# 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::portfolio;
use strict;
use Apache::Constants qw(:common :http);
use Apache::loncommon;
use Apache::lonnet;
use Apache::lontexconvert;
use Apache::lonfeedback;
use Apache::lonlocal;
use Apache::lonnet;
# receives a file name and path stub from username/userfiles/portfolio/
# returns an anchor tag consisting encoding filename and currentpath
sub make_anchor {
my ($url, $filename, $current_path, $current_mode, $field_name,
$continue_select,$group) = @_;
if ($continue_select ne 'true') {$continue_select = 'false'};
my $anchor = ''.$filename.'';
return $anchor;
}
my $dirptr=16384;
sub display_common {
my ($r,$url,$current_path,$is_empty,$dir_list,$group)=@_;
my $groupitem;
my $namespace = &get_namespace($group);
my $port_path = &get_port_path($group);
if (defined($group)) {
$groupitem = '';
}
my $iconpath= $r->dir_config('lonIconsURL') . "/";
my %text=&Apache::lonlocal::texthash('upload' => 'Upload',
'upload_label' =>
'Upload file to current directory:',
'createdir' => 'Create Subdirectory',
'createdir_label' =>
'Create subdirectory in current directory:');
$r->print(<<"TABLE");
TABLE
my @tree = split (/\//,$current_path);
$r->print(''.&make_anchor($url,$port_path,'/',$env{"form.mode"},$env{"form.fieldname"},$env{"form.continue"},$group).'/');
if (@tree > 1){
my $newCurrentPath = '';
for (my $i = 1; $i< @tree; $i++){
$newCurrentPath .= $tree[$i].'/';
$r->print(&make_anchor($url,$tree[$i],'/'.$newCurrentPath, $env{"form.mode"},$env{"form.fieldname"}, $env{"form.continue"},$group).'/');
}
}
$r->print('');
&Apache::lonhtmlcommon::store_recent($namespace,$current_path,$current_path);
$r->print(' ");
}
sub display_directory {
my ($r,$url,$current_path,$is_empty,$dir_list,$group)=@_;
my $iconpath= $r->dir_config('lonIconsURL') . "/";
my ($groupitem,$groupecho);
my $display_out;
my $select_mode;
my $checked_files;
my $port_path = &get_port_path($group);
my ($uname,$udom) = &get_name_dom($group);
my $namespace = &get_namespace($group);
if (defined($group)) {
$groupitem = '';
$groupecho = '&group='.$group;
}
my %locked_files = &Apache::lonnet::get_marked_as_readonly_hash ($namespace,$udom,$uname);
if ($env{"form.mode"} eq 'selectfile'){
&select_files($r);
$checked_files =&Apache::lonnet::files_in_path($uname,$env{'form.currentpath'});
$select_mode = 'true';
}
if ($is_empty && ($current_path ne '/')) {
$display_out = '';
$r->print($display_out);
return;
}
if ($select_mode eq 'true') {
$r->print('
'.
'
Select
Name
Size
Last Modified
');
$r->print('');
} else {
$r->print('
');
}
}
sub open_form {
my ($r,$url)=@_;
my @files=&Apache::loncommon::get_env_multiple('form.selectfile');
$r->print('
');
$r->print('');
$r->print('');
foreach (@files) {
$r->print('');
}
$r->print('');
}
sub close_form {
my ($r,$url,$group)=@_;
$r->print('
');
if (defined($group)) {
$r->print("\n".'');
}
$r->print('
');
$r->print('
');
if (defined($group)) {
$r->print("\n".'');
}
$r->print("\n".'
');
}
sub display_file {
my ($path,$filename)=@_;
my $display_file_text;
if (!defined($path)) { $path=$env{'form.currentpath'}; }
if (!defined($filename)) {
$filename=$env{'form.selectfile'};
$display_file_text = ''.$path.$filename.'';
} elsif (ref($filename) eq "ARRAY") {
foreach (@$filename) {
$display_file_text .= ''.$path.$_.' ';
}
} elsif (ref($filename) eq "SCALAR") {
$display_file_text = ''.$path.$filename.'';
}
return $display_file_text;
}
sub done {
my ($message,$url,$group)=@_;
unless (defined $message) {
$message='Done';
}
my $result = '
';
return $result;
}
sub delete {
my ($r,$url,$group)=@_;
my @check;
my $file_name = $env{'form.currentpath'}.$env{'form.selectfile'};
my @files=&Apache::loncommon::get_env_multiple('form.selectfile');
my ($uname,$udom) = &get_name_dom($group);
if (&Apache::lonnet::is_locked($file_name,$udom,$uname) eq 'true') {
$r->print ("The file is locked and cannot be deleted. ");
$r->print(&done('Back',$url,$group));
} else {
if (scalar(@files)) {
&open_form($r,$url);
$r->print('
');
&close_form($r,$url,$group);
} else {
$r->print("No file was checked to delete. ");
$r->print(&done(undef,$url,$group));
}
}
}
sub delete_confirmed {
my ($r,$url,$group)=@_;
my @files=&Apache::loncommon::get_env_multiple('form.selectfile');
my $result;
my ($uname,$udom) = &get_name_dom($group);
my $port_path = &get_port_path($group);
foreach my $delete_file (@files) {
$result=&Apache::lonnet::removeuserfile($uname,$udom,$port_path.
$env{'form.currentpath'}.
$delete_file);
if ($result ne 'ok') {
$r->print(' An error occured ('.$result.
') while trying to delete '.&display_file(undef, $delete_file).' ');
}
}
$r->print(&done(undef,$url,$group));
}
sub delete_dir {
my ($r,$url,$group)=@_;
&open_form($r,$url);
$r->print('
'.&mt('Delete').' '.&display_file().'?
');
&close_form($r,$url,$group);
}
sub delete_dir_confirmed {
my ($r,$url,$group)=@_;
my $directory_name = $env{'form.currentpath'};
$directory_name =~ s|/$||; # remove any trailing slash
my ($uname,$udom) = &get_name_dom($group);
my $namespace = &get_namespace($group);
my $port_path = &get_port_path($group);
my $result=&Apache::lonnet::removeuserfile($uname,$udom,$port_path.
$directory_name);
if ($result ne 'ok') {
$r->print(' An error occured (dir) ('.$result.
') while trying to delete '.$directory_name.' ');
} else {
# now remove from recent
# $r->print(' removing '.$directory_name.' print(&done(undef,$url,$group));
}
sub rename {
my ($r,$url,$group)=@_;
my $file_name = $env{'form.currentpath'}.$env{'form.rename'};
my ($uname,$udom) = &get_name_dom($group);
if (&Apache::lonnet::is_locked($file_name,$udom,$uname) eq 'true') {
$r->print ("The file is locked and cannot be renamed. ");
$r->print(&done(undef,$url,$group));
} else {
&open_form($r,$url);
$r->print('
'.&mt('Rename').' '.&display_file().' to
?
');
&close_form($r,$url,$group);
}
}
sub rename_confirmed {
my ($r,$url,$group)=@_;
my $filenewname=&Apache::lonnet::clean_filename($env{'form.filenewname'});
my ($uname,$udom) = &get_name_dom($group);
my $port_path = &get_port_path($group);
if ($filenewname eq '') {
$r->print(''.
&mt("Error: no valid filename was provided to rename to.").
' ');
$r->print(&done(undef,$url,$group));
return;
}
my $result=
&Apache::lonnet::renameuserfile($uname,$udom,
$port_path.$env{'form.currentpath'}.$env{'form.selectfile'},
$port_path.$env{'form.currentpath'}.$filenewname);
if ($result ne 'ok') {
$r->print(' An errror occured ('.$result.
') while trying to rename '.&display_file().' to '.
&display_file(undef,$filenewname).' ');
}
if ($filenewname ne $env{'form.filenewname'}) {
$r->print("The new file name was changed from: ".$env{'form.filenewname'}." to $filenewname ");
}
$r->print(&done(undef,$url,$group));
}
sub select_files {
my ($r,$group)=@_;
if ($env{'form.continue'} eq 'true') {
# here we update the selections for the currentpath
# eventually, have to handle removing those not checked, but . . .
my @items=&Apache::loncommon::get_env_multiple('form.checkfile');
if (scalar(@items)){
&Apache::lonnet::save_selected_files($env{'user.name'}, $env{'form.currentpath'}, @items);
}
} else {
#empty the file for a fresh start
&Apache::lonnet::clear_selected_files($env{'user.name'});
}
my @files = &Apache::lonnet::files_not_in_path($env{'user.name'}, $env{'form.currentpath'});
my $java_files = join ",", @files;
if ($java_files) {
$java_files.=',';
}
my $javascript =(<
function finishSelect() {
ENDSMP
$javascript .= 'fileList = "'.$java_files.'";';
$javascript .= (<
ENDSMP
$r->print($javascript);
$r->print("
Select portfolio files
Check as many as you wish in response to the problem. ");
my @otherfiles=&Apache::lonnet::files_not_in_path($env{'user.name'}, $env{'form.currentpath'});
if (@otherfiles) {
$r->print("Files selected from other directories: ");
foreach my $file (@otherfiles) {
$r->print($file." ");
}
}
}
sub upload {
my ($r,$url,$group)=@_;
my $fname=$env{'form.uploaddoc.filename'};
my $filesize = (length($env{'form.uploaddoc'})) / 1000; #express in k (1024?)
my $disk_quota = 20000; # expressed in k
$fname=&Apache::lonnet::clean_filename($fname);
my $portfolio_root=&get_portfolio_root($group);
my ($uname,$udom) = &get_name_dom($group);
my $port_path = &get_port_path($group);
# Fixme --- Move the checking for existing file to LOND error return
my @dir_list=&get_dir_list($portfolio_root,$group);
my $found_file = 0;
my $locked_file = 0;
foreach my $line (@dir_list) {
my ($file_name)=split(/\&/,$line,2);
if ($file_name eq $fname){
$found_file = 1;
if (&Apache::lonnet::is_locked($env{'form.currentpath'}.$file_name,$udom,$uname) eq 'true') {
$locked_file = 1;
}
}
}
my $current_disk_usage = &Apache::lonnet::diskusage($udom,$uname,$portfolio_root);
if (($current_disk_usage + $filesize) > $disk_quota){
$r->print('Unable to upload '.$fname.' (size = '.$filesize.' kilobytes). Disk quota will be exceeded.'.
' Disk quota is '.$disk_quota.' kilobytes. Your current disk usage is '.$current_disk_usage.' kilobytes.');
$r->print(&done('Back',$url,$group));
}
elsif ($found_file){
if ($locked_file){
$r->print('Unable to upload '.$fname.', a locked file by that name was found in '.$port_path.$env{'form.currentpath'}.''.
' You will be able to rename or delete existing '.$fname.' after a grade has been assigned.');
$r->print(&done('Back',$url,$group));
} else {
$r->print('Unable to upload '.$fname.', a file by that name was found in '.$port_path.$env{'form.currentpath'}.''.
' To upload, rename or delete existing '.$fname.' in '.$port_path.$env{'form.currentpath'});
$r->print(&done('Back',$url,$group));
}
} else {
my $result=&Apache::lonnet::userfileupload('uploaddoc','',
$port_path.$env{'form.currentpath'});
print STDERR "result was $result for $port_path.$env{'form.currentpath'}\n";
if ($result !~ m|^/uploaded/|) {
$r->print(' An errror occured ('.$result.
') while trying to upload '.&display_file().' ');
$r->print(&done('Back',$url,$group));
} else {
$r->print(&done(undef,$url,$group));
}
}
}
sub lock_info {
my ($r,$url,$group) = @_;
my ($uname,$udom) = &get_name_dom($group);
my %current_permissions = &Apache::lonnet::dump('file_permissions',$udom,$uname);
my $file_name = $env{'form.lockinfo'};
foreach my $key(keys(%current_permissions)) {
if ($file_name eq $key) {
foreach my $array_item (@{$current_permissions{$key}}) {
if (ref($array_item)) {
$r->print(''.$key.' was submitted in response to problem: '.
&Apache::lonnet::gettitle($$array_item[0]).' ');
my %course_description = &Apache::lonnet::coursedescription($$array_item[1]);
$r->print('In the course: '.$course_description{'description'}.' ');
# $r->print('the third is '.$$array_item[2].' ');
# $r->print("item is $$array_item[0] and $$array_item[0]");
}
}
}
}
$r->print(&done('Back',$url,$group));
return 'ok';
}
sub createdir {
my ($r,$url,$group)=@_;
my $newdir=&Apache::lonnet::clean_filename($env{'form.newdir'});
if ($newdir eq '') {
$r->print(''.
&mt("Error: no directory name was provided.").
' ');
$r->print(&done(undef,$url,$group));
return;
}
my $portfolio_root = &get_portfolio_root($group);
my @dir_list=&get_dir_list($portfolio_root,$group);
my $found_file = 0;
foreach my $line (@dir_list) {
my ($filename)=split(/\&/,$line,2);
if ($filename eq $newdir){
$found_file = 1;
}
}
if ($found_file){
$r->print(' Unable to create a directory named '.$newdir.
' a file or directory by that name already exists. ');
} else {
my ($uname,$udom) = &get_name_dom($group);
my $port_path = &get_port_path($group);
my $result=&Apache::lonnet::mkdiruserfile($uname,$udom,
$port_path.$env{'form.currentpath'}.$newdir);
if ($result ne 'ok') {
$r->print(' An errror occured ('.$result.
') while trying to create a new directory '.&display_file().' ');
}
}
if ($newdir ne $env{'form.newdir'}) {
$r->print("The new directory name was changed from: ".$env{'form.newdir'}." to $newdir ");
}
$r->print(&done(undef,$url,$group));
}
sub get_portfolio_root {
my ($group) = @_;
my ($portfolio_root,$udom,$uname,$path);
($uname,$udom) = &get_name_dom($group);
if (defined($group)) {
$path = '/userfiles/groups/'.$group.'/portfolio';
} else {
$path = '/userfiles/portfolio';
}
return (&Apache::loncommon::propath($udom,$uname).$path);
}
sub get_dir_list {
my ($portfolio_root,$group) = @_;
my ($uname,$udom) = &get_name_dom($group);
return &Apache::lonnet::dirlist($env{'form.currentpath'},
$udom,$uname,$portfolio_root);
}
sub get_name_dom {
my ($group) = @_;
my ($uname,$udom);
if (defined($group)) {
$udom = $env{'course.'.$env{'request.course.id'}.'.domain'};
$uname = $env{'course.'.$env{'request.course.id'}.'.num'};
} else {
$udom = $env{'user.domain'};
$uname = $env{'user.name'};
}
return ($uname,$udom);
}
sub get_namespace {
my ($group) = @_;
my $namespace = 'portfolio';
if (defined($group)) {
my ($uname,$udom) = &get_name_dom($group);
$namespace .= '_'.$udom.'_'.$uname.'_'.$group;
}
return $namespace;
}
sub get_port_path {
my ($group) = @_;
my $port_path;
if (defined($group)) {
$port_path = "groups/$group/portfolio";
} else {
$port_path = 'portfolio';
}
return $port_path;
}
sub handler {
# this handles file management
my $r = shift;
&Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},
['selectfile','currentpath','meta','lockinfo','currentfile',
'action','fieldname','mode','rename','continue','group']);
my ($uname,$udom,$portfolio_root,$url,$group,$caller,$title);
if ($r->uri =~ m|^(/adm/)([^/]+)|) {
$url = $1.$2;
$caller = $2;
}
if ($caller eq 'coursegrp_portfolio') {
# Needs to be in a course
if (! ($env{'request.course.fn'})) {
# Not in a course
$env{'user.error.msg'}=
"/adm/coursegrp_portfolio:rgf:0:0:Cannot view group portfolio";
return HTTP_NOT_ACCEPTABLE;
}
my $earlyout = 0;
my $view_permission = &Apache::lonnet::allowed('vcg',
$env{'request.course.id'});
$group = $env{'form.group'};
$group =~ s/\W//g;
if ($group) {
my %curr_groups = ();
($uname,$udom) = &get_name_dom($group);
if (&Apache::loncommon::coursegroups(\%curr_groups,$udom,$uname,
$group)) {
if (($view_permission) || (&Apache::lonnet::allowed('rgf',
$env{'request.course.id'}.'/'.$group))) {
$portfolio_root = &get_portfolio_root($group);
} else {
$r->print('You do not have the privileges required to access the shared files space for this group');
$earlyout = 1;
}
} else {
$r->print('Not a valid group for this course');
$earlyout = 1;
}
$title = &mt('Group files').' for '.$group;
} else {
$r->print('Invalid group');
$earlyout = 1;
}
if ($earlyout) { return OK; }
} else {
($uname,$udom) = &get_name_dom();
$portfolio_root = &get_portfolio_root();
$title = &mt('Portfolio Manager');
}
&Apache::loncommon::no_cache($r);
&Apache::loncommon::content_type($r,'text/html');
$r->send_http_header;
# Give the LON-CAPA page header
my $html=&Apache::lonxml::xmlbegin();
$r->print($html.''.$title."\n");
if ($env{"form.mode"} eq 'selectfile'){
$r->print(&Apache::loncommon::bodytag($title,undef,undef,1));
} else {
$r->print(&Apache::loncommon::bodytag($title));
}
$r->rflush();
if (($env{'form.storeupl'}) & (!$env{'form.uploaddoc.filename'})){
$r->print(' No file was selected to upload.'.
'To upload a file, click Browse...'.
', select a file, then click Upload,');
}
if ($env{'form.meta'}) {
&open_form($r,$url);
# $r->print(&edit_meta_data($r, $env{'form.currentpath'}.$env{'form.selectfile'}));
$r->print('Edit the meta data ');
&close_form($r,$url,$group);
}
if ($env{'form.store'}) {
}
if ($env{'form.uploaddoc.filename'}) {
&upload($r,$url,$group);
} elsif ($env{'form.action'} eq 'delete' && $env{'form.confirmed'}) {
&delete_confirmed($r,$url,$group);
} elsif ($env{'form.action'} eq 'delete') {
&delete($r,$url,$group);
} elsif ($env{'form.action'} eq 'deletedir' && $env{'form.confirmed'}) {
&delete_dir_confirmed($r,$url,$group);
} elsif ($env{'form.action'} eq 'deletedir'){
&delete_dir($r,$url,$group);
} elsif ($env{'form.action'} eq 'rename' && $env{'form.confirmed'}) {
&rename_confirmed($r,$url,$group);
} elsif ($env{'form.rename'}) {
$env{'form.selectfile'} = $env{'form.rename'};
$env{'form.action'} = 'rename';
&rename($r,$url,$group);
} elsif ($env{'form.createdir'}) {
&createdir($r,$url,$group);
} elsif ($env{'form.lockinfo'}) {
&lock_info($r,$url,$group);
} else {
my $current_path='/';
if ($env{'form.currentpath'}) {
$current_path = $env{'form.currentpath'};
}
my @dir_list=&get_dir_list($portfolio_root,$group);
if ($dir_list[0] eq 'no_such_dir'){
# two main reasons for this:
# 1) never been here, so directory structure not created
# 2) back-button navigation after deleting a directory
if ($current_path eq '/'){
&Apache::lonnet::mkdiruserfile($uname,$udom,'portfolio');
} else {
# some directory that snuck in get rid of the directory
# from the recent pulldown, just in case
&Apache::lonhtmlcommon::remove_recent('portfolio',
[$current_path]);
$current_path = '/'; # force it back to the root
}
# now grab the directory list again, for the first time
@dir_list=&Apache::lonnet::dirlist($current_path,
$udom,$uname,$portfolio_root);
}
# need to know if directory is empty so it can be removed if desired
my $is_empty=(@dir_list == 2);
&display_common($r,$url,$current_path,$is_empty,\@dir_list,$group);
&display_directory($r,$url,$current_path,$is_empty,\@dir_list,$group);
$r->print("