File:
[LON-CAPA] /
loncom /
auth /
lonroles.pm
Revision
1.139:
download - view:
text,
annotated -
select for diffs
Mon Dec 19 21:39:33 2005 UTC (18 years, 9 months ago) by
raeburn
Branches:
MAIN
CVS tags:
HEAD
Display of whatsnew page on entering a course can be set for specific courses (override user prefs). Can suppress count of unread posts per resource. Link to first resource at top of page not shown if NEW button used to get to whatsnew. What's new no longer restricted to CC role - accessible to adavnced roles in a course.
# The LearningOnline Network with CAPA
# User Roles Screen
#
# $Id: lonroles.pm,v 1.139 2005/12/19 21:39:33 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;
use GDBM_File;
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',undef,undef,
($url =~ m-/^adm/whatsnew-));
} 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 %dcroles = ();
my $numdc = &check_fordc(\%dcroles,$then);
# ================================================================== Roles Init
if ($env{'form.selectrole'}) {
if ($env{'form.newrole'}) {
$env{'form.'.$env{'form.newrole'}}=1;
}
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 if user is a DC trying to enter a course and needs privs to be created
if ($numdc > 0) {
foreach my $envkey (keys %env) {
if ($envkey =~ m-^form\.cc\./(\w+)/(\w+)$-) {
if ($dcroles{$1}) {
my $cckey = 'user.role.cc./'.$1.'/'.$2;
&check_privs($cckey,$then,$now);
}
last;
}
}
}
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 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'}) {
&Apache::lonhtmlcommon::store_recent('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(/\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,
'request.course.groups' => $cgrps);
my $tadv=0;
my $msg=&mt('Entering course ...');
if (($cnum) && ($role ne 'ca') && ($role ne 'aa')) {
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::allowed('adv') eq 'F') { $tadv=1; }
&Apache::lonnet::appenv('request.role.adv'=>$tadv);
$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;
}
if (&Apache::lonnet::allowed('adv') eq 'F') { $tadv=1; }
&Apache::lonnet::appenv('request.role.adv'=>$tadv);
# 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";
# Send the user to the course they selected
} elsif ($env{'request.course.fn'}) {
if ($env{'user.adv'}) {
my $startpage = &courseloadpage($courseid);
unless ($startpage eq 'firstres') {
$msg = &mt('Entering course ....');
&redirect_user($r,&mt('New in course'),
'/adm/whatsnew?refpage=start',$msg,
$env{'environment.remotenavmap'});
return OK;
}
}
}
&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|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;
}
}
}
}
}
# =============================================================== 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 $bodytag=&Apache::loncommon::bodytag('User Roles');
my $standby=&mt('Role selected. Please stand by.');
$standby=~s/\n/\\n/g;
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();
active=true;
function enterrole (thisform,rolecode,buttonname) {
if (active) {
active=false;
document.title='$standby';
window.status='$standby';
thisform.newrole.value=rolecode;
thisform.submit();
} else {
alert('$standby');
}
}
</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
# --------------------------------------------------------------- Error Header?
if ($error) {
$r->print("<h1>LON-CAPA Access Control</h1>");
$r->print("<!-- LONCAPAACCESSCONTROLERRORSCREEN --><hr /><pre>Access : ".
Apache::lonnet::plaintext($priv)."\n");
$r->print("Resource: ".&Apache::lonenc::check_encrypt($fn)."\n");
$r->print("Action : $msg\n</pre><hr />");
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='.&Apache::lonnet::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'}) {
$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 are not available on servers other than their respective home servers."));
}
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" />');
$r->print('<input type="hidden" name="newrole" value="" />');
}
if ($env{'user.adv'}) {
$r->print(
'<br /><label>'.&mt('Show all roles').': <input type="checkbox" name="showall"');
if ($env{'form.showall'}) { $r->print(' checked="checked" '); }
$r->print(' /></label><input type="submit" value="'.&mt('Display').'" />');
}
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 '' || $role =~ /^gr/);
$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);
if ($tremark) { $tremark.='<br />'; }
$tremark.=&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') || ($role eq 'aa')) {
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='otherserver='.$home.'&role='.$trolecode;
}
#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';
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 ($tsection) {
$twhere.='<br />'.&mt('Section/Group').': '.$tsection;
}
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.=&build_roletext($trolecode,$tdom,$trest,$tstatus,$tryagain,$advanced,$tremark,$tbg,$tfont,$trole,$ttype,$twhere,$tpstart,$tpend,$nochoose,$button,$switchserver);
$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>'.&mt('Extent').
'</th><th>'.&mt('Start').'</th><th>'.&mt('End').'</th></tr>'."\n");
my $doheaders=-1;
foreach my $type ('Domain','Construction Space','Course','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 ($env{'environment.recentroles'}) {
my %recent_roles =
&Apache::lonhtmlcommon::get_recent('roles',$env{'environment.recentrolesn'});
my $output='';
foreach (sort(keys(%recent_roles))) {
if (defined($roletext{'user.role.'.$_})) {
$output.=$roletext{'user.role.'.$_};
if ($_ =~ m-dc\./(\w+)/- && $dcroles{$1}) {
$output .= &allcourses_row($1,'recent');
}
} elsif ($numdc > 0) {
unless ($_ =~/^error\:/) {
$output.=&display_cc_role('user.role.'.$_);
}
}
}
if ($output) {
$r->print("<tr><td align='center' colspan='5'><font face='arial'>".
&mt('Recent Roles')."</font></td>");
$r->print($output);
$r->print("</tr>");
$doheaders ++;
}
}
if ($numdc > 0) {
$r->print(&coursepick_jscript());
$r->print(&Apache::loncommon::coursebrowser_javascript());
}
foreach my $type ('Construction Space','Domain','Course','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 ($sortrole{$which} =~ m-dc\./(\w+)/-) {
if ($dcroles{$1}) {
$output .= &allcourses_row($1,'');
}
}
}
}
if ($output) {
if ($doheaders > 0) {
$r->print("<tr>".
"<td align='center' colspan='5'><font face='arial'>".&mt($type)."</font></td></tr>");
}
$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="3"><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 build_roletext {
my ($trolecode,$tdom,$trest,$tstatus,$tryagain,$advanced,$tremark,$tbg,$tfont,$trole,$ttype,$twhere,$tpstart,$tpend,$nochoose,$button,$switchserver) = @_;
my $roletext='<tr bgcolor="'.$tbg.'">';
my $is_dc=($trolecode =~ m/^dc\./);
my $rowspan=($is_dc) ? ''
: ' rowspan="2" ';
unless ($nochoose) {
my $buttonname=$trolecode;
$buttonname=~s/\W//g;
if (!$button) {
if ($switchserver) {
$roletext.='<td'.$rowspan.'><a href="/adm/switchserver?'.
$switchserver.'">'.&mt('Switch Server').'</a></td>';
} else {
$roletext.=('<td> </td>');
}
} elsif ($tstatus eq 'is') {
$roletext.='<td'.$rowspan.'><input name="'.$buttonname.'" type="button" value="'.
&mt('Select').'" onClick="javascript:enterrole(this.form,\''.
$trolecode."','".$buttonname.'\');"></td>';
} elsif ($tryagain) {
$roletext.=
'<td'.$rowspan.'><input name="'.$buttonname.'" type="button" value="'.
&mt('Try Selecting Again').'" onClick="javascript:enterrole(this.form,\''.
$trolecode."','".$buttonname.'\');"></td>';
} elsif ($advanced) {
$roletext.=
'<td'.$rowspan.'><input name="'.$buttonname.'" type="button" value="'.
&mt('Re-Initialize').'" onClick="javascript:enterrole(this.form,\''.
$trolecode."','".$buttonname.'\');"></td>';
} else {
$roletext.='<td'.$rowspan.'> </td>';
}
}
$tremark.=&Apache::lonannounce::showday(time,1,
&Apache::lonannounce::readcalendar($tdom.'_'.$trest));
$roletext.='<td><font color="'.$tfont.'">'.$trole.
'</font></td><td><font color="'.$tfont.'">'.$twhere.
'</font></td><td><font color="'.$tfont.'">'.$tpstart.
'</font></td><td><font color="'.$tfont.'">'.$tpend.
'</font></td></tr>';
if (!$is_dc) {
$roletext.='<tr bgcolor="'.$tbg.'"><td colspan="4"><font color="'.$tfont.'">'.$tremark.
' </font></td></tr><tr><td colspan="5" height="3"></td></tr>'."\n";
}
return $roletext;
}
sub check_privs {
my ($cckey,$then,$now) = @_;
if ($env{$cckey}) {
my ($role,$where,$trolecode,$tstart,$tend,$tremark,$tstatus,$tpstart,$tpend,$tfont);
&role_status($cckey,$then,$now,\$role,\$where,\$trolecode,\$tstatus,\$tstart,\$tend);
unless (($tstatus eq 'is') || ($tstatus eq 'will_not')) {
&set_privileges($1,$2);
}
} else {
&set_privileges($1,$2);
}
}
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 courselink {
my ($dcdom,$rowtype) = @_;
my $courseform=&Apache::loncommon::selectcourse_link
('rolechoice','dccourse'.$rowtype.'_'.$dcdom,'dcdomain'.$rowtype.'_'.$dcdom,'coursedesc'.$rowtype.'_'.$dcdom,$dcdom);
my $hiddenitems = '<input type="hidden" name="dcdomain'.$rowtype.'_'.$dcdom.'" value="'.$dcdom.'" />'.
'<input type="hidden" name="origdom'.$rowtype.'_'.$dcdom.'" value="'.$dcdom.'" />'.
'<input type="hidden" name="dccourse'.$rowtype.'_'.$dcdom.'" value="" />'.
'<input type="hidden" name="coursedesc'.$rowtype.'_'.$dcdom.'" value="" />';
return $courseform.$hiddenitems;
}
sub coursepick_jscript {
my $verify_script = <<"END";
<script>
function verifyCoursePick(caller) {
var numbutton = getIndex(caller)
var pickedCourse = document.rolechoice.elements[numbutton+4].value
var pickedDomain = document.rolechoice.elements[numbutton+2].value
if (document.rolechoice.elements[numbutton+2].value == document.rolechoice.elements[numbutton+3].value) {
if (pickedCourse != '') {
if (numbutton != -1) {
var courseTarget = "cc./"+pickedDomain+"/"+pickedCourse
document.rolechoice.elements[numbutton+1].name = courseTarget
document.rolechoice.submit()
}
}
else {
alert("Please use the 'Select Course' link to open a separate pick course window where you may select the course you wish to enter.");
}
}
else {
alert("You can only use this screen to select courses in the current domain")
}
}
function getIndex(caller) {
for (var i=0;i<document.rolechoice.elements.length;i++) {
if (document.rolechoice.elements[i] == caller) {
return i;
}
}
return -1;
}
</script>
END
return $verify_script;
}
sub processpick {
my $process_pick = <<"END";
<script>
function process_pick(dom) {
var pickedCourse=opener.document.rolechoice.$env{'form.cnumelement'}.value;
var pickedDomain=opener.document.rolechoice.$env{'form.cdomelement'}.value;
var okDomain = 0;
if (pickedDomain == dom) {
if (pickedCourse != '') {
var courseTarget = "cc./"+pickedDomain+"/"+pickedCourse
opener.document.title='Role selected. Please stand by.';
opener.status='Role selected. Please stand by.';
opener.document.rolechoice.newrole.value=courseTarget
opener.document.rolechoice.submit()
}
} else {
alert("You may only use this screen to select courses in the current domain: "+dom+"\\nPlease return to the roles page window and click the 'Select Course' link for domain: "+pickedDomain+",\\n if you are a Domain Coordinator in that domain, and wish to become a Course Coordinator in a course in the domain");
}
}
</script>
END
return $process_pick;
}
sub display_cc_role {
my $rolekey = shift;
my $roletext;
my $advanced = $env{'user.adv'};
my $tryagain = $env{'form.tryagain'};
unless ($rolekey =~/^error\:/) {
if ($rolekey =~ m-^user\.role.cc\./(\w+)/(\w+)$-) {
my $tcourseid = $1.'_'.$2;
my $trolecode = 'cc./'.$1.'/'.$2;
my $trole = Apache::lonnet::plaintext('cc');
my $twhere;
my $tbg='#77FF77';
my $tfont='#003300';
my %newhash=&Apache::lonnet::coursedescription($tcourseid);
if (%newhash) {
$twhere=$newhash{'description'}.
' <font size="-2">'.
&Apache::loncommon::syllabuswrapper(&mt('Syllabus'),$2,$1,$tfont).
'</font>';
} else {
$twhere=&mt('Currently not available');
$env{'course.'.$tcourseid.'.description'}=$twhere;
}
$twhere.="<br />".&mt('Domain').":".$1;
$roletext = &build_roletext($trolecode,$1,$2,'is',$tryagain,$advanced,'',$tbg,$tfont,$trole,&mt('Course'),$twhere,'','','',1,'');
}
}
return $roletext;
}
sub allcourses_row {
my ($dcdom,$rowtype) = @_;
my $ccrole = Apache::lonnet::plaintext('cc');
my $selectlink = &courselink($dcdom,$rowtype);
my $output = '<tr bgcolor="#77FF77">'.
'<td colspan="5">'.
'<font color="#002200">'.$ccrole.'</font>'.
' <b>'.$selectlink.'</b>'.
' from '.&mt('Domain').' '.$dcdom.
'<tr><td colspan="5" height="3"></td></tr>'."\n";
return $output;
}
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);
my ($author,$adv)= &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);
}
sub courseloadpage {
my ($courseid) = @_;
my $startpage;
my %entry_settings =
&Apache::lonnet::dump('nohist_whatsnew',$env{'user.domain'},
$env{'user.name'},$courseid.':courseinit');
my ($tmp) = %entry_settings;
unless ($tmp =~ /^Error/) {
$startpage = $entry_settings{$courseid.':courseinit'};
}
if ($startpage eq '') {
if (exists($env{'environment.course_init_display'})) {
$startpage = $env{'environment.course_init_display'};
}
}
return $startpage;
}
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>