Annotation of loncom/publisher/lonpubdir.pm, revision 1.37
1.1 www 1: # The LearningOnline Network with CAPA
1.32 www 2: # Construction Space Directory Lister
1.16 albertel 3: #
1.37 ! www 4: # $Id: lonpubdir.pm,v 1.36 2003/07/17 13:50:44 www Exp $
1.16 albertel 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/
1.1 www 27: #
28: #
29: # (TeX Content Handler
30: #
1.17 harris41 31: # YEAR=2000
1.1 www 32: # 05/29/00,05/30,10/11 Gerd Kortemeyer)
33: #
34: # 11/28,11/29,11/30,12/01,12/02,12/04,12/23 Gerd Kortemeyer
1.17 harris41 35: # YEAR=2001
1.1 www 36: # 03/23 Guy Albertelli
37: # 03/24,03/29 Gerd Kortemeyer)
1.17 harris41 38: # 03/31,04/03,05/09,06/23,08/18,08/20 Gerd Kortemeyer
1.19 www 39: # 12/28 Gerd Kortemeyer
1.1 www 40: #
1.17 harris41 41: ###
1.1 www 42:
43: package Apache::lonpubdir;
44:
45: use strict;
46: use Apache::File;
47: use File::Copy;
48: use Apache::Constants qw(:common :http :methods);
1.6 www 49: use Apache::loncacc;
1.17 harris41 50: use Apache::loncommon();
1.1 www 51:
52: sub handler {
53:
54: my $r=shift;
55:
56: my $fn;
57:
1.23 foxr 58:
59:
60: $fn = getEffectiveUrl($r);
61:
62: # Validate access to the construction space and get username@domain.
1.6 www 63:
64: my $uname;
65: my $udom;
66:
1.9 www 67: ($uname,$udom)=
1.6 www 68: &Apache::loncacc::constructaccess(
1.9 www 69: $fn,$r->dir_config('lonDefDomain'));
70: unless (($uname) && ($udom)) {
1.6 www 71: $r->log_reason($uname.' at '.$udom.
1.32 www 72: ' trying to list directory '.$ENV{'form.filename'}.
1.6 www 73: ' ('.$fn.') - not authorized',
74: $r->filename);
75: return HTTP_NOT_ACCEPTABLE;
76: }
1.23 foxr 77:
1.32 www 78: # Remove trailing / from directory name.
1.23 foxr 79:
1.3 www 80: $fn=~s/\/$//;
1.1 www 81:
82: unless ($fn) {
83: $r->log_reason($ENV{'user.name'}.' at '.$ENV{'user.domain'}.
1.2 www 84: ' trying to list empty directory', $r->filename);
1.1 www 85: return HTTP_NOT_FOUND;
86: }
87:
88: # ----------------------------------------------------------- Start page output
89:
1.23 foxr 90: my $thisdisfn=$fn;
91: $thisdisfn=~s/^\/home\/$uname\/public_html//; # subdirectory part of
92: # construction space.
93: my $docroot=$r->dir_config('lonDocRoot'); # Apache londocument root.
1.1 www 94:
1.23 foxr 95: my $resdir=$docroot.'/res/'.$udom.'/'.$uname.$thisdisfn; # Resource directory
96: my $targetdir=$udom.'/'.$uname.$thisdisfn; # Publiction target directory.
1.25 www 97: my $linkdir='/priv/'.$uname.$thisdisfn; # Full URL name of constr space.
1.1 www 98:
99:
100:
1.26 www 101: &startpage($r, $uname, $udom, $thisdisfn); # Put out the start of page.
1.6 www 102:
1.23 foxr 103: # Start off the diretory table.
1.1 www 104:
1.2 www 105: $r->print('<table border=2>'.
1.23 foxr 106: '<tr><th>Actions</th><th>Name</th><th>Title</th>'.
107: '<th>Status</th><th>Last Modified</th></tr>');
1.1 www 108:
1.2 www 109: my $filename;
1.23 foxr 110: my $dirptr=16384; # Mask indicating a directory in stat.cmode.
1.1 www 111:
1.2 www 112: opendir(DIR,$fn);
1.10 albertel 113: my @files=sort(readdir(DIR));
1.11 albertel 114: foreach my $filename (@files) {
1.2 www 115: my ($cdev,$cino,$cmode,$cnlink,
116: $cuid,$cgid,$crdev,$csize,
117: $catime,$cmtime,$cctime,
118: $cblksize,$cblocks)=stat($fn.'/'.$filename);
1.12 www 119:
1.10 albertel 120: my $extension='';
121: if ($filename=~/\.(\w+)$/) { $extension=$1; }
1.15 matthew 122: if ($cmode&$dirptr) {
1.21 foxr 123: putdirectory($r, $thisdisfn, $linkdir, $filename, $cmtime);
1.17 harris41 124: } elsif (&Apache::loncommon::fileembstyle($extension) ne 'hdn') {
1.22 foxr 125: putresource($r, $uname, $filename, $thisdisfn, $resdir,
126: $targetdir, $linkdir, $cmtime);
1.14 albertel 127: } else {
1.15 matthew 128: # "hidden" extension and not a directory, so hide it away.
1.2 www 129: }
130: }
131: closedir(DIR);
132:
133: $r->print('</table></body></html>');
1.1 www 134: return OK;
135: }
1.21 foxr 136: #
1.23 foxr 137: # Gets the effective URL of the request and returns it:
138: # $effn = getEffectiveUrl($r);
139: # $r - The Apache Request object.
140: sub getEffectiveUrl {
141: my $r = shift;
142: my $fn;
143:
144: if ($ENV{'form.filename'}) { # If a form filename is defined.
145: $fn=$ENV{'form.filename'};
146: #
147: # Replace the ~username of the URL with /home/username/public_html
148: # so that we don't have to worry about ~ expansion internally.
149: #
1.32 www 150: $fn=~s/^http\:\/\/[^\/]+\///;
151: $fn=~s/^\///;
152: $fn=~s/\~(\w+)/\/home\/$1\/public_html/;
1.23 foxr 153:
154: # Remove trailing / strings (?)
155:
156: $fn=~s/\/[^\/]+$//;
1.24 albertel 157: } else {
158: # If no form is defined, use request filename.
159: $fn = $r->filename();
160: my $lonDocRoot=$r->dir_config('lonDocRoot');
161: if ( $fn =~ /$lonDocRoot/ ) {
162: #internal authentication, needs fixup.
163: $fn = $r->uri(); # non users do not get the full path request
164: # through SCRIPT_FILENAME
165: $fn=~s|^/~(\w+)|/home/$1/public_html|;
166: }
1.23 foxr 167: }
1.37 ! www 168: $fn=~s/\/+/\//g;
1.23 foxr 169: return $fn;
170: }
171: #
172: # Output the header of the page. This includes:
173: # - The HTML header
174: # - The H1/H3 stuff which includes the directory.
175: #
176: # startpage($r, $uame, $udom, $thisdisfn);
177: # $r - The apache request object.
178: # $uname - User name.
179: # $udom - Domain name the user is logged in under.
180: # $thisdisfn - Displayable version of the filename.
1.26 www 181:
1.23 foxr 182: sub startpage {
183: my ($r, $uname, $udom, $thisdisfn) = @_;
184:
185: $r->content_type('text/html');
186: $r->send_http_header;
187:
188: $r->print('<html><head><title>LON-CAPA Construction Space</title></head>');
189:
1.26 www 190: $r->print(&Apache::loncommon::bodytag(undef,undef,undef,1));
1.29 www 191: my $pubdirscript=(<<ENDPUBDIRSCRIPT);
192: <script>
1.37 ! www 193: // Store directory location for menu bar to find
! 194:
! 195: parent.lastknownpriv='/~$uname/$thisdisfn/';
! 196:
! 197: // Confirmation dialogues
! 198:
1.29 www 199: function pubdir(theform) {
200: if (confirm('Publish complete directory?')) {
201: theform.submit();
202: }
203: }
204: function pubrecdir(theform) {
205: if (confirm('Publish directory and all subdirectories?')) {
206: theform.pubrec.value='1';
207: theform.submit();
208: }
209: }
210: </script>
211: ENDPUBDIRSCRIPT
212:
1.23 foxr 213: $r->print('<h1>Construction Space Directory <tt>'.
1.31 albertel 214: $thisdisfn.'/</tt></h1>'.
215: '<script type="text/javascript">top.document.title = \''.
216: $thisdisfn.'/ - LON-CAPA Construction Space\';</script>'.
217: $pubdirscript.
1.26 www 218: '<form method="post" action="/adm/publish" target="_parent">'.
1.35 www 219: '<table><tr><td><input type="hidden" name="filename" value="/~'.
1.26 www 220: $uname.$thisdisfn.'/" />'.
1.29 www 221: '<input type="button" onClick="pubdir(this.form);" value="Publish Directory" />'.
222: '<input type="hidden" name="pubrec" value="" />'.
1.35 www 223: '<input type="button" onClick="pubrecdir(this.form);" value="Publish Directory and Sub Directories" /></td><td>'.
1.28 www 224: '<input type="button" onClick="window.location='."'/~".
1.35 www 225: $uname.$thisdisfn."/default.meta'".'" value="Edit Directory Catalog Information" /></td></tr><tr><td><input type="checkbox" name="forcerepub" /> Force publication of unmodified files.</td><td> </td></tr></table></form>');
1.23 foxr 226:
227: if (($uname ne $ENV{'user.name'}) || ($udom ne $ENV{'user.domain'})) {
228: $r->print('<h3>Co-Author: '.$uname.' at '.$udom.
229: '</h3>');
230: }
231: }
232:
233: #
234: # Get the title string or "[untitled]" if the file has no title metadata:
235: # Without the latter substitution, it's impossible to examine metadata for
236: # untitled resources. Resources may be legitimately untitled, to prevent
237: # searches from locating them.
238: #
239: # $str = getTitleString($fullname);
240: # $fullname - Fully qualified filename to check.
241: #
242: sub getTitleString {
243: my $fullname = shift;
244: my $title = &Apache::lonnet::metadata($fullname, 'title');
245:
246: unless ($title) {
247: $title = "[untitled]";
248: }
249: return $title;
250: }
251:
252:
253: #
1.21 foxr 254: # Put out a directory table row:
255: # putdirectory(r, base, here, dirname, modtime)
256: # r - Apache request object.
257: # reqfile - File in request.
258: # here - Where we are in directory tree.
259: # dirname - Name of directory special file.
260: # modtime - Encoded modification time.
261: #
262: sub putdirectory {
263: my ($r, $reqfile, $here, $dirname, $modtime) = @_;
264:
265: # construct the display filename: the directory name unless ..:
266:
267: my $disfilename = $dirname;
268: if ($dirname eq '..') {
269: $disfilename = '<i>Parent Directory</i>';
270: }
271: unless (( ($dirname eq '..') && ($reqfile eq '')) ||
272: ($dirname eq '.')) {
1.25 www 273: $r->print('<tr bgcolor="#CCCCFF">'.
274: '<td>Go to ...</td>'.
275: '<td><a href="'.$here.'/'.$dirname.'/" target="_top">'.
1.21 foxr 276: $disfilename.'</a></td>'.
277: '<td> </td>'.
278: '<td> </td>'.
279: '<td>'.localtime($modtime).'</td>'.
1.25 www 280: "</tr>\n");
1.21 foxr 281: }
282: return OK;
283: }
1.22 foxr 284: #
285: # Put a table row for a file resource.
286: #
287: sub putresource {
288: my ($r, $uname, $filename, $thisdisfn,
289: $resdir, $targetdir, $linkdir,
290: $cmtime) = @_;
291:
292: my $status='Unpublished';
1.25 www 293: my $bgcolor='#FFCCCC';
1.22 foxr 294: my $title=' ';
295: if (-e $resdir.'/'.$filename) {
296: my ($rdev,$rino,$rmode,$rnlink,
297: $ruid,$rgid,$rrdev,$rsize,
298: $ratime,$rmtime,$rctime,
299: $rblksize,$rblocks)=stat($resdir.'/'.$filename);
300: if ($rmtime>=$cmtime) {
301: $status='Published';
1.25 www 302: $bgcolor='#CCFFCC';
1.23 foxr 303: $title='<a href="/res/'.$targetdir.'/'.$filename.
304: '.meta" target=cat>'.
305: getTitleString($targetdir.'/'.$filename, 'title').'</a>';
1.22 foxr 306: } else {
307: $status='Modified';
1.25 www 308: $bgcolor='#FFFFCC';
1.22 foxr 309: $title='<a href="/res/'.$targetdir.'/'.$filename.'.meta" target=cat>'.
1.25 www 310: getTitleString($targetdir.'/'.$filename,'title').'</a>';
1.22 foxr 311: if (&Apache::loncommon::fileembstyle(($filename=~/\.(\w+)$/)) eq 'ssi') {
312: $status.='<br><a href="/adm/diff?filename=/~'.$uname.
313: $thisdisfn.'/'.$filename.
1.27 albertel 314: '&versiontwo=priv" target=cat>Diffs</a>';
1.22 foxr 315: }
316: }
317: $status.='<br><a href="/adm/retrieve?filename=/~'.$uname.
318: $thisdisfn.'/'.$filename.'" target=cat>Retrieve</a>';
319: }
1.33 www 320: my $editlink='';
1.36 www 321: if ($filename=~/\.(xml|html|htm|xhtml|xhtm|sty)$/) {
1.33 www 322: $editlink=' (<a href="'.$linkdir.'/'.$filename.'?forceedit=1" target="_top">Edit</a>)';
1.34 www 323: }
324: if ($filename=~/\.(problem|exam|quiz|assess|survey|form|library)$/) {
325: $editlink=' (<a href="'.$linkdir.'/'.$filename.'?forceedit=1" target="_top">EditXML</a>)';
1.33 www 326: }
1.25 www 327: $r->print('<tr bgcolor="'.$bgcolor.'">'.
1.22 foxr 328: '<td><a target="_parent" href="/adm/publish?filename=/~'.
329: $uname.$thisdisfn.'/'.$filename.'">'.'Publish</a>'.
330: '</td>'.
331: '<td>'.
1.25 www 332: '<a href="'.$linkdir.'/'.$filename.'" target="_top">'.
1.33 www 333: $filename.'</a>'.$editlink.
1.22 foxr 334: '</td>'.
335: '<td>'.$title.'</td>'.
336: '<td>'.$status.'</td>'.
337: '<td>'.localtime($cmtime).'</td>'.
1.25 www 338: "</tr>\n");
1.22 foxr 339: return OK;
1.23 foxr 340: }
341: #
342: # Categorize files in the directory.
343: # For each file in a list of files in a file directory,
344: # the file categorized as one of:
345: # - directory
346: # - sequence
347: # - problem
348: # - Other resource.
349: #
350: # For each file the modification date is determined as well.
351: # Returned is a list of sublists:
352: # (directories, sequences, problems, other)
353: # each of the sublists contains entries of the following form (sorted by
354: # filename):
355: # (filename, typecode, lastmodtime)
356: #
357: # $list = CategorizeFiles($location, $files)
358: # $location - Directory in which the files live (relative to our
359: # execution.
360: # $files - list of files.
361: #
362: sub CategorizeFiles {
363: my $location = shift;
364: my $files = shift;
1.22 foxr 365: }
366:
1.4 www 367: 1;
368: __END__
1.17 harris41 369:
370: =head1 NAME
371:
1.32 www 372: Apache::lonpubdir - Construction space directory lister
1.17 harris41 373:
374: =head1 SYNOPSIS
375:
376: Invoked (for various locations) by /etc/httpd/conf/srm.conf:
377:
1.18 harris41 378: <LocationMatch "^/\~.*/$">
379: PerlAccessHandler Apache::loncacc
380: SetHandler perl-script
381: PerlHandler Apache::lonpubdir
382: ErrorDocument 403 /adm/login
383: ErrorDocument 404 /adm/notfound.html
384: ErrorDocument 406 /adm/unauthorized.html
385: ErrorDocument 500 /adm/errorhandler
386: </LocationMatch>
387:
388: <Location /adm/pubdir>
389: PerlAccessHandler Apache::lonacc
390: SetHandler perl-script
391: PerlHandler Apache::lonpubdir
392: ErrorDocument 403 /adm/login
393: ErrorDocument 404 /adm/notfound.html
394: ErrorDocument 406 /adm/unauthorized.html
395: ErrorDocument 500 /adm/errorhandler
396: </Location>
1.17 harris41 397:
398: =head1 INTRODUCTION
399:
1.18 harris41 400: This module publishes a directory of files.
1.17 harris41 401:
402: This is part of the LearningOnline Network with CAPA project
403: described at http://www.lon-capa.org.
404:
405: =head1 HANDLER SUBROUTINE
406:
407: This routine is called by Apache and mod_perl.
408:
409: =over 4
410:
411: =item *
412:
413: read in information
414:
415: =item *
416:
417: start page output
418:
419: =item *
420:
421: run through list of files and attempt to publish unhidden files
422:
423: =back
424:
425: =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