--- rat/lonratedt.pm 2002/08/30 22:28:05 1.31.2.1
+++ rat/lonratedt.pm 2004/11/13 21:17:55 1.61
@@ -1,7 +1,7 @@
# The LearningOnline Network with CAPA
# Edit Handler for RAT Maps
#
-# $Id: lonratedt.pm,v 1.31.2.1 2002/08/30 22:28:05 albertel Exp $
+# $Id: lonratedt.pm,v 1.61 2004/11/13 21:17:55 albertel Exp $
#
# Copyright Michigan State University Board of Trustees
#
@@ -25,20 +25,155 @@
#
# http://www.lon-capa.org/
#
-# (TeX Content Handler
-#
-# 05/29/00,05/30 Gerd Kortemeyer)
-# 7/1,6/30 Gerd Kortemeyer
+
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;
-use vars qw(@order @resources);
+use vars qw(@order @resources @resparms);
# Mapread read maps into global arrays @links and @resources, determines status
@@ -52,8 +187,10 @@ sub mapread {
undef @links;
undef @resources;
undef @order;
+ undef @resparms;
@resources=('');
@order=();
+ @resparms=();
my ($outtext,$errtext)=&Apache::lonratsrv::loadmap($fn,'');
if ($errtext) { return ($errtext,2); }
@@ -68,7 +205,11 @@ sub mapread {
$links[$number]=$content;
}
if ($command eq 'objparms') {
- return('Map has resource parameters. Use advanced editor.',1);
+ if ($resparms[$number]) {
+ $resparms[$number].='&&&'.$content;
+ } else {
+ $resparms[$number]=$content;
+ }
}
}
# ------------------------------------------------------- Is this a linear map?
@@ -82,13 +223,13 @@ 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);
}
}
@@ -97,11 +238,16 @@ sub mapread {
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;
@@ -271,12 +417,15 @@ sub buttons {
my $adv=shift;
my $output='';
}
@@ -298,6 +447,7 @@ sub pastetarget {
my $ext='false';
if ($url=~/^http\:\/\//) { $ext='true'; }
$url=~s/\:/\:/g;
+ $name=~s/\:/\:/g;
$resources[$idx]=$name.':'.$url.':'.$ext.':normal:res';
}
}
@@ -310,25 +460,56 @@ sub pastetarget {
# 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;
}
- my ($name,$url,$ext)=split(/\:/,$resources[$order[$#order]]);
+# 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 $fn=shift;
+ 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;
@@ -336,6 +517,13 @@ sub storemap {
if (defined($resources[$order[$i]])) {
$output.='<&>objcont<:>'.$order[$i].'<:>'.$resources[$order[$i]];
}
+ if (defined($resparms[$order[$i]])) {
+ foreach (split('&&&',$resparms[$order[$i]])) {
+ if ($_) {
+ $output.='<&>objparms<:>'.$order[$i].'<:>'.$_;
+ }
+ }
+ }
if (defined($order[$i+1])) {
if (defined($resources[$order[$i+1]])) {
$output.='<&>objlinks<:>'.$k.'<:>'.
@@ -350,12 +538,195 @@ sub storemap {
&Apache::lonratsrv::loadmap($fn,&Apache::lonratsrv::savemap($fn,''));
}
+# ------------------------------------------ Store and get parameters in global
+
+sub storeparameter {
+ my ($to,$name,$value,$ptype)=@_;
+ my $newentry='';
+ my $nametype='';
+ foreach (split('&&&',$resparms[$to])) {
+ my ($thistype,$thisname,$thisvalue)=split('___',$_);
+ if ($thisname) {
+ unless ($thisname eq $name) {
+ $newentry.=$_.'&&&';
+ } else {
+ $nametype=$thistype;
+ }
+ }
+ }
+ unless ($ptype) { $ptype=$nametype; }
+ unless ($ptype) { $ptype='string'; }
+ $newentry.=$ptype.'___'.$name.'___'.$value;
+ $resparms[$to]=$newentry;
+}
+
+sub delparameter {
+ my ($to,$name)=@_;
+ my $newentry='';
+ my $nametype='';
+ foreach (split('&&&',$resparms[$to])) {
+ my ($thistype,$thisname,$thisvalue)=split('___',$_);
+ if ($thisname) {
+ unless ($thisname eq $name) {
+ $newentry.=$_.'&&&';
+ }
+ }
+ }
+ $resparms[$to]=$newentry;
+}
+
+sub getparameter {
+ my ($to,$name)=@_;
+ my $value=undef;
+ my $ptype=undef;
+ foreach (split('&&&',$resparms[$to])) {
+ my ($thistype,$thisname,$thisvalue)=split('___',$_);
+ if ($thisname eq $name) {
+ $value=$thisvalue;
+ $ptype=$thistype;
+ }
+ }
+ return ($value,$ptype);
+}
+
+# ----------------------------------------------------------------- Edit script
+sub editscript {
+ my $mode=shift;
+ my $resurl=&Apache::loncommon::lastresurl();
+ return(< ';
+ } else {
+ $targetmsg=''.&mt('An error occured while saving.').' ';
+ }
+ }
+ if ($ENV{'form.revert'}) {
+ $targetmsg=''.&mt('Reverted.').' ';
+ unlink($tmpfn);
+ my ($errtext,$fatal)=
+ &mapread(&Apache::lonnet::filelocation('',$url),'');
+ }
+ if (-e $tmpfn) {
+ $targetmsg=
+ ''.&mt('You are working with an unsaved version of your map.').' ';
+ my ($errtext,$fatal)=&mapread($tmpfn,'');
+ }
# ---------------------------------------------------------- Process form input
my @importselect=();
@@ -542,13 +913,42 @@ sub smpedt {
}
&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;
+ $importdetail='&'.$importdetail;
+ $importdetail=~s/^\&+/\&/;
my $importwindow=
- ''.
+ ''.
join("\n",map {
$idx++;
if ($_) {
@@ -561,8 +961,9 @@ sub smpedt {
} split(/\&/,$importdetail));
$idx=0;
+ $targetdetail='';
my $targetwindow=
- ''.
+ ''.
join("\n",map {
my ($name,$url)=split(/\:/,$resources[$_]);
unless ($name) { $name=(split(/\//,$url))[-1]; }
@@ -570,116 +971,41 @@ sub smpedt {
$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,
+ ($ENV{'environment.remote'} ne 'off')).
+ &Apache::loncommon::help_open_menu('','Sequence_Simple_Editor_Creation','Sequence_Simple_Editor_Creation','',6,'RAT');
+ 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
-