--- loncom/publisher/lonpubdir.pm 2011/11/14 00:20:31 1.137
+++ loncom/publisher/lonpubdir.pm 2015/01/19 15:36:11 1.163
@@ -1,7 +1,7 @@
# The LearningOnline Network with CAPA
-# Construction Space Directory Lister
+# Authoring Space Directory Lister
#
-# $Id: lonpubdir.pm,v 1.137 2011/11/14 00:20:31 raeburn Exp $
+# $Id: lonpubdir.pm,v 1.163 2015/01/19 15:36:11 goltermann 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,88 +40,294 @@ 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;
- # Validate access to the construction space and get username@domain.
+ # Validate access to the construction space and get username:domain.
- my $uname;
- my $udom;
-
- ($uname,$udom)=&Apache::loncacc::constructaccess($r->uri);
- unless (($uname) && ($udom)) {
- return HTTP_NOT_ACCEPTABLE;
- }
+ my ($uname,$udom)=&Apache::lonnet::constructaccess($r->uri);
+ unless (($uname) && ($udom)) {
+ return HTTP_NOT_ACCEPTABLE;
+ }
# ----------------------------------------------------------- Start page output
- my $fn=$r->filename;
- $fn=~s/\/$//;
+ 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//;
+
+ 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);
+
+ &startpage($r, $uname, $udom, $thisdisfn); # Put out the start of page.
+
+ 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::end_page());
+ return OK;
+ }
- my $thisdisfn=$fn;
- my $docroot=$r->dir_config('lonDocRoot'); # Apache londocument root.
- $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);
-
- &startpage($r, $uname, $udom, $thisdisfn); # Put out the start of page.
- &dircontrols($r,$uname,$udom,$thisdisfn); # Put out actions for directory,
- # browse/upload + new file page.
- &resourceactions($r,$uname,$udom,$thisdisfn); #Put out form used for printing/deletion etc.
+ &dircontrols($r,$uname,$udom,$thisdisfn); # Put out actions for directory,
+ # browse/upload + new file page.
+ &resourceactions($r,$uname,$udom,$thisdisfn); # Put out form used for printing/deletion etc.
- my $numdir = 0;
- my $numres = 0;
+ 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()
+ if ((@files == 0) && ($thisdisfn =~ m{^/$match_domain/$match_username})) {
+ if ($thisdisfn =~ m{^/$match_domain/$match_username$}) {
+ $r->print('
'.&mt('This Authoring Space is currently empty.').'
');
+ } else {
+ $r->print('
'.&mt('This subdirectory is currently empty.').'
');
+ }
+ $r->print(&Apache::loncommon::end_page());
+ return OK;
+ }
+
+ # Retrieving value for "sortby" and "sortorder" from QUERY_STRING
+ &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},
+ ['sortby','sortorder']);
+
+ # Sort by name as default, not reversed
+ if (! exists($env{'form.sortby'})) { $env{'form.sortby'} = 'filename' }
+ if (! exists($env{'form.sortorder'})) { $env{'form.sortorder'} = '' }
+ my $sortby = $env{'form.sortby'};
+ my $sortorder = $env{'form.sortorder'};
+
+ # Order in which columns are displayed from left to right
+ my @order = ('filetype','actions','filename','title',
+ 'pubstatus','cmtime','size');
+
+ # Up and down arrows to indicate sort order
+ my @arrows = (' ▲',' ▼','');
+
+ # Default sort order and column title
+ my %columns = (
+ filetype => {
+ order => 'ascending',
+ text => &mt('Type'),
+ },
+ actions => {
+ # Not sortable
+ text => &mt('Actions'),
+ },
+ filename => {
+ order => 'ascending',
+ text => &mt('Name'),
+ },
+ title => {
+ order => 'ascending',
+ text => &mt('Title'),
+ },
+ pubstatus => {
+ order => 'ascending',
+ text => &mt('Status'),
+ colspan => '2',
+ },
+ cmtime => {
+ order => 'descending',
+ text => &mt('Last Modified'),
+ },
+ size => {
+ order => 'ascending',
+ text => &mt('Size').' (kB)',
+ },
+ );
+
+ # Print column headers
+ my $output = '';
+ foreach my $key (@order) {
+ my $idx;
+ # Append an up or down arrow to sorted column
+ if ($sortby eq $key) {
+ $idx = ($columns{$key}{order} eq 'ascending') ? 0:1;
+ if ($sortorder eq 'rev') { $idx ++; }
+ $idx = $idx%2;
+ } else { $idx = 2; } # No arrow if column is not sorted
+ $output .= (($columns{$key}{order}) ?
+ '
'
+ .&Apache::loncommon::CSTR_pageheader()));
my $esc_thisdisfn = &Apache::loncommon::escape_single($thisdisfn);
- my $doctitle = 'LON-CAPA '.&mt('Construction Space');
+ my $doctitle = 'LON-CAPA '.&mt('Authoring Space');
my $newname = &mt('New Name');
my $pubdirscript=(<
@@ -301,12 +514,15 @@ sub dircontrols {
go => 'Go',
prnt => 'Print contents of directory',
crea => 'Create a new directory or LON-CAPA document',
+ qs => 'Quick Search',
+ cs => 'Case Sensitive',
+ re => 'Regular Expression',
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(<printf(<
+
+
+
END
@@ -458,11 +723,12 @@ sub putdirectory {
my $disfilename = $dirname;
# Don't display directory itself, and there is no way up from root directory
unless ((($dirname eq '..') && ($reqfile=~/^\/[^\/]+\/[^\/]+$/)) || ($dirname eq '.')) {
- my $kaputt=0;
+ my $kaputt=0;
if (ref($bombs) eq 'HASH') {
- foreach my $key (keys(%{$bombs})) {
- if ($key =~ m{^\Q$targetdir/$disfilename\E/}) { $kaputt=1; last; }
- }
+ 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
@@ -507,51 +773,71 @@ sub putdirectory {
}
$r->print($Apache::lonpublisher::metadatafields{'keywords'}.''.
'
'.&Apache::lonlocal::locallocaltime($modtime).'
'.
+ '
'.
"\n");
}
- return OK;
+ return;
}
-#
-# Put a table row for a file resource.
-#
-sub putresource {
- my ($r, $udom, $uname, $filename, $thisdisfn,
- $resdir, $targetdir, $linkdir,
- $cmtime,$bombs,$numres) = @_;
- &Apache::lonnet::devalidate_cache_new('meta',$targetdir.'/'.$filename);
+
+sub getTitle {
+ my ($resdir, $targetdir, $filename, $linkfilename, $meta_same, $bombs) = @_;
+ my $title='';
+ my $titleString = &getTitleString($targetdir.'/'.$filename);
+ if (-e $resdir.'/'.$filename) {
+ $title = ''.$titleString.'';
+ if (!$meta_same) {
+ $title = &mt('Metadata Modified').' '.$title.
+ ' '.
+ &Apache::loncommon::modal_link(
+ '/adm/diff?filename='.$linkfilename.'.meta'.'&versiontwo=priv',
+ &mt('Metadata Diffs'),600,500);
+ $title.="\n".' '.
+ &Apache::loncommon::modal_link(
+ '/adm/retrieve?filename='.$linkfilename.'.meta&inhibitmenu=yes&add_modal=yes',
+ &mt('Retrieve Metadata'),600,500);
+ }
+ }
+ # Allow editing metadata of published and unpublished resources
+ $title .= "\n".' ' if ($title);
+ $title .= ''.
+ ($$bombs{&Apache::lonnet::declutter($targetdir.'/'.$filename)}?
+ '':
+ &mt('Edit Metadata')).
+ '';
+
+ return ($title, $titleString);
+}
+
+
+sub isMetaSame {
+ my ($cstr_dir, $resdir, $filename) = @_;
+ my $meta_cmtime = (stat($cstr_dir.'/'.$filename.'.meta'))[9];
+ my $meta_rmtime = (stat($resdir.'/'.$filename.'.meta'))[9];
+ return (&Apache::londiff::are_different_files($resdir.'/'.$filename.'.meta',
+ $cstr_dir.'/'.$filename.'.meta') && $meta_rmtime < $meta_cmtime)
+ ? 0 : 1;
+}
+
+
+sub getStatus {
+ my ($resdir, $targetdir, $cstr_dir, $filename,
+ $linkfilename, $cmtime, $meta_same) = @_;
my $pubstatus = 'unpublished';
- my $status=&mt('Unpublished');
- my $css_class='LC_browser_file';
- my $title=' ';
- my $publish_button=&mt('Publish');
- my $cstr_dir = $r->dir_config('lonDocRoot').'/priv/'.$udom.'/'.$uname.'/'.$thisdisfn.'/';
- my $linkfilename=&HTML::Entities::encode('/priv'.$thisdisfn.'/'.$filename,'<>&"');
+ my $status = &mt('Unpublished');
if (-e $resdir.'/'.$filename) {
- my $same=0;
- my ($rdev,$rino,$rmode,$rnlink,
- $ruid,$rgid,$rrdev,$rsize,
- $ratime,$rmtime,$rctime,
- $rblksize,$rblocks)=stat($resdir.'/'.$filename);
- if ($rmtime>=$cmtime) {
- $same=1;
+ my $same = 0;
+ if ((stat($resdir.'/'.$filename))[9] >= $cmtime) {
+ $same = 1;
} else {
if (&Apache::londiff::are_different_files($resdir.'/'.$filename,
$cstr_dir.'/'.$filename)) {
- $same=0;
+ $same = 0;
} else {
- $same=1;
+ $same = 1;
}
}
- my $meta_cmtime = (stat($cstr_dir.'/'.$filename.'.meta'))[9];
- my $meta_rmtime = (stat($resdir.'/'.$filename.'.meta'))[9];
- my $meta_same = 1;
- if ($meta_rmtime < $meta_cmtime
- && &Apache::londiff::are_different_files($resdir.'/'.$filename.'.meta',
- $cstr_dir.'/'.$filename.'.meta')) {
- $meta_same = 0;
- }
- $publish_button=&mt('Re-publish');
my $rights_status =
&mt(&getCopyRightString($targetdir.'/'.$filename)).', ';
@@ -563,9 +849,6 @@ sub putresource {
$rights_status .=
$lt_SourceRight{&getSourceRightString($targetdir.'/'.$filename)};
- $title = ''.
- &getTitleString($targetdir.'/'.$filename).'';
if ($same) {
if (&Apache::lonnet::metadata($targetdir.'/'.$filename,'obsolete')) {
$pubstatus = 'obsolete';
@@ -584,30 +867,39 @@ sub putresource {
$status=&mt('Modified').
' '. $rights_status;
if (&Apache::loncommon::fileembstyle(($filename=~/\.(\w+)$/)) eq 'ssi') {
- $status.=' '.&mt('Diffs').'';
+ $status.=' '.
+ &Apache::loncommon::modal_link(
+ '/adm/diff?filename='.$linkfilename.'&versiontwo=priv',
+ &mt('Diffs'),600,500);
}
}
- $title.="\n".' '.
- ($$bombs{$targetdir.'/'.$filename}?'':&mt('Edit Metadata')).'';
-
- if (!$meta_same) {
- $title = &mt('Metadata Modified').' '.$title.
- ' '.&mt('Metadata Diffs').'';
- $title.="\n".' '.&mt('Retrieve Metadata').'';
- }
- $status.="\n".' '.&mt('Retrieve').'';
+ $status.="\n".' '.
+ &Apache::loncommon::modal_link(
+ '/adm/retrieve?filename='.$linkfilename.'&inhibitmenu=yes&add_modal=yes',&mt('Retrieve'),600,500);
}
+
+ return ($status, $pubstatus);
+}
+
+
+#
+# Put a table row for a file resource.
+#
+sub putresource {
+ my ($r, $udom, $uname, $filename, $thisdisfn, $resdir, $targetdir,
+ $linkdir, $cmtime, $size, $numres, $linkfilename, $title,
+ $status, $pubstatus) = @_;
+ &Apache::lonnet::devalidate_cache_new('meta',$targetdir.'/'.$filename);
+
my $editlink='';
my $editlink2='';
if ($filename=~/\.(xml|html|htm|xhtml|xhtm|sty)$/) {
- $editlink=' ('.&mt('Edit').')';
+ $editlink=' ('.&mt('Edit').')';
}
if ($filename=~/$LONCAPA::assess_re/) {
- $editlink=' ('.&mt('EditXML').')';
- $editlink2=' ('.&mt('Edit').')';
+ $editlink=' ('.&mt('EditXML').')';
+ $editlink2=' ('.&mt('Edit').')';
}
if ($filename=~/\.(problem|exam|quiz|assess|survey|form|library|xml|html|htm|xhtml|xhtm|sty)$/) {
$editlink.=' ('.&mt('Clean Up').')';
@@ -615,6 +907,7 @@ sub putresource {
if ($filename=~/\.(zip|tar|bz2|gz|tar.gz|tar.bz2|tgz)$/) {
$editlink=' ('.&mt('Decompress').')';
}
+ my $publish_button = (-e $resdir.'/'.$filename) ? &mt('Re-publish') : &mt('Publish');
my $pub_select = '';
&create_pubselect($r,\$pub_select,$udom,$uname,$thisdisfn,$filename,$resdir,$pubstatus,$publish_button,$numres);
$r->print(&Apache::loncommon::start_data_table_row().
@@ -629,9 +922,10 @@ sub putresource {
'
'. # Display publication status
'
'.$status.'
'.
'
'.&Apache::lonlocal::locallocaltime($cmtime).'
'.
+ '
'.sprintf("%.1f",$size).'
'.
&Apache::loncommon::end_data_table_row()
);
- return OK;
+ return;
}
sub create_pubselect {
@@ -684,16 +978,145 @@ sub check_for_versions {
$versions ++;
}
}
+ closedir(DIR);
return $versions;
}
+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
@@ -790,4 +1213,3 @@ Output the header of the page. This inc
=back
=cut
-