--- loncom/interface/portfolio.pm 2006/06/26 22:23:27 1.121
+++ loncom/interface/portfolio.pm 2006/11/06 20:02:58 1.171
@@ -1,3 +1,8 @@
+# The LearningOnline Network
+# portfolio browser
+#
+# $Id: portfolio.pm,v 1.171 2006/11/06 20:02:58 rezaferry Exp $
+#
# Copyright Michigan State University Board of Trustees
#
# This file is part of the LearningOnline Network with CAPA (LON-CAPA).
@@ -31,32 +36,56 @@ use Apache::lonfeedback;
use Apache::lonlocal;
use Apache::lonnet;
use Apache::longroup;
+use Apache::lonhtmlcommon;
use HTML::Entities;
use LONCAPA;
+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;
+}
+
+sub group_form_data {
+ my $output;
+ if (defined($env{'form.group'})) {
+ $output = '';
+ if (exists($env{'form.ref'})) {
+ $output .= '';
+ }
+ }
+ return $output;
+}
+
# 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.'';
+ 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_common {
- my ($r,$url,$current_path,$is_empty,$dir_list,$group,$can_upload)=@_;
- my $namespace = &get_namespace($group);
- my $port_path = &get_port_path($group);
+ my ($r,$url,$current_path,$is_empty,$dir_list,$can_upload)=@_;
+ my $namespace = &get_namespace();
+ my $port_path = &get_port_path();
if ($can_upload) {
- my $groupitem;
- if (defined($group)) {
- $groupitem = '';
- }
+ my $groupitem = &group_form_data();
+
my $iconpath= $r->dir_config('lonIconsURL') . "/";
my %text=&Apache::lonlocal::texthash(
'upload' => 'Upload',
@@ -66,6 +95,13 @@ sub display_common {
'createdir_label' =>
'Create subdirectory in current directory:');
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');
+
+ # FIXME: This line should be deleted once Portfolio uses breadcrumbs
+ $r->print(&Apache::loncommon::help_open_topic('Portfolio About', 'Help on the portfolio'));
+
+
$r->print(<<"TABLE");
@@ -80,7 +116,7 @@ sub display_common {
-
+ $help_fileupload
');
+ $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();
+ 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::grades::file_name_version_ext($fullpath);
+ $fname =~ s|^/||;
+ $anchor_fields{'showversions'} = $fname.'.'.$extension;
+ }
+ $lock_info = &make_anchor(undef,\%anchor_fields,$lock_info);
+ }
+ $r->print('
';
return $result;
}
sub delete {
- my ($r,$url,$group)=@_;
+ my ($r,$url)=@_;
my @check;
my $file_name = $env{'form.currentpath'}.$env{'form.selectfile'};
- $file_name = &prepend_group($file_name,$group);
+ $file_name = &prepend_group($file_name);
my @files=&Apache::loncommon::get_env_multiple('form.selectfile');
- my ($uname,$udom) = &get_name_dom($group);
+ my ($uname,$udom) = &get_name_dom();
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));
+ $r->print("The file is locked and cannot be deleted. ");
+ $r->print(&done('Back',$url));
} else {
if (scalar(@files)) {
&open_form($r,$url);
$r->print('
');
- &close_form($r,$url,$group);
+ &close_form($r,$url);
} else {
$r->print("No file was checked to delete. ");
- $r->print(&done(undef,$url,$group));
+ $r->print(&done(undef,$url));
}
}
}
@@ -420,34 +558,71 @@ 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);
+ my ($uname,$udom) = &get_name_dom();
+ my $port_path = &get_port_path();
+ my $current_permissions = &Apache::lonnet::get_portfile_permissions($udom,
+ $uname);
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(''.
+ &mt('An error occured ([_1]) while trying to delete
+ [_2].',$result,&display_file(undef, $delete_file)).
+ '
');
+ } else {
+ $r->print(&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') {
+ $r->print(' '.&mt("An error occured ([_1]) while ".
+ "trying to delete access controls for the file.",$outcome).
+ '
');
+ } else {
+ if ($deloutcome eq 'ok') {
+ $r->print(' '.&mt('Access controls also deleted for the file.').'
');
+ } else {
+ $r->print(''.' '.
+ &mt("An error occured ([_1]) while ".
+ "trying to delete access controls for the file.",$deloutcome).
+ '
');
+ }
+ }
+ }
+ }
}
}
- $r->print(&done(undef,$url,$group));
+ $r->print(&done(undef,$url));
}
sub delete_dir {
- my ($r,$url,$group)=@_;
+ my ($r,$url)=@_;
&open_form($r,$url);
$r->print('
'.&mt('Delete').' '.&display_file().'?
');
- &close_form($r,$url,$group);
+ &close_form($r,$url);
}
sub delete_dir_confirmed {
- my ($r,$url,$group)=@_;
+ my ($r,$url)=@_;
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 ($uname,$udom) = &get_name_dom();
+ my $namespace = &get_namespace();
+ my $port_path = &get_port_path();
my $result=&Apache::lonnet::removeuserfile($uname,$udom,$port_path.
$directory_name);
@@ -467,87 +642,165 @@ sub delete_dir_confirmed {
}
$env{'form.currentpath'} = $directory_name;
}
- $r->print(&done(undef,$url,$group));
+ $r->print(&done(undef,$url));
}
sub rename {
- my ($r,$url,$group)=@_;
+ my ($r,$url)=@_;
my $file_name = $env{'form.currentpath'}.$env{'form.rename'};
- my ($uname,$udom) = &get_name_dom($group);
- $file_name = &prepend_group($file_name,$group);
+ my ($uname,$udom) = &get_name_dom();
+ $file_name = &prepend_group($file_name);
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));
+ $r->print("The file is locked and cannot be renamed. ");
+ $r->print(&done(undef,$url));
} else {
&open_form($r,$url);
$r->print('
'.&mt('Rename').' '.&display_file().' to
?
');
- &close_form($r,$url,$group);
+ &close_form($r,$url);
}
}
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);
+ my ($uname,$udom) = &get_name_dom();
+ my $port_path = &get_port_path();
if ($filenewname eq '') {
$r->print(''.
&mt("Error: no valid filename was provided to rename to.").
' ');
- $r->print(&done(undef,$url,$group));
+ $r->print(&done(undef,$url));
return;
}
+ my $chg_access;
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') {
+ if ($result eq 'ok') {
+ $chg_access = &access_for_renamed($filenewname,$group,$udom,$uname);
+ } else {
$r->print(''.
- &mt('An errror occured ([_1]) while trying to rename [_2]'
+ &mt('An error occured ([_1]) while trying to rename [_2]'
.' to [_3]',$result,&display_file(),
&display_file('',$filenewname)).' ');
+ return;
}
if ($filenewname ne $env{'form.filenewname'}) {
$r->print(&mt("The new file name was changed from: [_1] to [_2]",
''.&display_file('',$env{'form.filenewname'}).'',
''.&display_file('',$filenewname).''));
}
- $r->print(&done(undef,$url,$group));
+ $r->print($chg_access);
+ $r->print(&done(undef,$url));
+}
+
+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 occured ([_1]) while ".
+ "trying to delete access control records for the old name.",$outcome).
+ ' ';
+ } else {
+ if ($deloutcome ne 'ok') {
+ $chg_text = '
'.
+ &mt("An error occured ([_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 occured ([_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) = @_;
- my ($uname,$udom) = &get_name_dom($group);
+ my ($r,$url,$group,$can_setacl,$port_path,$action) = @_;
+ my ($uname,$udom) = &get_name_dom();
my $file_name = $env{'form.currentpath'}.$env{'form.access'};
- $file_name = &prepend_group($file_name,$group);
+ $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 = '
'.&mt('Allowing others to retrieve portfolio file: [_1]',$env{'form.currentpath'}.$env{'form.access'}).'
';
- my $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.').'
'.&mt('Public files are available to anyone without the need for login.').'
'.&mt('Passphrase-protected files do not require log-in, but will require the viewer to enter the passphrase you set.').'
'.&mt('Conditional files are accessible to logged-in users with accounts in the LON-CAPA network, who satisfy the conditions you set.').' '.&mt('The conditions can include affiliation with a particular course or group, or a user account in a specific domain.').' '.&mt('Alternatively access can be granted to people with specific LON-CAPA usernames and domains.').'
';
+ 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 .= '
'.&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);
- &access_setting_table($r,$access_controls{$file_name});
+ $r->print(' '.&Apache::loncommon::help_open_topic('Portfolio ShareFile SetAccess', 'Help on setting up share access'));
+ $r->print(&Apache::loncommon::help_open_topic('Portfolio ShareFile ChangeSetting', 'Help on changing settings'));
+ $r->print(&Apache::loncommon::help_open_topic('Portfolio ShareFile StopAccess', '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('Back to directory listing'),
};
- &close_form($r,$url,$group,$button_text);
+ &close_form($r,$url,$button_text);
} else {
$r->print($header);
if ($aclcount) {
$r->print($info);
}
- &view_access_settings($r,$url,$group,$access_controls{$file_name},
- $aclcount);
+ &view_access_settings($r,$url,$access_controls{$file_name},$aclcount);
}
}
+sub explain_conditionals {
+ return
+ &mt('Conditional files are accessible to logged-in users with accounts in the LON-CAPA network, who satisfy the conditions you set.').' '."\n".
+ &mt('The conditions can include affiliation with a particular course, 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,$group,$access_controls,$aclcount) = @_;
+ my ($r,$url,$access_controls,$aclcount) = @_;
my ($showstart,$showend);
my %todisplay;
foreach my $key (sort(keys(%{$access_controls}))) {
@@ -568,12 +821,10 @@ sub view_access_settings {
} else {
$r->print(&mt('No access control settings currently exist for this file. ' ));
}
- my $group_arg;
- if ($group) {
- $group_arg = '&group='.$group;
- }
- $r->print(' '.&mt('Return to directory listing').'');
+ my %anchor_fields = (
+ 'currentpath' => $env{'form.currentpath'}
+ );
+ $r->print(' '.&make_anchor($url, \%anchor_fields, &mt('Return to directory listing')));
return;
}
@@ -586,9 +837,8 @@ sub build_access_summary {
domains => 'Conditional: domain-based',
users => 'Conditional: user-based',
course => 'Conditional: course-based',
- group => 'Conditional: group-based',
);
- my @allscopes = ('public','guest','domains','users','course','group');
+ my @allscopes = ('public','guest','domains','users','course');
foreach my $scope (@allscopes) {
if ((!(exists($todisplay{$scope}))) || (ref($todisplay{$scope}) ne 'HASH')) {
next;
@@ -611,7 +861,7 @@ sub build_access_summary {
}
}
$r->print('
'.&mt($scope_desc{$scope}));
- if (($scope eq 'course') || ($scope eq 'group')) {
+ if ($scope eq 'course') {
if ($chg ne 'delete') {
my $cid = $content->{'domain'}.'_'.$content->{'number'};
my %course_description = &Apache::lonnet::coursedescription($cid);
@@ -623,16 +873,12 @@ sub build_access_summary {
if ($chg ne 'delete') {
if ($scope eq 'guest') {
$r->print(&mt('Passphrase').': '.$content->{'password'});
- } elsif ($scope eq 'course' || $scope eq 'group') {
+ } elsif ($scope eq 'course') {
$r->print('
');
$r->print('
'.&mt('Roles').'
'.
&mt('Access').'
'.
&mt('Sections').'
');
- if ($scope eq 'course') {
- $r->print('
'.&mt('Groups').'
');
- } else {
- $r->print('
'.&mt('Teams').'
');
- }
+ $r->print('
'.&mt('Groups').'
');
$r->print('
');
foreach my $id (sort(keys(%{$content->{'roles'}}))) {
$r->print('