--- loncom/publisher/lonupload.pm 2001/04/05 19:35:15 1.1 +++ loncom/publisher/lonupload.pm 2002/08/24 03:56:58 1.13 @@ -1,146 +1,248 @@ + # The LearningOnline Network with CAPA # Handler to upload files into construction space # +# $Id: lonupload.pm,v 1.13 2002/08/24 03:56:58 foxr Exp $ +# +# Copyright Michigan State University Board of Trustees +# +# This file is part of the LearningOnline Network with CAPA (LON-CAPA). +# +# 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. +# +# 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. +# +# 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 +# +# /home/httpd/html/adm/gpl.txt +# +# http://www.lon-capa.org/ +# # (Handler to retrieve an old version of a file # # (Publication Handler # # (TeX Content Handler # +# YEAR=2000 # 05/29/00,05/30,10/11 Gerd Kortemeyer) # # 11/28,11/29,11/30,12/01,12/02,12/04,12/23 Gerd Kortemeyer +# YEAR=2001 # 03/23 Guy Albertelli # 03/24,03/29 Gerd Kortemeyer) # # 03/31,04/03 Gerd Kortemeyer) # -# 04/05 Gerd Kortemeyer +# 04/05,04/09,05/25,06/23,06/24,08/22 Gerd Kortemeyer +# 11/29 Matthew Hall +# 12/16 Scott Harrison +# +### 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::Log(); +use Apache::lonnet; -sub phaseone { - my ($r,$fn,$uname,$udom)=@_; - my $docroot=$r->dir_config('lonDocRoot'); +my $DEBUG=0; - my $urldir='/res/'.$udom.'/'.$uname.$fn; - $urldir=~s/\/[^\/]+$/\//; +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); + } +} - my $resfn=$docroot.'/res/'.$udom.'/'.$uname.$fn; - my $resdir=$resfn; - $resdir=~s/\/[^\/]+$/\//; - - $fn=~/^\/(.+)\.(\w+)$/; - my $main=$1; - my $suffix=$2; - - $r->print('
'. - ''. - ''. - ''. - ''. - ''); - 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(''); - } +sub upfile_store { + my $r=shift; + + my $fname=$ENV{'form.upfile.filename'}; + $fname=~s/\W//g; + + chop($ENV{'form.upfile'}); + + 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'}; } - closedir(DIR); - my ($rdev,$rino,$rmode,$rnlink, - $ruid,$rgid,$rrdev,$rsize, - $ratime,$rmtime,$rctime, - $rblksize,$rblocks)=stat($resfn); - $r->print(''. - '
SelectVersionBecame this version on ...Metadata
'.$version.''. - localtime($rmtime).''. - ''. - 'Metadata Version '.$version.'
Current'.localtime($rmtime). - ''. - 'Metadata current version

'. - 'Retrieval of an old version will '. - 'overwrite the file currently in construction space

'. - '

'); + return $datatoken; } -sub phasetwo { - my ($r,$fn,$uname,$udom)=@_; - if ($ENV{'form.version'}) { - my $version=$ENV{'form.version'}; - if ($version eq 'new') { - $r->print('

Retrieving current (most recent) version

'); - } else { - $r->print('

Retrieving old version '.$version.'

'); - } - my $logfile; - my $ctarget='/home/'.$uname.'/public_html'.$fn; - my $vfn=$fn; - if ($version ne 'new') { - $vfn=~s/\.(\w+)$/\.$version\.$1/; - } - my $csource=$r->dir_config('lonDocRoot').'/res/'.$udom.'/'.$uname.$vfn; - unless ($logfile=Apache::File->new('>>'.$ctarget.'.log')) { + +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; + +# Fn is the full path to the destination filename. +# + + &Debug($r, "Filename for upload: $fn"); + if (($fn) && ($fn!~/\/$/)) { + $r->print( + '
'. + ''. + ''. + 'Store uploaded file as '. + '
'. + '
'); + # Check for bad extension and warn user + if ($fn=~/\.(\w+)$/ && + (&Apache::loncommon::fileembstyle($1) eq 'hdn')) { $r->print( - 'No write permission to user directory, FAIL'); - } - print $logfile -"\n\n================= Retrieve ".localtime()." ================\n". -"Version: $version\nSource: $csource\nTarget: $ctarget\n"; - $r->print('

Copying file: '); - if (copy($csource,$ctarget)) { - $r->print('ok

'); - print $logfile "Copied sucessfully.\n\n"; - } else { - my $error=$!; - $r->print('fail, '.$error.'

'); - print $logfile "Copy failed: $error\n\n"; - } - $r->print('Back to '.$fn.''); + ''. + 'The extension on this file, "'.$1. + '", is reserved internally by LON-CAPA.
'. + 'Please change the extension.'. + '
'); + } elsif($fn=~/\.(\w+)$/ && + !defined(&Apache::loncommon::fileembstyle($1))) { + $r->print( + ''. + 'The extension on this file, "'.$1. + '", is not recognized by LON-CAPA.
'. + 'Please change the extension.'. + '
'); + } + } else { + $r->print('Illegal filename.'); + } + } else { + $r->print('No upload file specified.'); + } +} + +sub phasetwo { + my ($r,$fn,$uname,$udom)=@_; + &Debug($r, "Filename is ".$fn); + if ($fn=~/^\/priv\/$uname\//) { + &Debug($r, "Filename after priv substitution: ".$fn); + my $tfn=$fn; + $tfn=~s/^\/(\~|priv)\/(\w+)//; + &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 = Apache::lonnet::escape($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( + '

'. + 'File '.$fn.' exists. Overwrite? '. + ''. + ''. + ''. + '
'); + } 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 '.$fn.' could not be copied.
'. + ''. + 'The extension on this file is reserved internally by LON-CAPA.'. + ''); + } elsif ($fn=~/\.(\w+)$/ && + !defined(&Apache::loncommon::fileembstyle($1))) { + $r->print( + 'File '.$fn.' could not be copied.
'. + ''. + 'The extension on this file is not recognized by LON-CAPA.'. + ''); + } elsif (copy($source,$target)) { + chmod(0660, $target); # Set permissions to rw-rw---. + $r->print('File copied.'); + $r->print('

View file'); + } else { + $r->print('Failed to copy: '.$!); + } + } } else { $r->print( - 'Please pick a version to retrieve

'); + 'Please pick a filename

'); &phaseone($r,$fn,$uname,$udom); } + } else { + $r->print( + 'Please pick a filename

'); + &phaseone($r,$fn,$uname,$udom); + } } +# ---------------------------------------------------------------- Main Handler sub handler { my $r=shift; + my $uname; + my $udom; + + ($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/^http\:\/\/[^\/]+\/\~(\w+)//; + $fn=~s/^http\:\/\/[^\/]+\/(\~|priv\/)(\w+)//; } else { $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; } - 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 - my $uname=$ENV{'user.name'}; - my $udom=$ENV{'user.domain'}; $r->content_type('text/html'); $r->send_http_header; @@ -151,7 +253,13 @@ sub handler { ''); - $r->print('

Retrieve previous versions of '.$fn.'

'); + $r->print('

Upload file to Construction Space

'); + + if (($uname ne $ENV{'user.name'}) || ($udom ne $ENV{'user.domain'})) { + $r->print('

Co-Author: '.$uname.' at '.$udom. + '

'); + } + if ($ENV{'form.phase'} eq 'two') { &phasetwo($r,$fn,$uname,$udom); @@ -162,3 +270,79 @@ sub handler { $r->print(''); return OK; } + +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