loncom/publisher/lonpubdir.pm - view

File: [LON-CAPA] / loncom / publisher / lonpubdir.pm
Revision 1.183: download - view: text, annotated - select for diffs
Wed Jan 10 20:07:37 2024 UTC (10 months ago) by raeburn
Branches: MAIN
CVS tags: version_2_12_X, HEAD

- Code used to create default.rights file for course authoring space
  moved from londocs.pm to loncommon.pm to facilitate reuse.
- Course Editor > Content Utilities > Enter Course Authoring Space
  will create required directories and default.rights file if absent.

# The LearningOnline Network with CAPA # Authoring Space Directory Lister # # $Id: lonpubdir.pm,v 1.183 2024/01/10 20:07:37 raeburn Exp $ # # Copyright Michigan State University Board of Trustees # # This file is part of the LearningOnline Network with CAPA (LON-CAPA). # # LON-CAPA is free software; you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation; either version 2 of the License, or # (at your option) any later version. # # LON-CAPA is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License # along with LON-CAPA; if not, write to the Free Software # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA # # /home/httpd/html/adm/gpl.txt # # http://www.lon-capa.org/ # ### package Apache::lonpubdir; use strict; use Apache::File; use File::Copy; use Apache::Constants qw(:common :http :methods); use Apache::loncommon(); use Apache::lonhtmlcommon(); use Apache::londiff(); use Apache::lonpublisher(); use Apache::lonlocal; use Apache::lonmsg; use Apache::lonmenu; use Apache::lonnet; use LONCAPA qw(:DEFAULT :match); sub handler { my $r=shift; # 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 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'). '<div class="LC_error">'. '<br /><p>'. &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).'</p>'. '<p>'. &mt('Please ask your Domain Coordinator to move your Authoring Space to the new location.'). '</p>'. '</div>'. &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. my $cstr = 'author'; my ($crsauthor,$crstype,$crstoplevel,$cdom,$cnum); if ($env{'request.course.id'}) { $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'}; $cnum = $env{'course.'.$env{'request.course.id'}.'.num'}; if ($thisdisfn =~ m{^/\Q$cdom/$cnum\E}) { $crsauthor = 1; $cstr = 'course'; $crstype = &Apache::loncommon::course_type(); $crstoplevel = "$docroot/priv/$cdom/$cnum"; } } my %bombs=&Apache::lonmsg::all_url_author_res_msg($uname,$udom); my $londocroot = $Apache::lonnet::perlvar{'lonDocRoot'}; my $current_disk_usage = &Apache::lonnet::diskusage($udom,$uname, "$londocroot/priv/$udom/$uname"); # expressed in kB my $disk_quota = &Apache::loncommon::get_user_quota($uname,$udom, $cstr,$crstype); # expressed in MB # Put out the start of page. &startpage($r, $uname, $udom, $thisdisfn, $current_disk_usage, $disk_quota, $crsauthor); my @files; if (!-d $fn) { if (($crsauthor) && ($fn eq $crstoplevel)) { my $path = "$docroot/priv/$cdom/$cnum"; my $rightsfile = 'default.rights'; my $sourcerights = "$path/$rightsfile"; &Apache::loncommon::crsauthor_rights($rightsfile,$path,$docroot,$cnum,$cdom); my $targetrights = $docroot."/res/$cdom/$cnum/$rightsfile"; if ((-e $sourcerights) && (-e "$sourcerights.meta")) { if (!-e "$docroot/res/$cdom") { mkdir("$docroot/res/$cdom",0755); } if (!-e "$docroot/res/$cdom/$cnum") { mkdir("$docroot/res/$cdom/$cnum",0755); } if ((-e "$docroot/res/$cdom/$cnum") && (!-e $targetrights)) { my $nokeyref = &Apache::lonpublisher::getnokey($r->dir_config('lonIncludes')); my $output = &Apache::lonpublisher::batchpublish($r,$sourcerights,$targetrights,$nokeyref,1); } } else { $r->print('<p class="LC_info">'.&mt('The requested subdirectory does not exist.').'</p>'); return OK; } } else { if (-e $fn) { $r->print('<p class="LC_info">'.&mt('Requested item is a file not a directory.').'</p>'); } else { $r->print('<p class="LC_info">'.&mt('The requested subdirectory does not exist.').'</p>'); } $r->print(&Apache::loncommon::end_page()); return OK; } } else { if (opendir(DIR,$fn)) { @files = grep(!/^\.+$/,readdir(DIR)); closedir(DIR); } else { $r->print('<p class="LC_error">'.&mt('Could not open directory.').'</p>'); $r->print(&Apache::loncommon::end_page()); return OK; } } # Put out actions for directory, browse/upload + new file page. &dircontrols($r,$uname,$udom,$thisdisfn,$current_disk_usage,$disk_quota,$crsauthor); &resourceactions($r,$uname,$udom,$thisdisfn); # Put out form used for printing/deletion etc. my $numdir = 0; my $numres = 0; if ((@files == 0) && ($thisdisfn =~ m{^/$match_domain/$match_username})) { if ($thisdisfn =~ m{^/$match_domain/$match_username$}) { $r->print('<p class="LC_info">'.&mt('This Authoring Space is currently empty.').'</p>'); } else { $r->print('<p class="LC_info">'.&mt('This subdirectory is currently empty.').'</p>'); } $r->print(&Apache::loncommon::end_page()); return OK; } # 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}) ? '<th'.($columns{$key}{colspan} ? ' colspan="'.$columns{$key}{colspan}.'"' : '') .'><a href="'.$linkdir.'/?sortby='.$key.'&sortorder=' .((($sortby eq $key) && ($sortorder ne 'rev')) ? 'rev' : '').'">' .$columns{$key}{text}.$arrows[$idx].'</a></th>' : '<th>'.$columns{$key}{text}.'</th>'); } my $result = "<script type=\"text/javascript\"> sessionStorage.setItem('CSTRcache','".&prepareJsonData($uname,$udom,$thisdisfn)."'); localStorage.setItem('CSTRtrans', '".&prepareJsonTranslations()."'); </script>"; $r->print($result); $r->print('<div id="currentFolder">'.&Apache::loncommon::start_data_table() .'<tr><th colspan="8" id="searchtitle" style="display:none"></th></tr>' .&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); if (($crsauthor) && ($extension eq 'rights')) { $title = &getTitleString($targetdir.'/'.$filename); $fulltitle = $title; } else { ($fulltitle, $title) = &getTitle($resdir, $targetdir, $filename, $linkfilename, $meta_same, \%bombs); } } else { ($status, $pubstatus) = ('',''); ($fulltitle, $title) = ('',''); } # 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})); } # 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})); } } # Print the sorted resources my %editors = &Apache::loncommon::permitted_editors(); 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, $crsauthor, $filehash->{$filename}->{"cmtime"}, $filehash->{$filename}->{"size"}, \$numres, $filehash->{$filename}->{"linkfilename"}, $filehash->{$filename}->{"fulltitle"}, $filehash->{$filename}->{"status"}, $filehash->{$filename}->{"pubstatus"}, \%editors); } } $r->print(&Apache::loncommon::end_data_table() .'</div><div id="otherplaces" style="display:none">' .&Apache::loncommon::start_data_table() .'<tr><th colspan="7">'.&mt('Results in other directories:').'</th></tr>' .'<tr class="LC_header_row" id="otherplacestable">' .'<th>'.&mt('Type').'</th>' .'<th>'.&mt('Directory').'</th>' .'<th>'.&mt('Name').'</th>' .'<th>'.&mt('Title').'</th>' .'<th colspan="2">'.&mt('Status').'</th>' .'<th>'.&mt('Last Modified').'</th>' .'</tr>' .&Apache::loncommon::end_data_table() .'</div>' .&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. # # startpage($r, $uame, $udom, $thisdisfn, $current_disk_usage, $disk_quota); # $r - The apache request object. # $uname - User name. # $udom - Domain name the user is logged in under. # $thisdisfn - Displayable version of the filename. # $current_disk_usage - User's current disk usage (in kB). # $disk_quota - Disk quota for user's authoring space (in MB). # $crstype - Course type, if this is for "course author" sub startpage { my ($r, $uname, $udom, $thisdisfn, $current_disk_usage, $disk_quota, $crsauthor) = @_; &Apache::loncommon::content_type($r,'text/html'); $r->send_http_header; my $formaction='/priv'.$thisdisfn.'/'; $formaction=~s|/+|/|g; my $title; if ($crsauthor) { $title = 'Course Authoring'; } else { $title = 'Authoring Space'; &Apache::lonhtmlcommon::store_recent('construct',$formaction,$formaction); } &Apache::lonhtmlcommon::clear_breadcrumbs(); &Apache::lonhtmlcommon::add_breadcrumb({ 'text' => $title, 'href' => &Apache::loncommon::authorspace($formaction), }); # breadcrumbs (and tools) will be created # in start_page->bodytag->innerregister $env{'request.noversionuri'}=$formaction; my $js = '<script type="text/javascript" src="/res/adm/includes/file_upload.js"></script>'; $r->print(&Apache::loncommon::start_page($title, $js)); $disk_quota = 1024 * $disk_quota; # convert from MB to kB my $headertext = &mt('Directory'); if ($crsauthor) { $headertext = &mt('Course Authoring Directory'); } $r->print(&Apache::loncommon::head_subbox( '<div style="float:right;padding-top:0;margin-top;0">' .&Apache::lonhtmlcommon::display_usage($current_disk_usage, $disk_quota,'authoring') .'</div>' .&Apache::loncommon::CSTR_pageheader('','',$headertext))); my $esc_thisdisfn = &Apache::loncommon::escape_single($thisdisfn); my $doctitle = 'LON-CAPA '.&mt($title); my $newname = &mt('New Name'); my $pubdirscript=(<<ENDPUBDIRSCRIPT); <script type="text/javascript"> top.document.title = '$esc_thisdisfn/ - $doctitle'; // Store directory location for menu bar to find parent.lastknownpriv='/priv$esc_thisdisfn/'; // Confirmation dialogues function checkUpload(theform) { if (theform.file == '') { alert("Please use 'Browse..' to choose a file first, before uploading") return } theform.submit() } function SetPubDir(theform,printForm) { if (theform.diraction.options[theform.diraction.selectedIndex].value == "open") { top.location = theform.openname.value return } if (theform.diraction.options[theform.diraction.selectedIndex].value == "publish") { theform.submit(); } 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") { theform.action = '/adm/printout' theform.postdata.value = theform.filename.value theform.submit() } if (theform.diraction.options[theform.diraction.selectedIndex].value == "delete") { var delform = document.delresource delform.filename.value = theform.filename.value delform.submit() } return } function SetResChoice(theform) { var activity = theform.reschoice.options[theform.reschoice.selectedIndex].value if ((activity == 'rename') || (activity == 'copy') || (activity == 'move')) { changename(theform,activity) } if (activity == 'publish') { var pubform = document.pubresource pubform.filename.value = theform.filename.value pubform.submit() } if (activity == 'delete') { var delform = document.delresource delform.filename.value = theform.filename.value delform.submit() } if (activity == 'obsolete') { var pubform = document.pubresource pubform.filename.value = theform.filename.value pubform.makeobsolete.value=1; pubform.submit() } if (activity == 'print') { document.printresource.postdata.value = theform.filename.value document.printresource.submit() } if (activity == 'retrieve') { document.retrieveres.filename.value = theform.filename.value document.retrieveres.submit() } if (activity == 'cleanup') { document.cleanup.filename.value = theform.filename.value document.cleanup.submit() } return } function changename(theform,activity) { var oldname=theform.dispfilename.value; var newname=prompt('$newname',oldname); if (newname == "" || !newname || newname == oldname) { return } document.moveresource.newfilename.value = newname document.moveresource.filename.value = theform.filename.value document.moveresource.action.value = activity document.moveresource.submit(); } </script> ENDPUBDIRSCRIPT $r->print($pubdirscript); } sub dircontrols { my ($r,$uname,$udom,$thisdisfn,$current_disk_usage,$disk_quota,$crsauthor) = @_; 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', rtrv => 'Retrieve Old Version', list => 'List Directory', uplo => 'Upload file', dele => 'Delete', 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', crea => 'Create a new subdirectory or document', qs => 'Quick name search', cs => 'Case Sensitive', re => 'Regular Expression', updc => 'Upload a new document', pick => 'Please select an action to perform using the new filename', shcu => 'Shortcuts', ); my %js_lt = &Apache::lonlocal::texthash( nanf => 'Name of New File', nans => 'Name of New Subdirectory', psfn => 'Please specify file name', ); &js_escape(\%js_lt); my $mytype = $lt{'type'}; # avoid conflict with " and ' in javascript # Calculate free space in bytes. # $disk_quota is in MB and $current_disk_usage is in kB my $free_space = 1024 * ((1024 * $disk_quota) - $current_disk_usage); $r->printf(<<END,&Apache::loncommon::help_open_topic('Quicksearch')); <div class="LC_columnSection"> <div> <fieldset style="display:inline"> <legend>$lt{'qs'}</legend> <script type="text/javascript" src="/adm/quicksearch/quicksearch.js"></script> <input type="text" id="quickfilter" placeholder="Enter search term" onkeyup="applyFilter()"/> <input type="button" value="Clear" onclick="document.getElementById(\'quickfilter\').value=\'\'; applyFilter()" /> %s <br /> <label><input type="checkbox" id="casesens" onchange="applyFilter()"/>$lt{'cs'}  </label> <label><input type="checkbox" id="regex" onchange="applyFilter()"/>$lt{'re'}  </label> </fieldset> </div> END my %fileoptions = ( none => "$lt{'sela'}:", newfile => "$lt{'nfil'}:", newhtmlfile => "$lt{'nhtm'}:", newproblemfile => "$lt{'nprb'}:", newdir => "$lt{'nsub'}:", ); $fileoptions{'select_form_order'} = ['none','newfile','newhtmlfile','newproblemfile']; if ($crsauthor) { push(@{$fileoptions{'select_form_order'}},'newdir'); } else { my %extraoptions = ( newpagefile => "$lt{'npag'}:", newsequencefile => "$lt{'nseq'}:", newrightsfile => "$lt{'ncrf'}:", newstyfile => "$lt{'nsty'}:", newtaskfile => "$lt{'nbt'}:", newlibraryfile => "$lt{'nlib'}:", ); %fileoptions = (%fileoptions,%extraoptions); push(@{$fileoptions{'select_form_order'}},('newpagefile','newsequencefile', 'newrightsfile','newstyfile', 'newtaskfile','newlibraryfile', 'newdir')); } my $selectbox = &Apache::loncommon::select_form('none','action',\%fileoptions); $r->print(<<END); <div style="padding-bottom: 2px"> <form name="upublisher" enctype="multipart/form-data" method="post" action="/adm/upload"> <fieldset> <legend>$lt{'updc'}</legend> <input type="hidden" name="filename" value="/priv$thisdisfn/" /> <input type="file" name="upfile" class="LC_flUpload" /> <input type="hidden" id="LC_free_space" value="$free_space" /> <input type="button" value="$lt{'uplo'}" onclick="checkUpload(this.form)" /> </fieldset> </form> </div> <div> <form name="fileaction" method="post" action="/adm/cfile"> <fieldset> <legend>$lt{'crea'}</legend> <span class="LC_nobreak"> <input type="hidden" name="filename" value="/priv$thisdisfn/" /> <script type="text/javascript"> function validate_go() { var selected = document.fileaction.action.selectedIndex; if (selected == 0) { alert('$lt{'pick'}'); } else { document.fileaction.submit(); } } </script> $selectbox <input type="text" id="newnameid" name="newfilename" placeholder="$lt{'type'}" value="" onfocus="if (this.value == is.empty()) this.value=''" /> <input type="button" value="Go" onclick="validate_go();" /> <br /> <span>$lt{'shcu'}: <input type="hidden" name="mode"/> <a href="javascript:void(0)" onclick="javascript:validate_action('blank')"> <img src="/adm/lonIcons/unknown.gif" title="Create blank problem file" alt="file icon" /></a> <a href="javascript:void(0)" onclick="javascript:validate_action('problemtempl')"> <img src="/adm/lonIcons/problem.gif" title="Create new problem from template" alt="problem icon" /></a> <a href="javascript:void(0)" onclick="javascript:validate_action('blankhtml')"> <img src="/adm/lonIcons/html.gif" title="Create new blank HTML file" alt="web page icon" /></a> <a href="javascript:void(0)" onclick="javascript:validate_action('folder')"> <img src="/adm/lonIcons/navmap.folder.closed.gif" title="Create new subdirectory" alt="folder icon" /></a> </span> <script type="text/javascript"> function validate_action(action){ if (document.getElementById('newnameid')) { if (document.getElementById('newnameid').value == '') { var newname; var prompttext = "$js_lt{'nanf'}"; if (action == 'folder') { prompttext = "$js_lt{'nans'}"; } newname=prompt(prompttext); if (newname != '') { document.getElementById('newnameid').value = newname; } } if (document.getElementById('newnameid').value != '') { if (action == 'blank') { document.fileaction.action.value='newproblemfile'; document.fileaction.mode.value='blank'; } else if (action == 'problemtempl') { document.fileaction.action.value='newproblemfile'; validate_go(); } else if (action == 'blankhtml') { document.fileaction.action.value='newhtmlfile'; validate_go(); } else if (action == 'folder') { document.fileaction.action.value='newdir'; document.fileaction.mode.value='folder'; } fileaction.submit(); } else { alert("$js_lt{'psfn'}"); } } } </script> </span> </fieldset> </form> </div> </div> END } sub resourceactions { my ($r,$uname,$udom,$thisdisfn) = @_; $r->print(<<END); <form name="moveresource" action="/adm/cfile" method="post"> <input type="hidden" name="filename" value="" /> <input type="hidden" name="newfilename" value="" /> <input type="hidden" name="action" value="" /> </form> <form name="delresource" action="/adm/cfile" method="post"> <input type="hidden" name="filename" value="" /> <input type="hidden" name="action" value="delete" /> </form> <form name="pubresource" action="/adm/publish" method="post"> <input type="hidden" name="filename" value="" /> <input type="hidden" name="makeobsolete" value="0" /> </form> <form name="printresource" action="/adm/printout" method="post"> <input type="hidden" name="postdata" value="" /> </form> <form name="retrieveres" action="/adm/retrieve" method="post"> <input type="hidden" name="filename" value="" /> </form> <form name="cleanup" action="/adm/cleanup" method="post"> <input type="hidden" name="filename" value="" /> </form> END } # # 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. # sub getTitleString { my $fullname = shift; my $title = &Apache::lonnet::metadata($fullname, 'title'); unless ($title) { $title = "[".&mt('untitled')."]"; } return $title; } 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, targetdir, bombs, numdir) # 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). # sub putdirectory { my ($r, $reqfile, $here, $dirname, $modtime, $targetdir, $bombs, $numdir) = @_; # construct the display filename: the directory name unless ..: my $actionitem; my $disfilename = $dirname; # 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=(); &Apache::lonpublisher::metaeval( &Apache::lonnet::getfile($r->dir_config('lonDocRoot').$here.'/'.$dirname.'/default.meta') ); if ($dirname eq '..') { $actionitem = &mt('Go to ...'); $disfilename = '<i>'.&mt('Parent Directory').'</i>'; } else { $actionitem = '<form name="dirselect_'.$$numdir. '" action="/adm/publish">'. '<select name="diraction" onchange="SetPubDir(this.form,document)">'. '<option selected="selected">'.&mt('Select action').'</option>'. '<option value="open">'.&mt('Open').'</option>'. '<option value="publish">'.&mt('Publish').'</option>'. '<option value="editmeta">'.&mt('Edit Metadata').'</option>'. '<option value="printdir">'.&mt('Print directory').'</option>'. '<option value="delete">'.&mt('Delete directory').'</option>'. '</select>'. '<input type="hidden" name="filename" value="'.&HTML::Entities::encode($here.'/'.$dirname,'<>&"').'/" />'. '<input type="hidden" name="openname" value="'.$here.'/'.$dirname.'/" />'. '<input type="hidden" name="postdata" value="" />'. '</form>'; $$numdir ++; } $r->print('<tr class="LC_browser_folder">'. '<td><img src="'. $Apache::lonnet::perlvar{'lonIconsURL'}.'/navmap.folder.closed.gif" alt="folder" /></td>'. '<td>'.$actionitem.'</td>'. '<td><span class="LC_filename"><a href="'.&HTML::Entities::encode($here.'/'.$dirname,'<>&"').'/">'. $disfilename.'</a></span></td>'. '<td colspan="3">'.($kaputt?&Apache::lonhtmlcommon::authorbombs($targetdir.'/'.$disfilename.'/'):'').$Apache::lonpublisher::metadatafields{'title'}); if ($Apache::lonpublisher::metadatafields{'subject'} ne '') { $r->print(' <i>'. $Apache::lonpublisher::metadatafields{'subject'}. '</i> '); } $r->print($Apache::lonpublisher::metadatafields{'keywords'}.'</td>'. '<td>'.&Apache::lonlocal::locallocaltime($modtime).'</td>'. '<td></td>'. "</tr>\n"); } return; } sub getTitle { my ($resdir, $targetdir, $filename, $linkfilename, $meta_same, $bombs) = @_; my $title=''; my $titleString = &getTitleString($targetdir.'/'.$filename); if (-e $resdir.'/'.$filename) { $title = '<a href="'.$targetdir.'/'.$filename. '.meta" target="cat">'.$titleString.'</a>'; if (!$meta_same) { $title = &mt('Metadata Modified').'<br />'.$title. '<br />'. &Apache::loncommon::modal_link( '/adm/diff?filename='.$linkfilename.'.meta'.'&versiontwo=priv', &mt('Metadata Diffs'),600,500); $title.="\n".'<br />'. &Apache::loncommon::modal_link( '/adm/retrieve?filename='.$linkfilename.'.meta&inhibitmenu=yes&add_modal=yes', &mt('Retrieve Metadata'),600,500); } } # Allow editing metadata of published and unpublished resources $title .= "\n".'<br />' if ($title); $title .= '<a href="'.$linkfilename.'.meta">'. ($$bombs{&Apache::lonnet::declutter($targetdir.'/'.$filename)}? '<img src="/adm/lonMisc/bomb.gif" border="0" alt="'.&mt('bomb').'" />': &mt('Edit Metadata')). '</a>'; return ($title, $titleString); } sub isMetaSame { my ($cstr_dir, $resdir, $filename) = @_; my $meta_cmtime = (stat($cstr_dir.'/'.$filename.'.meta'))[9]; my $meta_rmtime = (stat($resdir.'/'.$filename.'.meta'))[9]; return (&Apache::londiff::are_different_files($resdir.'/'.$filename.'.meta', $cstr_dir.'/'.$filename.'.meta') && $meta_rmtime < $meta_cmtime) ? 0 : 1; } sub getStatus { my ($resdir, $targetdir, $cstr_dir, $filename, $linkfilename, $crsauthor, $cmtime, $meta_same) = @_; my $pubstatus = 'unpublished'; my $status = &mt('Unpublished'); if (-e $resdir.'/'.$filename) { my $same = 0; if ((stat($resdir.'/'.$filename))[9] >= $cmtime) { $same = 1; } else { if (&Apache::londiff::are_different_files($resdir.'/'.$filename, $cstr_dir.'/'.$filename)) { $same = 0; } else { $same = 1; } } my $rights_status = &mt(&getCopyRightString($targetdir.'/'.$filename)).', '; my %lt_SourceRight = &Apache::lonlocal::texthash( 'open' => 'Source: open', 'closed' => 'Source: closed', ); $rights_status .= $lt_SourceRight{&getSourceRightString($targetdir.'/'.$filename)}; if (($crsauthor) && ($filename =~ /\.rights$/)) { $rights_status =~ s/,\s+$//; } if ($same) { if (&Apache::lonnet::metadata($targetdir.'/'.$filename,'obsolete')) { $pubstatus = 'obsolete'; $status=&mt('Obsolete'); } else { if (!$meta_same) { $pubstatus = 'metamodified'; } else { $pubstatus = 'published'; } $status=&mt('Published'). '<br />'. $rights_status; } } else { $pubstatus = 'modified'; $status=&mt('Modified'). '<br />'. $rights_status; unless (($crsauthor) && ($filename =~ /\.rights$/)) { if (&Apache::loncommon::fileembstyle(($filename=~/\.(\w+)$/)) eq 'ssi') { $status.='<br />'. &Apache::loncommon::modal_link( '/adm/diff?filename='.$linkfilename.'&versiontwo=priv', &mt('Diffs'),600,500); } } } unless (($crsauthor) && ($filename =~ /\.rights$/)) { $status.="\n".'<br />'. &Apache::loncommon::modal_link( '/adm/retrieve?filename='.$linkfilename.'&inhibitmenu=yes&add_modal=yes',&mt('Retrieve'),600,500); } } return ($status, $pubstatus); } # # Put a table row for a file resource. # sub putresource { my ($r, $udom, $uname, $filename, $thisdisfn, $resdir, $targetdir, $linkdir, $crsauthor, $cmtime, $size, $numres, $linkfilename, $title, $status, $pubstatus, $editors) = @_; &Apache::lonnet::devalidate_cache_new('meta',$targetdir.'/'.$filename); my $editlink=''; my $editlink2=''; if ($filename=~/\.(xml|html|htm|xhtml|xhtm|sty|txt|css|js)$/) { $editlink=' <br />(<a href="'.$linkdir.'/'.$filename.'?editmode=Edit&problemmode=edit">'.&mt('Edit').'</a>)'; } if ($filename=~/$LONCAPA::assess_re/) { if ($editors->{'xml'}) { $editlink=' (<a href="'.$linkdir.'/'.$filename.'?editmode=Edit&problemmode=editxml">'.&mt('EditXML').'</a>)'; } if ($editors->{'edit'}) { $editlink2=' <br />(<a href="'.$linkdir.'/'.$filename.'?editmode=Edit&problemmode=edit">'.&mt('Edit').'</a>)'; } } if ($filename=~/\.(xml|html|htm|xhtml|xhtm)$/ || $filename=~/$LONCAPA::assess_re/) { if (($editors->{'daxe'}) && ($env{'browser.type'} ne 'explorer' || $env{'browser.version'} > 9)) { my $daxeurl = '/daxepage'.$linkdir.'/'.$filename; $editlink .= ' (<a href="'.$daxeurl.'">Daxe</a>)'; } } if ($filename=~/\.(problem|exam|quiz|assess|survey|form|library|xml|html|htm|xhtml|xhtm|sty)$/) { $editlink.=' (<a href="/adm/cleanup?filename='.$linkfilename.'">'.&mt('Clean Up').')</a>'; } if ($filename=~/\.(zip|tar|bz2|gz|tar.gz|tar.bz2|tgz)$/) { $editlink=' (<a href="/adm/cfile?decompress='.$linkfilename.'">'.&mt('Decompress').'</a>)'; } my $publish_button = (-e $resdir.'/'.$filename) ? &mt('Re-publish') : &mt('Publish'); my $pub_select = ''; unless (($crsauthor) && ($filename=~ /\.rights$/)) { &create_pubselect($r,\$pub_select,$udom,$uname,$thisdisfn,$filename,$resdir,$pubstatus,$publish_button,$numres); } $r->print(&Apache::loncommon::start_data_table_row(). '<td>'.($filename=~/[\#\~]$/?' ': '<img src="'.&Apache::loncommon::icon($filename).'" alt="" />').'</td>'. '<td>'.$pub_select.'</td>'. '<td><span class="LC_filename">'. '<a href="'.$linkdir.'/'.$filename.'">'. $filename.'</a></span>'.$editlink2.$editlink. '</td>'. '<td>'.$title.'</td>'. '<td class="LC_browser_file_'.$pubstatus.'">  </td>'. # Display publication status '<td>'.$status.'</td>'. '<td>'.&Apache::lonlocal::locallocaltime($cmtime).'</td>'. '<td>'.sprintf("%.1f",$size).'</td>'. &Apache::loncommon::end_data_table_row() ); return; } sub create_pubselect { my ($r,$pub_select,$udom,$uname,$thisdisfn,$filename,$resdir,$pubstatus,$publish_button,$numres) = @_; $$pub_select = ' <form name="resselect_'.$$numres.'" action=""> <select name="reschoice" onchange="SetResChoice(this.form)"> <option>'.&mt('Select action').'</option>'. '<option value="copy">'.&mt('Copy').'</option>'; if ($pubstatus eq 'obsolete' || $pubstatus eq 'unpublished') { $$pub_select .= '<option value="rename">'.&mt('Rename').'</option>'. '<option value="move">'.&mt('Move').'</option>'. '<option value="delete">'.&mt('Delete').'</option>'; } else { $$pub_select .= ' <option value="obsolete">'.&mt('Mark obsolete').'</option>'; } # check for versions my $versions = &check_for_versions($r,'/'.$filename,$udom,$uname); if ($versions > 0) { $$pub_select .=' <option value="retrieve">'.&mt('Retrieve old version').'</option>'; } $$pub_select .= ' <option value="publish">'.$publish_button.'</option>'. '<option value="cleanup">'.&mt('Clean up').'</option>'. '<option value="print">'.&mt('Print').'</option>'. '</select> <input type="hidden" name="filename" value="/priv'. &HTML::Entities::encode($thisdisfn.'/'.$filename,'<>&"').'" /> <input type="hidden" name="dispfilename" value="'. &HTML::Entities::encode($filename).'" /></form>'; $$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 ++; } } closedir(DIR); return $versions; } sub prepareJsonTranslations { my $json = '{"translations":{'. '"edit":"'.&mt('Edit').'",'. '"editxml":"'.&mt('EditXML').'",'. '"editmeta":"'.&mt('Edit Metadata').'",'. '"obsolete":"'.&mt('Obsolete').'",'. '"modified":"'.&mt('Modified').'",'. '"published":"'.&mt('Published').'",'. '"unpublished":"'.&mt('Unpublished').'",'. '"diff":"'.&mt('Diff').'",'. '"retrieve":"'.&mt('Retrieve').'",'. '"directory":"'.&mt('Directory').'",'. '"results":"'.&mt('Show results for keyword:').'"'. '}}'; } # gathers all files in the working directory except the ones that are already on screen sub prepareJsonData { my ($uname, $udom, $pathToSkip) = @_; my $path = "/home/httpd/html/priv/$udom/$uname/"; # maximum number of entries, to limit workload and required storage space my $entries = 100; my $firstfile = 1; my $firstdir = 1; my $json = '{"resources":['; $json .= &prepareJsonData_rec($path, \$entries, \$firstfile, \$firstdir, $pathToSkip); $json .= ']}'; # if the json string is invalid the whole search breaks. # so we want to make sure that the string is valid in any case. $json =~ s/,\s*,/,/g; $json =~ s/\}\s*\{/\},\{/g; $json =~ s/\}\s*,\s*\]/\}\]/g; return $json; } # recursive part of json file gathering sub prepareJsonData_rec { my ($path, $entries, $firstfile, $firstdir, $pathToSkip) = @_; my $json; my $skipThisFolder = $path =~ m/$pathToSkip\/$/?1:0; my @dirs; my @resources; my @ignored = qw(bak log meta save . ..); # Phase 1: Gathering opendir(DIR,$path); my @files=sort {uc($a) cmp uc($b)} (readdir(DIR)); foreach my $filename (@files) { next if ($filename eq '.DS_Store'); # gather all resources if ($filename !~ /\./) { # its a folder push(@dirs, $filename); } else { # only push files we dont want to ignore next if ($skipThisFolder); $filename =~ /\.(\w+?)$/; unless (grep /$1/, @ignored) { push(@resources, $filename); } } } closedir(DIR); # nothing to do here if both lists are empty return unless ( @dirs || @resources ); # Phase 2: Working $$firstfile = 1; foreach (@dirs) { $json .= '{"name":"'.$_.'",'. '"path":"'.$path.$_.'",'. '"title":"",'. '"status":"",'. '"cmtime":""},'; } foreach (@resources) { last if ($$entries < 1); my $title = &getTitleString($path.$_); my $privpath = $path.$_; my $respath = $privpath; $respath =~ s/httpd\/html\/priv\//httpd\/html\/res\//; my $cmtime = (stat($privpath))[9]; my $rmtime = (stat($respath))[9]; unless ($$firstfile) { $json .= ','; } else { $$firstfile = 0; } my $status = 'unpublished'; # if a resource is published, the published version (/html/res/filepath) gets its own modification time # this is newer or equal then the version in your authoring space (/html/priv/filepath) if ($rmtime >= $cmtime) { # obsolete if (&Apache::lonnet::metadata($respath, 'obsolete')) { $status = 'obsolete'; }else{ $status = 'published'; } } else { $status = 'modified'; } $json .= '{"name":"'.$_.'",'. '"path":"'.$path.'",'. '"title":"'.$title.'",'. '"status":"'.$status.'",'. '"cmtime":"'.&Apache::lonlocal::locallocaltime($cmtime).'"}'; $$entries--; } foreach(@dirs) { next if ($$entries < 1); $json .= ','; $json .= &prepareJsonData_rec ($path.$_.'/', $entries, $firstfile, $firstdir, $pathToSkip); } return $json; } 1; __END__ =head1 NAME Apache::lonpubdir - Authoring space directory lister =head1 SYNOPSIS Invoked (for various locations) by /etc/httpd/conf/srm.conf: <LocationMatch "^/+priv.*/$"> 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 </LocationMatch> <Location /adm/pubdir> 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 </Location> =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 =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