--- loncom/publisher/lonpubdir.pm 2001/05/03 11:04:07 1.5
+++ loncom/publisher/lonpubdir.pm 2002/04/09 06:01:56 1.24
@@ -1,16 +1,45 @@
# The LearningOnline Network with CAPA
-#
# (Publication Handler
+#
+# $Id: lonpubdir.pm,v 1.24 2002/04/09 06:01:56 albertel 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.
+#
+# 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/
+#
#
# (TeX Content Handler
#
+# YEAR=2000
# 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
+# YEAR=2001
# 03/23 Guy Albertelli
# 03/24,03/29 Gerd Kortemeyer)
+# 03/31,04/03,05/09,06/23,08/18,08/20 Gerd Kortemeyer
+# 12/15 Scott Harrison
+# 12/28 Gerd Kortemeyer
#
-# 03/31,04/03 Gerd Kortemeyer
+###
package Apache::lonpubdir;
@@ -18,7 +47,8 @@ use strict;
use Apache::File;
use File::Copy;
use Apache::Constants qw(:common :http :methods);
-
+use Apache::loncacc;
+use Apache::loncommon();
sub handler {
@@ -26,14 +56,28 @@ 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 publish file '.$ENV{'form.filename'}.
+ ' ('.$fn.') - not authorized',
+ $r->filename);
+ return HTTP_NOT_ACCEPTABLE;
}
-
+
+ # Remove trailing / from direcgtory name.
+
$fn=~s/\/$//;
unless ($fn) {
@@ -44,75 +88,45 @@ sub handler {
# ----------------------------------------------------------- Start page output
- my $uname=$ENV{'user.name'};
- my $udom=$ENV{'user.domain'};
+ 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');
- $r->send_http_header;
+ my $resdir=$docroot.'/res/'.$udom.'/'.$uname.$thisdisfn; # Resource directory
+ my $targetdir=$udom.'/'.$uname.$thisdisfn; # Publiction target directory.
+ my $linkdir='/~'.$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;
- $thisdisfn=~s/^\/home\/$uname\/public_html//;
+ startpage($r, $uname, $udom, $thisdisfn); # Put out the start of page.
- $r->print('<h1>Construction Space Directory <tt>'.$thisdisfn.'/</tt></h1>');
-
- my $docroot=$r->dir_config('lonDocRoot');
-
- my $resdir=$docroot.'/res/'.$udom.'/'.$uname.$thisdisfn;
- my $linkdir='/~'.$uname.$thisdisfn;
+ # Start off the diretory table.
$r->print('<table border=2>'.
- '<tr><th>Filename</th><th>Modified</th><th>Status</th></tr>');
+ '<tr><th>Actions</th><th>Name</th><th>Title</th>'.
+ '<th>Status</th><th>Last Modified</th></tr>');
my $filename;
- my $dirptr=16384;
+ my $dirptr=16384; # Mask indicating a directory in stat.cmode.
opendir(DIR,$fn);
- while ($filename=readdir(DIR)) {
+ my @files=sort(readdir(DIR));
+ foreach my $filename (@files) {
my ($cdev,$cino,$cmode,$cnlink,
$cuid,$cgid,$crdev,$csize,
$catime,$cmtime,$cctime,
$cblksize,$cblocks)=stat($fn.'/'.$filename);
- $filename=~/\.(\w+)$/;
- if (($1 ne 'meta') && (&Apache::lonnet::fileembstyle($1))) {
- my $status='Unpublished';
- my $bgcol='#FFBBBB';
- 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='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> </td></tr>');
- }
+
+ my $extension='';
+ if ($filename=~/\.(\w+)$/) { $extension=$1; }
+ if ($cmode&$dirptr) {
+ putdirectory($r, $thisdisfn, $linkdir, $filename, $cmtime);
+ } elsif (&Apache::loncommon::fileembstyle($extension) ne 'hdn') {
+ putresource($r, $uname, $filename, $thisdisfn, $resdir,
+ $targetdir, $linkdir, $cmtime);
+ } else {
+ # "hidden" extension and not a directory, so hide it away.
}
}
closedir(DIR);
@@ -120,6 +134,247 @@ sub handler {
$r->print('</table></body></html>');
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\:\/\/[^\/]+\/\~(\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|;
+ }
+ }
+ 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) = @_;
+
+ $r->content_type('text/html');
+ $r->send_http_header;
+
+ $r->print('<html><head><title>LON-CAPA Construction Space</title></head>');
+
+ $r->print('<body bgcolor="#FFFFFF"><img align=right '.
+ 'src=/adm/lonIcons/lonlogos.gif>');
+
+ $r->print('<h1>Construction Space Directory <tt>'.
+ $thisdisfn.'/</tt></h1>');
+
+ if (($uname ne $ENV{'user.name'}) || ($udom ne $ENV{'user.domain'})) {
+ $r->print('<h3>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 = "[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>Parent Directory</i>';
+ }
+ unless (( ($dirname eq '..') && ($reqfile eq '')) ||
+ ($dirname eq '.')) {
+ $r->print('<tr>'.
+ '<td>Click to cwd</td>'.
+ '<td><a href="'.$here.'/'.$dirname.'/">'.
+ $disfilename.'</a></td>'.
+ '<td> </td>'.
+ '<td> </td>'.
+ '<td>'.localtime($modtime).'</td>'.
+ '</tr>');
+ }
+ 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 $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='Published';
+ $title='<a href="/res/'.$targetdir.'/'.$filename.
+ '.meta" target=cat>'.
+ getTitleString($targetdir.'/'.$filename, 'title').'</a>';
+ } else {
+ $status='Modified';
+ $title='<a href="/res/'.$targetdir.'/'.$filename.'.meta" target=cat>'.
+ &Apache::lonnet::metadata($targetdir.'/'.$filename,'title').'</a>';
+ if (&Apache::loncommon::fileembstyle(($filename=~/\.(\w+)$/)) eq 'ssi') {
+ $status.='<br><a href="/adm/diff?filename=/~'.$uname.
+ $thisdisfn.'/'.$filename.
+ '&versionone=priv" target=cat>Diffs</a>';
+ }
+ }
+ $status.='<br><a href="/adm/retrieve?filename=/~'.$uname.
+ $thisdisfn.'/'.$filename.'" target=cat>Retrieve</a>';
+ }
+ $r->print('<tr>'.
+ '<td><a target="_parent" href="/adm/publish?filename=/~'.
+ $uname.$thisdisfn.'/'.$filename.'">'.'Publish</a>'.
+ '</td>'.
+ '<td>'.
+ '<a href="'.$linkdir.'/'.$filename.'">'.$filename.'</a>'.
+ '</td>'.
+ '<td>'.$title.'</td>'.
+ '<td>'.$status.'</td>'.
+ '<td>'.localtime($cmtime).'</td>'.
+ '</tr>');
+ 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 - Publication Handler for Directories
+
+=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