# The LearningOnline Network with CAPA
# Construction Space Directory Lister
#
# $Id: lonpubdir.pm,v 1.122 2009/05/28 17:08:38 bisitz Exp $
#
# Copyright Michigan State University Board of Trustees
#
# This file is part of the LearningOnline Network with CAPA (LON-CAPA).
#
# LON-CAPA is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# LON-CAPA is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with LON-CAPA; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
#
# /home/httpd/html/adm/gpl.txt
#
# http://www.lon-capa.org/
#
###
package Apache::lonpubdir;
use strict;
use Apache::File;
use File::Copy;
use Apache::Constants qw(:common :http :methods);
use Apache::loncacc;
use Apache::loncommon();
use Apache::lonhtmlcommon();
use Apache::londiff();
use Apache::lonlocal;
use Apache::lonmsg;
use Apache::lonmenu;
use Apache::lonnet;
use LONCAPA;
sub handler {
my $r=shift;
my $fn;
$fn = getEffectiveUrl($r);
# Validate access to the construction space and get username@domain.
my $uname;
my $udom;
($uname,$udom)=
&Apache::loncacc::constructaccess(
$fn,$r->dir_config('lonDefDomain'));
unless (($uname) && ($udom)) {
$r->log_reason($uname.':'.$udom.
' trying to list directory '.$env{'form.filename'}.
' ('.$fn.') - not authorized',
$r->filename);
return HTTP_NOT_ACCEPTABLE;
}
# Remove trailing / from directory name.
$fn=~s/\/$//;
unless ($fn) {
$r->log_reason($env{'user.name'}.':'.$env{'user.domain'}.
' trying to list empty directory', $r->filename);
return HTTP_NOT_FOUND;
}
# ----------------------------------------------------------- Start page output
my $thisdisfn=$fn;
$thisdisfn=~s/^\/home\/$uname\/public_html//; # subdirectory part of
# construction space.
my $docroot=$r->dir_config('lonDocRoot'); # Apache londocument root.
my $resdir=$docroot.'/res/'.$udom.'/'.$uname.$thisdisfn; # Resource directory
my $targetdir=$udom.'/'.$uname.$thisdisfn; # Publiction target directory.
my $linkdir='/priv/'.$uname.$thisdisfn; # Full URL name of constr space.
my %bombs=&Apache::lonmsg::all_url_author_res_msg($uname,$udom);
&startpage($r, $uname, $udom, $thisdisfn); # Put out the start of page.
if ($env{'environment.remote'} eq 'off') {
&dircontrols($r,$uname,$udom,$thisdisfn); # Put out actions for directory,
# browse/upload + new file page.
} else {
&pubbuttons($r,$uname,$thisdisfn);
}
&resourceactions($r,$uname,$udom,$thisdisfn); #Put out form used for printing/deletion etc.
my $numdir = 0;
my $numres = 0;
# Start off the directory table.
$r->print(&Apache::loncommon::start_data_table()
.&Apache::loncommon::start_data_table_header_row()
.'
'.&mt('Type').'
'
.'
'.&mt('Actions').'
'
.'
'.&mt('Name').'
'
.'
'.&mt('Title').'
'
.'
'.&mt('Status').'
'
.'
'.&mt('Last Modified').'
'
.&Apache::loncommon::end_data_table_header_row()
);
my $filename;
my $dirptr=16384; # Mask indicating a directory in stat.cmode.
opendir(DIR,$fn);
my @files=sort {uc($a) cmp uc($b)} (readdir(DIR));
foreach my $filename (@files) {
my ($cdev,$cino,$cmode,$cnlink,
$cuid,$cgid,$crdev,$csize,
$catime,$cmtime,$cctime,
$cblksize,$cblocks)=stat($fn.'/'.$filename);
my $extension='';
if ($filename=~/\.(\w+)$/) { $extension=$1; }
if ($cmode&$dirptr) {
putdirectory($r, $thisdisfn, $linkdir, $filename, $cmtime,$targetdir,\%bombs,\$numdir);
} elsif (&Apache::loncommon::fileembstyle($extension) ne 'hdn') {
putresource($r, $udom, $uname, $filename, $thisdisfn, $resdir,
$targetdir, $linkdir, $cmtime,\%bombs,\$numres);
} else {
# "hidden" extension and not a directory, so hide it away.
}
}
closedir(DIR);
$r->print(&Apache::loncommon::end_data_table()
.&Apache::loncommon::end_page()
);
return OK;
}
#
# Gets the effective URL of the request and returns it:
# $effn = getEffectiveUrl($r);
# $r - The Apache Request object.
sub getEffectiveUrl {
my $r = shift;
my $fn;
if ($env{'form.filename'}) { # If a form filename is defined.
$fn=$env{'form.filename'};
#
# Replace the ~username of the URL with /home/username/public_html
# so that we don't have to worry about ~ expansion internally.
#
$fn=~s/^https?\:\/\/[^\/]+\///;
$fn=~s/^\///;
$fn=~s{~($LONCAPA::username_re)}{/home/$1/public_html};
# Remove trailing / strings (?)
$fn=~s/\/[^\/]+$//;
} else {
# If no form is defined, use request filename.
$fn = $r->filename();
my $lonDocRoot=$r->dir_config('lonDocRoot');
if ( $fn =~ /$lonDocRoot/ ) {
#internal authentication, needs fixup.
$fn = $r->uri(); # non users do not get the full path request
# through SCRIPT_FILENAME
$fn=~s{^/~($LONCAPA::username_re)}{/home/$1/public_html};
}
}
$fn=~s/\/+/\//g;
return $fn;
}
#
# Output the header of the page. This includes:
# - The HTML header
# - The H1/H3 stuff which includes the directory.
#
# startpage($r, $uame, $udom, $thisdisfn);
# $r - The apache request object.
# $uname - User name.
# $udom - Domain name the user is logged in under.
# $thisdisfn - Displayable version of the filename.
sub startpage {
my ($r, $uname, $udom, $thisdisfn) = @_;
my $currdir = '/priv/'.$uname.$thisdisfn;
&Apache::loncommon::content_type($r,'text/html');
$r->send_http_header;
my $formaction='/priv/'.$uname.$thisdisfn.'/';
$formaction=~s|/+|/|g;
&Apache::lonhtmlcommon::store_recent('construct',$formaction,$formaction);
if ($env{'environment.remote'} eq 'off') {
$env{'request.noversionuri'}=$currdir.'/';
$r->print(&Apache::loncommon::start_page('Construction Space',undef));
} else {
$r->print(&Apache::loncommon::start_page('Construction Space',undef,
{ 'only_body' => 1,}));
}
# Breadcrumbs
&Apache::lonhtmlcommon::clear_breadcrumbs();
&Apache::lonhtmlcommon::add_breadcrumb({
'text' => 'Construction Space',
'href' => &Apache::loncommon::authorspace(),
});
$r->print(&Apache::lonhtmlcommon::breadcrumbs());
$r->print(&Apache::loncommon::head_subbox(
&Apache::loncommon::CSTR_pageheader(1)));
my $esc_thisdisfn = &Apache::loncommon::escape_single($thisdisfn);
my $doctitle = 'LON-CAPA '.&mt('Construction Space');
my $newname = &mt('New Name');
my $pubdirscript=(<
top.document.title = '$esc_thisdisfn/ - $doctitle';
// Store directory location for menu bar to find
parent.lastknownpriv='/~$uname$esc_thisdisfn/';
// Confirmation dialogues
function currdiract(theform) {
if (theform.dirtask.options[theform.dirtask.selectedIndex].value == 'publish') {
document.publishdir.filename.value = theform.filename.value;
document.publishdir.submit();
}
if (theform.dirtask.options[theform.dirtask.selectedIndex].value == 'editmeta') {
top.location=theform.filename.value+'default.meta'
}
if (theform.dirtask.options[theform.dirtask.selectedIndex].value == 'printdir' ) {
document.printdir.postdata.value=theform.filename.value
document.printdir.submit();
}
if (theform.dirtask.options[theform.dirtask.selectedIndex].value == "delete") {
var delform = document.delresource
delform.filename.value = theform.filename.value
delform.submit()
}
}
function checkUpload(theform) {
if (theform.file == '') {
alert("Please use 'Browse..' to choose a file first, before uploading")
return
}
theform.submit()
}
function SetPubDir(theform,printForm) {
if (theform.diraction.options[theform.diraction.selectedIndex].value == "open") {
top.location = theform.openname.value
return
}
if (theform.diraction.options[theform.diraction.selectedIndex].value == "publish") {
theform.submit();
}
if (theform.diraction.options[theform.diraction.selectedIndex].value == "editmeta") {
top.location=theform.filename.value+'default.meta'
}
if (theform.diraction.options[theform.diraction.selectedIndex].value == "printdir") {
theform.action = '/adm/printout'
theform.postdata.value = theform.filename.value
theform.submit()
}
if (theform.diraction.options[theform.diraction.selectedIndex].value == "delete") {
var delform = document.delresource
delform.filename.value = theform.filename.value
delform.submit()
}
return
}
function SetResChoice(theform) {
var activity = theform.reschoice.options[theform.reschoice.selectedIndex].value
if ((activity == 'rename') || (activity == 'copy') || (activity == 'move')) {
changename(theform,activity)
}
if (activity == 'publish') {
var pubform = document.pubresource
pubform.filename.value = theform.filename.value
pubform.submit()
}
if (activity == 'delete') {
var delform = document.delresource
delform.filename.value = theform.filename.value
delform.submit()
}
if (activity == 'obsolete') {
var pubform = document.pubresource
pubform.filename.value = theform.filename.value
pubform.makeobsolete.value=1;
pubform.submit()
}
if (activity == 'print') {
document.printresource.postdata.value = theform.filename.value
document.printresource.submit()
}
if (activity == 'retrieve') {
document.retrieveres.filename.value = theform.filename.value
document.retrieveres.submit()
}
if (activity == 'cleanup') {
document.cleanup.filename.value = theform.filename.value
document.cleanup.submit()
}
return
}
function changename(theform,activity) {
var oldname=theform.dispfilename.value;
var newname=prompt('$newname',oldname);
if (newname == "" || !newname || newname == oldname) {
return
}
document.moveresource.newfilename.value = newname
document.moveresource.filename.value = theform.filename.value
document.moveresource.action.value = activity
document.moveresource.submit();
}
ENDPUBDIRSCRIPT
$r->print($pubdirscript);
if ((($uname ne $env{'user.name'}) || ($udom ne $env{'user.domain'})) &&
$env{'environment.remote'} ne 'off') {
$r->print('
'.&mt('Co-Author [_1]',$uname.':'.$udom).'
');
}
}
sub dircontrols {
my ($r,$uname,$udom,$thisdisfn) = @_;
my %lt=&Apache::lonlocal::texthash(
cnpd => 'Cannot publish directory',
cnrd => 'Cannot retrieve directory',
mcdi => 'Must create new subdirectory inside a directory',
pubr => 'Publish this Resource',
pubd => 'Publish this Directory',
dedr => 'Delete Directory',
rtrv => 'Retrieve Old Version',
list => 'List Directory',
uplo => 'Upload file',
dele => 'Delete',
edit => 'Edit Metadata',
sela => 'Select Action',
nfil => 'New file',
nhtm => 'New HTML file',
nprb => 'New problem',
npag => 'New assembled page',
nseq => 'New assembled sequence',
ncrf => 'New custom rights file',
nsty => 'New style file',
nlib => 'New library file',
nbt => 'New bridgetask file',
nsub => 'New subdirectory',
renm => 'Rename current file to',
move => 'Move current file to',
copy => 'Copy current file to',
type => 'Type Name Here',
go => 'Go',
prnt => 'Print contents of directory',
crea => 'Create a new directory or LON-CAPA document',
acti => 'Actions for current directory',
updc => 'Upload a new document',
pick => 'Please select an action to perform using the new filename',
);
my $mytype = $lt{'type'}; # avoid conflict with " and ' in javascript
$r->print(<
END
}
sub pubbuttons {
my ($r,$uname,$thisdisfn) = @_;
$r->print('');
}
sub resourceactions {
my ($r,$uname,$udom,$thisdisfn) = @_;
$r->print(<
END
}
#
# Get the title string or "[untitled]" if the file has no title metadata:
# Without the latter substitution, it's impossible to examine metadata for
# untitled resources. Resources may be legitimately untitled, to prevent
# searches from locating them.
#
# $str = getTitleString($fullname);
# $fullname - Fully qualified filename to check.
#
sub getTitleString {
my $fullname = shift;
my $title = &Apache::lonnet::metadata($fullname, 'title');
unless ($title) {
$title = "[".&mt('untitled')."]";
}
return $title;
}
sub getCopyRightString {
my $fullname = shift;
return &Apache::lonnet::metadata($fullname, 'copyright');
}
sub getSourceRightString {
my $fullname = shift;
return &Apache::lonnet::metadata($fullname, 'sourceavail');
}
#
# Put out a directory table row:
# putdirectory(r, base, here, dirname, modtime)
# r - Apache request object.
# reqfile - File in request.
# here - Where we are in directory tree.
# dirname - Name of directory special file.
# modtime - Encoded modification time.
#
sub putdirectory {
my ($r, $reqfile, $here, $dirname, $modtime, $resdir, $bombs, $numdir) = @_;
# construct the display filename: the directory name unless ..:
my $disfilename = $dirname;
if ($dirname eq '..') {
$disfilename = ''.&mt('Parent Directory').'';
}
unless ( (($dirname eq '..') && ($reqfile eq '')) || ($dirname eq '.')) {
my $kaputt=0;
foreach (keys %{$bombs}) {
if ($_=~m:^\Q$resdir\E/\Q$disfilename\E/:) { $kaputt=1; last; }
}
%Apache::lonpublisher::metadatafields=();
%Apache::lonpublisher::metadatakeys=();
my $construct=$here;
$construct=~s{^/priv/($LONCAPA::username_re)$}{/home/$1/public_html};
my $dirpath = $here;
$dirpath=~s{^/priv/}{/~};
&Apache::lonpublisher::metaeval(&Apache::lonnet::getfile(
$construct.'/'.$dirname.'/default.meta'
));
my $actionitem = '';
if ($dirname eq '..') {
$actionitem = &mt('Go to ...');
} else {
$actionitem =
'';
$$numdir ++;
}
$r->print('
'.
&Apache::loncommon::end_data_table_row()
);
return OK;
}
sub create_pubselect {
my ($r,$pub_select,$udom,$uname,$thisdisfn,$filename,$resdir,$pubstatus,$publish_button,$numres) = @_;
$$pub_select = '
';
$$numres ++;
}
sub check_for_versions {
my ($r,$fn,$udom,$uname) = @_;
my $versions = 0;
my $docroot=$r->dir_config('lonDocRoot');
my $resfn=$docroot.'/res/'.$udom.'/'.$uname.$fn;
my $resdir=$resfn;
$resdir=~s/\/[^\/]+$/\//;
$fn=~/\/([^\/]+)\.(\w+)$/;
my $main=$1;
my $suffix=$2;
opendir(DIR,$resdir);
while (my $filename=readdir(DIR)) {
if ($filename=~/^\Q$main\E\.(\d+)\.\Q$suffix\E$/) {
$versions ++;
}
}
return $versions;
}
#
# Categorize files in the directory.
# For each file in a list of files in a file directory,
# the file categorized as one of:
# - directory
# - sequence
# - problem
# - Other resource.
#
# For each file the modification date is determined as well.
# Returned is a list of sublists:
# (directories, sequences, problems, other)
# each of the sublists contains entries of the following form (sorted by
# filename):
# (filename, typecode, lastmodtime)
#
# $list = CategorizeFiles($location, $files)
# $location - Directory in which the files live (relative to our
# execution.
# $files - list of files.
#
sub CategorizeFiles {
my $location = shift;
my $files = shift;
}
1;
__END__
=head1 NAME
Apache::lonpubdir - Construction space directory lister
=head1 SYNOPSIS
Invoked (for various locations) by /etc/httpd/conf/srm.conf:
PerlAccessHandler Apache::loncacc
SetHandler perl-script
PerlHandler Apache::lonpubdir
ErrorDocument 403 /adm/login
ErrorDocument 404 /adm/notfound.html
ErrorDocument 406 /adm/unauthorized.html
ErrorDocument 500 /adm/errorhandler
PerlAccessHandler Apache::lonacc
SetHandler perl-script
PerlHandler Apache::lonpubdir
ErrorDocument 403 /adm/login
ErrorDocument 404 /adm/notfound.html
ErrorDocument 406 /adm/unauthorized.html
ErrorDocument 500 /adm/errorhandler
=head1 INTRODUCTION
This module publishes a directory of files.
This is part of the LearningOnline Network with CAPA project
described at http://www.lon-capa.org.
=head1 HANDLER SUBROUTINE
This routine is called by Apache and mod_perl.
=over 4
=item *
read in information
=item *
start page output
=item *
run through list of files and attempt to publish unhidden files
=back
=head1 SUBROUTINES:
=over
=item startpage($r, $uame, $udom, $thisdisfn)
Output the header of the page. This includes:
- The HTML header
- The H1/H3 stuff which includes the directory.
startpage($r, $uame, $udom, $thisdisfn);
$r - The apache request object.
$uname - User name.
$udom - Domain name the user is logged in under.
$thisdisfn - Displayable version of the filename.
=item getTitleString($fullname)
Get the title string or "[untitled]" if the file has no title metadata:
Without the latter substitution, it's impossible to examine metadata for
untitled resources. Resources may be legitimately untitled, to prevent
searches from locating them.
$str = getTitleString($fullname);
$fullname - Fully qualified filename to check.
=item putdirectory(r, base, here, dirname, modtime)
Put out a directory table row:
putdirectory($r, $base, $here, $dirname, $modtime)
$r - Apache request object.
$reqfile - File in request.
$here - Where we are in directory tree.
$dirname - Name of directory special file.
$modtime - Encoded modification time.
=item CategorizeFiles($location, $files)
Categorize files in the directory.
For each file in a list of files in a file directory,
the file categorized as one of:
- directory
- sequence
- problem
- Other resource.
For each file the modification date is determined as well.
Returned is a list of sublists:
(directories, sequences, problems, other)
each of the sublists contains entries of the following form (sorted by filename):
(filename, typecode, lastmodtime)
$list = CategorizeFiles($location, $files)
$location - Directory in which the files live (relative to our execution)
$files - list of files.
=back
=cut