--- loncom/publisher/lonpublisher.pm 2000/11/29 19:52:34 1.3
+++ loncom/publisher/lonpublisher.pm 2007/01/26 22:16:33 1.218
@@ -1,151 +1,2135 @@
# The LearningOnline Network with CAPA
# Publication Handler
-#
-# (TeX Content Handler
#
-# 05/29/00,05/30,10/11 Gerd Kortemeyer)
+# $Id: lonpublisher.pm,v 1.218 2007/01/26 22:16:33 raeburn Exp $
#
-# 11/28,11/29 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 File::Copy;
use Apache::Constants qw(:common :http :methods);
-use HTML::TokeParser;
+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;
+ 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=~ 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$title:".
+ "
".
+ ' ';
+}
+
+sub text_with_browse_field {
+ my ($title,$name,$value,$restriction)=@_;
+ $value=~s/^\s+//gs;
+ $value=~s/\s+$//gs;
+ $value=~s/\s+/ /gs;
+ $title=&mt($title);
+ $env{'form.'.$name}=$value;
+ return "\n$title:".
+ "
".
+ ' '.
+ 'Select '.
+ 'Search ';
+
+}
+
+sub hiddenfield {
+ my ($name,$value)=@_;
+ $env{'form.'.$name}=$value;
+ return "\n".' ';
+}
+
+sub checkbox {
+ my ($name,$text)=@_;
+ return "\n ".
+ &mt($text)." ";
+}
+
+sub selectbox {
+ my ($title,$name,$value,$functionref,@idlist)=@_;
+ $title=&mt($title);
+ $value=(split(/\s*,\s*/,$value))[-1];
+ if (defined($value)) {
+ $env{'form.'.$name}=$value;
+ } else {
+ $env{'form.'.$name}=$idlist[0];
+ }
+ my $selout="\n$title:".
+ '
';
+ foreach (@idlist) {
+ $selout.=''.&{$functionref}($_).' ';
+ }
+ else {$selout.='>'.&{$functionref}($_).'';}
+ }
+ return $selout.' ';
+}
+
+sub select_level_form {
+ my ($value,$name)=@_;
+ $env{'form.'.$name}=$value;
+ if (!defined($value)) { $env{'form.'.$name}=0; }
+ return &Apache::loncommon::select_level_form($value,$name);
+}
+#########################################
+#########################################
+
+=pod
+
+=item B
+
+Fix up a url? First step of publication
+
+=cut
+
+#########################################
+#########################################
+sub urlfixup {
+ my ($url,$target)=@_;
+ unless ($url) { return ''; }
+ #javascript code needs no fixing
+ if ($url =~ /^javascript:/i) { return $url; }
+ if ($url =~ /^mailto:/i) { return $url; }
+ #internal document links need no fixing
+ if ($url =~ /^\#/) { return $url; }
+ my ($host)=($url=~/(?:http\:\/\/)*([^\/]+)/);
+ foreach (values %Apache::lonnet::hostname) {
+ if ($_ eq $host) {
+ $url=~s/^http\:\/\///;
+ $url=~s/^$host//;
+ }
+ }
+ if ($url=~/^http\:\/\//) { return $url; }
+ $url=~s/\~$cuname/res\/$cudom\/$cuname/;
+ return $url;
+}
+
+#########################################
+#########################################
+
+=pod
+
+=item B
+
+Currently undocumented.
+
+=cut
+
+#########################################
+#########################################
+sub absoluteurl {
+ my ($url,$target)=@_;
+ unless ($url) { return ''; }
+ if ($target) {
+ $target=~s/\/[^\/]+$//;
+ $url=&Apache::lonnet::hreflocation($target,$url);
+ }
+ return $url;
+}
+
+#########################################
+#########################################
+
+=pod
+
+=item B
+
+Currently undocumented
+
+=cut
+
+#########################################
+#########################################
+sub set_allow {
+ my ($allow,$logfile,$target,$tag,$oldurl)=@_;
+ my $newurl=&urlfixup($oldurl,$target);
+ my $return_url=$oldurl;
+ print $logfile 'GUYURL: '.$tag.':'.$oldurl.' - '.$newurl."\n";
+ if ($newurl ne $oldurl) {
+ $return_url=$newurl;
+ print $logfile 'URL: '.$tag.':'.$oldurl.' - '.$newurl."\n";
+ }
+ if (($newurl !~ /^javascript:/i) &&
+ ($newurl !~ /^mailto:/i) &&
+ ($newurl !~ /^http:/i) &&
+ ($newurl !~ /^\#/)) {
+ $$allow{&absoluteurl($newurl,$target)}=1;
+ }
+ return $return_url;
+}
+
+#########################################
+#########################################
+
+=pod
+
+=item B
+
+Currently undocumented
+
+=cut
+
+#########################################
+#########################################
+sub get_subscribed_hosts {
+ my ($target)=@_;
+ my @subscribed;
+ my $filename;
+ $target=~/(.*)\/([^\/]+)$/;
+ my $srcf=$2;
+ opendir(DIR,$1);
+ while ($filename=readdir(DIR)) {
+ if ($filename=~/\Q$srcf\E\.($match_lonid)$/) {
+ my $subhost=$1;
+ if (($subhost ne 'meta' && $subhost ne 'subscription' &&
+ $subhost ne 'tmp') &&
+ ($subhost ne $Apache::lonnet::perlvar{'lonHostID'})) {
+ push(@subscribed,$subhost);
+ }
+ }
+ }
+ closedir(DIR);
+ my $sh;
+ if ( $sh=Apache::File->new("$target.subscription") ) {
+ while (my $subline=<$sh>) {
+ if ($subline =~ /^($match_lonid):/) {
+ if ($1 ne $Apache::lonnet::perlvar{'lonHostID'}) {
+ push(@subscribed,$1);
+ }
+ }
+ }
+ }
+ return @subscribed;
+}
+
+
+#########################################
+#########################################
+
+=pod
+
+=item B
+
+Currently undocumented
+
+=cut
+
+#########################################
+#########################################
+sub get_max_ids_indices {
+ my ($content)=@_;
+ my $maxindex=10;
+ my $maxid=10;
+ my $needsfixup=0;
+ my $duplicateids=0;
+
+ my %allids;
+ my %duplicatedids;
+
+ my $parser=HTML::LCParser->new($content);
+ $parser->xml_mode(1);
+ my $token;
+ while ($token=$parser->get_token) {
+ if ($token->[0] eq 'S') {
+ my $counter;
+ if ($counter=$addid{$token->[1]}) {
+ if ($counter eq 'id') {
+ if (defined($token->[2]->{'id'}) &&
+ $token->[2]->{'id'} !~ /^\s*$/) {
+ $maxid=($token->[2]->{'id'}>$maxid)?$token->[2]->{'id'}:$maxid;
+ if (exists($allids{$token->[2]->{'id'}})) {
+ $duplicateids=1;
+ $duplicatedids{$token->[2]->{'id'}}=1;
+ } else {
+ $allids{$token->[2]->{'id'}}=1;
+ }
+ } else {
+ $needsfixup=1;
+ }
+ } else {
+ if (defined($token->[2]->{'index'}) &&
+ $token->[2]->{'index'} !~ /^\s*$/) {
+ $maxindex=($token->[2]->{'index'}>$maxindex)?$token->[2]->{'index'}:$maxindex;
+ } else {
+ $needsfixup=1;
+ }
+ }
+ }
+ }
+ }
+ return ($needsfixup,$maxid,$maxindex,$duplicateids,
+ (keys(%duplicatedids)));
+}
+
+#########################################
+#########################################
+
+=pod
+
+=item B
+
+Currently undocumented
+
+=cut
+
+#########################################
+#########################################
+sub get_all_text_unbalanced {
+ #there is a copy of this in lonxml.pm
+ my($tag,$pars)= @_;
+ my $token;
+ my $result='';
+ $tag='<'.$tag.'>';
+ while ($token = $$pars[-1]->get_token) {
+ if (($token->[0] eq 'T')||($token->[0] eq 'C')||($token->[0] eq 'D')) {
+ $result.=$token->[1];
+ } elsif ($token->[0] eq 'PI') {
+ $result.=$token->[2];
+ } elsif ($token->[0] eq 'S') {
+ $result.=$token->[4];
+ } elsif ($token->[0] eq 'E') {
+ $result.=$token->[2];
+ }
+ if ($result =~ /\Q$tag\E/s) {
+ ($result,my $redo)=$result =~ /(.*)\Q$tag\E(.*)/is;
+ #&Apache::lonnet::logthis('Got a winner with leftovers ::'.$2);
+ #&Apache::lonnet::logthis('Result is :'.$1);
+ $redo=$tag.$redo;
+ push (@$pars,HTML::LCParser->new(\$redo));
+ $$pars[-1]->xml_mode('1');
+ last;
+ }
+ }
+ return $result
+}
+
+#########################################
+#########################################
+
+=pod
+
+=item B
+
+Currently undocumented
+
+=cut
+
+#########################################
+#########################################
+#Arguably this should all be done as a lonnet::ssi instead
+sub fix_ids_and_indices {
+ my ($logfile,$source,$target)=@_;
+
+ my %allow;
+ my $content;
+ {
+ my $org=Apache::File->new($source);
+ $content=join('',<$org>);
+ }
+
+ my ($needsfixup,$maxid,$maxindex,$duplicateids,@duplicatedids)=
+ &get_max_ids_indices(\$content);
+
+ print $logfile ("Got $needsfixup,$maxid,$maxindex,$duplicateids--".
+ join(', ',@duplicatedids));
+ if ($duplicateids) {
+ print $logfile "Duplicate ID(s) exist, ".join(', ',@duplicatedids)."\n";
+ my $outstring=''.&mt('Unable to publish file, it contains duplicated ID(s), ID(s) need to be unique. The duplicated ID(s) are').': '.join(', ',@duplicatedids).' ';
+ return ($outstring,1);
+ }
+ if ($needsfixup) {
+ print $logfile "Needs ID and/or index fixup\n".
+ "Max ID : $maxid (min 10)\n".
+ "Max Index: $maxindex (min 10)\n";
+ }
+ my $outstring='';
+ my @parser;
+ $parser[0]=HTML::LCParser->new(\$content);
+ $parser[-1]->xml_mode(1);
+ my $token;
+ while (@parser) {
+ while ($token=$parser[-1]->get_token) {
+ if ($token->[0] eq 'S') {
+ my $counter;
+ my $tag=$token->[1];
+ my $lctag=lc($tag);
+ if ($lctag eq 'allow') {
+ $allow{$token->[2]->{'src'}}=1;
+ next;
+ }
+ if ($lctag eq 'base') { next; }
+ my %parms=%{$token->[2]};
+ $counter=$addid{$tag};
+ if (!$counter) { $counter=$addid{$lctag}; }
+ if ($counter) {
+ if ($counter eq 'id') {
+ unless (defined($parms{'id'}) &&
+ $parms{'id'}!~/^\s*$/) {
+ $maxid++;
+ $parms{'id'}=$maxid;
+ print $logfile 'ID(new) : '.$tag.':'.$maxid."\n";
+ } else {
+ print $logfile 'ID(kept): '.$tag.':'.$parms{'id'}."\n";
+ }
+ } elsif ($counter eq 'index') {
+ unless (defined($parms{'index'}) &&
+ $parms{'index'}!~/^\s*$/) {
+ $maxindex++;
+ $parms{'index'}=$maxindex;
+ print $logfile 'Index: '.$tag.':'.$maxindex."\n";
+ }
+ }
+ }
+ unless ($parms{'type'} eq 'zombie') {
+ foreach my $type ('src','href','background','bgimg') {
+ foreach my $key (keys(%parms)) {
+ if ($key =~ /^$type$/i) {
+ $parms{$key}=&set_allow(\%allow,$logfile,
+ $target,$tag,
+ $parms{$key});
+ }
+ }
+ }
+ }
+ # probably a image type
+ # or a tag inside
+ if (($lctag eq 'label' && defined($parms{'description'}))
+ ||
+ ($lctag eq 'image')) {
+ my $next_token=$parser[-1]->get_token();
+ if ($next_token->[0] eq 'T') {
+ $next_token->[1] =~ s/[\n\r\f]+//g;
+ $next_token->[1]=&set_allow(\%allow,$logfile,
+ $target,$tag,
+ $next_token->[1]);
+ }
+ $parser[-1]->unget_token($next_token);
+ }
+ if ($lctag eq 'applet') {
+ my $codebase='';
+ my $havecodebase=0;
+ foreach my $key (keys(%parms)) {
+ if (lc($key) eq 'codebase') {
+ $codebase=$parms{$key};
+ $havecodebase=1;
+ }
+ }
+ if ($havecodebase) {
+ my $oldcodebase=$codebase;
+ unless ($oldcodebase=~/\/$/) {
+ $oldcodebase.='/';
+ }
+ $codebase=&urlfixup($oldcodebase,$target);
+ $codebase=~s/\/$//;
+ if ($codebase ne $oldcodebase) {
+ $parms{'codebase'}=$codebase;
+ print $logfile 'URL codebase: '.$tag.':'.
+ $oldcodebase.' - '.
+ $codebase."\n";
+ }
+ $allow{&absoluteurl($codebase,$target).'/*'}=1;
+ } else {
+ foreach my $key (keys(%parms)) {
+ if ($key =~ /(archive|code|object)/i) {
+ my $oldurl=$parms{$key};
+ my $newurl=&urlfixup($oldurl,$target);
+ $newurl=~s/\/[^\/]+$/\/\*/;
+ print $logfile 'Allow: applet '.lc($key).':'.
+ $oldurl.' allows '.$newurl."\n";
+ $allow{&absoluteurl($newurl,$target)}=1;
+ }
+ }
+ }
+ }
+ my $newparmstring='';
+ my $endtag='';
+ foreach (keys %parms) {
+ if ($_ eq '/') {
+ $endtag=' /';
+ } else {
+ my $quote=($parms{$_}=~/\"/?"'":'"');
+ $newparmstring.=' '.$_.'='.$quote.$parms{$_}.$quote;
+ }
+ }
+ if (!$endtag) { if ($token->[4]=~m:/>$:) { $endtag=' /'; }; }
+ $outstring.='<'.$tag.$newparmstring.$endtag.'>';
+ if ($lctag eq 'm' || $lctag eq 'script'
+ || $lctag eq 'display' || $lctag eq 'tex') {
+ $outstring.=&get_all_text_unbalanced('/'.$lctag,\@parser);
+ }
+ } elsif ($token->[0] eq 'E') {
+ if ($token->[2]) {
+ unless ($token->[1] eq 'allow') {
+ $outstring.=''.$token->[1].'>';
+ }
+ }
+ } else {
+ $outstring.=$token->[1];
+ }
+ }
+ pop(@parser);
+ }
+
+ if ($needsfixup) {
+ print $logfile "End of ID and/or index fixup\n".
+ "Max ID : $maxid (min 10)\n".
+ "Max Index: $maxindex (min 10)\n";
+ } else {
+ print $logfile "Does not need ID and/or index fixup\n";
+ }
+
+ return ($outstring,0,%allow);
+}
+
+#########################################
+#########################################
+
+=pod
+
+=item B
+
+Store the metadata in the metadata table in the loncapa database.
+Uses lonmysql to access the database.
+
+Inputs: \%metadata
+
+Returns: (error,status). error is undef on success, status is undef on error.
+
+=cut
+
+#########################################
+#########################################
+sub store_metadata {
+ my %metadata = @_;
+ my $error;
+ # Determine if the table exists
+ my $status = &Apache::lonmysql::check_table('metadata');
+ if (! defined($status)) {
+ $error='WARNING: Cannot connect to '.
+ 'database! ';
+ &Apache::lonnet::logthis($error);
+ return ($error,undef);
+ }
+ if ($status == 0) {
+ # It would be nice to actually create the table....
+ $error ='WARNING: The metadata table does not '.
+ 'exist in the LON-CAPA database. ';
+ &Apache::lonnet::logthis($error);
+ return ($error,undef);
+ }
+ my $dbh = &Apache::lonmysql::get_dbh();
+ if (($metadata{'obsolete'}) || ($metadata{'copyright'} eq 'priv') ||
+ ($metadata{'copyright'} eq 'custom')) {
+ # remove this entry
+ $status=&LONCAPA::lonmetadata::delete_metadata($dbh,undef,
+ $metadata{'url'});
+ } else {
+ $status = &LONCAPA::lonmetadata::update_metadata($dbh,undef,undef,
+ \%metadata);
+ }
+ if (defined($status) && $status ne '') {
+ $error='Error occured storing new values in '.
+ 'metadata table in LON-CAPA database ';
+ &Apache::lonnet::logthis($error);
+ &Apache::lonnet::logthis($status);
+ return ($error,undef);
+ }
+ return (undef,'success');
+}
+
+
+# ========================================== Parse file for errors and warnings
+
+sub checkonthis {
+ my ($r,$source)=@_;
+ my $uri=&Apache::lonnet::hreflocation($source);
+ $uri=~s/\/$//;
+ my $result=&Apache::lonnet::ssi_body($uri,
+ ('grade_target'=>'web',
+ 'return_only_error_and_warning_counts' => 1));
+ my ($errorcount,$warningcount)=split(':',$result);
+ if (($errorcount) || ($warningcount)) {
+ $r->print(''.$uri.' : ');
+ if ($errorcount) {
+ $r->print(''.
+ $errorcount.' '.
+ &mt('error(s)').' ');
+ }
+ if ($warningcount) {
+ $r->print(''.
+ $warningcount.' '.
+ &mt('warning(s)').' ');
+ }
+ } else {
+ #$r->print(''.&mt('ok').' ');
+ }
+ $r->rflush();
+ return ($warningcount,$errorcount);
+}
+
+# ============================================== Parse file itself for metadata
+#
+# parses a file with target meta, sets global %metadatafields %metadatakeys
+
+sub parseformeta {
+ my ($source,$style)=@_;
+ my $allmeta='';
+ if (($style eq 'ssi') || ($style eq 'prv')) {
+ my $dir=$source;
+ $dir=~s-/[^/]*$--;
+ my $file=$source;
+ $file=(split('/',$file))[-1];
+ $source=&Apache::lonnet::hreflocation($dir,$file);
+ $allmeta=&Apache::lonnet::ssi_body($source,('grade_target' => 'meta'));
+ &metaeval($allmeta);
+ }
+ return $allmeta;
+}
+
+#########################################
+#########################################
+
+=pod
+
+=item B
+This is the workhorse function of this module. This subroutine generates
+backup copies, performs any automatic processing (prior to publication,
+especially for rat and ssi files),
+
+Returns a 2 element array, the first is the string to be shown to the
+user, the second is an error code, either 1 (an error occured) or 0
+(no error occurred)
+
+I
+
+=cut
+
+#########################################
+#########################################
sub publish {
- my ($source,$target,$style)=@_;
+
+ my ($source,$target,$style,$batch)=@_;
my $logfile;
+ my $scrout='';
+ my $allmeta='';
+ my $content='';
+ my %allow=();
+
unless ($logfile=Apache::File->new('>>'.$source.'.log')) {
- return 'No write permission to user directory, FAIL';
+ return (''.&mt('No write permission to user directory, FAIL').' ',1);
}
print $logfile
-"\n\n================== Publish ".localtime()." =================\n";
+"\n\n================= Publish ".localtime()." Phase One ================\n".$env{'user.name'}.':'.$env{'user.domain'}."\n";
- if (($style eq 'ssi') || ($style eq 'rat')) {
+ if (($style eq 'ssi') || ($style eq 'rat') || ($style eq 'prv')) {
# ------------------------------------------------------- This needs processing
+
+# ----------------------------------------------------------------- Backup Copy
my $copyfile=$source.'.save';
+ if (copy($source,$copyfile)) {
+ print $logfile "Copied original file to ".$copyfile."\n";
+ } else {
+ print $logfile "Unable to write backup ".$copyfile.':'.$!."\n";
+ return ("Failed to write backup copy, $!,FAIL ",1);
+ }
+# ------------------------------------------------------------- IDs and indices
+
+ my ($outstring,$error);
+ ($outstring,$error,%allow)=&fix_ids_and_indices($logfile,$source,
+ $target);
+ if ($error) { return ($outstring,$error); }
+# ------------------------------------------------------------ Construct Allows
+
+ $scrout.=''.&mt('Dependencies').' ';
+ my $allowstr='';
+ foreach (sort(keys(%allow))) {
+ my $thisdep=$_;
+ if ($thisdep !~ /[^\s]/) { next; }
+ unless ($style eq 'rat') {
+ $allowstr.="\n".' ';
+ }
+ $scrout.=' ';
+ if ($thisdep!~/\*/ && $thisdep!~m|^/adm/|) {
+ $scrout.='';
+ }
+ $scrout.=''.$thisdep.' ';
+ if ($thisdep!~/\*/ && $thisdep!~m|^/adm/|) {
+ $scrout.=' ';
+ if (
+ &Apache::lonnet::getfile($Apache::lonnet::perlvar{'lonDocRoot'}.'/'.
+ $thisdep.'.meta') eq '-1') {
+ $scrout.= ' - '.&mt('Currently not available').
+ ' ';
+ } else {
+ my %temphash=(&Apache::lonnet::declutter($target).'___'.
+ &Apache::lonnet::declutter($thisdep).'___usage'
+ => time);
+ $thisdep=~m{^/res/($match_domain)/($match_username)/};
+ if ((defined($1)) && (defined($2))) {
+ &Apache::lonnet::put('nohist_resevaldata',\%temphash,
+ $1,$2);
+ }
+ }
+ }
+ }
+ $outstring=~s/\n*(\<\/[^\>]+\>[^<]*)$/$allowstr\n$1\n/s;
+
+# ------------------------------------------------------------- Write modified.
+
{
- my $org=Apache::File->new($source);
- my $cop=Apache::File->new('>'.$copyfile);
- while (my $line=<$org>) { print $cop $line; }
+ my $org;
+ unless ($org=Apache::File->new('>'.$source)) {
+ print $logfile "No write permit to $source\n";
+ return (''.&mt('No write permission to').
+ ' '.$source.
+ ', '.&mt('FAIL').' ',1);
+ }
+ print($org $outstring);
}
- if (-e $copyfile) {
- print $logfile "Copied original file to ".$copyfile."\n";
+ $content=$outstring;
+
+ }
+# -------------------------------------------- Initial step done, now metadata.
+
+# --------------------------------------- Storage for metadata keys and fields.
+# these are globals
+#
+ %metadatafields=();
+ %metadatakeys=();
+
+ my %oldparmstores=();
+
+ unless ($batch) {
+ $scrout.=''.&mt('Metadata Information').' ' .
+ Apache::loncommon::help_open_topic("Metadata_Description")
+ . ' ';
+ }
+
+# ------------------------------------------------ First, check out environment
+ if ((!(-e $source.'.meta')) || ($env{'form.forceoverride'})) {
+ $metadatafields{'author'}=$env{'environment.firstname'}.' '.
+ $env{'environment.middlename'}.' '.
+ $env{'environment.lastname'}.' '.
+ $env{'environment.generation'};
+ $metadatafields{'author'}=~s/\s+/ /g;
+ $metadatafields{'author'}=~s/\s+$//;
+ $metadatafields{'owner'}=$cuname.':'.$cudom;
+
+# ------------------------------------------------ Check out directory hierachy
+
+ my $thisdisfn=$source;
+ $thisdisfn=~s/^\/home\/\Q$cuname\E\///;
+
+ my @urlparts=split(/\//,$thisdisfn);
+ $#urlparts--;
+
+ my $currentpath='/home/'.$cuname.'/';
+
+ my $prefix='../'x($#urlparts);
+ foreach (@urlparts) {
+ $currentpath.=$_.'/';
+ $scrout.=&metaread($logfile,$currentpath.'default.meta',$prefix);
+ $prefix=~s|^\.\./||;
+ }
+
+# ----------------------------------------------------------- Parse file itself
+# read %metadatafields from file itself
+
+ $allmeta=&parseformeta($source,$style);
+
+# ------------------- Clear out parameters and stores (there should not be any)
+
+ foreach (keys %metadatafields) {
+ if (($_=~/^parameter/) || ($_=~/^stores/)) {
+ delete $metadatafields{$_};
+ }
+ }
+
+ } else {
+# ---------------------- Read previous metafile, remember parameters and stores
+
+ $scrout.=&metaread($logfile,$source.'.meta');
+
+ foreach (keys %metadatafields) {
+ if (($_=~/^parameter/) || ($_=~/^stores/)) {
+ $oldparmstores{$_}=1;
+ delete $metadatafields{$_};
+ }
+ }
+# ------------------------------------------------------------- Save some stuff
+ my %savemeta=();
+ foreach ('title') {
+ $savemeta{$_}=$metadatafields{$_};
+ }
+# ------------------------------------------ See if anything new in file itself
+
+ $allmeta=&parseformeta($source,$style);
+# ----------------------------------------------------------- Restore the stuff
+ foreach (keys %savemeta) {
+ $metadatafields{$_}=$savemeta{$_};
+ }
+ }
+
+
+# ---------------- Find and document discrepancies in the parameters and stores
+
+ my $chparms='';
+ foreach (sort keys %metadatafields) {
+ if (($_=~/^parameter/) || ($_=~/^stores/)) {
+ unless ($_=~/\.\w+$/) {
+ unless ($oldparmstores{$_}) {
+ print $logfile 'New: '.$_."\n";
+ $chparms.=$_.' ';
+ }
+ }
+ }
+ }
+ if ($chparms) {
+ $scrout.=''.&mt('New parameters or stored values').
+ ': '.$chparms.'
';
+ }
+
+ $chparms='';
+ foreach (sort keys %oldparmstores) {
+ if (($_=~/^parameter/) || ($_=~/^stores/)) {
+ unless (($metadatafields{$_.'.name'}) ||
+ ($metadatafields{$_.'.package'}) || ($_=~/\.\w+$/)) {
+ print $logfile 'Obsolete: '.$_."\n";
+ $chparms.=$_.' ';
+ }
+ }
+ }
+ if ($chparms) {
+ $scrout.=''.&mt('Obsolete parameters or stored values').': '.
+ $chparms.'
'.&mt('Warning!').
+ ' '.
+ &mt('If this resource is in active use, student performance data from the previous version may become inaccessible.').'
';
+ }
+
+# ------------------------------------------------------- Now have all metadata
+
+ my %keywords=();
+
+ if (length($content)<500000) {
+ my $textonly=$content;
+ $textonly=~s/\
+$KEYWORDS:
+ $keywords_help
+
+
+
+
+END
+ $keywordout.='';
+
+ $intr_scrout.=$keywordout;
+
+ $intr_scrout.=&textfield('Additional Keywords','addkey','');
+
+ $intr_scrout.=&textfield('Notes','notes',$metadatafields{'notes'});
+
+ $intr_scrout.=
+ "\n".&mt('Abstract').":".
+ "
".
+ '
';
+
+ $source=~/\.(\w+)$/;
+
+
+ $intr_scrout.=
+ "\n".
+ &mt('Lowest Grade Level').':'.
+ "
".
+ &select_level_form($metadatafields{'lowestgradelevel'},'lowestgradelevel').
+ "\n".
+ &mt('Highest Grade Level').':'.
+ "
".
+ &select_level_form($metadatafields{'highestgradelevel'},'highestgradelevel').
+ &textfield('Standards','standards',$metadatafields{'standards'});
+
+
+
+
+ $intr_scrout.=&hiddenfield('mime',$1);
+
+ my $defaultlanguage=$metadatafields{'language'};
+ $defaultlanguage =~ s/\s*notset\s*//g;
+ $defaultlanguage =~ s/^,\s*//g;
+ $defaultlanguage =~ s/,\s*$//g;
+
+ $intr_scrout.=&selectbox('Language','language',
+ $defaultlanguage,
+ \&Apache::loncommon::languagedescription,
+ (&Apache::loncommon::languageids),
+ );
+
+ unless ($metadatafields{'creationdate'}) {
+ $metadatafields{'creationdate'}=time;
+ }
+ $intr_scrout.=&hiddenfield('creationdate',
+ &Apache::lonmysql::unsqltime($metadatafields{'creationdate'}));
+
+ $intr_scrout.=&hiddenfield('lastrevisiondate',time);
+
+
+ $intr_scrout.=&textfield('Publisher/Owner','owner',
+ $metadatafields{'owner'});
+
+# ---------------------------------------------- Retrofix for unused copyright
+ if ($metadatafields{'copyright'} eq 'free') {
+ $metadatafields{'copyright'}='default';
+ $metadatafields{'sourceavail'}='open';
+ }
+# ------------------------------------------------ Dial in reasonable defaults
+ my $defaultoption=$metadatafields{'copyright'};
+ unless ($defaultoption) { $defaultoption='default'; }
+ my $defaultsourceoption=$metadatafields{'sourceavail'};
+ unless ($defaultsourceoption) { $defaultsourceoption='closed'; }
+ unless ($style eq 'prv') {
+# -------------------------------------------------- Correct copyright for rat.
+ if ($style eq 'rat') {
+# -------------------------------------- Retrofix for non-applicable copyright
+ if ($metadatafields{'copyright'} eq 'public') {
+ delete $metadatafields{'copyright'};
+ $defaultoption='default';
+ }
+ $intr_scrout.=&selectbox('Copyright/Distribution','copyright',
+ $defaultoption,
+ \&Apache::loncommon::copyrightdescription,
+ (grep !/^public$/,(&Apache::loncommon::copyrightids)));
+ } else {
+ $intr_scrout.=&selectbox('Copyright/Distribution','copyright',
+ $defaultoption,
+ \&Apache::loncommon::copyrightdescription,
+ (&Apache::loncommon::copyrightids));
+ }
+ my $copyright_help =
+ Apache::loncommon::help_open_topic('Publishing_Copyright');
+ $intr_scrout =~ s/Distribution:/'Distribution: ' . $copyright_help/ge;
+ $intr_scrout.=&text_with_browse_field('Custom Distribution File','customdistributionfile',$metadatafields{'customdistributionfile'},'rights').$copyright_help;
+ $intr_scrout.=&selectbox('Source Distribution','sourceavail',
+ $defaultsourceoption,
+ \&Apache::loncommon::source_copyrightdescription,
+ (&Apache::loncommon::source_copyrightids));
+# $intr_scrout.=&text_with_browse_field('Source Custom Distribution File','sourcerights',$metadatafields{'sourcerights'},'rights');
+ my $uctitle=&mt('Obsolete');
+ $intr_scrout.=
+ "\n$uctitle:".
+ '
'.
+ &text_with_browse_field('Suggested Replacement for Obsolete File',
+ 'obsoletereplacement',
+ $metadatafields{'obsoletereplacement'});
+ } else {
+ $intr_scrout.=&hiddenfield('copyright','private');
+ }
+ } else {
+ $intr_scrout.=
+ &hiddenfield('title',$metadatafields{'title'}).
+ &hiddenfield('author',$metadatafields{'author'}).
+ &hiddenfield('subject',$metadatafields{'subject'}).
+ &hiddenfield('keywords',$metadatafields{'keywords'}).
+ &hiddenfield('abstract',$metadatafields{'abstract'}).
+ &hiddenfield('notes',$metadatafields{'notes'}).
+ &hiddenfield('mime',$metadatafields{'mime'}).
+ &hiddenfield('creationdate',$metadatafields{'creationdate'}).
+ &hiddenfield('lastrevisiondate',time).
+ &hiddenfield('owner',$metadatafields{'owner'}).
+ &hiddenfield('lowestgradelevel',$metadatafields{'lowestgradelevel'}).
+ &hiddenfield('standards',$metadatafields{'standards'}).
+ &hiddenfield('highestgradelevel',$metadatafields{'highestgradelevel'}).
+ &hiddenfield('language',$metadatafields{'language'}).
+ &hiddenfield('copyright',$metadatafields{'copyright'}).
+ &hiddenfield('sourceavail',$metadatafields{'sourceavail'}).
+ &hiddenfield('customdistributionfile',$metadatafields{'customdistributionfile'}).
+ &hiddenfield('obsolete',1).
+ &text_with_browse_field('Suggested Replacement for Obsolete File',
+ 'obsoletereplacement',
+ $metadatafields{'obsoletereplacement'});
+ }
+ if (!$batch) {
+ $scrout.=$intr_scrout.'
';
+ }
+ return($scrout,0);
+}
+
+#########################################
+#########################################
+
+=pod
+
+=item B
+
+Render second interface showing status of publication steps.
+This is publication step two.
+
+Parameters:
+
+=over 4
+
+=item I<$source>
+
+=item I<$target>
+
+=item I<$style>
+
+=item I<$distarget>
+
+=back
+
+Returns:
+
+=over 4
+
+=item integer
+
+0: fail
+1: success
+
+=cut
+
+#'stupid emacs
+#########################################
+#########################################
+sub phasetwo {
+
+ my ($r,$source,$target,$style,$distarget,$batch)=@_;
+ $source=~s/\/+/\//g;
+ $target=~s/\/+/\//g;
+#
+# Unless trying to get rid of something, check name validity
+#
+ unless ($env{'form.obsolete'}) {
+ if ($target=~/(\_\_\_|\&\&\&|\:\:\:)/) {
+ $r->print(
+ ''.&mt('Unsupported character combination').
+ ' "'.$1.' " '.&mt('in filename, FAIL').' ');
+ return 0;
+ }
+ unless ($target=~/\.(\w+)$/) {
+ $r->print(''.&mt('No valid extension found in filename, FAIL').' ');
+ return 0;
+ }
+ if ($target=~/\.(\d+)\.(\w+)$/) {
+ $r->print(''.&mt('Cannot publish versioned resource, FAIL').' ');
+ return 0;
+ }
+ }
+
+#
+# End name check
+#
+ $distarget=~s/\/+/\//g;
+ my $logfile;
+ unless ($logfile=Apache::File->new('>>'.$source.'.log')) {
+ $r->print(
+ ''.
+ &mt('No write permission to user directory, FAIL').' ');
+ return 0;
+ }
+ print $logfile
+ "\n================= Publish ".localtime()." Phase Two ================\n".$env{'user.name'}.':'.$env{'user.domain'}."\n";
+
+ %metadatafields=();
+ %metadatakeys=();
+
+ &metaeval(&unescape($env{'form.allmeta'}));
+
+ $metadatafields{'title'}=$env{'form.title'};
+ $metadatafields{'author'}=$env{'form.author'};
+ $metadatafields{'subject'}=$env{'form.subject'};
+ $metadatafields{'notes'}=$env{'form.notes'};
+ $metadatafields{'abstract'}=$env{'form.abstract'};
+ $metadatafields{'mime'}=$env{'form.mime'};
+ $metadatafields{'language'}=$env{'form.language'};
+ $metadatafields{'creationdate'}=$env{'form.creationdate'};
+ $metadatafields{'lastrevisiondate'}=$env{'form.lastrevisiondate'};
+ $metadatafields{'owner'}=$env{'form.owner'};
+ $metadatafields{'copyright'}=$env{'form.copyright'};
+ $metadatafields{'standards'}=$env{'form.standards'};
+ $metadatafields{'lowestgradelevel'}=$env{'form.lowestgradelevel'};
+ $metadatafields{'highestgradelevel'}=$env{'form.highestgradelevel'};
+ $metadatafields{'customdistributionfile'}=
+ $env{'form.customdistributionfile'};
+ $metadatafields{'sourceavail'}=$env{'form.sourceavail'};
+ $metadatafields{'obsolete'}=$env{'form.obsolete'};
+ $metadatafields{'obsoletereplacement'}=
+ $env{'form.obsoletereplacement'};
+ $metadatafields{'dependencies'}=$env{'form.dependencies'};
+ $metadatafields{'modifyinguser'}=$env{'user.name'}.':'.
+ $env{'user.domain'};
+ $metadatafields{'authorspace'}=$cuname.':'.$cudom;
+ $metadatafields{'domain'}=$cudom;
+
+ my $allkeywords=$env{'form.addkey'};
+ if (exists($env{'form.keywords'})) {
+ if (ref($env{'form.keywords'})) {
+ $allkeywords .= ','.join(',',@{$env{'form.keywords'}});
} else {
- return "Failed to write backup copy, FAIL";
+ $allkeywords .= ','.$env{'form.keywords'};
}
+ }
+ $allkeywords=~s/[\"\']//g;
+ $allkeywords=~s/\s*[\;\,]\s*/\,/g;
+ $allkeywords=~s/\s+/ /g;
+ $allkeywords=~s/^[ \,]//;
+ $allkeywords=~s/[ \,]$//;
+ $metadatafields{'keywords'}=$allkeywords;
+
+# check if custom distribution file is specified
+ if ($metadatafields{'copyright'} eq 'custom') {
+ my $file=$metadatafields{'customdistributionfile'};
+ unless ($file=~/\.rights$/) {
+ $r->print(
+ ''.&mt('No valid custom distribution rights file specified, FAIL').
+ ' ');
+ return 0;
+ }
+ }
+ {
+ print $logfile "\nWrite metadata file for ".$source;
+ my $mfh;
+ unless ($mfh=Apache::File->new('>'.$source.'.meta')) {
+ $r->print(
+ ''.&mt('Could not write metadata, FAIL').
+ ' ');
+ return 0;
+ }
+ foreach (sort keys %metadatafields) {
+ unless ($_=~/\./) {
+ my $unikey=$_;
+ $unikey=~/^([A-Za-z]+)/;
+ my $tag=$1;
+ $tag=~tr/A-Z/a-z/;
+ print $mfh "\n\<$tag";
+ foreach (split(/\,/,$metadatakeys{$unikey})) {
+ my $value=$metadatafields{$unikey.'.'.$_};
+ $value=~s/\"/\'\'/g;
+ print $mfh ' '.$_.'="'.$value.'"';
+ }
+ print $mfh '>'.
+ &HTML::Entities::encode($metadatafields{$unikey},'<>&"')
+ .''.$tag.'>';
+ }
+ }
+ $r->print(''.&mt('Wrote Metadata').'
');
+ print $logfile "\nWrote metadata";
+ }
+
+# -------------------------------- Synchronize entry with SQL metadata database
+ $metadatafields{'url'} = $distarget;
+ $metadatafields{'version'} = 'current';
+
+ my ($error,$success) = &store_metadata(%metadatafields);
+ if ($success) {
+ $r->print(''.&mt('Synchronized SQL metadata database').'
');
+ print $logfile "\nSynchronized SQL metadata database";
+ } else {
+ $r->print($error);
+ print $logfile "\n".$error;
}
- my $version='';
+# --------------------------------------------- Delete author resource messages
+ my $delresult=&Apache::lonmsg::del_url_author_res_msg($target);
+ $r->print(''.&mt('Removing error messages:').' '.$delresult.'
');
+ print $logfile "\nRemoving error messages: $delresult";
+# ----------------------------------------------------------- Copy old versions
- return 'Version '.$version.', SUCCESS';
+ 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').' '.
+ ''.
+ &mt('Back to Source').'
'.
+ ''.
+ &mt('Back to Source Directory').'
');
+ }
+ $logfile->close();
+ $r->print(''.&mt('Done').'
');
+ 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('');
+ &phasetwo($r,$srcfile,$targetfile,$thisembstyle,$thisdistarget,1);
+ $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.
-# ================================================================ Main Handler
+=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;
+ my $r=shift;
+
+ if ($r->header_only) {
+ &Apache::loncommon::content_type($r,'text/html');
+ $r->send_http_header;
+ return OK;
+ }
- if ($r->header_only) {
- $r->content_type('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=$ENV{'form.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};
- unless ($fn) {
- $r->log_reason($ENV{'user.name'}.' at '.$ENV{'user.domain'}.
- ' trying to publish empty filename', $r->filename);
- return HTTP_NOT_FOUND;
- }
-
- $fn=~s/^http\:\/\/[^\/]+\/\~(\w+)/\/home\/$1\/public_html/;
-
- my $targetdir='';
- my $docroot=$r->dir_config('lonDocRoot');
- if ($1 ne $ENV{'user.name'}) {
- $r->log_reason($ENV{'user.name'}.' at '.$ENV{'user.domain'}.
- ' trying to publish unowned file '.$ENV{'form.filename'}.
- ' ('.$fn.')',
- $r->filename);
- return HTTP_NOT_ACCEPTABLE;
- } else {
- $targetdir=$docroot.'/res/'.$ENV{'user.domain'};
- }
+ 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($ENV{'user.name'}.' at '.$ENV{'user.domain'}.
- ' 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;
- }
- }
-# ----------------------------------------------------------- Start page output
-
- $r->content_type('text/html');
- $r->send_http_header;
-
- $r->print('LON-CAPA Publishing ');
- $r->print('');
- my $thisfn=$fn;
-
-# ------------------------------------------------------------- Individual file
- {
- $thisfn=~/\.(\w+)$/;
- my $thistype=$1;
- my $thisembstyle=&Apache::lonnet::fileembstyle($thistype);
+ 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;
+ }
+ }
- my $thistarget=$thisfn;
-
- $thistarget=~s/^\/home/$targetdir/;
- $thistarget=~s/\/public\_html//;
+ %nokey=();
+
+ {
+ my $fh=Apache::File->new($r->dir_config('lonIncludes').'/un_keyword.tab');
+ while (<$fh>) {
+ my $word=$_;
+ chomp($word);
+ $nokey{$word}=1;
+ }
+ }
- my $thisdistarget=$thistarget;
- $thisdistarget=~s/^$docroot//;
+# ---------------------------------------------------------- Start page output.
- my $thisdisfn=$thisfn;
- $thisdisfn=~s/^\/home\/$ENV{'user.name'}\/public_html\///;
+ &Apache::loncommon::content_type($r,'text/html');
+ $r->send_http_header;
+
+ my $js='';
+ $r->print(&Apache::loncommon::start_page('Resource Publication',$js));
- $r->print('Publishing '.
- &Apache::lonnet::filedescription($thistype).' '.
- $thisdisfn.' Target: '.$thisdistarget.' ');
-# ------------ We are publishing from $thisfn to $thistarget with $thisembstyle
+ my $thisfn=$fn;
- $r->print('Result: '.&publish($thisfn,$thistarget,$thisembstyle));
+ my $thistarget=$thisfn;
- }
+ $thistarget=~s/^\/home/$targetdir/;
+ $thistarget=~s/\/public\_html//;
- $r->print('');
+ my $thisdistarget=$thistarget;
+ $thisdistarget=~s/^\Q$docroot\E//;
- return OK;
+ 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(''.&mt('Publishing').' '.
+ &Apache::loncommon::filedescription($thistype).' ');
+
+ $r->print(<
+$thisdisfn
+ENDCAPTION
+ $r->print(' '.&mt('Target').': '.
+ $thisdistarget.' ');
+
+ if (($cuname ne $env{'user.name'})||($cudom ne $env{'user.domain'})) {
+ $r->print(''.&mt('Co-Author').': '.
+ $cuname.&mt(' at ').$cudom.' ');
+ }
+
+ if (&Apache::loncommon::fileembstyle($thistype) eq 'ssi') {
+ $r->print(<
+
+ENDDIFF
+ $r->print(&mt('Diffs with Current Version').' ');
+ }
+
+# ------------------ Publishing from $thisfn to $thistarget with $thisembstyle.
+
+ unless ($env{'form.phase'} eq 'two') {
+# ---------------------------------------------------------- Parse for problems
+ my ($warningcount,$errorcount);
+ if ($thisembstyle eq 'ssi') {
+ ($warningcount,$errorcount)=&checkonthis($r,$thisfn);
+ }
+ unless ($errorcount) {
+ my ($outstring,$error)=
+ &publish($thisfn,$thistarget,$thisembstyle);
+ $r->print(' '.$outstring);
+ } else {
+ $r->print(''.
+ &mt('The document contains errors and cannot be published.').
+ ' ');
+ }
+ } else {
+ &phasetwo($r,$thisfn,$thistarget,$thisembstyle,$thisdistarget);
+ $r->print(' ');
+ }
+ }
+ $r->print(&Apache::loncommon::end_page());
+
+ return OK;
}
1;
__END__
+=pod
+=back
+=back
-
-
+=cut