1: # The LearningOnline Network with CAPA
2: # Publication Handler
3: #
4: # $Id: lonpublisher.pm,v 1.155 2003/12/27 16:58:36 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 = @_;
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: # retrieve current database column names
803: my @columns=&Apache::lonmysql::col_order('metadata');
804: # see if we have old entries
805: my @oldmeta=&Apache::lonmysql::get_rows('metadata',
806: "url LIKE BINARY '".
807: $metadata{'url'}."'");
808: if ($#oldmeta==0) {
809: # there is an old value
810: for (my $i=0; $i<=$#columns; $i++) {
811: $newmetadata{$columns[$i]}=$oldmeta[0]->[$i];
812: }
813: # remove old entry
814: $status=&Apache::lonmysql::remove_from_table
815: ('metadata','url',$metadata{'url'});
816: } elsif ($#oldmeta>0) {
817: # more than one entry fit - how did that happen?
818: $error='<font color="red">Error occured retrieving old values in '.
819: 'metadata table in LON-CAPA database: '.$#oldmeta.
820: ' matches</font>';
821: &Apache::lonnet::logthis($error);
822: return ($error,undef);
823: }
824: # store new data on top of it
825: foreach (keys %metadata) {
826: $newmetadata{$_}=$metadata{$_};
827: }
828: $status = &Apache::lonmysql::store_row('metadata',\%newmetadata);
829: }
830: if (! defined($status)) {
831: $error='<font color="red">Error occured storing new values in '.
832: 'metadata table in LON-CAPA database</font>';
833: &Apache::lonnet::logthis($error);
834: return ($error,undef);
835: }
836: return (undef,$status);
837: }
838:
839:
840: # ============================================== Parse file itself for metadata
841: #
842: # parses a file with target meta, sets global %metadatafields %metadatakeys
843:
844: sub parseformeta {
845: my ($source,$style)=@_;
846: my $allmeta='';
847: if (($style eq 'ssi') || ($style eq 'prv')) {
848: my $dir=$source;
849: $dir=~s-/[^/]*$--;
850: my $file=$source;
851: $file=(split('/',$file))[-1];
852: $source=&Apache::lonnet::hreflocation($dir,$file);
853: $allmeta=&Apache::lonnet::ssi_body($source,('grade_target' => 'meta'));
854: &metaeval($allmeta);
855: }
856: return $allmeta;
857: }
858:
859: #########################################
860: #########################################
861:
862: =pod
863:
864: =item B<publish>
865:
866: This is the workhorse function of this module. This subroutine generates
867: backup copies, performs any automatic processing (prior to publication,
868: especially for rat and ssi files),
869:
870: Returns a 2 element array, the first is the string to be shown to the
871: user, the second is an error code, either 1 (an error occured) or 0
872: (no error occurred)
873:
874: I<Additional documentation needed.>
875:
876: =cut
877:
878: #########################################
879: #########################################
880: sub publish {
881:
882: my ($source,$target,$style,$batch)=@_;
883: my $logfile;
884: my $scrout='';
885: my $allmeta='';
886: my $content='';
887: my %allow=();
888:
889: unless ($logfile=Apache::File->new('>>'.$source.'.log')) {
890: return ('<font color="red">'.&mt('No write permission to user directory, FAIL').'</font>',1);
891: }
892: print $logfile
893: "\n\n================= Publish ".localtime()." Phase One ================\n".$ENV{'user.name'}.'@'.$ENV{'user.domain'}."\n";
894:
895: if (($style eq 'ssi') || ($style eq 'rat') || ($style eq 'prv')) {
896: # ------------------------------------------------------- This needs processing
897:
898: # ----------------------------------------------------------------- Backup Copy
899: my $copyfile=$source.'.save';
900: if (copy($source,$copyfile)) {
901: print $logfile "Copied original file to ".$copyfile."\n";
902: } else {
903: print $logfile "Unable to write backup ".$copyfile.':'.$!."\n";
904: return ("<font color=\"red\">Failed to write backup copy, $!,FAIL</font>",1);
905: }
906: # ------------------------------------------------------------- IDs and indices
907:
908: my ($outstring,$error);
909: ($outstring,$error,%allow)=&fix_ids_and_indices($logfile,$source,
910: $target);
911: if ($error) { return ($outstring,$error); }
912: # ------------------------------------------------------------ Construct Allows
913:
914: $scrout.='<h3>'.&mt('Dependencies').'</h3>';
915: my $allowstr='';
916: foreach (sort(keys(%allow))) {
917: my $thisdep=$_;
918: if ($thisdep !~ /[^\s]/) { next; }
919: unless ($style eq 'rat') {
920: $allowstr.="\n".'<allow src="'.$thisdep.'" />';
921: }
922: $scrout.='<br />';
923: unless ($thisdep=~/\*/) {
924: $scrout.='<a href="'.$thisdep.'">';
925: }
926: $scrout.='<tt>'.$thisdep.'</tt>';
927: unless ($thisdep=~/\*/) {
928: $scrout.='</a>';
929: if (
930: &Apache::lonnet::getfile($Apache::lonnet::perlvar{'lonDocRoot'}.'/'.
931: $thisdep.'.meta') eq '-1') {
932: $scrout.= ' - <font color="red">'.&mt('Currently not available').
933: '</font>';
934: } else {
935: my %temphash=(&Apache::lonnet::declutter($target).'___'.
936: &Apache::lonnet::declutter($thisdep).'___usage'
937: => time);
938: $thisdep=~/^\/res\/(\w+)\/(\w+)\//;
939: if ((defined($1)) && (defined($2))) {
940: &Apache::lonnet::put('nohist_resevaldata',\%temphash,
941: $1,$2);
942: }
943: }
944: }
945: }
946: $outstring=~s/\n*(\<\/[^\>]+\>)\s*$/$allowstr\n$1\n/s;
947:
948: ### FIXME: is this really what we want?
949: # I dont' think so, to will corrupt any UTF-8 resources at least,
950: # and any encoding other than ISO-8859-1 will probably break
951: #Encode any High ASCII characters
952: #$outstring=&HTML::Entities::encode($outstring,"\200-\377");
953: # ------------------------------------------------------------- Write modified.
954:
955: {
956: my $org;
957: unless ($org=Apache::File->new('>'.$source)) {
958: print $logfile "No write permit to $source\n";
959: return ('<font color="red">'.&mt('No write permission to').
960: ' '.$source.
961: ', '.&mt('FAIL').'</font>',1);
962: }
963: print($org $outstring);
964: }
965: $content=$outstring;
966:
967: }
968: # -------------------------------------------- Initial step done, now metadata.
969:
970: # --------------------------------------- Storage for metadata keys and fields.
971: # these are globals
972: #
973: %metadatafields=();
974: %metadatakeys=();
975:
976: my %oldparmstores=();
977:
978: unless ($batch) {
979: $scrout.='<h3>'.&mt('Metadata Information').' ' .
980: Apache::loncommon::help_open_topic("Metadata_Description")
981: . '</h3>';
982: }
983:
984: # ------------------------------------------------ First, check out environment
985: unless (-e $source.'.meta') {
986: $metadatafields{'author'}=$ENV{'environment.firstname'}.' '.
987: $ENV{'environment.middlename'}.' '.
988: $ENV{'environment.lastname'}.' '.
989: $ENV{'environment.generation'};
990: $metadatafields{'author'}=~s/\s+/ /g;
991: $metadatafields{'author'}=~s/\s+$//;
992: $metadatafields{'owner'}=$cuname.'@'.$cudom;
993:
994: # ------------------------------------------------ Check out directory hierachy
995:
996: my $thisdisfn=$source;
997: $thisdisfn=~s/^\/home\/\Q$cuname\E\///;
998:
999: my @urlparts=split(/\//,$thisdisfn);
1000: $#urlparts--;
1001:
1002: my $currentpath='/home/'.$cuname.'/';
1003:
1004: my $prefix='../'x($#urlparts);
1005: foreach (@urlparts) {
1006: $currentpath.=$_.'/';
1007: $scrout.=&metaread($logfile,$currentpath.'default.meta',$prefix);
1008: $prefix=~s|^\.\./||;
1009: }
1010: # ----------------------------------------------------------- Parse file itself
1011: # read %metadatafields from file itself
1012:
1013: $allmeta=&parseformeta($source,$style);
1014:
1015: # ------------------- Clear out parameters and stores (there should not be any)
1016:
1017: foreach (keys %metadatafields) {
1018: if (($_=~/^parameter/) || ($_=~/^stores/)) {
1019: delete $metadatafields{$_};
1020: }
1021: }
1022:
1023: } else {
1024: # ---------------------- Read previous metafile, remember parameters and stores
1025:
1026: $scrout.=&metaread($logfile,$source.'.meta');
1027:
1028: foreach (keys %metadatafields) {
1029: if (($_=~/^parameter/) || ($_=~/^stores/)) {
1030: $oldparmstores{$_}=1;
1031: delete $metadatafields{$_};
1032: }
1033: }
1034: # ------------------------------------------ See if anything new in file itself
1035:
1036: $allmeta=&parseformeta($source,$style);
1037: }
1038:
1039:
1040: # ---------------- Find and document discrepancies in the parameters and stores
1041:
1042: my $chparms='';
1043: foreach (sort keys %metadatafields) {
1044: if (($_=~/^parameter/) || ($_=~/^stores/)) {
1045: unless ($_=~/\.\w+$/) {
1046: unless ($oldparmstores{$_}) {
1047: print $logfile 'New: '.$_."\n";
1048: $chparms.=$_.' ';
1049: }
1050: }
1051: }
1052: }
1053: if ($chparms) {
1054: $scrout.='<p><b>'.&mt('New parameters or stored values').
1055: ':</b> '.$chparms.'</p>';
1056: }
1057:
1058: $chparms='';
1059: foreach (sort keys %oldparmstores) {
1060: if (($_=~/^parameter/) || ($_=~/^stores/)) {
1061: unless (($metadatafields{$_.'.name'}) ||
1062: ($metadatafields{$_.'.package'}) || ($_=~/\.\w+$/)) {
1063: print $logfile 'Obsolete: '.$_."\n";
1064: $chparms.=$_.' ';
1065: }
1066: }
1067: }
1068: if ($chparms) {
1069: $scrout.='<p><b>'.&mt('Obsolete parameters or stored values').':</b> '.
1070: $chparms.'</p><h1><font color="red">'.&mt('Warning!').
1071: '</font></h1><p><font color="red" size="+1">'.
1072: &mt('If this resource is in active use, student performance data from the previous version may become inaccessible.').'</font></p><hr />';
1073: }
1074:
1075: # ------------------------------------------------------- Now have all metadata
1076:
1077: my %keywords=();
1078:
1079: if (length($content)<500000) {
1080: my $textonly=$content;
1081: $textonly=~s/\<script[^\<]+\<\/script\>//g;
1082: $textonly=~s/\<m\>[^\<]+\<\/m\>//g;
1083: $textonly=~s/\<[^\>]*\>//g;
1084: $textonly=~tr/A-Z/a-z/;
1085: $textonly=~s/[\$\&][a-z]\w*//g;
1086: $textonly=~s/[^a-z\s]//g;
1087:
1088: foreach ($textonly=~m/(\w+)/g) {
1089: unless ($nokey{$_}) {
1090: $keywords{$_}=1;
1091: }
1092: }
1093: }
1094:
1095:
1096: foreach (split(/\W+/,$metadatafields{'keywords'})) {
1097: $keywords{$_}=1;
1098: }
1099: # --------------------------------------------------- Now we also have keywords
1100: # =============================================================================
1101: # INTERACTIVE MODE
1102: #
1103: unless ($batch) {
1104: $scrout.=
1105: '<form name="pubform" action="/adm/publish" method="post">'.
1106: '<p><input type="submit" value="'.&mt('Finalize Publication').'" /></p>'.
1107: &hiddenfield('phase','two').
1108: &hiddenfield('filename',$ENV{'form.filename'}).
1109: &hiddenfield('allmeta',&Apache::lonnet::escape($allmeta)).
1110: &hiddenfield('dependencies',join(',',keys %allow)).
1111: &textfield('Title','title',$metadatafields{'title'}).
1112: &textfield('Author(s)','author',$metadatafields{'author'}).
1113: &textfield('Subject','subject',$metadatafields{'subject'});
1114:
1115: # --------------------------------------------------- Scan content for keywords
1116:
1117: my $keywords_help = Apache::loncommon::help_open_topic("Publishing_Keywords");
1118: my $KEYWORDS=&mt('KEYWORDS');
1119: my $CheckAll=&mt('check all');
1120: my $UncheckAll=&mt('uncheck all');
1121: my $keywordout=<<"END";
1122: <script>
1123: function checkAll(field) {
1124: for (i = 0; i < field.length; i++)
1125: field[i].checked = true ;
1126: }
1127:
1128: function uncheckAll(field) {
1129: for (i = 0; i < field.length; i++)
1130: field[i].checked = false ;
1131: }
1132: </script>
1133: <p><font color="#800000" face="helvetica"><b>$KEYWORDS:</b></font>
1134: $keywords_help</b>
1135: <input type="button" value="$CheckAll" onclick="javascript:checkAll(document.pubform.keywords)" />
1136: <input type="button" value="$UncheckAll" onclick="javascript:uncheckAll(document.pubform.keywords)" />
1137: </p>
1138: <br />
1139: END
1140: $keywordout.='<table border="2"><tr>';
1141: my $colcount=0;
1142:
1143: foreach (sort keys %keywords) {
1144: $keywordout.='<td><input type="checkbox" name="keywords" value="'.$_.'"';
1145: if ($metadatafields{'keywords'}) {
1146: if ($metadatafields{'keywords'}=~/\Q$_\E/) {
1147: $keywordout.=' checked="on"';
1148: }
1149: } elsif (&Apache::loncommon::keyword($_)) {
1150: $keywordout.=' checked="on"';
1151: }
1152: $keywordout.=' />'.$_.'</td>';
1153: if ($colcount>10) {
1154: $keywordout.="</tr><tr>\n";
1155: $colcount=0;
1156: }
1157: $colcount++;
1158: }
1159:
1160: $keywordout.='</tr></table>';
1161:
1162: $scrout.=$keywordout;
1163:
1164: $scrout.=&textfield('Additional Keywords','addkey','');
1165:
1166: $scrout.=&textfield('Notes','notes',$metadatafields{'notes'});
1167:
1168: $scrout.=
1169: "\n<p><font color=\"#800000\" face=\"helvetica\"><b>".&mt('ABSTRACT').":".
1170: "</b></font></p><br />".
1171: '<textarea cols="80" rows="5" name="abstract">'.
1172: $metadatafields{'abstract'}.'</textarea></p>';
1173:
1174: $source=~/\.(\w+)$/;
1175:
1176:
1177: $scrout.=
1178: "\n<p><font color=\"#800000\" face=\"helvetica\"><b>".
1179: uc(&mt('Lowest Grade Level:')).
1180: "</b></font></p><br />".
1181: &Apache::loncommon::select_level_form($metadatafields{'lowestgradelevel'},'lowestgradelevel').
1182: "\n<p><font color=\"#800000\" face=\"helvetica\"><b>".
1183: uc(&mt('Highest Grade Level:')).
1184: "</b></font></p><br />".
1185: &Apache::loncommon::select_level_form($metadatafields{'highestgradelevel'},'highestgradelevel').
1186: &textfield('Standards','standards',$metadatafields{'standards'});
1187:
1188:
1189:
1190:
1191: $scrout.=&hiddenfield('mime',$1);
1192:
1193: my $defaultlanguage=$metadatafields{'language'};
1194: $defaultlanguage =~ s/\s*notset\s*//g;
1195: $defaultlanguage =~ s/^,\s*//g;
1196: $defaultlanguage =~ s/,\s*$//g;
1197:
1198: $scrout.=&selectbox('Language','language',
1199: $defaultlanguage,
1200: \&Apache::loncommon::languagedescription,
1201: (&Apache::loncommon::languageids),
1202: );
1203:
1204: unless ($metadatafields{'creationdate'}) {
1205: $metadatafields{'creationdate'}=time;
1206: }
1207: $scrout.=&hiddenfield('creationdate',
1208: &Apache::lonmysql::unsqltime($metadatafields{'creationdate'}));
1209:
1210: $scrout.=&hiddenfield('lastrevisiondate',time);
1211:
1212:
1213: $scrout.=&textfield('Publisher/Owner','owner',
1214: $metadatafields{'owner'});
1215:
1216: # -------------------------------------------------- Correct copyright for rat.
1217: my $defaultoption=$metadatafields{'copyright'};
1218: unless ($defaultoption) { $defaultoption='default'; }
1219: unless ($style eq 'prv') {
1220: if ($style eq 'rat') {
1221: if ($metadatafields{'copyright'} eq 'public') {
1222: delete $metadatafields{'copyright'};
1223: $defaultoption='default';
1224: }
1225: $scrout.=&selectbox('Copyright/Distribution','copyright',
1226: $defaultoption,
1227: \&Apache::loncommon::copyrightdescription,
1228: (grep !/^public$/,(&Apache::loncommon::copyrightids)));
1229: } else {
1230: $scrout.=&selectbox('Copyright/Distribution','copyright',
1231: $defaultoption,
1232: \&Apache::loncommon::copyrightdescription,
1233: (&Apache::loncommon::copyrightids));
1234: }
1235:
1236: my $copyright_help =
1237: Apache::loncommon::help_open_topic('Publishing_Copyright');
1238: $scrout =~ s/DISTRIBUTION:/'DISTRIBUTION: ' . $copyright_help/ge;
1239: $scrout.=&textfield('Custom Distribution File','customdistributionfile',
1240: $metadatafields{'customdistributionfile'}).
1241: $copyright_help;
1242: my $uctitle=uc(&mt('Obsolete'));
1243: $scrout.=
1244: "\n<p><font color=\"#800000\" face=\"helvetica\"><b>$uctitle:".
1245: '</b></font> <input type="checkbox" name="obsolete" ';
1246: if ($metadatafields{'obsolete'}) {
1247: $scrout.=' checked="1" ';
1248: }
1249: $scrout.='/ ></p>'.
1250: &textfield('Suggested Replacement for Obsolete File',
1251: 'obsoletereplacement',
1252: $metadatafields{'obsoletereplacement'});
1253: } else {
1254: $scrout.=&hiddenfield('copyright','private');
1255: }
1256: return ($scrout.'<p><input type="submit" value="'.
1257: &mt('Finalize Publication').'" /></p></form>',0);
1258: # =============================================================================
1259: # BATCH MODE
1260: #
1261: } else {
1262: # Transfer metadata directly to environment for stage 2
1263: foreach (keys %metadatafields) {
1264: $ENV{'form.'.$_}=$metadatafields{$_};
1265: }
1266: $ENV{'form.addkey'}='';
1267: $ENV{'form.keywords'}='';
1268: foreach (keys %keywords) {
1269: if ($metadatafields{'keywords'}) {
1270: if ($metadatafields{'keywords'}=~/\Q$_\E/) {
1271: $ENV{'form.keywords'}.=$_.',';
1272: }
1273: } elsif (&Apache::loncommon::keyword($_)) {
1274: $ENV{'form.keywords'}.=$_.',';
1275: }
1276: }
1277: $ENV{'form.keywords'}=~s/\,$//;
1278: unless ($ENV{'form.creationdate'}) { $ENV{'form.creationdate'}=time; }
1279: $ENV{'form.lastrevisiondate'}=time;
1280: if ((($style eq 'rat') && ($ENV{'form.copyright'} eq 'public')) ||
1281: (!$ENV{'form.copyright'})) {
1282: $ENV{'form.copyright'}='default';
1283: }
1284: $ENV{'form.allmeta'}=&Apache::lonnet::escape($allmeta);
1285: return ($scrout,0);
1286: }
1287: }
1288:
1289: #########################################
1290: #########################################
1291:
1292: =pod
1293:
1294: =item B<phasetwo>
1295:
1296: Render second interface showing status of publication steps.
1297: This is publication step two.
1298:
1299: Parameters:
1300:
1301: =over 4
1302:
1303: =item I<$source>
1304:
1305: =item I<$target>
1306:
1307: =item I<$style>
1308:
1309: =item I<$distarget>
1310:
1311: =back
1312:
1313: Returns:
1314:
1315: =over 4
1316:
1317: =item Scalar string
1318:
1319: String contains status (errors and warnings) and information associated with
1320: the server's attempts at publication.
1321:
1322: =cut
1323:
1324: #'stupid emacs
1325: #########################################
1326: #########################################
1327: sub phasetwo {
1328:
1329: my ($r,$source,$target,$style,$distarget,$batch)=@_;
1330: $source=~s/\/+/\//g;
1331: $target=~s/\/+/\//g;
1332:
1333: if ($target=~/\_\_\_/) {
1334: $r->print(
1335: '<font color="red">'.&mt('Unsupported character combination').
1336: ' "<tt>___</tt>" '.&mt('in filename, FAIL').'</font>');
1337: return 0;
1338: }
1339: $distarget=~s/\/+/\//g;
1340: my $logfile;
1341: unless ($logfile=Apache::File->new('>>'.$source.'.log')) {
1342: $r->print(
1343: '<font color="red">'.
1344: &mt('No write permission to user directory, FAIL').'</font>');
1345: return 0;
1346: }
1347: print $logfile
1348: "\n================= Publish ".localtime()." Phase Two ================\n".$ENV{'user.name'}.'@'.$ENV{'user.domain'}."\n";
1349:
1350: %metadatafields=();
1351: %metadatakeys=();
1352:
1353: &metaeval(&Apache::lonnet::unescape($ENV{'form.allmeta'}));
1354:
1355: $metadatafields{'title'}=$ENV{'form.title'};
1356: $metadatafields{'author'}=$ENV{'form.author'};
1357: $metadatafields{'subject'}=$ENV{'form.subject'};
1358: $metadatafields{'notes'}=$ENV{'form.notes'};
1359: $metadatafields{'abstract'}=$ENV{'form.abstract'};
1360: $metadatafields{'mime'}=$ENV{'form.mime'};
1361: $metadatafields{'language'}=$ENV{'form.language'};
1362: $metadatafields{'creationdate'}=$ENV{'form.creationdate'};
1363: $metadatafields{'lastrevisiondate'}=$ENV{'form.lastrevisiondate'};
1364: $metadatafields{'owner'}=$ENV{'form.owner'};
1365: $metadatafields{'copyright'}=$ENV{'form.copyright'};
1366: $metadatafields{'standards'}=$ENV{'form.standards'};
1367: $metadatafields{'lowestgradelevel'}=$ENV{'form.lowestgradelevel'};
1368: $metadatafields{'highestgradelevel'}=$ENV{'form.highestgradelevel'};
1369: $metadatafields{'customdistributionfile'}=
1370: $ENV{'form.customdistributionfile'};
1371: $metadatafields{'obsolete'}=$ENV{'form.obsolete'};
1372: $metadatafields{'obsoletereplacement'}=
1373: $ENV{'form.obsoletereplacement'};
1374: $metadatafields{'dependencies'}=$ENV{'form.dependencies'};
1375: $metadatafields{'modifyinguser'}=$ENV{'user.name'}.'@'.
1376: $ENV{'user.domain'};
1377: $metadatafields{'authorspace'}=$cuname.'@'.$cudom;
1378:
1379: my $allkeywords=$ENV{'form.addkey'};
1380: if (exists($ENV{'form.keywords'})) {
1381: if (ref($ENV{'form.keywords'})) {
1382: $allkeywords .= ','.join(',',@{$ENV{'form.keywords'}});
1383: } else {
1384: $allkeywords .= ','.$ENV{'form.keywords'};
1385: }
1386: }
1387: $allkeywords=~s/\W+/\,/;
1388: $allkeywords=~s/^\,//;
1389: $metadatafields{'keywords'}=$allkeywords;
1390:
1391: # check if custom distribution file is specified
1392: if ($metadatafields{'copyright'} eq 'custom') {
1393: my $file=$metadatafields{'customdistributionfile'};
1394: unless ($file=~/\.rights$/) {
1395: return
1396: '<font color="red">'.&mt('No valid custom distribution rights file specified, FAIL').
1397: '</font>';
1398: }
1399: }
1400: {
1401: print $logfile "\nWrite metadata file for ".$source;
1402: my $mfh;
1403: unless ($mfh=Apache::File->new('>'.$source.'.meta')) {
1404: return
1405: '<font color="red">'.&mt('Could not write metadata, FAIL').
1406: '</font>';
1407: }
1408: foreach (sort keys %metadatafields) {
1409: unless ($_=~/\./) {
1410: my $unikey=$_;
1411: $unikey=~/^([A-Za-z]+)/;
1412: my $tag=$1;
1413: $tag=~tr/A-Z/a-z/;
1414: print $mfh "\n\<$tag";
1415: foreach (split(/\,/,$metadatakeys{$unikey})) {
1416: my $value=$metadatafields{$unikey.'.'.$_};
1417: $value=~s/\"/\'\'/g;
1418: print $mfh ' '.$_.'="'.$value.'"';
1419: }
1420: print $mfh '>'.
1421: &HTML::Entities::encode($metadatafields{$unikey})
1422: .'</'.$tag.'>';
1423: }
1424: }
1425: $r->print('<p>'.&mt('Wrote Metadata').'</p>');
1426: print $logfile "\nWrote metadata";
1427: }
1428:
1429: # -------------------------------- Synchronize entry with SQL metadata database
1430:
1431: $metadatafields{'url'} = $distarget;
1432: $metadatafields{'version'} = 'current';
1433:
1434: my ($error,$success) = &store_metadata(%metadatafields);
1435: if ($success) {
1436: $r->print('<p>'.&mt('Synchronized SQL metadata database').'</p>');
1437: print $logfile "\nSynchronized SQL metadata database";
1438: } else {
1439: $r->print($error);
1440: print $logfile "\n".$error;
1441: }
1442:
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>Directory <tt>'.$thisdisfn.'</tt></h1>'.
1656: '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 />Skipping '.$filename.'<br />');
1695: }
1696: $r->rflush();
1697: }
1698: }
1699: closedir(DIR);
1700: }
1701: #########################################
1702:
1703: =pod
1704:
1705: =item B<handler>
1706:
1707: A basic outline of the handler subroutine follows.
1708:
1709: =over 4
1710:
1711: =item *
1712:
1713: Get query string for limited number of parameters.
1714:
1715: =item *
1716:
1717: Check filename.
1718:
1719: =item *
1720:
1721: File is there and owned, init lookup tables.
1722:
1723: =item *
1724:
1725: Start page output.
1726:
1727: =item *
1728:
1729: Evaluate individual file, and then output information.
1730:
1731: =item *
1732:
1733: Publishing from $thisfn to $thistarget with $thisembstyle.
1734:
1735: =back
1736:
1737: =cut
1738:
1739: #########################################
1740: #########################################
1741: sub handler {
1742: my $r=shift;
1743:
1744: if ($r->header_only) {
1745: &Apache::loncommon::content_type($r,'text/html');
1746: $r->send_http_header;
1747: return OK;
1748: }
1749:
1750: # Get query string for limited number of parameters
1751:
1752: &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},
1753: ['filename']);
1754:
1755: # -------------------------------------------------------------- Check filename
1756:
1757: my $fn=&Apache::lonnet::unescape($ENV{'form.filename'});
1758:
1759:
1760: unless ($fn) {
1761: $r->log_reason($cuname.' at '.$cudom.
1762: ' trying to publish empty filename', $r->filename);
1763: return HTTP_NOT_FOUND;
1764: }
1765:
1766: ($cuname,$cudom)=
1767: &Apache::loncacc::constructaccess($fn,$r->dir_config('lonDefDomain'));
1768: unless (($cuname) && ($cudom)) {
1769: $r->log_reason($cuname.' at '.$cudom.
1770: ' trying to publish file '.$ENV{'form.filename'}.
1771: ' ('.$fn.') - not authorized',
1772: $r->filename);
1773: return HTTP_NOT_ACCEPTABLE;
1774: }
1775:
1776: unless (&Apache::lonnet::homeserver($cuname,$cudom)
1777: eq $r->dir_config('lonHostID')) {
1778: $r->log_reason($cuname.' at '.$cudom.
1779: ' trying to publish file '.$ENV{'form.filename'}.
1780: ' ('.$fn.') - not homeserver ('.
1781: &Apache::lonnet::homeserver($cuname,$cudom).')',
1782: $r->filename);
1783: return HTTP_NOT_ACCEPTABLE;
1784: }
1785:
1786: $fn=~s/^http\:\/\/[^\/]+//;
1787: $fn=~s/^\/\~(\w+)/\/home\/$1\/public_html/;
1788:
1789: my $targetdir='';
1790: $docroot=$r->dir_config('lonDocRoot');
1791: if ($1 ne $cuname) {
1792: $r->log_reason($cuname.' at '.$cudom.
1793: ' trying to publish unowned file '.
1794: $ENV{'form.filename'}.' ('.$fn.')',
1795: $r->filename);
1796: return HTTP_NOT_ACCEPTABLE;
1797: } else {
1798: $targetdir=$docroot.'/res/'.$cudom;
1799: }
1800:
1801:
1802: unless (-e $fn) {
1803: $r->log_reason($cuname.' at '.$cudom.
1804: ' trying to publish non-existing file '.
1805: $ENV{'form.filename'}.' ('.$fn.')',
1806: $r->filename);
1807: return HTTP_NOT_FOUND;
1808: }
1809:
1810: unless ($ENV{'form.phase'} eq 'two') {
1811:
1812: # -------------------------------- File is there and owned, init lookup tables.
1813:
1814: %addid=();
1815:
1816: {
1817: my $fh=Apache::File->new($r->dir_config('lonTabDir').'/addid.tab');
1818: while (<$fh>=~/(\w+)\s+(\w+)/) {
1819: $addid{$1}=$2;
1820: }
1821: }
1822:
1823: %nokey=();
1824:
1825: {
1826: my $fh=Apache::File->new($r->dir_config('lonIncludes').'/un_keyword.tab');
1827: while (<$fh>) {
1828: my $word=$_;
1829: chomp($word);
1830: $nokey{$word}=1;
1831: }
1832: }
1833:
1834: }
1835:
1836: # ---------------------------------------------------------- Start page output.
1837:
1838: &Apache::loncommon::content_type($r,'text/html');
1839: $r->send_http_header;
1840:
1841: $r->print('<html><head><title>LON-CAPA Publishing</title></head>');
1842: $r->print(&Apache::loncommon::bodytag('Resource Publication'));
1843:
1844:
1845: my $thisfn=$fn;
1846:
1847: my $thistarget=$thisfn;
1848:
1849: $thistarget=~s/^\/home/$targetdir/;
1850: $thistarget=~s/\/public\_html//;
1851:
1852: my $thisdistarget=$thistarget;
1853: $thisdistarget=~s/^\Q$docroot\E//;
1854:
1855: my $thisdisfn=$thisfn;
1856: $thisdisfn=~s/^\/home\/\Q$cuname\E\/public_html\///;
1857:
1858: if ($fn=~/\/$/) {
1859: # -------------------------------------------------------- This is a directory
1860: &publishdirectory($r,$fn,$thisdisfn);
1861: $r->print('<hr><font size="+2">'.&mt('Done').'</font><br><a href="/priv/'
1862: .$cuname.'/'.$thisdisfn
1863: .'">'.&mt('Return to Directory').'</a>');
1864:
1865:
1866: } else {
1867: # ---------------------- Evaluate individual file, and then output information.
1868: $thisfn=~/\.(\w+)$/;
1869: my $thistype=$1;
1870: my $thisembstyle=&Apache::loncommon::fileembstyle($thistype);
1871: $r->print('<h2>'.&mt('Publishing').' '.
1872: &Apache::loncommon::filedescription($thistype).' <tt>');
1873:
1874: $r->print(<<ENDCAPTION);
1875: <a href='javascript:void(window.open("/~$cuname/$thisdisfn","cat","height=300,width=500,scrollbars=1,resizable=1,menubar=0,location=1"))'>
1876: $thisdisfn</a>
1877: ENDCAPTION
1878: $r->print('</tt></h2><b>'.&mt('Target').':</b> <tt>'.
1879: $thisdistarget.'</tt><br />');
1880:
1881: if (($cuname ne $ENV{'user.name'})||($cudom ne $ENV{'user.domain'})) {
1882: $r->print('<h3><font color="red">'.&mt('Co-Author').': '.
1883: $cuname.&mt(' at ').$cudom.'</font></h3>');
1884: }
1885:
1886: if (&Apache::loncommon::fileembstyle($thistype) eq 'ssi') {
1887: $r->print(<<ENDDIFF);
1888: <br />
1889: <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"))'>
1890: ENDDIFF
1891: $r->print(&mt('Diffs with Current Version').'</a><br />');
1892: }
1893:
1894: # ------------------ Publishing from $thisfn to $thistarget with $thisembstyle.
1895:
1896: unless ($ENV{'form.phase'} eq 'two') {
1897: my ($outstring,$error)=&publish($thisfn,$thistarget,$thisembstyle);
1898: $r->print('<hr />'.$outstring);
1899: } else {
1900: $r->print('<hr />'.
1901: &phasetwo($r,$thisfn,$thistarget,$thisembstyle,$thisdistarget));
1902: }
1903: }
1904: $r->print('</body></html>');
1905:
1906: return OK;
1907: }
1908:
1909: 1;
1910: __END__
1911:
1912: =pod
1913:
1914: =back
1915:
1916: =back
1917:
1918: =cut
1919:
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