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