Diff for /loncom/publisher/lonupload.pm between versions 1.35 and 1.48

version 1.35, 2007/05/02 01:34:23 version 1.48, 2009/07/06 13:30:49
Line 28 Line 28
 #  #
 ###  ###
   
   =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;  package Apache::lonupload;
   
 use strict;  use strict;
Line 71  sub upfile_store { Line 157  sub upfile_store {
     return $datatoken;      return $datatoken;
 }  }
   
   
 sub phaseone {  sub phaseone {
     my ($r,$fn,$uname,$udom,$mode)=@_;      my ($r,$fn,$uname,$udom,$mode)=@_;
     my $action = '/adm/upload';      my $action = '/adm/upload';
Line 99  sub phaseone { Line 184  sub phaseone {
       '<input type="hidden" name="datatoken" value="'.        '<input type="hidden" name="datatoken" value="'.
       &upfile_store.'" />'.        &upfile_store.'" />'.
       '<input type="hidden" name="uploaduname" value="'.$uname.        '<input type="hidden" name="uploaduname" value="'.$uname.
       '" />'.&mt('Save uploaded file as ').        '" />'.&mt('Save uploaded file as [_1]',
                       "<span class='LC_filename'>/priv/$uname/</span>".                        "<span class='LC_filename'>/priv/$uname/</span>".
                       '<input type="text" size="50" name="filename" value="'.$fn.                        '<input type="text" size="50" name="filename" value="'.$fn.
                       '" /><br />'.                        '" />').
                         '<br />'.
       '<br />'.&mt('Choose file type:').'        '<br />'.&mt('Choose file type:').'
 <select name="filetype">  <select name="filetype">
  <option value="standard" selected>'.&mt('Regular file').'   <option value="standard" selected="selected">'.&mt('Regular file').'</option>
  <option value="testbank">'.&mt('Testbank file').'   <option value="testbank">'.&mt('Testbank file').'</option>
  <option value="imsimport">'.&mt('IMS package').'   <option value="imsimport">'.&mt('IMS package').'</option>
 </select>'.&Apache::loncommon::help_open_topic("Uploading_File_Options").'  </select>'.&Apache::loncommon::help_open_topic("Uploading_File_Options").'
 <br />  <br />
 <br />  <br />
 ');  ');
             $r->print('<input type="button" value="'.&mt('Save').'" onClick="javascript:verifyForm()"/></form>');              $r->print('<input type="button" value="'.&mt('Upload').'" onclick="javascript:verifyForm()"/></form>');
     # Check for bad extension and warn user      # Check for bad extension and warn user
     if ($fn=~/\.(\w+)$/ &&       if ($fn=~/\.(\w+)$/ && 
  (&Apache::loncommon::fileembstyle($1) eq 'hdn')) {   (&Apache::loncommon::fileembstyle($1) eq 'hdn')) {
  $r->print('<span class="LC_error">'.&mt('The extension on this file,').                  $r->print('<p class="LC_error">'
   ' "'.$1.'"'.&mt(', is reserved internally by LON-CAPA.').                            .&mt('The extension on this file, [_1], is reserved internally by LON-CAPA.','"'.$1.'"')
   ' <br />'.&mt('Please change the extension.').'</span>');                            .' <br />'.&mt('Please change the extension.')
                             .'</p>');
     } elsif($fn=~/\.(\w+)$/ &&       } elsif($fn=~/\.(\w+)$/ && 
     !defined(&Apache::loncommon::fileembstyle($1))) {      !defined(&Apache::loncommon::fileembstyle($1))) {
  $r->print('<span class="LC_error">'.&mt('The extension on this file,').                  $r->print('<p class="LC_error">'
   ' "'.$1.'"'.&mt(', is not recognized by LON-CAPA.').                           .&mt('The extension on this file, [_1], is not recognized by LON-CAPA.','"'.$1.'"')
   ' <br />'.&mt('Please change the extension.').                           .' <br />'.&mt('Please change the extension.')
   '</span>');                           .'</p>');
     }      }
  } else {   } else {
     $r->print('<span class="LC_error">'.&mt('Illegal filename.').'</span>');      $r->print('<span class="LC_error">'.&mt('Illegal filename.').'</span>');
Line 136  sub phaseone { Line 223  sub phaseone {
   
 sub phasetwo {  sub phasetwo {
     my ($r,$tfn,$uname,$udom,$mode)=@_;      my ($r,$tfn,$uname,$udom,$mode)=@_;
       my $output;
     my $action = '/adm/upload';      my $action = '/adm/upload';
     my $returnflag = '';      my $returnflag = '';
     if ($mode eq 'testbank') {      if ($mode eq 'testbank') {
Line 158  sub phasetwo { Line 246  sub phasetwo {
  &Debug($r, "URL is now ".$url);   &Debug($r, "URL is now ".$url);
  my $datatoken=$env{'form.datatoken'};   my $datatoken=$env{'form.datatoken'};
  if (($fn) && ($datatoken)) {   if (($fn) && ($datatoken)) {
     if ((-e $target) && ($env{'form.override'} ne 'Yes')) {              if ($env{'form.cancel'}) {
  $r->print('<form action="'.$action.'" method="post">'.                  my $source=$r->dir_config('lonDaemons').'/tmp/'.$datatoken.'.tmp';
   &mt('File').' <span class="LC_filename">'.$fn.'</span> '.                  my $dirpath=$path.'/';
   &mt('exists. Overwrite?').' '.                  $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="phase" value="two" />'.
   '<input type="hidden" name="filename" value="'."$url".'" />'.    '<input type="hidden" name="filename" value="'.$url.'" />'.
   '<input type="hidden" name="datatoken" value="'.$datatoken.'" />'.    '<input type="hidden" name="datatoken" value="'.$datatoken.'" />'.
   '<input type="submit" name="override" value="'.&mt('Yes').'" /></form>');    '<input type="submit" name="override" value="'.&mt('Yes').'" />'.
     } else {                            '<input type="submit" name="cancel" value="'.&mt('Cancel').'" />'.
                             '</form>';
               } else {
  my $source=$r->dir_config('lonDaemons').'/tmp/'.$datatoken.'.tmp';   my $source=$r->dir_config('lonDaemons').'/tmp/'.$datatoken.'.tmp';
  my $dirpath=$path.'/';   my $dirpath=$path.'/';
  $dirpath=~s/\/+/\//g;   $dirpath=~s/\/+/\//g;
  # Check for bad extension and disallow upload   # Check for bad extension and disallow upload
  if ($fn=~/\.(\w+)$/ &&                   my $result;
     (&Apache::loncommon::fileembstyle($1) eq 'hdn')) {                  ($result,$returnflag) = &check_extension($fn,$mode,$source,$target,$action,$dirpath,$url);
     $r->print(&mt('File').' <span class="LC_filename">'.$fn.'</span> '.                  $output .= $result;
       &mt('could not be copied.').'<br />'.  
       '<span class="LC_error">'.  
       &mt('The extension on this file is reserved internally by LON-CAPA.').  
       '</span>');  
     $r->print('<br /><font size=+2><a href="'.$dirpath.'">'.  
       &mt('Back to Directory').'</a></font>');  
  } elsif ($fn=~/\.(\w+)$/ &&   
  !defined(&Apache::loncommon::fileembstyle($1))) {  
     $r->print(&mt('File').' <span class="LC_filename">'.$fn.'</span> '.  
       &mt('could not be copied.').'<br />'.  
       '<span class="LC_error">'.  
       &mt('The extension on this file is not recognized by LON-CAPA.').  
       '</span>');  
     $r->print('<br /><font size="+2"><a href="'.$dirpath.'">'.  
       &mt('Back to Directory').'</a></font>');  
  } elsif (-d $target) {  
     $r->print('File <span class="LC_filename">'.$fn.'</span> could not be copied.<br />'.  
       '<span class="LC_error">'.  
       &mt('The target is an existing directory.').  
       '</span><br />');  
     $r->print('<font size="+2"><a href="'.$dirpath.'">'.  
       &mt('Back to Directory').'</a></font>');  
  } 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")."<br /><br />");  
                         $returnflag = 'ok';  
                     } else {  
                         $r->print(&mt('File copied.'));  
         $r->print('<br /><font size="+2"><a href="'.$url.'">'.  
       &mt('View file').'</a></font>');  
         $r->print('<br /><font size="+2"><a href="'.$dirpath.'">'.  
       &mt('Back to Directory').'</a></font><br />');  
                     }  
  } else {  
     $r->print('Failed to copy: '.$!);  
     $r->print('<br /><font size="+2"><a href="'.$path.'">'.  
       &mt('Back to Directory').'</a></font>');  
  }  
     }      }
  } else {   } else {
     $r->print('<span class="LC_error">'.      $output .= '<span class="LC_error">'.
       &mt('Please use browser "Back" button and pick a filename').        &mt('Please use browser "Back" button and pick a filename').
       '</span><br />');        '</span><br />';
  }   }
     } else {      } else {
  $r->print('<span class="LC_error">'.   $output .= '<span class="LC_error">'.
   &mt('Please use browser "Back" button and pick a filename').     &mt('Please use browser "Back" button and pick a filename').
   '</span><br />>');     '</span><br />';
     }      }
     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.',
                         '<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 {
               $result .= &mt('File copied.').'<br />';
           }
           # 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>';
                   }
               }
           }
           if (($mode ne 'imsimport') && ($mode ne 'testbank')) {
               $result .= '<br /><font size="+2"><a href="'.$url.'">'.
                           &mt('View file').'</a></font>';
           }
       } else {
           $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  # ---------------------------------------------------------------- Main Handler
Line 244  sub handler { Line 390  sub handler {
     }      }
   
     unless ($env{'form.phase'} eq 'two') {      unless ($env{'form.phase'} eq 'two') {
  my %body_layout = ('rightmargin'  => "0",  
    'leftmargin'   => "0",  
    'marginwidth'  => "0",  
    'topmargin'    => "0",  
    'marginheight' => "0");  
  my $start_page =   
     &Apache::loncommon::start_page('Importing a Testbank file into LON-CAPA',  
    undef,  
    {'only_body'   => 1,  
     'add_entries' => \%body_layout,  
     'js_ready'    => 1,});  
  my $end_page =   
     &Apache::loncommon::end_page({'js_ready' => 1,});  
   
         $javascript = qq|          $javascript = qq|
 function verifyForm() {  function verifyForm() {
     var mode = document.fileupload.filetype.options[document.fileupload.filetype.selectedIndex].value      var mode = document.fileupload.filetype.options[document.fileupload.filetype.selectedIndex].value
Line 277  function verifyForm() { Line 409  function verifyForm() {
     ($uname,$udom)=      ($uname,$udom)=
  &Apache::loncacc::constructaccess($env{'form.filename'},   &Apache::loncacc::constructaccess($env{'form.filename'},
   $r->dir_config('lonDefDomain'));    $r->dir_config('lonDefDomain'));
   
     unless (($uname) && ($udom)) {      unless (($uname) && ($udom)) {
  $r->log_reason($uname.' at '.$udom.   $r->log_reason($uname.' at '.$udom.
        ' trying to publish file '.$env{'form.filename'}.         ' trying to publish file '.$env{'form.filename'}.
Line 288  function verifyForm() { Line 421  function verifyForm() {
     my $fn;      my $fn;
     if ($env{'form.filename'}) {      if ($env{'form.filename'}) {
  $fn=$env{'form.filename'};   $fn=$env{'form.filename'};
  $fn=~s/^http\:\/\/[^\/]+\///;   $fn=~s/^https?\:\/\/[^\/]+\///;
  $fn=~s/^\///;   $fn=~s/^\///;
  $fn=~s{(~|priv/)($LONCAPA::username_re)}{};   $fn=~s{(~|priv/)($LONCAPA::username_re)}{};
  $fn=~s/\/+/\//g;   $fn=~s/\/+/\//g;
Line 307  function verifyForm() { Line 440  function verifyForm() {
    $javascript = "<script type=\"text/javascript\">\n//<!--\n".     $javascript = "<script type=\"text/javascript\">\n//<!--\n".
  $javascript."\n// --></script>\n";   $javascript."\n// --></script>\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',      $r->print(&Apache::loncommon::start_page('Upload file to Construction Space',
      $javascript));                                               $javascript,
                                                {'bread_crumbs' => $brcrum,})
                .&Apache::loncommon::head_subbox(
                   &Apache::loncommon::CSTR_pageheader())
       );
       
     if (($uname ne $env{'user.name'}) || ($udom ne $env{'user.domain'})) {      if (($uname ne $env{'user.name'}) || ($udom ne $env{'user.domain'})) {
  $r->print('<h3><font color=red>'.&mt('Co-Author').': '.$uname.          $r->print('<p class="LC_warning">'
   &mt(' at ').$udom.'</font></h3>');                   .&mt('Co-Author [_1]',$uname.':'.$udom)
                    .'</p>'
           );
     }      }
   
     if ($env{'form.phase'} eq 'two') {      if ($env{'form.phase'} eq 'three') {
  &phasetwo($r,$fn,$uname,$udom);          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 {      } else {
  &phaseone($r,$fn,$uname,$udom);   &phaseone($r,$fn,$uname,$udom);
     }      }
Line 328  function verifyForm() { Line 476  function verifyForm() {
 1;  1;
 __END__  __END__
   
 =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)  
   
 =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  

Removed from v.1.35  
changed lines
  Added in v.1.48


FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>