--- loncom/auth/lonroles.pm	2003/06/24 15:52:32	1.62
+++ loncom/auth/lonroles.pm	2003/09/18 20:10:18	1.72
@@ -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.72 2003/09/18 20:10:18 www Exp $
 #
 # Copyright Michigan State University Board of Trustees
 #
@@ -51,6 +51,7 @@ use Apache::File();
 use Apache::lonmenu;
 use Apache::loncommon;
 use Apache::lonannounce;
+use Apache::lonlocal;
 
 sub redirect_user {
     my ($r,$title,$url,$msg) = @_;
@@ -164,14 +165,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 +184,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 
@@ -270,34 +277,35 @@ 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.");
+	    $r->print(&mt(
+      "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("<h2>".&mt('Select a Course to Enter')."</h2>\n");
         }
         if (($ENV{'REDIRECT_QUERY_STRING'}) && ($fn)) {
     	    $fn.='?'.$ENV{'REDIRECT_QUERY_STRING'};
@@ -306,14 +314,18 @@ ENDHEADER
         $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>');
+    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').'">');
+    }
 # ----------------------------------------------------------------------- Table
-    $r->print('<table><tr>');
+    $r->print('<br /><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");
+    $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");
 
     foreach $envkey (sort keys %ENV) {
         my $button = 1;
@@ -358,23 +370,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.='<br>Defined by '.$rauthor.' at '.$rdomain.'.';
+                    $tremark.='<br>'.&mt('Defined by ').$rauthor.
+			&mt(' at ').$rdomain.'.';
                     $trole=$rrole;
                 } else {
                     $trole=Apache::lonnet::plaintext($role);
@@ -396,9 +409,10 @@ 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;
+                    $ttype=&mt('Construction Space');
+                    $twhere=&mt('User').': '.$trest.'<br />'.&mt('Domain').
+			': '.$tdom.'<br />'.
+                        ' '.&mt('Server').':&nbsp;'.$home;
                     $ENV{'course.'.$tdom.'_'.$trest.'.description'}='ca';
                 } elsif ($role eq 'au') {
                     # Authors
@@ -414,20 +428,21 @@ ENDHEADER
                     }
                     #next if ($home eq 'no_host');
                     $home = $Apache::lonnet::hostname{$home};
-                    $ttype='Construction Space';
-                    $twhere='Domain: '.$tdom.'<br />Server:&nbsp;'.$home;
+                    $ttype=&mt('Construction Space');
+                    $twhere=&mt('Domain').': '.$tdom.'<br />'.&mt('Server').
+			':&nbsp;'.$home;
                     $ENV{'course.'.$tdom.'_'.$trest.'.description'}='ca';
                 } elsif ($trest) {
-                    $ttype='Course';
+                    $ttype=&mt('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') {
+                        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 {
@@ -436,20 +451,20 @@ ENDHEADER
                         if (%newhash) {
                             $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;
                         }
                     }
-		    if ($role ne 'st') { $twhere.="<br />Domain:".$tdom; }
+		    if ($role ne 'st') { $twhere.="<br />".&mt('Domain').":".$tdom; }
                 } elsif ($tdom) {
-                    $ttype='Domain';
+                    $ttype=&mt('Domain');
                     $twhere=$tdom;
                 } else {
-                    $ttype='System';
-                    $twhere='system wide';
+                    $ttype=&mt('System');
+                    $twhere=&mt('system wide');
                 }
  
                 $r->print('<tr bgcolor='.$tbg.'>');
@@ -457,21 +472,22 @@ ENDHEADER
                     if (!$button) {
 			if ($switchserver) {
 			    $r->print('<td><a href="/adm/logout?handover='.
-                              $switchserver.'">Switch Server</a></td>');
+                              $switchserver.'">'.&mt('Switch Server').'</a></td>');
                         } else {
                             $r->print('<td>&nbsp;</td>');
                         }
                     } elsif ($tstatus eq 'is') {
-                        $r->print('<td><input type=submit value=Select name="'.
+                        $r->print('<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>');
+                        ('<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>');
+                            ('<td><input type=submit value="'.
+		        &mt('Re-Initialize').'" name="'.$trolecode.'"></td>');
                     } else {
                         $r->print('<td>&nbsp;</td>');
                     }
@@ -493,19 +509,20 @@ ENDHEADER
     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 +584,11 @@ ENDHEADER
 	    }
 	}
     }
-
+    $r->print(&Apache::lonnet::getannounce());
+    if ($advanced) {
+	$r->print('<p><small><i>This is LON-CAPA '.
+		  $r->dir_config('lonVersion').'</i></small></p>');
+    }
     $r->print("</body></html>\n");
     return OK;
 } 
@@ -591,6 +612,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