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