# The LearningOnline Network with CAPA
# Publication Handler
#
# $Id: lonpublisher.pm,v 1.232 2008/03/18 23:31:31 raeburn Exp $
#
# 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 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);
use LONCAPA qw(:DEFAULT :match);
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;
next if ($entry =~ m/^(?:parameter|stores)_/);
if (defined($token->[2]->{'package'})) {
$unikey.="\0package\0".$token->[2]->{'package'};
}
if (defined($token->[2]->{'part'})) {
$unikey.="\0".$token->[2]->{'part'};
}
if (defined($token->[2]->{'id'})) {
$unikey.="\0".$token->[2]->{'id'};
}
if (defined($token->[2]->{'name'})) {
$unikey.="\0".$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=~ m{^($match_domain)/($match_username)/});
my $regexp=quotemeta($url);
$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
'.
&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.').'
';
}
# ------------------------------------------------------- Now have all metadata
my %keywords=();
if (length($content)<500000) {
my $textonly=$content;
$textonly=~s/\
$KEYWORDS:
$keywords_help
END
$keywordout.='
';
my $colcount=0;
foreach (sort keys %keywords) {
$keywordout.='
');
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('
'.&mt('Copied old metadata').'
')
} else {
print $logfile "Unable to write metadata ".$copyfile.':'.$!."\n";
if (-e $target.'.meta') {
$r->print(
"".
&mt('Failed to write old metadata copy').", $!, ".&mt('FAIL')."");
return 0;
}
}
} else {
$r->print('
'.&mt('Initial version').'
');
print $logfile "\nInitial version";
}
# ---------------------------------------------------------------- Write Source
my $copyfile=$target;
my @parts=split(/\//,$copyfile);
my $path="/$parts[1]/$parts[2]/$parts[3]/$parts[4]";
my $count;
for ($count=5;$count<$#parts;$count++) {
$path.="/$parts[$count]";
if ((-e $path)!=1) {
print $logfile "\nCreating directory ".$path;
$r->print('
'.&mt('Created directory').' '.$parts[$count].'
');
mkdir($path,0777);
}
}
if (copy($source,$copyfile)) {
print $logfile "\nCopied original source to ".$copyfile."\n";
$r->print('
'.&mt('Copied source file').'
');
} else {
print $logfile "\nUnable to write ".$copyfile.':'.$!."\n";
$r->print("".
&mt('Failed to copy source').", $!, ".&mt('FAIL')."");
return 0;
}
# --------------------------------------------------------------- Copy Metadata
$copyfile=$copyfile.'.meta';
if (copy($source.'.meta',$copyfile)) {
print $logfile "\nCopied original metadata to ".$copyfile."\n";
$r->print('
'.&mt('Copied metadata').'
');
} else {
print $logfile "\nUnable to write metadata ".$copyfile.':'.$!."\n";
$r->print(
"".&mt('Failed to write metadata copy').", $!, ".&mt('FAIL')."");
return 0;
}
$r->rflush;
# ------------------------------------------------------------- Trigger updates
push(@{$modified_urls},[$target,$source]);
unless ($registered_cleanup) {
$r->register_cleanup(\¬ify);
$registered_cleanup=1;
}
# ---------------------------------------------------------- Clear local caches
my $thisdistarget=$target;
$thisdistarget=~s/^\Q$docroot\E//;
&Apache::lonnet::devalidate_cache_new('resversion',$target);
&Apache::lonnet::devalidate_cache_new('meta',
&Apache::lonnet::declutter($thisdistarget));
# ------------------------------------------------ Provide link to new resource
unless ($batch) {
my $thissrc=$source;
$thissrc=~s{^/home/($match_username)/public_html}{/priv/$1};
my $thissrcdir=$thissrc;
$thissrcdir=~s/\/[^\/]+$/\//;
$r->print(
''.
&mt('View Published Version').''.
'
');
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('
');
}
%env=%oldenv;
return '';
}
#########################################
sub publishdirectory {
my ($r,$fn,$thisdisfn)=@_;
$fn=~s/\/+/\//g;
$thisdisfn=~s/\/+/\//g;
my $resdir=
$Apache::lonnet::perlvar{'lonDocRoot'}.'/res/'.$cudom.'/'.$cuname.'/'.
$thisdisfn;
$r->print('
'.&mt('Directory').' '.$thisdisfn.'
'.
&mt('Target').': '.$resdir.' ');
my $dirptr=16384; # Mask indicating a directory in stat.cmode.
unless ($env{'form.phase'} eq 'two') {
# ask user what they want
$r->print('');
} else {
# actually publish things
opendir(DIR,$fn);
my @files=sort(readdir(DIR));
foreach my $filename (@files) {
my ($cdev,$cino,$cmode,$cnlink,
$cuid,$cgid,$crdev,$csize,
$catime,$cmtime,$cctime,
$cblksize,$cblocks)=stat($fn.'/'.$filename);
my $extension='';
if ($filename=~/\.(\w+)$/) { $extension=$1; }
if ($cmode&$dirptr) {
if (($filename!~/^\./) && ($env{'form.pubrec'})) {
&publishdirectory($r,$fn.'/'.$filename,$thisdisfn.'/'.$filename);
}
} elsif ((&Apache::loncommon::fileembstyle($extension) ne 'hdn') &&
($filename!~/^[\#\.]/) && ($filename!~/\~$/)) {
# find out publication status and/or exiting metadata
my $publishthis=0;
if (-e $resdir.'/'.$filename) {
my ($rdev,$rino,$rmode,$rnlink,
$ruid,$rgid,$rrdev,$rsize,
$ratime,$rmtime,$rctime,
$rblksize,$rblocks)=stat($resdir.'/'.$filename);
if (($rmtime<$cmtime) || ($env{'form.forcerepub'})) {
# previously published, modified now
$publishthis=1;
}
my $meta_cmtime = (stat($fn.'/'.$filename.'.meta'))[9];
my $meta_rmtime = (stat($resdir.'/'.$filename.'.meta'))[9];
if ( $meta_rmtime<$meta_cmtime ) {
$publishthis=1;
}
} else {
# never published
$publishthis=1;
}
if ($publishthis) {
&batchpublish($r,$fn.'/'.$filename,$resdir.'/'.$filename);
} else {
$r->print(' '.&mt('Skipping').' '.$filename.' ');
}
$r->rflush();
}
}
closedir(DIR);
}
}
#########################################
# publish a default.meta file
sub defaultmetapublish {
my ($r,$fn,$cuname,$cudom)=@_;
$fn=~s/^\/\~$cuname\//\/home\/$cuname\/public_html\//;
unless (-e $fn) {
return HTTP_NOT_FOUND;
}
my $target=$fn;
$target=~s/^\/home\/$cuname\/public_html\//$Apache::lonnet::perlvar{'lonDocRoot'}\/res\/$cudom\/$cuname\//;
&Apache::loncommon::content_type($r,'text/html');
$r->send_http_header;
$r->print(&Apache::loncommon::start_page('Catalog Information Publication'));
# ---------------------------------------------------------------- Write Source
my $copyfile=$target;
my @parts=split(/\//,$copyfile);
my $path="/$parts[1]/$parts[2]/$parts[3]/$parts[4]";
my $count;
for ($count=5;$count<$#parts;$count++) {
$path.="/$parts[$count]";
if ((-e $path)!=1) {
$r->print('
'.&mt('Created directory').' '.$parts[$count].'
');
mkdir($path,0777);
}
}
if (copy($fn,$copyfile)) {
$r->print('
'.&mt('Copied source file').'
');
} else {
return "".
&mt('Failed to copy source').", $!, ".&mt('FAIL')."";
}
# --------------------------------------------------- Send update notifications
my @subscribed=&get_subscribed_hosts($target);
foreach my $subhost (@subscribed) {
$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(&Apache::loncommon::end_page());
return OK;
}
#########################################
=pod
=item B
A basic outline of the handler subroutine follows.
=over 4
=item *
Get query string for limited number of parameters.
=item *
Check filename.
=item *
File is there and owned, init lookup tables.
=item *
Start page output.
=item *
Evaluate individual file, and then output information.
=item *
Publishing from $thisfn to $thistarget with $thisembstyle.
=back
=cut
#########################################
#########################################
sub handler {
my $r=shift;
if ($r->header_only) {
&Apache::loncommon::content_type($r,'text/html');
$r->send_http_header;
return OK;
}
# Get query string for limited number of parameters
&Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},
['filename']);
# -------------------------------------- Flag and buffer for registered cleanup
$registered_cleanup=0;
@{$modified_urls}=();
# -------------------------------------------------------------- Check filename
my $fn=&unescape($env{'form.filename'});
($cuname,$cudom)=
&Apache::loncacc::constructaccess($fn,$r->dir_config('lonDefDomain'));
# special publication: default.meta file
if ($fn=~/\/default.meta$/) {
return &defaultmetapublish($r,$fn,$cuname,$cudom);
}
$fn=~s/\.meta$//;
unless ($fn) {
$r->log_reason($cuname.' at '.$cudom.
' trying to publish empty filename', $r->filename);
return HTTP_NOT_FOUND;
}
unless (($cuname) && ($cudom)) {
$r->log_reason($cuname.' at '.$cudom.
' trying to publish file '.$env{'form.filename'}.
' ('.$fn.') - not authorized',
$r->filename);
return HTTP_NOT_ACCEPTABLE;
}
my $home=&Apache::lonnet::homeserver($cuname,$cudom);
my $allowed=0;
my @ids=&Apache::lonnet::current_machine_ids();
foreach my $id (@ids) { if ($id eq $home) { $allowed = 1; } }
unless ($allowed) {
$r->log_reason($cuname.' at '.$cudom.
' trying to publish file '.$env{'form.filename'}.
' ('.$fn.') - not homeserver ('.$home.')',
$r->filename);
return HTTP_NOT_ACCEPTABLE;
}
$fn=~s{^http://[^/]+}{};
$fn=~s{^/~($match_username)}{/home/$1/public_html};
my $targetdir='';
$docroot=$r->dir_config('lonDocRoot');
if ($1 ne $cuname) {
$r->log_reason($cuname.' at '.$cudom.
' trying to publish unowned file '.
$env{'form.filename'}.' ('.$fn.')',
$r->filename);
return HTTP_NOT_ACCEPTABLE;
} else {
$targetdir=$docroot.'/res/'.$cudom;
}
unless (-e $fn) {
$r->log_reason($cuname.' at '.$cudom.
' trying to publish non-existing file '.
$env{'form.filename'}.' ('.$fn.')',
$r->filename);
return HTTP_NOT_FOUND;
}
# -------------------------------- File is there and owned, init lookup tables.
%addid=();
{
my $fh=Apache::File->new($r->dir_config('lonTabDir').'/addid.tab');
while (<$fh>=~/(\w+)\s+(\w+)/) {
$addid{$1}=$2;
}
}
%nokey=();
{
my $fh=Apache::File->new($r->dir_config('lonIncludes').'/un_keyword.tab');
while (<$fh>) {
my $word=$_;
chomp($word);
$nokey{$word}=1;
}
}
# ---------------------------------------------------------- Start page output.
&Apache::loncommon::content_type($r,'text/html');
$r->send_http_header;
my $js='';
$r->print(&Apache::loncommon::start_page('Resource Publication',$js));
my $thisfn=$fn;
my $thistarget=$thisfn;
$thistarget=~s/^\/home/$targetdir/;
$thistarget=~s/\/public\_html//;
my $thisdistarget=$thistarget;
$thisdistarget=~s/^\Q$docroot\E//;
my $thisdisfn=$thisfn;
$thisdisfn=~s/^\/home\/\Q$cuname\E\/public_html\///;
if ($fn=~/\/$/) {
# -------------------------------------------------------- This is a directory
&publishdirectory($r,$fn,$thisdisfn);
$r->print(''.&mt('Return to Directory').'');
} else {
# ---------------------- Evaluate individual file, and then output information.
$thisfn=~/\.(\w+)$/;
my $thistype=$1;
my $thisembstyle=&Apache::loncommon::fileembstyle($thistype);
if ($thistype eq 'page') { $thisembstyle = 'rat'; }
$r->print('