--- loncom/interface/portfolio.pm 2004/10/11 22:52:20 1.47
+++ loncom/interface/portfolio.pm 2014/12/07 19:45:19 1.255
@@ -1,3 +1,8 @@
+# The LearningOnline Network
+# portfolio browser
+#
+# $Id: portfolio.pm,v 1.255 2014/12/07 19:45:19 raeburn Exp $
+#
# Copyright Michigan State University Board of Trustees
#
# This file is part of the LearningOnline Network with CAPA (LON-CAPA).
@@ -29,492 +34,2861 @@ use Apache::lonnet;
use Apache::lontexconvert;
use Apache::lonfeedback;
use Apache::lonlocal;
+use Apache::lonnet;
+use Apache::longroup;
+use Apache::lonhtmlcommon;
+use HTML::Entities;
+use LONCAPA qw(:DEFAULT :match);
+
+sub group_args {
+ my $output;
+ if (defined($env{'form.group'})) {
+ $output .= '&group='.$env{'form.group'};
+ if (defined($env{'form.ref'})) {
+ $output .= '&ref='.$env{'form.ref'};
+ }
+ }
+ return $output;
+}
-# receives a file name and path stub from username/userfiles/portfolio/
+sub group_form_data {
+ my $output;
+ if (defined($env{'form.group'})) {
+ $output = ' ';
+ if (exists($env{'form.ref'})) {
+ $output .= ' ';
+ }
+ }
+ return $output;
+}
+
+# receives a filename and path stub from username/userfiles/portfolio/
# returns an anchor tag consisting encoding filename and currentpath
sub make_anchor {
- my ($filename, $current_path) = @_;
- my $anchor = ''.$filename.' ';
+ my ($url, $anchor_fields, $inner_text) = @_;
+ if ($$anchor_fields{'continue'} ne 'true') {$$anchor_fields{'continue'} = 'false'};
+ my $anchor = ''.$inner_text.' ';
return $anchor;
}
+
my $dirptr=16384;
-sub display_directory {
- my ($r,$current_path,$is_empty,$dir_list)=@_;
- my $iconpath= $r->dir_config('lonIconsURL') . "/";
- $r->print('
');
- $r->print('');
- my $displayOut = '';
- $r->print($displayOut);
- $r->print(' ');
- $displayOut = '';
- $r->print($displayOut);
- $r->print('
');
+sub display_common {
+ my ($r,$url,$current_path,$is_empty,$dir_list,$can_upload,$group)=@_;
+ my $namespace = &get_namespace();
+ my $port_path = &get_port_path();
+ if ($can_upload) {
+ my $groupitem = &group_form_data();
+
+ my $iconpath= $r->dir_config('lonIconsURL') . "/";
+ my %lt=&Apache::lonlocal::texthash(
+ 'upload' => 'Upload',
+ 'upload_label' => 'Upload file to current directory',
+ 'createdir' => 'Create Subdirectory',
+ 'createdir_label' => 'Create subdirectory in current directory',
+ 'parse' => 'Upload embedded images/multimedia/css/linked files if HTML file',
+ );
+ my $escuri = &HTML::Entities::encode($r->uri,'&<>"');
+ my $help_fileupload = &Apache::loncommon::help_open_topic('Portfolio AddFiles');
+ my $help_createdir = &Apache::loncommon::help_open_topic('Portfolio CreateDirectory');
+ my $help_portfolio = &Apache::loncommon::help_open_topic('Portfolio About', &mt('Help on the portfolio'));
+ $r->print(&display_portfolio_usage($group,$help_portfolio));
+ my $parse_check;
+ if (!&suppress_embed_prompt()) {
+ $parse_check = <<"END";
+
+
+
+
+ $lt{'parse'}
+
+
+END
+ }
+
+ # Upload File
+ $r->print(''
+ .''
+ .'
'
+ );
+ # Create Subdirectory
+ $r->print(''
+ .''
+ .'
'
+ );
+ } # end "if can_upload"
+
my @tree = split (/\//,$current_path);
- $r->print(''.&make_anchor('portfolio','/').'/');
+ my %anchor_fields = (
+ 'selectfile' => $port_path,
+ 'currentpath' => '/',
+ 'mode' => $env{"form.mode"},
+ 'symb' => $env{"form.symb"},
+ 'fieldname' => $env{"form.fieldname"},
+ 'continue' => $env{"form.continue"}
+ );
+ $r->print(' ');
+ $r->print(''.&make_anchor($url,\%anchor_fields,$port_path).'/');
if (@tree > 1){
- my $newCurrentPath = '';
+ my $newCurrentPath = '/';
for (my $i = 1; $i< @tree; $i++){
$newCurrentPath .= $tree[$i].'/';
- $r->print(&make_anchor($tree[$i],'/'.$newCurrentPath).'/');
+ my %anchor_fields = (
+ 'selectfile' => $tree[$i],
+ 'currentpath' => $newCurrentPath,
+ 'mode' => $env{"form.mode"},
+ 'symb' => $env{"form.symb"},
+ 'fieldname' => $env{"form.fieldname"},
+ 'continue' => $env{"form.continue"}
+ );
+ $r->print(&make_anchor($url,\%anchor_fields,$tree[$i]).'/');
}
}
- $r->print(' ');
- &Apache::lonhtmlcommon::store_recent('portfolio',$current_path,$current_path);
- #Fixme -- remove from recent those paths that are deleted
- $r->print(' ");
- if ($is_empty && ($current_path ne '/')) {
- $displayOut = '';
-
- $r->print($displayOut);
- return;
- }
- $r->print(''.
- 'Actions Name Size Last Modified ');
- my $href_location="/uploaded/$ENV{'user.domain'}/$ENV{'user.name'}/portfolio$current_path";
- foreach my $line (sort
- {
- my ($afile)=split('&',$a,2);
- my ($bfile)=split('&',$b,2);
- return (lc($afile) cmp lc($bfile));
- } (@$dir_list)) {
- #$strip holds directory/file name
- #$dom
- my ($filename,$dom,undef,$testdir,undef,undef,undef,undef,$size,undef,$mtime,undef,undef,undef,$obs,undef)=split(/\&/,$line,16);
- if (($filename ne '.') && ($filename ne '..')) {
- if ($dirptr&$testdir) {
- $r->print(' ');
- $r->print('Go to ... ');
- $r->print(''.&make_anchor($filename.'/',$current_path.$filename.'/').' ');
- $r->print(' ');
- } else {
- $r->print('');
- $r->print('
-
- ');
- $r->print(' ');
- $r->print(''.
- $filename.' ');
- $r->print(''.$size.' ');
- $r->print(''.&Apache::lonlocal::locallocaltime($mtime).' ');
- $r->print(' ');
+}
+
+sub display_portfolio_usage {
+ my ($group,$helpitem) = @_;
+ my $disk_quota = &get_quota($group);
+ my $getpropath = 1;
+ my $portfolio_root = &get_portfolio_root();
+ my ($uname,$udom) = &get_name_dom($group);
+ my $current_disk_usage =
+ &Apache::lonnet::diskusage($udom,$uname,$portfolio_root,$getpropath);
+ return &Apache::loncommon::head_subbox(
+ ''
+ .$helpitem
+ .'
'
+ .''
+ .&Apache::lonhtmlcommon::display_usage($current_disk_usage,$disk_quota)
+ .'
');
+}
+
+sub display_directory_line {
+ my ($r,$select_mode, $filename, $mtime, $size, $css_class,
+ $line, $access_controls, $curr_access, $now, $version_flag,
+ $href_location, $url, $current_path, $access_admin_text, $versions)=@_;
+
+ my $fullpath = &prepend_group($current_path.$filename);
+ $r->print(&Apache::loncommon::start_data_table_row());
+ $r->print($line); # contains first two cells of table
+ my $lock_info;
+ if ($version_flag) { # versioned can't be versioned, so TRUE when root file
+ $r->print(' ');
+ $r->print(''.$version_flag.' ');
+ } else { # this is a graded or handed back file
+ my ($user,$domain) = &get_name_dom($env{'form.group'});
+ my $permissions_hash = &Apache::lonnet::get_portfile_permissions($domain,$user);
+ if (defined($$permissions_hash{$fullpath})) {
+ foreach my $array_item (@{$$permissions_hash{$fullpath}}) {
+ if (ref($array_item) eq 'ARRAY') {
+ if ($$array_item[-1] eq 'handback') {
+ $lock_info = 'Handback';
+ } elsif ($$array_item[-1] eq 'graded') {
+ $lock_info = 'Graded';
+ }
+ }
}
}
+ if ($lock_info) {
+ my %anchor_fields = ('lockinfo' => $fullpath);
+ if ($versions) { # hold the folder open
+ my ($fname,$version,$extension) = &Apache::lonnet::file_name_version_ext($fullpath);
+ $fname =~ s|^/||;
+ $anchor_fields{'showversions'} = $fname.'.'.$extension;
+ }
+ $lock_info = &make_anchor(undef,\%anchor_fields,$lock_info);
+ }
+ $r->print(''.$lock_info.' ');
}
-# pink bg
-# blue bg
-# $r->print(&display_directory($current_path, $currentFile, @dir_list));
-# $r->print('>');
-# $r->print(&display_actions($current_path, $currentFile, $isEmpty));
- $r->print('
');
+ # $r->print(''.$$version_flag{$filename}.' ');
+ $r->print(' '.&make_anchor($href_location.$filename,undef,$filename).' ');
+ $r->print(''.$size.' ');
+ $r->print(''.&Apache::lonlocal::locallocaltime($mtime).' ');
+ if ($select_mode ne 'true') {
+ $r->print(' '); # Display status
+ $r->print(''
+ .&mt($curr_access).' '
+ );
+ my %anchor_fields = (
+ 'access' => $filename,
+ 'currentpath' => $current_path
+ );
+ $r->print(&make_anchor($url, \%anchor_fields, $access_admin_text).' ');
+ } else {
+ $r->print(' '); # Display status
+ }
+ $r->print(&Apache::loncommon::end_data_table_row().$/);
}
-sub display_file_select {
- my ($r,$current_path,$is_empty,$dir_list)=@_;
+
+sub display_directory {
+ my ($r,$url,$current_path,$is_empty,$dir_list,$group,$can_upload,
+ $can_modify,$can_delete,$can_setacl)=@_;
my $iconpath= $r->dir_config('lonIconsURL') . "/";
- $r->print('');
- $r->print('');
- my $displayOut = '';
- $r->print($displayOut);
- $r->print(' ');
- $displayOut = '';
- $r->print($displayOut);
- $r->print('
');
- my @tree = split (/\//,$current_path);
- $r->print(''.&make_anchor('portfolio','/').'/');
- if (@tree > 1){
- my $newCurrentPath = '';
- for (my $i = 1; $i< @tree; $i++){
- $newCurrentPath .= $tree[$i].'/';
- $r->print(&make_anchor($tree[$i],'/'.$newCurrentPath).'/');
- }
+ my $select_mode;
+ my $checked_files;
+ my $port_path = &get_port_path();
+ my ($uname,$udom) = &get_name_dom($group);
+ my $access_admin_text = &mt('View Status');
+ if ($can_setacl) {
+ $access_admin_text = &mt('View/Change Status');
}
- $r->print(' ');
- &Apache::lonhtmlcommon::store_recent('portfolio',$current_path,$current_path);
- #Fixme -- remove from recent those paths that are deleted
- $r->print(' ");
- if ($is_empty && ($current_path ne '/')) {
- $displayOut = '';
-
- $r->print($displayOut);
- return;
+
+ my $current_permissions = &Apache::lonnet::get_portfile_permissions($udom,
+ $uname);
+ my %locked_files = &Apache::lonnet::get_marked_as_readonly_hash(
+ $current_permissions,$group);
+ my %access_controls = &Apache::lonnet::get_access_controls($current_permissions,$group);
+ my $now = time;
+ if ($env{"form.mode"} eq 'selectfile') {
+ &select_files($r,$dir_list);
+ $checked_files =&Apache::lonnet::files_in_path($uname,$env{'form.currentpath'});
+ $select_mode = 'true';
+ }
+ if ($select_mode eq 'true') {
+ $r->print(''
+ );
+ # Delete button
+ $r->print(
+ ''
+ );
+ # Directory is empty, so nothing else to display
+ return;
}
- $r->print(''.
- 'Select Name Size Last Modified ');
- my $href_location="/uploaded/$ENV{'user.domain'}/$ENV{'user.name'}/portfolio$current_path";
- $r->print('
');
+ if ($select_mode eq 'true') {
+ $r->print(&Apache::loncommon::end_data_table());
+ if ($zerobyte) {
+ $r->print(''.&mt('[quant,_1,file] in list not selectable as file size is 0 bytes.',$zerobyte).'
');
+ }
+ $r->print('
+
+
+
+
+
+
+
+
+
+ ');
+ } else {
+ $r->print(&Apache::loncommon::end_data_table());
+ if ($can_delete) {
+ $r->print('
+
+ '.
+ &Apache::loncommon::help_open_topic('Portfolio DeleteFile').'
+
+
+
+ '
+ );
+ }
+ }
}
sub open_form {
- my ($r)=@_;
- $r->print('');
- $r->print('');
+ $r->print('');
-
+ $env{'form.currentpath'}.'" />'.
+ &group_form_data());
+ $r->print("\n".'
+ ');
}
sub display_file {
my ($path,$filename)=@_;
- if (!defined($path)) { $path=$ENV{'form.currentpath'}; }
- if (!defined($filename)) { $filename=$ENV{'form.selectfile'}; }
- return ''.$path.$filename.' ';
+ my $display_file_text;
+ my $file_start='';
+ my $file_end=' ';
+ if (!defined($path)) { $path=$env{'form.currentpath'}; }
+ if (!defined($filename)) {
+ $filename=$env{'form.selectfile'};
+ $display_file_text = $file_start.$path.$filename.$file_end;
+ } elsif (ref($filename) eq "ARRAY") {
+ foreach my $file (@$filename) {
+ $display_file_text .= $file_start.$path.$file.$file_end.' ';
+ }
+ } elsif (ref($filename) eq "SCALAR") {
+ $display_file_text = $file_start.$path.$$filename.$file_end;
+ } else {
+ $display_file_text = $file_start.$path.$filename.$file_end;
+ }
+ return $display_file_text;
}
sub done {
- return ('');
+ my ($linktext,$url)=@_;
+ unless (defined($linktext)) {
+ $linktext='Return to directory';
+ }
+ my %anchor_fields = (
+ 'showversions' => $env{'form.showversions'},
+ 'currentpath' => $env{'form.currentpath'},
+ 'fieldname' => $env{'form.fieldname'},
+ 'symb' => $env{'form.symb'},
+ 'mode' => $env{'form.mode'}
+ );
+ my $result = &Apache::lonhtmlcommon::actionbox(
+ [&make_anchor($url,\%anchor_fields,&mt($linktext))]);
+ return $result;
}
sub delete {
- my ($r)=@_;
- &open_form($r);
- $r->print(''.&mt('Delete').' '.&display_file().'?
');
- &close_form($r);
+ my ($r,$url,$group)=@_;
+ my @check;
+ my $file_name = $env{'form.currentpath'}.$env{'form.selectfile'};
+ $file_name = &prepend_group($file_name);
+ 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(
+ ''
+ .&mt('The file is locked and cannot be deleted.')
+ .'
'
+ .&done(undef,$url)
+ );
+ } else {
+ if (scalar(@files)) {
+ &open_form($r,$url);
+ $r->print(''.&mt('Delete [_1]?',&display_file(undef,\@files)).'
');
+ &close_form($r,$url);
+ } else {
+ $r->print(''.&mt('No file was checked to delete.').'
');
+ $r->print(&done(undef,$url));
+ }
+ }
}
sub delete_confirmed {
- my ($r)=@_;
- my $result=&Apache::lonnet::removeuserfile($ENV{'user.name'},
- $ENV{'user.domain'},'portfolio'.
- $ENV{'form.currentpath'}.
- $ENV{'form.selectfile'});
- if ($result ne 'ok') {
- $r->print(' An error occured ('.$result.
- ') while trying to delete '.&display_file().' ');
+ 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();
+ my $current_permissions = &Apache::lonnet::get_portfile_permissions($udom,
+ $uname);
+ my @msg;
+ foreach my $delete_file (@files) {
+ $result =
+ &Apache::lonnet::removeuserfile(
+ $uname,$udom,$port_path.
+ $env{'form.currentpath'}.
+ $delete_file);
+ if ($result ne 'ok') {
+ push(@msg, &Apache::lonhtmlcommon::confirm_success(
+ &mt('An error occurred ([_1]) while trying to delete [_2].'
+ ,$result,&display_file(undef, $delete_file)),1));
+ } else {
+ push(@msg, &Apache::lonhtmlcommon::confirm_success(
+ &mt('File: [_1] deleted.'
+ ,&display_file(undef,$delete_file))));
+ my $file_name = $env{'form.currentpath'}.$delete_file;
+ $file_name = &prepend_group($file_name);
+ my %access_controls =
+ &Apache::lonnet::get_access_controls($current_permissions,
+ $group,$file_name);
+ if (keys(%access_controls) > 0) {
+ my %changes;
+ foreach my $key (keys(%{$access_controls{$file_name}})) {
+ $changes{'delete'}{$key} = 1;
+ }
+ if (keys(%changes) > 0) {
+ my ($outcome,$deloutcome,$new_values,$translation) =
+ &Apache::lonnet::modify_access_controls($file_name,\%changes,
+ $udom,$uname);
+ if ($outcome ne 'ok') {
+ push(@msg, &Apache::lonhtmlcommon::confirm_success(
+ &mt('An error occurred ([_1]) while '.
+ 'trying to delete access controls for the file.',$outcome),1));
+ } else {
+ if ($deloutcome eq 'ok') {
+ push(@msg, &mt('Access controls also deleted for the file.')); # FIXME: Does the user really need this message?
+ } else {
+ push(@msg, &Apache::lonhtmlcommon::confirm_success(
+ &mt('An error occurred ([_1]) while '.
+ 'trying to delete access controls for the file.'
+ ,$deloutcome),1));
+ }
+ }
+ }
+ }
+ }
}
- $r->print(&done());
+ $r->print(&Apache::loncommon::confirmwrapper(join(' ',@msg)));
+ $r->print(&done(undef,$url));
}
sub delete_dir {
- my ($r)=@_;
- &open_form($r);
- $r->print(''.&mt('Delete').' '.&display_file().'?
');
- &close_form($r);
+ my ($r,$url)=@_;
+ &open_form($r,$url);
+ $r->print(''.&mt('Delete [_1]?',&display_file()).'
');
+ &close_form($r,$url);
}
sub delete_dir_confirmed {
- my ($r)=@_;
- my $directory_name = $ENV{'form.currentpath'};
- $directory_name =~ m/\/$/;
- $directory_name = $`;
- my $result=&Apache::lonnet::removeuserfile($ENV{'user.name'},
- $ENV{'user.domain'},'portfolio'.
+ 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();
+ my $port_path = &get_port_path();
+ 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.' ');
+ $r->print(
+ &Apache::loncommon::confirmwrapper(
+ &Apache::lonhtmlcommon::confirm_success(
+ &mt('An error occurred (dir) ([_1]) while trying to delete [_2].'
+ ,$result,$directory_name),1)));
+ $r->print(&done(undef,$url));
+ return;
} else {
# now remove from recent
-# $r->print(' removing '.$directory_name.' print(&done());
+ $r->print(
+ &Apache::loncommon::confirmwrapper(
+ &Apache::lonhtmlcommon::confirm_success(
+ &mt('Directory successfully deleted'))));
+ $r->print(&done(undef,$url));
}
sub rename {
- my ($r)=@_;
- &open_form($r);
- $r->print(''.&mt('Rename').' '.&display_file().' to
- ?
');
- &close_form($r);
+ my ($r,$url,$group)=@_;
+ my $file_name = $env{'form.currentpath'}.$env{'form.rename'};
+ my ($uname,$udom) = &get_name_dom($group);
+ $file_name = &prepend_group($file_name);
+ if (&Apache::lonnet::is_locked($file_name,$udom,$uname) eq 'true') {
+ $r->print(
+ ''
+ .&mt('The file is locked and cannot be renamed.')
+ .'
'
+ );
+ $r->print(&done(undef,$url));
+ } else {
+ &open_form($r,$url);
+ $r->print(''.&mt('Rename [_1] to [_2]?', &display_file()
+ , ' ').'
');
+ &close_form($r,$url);
+ }
}
sub rename_confirmed {
- my ($r)=@_;
- my $filenewname=&Apache::lonnet::clean_filename($ENV{'form.filenewname'});
+ 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();
+
+ # Display warning in case of filename cleaning has changed the filename
+ if ($filenewname ne $env{'form.filenewname'}) {
+ $r->print(
+ ''
+ .&mt('Invalid characters')
+ .' '
+ .&mt('The new filename was changed from [_1] to [_2].'
+ ,''.&display_file('',$env{'form.filenewname'}).' '
+ ,''.&display_file('',$filenewname).' ')
+ .'
'
+ );
+
+ }
+
+ # Filename empty?
if ($filenewname eq '') {
- $r->print(''.
- &mt("Error: no valid filename was provided to rename to.").
- ' ');
- $r->print(&done());
- return;
+ $r->print(
+ &Apache::loncommon::confirmwrapper(
+ &Apache::lonhtmlcommon::confirm_success(
+ &mt('Error: no valid filename was provided to rename to.'),1)));
+ $r->print(&done(undef,$url));
+ return;
}
+
+ # Rename the file
+ my $chg_access;
my $result=
- &Apache::lonnet::renameuserfile($ENV{'user.name'},$ENV{'user.domain'},
- 'portfolio'.$ENV{'form.currentpath'}.$ENV{'form.selectfile'},
- 'portfolio'.$ENV{'form.currentpath'}.$ENV{'form.filenewname'});
- if ($result ne 'ok') {
- $r->print(' An errror occured ('.$result.
- ') while trying to rename '.&display_file().' to '.
- &display_file(undef,$filenewname).' ');
+ &Apache::lonnet::renameuserfile($uname,$udom,
+ $port_path.$env{'form.currentpath'}.$env{'form.selectfile'},
+ $port_path.$env{'form.currentpath'}.$filenewname);
+ if ($result eq 'ok') {
+ $chg_access = &access_for_renamed($filenewname,$group,$udom,$uname);
+ } else {
+ $r->print(
+ &Apache::loncommon::confirmwrapper(
+ &Apache::lonhtmlcommon::confirm_success(
+ &mt('An error occurred ([_1]) while trying to rename [_2] to [_3].'
+ ,$result,&display_file(),&display_file('',$filenewname))
+ ,1)));
+ $r->print(&done(undef,$url));
+ return;
}
- $r->print(&done());
+ $r->print($chg_access);
+ $r->print(
+ &Apache::loncommon::confirmwrapper(
+ &Apache::lonhtmlcommon::confirm_success(
+ &mt('File successfully renamed'))));
+ $r->print(&done(undef,$url));
}
-sub select_files {
- my ($r)=@_;
- $r->print("Select portfolio files
- Check as many as you wish in response to the essay problem. ");
- my $portfolio_root = &Apache::loncommon::propath($ENV{'user.domain'},
- $ENV{'user.name'}).
- '/userfiles/portfolio';
- my $current_path='/';
- if ($ENV{'form.currentpath'}) {
- $current_path = $ENV{'form.currentpath'};
- }
- my @dir_list=&Apache::lonnet::dirlist($current_path,
- $ENV{'user.domain'},
- $ENV{'user.name'},$portfolio_root);
- 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($ENV{'user.name'},
- $ENV{'user.domain'},'portfolio');
+
+sub access_for_renamed {
+ my ($filenewname,$group,$udom,$uname) = @_;
+ my $oldfile = $env{'form.currentpath'}.$env{'form.selectfile'};
+ $oldfile = &prepend_group($oldfile);
+ my $newfile = $env{'form.currentpath'}.$filenewname;
+ $newfile = &prepend_group($newfile);
+ my $current_permissions =
+ &Apache::lonnet::get_portfile_permissions($udom,$uname);
+ my %access_controls =
+ &Apache::lonnet::get_access_controls($current_permissions,
+ $group,$oldfile);
+ my $chg_text;
+ if (keys(%access_controls) > 0) {
+ my %change_old;
+ my %change_new;
+ foreach my $key (keys(%{$access_controls{$oldfile}})) {
+ $change_old{'delete'}{$key} = 1;
+ $change_new{'activate'}{$key} = $access_controls{$oldfile}{$key};
+ }
+ my ($outcome,$deloutcome,$new_values,$translation) =
+ &Apache::lonnet::modify_access_controls($oldfile,\%change_old,
+ $udom,$uname);
+ if ($outcome ne 'ok') {
+ $chg_text =' '.&mt("An error occurred ([_1]) while ".
+ "trying to delete access control records for the old name.",$outcome).
+ ' ';
+ } else {
+ if ($deloutcome ne 'ok') {
+ $chg_text = ' '.
+ &mt("An error occurred ([_1]) while ".
+ "trying to delete access control records for the old name.",$deloutcome).
+ ' ';
+ }
+ }
+ ($outcome,$deloutcome,$new_values,$translation) =
+ &Apache::lonnet::modify_access_controls($newfile,\%change_new,
+ $udom,$uname);
+ if ($outcome ne 'ok') {
+ $chg_text .= ' '.
+ &mt("An error occurred ([_1]) while ".
+ "trying to update access control records for the new name.",$outcome).
+ ' ';
+ }
+ if ($chg_text eq '') {
+ $chg_text = ' '.&mt('Access controls updated to reflect the name change.');
+ }
+ }
+ return $chg_text;
+}
+
+sub display_access {
+ my ($r,$url,$group,$can_setacl,$port_path,$action) = @_;
+ my ($uname,$udom) = &get_name_dom($group);
+ my $file_name = $env{'form.currentpath'}.$env{'form.access'};
+ $file_name = &prepend_group($file_name);
+ my $current_permissions = &Apache::lonnet::get_portfile_permissions($udom,
+ $uname);
+ my %access_controls = &Apache::lonnet::get_access_controls($current_permissions,$group,$file_name);
+ my $aclcount = keys(%access_controls);
+ my ($header,$info);
+ if ($action eq 'chgaccess') {
+ $header =
+ ''
+ .&mt('Allowing others to retrieve file: [_1]'
+ ,''
+ .$port_path.$env{'form.currentpath'}.$env{'form.access'}
+ .' ')
+ .' ';
+ $info .= &mt('Access to this file by others can be set to be one or more of the following types: public, passphrase-protected or conditional.');
+ $info .= ''.&mt('Public files are available to anyone without the need for login.');
+ $info .= ' '.&mt('Passphrase-protected files do not require log-in, but will require the viewer to enter the passphrase you set.');
+ $info .= ' '.&explain_conditionals();
+ $info .= ' '.
+ &mt('A listing of files viewable without log-in is available at: ')."".&Apache::lonnet::absolute_url($ENV{'SERVER_NAME'})."/adm/$udom/$uname/aboutme/portfolio . ";
+ if ($group eq '') {
+ $info .= &mt("For logged in users a 'Display file listing' link will also appear (when there are viewable files) on your personal information page:");
+ } else {
+ $info .= &mt("For logged in users a 'Display file listing' link will also appear (when there are viewable files) on the course information page:");
+ }
+ $info .= "".&Apache::lonnet::absolute_url($ENV{'SERVER_NAME'})."/adm/$udom/$uname/aboutme ";
+ if ($group ne '') {
+ $info .= &mt("Users with course editing rights may add a 'Group Portfolio' item using the Course Editor (Collaboration tab), to provide access to viewable group portfolio files.").' ';
+ }
+ } else {
+ $header = ''.&mt('Conditional access controls for file: [_1]',$port_path.$env{'form.currentpath'}.$env{'form.access'}).' '.
+ &explain_conditionals().' ';
+ }
+ if ($can_setacl) {
+ &open_form($r,$url);
+ $r->print($header.$info);
+ $r->print(' '.&Apache::loncommon::help_open_topic('Portfolio ShareFile SetAccess', &mt('Help on setting up share access')));
+ $r->print(&Apache::loncommon::help_open_topic('Portfolio ShareFile ChangeSetting', &mt('Help on changing settings')));
+ $r->print(&Apache::loncommon::help_open_topic('Portfolio ShareFile StopAccess', &mt('Help on removing share access')));
+ &access_setting_table($r,$url,$file_name,$access_controls{$file_name},
+ $action);
+ my $button_text = {
+ 'continue' => &mt('Proceed'),
+ 'cancel' => &mt('Return to directory'),
+ };
+ &close_form($r,$url,$button_text);
+ } else {
+ $r->print($header);
+ if ($aclcount) {
+ $r->print($info);
+ }
+ &view_access_settings($r,$url,$access_controls{$file_name},$aclcount);
+ }
+}
+
+sub explain_conditionals {
+ return
+ &mt('Conditional files are accessible to users who satisfy the conditions you set.').''.
+ ''.&mt('Conditions can be IP-based, in which case no log-in is required').' '.
+ ''.&mt("Conditions can also be based on a user's status, in which case the user needs an account in the LON-CAPA network, and needs to be logged in.").' '."\n".
+ &mt('The status-based conditions can include affiliation with a particular course or community, or a user account in a specific domain.').' '."\n".
+ &mt('Alternatively access can be granted to people with specific LON-CAPA usernames and domains.').' ';
+}
+
+sub view_access_settings {
+ my ($r,$url,$access_controls,$aclcount) = @_;
+ my ($showstart,$showend);
+ my %todisplay;
+ foreach my $key (sort(keys(%{$access_controls}))) {
+ my ($num,$scope,$end,$start) = &unpack_acc_key($key);
+ $todisplay{$scope}{$key} = $$access_controls{$key};
+ }
+ if ($aclcount) {
+ $r->print(''.&mt('Current access controls defined for this file:').' ');
+ $r->print(&Apache::loncommon::start_data_table());
+ $r->print(&Apache::loncommon::start_data_table_header_row());
+ $r->print(''.&mt('Access control').' '.&mt('Dates available').
+ ' '.&mt('Additional information').' ');
+ $r->print(&Apache::loncommon::end_data_table_header_row());
+ my $count = 1;
+ my $chg = 'none';
+ &build_access_summary($r,$count,$chg,%todisplay);
+ $r->print(&Apache::loncommon::end_data_table());
+ } else {
+ $r->print(&mt('No access control settings currently exist for this file.').' ');
+ }
+ my %anchor_fields = (
+ 'currentpath' => $env{'form.currentpath'}
+ );
+ $r->print(' '.&make_anchor($url, \%anchor_fields, &mt('Return to directory')));
+ return;
+}
+
+sub build_access_summary {
+ my ($r,$count,$chg,%todisplay) = @_;
+ my ($showstart,$showend);
+ my %scope_desc = (
+ public => 'Public',
+ guest => 'Passphrase-protected',
+ domains => 'Conditional: domain-based',
+ users => 'Conditional: user-based',
+ course => 'Conditional: course/community-based',
+ ip => 'Conditional: IP-based',
+ );
+ my @allscopes = ('public','guest','domains','users','course','ip');
+ foreach my $scope (@allscopes) {
+ if ((!(exists($todisplay{$scope}))) || (ref($todisplay{$scope}) ne 'HASH')) {
+ next;
+ }
+ foreach my $key (sort(keys(%{$todisplay{$scope}}))) {
+ if ($count) {
+ $r->print(&Apache::loncommon::start_data_table_row());
+ }
+ my ($num,$scope,$end,$start) = &unpack_acc_key($key);
+ my $content = $todisplay{$scope}{$key};
+ if ($chg eq 'delete') {
+ $showstart = &mt('Deleted');
+ $showend = $showstart;
+ } else {
+ $showstart = &Apache::lonlocal::locallocaltime($start);
+ if ($end == 0) {
+ $showend = &mt('No end date');
+ } else {
+ $showend = &Apache::lonlocal::locallocaltime($end);
+ }
+ }
+ $r->print(''.&mt($scope_desc{$scope}));
+ my $crstype;
+ if ($scope eq 'course') {
+ if ($chg ne 'delete') {
+ my $cid = $content->{'domain'}.'_'.$content->{'number'};
+ my %course_description = &Apache::lonnet::coursedescription($cid);
+ $r->print(' ('.$course_description{'description'}.')');
+ $crstype = 'Course';
+ if ($course_description{'type'} ne '') {
+ $crstype = $course_description{'type'};
+ }
+ }
+ }
+ $r->print(' '.&mt('Start: ').$showstart.
+ ' '.&mt('End: ').$showend.' ');
+ if ($chg ne 'delete') {
+ if ($scope eq 'guest') {
+ $r->print(&mt('Passphrase').': '.$content->{'password'});
+ } elsif ($scope eq 'course') {
+ $r->print('');
+ $r->print(''.&mt('Roles').' '.
+ &mt('Access').' '.
+ &mt('Sections').' ');
+ $r->print(''.&mt('Groups').' ');
+ $r->print(' ');
+ foreach my $id (sort(keys(%{$content->{'roles'}}))) {
+ $r->print('');
+ foreach my $item ('role','access','section','group') {
+ $r->print('');
+ if ($item eq 'role') {
+ my $role_output;
+ foreach my $role (@{$content->{'roles'}{$id}{$item}}) {
+ if ($role eq 'all') {
+ $role_output .= $role.',';
+ } elsif ($role =~ /^cr/) {
+ $role_output .= (split('/',$role))[3].',';
+ } else {
+ $role_output .= &Apache::lonnet::plaintext($role,$crstype).',';
+ }
+ }
+ $role_output =~ s/,$//;
+ $r->print($role_output);
+ } else {
+ $r->print(join(',',@{$content->{'roles'}{$id}{$item}}));
+ }
+ $r->print(' ');
+ }
+ $r->print(' ');
+ }
+ $r->print('
');
+ } elsif ($scope eq 'domains') {
+ $r->print(&mt('Domains: ').join(',',@{$content->{'dom'}}));
+ } elsif ($scope eq 'users') {
+ my $curr_user_list = &sort_users($content->{'users'});
+ $r->print(&mt('Users: ').$curr_user_list);
+ } elsif ($scope eq 'ip') {
+ my $curr_ips_list = &sort_ips($content->{'ip'});
+ $r->print(&mt('IP(s): ').$curr_ips_list);
+ } else {
+ $r->print(' ');
+ }
+ } else {
+ $r->print(' ');
+ }
+ $r->print(' ');
+ $r->print(&Apache::loncommon::end_data_table_row());
+ $count ++;
+ }
+ }
+}
+
+
+sub update_access {
+ my ($r,$url,$group,$port_path) = @_;
+ my $totalprocessed = 0;
+ my %processing;
+ my %title = (
+ 'activate' => 'New control(s) added',
+ 'delete' => 'Existing control(s) deleted',
+ 'update' => 'Existing control(s) modified',
+ );
+ my $changes;
+ foreach my $chg (sort(keys(%title))) {
+ @{$processing{$chg}} = &Apache::loncommon::get_env_multiple('form.'.$chg);
+ $totalprocessed += @{$processing{$chg}};
+ foreach my $num (@{$processing{$chg}}) {
+ my $scope = $env{'form.scope_'.$num};
+ my ($start,$end) = &get_dates_from_form($num);
+ my $newkey = $num.':'.$scope.'_'.$end.'_'.$start;
+ if ($chg eq 'delete') {
+ $$changes{$chg}{$newkey} = 1;
+ } else {
+ $$changes{$chg}{$newkey} =
+ &build_access_record($num,$scope,$start,$end,$chg);
+ }
+ }
+ }
+ my $file_name = $env{'form.currentpath'}.$env{'form.selectfile'};
+ $r->print(''.&mt('Allowing others to retrieve file: [_1]',
+ ''.$port_path.$file_name.' ').' '."\n");
+ $file_name = &prepend_group($file_name);
+ my ($uname,$udom) = &get_name_dom($group);
+ my ($errors,$outcome,$deloutcome,$new_values,$translation);
+ if ($totalprocessed) {
+ ($outcome,$deloutcome,$new_values,$translation) =
+ &Apache::lonnet::modify_access_controls($file_name,$changes,$udom,
+ $uname);
+ }
+ my $current_permissions = &Apache::lonnet::get_portfile_permissions($udom,
+ $uname);
+ my %access_controls =
+ &Apache::lonnet::get_access_controls($current_permissions,
+ $group,$file_name);
+ if ($totalprocessed) {
+ if ($outcome eq 'ok') {
+ my $updated_controls = $access_controls{$file_name};
+ my ($showstart,$showend);
+ $r->print(&Apache::loncommon::start_data_table());
+ $r->print(&Apache::loncommon::start_data_table_header_row());
+ $r->print(''.&mt('Type of change').' '.
+ &mt('Access control').' '.&mt('Dates available').
+ ' '.&mt('Additional information').' ');
+ $r->print(&Apache::loncommon::end_data_table_header_row());
+ foreach my $chg (sort(keys(%processing))) {
+ if (@{$processing{$chg}} > 0) {
+ if ($chg eq 'delete') {
+ if (!($deloutcome eq 'ok')) {
+ $errors .=''.
+ &mt('A problem occurred deleting access controls: [_1]',$deloutcome).
+ ' ';
+ next;
+ }
+ }
+ my $numchgs = @{$processing{$chg}};
+ $r->print(&Apache::loncommon::start_data_table_row());
+ $r->print(''.&mt($title{$chg}).
+ '. ');
+ my $count = 0;
+ my %todisplay;
+ foreach my $key (sort(keys(%{$$changes{$chg}}))) {
+ my ($num,$scope,$end,$start) = &unpack_acc_key($key);
+ my $newkey = $key;
+ if ($chg eq 'activate') {
+ $newkey =~ s/^(\d+)/$$translation{$1}/;
+ }
+ $todisplay{$scope}{$newkey} = $$updated_controls{$newkey};
+ }
+ &build_access_summary($r,$count,$chg,%todisplay);
+ }
+ }
+ $r->print(&Apache::loncommon::end_data_table());
+ } else {
+ if ((@{$processing{'activate'}} > 0) || (@{$processing{'update'}} > 0)) {
+ $errors .= ''.
+ &mt('A problem occurred saving access control settings: [_1]',$outcome).
+ ' ';
+ }
+ }
+ if ($errors) {
+ $r->print($errors);
+ }
+ }
+ my $allnew = 0;
+ my $totalnew = 0;
+ my $status = 'new';
+ my ($firstitem,$lastitem);
+ my @types = ('course','domains','users','ip');
+ foreach my $newitem (@types) {
+ $allnew += $env{'form.new'.$newitem};
+ }
+ if ($allnew > 0) {
+ my $now = time;
+ my $then = $now + (60*60*24*180); # six months approx.
+ &open_form($r,$url);
+ my %showtypes = (
+ course => 'course/community',
+ domains => 'domain',
+ users => 'user',
+ ip => 'IP',
+ );
+ foreach my $newitem (@types) {
+ next if ($env{'form.new'.$newitem} <= 0);
+ $r->print(
+ ''
+ .&mt('Add new [_1]'.$showtypes{$newitem}.'-based[_2] access control for portfolio file: [_3]',
+ '',' ',
+ ''
+ .$env{'form.currentpath'}.$env{'form.selectfile'}.' ')
+ .'
');
+ $firstitem = $totalnew;
+ $lastitem = $totalnew + $env{'form.new'.$newitem};
+ $totalnew = $lastitem;
+ my @numbers;
+ for (my $i=$firstitem; $i<$lastitem; $i++) {
+ push(@numbers,$i);
+ }
+ &display_access_row($r,$status,$newitem,\@numbers,
+ $access_controls{$file_name},$now,$then);
+ }
+ &close_form($r,$url);
+ } else {
+ my %anchor_fields = (
+ 'currentpath' => $env{'form.currentpath'},
+ 'access' => $env{'form.selectfile'}
+ );
+ my @actions;
+ push(@actions, &make_anchor($url, \%anchor_fields, &mt('Display all access settings for this file')));
+ delete $anchor_fields{'access'};
+ push(@actions, &make_anchor($url,\%anchor_fields,&mt('Return to directory')));
+ $r->print(' '.&Apache::lonhtmlcommon::actionbox(\@actions));
+ }
+ return;
+}
+
+sub build_access_record {
+ my ($num,$scope,$start,$end,$chg) = @_;
+ my $record = {
+ type => $scope,
+ time => {
+ start => $start,
+ end => $end
+ },
+ };
+
+ if ($scope eq 'guest') {
+ $record->{'password'} = $env{'form.password'};
+ } elsif ($scope eq 'course') {
+ $record->{'domain'} = $env{'form.crsdom_'.$num};
+ $record->{'number'} = $env{'form.crsnum_'.$num};
+ my @role_ids;
+ my @delete_role_ids =
+ &Apache::loncommon::get_env_multiple('form.delete_role_'.$num);
+ my @preserves =
+ &Apache::loncommon::get_env_multiple('form.preserve_role_'.$num);
+ if (@delete_role_ids) {
+ foreach my $id (@preserves) {
+ if (grep {$_ = $id} (@delete_role_ids)) {
+ next;
+ }
+ push(@role_ids,$id);
+ }
} 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
+ push(@role_ids,@preserves);
}
- # now grab the directory list again, for the first time
- @dir_list=&Apache::lonnet::dirlist($current_path,
- $ENV{'user.domain'},
- $ENV{'user.name'},$portfolio_root);
- }
- # need to know if directory is empty so it can be removed if desired
- my $is_empty=(@dir_list == 2);
- &display_file_select($r,$current_path,$is_empty,\@dir_list);
- $r->print("