--- loncom/publisher/lonpubdir.pm 2001/12/15 20:48:47 1.17
+++ loncom/publisher/lonpubdir.pm 2002/04/09 06:01:56 1.24
@@ -1,7 +1,7 @@
# The LearningOnline Network with CAPA
# (Publication Handler
#
-# $Id: lonpubdir.pm,v 1.17 2001/12/15 20:48:47 harris41 Exp $
+# $Id: lonpubdir.pm,v 1.24 2002/04/09 06:01:56 albertel Exp $
#
# Copyright Michigan State University Board of Trustees
#
@@ -37,6 +37,7 @@
# 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
#
###
@@ -55,13 +56,11 @@ 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;
@@ -76,7 +75,9 @@ sub handler {
$r->filename);
return HTTP_NOT_ACCEPTABLE;
}
-
+
+ # Remove trailing / from direcgtory name.
+
$fn=~s/\/$//;
unless ($fn) {
@@ -87,36 +88,27 @@ sub handler {
# ----------------------------------------------------------- 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');
- $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('
LON-CAPA Construction Space');
- $r->print(
- '
');
- 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.'/
');
-
- if (($uname ne $ENV{'user.name'}) || ($udom ne $ENV{'user.domain'})) {
- $r->print('Co-Author: '.$uname.' at '.$udom.
- '
');
- }
-
-
- my $docroot=$r->dir_config('lonDocRoot');
-
- my $resdir=$docroot.'/res/'.$udom.'/'.$uname.$thisdisfn;
- my $linkdir='/~'.$uname.$thisdisfn;
+ # Start off the diretory table.
$r->print(''.
- 'Filename | Modified | Status | |
');
+ 'Actions | Name | Title | '.
+ 'Status | Last Modified |
');
my $filename;
- my $dirptr=16384;
+ my $dirptr=16384; # Mask indicating a directory in stat.cmode.
opendir(DIR,$fn);
my @files=sort(readdir(DIR));
@@ -129,47 +121,10 @@ sub handler {
my $extension='';
if ($filename=~/\.(\w+)$/) { $extension=$1; }
if ($cmode&$dirptr) {
- my $disfilename=$filename;
- if ($filename eq '..') {
- $disfilename='Parent Directory';
- }
- unless ((($filename eq '..') && ($thisdisfn eq '')) ||
- ($filename eq '.')) {
- $r->print(''.$disfilename.
- ' | '.localtime($cmtime).' | | |
'
- );
- }
+ putdirectory($r, $thisdisfn, $linkdir, $filename, $cmtime);
} elsif (&Apache::loncommon::fileembstyle($extension) ne 'hdn') {
- 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::loncommon::fileembstyle(($filename=~/\.(\w+)$/)) eq 'ssi') {
- $status.='
Diffs';
- }
- }
- $status.='
Retrieve';
- }
- $r->print(''.$filename.
- ' | '.localtime($cmtime).' | '.$status.' | '.
- ''.
- 'Publish |
');
+ putresource($r, $uname, $filename, $thisdisfn, $resdir,
+ $targetdir, $linkdir, $cmtime);
} else {
# "hidden" extension and not a directory, so hide it away.
}
@@ -179,6 +134,190 @@ sub handler {
$r->print('
');
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('LON-CAPA Construction Space');
+
+ $r->print('
');
+
+ $r->print('Construction Space Directory '.
+ $thisdisfn.'/
');
+
+ if (($uname ne $ENV{'user.name'}) || ($udom ne $ENV{'user.domain'})) {
+ $r->print('Co-Author: '.$uname.' at '.$udom.
+ '
');
+ }
+}
+
+#
+# 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 = 'Parent Directory';
+ }
+ unless (( ($dirname eq '..') && ($reqfile eq '')) ||
+ ($dirname eq '.')) {
+ $r->print(''.
+ 'Click to cwd | '.
+ ''.
+ $disfilename.' | '.
+ ' | '.
+ ' | '.
+ ''.localtime($modtime).' | '.
+ '
');
+ }
+ 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=''.
+ getTitleString($targetdir.'/'.$filename, 'title').'';
+ } else {
+ $status='Modified';
+ $title=''.
+ &Apache::lonnet::metadata($targetdir.'/'.$filename,'title').'';
+ if (&Apache::loncommon::fileembstyle(($filename=~/\.(\w+)$/)) eq 'ssi') {
+ $status.='
Diffs';
+ }
+ }
+ $status.='
Retrieve';
+ }
+ $r->print(''.
+ ''.'Publish'.
+ ' | '.
+ ''.
+ ''.$filename.''.
+ ' | '.
+ ''.$title.' | '.
+ ''.$status.' | '.
+ ''.localtime($cmtime).' | '.
+ '
');
+ 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__
@@ -191,36 +330,29 @@ Apache::lonpubdir - Publication Handler
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
-
+
+ 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 enables cookie based authentication and is used
-to control access for many different LON-CAPA URIs.
-
-Whenever the client sends the cookie back to the server,
-this cookie is handled by either lonacc.pm or loncacc.pm
-(see srm.conf for what is invoked when). If
-the cookie is missing or invalid, the user is re-challenged
-for login information.
+This module publishes a directory of files.
This is part of the LearningOnline Network with CAPA project
described at http://www.lon-capa.org.