--- loncom/publisher/lonpubdir.pm 2011/10/21 22:33:14 1.129 +++ loncom/publisher/lonpubdir.pm 2024/08/22 18:32:56 1.160.2.5.2.5 @@ -1,7 +1,7 @@ # The LearningOnline Network with CAPA -# Construction Space Directory Lister +# Authoring Space Directory Lister # -# $Id: lonpubdir.pm,v 1.129 2011/10/21 22:33:14 www Exp $ +# $Id: lonpubdir.pm,v 1.160.2.5.2.5 2024/08/22 18:32:56 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,152 +40,341 @@ 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); + + 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::end_page()); + return OK; + } + my @files; + if (opendir(DIR,$fn)) { + @files = grep(!/^\.+$/,readdir(DIR)); + closedir(DIR); + } else { + $r->print('

'.&mt('Could not open directory.').'

'); + $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. + # Put out actions for directory, browse/upload + new file page. + &dircontrols($r,$uname,$udom,$thisdisfn, $current_disk_usage, $disk_quota); + &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() - .''.&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; + 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}) ? + '' + .$columns{$key}{text}.$arrows[$idx].'' : + ''.$columns{$key}{text}.''); + } + $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) = ('',''); + } + + # 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})); + } + + # 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})); + } + } + + # 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); + } + } + + $r->print( &Apache::loncommon::end_data_table() + .&Apache::loncommon::end_page() ); + + 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 ($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; &Apache::lonhtmlcommon::store_recent('construct',$formaction,$formaction); &Apache::lonhtmlcommon::clear_breadcrumbs(); &Apache::lonhtmlcommon::add_breadcrumb({ - 'text' => 'Construction Space', - 'href' => &Apache::loncommon::authorspace(), + 'text' => 'Authoring Space', + 'href' => &Apache::loncommon::authorspace($formaction), }); # breadcrumbs (and tools) will be created # in start_page->bodytag->innerregister - $env{'request.noversionuri'}='/priv/'.$udom.'/'.$uname.$thisdisfn.'/'; - $r->print(&Apache::loncommon::start_page('Construction Space',undef)); + $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 + + my $headertext = &mt('Directory'); $r->print(&Apache::loncommon::head_subbox( - &Apache::loncommon::CSTR_pageheader(1))); + '
' + .&Apache::lonhtmlcommon::display_usage($current_disk_usage, + $disk_quota,'authoring') + .'
' + .&Apache::loncommon::CSTR_pageheader('','',$headertext))); 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=(< top.document.title = '$esc_thisdisfn/ - $doctitle'; // Store directory location for menu bar to find -parent.lastknownpriv='/priv/$udom/$uname$esc_thisdisfn/'; +parent.lastknownpriv='/priv$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") @@ -270,19 +458,16 @@ ENDPUBDIRSCRIPT } 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', 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', @@ -299,55 +484,58 @@ sub dircontrols { 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', + crea => 'Create a new subdirectory or 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("\n".'
'."\n"); + my %fileoptions = ( + none => "$lt{'sela'}:", + newfile => "$lt{'nfil'}:", + newhtmlfile => "$lt{'nhtm'}:", + newproblemfile => "$lt{'nprb'}:", + newdir => "$lt{'nsub'}:", + newpagefile => "$lt{'npag'}:", + newsequencefile => "$lt{'nseq'}:", + newrightsfile => "$lt{'ncrf'}:", + newstyfile => "$lt{'nsty'}:", + newtaskfile => "$lt{'nbt'}:", + newlibraryfile => "$lt{'nlib'}:", + ); + $fileoptions{'select_form_order'} = ['none','newfile','newhtmlfile','newproblemfile', + 'newpagefile','newsequencefile','newrightsfile', + 'newstyfile','newtaskfile','newlibraryfile','newdir']; + my $selectbox = &Apache::loncommon::select_form('none','action',\%fileoptions); $r->print(< -
-
-
- $lt{'acti'} - - -
-
-
- - -
-
- -
-
- -
-
+
+
$lt{'updc'} - - + + +
-
+
$lt{'crea'} - - + + -    - + $selectbox   +
+ $lt{'shcu'}: + + + file icon + + problem icon + + web page icon + + folder icon + + +
-
+
END } @@ -382,26 +605,26 @@ END sub resourceactions { my ($r,$uname,$udom,$thisdisfn) = @_; $r->print(< +
-
+
-
+
-
+
-
+
-
+
END @@ -437,30 +660,34 @@ 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) = @_; - -#&Apache::lonnet::logthis("reqfile $reqfile here $here dirname $dirname resdir $resdir"); - + 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 # @@ -469,14 +696,13 @@ sub putdirectory { &Apache::lonpublisher::metaeval( &Apache::lonnet::getfile($r->dir_config('lonDocRoot').$here.'/'.$dirname.'/default.meta') ); -# - my $actionitem = ''; - if ($here eq '..') { + if ($dirname eq '..') { $actionitem = &mt('Go to ...'); + $disfilename = ''.&mt('Parent Directory').''; } else { $actionitem = '
'. + '" action="/adm/publish">'. ' - +
'; $$numres ++; @@ -682,6 +947,7 @@ sub check_for_versions { $versions ++; } } + closedir(DIR); return $versions; } @@ -691,13 +957,13 @@ __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 @@ -770,18 +1036,21 @@ Output the header of the page. This inc $str = getTitleString($fullname); $fullname - Fully qualified filename to check. -=item putdirectory(r, base, here, dirname, modtime) +=item putdirectory($r, $base, $here, $dirname, $modtime, $targetdir, $bombs, + $numdir) 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. + $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 -