--- loncom/publisher/lonpubdir.pm 2008/01/16 18:15:15 1.107 +++ 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.107 2008/01/16 18:15:15 bisitz 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; @@ -207,17 +319,18 @@ sub startpage { &Apache::lonhtmlcommon::store_recent('construct',$formaction,$formaction); if ($env{'environment.remote'} eq 'off') { $env{'request.noversionuri'}=$currdir.'/'; - $r->print(&Apache::loncommon::start_page(&mt('Construction Space'),undef, + $r->print(&Apache::loncommon::start_page('Construction Space',undef, {'body_title' => $pagetitle,})); } else { - $r->print(&Apache::loncommon::start_page(&mt('Construction Space'),undef, + $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=&mt('LON-CAPA Construction Space'); + my $doctitle = 'LON-CAPA '.&mt('Construction Space'); + my $newname = &mt('New Name'); my $pubdirscript=(< top.document.title = '$esc_thisdisfn/ - $doctitle'; @@ -232,7 +345,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' ) { @@ -262,7 +375,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") { @@ -314,7 +427,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 } @@ -347,7 +460,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', @@ -384,7 +497,7 @@ sub dircontrols { @@ -540,7 +653,7 @@ sub putdirectory { )); my $actionitem = ''; if ($dirname eq '..') { - $actionitem = 'Go to ...'; + $actionitem = &mt('Go to ...'); } else { $actionitem = '
'.&mt('Select action').''. ''. ''. - ''. + ''. ''. ''. ''. @@ -655,7 +768,7 @@ sub putresource { } $title.="\n".'
'. - ($$bombs{$targetdir.'/'.$filename}?'bomb':'Edit Metadata').''; + ($$bombs{$targetdir.'/'.$filename}?''.&mt('bomb').'':&mt('Edit Metadata')).''; if (!$meta_same) { $title = &mt('Metadata Modified').'
'.$title. @@ -784,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