--- loncom/publisher/lonpubdir.pm 2006/04/18 22:38:08 1.90
+++ loncom/publisher/lonpubdir.pm 2019/08/13 19:27:43 1.160.2.5
@@ -1,7 +1,7 @@
# The LearningOnline Network with CAPA
-# Construction Space Directory Lister
+# Authoring Space Directory Lister
#
-# $Id: lonpubdir.pm,v 1.90 2006/04/18 22:38:08 albertel Exp $
+# $Id: lonpubdir.pm,v 1.160.2.5 2019/08/13 19:27:43 raeburn Exp $
#
# Copyright Michigan State University Board of Trustees
#
@@ -33,192 +33,341 @@ 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.
+ my ($uname,$udom)=&Apache::lonnet::constructaccess($r->uri);
+ unless (($uname) && ($udom)) {
+ return HTTP_NOT_ACCEPTABLE;
+ }
+# ----------------------------------------------------------- Start page output
- $fn = getEffectiveUrl($r);
+ 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//;
- # Validate access to the construction space and get username@domain.
+ 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 $uname;
- my $udom;
+ # 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.
- ($uname,$udom)=
- &Apache::loncacc::constructaccess(
- $fn,$r->dir_config('lonDefDomain'));
- unless (($uname) && ($udom)) {
- $r->log_reason($uname.' at '.$udom.
- ' trying to list directory '.$env{'form.filename'}.
- ' ('.$fn.') - not authorized',
- $r->filename);
- return HTTP_NOT_ACCEPTABLE;
- }
+ 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;
+ }
- # Remove trailing / from directory name.
+ # 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}.'
');
+ }
+ $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) = ('','');
+ }
- $fn=~s/\/$//;
+ # 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}));
+ }
- unless ($fn) {
- $r->log_reason($env{'user.name'}.' at '.$env{'user.domain'}.
- ' trying to list empty directory', $r->filename);
- return HTTP_NOT_FOUND;
- }
+ # 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}));
+ }
+ }
-# ----------------------------------------------------------- Start page output
+ # 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//; # subdirectory part of
- # construction space.
- my $docroot=$r->dir_config('lonDocRoot'); # Apache londocument root.
-
- 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.
-
- my %bombs=&Apache::lonmsg::all_url_author_res_msg($uname,$udom);
-
- &startpage($r, $uname, $udom, $thisdisfn); # Put out the start of page.
- if ($env{'environment.remote'} eq 'off') {
- &dircontrols($r,$uname,$udom,$thisdisfn); # Put out actions for directory,
- # browse/upload + new file page.
- } else {
- &pubbuttons($r,$uname,$thisdisfn);
- }
- &resourceactions($r,$uname,$udom,$thisdisfn); #Put out form used for printing/deletion etc.
+ $r->print( &Apache::loncommon::end_data_table()
+ .&Apache::loncommon::end_page() );
- my $numdir = 0;
- my $numres = 0;
-
- # Start off the directory table.
- $r->print('
Directory Contents:
');
- $r->print('
'.
- '
'.&mt('Type').'
'.
- '
'.&mt('Actions').'
'.
- '
'.&mt('Name').'
'.
- '
'.&mt('Title').'
'.
- '
'.&mt('Status').'
'.
- '
'.&mt('Last Modified').
- '
'."\n");
-
- my $filename;
- my $dirptr=16384; # Mask indicating a directory in stat.cmode.
-
- opendir(DIR,$fn);
- my @files=sort {uc($a) cmp uc($b)} (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) {
- putdirectory($r, $thisdisfn, $linkdir, $filename, $cmtime,$targetdir,\%bombs,\$numdir);
- } elsif (&Apache::loncommon::fileembstyle($extension) ne 'hdn') {
- putresource($r, $udom, $uname, $filename, $thisdisfn, $resdir,
- $targetdir, $linkdir, $cmtime,\%bombs,\$numres);
- } else {
- # "hidden" extension and not a directory, so hide it away.
- }
- }
- closedir(DIR);
-
- $r->print('
'.&Apache::loncommon::end_page());
- 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;
+ 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);
+# 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) = @_;
- my $currdir = '/priv/'.$uname.$thisdisfn;
+ my ($r, $uname, $udom, $thisdisfn, $current_disk_usage, $disk_quota) = @_;
&Apache::loncommon::content_type($r,'text/html');
$r->send_http_header;
- my $formaction='/priv/'.$uname.$thisdisfn.'/';
+ my $formaction='/priv'.$thisdisfn.'/';
$formaction=~s|/+|/|g;
- my $pagetitle .= &Apache::loncommon::help_open_menu('','','','',3,'Authoring').
- 'Construction Space: '.
- '';
&Apache::lonhtmlcommon::store_recent('construct',$formaction,$formaction);
- if ($env{'environment.remote'} eq 'off') {
- $env{'request.noversionuri'}=$currdir.'/';
- $r->print(&Apache::loncommon::start_page('Construction Space',undef,
- {'body_title' =>
- $pagetitle,}));
- } else {
- $r->print(&Apache::loncommon::start_page('Construction Space',undef));
- $r->print($pagetitle);
- }
+ &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;
+ $r->print(&Apache::loncommon::start_page('Authoring Space'));
+
+ my $londocroot = $Apache::lonnet::perlvar{'lonDocRoot'};
+ my $current_disk_usage = &Apache::lonnet::diskusage($udom,$uname,"$londocroot/priv/$udom/$uname");
+ my $disk_quota = &Apache::loncommon::get_user_quota($uname,$udom,'author'); #expressed in MB
+ $disk_quota = 1024 * $disk_quota; # convert from MB to kB
+
+ $r->print(&Apache::loncommon::head_subbox(
+ '
'.
+ &Apache::loncommon::end_data_table_row()
+ );
+ return;
}
sub create_pubselect {
@@ -674,8 +934,10 @@ sub create_pubselect {
''.
''.
'
-';
+
+ ';
$$numres ++;
}
@@ -695,47 +957,23 @@ sub check_for_versions {
$versions ++;
}
}
+ closedir(DIR);
return $versions;
}
-#
-# 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 - Construction space directory lister
+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
@@ -782,4 +1020,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
':
+ &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');
- my $bgcolor='#FFAA99';
- my $title=' ';
- my $publish_button=&mt('Publish');
-# my $action_buttons=
-# '