Diff for /loncom/publisher/loncfile.pm between versions 1.16 and 1.17

version 1.16, 2002/09/02 16:39:15 version 1.17, 2002/09/02 20:06:57
Line 69  directory. Line 69  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 procede 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
 completion.  When the user dismisses the output of phase2, they are returned to  completion.  When the user dismisses the output of phase2, they are returned to
Line 100  my $r;    # Needs to be global for some Line 100  my $r;    # Needs to be global for some
   
 =item Debug($request, $message)  =item Debug($request, $message)
   
   If debugging is enabled puts out a debuggin message determined by the    If debugging is enabled puts out a debugging message determined by the
   caller.  The debug message goes to the Apache error log file. Debugging    caller.  The debug message goes to the Apache error log file. Debugging
   is enabled by ssetting the module global DEBUG variable to nonzero (TRUE).    is enabled by setting the module global DEBUG variable to nonzero (TRUE).
   
  Parameters:   Parameters:
   
 =over 4  =over 4
     
 =item $request - The curretn request operation.  =item $request - The current request operation.
   
 =item $message - The message to put inthe log file.  =item $message - The message to put in the log file.
   
 =back  =back
       
Line 182  sub URLToPath { Line 182  sub URLToPath {
   
 =item PublicationPath($domain, $user, $dir, $file)  =item PublicationPath($domain, $user, $dir, $file)
   
    Determines the filesystem path corersponding to a published resource     Determines the filesystem path corresponding to a published resource
    specification.  The returned value is the path.     specification.  The returned value is the path.
 Parameters:  Parameters:
   
Line 193  Parameters: Line 193  Parameters:
   
 =item   $user   - string [in] Name of the user asking about the resource.  =item   $user   - string [in] Name of the user asking about the resource.
   
 =item   $dir    - Directory pathr elatvie to the top of the resource space0  =item   $dir    - Directory path relative to the top of the resource space.
   
 =item   $file   - name of the resource file itself without path info.  =item   $file   - name of the resource file itself without path info.
   
Line 221  sub PublicationPath Line 221  sub PublicationPath
   
 =item ConstructionPath($domain, $user, $dir, $file)  =item ConstructionPath($domain, $user, $dir, $file)
   
    Determines the filesystem path corersponding to a construction space     Determines the filesystem path corresponding to a construction space
    resource specification.  The returned value is the path     resource specification.  The returned value is the path
 Parameters:  Parameters:
   
Line 229  Parameters: Line 229  Parameters:
   
 =item   $user   - string [in] Name of the user asking about the resource.  =item   $user   - string [in] Name of the user asking about the resource.
   
 =item   $dir    - Directory path relatvie to the top of the resource space  =item   $dir    - Directory path relative to the top of the resource space.
   
 =item   $file   - name of the resource file itself without path info.  =item   $file   - name of the resource file itself without path info.
   
Line 287  sub ConstructionPathFromRelative { Line 287  sub ConstructionPathFromRelative {
   
 =item exists($user, $domain, $directory, $file)  =item exists($user, $domain, $directory, $file)
   
    Determine if a resource file name has been publisehd or exists     Determine if a resource file name has been published or exists
    in the construction space.     in the construction space.
   
  Parameters:   Parameters:
Line 362  as a result of this operation. Line 362  as a result of this operation.
   
 =over 4  =over 4
   
 =item    Empty string if everythikng worked.  =item    Empty string if everything worked.
   
 =item    String containing an error message if there was a problem.  =item    String containing an error message if there was a problem.
   
Line 554  sub Delete1 { Line 554  sub Delete1 {
 =item Copy1($request, $user, $domain, $filename, $newfilename)  =item Copy1($request, $user, $domain, $filename, $newfilename)
   
    Performs phase 1 processing of the construction space copy command.     Performs phase 1 processing of the construction space copy command.
    Ensure that the source fil eexists.  Ensure that a destination exists,     Ensure that the source file exists.  Ensure that a destination exists,
    also warn if the detination already exists.     also warn if the destination already exists.
   
 Parameters:  Parameters:
   
Line 613  Parameters: Line 613  Parameters:
 =over 4  =over 4
   
 =item   $request  - Apache Request Object [in] - Server request object for the  =item   $request  - Apache Request Object [in] - Server request object for the
                current url..                 current url.
   
 =item   $username - Name of the user that is requesting the directory creation.  =item   $username - Name of the user that is requesting the directory creation.
   
 =item   $path     - current directory relative to construction spacee.  =item   $path     - current directory relative to construction space.
   
 =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.
Line 682  performed and reported to the user. Line 682  performed and reported to the user.
   
 =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 nmae under which the user logged in.   =item $udom  - string [in] Domain name under which the user logged in. 
   
 =back  =back
   
Line 729  sub phaseone { Line 729  sub phaseone {
   
 =item Rename2($request, $user, $directory, $oldfile, $newfile)  =item Rename2($request, $user, $directory, $oldfile, $newfile)
   
 Performs phase 2 procesing of a rename reequest.   This is where the  Performs phase 2 processing of a rename reequest.   This is where the
 actual rename is performed.  actual rename is performed.
   
 Parameters  Parameters
Line 799  Parameters: Line 799  Parameters:
 =item $user    - string [in]  The name of the user initiating the delete  =item $user    - string [in]  The name of the user initiating the delete
                  request.                   request.
   
 =item $filename - string [in] The name of the file, relative to construction space,  =item $filename - string [in] The name of the file, relative to construction
                   to delete.                    space, to delete.
   
 =back  =back
   

Removed from v.1.16  
changed lines
  Added in v.1.17


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