Annotation of loncom/publisher/lonpublisher.pm, revision 1.206
1.1 www 1: # The LearningOnline Network with CAPA
2: # Publication Handler
1.54 albertel 3: #
1.206 ! albertel 4: # $Id: lonpublisher.pm,v 1.205 2006/01/13 19:19:34 albertel 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;
1.205 albertel 689: print $logfile 'ID(new) : '.$tag.':'.$maxid."\n";
690: } else {
691: print $logfile 'ID(kept): '.$tag.':'.$parms{'id'}."\n";
1.86 albertel 692: }
693: } elsif ($counter eq 'index') {
1.186 albertel 694: unless (defined($parms{'index'}) &&
695: $parms{'index'}!~/^\s*$/) {
1.86 albertel 696: $maxindex++;
697: $parms{'index'}=$maxindex;
698: print $logfile 'Index: '.$tag.':'.$maxindex."\n";
699: }
700: }
701: }
1.203 www 702: unless ($parms{'type'} eq 'zombie') {
703: foreach my $type ('src','href','background','bgimg') {
704: foreach my $key (keys(%parms)) {
705: if ($key =~ /^$type$/i) {
706: $parms{$key}=&set_allow(\%allow,$logfile,
707: $target,$tag,
708: $parms{$key});
709: }
1.86 albertel 710: }
711: }
712: }
713: # probably a <randomlabel> image type <label>
1.135 albertel 714: # or a <image> tag inside <imageresponse>
715: if (($lctag eq 'label' && defined($parms{'description'}))
716: ||
717: ($lctag eq 'image')) {
1.86 albertel 718: my $next_token=$parser[-1]->get_token();
719: if ($next_token->[0] eq 'T') {
720: $next_token->[1]=&set_allow(\%allow,$logfile,
721: $target,$tag,
722: $next_token->[1]);
723: }
724: $parser[-1]->unget_token($next_token);
725: }
726: if ($lctag eq 'applet') {
727: my $codebase='';
1.148 albertel 728: my $havecodebase=0;
729: foreach my $key (keys(%parms)) {
730: if (lc($key) eq 'codebase') {
731: $codebase=$parms{$key};
732: $havecodebase=1;
733: }
734: }
735: if ($havecodebase) {
736: my $oldcodebase=$codebase;
1.86 albertel 737: unless ($oldcodebase=~/\/$/) {
738: $oldcodebase.='/';
739: }
740: $codebase=&urlfixup($oldcodebase,$target);
741: $codebase=~s/\/$//;
742: if ($codebase ne $oldcodebase) {
743: $parms{'codebase'}=$codebase;
744: print $logfile 'URL codebase: '.$tag.':'.
745: $oldcodebase.' - '.
746: $codebase."\n";
747: }
748: $allow{&absoluteurl($codebase,$target).'/*'}=1;
749: } else {
1.148 albertel 750: foreach my $key (keys(%parms)) {
751: if ($key =~ /(archive|code|object)/i) {
752: my $oldurl=$parms{$key};
1.86 albertel 753: my $newurl=&urlfixup($oldurl,$target);
754: $newurl=~s/\/[^\/]+$/\/\*/;
1.148 albertel 755: print $logfile 'Allow: applet '.lc($key).':'.
756: $oldurl.' allows '.$newurl."\n";
1.86 albertel 757: $allow{&absoluteurl($newurl,$target)}=1;
758: }
759: }
760: }
761: }
762: my $newparmstring='';
763: my $endtag='';
764: foreach (keys %parms) {
765: if ($_ eq '/') {
766: $endtag=' /';
767: } else {
768: my $quote=($parms{$_}=~/\"/?"'":'"');
769: $newparmstring.=' '.$_.'='.$quote.$parms{$_}.$quote;
770: }
771: }
772: if (!$endtag) { if ($token->[4]=~m:/>$:) { $endtag=' /'; }; }
773: $outstring.='<'.$tag.$newparmstring.$endtag.'>';
1.130 albertel 774: if ($lctag eq 'm' || $lctag eq 'script'
1.131 albertel 775: || $lctag eq 'display' || $lctag eq 'tex') {
1.130 albertel 776: $outstring.=&get_all_text_unbalanced('/'.$lctag,\@parser);
1.87 albertel 777: }
1.86 albertel 778: } elsif ($token->[0] eq 'E') {
779: if ($token->[2]) {
780: unless ($token->[1] eq 'allow') {
781: $outstring.='</'.$token->[1].'>';
782: }
783: }
784: } else {
785: $outstring.=$token->[1];
786: }
787: }
788: pop(@parser);
789: }
790:
791: if ($needsfixup) {
792: print $logfile "End of ID and/or index fixup\n".
793: "Max ID : $maxid (min 10)\n".
794: "Max Index: $maxindex (min 10)\n";
795: } else {
796: print $logfile "Does not need ID and/or index fixup\n";
797: }
798:
1.106 albertel 799: return ($outstring,0,%allow);
1.86 albertel 800: }
801:
1.89 matthew 802: #########################################
803: #########################################
804:
805: =pod
806:
1.94 harris41 807: =item B<store_metadata>
1.89 matthew 808:
809: Store the metadata in the metadata table in the loncapa database.
810: Uses lonmysql to access the database.
811:
812: Inputs: \%metadata
813:
814: Returns: (error,status). error is undef on success, status is undef on error.
815:
816: =cut
817:
818: #########################################
819: #########################################
820: sub store_metadata {
1.151 www 821: my %metadata = @_;
1.89 matthew 822: my $error;
823: # Determine if the table exists
824: my $status = &Apache::lonmysql::check_table('metadata');
825: if (! defined($status)) {
826: $error='<font color="red">WARNING: Cannot connect to '.
827: 'database!</font>';
828: &Apache::lonnet::logthis($error);
829: return ($error,undef);
830: }
831: if ($status == 0) {
832: # It would be nice to actually create the table....
833: $error ='<font color="red">WARNING: The metadata table does not '.
834: 'exist in the LON-CAPA database.</font>';
835: &Apache::lonnet::logthis($error);
836: return ($error,undef);
837: }
1.172 matthew 838: my $dbh = &Apache::lonmysql::get_dbh();
1.152 www 839: if (($metadata{'obsolete'}) || ($metadata{'copyright'} eq 'priv') ||
840: ($metadata{'copyright'} eq 'custom')) {
1.172 matthew 841: # remove this entry
842: $status=&LONCAPA::lonmetadata::delete_metadata($dbh,undef,
843: $metadata{'url'});
1.152 www 844: } else {
1.172 matthew 845: $status = &LONCAPA::lonmetadata::update_metadata($dbh,undef,
846: \%metadata);
1.152 www 847: }
1.172 matthew 848: if (defined($status) && $status ne '') {
1.89 matthew 849: $error='<font color="red">Error occured storing new values in '.
850: 'metadata table in LON-CAPA database</font>';
851: &Apache::lonnet::logthis($error);
1.172 matthew 852: &Apache::lonnet::logthis($status);
1.89 matthew 853: return ($error,undef);
854: }
855: return (undef,$status);
856: }
857:
1.142 www 858:
1.185 www 859: # ========================================== Parse file for errors and warnings
860:
861: sub checkonthis {
862: my ($r,$source)=@_;
1.187 www 863: my $uri=&Apache::lonnet::hreflocation($source);
864: $uri=~s/\/$//;
1.190 albertel 865: my $result=&Apache::lonnet::ssi_body($uri,
866: ('grade_target'=>'web',
867: 'return_only_error_and_warning_counts' => 1));
868: my ($errorcount,$warningcount)=split(':',$result);
1.187 www 869: if (($errorcount) || ($warningcount)) {
870: $r->print('<br /><tt>'.$uri.'</tt>: ');
871: if ($errorcount) {
1.185 www 872: $r->print('<img src="/adm/lonMisc/bomb.gif" /><font color="red"><b>'.
1.187 www 873: $errorcount.' '.
1.185 www 874: &mt('error(s)').'</b></font> ');
875: }
1.187 www 876: if ($warningcount) {
1.185 www 877: $r->print('<font color="blue">'.
1.187 www 878: $warningcount.' '.
1.185 www 879: &mt('warning(s)').'</font>');
880: }
881: } else {
1.190 albertel 882: #$r->print('<font color="green">'.&mt('ok').'</font>');
1.185 www 883: }
884: $r->rflush();
1.187 www 885: return ($warningcount,$errorcount);
1.185 www 886: }
887:
1.142 www 888: # ============================================== Parse file itself for metadata
1.144 www 889: #
890: # parses a file with target meta, sets global %metadatafields %metadatakeys
1.142 www 891:
892: sub parseformeta {
893: my ($source,$style)=@_;
1.143 www 894: my $allmeta='';
1.142 www 895: if (($style eq 'ssi') || ($style eq 'prv')) {
896: my $dir=$source;
897: $dir=~s-/[^/]*$--;
898: my $file=$source;
899: $file=(split('/',$file))[-1];
900: $source=&Apache::lonnet::hreflocation($dir,$file);
1.143 www 901: $allmeta=&Apache::lonnet::ssi_body($source,('grade_target' => 'meta'));
1.142 www 902: &metaeval($allmeta);
903: }
1.143 www 904: return $allmeta;
1.142 www 905: }
906:
1.90 matthew 907: #########################################
908: #########################################
909:
910: =pod
911:
1.94 harris41 912: =item B<publish>
913:
914: This is the workhorse function of this module. This subroutine generates
915: backup copies, performs any automatic processing (prior to publication,
916: especially for rat and ssi files),
1.90 matthew 917:
1.113 albertel 918: Returns a 2 element array, the first is the string to be shown to the
919: user, the second is an error code, either 1 (an error occured) or 0
920: (no error occurred)
921:
1.94 harris41 922: I<Additional documentation needed.>
1.90 matthew 923:
924: =cut
925:
926: #########################################
927: #########################################
1.2 www 928: sub publish {
1.50 www 929:
1.97 www 930: my ($source,$target,$style,$batch)=@_;
1.2 www 931: my $logfile;
1.4 www 932: my $scrout='';
1.23 www 933: my $allmeta='';
934: my $content='';
1.36 www 935: my %allow=();
1.4 www 936:
1.2 www 937: unless ($logfile=Apache::File->new('>>'.$source.'.log')) {
1.147 sakharuk 938: return ('<font color="red">'.&mt('No write permission to user directory, FAIL').'</font>',1);
1.2 www 939: }
940: print $logfile
1.192 albertel 941: "\n\n================= Publish ".localtime()." Phase One ================\n".$env{'user.name'}.'@'.$env{'user.domain'}."\n";
1.2 www 942:
1.119 www 943: if (($style eq 'ssi') || ($style eq 'rat') || ($style eq 'prv')) {
1.3 www 944: # ------------------------------------------------------- This needs processing
1.4 www 945:
946: # ----------------------------------------------------------------- Backup Copy
1.3 www 947: my $copyfile=$source.'.save';
1.13 www 948: if (copy($source,$copyfile)) {
1.3 www 949: print $logfile "Copied original file to ".$copyfile."\n";
950: } else {
1.13 www 951: print $logfile "Unable to write backup ".$copyfile.':'.$!."\n";
1.114 albertel 952: return ("<font color=\"red\">Failed to write backup copy, $!,FAIL</font>",1);
1.3 www 953: }
1.4 www 954: # ------------------------------------------------------------- IDs and indices
1.86 albertel 955:
1.106 albertel 956: my ($outstring,$error);
957: ($outstring,$error,%allow)=&fix_ids_and_indices($logfile,$source,
958: $target);
1.113 albertel 959: if ($error) { return ($outstring,$error); }
1.36 www 960: # ------------------------------------------------------------ Construct Allows
1.62 www 961:
1.146 sakharuk 962: $scrout.='<h3>'.&mt('Dependencies').'</h3>';
1.62 www 963: my $allowstr='';
1.73 albertel 964: foreach (sort(keys(%allow))) {
1.59 www 965: my $thisdep=$_;
1.73 albertel 966: if ($thisdep !~ /[^\s]/) { next; }
1.62 www 967: unless ($style eq 'rat') {
968: $allowstr.="\n".'<allow src="'.$thisdep.'" />';
969: }
1.120 albertel 970: $scrout.='<br />';
1.164 albertel 971: if ($thisdep!~/\*/ && $thisdep!~m|^/adm/|) {
1.59 www 972: $scrout.='<a href="'.$thisdep.'">';
1.44 www 973: }
1.59 www 974: $scrout.='<tt>'.$thisdep.'</tt>';
1.164 albertel 975: if ($thisdep!~/\*/ && $thisdep!~m|^/adm/|) {
1.44 www 976: $scrout.='</a>';
1.59 www 977: if (
978: &Apache::lonnet::getfile($Apache::lonnet::perlvar{'lonDocRoot'}.'/'.
979: $thisdep.'.meta') eq '-1') {
1.147 sakharuk 980: $scrout.= ' - <font color="red">'.&mt('Currently not available').
1.94 harris41 981: '</font>';
1.59 www 982: } else {
983: my %temphash=(&Apache::lonnet::declutter($target).'___'.
984: &Apache::lonnet::declutter($thisdep).'___usage'
985: => time);
986: $thisdep=~/^\/res\/(\w+)\/(\w+)\//;
987: if ((defined($1)) && (defined($2))) {
1.92 albertel 988: &Apache::lonnet::put('nohist_resevaldata',\%temphash,
989: $1,$2);
1.59 www 990: }
991: }
1.44 www 992: }
1.65 harris41 993: }
1.175 albertel 994: $outstring=~s/\n*(\<\/[^\>]+\>[^<]*)$/$allowstr\n$1\n/s;
1.62 www 995:
1.94 harris41 996: # ------------------------------------------------------------- Write modified.
1.37 www 997:
1.4 www 998: {
999: my $org;
1000: unless ($org=Apache::File->new('>'.$source)) {
1001: print $logfile "No write permit to $source\n";
1.136 www 1002: return ('<font color="red">'.&mt('No write permission to').
1003: ' '.$source.
1004: ', '.&mt('FAIL').'</font>',1);
1.4 www 1005: }
1.94 harris41 1006: print($org $outstring);
1.4 www 1007: }
1008: $content=$outstring;
1.34 www 1009:
1.37 www 1010: }
1.94 harris41 1011: # -------------------------------------------- Initial step done, now metadata.
1.7 www 1012:
1.94 harris41 1013: # --------------------------------------- Storage for metadata keys and fields.
1.144 www 1014: # these are globals
1015: #
1.8 www 1016: %metadatafields=();
1017: %metadatakeys=();
1018:
1019: my %oldparmstores=();
1.44 www 1020:
1.97 www 1021: unless ($batch) {
1.136 www 1022: $scrout.='<h3>'.&mt('Metadata Information').' ' .
1.84 bowersj2 1023: Apache::loncommon::help_open_topic("Metadata_Description")
1024: . '</h3>';
1.97 www 1025: }
1.7 www 1026:
1027: # ------------------------------------------------ First, check out environment
1.195 www 1028: if ((!(-e $source.'.meta')) || ($env{'form.forceoverride'})) {
1.192 albertel 1029: $metadatafields{'author'}=$env{'environment.firstname'}.' '.
1030: $env{'environment.middlename'}.' '.
1031: $env{'environment.lastname'}.' '.
1032: $env{'environment.generation'};
1.8 www 1033: $metadatafields{'author'}=~s/\s+/ /g;
1034: $metadatafields{'author'}=~s/\s+$//;
1.27 www 1035: $metadatafields{'owner'}=$cuname.'@'.$cudom;
1.7 www 1036:
1037: # ------------------------------------------------ Check out directory hierachy
1038:
1039: my $thisdisfn=$source;
1.122 albertel 1040: $thisdisfn=~s/^\/home\/\Q$cuname\E\///;
1.7 www 1041:
1042: my @urlparts=split(/\//,$thisdisfn);
1043: $#urlparts--;
1044:
1.27 www 1045: my $currentpath='/home/'.$cuname.'/';
1.7 www 1046:
1.140 albertel 1047: my $prefix='../'x($#urlparts);
1.65 harris41 1048: foreach (@urlparts) {
1.7 www 1049: $currentpath.=$_.'/';
1.140 albertel 1050: $scrout.=&metaread($logfile,$currentpath.'default.meta',$prefix);
1051: $prefix=~s|^\.\./||;
1.65 harris41 1052: }
1.185 www 1053:
1.149 www 1054: # ----------------------------------------------------------- Parse file itself
1055: # read %metadatafields from file itself
1056:
1057: $allmeta=&parseformeta($source,$style);
1.7 www 1058:
1059: # ------------------- Clear out parameters and stores (there should not be any)
1060:
1.65 harris41 1061: foreach (keys %metadatafields) {
1.7 www 1062: if (($_=~/^parameter/) || ($_=~/^stores/)) {
1063: delete $metadatafields{$_};
1064: }
1.65 harris41 1065: }
1.7 www 1066:
1.8 www 1067: } else {
1.7 www 1068: # ---------------------- Read previous metafile, remember parameters and stores
1069:
1070: $scrout.=&metaread($logfile,$source.'.meta');
1071:
1.65 harris41 1072: foreach (keys %metadatafields) {
1.7 www 1073: if (($_=~/^parameter/) || ($_=~/^stores/)) {
1074: $oldparmstores{$_}=1;
1075: delete $metadatafields{$_};
1076: }
1.65 harris41 1077: }
1.195 www 1078: # ------------------------------------------------------------- Save some stuff
1079: my %savemeta=();
1080: foreach ('title') {
1081: $savemeta{$_}=$metadatafields{$_};
1082: }
1.161 albertel 1083: # ------------------------------------------ See if anything new in file itself
1084:
1085: $allmeta=&parseformeta($source,$style);
1.195 www 1086: # ----------------------------------------------------------- Restore the stuff
1087: foreach (keys %savemeta) {
1088: $metadatafields{$_}=$savemeta{$_};
1089: }
1.144 www 1090: }
1.7 www 1091:
1.144 www 1092:
1.7 www 1093: # ---------------- Find and document discrepancies in the parameters and stores
1094:
1.116 albertel 1095: my $chparms='';
1096: foreach (sort keys %metadatafields) {
1097: if (($_=~/^parameter/) || ($_=~/^stores/)) {
1098: unless ($_=~/\.\w+$/) {
1099: unless ($oldparmstores{$_}) {
1100: print $logfile 'New: '.$_."\n";
1101: $chparms.=$_.' ';
1102: }
1103: }
1104: }
1105: }
1106: if ($chparms) {
1.136 www 1107: $scrout.='<p><b>'.&mt('New parameters or stored values').
1108: ':</b> '.$chparms.'</p>';
1.116 albertel 1109: }
1.7 www 1110:
1.116 albertel 1111: $chparms='';
1112: foreach (sort keys %oldparmstores) {
1113: if (($_=~/^parameter/) || ($_=~/^stores/)) {
1114: unless (($metadatafields{$_.'.name'}) ||
1115: ($metadatafields{$_.'.package'}) || ($_=~/\.\w+$/)) {
1116: print $logfile 'Obsolete: '.$_."\n";
1117: $chparms.=$_.' ';
1118: }
1119: }
1120: }
1121: if ($chparms) {
1.136 www 1122: $scrout.='<p><b>'.&mt('Obsolete parameters or stored values').':</b> '.
1.144 www 1123: $chparms.'</p><h1><font color="red">'.&mt('Warning!').
1124: '</font></h1><p><font color="red" size="+1">'.
1125: &mt('If this resource is in active use, student performance data from the previous version may become inaccessible.').'</font></p><hr />';
1.116 albertel 1126: }
1.37 www 1127:
1.8 www 1128: # ------------------------------------------------------- Now have all metadata
1.5 www 1129:
1.116 albertel 1130: my %keywords=();
1.97 www 1131:
1.116 albertel 1132: if (length($content)<500000) {
1133: my $textonly=$content;
1134: $textonly=~s/\<script[^\<]+\<\/script\>//g;
1135: $textonly=~s/\<m\>[^\<]+\<\/m\>//g;
1136: $textonly=~s/\<[^\>]*\>//g;
1137: $textonly=~tr/A-Z/a-z/;
1138: $textonly=~s/[\$\&][a-z]\w*//g;
1139: $textonly=~s/[^a-z\s]//g;
1140:
1141: foreach ($textonly=~m/(\w+)/g) {
1142: unless ($nokey{$_}) {
1143: $keywords{$_}=1;
1144: }
1145: }
1146: }
1.97 www 1147:
1148:
1.168 www 1149: foreach my $addkey (split(/[\"\'\,\;]/,$metadatafields{'keywords'})) {
1150: $addkey=~s/\s+/ /g;
1151: $addkey=~s/^\s//;
1152: $addkey=~s/\s$//;
1153: if ($addkey=~/\w/) {
1154: $keywords{$addkey}=1;
1155: }
1.116 albertel 1156: }
1.97 www 1157: # --------------------------------------------------- Now we also have keywords
1158: # =============================================================================
1.167 albertel 1159: # interactive mode html goes into $intr_scrout
1160: # batch mode throws away this HTML
1161: # additionally all of the field functions have a by product of setting
1.192 albertel 1162: # $env{'from.'..} so that it can be used by the phase two handler in
1.167 albertel 1163: # batch mode
1164:
1165: my $intr_scrout.=
1166: '<form name="pubform" action="/adm/publish" method="post">'.
1.194 www 1167: '<p>'.($env{'form.makeobsolete'}?'':'<input type="submit" value="'.&mt('Finalize Publication').'" />').'</p>'.
1.167 albertel 1168: &hiddenfield('phase','two').
1.192 albertel 1169: &hiddenfield('filename',$env{'form.filename'}).
1.167 albertel 1170: &hiddenfield('allmeta',&Apache::lonnet::escape($allmeta)).
1.194 www 1171: &hiddenfield('dependencies',join(',',keys %allow));
1172: unless ($env{'form.makeobsolete'}) {
1173: $intr_scrout.=
1.167 albertel 1174: &textfield('Title','title',$metadatafields{'title'}).
1175: &textfield('Author(s)','author',$metadatafields{'author'}).
1176: &textfield('Subject','subject',$metadatafields{'subject'});
1.194 www 1177: # --------------------------------------------------- Scan content for keywords
1.7 www 1178:
1.167 albertel 1179: my $keywords_help = Apache::loncommon::help_open_topic("Publishing_Keywords");
1180: my $KEYWORDS=&mt('Keywords');
1181: my $CheckAll=&mt('check all');
1182: my $UncheckAll=&mt('uncheck all');
1183: my $keywordout=<<"END";
1.77 matthew 1184: <script>
1.116 albertel 1185: function checkAll(field) {
1.77 matthew 1186: for (i = 0; i < field.length; i++)
1187: field[i].checked = true ;
1188: }
1189:
1.116 albertel 1190: function uncheckAll(field) {
1.77 matthew 1191: for (i = 0; i < field.length; i++)
1192: field[i].checked = false ;
1193: }
1194: </script>
1.146 sakharuk 1195: <p><font color="#800000" face="helvetica"><b>$KEYWORDS:</b></font>
1.123 albertel 1196: $keywords_help</b>
1.146 sakharuk 1197: <input type="button" value="$CheckAll" onclick="javascript:checkAll(document.pubform.keywords)" />
1198: <input type="button" value="$UncheckAll" onclick="javascript:uncheckAll(document.pubform.keywords)" />
1.120 albertel 1199: </p>
1.77 matthew 1200: <br />
1.117 albertel 1201: END
1.167 albertel 1202: $keywordout.='<table border="2"><tr>';
1203: my $colcount=0;
1.116 albertel 1204:
1.167 albertel 1205: foreach (sort keys %keywords) {
1.179 matthew 1206: $keywordout.='<td><label><input type="checkbox" name="keywords" value="'.$_.'"';
1.167 albertel 1207: if ($metadatafields{'keywords'}) {
1208: if ($metadatafields{'keywords'}=~/\Q$_\E/) {
1.120 albertel 1209: $keywordout.=' checked="on"';
1.192 albertel 1210: $env{'form.keywords'}.=$_.',';
1.116 albertel 1211: }
1.167 albertel 1212: } elsif (&Apache::loncommon::keyword($_)) {
1213: $keywordout.=' checked="on"';
1.192 albertel 1214: $env{'form.keywords'}.=$_.',';
1.167 albertel 1215: }
1.179 matthew 1216: $keywordout.=' />'.$_.'</label></td>';
1.167 albertel 1217: if ($colcount>10) {
1218: $keywordout.="</tr><tr>\n";
1219: $colcount=0;
1.116 albertel 1220: }
1.167 albertel 1221: $colcount++;
1222: }
1.192 albertel 1223: $env{'form.keywords'}=~s/\,$//;
1.116 albertel 1224:
1.167 albertel 1225: $keywordout.='</tr></table>';
1.51 www 1226:
1.167 albertel 1227: $intr_scrout.=$keywordout;
1.9 www 1228:
1.167 albertel 1229: $intr_scrout.=&textfield('Additional Keywords','addkey','');
1.12 www 1230:
1.167 albertel 1231: $intr_scrout.=&textfield('Notes','notes',$metadatafields{'notes'});
1.9 www 1232:
1.167 albertel 1233: $intr_scrout.=
1234: "\n<p><font color=\"#800000\" face=\"helvetica\"><b>".&mt('Abstract').":".
1235: "</b></font></p><br />".
1236: '<textarea cols="80" rows="5" name="abstract">'.
1237: $metadatafields{'abstract'}.'</textarea></p>';
1.9 www 1238:
1.167 albertel 1239: $source=~/\.(\w+)$/;
1.150 www 1240:
1241:
1.167 albertel 1242: $intr_scrout.=
1243: "\n<p><font color=\"#800000\" face=\"helvetica\"><b>".
1244: &mt('Lowest Grade Level').':'.
1245: "</b></font></p><br />".
1246: &select_level_form($metadatafields{'lowestgradelevel'},'lowestgradelevel').
1247: "\n<p><font color=\"#800000\" face=\"helvetica\"><b>".
1248: &mt('Highest Grade Level').':'.
1249: "</b></font></p><br />".
1250: &select_level_form($metadatafields{'highestgradelevel'},'highestgradelevel').
1251: &textfield('Standards','standards',$metadatafields{'standards'});
1.150 www 1252:
1253:
1254:
1.11 www 1255:
1.167 albertel 1256: $intr_scrout.=&hiddenfield('mime',$1);
1.11 www 1257:
1.167 albertel 1258: my $defaultlanguage=$metadatafields{'language'};
1259: $defaultlanguage =~ s/\s*notset\s*//g;
1260: $defaultlanguage =~ s/^,\s*//g;
1261: $defaultlanguage =~ s/,\s*$//g;
1.123 albertel 1262:
1.167 albertel 1263: $intr_scrout.=&selectbox('Language','language',
1264: $defaultlanguage,
1265: \&Apache::loncommon::languagedescription,
1266: (&Apache::loncommon::languageids),
1267: );
1.11 www 1268:
1.167 albertel 1269: unless ($metadatafields{'creationdate'}) {
1270: $metadatafields{'creationdate'}=time;
1271: }
1272: $intr_scrout.=&hiddenfield('creationdate',
1273: &Apache::lonmysql::unsqltime($metadatafields{'creationdate'}));
1.116 albertel 1274:
1.167 albertel 1275: $intr_scrout.=&hiddenfield('lastrevisiondate',time);
1.11 www 1276:
1277:
1.167 albertel 1278: $intr_scrout.=&textfield('Publisher/Owner','owner',
1279: $metadatafields{'owner'});
1.84 bowersj2 1280:
1.173 www 1281: # ---------------------------------------------- Retrofix for unused copyright
1282: if ($metadatafields{'copyright'} eq 'free') {
1283: $metadatafields{'copyright'}='default';
1284: $metadatafields{'sourceavail'}='open';
1285: }
1.174 www 1286: # ------------------------------------------------ Dial in reasonable defaults
1.167 albertel 1287: my $defaultoption=$metadatafields{'copyright'};
1288: unless ($defaultoption) { $defaultoption='default'; }
1.174 www 1289: my $defaultsourceoption=$metadatafields{'sourceavail'};
1290: unless ($defaultsourceoption) { $defaultsourceoption='closed'; }
1.167 albertel 1291: unless ($style eq 'prv') {
1.174 www 1292: # -------------------------------------------------- Correct copyright for rat.
1.167 albertel 1293: if ($style eq 'rat') {
1.174 www 1294: # -------------------------------------- Retrofix for non-applicable copyright
1.167 albertel 1295: if ($metadatafields{'copyright'} eq 'public') {
1296: delete $metadatafields{'copyright'};
1297: $defaultoption='default';
1298: }
1299: $intr_scrout.=&selectbox('Copyright/Distribution','copyright',
1300: $defaultoption,
1301: \&Apache::loncommon::copyrightdescription,
1.116 albertel 1302: (grep !/^public$/,(&Apache::loncommon::copyrightids)));
1303: } else {
1.174 www 1304: $intr_scrout.=&selectbox('Copyright/Distribution','copyright',
1305: $defaultoption,
1306: \&Apache::loncommon::copyrightdescription,
1307: (&Apache::loncommon::copyrightids));
1.65 harris41 1308: }
1.174 www 1309: my $copyright_help =
1310: Apache::loncommon::help_open_topic('Publishing_Copyright');
1.188 www 1311: $intr_scrout =~ s/Distribution:/'Distribution: ' . $copyright_help/ge;
1.180 albertel 1312: $intr_scrout.=&text_with_browse_field('Custom Distribution File','customdistributionfile',$metadatafields{'customdistributionfile'},'rights').$copyright_help;
1.174 www 1313: $intr_scrout.=&selectbox('Source Distribution','sourceavail',
1314: $defaultsourceoption,
1315: \&Apache::loncommon::source_copyrightdescription,
1316: (&Apache::loncommon::source_copyrightids));
1.198 www 1317: # $intr_scrout.=&text_with_browse_field('Source Custom Distribution File','sourcerights',$metadatafields{'sourcerights'},'rights');
1.174 www 1318: my $uctitle=&mt('Obsolete');
1319: $intr_scrout.=
1.201 albertel 1320: "\n<p><label><font color=\"#800000\" face=\"helvetica\"><b>$uctitle:".
1.174 www 1321: '</b></font> <input type="checkbox" name="obsolete" ';
1322: if ($metadatafields{'obsolete'}) {
1323: $intr_scrout.=' checked="1" ';
1324: }
1.201 albertel 1325: $intr_scrout.='/ ></label></p>'.
1.180 albertel 1326: &text_with_browse_field('Suggested Replacement for Obsolete File',
1327: 'obsoletereplacement',
1328: $metadatafields{'obsoletereplacement'});
1.174 www 1329: } else {
1330: $intr_scrout.=&hiddenfield('copyright','private');
1331: }
1.194 www 1332: } else {
1333: $intr_scrout.=
1334: &hiddenfield('title',$metadatafields{'title'}).
1335: &hiddenfield('author',$metadatafields{'author'}).
1336: &hiddenfield('subject',$metadatafields{'subject'}).
1337: &hiddenfield('keywords',$metadatafields{'keywords'}).
1338: &hiddenfield('abstract',$metadatafields{'abstract'}).
1339: &hiddenfield('notes',$metadatafields{'notes'}).
1340: &hiddenfield('mime',$metadatafields{'mime'}).
1341: &hiddenfield('creationdate',$metadatafields{'creationdate'}).
1342: &hiddenfield('lastrevisiondate',time).
1343: &hiddenfield('owner',$metadatafields{'owner'}).
1344: &hiddenfield('lowestgradelevel',$metadatafields{'lowestgradelevel'}).
1345: &hiddenfield('standards',$metadatafields{'standards'}).
1346: &hiddenfield('highestgradelevel',$metadatafields{'highestgradelevel'}).
1347: &hiddenfield('language',$metadatafields{'language'}).
1348: &hiddenfield('copyright',$metadatafields{'copyright'}).
1349: &hiddenfield('sourceavail',$metadatafields{'sourceavail'}).
1350: &hiddenfield('customdistributionfile',$metadatafields{'customdistributionfile'}).
1.195 www 1351: &hiddenfield('obsolete',1).
1.194 www 1352: &text_with_browse_field('Suggested Replacement for Obsolete File',
1353: 'obsoletereplacement',
1354: $metadatafields{'obsoletereplacement'});
1355: }
1.167 albertel 1356: if (!$batch) {
1357: $scrout.=$intr_scrout.'<p><input type="submit" value="'.
1.194 www 1358: &mt($env{'form.makeobsolete'}?'Make Obsolete':'Finalize Publication').'" /></p></form>';
1.97 www 1359: }
1.167 albertel 1360: return($scrout,0);
1.2 www 1361: }
1.1 www 1362:
1.90 matthew 1363: #########################################
1364: #########################################
1365:
1366: =pod
1367:
1.94 harris41 1368: =item B<phasetwo>
1.90 matthew 1369:
1370: Render second interface showing status of publication steps.
1371: This is publication step two.
1372:
1.94 harris41 1373: Parameters:
1374:
1375: =over 4
1376:
1377: =item I<$source>
1378:
1379: =item I<$target>
1380:
1381: =item I<$style>
1382:
1383: =item I<$distarget>
1384:
1385: =back
1386:
1387: Returns:
1388:
1389: =over 4
1390:
1.197 www 1391: =item integer
1.94 harris41 1392:
1.197 www 1393: 0: fail
1394: 1: success
1.94 harris41 1395:
1.90 matthew 1396: =cut
1.12 www 1397:
1.100 matthew 1398: #'stupid emacs
1.90 matthew 1399: #########################################
1400: #########################################
1.11 www 1401: sub phasetwo {
1402:
1.100 matthew 1403: my ($r,$source,$target,$style,$distarget,$batch)=@_;
1.102 www 1404: $source=~s/\/+/\//g;
1405: $target=~s/\/+/\//g;
1.196 www 1406: #
1407: # Unless trying to get rid of something, check name validity
1408: #
1409: unless ($env{'form.obsolete'}) {
1410: if ($target=~/(\_\_\_|\&\&\&|\:\:\:)/) {
1411: $r->print(
1412: '<font color="red">'.&mt('Unsupported character combination').
1413: ' "<tt>'.$1.'</tt>" '.&mt('in filename, FAIL').'</font>');
1414: return 0;
1415: }
1416: unless ($target=~/\.(\w+)$/) {
1417: $r->print('<font color="red">'.&mt('No valid extension found in filename, FAIL').'</font>');
1418: return 0;
1419: }
1420: if ($target=~/\.(\d+)\.(\w+)$/) {
1421: $r->print('<font color="red">'.&mt('Cannot publish versioned resource, FAIL').'</font>');
1422: return 0;
1423: }
1424: }
1.109 www 1425:
1.196 www 1426: #
1427: # End name check
1428: #
1.102 www 1429: $distarget=~s/\/+/\//g;
1.11 www 1430: my $logfile;
1431: unless ($logfile=Apache::File->new('>>'.$source.'.log')) {
1.110 www 1432: $r->print(
1.136 www 1433: '<font color="red">'.
1434: &mt('No write permission to user directory, FAIL').'</font>');
1.110 www 1435: return 0;
1.11 www 1436: }
1437: print $logfile
1.192 albertel 1438: "\n================= Publish ".localtime()." Phase Two ================\n".$env{'user.name'}.'@'.$env{'user.domain'}."\n";
1.100 matthew 1439:
1440: %metadatafields=();
1441: %metadatakeys=();
1.167 albertel 1442:
1.192 albertel 1443: &metaeval(&Apache::lonnet::unescape($env{'form.allmeta'}));
1.100 matthew 1444:
1.192 albertel 1445: $metadatafields{'title'}=$env{'form.title'};
1446: $metadatafields{'author'}=$env{'form.author'};
1447: $metadatafields{'subject'}=$env{'form.subject'};
1448: $metadatafields{'notes'}=$env{'form.notes'};
1449: $metadatafields{'abstract'}=$env{'form.abstract'};
1450: $metadatafields{'mime'}=$env{'form.mime'};
1451: $metadatafields{'language'}=$env{'form.language'};
1452: $metadatafields{'creationdate'}=$env{'form.creationdate'};
1453: $metadatafields{'lastrevisiondate'}=$env{'form.lastrevisiondate'};
1454: $metadatafields{'owner'}=$env{'form.owner'};
1455: $metadatafields{'copyright'}=$env{'form.copyright'};
1456: $metadatafields{'standards'}=$env{'form.standards'};
1457: $metadatafields{'lowestgradelevel'}=$env{'form.lowestgradelevel'};
1458: $metadatafields{'highestgradelevel'}=$env{'form.highestgradelevel'};
1.115 www 1459: $metadatafields{'customdistributionfile'}=
1.192 albertel 1460: $env{'form.customdistributionfile'};
1461: $metadatafields{'sourceavail'}=$env{'form.sourceavail'};
1462: $metadatafields{'obsolete'}=$env{'form.obsolete'};
1.138 www 1463: $metadatafields{'obsoletereplacement'}=
1.192 albertel 1464: $env{'form.obsoletereplacement'};
1465: $metadatafields{'dependencies'}=$env{'form.dependencies'};
1466: $metadatafields{'modifyinguser'}=$env{'user.name'}.'@'.
1467: $env{'user.domain'};
1.154 www 1468: $metadatafields{'authorspace'}=$cuname.'@'.$cudom;
1.100 matthew 1469:
1.192 albertel 1470: my $allkeywords=$env{'form.addkey'};
1471: if (exists($env{'form.keywords'})) {
1472: if (ref($env{'form.keywords'})) {
1473: $allkeywords .= ','.join(',',@{$env{'form.keywords'}});
1.100 matthew 1474: } else {
1.192 albertel 1475: $allkeywords .= ','.$env{'form.keywords'};
1.100 matthew 1476: }
1477: }
1.168 www 1478: $allkeywords=~s/[\"\']//g;
1.170 www 1479: $allkeywords=~s/\s*[\;\,]\s*/\,/g;
1.168 www 1480: $allkeywords=~s/\s+/ /g;
1481: $allkeywords=~s/^[ \,]//;
1482: $allkeywords=~s/[ \,]$//;
1.100 matthew 1483: $metadatafields{'keywords'}=$allkeywords;
1484:
1.149 www 1485: # check if custom distribution file is specified
1486: if ($metadatafields{'copyright'} eq 'custom') {
1487: my $file=$metadatafields{'customdistributionfile'};
1488: unless ($file=~/\.rights$/) {
1.197 www 1489: $r->print(
1.149 www 1490: '<font color="red">'.&mt('No valid custom distribution rights file specified, FAIL').
1.197 www 1491: '</font>');
1492: return 0;
1.149 www 1493: }
1494: }
1.100 matthew 1495: {
1496: print $logfile "\nWrite metadata file for ".$source;
1497: my $mfh;
1498: unless ($mfh=Apache::File->new('>'.$source.'.meta')) {
1.197 www 1499: $r->print(
1.136 www 1500: '<font color="red">'.&mt('Could not write metadata, FAIL').
1.197 www 1501: '</font>');
1502: return 0;
1.100 matthew 1503: }
1504: foreach (sort keys %metadatafields) {
1505: unless ($_=~/\./) {
1506: my $unikey=$_;
1507: $unikey=~/^([A-Za-z]+)/;
1508: my $tag=$1;
1509: $tag=~tr/A-Z/a-z/;
1510: print $mfh "\n\<$tag";
1511: foreach (split(/\,/,$metadatakeys{$unikey})) {
1512: my $value=$metadatafields{$unikey.'.'.$_};
1513: $value=~s/\"/\'\'/g;
1514: print $mfh ' '.$_.'="'.$value.'"';
1515: }
1516: print $mfh '>'.
1.165 albertel 1517: &HTML::Entities::encode($metadatafields{$unikey},'<>&"')
1.100 matthew 1518: .'</'.$tag.'>';
1519: }
1520: }
1.136 www 1521: $r->print('<p>'.&mt('Wrote Metadata').'</p>');
1.100 matthew 1522: print $logfile "\nWrote metadata";
1523: }
1524:
1525: # -------------------------------- Synchronize entry with SQL metadata database
1.12 www 1526:
1.89 matthew 1527: $metadatafields{'url'} = $distarget;
1528: $metadatafields{'version'} = 'current';
1.152 www 1529:
1530: my ($error,$success) = &store_metadata(%metadatafields);
1531: if ($success) {
1532: $r->print('<p>'.&mt('Synchronized SQL metadata database').'</p>');
1533: print $logfile "\nSynchronized SQL metadata database";
1.89 matthew 1534: } else {
1.152 www 1535: $r->print($error);
1536: print $logfile "\n".$error;
1.24 harris41 1537: }
1.159 www 1538: # --------------------------------------------- Delete author resource messages
1539: my $delresult=&Apache::lonmsg::del_url_author_res_msg($target);
1540: $r->print('<p>'.&mt('Removing error messages:').' '.$delresult.'</p>');
1541: print $logfile "\nRemoving error messages: $delresult";
1.12 www 1542: # ----------------------------------------------------------- Copy old versions
1543:
1.100 matthew 1544: if (-e $target) {
1545: my $filename;
1546: my $maxversion=0;
1547: $target=~/(.*)\/([^\/]+)\.(\w+)$/;
1548: my $srcf=$2;
1549: my $srct=$3;
1550: my $srcd=$1;
1551: unless ($srcd=~/^\/home\/httpd\/html\/res/) {
1552: print $logfile "\nPANIC: Target dir is ".$srcd;
1.197 www 1553: $r->print(
1554: "<font color=\"red\">Invalid target directory, FAIL</font>");
1555: return 0;
1.100 matthew 1556: }
1557: opendir(DIR,$srcd);
1558: while ($filename=readdir(DIR)) {
1559: if (-l $srcd.'/'.$filename) {
1560: unlink($srcd.'/'.$filename);
1561: unlink($srcd.'/'.$filename.'.meta');
1562: } else {
1.118 albertel 1563: if ($filename=~/\Q$srcf\E\.(\d+)\.\Q$srct\E$/) {
1.100 matthew 1564: $maxversion=($1>$maxversion)?$1:$maxversion;
1565: }
1566: }
1567: }
1568: closedir(DIR);
1569: $maxversion++;
1.120 albertel 1570: $r->print('<p>Creating old version '.$maxversion.'</p>');
1.125 www 1571: print $logfile "\nCreating old version ".$maxversion."\n";
1.100 matthew 1572:
1573: my $copyfile=$srcd.'/'.$srcf.'.'.$maxversion.'.'.$srct;
1574:
1.13 www 1575: if (copy($target,$copyfile)) {
1.12 www 1576: print $logfile "Copied old target to ".$copyfile."\n";
1.136 www 1577: $r->print('<p>'.&mt('Copied old target file').'</p>');
1.12 www 1578: } else {
1.13 www 1579: print $logfile "Unable to write ".$copyfile.':'.$!."\n";
1.197 www 1580: $r->print("<font color=\"red\">".&mt('Failed to copy old target').
1581: ", $!, ".&mt('FAIL')."</font>");
1582: return 0;
1.12 www 1583: }
1.100 matthew 1584:
1.12 www 1585: # --------------------------------------------------------------- Copy Metadata
1586:
1587: $copyfile=$copyfile.'.meta';
1.100 matthew 1588:
1.13 www 1589: if (copy($target.'.meta',$copyfile)) {
1.14 www 1590: print $logfile "Copied old target metadata to ".$copyfile."\n";
1.136 www 1591: $r->print('<p>'.&mt('Copied old metadata').'</p>')
1.12 www 1592: } else {
1.13 www 1593: print $logfile "Unable to write metadata ".$copyfile.':'.$!."\n";
1.14 www 1594: if (-e $target.'.meta') {
1.197 www 1595: $r->print(
1.136 www 1596: "<font color=\"red\">".
1.197 www 1597: &mt('Failed to write old metadata copy').", $!, ".&mt('FAIL')."</font>");
1598: return 0;
1.14 www 1599: }
1.12 www 1600: }
1.100 matthew 1601:
1602:
1603: } else {
1.138 www 1604: $r->print('<p>'.&mt('Initial version').'</p>');
1.100 matthew 1605: print $logfile "\nInitial version";
1606: }
1.12 www 1607:
1608: # ---------------------------------------------------------------- Write Source
1.100 matthew 1609: my $copyfile=$target;
1610:
1611: my @parts=split(/\//,$copyfile);
1612: my $path="/$parts[1]/$parts[2]/$parts[3]/$parts[4]";
1613:
1614: my $count;
1615: for ($count=5;$count<$#parts;$count++) {
1616: $path.="/$parts[$count]";
1617: if ((-e $path)!=1) {
1618: print $logfile "\nCreating directory ".$path;
1.136 www 1619: $r->print('<p>'.&mt('Created directory').' '.$parts[$count].'</p>');
1.100 matthew 1620: mkdir($path,0777);
1.12 www 1621: }
1.100 matthew 1622: }
1623:
1624: if (copy($source,$copyfile)) {
1625: print $logfile "\nCopied original source to ".$copyfile."\n";
1.136 www 1626: $r->print('<p>'.&mt('Copied source file').'</p>');
1.100 matthew 1627: } else {
1628: print $logfile "\nUnable to write ".$copyfile.':'.$!."\n";
1.197 www 1629: $r->print("<font color=\"red\">".
1630: &mt('Failed to copy source').", $!, ".&mt('FAIL')."</font>");
1631: return 0;
1.100 matthew 1632: }
1633:
1.12 www 1634: # --------------------------------------------------------------- Copy Metadata
1635:
1.100 matthew 1636: $copyfile=$copyfile.'.meta';
1637:
1638: if (copy($source.'.meta',$copyfile)) {
1639: print $logfile "\nCopied original metadata to ".$copyfile."\n";
1.136 www 1640: $r->print('<p>'.&mt('Copied metadata').'</p>');
1.100 matthew 1641: } else {
1642: print $logfile "\nUnable to write metadata ".$copyfile.':'.$!."\n";
1.197 www 1643: $r->print(
1644: "<font color=\"red\">".&mt('Failed to write metadata copy').", $!, ".&mt('FAIL')."</font>");
1645: return 0;
1.100 matthew 1646: }
1647: $r->rflush;
1.12 www 1648:
1.181 www 1649: # ------------------------------------------------------------- Trigger updates
1.183 www 1650: push(@{$modified_urls},[$target,$source]);
1.182 www 1651: unless ($registered_cleanup) {
1652: $r->register_cleanup(\¬ify);
1653: $registered_cleanup=1;
1654: }
1.199 www 1655:
1656: # ---------------------------------------------------------- Clear local caches
1657: my $thisdistarget=$target;
1658: $thisdistarget=~s/^\Q$docroot\E//;
1659: &Apache::lonnet::devalidate_cache_new('resversion',$target);
1660: &Apache::lonnet::devalidate_cache_new('meta',
1661: &Apache::lonnet::declutter($thisdistarget));
1662:
1.12 www 1663: # ------------------------------------------------ Provide link to new resource
1.100 matthew 1664: unless ($batch) {
1665:
1666: my $thissrc=$source;
1667: $thissrc=~s/^\/home\/(\w+)\/public_html/\/priv\/$1/;
1668:
1669: my $thissrcdir=$thissrc;
1670: $thissrcdir=~s/\/[^\/]+$/\//;
1671:
1672:
1673: $r->print(
1.120 albertel 1674: '<hr /><a href="'.$thisdistarget.'"><font size="+2">'.
1.138 www 1675: &mt('View Published Version').'</font></a>'.
1676: '<p><a href="'.$thissrc.'"><font size=+2>'.
1677: &mt('Back to Source').'</font></a></p>'.
1.100 matthew 1678: '<p><a href="'.$thissrcdir.
1.138 www 1679: '"><font size="+2">'.
1680: &mt('Back to Source Directory').'</font></a></p>');
1.100 matthew 1681: }
1.181 www 1682: $logfile->close();
1.197 www 1683: $r->print('<p><font color="green">'.&mt('Done').'</font></p>');
1684: return 1;
1.11 www 1685: }
1686:
1.181 www 1687: # =============================================================== Notifications
1688: sub notify {
1689: # --------------------------------------------------- Send update notifications
1.183 www 1690: foreach my $targetsource (@{$modified_urls}){
1.182 www 1691: my ($target,$source)=@{$targetsource};
1692: my $logfile=Apache::File->new('>>'.$source.'.log');
1693: print $logfile "\nCleanup phase: Notifications\n";
1694: my @subscribed=&get_subscribed_hosts($target);
1695: foreach my $subhost (@subscribed) {
1696: print $logfile "\nNotifying host ".$subhost.':';
1697: my $reply=&Apache::lonnet::critical('update:'.$target,$subhost);
1698: print $logfile $reply;
1699: }
1.181 www 1700: # ---------------------------------------- Send update notifications, meta only
1.182 www 1701: my @subscribedmeta=&get_subscribed_hosts("$target.meta");
1702: foreach my $subhost (@subscribedmeta) {
1703: print $logfile "\nNotifying host for metadata only ".$subhost.':';
1704: my $reply=&Apache::lonnet::critical('update:'.$target.'.meta',
1705: $subhost);
1706: print $logfile $reply;
1707: }
1.181 www 1708: # --------------------------------------------------- Notify subscribed courses
1.182 www 1709: my %courses=&coursedependencies($target);
1710: my $now=time;
1711: foreach (keys %courses) {
1712: print $logfile "\nNotifying course ".$_.':';
1713: my ($cdom,$cname)=split(/\_/,$_);
1714: my $reply=&Apache::lonnet::cput
1715: ('versionupdate',{$target => $now},$cdom,$cname);
1716: print $logfile $reply;
1717: }
1718: print $logfile "\n============ Done ============\n";
1719: $logfile->close();
1.181 www 1720: }
1.182 www 1721: return OK;
1.181 www 1722: }
1723:
1.95 www 1724: #########################################
1725:
1726: sub batchpublish {
1.97 www 1727: my ($r,$srcfile,$targetfile)=@_;
1.192 albertel 1728: #publication pollutes %env with form.* values
1729: my %oldenv=%env;
1.102 www 1730: $srcfile=~s/\/+/\//g;
1731: $targetfile=~s/\/+/\//g;
1.95 www 1732: my $thisdisfn=$srcfile;
1733: $thisdisfn=~s/\/home\/korte\/public_html\///;
1734: $srcfile=~s/\/+/\//g;
1.96 www 1735:
1.97 www 1736: my $docroot=$r->dir_config('lonDocRoot');
1737: my $thisdistarget=$targetfile;
1.122 albertel 1738: $thisdistarget=~s/^\Q$docroot\E//;
1.97 www 1739:
1.96 www 1740:
1.139 albertel 1741: %metadatafields=();
1742: %metadatakeys=();
1743: $srcfile=~/\.(\w+)$/;
1744: my $thistype=$1;
1.97 www 1745:
1746:
1.139 albertel 1747: my $thisembstyle=&Apache::loncommon::fileembstyle($thistype);
1.96 www 1748:
1.138 www 1749: $r->print('<h2>'.&mt('Publishing').' <tt>'.$thisdisfn.'</tt></h2>');
1.97 www 1750:
1751: # phase one takes
1752: # my ($source,$target,$style,$batch)=@_;
1.113 albertel 1753: my ($outstring,$error)=&publish($srcfile,$targetfile,$thisembstyle,1);
1754: $r->print('<p>'.$outstring.'</p>');
1.96 www 1755: # phase two takes
1756: # my ($source,$target,$style,$distarget,batch)=@_;
1.192 albertel 1757: # $env{'form.allmeta'},$env{'form.title'},$env{'form.author'},...
1.113 albertel 1758: if (!$error) {
1759: $r->print('<p>');
1760: &phasetwo($r,$srcfile,$targetfile,$thisembstyle,$thisdistarget,1);
1761: $r->print('</p>');
1762: }
1.192 albertel 1763: %env=%oldenv;
1.97 www 1764: return '';
1.95 www 1765: }
1.1 www 1766:
1.90 matthew 1767: #########################################
1.95 www 1768:
1769: sub publishdirectory {
1770: my ($r,$fn,$thisdisfn)=@_;
1.102 www 1771: $fn=~s/\/+/\//g;
1772: $thisdisfn=~s/\/+/\//g;
1.96 www 1773: my $resdir=
1.139 albertel 1774: $Apache::lonnet::perlvar{'lonDocRoot'}.'/res/'.$cudom.'/'.$cuname.'/'.
1775: $thisdisfn;
1.156 www 1776: $r->print('<h1>'.&mt('Directory').' <tt>'.$thisdisfn.'</tt></h1>'.
1777: &mt('Target').': <tt>'.$resdir.'</tt><br />');
1.139 albertel 1778:
1779: my $dirptr=16384; # Mask indicating a directory in stat.cmode.
1.193 www 1780: unless ($env{'form.phase'} eq 'two') {
1781: # ask user what they want
1782: $r->print('<form name="pubdirpref" method="post">'.
1783: &hiddenfield('phase','two').
1784: &hiddenfield('filename',$env{'form.filename'}).
1785: &checkbox('pubrec','include subdirectories').
1.194 www 1786: &checkbox('forcerepub','force republication of previously published files').
1.206 ! albertel 1787: &checkbox('obsolete','make file(s) obsolete').
1.195 www 1788: &checkbox('forceoverride','force directory level catalog information over existing').
1789: '<br /><input type="submit" value="'.&mt('Publish Directory').'" /></form>');
1.193 www 1790: } else {
1791: # actually publish things
1792: opendir(DIR,$fn);
1793: my @files=sort(readdir(DIR));
1794: foreach my $filename (@files) {
1795: my ($cdev,$cino,$cmode,$cnlink,
1796: $cuid,$cgid,$crdev,$csize,
1797: $catime,$cmtime,$cctime,
1798: $cblksize,$cblocks)=stat($fn.'/'.$filename);
1799:
1800: my $extension='';
1801: if ($filename=~/\.(\w+)$/) { $extension=$1; }
1802: if ($cmode&$dirptr) {
1803: if (($filename!~/^\./) && ($env{'form.pubrec'})) {
1804: &publishdirectory($r,$fn.'/'.$filename,$thisdisfn.'/'.$filename);
1805: }
1806: } elsif ((&Apache::loncommon::fileembstyle($extension) ne 'hdn') &&
1807: ($filename!~/^[\#\.]/) && ($filename!~/\~$/)) {
1.96 www 1808: # find out publication status and/or exiting metadata
1.193 www 1809: my $publishthis=0;
1810: if (-e $resdir.'/'.$filename) {
1811: my ($rdev,$rino,$rmode,$rnlink,
1812: $ruid,$rgid,$rrdev,$rsize,
1813: $ratime,$rmtime,$rctime,
1814: $rblksize,$rblocks)=stat($resdir.'/'.$filename);
1815: if (($rmtime<$cmtime) || ($env{'form.forcerepub'})) {
1.96 www 1816: # previously published, modified now
1.193 www 1817: $publishthis=1;
1818: }
1819: } else {
1820: # never published
1.96 www 1821: $publishthis=1;
1.193 www 1822: }
1823: if ($publishthis) {
1824: &batchpublish($r,$fn.'/'.$filename,$resdir.'/'.$filename);
1825: } else {
1826: $r->print('<br />'.&mt('Skipping').' '.$filename.'<br />');
1827: }
1828: $r->rflush();
1.139 albertel 1829: }
1830: }
1.193 www 1831: closedir(DIR);
1.139 albertel 1832: }
1.95 www 1833: }
1.160 www 1834:
1835: #########################################
1836: # publish a default.meta file
1837:
1838: sub defaultmetapublish {
1839: my ($r,$fn,$cuname,$cudom)=@_;
1840: $fn=~s/^\/\~$cuname\//\/home\/$cuname\/public_html\//;
1841: unless (-e $fn) {
1842: return HTTP_NOT_FOUND;
1843: }
1844: my $target=$fn;
1845: $target=~s/^\/home\/$cuname\/public_html\//$Apache::lonnet::perlvar{'lonDocRoot'}\/res\/$cudom\/$cuname\//;
1846:
1847:
1848: &Apache::loncommon::content_type($r,'text/html');
1849: $r->send_http_header;
1850:
1851: $r->print('<html><head><title>LON-CAPA Publishing</title></head>');
1852: $r->print(&Apache::loncommon::bodytag('Catalog Information Publication'));
1853:
1854: # ---------------------------------------------------------------- Write Source
1855: my $copyfile=$target;
1856:
1857: my @parts=split(/\//,$copyfile);
1858: my $path="/$parts[1]/$parts[2]/$parts[3]/$parts[4]";
1859:
1860: my $count;
1861: for ($count=5;$count<$#parts;$count++) {
1862: $path.="/$parts[$count]";
1863: if ((-e $path)!=1) {
1864: $r->print('<p>'.&mt('Created directory').' '.$parts[$count].'</p>');
1865: mkdir($path,0777);
1866: }
1867: }
1868:
1869: if (copy($fn,$copyfile)) {
1870: $r->print('<p>'.&mt('Copied source file').'</p>');
1871: } else {
1872: return "<font color=\"red\">".
1873: &mt('Failed to copy source').", $!, ".&mt('FAIL')."</font>";
1874: }
1875:
1876: # --------------------------------------------------- Send update notifications
1877:
1878: my @subscribed=&get_subscribed_hosts($target);
1879: foreach my $subhost (@subscribed) {
1880: $r->print('<p>'.&mt('Notifying host').' '.$subhost.':');$r->rflush;
1881: my $reply=&Apache::lonnet::critical('update:'.$target,$subhost);
1882: $r->print($reply.'</p><br />');$r->rflush;
1883: }
1884: # ------------------------------------------------------------------- Link back
1885: my $link=$fn;
1886: $link=~s/^\/home\/$cuname\/public_html\//\/priv\/$cuname\//;
1887: $r->print("<a href='$link'>".&mt('Back to Catalog Information').'</a>');
1888: $r->print('</body></html>');
1889: return OK;
1890: }
1.90 matthew 1891: #########################################
1892:
1893: =pod
1894:
1.94 harris41 1895: =item B<handler>
1.90 matthew 1896:
1897: A basic outline of the handler subroutine follows.
1898:
1899: =over 4
1900:
1.94 harris41 1901: =item *
1902:
1903: Get query string for limited number of parameters.
1904:
1905: =item *
1906:
1907: Check filename.
1908:
1909: =item *
1910:
1911: File is there and owned, init lookup tables.
1912:
1913: =item *
1.90 matthew 1914:
1.94 harris41 1915: Start page output.
1.90 matthew 1916:
1.94 harris41 1917: =item *
1.90 matthew 1918:
1.94 harris41 1919: Evaluate individual file, and then output information.
1.90 matthew 1920:
1.94 harris41 1921: =item *
1.90 matthew 1922:
1.94 harris41 1923: Publishing from $thisfn to $thistarget with $thisembstyle.
1.90 matthew 1924:
1925: =back
1926:
1927: =cut
1928:
1929: #########################################
1930: #########################################
1.1 www 1931: sub handler {
1.139 albertel 1932: my $r=shift;
1.2 www 1933:
1.139 albertel 1934: if ($r->header_only) {
1935: &Apache::loncommon::content_type($r,'text/html');
1936: $r->send_http_header;
1937: return OK;
1938: }
1.2 www 1939:
1.43 www 1940: # Get query string for limited number of parameters
1941:
1.80 matthew 1942: &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},
1943: ['filename']);
1.43 www 1944:
1.183 www 1945: # -------------------------------------- Flag and buffer for registered cleanup
1.182 www 1946: $registered_cleanup=0;
1.183 www 1947: @{$modified_urls}=();
1.2 www 1948: # -------------------------------------------------------------- Check filename
1949:
1.192 albertel 1950: my $fn=&Apache::lonnet::unescape($env{'form.filename'});
1.160 www 1951:
1952: ($cuname,$cudom)=
1953: &Apache::loncacc::constructaccess($fn,$r->dir_config('lonDefDomain'));
1954:
1955: # special publication: default.meta file
1956: if ($fn=~/\/default.meta$/) {
1957: return &defaultmetapublish($r,$fn,$cuname,$cudom);
1958: }
1.159 www 1959: $fn=~s/\.meta$//;
1.27 www 1960:
1.139 albertel 1961: unless ($fn) {
1962: $r->log_reason($cuname.' at '.$cudom.
1963: ' trying to publish empty filename', $r->filename);
1964: return HTTP_NOT_FOUND;
1965: }
1966:
1967: unless (($cuname) && ($cudom)) {
1968: $r->log_reason($cuname.' at '.$cudom.
1.192 albertel 1969: ' trying to publish file '.$env{'form.filename'}.
1.139 albertel 1970: ' ('.$fn.') - not authorized',
1971: $r->filename);
1972: return HTTP_NOT_ACCEPTABLE;
1973: }
1974:
1.163 albertel 1975: my $home=&Apache::lonnet::homeserver($cuname,$cudom);
1976: my $allowed=0;
1977: my @ids=&Apache::lonnet::current_machine_ids();
1978: foreach my $id (@ids) { if ($id eq $home) { $allowed = 1; } }
1979: unless ($allowed) {
1.139 albertel 1980: $r->log_reason($cuname.' at '.$cudom.
1.192 albertel 1981: ' trying to publish file '.$env{'form.filename'}.
1.163 albertel 1982: ' ('.$fn.') - not homeserver ('.$home.')',
1.139 albertel 1983: $r->filename);
1984: return HTTP_NOT_ACCEPTABLE;
1985: }
1986:
1987: $fn=~s/^http\:\/\/[^\/]+//;
1988: $fn=~s/^\/\~(\w+)/\/home\/$1\/public_html/;
1989:
1990: my $targetdir='';
1991: $docroot=$r->dir_config('lonDocRoot');
1992: if ($1 ne $cuname) {
1993: $r->log_reason($cuname.' at '.$cudom.
1994: ' trying to publish unowned file '.
1.192 albertel 1995: $env{'form.filename'}.' ('.$fn.')',
1.139 albertel 1996: $r->filename);
1997: return HTTP_NOT_ACCEPTABLE;
1998: } else {
1999: $targetdir=$docroot.'/res/'.$cudom;
2000: }
1.2 www 2001:
2002:
1.139 albertel 2003: unless (-e $fn) {
2004: $r->log_reason($cuname.' at '.$cudom.
2005: ' trying to publish non-existing file '.
1.192 albertel 2006: $env{'form.filename'}.' ('.$fn.')',
1.139 albertel 2007: $r->filename);
2008: return HTTP_NOT_FOUND;
2009: }
1.2 www 2010:
1.94 harris41 2011: # -------------------------------- File is there and owned, init lookup tables.
1.2 www 2012:
1.205 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;
1.139 albertel 2019: }
1.205 albertel 2020: }
1.3 www 2021:
1.205 albertel 2022: %nokey=();
1.11 www 2023:
1.205 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;
1.139 albertel 2030: }
2031: }
1.11 www 2032:
1.94 harris41 2033: # ---------------------------------------------------------- Start page output.
1.2 www 2034:
1.139 albertel 2035: &Apache::loncommon::content_type($r,'text/html');
2036: $r->send_http_header;
1.180 albertel 2037:
2038: my $js=&Apache::loncommon::browser_and_searcher_javascript();
2039: $r->print('<html><head><title>LON-CAPA Publishing</title>
2040: <script type="text/javascript">'.$js.'
2041: </script></head>');
1.139 albertel 2042: $r->print(&Apache::loncommon::bodytag('Resource Publication'));
1.101 www 2043:
2044:
1.139 albertel 2045: my $thisfn=$fn;
1.95 www 2046:
1.139 albertel 2047: my $thistarget=$thisfn;
1.95 www 2048:
1.139 albertel 2049: $thistarget=~s/^\/home/$targetdir/;
2050: $thistarget=~s/\/public\_html//;
1.95 www 2051:
1.139 albertel 2052: my $thisdistarget=$thistarget;
2053: $thisdistarget=~s/^\Q$docroot\E//;
1.95 www 2054:
1.139 albertel 2055: my $thisdisfn=$thisfn;
2056: $thisdisfn=~s/^\/home\/\Q$cuname\E\/public_html\///;
1.95 www 2057:
1.139 albertel 2058: if ($fn=~/\/$/) {
1.95 www 2059: # -------------------------------------------------------- This is a directory
1.139 albertel 2060: &publishdirectory($r,$fn,$thisdisfn);
1.193 www 2061: $r->print('<hr /><a href="/priv/'
1.139 albertel 2062: .$cuname.'/'.$thisdisfn
2063: .'">'.&mt('Return to Directory').'</a>');
1.128 www 2064:
1.95 www 2065:
1.139 albertel 2066: } else {
1.94 harris41 2067: # ---------------------- Evaluate individual file, and then output information.
1.139 albertel 2068: $thisfn=~/\.(\w+)$/;
2069: my $thistype=$1;
2070: my $thisembstyle=&Apache::loncommon::fileembstyle($thistype);
1.200 raeburn 2071: if ($thistype eq 'page') { $thisembstyle = 'rat'; }
1.139 albertel 2072: $r->print('<h2>'.&mt('Publishing').' '.
2073: &Apache::loncommon::filedescription($thistype).' <tt>');
1.2 www 2074:
1.139 albertel 2075: $r->print(<<ENDCAPTION);
1.129 www 2076: <a href='javascript:void(window.open("/~$cuname/$thisdisfn","cat","height=300,width=500,scrollbars=1,resizable=1,menubar=0,location=1"))'>
2077: $thisdisfn</a>
2078: ENDCAPTION
1.139 albertel 2079: $r->print('</tt></h2><b>'.&mt('Target').':</b> <tt>'.
2080: $thisdistarget.'</tt><br />');
1.27 www 2081:
1.192 albertel 2082: if (($cuname ne $env{'user.name'})||($cudom ne $env{'user.domain'})) {
1.139 albertel 2083: $r->print('<h3><font color="red">'.&mt('Co-Author').': '.
2084: $cuname.&mt(' at ').$cudom.'</font></h3>');
2085: }
1.26 www 2086:
1.139 albertel 2087: if (&Apache::loncommon::fileembstyle($thistype) eq 'ssi') {
2088: $r->print(<<ENDDIFF);
1.129 www 2089: <br />
1.136 www 2090: <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 2091: ENDDIFF
1.139 albertel 2092: $r->print(&mt('Diffs with Current Version').'</a><br />');
2093: }
1.11 www 2094:
1.94 harris41 2095: # ------------------ Publishing from $thisfn to $thistarget with $thisembstyle.
1.2 www 2096:
1.192 albertel 2097: unless ($env{'form.phase'} eq 'two') {
1.185 www 2098: # ---------------------------------------------------------- Parse for problems
1.189 albertel 2099: my ($warningcount,$errorcount);
2100: if ($thisembstyle eq 'ssi') {
2101: ($warningcount,$errorcount)=&checkonthis($r,$thisfn);
2102: }
2103: unless ($errorcount) {
1.187 www 2104: my ($outstring,$error)=
2105: &publish($thisfn,$thistarget,$thisembstyle);
2106: $r->print('<hr />'.$outstring);
2107: } else {
1.189 albertel 2108: $r->print('<h3>'.
2109: &mt('The document contains errors and cannot be published.').
1.187 www 2110: '</h3>');
2111: }
1.139 albertel 2112: } else {
1.197 www 2113: &phasetwo($r,$thisfn,$thistarget,$thisembstyle,$thisdistarget);
2114: $r->print('<hr />');
1.139 albertel 2115: }
2116: }
2117: $r->print('</body></html>');
1.15 www 2118:
1.139 albertel 2119: return OK;
1.1 www 2120: }
2121:
2122: 1;
2123: __END__
2124:
1.89 matthew 2125: =pod
1.126 bowersj2 2126:
2127: =back
1.66 harris41 2128:
2129: =back
2130:
1.89 matthew 2131: =cut
1.66 harris41 2132:
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