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

Diff for /loncom/publisher/lonpubdir.pm between versions 1.6 and 1.46

version 1.6, 2001/05/09 16:57:07 version 1.46, 2003/11/19 14:57:32
Line 1 Line 1
 # The LearningOnline Network with CAPA  # The LearningOnline Network with CAPA
   # Construction Space Directory Lister
   #
   # $Id$
   #
   # Copyright Michigan State University Board of Trustees
   #
   # This file is part of the LearningOnline Network with CAPA (LON-CAPA).
   #
   # LON-CAPA is free software; you can redistribute it and/or modify
   # it under the terms of the GNU General Public License as published by
   # the Free Software Foundation; either version 2 of the License, or
   # (at your option) any later version.
   #
   # LON-CAPA is distributed in the hope that it will be useful,
   # but WITHOUT ANY WARRANTY; without even the implied warranty of
   # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   # GNU General Public License for more details.
   #
   # You should have received a copy of the GNU General Public License
   # along with LON-CAPA; if not, write to the Free Software
   # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
   #
   # /home/httpd/html/adm/gpl.txt
   #
   # http://www.lon-capa.org/
 #  #
 # (Publication Handler  
 #   # 
 # (TeX Content Handler  # (TeX Content Handler
 #  #
   # YEAR=2000
 # 05/29/00,05/30,10/11 Gerd Kortemeyer)  # 05/29/00,05/30,10/11 Gerd Kortemeyer)
 #  #
 # 11/28,11/29,11/30,12/01,12/02,12/04,12/23 Gerd Kortemeyer  # 11/28,11/29,11/30,12/01,12/02,12/04,12/23 Gerd Kortemeyer
   # YEAR=2001
 # 03/23 Guy Albertelli  # 03/23 Guy Albertelli
 # 03/24,03/29 Gerd Kortemeyer)  # 03/24,03/29 Gerd Kortemeyer)
   # 03/31,04/03,05/09,06/23,08/18,08/20 Gerd Kortemeyer
   # 12/28 Gerd Kortemeyer
 #  #
 # 03/31,04/03,05/09 Gerd Kortemeyer  ###
   
 package Apache::lonpubdir;  package Apache::lonpubdir;
   
Line 19  use Apache::File; Line 47  use Apache::File;
 use File::Copy;  use File::Copy;
 use Apache::Constants qw(:common :http :methods);  use Apache::Constants qw(:common :http :methods);
 use Apache::loncacc;  use Apache::loncacc;
   use Apache::loncommon();
   use Apache::lonlocal;
   
 sub handler {  sub handler {
   
Line 27  sub handler { Line 56  sub handler {
   
   my $fn;    my $fn;
   
   if ($ENV{'form.filename'}) {  
       $fn=$ENV{'form.filename'};  
       $fn=~s/^http\:\/\/[^\/]+\/\~(\w+)/\/home\/$1\/public_html/;    $fn = getEffectiveUrl($r);
       $fn=~s/\/[^\/]+$//;  
   } else {    # Validate access to the construction space and get username@domain.
       $fn=$r->filename();  
   }  
   
   my $uname;    my $uname;
   my $udom;    my $udom;
   
   unless (($uname,$udom)=    ($uname,$udom)=
     &Apache::loncacc::constructaccess(      &Apache::loncacc::constructaccess(
              $fn,$r->dir_config('lonDefDomain'))) {               $fn,$r->dir_config('lonDefDomain')); 
     unless (($uname) && ($udom)) {
      $r->log_reason($uname.' at '.$udom.       $r->log_reason($uname.' at '.$udom.
          ' trying to publish file '.$ENV{'form.filename'}.           ' trying to list directory '.$ENV{'form.filename'}.
          ' ('.$fn.') - not authorized',            ' ('.$fn.') - not authorized', 
          $r->filename);            $r->filename); 
      return HTTP_NOT_ACCEPTABLE;       return HTTP_NOT_ACCEPTABLE;
   }    }
        
     # Remove trailing / from directory name.
   
   $fn=~s/\/$//;    $fn=~s/\/$//;
   
   unless ($fn) {     unless ($fn) { 
Line 58  sub handler { Line 88  sub handler {
   
 # ----------------------------------------------------------- Start page output  # ----------------------------------------------------------- Start page output
   
     my $thisdisfn=$fn;
     $thisdisfn=~s/^\/home\/$uname\/public_html//; # subdirectory part of
                                                   # construction space. 
     my $docroot=$r->dir_config('lonDocRoot');     # Apache  londocument root.
   
   $r->content_type('text/html');    my $resdir=$docroot.'/res/'.$udom.'/'.$uname.$thisdisfn; # Resource directory
   $r->send_http_header;    my $targetdir=$udom.'/'.$uname.$thisdisfn; # Publiction target directory.
     my $linkdir='/priv/'.$uname.$thisdisfn;      # Full URL name of constr space.
   
   $r->print('<html><head><title>LON-CAPA Construction Space</title></head>');  
   
   $r->print(  
    '<body bgcolor="#FFFFFF"><img align=right src=/adm/lonIcons/lonlogos.gif>');  
   
   my $thisdisfn=$fn;    &startpage($r, $uname, $udom, $thisdisfn);   # Put out the start of page.
   $thisdisfn=~s/^\/home\/$uname\/public_html//;  
       
   $r->print('<h1>Construction Space Directory <tt>'.$thisdisfn.'/</tt></h1>');    # Start off the diretory table.
     
   if (($uname ne $ENV{'user.name'}) || ($udom ne $ENV{'user.domain'})) {  
           $r->print('<h3><font color=red>Co-Author: '.$uname.' at '.$udom.  
                '</font></h3>');  
   }  
   
   
   my $docroot=$r->dir_config('lonDocRoot');  
   
   my $resdir=$docroot.'/res/'.$udom.'/'.$uname.$thisdisfn;  
   my $linkdir='/~'.$uname.$thisdisfn;  
   
   $r->print('<table border=2>'.    $r->print('<table border=2>'.
             '<tr><th>Filename</th><th>Modified</th><th>Status</th></tr>');      '<tr><th>'.&mt('Actions').'</th><th>'.&mt('Name').'</th><th>'.
       &mt('Title').'</th>'.
       '<th>'.&mt('Status').'</th><th>'.&mt('Last Modified').
       '</th></tr>');
   
   my $filename;    my $filename;
   my $dirptr=16384;    my $dirptr=16384; # Mask indicating a directory in stat.cmode.
   
   opendir(DIR,$fn);    opendir(DIR,$fn);
   while ($filename=readdir(DIR)) {    my @files=sort {uc($a) cmp uc($b)} (readdir(DIR));
     foreach my $filename (@files) {
      my ($cdev,$cino,$cmode,$cnlink,       my ($cdev,$cino,$cmode,$cnlink,
          $cuid,$cgid,$crdev,$csize,           $cuid,$cgid,$crdev,$csize,
          $catime,$cmtime,$cctime,           $catime,$cmtime,$cctime,
          $cblksize,$cblocks)=stat($fn.'/'.$filename);           $cblksize,$cblocks)=stat($fn.'/'.$filename);
      $filename=~/\.(\w+)$/;  
      if (($1 ne 'meta') && (&Apache::lonnet::fileembstyle($1))) {       my $extension='';
          my $status='Unpublished';       if ($filename=~/\.(\w+)$/) { $extension=$1; }
          my $bgcol='#FFBBBB';       if ($cmode&$dirptr) {
          if (-e $resdir.'/'.$filename) {   putdirectory($r, $thisdisfn, $linkdir, $filename, $cmtime);
             my ($rdev,$rino,$rmode,$rnlink,       } elsif (&Apache::loncommon::fileembstyle($extension) ne 'hdn') {
                 $ruid,$rgid,$rrdev,$rsize,   putresource($r, $uname, $filename, $thisdisfn, $resdir, 
                 $ratime,$rmtime,$rctime,       $targetdir, $linkdir, $cmtime);
                 $rblksize,$rblocks)=stat($resdir.'/'.$filename);       } else {
             if ($rmtime>=$cmtime) {   # "hidden" extension and not a directory, so hide it away.
  $status='Published';  
                 $bgcol='#BBFFBB';  
             } else {  
                 $status='Modified';  
                 $bgcol='#FFFFBB';  
                 if   
             (&Apache::lonnet::fileembstyle(($filename=~/\.(\w+)$/)) eq 'ssi') {  
                    $status.='<br><a href="/adm/diff?filename='.$filename.  
        '&versionone=priv" target=cat>Diffs</a>';  
         }  
             }     
  }  
          $r->print('<tr bgcolor='.$bgcol.  
          '><td><a href="'.$linkdir.'/'.$filename.'">'.$filename.  
          '</a></td><td>'.localtime($cmtime).'</td><td>'.$status.'</td></tr>');  
      } elsif ($cmode&$dirptr) {  
          my $disfilename=$filename;  
          if ($filename eq '..') {  
      $disfilename='<i>Parent Directory</i>';  
          }  
          unless ((($filename eq '..') && ($thisdisfn eq '')) ||  
                  ($filename eq '.')) {  
            $r->print('<tr bgcolor=#BBBBFF'.  
            '><td><a href="'.$linkdir.'/'.$filename.'">'.$disfilename.  
            '</a></td><td>'.localtime($cmtime).'</td><td>&nbsp;</td></tr>');  
          }  
      }       }
   }    }
   closedir(DIR);    closedir(DIR);
Line 138  sub handler { Line 136  sub handler {
   $r->print('</table></body></html>');    $r->print('</table></body></html>');
   return OK;      return OK;  
 }  }
   #
   #  Gets the effective URL of the request and returns it:
   #    $effn = getEffectiveUrl($r);
   #       $r  - The Apache Request object.
   sub getEffectiveUrl {
       my $r = shift;
       my $fn;
       
       if ($ENV{'form.filename'}) { # If a form filename is defined.
    $fn=$ENV{'form.filename'};
    #
    #   Replace the ~username of the URL with /home/username/public_html
    #   so that we don't have to worry about ~ expansion internally.
    #
    $fn=~s/^http\:\/\/[^\/]+\///;
           $fn=~s/^\///;
           $fn=~s/\~(\w+)/\/home\/$1\/public_html/;
   
    #  Remove trailing / strings (?) 
   
    $fn=~s/\/[^\/]+$//;
       } else {
    #   If no form is defined, use request filename.
    $fn = $r->filename();
    my $lonDocRoot=$r->dir_config('lonDocRoot');
    if ( $fn =~ /$lonDocRoot/ ) {
       #internal authentication, needs fixup.
       $fn = $r->uri(); # non users do not get the full path request
                                # through SCRIPT_FILENAME
       $fn=~s|^/~(\w+)|/home/$1/public_html|;
    }
       }
       $fn=~s/\/+/\//g;
       return $fn;
   }
   #
   #   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.
   
   sub startpage {
       my ($r, $uname, $udom, $thisdisfn) = @_;
       
       &Apache::loncommon::content_type($r,'text/html');
       $r->send_http_header;
       
       $r->print('<html><head><title>LON-CAPA Construction Space</title></head>');
       
       $r->print(&Apache::loncommon::bodytag(undef,undef,undef,1));
       my $pubdirscript=(<<ENDPUBDIRSCRIPT);
   <script>
   // Store directory location for menu bar to find
   
   parent.lastknownpriv='/~$uname/$thisdisfn/';
   
   // Confirmation dialogues
   
       function pubdir(theform) {
    if (confirm('Publish complete directory?')) {
       theform.submit();
           }
       }
      function pubrecdir(theform) {
    if (confirm('Publish directory and all subdirectories?')) {
               theform.pubrec.value='1';
       theform.submit();
           }
       }
   </script>
   ENDPUBDIRSCRIPT
   
       $r->print('<h1>'.&mt('Construction Space Directory').' <tt>'.
         $thisdisfn.'/</tt></h1>'.
         '<script type="text/javascript">top.document.title = \''.
         $thisdisfn.'/ - LON-CAPA Construction Space\';</script>'.
         $pubdirscript.
                 '<form method="post" action="/adm/publish" target="_parent">'.
                 '<table><tr><td><input type="hidden" name="filename" value="/~'.
                  $uname.$thisdisfn.'/" />'.
                 '<input type="button" onClick="pubdir(this.form);" value="'.
   &mt('Publish Directory').'" />'.
                 '<input type="hidden" name="pubrec" value="" />'.
                 '<input type="button" onClick="pubrecdir(this.form);" value="'.
   &mt('Publish Directory and Sub Directories').'" /></td><td>'.
   '<input type="button" onClick="window.location='."'/~".
                  $uname.$thisdisfn."/default.meta'".'" value="'.
   &mt('Edit Directory Catalog Information').'" /></td></tr><tr><td><input type="checkbox" name="forcerepub" /> '.&mt('Force publication of unmodified files').'.</td><td>&nbsp;</td></tr></table></form>');
       
       if (($uname ne $ENV{'user.name'}) || ($udom ne $ENV{'user.domain'})) {
    $r->print('<h3>'.&mt('Co-Author').': '.$uname.' at '.$udom.
     '</h3>');
       }
   }
   
   #
   #   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.
   #
   sub getTitleString {
       my $fullname = shift;
       my $title    = &Apache::lonnet::metadata($fullname, 'title');
   
       unless ($title) {
    $title = "[".&mt('untitled')."]";
       }
       return $title;
   }
   
   
   #
   #  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.
   # 
   sub putdirectory {
       my ($r, $reqfile, $here, $dirname, $modtime) = @_;
     
       # construct the display filename: the directory name unless ..:
       
       my $disfilename = $dirname;
       if ($dirname eq '..') {
    $disfilename = '<i>'.&mt('Parent Directory').'</i>';
       }
       unless (( ($dirname eq '..') && ($reqfile eq '')) ||
       ($dirname eq '.')) {
    $r->print('<tr bgcolor="#CCCCFF">'.
     '<td>Go to ...</td>'.
     '<td><a href="'.$here.'/'.$dirname.'/" target="_top">'.
     $disfilename.'</a></td>'.
           '<td>&nbsp;</td>'.
     '<td>&nbsp;</td>'.
     '<td>'.&Apache::lonlocal::locallocaltime($modtime).'</td>'.
     "</tr>\n");
       }
       return OK;
   }
   #
   #   Put a table row for a file resource.
   #
   sub putresource {
       my ($r, $uname, $filename, $thisdisfn, 
    $resdir, $targetdir, $linkdir,
    $cmtime) = @_;
   
       my $status='Unpublished';
       my $bgcolor='#FFCCCC';
       my $title='&nbsp;';
       if (-e $resdir.'/'.$filename) {
    my ($rdev,$rino,$rmode,$rnlink,
       $ruid,$rgid,$rrdev,$rsize,
       $ratime,$rmtime,$rctime,
       $rblksize,$rblocks)=stat($resdir.'/'.$filename);
    if ($rmtime>=$cmtime) {
       $status=&mt('Published');
               $bgcolor='#CCFFCC';
       if (&Apache::lonnet::metadata($targetdir.'/'.$filename,'obsolete')) {
    $status=&mt('Obsolete');
                   $bgcolor='#AAAAAA';
       }
       $title='<a href="/res/'.$targetdir.'/'.$filename.
    '.meta" target=cat>'.
    getTitleString($targetdir.'/'.$filename, 'title').'</a>';
    } else {
       $status=&mt('Modified');
               $bgcolor='#FFFFCC';
       $title='<a href="/res/'.$targetdir.'/'.$filename.'.meta" target=cat>'.
    getTitleString($targetdir.'/'.$filename,'title').'</a>';
       if (&Apache::loncommon::fileembstyle(($filename=~/\.(\w+)$/)) eq 'ssi') {
    $status.='<br><a href="/adm/diff?filename=/~'.$uname.
       $thisdisfn.'/'.$filename.
       '&versiontwo=priv" target=cat>'.&mt('Diffs').'</a>';
       }
    }   
    $status.='<br><a href="/adm/retrieve?filename=/~'.$uname.
       $thisdisfn.'/'.$filename.'" target=cat>'.&mt('Retrieve').'</a>';
       }
       my $editlink='';
       my $editlink2='';
       if ($filename=~/\.(xml|html|htm|xhtml|xhtm|sty)$/) {
    $editlink=' (<a href="'.$linkdir.'/'.$filename.'?forceedit=1" target="_top">'.&mt('Edit').'</a>)';
       }
       if ($filename=~/\.(problem|exam|quiz|assess|survey|form|library)$/) {
    $editlink=' (<a href="'.$linkdir.'/'.$filename.'?forceedit=1" target="_top">'.&mt('EditXML').'</a>)';
    $editlink2=' (<a href="'.$linkdir.'/'.$filename.'?forceColoredit=1" target="_top">'.&mt('Edit').'</a>)';
       }
       if ($filename=~/\.(zip|tar|bz2|gz|tar.gz|tar.bz2|tgz)$/) {
    $editlink=' (<a target="_parent" href="/adm/cfile?decompress=/~'.
         $uname.$thisdisfn.'/'.$filename.'">'.&mt('Decompress').'</a>)';
       }
       $r->print('<tr bgcolor="'.$bgcolor.'">'.
         '<td><a target="_parent" href="/adm/publish?filename=/~'.
         $uname.$thisdisfn.'/'.$filename.'">'.&mt('Publish').'</a>'.
         '</td>'.
         '<td>'.
         '<a href="'.$linkdir.'/'.$filename.'" target="_top">'.
                  $filename.'</a>'.$editlink2.$editlink.
         '</td>'.
         '<td>'.$title.'</td>'.
         '<td>'.$status.'</td>'.
         '<td>'.&Apache::lonlocal::locallocaltime($cmtime).'</td>'.
         "</tr>\n");
       return OK;
   }
   #
   #   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.
   #
   sub CategorizeFiles {
       my $location = shift;
       my $files    = shift;
   }
   
 1;  1;
 __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
   
   =cut
Removed from v.1.6  
changed lines
  Added in v.1.46

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