--- loncom/auth/lonroles.pm 2000/06/12 18:25:03 1.3 +++ loncom/auth/lonroles.pm 2003/06/24 15:52:32 1.62 @@ -1,81 +1,572 @@ # The LearningOnline Network with CAPA # User Roles Screen +# +# $Id: lonroles.pm,v 1.62 2003/06/24 15:52:32 matthew 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/ +# # (Directory Indexer # (Login Screen +# YEAR=1999 # 5/21/99,5/22,5/25,5/26,5/31,6/2,6/10,7/12,7/14 Gerd Kortemeyer) # 11/23 Gerd Kortemeyer) -# 1/14,03/06,06/01 Gerd Kortemeyer +# YEAR=2000 +# 1/14,03/06,06/01,07/22,07/24,07/25, +# 09/04,09/06,09/28,09/29,09/30,10/2,10/5,10/26,10/28, +# 12/08,12/28, +# YEAR=2001 +# 01/15/01 Gerd Kortemeyer +# 03/02,05/03,05/25,05/30,06/01,07/06,08/06 Gerd Kortemeyer +# 12/29 Gerd Kortemeyer # +### + 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::lonannounce; + +sub redirect_user { + my ($r,$title,$url,$msg) = @_; + $msg = $title if (! defined($msg)); + $r->content_type('text/html'); + &Apache::loncommon::no_cache($r); + $r->send_http_header; + my $swinfo=&Apache::lonmenu::rawconfig(); + my $bodytag=&Apache::loncommon::bodytag('Switching Role'); + $r->print (<$title + + + +$bodytag + +

$msg

+ + +ENDREDIR + return; +} sub handler { + my $r = shift; - $r->content_type('text/html'); - $r->send_http_header; - return OK if $r->header_only; -# --------------------------------------------------- Read Plain Text for Roles + my $now=time; + my $then=$ENV{'user.login.time'}; + my $envkey; - my $tabdir = $r->dir_config('lonTabDir'); - my @rolesplain; - my %plain; +# ================================================================== Roles Init - { - my $idf=Apache::File->new("$tabdir/rolesplain.tab"); - @rolesplain=<$idf>; + if ($ENV{'form.selectrole'}) { + if ($ENV{'request.course.id'}) { + my %temp=('logout_'.$ENV{'request.course.id'} => time); + &Apache::lonnet::put('email_status',\%temp); + } + &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'}); + foreach $envkey (keys %ENV) { + next if ($envkey!~/^user\.role\./); + my (undef,undef,$role,@pwhere)=split(/\./,$envkey); + my $where=join('.',@pwhere); + my $trolecode=$role.'.'.$where; + if ($ENV{'form.'.$trolecode}) { + my ($tstart,$tend)=split(/\./,$ENV{$envkey}); + my $tstatus='is'; + if ($tstart) { + if ($tstart>$then) { + $tstatus='future'; + } + } + if ($tend) { + if ($tend<$then) { $tstatus='expired'; } + if ($tend<$now) { $tstatus='will_not'; } + } + 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')) { + unless (&Apache::lonnet::validate_access_key( + $ENV{'environment.key.'.$cdom.'_'.$cnum}, + $cdom,$cnum)) { +# there is no valid key + if ($ENV{'form.newkey'}) { +# student attempts to register a new key + } else { +# print form to enter a new key + $r->content_type('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(<Entering Course Access Key + + +$bodytag + +
+ + + +
+ +ENDENTERKEY + return OK; + } + } + } + my $tadv=0; + if (($trolecode!~/^st/) && + ($trolecode!~/^ta/) && + ($trolecode!~/^cm/)) { $tadv=1; } + &Apache::lonnet::appenv( + 'request.role' => $trolecode, + 'request.role.adv' => $tadv, + 'request.role.domain' => $cdom, + 'request.course.sec' => $csec); + my $msg='Entering course ...'; + + if (($cnum) && ($role ne 'ca')) { + my ($furl,$ferr)= + &Apache::lonuserstate::readmap($cdom.'/'.$cnum); + if (($ENV{'form.orgurl'}) && + ($ENV{'form.orgurl'}!~/^\/adm\/flip/)) { + $r->internal_redirect($ENV{'form.orgurl'}); + return OK; + } else { + unless ($ENV{'request.course.id'}) { + &Apache::lonnet::appenv( + "request.course.id" => $cdom.'_'.$cnum); + $furl='/adm/roles?tryagain=1'; + $msg= + '

Could not initialize course at this time.

Please try again.

'; + } + + # 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 + &redirect_user($r,'Entering Course', + $furl,$msg); + 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,'Entering Construction Space', + $redirect_url); + return OK; + } + } + } + } } - map { - my ($short,$long)=split(/:/,$_); - $plain{$short}=$long; - } @rolesplain; -# ---------------------------------------------------------------- Print Header + +# =============================================================== No Roles Init + + $r->content_type('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 $helptag=&Apache::loncommon::help_open_topic + ("General_Intro","Click here for help"); $r->print(< LON-CAPA User Roles - +$bodytag +$helptag
+ 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); + } -# -------------------------------------------------------- Generate Page Output +# ------------------------------------------------- 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("

LON-CAPA Access Control

"); - $r->print("
Access  : $plain{$priv}
");
-        $r->print("Resource: $fn
");
-        $r->print("Action  : $msg
"); - $r->log_reason( - "$msg for $ENV{'user.name'} domain $ENV{'user.domain'} access $priv",$fn); + $r->print("
Access  : ".
+                  Apache::lonnet::plaintext($priv)."\n");
+        $r->print("Resource: $fn\n");
+        $r->print("Action  : $msg\n
"); } else { - $r->print("

LON-CAPA User Roles

"); + if ($ENV{'user.error.msg'}) { + $r->print( + '

You need to choose another user role or '. + 'enter a specific course for this function

'); + } } - +# -------------------------------------------------------- Choice or no choice? if ($nochoose) { - $r->print("

Assigned User Roles

"); + if ($advanced) { + $r->print("

Assigned User Roles

\n"); + } else { + $r->print("

Sorry ...

\nThis resource might be part of"); + if ($ENV{'request.course.id'}) { + $r->print(' another'); + } else { + $r->print(' a certain'); + } + $r->print(' course.'); + return OK; + } } else { - $r->print("

Select a User Role

\n"); - $r->print('
'); -$r->print('
'); + if ($advanced) { + $r->print("Your home server is ". + $Apache::lonnet::hostname{&Apache::lonnet::homeserver + ($ENV{'user.name'},$ENV{'user.domain'})}. + "
\n"); + $r->print("Author and Co-Author roles may not be available on ". + "servers other than your home server."); + } else { + $r->print("

Select a Course to Enter

\n"); + } + if (($ENV{'REDIRECT_QUERY_STRING'}) && ($fn)) { + $fn.='?'.$ENV{'REDIRECT_QUERY_STRING'}; + } + $r->print('
'); + $r->print(''); + $r->print(''); } - my $envkey; + $r->print('
Show all roles: print(' checked'); } + $r->print('>
'); +# ----------------------------------------------------------------------- Table + $r->print(''); + unless ($nochoose) { $r->print(''); } + $r->print(''. + ''."\n"); + foreach $envkey (sort keys %ENV) { - $r->print("$envkey ---- $ENV{$envkey}
"); + my $button = 1; + my $switchserver=''; if ($envkey=~/^user\.role\./) { - my ($dum1,$dum2,$role,$where)=split(/\./,$envkey); - $r->print("$plain{$role} for $where
"); + my (undef,undef,$role,@pwhere)=split(/\./,$envkey); + next if (!defined($role) || $role eq ''); + my $where=join('.',@pwhere); + my $trolecode=$role.'.'.$where; + my ($tstart,$tend)=split(/\./,$ENV{$envkey}); + my $tremark=''; + my $tstatus='is'; + my $tpstart=' '; + my $tpend=' '; + my $tfont='#000000'; + if ($tstart) { + if ($tstart>$then) { + $tstatus='future'; + if ($tstart<$now) { $tstatus='will'; } + } + $tpstart=localtime($tstart); + } + if ($tend) { + if ($tend<$then) { + $tstatus='expired'; + } elsif ($tend<$now) { + $tstatus='will_not'; + } + $tpend=localtime($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'; + } elsif ($tstatus eq 'future') { + $tbg='#FFFF77'; + $button=0; + } elsif ($tstatus eq 'will') { + $tbg='#FFAA77'; + $tremark.='Active at next login. '; + } elsif ($tstatus eq 'expired') { + $tbg='#FF7777'; + $tfont='#330000'; + $button=0; + } elsif ($tstatus eq 'will_not') { + $tbg='#AAFF77'; + $tremark.='Expired after logout. '; + } elsif ($tstatus eq 'selected') { + $tbg='#11CC55'; + $tfont='#002200'; + $tremark.='Currently selected. '; + } + my $trole; + if ($role =~ /^cr\//) { + my ($rdummy,$rdomain,$rauthor,$rrole)=split(/\//,$role); + $tremark.='
Defined by '.$rauthor.' 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); + if ($home ne $r->dir_config('lonHostID')) { + $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='User: '.$trest.'
Domain: '.$tdom.'
'. + ' Server: '.$home; + $ENV{'course.'.$tdom.'_'.$trest.'.description'}='ca'; + } elsif ($role eq 'au') { + # Authors + my $home = &Apache::lonnet::homeserver + ($ENV{'user.name'},$ENV{'user.domain'}); + if ($home ne $r->dir_config('lonHostID')) { + $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='Domain: '.$tdom.'
Server: '.$home; + $ENV{'course.'.$tdom.'_'.$trest.'.description'}='ca'; + } elsif ($trest) { + $ttype='Course'; + if ($tsection) { + $ttype.='
Section/Group: '.$tsection; + } + my $tcourseid=$tdom.'_'.$trest; + if ($ENV{'course.'.$tcourseid.'.description'}) { + $twhere=$ENV{'course.'.$tcourseid.'.description'}; + unless ($twhere eq 'Currently not available') { + $twhere.=' '. + &Apache::loncommon::syllabuswrapper('Syllabus',$trest,$tdom,$tfont). + ''; + } + } else { + my %newhash=Apache::lonnet::coursedescription + ($tcourseid); + if (%newhash) { + $twhere=$newhash{'description'}. + ' '. + &Apache::loncommon::syllabuswrapper('Syllabus',$trest,$tdom,$tfont). + ''; + } else { + $twhere='Currently not available'; + $ENV{'course.'.$tcourseid.'.description'}=$twhere; + } + } + if ($role ne 'st') { $twhere.="
Domain:".$tdom; } + } elsif ($tdom) { + $ttype='Domain'; + $twhere=$tdom; + } else { + $ttype='System'; + $twhere='system wide'; + } + + $r->print(''); + unless ($nochoose) { + if (!$button) { + if ($switchserver) { + $r->print(''); + } else { + $r->print(''); + } + } elsif ($tstatus eq 'is') { + $r->print(''); + } elsif ($tryagain) { + $r->print + (''); + } elsif ($advanced) { + $r->print + (''); + } else { + $r->print(''); + } + } + $tremark.=&Apache::lonannounce::showday(time,1, + &Apache::lonannounce::readcalendar($tdom.'_'.$trest)); + + $r->print(''."\n"); + } } } + my $tremark=''; + my $tfont='#003300'; + if ($ENV{'request.role'} eq 'cm') { + $r->print(''); + $tremark='Currently selected.'; + $tfont='#002200'; + } else { + $r->print(''); + } + unless ($nochoose) { + if ($ENV{'request.role'} ne 'cm') { + $r->print(''); + } else { + $r->print(''); + } + } + $r->print(''."\n"); + + $r->print('
 User RoleExtentStartEndRemark
Switch Server  '.$trole. + ''.$ttype. + ''.$twhere. + ''.$tpstart. + ''.$tpend. + ''.$tremark. + ' 
 No role specified'. + ''.$tremark. + ' 
'); + unless ($nochoose) { + $r->print("
\n"); + } +# ------------------------------------------------------------ Privileges Info + if (($advanced) && (($ENV{'user.error.msg'}) || ($error))) { + $r->print('

Current Privileges

'); + + 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

".$ttype.': '.$twhere.'

    '); + foreach (sort split(/:/,$ENV{$envkey})) { + if ($_) { + my ($prv,$restr)=split(/\&/,$_); + my $trestr=''; + if ($restr ne 'F') { + my $i; + $trestr.=' ('; + for ($i=0;$iprint('
  • '. + Apache::lonnet::plaintext($prv).$trestr. + '
    • '); + } + } + $r->print('
'); + } + } + } $r->print("\n"); return OK; @@ -83,3 +574,67 @@ $r->print(' + PerlAccessHandler Apache::lonacc + SetHandler perl-script + PerlHandler Apache::lonroles + ErrorDocument 403 /adm/login + ErrorDocument 500 /adm/errorhandler + + +=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