--- loncom/auth/lonroles.pm 2000/12/08 15:52:43 1.17 +++ loncom/auth/lonroles.pm 2003/03/23 01:46:51 1.53 @@ -1,12 +1,46 @@ # The LearningOnline Network with CAPA # User Roles Screen +# +# $Id: lonroles.pm,v 1.53 2003/03/23 01:46:51 www 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) +# 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 Gerd Kortemeyer +# 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; @@ -14,6 +48,8 @@ use Apache::lonnet(); use Apache::lonuserstate(); use Apache::Constants qw(:common); use Apache::File(); +use Apache::lonmenu; +use Apache::loncommon; sub handler { @@ -27,14 +63,19 @@ sub handler { # ================================================================== Roles Init if ($ENV{'form.selectrole'}) { - &Apache::lonnet::appenv("request.course.id" => '', - "request.course.fn" => '', - "request.course.uri" => '', - "request.course.sec" => '', - "request.role" => 'cm'); + 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.domain" => $ENV{'user.domain'}); foreach $envkey (keys %ENV) { - if ($envkey=~/^user\.role\./) { - my ($dum1,$dum2,$role,@pwhere)=split(/\./,$envkey); + next if ($envkey!~/^user\.role\./); + my (undef,undef,$role,@pwhere)=split(/\./,$envkey); my $where=join('.',@pwhere); my $trolecode=$role.'.'.$where; if ($ENV{'form.'.$trolecode}) { @@ -47,38 +88,114 @@ sub handler { } if ($tend) { if ($tend<$then) { $tstatus='expired'; } - if ($tend>$now) { $tstatus='will_not'; } + 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); - if ($cnum) { - &Apache::lonuserstate::readmap($cdom.'/'.$cnum); - if ($ENV{'form.orgurl'}) { +# 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 + } + } + } + &Apache::lonnet::appenv('request.role' => $trolecode, + '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/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(); + my $bodytag=&Apache::loncommon::bodytag('Switching Role'); + print (<Entering Course + + + +$bodytag + +

$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; + 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 @@ -94,7 +211,7 @@ ENDHEADER my $advanced=0; foreach $envkey (keys %ENV) { if ($envkey=~/^user\.role\./) { - my ($dum1,$dum2,$role,@pwhere)=split(/\./,$envkey); + my (undef,undef,$role,@pwhere)=split(/\./,$envkey); if ($role ne 'st') { $advanced=1; } } } @@ -108,7 +225,11 @@ ENDHEADER $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) { @@ -126,30 +247,37 @@ ENDHEADER } } else { if ($advanced) { - $r->print("

Select a User 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.='?'.$ENV{'REDIRECT_QUERY_STRING'}; + 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(''); } - if ($advanced) { $r->print(''. ''."\n"); - } else { - $r->print(''."\n"); - } foreach $envkey (sort keys %ENV) { + my $button = 1; + my $switchserver=''; if ($envkey=~/^user\.role\./) { - my ($dum1,$dum2,$role,@pwhere)=split(/\./,$envkey); + 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}); @@ -157,94 +285,167 @@ ENDHEADER my $tstatus='is'; my $tpstart=' '; my $tpend=' '; + my $tfont='#000000'; 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); } if ($ENV{'request.role'} eq $trolecode) { $tstatus='selected'; } 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. '; - } elsif ($tstatus eq 'selected') { - $tbg='#33FF33'; - $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)); - if ($trest) { - $ttype='Course'; - if ($tsection) { - $ttype.='
Section/Group: '.$tsection; - } - my $tcourseid=$tdom.'_'.$trest; - if ($ENV{'course.'.$tcourseid.'.description'}) { - $twhere=$ENV{'course.'.$tcourseid.'.description'}; + 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 { - my %newhash=Apache::lonnet::coursedescription($tcourseid); - if (%newhash) { - $twhere=$newhash{'description'}; + $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 { - $twhere='Currently not available'; - $ENV{'course.'.$tcourseid.'.description'}=$twhere; + 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; + } } - } - } elsif ($tdom) { - $ttype='Domain'; - $twhere=$tdom; - } else { - $ttype='System'; - $twhere='system wide'; - } - - $r->print(''); - unless ($nochoose) { - if ($tstatus eq 'is') { - $r->print(''); + if ($role ne 'st') { $twhere.="
Domain:".$tdom; } + } elsif ($tdom) { + $ttype='Domain'; + $twhere=$tdom; } else { - $r->print(''); + $ttype='System'; + $twhere='system wide'; } - } - $r->print(''."\n"); + +# ----- do not trust the indention below here ----- + $r->print(''); + unless ($nochoose) { + if (!$button) { + if ($switchserver) { + $r->print(''); + } else { + $r->print(''); + } + } elsif ($tstatus eq 'is') { + $r->print(''); + } elsif ($ENV{'user.adv'}) { + $r->print + (''); + } else { + $r->print(''); + } + } + $r->print(''."\n"); + } } } my $tremark=''; + my $tfont='#003300'; if ($ENV{'request.role'} eq 'cm') { - $r->print(''); + $r->print(''); $tremark='Currently selected.'; + $tfont='#002200'; } else { $r->print(''); } @@ -255,16 +456,17 @@ ENDHEADER $r->print(''); } } - $r->print(''."\n"); + $r->print(''."\n"); $r->print('
 User RoleExtentStartEndRemark
Course
 '.$trole.''. - $ttype.''.$twhere.''.$tpstart. - ''.$tpend. - ''.$tremark.' 
Switch Server  '.$trole. + ''.$ttype. + ''.$twhere. + ''.$tpstart. + ''.$tpend. + ''.$tremark. + ' 
 No role specified'. - ''.$tremark.' 
No role specified'. + ''.$tremark. + ' 
'); unless ($nochoose) { $r->print("
\n"); } -# ------------------------------------------------------------ Priviledges Info - if ($advanced) { - $r->print('

Current Priviledges

'); +# ------------------------------------------------------------ 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'}\./) { @@ -275,11 +477,16 @@ ENDHEADER 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; @@ -288,7 +495,7 @@ ENDHEADER $twhere='/'; } $r->print("\n

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

    '); - map { + foreach (sort split(/:/,$ENV{$envkey})) { if ($_) { my ($prv,$restr)=split(/\&/,$_); my $trestr=''; @@ -305,20 +512,11 @@ ENDHEADER $r->print('
  • '.Apache::lonnet::plaintext($prv).$trestr. '
    • '); } - } sort split(/:/,$ENV{$envkey}); + } $r->print('
'); } } } -# -------------------------------------------------------------- Debug - remove - - $->print("

Debugging

\n"); - - foreach $envkey (sort keys %ENV) { - $r->print("$envkey ---- $ENV{$envkey}
"); - } - -# ------------------------------------------------------------------- End Debug $r->print("\n"); return OK; @@ -326,3 +524,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