--- loncom/auth/lonroles.pm 2000/07/25 15:40:11 1.4 +++ loncom/auth/lonroles.pm 2002/05/13 09:10:15 1.37 @@ -1,68 +1,245 @@ # The LearningOnline Network with CAPA # User Roles Screen +# +# $Id: lonroles.pm,v 1.37 2002/05/13 09:10:15 albertel 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,07/22,07/24,07/25 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 +# 02/27/01 Scott Harrison +# 03/02,05/03,05/25,05/30,06/01,07/06,08/06 Gerd Kortemeyer +# 12/21 Scott Harrison +# 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; sub handler { + my $r = shift; + + my $now=time; + my $then=$ENV{'user.login.time'}; + my $envkey; + + +# ================================================================== Roles Init + + 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'); + foreach $envkey (keys %ENV) { + if ($envkey=~/^user\.role\./) { + my ($dum1,$dum2,$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); + &Apache::lonnet::appenv('request.role' => $trolecode, + '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/notfound.html'; + $msg= + '

Could not initialize top-level map.

'; + } + $r->content_type('text/html'); + &Apache::loncommon::no_cache($r); + $r->send_http_header; + my $swinfo=&Apache::lonmenu::rawconfig($r); + print (<Entering Course + + + + + +$msg + + +ENDREDIR + return OK; + } + } + } + } + } + } + } + + +# =============================================================== No Roles Init + $r->content_type('text/html'); + &Apache::loncommon::no_cache($r); $r->send_http_header; return OK if $r->header_only; -# ---------------------------------------------------------------- Print Header + my $swinfo=&Apache::lonmenu::rawconfig($r); $r->print(< LON-CAPA User Roles - - + + 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 +# ---------------------------------------------------------------- Who is this? + my $advanced=0; + foreach $envkey (keys %ENV) { + if ($envkey=~/^user\.role\./) { + my ($dum1,$dum2,$role,@pwhere)=split(/\./,$envkey); + if ($role ne 'st') { $advanced=1; } + } + } + +# -------------------------------------------------------- Generate Page Output +# --------------------------------------------------------------- Error Header? if ($error) { $r->print("

LON-CAPA Access Control

"); $r->print("
Access  : ".
                   Apache::lonnet::plaintext($priv)."\n");
         $r->print("Resource: $fn\n");
         $r->print("Action  : $msg\n

"); - $r->log_reason( - "$msg for $ENV{'user.name'} domain $ENV{'user.domain'} access $priv",$fn); } 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

'); + } } - - my $now=time; - my $then=$ENV{'user.login.time'}; - +# -------------------------------------------------------- Choice or no choice? if ($nochoose) { - $r->print("

Assigned User Roles

\n"); + 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('
'); + if ($advanced) { + $r->print + ("

$ENV{'user.name'}, Please Select a Role

\n"); + $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("

Enter a Course

\n"); + } + if (($ENV{'REDIRECT_QUERY_STRING'}) && ($fn)) { + $fn.='?'.$ENV{'REDIRECT_QUERY_STRING'}; + } + $r->print(''); + $r->print(''); + $r->print(''); } + $r->print('
Show all roles: print(' checked'); } + $r->print('>
'); +# ----------------------------------------------------------------------- Table + $r->print(''); + unless ($nochoose) { $r->print(''); } + $r->print(''. + ''."\n"); - $r->print('
 User RoleExtentStartEndRemark
'. - ''."\n"); - my $envkey; foreach $envkey (sort keys %ENV) { + my $button = 1; if ($envkey=~/^user\.role\./) { my ($dum1,$dum2,$role,@pwhere)=split(/\./,$envkey); my $where=join('.',@pwhere); + my $trolecode=$role.'.'.$where; my ($tstart,$tend)=split(/\./,$ENV{$envkey}); my $tremark=''; my $tstatus='is'; @@ -70,77 +247,167 @@ ENDHEADER my $tpend=' '; if ($tstart) { if ($tstart>$then) { - $tstatus='future'; - if ($tstart<$now) { $tstatus='will'; } + $tstatus='future'; + if ($tstart<$now) { $tstatus='will'; } } $tpstart=localtime($tstart); } if ($tend) { - if ($tend<$then) { $tstatus='expired'; } - if ($tend>$now) { $tstatus='will_not'; } + if ($tend<$then) { + $tstatus='expired'; + } elsif ($tend<$now) { + $tstatus='will_not'; + } $tpend=localtime($tend); } - my $tbg; - if ($tstatus eq 'is') { - $tbg='#77FF77'; - } elsif ($tstatus eq 'future') { - $tbg='#FFFF77'; - } elsif ($tstatus eq 'will') { - $tbg='#FFAA77'; - $tremark.='Active at next login.'; - } elsif ($tstatus eq 'expired') { - $tbg='#FF7777'; - } elsif ($tstatus eq 'will_not') { - $tbg='#AAFF77'; - $tremark.='Expired after logout.'; - } - 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 ($tres,$tdom,@trest)=split(/\//,$where); - if ($where=~/\.course$/) { - $ttype='Course'; - $twhere=$tdom.'/'.join('/',@trest); - } elsif ($tdom) { - $ttype='Domain'; - $twhere=$tdom; - } else { - $ttype='System'; - $twhere='/'; + if ($ENV{'request.role'} eq $trolecode) { + $tstatus='selected'; } - - $r->print(''); + unless ($nochoose) { + if (!$button) { + $r->print(''); + } elsif ($tstatus eq 'is') { + $r->print(''); + } elsif ($ENV{'user.adv'}) { + $r->print + (''); + } else { + $r->print(''); + } + } + $r->print(''."\n"); + } } } + my $tremark=''; + if ($ENV{'request.role'} eq 'cm') { + $r->print(''); + $tremark='Currently selected.'; + } else { + $r->print(''); + } + unless ($nochoose) { + if ($ENV{'request.role'} ne 'cm') { + $r->print(''); + } else { + $r->print(''); + } + } + $r->print(''."\n"); $r->print('
User RoleExtentStartEndRemark
'.$trole.''. + my $tbg; + if (($tstatus eq 'is') || ($tstatus eq 'selected') || + ($ENV{'form.showall'})) { + if ($tstatus eq 'is') { + $tbg='#77FF77'; + } elsif ($tstatus eq 'future') { + $tbg='#FFFF77'; + } elsif ($tstatus eq 'will') { + $tbg='#FFAA77'; + $tremark.='Active at next login. '; + } elsif ($tstatus eq 'expired') { + $tbg='#FF7777'; + } elsif ($tstatus eq 'will_not') { + $tbg='#AAFF77'; + $tremark.='Expired after logout. '; + } elsif ($tstatus eq 'selected') { + $tbg='#11CC55'; + $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); + $button = 0 if ($home ne $r->dir_config('lonHostID')); + #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'}); + $button = 0 if ($home ne $r->dir_config('lonHostID')); + #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'}; + } else { + my %newhash=Apache::lonnet::coursedescription + ($tcourseid); + if (%newhash) { + $twhere=$newhash{'description'}; + } 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'; + } + +# ----- do not trust the indention below here ----- + $r->print('
  '.$trole.''. $ttype.''.$twhere.''.$tpstart. ''.$tpend. ''.$tremark.' 
 No role specified'. + ''.$tremark.' 
'); unless ($nochoose) { $r->print("
\n"); } -# ----------------------------------------------------------------- Priviledges - - $r->print('

Priviledges

'); +# ------------------------------------------------------------ Privileges Info + if ($advanced) { + $r->print('

Current Privileges

'); foreach $envkey (sort keys %ENV) { - if ($envkey=~/^user\.priv\./) { - my ($dum1,$dum2,@pwhere)=split(/\./,$envkey); - my $where=join('.',@pwhere); + if ($envkey=~/^user\.priv\.$ENV{'request.role'}\./) { + my $where=$envkey; + $where=~s/^user\.priv\.$ENV{'request.role'}\.//; my $ttype; my $twhere; - my ($tres,$tdom,@trest)=split(/\//,$where); - if ($where=~/\.course$/) { + 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=$tdom.'/'.join('/',@trest); + $twhere=$ENV{'course.'.$tdom.'_'.$trest.'.description'}; + if ($tsec) { + $twhere.=' (Section/Group: '.$tsec.')'; + } + } } elsif ($tdom) { $ttype='Domain'; $twhere=$tdom; @@ -149,32 +416,28 @@ ENDHEADER $twhere='/'; } $r->print("\n

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

'); } } - -# -------------------------------------------------------------- Debug - remove - - $->print("

Debugging


\n"); - - foreach $envkey (sort keys %ENV) { - $r->print("$envkey ---- $ENV{$envkey}
"); - } + } $r->print("\n"); return OK; @@ -182,3 +445,67 @@ ENDHEADER 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 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