--- loncom/publisher/lonpublisher.pm 2000/11/28 22:15:11 1.1
+++ loncom/publisher/lonpublisher.pm 2006/01/13 19:19:34 1.205
@@ -1,41 +1,2132 @@
# The LearningOnline Network with CAPA
# Publication Handler
-#
-# (TeX Content Handler
#
-# 05/29/00,05/30,10/11 Gerd Kortemeyer)
+# $Id: lonpublisher.pm,v 1.205 2006/01/13 19:19:34 albertel Exp $
#
-# 11/28 Gerd Kortemeyer
+# Copyright Michigan State University Board of Trustees
+#
+# This file is part of the LearningOnline Network with CAPA (LON-CAPA).
+#
+# LON-CAPA is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+# LON-CAPA is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with LON-CAPA; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+#
+# /home/httpd/html/adm/gpl.txt
+#
+# http://www.lon-capa.org/
+#
+###
+
+###############################################################################
+## ##
+## ORGANIZATION OF THIS PERL MODULE ##
+## ##
+## 1. Modules used by this module ##
+## 2. Various subroutines ##
+## 3. Publication Step One ##
+## 4. Phase Two ##
+## 5. Main Handler ##
+## ##
+###############################################################################
+
+
+######################################################################
+######################################################################
+
+=pod
+
+=head1 NAME
+
+lonpublisher - LON-CAPA publishing handler
+
+=head1 SYNOPSIS
+
+B is used by B inside B. This is the
+invocation by F:
+
+
+ PerlAccessHandler Apache::lonacc
+ SetHandler perl-script
+ PerlHandler Apache::lonpublisher
+ ErrorDocument 403 /adm/login
+ ErrorDocument 404 /adm/notfound.html
+ ErrorDocument 406 /adm/unauthorized.html
+ ErrorDocument 500 /adm/errorhandler
+
+
+=head1 OVERVIEW
+
+Authors can only write-access the C~authorname/> space. They can
+copy resources into the resource area through the publication step,
+and move them back through a recover step. Authors do not have direct
+write-access to their resource space.
+
+During the publication step, several events will be
+triggered. Metadata is gathered, where a wizard manages default
+entries on a hierarchical per-directory base: The wizard imports the
+metadata (including access privileges and royalty information) from
+the most recent published resource in the current directory, and if
+that is not available, from the next directory above, etc. The Network
+keeps all previous versions of a resource and makes them available by
+an explicit version number, which is inserted between the file name
+and extension, for example C, while the most recent
+version does not carry a version number (C). Servers
+subscribing to a changed resource are notified that a new version is
+available.
+
+=head1 DESCRIPTION
+
+B takes the proper steps to add resources to the LON-CAPA
+digital library. This includes updating the metadata table in the
+LON-CAPA database.
+
+B is many things to many people.
+
+This module publishes a file. This involves gathering metadata,
+versioning the file, copying file from construction space to
+publication space, and copying metadata from construction space
+to publication space.
+
+=head2 SUBROUTINES
+
+Many of the undocumented subroutines implement various magical
+parsing shortcuts.
+
+=over 4
+
+=cut
+
+######################################################################
+######################################################################
+
package Apache::lonpublisher;
+# ------------------------------------------------- modules used by this module
use strict;
use Apache::File;
-use Apache::Constants qw(:common);
+use File::Copy;
+use Apache::Constants qw(:common :http :methods);
+use HTML::LCParser;
+use Apache::lonxml;
+use Apache::loncacc;
+use DBI;
+use Apache::lonnet;
+use Apache::loncommon();
+use Apache::lonmysql;
+use Apache::lonlocal;
+use Apache::loncfile;
+use LONCAPA::lonmetadata;
+use Apache::lonmsg;
+use vars qw(%metadatafields %metadatakeys);
+
+my %addid;
+my %nokey;
+
+my $docroot;
+
+my $cuname;
+my $cudom;
+
+my $registered_cleanup;
+my $modified_urls;
+
+=pod
+
+=item B
+
+Evaluates a string that contains metadata. This subroutine
+stores values inside I<%metadatafields> and I<%metadatakeys>.
+The hash key is a I<$unikey> corresponding to a unique id
+that is descriptive of the parser location inside the XML tree.
+
+Parameters:
+
+=over 4
+
+=item I<$metastring>
+
+A string that contains metadata.
+
+=back
+
+Returns:
+
+nothing
+
+=cut
+
+#########################################
+#########################################
+#
+# Modifies global %metadatafields %metadatakeys
+#
+
+sub metaeval {
+ my ($metastring,$prefix)=@_;
+
+ my $parser=HTML::LCParser->new(\$metastring);
+ my $token;
+ while ($token=$parser->get_token) {
+ if ($token->[0] eq 'S') {
+ my $entry=$token->[1];
+ my $unikey=$entry;
+ if (defined($token->[2]->{'package'})) {
+ $unikey.='_package_'.$token->[2]->{'package'};
+ }
+ if (defined($token->[2]->{'part'})) {
+ $unikey.='_'.$token->[2]->{'part'};
+ }
+ if (defined($token->[2]->{'id'})) {
+ $unikey.='_'.$token->[2]->{'id'};
+ }
+ if (defined($token->[2]->{'name'})) {
+ $unikey.='_'.$token->[2]->{'name'};
+ }
+ foreach (@{$token->[3]}) {
+ $metadatafields{$unikey.'.'.$_}=$token->[2]->{$_};
+ if ($metadatakeys{$unikey}) {
+ $metadatakeys{$unikey}.=','.$_;
+ } else {
+ $metadatakeys{$unikey}=$_;
+ }
+ }
+ my $newentry=$parser->get_text('/'.$entry);
+ if (($entry eq 'customdistributionfile') ||
+ ($entry eq 'sourcerights')) {
+ $newentry=~s/^\s*//;
+ if ($newentry !~m|^/res|) { $newentry=$prefix.$newentry; }
+ }
+# actually store
+ if ( $entry eq 'rule' && exists($metadatafields{$unikey})) {
+ $metadatafields{$unikey}.=','.$newentry;
+ } else {
+ $metadatafields{$unikey}=$newentry;
+ }
+ }
+ }
+}
+
+#########################################
+#########################################
+
+=pod
+
+=item B
+
+Read a metadata file
+
+Parameters:
+
+=over
+
+=item I<$logfile>
+
+File output stream to output errors and warnings to.
+
+=item I<$fn>
+
+File name (including path).
+
+=back
+
+Returns:
+
+=over 4
+
+=item Scalar string (if successful)
+
+XHTML text that indicates successful reading of the metadata.
+
+=back
+
+=cut
+
+#########################################
+#########################################
+sub metaread {
+ my ($logfile,$fn,$prefix)=@_;
+ unless (-e $fn) {
+ print($logfile 'No file '.$fn."\n");
+ return ' '.&mt('No file').':'.
+ &Apache::loncfile::display($fn).'';
+ }
+ print($logfile 'Processing '.$fn."\n");
+ my $metastring;
+ {
+ my $metafh=Apache::File->new($fn);
+ $metastring=join('',<$metafh>);
+ }
+ &metaeval($metastring,$prefix);
+ return ' '.&mt('Processed file').':'.
+ &Apache::loncfile::display($fn).'';
+}
+
+#########################################
+#########################################
+
+sub coursedependencies {
+ my $url=&Apache::lonnet::declutter(shift);
+ $url=~s/\.meta$//;
+ my ($adomain,$aauthor)=($url=~/^(\w+)\/(\w+)\//);
+ my $regexp=$url;
+ $regexp=~s/(\W)/\\$1/g;
+ $regexp='___'.$regexp.'___course';
+ my %evaldata=&Apache::lonnet::dump('nohist_resevaldata',$adomain,
+ $aauthor,$regexp);
+ my %courses=();
+ foreach (keys %evaldata) {
+ if ($_=~/^([a-zA-Z0-9]+_[a-zA-Z0-9]+)___.+___course$/) {
+ $courses{$1}=1;
+ }
+ }
+ return %courses;
+}
+#########################################
+#########################################
+
+
+=pod
+
+=item Form-field-generating subroutines.
+
+For input parameters, these subroutines take in values
+such as I<$name>, I<$value> and other form field metadata.
+The output (scalar string that is returned) is an XHTML
+string which presents the form field (foreseeably inside
+ tags).
+
+=over 4
+
+=item B
+
+=item B
+
+=item B
+
+=back
+
+=cut
+
+#########################################
+#########################################
+sub textfield {
+ my ($title,$name,$value)=@_;
+ $value=~s/^\s+//gs;
+ $value=~s/\s+$//gs;
+ $value=~s/\s+/ /gs;
+ $title=&mt($title);
+ $env{'form.'.$name}=$value;
+ return "\n
');
+ print $logfile "\nRemoving error messages: $delresult";
+# ----------------------------------------------------------- Copy old versions
+
+ if (-e $target) {
+ my $filename;
+ my $maxversion=0;
+ $target=~/(.*)\/([^\/]+)\.(\w+)$/;
+ my $srcf=$2;
+ my $srct=$3;
+ my $srcd=$1;
+ unless ($srcd=~/^\/home\/httpd\/html\/res/) {
+ print $logfile "\nPANIC: Target dir is ".$srcd;
+ $r->print(
+ "Invalid target directory, FAIL");
+ return 0;
+ }
+ opendir(DIR,$srcd);
+ while ($filename=readdir(DIR)) {
+ if (-l $srcd.'/'.$filename) {
+ unlink($srcd.'/'.$filename);
+ unlink($srcd.'/'.$filename.'.meta');
+ } else {
+ if ($filename=~/\Q$srcf\E\.(\d+)\.\Q$srct\E$/) {
+ $maxversion=($1>$maxversion)?$1:$maxversion;
+ }
+ }
+ }
+ closedir(DIR);
+ $maxversion++;
+ $r->print('
Creating old version '.$maxversion.'
');
+ print $logfile "\nCreating old version ".$maxversion."\n";
+
+ my $copyfile=$srcd.'/'.$srcf.'.'.$maxversion.'.'.$srct;
+
+ if (copy($target,$copyfile)) {
+ print $logfile "Copied old target to ".$copyfile."\n";
+ $r->print('
'.&mt('Copied old target file').'
');
+ } else {
+ print $logfile "Unable to write ".$copyfile.':'.$!."\n";
+ $r->print("".&mt('Failed to copy old target').
+ ", $!, ".&mt('FAIL')."");
+ return 0;
+ }
+
+# --------------------------------------------------------------- Copy Metadata
+
+ $copyfile=$copyfile.'.meta';
+
+ if (copy($target.'.meta',$copyfile)) {
+ print $logfile "Copied old target metadata to ".$copyfile."\n";
+ $r->print('
');
+ return 1;
+}
+
+# =============================================================== Notifications
+sub notify {
+# --------------------------------------------------- Send update notifications
+ foreach my $targetsource (@{$modified_urls}){
+ my ($target,$source)=@{$targetsource};
+ my $logfile=Apache::File->new('>>'.$source.'.log');
+ print $logfile "\nCleanup phase: Notifications\n";
+ my @subscribed=&get_subscribed_hosts($target);
+ foreach my $subhost (@subscribed) {
+ print $logfile "\nNotifying host ".$subhost.':';
+ my $reply=&Apache::lonnet::critical('update:'.$target,$subhost);
+ print $logfile $reply;
+ }
+# ---------------------------------------- Send update notifications, meta only
+ my @subscribedmeta=&get_subscribed_hosts("$target.meta");
+ foreach my $subhost (@subscribedmeta) {
+ print $logfile "\nNotifying host for metadata only ".$subhost.':';
+ my $reply=&Apache::lonnet::critical('update:'.$target.'.meta',
+ $subhost);
+ print $logfile $reply;
+ }
+# --------------------------------------------------- Notify subscribed courses
+ my %courses=&coursedependencies($target);
+ my $now=time;
+ foreach (keys %courses) {
+ print $logfile "\nNotifying course ".$_.':';
+ my ($cdom,$cname)=split(/\_/,$_);
+ my $reply=&Apache::lonnet::cput
+ ('versionupdate',{$target => $now},$cdom,$cname);
+ print $logfile $reply;
+ }
+ print $logfile "\n============ Done ============\n";
+ $logfile->close();
+ }
+ return OK;
+}
+
+#########################################
+
+sub batchpublish {
+ my ($r,$srcfile,$targetfile)=@_;
+ #publication pollutes %env with form.* values
+ my %oldenv=%env;
+ $srcfile=~s/\/+/\//g;
+ $targetfile=~s/\/+/\//g;
+ my $thisdisfn=$srcfile;
+ $thisdisfn=~s/\/home\/korte\/public_html\///;
+ $srcfile=~s/\/+/\//g;
+
+ my $docroot=$r->dir_config('lonDocRoot');
+ my $thisdistarget=$targetfile;
+ $thisdistarget=~s/^\Q$docroot\E//;
+
+
+ %metadatafields=();
+ %metadatakeys=();
+ $srcfile=~/\.(\w+)$/;
+ my $thistype=$1;
+
+
+ my $thisembstyle=&Apache::loncommon::fileembstyle($thistype);
+
+ $r->print('
'.&mt('Publishing').' '.$thisdisfn.'
');
+
+# phase one takes
+# my ($source,$target,$style,$batch)=@_;
+ my ($outstring,$error)=&publish($srcfile,$targetfile,$thisembstyle,1);
+ $r->print('
'.$outstring.'
');
+# phase two takes
+# my ($source,$target,$style,$distarget,batch)=@_;
+# $env{'form.allmeta'},$env{'form.title'},$env{'form.author'},...
+ if (!$error) {
+ $r->print('
'.&mt('Notifying host').' '.$subhost.':');$r->rflush;
+ my $reply=&Apache::lonnet::critical('update:'.$target,$subhost);
+ $r->print($reply.'
');$r->rflush;
+ }
+# ------------------------------------------------------------------- Link back
+ my $link=$fn;
+ $link=~s/^\/home\/$cuname\/public_html\//\/priv\/$cuname\//;
+ $r->print("".&mt('Back to Catalog Information').'');
+ $r->print('