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