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