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