Diff for /loncom/publisher/lonupload.pm between versions 1.1 and 1.19

version 1.1, 2001/04/05 19:35:15 version 1.19, 2003/08/04 18:22:55
Line 1 Line 1
   
 # The LearningOnline Network with CAPA  # The LearningOnline Network with CAPA
 # Handler to upload files into construction space  # Handler to upload files into construction space
 #  #
 # (Handler to retrieve an old version of a file  # $Id$
   #
   # Copyright Michigan State University Board of Trustees
   #
   # This file is part of the LearningOnline Network with CAPA (LON-CAPA).
 #  #
 # (Publication 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
 # (TeX Content Handler  # 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  # You should have received a copy of the GNU General Public License
 # 03/23 Guy Albertelli  # along with LON-CAPA; if not, write to the Free Software
 # 03/24,03/29 Gerd Kortemeyer)  # 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/
   #
   ###
   
 package Apache::lonupload;  package Apache::lonupload;
   
 use strict;  use strict;
 use Apache::File;  use Apache::File;
 use File::Copy;  use File::Copy;
   use File::Basename;
 use Apache::Constants qw(:common :http :methods);  use Apache::Constants qw(:common :http :methods);
   use Apache::loncacc;
   use Apache::loncommon();
   use Apache::Log();
   use Apache::lonnet;
   use HTML::Entities();
   
 sub phaseone {  my $DEBUG=0;
     my ($r,$fn,$uname,$udom)=@_;  
     my $docroot=$r->dir_config('lonDocRoot');  
   
     my $urldir='/res/'.$udom.'/'.$uname.$fn;  sub Debug {
     $urldir=~s/\/[^\/]+$/\//;    
     # 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);
     }
   }
   
     my $resfn=$docroot.'/res/'.$udom.'/'.$uname.$fn;  sub upfile_store {
     my $resdir=$resfn;      my $r=shift;
     $resdir=~s/\/[^\/]+$/\//;  
       my $fname=$ENV{'form.upfile.filename'};
     $fn=~/^\/(.+)\.(\w+)$/;      $fname=~s/\W//g;
     my $main=$1;      
     my $suffix=$2;      chomp($ENV{'form.upfile'});
       
     $r->print('<form action=/adm/retrieve method=post>'.      my $datatoken=$ENV{'user.name'}.'_'.$ENV{'user.domain'}.
       '<input type=hidden name=filename value="'.$fn.'">'.    '_upload_'.$fname.'_'.time.'_'.$$;
               '<input type=hidden name=phase value=two>'.      {
               '<table border=2><tr><th>Select</th><th>Version</th>'.         my $fh=Apache::File->new('>'.$r->dir_config('lonDaemons').
               '<th>Became this version on ...</th>'.                                     '/tmp/'.$datatoken.'.tmp');
               '<th>Metadata</th></tr>');         print $fh $ENV{'form.upfile'};
     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>');  
         }  
     }      }
     closedir(DIR);      return $datatoken;
     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)=@_;  sub phaseone {
     if ($ENV{'form.version'}) {     my ($r,$fn,$uname,$udom)=@_;
         my $version=$ENV{'form.version'};     $ENV{'form.upfile.filename'}=~s/\\/\//g;
  if ($version eq 'new') {     $ENV{'form.upfile.filename'}=~s/^.*\/([^\/]+)$/$1/;
     $r->print('<h3>Retrieving current (most recent) version</h3>');     if ($ENV{'form.upfile.filename'}) {
         } else {      $fn=~s/\/[^\/]+$//;
             $r->print('<h3>Retrieving old version '.$version.'</h3>');      $fn=~s/([^\/])$/$1\//;
         }      $fn.=$ENV{'form.upfile.filename'};
         my $logfile;      $fn=~s/^\///;
         my $ctarget='/home/'.$uname.'/public_html'.$fn;      $fn=~s/(\/)+/\//g;
         my $vfn=$fn;  
         if ($version ne 'new') {  #    Fn is the full path to the destination filename.
     $vfn=~s/\.(\w+)$/\.$version\.$1/;  #    
         }  
         my $csource=$r->dir_config('lonDocRoot').'/res/'.$udom.'/'.$uname.$vfn;      &Debug($r, "Filename for upload: $fn");
         unless ($logfile=Apache::File->new('>>'.$ctarget.'.log')) {      if (($fn) && ($fn!~/\/$/)) {
         $r->print(
    '<form action=/adm/upload method=post>'.
    '<input type=hidden name=phase value=two>'.
    '<input type=hidden name=datatoken value="'.&upfile_store.'">'.
    '<input type=hidden name=uploaduname value="'.$uname.'">'.
    'Store uploaded file as '.
    '<input type=text size=50 name=filename value="'.$fn.'"><br>'.
    '<input type=submit value="Store"></form>');
         # Check for bad extension and warn user
         if ($fn=~/\.(\w+)$/ && 
     (&Apache::loncommon::fileembstyle($1) eq 'hdn')) {
   $r->print(    $r->print(
          '<font color=red>No write permission to user directory, FAIL</font>');   '<font color=red>'.
         }   'The extension on this file, "'.$1.
         print $logfile    '", is reserved internally by LON-CAPA. <br \>'.
 "\n\n================= Retrieve ".localtime()." ================\n".   'Please change the extension.'.
 "Version: $version\nSource: $csource\nTarget: $ctarget\n";   '</font>');
         $r->print('<p>Copying file: ');        } elsif($fn=~/\.(\w+)$/ && 
         if (copy($csource,$ctarget)) {        !defined(&Apache::loncommon::fileembstyle($1))) {
     $r->print('ok<p>');    $r->print(
             print $logfile "Copied sucessfully.\n\n";   '<font color=red>'.
         } else {   'The extension on this file, "'.$1.
             my $error=$!;   '", is not recognized by LON-CAPA. <br \>'.
     $r->print('fail, '.$error.'<p>');   'Please change the extension.'.
             print $logfile "Copy failed: $error\n\n";   '</font>');
         }        }
         $r->print('<font size=+2><a href="/priv/'.$uname.$fn.    } else {
                   '">Back to '.$fn.'</a></font>');         $r->print('<font color=red>Illegal filename.</font>');
     }
    } else {
        $r->print('<font color=red>No upload file specified.</font>');
    }
   }
   
   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);
   #     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 ((-e $target) && ($ENV{'form.override'} ne 'Yes')) {
              $r->print(
    '<form action=/adm/upload method=post>'.
    'File <tt>'.$fn.'</tt> exists. Overwrite? '.
    '<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="Yes"></form>');
          } else {
              my $source=$r->dir_config('lonDaemons').
                                '/tmp/'.$datatoken.'.tmp';
              # Check for bad extension and disallow upload
      if ($fn=~/\.(\w+)$/ && 
          (&Apache::loncommon::fileembstyle($1) eq 'hdn')) {
          $r->print(
    'File <tt>'.$fn.'</tt> could not be copied.<br />'.
    '<font color=red>'.
    'The extension on this file is reserved internally by LON-CAPA.'.
    '</font>');
                 $r->print('<p><font size=+2><a href="'.$path.
                           '">Back to Directory</a></font>');
      } elsif ($fn=~/\.(\w+)$/ && 
       !defined(&Apache::loncommon::fileembstyle($1))) {
          $r->print(
    'File <tt>'.$fn.'</tt> could not be copied.<br />'.
    '<font color=red>'.
    'The extension on this file is not recognized by LON-CAPA.'.
    '</font>');
          $r->print('<p><font size=+2><a href="'.$path.
                           '">Back to Directory</a></font>');
      } elsif (-d $target) {
          $r->print(
    'File <tt>'.$fn.'</tt> could not be copied.<br />'.
    '<font color=red>'.
    'The target is an existing directory.'.
    '</font>');
          $r->print('<p><font size=+2><a href="'.$path.
                           '">Back to Directory</a></font>');
      } elsif (copy($source,$target)) {
          chmod(0660, $target); # Set permissions to rw-rw---.
         $r->print('File copied.');
                 $r->print('<p><font size=+2><a href="'.$url.
                           '">View file</a></font>');
                 $r->print('<p><font size=+2><a href="'.$path.
                           '">Back to Directory</a></font>');
      } else {
                 $r->print('Failed to copy: '.$!);
                 $r->print('<p><font size=+2><a href="'.$path.
                           '">Back to Directory</a></font>');
      }
          }
     } else {      } else {
        $r->print(         $r->print(
    '<font size=+1 color=red>Please pick a version to retrieve</font><p>');     '<font size=+1 color=red>Please use browser "Back" button and pick a filename</font><p>');
        &phaseone($r,$fn,$uname,$udom);  
     }      }
     } else {
       $r->print(
      '<font size=+1 color=red>Please use browser "Back" button and pick a filename</font><p>');
     }
 }  }
   
   # ---------------------------------------------------------------- Main Handler
 sub handler {  sub handler {
   
   my $r=shift;    my $r=shift;
   
   my $fn;    my $uname;
     my $udom;
   #
   # phase two: re-attach user
   #
     if ($ENV{'form.uploaduname'}) {
         $ENV{'form.filename'}='/priv/'.$ENV{'form.uploaduname'}.'/'.
     $ENV{'form.filename'};
     }
   #
   
     ($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'}) {    if ($ENV{'form.filename'}) {
       $fn=$ENV{'form.filename'};        $fn=$ENV{'form.filename'};
       $fn=~s/^http\:\/\/[^\/]+\/\~(\w+)//;        $fn=~s/^http\:\/\/[^\/]+\///;
         $fn=~s/^\///;
         $fn=~s/(\~|priv\/)(\w+)//;
         $fn=~s/\/+/\//g;
   } else {    } else {
      $r->log_reason($ENV{'user.name'}.' at '.$ENV{'user.domain'}.       $r->log_reason($ENV{'user.name'}.' at '.$ENV{'user.domain'}.
          ' unspecified filename for retrieval', $r->filename);            ' unspecified filename for upload', $r->filename); 
      return HTTP_NOT_FOUND;       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;  
   }   
   
 # ----------------------------------------------------------- Start page output  # ----------------------------------------------------------- Start page output
   
   my $uname=$ENV{'user.name'};  
   my $udom=$ENV{'user.domain'};  
   
   $r->content_type('text/html');    $r->content_type('text/html');
   $r->send_http_header;    $r->send_http_header;
   
   $r->print('<html><head><title>LON-CAPA Construction Space</title></head>');    $r->print('<html><head><title>LON-CAPA Construction Space</title></head>');
   
   $r->print(    $r->print(&Apache::loncommon::bodytag('Upload file to Construction Space'));
    '<body bgcolor="#FFFFFF"><img align=right src=/adm/lonIcons/lonlogos.gif>');  
   
       
   $r->print('<h1>Retrieve previous versions of <tt>'.$fn.'</tt></h1>');    if (($uname ne $ENV{'user.name'}) || ($udom ne $ENV{'user.domain'})) {
             $r->print('<h3><font color=red>Co-Author: '.$uname.' at '.$udom.
                  '</font></h3>');
     }
   
   
   if ($ENV{'form.phase'} eq 'two') {    if ($ENV{'form.phase'} eq 'two') {
       &phasetwo($r,$fn,$uname,$udom);        &phasetwo($r,$fn,$uname,$udom);
Line 162  sub handler { Line 270  sub handler {
   $r->print('</body></html>');    $r->print('</body></html>');
   return OK;      return OK;  
 }  }
   
   1;
   __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.1  
changed lines
  Added in v.1.19


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