1: # The LearningOnline Network with CAPA
2: # Publication Handler
3: #
4: # $Id: lonpublisher.pm,v 1.83 2002/06/24 14:25:38 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: # (TeX Content Handler
30: #
31: # 05/29/00,05/30,10/11 Gerd Kortemeyer)
32: #
33: # 11/28,11/29,11/30,12/01,12/02,12/04,12/23 Gerd Kortemeyer
34: # 03/23 Guy Albertelli
35: # 03/24,03/29,04/03 Gerd Kortemeyer
36: # 04/16/2001 Scott Harrison
37: # 05/03,05/05,05/07 Gerd Kortemeyer
38: # 05/28/2001 Scott Harrison
39: # 06/23,08/07,08/11,8/13,8/17,8/18,8/24,9/26,10/16 Gerd Kortemeyer
40: # 12/04,12/05 Guy Albertelli
41: # 12/05 Gerd Kortemeyer
42: # 12/05 Guy Albertelli
43: # 12/06,12/07 Gerd Kortemeyer
44: # 12/15,12/16 Scott Harrison
45: # 12/25 Gerd Kortemeyer
46: # YEAR=2002
47: # 1/16,1/17 Scott Harrison
48: # 1/17 Gerd Kortemeyer
49: #
50: ###
51:
52: ###############################################################################
53: ## ##
54: ## ORGANIZATION OF THIS PERL MODULE ##
55: ## ##
56: ## 1. Modules used by this module ##
57: ## 2. Various subroutines ##
58: ## 3. Publication Step One ##
59: ## 4. Phase Two ##
60: ## 5. Main Handler ##
61: ## ##
62: ###############################################################################
63:
64: package Apache::lonpublisher;
65:
66: # ------------------------------------------------- modules used by this module
67: use strict;
68: use Apache::File;
69: use File::Copy;
70: use Apache::Constants qw(:common :http :methods);
71: use HTML::LCParser;
72: use Apache::lonxml;
73: use Apache::lonhomework;
74: use Apache::loncacc;
75: use DBI;
76: use Apache::lonnet();
77: use Apache::loncommon();
78:
79: my %addid;
80: my %nokey;
81:
82: my %metadatafields;
83: my %metadatakeys;
84:
85: my $docroot;
86:
87: my $cuname;
88: my $cudom;
89:
90: # ----------------------------------------------- Evaluate string with metadata
91: sub metaeval {
92: my $metastring=shift;
93:
94: my $parser=HTML::LCParser->new(\$metastring);
95: my $token;
96: while ($token=$parser->get_token) {
97: if ($token->[0] eq 'S') {
98: my $entry=$token->[1];
99: my $unikey=$entry;
100: if (defined($token->[2]->{'package'})) {
101: $unikey.='_package_'.$token->[2]->{'package'};
102: }
103: if (defined($token->[2]->{'part'})) {
104: $unikey.='_'.$token->[2]->{'part'};
105: }
106: if (defined($token->[2]->{'id'})) {
107: $unikey.='_'.$token->[2]->{'id'};
108: }
109: if (defined($token->[2]->{'name'})) {
110: $unikey.='_'.$token->[2]->{'name'};
111: }
112: foreach (@{$token->[3]}) {
113: $metadatafields{$unikey.'.'.$_}=$token->[2]->{$_};
114: if ($metadatakeys{$unikey}) {
115: $metadatakeys{$unikey}.=','.$_;
116: } else {
117: $metadatakeys{$unikey}=$_;
118: }
119: }
120: if ($metadatafields{$unikey}) {
121: my $newentry=$parser->get_text('/'.$entry);
122: unless (($metadatafields{$unikey}=~/$newentry/) ||
123: ($newentry eq '')) {
124: $metadatafields{$unikey}.=', '.$newentry;
125: }
126: } else {
127: $metadatafields{$unikey}=$parser->get_text('/'.$entry);
128: }
129: }
130: }
131: }
132:
133: # -------------------------------------------------------- Read a metadata file
134: sub metaread {
135: my ($logfile,$fn)=@_;
136: unless (-e $fn) {
137: print $logfile 'No file '.$fn."\n";
138: return '<br><b>No file:</b> <tt>'.$fn.'</tt>';
139: }
140: print $logfile 'Processing '.$fn."\n";
141: my $metastring;
142: {
143: my $metafh=Apache::File->new($fn);
144: $metastring=join('',<$metafh>);
145: }
146: &metaeval($metastring);
147: return '<br><b>Processed file:</b> <tt>'.$fn.'</tt>';
148: }
149:
150: # ---------------------------- convert 'time' format into a datetime sql format
151: sub sqltime {
152: my $timef=shift @_;
153: my ($sec,$min,$hour,$mday,$mon,$year,$wday,$yday,$isdst) =
154: localtime($timef);
155: $mon++; $year+=1900;
156: return "$year-$mon-$mday $hour:$min:$sec";
157: }
158:
159: # --------------------------------------------------------- Various form fields
160:
161: sub textfield {
162: my ($title,$name,$value)=@_;
163: return "\n<p><b>$title:</b><br>".
164: '<input type=text name="'.$name.'" size=80 value="'.$value.'">';
165: }
166:
167: sub hiddenfield {
168: my ($name,$value)=@_;
169: return "\n".'<input type=hidden name="'.$name.'" value="'.$value.'">';
170: }
171:
172: sub selectbox {
173: my ($title,$name,$value,$functionref,@idlist)=@_;
174: my $uctitle=uc($title);
175: my $selout="\n<p><font color=\"#800000\" face=\"helvetica\"><b>$uctitle:".
176: "</b></font><br />".'<select name="'.$name.'">';
177: foreach (@idlist) {
178: $selout.='<option value=\''.$_.'\'';
179: if ($_ eq $value) {
180: $selout.=' selected>'.&{$functionref}($_).'</option>';
181: }
182: else {$selout.='>'.&{$functionref}($_).'</option>';}
183: }
184: return $selout.'</select>';
185: }
186:
187: # -------------------------------------------------------- Publication Step One
188:
189: sub urlfixup {
190: my ($url,$target)=@_;
191: unless ($url) { return ''; }
192: #javascript code needs no fixing
193: if ($url =~ /^javascript:/i) { return $url; }
194: if ($url =~ /^mailto:/i) { return $url; }
195: #internal document links need no fixing
196: if ($url =~ /^\#/) { return $url; }
197: my ($host)=($url=~/(?:http\:\/\/)*([^\/]+)/);
198: foreach (values %Apache::lonnet::hostname) {
199: if ($_ eq $host) {
200: $url=~s/^http\:\/\///;
201: $url=~s/^$host//;
202: }
203: }
204: if ($url=~/^http\:\/\//) { return $url; }
205: $url=~s/\~$cuname/res\/$cudom\/$cuname/;
206: return $url;
207: }
208:
209:
210: sub absoluteurl {
211: my ($url,$target)=@_;
212: unless ($url) { return ''; }
213: if ($target) {
214: $target=~s/\/[^\/]+$//;
215: $url=&Apache::lonnet::hreflocation($target,$url);
216: }
217: return $url;
218: }
219:
220: sub set_allow {
221: my ($allow,$logfile,$target,$tag,$oldurl)=@_;
222: my $newurl=&urlfixup($oldurl,$target);
223: my $return_url=$oldurl;
224: print $logfile 'GUYURL: '.$tag.':'.$oldurl.' - '.$newurl."\n";
225: if ($newurl ne $oldurl) {
226: $return_url=$newurl;
227: print $logfile 'URL: '.$tag.':'.$oldurl.' - '.$newurl."\n";
228: }
229: if (($newurl !~ /^javascript:/i) &&
230: ($newurl !~ /^mailto:/i) &&
231: ($newurl !~ /^http:/i) &&
232: ($newurl !~ /^\#/)) {
233: $$allow{&absoluteurl($newurl,$target)}=1;
234: }
235: return $return_url
236: }
237:
238: sub publish {
239:
240: my ($source,$target,$style)=@_;
241: my $logfile;
242: my $scrout='';
243: my $allmeta='';
244: my $content='';
245: my %allow=();
246: undef %allow;
247:
248: unless ($logfile=Apache::File->new('>>'.$source.'.log')) {
249: return
250: '<font color=red>No write permission to user directory, FAIL</font>';
251: }
252: print $logfile
253: "\n\n================= Publish ".localtime()." Phase One ================\n";
254:
255: if (($style eq 'ssi') || ($style eq 'rat')) {
256: # ------------------------------------------------------- This needs processing
257:
258: # ----------------------------------------------------------------- Backup Copy
259: my $copyfile=$source.'.save';
260: if (copy($source,$copyfile)) {
261: print $logfile "Copied original file to ".$copyfile."\n";
262: } else {
263: print $logfile "Unable to write backup ".$copyfile.':'.$!."\n";
264: return "<font color=red>Failed to write backup copy, $!,FAIL</font>";
265: }
266: # ------------------------------------------------------------- IDs and indices
267:
268: my $maxindex=10;
269: my $maxid=10;
270:
271: my $needsfixup=0;
272:
273: {
274: my $org=Apache::File->new($source);
275: $content=join('',<$org>);
276: }
277: {
278: my $parser=HTML::LCParser->new(\$content);
279: my $token;
280: while ($token=$parser->get_token) {
281: if ($token->[0] eq 'S') {
282: my $counter;
283: if ($counter=$addid{$token->[1]}) {
284: if ($counter eq 'id') {
285: if (defined($token->[2]->{'id'})) {
286: $maxid=
287: ($token->[2]->{'id'}>$maxid)?$token->[2]->{'id'}:$maxid;
288: } else {
289: $needsfixup=1;
290: }
291: } else {
292: if (defined($token->[2]->{'index'})) {
293: $maxindex=
294: ($token->[2]->{'index'}>$maxindex)?$token->[2]->{'index'}:$maxindex;
295: } else {
296: $needsfixup=1;
297: }
298: }
299: }
300: }
301: }
302: }
303: if ($needsfixup) {
304: print $logfile "Needs ID and/or index fixup\n".
305: "Max ID : $maxid (min 10)\n".
306: "Max Index: $maxindex (min 10)\n";
307: }
308: my $outstring='';
309: my $parser=HTML::LCParser->new(\$content);
310: $parser->xml_mode(1);
311: my $token;
312: while ($token=$parser->get_token) {
313: if ($token->[0] eq 'S') {
314: my $counter;
315: my $tag=$token->[1];
316: my $lctag=lc($tag);
317: unless ($lctag eq 'allow') {
318: my %parms=%{$token->[2]};
319: $counter=$addid{$tag};
320: if (!$counter) { $counter=$addid{$lctag}; }
321: if ($counter) {
322: if ($counter eq 'id') {
323: unless (defined($parms{'id'})) {
324: $maxid++;
325: $parms{'id'}=$maxid;
326: print $logfile 'ID: '.$tag.':'.$maxid."\n";
327: }
328: } elsif ($counter eq 'index') {
329: unless (defined($parms{'index'})) {
330: $maxindex++;
331: $parms{'index'}=$maxindex;
332: print $logfile 'Index: '.$tag.':'.$maxindex."\n";
333: }
334: }
335: }
336:
337: foreach my $type ('src','href','background','bgimg') {
338: foreach my $key (keys(%parms)) {
339: print $logfile "for $type, and $key\n";
340: if ($key =~ /^$type$/i) {
341: print $logfile "calling set_allow\n";
342: $parms{$key}=&set_allow(\%allow,$logfile,
343: $target,$tag,
344: $parms{$key});
345: }
346: }
347: }
348: # probably a <randomlabel> image type <label>
349: if ($lctag eq 'label' && defined($parms{'description'})) {
350: my $next_token=$parser->get_token();
351: if ($next_token->[0] eq 'T') {
352: $next_token->[1]=&set_allow(\%allow,$logfile,
353: $target,$tag,
354: $next_token->[1]);
355: }
356: $parser->unget_token($next_token);
357: }
358: if ($lctag eq 'applet') {
359: my $codebase='';
360: if (defined($parms{'codebase'})) {
361: my $oldcodebase=$parms{'codebase'};
362: unless ($oldcodebase=~/\/$/) {
363: $oldcodebase.='/';
364: }
365: $codebase=&urlfixup($oldcodebase,$target);
366: $codebase=~s/\/$//;
367: if ($codebase ne $oldcodebase) {
368: $parms{'codebase'}=$codebase;
369: print $logfile 'URL codebase: '.$tag.':'.
370: $oldcodebase.' - '.
371: $codebase."\n";
372: }
373: $allow{&absoluteurl($codebase,$target).'/*'}=1;
374: } else {
375: foreach ('archive','code','object') {
376: if (defined($parms{$_})) {
377: my $oldurl=$parms{$_};
378: my $newurl=&urlfixup($oldurl,$target);
379: $newurl=~s/\/[^\/]+$/\/\*/;
380: print $logfile 'Allow: applet '.$_.':'.
381: $oldurl.' allows '.
382: $newurl."\n";
383: $allow{&absoluteurl($newurl,$target)}=1;
384: }
385: }
386: }
387: }
388:
389: my $newparmstring='';
390: my $endtag='';
391: foreach (keys %parms) {
392: if ($_ eq '/') {
393: $endtag=' /';
394: } else {
395: my $quote=($parms{$_}=~/\"/?"'":'"');
396: $newparmstring.=' '.$_.'='.$quote.$parms{$_}.$quote;
397: }
398: }
399: if (!$endtag) { if ($token->[4]=~m:/>$:) { $endtag=' /'; }; }
400: $outstring.='<'.$tag.$newparmstring.$endtag.'>';
401: } else {
402: $allow{$token->[2]->{'src'}}=1;
403: }
404: } elsif ($token->[0] eq 'E') {
405: if ($token->[2]) {
406: unless ($token->[1] eq 'allow') {
407: $outstring.='</'.$token->[1].'>';
408: }
409: }
410: } else {
411: $outstring.=$token->[1];
412: }
413: }
414: # ------------------------------------------------------------ Construct Allows
415:
416: $scrout.='<h3>Dependencies</h3>';
417: my $allowstr='';
418: foreach (sort(keys(%allow))) {
419: my $thisdep=$_;
420: if ($thisdep !~ /[^\s]/) { next; }
421: unless ($style eq 'rat') {
422: $allowstr.="\n".'<allow src="'.$thisdep.'" />';
423: }
424: $scrout.='<br>';
425: unless ($thisdep=~/\*/) {
426: $scrout.='<a href="'.$thisdep.'">';
427: }
428: $scrout.='<tt>'.$thisdep.'</tt>';
429: unless ($thisdep=~/\*/) {
430: $scrout.='</a>';
431: if (
432: &Apache::lonnet::getfile($Apache::lonnet::perlvar{'lonDocRoot'}.'/'.
433: $thisdep.'.meta') eq '-1') {
434: $scrout.=
435: ' - <font color=red>Currently not available</font>';
436: } else {
437: my %temphash=(&Apache::lonnet::declutter($target).'___'.
438: &Apache::lonnet::declutter($thisdep).'___usage'
439: => time);
440: $thisdep=~/^\/res\/(\w+)\/(\w+)\//;
441: if ((defined($1)) && (defined($2))) {
442: &Apache::lonnet::put('resevaldata',\%temphash,$1,$2);
443: }
444: }
445: }
446: }
447: $outstring=~s/\n*(\<\/[^\>]+\>)\s*$/$allowstr\n$1\n/s;
448:
449: #Encode any High ASCII characters
450: $outstring=&HTML::Entities::encode($outstring,"\200-\377");
451: # ------------------------------------------------------------- Write modified
452:
453: {
454: my $org;
455: unless ($org=Apache::File->new('>'.$source)) {
456: print $logfile "No write permit to $source\n";
457: return
458: "<font color=red>No write permission to $source, FAIL</font>";
459: }
460: print $org $outstring;
461: }
462: $content=$outstring;
463:
464: if ($needsfixup) {
465: print $logfile "End of ID and/or index fixup\n".
466: "Max ID : $maxid (min 10)\n".
467: "Max Index: $maxindex (min 10)\n";
468: } else {
469: print $logfile "Does not need ID and/or index fixup\n";
470: }
471: }
472: # --------------------------------------------- Initial step done, now metadata
473:
474: # ---------------------------------------- Storage for metadata keys and fields
475:
476: %metadatafields=();
477: %metadatakeys=();
478:
479: my %oldparmstores=();
480:
481: $scrout.='<h3>Metadata Information</h3>';
482:
483: # ------------------------------------------------ First, check out environment
484: unless (-e $source.'.meta') {
485: $metadatafields{'author'}=$ENV{'environment.firstname'}.' '.
486: $ENV{'environment.middlename'}.' '.
487: $ENV{'environment.lastname'}.' '.
488: $ENV{'environment.generation'};
489: $metadatafields{'author'}=~s/\s+/ /g;
490: $metadatafields{'author'}=~s/\s+$//;
491: $metadatafields{'owner'}=$cuname.'@'.$cudom;
492:
493: # ------------------------------------------------ Check out directory hierachy
494:
495: my $thisdisfn=$source;
496: $thisdisfn=~s/^\/home\/$cuname\///;
497:
498: my @urlparts=split(/\//,$thisdisfn);
499: $#urlparts--;
500:
501: my $currentpath='/home/'.$cuname.'/';
502:
503: foreach (@urlparts) {
504: $currentpath.=$_.'/';
505: $scrout.=&metaread($logfile,$currentpath.'default.meta');
506: }
507:
508: # ------------------- Clear out parameters and stores (there should not be any)
509:
510: foreach (keys %metadatafields) {
511: if (($_=~/^parameter/) || ($_=~/^stores/)) {
512: delete $metadatafields{$_};
513: }
514: }
515:
516: } else {
517: # ---------------------- Read previous metafile, remember parameters and stores
518:
519: $scrout.=&metaread($logfile,$source.'.meta');
520:
521: foreach (keys %metadatafields) {
522: if (($_=~/^parameter/) || ($_=~/^stores/)) {
523: $oldparmstores{$_}=1;
524: delete $metadatafields{$_};
525: }
526: }
527:
528: }
529:
530: # -------------------------------------------------- Parse content for metadata
531: if ($style eq 'ssi') {
532: my $oldenv=$ENV{'request.uri'};
533:
534: $ENV{'request.uri'}=$target;
535: $allmeta=Apache::lonxml::xmlparse(undef,'meta',$content);
536: $ENV{'request.uri'}=$oldenv;
537:
538: &metaeval($allmeta);
539: }
540: # ---------------- Find and document discrepancies in the parameters and stores
541:
542: my $chparms='';
543: foreach (sort keys %metadatafields) {
544: if (($_=~/^parameter/) || ($_=~/^stores/)) {
545: unless ($_=~/\.\w+$/) {
546: unless ($oldparmstores{$_}) {
547: print $logfile 'New: '.$_."\n";
548: $chparms.=$_.' ';
549: }
550: }
551: }
552: }
553: if ($chparms) {
554: $scrout.='<p><b>New parameters or stored values:</b> '.
555: $chparms;
556: }
557:
558: $chparms='';
559: foreach (sort keys %oldparmstores) {
560: if (($_=~/^parameter/) || ($_=~/^stores/)) {
561: unless (($metadatafields{$_.'.name'}) ||
562: ($metadatafields{$_.'.package'}) || ($_=~/\.\w+$/)) {
563: print $logfile 'Obsolete: '.$_."\n";
564: $chparms.=$_.' ';
565: }
566: }
567: }
568: if ($chparms) {
569: $scrout.='<p><b>Obsolete parameters or stored values:</b> '.
570: $chparms;
571: }
572:
573: # ------------------------------------------------------- Now have all metadata
574:
575: $scrout.=
576: '<form name="pubform" action="/adm/publish" method="post">'.
577: '<p><input type="submit" value="Finalize Publication" /></p>'.
578: &hiddenfield('phase','two').
579: &hiddenfield('filename',$ENV{'form.filename'}).
580: &hiddenfield('allmeta',&Apache::lonnet::escape($allmeta)).
581: &hiddenfield('dependencies',join(',',keys %allow)).
582: &textfield('Title','title',$metadatafields{'title'}).
583: &textfield('Author(s)','author',$metadatafields{'author'}).
584: &textfield('Subject','subject',$metadatafields{'subject'});
585:
586: # --------------------------------------------------- Scan content for keywords
587:
588: my $keywordout=<<"END";
589: <script>
590: function checkAll(field)
591: {
592: for (i = 0; i < field.length; i++)
593: field[i].checked = true ;
594: }
595:
596: function uncheckAll(field)
597: {
598: for (i = 0; i < field.length; i++)
599: field[i].checked = false ;
600: }
601: </script>
602: <p><b>Keywords:</b>
603: <input type="button" value="check all" onclick="javascript:checkAll(document.pubform.keywords)">
604: <input type="button" value="uncheck all" onclick="javascript:uncheckAll(document.pubform.keywords)">
605: <br />
606: END
607: $keywordout.='<table border=2><tr>';
608: my $colcount=0;
609: my %keywords=();
610:
611: if (length($content)<500000) {
612: my $textonly=$content;
613: $textonly=~s/\<script[^\<]+\<\/script\>//g;
614: $textonly=~s/\<m\>[^\<]+\<\/m\>//g;
615: $textonly=~s/\<[^\>]*\>//g;
616: $textonly=~tr/A-Z/a-z/;
617: $textonly=~s/[\$\&][a-z]\w*//g;
618: $textonly=~s/[^a-z\s]//g;
619:
620: foreach ($textonly=~m/(\w+)/g) {
621: unless ($nokey{$_}) {
622: $keywords{$_}=1;
623: }
624: }
625: }
626:
627:
628: foreach (split(/\W+/,$metadatafields{'keywords'})) {
629: $keywords{$_}=1;
630: }
631:
632: foreach (sort keys %keywords) {
633: $keywordout.='<td><input type=checkbox name="keywords" value="'.$_.'"';
634: if ($metadatafields{'keywords'}) {
635: if ($metadatafields{'keywords'}=~/$_/) {
636: $keywordout.=' checked';
637: }
638: } elsif (&Apache::loncommon::keyword($_)) {
639: $keywordout.=' checked';
640: }
641: $keywordout.='>'.$_.'</td>';
642: if ($colcount>10) {
643: $keywordout.="</tr><tr>\n";
644: $colcount=0;
645: }
646: $colcount++;
647: }
648:
649: $keywordout.='</tr></table>';
650:
651: $scrout.=$keywordout;
652:
653: $scrout.=&textfield('Additional Keywords','addkey','');
654:
655: $scrout.=&textfield('Notes','notes',$metadatafields{'notes'});
656:
657: $scrout.=
658: '<p><b>Abstract:</b><br><textarea cols=80 rows=5 name=abstract>'.
659: $metadatafields{'abstract'}.'</textarea>';
660:
661: $source=~/\.(\w+)$/;
662:
663: $scrout.=&hiddenfield('mime',$1);
664:
665: $scrout.=&selectbox('Language','language',
666: $metadatafields{'language'},
667: \&Apache::loncommon::languagedescription,
668: (&Apache::loncommon::languageids),
669: );
670:
671: unless ($metadatafields{'creationdate'}) {
672: $metadatafields{'creationdate'}=time;
673: }
674: $scrout.=&hiddenfield('creationdate',$metadatafields{'creationdate'});
675:
676: $scrout.=&hiddenfield('lastrevisiondate',time);
677:
678:
679: $scrout.=&textfield('Publisher/Owner','owner',
680: $metadatafields{'owner'});
681: # --------------------------------------------------- Correct copyright for rat
682: if ($style eq 'rat') {
683: if ($metadatafields{'copyright'} eq 'public') {
684: delete $metadatafields{'copyright'};
685: }
686: $scrout.=&selectbox('Copyright/Distribution','copyright',
687: $metadatafields{'copyright'},
688: \&Apache::loncommon::copyrightdescription,
689: (grep !/^public$/,(&Apache::loncommon::copyrightids)));
690: }
691: else {
692: $scrout.=&selectbox('Copyright/Distribution','copyright',
693: $metadatafields{'copyright'},
694: \&Apache::loncommon::copyrightdescription,
695: (&Apache::loncommon::copyrightids));
696: }
697: return $scrout.
698: '<p><input type="submit" value="Finalize Publication" /></p></form>';
699: }
700:
701: # -------------------------------------------------------- Publication Step Two
702:
703: sub phasetwo {
704:
705: my ($source,$target,$style,$distarget)=@_;
706: my $logfile;
707: my $scrout='';
708: unless ($logfile=Apache::File->new('>>'.$source.'.log')) {
709: return
710: '<font color=red>No write permission to user directory, FAIL</font>';
711: }
712: print $logfile
713: "\n================= Publish ".localtime()." Phase Two ================\n";
714:
715: %metadatafields=();
716: %metadatakeys=();
717:
718: &metaeval(&Apache::lonnet::unescape($ENV{'form.allmeta'}));
719:
720: $metadatafields{'title'}=$ENV{'form.title'};
721: $metadatafields{'author'}=$ENV{'form.author'};
722: $metadatafields{'subject'}=$ENV{'form.subject'};
723: $metadatafields{'notes'}=$ENV{'form.notes'};
724: $metadatafields{'abstract'}=$ENV{'form.abstract'};
725: $metadatafields{'mime'}=$ENV{'form.mime'};
726: $metadatafields{'language'}=$ENV{'form.language'};
727: $metadatafields{'creationdate'}=$ENV{'form.creationdate'};
728: $metadatafields{'lastrevisiondate'}=$ENV{'form.lastrevisiondate'};
729: $metadatafields{'owner'}=$ENV{'form.owner'};
730: $metadatafields{'copyright'}=$ENV{'form.copyright'};
731: $metadatafields{'dependencies'}=$ENV{'form.dependencies'};
732:
733: my $allkeywords=$ENV{'form.addkey'};
734: if (exists($ENV{'form.keywords'}) && (ref($ENV{'form.keywords'}))) {
735: my @Keywords = @{$ENV{'form.keywords'}};
736: foreach (@Keywords) {
737: $allkeywords.=','.$_;
738: }
739: }
740: $allkeywords=~s/\W+/\,/;
741: $allkeywords=~s/^\,//;
742: $metadatafields{'keywords'}=$allkeywords;
743:
744: {
745: print $logfile "\nWrite metadata file for ".$source;
746: my $mfh;
747: unless ($mfh=Apache::File->new('>'.$source.'.meta')) {
748: return
749: '<font color=red>Could not write metadata, FAIL</font>';
750: }
751: foreach (sort keys %metadatafields) {
752: unless ($_=~/\./) {
753: my $unikey=$_;
754: $unikey=~/^([A-Za-z]+)/;
755: my $tag=$1;
756: $tag=~tr/A-Z/a-z/;
757: print $mfh "\n\<$tag";
758: foreach (split(/\,/,$metadatakeys{$unikey})) {
759: my $value=$metadatafields{$unikey.'.'.$_};
760: $value=~s/\"/\'\'/g;
761: print $mfh ' '.$_.'="'.$value.'"';
762: }
763: print $mfh '>'.
764: &HTML::Entities::encode($metadatafields{$unikey})
765: .'</'.$tag.'>';
766: }
767: }
768: $scrout.='<p>Wrote Metadata';
769: print $logfile "\nWrote metadata";
770: }
771:
772: # -------------------------------- Synchronize entry with SQL metadata database
773: my $warning;
774:
775: unless ($metadatafields{'copyright'} eq 'priv') {
776:
777: my $dbh;
778: {
779: unless (
780: $dbh = DBI->connect("DBI:mysql:loncapa","www",
781: $Apache::lonnet::perlvar{'lonSqlAccess'},{ RaiseError =>0,PrintError=>0})
782: ) {
783: $warning='<font color=red>WARNING: Cannot connect to '.
784: 'database!</font>';
785: }
786: else {
787: my %sqldatafields;
788: $sqldatafields{'url'}=$distarget;
789: my $sth=$dbh->prepare(
790: 'delete from metadata where url like binary'.
791: '"'.$sqldatafields{'url'}.'"');
792: $sth->execute();
793: foreach ('title','author','subject','keywords','notes','abstract',
794: 'mime','language','creationdate','lastrevisiondate','owner',
795: 'copyright') {
796: my $field=$metadatafields{$_}; $field=~s/\"/\'\'/g;
797: $sqldatafields{$_}=$field;
798: }
799:
800: $sth=$dbh->prepare('insert into metadata values ('.
801: '"'.delete($sqldatafields{'title'}).'"'.','.
802: '"'.delete($sqldatafields{'author'}).'"'.','.
803: '"'.delete($sqldatafields{'subject'}).'"'.','.
804: '"'.delete($sqldatafields{'url'}).'"'.','.
805: '"'.delete($sqldatafields{'keywords'}).'"'.','.
806: '"'.'current'.'"'.','.
807: '"'.delete($sqldatafields{'notes'}).'"'.','.
808: '"'.delete($sqldatafields{'abstract'}).'"'.','.
809: '"'.delete($sqldatafields{'mime'}).'"'.','.
810: '"'.delete($sqldatafields{'language'}).'"'.','.
811: '"'.
812: sqltime(delete($sqldatafields{'creationdate'}))
813: .'"'.','.
814: '"'.
815: sqltime(delete(
816: $sqldatafields{'lastrevisiondate'})).'"'.','.
817: '"'.delete($sqldatafields{'owner'}).'"'.','.
818: '"'.delete(
819: $sqldatafields{'copyright'}).'"'.')');
820: $sth->execute();
821: $dbh->disconnect;
822: $scrout.='<p>Synchronized SQL metadata database';
823: print $logfile "\nSynchronized SQL metadata database";
824: }
825: }
826:
827: } else {
828: $scrout.='<p>Private Publication - did not synchronize database';
829: print $logfile "\nPrivate: Did not synchronize data into ".
830: "SQL metadata database";
831: }
832: # ----------------------------------------------------------- Copy old versions
833:
834: if (-e $target) {
835: my $filename;
836: my $maxversion=0;
837: $target=~/(.*)\/([^\/]+)\.(\w+)$/;
838: my $srcf=$2;
839: my $srct=$3;
840: my $srcd=$1;
841: unless ($srcd=~/^\/home\/httpd\/html\/res/) {
842: print $logfile "\nPANIC: Target dir is ".$srcd;
843: return "<font color=red>Invalid target directory, FAIL</font>";
844: }
845: opendir(DIR,$srcd);
846: while ($filename=readdir(DIR)) {
847: if ($filename=~/$srcf\.(\d+)\.$srct$/) {
848: $maxversion=($1>$maxversion)?$1:$maxversion;
849: }
850: }
851: closedir(DIR);
852: $maxversion++;
853: $scrout.='<p>Creating old version '.$maxversion;
854: print $logfile "\nCreating old version ".$maxversion;
855:
856: my $copyfile=$srcd.'/'.$srcf.'.'.$maxversion.'.'.$srct;
857:
858: if (copy($target,$copyfile)) {
859: print $logfile "Copied old target to ".$copyfile."\n";
860: $scrout.='<p>Copied old target file';
861: } else {
862: print $logfile "Unable to write ".$copyfile.':'.$!."\n";
863: return "<font color=red>Failed to copy old target, $!, FAIL</font>";
864: }
865:
866: # --------------------------------------------------------------- Copy Metadata
867:
868: $copyfile=$copyfile.'.meta';
869:
870: if (copy($target.'.meta',$copyfile)) {
871: print $logfile "Copied old target metadata to ".$copyfile."\n";
872: $scrout.='<p>Copied old metadata';
873: } else {
874: print $logfile "Unable to write metadata ".$copyfile.':'.$!."\n";
875: if (-e $target.'.meta') {
876: return
877: "<font color=red>Failed to write old metadata copy, $!, FAIL</font>";
878: }
879: }
880:
881:
882: } else {
883: $scrout.='<p>Initial version';
884: print $logfile "\nInitial version";
885: }
886:
887: # ---------------------------------------------------------------- Write Source
888: my $copyfile=$target;
889:
890: my @parts=split(/\//,$copyfile);
891: my $path="/$parts[1]/$parts[2]/$parts[3]/$parts[4]";
892:
893: my $count;
894: for ($count=5;$count<$#parts;$count++) {
895: $path.="/$parts[$count]";
896: if ((-e $path)!=1) {
897: print $logfile "\nCreating directory ".$path;
898: $scrout.='<p>Created directory '.$parts[$count];
899: mkdir($path,0777);
900: }
901: }
902:
903: if (copy($source,$copyfile)) {
904: print $logfile "Copied original source to ".$copyfile."\n";
905: $scrout.='<p>Copied source file';
906: } else {
907: print $logfile "Unable to write ".$copyfile.':'.$!."\n";
908: return "<font color=red>Failed to copy source, $!, FAIL</font>";
909: }
910:
911: # --------------------------------------------------------------- Copy Metadata
912:
913: $copyfile=$copyfile.'.meta';
914:
915: if (copy($source.'.meta',$copyfile)) {
916: print $logfile "Copied original metadata to ".$copyfile."\n";
917: $scrout.='<p>Copied metadata';
918: } else {
919: print $logfile "Unable to write metadata ".$copyfile.':'.$!."\n";
920: return
921: "<font color=red>Failed to write metadata copy, $!, FAIL</font>";
922: }
923:
924: # --------------------------------------------------- Send update notifications
925:
926: {
927:
928: my $filename;
929:
930: $target=~/(.*)\/([^\/]+)$/;
931: my $srcf=$2;
932: opendir(DIR,$1);
933: while ($filename=readdir(DIR)) {
934: if ($filename=~/$srcf\.(\w+)$/) {
935: my $subhost=$1;
936: if ($subhost ne 'meta') {
937: $scrout.='<p>Notifying host '.$subhost.':';
938: print $logfile "\nNotifying host '.$subhost.':'";
939: my $reply=&Apache::lonnet::critical('update:'.$target,$subhost);
940: $scrout.=$reply;
941: print $logfile $reply;
942: }
943: }
944: }
945: closedir(DIR);
946:
947: }
948:
949: # ---------------------------------------- Send update notifications, meta only
950:
951: {
952:
953: my $filename;
954:
955: $target=~/(.*)\/([^\/]+)$/;
956: my $srcf=$2.'.meta';
957: opendir(DIR,$1);
958: while ($filename=readdir(DIR)) {
959: if ($filename=~/$srcf\.(\w+)$/) {
960: my $subhost=$1;
961: if ($subhost ne 'meta') {
962: $scrout.=
963: '<p>Notifying host for metadata only '.$subhost.':';
964: print $logfile
965: "\nNotifying host for metadata only '.$subhost.':'";
966: my $reply=&Apache::lonnet::critical(
967: 'update:'.$target.'.meta',$subhost);
968: $scrout.=$reply;
969: print $logfile $reply;
970: }
971: }
972: }
973: closedir(DIR);
974:
975: }
976:
977: # ------------------------------------------------ Provide link to new resource
978:
979: my $thisdistarget=$target;
980: $thisdistarget=~s/^$docroot//;
981:
982: my $thissrc=$source;
983: $thissrc=~s/^\/home\/(\w+)\/public_html/\/priv\/$1/;
984:
985: my $thissrcdir=$thissrc;
986: $thissrcdir=~s/\/[^\/]+$/\//;
987:
988:
989: return $warning.$scrout.
990: '<hr><a href="'.$thisdistarget.'"><font size=+2>View Published Version</font></a>'.
991: '<p><a href="'.$thissrc.'"><font size=+2>Back to Source</font></a>'.
992: '<p><a href="'.$thissrcdir.
993: '"><font size=+2>Back to Source Directory</font></a>';
994:
995: }
996:
997: # ================================================================ Main Handler
998:
999: sub handler {
1000: my $r=shift;
1001:
1002: if ($r->header_only) {
1003: $r->content_type('text/html');
1004: $r->send_http_header;
1005: return OK;
1006: }
1007:
1008: # Get query string for limited number of parameters
1009:
1010: &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},
1011: ['filename']);
1012:
1013: # -------------------------------------------------------------- Check filename
1014:
1015: my $fn=$ENV{'form.filename'};
1016:
1017:
1018: unless ($fn) {
1019: $r->log_reason($cuname.' at '.$cudom.
1020: ' trying to publish empty filename', $r->filename);
1021: return HTTP_NOT_FOUND;
1022: }
1023:
1024: ($cuname,$cudom)=
1025: &Apache::loncacc::constructaccess($fn,$r->dir_config('lonDefDomain'));
1026: unless (($cuname) && ($cudom)) {
1027: $r->log_reason($cuname.' at '.$cudom.
1028: ' trying to publish file '.$ENV{'form.filename'}.
1029: ' ('.$fn.') - not authorized',
1030: $r->filename);
1031: return HTTP_NOT_ACCEPTABLE;
1032: }
1033:
1034: unless (&Apache::lonnet::homeserver($cuname,$cudom)
1035: eq $r->dir_config('lonHostID')) {
1036: $r->log_reason($cuname.' at '.$cudom.
1037: ' trying to publish file '.$ENV{'form.filename'}.
1038: ' ('.$fn.') - not homeserver ('.
1039: &Apache::lonnet::homeserver($cuname,$cudom).')',
1040: $r->filename);
1041: return HTTP_NOT_ACCEPTABLE;
1042: }
1043:
1044: $fn=~s/^http\:\/\/[^\/]+//;
1045: $fn=~s/^\/\~(\w+)/\/home\/$1\/public_html/;
1046:
1047: my $targetdir='';
1048: $docroot=$r->dir_config('lonDocRoot');
1049: if ($1 ne $cuname) {
1050: $r->log_reason($cuname.' at '.$cudom.
1051: ' trying to publish unowned file '.$ENV{'form.filename'}.
1052: ' ('.$fn.')',
1053: $r->filename);
1054: return HTTP_NOT_ACCEPTABLE;
1055: } else {
1056: $targetdir=$docroot.'/res/'.$cudom;
1057: }
1058:
1059:
1060: unless (-e $fn) {
1061: $r->log_reason($cuname.' at '.$cudom.
1062: ' trying to publish non-existing file '.$ENV{'form.filename'}.
1063: ' ('.$fn.')',
1064: $r->filename);
1065: return HTTP_NOT_FOUND;
1066: }
1067:
1068: unless ($ENV{'form.phase'} eq 'two') {
1069:
1070: # --------------------------------- File is there and owned, init lookup tables
1071:
1072: %addid=();
1073:
1074: {
1075: my $fh=Apache::File->new($r->dir_config('lonTabDir').'/addid.tab');
1076: while (<$fh>=~/(\w+)\s+(\w+)/) {
1077: $addid{$1}=$2;
1078: }
1079: }
1080:
1081: %nokey=();
1082:
1083: {
1084: my $fh=Apache::File->new($r->dir_config('lonIncludes').'/un_keyword.tab');
1085: while (<$fh>) {
1086: my $word=$_;
1087: chomp($word);
1088: $nokey{$word}=1;
1089: }
1090: }
1091:
1092: }
1093:
1094: # ----------------------------------------------------------- Start page output
1095:
1096: $r->content_type('text/html');
1097: $r->send_http_header;
1098:
1099: $r->print('<html><head><title>LON-CAPA Publishing</title></head>');
1100: $r->print(
1101: '<body bgcolor="#FFFFFF"><img align=right src=/adm/lonIcons/lonlogos.gif>');
1102: my $thisfn=$fn;
1103:
1104: # ------------------------------------------------------------- Individual file
1105: {
1106: $thisfn=~/\.(\w+)$/;
1107: my $thistype=$1;
1108: my $thisembstyle=&Apache::loncommon::fileembstyle($thistype);
1109:
1110: my $thistarget=$thisfn;
1111:
1112: $thistarget=~s/^\/home/$targetdir/;
1113: $thistarget=~s/\/public\_html//;
1114:
1115: my $thisdistarget=$thistarget;
1116: $thisdistarget=~s/^$docroot//;
1117:
1118: my $thisdisfn=$thisfn;
1119: $thisdisfn=~s/^\/home\/$cuname\/public_html\///;
1120:
1121: $r->print('<h2>Publishing '.
1122: &Apache::loncommon::filedescription($thistype).' <tt>'.
1123: $thisdisfn.'</tt></h2><b>Target:</b> <tt>'.$thisdistarget.'</tt><p>');
1124:
1125: if (($cuname ne $ENV{'user.name'}) || ($cudom ne $ENV{'user.domain'})) {
1126: $r->print('<h3><font color=red>Co-Author: '.$cuname.' at '.$cudom.
1127: '</font></h3>');
1128: }
1129:
1130: if (&Apache::loncommon::fileembstyle($thistype) eq 'ssi') {
1131: $r->print('<br><a href="/adm/diff?filename=/~'.$cuname.'/'.
1132: $thisdisfn.
1133: '&versionone=priv" target=cat>Diffs with Current Version</a><p>');
1134: }
1135:
1136: # ------------ We are publishing from $thisfn to $thistarget with $thisembstyle
1137:
1138: unless ($ENV{'form.phase'} eq 'two') {
1139: $r->print(
1140: '<hr>'.&publish($thisfn,$thistarget,$thisembstyle));
1141: } else {
1142: $r->print(
1143: '<hr>'.&phasetwo($thisfn,$thistarget,$thisembstyle,$thisdistarget));
1144: }
1145:
1146: }
1147: $r->print('</body></html>');
1148:
1149: return OK;
1150: }
1151:
1152: 1;
1153: __END__
1154:
1155: =head1 NAME
1156:
1157: Apache::lonpublisher - Publication Handler
1158:
1159: =head1 SYNOPSIS
1160:
1161: Invoked by /etc/httpd/conf/srm.conf:
1162:
1163: <Location /adm/publish>
1164: PerlAccessHandler Apache::lonacc
1165: SetHandler perl-script
1166: PerlHandler Apache::lonpublisher
1167: ErrorDocument 403 /adm/login
1168: ErrorDocument 404 /adm/notfound.html
1169: ErrorDocument 406 /adm/unauthorized.html
1170: ErrorDocument 500 /adm/errorhandler
1171: </Location>
1172:
1173: =head1 INTRODUCTION
1174:
1175: This module publishes a file. This involves gathering metadata,
1176: versioning the file, copying file from construction space to
1177: publication space, and copying metadata from construction space
1178: to publication space.
1179:
1180: This is part of the LearningOnline Network with CAPA project
1181: described at http://www.lon-capa.org.
1182:
1183: =head1 HANDLER SUBROUTINE
1184:
1185: This routine is called by Apache and mod_perl.
1186:
1187: =over 4
1188:
1189: =item *
1190:
1191: Get query string for limited number of parameters
1192:
1193: =item *
1194:
1195: Check filename
1196:
1197: =item *
1198:
1199: File is there and owned, init lookup tables
1200:
1201: =item *
1202:
1203: Start page output
1204:
1205: =item *
1206:
1207: Individual file
1208:
1209: =item *
1210:
1211: publish from $thisfn to $thistarget with $thisembstyle
1212:
1213: =back
1214:
1215: =head1 OTHER SUBROUTINES
1216:
1217: =over 4
1218:
1219: =item *
1220:
1221: metaeval() : Evaluate string with metadata
1222:
1223: =item *
1224:
1225: metaread() : Read a metadata file
1226:
1227: =item *
1228:
1229: sqltime() : convert 'time' format into a datetime sql format
1230:
1231: =item *
1232:
1233: textfield() : form field
1234:
1235: =item *
1236:
1237: hiddenfield() : form field
1238:
1239: =item *
1240:
1241: selectbox() : form field
1242:
1243: =item *
1244:
1245: urlfixup() : fixup URL (Publication Step One)
1246:
1247: =item *
1248:
1249: publish() : publish (Publication Step One)
1250:
1251: =item *
1252:
1253: phasetwo() : render second interface showing status of publication steps
1254: (Publication Step Two)
1255:
1256: =back
1257:
1258: =cut
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