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