--- loncom/publisher/loncfile.pm 2002/09/10 02:31:26 1.18 +++ loncom/publisher/loncfile.pm 2003/08/04 20:08:23 1.38 @@ -7,10 +7,9 @@ # presents a page that describes the proposed action to the user # and requests confirmation. The second phase commits the action # and displays a page showing the results of the action. -# - # -# $Id: loncfile.pm,v 1.18 2002/09/10 02:31:26 foxr Exp $ +# +# $Id: loncfile.pm,v 1.38 2003/08/04 20:08:23 www Exp $ # # Copyright Michigan State University Board of Trustees # @@ -34,27 +33,6 @@ # # http://www.lon-capa.org/ # -# -# (Handler to retrieve an old version of a file -# -# (Publication Handler -# -# (TeX Content Handler -# -# 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 -# 03/23 Guy Albertelli -# 03/24,03/29 Gerd Kortemeyer) -# -# 03/31,04/03,05/02,05/09,06/23,06/24 Gerd Kortemeyer) -# -# 06/23 Gerd Kortemeyer -# 05/07/02 Ron Fox: -# - Added Debug log output so that I can trace what the heck this -# undocumented thingy does. -# 05/28/02 Ron Fox: -# - Started putting in pod in standard format. =pod =head1 NAME @@ -93,6 +71,7 @@ use Apache::Constants qw(:common :http : use Apache::loncacc; use Apache::Log (); use Apache::lonnet; +use Apache::loncommon(); my $DEBUG=0; my $r; # Needs to be global for some stuff RF. @@ -128,7 +107,7 @@ sub Debug { my $log = $r->log; my $message = shift; - # Put out the indicated message butonly if DEBUG is false. + # Put out the indicated message butonly if DEBUG is true. if ($DEBUG) { $log->debug($message); @@ -173,12 +152,26 @@ Global References sub URLToPath { my $Url = shift; &Debug($r, "UrlToPath got: $Url"); - $Url=~ s/^http\:\/\/[^\/]+\/\~(\w+)/\/home\/$1\/public_html/; + $Url=~ s/\/+/\//g; $Url=~ s/^http\:\/\/[^\/]+//; + $Url=~ s/^\///; + $Url=~ s/(\~|priv\/)(\w+)\//\/home\/$2\/public_html\//; &Debug($r, "Returning $Url \n"); return $Url; } +sub url { + my $fn=shift; + $fn=~s/^\/home\/(\w+)\/public\_html/\/priv\/$1/; + return $fn; +} + +sub display { + my $fn=shift; + $fn=~s/^\/home\/(\w+)\/public\_html//; + return ''.$fn.''; +} + =pod =item PublicationPath($domain, $user, $dir, $file) @@ -248,41 +241,6 @@ sub ConstructionPath { return '/home/'.$user.'/public_html/'.$dir.'/'.$file; } -=pod - -=item ConstructionPathFromRelative($user, $relname) - - Determines the path to a construction space file given -the username and the path relative to the root of construction space. - -Parameters: - -=over 4 - -=item $user - string [in] Name of the user in whose construction space the - file [will] live. - -=item $relname - string[in] Path to the file relative to the root of the - construction space. - -=back - -Returns: - -=over 4 - -=item string - Full path to the file. - -=back - -=cut - -sub ConstructionPathFromRelative { - - my ($user, $relname) = @_; - return '/home/'.$user.'/public_html'.$relname; - -} =pod @@ -323,20 +281,23 @@ sub exists { my ($user, $domain, $dir, $file) = @_; # Create complete paths in publication and construction space. - - my $published = &PublicationPath($domain, $user, $dir, $file); - my $construct = &ConstructionPath($user, $dir, $file); + my $relativedir=$dir; + $relativedir=s|/home/\Q$user\E/public_html||; + my $published = &PublicationPath($domain, $user, $relativedir, $file); + my $construct = &ConstructionPath($user, $relativedir, $file); # If the resource exists in either space indicate this fact. # Note that the check for existence in resource space is stricter. my $result; + if ( -d $construct ) { + return 'Error: destination for operation is a directory.'; + } if ( -e $published) { - $result.='

Warning: target file exists, and has been published!

'; + $result.='

Warning: target file exists, and has been published!

'; + } elsif ( -e $construct) { + $result.='

Warning: target file exists!

'; } - elsif ( -e $construct) { - $result.='

Warning: target file exists!

'; - } return $result; @@ -380,10 +341,38 @@ sub checksuffix { if ($old=~m:(.*)/+([^/]+)\.(\w+)$:) { $oldsuffix=$3; } if ($oldsuffix ne $newsuffix) { $result.= - '

Warning: change of MIME type!

'; + '

Warning: change of MIME type!

'; } return $result; } + +sub cleanDest { + my ($request,$dest)=@_; + #remove bad characters + if ($dest=~/[\#\?&]/) { + $request->print("

Invalid characters in requested name have been removed.

"); + $dest=~s/[\#\?&]//g; + } + return $dest; +} + +sub relativeDest { + my ($fn,$newfilename,$uname)=@_; + if ($newfilename=~/^\//) { +# absolute, simply add path + $newfilename='/home/'.$uname.'/public_html/'; + } else { + my $dir=$fn; + $dir=~s/\/[^\/]+$//; + $newfilename=$dir.'/'.$newfilename; + } + $newfilename=~s://+:/:g; # remove duplicate / + while ($newfilename=~m:/\.\./:) { + $newfilename=~ s:/[^/]+/\.\./:/:g; #remove dir/.. + } + return $newfilename; +} + =pod =item CloseForm1($request, $user, $file) @@ -403,14 +392,10 @@ Parameters: =cut sub CloseForm1 { - my ($request, $cancelurl) = @_; - - - &Debug($request, "Cancel url is: ".$cancelurl); - $request->print('

'); - $request->print('

'); - + my ($request, $fn) = @_; + $request->print('

'); + $request->print('

'); } @@ -439,9 +424,8 @@ Parameters: =cut sub CloseForm2 { - my ($request, $user, $directory) = @_; - - $request->print('

Done

'); + my ($request, $user, $fn) = @_; + $request->print('

Done

'); } =pod @@ -480,30 +464,41 @@ new filename relative to the current dir =cut sub Rename1 { - my ($request, $filename, $user, $domain, $dir) = @_; - &Debug($request, "Username - ".$user." filename: ".$filename."\n"); - my $conspace = $filename; - - my $cancelurl = "/priv/".$filename; - $cancelurl =~ s/\/home\///; - $cancelurl =~ s/\/public_html//; - - if(-e $conspace) { - if($ENV{'form.newfilename'}) { - my $newfilename = $ENV{'form.newfilename'}; - $request->print(&checksuffix($filename, $newfilename)); - $request->print(&exists($user, $domain, $dir, $newfilename)); - $request->print('Cancel'); + return; + } + $request->print('

Rename '.$filename.' to '. - $dir.'/'.$newfilename.'?

'); - &CloseForm1($request, $cancelurl); + '" />

Rename '.&display($fn). + '
to '.&display($newfilename).'?

'); + &CloseForm1($request, $fn); } else { - $request->print('

No new filename specified

'); + $request->print('

No new filename specified.

'); return; } } else { - $request->print('

No such File

'); + $request->print('

No such file: '.&display($fn).'

'); return; } @@ -519,34 +514,29 @@ Parameters: =over 4 -=item $request - Apache Request Object [in] request object for the current +=item $request - Apache Request Object [in] request object for the current request. -=item $user - string [in] Name of session user. +=item $user - string [in] Name of the user initiating the request. +=item $domain - string [in] Domain the initiating user is logged in as -=item $filename - string [in] Name fo the file to be deleted: - Filename is the full filesystem path to the file. +=item $filename - string [in] Source filename. =back =cut sub Delete1 { - my ($request, $user, $filename) = @_; - - my $cancelurl = '/priv/'.$filename; - $cancelurl =~ s/\/home\///; - $cancelurl =~ s/\/public_html//; - + my ($request, $user, $domain, $fn) = @_; - if( -e $filename) { - $request->print(''); - $request->print('

Delete '.$filename.'?

'); - &CloseForm1($request, $cancelurl); + if( -e $fn) { + $request->print(''); + $request->print('

Delete '.&display($fn).'?

'); + &CloseForm1($request, $fn); } else { - $request->print('

No Such file: '.$filename.'

'); + $request->print('

No such file: '.&display($fn).'

'); } } @@ -569,9 +559,7 @@ Parameters: =item $domain - string [in] Domain the initiating user is logged in as -=item $dir - string [in] Directory path. - -=item $filename - string [in] Source filename. +=item $fn - string [in] Source filename. =item $newfilename-string [in] Destination filename. @@ -580,24 +568,23 @@ Parameters: =cut sub Copy1 { - my ($request, $user, $domain, $dir, $filename, $newfilename) = @_; - - my $cancelurl = "/priv/".$filename; - $cancelurl =~ s/\/home\///; - $cancelurl =~ s/\/public_html//; - - + my ($request, $user, $domain, $fn, $newfilename) = @_; - if(-e $filename) { - $request->print(&checksuffix($filename,$newfilename)); - $request->print(&exists($user, $domain, $dir, $newfilename)); - $request->print('

Copy '.$filename.' to'. - ''.$dir.'/'.$newfilename.'/?

'); - &CloseForm1($request, $cancelurl); + if(-e $fn) { + $request->print(&checksuffix($fn,$newfilename)); + my $return=&exists($user, $domain, $fn, $newfilename); + $request->print($return); + if ($return =~/^Error:/) { + $request->print('
Cancel'); + return; + } + $request->print('

Copy '.&display($fn).'
to '. + &display($newfilename).'?

'); + &CloseForm1($request, $fn); } else { - $request->print('

No such file '.$filename.'

'); + $request->print('

No such file: '.&display($fn).'

'); } } @@ -618,7 +605,9 @@ Parameters: =item $username - Name of the user that is requesting the directory creation. -=item $path - current directory relative to construction space. +=item $domain - Domain user is in + +=item $fn - source file. =item $newdir - Name of the directory to be created; path relative to the top level of construction space. @@ -640,29 +629,89 @@ causes the newdir operation to transitio sub NewDir1 { - my ($request, $username, $path, $newdir) = @_; - - my $fullpath = '/home/'.$username.'/public_html/'. - $path.'/'.$newdir; + my ($request, $username, $domain, $fn, $newfilename) = @_; - my $cancelurl = '/priv/'.$username.'/'.$path; - - &Debug($request, "Full path is : ".$fullpath); - - if(-e $fullpath) { + if(-e $newfilename) { $request->print('

Directory exists.

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

Make new directory '. - $path."/".$newdir.'?

'); - &CloseForm1($request, $cancelurl); - + $request->print('

Make new directory '. + &display($newfilename).'?

'); + &CloseForm1($request, $fn); } } =pod +=item NewFile1 + + Does all phase 1 processing of file creation: + Ensures that the user provides a new filename, adds proper extension + if needed and that the file does not already exist, if it is a html, + problem, page, or sequence, it then creates a form link to hand the + actual creation off to the proper handler. + +Parameters: + +=over 4 + +=item $request - Apache Request Object [in] - Server request object for the + current url. + +=item $username - Name of the user that is requesting the directory creation. + +=item $domain - Name of the domain of the user + +=item $fn - Source file name + +=item $newfilename + - Name of the file to be created; no path information +=back + +Side Effects: + +=over 4 + +=item 2 new forms are displayed. Clicking on the confirmation button +causes the browser to attempt to load the specfied URL, allowing the +proper handler to take care of file creation. There is also a Cancel +button which returns you to the driectory listing you came from + +=back + +=cut + + +sub NewFile1 { + my ($request, $user, $domain, $fn, $newfilename) = @_; + + if ($ENV{'form.action'} =~ /new(.+)file/) { + my $extension=$1; + if ($newfilename !~ /\Q.$extension\E$/) { + if ($newfilename =~ m|^[^\.]*\.([^\.]+)$|) { + #already has an extension strip it and add in expected one + $newfilename =~ s|.([^\.]+)$||; + } + $newfilename.=".$extension"; + } + } + + if(-e $newfilename) { + $request->print('

File exists.

'); + } + else { + $request->print('

Make new file '.&display($newfilename).'?

'); + $request->print(''); + $request->print('

'); + $request->print('

'); + } +} + +=pod + =item phaseone($r, $fn, $uname, $udom) Peforms phase one processing of the request. In phase one, error messages @@ -692,38 +741,40 @@ performed and reported to the user. sub phaseone { my ($r,$fn,$uname,$udom)=@_; - $fn=~m:(.*)/([^/]+)\.(\w+)$:; - my $dir=$1; - my $main=$2; - my $suffix=$3; - - # my $conspace=ConstructionPathFromRelative($uname, $fn); - - - $r->print('
'. - ''. - ''. - ''); + my $newfilename=&cleanDest($r,$ENV{'form.newfilename'}); + $newfilename=&relativeDest($fn,$newfilename,$uname); + + $r->print(''. + ''. + ''. + ''); if ($ENV{'form.action'} eq 'rename') { - - &Rename1($r, $fn, $uname, $udom, $dir); - + &Rename1($r, $uname, $udom, $fn, $newfilename); } elsif ($ENV{'form.action'} eq 'delete') { - - &Delete1($r, $uname, $fn); - + &Delete1($r, $uname, $udom, $fn); } elsif ($ENV{'form.action'} eq 'copy') { - if($ENV{'form.newfilename'}) { - my $newfilename = $ENV{'form.newfilename'}; - &Copy1($r, $uname, $udom, $dir, $fn, $newfilename); - }else { - $r->print('

No new filename specified.

'); - } + if($newfilename) { + &Copy1($r, $uname, $udom, $fn, $newfilename); + } else { + $r->print('

No new filename specified.

'); + } } elsif ($ENV{'form.action'} eq 'newdir') { - &NewDir1($r, $uname, $dir, $ENV{'form.newfilename'}); + &NewDir1($r, $uname, $udom, $fn, $newfilename); + } elsif ($ENV{'form.action'} eq 'newfile' || + $ENV{'form.action'} eq 'newhtmlfile' || + $ENV{'form.action'} eq 'newproblemfile' || + $ENV{'form.action'} eq 'newpagefile' || + $ENV{'form.action'} eq 'newsequencefile' || + $ENV{'form.action'} eq 'newrightsfile' || + $ENV{'form.action'} eq 'newstyfile' || + $ENV{'form.action'} eq 'Select Action') { + if ($newfilename) { + &NewFile1($r, $uname, $udom, $fn, $newfilename); + } else { + $r->print('

No new filename specified.

'); + } } - } =pod @@ -768,16 +819,13 @@ sub Rename2 { " new file ".$newfile."\n"); &Debug($request, "Target is: ".$directory.'/'. $newfile); - - if(-e $oldfile) { - unless(rename($oldfile, - $directory.'/'.$newfile)) { - $request->print('Error: '.$!.''); + if (-e $oldfile) { + unless (rename($oldfile,$newfile)) { + $request->print('Error: '.$!.''); return 0; - } else {} + } } else { - $request->print("

No such file: /home".$user.'/public_html'. - $oldfile.'

'); + $request->print("

No such file: ".&display($oldfile).'

'); return 0; } return 1; @@ -816,11 +864,11 @@ sub Delete2 { if(-e $filename) { unless(unlink($filename)) { - $request->print('Error: '.$!.''); + $request->print('Error: '.$!.''); return 0; } } else { - $request->print('

No such file. print('

No such file.

print(' copy Error: '.$!.''); + $request->print(' copy Error: '.$!.''); return 0; } else { unless (chmod(0660, $newfile)) { - $request->print(' chmod error: '.$!.''); + $request->print(' chmod error: '.$!.''); return 0; } return 1; @@ -900,11 +948,11 @@ sub NewDir2 { my ($request, $user, $newdirectory) = @_; unless(mkdir($newdirectory, 02770)) { - $request->print('Error: '.$!.''); + $request->print('Error: '.$!.''); return 0; } unless(chmod(02770, ($newdirectory))) { - $request->print(' Error: '.$!.''); + $request->print(' Error: '.$!.''); return 0; } return 1; @@ -949,11 +997,16 @@ sub phasetwo { # Break down the file into it's component pieces. - $fn=~/(.*)\/([^\/]+)\.(\w+)$/; - my $dir=$1; # Directory path - my $main=$2; # Filename. - my $suffix=$3; # Extension. - + my $dir; # Directory path + my $main; # Filename. + my $suffix; # Extension. + + if ($fn=~m:(.*)/([^/]+)\.(\w+)$:) { + $dir=$1; # Directory path + $main=$2; # Filename. + $suffix=$3; # Extension. + } + my $dest; # On success this is where we'll go. &Debug($r, @@ -973,13 +1026,14 @@ sub phasetwo { if ($ENV{'form.action'} eq 'rename') { # Rename. if($ENV{'form.newfilename'}) { + if (!defined($dir)) { + $fn=~m:^(.*)/:; + $dir=$1; + } if(!&Rename2($r, $uname, $dir, $fn, $ENV{'form.newfilename'})) { return; } - # Prepend the directory to the new name to form the basis of the - # url of the new resource. - # - $dest = $dir."/".$ENV{'form.newfilename'}; + $dest = &url($ENV{'form.newfilename'}); } } elsif ($ENV{'form.action'} eq 'delete') { if(!&Delete2($r, $uname, $ENV{'form.newfilename'})) { @@ -988,7 +1042,7 @@ sub phasetwo { # Once a resource is deleted, we just list the directory that # previously held it. # - $dest = $dir."/"; # Parent dir. + $dest = $dir."/."; # Parent dir. } elsif ($ENV{'form.action'} eq 'copy') { if($ENV{'form.newfilename'}) { if(!&Copy2($r, $uname, $dir, $fn, $ENV{'form.newfilename'})) { @@ -997,37 +1051,18 @@ sub phasetwo { $dest = $ENV{'form.newfilename'}; } else { - $r->print('

No New filename specified'); + $r->print('

No New filename specified

'); return; } } elsif ($ENV{'form.action'} eq 'newdir') { - # - # Since the newfilename form field is construction space - # relative, ew need to prepend the current path; now in $fn. - # - my $newdir= $fn.$ENV{'form.newfilename'}; + my $newdir= $ENV{'form.newfilename'}; if(!&NewDir2($r, $uname, $newdir)) { return; } $dest = $newdir."/" } - # - # Substitute for priv for the first home in $dir to get our - # construction space path. - # - &Debug($r, "Final url is: $dest"); - $dest =~ s/\/home\//\/priv\//; - $dest =~ s/\/public_html//; - - my $base = &File::Basename::basename($dest); - my $dpath= &File::Basename::dirname($dest); - $dest = &HTML::Entities::encode($dpath.'/'.$base); - - - &Debug($r, "Final url after rewrite: $dest"); - - $r->print('

Done

'); + $r->print('

Done

'); } sub handler { @@ -1038,17 +1073,18 @@ sub handler { &Debug($r, "loncfile.pm - handler entered"); &Debug($r, " filename: ".$ENV{'form.filename'}); &Debug($r, " newfilename: ".$ENV{'form.newfilename'}); - +# +# Determine the root filename +# This could come in as "filename", which actually is a URL, or +# as "qualifiedfilename", which is indeed a real filename in filesystem +# my $fn; if ($ENV{'form.filename'}) { - $fn=$ENV{'form.filename'}; - &Debug($r, "loncfile::handler - raw url: $fn"); -# $fn=~s/^http\:\/\/[^\/]+\/\~(\w+)/\/home\/$1\/public_html/; -# $fn=~s/^http\:\/\/[^\/]+//; - $fn=URLToPath($fn); - &Debug($r, "loncfile::handler - doctored url: $fn"); - + $fn=&Apache::lonnet::unescape($ENV{'form.filename'}); + $fn=&URLToPath($fn); + } elsif ($ENV{'form.qualifiedfilename'}) { + $fn=$ENV{'form.qualifiedfilename'}; } else { &Debug($r, "loncfile::handler - no form.filename"); $r->log_reason($ENV{'user.name'}.' at '.$ENV{'user.domain'}. @@ -1079,22 +1115,19 @@ sub handler { return HTTP_NOT_ACCEPTABLE; } - $fn=~s/\/\~(\w+)//; - &Debug($r, "loncfile::handler ~ removed filename: $fn"); $r->content_type('text/html'); $r->send_http_header; $r->print('LON-CAPA Construction Space'); - $r->print( - ''); + $r->print(&Apache::loncommon::bodytag('Construction Space File Operation')); - $r->print('

Construction Space '.$fn.'

'); + $r->print('

Location: '.&display($fn).'

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

Co-Author: '.$uname.' at '.$udom. + $r->print('

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

'); } @@ -1109,8 +1142,17 @@ sub handler { $r->print('

New Directory

'); } elsif ($ENV{'form.action'} eq 'copy') { $r->print('

Copy

'); + } elsif ($ENV{'form.action'} eq 'newfile' || + $ENV{'form.action'} eq 'newhtmlfile' || + $ENV{'form.action'} eq 'newproblemfile' || + $ENV{'form.action'} eq 'newpagefile' || + $ENV{'form.action'} eq 'newsequencefile' || + $ENV{'form.action'} eq 'newrightsfile' || + $ENV{'form.action'} eq 'newstyfile' || + $ENV{'form.action'} eq 'Select Action' ) { + $r->print('

New Resource

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

Unknown Action'); + $r->print('

Unknown Action '.$ENV{'form.action'}.'

'); return OK; } if ($ENV{'form.phase'} eq 'two') {