--- loncom/publisher/lonupload.pm 2006/04/06 22:15:19 1.31 +++ loncom/publisher/lonupload.pm 2011/11/07 13:38:45 1.53.2.1 @@ -2,7 +2,7 @@ # The LearningOnline Network with CAPA # Handler to upload files into construction space # -# $Id: lonupload.pm,v 1.31 2006/04/06 22:15:19 albertel Exp $ +# $Id: lonupload.pm,v 1.53.2.1 2011/11/07 13:38:45 raeburn Exp $ # # Copyright Michigan State University Board of Trustees # @@ -28,6 +28,97 @@ # ### +=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, phasetwo, phasethree or phasefour) + +=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 phasefour() + +Interface for handling optional renaming of links to embedded +objects. + +=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; @@ -41,6 +132,7 @@ use Apache::lonnet; use HTML::Entities(); use Apache::lonlocal; use Apache::lonnet; +use LONCAPA(); my $DEBUG=0; @@ -70,7 +162,6 @@ sub upfile_store { return $datatoken; } - sub phaseone { my ($r,$fn,$uname,$udom,$mode)=@_; my $action = '/adm/upload'; @@ -79,68 +170,80 @@ sub phaseone { } elsif ($mode eq 'imsimport') { $action = '/adm/imsimport'; } + + # Check for file to be uploaded $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('
'. - ''. - ''. - ''.&mt('Store uploaded file as '). - "/priv/$uname/". - '
'); - $r->print('
'.&mt('Please indicate the type of file you are uploading. The possible types of file are as follows:').' - -
'.&mt('Choose file type:').' - -
-
-'); - $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.'). - '
'.&mt('Please change the extension.').'
'); - } elsif($fn=~/\.(\w+)$/ && - !defined(&Apache::loncommon::fileembstyle($1))) { - $r->print(''.&mt('The extension on this file,'). - ' "'.$1.'"'.&mt(', is not recognized by LON-CAPA.'). - '
'.&mt('Please change the extension.'). - '
'); - } - } else { - $r->print(''.&mt('Illegal filename.').''); - } - } else { - $r->print(''.&mt('No upload file specified.').''); + if (!$env{'form.upfile.filename'}) { + $r->print('

'.&mt('No upload file specified.').'

'); + return; + } + + $fn=~s/\/[^\/]+$//; + $fn=~s/([^\/])$/$1\//; + $fn.=$env{'form.upfile.filename'}; + $fn=~s/^\///; + $fn=~s/(\/)+/\//g; + # Fn is the full path to the destination filename. + + # Check for illegal filename + &Debug($r, "Filename for upload: $fn"); + if (!(($fn) && ($fn!~/\/$/))) { + $r->print('

'.&mt('Illegal filename.').'

'); + return; + } + + # Display additional options for upload + # and upload button + $r->print( + '
' + .'' + .'' + .'' + ); + $r->print( + &Apache::lonhtmlcommon::start_pick_box() + .&Apache::lonhtmlcommon::row_title(&mt('Save uploaded file as')) + .'/priv/'.$uname.'/' + .'' + .&Apache::lonhtmlcommon::row_closure() + .&Apache::lonhtmlcommon::row_title(&mt('File Type')) + .''.&Apache::loncommon::help_open_topic("Uploading_File_Options") + .&Apache::lonhtmlcommon::row_closure(1) + .&Apache::lonhtmlcommon::end_pick_box() + ); + $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.'') + .'
'.&mt('Please change the extension.') + .'

'); + } elsif($fn=~/\.(\w+)$/ && + !defined(&Apache::loncommon::fileembstyle($1))) { + $r->print('

' + .&mt('The extension on this file, [_1], is not recognized by LON-CAPA.', + ''.$1.'') + .'
'.&mt('Please change the extension.') + .'

'); } } sub phasetwo { my ($r,$tfn,$uname,$udom,$mode)=@_; + my $output; my $action = '/adm/upload'; my $returnflag = ''; if ($mode eq 'testbank') { @@ -163,73 +266,196 @@ sub phasetwo { &Debug($r, "URL is now ".$url); my $datatoken=$env{'form.datatoken'}; if (($fn) && ($datatoken)) { - if ((-e $target) && ($env{'form.override'} ne 'Yes')) { - $r->print('
'. - &mt('File').' '.$fn.' '. - &mt('exists. Overwrite?').' '. - ''. - ''. - ''. - '
'); - } else { + 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').'

'; + } elsif ((-e $target) && (!$env{'form.override'})) { + $output .= '
' + .'

' + .&mt('File [_1] already exists.', + ''.$fn.'') + .'' + .'' + .'' + .'

' + .'' + .' ' + .'

' + .'
'; + } else { my $source=$r->dir_config('lonDaemons').'/tmp/'.$datatoken.'.tmp'; my $dirpath=$path.'/'; $dirpath=~s/\/+/\//g; # Check for bad extension and disallow upload - if ($fn=~/\.(\w+)$/ && - (&Apache::loncommon::fileembstyle($1) eq 'hdn')) { - $r->print(&mt('File').' '.$fn.' '. - &mt('could not be copied.').'
'. - ''. - &mt('The extension on this file is reserved internally by LON-CAPA.'). - ''); - $r->print('
'. - &mt('Back to Directory').''); - } elsif ($fn=~/\.(\w+)$/ && - !defined(&Apache::loncommon::fileembstyle($1))) { - $r->print(&mt('File').' '.$fn.' '. - &mt('could not be copied.').'
'. - ''. - &mt('The extension on this file is not recognized by LON-CAPA.'). - ''); - $r->print('
'. - &mt('Back to Directory').''); - } elsif (-d $target) { - $r->print('File '.$fn.' could not be copied.
'. - ''. - &mt('The target is an existing directory.'). - '
'); - $r->print(''. - &mt('Back to Directory').''); - } elsif (copy($source,$target)) { - chmod(0660, $target); # Set permissions to rw-rw---. - if ($mode eq 'testbank' || $mode eq 'imsimport') { - $r->print(&mt("Your file - $fn - was uploaded successfully")."

"); - $returnflag = 'ok'; - } else { - $r->print(&mt('File copied.')); - $r->print('
'. - &mt('View file').''); - $r->print('
'. - &mt('Back to Directory').'
'); - } - } else { - $r->print('Failed to copy: '.$!); - $r->print('
'. - &mt('Back to Directory').''); - } + my $result; + ($result,$returnflag) = &check_extension($fn,$mode,$source,$target,$action,$dirpath,$url); + $output .= $result; } } else { - $r->print(''. + $output .= ''. &mt('Please use browser "Back" button and pick a filename'). - '
'); + '
'; } } else { - $r->print(''. - &mt('Please use browser "Back" button and pick a filename'). - '
>'); + $output .= ''. + &mt('Please use browser "Back" button and pick a filename'). + '
'; } - return $returnflag; + 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.', + ''.$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.'') + .'

'; + } else { + $result .= '

' + .&mt('File copied.') + .'

'; + } + # 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 ($currentpath) = ($url =~ m{^(.+)/[^/]+$}); + my $state = &embedded_form_elems('upload_embedded',$url,$mode); + my ($embedded,$num,$pathchg) = + &Apache::loncommon::ask_for_embedded_content($action,$state,\%allfiles, + \%codebase, + {'error_on_invalid_names' => 1, + 'ignore_remote_references' => 1, + 'current_path' => $currentpath}); + if ($embedded) { + $result .= '

'.&mt('Reference Warning').'

'; + if ($num) { + $result .= '

'.&mt('Completed upload of the file.').' '.&mt('This file contained references to other files.').'

'. + '

'.&mt('Please select the locations from which the referenced files are to be uploaded.').'

'. + $embedded; + if ($mode eq 'testbank') { + $returnflag = 'embedded'; + $result .= '

'.&mt('Or [_1]continue[_2] the testbank import without these files.','','').'

'; + } + } else { + $result .= '

'.&mt('Completed upload of the file.').'

'.$embedded; + if ($pathchg) { + if ($mode eq 'testbank') { + $returnflag = 'embedded'; + $result .= '

'.&mt('Or [_1]continue[_2] the testbank import without modifying the references(s).','','').'

'; + } + } + } + } + } + } + if (($mode ne 'imsimport') && ($mode ne 'testbank')) { + $result .= '
'. + &mt('View file').''; + } + } else { + $result .= &mt('Failed to copy: [_1].',$!); + } + if ($mode ne 'imsimport' && $mode ne 'testbank') { + $result .= '
'. + &mt('Back to Directory').'
'; + } + return ($result,$returnflag); +} + +sub phasethree { + my ($r,$fn,$uname,$udom,$mode) = @_; + my $action = '/adm/upload'; + if ($mode eq 'testbank') { + $action = '/adm/testbank'; + } elsif ($mode eq 'imsimport') { + $action = '/adm/imsimport'; + } + my $dir_root = '/home/'.$uname.'/public_html'; + my $url_root = '/priv/'.$uname; + my $path = &File::Basename::dirname($fn); + my $filename = &HTML::Entities::encode($env{'form.filename'},'<>&"'); + my $state = &embedded_form_elems('modify_orightml',$filename,$mode). + ''; + my ($result,$returnflag) = + &Apache::loncommon::upload_embedded($mode,$path,$uname,$udom, + $dir_root,$url_root,undef, + undef,undef,$state,$action); + if ($mode ne 'imsimport' && $mode ne 'testbank') { + $result .= '

'. + &mt('View main file').'

'. + '

'. + &mt('Back to Directory').'


'; + } + return ($result,$returnflag); +} + +sub embedded_form_elems { + my ($action,$filename,$mode) = @_; + return < + + +STATE +} + +sub phasefour { + my ($r,$fn,$uname,$udom,$mode) = @_; + my $action = '/adm/upload'; + if ($mode eq 'testbank') { + $action = '/adm/testbank'; + } elsif ($mode eq 'imsimport') { + $action = '/adm/imsimport'; + } + my $result; + my $dir_root = '/home/'.$uname.'/public_html'; + my $url_root = '/priv/'.$uname; + my $path = &File::Basename::dirname($fn); + $result .= &Apache::loncommon::modify_html_refs($mode,$path, + $uname,$udom,$dir_root); + if ($mode ne 'imsimport' && $mode ne 'testbank') { + $result .= '

'. + &mt('View main file').'

'. + '

'. + &mt('Back to Directory').'


'; + } + return $result; } # ---------------------------------------------------------------- Main Handler @@ -249,15 +475,6 @@ sub handler { } unless ($env{'form.phase'} eq 'two') { - my $start_page = - &Apache::loncommon::start_page('Importing a Testbank file into LON-CAPA', - undef, - {'only_body' => 1, - 'add_entries' => "topmargin='0' leftmargin='0' marginheight='0'marginwidth='0' rightmargin='0'", - 'js_ready' => 1,}); - my $end_page = - &Apache::loncommon::end_page({'js_ready' => 1,}); - $javascript = qq| function verifyForm() { var mode = document.fileupload.filetype.options[document.fileupload.filetype.selectedIndex].value @@ -272,32 +489,12 @@ function verifyForm() { } document.fileupload.submit(); } - -function testbankWin() { - newWindow = window.open("","testbankinfo","HEIGHT=400,WIDTH=750,scrollbars=yes") - newWindow.document.open() - newWindow.document.write('$start_page') - newWindow.document.write("[Author Header]\\n") - newWindow.document.write("\\n") - newWindow.document.write("\\n") - newWindow.document.write("\\n") - newWindow.document.write("
  

Importing Testbank questions into LON-CAPA

") - newWindow.document.write("
Four requirements must be met to ensure that you will succeed in building LON-CAPA problem files using your plain text file containing testbank questions.") - newWindow.document.write("
  1. The questions and answers you upload must be in plain text format. Any header lines should occur before the text containing the questions and answers.
  2. ") - newWindow.document.write("
  3. All questions must occur before any of the answers. Each question should be numbered sequentially using a number followed immediately by a space, a period, or enclosed in parentheses, i.e., 1 , 1., (1), 1), or (1 .
  4. ") - newWindow.document.write("
  5. One or more correct answers should be provided for all questions (although blank answers may be provided for essay questions). Answers should be numbered sequentially, using the same scheme as used for the questions, and must occur after all the questions.") - newWindow.document.write("
  6. Multiple choice and multiple answer correct questions should consist of (i) the question number followed by (ii) a question stem beginning on the same line and (iii) two or more foils, with each foil beginning on a new line and prefixed by a unique letter, or Roman numeral, listed in alphabetic or numeric order, beginning at a (alphabetic) or i (Roman numeral), followed by a period, or enclosed in parentheses, i.e., a., (a), i., or (i) .
  7. ") - newWindow.document.write("
  8. If fill-in-the-blank or multiple answer questions have more than one correct answer, each answer should appear in a comma-, tab-, space-, or new line-delimited list.
") - newWindow.document.write("
") - newWindow.document.write('$end_page') - newWindow.document.close() - newWindow.focus() -} -|; + |; } ($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'}. @@ -306,13 +503,15 @@ function testbankWin() { return HTTP_NOT_ACCEPTABLE; } - my $fn; + my ($fn,$trailfile); if ($env{'form.filename'}) { $fn=$env{'form.filename'}; - $fn=~s/^http\:\/\/[^\/]+\///; + $fn=~s/^https?\:\/\/[^\/]+\///; $fn=~s/^\///; - $fn=~s/(\~|priv\/)(\w+)//; + $fn=~s{(~|priv/)($LONCAPA::username_re)}{}; $fn=~s/\/+/\//g; + $trailfile = "/home/$uname/public_html/".$trailfile; + $trailfile=~s{//+}{/}g; } else { $r->log_reason($env{'user.name'}.' at '.$env{'user.domain'}. ' unspecified filename for upload', $r->filename); @@ -328,16 +527,33 @@ function testbankWin() { $javascript = "\n"; + # 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)); + $javascript, + {'bread_crumbs' => $brcrum,}) + .&Apache::loncommon::head_subbox( + &Apache::loncommon::CSTR_pageheader($trailfile)) + ); if (($uname ne $env{'user.name'}) || ($udom ne $env{'user.domain'})) { - $r->print('

'.&mt('Co-Author').': '.$uname. - &mt(' at ').$udom.'

'); - } - - if ($env{'form.phase'} eq 'two') { - &phasetwo($r,$fn,$uname,$udom); + $r->print('

' + .&mt('Co-Author [_1]',$uname.':'.$udom) + .'

' + ); + } + if ($env{'form.phase'} eq 'four') { + my $output = &phasefour($r,$fn,$uname,$udom,'author'); + $r->print($output); + } elsif ($env{'form.phase'} eq 'three') { + my ($output,$rtnflag) = &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); } @@ -349,75 +565,4 @@ function testbankWin() { 1; __END__ -=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) - -=item * - -(phase one is to specify upload file; phase two is to handle conditions -subsequent to specification--like overwriting an existing file) - -=back - -=head1 OTHER SUBROUTINES - -=over 4 - -=item * - -phaseone() : Interface for specifying file to upload. - -=item * - -phasetwo() : Interface for handling post-conditions about uploading (such -as overwriting an existing file). - -=item * - -upfile_store() : Store contents of uploaded file into temporary space. Invoked -by phaseone subroutine. - -=back - -=cut