--- loncom/publisher/lonpubdir.pm 2001/12/04 15:34:57 1.16
+++ loncom/publisher/lonpubdir.pm 2016/06/10 22:31:34 1.168
@@ -1,7 +1,7 @@
# The LearningOnline Network with CAPA
-# (Publication Handler
+# Authoring Space Directory Lister
#
-# $Id: lonpubdir.pm,v 1.16 2001/12/04 15:34:57 albertel Exp $
+# $Id: lonpubdir.pm,v 1.168 2016/06/10 22:31:34 raeburn Exp $
#
# Copyright Michigan State University Board of Trustees
#
@@ -25,16 +25,7 @@
#
# http://www.lon-capa.org/
#
-#
-# (TeX Content Handler
-#
-# 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
-# 03/23 Guy Albertelli
-# 03/24,03/29 Gerd Kortemeyer)
-#
-# 03/31,04/03,05/09,06/23,08/18,08/20 Gerd Kortemeyer
+###
package Apache::lonpubdir;
@@ -42,140 +33,1204 @@ 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();
+ my $js = '';
+ $r->print(&Apache::loncommon::start_page('Authoring Space', $js).
+ '
'.
+ '
'.
+ &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);
+
+ my $londocroot = $Apache::lonnet::perlvar{'lonDocRoot'};
+ my $current_disk_usage = &Apache::lonnet::diskusage($udom,$uname,
+ "$londocroot/priv/$udom/$uname"); # expressed in kB
+ my $disk_quota = &Apache::loncommon::get_user_quota($uname,$udom,
+ 'author'); # expressed in MB
+
+ # Put out the start of page.
+ &startpage($r, $uname, $udom, $thisdisfn, $current_disk_usage, $disk_quota);
+
+ if (!-d $fn) {
+ if (-e $fn) {
+ $r->print(''.&mt('Requested item is a file not a directory.').'
');
+ } else {
+ $r->print(''.&mt('The requested subdirectory does not exist.').'
');
+ }
+ $r->print(&Apache::loncommon::end_page());
+ return OK;
+ }
+ my @files;
+ if (opendir(DIR,$fn)) {
+ @files = grep(!/^\.+$/,readdir(DIR));
+ closedir(DIR);
+ } else {
+ $r->print(''.&mt('Could not open directory.').'
');
+ $r->print(&Apache::loncommon::end_page());
+ return OK;
+ }
+
+ # Put out actions for directory, browse/upload + new file page.
+ &dircontrols($r,$uname,$udom,$thisdisfn, $current_disk_usage, $disk_quota);
+ &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;
+
+ if ((@files == 0) && ($thisdisfn =~ m{^/$match_domain/$match_username})) {
+ if ($thisdisfn =~ m{^/$match_domain/$match_username$}) {
+ $r->print(''.&mt('This Authoring Space is currently empty.').'
');
+ } else {
+ $r->print(''.&mt('This subdirectory is currently empty.').'
');
+ }
+ $r->print(&Apache::loncommon::end_page());
+ return OK;
+ }
+
+ # 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'};
+
+ # Order in which columns are displayed from left to right
+ my @order = ('filetype','actions','filename','title',
+ 'pubstatus','cmtime','size');
+
+ # Up and down arrows to indicate sort order
+ my @arrows = (' ▲',' ▼','');
+
+ # Default sort order and column title
+ my %columns = (
+ filetype => {
+ order => 'ascending',
+ text => &mt('Type'),
+ },
+ actions => {
+ # Not sortable
+ text => &mt('Actions'),
+ },
+ filename => {
+ order => 'ascending',
+ text => &mt('Name'),
+ },
+ title => {
+ order => 'ascending',
+ text => &mt('Title'),
+ },
+ pubstatus => {
+ order => 'ascending',
+ text => &mt('Status'),
+ colspan => '2',
+ },
+ cmtime => {
+ order => 'descending',
+ text => &mt('Last Modified'),
+ },
+ size => {
+ order => 'ascending',
+ text => &mt('Size').' (kB)',
+ },
+ );
+
+ # Print column headers
+ my $output = '';
+ foreach my $key (@order) {
+ my $idx;
+ # Append an up or down arrow to sorted column
+ if ($sortby eq $key) {
+ $idx = ($columns{$key}{order} eq 'ascending') ? 0:1;
+ if ($sortorder eq 'rev') { $idx ++; }
+ $idx = $idx%2;
+ } else { $idx = 2; } # No arrow if column is not sorted
+ $output .= (($columns{$key}{order}) ?
+ ''
+ .$columns{$key}{text}.$arrows[$idx].' ' :
+ ''.$columns{$key}{text}.' ');
+ }
+
+my $result = "";
+ $r->print($result);
+
+ $r->print(''.&Apache::loncommon::start_data_table()
+ .'
'
+ .&Apache::loncommon::start_data_table_header_row() . $output
+ .&Apache::loncommon::end_data_table_header_row()
+ );
+
+ my $dirptr=16384; # Mask indicating a directory in stat.cmode.
+ my $filehash = {};
+ foreach my $filename (@files) {
+ # Skip .DS_Store, .DAV and hidden files
+ my ($extension) = ($filename=~/\.(\w+)$/);
+ next if (($filename eq '.DS_Store')
+ || ($filename eq '.DAV')
+ || (&Apache::loncommon::fileembstyle($extension) eq 'hdn')
+ || ($filename =~ /^\._/));
+
+ my ($cmode,$csize,$cmtime)=(stat($fn.'/'.$filename))[2,7,9];
+ my $linkfilename = &HTML::Entities::encode('/priv'.$thisdisfn.'/'.$filename,'<>&"');
+ # Identify type of file according to icon used
+ my ($filetype) = (&Apache::loncommon::icon($filename) =~ m{/(\w+).gif$});
+ my $cstr_dir = $r->dir_config('lonDocRoot').'/priv'.$thisdisfn;
+ my $meta_same = &isMetaSame($cstr_dir, $resdir, $filename);
+
+ # Store size, title, and status for files but not directories
+ my $size = (!($cmode&$dirptr)) ? $csize/1024. : 0;
+ my ($status, $pubstatus, $title, $fulltitle);
+ if (!($cmode&$dirptr)) {
+ ($status, $pubstatus) = &getStatus($resdir, $targetdir, $cstr_dir,
+ $filename, $linkfilename, $cmtime, $meta_same);
+ ($fulltitle, $title) = &getTitle($resdir, $targetdir, $filename,
+ $linkfilename, $meta_same, \%bombs);
+ } else {
+ ($status, $pubstatus) = ('','');
+ ($fulltitle, $title) = ('','');
+ }
+
+ # This hash will allow sorting
+ $filehash->{ $filename } = {
+ "cmtime" => $cmtime,
+ "size" => $size,
+ "cmode" => $cmode,
+ "filetype" => $filetype,
+ "title" => $title,
+ "fulltitle" => $fulltitle,
+ "status" => $status,
+ "pubstatus" => $pubstatus,
+ "linkfilename" => $linkfilename,
+ }
+ }
+
+ my @sorted_files;
+ # Sorting by something other than "Name". Name is the secondary key.
+ if ($sortby =~ m{cmtime|size}) { # Numeric fields
+ # First check if order should be reversed
+ if ($sortorder eq "rev") {
+ @sorted_files = sort {
+ $filehash->{$a}->{$sortby} <=> $filehash->{$b}->{$sortby}
+ or
+ uc($a) cmp uc($b)
+ } (keys(%{$filehash}));
+ } else {
+ @sorted_files = sort {
+ $filehash->{$b}->{$sortby} <=> $filehash->{$a}->{$sortby}
+ or
+ uc($a) cmp uc($b)
+ } (keys(%{$filehash}));
+ }
+ } elsif ($sortby =~ m{filetype|title|status}) { # String fields
+ if ($sortorder eq "rev") {
+ @sorted_files = sort {
+ $filehash->{$b}->{$sortby} cmp $filehash->{$a}->{$sortby}
+ or
+ uc($a) cmp uc($b)
+ } (keys(%{$filehash}));
+ } else {
+ @sorted_files = sort {
+ $filehash->{$a}->{$sortby} cmp $filehash->{$b}->{$sortby}
+ or
+ uc($a) cmp uc($b)
+ } (keys(%{$filehash}));
+ }
+
+ # Sort by "Name" is the default
+ } else {
+ if ($sortorder eq "rev") {
+ @sorted_files = sort {uc($b) cmp uc($a)} (keys(%{$filehash}));
+ } else {
+ @sorted_files = sort {uc($a) cmp uc($b)} (keys(%{$filehash}));
+ }
+ }
+
+ # 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"});
+ }
+ }
+
+ $r->print(&Apache::loncommon::end_data_table()
+ .''
+ .&Apache::loncommon::start_data_table()
+ .'
'.&mt('Results in other directories:').' '
+ .''
+ .&Apache::loncommon::end_data_table()
+ .''
+ .&Apache::loncommon::end_page()
+ );
+ return OK;
+}
- $r->print('LON-CAPA Construction Space ');
- $r->print(
- ' ');
- my $thisdisfn=$fn;
- $thisdisfn=~s/^\/home\/$uname\/public_html//;
-
- $r->print('Construction Space Directory '.$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, $current_disk_usage, $disk_quota);
+# $r - The apache request object.
+# $uname - User name.
+# $udom - Domain name the user is logged in under.
+# $thisdisfn - Displayable version of the filename.
+# $current_disk_usage - User's current disk usage (in kB).
+# $disk_quota - Disk quota for user's authoring space (in MB).
+
+sub startpage {
+ my ($r, $uname, $udom, $thisdisfn, $current_disk_usage, $disk_quota) = @_;
+ &Apache::loncommon::content_type($r,'text/html');
+ $r->send_http_header;
+
+ my $formaction='/priv'.$thisdisfn.'/';
+ $formaction=~s|/+|/|g;
+ &Apache::lonhtmlcommon::store_recent('construct',$formaction,$formaction);
+
+ &Apache::lonhtmlcommon::clear_breadcrumbs();
+ &Apache::lonhtmlcommon::add_breadcrumb({
+ 'text' => 'Authoring Space',
+ 'href' => &Apache::loncommon::authorspace($formaction),
+ });
+ # breadcrumbs (and tools) will be created
+ # in start_page->bodytag->innerregister
+
+ $env{'request.noversionuri'}=$formaction;
+ my $js = '';
+ $r->print(&Apache::loncommon::start_page('Authoring Space', $js));
+
+ $disk_quota = 1024 * $disk_quota; # convert from MB to kB
+
+ $r->print(&Apache::loncommon::head_subbox(
+ ''
+ .&Apache::lonhtmlcommon::display_usage($current_disk_usage,
+ $disk_quota,'authoring')
+ .'
'
+ .&Apache::loncommon::CSTR_pageheader()));
+
+ my $esc_thisdisfn = &Apache::loncommon::escape_single($thisdisfn);
+ my $doctitle = 'LON-CAPA '.&mt('Authoring Space');
+ my $newname = &mt('New Name');
+ my $pubdirscript=(<
+top.document.title = '$esc_thisdisfn/ - $doctitle';
+// Store directory location for menu bar to find
+
+parent.lastknownpriv='/priv$esc_thisdisfn/';
+
+// Confirmation dialogues
+
+ function currdiract(theform) {
+ if (theform.dirtask.options[theform.dirtask.selectedIndex].value == 'publish') {
+ document.publishdir.filename.value = theform.filename.value;
+ document.publishdir.submit();
+ }
+ if (theform.dirtask.options[theform.dirtask.selectedIndex].value == 'editmeta') {
+ top.location=theform.filename.value+'default.meta'
+ }
+ if (theform.dirtask.options[theform.dirtask.selectedIndex].value == 'printdir' ) {
+ document.printdir.postdata.value=theform.filename.value
+ document.printdir.submit();
+ }
+ if (theform.dirtask.options[theform.dirtask.selectedIndex].value == "delete") {
+ var delform = document.delresource
+ delform.filename.value = theform.filename.value
+ delform.submit()
+ }
+ }
- 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;
-
- $r->print(''.
- 'Filename Modified Status ');
-
- my $filename;
- my $dirptr=16384;
-
- opendir(DIR,$fn);
- 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);
-
- 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).' '
- );
- }
- } elsif (&Apache::lonnet::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';
+ function checkUpload(theform) {
+ if (theform.file == '') {
+ alert("Please use 'Browse..' to choose a file first, before uploading")
+ return
+ }
+ theform.submit()
+ }
+
+ 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, $current_disk_usage, $disk_quota) = @_;
+ 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',
+ qs => 'Quick Search',
+ cs => 'Case Sensitive',
+ re => 'Regular Expression',
+ 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
+ # Calculate free space in bytes.
+ # $disk_quota is in MB and $current_disk_usage is in kB
+ my $free_space = 1024 * ((1024 * $disk_quota) - $current_disk_usage);
+ $r->printf(<
+
+
+
+
+
+
+
+
+
+
+
+
+
+ $lt{'qs'}
+
+
+
+ %s
+
+ $lt{'cs'}
+ $lt{'re'}
+
+
+
+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, 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, $targetdir, $bombs, $numdir) = @_;
+
+# construct the display filename: the directory name unless ..:
+
+ my $actionitem;
+
+ my $disfilename = $dirname;
+# 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(''.
+ ' '.
+ ''.$actionitem.' '.
+ ''.
+ $disfilename.' '.
+ ''.($kaputt?&Apache::lonhtmlcommon::authorbombs($targetdir.'/'.$disfilename.'/'):'').$Apache::lonpublisher::metadatafields{'title'});
+ if ($Apache::lonpublisher::metadatafields{'subject'} ne '') {
+ $r->print(' '.
+ $Apache::lonpublisher::metadatafields{'subject'}.
+ ' ');
+ }
+ $r->print($Apache::lonpublisher::metadatafields{'keywords'}.' '.
+ ''.&Apache::lonlocal::locallocaltime($modtime).' '.
+ ' '.
+ " \n");
+ }
+ return;
+}
+
+sub getTitle {
+ my ($resdir, $targetdir, $filename, $linkfilename, $meta_same, $bombs) = @_;
+ my $title='';
+ my $titleString = &getTitleString($targetdir.'/'.$filename);
+ if (-e $resdir.'/'.$filename) {
+ $title = ''.$titleString.' ';
+ if (!$meta_same) {
+ $title = &mt('Metadata Modified').' '.$title.
+ ' '.
+ &Apache::loncommon::modal_link(
+ '/adm/diff?filename='.$linkfilename.'.meta'.'&versiontwo=priv',
+ &mt('Metadata Diffs'),600,500);
+ $title.="\n".' '.
+ &Apache::loncommon::modal_link(
+ '/adm/retrieve?filename='.$linkfilename.'.meta&inhibitmenu=yes&add_modal=yes',
+ &mt('Retrieve Metadata'),600,500);
+ }
+ }
+ # Allow editing metadata of published and unpublished resources
+ $title .= "\n".' ' if ($title);
+ $title .= ''.
+ ($$bombs{&Apache::lonnet::declutter($targetdir.'/'.$filename)}?
+ ' ':
+ &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 {
- $status='Modified';
- $bgcol='#FFFFBB';
- if
- (&Apache::lonnet::fileembstyle(($filename=~/\.(\w+)$/)) eq 'ssi') {
- $status.='Diffs ';
- }
- }
- $status.='Retrieve ';
- }
- $r->print(''.$filename.
- ' '.localtime($cmtime).' '.$status.' '.
- ''.
- 'Publish ');
- } else {
- # "hidden" extension and not a directory, so hide it away.
- }
- }
- closedir(DIR);
+ if (!$meta_same) {
+ $pubstatus = 'metamodified';
+ } else {
+ $pubstatus = 'published';
+ }
+ $status=&mt('Published').
+ ' '. $rights_status;
+ }
+ } else {
+ $pubstatus = 'modified';
+ $status=&mt('Modified').
+ ' '. $rights_status;
+ if (&Apache::loncommon::fileembstyle(($filename=~/\.(\w+)$/)) eq 'ssi') {
+ $status.=' '.
+ &Apache::loncommon::modal_link(
+ '/adm/diff?filename='.$linkfilename.'&versiontwo=priv',
+ &mt('Diffs'),600,500);
+ }
+ }
+
+ $status.="\n".' '.
+ &Apache::loncommon::modal_link(
+ '/adm/retrieve?filename='.$linkfilename.'&inhibitmenu=yes&add_modal=yes',&mt('Retrieve'),600,500);
+ }
- $r->print('
');
- return OK;
+ return ($status, $pubstatus);
}
+
+#
+# Put a table row for a file resource.
+#
+sub putresource {
+ my ($r, $udom, $uname, $filename, $thisdisfn, $resdir, $targetdir,
+ $linkdir, $cmtime, $size, $numres, $linkfilename, $title,
+ $status, $pubstatus) = @_;
+ &Apache::lonnet::devalidate_cache_new('meta',$targetdir.'/'.$filename);
+
+ my $editlink='';
+ my $editlink2='';
+ if ($filename=~/\.(xml|html|htm|xhtml|xhtm|sty)$/) {
+ $editlink=' ('.&mt('Edit').' )';
+ }
+ if ($filename=~/$LONCAPA::assess_re/) {
+ $editlink=' ('.&mt('EditXML').' )';
+ $editlink2=' ('.&mt('Edit').' )';
+ }
+ if ($filename=~/\.(xml|html|htm|xhtml|xhtm)$/ || $filename=~/$LONCAPA::assess_re/) {
+ if ($env{'browser.type'} ne 'explorer' || $env{'browser.version'} > 9) {
+ my $daxeurl = '/daxepage'.$linkdir.'/'.$filename;
+ $editlink .= ' (Daxe )';
+ }
+ }
+ if ($filename=~/\.(problem|exam|quiz|assess|survey|form|library|xml|html|htm|xhtml|xhtm|sty)$/) {
+ $editlink.=' ('.&mt('Clean Up').') ';
+ }
+ if ($filename=~/\.(zip|tar|bz2|gz|tar.gz|tar.bz2|tgz)$/) {
+ $editlink=' ('.&mt('Decompress').' )';
+ }
+ my $publish_button = (-e $resdir.'/'.$filename) ? &mt('Re-publish') : &mt('Publish');
+ my $pub_select = '';
+ &create_pubselect($r,\$pub_select,$udom,$uname,$thisdisfn,$filename,$resdir,$pubstatus,$publish_button,$numres);
+ $r->print(&Apache::loncommon::start_data_table_row().
+ ''.($filename=~/[\#\~]$/?' ':
+ ' ').' '.
+ ''.$pub_select.' '.
+ ''.
+ ''.
+ $filename.' '.$editlink2.$editlink.
+ ' '.
+ ''.$title.' '.
+ ' '. # Display publication status
+ ''.$status.' '.
+ ''.&Apache::lonlocal::locallocaltime($cmtime).' '.
+ ''.sprintf("%.1f",$size).' '.
+ &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;
+}
+
+sub prepareJsonTranslations {
+ my $json =
+ '{"translations":{'.
+ '"edit":"'.&mt('Edit').'",'.
+ '"editxml":"'.&mt('EditXML').'",'.
+ '"editmeta":"'.&mt('Edit Metadata').'",'.
+ '"obsolete":"'.&mt('Obsolete').'",'.
+ '"modified":"'.&mt('Modified').'",'.
+ '"published":"'.&mt('Published').'",'.
+ '"unpublished":"'.&mt('Unpublished').'",'.
+ '"diff":"'.&mt('Diff').'",'.
+ '"retrieve":"'.&mt('Retrieve').'",'.
+ '"directory":"'.&mt('Directory').'",'.
+ '"results":"'.&mt('Show results for keyword:').'"'.
+ '}}';
+}
+
+# gathers all files in the working directory except the ones that are already on screen
+sub prepareJsonData {
+ my ($uname, $udom, $pathToSkip) = @_;
+ my $path = "/home/httpd/html/priv/$udom/$uname/";
+
+ # maximum number of entries, to limit workload and required storage space
+ my $entries = 100;
+ my $firstfile = 1;
+ my $firstdir = 1;
+
+ my $json = '{"resources":[';
+ $json .= &prepareJsonData_rec($path, \$entries, \$firstfile, \$firstdir, $pathToSkip);
+ $json .= ']}';
+
+ # if the json string is invalid the whole search breaks.
+ # so we want to make sure that the string is valid in any case.
+ $json =~ s/,\s*,/,/g;
+ $json =~ s/\}\s*\{/\},\{/g;
+ $json =~ s/\}\s*,\s*\]/\}\]/g;
+ return $json;
+}
+
+# recursive part of json file gathering
+sub prepareJsonData_rec {
+ my ($path, $entries, $firstfile, $firstdir, $pathToSkip) = @_;
+ my $json;
+ my $skipThisFolder = $path =~ m/$pathToSkip\/$/?1:0;
+
+ my @dirs;
+ my @resources;
+ my @ignored = qw(bak log meta save . ..);
+
+# Phase 1: Gathering
+ opendir(DIR,$path);
+ my @files=sort {uc($a) cmp uc($b)} (readdir(DIR));
+ foreach my $filename (@files) {
+ next if ($filename eq '.DS_Store');
+
+ # gather all resources
+ if ($filename !~ /\./) {
+ # its a folder
+ push(@dirs, $filename);
+ } else {
+ # only push files we dont want to ignore
+ next if ($skipThisFolder);
+
+ $filename =~ /\.(\w+?)$/;
+ unless (grep /$1/, @ignored) {
+ push(@resources, $filename);
+ }
+ }
+ }
+ closedir(DIR);
+ # nothing to do here if both lists are empty
+ return unless ( @dirs || @resources );
+
+# Phase 2: Working
+ $$firstfile = 1;
+
+ foreach (@dirs) {
+ $json .= '{"name":"'.$_.'",'.
+ '"path":"'.$path.$_.'",'.
+ '"title":"",'.
+ '"status":"",'.
+ '"cmtime":""},';
+ }
+
+ foreach (@resources) {
+ last if ($$entries < 1);
+ my $title = &getTitleString($path.$_);
+
+ my $privpath = $path.$_;
+ my $respath = $privpath;
+ $respath =~ s/httpd\/html\/priv\//httpd\/html\/res\//;
+
+ my $cmtime = (stat($privpath))[9];
+ my $rmtime = (stat($respath))[9];
+
+ unless ($$firstfile) { $json .= ','; } else { $$firstfile = 0; }
+
+ my $status = 'unpublished';
+
+ # if a resource is published, the published version (/html/res/filepath) gets its own modification time
+ # this is newer or equal then the version in your authoring space (/html/priv/filepath)
+ if ($rmtime >= $cmtime) {
+ # obsolete
+ if (&Apache::lonnet::metadata($respath, 'obsolete')) {
+ $status = 'obsolete';
+ }else{
+ $status = 'published';
+ }
+ } else {
+ $status = 'modified';
+ }
+
+ $json .= '{"name":"'.$_.'",'.
+ '"path":"'.$path.'",'.
+ '"title":"'.$title.'",'.
+ '"status":"'.$status.'",'.
+ '"cmtime":"'.&Apache::lonlocal::locallocaltime($cmtime).'"}';
+ $$entries--;
+ }
+
+ foreach(@dirs) {
+ next if ($$entries < 1);
+ $json .= ',';
+ $json .= &prepareJsonData_rec
+ ($path.$_.'/', $entries, $firstfile, $firstdir, $pathToSkip);
+ }
+ return $json;
+}
1;
__END__
+
+
+=head1 NAME
+
+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
+ 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
+
+=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