1: # The LearningOnline Network with CAPA
2: # Authoring Space Directory Lister
3: #
4: # $Id: lonpubdir.pm,v 1.160.2.1 2016/08/07 20:23:42 raeburn Exp $
5: #
6: # Copyright Michigan State University Board of Trustees
7: #
8: # This file is part of the LearningOnline Network with CAPA (LON-CAPA).
9: #
10: # LON-CAPA is free software; you can redistribute it and/or modify
11: # it under the terms of the GNU General Public License as published by
12: # the Free Software Foundation; either version 2 of the License, or
13: # (at your option) any later version.
14: #
15: # LON-CAPA is distributed in the hope that it will be useful,
16: # but WITHOUT ANY WARRANTY; without even the implied warranty of
17: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18: # GNU General Public License for more details.
19: #
20: # You should have received a copy of the GNU General Public License
21: # along with LON-CAPA; if not, write to the Free Software
22: # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
23: #
24: # /home/httpd/html/adm/gpl.txt
25: #
26: # http://www.lon-capa.org/
27: #
28: ###
29:
30: package Apache::lonpubdir;
31:
32: use strict;
33: use Apache::File;
34: use File::Copy;
35: use Apache::Constants qw(:common :http :methods);
36: use Apache::loncommon();
37: use Apache::lonhtmlcommon();
38: use Apache::londiff();
39: use Apache::lonlocal;
40: use Apache::lonmsg;
41: use Apache::lonmenu;
42: use Apache::lonnet;
43: use LONCAPA qw(:DEFAULT :match);
44:
45: sub handler {
46:
47: my $r=shift;
48:
49: # Validate access to the construction space and get username:domain.
50:
51: my ($uname,$udom)=&Apache::lonnet::constructaccess($r->uri);
52: unless (($uname) && ($udom)) {
53: return HTTP_NOT_ACCEPTABLE;
54: }
55:
56: # ----------------------------------------------------------- Start page output
57:
58: my $fn=$r->filename;
59: $fn=~s/\/$//;
60: my $thisdisfn=$fn;
61:
62: my $docroot=$r->dir_config('lonDocRoot'); # Apache londocument root.
63: if ($thisdisfn eq "$docroot/priv/$udom") {
64: if ((-d "/home/$uname/public_html/") && (!-e "$docroot/priv/$udom/$uname")) {
65: my ($version) = ($r->dir_config('lonVersion') =~ /^\'?(\d+\.\d+)\./);
66: &Apache::loncommon::content_type($r,'text/html');
67: $r->send_http_header;
68:
69: &Apache::lonhtmlcommon::clear_breadcrumbs();
70: $r->print(&Apache::loncommon::start_page('Authoring Space').
71: '<div class="LC_error">'.
72: '<br /><p>'.
73: &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>'.
74: '<p>'.
75: &mt('Please ask your Domain Coordinator to move your Authoring Space to the new location.').
76: '</p>'.
77: '</div>'.
78: &Apache::loncommon::end_page());
79: return OK;
80: }
81: }
82: $thisdisfn=~s/^\Q$docroot\E\/priv//;
83:
84: my $resdir=$docroot.'/res'.$thisdisfn; # Resource directory
85: my $targetdir='/res'.$thisdisfn; # Publication target directory.
86: my $linkdir='/priv'.$thisdisfn; # Full URL name of constr space.
87:
88: my %bombs=&Apache::lonmsg::all_url_author_res_msg($uname,$udom);
89:
90: &startpage($r, $uname, $udom, $thisdisfn); # Put out the start of page.
91:
92: if (!-d $fn) {
93: if (-e $fn) {
94: $r->print('<p class="LC_info">'.&mt('Requested item is a file not a directory.').'</p>');
95: } else {
96: $r->print('<p class="LC_info">'.&mt('The requested subdirectory does not exist.').'</p>');
97: }
98: $r->print(&Apache::loncommon::end_page());
99: return OK;
100: }
101: my @files;
102: if (opendir(DIR,$fn)) {
103: @files = grep(!/^\.+$/,readdir(DIR));
104: closedir(DIR);
105: } else {
106: $r->print('<p class="LC_error">'.&mt('Could not open directory.').'</p>');
107: $r->print(&Apache::loncommon::end_page());
108: return OK;
109: }
110:
111: &dircontrols($r,$uname,$udom,$thisdisfn); # Put out actions for directory,
112: # browse/upload + new file page.
113: &resourceactions($r,$uname,$udom,$thisdisfn); # Put out form used for printing/deletion etc.
114:
115: my $numdir = 0;
116: my $numres = 0;
117:
118: if ((@files == 0) && ($thisdisfn =~ m{^/$match_domain/$match_username})) {
119: if ($thisdisfn =~ m{^/$match_domain/$match_username$}) {
120: $r->print('<p class="LC_info">'.&mt('This Authoring Space is currently empty.').'</p>');
121: } else {
122: $r->print('<p class="LC_info">'.&mt('This subdirectory is currently empty.').'</p>');
123: }
124: $r->print(&Apache::loncommon::end_page());
125: return OK;
126: }
127:
128: # Retrieving value for "sortby" and "sortorder" from QUERY_STRING
129: &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},
130: ['sortby','sortorder']);
131:
132: # Sort by name as default, not reversed
133: if (! exists($env{'form.sortby'})) { $env{'form.sortby'} = 'filename' }
134: if (! exists($env{'form.sortorder'})) { $env{'form.sortorder'} = '' }
135: my $sortby = $env{'form.sortby'};
136: my $sortorder = $env{'form.sortorder'};
137:
138: # Order in which columns are displayed from left to right
139: my @order = ('filetype','actions','filename','title',
140: 'pubstatus','cmtime','size');
141:
142: # Up and down arrows to indicate sort order
143: my @arrows = (' ▲',' ▼','');
144:
145: # Default sort order and column title
146: my %columns = (
147: filetype => {
148: order => 'ascending',
149: text => &mt('Type'),
150: },
151: actions => {
152: # Not sortable
153: text => &mt('Actions'),
154: },
155: filename => {
156: order => 'ascending',
157: text => &mt('Name'),
158: },
159: title => {
160: order => 'ascending',
161: text => &mt('Title'),
162: },
163: pubstatus => {
164: order => 'ascending',
165: text => &mt('Status'),
166: colspan => '2',
167: },
168: cmtime => {
169: order => 'descending',
170: text => &mt('Last Modified'),
171: },
172: size => {
173: order => 'ascending',
174: text => &mt('Size').' (kB)',
175: },
176: );
177:
178: # Print column headers
179: my $output = '';
180: foreach my $key (@order) {
181: my $idx;
182: # Append an up or down arrow to sorted column
183: if ($sortby eq $key) {
184: $idx = ($columns{$key}{order} eq 'ascending') ? 0:1;
185: if ($sortorder eq 'rev') { $idx ++; }
186: $idx = $idx%2;
187: } else { $idx = 2; } # No arrow if column is not sorted
188: $output .= (($columns{$key}{order}) ?
189: '<th'.($columns{$key}{colspan} ? ' colspan="'.$columns{$key}{colspan}.'"' : '')
190: .'><a href="'.$linkdir.'/?sortby='.$key.'&sortorder='
191: .((($sortby eq $key) && ($sortorder ne 'rev')) ? 'rev' : '').'">'
192: .$columns{$key}{text}.$arrows[$idx].'</a></th>' :
193: '<th>'.$columns{$key}{text}.'</th>');
194: }
195: $r->print(&Apache::loncommon::start_data_table()
196: .&Apache::loncommon::start_data_table_header_row() . $output
197: .&Apache::loncommon::end_data_table_header_row()
198: );
199:
200: my $dirptr=16384; # Mask indicating a directory in stat.cmode.
201: my $filehash = {};
202: foreach my $filename (@files) {
203: # Skip .DS_Store, .DAV and hidden files
204: my ($extension) = ($filename=~/\.(\w+)$/);
205: next if (($filename eq '.DS_Store')
206: || ($filename eq '.DAV')
207: || (&Apache::loncommon::fileembstyle($extension) eq 'hdn')
208: || ($filename =~ /^\._/));
209:
210: my ($cmode,$csize,$cmtime)=(stat($fn.'/'.$filename))[2,7,9];
211: my $linkfilename = &HTML::Entities::encode('/priv'.$thisdisfn.'/'.$filename,'<>&"');
212: # Identify type of file according to icon used
213: my ($filetype) = (&Apache::loncommon::icon($filename) =~ m{/(\w+).gif$});
214: my $cstr_dir = $r->dir_config('lonDocRoot').'/priv'.$thisdisfn;
215: my $meta_same = &isMetaSame($cstr_dir, $resdir, $filename);
216:
217: # Store size, title, and status for files but not directories
218: my $size = (!($cmode&$dirptr)) ? $csize/1024. : 0;
219: my ($status, $pubstatus, $title, $fulltitle);
220: if (!($cmode&$dirptr)) {
221: ($status, $pubstatus) = &getStatus($resdir, $targetdir, $cstr_dir,
222: $filename, $linkfilename, $cmtime, $meta_same);
223: ($fulltitle, $title) = &getTitle($resdir, $targetdir, $filename,
224: $linkfilename, $meta_same, \%bombs);
225: } else {
226: ($status, $pubstatus) = ('','');
227: ($fulltitle, $title) = ('','');
228: }
229:
230: # This hash will allow sorting
231: $filehash->{ $filename } = {
232: "cmtime" => $cmtime,
233: "size" => $size,
234: "cmode" => $cmode,
235: "filetype" => $filetype,
236: "title" => $title,
237: "fulltitle" => $fulltitle,
238: "status" => $status,
239: "pubstatus" => $pubstatus,
240: "linkfilename" => $linkfilename,
241: }
242: }
243:
244: my @sorted_files;
245: # Sorting by something other than "Name". Name is the secondary key.
246: if ($sortby =~ m{cmtime|size}) { # Numeric fields
247: # First check if order should be reversed
248: if ($sortorder eq "rev") {
249: @sorted_files = sort {
250: $filehash->{$a}->{$sortby} <=> $filehash->{$b}->{$sortby}
251: or
252: uc($a) cmp uc($b)
253: } (keys(%{$filehash}));
254: } else {
255: @sorted_files = sort {
256: $filehash->{$b}->{$sortby} <=> $filehash->{$a}->{$sortby}
257: or
258: uc($a) cmp uc($b)
259: } (keys(%{$filehash}));
260: }
261: } elsif ($sortby =~ m{filetype|title|status}) { # String fields
262: if ($sortorder eq "rev") {
263: @sorted_files = sort {
264: $filehash->{$b}->{$sortby} cmp $filehash->{$a}->{$sortby}
265: or
266: uc($a) cmp uc($b)
267: } (keys(%{$filehash}));
268: } else {
269: @sorted_files = sort {
270: $filehash->{$a}->{$sortby} cmp $filehash->{$b}->{$sortby}
271: or
272: uc($a) cmp uc($b)
273: } (keys(%{$filehash}));
274: }
275:
276: # Sort by "Name" is the default
277: } else {
278: if ($sortorder eq "rev") {
279: @sorted_files = sort {uc($b) cmp uc($a)} (keys(%{$filehash}));
280: } else {
281: @sorted_files = sort {uc($a) cmp uc($b)} (keys(%{$filehash}));
282: }
283: }
284:
285: # Print the sorted resources
286: foreach my $filename (@sorted_files) {
287: if ($filehash->{$filename}->{"cmode"}&$dirptr) { # Directories
288: &putdirectory($r, $thisdisfn, $linkdir, $filename,
289: $filehash->{$filename}->{"cmtime"},
290: $targetdir, \%bombs, \$numdir);
291: } else { # Files
292: &putresource($r, $udom, $uname, $filename, $thisdisfn, $resdir,
293: $targetdir, $linkdir, $filehash->{$filename}->{"cmtime"},
294: $filehash->{$filename}->{"size"}, \$numres,
295: $filehash->{$filename}->{"linkfilename"},
296: $filehash->{$filename}->{"fulltitle"},
297: $filehash->{$filename}->{"status"},
298: $filehash->{$filename}->{"pubstatus"});
299: }
300: }
301:
302: $r->print( &Apache::loncommon::end_data_table()
303: .&Apache::loncommon::end_page() );
304:
305: return OK;
306: }
307:
308:
309:
310: # Output the header of the page. This includes:
311: # - The HTML header
312: # - The H1/H3 stuff which includes the directory.
313: #
314: # startpage($r, $uame, $udom, $thisdisfn);
315: # $r - The apache request object.
316: # $uname - User name.
317: # $udom - Domain name the user is logged in under.
318: # $thisdisfn - Displayable version of the filename.
319:
320: sub startpage {
321: my ($r, $uname, $udom, $thisdisfn) = @_;
322: &Apache::loncommon::content_type($r,'text/html');
323: $r->send_http_header;
324:
325: my $formaction='/priv'.$thisdisfn.'/';
326: $formaction=~s|/+|/|g;
327: &Apache::lonhtmlcommon::store_recent('construct',$formaction,$formaction);
328:
329: &Apache::lonhtmlcommon::clear_breadcrumbs();
330: &Apache::lonhtmlcommon::add_breadcrumb({
331: 'text' => 'Authoring Space',
332: 'href' => &Apache::loncommon::authorspace($formaction),
333: });
334: # breadcrumbs (and tools) will be created
335: # in start_page->bodytag->innerregister
336:
337: $env{'request.noversionuri'}=$formaction;
338: $r->print(&Apache::loncommon::start_page('Authoring Space'));
339:
340: my $londocroot = $Apache::lonnet::perlvar{'lonDocRoot'};
341: my $current_disk_usage = &Apache::lonnet::diskusage($udom,$uname,"$londocroot/priv/$udom/$uname");
342: my $disk_quota = &Apache::loncommon::get_user_quota($uname,$udom,'author'); #expressed in MB
343: $disk_quota = 1000 * $disk_quota; # convert from MB to kB
344:
345: $r->print(&Apache::loncommon::head_subbox(
346: '<div style="float:right;padding-top:0;margin-top;0">'
347: .&Apache::lonhtmlcommon::display_usage($current_disk_usage,
348: $disk_quota,'authoring')
349: .'</div>'
350: .&Apache::loncommon::CSTR_pageheader()));
351:
352: my $esc_thisdisfn = &Apache::loncommon::escape_single($thisdisfn);
353: my $doctitle = 'LON-CAPA '.&mt('Authoring Space');
354: my $newname = &mt('New Name');
355: my $pubdirscript=(<<ENDPUBDIRSCRIPT);
356: <script type="text/javascript">
357: top.document.title = '$esc_thisdisfn/ - $doctitle';
358: // Store directory location for menu bar to find
359:
360: parent.lastknownpriv='/priv$esc_thisdisfn/';
361:
362: // Confirmation dialogues
363:
364: function currdiract(theform) {
365: if (theform.dirtask.options[theform.dirtask.selectedIndex].value == 'publish') {
366: document.publishdir.filename.value = theform.filename.value;
367: document.publishdir.submit();
368: }
369: if (theform.dirtask.options[theform.dirtask.selectedIndex].value == 'editmeta') {
370: top.location=theform.filename.value+'default.meta'
371: }
372: if (theform.dirtask.options[theform.dirtask.selectedIndex].value == 'printdir' ) {
373: document.printdir.postdata.value=theform.filename.value
374: document.printdir.submit();
375: }
376: if (theform.dirtask.options[theform.dirtask.selectedIndex].value == "delete") {
377: var delform = document.delresource
378: delform.filename.value = theform.filename.value
379: delform.submit()
380: }
381: }
382:
383: function checkUpload(theform) {
384: if (theform.file == '') {
385: alert("Please use 'Browse..' to choose a file first, before uploading")
386: return
387: }
388: theform.submit()
389: }
390:
391: function SetPubDir(theform,printForm) {
392: if (theform.diraction.options[theform.diraction.selectedIndex].value == "open") {
393: top.location = theform.openname.value
394: return
395: }
396: if (theform.diraction.options[theform.diraction.selectedIndex].value == "publish") {
397: theform.submit();
398: }
399: if (theform.diraction.options[theform.diraction.selectedIndex].value == "editmeta") {
400: top.location=theform.filename.value+'default.meta'
401: }
402: if (theform.diraction.options[theform.diraction.selectedIndex].value == "printdir") {
403: theform.action = '/adm/printout'
404: theform.postdata.value = theform.filename.value
405: theform.submit()
406: }
407: if (theform.diraction.options[theform.diraction.selectedIndex].value == "delete") {
408: var delform = document.delresource
409: delform.filename.value = theform.filename.value
410: delform.submit()
411: }
412: return
413: }
414: function SetResChoice(theform) {
415: var activity = theform.reschoice.options[theform.reschoice.selectedIndex].value
416: if ((activity == 'rename') || (activity == 'copy') || (activity == 'move')) {
417: changename(theform,activity)
418: }
419: if (activity == 'publish') {
420: var pubform = document.pubresource
421: pubform.filename.value = theform.filename.value
422: pubform.submit()
423: }
424: if (activity == 'delete') {
425: var delform = document.delresource
426: delform.filename.value = theform.filename.value
427: delform.submit()
428: }
429: if (activity == 'obsolete') {
430: var pubform = document.pubresource
431: pubform.filename.value = theform.filename.value
432: pubform.makeobsolete.value=1;
433: pubform.submit()
434: }
435: if (activity == 'print') {
436: document.printresource.postdata.value = theform.filename.value
437: document.printresource.submit()
438: }
439: if (activity == 'retrieve') {
440: document.retrieveres.filename.value = theform.filename.value
441: document.retrieveres.submit()
442: }
443: if (activity == 'cleanup') {
444: document.cleanup.filename.value = theform.filename.value
445: document.cleanup.submit()
446: }
447: return
448: }
449: function changename(theform,activity) {
450: var oldname=theform.dispfilename.value;
451: var newname=prompt('$newname',oldname);
452: if (newname == "" || !newname || newname == oldname) {
453: return
454: }
455: document.moveresource.newfilename.value = newname
456: document.moveresource.filename.value = theform.filename.value
457: document.moveresource.action.value = activity
458: document.moveresource.submit();
459: }
460: </script>
461: ENDPUBDIRSCRIPT
462: $r->print($pubdirscript);
463: }
464:
465: sub dircontrols {
466: my ($r,$uname,$udom,$thisdisfn) = @_;
467: my %lt=&Apache::lonlocal::texthash(
468: cnpd => 'Cannot publish directory',
469: cnrd => 'Cannot retrieve directory',
470: mcdi => 'Must create new subdirectory inside a directory',
471: pubr => 'Publish this Resource',
472: pubd => 'Publish this Directory',
473: dedr => 'Delete Directory',
474: rtrv => 'Retrieve Old Version',
475: list => 'List Directory',
476: uplo => 'Upload file',
477: dele => 'Delete',
478: edit => 'Edit Metadata',
479: sela => 'Select Action',
480: nfil => 'New file',
481: nhtm => 'New HTML file',
482: nprb => 'New problem',
483: npag => 'New assembled page',
484: nseq => 'New assembled sequence',
485: ncrf => 'New custom rights file',
486: nsty => 'New style file',
487: nlib => 'New library file',
488: nbt => 'New bridgetask file',
489: nsub => 'New subdirectory',
490: renm => 'Rename current file to',
491: move => 'Move current file to',
492: copy => 'Copy current file to',
493: type => 'Type Name Here',
494: go => 'Go',
495: prnt => 'Print contents of directory',
496: crea => 'Create a new directory or LON-CAPA document',
497: acti => 'Actions for current directory',
498: updc => 'Upload a new document',
499: pick => 'Please select an action to perform using the new filename',
500: );
501: my $mytype = $lt{'type'}; # avoid conflict with " and ' in javascript
502: $r->print(<<END);
503: <div class="LC_columnSection">
504: <div>
505: <form name="curractions" method="post" action="">
506: <fieldset>
507: <legend>$lt{'acti'}</legend>
508: <select name="dirtask" onchange="currdiract(this.form)">
509: <option>$lt{'sela'}</option>
510: <option value="publish">$lt{'pubd'}</option>
511: <option value="editmeta">$lt{'edit'}</option>
512: <option value="printdir">$lt{'prnt'}</option>
513: <option value="delete">$lt{'dedr'}</option>
514: </select>
515: <input type="hidden" name="filename" value="/priv$thisdisfn/" />
516: </fieldset>
517: </form>
518: <form name="publishdir" method="post" action="/adm/publish" target="_parent">
519: <input type="hidden" name="pubrec" value="" />
520: <input type="hidden" name="filename" value="" />
521: </form>
522: <form name="printdir" method="post" action="/adm/printout" target="_parent">
523: <input type="hidden" name="postdata" value="" />
524: </form>
525: </div>
526:
527: <div>
528: <form name="upublisher" enctype="multipart/form-data" method="post" action="/adm/upload" target="_parent">
529: <fieldset>
530: <legend>$lt{'updc'}</legend>
531: <input type="hidden" name="filename" value="/priv$thisdisfn/" />
532: <input type="file" name="upfile" size="20" />
533: <input type="button" value="$lt{'uplo'}" onclick="checkUpload(this.form)" />
534: </fieldset>
535: </form>
536: </div>
537:
538: <div>
539: <form name="fileaction" method="post" action="/adm/cfile" target="_parent">
540: <fieldset>
541: <legend>$lt{'crea'}</legend>
542: <span class="LC_nobreak">
543: <input type="hidden" name="filename" value="/priv$thisdisfn/" />
544: <script type="text/javascript">
545: function validate_go() {
546: var selected = document.fileaction.action.selectedIndex;
547: if (selected == 0) {
548: alert('$lt{'pick'}');
549: } else {
550: document.fileaction.submit();
551: }
552: }
553: </script>
554: <select name="action">
555: <option value="none">$lt{'sela'}</option>
556: <option value="newfile">$lt{'nfil'}:</option>
557: <option value="newhtmlfile">$lt{'nhtm'}:</option>
558: <option value="newproblemfile">$lt{'nprb'}:</option>
559: <option value="newpagefile">$lt{'npag'}:</option>
560: <option value="newsequencefile">$lt{'nseq'}:</option>
561: <option value="newrightsfile">$lt{'ncrf'}:</option>
562: <option value="newstyfile">$lt{'nsty'}:</option>
563: <option value="newtaskfile">$lt{'nbt'}:</option>
564: <option value="newlibraryfile">$lt{'nlib'}:</option>
565: <option value="newdir">$lt{'nsub'}:</option>
566: </select> <input type="text" name="newfilename" value="$lt{'type'}" onfocus="if (this.value == '$mytype') this.value=''" /> <input type="button" value="Go" onclick="validate_go();" />
567: </span>
568: </fieldset>
569: </form>
570: </div>
571: </div>
572: END
573: }
574:
575: sub resourceactions {
576: my ($r,$uname,$udom,$thisdisfn) = @_;
577: $r->print(<<END);
578: <form name="moveresource" action="/adm/cfile" target="_parent" method="post">
579: <input type="hidden" name="filename" value="" />
580: <input type="hidden" name="newfilename" value="" />
581: <input type="hidden" name="action" value="" />
582: </form>
583: <form name="delresource" action="/adm/cfile" target="_parent" method="post">
584: <input type="hidden" name="filename" value="" />
585: <input type="hidden" name="action" value="delete" />
586: </form>
587: <form name="pubresource" action="/adm/publish" target="_parent" method="post">
588: <input type="hidden" name="filename" value="" />
589: <input type="hidden" name="makeobsolete" value="0" />
590: </form>
591: <form name="printresource" action="/adm/printout" target="_parent" method="post">
592: <input type="hidden" name="postdata" value="" />
593: </form>
594: <form name="retrieveres" action="/adm/retrieve" target="_parent" method="post">
595: <input type="hidden" name="filename" value="" />
596: </form>
597: <form name="cleanup" action="/adm/cleanup" target="_parent" method="post">
598: <input type="hidden" name="filename" value="" />
599: </form>
600: END
601: }
602:
603: #
604: # Get the title string or "[untitled]" if the file has no title metadata:
605: # Without the latter substitution, it's impossible to examine metadata for
606: # untitled resources. Resources may be legitimately untitled, to prevent
607: # searches from locating them.
608: #
609: # $str = getTitleString($fullname);
610: # $fullname - Fully qualified filename to check.
611: #
612: sub getTitleString {
613: my $fullname = shift;
614: my $title = &Apache::lonnet::metadata($fullname, 'title');
615:
616: unless ($title) {
617: $title = "[".&mt('untitled')."]";
618: }
619: return $title;
620: }
621:
622: sub getCopyRightString {
623: my $fullname = shift;
624: return &Apache::lonnet::metadata($fullname, 'copyright');
625: }
626:
627: sub getSourceRightString {
628: my $fullname = shift;
629: return &Apache::lonnet::metadata($fullname, 'sourceavail');
630: }
631: #
632: # Put out a directory table row:
633: # putdirectory(r, base, here, dirname, modtime, targetdir, bombs, numdir)
634: # r - Apache request object.
635: # reqfile - File in request.
636: # here - Where we are in directory tree.
637: # dirname - Name of directory special file.
638: # modtime - Encoded modification time.
639: # targetdir - Publication target directory.
640: # bombs - Reference to hash of URLs with runtime error messages.
641: # numdir - Reference to scalar used to track number of sub-directories
642: # in directory (used in form name for each "actions" dropdown).
643: #
644: sub putdirectory {
645: my ($r, $reqfile, $here, $dirname, $modtime, $targetdir, $bombs, $numdir) = @_;
646:
647: # construct the display filename: the directory name unless ..:
648:
649: my $actionitem;
650:
651: my $disfilename = $dirname;
652: # Don't display directory itself, and there is no way up from root directory
653: unless ((($dirname eq '..') && ($reqfile=~/^\/[^\/]+\/[^\/]+$/)) || ($dirname eq '.')) {
654: my $kaputt=0;
655: if (ref($bombs) eq 'HASH') {
656: foreach my $key (keys(%{$bombs})) {
657: my $currentdir = &Apache::lonnet::declutter("$targetdir/$disfilename");
658: if (($key) =~ m{^\Q$currentdir\E/}) { $kaputt=1; last; }
659: }
660: }
661: #
662: # Get the metadata from that directory's default.meta to display titles
663: #
664: %Apache::lonpublisher::metadatafields=();
665: %Apache::lonpublisher::metadatakeys=();
666: &Apache::lonpublisher::metaeval(
667: &Apache::lonnet::getfile($r->dir_config('lonDocRoot').$here.'/'.$dirname.'/default.meta')
668: );
669: if ($dirname eq '..') {
670: $actionitem = &mt('Go to ...');
671: $disfilename = '<i>'.&mt('Parent Directory').'</i>';
672: } else {
673: $actionitem =
674: '<form name="dirselect_'.$$numdir.
675: '" action="/adm/publish" target="_parent">'.
676: '<select name="diraction" onchange="SetPubDir(this.form,document)">'.
677: '<option selected="selected">'.&mt('Select action').'</option>'.
678: '<option value="open">'.&mt('Open').'</option>'.
679: '<option value="publish">'.&mt('Publish').'</option>'.
680: '<option value="editmeta">'.&mt('Edit Metadata').'</option>'.
681: '<option value="printdir">'.&mt('Print directory').'</option>'.
682: '<option value="delete">'.&mt('Delete directory').'</option>'.
683: '</select>'.
684: '<input type="hidden" name="filename" value="'.&HTML::Entities::encode($here.'/'.$dirname,'<>&"').'/" />'.
685: '<input type="hidden" name="openname" value="'.$here.'/'.$dirname.'/" />'.
686: '<input type="hidden" name="postdata" value="" />'.
687: '</form>';
688: $$numdir ++;
689: }
690: $r->print('<tr class="LC_browser_folder">'.
691: '<td><img src="'.
692: $Apache::lonnet::perlvar{'lonIconsURL'}.'/navmap.folder.closed.gif" alt="folder" /></td>'.
693: '<td>'.$actionitem.'</td>'.
694: '<td><span class="LC_filename"><a href="'.&HTML::Entities::encode($here.'/'.$dirname,'<>&"').'/" target="_parent">'.
695: $disfilename.'</a></span></td>'.
696: '<td colspan="3">'.($kaputt?&Apache::lonhtmlcommon::authorbombs($targetdir.'/'.$disfilename.'/'):'').$Apache::lonpublisher::metadatafields{'title'});
697: if ($Apache::lonpublisher::metadatafields{'subject'} ne '') {
698: $r->print(' <i>'.
699: $Apache::lonpublisher::metadatafields{'subject'}.
700: '</i> ');
701: }
702: $r->print($Apache::lonpublisher::metadatafields{'keywords'}.'</td>'.
703: '<td>'.&Apache::lonlocal::locallocaltime($modtime).'</td>'.
704: '<td></td>'.
705: "</tr>\n");
706: }
707: return;
708: }
709:
710: sub getTitle {
711: my ($resdir, $targetdir, $filename, $linkfilename, $meta_same, $bombs) = @_;
712: my $title='';
713: my $titleString = &getTitleString($targetdir.'/'.$filename);
714: if (-e $resdir.'/'.$filename) {
715: $title = '<a href="'.$targetdir.'/'.$filename.
716: '.meta" target="cat">'.$titleString.'</a>';
717: if (!$meta_same) {
718: $title = &mt('Metadata Modified').'<br />'.$title.
719: '<br />'.
720: &Apache::loncommon::modal_link(
721: '/adm/diff?filename='.$linkfilename.'.meta'.'&versiontwo=priv',
722: &mt('Metadata Diffs'),600,500);
723: $title.="\n".'<br />'.
724: &Apache::loncommon::modal_link(
725: '/adm/retrieve?filename='.$linkfilename.'.meta&inhibitmenu=yes&add_modal=yes',
726: &mt('Retrieve Metadata'),600,500);
727: }
728: }
729: # Allow editing metadata of published and unpublished resources
730: $title .= "\n".'<br />' if ($title);
731: $title .= '<a href="'.$linkfilename.'.meta">'.
732: ($$bombs{&Apache::lonnet::declutter($targetdir.'/'.$filename)}?
733: '<img src="/adm/lonMisc/bomb.gif" border="0" alt="'.&mt('bomb').'" />':
734: &mt('Edit Metadata')).
735: '</a>';
736:
737: return ($title, $titleString);
738: }
739:
740:
741: sub isMetaSame {
742: my ($cstr_dir, $resdir, $filename) = @_;
743: my $meta_cmtime = (stat($cstr_dir.'/'.$filename.'.meta'))[9];
744: my $meta_rmtime = (stat($resdir.'/'.$filename.'.meta'))[9];
745: return (&Apache::londiff::are_different_files($resdir.'/'.$filename.'.meta',
746: $cstr_dir.'/'.$filename.'.meta') && $meta_rmtime < $meta_cmtime)
747: ? 0 : 1;
748: }
749:
750:
751: sub getStatus {
752: my ($resdir, $targetdir, $cstr_dir, $filename,
753: $linkfilename, $cmtime, $meta_same) = @_;
754: my $pubstatus = 'unpublished';
755: my $status = &mt('Unpublished');
756:
757: if (-e $resdir.'/'.$filename) {
758: my $same = 0;
759: if ((stat($resdir.'/'.$filename))[9] >= $cmtime) {
760: $same = 1;
761: } else {
762: if (&Apache::londiff::are_different_files($resdir.'/'.$filename,
763: $cstr_dir.'/'.$filename)) {
764: $same = 0;
765: } else {
766: $same = 1;
767: }
768: }
769:
770: my $rights_status =
771: &mt(&getCopyRightString($targetdir.'/'.$filename)).', ';
772:
773: my %lt_SourceRight = &Apache::lonlocal::texthash(
774: 'open' => 'Source: open',
775: 'closed' => 'Source: closed',
776: );
777: $rights_status .=
778: $lt_SourceRight{&getSourceRightString($targetdir.'/'.$filename)};
779:
780: if ($same) {
781: if (&Apache::lonnet::metadata($targetdir.'/'.$filename,'obsolete')) {
782: $pubstatus = 'obsolete';
783: $status=&mt('Obsolete');
784: } else {
785: if (!$meta_same) {
786: $pubstatus = 'metamodified';
787: } else {
788: $pubstatus = 'published';
789: }
790: $status=&mt('Published').
791: '<br />'. $rights_status;
792: }
793: } else {
794: $pubstatus = 'modified';
795: $status=&mt('Modified').
796: '<br />'. $rights_status;
797: if (&Apache::loncommon::fileembstyle(($filename=~/\.(\w+)$/)) eq 'ssi') {
798: $status.='<br />'.
799: &Apache::loncommon::modal_link(
800: '/adm/diff?filename='.$linkfilename.'&versiontwo=priv',
801: &mt('Diffs'),600,500);
802: }
803: }
804:
805: $status.="\n".'<br />'.
806: &Apache::loncommon::modal_link(
807: '/adm/retrieve?filename='.$linkfilename.'&inhibitmenu=yes&add_modal=yes',&mt('Retrieve'),600,500);
808: }
809:
810: return ($status, $pubstatus);
811: }
812:
813:
814: #
815: # Put a table row for a file resource.
816: #
817: sub putresource {
818: my ($r, $udom, $uname, $filename, $thisdisfn, $resdir, $targetdir,
819: $linkdir, $cmtime, $size, $numres, $linkfilename, $title,
820: $status, $pubstatus) = @_;
821: &Apache::lonnet::devalidate_cache_new('meta',$targetdir.'/'.$filename);
822:
823: my $editlink='';
824: my $editlink2='';
825: if ($filename=~/\.(xml|html|htm|xhtml|xhtm|sty)$/) {
826: $editlink=' <br />(<a href="'.$linkdir.'/'.$filename.'?editmode=Edit&problemmode=edit">'.&mt('Edit').'</a>)';
827: }
828: if ($filename=~/$LONCAPA::assess_re/) {
829: $editlink=' (<a href="'.$linkdir.'/'.$filename.'?editmode=Edit&problemmode=editxml">'.&mt('EditXML').'</a>)';
830: $editlink2=' <br />(<a href="'.$linkdir.'/'.$filename.'?editmode=Edit&problemmode=edit">'.&mt('Edit').'</a>)';
831: }
832: if ($filename=~/\.(problem|exam|quiz|assess|survey|form|library|xml|html|htm|xhtml|xhtm|sty)$/) {
833: $editlink.=' (<a href="/adm/cleanup?filename='.$linkfilename.'" target="_parent">'.&mt('Clean Up').')</a>';
834: }
835: if ($filename=~/\.(zip|tar|bz2|gz|tar.gz|tar.bz2|tgz)$/) {
836: $editlink=' (<a target="_parent" href="/adm/cfile?decompress='.$linkfilename.'">'.&mt('Decompress').'</a>)';
837: }
838: my $publish_button = (-e $resdir.'/'.$filename) ? &mt('Re-publish') : &mt('Publish');
839: my $pub_select = '';
840: &create_pubselect($r,\$pub_select,$udom,$uname,$thisdisfn,$filename,$resdir,$pubstatus,$publish_button,$numres);
841: $r->print(&Apache::loncommon::start_data_table_row().
842: '<td>'.($filename=~/[\#\~]$/?' ':
843: '<img src="'.&Apache::loncommon::icon($filename).'" alt="" />').'</td>'.
844: '<td>'.$pub_select.'</td>'.
845: '<td><span class="LC_filename">'.
846: '<a href="'.$linkdir.'/'.$filename.'" target="_parent">'.
847: $filename.'</a></span>'.$editlink2.$editlink.
848: '</td>'.
849: '<td>'.$title.'</td>'.
850: '<td class="LC_browser_file_'.$pubstatus.'"> </td>'. # Display publication status
851: '<td>'.$status.'</td>'.
852: '<td>'.&Apache::lonlocal::locallocaltime($cmtime).'</td>'.
853: '<td>'.sprintf("%.1f",$size).'</td>'.
854: &Apache::loncommon::end_data_table_row()
855: );
856: return;
857: }
858:
859: sub create_pubselect {
860: my ($r,$pub_select,$udom,$uname,$thisdisfn,$filename,$resdir,$pubstatus,$publish_button,$numres) = @_;
861: $$pub_select = '
862: <form name="resselect_'.$$numres.'" action="">
863: <select name="reschoice" onchange="SetResChoice(this.form)">
864: <option>'.&mt('Select action').'</option>'.
865: '<option value="copy">'.&mt('Copy').'</option>';
866: if ($pubstatus eq 'obsolete' || $pubstatus eq 'unpublished') {
867: $$pub_select .=
868: '<option value="rename">'.&mt('Rename').'</option>'.
869: '<option value="move">'.&mt('Move').'</option>'.
870: '<option value="delete">'.&mt('Delete').'</option>';
871: } else {
872: $$pub_select .= '
873: <option value="obsolete">'.&mt('Mark obsolete').'</option>';
874: }
875: # check for versions
876: my $versions = &check_for_versions($r,'/'.$filename,$udom,$uname);
877: if ($versions > 0) {
878: $$pub_select .='
879: <option value="retrieve">'.&mt('Retrieve old version').'</option>';
880: }
881: $$pub_select .= '
882: <option value="publish">'.$publish_button.'</option>'.
883: '<option value="cleanup">'.&mt('Clean up').'</option>'.
884: '<option value="print">'.&mt('Print').'</option>'.
885: '</select>
886: <input type="hidden" name="filename" value="/priv'.
887: &HTML::Entities::encode($thisdisfn.'/'.$filename,'<>&"').'" />
888: <input type="hidden" name="dispfilename" value="'.
889: &HTML::Entities::encode($filename).'" /></form>';
890: $$numres ++;
891: }
892:
893: sub check_for_versions {
894: my ($r,$fn,$udom,$uname) = @_;
895: my $versions = 0;
896: my $docroot=$r->dir_config('lonDocRoot');
897: my $resfn=$docroot.'/res/'.$udom.'/'.$uname.$fn;
898: my $resdir=$resfn;
899: $resdir=~s/\/[^\/]+$/\//;
900: $fn=~/\/([^\/]+)\.(\w+)$/;
901: my $main=$1;
902: my $suffix=$2;
903: opendir(DIR,$resdir);
904: while (my $filename=readdir(DIR)) {
905: if ($filename=~/^\Q$main\E\.(\d+)\.\Q$suffix\E$/) {
906: $versions ++;
907: }
908: }
909: closedir(DIR);
910: return $versions;
911: }
912:
913: 1;
914: __END__
915:
916:
917: =head1 NAME
918:
919: Apache::lonpubdir - Authoring space directory lister
920:
921: =head1 SYNOPSIS
922:
923: Invoked (for various locations) by /etc/httpd/conf/srm.conf:
924:
925: <LocationMatch "^/+priv.*/$">
926: PerlAccessHandler Apache::loncacc
927: SetHandler perl-script
928: PerlHandler Apache::lonpubdir
929: ErrorDocument 403 /adm/login
930: ErrorDocument 404 /adm/notfound.html
931: ErrorDocument 406 /adm/unauthorized.html
932: ErrorDocument 500 /adm/errorhandler
933: </LocationMatch>
934:
935: <Location /adm/pubdir>
936: PerlAccessHandler Apache::lonacc
937: SetHandler perl-script
938: PerlHandler Apache::lonpubdir
939: ErrorDocument 403 /adm/login
940: ErrorDocument 404 /adm/notfound.html
941: ErrorDocument 406 /adm/unauthorized.html
942: ErrorDocument 500 /adm/errorhandler
943: </Location>
944:
945: =head1 INTRODUCTION
946:
947: This module publishes a directory of files.
948:
949: This is part of the LearningOnline Network with CAPA project
950: described at http://www.lon-capa.org.
951:
952: =head1 HANDLER SUBROUTINE
953:
954: This routine is called by Apache and mod_perl.
955:
956: =over 4
957:
958: =item *
959:
960: read in information
961:
962: =item *
963:
964: start page output
965:
966: =item *
967:
968: run through list of files and attempt to publish unhidden files
969:
970: =back
971:
972: =head1 SUBROUTINES:
973:
974: =over
975:
976: =item startpage($r, $uame, $udom, $thisdisfn)
977:
978: Output the header of the page. This includes:
979: - The HTML header
980: - The H1/H3 stuff which includes the directory.
981:
982: startpage($r, $uame, $udom, $thisdisfn);
983: $r - The apache request object.
984: $uname - User name.
985: $udom - Domain name the user is logged in under.
986: $thisdisfn - Displayable version of the filename.
987:
988: =item getTitleString($fullname)
989:
990: Get the title string or "[untitled]" if the file has no title metadata:
991: Without the latter substitution, it's impossible to examine metadata for
992: untitled resources. Resources may be legitimately untitled, to prevent
993: searches from locating them.
994:
995: $str = getTitleString($fullname);
996: $fullname - Fully qualified filename to check.
997:
998: =item putdirectory($r, $base, $here, $dirname, $modtime, $targetdir, $bombs,
999: $numdir)
1000:
1001: Put out a directory table row:
1002:
1003: $r - Apache request object.
1004: $reqfile - File in request.
1005: $here - Where we are in directory tree.
1006: $dirname - Name of directory special file.
1007: $modtime - Encoded modification time.
1008: targetdir - Publication target directory.
1009: bombs - Reference to hash of URLs with runtime error messages.
1010: numdir - Reference to scalar used to track number of sub-directories
1011: in directory (used in form name for each "actions" dropdown).
1012:
1013: =back
1014:
1015: =cut
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>
![[BACK]](/icons/back.gif){kind=icon}
Return to lonpubdir.pm CVS log ![[TXT]](/icons/text.gif){kind=icon}
![[DIR]](/icons/dir.gif){kind=icon}
Up to [LON-CAPA] / loncom / publisher