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