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