--- loncom/publisher/lonpubdir.pm 2002/02/05 12:54:46 1.21
+++ loncom/publisher/lonpubdir.pm 2014/06/20 18:00:51 1.155
@@ -1,7 +1,7 @@
# The LearningOnline Network with CAPA
-# (Publication Handler
+# Authoring Space Directory Lister
#
-# $Id: lonpubdir.pm,v 1.21 2002/02/05 12:54:46 foxr Exp $
+# $Id: lonpubdir.pm,v 1.155 2014/06/20 18:00:51 raeburn 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;
@@ -47,183 +33,843 @@ 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::londiff();
+use Apache::lonlocal;
+use Apache::lonmsg;
+use Apache::lonmenu;
+use Apache::lonnet;
+use LONCAPA qw(:DEFAULT :match);
sub handler {
- my $r=shift;
+ my $r=shift;
- my $fn;
+ # Validate access to the construction space and get username:domain.
- if ($ENV{'form.filename'}) {
- $fn=$ENV{'form.filename'};
- $fn=~s/^http\:\/\/[^\/]+\/\~(\w+)/\/home\/$1\/public_html/;
- $fn=~s/\/[^\/]+$//;
- } else {
- $fn=$r->filename();
- }
-
- 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;
- }
-
- $fn=~s/\/$//;
-
- unless ($fn) {
- $r->log_reason($ENV{'user.name'}.' at '.$ENV{'user.domain'}.
- ' trying to list empty directory', $r->filename);
- return HTTP_NOT_FOUND;
- }
+ my ($uname,$udom)=&Apache::lonnet::constructaccess($r->uri);
+ unless (($uname) && ($udom)) {
+ return HTTP_NOT_ACCEPTABLE;
+ }
# ----------------------------------------------------------- Start page output
+ my $fn=$r->filename;
+ $fn=~s/\/$//;
+ my $thisdisfn=$fn;
+
+ my $docroot=$r->dir_config('lonDocRoot'); # Apache londocument root.
+ if ($thisdisfn eq "$docroot/priv/$udom") {
+ if ((-d "/home/$uname/public_html/") && (!-e "$docroot/priv/$udom/$uname")) {
+ my ($version) = ($r->dir_config('lonVersion') =~ /^\'?(\d+\.\d+)\./);
+ &Apache::loncommon::content_type($r,'text/html');
+ $r->send_http_header;
+
+ &Apache::lonhtmlcommon::clear_breadcrumbs();
+ $r->print(&Apache::loncommon::start_page('Authoring Space').
+ '
'.
+ '
'.
+ &mt('Your Authoring Space is currently in the location used by LON-CAPA version 2.10 and older, but your domain is using a newer LON-CAPA version ([_1]).',$version).'
'.
+ '
'.
+ &mt('Please ask your Domain Coordinator to move your Authoring Space to the new location.').
+ '
'.
+ '
'.
+ &Apache::loncommon::end_page());
+ return OK;
+ }
+ }
+ $thisdisfn=~s/^\Q$docroot\E\/priv//;
+
+ my $resdir=$docroot.'/res'.$thisdisfn; # Resource directory
+ my $targetdir='/res'.$thisdisfn; # Publication target directory.
+ my $linkdir='/priv'.$thisdisfn; # Full URL name of constr space.
+
+ my %bombs=&Apache::lonmsg::all_url_author_res_msg($uname,$udom);
+
+ &startpage($r, $uname, $udom, $thisdisfn); # Put out the start of page.
+ &dircontrols($r,$uname,$udom,$thisdisfn); # Put out actions for directory,
+ # browse/upload + new file page.
+ &resourceactions($r,$uname,$udom,$thisdisfn); # Put out form used for printing/deletion etc.
- $r->content_type('text/html');
- $r->send_http_header;
+ my $numdir = 0;
+ my $numres = 0;
+
+ # Retrieving value for "sortby" and "sortorder" from QUERY_STRING
+ &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},
+ ['sortby','sortorder']);
+
+ # Sort by name as default, not reversed
+ if (! exists($env{'form.sortby'})) { $env{'form.sortby'} = 'filename' }
+ if (! exists($env{'form.sortorder'})) { $env{'form.sortorder'} = '' }
+
+ my $sortby = $env{'form.sortby'};
+ my $sortorder = $env{'form.sortorder'};
+
+ opendir(DIR,$fn);
+ my @files = readdir(DIR);
+ closedir(DIR);
+
+ if ((@files == 0) && ($thisdisfn =~ m{^/$match_domain/$match_username})) {
+ $r->print('
'.&mt('This Authoring Space is currently empty.').'
');
+ $r->print(&Apache::loncommon::end_page());
+ return OK;
+ }
- $r->print('LON-CAPA Construction Space');
+ # Start off the directory table.
+ $r->print(&Apache::loncommon::start_data_table()
+ .&Apache::loncommon::start_data_table_header_row()
+ .'
');
- } else {
- # "hidden" extension and not a directory, so hide it away.
- }
- }
- closedir(DIR);
+ function checkUpload(theform) {
+ if (theform.file == '') {
+ alert("Please use 'Browse..' to choose a file first, before uploading")
+ return
+ }
+ theform.submit()
+ }
- $r->print('
');
- return OK;
+ function SetPubDir(theform,printForm) {
+ if (theform.diraction.options[theform.diraction.selectedIndex].value == "open") {
+ top.location = theform.openname.value
+ return
+ }
+ if (theform.diraction.options[theform.diraction.selectedIndex].value == "publish") {
+ theform.submit();
+ }
+ if (theform.diraction.options[theform.diraction.selectedIndex].value == "editmeta") {
+ top.location=theform.filename.value+'default.meta'
+ }
+ if (theform.diraction.options[theform.diraction.selectedIndex].value == "printdir") {
+ theform.action = '/adm/printout'
+ theform.postdata.value = theform.filename.value
+ theform.submit()
+ }
+ if (theform.diraction.options[theform.diraction.selectedIndex].value == "delete") {
+ var delform = document.delresource
+ delform.filename.value = theform.filename.value
+ delform.submit()
+ }
+ return
+ }
+ function SetResChoice(theform) {
+ var activity = theform.reschoice.options[theform.reschoice.selectedIndex].value
+ if ((activity == 'rename') || (activity == 'copy') || (activity == 'move')) {
+ changename(theform,activity)
+ }
+ if (activity == 'publish') {
+ var pubform = document.pubresource
+ pubform.filename.value = theform.filename.value
+ pubform.submit()
+ }
+ if (activity == 'delete') {
+ var delform = document.delresource
+ delform.filename.value = theform.filename.value
+ delform.submit()
+ }
+ if (activity == 'obsolete') {
+ var pubform = document.pubresource
+ pubform.filename.value = theform.filename.value
+ pubform.makeobsolete.value=1;
+ pubform.submit()
+ }
+ if (activity == 'print') {
+ document.printresource.postdata.value = theform.filename.value
+ document.printresource.submit()
+ }
+ if (activity == 'retrieve') {
+ document.retrieveres.filename.value = theform.filename.value
+ document.retrieveres.submit()
+ }
+ if (activity == 'cleanup') {
+ document.cleanup.filename.value = theform.filename.value
+ document.cleanup.submit()
+ }
+ return
+ }
+ function changename(theform,activity) {
+ var oldname=theform.dispfilename.value;
+ var newname=prompt('$newname',oldname);
+ if (newname == "" || !newname || newname == oldname) {
+ return
+ }
+ document.moveresource.newfilename.value = newname
+ document.moveresource.filename.value = theform.filename.value
+ document.moveresource.action.value = activity
+ document.moveresource.submit();
+ }
+
+ENDPUBDIRSCRIPT
+ $r->print($pubdirscript);
+}
+
+sub dircontrols {
+ my ($r,$uname,$udom,$thisdisfn) = @_;
+ my %lt=&Apache::lonlocal::texthash(
+ cnpd => 'Cannot publish directory',
+ cnrd => 'Cannot retrieve directory',
+ mcdi => 'Must create new subdirectory inside a directory',
+ pubr => 'Publish this Resource',
+ pubd => 'Publish this Directory',
+ dedr => 'Delete Directory',
+ rtrv => 'Retrieve Old Version',
+ list => 'List Directory',
+ uplo => 'Upload file',
+ dele => 'Delete',
+ edit => 'Edit Metadata',
+ sela => 'Select Action',
+ nfil => 'New file',
+ nhtm => 'New HTML file',
+ nprb => 'New problem',
+ npag => 'New assembled page',
+ nseq => 'New assembled sequence',
+ ncrf => 'New custom rights file',
+ nsty => 'New style file',
+ nlib => 'New library file',
+ nbt => 'New bridgetask file',
+ nsub => 'New subdirectory',
+ renm => 'Rename current file to',
+ move => 'Move current file to',
+ copy => 'Copy current file to',
+ type => 'Type Name Here',
+ go => 'Go',
+ prnt => 'Print contents of directory',
+ crea => 'Create a new directory or LON-CAPA document',
+ acti => 'Actions for current directory',
+ updc => 'Upload a new document',
+ pick => 'Please select an action to perform using the new filename',
+ );
+ my $mytype = $lt{'type'}; # avoid conflict with " and ' in javascript
+ $r->print(<
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+END
+}
+
+sub resourceactions {
+ my ($r,$uname,$udom,$thisdisfn) = @_;
+ $r->print(<
+
+
+
+
+
+
+
+
+
+END
+}
+
+#
+# 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;
+}
+
+sub getCopyRightString {
+ my $fullname = shift;
+ return &Apache::lonnet::metadata($fullname, 'copyright');
+}
+
+sub getSourceRightString {
+ my $fullname = shift;
+ return &Apache::lonnet::metadata($fullname, 'sourceavail');
}
#
# 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.
-#
+# putdirectory(r, base, here, dirname, modtime, targetdir, bombs, numdir)
+# 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.
+# targetdir - Publication target directory.
+# bombs - Reference to hash of URLs with runtime error messages.
+# numdir - Reference to scalar used to track number of sub-directories
+# in directory (used in form name for each "actions" dropdown).
+#
sub putdirectory {
- my ($r, $reqfile, $here, $dirname, $modtime) = @_;
-
- # construct the display filename: the directory name unless ..:
-
+ my ($r, $reqfile, $here, $dirname, $modtime, $targetdir, $bombs, $numdir) = @_;
+
+# construct the display filename: the directory name unless ..:
+
+ my $actionitem;
+
my $disfilename = $dirname;
- if ($dirname eq '..') {
- $disfilename = 'Parent Directory';
+# Don't display directory itself, and there is no way up from root directory
+ unless ((($dirname eq '..') && ($reqfile=~/^\/[^\/]+\/[^\/]+$/)) || ($dirname eq '.')) {
+ my $kaputt=0;
+ if (ref($bombs) eq 'HASH') {
+ foreach my $key (keys(%{$bombs})) {
+ my $currentdir = &Apache::lonnet::declutter("$targetdir/$disfilename");
+ if (($key) =~ m{^\Q$currentdir\E/}) { $kaputt=1; last; }
+ }
+ }
+#
+# Get the metadata from that directory's default.meta to display titles
+#
+ %Apache::lonpublisher::metadatafields=();
+ %Apache::lonpublisher::metadatakeys=();
+ &Apache::lonpublisher::metaeval(
+ &Apache::lonnet::getfile($r->dir_config('lonDocRoot').$here.'/'.$dirname.'/default.meta')
+ );
+ if ($dirname eq '..') {
+ $actionitem = &mt('Go to ...');
+ $disfilename = ''.&mt('Parent Directory').'';
+ } else {
+ $actionitem =
+ '';
+ $$numdir ++;
+ }
+ $r->print('
'.
+ &Apache::loncommon::end_data_table_row()
+ );
+ return;
+}
+
+sub create_pubselect {
+ my ($r,$pub_select,$udom,$uname,$thisdisfn,$filename,$resdir,$pubstatus,$publish_button,$numres) = @_;
+ $$pub_select = '
+';
+ $$numres ++;
+}
+
+sub check_for_versions {
+ my ($r,$fn,$udom,$uname) = @_;
+ my $versions = 0;
+ my $docroot=$r->dir_config('lonDocRoot');
+ my $resfn=$docroot.'/res/'.$udom.'/'.$uname.$fn;
+ my $resdir=$resfn;
+ $resdir=~s/\/[^\/]+$/\//;
+ $fn=~/\/([^\/]+)\.(\w+)$/;
+ my $main=$1;
+ my $suffix=$2;
+ opendir(DIR,$resdir);
+ while (my $filename=readdir(DIR)) {
+ if ($filename=~/^\Q$main\E\.(\d+)\.\Q$suffix\E$/) {
+ $versions ++;
+ }
+ }
+ closedir(DIR);
+ return $versions;
+}
+
1;
__END__
+
=head1 NAME
-Apache::lonpubdir - Publication Handler for Directories
+Apache::lonpubdir - Authoring space directory lister
=head1 SYNOPSIS
Invoked (for various locations) by /etc/httpd/conf/srm.conf:
-
+
PerlAccessHandler Apache::loncacc
SetHandler perl-script
PerlHandler Apache::lonpubdir
@@ -270,4 +916,47 @@ run through list of files and attempt to
=back
+=head1 SUBROUTINES:
+
+=over
+
+=item startpage($r, $uame, $udom, $thisdisfn)
+
+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.
+
+=item getTitleString($fullname)
+
+ 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.
+
+=item putdirectory($r, $base, $here, $dirname, $modtime, $targetdir, $bombs,
+ $numdir)
+
+ Put out a directory table row:
+
+ $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.
+ targetdir - Publication target directory.
+ bombs - Reference to hash of URLs with runtime error messages.
+ numdir - Reference to scalar used to track number of sub-directories
+ in directory (used in form name for each "actions" dropdown).
+
+=back
+
=cut
');
+ # Print the sorted resources
+ foreach my $filename (@sorted_files) {
+ if ($filehash->{$filename}->{"cmode"}&$dirptr) { # Directories
+ &putdirectory($r, $thisdisfn, $linkdir, $filename,
+ $filehash->{$filename}->{"cmtime"},
+ $targetdir, \%bombs, \$numdir);
+ } else { # Files
+ &putresource($r, $udom, $uname, $filename, $thisdisfn, $resdir,
+ $targetdir, $linkdir, $filehash->{$filename}->{"cmtime"},
+ $filehash->{$filename}->{"size"}, \$numres,
+ $filehash->{$filename}->{"linkfilename"},
+ $filehash->{$filename}->{"fulltitle"},
+ $filehash->{$filename}->{"status"},
+ $filehash->{$filename}->{"pubstatus"});
+ }
+ }
- my $thisdisfn=$fn;
- $thisdisfn=~s/^\/home\/$uname\/public_html//;
-
- $r->print('
':
+ &mt('Edit Metadata')).
+ '';
+
+ return ($title, $titleString);
+}
+
+
+sub isMetaSame {
+ my ($cstr_dir, $resdir, $filename) = @_;
+ my $meta_cmtime = (stat($cstr_dir.'/'.$filename.'.meta'))[9];
+ my $meta_rmtime = (stat($resdir.'/'.$filename.'.meta'))[9];
+ return (&Apache::londiff::are_different_files($resdir.'/'.$filename.'.meta',
+ $cstr_dir.'/'.$filename.'.meta') && $meta_rmtime < $meta_cmtime)
+ ? 0 : 1;
+}
+
+
+sub getStatus {
+ my ($resdir, $targetdir, $cstr_dir, $filename,
+ $linkfilename, $cmtime, $meta_same) = @_;
+ my $pubstatus = 'unpublished';
+ my $status = &mt('Unpublished');
+
+ if (-e $resdir.'/'.$filename) {
+ my $same = 0;
+ if ((stat($resdir.'/'.$filename))[9] >= $cmtime) {
+ $same = 1;
+ } else {
+ if (&Apache::londiff::are_different_files($resdir.'/'.$filename,
+ $cstr_dir.'/'.$filename)) {
+ $same = 0;
+ } else {
+ $same = 1;
+ }
+ }
+
+ my $rights_status =
+ &mt(&getCopyRightString($targetdir.'/'.$filename)).', ';
+
+ my %lt_SourceRight = &Apache::lonlocal::texthash(
+ 'open' => 'Source: open',
+ 'closed' => 'Source: closed',
+ );
+ $rights_status .=
+ $lt_SourceRight{&getSourceRightString($targetdir.'/'.$filename)};
+
+ if ($same) {
+ if (&Apache::lonnet::metadata($targetdir.'/'.$filename,'obsolete')) {
+ $pubstatus = 'obsolete';
+ $status=&mt('Obsolete');
+ } else {
+ if (!$meta_same) {
+ $pubstatus = 'metamodified';
+ } else {
+ $pubstatus = 'published';
+ }
+ $status=&mt('Published').
+ '