# The LearningOnline Network with CAPA
# User Roles Screen
#
# $Id: lonroles.pm,v 1.106 2004/11/11 22:18:23 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::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;
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::lonnavmaps::launch_win('now');
} else {
$navwindow.=&Apache::lonnavmaps::close();
}
my $bodytag=&Apache::loncommon::bodytag('Switching Role');
# Note to style police:
# This must only replace the spaces, nothing else, or it bombs elsewhere.
$url=~s/ /\%20/g;
$r->print(<<ENDREDIR);
<head><title>$title</title>
<meta HTTP-EQUIV="Refresh" CONTENT="1; url=$url">
</head>
<html>
$bodytag
<script type="text/javascript">
$swinfo
</script>
$navwindow
<h1>$msg</h1>
<a href="$url">Continue</a>
</body>
</html>
ENDREDIR
return;
}
sub handler {
my $r = shift;
my $now=time;
my $then=$ENV{'user.login.time'};
my $envkey;
my $dcselect='';
# ================================================================== Roles Init
if ($ENV{'form.selectrole'}) {
if ($ENV{'form.dcselected'}) {
my $dcdom = $ENV{'form.dcselected'};
my $dckey = 'user.role.dc./'.$dcdom.'/';
if ($ENV{$dckey}) {
my ($dcstart,$dcend)=split(/\./,$ENV{$dckey});
my $active_dc = 1;
if ($dcstart) {
if ($dcstart>$then) {
$active_dc = 0;
}
}
if ($dcend) {
if ($dcend < $then) {
$active_dc = 0;
}
}
if ($active_dc) {
$dcselect = $dcdom;
}
}
}
if ($ENV{'request.course.id'}) {
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 to see if the user is a DC trying to enter a course
# course selection page
my $dcflag = 0;
if ($ENV{'form.dccourse'}) {
my $dcdom = $ENV{'form.dcdomain'};
my $pickedcourse = $ENV{'form.dccourse'};
if ($dcdom && $pickedcourse) {
unless ($ENV{'user.role.cc./'.$dcdom.'/'.$pickedcourse}) {
if ($ENV{'user.role.dc./'.$dcdom.'/'}) {
&set_privileges($dcdom,$pickedcourse);
my $msg=&mt('Entering course ...');
my ($furl,$ferr)=&Apache::lonuserstate::readmap($dcdom.'/'.$pickedcourse);
my $formaction = '/adm/roles/';
my $courseid = $dcdom.'_'.$pickedcourse;
&Apache::lonhtmlcommon::store_recent('cc_pickby_dc_'.$dcdom,
$courseid,$formaction);
# Send the user to the course they selected
&redirect_user($r,&mt('Entering Course'),
$furl,$msg,
$ENV{'environment.remotenavmap'});
return OK;
}
}
}
}
foreach $envkey (keys %ENV) {
next if ($envkey!~/^user\.role\./);
my ($where,$trolecode,$role,$tstatus,$tend,$tstart);
&role_status($envkey,$then,$now,\$role,\$where,\$trolecode,\$tstatus,\$tstart,\$tend);
if ($ENV{'form.'.$trolecode}) {
if ($tstatus eq 'is') {
$where=~s/^\///;
my ($cdom,$cnum,$csec)=split(/\//,$where);
# 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(/\W/,$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 $bodytag=&Apache::loncommon::bodytag
('Verifying Access Key to Unlock this Course');
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'},
'Assigned from '.$ENV{'REMOTE_ADDR'}.' at '.localtime().' for '.
$trolecode);
unless ($assignresult eq 'ok') {
$assignresult=~s/^error\:\s*//;
$message=&mt($assignresult).
'<br /><a href="/adm/logout">'.
&mt('Logout').'</a>';
$buttontext=&mt('Re-Enter Key');
}
$r->print(<<ENDENTEREDKEY);
<head><title>Verifying Course Access Key</title>
</head>
<html>
$bodytag
<script>
$swinfo
</script>
<form method="post">
<input type="hidden" name="selectrole" value="1" />
<input type="hidden" name="$trolecode" value="1" />
<font size="+2">$message</font><br />
<input type="submit" value="$buttontext" />
</form>
</body></html>
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 $bodytag=&Apache::loncommon::bodytag
('Enter Access Key to Unlock this Course');
$r->print(<<ENDENTERKEY);
<head><title>Entering Course Access Key</title>
</head>
<html>
$bodytag
<script>
$swinfo
</script>
<form method="post">
<input type="hidden" name="selectrole" value="1" />
<input type="hidden" name="$trolecode" value="1" />
<input type="text" size="20" name="newkey" value="$ENV{'form.newkey'}" />
<input type="submit" value="Enter key" />
</form>
</body></html>
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);
my $tadv=0;
if (&Apache::lonnet::allowed('adv') eq 'F') { $tadv=1; }
&Apache::lonnet::appenv('request.role.adv' => $tadv);
my $msg=&mt('Entering course ...');
if (($cnum) && ($role ne 'ca')) {
my ($furl,$ferr)=
&Apache::lonuserstate::readmap($cdom.'/'.$cnum);
if (($ENV{'form.orgurl'}) &&
($ENV{'form.orgurl'}!~/^\/adm\/flip/)) {
my $dest=$ENV{'form.orgurl'};
if ( &Apache::lonnet::mod_perl_version() == 2 ) {
&Apache::lonnet::cleanenv();
}
$r->internal_redirect($dest);
return OK;
} else {
unless ($ENV{'request.course.id'}) {
&Apache::lonnet::appenv(
"request.course.id" => $cdom.'_'.$cnum);
$furl='/adm/roles?tryagain=1';
$msg=
'<h1><font color=red>'.
&mt('Could not initialize course at this time.').
'</font></h1><h3>'.&mt('Please try again.').'</h3>'.$ferr;
}
# 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' && $ENV{'course.' . $courseid .
'.course.helper.not.run'}) {
$furl = "/adm/helper/course.initialization.helper";
}
# Check to see if the user is a DC coming from the
# course selection page
my $dcflag = 0;
if ($ENV{'form.dccourse'}) {
my $formaction = '/adm/roles/';
my ($dcdom,$pickedcourse) = split/_/,$courseid;
if ($ENV{'user.role.dc./'.$dcdom.'/'}) {
&Apache::lonhtmlcommon::store_recent('cc_pickby_dc_'.$dcdom,
$courseid,$formaction);
}
}
#
# Send the user to the course they selected
&redirect_user($r,&mt('Entering Course'),
$furl,$msg,
$ENV{'environment.remotenavmap'});
return OK;
}
}
#
# Send the user to the construction space they selected
if ($role =~ /^(au|ca)$/) {
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') {
unless ($dcselect) {
my $redirect_url = '/adm/menu/';
&redirect_user($r,&mt('Loading Domain Coordinator Menu'),
$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 $swinfo=&Apache::lonmenu::rawconfig();
my $setDCchoice = &dc_script();
my $bodytag=&Apache::loncommon::bodytag('User Roles');
my $helptag='<table><tr><td>'.&Apache::loncommon::help_open_menu('','General Intro','General_Intro','User Roles',1,undef,undef,undef,undef,,&mt("Click here for help")).'</td></td></tr></table>';
$r->print(<<ENDHEADER);
<html>
<head>
<title>LON-CAPA User Roles</title>
</head>
$bodytag
$helptag<br />
<script>
$swinfo
window.focus();
$setDCchoice
</script>
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'};
# -------------------------------------------------------- Generate Page Output
# -------------------------------------------------------- Domain Coordinator?
if ($dcselect ne '') {
&choosecourse_display($r,$dcselect,$then,$now);
return OK;
}
# --------------------------------------------------------------- Error Header?
if ($error) {
$r->print("<h1>LON-CAPA Access Control</h1>");
$r->print("<hr><pre>Access : ".
Apache::lonnet::plaintext($priv)."\n");
$r->print("Resource: $fn\n");
$r->print("Action : $msg\n</pre><hr>");
} else {
if ($ENV{'user.error.msg'}) {
$r->print(
'<h3><font color=red>'.
&mt('You need to choose another user role or enter a specific course for this function').'</font></h3>');
}
}
# -------------------------------------------------------- Choice or no choice?
if ($nochoose) {
if ($advanced) {
$r->print("<h2>".&mt('Assigned User Roles')."</h2>\n");
} else {
$r->print("<h2>".&mt('Sorry ...')."</h2>\n".
&mt('This resource might be part of'));
if ($ENV{'request.course.id'}) {
$r->print(&mt(' another'));
} else {
$r->print(&mt(' a certain'));
}
$r->print(&mt(' course.').'</body></html>');
return OK;
}
} else {
if ($advanced) {
$r->print(&mt("Your home server is ").
$Apache::lonnet::hostname{&Apache::lonnet::homeserver
($ENV{'user.name'},$ENV{'user.domain'})}.
"<br />\n");
$r->print(&mt(
"Author and Co-Author roles may not be available on servers other than your home server."));
}
if (($ENV{'REDIRECT_QUERY_STRING'}) && ($fn)) {
$fn.='?'.$ENV{'REDIRECT_QUERY_STRING'};
}
$r->print('<form method="post" name="rolechoice" action="'.(($fn)?$fn:$r->uri).'">');
$r->print('<input type=hidden name=orgurl value="'.$fn.'">');
$r->print('<input type=hidden name=selectrole value=1>');
}
if ($ENV{'user.adv'}) {
$r->print(
'<br />'.&mt('Show all roles').': <input type="checkbox" name="showall"');
if ($ENV{'form.showall'}) { $r->print(' checked'); }
$r->print('><input type=submit value="'.&mt('Display').'">');
}
my %dcroles = ();
my $numdc = &check_fordc(\%dcroles,$then);
my (%roletext,%sortrole,%roleclass);
my $countactive=0;
my $inrole=0;
my $possiblerole='';
foreach $envkey (sort keys %ENV) {
my $button = 1;
my $switchserver='';
my $roletext;
my $sortkey;
if ($envkey=~/^user\.role\./) {
my ($role,$where,$trolecode,$tstart,$tend,$tremark,$tstatus,$tpstart,$tpend,$tfont);
&role_status($envkey,$then,$now,\$role,\$where,\$trolecode,\$tstatus,\$tstart,\$tend);
next if (!defined($role) || $role eq '');
$tremark='';
$tpstart=' ';
$tpend=' ';
$tfont='#000000';
if ($tstart) {
$tpstart=&Apache::lonlocal::locallocaltime($tstart);
}
if ($tend) {
$tpend=&Apache::lonlocal::locallocaltime($tend);
}
if ($ENV{'request.role'} eq $trolecode) {
$tstatus='selected';
}
my $tbg;
if (($tstatus eq 'is') || ($tstatus eq 'selected') ||
($ENV{'form.showall'})) {
if ($tstatus eq 'is') {
$tbg='#77FF77';
$tfont='#003300';
$possiblerole=$trolecode;
$countactive++;
} elsif ($tstatus eq 'future') {
$tbg='#FFFF77';
$button=0;
} elsif ($tstatus eq 'will') {
$tbg='#FFAA77';
$tremark.=&mt('Active at next login. ');
} elsif ($tstatus eq 'expired') {
$tbg='#FF7777';
$tfont='#330000';
$button=0;
} elsif ($tstatus eq 'will_not') {
$tbg='#AAFF77';
$tremark.=&mt('Expired after logout. ');
} elsif ($tstatus eq 'selected') {
$tbg='#11CC55';
$tfont='#002200';
$inrole=1;
$countactive++;
$tremark.=&mt('Currently selected. ');
}
my $trole;
if ($role =~ /^cr\//) {
my ($rdummy,$rdomain,$rauthor,$rrole)=split(/\//,$role);
$tremark.='<br>'.&mt('Defined by ').$rauthor.
&mt(' at ').$rdomain.'.';
$trole=$rrole;
} else {
$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') {
my $home = &Apache::lonnet::homeserver($trest,$tdom);
my $allowed=0;
my @ids=&Apache::lonnet::current_machine_ids();
foreach my $id (@ids) { if ($id eq $home) { $allowed=1; } }
if (!$allowed) {
$button=0;
$switchserver=&Apache::lonnet::escape('http://'.
$Apache::lonnet::hostname{$home}.
'/adm/login?domain='.$ENV{'user.domain'}.
'&username='.$ENV{'user.name'}.
'&firsturl=/priv/'.$trest.'/');
}
#next if ($home eq 'no_host');
$home = $Apache::lonnet::hostname{$home};
$ttype='Construction Space';
$twhere=&mt('User').': '.$trest.'<br />'.&mt('Domain').
': '.$tdom.'<br />'.
' '.&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;
my @ids=&Apache::lonnet::current_machine_ids();
foreach my $id (@ids) { if ($id eq $home) { $allowed=1; } }
if (!$allowed) {
$button=0;
$switchserver=&Apache::lonnet::escape('http://'.
$Apache::lonnet::hostname{$home}.
'/adm/login?domain='.$ENV{'user.domain'}.
'&username='.$ENV{'user.name'}.
'&firsturl=/priv/'.$ENV{'user.name'}.'/');
}
#next if ($home eq 'no_host');
$home = $Apache::lonnet::hostname{$home};
$ttype='Construction Space';
$twhere=&mt('Domain').': '.$tdom.'<br />'.&mt('Server').
': '.$home;
$ENV{'course.'.$tdom.'_'.$trest.'.description'}='ca';
$tremark.=&Apache::lonhtmlcommon::authorbombs('/res/'.$tdom.'/'.$ENV{'user.name'}.'/');
$sortkey=$role;
} elsif ($trest) {
$ttype='Course';
if ($tsection) {
$ttype.='<br>'.&mt('Section/Group').': '.$tsection;
}
my $tcourseid=$tdom.'_'.$trest;
if ($ENV{'course.'.$tcourseid.'.description'}) {
$twhere=$ENV{'course.'.$tcourseid.'.description'};
$sortkey=$role."\0".$tdom."\0".$twhere."\0".$envkey;
unless ($twhere eq &mt('Currently not available')) {
$twhere.=' <font size="-2">'.
&Apache::loncommon::syllabuswrapper(&mt('Syllabus'),$trest,$tdom,$tfont).
'</font>';
}
} else {
my %newhash=&Apache::lonnet::coursedescription($tcourseid);
if (%newhash) {
$sortkey=$role."\0".$tdom."\0".$newhash{'description'}.
"\0".$envkey;
$twhere=$newhash{'description'}.
' <font size="-2">'.
&Apache::loncommon::syllabuswrapper(&mt('Syllabus'),$trest,$tdom,$tfont).
'</font>';
} else {
$twhere=&mt('Currently not available');
$ENV{'course.'.$tcourseid.'.description'}=$twhere;
$sortkey=$role."\0".$tdom."\0".$twhere."\0".$envkey;
}
}
if ($role ne 'st') { $twhere.="<br />".&mt('Domain').":".$tdom; }
} elsif ($tdom) {
$ttype='Domain';
$twhere=$tdom;
$sortkey=$role.$twhere;
} else {
$ttype='System';
$twhere=&mt('system wide');
$sortkey=$role.$twhere;
}
$roletext.='<tr bgcolor='.$tbg.'>';
unless ($nochoose) {
if (!$button) {
if ($switchserver) {
$roletext.='<td><a href="/adm/logout?handover='.
$switchserver.'">'.&mt('Switch Server').'</a></td>';
} else {
$roletext.=('<td> </td>');
}
} elsif ($tstatus eq 'is') {
$roletext.=('<td><input type=submit value="'.
&mt('Select').'" name="'.
$trolecode.'"></td>');
} elsif ($tryagain) {
$roletext.=
'<td><input type=submit value="'.
&mt('Try Selecting Again').'" name="'.$trolecode.'"></td>';
} elsif ($advanced) {
$roletext.=
'<td><input type=submit value="'.
&mt('Re-Initialize').'" name="'.$trolecode.'"></td>';
} else {
$roletext.='<td> </td>';
}
}
$tremark.=&Apache::lonannounce::showday(time,1,
&Apache::lonannounce::readcalendar($tdom.'_'.$trest));
$roletext.='<td><font color="'.$tfont.'">'.$trole.
'</font></td><td><font color="'.$tfont.'">'.$ttype.
'</font></td><td><font color="'.$tfont.'">'.$twhere.
'</font></td><td><font color="'.$tfont.'">'.$tpstart.
'</font></td><td><font color="'.$tfont.'">'.$tpend.
'</font></td><td><font color="'.$tfont.'">'.$tremark.
' </font></td></tr>'."\n";
$roletext{$envkey}=$roletext;
if (!$sortkey) {$sortkey=$twhere."\0".$envkey;}
$sortrole{$sortkey}=$envkey;
$roleclass{$envkey}=$ttype;
}
}
}
# No active roles
if ($countactive==0) {
if ($inrole) {
$r->print('<h2>'.&mt('Currently no additional roles or courses').'</h2>');
} else {
$r->print('<h2>'.&mt('Currently no active roles or courses').'</h2>');
}
$r->print('</form></body></html>');
return OK;
# Is there only one choice?
} elsif (($countactive==1) && ($ENV{'request.role'} eq 'cm')) {
$r->print('<h3>'.&mt('Please stand by.').'</h3>'.
'<input type="hidden" name="'.$possiblerole.'" value="1" />');
$r->print("</form>\n");
$r->rflush();
$r->print('<script>document.forms.rolechoice.submit();</script>');
$r->print('</body></html>');
return OK;
}
# More than one possible role
# ----------------------------------------------------------------------- Table
unless (($advanced) || ($nochoose)) {
$r->print("<h2>".&mt('Select a Course to Enter')."</h2>\n");
}
$r->print('<br /><table><tr>');
unless ($nochoose) { $r->print('<th> </th>'); }
$r->print('<th>'.&mt('User Role').'</th><th colspan=2>'.&mt('Extent').
'</th><th>'.&mt('Start').'</th><th>'.&mt('End').'</th><th>'.
&mt('Remarks and Calendar Announcements').'</th></tr>'."\n");
my $doheaders=-1;
foreach my $type ('Construction Space','Course','Domain','System') {
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++; }
}
if ($numdc > 0) {
$r->print('<tr bgcolor="#BBffBB">'.
'<td align="center" colspan="7">'.
'<input type="hidden" name="all_cc_roles" value="1"/>'.
'<input type="hidden" name="dcselected" value=""/>'.
&mt('Domain').'</td>');
foreach my $dcdom (keys %dcroles) {
my $output = $roletext{$dcroles{$dcdom}};
my $ccrole = Apache::lonnet::plaintext('cc');
if ($ENV{'request.role'} =~ m-cc\./$dcdom/-) {
$output.=$roletext{'user.role.'.$ENV{'request.role'}};
}
$r->print($output);
$r->print('<tr bgcolor="#77FF77">');
$r->print('<td><input type="button" value="'.
&mt('Select').'" name="dcpick_'.$dcdom.'/" '.
'onClick="setDCchoice('."'$dcdom'".')"></td>'.
'<td><font color="#002200">'.
$ccrole.'</font></td><td>'.&mt('Course').'</td>'.
'<td><font color="#002200"><b>'.&mt('All courses').'</b>'.
'<br />'.&mt('Domain').':'.$dcdom.'</font>'.
'<td colspan="4"><font color="#002200">'.
&mt('Course Coordinator access to all courses in domain').
': <b>'.$dcdom.'</b></font></td></tr>'."\n");
}
foreach my $type ('Construction Space','Course','Domain','System') {
my $output;
foreach my $which (sort {uc($a) cmp uc($b)} (keys(%sortrole))) {
my $skiprole = 0;
foreach my $dcdom (keys %dcroles) {
if ($sortrole{$which} =~ m-(dc)\./$dcdom/-) {
$skiprole = 1;
last;
}
}
if (($roleclass{$sortrole{$which}} =~ /^\Q$type\E/) && (!$skiprole)) {
$output.=$roletext{$sortrole{$which}};
}
}
if ($output) {
if ($doheaders > 0) {
$r->print("<tr bgcolor='#BBffBB'>".
"<td align='center' colspan='7'>".&mt($type)."</td>
");
}
$r->print($output);
}
}
} else {
foreach my $type ('Construction Space','Course','Domain','System') {
my $output;
foreach my $which (sort {uc($a) cmp uc($b)} (keys(%sortrole))) {
if ($roleclass{$sortrole{$which}} =~ /^\Q$type\E/) {
$output.=$roletext{$sortrole{$which}};
}
}
if ($output) {
if ($doheaders > 0) {
$r->print("<tr bgcolor='#BBffBB'>".
"<td align='center' colspan='7'>".&mt($type)."</td>");
}
$r->print($output);
}
}
}
my $tremark='';
my $tfont='#003300';
if ($ENV{'request.role'} eq 'cm') {
$r->print('<tr bgcolor="#11CC55">');
$tremark=&mt('Currently selected. ');
$tfont='#002200';
} else {
$r->print('<tr bgcolor="#77FF77">');
}
unless ($nochoose) {
if ($ENV{'request.role'} ne 'cm') {
$r->print('<td><input type=submit value="'.
&mt('Select').'" name="cm"></td>');
} else {
$r->print('<td> </td>');
}
}
$r->print('<td colspan=5><font color="'.$tfont.'">'.&mt('No role specified').
'</font></td><td><font color="'.$tfont.'">'.$tremark.
' </font></td></tr>'."\n");
$r->print('</table>');
unless ($nochoose) {
$r->print("</form>\n");
}
# ------------------------------------------------------------ Privileges Info
if (($advanced) && (($ENV{'user.error.msg'}) || ($error))) {
$r->print('<hr><h2>Current Privileges</h2>');
foreach $envkey (sort keys %ENV) {
if ($envkey=~/^user\.priv\.$ENV{'request.role'}\./) {
my $where=$envkey;
$where=~s/^user\.priv\.$ENV{'request.role'}\.//;
my $ttype;
my $twhere;
my ($tdom,$trest,$tsec)=
split(/\//,Apache::lonnet::declutter($where));
if ($trest) {
if ($ENV{'course.'.$tdom.'_'.$trest.'.description'} eq 'ca') {
$ttype='Construction Space';
$twhere='User: '.$trest.', Domain: '.$tdom;
} else {
$ttype='Course';
$twhere=$ENV{'course.'.$tdom.'_'.$trest.'.description'};
if ($tsec) {
$twhere.=' (Section/Group: '.$tsec.')';
}
}
} elsif ($tdom) {
$ttype='Domain';
$twhere=$tdom;
} else {
$ttype='System';
$twhere='/';
}
$r->print("\n<h3>".$ttype.': '.$twhere.'</h3><ul>');
foreach (sort split(/:/,$ENV{$envkey})) {
if ($_) {
my ($prv,$restr)=split(/\&/,$_);
my $trestr='';
if ($restr ne 'F') {
my $i;
$trestr.=' (';
for ($i=0;$i<length($restr);$i++) {
$trestr.=
Apache::lonnet::plaintext(substr($restr,$i,1));
if ($i<length($restr)-1) { $trestr.=', '; }
}
$trestr.=')';
}
$r->print('<li>'.
Apache::lonnet::plaintext($prv).$trestr.
'</li>');
}
}
$r->print('</ul>');
}
}
}
$r->print(&Apache::lonnet::getannounce());
if ($advanced) {
$r->print('<p><small><i>This is LON-CAPA '.
$r->dir_config('lonVersion').'</i><br />'.
'<a href="/adm/logout">'.&mt('Logout').'</a></small></p>');
}
$r->print("</body></html>\n");
return OK;
}
sub role_status {
my ($rolekey,$then,$now,$role,$where,$trolecode,$tstatus,$tstart,$tend) = @_;
my @pwhere = ();
if (exists($ENV{$rolekey}) && $ENV{$rolekey} ne '') {
(undef,undef,$$role,@pwhere)=split(/\./,$rolekey);
unless (!defined($$role) || $$role eq '') {
$$where=join('.',@pwhere);
$$trolecode=$$role.'.'.$$where;
($$tstart,$$tend)=split(/\./,$ENV{$rolekey});
$$tstatus='is';
if ($$tstart && $$tstart>$then) {
$$tstatus='future';
if ($$tstart<$now) { $$tstatus='will'; }
}
if ($$tend) {
if ($$tend<$then) {
$$tstatus='expired';
} elsif ($$tend<$now) {
$$tstatus='will_not';
}
}
}
}
}
sub dc_script {
my $response = (<<"END");
function setDCchoice(caller) {
var dcname = "dc./"+caller+"/"
document.rolechoice.dcselected.value = caller
document.rolechoice.elements[3].name = dcname
document.rolechoice.submit()
}
END
return $response;
}
sub check_fordc {
my ($dcroles,$then) = @_;
my $numdc = 0;
if ($ENV{'user.adv'}) {
foreach my $envkey (sort keys %ENV) {
if ($envkey=~/^user\.role\.dc\.\/(\w+)\/$/) {
my $dcdom = $1;
my $livedc = 1;
my ($tstart,$tend)=split(/\./,$ENV{$envkey});
if ($tstart && $tstart>$then) { $livedc = 0; }
if ($tend && $tend <$then) { $livedc = 0; }
if ($livedc) {
$$dcroles{$dcdom} = $envkey;
$numdc++;
}
}
}
}
return $numdc;
}
sub choosecourse_display {
my ($r,$dcdom,$then,$now) = @_;
my $cb_jscript = &Apache::loncommon::coursebrowser_javascript($dcdom,'dom');
my $verify_script = <<"END";
<script>
function verifyCoursePick() {
var pickedCourse = document.roles.dccourse.value
var pickedDomain = document.roles.dcdomain.value
if (document.roles.dcdomain.value == document.roles.origdom.value) {
if (pickedCourse != '') {
var courseTarget = "cc./"+pickedDomain+"/"+pickedCourse
document.roles.elements[0].value = 1
document.roles.elements[0].name = courseTarget
document.roles.selectrole.value = 1
document.roles.submit()
}
else {
alert("You must use the 'Select Course' link to open a separate pick course window which you can use to select the course you wish to enter");
}
}
else {
alert("You can only use this screen to select courses in the current domain")
}
}
</script>
END
my $courseform=&Apache::loncommon::selectcourse_link
('roles','dccourse','dcdomain','coursedesc');
$r->print($cb_jscript.$verify_script);
my $formaction='/adm/roles';
$formaction=~s/\/+/\//g;
my $crs;
&select_recent_courses($r,$dcdom,$then,$now);
$r->print('<br /><form name="roles" method="post" action="'.$formaction.'" />');
$r->print('<h3>'.&mt('Choose a course from domain').': '.$dcdom.'</h3><font size="+1">'.$courseform.'</font><br /><br />'.
'<input type="hidden" name="chosencourse" value=""/>'.
'Course Title: <input type="text" size="20" name="coursedesc" value=""><br />'.
'Course ID: <input type="text" size="15" name="dccourse" />'.
'<input type="hidden" name="dcdomain" value="'.$dcdom.'" />'.
'<input type="hidden" name="origdom" value="'.$dcdom.'" />'.
'<input type="hidden" name="selectrole" value="" />'.
'<br /><br /><input type="button" name="proceed" value="'.&mt('Enter this course').'" onClick="verifyCoursePick()" />'.
'</form>');
return;
}
sub select_recent_courses {
my ($r,$dcdom,$then,$now)=@_;
my $advanced = $ENV{'user.adv'};
my $tryagain = $ENV{'form.tryagain'};
my %recent=&Apache::lonnet::dump(&recent_filename('cc_pickby_dc_'.$dcdom));
my $numrecent = 0;
my $roletext = '<h3>'.&mt('Enter a recently visited course').'</h3>'.
'<form name="rolechoice" action="/adm/roles" method="post">'.
'<table><tr><th> </th>'.
'<th>'.&mt('User Role').'</th><th colspan=2>'.&mt('Extent').
'</th><th>'.&mt('Start').'</th><th>'.&mt('End').'</th><th>'.
&mt('Remarks and Calendar Announcements').'</th></tr>'."\n".
'<tr bgcolor="#BBffBB">'.
'<td align="center" colspan="7">'.
&mt('Domain').' - '.&mt('Recent courses accessed in this domain').
'</td></tr>'."\n";
foreach my $courseid (sort keys %recent) {
unless ($courseid =~/^error\:/) {
my ($dom,$crs) = split/_/,$courseid;
if ($dom eq $dcdom) {
$numrecent ++;
my $crskey = 'user.role.cc./'.$dom.'/'.$crs;
my ($where,$trolecode,$role,$tstatus,$tend,$tstart,$tbg,$tfont,$tremark,$inrole,$tpstart,$tpend);
my $button = 1;
&role_status($crskey,$then,$now,\$role,\$where,\$trolecode,\$tstatus,\$tstart,\$tend);
if ($tstart) {
$tpstart=&Apache::lonlocal::locallocaltime($tstart);
}
if ($tend) {
$tpend=&Apache::lonlocal::locallocaltime($tend);
}
my $ttype = &mt('Course');
my $twhere;
if ($ENV{'course.'.$courseid.'.description'}) {
$twhere=$ENV{'course.'.$courseid.'.description'};
}
my ($tdom,$trest,$tsection)=
split(/\//,Apache::lonnet::declutter($where));
if ($ENV{'request.role'} eq $trolecode) {
$tstatus='selected';
}
if ($tstatus eq 'is') {
$tbg='#77FF77';
$tfont='#003300';
} elsif ($tstatus eq 'future') {
$tbg='#FFFF77';
$button=0;
} elsif ($tstatus eq 'will') {
$tbg='#FFAA77';
$tremark.=&mt('Active at next login. ');
} elsif ($tstatus eq 'expired') {
$tbg='#FF7777';
$tfont='#330000';
$button=0;
} elsif ($tstatus eq 'will_not') {
$tbg='#AAFF77';
$tremark.=&mt('Expired after logout. ');
} elsif ($tstatus eq 'selected') {
$tbg='#11CC55';
$tfont='#002200';
$inrole=1;
$tremark.=&mt('Currently selected. ');
}
my $trole=Apache::lonnet::plaintext($role);
$roletext.='<tr bgcolor='.$tbg.'>';
if (!$button) {
$roletext.=('<td> </td>');
} elsif ($tstatus eq 'is') {
$roletext.=('<td><input type=submit value="'.
&mt('Select').'" name="'.
$trolecode.'"></td>');
} elsif ($tryagain) {
$roletext.=
'<td><input type=submit value="'.
&mt('Try Selecting Again').'" name="'.$trolecode.'"></td>';
} elsif ($advanced) {
$roletext.=
'<td><input type=submit value="'.
&mt('Re-Initialize').'" name="'.$trolecode.'"></td>';
} else {
$roletext.='<td> </td>';
}
$tremark.=&Apache::lonannounce::showday(time,1,
&Apache::lonannounce::readcalendar($tdom.'_'.$trest));
$roletext.='<td><font color="'.$tfont.'">'.$trole.
'</font></td><td><font color="'.$tfont.'">'.$ttype.
'</font></td><td><font color="'.$tfont.'">'.$twhere.
'</font></td><td><font color="'.$tfont.'">'.$tpstart.
'</font></td><td><font color="'.$tfont.'">'.$tpend.
'</font></td><td><font color="'.$tfont.'">'.$tremark.
' </font></td></tr>'."\n";
}
}
}
if ($numrecent > 0) {
$r->print($roletext.'</table><input type="hidden" '.
'name="selectrole" value="1" /></form>'."\n");
}
}
sub recent_filename {
my $area=shift;
return 'nohist_recent_'.&Apache::lonnet::escape($area);
}
sub set_privileges {
my ($dcdom,$pickedcourse) = @_;
my $area = '/'.$dcdom.'/'.$pickedcourse;
my $role = 'cc';
my $spec = $role.'.'.$area;
my $userroles = &Apache::lonnet::set_arearole($role,$area,'','',$dcdom,$ENV{'user.name'});
my %ccrole = ();
&Apache::lonnet::standard_roleprivs(\%ccrole,$role,$dcdom,$spec,$pickedcourse,$area);
$userroles .= &Apache::lonnet::set_userprivs(\$userroles,\%ccrole); my @newprivs = split/\n/,$userroles;
my %newccroles = ();
foreach (@newprivs) {
my ($key,$val) = split/=/,$_;
$newccroles{$key} = $val;
}
&Apache::lonnet::appenv(%newccroles);
&Apache::lonnet::log($ENV{'user.domain'},
$ENV{'user.name'},
$ENV{'user.home'},
"Role ".$role);
&Apache::lonnet::appenv(
'request.role' => $role,
'request.role.domain' => $dcdom,
'request.course.sec' => '');
my $tadv=0;
if (&Apache::lonnet::allowed('adv') eq 'F') { $tadv=1; }
&Apache::lonnet::appenv('request.role.adv' => $tadv);
}
1;
__END__
=head1 NAME
Apache::lonroles - User Roles Screen
=head1 SYNOPSIS
Invoked by /etc/httpd/conf/srm.conf:
<Location /adm/roles>
PerlAccessHandler Apache::lonacc
SetHandler perl-script
PerlHandler Apache::lonroles
ErrorDocument 403 /adm/login
ErrorDocument 500 /adm/errorhandler
</Location>
=head1 OVERVIEW
=head2 Choosing Roles
C<lonroles> 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<lonnet>'s C<&allowed> function that a certain
action is not allowed, C<lonroles> 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. C<lonroles> can also be accessed via the
B<CRS> button in the Remote Control.
=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<lonnet>'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
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>
![[BACK]](/icons/back.gif){kind=icon}
Return to lonroles.pm CVS log ![[TXT]](/icons/text.gif){kind=icon}
![[DIR]](/icons/dir.gif){kind=icon}
Up to [LON-CAPA] / loncom / auth