Annotation of loncom/publisher/lonpubdir.pm, revision 1.23
1.1 www 1: # The LearningOnline Network with CAPA
1.16 albertel 2: # (Publication Handler
3: #
1.22 foxr 4: # $Id: lonpubdir.pm,v 1.21 2002/02/05 12:54:46 foxr 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
39: # 12/15 Scott Harrison
1.19 www 40: # 12/28 Gerd Kortemeyer
1.1 www 41: #
1.17 harris41 42: ###
1.1 www 43:
44: package Apache::lonpubdir;
45:
46: use strict;
47: use Apache::File;
48: use File::Copy;
49: use Apache::Constants qw(:common :http :methods);
1.6 www 50: use Apache::loncacc;
1.17 harris41 51: use Apache::loncommon();
1.1 www 52:
53: sub handler {
54:
55: my $r=shift;
56:
57: my $fn;
58:
1.23 ! foxr 59:
! 60:
! 61: $fn = getEffectiveUrl($r);
! 62:
! 63: # Validate access to the construction space and get username@domain.
1.6 www 64:
65: my $uname;
66: my $udom;
67:
1.9 www 68: ($uname,$udom)=
1.6 www 69: &Apache::loncacc::constructaccess(
1.9 www 70: $fn,$r->dir_config('lonDefDomain'));
71: unless (($uname) && ($udom)) {
1.6 www 72: $r->log_reason($uname.' at '.$udom.
73: ' trying to publish file '.$ENV{'form.filename'}.
74: ' ('.$fn.') - not authorized',
75: $r->filename);
76: return HTTP_NOT_ACCEPTABLE;
77: }
1.23 ! foxr 78:
! 79: # Remove trailing / from direcgtory name.
! 80:
1.3 www 81: $fn=~s/\/$//;
1.1 www 82:
83: unless ($fn) {
84: $r->log_reason($ENV{'user.name'}.' at '.$ENV{'user.domain'}.
1.2 www 85: ' trying to list empty directory', $r->filename);
1.1 www 86: return HTTP_NOT_FOUND;
87: }
88:
89: # ----------------------------------------------------------- Start page output
90:
1.23 ! foxr 91: my $thisdisfn=$fn;
! 92: $thisdisfn=~s/^\/home\/$uname\/public_html//; # subdirectory part of
! 93: # construction space.
! 94: my $docroot=$r->dir_config('lonDocRoot'); # Apache londocument root.
1.1 www 95:
1.23 ! foxr 96: my $resdir=$docroot.'/res/'.$udom.'/'.$uname.$thisdisfn; # Resource directory
! 97: my $targetdir=$udom.'/'.$uname.$thisdisfn; # Publiction target directory.
! 98: my $linkdir='/~'.$uname.$thisdisfn; # Full URL name of constr space.
1.1 www 99:
100:
101:
1.23 ! foxr 102: startpage($r, $uname, $udom, $thisdisfn); # Put out the start of page.
1.6 www 103:
1.23 ! foxr 104: # Start off the diretory table.
1.1 www 105:
1.2 www 106: $r->print('<table border=2>'.
1.23 ! foxr 107: '<tr><th>Actions</th><th>Name</th><th>Title</th>'.
! 108: '<th>Status</th><th>Last Modified</th></tr>');
1.1 www 109:
1.2 www 110: my $filename;
1.23 ! foxr 111: my $dirptr=16384; # Mask indicating a directory in stat.cmode.
1.1 www 112:
1.2 www 113: opendir(DIR,$fn);
1.10 albertel 114: my @files=sort(readdir(DIR));
1.11 albertel 115: foreach my $filename (@files) {
1.2 www 116: my ($cdev,$cino,$cmode,$cnlink,
117: $cuid,$cgid,$crdev,$csize,
118: $catime,$cmtime,$cctime,
119: $cblksize,$cblocks)=stat($fn.'/'.$filename);
1.12 www 120:
1.10 albertel 121: my $extension='';
122: if ($filename=~/\.(\w+)$/) { $extension=$1; }
1.15 matthew 123: if ($cmode&$dirptr) {
1.21 foxr 124: putdirectory($r, $thisdisfn, $linkdir, $filename, $cmtime);
1.17 harris41 125: } elsif (&Apache::loncommon::fileembstyle($extension) ne 'hdn') {
1.22 foxr 126: putresource($r, $uname, $filename, $thisdisfn, $resdir,
127: $targetdir, $linkdir, $cmtime);
1.14 albertel 128: } else {
1.15 matthew 129: # "hidden" extension and not a directory, so hide it away.
1.2 www 130: }
131: }
132: closedir(DIR);
133:
134: $r->print('</table></body></html>');
1.1 www 135: return OK;
136: }
1.21 foxr 137: #
1.23 ! foxr 138: # Gets the effective URL of the request and returns it:
! 139: # $effn = getEffectiveUrl($r);
! 140: # $r - The Apache Request object.
! 141: sub getEffectiveUrl {
! 142: my $r = shift;
! 143: my $fn;
! 144:
! 145: if ($ENV{'form.filename'}) { # If a form filename is defined.
! 146: $fn=$ENV{'form.filename'};
! 147: #
! 148: # Replace the ~username of the URL with /home/username/public_html
! 149: # so that we don't have to worry about ~ expansion internally.
! 150: #
! 151: $fn=~s/^http\:\/\/[^\/]+\/\~(\w+)/\/home\/$1\/public_html/;
! 152:
! 153: # Remove trailing / strings (?)
! 154:
! 155: $fn=~s/\/[^\/]+$//;
! 156: } else { # If no form is defined, use request filename.
! 157: $fn=$r->filename();
! 158: }
! 159: return $fn;
! 160: }
! 161: #
! 162: # Output the header of the page. This includes:
! 163: # - The HTML header
! 164: # - The H1/H3 stuff which includes the directory.
! 165: #
! 166: # startpage($r, $uame, $udom, $thisdisfn);
! 167: # $r - The apache request object.
! 168: # $uname - User name.
! 169: # $udom - Domain name the user is logged in under.
! 170: # $thisdisfn - Displayable version of the filename.
! 171: sub startpage {
! 172: my ($r, $uname, $udom, $thisdisfn) = @_;
! 173:
! 174: $r->content_type('text/html');
! 175: $r->send_http_header;
! 176:
! 177: $r->print('<html><head><title>LON-CAPA Construction Space</title></head>');
! 178:
! 179: $r->print('<body bgcolor="#FFFFFF"><img align=right '.
! 180: 'src=/adm/lonIcons/lonlogos.gif>');
! 181:
! 182: $r->print('<h1>Construction Space Directory <tt>'.
! 183: $thisdisfn.'/</tt></h1>');
! 184:
! 185: if (($uname ne $ENV{'user.name'}) || ($udom ne $ENV{'user.domain'})) {
! 186: $r->print('<h3>Co-Author: '.$uname.' at '.$udom.
! 187: '</h3>');
! 188: }
! 189: }
! 190:
! 191: #
! 192: # Get the title string or "[untitled]" if the file has no title metadata:
! 193: # Without the latter substitution, it's impossible to examine metadata for
! 194: # untitled resources. Resources may be legitimately untitled, to prevent
! 195: # searches from locating them.
! 196: #
! 197: # $str = getTitleString($fullname);
! 198: # $fullname - Fully qualified filename to check.
! 199: #
! 200: sub getTitleString {
! 201: my $fullname = shift;
! 202: my $title = &Apache::lonnet::metadata($fullname, 'title');
! 203:
! 204: unless ($title) {
! 205: $title = "[untitled]";
! 206: }
! 207: return $title;
! 208: }
! 209:
! 210:
! 211: #
1.21 foxr 212: # Put out a directory table row:
213: # putdirectory(r, base, here, dirname, modtime)
214: # r - Apache request object.
215: # reqfile - File in request.
216: # here - Where we are in directory tree.
217: # dirname - Name of directory special file.
218: # modtime - Encoded modification time.
219: #
220: sub putdirectory {
221: my ($r, $reqfile, $here, $dirname, $modtime) = @_;
222:
223: # construct the display filename: the directory name unless ..:
224:
225: my $disfilename = $dirname;
226: if ($dirname eq '..') {
227: $disfilename = '<i>Parent Directory</i>';
228: }
229: unless (( ($dirname eq '..') && ($reqfile eq '')) ||
230: ($dirname eq '.')) {
231: $r->print('<tr>'.
232: '<td>Click to cwd</td>'.
233: '<td><a href="'.$here.'/'.$dirname.'/">'.
234: $disfilename.'</a></td>'.
235: '<td> </td>'.
236: '<td> </td>'.
237: '<td>'.localtime($modtime).'</td>'.
238: '</tr>');
239: }
240: return OK;
241: }
1.22 foxr 242: #
243: # Put a table row for a file resource.
244: #
245: sub putresource {
246: my ($r, $uname, $filename, $thisdisfn,
247: $resdir, $targetdir, $linkdir,
248: $cmtime) = @_;
249:
250: my $status='Unpublished';
251: my $title=' ';
252: if (-e $resdir.'/'.$filename) {
253: my ($rdev,$rino,$rmode,$rnlink,
254: $ruid,$rgid,$rrdev,$rsize,
255: $ratime,$rmtime,$rctime,
256: $rblksize,$rblocks)=stat($resdir.'/'.$filename);
257: if ($rmtime>=$cmtime) {
258: $status='Published';
1.23 ! foxr 259: $title='<a href="/res/'.$targetdir.'/'.$filename.
! 260: '.meta" target=cat>'.
! 261: getTitleString($targetdir.'/'.$filename, 'title').'</a>';
1.22 foxr 262: } else {
263: $status='Modified';
264: $title='<a href="/res/'.$targetdir.'/'.$filename.'.meta" target=cat>'.
265: &Apache::lonnet::metadata($targetdir.'/'.$filename,'title').'</a>';
266: if (&Apache::loncommon::fileembstyle(($filename=~/\.(\w+)$/)) eq 'ssi') {
267: $status.='<br><a href="/adm/diff?filename=/~'.$uname.
268: $thisdisfn.'/'.$filename.
269: '&versionone=priv" target=cat>Diffs</a>';
270: }
271: }
272: $status.='<br><a href="/adm/retrieve?filename=/~'.$uname.
273: $thisdisfn.'/'.$filename.'" target=cat>Retrieve</a>';
274: }
275: $r->print('<tr>'.
276: '<td><a target="_parent" href="/adm/publish?filename=/~'.
277: $uname.$thisdisfn.'/'.$filename.'">'.'Publish</a>'.
278: '</td>'.
279: '<td>'.
280: '<a href="'.$linkdir.'/'.$filename.'">'.$filename.'</a>'.
281: '</td>'.
282: '<td>'.$title.'</td>'.
283: '<td>'.$status.'</td>'.
284: '<td>'.localtime($cmtime).'</td>'.
285: '</tr>');
286: return OK;
1.23 ! foxr 287: }
! 288: #
! 289: # Categorize files in the directory.
! 290: # For each file in a list of files in a file directory,
! 291: # the file categorized as one of:
! 292: # - directory
! 293: # - sequence
! 294: # - problem
! 295: # - Other resource.
! 296: #
! 297: # For each file the modification date is determined as well.
! 298: # Returned is a list of sublists:
! 299: # (directories, sequences, problems, other)
! 300: # each of the sublists contains entries of the following form (sorted by
! 301: # filename):
! 302: # (filename, typecode, lastmodtime)
! 303: #
! 304: # $list = CategorizeFiles($location, $files)
! 305: # $location - Directory in which the files live (relative to our
! 306: # execution.
! 307: # $files - list of files.
! 308: #
! 309: sub CategorizeFiles {
! 310: my $location = shift;
! 311: my $files = shift;
1.22 foxr 312: }
313:
1.4 www 314: 1;
315: __END__
1.17 harris41 316:
317: =head1 NAME
318:
319: Apache::lonpubdir - Publication Handler for Directories
320:
321: =head1 SYNOPSIS
322:
323: Invoked (for various locations) by /etc/httpd/conf/srm.conf:
324:
1.18 harris41 325: <LocationMatch "^/\~.*/$">
326: PerlAccessHandler Apache::loncacc
327: SetHandler perl-script
328: PerlHandler Apache::lonpubdir
329: ErrorDocument 403 /adm/login
330: ErrorDocument 404 /adm/notfound.html
331: ErrorDocument 406 /adm/unauthorized.html
332: ErrorDocument 500 /adm/errorhandler
333: </LocationMatch>
334:
335: <Location /adm/pubdir>
336: PerlAccessHandler Apache::lonacc
337: SetHandler perl-script
338: PerlHandler Apache::lonpubdir
339: ErrorDocument 403 /adm/login
340: ErrorDocument 404 /adm/notfound.html
341: ErrorDocument 406 /adm/unauthorized.html
342: ErrorDocument 500 /adm/errorhandler
343: </Location>
1.17 harris41 344:
345: =head1 INTRODUCTION
346:
1.18 harris41 347: This module publishes a directory of files.
1.17 harris41 348:
349: This is part of the LearningOnline Network with CAPA project
350: described at http://www.lon-capa.org.
351:
352: =head1 HANDLER SUBROUTINE
353:
354: This routine is called by Apache and mod_perl.
355:
356: =over 4
357:
358: =item *
359:
360: read in information
361:
362: =item *
363:
364: start page output
365:
366: =item *
367:
368: run through list of files and attempt to publish unhidden files
369:
370: =back
371:
372: =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