--- loncom/publisher/loncfile.pm 2005/05/25 22:27:17 1.68 +++ loncom/publisher/loncfile.pm 2009/05/14 14:24:18 1.98 @@ -9,7 +9,7 @@ # and displays a page showing the results of the action. # # -# $Id: loncfile.pm,v 1.68 2005/05/25 22:27:17 albertel Exp $ +# $Id: loncfile.pm,v 1.98 2009/05/14 14:24:18 bisitz Exp $ # # Copyright Michigan State University Board of Trustees # @@ -69,10 +69,11 @@ use File::Copy; use HTML::Entities(); use Apache::Constants qw(:common :http :methods); use Apache::loncacc; -use Apache::Log (); use Apache::lonnet; use Apache::loncommon(); use Apache::lonlocal; +use LONCAPA qw(:DEFAULT :match); + my $DEBUG=0; my $r; # Needs to be global for some stuff RF. @@ -101,20 +102,24 @@ my $r; # Needs to be global for some =cut sub Debug { - - # Marshall the parameters. - - my $r = shift; - my $log = $r->log; - my $message = shift; - # Put out the indicated message butonly if DEBUG is true. - if ($DEBUG) { + my ($r,$message) = @_; $r->log_reason($message); } } +sub done { + my ($url)=@_; + my $done=&mt("Done"); + return(<$done + +ENDDONE +} + =pod =item URLToPath($url) @@ -154,24 +159,24 @@ sub URLToPath { my $Url = shift; &Debug($r, "UrlToPath got: $Url"); $Url=~ s/\/+/\//g; - $Url=~ s/^http\:\/\/[^\/]+//; + $Url=~ s/^https?\:\/\/[^\/]+//; $Url=~ s/^\///; - $Url=~ s/(\~|priv\/)(\w+)\//\/home\/$2\/public_html\//; + $Url=~ s/(\~|priv\/)($match_username)\//\/home\/$2\/public_html\//; &Debug($r, "Returning $Url \n"); return $Url; } sub url { my $fn=shift; - $fn=~s/^\/home\/(\w+)\/public\_html/\/priv\/$1/; + $fn=~s/^\/home\/($match_username)\/public\_html/\/priv\/$1/; $fn=&HTML::Entities::encode($fn,'<>"&'); return $fn; } sub display { my $fn=shift; - $fn=~s-^/home/(\w+)/public_html-/priv/$1-; - return ''.$fn.''; + $fn=~s-^/home/($match_username)/public_html-/priv/$1-; + return ''.$fn.''; } @@ -194,7 +199,32 @@ sub obsolete_unpub { } } - +# see if directory is empty +# ignores any .meta, .save, .bak, and .log files created for a previously +# published file, which has since been marked obsolete and deleted. +sub empty_directory { + my ($dirname,$phase) = @_; + if (opendir DIR, $dirname) { + my @files = grep(!/^\.\.?$/, readdir(DIR)); # ignore . and .. + if (@files) { + my @orphans = grep(/\.(meta|save|log|bak)$/,@files); + if (scalar(@files) - scalar(@orphans) > 0) { + return 0; + } else { + if (($phase eq 'Delete2') && (@orphans > 0)) { + foreach my $file (@orphans) { + if ($file =~ /\.(meta|save|log|bak)$/) { + unlink($dirname.$file); + } + } + } + } + } + closedir(DIR); + return 1; + } + return 0; +} =pod @@ -207,12 +237,16 @@ sub obsolete_unpub { =over 4 -=item $user - string [in] - Name of the user for which to check. +=item $user - string [in] - Name of the user for which to check. -=item $domain - string [in] - Name of the domain in which the resource +=item $domain - string [in] - Name of the domain in which the resource might have been published. -=item $file - string [in] - Name of the file. +=item $file - string [in] - Name of the file. + +=item $creating - string [in] - optional, type of object being created, + either 'directory' or 'file'. Defaults to + 'file' if unspecified. =back @@ -220,6 +254,9 @@ Returns: =over 4 +=item string - Either undef, 'warning' or 'error' depending on the + type of problem + =item string - Either where the resource exists as an html string that can be embedded in a dialog or an empty string if the resource does not exist. @@ -229,20 +266,39 @@ Returns: =cut sub exists { - my ($user, $domain, $construct) = @_; + my ($user, $domain, $construct, $creating) = @_; + $creating ||= 'file'; + my $published=$construct; $published=~ - s/^\/home\/$user\/public\_html\//\/home\/httpd\/html\/res\/$domain\/$user\//; - my $result=''; + s{^/home/$user/public_html/}{/home/httpd/html/res/$domain/$user/}; + my ($type,$result); if ( -d $construct ) { - return &mt('Error: destination for operation is an existing directory.'); + return ('error','

'.&mt('Error: destination for operation is an existing directory.').'

'); + } + if ( -e $published) { - $result.='

'.&mt('Warning: target file exists, and has been published!').'

'; + if ( -e $construct ) { + $type = 'warning'; + $result.='

'.&mt('Warning: target file exists, and has been published!').'

'; + } else { + my $published_type = (-d $published) ? 'directory' : 'file'; + + if ($published_type eq $creating) { + $type = 'warning'; + $result.='

'.&mt("Warning: a published $published_type of this name exists.").'

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

'.&mt("Error: a published $published_type of this name exists.").'

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

'.&mt('Warning: target file exists!').'

'; + $type = 'warning'; + $result.='

'.&mt('Warning: target file exists!').'

'; } - return $result; + + return ($type,$result); } =pod @@ -281,9 +337,9 @@ sub checksuffix { my $newsuffix; if ($new=~m:(.*/*)([^/]+)\.(\w+)$:) { $newsuffix=$3; } if ($old=~m:(.*)/+([^/]+)\.(\w+)$:) { $oldsuffix=$3; } - if ($oldsuffix ne $newsuffix) { + if (lc($oldsuffix) ne lc($newsuffix)) { $result.= - '

'.&mt('Warning: change of MIME type!').'

'; + '

'.&mt('Warning: change of MIME type!').'

'; } return $result; } @@ -296,20 +352,34 @@ sub cleanDest { $foundbad=1; $dest=~s/\.//g; } - if ($dest=~/[\#\?&%\"]/) { + $dest =~ s/(\s+$|^\s+)//g; + if ($dest=~/[\#\?&%\":]/) { $foundbad=1; - $dest=~s/[\#\?&%\"]//g; + $dest=~s/[\#\?&%\":]//g; } if ($dest=~m|/|) { my ($newpath)=($dest=~m|(.*)/|); $newpath=&relativeDest($fn,$newpath,$uname); if (! -d "$newpath") { - $request->print("

".&mt('You have requested to create file in directory [_1] which doesn\'t exist. The requested directory path has been removed from the requested file name.','"'.$newpath.'"')."

"); + $request->print('

' + .&mt("You have requested to create file in directory [_1] which doesn't exist. The requested directory path has been removed from the requested file name." + ,'"'.&display($newpath).'"') + .'

'); $dest=~s|.*/||; } } + if ($dest =~ /\.(\d+)\.(\w+)$/){ + $request->print('' + .&mt('Bad filename [_1]',''.&display($dest).'') + .'
' + .&mt('[_1](name).(number).(extension)[_2] not allowed.','','') + .'
' + .&mt('Removing the [_1].number.[_2] from requested filename.','','') + .''); + $dest =~ s/\.(\d+)(\.\w+)$/$2/; + } if ($foundbad) { - $request->print("

".&mt('Invalid characters in requested name have been removed.')."

"); + $request->print("

".&mt('Invalid characters in requested name have been removed.')."

"); } return $dest; } @@ -353,7 +423,7 @@ sub CloseForm1 { my ($request, $fn) = @_; $request->print('

'); $request->print('

'); + '" method="post">

'); } @@ -383,7 +453,7 @@ Parameters: sub CloseForm2 { my ($request, $user, $fn) = @_; - $request->print('

'.&mt('Done').'

'); + $request->print(&done(&url($fn))); } =pod @@ -444,9 +514,9 @@ sub Rename1 { if (-d $fn) { $newfilename=~/\.(\w+)$/; if (&Apache::loncommon::fileembstyle($1) eq 'ssi') { - $request->print('
'. + $request->print('
'. &mt('Cannot change MIME type of a directory'). - ''. + ''. '
'.&mt('Cancel').''); return; } @@ -456,9 +526,9 @@ sub Rename1 { while ($newfilename=~m:/\.\./:) { $newfilename=~ s:/[^/]+/\.\./:/:g; #remove dir/.. } - my $return=&exists($user, $domain, $newfilename); + my ($type, $return)=&exists($user, $domain, $newfilename); $request->print($return); - if ($return =~/^Error:/) { + if ($type eq 'error') { $request->print('
'.&mt('Cancel').''); return; } @@ -476,7 +546,7 @@ sub Rename1 { $request->print('

'.$action.' '.&display($fn). - '
to '.&display($newfilename).'?

'); + '


to '.&display($newfilename).'?

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

'.&mt('No new filename specified.').'

'); @@ -518,12 +588,21 @@ sub Delete1 { if( -e $fn) { $request->print(''); - unless (&obsolete_unpub($user,$domain,$fn)) { - $request->print('

'.&mt('Cannot delete non-obsolete published file').'

'. + $fn.'" />'); + if (-d $fn) { + unless (&empty_directory($fn,'Delete1')) { + $request->print('

'.&mt('Only empty directories may be deleted.').'

'. + 'You must delete the contents of the directory first.
'. + '
'.&mt('Cancel').''); + return; + } + } else { + unless (&obsolete_unpub($user,$domain,$fn)) { + $request->print('

'.&mt('Cannot delete non-obsolete published file').'

'. '
'.&mt('Cancel').''); - return; - } + return; + } + } $request->print('

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

'); &CloseForm1($request, $fn); } else { @@ -575,9 +654,9 @@ sub Copy1 { $newfilename=~ s:/[^/]+/\.\./:/:g; #remove dir/.. } $request->print(&checksuffix($fn,$newfilename)); - my $return=&exists($user, $domain, $newfilename); + my ($type,$return)=&exists($user, $domain, $newfilename); $request->print($return); - if ($return =~/^Error:/) { + if ($type eq 'error') { $request->print('
'.&mt('Cancel').''); return; } @@ -633,14 +712,15 @@ causes the newdir operation to transitio sub NewDir1 { my ($request, $username, $domain, $fn, $newfilename, $mode) = @_; - my $result=&exists($username,$domain,$newfilename); - if ($result) { - $request->print(''.$result.''); + my ($type, $result)=&exists($username,$domain,$newfilename,'directory'); + $request->print($result); + if ($type eq 'error') { + $request->print(''); } else { if ($mode eq 'testbank') { - $request->print(''); + $request->print(''); } elsif ($mode eq 'imsimport') { - $request->print(''); + $request->print(''); } $request->print('

'.&mt('Make new directory').' '. @@ -653,7 +733,7 @@ sub NewDir1 { sub Decompress1 { my ($request, $user, $domain, $fn) = @_; if( -e $fn) { - $request->print(''); + $request->print(''); $request->print('

'.&mt('Decompress').' '.&display($fn).'?

'); &CloseForm1($request, $fn); } else { @@ -703,36 +783,74 @@ button which returns you to the driector sub NewFile1 { my ($request, $user, $domain, $fn, $newfilename) = @_; + return if (&filename_check($newfilename) ne 'ok'); if ($env{'form.action'} =~ /new(.+)file/) { my $extension=$1; - - ##Informs User (name).(number).(extension) not allowed - if($newfilename =~ /\.(\d+)\.(\w+)$/){ - $r->print(''.$newfilename. - ' - '.&mt('Bad Filename').'
('.&mt('name').').('.&mt('number').').('.&mt('extension').')'. - ' '.&mt('Not Allowed').''); - return; - } if ($newfilename !~ /\Q.$extension\E$/) { - if ($newfilename =~ m|^[^\.]*\.([^\.]+)$|) { + if ($newfilename =~ m|/[^/.]*\.(?:[^/.]+)$|) { #already has an extension strip it and add in expected one - $newfilename =~ s|.([^\.]+)$||; + $newfilename =~ s|(/[^./])\.(?:[^.]+)$|$1|; } $newfilename.=".$extension"; } } - my $result=&exists($user,$domain,$newfilename); - if($result) { - $request->print(''.$result.''); + my ($type, $result)=&exists($user,$domain,$newfilename); + $request->print($result); + if ($type eq 'error') { + $request->print(''); } else { + my $extension; + + if ($newfilename =~ m{[^/.]+\.([^/.]+)$}) { + $extension = $1; + } + + my @okexts = qw(xml html xhtml htm xhtm problem page sequence rights sty library js css txt); + if (($extension eq '') || (!grep(/^\Q$extension\E/,@okexts))) { + my $validexts = '.'.join(', .',@okexts); + $request->print('

'. + &mt('Invalid filename: ').&display($newfilename).'

'. + &mt('The name of the new file needs to end with an appropriate file extension to indicate the type of file to create.').'
'. + &mt('The following are valid extensions: [_1].',$validexts). + '

'. + '

'. + ''. + ''. + ''.&mt('Enter a file name: ').' '. + '

'. + '

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

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

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

'); + '" method="post">

'); $request->print('

'); + '" method="post">

'); + } + return; +} + +sub filename_check { + my ($newfilename) = @_; + ##Informs User (name).(number).(extension) not allowed + if($newfilename =~ /\.(\d+)\.(\w+)$/){ + $r->print(''.$newfilename. + ' - '.&mt('Bad Filename').'
('.&mt('name').').('.&mt('number').').('.&mt('extension').') '. + ' '.&mt('Not Allowed').''); + return; + } + if($newfilename =~ /(\:\:\:|\&\&\&|\_\_\_)/){ + $r->print(''.$newfilename. + ' - '.&mt('Bad Filename').'
('.&mt('Must not include').' '.$1.') '. + ' '.&mt('Not Allowed').''); + return; } + return 'ok'; } =pod @@ -802,6 +920,7 @@ sub phaseone { $env{'form.action'} eq 'newsequencefile' || $env{'form.action'} eq 'newrightsfile' || $env{'form.action'} eq 'newstyfile' || + $env{'form.action'} eq 'newtaskfile' || $env{'form.action'} eq 'newlibraryfile' || $env{'form.action'} eq 'Select Action') { my $empty=&mt('Type Name Here'); @@ -860,7 +979,7 @@ sub Rename2 { my $oRN=$oldfile; my $nRN=$newfile; unless (rename($oldfile,$newfile)) { - $request->print(''.&mt('Error').': '.$!.''); + $request->print(''.&mt('Error').': '.$!.''); return 0; } ## If old name.(extension) exits, move under new name. @@ -932,16 +1051,14 @@ Returns: sub Delete2 { my ($request, $user, $filename) = @_; - if(opendir DIR, $filename) { - my @files=readdir(DIR); - shift @files; shift @files; # takes off . and .. - if(@files) { - $request->print(' '.&mt('Error: Directory Non Empty').''); + if (-d $filename) { + unless (&empty_directory($filename,'Delete2')) { + $request->print(''.&mt('Error: Directory Non Empty').''); return 0; } else { if(-e $filename) { unless(rmdir($filename)) { - $request->print(''.&mt('Error').': '.$!.''); + $request->print(''.&mt('Error').': '.$!.''); return 0; } } else { @@ -952,7 +1069,7 @@ sub Delete2 { } else { if(-e $filename) { unless(unlink($filename)) { - $request->print(''.&mt('Error').': '.$!.''); + $request->print(''.&mt('Error').': '.$!.''); return 0; } } else { @@ -987,7 +1104,7 @@ sub Delete2 { =back -Returns 0 failure, and 0 successs. +Returns 0 failure, and 1 successs. =cut @@ -995,17 +1112,21 @@ sub Copy2 { my ($request, $username, $dir, $oldfile, $newfile) = @_; &Debug($request ,"Will try to copy $oldfile to $newfile"); if(-e $oldfile) { + if ($oldfile eq $newfile) { + $request->print(''.&mt('Warning').': '.&mt('Name of new file is the same as name of old file').' - '.&mt('no action taken').'.'); + return 1; + } unless (copy($oldfile, $newfile)) { - $request->print(' '.&mt('copy Error').': '.$!.''); + $request->print(''.&mt('copy Error').': '.$!.''); return 0; } elsif (!chmod(0660, $newfile)) { - $request->print(' '.&mt('chmod error').': '.$!.''); + $request->print(''.&mt('chmod error').': '.$!.''); return 0; } elsif (-e $oldfile.'.meta' && !copy($oldfile.'.meta', $newfile.'.meta') && !chmod(0660, $newfile.'.meta')) { - $request->print(' '.&mt('copy metadata error'). - ': '.$!.''); + $request->print(''.&mt('copy metadata error'). + ': '.$!.''); return 0; } else { return 1; @@ -1043,11 +1164,11 @@ sub NewDir2 { my ($request, $user, $newdirectory) = @_; unless(mkdir($newdirectory, 02770)) { - $request->print(''.&mt('Error').': '.$!.''); + $request->print(''.&mt('Error').': '.$!.''); return 0; } unless(chmod(02770, ($newdirectory))) { - $request->print(' '.&mt('Error').': '.$!.''); + $request->print(''.&mt('Error').': '.$!.''); return 0; } return 1; @@ -1055,8 +1176,8 @@ sub NewDir2 { sub decompress2 { my ($r, $user, $dir, $file) = @_; - &Apache::lonnet::appenv('cgi.file' => $file); - &Apache::lonnet::appenv('cgi.dir' => $dir); + &Apache::lonnet::appenv({'cgi.file' => $file}); + &Apache::lonnet::appenv({'cgi.dir' => $dir}); my $result=&Apache::lonnet::ssi_body('/cgi-bin/decompress.pl'); $r->print($result); &Apache::lonnet::delenv('cgi.file'); @@ -1101,7 +1222,7 @@ sub phasetwo { &Debug($r, "loncfile - Entering phase 2 for $fn"); - # Break down the file into it's component pieces. + # Break down the file into its component pieces. my $dir; # Directory path my $main; # Filename. @@ -1114,8 +1235,10 @@ sub phasetwo { $suffix=$1; #This is the actually filename extension if it exists $main=~s/\.\w+$//; #strip the extension } - my $dest; # On success this is where we'll go. - + my $dest; # + my $dest_dir; # On success this is where we'll go. + my $disp_newname; # + my $dest_newname; # &Debug($r,"loncfile::phase2 dir = $dir main = $main suffix = $suffix"); &Debug($r," newfilename = ".$env{'form.newfilename'}); @@ -1142,7 +1265,11 @@ sub phasetwo { if(!&Rename2($r, $uname, $dir, $fn, $env{'form.newfilename'})) { return; } - $dest = $env{'form.newfilename'}; + $dest = $dir."/"; + $dest_newname = $env{'form.newfilename'}; + $env{'form.newfilename'} =~ /.+(\/.+$)/; + $disp_newname = $1; + $disp_newname =~ s/\///; } } elsif ($env{'form.action'} eq 'delete') { if(!&Delete2($r, $uname, $env{'form.newfilename'})) { @@ -1173,7 +1300,12 @@ sub phasetwo { if ( ($env{'form.action'} eq 'newdir') && ($env{'form.phase'} eq 'two') && ( ($env{'form.callingmode'} eq 'testbank') || ($env{'form.callingmode'} eq 'imsimport') ) ) { $r->print('

'.&mt('Done').'

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

'.&mt('Done').'

'); + if ($env{'form.action'} eq 'rename') { + $r->print('

'.&mt('Return to Directory').'

'); + $r->print('

'.$disp_newname.'

'); + } else { + $r->print(&done(&url($dest))); + } } } @@ -1195,12 +1327,12 @@ sub handler { if ($env{'form.filename'}) { &Debug($r, "test: $env{'form.filename'}"); - $fn=&Apache::lonnet::unescape($env{'form.filename'}); + $fn=&unescape($env{'form.filename'}); $fn=&URLToPath($fn); } elsif($ENV{'QUERY_STRING'} && $env{'form.phase'} ne 'two') { #Just hijack the script only the first time around to inject the #correct information for further processing - $fn=&Apache::lonnet::unescape($env{'form.decompress'}); + $fn=&unescape($env{'form.decompress'}); $fn=&URLToPath($fn); $env{'form.action'}="decompress"; } elsif ($env{'form.qualifiedfilename'}) { @@ -1239,31 +1371,33 @@ sub handler { &Apache::loncommon::content_type($r,'text/html'); $r->send_http_header; + my (%loaditem,$js); + if ( ($env{'form.action'} eq 'newdir') && ($env{'form.phase'} eq 'two') && ( ($env{'form.callingmode'} eq 'testbank') || ($env{'form.callingmode'} eq 'imsimport') ) ) { my $newdirname = $env{'form.newfilename'}; - $r->print('LON-CAPA Construction Space - |); - my $loaditem = 'onLoad="writeDone()"'; - $r->print(&Apache::loncommon::bodytag('Construction Space File Operation','',$loaditem)); - } else { - $r->print('LON-CAPA Construction Space'); - $r->print(&Apache::loncommon::bodytag('Construction Space File Operation')); +|; + $loaditem{'onload'} = "writeDone()"; } - + + $r->print(&Apache::loncommon::start_page('Construction Space File Operation', + $js, + {'add_entries' => \%loaditem,})); $r->print('

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

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

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

'); + $r->print('

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

' + ); } @@ -1287,11 +1421,13 @@ function writeDone() { $env{'form.action'} eq 'newsequencefile' || $env{'form.action'} eq 'newrightsfile' || $env{'form.action'} eq 'newstyfile' || + $env{'form.action'} eq 'newtaskfile' || $env{'form.action'} eq 'newlibraryfile' || $env{'form.action'} eq 'Select Action' ) { $r->print('

'.&mt('New Resource').'

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

'.&mt('Unknown Action').' '.$env{'form.action'}.'

'); + $r->print('

'.&mt('Unknown Action').' '.$env{'form.action'}.'

'. + &Apache::loncommon::end_page()); return OK; } if ($env{'form.phase'} eq 'two') { @@ -1302,7 +1438,7 @@ function writeDone() { &phaseone($r,$fn,$uname,$udom); } - $r->print(''); + $r->print(&Apache::loncommon::end_page()); return OK; }