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