Diff for /loncom/publisher/lonpubdir.pm between versions 1.113 and 1.114.2.2

version 1.113, 2008/11/17 13:41:10 version 1.114.2.2, 2010/02/12 16:04:18
Line 27 Line 27
 #  #
 ###  ###
   
 =head1 NAME  
   
 Apache::lonpubdir - Construction space directory lister  
   
 =head1 SYNOPSIS  
   
 Invoked (for various locations) by /etc/httpd/conf/srm.conf:  
   
  <LocationMatch "^/\~.*/$">  
  PerlAccessHandler       Apache::loncacc  
  SetHandler perl-script  
  PerlHandler Apache::lonpubdir  
  ErrorDocument     403 /adm/login  
  ErrorDocument     404 /adm/notfound.html  
  ErrorDocument     406 /adm/unauthorized.html  
  ErrorDocument  500 /adm/errorhandler  
  </LocationMatch>  
   
  <Location /adm/pubdir>  
  PerlAccessHandler       Apache::lonacc  
  SetHandler perl-script  
  PerlHandler Apache::lonpubdir  
  ErrorDocument     403 /adm/login  
  ErrorDocument     404 /adm/notfound.html  
  ErrorDocument     406 /adm/unauthorized.html  
  ErrorDocument  500 /adm/errorhandler  
  </Location>  
   
 =head1 INTRODUCTION  
   
 This module publishes a directory of files.  
   
 This is part of the LearningOnline Network with CAPA project  
 described at http://www.lon-capa.org.  
   
 =head1 HANDLER SUBROUTINE  
   
 This routine is called by Apache and mod_perl.  
   
 =over 4  
   
 =item *  
   
 read in information  
   
 =item *  
   
 start page output  
   
 =item *  
   
 run through list of files and attempt to publish unhidden files  
   
 =back  
   
 =head2 OTHER SUBROUTINES:  
   
 =head3 startpage($r, $uame, $udom, $thisdisfn)  
   
 Output the header of the page.  This includes:  
  - The HTML header   
  - The H1/H3  stuff which includes the directory.  
    
     startpage($r, $uame, $udom, $thisdisfn);  
         $r     - The apache request object.  
         $uname - User name.  
         $udom  - Domain name the user is logged in under.  
         $thisdisfn - Displayable version of the filename.  
   
 =head3 getTitleString($fullname)  
   
     Get the title string or "[untitled]" if the file has no title metadata:  
     Without the latter substitution, it's impossible to examine metadata for  
     untitled resources.  Resources may be legitimately untitled, to prevent  
     searches from locating them.  
       
     $str = getTitleString($fullname);  
         $fullname - Fully qualified filename to check.  
   
 =head3 putdirectory(r, base, here, dirname, modtime)  
   
     Put out a directory table row:  
       
     putdirectory($r, $base, $here, $dirname, $modtime)  
         $r       - Apache request object.  
         $reqfile - File in request.  
         $here    - Where we are in directory tree.  
         $dirname - Name of directory special file.  
         $modtime - Encoded modification time.  
   
 =head3 CategorizeFiles($location, $files)  
       
     Categorize files in the directory.  
     For each file in a list of files in a file directory,   
     the  file categorized as one of:  
         - directory    
         - sequence  
         - problem   
         - Other resource.  
   
     For each file the modification date is determined as well.  
     Returned is a list of sublists:  
         (directories, sequences, problems, other)  
     each of the sublists contains entries of the following form (sorted by filename):  
     (filename, typecode, lastmodtime)  
       
         $list = CategorizeFiles($location, $files)  
         $location   - Directory in which the files live (relative to our execution)  
         $files      - list of files.  
   
 =cut  
   
 package Apache::lonpubdir;  package Apache::lonpubdir;
   
 use strict;  use strict;
Line 174  sub handler { Line 62  sub handler {
     &Apache::loncacc::constructaccess(      &Apache::loncacc::constructaccess(
              $fn,$r->dir_config('lonDefDomain'));                $fn,$r->dir_config('lonDefDomain')); 
   unless (($uname) && ($udom)) {    unless (($uname) && ($udom)) {
      $r->log_reason($uname.' at '.$udom.       $r->log_reason($uname.':'.$udom.
          ' trying to list directory '.$env{'form.filename'}.           ' trying to list directory '.$env{'form.filename'}.
          ' ('.$fn.') - not authorized',            ' ('.$fn.') - not authorized', 
          $r->filename);            $r->filename); 
Line 186  sub handler { Line 74  sub handler {
   $fn=~s/\/$//;    $fn=~s/\/$//;
   
   unless ($fn) {     unless ($fn) { 
      $r->log_reason($env{'user.name'}.' at '.$env{'user.domain'}.       $r->log_reason($env{'user.name'}.':'.$env{'user.domain'}.
          ' trying to list empty directory', $r->filename);            ' trying to list empty directory', $r->filename); 
      return HTTP_NOT_FOUND;       return HTTP_NOT_FOUND;
   }     } 
Line 268  sub getEffectiveUrl { Line 156  sub getEffectiveUrl {
  #   Replace the ~username of the URL with /home/username/public_html   #   Replace the ~username of the URL with /home/username/public_html
  #   so that we don't have to worry about ~ expansion internally.   #   so that we don't have to worry about ~ expansion internally.
  #   #
  $fn=~s/^http\:\/\/[^\/]+\///;          $fn=~s/^https?\:\/\/[^\/]+\///;
   
         $fn=~s/^\///;          $fn=~s/^\///;
         $fn=~s{~($LONCAPA::username_re)}{/home/$1/public_html};          $fn=~s{~($LONCAPA::username_re)}{/home/$1/public_html};
   
Line 442  ENDPUBDIRSCRIPT Line 331  ENDPUBDIRSCRIPT
   
     if ((($uname ne $env{'user.name'}) || ($udom ne $env{'user.domain'})) &&      if ((($uname ne $env{'user.name'}) || ($udom ne $env{'user.domain'})) &&
  $env{'environment.remote'} ne 'off') {   $env{'environment.remote'} ne 'off') {
  $r->print('<h3>'.&mt('Co-Author').': '.$uname.' at '.$udom.          $r->print('<h3>'.&mt('Co-Author [_1]',$uname.':'.$udom).'</h3>');
   '</h3>');  
     }      }
 }  }
   
Line 561  sub pubbuttons { Line 449  sub pubbuttons {
               '<input type="submit" value="'.&mt('Publish Directory').'" /></td><td>'.                '<input type="submit" value="'.&mt('Publish Directory').'" /></td><td>'.
 '<input type="button" onclick="window.location='."'/~".  '<input type="button" onclick="window.location='."'/~".
                $uname.$thisdisfn."/default.meta'".'" value="'.                 $uname.$thisdisfn."/default.meta'".'" value="'.
 &mt('Edit Directory Catalog Information').'" /></td></tr></table></form>');  &mt('Edit Directory Metadata').'" /></td></tr></table></form>');
 }  }
   
 sub resourceactions {  sub resourceactions {
Line 733  sub putresource { Line 621  sub putresource {
     $meta_same = 0;      $meta_same = 0;
  }   }
  $publish_button=&mt('Re-publish');   $publish_button=&mt('Re-publish');
  my $rights_status =  
     &mt(&getCopyRightString($targetdir.'/'.$filename)).' '.          my $rights_status =
     &mt(&getSourceRightString($targetdir.'/'.$filename));              &mt(&getCopyRightString($targetdir.'/'.$filename)).', ';
   
           my %lt_SourceRight = &Apache::lonlocal::texthash(
                  'open'   => 'Source: open',
                  'closed' => 'Source: closed',
           );
           $rights_status .=
               $lt_SourceRight{&getSourceRightString($targetdir.'/'.$filename)};
   
  $title = '<a href="/res/'.$targetdir.'/'.$filename.   $title = '<a href="/res/'.$targetdir.'/'.$filename.
     '.meta" target="cat">'.      '.meta" target="cat">'.
     &getTitleString($targetdir.'/'.$filename).'</a>';      &getTitleString($targetdir.'/'.$filename).'</a>';
Line 898  sub CategorizeFiles { Line 794  sub CategorizeFiles {
 __END__  __END__
   
   
   =head1 NAME
   
   Apache::lonpubdir - Construction space directory lister
   
   =head1 SYNOPSIS
   
   Invoked (for various locations) by /etc/httpd/conf/srm.conf:
   
    <LocationMatch "^/\~.*/$">
    PerlAccessHandler       Apache::loncacc
    SetHandler perl-script
    PerlHandler Apache::lonpubdir
    ErrorDocument     403 /adm/login
    ErrorDocument     404 /adm/notfound.html
    ErrorDocument     406 /adm/unauthorized.html
    ErrorDocument  500 /adm/errorhandler
    </LocationMatch>
   
    <Location /adm/pubdir>
    PerlAccessHandler       Apache::lonacc
    SetHandler perl-script
    PerlHandler Apache::lonpubdir
    ErrorDocument     403 /adm/login
    ErrorDocument     404 /adm/notfound.html
    ErrorDocument     406 /adm/unauthorized.html
    ErrorDocument  500 /adm/errorhandler
    </Location>
   
   =head1 INTRODUCTION
   
   This module publishes a directory of files.
   
   This is part of the LearningOnline Network with CAPA project
   described at http://www.lon-capa.org.
   
   =head1 HANDLER SUBROUTINE
   
   This routine is called by Apache and mod_perl.
   
   =over 4
   
   =item *
   
   read in information
   
   =item *
   
   start page output
   
   =item *
   
   run through list of files and attempt to publish unhidden files
   
   =back
   
   =head1 SUBROUTINES:
   
   =over
   
   =item startpage($r, $uame, $udom, $thisdisfn)
   
   Output the header of the page.  This includes:
    - The HTML header 
    - The H1/H3  stuff which includes the directory.
    
       startpage($r, $uame, $udom, $thisdisfn);
           $r     - The apache request object.
           $uname - User name.
           $udom  - Domain name the user is logged in under.
           $thisdisfn - Displayable version of the filename.
   
   =item getTitleString($fullname)
   
       Get the title string or "[untitled]" if the file has no title metadata:
       Without the latter substitution, it's impossible to examine metadata for
       untitled resources.  Resources may be legitimately untitled, to prevent
       searches from locating them.
       
       $str = getTitleString($fullname);
           $fullname - Fully qualified filename to check.
   
   =item putdirectory(r, base, here, dirname, modtime)
   
       Put out a directory table row:
       
       putdirectory($r, $base, $here, $dirname, $modtime)
           $r       - Apache request object.
           $reqfile - File in request.
           $here    - Where we are in directory tree.
           $dirname - Name of directory special file.
           $modtime - Encoded modification time.
   
   =item CategorizeFiles($location, $files)
       
       Categorize files in the directory.
       For each file in a list of files in a file directory, 
       the  file categorized as one of:
           - directory  
           - sequence
           - problem 
           - Other resource.
   
       For each file the modification date is determined as well.
       Returned is a list of sublists:
           (directories, sequences, problems, other)
       each of the sublists contains entries of the following form (sorted by filename):
       (filename, typecode, lastmodtime)
       
           $list = CategorizeFiles($location, $files)
           $location   - Directory in which the files live (relative to our execution)
           $files      - list of files.
   
   =back
   
   =cut
   

Removed from v.1.113  
changed lines
  Added in v.1.114.2.2


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