1: # The LearningOnline Network with CAPA
2: # Publication Handler
3: #
4: # $Id: lonpublisher.pm,v 1.171 2004/06/11 02:27:27 taceyjo1 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: if (($metadata{'obsolete'}) || ($metadata{'copyright'} eq 'priv') ||
805: ($metadata{'copyright'} eq 'custom')) {
806: # remove this entry
807: $status=&Apache::lonmysql::remove_from_table
808: ('metadata','url',$metadata{'url'});
809: } else {
810: # store new data
811: # adjust some values to metadatadatabase (e.g., "usage" is a reserved word)
812: $metadata{'creationdate'}=
813: &Apache::lonmysql::sqltime($metadata{'creationdate'});
814: $metadata{'lastrevisiondate'}=
815: &Apache::lonmysql::sqltime($metadata{'lastrevisiondate'});
816: $metadata{'sequsage'}=$metadata{'usage'};
817: $metadata{'sequsage_list'}=$metadata{'usage_list'};
818: my %newmetadata=();
819: # see if we have old entries
820: my @oldmeta=&Apache::lonmysql::get_rows('metadata',
821: "url LIKE BINARY '".
822: $metadata{'url'}."'");
823: if ($#oldmeta==0) {
824: # yes, there is one old entry, transfer to newmetadata
825: %newmetadata=&LONCAPA::lonmetadata::metadata_col_to_hash(@{$oldmeta[0]});
826: # remove old entry
827: $status=&Apache::lonmysql::remove_from_table
828: ('metadata','url',$metadata{'url'});
829: } elsif ($#oldmeta>0) {
830: # more than one entry fit - how did that happen?
831: $error='<font color="red">Error occured retrieving old values in '.
832: 'metadata table in LON-CAPA database: '.$#oldmeta.
833: ' matches</font>';
834: &Apache::lonnet::logthis($error);
835: return ($error,undef);
836: }
837: # store new data on top of it
838: foreach (keys %metadata) {
839: $newmetadata{$_}=$metadata{$_};
840: }
841: $status = &Apache::lonmysql::store_row('metadata',\%newmetadata);
842: }
843: if (! defined($status)) {
844: $error='<font color="red">Error occured storing new values in '.
845: 'metadata table in LON-CAPA database</font>';
846: &Apache::lonnet::logthis($error);
847: return ($error,undef);
848: }
849: return (undef,$status);
850: }
851:
852:
853: # ============================================== Parse file itself for metadata
854: #
855: # parses a file with target meta, sets global %metadatafields %metadatakeys
856:
857: sub parseformeta {
858: my ($source,$style)=@_;
859: my $allmeta='';
860: if (($style eq 'ssi') || ($style eq 'prv')) {
861: my $dir=$source;
862: $dir=~s-/[^/]*$--;
863: my $file=$source;
864: $file=(split('/',$file))[-1];
865: $source=&Apache::lonnet::hreflocation($dir,$file);
866: $allmeta=&Apache::lonnet::ssi_body($source,('grade_target' => 'meta'));
867: &metaeval($allmeta);
868: }
869: return $allmeta;
870: }
871:
872: #########################################
873: #########################################
874:
875: =pod
876:
877: =item B<publish>
878:
879: This is the workhorse function of this module. This subroutine generates
880: backup copies, performs any automatic processing (prior to publication,
881: especially for rat and ssi files),
882:
883: Returns a 2 element array, the first is the string to be shown to the
884: user, the second is an error code, either 1 (an error occured) or 0
885: (no error occurred)
886:
887: I<Additional documentation needed.>
888:
889: =cut
890:
891: #########################################
892: #########################################
893: sub publish {
894:
895: my ($source,$target,$style,$batch)=@_;
896: my $logfile;
897: my $scrout='';
898: my $allmeta='';
899: my $content='';
900: my %allow=();
901:
902: unless ($logfile=Apache::File->new('>>'.$source.'.log')) {
903: return ('<font color="red">'.&mt('No write permission to user directory, FAIL').'</font>',1);
904: }
905: print $logfile
906: "\n\n================= Publish ".localtime()." Phase One ================\n".$ENV{'user.name'}.'@'.$ENV{'user.domain'}."\n";
907:
908: if (($style eq 'ssi') || ($style eq 'rat') || ($style eq 'prv')) {
909: # ------------------------------------------------------- This needs processing
910:
911: # ----------------------------------------------------------------- Backup Copy
912: my $copyfile=$source.'.save';
913: if (copy($source,$copyfile)) {
914: print $logfile "Copied original file to ".$copyfile."\n";
915: } else {
916: print $logfile "Unable to write backup ".$copyfile.':'.$!."\n";
917: return ("<font color=\"red\">Failed to write backup copy, $!,FAIL</font>",1);
918: }
919: # ------------------------------------------------------------- IDs and indices
920:
921: my ($outstring,$error);
922: ($outstring,$error,%allow)=&fix_ids_and_indices($logfile,$source,
923: $target);
924: if ($error) { return ($outstring,$error); }
925: # ------------------------------------------------------------ Construct Allows
926:
927: $scrout.='<h3>'.&mt('Dependencies').'</h3>';
928: my $allowstr='';
929: foreach (sort(keys(%allow))) {
930: my $thisdep=$_;
931: if ($thisdep !~ /[^\s]/) { next; }
932: unless ($style eq 'rat') {
933: $allowstr.="\n".'<allow src="'.$thisdep.'" />';
934: }
935: $scrout.='<br />';
936: if ($thisdep!~/\*/ && $thisdep!~m|^/adm/|) {
937: $scrout.='<a href="'.$thisdep.'">';
938: }
939: $scrout.='<tt>'.$thisdep.'</tt>';
940: if ($thisdep!~/\*/ && $thisdep!~m|^/adm/|) {
941: $scrout.='</a>';
942: if (
943: &Apache::lonnet::getfile($Apache::lonnet::perlvar{'lonDocRoot'}.'/'.
944: $thisdep.'.meta') eq '-1') {
945: $scrout.= ' - <font color="red">'.&mt('Currently not available').
946: '</font>';
947: } else {
948: my %temphash=(&Apache::lonnet::declutter($target).'___'.
949: &Apache::lonnet::declutter($thisdep).'___usage'
950: => time);
951: $thisdep=~/^\/res\/(\w+)\/(\w+)\//;
952: if ((defined($1)) && (defined($2))) {
953: &Apache::lonnet::put('nohist_resevaldata',\%temphash,
954: $1,$2);
955: }
956: }
957: }
958: }
959: $outstring=~s/\n*(\<\/[^\>]+\>)\s*$/$allowstr\n$1\n/s;
960:
961: # ------------------------------------------------------------- Write modified.
962:
963: {
964: my $org;
965: unless ($org=Apache::File->new('>'.$source)) {
966: print $logfile "No write permit to $source\n";
967: return ('<font color="red">'.&mt('No write permission to').
968: ' '.$source.
969: ', '.&mt('FAIL').'</font>',1);
970: }
971: print($org $outstring);
972: }
973: $content=$outstring;
974:
975: }
976: # -------------------------------------------- Initial step done, now metadata.
977:
978: # --------------------------------------- Storage for metadata keys and fields.
979: # these are globals
980: #
981: %metadatafields=();
982: %metadatakeys=();
983:
984: my %oldparmstores=();
985:
986: unless ($batch) {
987: $scrout.='<h3>'.&mt('Metadata Information').' ' .
988: Apache::loncommon::help_open_topic("Metadata_Description")
989: . '</h3>';
990: }
991:
992: # ------------------------------------------------ First, check out environment
993: unless (-e $source.'.meta') {
994: $metadatafields{'author'}=$ENV{'environment.firstname'}.' '.
995: $ENV{'environment.middlename'}.' '.
996: $ENV{'environment.lastname'}.' '.
997: $ENV{'environment.generation'};
998: $metadatafields{'author'}=~s/\s+/ /g;
999: $metadatafields{'author'}=~s/\s+$//;
1000: $metadatafields{'owner'}=$cuname.'@'.$cudom;
1001:
1002: # ------------------------------------------------ Check out directory hierachy
1003:
1004: my $thisdisfn=$source;
1005: $thisdisfn=~s/^\/home\/\Q$cuname\E\///;
1006:
1007: my @urlparts=split(/\//,$thisdisfn);
1008: $#urlparts--;
1009:
1010: my $currentpath='/home/'.$cuname.'/';
1011:
1012: my $prefix='../'x($#urlparts);
1013: foreach (@urlparts) {
1014: $currentpath.=$_.'/';
1015: $scrout.=&metaread($logfile,$currentpath.'default.meta',$prefix);
1016: $prefix=~s|^\.\./||;
1017: }
1018: # ----------------------------------------------------------- Parse file itself
1019: # read %metadatafields from file itself
1020:
1021: $allmeta=&parseformeta($source,$style);
1022:
1023: # ------------------- Clear out parameters and stores (there should not be any)
1024:
1025: foreach (keys %metadatafields) {
1026: if (($_=~/^parameter/) || ($_=~/^stores/)) {
1027: delete $metadatafields{$_};
1028: }
1029: }
1030:
1031: } else {
1032: # ---------------------- Read previous metafile, remember parameters and stores
1033:
1034: $scrout.=&metaread($logfile,$source.'.meta');
1035:
1036: foreach (keys %metadatafields) {
1037: if (($_=~/^parameter/) || ($_=~/^stores/)) {
1038: $oldparmstores{$_}=1;
1039: delete $metadatafields{$_};
1040: }
1041: }
1042: # ------------------------------------------ See if anything new in file itself
1043:
1044: $allmeta=&parseformeta($source,$style);
1045:
1046: }
1047:
1048:
1049: # ---------------- Find and document discrepancies in the parameters and stores
1050:
1051: my $chparms='';
1052: foreach (sort keys %metadatafields) {
1053: if (($_=~/^parameter/) || ($_=~/^stores/)) {
1054: unless ($_=~/\.\w+$/) {
1055: unless ($oldparmstores{$_}) {
1056: print $logfile 'New: '.$_."\n";
1057: $chparms.=$_.' ';
1058: }
1059: }
1060: }
1061: }
1062: if ($chparms) {
1063: $scrout.='<p><b>'.&mt('New parameters or stored values').
1064: ':</b> '.$chparms.'</p>';
1065: }
1066:
1067: $chparms='';
1068: foreach (sort keys %oldparmstores) {
1069: if (($_=~/^parameter/) || ($_=~/^stores/)) {
1070: unless (($metadatafields{$_.'.name'}) ||
1071: ($metadatafields{$_.'.package'}) || ($_=~/\.\w+$/)) {
1072: print $logfile 'Obsolete: '.$_."\n";
1073: $chparms.=$_.' ';
1074: }
1075: }
1076: }
1077: if ($chparms) {
1078: $scrout.='<p><b>'.&mt('Obsolete parameters or stored values').':</b> '.
1079: $chparms.'</p><h1><font color="red">'.&mt('Warning!').
1080: '</font></h1><p><font color="red" size="+1">'.
1081: &mt('If this resource is in active use, student performance data from the previous version may become inaccessible.').'</font></p><hr />';
1082: }
1083:
1084: # ------------------------------------------------------- Now have all metadata
1085:
1086: my %keywords=();
1087:
1088: if (length($content)<500000) {
1089: my $textonly=$content;
1090: $textonly=~s/\<script[^\<]+\<\/script\>//g;
1091: $textonly=~s/\<m\>[^\<]+\<\/m\>//g;
1092: $textonly=~s/\<[^\>]*\>//g;
1093: $textonly=~tr/A-Z/a-z/;
1094: $textonly=~s/[\$\&][a-z]\w*//g;
1095: $textonly=~s/[^a-z\s]//g;
1096:
1097: foreach ($textonly=~m/(\w+)/g) {
1098: unless ($nokey{$_}) {
1099: $keywords{$_}=1;
1100: }
1101: }
1102: }
1103:
1104:
1105: foreach my $addkey (split(/[\"\'\,\;]/,$metadatafields{'keywords'})) {
1106: $addkey=~s/\s+/ /g;
1107: $addkey=~s/^\s//;
1108: $addkey=~s/\s$//;
1109: if ($addkey=~/\w/) {
1110: $keywords{$addkey}=1;
1111: }
1112: }
1113: # --------------------------------------------------- Now we also have keywords
1114: # =============================================================================
1115: # interactive mode html goes into $intr_scrout
1116: # batch mode throws away this HTML
1117: # additionally all of the field functions have a by product of setting
1118: # $ENV{'from.'..} so that it can be used by the phase two handler in
1119: # batch mode
1120:
1121: my $intr_scrout.=
1122: '<form name="pubform" action="/adm/publish" method="post">'.
1123: '<p><input type="submit" value="'.&mt('Finalize Publication').'" /></p>'.
1124: &hiddenfield('phase','two').
1125: &hiddenfield('filename',$ENV{'form.filename'}).
1126: &hiddenfield('allmeta',&Apache::lonnet::escape($allmeta)).
1127: &hiddenfield('dependencies',join(',',keys %allow)).
1128: &textfield('Title','title',$metadatafields{'title'}).
1129: &textfield('Author(s)','author',$metadatafields{'author'}).
1130: &textfield('Subject','subject',$metadatafields{'subject'});
1131:
1132: # --------------------------------------------------- Scan content for keywords
1133:
1134: my $keywords_help = Apache::loncommon::help_open_topic("Publishing_Keywords");
1135: my $KEYWORDS=&mt('Keywords');
1136: my $CheckAll=&mt('check all');
1137: my $UncheckAll=&mt('uncheck all');
1138: my $keywordout=<<"END";
1139: <script>
1140: function checkAll(field) {
1141: for (i = 0; i < field.length; i++)
1142: field[i].checked = true ;
1143: }
1144:
1145: function uncheckAll(field) {
1146: for (i = 0; i < field.length; i++)
1147: field[i].checked = false ;
1148: }
1149: </script>
1150: <p><font color="#800000" face="helvetica"><b>$KEYWORDS:</b></font>
1151: $keywords_help</b>
1152: <input type="button" value="$CheckAll" onclick="javascript:checkAll(document.pubform.keywords)" />
1153: <input type="button" value="$UncheckAll" onclick="javascript:uncheckAll(document.pubform.keywords)" />
1154: </p>
1155: <br />
1156: END
1157: $keywordout.='<table border="2"><tr>';
1158: my $colcount=0;
1159:
1160: foreach (sort keys %keywords) {
1161: $keywordout.='<td><input type="checkbox" name="keywords" value="'.$_.'"';
1162: if ($metadatafields{'keywords'}) {
1163: if ($metadatafields{'keywords'}=~/\Q$_\E/) {
1164: $keywordout.=' checked="on"';
1165: $ENV{'form.keywords'}.=$_.',';
1166: }
1167: } elsif (&Apache::loncommon::keyword($_)) {
1168: $keywordout.=' checked="on"';
1169: $ENV{'form.keywords'}.=$_.',';
1170: }
1171: $keywordout.=' />'.$_.'</td>';
1172: if ($colcount>10) {
1173: $keywordout.="</tr><tr>\n";
1174: $colcount=0;
1175: }
1176: $colcount++;
1177: }
1178: $ENV{'form.keywords'}=~s/\,$//;
1179:
1180: $keywordout.='</tr></table>';
1181:
1182: $intr_scrout.=$keywordout;
1183:
1184: $intr_scrout.=&textfield('Additional Keywords','addkey','');
1185:
1186: $intr_scrout.=&textfield('Notes','notes',$metadatafields{'notes'});
1187:
1188: $intr_scrout.=
1189: "\n<p><font color=\"#800000\" face=\"helvetica\"><b>".&mt('Abstract').":".
1190: "</b></font></p><br />".
1191: '<textarea cols="80" rows="5" name="abstract">'.
1192: $metadatafields{'abstract'}.'</textarea></p>';
1193:
1194: $source=~/\.(\w+)$/;
1195:
1196:
1197: $intr_scrout.=
1198: "\n<p><font color=\"#800000\" face=\"helvetica\"><b>".
1199: &mt('Lowest Grade Level').':'.
1200: "</b></font></p><br />".
1201: &select_level_form($metadatafields{'lowestgradelevel'},'lowestgradelevel').
1202: "\n<p><font color=\"#800000\" face=\"helvetica\"><b>".
1203: &mt('Highest Grade Level').':'.
1204: "</b></font></p><br />".
1205: &select_level_form($metadatafields{'highestgradelevel'},'highestgradelevel').
1206: &textfield('Standards','standards',$metadatafields{'standards'});
1207:
1208:
1209:
1210:
1211: $intr_scrout.=&hiddenfield('mime',$1);
1212:
1213: my $defaultlanguage=$metadatafields{'language'};
1214: $defaultlanguage =~ s/\s*notset\s*//g;
1215: $defaultlanguage =~ s/^,\s*//g;
1216: $defaultlanguage =~ s/,\s*$//g;
1217:
1218: $intr_scrout.=&selectbox('Language','language',
1219: $defaultlanguage,
1220: \&Apache::loncommon::languagedescription,
1221: (&Apache::loncommon::languageids),
1222: );
1223:
1224: unless ($metadatafields{'creationdate'}) {
1225: $metadatafields{'creationdate'}=time;
1226: }
1227: $intr_scrout.=&hiddenfield('creationdate',
1228: &Apache::lonmysql::unsqltime($metadatafields{'creationdate'}));
1229:
1230: $intr_scrout.=&hiddenfield('lastrevisiondate',time);
1231:
1232:
1233: $intr_scrout.=&textfield('Publisher/Owner','owner',
1234: $metadatafields{'owner'});
1235:
1236: # -------------------------------------------------- Correct copyright for rat.
1237: my $defaultoption=$metadatafields{'copyright'};
1238: unless ($defaultoption) { $defaultoption='default'; }
1239: unless ($style eq 'prv') {
1240: if ($style eq 'rat') {
1241: if ($metadatafields{'copyright'} eq 'public') {
1242: delete $metadatafields{'copyright'};
1243: $defaultoption='default';
1244: }
1245: $intr_scrout.=&selectbox('Copyright/Distribution','copyright',
1246: $defaultoption,
1247: \&Apache::loncommon::copyrightdescription,
1248: (grep !/^public$/,(&Apache::loncommon::copyrightids)));
1249: } else {
1250: $intr_scrout.=&selectbox('Copyright/Distribution','copyright',
1251: $defaultoption,
1252: \&Apache::loncommon::copyrightdescription,
1253: (&Apache::loncommon::copyrightids));
1254: }
1255:
1256: my $copyright_help =
1257: Apache::loncommon::help_open_topic('Publishing_Copyright');
1258: $intr_scrout =~ s/DISTRIBUTION:/'DISTRIBUTION: ' . $copyright_help/ge;
1259: $intr_scrout.=&textfield('Custom Distribution File','customdistributionfile',
1260: $metadatafields{'customdistributionfile'}).
1261: $copyright_help;
1262: $intr_scrout.=&selectbox('Source Distribution','sourceavail',
1263: $defaultoption,
1264: \&Apache::loncommon::source_copyrightdescription,
1265: (&Apache::loncommon::source_copyrightids));
1266: $intr_scrout.=&textfield('Source Custom Distribution File','sourcerights',
1267: $metadatafields{'sourcerights'});
1268: my $uctitle=&mt('Obsolete');
1269: $intr_scrout.=
1270: "\n<p><font color=\"#800000\" face=\"helvetica\"><b>$uctitle:".
1271: '</b></font> <input type="checkbox" name="obsolete" ';
1272: if ($metadatafields{'obsolete'}) {
1273: $intr_scrout.=' checked="1" ';
1274: }
1275: $intr_scrout.='/ ></p>'.
1276: &textfield('Suggested Replacement for Obsolete File',
1277: 'obsoletereplacement',
1278: $metadatafields{'obsoletereplacement'});
1279: } else {
1280: $intr_scrout.=&hiddenfield('copyright','private');
1281: }
1282: if (!$batch) {
1283: $scrout.=$intr_scrout.'<p><input type="submit" value="'.
1284: &mt('Finalize Publication').'" /></p></form>';
1285: }
1286: return($scrout,0);
1287: }
1288:
1289: #########################################
1290: #########################################
1291:
1292: =pod
1293:
1294: =item B<phasetwo>
1295:
1296: Render second interface showing status of publication steps.
1297: This is publication step two.
1298:
1299: Parameters:
1300:
1301: =over 4
1302:
1303: =item I<$source>
1304:
1305: =item I<$target>
1306:
1307: =item I<$style>
1308:
1309: =item I<$distarget>
1310:
1311: =back
1312:
1313: Returns:
1314:
1315: =over 4
1316:
1317: =item Scalar string
1318:
1319: String contains status (errors and warnings) and information associated with
1320: the server's attempts at publication.
1321:
1322: =cut
1323:
1324: #'stupid emacs
1325: #########################################
1326: #########################################
1327: sub phasetwo {
1328:
1329: my ($r,$source,$target,$style,$distarget,$batch)=@_;
1330: $source=~s/\/+/\//g;
1331: $target=~s/\/+/\//g;
1332:
1333: if ($target=~/\_\_\_/) {
1334: $r->print(
1335: '<font color="red">'.&mt('Unsupported character combination').
1336: ' "<tt>___</tt>" '.&mt('in filename, FAIL').'</font>');
1337: return 0;
1338: }
1339: $distarget=~s/\/+/\//g;
1340: my $logfile;
1341: unless ($logfile=Apache::File->new('>>'.$source.'.log')) {
1342: $r->print(
1343: '<font color="red">'.
1344: &mt('No write permission to user directory, FAIL').'</font>');
1345: return 0;
1346: }
1347: print $logfile
1348: "\n================= Publish ".localtime()." Phase Two ================\n".$ENV{'user.name'}.'@'.$ENV{'user.domain'}."\n";
1349:
1350: %metadatafields=();
1351: %metadatakeys=();
1352:
1353: &metaeval(&Apache::lonnet::unescape($ENV{'form.allmeta'}));
1354:
1355: $metadatafields{'title'}=$ENV{'form.title'};
1356: $metadatafields{'author'}=$ENV{'form.author'};
1357: $metadatafields{'subject'}=$ENV{'form.subject'};
1358: $metadatafields{'notes'}=$ENV{'form.notes'};
1359: $metadatafields{'abstract'}=$ENV{'form.abstract'};
1360: $metadatafields{'mime'}=$ENV{'form.mime'};
1361: $metadatafields{'language'}=$ENV{'form.language'};
1362: $metadatafields{'creationdate'}=$ENV{'form.creationdate'};
1363: $metadatafields{'lastrevisiondate'}=$ENV{'form.lastrevisiondate'};
1364: $metadatafields{'owner'}=$ENV{'form.owner'};
1365: $metadatafields{'copyright'}=$ENV{'form.copyright'};
1366: $metadatafields{'standards'}=$ENV{'form.standards'};
1367: $metadatafields{'lowestgradelevel'}=$ENV{'form.lowestgradelevel'};
1368: $metadatafields{'highestgradelevel'}=$ENV{'form.highestgradelevel'};
1369: $metadatafields{'customdistributionfile'}=
1370: $ENV{'form.customdistributionfile'};
1371: $metadatafields{'sourceavail'}=$ENV{'form.sourceavail'};
1372: $metadatafields{'obsolete'}=$ENV{'form.obsolete'};
1373: $metadatafields{'obsoletereplacement'}=
1374: $ENV{'form.obsoletereplacement'};
1375: $metadatafields{'dependencies'}=$ENV{'form.dependencies'};
1376: $metadatafields{'modifyinguser'}=$ENV{'user.name'}.'@'.
1377: $ENV{'user.domain'};
1378: $metadatafields{'authorspace'}=$cuname.'@'.$cudom;
1379:
1380: my $allkeywords=$ENV{'form.addkey'};
1381: if (exists($ENV{'form.keywords'})) {
1382: if (ref($ENV{'form.keywords'})) {
1383: $allkeywords .= ','.join(',',@{$ENV{'form.keywords'}});
1384: } else {
1385: $allkeywords .= ','.$ENV{'form.keywords'};
1386: }
1387: }
1388: $allkeywords=~s/[\"\']//g;
1389: $allkeywords=~s/\s*[\;\,]\s*/\,/g;
1390: $allkeywords=~s/\s+/ /g;
1391: $allkeywords=~s/^[ \,]//;
1392: $allkeywords=~s/[ \,]$//;
1393: $metadatafields{'keywords'}=$allkeywords;
1394:
1395: # check if custom distribution file is specified
1396: if ($metadatafields{'copyright'} eq 'custom') {
1397: my $file=$metadatafields{'customdistributionfile'};
1398: unless ($file=~/\.rights$/) {
1399: return
1400: '<font color="red">'.&mt('No valid custom distribution rights file specified, FAIL').
1401: '</font>';
1402: }
1403: }
1404: {
1405: print $logfile "\nWrite metadata file for ".$source;
1406: my $mfh;
1407: unless ($mfh=Apache::File->new('>'.$source.'.meta')) {
1408: return
1409: '<font color="red">'.&mt('Could not write metadata, FAIL').
1410: '</font>';
1411: }
1412: foreach (sort keys %metadatafields) {
1413: unless ($_=~/\./) {
1414: my $unikey=$_;
1415: $unikey=~/^([A-Za-z]+)/;
1416: my $tag=$1;
1417: $tag=~tr/A-Z/a-z/;
1418: print $mfh "\n\<$tag";
1419: foreach (split(/\,/,$metadatakeys{$unikey})) {
1420: my $value=$metadatafields{$unikey.'.'.$_};
1421: $value=~s/\"/\'\'/g;
1422: print $mfh ' '.$_.'="'.$value.'"';
1423: }
1424: print $mfh '>'.
1425: &HTML::Entities::encode($metadatafields{$unikey},'<>&"')
1426: .'</'.$tag.'>';
1427: }
1428: }
1429: $r->print('<p>'.&mt('Wrote Metadata').'</p>');
1430: print $logfile "\nWrote metadata";
1431: }
1432:
1433: # -------------------------------- Synchronize entry with SQL metadata database
1434:
1435: $metadatafields{'url'} = $distarget;
1436: $metadatafields{'version'} = 'current';
1437:
1438: my ($error,$success) = &store_metadata(%metadatafields);
1439: if ($success) {
1440: $r->print('<p>'.&mt('Synchronized SQL metadata database').'</p>');
1441: print $logfile "\nSynchronized SQL metadata database";
1442: } else {
1443: $r->print($error);
1444: print $logfile "\n".$error;
1445: }
1446: # --------------------------------------------- Delete author resource messages
1447: my $delresult=&Apache::lonmsg::del_url_author_res_msg($target);
1448: $r->print('<p>'.&mt('Removing error messages:').' '.$delresult.'</p>');
1449: print $logfile "\nRemoving error messages: $delresult";
1450: # ----------------------------------------------------------- Copy old versions
1451:
1452: if (-e $target) {
1453: my $filename;
1454: my $maxversion=0;
1455: $target=~/(.*)\/([^\/]+)\.(\w+)$/;
1456: my $srcf=$2;
1457: my $srct=$3;
1458: my $srcd=$1;
1459: unless ($srcd=~/^\/home\/httpd\/html\/res/) {
1460: print $logfile "\nPANIC: Target dir is ".$srcd;
1461: return "<font color=\"red\">Invalid target directory, FAIL</font>";
1462: }
1463: opendir(DIR,$srcd);
1464: while ($filename=readdir(DIR)) {
1465: if (-l $srcd.'/'.$filename) {
1466: unlink($srcd.'/'.$filename);
1467: unlink($srcd.'/'.$filename.'.meta');
1468: } else {
1469: if ($filename=~/\Q$srcf\E\.(\d+)\.\Q$srct\E$/) {
1470: $maxversion=($1>$maxversion)?$1:$maxversion;
1471: }
1472: }
1473: }
1474: closedir(DIR);
1475: $maxversion++;
1476: $r->print('<p>Creating old version '.$maxversion.'</p>');
1477: print $logfile "\nCreating old version ".$maxversion."\n";
1478:
1479: my $copyfile=$srcd.'/'.$srcf.'.'.$maxversion.'.'.$srct;
1480:
1481: if (copy($target,$copyfile)) {
1482: print $logfile "Copied old target to ".$copyfile."\n";
1483: $r->print('<p>'.&mt('Copied old target file').'</p>');
1484: } else {
1485: print $logfile "Unable to write ".$copyfile.':'.$!."\n";
1486: return "<font color=\"red\">".&mt('Failed to copy old target').
1487: ", $!, ".&mt('FAIL')."</font>";
1488: }
1489:
1490: # --------------------------------------------------------------- Copy Metadata
1491:
1492: $copyfile=$copyfile.'.meta';
1493:
1494: if (copy($target.'.meta',$copyfile)) {
1495: print $logfile "Copied old target metadata to ".$copyfile."\n";
1496: $r->print('<p>'.&mt('Copied old metadata').'</p>')
1497: } else {
1498: print $logfile "Unable to write metadata ".$copyfile.':'.$!."\n";
1499: if (-e $target.'.meta') {
1500: return
1501: "<font color=\"red\">".
1502: &mt('Failed to write old metadata copy').", $!, ".&mt('FAIL')."</font>";
1503: }
1504: }
1505:
1506:
1507: } else {
1508: $r->print('<p>'.&mt('Initial version').'</p>');
1509: print $logfile "\nInitial version";
1510: }
1511:
1512: # ---------------------------------------------------------------- Write Source
1513: my $copyfile=$target;
1514:
1515: my @parts=split(/\//,$copyfile);
1516: my $path="/$parts[1]/$parts[2]/$parts[3]/$parts[4]";
1517:
1518: my $count;
1519: for ($count=5;$count<$#parts;$count++) {
1520: $path.="/$parts[$count]";
1521: if ((-e $path)!=1) {
1522: print $logfile "\nCreating directory ".$path;
1523: $r->print('<p>'.&mt('Created directory').' '.$parts[$count].'</p>');
1524: mkdir($path,0777);
1525: }
1526: }
1527:
1528: if (copy($source,$copyfile)) {
1529: print $logfile "\nCopied original source to ".$copyfile."\n";
1530: $r->print('<p>'.&mt('Copied source file').'</p>');
1531: } else {
1532: print $logfile "\nUnable to write ".$copyfile.':'.$!."\n";
1533: return "<font color=\"red\">".
1534: &mt('Failed to copy source').", $!, ".&mt('FAIL')."</font>";
1535: }
1536:
1537: # --------------------------------------------------------------- Copy Metadata
1538:
1539: $copyfile=$copyfile.'.meta';
1540:
1541: if (copy($source.'.meta',$copyfile)) {
1542: print $logfile "\nCopied original metadata to ".$copyfile."\n";
1543: $r->print('<p>'.&mt('Copied metadata').'</p>');
1544: } else {
1545: print $logfile "\nUnable to write metadata ".$copyfile.':'.$!."\n";
1546: return
1547: "<font color=\"red\">".&mt('Failed to write metadata copy').", $!, ".&mt('FAIL')."</font>";
1548: }
1549: $r->rflush;
1550: # --------------------------------------------------- Send update notifications
1551:
1552: my @subscribed=&get_subscribed_hosts($target);
1553: foreach my $subhost (@subscribed) {
1554: $r->print('<p>'.&mt('Notifying host').' '.$subhost.':');$r->rflush;
1555: print $logfile "\nNotifying host ".$subhost.':';
1556: my $reply=&Apache::lonnet::critical('update:'.$target,$subhost);
1557: $r->print($reply.'</p><br />');$r->rflush;
1558: print $logfile $reply;
1559: }
1560:
1561: # ---------------------------------------- Send update notifications, meta only
1562:
1563: my @subscribedmeta=&get_subscribed_hosts("$target.meta");
1564: foreach my $subhost (@subscribedmeta) {
1565: $r->print('<p>'.
1566: &mt('Notifying host for metadata only').' '.$subhost.':');$r->rflush;
1567: print $logfile "\nNotifying host for metadata only ".$subhost.':';
1568: my $reply=&Apache::lonnet::critical('update:'.$target.'.meta',
1569: $subhost);
1570: $r->print($reply.'</p><br />');$r->rflush;
1571: print $logfile $reply;
1572: }
1573:
1574: # --------------------------------------------------- Notify subscribed courses
1575: my %courses=&coursedependencies($target);
1576: my $now=time;
1577: foreach (keys %courses) {
1578: $r->print('<p>'.&mt('Notifying course').' '.$_.':');$r->rflush;
1579: print $logfile "\nNotifying host ".$_.':';
1580: my ($cdom,$cname)=split(/\_/,$_);
1581: my $reply=&Apache::lonnet::cput
1582: ('versionupdate',{$target => $now},$cdom,$cname);
1583: $r->print($reply.'</p><br />');$r->rflush;
1584: print $logfile $reply;
1585: }
1586: # ------------------------------------------------ Provide link to new resource
1587: unless ($batch) {
1588: my $thisdistarget=$target;
1589: $thisdistarget=~s/^\Q$docroot\E//;
1590:
1591: my $thissrc=$source;
1592: $thissrc=~s/^\/home\/(\w+)\/public_html/\/priv\/$1/;
1593:
1594: my $thissrcdir=$thissrc;
1595: $thissrcdir=~s/\/[^\/]+$/\//;
1596:
1597:
1598: $r->print(
1599: '<hr /><a href="'.$thisdistarget.'"><font size="+2">'.
1600: &mt('View Published Version').'</font></a>'.
1601: '<p><a href="'.$thissrc.'"><font size=+2>'.
1602: &mt('Back to Source').'</font></a></p>'.
1603: '<p><a href="'.$thissrcdir.
1604: '"><font size="+2">'.
1605: &mt('Back to Source Directory').'</font></a></p>');
1606: }
1607: return '<p><font color="green">'.&mt('Done').'</font></p>';
1608: }
1609:
1610: #########################################
1611:
1612: sub batchpublish {
1613: my ($r,$srcfile,$targetfile)=@_;
1614: #publication pollutes %ENV with form.* values
1615: my %oldENV=%ENV;
1616: $srcfile=~s/\/+/\//g;
1617: $targetfile=~s/\/+/\//g;
1618: my $thisdisfn=$srcfile;
1619: $thisdisfn=~s/\/home\/korte\/public_html\///;
1620: $srcfile=~s/\/+/\//g;
1621:
1622: my $docroot=$r->dir_config('lonDocRoot');
1623: my $thisdistarget=$targetfile;
1624: $thisdistarget=~s/^\Q$docroot\E//;
1625:
1626:
1627: %metadatafields=();
1628: %metadatakeys=();
1629: $srcfile=~/\.(\w+)$/;
1630: my $thistype=$1;
1631:
1632:
1633: my $thisembstyle=&Apache::loncommon::fileembstyle($thistype);
1634:
1635: $r->print('<h2>'.&mt('Publishing').' <tt>'.$thisdisfn.'</tt></h2>');
1636:
1637: # phase one takes
1638: # my ($source,$target,$style,$batch)=@_;
1639: my ($outstring,$error)=&publish($srcfile,$targetfile,$thisembstyle,1);
1640: $r->print('<p>'.$outstring.'</p>');
1641: # phase two takes
1642: # my ($source,$target,$style,$distarget,batch)=@_;
1643: # $ENV{'form.allmeta'},$ENV{'form.title'},$ENV{'form.author'},...
1644: if (!$error) {
1645: $r->print('<p>');
1646: &phasetwo($r,$srcfile,$targetfile,$thisembstyle,$thisdistarget,1);
1647: $r->print('</p>');
1648: }
1649: %ENV=%oldENV;
1650: return '';
1651: }
1652:
1653: #########################################
1654:
1655: sub publishdirectory {
1656: my ($r,$fn,$thisdisfn)=@_;
1657: $fn=~s/\/+/\//g;
1658: $thisdisfn=~s/\/+/\//g;
1659: my $resdir=
1660: $Apache::lonnet::perlvar{'lonDocRoot'}.'/res/'.$cudom.'/'.$cuname.'/'.
1661: $thisdisfn;
1662: $r->print('<h1>'.&mt('Directory').' <tt>'.$thisdisfn.'</tt></h1>'.
1663: &mt('Target').': <tt>'.$resdir.'</tt><br />');
1664:
1665: my $dirptr=16384; # Mask indicating a directory in stat.cmode.
1666:
1667: opendir(DIR,$fn);
1668: my @files=sort(readdir(DIR));
1669: foreach my $filename (@files) {
1670: my ($cdev,$cino,$cmode,$cnlink,
1671: $cuid,$cgid,$crdev,$csize,
1672: $catime,$cmtime,$cctime,
1673: $cblksize,$cblocks)=stat($fn.'/'.$filename);
1674:
1675: my $extension='';
1676: if ($filename=~/\.(\w+)$/) { $extension=$1; }
1677: if ($cmode&$dirptr) {
1678: if (($filename!~/^\./) && ($ENV{'form.pubrec'})) {
1679: &publishdirectory($r,$fn.'/'.$filename,$thisdisfn.'/'.$filename);
1680: }
1681: } elsif ((&Apache::loncommon::fileembstyle($extension) ne 'hdn') &&
1682: ($filename!~/^[\#\.]/) && ($filename!~/\~$/)) {
1683: # find out publication status and/or exiting metadata
1684: my $publishthis=0;
1685: if (-e $resdir.'/'.$filename) {
1686: my ($rdev,$rino,$rmode,$rnlink,
1687: $ruid,$rgid,$rrdev,$rsize,
1688: $ratime,$rmtime,$rctime,
1689: $rblksize,$rblocks)=stat($resdir.'/'.$filename);
1690: if (($rmtime<$cmtime) || ($ENV{'form.forcerepub'})) {
1691: # previously published, modified now
1692: $publishthis=1;
1693: }
1694: } else {
1695: # never published
1696: $publishthis=1;
1697: }
1698: if ($publishthis) {
1699: &batchpublish($r,$fn.'/'.$filename,$resdir.'/'.$filename);
1700: } else {
1701: $r->print('<br />'.&mt('Skipping').' '.$filename.'<br />');
1702: }
1703: $r->rflush();
1704: }
1705: }
1706: closedir(DIR);
1707: }
1708:
1709: #########################################
1710: # publish a default.meta file
1711:
1712: sub defaultmetapublish {
1713: my ($r,$fn,$cuname,$cudom)=@_;
1714: $fn=~s/^\/\~$cuname\//\/home\/$cuname\/public_html\//;
1715: unless (-e $fn) {
1716: return HTTP_NOT_FOUND;
1717: }
1718: my $target=$fn;
1719: $target=~s/^\/home\/$cuname\/public_html\//$Apache::lonnet::perlvar{'lonDocRoot'}\/res\/$cudom\/$cuname\//;
1720:
1721:
1722: &Apache::loncommon::content_type($r,'text/html');
1723: $r->send_http_header;
1724:
1725: $r->print('<html><head><title>LON-CAPA Publishing</title></head>');
1726: $r->print(&Apache::loncommon::bodytag('Catalog Information Publication'));
1727:
1728: # ---------------------------------------------------------------- Write Source
1729: my $copyfile=$target;
1730:
1731: my @parts=split(/\//,$copyfile);
1732: my $path="/$parts[1]/$parts[2]/$parts[3]/$parts[4]";
1733:
1734: my $count;
1735: for ($count=5;$count<$#parts;$count++) {
1736: $path.="/$parts[$count]";
1737: if ((-e $path)!=1) {
1738: $r->print('<p>'.&mt('Created directory').' '.$parts[$count].'</p>');
1739: mkdir($path,0777);
1740: }
1741: }
1742:
1743: if (copy($fn,$copyfile)) {
1744: $r->print('<p>'.&mt('Copied source file').'</p>');
1745: } else {
1746: return "<font color=\"red\">".
1747: &mt('Failed to copy source').", $!, ".&mt('FAIL')."</font>";
1748: }
1749:
1750: # --------------------------------------------------- Send update notifications
1751:
1752: my @subscribed=&get_subscribed_hosts($target);
1753: foreach my $subhost (@subscribed) {
1754: $r->print('<p>'.&mt('Notifying host').' '.$subhost.':');$r->rflush;
1755: my $reply=&Apache::lonnet::critical('update:'.$target,$subhost);
1756: $r->print($reply.'</p><br />');$r->rflush;
1757: }
1758: # ------------------------------------------------------------------- Link back
1759: my $link=$fn;
1760: $link=~s/^\/home\/$cuname\/public_html\//\/priv\/$cuname\//;
1761: $r->print("<a href='$link'>".&mt('Back to Catalog Information').'</a>');
1762: $r->print('</body></html>');
1763: return OK;
1764: }
1765: #########################################
1766:
1767: =pod
1768:
1769: =item B<handler>
1770:
1771: A basic outline of the handler subroutine follows.
1772:
1773: =over 4
1774:
1775: =item *
1776:
1777: Get query string for limited number of parameters.
1778:
1779: =item *
1780:
1781: Check filename.
1782:
1783: =item *
1784:
1785: File is there and owned, init lookup tables.
1786:
1787: =item *
1788:
1789: Start page output.
1790:
1791: =item *
1792:
1793: Evaluate individual file, and then output information.
1794:
1795: =item *
1796:
1797: Publishing from $thisfn to $thistarget with $thisembstyle.
1798:
1799: =back
1800:
1801: =cut
1802:
1803: #########################################
1804: #########################################
1805: sub handler {
1806: my $r=shift;
1807:
1808: if ($r->header_only) {
1809: &Apache::loncommon::content_type($r,'text/html');
1810: $r->send_http_header;
1811: return OK;
1812: }
1813:
1814: # Get query string for limited number of parameters
1815:
1816: &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},
1817: ['filename']);
1818:
1819: # -------------------------------------------------------------- Check filename
1820:
1821: my $fn=&Apache::lonnet::unescape($ENV{'form.filename'});
1822:
1823: ($cuname,$cudom)=
1824: &Apache::loncacc::constructaccess($fn,$r->dir_config('lonDefDomain'));
1825:
1826: # special publication: default.meta file
1827: if ($fn=~/\/default.meta$/) {
1828: return &defaultmetapublish($r,$fn,$cuname,$cudom);
1829: }
1830: $fn=~s/\.meta$//;
1831:
1832: unless ($fn) {
1833: $r->log_reason($cuname.' at '.$cudom.
1834: ' trying to publish empty filename', $r->filename);
1835: return HTTP_NOT_FOUND;
1836: }
1837:
1838: unless (($cuname) && ($cudom)) {
1839: $r->log_reason($cuname.' at '.$cudom.
1840: ' trying to publish file '.$ENV{'form.filename'}.
1841: ' ('.$fn.') - not authorized',
1842: $r->filename);
1843: return HTTP_NOT_ACCEPTABLE;
1844: }
1845:
1846: my $home=&Apache::lonnet::homeserver($cuname,$cudom);
1847: my $allowed=0;
1848: my @ids=&Apache::lonnet::current_machine_ids();
1849: foreach my $id (@ids) { if ($id eq $home) { $allowed = 1; } }
1850: unless ($allowed) {
1851: $r->log_reason($cuname.' at '.$cudom.
1852: ' trying to publish file '.$ENV{'form.filename'}.
1853: ' ('.$fn.') - not homeserver ('.$home.')',
1854: $r->filename);
1855: return HTTP_NOT_ACCEPTABLE;
1856: }
1857:
1858: $fn=~s/^http\:\/\/[^\/]+//;
1859: $fn=~s/^\/\~(\w+)/\/home\/$1\/public_html/;
1860:
1861: my $targetdir='';
1862: $docroot=$r->dir_config('lonDocRoot');
1863: if ($1 ne $cuname) {
1864: $r->log_reason($cuname.' at '.$cudom.
1865: ' trying to publish unowned file '.
1866: $ENV{'form.filename'}.' ('.$fn.')',
1867: $r->filename);
1868: return HTTP_NOT_ACCEPTABLE;
1869: } else {
1870: $targetdir=$docroot.'/res/'.$cudom;
1871: }
1872:
1873:
1874: unless (-e $fn) {
1875: $r->log_reason($cuname.' at '.$cudom.
1876: ' trying to publish non-existing file '.
1877: $ENV{'form.filename'}.' ('.$fn.')',
1878: $r->filename);
1879: return HTTP_NOT_FOUND;
1880: }
1881:
1882: unless ($ENV{'form.phase'} eq 'two') {
1883:
1884: # -------------------------------- File is there and owned, init lookup tables.
1885:
1886: %addid=();
1887:
1888: {
1889: my $fh=Apache::File->new($r->dir_config('lonTabDir').'/addid.tab');
1890: while (<$fh>=~/(\w+)\s+(\w+)/) {
1891: $addid{$1}=$2;
1892: }
1893: }
1894:
1895: %nokey=();
1896:
1897: {
1898: my $fh=Apache::File->new($r->dir_config('lonIncludes').'/un_keyword.tab');
1899: while (<$fh>) {
1900: my $word=$_;
1901: chomp($word);
1902: $nokey{$word}=1;
1903: }
1904: }
1905:
1906: }
1907:
1908: # ---------------------------------------------------------- Start page output.
1909:
1910: &Apache::loncommon::content_type($r,'text/html');
1911: $r->send_http_header;
1912:
1913: $r->print('<html><head><title>LON-CAPA Publishing</title></head>');
1914: $r->print(&Apache::loncommon::bodytag('Resource Publication'));
1915:
1916:
1917: my $thisfn=$fn;
1918:
1919: my $thistarget=$thisfn;
1920:
1921: $thistarget=~s/^\/home/$targetdir/;
1922: $thistarget=~s/\/public\_html//;
1923:
1924: my $thisdistarget=$thistarget;
1925: $thisdistarget=~s/^\Q$docroot\E//;
1926:
1927: my $thisdisfn=$thisfn;
1928: $thisdisfn=~s/^\/home\/\Q$cuname\E\/public_html\///;
1929:
1930: if ($fn=~/\/$/) {
1931: # -------------------------------------------------------- This is a directory
1932: &publishdirectory($r,$fn,$thisdisfn);
1933: $r->print('<hr><font size="+2">'.&mt('Done').'</font><br><a href="/priv/'
1934: .$cuname.'/'.$thisdisfn
1935: .'">'.&mt('Return to Directory').'</a>');
1936:
1937:
1938: } else {
1939: # ---------------------- Evaluate individual file, and then output information.
1940: $thisfn=~/\.(\w+)$/;
1941: my $thistype=$1;
1942: my $thisembstyle=&Apache::loncommon::fileembstyle($thistype);
1943: $r->print('<h2>'.&mt('Publishing').' '.
1944: &Apache::loncommon::filedescription($thistype).' <tt>');
1945:
1946: $r->print(<<ENDCAPTION);
1947: <a href='javascript:void(window.open("/~$cuname/$thisdisfn","cat","height=300,width=500,scrollbars=1,resizable=1,menubar=0,location=1"))'>
1948: $thisdisfn</a>
1949: ENDCAPTION
1950: $r->print('</tt></h2><b>'.&mt('Target').':</b> <tt>'.
1951: $thisdistarget.'</tt><br />');
1952:
1953: if (($cuname ne $ENV{'user.name'})||($cudom ne $ENV{'user.domain'})) {
1954: $r->print('<h3><font color="red">'.&mt('Co-Author').': '.
1955: $cuname.&mt(' at ').$cudom.'</font></h3>');
1956: }
1957:
1958: if (&Apache::loncommon::fileembstyle($thistype) eq 'ssi') {
1959: $r->print(<<ENDDIFF);
1960: <br />
1961: <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"))'>
1962: ENDDIFF
1963: $r->print(&mt('Diffs with Current Version').'</a><br />');
1964: }
1965:
1966: # ------------------ Publishing from $thisfn to $thistarget with $thisembstyle.
1967:
1968: unless ($ENV{'form.phase'} eq 'two') {
1969: my ($outstring,$error)=&publish($thisfn,$thistarget,$thisembstyle);
1970: $r->print('<hr />'.$outstring);
1971: } else {
1972: $r->print('<hr />'.
1973: &phasetwo($r,$thisfn,$thistarget,$thisembstyle,$thisdistarget));
1974: }
1975: }
1976: $r->print('</body></html>');
1977:
1978: return OK;
1979: }
1980:
1981: 1;
1982: __END__
1983:
1984: =pod
1985:
1986: =back
1987:
1988: =back
1989:
1990: =cut
1991:
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