--- loncom/publisher/lonpubdir.pm 2002/02/05 12:54:46 1.21
+++ loncom/publisher/lonpubdir.pm 2003/12/22 19:30:25 1.48
@@ -1,7 +1,7 @@
# The LearningOnline Network with CAPA
-# (Publication Handler
+# Construction Space Directory Lister
#
-# $Id: lonpubdir.pm,v 1.21 2002/02/05 12:54:46 foxr Exp $
+# $Id: lonpubdir.pm,v 1.48 2003/12/22 19:30:25 www Exp $
#
# Copyright Michigan State University Board of Trustees
#
@@ -25,20 +25,6 @@
#
# 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
-#
###
package Apache::lonpubdir;
@@ -49,6 +35,8 @@ use File::Copy;
use Apache::Constants qw(:common :http :methods);
use Apache::loncacc;
use Apache::loncommon();
+use Apache::lonhtmlcommon();
+use Apache::lonlocal;
sub handler {
@@ -56,13 +44,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;
@@ -72,12 +58,14 @@ sub handler {
$fn,$r->dir_config('lonDefDomain'));
unless (($uname) && ($udom)) {
$r->log_reason($uname.' at '.$udom.
- ' trying to publish file '.$ENV{'form.filename'}.
+ ' 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) {
@@ -88,41 +76,32 @@ 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='/priv/'.$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//;
-
- $r->print('Construction Space Directory '.$thisdisfn.'/
');
+ &startpage($r, $uname, $udom, $thisdisfn); # Put out the start of page.
- 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 $targetdir=$udom.'/'.$uname.$thisdisfn;
- my $linkdir='/~'.$uname.$thisdisfn;
+ # Start off the diretory table.
$r->print(''.
- 'Actions | Name | Title | '.
- 'Status | Last Modified |
');
+ ''.&mt('Actions').' | '.&mt('Name').' | '.
+ &mt('Title').' | '.
+ ''.&mt('Status').' | '.&mt('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));
+ my @files=sort {uc($a) cmp uc($b)} (readdir(DIR));
foreach my $filename (@files) {
my ($cdev,$cino,$cmode,$cnlink,
$cuid,$cgid,$crdev,$csize,
@@ -134,44 +113,8 @@ sub handler {
if ($cmode&$dirptr) {
putdirectory($r, $thisdisfn, $linkdir, $filename, $cmtime);
} elsif (&Apache::loncommon::fileembstyle($extension) ne 'hdn') {
- 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=
- ''.
- &Apache::lonnet::metadata($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).' | '.
- '
');
+ putresource($r, $uname, $filename, $thisdisfn, $resdir,
+ $targetdir, $linkdir, $cmtime);
} else {
# "hidden" extension and not a directory, so hide it away.
}
@@ -182,6 +125,127 @@ sub handler {
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.
+ '');
+
+ if (($uname ne $ENV{'user.name'}) || ($udom ne $ENV{'user.domain'})) {
+ $r->print(''.&mt('Co-Author').': '.$uname.' at '.$udom.
+ '
');
+ }
+ $r->print(
+ &Apache::lonhtmlcommon::crumbs($thisdisfn,'_top','/priv/'.$uname));
+}
+
+#
+# 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.
@@ -197,27 +261,120 @@ sub putdirectory {
my $disfilename = $dirname;
if ($dirname eq '..') {
- $disfilename = 'Parent Directory';
+ $disfilename = ''.&mt('Parent Directory').'';
}
unless (( ($dirname eq '..') && ($reqfile eq '')) ||
($dirname eq '.')) {
- $r->print(''.
- 'Click to cwd | '.
- ''.
+ $r->print(''.
+ ''.&mt('Go to ...').' | '.
+ ''.
$disfilename.' | '.
' | '.
' | '.
- ''.localtime($modtime).' | '.
- ' ');
+ ' | '.&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) = @_;
+
+ 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').'';
+ }
+ }
+ $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 - Publication Handler for Directories
+Apache::lonpubdir - Construction space directory lister
=head1 SYNOPSIS