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