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