# The LearningOnline Network
# portfolio browser
#
# $Id: portfolio.pm,v 1.212.2.4 2010/02/12 19:19:21 raeburn 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,$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_usage($group));
my $parse_check;
if (!&suppress_embed_prompt()) {
$parse_check = <<"END";
END
}
$r->print('
'.$help_portfolio);
# Upload File
$r->print('
'
.''
.'
'
);
# Create Subdirectory
$r->print('
'
.''
.'
'
);
$r->print('
');
} # end "if can_upload"
my @tree = split (/\//,$current_path);
my %anchor_fields = (
'selectfile' => $port_path,
'currentpath' => '/',
'mode' => $env{"form.mode"},
'fieldname' => $env{"form.fieldname"},
'continue' => $env{"form.continue"}
);
$r->print(' ');
$r->print(''.&make_anchor($url,\%anchor_fields,$port_path).'/');
if (@tree > 1){
my $newCurrentPath = '/';
for (my $i = 1; $i< @tree; $i++){
$newCurrentPath .= $tree[$i].'/';
my %anchor_fields = (
'selectfile' => $tree[$i],
'currentpath' => $newCurrentPath,
'mode' => $env{"form.mode"},
'fieldname' => $env{"form.fieldname"},
'continue' => $env{"form.continue"}
);
$r->print(&make_anchor($url,\%anchor_fields,$tree[$i]).'/');
}
}
$r->print('');
$r->print(&Apache::loncommon::help_open_topic('Portfolio ChangeDirectory'));
&Apache::lonhtmlcommon::store_recent($namespace,$current_path,$current_path);
$r->print(' ");
}
sub display_usage {
my ($group) = @_;
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);
my $usage = $current_disk_usage/1000;
my $quota = $disk_quota/1000;
my $percent;
if ($disk_quota == 0) {
$percent = 100.0;
} else {
$percent = 100*($current_disk_usage/$disk_quota);
}
$usage = sprintf("%.2f",$usage);
$quota = sprintf("%.2f",$quota);
$percent = sprintf("%.0f",$percent);
my ($color,$cssclass);
if ($percent <= 60) {
$color = '#00A000';
} elsif ($percent > 60 && $percent < 90) {
$color = '#FFD300';
$cssclass = 'class="LC_warning"';
} elsif( $percent >= 90) {
$color = '#FF0000';
$cssclass = 'class="LC_error"';
}
my $prog_width = $percent;
if ($prog_width > 100) {
$prog_width = 100;
}
my $disk_meter = '
'.&mt('Currently using [_1] of the [_2] available.',$usage.' MB ('.$percent.'%)',$quota.' MB')."\n".
'
'."\n".
' '."\n".
'
'."\n".
'
';
return $disk_meter;
}
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::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 @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.').' ');
$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($group);
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 occurred ([_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 occurred ([_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 occurred ([_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 [_1]?',&display_file()).'
');
&close_form($r,$url);
}
sub delete_dir_confirmed {
my ($r,$url,$group)=@_;
my $directory_name = $env{'form.currentpath'};
$directory_name =~ s|/$||; # remove any trailing slash
my ($uname,$udom) = &get_name_dom($group);
my $namespace = &get_namespace();
my $port_path = &get_port_path();
my $result=&Apache::lonnet::removeuserfile($uname,$udom,$port_path.
$directory_name);
if ($result ne 'ok') {
$r->print(''
.&mt('An error occurred (dir) ([_1]) while trying to delete [_2].'
,$result,$directory_name)
.' ');
} else {
# now remove from recent
&Apache::lonhtmlcommon::remove_recent($namespace,[$directory_name.'/']);
my @dirs = split m!/!, $directory_name;
$directory_name='/';
for (my $i=1; $i < (@dirs - 1); $i ++){
$directory_name .= $dirs[$i].'/';
}
$env{'form.currentpath'} = $directory_name;
}
$r->print(&done(undef,$url));
}
sub rename {
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("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,$url,$group)=@_;
my $filenewname=&Apache::lonnet::clean_filename($env{'form.filenewname'});
my ($uname,$udom) = &get_name_dom($group);
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 occurred ([_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 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 privileges to edit course contents may add a course information page to a course using the 'Course Info' button in DOCS").' ';
}
} 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 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,$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::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-based',
);
my @allscopes = ('public','guest','domains','users','course');
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 = localtime($start);
if ($end == 0) {
$showend = &mt('No end date');
} else {
$showend = localtime($end);
}
}
$r->print('
'.&mt($scope_desc{$scope}));
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'}.')');
}
}
$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);
foreach my $newitem ('course','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','domains','users') {
if ($env{'form.new'.$newitem} > 0) {
$r->print(' '.&mt('Add new [_1]-based access control for portfolio file: [_2]',&mt($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')));
}
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 {
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,$url,$filename,$access_controls,$action) = @_;
my ($public,$publictext);
$publictext ='Off';
my ($guest,$guesttext);
$guesttext = 'Off';
my @courses = ();
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,%conditionals);
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);
} else {
$conditionals{$scope}{$key} = $$access_controls{$key};
if ($scope eq 'course') {
push(@courses,$key);
} elsif ($scope eq 'domains') {
push(@domains,$key);
} elsif ($scope eq 'users') {
push(@users,$key);
}
}
$acl_count{$scope} ++;
}
$r->print('
');
}
sub standard_settings {
my ($r,$now,$then,$url,$filename,$acl_count,$start,$end,$public,$publicnum,
$publictext,$guest,$guestnum,$guesttext,$access_controls,%conditionals)=@_;
$r->print('
');
if ($numconditionals > 0) {
my $count = 1;
my $chg = 'none';
$r->print(&mt('You have previously set [_1] conditional access controls.',$numconditionals).' '.&make_anchor($url,\%anchor_fields,&mt('Change Conditions')).'
');
$r->print(&Apache::loncommon::end_data_table_row());
}
$r->print(&Apache::loncommon::end_data_table());
} else {
$r->print(&mt('No [_1]-based conditions defined.',&mt($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 $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('
');
return;
}
sub add_course_role {
my ($num,$max_id) = @_;
my $output;
$output .=''.
''.
''.
'';
return $output;
}
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)?',&mt($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,$type,$content,$caller) = @_;
my ($output,$cdom,$cnum,$longid);
if ($caller eq 'display') {
$longid = '_'.$num.'_'.$role_id;
$cdom = $$content{'domain'};
$cnum = $$content{'number'};
} elsif ($caller eq 'rolepicker') {
$cdom = $env{'form.cdom'};
$cnum = $env{'form.cnum'};
}
my $uctype = $type;
$uctype =~ s/^(\w)/uc($1)/e;
my ($sections,$groups,$allroles,$rolehash,$accesshash) =
&Apache::loncommon::get_secgrprole_info($cdom,$cnum,1,$uctype);
if (!@{$sections}) {
@{$sections} = ('none');
} else {
unshift(@{$sections},('all','none'));
}
if (!@{$groups}) {
@{$groups} = ('none');
} else {
unshift(@{$groups},('all','none'));
}
my @allacesses = sort(keys(%{$accesshash}));
my (%sectionhash,%grouphash);
foreach my $sec (@{$sections}) {
$sectionhash{$sec} = $sec;
}
foreach my $grp (@{$groups}) {
$grouphash{$grp} = $grp;
}
my %lookup = (
'role' => $rolehash,
'access' => $accesshash,
'section' => \%sectionhash,
'group' => \%grouphash,
);
my @allaccesses = sort(keys(%{$accesshash}));
my %allitems = (
'role' => $allroles,
'access' => \@allaccesses,
'section' => $sections,
'group' => $groups,
);
foreach my $item ('role','access','section','group') {
$output .= '
';
}
$output .= '
';
return $output;
}
sub role_options_window {
my ($r) = @_;
my $type = $env{'form.type'};
my $rolenum = $env{'form.setroles'};
my ($num,$role_id) = ($rolenum =~ /^([\d_]+)_(\d+)$/);
my $role_elements;
foreach my $item ('role','access','section','group') {
$role_elements .= "'".$item.'_'.$rolenum."',";
}
$role_elements =~ s/,$//;
my $role_selects = &role_selectors($num,$role_id,$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('