--- loncom/publisher/lonretrieve.pm	2001/08/20 13:18:41	1.14
+++ loncom/publisher/lonretrieve.pm	2003/05/19 21:53:03	1.22
@@ -1,17 +1,46 @@
 # The LearningOnline Network with CAPA
 # Handler to retrieve an old version of a file
 #
+# $Id: lonretrieve.pm,v 1.22 2003/05/19 21:53:03 albertel 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/
+#
+#
 # (Publication Handler
 # 
 # (TeX Content Handler
 #
+# YEAR=2000
 # 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
+# YEAR=2001
 # 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;
 
@@ -20,7 +49,9 @@ use Apache::File;
 use File::Copy;
 use Apache::Constants qw(:common :http :methods);
 use Apache::loncacc;
+use Apache::loncommon();
 
+# ------------------------------------ Interface for selecting previous version
 sub phaseone {
     my ($r,$fn,$uname,$udom)=@_;
     my $docroot=$r->dir_config('lonDocRoot');
@@ -46,7 +77,7 @@ sub phaseone {
     my $filename;
     opendir(DIR,$resdir);
     while ($filename=readdir(DIR)) {
-        if ($filename=~/^$main\.(\d+)\.$suffix$/) {
+        if ($filename=~/^\Q$main\E\.(\d+)\.\Q$suffix\E$/) {
 	   my $version=$1;
            my ($rdev,$rino,$rmode,$rnlink,
                 $ruid,$rgid,$rrdev,$rsize,
@@ -57,11 +88,11 @@ sub phaseone {
                      localtime($rmtime).'</td><td>'.
                      '<a href="'.$urldir.$filename.'.meta" target=cat>'.
                      'Metadata Version '.$version.'</a>');
-           if (&Apache::lonnet::fileembstyle($suffix) eq 'ssi') {
+           if (&Apache::loncommon::fileembstyle($suffix) eq 'ssi') {
                $r->print(
                     '&nbsp;&nbsp;<a target=cat href="/adm/diff?filename=/~'.
                         $uname.$fn.
-                        '&versionone=priv&versiontwo='.$version.
+                        '&versiontwo=priv&versiontwo='.$version.
                         '">Diffs with Version '.$version.'</a>');
            }
            $r->print('</a></td></tr>');
@@ -76,11 +107,11 @@ sub phaseone {
               '<th>Current</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') {
+           if (&Apache::loncommon::fileembstyle($suffix) eq 'ssi') {
                $r->print(
                     '&nbsp;&nbsp;<a target=cat href="/adm/diff?filename=/~'.
                         $uname.$fn.
-                        '&versionone=priv'.
+                        '&versiontwo=priv'.
                         '">Diffs with current Version</a>');
            }
            $r->print('</td></tr></table><p>'.
@@ -92,6 +123,7 @@ sub phaseone {
 }
 }
 
+# ---------------------------------- Interface for presenting specified version
 sub phasetwo {
     my ($r,$fn,$uname,$udom)=@_;
     if ($ENV{'form.version'}) {
@@ -133,6 +165,7 @@ sub phasetwo {
     }
 }
 
+# ---------------------------------------------------------------- Main Handler
 sub handler {
 
   my $r=shift;
@@ -142,17 +175,8 @@ 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'};
@@ -190,8 +214,7 @@ sub handler {
 
   $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>');
@@ -214,3 +237,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