--- loncom/auth/lonroles.pm 2009/09/23 19:42:20 1.209.4.2 +++ loncom/auth/lonroles.pm 2008/12/04 16:56:46 1.212 @@ -1,7 +1,7 @@ # The LearningOnline Network with CAPA # User Roles Screen # -# $Id: lonroles.pm,v 1.209.4.2 2009/09/23 19:42:20 raeburn Exp $ +# $Id: lonroles.pm,v 1.212 2008/12/04 16:56:46 bisitz Exp $ # # Copyright Michigan State University Board of Trustees # @@ -27,6 +27,103 @@ # ### +=pod + +=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 OVERVIEW + +=head2 Choosing Roles + +C 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's C<&allowed> function that a certain +action is not allowed, C 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 can also be accessed via the +B 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'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 + + package Apache::lonroles; use strict; @@ -272,7 +369,7 @@ $swinfo
-$message
+$message
$end_page @@ -548,31 +645,23 @@ ENDHEADER my $possiblerole=''; my %futureroles; my %roles_nextlogin; - my %timezones; - my $numcourses; - if ($env{'user.adv'}) { - my %courses = &Apache::lonnet::courseiddump($env{'user.domain'},'.','.','.','.','.',undef,undef,'Course'); - $numcourses = keys(%courses); - } 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); + my ($role,$where,$trolecode,$tstart,$tend,$tremark,$tstatus,$tpstart,$tpend); &role_status($envkey,$then,$now,\$role,\$where,\$trolecode,\$tstatus,\$tstart,\$tend); next if (!defined($role) || $role eq '' || $role =~ /^gr/); - my $timezone = &role_timezone($where,\%timezones); $tremark=''; $tpstart=' '; $tpend=' '; - $tfont='#000000'; if ($tstart) { - $tpstart=&Apache::lonlocal::locallocaltime($tstart,$timezone); + $tpstart=&Apache::lonlocal::locallocaltime($tstart); } if ($tend) { - $tpend=&Apache::lonlocal::locallocaltime($tend,$timezone); + $tpend=&Apache::lonlocal::locallocaltime($tend); } if ($env{'request.role'} eq $trolecode) { $tstatus='selected'; @@ -584,30 +673,27 @@ ENDHEADER || ($tstatus eq 'future') || ($env{'form.showall'})) { if ($tstatus eq 'is') { - $tbg='#77FF77'; - $tfont='#003300'; + $tbg='LC_roles_is'; $possiblerole=$trolecode; $countactive++; } elsif ($tstatus eq 'future') { - $tbg='#FFFF77'; + $tbg='LC_roles_future'; $button=0; $futureroles{$trolecode} = $tstart.':'.$tend; $countfuture ++; } elsif ($tstatus eq 'will') { - $tbg='#FFAA77'; + $tbg='LC_roles_will'; $tremark.=&mt('Active at next login.').' '; $roles_nextlogin{$trolecode} = $tstart.':'.$tend; $countwill ++; } elsif ($tstatus eq 'expired') { - $tbg='#FF7777'; - $tfont='#330000'; + $tbg='LC_roles_expired'; $button=0; } elsif ($tstatus eq 'will_not') { - $tbg='#AAFF77'; + $tbg='LC_roles_will_not'; $tremark.=&mt('Expired after logout.').' '; } elsif ($tstatus eq 'selected') { - $tbg='#11CC55'; - $tfont='#002200'; + $tbg='LC_roles_selected'; $inrole=1; $countactive++; $tremark.=&mt('Currently selected.').' '; @@ -669,9 +755,9 @@ ENDHEADER $twhere=$env{'course.'.$tcourseid.'.description'}; $sortkey=$role."\0".$tdom."\0".$twhere."\0".$envkey; unless ($twhere eq &mt('Currently not available')) { - $twhere.=' '. - &Apache::loncommon::syllabuswrapper(&mt('Syllabus'),$trest,$tdom,$tfont). - ''; + $twhere.=' '. + &Apache::loncommon::syllabuswrapper(&mt('Syllabus'),$trest,$tdom). + ''; } } else { my %newhash=&Apache::lonnet::coursedescription($tcourseid); @@ -679,9 +765,9 @@ ENDHEADER $sortkey=$role."\0".$tdom."\0".$newhash{'description'}. "\0".$envkey; $twhere=$newhash{'description'}. - ' '. - &Apache::loncommon::syllabuswrapper(&mt('Syllabus'),$trest,$tdom,$tfont). - ''; + ' '. + &Apache::loncommon::syllabuswrapper(&mt('Syllabus'),$trest,$tdom). + ''; $ttype = $newhash{'type'}; $trole = &Apache::lonnet::plaintext($role,$ttype); } else { @@ -704,7 +790,7 @@ ENDHEADER $twhere=&mt('system wide'); $sortkey=$role.$twhere; } - $roletext.=&build_roletext($trolecode,$tdom,$trest,$tstatus,$tryagain,$advanced,$tremark,$tbg,$tfont,$trole,$twhere,$tpstart,$tpend,$nochoose,$button,$switchserver,$reinit); + $roletext.=&build_roletext($trolecode,$tdom,$trest,$tstatus,$tryagain,$advanced,$tremark,$tbg,$trole,$twhere,$tpstart,$tpend,$nochoose,$button,$switchserver,$reinit); $roletext{$envkey}=$roletext; if (!$sortkey) {$sortkey=$twhere."\0".$envkey;} $sortrole{$sortkey}=$envkey; @@ -714,17 +800,14 @@ ENDHEADER } if ($env{'user.adv'}) { $r->print( - '
'); + $r->print(' />

'); } else { if ($countactive > 0) { - my $queuetotal = &queued_selfenrollment($r); - if (($numcourses-$queuetotal) > 1) { - my $domdesc = &Apache::lonnet::domain($env{'user.domain'},'description'); - my $esc_dom = &HTML::Entities::encode($env{'user.domain'},'"<>&'); - $r->print('

'.&mt('[_1]Visit the [_2]Course Catalog[_3] to view all [_4] GCI WebCenter courses.','','','',$domdesc).'
'.&mt('If a course is [_1]not[_2] in your list of current courses below, you may be able to enroll if self-enrollment is permitted.','','').'

'); - } + my $domdesc = &Apache::lonnet::domain($env{'user.domain'},'description'); + my $esc_dom = &HTML::Entities::encode($env{'user.domain'},'"<>&'); + $r->print('

'.&mt('[_1]Visit the [_2]Course Catalog[_3] to view all [_4] LON-CAPA courses.','','','',$domdesc).'
'.&mt('If a course is [_1]not[_2] in your list of current courses below, you may be able to enroll if self-enrollment is permitted.','','').'

'); } } @@ -735,7 +818,7 @@ ENDHEADER } else { $r->print('

'.&mt('Currently no active roles or courses').'

'); } - &findcourse_advice($r,$numcourses); + &findcourse_advice($r); $r->print(''); if ($countfuture) { $r->print(&mt('The following [quant,_1,role,roles] will become active in the future:',$countfuture)); @@ -744,43 +827,26 @@ ENDHEADER &print_rolerows($r,$doheaders,\%roleclass,\%sortrole,\%dcroles, \%roletext); my $tremark=''; - my $tfont='#003300'; + my $tbg; if ($env{'request.role'} eq 'cm') { - $r->print(''); + $tbg="LC_roles_selected"; $tremark=&mt('Currently selected.').' '; - $tfont='#002200'; } else { - $r->print(''); + $tbg="LC_roles_is"; } - $r->print(''.&mt('No role specified'). - ''.$tremark. - ' '."\n"); + $r->print(&Apache::loncommon::start_data_table_row() + .' ' + .'' + .&mt('No role specified') + .'' + .''.$tremark.' ' + .&Apache::loncommon::end_data_table_row() + ); - $r->print(''); + $r->print(&Apache::loncommon::end_data_table()); } $r->print(&Apache::loncommon::end_page()); return OK; - } elsif ($countactive==1) { # Is there only one choice? - my $needs_switchserver; - if ($env{'user.author'}) { - $needs_switchserver = &check_needs_switchserver($possiblerole); - } - if ((!$needs_switchserver) && ($env{'request.role'} eq 'cm')) { - $r->print('

'.&mt('Please stand by.').'

'. - ''. - ''); - $r->print("\n"); - $r->rflush(); - $r->print(''); - $r->print(&Apache::loncommon::end_page()); - return OK; - } - if ($needs_switchserver) { - $r->print("

".&mt('Server Switch Required')."

\n". - &mt('Construction Space access is only available from '. - 'the home server of the corresponding Author.').'
'. - &mt("Click the 'Switch Server' link to go there.").'
'); - } } # ----------------------------------------------------------------------- Table unless ((!&Apache::lonmenu::show_course()) || ($nochoose) || ($countactive==1)) { @@ -805,8 +871,12 @@ ENDHEADER } } if ($output) { - $r->print("". - &mt('Recent Roles').""); + $r->print(&Apache::loncommon::start_data_table_empty_row() + .'' + .&mt('Recent Roles') + .'' + .&Apache::loncommon::end_data_table_empty_row() + ); $r->print($output); $doheaders ++; } @@ -820,33 +890,36 @@ ENDHEADER &print_rolerows($r,$doheaders,\%roleclass,\%sortrole,\%dcroles,\%roletext); if ($countactive > 1) { my $tremark=''; - my $tfont='#003300'; + my $tbg; if ($env{'request.role'} eq 'cm') { - $r->print(''); + $tbg="LC_roles_selected"; $tremark=&mt('Currently selected.').' '; - $tfont='#002200'; } else { - $r->print(''); + $tbg="LC_roles_is"; } + $r->print(&Apache::loncommon::start_data_table_row()); unless ($nochoose) { if ($env{'request.role'} ne 'cm') { - $r->print(''); } else { - $r->print(' '); + $r->print(' '); } } - $r->print(''.&mt('No role specified'). - ''.$tremark. - ' '."\n"); + $r->print('' + .&mt('No role specified') + .'' + .''.$tremark.' ' + .&Apache::loncommon::end_data_table_row() + ); } - $r->print(''); + $r->print(&Apache::loncommon::end_data_table()); unless ($nochoose) { $r->print("\n"); } # ------------------------------------------------------------ Privileges Info if (($advanced) && (($env{'user.error.msg'}) || ($error))) { - $r->print('

Current Privileges

'); + $r->print('

'.&mt('Current Privileges').'

'); $r->print(&privileges_info()); } $r->print(&Apache::lonnet::getannounce()); @@ -855,78 +928,30 @@ ENDHEADER $r->print('

' .&mt('This is LON-CAPA [_1]',$r->dir_config('lonVersion')) .'
' - .''.&mt('Logout').''); - if ($numcourses>1) { - $r->print('  '. - ''. - &mt('Course Catalog'). - ''); - } - $r->print('

'); + .''.&mt('Logout').'  ' + .'' + .&mt('Course Catalog') + .'

'); } $r->print(&Apache::loncommon::end_page()); return OK; } -sub role_timezone { - my ($where,$timezones) = @_; - my $timezone; - if (ref($timezones) eq 'HASH') { - if ($where =~ m{^/($match_domain)/($match_courseid)}) { - my $cdom = $1; - my $cnum = $2; - if ($cdom && $cnum) { - if (!exists($timezones->{$cdom.'_'.$cnum})) { - my %timehash = - &Apache::lonnet::get('environment',['timezone'],$cdom,$cnum); - if ($timehash{'timezone'} eq '') { - if (!exists($timezones->{$cdom})) { - my %domdefaults = - &Apache::lonnet::get_domain_defaults($cdom); - if ($domdefaults{'timezone_def'} eq '') { - $timezones->{$cdom} = 'local'; - } else { - $timezones->{$cdom} = $domdefaults{'timezone_def'}; - } - } - $timezones->{$cdom.'_'.$cnum} = $timezones->{$cdom}; - } else { - $timezones->{$cdom.'_'.$cnum} = - &Apache::lonlocal::gettimezone($timehash{'timezone'}); - } - } - $timezone = $timezones->{$cdom.'_'.$cnum}; - } - } else { - my ($tdom) = ($where =~ m{^/($match_domain)}); - if ($tdom) { - if (!exists($timezones->{$tdom})) { - my %domdefaults = &Apache::lonnet::get_domain_defaults($tdom); - if ($domdefaults{'timezone_def'} eq '') { - $timezones->{$tdom} = 'local'; - } else { - $timezones->{$tdom} = $domdefaults{'timezone_def'}; - } - } - $timezone = $timezones->{$tdom}; - } - } - if ($timezone eq 'local') { - $timezone = undef; - } - } - return $timezone; -} - sub roletable_headers { my ($r,$roleclass,$sortrole,$nochoose) = @_; my $doheaders; if ((ref($sortrole) eq 'HASH') && (ref($roleclass) eq 'HASH')) { - $r->print('
'); + $r->print('
' + .&Apache::loncommon::start_data_table() + .&Apache::loncommon::start_data_table_header_row() + ); if (!$nochoose) { $r->print(''); } - $r->print(''."\n"); + $r->print('' + .'' + .'' + .'' + .&Apache::loncommon::end_data_table_header_row() + ); $doheaders=-1; my @roletypes = &roletypes(); foreach my $type (@roletypes) { @@ -969,9 +994,12 @@ sub print_rolerows { } if ($output) { if ($doheaders > 0) { - $r->print("". - ""); + $r->print(&Apache::loncommon::start_data_table_empty_row() + .'' + .&Apache::loncommon::end_data_table_empty_row() + ); } $r->print($output); } @@ -980,7 +1008,7 @@ sub print_rolerows { } sub findcourse_advice { - my ($r,$numcourses) = @_; + my ($r) = @_; my $domdesc = &Apache::lonnet::domain($env{'user.domain'},'description'); my $esc_dom = &HTML::Entities::encode($env{'user.domain'},'"<>&'); if (&Apache::lonnet::auto_run(undef,$env{'user.domain'})) { @@ -995,59 +1023,11 @@ sub findcourse_advice { } else { $r->print(&mt('If you were expecting to see an active role listed for a particular course, that course may not have been created yet.').'
'); } - my $queuetotal = &queued_selfenrollment($r); - if (($numcourses - $queuetotal) > 0) { - $r->print('

'.&mt('The [_1]Course Catalog[_2] provides information about all [_3] classes for which LON-CAPA courses have been created.','','',$domdesc).'
'); - $r->print(&mt('You can search the course catalog for courses which permit self-enrollment, if you would like to enroll in a course.').'

'); - } + $r->print('

'.&mt('The [_1]Course Catalog[_2] provides information about all [_3] classes for which LON-CAPA courses have been created.','','',$domdesc).'
'); + $r->print(&mt('You can search the course catalog for courses which permit self-enrollment, if you would like to enroll in a course.').'

'); return; } -sub queued_selfenrollment { - my ($r) = @_; - my %selfenrollrequests = &Apache::lonnet::dump('selfenrollrequests'); - my %reqs_by_date; - my $queuetotal = 0; - foreach my $item (keys(%selfenrollrequests)) { - if (ref($selfenrollrequests{$item}) eq 'HASH') { - if ($selfenrollrequests{$item}{'status'} eq 'request') { - if ($selfenrollrequests{$item}{'timestamp'}) { - push(@{$reqs_by_date{$selfenrollrequests{$item}{'timestamp'}}},$item); - } - } - } - } - if (keys(%reqs_by_date)) { - my $rolename = &Apache::lonnet::plaintext('st'); - $r->print(''.&mt('Enrollment requests pending Course Coordinator approval').'
'. - &Apache::loncommon::start_data_table(). - &Apache::loncommon::start_data_table_header_row(). - ''. - ''. - &Apache::loncommon::end_data_table_header_row()); - my @sorted = sort { $a <=> $b } (keys(%reqs_by_date)); - foreach my $item (@sorted) { - if (ref($reqs_by_date{$item}) eq 'ARRAY') { - foreach my $crs (@{$reqs_by_date{$item}}) { - my %courseinfo = &Apache::lonnet::coursedescription($crs); - my $usec = $selfenrollrequests{$crs}{'section'}; - if ($usec eq '') { - $usec = &mt('No section'); - } - $r->print(&Apache::loncommon::start_data_table_row(). - ''. - ''. - ''. - &Apache::loncommon::end_data_table_row()); - $queuetotal ++; - } - } - } - $r->print(&Apache::loncommon::end_data_table()); - } - return $queuetotal; -} - sub privileges_info { my ($which) = @_; my $output; @@ -1129,8 +1109,8 @@ sub role_status { } sub build_roletext { - my ($trolecode,$tdom,$trest,$tstatus,$tryagain,$advanced,$tremark,$tbg,$tfont,$trole,$twhere,$tpstart,$tpend,$nochoose,$button,$switchserver,$reinit) = @_; - my $roletext=''; + my ($trolecode,$tdom,$trest,$tstatus,$tryagain,$advanced,$tremark,$tbg,$trole,$twhere,$tpstart,$tpend,$nochoose,$button,$switchserver,$reinit) = @_; + my $roletext=&Apache::loncommon::start_data_table_row(); my $is_dc=($trolecode =~ m/^dc\./); my $rowspan=($is_dc) ? '' : ' rowspan="2" '; @@ -1140,34 +1120,41 @@ sub build_roletext { $buttonname=~s/\W//g; if (!$button) { if ($switchserver) { - $roletext.=''.&mt('Switch Server').''; + $roletext.='' + .'' + .&mt('Switch Server') + .''; } else { - $roletext.=(' '); + $roletext.=(' '); } } elsif ($tstatus eq 'is') { - $roletext.=''. + ''; } elsif ($tryagain) { $roletext.= - ''. + ''; } elsif ($advanced) { $roletext.= - ''. + ''; } elsif ($reinit) { $roletext.= - ''. + ''; } else { $roletext.= - ''. + ''; } } @@ -1175,14 +1162,17 @@ sub build_roletext { $tremark.=&Apache::lonannounce::showday(time,1, &Apache::lonannounce::readcalendar($tdom.'_'.$trest)); } - $roletext.=''; + $roletext.='' + .'' + .'' + .'' + .&Apache::loncommon::end_data_table_row(); if (!$is_dc) { - $roletext.=''."\n"; + $roletext.=&Apache::loncommon::continue_data_table_row() + .'' + .&Apache::loncommon::end_data_table_row(); } return $roletext; } @@ -1226,7 +1216,7 @@ sub check_privs { my ($cdom,$cnum,$then,$now,$checkrole) = @_; my $cckey = 'user.role.'.$checkrole.'./'.$cdom.'/'.$cnum; if ($env{$cckey}) { - my ($role,$where,$trolecode,$tstart,$tend,$tremark,$tstatus,$tpstart,$tpend,$tfont); + my ($role,$where,$trolecode,$tstart,$tend,$tremark,$tstatus,$tpstart,$tpend); &role_status($cckey,$then,$now,\$role,\$where,\$trolecode,\$tstatus,\$tstart,\$tend); unless (($tstatus eq 'is') || ($tstatus eq 'will_not')) { &set_privileges($cdom,$cnum,$checkrole); @@ -1399,14 +1389,13 @@ sub display_cc_role { my $trolecode = 'cc./'.$1.'/'.$2; my $twhere; my $ttype; - my $tbg='#77FF77'; - my $tfont='#003300'; + my $tbg='LC_roles_is'; my %newhash=&Apache::lonnet::coursedescription($tcourseid); if (%newhash) { $twhere=$newhash{'description'}. - ' '. - &Apache::loncommon::syllabuswrapper(&mt('Syllabus'),$2,$1,$tfont). - ''; + ' '. + &Apache::loncommon::syllabuswrapper(&mt('Syllabus'),$2,$1). + ''; $ttype = $newhash{'type'}; } else { $twhere=&mt('Currently not available'); @@ -1414,7 +1403,7 @@ sub display_cc_role { } my $trole = &Apache::lonnet::plaintext('cc',$ttype); $twhere.="
".&mt('Domain').":".$1; - $roletext = &build_roletext($trolecode,$1,$2,'is',$tryagain,$advanced,'',$tbg,$tfont,$trole,$twhere,'','','',1,''); + $roletext = &build_roletext($trolecode,$1,$2,'is',$tryagain,$advanced,'',$tbg,$trole,$twhere,'','','',1,''); } } return ($roletext); @@ -1422,20 +1411,24 @@ sub display_cc_role { sub adhoc_roles_row { my ($dcdom,$rowtype) = @_; - my $output = ''. - ' ' + .&Apache::loncommon::end_data_table_row(); return $output; }
 '.&mt('User Role').''.&mt('Extent') - .''.&mt('Start').''.&mt('End') - .'
'.&mt('User Role').''.&mt('Extent').''.&mt('Start').''.&mt('End').'
". - &mt($type)."
' + .&mt($type) + .''.&mt('Date requested').''.&mt('Course title').''.&mt('User role').''.&mt('Section').''.&Apache::lonlocal::locallocaltime($item).''.$courseinfo{'description'}.''.$rolename.''.$usec.'
'.$trole. - ''.$twhere. - ''.$tpstart. - ''.$tpend. - '
'.$trole.''.$twhere.''.$tpstart.''.$tpend.'
'.$tremark. - ' 
' + .$tremark.' ' + .'
'. - ''."\n"; + $output.=&mt('[_1]: [_2]',$ccrole,$selectcclink) + .'
' + .'' + .'' + .'
' - .&mt('[_1]Ad hoc[_2] roles in domain [_3] --', - '','',$dcdom).''; + my $output = &Apache::loncommon::continue_data_table_row() + .' ' + .'' + .'
' + .&mt('[_1]Ad hoc[_2] roles in domain [_3] --' + ,'','',$dcdom) + .''; my $selectcclink = &courselink($dcdom,$rowtype); my $ccrole = &Apache::lonnet::plaintext('cc'); my $carole = &Apache::lonnet::plaintext('ca'); my $selectcalink = &coauthorlink($dcdom,$rowtype); - $output.= ''. - &mt('[_1]: [_2]',$ccrole,$selectcclink). - '
  '. - &mt('[_1]: [_2]',$carole,$selectcalink). - '
  '.&mt('[_1]: [_2]',$carole,$selectcalink).'
' + .'