--- rat/lonratedt.pm	2002/06/04 13:23:54	1.30
+++ rat/lonratedt.pm	2003/07/25 04:14:32	1.46
@@ -1,7 +1,7 @@
 # The LearningOnline Network with CAPA
 # Edit Handler for RAT Maps
 #
-# $Id: lonratedt.pm,v 1.30 2002/06/04 13:23:54 www Exp $
+# $Id: lonratedt.pm,v 1.46 2003/07/25 04:14:32 bowersj2 Exp $
 #
 # Copyright Michigan State University Board of Trustees
 #
@@ -32,14 +32,150 @@
 
 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}
+<map>
+
+~~<resource~id=\char`\"{}1\char`\"{}
+
+~~~~src=\char`\"{}/res/msu/korte/phy231welcome.html\char`\"{}
+
+~~~~type=\char`\"{}start\char`\"{}
+
+~~~~title=\char`\"{}Start\char`\"{}>
+
+~~~~</resource>
+
+~~<resource~id=\char`\"{}2\char`\"{}
+
+~~~~src=\char`\"{}\char`\"{}~type=\char`\"{}finish\char`\"{}
+
+~~~~title=\char`\"{}Finish\char`\"{}>
+
+~~~~</resource>
+
+~~<resource~id=\char`\"{}6\char`\"{}
+
+~~~~src=\char`\"{}/res/msu/korte/tests/units.problem\char`\"{}
+
+~~~~type=\char`\"{}mandatory\char`\"{}
+
+~~~~title=\char`\"{}Physical~Units~Test\char`\"{}>
+
+~~~~</resource>
+
+~~<resource~id=\char`\"{}9\char`\"{}
+
+~~~~src=\char`\"{}/res/msu/korte/chapters/onedim.sequence\char`\"{}
+
+~~~~title=\char`\"{}Motion~in~One~Dimension\char`\"{}>
+
+~~~~</resource>
+
+~~<resource~id=\char`\"{}11\char`\"{}
+
+~~~~src=\char`\"{}/res/msu/bauer/bridges/units.sequence\char`\"{}
+
+~~~~title=\char`\"{}Physical~Units~Refresher\char`\"{}>
+
+~~~~</resource>
+
+~~<condition~id=\char`\"{}19\char`\"{}
+
+~~~~type=\char`\"{}stop\char`\"{}
+
+~~~~value=\char`\"{}user.assessments{[}this./res/msu/korte/tests/units.problem{]}.status=solved\char`\"{}>
+
+~~~~</condition>
+
+~~<link~from=\char`\"{}1\char`\"{}~to=\char`\"{}6\char`\"{}></link>
+
+~~<link~from=\char`\"{}6\char`\"{}~to=\char`\"{}9\char`\"{}~condition=\char`\"{}19\char`\"{}></link>
+
+~~<link~from=\char`\"{}6\char`\"{}~to=\char`\"{}11\char`\"{}></link>
+
+~~<link~from=\char`\"{}11\char`\"{}~to=\char`\"{}6\char`\"{}></link>
+
+~~</map>
+\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<conditions> 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<The final syntax for conditions has not yet been
+determined.>
+
+=cut
+
 use strict;
 use Apache::Constants qw(:common);
 use Apache::lonnet;
 use Apache::lonratsrv;
 use Apache::lonsequence;
+use Apache::loncommon;
+use File::Copy;
 
-my @order;
-my @resources;
+use vars qw(@order @resources);
 
 
 # Mapread read maps into global arrays @links and @resources, determines status
@@ -68,6 +204,9 @@ sub mapread {
         if ($command eq 'objlinks') {
             $links[$number]=$content;
         }
+        if ($command eq 'objparms') {
+	    return('Map has resource parameters. Use advanced editor.',1);
+        }
     }
 # ------------------------------------------------------- Is this a linear map?
     my @starters=();
@@ -99,7 +238,12 @@ sub mapread {
             }
         }
     }
-
+# ---------------------------------------------- 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;
@@ -296,6 +440,7 @@ sub pastetarget {
                my $ext='false';
                if ($url=~/^http\:\/\//) { $ext='true'; }
                $url=~s/\:/\&colon;/g;
+               $name=~s/\:/\&colon;/g;
                $resources[$idx]=$name.':'.$url.':'.$ext.':normal:res';
 	   }
         }
@@ -308,21 +453,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';
-   my ($name,$url,$ext)=split(/\:/,$resources[$order[$#order]]);
+# 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 $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;
@@ -344,12 +524,138 @@ sub storemap {
      &Apache::lonratsrv::loadmap($fn,&Apache::lonratsrv::savemap($fn,''));
 }
 
+sub editscript {
+    my $mode=shift;
+    return(<<ENDSCRIPT);
+var srch;
+var srchflag=-1; // 1 means currently open
+                 // 0 means closed (but has been open)
+                 // -1 means never yet opened/defined
+var srchmode='';
+
+var idx;
+var idxflag=-1; // 1 means currently open
+                 // 0 means closed (but has been open)
+                 // -1 means never yet opened/defined
+var idxmode='';
+
+// ------------------------------------------------------ Clears indexer window
+function idxclear() {
+  idx.document.clear();
+}
+
+// ------------------------------------------------------- Clears search window
+function srchclear() {
+  srch.document.clear();
+}
+
+// ------------------------------------------------------ Closes indexer window
+function idxclose() {
+  if (idx && !idx.closed) {
+    idxflag=0;
+    idx.close();
+  }
+}
+
+// ------------------------------------------------------- Closes search window
+function srchclose() {
+  if (srch && !srch.closed) {
+    srchflag=0;
+    srch.close();
+  }
+}
+
+// -------------------------------------------------------- Open indexer window
+function idxopen(mode) {
+   var options="scrollbars=1,resizable=1,menubar=0";
+   idxmode=mode;
+   idxflag=1;
+   idx=open("/res/?launch=1&mode=$mode&catalogmode="+mode,"idxout",options);
+   idx.focus();
+}
+
+// --------------------------------------------------------- Open search window
+function srchopen(mode) {
+   var options="scrollbars=1,resizable=1,menubar=0";
+   srchmode=mode;
+   srchflag=1;
+   srch=open("/adm/searchcat?launch=1&mode=$mode&catalogmode="+mode,"srchout",options);
+   srch.focus();
+}
+// ----------------------------------------------------- launch indexer browser
+function groupsearch() {
+   srchcheck('groupsearch');
+}
+
+function groupimport() {
+   idxcheck('groupimport');
+}
+// ------------------------------------------------------- Do srch status check
+function srchcheck(mode) {
+   if (!srch || srch.closed || srchmode!=mode) {
+      srchopen(mode);
+   }
+   srch.focus();
+}
+
+// -------------------------------------------------------- Do idx status check
+function idxcheck(mode) {
+   if (!idx || idx.closed || idxmode!=mode) {
+      idxopen(mode);
+   }
+   idx.focus();
+}
+
+
+    var editbrowser;
+    function openbrowser(formname,elementname,only,omit) {
+        var url = '/res/?';
+        if (editbrowser == null) {
+            url += 'launch=1&';
+        }
+        url += 'catalogmode=interactive&';
+        url += 'mode=edit&';
+        url += 'form=' + formname + '&';
+        if (only != null) {
+            url += 'only=' + only + '&';
+        } 
+        if (omit != null) {
+            url += 'omit=' + omit + '&';
+        }
+        url += 'element=' + elementname + '';
+        var title = 'Browser';
+        var options = 'scrollbars=1,resizable=1,menubar=0';
+        options += ',width=700,height=600';
+        editbrowser = open(url,title,options,'1');
+        editbrowser.focus();
+    }
+ENDSCRIPT
+}
 # ------------------------------------------------------- Simple edit processor
 
 sub smpedt {
    my ($r,$url,$errtext)=@_;
    my $buttons=&buttons(2);
-
+   my $tmpfn=&Apache::lonnet::filelocation('',$url).'.tmp';
+   my $targetmsg='';
+   if ($ENV{'form.save'}) {
+       $targetmsg='<b>Saving ...</b><br>';
+       copy($tmpfn,&Apache::lonnet::filelocation('',$url));
+       unlink($tmpfn);
+       my ($errtext,$fatal)=
+                           &mapread(&Apache::lonnet::filelocation('',$url),'');
+   }
+   if ($ENV{'form.revert'}) {
+       $targetmsg='<b>Reverting ...</b><br>';
+       unlink($tmpfn);
+       my ($errtext,$fatal)=
+                           &mapread(&Apache::lonnet::filelocation('',$url),'');
+   }
+   if (-e $tmpfn) {
+      $targetmsg=
+        '<b><font color="red">You are working with an unsaved version of your map.</font></b><br>';
+      my ($errtext,$fatal)=&mapread($tmpfn,'');
+   }
 # ---------------------------------------------------------- Process form input
 
    my @importselect=();
@@ -536,11 +842,40 @@ 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=
        '<option value="-1"> ---- Import and Paste Area ---- </option>'.
      join("\n",map {
@@ -555,6 +890,7 @@ sub smpedt {
    } split(/\&/,$importdetail));
 
    $idx=0;
+   $targetdetail='';
    my $targetwindow=       
        '<option value="0"> ------- Target Edit Map ------- </option>'.
      join("\n",map { 
@@ -564,116 +900,19 @@ sub smpedt {
        $targetdetail.='&'.&Apache::lonnet::escape($name).'='.
 	                  &Apache::lonnet::escape($url);
        $idx++;
+       $name=~s/\&colon;/\:/g;
        '<option value="'.$idx.'">'.$name.'</option>';
    } @order);
 
 # ----------------------------------------------------- Start simple RAT screen
+   my $editscript=&editscript('simple');
+   my $bodytag=&Apache::loncommon::bodytag(undef,undef,undef,1);
    $r->print(<<ENDSMPHEAD);
 <html>
 <head>
 <script>
-var srch;
-var srchflag=-1; // 1 means currently open
-                 // 0 means closed (but has been open)
-                 // -1 means never yet opened/defined
-var srchmode='';
-
-var idx;
-var idxflag=-1; // 1 means currently open
-                 // 0 means closed (but has been open)
-                 // -1 means never yet opened/defined
-var idxmode='';
-
-// ------------------------------------------------------ Clears indexer window
-function idxclear() {
-  idx.document.clear();
-}
-
-// ------------------------------------------------------- Clears search window
-function srchclear() {
-  srch.document.clear();
-}
-
-// ------------------------------------------------------ Closes indexer window
-function idxclose() {
-  if (idx && !idx.closed) {
-    idxflag=0;
-    idx.close();
-  }
-}
-
-// ------------------------------------------------------- Closes search window
-function srchclose() {
-  if (srch && !srch.closed) {
-    srchflag=0;
-    srch.close();
-  }
-}
 
-// -------------------------------------------------------- Open indexer window
-function idxopen(mode) {
-   var options="scrollbars=1,resizable=1,menubar=0";
-   idxmode=mode;
-   idxflag=1;
-   idx=open("/res/?launch=1&mode=simple&catalogmode="+mode,"idxout",options);
-   idx.focus();
-}
-
-// --------------------------------------------------------- Open search window
-function srchopen(mode) {
-   var options="scrollbars=1,resizable=1,menubar=0";
-   srchmode=mode;
-   srchflag=1;
-   srch=open("/adm/searchcat?launch=1&mode=simple&catalogmode="+mode,"srchout",options);
-   srch.focus();
-}
-// ----------------------------------------------------- launch indexer browser
-function groupsearch() {
-   srchcheck('groupsearch');
-}
-
-function groupimport() {
-   idxcheck('groupimport');
-}
-// ------------------------------------------------------- Do srch status check
-function srchcheck(mode) {
-   if (!srch || srch.closed || srchmode!=mode) {
-      srchopen(mode);
-   }
-   srch.focus();
-}
-
-// -------------------------------------------------------- Do idx status check
-function idxcheck(mode) {
-   if (!idx || idx.closed || idxmode!=mode) {
-      idxopen(mode);
-   }
-   idx.focus();
-}
-
-
-    var editbrowser;
-    function openbrowser(formname,elementname,only,omit) {
-        var url = '/res/?';
-        if (editbrowser == null) {
-            url += 'launch=1&';
-        }
-        url += 'catalogmode=interactive&';
-        url += 'mode=edit&';
-        url += 'form=' + formname + '&';
-        if (only != null) {
-            url += 'only=' + only + '&';
-        } 
-        if (omit != null) {
-            url += 'omit=' + omit + '&';
-        }
-        url += 'element=' + elementname + '';
-        var title = 'Browser';
-        var options = 'scrollbars=1,resizable=1,menubar=0';
-        options += ',width=700,height=600';
-        editbrowser = open(url,title,options,'1');
-        editbrowser.focus();
-    }
+   $editscript
 
    function openview(entry) {
        var url=unescape((entry.split('='))[1]);
@@ -685,35 +924,57 @@ function idxcheck(mode) {
 
    function viewtarget() {
        openview((document.forms.simpleedit.targetdetail.value.split('&'))
-                [document.forms.simpleedit.target.selectedIndex+1]);
+                [document.forms.simpleedit.target.selectedIndex]);
    }
 
    function viewimport() {
        openview((document.forms.simpleedit.curimpdetail.value.split('&'))
-                [document.forms.simpleedit.importsel.selectedIndex+1]);
+                [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]);
+       var nameparts=oldname.split('&colon;');
+       oldname=unescape(nameparts.join(':'));
+       nameparts=oldname.split('&#34;');
+       oldname=unescape(nameparts.join('"'));
+       nameparts=oldname.split('&#39;');
+       oldname=unescape(nameparts.join("'"));
+       newtitle=prompt('New Title',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();
+       }
    }
 
 </script>
 </head>                 
-<body bgcolor='#FFFFFF'>
+$bodytag
 $buttons
 <font color=red>$errtext</font>
-<h1>$url</h1>
 <form name=simpleedit method=post>
 <input type=hidden name=forcesmp value=1>
+<input type=hidden name=renameres value=0>
+<input type=hidden name=renametitle value=''>
+<input type=hidden name=renameidx value=0>
 <table>
-    <tr><th width="40%">Import</th>
+    <tr><th width="40%">Temporary Assembly Workspace</th>
 <th>&nbsp;</th>
-<th width="40%">Target</th></tr>
+<th width="40%">File: $url</th></tr>
 <tr><td bgcolor="#FFFFCC">
-<input type=button onClick="javascript:groupsearch()" value="Group Search">
-<input type=button onClick="javascript:groupimport();" value="Group Import">
+<input type=button onClick="javascript:groupsearch()" value="Search">
+<input type=button onClick="javascript:groupimport();" value="Import">
 after selected
 <hr>
 <input type=text size=20 name=importmap>
 <input type=button 
 onClick="javascript:openbrowser('simpleedit','importmap','sequence,page','')"
-value="Browse"><input type=submit name=loadmap value="Load Map"><hr>
+value="Select Map"><input type=submit name=loadmap value="Load Map"><hr>
 <input type=submit name="discard" value="Discard Selected">
 <input type=submit name="clear" value="Clear All">
 <input type=button onClick="javascript:viewimport()" value="View">
@@ -721,11 +982,18 @@ value="Browse"><input type=submit name=l
     </td><td>&nbsp;</td><td bgcolor="#FFFFCC">
 
 <input type=button onClick=
-"javascript:impfortarget.value=1;groupsearch()" value="Group Search">
+"javascript:impfortarget.value=1;groupsearch()" value="Search">
 <input type=button onClick=
-"javascript:impfortarget.value=1;groupimport();" value="Group Import">
+"javascript:impfortarget.value=1;groupimport();" value="Import">
 after selected
-<hr><input type=button onClick="javascript:viewtarget()" value="View">
+<hr>
+<input type=submit name="moveup" value="Move Up">
+<input type=submit name="movedown" value="Move Down">
+<input type=button onClick="javascript:renametarget()" value="Rename">
+<hr>$targetmsg
+<input type=submit name="revert" value="Revert to Last Saved">
+<input type=submit name="save" value="Save">
+<input type=button onClick="javascript:viewtarget()" value="View">
 </td></tr>
 
 <tr><td bgcolor="#FFFFCC"><select name="importsel" size=10 multiple>
@@ -772,11 +1040,17 @@ ENDNODIR
 
 sub viewmap {
     my ($r,$url,$adv,$errtext)=@_;
-    $r->print('<html><body bgcolor="#FFFFFF">'.&buttons($adv));
+    $r->print('<html>'.
+     &Apache::loncommon::bodytag('Edit Content of a Map').
+     &buttons($adv));
     if ($errtext) {
 	$r->print($errtext.'<hr>');
     }
     my $idx=0;
+    $r->print('<h1>'.$url.'</h1>');
+    if ($adv) {
+	$r->print('<p><b><font color="red">Map contents are not shown in order.</font></b></p><br />');
+    }
     foreach (&attemptread(&Apache::lonnet::filelocation('',$url))) {
 	if (defined($_)) {
             $idx++;