--- rat/lonratedt.pm 2002/05/16 21:10:05 1.20 +++ rat/lonratedt.pm 2003/12/12 15:19:29 1.50 @@ -1,7 +1,7 @@ # The LearningOnline Network with CAPA # Edit Handler for RAT Maps # -# $Id: lonratedt.pm,v 1.20 2002/05/16 21:10:05 www Exp $ +# $Id: lonratedt.pm,v 1.50 2003/12/12 15:19:29 sakharuk Exp $ # # Copyright Michigan State University Board of Trustees # @@ -32,13 +32,151 @@ package Apache::lonratedt; +=pod + +=head1 NAME + +Apache::lonratedt: advanced 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 + use strict; use Apache::Constants qw(:common); use Apache::lonnet; use Apache::lonratsrv; +use Apache::lonsequence; +use Apache::loncommon; +use Apache::lonlocal; +use File::Copy; -my @order=(); -my @resources=(); +use vars qw(@order @resources); # Mapread read maps into global arrays @links and @resources, determines status @@ -52,6 +190,8 @@ sub mapread { undef @links; undef @resources; undef @order; + @resources=(''); + @order=(); my ($outtext,$errtext)=&Apache::lonratsrv::loadmap($fn,''); if ($errtext) { return ($errtext,2); } @@ -65,6 +205,9 @@ sub mapread { if ($command eq 'objlinks') { $links[$number]=$content; } + if ($command eq 'objparms') { + return(&mt('Map has resource parameters. Use advanced editor.'),1); + } } # ------------------------------------------------------- Is this a linear map? my @starters=(); @@ -77,26 +220,31 @@ sub mapread { my ($start,$end,$cond)=split(/\:/,$_); if ((defined($starters[$start])) || (defined($endings[$end]))) { return - ('Map has branchings. Use advanced editor.',1); + (&mt('Map has branchings. Use advanced editor.'),1); } $starters[$start]=1; $endings[$end]=1; if ($cond) { return - ('Map has conditions. Use advanced editor.',1); + (&mt('Map has conditions. Use advanced editor.'),1); } } } - for (my $i=0; $i<=$#resources; $i++) { + for (my $i=1; $i<=$#resources; $i++) { if (defined($resources[$i])) { unless (($starters[$i]) || ($endings[$i])) { return - ('Map has unconnected resources. Use advanced editor.',1); + (&mt('Map has unconnected resources. Use advanced editor.'),1); } } } - +# ---------------------------------------------- Did we just read an empty map? + if ($#resources<1) { + undef $resources[0]; + $resources[1]=':::start'; + $resources[2]=':::finish'; + } # -------------------------------------------------- This is a linear map, sort my $startidx=0; @@ -127,7 +275,9 @@ sub mapread { } # ---------------------------------------------- Read a map as well as possible - +# Also used by the sequence handler +# Call lonsequence::attemptread to read from resource space +# sub attemptread { my $fn=shift; @@ -264,12 +414,12 @@ sub buttons { my $adv=shift; my $output='
'; if ($adv==1) { - $output.=''; + $output.=''; } else { unless ($adv==2) { - $output.=''; + $output.=''; } - $output.=''; + $output.=''; } return $output.'

'; } @@ -283,44 +433,246 @@ sub pastetarget { foreach (@which) { if (defined($_)) { my ($name,$url)=split(/\=/,$_); - my $idx=$#resources+1; - $insertorder[$#insertorder+1]=$idx; - my $ext='false'; - if ($url=~/^http\:\/\//) { $ext='true'; } - $resources[$idx]=$name.':'.$url.':normal:'.$ext.':res'; + $name=&Apache::lonnet::unescape($name); + $url=&Apache::lonnet::unescape($url); + if ($url) { + my $idx=$#resources+1; + $insertorder[$#insertorder+1]=$idx; + my $ext='false'; + if ($url=~/^http\:\/\//) { $ext='true'; } + $url=~s/\:/\:/g; + $name=~s/\:/\:/g; + $resources[$idx]=$name.':'.$url.':'.$ext.':normal:res'; + } + } + } + my @oldorder=splice(@order,$after); + @order=(@order,@insertorder,@oldorder); +} + +# ------------------------------------------------ Get start and finish correct +# modifies @resources + +sub startfinish { +# Remove all start and finish + foreach (@order) { + my ($name,$url,$ext)=split(/\:/,$resources[$_]); + if ($url=~/http\&colon\:\/\//) { $ext='true'; } + $resources[$_]=$name.':'.$url.':'.$ext.':normal:res'; + } +# Garbage collection + my $stillchange=1; + while (($#order>1) && ($stillchange)) { + $stillchange=0; + for (my $i=0;$i<=$#order;$i++) { + my ($name,$url,$ext)=split(/\:/,$resources[$order[$i]]); + unless ($url) { +# Take out empty resource + for (my $j=$i+1;$j<=$#order;$j++) { + $order[$j-1]=$order[$j]; + } + $#order--; + $stillchange=1; + last; + } + } + } +# Put in a start resource + my ($name,$url,$ext)=split(/\:/,$resources[$order[0]]); + $resources[$order[0]]=$name.':'.$url.':'.$ext.':start:res'; +# Make sure this has at least start and finish + if ($#order==0) { + $resources[$#resources+1]='::false'; + $order[1]=$#resources; + } +# Make the last one a finish resource + ($name,$url,$ext)=split(/\:/,$resources[$order[$#order]]); + $resources[$order[$#order]]=$name.':'.$url.':'.$ext.':finish:res'; +} + +# ------------------------------------------------------------------- Store map + +sub storemap { + my $realfn=shift; + my $fn=$realfn; +# unless this is forced to work from the original file, use a temporary file +# instead + unless (shift) { + $fn=$realfn.'.tmp'; + unless (-e $fn) { + copy($realfn,$fn); + } + } +# store data either into tmp or real file + &startfinish(); + my $output='graphdef<:>no'; + my $k=1; + for (my $i=0; $i<=$#order; $i++) { + if (defined($resources[$order[$i]])) { + $output.='<&>objcont<:>'.$order[$i].'<:>'.$resources[$order[$i]]; + } + if (defined($order[$i+1])) { + if (defined($resources[$order[$i+1]])) { + $output.='<&>objlinks<:>'.$k.'<:>'. + $order[$i].':'.$order[$i+1].':0'; + $k++; + } } } - print "insertorder:".join(',',@insertorder).'
'; - print "order:".join(',',@order).'
'; - my @oldorder=splice(@order,$after,$#insertorder+1,@insertorder); - print "oldorder:".join(',',@oldorder).'
'; - print "order:".join(',',@order).'
'; - @order=push(@order,@oldorder); - print "order:".join(',',@order).'
'; + $output=~s/http\&colon\;\/\///g; + $ENV{'form.output'}=$output; + return + &Apache::lonratsrv::loadmap($fn,&Apache::lonratsrv::savemap($fn,'')); } +sub editscript { + my $mode=shift; + return(<'.&mt('You are working with an unsaved version of your map.').'
'; + my ($errtext,$fatal)=&mapread($tmpfn,''); + } # ---------------------------------------------------------- Process form input my @importselect=(); my @targetselect=(); undef @importselect; undef @targetselect; - if (defined($ENV{'form.import'})) { - if (ref($ENV{'form.import'})) { - @importselect=sort($ENV->{'form.import'}); + if (defined($ENV{'form.importsel'})) { + if (ref($ENV{'form.importsel'})) { + @importselect=sort(@{$ENV{'form.importsel'}}); } else { - @importselect=($ENV{'form.import'}); + @importselect=($ENV{'form.importsel'}); } } if (defined($ENV{'form.target'})) { if (ref($ENV{'form.target'})) { - @targetselect=sort($ENV->{'form.target'}); + @targetselect=sort(@{$ENV{'form.target'}}); } else { @targetselect=($ENV{'form.target'}); } @@ -399,7 +751,7 @@ sub smpedt { } foreach ( - &attemptread(&Apache::lonnet::filelocation('',$ENV{'form.importmap'}))) { + &Apache::lonsequence::attemptread(&Apache::lonnet::filelocation('',$ENV{'form.importmap'}))) { my ($name,$url)=split(/\:/,$_); if ($url) { $importdetail.='&'.&Apache::lonnet::escape($name).'='. @@ -419,23 +771,115 @@ sub smpedt { # ------------------------------------------------ Groupimport/search to target } elsif ($ENV{'form.importdetail'}) { my $lastsel; - if (defined($targetselect[-1])) { $lastsel=$targetselect[-1]; } else { - $lastsel=$#order; + $lastsel=$#order+1; } - &pastetarget($lastsel,split(/\&/,$ENV{'form.importdata'})); + &pastetarget($lastsel,split(/\&/,$ENV{'form.importdetail'})); + &storemap(&Apache::lonnet::filelocation('',$url)); # ------------------------------------------------------------------------- Cut - } elsif ($ENV{'form.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(/\:/,$resources[$order[$_-1]]); + if ($url) { + $importdetail.='&'.&Apache::lonnet::escape($name).'='. + &Apache::lonnet::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<=$#order;$i++) { + my $include=1; + foreach (@targetselect) { + if ($_-1==$i) { $include=0; } + } + if ($include) { $neworder[$#neworder+1]=$order[$i]; } + } + @order=@neworder; + &storemap(&Apache::lonnet::filelocation('',$url)); + } + # ----------------------------------------------------------------------- Paste } elsif ($ENV{'form.paste'}) { -# ------------------------------------------------ + my $lastsel; + if (defined($targetselect[-1])) { + $lastsel=$targetselect[-1]; + } else { + $lastsel=$#order+1; + } + my @newsequence; + my @curimport=split(/\&/,$ENV{'form.curimpdetail'}); + foreach (@importselect) { + $newsequence[$#newsequence+1]=$curimport[$_]; + } + &pastetarget($lastsel,@newsequence); + &storemap(&Apache::lonnet::filelocation('',$url)); +# -------------------------------------------------------------------- Move up + } elsif ($ENV{'form.moveup'}) { + foreach (sort @targetselect) { + if ($_-1>0) { + my $movethis=$order[$_-1]; + $order[$_-1]=$order[$_-2]; + $order[$_-2]=$movethis; + } + } + &storemap(&Apache::lonnet::filelocation('',$url)); +# ------------------------------------------------------------------ Move down + } elsif ($ENV{'form.movedown'}) { + foreach (reverse sort @targetselect) { + if ($_-1<$#order) { + my $movethis=$order[$_-1]; + $order[$_-1]=$order[$_]; + $order[$_]=$movethis; + } + } + &storemap(&Apache::lonnet::filelocation('',$url)); +# --------------------------------------------------------------------- Rename + } elsif ($ENV{'form.renameres'}) { + my $residx=$Apache::lonratedt::order[$ENV{'form.renameidx'}-1]; + my ($name,@resrest)=split(/\:/,$Apache::lonratedt::resources[$residx]); + $name=$ENV{'form.renametitle'}; + $name=~s/\:/\&colon\;/g; + $Apache::lonratedt::resources[$residx]=$name.':'.join(':',@resrest); + &storemap(&Apache::lonnet::filelocation('',$url)); } # ------------------------------------------------------------ Assemble windows my $idx=-1; - my $importwindow=join("\n",map { + $importdetail='&'.$importdetail; + $importdetail=~s/^\&+/\&/; + my $importwindow= + ''. + join("\n",map { $idx++; if ($_) { my ($name,$url)=split(/\=/,$_); @@ -447,123 +891,49 @@ sub smpedt { } split(/\&/,$importdetail)); $idx=0; - my $targetwindow=join("\n",map { + $targetdetail=''; + my $targetwindow= + ''. + join("\n",map { my ($name,$url)=split(/\:/,$resources[$_]); unless ($name) { $name=(split(/\//,$url))[-1]; } unless ($name) { $name='EMPTY'; } $targetdetail.='&'.&Apache::lonnet::escape($name).'='. &Apache::lonnet::escape($url); $idx++; + $name=~s/\:/\:/g; ''; } @order); # ----------------------------------------------------- Start simple RAT screen + my $editscript=&editscript('simple'); + my $bodytag=&Apache::loncommon::bodytag(undef,undef,undef,1); + my %lt=&Apache::lonlocal::texthash( + 'sa' => 'Save', + 'nt' => 'New Title', + 'se' => 'Search', + 'im' => 'Import', + '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', + ); $r->print(< - +$bodytag $buttons $errtext
+ + + - + - + - -
Import
$lt{'ta'}  Target
File: $url
- - -after selected + + +$lt{'as'}

- - - +value="Select Map">
+ + +
  +"javascript:impfortarget.value=1;groupsearch()" value="$lt{'se'}"> -after selected -
+"javascript:impfortarget.value=1;groupimport();" value="$lt{'im'}"> +$lt{'as'} +
+ + + +
$targetmsg + + +
-Cut selected
+$lt{'cs'}


-Paste after selected
- +$lt{'ps'}
+

+


+$lt{'pas'}
+
@@ -658,12 +1061,20 @@ ENDNODIR sub viewmap { my ($r,$url,$adv,$errtext)=@_; - $r->print(''.&buttons($adv)); + $r->print(''. + &Apache::loncommon::bodytag('Edit Content of a Map'). + &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.').'


'); + } foreach (&attemptread(&Apache::lonnet::filelocation('',$url))) { if (defined($_)) { + $idx++; my ($title,$url)=split(/\:/,$_); $title=~s/\&colon\;/\:/g; $url=~s/\&colon\;/\:/g; @@ -674,7 +1085,7 @@ sub viewmap { } $r->print(&Apache::lonratsrv::qtescape($title)); if ($url) { $r->print(''); } - $r->print('
'); + $r->print('
'); } } $r->print(''); @@ -684,11 +1095,17 @@ sub viewmap { 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); @@ -723,7 +1140,7 @@ sub handler { if ($ENV{'form.forceadv'}) { &ratedt($r,$url); } elsif ($ENV{'form.forcesmp'}) { - &smpedt($r,$errtext); + &smpedt($r,$url,$errtext); } else { &viewmap($r,$url,$adv,$errtext); }