File:  [LON-CAPA] / loncom / publisher / lonpublisher.pm
Revision 1.122: download - view: text, annotated - select for diffs
Tue Jun 24 23:24:48 2003 UTC (20 years, 10 months ago) by albertel
Branches: MAIN
CVS tags: version_0_99_3, HEAD
- the first one of these fixes BUG #1669, the rest of these I did cause I of BUG#1669

    1: # The LearningOnline Network with CAPA
    2: # Publication Handler
    3: #
    4: # $Id: lonpublisher.pm,v 1.122 2003/06/24 23:24:48 albertel Exp $
    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: #
   28: # 
   29: # (TeX Content Handler
   30: #
   31: # 05/29/00,05/30,10/11 Gerd Kortemeyer)
   32: #
   33: # 11/28,11/29,11/30,12/01,12/02,12/04,12/23 Gerd Kortemeyer
   34: # 03/23 Guy Albertelli
   35: # 03/24,03/29,04/03 Gerd Kortemeyer
   36: # 05/03,05/05,05/07 Gerd Kortemeyer
   37: # 06/23,08/07,08/11,8/13,8/17,8/18,8/24,9/26,10/16 Gerd Kortemeyer
   38: # 12/04,12/05 Guy Albertelli
   39: # 12/05 Gerd Kortemeyer
   40: # 12/05 Guy Albertelli
   41: # 12/06,12/07 Gerd Kortemeyer
   42: # 12/25 Gerd Kortemeyer
   43: # YEAR=2002
   44: # 1/17 Gerd Kortemeyer
   45: #
   46: ###
   47: 
   48: ###############################################################################
   49: ##                                                                           ##
   50: ## ORGANIZATION OF THIS PERL MODULE                                          ##
   51: ##                                                                           ##
   52: ## 1. Modules used by this module                                            ##
   53: ## 2. Various subroutines                                                    ##
   54: ## 3. Publication Step One                                                   ##
   55: ## 4. Phase Two                                                              ##
   56: ## 5. Main Handler                                                           ##
   57: ##                                                                           ##
   58: ###############################################################################
   59: 
   60: 
   61: ######################################################################
   62: ######################################################################
   63: 
   64: =pod 
   65: 
   66: =head1 NAME
   67: 
   68: lonpublisher - LON-CAPA publishing handler
   69: 
   70: =head1 SYNOPSIS
   71: 
   72: B<lonpublisher> is used by B<mod_perl> inside B<Apache>.  This is the
   73: invocation by F<loncapa_apache.conf>:
   74: 
   75:   <Location /adm/publish>
   76:   PerlAccessHandler       Apache::lonacc
   77:   SetHandler perl-script
   78:   PerlHandler Apache::lonpublisher
   79:   ErrorDocument     403 /adm/login
   80:   ErrorDocument     404 /adm/notfound.html
   81:   ErrorDocument     406 /adm/unauthorized.html
   82:   ErrorDocument     500 /adm/errorhandler
   83:   </Location>
   84: 
   85: =head1 DESCRIPTION
   86: 
   87: B<lonpublisher> takes the proper steps to add resources to the LON-CAPA
   88: digital library.  This includes updating the metadata table in the
   89: LON-CAPA database.
   90: 
   91: B<lonpublisher> is many things to many people.  
   92: 
   93: This module publishes a file.  This involves gathering metadata,
   94: versioning the file, copying file from construction space to
   95: publication space, and copying metadata from construction space
   96: to publication space.
   97: 
   98: =head2 SUBROUTINES
   99: 
  100: Many of the undocumented subroutines implement various magical
  101: parsing shortcuts.
  102: 
  103: =over 4
  104: 
  105: =cut
  106: 
  107: ######################################################################
  108: ######################################################################
  109: 
  110: 
  111: package Apache::lonpublisher;
  112: 
  113: # ------------------------------------------------- modules used by this module
  114: use strict;
  115: use Apache::File;
  116: use File::Copy;
  117: use Apache::Constants qw(:common :http :methods);
  118: use HTML::LCParser;
  119: use Apache::lonxml;
  120: use Apache::loncacc;
  121: use DBI;
  122: use Apache::lonnet();
  123: use Apache::loncommon();
  124: use Apache::lonmysql;
  125: use vars qw(%metadatafields %metadatakeys);
  126: 
  127: my %addid;
  128: my %nokey;
  129: 
  130: my $docroot;
  131: 
  132: my $cuname;
  133: my $cudom;
  134: 
  135: =pod
  136: 
  137: =item B<metaeval>
  138: 
  139: Evaluates a string that contains metadata.  This subroutine
  140: stores values inside I<%metadatafields> and I<%metadatakeys>.
  141: The hash key is a I<$unikey> corresponding to a unique id
  142: that is descriptive of the parser location inside the XML tree.
  143: 
  144: Parameters:
  145: 
  146: =over 4
  147: 
  148: =item I<$metastring>
  149: 
  150: A string that contains metadata.
  151: 
  152: =back
  153: 
  154: Returns:
  155: 
  156: nothing
  157: 
  158: =cut
  159: 
  160: #########################################
  161: #########################################
  162: sub metaeval {
  163:     my $metastring=shift;
  164:    
  165:         my $parser=HTML::LCParser->new(\$metastring);
  166:         my $token;
  167:         while ($token=$parser->get_token) {
  168:            if ($token->[0] eq 'S') {
  169: 	      my $entry=$token->[1];
  170:               my $unikey=$entry;
  171:               if (defined($token->[2]->{'package'})) { 
  172:                   $unikey.='_package_'.$token->[2]->{'package'};
  173:               } 
  174:               if (defined($token->[2]->{'part'})) { 
  175:                  $unikey.='_'.$token->[2]->{'part'}; 
  176: 	      }
  177:               if (defined($token->[2]->{'id'})) { 
  178:                   $unikey.='_'.$token->[2]->{'id'};
  179:               } 
  180:               if (defined($token->[2]->{'name'})) { 
  181:                  $unikey.='_'.$token->[2]->{'name'}; 
  182: 	      }
  183:               foreach (@{$token->[3]}) {
  184: 		  $metadatafields{$unikey.'.'.$_}=$token->[2]->{$_};
  185:                   if ($metadatakeys{$unikey}) {
  186: 		      $metadatakeys{$unikey}.=','.$_;
  187:                   } else {
  188:                       $metadatakeys{$unikey}=$_;
  189:                   }
  190:               }
  191:               if ($metadatafields{$unikey}) {
  192: 		  my $newentry=$parser->get_text('/'.$entry);
  193:                   unless (($metadatafields{$unikey}=~/\Q$newentry\E/) ||
  194:                           ($newentry eq '')) {
  195:                      $metadatafields{$unikey}.=', '.$newentry;
  196: 		  }
  197: 	      } else {
  198:                  $metadatafields{$unikey}=$parser->get_text('/'.$entry);
  199:               }
  200:           }
  201:        }
  202: }
  203: 
  204: #########################################
  205: #########################################
  206: 
  207: =pod
  208: 
  209: =item B<metaread>
  210: 
  211: Read a metadata file
  212: 
  213: Parameters:
  214: 
  215: =over
  216: 
  217: =item I<$logfile>
  218: 
  219: File output stream to output errors and warnings to.
  220: 
  221: =item I<$fn>
  222: 
  223: File name (including path).
  224: 
  225: =back
  226: 
  227: Returns:
  228: 
  229: =over 4
  230: 
  231: =item Scalar string (if successful)
  232: 
  233: XHTML text that indicates successful reading of the metadata.
  234: 
  235: =back
  236: 
  237: =cut
  238: 
  239: #########################################
  240: #########################################
  241: sub metaread {
  242:     my ($logfile,$fn)=@_;
  243:     unless (-e $fn) {
  244: 	print($logfile 'No file '.$fn."\n");
  245:         return '<br /><b>No file:</b> <tt>'.$fn.'</tt>';
  246:     }
  247:     print($logfile 'Processing '.$fn."\n");
  248:     my $metastring;
  249:     {
  250:      my $metafh=Apache::File->new($fn);
  251:      $metastring=join('',<$metafh>);
  252:     }
  253:     &metaeval($metastring);
  254:     return '<br /><b>Processed file:</b> <tt>'.$fn.'</tt>';
  255: }
  256: 
  257: #########################################
  258: #########################################
  259: 
  260: sub coursedependencies {
  261:     my $url=&Apache::lonnet::declutter(shift);
  262:     $url=~s/\.meta$//;
  263:     my ($adomain,$aauthor)=($url=~/^(\w+)\/(\w+)\//);
  264:     my $regexp=$url;
  265:     $regexp=~s/(\W)/\\$1/g;
  266:     $regexp='___'.$regexp.'___course';
  267:     my %evaldata=&Apache::lonnet::dump('nohist_resevaldata',$adomain,
  268: 				       $aauthor,$regexp);
  269:     my %courses=();
  270:     foreach (keys %evaldata) {
  271: 	if ($_=~/^([a-zA-Z0-9]+_[a-zA-Z0-9]+)___.+___course$/) {
  272: 	    $courses{$1}=1;
  273:         }
  274:     }
  275:     return %courses;
  276: }
  277: #########################################
  278: #########################################
  279: 
  280: 
  281: =pod
  282: 
  283: =item Form-field-generating subroutines.
  284: 
  285: For input parameters, these subroutines take in values
  286: such as I<$name>, I<$value> and other form field metadata.
  287: The output (scalar string that is returned) is an XHTML
  288: string which presents the form field (foreseeably inside
  289: <form></form> tags).
  290: 
  291: =over 4
  292: 
  293: =item B<textfield>
  294: 
  295: =item B<hiddenfield>
  296: 
  297: =item B<selectbox>
  298: 
  299: =back
  300: 
  301: =cut
  302: 
  303: #########################################
  304: #########################################
  305: sub textfield {
  306:     my ($title,$name,$value)=@_;
  307:     return "\n<p><b>$title:</b></p><br />".
  308:            '<input type="text" name="'.$name.'" size=80 value="'.$value.'" />';
  309: }
  310: 
  311: sub hiddenfield {
  312:     my ($name,$value)=@_;
  313:     return "\n".'<input type="hidden" name="'.$name.'" value="'.$value.'" />';
  314: }
  315: 
  316: sub selectbox {
  317:     my ($title,$name,$value,$functionref,@idlist)=@_;
  318:     my $uctitle=uc($title);
  319:     my $selout="\n<p><font color=\"#800000\" face=\"helvetica\"><b>$uctitle:".
  320: 	"</b></font></p><br />".'<select name="'.$name.'">';
  321:     foreach (@idlist) {
  322:         $selout.='<option value=\''.$_.'\'';
  323:         if ($_ eq $value) {
  324: 	    $selout.=' selected>'.&{$functionref}($_).'</option>';
  325: 	}
  326:         else {$selout.='>'.&{$functionref}($_).'</option>';}
  327:     }
  328:     return $selout.'</select>';
  329: }
  330: 
  331: #########################################
  332: #########################################
  333: 
  334: =pod
  335: 
  336: =item B<urlfixup>
  337: 
  338: Fix up a url?  First step of publication
  339: 
  340: =cut
  341: 
  342: #########################################
  343: #########################################
  344: sub urlfixup {
  345:     my ($url,$target)=@_;
  346:     unless ($url) { return ''; }
  347:     #javascript code needs no fixing
  348:     if ($url =~ /^javascript:/i) { return $url; }
  349:     if ($url =~ /^mailto:/i) { return $url; }
  350:     #internal document links need no fixing
  351:     if ($url =~ /^\#/) { return $url; } 
  352:     my ($host)=($url=~/(?:http\:\/\/)*([^\/]+)/);
  353:     foreach (values %Apache::lonnet::hostname) {
  354: 	if ($_ eq $host) {
  355: 	    $url=~s/^http\:\/\///;
  356:             $url=~s/^$host//;
  357:         }
  358:     }
  359:     if ($url=~/^http\:\/\//) { return $url; }
  360:     $url=~s/\~$cuname/res\/$cudom\/$cuname/;
  361:     return $url;
  362: }
  363: 
  364: #########################################
  365: #########################################
  366: 
  367: =pod
  368: 
  369: =item B<absoluteurl>
  370: 
  371: Currently undocumented.
  372: 
  373: =cut
  374: 
  375: #########################################
  376: #########################################
  377: sub absoluteurl {
  378:     my ($url,$target)=@_;
  379:     unless ($url) { return ''; }
  380:     if ($target) {
  381: 	$target=~s/\/[^\/]+$//;
  382:        $url=&Apache::lonnet::hreflocation($target,$url);
  383:     }
  384:     return $url;
  385: }
  386: 
  387: #########################################
  388: #########################################
  389: 
  390: =pod
  391: 
  392: =item B<set_allow>
  393: 
  394: Currently undocumented    
  395: 
  396: =cut
  397: 
  398: #########################################
  399: #########################################
  400: sub set_allow {
  401:     my ($allow,$logfile,$target,$tag,$oldurl)=@_;
  402:     my $newurl=&urlfixup($oldurl,$target);
  403:     my $return_url=$oldurl;
  404:     print $logfile 'GUYURL: '.$tag.':'.$oldurl.' - '.$newurl."\n";
  405:     if ($newurl ne $oldurl) {
  406: 	$return_url=$newurl;
  407: 	print $logfile 'URL: '.$tag.':'.$oldurl.' - '.$newurl."\n";
  408:     }
  409:     if (($newurl !~ /^javascript:/i) &&
  410: 	($newurl !~ /^mailto:/i) &&
  411: 	($newurl !~ /^http:/i) &&
  412: 	($newurl !~ /^\#/)) {
  413: 	$$allow{&absoluteurl($newurl,$target)}=1;
  414:     }
  415:     return $return_url
  416: }
  417: 
  418: #########################################
  419: #########################################
  420: 
  421: =pod
  422: 
  423: =item B<get_subscribed_hosts>
  424: 
  425: Currently undocumented    
  426: 
  427: =cut
  428: 
  429: #########################################
  430: #########################################
  431: sub get_subscribed_hosts {
  432:     my ($target)=@_;
  433:     my @subscribed;
  434:     my $filename;
  435:     $target=~/(.*)\/([^\/]+)$/;
  436:     my $srcf=$2;
  437:     opendir(DIR,$1);
  438:     while ($filename=readdir(DIR)) {
  439: 	if ($filename=~/\Q$srcf\E\.(\w+)$/) {
  440: 	    my $subhost=$1;
  441: 	    if (($subhost ne 'meta' && $subhost ne 'subscription') &&
  442:                 ($subhost ne $Apache::lonnet::perlvar{'lonHostID'})) {
  443: 		push(@subscribed,$subhost);
  444: 	    }
  445: 	}
  446:     }
  447:     closedir(DIR);
  448:     my $sh;
  449:     if ( $sh=Apache::File->new("$target.subscription") ) {
  450: 	&Apache::lonnet::logthis("opened $target.subscription");
  451: 	while (my $subline=<$sh>) {
  452: 	    &Apache::lonnet::logthis("Trying $subline");
  453: 	    if ($subline =~ /(^\w+):/) { 
  454:                 if ($1 ne $Apache::lonnet::perlvar{'lonHostID'}) { 
  455:                    push(@subscribed,$1);
  456: 	        }
  457:             } else {
  458: 		&Apache::lonnet::logthis("No Match for $subline");
  459: 	    }
  460: 	}
  461:     } else {
  462: 	&Apache::lonnet::logthis("Unable to open $target.subscription");
  463:     }
  464:     return @subscribed;
  465: }
  466: 
  467: 
  468: #########################################
  469: #########################################
  470: 
  471: =pod
  472: 
  473: =item B<get_max_ids_indices>
  474: 
  475: Currently undocumented    
  476: 
  477: =cut
  478: 
  479: #########################################
  480: #########################################
  481: sub get_max_ids_indices {
  482:     my ($content)=@_;
  483:     my $maxindex=10;
  484:     my $maxid=10;
  485:     my $needsfixup=0;
  486:     my $duplicateids=0;
  487: 
  488:     my %allids;
  489:     my %duplicatedids;
  490: 
  491:     my $parser=HTML::LCParser->new($content);
  492:     my $token;
  493:     while ($token=$parser->get_token) {
  494: 	if ($token->[0] eq 'S') {
  495: 	    my $counter;
  496: 	    if ($counter=$addid{$token->[1]}) {
  497: 		if ($counter eq 'id') {
  498: 		    if (defined($token->[2]->{'id'})) {
  499: 			$maxid=($token->[2]->{'id'}>$maxid)?$token->[2]->{'id'}:$maxid;
  500: 			if (exists($allids{$token->[2]->{'id'}})) {
  501: 			    $duplicateids=1;
  502: 			    $duplicatedids{$token->[2]->{'id'}}=1;
  503: 			} else {
  504: 			    $allids{$token->[2]->{'id'}}=1;
  505: 			}
  506: 		    } else {
  507: 			$needsfixup=1;
  508: 		    }
  509: 		} else {
  510: 		    if (defined($token->[2]->{'index'})) {
  511: 			$maxindex=($token->[2]->{'index'}>$maxindex)?$token->[2]->{'index'}:$maxindex;
  512: 		    } else {
  513: 			$needsfixup=1;
  514: 		    }
  515: 		}
  516: 	    }
  517: 	}
  518:     }
  519:     return ($needsfixup,$maxid,$maxindex,$duplicateids,
  520: 	    (keys(%duplicatedids)));
  521: }
  522: 
  523: #########################################
  524: #########################################
  525: 
  526: =pod
  527: 
  528: =item B<get_all_text_unbalanced>
  529: 
  530: Currently undocumented    
  531: 
  532: =cut
  533: 
  534: #########################################
  535: #########################################
  536: sub get_all_text_unbalanced {
  537:     #there is a copy of this in lonxml.pm
  538:     my($tag,$pars)= @_;
  539:     my $token;
  540:     my $result='';
  541:     $tag='<'.$tag.'>';
  542:     while ($token = $$pars[-1]->get_token) {
  543: 	if (($token->[0] eq 'T')||($token->[0] eq 'C')||($token->[0] eq 'D')) {
  544: 	    $result.=$token->[1];
  545: 	} elsif ($token->[0] eq 'PI') {
  546: 	    $result.=$token->[2];
  547: 	} elsif ($token->[0] eq 'S') {
  548: 	    $result.=$token->[4];
  549: 	} elsif ($token->[0] eq 'E')  {
  550: 	    $result.=$token->[2];
  551: 	}
  552: 	if ($result =~ /(.*)\Q$tag\E(.*)/s) {
  553: 	    #&Apache::lonnet::logthis('Got a winner with leftovers ::'.$2);
  554: 	    #&Apache::lonnet::logthis('Result is :'.$1);
  555: 	    $result=$1;
  556: 	    my $redo=$tag.$2;
  557: 	    push (@$pars,HTML::LCParser->new(\$redo));
  558: 	    $$pars[-1]->xml_mode('1');
  559: 	    last;
  560: 	}
  561:     }
  562:     return $result
  563: }
  564: 
  565: #########################################
  566: #########################################
  567: 
  568: =pod
  569: 
  570: =item B<fix_ids_and_indices>
  571: 
  572: Currently undocumented    
  573: 
  574: =cut
  575: 
  576: #########################################
  577: #########################################
  578: #Arguably this should all be done as a lonnet::ssi instead
  579: sub fix_ids_and_indices {
  580:     my ($logfile,$source,$target)=@_;
  581: 
  582:     my %allow;
  583:     my $content;
  584:     {
  585: 	my $org=Apache::File->new($source);
  586: 	$content=join('',<$org>);
  587:     }
  588: 
  589:     my ($needsfixup,$maxid,$maxindex,$duplicateids,@duplicatedids)=
  590: 	&get_max_ids_indices(\$content);
  591: 
  592:     print $logfile ("Got $needsfixup,$maxid,$maxindex,$duplicateids--".
  593: 			   join(', ',@duplicatedids));
  594:     if ($duplicateids) {
  595: 	print $logfile "Duplicate ID(s) exist, ".join(', ',@duplicatedids)."\n";
  596: 	my $outstring='<font color="red">Unable to publish file, it contains duplicated ID(s), ID(s) need to be unique. The duplicated ID(s) are: '.join(', ',@duplicatedids).'</font>';
  597: 	return ($outstring,1);
  598:     }
  599:     if ($needsfixup) {
  600: 	print $logfile "Needs ID and/or index fixup\n".
  601: 	    "Max ID   : $maxid (min 10)\n".
  602:                 "Max Index: $maxindex (min 10)\n";
  603:     }
  604:     my $outstring='';
  605:     my @parser;
  606:     $parser[0]=HTML::LCParser->new(\$content);
  607:     $parser[-1]->xml_mode(1);
  608:     my $token;
  609:     while (@parser) {
  610: 	while ($token=$parser[-1]->get_token) {
  611: 	    if ($token->[0] eq 'S') {
  612: 		my $counter;
  613: 		my $tag=$token->[1];
  614: 		my $lctag=lc($tag);
  615: 		if ($lctag eq 'allow') {
  616: 		    $allow{$token->[2]->{'src'}}=1;
  617: 		    next;
  618: 		}
  619: 		my %parms=%{$token->[2]};
  620: 		$counter=$addid{$tag};
  621: 		if (!$counter) { $counter=$addid{$lctag}; }
  622: 		if ($counter) {
  623: 		    if ($counter eq 'id') {
  624: 			unless (defined($parms{'id'})) {
  625: 			    $maxid++;
  626: 			    $parms{'id'}=$maxid;
  627: 			    print $logfile 'ID: '.$tag.':'.$maxid."\n";
  628: 			}
  629: 		    } elsif ($counter eq 'index') {
  630: 			unless (defined($parms{'index'})) {
  631: 			    $maxindex++;
  632: 			    $parms{'index'}=$maxindex;
  633: 			    print $logfile 'Index: '.$tag.':'.$maxindex."\n";
  634: 			}
  635: 		    }
  636: 		}
  637: 		foreach my $type ('src','href','background','bgimg') {
  638: 		    foreach my $key (keys(%parms)) {
  639: 			if ($key =~ /^$type$/i) {
  640: 			    $parms{$key}=&set_allow(\%allow,$logfile,
  641: 						    $target,$tag,
  642: 						    $parms{$key});
  643: 			}
  644: 		    }
  645: 		}
  646: 		# probably a <randomlabel> image type <label>
  647: 		if ($lctag eq 'label' && defined($parms{'description'})) {
  648: 		    my $next_token=$parser[-1]->get_token();
  649: 		    if ($next_token->[0] eq 'T') {
  650: 			$next_token->[1]=&set_allow(\%allow,$logfile,
  651: 						    $target,$tag,
  652: 						    $next_token->[1]);
  653: 		    }
  654: 		    $parser[-1]->unget_token($next_token);
  655: 		}
  656: 		if ($lctag eq 'applet') {
  657: 		    my $codebase='';
  658: 		    if (defined($parms{'codebase'})) {
  659: 			my $oldcodebase=$parms{'codebase'};
  660: 			unless ($oldcodebase=~/\/$/) {
  661: 			    $oldcodebase.='/';
  662: 			}
  663: 			$codebase=&urlfixup($oldcodebase,$target);
  664: 			$codebase=~s/\/$//;    
  665: 			if ($codebase ne $oldcodebase) {
  666: 			    $parms{'codebase'}=$codebase;
  667: 			    print $logfile 'URL codebase: '.$tag.':'.
  668: 				$oldcodebase.' - '.
  669: 				    $codebase."\n";
  670: 			}
  671: 			$allow{&absoluteurl($codebase,$target).'/*'}=1;
  672: 		    } else {
  673: 			foreach ('archive','code','object') {
  674: 			    if (defined($parms{$_})) {
  675: 				my $oldurl=$parms{$_};
  676: 				my $newurl=&urlfixup($oldurl,$target);
  677: 				$newurl=~s/\/[^\/]+$/\/\*/;
  678: 				print $logfile 'Allow: applet '.$_.':'.
  679: 				    $oldurl.' allows '.
  680: 					$newurl."\n";
  681: 				$allow{&absoluteurl($newurl,$target)}=1;
  682: 			    }
  683: 			}
  684: 		    }
  685: 		}
  686: 		my $newparmstring='';
  687: 		my $endtag='';
  688: 		foreach (keys %parms) {
  689: 		    if ($_ eq '/') {
  690: 			$endtag=' /';
  691: 		    } else { 
  692: 			my $quote=($parms{$_}=~/\"/?"'":'"');
  693: 			$newparmstring.=' '.$_.'='.$quote.$parms{$_}.$quote;
  694: 		    }
  695: 		}
  696: 		if (!$endtag) { if ($token->[4]=~m:/>$:) { $endtag=' /'; }; }
  697: 		$outstring.='<'.$tag.$newparmstring.$endtag.'>';
  698: 		if ($lctag eq 'm') {
  699: 		    $outstring.=&get_all_text_unbalanced('/m',\@parser);
  700: 		}
  701: 	    } elsif ($token->[0] eq 'E') {
  702: 		if ($token->[2]) {
  703: 		    unless ($token->[1] eq 'allow') {
  704: 			$outstring.='</'.$token->[1].'>';
  705: 		    }
  706: 		}
  707: 	    } else {
  708: 		$outstring.=$token->[1];
  709: 	    }
  710: 	}
  711: 	pop(@parser);
  712:     }
  713: 
  714:     if ($needsfixup) {
  715: 	print $logfile "End of ID and/or index fixup\n".
  716: 	    "Max ID   : $maxid (min 10)\n".
  717: 		"Max Index: $maxindex (min 10)\n";
  718:     } else {
  719: 	print $logfile "Does not need ID and/or index fixup\n";
  720:     }
  721: 
  722:     return ($outstring,0,%allow);
  723: }
  724: 
  725: #########################################
  726: #########################################
  727: 
  728: =pod
  729: 
  730: =item B<store_metadata>
  731: 
  732: Store the metadata in the metadata table in the loncapa database.
  733: Uses lonmysql to access the database.
  734: 
  735: Inputs: \%metadata
  736: 
  737: Returns: (error,status).  error is undef on success, status is undef on error.
  738: 
  739: =cut
  740: 
  741: #########################################
  742: #########################################
  743: sub store_metadata {
  744:     my %metadata = %{shift()};
  745:     my $error;
  746:     # Determine if the table exists
  747:     my $status = &Apache::lonmysql::check_table('metadata');
  748:     if (! defined($status)) {
  749:         $error='<font color="red">WARNING: Cannot connect to '.
  750:             'database!</font>';
  751:         &Apache::lonnet::logthis($error);
  752:         return ($error,undef);
  753:     }
  754:     if ($status == 0) {
  755:         # It would be nice to actually create the table....
  756:         $error ='<font color="red">WARNING: The metadata table does not '.
  757:             'exist in the LON-CAPA database.</font>';
  758:         &Apache::lonnet::logthis($error);
  759:         return ($error,undef);
  760:     }
  761:     # Remove old value from table
  762:     $status = &Apache::lonmysql::remove_from_table
  763:         ('metadata','url',$metadata{'url'});
  764:     if (! defined($status)) {
  765:         $error = '<font color="red">Error when removing old values from '.
  766:             'metadata table in LON-CAPA database.</font>';
  767:         &Apache::lonnet::logthis($error);
  768:         return ($error,undef);
  769:     }
  770:     # Store data in table.
  771:     $status = &Apache::lonmysql::store_row('metadata',\%metadata);
  772:     if (! defined($status)) {
  773:         $error='<font color="red">Error occured storing new values in '.
  774:             'metadata table in LON-CAPA database</font>';
  775:         &Apache::lonnet::logthis($error);
  776:         return ($error,undef);
  777:     }
  778:     return (undef,$status);
  779: }
  780: 
  781: #########################################
  782: #########################################
  783: 
  784: =pod
  785: 
  786: =item B<publish>
  787: 
  788: This is the workhorse function of this module.  This subroutine generates
  789: backup copies, performs any automatic processing (prior to publication,
  790: especially for rat and ssi files),
  791: 
  792: Returns a 2 element array, the first is the string to be shown to the
  793: user, the second is an error code, either 1 (an error occured) or 0
  794: (no error occurred)
  795: 
  796: I<Additional documentation needed.>
  797: 
  798: =cut
  799: 
  800: #########################################
  801: #########################################
  802: sub publish {
  803: 
  804:     my ($source,$target,$style,$batch)=@_;
  805:     my $logfile;
  806:     my $scrout='';
  807:     my $allmeta='';
  808:     my $content='';
  809:     my %allow=();
  810: 
  811:     unless ($logfile=Apache::File->new('>>'.$source.'.log')) {
  812: 	return ('<font color="red">No write permission to user directory, FAIL</font>',1);
  813:     }
  814:     print $logfile 
  815: "\n\n================= Publish ".localtime()." Phase One  ================\n";
  816: 
  817:     if (($style eq 'ssi') || ($style eq 'rat') || ($style eq 'prv')) {
  818: # ------------------------------------------------------- This needs processing
  819: 
  820: # ----------------------------------------------------------------- Backup Copy
  821: 	my $copyfile=$source.'.save';
  822:         if (copy($source,$copyfile)) {
  823: 	    print $logfile "Copied original file to ".$copyfile."\n";
  824:         } else {
  825: 	    print $logfile "Unable to write backup ".$copyfile.':'.$!."\n";
  826: 	    return ("<font color=\"red\">Failed to write backup copy, $!,FAIL</font>",1);
  827:         }
  828: # ------------------------------------------------------------- IDs and indices
  829: 	
  830: 	my ($outstring,$error);
  831: 	($outstring,$error,%allow)=&fix_ids_and_indices($logfile,$source,
  832: 							$target);
  833: 	if ($error) { return ($outstring,$error); }
  834: # ------------------------------------------------------------ Construct Allows
  835:     
  836: 	$scrout.='<h3>Dependencies</h3>';
  837:         my $allowstr='';
  838:         foreach (sort(keys(%allow))) {
  839: 	   my $thisdep=$_;
  840: 	   if ($thisdep !~ /[^\s]/) { next; }
  841:            unless ($style eq 'rat') { 
  842:               $allowstr.="\n".'<allow src="'.$thisdep.'" />';
  843: 	   }
  844:            $scrout.='<br />';
  845:            unless ($thisdep=~/\*/) {
  846: 	       $scrout.='<a href="'.$thisdep.'">';
  847:            }
  848:            $scrout.='<tt>'.$thisdep.'</tt>';
  849:            unless ($thisdep=~/\*/) {
  850: 	       $scrout.='</a>';
  851:                if (
  852:        &Apache::lonnet::getfile($Apache::lonnet::perlvar{'lonDocRoot'}.'/'.
  853:                                             $thisdep.'.meta') eq '-1') {
  854: 		   $scrout.= ' - <font color="red">Currently not available'.
  855: 		       '</font>';
  856:                } else {
  857:                    my %temphash=(&Apache::lonnet::declutter($target).'___'.
  858:                              &Apache::lonnet::declutter($thisdep).'___usage'
  859:                                  => time);
  860:                    $thisdep=~/^\/res\/(\w+)\/(\w+)\//;
  861:                    if ((defined($1)) && (defined($2))) {
  862:                       &Apache::lonnet::put('nohist_resevaldata',\%temphash,
  863: 					   $1,$2);
  864: 		   }
  865: 	       }
  866:            }
  867:         }
  868:         $outstring=~s/\n*(\<\/[^\>]+\>)\s*$/$allowstr\n$1\n/s;
  869: 
  870: 	#Encode any High ASCII characters
  871: 	$outstring=&HTML::Entities::encode($outstring,"\200-\377");
  872: # ------------------------------------------------------------- Write modified.
  873: 
  874:         {
  875:           my $org;
  876:           unless ($org=Apache::File->new('>'.$source)) {
  877:              print $logfile "No write permit to $source\n";
  878:              return ('<font color="red">No write permission to '.$source.
  879: 		     ', FAIL</font>',1);
  880: 	  }
  881:           print($org $outstring);
  882:         }
  883: 	  $content=$outstring;
  884: 
  885:     }
  886: # -------------------------------------------- Initial step done, now metadata.
  887: 
  888: # --------------------------------------- Storage for metadata keys and fields.
  889: 
  890:      %metadatafields=();
  891:      %metadatakeys=();
  892:      
  893:      my %oldparmstores=();
  894:      
  895:     unless ($batch) {
  896:      $scrout.='<h3>Metadata Information ' .
  897:        Apache::loncommon::help_open_topic("Metadata_Description")
  898:        . '</h3>';
  899:     }
  900: 
  901: # ------------------------------------------------ First, check out environment
  902:      unless (-e $source.'.meta') {
  903:         $metadatafields{'author'}=$ENV{'environment.firstname'}.' '.
  904: 	                          $ENV{'environment.middlename'}.' '.
  905: 		                  $ENV{'environment.lastname'}.' '.
  906: 		                  $ENV{'environment.generation'};
  907:         $metadatafields{'author'}=~s/\s+/ /g;
  908:         $metadatafields{'author'}=~s/\s+$//;
  909:         $metadatafields{'owner'}=$cuname.'@'.$cudom;
  910: 
  911: # ------------------------------------------------ Check out directory hierachy
  912: 
  913:         my $thisdisfn=$source;
  914:         $thisdisfn=~s/^\/home\/\Q$cuname\E\///;
  915: 
  916:         my @urlparts=split(/\//,$thisdisfn);
  917:         $#urlparts--;
  918: 
  919:         my $currentpath='/home/'.$cuname.'/';
  920: 
  921:         foreach (@urlparts) {
  922: 	    $currentpath.=$_.'/';
  923:             $scrout.=&metaread($logfile,$currentpath.'default.meta');
  924:         }
  925: 
  926: # ------------------- Clear out parameters and stores (there should not be any)
  927: 
  928:         foreach (keys %metadatafields) {
  929: 	    if (($_=~/^parameter/) || ($_=~/^stores/)) {
  930: 		delete $metadatafields{$_};
  931:             }
  932:         }
  933: 
  934:     } else {
  935: # ---------------------- Read previous metafile, remember parameters and stores
  936: 
  937:         $scrout.=&metaread($logfile,$source.'.meta');
  938: 
  939:         foreach (keys %metadatafields) {
  940: 	    if (($_=~/^parameter/) || ($_=~/^stores/)) {
  941:                 $oldparmstores{$_}=1;
  942: 		delete $metadatafields{$_};
  943:             }
  944:         }
  945:         
  946:     }
  947: 
  948: # -------------------------------------------------- Parse content for metadata
  949:     if (($style eq 'ssi') || ($style eq 'prv')) {
  950:         my $oldenv=$ENV{'request.uri'};
  951: 
  952:         $ENV{'request.uri'}=$target;
  953:         $allmeta=Apache::lonxml::xmlparse(undef,'meta',$content);
  954:         $ENV{'request.uri'}=$oldenv;
  955: 
  956:         &metaeval($allmeta);
  957:     }
  958: # ---------------- Find and document discrepancies in the parameters and stores
  959: 
  960:     my $chparms='';
  961:     foreach (sort keys %metadatafields) {
  962: 	if (($_=~/^parameter/) || ($_=~/^stores/)) {
  963: 	    unless ($_=~/\.\w+$/) { 
  964: 		unless ($oldparmstores{$_}) {
  965: 		    print $logfile 'New: '.$_."\n";
  966: 		    $chparms.=$_.' ';
  967: 		}
  968: 	    }
  969: 	}
  970:     }
  971:     if ($chparms) {
  972: 	$scrout.='<p><b>New parameters or stored values:</b> '.$chparms.'</p>';
  973:     }
  974: 
  975:     $chparms='';
  976:     foreach (sort keys %oldparmstores) {
  977: 	if (($_=~/^parameter/) || ($_=~/^stores/)) {
  978: 	    unless (($metadatafields{$_.'.name'}) ||
  979: 		    ($metadatafields{$_.'.package'}) || ($_=~/\.\w+$/)) {
  980: 		print $logfile 'Obsolete: '.$_."\n";
  981: 		$chparms.=$_.' ';
  982: 	    }
  983: 	}
  984:     }
  985:     if ($chparms) {
  986: 	$scrout.='<p><b>Obsolete parameters or stored values:</b> '.
  987: 	    $chparms.'</p>';
  988:     }
  989: 
  990: # ------------------------------------------------------- Now have all metadata
  991: 
  992:     my %keywords=();
  993:         
  994:     if (length($content)<500000) {
  995: 	my $textonly=$content;
  996: 	$textonly=~s/\<script[^\<]+\<\/script\>//g;
  997: 	$textonly=~s/\<m\>[^\<]+\<\/m\>//g;
  998: 	$textonly=~s/\<[^\>]*\>//g;
  999: 	$textonly=~tr/A-Z/a-z/;
 1000: 	$textonly=~s/[\$\&][a-z]\w*//g;
 1001: 	$textonly=~s/[^a-z\s]//g;
 1002: 	
 1003: 	foreach ($textonly=~m/(\w+)/g) {
 1004: 	    unless ($nokey{$_}) {
 1005: 		$keywords{$_}=1;
 1006: 	    } 
 1007: 	}
 1008:     }
 1009: 
 1010:             
 1011:     foreach (split(/\W+/,$metadatafields{'keywords'})) {
 1012: 	$keywords{$_}=1;
 1013:     }
 1014: # --------------------------------------------------- Now we also have keywords
 1015: # =============================================================================
 1016: # INTERACTIVE MODE
 1017: #
 1018:     unless ($batch) {
 1019:         $scrout.=
 1020: 	    '<form name="pubform" action="/adm/publish" method="post">'.
 1021:             '<p><input type="submit" value="Finalize Publication" /></p>'.
 1022:             &hiddenfield('phase','two').
 1023:             &hiddenfield('filename',$ENV{'form.filename'}).
 1024: 	    &hiddenfield('allmeta',&Apache::lonnet::escape($allmeta)).
 1025:             &hiddenfield('dependencies',join(',',keys %allow)).
 1026:             &textfield('Title','title',$metadatafields{'title'}).
 1027:             &textfield('Author(s)','author',$metadatafields{'author'}).
 1028: 	    &textfield('Subject','subject',$metadatafields{'subject'});
 1029: 
 1030: # --------------------------------------------------- Scan content for keywords
 1031: 
 1032:         my $keywords_help = Apache::loncommon::help_open_topic("Publishing_Keywords");
 1033: 	my $keywordout=<<"END";
 1034: <script>
 1035: function checkAll(field) {
 1036:     for (i = 0; i < field.length; i++)
 1037:         field[i].checked = true ;
 1038: }
 1039: 
 1040: function uncheckAll(field) {
 1041:     for (i = 0; i < field.length; i++)
 1042:         field[i].checked = false ;
 1043: }
 1044: </script>
 1045: <p><b>Keywords: $keywords_help</b> 
 1046: <input type="button" value="check all" onclick="javascript:checkAll(document.pubform.keywords)" /> 
 1047: <input type="button" value="uncheck all" onclick="javascript:uncheckAll(document.pubform.keywords)" /> 
 1048: </p>
 1049: <br />
 1050: END
 1051: 	$keywordout.='<table border="2"><tr>';
 1052: 	my $colcount=0;
 1053: 
 1054: 	foreach (sort keys %keywords) {
 1055: 	    $keywordout.='<td><input type="checkbox" name="keywords" value="'.$_.'"';
 1056: 	    if ($metadatafields{'keywords'}) {
 1057: 		if ($metadatafields{'keywords'}=~/\Q$_\E/) {
 1058: 		    $keywordout.=' checked="on"';
 1059: 		}
 1060: 	    } elsif (&Apache::loncommon::keyword($_)) {
 1061: 		$keywordout.=' checked="on"';
 1062: 	    }
 1063: 	    $keywordout.=' />'.$_.'</td>';
 1064: 	    if ($colcount>10) {
 1065: 		$keywordout.="</tr><tr>\n";
 1066: 		$colcount=0;
 1067: 	    }
 1068: 	    $colcount++;
 1069: 	}
 1070: 
 1071: 	$keywordout.='</tr></table>';
 1072: 
 1073: 	$scrout.=$keywordout;
 1074: 
 1075: 	$scrout.=&textfield('Additional Keywords','addkey','');
 1076: 
 1077: 	$scrout.=&textfield('Notes','notes',$metadatafields{'notes'});
 1078: 
 1079: 	$scrout.=
 1080: 	    '<p><b>Abstract:</b><br /><textarea cols="80" rows="5" name="abstract">'.
 1081: 	    $metadatafields{'abstract'}.'</textarea></p>';
 1082: 
 1083: 	$source=~/\.(\w+)$/;
 1084: 
 1085: 	$scrout.=&hiddenfield('mime',$1);
 1086: 
 1087: 	$scrout.=&selectbox('Language','language',
 1088: 			    $metadatafields{'language'},
 1089: 			    \&Apache::loncommon::languagedescription,
 1090: 			    (&Apache::loncommon::languageids),
 1091: 			   );
 1092: 
 1093: 	unless ($metadatafields{'creationdate'}) {
 1094: 	    $metadatafields{'creationdate'}=time;
 1095: 	}
 1096: 	$scrout.=&hiddenfield('creationdate',
 1097: 			      &Apache::loncommon::unsqltime($metadatafields{'creationdate'}));
 1098: 
 1099: 	$scrout.=&hiddenfield('lastrevisiondate',time);
 1100: 
 1101: 
 1102: 	$scrout.=&textfield('Publisher/Owner','owner',
 1103: 			    $metadatafields{'owner'});
 1104: 
 1105: # -------------------------------------------------- Correct copyright for rat.
 1106:         my $defaultoption=$metadatafields{'copyright'};
 1107:         unless ($defaultoption) { $defaultoption='default'; }
 1108: 	unless ($style eq 'prv') {
 1109: 	    if ($style eq 'rat') {
 1110: 		if ($metadatafields{'copyright'} eq 'public') { 
 1111: 		    delete $metadatafields{'copyright'};
 1112:                     $defaultoption='default';
 1113: 		}
 1114: 		$scrout.=&selectbox('Copyright/Distribution','copyright',
 1115: 				    $defaultoption,
 1116: 				    \&Apache::loncommon::copyrightdescription,
 1117: 				    (grep !/^public$/,(&Apache::loncommon::copyrightids)));
 1118: 	    } else {
 1119: 		$scrout.=&selectbox('Copyright/Distribution','copyright',
 1120: 				    $defaultoption,
 1121: 				    \&Apache::loncommon::copyrightdescription,
 1122: 				    (&Apache::loncommon::copyrightids));
 1123: 	    }
 1124:     
 1125: 	    my $copyright_help =
 1126: 		Apache::loncommon::help_open_topic('Publishing_Copyright');
 1127: 	    $scrout =~ s/DISTRIBUTION:/'DISTRIBUTION: ' . $copyright_help/ge;
 1128: 	    $scrout.=&textfield('Custom Distribution File','customdistributionfile',
 1129: 				$metadatafields{'customdistributionfile'}).
 1130: 				    $copyright_help;
 1131: 	} else {
 1132: 	    $scrout.=&hiddenfield('copyright','private');
 1133: 	}
 1134: 	return ($scrout.'<p><input type="submit" value="Finalize Publication" /></p></form>',0);
 1135: # =============================================================================
 1136: # BATCH MODE
 1137: #
 1138:     } else {
 1139: # Transfer metadata directly to environment for stage 2
 1140: 	foreach (keys %metadatafields) {
 1141: 	    $ENV{'form.'.$_}=$metadatafields{$_};
 1142: 	}
 1143: 	$ENV{'form.addkey'}='';
 1144: 	$ENV{'form.keywords'}='';
 1145: 	foreach (keys %keywords) {
 1146: 	    if ($metadatafields{'keywords'}) {
 1147: 		if ($metadatafields{'keywords'}=~/\Q$_\E/) { 
 1148: 		    $ENV{'form.keywords'}.=$_.','; 
 1149: 		}
 1150: 	    } elsif (&Apache::loncommon::keyword($_)) {
 1151: 		$ENV{'form.keywords'}.=$_.',';
 1152: 	    }
 1153: 	}
 1154: 	$ENV{'form.keywords'}=~s/\,$//;
 1155: 	unless ($ENV{'form.creationdate'}) { $ENV{'form.creationdate'}=time; }
 1156: 	$ENV{'form.lastrevisiondate'}=time;
 1157: 	if ((($style eq 'rat') && ($ENV{'form.copyright'} eq 'public')) ||
 1158: 	    (!$ENV{'form.copyright'})) { 
 1159: 	    $ENV{'form.copyright'}='default';
 1160: 	}
 1161: 	$ENV{'form.allmeta'}=&Apache::lonnet::escape($allmeta);
 1162: 	return ($scrout,0);
 1163:     }
 1164: }
 1165: 
 1166: #########################################
 1167: #########################################
 1168: 
 1169: =pod 
 1170: 
 1171: =item B<phasetwo>
 1172: 
 1173: Render second interface showing status of publication steps.
 1174: This is publication step two.
 1175: 
 1176: Parameters:
 1177: 
 1178: =over 4
 1179: 
 1180: =item I<$source>
 1181: 
 1182: =item I<$target>
 1183: 
 1184: =item I<$style>
 1185: 
 1186: =item I<$distarget>
 1187: 
 1188: =back
 1189: 
 1190: Returns:
 1191: 
 1192: =over 4
 1193: 
 1194: =item Scalar string
 1195: 
 1196: String contains status (errors and warnings) and information associated with
 1197: the server's attempts at publication.     
 1198: 
 1199: =cut
 1200: 
 1201: #'stupid emacs
 1202: #########################################
 1203: #########################################
 1204: sub phasetwo {
 1205: 
 1206:     my ($r,$source,$target,$style,$distarget,$batch)=@_;
 1207:     $source=~s/\/+/\//g;
 1208:     $target=~s/\/+/\//g;
 1209: 
 1210:     if ($target=~/\_\_\_/) {
 1211: 	$r->print(
 1212:  '<font color="red">Unsupported character combination "<tt>___</tt>" in filename, FAIL</font>');
 1213:         return 0;
 1214:     }
 1215:     $distarget=~s/\/+/\//g;
 1216:     my $logfile;
 1217:     unless ($logfile=Apache::File->new('>>'.$source.'.log')) {
 1218: 	$r->print(
 1219:         '<font color="red">No write permission to user directory, FAIL</font>');
 1220:         return 0;
 1221:     }
 1222:     print $logfile 
 1223:         "\n================= Publish ".localtime()." Phase Two  ================\n";
 1224:     
 1225:     %metadatafields=();
 1226:     %metadatakeys=();
 1227:     
 1228:     &metaeval(&Apache::lonnet::unescape($ENV{'form.allmeta'}));
 1229:     
 1230:     $metadatafields{'title'}=$ENV{'form.title'};
 1231:     $metadatafields{'author'}=$ENV{'form.author'};
 1232:     $metadatafields{'subject'}=$ENV{'form.subject'};
 1233:     $metadatafields{'notes'}=$ENV{'form.notes'};
 1234:     $metadatafields{'abstract'}=$ENV{'form.abstract'};
 1235:     $metadatafields{'mime'}=$ENV{'form.mime'};
 1236:     $metadatafields{'language'}=$ENV{'form.language'};
 1237:     $metadatafields{'creationdate'}=$ENV{'form.creationdate'};
 1238:     $metadatafields{'lastrevisiondate'}=$ENV{'form.lastrevisiondate'};
 1239:     $metadatafields{'owner'}=$ENV{'form.owner'};
 1240:     $metadatafields{'copyright'}=$ENV{'form.copyright'};
 1241:     $metadatafields{'customdistributionfile'}=
 1242:                                  $ENV{'form.customdistributionfile'};
 1243:     $metadatafields{'dependencies'}=$ENV{'form.dependencies'};
 1244:     
 1245:     my $allkeywords=$ENV{'form.addkey'};
 1246:     if (exists($ENV{'form.keywords'})) {
 1247:         if (ref($ENV{'form.keywords'})) {
 1248:             $allkeywords .= ','.join(',',@{$ENV{'form.keywords'}});
 1249:         } else {
 1250:             $allkeywords .= ','.$ENV{'form.keywords'};
 1251:         }
 1252:     }
 1253:     $allkeywords=~s/\W+/\,/;
 1254:     $allkeywords=~s/^\,//;
 1255:     $metadatafields{'keywords'}=$allkeywords;
 1256:     
 1257:     {
 1258:         print $logfile "\nWrite metadata file for ".$source;
 1259:         my $mfh;
 1260:         unless ($mfh=Apache::File->new('>'.$source.'.meta')) {
 1261:             return 
 1262:                 '<font color="red">Could not write metadata, FAIL</font>';
 1263:         }
 1264:         foreach (sort keys %metadatafields) {
 1265:             unless ($_=~/\./) {
 1266:                 my $unikey=$_;
 1267:                 $unikey=~/^([A-Za-z]+)/;
 1268:                 my $tag=$1;
 1269:                 $tag=~tr/A-Z/a-z/;
 1270:                 print $mfh "\n\<$tag";
 1271:                 foreach (split(/\,/,$metadatakeys{$unikey})) {
 1272:                     my $value=$metadatafields{$unikey.'.'.$_};
 1273:                     $value=~s/\"/\'\'/g;
 1274:                     print $mfh ' '.$_.'="'.$value.'"';
 1275:                 }
 1276:                 print $mfh '>'.
 1277:                     &HTML::Entities::encode($metadatafields{$unikey})
 1278:                         .'</'.$tag.'>';
 1279:             }
 1280:         }
 1281:         $r->print('<p>Wrote Metadata</p>');
 1282:         print $logfile "\nWrote metadata";
 1283:     }
 1284:     
 1285: # -------------------------------- Synchronize entry with SQL metadata database
 1286: 
 1287:     $metadatafields{'url'} = $distarget;
 1288:     $metadatafields{'version'} = 'current';
 1289:     unless ($metadatafields{'copyright'} eq 'priv') {
 1290:         my ($error,$success) = &store_metadata(\%metadatafields);
 1291:         if ($success) {
 1292:             $r->print('<p>Synchronized SQL metadata database</p>');
 1293:             print $logfile "\nSynchronized SQL metadata database";
 1294:         } else {
 1295:             $r->print($error);
 1296:             print $logfile "\n".$error;
 1297:         }
 1298:     } else {
 1299:         $r->print('<p>Private Publication - did not synchronize database</p>');
 1300:         print $logfile "\nPrivate: Did not synchronize data into ".
 1301:             "SQL metadata database";
 1302:     }
 1303: # ----------------------------------------------------------- Copy old versions
 1304:    
 1305:     if (-e $target) {
 1306:         my $filename;
 1307:         my $maxversion=0;
 1308:         $target=~/(.*)\/([^\/]+)\.(\w+)$/;
 1309:         my $srcf=$2;
 1310:         my $srct=$3;
 1311:         my $srcd=$1;
 1312:         unless ($srcd=~/^\/home\/httpd\/html\/res/) {
 1313:             print $logfile "\nPANIC: Target dir is ".$srcd;
 1314:             return "<font color=\"red\">Invalid target directory, FAIL</font>";
 1315:         }
 1316:         opendir(DIR,$srcd);
 1317:         while ($filename=readdir(DIR)) {
 1318:             if (-l $srcd.'/'.$filename) {
 1319:                 unlink($srcd.'/'.$filename);
 1320:                 unlink($srcd.'/'.$filename.'.meta');
 1321:             } else {
 1322:                 if ($filename=~/\Q$srcf\E\.(\d+)\.\Q$srct\E$/) {
 1323:                     $maxversion=($1>$maxversion)?$1:$maxversion;
 1324:                 }
 1325:             }
 1326:         }
 1327:         closedir(DIR);
 1328:         $maxversion++;
 1329:         $r->print('<p>Creating old version '.$maxversion.'</p>');
 1330:         print $logfile "\nCreating old version ".$maxversion;
 1331:         
 1332:         my $copyfile=$srcd.'/'.$srcf.'.'.$maxversion.'.'.$srct;
 1333:         
 1334:         if (copy($target,$copyfile)) {
 1335: 	    print $logfile "Copied old target to ".$copyfile."\n";
 1336:             $r->print('<p>Copied old target file</p>');
 1337:         } else {
 1338: 	    print $logfile "Unable to write ".$copyfile.':'.$!."\n";
 1339:             return "<font color=\"red\">Failed to copy old target, $!, FAIL</font>";
 1340:         }
 1341:         
 1342: # --------------------------------------------------------------- Copy Metadata
 1343: 
 1344: 	$copyfile=$copyfile.'.meta';
 1345:         
 1346:         if (copy($target.'.meta',$copyfile)) {
 1347: 	    print $logfile "Copied old target metadata to ".$copyfile."\n";
 1348:             $r->print('<p>Copied old metadata</p>')
 1349:         } else {
 1350: 	    print $logfile "Unable to write metadata ".$copyfile.':'.$!."\n";
 1351:             if (-e $target.'.meta') {
 1352:                 return 
 1353:                     "<font color=\"red\">Failed to write old metadata copy, $!, FAIL</font>";
 1354: 	    }
 1355:         }
 1356:         
 1357:         
 1358:     } else {
 1359:         $r->print('<p>Initial version</p>');
 1360:         print $logfile "\nInitial version";
 1361:     }
 1362: 
 1363: # ---------------------------------------------------------------- Write Source
 1364:     my $copyfile=$target;
 1365:     
 1366:     my @parts=split(/\//,$copyfile);
 1367:     my $path="/$parts[1]/$parts[2]/$parts[3]/$parts[4]";
 1368:     
 1369:     my $count;
 1370:     for ($count=5;$count<$#parts;$count++) {
 1371:         $path.="/$parts[$count]";
 1372:         if ((-e $path)!=1) {
 1373:             print $logfile "\nCreating directory ".$path;
 1374:             $r->print('<p>Created directory '.$parts[$count].'</p>');
 1375:             mkdir($path,0777);
 1376:         }
 1377:     }
 1378:     
 1379:     if (copy($source,$copyfile)) {
 1380:         print $logfile "\nCopied original source to ".$copyfile."\n";
 1381:         $r->print('<p>Copied source file</p>');
 1382:     } else {
 1383:         print $logfile "\nUnable to write ".$copyfile.':'.$!."\n";
 1384:         return "<font color=\"red\">Failed to copy source, $!, FAIL</font>";
 1385:     }
 1386:     
 1387: # --------------------------------------------------------------- Copy Metadata
 1388: 
 1389:     $copyfile=$copyfile.'.meta';
 1390:     
 1391:     if (copy($source.'.meta',$copyfile)) {
 1392:         print $logfile "\nCopied original metadata to ".$copyfile."\n";
 1393:         $r->print('<p>Copied metadata</p>');
 1394:     } else {
 1395:         print $logfile "\nUnable to write metadata ".$copyfile.':'.$!."\n";
 1396:         return 
 1397:             "<font color=\"red\">Failed to write metadata copy, $!, FAIL</font>";
 1398:     }
 1399:     $r->rflush;
 1400: # --------------------------------------------------- Send update notifications
 1401: 
 1402:     my @subscribed=&get_subscribed_hosts($target);
 1403:     foreach my $subhost (@subscribed) {
 1404: 	$r->print('<p>Notifying host '.$subhost.':');$r->rflush;
 1405: 	print $logfile "\nNotifying host ".$subhost.':';
 1406: 	my $reply=&Apache::lonnet::critical('update:'.$target,$subhost);
 1407: 	$r->print($reply.'</p><br />');$r->rflush;
 1408: 	print $logfile $reply;
 1409:     }
 1410:     
 1411: # ---------------------------------------- Send update notifications, meta only
 1412: 
 1413:     my @subscribedmeta=&get_subscribed_hosts("$target.meta");
 1414:     foreach my $subhost (@subscribedmeta) {
 1415: 	$r->print('<p>Notifying host for metadata only '.$subhost.':');$r->rflush;
 1416: 	print $logfile "\nNotifying host for metadata only ".$subhost.':';
 1417: 	my $reply=&Apache::lonnet::critical('update:'.$target.'.meta',
 1418: 					    $subhost);
 1419: 	$r->print($reply.'</p><br />');$r->rflush;
 1420: 	print $logfile $reply;
 1421:     }
 1422:     
 1423: # --------------------------------------------------- Notify subscribed courses
 1424:     my %courses=&coursedependencies($target);
 1425:     my $now=time;
 1426:     foreach (keys %courses) {
 1427: 	$r->print('<p>Notifying course '.$_.':');$r->rflush;
 1428: 	print $logfile "\nNotifying host ".$_.':';
 1429:         my ($cdom,$cname)=split(/\_/,$_);
 1430: 	my $reply=&Apache::lonnet::cput
 1431:                   ('versionupdate',{$target => $now},$cdom,$cname);
 1432: 	$r->print($reply.'</p><br />');$r->rflush;
 1433: 	print $logfile $reply;
 1434:     }
 1435: # ------------------------------------------------ Provide link to new resource
 1436:     unless ($batch) {
 1437:         my $thisdistarget=$target;
 1438:         $thisdistarget=~s/^\Q$docroot\E//;
 1439:         
 1440:         my $thissrc=$source;
 1441:         $thissrc=~s/^\/home\/(\w+)\/public_html/\/priv\/$1/;
 1442:         
 1443:         my $thissrcdir=$thissrc;
 1444:         $thissrcdir=~s/\/[^\/]+$/\//;
 1445:         
 1446:         
 1447:         $r->print(
 1448:            '<hr /><a href="'.$thisdistarget.'"><font size="+2">'.
 1449:            'View Published Version</font></a>'.
 1450:            '<p><a href="'.$thissrc.'"><font size=+2>Back to Source</font></a></p>'.
 1451:            '<p><a href="'.$thissrcdir.
 1452:                    '"><font size="+2">Back to Source Directory</font></a></p>');
 1453:     }
 1454: }
 1455: 
 1456: #########################################
 1457: 
 1458: sub batchpublish {
 1459:     my ($r,$srcfile,$targetfile)=@_;
 1460:     $srcfile=~s/\/+/\//g;
 1461:     $targetfile=~s/\/+/\//g;
 1462:     my $thisdisfn=$srcfile;
 1463:     $thisdisfn=~s/\/home\/korte\/public_html\///;
 1464:     $srcfile=~s/\/+/\//g;
 1465: 
 1466:     my $docroot=$r->dir_config('lonDocRoot');
 1467:     my $thisdistarget=$targetfile;
 1468:     $thisdistarget=~s/^\Q$docroot\E//;
 1469: 
 1470: 
 1471:     undef %metadatafields;
 1472:     undef %metadatakeys;
 1473:      %metadatafields=();
 1474:      %metadatakeys=();
 1475:       $srcfile=~/\.(\w+)$/;
 1476:       my $thistype=$1;
 1477: 
 1478: 
 1479:       my $thisembstyle=&Apache::loncommon::fileembstyle($thistype);
 1480:      
 1481:     $r->print('<h2>Publishing <tt>'.$thisdisfn.'</tt></h2>');
 1482: 
 1483: # phase one takes
 1484: #  my ($source,$target,$style,$batch)=@_;
 1485:     my ($outstring,$error)=&publish($srcfile,$targetfile,$thisembstyle,1);
 1486:     $r->print('<p>'.$outstring.'</p>');
 1487: # phase two takes
 1488: # my ($source,$target,$style,$distarget,batch)=@_;
 1489: # $ENV{'form.allmeta'},$ENV{'form.title'},$ENV{'form.author'},...
 1490:     if (!$error) {
 1491: 	$r->print('<p>');
 1492: 	&phasetwo($r,$srcfile,$targetfile,$thisembstyle,$thisdistarget,1);
 1493: 	$r->print('</p>');
 1494:     }
 1495:     return '';
 1496: }
 1497: 
 1498: #########################################
 1499: 
 1500: sub publishdirectory {
 1501:     my ($r,$fn,$thisdisfn)=@_;
 1502:     $fn=~s/\/+/\//g;
 1503:     $thisdisfn=~s/\/+/\//g;
 1504:     my $resdir=
 1505:     $Apache::lonnet::perlvar{'lonDocRoot'}.'/res/'.$cudom.'/'.$cuname.'/'.
 1506:       $thisdisfn;
 1507:       $r->print('<h1>Directory <tt>'.$thisdisfn.'</tt></h1>'.
 1508:                 'Target: <tt>'.$resdir.'</tt><br />');
 1509: 
 1510:       my $dirptr=16384;		# Mask indicating a directory in stat.cmode.
 1511: 
 1512:       opendir(DIR,$fn);
 1513:       my @files=sort(readdir(DIR));
 1514:       foreach my $filename (@files) {
 1515:          my ($cdev,$cino,$cmode,$cnlink,
 1516:             $cuid,$cgid,$crdev,$csize,
 1517:             $catime,$cmtime,$cctime,
 1518:             $cblksize,$cblocks)=stat($fn.'/'.$filename);
 1519: 
 1520:          my $extension='';
 1521:          if ($filename=~/\.(\w+)$/) { $extension=$1; }
 1522:          if ($cmode&$dirptr) {
 1523: 	   if (($filename!~/^\./) && ($ENV{'form.pubrec'})) {
 1524: 	      &publishdirectory($r,$fn.'/'.$filename,$thisdisfn.'/'.$filename);
 1525: 	   }
 1526:          } elsif ((&Apache::loncommon::fileembstyle($extension) ne 'hdn') &&
 1527:                   ($filename!~/^[\#\.]/) && ($filename!~/\~$/)) {
 1528: # find out publication status and/or exiting metadata
 1529: 	     my $publishthis=0;
 1530:              if (-e $resdir.'/'.$filename) {
 1531: 	        my ($rdev,$rino,$rmode,$rnlink,
 1532: 	        $ruid,$rgid,$rrdev,$rsize,
 1533: 	        $ratime,$rmtime,$rctime,
 1534: 	        $rblksize,$rblocks)=stat($resdir.'/'.$filename);
 1535: 	        if ($rmtime<$cmtime) {
 1536: # previously published, modified now
 1537: 		    $publishthis=1;
 1538:                 }
 1539: 	     } else {
 1540: # never published
 1541: 		 $publishthis=1;
 1542: 	     }
 1543:              if ($publishthis) {
 1544:                 &batchpublish($r,$fn.'/'.$filename,$resdir.'/'.$filename);
 1545: 	     } else {
 1546:                  $r->print('<br />Skipping '.$filename.'<br />');
 1547:              }
 1548:              $r->rflush();
 1549:          }
 1550:       }
 1551:       closedir(DIR);
 1552: }
 1553: #########################################
 1554: 
 1555: =pod
 1556: 
 1557: =item B<handler>
 1558: 
 1559: A basic outline of the handler subroutine follows.
 1560: 
 1561: =over 4
 1562: 
 1563: =item *
 1564: 
 1565: Get query string for limited number of parameters.
 1566: 
 1567: =item *
 1568: 
 1569: Check filename.
 1570: 
 1571: =item *
 1572: 
 1573: File is there and owned, init lookup tables.
 1574: 
 1575: =item *
 1576: 
 1577: Start page output.
 1578: 
 1579: =item *
 1580: 
 1581: Evaluate individual file, and then output information.
 1582: 
 1583: =item *
 1584: 
 1585: Publishing from $thisfn to $thistarget with $thisembstyle.
 1586: 
 1587: =back
 1588: 
 1589: =cut
 1590: 
 1591: #########################################
 1592: #########################################
 1593: sub handler {
 1594:   my $r=shift;
 1595: 
 1596:   if ($r->header_only) {
 1597:      $r->content_type('text/html');
 1598:      $r->send_http_header;
 1599:      return OK;
 1600:   }
 1601: 
 1602: # Get query string for limited number of parameters
 1603: 
 1604:     &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},
 1605:                                             ['filename']);
 1606: 
 1607: # -------------------------------------------------------------- Check filename
 1608: 
 1609:   my $fn=&Apache::lonnet::unescape($ENV{'form.filename'});
 1610: 
 1611:   
 1612:   unless ($fn) { 
 1613:      $r->log_reason($cuname.' at '.$cudom.
 1614:          ' trying to publish empty filename', $r->filename); 
 1615:      return HTTP_NOT_FOUND;
 1616:   } 
 1617: 
 1618:   ($cuname,$cudom)=
 1619:     &Apache::loncacc::constructaccess($fn,$r->dir_config('lonDefDomain'));
 1620:   unless (($cuname) && ($cudom)) {
 1621:      $r->log_reason($cuname.' at '.$cudom.
 1622:          ' trying to publish file '.$ENV{'form.filename'}.
 1623:          ' ('.$fn.') - not authorized', 
 1624:          $r->filename); 
 1625:      return HTTP_NOT_ACCEPTABLE;
 1626:   }
 1627: 
 1628:   unless (&Apache::lonnet::homeserver($cuname,$cudom) 
 1629:           eq $r->dir_config('lonHostID')) {
 1630:      $r->log_reason($cuname.' at '.$cudom.
 1631:          ' trying to publish file '.$ENV{'form.filename'}.
 1632:          ' ('.$fn.') - not homeserver ('.
 1633:          &Apache::lonnet::homeserver($cuname,$cudom).')', 
 1634:          $r->filename); 
 1635:      return HTTP_NOT_ACCEPTABLE;
 1636:   }
 1637: 
 1638:   $fn=~s/^http\:\/\/[^\/]+//;
 1639:   $fn=~s/^\/\~(\w+)/\/home\/$1\/public_html/;
 1640: 
 1641:   my $targetdir='';
 1642:   $docroot=$r->dir_config('lonDocRoot'); 
 1643:   if ($1 ne $cuname) {
 1644:      $r->log_reason($cuname.' at '.$cudom.
 1645:          ' trying to publish unowned file '.$ENV{'form.filename'}.
 1646:          ' ('.$fn.')', 
 1647:          $r->filename); 
 1648:      return HTTP_NOT_ACCEPTABLE;
 1649:   } else {
 1650:       $targetdir=$docroot.'/res/'.$cudom;
 1651:   }
 1652:                                  
 1653:   
 1654:   unless (-e $fn) { 
 1655:      $r->log_reason($cuname.' at '.$cudom.
 1656:          ' trying to publish non-existing file '.$ENV{'form.filename'}.
 1657:          ' ('.$fn.')', 
 1658:          $r->filename); 
 1659:      return HTTP_NOT_FOUND;
 1660:   } 
 1661: 
 1662: unless ($ENV{'form.phase'} eq 'two') {
 1663: 
 1664: # -------------------------------- File is there and owned, init lookup tables.
 1665: 
 1666:   %addid=();
 1667: 
 1668:   {
 1669:       my $fh=Apache::File->new($r->dir_config('lonTabDir').'/addid.tab');
 1670:       while (<$fh>=~/(\w+)\s+(\w+)/) {
 1671:           $addid{$1}=$2;
 1672:       }
 1673:   }
 1674: 
 1675:   %nokey=();
 1676: 
 1677:   {
 1678:      my $fh=Apache::File->new($r->dir_config('lonIncludes').'/un_keyword.tab');
 1679:       while (<$fh>) {
 1680:           my $word=$_;
 1681:           chomp($word);
 1682:           $nokey{$word}=1;
 1683:       }
 1684:   }
 1685: 
 1686: }
 1687: 
 1688: # ---------------------------------------------------------- Start page output.
 1689: 
 1690:   $r->content_type('text/html');
 1691:   $r->send_http_header;
 1692: 
 1693:   $r->print('<html><head><title>LON-CAPA Publishing</title></head>');
 1694:   $r->print(&Apache::loncommon::bodytag('Resource Publication'));
 1695: 
 1696: 
 1697:   my $thisfn=$fn;
 1698: 
 1699:   my $thistarget=$thisfn;
 1700:       
 1701:   $thistarget=~s/^\/home/$targetdir/;
 1702:   $thistarget=~s/\/public\_html//;
 1703: 
 1704:   my $thisdistarget=$thistarget;
 1705:   $thisdistarget=~s/^\Q$docroot\E//;
 1706: 
 1707:   my $thisdisfn=$thisfn;
 1708:   $thisdisfn=~s/^\/home\/\Q$cuname\E\/public_html\///;
 1709: 
 1710:   if ($fn=~/\/$/) {
 1711: # -------------------------------------------------------- This is a directory
 1712:       &publishdirectory($r,$fn,$thisdisfn);
 1713: 
 1714:   } else {
 1715: # ---------------------- Evaluate individual file, and then output information.
 1716:       $thisfn=~/\.(\w+)$/;
 1717:       my $thistype=$1;
 1718:       my $thisembstyle=&Apache::loncommon::fileembstyle($thistype);
 1719: 
 1720:       $r->print('<h2>Publishing '.
 1721:         &Apache::loncommon::filedescription($thistype).' <tt>'.
 1722:         '<a href="/~'.$cuname.'/'.$thisdisfn.'" target="cat">'.$thisdisfn.
 1723:         '</a></tt></h2><b>Target:</b> <tt>'.$thisdistarget.'</tt><br />');
 1724:    
 1725:       if (($cuname ne $ENV{'user.name'}) || ($cudom ne $ENV{'user.domain'})) {
 1726:           $r->print('<h3><font color="red">Co-Author: '.$cuname.' at '.$cudom.
 1727: 		    '</font></h3>');
 1728:       }
 1729: 
 1730:       if (&Apache::loncommon::fileembstyle($thistype) eq 'ssi') {
 1731:           $r->print('<br /><a href="/adm/diff?filename=/~'.$cuname.'/'.
 1732:                     $thisdisfn.
 1733:   	  '&versiontwo=priv" target="cat">Diffs with Current Version</a><br />');
 1734:       }
 1735:   
 1736: # ------------------ Publishing from $thisfn to $thistarget with $thisembstyle.
 1737: 
 1738:        unless ($ENV{'form.phase'} eq 'two') {
 1739: 	   my ($outstring,$error)=&publish($thisfn,$thistarget,$thisembstyle);
 1740: 	   $r->print('<hr />'.$outstring);
 1741:        } else {
 1742:            $r->print('<hr />');
 1743:            &phasetwo($r,$thisfn,$thistarget,$thisembstyle,$thisdistarget); 
 1744:        }
 1745:   }
 1746:   $r->print('</body></html>');
 1747: 
 1748:   return OK;
 1749: }
 1750: 
 1751: 1;
 1752: __END__
 1753: 
 1754: =pod
 1755: 
 1756: =back
 1757: 
 1758: =cut
 1759: 

FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>