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