--- rat/lonratedt.pm 2001/05/01 15:23:40 1.2 +++ rat/lonratedt.pm 2012/12/16 16:02:15 1.105.2.3 @@ -1,42 +1,821 @@ # The LearningOnline Network with CAPA # Edit Handler for RAT Maps -# (TeX Content Handler # -# 05/29/00,05/30 Gerd Kortemeyer) -# 7/1 Gerd Kortemeyer +# $Id: lonratedt.pm,v 1.105.2.3 2012/12/16 16:02:15 raeburn Exp $ +# +# Copyright Michigan State University Board of Trustees +# +# This file is part of the LearningOnline Network with CAPA (LON-CAPA). +# +# LON-CAPA is free software; you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation; either version 2 of the License, or +# (at your option) any later version. +# +# LON-CAPA is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with LON-CAPA; if not, write to the Free Software +# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA +# +# /home/httpd/html/adm/gpl.txt +# +# http://www.lon-capa.org/ +# + package Apache::lonratedt; use strict; use Apache::Constants qw(:common); +use Apache::lonnet; +use Apache::lonsequence(); +use Apache::loncommon(); +use Apache::lonlocal; +use LONCAPA::map(); +use File::Copy; +use LONCAPA; +use HTML::Entities(); + +# --------------------------------------------------------- Build up RAT screen +sub ratedt { + my ($r,$url)=@_; + my %layout = ('border' => "0"); + if ($env{'environment.remote'} eq 'off') { + $layout{'rows'} = "1,250,*"; + } else { + $layout{'rows'} = "1,70,*"; + } + my $js =' +'; + + my $start_page = + &Apache::loncommon::start_page('Edit Sequence',$js, + {'frameset' => 1, + 'add_entries' => \%layout}); + + my $end_page = + &Apache::loncommon::end_page({'frameset' => 1}); + + $r->print(< + + +$end_page +ENDDOCUMENT +} + +# ---------------------------------------------------------------- Make buttons + +sub buttons { + my $adv=shift; + my $output='
'; + if ($adv==1) { + $output.= + '' + .&Apache::loncommon::help_open_topic( + 'Sequence_Advanced_Editor_Creation'); + } else { + unless ($adv==2) { + $output.= + '' + .&Apache::loncommon::help_open_topic( + 'Sequence_Simple_Editor_Creation') + .' '; + } + $output.= + '' + .&Apache::loncommon::help_open_topic( + 'Sequence_Advanced_Editor_Creation'); + } + return $output.'
'; +} + +# ----------------------------------------------------------------- Edit script +sub editscript { + my $mode=shift; + my $resurl= + &Apache::loncommon::escape_single(&Apache::loncommon::lastresurl()); + return(<
'; + } else { + $targetmsg=''.&mt('An error occurred while saving.').'
'; + } + } + if ($env{'form.revert'}) { + $targetmsg=''.&mt('Reverted.').'
'; + unlink($tmpfn); + my ($errtext,$fatal)= + &LONCAPA::map::mapread(&Apache::lonnet::filelocation('',$url),''); + } + if (-e $tmpfn) { + $targetmsg= + ''.&mt('You are working with an unsaved version of your map.').'
'; + my ($errtext,$fatal)=&LONCAPA::map::mapread($tmpfn,''); + } +# ---------------------------------------------------------- Process form input + + my @importselect=&Apache::loncommon::get_env_multiple('form.importsel'); + my @targetselect=&Apache::loncommon::get_env_multiple('form.target'); +# ============================================================ Process commands + + my $targetdetail=$env{'form.targetdetail'}; + my $importdetail=$env{'form.curimpdetail'}; + +# ---------------------------------------------------- Importing from groupsort + if (($env{'form.importdetail'}) && (!$env{'form.impfortarget'})) { + + $importdetail=''; + my @curimport=split(/\&/,$env{'form.curimpdetail'}); + + my $lastsel; + + if (defined($importselect[-1])) { + $lastsel=$importselect[-1]; + } else { + $lastsel=$#curimport; + } + + for (my $i=0;$i<=$lastsel;$i++) { + my ($name,$url)=split(/\=/,$curimport[$i]); + if ($url) { + $importdetail.='&'.$name.'='.$url; + } + } + + $importdetail.='&'.$env{'form.importdetail'}; + + for (my $i=$lastsel+1;$i<=$#curimport;$i++) { + my ($name,$url)=split(/\=/,$curimport[$i]); + if ($url) { + $importdetail.='&'.$name.'='.$url; + } + } + $importdetail=~s/\&+/\&/g; + $importdetail=~s/^\&//; + +# ------------------------------------------------------------------- Clear all + } elsif ($env{'form.clear'}) { + $importdetail=''; +# ------------------------------------------------------------ Discard selected + } elsif ($env{'form.discard'}) { + $importdetail=''; + my @curimport=split(/\&/,$env{'form.curimpdetail'}); + foreach (@importselect) { + $curimport[$_]=''; + } + for (my $i=0;$i<=$#curimport;$i++) { + my ($name,$url)=split(/\=/,$curimport[$i]); + if ($url) { + $importdetail.='&'.$name.'='.$url; + } + } +# --------------------------------------------------------- Loading another map + } elsif ($env{'form.loadmap'}) { + $importdetail=''; + my @curimport=split(/\&/,$env{'form.curimpdetail'}); + + my $lastsel; + + if (defined($importselect[-1])) { + $lastsel=$importselect[-1]; + } else { + $lastsel=$#curimport; + } + + for (my $i=0;$i<=$lastsel;$i++) { + my ($name,$url)=split(/\=/,$curimport[$i]); + if ($url) { + $importdetail.='&'.$name.'='.$url; + } + } + + foreach ( + &Apache::lonsequence::attemptread(&Apache::lonnet::filelocation('',$env{'form.importmap'}))) { + my ($name,$url)=split(/\:/,$_); + if ($url) { + $importdetail.='&'.&escape($name).'='. + &escape($url); + } + } + + for (my $i=$lastsel+1;$i<=$#curimport;$i++) { + my ($name,$url)=split(/\=/,$curimport[$i]); + if ($url) { + $importdetail.='&'.$name.'='.$url; + } + } + $importdetail=~s/\&+/\&/g; + $importdetail=~s/^\&//; + +# ------------------------------------------------ Groupimport/search to target + } elsif ($env{'form.importdetail'}) { + my $lastsel; + if (defined($targetselect[-1])) { + $lastsel=$targetselect[-1]; + } else { + $lastsel=$#LONCAPA::map::order+1; + } + &LONCAPA::map::pastetarget($lastsel,split(/\&/,$env{'form.importdetail'})); + &LONCAPA::map::storemap(&Apache::lonnet::filelocation('',$url)); +# ------------------------------------------------------------------------- Cut + } elsif (($env{'form.cut'}) || ($env{'form.copy'})) { + $importdetail=''; + my @curimport=split(/\&/,$env{'form.curimpdetail'}); + + my $lastsel; + + if (defined($importselect[-1])) { + $lastsel=$importselect[-1]; + } else { + $lastsel=$#curimport; + } + + for (my $i=0;$i<=$lastsel;$i++) { + my ($name,$url)=split(/\=/,$curimport[$i]); + if ($url) { + $importdetail.='&'.$name.'='.$url; + } + } + + foreach (@targetselect) { + my ($name,$url)=split(/\:/,$LONCAPA::map::resources[$LONCAPA::map::order[$_-1]]); + if ($url) { + $importdetail.='&'.&escape($name).'='. + &escape($url); + } + } + + for (my $i=$lastsel+1;$i<=$#curimport;$i++) { + my ($name,$url)=split(/\=/,$curimport[$i]); + if ($url) { + $importdetail.='&'.$name.'='.$url; + } + } + $importdetail=~s/\&+/\&/g; + $importdetail=~s/^\&//; + + if ($env{'form.cut'}) { + my @neworder=(); + for (my $i=0;$i<=$#LONCAPA::map::order;$i++) { + my $include=1; + foreach (@targetselect) { + if ($_-1==$i) { $include=0; } + } + if ($include) { + $neworder[$#neworder+1]=$LONCAPA::map::order[$i]; + } else { + &LONCAPA::map::makezombie($LONCAPA::map::order[$i]); + } + } + @LONCAPA::map::order=@neworder; + &LONCAPA::map::storemap(&Apache::lonnet::filelocation('',$url)); + } + +# ----------------------------------------------------------------------- Paste + } elsif ($env{'form.paste'}) { + my $lastsel; + if (defined($targetselect[-1])) { + $lastsel=$targetselect[-1]; + } else { + $lastsel=$#LONCAPA::map::order+1; + } + my @newsequence; + my @curimport=split(/\&/,$env{'form.curimpdetail'}); + foreach (@importselect) { + $newsequence[$#newsequence+1]=$curimport[$_]; + } + &LONCAPA::map::pastetarget($lastsel,@newsequence); + &LONCAPA::map::storemap(&Apache::lonnet::filelocation('',$url)); +# -------------------------------------------------------------------- Move up + } elsif ($env{'form.moveup'}) { + foreach (sort @targetselect) { + if ($_-1>0) { + my $movethis=$LONCAPA::map::order[$_-1]; + $LONCAPA::map::order[$_-1]=$LONCAPA::map::order[$_-2]; + $LONCAPA::map::order[$_-2]=$movethis; + } + } + &LONCAPA::map::storemap(&Apache::lonnet::filelocation('',$url)); +# ------------------------------------------------------------------ Move down + } elsif ($env{'form.movedown'}) { + foreach (reverse sort @targetselect) { + if ($_-1<$#LONCAPA::map::order) { + my $movethis=$LONCAPA::map::order[$_-1]; + $LONCAPA::map::order[$_-1]=$LONCAPA::map::order[$_]; + $LONCAPA::map::order[$_]=$movethis; + } + } + &LONCAPA::map::storemap(&Apache::lonnet::filelocation('',$url)); +# --------------------------------------------------------------------- Rename + } elsif ($env{'form.renameres'}) { + my $residx=$LONCAPA::map::order[$env{'form.renameidx'}-1]; + my ($name,@resrest)=split(/\:/,$LONCAPA::map::resources[$residx]); + $name=$env{'form.renametitle'}; + $name=~s/\:/\&colon\;/g; + $LONCAPA::map::resources[$residx]=$name.':'.join(':',@resrest); + &LONCAPA::map::storemap(&Apache::lonnet::filelocation('',$url)); + } +# ------------------------------------------------------------ Assemble windows + + my $idx=-1; + $importdetail='&'.$importdetail; + $importdetail=~s/^\&+/\&/; + my $importwindow= + ''. + join("\n",map { + $idx++; + if ($_) { + my ($name,$url)=split(/\=/,$_); + unless ($name) { $name=(split(/\//,$url))[-1]; } + unless ($name) { $name='EMPTY'; } + ''; + } + } split(/\&/,$importdetail)); + + $idx=0; + $targetdetail=''; + my $targetwindow= + ''. + join("\n",map { + my ($name,$url)=split(/\:/,$LONCAPA::map::resources[$_]); + unless ($name) { $name=(split(/\//,$url))[-1]; } + unless ($name) { $name='EMPTY'; } + $name = &LONCAPA::map::qtescape($name); + $url = &LONCAPA::map::qtescape($url); + $targetdetail.='&'.&escape($name).'='. + &escape($url); + $idx++; + $name = &HTML::Entities::encode($name,'\'"<>&'); + ''; + } @LONCAPA::map::order); + +# ----------------------------------------------------- Start simple RAT screen + my $editscript=&editscript('simple'); + + my %lt=&Apache::lonlocal::texthash( + 'sa' => 'Save', + 'nt' => 'New Title', + 'se' => 'Search', + 'im' => 'Import', + 'wl' => 'Import from Stored Links', + 'vi' => 'View', + 'lm' => 'Load Map', + 'ds' => 'Discard Selected', + 'ca' => 'Clear All', + 'ta' => 'Temporary Assembly Workspace', + 'rv' => 'Revert to Last Saved', + 'sa' => 'Save', + 'mu' => 'Move Up', + 'md' => 'Move Down', + 're' => 'Rename', + 'as' => 'after selected', + 'cs' => 'Cut selected', + 'ps' => 'Copy selected', + 'pas' => 'Paste after selected', + 'reco' => 'Recover Deleted' + ); + my $js=< + + $editscript + + function openview(entry) { + var url=unescape((entry.split('='))[1]); + var parts=new Array; + if (url) { open(url,'cat'); } + } + + function viewtarget() { + openview((document.forms.simpleedit.targetdetail.value.split('&')) + [document.forms.simpleedit.target.selectedIndex]); + } + + function viewimport() { + openview((document.forms.simpleedit.curimpdetail.value.split('&')) + [document.forms.simpleedit.importsel.selectedIndex]); + } + + function renametarget() { + var selidx=document.forms.simpleedit.target.selectedIndex; + var entry=(document.forms.simpleedit.targetdetail.value.split('&')) + [selidx]; + var oldname=unescape((entry.split('='))[0]); + newtitle=prompt('$lt{'nt'}',oldname); + if (newtitle) { + document.forms.simpleedit.renameres.value=1; + document.forms.simpleedit.renameidx.value=selidx; + document.forms.simpleedit.renametitle.value=newtitle; + document.forms.simpleedit.submit(); + } + } + + +ENDJS + + &Apache::lonhtmlcommon::clear_breadcrumbs(); + &Apache::lonhtmlcommon::add_breadcrumb({ + text => 'Construction Space', + href => &Apache::loncommon::authorspace($url), + faq => 6, + bug => 'RAT', + help => 'Sequence_Simple_Editor_Creation',}); + &Apache::lonhtmlcommon::add_breadcrumb({ + text => 'RAT', + title => 'Resource Assembly Tool', + href => '',}); + &Apache::lonhtmlcommon::add_breadcrumb({ + text => 'Editor', + title => 'Simple Editor', + href => '',}); + + # Breadcrumbs are included by &start_page + my $start_page = &Apache::loncommon::start_page('Construction Space',$js) + .&Apache::loncommon::head_subbox( + &Apache::loncommon::CSTR_pageheader() + .&buttons(2)); + my $end_page = &Apache::loncommon::end_page(); + + $r->print(<$errtext +
+ + + + + + + + + + + + +
$lt{'ta'} File: $url
+ + +$lt{'as'} +
+ +
+ + + + + 		  + + + + + +$lt{'as'} +
+ + + +
$targetmsg + + + +
+ +$lt{'cs'}
+

+

+$lt{'ps'}
+

+ +$lt{'pas'}
+ +

 +
+ + + + +
+$end_page +ENDSMPHEAD +} + +# ----------------------------------------------------------------- No such dir +sub nodir { + my ($r,$dir)=@_; + my $londocroot = $r->dir_config('lonDocRoot'); + my ($path) = ($dir =~ m{^\Q$londocroot\E?(/priv/[^/]+/[^/]+/)}); + $dir=~s{^\Q$londocroot/priv/\E[^/]+/[^/]+}{}; + my $brcrum = [{'href' => &Apache::loncommon::authorspace($path), + 'text' => 'Construction Space'}]; +# {'href' => '', +# 'text' => 'No such directory'}]; + $r->print(&Apache::loncommon::start_page('Construction Space', + undef, + {'bread_crumbs' => $brcrum,}) + .&Apache::loncommon::head_subbox( + &Apache::loncommon::CSTR_pageheader()) + .'

' + .&mt('No such directory: [_1]',''.$dir.'' + .'

' + .&Apache::loncommon::end_page()) + ); +} + +# ---------------------------------------------------------------- View Handler + +sub viewmap { + my ($r,$url,$adv,$errtext)=@_; + + &Apache::lonhtmlcommon::clear_breadcrumbs(); + &Apache::lonhtmlcommon::add_breadcrumb({ + text => 'Construction Space', + href => &Apache::loncommon::authorspace($url), + faq => 6, + bug => 'RAT', + help => 'Sequence_Simple_Editor_Creation',}); + &Apache::lonhtmlcommon::add_breadcrumb({ + text => 'RAT', + title => 'Resource Assembly Tool', + href => '',}); + + # Breadcrumbs are included by &start_page + $r->print(&Apache::loncommon::start_page('Edit Content of a Map') + .&Apache::loncommon::head_subbox( + &Apache::loncommon::CSTR_pageheader() + .&buttons($adv)) + ); + if ($errtext) { + $r->print('
' + .$errtext + .'
' + .'
' + ); + } + my $idx=0; + $r->print('

'.$url.'

'); + if ($adv) { + $r->print('

' + .&mt('Map contents are not shown in order.') + .'


' + ); + } + $r->print(&Apache::loncommon::start_data_table() + .&Apache::loncommon::start_data_table_header_row() + .''.&mt('Type').'' + .''.&mt('Title in map').'' + .''.&mt('Filename of resource').'' + .''.&mt('Link to published resource').'' + .''.&mt('Link to resource in Construction Space').'' + .&Apache::loncommon::end_data_table_header_row() + ); + foreach (&LONCAPA::map::attemptread(&Apache::lonnet::filelocation('',$url))) { + if (defined($_)) { + $idx++; + my ($title,$url,$cond)=split(/\:/,$_); + if ($cond eq 'cond') { next; } + $title= &LONCAPA::map::qtescape($title); + $url = &LONCAPA::map::qtescape($url); + unless ($title) { $title=(split(/\//,$url))[-1] }; + unless ($title) { $title=''.&mt('Empty').''; } + my $resurl = $url; + my $resfilepath = $Apache::lonnet::perlvar{'lonDocRoot'}.$resurl; + my $filename; + if ($resurl =~ m#/([^/]+)$#) { + $filename = $1; + } + my $cstrurl = $resurl; + $cstrurl =~ s{^/res/}{/priv/}; + $r->print(&Apache::loncommon::start_data_table_row() + .'' + .'' + .'' + .'' + .&HTML::Entities::encode(&LONCAPA::map::qtescape($title)) + .'' + .''.$filename.'' + .'' + ); + if ($url) { + $r->print(''.&mt('Resource space').''); + } else { + $r->print(' '); + } + $r->print(''); + if ($url) { + $r->print(''. + &mt('Construction space').''); + } else { + $r->print(' '); + } + $r->print('' + .&Apache::loncommon::end_data_table_row() + ); + } + } + $r->print(&Apache::loncommon::end_data_table()); + $r->print(&Apache::loncommon::end_page()); +} # ================================================================ Main Handler sub handler { my $r=shift; - $r->content_type('text/html'); + &Apache::loncommon::content_type($r,'text/html'); $r->send_http_header; return OK if $r->header_only; - + my $target = $env{'form.grade_target'}; + if ($target eq 'meta') { + &Apache::loncommon::content_type($r,'text/html'); + $r->send_http_header; + return OK; + } + my $url=$r->uri; + my $fn=&Apache::lonnet::filelocation('',$url); - $r->print(< - - - - - - - - - - -ENDDOCUMENT + my ($dir)=($fn=~/^(.+)\/[^\/]+$/); + unless (-e $dir) { + &nodir($r,$dir); + return OK; + } + +# ------------------------------------------- Determine which tools can be used + my $adv=0; + + unless ($env{'form.forcesmp'}) { + if ($env{'form.forceadv'}) { + $adv=1; + } elsif (my $fh=Apache::File->new($fn)) { + my $allmap=join('',<$fh>); + $adv=($allmap=~/\]+mode\s*\=\s*(\'|\")rat/is); + } + } + + my $errtext=''; + my $fatal=0; + +# -------------------------------------------------------------------- Load map + ($errtext,$fatal)=&LONCAPA::map::mapread($fn,$errtext); + + if ($fatal==1) { $adv=1; } + +# ----------------------------------- adv==1 now means "graphical MUST be used" + + if ($env{'form.forceadv'}) { + &ratedt($r,$url); + } elsif ($env{'form.forcesmp'}) { + &smpedt($r,$url,$errtext); + } else { + &viewmap($r,$url,$adv,$errtext); + } return OK; } @@ -45,7 +824,140 @@ __END__ +=pod + +=head1 NAME + +Apache::lonratedt: simple resource assembly tool + +=head1 SYNOPSIS + +lonratedt provides the routines and the handler for the Advanced + Resource Assembly Tool (RAT), and ties the various pieces together + with Javascript. + +=head1 OVERVIEW + +=head2 Map Representation + +=begin latex + +% +\begin{figure} +\begin{center}\includegraphics[% + width=0.55\paperwidth,bb = 0 0 200 100, draft, type=eps]{Map_Example}\end{center} + + +\caption{\label{Map_In_Advanced_Editor}Example of a Map in the Advanced Editor} +\end{figure} +% +\begin{figure} +\begin{lyxcode} + + +~~ + +~~~~ + +~~ + +~~~~ + +~~ + +~~~~ + +~~ + +~~~~ + +~~ + +~~~~ + +~~ + +~~~~ + +~~ + +~~ + +~~ + +~~ + +~~ +\end{lyxcode} + +\caption{\label{XML}XML for Map in Figure \ref{Map_In_Advanced_Editor}} +\end{figure} + +=end latex + +Fig. "XML for Map in Figure" shows the XML representation of the +resource map shown in Fig. "Example of a Map in the Advanced Editor", +which is the format in which maps are stored. In the figure, however, +additional graphical map layout information generated by the Advanced +Resource Assembly Tool is not displayed. This graphical information is +optional to re-generate the same graphical layout when the map is +brought up again in the Resource Assembly Tool, and is not needed for +any other system functionality. + +Maps can be generated by tools other than the Resource Assembly +Tool. In particular, an author might have some other representation of +a course sequence, which can be converted into a map using scripts. If +this map then were to be brought up in the Resource Assembly Tool, the +Tool would automatically generate a graphical layout for it. Each +entry of the map (resources, conditions and links) is stored in a +separate tag. + +Resources and conditionsX have to have unique ID +numbers. These numbers are automatically generated by the Resource +Assembly Tool when the entry is first created, or added to the entries +when a map generated outside the Resource Assembly Tool is first +retrieved. They can also be assigned by custom scripts or added in by +hand. + +In the XML example, entry 1 is the start resource of the map. When +this map is accessed, the source (src) URL of this tag will be the +first resource rendered. Entry 2 is the finish resource of this +map. This resource will be the last resource in the sequence of +resources. Entry 6 is a problem resource with the given URL and title, +as well as the priority "mandatory". Entry 19 is a condition, which is +used by the link between entries 6, the problem, and 9, a +sequence. I +=cut