# The LearningOnline Network with CAPA
# User Roles Screen
#
# $Id: lonroles.pm,v 1.256.2.6.2.3 2012/02/09 01:11:52 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/
#
###
=pod
=head1 NAME
Apache::lonroles - User Roles Screen
=head1 SYNOPSIS
Invoked by /etc/httpd/conf/srm.conf:
PerlAccessHandler Apache::lonacc
SetHandler perl-script
PerlHandler Apache::lonroles
ErrorDocument 403 /adm/login
ErrorDocument 500 /adm/errorhandler
=head1 OVERVIEW
=head2 Choosing Roles
C is a handler that allows a user to switch roles in
mid-session. LON-CAPA attempts to work with "No Role Specified", the
default role that a user has before selecting a role, as widely as
possible, but certain handlers for example need specification which
course they should act on, etc. Both in this scenario, and when the
handler determines via C's C<&allowed> function that a certain
action is not allowed, C is used as error handler. This
allows the user to select another role which may have permission to do
what they were trying to do.
=begin latex
\begin{figure}
\begin{center}
\includegraphics[width=0.45\paperwidth,keepaspectratio]{Sample_Roles_Screen}
\caption{\label{Sample_Roles_Screen}Sample Roles Screen}
\end{center}
\end{figure}
=end latex
=head2 Role Initialization
The privileges for a user are established at login time and stored in the session environment. As a consequence, a new role does not become active till the next login. Handlers are able to query for privileges using C's C<&allowed> function. When a user first logs in, their role is the "common" role, which means that they have the sum of all of their privileges. During a session it might become necessary to choose a particular role, which as a consequence also limits the user to only the privileges in that particular role.
=head1 INTRODUCTION
This module enables a user to select what role he wishes to
operate under (instructor, student, teaching assistant, course
coordinator, etc). These roles are pre-established by the actions
of upper-level users.
This is part of the LearningOnline Network with CAPA project
described at http://www.lon-capa.org.
=head1 HANDLER SUBROUTINE
This routine is called by Apache and mod_perl.
=over 4
=item *
Roles Initialization (yes/no)
=item *
Get Error Message from Environment
=item *
Who is this?
=item *
Generate Page Output
=item *
Choice or no choice
=item *
Table
=item *
Privileges
=back
=cut
package Apache::lonroles;
use strict;
use Apache::lonnet;
use Apache::lonuserstate();
use Apache::Constants qw(:common);
use Apache::File();
use Apache::lonmenu;
use Apache::loncommon;
use Apache::lonhtmlcommon;
use Apache::lonannounce;
use Apache::lonlocal;
use Apache::lonpageflip();
use Apache::lonnavdisplay();
use Apache::loncoursequeueadmin;
use GDBM_File;
use LONCAPA qw(:DEFAULT :match);
use HTML::Entities;
sub redirect_user {
my ($r,$title,$url,$msg,$launch_nav) = @_;
$msg = $title if (! defined($msg));
&Apache::loncommon::content_type($r,'text/html');
&Apache::loncommon::no_cache($r);
$r->send_http_header;
my $swinfo=&Apache::lonmenu::rawconfig();
my $navwindow;
if ($launch_nav eq 'on') {
$navwindow.=&Apache::lonnavdisplay::launch_win('now',undef,undef,
($url =~ m-^/adm/whatsnew-));
} else {
$navwindow.=&Apache::lonnavmaps::close();
}
# Breadcrumbs
my $brcrum = [{'href' => $url,
'text' => 'Switching Role'},];
my $start_page = &Apache::loncommon::start_page('Switching Role',undef,
{'redirect' => [1,$url],
'bread_crumbs' => $brcrum,});
my $end_page = &Apache::loncommon::end_page();
# Note to style police:
# This must only replace the spaces, nothing else, or it bombs elsewhere.
$url=~s/ /\%20/g;
$r->print(<
//
$navwindow
$msg
$end_page
ENDREDIR
return;
}
sub error_page {
my ($r,$error,$dest)=@_;
&Apache::loncommon::content_type($r,'text/html');
&Apache::loncommon::no_cache($r);
$r->send_http_header;
return OK if $r->header_only;
# Breadcrumbs
my $brcrum = [{'href' => $dest,
'text' => 'Problems during Course Initialization'},];
$r->print(&Apache::loncommon::start_page('Problems during Course Initialization',
undef,
{'bread_crumbs' => $brcrum,})
);
$r->print(
''.
'
'.&mt('The following problems occurred:').
' '.
$error.
'
'.&mt('Continue').''
);
$r->print(&Apache::loncommon::end_page());
}
sub handler {
my $r = shift;
my $now=time;
my $then=$env{'user.login.time'};
my $refresh=$env{'user.refresh.time'};
my $update=$env{'user.update.time'};
if (!$refresh) {
$refresh = $then;
}
if (!$update) {
$update = $then;
}
# -------------------------------------------------------- Check for new roles
my $updateresult;
if ($env{'form.doupdate'}) {
my $show_course=&Apache::loncommon::show_course();
my $checkingtxt;
if ($show_course) {
$checkingtxt = &mt('Checking for new courses ...');
} else {
$checkingtxt = &mt('Checking for new roles ...');
}
$updateresult = ''.$checkingtxt.'';
$updateresult .= &update_session_roles();
&Apache::lonnet::appenv({'user.update.time' => $now});
$update = $now;
}
my $envkey;
my %dcroles = ();
my $numdc = &check_fordc(\%dcroles,$update,$then);
&Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'});
my $loncaparev = $Apache::lonnet::perlvar{'lonVersion'};
# ================================================================== Roles Init
if ($env{'form.selectrole'}) {
my $locknum=&Apache::lonnet::get_locks();
if ($locknum) { return 409; }
if ($env{'form.newrole'}) {
$env{'form.'.$env{'form.newrole'}}=1;
}
if ($env{'request.course.id'}) {
# Check if user is CC trying to select a course role
if ($env{'form.switchrole'}) {
my $switch_is_active;
if (defined($env{'user.role.'.$env{'form.switchrole'}})) {
my ($start,$end) = split(/\./,$env{'user.role.'.$env{'form.switchrole'}});
if (!$end || $end > $now) {
if (!$start || $start < $update) {
$switch_is_active = 1;
}
}
}
unless ($switch_is_active) {
&adhoc_course_role($refresh,$update,$then);
}
}
my %temp=('logout_'.$env{'request.course.id'} => time);
&Apache::lonnet::put('email_status',\%temp);
&Apache::lonnet::delenv('user.state.'.$env{'request.course.id'});
}
&Apache::lonnet::appenv({"request.course.id" => '',
"request.course.fn" => '',
"request.course.uri" => '',
"request.course.sec" => '',
"request.role" => 'cm',
"request.role.adv" => $env{'user.adv'},
"request.role.domain" => $env{'user.domain'}});
# Check if user is a DC trying to enter a course or author space and needs privs to be created
if ($numdc > 0) {
foreach my $envkey (keys %env) {
# Is this an ad-hoc Coordinator role?
if (my ($ccrole,$domain,$coursenum) =
($envkey =~ m-^form\.(cc|co)\./($match_domain)/($match_courseid)$-)) {
if ($dcroles{$domain}) {
&Apache::lonnet::check_adhoc_privs($domain,$coursenum,
$update,$refresh,$now,$ccrole);
}
last;
}
# Is this an ad-hoc CA-role?
if (my ($domain,$user) =
($envkey =~ m-^form\.ca\./($match_domain)/($match_username)$-)) {
if (($domain eq $env{'user.domain'}) && ($user eq $env{'user.name'})) {
delete($env{$envkey});
$env{'form.au./'.$domain.'/'} = 1;
my ($server_status,$home) = &check_author_homeserver($user,$domain);
if ($server_status eq 'switchserver') {
my $trolecode = 'au./'.$domain.'/';
my $switchserver = '/adm/switchserver?otherserver='.$home.'&role='.$trolecode;
$r->internal_redirect($switchserver);
}
last;
}
if (my ($castart,$caend) = ($env{'user.role.ca./'.$domain.'/'.$user} =~ /^(\d*)\.(\d*)$/)) {
if (((($castart) && ($castart < $now)) || !$castart) &&
((!$caend) || (($caend) && ($caend > $now)))) {
my ($server_status,$home) = &check_author_homeserver($user,$domain);
if ($server_status eq 'switchserver') {
my $trolecode = 'ca./'.$domain.'/'.$user;
my $switchserver = '/adm/switchserver?otherserver='.$home.'&role='.$trolecode;
$r->internal_redirect($switchserver);
}
last;
}
}
# Check if author blocked ca-access
my %blocked=&Apache::lonnet::get('environment',['domcoord.author'],$domain,$user);
if ($blocked{'domcoord.author'} eq 'blocked') {
delete($env{$envkey});
$env{'user.error.msg'}=':::1:User '.$user.' in domain '.$domain.' blocked domain coordinator access';
last;
}
if ($dcroles{$domain}) {
my ($server_status,$home) = &check_author_homeserver($user,$domain);
if (($server_status eq 'ok') || ($server_status eq 'switchserver')) {
&Apache::lonnet::check_adhoc_privs($domain,$user,$update,
$refresh,$now,'ca');
if ($server_status eq 'switchserver') {
my $trolecode = 'ca./'.$domain.'/'.$user;
my $switchserver = '/adm/switchserver?'
.'otherserver='.$home.'&role='.$trolecode;
$r->internal_redirect($switchserver);
}
} else {
delete($env{$envkey});
}
} else {
delete($env{$envkey});
}
last;
}
}
}
foreach $envkey (keys %env) {
next if ($envkey!~/^user\.role\./);
my ($where,$trolecode,$role,$tstatus,$tend,$tstart);
&Apache::lonnet::role_status($envkey,$update,$refresh,$now,\$role,\$where,
\$trolecode,\$tstatus,\$tstart,\$tend);
if ($env{'form.'.$trolecode}) {
if ($tstatus eq 'is') {
$where=~s/^\///;
my ($cdom,$cnum,$csec)=split(/\//,$where);
if (($cnum) && ($role ne 'ca') && ($role ne 'aa')) {
my $home = $env{'course.'.$cdom.'_'.$cnum.'.home'};
my @ids = &Apache::lonnet::current_machine_ids();
unless ($loncaparev eq '' && $home && grep(/^\Q$home\E$/,@ids)) {
my %curr_reqd_hash = &Apache::lonnet::userenvironment($cdom,$cnum,'internal.releaserequired');
if ($curr_reqd_hash{'internal.releaserequired'} ne '') {
my ($switchserver,$switchwarning) =
&check_release_required($loncaparev,$cdom.'_'.$cnum,$trolecode,$curr_reqd_hash{'internal.releaserequired'});
if ($switchwarning ne '' || $switchserver ne '') {
&Apache::loncommon::content_type($r,'text/html');
&Apache::loncommon::no_cache($r);
$r->send_http_header;
my $end_page=&Apache::loncommon::end_page();
$r->print(&Apache::loncommon::start_page('Selected course unavailable on this server').
'
'.&Apache::loncommon::end_page());
return OK;
}
}
}
}
# check for course groups
my %coursegroups = &Apache::lonnet::get_active_groups(
$env{'user.domain'},$env{'user.name'},$cdom, $cnum);
my $cgrps = join(':',keys(%coursegroups));
# store role if recent_role list being kept
if ($env{'environment.recentroles'}) {
my %frozen_roles =
&Apache::lonhtmlcommon::get_recent_frozen('roles',$env{'environment.recentrolesn'});
&Apache::lonhtmlcommon::store_recent('roles',
$trolecode,' ',$frozen_roles{$trolecode});
}
# check for keyed access
if (($role eq 'st') &&
($env{'course.'.$cdom.'_'.$cnum.'.keyaccess'} eq 'yes')) {
# who is key authority?
my $authdom=$cdom;
my $authnum=$cnum;
if ($env{'course.'.$cdom.'_'.$cnum.'.keyauth'}) {
($authnum,$authdom)=
split(/:/,$env{'course.'.$cdom.'_'.$cnum.'.keyauth'});
}
# check with key authority
unless (&Apache::lonnet::validate_access_key(
$env{'environment.key.'.$cdom.'_'.$cnum},
$authdom,$authnum)) {
# there is no valid key
if ($env{'form.newkey'}) {
# student attempts to register a new key
&Apache::loncommon::content_type($r,'text/html');
&Apache::loncommon::no_cache($r);
$r->send_http_header;
my $swinfo=&Apache::lonmenu::rawconfig();
my $start_page=&Apache::loncommon::start_page
('Verifying Access Key to Unlock this Course');
my $end_page=&Apache::loncommon::end_page();
my $buttontext=&mt('Enter Course');
my $message=&mt('Successfully registered key');
my $assignresult=
&Apache::lonnet::assign_access_key(
$env{'form.newkey'},
$authdom,$authnum,
$cdom,$cnum,
$env{'user.domain'},
$env{'user.name'},
&mt('Assigned from [_1] at [_2] for [_3]'
,$ENV{'REMOTE_ADDR'}
,&Apache::lonlocal::locallocaltime()
,$trolecode)
);
unless ($assignresult eq 'ok') {
$assignresult=~s/^error\:\s*//;
$message=&mt($assignresult).
' '.
&mt('Logout').'';
$buttontext=&mt('Re-Enter Key');
}
$r->print(<
//
$end_page
ENDENTEREDKEY
return OK;
} else {
# print form to enter a new key
&Apache::loncommon::content_type($r,'text/html');
&Apache::loncommon::no_cache($r);
$r->send_http_header;
my $swinfo=&Apache::lonmenu::rawconfig();
my $start_page=&Apache::loncommon::start_page
('Enter Access Key to Unlock this Course');
my $end_page=&Apache::loncommon::end_page();
$r->print(<
//
$end_page
ENDENTERKEY
return OK;
}
}
}
&Apache::lonnet::log($env{'user.domain'},
$env{'user.name'},
$env{'user.home'},
"Role ".$trolecode);
&Apache::lonnet::appenv(
{'request.role' => $trolecode,
'request.role.domain' => $cdom,
'request.course.sec' => $csec,
'request.course.groups' => $cgrps});
my $tadv=0;
if (($cnum) && ($role ne 'ca') && ($role ne 'aa')) {
my $msg;
my ($furl,$ferr)=
&Apache::lonuserstate::readmap($cdom.'/'.$cnum);
unless (($ferr) || ($env{'form.switchrole'})) {
&Apache::lonnet::put('nohist_crslastlogin',
{$env{'user.name'}.':'.$env{'user.domain'}.
':'.$csec.':'.$role => $now},$cdom,$cnum);
}
if (($env{'form.orgurl'}) &&
($env{'form.orgurl'}!~/^\/adm\/flip/)) {
my $dest=$env{'form.orgurl'};
if ($env{'form.symb'}) {
if ($dest =~ /\?/) {
$dest .= '&';
} else {
$dest .= '?'
}
$dest .= 'symb='.$env{'form.symb'};
}
if (&Apache::lonnet::allowed('adv') eq 'F') { $tadv=1; }
&Apache::lonnet::appenv({'request.role.adv'=>$tadv});
if (($ferr) && ($tadv)) {
&error_page($r,$ferr,$dest);
} else {
if ($dest =~ m{^/adm/coursedocs\?folderpath}) {
if ($env{'request.course.id'} eq $cdom.'_'.$cnum) {
my $chome = &Apache::lonnet::homeserver($cnum,$cdom);
&update_content_constraints($cdom,$cnum,$chome,$cdom.'_'.$cnum);
}
}
$r->internal_redirect($dest);
}
return OK;
} else {
if (!$env{'request.course.id'}) {
&Apache::lonnet::appenv(
{"request.course.id" => $cdom.'_'.$cnum});
$furl='/adm/roles?tryagain=1';
$msg='
'
.&mt('Could not initialize [_1] at this time.',
$env{'course.'.$cdom.'_'.$cnum.'.description'})
.'
'
.'
'.&mt('Please try again.').'
'
.'
'.$ferr.'
';
}
if (&Apache::lonnet::allowed('adv') eq 'F') { $tadv=1; }
&Apache::lonnet::appenv({'request.role.adv'=>$tadv});
if (($ferr) && ($tadv)) {
&error_page($r,$ferr,$furl);
} else {
# Check to see if the user is a CC entering a course
# for the first time
my (undef, undef, $role, $courseid) = split(/\./, $envkey);
if (substr($courseid, 0, 1) eq '/') {
$courseid = substr($courseid, 1);
}
$courseid =~ s/\//_/;
if ((($role eq 'cc') || ($role eq 'co'))
&& ($env{'course.' . $courseid .'.course.helper.not.run'})) {
$furl = "/adm/helper/course.initialization.helper";
# Send the user to the course they selected
} elsif ($env{'request.course.id'}) {
if ($env{'form.destinationurl'}) {
my $dest = $env{'form.destinationurl'};
if ($env{'form.destsymb'} ne '') {
my $esc_symb = &HTML::Entities::encode($env{'form.destsymb'},'"<>&');
$dest .= '?symb='.$esc_symb;
}
&redirect_user($r, &mt('Entering [_1]',
$env{'course.'.$courseid.'.description'}),
$dest, $msg,
$env{'environment.remotenavmap'});
return OK;
}
if (&Apache::lonnet::allowed('whn',
$env{'request.course.id'})
|| &Apache::lonnet::allowed('whn',
$env{'request.course.id'}.'/'
.$env{'request.course.sec'})
) {
my $startpage = &courseloadpage($courseid);
unless ($startpage eq 'firstres') {
$msg = &mt('Entering [_1] ...',
$env{'course.'.$courseid.'.description'});
&redirect_user($r,&mt('New in course'),
'/adm/whatsnew?refpage=start',$msg,
$env{'environment.remotenavmap'});
return OK;
}
}
}
# Are we allowed to look at the first resource?
if (($furl !~ m|^/adm/|) ||
(($env{'environment.remotenavmap'} eq 'on') &&
($furl =~ m{^/adm/navmaps}))) {
# Guess not ...
$furl=&Apache::lonpageflip::first_accessible_resource();
}
$msg = &mt('Entering [_1] ...',
$env{'course.'.$courseid.'.description'});
&redirect_user($r,&mt('Entering [_1]',
$env{'course.'.$courseid.'.description'}),
$furl,$msg,
$env{'environment.remotenavmap'});
}
return OK;
}
}
#
# Send the user to the construction space they selected
if ($role =~ /^(au|ca|aa)$/) {
my $redirect_url = '/priv/';
if ($role eq 'au') {
$redirect_url.=$env{'user.name'};
} else {
$where =~ /\/(.*)$/;
$redirect_url .= $1;
}
$redirect_url .= '/';
&redirect_user($r,&mt('Entering Construction Space'),
$redirect_url);
return OK;
}
if ($role eq 'dc') {
my $redirect_url = '/adm/menu/';
&redirect_user($r,&mt('Loading Domain Coordinator Menu'),
$redirect_url);
return OK;
}
if ($role eq 'sc') {
my $redirect_url = '/adm/grades?command=scantronupload';
&redirect_user($r,&mt('Loading Data Upload Page'),
$redirect_url);
return OK;
}
}
}
}
}
# =============================================================== No Roles Init
&Apache::loncommon::content_type($r,'text/html');
&Apache::loncommon::no_cache($r);
$r->send_http_header;
return OK if $r->header_only;
my $crumbtext = 'User Roles';
my $pagetitle = 'My Roles';
my $recent = &mt('Recent Roles');
my $show_course=&Apache::loncommon::show_course();
if ($show_course) {
$crumbtext = 'Courses';
$pagetitle = 'My Courses';
$recent = &mt('Recent Courses');
}
my $brcrum =[{href=>"/adm/roles",text=>$crumbtext}];
my $swinfo=&Apache::lonmenu::rawconfig();
my $start_page=&Apache::loncommon::start_page($pagetitle,undef,{bread_crumbs=>$brcrum});
my $standby=&mt('Role selected. Please stand by.');
$standby=~s/\n/\\n/g;
my $noscript=''.&mt('Use of LON-CAPA requires Javascript to be enabled in your web browser.').' '.&mt('As this is not the case, most functionality in the system will be unavailable.').' ';
$r->print(<
ENDHEADER
# ------------------------------------------ Get Error Message from Environment
my ($fn,$priv,$nochoose,$error,$msg)=split(/:/,$env{'user.error.msg'});
if ($env{'user.error.msg'}) {
$r->log_reason(
"$msg for $env{'user.name'} domain $env{'user.domain'} access $priv",$fn);
}
# ------------------------------------------------- Can this user re-init, etc?
my $advanced=$env{'user.adv'};
&Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},['tryagain']);
my $tryagain=$env{'form.tryagain'};
my $reinit=$env{'user.reinit'};
delete $env{'user.reinit'};
# -------------------------------------------------------- Generate Page Output
# --------------------------------------------------------------- Error Header?
if ($error) {
$r->print("
".&mt('LON-CAPA Access Control')."
");
$r->print("
");
if ($priv ne '') {
$r->print(&mt('Access : ').&Apache::lonnet::plaintext($priv)."\n");
}
if ($fn ne '') {
$r->print(&mt('Resource: ').&Apache::lonenc::check_encrypt($fn)."\n");
}
if ($msg ne '') {
$r->print(&mt('Action : ').$msg."\n");
}
$r->print("
");
my $url=$fn;
my $last;
if (tie(my %hash,'GDBM_File',$env{'request.course.fn'}.'_symb.db',
&GDBM_READER(),0640)) {
$last=$hash{'last_known'};
untie(%hash);
}
if ($last) { $fn.='?symb='.&escape($last); }
&Apache::londocs::changewarning($r,undef,'You have modified your course recently, [_1] may fix this access problem.',
&Apache::lonenc::check_encrypt($fn));
} else {
if ($env{'user.error.msg'}) {
if ($reinit) {
$r->print(
'
'.
&mt('As your session file for the course or community has expired, you will need to re-select it.').'
');
} else {
$r->print(
'
'.
&mt('You need to choose another user role or enter a specific course or community for this function.').
'
');
}
}
}
# -------------------------------------------------------- Choice or no choice?
if ($nochoose) {
$r->print("
".&mt('Sorry ...')."
\n".
&mt('This action is currently not authorized.').''.
&Apache::loncommon::end_page());
return OK;
} else {
$r->print($updateresult);
if (($ENV{'REDIRECT_QUERY_STRING'}) && ($fn)) {
$fn.='?'.$ENV{'REDIRECT_QUERY_STRING'};
}
$r->print('');
if ($countfuture) {
$r->print(&mt('The following [quant,_1,role,roles] will become active in the future:',$countfuture));
my $doheaders = &roletable_headers($r,\%roleclass,\%sortrole,
$nochoose);
&print_rolerows($r,$doheaders,\%roleclass,\%sortrole,\%dcroles,
\%roletext);
my $tremark='';
my $tbg;
if ($env{'request.role'} eq 'cm') {
$tbg="LC_roles_selected";
$tremark=&mt('Currently selected.').' ';
} else {
$tbg="LC_roles_is";
}
$r->print(&Apache::loncommon::start_data_table_row()
.'
'
.'
'
.&mt('No role specified')
.'
'
.'
'.$tremark.'
'
.&Apache::loncommon::end_data_table_row()
);
$r->print(&Apache::loncommon::end_data_table());
}
$r->print(&Apache::loncommon::end_page());
return OK;
} elsif ($countactive==1 && $countfuture==0) { # Only one choice
my $needs_switchserver;
if ($env{'user.author'}) {
$needs_switchserver = &check_needs_switchserver($possiblerole);
}
if ((!$needs_switchserver) && ($env{'request.role'} eq 'cm')) {
$r->print('
\n".
&mt('Construction Space access is only available from '.
'the home server of the corresponding Author.').' '.
&mt("Click the 'Switch Server' link to go there.").' ');
}
}
# ----------------------------------------------------------------------- Table
if ($numdc > 0) {
$r->print(&coursepick_jscript());
$r->print(&Apache::loncommon::coursebrowser_javascript().
&Apache::loncommon::authorbrowser_javascript());
}
unless ((!&Apache::loncommon::show_course()) || ($nochoose) || ($countactive==1)) {
$r->print("
".&mt('Select a Course to Enter')."
\n");
}
if ($env{'form.destinationurl'}) {
$r->print('');
if ($env{'form.destsymb'} ne '') {
$r->print('');
}
}
my $doheaders = &roletable_headers($r,\%roleclass,\%sortrole,$nochoose);
if ($env{'environment.recentroles'}) {
my %recent_roles =
&Apache::lonhtmlcommon::get_recent('roles',$env{'environment.recentrolesn'});
my $output='';
foreach my $role (sort(keys(%recent_roles))) {
if (ref($roletext{'user.role.'.$role}) eq 'ARRAY') {
$output.= &Apache::loncommon::start_data_table_row().
$roletext{'user.role.'.$role}->[0].
&Apache::loncommon::end_data_table_row();
if ($roletext{'user.role.'.$role}->[1] ne '') {
$output .= &Apache::loncommon::continue_data_table_row().
$roletext{'user.role.'.$role}->[1].
&Apache::loncommon::end_data_table_row();
}
if ($role =~ m{dc\./($match_domain)/}
&& $dcroles{$1}) {
$output .= &adhoc_roles_row($1,'recent');
}
} elsif ($numdc > 0) {
unless ($role =~/^error\:/) {
my ($roletext,$role_text_end) = &display_cc_role('user.role.'.$role);
if ($roletext) {
$output.= &Apache::loncommon::start_data_table_row().
$roletext.
&Apache::loncommon::end_data_table_row();
if ($role_text_end) {
$output .= &Apache::loncommon::continue_data_table_row().
$role_text_end.
&Apache::loncommon::end_data_table_row();
}
}
}
}
}
if ($output) {
$r->print(&Apache::loncommon::start_data_table_empty_row()
.'
'
.$recent
.'
'
.&Apache::loncommon::end_data_table_empty_row()
);
$r->print($output);
$doheaders ++;
}
}
&print_rolerows($r,$doheaders,\%roleclass,\%sortrole,\%dcroles,\%roletext);
if ($countactive > 1) {
my $tremark='';
my $tbg;
if ($env{'request.role'} eq 'cm') {
$tbg="LC_roles_selected";
$tremark=&mt('Currently selected.').' ';
} else {
$tbg="LC_roles_is";
}
$r->print(&Apache::loncommon::start_data_table_row());
unless ($nochoose) {
if ($env{'request.role'} ne 'cm') {
$r->print('
');
}
$r->print(&Apache::loncommon::end_page());
return OK;
}
sub gather_roles {
my ($update,$refresh,$now,$reinit,$nochoose,$roletext,$sortrole,$roleclass,$futureroles,$timezones,$loncaparev) = @_;
my ($countactive,$countfuture,$inrole,$possiblerole) = (0,0,0,'');
my $advanced = $env{'user.adv'};
my $tryagain = $env{'form.tryagain'};
my @ids = &Apache::lonnet::current_machine_ids();
foreach my $envkey (sort(keys(%env))) {
my $button = 1;
my $switchserver='';
my $switchwarning;
my ($role_text,$role_text_end,$sortkey);
if ($envkey=~/^user\.role\./) {
my ($role,$where,$trolecode,$tstart,$tend,$tremark,$tstatus,$tpstart,$tpend);
&Apache::lonnet::role_status($envkey,$update,$refresh,$now,\$role,\$where,
\$trolecode,\$tstatus,\$tstart,\$tend);
next if (!defined($role) || $role eq '' || $role =~ /^gr/);
$tremark='';
$tpstart=' ';
$tpend=' ';
if ($env{'request.role'} eq $trolecode) {
$tstatus='selected';
}
my $tbg;
if (($tstatus eq 'is')
|| ($tstatus eq 'selected')
|| ($tstatus eq 'future')
|| ($env{'form.showall'})) {
my $timezone = &role_timezone($where,$timezones);
if ($tstart) {
$tpstart=&Apache::lonlocal::locallocaltime($tstart,$timezone);
}
if ($tend) {
$tpend=&Apache::lonlocal::locallocaltime($tend,$timezone);
}
if ($tstatus eq 'is') {
$tbg='LC_roles_is';
$possiblerole=$trolecode;
$countactive++;
} elsif ($tstatus eq 'future') {
$tbg='LC_roles_future';
$button=0;
$futureroles->{$trolecode} = $tstart.':'.$tend;
$countfuture ++;
} elsif ($tstatus eq 'expired') {
$tbg='LC_roles_expired';
$button=0;
} elsif ($tstatus eq 'will_not') {
$tbg='LC_roles_will_not';
$tremark.=&mt('Expired after logout.').' ';
} elsif ($tstatus eq 'selected') {
$tbg='LC_roles_selected';
$inrole=1;
$countactive++;
$tremark.=&mt('Currently selected.').' ';
}
my $trole;
if ($role =~ /^cr\//) {
my ($rdummy,$rdomain,$rauthor,$rrole)=split(/\//,$role);
if ($tremark) { $tremark.=' '; }
$tremark.=&mt('Customrole defined by [_1].',$rauthor.':'.$rdomain);
}
$trole=Apache::lonnet::plaintext($role);
my $ttype;
my $twhere;
my ($tdom,$trest,$tsection)=
split(/\//,Apache::lonnet::declutter($where));
# First, Co-Authorship roles
if (($role eq 'ca') || ($role eq 'aa')) {
my $home = &Apache::lonnet::homeserver($trest,$tdom);
my $allowed=0;
foreach my $id (@ids) { if ($id eq $home) { $allowed=1; } }
if (!$allowed) {
$button=0;
$switchserver='otherserver='.$home.'&role='.$trolecode;
}
#next if ($home eq 'no_host');
$home = &Apache::lonnet::hostname($home);
$ttype='Construction Space';
$twhere=&mt('User').': '.$trest.' '.&mt('Domain').
': '.$tdom.' '.
' '.&mt('Server').': '.$home;
$env{'course.'.$tdom.'_'.$trest.'.description'}='ca';
$tremark.=&Apache::lonhtmlcommon::authorbombs('/res/'.$tdom.'/'.$trest.'/');
$sortkey=$role."$trest:$tdom";
} elsif ($role eq 'au') {
# Authors
my $home = &Apache::lonnet::homeserver
($env{'user.name'},$env{'user.domain'});
my $allowed=0;
foreach my $id (@ids) { if ($id eq $home) { $allowed=1; } }
if (!$allowed) {
$button=0;
$switchserver='otherserver='.$home.'&role='.$trolecode;
}
#next if ($home eq 'no_host');
$home = &Apache::lonnet::hostname($home);
$ttype='Construction Space';
$twhere=&mt('Domain').': '.$tdom.' '.&mt('Server').
': '.$home;
$env{'course.'.$tdom.'_'.$trest.'.description'}='ca';
$tremark.=&Apache::lonhtmlcommon::authorbombs('/res/'.$tdom.'/'.$env{'user.name'}.'/');
$sortkey=$role;
} elsif ($trest) {
my $tcourseid=$tdom.'_'.$trest;
$ttype = &Apache::loncommon::course_type($tcourseid);
$trole = &Apache::lonnet::plaintext($role,$ttype,$tcourseid);
if ($env{'course.'.$tcourseid.'.description'}) {
my $home=$env{'course.'.$tcourseid.'.home'};
$twhere=$env{'course.'.$tcourseid.'.description'};
$sortkey=$role."\0".$tdom."\0".$twhere."\0".$envkey;
$twhere = &HTML::Entities::encode($twhere,'"<>&');
unless ($twhere eq &mt('Currently not available')) {
$twhere.=' '.
&Apache::loncommon::syllabuswrapper(&mt('Syllabus'),$trest,$tdom).
'';
unless ($home && grep(/^\Q$home\E$/,@ids) && $loncaparev eq '') {
my $required = $env{'course.'.$tcourseid.'.internal.releaserequired'};
if ($required ne '') {
($switchserver,$switchwarning) =
&check_release_required($loncaparev,$tcourseid,$trolecode,$required);
if ($switchserver || $switchwarning) {
$button = 0;
}
}
}
}
} else {
my %newhash=&Apache::lonnet::coursedescription($tcourseid);
if (%newhash) {
$sortkey=$role."\0".$tdom."\0".$newhash{'description'}.
"\0".$envkey;
$twhere=&HTML::Entities::encode($newhash{'description'},'"<>&').
' '.
&Apache::loncommon::syllabuswrapper(&mt('Syllabus'),$trest,$tdom).
'';
$ttype = $newhash{'type'};
$trole = &Apache::lonnet::plaintext($role,$ttype,$tcourseid);
my $home = $newhash{'home'};
unless ($home && grep(/^\Q$home\E$/,@ids) && $loncaparev eq '') {
my $required = $newhash{'internal.releaserequired'};
if ($required ne '') {
($switchserver,$switchwarning) =
&check_release_required($loncaparev,$tcourseid,$trolecode,$required);
if ($switchserver || $switchwarning) {
$button = 0;
}
}
}
} else {
$twhere=&mt('Currently not available');
$env{'course.'.$tcourseid.'.description'}=$twhere;
$sortkey=$role."\0".$tdom."\0".$twhere."\0".$envkey;
$ttype = 'Unavailable';
}
}
if ($tsection) {
$twhere.=' '.&mt('Section').': '.$tsection;
}
if ($role ne 'st') { $twhere.=" ".&mt('Domain').":".$tdom; }
} elsif ($tdom) {
$ttype='Domain';
$twhere=$tdom;
$sortkey=$role.$twhere;
} else {
$ttype='System';
$twhere=&mt('system wide');
$sortkey=$role.$twhere;
}
($role_text,$role_text_end) =
&build_roletext($trolecode,$tdom,$trest,$tstatus,$tryagain,
$advanced,$tremark,$tbg,$trole,$twhere,$tpstart,
$tpend,$nochoose,$button,$switchserver,$reinit,$switchwarning);
$roletext->{$envkey}=[$role_text,$role_text_end];
if (!$sortkey) {$sortkey=$twhere."\0".$envkey;}
$sortrole->{$sortkey}=$envkey;
$roleclass->{$envkey}=$ttype;
}
}
}
return ($countactive,$countfuture,$inrole,$possiblerole);
}
sub role_timezone {
my ($where,$timezones) = @_;
my $timezone;
if (ref($timezones) eq 'HASH') {
if ($where =~ m{^/($match_domain)/($match_courseid)}) {
my $cdom = $1;
my $cnum = $2;
if ($cdom && $cnum) {
if (!exists($timezones->{$cdom.'_'.$cnum})) {
my $tz;
if ($env{'course.'.$cdom.'_'.$cnum.'.description'}) {
$tz = $env{'course.'.$cdom.'_'.$cnum.'.timezone'};
} else {
my %timehash =
&Apache::lonnet::get('environment',['timezone'],$cdom,$cnum);
$tz = $timehash{'timezone'};
}
if ($tz eq '') {
if (!exists($timezones->{$cdom})) {
my %domdefaults =
&Apache::lonnet::get_domain_defaults($cdom);
if ($domdefaults{'timezone_def'} eq '') {
$timezones->{$cdom} = 'local';
} else {
$timezones->{$cdom} = $domdefaults{'timezone_def'};
}
}
$timezones->{$cdom.'_'.$cnum} = $timezones->{$cdom};
} else {
$timezones->{$cdom.'_'.$cnum} =
&Apache::lonlocal::gettimezone($tz);
}
}
$timezone = $timezones->{$cdom.'_'.$cnum};
}
} else {
my ($tdom) = ($where =~ m{^/($match_domain)});
if ($tdom) {
if (!exists($timezones->{$tdom})) {
my %domdefaults = &Apache::lonnet::get_domain_defaults($tdom);
if ($domdefaults{'timezone_def'} eq '') {
$timezones->{$tdom} = 'local';
} else {
$timezones->{$tdom} = $domdefaults{'timezone_def'};
}
}
$timezone = $timezones->{$tdom};
}
}
if ($timezone eq 'local') {
$timezone = undef;
}
}
return $timezone;
}
sub roletable_headers {
my ($r,$roleclass,$sortrole,$nochoose) = @_;
my $doheaders;
if ((ref($sortrole) eq 'HASH') && (ref($roleclass) eq 'HASH')) {
$r->print(' '
.&Apache::loncommon::start_data_table()
.&Apache::loncommon::start_data_table_header_row()
);
if (!$nochoose) { $r->print('
'); }
$r->print('
'.&mt('User Role').'
'
.'
'.&mt('Extent').'
'
.'
'.&mt('Start').'
'
.'
'.&mt('End').'
'
.&Apache::loncommon::end_data_table_header_row()
);
$doheaders=-1;
my @roletypes = &roletypes();
foreach my $type (@roletypes) {
my $haverole=0;
foreach my $which (sort {uc($a) cmp uc($b)} (keys(%{$sortrole}))) {
if ($roleclass->{$sortrole->{$which}} =~ /^\Q$type\E/) {
$haverole=1;
}
}
if ($haverole) { $doheaders++; }
}
}
return $doheaders;
}
sub roletypes {
my @types = ('Domain','Construction Space','Course','Community','Unavailable','System');
return @types;
}
sub print_rolerows {
my ($r,$doheaders,$roleclass,$sortrole,$dcroles,$roletext) = @_;
if ((ref($roleclass) eq 'HASH') && (ref($sortrole) eq 'HASH')) {
my @types = &roletypes();
foreach my $type (@types) {
my $output;
foreach my $which (sort {uc($a) cmp uc($b)} (keys(%{$sortrole}))) {
if ($roleclass->{$sortrole->{$which}} =~ /^\Q$type\E/) {
if (ref($roletext) eq 'HASH') {
if (ref($roletext->{$sortrole->{$which}}) eq 'ARRAY') {
$output.= &Apache::loncommon::start_data_table_row().
$roletext->{$sortrole->{$which}}->[0].
&Apache::loncommon::end_data_table_row();
if ($roletext->{$sortrole->{$which}}->[1] ne '') {
$output .= &Apache::loncommon::continue_data_table_row().
$roletext->{$sortrole->{$which}}->[1].
&Apache::loncommon::end_data_table_row();
}
}
if ($sortrole->{$which} =~ m-dc\./($match_domain)/-) {
if (ref($dcroles) eq 'HASH') {
if ($dcroles->{$1}) {
$output .= &adhoc_roles_row($1,'');
}
}
}
}
}
}
if ($output) {
if ($doheaders > 0) {
$r->print(&Apache::loncommon::start_data_table_empty_row()
.'
'
.&mt($type)
.'
'
.&Apache::loncommon::end_data_table_empty_row()
);
}
$r->print($output);
}
}
}
}
sub findcourse_advice {
my ($r) = @_;
my $domdesc = &Apache::lonnet::domain($env{'user.domain'},'description');
my $esc_dom = &HTML::Entities::encode($env{'user.domain'},'"<>&');
if (&Apache::lonnet::auto_run(undef,$env{'user.domain'})) {
$r->print(&mt('If you were expecting to see an active role listed for a particular course in the [_1] domain, it may be missing for one of the following reasons:',$domdesc).'
'.&mt('The course has yet to be created.').'
'.&mt('Automatic enrollment of registered students has not been enabled for the course.').'
'.&mt('You are in a section of course for which automatic enrollment in the corresponding LON-CAPA course is not active.').'
'.&mt('The start date for automated enrollment has yet to be reached.').'
'.&mt('You registered for the course recently and there is a time lag between the time you register, and the time this information becomes available for the update of LON-CAPA course rosters.').'
');
} else {
$r->print(&mt('If you were expecting to see an active role listed for a particular course, that course may not have been created yet.').' ');
}
$r->print('
'.&mt('Self-Enrollment').'
'.
'
'.&mt('The [_1]Course/Community Catalog[_2] provides information about all [_3] classes for which LON-CAPA courses have been created, as well as any communities in the domain.','','',$domdesc).' ');
$r->print(&mt('You can search for courses and communities which permit self-enrollment, if you would like to enroll in one.').'
'.
&Apache::loncoursequeueadmin::queued_selfenrollment());
return;
}
sub requestcourse_advice {
my ($r) = @_;
my $domdesc = &Apache::lonnet::domain($env{'user.domain'},'description');
my $esc_dom = &HTML::Entities::encode($env{'user.domain'},'"<>&');
my (%can_request,%request_doms);
&Apache::lonnet::check_can_request($env{'user.domain'},\%can_request,\%request_doms);
if (keys(%request_doms) > 0) {
my ($types,$typename) = &Apache::loncommon::course_types();
if ((ref($types) eq 'ARRAY') && (ref($typename) eq 'HASH')) {
$r->print('
'.&mt('Request creation of a course or community').'
'.
'
'.&mt('You have rights to request the creation of courses and/or communities in the following domain(s):').'
');
my (@reqdoms,@reqtypes);
foreach my $type (sort(keys(%request_doms))) {
push(@reqtypes,$type);
if (ref($request_doms{$type}) eq 'ARRAY') {
my $domstr = join(', ',map { &Apache::lonnet::domain($_) } sort(@{$request_doms{$type}}));
$r->print(
'
'
.&mt('[_1]'.$typename->{$type}.'[_2] in domain: [_3]',
'',
'',
''.$domstr.'')
.'
'
);
foreach my $dom (@{$request_doms{$type}}) {
unless (grep(/^\Q$dom\E/,@reqdoms)) {
push(@reqdoms,$dom);
}
}
}
}
my @showtypes;
foreach my $type (@{$types}) {
if (grep(/^\Q$type\E$/,@reqtypes)) {
push(@showtypes,$type);
}
}
my $requrl = '/adm/requestcourse';
if (@reqdoms == 1) {
$requrl .= '?showdom='.$reqdoms[0];
}
if (@showtypes > 0) {
$requrl.=(($requrl=~/\?/)?'&':'?').'crstype='.$showtypes[0];
}
if (@reqdoms == 1 || @showtypes > 0) {
$requrl .= '&state=crstype&action=new';
}
$r->print('
'.&mt('Use the [_1]request form[_2] to submit a request for creation of a new course or community.','','').'');
}
}
return;
}
sub privileges_info {
my ($which) = @_;
my $output;
$which ||= $env{'request.role'};
foreach my $envkey (sort(keys(%env))) {
next if ($envkey!~/^user\.priv\.\Q$which\E\.(.*)/);
my $where=$1;
my $ttype;
my $twhere;
my (undef,$tdom,$trest,$tsec)=split(m{/},$where);
if ($trest) {
if ($env{'course.'.$tdom.'_'.$trest.'.description'} eq 'ca') {
$ttype='Construction Space';
$twhere='User: '.$trest.', Domain: '.$tdom;
} else {
$ttype= &Apache::loncommon::course_type($tdom.'_'.$trest);
$twhere=$env{'course.'.$tdom.'_'.$trest.'.description'};
if ($tsec) {
my $sec_type = 'Section';
if (exists($env{"user.role.gr.$where"})) {
$sec_type = 'Group';
}
$twhere.=' ('.$sec_type.': '.$tsec.')';
}
}
} elsif ($tdom) {
$ttype='Domain';
$twhere=$tdom;
} else {
$ttype='System';
$twhere='/';
}
$output .= "\n
".&mt($ttype).': '.$twhere.'
'."\n
";
foreach my $priv (sort(split(/:/,$env{$envkey}))) {
next if (!$priv);
my ($prv,$restr)=split(/\&/,$priv);
my $trestr='';
if ($restr ne 'F') {
$trestr.=' ('.
join(', ',
map { &Apache::lonnet::plaintext($_) }
(split('',$restr))).') ';
}
$output .= "\n\t".
'
';
}
return ($roletext,$roletext_end);
}
sub check_needs_switchserver {
my ($possiblerole) = @_;
my $needs_switchserver;
my ($role,$where) = split(/\./,$possiblerole,2);
my (undef,$tdom,$twho) = split(/\//,$where);
my ($server_status,$home);
if (($role eq 'ca') || ($role eq 'aa')) {
($server_status,$home) = &check_author_homeserver($twho,$tdom);
} else {
($server_status,$home) = &check_author_homeserver($env{'user.name'},
$env{'user.domain'});
}
if ($server_status eq 'switchserver') {
$needs_switchserver = 1;
}
return $needs_switchserver;
}
sub check_author_homeserver {
my ($uname,$udom)=@_;
if (($uname eq '') || ($udom eq '')) {
return ('fail','');
}
my $home = &Apache::lonnet::homeserver($uname,$udom);
if (&Apache::lonnet::host_domain($home) ne $udom) {
return ('fail',$home);
}
my @ids=&Apache::lonnet::current_machine_ids();
if (grep(/^\Q$home\E$/,@ids)) {
return ('ok',$home);
} else {
return ('switchserver',$home);
}
}
sub check_fordc {
my ($dcroles,$update,$then) = @_;
my $numdc = 0;
if ($env{'user.adv'}) {
foreach my $envkey (sort keys %env) {
if ($envkey=~/^user\.role\.dc\.\/($match_domain)\/$/) {
my $dcdom = $1;
my $livedc = 1;
my ($tstart,$tend)=split(/\./,$env{$envkey});
my $limit = $update;
if ($env{'request.role'} eq 'dc./'.$dcdom.'/') {
$limit = $then;
}
if ($tstart && $tstart>$limit) { $livedc = 0; }
if ($tend && $tend <$limit) { $livedc = 0; }
if ($livedc) {
$$dcroles{$dcdom} = $envkey;
$numdc++;
}
}
}
}
return $numdc;
}
sub adhoc_course_role {
my ($refresh,$update,$then) = @_;
my ($cdom,$cnum,$crstype);
$cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
$cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
$crstype = &Apache::loncommon::course_type();
if (&check_forcc($cdom,$cnum,$refresh,$update,$then,$crstype)) {
my $setprivs;
if (!defined($env{'user.role.'.$env{'form.switchrole'}})) {
$setprivs = 1;
} else {
my ($start,$end) = split(/\./,$env{'user.role.'.$env{'form.switchrole'}});
if (($start && ($start>$refresh || $start == -1)) ||
($end && $end<$update)) {
$setprivs = 1;
}
}
if ($setprivs) {
if ($env{'form.switchrole'} =~ m-^(in|ta|ep|ad|st|cr)([\w/]*)\./\Q$cdom\E/\Q$cnum\E/?(\w*)$-) {
my $role = $1;
my $custom_role = $2;
my $usec = $3;
if ($role eq 'cr') {
if ($custom_role =~ m-^/$match_domain/$match_username/\w+$-) {
$role .= $custom_role;
} else {
return;
}
}
my (%userroles,%newrole,%newgroups,%group_privs);
my %cgroups =
&Apache::lonnet::get_active_groups($env{'user.domain'},
$env{'user.name'},$cdom,$cnum);
foreach my $group (keys(%cgroups)) {
$group_privs{$group} =
$env{'user.priv.cc./'.$cdom.'/'.$cnum.'./'.$cdom.'/'.$cnum.'/'.$group};
}
$newgroups{'/'.$cdom.'/'.$cnum} = \%group_privs;
my $area = '/'.$cdom.'/'.$cnum;
my $spec = $role.'.'.$area;
if ($usec ne '') {
$spec .= '/'.$usec;
$area .= '/'.$usec;
}
&Apache::lonnet::standard_roleprivs(\%newrole,$role,$cdom,$spec,$cnum,$area);
&Apache::lonnet::set_userprivs(\%userroles,\%newrole,\%newgroups);
my $adhocstart = $refresh-1;
$userroles{'user.role.'.$spec} = $adhocstart.'.';
&Apache::lonnet::appenv(\%userroles,[$role,'cm']);
}
}
}
return;
}
sub check_forcc {
my ($cdom,$cnum,$refresh,$update,$then,$crstype) = @_;
my ($is_cc,$ccrole);
if ($crstype eq 'Community') {
$ccrole = 'co';
} else {
$ccrole = 'cc';
}
if ($cdom ne '' && $cnum ne '') {
if (&Apache::lonnet::is_course($cdom,$cnum)) {
my $envkey = 'user.role.'.$ccrole.'./'.$cdom.'/'.$cnum;
if (defined($env{$envkey})) {
$is_cc = 1;
my ($tstart,$tend)=split(/\./,$env{$envkey});
my $limit = $update;
if ($env{'request.role'} eq $ccrole.'./'.$cdom.'/'.$cnum) {
$limit = $then;
}
if ($tstart && $tstart>$refresh) { $is_cc = 0; }
if ($tend && $tend <$limit) { $is_cc = 0; }
}
}
}
return $is_cc;
}
sub check_release_required {
my ($loncaparev,$tcourseid,$trolecode,$required) = @_;
my ($switchserver,$warning);
if ($required ne '') {
my ($reqdmajor,$reqdminor) = ($required =~ /^(\d+)\.(\d+)$/);
my ($major,$minor) = ($loncaparev =~ /^\'?(\d+)\.(\d+)\.[\w.\-]+\'?$/);
if ($reqdmajor ne '' && $reqdminor ne '') {
my $otherserver;
if (($major eq '' && $minor eq '') ||
(($reqdmajor > $major) || (($reqdmajor == $major) && ($reqdminor > $minor)))) {
my ($userdomserver) = &Apache::lonnet::choose_server($env{'user.domain'});
my $switchlcrev =
&Apache::lonnet::get_server_loncaparev($env{'user.domain'},
$userdomserver);
my ($swmajor,$swminor) = ($switchlcrev =~ /^\'?(\d+)\.(\d+)\.[\w.\-]+\'?$/);
if (($swmajor eq '' && $swminor eq '') || ($reqdmajor > $swmajor) ||
(($reqdmajor == $swmajor) && ($reqdminor > $swminor))) {
my $cdom = $env{'course.'.$tcourseid.'.domain'};
if ($cdom ne $env{'user.domain'}) {
my ($coursedomserver,$coursehostname) = &Apache::lonnet::choose_server($cdom);
my $serverhomeID = &Apache::lonnet::get_server_homeID($coursehostname);
my $serverhomedom = &Apache::lonnet::host_domain($serverhomeID);
my %defdomdefaults = &Apache::lonnet::get_domain_defaults($serverhomedom);
my %udomdefaults = &Apache::lonnet::get_domain_defaults($env{'user.domain'});
my $remoterev = &Apache::lonnet::get_server_loncaparev($serverhomedom,$coursedomserver);
my $canhost =
&Apache::lonnet::can_host_session($env{'user.domain'},
$coursedomserver,
$remoterev,
$udomdefaults{'remotesessions'},
$defdomdefaults{'hostedsessions'});
if ($canhost) {
$otherserver = $coursedomserver;
} else {
$warning = &mt('Requires LON-CAPA version [_1].',$env{'course.'.$tcourseid.'.internal.releaserequired'}).' '. &mt("No suitable server could be found amongst servers in either your own domain or in the course's domain.");
}
} else {
$warning = &mt('Requires LON-CAPA version [_1].',$env{'course.'.$tcourseid.'.internal.releaserequired'}).' '.&mt("No suitable server could be found amongst servers in your own domain (which is also the course's domain).");
}
} else {
$otherserver = $userdomserver;
}
}
if ($otherserver ne '') {
$switchserver = 'otherserver='.$otherserver.'&role='.$trolecode;
}
}
}
return ($switchserver,$warning);
}
sub update_content_constraints {
my ($cdom,$cnum,$chome,$cid) = @_;
my %curr_reqd_hash = &Apache::lonnet::userenvironment($cdom,$cnum,'internal.releaserequired');
my ($reqdmajor,$reqdminor) = split(/\./,$curr_reqd_hash{'internal.releaserequired'});
my %checkresponsetypes;
foreach my $key (keys(%Apache::lonnet::needsrelease)) {
my ($item,$name,$value) = split(/:/,$key);
if ($item eq 'resourcetag') {
if ($name eq 'responsetype') {
$checkresponsetypes{$value} = $Apache::lonnet::needsrelease{$key}
}
}
}
my $navmap = Apache::lonnavmaps::navmap->new();
if (defined($navmap)) {
my %allresponses;
foreach my $res ($navmap->retrieveResources(undef,sub { $_[0]->is_problem() },1,0)) {
my %responses = $res->responseTypes();
foreach my $key (keys(%responses)) {
next unless(exists($checkresponsetypes{$key}));
$allresponses{$key} += $responses{$key};
}
}
foreach my $key (keys(%allresponses)) {
my ($major,$minor) = split(/\./,$checkresponsetypes{$key});
if (($major > $reqdmajor) || ($major == $reqdmajor && $minor > $reqdminor)) {
($reqdmajor,$reqdminor) = ($major,$minor);
}
}
undef($navmap);
}
unless (($reqdmajor eq '') && ($reqdminor eq '')) {
&Apache::lonnet::update_released_required($reqdmajor.'.'.$reqdminor,$cdom,$cnum,$chome,$cid);
}
return;
}
sub courselink {
my ($dcdom,$rowtype) = @_;
my $courseform=&Apache::loncommon::selectcourse_link
('rolechoice','dccourse'.$rowtype.'_'.$dcdom,
'dcdomain'.$rowtype.'_'.$dcdom,'coursedesc'.$rowtype.'_'.
$dcdom,$dcdom,undef,'Course/Community');
my $hiddenitems = ''.
''.
''.
'';
return $courseform.$hiddenitems;
}
sub coursepick_jscript {
my %lt = &Apache::lonlocal::texthash(
plsu => "Please use the 'Select Course/Community' link to open a separate pick course window where you may select the course or community you wish to enter.",
youc => 'You can only use this screen to select courses and communities in the current domain.',
);
my $verify_script = <<"END";
END
return $verify_script;
}
sub coauthorlink {
my ($dcdom,$rowtype) = @_;
my $coauthorform=&Apache::loncommon::selectauthor_link('rolechoice',$dcdom);
my $hiddenitems = '';
return $coauthorform.$hiddenitems;
}
sub display_cc_role {
my $rolekey = shift;
my ($roletext,$roletext_end);
my $advanced = $env{'user.adv'};
my $tryagain = $env{'form.tryagain'};
unless ($rolekey =~/^error\:/) {
if ($rolekey =~ m{^user\.role\.(cc|co)\./($match_domain)/($match_courseid)$}) {
my $ccrole = $1;
my $tdom = $2;
my $trest = $3;
my $tcourseid = $tdom.'_'.$trest;
my $trolecode = $ccrole.'./'.$tdom.'/'.$trest;
my $twhere;
my $ttype;
my $tbg='LC_roles_is';
my %newhash=&Apache::lonnet::coursedescription($tcourseid);
if (%newhash) {
$twhere=$newhash{'description'}.
' '.
&Apache::loncommon::syllabuswrapper(&mt('Syllabus'),$trest,$tdom).
'';
$ttype = $newhash{'type'};
} else {
$twhere=&mt('Currently not available');
$env{'course.'.$tcourseid.'.description'}=$twhere;
}
my $trole = &Apache::lonnet::plaintext($ccrole,$ttype,$tcourseid);
$twhere.=" ".&mt('Domain').":".$tdom;
($roletext,$roletext_end) = &build_roletext($trolecode,$tdom,$trest,'is',$tryagain,$advanced,'',$tbg,$trole,$twhere,'','','',1,'');
}
}
return ($roletext,$roletext_end);
}
sub adhoc_roles_row {
my ($dcdom,$rowtype) = @_;
my $output = &Apache::loncommon::continue_data_table_row()
.'
'
.&mt('[_1]Ad hoc[_2] roles in domain [_3] --'
,'','',$dcdom)
.' ';
my $selectcclink = &courselink($dcdom,$rowtype);
my $ccrole = &Apache::lonnet::plaintext('co',undef,undef,1);
my $carole = &Apache::lonnet::plaintext('ca');
my $selectcalink = &coauthorlink($dcdom,$rowtype);
$output.=$ccrole.': '.$selectcclink
.' | '.$carole.': '.$selectcalink.'
'
.&Apache::loncommon::end_data_table_row();
return $output;
}
sub recent_filename {
my $area=shift;
return 'nohist_recent_'.&escape($area);
}
sub courseloadpage {
my ($courseid) = @_;
my $startpage;
my %entry_settings = &Apache::lonnet::get('nohist_whatsnew',
[$courseid.':courseinit']);
my ($tmp) = %entry_settings;
unless ($tmp =~ /^error: 2 /) {
$startpage = $entry_settings{$courseid.':courseinit'};
}
if ($startpage eq '') {
if (exists($env{'environment.course_init_display'})) {
$startpage = $env{'environment.course_init_display'};
}
}
return $startpage;
}
sub update_session_roles {
my $then=$env{'user.login.time'};
my $refresh=$env{'user.refresh.time'};
if (!$refresh) {
$refresh = $then;
}
my $update = $env{'user.update.time'};
if (!$update) {
$update = $then;
}
my $now = time;
my %roleshash =
&Apache::lonnet::get_my_roles('','','userroles',
['active','future','previous'],
undef,undef,1);
my ($msg,@newsec,$oldsec,$currrole_expired,@changed_roles,
%changed_groups,%dbroles,%deletedroles,%allroles,%allgroups,
%userroles,%checkedgroup,%crprivs,$hasgroups,%rolechange,
%groupchange,%newrole,%newgroup,%customprivchg,%groups_roles,
@rolecodes);
my @possroles = ('cr','st','ta','ad','ep','in','co','cc');
my %courseroles;
foreach my $item (keys(%roleshash)) {
my ($uname,$udom,$role,$remainder) = split(/:/,$item,4);
my ($tstart,$tend) = split(/:/,$roleshash{$item});
my ($section,$group,@group_privs);
if ($role =~ m{^gr/(\w*)$}) {
$role = 'gr';
my $priv = $1;
next if ($tstart eq '-1');
if (&curr_role_status($tstart,$tend,$refresh,$now) eq 'active') {
if ($priv ne '') {
push(@group_privs,$priv);
}
}
if ($remainder =~ /:/) {
(my $additional_privs,$group) =
($remainder =~ /^([\w:]+):([^:]+)$/);
if ($additional_privs ne '') {
if (&curr_role_status($tstart,$tend,$refresh,$now) eq 'active') {
push(@group_privs,split(/:/,$additional_privs));
@group_privs = sort(@group_privs);
}
}
} else {
$group = $remainder;
}
} else {
$section = $remainder;
}
my $where = "/$udom/$uname";
if ($section ne '') {
$where .= "/$section";
} elsif ($group ne '') {
$where .= "/$group";
}
my $rolekey = "$role.$where";
my $envkey = "user.role.$rolekey";
$dbroles{$envkey} = 1;
if (($env{'request.role'} eq $rolekey) && ($role ne 'st')) {
if (&curr_role_status($tstart,$tend,$refresh,$now) ne 'active') {
$currrole_expired = 1;
}
}
if ($env{$envkey} eq '') {
my $status_in_db =
&curr_role_status($tstart,$tend,$refresh,$now);
&gather_roleprivs(\%allroles,\%allgroups,\%userroles,$where,$role,$tstart,$tend,$status_in_db);
if (($role eq 'st') && ($env{'request.role'} =~ m{^\Q$role\E\.\Q/$udom/$uname\E})) {
if ($status_in_db eq 'active') {
if ($section eq '') {
push(@newsec,'none');
} else {
push(@newsec,$section);
}
}
} else {
unless (grep(/^\Q$role\E$/,@changed_roles)) {
push(@changed_roles,$role);
}
if ($status_in_db ne 'previous') {
if ($role eq 'gr') {
$newgroup{$rolekey} = $status_in_db;
if ($status_in_db eq 'active') {
unless (ref($courseroles{$udom}) eq 'HASH') {
%{$courseroles{$udom}} =
&Apache::lonnet::get_my_roles('','','userroles',
['active'],\@possroles,
[$udom],1);
}
&Apache::lonnet::get_groups_roles($udom,$uname,
$courseroles{$udom},
\@rolecodes,\%groups_roles);
}
} else {
$newrole{$rolekey} = $status_in_db;
}
}
}
} else {
my ($currstart,$currend) = split(/\./,$env{$envkey});
if ($role eq 'gr') {
if (&curr_role_status($currstart,$currend,$refresh,$update) ne 'previous') {
$hasgroups = 1;
}
}
if (($currstart ne $tstart) || ($currend ne $tend)) {
my $status_in_env =
&curr_role_status($currstart,$currend,$refresh,$update);
my $status_in_db =
&curr_role_status($tstart,$tend,$refresh,$now);
if ($status_in_env ne $status_in_db) {
if ($status_in_env eq 'active') {
if ($role eq 'st') {
if ($env{'request.role'} eq $rolekey) {
my $switchsection;
unless (ref($courseroles{$udom}) eq 'HASH') {
%{$courseroles{$udom}} =
&Apache::lonnet::get_my_roles('','','userroles',
['active'],
\@possroles,[$udom],1);
}
foreach my $crsrole (keys(%{$courseroles{$udom}})) {
if ($crsrole =~ /^\Q$uname\E:\Q$udom\E:st/) {
$switchsection = 1;
last;
}
}
if ($switchsection) {
if ($section eq '') {
$oldsec = 'none';
} else {
$oldsec = $section;
}
&gather_roleprivs(\%allroles,\%allgroups,\%userroles,$where,$role,$tstart,$tend,$status_in_db);
} else {
$currrole_expired = 1;
next;
}
}
}
unless ($rolekey eq $env{'request.role'}) {
if ($role eq 'gr') {
&Apache::lonnet::delete_env_groupprivs($where,\%courseroles,\@possroles);
} else {
&Apache::lonnet::delenv("user.priv.$rolekey",undef,[$role]);
&Apache::lonnet::delenv("user.priv.cm.$where",undef,['cm']);
}
&gather_roleprivs(\%allroles,\%allgroups,\%userroles,$where,$role,$tstart,$tend,$status_in_db);
}
} elsif ($status_in_db eq 'active') {
if (($role eq 'st') &&
($env{'request.role'} =~ m{^\Q$role\E\.\Q/$udom/$uname\E})) {
if ($section eq '') {
push(@newsec,'none');
} else {
push(@newsec,$section);
}
} elsif ($role eq 'gr') {
unless (ref($courseroles{$udom}) eq 'HASH') {
%{$courseroles{$udom}} =
&Apache::lonnet::get_my_roles('','','userroles',
['active'],
\@possroles,[$udom],1);
}
&Apache::lonnet::get_groups_roles($udom,$uname,
$courseroles{$udom},
\@rolecodes,\%groups_roles);
}
&gather_roleprivs(\%allroles,\%allgroups,\%userroles,$where,$role,$tstart,$tend,$status_in_db);
}
unless (grep(/^\Q$role\E$/,@changed_roles)) {
push(@changed_roles,$role);
}
if ($role eq 'gr') {
$groupchange{"/$udom/$uname"}{$group} = $status_in_db;
} else {
$rolechange{$rolekey} = $status_in_db;
}
}
} else {
if ($role eq 'gr') {
unless ($checkedgroup{$where}) {
my $status_in_db =
&curr_role_status($tstart,$tend,$refresh,$now);
if ($tstart eq '-1') {
$status_in_db = 'deleted';
}
unless (ref($courseroles{$udom}) eq 'HASH') {
%{$courseroles{$udom}} =
&Apache::lonnet::get_my_roles('','','userroles',
['active'],
\@possroles,[$udom],1);
}
if (ref($courseroles{$udom}) eq 'HASH') {
foreach my $item (keys(%{$courseroles{$udom}})) {
next unless ($item =~ /^\Q$uname\E/);
my ($cnum,$cdom,$crsrole,$crssec) = split(/:/,$item);
my $area = '/'.$cdom.'/'.$cnum;
if ($crssec ne '') {
$area .= '/'.$crssec;
}
my $crsrolekey = $crsrole.'.'.$area;
my $currprivs = $env{'user.priv.'.$crsrole.'.'.$area.'.'.$where};
$currprivs =~ s/^://;
$currprivs =~ s/\&F$//;
my @curr_grp_privs = split(/\&F:/,$currprivs);
@curr_grp_privs = sort(@curr_grp_privs);
my @diffs;
if (@group_privs > 0 || @curr_grp_privs > 0) {
@diffs = &Apache::loncommon::compare_arrays(\@group_privs,\@curr_grp_privs);
}
if (@diffs == 0) {
last;
} else {
unless(grep(/^\Qgr\E$/,@rolecodes)) {
push(@rolecodes,'gr');
}
&gather_roleprivs(\%allroles,\%allgroups,
\%userroles,$where,$role,
$tstart,$tend,$status_in_db);
if ($status_in_db eq 'active') {
&Apache::lonnet::get_groups_roles($udom,$uname,
$courseroles{$udom},
\@rolecodes,\%groups_roles);
}
$changed_groups{$udom.'_'.$uname}{$group} = $status_in_db;
last;
}
}
}
$checkedgroup{$where} = 1;
}
} elsif ($role =~ /^cr/) {
my $status_in_db =
&curr_role_status($tstart,$tend,$refresh,$now);
my ($rdummy,$rest) = split(/\//,$role,2);
my ($rdummy,$rdomain,$rauthor,$rrole)=split(/\//,$role);
my %currpriv;
unless (exists($crprivs{$rest})) {
my ($rdomain,$rauthor,$rrole)=split(/\//,$rest);
my $homsvr=&Apache::lonnet::homeserver($rauthor,$rdomain);
if (&Apache::lonnet::hostname($homsvr) ne '') {
my ($rdummy,$roledef)=
&Apache::lonnet::get('roles',["rolesdef_$rrole"],
$rdomain,$rauthor);
if (($rdummy ne 'con_lost') && ($roledef ne '')) {
my $i = 0;
my @scopes = ('sys','dom','crs');
my @privs = split(/\_/,$roledef);
foreach my $priv (@privs) {
my ($blank,@prv) = split(/:/,$priv);
@prv = map { $_ .= (/\&\w+$/ ? '':'&F') } @prv;
if (@prv) {
$priv = ':'.join(':',sort(@prv));
}
$crprivs{$rest}{$scopes[$i]} = $priv;
$i++;
}
}
}
}
$currpriv{sys} = $env{"user.priv.$rolekey./"};
$currpriv{dom} = $env{"user.priv.$rolekey./$udom/"};
$currpriv{crs} = $env{"user.priv.$rolekey.$where"};
if (keys(%crprivs)) {
if (($crprivs{$rest}{sys} ne $currpriv{sys}) ||
($crprivs{$rest}{dom} ne $currpriv{dom})
||
($crprivs{$rest}{crs} ne $currpriv{crs})) {
&gather_roleprivs(\%allroles,\%allgroups,\%userroles,$where,$role,$tstart,$tend,$status_in_db);
unless (grep(/^\Q$role\E$/,@changed_roles)) {
push(@changed_roles,$role);
}
my $status_in_env =
&curr_role_status($currstart,$currend,$refresh,$update);
if ($status_in_env eq 'active') {
$customprivchg{$rolekey} = $status_in_env;
}
}
}
}
}
}
}
foreach my $envkey (keys(%env)) {
next unless ($envkey =~ /^user\.role\./);
next if ($dbroles{$envkey});
next if ($envkey eq 'user.role.'.$env{'request.role'});
my ($currstart,$currend) = split(/\./,$env{$envkey});
my $status_in_env =
&curr_role_status($currstart,$currend,$refresh,$update);
my ($rolekey) = ($envkey =~ /^user\.role\.(.+)$/);
my ($role,$rest)=split(/\./,$rolekey,2);
if (&Apache::lonnet::delenv($envkey,undef,[$role])) {
if ($status_in_env eq 'active') {
if ($role eq 'gr') {
&Apache::lonnet::delete_env_groupprivs($rest,\%courseroles,
\@possroles);
} else {
&Apache::lonnet::delenv("user.priv.$rolekey",undef,[$role]);
&Apache::lonnet::delenv("user.priv.cm.$rest",undef,['cm']);
}
unless (grep(/^\Q$role\E$/,@changed_roles)) {
push(@changed_roles,$role);
}
$deletedroles{$rolekey} = 1;
}
}
}
if (($oldsec) && (@newsec > 0)) {
if (@newsec > 1) {
$msg = '
'.&mt('The section has changed for your current role. Log-out and log-in again to select a role for the new section.').'
';
} else {
my $newrole = $env{'request.role'};
if ($newsec[0] eq 'none') {
$newrole =~ s{(/[^/])$}{};
} elsif ($oldsec eq 'none') {
$newrole .= '/'.$newsec[0];
} else {
$newrole =~ s{([^/]+)$}{$newsec[0]};
}
my $coursedesc = $env{'course.'.$env{'request.course.id'}.'.description'};
my ($curr_role) = ($env{'request.role'} =~ m{^(\w+)\./$match_domain/$match_courseid});
my %temp=('logout_'.$env{'request.course.id'} => time);
&Apache::lonnet::put('email_status',\%temp);
&Apache::lonnet::delenv('user.state.'.$env{'request.course.id'});
&Apache::lonnet::appenv({"request.course.id" => '',
"request.course.fn" => '',
"request.course.uri" => '',
"request.course.sec" => '',
"request.role" => 'cm',
"request.role.adv" => $env{'user.adv'},
"request.role.domain" => $env{'user.domain'}});
my $rolename = &Apache::loncommon::plainname($curr_role);
$msg = ''.
''.
''.
''.
&mt('Your section has changed for your current [_1] role in [_2].',$rolename,$coursedesc).' ';
my $button = '';
if ($newsec[0] eq 'none') {
$msg .= &mt('[_1] to continue with your new section-less role.',$button);
} else {
$msg .= &mt('[_1] to continue with your new role in section ([_2]).',$button,$newsec[0]);
}
$msg .= '';
}
} elsif ($currrole_expired) {
$msg .= '
';
if (&Apache::loncommon::show_course()) {
$msg .= &mt('Your role in the current course has expired.');
} else {
$msg .= &mt('Your current role has expired.');
}
$msg .= ' '.&mt('However you can continue to use this role until you logout, click the "Re-Select" button, or your session has been idle for more than 24 hours.').'
';
}
if (!@changed_roles || !(keys(%changed_groups))) {
my ($rolesmsg,$groupsmsg);
if (!@changed_roles) {
if (&Apache::loncommon::show_course()) {
$rolesmsg = &mt('No new courses or communities');
} else {
$rolesmsg = &mt('No role changes');
}
}
if ($hasgroups && !(keys(%changed_groups)) && !(grep(/gr/,@changed_roles))) {
$groupsmsg = &mt('No changes in course/community groups');
}
if (!@changed_roles && !(keys(%changed_groups))) {
if (($msg ne '') || ($groupsmsg ne '')) {
$msg .= '
';
if ($rolesmsg) {
$msg .= '
'.$rolesmsg.'
';
}
if ($groupsmsg) {
$msg .= '
'.$groupsmsg.'
';
}
$msg .= '
';
} else {
$msg = ' '.$rolesmsg.' ';
}
return $msg;
}
}
my $changemsg;
if (@changed_roles > 0) {
if (keys(%newgroup) > 0) {
my $groupmsg;
foreach my $item (sort(keys(%newgroup))) {
if (&is_active_course($item,$refresh,$update,\%roleshash)) {
$groupmsg .= '
'.
&mt('[_1] with status: [_2].',
$item,$newgroup{$item}).'
';
}
}
if ($groupmsg) {
$changemsg .= '
'.
&mt('Courses with new groups').'
'.
'
'.$groupmsg.'
';
}
}
if (keys(%newrole) > 0) {
$changemsg .= '
'.&mt('New roles').
'
';
foreach my $item (sort(keys(%newrole))) {
$changemsg .= '
'.
&mt('[_1] with status: [_2].',
$item,$newrole{$item}).'
';
}
$changemsg .= '
';
}
if (keys(%customprivchg) > 0) {
$changemsg .= '
'.
&mt('Custom roles with privilege changes').
'
';
foreach my $item (sort(keys(%customprivchg))) {
$changemsg .= '
'.$item.'
';
}
$changemsg .= '
';
}
if (keys(%rolechange) > 0) {
$changemsg .= '
'.
&mt('Existing roles with status changes').'
'.
'
';
foreach my $item (sort(keys(%rolechange))) {
$changemsg .= '
'.
&mt('[_1] status now: [_2].',$item,
$rolechange{$item}).'
';
}
$changemsg .= '
';
}
if (keys(%deletedroles) > 0) {
$changemsg .= '
'.
&mt('Existing roles deleted').'
'.
'
';
foreach my $item (sort(keys(%deletedroles))) {
$changemsg .= '
'.$item.'
';
}
$changemsg .= '
';
}
}
if ((keys(%changed_groups) > 0) || (keys(%groupchange) > 0)) {
my $groupchgmsg;
foreach my $key (sort(keys(%changed_groups))) {
my $crs = 'gr/'.$key;
$crs =~ s/_/\//;
if (&is_active_course($crs,$refresh,$update,\%roleshash)) {
if (ref($changed_groups{$key}) eq 'HASH') {
my @showgroups;
foreach my $group (sort(keys(%{$changed_groups{$key}}))) {
if ($changed_groups{$key}{$group} eq 'active') {
push(@showgroups,$group);
}
}
if (@showgroups > 0) {
$groupchgmsg .= '
'.
&mt('Existing course/community groups with status changes').'
'.
'
';
foreach my $crs (sort(keys(%groupchange))) {
if (ref($groupchange{$crs}) eq 'HASH') {
$groupchgmsg .= '
'.&mt('Course/Community: [_1]',''.$crs.'
');
foreach my $group (sort(keys(%{$groupchange{$crs}}))) {
$groupchgmsg .= '
'.&mt('Group: [_1] status now: [_2].',''.$group.'',$groupchange{$crs}{$group}).'
';
}
$groupchgmsg .= '
';
}
}
$groupchgmsg .= '
';
}
if ($groupchgmsg) {
$changemsg .= '
'.
&mt('Courses with changes in groups').'
'.
'
'.$groupchgmsg.'
';
}
}
if ($changemsg) {
$msg .= '
'.$changemsg.'
';
}
&Apache::lonnet::set_userprivs(\%userroles,\%allroles,\%allgroups,\%groups_roles);
my ($curr_is_adv,$curr_role_adv,$curr_author,$curr_role_author);
$curr_author = $env{'user.author'};
if (($env{'request.role'} =~/^au/) || ($env{'request.role'} =~/^ca/) ||
($env{'request.role'} =~/^aa/)) {
$curr_role_author=1;
}
$curr_is_adv = $env{'user.adv'};
$curr_role_adv = $env{'request.role.adv'};
if (keys(%userroles) > 0) {
foreach my $role (@changed_roles) {
unless(grep(/^\Q$role\E$/,@rolecodes)) {
push(@rolecodes,$role);
}
}
unless(grep(/^\Qcm\E$/,@rolecodes)) {
push(@rolecodes,'cm');
}
&Apache::lonnet::appenv(\%userroles,\@rolecodes);
}
my %newenv;
if (&Apache::lonnet::is_advanced_user($env{'user.domain'},$env{'user.name'})) {
unless ($curr_is_adv) {
$newenv{'user.adv'} = 1;
}
} elsif ($curr_is_adv && !$curr_role_adv) {
&Apache::lonnet::delenv('user.adv');
}
my %authorroleshash =
&Apache::lonnet::get_my_roles('','','userroles',['active'],['au','ca','aa']);
if (keys(%authorroleshash)) {
unless ($curr_author) {
$newenv{'user.author'} = 1;
}
} elsif ($curr_author && !$curr_role_author) {
&Apache::lonnet::delenv('user.author');
}
if ($env{'request.course.id'}) {
my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
my (@activecrsgroups,$crsgroupschanged);
if ($env{'request.course.groups'}) {
@activecrsgroups = split(/:/,$env{'request.course.groups'});
foreach my $item (keys(%deletedroles)) {
if ($item =~ m{^gr\./\Q$cdom\E/\Q$cnum\E/(\w+)$}) {
if (grep(/^\Q$1\E$/,@activecrsgroups)) {
$crsgroupschanged = 1;
last;
}
}
}
}
unless ($crsgroupschanged) {
foreach my $item (keys(%newgroup)) {
if ($item =~ m{^gr\./\Q$cdom\E/\Q$cnum\E/(\w+)$}) {
if ($newgroup{$item} eq 'active') {
$crsgroupschanged = 1;
last;
}
}
}
}
if ((ref($changed_groups{$env{'request.course.id'}}) eq 'HASH') ||
(ref($groupchange{"/$cdom/$cnum"}) eq 'HASH') ||
($crsgroupschanged)) {
my %grouproles = &Apache::lonnet::get_my_roles('','','userroles',
['active'],['gr'],[$cdom],1);
my @activegroups;
foreach my $item (keys(%grouproles)) {
next unless($item =~ /^\Q$cnum\E:\Q$cdom\E/);
my $group;
my ($crsn,$crsd,$role,$remainder) = split(/:/,$item,4);
if ($remainder =~ /:/) {
(my $other,$group) = ($remainder =~ /^([\w:]+):([^:]+)$/);
} else {
$group = $remainder;
}
if ($group ne '') {
push(@activegroups,$group);
}
}
$newenv{'request.course.groups'} = join(':',@activegroups);
}
}
if (keys(%newenv)) {
&Apache::lonnet::appenv(\%newenv);
}
return $msg;
}
sub curr_role_status {
my ($start,$end,$refresh,$update) = @_;
if (($start) && ($start<0)) { return 'deleted' };
my $status = 'active';
if (($end) && ($end<=$update)) {
$status = 'previous';
}
if (($start) && ($refresh<$start)) {
$status = 'future';
}
return $status;
}
sub gather_roleprivs {
my ($allroles,$allgroups,$userroles,$area,$role,$tstart,$tend,$status) = @_;
return unless ((ref($allroles) eq 'HASH') && (ref($allgroups) eq 'HASH') && (ref($userroles) eq 'HASH'));
if (($area ne '') && ($role ne '')) {
&Apache::lonnet::userrolelog($role,$env{'user.name'},$env{'user.domain'},
$area,$tstart,$tend);
my $spec=$role.'.'.$area;
$userroles->{'user.role.'.$spec} = $tstart.'.'.$tend;
my ($tdummy,$tdomain,$trest)=split(/\//,$area);
if ($status eq 'active') {
if ($role =~ /^cr\//) {
&Apache::lonnet::custom_roleprivs($allroles,$role,$tdomain,$trest,$spec,$area);
} elsif ($role eq 'gr') {
my %rolehash = &Apache::lonnet::get('roles',[$area.'_'.$role],
$env{'user.domain'},
$env{'user.name'});
my ($trole) = split(/_/,$rolehash{$area.'_'.$role},2);
(undef,my $group_privs) = split(/\//,$trole);
$group_privs = &unescape($group_privs);
&Apache::lonnet::group_roleprivs($allgroups,$area,$group_privs,$tend,$tstart);
} else {
&Apache::lonnet::standard_roleprivs($allroles,$role,$tdomain,$spec,$trest,$area);
}
}
}
return;
}
sub is_active_course {
my ($rolekey,$refresh,$update,$roleshashref) = @_;
return unless(ref($roleshashref) eq 'HASH');
my ($role,$cdom,$cnum) = split(/\//,$rolekey);
my $is_active;
foreach my $key (keys(%{$roleshashref})) {
if ($key =~ /^\Q$cnum\E:\Q$cdom\E:/) {
my ($tstart,$tend) = split(/:/,$roleshashref->{$key});
my $status = &curr_role_status($tstart,$tend,$refresh,$update);
if ($status eq 'active') {
$is_active = 1;
last;
}
}
}
return $is_active;
}
1;
__END__
=head1 NAME
Apache::lonroles - User Roles Screen
=head1 SYNOPSIS
Invoked by /etc/httpd/conf/srm.conf:
PerlAccessHandler Apache::lonacc
SetHandler perl-script
PerlHandler Apache::lonroles
ErrorDocument 403 /adm/login
ErrorDocument 500 /adm/errorhandler
=head1 OVERVIEW
=head2 Choosing Roles
C is a handler that allows a user to switch roles in
mid-session. LON-CAPA attempts to work with "No Role Specified", the
default role that a user has before selecting a role, as widely as
possible, but certain handlers for example need specification which
course they should act on, etc. Both in this scenario, and when the
handler determines via C's C<&allowed> function that a certain
action is not allowed, C is used as error handler. This
allows the user to select another role which may have permission to do
what they were trying to do.
=begin latex
\begin{figure}
\begin{center}
\includegraphics[width=0.45\paperwidth,keepaspectratio]{Sample_Roles_Screen}
\caption{\label{Sample_Roles_Screen}Sample Roles Screen}
\end{center}
\end{figure}
=end latex
=head2 Role Initialization
The privileges for a user are established at login time and stored in the session environment. As a consequence, a new role does not become active till the next login. Handlers are able to query for privileges using C's C<&allowed> function. When a user first logs in, their role is the "common" role, which means that they have the sum of all of their privileges. During a session it might become necessary to choose a particular role, which as a consequence also limits the user to only the privileges in that particular role.
=head1 INTRODUCTION
This module enables a user to select what role he wishes to
operate under (instructor, student, teaching assistant, course
coordinator, etc). These roles are pre-established by the actions
of upper-level users.
This is part of the LearningOnline Network with CAPA project
described at http://www.lon-capa.org.
=head1 HANDLER SUBROUTINE
This routine is called by Apache and mod_perl.
=over 4
=item *
Roles Initialization (yes/no)
=item *
Get Error Message from Environment
=item *
Who is this?
=item *
Generate Page Output
=item *
Choice or no choice
=item *
Table
=item *
Privileges
=back
=cut