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