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