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