1: # The LearningOnline Network with CAPA
2: # Publication Handler
3: #
4: # $Id: lonpublisher.pm,v 1.267.2.1 2011/11/07 13:38:45 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</~authorname/> space. They can
70: copy resources into the resource area through the publication step,
71: and move them back through a recover step. Authors do not have direct
72: 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 '<div><b>'
270: .&mt('No file: [_1]'
271: ,'</b> <tt>'.&Apache::loncfile::display($fn).'</tt></div>');
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 '<div><b>'
281: .&mt('Processed file: [_1]'
282: ,'</b> <tt>'.&Apache::loncfile::display($fn).'</tt></div>');
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: $thisdisfn=~s/^\/home\/\Q$cuname\E\///;
1084:
1085: my @urlparts=split(/\//,$thisdisfn);
1086: $#urlparts--;
1087:
1088: my $currentpath='/home/'.$cuname.'/';
1089:
1090: my $prefix='../'x($#urlparts);
1091: foreach (@urlparts) {
1092: $currentpath.=$_.'/';
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: my $thissrc=$source;
1227: $thissrc=~s{^/home/($match_username)/public_html}{/priv/$1};
1228: $intr_scrout.='<p class="LC_warning">'
1229: .&mt('Searching for your resource will be based on the following metadata. Please provide as much data as possible.')
1230: .'</p>'
1231: .'<p><input type="submit" value="'
1232: .&mt('Finalize Publication')
1233: .'" /> <a href="'.$thissrc.'">'.&mt('Cancel').'</a></p>';
1234: }
1235: $intr_scrout.=&Apache::lonhtmlcommon::start_pick_box();
1236: $intr_scrout.=
1237: &hiddenfield('phase','two').
1238: &hiddenfield('filename',$env{'form.filename'}).
1239: &hiddenfield('allmeta',&escape($allmeta)).
1240: &hiddenfield('dependencies',join(',',keys %allow));
1241: unless ($env{'form.makeobsolete'}) {
1242: $intr_scrout.=
1243: &textfield('Title','title',$metadatafields{'title'}).
1244: &textfield('Author(s)','author',$metadatafields{'author'}).
1245: &textfield('Subject','subject',$metadatafields{'subject'});
1246: # --------------------------------------------------- Scan content for keywords
1247:
1248: my $keywords_help = &Apache::loncommon::help_open_topic("Publishing_Keywords");
1249: my $keywordout=<<"END";
1250: <script>
1251: function checkAll(field) {
1252: for (i = 0; i < field.length; i++)
1253: field[i].checked = true ;
1254: }
1255:
1256: function uncheckAll(field) {
1257: for (i = 0; i < field.length; i++)
1258: field[i].checked = false ;
1259: }
1260: </script>
1261: END
1262: $keywordout.="\n".&Apache::lonhtmlcommon::row_title(&mt('Keywords'))
1263: .$keywords_help
1264: .'<input type="button" value="'.&mt('check all').'" onclick="javascript:checkAll(document.pubform.keywords)" />'
1265: .'<input type="button" value="'.&mt('uncheck all').'" onclick="javascript:uncheckAll(document.pubform.keywords)" />'
1266: .'</p><br />'
1267: .&Apache::loncommon::start_data_table();
1268: my $cols_per_row = 10;
1269: my $colcount=0;
1270: my $wordcount=0;
1271: my $numkeywords = scalar(keys(%keywords));
1272:
1273: foreach my $word (sort(keys(%keywords))) {
1274: if ($colcount == 0) {
1275: $keywordout .= &Apache::loncommon::start_data_table_row();
1276: }
1277: $colcount++;
1278: $wordcount++;
1279: if (($wordcount == $numkeywords) && ($colcount < $cols_per_row)) {
1280: my $colspan = 1+$cols_per_row-$colcount;
1281: $keywordout .= '<td colspan="'.$colspan.'">';
1282: } else {
1283: $keywordout .= '<td>';
1284: }
1285: $keywordout.='<label><input type="checkbox" name="keywords" value="'.$word.'"';
1286: if ($metadatafields{'keywords'}) {
1287: if ($metadatafields{'keywords'}=~/\Q$word\E/) {
1288: $keywordout.=' checked="checked"';
1289: $env{'form.keywords'}.=$word.',';
1290: }
1291: } elsif (&Apache::loncommon::keyword($word)) {
1292: $keywordout.=' checked="checked"';
1293: $env{'form.keywords'}.=$word.',';
1294: }
1295: $keywordout.=' />'.$word.'</label></td>';
1296: if ($colcount == $cols_per_row) {
1297: $keywordout.=&Apache::loncommon::end_data_table_row();
1298: $colcount=0;
1299: }
1300: }
1301: if ($colcount > 0) {
1302: $keywordout .= &Apache::loncommon::end_data_table_row();
1303: }
1304:
1305: $env{'form.keywords'}=~s/\,$//;
1306:
1307: $keywordout.=&Apache::loncommon::end_data_table_row()
1308: .&Apache::loncommon::end_data_table()
1309: .&Apache::lonhtmlcommon::row_closure();
1310:
1311: $intr_scrout.=$keywordout;
1312:
1313: $intr_scrout.=&textfield('Additional Keywords','addkey','');
1314:
1315: $intr_scrout.=&textfield('Notes','notes',$metadatafields{'notes'});
1316:
1317: $intr_scrout.="\n".&Apache::lonhtmlcommon::row_title(&mt('Abstract'))
1318: .'<textarea cols="80" rows="5" name="abstract">'
1319: .$metadatafields{'abstract'}
1320: .'</textarea>'
1321: .&Apache::lonhtmlcommon::row_closure();
1322:
1323: $source=~/\.(\w+)$/;
1324:
1325: $intr_scrout.="\n".&Apache::lonhtmlcommon::row_title(&mt('Grade Levels'))
1326: .&mt('Lowest Grade Level:').' '
1327: .&select_level_form($metadatafields{'lowestgradelevel'},'lowestgradelevel')
1328: # .&Apache::lonhtmlcommon::row_closure();
1329: # $intr_scrout.="\n".&Apache::lonhtmlcommon::row_title(&mt('Highest Grade Level'))
1330: .' '.&mt('Highest Grade Level:').' '
1331: .&select_level_form($metadatafields{'highestgradelevel'},'highestgradelevel')
1332: .&Apache::lonhtmlcommon::row_closure();
1333:
1334: $intr_scrout.=&textfield('Standards','standards',$metadatafields{'standards'});
1335:
1336: $intr_scrout.=&hiddenfield('mime',$1);
1337:
1338: my $defaultlanguage=$metadatafields{'language'};
1339: $defaultlanguage =~ s/\s*notset\s*//g;
1340: $defaultlanguage =~ s/^,\s*//g;
1341: $defaultlanguage =~ s/,\s*$//g;
1342:
1343: $intr_scrout.=&selectbox('Language','language',
1344: $defaultlanguage,
1345: \&Apache::loncommon::languagedescription,
1346: (&Apache::loncommon::languageids),
1347: );
1348:
1349: unless ($metadatafields{'creationdate'}) {
1350: $metadatafields{'creationdate'}=time;
1351: }
1352: $intr_scrout.=&hiddenfield('creationdate',
1353: &Apache::lonmysql::unsqltime($metadatafields{'creationdate'}));
1354:
1355: $intr_scrout.=&hiddenfield('lastrevisiondate',time);
1356:
1357: my $pubowner_last;
1358: if ($style eq 'prv') {
1359: $pubowner_last = 1;
1360: }
1361: $intr_scrout.=&textfield('Publisher/Owner','owner',
1362: $metadatafields{'owner'},$pubowner_last);
1363:
1364: # ---------------------------------------------- Retrofix for unused copyright
1365: if ($metadatafields{'copyright'} eq 'free') {
1366: $metadatafields{'copyright'}='default';
1367: $metadatafields{'sourceavail'}='open';
1368: }
1369: if ($metadatafields{'copyright'} eq 'priv') {
1370: $metadatafields{'copyright'}='domain';
1371: }
1372: # ------------------------------------------------ Dial in reasonable defaults
1373: my $defaultoption=$metadatafields{'copyright'};
1374: unless ($defaultoption) { $defaultoption='default'; }
1375: my $defaultsourceoption=$metadatafields{'sourceavail'};
1376: unless ($defaultsourceoption) { $defaultsourceoption='closed'; }
1377: unless ($style eq 'prv') {
1378: # -------------------------------------------------- Correct copyright for rat.
1379: if ($style eq 'rat') {
1380: # -------------------------------------- Retrofix for non-applicable copyright
1381: if ($metadatafields{'copyright'} eq 'public') {
1382: delete $metadatafields{'copyright'};
1383: $defaultoption='default';
1384: }
1385: $intr_scrout.=&selectbox('Copyright/Distribution','copyright',
1386: $defaultoption,
1387: \&Apache::loncommon::copyrightdescription,
1388: (grep !/^(public|priv)$/,(&Apache::loncommon::copyrightids)));
1389: } else {
1390: $intr_scrout.=&selectbox('Copyright/Distribution','copyright',
1391: $defaultoption,
1392: \&Apache::loncommon::copyrightdescription,
1393: (grep !/^priv$/,(&Apache::loncommon::copyrightids)));
1394: }
1395: my $copyright_help =
1396: &Apache::loncommon::help_open_topic('Publishing_Copyright');
1397: my $replace=&mt('Copyright/Distribution:');
1398: $intr_scrout =~ s/$replace/$replace.' '.$copyright_help/ge;
1399:
1400: $intr_scrout.=&text_with_browse_field('Custom Distribution File','customdistributionfile',$metadatafields{'customdistributionfile'},'rights');
1401: $intr_scrout.=&selectbox('Source Distribution','sourceavail',
1402: $defaultsourceoption,
1403: \&Apache::loncommon::source_copyrightdescription,
1404: (&Apache::loncommon::source_copyrightids));
1405: # $intr_scrout.=&text_with_browse_field('Source Custom Distribution File','sourcerights',$metadatafields{'sourcerights'},'rights');
1406: my $uctitle=&mt('Obsolete');
1407: my $obsolete_checked=($metadatafields{'obsolete'})?' checked="checked"':'';
1408: $intr_scrout.="\n".&Apache::lonhtmlcommon::row_title($uctitle)
1409: .'<input type="checkbox" name="obsolete"'.$obsolete_checked.' />'
1410: .&Apache::lonhtmlcommon::row_closure(1);
1411: $intr_scrout.=&text_with_browse_field('Suggested Replacement for Obsolete File',
1412: 'obsoletereplacement',
1413: $metadatafields{'obsoletereplacement'},'',1);
1414: } else {
1415: $intr_scrout.=&hiddenfield('copyright','private');
1416: }
1417: } else {
1418: $intr_scrout.=
1419: &hiddenfield('title',$metadatafields{'title'}).
1420: &hiddenfield('author',$metadatafields{'author'}).
1421: &hiddenfield('subject',$metadatafields{'subject'}).
1422: &hiddenfield('keywords',$metadatafields{'keywords'}).
1423: &hiddenfield('abstract',$metadatafields{'abstract'}).
1424: &hiddenfield('notes',$metadatafields{'notes'}).
1425: &hiddenfield('mime',$metadatafields{'mime'}).
1426: &hiddenfield('creationdate',$metadatafields{'creationdate'}).
1427: &hiddenfield('lastrevisiondate',time).
1428: &hiddenfield('owner',$metadatafields{'owner'}).
1429: &hiddenfield('lowestgradelevel',$metadatafields{'lowestgradelevel'}).
1430: &hiddenfield('standards',$metadatafields{'standards'}).
1431: &hiddenfield('highestgradelevel',$metadatafields{'highestgradelevel'}).
1432: &hiddenfield('language',$metadatafields{'language'}).
1433: &hiddenfield('copyright',$metadatafields{'copyright'}).
1434: &hiddenfield('sourceavail',$metadatafields{'sourceavail'}).
1435: &hiddenfield('customdistributionfile',$metadatafields{'customdistributionfile'}).
1436: &hiddenfield('obsolete',1).
1437: &text_with_browse_field('Suggested Replacement for Obsolete File',
1438: 'obsoletereplacement',
1439: $metadatafields{'obsoletereplacement'},'',1);
1440: }
1441: if (!$batch) {
1442: $scrout.=$intr_scrout
1443: .&Apache::lonhtmlcommon::end_pick_box()
1444: .'<p><input type="submit" value="'
1445: .&mt($env{'form.makeobsolete'}?'Make Obsolete':'Finalize Publication')
1446: .'" /></p>'
1447: .'</form>';
1448: }
1449: return($scrout,0);
1450: }
1451:
1452: #########################################
1453: #########################################
1454:
1455: =pod
1456:
1457: =item B<phasetwo>
1458:
1459: Render second interface showing status of publication steps.
1460: This is publication step two.
1461:
1462: Parameters:
1463:
1464: =over 4
1465:
1466: =item I<$source>
1467:
1468: =item I<$target>
1469:
1470: =item I<$style>
1471:
1472: =item I<$distarget>
1473:
1474: =back
1475:
1476: Returns:
1477:
1478: =over 4
1479:
1480: =item integer
1481:
1482: 0: fail
1483: 1: success
1484:
1485: =cut
1486:
1487: #'stupid emacs
1488: #########################################
1489: #########################################
1490: sub phasetwo {
1491:
1492: my ($r,$source,$target,$style,$distarget,$batch)=@_;
1493: $source=~s/\/+/\//g;
1494: $target=~s/\/+/\//g;
1495: #
1496: # Unless trying to get rid of something, check name validity
1497: #
1498: unless ($env{'form.obsolete'}) {
1499: if ($target=~/(\_\_\_|\&\&\&|\:\:\:)/) {
1500: $r->print('<span class="LC_error">'.
1501: &mt('Unsupported character combination [_1] in filename, FAIL.',"<tt>'.$1.'</tt>").
1502: '</span>');
1503: return 0;
1504: }
1505: unless ($target=~/\.(\w+)$/) {
1506: $r->print('<span class="LC_error">'.&mt('No valid extension found in filename, FAIL').'</span>');
1507: return 0;
1508: }
1509: if ($target=~/\.(\d+)\.(\w+)$/) {
1510: $r->print('<span class="LC_error">'.&mt('Filename of resource contains internal version number. Cannot publish such resources, FAIL').'</span>');
1511: return 0;
1512: }
1513: }
1514:
1515: #
1516: # End name check
1517: #
1518: $distarget=~s/\/+/\//g;
1519: my $logfile;
1520: unless ($logfile=Apache::File->new('>>'.$source.'.log')) {
1521: $r->print(
1522: '<span class="LC_error">'.
1523: &mt('No write permission to user directory, FAIL').'</span>');
1524: return 0;
1525: }
1526:
1527: if ($source =~ /\.rights$/) {
1528: $r->print('<p><span class="LC_warning">'.&mt('Warning: It can take up to 1 hour for rights changes to fully propagate.').'</span></p>');
1529: }
1530:
1531: print $logfile
1532: "\n================= Publish ".localtime()." Phase Two ================\n".$env{'user.name'}.':'.$env{'user.domain'}."\n";
1533:
1534: %metadatafields=();
1535: %metadatakeys=();
1536:
1537: &metaeval(&unescape($env{'form.allmeta'}));
1538:
1539: $metadatafields{'title'}=$env{'form.title'};
1540: $metadatafields{'author'}=$env{'form.author'};
1541: $metadatafields{'subject'}=$env{'form.subject'};
1542: $metadatafields{'notes'}=$env{'form.notes'};
1543: $metadatafields{'abstract'}=$env{'form.abstract'};
1544: $metadatafields{'mime'}=$env{'form.mime'};
1545: $metadatafields{'language'}=$env{'form.language'};
1546: $metadatafields{'creationdate'}=$env{'form.creationdate'};
1547: $metadatafields{'lastrevisiondate'}=$env{'form.lastrevisiondate'};
1548: $metadatafields{'owner'}=$env{'form.owner'};
1549: $metadatafields{'copyright'}=$env{'form.copyright'};
1550: $metadatafields{'standards'}=$env{'form.standards'};
1551: $metadatafields{'lowestgradelevel'}=$env{'form.lowestgradelevel'};
1552: $metadatafields{'highestgradelevel'}=$env{'form.highestgradelevel'};
1553: $metadatafields{'customdistributionfile'}=
1554: $env{'form.customdistributionfile'};
1555: $metadatafields{'sourceavail'}=$env{'form.sourceavail'};
1556: $metadatafields{'obsolete'}=$env{'form.obsolete'};
1557: $metadatafields{'obsoletereplacement'}=
1558: $env{'form.obsoletereplacement'};
1559: $metadatafields{'dependencies'}=$env{'form.dependencies'};
1560: $metadatafields{'modifyinguser'}=$env{'user.name'}.':'.
1561: $env{'user.domain'};
1562: $metadatafields{'authorspace'}=$cuname.':'.$cudom;
1563: $metadatafields{'domain'}=$cudom;
1564:
1565: my $allkeywords=$env{'form.addkey'};
1566: if (exists($env{'form.keywords'})) {
1567: if (ref($env{'form.keywords'})) {
1568: $allkeywords .= ','.join(',',@{$env{'form.keywords'}});
1569: } else {
1570: $allkeywords .= ','.$env{'form.keywords'};
1571: }
1572: }
1573: $allkeywords=~s/[\"\']//g;
1574: $allkeywords=~s/\s*[\;\,]\s*/\,/g;
1575: $allkeywords=~s/\s+/ /g;
1576: $allkeywords=~s/^[ \,]//;
1577: $allkeywords=~s/[ \,]$//;
1578: $metadatafields{'keywords'}=$allkeywords;
1579:
1580: # check if custom distribution file is specified
1581: if ($metadatafields{'copyright'} eq 'custom') {
1582: my $file=$metadatafields{'customdistributionfile'};
1583: unless ($file=~/\.rights$/) {
1584: $r->print(
1585: '<span class="LC_error">'.&mt('No valid custom distribution rights file specified, FAIL').
1586: '</span>');
1587: return 0;
1588: }
1589: }
1590: {
1591: print $logfile "\nWrite metadata file for ".$source;
1592: my $mfh;
1593: unless ($mfh=Apache::File->new('>'.$source.'.meta')) {
1594: $r->print(
1595: '<span class="LC_error">'.&mt('Could not write metadata, FAIL').
1596: '</span>');
1597: return 0;
1598: }
1599: foreach (sort keys %metadatafields) {
1600: unless ($_=~/\./) {
1601: my $unikey=$_;
1602: $unikey=~/^([A-Za-z]+)/;
1603: my $tag=$1;
1604: $tag=~tr/A-Z/a-z/;
1605: print $mfh "\n\<$tag";
1606: foreach (split(/\,/,$metadatakeys{$unikey})) {
1607: my $value=$metadatafields{$unikey.'.'.$_};
1608: $value=~s/\"/\'\'/g;
1609: print $mfh ' '.$_.'="'.$value.'"';
1610: }
1611: print $mfh '>'.
1612: &HTML::Entities::encode($metadatafields{$unikey},'<>&"')
1613: .'</'.$tag.'>';
1614: }
1615: }
1616: $r->print('<p>'.&mt('Wrote Metadata').'</p>');
1617: print $logfile "\nWrote metadata";
1618: }
1619:
1620: # -------------------------------- Synchronize entry with SQL metadata database
1621:
1622: $metadatafields{'url'} = $distarget;
1623: $metadatafields{'version'} = 'current';
1624:
1625: my ($error,$success) = &store_metadata(%metadatafields);
1626: if ($success) {
1627: $r->print('<p>'.&mt('Synchronized SQL metadata database').'</p>');
1628: print $logfile "\nSynchronized SQL metadata database";
1629: } else {
1630: $r->print($error);
1631: print $logfile "\n".$error;
1632: }
1633: # --------------------------------------------- Delete author resource messages
1634: my $delresult=&Apache::lonmsg::del_url_author_res_msg($target);
1635: $r->print('<p>'.&mt('Removing error messages:').' '.$delresult.'</p>');
1636: print $logfile "\nRemoving error messages: $delresult";
1637: # ----------------------------------------------------------- Copy old versions
1638:
1639: if (-e $target) {
1640: my $filename;
1641: my $maxversion=0;
1642: $target=~/(.*)\/([^\/]+)\.(\w+)$/;
1643: my $srcf=$2;
1644: my $srct=$3;
1645: my $srcd=$1;
1646: my $docroot = $Apache::lonnet::perlvar{'lonDocRoot'};
1647: unless ($srcd=~/^\Q$docroot\E\/res/) {
1648: print $logfile "\nPANIC: Target dir is ".$srcd;
1649: $r->print(
1650: "<span class=\"LC_error\">".&mt('Invalid target directory, FAIL')."</span>");
1651: return 0;
1652: }
1653: opendir(DIR,$srcd);
1654: while ($filename=readdir(DIR)) {
1655: if (-l $srcd.'/'.$filename) {
1656: unlink($srcd.'/'.$filename);
1657: unlink($srcd.'/'.$filename.'.meta');
1658: } else {
1659: if ($filename=~/^\Q$srcf\E\.(\d+)\.\Q$srct\E$/) {
1660: $maxversion=($1>$maxversion)?$1:$maxversion;
1661: }
1662: }
1663: }
1664: closedir(DIR);
1665: $maxversion++;
1666: $r->print('<p>'.&mt('Creating old version [_1]',$maxversion).'</p>');
1667: print $logfile "\nCreating old version ".$maxversion."\n";
1668:
1669: my $copyfile=$srcd.'/'.$srcf.'.'.$maxversion.'.'.$srct;
1670:
1671: if (copy($target,$copyfile)) {
1672: print $logfile "Copied old target to ".$copyfile."\n";
1673: $r->print(&Apache::lonhtmlcommon::confirm_success(&mt('Copied old target file')));
1674: } else {
1675: print $logfile "Unable to write ".$copyfile.':'.$!."\n";
1676: $r->print(&Apache::lonhtmlcommon::confirm_success(&mt('Failed to copy old target').", $!",1));
1677: return 0;
1678: }
1679:
1680: # --------------------------------------------------------------- Copy Metadata
1681:
1682: $copyfile=$copyfile.'.meta';
1683:
1684: if (copy($target.'.meta',$copyfile)) {
1685: print $logfile "Copied old target metadata to ".$copyfile."\n";
1686: $r->print(&Apache::lonhtmlcommon::confirm_success(&mt('Copied old metadata')));
1687: } else {
1688: print $logfile "Unable to write metadata ".$copyfile.':'.$!."\n";
1689: if (-e $target.'.meta') {
1690: $r->print(&Apache::lonhtmlcommon::confirm_success(
1691: &mt('Failed to write old metadata copy').", $!",1));
1692: return 0;
1693: }
1694: }
1695:
1696:
1697: } else {
1698: $r->print('<p>'.&mt('Initial version').'</p>');
1699: print $logfile "\nInitial version";
1700: }
1701:
1702: # ---------------------------------------------------------------- Write Source
1703: my $copyfile=$target;
1704:
1705: my @parts=split(/\//,$copyfile);
1706: my $path="/$parts[1]/$parts[2]/$parts[3]/$parts[4]";
1707:
1708: my $count;
1709: for ($count=5;$count<$#parts;$count++) {
1710: $path.="/$parts[$count]";
1711: if ((-e $path)!=1) {
1712: print $logfile "\nCreating directory ".$path;
1713: mkdir($path,0777);
1714: $r->print('<p>'
1715: .&mt('Created directory [_1]'
1716: ,'<span class="LC_filename">'.$parts[$count].'</span>')
1717: .'</p>'
1718: );
1719: }
1720: }
1721:
1722: if (copy($source,$copyfile)) {
1723: print $logfile "\nCopied original source to ".$copyfile."\n";
1724: $r->print(&Apache::lonhtmlcommon::confirm_success(&mt('Copied source file')));
1725: } else {
1726: print $logfile "\nUnable to write ".$copyfile.':'.$!."\n";
1727: $r->print(&Apache::lonhtmlcommon::confirm_success(
1728: &mt('Failed to copy source').", $!",1));
1729: return 0;
1730: }
1731:
1732: # ---------------------------------------------- Delete local tmp-preview files
1733: unlink($copyfile.'.tmp');
1734: # --------------------------------------------------------------- Copy Metadata
1735:
1736: $copyfile=$copyfile.'.meta';
1737:
1738: if (copy($source.'.meta',$copyfile)) {
1739: print $logfile "\nCopied original metadata to ".$copyfile."\n";
1740: $r->print(&Apache::lonhtmlcommon::confirm_success(&mt('Copied metadata')));
1741: } else {
1742: print $logfile "\nUnable to write metadata ".$copyfile.':'.$!."\n";
1743: $r->print(&Apache::lonhtmlcommon::confirm_success(
1744: &mt('Failed to write metadata copy').", $!",1));
1745: return 0;
1746: }
1747: $r->rflush;
1748:
1749: # ------------------------------------------------------------- Trigger updates
1750: push(@{$modified_urls},[$target,$source]);
1751: unless ($registered_cleanup) {
1752: my $handlers = $r->get_handlers('PerlCleanupHandler');
1753: $r->set_handlers('PerlCleanupHandler' => [\¬ify,@{$handlers}]);
1754: $registered_cleanup=1;
1755: }
1756:
1757: # ---------------------------------------------------------- Clear local caches
1758: my $thisdistarget=$target;
1759: $thisdistarget=~s/^\Q$docroot\E//;
1760: &Apache::lonnet::devalidate_cache_new('resversion',$target);
1761: &Apache::lonnet::devalidate_cache_new('meta',
1762: &Apache::lonnet::declutter($thisdistarget));
1763:
1764: # ------------------------------------------------------------- Everything done
1765: $logfile->close();
1766: $r->print('<p class="LC_success">'.&mt('Done').'</p>');
1767:
1768: # ------------------------------------------------ Provide link to new resource
1769: unless ($batch) {
1770: my $thissrc=$source;
1771: $thissrc=~s{^/home/($match_username)/public_html}{/priv/$1};
1772:
1773: my $thissrcdir=$thissrc;
1774: $thissrcdir=~s/\/[^\/]+$/\//;
1775:
1776: $r->print(&Apache::loncommon::head_subbox(
1777: &Apache::lonhtmlcommon::start_funclist().
1778: &Apache::lonhtmlcommon::add_item_funclist(
1779: '<a href="'.$thisdistarget.'">'.
1780: &mt('View Published Version').
1781: '</a>').
1782: &Apache::lonhtmlcommon::add_item_funclist(
1783: '<a href="'.$thissrc.'">'.
1784: &mt('Back to Source').
1785: '</a>').
1786: &Apache::lonhtmlcommon::add_item_funclist(
1787: '<a href="'.$thissrcdir.'">'.
1788: &mt('Back to Source Directory').
1789: '</a>').
1790: &Apache::lonhtmlcommon::end_funclist())
1791: );
1792: }
1793: return 1;
1794: }
1795:
1796: # =============================================================== Notifications
1797: sub notify {
1798: # --------------------------------------------------- Send update notifications
1799: foreach my $targetsource (@{$modified_urls}){
1800: my ($target,$source)=@{$targetsource};
1801: my $logfile=Apache::File->new('>>'.$source.'.log');
1802: print $logfile "\nCleanup phase: Notifications\n";
1803: my @subscribed=&get_subscribed_hosts($target);
1804: foreach my $subhost (@subscribed) {
1805: print $logfile "\nNotifying host ".$subhost.':';
1806: my $reply=&Apache::lonnet::critical('update:'.$target,$subhost);
1807: print $logfile $reply;
1808: }
1809: # ---------------------------------------- Send update notifications, meta only
1810: my @subscribedmeta=&get_subscribed_hosts("$target.meta");
1811: foreach my $subhost (@subscribedmeta) {
1812: print $logfile "\nNotifying host for metadata only ".$subhost.':';
1813: my $reply=&Apache::lonnet::critical('update:'.$target.'.meta',
1814: $subhost);
1815: print $logfile $reply;
1816: }
1817: # --------------------------------------------------- Notify subscribed courses
1818: my %courses=&coursedependencies($target);
1819: my $now=time;
1820: foreach (keys %courses) {
1821: print $logfile "\nNotifying course ".$_.':';
1822: my ($cdom,$cname)=split(/\_/,$_);
1823: my $reply=&Apache::lonnet::cput
1824: ('versionupdate',{$target => $now},$cdom,$cname);
1825: print $logfile $reply;
1826: }
1827: print $logfile "\n============ Done ============\n";
1828: $logfile->close();
1829: }
1830: if ($lock) { &Apache::lonnet::remove_lock($lock); }
1831: return OK;
1832: }
1833:
1834: #########################################
1835:
1836: sub batchpublish {
1837: my ($r,$srcfile,$targetfile)=@_;
1838: #publication pollutes %env with form.* values
1839: my %oldenv=%env;
1840: $srcfile=~s/\/+/\//g;
1841: $targetfile=~s/\/+/\//g;
1842: my $thisdisfn=$srcfile;
1843: $thisdisfn=~s/\/home\/korte\/public_html\///;
1844: $srcfile=~s/\/+/\//g;
1845:
1846: my $docroot=$r->dir_config('lonDocRoot');
1847: my $thisdistarget=$targetfile;
1848: $thisdistarget=~s/^\Q$docroot\E//;
1849:
1850:
1851: %metadatafields=();
1852: %metadatakeys=();
1853: $srcfile=~/\.(\w+)$/;
1854: my $thistype=$1;
1855:
1856:
1857: my $thisembstyle=&Apache::loncommon::fileembstyle($thistype);
1858:
1859: $r->print('<h2>'
1860: .&mt('Publishing [_1]'
1861: ,'<span class="LC_filename">'.$thisdisfn.'</span>')
1862: .'</h2>'
1863: );
1864:
1865: # phase one takes
1866: # my ($source,$target,$style,$batch)=@_;
1867: my ($outstring,$error)=&publish($srcfile,$targetfile,$thisembstyle,1);
1868: $r->print('<p>'.$outstring.'</p>');
1869: # phase two takes
1870: # my ($source,$target,$style,$distarget,batch)=@_;
1871: # $env{'form.allmeta'},$env{'form.title'},$env{'form.author'},...
1872: if (!$error) {
1873: $r->print('<p>');
1874: &phasetwo($r,$srcfile,$targetfile,$thisembstyle,$thisdistarget,1);
1875: $r->print('</p>');
1876: }
1877: %env=%oldenv;
1878: return '';
1879: }
1880:
1881: #########################################
1882:
1883: sub publishdirectory {
1884: my ($r,$fn,$thisdisfn)=@_;
1885: $fn=~s/\/+/\//g;
1886: $thisdisfn=~s/\/+/\//g;
1887: my $resdir=
1888: $Apache::lonnet::perlvar{'lonDocRoot'}.'/res/'.$cudom.'/'.$cuname.'/'.
1889: $thisdisfn;
1890: $r->print(&Apache::lonhtmlcommon::start_pick_box()
1891: .&Apache::lonhtmlcommon::row_title(&mt('Directory'))
1892: .'<span class="LC_filename">'.$thisdisfn.'</span>'
1893: .&Apache::lonhtmlcommon::row_closure()
1894: .&Apache::lonhtmlcommon::row_title(&mt('Target'))
1895: .'<span class="LC_filename">'.$resdir.'</span>'
1896: );
1897:
1898: my $dirptr=16384; # Mask indicating a directory in stat.cmode.
1899: unless ($env{'form.phase'} eq 'two') {
1900: # ask user what they want
1901: $r->print(&Apache::lonhtmlcommon::row_closure()
1902: .&Apache::lonhtmlcommon::row_title(&mt('Options'))
1903: );
1904: $r->print('<form name="pubdirpref" method="post">'.
1905: &hiddenfield('phase','two').
1906: &hiddenfield('filename',$env{'form.filename'}).
1907: &checkbox('pubrec','include subdirectories').
1908: &checkbox('forcerepub','force republication of previously published files').
1909: &checkbox('obsolete','make file(s) obsolete').
1910: &checkbox('forceoverride','force directory level metadata over existing').
1911: '<br /><input type="submit" value="'.&mt('Publish Directory').'" /></form>');
1912: $r->print(&Apache::lonhtmlcommon::row_closure(1)
1913: .&Apache::lonhtmlcommon::end_pick_box()
1914: );
1915: $lock=0;
1916: } else {
1917: $r->print(&Apache::lonhtmlcommon::row_closure(1)
1918: .&Apache::lonhtmlcommon::end_pick_box()
1919: );
1920: unless ($lock) { $lock=&Apache::lonnet::set_lock(&mt('Publishing [_1]',$fn)); }
1921: # actually publish things
1922: opendir(DIR,$fn);
1923: my @files=sort(readdir(DIR));
1924: foreach my $filename (@files) {
1925: my ($cdev,$cino,$cmode,$cnlink,
1926: $cuid,$cgid,$crdev,$csize,
1927: $catime,$cmtime,$cctime,
1928: $cblksize,$cblocks)=stat($fn.'/'.$filename);
1929:
1930: my $extension='';
1931: if ($filename=~/\.(\w+)$/) { $extension=$1; }
1932: if ($cmode&$dirptr) {
1933: if (($filename!~/^\./) && ($env{'form.pubrec'})) {
1934: &publishdirectory($r,$fn.'/'.$filename,$thisdisfn.'/'.$filename);
1935: }
1936: } elsif ((&Apache::loncommon::fileembstyle($extension) ne 'hdn') &&
1937: ($filename!~/^[\#\.]/) && ($filename!~/\~$/)) {
1938: # find out publication status and/or exiting metadata
1939: my $publishthis=0;
1940: if (-e $resdir.'/'.$filename) {
1941: my ($rdev,$rino,$rmode,$rnlink,
1942: $ruid,$rgid,$rrdev,$rsize,
1943: $ratime,$rmtime,$rctime,
1944: $rblksize,$rblocks)=stat($resdir.'/'.$filename);
1945: if (($rmtime<$cmtime) || ($env{'form.forcerepub'})) {
1946: # previously published, modified now
1947: $publishthis=1;
1948: }
1949: my $meta_cmtime = (stat($fn.'/'.$filename.'.meta'))[9];
1950: my $meta_rmtime = (stat($resdir.'/'.$filename.'.meta'))[9];
1951: if ( $meta_rmtime<$meta_cmtime ) {
1952: $publishthis=1;
1953: }
1954: } else {
1955: # never published
1956: $publishthis=1;
1957: }
1958:
1959: if ($publishthis) {
1960: &batchpublish($r,$fn.'/'.$filename,$resdir.'/'.$filename);
1961: } else {
1962: $r->print('<br />'.&mt('Skipping').' '.$filename.'<br />');
1963: }
1964: $r->rflush();
1965: }
1966: }
1967: closedir(DIR);
1968: }
1969: }
1970:
1971: #########################################
1972: # publish a default.meta file
1973:
1974: sub defaultmetapublish {
1975: my ($r,$fn,$cuname,$cudom)=@_;
1976: $fn=~s/^\/\~$cuname\//\/home\/$cuname\/public_html\//;
1977: unless (-e $fn) {
1978: return HTTP_NOT_FOUND;
1979: }
1980: my $target=$fn;
1981: $target=~s/^\/home\/$cuname\/public_html\//$Apache::lonnet::perlvar{'lonDocRoot'}\/res\/$cudom\/$cuname\//;
1982:
1983:
1984: &Apache::loncommon::content_type($r,'text/html');
1985: $r->send_http_header;
1986:
1987: $r->print(&Apache::loncommon::start_page('Metadata Publication'));
1988:
1989: # ---------------------------------------------------------------- Write Source
1990: my $copyfile=$target;
1991:
1992: my @parts=split(/\//,$copyfile);
1993: my $path="/$parts[1]/$parts[2]/$parts[3]/$parts[4]";
1994:
1995: my $count;
1996: for ($count=5;$count<$#parts;$count++) {
1997: $path.="/$parts[$count]";
1998: if ((-e $path)!=1) {
1999: mkdir($path,0777);
2000: $r->print('<p>'
2001: .&mt('Created directory [_1]'
2002: ,'<span class="LC_filename">'.$parts[$count].'</span>')
2003: .'</p>'
2004: );
2005: }
2006: }
2007:
2008: if (copy($fn,$copyfile)) {
2009: $r->print('<p>'.&mt('Copied source file').'</p>');
2010: } else {
2011: return "<span class=\"LC_error\">".
2012: &mt('Failed to copy source').", $!, ".&mt('FAIL')."</span>";
2013: }
2014:
2015: # --------------------------------------------------- Send update notifications
2016:
2017: my @subscribed=&get_subscribed_hosts($target);
2018: foreach my $subhost (@subscribed) {
2019: $r->print('<p>'.&mt('Notifying host').' '.$subhost.':');$r->rflush;
2020: my $reply=&Apache::lonnet::critical('update:'.$target,$subhost);
2021: $r->print($reply.'</p><br />');$r->rflush;
2022: }
2023: # ------------------------------------------------------------------- Link back
2024: my $link=$fn;
2025: $link=~s/^\/home\/$cuname\/public_html\//\/priv\/$cuname\//;
2026: $r->print("<a href='$link'>".&mt('Back to Metadata').'</a>');
2027: $r->print(&Apache::loncommon::end_page());
2028: return OK;
2029: }
2030: #########################################
2031:
2032: =pod
2033:
2034: =item B<handler>
2035:
2036: A basic outline of the handler subroutine follows.
2037:
2038: =over 4
2039:
2040: =item *
2041:
2042: Get query string for limited number of parameters.
2043:
2044: =item *
2045:
2046: Check filename.
2047:
2048: =item *
2049:
2050: File is there and owned, init lookup tables.
2051:
2052: =item *
2053:
2054: Start page output.
2055:
2056: =item *
2057:
2058: Evaluate individual file, and then output information.
2059:
2060: =item *
2061:
2062: Publishing from $thisfn to $thistarget with $thisembstyle.
2063:
2064: =back
2065:
2066: =cut
2067:
2068: #########################################
2069: #########################################
2070: sub handler {
2071: my $r=shift;
2072:
2073: if ($r->header_only) {
2074: &Apache::loncommon::content_type($r,'text/html');
2075: $r->send_http_header;
2076: return OK;
2077: }
2078:
2079: # Get query string for limited number of parameters
2080:
2081: &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},
2082: ['filename']);
2083:
2084: # -------------------------------------- Flag and buffer for registered cleanup
2085: $registered_cleanup=0;
2086: @{$modified_urls}=();
2087: # -------------------------------------------------------------- Check filename
2088:
2089: my $fn=&unescape($env{'form.filename'});
2090:
2091: ($cuname,$cudom)=
2092: &Apache::loncacc::constructaccess($fn,$r->dir_config('lonDefDomain'));
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: unless ($fn) {
2101: $r->log_reason($cuname.' at '.$cudom.
2102: ' trying to publish empty filename', $r->filename);
2103: return HTTP_NOT_FOUND;
2104: }
2105:
2106: unless (($cuname) && ($cudom)) {
2107: $r->log_reason($cuname.' at '.$cudom.
2108: ' trying to publish file '.$env{'form.filename'}.
2109: ' ('.$fn.') - not authorized',
2110: $r->filename);
2111: return HTTP_NOT_ACCEPTABLE;
2112: }
2113:
2114: my $home=&Apache::lonnet::homeserver($cuname,$cudom);
2115: my $allowed=0;
2116: my @ids=&Apache::lonnet::current_machine_ids();
2117: foreach my $id (@ids) { if ($id eq $home) { $allowed = 1; } }
2118: unless ($allowed) {
2119: $r->log_reason($cuname.' at '.$cudom.
2120: ' trying to publish file '.$env{'form.filename'}.
2121: ' ('.$fn.') - not homeserver ('.$home.')',
2122: $r->filename);
2123: return HTTP_NOT_ACCEPTABLE;
2124: }
2125:
2126: $fn=~s{^http://[^/]+}{};
2127: $fn=~s{^/~($match_username)}{/home/$1/public_html};
2128:
2129: my $targetdir='';
2130: $docroot=$r->dir_config('lonDocRoot');
2131: if ($1 ne $cuname) {
2132: $r->log_reason($cuname.' at '.$cudom.
2133: ' trying to publish unowned file '.
2134: $env{'form.filename'}.' ('.$fn.')',
2135: $r->filename);
2136: return HTTP_NOT_ACCEPTABLE;
2137: } else {
2138: $targetdir=$docroot.'/res/'.$cudom;
2139: }
2140:
2141:
2142: unless (-e $fn) {
2143: $r->log_reason($cuname.' at '.$cudom.
2144: ' trying to publish non-existing file '.
2145: $env{'form.filename'}.' ('.$fn.')',
2146: $r->filename);
2147: return HTTP_NOT_FOUND;
2148: }
2149:
2150: # -------------------------------- File is there and owned, init lookup tables.
2151:
2152: %addid=();
2153:
2154: {
2155: my $fh=Apache::File->new($r->dir_config('lonTabDir').'/addid.tab');
2156: while (<$fh>=~/(\w+)\s+(\w+)/) {
2157: $addid{$1}=$2;
2158: }
2159: }
2160:
2161: %nokey=();
2162:
2163: {
2164: my $fh=Apache::File->new($r->dir_config('lonIncludes').'/un_keyword.tab');
2165: while (<$fh>) {
2166: my $word=$_;
2167: chomp($word);
2168: $nokey{$word}=1;
2169: }
2170: }
2171:
2172: # ---------------------------------------------------------- Start page output.
2173:
2174: &Apache::loncommon::content_type($r,'text/html');
2175: $r->send_http_header;
2176:
2177: # Breadcrumbs
2178: &Apache::lonhtmlcommon::clear_breadcrumbs();
2179: &Apache::lonhtmlcommon::add_breadcrumb({
2180: 'text' => 'Construction Space',
2181: 'href' => &Apache::loncommon::authorspace(),
2182: });
2183: &Apache::lonhtmlcommon::add_breadcrumb({
2184: 'text' => 'Resource Publication',
2185: 'href' => '',
2186: });
2187:
2188: my $js='<script type="text/javascript">'.
2189: &Apache::loncommon::browser_and_searcher_javascript().
2190: '</script>';
2191: $r->print(&Apache::loncommon::start_page('Resource Publication',$js)
2192: .&Apache::lonhtmlcommon::breadcrumbs()
2193: .&Apache::loncommon::head_subbox(
2194: &Apache::loncommon::CSTR_pageheader($fn))
2195: );
2196:
2197:
2198: my $thisfn=$fn;
2199:
2200: my $thistarget=$thisfn;
2201:
2202: $thistarget=~s/^\/home/$targetdir/;
2203: $thistarget=~s/\/public\_html//;
2204:
2205: my $thisdistarget=$thistarget;
2206: $thisdistarget=~s/^\Q$docroot\E//;
2207:
2208: my $thisdisfn=$thisfn;
2209: $thisdisfn=~s/^\/home\/\Q$cuname\E\/public_html\///;
2210:
2211: if ($fn=~/\/$/) {
2212: # -------------------------------------------------------- This is a directory
2213: &publishdirectory($r,$fn,$thisdisfn);
2214: $r->print('<hr /><a href="/priv/'
2215: .$cuname.'/'.$thisdisfn
2216: .'">'.&mt('Return to Directory').'</a>');
2217:
2218:
2219: } else {
2220: # ---------------------- Evaluate individual file, and then output information.
2221: $thisfn=~/\.(\w+)$/;
2222: my $thistype=$1;
2223: my $thisembstyle=&Apache::loncommon::fileembstyle($thistype);
2224: if ($thistype eq 'page') { $thisembstyle = 'rat'; }
2225:
2226: $r->print('<h2>'
2227: .&mt('Publishing [_1]'
2228: ,'<span class="LC_filename">'.$thisdisfn.'</span>')
2229: .'</h2>'
2230: );
2231:
2232: $r->print('<h3>'.&mt('Resource Details').'</h3>');
2233:
2234: $r->print(&Apache::lonhtmlcommon::start_pick_box());
2235:
2236: $r->print(&Apache::lonhtmlcommon::row_title(&mt('Type'))
2237: .&Apache::loncommon::filedescription($thistype)
2238: .&Apache::lonhtmlcommon::row_closure()
2239: );
2240:
2241: $r->print(&Apache::lonhtmlcommon::row_title(&mt('Link to Resource'))
2242: .'<tt>'
2243: );
2244: $r->print(<<ENDCAPTION);
2245: <a href='javascript:void(window.open("/~$cuname/$thisdisfn","cat","height=300,width=500,scrollbars=1,resizable=1,menubar=0,location=1"))'>
2246: $thisdisfn</a>
2247: ENDCAPTION
2248: $r->print('</tt>'
2249: .&Apache::lonhtmlcommon::row_closure()
2250: );
2251:
2252: $r->print(&Apache::lonhtmlcommon::row_title(&mt('Target'))
2253: .'<tt>'.$thisdistarget.'</tt>'
2254: );
2255: if (($cuname ne $env{'user.name'})||($cudom ne $env{'user.domain'})) {
2256: $r->print(&Apache::lonhtmlcommon::row_closure()
2257: .&Apache::lonhtmlcommon::row_title(&mt('Co-Author'))
2258: .'<span class="LC_warning">'
2259: .&Apache::loncommon::plainname($cuname,$cudom) .' ('.$cuname.':'.$cudom.')'
2260: .'</span>'
2261: );
2262: }
2263:
2264: if (&Apache::loncommon::fileembstyle($thistype) eq 'ssi') {
2265: $r->print(&Apache::lonhtmlcommon::row_closure()
2266: .&Apache::lonhtmlcommon::row_title(&mt('Diffs')));
2267: $r->print(<<ENDDIFF);
2268: <a href='javascript:void(window.open("/adm/diff?filename=/~$cuname/$thisdisfn&versiontwo=priv","cat","height=300,width=500,scrollbars=1,resizable=1,menubar=0,location=1"))'>
2269: ENDDIFF
2270: $r->print(&mt('Diffs with Current Version').'</a>');
2271: }
2272:
2273: $r->print(&Apache::lonhtmlcommon::row_closure(1)
2274: .&Apache::lonhtmlcommon::end_pick_box()
2275: );
2276:
2277: # ------------------ Publishing from $thisfn to $thistarget with $thisembstyle.
2278:
2279: unless ($env{'form.phase'} eq 'two') {
2280: # ---------------------------------------------------------- Parse for problems
2281: my ($warningcount,$errorcount);
2282: if ($thisembstyle eq 'ssi') {
2283: ($warningcount,$errorcount)=&checkonthis($r,$thisfn);
2284: }
2285: unless ($errorcount) {
2286: my ($outstring,$error)=
2287: &publish($thisfn,$thistarget,$thisembstyle);
2288: $r->print($outstring);
2289: } else {
2290: $r->print('<h3 class="LC_error">'.
2291: &mt('The document contains errors and cannot be published.').
2292: '</h3>');
2293: }
2294: } else {
2295: &phasetwo($r,$thisfn,$thistarget,$thisembstyle,$thisdistarget);
2296: }
2297: }
2298: $r->print(&Apache::loncommon::end_page());
2299:
2300: return OK;
2301: }
2302:
2303: 1;
2304: __END__
2305:
2306: =pod
2307:
2308: =back
2309:
2310: =back
2311:
2312: =cut
2313:
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