--- loncom/publisher/lonupload.pm	2001/04/05 19:35:15	1.1
+++ loncom/publisher/lonupload.pm	2009/05/14 14:24:18	1.46
@@ -1,164 +1,470 @@
+
 # The LearningOnline Network with CAPA
 # Handler to upload files into construction space
 #
-# (Handler to retrieve an old version of a file
+# $Id: lonupload.pm,v 1.46 2009/05/14 14:24:18 bisitz Exp $
+#
+# Copyright Michigan State University Board of Trustees
+#
+# This file is part of the LearningOnline Network with CAPA (LON-CAPA).
 #
-# (Publication Handler
-# 
-# (TeX Content Handler
+# 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.
 #
-# 05/29/00,05/30,10/11 Gerd Kortemeyer)
+# 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.
 #
-# 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)
+# 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
 #
-# 03/31,04/03 Gerd Kortemeyer)
+# /home/httpd/html/adm/gpl.txt
 #
-# 04/05 Gerd Kortemeyer
+# http://www.lon-capa.org/
+#
+###
+
+=head1 NAME
+
+Apache::lonupload - upload files into construction space
+
+=head1 SYNOPSIS
+
+Invoked by /etc/httpd/conf/srm.conf:
+
+ <Location /adm/upload>
+ PerlAccessHandler       Apache::lonacc
+ SetHandler perl-script
+ PerlHandler Apache::lonupload
+ ErrorDocument     403 /adm/login
+ ErrorDocument     404 /adm/notfound.html
+ ErrorDocument     406 /adm/unauthorized.html
+ ErrorDocument	  500 /adm/errorhandler
+ </Location>
+
+=head1 INTRODUCTION
+
+This module uploads a file sitting on a client computer into 
+library server construction space.
+
+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 *
+
+Initialize variables
+
+=item *
+
+Start page output
+
+=item *
+
+output relevant interface phase (phaseone or phasetwo or phasethree)
+
+=item *
+
+(phase one is to specify upload file; phase two is to handle conditions
+subsequent to specification--like overwriting an existing file; phase three
+is to handle processing of secondary uploads - of embedded objects in an
+html file).
+
+=back
+
+=head1 OTHER SUBROUTINES
+
+=over
+
+=item phaseone()
+
+Interface for specifying file to upload.
+
+=item phasetwo()
+
+Interface for handling post-conditions about uploading (such
+as overwriting an existing file).
+
+=item phasethree()
+
+Interface for handling secondary uploads of embedded objects
+in an html file.
+
+=item upfile_store()
+
+Store contents of uploaded file into temporary space.  Invoked
+by phaseone subroutine.
+
+=item check_extension()
+
+Checks if filename extension is permitted and checks type
+ of file - if html file, calls parser to check for embedded objects.
+ Invoked by phasetwo subroutine.
+
+=back
+
+=cut
 
 package Apache::lonupload;
 
 use strict;
 use Apache::File;
 use File::Copy;
+use File::Basename;
 use Apache::Constants qw(:common :http :methods);
+use Apache::loncacc;
+use Apache::loncommon();
+use Apache::lonnet;
+use HTML::Entities();
+use Apache::lonlocal;
+use Apache::lonnet;
+use LONCAPA();
+
+my $DEBUG=0;
+
+sub Debug {
+    # Put out the indicated message but only if DEBUG is true.
+    if ($DEBUG) {
+	my ($r,$message) = @_;
+	$r->log_reason($message);
+    }
+}
 
-sub phaseone {
-    my ($r,$fn,$uname,$udom)=@_;
-    my $docroot=$r->dir_config('lonDocRoot');
-
-    my $urldir='/res/'.$udom.'/'.$uname.$fn;
-    $urldir=~s/\/[^\/]+$/\//;
-
-    my $resfn=$docroot.'/res/'.$udom.'/'.$uname.$fn;
-    my $resdir=$resfn;
-    $resdir=~s/\/[^\/]+$/\//;
-
-    $fn=~/^\/(.+)\.(\w+)$/;
-    my $main=$1;
-    my $suffix=$2;
+sub upfile_store {
+    my $r=shift;
+	
+    my $fname=$env{'form.upfile.filename'};
+    $fname=~s/\W//g;
+    
+    chomp($env{'form.upfile'});
   
-    $r->print('<form action=/adm/retrieve method=post>'.
-	      '<input type=hidden name=filename value="'.$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;
-    opendir(DIR,$resdir);
-    while ($filename=readdir(DIR)) {
-        if ($filename=~/^$main\.(\d+)\.$suffix$/) {
-	   my $version=$1;
-           my ($rdev,$rino,$rmode,$rnlink,
-                $ruid,$rgid,$rrdev,$rsize,
-                $ratime,$rmtime,$rctime,
-                $rblksize,$rblocks)=stat($resdir.'/'.$filename);
-           $r->print('<tr><td><input type=radio name=version value="'.
-                     $version.'"></td><th>'.$version.'</th><td>'.
-                     localtime($rmtime).'</td><td>'.
-                     '<a href="'.$urldir.$filename.'.meta" target=cat>'.
-                     'Metadata Version '.$version.'</a></td></tr>');
-        }
+    my $datatoken=$env{'user.name'}.'_'.$env{'user.domain'}.
+		  '_upload_'.$fname.'_'.time.'_'.$$;
+    {
+       my $fh=Apache::File->new('>'.$r->dir_config('lonDaemons').
+                                   '/tmp/'.$datatoken.'.tmp');
+       print $fh $env{'form.upfile'};
+    }
+    return $datatoken;
+}
+
+sub phaseone {
+    my ($r,$fn,$uname,$udom,$mode)=@_;
+    my $action = '/adm/upload';
+    if ($mode eq 'testbank') {
+        $action = '/adm/testbank';
+    } elsif ($mode eq 'imsimport') {
+        $action = '/adm/imsimport';
+    }
+    $env{'form.upfile.filename'}=~s/\\/\//g;
+    $env{'form.upfile.filename'}=~s/^.*\/([^\/]+)$/$1/;
+    if ($env{'form.upfile.filename'}) {
+	$fn=~s/\/[^\/]+$//;
+	$fn=~s/([^\/])$/$1\//;
+	$fn.=$env{'form.upfile.filename'};
+	$fn=~s/^\///;
+	$fn=~s/(\/)+/\//g;
+
+#    Fn is the full path to the destination filename.
+#    
+
+	&Debug($r, "Filename for upload: $fn");
+	if (($fn) && ($fn!~/\/$/)) {
+	    $r->print('<form action="'.$action.'" method="post" name="fileupload">'.
+		      '<input type="hidden" name="phase" value="two" />'.
+		      '<input type="hidden" name="datatoken" value="'.
+		      &upfile_store.'" />'.
+		      '<input type="hidden" name="uploaduname" value="'.$uname.
+		      '" />'.&mt('Save uploaded file as [_1]',
+                      "<span class='LC_filename'>/priv/$uname/</span>".
+                      '<input type="text" size="50" name="filename" value="'.$fn.
+                      '" />').
+                      '<br />'.
+		      '<br />'.&mt('Choose file type:').'
+<select name="filetype">
+ <option value="standard" selected="selected">'.&mt('Regular file').'
+ <option value="testbank">'.&mt('Testbank file').'
+ <option value="imsimport">'.&mt('IMS package').'
+</select>'.&Apache::loncommon::help_open_topic("Uploading_File_Options").'
+<br />
+<br />
+');
+            $r->print('<input type="button" value="'.&mt('Save').'" onClick="javascript:verifyForm()"/></form>');
+	    # Check for bad extension and warn user
+	    if ($fn=~/\.(\w+)$/ && 
+		(&Apache::loncommon::fileembstyle($1) eq 'hdn')) {
+                $r->print('<p class="LC_error">'
+                          .&mt('The extension on this file, [_1], is reserved internally by LON-CAPA.','"'.$1.'"')
+                          .' <br />'.&mt('Please change the extension.')
+                          .'</p>');
+	    } elsif($fn=~/\.(\w+)$/ && 
+		    !defined(&Apache::loncommon::fileembstyle($1))) {
+                $r->print('<p class="LC_error">'
+                         .&mt('The extension on this file, [_1], is not recognized by LON-CAPA.','"'.$1.'"')
+                         .' <br />'.&mt('Please change the extension.')
+                         .'</p>');
+	    }
+	} else {
+	    $r->print('<span class="LC_error">'.&mt('Illegal filename.').'</span>');
+	}
+    } else {
+	$r->print('<span class="LC_error">'.&mt('No upload file specified.').'</span>');
     }
-    closedir(DIR);
-    my ($rdev,$rino,$rmode,$rnlink,
-        $ruid,$rgid,$rrdev,$rsize,
-        $ratime,$rmtime,$rctime,
-        $rblksize,$rblocks)=stat($resfn);
-    $r->print('<tr><td><input type=radio name=version value="new"></td>'.
-              '<th>Current</th><td>'.localtime($rmtime).
-           '</td><td><a href="'.$urldir.$main.'.'.$suffix.'.meta" target=cat>'.
-              'Metadata current version</a></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>');
 }
 
 sub phasetwo {
-    my ($r,$fn,$uname,$udom)=@_;
-    if ($ENV{'form.version'}) {
-        my $version=$ENV{'form.version'};
-	if ($version eq 'new') {
-	    $r->print('<h3>Retrieving current (most recent) version</h3>');
+    my ($r,$tfn,$uname,$udom,$mode)=@_;
+    my $output;
+    my $action = '/adm/upload';
+    my $returnflag = '';
+    if ($mode eq 'testbank') {
+        $action = '/adm/testbank';
+    } elsif ($mode eq 'imsimport') {
+        $action = '/adm/imsimport';
+    }
+    my $fn='/priv/'.$uname.'/'.$tfn;
+    $fn=~s/\/+/\//g;
+    &Debug($r, "Filename is ".$tfn);
+    if ($tfn) {
+	&Debug($r, "Filename for tfn = ".$tfn);
+	my $target='/home/'.$uname.'/public_html'.$tfn;
+	&Debug($r, "target -> ".$target);
+#     target is the full filesystem path of the destination file.
+	my $base = &File::Basename::basename($fn);
+	my $path = &File::Basename::dirname($fn);
+	$base    = &HTML::Entities::encode($base,'<>&"');
+	my $url  = $path."/".$base; 
+	&Debug($r, "URL is now ".$url);
+	my $datatoken=$env{'form.datatoken'};
+	if (($fn) && ($datatoken)) {
+            if ($env{'form.cancel'}) {
+                my $source=$r->dir_config('lonDaemons').'/tmp/'.$datatoken.'.tmp';
+                my $dirpath=$path.'/';
+                $dirpath=~s/\/+/\//g;
+                $output .= &mt('Upload cancelled.').'<br /><font size="+2"><a href="'.$dirpath.'">'.
+                          &mt('Back to Directory').'</a></font>';
+	    } elsif ((-e $target) && (!$env{'form.override'})) {
+		$output .= '<form action="'.$action.'" method="post">'.
+			  &mt('File [_1] exists. Overwrite?','<span class="LC_filename">'.$fn.'</span>').
+			  '<input type="hidden" name="phase" value="two" />'.
+			  '<input type="hidden" name="filename" value="'.$url.'" />'.
+			  '<input type="hidden" name="datatoken" value="'.$datatoken.'" />'.
+			  '<input type="submit" name="override" value="'.&mt('Yes').'" />'.
+                          '<input type="submit" name="cancel" value="'.&mt('Cancel').'" />'.
+                          '</form>';
+            } else {
+		my $source=$r->dir_config('lonDaemons').'/tmp/'.$datatoken.'.tmp';
+		my $dirpath=$path.'/';
+		$dirpath=~s/\/+/\//g;
+		# Check for bad extension and disallow upload
+                my $result;
+                ($result,$returnflag) = &check_extension($fn,$mode,$source,$target,$action,$dirpath,$url);
+                $output .= $result;
+	    }
+	} else {
+	    $output .= '<span class="LC_error">'.
+		      &mt('Please use browser "Back" button and pick a filename').
+		      '</span><br />';
+	}
+    } else {
+	$output .= '<span class="LC_error">'.
+		   &mt('Please use browser "Back" button and pick a filename').
+		   '</span><br />';
+    }
+    return ($output,$returnflag);
+}
+
+sub check_extension {
+    my ($fn,$mode,$source,$target,$action,$dirpath,$url) = @_;
+    my ($result,$returnflag);
+    # Check for bad extension and disallow upload
+    if ($fn=~/\.(\w+)$/ &&
+        (&Apache::loncommon::fileembstyle($1) eq 'hdn')) {
+        $result .= &mt('File [_1] could not be copied.',
+                      '<span class="LC_filename">'.$fn.'</span> ').
+                  '<p class="LC_error">'.
+                  &mt('The extension on this file is reserved internally by LON-CAPA.').
+                  '</p>';
+    } elsif ($fn=~/\.(\w+)$/ &&
+             !defined(&Apache::loncommon::fileembstyle($1))) {
+        $result .= &mt('File [_1] could not be copied.',
+                      '<span class="LC_filename">'.$fn.'</span> ').
+                  '<p class="LC_error">'.
+                  &mt('The extension on this file is not recognized by LON-CAPA.').
+                  '</p>';
+    } elsif (-d $target) {
+        $result .= &mt('File [_1] could not be copied.',
+                      '<span class="LC_filename">'.$fn.'</span>').
+                  '<p class="LC_error">'.
+                  &mt('The target is an existing directory.').
+                  '</p>';
+    } elsif (copy($source,$target)) {
+        chmod(0660, $target); # Set permissions to rw-rw---.
+        if ($mode eq 'testbank' || $mode eq 'imsimport') {
+            $returnflag = 'ok';
+            $result .= &mt('Your file - [_1] - was uploaded successfully',$fn).'<br /><br />';
         } else {
-            $r->print('<h3>Retrieving old version '.$version.'</h3>');
+            $result .= &mt('File copied.').'<br />';
         }
-        my $logfile;
-        my $ctarget='/home/'.$uname.'/public_html'.$fn;
-        my $vfn=$fn;
-        if ($version ne 'new') {
-	    $vfn=~s/\.(\w+)$/\.$version\.$1/;
+        # Check for embedded objects.
+        my (%allfiles,%codebase);
+        my ($text,$header,$css,$js);
+        if (($mode ne 'imsimport') && ($target =~ /\.(htm|html|shtml)$/i)) {
+            my (%allfiles,%codebase);
+            &Apache::lonnet::extract_embedded_items($target,\%allfiles,\%codebase);
+            if (keys(%allfiles) > 0) {
+                my $state = <<STATE;
+    <input type="hidden" name="action"      value="upload_embedded" />
+    <input type="hidden" name="currentpath" value="$env{'form.currentpath'}" />
+    <input type="hidden" name="mode"        value="$mode" />
+    <input type="hidden" name="phase"       value="three" />
+    <input type="hidden" name="filename" value="$url" />
+STATE
+                $result .= "<h3>".&mt("Reference Warning")."</h3>".
+                           "<p>".&mt("Completed upload of the file. This file contained references to other files.")."</p>".
+                          "<p>".&mt("Please select the locations from which the referenced files are to be uploaded.")."</p>".
+                          &Apache::loncommon::ask_for_embedded_content($action,$state,\%allfiles,\%codebase,
+                                      {'error_on_invalid_names'   => 1,
+                                       'ignore_remote_references' => 1,});
+                if ($mode eq 'testbank') {
+                    $returnflag = 'embedded';
+                    $result .=  '<p>'.&mt('Or [_1]continue[_2] the testbank import without these files','<a href="javascript:document.testbankForm.submit();">','</a>').'</p>';
+                }
+            }
         }
-        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>');
+        if (($mode ne 'imsimport') && ($mode ne 'testbank')) {
+            $result .= '<br /><font size="+2"><a href="'.$url.'">'.
+                        &mt('View file').'</a></font>';
         }
-        print $logfile 
-"\n\n================= Retrieve ".localtime()." ================\n".
-"Version: $version\nSource: $csource\nTarget: $ctarget\n";
-        $r->print('<p>Copying file: ');
-        if (copy($csource,$ctarget)) {
-	    $r->print('ok<p>');
-            print $logfile "Copied sucessfully.\n\n";
-        } else {
-            my $error=$!;
-	    $r->print('fail, '.$error.'<p>');
-            print $logfile "Copy failed: $error\n\n";
-        }
-        $r->print('<font size=+2><a href="/priv/'.$uname.$fn.
-                  '">Back to '.$fn.'</a></font>'); 
     } else {
-       $r->print(
-   '<font size=+1 color=red>Please pick a version to retrieve</font><p>');
-       &phaseone($r,$fn,$uname,$udom);
+        $result .= &mt('Failed to copy: [_1].',$!);
+    }
+    if ($mode ne 'imsimport' && $mode ne 'testbank') {
+        $result .= '<br /><font size="+2"><a href="'.$dirpath.'">'.
+                   &mt('Back to Directory').'</a></font><br />';
     }
+    return ($result,$returnflag);
 }
 
+sub phasethree {
+    my ($r,$fn,$uname,$udom,$mode) = @_;
+    my $result;
+    my $dir_root = '/home/'.$uname.'/public_html';
+    my $url_root = '/priv/'.$uname;
+    my $base = &File::Basename::basename($fn);
+    my $path = &File::Basename::dirname($fn);
+    $result = &Apache::loncommon::upload_embedded($mode,$path,$uname,$udom,
+                                                  $dir_root,$url_root);
+    if ($mode ne 'imsimport' && $mode ne 'testbank') {
+        $result = '<br /><font size="+2"><a href="'.$url_root.$fn.'">'.
+                  &mt('View main file').'</a></font>'.
+                  '<br /><font size="+2"><a href="'.$url_root.$path.'">'.
+                  &mt('Back to Directory').'</a></font><br />';
+    }
+    return $result;
+}
+
+# ---------------------------------------------------------------- Main Handler
 sub handler {
 
-  my $r=shift;
+    my $r=shift;
 
-  my $fn;
+    my $uname;
+    my $udom;
+    my $javascript = '';
+#
+# phase two: re-attach user
+#
+    if ($env{'form.uploaduname'}) {
+	$env{'form.filename'}='/priv/'.$env{'form.uploaduname'}.'/'.
+	    $env{'form.filename'};
+    }
 
-  if ($ENV{'form.filename'}) {
-      $fn=$ENV{'form.filename'};
-      $fn=~s/^http\:\/\/[^\/]+\/\~(\w+)//;
-  } else {
-     $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'}.
-         ' trying to retrieve non-existing file', $r->filename); 
-     return HTTP_NOT_FOUND;
-  } 
+    unless ($env{'form.phase'} eq 'two') {
+        $javascript = qq|
+function verifyForm() {
+    var mode = document.fileupload.filetype.options[document.fileupload.filetype.selectedIndex].value
+    if (mode == "testbank") {
+        document.fileupload.action = "/adm/testbank";
+    }
+    if (mode == "imsimport") {
+        document.fileupload.action = "/adm/imsimport";
+    }
+    if (mode == "standard") {
+        document.fileupload.action = "/adm/upload";
+    }
+    document.fileupload.submit();
+}
+	|;
+    }
+    ($uname,$udom)=
+	&Apache::loncacc::constructaccess($env{'form.filename'},
+					  $r->dir_config('lonDefDomain'));
+
+    unless (($uname) && ($udom)) {
+	$r->log_reason($uname.' at '.$udom.
+		       ' trying to publish file '.$env{'form.filename'}.
+		       ' - not authorized', 
+		       $r->filename); 
+	return HTTP_NOT_ACCEPTABLE;
+    }
+    
+    my $fn;
+    if ($env{'form.filename'}) {
+	$fn=$env{'form.filename'};
+	$fn=~s/^https?\:\/\/[^\/]+\///;
+	$fn=~s/^\///;
+	$fn=~s{(~|priv/)($LONCAPA::username_re)}{};
+	$fn=~s/\/+/\//g;
+    } else {
+	$r->log_reason($env{'user.name'}.' at '.$env{'user.domain'}.
+		       ' unspecified filename for upload', $r->filename); 
+	return HTTP_NOT_FOUND;
+    }
 
 # ----------------------------------------------------------- Start page output
 
-  my $uname=$ENV{'user.name'};
-  my $udom=$ENV{'user.domain'};
-
-  $r->content_type('text/html');
-  $r->send_http_header;
 
-  $r->print('<html><head><title>LON-CAPA Construction Space</title></head>');
+    &Apache::loncommon::content_type($r,'text/html');
+    $r->send_http_header;
 
-  $r->print(
-   '<body bgcolor="#FFFFFF"><img align=right src=/adm/lonIcons/lonlogos.gif>');
+   $javascript = "<script type=\"text/javascript\">\n//<!--\n".
+	$javascript."\n// --></script>\n";
 
+    $r->print(&Apache::loncommon::start_page('Upload file to Construction Space',
+					     $javascript));
   
-  $r->print('<h1>Retrieve previous versions of <tt>'.$fn.'</tt></h1>');
+    if (($uname ne $env{'user.name'}) || ($udom ne $env{'user.domain'})) {
+        $r->print('<p class="LC_warning">'
+                 .&mt('Co-Author [_1]',$uname.':'.$udom)
+                 .'</p>'
+        );
+    }
 
-  if ($ENV{'form.phase'} eq 'two') {
-      &phasetwo($r,$fn,$uname,$udom);
-  } else {
-      &phaseone($r,$fn,$uname,$udom);
-  }
+    if ($env{'form.phase'} eq 'three') {
+        my $output = &phasethree($r,$fn,$uname,$udom,'author');
+        $r->print($output);
+    } elsif ($env{'form.phase'} eq 'two') {
+	my ($output,$returnflag) = &phasetwo($r,$fn,$uname,$udom);
+        $r->print($output);
+    } else {
+	&phaseone($r,$fn,$uname,$udom);
+    }
 
-  $r->print('</body></html>');
-  return OK;  
+    $r->print(&Apache::loncommon::end_page());
+    return OK;  
 }
+
+1;
+__END__
+
+