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