--- loncom/publisher/lonpubdir.pm 2007/01/10 19:51:35 1.99
+++ loncom/publisher/lonpubdir.pm 2015/06/18 20:19:27 1.164
@@ -1,7 +1,7 @@
# The LearningOnline Network with CAPA
-# Construction Space Directory Lister
+# Authoring Space Directory Lister
#
-# $Id: lonpubdir.pm,v 1.99 2007/01/10 19:51:35 albertel Exp $
+# $Id: lonpubdir.pm,v 1.164 2015/06/18 20:19:27 musolffc 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,186 +40,354 @@ 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);
-
- # Validate access to the construction space and get username@domain.
-
- my $uname;
- my $udom;
+ 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();
+ my $js = '';
+ $r->print(&Apache::loncommon::start_page('Authoring Space', $js).
+ '
'.
+ '
'.
+ &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//;
+
+ 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.').'
'
+ .&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;
-}
-#
+
+
+
# 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).
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));
- $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;
+ my $js = '';
+ $r->print(&Apache::loncommon::start_page('Authoring Space', $js));
+
+ $disk_quota = 1024 * $disk_quota; # convert from MB to kB
+
+ $r->print(&Apache::loncommon::head_subbox(
+ '
'.
+ &Apache::loncommon::end_data_table_row()
+ );
+ return;
}
sub create_pubselect {
@@ -713,8 +969,8 @@ sub create_pubselect {
''.
''.
'
-
+
';
$$numres ++;
@@ -736,47 +992,151 @@ 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;
+sub prepareJsonTranslations {
+ my $json =
+ '{"translations":{'.
+ '"edit":"'.&mt('Edit').'",'.
+ '"editxml":"'.&mt('EditXML').'",'.
+ '"editmeta":"'.&mt('Edit Metadata').'",'.
+ '"obsolete":"'.&mt('Obsolete').'",'.
+ '"modified":"'.&mt('Modified').'",'.
+ '"published":"'.&mt('Published').'",'.
+ '"unpublished":"'.&mt('Unpublished').'",'.
+ '"diff":"'.&mt('Diff').'",'.
+ '"retrieve":"'.&mt('Retrieve').'",'.
+ '"directory":"'.&mt('Directory').'",'.
+ '"results":"'.&mt('Show results for keyword:').'"'.
+ '}}';
+}
+
+# gathers all files in the working directory except the ones that are already on screen
+sub prepareJsonData {
+ my ($uname, $udom, $pathToSkip) = @_;
+ my $path = "/home/httpd/html/priv/$udom/$uname/";
+
+ # maximum number of entries, to limit workload and required storage space
+ my $entries = 100;
+ my $firstfile = 1;
+ my $firstdir = 1;
+
+ my $json = '{"resources":[';
+ $json .= &prepareJsonData_rec($path, \$entries, \$firstfile, \$firstdir, $pathToSkip);
+ $json .= ']}';
+
+ # if the json string is invalid the whole search breaks.
+ # so we want to make sure that the string is valid in any case.
+ $json =~ s/,\s*,/,/g;
+ $json =~ s/\}\s*\{/\},\{/g;
+ $json =~ s/\}\s*,\s*\]/\}\]/g;
+ return $json;
}
+# recursive part of json file gathering
+sub prepareJsonData_rec {
+ my ($path, $entries, $firstfile, $firstdir, $pathToSkip) = @_;
+ my $json;
+ my $skipThisFolder = $path =~ m/$pathToSkip\/$/?1:0;
+
+ my @dirs;
+ my @resources;
+ my @ignored = qw(bak log meta save . ..);
+
+# Phase 1: Gathering
+ opendir(DIR,$path);
+ my @files=sort {uc($a) cmp uc($b)} (readdir(DIR));
+ foreach my $filename (@files) {
+ next if ($filename eq '.DS_Store');
+
+ # gather all resources
+ if ($filename !~ /\./) {
+ # its a folder
+ push(@dirs, $filename);
+ } else {
+ # only push files we dont want to ignore
+ next if ($skipThisFolder);
+
+ $filename =~ /\.(\w+?)$/;
+ unless (grep /$1/, @ignored) {
+ push(@resources, $filename);
+ }
+ }
+ }
+ closedir(DIR);
+ # nothing to do here if both lists are empty
+ return unless ( @dirs || @resources );
+
+# Phase 2: Working
+ $$firstfile = 1;
+
+ foreach (@dirs) {
+ $json .= '{"name":"'.$_.'",'.
+ '"path":"'.$path.$_.'",'.
+ '"title":"",'.
+ '"status":"",'.
+ '"cmtime":""},';
+ }
+
+ foreach (@resources) {
+ last if ($$entries < 1);
+ my $title = &getTitleString($path.$_);
+
+ my $privpath = $path.$_;
+ my $respath = $privpath;
+ $respath =~ s/httpd\/html\/priv\//httpd\/html\/res\//;
+
+ my $cmtime = (stat($privpath))[9];
+ my $rmtime = (stat($respath))[9];
+
+ unless ($$firstfile) { $json .= ','; } else { $$firstfile = 0; }
+
+ my $status = 'unpublished';
+
+ # if a resource is published, the published version (/html/res/filepath) gets its own modification time
+ # this is newer or equal then the version in your authoring space (/html/priv/filepath)
+ if ($rmtime >= $cmtime) {
+ # obsolete
+ if (&Apache::lonnet::metadata($respath, 'obsolete')) {
+ $status = 'obsolete';
+ }else{
+ $status = 'published';
+ }
+ } else {
+ $status = 'modified';
+ }
+
+ $json .= '{"name":"'.$_.'",'.
+ '"path":"'.$path.'",'.
+ '"title":"'.$title.'",'.
+ '"status":"'.$status.'",'.
+ '"cmtime":"'.&Apache::lonlocal::locallocaltime($cmtime).'"}';
+ $$entries--;
+ }
+
+ foreach(@dirs) {
+ next if ($$entries < 1);
+ $json .= ',';
+ $json .= &prepareJsonData_rec
+ ($path.$_.'/', $entries, $firstfile, $firstdir, $pathToSkip);
+ }
+ return $json;
+}
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
@@ -823,4 +1183,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