--- loncom/publisher/lonretrieve.pm	2001/12/04 15:34:57	1.15
+++ loncom/publisher/lonretrieve.pm	2006/01/31 22:37:04	1.29
@@ -1,7 +1,7 @@
 # The LearningOnline Network with CAPA
 # Handler to retrieve an old version of a file
 #
-# $Id: lonretrieve.pm,v 1.15 2001/12/04 15:34:57 albertel Exp $
+# $Id: lonretrieve.pm,v 1.29 2006/01/31 22:37:04 albertel Exp $
 #
 # Copyright Michigan State University Board of Trustees
 #
@@ -26,17 +26,7 @@
 # http://www.lon-capa.org/
 #
 #
-# (Publication Handler
-# 
-# (TeX Content Handler
-#
-# 05/29/00,05/30,10/11 Gerd Kortemeyer)
-#
-# 11/28,11/29,11/30,12/01,12/02,12/04,12/23 Gerd Kortemeyer
-# 03/23 Guy Albertelli
-# 03/24,03/29 Gerd Kortemeyer)
-#
-# 03/31,04/03,05/02,05/09,06/23,08/20 Gerd Kortemeyer
+###
 
 package Apache::lonretrieve;
 
@@ -45,7 +35,11 @@ use Apache::File;
 use File::Copy;
 use Apache::Constants qw(:common :http :methods);
 use Apache::loncacc;
+use Apache::loncommon();
+use Apache::lonlocal;
+use Apache::lonnet;
 
+# ------------------------------------ Interface for selecting previous version
 sub phaseone {
     my ($r,$fn,$uname,$udom)=@_;
     my $docroot=$r->dir_config('lonDocRoot');
@@ -65,66 +59,72 @@ sub phaseone {
     $r->print('<form action=/adm/retrieve method=post>'.
 	      '<input type=hidden name=filename value="/~'.$uname.$fn.'">'.
               '<input type=hidden name=phase value=two>'.
-              '<table border=2><tr><th>Select</th><th>Version</th>'.
-              '<th>Became this version on ...</th>'.
-              '<th>Metadata</th></tr>');
-    my $filename;
+              '<table border=2><tr><th>'.&mt('Select').'</th><th>'.
+	      &mt('Version').'</th>'.
+              '<th>'.&mt('Published on ...').'</th>'.
+              '<th>'.&mt('Metadata').'</th></tr>');
+
     opendir(DIR,$resdir);
-    while ($filename=readdir(DIR)) {
-        if ($filename=~/^$main\.(\d+)\.$suffix$/) {
+    my @files = grep(/^\Q$main\E\.(\d+)\.\Q$suffix\E$/,readdir(DIR));
+    @files = sort {
+	my ($aver) = ($a=~/^\Q$main\E\.(\d+)\.\Q$suffix\E$/);
+	my ($bver) = ($b=~/^\Q$main\E\.(\d+)\.\Q$suffix\E$/);
+	return $aver <=> $bver;
+    } (@files);
+    closedir(DIR);
+
+    foreach my $filename (@files) {
+        if ($filename=~/^\Q$main\E\.(\d+)\.\Q$suffix\E$/) {
 	   my $version=$1;
-           my ($rdev,$rino,$rmode,$rnlink,
-                $ruid,$rgid,$rrdev,$rsize,
-                $ratime,$rmtime,$rctime,
-                $rblksize,$rblocks)=stat($resdir.'/'.$filename);
+           my $rmtime=&Apache::lonnet::metadata($resdir.'/'.$filename,'lastrevisiondate');
            $r->print('<tr><td><input type=radio name=version value="'.
-                     $version.'"></td><th>'.$version.'</th><td>'.
+                     $version.'"></td><td>'.&mt('Previously published version').' '.$version.'</td><td>'.
                      localtime($rmtime).'</td><td>'.
                      '<a href="'.$urldir.$filename.'.meta" target=cat>'.
-                     'Metadata Version '.$version.'</a>');
-           if (&Apache::lonnet::fileembstyle($suffix) eq 'ssi') {
+                     &mt('Metadata Version').' '.$version.'</a>');
+           if (&Apache::loncommon::fileembstyle($suffix) eq 'ssi') {
                $r->print(
                     '&nbsp;&nbsp;<a target=cat href="/adm/diff?filename=/~'.
                         $uname.$fn.
-                        '&versionone=priv&versiontwo='.$version.
-                        '">Diffs with Version '.$version.'</a>');
+                        '&versiontwo=priv&versionone='.$version.
+                        '">'.&mt('Diffs with Version').' '.$version.'</a>');
            }
            $r->print('</a></td></tr>');
         }
     }
     closedir(DIR);
-    my ($rdev,$rino,$rmode,$rnlink,
-        $ruid,$rgid,$rrdev,$rsize,
-        $ratime,$rmtime,$rctime,
-        $rblksize,$rblocks)=stat($resfn);
+    my $rmtime=&Apache::lonnet::metadata($resfn,'lastrevisiondate');
     $r->print('<tr><td><input type=radio name=version value="new"></td>'.
-              '<th>Current</th><td>'.localtime($rmtime).
+              '<th>'.&mt('Currently published version').'</th><td>'.localtime($rmtime).
            '</td><td><a href="'.$urldir.$main.'.'.$suffix.'.meta" target=cat>'.
-              'Metadata current version</a>');           
-           if (&Apache::lonnet::fileembstyle($suffix) eq 'ssi') {
+              &mt('Metadata current version').'</a>');           
+           if (&Apache::loncommon::fileembstyle($suffix) eq 'ssi') {
                $r->print(
                     '&nbsp;&nbsp;<a target=cat href="/adm/diff?filename=/~'.
                         $uname.$fn.
-                        '&versionone=priv'.
-                        '">Diffs with current Version</a>');
+                        '&versiontwo=priv'.
+                        '">'.&mt('Diffs with current Version').'</a>');
            }
            $r->print('</td></tr></table><p>'.
-           '<font size=+1 color=red>Retrieval of an old version will '.
-           'overwrite the file currently in construction space</font><p>'.
-           '<input type=submit value="Retrieve version"></form>');
+           '<font size=+1 color=red>'.
+&mt('Retrieval of an old version will overwrite the file currently in construction space').'</font><p>'.
+           '<input type=submit value="'.&mt('Retrieve version').'"></form>');
 } else {
-    $r->print('<h3>No previous versions published.</h3>');
+    $r->print('<h3>'.&mt('No previous versions published.').'</h3>');
 }
+    $r->print('<p><a href="/priv/'.$uname.$fn.'">'.&mt('Back to').' '.$fn.
+	      '</a></p>'); 
 }
 
+# ---------------------------------- Interface for presenting specified version
 sub phasetwo {
     my ($r,$fn,$uname,$udom)=@_;
-    if ($ENV{'form.version'}) {
-        my $version=$ENV{'form.version'};
+    if ($env{'form.version'}) {
+        my $version=$env{'form.version'};
 	if ($version eq 'new') {
-	    $r->print('<h3>Retrieving current (most recent) version</h3>');
+	    $r->print('<h3>'.&mt('Retrieving current (most recent) version').'</h3>');
         } else {
-            $r->print('<h3>Retrieving old version '.$version.'</h3>');
+            $r->print('<h3>'.&mt('Retrieving old version').' '.$version.'</h3>');
         }
         my $logfile;
         my $ctarget='/home/'.$uname.'/public_html'.$fn;
@@ -135,12 +135,12 @@ sub phasetwo {
         my $csource=$r->dir_config('lonDocRoot').'/res/'.$udom.'/'.$uname.$vfn;
         unless ($logfile=Apache::File->new('>>'.$ctarget.'.log')) {
 	  $r->print(
-         '<font color=red>No write permission to user directory, FAIL</font>');
+         '<font color=red>'.&mt('No write permission to user directory, FAIL').'</font>');
         }
         print $logfile 
 "\n\n================= Retrieve ".localtime()." ================\n".
 "Version: $version\nSource: $csource\nTarget: $ctarget\n";
-        $r->print('<p>Copying file: ');
+        $r->print('<p>'.&mt('Copying file').': ');
         if (copy($csource,$ctarget)) {
 	    $r->print('ok<p>');
             print $logfile "Copied sucessfully.\n\n";
@@ -150,14 +150,15 @@ sub phasetwo {
             print $logfile "Copy failed: $error\n\n";
         }
         $r->print('<font size=+2><a href="/priv/'.$uname.$fn.
-                  '">Back to '.$fn.'</a></font>'); 
+                  '">'.&mt('Back to').' '.$fn.'</a></font>'); 
     } else {
        $r->print(
-   '<font size=+1 color=red>Please pick a version to retrieve</font><p>');
+   '<font size=+1 color=red>'.&mt('Please pick a version to retrieve').'</font><p>');
        &phaseone($r,$fn,$uname,$udom);
     }
 }
 
+# ---------------------------------------------------------------- Main Handler
 sub handler {
 
   my $r=shift;
@@ -167,29 +168,20 @@ sub handler {
 
 # Get query string for limited number of parameters
 
-    map {
-       my ($name, $value) = split(/=/,$_);
-       $value =~ tr/+/ /;
-       $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
-       if ($name eq 'filename') {
-           unless ($ENV{'form.'.$name}) {
-              $ENV{'form.'.$name}=$value;
-	   }
-       }
-    } (split(/&/,$ENV{'QUERY_STRING'}));
-
+  &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},
+					  ['filename']);
 
-  if ($ENV{'form.filename'}) {
-      $fn=$ENV{'form.filename'};
+  if ($env{'form.filename'}) {
+      $fn=$env{'form.filename'};
       $fn=~s/^http\:\/\/[^\/]+//;
   } else {
-     $r->log_reason($ENV{'user.name'}.' at '.$ENV{'user.domain'}.
+     $r->log_reason($env{'user.name'}.' at '.$env{'user.domain'}.
          ' unspecified filename for retrieval', $r->filename); 
      return HTTP_NOT_FOUND;
   }
 
   unless ($fn) { 
-     $r->log_reason($ENV{'user.name'}.' at '.$ENV{'user.domain'}.
+     $r->log_reason($env{'user.name'}.' at '.$env{'user.domain'}.
          ' trying to retrieve non-existing file', $r->filename); 
      return HTTP_NOT_FOUND;
   } 
@@ -202,7 +194,7 @@ sub handler {
     &Apache::loncacc::constructaccess($fn,$r->dir_config('lonDefDomain'));
   unless (($uname) && ($udom)) {
      $r->log_reason($uname.' at '.$udom.
-         ' trying to publish file '.$ENV{'form.filename'}.
+         ' trying to publish file '.$env{'form.filename'}.
          ' ('.$fn.') - not authorized', 
          $r->filename); 
      return HTTP_NOT_ACCEPTABLE;
@@ -210,24 +202,24 @@ sub handler {
 
   $fn=~s/\/\~(\w+)//;
 
-  $r->content_type('text/html');
+  &Apache::loncommon::content_type($r,'text/html');
   $r->send_http_header;
 
   $r->print('<html><head><title>LON-CAPA Construction Space</title></head>');
 
-  $r->print(
-   '<body bgcolor="#FFFFFF"><img align=right src=/adm/lonIcons/lonlogos.gif>');
+  $r->print(&Apache::loncommon::bodytag('Retrieve Published Resources'));
 
   
-  $r->print('<h1>Retrieve previous versions of <tt>'.$fn.'</tt></h1>');
+  $r->print('<h1>'.&mt('Retrieve previous versions of').' <tt>'.$fn.'</tt></h1>');
   
-  if (($uname ne $ENV{'user.name'}) || ($udom ne $ENV{'user.domain'})) {
-          $r->print('<h3><font color=red>Co-Author: '.$uname.' at '.$udom.
+  if (($uname ne $env{'user.name'}) || ($udom ne $env{'user.domain'})) {
+          $r->print('<h3><font color=red>'.&mt('Co-Author').': '.$uname.
+		    &mt(' at ').$udom.
                '</font></h3>');
   }
 
 
-  if ($ENV{'form.phase'} eq 'two') {
+  if ($env{'form.phase'} eq 'two') {
       &phasetwo($r,$fn,$uname,$udom);
   } else {
       &phaseone($r,$fn,$uname,$udom);
@@ -239,3 +231,68 @@ sub handler {
 
 1;
 __END__
+
+=head1 NAME
+
+Apache::lonretrieve - retrieves an old version of a file
+
+=head1 SYNOPSIS
+
+Invoked by /etc/httpd/conf/srm.conf:
+
+ <Location /adm/retrieve>
+ PerlAccessHandler       Apache::lonacc
+ SetHandler perl-script
+ PerlHandler Apache::lonretrieve
+ ErrorDocument     403 /adm/login
+ ErrorDocument     404 /adm/notfound.html
+ ErrorDocument     406 /adm/unauthorized.html
+ ErrorDocument	  500 /adm/errorhandler
+ </Location>
+
+=head1 INTRODUCTION
+
+This module retrieves an old published version of a file.
+
+This is part of the LearningOnline Network with CAPA project
+described at http://www.lon-capa.org.
+
+=head1 HANDLER SUBROUTINE
+
+This routine is called by Apache and mod_perl.
+
+=over 4
+
+=item *
+
+Get query string for limited number of parameters
+
+=item *
+
+Start page output
+
+=item *
+
+print phase relevant output
+
+=item *
+
+(phase one is to select version; phase two retrieves version)
+
+=back
+
+=head1 OTHER SUBROUTINES
+
+=over 4
+
+=item *
+
+phaseone() : Interface for selecting previous version.
+
+=item *
+
+phasetwo() : Interface for presenting specified version.
+
+=back
+
+=cut