--- loncom/publisher/lonpubdir.pm 2007/10/18 21:58:21 1.104 +++ loncom/publisher/lonpubdir.pm 2014/04/06 19:39:04 1.151 @@ -1,7 +1,7 @@ # The LearningOnline Network with CAPA -# Construction Space Directory Lister +# Authoring Space Directory Lister # -# $Id: lonpubdir.pm,v 1.104 2007/10/18 21:58:21 albertel Exp $ +# $Id: lonpubdir.pm,v 1.151 2014/04/06 19:39:04 raeburn Exp $ # # Copyright Michigan State University Board of Trustees # @@ -33,7 +33,6 @@ 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(); @@ -47,136 +46,116 @@ sub handler { my $r=shift; - my $fn; - - - - $fn = getEffectiveUrl($r); - - # Validate access to the construction space and get username@domain. + # Validate access to the construction space and get username:domain. my $uname; my $udom; - ($uname,$udom)= - &Apache::loncacc::constructaccess( - $fn,$r->dir_config('lonDefDomain')); + ($uname,$udom)=&Apache::lonnet::constructaccess($r->uri); 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; } - # Remove trailing / from directory name. +# ----------------------------------------------------------- Start page output + my $fn=$r->filename; $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; - } - -# ----------------------------------------------------------- Start page output - my $thisdisfn=$fn; - $thisdisfn=~s/^\/home\/$uname\/public_html//; # subdirectory part of - # construction space. my $docroot=$r->dir_config('lonDocRoot'); # Apache londocument root. + $thisdisfn=~s/^\Q$docroot\E\/priv//; - 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 $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. - if ($env{'environment.remote'} eq 'off') { - &dircontrols($r,$uname,$udom,$thisdisfn); # Put out actions for directory, + &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. my $numdir = 0; my $numres = 0; + # Retrieving value for sortby from QUERY_STRING + &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},['sortby']); + + # Default sort by 'Name' + if (! exists($env{'form.sortby'})) { + $env{'form.sortby'} = 'filename'; + } + # Start off the directory table. - $r->print('

Directory Contents:

'); - $r->print(''. - ''. - ''. - ''. - ''. - ''. - ''."\n"); + $r->print(&Apache::loncommon::start_data_table() + .&Apache::loncommon::start_data_table_header_row() + .'' + .'' + .'' + .'' + .'' + .'' + .&Apache::loncommon::end_data_table_header_row() + ); my $filename; my $dirptr=16384; # Mask indicating a directory in stat.cmode. opendir(DIR,$fn); + my $filehash = {}; + my $sortby = $env{'form.sortby'}; 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. + next if ($filename eq '.DS_Store'); + my ($cmode,$cmtime)=(stat($fn.'/'.$filename))[2,9]; + # If you want to sort by "last modified", we need to make this hash. + if ($sortby eq 'cmtime') { + $filehash->{ $filename } = {"cmtime" => $cmtime,}; } - } + # Otherwise sort by name. Don't bother with filehash. Continue printing contents. + else { + 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. + } + } + }; + + # Sorting files by "last modified" if that's what you selected + if ($sortby eq 'cmtime') { + my @sorted_files = sort { + $filehash->{$b}->{$sortby} <=> $filehash->{$a}->{$sortby} + } (keys(%{$filehash})); + foreach my $filename (@sorted_files) { + my ($cmode,$cmtime)=(stat($fn.'/'.$filename))[2,9]; + 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'). - '
'.&mt('Type').''.&mt('Actions').''.&mt('Name').' ▼'.&mt('Title').''.&mt('Status').''.&mt('Last Modified').' ▼
'.&Apache::loncommon::end_page()); + $r->print(&Apache::loncommon::end_data_table() + .&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}; - } - } - $fn=~s/\/+/\//g; - return $fn; -} + # # Output the header of the page. This includes: # - The HTML header @@ -190,39 +169,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'). - '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',undef)); + + 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('Authoring Space'); + my $newname = &mt('New Name'); my $pubdirscript=(< -top.document.title = '$esc_thisdisfn/ - LON-CAPA Construction Space'; +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 @@ -231,7 +215,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' ) { @@ -261,7 +245,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") { @@ -313,7 +297,7 @@ parent.lastknownpriv='/~$uname$esc_thisd } function changename(theform,activity) { var oldname=theform.dispfilename.value; - var newname=prompt('New Name',oldname); + var newname=prompt('$newname',oldname); if (newname == "" || !newname || newname == oldname) { return } @@ -325,12 +309,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 { @@ -346,7 +324,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', @@ -362,82 +340,87 @@ sub dircontrols { move => 'Move current file to', copy => 'Copy current file to', type => 'Type Name Here', - go => 'Go', + 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' + 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(< - - $lt{'acti'} - $lt{'updc'} - $lt{'crea'} - - - -
- - + - - -
-
- - -
-
- -
- - -
- - - -
- - -
- - -    + + + + +
+ + +
+
+ +
+ + +
+
+
+ $lt{'updc'} + + + +
+
+
+ +
+
+
+ $lt{'crea'} + + + +    - - - - +
+ +
+ END } -sub pubbuttons { - my ($r,$uname,$thisdisfn) = @_; - $r->print('
'. - '
'. - ''. -'
'); -} - sub resourceactions { my ($r,$uname,$udom,$thisdisfn) = @_; $r->print(<'; - } - unless ( (($dirname eq '..') && ($reqfile eq '')) || ($dirname eq '.')) { - my $kaputt=0; - foreach (keys %{$bombs}) { - if ($_=~m:^\Q$resdir\E/\Q$disfilename\E/:) { $kaputt=1; last; } - } +# 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=(); - my $construct=$here; - $construct=~s{^/priv/($LONCAPA::username_re)$}{/home/$1/public_html}; - my $dirpath = $here; - $dirpath=~s{^/priv/}{/~}; - &Apache::lonpublisher::metaeval(&Apache::lonnet::getfile( - $construct.'/'.$dirname.'/default.meta' - )); - my $actionitem = ''; + &Apache::lonpublisher::metaeval( + &Apache::lonnet::getfile($r->dir_config('lonDocRoot').$here.'/'.$dirname.'/default.meta') + ); if ($dirname eq '..') { - $actionitem = 'Go to ...'; + $actionitem = &mt('Go to ...'); + $disfilename = ''.&mt('Parent Directory').''; } else { $actionitem = '
'.&mt('Select action').''. ''. ''. - ''. + ''. ''. ''. ''. - ''. + ''. ''. ''. '
'; @@ -548,11 +538,11 @@ sub putdirectory { } $r->print(''. 'folder'. + $Apache::lonnet::perlvar{'lonIconsURL'}.'/navmap.folder.closed.gif" alt="folder" />'. ''.$actionitem.''. ''. $disfilename.''. - ''.($kaputt?&Apache::lonhtmlcommon::authorbombs($resdir.'/'.$disfilename.'/'):'').$Apache::lonpublisher::metadatafields{'title'}); + ''.($kaputt?&Apache::lonhtmlcommon::authorbombs($targetdir.'/'.$disfilename.'/'):'').$Apache::lonpublisher::metadatafields{'title'}); if ($Apache::lonpublisher::metadatafields{'subject'} ne '') { $r->print(' '. $Apache::lonpublisher::metadatafields{'subject'}. @@ -575,13 +565,11 @@ sub putresource { my $pubstatus = 'unpublished'; my $status=&mt('Unpublished'); my $css_class='LC_browser_file'; - my $title=' '; + my $title=''; my $publish_button=&mt('Publish'); - my $cstr_dir = '/home/'.$uname.'/public_html/'.$thisdisfn.'/'; -# my $action_buttons= -# '
'. -# &mt('Delete').''; + my $cstr_dir = $r->dir_config('lonDocRoot').'/priv'.$thisdisfn; + my $linkfilename=&HTML::Entities::encode('/priv'.$thisdisfn.'/'.$filename,'<>&"'); + if (-e $resdir.'/'.$filename) { my $same=0; my ($rdev,$rino,$rmode,$rnlink, @@ -607,10 +595,18 @@ sub putresource { $meta_same = 0; } $publish_button=&mt('Re-publish'); - my $rights_status = - &mt(&getCopyRightString($targetdir.'/'.$filename)).' '. - &mt(&getSourceRightString($targetdir.'/'.$filename)); - $title = ''. &getTitleString($targetdir.'/'.$filename).''; if ($same) { @@ -626,55 +622,58 @@ sub putresource { $status=&mt('Published'). '
'. $rights_status; } -# } else { -# $action_buttons=''; -# } } else { $pubstatus = 'modified'; $status=&mt('Modified'). '
'. $rights_status; -# $action_buttons=''; if (&Apache::loncommon::fileembstyle(($filename=~/\.(\w+)$/)) eq 'ssi') { - $status.='
'.&mt('Diffs').''; + $status.='
'. + &Apache::loncommon::modal_link( + '/adm/diff?filename='.$linkfilename.'&versiontwo=priv', + &mt('Diffs'),600,500); } } - - $title.="\n".'
'. - ($$bombs{$targetdir.'/'.$filename}?'bomb':'Edit Metadata').''; - if (!$meta_same) { $title = &mt('Metadata Modified').'
'.$title. - '
'.&mt('Metadata Diffs').''; - $title.="\n".'
'.&mt('Retrieve Metadata').''; + '
'. + &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); } - $status.="\n".'
'.&mt('Retrieve').''; - } + $status.="\n".'
'. + &Apache::loncommon::modal_link( + '/adm/retrieve?filename='.$linkfilename.'&inhibitmenu=yes&add_modal=yes',&mt('Retrieve'),600,500); + } + # Allow editing metadata of published and unpublished resources + $title .= "\n".'
' if ($title); + $title .= ''. + ($$bombs{&Apache::lonnet::declutter($targetdir.'/'.$filename)}? + ''.&mt('bomb').'': + &mt('Edit Metadata')). + ''; + my $editlink=''; my $editlink2=''; if ($filename=~/\.(xml|html|htm|xhtml|xhtm|sty)$/) { - $editlink='
('.&mt('Edit').')'; + $editlink='
('.&mt('Edit').')'; } - if ($filename=~/\.(problem|exam|quiz|assess|survey|form|library)$/) { - $editlink=' ('.&mt('EditXML').')'; - $editlink2='
('.&mt('Edit').')'; + if ($filename=~/$LONCAPA::assess_re/) { + $editlink=' ('.&mt('EditXML').')'; + $editlink2='
('.&mt('Edit').')'; } if ($filename=~/\.(problem|exam|quiz|assess|survey|form|library|xml|html|htm|xhtml|xhtm|sty)$/) { - $editlink.=' ('.&mt('Clean Up').')'; + $editlink.=' ('.&mt('Clean Up').')'; } if ($filename=~/\.(zip|tar|bz2|gz|tar.gz|tar.bz2|tgz)$/) { - $editlink=' ('.&mt('Decompress').')'; + $editlink=' ('.&mt('Decompress').')'; } my $pub_select = ''; &create_pubselect($r,\$pub_select,$udom,$uname,$thisdisfn,$filename,$resdir,$pubstatus,$publish_button,$numres); - $r->print(''. + $r->print(&Apache::loncommon::start_data_table_row(). ''.($filename=~/[\#\~]$/?' ': '').''. ''.$pub_select.''. @@ -683,9 +682,11 @@ sub putresource { $filename.'
'.$editlink2.$editlink. ''. ''.$title.''. - ''.$status.''. + '  '. # Display publication status + ''.$status.''. ''.&Apache::lonlocal::locallocaltime($cmtime).''. - "\n"); + &Apache::loncommon::end_data_table_row() + ); return OK; } @@ -716,8 +717,8 @@ sub create_pubselect { ''. ''. ' - + '; $$numres ++; @@ -742,44 +743,19 @@ sub check_for_versions { 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 @@ -826,4 +802,48 @@ 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 +