--- loncom/publisher/lonpubdir.pm 2004/11/08 22:42:20 1.65 +++ loncom/publisher/lonpubdir.pm 2008/11/17 13:41:10 1.113 @@ -1,7 +1,7 @@ # The LearningOnline Network with CAPA # Construction Space Directory Lister # -# $Id: lonpubdir.pm,v 1.65 2004/11/08 22:42:20 albertel Exp $ +# $Id: lonpubdir.pm,v 1.113 2008/11/17 13:41:10 schafran Exp $ # # Copyright Michigan State University Board of Trustees # @@ -27,6 +27,118 @@ # ### +=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; @@ -36,10 +148,12 @@ use Apache::Constants qw(:common :http : 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; sub handler { @@ -61,7 +175,7 @@ sub handler { $fn,$r->dir_config('lonDefDomain')); unless (($uname) && ($udom)) { $r->log_reason($uname.' at '.$udom. - ' trying to list directory '.$ENV{'form.filename'}. + ' trying to list directory '.$env{'form.filename'}. ' ('.$fn.') - not authorized', $r->filename); return HTTP_NOT_ACCEPTABLE; @@ -72,7 +186,7 @@ sub handler { $fn=~s/\/$//; unless ($fn) { - $r->log_reason($ENV{'user.name'}.' at '.$ENV{'user.domain'}. + $r->log_reason($env{'user.name'}.' at '.$env{'user.domain'}. ' trying to list empty directory', $r->filename); return HTTP_NOT_FOUND; } @@ -91,9 +205,11 @@ sub handler { 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') { + 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. @@ -101,15 +217,15 @@ sub handler { my $numres = 0; # Start off the directory table. - $r->print('

Directory Contents:

'); - $r->print(''. - ''. - ''. - ''. - ''. - ''. - ''); + $r->print('

'.&mt('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. @@ -135,7 +251,7 @@ sub handler { } closedir(DIR); - $r->print('
'.&mt('Type').''.&mt('Actions').''.&mt('Name').''.&mt('Title').''.&mt('Status').''.&mt('Last Modified'). + '
'); + $r->print(''.&Apache::loncommon::end_page()); return OK; } # @@ -146,15 +262,15 @@ sub getEffectiveUrl { my $r = shift; my $fn; - if ($ENV{'form.filename'}) { # If a form filename is defined. - $fn=$ENV{'form.filename'}; + 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/; + $fn=~s{~($LONCAPA::username_re)}{/home/$1/public_html}; # Remove trailing / strings (?) @@ -167,7 +283,7 @@ sub getEffectiveUrl { #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{^/~($LONCAPA::username_re)}{/home/$1/public_html}; } } $fn=~s/\/+/\//g; @@ -190,72 +306,59 @@ sub startpage { &Apache::loncommon::content_type($r,'text/html'); $r->send_http_header; - $r->print('LON-CAPA Construction Space'); - - my $pagetitle; - my $formaction='/priv/'.$uname.'/'.$thisdisfn; - $formaction=~s/\/+/\//g; - $pagetitle .= ('
'. - 'Construction Space: '. - &Apache::lonhtmlcommon::crumbs($uname.'/'.$thisdisfn,'top','/priv','','-1'). + my $formaction='/priv/'.$uname.$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::bodytag('Construction Space',undef,undef,undef,undef,undef,$pagetitle)); + ''; + &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); } - $r->print(&Apache::loncommon::help_open_menu('','','','',3,'Authoring')); + + my $esc_thisdisfn = &Apache::loncommon::escape_single($thisdisfn); + my $doctitle = 'LON-CAPA '.&mt('Construction Space'); + my $newname = &mt('New Name'); my $pubdirscript=(< + ENDPUBDIRSCRIPT $r->print($pubdirscript); - if (($uname ne $ENV{'user.name'}) || ($udom ne $ENV{'user.domain'})) { + if ((($uname ne $env{'user.name'}) || ($udom ne $env{'user.domain'})) && + $env{'environment.remote'} ne 'off') { $r->print('

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

'); } @@ -367,68 +449,121 @@ ENDPUBDIRSCRIPT sub dircontrols { my ($r,$uname,$udom,$thisdisfn) = @_; + 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', + 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 $r->print(< + - - - + + + - - -
Actions for current directoryUpload a new documentCreate a new directory or LON-CAPA document$lt{'acti'}$lt{'updc'}$lt{'crea'}
+
- + + + + +
-
- -
+
- +
+
- + +    - + + + + + + + + + + + +    +
-
-
END } +sub pubbuttons { + my ($r,$uname,$thisdisfn) = @_; + $r->print('
'. + '
'. + ''. +'
'); +} + sub resourceactions { my ($r,$uname,$udom,$thisdisfn) = @_; $r->print(<
- - +
- -
+
+ +
END } @@ -510,43 +645,46 @@ sub putdirectory { %Apache::lonpublisher::metadatafields=(); %Apache::lonpublisher::metadatakeys=(); my $construct=$here; - $construct=~s:^/priv/(\w+)$:/home/$1/public_html:; + $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 = ''; if ($dirname eq '..') { - $actionitem = 'Go to ...'; + $actionitem = &mt('Go to ...'); } else { $actionitem = '
'. - ''. ''. ''. ''. - ''. - ''. - ''. + ''. + ''. ''. - ''. - ''. - ''. - ''. - ''. + ''. + ''. ''. '
'; $$numdir ++; } - $r->print(''. + $r->print(''. ''. + $Apache::lonnet::perlvar{'lonIconsURL'}.'/folder_closed.gif" alt="folder" />'. ''.$actionitem.''. - ''. - $disfilename.''. - ''.($kaputt?&Apache::lonhtmlcommon::authorbombs($resdir.'/'.$disfilename.'/'):'').$Apache::lonpublisher::metadatafields{'title'}.' '. - $Apache::lonpublisher::metadatafields{'subject'}.' '. - $Apache::lonpublisher::metadatafields{'keywords'}.''. + ''. + $disfilename.''. + ''.($kaputt?&Apache::lonhtmlcommon::authorbombs($resdir.'/'.$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"); } @@ -559,56 +697,88 @@ sub putresource { my ($r, $udom, $uname, $filename, $thisdisfn, $resdir, $targetdir, $linkdir, $cmtime,$bombs,$numres) = @_; + &Apache::lonnet::devalidate_cache_new('meta',$targetdir.'/'.$filename); my $pubstatus = 'unpublished'; my $status=&mt('Unpublished'); - my $bgcolor='#FFAA99'; + my $css_class='LC_browser_file'; my $title=' '; my $publish_button=&mt('Publish'); + my $cstr_dir = '/home/'.$uname.'/public_html/'.$thisdisfn.'/'; # my $action_buttons= # '
'. # &mt('Delete').''; if (-e $resdir.'/'.$filename) { + my $same=0; my ($rdev,$rino,$rmode,$rnlink, $ruid,$rgid,$rrdev,$rsize, $ratime,$rmtime,$rctime, $rblksize,$rblocks)=stat($resdir.'/'.$filename); + if ($rmtime>=$cmtime) { + $same=1; + } else { + if (&Apache::londiff::are_different_files($resdir.'/'.$filename, + $cstr_dir.'/'.$filename)) { + $same=0; + } else { + $same=1; + } + } + my $meta_cmtime = (stat($cstr_dir.'/'.$filename.'.meta'))[9]; + my $meta_rmtime = (stat($resdir.'/'.$filename.'.meta'))[9]; + my $meta_same = 1; + if ($meta_rmtime < $meta_cmtime + && &Apache::londiff::are_different_files($resdir.'/'.$filename.'.meta', + $cstr_dir.'/'.$filename.'.meta')) { + $meta_same = 0; + } $publish_button=&mt('Re-publish'); - if ($rmtime>=$cmtime) { - $pubstatus = 'published'; - $status=&mt('Published').'
'. - &mt(&getCopyRightString($targetdir.'/'.$filename)).' '. - &mt(&getSourceRightString($targetdir.'/'.$filename)); - $bgcolor='#CCFF88'; + my $rights_status = + &mt(&getCopyRightString($targetdir.'/'.$filename)).' '. + &mt(&getSourceRightString($targetdir.'/'.$filename)); + $title = ''. + &getTitleString($targetdir.'/'.$filename).''; + if ($same) { if (&Apache::lonnet::metadata($targetdir.'/'.$filename,'obsolete')) { $pubstatus = 'obsolete'; $status=&mt('Obsolete'); - $bgcolor='#AAAAAA'; - } + } else { + if (!$meta_same) { + $pubstatus = 'metamodified'; + } else { + $pubstatus = 'published'; + } + $status=&mt('Published'). + '
'. $rights_status; + } # } else { # $action_buttons=''; # } - $title=''. - &getTitleString($targetdir.'/'.$filename).''; } else { $pubstatus = 'modified'; - $status=&mt('Modified').'
'. - &mt(&getCopyRightString($targetdir.'/'.$filename)).' '. - &mt(&getSourceRightString($targetdir.'/'.$filename)); - $bgcolor='#FFFF77'; + $status=&mt('Modified'). + '
'. $rights_status; # $action_buttons=''; - $title=''. - &getTitleString($targetdir.'/'.$filename).''; if (&Apache::loncommon::fileembstyle(($filename=~/\.(\w+)$/)) eq 'ssi') { $status.='
'.&mt('Diffs').''; + '&versiontwo=priv" target="cat">'.&mt('Diffs').''; } + } + + $title.="\n".'
'. + ($$bombs{$targetdir.'/'.$filename}?''.&mt('bomb').'':&mt('Edit Metadata')).''; + + if (!$meta_same) { + $title = &mt('Metadata Modified').'
'.$title. + '
'.&mt('Metadata Diffs').''; + $title.="\n".'
'.&mt('Retrieve Metadata').''; } - $title.='
'. - ($$bombs{$targetdir.'/'.$filename}?'':'Edit Metadata').''; - $status.='
'.&mt('Retrieve').''; } my $editlink=''; @@ -620,19 +790,23 @@ sub putresource { $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').')'; + } if ($filename=~/\.(zip|tar|bz2|gz|tar.gz|tar.bz2|tgz)$/) { $editlink=' ('.&mt('Decompress').')'; } my $pub_select = ''; &create_pubselect($r,\$pub_select,$udom,$uname,$thisdisfn,$filename,$resdir,$pubstatus,$publish_button,$numres); - $r->print(''. + $r->print(''. ''.($filename=~/[\#\~]$/?' ': - ''). + '').''. ''.$pub_select.''. - ''. + ''. ''. - $filename.''.$editlink2.$editlink. + $filename.''.$editlink2.$editlink. ''. ''.$title.''. ''.$status.''. @@ -645,32 +819,33 @@ sub create_pubselect { my ($r,$pub_select,$udom,$uname,$thisdisfn,$filename,$resdir,$pubstatus,$publish_button,$numres) = @_; $$pub_select = '
- +'. +''; if ($pubstatus eq 'obsolete' || $pubstatus eq 'unpublished') { - $$pub_select .= ' -'. +''. +''; } else { $$pub_select .= ' -'; } - $$pub_select .= ' -'; } $$pub_select .= ' - +'. +''. +''. +'
'; + &HTML::Entities::encode($uname.$thisdisfn.'/'.$filename,'<>&"').'" /> + '; $$numres ++; } @@ -722,59 +897,4 @@ sub CategorizeFiles { 1; __END__ -=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 - -=cut