--- loncom/publisher/lonpubdir.pm 2008/11/10 14:11:08 1.112 +++ loncom/publisher/lonpubdir.pm 2014/08/05 19:32:23 1.160 @@ -1,7 +1,7 @@ # The LearningOnline Network with CAPA -# Construction Space Directory Lister +# Authoring Space Directory Lister # -# $Id: lonpubdir.pm,v 1.112 2008/11/10 14:11:08 jms Exp $ +# $Id: lonpubdir.pm,v 1.160 2014/08/05 19:32:23 musolffc Exp $ # # Copyright Michigan State University Board of Trustees # @@ -27,125 +27,12 @@ # ### -=head1 NAME - -Apache::lonpubdir - Construction 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 - -=head2 OTHER SUBROUTINES: - -=head3 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. - -=head3 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. - -=head3 putdirectory(r, base, here, dirname, modtime) - - 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. - -=head3 CategorizeFiles($location, $files) - - 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. - -=cut - package Apache::lonpubdir; 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(); @@ -153,143 +40,273 @@ use Apache::lonlocal; use Apache::lonmsg; use Apache::lonmenu; use Apache::lonnet; -use LONCAPA; +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//; + + my $resdir=$docroot.'/res'.$thisdisfn; # Resource directory + my $targetdir='/res'.$thisdisfn; # Publication target directory. + my $linkdir='/priv'.$thisdisfn; # Full URL name of constr space. - # Validate access to the construction space and get username@domain. + my %bombs=&Apache::lonmsg::all_url_author_res_msg($uname,$udom); - my $uname; - my $udom; + &startpage($r, $uname, $udom, $thisdisfn); # Put out the start of page. - ($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; - } + 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; + } - # Remove trailing / from directory name. + &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. - $fn=~s/\/$//; + 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; + } - unless ($fn) { - $r->log_reason($env{'user.name'}.' at '.$env{'user.domain'}. - ' trying to list empty directory', $r->filename); - return HTTP_NOT_FOUND; - } + # 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) = ('',''); + } -# ----------------------------------------------------------- Start page output + # 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})); + } - 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. + # 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})); + } + } - my $numdir = 0; - my $numres = 0; - - # Start off the directory table. - $r->print('

'.&mt('Directory Contents:').'

'); - $r->print(''. - ''. - ''. - ''. - ''. - ''. - ''."\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('
'.&mt('Type').''.&mt('Actions').''.&mt('Name').''.&mt('Title').''.&mt('Status').''.&mt('Last Modified'). - '
'.&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{~($LONCAPA::username_re)}{/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{^/~($LONCAPA::username_re)}{/home/$1/public_html}; - } + # 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"}); + } } - $fn=~s/\/+/\//g; - return $fn; + + $r->print( &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. @@ -302,41 +319,44 @@ sub getEffectiveUrl { sub startpage { my ($r, $uname, $udom, $thisdisfn) = @_; - my $currdir = '/priv/'.$uname.$thisdisfn; &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'). - ''.&mt('Construction Space').': '. - '
'. - &Apache::lonhtmlcommon::crumbs($uname.$thisdisfn.'/','_top','/priv','','+1',1)."
". - &Apache::lonhtmlcommon::select_recent('construct','recent', - 'this.form.action=this.form.recent.value;this.form.submit()'). - '
'; &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, - { 'only_body' => 1,})); - $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 = 1000 * $disk_quota; # convert from MB to kB + + $r->print(&Apache::loncommon::head_subbox( + '
' + .&Apache::lonhtmlcommon::display_usage($current_disk_usage,$disk_quota) + .'
' + .&Apache::loncommon::CSTR_pageheader())); my $esc_thisdisfn = &Apache::loncommon::escape_single($thisdisfn); - my $doctitle = 'LON-CAPA '.&mt('Construction Space'); + 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='/~$uname$esc_thisdisfn/'; +parent.lastknownpriv='/priv$esc_thisdisfn/'; // Confirmation dialogues @@ -345,7 +365,7 @@ parent.lastknownpriv='/~$uname$esc_thisd document.publishdir.filename.value = theform.filename.value; document.publishdir.submit(); } - if (theform.dirtask.options[theform.dirtask.selectedIndex].value == 'editcat') { + 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' ) { @@ -375,7 +395,7 @@ parent.lastknownpriv='/~$uname$esc_thisd if (theform.diraction.options[theform.diraction.selectedIndex].value == "publish") { theform.submit(); } - if (theform.diraction.options[theform.diraction.selectedIndex].value == "editcat") { + 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") { @@ -439,12 +459,6 @@ parent.lastknownpriv='/~$uname$esc_thisd ENDPUBDIRSCRIPT $r->print($pubdirscript); - - if ((($uname ne $env{'user.name'}) || ($udom ne $env{'user.domain'})) && - $env{'environment.remote'} ne 'off') { - $r->print('

'.&mt('Co-Author').': '.$uname.' at '.$udom. - '

'); - } } sub dircontrols { @@ -460,7 +474,7 @@ sub dircontrols { list => 'List Directory', uplo => 'Upload file', dele => 'Delete', - edit => 'Edit Catalog Information', + edit => 'Edit Metadata', sela => 'Select Action', nfil => 'New file', nhtm => 'New HTML file', @@ -485,43 +499,47 @@ sub dircontrols { ); my $mytype = $lt{'type'}; # avoid conflict with " and ' in javascript $r->print(< - - $lt{'acti'} - $lt{'updc'} - $lt{'crea'} - - - -
- - + - - -
-
- - -
-
- -
- - -
- - - -
- - -
- - + + + + +
+ + +
+
+ +
+ + +
+
+
+ $lt{'updc'} + + + +
+
+
+ +
+
+
+ $lt{'crea'} + +