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

Diff for /loncom/publisher/loncfile.pm between versions 1.10 and 1.52

version 1.10, 2002/05/27 03:18:46 version 1.52, 2004/03/02 16:48:27
Line 8 Line 8
 #  and requests confirmation.  The second phase commits the action  #  and requests confirmation.  The second phase commits the action
 #  and displays a page showing the results of the action.  #  and displays a page showing the results of the action.
 #  #
   
 #  #
 # $Id$  # $Id$
 #  #
Line 34 Line 33
 #  #
 # http://www.lon-capa.org/  # http://www.lon-capa.org/
 #  #
 #  =pod
 # (Handler to retrieve an old version of a file  
 #  =head1 NAME
 # (Publication Handler  
 #   Apache::loncfile - Construction space file management.
 # (TeX Content Handler  
 #  =head1 SYNOPSIS
 # 05/29/00,05/30,10/11 Gerd Kortemeyer)   
 #   Content handler for buttons on the top frame of the construction space 
 # 11/28,11/29,11/30,12/01,12/02,12/04,12/23 Gerd Kortemeyer  directory.
 # 03/23 Guy Albertelli  
 # 03/24,03/29 Gerd Kortemeyer)  =head1 INTRODUCTION
 #  
 # 03/31,04/03,05/02,05/09,06/23,06/24 Gerd Kortemeyer)    loncfile is invoked when buttons in the top frame of the construction 
 #  space directory listing are clicked.   All operations proceed in two phases.
 # 06/23 Gerd Kortemeyer  The first phase describes to the user exactly what will be done.  If the user
 # 05/07/02 Ron Fox:  confirms the operation, the second phase commits the operation and indicates
 #           - Added Debug log output so that I can trace what the heck this  completion.  When the user dismisses the output of phase2, they are returned to
 #             undocumented thingy does.  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;  package Apache::loncfile;
   
 use strict;  use strict;
 use Apache::File;  use Apache::File;
   use File::Basename;
 use File::Copy;  use File::Copy;
   use HTML::Entities();
 use Apache::Constants qw(:common :http :methods);  use Apache::Constants qw(:common :http :methods);
 use Apache::loncacc;  use Apache::loncacc;
 use Apache::Log ();  use Apache::Log ();
   use Apache::lonnet;
   use Apache::loncommon();
   use Apache::lonlocal;
   
 my $DEBUG=0;  my $DEBUG=0;
 my $r; # Needs to be global for some stuff RF.  my $r; # Needs to be global for some stuff RF.
 #  
 #  Debug  =pod
 #    If debugging is enabled puts out a debuggin message determined by the  
 #    caller.  The debug message goes to the Apache error log file.  =item Debug($request, $message)
 #  
 #  Parameters:    If debugging is enabled puts out a debugging message determined by the
 #     r       - Apache request [in]    caller.  The debug message goes to the Apache error log file. Debugging
 #     message - String [in]     is enabled by setting the module global DEBUG variable to nonzero (TRUE).
 # Returns:  
 #    nothing.   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 {  sub Debug {
     my $r       = shift;    
     my $log     = $r->log;    # Marshall the parameters.
     my $message = shift;    
     if ($DEBUG) {    my $r       = shift;
  $log->debug($message);        my $log     = $r->log;
     }    my $message = shift;
     
     # Put out the indicated message butonly if DEBUG is true.
     
     if ($DEBUG) {
     $r->log_reason($message);
     }
 }  }
 #  
 #   URLToPath  =pod
 #     Convert a URL to a file system path.  
 #  =item URLToPath($url)
 #   In order to manipulate the construction space objects, it's necessary  
 #   to access url identified objects a filespace objects.  This function    Convert a URL to a file system path.
 #   translates a construction space URL to a file system path.    
 # Parameters:    In order to manipulate the construction space objects, it is necessary
 #    Url    - string [in] The url to convert.    to access url identified objects a filespace objects.  This function
 # Returns:    translates a construction space URL to a file system path.
 #    The corresponing file system path.   Parameters:
 sub URLToPath  
 {  =over 4
     my $Url = shift;  
     &Debug($r, "UrlToPath got: $Url");  =item  Url    - string [in] The url to convert.
     $Url=~ s/^http\:\/\/[^\/]+\/\~(\w+)/\/home\/$1\/public_html/;    
     $Url=~ s/^http\:\/\/[^\/]+//;  =back
     &Debug($r, "Returning $Url \n");    
     return $Url;   Returns:
   
   =over 4
   
   =item  The corresponding file system path. 
   
   =back
   
   Global References
   
   =over 4
   
   =item  $r      - Request object [in] Referenced in the &Debug calls.
   
   =back
   
   =cut
   
   sub URLToPath {
     my $Url = shift;
     &Debug($r, "UrlToPath got: $Url");
     $Url=~ s/\/+/\//g;
     $Url=~ s/^http\:\/\/[^\/]+//;
     $Url=~ s/^\///;
     $Url=~ s/(\~|priv\/)(\w+)\//\/home\/$2\/public_html\//;
     &Debug($r, "Returning $Url \n");
     return $Url;
 }  }
 sub exists {  
     my ($uname,$udom,$dir,$newfile)=@_;  sub url {
     my $published='/home/httpd/html/res/'.$udom.'/'.$uname.'/'.$dir.'/'.      my $fn=shift;
  $ENV{'form.newfilename'};      $fn=~s/^\/home\/(\w+)\/public\_html/\/priv\/$1/;
     my $construct='/home/'.$uname.'/public_html/'.$dir.'/'.      return $fn;
  $ENV{'form.newfilename'};  }
     my $result;  
   sub display {
       my $fn=shift;
       $fn=~s-^/home/(\w+)/public_html-/priv/$1-;
       return '<tt>'.$fn.'</tt>';
   }
   
   
   # see if the file is
   # a) published (return 0 if not)
   # b) if, so obsolete (return 0 if not)
   
   sub obsolete_unpub {
       my ($user,$domain,$construct)=@_;
       my $published=$construct;
       $published=~
    s/^\/home\/$user\/public\_html\//\/home\/httpd\/html\/res\/$domain\/$user\//;
     if (-e $published) {      if (-e $published) {
  $result.='<p><font color=red>Warning: target file exists, and has been published!</font></p>';   if (&Apache::lonnet::metadata($published,'obsolete')) {
     } elsif ( -e $construct ) {      return 1;
  $result.='<p><font color=red>Warning: target file exists!</font></p>';   }
    return 0;
       } else {
    return 1;
     }      }
     return $result;  
 }  }
   
   
   
   =pod
   
   =item exists($user, $domain, $file)
   
      Determine if a resource file name has been published or exists
      in the construction space.
   
    Parameters:
   
   =over 4
   
   =item  $user   - string [in] - Name of the user for which to check.
   
   =item  $domain - string [in] - Name of the domain in which the resource
                             might have been published.
   
   =item  $file   - string [in] - Name of the file.
   
   =back
   
   Returns:
   
   =over 4
   
   =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
   
   sub exists {
     my ($user, $domain, $construct) = @_;
     my $published=$construct;
     $published=~
   s/^\/home\/$user\/public\_html\//\/home\/httpd\/html\/res\/$domain\/$user\//;
     my $result='';    
     if ( -d $construct ) {
         return &mt('Error: destination for operation is an existing directory.');
     }
     if ( -e $published) {
         $result.='<p><font color="red">'.&mt('Warning: target file exists, and has been published!').'</font></p>';
     } elsif ( -e $construct) {
         $result.='<p><font color="red">'.&mt('Warning: target file exists!').'</font></p>';
     }
     return $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 {  sub checksuffix {
     my ($old,$new) = @_;      my ($old,$new) = @_;
     my $result;      my $result;
Line 126  sub checksuffix { Line 282  sub checksuffix {
     if ($new=~m:(.*/*)([^/]+)\.(\w+)$:) { $newsuffix=$3; }      if ($new=~m:(.*/*)([^/]+)\.(\w+)$:) { $newsuffix=$3; }
     if ($old=~m:(.*)/+([^/]+)\.(\w+)$:) { $oldsuffix=$3; }      if ($old=~m:(.*)/+([^/]+)\.(\w+)$:) { $oldsuffix=$3; }
     if ($oldsuffix ne $newsuffix) {      if ($oldsuffix ne $newsuffix) {
  $result.='<p><font color=red>Warning: change of MIME type!</font></p>';   $result.=
               '<p><font color="red">'.&mt('Warning: change of MIME type!').'</font></p>';
     }      }
     return $result;      return $result;
 }  }
   
 sub phaseone {  sub cleanDest {
     my ($r,$fn,$uname,$udom)=@_;      my ($request,$dest)=@_;
       #remove bad characters
       if  ($dest=~/[\#\?&]/) {
    $request->print("<p><font color=\"red\">".&mt('Invalid characters in requested name have been removed.')."</font></p>");
    $dest=~s/[\#\?&]//g;
       }
       return $dest;
   }
   
     $fn=~m:(.*)/([^/]+)\.(\w+)$:;  sub relativeDest {
     my $dir=$1;      my ($fn,$newfilename,$uname)=@_;
     my $main=$2;      if ($newfilename=~/^\//) {
     my $suffix=$3;  # absolute, simply add path
    $newfilename='/home/'.$uname.'/public_html/';
     my $conspace='/home/'.$uname.'/public_html'.$fn;      } else {
    my $dir=$fn;
     $r->print('<form action=/adm/cfile method=post>'.   $dir=~s/\/[^\/]+$//;
       '<input type=hidden name=filename value="/~'.$uname.$fn.'">'.   $newfilename=$dir.'/'.$newfilename;
               '<input type=hidden name=phase value=two>'.      }
               '<input type=hidden name=action value='.$ENV{'form.action'}.'>');      $newfilename=~s://+:/:g; # remove duplicate /
       while ($newfilename=~m:/\.\./:) {
     if ($ENV{'form.action'} eq 'rename') {   $newfilename=~ s:/[^/]+/\.\./:/:g; #remove dir/..
  if (-e $conspace) {      }
     if ($ENV{'form.newfilename'}) {      return $newfilename;
  $r->print(&checksuffix($fn,$ENV{'form.newfilename'}));  }
  $r->print(&exists($uname,$udom,$dir,$ENV{'form.newfilename'}));  
        $r->print('<input type=hidden name=newfilename value="'.  =pod
                          $ENV{'form.newfilename'}.  
                          '"><p>Rename <tt>'.$fn.'</tt> to <tt>'.  =item CloseForm1($request, $user, $file)
                          $dir.'/'.$ENV{'form.newfilename'}.'</tt>?</p>');  
     } else {     Close of a form on the successful completion of phase 1 processing
        $r->print('<p>No new filename specified.</p></form>');  
                return;  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('<p><input type="submit" value="'.&mt('Continue').'" /></p></form>');
      $request->print('<form action="'.&url($fn).
        '" method="POST"><p><input type="submit" value="'.&mt('Cancel').'" /></p></form>');
   }
   
   
   =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('<h3><a href="'.&url($fn).'/">'.&mt('Done').'</a></h3>');
   }
   
   =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; }
    }
     }      }
         } else {      if ($newfilename =~ m|/[^\.]+$|) {
     $r->print('<p>No such file.</p></form>');   #no extension add on original extension
             return;   if ($fn =~ m|/[^\.]*\.([^\.]+)$|) {
         }      $newfilename.='.'.$1;
     } elsif ($ENV{'form.action'} eq 'delete') {    }
  if (-e $conspace) {      }
             $r->print('<p>Delete <tt>'.$fn.'</tt>?</p>');      $request->print(&checksuffix($fn, $newfilename));
         } else {      #renaming a dir, delete the trailing /
     $r->print('<p>No such file.</p></form>');              #remove second to last element for current dir
             return;      if (-d $fn) {
         }   $newfilename=~s/\/[^\/]+\/([^\/]+)$/\/$1/;
     } elsif ($ENV{'form.action'} eq 'copy') {       }
  if (-e $conspace) {      $newfilename=~s://+:/:g; # remove duplicate /
     if ($ENV{'form.newfilename'}) {      while ($newfilename=~m:/\.\./:) {
  $r->print(&checksuffix($fn,$ENV{'form.newfilename'}));   $newfilename=~ s:/[^/]+/\.\./:/:g; #remove dir/..
  $r->print(&exists($uname,$udom,$dir,$ENV{'form.newfilename'}));      }
        $r->print('<input type=hidden name=newfilename value="'.      my $return=&exists($user, $domain, $newfilename);
                          $ENV{'form.newfilename'}.      $request->print($return);
                          '"><p>Copy <tt>'.$fn.'</tt> to <tt>'.      if ($return =~/^Error:/) {
                          $dir.'/'.$ENV{'form.newfilename'}.'</tt>?</p>');   $request->print('<br /><a href="'.&url($fn).'">'.&mt('Cancel').'</a>');
    return;
       }
       unless (&obsolete_unpub($user,$domain,$fn)) {
    $request->print('<h3>'.&mt('Cannot rename or move non-obsolete published file').'</h3>'.
    '<br /><a href="'.&url($fn).'">'.&mt('Cancel').'</a>');
    return;
       }
       my $action;
       if ($style eq 'rename') {
    $action=&mt('Rename');
     } else {      } else {
        $r->print('<p>No new filename specified.</p></form>');   $action=&mt('Move');
                return;  
     }      }
         } else {      $request->print('<input type="hidden" name="newfilename" value="'.
     $r->print('<p>No such file.</p></form>');      $newfilename.
             return;      '" /><p>'.$action.' '.&display($fn).
         }      '</tt><br />to '.&display($newfilename).'?</p>');
     } elsif ($ENV{'form.action'} eq 'newdir') {      &CloseForm1($request, $fn);
         my $newdir='/home/'.$uname.'/public_html/'.   } else {
                    $fn.$ENV{'form.newfilename'};      $request->print('<p>'.&mt('No new filename specified.').'</p></form>');
  if (-e $newdir) {      return;
             $r->print('<p>Directory exists.</p></form>');   }
             return;      } else {
         }   $request->print('<p> '.&mt('No such file').': '.&display($fn).'</p></form>');
  $r->print('<input type=hidden name=newfilename value="'.   return;
                   $ENV{'form.newfilename'}.      }
                   '"><p>Make new directory <tt>'.      
                   $fn.$ENV{'form.newfilename'}.'</tt>?</p>');  }
          =pod
     }  
     $r->print('<p><input type=submit value=Continue></p></form>');  =item Delete1
     $r->print('<form action="/priv/'.$uname.$fn.  
       '" method="GET"><p><input type=submit value=Cancel></p></form>');     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('<input type="hidden" name="newfilename" value="'.
       $fn.'"/>');
       unless (&obsolete_unpub($user,$domain,$fn)) {
    $request->print('<h3>'.&mt('Cannot delete non-obsolete published file').'</h3>'.
    '<br /><a href="'.&url($fn).'">'.&mt('Cancel').'</a>');
    return;
       }
       $request->print('<p>'.&mt('Delete').' '.&display($fn).'?</p>');
       &CloseForm1($request, $fn);
     } else {
       $request->print('<p>'.&mt('No such file').': '.&display($fn).'</p></form>');
     }
 }  }
   
 sub phasetwo {  =pod
     my ($r,$fn,$uname,$udom)=@_;  
   
     &Debug($r, "loncfile - Entering phase 2 for $fn");  =item Copy1($request, $user, $domain, $filename, $newfilename)
   
     $fn=~/(.*)\/([^\/]+)\.(\w+)$/;     Performs phase 1 processing of the construction space copy command.
     my $dir=$1;     Ensure that the source file exists.  Ensure that a destination exists,
     my $main=$2;     also warn if the destination already exists.
     my $suffix=$3;  
       Parameters:
       
     &Debug($r, "loncfile::phase2 dir = $dir main = $main suffix = $suffix");  =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 $return=&exists($user, $domain, $newfilename);
    $request->print($return);
    if ($return =~/^Error:/) {
       $request->print('<br /><a href="'.&url($fn).'">'.&mt('Cancel').'</a>');
       return;
    }
    $request->print('<input type="hidden" name="newfilename" value="'.
    $newfilename.
    '" /><p>'.&mt('Copy').' '.&display($fn).'<br />to '.
    &display($newfilename).'?</p>');
    &CloseForm1($request, $fn);
       } else {
    $request->print('<p>'.&mt('No such file').': '.&display($fn).'</p></form>');
       }
   }
   
     my $conspace=$fn;  =pod
   
     &Debug($r, "loncfile::phase2 Full construction space name: $conspace");  =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.
   
     &Debug($r, "loncfie::phase2 action is $ENV{'form.action'}");  Parameters:
   
     if ($ENV{'form.action'} eq 'rename') {  =over 4
  if (-e $conspace) {  
     if ($ENV{'form.newfilename'}) {  =item   $request  - Apache Request Object [in] - Server request object for the
                unless (rename('/home/'.$uname.'/public_html'.$fn,                 current url.
           '/home/'.$uname.'/public_html'.$dir.'/'.$ENV{'form.newfilename'})) {  
     $r->print('<font color=red>Error: '.$!.'</font>');  =item   $username - Name of the user that is requesting the directory creation.
                }  
             }  =item $domain - Domain user is in
         } else {  
     $r->print('<p>No such file.</form>');  =item   $fn     - source file.
             return;  
         }  =item   $newdir   - Name of the directory to be created; path relative to the 
     } elsif ($ENV{'form.action'} eq 'delete') {                  top level of construction space.
  if (-e $conspace) {  =back
             unless (unlink('/home/'.$uname.'/public_html'.$fn)) {  
        $r->print('<font color=red>Error: '.$!.'</font>');  Side Effects:
             }  
         } else {  =over 4
     $r->print('<p>No such file.</form>');  
             return;  =item A new form is displayed.  Clicking on the confirmation button
         }  causes the newdir operation to transition into phase 2.  The hidden field
     } elsif ($ENV{'form.action'} eq 'copy') {   "newfilename" is set with the construction space path to the new directory.
  if (-e $conspace) {  
     if ($ENV{'form.newfilename'}) {  
                unless (copy('/home/'.$uname.'/public_html'.$fn,  =back
            '/home/'.$uname.'/public_html'.$dir.'/'.$ENV{'form.newfilename'})) {  
           $r->print('<font color=red>Error: '.$!.'</font>');  =cut
                }  
     } else {  
        $r->print('<p>No new filename specified.</form>');  sub NewDir1
                return;  {
     my ($request, $username, $domain, $fn, $newfilename, $mode) = @_;
   
     my $result=&exists($username,$domain,$newfilename);
     if ($result) {
       $request->print('<font color="red">'.$result.'</font></form>');
     } else {
       if ($mode eq 'testbank') {
           $request->print('<input type="hidden" name="callingmode" value="testbank">');
       } elsif ($mode eq 'imsimport') {
           $request->print('<input type="hidden" name="callingmode" value="imsimport">');
       }
       $request->print('<input type="hidden" name="newfilename" value="'.
       $newfilename.'" /><p>'.&mt('Make new directory').' '.
       &display($newfilename).'?</p>');
       &CloseForm1($request, $fn);
     }
   }
   
   
   sub Decompress1 {
      my ($request, $user, $domain, $fn) = @_;
      if( -e $fn) {
       $request->print('<input type="hidden" name="newfilename" value="'.$fn.'"/>');
       $request->print('<p>'.&mt('Decompress').' '.&display($fn).'?</p>');
       &CloseForm1($request, $fn);
       } else {
           $request->print('<p>'.&mt('No such file').': '.&display($fn).'</p></form>');
          }
   }
   =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,
     problem, page, or sequence, it then creates a form link to hand the
     actual creation off to the proper handler.
   
   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   - Name of the domain of the user
   
   =item   $fn      - Source file name
   
   =item   $newfilename
                     - Name of the file to be created; no path information
   =back
   
   Side Effects:
   
   =over 4
   
   =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
   
   =back
   
   =cut
   
   
   sub NewFile1 {
       my ($request, $user, $domain, $fn, $newfilename) = @_;
   
       if ($ENV{'form.action'} =~ /new(.+)file/) {
    my $extension=$1;
   
           ##Informs User (name).(number).(extension) not allowed 
    if($newfilename =~ /\.(\d+)\.(\w+)$/){
       $r->print('<font color="red">'.$newfilename.
         ' - '.&mt('Bad Filename').'<br />('.&mt('name').').('.&mt('number').').('.&mt('extension').')'.
         ' '.&mt('Not Allowed').'</font>');
       return;
    }
    if ($newfilename !~ /\Q.$extension\E$/) {
       if ($newfilename =~ m|^[^\.]*\.([^\.]+)$|) {
    #already has an extension strip it and add in expected one
    $newfilename =~ s|.([^\.]+)$||;
     }      }
         } else {      $newfilename.=".$extension";
     $r->print('<p>No such file.</form>');   }
             return;      }
         }      my $result=&exists($user,$domain,$newfilename);
     } elsif ($ENV{'form.action'} eq 'newdir') {      if($result) {
         my $newdir= $fn.$ENV{'form.newfilename'};   $request->print('<font color="red">'.$result.'</font></form>');
       } else {
    $request->print('<p>'.&mt('Make new file').' '.&display($newfilename).'?</p>');
    $request->print('</form>');
    $request->print('<form action="'.&url($newfilename).
    '" method="POST"><p><input type="submit" value="'.&mt('Continue').'" /></p></form>');
    $request->print('<form action="'.&url($fn).
    '" method="POST"><p><input type="submit" value="'.&mt('Cancel').'" /></p></form>');
       }
   }
   
   =pod
   
   =item phaseone($r, $fn, $uname, $udom)
   
     Peforms phase one processing of the request.  In phase one, error messages
   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 
   performed and reported to the user.
   
    Parameters:
   
   =over 4
   
   =item $r  - request object [in] - The Apache request being executed.
   
   =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. 
   
   =back
   
   =cut
   
   sub phaseone {
     my ($r,$fn,$uname,$udom)=@_;
     
     my $newfilename=&cleanDest($r,$ENV{'form.newfilename'});
     $newfilename=&relativeDest($fn,$newfilename,$uname);
     $r->print('<form action="/adm/cfile" method="post">'.
         '<input type="hidden" name="qualifiedfilename" value="'.$fn.'" />'.
         '<input type="hidden" name="phase" value="two" />'.
         '<input type="hidden" name="action" value="'.$ENV{'form.action'}.'" />');
     
     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('<p>'.&mt('No new filename specified.').'</p></form>');
         }
     } 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 'Select Action') {
         if ($newfilename) {
     &NewFile1($r, $uname, $udom, $fn, $newfilename);
         } else {
     $r->print('<p>'.&mt('No new filename specified.').'</p></form>');
         }
     }
   }
   
   =pod
   
   =item Rename2($request, $user, $directory, $oldfile, $newfile)
   
   Performs phase 2 processing of a rename reequest.   This is where the
   actual rename is performed.
   
  &Debug($r, "loncfile::phasetwo - new directory name: $newdir");  Parameters
   
         unless (mkdir($newdir,0770)) {  =over 4
     $r->print('<font color=red>Error: '.$!.'</font>');  
     &Debug($r, "loncfile::phasetwo - mkdir failed $!");  =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('<font color="red">'.&mt('Error').': '.$!.'</font>');
     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("<p> ".&mt('No such file').": ".&display($oldfile).'</p></form>');
         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(opendir DIR, $filename) { 
       my @files=readdir(DIR);
       shift @files; shift @files; # takes off . and ..
       if(@files) { 
         $request->print('<font color="red"> '.&mt('Error: Directory Non Empty').'</font>'); 
         return 0;
       } else {   
         if(-e $filename) {
           unless(rmdir($filename)) {
             $request->print('<font color="red">'.&mt('Error').': '.$!.'</font>');
             return 0;
         }          }
  &Debug($r, "Done button: uname = $uname, dir = $dir, fn = $fn");        } else {
  my $url = '/priv/'.$uname.$newdir.'/';          $request->print('<p> '.&mt('No such file').'. </p></form>');
  &Debug($r, "URL[1] = ".$url);          return 0;
  $url =~ s/\/home\/$uname\/public_html//o;        }
         &Debug($r, "URL = ".$url);       }
      } else {
       if(-e $filename) {
         unless(unlink($filename)) {
           $request->print('<font color="red">'.&mt('Error').': '.$!.'</font>');
           return 0;
         }
       } else {
         $request->print('<p> '.&mt('No such file').'. </p></form>');
         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.
   
         $r->print('<h3><a href="'.$url.'">Done</a></h3>');  =item $username - string [in] Name of the user who is requesting the copy.
         return;  
   =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 0 successs.
   
   =cut
   
   sub Copy2 {
       my ($request, $username, $dir, $oldfile, $newfile) = @_;
       &Debug($request ,"Will try to copy $oldfile to $newfile");
       if(-e $oldfile) {
    unless (copy($oldfile, $newfile)) {
       $request->print('<font color="red"> '.&mt('copy Error').': '.$!.'</font>');
       return 0;
    } else {
       unless (chmod(0660, $newfile)) {
    $request->print('<font color="red"> '.&mt('chmod error').': '.$!.'</font>');
    return 0;
       }
       return 1;
    }
       } else {
    $request->print('<p> '.&mt('No such file').' </p>');
    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('<font color="red">'.&mt('Error').': '.$!.'</font>');
       return 0;
     }
     unless(chmod(02770, ($newdirectory))) {
         $request->print('<font color="red"> '.&mt('Error').': '.$!.'</font>');
         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;
   }
   =pod
   
   =item phasetwo($r, $fn, $uname, $udom)
   
      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)=@_;
       
       &Debug($r, "loncfile - Entering phase 2 for $fn");
       
       # Break down the file into it's 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
    $main=$`; #This is what is before the match (.) so it's just the main filename, yea it's nasty
    $suffix=$1; #This is the actually filename extension if it exists
    }
       my $dest;                   # On success this is where we'll go.
       
       &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 .= '.';
    $main .= $suffix;
       if(!&decompress2($r, $uname, $dir, $main)) {
    return ;
    }
       $dest = $dir."/.";
        
   
       } elsif ($ENV{'form.action'} eq 'rename') { # Rename.
    if($ENV{'form.newfilename'}) {
       if (!defined($dir)) {
    $fn=~m:^(.*)/:;
    $dir=$1;
       }
       if(!&Rename2($r, $uname, $dir, $fn, $ENV{'form.newfilename'})) {
    return;
       }
       $dest = &url($ENV{'form.newfilename'});
    }
       } 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('<p>'.&mt('No New filename specified').'</p></form>');
       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('<h3><a href="javascript:self.close()">'.&mt('Done').'</a></h3>');
       } else {
            $r->print('<h3><a href="'.&url($dest).'">'.&mt('Done').'</a></h3>');
     }      }
     $r->print('<h3><a href="/priv/'.$uname.$dir.'/">Done</a></h3>');  
 }  }
   
 sub handler {  sub handler {
Line 288  sub handler { Line 1153  sub handler {
   
   
   &Debug($r, "loncfile.pm - handler entered");    &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
   #
   my $fn;    my $fn;
   
   if ($ENV{'form.filename'}) {    if ($ENV{'form.filename'}) {
       $fn=$ENV{'form.filename'};  
       &Debug($r, "loncfile::handler - raw url: $fn");   &Debug($r, "test: $ENV{'form.filename'}");
 #      $fn=~s/^http\:\/\/[^\/]+\/\~(\w+)/\/home\/$1\/public_html/;        $fn=&Apache::lonnet::unescape($ENV{'form.filename'});
 #      $fn=~s/^http\:\/\/[^\/]+//;        $fn=&URLToPath($fn);
       $fn=URLToPath($fn);    }  
       &Debug($r, "loncfile::handler - doctored url: $fn");   #Just hijack the script only the first time around to inject the correct information for further processing
       elsif($ENV{'QUERY_STRING'} && $ENV{'form.phase'} ne 'two') {
     &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},['decompress']);
    $fn=&Apache::lonnet::unescape($ENV{'form.decompress'});
    $fn=&URLToPath($fn);
    $ENV{'form.action'}="decompress";
     }
   
       elsif ($ENV{'form.qualifiedfilename'}) {
         $fn=$ENV{'form.qualifiedfilename'};
   } 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'}.
Line 329  sub handler { Line 1208  sub handler {
      return HTTP_NOT_ACCEPTABLE;       return HTTP_NOT_ACCEPTABLE;
   }    }
   
   $fn=~s/\/\~(\w+)//;  
   &Debug($r, "loncfile::handler ~ removed filename: $fn");  
   
   $r->content_type('text/html');    &Apache::loncommon::content_type($r,'text/html');
   $r->send_http_header;    $r->send_http_header;
   
   $r->print('<html><head><title>LON-CAPA Construction Space</title></head>');    if ( ($ENV{'form.action'} eq 'newdir') && ($ENV{'form.phase'} eq 'two') && ( ($ENV{'form.callingmode'} eq 'testbank') || ($ENV{'form.callingmode'} eq 'imsimport') ) ) {
         my $newdirname = $ENV{'form.newfilename'};
   $r->print(        $r->print('<html><head><title>LON-CAPA Construction Space</title><script language="Javascript">');
    '<body bgcolor="#FFFFFF"><img align=right src=/adm/lonIcons/lonlogos.gif>');        $r->print(qq|
   function writeDone() {
       var winName = window.opener
       window.focus();
       winName.document.dataForm.newdir.value = "$newdirname"
       setTimeout("self.close()",10000)
   }
     </script>
     </head>|);
         my $loaditem = 'onLoad="writeDone()"';
         $r->print(&Apache::loncommon::bodytag('Construction Space File Operation','',$loaditem));
     } else {
         $r->print('<html><head><title>LON-CAPA Construction Space</title></head>');
         $r->print(&Apache::loncommon::bodytag('Construction Space File Operation'));
     }
   
       
   $r->print('<h1>Construction Space <tt>'.$fn.'</tt></h1>');    $r->print('<h3>'.&mt('Location').': '.&display($fn).'</h3>');
       
   if (($uname ne $ENV{'user.name'}) || ($udom ne $ENV{'user.domain'})) {    if (($uname ne $ENV{'user.name'}) || ($udom ne $ENV{'user.domain'})) {
           $r->print('<h3><font color=red>Co-Author: '.$uname.' at '.$udom.            $r->print('<h3><font color="red">'.&mt('Co-Author').': '.$uname.' at '.$udom.
                '</font></h3>');                 '</font></h3>');
   }    }
   
Line 352  sub handler { Line 1243  sub handler {
   &Debug($r, "loncfile::handler Form action is $ENV{'form.action'} ");    &Debug($r, "loncfile::handler Form action is $ENV{'form.action'} ");
   if ($ENV{'form.action'} eq 'delete') {    if ($ENV{'form.action'} eq 'delete') {
               
       $r->print('<h3>Delete</h3>');        $r->print('<h3>'.&mt('Delete').'</h3>');
   } elsif ($ENV{'form.action'} eq 'rename') {    } elsif ($ENV{'form.action'} eq 'rename') {
       $r->print('<h3>Rename</h3>');        $r->print('<h3>'.&mt('Rename').'</h3>');
     } elsif ($ENV{'form.action'} eq 'move') {
         $r->print('<h3>'.&mt('Move').'</h3>');
   } elsif ($ENV{'form.action'} eq 'newdir') {    } elsif ($ENV{'form.action'} eq 'newdir') {
       $r->print('<h3>New Directory</h3>');        $r->print('<h3>'.&mt('New Directory').'</h3>');
     } elsif ($ENV{'form.action'} eq 'decompress') {
         $r->print('<h3>'.&mt('Decompress').'</h3>');
   } elsif ($ENV{'form.action'} eq 'copy') {    } elsif ($ENV{'form.action'} eq 'copy') {
       $r->print('<h3>Copy</h3>');        $r->print('<h3>'.&mt('Copy').'</h3>');
     } 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 'Select Action' ) {
         $r->print('<h3>'.&mt('New Resource').'</h3>');
   } else {    } else {
      $r->print('<p>Unknown Action</body></html>');       $r->print('<p>'.&mt('Unknown Action').' '.$ENV{'form.action'}.' </p></body></html>');
      return OK;         return OK;  
   }    }
   if ($ENV{'form.phase'} eq 'two') {    if ($ENV{'form.phase'} eq 'two') {
Removed from v.1.10  
changed lines
  Added in v.1.52

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