--- loncom/publisher/loncfile.pm 2012/11/30 11:36:14 1.117 +++ loncom/publisher/loncfile.pm 2024/09/03 10:40:04 1.130 @@ -9,7 +9,7 @@ # and displays a page showing the results of the action. # # -# $Id: loncfile.pm,v 1.117 2012/11/30 11:36:14 bisitz Exp $ +# $Id: loncfile.pm,v 1.130 2024/09/03 10:40:04 raeburn Exp $ # # Copyright Michigan State University Board of Trustees # @@ -37,16 +37,16 @@ =head1 NAME -Apache::loncfile - Construction space file management. +Apache::loncfile - Authoring space file management. =head1 SYNOPSIS - - Content handler for buttons on the top frame of the construction space + + 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 + 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 @@ -70,10 +70,10 @@ use HTML::Entities(); use Apache::Constants qw(:common :http :methods); use Apache::lonnet; use Apache::loncommon(); +use Apache::lonhtmlcommon; use Apache::lonlocal; use LONCAPA qw(:DEFAULT :match); - my $DEBUG=0; my $r; # Needs to be global for some stuff RF. @@ -88,13 +88,13 @@ my $r; # Needs to be global for some Parameters: =over 4 - + =item $request - The current request operation. =item $message - The message to put in the log file. =back - + Returns: nothing. @@ -109,13 +109,13 @@ sub Debug { } sub done { - my ($url) = @_; + my ($destfn) = @_; return '

' .&Apache::lonhtmlcommon::confirm_success(&mt("Done")) - .'
'.&mt("Continue").'' + .'
'.&mt("Continue").'' .'' .'

'; } @@ -125,7 +125,7 @@ sub done { =item URLToPath($url) Convert a URL to a file system path. - + In order to manipulate the construction space objects, it is necessary to access url identified objects a filespace objects. This function translates a construction space URL to a file system path. @@ -134,14 +134,14 @@ sub done { =over 4 =item Url - string [in] The url to convert. - + =back - + Returns: =over 4 -=item The corresponding file system path. +=item The corresponding file system path. =back @@ -167,11 +167,15 @@ sub URLToPath { } sub url { - my $fn=shift; + my ($fn,$context) = @_; my $londocroot = $Apache::lonnet::perlvar{'lonDocRoot'}; $fn=~ s/^\Q$londocroot\E//; $fn=~s{/\./}{/}g; - $fn=&HTML::Entities::encode($fn,'<>"&'); + if ($context eq 'js') { + &js_escape(\$fn); + } else { + $fn=&HTML::Entities::encode($fn,'\'<>"&'); + } return $fn; } @@ -206,14 +210,14 @@ 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. -# ignores a .DS_Store file put there when viewing directory via webDAV on MacOS. +# ignores a .DS_Store file put there when viewing directory via webDAV on MacOS. sub empty_directory { my ($dirname,$phase) = @_; if (opendir DIR, $dirname) { my @files = grep(!/^\.\.?$/, readdir(DIR)); # ignore . and .. - if (@files) { + if (@files) { my @orphans = grep(/\.(meta|save|log|bak|DS_Store)$/,@files); - if (scalar(@files) - scalar(@orphans) > 0) { + if (scalar(@files) - scalar(@orphans) > 0) { return 0; } else { if (($phase eq 'Delete2') && (@orphans > 0)) { @@ -235,7 +239,7 @@ sub empty_directory { =item exists($user, $domain, $file) - Determine if a resource file name has been published or exists + Determine if a resource filename has been published or exists in the construction space. Parameters: @@ -265,7 +269,7 @@ Returns: =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. - + =back =cut @@ -279,28 +283,28 @@ sub exists { $published=~s{^\Q$londocroot/priv/\E}{$londocroot/res/}; my ($type,$result); if ( -d $construct ) { - return ('error','

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

'); + return ('error','

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

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

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

'; + $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.").'

'; + $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.").'

'; + $result.='

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

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

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

'; + $result.='

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

'; } return ($type,$result); @@ -309,7 +313,7 @@ sub exists { =pod =item checksuffix($old, $new) - + Determine if a resource filename suffix (the stuff after the .) would change as a result of this operation. @@ -344,15 +348,16 @@ sub checksuffix { if ($old=~m:(.*)/+([^/]+)\.(\w+)$:) { $oldsuffix=$3; } if (lc($oldsuffix) ne lc($newsuffix)) { $result.= - '

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

'; + '

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

'; } return $result; } sub cleanDest { - my ($request,$dest,$subdir,$fn,$uname,$udom)=@_; + my ($dest,$subdir,$fn,$uname,$udom)=@_; #remove bad characters my $foundbad=0; + my $warnings; my $error=''; if ($subdir && $dest =~/\./) { $foundbad=1; @@ -367,30 +372,29 @@ sub cleanDest { my ($newpath)=($dest=~m|(.*)/|); ($newpath,$error)=&relativeDest($fn,$newpath,$uname,$udom); 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." - ,&display($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+)$/){ - $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.','','') - .'

'); + 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.','','') + .'

'; $dest =~ s/\.(\d+)(\.\w+)$/$2/; } if ($foundbad) { - $request->print('

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

' - ); + $warnings .= '

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

'; } - return ($dest,$error); + return ($dest,$error,$warnings); } sub relativeDest { @@ -459,7 +463,7 @@ Parameters: =item $user - string [in] - Name of the user that is initiating the request. -=item $directory - string [in] - Directory in which the operation is +=item $directory - string [in] - Directory in which the operation is being done relative to the top level construction space directory. @@ -469,20 +473,20 @@ Parameters: sub CloseForm2 { my ($request, $user, $fn) = @_; - $request->print(&done(&url($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 +=item $request - Apache Request Object [in] The request object for the current request. =item $filename - The filename relative to construction space. @@ -505,7 +509,7 @@ new filename relative to the current dir =back -=cut +=cut sub Rename1 { my ($request, $user, $domain, $fn, $newfilename, $style) = @_; @@ -583,7 +587,7 @@ sub Rename1 { ); return; } - + } =pod @@ -597,7 +601,7 @@ 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 the user initiating the request. @@ -628,7 +632,7 @@ sub Delete1 { ); return; } - } else { + } else { unless (&obsolete_unpub($user,$domain,$fn)) { $request->print('

' .&mt('Cannot delete non-obsolete published file.') @@ -665,7 +669,7 @@ 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 the user initiating the request. @@ -691,7 +695,7 @@ sub Copy1 { 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/.. @@ -700,9 +704,20 @@ sub Copy1 { my ($type,$return)=&exists($user, $domain, $newfilename); $request->print($return); if ($type eq 'error') { - $request->print('
'.&mt('Cancel').''); + $request->print('
'.&mt('Cancel').''); return; } +# Check if there is enough space. + my @fileinfo = stat($fn); + my ($dir,$fname) = ($fn =~ m{^(.+/)([^/]+)$}); + my $filesize = $fileinfo[7]; + $filesize = int($filesize/1000); #expressed in kb + my $output = &Apache::loncommon::excess_filesize_warning($user,$domain,'author', + $fname,$filesize,'copy'); + if ($output) { + $request->print($output.'
'.&mt('Cancel').''); + return; + } $request->print( '' @@ -725,7 +740,7 @@ sub Copy1 { =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. @@ -743,7 +758,7 @@ Parameters: =item $fn - source file. -=item $newdir - Name of the directory to be created; path relative to the +=item $newdir - Name of the directory to be created; path relative to the top level of construction space. =back @@ -804,10 +819,223 @@ sub Decompress1 { } } +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')). + '
'.&mt('Recurse').''. + ''. + '
'. + '
'.&mt('File types (extensions) to include').(' 'x2). + ''.(' 'x5).''.(' 'x2). + ''. + (' 'x2). + ''. + ''); + my $rem; + my $numinrow = 6; + for (my $i=0; $i<@posstypes; $i++) { + my $rem = $i%($numinrow); + if ($rem == 0) { + if ($i > 0) { + $request->print(''."\n"); + } + $request->print(''."\n"); + } + $request->print(''."\n"); + } + $rem = scalar(@posstypes)%($numinrow); + my $colsleft; + if ($rem) { + $colsleft = $numinrow - $rem; + } + if ($colsleft > 1 ) { + $request->print(''."\n"); + } elsif ($colsleft == 1) { + $request->print(''."\n"); + } + $request->print('
'. + ''. + '  
'."\n". + '
'. + '
'.&mt('Archive file format').''); + foreach my $possfmt ('tar','zip') { + if (exists($location_of{$possfmt})) { + $request->print(''. + '   '); + } + } + $request->print('
'."\n". + '
'. + ''.&mt('Compression to apply to tar file').''. + ''); + if ($cancompress) { + foreach my $compress ('gzip','bzip2','xz') { + if (exists($location_of{$compress})) { + $request->print('  '); + } + } + } else { + $request->print(''. + &mt('This LON-CAPA instance does not seem to have gzip, bzip2 or xz installed.'). + '
'.&mt('No compression will be used.').''); + } + $request->print('
'."\n". + ''."\n". + &Apache::lonhtmlcommon::row_closure(1). + &Apache::lonhtmlcommon::end_pick_box().'
'."\n" + ); + &CloseForm1($request, $fn); + } else { + $request->print('

' + .&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; + } + } + } + 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 { + &Apache::lonnet::delenv('cgi.author.archive'); + } + } + return ($earlyout,$idnum); +} + +sub cancel_archive_form { + my ($r,$title,$fname,$earlyout,$idnum) = @_; + $r->print('

'.$title.'

'."\n". + '
'."\n". + ''."\n". + ''."\n". + '

'.&mt('Each author may only have one archive request in process at a time.')."\n".'

'."\n". + '

'.&mt('Remove existing archive request?').' '."\n". + ''. + (' 'x2)."\n". + '

'."\n". + '
'); +} + =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, @@ -825,10 +1053,13 @@ Parameters: =item $domain - Name of the domain of the user -=item $fn - Source file name +=item $fn - Source filename =item $newfilename - Name of the file to be created; no path information + +=item $warnings - Information about changes to filename made by cleanDest(). + =back Side Effects: @@ -845,8 +1076,8 @@ button which returns you to the director =cut sub NewFile1 { - my ($request, $user, $domain, $fn, $newfilename) = @_; - return if (&filename_check($newfilename) ne 'ok'); + my ($request, $user, $domain, $fn, $newfilename, $warnings) = @_; + return if (&filename_check($newfilename,$warnings) ne 'ok'); if ($env{'form.action'} =~ /new(.+)file/) { my $extension=$1; @@ -859,8 +1090,8 @@ sub NewFile1 { } } my ($type, $result)=&exists($user,$domain,$newfilename); - $request->print($result); if ($type eq 'error') { + $request->print($warnings.$result); $request->print('
'); } else { my $extension; @@ -872,6 +1103,7 @@ sub NewFile1 { my @okexts = qw(xml html xhtml htm xhtm problem page sequence rights sty task library js css txt); if (($extension eq '') || (!grep(/^\Q$extension\E/,@okexts))) { my $validexts = '.'.join(', .',@okexts); + $request->print($warnings.$result); $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.').'
'. @@ -880,20 +1112,26 @@ sub NewFile1 { '

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

'. '

'); - return; + } 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 { + $request->print($warnings.$result); + $request->print('

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

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

'); + $request->print('

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

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

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

'); - $request->print('

'); } return; } @@ -913,7 +1151,7 @@ sub filename_check { ' '.&mt('Not Allowed').'
'); return; } - return 'ok'; + return 'ok'; } =pod @@ -924,7 +1162,7 @@ sub filename_check { are returned if the request cannot be performed (e.g. attempts to manipulate files that are nonexistent). If the operation can be performed, what is about to be done will be presented to the user for confirmation. If the -user confirms the request, then phase two is executed, the action +user confirms the request, then phase two is executed, the action performed and reported to the user. Parameters: @@ -933,12 +1171,12 @@ performed and reported to the user. =item $r - request object [in] - The Apache request being executed. -=item $fn = string [in] - The filename being manipulated by the +=item $fn = string [in] - The filename being manipulated by the request. =item $uname - string [in] Name of user logged in and doing this action. -=item $udom - string [in] Domain name under which the user logged in. +=item $udom - string [in] Domain name under which the user logged in. =back @@ -946,11 +1184,11 @@ performed and reported to the user. sub phaseone { my ($r,$fn,$uname,$udom)=@_; - + my $doingdir=0; if ($env{'form.action'} eq 'newdir') { $doingdir=1; } - my ($newfilename,$error) = - &cleanDest($r,$env{'form.newfilename'},$doingdir,$fn,$uname,$udom); + my ($newfilename,$error,$warnings) = + &cleanDest($env{'form.newfilename'},$doingdir,$fn,$uname,$udom); unless ($error) { ($newfilename,$error)=&relativeDest($fn,$newfilename,$uname,$udom); } @@ -959,60 +1197,80 @@ sub phaseone { if ($fn=~m{^(.*/)[^/]+$}) { $dirlist=$1; } else { - $dirlist=$fn; + $dirlist=$fn; + } + if ($warnings) { + $r->print($warnings); } $r->print('
'.$error.'
'. '

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

'); return; } - $r->print('
'. - ''. - ''. - ''); - - if ($env{'form.action'} eq 'rename') { - &Rename1($r, $uname, $udom, $fn, $newfilename, 'rename'); - } elsif ($env{'form.action'} eq 'move') { - &Rename1($r, $uname, $udom, $fn, $newfilename, 'move'); - } elsif ($env{'form.action'} eq 'delete') { - &Delete1($r, $uname, $udom, $fn); - } elsif ($env{'form.action'} eq 'decompress') { - &Decompress1($r, $uname, $udom, $fn); - } 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); - } 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 'newtaskfile' || - $env{'form.action'} eq 'newlibraryfile' || - $env{'form.action'} eq 'Select Action') { + $r->print('
'."\n". + ''."\n". + ''."\n". + ''."\n"); + + if ($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 'newtaskfile' || + $env{'form.action'} eq 'newlibraryfile' || + $env{'form.action'} eq 'Select Action') { my $empty=&mt('Type Name Here'); - if (($newfilename!~/\/$/) && ($newfilename!~/$empty$/)) { - &NewFile1($r, $uname, $udom, $fn, $newfilename); - } else { + if (($newfilename!~/\/$/) && ($newfilename!~/$empty$/)) { + &NewFile1($r, $uname, $udom, $fn, $newfilename, $warnings); + } else { + if ($warnings) { + $r->print($warnings); + } $r->print('

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

' ); - } + } + } else { + if ($warnings) { + $r->print($warnings); + } + if ($env{'form.action'} eq 'rename') { + &Rename1($r, $uname, $udom, $fn, $newfilename, 'rename'); + } elsif ($env{'form.action'} eq 'move') { + &Rename1($r, $uname, $udom, $fn, $newfilename, 'move'); + } elsif ($env{'form.action'} eq 'delete') { + &Delete1($r, $uname, $udom, $fn); + } elsif ($env{'form.action'} eq 'decompress') { + &Decompress1($r, $uname, $udom, $fn); + } elsif ($env{'form.action'} eq 'archive') { + if (($uname eq $env{'user.name'}) && ($udom eq $env{'user.domain'})) { + &Archive1($r,$fn); + } else { + $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); + } } } @@ -1067,7 +1325,7 @@ sub Rename2 { return 0; } ## If old name.(extension) exits, move under new name. - ## If it doesn't exist and a new.(extension) exists + ## 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'; @@ -1113,7 +1371,7 @@ sub Rename2 { =item Delete2($request, $user, $filename) - Performs phase two of a delete. The user has confirmed that they want + 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. @@ -1140,11 +1398,11 @@ Returns: sub Delete2 { my ($request, $user, $filename) = @_; - if (-d $filename) { - unless (&empty_directory($filename,'Delete2')) { - $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 { + } else { if(-e $filename) { unless(rmdir($filename)) { $request->print(''.&mt('Error').': '.$!.''); @@ -1173,7 +1431,7 @@ sub Delete2 { =item Copy2($request, $username, $dir, $oldfile, $newfile) - Performs phase 2 of a copy. The file is copied and the status + Performs phase 2 of a copy. The file is copied and the status of that copy is reported back to the user. =over 4 @@ -1211,7 +1469,7 @@ sub Copy2 { } elsif (!chmod(0660, $newfile)) { $request->print(''.&mt('chmod error').': '.$!.''); return 0; - } elsif (-e $oldfile.'.meta' && + } elsif (-e $oldfile.'.meta' && !copy($oldfile.'.meta', $newfile.'.meta') && !chmod(0660, $newfile.'.meta')) { $request->print(''.&mt('copy metadata error'). @@ -1251,7 +1509,7 @@ Returns 0 - failure 1 - success. sub NewDir2 { my ($request, $user, $newdirectory) = @_; - + unless(mkdir($newdirectory, 02770)) { $request->print(''.&mt('Error').': '.$!.''); return 0; @@ -1274,9 +1532,92 @@ sub decompress2 { 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) +=item phasetwo($r, $fn, $uname, $udom,$identifier) Controls the phase 2 processing of file management requests for construction space. In phase one, the user @@ -1284,7 +1625,7 @@ sub decompress2 { 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 + named action2 where action is the requested action and the 2 denotes phase 2 processing. Parameters: @@ -1307,12 +1648,12 @@ Parameters: =cut sub phasetwo { - my ($r,$fn,$uname,$udom)=@_; - + 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. @@ -1332,24 +1673,33 @@ sub phasetwo { &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') { + 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.archive'}) && + ($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; + $dir=$1; } if(!&Rename2($r, $uname, $dir, $fn, $env{'form.newfilename'})) { return; @@ -1360,7 +1710,7 @@ sub phasetwo { $disp_newname = $1; $disp_newname =~ s/\///; } - } elsif ($env{'form.action'} eq 'delete') { + } elsif ($env{'form.action'} eq 'delete') { if(!&Delete2($r, $uname, $env{'form.newfilename'})) { return ; } @@ -1368,7 +1718,7 @@ sub phasetwo { # previously held it. # $dest = $dir."/."; # Parent dir. - } elsif ($env{'form.action'} eq 'copy') { + } elsif ($env{'form.action'} eq 'copy') { if($env{'form.newfilename'}) { if(!&Copy2($r, $uname, $dir, $fn, $env{'form.newfilename'})) { return ; @@ -1401,7 +1751,7 @@ sub phasetwo { [''.&mt('Return to Directory').'', ''.$disp_newname.''])); } else { - $r->print(&done(&url($dest))); + $r->print(&done($dest)); } } } @@ -1410,7 +1760,7 @@ sub handler { $r=shift; - &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},['decompress','action','filename','newfilename']); + &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},['decompress','action','filename','newfilename','mode']); &Debug($r, "loncfile.pm - handler entered"); &Debug($r, " filename: ".$env{'form.filename'}); @@ -1418,100 +1768,326 @@ sub handler { # # 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 +# 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..archive key, where id +# is a unique cgi_id created when an Author creates an archive of +# Authoring Space for download. # - my $fn; + my ($fn,$archiveref); if ($env{'form.filename'}) { &Debug($r, "test: $env{'form.filename'}"); $fn=&unescape($env{'form.filename'}); $fn=&URLToPath($fn); - } elsif($ENV{'QUERY_STRING'} && $env{'form.phase'} ne 'two') { + } elsif ($env{'form.delarchive'}) { + my ($delarchive,$suffix) = split(/\./,$env{'form.delarchive'}); + if (($delarchive) && (exists($env{'cgi.'.$delarchive.'.archive'}))) { + $archiveref = &Apache::lonnet::thaw_unescape($env{'cgi.'.$delarchive.'.archive'}); + if (ref($archiveref) eq 'HASH') { + $fn = $archiveref->{'dir'}; + } + } + } 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=&unescape($env{'form.decompress'}); - $fn=&URLToPath($fn); - $env{'form.action'}="decompress"; + if ($env{'form.decompress'} ne '') { + $fn=&unescape($env{'form.decompress'}); + $fn=&URLToPath($fn); + $env{'form.action'}="decompress"; + } } 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'}. - ' unspecified filename for cfile', $r->filename); + ' unspecified filename for cfile', $r->filename); return HTTP_NOT_FOUND; } - unless ($fn) { + unless ($fn) { &Debug($r, "loncfile::handler - doctored url is empty"); $r->log_reason($env{'user.name'}.' at '.$env{'user.domain'}. - ' trying to cfile non-existing file', $r->filename); + ' trying to cfile non-existing file', $r->filename); return HTTP_NOT_FOUND; - } + } # ----------------------------------------------------------- Start page output my ($uname,$udom) = &Apache::lonnet::constructaccess($fn); - &Debug($r, + &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); + ' ('.$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; - my (%loaditem,$js); +# 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') ) ) { + 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 = qq| + &js_escape(\$newdirname); + $js = <<"ENDJS"; -|; - $loaditem{'onload'} = "writeDone()"; +// ]]> + +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 $crsauthor; + my $text = 'Authoring Space'; + my $title = 'Authoring Space File Operation', + my $href = &Apache::loncommon::authorspace(&url($fn)); + if ($env{'request.course.id'}) { + my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'}; + my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'}; + if ($href eq "/priv/$cdom/$cnum/") { + $text = 'Course Authoring Space'; + $title = 'Course Authoring Space File Operation', + $crsauthor = 1; + } + } &Apache::lonhtmlcommon::clear_breadcrumbs(); &Apache::lonhtmlcommon::add_breadcrumb({ - 'text' => 'Construction Space', - 'href' => &Apache::loncommon::authorspace($fn), + 'text' => $text, + 'href' => $href, }); &Apache::lonhtmlcommon::add_breadcrumb({ 'text' => 'File Operation', - 'title' => 'Construction Space File Operation', + 'title' => $title, 'href' => '', }); - $r->print(&Apache::loncommon::start_page('Construction Space File Operation', - $js, - {'add_entries' => \%loaditem,}) + $r->print(&Apache::loncommon::start_page($title,$js,$args) .&Apache::lonhtmlcommon::breadcrumbs() .&Apache::loncommon::head_subbox( &Apache::loncommon::CSTR_pageheader($trailfile)) ); - - $r->print('

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

'); - + + 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) - .'

' - ); + unless ($crsauthor) { + $r->print('

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

' + ); + } } @@ -1522,6 +2098,7 @@ function writeDone() { 'move' => 'Move', 'newdir' => 'New Directory', 'decompress' => 'Decompress', + 'archive' => 'Export directory to archive file', 'copy' => 'Copy', 'newfile' => 'New Resource', 'newhtmlfile' => 'New Resource', @@ -1535,7 +2112,52 @@ function writeDone() { 'Select Action' => 'New Resource', ); if ($action{$env{'form.action'}}) { - $r->print('

'.$action{$env{'form.action'}}.'

'); + if ($crsauthor) { + my @disallowed = qw(page sequence rights library); + my $newtype; + if ($env{'form.action'} =~ /^new(\w+)file$/) { + $newtype = $1; + } elsif ($env{'form.action'} eq 'newfile') { + ($newtype) = ($env{'form.newfilename'} =~ m{\.([^/.]+)$}); + $newtype = lc($newtype); + } + if (($newtype ne '') && + (grep(/^\Q$newtype\E$/,@disallowed))) { + $r->print('

' + .&mt('Creation of a new file of type: [_1] is not permitted in Course Authoring Space',$newtype) + .'

' + .&Apache::loncommon::end_page() + ); + return OK; + } + if ($env{'form.action'} eq 'archive') { + $r->print('

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

'."\n". + '

'. + &mt('Export to an archive file is not permitted in Course Authoring Space'). + '

'."\n". + &Apache::loncommon::end_page()); + return OK; + } + } elsif ($env{'form.action'} eq 'archive') { + if ($env{'environment.canarchive'}) { + if ($archive_earlyout) { + my $fname = &url($fn); + my $title = $action{$env{'form.action'}}; + &cancel_archive_form($r,$title,$fname,$archive_earlyout,$archive_idnum); + &CloseForm1($r,$fn); + $r->print(&Apache::loncommon::end_page()); + return OK; + } + } else { + $r->print('

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

'."\n". + '

'. + &mt('You do not have permission to export to an archive file in this Authoring Space'). + '

'."\n". + &Apache::loncommon::end_page()); + return OK; + } + } + $r->print('

'.$action{$env{'form.action'}}.'

'."\n"); } else { $r->print('

' .&mt('Unknown Action: [_1]',$env{'form.action'}) @@ -1547,14 +2169,14 @@ function writeDone() { if ($env{'form.phase'} eq 'two') { &Debug($r, "loncfile::handler entering phase2"); - &phasetwo($r,$fn,$uname,$udom); + &phasetwo($r,$fn,$uname,$udom,$identifier); } else { &Debug($r, "loncfile::handler entering phase1"); &phaseone($r,$fn,$uname,$udom); } $r->print(&Apache::loncommon::end_page()); - return OK; + return OK; } 1;