--- loncom/auth/lonroles.pm 2003/06/18 13:13:10 1.60 +++ loncom/auth/lonroles.pm 2003/11/08 21:51:44 1.76 @@ -1,7 +1,7 @@ # The LearningOnline Network with CAPA # User Roles Screen # -# $Id: lonroles.pm,v 1.60 2003/06/18 13:13:10 www Exp $ +# $Id: lonroles.pm,v 1.76 2003/11/08 21:51:44 albertel Exp $ # # Copyright Michigan State University Board of Trustees # @@ -51,6 +51,31 @@ use Apache::File(); use Apache::lonmenu; use Apache::loncommon; use Apache::lonannounce; +use Apache::lonlocal; + +sub redirect_user { + my ($r,$title,$url,$msg) = @_; + $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 $bodytag=&Apache::loncommon::bodytag('Switching Role'); + $r->print (<$title + + + +$bodytag + +

$msg

+ + +ENDREDIR + return; +} sub handler { @@ -106,7 +131,7 @@ sub handler { # student attempts to register a new key } else { # print form to enter a new key - $r->content_type('text/html'); + &Apache::loncommon::content_type($r,'text/html'); &Apache::loncommon::no_cache($r); $r->send_http_header; my $swinfo=&Apache::lonmenu::rawconfig(); @@ -140,21 +165,28 @@ ENDENTERKEY 'request.role.adv' => $tadv, 'request.role.domain' => $cdom, 'request.course.sec' => $csec); - my $msg='Entering course ...'; + my $msg=&mt('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'}); + my $dest=$ENV{'form.orgurl'}; + if ( &Apache::lonnet::mod_perl_version() == 2 ) { + &Apache::lonnet::cleanenv(); + } + $r->internal_redirect($dest); return OK; } else { unless ($ENV{'request.course.id'}) { &Apache::lonnet::appenv( "request.course.id" => $cdom.'_'.$cnum); - $furl='/adm/roles'; + $furl='/adm/roles?tryagain=1'; $msg= - '

Could not initialize course at this time.

Please try again.

'; + '

'. + &mt('Could not initialize course at this time.'). + '

'.&mt('Please try again.').'

'.$ferr; } # Check to see if the user is a CC entering a course @@ -168,28 +200,28 @@ ENDENTERKEY '.course.helper.not.run'}) { $furl = "/adm/helper/course.initialization.helper"; } - - $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 + # + # 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; + } } } } @@ -198,7 +230,7 @@ ENDREDIR # =============================================================== No Roles Init - $r->content_type('text/html'); + &Apache::loncommon::content_type($r,'text/html'); &Apache::loncommon::no_cache($r); $r->send_http_header; return OK if $r->header_only; @@ -228,15 +260,11 @@ ENDHEADER "$msg for $ENV{'user.name'} domain $ENV{'user.domain'} access $priv",$fn); } -# ---------------------------------------------------------------- Who is this? +# ------------------------------------------------- Can this user re-init, etc? - my $advanced=0; - foreach $envkey (keys %ENV) { - if ($envkey=~/^user\.role\./) { - my (undef,undef,$role,@pwhere)=split(/\./,$envkey); - if ($role ne 'st') { $advanced=1; } - } - } + my $advanced=$ENV{'user.adv'}; + &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},['tryagain']); + my $tryagain=$ENV{'form.tryagain'}; # -------------------------------------------------------- Generate Page Output # --------------------------------------------------------------- Error Header? @@ -249,34 +277,35 @@ ENDHEADER } else { if ($ENV{'user.error.msg'}) { $r->print( - '

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

'); + '

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

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

Assigned User Roles

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

".&mt('Assigned User Roles')."

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

Sorry ...

\nThis resource might be part of"); + $r->print("

".&mt('Sorry ...')."

\n". + &mt('This resource might be part of')); if ($ENV{'request.course.id'}) { - $r->print(' another'); + $r->print(&mt(' another')); } else { - $r->print(' a certain'); + $r->print(&mt(' a certain')); } - $r->print(' course.'); + $r->print(&mt(' course.').''); return OK; } } else { if ($advanced) { - $r->print("Your home server is ". + $r->print(&mt("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."); + $r->print(&mt( + "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"); + $r->print("

".&mt('Select a Course to Enter')."

\n"); } if (($ENV{'REDIRECT_QUERY_STRING'}) && ($fn)) { $fn.='?'.$ENV{'REDIRECT_QUERY_STRING'}; @@ -285,18 +314,25 @@ ENDHEADER $r->print(''); $r->print(''); } - $r->print('
Show all roles: print(' checked'); } - $r->print('>
'); + if ($ENV{'user.adv'}) { + $r->print( + '
'.&mt('Show all roles').': print(' checked'); } + $r->print('>'); + } # ----------------------------------------------------------------------- Table - $r->print(''); + $r->print('
'); unless ($nochoose) { $r->print(''); } - $r->print(''. - ''."\n"); + $r->print(''."\n"); + my (%roletext,%sortrole,%roleclass); foreach $envkey (sort keys %ENV) { my $button = 1; my $switchserver=''; + my $roletext; + my $sortkey; if ($envkey=~/^user\.role\./) { my (undef,undef,$role,@pwhere)=split(/\./,$envkey); next if (!defined($role) || $role eq ''); @@ -313,7 +349,7 @@ ENDHEADER $tstatus='future'; if ($tstart<$now) { $tstatus='will'; } } - $tpstart=localtime($tstart); + $tpstart=&Apache::lonlocal::locallocaltime($tstart); } if ($tend) { if ($tend<$then) { @@ -321,7 +357,7 @@ ENDHEADER } elsif ($tend<$now) { $tstatus='will_not'; } - $tpend=localtime($tend); + $tpend=&Apache::lonlocal::locallocaltime($tend); } if ($ENV{'request.role'} eq $trolecode) { $tstatus='selected'; @@ -337,23 +373,24 @@ ENDHEADER $button=0; } elsif ($tstatus eq 'will') { $tbg='#FFAA77'; - $tremark.='Active at next login. '; + $tremark.=&mt('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. '; + $tremark.=&mt('Expired after logout. '); } elsif ($tstatus eq 'selected') { $tbg='#11CC55'; $tfont='#002200'; - $tremark.='Currently selected. '; + $tremark.=&mt('Currently selected. '); } my $trole; if ($role =~ /^cr\//) { my ($rdummy,$rdomain,$rauthor,$rrole)=split(/\//,$role); - $tremark.='
Defined by '.$rauthor.' at '.$rdomain.'.'; + $tremark.='
'.&mt('Defined by ').$rauthor. + &mt(' at ').$rdomain.'.'; $trole=$rrole; } else { $trole=Apache::lonnet::plaintext($role); @@ -375,10 +412,12 @@ ENDHEADER } #next if ($home eq 'no_host'); $home = $Apache::lonnet::hostname{$home}; - $ttype='Construction Space'; - $twhere='User: '.$trest.'
Domain: '.$tdom.'
'. - ' Server: '.$home; + $ttype=&mt('Construction Space'); + $twhere=&mt('User').': '.$trest.'
'.&mt('Domain'). + ': '.$tdom.'
'. + ' '.&mt('Server').': '.$home; $ENV{'course.'.$tdom.'_'.$trest.'.description'}='ca'; + $sortkey=$role."$trest:$tdom"; } elsif ($role eq 'au') { # Authors my $home = &Apache::lonnet::homeserver @@ -393,94 +432,138 @@ ENDHEADER } #next if ($home eq 'no_host'); $home = $Apache::lonnet::hostname{$home}; - $ttype='Construction Space'; - $twhere='Domain: '.$tdom.'
Server: '.$home; + $ttype=&mt('Construction Space'); + $twhere=&mt('Domain').': '.$tdom.'
'.&mt('Server'). + ': '.$home; $ENV{'course.'.$tdom.'_'.$trest.'.description'}='ca'; + $sortkey=$role; } elsif ($trest) { - $ttype='Course'; + $ttype=&mt('Course'); if ($tsection) { - $ttype.='
Section/Group: '.$tsection; + $ttype.='
'.&mt('Section/Group').': '.$tsection; } my $tcourseid=$tdom.'_'.$trest; if ($ENV{'course.'.$tcourseid.'.description'}) { $twhere=$ENV{'course.'.$tcourseid.'.description'}; - unless ($twhere eq 'Currently not available') { + $sortkey=$twhere."\0".$envkey; + unless ($twhere eq &mt('Currently not available')) { $twhere.=' '. - &Apache::loncommon::syllabuswrapper('Syllabus',$trest,$tdom,$tfont). + &Apache::loncommon::syllabuswrapper(&mt('Syllabus'),$trest,$tdom,$tfont). ''; } } else { my %newhash=Apache::lonnet::coursedescription ($tcourseid); if (%newhash) { + $sortkey=$newhash{'description'}."\0".$envkey; $twhere=$newhash{'description'}. ' '. - &Apache::loncommon::syllabuswrapper('Syllabus',$trest,$tdom,$tfont). + &Apache::loncommon::syllabuswrapper(&mt('Syllabus'),$trest,$tdom,$tfont). ''; } else { - $twhere='Currently not available'; + $twhere=&mt('Currently not available'); $ENV{'course.'.$tcourseid.'.description'}=$twhere; + $sortkey=$twhere."\0".$envkey; } } - if ($role ne 'st') { $twhere.="
Domain:".$tdom; } + if ($role ne 'st') { $twhere.="
".&mt('Domain').":".$tdom; } } elsif ($tdom) { - $ttype='Domain'; + $ttype=&mt('Domain'); $twhere=$tdom; + $sortkey=$role.$twhere; } else { - $ttype='System'; - $twhere='system wide'; + $ttype=&mt('System'); + $twhere=&mt('system wide'); + $sortkey=$role.$twhere; } - $r->print(''); + $roletext.=''; unless ($nochoose) { if (!$button) { if ($switchserver) { - $r->print(''); + $roletext.=''; } else { - $r->print(''); + $roletext.=(''); } } elsif ($tstatus eq 'is') { - $r->print(''); - } elsif ($ENV{'user.adv'}) { - $r->print - (''); + } elsif ($tryagain) { + $roletext.= + ''; + } elsif ($advanced) { + $roletext.= + ''; } else { - $r->print(''); + $roletext.=''; } } $tremark.=&Apache::lonannounce::showday(time,1, &Apache::lonannounce::readcalendar($tdom.'_'.$trest)); - $r->print(''."\n"); + ' '."\n"; + $roletext{$envkey}=$roletext; + if (!$sortkey) {$sortkey=$twhere."\0".$envkey;} + $sortrole{$sortkey}=$envkey; + $roleclass{$envkey}=$ttype; } } } + my $doheaders=-1; + foreach my $type (&mt('Construction Space'),&mt('Course'), + &mt('Domain'),&mt('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++; } + } + foreach my $type (&mt('Construction Space'),&mt('Course'), + &mt('Domain'),&mt('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 ($output) { + if ($doheaders > 0) { + $r->print("". + ""); + } + $r->print($output); + } + } my $tremark=''; my $tfont='#003300'; if ($ENV{'request.role'} eq 'cm') { $r->print(''); - $tremark='Currently selected.'; + $tremark=&mt('Currently selected. '); $tfont='#002200'; } else { $r->print(''); } unless ($nochoose) { if ($ENV{'request.role'} ne 'cm') { - $r->print(''); + $r->print(''); } else { $r->print(''); } } - $r->print(''."\n"); @@ -542,7 +625,11 @@ ENDHEADER } } } - + $r->print(&Apache::lonnet::getannounce()); + if ($advanced) { + $r->print('

This is LON-CAPA '. + $r->dir_config('lonVersion').'

'); + } $r->print("\n"); return OK; } @@ -566,6 +653,36 @@ Invoked by /etc/httpd/conf/srm.conf: 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
 User RoleExtentStartEndRemark
'.&mt('User Role').''.&mt('Extent'). + ''.&mt('Start').''.&mt('End').''. + &mt('Remark').'
Switch Server'.&mt('Switch Server').'    '.$trole. + $roletext.=''.$trole. ''.$ttype. ''.$twhere. ''.$tpstart. ''.$tpend. ''.$tremark. - ' 
$type
 No role specified'. + $r->print(''.&mt('No role specified'). ''.$tremark. '