--- loncom/publisher/lonpubdir.pm 2004/01/05 22:13:16 1.56 +++ loncom/publisher/lonpubdir.pm 2008/11/10 13:43:51 1.111 @@ -1,7 +1,7 @@ # The LearningOnline Network with CAPA # Construction Space Directory Lister # -# $Id: lonpubdir.pm,v 1.56 2004/01/05 22:13:16 albertel Exp $ +# $Id: lonpubdir.pm,v 1.111 2008/11/10 13:43:51 jms 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 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,8 +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 { @@ -59,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; @@ -70,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; } @@ -89,14 +205,27 @@ 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') { + &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; # Start off the directory table. - - $r->print(''. - ''. - ''); + $r->print('

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

'); + $r->print('
 '.&mt('Actions').''.&mt('Name').''. - &mt('Title').''.&mt('Status').''.&mt('Last Modified'). - '
'. + ''. + ''. + ''. + ''. + ''. + ''."\n"); my $filename; my $dirptr=16384; # Mask indicating a directory in stat.cmode. @@ -112,17 +241,17 @@ sub handler { my $extension=''; if ($filename=~/\.(\w+)$/) { $extension=$1; } if ($cmode&$dirptr) { - putdirectory($r, $thisdisfn, $linkdir, $filename, $cmtime,$targetdir,\%bombs); + putdirectory($r, $thisdisfn, $linkdir, $filename, $cmtime,$targetdir,\%bombs,\$numdir); } elsif (&Apache::loncommon::fileembstyle($extension) ne 'hdn') { - putresource($r, $uname, $filename, $thisdisfn, $resdir, - $targetdir, $linkdir, $cmtime,\%bombs); + 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'). + '
'); + $r->print(''.&Apache::loncommon::end_page()); return OK; } # @@ -133,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 (?) @@ -154,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; @@ -173,57 +302,294 @@ 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; - - $r->print('LON-CAPA Construction Space'); - - $r->print(&Apache::loncommon::bodytag(undef,undef,undef,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::start_page('Construction Space',undef, + {'body_title' => + $pagetitle,})); + } else { + $r->print(&Apache::loncommon::start_page('Construction Space',undef, + { 'only_body' => 1,})); + $r->print($pagetitle); + } + + 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); - $r->print('

'.&mt('Construction Space Directory').'

'. - ''. - $pubdirscript. - '
'. - '
'. - ''. - ''. - ''. -'
'.&mt('Force publication of unmodified files').'. 
'); - - 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. '

'); } - $r->print( - &Apache::lonhtmlcommon::crumbs($uname.'/'.$thisdisfn.'/','_top','/priv').'
'); +} + +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 Catalog Information', + 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(< + + $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 } # @@ -249,6 +615,11 @@ 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) @@ -259,16 +630,14 @@ sub getCopyRightString { # modtime - Encoded modification time. # sub putdirectory { - my ($r, $reqfile, $here, $dirname, $modtime, $resdir, $bombs) = @_; - + my ($r, $reqfile, $here, $dirname, $modtime, $resdir, $bombs, $numdir) = @_; # construct the display filename: the directory name unless ..: my $disfilename = $dirname; if ($dirname eq '..') { $disfilename = ''.&mt('Parent Directory').''; } - unless (( ($dirname eq '..') && ($reqfile eq '')) || - ($dirname eq '.')) { + unless ( (($dirname eq '..') && ($reqfile eq '')) || ($dirname eq '.')) { my $kaputt=0; foreach (keys %{$bombs}) { if ($_=~m:^\Q$resdir\E/\Q$disfilename\E/:) { $kaputt=1; last; } @@ -276,90 +645,168 @@ 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' )); - $r->print(''. + my $actionitem = ''; + if ($dirname eq '..') { + $actionitem = &mt('Go to ...'); + } else { + $actionitem = + '
'. + ''. + ''. + ''. + ''. + '
'; + $$numdir ++; + } + $r->print(''. ''. - ''.&mt('Go to ...').''. - ''. - $disfilename.''. - ''.($kaputt?'':'').$Apache::lonpublisher::metadatafields{'title'}.' '. - $Apache::lonpublisher::metadatafields{'subject'}.' '. - $Apache::lonpublisher::metadatafields{'keywords'}.''. + $Apache::lonnet::perlvar{'lonIconsURL'}.'/folder_closed.gif" alt="folder" />'. + ''.$actionitem.''. + ''. + $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"); - } + } return OK; } # # Put a table row for a file resource. # sub putresource { - my ($r, $uname, $filename, $thisdisfn, + my ($r, $udom, $uname, $filename, $thisdisfn, $resdir, $targetdir, $linkdir, - $cmtime,$bombs) = @_; - + $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) { - $status=&mt('Published').'
'. - &mt(&getCopyRightString($targetdir.'/'.$filename)); - $bgcolor='#CCFF88'; + 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'); + 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; } - $title=''. - &getTitleString($targetdir.'/'.$filename).''; +# } else { +# $action_buttons=''; +# } } else { - $status=&mt('Modified').'
'. - &mt(&getCopyRightString($targetdir.'/'.$filename)); - $bgcolor='#FFFF77'; - $title=''. - &getTitleString($targetdir.'/'.$filename).''; + $pubstatus = 'modified'; + $status=&mt('Modified'). + '
'. $rights_status; +# $action_buttons=''; 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').''; + $status.="\n".'
'.&mt('Retrieve').''; } 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').')'; + $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').')'; } - $r->print(''. + my $pub_select = ''; + &create_pubselect($r,\$pub_select,$udom,$uname,$thisdisfn,$filename,$resdir,$pubstatus,$publish_button,$numres); + $r->print(''. ''.($filename=~/[\#\~]$/?' ': - ''). - ''.&mt('Publish').''. - ''. - ''. - ''. - $filename.''.$editlink2.$editlink. + '').''. + ''.$pub_select.''. + ''. + ''. + $filename.''.$editlink2.$editlink. ''. ''.$title.''. ''.$status.''. @@ -367,6 +814,60 @@ sub putresource { "\n"); return OK; } + +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 ++; + } + } + return $versions; +} + # # Categorize files in the directory. # For each file in a list of files in a file directory, @@ -396,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 500 Internal Server Error

Internal Server Error

The server encountered an internal error or misconfiguration and was unable to complete your request.

Please contact the server administrator at root@localhost to inform them of the time this error occurred, and the actions you performed just before this error.

More information about this error may be available in the server error log.