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