# The LearningOnline Network with CAPA
# Authoring Space Directory Lister
#
# $Id: lonpubdir.pm,v 1.183 2024/01/10 20:07:37 raeburn 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/
#
###
package Apache::lonpubdir;
use strict;
use Apache::File;
use File::Copy;
use Apache::Constants qw(:common :http :methods);
use Apache::loncommon();
use Apache::lonhtmlcommon();
use Apache::londiff();
use Apache::lonpublisher();
use Apache::lonlocal;
use Apache::lonmsg;
use Apache::lonmenu;
use Apache::lonnet;
use LONCAPA qw(:DEFAULT :match);
sub handler {
my $r=shift;
# Validate access to the construction space and get username:domain.
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 $cstr = 'author';
my ($crsauthor,$crstype,$crstoplevel,$cdom,$cnum);
if ($env{'request.course.id'}) {
$cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
$cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
if ($thisdisfn =~ m{^/\Q$cdom/$cnum\E}) {
$crsauthor = 1;
$cstr = 'course';
$crstype = &Apache::loncommon::course_type();
$crstoplevel = "$docroot/priv/$cdom/$cnum";
}
}
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,
$cstr,$crstype); # expressed in MB
# Put out the start of page.
&startpage($r, $uname, $udom, $thisdisfn, $current_disk_usage, $disk_quota, $crsauthor);
my @files;
if (!-d $fn) {
if (($crsauthor) && ($fn eq $crstoplevel)) {
my $path = "$docroot/priv/$cdom/$cnum";
my $rightsfile = 'default.rights';
my $sourcerights = "$path/$rightsfile";
&Apache::loncommon::crsauthor_rights($rightsfile,$path,$docroot,$cnum,$cdom);
my $targetrights = $docroot."/res/$cdom/$cnum/$rightsfile";
if ((-e $sourcerights) && (-e "$sourcerights.meta")) {
if (!-e "$docroot/res/$cdom") {
mkdir("$docroot/res/$cdom",0755);
}
if (!-e "$docroot/res/$cdom/$cnum") {
mkdir("$docroot/res/$cdom/$cnum",0755);
}
if ((-e "$docroot/res/$cdom/$cnum") && (!-e $targetrights)) {
my $nokeyref = &Apache::lonpublisher::getnokey($r->dir_config('lonIncludes'));
my $output = &Apache::lonpublisher::batchpublish($r,$sourcerights,$targetrights,$nokeyref,1);
}
} else {
$r->print('
'.&mt('The requested subdirectory does not exist.').'
');
$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,$crsauthor);
&resourceactions($r,$uname,$udom,$thisdisfn); # Put out form used for printing/deletion etc.
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}) ?
'
');
}
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);
if (($crsauthor) && ($extension eq 'rights')) {
$title = &getTitleString($targetdir.'/'.$filename);
$fulltitle = $title;
} else {
($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
my %editors = &Apache::loncommon::permitted_editors();
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, $crsauthor,
$filehash->{$filename}->{"cmtime"},
$filehash->{$filename}->{"size"}, \$numres,
$filehash->{$filename}->{"linkfilename"},
$filehash->{$filename}->{"fulltitle"},
$filehash->{$filename}->{"status"},
$filehash->{$filename}->{"pubstatus"},
\%editors);
}
}
$r->print(&Apache::loncommon::end_data_table()
.'
'
.&Apache::loncommon::start_data_table()
.'
'.&mt('Results in other directories:').'
'
.'
'
.'
'.&mt('Type').'
'
.'
'.&mt('Directory').'
'
.'
'.&mt('Name').'
'
.'
'.&mt('Title').'
'
.'
'.&mt('Status').'
'
.'
'.&mt('Last Modified').'
'
.'
'
.&Apache::loncommon::end_data_table()
.'
'
.&Apache::loncommon::end_page()
);
return OK;
}
# 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).
# $crstype - Course type, if this is for "course author"
sub startpage {
my ($r, $uname, $udom, $thisdisfn, $current_disk_usage, $disk_quota, $crsauthor) = @_;
&Apache::loncommon::content_type($r,'text/html');
$r->send_http_header;
my $formaction='/priv'.$thisdisfn.'/';
$formaction=~s|/+|/|g;
my $title;
if ($crsauthor) {
$title = 'Course Authoring';
} else {
$title = 'Authoring Space';
&Apache::lonhtmlcommon::store_recent('construct',$formaction,$formaction);
}
&Apache::lonhtmlcommon::clear_breadcrumbs();
&Apache::lonhtmlcommon::add_breadcrumb({
'text' => $title,
'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($title, $js));
$disk_quota = 1024 * $disk_quota; # convert from MB to kB
my $headertext = &mt('Directory');
if ($crsauthor) {
$headertext = &mt('Course Authoring Directory');
}
$r->print(&Apache::loncommon::head_subbox(
'
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('
'.
&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