1: # The LearningOnline Network with CAPA
2: # Publication Handler
3: #
4: # $Id: lonpublisher.pm,v 1.291 2014/07/27 11:39:33 raeburn Exp $
5: #
6: # Copyright Michigan State University Board of Trustees
7: #
8: # This file is part of the LearningOnline Network with CAPA (LON-CAPA).
9: #
10: # LON-CAPA is free software; you can redistribute it and/or modify
11: # it under the terms of the GNU General Public License as published by
12: # the Free Software Foundation; either version 2 of the License, or
13: # (at your option) any later version.
14: #
15: # LON-CAPA is distributed in the hope that it will be useful,
16: # but WITHOUT ANY WARRANTY; without even the implied warranty of
17: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18: # GNU General Public License for more details.
19: #
20: # You should have received a copy of the GNU General Public License
21: # along with LON-CAPA; if not, write to the Free Software
22: # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
23: #
24: # /home/httpd/html/adm/gpl.txt
25: #
26: # http://www.lon-capa.org/
27: #
28: ###
29:
30: ###############################################################################
31: ## ##
32: ## ORGANIZATION OF THIS PERL MODULE ##
33: ## ##
34: ## 1. Modules used by this module ##
35: ## 2. Various subroutines ##
36: ## 3. Publication Step One ##
37: ## 4. Phase Two ##
38: ## 5. Main Handler ##
39: ## ##
40: ###############################################################################
41:
42:
43: ######################################################################
44: ######################################################################
45:
46: =pod
47:
48: =head1 NAME
49:
50: lonpublisher - LON-CAPA publishing handler
51:
52: =head1 SYNOPSIS
53:
54: B<lonpublisher> is used by B<mod_perl> inside B<Apache>. This is the
55: invocation by F<loncapa_apache.conf>:
56:
57: <Location /adm/publish>
58: PerlAccessHandler Apache::lonacc
59: SetHandler perl-script
60: PerlHandler Apache::lonpublisher
61: ErrorDocument 403 /adm/login
62: ErrorDocument 404 /adm/notfound.html
63: ErrorDocument 406 /adm/unauthorized.html
64: ErrorDocument 500 /adm/errorhandler
65: </Location>
66:
67: =head1 OVERVIEW
68:
69: Authors can only write-access the C</priv/domain/authorname/> space.
70: They can copy resources into the resource area through the
71: publication step, and move them back through a recover step.
72: Authors do not have direct write-access to their resource space.
73:
74: During the publication step, several events will be
75: triggered. Metadata is gathered, where a wizard manages default
76: entries on a hierarchical per-directory base: The wizard imports the
77: metadata (including access privileges and royalty information) from
78: the most recent published resource in the current directory, and if
79: that is not available, from the next directory above, etc. The Network
80: keeps all previous versions of a resource and makes them available by
81: an explicit version number, which is inserted between the file name
82: and extension, for example C<foo.2.html>, while the most recent
83: version does not carry a version number (C<foo.html>). Servers
84: subscribing to a changed resource are notified that a new version is
85: available.
86:
87: =head1 DESCRIPTION
88:
89: B<lonpublisher> takes the proper steps to add resources to the LON-CAPA
90: digital library. This includes updating the metadata table in the
91: LON-CAPA database.
92:
93: B<lonpublisher> is many things to many people.
94:
95: This module publishes a file. This involves gathering metadata,
96: versioning the file, copying file from construction space to
97: publication space, and copying metadata from construction space
98: to publication space.
99:
100: =head2 SUBROUTINES
101:
102: Many of the undocumented subroutines implement various magical
103: parsing shortcuts.
104:
105: =cut
106:
107: ######################################################################
108: ######################################################################
109:
110:
111: package Apache::lonpublisher;
112:
113: # ------------------------------------------------- modules used by this module
114: use strict;
115: use Apache::File;
116: use File::Copy;
117: use Apache::Constants qw(:common :http :methods);
118: use HTML::LCParser;
119: use HTML::Entities;
120: use Encode::Encoder;
121: use Apache::lonxml;
122: use DBI;
123: use Apache::lonnet;
124: use Apache::loncommon();
125: use Apache::lonhtmlcommon;
126: use Apache::lonmysql;
127: use Apache::lonlocal;
128: use Apache::loncfile;
129: use LONCAPA::lonmetadata;
130: use Apache::lonmsg;
131: use vars qw(%metadatafields %metadatakeys);
132: use LONCAPA qw(:DEFAULT :match);
133:
134:
135: my %addid;
136: my %nokey;
137:
138: my $docroot;
139:
140: my $cuname;
141: my $cudom;
142:
143: my $registered_cleanup;
144: my $modified_urls;
145:
146: my $lock;
147:
148: =pod
149:
150: =over 4
151:
152: =item B<metaeval>
153:
154: Evaluates a string that contains metadata. This subroutine
155: stores values inside I<%metadatafields> and I<%metadatakeys>.
156: The hash key is a I<$unikey> corresponding to a unique id
157: that is descriptive of the parser location inside the XML tree.
158:
159: Parameters:
160:
161: =over 4
162:
163: =item I<$metastring>
164:
165: A string that contains metadata.
166:
167: =back
168:
169: Returns:
170:
171: nothing
172:
173: =cut
174:
175: #########################################
176: #########################################
177: #
178: # Modifies global %metadatafields %metadatakeys
179: #
180:
181: sub metaeval {
182: my ($metastring,$prefix)=@_;
183:
184: my $parser=HTML::LCParser->new(\$metastring);
185: my $token;
186: while ($token=$parser->get_token) {
187: if ($token->[0] eq 'S') {
188: my $entry=$token->[1];
189: my $unikey=$entry;
190: next if ($entry =~ m/^(?:parameter|stores)_/);
191: if (defined($token->[2]->{'package'})) {
192: $unikey.="\0package\0".$token->[2]->{'package'};
193: }
194: if (defined($token->[2]->{'part'})) {
195: $unikey.="\0".$token->[2]->{'part'};
196: }
197: if (defined($token->[2]->{'id'})) {
198: $unikey.="\0".$token->[2]->{'id'};
199: }
200: if (defined($token->[2]->{'name'})) {
201: $unikey.="\0".$token->[2]->{'name'};
202: }
203: foreach (@{$token->[3]}) {
204: $metadatafields{$unikey.'.'.$_}=$token->[2]->{$_};
205: if ($metadatakeys{$unikey}) {
206: $metadatakeys{$unikey}.=','.$_;
207: } else {
208: $metadatakeys{$unikey}=$_;
209: }
210: }
211: my $newentry=$parser->get_text('/'.$entry);
212: if (($entry eq 'customdistributionfile') ||
213: ($entry eq 'sourcerights')) {
214: $newentry=~s/^\s*//;
215: if ($newentry !~m|^/res|) { $newentry=$prefix.$newentry; }
216: }
217: # actually store
218: if ( $entry eq 'rule' && exists($metadatafields{$unikey})) {
219: $metadatafields{$unikey}.=','.$newentry;
220: } else {
221: $metadatafields{$unikey}=$newentry;
222: }
223: }
224: }
225: }
226:
227: #########################################
228: #########################################
229:
230: =pod
231:
232: =item B<metaread>
233:
234: Read a metadata file
235:
236: Parameters:
237:
238: =over
239:
240: =item I<$logfile>
241:
242: File output stream to output errors and warnings to.
243:
244: =item I<$fn>
245:
246: File name (including path).
247:
248: =back
249:
250: Returns:
251:
252: =over 4
253:
254: =item Scalar string (if successful)
255:
256: XHTML text that indicates successful reading of the metadata.
257:
258: =back
259:
260: =cut
261:
262: #########################################
263: #########################################
264: sub metaread {
265: my ($logfile,$fn,$prefix)=@_;
266: unless (-e $fn) {
267: print($logfile 'No file '.$fn."\n");
268: return '<p class="LC_warning">'
269: .&mt('No file: [_1]',&Apache::loncfile::display($fn))
270: .'</p>';
271: }
272: print($logfile 'Processing '.$fn."\n");
273: my $metastring;
274: {
275: my $metafh=Apache::File->new($fn);
276: $metastring=join('',<$metafh>);
277: }
278: &metaeval($metastring,$prefix);
279: return '<p class="LC_info">'
280: .&mt('Processed file: [_1]',&Apache::loncfile::display($fn))
281: .'</p>';
282: }
283:
284: #########################################
285: #########################################
286:
287: sub coursedependencies {
288: my $url=&Apache::lonnet::declutter(shift);
289: $url=~s/\.meta$//;
290: my ($adomain,$aauthor)=($url=~ m{^($match_domain)/($match_username)/});
291: my $regexp=quotemeta($url);
292: $regexp='___'.$regexp.'___course';
293: my %evaldata=&Apache::lonnet::dump('nohist_resevaldata',$adomain,
294: $aauthor,$regexp);
295: my %courses=();
296: foreach (keys %evaldata) {
297: if ($_=~/^([a-zA-Z0-9]+_[a-zA-Z0-9]+)___.+___course$/) {
298: $courses{$1}=1;
299: }
300: }
301: return %courses;
302: }
303: #########################################
304: #########################################
305:
306:
307: =pod
308:
309: =item Form-field-generating subroutines.
310:
311: For input parameters, these subroutines take in values
312: such as I<$name>, I<$value> and other form field metadata.
313: The output (scalar string that is returned) is an XHTML
314: string which presents the form field (foreseeably inside
315: <form></form> tags).
316:
317: =over 4
318:
319: =item B<textfield>
320:
321: =item B<hiddenfield>
322:
323: =item B<selectbox>
324:
325: =back
326:
327: =cut
328:
329: #########################################
330: #########################################
331: sub textfield {
332: my ($title,$name,$value,$noline)=@_;
333: $value=~s/^\s+//gs;
334: $value=~s/\s+$//gs;
335: $value=~s/\s+/ /gs;
336: $title=&mt($title);
337: $env{'form.'.$name}=$value;
338: return "\n".&Apache::lonhtmlcommon::row_title($title)
339: .'<input type="text" name="'.$name.'" size="80" value="'.$value.'" />'
340: .&Apache::lonhtmlcommon::row_closure($noline);
341: }
342:
343: sub text_with_browse_field {
344: my ($title,$name,$value,$restriction,$noline)=@_;
345: $value=~s/^\s+//gs;
346: $value=~s/\s+$//gs;
347: $value=~s/\s+/ /gs;
348: $title=&mt($title);
349: $env{'form.'.$name}=$value;
350: return "\n".&Apache::lonhtmlcommon::row_title($title)
351: .'<input type="text" name="'.$name.'" size="80" value="'.$value.'" />'
352: .'<br />'
353: .'<a href="javascript:openbrowser(\'pubform\',\''.$name.'\',\''.$restriction.'\');">'
354: .&mt('Select')
355: .'</a> '
356: .'<a href="javascript:opensearcher(\'pubform\',\''.$name.'\');">'
357: .&mt('Search')
358: .'</a>'
359: .&Apache::lonhtmlcommon::row_closure($noline);
360: }
361:
362: sub hiddenfield {
363: my ($name,$value)=@_;
364: $env{'form.'.$name}=$value;
365: return "\n".'<input type="hidden" name="'.$name.'" value="'.$value.'" />';
366: }
367:
368: sub checkbox {
369: my ($name,$text)=@_;
370: return "\n<br /><label><input type='checkbox' name='$name' /> ".
371: &mt($text)."</label>";
372: }
373:
374: sub selectbox {
375: my ($title,$name,$value,$functionref,@idlist)=@_;
376: $title=&mt($title);
377: $value=(split(/\s*,\s*/,$value))[-1];
378: if (defined($value)) {
379: $env{'form.'.$name}=$value;
380: } else {
381: $env{'form.'.$name}=$idlist[0];
382: }
383: my $selout="\n".&Apache::lonhtmlcommon::row_title($title)
384: .'<select name="'.$name.'">';
385: foreach (@idlist) {
386: $selout.='<option value="'.$_.'"';
387: if ($_ eq $value) {
388: $selout.=' selected="selected"';
389: }
390: $selout.='>'.&{$functionref}($_).'</option>';
391: }
392: $selout.='</select>'.&Apache::lonhtmlcommon::row_closure();
393: return $selout;
394: }
395:
396: sub select_level_form {
397: my ($value,$name)=@_;
398: $env{'form.'.$name}=$value;
399: if (!defined($value)) { $env{'form.'.$name}=0; }
400: return &Apache::loncommon::select_level_form($value,$name);
401: }
402: #########################################
403: #########################################
404:
405: =pod
406:
407: =item B<urlfixup>
408:
409: Fix up a url? First step of publication
410:
411: =cut
412:
413: #########################################
414: #########################################
415: sub urlfixup {
416: my ($url,$target)=@_;
417: unless ($url) { return ''; }
418: #javascript code needs no fixing
419: if ($url =~ /^javascript:/i) { return $url; }
420: if ($url =~ /^mailto:/i) { return $url; }
421: #internal document links need no fixing
422: if ($url =~ /^\#/) { return $url; }
423: my ($host)=($url=~m{(?:(?:http|https|ftp)://)*([^/]+)});
424: my @lonids = &Apache::lonnet::machine_ids($host);
425: if (@lonids) {
426: $url=~s{^(?:http|https|ftp)://}{};
427: $url=~s/^\Q$host\E//;
428: }
429: if ($url=~m{^(?:http|https|ftp)://}) { return $url; }
430: $url=~s{\Q~$cuname\E}{res/$cudom/$cuname};
431: return $url;
432: }
433:
434: #########################################
435: #########################################
436:
437: =pod
438:
439: =item B<absoluteurl>
440:
441: Currently undocumented.
442:
443: =cut
444:
445: #########################################
446: #########################################
447: sub absoluteurl {
448: my ($url,$target)=@_;
449: unless ($url) { return ''; }
450: if ($target) {
451: $target=~s/\/[^\/]+$//;
452: $url=&Apache::lonnet::hreflocation($target,$url);
453: }
454: return $url;
455: }
456:
457: #########################################
458: #########################################
459:
460: =pod
461:
462: =item B<set_allow>
463:
464: Currently undocumented
465:
466: =cut
467:
468: #########################################
469: #########################################
470: sub set_allow {
471: my ($allow,$logfile,$target,$tag,$oldurl,$type)=@_;
472: my $newurl=&urlfixup($oldurl,$target);
473: my $return_url=$oldurl;
474: print $logfile 'GUYURL: '.$tag.':'.$oldurl.' - '.$newurl."\n";
475: if ($newurl ne $oldurl) {
476: $return_url=$newurl;
477: print $logfile 'URL: '.$tag.':'.$oldurl.' - '.$newurl."\n";
478: }
479: if (($newurl !~ /^javascript:/i) &&
480: ($newurl !~ /^mailto:/i) &&
481: ($newurl !~ /^(?:http|https|ftp):/i) &&
482: ($newurl !~ /^\#/)) {
483: if (($type eq 'src') || ($type eq 'href')) {
484: if ($newurl =~ /^([^?]+)\?[^?]*$/) {
485: $newurl = $1;
486: }
487: }
488: $$allow{&absoluteurl($newurl,$target)}=1;
489: }
490: return $return_url;
491: }
492:
493: #########################################
494: #########################################
495:
496: =pod
497:
498: =item B<get_subscribed_hosts>
499:
500: Currently undocumented
501:
502: =cut
503:
504: #########################################
505: #########################################
506: sub get_subscribed_hosts {
507: my ($target)=@_;
508: my @subscribed;
509: my $filename;
510: $target=~/(.*)\/([^\/]+)$/;
511: my $srcf=$2;
512: opendir(DIR,$1);
513: # cycle through listed files, subscriptions used to exist
514: # as "filename.lonid"
515: while ($filename=readdir(DIR)) {
516: if ($filename=~/\Q$srcf\E\.($match_lonid)$/) {
517: my $subhost=$1;
518: if (($subhost ne 'meta'
519: && $subhost ne 'subscription'
520: && $subhost ne 'meta.subscription'
521: && $subhost ne 'tmp') &&
522: ($subhost ne $Apache::lonnet::perlvar{'lonHostID'})) {
523: push(@subscribed,$subhost);
524: }
525: }
526: }
527: closedir(DIR);
528: my $sh;
529: if ( $sh=Apache::File->new("$target.subscription") ) {
530: while (my $subline=<$sh>) {
531: if ($subline =~ /^($match_lonid):/) {
532: if ($1 ne $Apache::lonnet::perlvar{'lonHostID'}) {
533: push(@subscribed,$1);
534: }
535: }
536: }
537: }
538: return @subscribed;
539: }
540:
541:
542: #########################################
543: #########################################
544:
545: =pod
546:
547: =item B<get_max_ids_indices>
548:
549: Currently undocumented
550:
551: =cut
552:
553: #########################################
554: #########################################
555: sub get_max_ids_indices {
556: my ($content)=@_;
557: my $maxindex=10;
558: my $maxid=10;
559: my $needsfixup=0;
560: my $duplicateids=0;
561:
562: my %allids;
563: my %duplicatedids;
564:
565: my $parser=HTML::LCParser->new($content);
566: $parser->xml_mode(1);
567: my $token;
568: while ($token=$parser->get_token) {
569: if ($token->[0] eq 'S') {
570: my $counter;
571: if ($counter=$addid{$token->[1]}) {
572: if ($counter eq 'id') {
573: if (defined($token->[2]->{'id'}) &&
574: $token->[2]->{'id'} !~ /^\s*$/) {
575: $maxid=($token->[2]->{'id'}>$maxid)?$token->[2]->{'id'}:$maxid;
576: if (exists($allids{$token->[2]->{'id'}})) {
577: $duplicateids=1;
578: $duplicatedids{$token->[2]->{'id'}}=1;
579: } else {
580: $allids{$token->[2]->{'id'}}=1;
581: }
582: } else {
583: $needsfixup=1;
584: }
585: } else {
586: if (defined($token->[2]->{'index'}) &&
587: $token->[2]->{'index'} !~ /^\s*$/) {
588: $maxindex=($token->[2]->{'index'}>$maxindex)?$token->[2]->{'index'}:$maxindex;
589: } else {
590: $needsfixup=1;
591: }
592: }
593: }
594: }
595: }
596: return ($needsfixup,$maxid,$maxindex,$duplicateids,
597: (keys(%duplicatedids)));
598: }
599:
600: #########################################
601: #########################################
602:
603: =pod
604:
605: =item B<get_all_text_unbalanced>
606:
607: Currently undocumented
608:
609: =cut
610:
611: #########################################
612: #########################################
613: sub get_all_text_unbalanced {
614: #there is a copy of this in lonxml.pm
615: my($tag,$pars)= @_;
616: my $token;
617: my $result='';
618: $tag='<'.$tag.'>';
619: while ($token = $$pars[-1]->get_token) {
620: if (($token->[0] eq 'T')||($token->[0] eq 'C')||($token->[0] eq 'D')) {
621: $result.=$token->[1];
622: } elsif ($token->[0] eq 'PI') {
623: $result.=$token->[2];
624: } elsif ($token->[0] eq 'S') {
625: $result.=$token->[4];
626: } elsif ($token->[0] eq 'E') {
627: $result.=$token->[2];
628: }
629: if ($result =~ /\Q$tag\E/s) {
630: ($result,my $redo)=$result =~ /(.*)\Q$tag\E(.*)/is;
631: #&Apache::lonnet::logthis('Got a winner with leftovers ::'.$2);
632: #&Apache::lonnet::logthis('Result is :'.$1);
633: $redo=$tag.$redo;
634: push (@$pars,HTML::LCParser->new(\$redo));
635: $$pars[-1]->xml_mode('1');
636: last;
637: }
638: }
639: return $result
640: }
641:
642: #########################################
643: #########################################
644:
645: =pod
646:
647: =item B<fix_ids_and_indices>
648:
649: Currently undocumented
650:
651: =cut
652:
653: #########################################
654: #########################################
655: #Arguably this should all be done as a lonnet::ssi instead
656: sub fix_ids_and_indices {
657: my ($logfile,$source,$target)=@_;
658:
659: my %allow;
660: my $content;
661: {
662: my $org=Apache::File->new($source);
663: $content=join('',<$org>);
664: }
665:
666: my ($needsfixup,$maxid,$maxindex,$duplicateids,@duplicatedids)=
667: &get_max_ids_indices(\$content);
668:
669: print $logfile ("Got $needsfixup,$maxid,$maxindex,$duplicateids--".
670: join(', ',@duplicatedids));
671: if ($duplicateids) {
672: print $logfile "Duplicate ID(s) exist, ".join(', ',@duplicatedids)."\n";
673: my $outstring='<span class="LC_error">'.&mt('Unable to publish file, it contains duplicated ID(s), ID(s) need to be unique. The duplicated ID(s) are').': '.join(', ',@duplicatedids).'</span>';
674: return ($outstring,1);
675: }
676: if ($needsfixup) {
677: print $logfile "Needs ID and/or index fixup\n".
678: "Max ID : $maxid (min 10)\n".
679: "Max Index: $maxindex (min 10)\n";
680: }
681: my $outstring='';
682: my $responsecounter=1;
683: my @parser;
684: $parser[0]=HTML::LCParser->new(\$content);
685: $parser[-1]->xml_mode(1);
686: my $token;
687: while (@parser) {
688: while ($token=$parser[-1]->get_token) {
689: if ($token->[0] eq 'S') {
690: my $counter;
691: my $tag=$token->[1];
692: my $lctag=lc($tag);
693: if ($lctag eq 'allow') {
694: $allow{$token->[2]->{'src'}}=1;
695: next;
696: }
697: if ($lctag eq 'base') { next; }
698: if (($lctag eq 'part') || ($lctag eq 'problem')) {
699: $responsecounter=0;
700: }
701: if ($lctag=~/response$/) { $responsecounter++; }
702: if ($lctag eq 'import') { $responsecounter++; }
703: my %parms=%{$token->[2]};
704: $counter=$addid{$tag};
705: if (!$counter) { $counter=$addid{$lctag}; }
706: if ($counter) {
707: if ($counter eq 'id') {
708: unless (defined($parms{'id'}) &&
709: $parms{'id'}!~/^\s*$/) {
710: $maxid++;
711: $parms{'id'}=$maxid;
712: print $logfile 'ID(new) : '.$tag.':'.$maxid."\n";
713: } else {
714: print $logfile 'ID(kept): '.$tag.':'.$parms{'id'}."\n";
715: }
716: } elsif ($counter eq 'index') {
717: unless (defined($parms{'index'}) &&
718: $parms{'index'}!~/^\s*$/) {
719: $maxindex++;
720: $parms{'index'}=$maxindex;
721: print $logfile 'Index: '.$tag.':'.$maxindex."\n";
722: }
723: }
724: }
725: unless ($parms{'type'} eq 'zombie') {
726: foreach my $type ('src','href','background','bgimg') {
727: foreach my $key (keys(%parms)) {
728: if ($key =~ /^$type$/i) {
729: $parms{$key}=&set_allow(\%allow,$logfile,
730: $target,$tag,
731: $parms{$key},$type);
732: }
733: }
734: }
735: }
736: # probably a <randomlabel> image type <label>
737: # or a <image> tag inside <imageresponse>
738: if (($lctag eq 'label' && defined($parms{'description'}))
739: ||
740: ($lctag eq 'image')) {
741: my $next_token=$parser[-1]->get_token();
742: if ($next_token->[0] eq 'T') {
743: $next_token->[1] =~ s/[\n\r\f]+//g;
744: $next_token->[1]=&set_allow(\%allow,$logfile,
745: $target,$tag,
746: $next_token->[1]);
747: }
748: $parser[-1]->unget_token($next_token);
749: }
750: if ($lctag eq 'applet') {
751: my $codebase='';
752: my $havecodebase=0;
753: foreach my $key (keys(%parms)) {
754: if (lc($key) eq 'codebase') {
755: $codebase=$parms{$key};
756: $havecodebase=1;
757: }
758: }
759: if ($havecodebase) {
760: my $oldcodebase=$codebase;
761: unless ($oldcodebase=~/\/$/) {
762: $oldcodebase.='/';
763: }
764: $codebase=&urlfixup($oldcodebase,$target);
765: $codebase=~s/\/$//;
766: if ($codebase ne $oldcodebase) {
767: $parms{'codebase'}=$codebase;
768: print $logfile 'URL codebase: '.$tag.':'.
769: $oldcodebase.' - '.
770: $codebase."\n";
771: }
772: $allow{&absoluteurl($codebase,$target).'/*'}=1;
773: } else {
774: foreach my $key (keys(%parms)) {
775: if ($key =~ /(archive|code|object)/i) {
776: my $oldurl=$parms{$key};
777: my $newurl=&urlfixup($oldurl,$target);
778: $newurl=~s/\/[^\/]+$/\/\*/;
779: print $logfile 'Allow: applet '.lc($key).':'.
780: $oldurl.' allows '.$newurl."\n";
781: $allow{&absoluteurl($newurl,$target)}=1;
782: }
783: }
784: }
785: }
786: my $newparmstring='';
787: my $endtag='';
788: foreach (keys %parms) {
789: if ($_ eq '/') {
790: $endtag=' /';
791: } else {
792: my $quote=($parms{$_}=~/\"/?"'":'"');
793: $newparmstring.=' '.$_.'='.$quote.$parms{$_}.$quote;
794: }
795: }
796: if (!$endtag) { if ($token->[4]=~m:/>$:) { $endtag=' /'; }; }
797: $outstring.='<'.$tag.$newparmstring.$endtag.'>';
798: if ($lctag eq 'm' || $lctag eq 'answer' || $lctag eq 'display' ||
799: $lctag eq 'tex') {
800: $outstring.=&get_all_text_unbalanced('/'.$lctag,\@parser);
801: } elsif ($lctag eq 'script') {
802: if ($parms{'type'} eq 'loncapa/perl') {
803: $outstring.=&get_all_text_unbalanced('/'.$lctag,\@parser);
804: } else {
805: my $script = &get_all_text_unbalanced('/'.$lctag,\@parser);
806: if ($script =~ m{\.set\w+(Src|Swf)\(["']}i) {
807: my @srcs = split(/\.set/i,$script);
808: if (scalar(@srcs) > 1) {
809: foreach my $item (@srcs) {
810: if ($item =~ m{^(FlashPlayerSwf|MediaSrc|XMPSrc|ConfigurationSrc|PosterImageSrc)\((['"])(?:(?!\2).)+\2\)}is) {
811: my $srctype = $1;
812: my $quote = $2;
813: my ($url) = ($item =~ m{^\Q$srctype($quote\E([^$quote]+)\Q$quote)\E});
814: $url = &urlfixup($url);
815: unless ($url=~m{^(?:http|https|ftp)://}) {
816: $allow{&absoluteurl($url,$target)}=1;
817: if ($srctype eq 'ConfigurationSrc') {
818: if ($url =~ m{^(.+/)configuration_express\.xml$}) {
819: #
820: # Camtasia 8.1: express_show/spritesheet.png needed, and included in zip archive.
821: # Not referenced directly in <main>.html or <main>_player.html files,
822: # so add this file to %allow (where <main> is name user gave to file/archive).
823: #
824: my $spritesheet = $1.'express_show/spritesheet.png';
825: $allow{&absoluteurl($spritesheet,$target)}=1;
826: }
827: } elsif ($srctype eq 'PosterImageSrc') {
828: if ($url =~ m{^(.+)_First_Frame\.png$}) {
829: my $prefix = $1;
830: #
831: # Camtasia 8.1: <main>_Thumbnails.png needed, and included in zip archive.
832: # Not referenced directly in <main>.html or <main>_player.html files,
833: # so add this file to %allow (where <main> is name user gave to file/archive).
834: #
835: my $thumbnail = $prefix.'_Thumbnails.png';
836: $allow{&absoluteurl($thumbnail,$target)}=1;
837: }
838: }
839: }
840: }
841: }
842: }
843: }
844: if ($script =~ /\(document,\s*(['"])script\1,\s*\[([^\]]+)\]\);/s) {
845: my $scriptslist = $2;
846: my @srcs = split(/\s*,\s*/,$scriptslist);
847: foreach my $src (@srcs) {
848: if ($src =~ /(["'])(?:(?!\1).)+\.js\1/) {
849: my $quote = $1;
850: my ($url) = ($src =~ m/\Q$quote\E([^$quote]+)\Q$quote\E/);
851: $url = &urlfixup($url);
852: unless ($url=~m{^(?:http|https|ftp)://}) {
853: $allow{&absoluteurl($url,$target)}=1;
854: }
855: }
856: }
857: }
858: $outstring .= $script;
859: }
860: }
861: } elsif ($token->[0] eq 'E') {
862: if ($token->[2]) {
863: unless ($token->[1] eq 'allow') {
864: $outstring.='</'.$token->[1].'>';
865: }
866: }
867: if ((($token->[1] eq 'part') || ($token->[1] eq 'problem'))
868: && (!$responsecounter)) {
869: my $outstring='<span class="LC_error">'.&mt('Found [_1] without responses. This resource cannot be published.',$token->[1]).'</span>';
870: return ($outstring,1);
871: }
872: } else {
873: $outstring.=$token->[1];
874: }
875: }
876: pop(@parser);
877: }
878:
879: if ($needsfixup) {
880: print $logfile "End of ID and/or index fixup\n".
881: "Max ID : $maxid (min 10)\n".
882: "Max Index: $maxindex (min 10)\n";
883: } else {
884: print $logfile "Does not need ID and/or index fixup\n";
885: }
886:
887: return ($outstring,0,%allow);
888: }
889:
890: #########################################
891: #########################################
892:
893: =pod
894:
895: =item B<store_metadata>
896:
897: Store the metadata in the metadata table in the loncapa database.
898: Uses lonmysql to access the database.
899:
900: Inputs: \%metadata
901:
902: Returns: (error,status). error is undef on success, status is undef on error.
903:
904: =cut
905:
906: #########################################
907: #########################################
908: sub store_metadata {
909: my %metadata = @_;
910: my $error;
911: # Determine if the table exists
912: my $status = &Apache::lonmysql::check_table('metadata');
913: if (! defined($status)) {
914: $error='<span class="LC_error">'
915: .&mt('WARNING: Cannot connect to database!')
916: .'</span>';
917: &Apache::lonnet::logthis($error);
918: return ($error,undef);
919: }
920: if ($status == 0) {
921: # It would be nice to actually create the table....
922: $error ='<span class="LC_error">'
923: .&mt('WARNING: The metadata table does not exist in the LON-CAPA database!')
924: .'</span>';
925: &Apache::lonnet::logthis($error);
926: return ($error,undef);
927: }
928: my $dbh = &Apache::lonmysql::get_dbh();
929: if (($metadata{'obsolete'}) || ($metadata{'copyright'} eq 'priv')) {
930: # remove this entry
931: my $delitem = 'url = '.$dbh->quote($metadata{'url'});
932: $status = &LONCAPA::lonmetadata::delete_metadata($dbh,undef,$delitem);
933:
934: } else {
935: $status = &LONCAPA::lonmetadata::update_metadata($dbh,undef,undef,
936: \%metadata);
937: }
938: if (defined($status) && $status ne '') {
939: $error='<span class="LC_error">'
940: .&mt('Error occurred saving new values in metadata table in LON-CAPA database!')
941: .'</span>';
942: &Apache::lonnet::logthis($error);
943: &Apache::lonnet::logthis($status);
944: return ($error,undef);
945: }
946: return (undef,'success');
947: }
948:
949:
950: # ========================================== Parse file for errors and warnings
951:
952: sub checkonthis {
953: my ($r,$source)=@_;
954: my $uri=&Apache::lonnet::hreflocation($source);
955: $uri=~s/\/$//;
956: my $result=&Apache::lonnet::ssi_body($uri,
957: ('grade_target'=>'web',
958: 'return_only_error_and_warning_counts' => 1));
959: my ($errorcount,$warningcount)=split(':',$result);
960: if (($errorcount) || ($warningcount)) {
961: $r->print('<h3>'.&mt('Warnings and Errors').'</h3>');
962: $r->print('<tt>'.$uri.'</tt>:');
963: $r->print('<ul>');
964: if ($warningcount) {
965: $r->print('<li><div class="LC_warning">'
966: .&mt('[quant,_1,warning]',$warningcount)
967: .'</div></li>');
968: }
969: if ($errorcount) {
970: $r->print('<li><div class="LC_error">'
971: .&mt('[quant,_1,error]',$errorcount)
972: .' <img src="/adm/lonMisc/bomb.gif" />'
973: .'</div></li>');
974: }
975: $r->print('</ul>');
976: } else {
977: #$r->print('<font color="green">'.&mt('ok').'</font>');
978: }
979: $r->rflush();
980: return ($warningcount,$errorcount);
981: }
982:
983: # ============================================== Parse file itself for metadata
984: #
985: # parses a file with target meta, sets global %metadatafields %metadatakeys
986:
987: sub parseformeta {
988: my ($source,$style)=@_;
989: my $allmeta='';
990: if (($style eq 'ssi') || ($style eq 'prv')) {
991: my $dir=$source;
992: $dir=~s-/[^/]*$--;
993: my $file=$source;
994: $file=(split('/',$file))[-1];
995: $source=&Apache::lonnet::hreflocation($dir,$file);
996: $allmeta=&Apache::lonnet::ssi_body($source,('grade_target' => 'meta'));
997: &metaeval($allmeta);
998: }
999: return $allmeta;
1000: }
1001:
1002: #########################################
1003: #########################################
1004:
1005: =pod
1006:
1007: =item B<publish>
1008:
1009: This is the workhorse function of this module. This subroutine generates
1010: backup copies, performs any automatic processing (prior to publication,
1011: especially for rat and ssi files),
1012:
1013: Returns a 2 element array, the first is the string to be shown to the
1014: user, the second is an error code, either 1 (an error occurred) or 0
1015: (no error occurred)
1016:
1017: I<Additional documentation needed.>
1018:
1019: =cut
1020:
1021: #########################################
1022: #########################################
1023: sub publish {
1024:
1025: my ($source,$target,$style,$batch)=@_;
1026: my $logfile;
1027: my $scrout='';
1028: my $allmeta='';
1029: my $content='';
1030: my %allow=();
1031:
1032: unless ($logfile=Apache::File->new('>>'.$source.'.log')) {
1033: return ('<span class="LC_error">'.&mt('No write permission to user directory, FAIL').'</span>',1);
1034: }
1035: print $logfile
1036: "\n\n================= Publish ".localtime()." Phase One ================\n".$env{'user.name'}.':'.$env{'user.domain'}."\n";
1037:
1038: if (($style eq 'ssi') || ($style eq 'rat') || ($style eq 'prv')) {
1039: # ------------------------------------------------------- This needs processing
1040:
1041: # ----------------------------------------------------------------- Backup Copy
1042: my $copyfile=$source.'.save';
1043: if (copy($source,$copyfile)) {
1044: print $logfile "Copied original file to ".$copyfile."\n";
1045: } else {
1046: print $logfile "Unable to write backup ".$copyfile.':'.$!."\n";
1047: return ("<span class=\"LC_error\">".&mt("Failed to write backup copy, [_1], FAIL",$1)."</span>",1);
1048: }
1049: # ------------------------------------------------------------- IDs and indices
1050:
1051: my ($outstring,$error);
1052: ($outstring,$error,%allow)=&fix_ids_and_indices($logfile,$source,
1053: $target);
1054: if ($error) { return ($outstring,$error); }
1055: # ------------------------------------------------------------ Construct Allows
1056:
1057: my $outdep=''; # Collect dependencies output data
1058: my $allowstr='';
1059: foreach my $thisdep (sort(keys(%allow))) {
1060: if ($thisdep !~ /[^\s]/) { next; }
1061: if ($thisdep =~/\$/) {
1062: $outdep.='<div class="LC_warning">'
1063: .&mt('The resource depends on another resource with variable filename, i.e., [_1].','<tt>'.$thisdep.'</tt>').'<br />'
1064: .&mt('You likely need to explicitly allow access to all possible dependencies using the [_1]-tag.','<tt><allow></tt>')
1065: ."</div>\n";
1066: }
1067: unless ($style eq 'rat') {
1068: $allowstr.="\n".'<allow src="'.$thisdep.'" />';
1069: }
1070: $outdep.='<div>';
1071: if ($thisdep!~/[\*\$]/ && $thisdep!~m|^/adm/|) {
1072: $outdep.='<a href="'.$thisdep.'">';
1073: }
1074: $outdep.='<tt>'.$thisdep.'</tt>';
1075: if ($thisdep!~/[\*\$]/ && $thisdep!~m|^/adm/|) {
1076: $outdep.='</a>';
1077: if (
1078: &Apache::lonnet::getfile($Apache::lonnet::perlvar{'lonDocRoot'}.'/'.
1079: $thisdep.'.meta') eq '-1') {
1080: $outdep.= ' - <span class="LC_error">'.&mt('Currently not available').
1081: '</span>';
1082: } else {
1083: #
1084: # Store the fact that the dependency has been used by the target file
1085: # Unfortunately, usage is erroneously named sequsage in lonmeta.pm
1086: # The translation happens in lonmetadata.pm
1087: #
1088: my %temphash=(&Apache::lonnet::declutter($target).'___'.
1089: &Apache::lonnet::declutter($thisdep).'___usage'
1090: => time);
1091: $thisdep=~m{^/res/($match_domain)/($match_username)/};
1092: if ((defined($1)) && (defined($2))) {
1093: &Apache::lonnet::put('nohist_resevaldata',\%temphash,
1094: $1,$2);
1095: }
1096: }
1097: }
1098: $outdep.='</div><br />';
1099: }
1100:
1101: if ($outdep) {
1102: $scrout.='<h3>'.&mt('Dependencies').'</h3>'
1103: .$outdep
1104: }
1105: $outstring=~s/\n*(\<\/[^\>]+\>[^<]*)$/$allowstr\n$1\n/s;
1106:
1107: # ------------------------------------------------------------- Write modified.
1108:
1109: {
1110: my $org;
1111: unless ($org=Apache::File->new('>'.$source)) {
1112: print $logfile "No write permit to $source\n";
1113: return ('<span class="LC_error">'.&mt('No write permission to').
1114: ' '.$source.
1115: ', '.&mt('FAIL').'</span>',1);
1116: }
1117: print($org $outstring);
1118: }
1119: $content=$outstring;
1120:
1121: }
1122: # -------------------------------------------- Initial step done, now metadata.
1123:
1124: # --------------------------------------- Storage for metadata keys and fields.
1125: # these are globals
1126: #
1127: %metadatafields=();
1128: %metadatakeys=();
1129:
1130: my %oldparmstores=();
1131:
1132: unless ($batch) {
1133: $scrout.='<h3>'.&mt('Metadata').' ' .
1134: &Apache::loncommon::help_open_topic("Metadata_Description")
1135: . '</h3>';
1136: }
1137:
1138: # ------------------------------------------------ First, check out environment
1139: if ((!(-e $source.'.meta')) || ($env{'form.forceoverride'})) {
1140: $metadatafields{'author'}=$env{'environment.firstname'}.' '.
1141: $env{'environment.middlename'}.' '.
1142: $env{'environment.lastname'}.' '.
1143: $env{'environment.generation'};
1144: $metadatafields{'author'}=~s/\s+/ /g;
1145: $metadatafields{'author'}=~s/\s+$//;
1146: $metadatafields{'owner'}=$cuname.':'.$cudom;
1147:
1148: # ------------------------------------------------ Check out directory hierachy
1149:
1150: my $thisdisfn=$source;
1151:
1152: $thisdisfn=~s/^\Q$docroot\E\/priv\/\Q$cudom\E\/\Q$cuname\E\///;
1153: my @urlparts=('.',split(/\//,$thisdisfn));
1154: $#urlparts--;
1155:
1156: my $currentpath=$docroot.'/priv/'.$cudom.'/'.$cuname.'/';
1157:
1158: my $prefix='../'x($#urlparts);
1159: foreach my $subdir (@urlparts) {
1160: $currentpath.=$subdir.'/';
1161: $scrout.=&metaread($logfile,$currentpath.'default.meta',$prefix);
1162: $prefix=~s|^\.\./||;
1163: }
1164:
1165: # ----------------------------------------------------------- Parse file itself
1166: # read %metadatafields from file itself
1167:
1168: $allmeta=&parseformeta($source,$style);
1169:
1170: # ------------------- Clear out parameters and stores (there should not be any)
1171:
1172: foreach (keys %metadatafields) {
1173: if (($_=~/^parameter/) || ($_=~/^stores/)) {
1174: delete $metadatafields{$_};
1175: }
1176: }
1177:
1178: } else {
1179: # ---------------------- Read previous metafile, remember parameters and stores
1180:
1181: $scrout.=&metaread($logfile,$source.'.meta');
1182:
1183: foreach (keys %metadatafields) {
1184: if (($_=~/^parameter/) || ($_=~/^stores/)) {
1185: $oldparmstores{$_}=1;
1186: delete $metadatafields{$_};
1187: }
1188: }
1189: # ------------------------------------------------------------- Save some stuff
1190: my %savemeta=();
1191: foreach ('title') {
1192: if ($metadatafields{$_}) { $savemeta{$_}=$metadatafields{$_}; }
1193: }
1194: # ------------------------------------------ See if anything new in file itself
1195:
1196: $allmeta=&parseformeta($source,$style);
1197: # ----------------------------------------------------------- Restore the stuff
1198: foreach (keys %savemeta) {
1199: $metadatafields{$_}=$savemeta{$_};
1200: }
1201: }
1202:
1203:
1204: # ---------------- Find and document discrepancies in the parameters and stores
1205:
1206: my $chparms='';
1207: foreach (sort keys %metadatafields) {
1208: if (($_=~/^parameter/) || ($_=~/^stores/)) {
1209: unless ($_=~/\.\w+$/) {
1210: unless ($oldparmstores{$_}) {
1211: my $disp_key = $_;
1212: $disp_key =~ tr/\0/_/;
1213: print $logfile ('New: '.$disp_key."\n");
1214: $chparms .= $disp_key.' ';
1215: }
1216: }
1217: }
1218: }
1219: if ($chparms) {
1220: $scrout.='<p><b>'.&mt('New parameters or saved values').
1221: ':</b> '.$chparms.'</p>';
1222: }
1223:
1224: $chparms='';
1225: foreach (sort keys %oldparmstores) {
1226: if (($_=~/^parameter/) || ($_=~/^stores/)) {
1227: unless (($metadatafields{$_.'.name'}) ||
1228: ($metadatafields{$_.'.package'}) || ($_=~/\.\w+$/)) {
1229: my $disp_key = $_;
1230: $disp_key =~ tr/\0/_/;
1231: print $logfile ('Obsolete: '.$disp_key."\n");
1232: $chparms.=$disp_key.' ';
1233: }
1234: }
1235: }
1236: if ($chparms) {
1237: $scrout.='<p><b>'.&mt('Obsolete parameters or saved values').':</b> '
1238: .$chparms.'</p>'
1239: .'<p class="LC_warning"><b>'.&mt('Warning!').'</b><br />'
1240: .&mt('If this resource is in active use, student performance data from the previous version may become inaccessible.')
1241: .'</p><hr />';
1242: }
1243: if ($metadatafields{'copyright'} eq 'priv') {
1244: $scrout.='<p class="LC_warning"><b>'.&mt('Warning!').'</b><br />'
1245: .&mt('Copyright/distribution option "Private" is no longer supported. Select another option from below. Consider "Custom Rights" for maximum control over the usage of your resource.')
1246: .'</p><hr />';
1247: }
1248:
1249: # ------------------------------------------------------- Now have all metadata
1250:
1251: my %keywords=();
1252:
1253: if (length($content)<500000) {
1254: my $textonly=$content;
1255: $textonly=~s/\<script[^\<]+\<\/script\>//g;
1256: $textonly=~s/\<m\>[^\<]+\<\/m\>//g;
1257: $textonly=~s/\<[^\>]*\>//g;
1258:
1259: #this is a work simplification for german authors for present
1260: $textonly=HTML::Entities::decode($textonly); #decode HTML-character
1261: $textonly=Encode::Encoder::encode('utf8', $textonly); #encode to perl internal unicode
1262: $textonly=~tr/A-ZÜÄÖ/a-züäö/; #add lowercase rule for german "Umlaute"
1263: $textonly=~s/[\$\&][a-z]\w*//g;
1264: $textonly=~s/[^a-z^ü^ä^ö^ß\s]//g; #dont delete german "Umlaute"
1265:
1266: foreach ($textonly=~m/[^\s]+/g) { #match all but whitespaces
1267: unless ($nokey{$_}) {
1268: $keywords{$_}=1;
1269: }
1270: }
1271:
1272:
1273: }
1274:
1275: foreach my $addkey (split(/[\"\'\,\;]/,$metadatafields{'keywords'})) {
1276: $addkey=~s/\s+/ /g;
1277: $addkey=~s/^\s//;
1278: $addkey=~s/\s$//;
1279: if ($addkey=~/\w/) {
1280: $keywords{$addkey}=1;
1281: }
1282: }
1283: # --------------------------------------------------- Now we also have keywords
1284: # =============================================================================
1285: # interactive mode html goes into $intr_scrout
1286: # batch mode throws away this HTML
1287: # additionally all of the field functions have a by product of setting
1288: # $env{'from.'..} so that it can be used by the phase two handler in
1289: # batch mode
1290:
1291: my $intr_scrout.='<br />'
1292: .'<form name="pubform" action="/adm/publish" method="post">';
1293: unless ($env{'form.makeobsolete'}) {
1294: $intr_scrout.='<p class="LC_warning">'
1295: .&mt('Searching for your resource will be based on the following metadata. Please provide as much data as possible.')
1296: .'</p>'
1297: .'<p><input type="submit" value="'
1298: .&mt('Finalize Publication')
1299: .'" /> <a href="'.&Apache::loncfile::url($source).'">'.&mt('Cancel').'</a></p>';
1300: }
1301: $intr_scrout.=&Apache::lonhtmlcommon::start_pick_box();
1302: $intr_scrout.=
1303: &hiddenfield('phase','two').
1304: &hiddenfield('filename',$env{'form.filename'}).
1305: &hiddenfield('allmeta',&escape($allmeta)).
1306: &hiddenfield('dependencies',join(',',keys %allow));
1307: unless ($env{'form.makeobsolete'}) {
1308: $intr_scrout.=
1309: &textfield('Title','title',$metadatafields{'title'}).
1310: &textfield('Author(s)','author',$metadatafields{'author'}).
1311: &textfield('Subject','subject',$metadatafields{'subject'});
1312: # --------------------------------------------------- Scan content for keywords
1313:
1314: my $keywords_help = &Apache::loncommon::help_open_topic("Publishing_Keywords");
1315: my $keywordout=<<"END";
1316: <script>
1317: function checkAll(field) {
1318: for (i = 0; i < field.length; i++)
1319: field[i].checked = true ;
1320: }
1321:
1322: function uncheckAll(field) {
1323: for (i = 0; i < field.length; i++)
1324: field[i].checked = false ;
1325: }
1326: </script>
1327: END
1328: $keywordout.="\n".&Apache::lonhtmlcommon::row_title(&mt('Keywords'))
1329: .$keywords_help
1330: .'<input type="button" value="'.&mt('check all').'" onclick="javascript:checkAll(document.pubform.keywords)" />'
1331: .'<input type="button" value="'.&mt('uncheck all').'" onclick="javascript:uncheckAll(document.pubform.keywords)" />'
1332: .'</p><br />'
1333: .&Apache::loncommon::start_data_table();
1334: my $cols_per_row = 10;
1335: my $colcount=0;
1336: my $wordcount=0;
1337: my $numkeywords = scalar(keys(%keywords));
1338:
1339: foreach my $word (sort(keys(%keywords))) {
1340: if ($colcount == 0) {
1341: $keywordout .= &Apache::loncommon::start_data_table_row();
1342: }
1343: $colcount++;
1344: $wordcount++;
1345: if (($wordcount == $numkeywords) && ($colcount < $cols_per_row)) {
1346: my $colspan = 1+$cols_per_row-$colcount;
1347: $keywordout .= '<td colspan="'.$colspan.'">';
1348: } else {
1349: $keywordout .= '<td>';
1350: }
1351: $keywordout.='<label><input type="checkbox" name="keywords" value="'.$word.'"';
1352: if ($metadatafields{'keywords'}) {
1353: if ($metadatafields{'keywords'}=~/\Q$word\E/) {
1354: $keywordout.=' checked="checked"';
1355: $env{'form.keywords'}.=$word.',';
1356: }
1357: } elsif (&Apache::loncommon::keyword($word)) {
1358: $keywordout.=' checked="checked"';
1359: $env{'form.keywords'}.=$word.',';
1360: }
1361: $keywordout.=' />'.$word.'</label></td>';
1362: if ($colcount == $cols_per_row) {
1363: $keywordout.=&Apache::loncommon::end_data_table_row();
1364: $colcount=0;
1365: }
1366: }
1367: if ($colcount > 0) {
1368: $keywordout .= &Apache::loncommon::end_data_table_row();
1369: }
1370:
1371: $env{'form.keywords'}=~s/\,$//;
1372:
1373: $keywordout.=&Apache::loncommon::end_data_table_row()
1374: .&Apache::loncommon::end_data_table()
1375: .&Apache::lonhtmlcommon::row_closure();
1376:
1377: $intr_scrout.=$keywordout;
1378:
1379: $intr_scrout.=&textfield('Additional Keywords','addkey','');
1380:
1381: $intr_scrout.=&textfield('Notes','notes',$metadatafields{'notes'});
1382:
1383: $intr_scrout.="\n".&Apache::lonhtmlcommon::row_title(&mt('Abstract'))
1384: .'<textarea cols="80" rows="5" name="abstract">'
1385: .$metadatafields{'abstract'}
1386: .'</textarea>'
1387: .&Apache::lonhtmlcommon::row_closure();
1388:
1389: $source=~/\.(\w+)$/;
1390:
1391: $intr_scrout.="\n".&Apache::lonhtmlcommon::row_title(&mt('Grade Levels'))
1392: .&mt('Lowest Grade Level:').' '
1393: .&select_level_form($metadatafields{'lowestgradelevel'},'lowestgradelevel')
1394: # .&Apache::lonhtmlcommon::row_closure();
1395: # $intr_scrout.="\n".&Apache::lonhtmlcommon::row_title(&mt('Highest Grade Level'))
1396: .' '.&mt('Highest Grade Level:').' '
1397: .&select_level_form($metadatafields{'highestgradelevel'},'highestgradelevel')
1398: .&Apache::lonhtmlcommon::row_closure();
1399:
1400: $intr_scrout.=&textfield('Standards','standards',$metadatafields{'standards'});
1401:
1402: $intr_scrout.=&hiddenfield('mime',$1);
1403:
1404: my $defaultlanguage=$metadatafields{'language'};
1405: $defaultlanguage =~ s/\s*notset\s*//g;
1406: $defaultlanguage =~ s/^,\s*//g;
1407: $defaultlanguage =~ s/,\s*$//g;
1408:
1409: $intr_scrout.=&selectbox('Language','language',
1410: $defaultlanguage,
1411: \&Apache::loncommon::languagedescription,
1412: (&Apache::loncommon::languageids),
1413: );
1414:
1415: unless ($metadatafields{'creationdate'}) {
1416: $metadatafields{'creationdate'}=time;
1417: }
1418: $intr_scrout.=&hiddenfield('creationdate',
1419: &Apache::lonmysql::unsqltime($metadatafields{'creationdate'}));
1420:
1421: $intr_scrout.=&hiddenfield('lastrevisiondate',time);
1422:
1423: my $pubowner_last;
1424: if ($style eq 'prv') {
1425: $pubowner_last = 1;
1426: }
1427: $intr_scrout.=&textfield('Publisher/Owner','owner',
1428: $metadatafields{'owner'},$pubowner_last);
1429:
1430: # ---------------------------------------------- Retrofix for unused copyright
1431: if ($metadatafields{'copyright'} eq 'free') {
1432: $metadatafields{'copyright'}='default';
1433: $metadatafields{'sourceavail'}='open';
1434: }
1435: if ($metadatafields{'copyright'} eq 'priv') {
1436: $metadatafields{'copyright'}='domain';
1437: }
1438: # ------------------------------------------------ Dial in reasonable defaults
1439: my $defaultoption=$metadatafields{'copyright'};
1440: unless ($defaultoption) { $defaultoption='default'; }
1441: my $defaultsourceoption=$metadatafields{'sourceavail'};
1442: unless ($defaultsourceoption) { $defaultsourceoption='closed'; }
1443: unless ($style eq 'prv') {
1444: # -------------------------------------------------- Correct copyright for rat.
1445: if ($style eq 'rat') {
1446: # -------------------------------------- Retrofix for non-applicable copyright
1447: if ($metadatafields{'copyright'} eq 'public') {
1448: delete $metadatafields{'copyright'};
1449: $defaultoption='default';
1450: }
1451: $intr_scrout.=&selectbox('Copyright/Distribution','copyright',
1452: $defaultoption,
1453: \&Apache::loncommon::copyrightdescription,
1454: (grep !/^(public|priv)$/,(&Apache::loncommon::copyrightids)));
1455: } else {
1456: $intr_scrout.=&selectbox('Copyright/Distribution','copyright',
1457: $defaultoption,
1458: \&Apache::loncommon::copyrightdescription,
1459: (grep !/^priv$/,(&Apache::loncommon::copyrightids)));
1460: }
1461: my $copyright_help =
1462: &Apache::loncommon::help_open_topic('Publishing_Copyright');
1463: my $replace=&mt('Copyright/Distribution:');
1464: $intr_scrout =~ s/$replace/$replace.' '.$copyright_help/ge;
1465:
1466: $intr_scrout.=&text_with_browse_field('Custom Distribution File','customdistributionfile',$metadatafields{'customdistributionfile'},'rights');
1467: $intr_scrout.=&selectbox('Source Distribution','sourceavail',
1468: $defaultsourceoption,
1469: \&Apache::loncommon::source_copyrightdescription,
1470: (&Apache::loncommon::source_copyrightids));
1471: # $intr_scrout.=&text_with_browse_field('Source Custom Distribution File','sourcerights',$metadatafields{'sourcerights'},'rights');
1472: my $uctitle=&mt('Obsolete');
1473: my $obsolete_checked=($metadatafields{'obsolete'})?' checked="checked"':'';
1474: $intr_scrout.="\n".&Apache::lonhtmlcommon::row_title($uctitle)
1475: .'<input type="checkbox" name="obsolete"'.$obsolete_checked.' />'
1476: .&Apache::lonhtmlcommon::row_closure(1);
1477: $intr_scrout.=&text_with_browse_field('Suggested Replacement for Obsolete File',
1478: 'obsoletereplacement',
1479: $metadatafields{'obsoletereplacement'},'',1);
1480: } else {
1481: $intr_scrout.=&hiddenfield('copyright','private');
1482: }
1483: } else {
1484: $intr_scrout.=
1485: &hiddenfield('title',$metadatafields{'title'}).
1486: &hiddenfield('author',$metadatafields{'author'}).
1487: &hiddenfield('subject',$metadatafields{'subject'}).
1488: &hiddenfield('keywords',$metadatafields{'keywords'}).
1489: &hiddenfield('abstract',$metadatafields{'abstract'}).
1490: &hiddenfield('notes',$metadatafields{'notes'}).
1491: &hiddenfield('mime',$metadatafields{'mime'}).
1492: &hiddenfield('creationdate',$metadatafields{'creationdate'}).
1493: &hiddenfield('lastrevisiondate',time).
1494: &hiddenfield('owner',$metadatafields{'owner'}).
1495: &hiddenfield('lowestgradelevel',$metadatafields{'lowestgradelevel'}).
1496: &hiddenfield('standards',$metadatafields{'standards'}).
1497: &hiddenfield('highestgradelevel',$metadatafields{'highestgradelevel'}).
1498: &hiddenfield('language',$metadatafields{'language'}).
1499: &hiddenfield('copyright',$metadatafields{'copyright'}).
1500: &hiddenfield('sourceavail',$metadatafields{'sourceavail'}).
1501: &hiddenfield('customdistributionfile',$metadatafields{'customdistributionfile'}).
1502: &hiddenfield('obsolete',1).
1503: &text_with_browse_field('Suggested Replacement for Obsolete File',
1504: 'obsoletereplacement',
1505: $metadatafields{'obsoletereplacement'},'',1);
1506: }
1507: if (!$batch) {
1508: $scrout.=$intr_scrout
1509: .&Apache::lonhtmlcommon::end_pick_box()
1510: .'<p><input type="submit" value="'
1511: .&mt($env{'form.makeobsolete'}?'Make Obsolete':'Finalize Publication')
1512: .'" /></p>'
1513: .'</form>';
1514: }
1515: return($scrout,0);
1516: }
1517:
1518: #########################################
1519: #########################################
1520:
1521: =pod
1522:
1523: =item B<phasetwo>
1524:
1525: Render second interface showing status of publication steps.
1526: This is publication step two.
1527:
1528: Parameters:
1529:
1530: =over 4
1531:
1532: =item I<$source>
1533:
1534: =item I<$target>
1535:
1536: =item I<$style>
1537:
1538: =item I<$distarget>
1539:
1540: =back
1541:
1542: Returns:
1543:
1544: =over 4
1545:
1546: =item integer
1547:
1548: 0: fail
1549: 1: success
1550:
1551: =back
1552:
1553: =cut
1554:
1555: #'stupid emacs
1556: #########################################
1557: #########################################
1558: sub phasetwo {
1559:
1560: my ($r,$source,$target,$style,$distarget,$batch)=@_;
1561: $source=~s/\/+/\//g;
1562: $target=~s/\/+/\//g;
1563: #
1564: # Unless trying to get rid of something, check name validity
1565: #
1566: unless ($env{'form.obsolete'}) {
1567: if ($target=~/(\_\_\_|\&\&\&|\:\:\:)/) {
1568: $r->print('<span class="LC_error">'.
1569: &mt('Unsupported character combination [_1] in filename, FAIL.',"<tt>'.$1.'</tt>").
1570: '</span>');
1571: return 0;
1572: }
1573: unless ($target=~/\.(\w+)$/) {
1574: $r->print('<span class="LC_error">'.&mt('No valid extension found in filename, FAIL').'</span>');
1575: return 0;
1576: }
1577: if ($target=~/\.(\d+)\.(\w+)$/) {
1578: $r->print('<span class="LC_error">'.&mt('Filename of resource contains internal version number. Cannot publish such resources, FAIL').'</span>');
1579: return 0;
1580: }
1581: }
1582:
1583: #
1584: # End name check
1585: #
1586: $distarget=~s/\/+/\//g;
1587: my $logfile;
1588: unless ($logfile=Apache::File->new('>>'.$source.'.log')) {
1589: $r->print(
1590: '<span class="LC_error">'.
1591: &mt('No write permission to user directory, FAIL').'</span>');
1592: return 0;
1593: }
1594:
1595: if ($source =~ /\.rights$/) {
1596: $r->print('<p><span class="LC_warning">'.&mt('Warning: It can take up to 1 hour for rights changes to fully propagate.').'</span></p>');
1597: }
1598:
1599: print $logfile
1600: "\n================= Publish ".localtime()." Phase Two ================\n".$env{'user.name'}.':'.$env{'user.domain'}."\n";
1601:
1602: %metadatafields=();
1603: %metadatakeys=();
1604:
1605: &metaeval(&unescape($env{'form.allmeta'}));
1606:
1607: $metadatafields{'title'}=$env{'form.title'};
1608: $metadatafields{'author'}=$env{'form.author'};
1609: $metadatafields{'subject'}=$env{'form.subject'};
1610: $metadatafields{'notes'}=$env{'form.notes'};
1611: $metadatafields{'abstract'}=$env{'form.abstract'};
1612: $metadatafields{'mime'}=$env{'form.mime'};
1613: $metadatafields{'language'}=$env{'form.language'};
1614: $metadatafields{'creationdate'}=$env{'form.creationdate'};
1615: $metadatafields{'lastrevisiondate'}=$env{'form.lastrevisiondate'};
1616: $metadatafields{'owner'}=$env{'form.owner'};
1617: $metadatafields{'copyright'}=$env{'form.copyright'};
1618: $metadatafields{'standards'}=$env{'form.standards'};
1619: $metadatafields{'lowestgradelevel'}=$env{'form.lowestgradelevel'};
1620: $metadatafields{'highestgradelevel'}=$env{'form.highestgradelevel'};
1621: $metadatafields{'customdistributionfile'}=
1622: $env{'form.customdistributionfile'};
1623: $metadatafields{'sourceavail'}=$env{'form.sourceavail'};
1624: $metadatafields{'obsolete'}=$env{'form.obsolete'};
1625: $metadatafields{'obsoletereplacement'}=
1626: $env{'form.obsoletereplacement'};
1627: $metadatafields{'dependencies'}=$env{'form.dependencies'};
1628: $metadatafields{'modifyinguser'}=$env{'user.name'}.':'.
1629: $env{'user.domain'};
1630: $metadatafields{'authorspace'}=$cuname.':'.$cudom;
1631: $metadatafields{'domain'}=$cudom;
1632:
1633: my $allkeywords=$env{'form.addkey'};
1634: if (exists($env{'form.keywords'})) {
1635: if (ref($env{'form.keywords'})) {
1636: $allkeywords .= ','.join(',',@{$env{'form.keywords'}});
1637: } else {
1638: $allkeywords .= ','.$env{'form.keywords'};
1639: }
1640: }
1641: $allkeywords=~s/[\"\']//g;
1642: $allkeywords=~s/\s*[\;\,]\s*/\,/g;
1643: $allkeywords=~s/\s+/ /g;
1644: $allkeywords=~s/^[ \,]//;
1645: $allkeywords=~s/[ \,]$//;
1646: $metadatafields{'keywords'}=$allkeywords;
1647:
1648: # check if custom distribution file is specified
1649: if ($metadatafields{'copyright'} eq 'custom') {
1650: my $file=$metadatafields{'customdistributionfile'};
1651: unless ($file=~/\.rights$/) {
1652: $r->print(
1653: '<span class="LC_error">'.&mt('No valid custom distribution rights file specified, FAIL').
1654: '</span>');
1655: return 0;
1656: }
1657: }
1658: {
1659: print $logfile "\nWrite metadata file for ".$source;
1660: my $mfh;
1661: unless ($mfh=Apache::File->new('>'.$source.'.meta')) {
1662: $r->print(
1663: '<span class="LC_error">'.&mt('Could not write metadata, FAIL').
1664: '</span>');
1665: return 0;
1666: }
1667: foreach (sort keys %metadatafields) {
1668: unless ($_=~/\./) {
1669: my $unikey=$_;
1670: $unikey=~/^([A-Za-z]+)/;
1671: my $tag=$1;
1672: $tag=~tr/A-Z/a-z/;
1673: print $mfh "\n\<$tag";
1674: foreach (split(/\,/,$metadatakeys{$unikey})) {
1675: my $value=$metadatafields{$unikey.'.'.$_};
1676: $value=~s/\"/\'\'/g;
1677: print $mfh ' '.$_.'="'.$value.'"';
1678: }
1679: print $mfh '>'.
1680: &HTML::Entities::encode($metadatafields{$unikey},'<>&"')
1681: .'</'.$tag.'>';
1682: }
1683: }
1684: $r->print('<p>'.&mt('Wrote Metadata').'</p>');
1685: print $logfile "\nWrote metadata";
1686: }
1687:
1688: # -------------------------------- Synchronize entry with SQL metadata database
1689:
1690: $metadatafields{'url'} = $distarget;
1691: $metadatafields{'version'} = 'current';
1692:
1693: my ($error,$success) = &store_metadata(%metadatafields);
1694: if ($success) {
1695: $r->print('<p>'.&mt('Synchronized SQL metadata database').'</p>');
1696: print $logfile "\nSynchronized SQL metadata database";
1697: } else {
1698: $r->print($error);
1699: print $logfile "\n".$error;
1700: }
1701: # --------------------------------------------- Delete author resource messages
1702: my $delresult=&Apache::lonmsg::del_url_author_res_msg($target);
1703: $r->print('<p>'.&mt('Removing error messages:').' '.$delresult.'</p>');
1704: print $logfile "\nRemoving error messages: $delresult";
1705: # ----------------------------------------------------------- Copy old versions
1706:
1707: if (-e $target) {
1708: my $filename;
1709: my $maxversion=0;
1710: $target=~/(.*)\/([^\/]+)\.(\w+)$/;
1711: my $srcf=$2;
1712: my $srct=$3;
1713: my $srcd=$1;
1714: my $docroot = $Apache::lonnet::perlvar{'lonDocRoot'};
1715: unless ($srcd=~/^\Q$docroot\E\/res/) {
1716: print $logfile "\nPANIC: Target dir is ".$srcd;
1717: $r->print(
1718: "<span class=\"LC_error\">".&mt('Invalid target directory, FAIL')."</span>");
1719: return 0;
1720: }
1721: opendir(DIR,$srcd);
1722: while ($filename=readdir(DIR)) {
1723: if (-l $srcd.'/'.$filename) {
1724: unlink($srcd.'/'.$filename);
1725: unlink($srcd.'/'.$filename.'.meta');
1726: } else {
1727: if ($filename=~/^\Q$srcf\E\.(\d+)\.\Q$srct\E$/) {
1728: $maxversion=($1>$maxversion)?$1:$maxversion;
1729: }
1730: }
1731: }
1732: closedir(DIR);
1733: $maxversion++;
1734: $r->print('<p>'.&mt('Creating old version [_1]',$maxversion).'</p>');
1735: print $logfile "\nCreating old version ".$maxversion."\n";
1736:
1737: my $copyfile=$srcd.'/'.$srcf.'.'.$maxversion.'.'.$srct;
1738:
1739: if (copy($target,$copyfile)) {
1740: print $logfile "Copied old target to ".$copyfile."\n";
1741: $r->print(&Apache::lonhtmlcommon::confirm_success(&mt('Copied old target file')));
1742: } else {
1743: print $logfile "Unable to write ".$copyfile.':'.$!."\n";
1744: $r->print(&Apache::lonhtmlcommon::confirm_success(&mt('Failed to copy old target').", $!",1));
1745: return 0;
1746: }
1747:
1748: # --------------------------------------------------------------- Copy Metadata
1749:
1750: $copyfile=$copyfile.'.meta';
1751:
1752: if (copy($target.'.meta',$copyfile)) {
1753: print $logfile "Copied old target metadata to ".$copyfile."\n";
1754: $r->print(&Apache::lonhtmlcommon::confirm_success(&mt('Copied old metadata')));
1755: } else {
1756: print $logfile "Unable to write metadata ".$copyfile.':'.$!."\n";
1757: if (-e $target.'.meta') {
1758: $r->print(&Apache::lonhtmlcommon::confirm_success(
1759: &mt('Failed to write old metadata copy').", $!",1));
1760: return 0;
1761: }
1762: }
1763:
1764:
1765: } else {
1766: $r->print('<p>'.&mt('Initial version').'</p>');
1767: print $logfile "\nInitial version";
1768: }
1769:
1770: # ---------------------------------------------------------------- Write Source
1771: my $copyfile=$target;
1772:
1773: my @parts=split(/\//,$copyfile);
1774: my $path="/$parts[1]/$parts[2]/$parts[3]/$parts[4]";
1775:
1776: my $count;
1777: for ($count=5;$count<$#parts;$count++) {
1778: $path.="/$parts[$count]";
1779: if ((-e $path)!=1) {
1780: print $logfile "\nCreating directory ".$path;
1781: mkdir($path,0777);
1782: $r->print('<p>'
1783: .&mt('Created directory [_1]'
1784: ,'<span class="LC_filename">'.$parts[$count].'</span>')
1785: .'</p>'
1786: );
1787: }
1788: }
1789:
1790: if (copy($source,$copyfile)) {
1791: print $logfile "\nCopied original source to ".$copyfile."\n";
1792: $r->print(&Apache::lonhtmlcommon::confirm_success(&mt('Copied source file')));
1793: } else {
1794: print $logfile "\nUnable to write ".$copyfile.':'.$!."\n";
1795: $r->print(&Apache::lonhtmlcommon::confirm_success(
1796: &mt('Failed to copy source').", $!",1));
1797: return 0;
1798: }
1799:
1800: # ---------------------------------------------- Delete local tmp-preview files
1801: unlink($copyfile.'.tmp');
1802: # --------------------------------------------------------------- Copy Metadata
1803:
1804: $copyfile=$copyfile.'.meta';
1805:
1806: if (copy($source.'.meta',$copyfile)) {
1807: print $logfile "\nCopied original metadata to ".$copyfile."\n";
1808: $r->print(&Apache::lonhtmlcommon::confirm_success(&mt('Copied metadata')));
1809: } else {
1810: print $logfile "\nUnable to write metadata ".$copyfile.':'.$!."\n";
1811: $r->print(&Apache::lonhtmlcommon::confirm_success(
1812: &mt('Failed to write metadata copy').", $!",1));
1813: return 0;
1814: }
1815: $r->rflush;
1816:
1817: # ------------------------------------------------------------- Trigger updates
1818: push(@{$modified_urls},[$target,$source]);
1819: unless ($registered_cleanup) {
1820: my $handlers = $r->get_handlers('PerlCleanupHandler');
1821: $r->set_handlers('PerlCleanupHandler' => [\¬ify,@{$handlers}]);
1822: $registered_cleanup=1;
1823: }
1824:
1825: # ---------------------------------------------------------- Clear local caches
1826: my $thisdistarget=$target;
1827: $thisdistarget=~s/^\Q$docroot\E//;
1828: &Apache::lonnet::devalidate_cache_new('resversion',$target);
1829: &Apache::lonnet::devalidate_cache_new('meta',
1830: &Apache::lonnet::declutter($thisdistarget));
1831:
1832: # ------------------------------------------------------------- Everything done
1833: $logfile->close();
1834: $r->print('<p class="LC_success">'.&mt('Done').'</p>');
1835:
1836: # ------------------------------------------------ Provide link to new resource
1837: unless ($batch) {
1838:
1839: my $thissrc=&Apache::loncfile::url($source);
1840: my $thissrcdir=$thissrc;
1841: $thissrcdir=~s/\/[^\/]+$/\//;
1842:
1843: $r->print(
1844: &Apache::lonhtmlcommon::actionbox([
1845: '<a href="'.$thisdistarget.'">'.
1846: &mt('View Published Version').
1847: '</a>',
1848: '<a href="'.$thissrc.'">'.
1849: &mt('Back to Source').
1850: '</a>',
1851: '<a href="'.$thissrcdir.'">'.
1852: &mt('Back to Source Directory').
1853: '</a>'])
1854: );
1855: }
1856: return 1;
1857: }
1858:
1859: # =============================================================== Notifications
1860: sub notify {
1861: # --------------------------------------------------- Send update notifications
1862: foreach my $targetsource (@{$modified_urls}){
1863: my ($target,$source)=@{$targetsource};
1864: my $logfile=Apache::File->new('>>'.$source.'.log');
1865: print $logfile "\nCleanup phase: Notifications\n";
1866: my @subscribed=&get_subscribed_hosts($target);
1867: foreach my $subhost (@subscribed) {
1868: print $logfile "\nNotifying host ".$subhost.':';
1869: my $reply=&Apache::lonnet::critical('update:'.$target,$subhost);
1870: print $logfile $reply;
1871: }
1872: # ---------------------------------------- Send update notifications, meta only
1873: my @subscribedmeta=&get_subscribed_hosts("$target.meta");
1874: foreach my $subhost (@subscribedmeta) {
1875: print $logfile "\nNotifying host for metadata only ".$subhost.':';
1876: my $reply=&Apache::lonnet::critical('update:'.$target.'.meta',
1877: $subhost);
1878: print $logfile $reply;
1879: }
1880: # --------------------------------------------------- Notify subscribed courses
1881: my %courses=&coursedependencies($target);
1882: my $now=time;
1883: foreach (keys %courses) {
1884: print $logfile "\nNotifying course ".$_.':';
1885: my ($cdom,$cname)=split(/\_/,$_);
1886: my $reply=&Apache::lonnet::cput
1887: ('versionupdate',{$target => $now},$cdom,$cname);
1888: print $logfile $reply;
1889: }
1890: print $logfile "\n============ Done ============\n";
1891: $logfile->close();
1892: }
1893: if ($lock) { &Apache::lonnet::remove_lock($lock); }
1894: return OK;
1895: }
1896:
1897: #########################################
1898:
1899: sub batchpublish {
1900: my ($r,$srcfile,$targetfile)=@_;
1901: #publication pollutes %env with form.* values
1902: my %oldenv=%env;
1903: $srcfile=~s/\/+/\//g;
1904: $targetfile=~s/\/+/\//g;
1905: $srcfile=~s/\/+/\//g;
1906:
1907: my $docroot=$r->dir_config('lonDocRoot');
1908: my $thisdistarget=$targetfile;
1909: $thisdistarget=~s/^\Q$docroot\E//;
1910:
1911:
1912: %metadatafields=();
1913: %metadatakeys=();
1914: $srcfile=~/\.(\w+)$/;
1915: my $thistype=$1;
1916:
1917:
1918: my $thisembstyle=&Apache::loncommon::fileembstyle($thistype);
1919:
1920: $r->print('<h2>'
1921: .&mt('Publishing [_1]',&Apache::loncfile::display($srcfile))
1922: .'</h2>'
1923: );
1924:
1925: # phase one takes
1926: # my ($source,$target,$style,$batch)=@_;
1927: my ($outstring,$error)=&publish($srcfile,$targetfile,$thisembstyle,1);
1928: $r->print('<p>'.$outstring.'</p>');
1929: # phase two takes
1930: # my ($source,$target,$style,$distarget,batch)=@_;
1931: # $env{'form.allmeta'},$env{'form.title'},$env{'form.author'},...
1932: if (!$error) {
1933: $r->print('<p>');
1934: &phasetwo($r,$srcfile,$targetfile,$thisembstyle,$thisdistarget,1);
1935: $r->print('</p>');
1936: }
1937: %env=%oldenv;
1938: return '';
1939: }
1940:
1941: #########################################
1942:
1943: sub publishdirectory {
1944: my ($r,$fn,$thisdisfn)=@_;
1945: $fn=~s/\/+/\//g;
1946: $thisdisfn=~s/\/+/\//g;
1947: my $thisdisresdir=$thisdisfn;
1948: $thisdisresdir=~s/^\/priv\//\/res\//;
1949: my $resdir = $r->dir_config('lonDocRoot').$thisdisresdir;
1950: $r->print('<form name="pubdirpref" method="post" action="">'
1951: .&Apache::lonhtmlcommon::start_pick_box()
1952: .&Apache::lonhtmlcommon::row_title(&mt('Directory'))
1953: .'<span class="LC_filename">'.$thisdisfn.'</span>'
1954: .&Apache::lonhtmlcommon::row_closure()
1955: .&Apache::lonhtmlcommon::row_title(&mt('Target'))
1956: .'<span class="LC_filename">'.$thisdisresdir.'</span>'
1957: );
1958:
1959: my $dirptr=16384; # Mask indicating a directory in stat.cmode.
1960: unless ($env{'form.phase'} eq 'two') {
1961: # ask user what they want
1962: $r->print(&Apache::lonhtmlcommon::row_closure()
1963: .&Apache::lonhtmlcommon::row_title(&mt('Options'))
1964: );
1965: $r->print(&hiddenfield('phase','two').
1966: &hiddenfield('filename',$env{'form.filename'}).
1967: &checkbox('pubrec','include subdirectories').
1968: &checkbox('forcerepub','force republication of previously published files').
1969: &checkbox('obsolete','make file(s) obsolete').
1970: &checkbox('forceoverride','force directory level metadata over existing')
1971: );
1972: $r->print(&Apache::lonhtmlcommon::row_closure(1)
1973: .&Apache::lonhtmlcommon::end_pick_box()
1974: .'<br /><input type="submit" value="'.&mt('Publish Directory').'" /></form>'
1975: );
1976: $lock=0;
1977: } else {
1978: $r->print(&Apache::lonhtmlcommon::row_closure(1)
1979: .&Apache::lonhtmlcommon::end_pick_box()
1980: );
1981: unless ($lock) { $lock=&Apache::lonnet::set_lock(&mt('Publishing [_1]',$fn)); }
1982: # actually publish things
1983: opendir(DIR,$fn);
1984: my @files=sort(readdir(DIR));
1985: foreach my $filename (@files) {
1986: my ($cdev,$cino,$cmode,$cnlink,
1987: $cuid,$cgid,$crdev,$csize,
1988: $catime,$cmtime,$cctime,
1989: $cblksize,$cblocks)=stat($fn.'/'.$filename);
1990:
1991: my $extension='';
1992: if ($filename=~/\.(\w+)$/) { $extension=$1; }
1993: if ($cmode&$dirptr) {
1994: if (($filename!~/^\./) && ($env{'form.pubrec'})) {
1995: &publishdirectory($r,$fn.'/'.$filename,$thisdisfn.'/'.$filename);
1996: }
1997: } elsif ((&Apache::loncommon::fileembstyle($extension) ne 'hdn') &&
1998: ($filename!~/^[\#\.]/) && ($filename!~/\~$/)) {
1999: # find out publication status and/or exiting metadata
2000: my $publishthis=0;
2001: if (-e $resdir.'/'.$filename) {
2002: my ($rdev,$rino,$rmode,$rnlink,
2003: $ruid,$rgid,$rrdev,$rsize,
2004: $ratime,$rmtime,$rctime,
2005: $rblksize,$rblocks)=stat($resdir.'/'.$filename);
2006: if (($rmtime<$cmtime) || ($env{'form.forcerepub'})) {
2007: # previously published, modified now
2008: $publishthis=1;
2009: }
2010: my $meta_cmtime = (stat($fn.'/'.$filename.'.meta'))[9];
2011: my $meta_rmtime = (stat($resdir.'/'.$filename.'.meta'))[9];
2012: if ( $meta_rmtime<$meta_cmtime ) {
2013: $publishthis=1;
2014: }
2015: } else {
2016: # never published
2017: $publishthis=1;
2018: }
2019:
2020: if ($publishthis) {
2021: &batchpublish($r,$fn.'/'.$filename,$resdir.'/'.$filename);
2022: } else {
2023: $r->print('<br />'.&mt('Skipping').' '.$filename.'<br />');
2024: }
2025: $r->rflush();
2026: }
2027: }
2028: closedir(DIR);
2029: }
2030: }
2031:
2032: #########################################
2033: # publish a default.meta file
2034:
2035: sub defaultmetapublish {
2036: my ($r,$fn,$cuname,$cudom)=@_;
2037: unless (-e $fn) {
2038: return HTTP_NOT_FOUND;
2039: }
2040: my $target=$fn;
2041: $target=~s/^\Q$Apache::lonnet::perlvar{'lonDocRoot'}\E\/priv\//\Q$Apache::lonnet::perlvar{'lonDocRoot'}\E\/res\//;
2042:
2043:
2044: &Apache::loncommon::content_type($r,'text/html');
2045: $r->send_http_header;
2046:
2047: $r->print(&Apache::loncommon::start_page('Metadata Publication'));
2048:
2049: # ---------------------------------------------------------------- Write Source
2050: my $copyfile=$target;
2051:
2052: my @parts=split(/\//,$copyfile);
2053: my $path="/$parts[1]/$parts[2]/$parts[3]/$parts[4]";
2054:
2055: my $count;
2056: for ($count=5;$count<$#parts;$count++) {
2057: $path.="/$parts[$count]";
2058: if ((-e $path)!=1) {
2059: mkdir($path,0777);
2060: $r->print('<p>'
2061: .&mt('Created directory [_1]'
2062: ,'<span class="LC_filename">'.$parts[$count].'</span>')
2063: .'</p>'
2064: );
2065: }
2066: }
2067:
2068: if (copy($fn,$copyfile)) {
2069: $r->print('<p>'.&mt('Copied source file').'</p>');
2070: } else {
2071: return "<span class=\"LC_error\">".
2072: &mt('Failed to copy source').", $!, ".&mt('FAIL')."</span>";
2073: }
2074:
2075: # --------------------------------------------------- Send update notifications
2076:
2077: my @subscribed=&get_subscribed_hosts($target);
2078: foreach my $subhost (@subscribed) {
2079: $r->print('<p>'.&mt('Notifying host').' '.$subhost.':');$r->rflush;
2080: my $reply=&Apache::lonnet::critical('update:'.$target,$subhost);
2081: $r->print($reply.'</p><br />');$r->rflush;
2082: }
2083: # ------------------------------------------------------------------- Link back
2084: $r->print("<a href='".&Apache::loncfile::display($fn)."'>".&mt('Back to Metadata').'</a>');
2085: $r->print(&Apache::loncommon::end_page());
2086: return OK;
2087: }
2088: #########################################
2089:
2090: =pod
2091:
2092: =item B<handler>
2093:
2094: A basic outline of the handler subroutine follows.
2095:
2096: =over 4
2097:
2098: =item *
2099:
2100: Get query string for limited number of parameters.
2101:
2102: =item *
2103:
2104: Check filename.
2105:
2106: =item *
2107:
2108: File is there and owned, init lookup tables.
2109:
2110: =item *
2111:
2112: Start page output.
2113:
2114: =item *
2115:
2116: Evaluate individual file, and then output information.
2117:
2118: =item *
2119:
2120: Publishing from $thisfn to $thistarget with $thisembstyle.
2121:
2122: =back
2123:
2124: =cut
2125:
2126: #########################################
2127: #########################################
2128: sub handler {
2129: my $r=shift;
2130:
2131: if ($r->header_only) {
2132: &Apache::loncommon::content_type($r,'text/html');
2133: $r->send_http_header;
2134: return OK;
2135: }
2136:
2137: # Get query string for limited number of parameters
2138:
2139: &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},
2140: ['filename']);
2141:
2142: # -------------------------------------- Flag and buffer for registered cleanup
2143: $registered_cleanup=0;
2144: @{$modified_urls}=();
2145: # -------------------------------------------------------------- Check filename
2146:
2147: my $fn=&unescape($env{'form.filename'});
2148: ($cuname,$cudom)=&Apache::lonnet::constructaccess($fn);
2149: # ----------------------------------------------------- Do we have permissions?
2150: unless (($cuname) && ($cudom)) {
2151: $r->log_reason($env{'user.name'}.' at '.$env{'user.domain'}.
2152: ' trying to publish file '.$env{'form.filename'}.
2153: ' - not authorized',
2154: $r->filename);
2155: return HTTP_NOT_ACCEPTABLE;
2156: }
2157: # ----------------------------------------------------------------- Get docroot
2158: $docroot=$r->dir_config('lonDocRoot');
2159:
2160:
2161: # special publication: default.meta file
2162: if ($fn=~/\/default.meta$/) {
2163: return &defaultmetapublish($r,$fn,$cuname,$cudom);
2164: }
2165: $fn=~s/\.meta$//;
2166:
2167: # sanity test on the filename
2168:
2169: unless ($fn) {
2170: $r->log_reason($cuname.' at '.$cudom.
2171: ' trying to publish empty filename', $r->filename);
2172: return HTTP_NOT_FOUND;
2173: }
2174:
2175: unless (-e $docroot.$fn) {
2176: $r->log_reason($cuname.' at '.$cudom.
2177: ' trying to publish non-existing file '.
2178: $env{'form.filename'}.' ('.$fn.')',
2179: $r->filename);
2180: return HTTP_NOT_FOUND;
2181: }
2182:
2183: # -------------------------------- File is there and owned, init lookup tables.
2184:
2185: %addid=();
2186:
2187: {
2188: my $fh=Apache::File->new($r->dir_config('lonTabDir').'/addid.tab');
2189: while (<$fh>=~/(\w+)\s+(\w+)/) {
2190: $addid{$1}=$2;
2191: }
2192: }
2193:
2194: %nokey=();
2195:
2196: {
2197: my $fh=Apache::File->new($r->dir_config('lonIncludes').'/un_keyword.tab');
2198: while (<$fh>) {
2199: my $word=$_;
2200: chomp($word);
2201: $nokey{$word}=1;
2202: }
2203: }
2204:
2205: # ---------------------------------------------------------- Start page output.
2206:
2207: &Apache::loncommon::content_type($r,'text/html');
2208: $r->send_http_header;
2209:
2210: # Breadcrumbs
2211: &Apache::lonhtmlcommon::clear_breadcrumbs();
2212: &Apache::lonhtmlcommon::add_breadcrumb({
2213: 'text' => 'Authoring Space',
2214: 'href' => &Apache::loncommon::authorspace($fn),
2215: });
2216: &Apache::lonhtmlcommon::add_breadcrumb({
2217: 'text' => 'Resource Publication',
2218: 'href' => '',
2219: });
2220:
2221: my $js='<script type="text/javascript">'.
2222: &Apache::loncommon::browser_and_searcher_javascript().
2223: '</script>';
2224: $r->print(&Apache::loncommon::start_page('Resource Publication',$js)
2225: .&Apache::lonhtmlcommon::breadcrumbs()
2226: .&Apache::loncommon::head_subbox(
2227: &Apache::loncommon::CSTR_pageheader($docroot.$fn))
2228: );
2229:
2230: my $thisdisfn=&HTML::Entities::encode($fn,'<>&"');
2231: my $thistarget=$fn;
2232: $thistarget=~s/^\/priv\//\/res\//;
2233: my $thisdistarget=&HTML::Entities::encode($thistarget,'<>&"');
2234:
2235: if ($fn=~/\/$/) {
2236: # -------------------------------------------------------- This is a directory
2237: &publishdirectory($r,$docroot.$fn,$thisdisfn);
2238: $r->print(
2239: '<br /><br />'.
2240: &Apache::lonhtmlcommon::actionbox([
2241: '<a href="'.$thisdisfn.'">'.&mt('Return to Directory').'</a>']));
2242: } else {
2243: # ---------------------- Evaluate individual file, and then output information.
2244: $fn=~/\.(\w+)$/;
2245: my $thistype=$1;
2246: my $thisembstyle=&Apache::loncommon::fileembstyle($thistype);
2247: if ($thistype eq 'page') { $thisembstyle = 'rat'; }
2248:
2249: $r->print('<h2>'
2250: .&mt('Publishing [_1]'
2251: ,'<span class="LC_filename">'.$thisdisfn.'</span>')
2252: .'</h2>'
2253: );
2254:
2255: $r->print('<h3>'.&mt('Resource Details').'</h3>');
2256:
2257: $r->print(&Apache::lonhtmlcommon::start_pick_box());
2258:
2259: $r->print(&Apache::lonhtmlcommon::row_title(&mt('Type'))
2260: .&Apache::loncommon::filedescription($thistype)
2261: .&Apache::lonhtmlcommon::row_closure()
2262: );
2263:
2264: $r->print(&Apache::lonhtmlcommon::row_title(&mt('Link to Resource'))
2265: .'<tt>'
2266: );
2267: $r->print(<<ENDCAPTION);
2268: <a href='javascript:void(window.open("$thisdisfn","cat","height=300,width=500,scrollbars=1,resizable=1,menubar=0,location=1"))'>
2269: $thisdisfn</a>
2270: ENDCAPTION
2271: $r->print('</tt>'
2272: .&Apache::lonhtmlcommon::row_closure()
2273: );
2274:
2275: $r->print(&Apache::lonhtmlcommon::row_title(&mt('Target'))
2276: .'<tt>'.$thisdistarget.'</tt>'
2277: );
2278: if (($cuname ne $env{'user.name'})||($cudom ne $env{'user.domain'})) {
2279: $r->print(&Apache::lonhtmlcommon::row_closure()
2280: .&Apache::lonhtmlcommon::row_title(&mt('Co-Author'))
2281: .'<span class="LC_warning">'
2282: .&Apache::loncommon::plainname($cuname,$cudom) .' ('.$cuname.':'.$cudom.')'
2283: .'</span>'
2284: );
2285: }
2286:
2287: if (&Apache::loncommon::fileembstyle($thistype) eq 'ssi') {
2288: $r->print(&Apache::lonhtmlcommon::row_closure()
2289: .&Apache::lonhtmlcommon::row_title(&mt('Diffs')));
2290: $r->print(<<ENDDIFF);
2291: <a href='javascript:void(window.open("/adm/diff?filename=$thisdisfn&versiontwo=priv","cat","height=300,width=500,scrollbars=1,resizable=1,menubar=0,location=1"))'>
2292: ENDDIFF
2293: $r->print(&mt('Diffs with Current Version').'</a>');
2294: }
2295:
2296: $r->print(&Apache::lonhtmlcommon::row_closure(1)
2297: .&Apache::lonhtmlcommon::end_pick_box()
2298: );
2299:
2300: # ---------------------- Publishing from $fn to $thistarget with $thisembstyle.
2301:
2302: unless ($env{'form.phase'} eq 'two') {
2303: # ---------------------------------------------------------- Parse for problems
2304: my ($warningcount,$errorcount);
2305: if ($thisembstyle eq 'ssi') {
2306: ($warningcount,$errorcount)=&checkonthis($r,$fn);
2307: }
2308: unless ($errorcount) {
2309: my ($outstring,$error)=
2310: &publish($docroot.$fn,$docroot.$thistarget,$thisembstyle);
2311: $r->print($outstring);
2312: } else {
2313: $r->print('<h3 class="LC_error">'.
2314: &mt('The document contains errors and cannot be published.').
2315: '</h3>');
2316: }
2317: } else {
2318: &phasetwo($r,$docroot.$fn,$docroot.$thistarget,$thisembstyle,$thisdistarget);
2319: }
2320: }
2321: $r->print(&Apache::loncommon::end_page());
2322:
2323: return OK;
2324: }
2325:
2326: 1;
2327: __END__
2328:
2329: =pod
2330:
2331: =back
2332:
2333: =cut
2334:
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