--- loncom/publisher/lonupload.pm 2003/11/08 10:58:30 1.21
+++ loncom/publisher/lonupload.pm 2009/07/06 10:19:22 1.47
@@ -2,7 +2,7 @@
# The LearningOnline Network with CAPA
# Handler to upload files into construction space
#
-# $Id: lonupload.pm,v 1.21 2003/11/08 10:58:30 albertel Exp $
+# $Id: lonupload.pm,v 1.47 2009/07/06 10:19:22 bisitz Exp $
#
# Copyright Michigan State University Board of Trustees
#
@@ -28,6 +28,92 @@
#
###
+=head1 NAME
+
+Apache::lonupload - upload files into construction space
+
+=head1 SYNOPSIS
+
+Invoked by /etc/httpd/conf/srm.conf:
+
+
+ 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
+
+
+=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;
@@ -37,313 +123,357 @@ use File::Basename;
use Apache::Constants qw(:common :http :methods);
use Apache::loncacc;
use Apache::loncommon();
-use Apache::Log();
use Apache::lonnet;
use HTML::Entities();
use Apache::lonlocal;
+use Apache::lonnet;
+use LONCAPA();
my $DEBUG=0;
sub Debug {
-
- # Marshall the parameters.
-
- my $r = shift;
- my $log = $r->log;
- my $message = shift;
-
- # Put out the indicated message butonly if DEBUG is false.
-
- if ($DEBUG) {
- $log->debug($message);
- }
+ # Put out the indicated message but only if DEBUG is true.
+ if ($DEBUG) {
+ my ($r,$message) = @_;
+ $r->log_reason($message);
+ }
}
sub upfile_store {
my $r=shift;
- my $fname=$ENV{'form.upfile.filename'};
+ my $fname=$env{'form.upfile.filename'};
$fname=~s/\W//g;
- chomp($ENV{'form.upfile'});
+ chomp($env{'form.upfile'});
- my $datatoken=$ENV{'user.name'}.'_'.$ENV{'user.domain'}.
+ 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'};
+ print $fh $env{'form.upfile'};
}
return $datatoken;
}
-
sub phaseone {
- my ($r,$fn,$uname,$udom)=@_;
- $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;
+ 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(
- '');
- # Check for bad extension and warn user
- if ($fn=~/\.(\w+)$/ &&
- (&Apache::loncommon::fileembstyle($1) eq 'hdn')) {
- $r->print(
- ''.
- &mt('The extension on this file,').' "'.$1.
- '"'.&mt(', is reserved internally by LON-CAPA.').' ');
- } elsif($fn=~/\.(\w+)$/ &&
- !defined(&Apache::loncommon::fileembstyle($1))) {
- $r->print(
- ''.
- &mt('The extension on this file,').' "'.$1.
- '"'.&mt(', is not recognized by LON-CAPA.').' ');
- }
- } else {
- $r->print(''.&mt('Illegal filename.').' ');
- }
- } else {
- $r->print(''.&mt('No upload file specified.').' ');
- }
+ &Debug($r, "Filename for upload: $fn");
+ if (($fn) && ($fn!~/\/$/)) {
+ $r->print('');
+ # Check for bad extension and warn user
+ if ($fn=~/\.(\w+)$/ &&
+ (&Apache::loncommon::fileembstyle($1) eq 'hdn')) {
+ $r->print(''
+ .&mt('The extension on this file, [_1], is reserved internally by LON-CAPA.','"'.$1.'"')
+ .'
');
+ } elsif($fn=~/\.(\w+)$/ &&
+ !defined(&Apache::loncommon::fileembstyle($1))) {
+ $r->print(''
+ .&mt('The extension on this file, [_1], is not recognized by LON-CAPA.','"'.$1.'"')
+ .'
');
+ }
+ } else {
+ $r->print(''.&mt('Illegal filename.').' ');
+ }
+ } else {
+ $r->print(''.&mt('No upload file specified.').' ');
+ }
}
sub phasetwo {
- my ($r,$tfn,$uname,$udom)=@_;
- 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);
+ 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.').''.
+ &mt('Back to Directory').' '.
+ &mt('Please use browser "Back" button and pick a filename').
+ ' '.
+ &mt('Please use browser "Back" button and pick a filename').
+ ' '.$fn.' ').
+ ''.
+ &mt('The extension on this file is reserved internally by LON-CAPA.').
+ '
';
+ } elsif ($fn=~/\.(\w+)$/ &&
+ !defined(&Apache::loncommon::fileembstyle($1))) {
+ $result .= &mt('File [_1] could not be copied.',
+ ''.$fn.' ').
+ ''.
+ &mt('The extension on this file is not recognized by LON-CAPA.').
+ '
';
+ } elsif (-d $target) {
+ $result .= &mt('File [_1] could not be copied.',
+ ''.$fn.' ').
+ ''.
+ &mt('The target is an existing directory.').
+ '
';
+ } 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).'".&mt("Reference Warning")." ".
+ "".&mt("Completed upload of the file. This file contained references to other files.")."
".
+ "".&mt("Please select the locations from which the referenced files are to be uploaded.")."
".
+ &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 .= ''.&mt('Or [_1]continue[_2] the testbank import without these files','',' ').'
';
+ }
+ }
+ }
+ if (($mode ne 'imsimport') && ($mode ne 'testbank')) {
+ $result .= ''.
+ &mt('View file').' '.
+ &mt('Back to Directory').' '.$fn.' '.&mt('could not be copied.').''.
- &mt('The extension on this file is reserved internally by LON-CAPA.').
- ' ');
- $r->print(''.&mt('Back to Directory').' '.$fn.' '.&mt('could not be copied.').''.
- &mt('The extension on this file is not recognized by LON-CAPA.').
- ' ');
- $r->print('
'.&mt('Back to Directory').' '.$fn.' could not be copied.'.
- &mt('The target is an existing directory.').
- ' ');
- $r->print('
'.&mt('Back to Directory').'
'.&mt('View file').'
'.&mt('Back to Directory').'
'.&mt('Back to Directory').' '.
-&mt('Please use browser "Back" button and pick a filename').'
');
- }
- } else {
- $r->print(
- ''.&mt('Please use browser "Back" button and pick a filename').'
');
- }
+ $result = &Apache::loncommon::upload_embedded($mode,$path,$uname,$udom,
+ $dir_root,$url_root);
+ if ($mode ne 'imsimport' && $mode ne 'testbank') {
+ $result = ''.
+ &mt('View main file').' '.
+ &mt('Back to Directory').'
LON-CAPA Construction Space ');
+ $javascript = "\n";
- $r->print(&Apache::loncommon::bodytag('Upload file to Construction Space'));
+ # Breadcrumbs
+ my $brcrum = [{'href' => &Apache::loncommon::authorspace(),
+ 'text' => 'Construction Space'},
+ {'href' => '/adm/upload',
+ 'text' => 'Upload file to Construction Space'}];
+ $r->print(&Apache::loncommon::start_page('Upload file to Construction Space',
+ $javascript,
+ {'bread_crumbs' => $brcrum,})
+ .&Apache::loncommon::head_subbox(
+ &Apache::loncommon::CSTR_pageheader())
+ );
- if (($uname ne $ENV{'user.name'}) || ($udom ne $ENV{'user.domain'})) {
- $r->print(''.&mt('Co-Author').': '.$uname.
- &mt(' at ').$udom.' '
+ .&mt('Co-Author [_1]',$uname.':'.$udom)
+ .'
'
+ );
+ }
- $r->print('