1: # The LearningOnline Network with CAPA
2: # Publication Handler
3: #
4: # $Id: lonpublisher.pm,v 1.127 2003/07/25 02:04:51 bowersj2 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: # (TeX Content Handler
30: #
31: # 05/29/00,05/30,10/11 Gerd Kortemeyer)
32: #
33: # 11/28,11/29,11/30,12/01,12/02,12/04,12/23 Gerd Kortemeyer
34: # 03/23 Guy Albertelli
35: # 03/24,03/29,04/03 Gerd Kortemeyer
36: # 05/03,05/05,05/07 Gerd Kortemeyer
37: # 06/23,08/07,08/11,8/13,8/17,8/18,8/24,9/26,10/16 Gerd Kortemeyer
38: # 12/04,12/05 Guy Albertelli
39: # 12/05 Gerd Kortemeyer
40: # 12/05 Guy Albertelli
41: # 12/06,12/07 Gerd Kortemeyer
42: # 12/25 Gerd Kortemeyer
43: # YEAR=2002
44: # 1/17 Gerd Kortemeyer
45: #
46: ###
47:
48: ###############################################################################
49: ## ##
50: ## ORGANIZATION OF THIS PERL MODULE ##
51: ## ##
52: ## 1. Modules used by this module ##
53: ## 2. Various subroutines ##
54: ## 3. Publication Step One ##
55: ## 4. Phase Two ##
56: ## 5. Main Handler ##
57: ## ##
58: ###############################################################################
59:
60:
61: ######################################################################
62: ######################################################################
63:
64: =pod
65:
66: =head1 NAME
67:
68: lonpublisher - LON-CAPA publishing handler
69:
70: =head1 SYNOPSIS
71:
72: B<lonpublisher> is used by B<mod_perl> inside B<Apache>. This is the
73: invocation by F<loncapa_apache.conf>:
74:
75: <Location /adm/publish>
76: PerlAccessHandler Apache::lonacc
77: SetHandler perl-script
78: PerlHandler Apache::lonpublisher
79: ErrorDocument 403 /adm/login
80: ErrorDocument 404 /adm/notfound.html
81: ErrorDocument 406 /adm/unauthorized.html
82: ErrorDocument 500 /adm/errorhandler
83: </Location>
84:
85: =head1 OVERVIEW
86:
87: Authors can only write-access the C</~authorname/> space. They can
88: copy resources into the resource area through the publication step,
89: and move them back through a recover step. Authors do not have direct
90: write-access to their resource space.
91:
92: During the publication step, several events will be
93: triggered. Metadata is gathered, where a wizard manages default
94: entries on a hierarchical per-directory base: The wizard imports the
95: metadata (including access privileges and royalty information) from
96: the most recent published resource in the current directory, and if
97: that is not available, from the next directory above, etc. The Network
98: keeps all previous versions of a resource and makes them available by
99: an explicit version number, which is inserted between the file name
100: and extension, for example C<foo.2.html>, while the most recent
101: version does not carry a version number (C<foo.html>). Servers
102: subscribing to a changed resource are notified that a new version is
103: available.
104:
105: =head1 DESCRIPTION
106:
107: B<lonpublisher> takes the proper steps to add resources to the LON-CAPA
108: digital library. This includes updating the metadata table in the
109: LON-CAPA database.
110:
111: B<lonpublisher> is many things to many people.
112:
113: This module publishes a file. This involves gathering metadata,
114: versioning the file, copying file from construction space to
115: publication space, and copying metadata from construction space
116: to publication space.
117:
118: =head2 SUBROUTINES
119:
120: Many of the undocumented subroutines implement various magical
121: parsing shortcuts.
122:
123: =over 4
124:
125: =cut
126:
127: ######################################################################
128: ######################################################################
129:
130:
131: package Apache::lonpublisher;
132:
133: # ------------------------------------------------- modules used by this module
134: use strict;
135: use Apache::File;
136: use File::Copy;
137: use Apache::Constants qw(:common :http :methods);
138: use HTML::LCParser;
139: use Apache::lonxml;
140: use Apache::loncacc;
141: use DBI;
142: use Apache::lonnet();
143: use Apache::loncommon();
144: use Apache::lonmysql;
145: use vars qw(%metadatafields %metadatakeys);
146:
147: my %addid;
148: my %nokey;
149:
150: my $docroot;
151:
152: my $cuname;
153: my $cudom;
154:
155: =pod
156:
157: =item B<metaeval>
158:
159: Evaluates a string that contains metadata. This subroutine
160: stores values inside I<%metadatafields> and I<%metadatakeys>.
161: The hash key is a I<$unikey> corresponding to a unique id
162: that is descriptive of the parser location inside the XML tree.
163:
164: Parameters:
165:
166: =over 4
167:
168: =item I<$metastring>
169:
170: A string that contains metadata.
171:
172: =back
173:
174: Returns:
175:
176: nothing
177:
178: =cut
179:
180: #########################################
181: #########################################
182: sub metaeval {
183: my $metastring=shift;
184:
185: my $parser=HTML::LCParser->new(\$metastring);
186: my $token;
187: while ($token=$parser->get_token) {
188: if ($token->[0] eq 'S') {
189: my $entry=$token->[1];
190: my $unikey=$entry;
191: if (defined($token->[2]->{'package'})) {
192: $unikey.='_package_'.$token->[2]->{'package'};
193: }
194: if (defined($token->[2]->{'part'})) {
195: $unikey.='_'.$token->[2]->{'part'};
196: }
197: if (defined($token->[2]->{'id'})) {
198: $unikey.='_'.$token->[2]->{'id'};
199: }
200: if (defined($token->[2]->{'name'})) {
201: $unikey.='_'.$token->[2]->{'name'};
202: }
203: foreach (@{$token->[3]}) {
204: $metadatafields{$unikey.'.'.$_}=$token->[2]->{$_};
205: if ($metadatakeys{$unikey}) {
206: $metadatakeys{$unikey}.=','.$_;
207: } else {
208: $metadatakeys{$unikey}=$_;
209: }
210: }
211: if ($metadatafields{$unikey}) {
212: my $newentry=$parser->get_text('/'.$entry);
213: unless (($metadatafields{$unikey}=~/\Q$newentry\E/) ||
214: ($newentry eq '')) {
215: $metadatafields{$unikey}.=', '.$newentry;
216: }
217: } else {
218: $metadatafields{$unikey}=$parser->get_text('/'.$entry);
219: }
220: }
221: }
222: }
223:
224: #########################################
225: #########################################
226:
227: =pod
228:
229: =item B<metaread>
230:
231: Read a metadata file
232:
233: Parameters:
234:
235: =over
236:
237: =item I<$logfile>
238:
239: File output stream to output errors and warnings to.
240:
241: =item I<$fn>
242:
243: File name (including path).
244:
245: =back
246:
247: Returns:
248:
249: =over 4
250:
251: =item Scalar string (if successful)
252:
253: XHTML text that indicates successful reading of the metadata.
254:
255: =back
256:
257: =cut
258:
259: #########################################
260: #########################################
261: sub metaread {
262: my ($logfile,$fn)=@_;
263: unless (-e $fn) {
264: print($logfile 'No file '.$fn."\n");
265: return '<br /><b>No file:</b> <tt>'.$fn.'</tt>';
266: }
267: print($logfile 'Processing '.$fn."\n");
268: my $metastring;
269: {
270: my $metafh=Apache::File->new($fn);
271: $metastring=join('',<$metafh>);
272: }
273: &metaeval($metastring);
274: return '<br /><b>Processed file:</b> <tt>'.$fn.'</tt>';
275: }
276:
277: #########################################
278: #########################################
279:
280: sub coursedependencies {
281: my $url=&Apache::lonnet::declutter(shift);
282: $url=~s/\.meta$//;
283: my ($adomain,$aauthor)=($url=~/^(\w+)\/(\w+)\//);
284: my $regexp=$url;
285: $regexp=~s/(\W)/\\$1/g;
286: $regexp='___'.$regexp.'___course';
287: my %evaldata=&Apache::lonnet::dump('nohist_resevaldata',$adomain,
288: $aauthor,$regexp);
289: my %courses=();
290: foreach (keys %evaldata) {
291: if ($_=~/^([a-zA-Z0-9]+_[a-zA-Z0-9]+)___.+___course$/) {
292: $courses{$1}=1;
293: }
294: }
295: return %courses;
296: }
297: #########################################
298: #########################################
299:
300:
301: =pod
302:
303: =item Form-field-generating subroutines.
304:
305: For input parameters, these subroutines take in values
306: such as I<$name>, I<$value> and other form field metadata.
307: The output (scalar string that is returned) is an XHTML
308: string which presents the form field (foreseeably inside
309: <form></form> tags).
310:
311: =over 4
312:
313: =item B<textfield>
314:
315: =item B<hiddenfield>
316:
317: =item B<selectbox>
318:
319: =back
320:
321: =cut
322:
323: #########################################
324: #########################################
325: sub textfield {
326: my ($title,$name,$value)=@_;
327: my $uctitle=uc($title);
328: return "\n<p><font color=\"#800000\" face=\"helvetica\"><b>$uctitle:".
329: "</b></font></p><br />".
330: '<input type="text" name="'.$name.'" size=80 value="'.$value.'" />';
331: }
332:
333: sub hiddenfield {
334: my ($name,$value)=@_;
335: return "\n".'<input type="hidden" name="'.$name.'" value="'.$value.'" />';
336: }
337:
338: sub selectbox {
339: my ($title,$name,$value,$functionref,@idlist)=@_;
340: my $uctitle=uc($title);
341: $value=(split(/\s*,\s*/,$value))[-1];
342: my $selout="\n<p><font color=\"#800000\" face=\"helvetica\"><b>$uctitle:".
343: '</b></font></p><br /><select name="'.$name.'">';
344: foreach (@idlist) {
345: $selout.='<option value=\''.$_.'\'';
346: if ($_ eq $value) {
347: $selout.=' selected>'.&{$functionref}($_).'</option>';
348: }
349: else {$selout.='>'.&{$functionref}($_).'</option>';}
350: }
351: return $selout.'</select>';
352: }
353:
354: #########################################
355: #########################################
356:
357: =pod
358:
359: =item B<urlfixup>
360:
361: Fix up a url? First step of publication
362:
363: =cut
364:
365: #########################################
366: #########################################
367: sub urlfixup {
368: my ($url,$target)=@_;
369: unless ($url) { return ''; }
370: #javascript code needs no fixing
371: if ($url =~ /^javascript:/i) { return $url; }
372: if ($url =~ /^mailto:/i) { return $url; }
373: #internal document links need no fixing
374: if ($url =~ /^\#/) { return $url; }
375: my ($host)=($url=~/(?:http\:\/\/)*([^\/]+)/);
376: foreach (values %Apache::lonnet::hostname) {
377: if ($_ eq $host) {
378: $url=~s/^http\:\/\///;
379: $url=~s/^$host//;
380: }
381: }
382: if ($url=~/^http\:\/\//) { return $url; }
383: $url=~s/\~$cuname/res\/$cudom\/$cuname/;
384: return $url;
385: }
386:
387: #########################################
388: #########################################
389:
390: =pod
391:
392: =item B<absoluteurl>
393:
394: Currently undocumented.
395:
396: =cut
397:
398: #########################################
399: #########################################
400: sub absoluteurl {
401: my ($url,$target)=@_;
402: unless ($url) { return ''; }
403: if ($target) {
404: $target=~s/\/[^\/]+$//;
405: $url=&Apache::lonnet::hreflocation($target,$url);
406: }
407: return $url;
408: }
409:
410: #########################################
411: #########################################
412:
413: =pod
414:
415: =item B<set_allow>
416:
417: Currently undocumented
418:
419: =cut
420:
421: #########################################
422: #########################################
423: sub set_allow {
424: my ($allow,$logfile,$target,$tag,$oldurl)=@_;
425: my $newurl=&urlfixup($oldurl,$target);
426: my $return_url=$oldurl;
427: print $logfile 'GUYURL: '.$tag.':'.$oldurl.' - '.$newurl."\n";
428: if ($newurl ne $oldurl) {
429: $return_url=$newurl;
430: print $logfile 'URL: '.$tag.':'.$oldurl.' - '.$newurl."\n";
431: }
432: if (($newurl !~ /^javascript:/i) &&
433: ($newurl !~ /^mailto:/i) &&
434: ($newurl !~ /^http:/i) &&
435: ($newurl !~ /^\#/)) {
436: $$allow{&absoluteurl($newurl,$target)}=1;
437: }
438: return $return_url
439: }
440:
441: #########################################
442: #########################################
443:
444: =pod
445:
446: =item B<get_subscribed_hosts>
447:
448: Currently undocumented
449:
450: =cut
451:
452: #########################################
453: #########################################
454: sub get_subscribed_hosts {
455: my ($target)=@_;
456: my @subscribed;
457: my $filename;
458: $target=~/(.*)\/([^\/]+)$/;
459: my $srcf=$2;
460: opendir(DIR,$1);
461: while ($filename=readdir(DIR)) {
462: if ($filename=~/\Q$srcf\E\.(\w+)$/) {
463: my $subhost=$1;
464: if (($subhost ne 'meta' && $subhost ne 'subscription') &&
465: ($subhost ne $Apache::lonnet::perlvar{'lonHostID'})) {
466: push(@subscribed,$subhost);
467: }
468: }
469: }
470: closedir(DIR);
471: my $sh;
472: if ( $sh=Apache::File->new("$target.subscription") ) {
473: &Apache::lonnet::logthis("opened $target.subscription");
474: while (my $subline=<$sh>) {
475: &Apache::lonnet::logthis("Trying $subline");
476: if ($subline =~ /(^\w+):/) {
477: if ($1 ne $Apache::lonnet::perlvar{'lonHostID'}) {
478: push(@subscribed,$1);
479: }
480: } else {
481: &Apache::lonnet::logthis("No Match for $subline");
482: }
483: }
484: } else {
485: &Apache::lonnet::logthis("Unable to open $target.subscription");
486: }
487: return @subscribed;
488: }
489:
490:
491: #########################################
492: #########################################
493:
494: =pod
495:
496: =item B<get_max_ids_indices>
497:
498: Currently undocumented
499:
500: =cut
501:
502: #########################################
503: #########################################
504: sub get_max_ids_indices {
505: my ($content)=@_;
506: my $maxindex=10;
507: my $maxid=10;
508: my $needsfixup=0;
509: my $duplicateids=0;
510:
511: my %allids;
512: my %duplicatedids;
513:
514: my $parser=HTML::LCParser->new($content);
515: my $token;
516: while ($token=$parser->get_token) {
517: if ($token->[0] eq 'S') {
518: my $counter;
519: if ($counter=$addid{$token->[1]}) {
520: if ($counter eq 'id') {
521: if (defined($token->[2]->{'id'})) {
522: $maxid=($token->[2]->{'id'}>$maxid)?$token->[2]->{'id'}:$maxid;
523: if (exists($allids{$token->[2]->{'id'}})) {
524: $duplicateids=1;
525: $duplicatedids{$token->[2]->{'id'}}=1;
526: } else {
527: $allids{$token->[2]->{'id'}}=1;
528: }
529: } else {
530: $needsfixup=1;
531: }
532: } else {
533: if (defined($token->[2]->{'index'})) {
534: $maxindex=($token->[2]->{'index'}>$maxindex)?$token->[2]->{'index'}:$maxindex;
535: } else {
536: $needsfixup=1;
537: }
538: }
539: }
540: }
541: }
542: return ($needsfixup,$maxid,$maxindex,$duplicateids,
543: (keys(%duplicatedids)));
544: }
545:
546: #########################################
547: #########################################
548:
549: =pod
550:
551: =item B<get_all_text_unbalanced>
552:
553: Currently undocumented
554:
555: =cut
556:
557: #########################################
558: #########################################
559: sub get_all_text_unbalanced {
560: #there is a copy of this in lonxml.pm
561: my($tag,$pars)= @_;
562: my $token;
563: my $result='';
564: $tag='<'.$tag.'>';
565: while ($token = $$pars[-1]->get_token) {
566: if (($token->[0] eq 'T')||($token->[0] eq 'C')||($token->[0] eq 'D')) {
567: $result.=$token->[1];
568: } elsif ($token->[0] eq 'PI') {
569: $result.=$token->[2];
570: } elsif ($token->[0] eq 'S') {
571: $result.=$token->[4];
572: } elsif ($token->[0] eq 'E') {
573: $result.=$token->[2];
574: }
575: if ($result =~ /(.*)\Q$tag\E(.*)/s) {
576: #&Apache::lonnet::logthis('Got a winner with leftovers ::'.$2);
577: #&Apache::lonnet::logthis('Result is :'.$1);
578: $result=$1;
579: my $redo=$tag.$2;
580: push (@$pars,HTML::LCParser->new(\$redo));
581: $$pars[-1]->xml_mode('1');
582: last;
583: }
584: }
585: return $result
586: }
587:
588: #########################################
589: #########################################
590:
591: =pod
592:
593: =item B<fix_ids_and_indices>
594:
595: Currently undocumented
596:
597: =cut
598:
599: #########################################
600: #########################################
601: #Arguably this should all be done as a lonnet::ssi instead
602: sub fix_ids_and_indices {
603: my ($logfile,$source,$target)=@_;
604:
605: my %allow;
606: my $content;
607: {
608: my $org=Apache::File->new($source);
609: $content=join('',<$org>);
610: }
611:
612: my ($needsfixup,$maxid,$maxindex,$duplicateids,@duplicatedids)=
613: &get_max_ids_indices(\$content);
614:
615: print $logfile ("Got $needsfixup,$maxid,$maxindex,$duplicateids--".
616: join(', ',@duplicatedids));
617: if ($duplicateids) {
618: print $logfile "Duplicate ID(s) exist, ".join(', ',@duplicatedids)."\n";
619: my $outstring='<font color="red">Unable to publish file, it contains duplicated ID(s), ID(s) need to be unique. The duplicated ID(s) are: '.join(', ',@duplicatedids).'</font>';
620: return ($outstring,1);
621: }
622: if ($needsfixup) {
623: print $logfile "Needs ID and/or index fixup\n".
624: "Max ID : $maxid (min 10)\n".
625: "Max Index: $maxindex (min 10)\n";
626: }
627: my $outstring='';
628: my @parser;
629: $parser[0]=HTML::LCParser->new(\$content);
630: $parser[-1]->xml_mode(1);
631: my $token;
632: while (@parser) {
633: while ($token=$parser[-1]->get_token) {
634: if ($token->[0] eq 'S') {
635: my $counter;
636: my $tag=$token->[1];
637: my $lctag=lc($tag);
638: if ($lctag eq 'allow') {
639: $allow{$token->[2]->{'src'}}=1;
640: next;
641: }
642: my %parms=%{$token->[2]};
643: $counter=$addid{$tag};
644: if (!$counter) { $counter=$addid{$lctag}; }
645: if ($counter) {
646: if ($counter eq 'id') {
647: unless (defined($parms{'id'})) {
648: $maxid++;
649: $parms{'id'}=$maxid;
650: print $logfile 'ID: '.$tag.':'.$maxid."\n";
651: }
652: } elsif ($counter eq 'index') {
653: unless (defined($parms{'index'})) {
654: $maxindex++;
655: $parms{'index'}=$maxindex;
656: print $logfile 'Index: '.$tag.':'.$maxindex."\n";
657: }
658: }
659: }
660: foreach my $type ('src','href','background','bgimg') {
661: foreach my $key (keys(%parms)) {
662: if ($key =~ /^$type$/i) {
663: $parms{$key}=&set_allow(\%allow,$logfile,
664: $target,$tag,
665: $parms{$key});
666: }
667: }
668: }
669: # probably a <randomlabel> image type <label>
670: if ($lctag eq 'label' && defined($parms{'description'})) {
671: my $next_token=$parser[-1]->get_token();
672: if ($next_token->[0] eq 'T') {
673: $next_token->[1]=&set_allow(\%allow,$logfile,
674: $target,$tag,
675: $next_token->[1]);
676: }
677: $parser[-1]->unget_token($next_token);
678: }
679: if ($lctag eq 'applet') {
680: my $codebase='';
681: if (defined($parms{'codebase'})) {
682: my $oldcodebase=$parms{'codebase'};
683: unless ($oldcodebase=~/\/$/) {
684: $oldcodebase.='/';
685: }
686: $codebase=&urlfixup($oldcodebase,$target);
687: $codebase=~s/\/$//;
688: if ($codebase ne $oldcodebase) {
689: $parms{'codebase'}=$codebase;
690: print $logfile 'URL codebase: '.$tag.':'.
691: $oldcodebase.' - '.
692: $codebase."\n";
693: }
694: $allow{&absoluteurl($codebase,$target).'/*'}=1;
695: } else {
696: foreach ('archive','code','object') {
697: if (defined($parms{$_})) {
698: my $oldurl=$parms{$_};
699: my $newurl=&urlfixup($oldurl,$target);
700: $newurl=~s/\/[^\/]+$/\/\*/;
701: print $logfile 'Allow: applet '.$_.':'.
702: $oldurl.' allows '.
703: $newurl."\n";
704: $allow{&absoluteurl($newurl,$target)}=1;
705: }
706: }
707: }
708: }
709: my $newparmstring='';
710: my $endtag='';
711: foreach (keys %parms) {
712: if ($_ eq '/') {
713: $endtag=' /';
714: } else {
715: my $quote=($parms{$_}=~/\"/?"'":'"');
716: $newparmstring.=' '.$_.'='.$quote.$parms{$_}.$quote;
717: }
718: }
719: if (!$endtag) { if ($token->[4]=~m:/>$:) { $endtag=' /'; }; }
720: $outstring.='<'.$tag.$newparmstring.$endtag.'>';
721: if ($lctag eq 'm') {
722: $outstring.=&get_all_text_unbalanced('/m',\@parser);
723: }
724: } elsif ($token->[0] eq 'E') {
725: if ($token->[2]) {
726: unless ($token->[1] eq 'allow') {
727: $outstring.='</'.$token->[1].'>';
728: }
729: }
730: } else {
731: $outstring.=$token->[1];
732: }
733: }
734: pop(@parser);
735: }
736:
737: if ($needsfixup) {
738: print $logfile "End of ID and/or index fixup\n".
739: "Max ID : $maxid (min 10)\n".
740: "Max Index: $maxindex (min 10)\n";
741: } else {
742: print $logfile "Does not need ID and/or index fixup\n";
743: }
744:
745: return ($outstring,0,%allow);
746: }
747:
748: #########################################
749: #########################################
750:
751: =pod
752:
753: =item B<store_metadata>
754:
755: Store the metadata in the metadata table in the loncapa database.
756: Uses lonmysql to access the database.
757:
758: Inputs: \%metadata
759:
760: Returns: (error,status). error is undef on success, status is undef on error.
761:
762: =cut
763:
764: #########################################
765: #########################################
766: sub store_metadata {
767: my %metadata = %{shift()};
768: my $error;
769: # Determine if the table exists
770: my $status = &Apache::lonmysql::check_table('metadata');
771: if (! defined($status)) {
772: $error='<font color="red">WARNING: Cannot connect to '.
773: 'database!</font>';
774: &Apache::lonnet::logthis($error);
775: return ($error,undef);
776: }
777: if ($status == 0) {
778: # It would be nice to actually create the table....
779: $error ='<font color="red">WARNING: The metadata table does not '.
780: 'exist in the LON-CAPA database.</font>';
781: &Apache::lonnet::logthis($error);
782: return ($error,undef);
783: }
784: # Remove old value from table
785: $status = &Apache::lonmysql::remove_from_table
786: ('metadata','url',$metadata{'url'});
787: if (! defined($status)) {
788: $error = '<font color="red">Error when removing old values from '.
789: 'metadata table in LON-CAPA database.</font>';
790: &Apache::lonnet::logthis($error);
791: return ($error,undef);
792: }
793: # Store data in table.
794: $status = &Apache::lonmysql::store_row('metadata',\%metadata);
795: if (! defined($status)) {
796: $error='<font color="red">Error occured storing new values in '.
797: 'metadata table in LON-CAPA database</font>';
798: &Apache::lonnet::logthis($error);
799: return ($error,undef);
800: }
801: return (undef,$status);
802: }
803:
804: #########################################
805: #########################################
806:
807: =pod
808:
809: =item B<publish>
810:
811: This is the workhorse function of this module. This subroutine generates
812: backup copies, performs any automatic processing (prior to publication,
813: especially for rat and ssi files),
814:
815: Returns a 2 element array, the first is the string to be shown to the
816: user, the second is an error code, either 1 (an error occured) or 0
817: (no error occurred)
818:
819: I<Additional documentation needed.>
820:
821: =cut
822:
823: #########################################
824: #########################################
825: sub publish {
826:
827: my ($source,$target,$style,$batch)=@_;
828: my $logfile;
829: my $scrout='';
830: my $allmeta='';
831: my $content='';
832: my %allow=();
833:
834: unless ($logfile=Apache::File->new('>>'.$source.'.log')) {
835: return ('<font color="red">No write permission to user directory, FAIL</font>',1);
836: }
837: print $logfile
838: "\n\n================= Publish ".localtime()." Phase One ================\n".$ENV{'user.name'}.'@'.$ENV{'user.domain'}."\n";
839:
840: if (($style eq 'ssi') || ($style eq 'rat') || ($style eq 'prv')) {
841: # ------------------------------------------------------- This needs processing
842:
843: # ----------------------------------------------------------------- Backup Copy
844: my $copyfile=$source.'.save';
845: if (copy($source,$copyfile)) {
846: print $logfile "Copied original file to ".$copyfile."\n";
847: } else {
848: print $logfile "Unable to write backup ".$copyfile.':'.$!."\n";
849: return ("<font color=\"red\">Failed to write backup copy, $!,FAIL</font>",1);
850: }
851: # ------------------------------------------------------------- IDs and indices
852:
853: my ($outstring,$error);
854: ($outstring,$error,%allow)=&fix_ids_and_indices($logfile,$source,
855: $target);
856: if ($error) { return ($outstring,$error); }
857: # ------------------------------------------------------------ Construct Allows
858:
859: $scrout.='<h3>Dependencies</h3>';
860: my $allowstr='';
861: foreach (sort(keys(%allow))) {
862: my $thisdep=$_;
863: if ($thisdep !~ /[^\s]/) { next; }
864: unless ($style eq 'rat') {
865: $allowstr.="\n".'<allow src="'.$thisdep.'" />';
866: }
867: $scrout.='<br />';
868: unless ($thisdep=~/\*/) {
869: $scrout.='<a href="'.$thisdep.'">';
870: }
871: $scrout.='<tt>'.$thisdep.'</tt>';
872: unless ($thisdep=~/\*/) {
873: $scrout.='</a>';
874: if (
875: &Apache::lonnet::getfile($Apache::lonnet::perlvar{'lonDocRoot'}.'/'.
876: $thisdep.'.meta') eq '-1') {
877: $scrout.= ' - <font color="red">Currently not available'.
878: '</font>';
879: } else {
880: my %temphash=(&Apache::lonnet::declutter($target).'___'.
881: &Apache::lonnet::declutter($thisdep).'___usage'
882: => time);
883: $thisdep=~/^\/res\/(\w+)\/(\w+)\//;
884: if ((defined($1)) && (defined($2))) {
885: &Apache::lonnet::put('nohist_resevaldata',\%temphash,
886: $1,$2);
887: }
888: }
889: }
890: }
891: $outstring=~s/\n*(\<\/[^\>]+\>)\s*$/$allowstr\n$1\n/s;
892:
893: #Encode any High ASCII characters
894: $outstring=&HTML::Entities::encode($outstring,"\200-\377");
895: # ------------------------------------------------------------- Write modified.
896:
897: {
898: my $org;
899: unless ($org=Apache::File->new('>'.$source)) {
900: print $logfile "No write permit to $source\n";
901: return ('<font color="red">No write permission to '.$source.
902: ', FAIL</font>',1);
903: }
904: print($org $outstring);
905: }
906: $content=$outstring;
907:
908: }
909: # -------------------------------------------- Initial step done, now metadata.
910:
911: # --------------------------------------- Storage for metadata keys and fields.
912:
913: %metadatafields=();
914: %metadatakeys=();
915:
916: my %oldparmstores=();
917:
918: unless ($batch) {
919: $scrout.='<h3>Metadata Information ' .
920: Apache::loncommon::help_open_topic("Metadata_Description")
921: . '</h3>';
922: }
923:
924: # ------------------------------------------------ First, check out environment
925: unless (-e $source.'.meta') {
926: $metadatafields{'author'}=$ENV{'environment.firstname'}.' '.
927: $ENV{'environment.middlename'}.' '.
928: $ENV{'environment.lastname'}.' '.
929: $ENV{'environment.generation'};
930: $metadatafields{'author'}=~s/\s+/ /g;
931: $metadatafields{'author'}=~s/\s+$//;
932: $metadatafields{'owner'}=$cuname.'@'.$cudom;
933: $metadatafields{'modifyinguser'}=$ENV{'user.name'}.'@'.
934: $ENV{'user.domain'};
935: $metadatafields{'authorspace'}=$cuname.'@'.$cudom;
936:
937: # ------------------------------------------------ Check out directory hierachy
938:
939: my $thisdisfn=$source;
940: $thisdisfn=~s/^\/home\/\Q$cuname\E\///;
941:
942: my @urlparts=split(/\//,$thisdisfn);
943: $#urlparts--;
944:
945: my $currentpath='/home/'.$cuname.'/';
946:
947: foreach (@urlparts) {
948: $currentpath.=$_.'/';
949: $scrout.=&metaread($logfile,$currentpath.'default.meta');
950: }
951:
952: # ------------------- Clear out parameters and stores (there should not be any)
953:
954: foreach (keys %metadatafields) {
955: if (($_=~/^parameter/) || ($_=~/^stores/)) {
956: delete $metadatafields{$_};
957: }
958: }
959:
960: } else {
961: # ---------------------- Read previous metafile, remember parameters and stores
962:
963: $scrout.=&metaread($logfile,$source.'.meta');
964:
965: foreach (keys %metadatafields) {
966: if (($_=~/^parameter/) || ($_=~/^stores/)) {
967: $oldparmstores{$_}=1;
968: delete $metadatafields{$_};
969: }
970: }
971:
972: }
973:
974: # -------------------------------------------------- Parse content for metadata
975: if (($style eq 'ssi') || ($style eq 'prv')) {
976: my $oldenv=$ENV{'request.uri'};
977:
978: $ENV{'request.uri'}=$target;
979: $allmeta=Apache::lonxml::xmlparse(undef,'meta',$content);
980: $ENV{'request.uri'}=$oldenv;
981:
982: &metaeval($allmeta);
983: }
984: # ---------------- Find and document discrepancies in the parameters and stores
985:
986: my $chparms='';
987: foreach (sort keys %metadatafields) {
988: if (($_=~/^parameter/) || ($_=~/^stores/)) {
989: unless ($_=~/\.\w+$/) {
990: unless ($oldparmstores{$_}) {
991: print $logfile 'New: '.$_."\n";
992: $chparms.=$_.' ';
993: }
994: }
995: }
996: }
997: if ($chparms) {
998: $scrout.='<p><b>New parameters or stored values:</b> '.$chparms.'</p>';
999: }
1000:
1001: $chparms='';
1002: foreach (sort keys %oldparmstores) {
1003: if (($_=~/^parameter/) || ($_=~/^stores/)) {
1004: unless (($metadatafields{$_.'.name'}) ||
1005: ($metadatafields{$_.'.package'}) || ($_=~/\.\w+$/)) {
1006: print $logfile 'Obsolete: '.$_."\n";
1007: $chparms.=$_.' ';
1008: }
1009: }
1010: }
1011: if ($chparms) {
1012: $scrout.='<p><b>Obsolete parameters or stored values:</b> '.
1013: $chparms.'</p>';
1014: }
1015:
1016: # ------------------------------------------------------- Now have all metadata
1017:
1018: my %keywords=();
1019:
1020: if (length($content)<500000) {
1021: my $textonly=$content;
1022: $textonly=~s/\<script[^\<]+\<\/script\>//g;
1023: $textonly=~s/\<m\>[^\<]+\<\/m\>//g;
1024: $textonly=~s/\<[^\>]*\>//g;
1025: $textonly=~tr/A-Z/a-z/;
1026: $textonly=~s/[\$\&][a-z]\w*//g;
1027: $textonly=~s/[^a-z\s]//g;
1028:
1029: foreach ($textonly=~m/(\w+)/g) {
1030: unless ($nokey{$_}) {
1031: $keywords{$_}=1;
1032: }
1033: }
1034: }
1035:
1036:
1037: foreach (split(/\W+/,$metadatafields{'keywords'})) {
1038: $keywords{$_}=1;
1039: }
1040: # --------------------------------------------------- Now we also have keywords
1041: # =============================================================================
1042: # INTERACTIVE MODE
1043: #
1044: unless ($batch) {
1045: $scrout.=
1046: '<form name="pubform" action="/adm/publish" method="post">'.
1047: '<p><input type="submit" value="Finalize Publication" /></p>'.
1048: &hiddenfield('phase','two').
1049: &hiddenfield('filename',$ENV{'form.filename'}).
1050: &hiddenfield('allmeta',&Apache::lonnet::escape($allmeta)).
1051: &hiddenfield('dependencies',join(',',keys %allow)).
1052: &textfield('Title','title',$metadatafields{'title'}).
1053: &textfield('Author(s)','author',$metadatafields{'author'}).
1054: &textfield('Subject','subject',$metadatafields{'subject'});
1055:
1056: # --------------------------------------------------- Scan content for keywords
1057:
1058: my $keywords_help = Apache::loncommon::help_open_topic("Publishing_Keywords");
1059: my $keywordout=<<"END";
1060: <script>
1061: function checkAll(field) {
1062: for (i = 0; i < field.length; i++)
1063: field[i].checked = true ;
1064: }
1065:
1066: function uncheckAll(field) {
1067: for (i = 0; i < field.length; i++)
1068: field[i].checked = false ;
1069: }
1070: </script>
1071: <p><font color="#800000" face="helvetica"><b>KEYWORDS:</b></font>
1072: $keywords_help</b>
1073: <input type="button" value="check all" onclick="javascript:checkAll(document.pubform.keywords)" />
1074: <input type="button" value="uncheck all" onclick="javascript:uncheckAll(document.pubform.keywords)" />
1075: </p>
1076: <br />
1077: END
1078: $keywordout.='<table border="2"><tr>';
1079: my $colcount=0;
1080:
1081: foreach (sort keys %keywords) {
1082: $keywordout.='<td><input type="checkbox" name="keywords" value="'.$_.'"';
1083: if ($metadatafields{'keywords'}) {
1084: if ($metadatafields{'keywords'}=~/\Q$_\E/) {
1085: $keywordout.=' checked="on"';
1086: }
1087: } elsif (&Apache::loncommon::keyword($_)) {
1088: $keywordout.=' checked="on"';
1089: }
1090: $keywordout.=' />'.$_.'</td>';
1091: if ($colcount>10) {
1092: $keywordout.="</tr><tr>\n";
1093: $colcount=0;
1094: }
1095: $colcount++;
1096: }
1097:
1098: $keywordout.='</tr></table>';
1099:
1100: $scrout.=$keywordout;
1101:
1102: $scrout.=&textfield('Additional Keywords','addkey','');
1103:
1104: $scrout.=&textfield('Notes','notes',$metadatafields{'notes'});
1105:
1106: $scrout.=
1107: "\n<p><font color=\"#800000\" face=\"helvetica\"><b>ABSTRACT:".
1108: "</b></font></p><br />".
1109: '<textarea cols="80" rows="5" name="abstract">'.
1110: $metadatafields{'abstract'}.'</textarea></p>';
1111:
1112: $source=~/\.(\w+)$/;
1113:
1114: $scrout.=&hiddenfield('mime',$1);
1115:
1116: my $defaultlanguage=$metadatafields{'language'};
1117: $defaultlanguage =~ s/\s*notset\s*//g;
1118: $defaultlanguage =~ s/^,\s*//g;
1119: $defaultlanguage =~ s/,\s*$//g;
1120:
1121: $scrout.=&selectbox('Language','language',
1122: $defaultlanguage,
1123: \&Apache::loncommon::languagedescription,
1124: (&Apache::loncommon::languageids),
1125: );
1126:
1127: unless ($metadatafields{'creationdate'}) {
1128: $metadatafields{'creationdate'}=time;
1129: }
1130: $scrout.=&hiddenfield('creationdate',
1131: &Apache::loncommon::unsqltime($metadatafields{'creationdate'}));
1132:
1133: $scrout.=&hiddenfield('lastrevisiondate',time);
1134:
1135:
1136: $scrout.=&textfield('Publisher/Owner','owner',
1137: $metadatafields{'owner'});
1138:
1139: # -------------------------------------------------- Correct copyright for rat.
1140: my $defaultoption=$metadatafields{'copyright'};
1141: unless ($defaultoption) { $defaultoption='default'; }
1142: unless ($style eq 'prv') {
1143: if ($style eq 'rat') {
1144: if ($metadatafields{'copyright'} eq 'public') {
1145: delete $metadatafields{'copyright'};
1146: $defaultoption='default';
1147: }
1148: $scrout.=&selectbox('Copyright/Distribution','copyright',
1149: $defaultoption,
1150: \&Apache::loncommon::copyrightdescription,
1151: (grep !/^public$/,(&Apache::loncommon::copyrightids)));
1152: } else {
1153: $scrout.=&selectbox('Copyright/Distribution','copyright',
1154: $defaultoption,
1155: \&Apache::loncommon::copyrightdescription,
1156: (&Apache::loncommon::copyrightids));
1157: }
1158:
1159: my $copyright_help =
1160: Apache::loncommon::help_open_topic('Publishing_Copyright');
1161: $scrout =~ s/DISTRIBUTION:/'DISTRIBUTION: ' . $copyright_help/ge;
1162: $scrout.=&textfield('Custom Distribution File','customdistributionfile',
1163: $metadatafields{'customdistributionfile'}).
1164: $copyright_help;
1165: } else {
1166: $scrout.=&hiddenfield('copyright','private');
1167: }
1168: return ($scrout.'<p><input type="submit" value="Finalize Publication" /></p></form>',0);
1169: # =============================================================================
1170: # BATCH MODE
1171: #
1172: } else {
1173: # Transfer metadata directly to environment for stage 2
1174: foreach (keys %metadatafields) {
1175: $ENV{'form.'.$_}=$metadatafields{$_};
1176: }
1177: $ENV{'form.addkey'}='';
1178: $ENV{'form.keywords'}='';
1179: foreach (keys %keywords) {
1180: if ($metadatafields{'keywords'}) {
1181: if ($metadatafields{'keywords'}=~/\Q$_\E/) {
1182: $ENV{'form.keywords'}.=$_.',';
1183: }
1184: } elsif (&Apache::loncommon::keyword($_)) {
1185: $ENV{'form.keywords'}.=$_.',';
1186: }
1187: }
1188: $ENV{'form.keywords'}=~s/\,$//;
1189: unless ($ENV{'form.creationdate'}) { $ENV{'form.creationdate'}=time; }
1190: $ENV{'form.lastrevisiondate'}=time;
1191: if ((($style eq 'rat') && ($ENV{'form.copyright'} eq 'public')) ||
1192: (!$ENV{'form.copyright'})) {
1193: $ENV{'form.copyright'}='default';
1194: }
1195: $ENV{'form.allmeta'}=&Apache::lonnet::escape($allmeta);
1196: return ($scrout,0);
1197: }
1198: }
1199:
1200: #########################################
1201: #########################################
1202:
1203: =pod
1204:
1205: =item B<phasetwo>
1206:
1207: Render second interface showing status of publication steps.
1208: This is publication step two.
1209:
1210: Parameters:
1211:
1212: =over 4
1213:
1214: =item I<$source>
1215:
1216: =item I<$target>
1217:
1218: =item I<$style>
1219:
1220: =item I<$distarget>
1221:
1222: =back
1223:
1224: Returns:
1225:
1226: =over 4
1227:
1228: =item Scalar string
1229:
1230: String contains status (errors and warnings) and information associated with
1231: the server's attempts at publication.
1232:
1233: =cut
1234:
1235: #'stupid emacs
1236: #########################################
1237: #########################################
1238: sub phasetwo {
1239:
1240: my ($r,$source,$target,$style,$distarget,$batch)=@_;
1241: $source=~s/\/+/\//g;
1242: $target=~s/\/+/\//g;
1243:
1244: if ($target=~/\_\_\_/) {
1245: $r->print(
1246: '<font color="red">Unsupported character combination "<tt>___</tt>" in filename, FAIL</font>');
1247: return 0;
1248: }
1249: $distarget=~s/\/+/\//g;
1250: my $logfile;
1251: unless ($logfile=Apache::File->new('>>'.$source.'.log')) {
1252: $r->print(
1253: '<font color="red">No write permission to user directory, FAIL</font>');
1254: return 0;
1255: }
1256: print $logfile
1257: "\n================= Publish ".localtime()." Phase Two ================\n".$ENV{'user.name'}.'@'.$ENV{'user.domain'}."\n";
1258:
1259: %metadatafields=();
1260: %metadatakeys=();
1261:
1262: &metaeval(&Apache::lonnet::unescape($ENV{'form.allmeta'}));
1263:
1264: $metadatafields{'title'}=$ENV{'form.title'};
1265: $metadatafields{'author'}=$ENV{'form.author'};
1266: $metadatafields{'subject'}=$ENV{'form.subject'};
1267: $metadatafields{'notes'}=$ENV{'form.notes'};
1268: $metadatafields{'abstract'}=$ENV{'form.abstract'};
1269: $metadatafields{'mime'}=$ENV{'form.mime'};
1270: $metadatafields{'language'}=$ENV{'form.language'};
1271: $metadatafields{'creationdate'}=$ENV{'form.creationdate'};
1272: $metadatafields{'lastrevisiondate'}=$ENV{'form.lastrevisiondate'};
1273: $metadatafields{'owner'}=$ENV{'form.owner'};
1274: $metadatafields{'copyright'}=$ENV{'form.copyright'};
1275: $metadatafields{'customdistributionfile'}=
1276: $ENV{'form.customdistributionfile'};
1277: $metadatafields{'dependencies'}=$ENV{'form.dependencies'};
1278:
1279: my $allkeywords=$ENV{'form.addkey'};
1280: if (exists($ENV{'form.keywords'})) {
1281: if (ref($ENV{'form.keywords'})) {
1282: $allkeywords .= ','.join(',',@{$ENV{'form.keywords'}});
1283: } else {
1284: $allkeywords .= ','.$ENV{'form.keywords'};
1285: }
1286: }
1287: $allkeywords=~s/\W+/\,/;
1288: $allkeywords=~s/^\,//;
1289: $metadatafields{'keywords'}=$allkeywords;
1290:
1291: {
1292: print $logfile "\nWrite metadata file for ".$source;
1293: my $mfh;
1294: unless ($mfh=Apache::File->new('>'.$source.'.meta')) {
1295: return
1296: '<font color="red">Could not write metadata, FAIL</font>';
1297: }
1298: foreach (sort keys %metadatafields) {
1299: unless ($_=~/\./) {
1300: my $unikey=$_;
1301: $unikey=~/^([A-Za-z]+)/;
1302: my $tag=$1;
1303: $tag=~tr/A-Z/a-z/;
1304: print $mfh "\n\<$tag";
1305: foreach (split(/\,/,$metadatakeys{$unikey})) {
1306: my $value=$metadatafields{$unikey.'.'.$_};
1307: $value=~s/\"/\'\'/g;
1308: print $mfh ' '.$_.'="'.$value.'"';
1309: }
1310: print $mfh '>'.
1311: &HTML::Entities::encode($metadatafields{$unikey})
1312: .'</'.$tag.'>';
1313: }
1314: }
1315: $r->print('<p>Wrote Metadata</p>');
1316: print $logfile "\nWrote metadata";
1317: }
1318:
1319: # -------------------------------- Synchronize entry with SQL metadata database
1320:
1321: $metadatafields{'url'} = $distarget;
1322: $metadatafields{'version'} = 'current';
1323: unless ($metadatafields{'copyright'} eq 'priv') {
1324: my ($error,$success) = &store_metadata(\%metadatafields);
1325: if ($success) {
1326: $r->print('<p>Synchronized SQL metadata database</p>');
1327: print $logfile "\nSynchronized SQL metadata database";
1328: } else {
1329: $r->print($error);
1330: print $logfile "\n".$error;
1331: }
1332: } else {
1333: $r->print('<p>Private Publication - did not synchronize database</p>');
1334: print $logfile "\nPrivate: Did not synchronize data into ".
1335: "SQL metadata database";
1336: }
1337: # ----------------------------------------------------------- Copy old versions
1338:
1339: if (-e $target) {
1340: my $filename;
1341: my $maxversion=0;
1342: $target=~/(.*)\/([^\/]+)\.(\w+)$/;
1343: my $srcf=$2;
1344: my $srct=$3;
1345: my $srcd=$1;
1346: unless ($srcd=~/^\/home\/httpd\/html\/res/) {
1347: print $logfile "\nPANIC: Target dir is ".$srcd;
1348: return "<font color=\"red\">Invalid target directory, FAIL</font>";
1349: }
1350: opendir(DIR,$srcd);
1351: while ($filename=readdir(DIR)) {
1352: if (-l $srcd.'/'.$filename) {
1353: unlink($srcd.'/'.$filename);
1354: unlink($srcd.'/'.$filename.'.meta');
1355: } else {
1356: if ($filename=~/\Q$srcf\E\.(\d+)\.\Q$srct\E$/) {
1357: $maxversion=($1>$maxversion)?$1:$maxversion;
1358: }
1359: }
1360: }
1361: closedir(DIR);
1362: $maxversion++;
1363: $r->print('<p>Creating old version '.$maxversion.'</p>');
1364: print $logfile "\nCreating old version ".$maxversion."\n";
1365:
1366: my $copyfile=$srcd.'/'.$srcf.'.'.$maxversion.'.'.$srct;
1367:
1368: if (copy($target,$copyfile)) {
1369: print $logfile "Copied old target to ".$copyfile."\n";
1370: $r->print('<p>Copied old target file</p>');
1371: } else {
1372: print $logfile "Unable to write ".$copyfile.':'.$!."\n";
1373: return "<font color=\"red\">Failed to copy old target, $!, FAIL</font>";
1374: }
1375:
1376: # --------------------------------------------------------------- Copy Metadata
1377:
1378: $copyfile=$copyfile.'.meta';
1379:
1380: if (copy($target.'.meta',$copyfile)) {
1381: print $logfile "Copied old target metadata to ".$copyfile."\n";
1382: $r->print('<p>Copied old metadata</p>')
1383: } else {
1384: print $logfile "Unable to write metadata ".$copyfile.':'.$!."\n";
1385: if (-e $target.'.meta') {
1386: return
1387: "<font color=\"red\">Failed to write old metadata copy, $!, FAIL</font>";
1388: }
1389: }
1390:
1391:
1392: } else {
1393: $r->print('<p>Initial version</p>');
1394: print $logfile "\nInitial version";
1395: }
1396:
1397: # ---------------------------------------------------------------- Write Source
1398: my $copyfile=$target;
1399:
1400: my @parts=split(/\//,$copyfile);
1401: my $path="/$parts[1]/$parts[2]/$parts[3]/$parts[4]";
1402:
1403: my $count;
1404: for ($count=5;$count<$#parts;$count++) {
1405: $path.="/$parts[$count]";
1406: if ((-e $path)!=1) {
1407: print $logfile "\nCreating directory ".$path;
1408: $r->print('<p>Created directory '.$parts[$count].'</p>');
1409: mkdir($path,0777);
1410: }
1411: }
1412:
1413: if (copy($source,$copyfile)) {
1414: print $logfile "\nCopied original source to ".$copyfile."\n";
1415: $r->print('<p>Copied source file</p>');
1416: } else {
1417: print $logfile "\nUnable to write ".$copyfile.':'.$!."\n";
1418: return "<font color=\"red\">Failed to copy source, $!, FAIL</font>";
1419: }
1420:
1421: # --------------------------------------------------------------- Copy Metadata
1422:
1423: $copyfile=$copyfile.'.meta';
1424:
1425: if (copy($source.'.meta',$copyfile)) {
1426: print $logfile "\nCopied original metadata to ".$copyfile."\n";
1427: $r->print('<p>Copied metadata</p>');
1428: } else {
1429: print $logfile "\nUnable to write metadata ".$copyfile.':'.$!."\n";
1430: return
1431: "<font color=\"red\">Failed to write metadata copy, $!, FAIL</font>";
1432: }
1433: $r->rflush;
1434: # --------------------------------------------------- Send update notifications
1435:
1436: my @subscribed=&get_subscribed_hosts($target);
1437: foreach my $subhost (@subscribed) {
1438: $r->print('<p>Notifying host '.$subhost.':');$r->rflush;
1439: print $logfile "\nNotifying host ".$subhost.':';
1440: my $reply=&Apache::lonnet::critical('update:'.$target,$subhost);
1441: $r->print($reply.'</p><br />');$r->rflush;
1442: print $logfile $reply;
1443: }
1444:
1445: # ---------------------------------------- Send update notifications, meta only
1446:
1447: my @subscribedmeta=&get_subscribed_hosts("$target.meta");
1448: foreach my $subhost (@subscribedmeta) {
1449: $r->print('<p>Notifying host for metadata only '.$subhost.':');$r->rflush;
1450: print $logfile "\nNotifying host for metadata only ".$subhost.':';
1451: my $reply=&Apache::lonnet::critical('update:'.$target.'.meta',
1452: $subhost);
1453: $r->print($reply.'</p><br />');$r->rflush;
1454: print $logfile $reply;
1455: }
1456:
1457: # --------------------------------------------------- Notify subscribed courses
1458: my %courses=&coursedependencies($target);
1459: my $now=time;
1460: foreach (keys %courses) {
1461: $r->print('<p>Notifying course '.$_.':');$r->rflush;
1462: print $logfile "\nNotifying host ".$_.':';
1463: my ($cdom,$cname)=split(/\_/,$_);
1464: my $reply=&Apache::lonnet::cput
1465: ('versionupdate',{$target => $now},$cdom,$cname);
1466: $r->print($reply.'</p><br />');$r->rflush;
1467: print $logfile $reply;
1468: }
1469: # ------------------------------------------------ Provide link to new resource
1470: unless ($batch) {
1471: my $thisdistarget=$target;
1472: $thisdistarget=~s/^\Q$docroot\E//;
1473:
1474: my $thissrc=$source;
1475: $thissrc=~s/^\/home\/(\w+)\/public_html/\/priv\/$1/;
1476:
1477: my $thissrcdir=$thissrc;
1478: $thissrcdir=~s/\/[^\/]+$/\//;
1479:
1480:
1481: $r->print(
1482: '<hr /><a href="'.$thisdistarget.'"><font size="+2">'.
1483: 'View Published Version</font></a>'.
1484: '<p><a href="'.$thissrc.'"><font size=+2>Back to Source</font></a></p>'.
1485: '<p><a href="'.$thissrcdir.
1486: '"><font size="+2">Back to Source Directory</font></a></p>');
1487: }
1488: }
1489:
1490: #########################################
1491:
1492: sub batchpublish {
1493: my ($r,$srcfile,$targetfile)=@_;
1494: $srcfile=~s/\/+/\//g;
1495: $targetfile=~s/\/+/\//g;
1496: my $thisdisfn=$srcfile;
1497: $thisdisfn=~s/\/home\/korte\/public_html\///;
1498: $srcfile=~s/\/+/\//g;
1499:
1500: my $docroot=$r->dir_config('lonDocRoot');
1501: my $thisdistarget=$targetfile;
1502: $thisdistarget=~s/^\Q$docroot\E//;
1503:
1504:
1505: undef %metadatafields;
1506: undef %metadatakeys;
1507: %metadatafields=();
1508: %metadatakeys=();
1509: $srcfile=~/\.(\w+)$/;
1510: my $thistype=$1;
1511:
1512:
1513: my $thisembstyle=&Apache::loncommon::fileembstyle($thistype);
1514:
1515: $r->print('<h2>Publishing <tt>'.$thisdisfn.'</tt></h2>');
1516:
1517: # phase one takes
1518: # my ($source,$target,$style,$batch)=@_;
1519: my ($outstring,$error)=&publish($srcfile,$targetfile,$thisembstyle,1);
1520: $r->print('<p>'.$outstring.'</p>');
1521: # phase two takes
1522: # my ($source,$target,$style,$distarget,batch)=@_;
1523: # $ENV{'form.allmeta'},$ENV{'form.title'},$ENV{'form.author'},...
1524: if (!$error) {
1525: $r->print('<p>');
1526: &phasetwo($r,$srcfile,$targetfile,$thisembstyle,$thisdistarget,1);
1527: $r->print('</p>');
1528: }
1529: return '';
1530: }
1531:
1532: #########################################
1533:
1534: sub publishdirectory {
1535: my ($r,$fn,$thisdisfn)=@_;
1536: $fn=~s/\/+/\//g;
1537: $thisdisfn=~s/\/+/\//g;
1538: my $resdir=
1539: $Apache::lonnet::perlvar{'lonDocRoot'}.'/res/'.$cudom.'/'.$cuname.'/'.
1540: $thisdisfn;
1541: $r->print('<h1>Directory <tt>'.$thisdisfn.'</tt></h1>'.
1542: 'Target: <tt>'.$resdir.'</tt><br />');
1543:
1544: my $dirptr=16384; # Mask indicating a directory in stat.cmode.
1545:
1546: opendir(DIR,$fn);
1547: my @files=sort(readdir(DIR));
1548: foreach my $filename (@files) {
1549: my ($cdev,$cino,$cmode,$cnlink,
1550: $cuid,$cgid,$crdev,$csize,
1551: $catime,$cmtime,$cctime,
1552: $cblksize,$cblocks)=stat($fn.'/'.$filename);
1553:
1554: my $extension='';
1555: if ($filename=~/\.(\w+)$/) { $extension=$1; }
1556: if ($cmode&$dirptr) {
1557: if (($filename!~/^\./) && ($ENV{'form.pubrec'})) {
1558: &publishdirectory($r,$fn.'/'.$filename,$thisdisfn.'/'.$filename);
1559: }
1560: } elsif ((&Apache::loncommon::fileembstyle($extension) ne 'hdn') &&
1561: ($filename!~/^[\#\.]/) && ($filename!~/\~$/)) {
1562: # find out publication status and/or exiting metadata
1563: my $publishthis=0;
1564: if (-e $resdir.'/'.$filename) {
1565: my ($rdev,$rino,$rmode,$rnlink,
1566: $ruid,$rgid,$rrdev,$rsize,
1567: $ratime,$rmtime,$rctime,
1568: $rblksize,$rblocks)=stat($resdir.'/'.$filename);
1569: if (($rmtime<$cmtime) || ($ENV{'form.forcerepub'})) {
1570: # previously published, modified now
1571: $publishthis=1;
1572: }
1573: } else {
1574: # never published
1575: $publishthis=1;
1576: }
1577: if ($publishthis) {
1578: &batchpublish($r,$fn.'/'.$filename,$resdir.'/'.$filename);
1579: } else {
1580: $r->print('<br />Skipping '.$filename.'<br />');
1581: }
1582: $r->rflush();
1583: }
1584: }
1585: closedir(DIR);
1586: }
1587: #########################################
1588:
1589: =pod
1590:
1591: =item B<handler>
1592:
1593: A basic outline of the handler subroutine follows.
1594:
1595: =over 4
1596:
1597: =item *
1598:
1599: Get query string for limited number of parameters.
1600:
1601: =item *
1602:
1603: Check filename.
1604:
1605: =item *
1606:
1607: File is there and owned, init lookup tables.
1608:
1609: =item *
1610:
1611: Start page output.
1612:
1613: =item *
1614:
1615: Evaluate individual file, and then output information.
1616:
1617: =item *
1618:
1619: Publishing from $thisfn to $thistarget with $thisembstyle.
1620:
1621: =back
1622:
1623: =cut
1624:
1625: #########################################
1626: #########################################
1627: sub handler {
1628: my $r=shift;
1629:
1630: if ($r->header_only) {
1631: $r->content_type('text/html');
1632: $r->send_http_header;
1633: return OK;
1634: }
1635:
1636: # Get query string for limited number of parameters
1637:
1638: &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},
1639: ['filename']);
1640:
1641: # -------------------------------------------------------------- Check filename
1642:
1643: my $fn=&Apache::lonnet::unescape($ENV{'form.filename'});
1644:
1645:
1646: unless ($fn) {
1647: $r->log_reason($cuname.' at '.$cudom.
1648: ' trying to publish empty filename', $r->filename);
1649: return HTTP_NOT_FOUND;
1650: }
1651:
1652: ($cuname,$cudom)=
1653: &Apache::loncacc::constructaccess($fn,$r->dir_config('lonDefDomain'));
1654: unless (($cuname) && ($cudom)) {
1655: $r->log_reason($cuname.' at '.$cudom.
1656: ' trying to publish file '.$ENV{'form.filename'}.
1657: ' ('.$fn.') - not authorized',
1658: $r->filename);
1659: return HTTP_NOT_ACCEPTABLE;
1660: }
1661:
1662: unless (&Apache::lonnet::homeserver($cuname,$cudom)
1663: eq $r->dir_config('lonHostID')) {
1664: $r->log_reason($cuname.' at '.$cudom.
1665: ' trying to publish file '.$ENV{'form.filename'}.
1666: ' ('.$fn.') - not homeserver ('.
1667: &Apache::lonnet::homeserver($cuname,$cudom).')',
1668: $r->filename);
1669: return HTTP_NOT_ACCEPTABLE;
1670: }
1671:
1672: $fn=~s/^http\:\/\/[^\/]+//;
1673: $fn=~s/^\/\~(\w+)/\/home\/$1\/public_html/;
1674:
1675: my $targetdir='';
1676: $docroot=$r->dir_config('lonDocRoot');
1677: if ($1 ne $cuname) {
1678: $r->log_reason($cuname.' at '.$cudom.
1679: ' trying to publish unowned file '.$ENV{'form.filename'}.
1680: ' ('.$fn.')',
1681: $r->filename);
1682: return HTTP_NOT_ACCEPTABLE;
1683: } else {
1684: $targetdir=$docroot.'/res/'.$cudom;
1685: }
1686:
1687:
1688: unless (-e $fn) {
1689: $r->log_reason($cuname.' at '.$cudom.
1690: ' trying to publish non-existing file '.$ENV{'form.filename'}.
1691: ' ('.$fn.')',
1692: $r->filename);
1693: return HTTP_NOT_FOUND;
1694: }
1695:
1696: unless ($ENV{'form.phase'} eq 'two') {
1697:
1698: # -------------------------------- File is there and owned, init lookup tables.
1699:
1700: %addid=();
1701:
1702: {
1703: my $fh=Apache::File->new($r->dir_config('lonTabDir').'/addid.tab');
1704: while (<$fh>=~/(\w+)\s+(\w+)/) {
1705: $addid{$1}=$2;
1706: }
1707: }
1708:
1709: %nokey=();
1710:
1711: {
1712: my $fh=Apache::File->new($r->dir_config('lonIncludes').'/un_keyword.tab');
1713: while (<$fh>) {
1714: my $word=$_;
1715: chomp($word);
1716: $nokey{$word}=1;
1717: }
1718: }
1719:
1720: }
1721:
1722: # ---------------------------------------------------------- Start page output.
1723:
1724: $r->content_type('text/html');
1725: $r->send_http_header;
1726:
1727: $r->print('<html><head><title>LON-CAPA Publishing</title></head>');
1728: $r->print(&Apache::loncommon::bodytag('Resource Publication'));
1729:
1730:
1731: my $thisfn=$fn;
1732:
1733: my $thistarget=$thisfn;
1734:
1735: $thistarget=~s/^\/home/$targetdir/;
1736: $thistarget=~s/\/public\_html//;
1737:
1738: my $thisdistarget=$thistarget;
1739: $thisdistarget=~s/^\Q$docroot\E//;
1740:
1741: my $thisdisfn=$thisfn;
1742: $thisdisfn=~s/^\/home\/\Q$cuname\E\/public_html\///;
1743:
1744: if ($fn=~/\/$/) {
1745: # -------------------------------------------------------- This is a directory
1746: &publishdirectory($r,$fn,$thisdisfn);
1747:
1748: } else {
1749: # ---------------------- Evaluate individual file, and then output information.
1750: $thisfn=~/\.(\w+)$/;
1751: my $thistype=$1;
1752: my $thisembstyle=&Apache::loncommon::fileembstyle($thistype);
1753:
1754: $r->print('<h2>Publishing '.
1755: &Apache::loncommon::filedescription($thistype).' <tt>'.
1756: '<a href="/~'.$cuname.'/'.$thisdisfn.'" target="cat">'.$thisdisfn.
1757: '</a></tt></h2><b>Target:</b> <tt>'.$thisdistarget.'</tt><br />');
1758:
1759: if (($cuname ne $ENV{'user.name'}) || ($cudom ne $ENV{'user.domain'})) {
1760: $r->print('<h3><font color="red">Co-Author: '.$cuname.' at '.$cudom.
1761: '</font></h3>');
1762: }
1763:
1764: if (&Apache::loncommon::fileembstyle($thistype) eq 'ssi') {
1765: $r->print('<br /><a href="/adm/diff?filename=/~'.$cuname.'/'.
1766: $thisdisfn.
1767: '&versiontwo=priv" target="cat">Diffs with Current Version</a><br />');
1768: }
1769:
1770: # ------------------ Publishing from $thisfn to $thistarget with $thisembstyle.
1771:
1772: unless ($ENV{'form.phase'} eq 'two') {
1773: my ($outstring,$error)=&publish($thisfn,$thistarget,$thisembstyle);
1774: $r->print('<hr />'.$outstring);
1775: } else {
1776: $r->print('<hr />');
1777: &phasetwo($r,$thisfn,$thistarget,$thisembstyle,$thisdistarget);
1778: }
1779: }
1780: $r->print('</body></html>');
1781:
1782: return OK;
1783: }
1784:
1785: 1;
1786: __END__
1787:
1788: =pod
1789:
1790: =back
1791:
1792: =back
1793:
1794: =cut
1795:
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>
![[BACK]](/icons/back.gif){kind=icon}
Return to lonpublisher.pm CVS log ![[TXT]](/icons/text.gif){kind=icon}
![[DIR]](/icons/dir.gif){kind=icon}
Up to [LON-CAPA] / loncom / publisher