# The LearningOnline Network
# portfolio browser
#
# $Id: portfolio.pm,v 1.168 2006/11/01 16:09:04 albertel Exp $
#
# 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;
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, $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,$can_upload)=@_;
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 %text=&Apache::lonlocal::texthash(
'upload' => 'Upload',
'upload_label' =>
'Upload file to current directory:',
'createdir' => 'Create Subdirectory',
'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");
');
$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('
'.$/);
}
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') . "/";
my $display_out;
my $select_mode;
my $checked_files;
my $port_path = &get_port_path();
my ($uname,$udom) = &get_name_dom();
my $access_admin_text = &mt('View Status');
if ($can_setacl) {
$access_admin_text = &mt('View/Change Status');
}
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);
$checked_files =&Apache::lonnet::files_in_path($uname,$env{'form.currentpath'});
$select_mode = 'true';
}
if ($is_empty && ($current_path ne '/') && $can_delete) {
$display_out = '';
$r->print($display_out);
return;
}
if ($select_mode eq 'true') {
$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,$button_text)=@_;
if (!defined($button_text)) {
$button_text = {
'continue' => &mt('Continue'),
'cancel' => &mt('Cancel'),
};
}
$r->print('
');
$r->print(&group_form_data().'
');
$r->print('
'.
&group_form_data());
$r->print("\n".'
');
}
sub display_file {
my ($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 {
my ($message,$url)=@_;
unless (defined $message) {
$message='Done';
}
my %anchor_fields = (
'showversions' => $env{'form.showversions'},
'currentpath' => $env{'form.currentpath'},
'fieldname' => $env{'form.fieldname'},
'mode' => $env{'form.mode'}
);
my $result = '
';
return $result;
}
sub delete {
my ($r,$url)=@_;
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();
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));
} else {
if (scalar(@files)) {
&open_form($r,$url);
$r->print('
');
&close_form($r,$url);
} else {
$r->print("No file was checked to delete. ");
$r->print(&done(undef,$url));
}
}
}
sub delete_confirmed {
my ($r,$url,$group)=@_;
my @files=&Apache::loncommon::get_env_multiple('form.selectfile');
my $result;
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(''.
&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));
}
sub delete_dir {
my ($r,$url)=@_;
&open_form($r,$url);
$r->print('
'.&mt('Delete').' '.&display_file().'?
');
&close_form($r,$url);
}
sub delete_dir_confirmed {
my ($r,$url)=@_;
my $directory_name = $env{'form.currentpath'};
$directory_name =~ s|/$||; # remove any trailing slash
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);
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));
}
sub rename {
my ($r,$url)=@_;
my $file_name = $env{'form.currentpath'}.$env{'form.rename'};
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));
} else {
&open_form($r,$url);
$r->print('
'.&mt('Rename').' '.&display_file().' to
?
');
&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();
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));
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 eq 'ok') {
$chg_access = &access_for_renamed($filenewname,$group,$udom,$uname);
} else {
$r->print(''.
&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($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,$port_path) = @_;
my ($uname,$udom) = &get_name_dom();
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 = '
'.&mt('Allowing others to retrieve file: [_1]',$port_path.$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.');
$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 files are accessible to logged-in users with accounts in the LON-CAPA network, who satisfy the conditions you set.').' ';
$info .= &mt('The conditions can include affiliation with a particular course or group, or a user account in a specific domain.').' ';
$info .= &mt('Alternatively access can be granted to people with specific LON-CAPA usernames and domains.').'
';
if ($group eq '') {
$info .= (&mt("A listing of files viewable without log-in is available at: http://$ENV{'SERVER_NAME'}/adm/$udom/$uname/aboutme/portfolio. For logged in users a 'Display file listing' link will also appear (when there are viewable files) on your personal information page: http://$ENV{'SERVER_NAME'}/adm/$udom/$uname/aboutme "));
}
if ($can_setacl) {
&open_form($r,$url);
$r->print($header.$info);
$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,$access_controls{$file_name});
my $button_text = {
'continue' => &mt('Proceed'),
'cancel' => &mt('Back to directory listing'),
};
&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 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('
');
$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();
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 storing access control settings: [_1]',$outcome).
'';
}
}
if ($errors) {
$r->print($errors);
}
}
my $allnew = 0;
my $totalnew = 0;
my $status = 'new';
my ($firstitem,$lastitem);
foreach my $newitem ('course','group','domains','users') {
$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);
foreach my $newitem ('course','group','domains','users') {
if ($env{'form.new'.$newitem} > 0) {
$r->print(' '.&mt('Add new [_1]-based access control for portfolio file: [_2]',$newitem,$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'}
);
$r->print(' '.&make_anchor($url, \%anchor_fields, &mt('Display all access settings for this file')));
delete $anchor_fields{'access'};
$r->print(' '.&make_anchor($url,\%anchor_fields,&mt('Return to directory listing')));
}
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') || ($scope eq 'group')) {
$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 {
push(@role_ids,@preserves);
}
my $next_id = $env{'form.add_role_'.$num};
if ($next_id) {
push(@role_ids,$next_id);
}
foreach my $id (@role_ids) {
my (@roles,@accesses,@sections,@groups);
if (($id == $next_id) && ($chg eq 'update')) {
@roles = split(/,/,$env{'form.role_'.$num.'_'.$next_id});
@accesses = split(/,/,$env{'form.access_'.$num.'_'.$next_id});
@sections = split(/,/,$env{'form.section_'.$num.'_'.$next_id});
@groups = split(/,/,$env{'form.group_'.$num.'_'.$next_id});
} else {
@roles = &Apache::loncommon::get_env_multiple('form.role_'.$num.'_'.$id);
@accesses = &Apache::loncommon::get_env_multiple('form.access_'.$num.'_'.$id);
@sections = &Apache::loncommon::get_env_multiple('form.section_'.$num.'_'.$id);
@groups = &Apache::loncommon::get_env_multiple('form.group_'.$num.'_'.$id);
}
$record->{'roles'}{$id}{'role'} = \@roles;
$record->{'roles'}{$id}{'access'} = \@accesses;
$record->{'roles'}{$id}{'section'} = \@sections;
$record->{'roles'}{$id}{'group'} = \@groups;
}
} elsif ($scope eq 'domains') {
my @doms = &Apache::loncommon::get_env_multiple('form.dom_'.$num);
$record->{'dom'} = \@doms;
} elsif ($scope eq 'users') {
my $userlist = $env{'form.users_'.$num};
$userlist =~ s/\s+//sg;
my %userhash = map { ($_,1) } (split(/,/,$userlist));
foreach my $user (keys(%userhash)) {
my ($uname,$udom) = split(/:/,$user);
push(@{$record->{'users'}}, {
'uname' => $uname,
'udom' => $udom
});
}
}
return $record;
}
sub get_dates_from_form {
my ($id) = @_;
my $startdate;
my $enddate;
$startdate = &Apache::lonhtmlcommon::get_date_from_form('startdate_'.$id);
$enddate = &Apache::lonhtmlcommon::get_date_from_form('enddate_'.$id);
if ( exists ($env{'form.noend_'.$id}) ) {
$enddate = 0;
}
return ($startdate,$enddate);
}
sub sort_users {
my ($users) = @_;
my @curr_users = map {
$_->{'uname'}.':'.$_->{'udom'}
} (@{$users});
my $curr_user_list = join(",\n",sort(@curr_users));
return $curr_user_list;
}
sub access_setting_table {
my ($r,$access_controls) = @_;
my ($public,$publictext);
$publictext = &mt('Off');
my ($guest,$guesttext);
$guesttext = &mt('Off');
my @courses = ();
my @groups = ();
my @domains = ();
my @users = ();
my $now = time;
my $then = $now + (60*60*24*180); # six months approx.
my ($num,$scope,$publicnum,$guestnum);
my (%acl_count,%end,%start);
foreach my $key (sort(keys(%{$access_controls}))) {
($num,$scope,$end{$key},$start{$key}) = &unpack_acc_key($key);
if ($scope eq 'public') {
$public = $key;
$publicnum = $num;
$publictext = &acl_status($start{$key},$end{$key},$now);
} elsif ($scope eq 'guest') {
$guest=$key;
$guestnum = $num;
$guesttext = &acl_status($start{$key},$end{$key},$now);
} elsif ($scope eq 'course') {
push(@courses,$key);
} elsif ($scope eq 'group') {
push(@groups,$key);
} elsif ($scope eq 'domains') {
push(@domains,$key);
} elsif ($scope eq 'users') {
push(@users,$key);
}
$acl_count{$scope} ++;
}
$r->print('
');
$r->print(&Apache::loncommon::end_data_table_row());
}
$r->print(&Apache::loncommon::end_data_table());
} else {
$r->print(&mt('No [_1]-based conditions defined. ',$type).
&additional_item($type));
}
return;
}
sub course_js {
return qq|
|;
}
sub course_row {
my ($r,$status,$type,$item,$access_controls,$now,$then) = @_;
my $content;
my $defdom = $env{'user.domain'};
if ($status eq 'old') {
$content = $$access_controls{$item};
$defdom = $content->{'domain'};
}
my $js = &Apache::loncommon::coursebrowser_javascript($defdom)
.&course_js();
my $crsgrptext = 'Groups';
if ($type eq 'group') {
$crsgrptext = 'Teams';
}
my $uctype = $type;
$uctype =~ s/^(\w)/uc($1)/e;
my ($num,$scope,$end,$start) = &set_identifiers($status,$item,$now,$then,
$type);
$r->print('
'.$js.&actionbox($status,$num,$scope).'
');
if ($status eq 'old') {
my $cid = $content->{'domain'}.'_'.$content->{'number'};
my %course_description = &Apache::lonnet::coursedescription($cid);
$r->print('
');
if ($status eq 'old') {
my $max_id = 0;
foreach my $role_id (sort(keys(%{$content->{'roles'}}))) {
if ($role_id > $max_id) {
$max_id = $role_id;
}
$max_id ++;
my $role_selects = &role_selectors($num,$role_id,$status,$type,$content,'display');
$r->print('
'.$role_selects.'
');
}
$r->print('
'.&mt('Add a roles-based condition').' {'domain'}','$content->{'number'}','$uctype'".')" value="'.$max_id.'" />
');
} elsif ($status eq 'new') {
my $role_id = 1;
my $role_selects = &role_selectors($num,$role_id,$status,$type,undef,'display');
$r->print('
'.&mt('Add').'
'.$role_selects);
$r->print('
');
}
return;
}
sub domains_row {
my ($r,$status,$item,$all_doms,$access_controls,$now,$then) = @_;
my ($num,$scope,$end,$start) = &set_identifiers($status,$item,$now,$then,
'domains');
my $dom_select = '';
$r->print('
'.&actionbox($status,$num,$scope).'
'.$dom_select.
'
'.&dateboxes($num,$start,$end).'
');
}
sub users_row {
my ($r,$status,$item,$access_controls,$now,$then) = @_;
my ($num,$scope,$end,$start) = &set_identifiers($status,$item,$now,$then,
'users');
my $curr_user_list;
if ($status eq 'old') {
my $content = $$access_controls{$item};
$curr_user_list = &sort_users($content->{'users'});
}
$r->print('
'.&actionbox($status,$num,$scope).'
'.&mt("Format for users' username:domain information:").' sparty:msu,illini:uiuc ... etc.
'.&dateboxes($num,$start,$end).'
');
}
sub additional_item {
my ($type) = @_;
my $output = &mt('Add new [_1] condition(s)?',$type).' '.&mt('Number to add: ').'';
return $output;
}
sub actionbox {
my ($status,$num,$scope) = @_;
my $output = ' '.
'';
return $output;
}
sub dateboxes {
my ($num,$start,$end) = @_;
my $noend;
if ($end == 0) {
$noend = 'checked="checked"';
}
my $startdate = &Apache::lonhtmlcommon::date_setter('portform',
'startdate_'.$num,$start,undef,undef,undef,1,undef,
undef,undef,1);
my $enddate = &Apache::lonhtmlcommon::date_setter('portform',
'enddate_'.$num,$end,undef,undef,undef,1,undef,
undef,undef,1). ' ';
my $output = &mt('Start: ').$startdate.' '.&mt('End: ').$enddate;
return $output;
}
sub unpack_acc_key {
my ($acc_key) = @_;
my ($num,$scope,$end,$start) = ($acc_key =~ /^([^:]+):([a-z]+)_(\d*)_?(\d*)$/);
return ($num,$scope,$end,$start);
}
sub set_identifiers {
my ($status,$item,$now,$then,$scope) = @_;
if ($status eq 'old') {
return(&unpack_acc_key($item));
} else {
return($item,$scope,$then,$now);
}
}
sub role_selectors {
my ($num,$role_id,$status,$type,$content,$caller) = @_;
my ($output,$cdom,$cnum,$longid);
if ($caller eq 'display') {
$longid = '_'.$num.'_'.$role_id;
if ($status eq 'new') {
foreach my $item ('role','access','section','group') {
$output .= '
';
return $output;
}
sub role_options_window {
my ($r) = @_;
my $cdom = $env{'form.cdom'};
my $cnum = $env{'form.cnum'};
my $type = $env{'form.type'};
my $addindex = $env{'form.setroles'};
my $grouptitle = 'Groups';
if ($type eq 'Group') {
$grouptitle = 'Teams';
}
my $role_selects = &role_selectors(1,1,'new',$type,undef,'rolepicker');
$r->print(<<"END_SCRIPT");
END_SCRIPT
$r->print(&mt('Select roles, course status, section(s) and group(s) for users who will be able to access the portfolio file.'));
$r->print('
'.&mt('Roles').'
'.&mt('[_1] status',$type).'
'.&mt('Sections').'
'.&mt($grouptitle).'
'.$role_selects.'
');
return;
}
sub select_files {
my ($r) = @_;
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
if (defined($group)) {
my $grp_quota = &get_group_quota($group); # quota expressed in k
if ($grp_quota ne '') {
$disk_quota = $grp_quota;
} else {
$disk_quota = 0;
}
}
$fname=&Apache::lonnet::clean_filename($fname);
my $portfolio_root=&get_portfolio_root();
my ($uname,$udom) = &get_name_dom();
my $port_path = &get_port_path();
# Fixme --- Move the checking for existing file to LOND error return
my @dir_list=&get_dir_list($portfolio_root);
my $found_file = 0;
my $locked_file = 0;
foreach my $line (@dir_list) {
my ($file_name)=split(/\&/,$line,2);
if ($file_name eq $fname){
$file_name = $env{'form.currentpath'}.$file_name;
$file_name = &prepend_group($file_name);
$found_file = 1;
if (&Apache::lonnet::is_locked($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));
}
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));
} 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));
}
} else {
my $result=&Apache::lonnet::userfileupload('uploaddoc','',
$port_path.$env{'form.currentpath'});
if ($result !~ m|^/uploaded/|) {
$r->print(''.'An errror occured ('.$result.
') while trying to upload '.&display_file().' ');
$r->print(&done('Back',$url));
} else {
$r->print(&done(undef,$url));
}
}
}
sub lock_info {
my ($r,$url,$group) = @_;
my ($uname,$udom) = &get_name_dom();
my $current_permissions = &Apache::lonnet::get_portfile_permissions($udom,
$uname);
my $file_name = $env{'form.lockinfo'};
$file_name = &prepend_group($file_name);
if (defined($file_name) && defined($$current_permissions{$file_name})) {
foreach my $array_item (@{$$current_permissions{$file_name}}) {
next if (ref($array_item) ne 'ARRAY');
my $filetext;
if (defined($group)) {
$filetext = ''.$env{'form.lockinfo'}.
' (group: '.$group.')';
} else {
$filetext = ''.$file_name.'';
}
my $title =''.&Apache::lonnet::gettitle($$array_item[0]).
' ';
if ($$array_item[-1] eq 'graded') {
$r->print(&mt('[_1] was submitted in response to problem: [_2]',
$filetext,$title));
} elsif ($$array_item[-1] eq 'handback') {
$r->print(&mt('[_1] was handed back in response to problem: [_2]',
$filetext,$title));
} else {
# submission style lock
$r->print(&mt('[_1] was submitted in response to problem: [_2]',
$filetext,$title));
}
my %course_description =
&Apache::lonnet::coursedescription($$array_item[1]);
if ( $course_description{'description'} ne '') {
$r->print(&mt('In the course: [_1] ',
$course_description{'description'}));
}
}
}
$r->print(&done('Back',$url));
return 'ok';
}
sub createdir {
my ($r,$url)=@_;
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));
return;
}
my $portfolio_root = &get_portfolio_root();
my @dir_list=&get_dir_list($portfolio_root);
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();
my $port_path = &get_port_path();
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));
}
sub get_portfolio_root {
my ($udom,$uname,$group) = @_;
if (!(defined($udom)) || !(defined($uname))) {
($uname,$udom) = &get_name_dom();
}
my $path = '/userfiles/portfolio';
if (!defined($group)) {
if (defined($env{'form.group'})) {
$group = $env{'form.group'};
}
}
if (defined($group)) {
$path = '/userfiles/groups/'.$group.'/portfolio';
}
return (&Apache::loncommon::propath($udom,$uname).$path);
}
sub get_group_quota {
my ($group) = @_;
my $group_quota;
my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
my %curr_groups = &Apache::longroup::coursegroups($cdom,$cnum,$group);
if (%curr_groups) {
my %group_info = &Apache::longroup::get_group_settings(
$curr_groups{$group});
$group_quota = $group_info{'quota'}; #expressed in Mb
if ($group_quota) {
$group_quota = 1000 * $group_quota; #expressed in k
}
}
return $group_quota;
}
sub get_dir_list {
my ($portfolio_root) = @_;
my ($uname,$udom) = &get_name_dom();
return &Apache::lonnet::dirlist($env{'form.currentpath'},
$udom,$uname,$portfolio_root);
}
sub get_name_dom {
my ($uname,$udom);
if (defined($env{'form.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 prepend_group {
my ($filename) = @_;
if (defined($env{'form.group'})) {
$filename = $env{'form.group'}.$filename;
}
return $filename;
}
sub get_namespace {
my $namespace = 'portfolio';
if (defined($env{'form.group'})) {
my ($uname,$udom) = &get_name_dom();
$namespace .= '_'.$udom.'_'.$uname.'_'.$env{'form.group'};
}
return $namespace;
}
sub get_port_path {
my $port_path;
if (defined($env{'form.group'})) {
$port_path = "groups/$env{'form.group'}/portfolio";
} else {
$port_path = 'portfolio';
}
return $port_path;
}
sub missing_priv {
my ($r,$url,$priv) = @_;
my $longtext = {
upload => 'upload files',
delete => 'delete files',
rename => 'rename files',
setacl => 'set access controls for files',
};
my $escpath = &HTML::Entities::encode($env{'form.currentpath'},'&<>"');
my $rtnlink = 'print(&mt('in this portfolio.'));
}
$rtnlink .= '">'.&mt('Return to directory listing page').'';
$r->print(' '.$rtnlink);
$r->print(&Apache::loncommon::end_page());
return;
}
sub coursegrp_portfolio_header {
my ($cdom,$cnum,$grp_desc)=@_;
my $gpterm = &Apache::loncommon::group_term();
my $ucgpterm = $gpterm;
$ucgpterm =~ s/^(\w)/uc($1)/e;
if ($env{'form.ref'}) {
&Apache::lonhtmlcommon::add_breadcrumb
({href=>"/adm/coursegroups",
text=>"Groups",
title=>"Course Groups"});
}
&Apache::lonhtmlcommon::add_breadcrumb
({href=>"/adm/$cdom/$cnum/$env{'form.group'}/smppg?ref=$env{'form.ref'}",
text=>"$ucgpterm: $grp_desc",
title=>"Go to group's home page"},
{href=>"/adm/coursegrp_portfolio?".&group_args(),
text=>"Group Portfolio",
title=>"Display group portfolio"});
my $output = &Apache::lonhtmlcommon::breadcrumbs(
&mt('[_1] portfolio files - [_2]',$gpterm,$grp_desc));
return $output;
}
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','access','setnum',
'cnum','cdom','type','setroles','showversions','ref']);
my ($uname,$udom,$portfolio_root,$url,$caller,$title,$group,$grp_desc);
if ($r->uri =~ m|^(/adm/)([^/]+)|) {
$url = $1.$2;
$caller = $2;
}
my ($can_modify,$can_delete,$can_upload,$can_setacl);
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'}.($env{'request.course.sec'}?'/'.$env{'request.course.sec'}:''));
$env{'form.group'} =~ s/\W//g;
$group = $env{'form.group'};
if ($group) {
($uname,$udom) = &get_name_dom();
my %curr_groups = &Apache::longroup::coursegroups($udom,$uname,
$group);
if (%curr_groups) {
my %grp_content = &Apache::longroup::get_group_settings(
$curr_groups{$group});
$grp_desc = &unescape($grp_content{'description'});
if (($view_permission) || (&Apache::lonnet::allowed('rgf',
$env{'request.course.id'}.'/'.$group))) {
$portfolio_root = &get_portfolio_root();
} 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; }
if (&Apache::lonnet::allowed('mdg',$env{'request.course.id'})) {
$can_modify = 1;
$can_delete = 1;
$can_upload = 1;
$can_setacl = 1;
} else {
if (&Apache::lonnet::allowed('agf',$env{'request.course.id'}.'/'.$group)) {
$can_setacl = 1;
}
if (&Apache::lonnet::allowed('ugf',$env{'request.course.id'}.'/'.$group)) {
$can_upload = 1;
}
if (&Apache::lonnet::allowed('mgf',$env{'request.course.id'}.'/'.$group)) {
$can_modify = 1;
}
if (&Apache::lonnet::allowed('dgf',$env{'request.course.id'}.'/'.$group)) {
$can_delete = 1;
}
}
} else {
($uname,$udom) = &get_name_dom();
$portfolio_root = &get_portfolio_root();
$title = &mt('Portfolio Manager');
$can_modify = 1;
$can_delete = 1;
$can_upload = 1;
$can_setacl = 1;
}
my $port_path = &get_port_path();
&Apache::loncommon::no_cache($r);
&Apache::loncommon::content_type($r,'text/html');
$r->send_http_header;
# Give the LON-CAPA page header
if ($env{"form.mode"} eq 'selectfile'){
$r->print(&Apache::loncommon::start_page($title,undef,
{'only_body' => 1}));
} elsif ($env{'form.action'} eq 'rolepicker') {
$r->print(&Apache::loncommon::start_page('New role-based condition',undef,
{'no_nav_bar' => 1, }));
} else {
$r->print(&Apache::loncommon::start_page($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);
}
if ($env{'form.store'}) {
}
if ($env{'form.uploaddoc.filename'}) {
if ($can_upload) {
&upload($r,$url,$group);
} else {
&missing_priv($r,$url,'upload');
}
} elsif ($env{'form.action'} eq 'delete' && $env{'form.confirmed'}) {
if ($can_delete) {
&delete_confirmed($r,$url,$group);
} else {
&missing_priv($r,$url,'delete');
}
} elsif ($env{'form.action'} eq 'delete') {
if ($can_delete) {
&delete($r,$url);
} else {
&missing_priv($r,$url,'delete');
}
} elsif ($env{'form.action'} eq 'deletedir' && $env{'form.confirmed'}) {
if ($can_delete) {
&delete_dir_confirmed($r,$url);
} else {
&missing_priv($r,$url,'delete');
}
} elsif ($env{'form.action'} eq 'deletedir') {
if ($can_delete) {
&delete_dir($r,$url);
} else {
&missing_priv($r,$url,'delete');
}
} elsif ($env{'form.action'} eq 'rename' && $env{'form.confirmed'}) {
if ($can_modify) {
&rename_confirmed($r,$url,$group);
} else {
&missing_priv($r,$url,'rename');
}
} elsif ($env{'form.rename'}) {
$env{'form.selectfile'} = $env{'form.rename'};
$env{'form.action'} = 'rename';
if ($can_modify) {
&rename($r,$url);
} else {
&missing_priv($r,$url,'rename');
}
} elsif ($env{'form.access'}) {
$env{'form.selectfile'} = $env{'form.access'};
$env{'form.action'} = 'chgaccess';
&display_access($r,$url,$group,$can_setacl,$port_path);
} elsif ($env{'form.action'} eq 'chgaccess') {
if ($can_setacl) {
&update_access($r,$url,$group,$port_path);
} else {
&missing_priv($r,$url,'setacl');
}
} elsif ($env{'form.action'} eq 'rolepicker') {
if ($can_setacl) {
&role_options_window($r);
} else {
&missing_priv($r,$url,'setacl');
}
} elsif ($env{'form.createdir'}) {
if ($can_upload) {
&createdir($r,$url);
} else {
&missing_priv($r,$url,'upload');
}
} elsif ($env{'form.lockinfo'}) {
&lock_info($r,$url,$group);
} else {
my $current_path='/';
if ($env{'form.currentpath'}) {
$current_path = $env{'form.currentpath'};
}
if ($caller eq 'coursegrp_portfolio') {
&Apache::lonhtmlcommon::clear_breadcrumbs();
$r->print(&coursegrp_portfolio_header($udom,$uname,$grp_desc));
}
my @dir_list=&get_dir_list($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($uname,$udom,
&get_port_path());
} 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,
$can_upload);
&display_directory($r,$url,$current_path,$is_empty,\@dir_list,$group,
$can_upload,$can_modify,$can_delete,$can_setacl);
$r->print(&Apache::loncommon::end_page());
}
return OK;
}
1;
__END__