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