[BACK]Return to loncfile.pm CVS log [TXT] [DIR] Up to [LON-CAPA] / loncom / publisher

Diff for /loncom/publisher/loncfile.pm between versions 1.126 and 1.127

version 1.126, 2023/07/14 14:32:57 version 1.127, 2023/07/14 23:20:15
Line 40 Line 40
 Apache::loncfile - Authoring space file management.  Apache::loncfile - Authoring space file management.
   
 =head1 SYNOPSIS  =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.  directory.
   
 =head1 INTRODUCTION  =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.  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  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  confirms the operation, the second phase commits the operation and indicates
Line 88  my $r;    # Needs to be global for some Line 88  my $r;    # Needs to be global for some
  Parameters:   Parameters:
   
 =over 4  =over 4
    
 =item $request - The current request operation.  =item $request - The current request operation.
   
 =item $message - The message to put in the log file.  =item $message - The message to put in the log file.
   
 =back  =back
     
  Returns:   Returns:
    nothing.     nothing.
   
Line 125  sub done { Line 125  sub done {
 =item URLToPath($url)  =item URLToPath($url)
   
   Convert a URL to a file system path.    Convert a URL to a file system path.
     
   In order to manipulate the construction space objects, it is necessary    In order to manipulate the construction space objects, it is necessary
   to access url identified objects a filespace objects.  This function    to access url identified objects a filespace objects.  This function
   translates a construction space URL to a file system path.    translates a construction space URL to a file system path.
Line 134  sub done { Line 134  sub done {
 =over 4  =over 4
   
 =item  Url    - string [in] The url to convert.  =item  Url    - string [in] The url to convert.
     
 =back  =back
     
  Returns:   Returns:
   
 =over 4  =over 4
   
 =item  The corresponding file system path.   =item  The corresponding file system path.
   
 =back  =back
   
Line 210  sub obsolete_unpub { Line 210  sub obsolete_unpub {
 # see if directory is empty  # see if directory is empty
 # ignores any .meta, .save, .bak, and .log files created for a previously  # ignores any .meta, .save, .bak, and .log files created for a previously
 # published file, which has since been marked obsolete and deleted.  # 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 {  sub empty_directory {
     my ($dirname,$phase) = @_;      my ($dirname,$phase) = @_;
     if (opendir DIR, $dirname) {      if (opendir DIR, $dirname) {
         my @files = grep(!/^\.\.?$/, readdir(DIR)); # ignore . and ..          my @files = grep(!/^\.\.?$/, readdir(DIR)); # ignore . and ..
         if (@files) {           if (@files) {
             my @orphans = grep(/\.(meta|save|log|bak|DS_Store)$/,@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;                  return 0;
             } else {              } else {
                 if (($phase eq 'Delete2') && (@orphans > 0)) {                  if (($phase eq 'Delete2') && (@orphans > 0)) {
Line 269  Returns: Line 269  Returns:
 =item  string - Either where the resource exists as an html string that can  =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             be embedded in a dialog or an empty string if the resource
            does not exist.             does not exist.
     
 =back  =back
   
 =cut  =cut
Line 313  sub exists { Line 313  sub exists {
 =pod  =pod
   
 =item checksuffix($old, $new)  =item checksuffix($old, $new)
           
   Determine if a resource filename suffix (the stuff after the .) would change    Determine if a resource filename suffix (the stuff after the .) would change
 as a result of this operation.  as a result of this operation.
   
Line 463  Parameters: Line 463  Parameters:
 =item   $user       - string [in] - Name of the user that is initiating the  =item   $user       - string [in] - Name of the user that is initiating the
                  request.                   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                   being done relative to the top level construction space
                  directory.                   directory.
   
Line 479  sub CloseForm2 { Line 479  sub CloseForm2 {
 =pod  =pod
   
 =item Rename1($request, $filename, $user, $domain, $dir)  =item Rename1($request, $filename, $user, $domain, $dir)
    
    Perform phase 1 processing of the file rename operation.     Perform phase 1 processing of the file rename operation.
   
 Parameters:  Parameters:
   
 =over 4  =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.  current request.
   
 =item  $filename  - The filename relative to construction space.  =item  $filename  - The filename relative to construction space.
Line 509  new filename relative to the current dir Line 509  new filename relative to the current dir
   
 =back  =back
   
 =cut    =cut
   
 sub Rename1 {  sub Rename1 {
     my ($request, $user, $domain, $fn, $newfilename, $style) = @_;      my ($request, $user, $domain, $fn, $newfilename, $style) = @_;
Line 587  sub Rename1 { Line 587  sub Rename1 {
         );          );
  return;   return;
     }      }
       
 }  }
   
 =pod  =pod
Line 601  Parameters: Line 601  Parameters:
   
 =over 4  =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.                  request.
   
 =item   $user      - string [in]  Name of the user initiating the request.  =item   $user      - string [in]  Name of the user initiating the request.
Line 632  sub Delete1 { Line 632  sub Delete1 {
                 );                  );
                 return;                  return;
             }              }
         } else {           } else {
     unless (&obsolete_unpub($user,$domain,$fn)) {      unless (&obsolete_unpub($user,$domain,$fn)) {
                 $request->print('<p><span class="LC_error">'                  $request->print('<p><span class="LC_error">'
                                .&mt('Cannot delete non-obsolete published file.')                                 .&mt('Cannot delete non-obsolete published file.')
Line 669  Parameters: Line 669  Parameters:
   
 =over 4  =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.                  request.
   
 =item   $user      - string [in]  Name of the user initiating the request.  =item   $user      - string [in]  Name of the user initiating the request.
Line 695  sub Copy1 { Line 695  sub Copy1 {
  if ($newfilename =~ m|/[^\.]+$|) {   if ($newfilename =~ m|/[^\.]+$|) {
     #no extension add on original extension      #no extension add on original extension
     if ($fn =~ m|/[^\.]*\.([^\.]+)$|) { $newfilename.='.'.$1; }      if ($fn =~ m|/[^\.]*\.([^\.]+)$|) { $newfilename.='.'.$1; }
  }    }
  $newfilename=~s://+:/:g; # remove duplicate /   $newfilename=~s://+:/:g; # remove duplicate /
  while ($newfilename=~m:/\.\./:) {   while ($newfilename=~m:/\.\./:) {
     $newfilename=~ s:/[^/]+/\.\./:/:g; #remove dir/..      $newfilename=~ s:/[^/]+/\.\./:/:g; #remove dir/..
Line 740  sub Copy1 { Line 740  sub Copy1 {
 =pod  =pod
   
 =item NewDir1  =item NewDir1
    
   Does all phase 1 processing of directory creation:    Does all phase 1 processing of directory creation:
   Ensures that the user provides a new directory name,    Ensures that the user provides a new directory name,
   and that the directory does not already exist.    and that the directory does not already exist.
Line 758  Parameters: Line 758  Parameters:
   
 =item   $fn     - source file.  =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.                 top level of construction space.
 =back  =back
   
Line 822  sub Decompress1 { Line 822  sub Decompress1 {
 =pod  =pod
   
 =item NewFile1  =item NewFile1
    
   Does all phase 1 processing of file creation:    Does all phase 1 processing of file creation:
   Ensures that the user provides a new filename, adds proper extension    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,    if needed and that the file does not already exist, if it is a html,
Line 938  sub filename_check { Line 938  sub filename_check {
                   ' '.&mt('Not Allowed').'</span>');                    ' '.&mt('Not Allowed').'</span>');
         return;          return;
     }      }
     return 'ok';       return 'ok';
 }  }
   
 =pod  =pod
Line 949  sub filename_check { Line 949  sub filename_check {
 are returned if the request cannot be performed (e.g. attempts to manipulate  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  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  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.  performed and reported to the user.
   
  Parameters:   Parameters:
Line 958  performed and reported to the user. Line 958  performed and reported to the user.
   
 =item $r  - request object [in] - The Apache request being executed.  =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.                               request.
   
 =item $uname - string [in] Name of user logged in and doing this action.  =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  =back
   
Line 971  performed and reported to the user. Line 971  performed and reported to the user.
   
 sub phaseone {  sub phaseone {
     my ($r,$fn,$uname,$udom)=@_;      my ($r,$fn,$uname,$udom)=@_;
     
     my $doingdir=0;      my $doingdir=0;
     if ($env{'form.action'} eq 'newdir') { $doingdir=1; }      if ($env{'form.action'} eq 'newdir') { $doingdir=1; }
     my ($newfilename,$error,$warnings) =       my ($newfilename,$error,$warnings) =
         &cleanDest($env{'form.newfilename'},$doingdir,$fn,$uname,$udom);          &cleanDest($env{'form.newfilename'},$doingdir,$fn,$uname,$udom);
     unless ($error) {      unless ($error) {
         ($newfilename,$error)=&relativeDest($fn,$newfilename,$uname,$udom);          ($newfilename,$error)=&relativeDest($fn,$newfilename,$uname,$udom);
Line 984  sub phaseone { Line 984  sub phaseone {
         if ($fn=~m{^(.*/)[^/]+$}) {          if ($fn=~m{^(.*/)[^/]+$}) {
             $dirlist=$1;              $dirlist=$1;
         } else {          } else {
             $dirlist=$fn;               $dirlist=$fn;
         }          }
         if ($warnings) {          if ($warnings) {
             $r->print($warnings);              $r->print($warnings);
Line 1029  sub phaseone { Line 1029  sub phaseone {
     &Rename1($r, $uname, $udom, $fn, $newfilename, 'rename');      &Rename1($r, $uname, $udom, $fn, $newfilename, 'rename');
         } elsif ($env{'form.action'} eq 'move') {          } elsif ($env{'form.action'} eq 'move') {
     &Rename1($r, $uname, $udom, $fn, $newfilename, 'move');      &Rename1($r, $uname, $udom, $fn, $newfilename, 'move');
         } elsif ($env{'form.action'} eq 'delete') {           } elsif ($env{'form.action'} eq 'delete') {
     &Delete1($r, $uname, $udom, $fn);      &Delete1($r, $uname, $udom, $fn);
         } elsif ($env{'form.action'} eq 'decompress') {          } elsif ($env{'form.action'} eq 'decompress') {
     &Decompress1($r, $uname, $udom, $fn);      &Decompress1($r, $uname, $udom, $fn);
         } elsif ($env{'form.action'} eq 'copy') {           } elsif ($env{'form.action'} eq 'copy') {
     if ($newfilename) {      if ($newfilename) {
         &Copy1($r, $uname, $udom, $fn, $newfilename);          &Copy1($r, $uname, $udom, $fn, $newfilename);
     } else {      } else {
Line 1103  sub Rename2 { Line 1103  sub Rename2 {
     return 0;      return 0;
  }   }
  ## If old name.(extension) exits, move under new name.   ## 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)   ## delete it (only concern when renaming over files)
  my $tmp1=$oRN.'.meta';   my $tmp1=$oRN.'.meta';
  my $tmp2=$nRN.'.meta';   my $tmp2=$nRN.'.meta';
Line 1149  sub Rename2 { Line 1149  sub Rename2 {
   
 =item Delete2($request, $user, $filename)  =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  to delete the selected file.   The file is deleted and the results of the
 delete attempt are indicated.  delete attempt are indicated.
   
Line 1176  Returns: Line 1176  Returns:
   
 sub Delete2 {  sub Delete2 {
     my ($request, $user, $filename) = @_;      my ($request, $user, $filename) = @_;
     if (-d $filename) {       if (-d $filename) {
  unless (&empty_directory($filename,'Delete2')) {    unless (&empty_directory($filename,'Delete2')) {
     $request->print('<span class="LC_error">'.&mt('Error: Directory Non Empty').'</span>');       $request->print('<span class="LC_error">'.&mt('Error: Directory Non Empty').'</span>');
     return 0;      return 0;
  } else {      } else {
     if(-e $filename) {      if(-e $filename) {
  unless(rmdir($filename)) {   unless(rmdir($filename)) {
     $request->print('<span class="LC_error">'.&mt('Error').': '.$!.'</span>');      $request->print('<span class="LC_error">'.&mt('Error').': '.$!.'</span>');
Line 1209  sub Delete2 { Line 1209  sub Delete2 {
   
 =item Copy2($request, $username, $dir, $oldfile, $newfile)  =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.     of that copy is reported back to the user.
   
 =over 4  =over 4
Line 1247  sub Copy2 { Line 1247  sub Copy2 {
  } elsif (!chmod(0660, $newfile)) {   } elsif (!chmod(0660, $newfile)) {
     $request->print('<span class="LC_error">'.&mt('chmod error').': '.$!.'</span>');      $request->print('<span class="LC_error">'.&mt('chmod error').': '.$!.'</span>');
     return 0;      return 0;
  } elsif (-e $oldfile.'.meta' &&    } elsif (-e $oldfile.'.meta' &&
  !copy($oldfile.'.meta', $newfile.'.meta') &&   !copy($oldfile.'.meta', $newfile.'.meta') &&
  !chmod(0660, $newfile.'.meta')) {   !chmod(0660, $newfile.'.meta')) {
     $request->print('<span class="LC_error">'.&mt('copy metadata error').      $request->print('<span class="LC_error">'.&mt('copy metadata error').
Line 1287  Returns 0 - failure 1 - success. Line 1287  Returns 0 - failure 1 - success.
   
 sub NewDir2 {  sub NewDir2 {
     my ($request, $user, $newdirectory) = @_;      my ($request, $user, $newdirectory) = @_;
     
     unless(mkdir($newdirectory, 02770)) {      unless(mkdir($newdirectory, 02770)) {
  $request->print('<span class="LC_error">'.&mt('Error').': '.$!.'</span>');   $request->print('<span class="LC_error">'.&mt('Error').': '.$!.'</span>');
  return 0;   return 0;
Line 1320  sub decompress2 { Line 1320  sub decompress2 {
    is performed and the result is shown.     is performed and the result is shown.
   
   The strategy is to break out the processing into specific action processors    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.    phase 2 processing.
   
 Parameters:  Parameters:
Line 1344  Parameters: Line 1344  Parameters:
   
 sub phasetwo {  sub phasetwo {
     my ($r,$fn,$uname,$udom)=@_;      my ($r,$fn,$uname,$udom)=@_;
       
     &Debug($r, "loncfile - Entering phase 2 for $fn");      &Debug($r, "loncfile - Entering phase 2 for $fn");
       
     # Break down the file into its component pieces.      # Break down the file into its component pieces.
       
     my $dir; # Directory path      my $dir; # Directory path
     my $main; # Filename.      my $main; # Filename.
     my $suffix; # Extension.      my $suffix; # Extension.
Line 1368  sub phasetwo { Line 1368  sub phasetwo {
     &Debug($r,"    newfilename = ".$env{'form.newfilename'});      &Debug($r,"    newfilename = ".$env{'form.newfilename'});
   
     my $conspace=$fn;      my $conspace=$fn;
       
     &Debug($r,"loncfile::phase2 Full construction space name: $conspace");      &Debug($r,"loncfile::phase2 Full construction space name: $conspace");
       
     &Debug($r,"loncfie::phase2 action is $env{'form.action'}");      &Debug($r,"loncfie::phase2 action is $env{'form.action'}");
       
     # Select the appropriate processing sub.      # Select the appropriate processing sub.
     if ($env{'form.action'} eq 'decompress') {       if ($env{'form.action'} eq 'decompress') {
  $main .= '.'.$suffix;   $main .= '.'.$suffix;
  if(!&decompress2($r, $uname, $dir, $main)) {   if(!&decompress2($r, $uname, $dir, $main)) {
     return ;      return ;
Line 1385  sub phasetwo { Line 1385  sub phasetwo {
  if($env{'form.newfilename'}) {   if($env{'form.newfilename'}) {
     if (!defined($dir)) {      if (!defined($dir)) {
  $fn=~m:^(.*)/:;   $fn=~m:^(.*)/:;
  $dir=$1;    $dir=$1;
     }      }
     if(!&Rename2($r, $uname, $dir, $fn, $env{'form.newfilename'})) {      if(!&Rename2($r, $uname, $dir, $fn, $env{'form.newfilename'})) {
  return;   return;
Line 1396  sub phasetwo { Line 1396  sub phasetwo {
     $disp_newname = $1;      $disp_newname = $1;
     $disp_newname =~ s/\///;      $disp_newname =~ s/\///;
  }   }
     } elsif ($env{'form.action'} eq 'delete') {       } elsif ($env{'form.action'} eq 'delete') {
  if(!&Delete2($r, $uname, $env{'form.newfilename'})) {   if(!&Delete2($r, $uname, $env{'form.newfilename'})) {
     return ;      return ;
  }   }
Line 1404  sub phasetwo { Line 1404  sub phasetwo {
  # previously held it.   # previously held it.
  #   #
  $dest = $dir."/."; # Parent dir.   $dest = $dir."/."; # Parent dir.
     } elsif ($env{'form.action'} eq 'copy') {       } elsif ($env{'form.action'} eq 'copy') {
  if($env{'form.newfilename'}) {   if($env{'form.newfilename'}) {
     if(!&Copy2($r, $uname, $dir, $fn, $env{'form.newfilename'})) {      if(!&Copy2($r, $uname, $dir, $fn, $env{'form.newfilename'})) {
  return ;   return ;
Line 1462  sub handler { Line 1462  sub handler {
  &Debug($r, "test: $env{'form.filename'}");   &Debug($r, "test: $env{'form.filename'}");
  $fn=&unescape($env{'form.filename'});   $fn=&unescape($env{'form.filename'});
  $fn=&URLToPath($fn);   $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   #Just hijack the script only the first time around to inject the
  #correct information for further processing   #correct information for further processing
  $fn=&unescape($env{'form.decompress'});   $fn=&unescape($env{'form.decompress'});
Line 1473  sub handler { Line 1473  sub handler {
     } else {      } else {
  &Debug($r, "loncfile::handler - no form.filename");   &Debug($r, "loncfile::handler - no form.filename");
  $r->log_reason($env{'user.name'}.' at '.$env{'user.domain'}.   $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;   return HTTP_NOT_FOUND;
     }      }
   
     unless ($fn) {      unless ($fn) {
  &Debug($r, "loncfile::handler - doctored url is empty");   &Debug($r, "loncfile::handler - doctored url is empty");
  $r->log_reason($env{'user.name'}.' at '.$env{'user.domain'}.   $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;   return HTTP_NOT_FOUND;
     }       }
   
 # ----------------------------------------------------------- Start page output  # ----------------------------------------------------------- Start page output
   
     my ($uname,$udom) = &Apache::lonnet::constructaccess($fn);      my ($uname,$udom) = &Apache::lonnet::constructaccess($fn);
     &Debug($r,       &Debug($r,
    "loncfile::handler constructaccess uname = $uname domain = $udom");     "loncfile::handler constructaccess uname = $uname domain = $udom");
     if (($uname eq '') || ($udom eq '')) {      if (($uname eq '') || ($udom eq '')) {
  $r->log_reason($uname.' at '.$udom.   $r->log_reason($uname.' at '.$udom.
        ' trying to manipulate file '.$env{'form.filename'}.         ' trying to manipulate file '.$env{'form.filename'}.
        ' ('.$fn.') - not authorized',          ' ('.$fn.') - not authorized',
        $r->filename);          $r->filename);
  return HTTP_NOT_ACCEPTABLE;   return HTTP_NOT_ACCEPTABLE;
     }      }
   
Line 1553  function writeDone() { Line 1553  function writeDone() {
              .&Apache::loncommon::head_subbox(               .&Apache::loncommon::head_subbox(
                   &Apache::loncommon::CSTR_pageheader($trailfile))                    &Apache::loncommon::CSTR_pageheader($trailfile))
     );      );
     
     $r->print('<p>'.&mt('Location').': '.&display($fn).'</p>');      $r->print('<p>'.&mt('Location').': '.&display($fn).'</p>');
     
     if (($uname ne $env{'user.name'}) || ($udom ne $env{'user.domain'})) {      if (($uname ne $env{'user.name'}) || ($udom ne $env{'user.domain'})) {
         unless ($crsauthor) {            unless ($crsauthor) {
             $r->print('<p class="LC_info">'              $r->print('<p class="LC_info">'
                      .&mt('Co-Author [_1]',$uname.':'.$udom)                       .&mt('Co-Author [_1]',$uname.':'.$udom)
                      .'</p>'                       .'</p>'
Line 1624  function writeDone() { Line 1624  function writeDone() {
     }      }
   
     $r->print(&Apache::loncommon::end_page());      $r->print(&Apache::loncommon::end_page());
     return OK;        return OK;
 }  }
   
 1;  1;
Removed from v.1.126  
changed lines
  Added in v.1.127

FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>