--- loncom/publisher/lonpubdir.pm 2001/04/01 02:58:51 1.1 +++ loncom/publisher/lonpubdir.pm 2003/12/31 02:33:28 1.51 @@ -1,16 +1,31 @@ # The LearningOnline Network with CAPA +# Construction Space Directory Lister # -# (Publication Handler -# -# (TeX Content Handler +# $Id: lonpubdir.pm,v 1.51 2003/12/31 02:33:28 www Exp $ +# +# 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. # -# 05/29/00,05/30,10/11 Gerd Kortemeyer) +# 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. # -# 11/28,11/29,11/30,12/01,12/02,12/04,12/23 Gerd Kortemeyer -# 03/23 Guy Albertelli -# 03/24,03/29 Gerd Kortemeyer) +# 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 # -# 03/31 Gerd Kortemeyer +# /home/httpd/html/adm/gpl.txt +# +# http://www.lon-capa.org/ +# +### package Apache::lonpubdir; @@ -18,7 +33,11 @@ use strict; use Apache::File; use File::Copy; use Apache::Constants qw(:common :http :methods); - +use Apache::loncacc; +use Apache::loncommon(); +use Apache::lonhtmlcommon(); +use Apache::lonlocal; +use Apache::lonmsg; sub handler { @@ -26,55 +45,393 @@ sub handler { my $fn; - if ($ENV{'form.filename'}) { - $fn=$ENV{'form.filename'}; - $fn=~s/^http\:\/\/[^\/]+\/\~(\w+)/\/home\/$1\/public_html/; - $fn=~s/\/[^\/]+$//; - } else { - $fn=$r->filename(); + + + $fn = getEffectiveUrl($r); + + # Validate access to the construction space and get username@domain. + + my $uname; + my $udom; + + ($uname,$udom)= + &Apache::loncacc::constructaccess( + $fn,$r->dir_config('lonDefDomain')); + unless (($uname) && ($udom)) { + $r->log_reason($uname.' at '.$udom. + ' trying to list directory '.$ENV{'form.filename'}. + ' ('.$fn.') - not authorized', + $r->filename); + return HTTP_NOT_ACCEPTABLE; } - + + # Remove trailing / from directory name. + + $fn=~s/\/$//; unless ($fn) { $r->log_reason($ENV{'user.name'}.' at '.$ENV{'user.domain'}. - ' trying to publish empty directory', $r->filename); + ' trying to list empty directory', $r->filename); return HTTP_NOT_FOUND; } # ----------------------------------------------------------- Start page output - my $uname=$ENV{'user.name'}; - my $udom=$ENV{'user.domain'}; - - $r->content_type('text/html'); - $r->send_http_header; + my $thisdisfn=$fn; + $thisdisfn=~s/^\/home\/$uname\/public_html//; # subdirectory part of + # construction space. + my $docroot=$r->dir_config('lonDocRoot'); # Apache londocument root. - $r->print('LON-CAPA Construction Space'); + my $resdir=$docroot.'/res/'.$udom.'/'.$uname.$thisdisfn; # Resource directory + my $targetdir=$udom.'/'.$uname.$thisdisfn; # Publiction target directory. + my $linkdir='/priv/'.$uname.$thisdisfn; # Full URL name of constr space. - $r->print( - ''); + my %bombs=&Apache::lonmsg::all_url_author_res_msg($uname,$udom); - my $thisdisfn=$fn; - $thisdisfn=~s/^\/home\/$uname\/public_html//; + &startpage($r, $uname, $udom, $thisdisfn); # Put out the start of page. - $r->print('

Construction Space Directory '.$thisdisfn.'

'); + # Start off the directory table. - my $docroot=$r->dir_config('lonDocRoot'); + $r->print(''. + ''. + ''); + + my $filename; + my $dirptr=16384; # Mask indicating a directory in stat.cmode. + + opendir(DIR,$fn); + my @files=sort {uc($a) cmp uc($b)} (readdir(DIR)); + foreach my $filename (@files) { + my ($cdev,$cino,$cmode,$cnlink, + $cuid,$cgid,$crdev,$csize, + $catime,$cmtime,$cctime, + $cblksize,$cblocks)=stat($fn.'/'.$filename); + + my $extension=''; + if ($filename=~/\.(\w+)$/) { $extension=$1; } + if ($cmode&$dirptr) { + putdirectory($r, $thisdisfn, $linkdir, $filename, $cmtime,$targetdir,\%bombs); + } elsif (&Apache::loncommon::fileembstyle($extension) ne 'hdn') { + putresource($r, $uname, $filename, $thisdisfn, $resdir, + $targetdir, $linkdir, $cmtime,\%bombs); + } else { + # "hidden" extension and not a directory, so hide it away. + } + } + closedir(DIR); - my $resdir=$docroot.'/res/'.$udom.'/'.$uname.$thisdisfn; - my $linkdir='/~'.$uname.$thisdisfn; + $r->print('
'.&mt('Actions').''.&mt('Name').''. + &mt('Title').''.&mt('Status').''.&mt('Last Modified'). + '
'); + 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('LON-CAPA Construction Space'); + + $r->print(&Apache::loncommon::bodytag(undef,undef,undef,1)); + my $pubdirscript=(< +// 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(); + } + } + +ENDPUBDIRSCRIPT + + $r->print('

'.&mt('Construction Space Directory').'

'. + ''. + $pubdirscript. + '
'. + '
'. + ''. + ''. + ''. +'
'.&mt('Force publication of unmodified files').'. 
'); + + if (($uname ne $ENV{'user.name'}) || ($udom ne $ENV{'user.domain'})) { + $r->print('

'.&mt('Co-Author').': '.$uname.' at '.$udom. + '

'); + } + $r->print( + &Apache::lonhtmlcommon::crumbs($uname.'/'.$thisdisfn.'/','_top','/priv')); +} - my $filename; - opendir(DIR,$fn); - while ($filename=readdir(DIR)) { - $filename=~/\.(\w+)$/; - if (($1 ne 'meta') && ($1 ne 'save') && ($1 ne 'log')) { - $r->print($resdir.' - '.$linkdir.' = '.$filename.'
'); - } - } - closedir(DIR); +# +# 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; +} - $r->print(''); - return OK; +# +# 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, $resdir, $bombs) = @_; + + # construct the display filename: the directory name unless ..: + + my $disfilename = $dirname; + if ($dirname eq '..') { + $disfilename = ''.&mt('Parent Directory').''; + } + unless (( ($dirname eq '..') && ($reqfile eq '')) || + ($dirname eq '.')) { + my $kaputt=0; + foreach (keys %{$bombs}) { + if ($_=~/^$resdir\/$disfilename\//) { $kaputt=1; last; } + } + $r->print(''. + ''.&mt('Go to ...').''. + ''. + $disfilename.''. + ''.($kaputt?'':' ').''. + ' '. + ''.&Apache::lonlocal::locallocaltime($modtime).''. + "\n"); + } + return OK; +} +# +# Put a table row for a file resource. +# +sub putresource { + my ($r, $uname, $filename, $thisdisfn, + $resdir, $targetdir, $linkdir, + $cmtime,$bombs) = @_; + + my $status=&mt('Unpublished'); + my $bgcolor='#FFCCCC'; + my $title=' '; + 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=''. + getTitleString($targetdir.'/'.$filename, 'title').''; + } else { + $status=&mt('Modified'); + $bgcolor='#FFFFCC'; + $title=''. + getTitleString($targetdir.'/'.$filename,'title').''; + if (&Apache::loncommon::fileembstyle(($filename=~/\.(\w+)$/)) eq 'ssi') { + $status.='
'.&mt('Diffs').''; + } + } + $title.='
'. + ($$bombs{$targetdir.'/'.$filename}?'':'Edit Metadata').''; + $status.='
'.&mt('Retrieve').''; + } + my $editlink=''; + my $editlink2=''; + if ($filename=~/\.(xml|html|htm|xhtml|xhtm|sty)$/) { + $editlink=' ('.&mt('Edit').')'; + } + if ($filename=~/\.(problem|exam|quiz|assess|survey|form|library)$/) { + $editlink=' ('.&mt('EditXML').')'; + $editlink2=' ('.&mt('Edit').')'; + } + if ($filename=~/\.(zip|tar|bz2|gz|tar.gz|tar.bz2|tgz)$/) { + $editlink=' ('.&mt('Decompress').')'; + } + $r->print(''. + ''.&mt('Publish').''. + ''. + ''. + ''. + $filename.''.$editlink2.$editlink. + ''. + ''.$title.''. + ''.$status.''. + ''.&Apache::lonlocal::locallocaltime($cmtime).''. + "\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; +__END__ + +=head1 NAME + +Apache::lonpubdir - Construction space directory lister + +=head1 SYNOPSIS + +Invoked (for various locations) by /etc/httpd/conf/srm.conf: + + + 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 + + + + 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 + + +=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