--- loncom/auth/lonroles.pm	2003/06/24 15:52:32	1.62
+++ loncom/auth/lonroles.pm	2004/03/05 01:55:01	1.87
@@ -1,7 +1,7 @@
 # The LearningOnline Network with CAPA
 # User Roles Screen
 #
-# $Id: lonroles.pm,v 1.62 2003/06/24 15:52:32 matthew Exp $
+# $Id: lonroles.pm,v 1.87 2004/03/05 01:55:01 www Exp $
 #
 # Copyright Michigan State University Board of Trustees
 #
@@ -25,20 +25,6 @@
 #
 # 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,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;
@@ -51,11 +37,12 @@ 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));
-    $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();
@@ -130,7 +117,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();
@@ -155,6 +142,10 @@ ENDENTERKEY
 			     }
 			 }
 		     }
+		    &Apache::lonnet::log($ENV{'user.domain'},
+					 $ENV{'user.name'},
+					 $ENV{'user.home'},
+					 "Role ".$trolecode);
                     my $tadv=0;
                     if (($trolecode!~/^st/) && 
                         ($trolecode!~/^ta/) && 
@@ -164,14 +155,18 @@ 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'}) {
@@ -179,7 +174,9 @@ ENDENTERKEY
 				      "request.course.id"  => $cdom.'_'.$cnum);
 				$furl='/adm/roles?tryagain=1';
 				$msg=
-	 '<h1><font color=red>Could not initialize course at this time.</font></h1><h3>Please try again.</h3>';
+				    '<h1><font color=red>'.
+			 &mt('Could not initialize course at this time.').
+		    '</font></h1><h3>'.&mt('Please try again.').'</h3>'.$ferr;
 			    }
 
 			    # Check to see if the user is a CC entering a course 
@@ -195,7 +192,7 @@ ENDENTERKEY
 			    }
                             #
                             # Send the user to the course they selected
-                            &redirect_user($r,'Entering Course',
+                            &redirect_user($r,&mt('Entering Course'),
                                            $furl,$msg);
                             return OK;
 			}
@@ -211,7 +208,7 @@ ENDENTERKEY
                             $redirect_url .= $1;
                         }
                         $redirect_url .= '/';
-                        &redirect_user($r,'Entering Construction Space',
+                        &redirect_user($r,&mt('Entering Construction Space'),
                                        $redirect_url);
                         return OK;
                     }
@@ -223,15 +220,17 @@ ENDENTERKEY
 
 # =============================================================== 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;
 
     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");
+    my $helptag='<table><tr><td>'.&Apache::loncommon::help_open_topic
+     ("General_Intro",&mt("Click here for help")).'</td><td>'.
+      &Apache::loncommon::help_open_faq(1,&mt('Click here for FAQ')).'</td><td>'.
+      &Apache::loncommon::help_open_bug('',&mt('Click here to report bugs')).'</td></tr></table>';
     $r->print(<<ENDHEADER);
 <html>
 <head>
@@ -270,54 +269,57 @@ ENDHEADER
     } else {
         if ($ENV{'user.error.msg'}) {
 	    $r->print(
- '<h3><font color=red>You need to choose another user role or '.
- 'enter a specific course for this function</font></h3>');
+ '<h3><font color=red>'.
+ &mt('You need to choose another user role or enter a specific course for this function').'</font></h3>');
 	}
     }
 # -------------------------------------------------------- Choice or no choice?
     if ($nochoose) {
         if ($advanced) {
-	    $r->print("<h2>Assigned User Roles</h2>\n");
+	    $r->print("<h2>".&mt('Assigned User Roles')."</h2>\n");
         } else {
-	    $r->print("<h2>Sorry ...</h2>\nThis resource might be part of");
+	    $r->print("<h2>".&mt('Sorry ...')."</h2>\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.</body></html>');
+	    $r->print(&mt(' course.').'</body></html>');
 	    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'})}.
 		      "<br />\n");
-	    $r->print("Author and Co-Author roles may not be available on ".
-		      "servers other than your home server.");
-        } else {
-	    $r->print("<h2>Select a Course to Enter</h2>\n");
+	    $r->print(&mt(
+      "Author and Co-Author roles may not be available on servers other than your home server."));
         }
         if (($ENV{'REDIRECT_QUERY_STRING'}) && ($fn)) {
     	    $fn.='?'.$ENV{'REDIRECT_QUERY_STRING'};
         }
-        $r->print('<form method=post action="'.(($fn)?$fn:$r->uri).'">');
+        $r->print('<form method="post" name="rolechoice" action="'.(($fn)?$fn:$r->uri).'">');
         $r->print('<input type=hidden name=orgurl value="'.$fn.'">');
         $r->print('<input type=hidden name=selectrole value=1>');
     }
-    $r->print('<br>Show all roles: <input type=checkbox name=showall');
-    if ($ENV{'form.showall'}) { $r->print(' checked'); }
-    $r->print('><input type=submit value="Display"><br>');
-# ----------------------------------------------------------------------- Table
-    $r->print('<table><tr>');
-    unless ($nochoose) { $r->print('<th>&nbsp;</th>'); }
-    $r->print('<th>User Role</th><th colspan=2>Extent</th>'.
-	      '<th>Start</th><th>End</th><th>Remark</th></tr>'."\n");
+    if ($ENV{'user.adv'}) {
+	$r->print(
+	      '<br />'.&mt('Show all roles').': <input type="checkbox" name="showall"');
+	if ($ENV{'form.showall'}) { $r->print(' checked'); }
+	$r->print('><input type=submit value="'.&mt('Display').'">');
+    }
 
+    my (%roletext,%sortrole,%roleclass);
+    my $countactive=0;
+    my $inrole=0;
+    my $possiblerole='';
     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 '');
@@ -334,7 +336,7 @@ ENDHEADER
                     $tstatus='future';
                     if ($tstart<$now) { $tstatus='will'; }
                 }
-                $tpstart=localtime($tstart);
+                $tpstart=&Apache::lonlocal::locallocaltime($tstart);
             }
             if ($tend) {
                 if ($tend<$then) { 
@@ -342,7 +344,7 @@ ENDHEADER
                 } elsif ($tend<$now) { 
                     $tstatus='will_not'; 
                 }
-                $tpend=localtime($tend);
+                $tpend=&Apache::lonlocal::locallocaltime($tend);
             }
             if ($ENV{'request.role'} eq $trolecode) {
 		$tstatus='selected';
@@ -353,28 +355,33 @@ ENDHEADER
                 if ($tstatus eq 'is') {
                     $tbg='#77FF77';
                     $tfont='#003300';
+		    $possiblerole=$trolecode;
+		    $countactive++;
                 } elsif ($tstatus eq 'future') {
                     $tbg='#FFFF77';
                     $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. ';
+		    $inrole=1;
+		    $countactive++;
+                    $tremark.=&mt('Currently selected. ');
                 }
                 my $trole;
                 if ($role =~ /^cr\//) {
                     my ($rdummy,$rdomain,$rauthor,$rrole)=split(/\//,$role);
-                    $tremark.='<br>Defined by '.$rauthor.' at '.$rdomain.'.';
+                    $tremark.='<br>'.&mt('Defined by ').$rauthor.
+			&mt(' at ').$rdomain.'.';
                     $trole=$rrole;
                 } else {
                     $trole=Apache::lonnet::plaintext($role);
@@ -386,7 +393,10 @@ ENDHEADER
                 # First, Co-Authorship roles
                 if ($role eq 'ca') {
                     my $home = &Apache::lonnet::homeserver($trest,$tdom);
-                    if ($home ne $r->dir_config('lonHostID')) {
+		    my $allowed=0;
+		    my @ids=&Apache::lonnet::current_machine_ids();
+		    foreach my $id (@ids) { if ($id eq $home) { $allowed=1; } }
+                    if (!$allowed) {
 			$button=0;
                         $switchserver=&Apache::lonnet::escape('http://'.
                          $Apache::lonnet::hostname{$home}.
@@ -397,14 +407,20 @@ ENDHEADER
                     #next if ($home eq 'no_host');
                     $home = $Apache::lonnet::hostname{$home};
                     $ttype='Construction Space';
-                    $twhere='User: '.$trest.'<br />Domain: '.$tdom.'<br />'.
-                        ' Server:&nbsp;'.$home;
+                    $twhere=&mt('User').': '.$trest.'<br />'.&mt('Domain').
+			': '.$tdom.'<br />'.
+                        ' '.&mt('Server').':&nbsp;'.$home;
                     $ENV{'course.'.$tdom.'_'.$trest.'.description'}='ca';
+		    $tremark.=&Apache::lonhtmlcommon::authorbombs('/res/'.$tdom.'/'.$trest.'/');
+		    $sortkey=$role."$trest:$tdom";
                 } elsif ($role eq 'au') {
                     # Authors
                     my $home = &Apache::lonnet::homeserver
                         ($ENV{'user.name'},$ENV{'user.domain'});
-                    if ($home ne $r->dir_config('lonHostID')) {
+		    my $allowed=0;
+		    my @ids=&Apache::lonnet::current_machine_ids();
+		    foreach my $id (@ids) { if ($id eq $home) { $allowed=1; } }
+                    if (!$allowed) {
 			$button=0;
                         $switchserver=&Apache::lonnet::escape('http://'.
                          $Apache::lonnet::hostname{$home}.
@@ -415,97 +431,166 @@ ENDHEADER
                     #next if ($home eq 'no_host');
                     $home = $Apache::lonnet::hostname{$home};
                     $ttype='Construction Space';
-                    $twhere='Domain: '.$tdom.'<br />Server:&nbsp;'.$home;
+                    $twhere=&mt('Domain').': '.$tdom.'<br />'.&mt('Server').
+			':&nbsp;'.$home;
                     $ENV{'course.'.$tdom.'_'.$trest.'.description'}='ca';
+		    $tremark.=&Apache::lonhtmlcommon::authorbombs('/res/'.$tdom.'/'.$ENV{'user.name'}.'/');
+		    $sortkey=$role;
                 } elsif ($trest) {
                     $ttype='Course';
                     if ($tsection) {
-                        $ttype.='<br>Section/Group: '.$tsection;
+                        $ttype.='<br>'.&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=$role."\0".$tdom."\0".$twhere."\0".$envkey;
+                        unless ($twhere eq &mt('Currently not available')) {
 			    $twhere.=' <font size="-2">'.
-        &Apache::loncommon::syllabuswrapper('Syllabus',$trest,$tdom,$tfont).
+        &Apache::loncommon::syllabuswrapper(&mt('Syllabus'),$trest,$tdom,$tfont).
                                     '</font>';
 			}
                     } else {
                         my %newhash=Apache::lonnet::coursedescription
                             ($tcourseid);
                         if (%newhash) {
+			    $sortkey=$role."\0".$tdom."\0".$newhash{'description'}.
+				"\0".$envkey;
                             $twhere=$newhash{'description'}.
                               ' <font size="-2">'.
-        &Apache::loncommon::syllabuswrapper('Syllabus',$trest,$tdom,$tfont).
+        &Apache::loncommon::syllabuswrapper(&mt('Syllabus'),$trest,$tdom,$tfont).
                               '</font>';
                         } else {
-                            $twhere='Currently not available';
+                            $twhere=&mt('Currently not available');
                             $ENV{'course.'.$tcourseid.'.description'}=$twhere;
+			    $sortkey=$role."\0".$tdom."\0".$twhere."\0".$envkey;
                         }
                     }
-		    if ($role ne 'st') { $twhere.="<br />Domain:".$tdom; }
+		    if ($role ne 'st') { $twhere.="<br />".&mt('Domain').":".$tdom; }
                 } elsif ($tdom) {
                     $ttype='Domain';
                     $twhere=$tdom;
+		    $sortkey=$role.$twhere;
                 } else {
                     $ttype='System';
-                    $twhere='system wide';
+                    $twhere=&mt('system wide');
+		    $sortkey=$role.$twhere;
                 }
  
-                $r->print('<tr bgcolor='.$tbg.'>');
+                $roletext.='<tr bgcolor='.$tbg.'>';
                 unless ($nochoose) {
                     if (!$button) {
 			if ($switchserver) {
-			    $r->print('<td><a href="/adm/logout?handover='.
-                              $switchserver.'">Switch Server</a></td>');
+			    $roletext.='<td><a href="/adm/logout?handover='.
+                              $switchserver.'">'.&mt('Switch Server').'</a></td>';
                         } else {
-                            $r->print('<td>&nbsp;</td>');
+                            $roletext.=('<td>&nbsp;</td>');
                         }
                     } elsif ($tstatus eq 'is') {
-                        $r->print('<td><input type=submit value=Select name="'.
+                        $roletext.=('<td><input type=submit value="'.
+				  &mt('Select').'" name="'.
                                   $trolecode.'"></td>');
                     } elsif ($tryagain) {
-                        $r->print
-                        ('<td><input type=submit value="Try Selecting Again"'.
-                             ' name="'.$trolecode.'"></td>');
+                        $roletext.=
+			    '<td><input type=submit value="'.
+		  &mt('Try Selecting Again').'" name="'.$trolecode.'"></td>';
                     } elsif ($advanced) {
-                        $r->print
-                            ('<td><input type=submit value="Re-Initialize"'.
-                             ' name="'.$trolecode.'"></td>');
+                        $roletext.=
+                            '<td><input type=submit value="'.
+		        &mt('Re-Initialize').'" name="'.$trolecode.'"></td>';
                     } else {
-                        $r->print('<td>&nbsp;</td>');
+                        $roletext.='<td>&nbsp;</td>';
                     }
                 }
                 $tremark.=&Apache::lonannounce::showday(time,1,
                          &Apache::lonannounce::readcalendar($tdom.'_'.$trest));
                 
-		$r->print('<td><font color="'.$tfont.'">'.$trole.
+		$roletext.='<td><font color="'.$tfont.'">'.$trole.
                       '</font></td><td><font color="'.$tfont.'">'.$ttype.
                       '</font></td><td><font color="'.$tfont.'">'.$twhere.
                       '</font></td><td><font color="'.$tfont.'">'.$tpstart.
                       '</font></td><td><font color="'.$tfont.'">'.$tpend.
                       '</font></td><td><font color="'.$tfont.'">'.$tremark.
-                      '&nbsp;</font></td></tr>'."\n");
+                      '&nbsp;</font></td></tr>'."\n";
+		$roletext{$envkey}=$roletext;
+		if (!$sortkey) {$sortkey=$twhere."\0".$envkey;}
+		$sortrole{$sortkey}=$envkey;
+		$roleclass{$envkey}=$ttype;
 	    }
         }
     }
+# No active roles
+    if ($countactive==0) {
+	if ($inrole) {
+	    $r->print('<h2>'.&mt('Currently no additional roles or courses').'</h2>');
+	} else {
+	    $r->print('<h2>'.&mt('Currently no active roles or courses').'</h2>');
+	}
+	$r->print('</form></body></html>');
+	return OK;
+# Is there only one choice?
+    } elsif ($countactive==1) {
+	$r->print('<h3>'.&mt('Please stand by.').'</h3>'.
+	    '<input type="hidden" name="'.$possiblerole.'" value="1" />');
+	$r->print("</form>\n");
+	$r->rflush();
+	$r->print('<script>document.forms.rolechoice.submit();</script>');
+	$r->print('</body></html>');
+	return OK;
+    }
+# More than one possible role
+# ----------------------------------------------------------------------- Table
+    unless (($advanced) || ($nochoose)) {
+	$r->print("<h2>".&mt('Select a Course to Enter')."</h2>\n");
+    }
+    $r->print('<br /><table><tr>');
+    unless ($nochoose) { $r->print('<th>&nbsp;</th>'); }
+    $r->print('<th>'.&mt('User Role').'</th><th colspan=2>'.&mt('Extent').
+         '</th><th>'.&mt('Start').'</th><th>'.&mt('End').'</th><th>'.
+	      &mt('Remark').'</th></tr>'."\n");
+    my $doheaders=-1;
+    foreach my $type ('Construction Space','Course','Domain','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 ('Construction Space','Course','Domain','System') {
+	my $output;
+	foreach my $which (sort {uc($a) cmp uc($b)} (keys(%sortrole))) {
+	    if ($roleclass{$sortrole{$which}} =~ /^\Q$type\E/) { 
+		$output.=&mt($roletext{$sortrole{$which}});
+	    }
+	}
+	if ($output) {
+	    if ($doheaders > 0) {
+		$r->print("<tr bgcolor='#BBffBB'>".
+			  "<td align='center' colspan='7'>".&mt($type)."</td>");
+	    }
+	    $r->print($output);	    
+	}
+    }
     my $tremark='';
     my $tfont='#003300';
     if ($ENV{'request.role'} eq 'cm') {
 	$r->print('<tr bgcolor="#11CC55">');
-        $tremark='Currently selected.';
+        $tremark=&mt('Currently selected. ');
         $tfont='#002200';
     } else {
         $r->print('<tr bgcolor="#77FF77">');
     }
     unless ($nochoose) {
 	if ($ENV{'request.role'} ne 'cm') {
-	    $r->print('<td><input type=submit value=Select name="cm"></td>');
+	    $r->print('<td><input type=submit value="'.
+		      &mt('Select').'" name="cm"></td>');
 	} else {
 	    $r->print('<td>&nbsp;</td>');
 	}
     }
-    $r->print('<td colspan=5><font color="'.$tfont.'">No role specified'.
+    $r->print('<td colspan=5><font color="'.$tfont.'">'.&mt('No role specified').
       '</font></td><td><font color="'.$tfont.'">'.$tremark.
       '&nbsp;</font></td></tr>'."\n");
 
@@ -567,7 +652,12 @@ ENDHEADER
 	    }
 	}
     }
-
+    $r->print(&Apache::lonnet::getannounce());
+    if ($advanced) {
+	$r->print('<p><small><i>This is LON-CAPA '.
+		  $r->dir_config('lonVersion').'</i><br />'.
+		  '<a href="/adm/logout">'.&mt('Logout').'</a></small></p>');
+    }
     $r->print("</body></html>\n");
     return OK;
 } 
@@ -591,6 +681,36 @@ Invoked by /etc/httpd/conf/srm.conf:
  ErrorDocument	  500 /adm/errorhandler
  </Location>
 
+=head1 OVERVIEW
+
+=head2 Choosing Roles
+
+C<lonroles> 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<lonnet>'s C<&allowed> function that a certain
+action is not allowed, C<lonroles> 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<lonroles> can also be accessed via the
+B<CRS> 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<lonnet>'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