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