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