--- loncom/publisher/lonretrieve.pm	2001/12/04 15:34:57	1.15
+++ loncom/publisher/lonretrieve.pm	2001/12/17 00:57:59	1.16
@@ -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.16 2001/12/17 00:57:59 harris41 Exp $
 #
 # Copyright Michigan State University Board of Trustees
 #
@@ -30,13 +30,18 @@
 # 
 # (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
+# 12/16 Scott Harrison
+#
+###
 
 package Apache::lonretrieve;
 
@@ -45,7 +50,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');
@@ -82,7 +89,7 @@ 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.
@@ -101,7 +108,7 @@ 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.
@@ -117,6 +124,7 @@ sub phaseone {
 }
 }
 
+# ---------------------------------- Interface for presenting specified version
 sub phasetwo {
     my ($r,$fn,$uname,$udom)=@_;
     if ($ENV{'form.version'}) {
@@ -158,6 +166,7 @@ sub phasetwo {
     }
 }
 
+# ---------------------------------------------------------------- Main Handler
 sub handler {
 
   my $r=shift;
@@ -167,7 +176,7 @@ sub handler {
 
 # Get query string for limited number of parameters
 
-    map {
+    foreach (split(/&/,$ENV{'QUERY_STRING'})) {
        my ($name, $value) = split(/=/,$_);
        $value =~ tr/+/ /;
        $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
@@ -176,7 +185,7 @@ sub handler {
               $ENV{'form.'.$name}=$value;
 	   }
        }
-    } (split(/&/,$ENV{'QUERY_STRING'}));
+    }
 
 
   if ($ENV{'form.filename'}) {
@@ -239,3 +248,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