Diff for /loncom/auth/lonroles.pm between versions 1.61 and 1.72

version 1.61, 2003/06/18 15:05:32 version 1.72, 2003/09/18 20:10:18
Line 51  use Apache::File(); Line 51  use Apache::File();
 use Apache::lonmenu;  use Apache::lonmenu;
 use Apache::loncommon;  use Apache::loncommon;
 use Apache::lonannounce;  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::no_cache($r);
       $r->send_http_header;
       my $swinfo=&Apache::lonmenu::rawconfig();
       my $bodytag=&Apache::loncommon::bodytag('Switching Role');
       $r->print (<<ENDREDIR);
   <head><title>$title</title>
   <meta HTTP-EQUIV="Refresh" CONTENT="1; url=$url">
   </head>
   <html>
   $bodytag
   <script>
   $swinfo
   </script>
   <h1>$msg</h1>
   </body>
   </html>
   ENDREDIR
       return;
   }
   
 sub handler {  sub handler {
   
Line 140  ENDENTERKEY Line 165  ENDENTERKEY
    'request.role.adv'    => $tadv,     'request.role.adv'    => $tadv,
    'request.role.domain' => $cdom,     'request.role.domain' => $cdom,
    'request.course.sec'  => $csec);     'request.course.sec'  => $csec);
     my $msg='Entering course ...';      my $msg=&mt('Entering course ...');
   
     if (($cnum) && ($role ne 'ca')) {      if (($cnum) && ($role ne 'ca')) {
  my ($furl,$ferr)=   my ($furl,$ferr)=
     &Apache::lonuserstate::readmap($cdom.'/'.$cnum);      &Apache::lonuserstate::readmap($cdom.'/'.$cnum);
  if (($ENV{'form.orgurl'}) &&    if (($ENV{'form.orgurl'}) && 
     ($ENV{'form.orgurl'}!~/^\/adm\/flip/)) {      ($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;      return OK;
  } else {   } else {
     unless ($ENV{'request.course.id'}) {      unless ($ENV{'request.course.id'}) {
Line 154  ENDENTERKEY Line 184  ENDENTERKEY
       "request.course.id"  => $cdom.'_'.$cnum);        "request.course.id"  => $cdom.'_'.$cnum);
  $furl='/adm/roles?tryagain=1';   $furl='/adm/roles?tryagain=1';
  $msg=   $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       # Check to see if the user is a CC entering a course 
Line 168  ENDENTERKEY Line 200  ENDENTERKEY
   '.course.helper.not.run'}) {    '.course.helper.not.run'}) {
  $furl = "/adm/helper/course.initialization.helper";   $furl = "/adm/helper/course.initialization.helper";
     }      }
                               #
     $r->content_type('text/html');                              # Send the user to the course they selected
     &Apache::loncommon::no_cache($r);                              &redirect_user($r,'Entering Course',
     $r->send_http_header;                                             $furl,$msg);
     my $swinfo=&Apache::lonmenu::rawconfig();  
     my $bodytag=&Apache::loncommon::bodytag('Switching Role');  
     print (<<ENDREDIR);  
 <head><title>Entering Course</title>  
 <meta HTTP-EQUIV="Refresh" CONTENT="1; url=$furl">  
 </head>  
 <html>  
 $bodytag  
 <script>  
 $swinfo  
 </script>  
 <h1>$msg</h1>  
 </body>  
 </html>  
 ENDREDIR  
                             return OK;                              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;
                       }
  }   }
             }              }
         }          }
Line 245  ENDHEADER Line 277  ENDHEADER
     } else {      } else {
         if ($ENV{'user.error.msg'}) {          if ($ENV{'user.error.msg'}) {
     $r->print(      $r->print(
  '<h3><font color=red>You need to choose another user role or '.   '<h3><font color=red>'.
  'enter a specific course for this function</font></h3>');   &mt('You need to choose another user role or enter a specific course for this function').'</font></h3>');
  }   }
     }      }
 # -------------------------------------------------------- Choice or no choice?  # -------------------------------------------------------- Choice or no choice?
     if ($nochoose) {      if ($nochoose) {
         if ($advanced) {          if ($advanced) {
     $r->print("<h2>Assigned User Roles</h2>\n");      $r->print("<h2>".&mt('Assigned User Roles')."</h2>\n");
         } else {          } 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'}) {      if ($ENV{'request.course.id'}) {
  $r->print(' another');   $r->print(&mt(' another'));
     } else {      } else {
  $r->print(' a certain');   $r->print(&mt(' a certain'));
     }       } 
     $r->print(' course.</body></html>');      $r->print(&mt(' course.').'</body></html>');
     return OK;      return OK;
         }           } 
     } else {      } else {
         if ($advanced) {          if ($advanced) {
     $r->print("Your home server is ".      $r->print(&mt("Your home server is ").
       $Apache::lonnet::hostname{&Apache::lonnet::homeserver        $Apache::lonnet::hostname{&Apache::lonnet::homeserver
                       ($ENV{'user.name'},$ENV{'user.domain'})}.                        ($ENV{'user.name'},$ENV{'user.domain'})}.
       "<br />\n");        "<br />\n");
     $r->print("Author and Co-Author roles may not be available on ".      $r->print(&mt(
       "servers other than your home server.");        "Author and Co-Author roles may not be available on servers other than your home server."));
         } else {          } 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)) {          if (($ENV{'REDIRECT_QUERY_STRING'}) && ($fn)) {
        $fn.='?'.$ENV{'REDIRECT_QUERY_STRING'};         $fn.='?'.$ENV{'REDIRECT_QUERY_STRING'};
Line 281  ENDHEADER Line 314  ENDHEADER
         $r->print('<input type=hidden name=orgurl value="'.$fn.'">');          $r->print('<input type=hidden name=orgurl value="'.$fn.'">');
         $r->print('<input type=hidden name=selectrole value=1>');          $r->print('<input type=hidden name=selectrole value=1>');
     }      }
     $r->print('<br>Show all roles: <input type=checkbox name=showall');      if ($ENV{'user.adv'}) {
     if ($ENV{'form.showall'}) { $r->print(' checked'); }   $r->print(
     $r->print('><input type=submit value="Display"><br>');        '<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  # ----------------------------------------------------------------------- Table
     $r->print('<table><tr>');      $r->print('<br /><table><tr>');
     unless ($nochoose) { $r->print('<th>&nbsp;</th>'); }      unless ($nochoose) { $r->print('<th>&nbsp;</th>'); }
     $r->print('<th>User Role</th><th colspan=2>Extent</th>'.      $r->print('<th>'.&mt('User Role').'</th><th colspan=2>'.&mt('Extent').
       '<th>Start</th><th>End</th><th>Remark</th></tr>'."\n");           '</th><th>'.&mt('Start').'</th><th>'.&mt('End').'</th><th>'.
         &mt('Remark').'</th></tr>'."\n");
   
     foreach $envkey (sort keys %ENV) {      foreach $envkey (sort keys %ENV) {
         my $button = 1;          my $button = 1;
Line 333  ENDHEADER Line 370  ENDHEADER
                     $button=0;                      $button=0;
                 } elsif ($tstatus eq 'will') {                  } elsif ($tstatus eq 'will') {
                     $tbg='#FFAA77';                      $tbg='#FFAA77';
                     $tremark.='Active at next login. ';                      $tremark.=&mt('Active at next login. ');
                 } elsif ($tstatus eq 'expired') {                  } elsif ($tstatus eq 'expired') {
                     $tbg='#FF7777';                      $tbg='#FF7777';
                     $tfont='#330000';                      $tfont='#330000';
                     $button=0;                      $button=0;
                 } elsif ($tstatus eq 'will_not') {                  } elsif ($tstatus eq 'will_not') {
                     $tbg='#AAFF77';                      $tbg='#AAFF77';
                     $tremark.='Expired after logout. ';                      $tremark.=&mt('Expired after logout. ');
                 } elsif ($tstatus eq 'selected') {                  } elsif ($tstatus eq 'selected') {
                     $tbg='#11CC55';                      $tbg='#11CC55';
                     $tfont='#002200';                      $tfont='#002200';
                     $tremark.='Currently selected. ';                      $tremark.=&mt('Currently selected. ');
                 }                  }
                 my $trole;                  my $trole;
                 if ($role =~ /^cr\//) {                  if ($role =~ /^cr\//) {
                     my ($rdummy,$rdomain,$rauthor,$rrole)=split(/\//,$role);                      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;                      $trole=$rrole;
                 } else {                  } else {
                     $trole=Apache::lonnet::plaintext($role);                      $trole=Apache::lonnet::plaintext($role);
Line 371  ENDHEADER Line 409  ENDHEADER
                     }                      }
                     #next if ($home eq 'no_host');                      #next if ($home eq 'no_host');
                     $home = $Apache::lonnet::hostname{$home};                      $home = $Apache::lonnet::hostname{$home};
                     $ttype='Construction Space';                      $ttype=&mt('Construction Space');
                     $twhere='User: '.$trest.'<br />Domain: '.$tdom.'<br />'.                      $twhere=&mt('User').': '.$trest.'<br />'.&mt('Domain').
                         ' Server:&nbsp;'.$home;   ': '.$tdom.'<br />'.
                           ' '.&mt('Server').':&nbsp;'.$home;
                     $ENV{'course.'.$tdom.'_'.$trest.'.description'}='ca';                      $ENV{'course.'.$tdom.'_'.$trest.'.description'}='ca';
                 } elsif ($role eq 'au') {                  } elsif ($role eq 'au') {
                     # Authors                      # Authors
Line 389  ENDHEADER Line 428  ENDHEADER
                     }                      }
                     #next if ($home eq 'no_host');                      #next if ($home eq 'no_host');
                     $home = $Apache::lonnet::hostname{$home};                      $home = $Apache::lonnet::hostname{$home};
                     $ttype='Construction Space';                      $ttype=&mt('Construction Space');
                     $twhere='Domain: '.$tdom.'<br />Server:&nbsp;'.$home;                      $twhere=&mt('Domain').': '.$tdom.'<br />'.&mt('Server').
    ':&nbsp;'.$home;
                     $ENV{'course.'.$tdom.'_'.$trest.'.description'}='ca';                      $ENV{'course.'.$tdom.'_'.$trest.'.description'}='ca';
                 } elsif ($trest) {                  } elsif ($trest) {
                     $ttype='Course';                      $ttype=&mt('Course');
                     if ($tsection) {                      if ($tsection) {
                         $ttype.='<br>Section/Group: '.$tsection;                          $ttype.='<br>'.&mt('Section/Group').': '.$tsection;
     }      }
                     my $tcourseid=$tdom.'_'.$trest;                      my $tcourseid=$tdom.'_'.$trest;
                     if ($ENV{'course.'.$tcourseid.'.description'}) {                      if ($ENV{'course.'.$tcourseid.'.description'}) {
                         $twhere=$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">'.      $twhere.=' <font size="-2">'.
         &Apache::loncommon::syllabuswrapper('Syllabus',$trest,$tdom,$tfont).          &Apache::loncommon::syllabuswrapper(&mt('Syllabus'),$trest,$tdom,$tfont).
                                     '</font>';                                      '</font>';
  }   }
                     } else {                      } else {
Line 411  ENDHEADER Line 451  ENDHEADER
                         if (%newhash) {                          if (%newhash) {
                             $twhere=$newhash{'description'}.                              $twhere=$newhash{'description'}.
                               ' <font size="-2">'.                                ' <font size="-2">'.
         &Apache::loncommon::syllabuswrapper('Syllabus',$trest,$tdom,$tfont).          &Apache::loncommon::syllabuswrapper(&mt('Syllabus'),$trest,$tdom,$tfont).
                               '</font>';                                '</font>';
                         } else {                          } else {
                             $twhere='Currently not available';                              $twhere=&mt('Currently not available');
                             $ENV{'course.'.$tcourseid.'.description'}=$twhere;                              $ENV{'course.'.$tcourseid.'.description'}=$twhere;
                         }                          }
                     }                      }
     if ($role ne 'st') { $twhere.="<br />Domain:".$tdom; }      if ($role ne 'st') { $twhere.="<br />".&mt('Domain').":".$tdom; }
                 } elsif ($tdom) {                  } elsif ($tdom) {
                     $ttype='Domain';                      $ttype=&mt('Domain');
                     $twhere=$tdom;                      $twhere=$tdom;
                 } else {                  } else {
                     $ttype='System';                      $ttype=&mt('System');
                     $twhere='system wide';                      $twhere=&mt('system wide');
                 }                  }
     
                 $r->print('<tr bgcolor='.$tbg.'>');                  $r->print('<tr bgcolor='.$tbg.'>');
Line 432  ENDHEADER Line 472  ENDHEADER
                     if (!$button) {                      if (!$button) {
  if ($switchserver) {   if ($switchserver) {
     $r->print('<td><a href="/adm/logout?handover='.      $r->print('<td><a href="/adm/logout?handover='.
                               $switchserver.'">Switch Server</a></td>');                                $switchserver.'">'.&mt('Switch Server').'</a></td>');
                         } else {                          } else {
                             $r->print('<td>&nbsp;</td>');                              $r->print('<td>&nbsp;</td>');
                         }                          }
                     } elsif ($tstatus eq 'is') {                      } 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>');                                    $trolecode.'"></td>');
                     } elsif ($tryagain) {                      } elsif ($tryagain) {
                         $r->print                          $r->print
                         ('<td><input type=submit value="Try Selecting Again"'.                          ('<td><input type=submit value="'.
                              ' name="'.$trolecode.'"></td>');    &mt('Try Selecting Again').'" name="'.$trolecode.'"></td>');
                     } elsif ($advanced) {                      } elsif ($advanced) {
                         $r->print                          $r->print
                             ('<td><input type=submit value="Re-Initialize"'.                              ('<td><input type=submit value="'.
                              ' name="'.$trolecode.'"></td>');          &mt('Re-Initialize').'" name="'.$trolecode.'"></td>');
                     } else {                      } else {
                         $r->print('<td>&nbsp;</td>');                          $r->print('<td>&nbsp;</td>');
                     }                      }
Line 468  ENDHEADER Line 509  ENDHEADER
     my $tfont='#003300';      my $tfont='#003300';
     if ($ENV{'request.role'} eq 'cm') {      if ($ENV{'request.role'} eq 'cm') {
  $r->print('<tr bgcolor="#11CC55">');   $r->print('<tr bgcolor="#11CC55">');
         $tremark='Currently selected.';          $tremark=&mt('Currently selected. ');
         $tfont='#002200';          $tfont='#002200';
     } else {      } else {
         $r->print('<tr bgcolor="#77FF77">');          $r->print('<tr bgcolor="#77FF77">');
     }      }
     unless ($nochoose) {      unless ($nochoose) {
  if ($ENV{'request.role'} ne 'cm') {   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 {   } else {
     $r->print('<td>&nbsp;</td>');      $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.        '</font></td><td><font color="'.$tfont.'">'.$tremark.
       '&nbsp;</font></td></tr>'."\n");        '&nbsp;</font></td></tr>'."\n");
   
Line 542  ENDHEADER Line 584  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");      $r->print("</body></html>\n");
     return OK;      return OK;
 }   } 
Line 566  Invoked by /etc/httpd/conf/srm.conf: Line 612  Invoked by /etc/httpd/conf/srm.conf:
  ErrorDocument  500 /adm/errorhandler   ErrorDocument  500 /adm/errorhandler
  </Location>   </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  =head1 INTRODUCTION
   
 This module enables a user to select what role he wishes to  This module enables a user to select what role he wishes to

Removed from v.1.61  
changed lines
  Added in v.1.72


FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>