--- loncom/publisher/lonpubdir.pm 2007/07/25 19:56:57 1.103
+++ loncom/publisher/lonpubdir.pm 2024/08/18 22:25:36 1.160.2.5.2.4
@@ -1,7 +1,7 @@
# The LearningOnline Network with CAPA
-# Construction Space Directory Lister
+# Authoring Space Directory Lister
#
-# $Id: lonpubdir.pm,v 1.103 2007/07/25 19:56:57 albertel Exp $
+# $Id: lonpubdir.pm,v 1.160.2.5.2.4 2024/08/18 22:25:36 raeburn Exp $
#
# Copyright Michigan State University Board of Trustees
#
@@ -33,7 +33,6 @@ 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();
@@ -41,188 +40,336 @@ use Apache::lonlocal;
use Apache::lonmsg;
use Apache::lonmenu;
use Apache::lonnet;
-use LONCAPA;
+use LONCAPA qw(:DEFAULT :match);
sub handler {
- my $r=shift;
+ my $r=shift;
- my $fn;
+ # Validate access to the construction space and get username:domain.
+ my ($uname,$udom)=&Apache::lonnet::constructaccess($r->uri);
+ unless (($uname) && ($udom)) {
+ return HTTP_NOT_ACCEPTABLE;
+ }
+# ----------------------------------------------------------- Start page output
- $fn = getEffectiveUrl($r);
+ my $fn=$r->filename;
+ $fn=~s/\/$//;
+ my $thisdisfn=$fn;
+
+ my $docroot=$r->dir_config('lonDocRoot'); # Apache londocument root.
+ if ($thisdisfn eq "$docroot/priv/$udom") {
+ if ((-d "/home/$uname/public_html/") && (!-e "$docroot/priv/$udom/$uname")) {
+ my ($version) = ($r->dir_config('lonVersion') =~ /^\'?(\d+\.\d+)\./);
+ &Apache::loncommon::content_type($r,'text/html');
+ $r->send_http_header;
+
+ &Apache::lonhtmlcommon::clear_breadcrumbs();
+ $r->print(&Apache::loncommon::start_page('Authoring Space').
+ '
'.
+ '
'.
+ &mt('Your Authoring Space is currently in the location used by LON-CAPA version 2.10 and older, but your domain is using a newer LON-CAPA version ([_1]).',$version).'
'.
+ '
'.
+ &mt('Please ask your Domain Coordinator to move your Authoring Space to the new location.').
+ '
'.
+ '
'.
+ &Apache::loncommon::end_page());
+ return OK;
+ }
+ }
+ $thisdisfn=~s/^\Q$docroot\E\/priv//;
- # Validate access to the construction space and get username@domain.
+ my $resdir=$docroot.'/res'.$thisdisfn; # Resource directory
+ my $targetdir='/res'.$thisdisfn; # Publication target directory.
+ my $linkdir='/priv'.$thisdisfn; # Full URL name of constr space.
+
+ my %bombs=&Apache::lonmsg::all_url_author_res_msg($uname,$udom);
+
+ my $londocroot = $Apache::lonnet::perlvar{'lonDocRoot'};
+ my $current_disk_usage = &Apache::lonnet::diskusage($udom,$uname,
+ "$londocroot/priv/$udom/$uname"); # expressed in kB
+ my $disk_quota = &Apache::loncommon::get_user_quota($uname,$udom,
+ 'author'); # expressed in MB
+
+ # Put out the start of page.
+ &startpage($r, $uname, $udom, $thisdisfn, $current_disk_usage, $disk_quota);
+
+ if (!-d $fn) {
+ if (-e $fn) {
+ $r->print('
'.&mt('Requested item is a file not a directory.').'
');
+ } else {
+ $r->print('
'.&mt('The requested subdirectory does not exist.').'
');
+ }
+ $r->print(&Apache::loncommon::start_data_table()
+ .&Apache::loncommon::start_data_table_header_row() . $output
+ .&Apache::loncommon::end_data_table_header_row()
+ );
+
+ my $dirptr=16384; # Mask indicating a directory in stat.cmode.
+ my $filehash = {};
+ foreach my $filename (@files) {
+ # Skip .DS_Store, .DAV and hidden files
+ my ($extension) = ($filename=~/\.(\w+)$/);
+ next if (($filename eq '.DS_Store')
+ || ($filename eq '.DAV')
+ || (&Apache::loncommon::fileembstyle($extension) eq 'hdn')
+ || ($filename =~ /^\._/));
+
+ my ($cmode,$csize,$cmtime)=(stat($fn.'/'.$filename))[2,7,9];
+ my $linkfilename = &HTML::Entities::encode('/priv'.$thisdisfn.'/'.$filename,'<>&"');
+ # Identify type of file according to icon used
+ my ($filetype) = (&Apache::loncommon::icon($filename) =~ m{/(\w+).gif$});
+ my $cstr_dir = $r->dir_config('lonDocRoot').'/priv'.$thisdisfn;
+ my $meta_same = &isMetaSame($cstr_dir, $resdir, $filename);
+
+ # Store size, title, and status for files but not directories
+ my $size = (!($cmode&$dirptr)) ? $csize/1024. : 0;
+ my ($status, $pubstatus, $title, $fulltitle);
+ if (!($cmode&$dirptr)) {
+ ($status, $pubstatus) = &getStatus($resdir, $targetdir, $cstr_dir,
+ $filename, $linkfilename, $cmtime, $meta_same);
+ ($fulltitle, $title) = &getTitle($resdir, $targetdir, $filename,
+ $linkfilename, $meta_same, \%bombs);
+ } else {
+ ($status, $pubstatus) = ('','');
+ ($fulltitle, $title) = ('','');
+ }
- $fn=~s/\/$//;
+ # This hash will allow sorting
+ $filehash->{ $filename } = {
+ "cmtime" => $cmtime,
+ "size" => $size,
+ "cmode" => $cmode,
+ "filetype" => $filetype,
+ "title" => $title,
+ "fulltitle" => $fulltitle,
+ "status" => $status,
+ "pubstatus" => $pubstatus,
+ "linkfilename" => $linkfilename,
+ }
+ }
+
+ my @sorted_files;
+ # Sorting by something other than "Name". Name is the secondary key.
+ if ($sortby =~ m{cmtime|size}) { # Numeric fields
+ # First check if order should be reversed
+ if ($sortorder eq "rev") {
+ @sorted_files = sort {
+ $filehash->{$a}->{$sortby} <=> $filehash->{$b}->{$sortby}
+ or
+ uc($a) cmp uc($b)
+ } (keys(%{$filehash}));
+ } else {
+ @sorted_files = sort {
+ $filehash->{$b}->{$sortby} <=> $filehash->{$a}->{$sortby}
+ or
+ uc($a) cmp uc($b)
+ } (keys(%{$filehash}));
+ }
+ } elsif ($sortby =~ m{filetype|title|status}) { # String fields
+ if ($sortorder eq "rev") {
+ @sorted_files = sort {
+ $filehash->{$b}->{$sortby} cmp $filehash->{$a}->{$sortby}
+ or
+ uc($a) cmp uc($b)
+ } (keys(%{$filehash}));
+ } else {
+ @sorted_files = sort {
+ $filehash->{$a}->{$sortby} cmp $filehash->{$b}->{$sortby}
+ or
+ uc($a) cmp uc($b)
+ } (keys(%{$filehash}));
+ }
- unless ($fn) {
- $r->log_reason($env{'user.name'}.' at '.$env{'user.domain'}.
- ' trying to list empty directory', $r->filename);
- return HTTP_NOT_FOUND;
- }
+ # Sort by "Name" is the default
+ } else {
+ if ($sortorder eq "rev") {
+ @sorted_files = sort {uc($b) cmp uc($a)} (keys(%{$filehash}));
+ } else {
+ @sorted_files = sort {uc($a) cmp uc($b)} (keys(%{$filehash}));
+ }
+ }
-# ----------------------------------------------------------- Start page output
+ # Print the sorted resources
+ my %editors = &Apache::loncommon::permitted_editors();
+ foreach my $filename (@sorted_files) {
+ if ($filehash->{$filename}->{"cmode"}&$dirptr) { # Directories
+ &putdirectory($r, $thisdisfn, $linkdir, $filename,
+ $filehash->{$filename}->{"cmtime"},
+ $targetdir, \%bombs, \$numdir);
+ } else { # Files
+ &putresource($r, $udom, $uname, $filename, $thisdisfn, $resdir,
+ $targetdir, $linkdir, $filehash->{$filename}->{"cmtime"},
+ $filehash->{$filename}->{"size"}, \$numres,
+ $filehash->{$filename}->{"linkfilename"},
+ $filehash->{$filename}->{"fulltitle"},
+ $filehash->{$filename}->{"status"},
+ $filehash->{$filename}->{"pubstatus"},
+ \%editors);
+ }
+ }
- 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.
+ $r->print( &Apache::loncommon::end_data_table()
+ .&Apache::loncommon::end_page() );
- my $numdir = 0;
- my $numres = 0;
-
- # Start off the directory table.
- $r->print('
Directory Contents:
');
- $r->print('
'.
- '
'.&mt('Type').'
'.
- '
'.&mt('Actions').'
'.
- '
'.&mt('Name').'
'.
- '
'.&mt('Title').'
'.
- '
'.&mt('Status').'
'.
- '
'.&mt('Last Modified').
- '
'."\n");
-
- 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_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/^http\:\/\/[^\/]+\///;
- $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;
+ return OK;
}
-#
+
+
+
# Output the header of the page. This includes:
# - The HTML header
# - The H1/H3 stuff which includes the directory.
#
-# startpage($r, $uame, $udom, $thisdisfn);
+# startpage($r, $uame, $udom, $thisdisfn, $current_disk_usage, $disk_quota);
# $r - The apache request object.
# $uname - User name.
# $udom - Domain name the user is logged in under.
# $thisdisfn - Displayable version of the filename.
+# $current_disk_usage - User's current disk usage (in kB).
+# $disk_quota - Disk quota for user's authoring space (in MB).
+# $crstype - Course type, if this is for "course author"
sub startpage {
- my ($r, $uname, $udom, $thisdisfn) = @_;
- my $currdir = '/priv/'.$uname.$thisdisfn;
+ my ($r, $uname, $udom, $thisdisfn, $current_disk_usage, $disk_quota) = @_;
&Apache::loncommon::content_type($r,'text/html');
$r->send_http_header;
- my $formaction='/priv/'.$uname.$thisdisfn.'/';
+ my $formaction='/priv'.$thisdisfn.'/';
$formaction=~s|/+|/|g;
- my $pagetitle .= &Apache::loncommon::help_open_menu('','',3,'Authoring').
- 'Construction Space: '.
- '';
&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,
- {'body_title' =>
- $pagetitle,}));
- } else {
- $r->print(&Apache::loncommon::start_page('Construction Space',undef,
- { 'only_body' => 1,}));
- $r->print($pagetitle);
- }
+
+ &Apache::lonhtmlcommon::clear_breadcrumbs();
+ &Apache::lonhtmlcommon::add_breadcrumb({
+ 'text' => 'Authoring Space',
+ 'href' => &Apache::loncommon::authorspace($formaction),
+ });
+ # breadcrumbs (and tools) will be created
+ # in start_page->bodytag->innerregister
+
+ $env{'request.noversionuri'}=$formaction;
+ $r->print(&Apache::loncommon::start_page('Authoring Space'));
+
+ my $londocroot = $Apache::lonnet::perlvar{'lonDocRoot'};
+ my $current_disk_usage = &Apache::lonnet::diskusage($udom,$uname,"$londocroot/priv/$udom/$uname");
+ my $disk_quota = &Apache::loncommon::get_user_quota($uname,$udom,'author'); #expressed in MB
+ $disk_quota = 1024 * $disk_quota; # convert from MB to kB
+
+ $r->print(&Apache::loncommon::head_subbox(
+ '
'
+ .&Apache::loncommon::CSTR_pageheader()));
my $esc_thisdisfn = &Apache::loncommon::escape_single($thisdisfn);
+ my $doctitle = 'LON-CAPA '.&mt('Authoring Space');
+ my $newname = &mt('New Name');
my $pubdirscript=(<
-top.document.title = '$esc_thisdisfn/ - LON-CAPA Construction Space';
+top.document.title = '$esc_thisdisfn/ - $doctitle';
// Store directory location for menu bar to find
-parent.lastknownpriv='/~$uname$esc_thisdisfn/';
+parent.lastknownpriv='/priv$esc_thisdisfn/';
// Confirmation dialogues
@@ -231,7 +378,7 @@ parent.lastknownpriv='/~$uname$esc_thisd
document.publishdir.filename.value = theform.filename.value;
document.publishdir.submit();
}
- if (theform.dirtask.options[theform.dirtask.selectedIndex].value == 'editcat') {
+ 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' ) {
@@ -261,7 +408,7 @@ parent.lastknownpriv='/~$uname$esc_thisd
if (theform.diraction.options[theform.diraction.selectedIndex].value == "publish") {
theform.submit();
}
- if (theform.diraction.options[theform.diraction.selectedIndex].value == "editcat") {
+ 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") {
@@ -313,7 +460,7 @@ parent.lastknownpriv='/~$uname$esc_thisd
}
function changename(theform,activity) {
var oldname=theform.dispfilename.value;
- var newname=prompt('New Name',oldname);
+ var newname=prompt('$newname',oldname);
if (newname == "" || !newname || newname == oldname) {
return
}
@@ -325,16 +472,10 @@ parent.lastknownpriv='/~$uname$esc_thisd
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').': '.$uname.' at '.$udom.
- '
');
- }
}
sub dircontrols {
- my ($r,$uname,$udom,$thisdisfn) = @_;
+ my ($r,$uname,$udom,$thisdisfn, $current_disk_usage, $disk_quota) = @_;
my %lt=&Apache::lonlocal::texthash(
cnpd => 'Cannot publish directory',
cnrd => 'Cannot retrieve directory',
@@ -346,7 +487,7 @@ sub dircontrols {
list => 'List Directory',
uplo => 'Upload file',
dele => 'Delete',
- edit => 'Edit Catalog Information',
+ edit => 'Edit Metadata',
sela => 'Select Action',
nfil => 'New file',
nhtm => 'New HTML file',
@@ -362,105 +503,168 @@ sub dircontrols {
move => 'Move current file to',
copy => 'Copy current file to',
type => 'Type Name Here',
- go => 'Go',
+ 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'
+ updc => 'Upload a new document',
+ pick => 'Please select an action to perform using the new filename',
+ shcu => 'Shortcuts',
);
+ my %js_lt = &Apache::lonlocal::texthash(
+ nanf => 'Name of New File',
+ nans => 'Name of New Subdirectory',
+ psfn => 'Please specify file name',
+ );
+ &js_escape(\%js_lt);
+ my $mytype = $lt{'type'}; # avoid conflict with " and ' in javascript
+ # Calculate free space in bytes.
+ # $disk_quota is in MB and $current_disk_usage is in kB
+ my $free_space = 1024 * ((1024 * $disk_quota) - $current_disk_usage);
$r->print(<
-
-
$lt{'acti'}
-
$lt{'updc'}
-
$lt{'crea'}
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
-
-
+
+
+
+
END
}
-sub pubbuttons {
- my ($r,$uname,$thisdisfn) = @_;
- $r->print('
'.
- '
'.
- '
'.
-'
');
-}
-
sub resourceactions {
my ($r,$uname,$udom,$thisdisfn) = @_;
$r->print(<
+
-
+
-
+
-
+
-
+
-
+
END
@@ -496,51 +700,58 @@ sub getSourceRightString {
}
#
# 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.
-#
+# putdirectory(r, base, here, dirname, modtime, targetdir, bombs, numdir)
+# 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.
+# targetdir - Publication target directory.
+# bombs - Reference to hash of URLs with runtime error messages.
+# numdir - Reference to scalar used to track number of sub-directories
+# in directory (used in form name for each "actions" dropdown).
+#
sub putdirectory {
- my ($r, $reqfile, $here, $dirname, $modtime, $resdir, $bombs, $numdir) = @_;
- # construct the display filename: the directory name unless ..:
-
+ my ($r, $reqfile, $here, $dirname, $modtime, $targetdir, $bombs, $numdir) = @_;
+
+# construct the display filename: the directory name unless ..:
+
+ my $actionitem;
+
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; }
- }
+# Don't display directory itself, and there is no way up from root directory
+ unless ((($dirname eq '..') && ($reqfile=~/^\/[^\/]+\/[^\/]+$/)) || ($dirname eq '.')) {
+ my $kaputt=0;
+ if (ref($bombs) eq 'HASH') {
+ foreach my $key (keys(%{$bombs})) {
+ my $currentdir = &Apache::lonnet::declutter("$targetdir/$disfilename");
+ if (($key) =~ m{^\Q$currentdir\E/}) { $kaputt=1; last; }
+ }
+ }
+#
+# Get the metadata from that directory's default.meta to display titles
+#
%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 = '';
+ &Apache::lonpublisher::metaeval(
+ &Apache::lonnet::getfile($r->dir_config('lonDocRoot').$here.'/'.$dirname.'/default.meta')
+ );
if ($dirname eq '..') {
- $actionitem = 'Go to ...';
+ $actionitem = &mt('Go to ...');
+ $disfilename = ''.&mt('Parent Directory').'';
} else {
$actionitem =
'
'.
+ &Apache::loncommon::end_data_table_row()
+ );
+ return;
}
sub create_pubselect {
@@ -716,8 +964,8 @@ sub create_pubselect {
''.
''.
'
-
+
';
$$numres ++;
@@ -739,47 +987,23 @@ sub check_for_versions {
$versions ++;
}
}
+ closedir(DIR);
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
+Apache::lonpubdir - Authoring space directory lister
=head1 SYNOPSIS
Invoked (for various locations) by /etc/httpd/conf/srm.conf:
-
+
PerlAccessHandler Apache::loncacc
SetHandler perl-script
PerlHandler Apache::lonpubdir
@@ -826,4 +1050,47 @@ run through list of files and attempt to
=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, $targetdir, $bombs,
+ $numdir)
+
+ Put out a directory table row:
+
+ $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.
+ targetdir - Publication target directory.
+ bombs - Reference to hash of URLs with runtime error messages.
+ numdir - Reference to scalar used to track number of sub-directories
+ in directory (used in form name for each "actions" dropdown).
+
+=back
+
=cut