Annotation of loncom/publisher/lonpublisher.pm, revision 1.289

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

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