--- loncom/publisher/loncfile.pm 2011/03/01 01:36:55 1.106
+++ loncom/publisher/loncfile.pm 2023/07/14 23:20:15 1.127
@@ -9,7 +9,7 @@
# and displays a page showing the results of the action.
#
#
-# $Id: loncfile.pm,v 1.106 2011/03/01 01:36:55 raeburn Exp $
+# $Id: loncfile.pm,v 1.127 2023/07/14 23:20:15 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
@@ -68,7 +68,6 @@ 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::lonlocal;
@@ -89,20 +88,20 @@ 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.
=cut
sub Debug {
- # Put out the indicated message butonly if DEBUG is true.
+ # Put out the indicated message but only if DEBUG is true.
if ($DEBUG) {
my ($r,$message) = @_;
$r->log_reason($message);
@@ -110,14 +109,15 @@ sub Debug {
}
sub done {
- my ($url)=@_;
- my $done=&mt("Done");
- return(< '
+ .&Apache::lonhtmlcommon::confirm_success(&mt("Done"))
+ .' '.&mt('Error: destination for operation is an existing directory.').' '.&mt('Error: destination for operation is an existing directory.').' '.&mt('Warning: target file exists, and has been published!').' '.&mt('Warning: target file exists, and has been published!').' '.&mt("Warning: a published $published_type of this name exists.").' '.&mt("Warning: a published $published_type of this name exists.").' '.&mt("Error: a published $published_type of this name exists.").' '.&mt("Error: a published $published_type of this name exists.").' '.&mt('Warning: target file exists!').' '.&mt('Warning: target file exists!').' '.&mt('Warning: change of MIME type!').' '.&mt('Warning: change of MIME type!').'> '
- .&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))
- .' '
+ .&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))
+ .' '
- .&mt('Bad filename [_1]',&display($dest))
- .' '
+ .&mt('Bad filename [_1]',&display($dest))
+ .' '
- .&mt('Invalid characters in requested name have been removed.')
- .' '
+ .&mt('Invalid characters in requested name have been removed.')
+ .' '
.&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('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("Continue").''
+ .''
+ .'
'
- .&mt('[_1](name).(number).(extension)[_2] not allowed.','','')
- .'
'
- .&mt('Removing the [_1].number.[_2] from requested filename.','','')
- .'
'
+ .&mt('[_1](name).(number).(extension)[_2] not allowed.','','')
+ .'
'
+ .&mt('Removing the [_1].number.[_2] from requested filename.','','')
+ .'
'.&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
@@ -807,7 +822,7 @@ sub Decompress1 {
=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 +840,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:
@@ -838,15 +856,15 @@ Side Effects:
=item 2 new forms are displayed. Clicking on the confirmation button
causes the browser to attempt to load the specfied URL, allowing the
proper handler to take care of file creation. There is also a Cancel
-button which returns you to the driectory listing you came from
+button which returns you to the directory listing you came from
=back
=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 +877,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 +890,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('
'.
@@ -880,20 +899,26 @@ sub NewFile1 {
'
'.&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 +938,7 @@ sub filename_check { ' '.&mt('Not Allowed').''); return; } - return 'ok'; + return 'ok'; } =pod @@ -924,7 +949,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 +958,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,73 +971,84 @@ 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); + my ($newfilename,$error,$warnings) = + &cleanDest($env{'form.newfilename'},$doingdir,$fn,$uname,$udom); unless ($error) { - ($newfilename,$error)=&relativeDest($fn,$newfilename,$uname); + ($newfilename,$error)=&relativeDest($fn,$newfilename,$uname,$udom); } if ($error) { my $dirlist; if ($fn=~m{^(.*/)[^/]+$}) { $dirlist=$1; } else { - $dirlist=$fn; + $dirlist=$fn; + } + if ($warnings) { + $r->print($warnings); } $r->print(''.&mt('Return to Directory'). + '
'); return; } $r->print('' - ); - } - } 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') { + + 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 '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 +1103,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'; @@ -1099,7 +1135,7 @@ sub Rename2 { } } else { $request->print( - '' + '
' .&mt('No such file: [_1]', &display($oldfile)) .'
' @@ -1113,7 +1149,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 +1176,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 +1209,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 +1247,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 +1287,7 @@ Returns 0 - failure 1 - success. sub NewDir2 { my ($request, $user, $newdirectory) = @_; - + unless(mkdir($newdirectory, 02770)) { $request->print(''.&mt('Error').': '.$!.''); return 0; @@ -1284,7 +1320,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: @@ -1308,11 +1344,11 @@ Parameters: sub phasetwo { my ($r,$fn,$uname,$udom)=@_; - + &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,13 +1368,13 @@ 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 ; @@ -1349,7 +1385,7 @@ sub phasetwo { 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 +1396,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 +1404,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 ; @@ -1387,13 +1423,21 @@ sub phasetwo { $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(&url($dest))); + $r->print(&done($dest)); } } } @@ -1402,7 +1446,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,7 +1462,7 @@ sub handler { &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{'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'}); @@ -1429,30 +1473,27 @@ sub handler { } 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; - my $udom; - ($uname,$udom)= - &Apache::loncacc::constructaccess($fn,$r->dir_config('lonDefDomain')); - &Debug($r, + my ($uname,$udom) = &Apache::lonnet::constructaccess($fn); + &Debug($r, "loncfile::handler constructaccess uname = $uname domain = $udom"); - unless (($uname) && ($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; } @@ -1475,69 +1516,105 @@ function writeDone() { |; $loaditem{'onload'} = "writeDone()"; } - + + 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(), + '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', + $r->print(&Apache::loncommon::start_page($title, $js, {'add_entries' => \%loaditem,}) .&Apache::lonhtmlcommon::breadcrumbs() .&Apache::loncommon::head_subbox( - &Apache::loncommon::CSTR_pageheader()) + &Apache::loncommon::CSTR_pageheader($trailfile)) ); - - $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) + .'
' + ); + } } &Debug($r, "loncfile::handler Form action is $env{'form.action'} "); - if ($env{'form.action'} eq 'delete') { - $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; + } + } + $r->print('' - .&mt('Unknown Action').' '.$env{'form.action'} + .&mt('Unknown Action: [_1]',$env{'form.action'}) .'
' .&Apache::loncommon::end_page() ); - return OK; + return OK; } + if ($env{'form.phase'} eq 'two') { &Debug($r, "loncfile::handler entering phase2"); &phasetwo($r,$fn,$uname,$udom); @@ -1547,7 +1624,7 @@ function writeDone() { } $r->print(&Apache::loncommon::end_page()); - return OK; + return OK; } 1;