1: # The LearningOnline Network with CAPA
2: # Publication Handler
3: #
4: # $Id: lonpublisher.pm,v 1.150 2003/12/26 16:27:20 www 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 vars qw(%metadatafields %metadatakeys);
130:
131: my %addid;
132: my %nokey;
133:
134: my $docroot;
135:
136: my $cuname;
137: my $cudom;
138:
139: =pod
140:
141: =item B<metaeval>
142:
143: Evaluates a string that contains metadata. This subroutine
144: stores values inside I<%metadatafields> and I<%metadatakeys>.
145: The hash key is a I<$unikey> corresponding to a unique id
146: that is descriptive of the parser location inside the XML tree.
147:
148: Parameters:
149:
150: =over 4
151:
152: =item I<$metastring>
153:
154: A string that contains metadata.
155:
156: =back
157:
158: Returns:
159:
160: nothing
161:
162: =cut
163:
164: #########################################
165: #########################################
166: #
167: # Modifies global %metadatafields %metadatakeys
168: #
169:
170: sub metaeval {
171: my ($metastring,$prefix)=@_;
172:
173: my $parser=HTML::LCParser->new(\$metastring);
174: my $token;
175: while ($token=$parser->get_token) {
176: if ($token->[0] eq 'S') {
177: my $entry=$token->[1];
178: my $unikey=$entry;
179: if (defined($token->[2]->{'package'})) {
180: $unikey.='_package_'.$token->[2]->{'package'};
181: }
182: if (defined($token->[2]->{'part'})) {
183: $unikey.='_'.$token->[2]->{'part'};
184: }
185: if (defined($token->[2]->{'id'})) {
186: $unikey.='_'.$token->[2]->{'id'};
187: }
188: if (defined($token->[2]->{'name'})) {
189: $unikey.='_'.$token->[2]->{'name'};
190: }
191: foreach (@{$token->[3]}) {
192: $metadatafields{$unikey.'.'.$_}=$token->[2]->{$_};
193: if ($metadatakeys{$unikey}) {
194: $metadatakeys{$unikey}.=','.$_;
195: } else {
196: $metadatakeys{$unikey}=$_;
197: }
198: }
199: my $newentry=$parser->get_text('/'.$entry);
200: if ($entry eq 'customdistributionfile') {
201: $newentry=~s/^\s*//;
202: if ($newentry !~m|^/res|) { $newentry=$prefix.$newentry; }
203: }
204: # actually store
205: $metadatafields{$unikey}=$newentry;
206: }
207: }
208: }
209:
210: #########################################
211: #########################################
212:
213: =pod
214:
215: =item B<metaread>
216:
217: Read a metadata file
218:
219: Parameters:
220:
221: =over
222:
223: =item I<$logfile>
224:
225: File output stream to output errors and warnings to.
226:
227: =item I<$fn>
228:
229: File name (including path).
230:
231: =back
232:
233: Returns:
234:
235: =over 4
236:
237: =item Scalar string (if successful)
238:
239: XHTML text that indicates successful reading of the metadata.
240:
241: =back
242:
243: =cut
244:
245: #########################################
246: #########################################
247: sub metaread {
248: my ($logfile,$fn,$prefix)=@_;
249: unless (-e $fn) {
250: print($logfile 'No file '.$fn."\n");
251: return '<br /><b>'.&mt('No file').':</b> <tt>'.
252: &Apache::loncfile::display($fn).'</tt>';
253: }
254: print($logfile 'Processing '.$fn."\n");
255: my $metastring;
256: {
257: my $metafh=Apache::File->new($fn);
258: $metastring=join('',<$metafh>);
259: }
260: &metaeval($metastring,$prefix);
261: return '<br /><b>'.&mt('Processed file').':</b> <tt>'.
262: &Apache::loncfile::display($fn).'</tt>';
263: }
264:
265: #########################################
266: #########################################
267:
268: sub coursedependencies {
269: my $url=&Apache::lonnet::declutter(shift);
270: $url=~s/\.meta$//;
271: my ($adomain,$aauthor)=($url=~/^(\w+)\/(\w+)\//);
272: my $regexp=$url;
273: $regexp=~s/(\W)/\\$1/g;
274: $regexp='___'.$regexp.'___course';
275: my %evaldata=&Apache::lonnet::dump('nohist_resevaldata',$adomain,
276: $aauthor,$regexp);
277: my %courses=();
278: foreach (keys %evaldata) {
279: if ($_=~/^([a-zA-Z0-9]+_[a-zA-Z0-9]+)___.+___course$/) {
280: $courses{$1}=1;
281: }
282: }
283: return %courses;
284: }
285: #########################################
286: #########################################
287:
288:
289: =pod
290:
291: =item Form-field-generating subroutines.
292:
293: For input parameters, these subroutines take in values
294: such as I<$name>, I<$value> and other form field metadata.
295: The output (scalar string that is returned) is an XHTML
296: string which presents the form field (foreseeably inside
297: <form></form> tags).
298:
299: =over 4
300:
301: =item B<textfield>
302:
303: =item B<hiddenfield>
304:
305: =item B<selectbox>
306:
307: =back
308:
309: =cut
310:
311: #########################################
312: #########################################
313: sub textfield {
314: my ($title,$name,$value)=@_;
315: $value=~s/^\s+//gs;
316: $value=~s/\s+$//gs;
317: $value=~s/\s+/ /gs;
318: $title=&mt($title);
319: my $uctitle=uc($title);
320: return "\n<p><font color=\"#800000\" face=\"helvetica\"><b>$uctitle:".
321: "</b></font></p><br />".
322: '<input type="text" name="'.$name.'" size=80 value="'.$value.'" />';
323: }
324:
325: sub hiddenfield {
326: my ($name,$value)=@_;
327: return "\n".'<input type="hidden" name="'.$name.'" value="'.$value.'" />';
328: }
329:
330: sub selectbox {
331: my ($title,$name,$value,$functionref,@idlist)=@_;
332: $title=&mt($title);
333: my $uctitle=uc($title);
334: $value=(split(/\s*,\s*/,$value))[-1];
335: my $selout="\n<p><font color=\"#800000\" face=\"helvetica\"><b>$uctitle:".
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 = %{shift()};
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: # Remove old value from table
788: $status = &Apache::lonmysql::remove_from_table
789: ('metadata','url',$metadata{'url'});
790: if (! defined($status)) {
791: $error = '<font color="red">Error when removing old values from '.
792: 'metadata table in LON-CAPA database.</font>';
793: &Apache::lonnet::logthis($error);
794: return ($error,undef);
795: }
796: # Store data in table.
797: $status = &Apache::lonmysql::store_row('metadata',\%metadata);
798: if (! defined($status)) {
799: $error='<font color="red">Error occured storing new values in '.
800: 'metadata table in LON-CAPA database</font>';
801: &Apache::lonnet::logthis($error);
802: return ($error,undef);
803: }
804: return (undef,$status);
805: }
806:
807:
808: # ============================================== Parse file itself for metadata
809: #
810: # parses a file with target meta, sets global %metadatafields %metadatakeys
811:
812: sub parseformeta {
813: my ($source,$style)=@_;
814: my $allmeta='';
815: if (($style eq 'ssi') || ($style eq 'prv')) {
816: my $dir=$source;
817: $dir=~s-/[^/]*$--;
818: my $file=$source;
819: $file=(split('/',$file))[-1];
820: $source=&Apache::lonnet::hreflocation($dir,$file);
821: $allmeta=&Apache::lonnet::ssi_body($source,('grade_target' => 'meta'));
822: &metaeval($allmeta);
823: }
824: return $allmeta;
825: }
826:
827: #########################################
828: #########################################
829:
830: =pod
831:
832: =item B<publish>
833:
834: This is the workhorse function of this module. This subroutine generates
835: backup copies, performs any automatic processing (prior to publication,
836: especially for rat and ssi files),
837:
838: Returns a 2 element array, the first is the string to be shown to the
839: user, the second is an error code, either 1 (an error occured) or 0
840: (no error occurred)
841:
842: I<Additional documentation needed.>
843:
844: =cut
845:
846: #########################################
847: #########################################
848: sub publish {
849:
850: my ($source,$target,$style,$batch)=@_;
851: my $logfile;
852: my $scrout='';
853: my $allmeta='';
854: my $content='';
855: my %allow=();
856:
857: unless ($logfile=Apache::File->new('>>'.$source.'.log')) {
858: return ('<font color="red">'.&mt('No write permission to user directory, FAIL').'</font>',1);
859: }
860: print $logfile
861: "\n\n================= Publish ".localtime()." Phase One ================\n".$ENV{'user.name'}.'@'.$ENV{'user.domain'}."\n";
862:
863: if (($style eq 'ssi') || ($style eq 'rat') || ($style eq 'prv')) {
864: # ------------------------------------------------------- This needs processing
865:
866: # ----------------------------------------------------------------- Backup Copy
867: my $copyfile=$source.'.save';
868: if (copy($source,$copyfile)) {
869: print $logfile "Copied original file to ".$copyfile."\n";
870: } else {
871: print $logfile "Unable to write backup ".$copyfile.':'.$!."\n";
872: return ("<font color=\"red\">Failed to write backup copy, $!,FAIL</font>",1);
873: }
874: # ------------------------------------------------------------- IDs and indices
875:
876: my ($outstring,$error);
877: ($outstring,$error,%allow)=&fix_ids_and_indices($logfile,$source,
878: $target);
879: if ($error) { return ($outstring,$error); }
880: # ------------------------------------------------------------ Construct Allows
881:
882: $scrout.='<h3>'.&mt('Dependencies').'</h3>';
883: my $allowstr='';
884: foreach (sort(keys(%allow))) {
885: my $thisdep=$_;
886: if ($thisdep !~ /[^\s]/) { next; }
887: unless ($style eq 'rat') {
888: $allowstr.="\n".'<allow src="'.$thisdep.'" />';
889: }
890: $scrout.='<br />';
891: unless ($thisdep=~/\*/) {
892: $scrout.='<a href="'.$thisdep.'">';
893: }
894: $scrout.='<tt>'.$thisdep.'</tt>';
895: unless ($thisdep=~/\*/) {
896: $scrout.='</a>';
897: if (
898: &Apache::lonnet::getfile($Apache::lonnet::perlvar{'lonDocRoot'}.'/'.
899: $thisdep.'.meta') eq '-1') {
900: $scrout.= ' - <font color="red">'.&mt('Currently not available').
901: '</font>';
902: } else {
903: my %temphash=(&Apache::lonnet::declutter($target).'___'.
904: &Apache::lonnet::declutter($thisdep).'___usage'
905: => time);
906: $thisdep=~/^\/res\/(\w+)\/(\w+)\//;
907: if ((defined($1)) && (defined($2))) {
908: &Apache::lonnet::put('nohist_resevaldata',\%temphash,
909: $1,$2);
910: }
911: }
912: }
913: }
914: $outstring=~s/\n*(\<\/[^\>]+\>)\s*$/$allowstr\n$1\n/s;
915:
916: ### FIXME: is this really what we want?
917: # I dont' think so, to will corrupt any UTF-8 resources at least,
918: # and any encoding other than ISO-8859-1 will probably break
919: #Encode any High ASCII characters
920: #$outstring=&HTML::Entities::encode($outstring,"\200-\377");
921: # ------------------------------------------------------------- Write modified.
922:
923: {
924: my $org;
925: unless ($org=Apache::File->new('>'.$source)) {
926: print $logfile "No write permit to $source\n";
927: return ('<font color="red">'.&mt('No write permission to').
928: ' '.$source.
929: ', '.&mt('FAIL').'</font>',1);
930: }
931: print($org $outstring);
932: }
933: $content=$outstring;
934:
935: }
936: # -------------------------------------------- Initial step done, now metadata.
937:
938: # --------------------------------------- Storage for metadata keys and fields.
939: # these are globals
940: #
941: %metadatafields=();
942: %metadatakeys=();
943:
944: my %oldparmstores=();
945:
946: unless ($batch) {
947: $scrout.='<h3>'.&mt('Metadata Information').' ' .
948: Apache::loncommon::help_open_topic("Metadata_Description")
949: . '</h3>';
950: }
951:
952: # ------------------------------------------------ First, check out environment
953: unless (-e $source.'.meta') {
954: $metadatafields{'author'}=$ENV{'environment.firstname'}.' '.
955: $ENV{'environment.middlename'}.' '.
956: $ENV{'environment.lastname'}.' '.
957: $ENV{'environment.generation'};
958: $metadatafields{'author'}=~s/\s+/ /g;
959: $metadatafields{'author'}=~s/\s+$//;
960: $metadatafields{'owner'}=$cuname.'@'.$cudom;
961: $metadatafields{'modifyinguser'}=$ENV{'user.name'}.'@'.
962: $ENV{'user.domain'};
963: $metadatafields{'authorspace'}=$cuname.'@'.$cudom;
964:
965: # ------------------------------------------------ Check out directory hierachy
966:
967: my $thisdisfn=$source;
968: $thisdisfn=~s/^\/home\/\Q$cuname\E\///;
969:
970: my @urlparts=split(/\//,$thisdisfn);
971: $#urlparts--;
972:
973: my $currentpath='/home/'.$cuname.'/';
974:
975: my $prefix='../'x($#urlparts);
976: foreach (@urlparts) {
977: $currentpath.=$_.'/';
978: $scrout.=&metaread($logfile,$currentpath.'default.meta',$prefix);
979: $prefix=~s|^\.\./||;
980: }
981: # ----------------------------------------------------------- Parse file itself
982: # read %metadatafields from file itself
983:
984: $allmeta=&parseformeta($source,$style);
985:
986: # ------------------- Clear out parameters and stores (there should not be any)
987:
988: foreach (keys %metadatafields) {
989: if (($_=~/^parameter/) || ($_=~/^stores/)) {
990: delete $metadatafields{$_};
991: }
992: }
993:
994: } else {
995: # ---------------------- Read previous metafile, remember parameters and stores
996:
997: $scrout.=&metaread($logfile,$source.'.meta');
998:
999: foreach (keys %metadatafields) {
1000: if (($_=~/^parameter/) || ($_=~/^stores/)) {
1001: $oldparmstores{$_}=1;
1002: delete $metadatafields{$_};
1003: }
1004: }
1005: # ------------------------------------------ See if anything new in file itself
1006:
1007: $allmeta=&parseformeta($source,$style);
1008: }
1009:
1010:
1011: # ---------------- Find and document discrepancies in the parameters and stores
1012:
1013: my $chparms='';
1014: foreach (sort keys %metadatafields) {
1015: if (($_=~/^parameter/) || ($_=~/^stores/)) {
1016: unless ($_=~/\.\w+$/) {
1017: unless ($oldparmstores{$_}) {
1018: print $logfile 'New: '.$_."\n";
1019: $chparms.=$_.' ';
1020: }
1021: }
1022: }
1023: }
1024: if ($chparms) {
1025: $scrout.='<p><b>'.&mt('New parameters or stored values').
1026: ':</b> '.$chparms.'</p>';
1027: }
1028:
1029: $chparms='';
1030: foreach (sort keys %oldparmstores) {
1031: if (($_=~/^parameter/) || ($_=~/^stores/)) {
1032: unless (($metadatafields{$_.'.name'}) ||
1033: ($metadatafields{$_.'.package'}) || ($_=~/\.\w+$/)) {
1034: print $logfile 'Obsolete: '.$_."\n";
1035: $chparms.=$_.' ';
1036: }
1037: }
1038: }
1039: if ($chparms) {
1040: $scrout.='<p><b>'.&mt('Obsolete parameters or stored values').':</b> '.
1041: $chparms.'</p><h1><font color="red">'.&mt('Warning!').
1042: '</font></h1><p><font color="red" size="+1">'.
1043: &mt('If this resource is in active use, student performance data from the previous version may become inaccessible.').'</font></p><hr />';
1044: }
1045:
1046: # ------------------------------------------------------- Now have all metadata
1047:
1048: my %keywords=();
1049:
1050: if (length($content)<500000) {
1051: my $textonly=$content;
1052: $textonly=~s/\<script[^\<]+\<\/script\>//g;
1053: $textonly=~s/\<m\>[^\<]+\<\/m\>//g;
1054: $textonly=~s/\<[^\>]*\>//g;
1055: $textonly=~tr/A-Z/a-z/;
1056: $textonly=~s/[\$\&][a-z]\w*//g;
1057: $textonly=~s/[^a-z\s]//g;
1058:
1059: foreach ($textonly=~m/(\w+)/g) {
1060: unless ($nokey{$_}) {
1061: $keywords{$_}=1;
1062: }
1063: }
1064: }
1065:
1066:
1067: foreach (split(/\W+/,$metadatafields{'keywords'})) {
1068: $keywords{$_}=1;
1069: }
1070: # --------------------------------------------------- Now we also have keywords
1071: # =============================================================================
1072: # INTERACTIVE MODE
1073: #
1074: unless ($batch) {
1075: $scrout.=
1076: '<form name="pubform" action="/adm/publish" method="post">'.
1077: '<p><input type="submit" value="'.&mt('Finalize Publication').'" /></p>'.
1078: &hiddenfield('phase','two').
1079: &hiddenfield('filename',$ENV{'form.filename'}).
1080: &hiddenfield('allmeta',&Apache::lonnet::escape($allmeta)).
1081: &hiddenfield('dependencies',join(',',keys %allow)).
1082: &textfield('Title','title',$metadatafields{'title'}).
1083: &textfield('Author(s)','author',$metadatafields{'author'}).
1084: &textfield('Subject','subject',$metadatafields{'subject'});
1085:
1086: # --------------------------------------------------- Scan content for keywords
1087:
1088: my $keywords_help = Apache::loncommon::help_open_topic("Publishing_Keywords");
1089: my $KEYWORDS=&mt('KEYWORDS');
1090: my $CheckAll=&mt('check all');
1091: my $UncheckAll=&mt('uncheck all');
1092: my $keywordout=<<"END";
1093: <script>
1094: function checkAll(field) {
1095: for (i = 0; i < field.length; i++)
1096: field[i].checked = true ;
1097: }
1098:
1099: function uncheckAll(field) {
1100: for (i = 0; i < field.length; i++)
1101: field[i].checked = false ;
1102: }
1103: </script>
1104: <p><font color="#800000" face="helvetica"><b>$KEYWORDS:</b></font>
1105: $keywords_help</b>
1106: <input type="button" value="$CheckAll" onclick="javascript:checkAll(document.pubform.keywords)" />
1107: <input type="button" value="$UncheckAll" onclick="javascript:uncheckAll(document.pubform.keywords)" />
1108: </p>
1109: <br />
1110: END
1111: $keywordout.='<table border="2"><tr>';
1112: my $colcount=0;
1113:
1114: foreach (sort keys %keywords) {
1115: $keywordout.='<td><input type="checkbox" name="keywords" value="'.$_.'"';
1116: if ($metadatafields{'keywords'}) {
1117: if ($metadatafields{'keywords'}=~/\Q$_\E/) {
1118: $keywordout.=' checked="on"';
1119: }
1120: } elsif (&Apache::loncommon::keyword($_)) {
1121: $keywordout.=' checked="on"';
1122: }
1123: $keywordout.=' />'.$_.'</td>';
1124: if ($colcount>10) {
1125: $keywordout.="</tr><tr>\n";
1126: $colcount=0;
1127: }
1128: $colcount++;
1129: }
1130:
1131: $keywordout.='</tr></table>';
1132:
1133: $scrout.=$keywordout;
1134:
1135: $scrout.=&textfield('Additional Keywords','addkey','');
1136:
1137: $scrout.=&textfield('Notes','notes',$metadatafields{'notes'});
1138:
1139: $scrout.=
1140: "\n<p><font color=\"#800000\" face=\"helvetica\"><b>".&mt('ABSTRACT').":".
1141: "</b></font></p><br />".
1142: '<textarea cols="80" rows="5" name="abstract">'.
1143: $metadatafields{'abstract'}.'</textarea></p>';
1144:
1145: $source=~/\.(\w+)$/;
1146:
1147:
1148: $scrout.=
1149: "\n<p><font color=\"#800000\" face=\"helvetica\"><b>".
1150: uc(&mt('Lowest Grade Level:')).
1151: "</b></font></p><br />".
1152: &Apache::loncommon::select_level_form($metadatafields{'lowestgradelevel'},'lowestgradelevel').
1153: "\n<p><font color=\"#800000\" face=\"helvetica\"><b>".
1154: uc(&mt('Highest Grade Level:')).
1155: "</b></font></p><br />".
1156: &Apache::loncommon::select_level_form($metadatafields{'highestgradelevel'},'highestgradelevel').
1157: &textfield('Standards','standards',$metadatafields{'standards'});
1158:
1159:
1160:
1161:
1162: $scrout.=&hiddenfield('mime',$1);
1163:
1164: my $defaultlanguage=$metadatafields{'language'};
1165: $defaultlanguage =~ s/\s*notset\s*//g;
1166: $defaultlanguage =~ s/^,\s*//g;
1167: $defaultlanguage =~ s/,\s*$//g;
1168:
1169: $scrout.=&selectbox('Language','language',
1170: $defaultlanguage,
1171: \&Apache::loncommon::languagedescription,
1172: (&Apache::loncommon::languageids),
1173: );
1174:
1175: unless ($metadatafields{'creationdate'}) {
1176: $metadatafields{'creationdate'}=time;
1177: }
1178: $scrout.=&hiddenfield('creationdate',
1179: &Apache::loncommon::unsqltime($metadatafields{'creationdate'}));
1180:
1181: $scrout.=&hiddenfield('lastrevisiondate',time);
1182:
1183:
1184: $scrout.=&textfield('Publisher/Owner','owner',
1185: $metadatafields{'owner'});
1186:
1187: # -------------------------------------------------- Correct copyright for rat.
1188: my $defaultoption=$metadatafields{'copyright'};
1189: unless ($defaultoption) { $defaultoption='default'; }
1190: unless ($style eq 'prv') {
1191: if ($style eq 'rat') {
1192: if ($metadatafields{'copyright'} eq 'public') {
1193: delete $metadatafields{'copyright'};
1194: $defaultoption='default';
1195: }
1196: $scrout.=&selectbox('Copyright/Distribution','copyright',
1197: $defaultoption,
1198: \&Apache::loncommon::copyrightdescription,
1199: (grep !/^public$/,(&Apache::loncommon::copyrightids)));
1200: } else {
1201: $scrout.=&selectbox('Copyright/Distribution','copyright',
1202: $defaultoption,
1203: \&Apache::loncommon::copyrightdescription,
1204: (&Apache::loncommon::copyrightids));
1205: }
1206:
1207: my $copyright_help =
1208: Apache::loncommon::help_open_topic('Publishing_Copyright');
1209: $scrout =~ s/DISTRIBUTION:/'DISTRIBUTION: ' . $copyright_help/ge;
1210: $scrout.=&textfield('Custom Distribution File','customdistributionfile',
1211: $metadatafields{'customdistributionfile'}).
1212: $copyright_help;
1213: my $uctitle=uc(&mt('Obsolete'));
1214: $scrout.=
1215: "\n<p><font color=\"#800000\" face=\"helvetica\"><b>$uctitle:".
1216: '</b></font> <input type="checkbox" name="obsolete" ';
1217: if ($metadatafields{'obsolete'}) {
1218: $scrout.=' checked="1" ';
1219: }
1220: $scrout.='/ ></p>'.
1221: &textfield('Suggested Replacement for Obsolete File',
1222: 'obsoletereplacement',
1223: $metadatafields{'obsoletereplacement'});
1224: } else {
1225: $scrout.=&hiddenfield('copyright','private');
1226: }
1227: return ($scrout.'<p><input type="submit" value="'.
1228: &mt('Finalize Publication').'" /></p></form>',0);
1229: # =============================================================================
1230: # BATCH MODE
1231: #
1232: } else {
1233: # Transfer metadata directly to environment for stage 2
1234: foreach (keys %metadatafields) {
1235: $ENV{'form.'.$_}=$metadatafields{$_};
1236: }
1237: $ENV{'form.addkey'}='';
1238: $ENV{'form.keywords'}='';
1239: foreach (keys %keywords) {
1240: if ($metadatafields{'keywords'}) {
1241: if ($metadatafields{'keywords'}=~/\Q$_\E/) {
1242: $ENV{'form.keywords'}.=$_.',';
1243: }
1244: } elsif (&Apache::loncommon::keyword($_)) {
1245: $ENV{'form.keywords'}.=$_.',';
1246: }
1247: }
1248: $ENV{'form.keywords'}=~s/\,$//;
1249: unless ($ENV{'form.creationdate'}) { $ENV{'form.creationdate'}=time; }
1250: $ENV{'form.lastrevisiondate'}=time;
1251: if ((($style eq 'rat') && ($ENV{'form.copyright'} eq 'public')) ||
1252: (!$ENV{'form.copyright'})) {
1253: $ENV{'form.copyright'}='default';
1254: }
1255: $ENV{'form.allmeta'}=&Apache::lonnet::escape($allmeta);
1256: return ($scrout,0);
1257: }
1258: }
1259:
1260: #########################################
1261: #########################################
1262:
1263: =pod
1264:
1265: =item B<phasetwo>
1266:
1267: Render second interface showing status of publication steps.
1268: This is publication step two.
1269:
1270: Parameters:
1271:
1272: =over 4
1273:
1274: =item I<$source>
1275:
1276: =item I<$target>
1277:
1278: =item I<$style>
1279:
1280: =item I<$distarget>
1281:
1282: =back
1283:
1284: Returns:
1285:
1286: =over 4
1287:
1288: =item Scalar string
1289:
1290: String contains status (errors and warnings) and information associated with
1291: the server's attempts at publication.
1292:
1293: =cut
1294:
1295: #'stupid emacs
1296: #########################################
1297: #########################################
1298: sub phasetwo {
1299:
1300: my ($r,$source,$target,$style,$distarget,$batch)=@_;
1301: $source=~s/\/+/\//g;
1302: $target=~s/\/+/\//g;
1303:
1304: if ($target=~/\_\_\_/) {
1305: $r->print(
1306: '<font color="red">'.&mt('Unsupported character combination').
1307: ' "<tt>___</tt>" '.&mt('in filename, FAIL').'</font>');
1308: return 0;
1309: }
1310: $distarget=~s/\/+/\//g;
1311: my $logfile;
1312: unless ($logfile=Apache::File->new('>>'.$source.'.log')) {
1313: $r->print(
1314: '<font color="red">'.
1315: &mt('No write permission to user directory, FAIL').'</font>');
1316: return 0;
1317: }
1318: print $logfile
1319: "\n================= Publish ".localtime()." Phase Two ================\n".$ENV{'user.name'}.'@'.$ENV{'user.domain'}."\n";
1320:
1321: %metadatafields=();
1322: %metadatakeys=();
1323:
1324: &metaeval(&Apache::lonnet::unescape($ENV{'form.allmeta'}));
1325:
1326: $metadatafields{'title'}=$ENV{'form.title'};
1327: $metadatafields{'author'}=$ENV{'form.author'};
1328: $metadatafields{'subject'}=$ENV{'form.subject'};
1329: $metadatafields{'notes'}=$ENV{'form.notes'};
1330: $metadatafields{'abstract'}=$ENV{'form.abstract'};
1331: $metadatafields{'mime'}=$ENV{'form.mime'};
1332: $metadatafields{'language'}=$ENV{'form.language'};
1333: $metadatafields{'creationdate'}=$ENV{'form.creationdate'};
1334: $metadatafields{'lastrevisiondate'}=$ENV{'form.lastrevisiondate'};
1335: $metadatafields{'owner'}=$ENV{'form.owner'};
1336: $metadatafields{'copyright'}=$ENV{'form.copyright'};
1337: $metadatafields{'customdistributionfile'}=
1338: $ENV{'form.customdistributionfile'};
1339: $metadatafields{'obsolete'}=$ENV{'form.obsolete'};
1340: $metadatafields{'obsoletereplacement'}=
1341: $ENV{'form.obsoletereplacement'};
1342: $metadatafields{'dependencies'}=$ENV{'form.dependencies'};
1343:
1344: my $allkeywords=$ENV{'form.addkey'};
1345: if (exists($ENV{'form.keywords'})) {
1346: if (ref($ENV{'form.keywords'})) {
1347: $allkeywords .= ','.join(',',@{$ENV{'form.keywords'}});
1348: } else {
1349: $allkeywords .= ','.$ENV{'form.keywords'};
1350: }
1351: }
1352: $allkeywords=~s/\W+/\,/;
1353: $allkeywords=~s/^\,//;
1354: $metadatafields{'keywords'}=$allkeywords;
1355:
1356: # check if custom distribution file is specified
1357: if ($metadatafields{'copyright'} eq 'custom') {
1358: my $file=$metadatafields{'customdistributionfile'};
1359: unless ($file=~/\.rights$/) {
1360: return
1361: '<font color="red">'.&mt('No valid custom distribution rights file specified, FAIL').
1362: '</font>';
1363: }
1364: }
1365: {
1366: print $logfile "\nWrite metadata file for ".$source;
1367: my $mfh;
1368: unless ($mfh=Apache::File->new('>'.$source.'.meta')) {
1369: return
1370: '<font color="red">'.&mt('Could not write metadata, FAIL').
1371: '</font>';
1372: }
1373: foreach (sort keys %metadatafields) {
1374: unless ($_=~/\./) {
1375: my $unikey=$_;
1376: $unikey=~/^([A-Za-z]+)/;
1377: my $tag=$1;
1378: $tag=~tr/A-Z/a-z/;
1379: print $mfh "\n\<$tag";
1380: foreach (split(/\,/,$metadatakeys{$unikey})) {
1381: my $value=$metadatafields{$unikey.'.'.$_};
1382: $value=~s/\"/\'\'/g;
1383: print $mfh ' '.$_.'="'.$value.'"';
1384: }
1385: print $mfh '>'.
1386: &HTML::Entities::encode($metadatafields{$unikey})
1387: .'</'.$tag.'>';
1388: }
1389: }
1390: $r->print('<p>'.&mt('Wrote Metadata').'</p>');
1391: print $logfile "\nWrote metadata";
1392: }
1393:
1394: # -------------------------------- Synchronize entry with SQL metadata database
1395:
1396: $metadatafields{'url'} = $distarget;
1397: $metadatafields{'version'} = 'current';
1398: unless ($metadatafields{'copyright'} eq 'priv') {
1399: my ($error,$success) = &store_metadata(\%metadatafields);
1400: if ($success) {
1401: $r->print('<p>'.&mt('Synchronized SQL metadata database').'</p>');
1402: print $logfile "\nSynchronized SQL metadata database";
1403: } else {
1404: $r->print($error);
1405: print $logfile "\n".$error;
1406: }
1407: } else {
1408: $r->print('<p>'.
1409: &mt('Private Publication - did not synchronize database').'</p>');
1410: print $logfile "\nPrivate: Did not synchronize data into ".
1411: "SQL metadata database";
1412: }
1413: # ----------------------------------------------------------- Copy old versions
1414:
1415: if (-e $target) {
1416: my $filename;
1417: my $maxversion=0;
1418: $target=~/(.*)\/([^\/]+)\.(\w+)$/;
1419: my $srcf=$2;
1420: my $srct=$3;
1421: my $srcd=$1;
1422: unless ($srcd=~/^\/home\/httpd\/html\/res/) {
1423: print $logfile "\nPANIC: Target dir is ".$srcd;
1424: return "<font color=\"red\">Invalid target directory, FAIL</font>";
1425: }
1426: opendir(DIR,$srcd);
1427: while ($filename=readdir(DIR)) {
1428: if (-l $srcd.'/'.$filename) {
1429: unlink($srcd.'/'.$filename);
1430: unlink($srcd.'/'.$filename.'.meta');
1431: } else {
1432: if ($filename=~/\Q$srcf\E\.(\d+)\.\Q$srct\E$/) {
1433: $maxversion=($1>$maxversion)?$1:$maxversion;
1434: }
1435: }
1436: }
1437: closedir(DIR);
1438: $maxversion++;
1439: $r->print('<p>Creating old version '.$maxversion.'</p>');
1440: print $logfile "\nCreating old version ".$maxversion."\n";
1441:
1442: my $copyfile=$srcd.'/'.$srcf.'.'.$maxversion.'.'.$srct;
1443:
1444: if (copy($target,$copyfile)) {
1445: print $logfile "Copied old target to ".$copyfile."\n";
1446: $r->print('<p>'.&mt('Copied old target file').'</p>');
1447: } else {
1448: print $logfile "Unable to write ".$copyfile.':'.$!."\n";
1449: return "<font color=\"red\">".&mt('Failed to copy old target').
1450: ", $!, ".&mt('FAIL')."</font>";
1451: }
1452:
1453: # --------------------------------------------------------------- Copy Metadata
1454:
1455: $copyfile=$copyfile.'.meta';
1456:
1457: if (copy($target.'.meta',$copyfile)) {
1458: print $logfile "Copied old target metadata to ".$copyfile."\n";
1459: $r->print('<p>'.&mt('Copied old metadata').'</p>')
1460: } else {
1461: print $logfile "Unable to write metadata ".$copyfile.':'.$!."\n";
1462: if (-e $target.'.meta') {
1463: return
1464: "<font color=\"red\">".
1465: &mt('Failed to write old metadata copy').", $!, ".&mt('FAIL')."</font>";
1466: }
1467: }
1468:
1469:
1470: } else {
1471: $r->print('<p>'.&mt('Initial version').'</p>');
1472: print $logfile "\nInitial version";
1473: }
1474:
1475: # ---------------------------------------------------------------- Write Source
1476: my $copyfile=$target;
1477:
1478: my @parts=split(/\//,$copyfile);
1479: my $path="/$parts[1]/$parts[2]/$parts[3]/$parts[4]";
1480:
1481: my $count;
1482: for ($count=5;$count<$#parts;$count++) {
1483: $path.="/$parts[$count]";
1484: if ((-e $path)!=1) {
1485: print $logfile "\nCreating directory ".$path;
1486: $r->print('<p>'.&mt('Created directory').' '.$parts[$count].'</p>');
1487: mkdir($path,0777);
1488: }
1489: }
1490:
1491: if (copy($source,$copyfile)) {
1492: print $logfile "\nCopied original source to ".$copyfile."\n";
1493: $r->print('<p>'.&mt('Copied source file').'</p>');
1494: } else {
1495: print $logfile "\nUnable to write ".$copyfile.':'.$!."\n";
1496: return "<font color=\"red\">".
1497: &mt('Failed to copy source').", $!, ".&mt('FAIL')."</font>";
1498: }
1499:
1500: # --------------------------------------------------------------- Copy Metadata
1501:
1502: $copyfile=$copyfile.'.meta';
1503:
1504: if (copy($source.'.meta',$copyfile)) {
1505: print $logfile "\nCopied original metadata to ".$copyfile."\n";
1506: $r->print('<p>'.&mt('Copied metadata').'</p>');
1507: } else {
1508: print $logfile "\nUnable to write metadata ".$copyfile.':'.$!."\n";
1509: return
1510: "<font color=\"red\">".&mt('Failed to write metadata copy').", $!, ".&mt('FAIL')."</font>";
1511: }
1512: $r->rflush;
1513: # --------------------------------------------------- Send update notifications
1514:
1515: my @subscribed=&get_subscribed_hosts($target);
1516: foreach my $subhost (@subscribed) {
1517: $r->print('<p>'.&mt('Notifying host').' '.$subhost.':');$r->rflush;
1518: print $logfile "\nNotifying host ".$subhost.':';
1519: my $reply=&Apache::lonnet::critical('update:'.$target,$subhost);
1520: $r->print($reply.'</p><br />');$r->rflush;
1521: print $logfile $reply;
1522: }
1523:
1524: # ---------------------------------------- Send update notifications, meta only
1525:
1526: my @subscribedmeta=&get_subscribed_hosts("$target.meta");
1527: foreach my $subhost (@subscribedmeta) {
1528: $r->print('<p>'.
1529: &mt('Notifying host for metadata only').' '.$subhost.':');$r->rflush;
1530: print $logfile "\nNotifying host for metadata only ".$subhost.':';
1531: my $reply=&Apache::lonnet::critical('update:'.$target.'.meta',
1532: $subhost);
1533: $r->print($reply.'</p><br />');$r->rflush;
1534: print $logfile $reply;
1535: }
1536:
1537: # --------------------------------------------------- Notify subscribed courses
1538: my %courses=&coursedependencies($target);
1539: my $now=time;
1540: foreach (keys %courses) {
1541: $r->print('<p>'.&mt('Notifying course').' '.$_.':');$r->rflush;
1542: print $logfile "\nNotifying host ".$_.':';
1543: my ($cdom,$cname)=split(/\_/,$_);
1544: my $reply=&Apache::lonnet::cput
1545: ('versionupdate',{$target => $now},$cdom,$cname);
1546: $r->print($reply.'</p><br />');$r->rflush;
1547: print $logfile $reply;
1548: }
1549: # ------------------------------------------------ Provide link to new resource
1550: unless ($batch) {
1551: my $thisdistarget=$target;
1552: $thisdistarget=~s/^\Q$docroot\E//;
1553:
1554: my $thissrc=$source;
1555: $thissrc=~s/^\/home\/(\w+)\/public_html/\/priv\/$1/;
1556:
1557: my $thissrcdir=$thissrc;
1558: $thissrcdir=~s/\/[^\/]+$/\//;
1559:
1560:
1561: $r->print(
1562: '<hr /><a href="'.$thisdistarget.'"><font size="+2">'.
1563: &mt('View Published Version').'</font></a>'.
1564: '<p><a href="'.$thissrc.'"><font size=+2>'.
1565: &mt('Back to Source').'</font></a></p>'.
1566: '<p><a href="'.$thissrcdir.
1567: '"><font size="+2">'.
1568: &mt('Back to Source Directory').'</font></a></p>');
1569: }
1570: return '<p><font color="green">'.&mt('Done').'</font></p>';
1571: }
1572:
1573: #########################################
1574:
1575: sub batchpublish {
1576: my ($r,$srcfile,$targetfile)=@_;
1577: #publication pollutes %ENV with form.* values
1578: my %oldENV=%ENV;
1579: $srcfile=~s/\/+/\//g;
1580: $targetfile=~s/\/+/\//g;
1581: my $thisdisfn=$srcfile;
1582: $thisdisfn=~s/\/home\/korte\/public_html\///;
1583: $srcfile=~s/\/+/\//g;
1584:
1585: my $docroot=$r->dir_config('lonDocRoot');
1586: my $thisdistarget=$targetfile;
1587: $thisdistarget=~s/^\Q$docroot\E//;
1588:
1589:
1590: %metadatafields=();
1591: %metadatakeys=();
1592: $srcfile=~/\.(\w+)$/;
1593: my $thistype=$1;
1594:
1595:
1596: my $thisembstyle=&Apache::loncommon::fileembstyle($thistype);
1597:
1598: $r->print('<h2>'.&mt('Publishing').' <tt>'.$thisdisfn.'</tt></h2>');
1599:
1600: # phase one takes
1601: # my ($source,$target,$style,$batch)=@_;
1602: my ($outstring,$error)=&publish($srcfile,$targetfile,$thisembstyle,1);
1603: $r->print('<p>'.$outstring.'</p>');
1604: # phase two takes
1605: # my ($source,$target,$style,$distarget,batch)=@_;
1606: # $ENV{'form.allmeta'},$ENV{'form.title'},$ENV{'form.author'},...
1607: if (!$error) {
1608: $r->print('<p>');
1609: &phasetwo($r,$srcfile,$targetfile,$thisembstyle,$thisdistarget,1);
1610: $r->print('</p>');
1611: }
1612: %ENV=%oldENV;
1613: return '';
1614: }
1615:
1616: #########################################
1617:
1618: sub publishdirectory {
1619: my ($r,$fn,$thisdisfn)=@_;
1620: $fn=~s/\/+/\//g;
1621: $thisdisfn=~s/\/+/\//g;
1622: my $resdir=
1623: $Apache::lonnet::perlvar{'lonDocRoot'}.'/res/'.$cudom.'/'.$cuname.'/'.
1624: $thisdisfn;
1625: $r->print('<h1>Directory <tt>'.$thisdisfn.'</tt></h1>'.
1626: 'Target: <tt>'.$resdir.'</tt><br />');
1627:
1628: my $dirptr=16384; # Mask indicating a directory in stat.cmode.
1629:
1630: opendir(DIR,$fn);
1631: my @files=sort(readdir(DIR));
1632: foreach my $filename (@files) {
1633: my ($cdev,$cino,$cmode,$cnlink,
1634: $cuid,$cgid,$crdev,$csize,
1635: $catime,$cmtime,$cctime,
1636: $cblksize,$cblocks)=stat($fn.'/'.$filename);
1637:
1638: my $extension='';
1639: if ($filename=~/\.(\w+)$/) { $extension=$1; }
1640: if ($cmode&$dirptr) {
1641: if (($filename!~/^\./) && ($ENV{'form.pubrec'})) {
1642: &publishdirectory($r,$fn.'/'.$filename,$thisdisfn.'/'.$filename);
1643: }
1644: } elsif ((&Apache::loncommon::fileembstyle($extension) ne 'hdn') &&
1645: ($filename!~/^[\#\.]/) && ($filename!~/\~$/)) {
1646: # find out publication status and/or exiting metadata
1647: my $publishthis=0;
1648: if (-e $resdir.'/'.$filename) {
1649: my ($rdev,$rino,$rmode,$rnlink,
1650: $ruid,$rgid,$rrdev,$rsize,
1651: $ratime,$rmtime,$rctime,
1652: $rblksize,$rblocks)=stat($resdir.'/'.$filename);
1653: if (($rmtime<$cmtime) || ($ENV{'form.forcerepub'})) {
1654: # previously published, modified now
1655: $publishthis=1;
1656: }
1657: } else {
1658: # never published
1659: $publishthis=1;
1660: }
1661: if ($publishthis) {
1662: &batchpublish($r,$fn.'/'.$filename,$resdir.'/'.$filename);
1663: } else {
1664: $r->print('<br />Skipping '.$filename.'<br />');
1665: }
1666: $r->rflush();
1667: }
1668: }
1669: closedir(DIR);
1670: }
1671: #########################################
1672:
1673: =pod
1674:
1675: =item B<handler>
1676:
1677: A basic outline of the handler subroutine follows.
1678:
1679: =over 4
1680:
1681: =item *
1682:
1683: Get query string for limited number of parameters.
1684:
1685: =item *
1686:
1687: Check filename.
1688:
1689: =item *
1690:
1691: File is there and owned, init lookup tables.
1692:
1693: =item *
1694:
1695: Start page output.
1696:
1697: =item *
1698:
1699: Evaluate individual file, and then output information.
1700:
1701: =item *
1702:
1703: Publishing from $thisfn to $thistarget with $thisembstyle.
1704:
1705: =back
1706:
1707: =cut
1708:
1709: #########################################
1710: #########################################
1711: sub handler {
1712: my $r=shift;
1713:
1714: if ($r->header_only) {
1715: &Apache::loncommon::content_type($r,'text/html');
1716: $r->send_http_header;
1717: return OK;
1718: }
1719:
1720: # Get query string for limited number of parameters
1721:
1722: &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},
1723: ['filename']);
1724:
1725: # -------------------------------------------------------------- Check filename
1726:
1727: my $fn=&Apache::lonnet::unescape($ENV{'form.filename'});
1728:
1729:
1730: unless ($fn) {
1731: $r->log_reason($cuname.' at '.$cudom.
1732: ' trying to publish empty filename', $r->filename);
1733: return HTTP_NOT_FOUND;
1734: }
1735:
1736: ($cuname,$cudom)=
1737: &Apache::loncacc::constructaccess($fn,$r->dir_config('lonDefDomain'));
1738: unless (($cuname) && ($cudom)) {
1739: $r->log_reason($cuname.' at '.$cudom.
1740: ' trying to publish file '.$ENV{'form.filename'}.
1741: ' ('.$fn.') - not authorized',
1742: $r->filename);
1743: return HTTP_NOT_ACCEPTABLE;
1744: }
1745:
1746: unless (&Apache::lonnet::homeserver($cuname,$cudom)
1747: eq $r->dir_config('lonHostID')) {
1748: $r->log_reason($cuname.' at '.$cudom.
1749: ' trying to publish file '.$ENV{'form.filename'}.
1750: ' ('.$fn.') - not homeserver ('.
1751: &Apache::lonnet::homeserver($cuname,$cudom).')',
1752: $r->filename);
1753: return HTTP_NOT_ACCEPTABLE;
1754: }
1755:
1756: $fn=~s/^http\:\/\/[^\/]+//;
1757: $fn=~s/^\/\~(\w+)/\/home\/$1\/public_html/;
1758:
1759: my $targetdir='';
1760: $docroot=$r->dir_config('lonDocRoot');
1761: if ($1 ne $cuname) {
1762: $r->log_reason($cuname.' at '.$cudom.
1763: ' trying to publish unowned file '.
1764: $ENV{'form.filename'}.' ('.$fn.')',
1765: $r->filename);
1766: return HTTP_NOT_ACCEPTABLE;
1767: } else {
1768: $targetdir=$docroot.'/res/'.$cudom;
1769: }
1770:
1771:
1772: unless (-e $fn) {
1773: $r->log_reason($cuname.' at '.$cudom.
1774: ' trying to publish non-existing file '.
1775: $ENV{'form.filename'}.' ('.$fn.')',
1776: $r->filename);
1777: return HTTP_NOT_FOUND;
1778: }
1779:
1780: unless ($ENV{'form.phase'} eq 'two') {
1781:
1782: # -------------------------------- File is there and owned, init lookup tables.
1783:
1784: %addid=();
1785:
1786: {
1787: my $fh=Apache::File->new($r->dir_config('lonTabDir').'/addid.tab');
1788: while (<$fh>=~/(\w+)\s+(\w+)/) {
1789: $addid{$1}=$2;
1790: }
1791: }
1792:
1793: %nokey=();
1794:
1795: {
1796: my $fh=Apache::File->new($r->dir_config('lonIncludes').'/un_keyword.tab');
1797: while (<$fh>) {
1798: my $word=$_;
1799: chomp($word);
1800: $nokey{$word}=1;
1801: }
1802: }
1803:
1804: }
1805:
1806: # ---------------------------------------------------------- Start page output.
1807:
1808: &Apache::loncommon::content_type($r,'text/html');
1809: $r->send_http_header;
1810:
1811: $r->print('<html><head><title>LON-CAPA Publishing</title></head>');
1812: $r->print(&Apache::loncommon::bodytag('Resource Publication'));
1813:
1814:
1815: my $thisfn=$fn;
1816:
1817: my $thistarget=$thisfn;
1818:
1819: $thistarget=~s/^\/home/$targetdir/;
1820: $thistarget=~s/\/public\_html//;
1821:
1822: my $thisdistarget=$thistarget;
1823: $thisdistarget=~s/^\Q$docroot\E//;
1824:
1825: my $thisdisfn=$thisfn;
1826: $thisdisfn=~s/^\/home\/\Q$cuname\E\/public_html\///;
1827:
1828: if ($fn=~/\/$/) {
1829: # -------------------------------------------------------- This is a directory
1830: &publishdirectory($r,$fn,$thisdisfn);
1831: $r->print('<hr><font size="+2">'.&mt('Done').'</font><br><a href="/priv/'
1832: .$cuname.'/'.$thisdisfn
1833: .'">'.&mt('Return to Directory').'</a>');
1834:
1835:
1836: } else {
1837: # ---------------------- Evaluate individual file, and then output information.
1838: $thisfn=~/\.(\w+)$/;
1839: my $thistype=$1;
1840: my $thisembstyle=&Apache::loncommon::fileembstyle($thistype);
1841: $r->print('<h2>'.&mt('Publishing').' '.
1842: &Apache::loncommon::filedescription($thistype).' <tt>');
1843:
1844: $r->print(<<ENDCAPTION);
1845: <a href='javascript:void(window.open("/~$cuname/$thisdisfn","cat","height=300,width=500,scrollbars=1,resizable=1,menubar=0,location=1"))'>
1846: $thisdisfn</a>
1847: ENDCAPTION
1848: $r->print('</tt></h2><b>'.&mt('Target').':</b> <tt>'.
1849: $thisdistarget.'</tt><br />');
1850:
1851: if (($cuname ne $ENV{'user.name'})||($cudom ne $ENV{'user.domain'})) {
1852: $r->print('<h3><font color="red">'.&mt('Co-Author').': '.
1853: $cuname.&mt(' at ').$cudom.'</font></h3>');
1854: }
1855:
1856: if (&Apache::loncommon::fileembstyle($thistype) eq 'ssi') {
1857: $r->print(<<ENDDIFF);
1858: <br />
1859: <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"))'>
1860: ENDDIFF
1861: $r->print(&mt('Diffs with Current Version').'</a><br />');
1862: }
1863:
1864: # ------------------ Publishing from $thisfn to $thistarget with $thisembstyle.
1865:
1866: unless ($ENV{'form.phase'} eq 'two') {
1867: my ($outstring,$error)=&publish($thisfn,$thistarget,$thisembstyle);
1868: $r->print('<hr />'.$outstring);
1869: } else {
1870: $r->print('<hr />'.
1871: &phasetwo($r,$thisfn,$thistarget,$thisembstyle,$thisdistarget));
1872: }
1873: }
1874: $r->print('</body></html>');
1875:
1876: return OK;
1877: }
1878:
1879: 1;
1880: __END__
1881:
1882: =pod
1883:
1884: =back
1885:
1886: =back
1887:
1888: =cut
1889:
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>
![[BACK]](/icons/back.gif){kind=icon}
Return to lonpublisher.pm CVS log ![[TXT]](/icons/text.gif){kind=icon}
![[DIR]](/icons/dir.gif){kind=icon}
Up to [LON-CAPA] / loncom / publisher