--- loncom/publisher/loncfile.pm 2001/06/24 18:21:09 1.6 +++ loncom/publisher/loncfile.pm 2024/09/26 23:04:06 1.129.2.3 @@ -1,249 +1,2146 @@ # The LearningOnline Network with CAPA # Handler to rename files, etc, in construction space # -# (Handler to retrieve an old version of a file +# This file responds to the various buttons and events +# in the top frame of the construction space directory. +# Each event is processed in two phases. The first phase +# 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. # -# (Publication Handler -# -# (TeX Content Handler # -# 05/29/00,05/30,10/11 Gerd Kortemeyer) +# $Id: loncfile.pm,v 1.129.2.3 2024/09/26 23:04:06 raeburn Exp $ # -# 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) +# Copyright Michigan State University Board of Trustees # -# 03/31,04/03,05/02,05/09,06/23,06/24 Gerd Kortemeyer) +# This file is part of the LearningOnline Network with CAPA (LON-CAPA). # -# 06/23 Gerd Kortemeyer +# 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/ +# +=pod + +=head1 NAME + +Apache::loncfile - Authoring space file management. + +=head1 SYNOPSIS + + Content handler for buttons on the top frame of the construction space +directory. + +=head1 INTRODUCTION + + loncfile is invoked when buttons in the top frame of the construction +space directory listing are clicked. All operations proceed in two phases. +The first phase describes to the user exactly what will be done. If the user +confirms the operation, the second phase commits the operation and indicates +completion. When the user dismisses the output of phase2, they are returned to +an "appropriate" directory listing in general. + + This is part of the LearningOnline Network with CAPA project +described at http://www.lon-capa.org. + +=head2 Subroutines + +=cut package Apache::loncfile; use strict; use Apache::File; +use File::Basename; use File::Copy; +use HTML::Entities(); use Apache::Constants qw(:common :http :methods); -use Apache::loncacc; +use Apache::lonnet; +use Apache::loncommon(); +use Apache::lonhtmlcommon; +use Apache::lonlocal; +use LONCAPA qw(:DEFAULT :match); -sub phaseone { - my ($r,$fn,$uname,$udom)=@_; +my $DEBUG=0; +my $r; # Needs to be global for some stuff RF. - $fn=~/(.*)\/([^\/]+)\.(\w+)$/; - my $dir=$1; - my $main=$2; - my $suffix=$3; - - my $conspace='/home/'.$uname.'/public_html'.$fn; - - $r->print('
'); - return; + $type = 'error'; + $result.=''.&mt("Error: a published $published_type of this name exists.").'
'; } - } else { - $r->print('No such file.'); - return; - } - } elsif ($ENV{'form.action'} eq 'delete') { - if (-e $conspace) { - $r->print('
Delete '.$fn.'?'); - } else { - $r->print('
No such file.'); - return; - } - } elsif ($ENV{'form.action'} eq 'copy') { - if (-e $conspace) { - if ($ENV{'form.newfilename'}) { - $ENV{'form.newfilename'}=~/(.*)\/([^\/]+)\.(\w+)$/; - if ($3 ne $suffix) { - $r->print( - '
Warning: change of MIME type!'); - } - if (-e - '/home/httpd/'.$uname.'/'.$dir.'/'.$ENV{'form.newfilename'}) { - $r->print( - '
Warning: target file exists!'); - } - $r->print('
Copy '.$fn.' to '. - $dir.'/'.$ENV{'form.newfilename'}.'?'); + } + } elsif ( -e $construct) { + $type = 'warning'; + $result.='
'.&mt('Warning: target file exists!').'
'; + } + + return ($type,$result); +} + +=pod + +=item checksuffix($old, $new) + + Determine if a resource filename suffix (the stuff after the .) would change +as a result of this operation. + + Parameters: + +=over 4 + +=item $old = string [in] Previous filename. + +=item $new = string [in] Resultant filename. + +=back + + Returns: + +=over 4 + +=item Empty string if everything worked. + +=item String containing an error message if there was a problem. + +=back + +=cut + +sub checksuffix { + my ($old,$new) = @_; + my $result; + my $oldsuffix; + my $newsuffix; + if ($new=~m:(.*/*)([^/]+)\.(\w+)$:) { $newsuffix=$3; } + if ($old=~m:(.*)/+([^/]+)\.(\w+)$:) { $oldsuffix=$3; } + if (lc($oldsuffix) ne lc($newsuffix)) { + $result.= + ''.&mt('Warning: change of MIME type!').'>
'; + } + return $result; +} + +sub cleanDest { + my ($dest,$subdir,$fn,$uname,$udom)=@_; + #remove bad characters + my $foundbad=0; + my $warnings; + my $error=''; + if ($subdir && $dest =~/\./) { + $foundbad=1; + $dest=~s/\.//g; + } + $dest =~ s/(\s+$|^\s+)//g; + if ($dest=~/[\#\?&%\":]/) { + $foundbad=1; + $dest=~s/[\#\?&%\":]//g; + } + if ($dest=~m|/|) { + my ($newpath)=($dest=~m|(.*)/|); + ($newpath,$error)=&relativeDest($fn,$newpath,$uname,$udom); + if (! -d "$newpath") { + $warnings = '' + .&mt("You have requested to create file in directory [_1] which doesn't exist. The requested directory path has been removed from the requested filename." + ,&display($newpath)) + .'
'; + $dest=~s|.*/||; + } + } + if ($dest =~ /\.(\d+)\.(\w+)$/) { + $warnings .= ''
+ .&mt('Bad filename [_1]',&display($dest))
+ .'
'
+ .&mt('[_1](name).(number).(extension)[_2] not allowed.','','')
+ .'
'
+ .&mt('Removing the [_1].number.[_2] from requested filename.','','')
+ .'
' + .&mt('Invalid characters in requested name have been removed.') + .'
'; + } + return ($dest,$error,$warnings); +} + +sub relativeDest { + my ($fn,$newfilename,$uname,$udom)=@_; + my $error = ''; + if ($newfilename=~/^\//) { +# absolute, simply add path + my $londocroot = $Apache::lonnet::perlvar{'lonDocRoot'}; + $newfilename="$londocroot/res/$udom/$uname/"; + } else { + my $dir=$fn; + $dir=~s{/[^/]+$}{}; + $newfilename=$dir.'/'.$newfilename; + } + $newfilename=~s{//+}{/}g; # remove duplicate / + while ($newfilename=~m{/\.\./}) { + $newfilename=~ s{/[^/]+/\.\./}{/}g; #remove dir/.. + } + my ($authorname,$authordom)=&Apache::lonnet::constructaccess($newfilename); + unless (($authorname) && ($authordom)) { + my $otherdir = &display($newfilename); + $error = &mt('Access denied to [_1]',$otherdir); + } + return ($newfilename,$error); +} + +=pod + +=item CloseForm1($request, $user, $file) + + Close of a form on the successful completion of phase 1 processing + +Parameters: + +=over 4 + +=item $request - Apache Request Object [in] - Apache server request object. + +=item $cancelurl - the url to go to on cancel. + +=back + +=cut + +sub CloseForm1 { + my ($request, $fn) = @_; + $request->print(''); + $request->print(' '); +} + + +=pod + +=item CloseForm2($request, $user, $directory) + + Successfully close off the phase 2 form. + +Parameters: + +=over 4 + +=item $request - Apache Request object [in] - The request that is being + executed. + +=item $user - string [in] - Name of the user that is initiating the + request. + +=item $directory - string [in] - Directory in which the operation is + being done relative to the top level construction space + directory. + +=back + +=cut + +sub CloseForm2 { + my ($request, $user, $fn) = @_; + $request->print(&done($fn)); +} + +=pod + +=item Rename1($request, $filename, $user, $domain, $dir) + + Perform phase 1 processing of the file rename operation. + +Parameters: + +=over 4 + +=item $request - Apache Request Object [in] The request object for the +current request. + +=item $filename - The filename relative to construction space. + +=item $user - Name of the user making the request. + +=item $domain - User login domain. + +=item $dir - Directory specification of the path to the file. + +=back + +Side effects: + +=over 4 + +=item A new form is displayed prompting for confirmation. The newfilename +hidden field of this form is loaded with +new filename relative to the current directory ($dir). + +=back + +=cut + +sub Rename1 { + my ($request, $user, $domain, $fn, $newfilename, $style) = @_; + + if(-e $fn) { + if($newfilename) { + # is dest a dir + if ($style eq 'move') { + if (-d $newfilename) { + if ($fn =~ m|/([^/]*)$|) { $newfilename .= '/'.$1; } + } + } + if ($newfilename =~ m|/[^\.]+$|) { + #no extension add on original extension + if ($fn =~ m|/[^\.]*\.([^\.]+)$|) { + $newfilename.='.'.$1; + } + } + $request->print(&checksuffix($fn, $newfilename)); + #renaming a dir, delete the trailing / + #remove second to last element for current dir + if (-d $fn) { + $newfilename=~/\.(\w+)$/; + if (&Apache::loncommon::fileembstyle($1) eq 'ssi') { + $request->print(''.
+ &mt('Cannot change MIME type of a directory.').
+ ''.
+ '
'.&mt('Cancel').'
'
+ .&mt('Cannot rename or move non-obsolete published file.')
+ .'
'
+ .''.&mt('Cancel').'
No new filename specified.'); - return; + $action='Move'; } + $request->print('' + .'
' + .&mt($action.' [_1] to [_2]?', + &display($fn), + &display($newfilename)) + .'
' + ); + &CloseForm1($request, $fn); + } else { + $request->print(''.&mt('No new filename specified.').'
'); + return; + } + } else { + $request->print('' + .&mt('No such file: [_1]', + &display($fn)) + .'
' + ); + return; + } + +} + +=pod + +=item Delete1 + + Performs phase 1 processing of the delete operation. In phase one + we just check to be sure the file exists. + +Parameters: + +=over 4 + +=item $request - Apache Request Object [in] request object for the current + request. + +=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] Source filename. + +=back + +=cut + +sub Delete1 { + my ($request, $user, $domain, $fn) = @_; + + if( -e $fn) { + $request->print(''); + if (-d $fn) { + unless (&empty_directory($fn,'Delete1')) { + $request->print(''
+ .''
+ .&mt('Only empty directories may be deleted.')
+ .'
'
+ .&mt('You must delete the contents of the directory first.')
+ .'
No such file.'); - return; + unless (&obsolete_unpub($user,$domain,$fn)) { + $request->print('
'
+ .&mt('Cannot delete non-obsolete published file.')
+ .'
'
+ .''.&mt('Cancel').'
Directory exists.'); + $request->print('
' + .&mt('Delete [_1]?', + &display($fn)) + .'
' + ); + &CloseForm1($request, $fn); + } else { + $request->print('' + .&mt('No such file: [_1]', + &display($fn)) + .'
' + ); + } +} + +=pod + +=item Copy1($request, $user, $domain, $filename, $newfilename) + + Performs phase 1 processing of the construction space copy command. + Ensure that the source file exists. Ensure that a destination exists, + also warn if the destination already exists. + +Parameters: + +=over 4 + +=item $request - Apache Request Object [in] request object for the current + request. + +=item $user - string [in] Name of the user initiating the request. + +=item $domain - string [in] Domain the initiating user is logged in as + +=item $fn - string [in] Source filename. + +=item $newfilename-string [in] Destination filename. + +=back + +=cut + +sub Copy1 { + my ($request, $user, $domain, $fn, $newfilename) = @_; + + if(-e $fn) { + # is dest a dir + if (-d $newfilename) { + if ($fn =~ m|/([^/]*)$|) { $newfilename .= '/'.$1; } + } + if ($newfilename =~ m|/[^\.]+$|) { + #no extension add on original extension + if ($fn =~ m|/[^\.]*\.([^\.]+)$|) { $newfilename.='.'.$1; } + } + $newfilename=~s://+:/:g; # remove duplicate / + while ($newfilename=~m:/\.\./:) { + $newfilename=~ s:/[^/]+/\.\./:/:g; #remove dir/.. + } + $request->print(&checksuffix($fn,$newfilename)); + my ($type,$return)=&exists($user, $domain, $newfilename); + $request->print($return); + if ($type eq 'error') { + $request->print('Make new directory '. - $fn.$ENV{'form.newfilename'}.'?'); - + $request->print( + '' + .'
' + .&mt('Copy [_1] to [_2]?', + &display($fn), + &display($newfilename)) + .'
' + ); + &CloseForm1($request, $fn); + } else { + $request->print('' + .&mt('No such file: [_1]', + &display($fn)) + .'
' + ); } - $r->print(''); } -sub phasetwo { - my ($r,$fn,$uname,$udom)=@_; +=pod + +=item NewDir1 + + Does all phase 1 processing of directory creation: + Ensures that the user provides a new directory name, + and that the directory does not already exist. + +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 - 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. +=back + +Side Effects: + +=over 4 + +=item A new form is displayed. Clicking on the confirmation button +causes the newdir operation to transition into phase 2. The hidden field +"newfilename" is set with the construction space path to the new directory. + + +=back - $fn=~/(.*)\/([^\/]+)\.(\w+)$/; - my $dir=$1; - my $main=$2; - my $suffix=$3; - - my $conspace='/home/'.$uname.'/public_html'.$fn; - - if ($ENV{'form.action'} eq 'rename') { - if (-e $conspace) { - if ($ENV{'form.newfilename'}) { - unless (rename('/home/'.$uname.'/public_html'.$fn, - '/home/'.$uname.'/public_html'.$dir.'/'.$ENV{'form.newfilename'})) { - $r->print('Error: '.$!.''); +=cut + + +sub NewDir1 { + my ($request, $username, $domain, $fn, $newfilename, $mode) = @_; + + my ($type, $result)=&exists($username,$domain,$newfilename,'directory'); + $request->print($result); + if ($type eq 'error') { + $request->print(''); + } else { + if (($mode eq 'testbank') || ($mode eq 'imsimport')) { + $request->print(''."\n". + ''); + } + $request->print('' + .'
' + .&mt('Make new directory [_1]?', + &display($newfilename)) + .'
' + ); + &CloseForm1($request, $fn); + } +} + + +sub Decompress1 { + my ($request, $user, $domain, $fn) = @_; + if( -e $fn) { + $request->print(''); + $request->print('' + .&mt('Decompress [_1]?', + &display($fn)) + .'
' + ); + &CloseForm1($request, $fn); + } else { + $request->print('' + .&mt('No such file: [_1]', + &display($fn)) + .'
' + ); + } +} + +sub Archive1 { + my ($request,$fn) = @_; + my @posstypes = qw(problem library sty sequence page task rights meta xml html xhtml htm xhtm css js tex txt gif jpg jpeg png svg other); + my (%location_of,%defaults); + my ($compstyle,$canarchive,$cancompress,$numformat,$numcompress,$defext) = + &archive_tools(\%location_of,\%defaults); + if (!$canarchive) { + $request->print(''. + &mt('This LON-CAPA instance does not seem to have either tar or zip installed.').'
'."\n". + ''. + &mt('At least one of the two is needed in order to be able to create an archive file for: [_1].', + &display($fn))."\n". + ''); + } elsif (-e $fn) { + $request->print(''."\n". + &Apache::lonhtmlcommon::start_pick_box(). + &Apache::lonhtmlcommon::row_title(&mt('Directory')). + &display($fn). + &Apache::lonhtmlcommon::row_closure(). + &Apache::lonhtmlcommon::row_title(&mt('Options'). + &Apache::loncommon::help_open_topic('Archiving_Directory_Options')). + ''. + ''. + ''."\n". + ''."\n". + ''."\n". + &Apache::lonhtmlcommon::row_closure(1). + &Apache::lonhtmlcommon::end_pick_box().'' + .&mt('No such directory: [_1]', + &display($fn)) + .'
' + ); + } + return; +} + +sub archive_tools { + my ($location_of,$defaults) = @_; + my ($compstyle,$canarchive,$cancompress,$numformat,$numcompress,$defext); + ($numformat,$numcompress) = (0,0); + if ((ref($location_of) eq 'HASH') && (ref($defaults) eq 'HASH')) { + foreach my $program ('tar','gzip','bzip2','xz','zip') { + foreach my $dir ('/bin/','/usr/bin/','/usr/local/bin/','/sbin/', + '/usr/sbin/') { + if (-x $dir.$program) { + $location_of->{$program} = $dir.$program; + last; + } + } } - } elsif ($ENV{'form.action'} eq 'delete') { - if (-e $conspace) { - unless (unlink('/home/'.$uname.'/public_html'.$fn)) { - $r->print('Error: '.$!.''); + foreach my $format ('tar','zip') { + if (exists($location_of->{$format})) { + unless ($canarchive) { + $defext = $format; + $defaults->{$format} = ' checked="checked"'; + if ($format eq 'tar') { + $compstyle = 'block'; + } else { + $compstyle = 'none'; + } + } + $canarchive = 1; + $numformat ++; + } + } + foreach my $compress ('gzip','bzip2','xz') { + if (exists($location_of->{$compress})) { + $numcompress ++; + unless ($cancompress) { + if ($defext eq 'tar') { + if ($compress eq 'gzip') { + $defext .= '.gz'; + } elsif ($compress eq 'bzip2') { + $defext .= '.bz2'; + } else { + $defext .= ".$compress"; + } + } + $defaults->{$compress} = ' checked="checked"'; + $cancompress = 1; + } + } + } + } + if (wantarray) { + return ($compstyle,$canarchive,$cancompress,$numformat,$numcompress,$defext); + } else { + return $defext; + } +} + +sub archive_in_progress { + my ($earlyout,$idnum); + if ($env{'cgi.author.archive'} =~ /^(\d+)_\d+_\d+$/) { + my $timestamp = $1; + $idnum = $env{'cgi.author.archive'}; + if (exists($env{'cgi.'.$idnum.'.archive'})) { + my $hashref = &Apache::lonnet::thaw_unescape($env{'cgi.'.$idnum.'.archive'}); + my $lonprtdir = $Apache::lonnet::perlvar{'lonPrtDir'}; + if (-e $lonprtdir.'/'.$env{'user.name'}.'_'.$env{'user.domain'}.'_archive_'.$idnum.'.txt') { + $earlyout = $timestamp; + } elsif (ref($hashref) eq 'HASH') { + my $suffix = $hashref->{'extension'}; + if (-e $lonprtdir.'/'.$env{'user.name'}.'_'.$env{'user.domain'}.'_archive_'.$idnum.$suffix) { + $earlyout = $timestamp; + } + } + unless ($earlyout) { + &Apache::lonnet::delenv('cgi.'.$idnum.'.archive'); + &Apache::lonnet::delenv('cgi.author.archive'); } } else { - $r->print('No such file.'); - return; + &Apache::lonnet::delenv('cgi.author.archive'); } - } elsif ($ENV{'form.action'} eq 'copy') { - if (-e $conspace) { - if ($ENV{'form.newfilename'}) { - unless (copy('/home/'.$uname.'/public_html'.$fn, - '/home/'.$uname.'/public_html'.$dir.'/'.$ENV{'form.newfilename'})) { - $r->print('Error: '.$!.''); - } - } else { - $r->print('
No new filename specified.'); - return; + } + return ($earlyout,$idnum); +} + +sub cancel_archive_form { + my ($r,$title,$fname,$earlyout,$idnum) = @_; + $r->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).
+ '
'. + '
'. + ''); + } elsif (($type ne 'warning') && ($warnings eq '') && ($result eq '')) { + my $query = ""; + $query .= "?mode=" . $env{'form.mode'} unless (!exists($env{'form.mode'}) || !length($env{'form.mode'})); + $request->print(' + '); } else { - $r->print('No such file.'); - return; + $request->print($warnings.$result); + $request->print('
'.&mt('Make new file').' '.&display($newfilename).'?
'); + $request->print(''); + $request->print(''); + $request->print(''); + } + } + return; +} + +sub filename_check { + my ($newfilename) = @_; + ##Informs User (name).(number).(extension) not allowed + if($newfilename =~ /\.(\d+)\.(\w+)$/){ + $r->print(''.$newfilename. + ' - '.&mt('Bad Filename').''.&mt('Return to Directory'). + '
'); return; } - $r->print('' + .&mt('Archiving of Authoring Spaces is only permitted by Author') + .'
' + ); + } + } elsif ($env{'form.action'} eq 'copy') { + if ($newfilename) { + &Copy1($r, $uname, $udom, $fn, $newfilename); + } else { + $r->print('' + .&mt('No new filename specified.') + .'
' + ); + } + } elsif ($env{'form.action'} eq 'newdir') { + my $mode = ''; + if (exists($env{'form.callingmode'}) ) { + $mode = $env{'form.callingmode'}; + } + &NewDir1($r, $uname, $udom, $fn, $newfilename, $mode); + } + } +} + +=pod + +=item Rename2($request, $user, $directory, $oldfile, $newfile) + +Performs phase 2 processing of a rename reequest. This is where the +actual rename is performed. + +Parameters + +=over 4 + +=item $request - Apache request object [in] The request being processed. + +=item $user - string [in] The name of the user initiating the request. + +=item $directory - string [in] The name of the directory relative to the + construction space top level of the renamed file. + +=item $oldfile - Name of the file. + +=item $newfile - Name of the new file. + +=back + +Returns: + +=over 4 + +=item 1 Success. + +=item 0 Failure. + +=cut + +sub Rename2 { + + my ($request, $user, $directory, $oldfile, $newfile) = @_; + + &Debug($request, "Rename2 directory: ".$directory." old file: ".$oldfile. + " new file ".$newfile."\n"); + &Debug($request, "Target is: ".$directory.'/'. + $newfile); + if (-e $oldfile) { + + my $oRN=$oldfile; + my $nRN=$newfile; + unless (rename($oldfile,$newfile)) { + $request->print(''.&mt('Error').': '.$!.''); + return 0; + } + ## If old name.(extension) exits, move under new name. + ## If it doesn't exist and a new.(extension) exists + ## delete it (only concern when renaming over files) + my $tmp1=$oRN.'.meta'; + my $tmp2=$nRN.'.meta'; + if(-e $tmp1){ + unless(rename($tmp1,$tmp2)){ } + } elsif(-e $tmp2){ + unlink $tmp2; + } + $tmp1=$oRN.'.save'; + $tmp2=$nRN.'.save'; + if(-e $tmp1){ + unless(rename($tmp1,$tmp2)){ } + } elsif(-e $tmp2){ + unlink $tmp2; + } + $tmp1=$oRN.'.log'; + $tmp2=$nRN.'.log'; + if(-e $tmp1){ + unless(rename($tmp1,$tmp2)){ } + } elsif(-e $tmp2){ + unlink $tmp2; + } + $tmp1=$oRN.'.bak'; + $tmp2=$nRN.'.bak'; + if(-e $tmp1){ + unless(rename($tmp1,$tmp2)){ } + } elsif(-e $tmp2){ + unlink $tmp2; + } + } else { + $request->print( + '' + .&mt('No such file: [_1]', + &display($oldfile)) + .'
' + ); + return 0; + } + return 1; +} + +=pod + +=item Delete2($request, $user, $filename) + + Performs phase two of a delete. The user has confirmed that they want +to delete the selected file. The file is deleted and the results of the +delete attempt are indicated. + +Parameters: + +=over 4 + +=item $request - Apache Request object [in] the request object for the current + delete operation. + +=item $user - string [in] The name of the user initiating the delete + request. + +=item $filename - string [in] The name of the file, relative to construction + space, to delete. + +=back + +Returns: + 1 - success. + 0 - Failure. + +=cut + +sub Delete2 { + my ($request, $user, $filename) = @_; + 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').': '.$!.''); + return 0; + } + } else { + $request->print(''.&mt('No such file').'
'); + return 0; + } + } + } else { + if(-e $filename) { + unless(unlink($filename)) { + $request->print(''.&mt('Error').': '.$!.''); + return 0; + } + } else { + $request->print(''.&mt('No such file').'
'); + return 0; + } + } + return 1; +} + +=pod + +=item Copy2($request, $username, $dir, $oldfile, $newfile) + + Performs phase 2 of a copy. The file is copied and the status + of that copy is reported back to the user. + +=over 4 + +=item $request - Apache request object [in]; the apache request currently + being executed. + +=item $username - string [in] Name of the user who is requesting the copy. + +=item $dir - string [in] Directory path relative to the construction space + of the destination file. + +=item $oldfile - string [in] Name of the source file. + +=item $newfile - string [in] Name of the destination file. + + +=back + +Returns 0 failure, and 1 successs. + +=cut + +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').': '.$!.''); + return 0; + } elsif (!chmod(0660, $newfile)) { + $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'). + ': '.$!.''); + return 0; + } else { + return 1; + } + } else { + $request->print(''.&mt('No such file').'
'); + return 0; + } + return 1; +} + +=pod + +=item NewDir2($request, $user, $newdirectory) + + Performs phase 2 processing of directory creation. This involves creating the directory and + reporting the results of that creation to the user. + +Parameters: +=over 4 + +=item $request - Apache request object [in]. Object representing the current HTTP request. + +=item $user - string [in] The name of the user that is initiating the request. + +=item $newdirectory - string [in] The full path of the directory being created. + +=back + +Returns 0 - failure 1 - success. + +=cut + +sub NewDir2 { + my ($request, $user, $newdirectory) = @_; + + unless(mkdir($newdirectory, 02770)) { + $request->print(''.&mt('Error').': '.$!.''); + return 0; + } + unless(chmod(02770, ($newdirectory))) { + $request->print(''.&mt('Error').': '.$!.''); + return 0; + } + return 1; +} + +sub decompress2 { + my ($r, $user, $dir, $file) = @_; + &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'); + &Apache::lonnet::delenv('cgi.dir'); + return 1; +} + +sub Archive2 { + my ($r,$uname,$udom,$fn,$identifier) = @_; + my %options = ( + dir => $fn, + uname => $uname, + udom => $udom, + ); + if ($env{'form.adload'}) { + $options{'adload'} = 1; + if ($env{'form.archivefname'} ne '') { + $env{'form.archivefname'} =~ s{\.+}{.}g; + $options{'fname'} = $env{'form.archivefname'}; + } + if ($env{'form.archiveext'} ne '') { + $options{'extension'} = $env{'form.archiveext'}; + } + } + my @filetypes = qw(problem library sty sequence page task rights meta xml html xhtml htm xhtm css js tex txt gif jpg jpeg png svg other); + my (@include,%oktypes); + map { $oktypes{$_} = 1; } @filetypes; + my @posstypes = &Apache::loncommon::get_env_multiple('form.filetype'); + foreach my $type (@posstypes) { + if ($oktypes{$type}) { + push(@include,$type); + } + } + if (scalar(@include) == scalar(@filetypes)) { + $options{'types'} = 'all'; + } else { + $options{'types'} = join(',',@include); + } + if (exists($env{'form.recurse'})) { + $options{'recurse'} = 1; + } + if (exists($env{'form.encrypt'})) { + if ($env{'form.enckey'} ne '') { + $options{'encrypt'} = $env{'form.enckey'}; + } + } + $options{'format'} = 'tar'; + $options{'compress'} = 'gzip'; + if ((exists($env{'form.format'})) && $env{'form.format'} =~ /^zip$/i) { + $options{'format'} = 'zip'; + delete($options{'compress'}); + } elsif ((exists($env{'form.compress'})) && ($env{'form.compress'} =~ /^(xz|bzip2)$/i)) { + $options{'compress'} = lc($env{'form.compress'}); + } + my $key = 'cgi.'.$identifier.'.archive'; + my $storestring = &Apache::lonnet::freeze_escape(\%options); + &Apache::lonnet::appenv({$key => $storestring, + 'cgi.author.archive' => $identifier}); + return 1; +} + +sub Archive3 { + my ($hashref) = @_; + if (ref($hashref) eq 'HASH') { + if (($hashref->{'uname'} eq $env{'user.name'}) && + ($hashref->{'udom'} eq $env{'user.domain'}) && + ($env{'environment.canarchive'}) && + ($env{'form.delarchive'})) { + my $filesdest = $Apache::lonnet::perlvar{'lonPrtDir'}.'/'.$env{'user.name'}.'_'.$env{'user.domain'}.'_archive_'.$env{'form.delarchive'}; + if (-e $filesdest) { + my $size = (stat($filesdest))[7]; + if (unlink($filesdest)) { + my ($identifier,$suffix) = split(/\./,$env{'form.delarchive'},2); + if (($identifier) && (exists($env{'cgi.'.$identifier.'.archive'}))) { + my $delres = &Apache::lonnet::delenv('cgi.'.$identifier.'.archive'); + if (($delres eq 'ok') && + (exists($env{'cgi.author.archive'})) && + ($env{'cgi.author.archive'} eq $identifier)) { + &Apache::lonnet::authorarchivelog($hashref,$size,$filesdest,'delete'); + &Apache::lonnet::delenv('cgi.author.archive'); + } + } + return 1; + } + } + } + } + return 0; +} + +=pod + +=item phasetwo($r, $fn, $uname, $udom,$identifier) + + Controls the phase 2 processing of file management + requests for construction space. In phase one, the user + was asked to confirm the operation. In phase 2, the operation + is performed and the result is shown. + + The strategy is to break out the processing into specific action processors + named action2 where action is the requested action and the 2 denotes + phase 2 processing. + +Parameters: + +=over 4 + +=item $r - Apache Request object [in] The request object for this httpd + transaction. + +=item $fn - string [in] A filename indicating the object that is being + manipulated. + +=item $uname - string [in] The name of the user initiating the file management + request. + +=item $udom - string [in] The login domain of the user initiating the + file management request. +=back + +=cut + +sub phasetwo { + my ($r,$fn,$uname,$udom,$identifier)=@_; + + &Debug($r, "loncfile - Entering phase 2 for $fn"); + + # Break down the file into its component pieces. + + my $dir; # Directory path + my $main; # Filename. + my $suffix; # Extension. + if ($fn=~m:(.*)/([^/]+):) { + $dir=$1; # Directory path + $main=$2; # Filename. + } + if($main=~m:\.(\w+)$:){ # Fixes problems with filenames with no extensions + $suffix=$1; #This is the actually filename extension if it exists + $main=~s/\.\w+$//; #strip the extension + } + 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'}); + + my $conspace=$fn; + + &Debug($r,"loncfile::phase2 Full construction space name: $conspace"); + + &Debug($r,"loncfie::phase2 action is $env{'form.action'}"); + + # Select the appropriate processing sub. + if ($env{'form.action'} eq 'decompress') { + $main .= '.'.$suffix; + if(!&decompress2($r, $uname, $dir, $main)) { + return ; + } + $dest = $dir."/."; + } elsif ($env{'form.action'} eq 'archive') { + if (($env{'environment.canarchive'}) && + ($env{'user.name'} eq $uname) && + ($env{'user.domain'} eq $udom)) { + &Archive2($r,$uname,$udom,$fn,$identifier); + } else { + $r->print(&mt('You do not have permission to export to an archive file in this Authoring Space')); + } + return; + } elsif ($env{'form.action'} eq 'rename' || + $env{'form.action'} eq 'move') { + if($env{'form.newfilename'}) { + if (!defined($dir)) { + $fn=~m:^(.*)/:; + $dir=$1; + } + if(!&Rename2($r, $uname, $dir, $fn, $env{'form.newfilename'})) { + return; + } + $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'})) { + return ; + } + # Once a resource is deleted, we just list the directory that + # previously held it. + # + $dest = $dir."/."; # Parent dir. + } elsif ($env{'form.action'} eq 'copy') { + if($env{'form.newfilename'}) { + if(!&Copy2($r, $uname, $dir, $fn, $env{'form.newfilename'})) { + return ; + } + $dest = $env{'form.newfilename'}; + } else { + $r->print(''.&mt('No New filename specified').'
'); + return; + } + + } elsif ($env{'form.action'} eq 'newdir') { + my $newdir= $env{'form.newfilename'}; + if(!&NewDir2($r, $uname, $newdir)) { + return; + } + $dest = $newdir."/"; + } + if ( ($env{'form.action'} eq 'newdir') && ($env{'form.phase'} eq 'two') && ( ($env{'form.callingmode'} eq 'testbank') || ($env{'form.callingmode'} eq 'imsimport') ) ) { + $r->print( + ''
+ .&Apache::lonhtmlcommon::confirm_success(&mt('Done'))
+ .'
'.&mt('Continue').''
+ .'
'.&Apache::lonhtmlcommon::confirm_success(&mt('Done')).'
' + .&Apache::lonhtmlcommon::actionbox( + [''.&mt('Return to Directory').'', + ''.$disp_newname.''])); + } else { + $r->print(&done($dest)); + } + } } sub handler { - my $r=shift; + $r=shift; - my $fn; + &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},['decompress','action','filename','newfilename','mode']); - if ($ENV{'form.filename'}) { - $fn=$ENV{'form.filename'}; - $fn=~s/^http\:\/\/[^\/]+//; - } else { - $r->log_reason($ENV{'user.name'}.' at '.$ENV{'user.domain'}. - ' unspecified filename for cfile', $r->filename); - return HTTP_NOT_FOUND; - } - - unless ($fn) { - $r->log_reason($ENV{'user.name'}.' at '.$ENV{'user.domain'}. - ' trying to cfile non-existing file', $r->filename); - return HTTP_NOT_FOUND; - } + &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, +# or in value of decompress form element, or need to be extracted +# from %env from hashref retrieved for cgi.Unknown Action'); - return OK; - } - if ($ENV{'form.phase'} eq 'two') { - &phasetwo($r,$fn,$uname,$udom); - } else { - &phaseone($r,$fn,$uname,$udom); - } + my ($uname,$udom) = &Apache::lonnet::constructaccess($fn); + &Debug($r, + "loncfile::handler constructaccess uname = $uname domain = $udom"); + if (($uname eq '') || ($udom eq '')) { + $r->log_reason($uname.' at '.$udom. + ' trying to manipulate file '.$env{'form.filename'}. + ' ('.$fn.') - not authorized', + $r->filename); + return HTTP_NOT_ACCEPTABLE; + } + if (($env{'form.delarchive'}) && + ($env{'environment.canarchive'})) { + &Apache::loncommon::content_type($r,'text/plain'); + $r->send_http_header; + if (($env{'user.name'} eq $uname) && + ($env{'user.domain'} eq $udom)) { + $r->print(&Archive3($archiveref)); + } else { + $r->print(&mt('You do not have permission to export to an archive file in this Authoring Space')); + } + return OK; + } + + &Apache::loncommon::content_type($r,'text/html'); + $r->send_http_header; + +# Declarations for items used for directory archive requests + my ($js,$identifier,$defext,$archive_earlyout,$archive_idnum); + my $args = {}; + + 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'}; + &js_escape(\$newdirname); + $js = <<"ENDJS"; + +ENDJS + $args->{'add_entries'} = { onload => "writeDone()" }; + } elsif (($env{'form.action'} eq 'archive') && + ($env{'environment.canarchive'})) { +# Check if author already has an archive request in process + ($archive_earlyout,$archive_idnum) = &archive_in_progress(); +# Check if archive request was in process which author wishes to terminate + if ($env{'form.remove_archive_request'}) { + if ($env{'form.remove_archive_request'} eq $archive_idnum) { + if (exists($env{'cgi.'.$archive_idnum.'.archive'})) { + my $archiveref = &Apache::lonnet::thaw_unescape($env{'cgi.'.$archive_idnum.'.archive'}); + if (ref($archiveref) eq 'HASH') { + $env{'form.delarchive'} = $archive_idnum.$archiveref->{'extension'}; + if (&Archive3($archiveref)) { + ($archive_earlyout,$archive_idnum) = &archive_in_progress(); + } + delete($env{'form.delarchive'}); + } + } + } + } + if ($archive_earlyout) { + my $conftext = + &mt('Removing an existing request will terminate an active download of the archive file.'); + &js_escape(\$conftext); + $js = <<"ENDJS"; + + +ENDJS + } else { + if ($env{'form.phase'} eq 'two') { + $identifier = &Apache::loncommon::get_cgi_id(); + $args->{'redirect'} = [0.1,"/cgi-bin/archive.pl?$identifier"]; + } else { + my (%location_of,%defaults); + $defext = &archive_tools(\%location_of,\%defaults); + my $check_uncheck_js = &Apache::loncommon::check_uncheck_jscript(); + $js = <<"ENDJS"; + + +ENDJS + $args->{'add_entries'} = { onload => "resetForm()" }; + } + } + } + my $londocroot = $r->dir_config('lonDocRoot'); + my $trailfile = $fn; + $trailfile =~ s{^/(priv/)}{$londocroot/$1}; + + # Breadcrumbs + my $text = 'Authoring Space'; + my $title = 'Authoring Space File Operation', + my $href = &Apache::loncommon::authorspace(&url($fn)); + &Apache::lonhtmlcommon::clear_breadcrumbs(); + &Apache::lonhtmlcommon::add_breadcrumb({ + 'text' => $text, + 'href' => $href, + }); + &Apache::lonhtmlcommon::add_breadcrumb({ + 'text' => 'File Operation', + 'title' => $title, + 'href' => '', + }); + + $r->print(&Apache::loncommon::start_page($title,$js,$args) + .&Apache::lonhtmlcommon::breadcrumbs() + .&Apache::loncommon::head_subbox( + &Apache::loncommon::CSTR_pageheader($trailfile)) + ); + + unless ($env{'form.action'} eq 'archive') { + $r->print('
'.&mt('Location').': '.&display($fn).'
'); + } + + if (($uname ne $env{'user.name'}) || ($udom ne $env{'user.domain'})) { + $r->print('' + .&mt('Co-Author [_1]',$uname.':'.$udom) + .'
' + ); + } + - $r->print('