Diff for /loncom/auth/lonroles.pm between versions 1.30 and 1.91

version 1.30, 2001/10/31 17:47:55 version 1.91, 2004/05/09 00:45:00
Line 1 Line 1
 # The LearningOnline Network with CAPA  # The LearningOnline Network with CAPA
 # User Roles Screen  # User Roles Screen
 # (Directory Indexer  #
 # (Login Screen  # $Id$
 # 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)  # Copyright Michigan State University Board of Trustees
 # 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,  # This file is part of the LearningOnline Network with CAPA (LON-CAPA).
 # 12/08,12/28,  #
 # 01/15/01 Gerd Kortemeyer  # LON-CAPA is free software; you can redistribute it and/or modify
 # 02/27/01 Scott Harrison  # it under the terms of the GNU General Public License as published by
 # 03/02,05/03,05/25,05/30,06/01,07/06,08/06 Gerd Kortemeyer  # the Free Software Foundation; either version 2 of the License, or
   # (at your option) any later version.
   #
   # LON-CAPA is distributed in the hope that it will be useful,
   # but WITHOUT ANY WARRANTY; without even the implied warranty of
   # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   # GNU General Public License for more details.
   #
   # You should have received a copy of the GNU General Public License
   # along with LON-CAPA; if not, write to the Free Software
   # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
   #
   # /home/httpd/html/adm/gpl.txt
   #
   # http://www.lon-capa.org/
   #
   ###
   
 package Apache::lonroles;  package Apache::lonroles;
   
Line 20  use Apache::Constants qw(:common); Line 36  use Apache::Constants qw(:common);
 use Apache::File();  use Apache::File();
 use Apache::lonmenu;  use Apache::lonmenu;
 use Apache::loncommon;  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 (<<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 33  sub handler { Line 75  sub handler {
 # ================================================================== Roles Init  # ================================================================== Roles Init
   
     if ($ENV{'form.selectrole'}) {      if ($ENV{'form.selectrole'}) {
        &Apache::lonnet::appenv("request.course.id"  => '',   if ($ENV{'request.course.id'}) {
                                "request.course.fn"  => '',      my %temp=('logout_'.$ENV{'request.course.id'} => time);
                                "request.course.uri" => '',      &Apache::lonnet::put('email_status',\%temp);
                                "request.course.sec" => '',          }
                                "request.role" => 'cm');    &Apache::lonnet::appenv("request.course.id"   => '',
    "request.course.fn"   => '',
    "request.course.uri"  => '',
    "request.course.sec"  => '',
    "request.role"        => 'cm',
                                   "request.role.adv"    => $ENV{'user.adv'},
    "request.role.domain" => $ENV{'user.domain'});
         foreach $envkey (keys %ENV) {          foreach $envkey (keys %ENV) {
          if ($envkey=~/^user\.role\./) {              next if ($envkey!~/^user\.role\./);
     my ($dum1,$dum2,$role,@pwhere)=split(/\./,$envkey);      my (undef,undef,$role,@pwhere)=split(/\./,$envkey);
             my $where=join('.',@pwhere);              my $where=join('.',@pwhere);
             my $trolecode=$role.'.'.$where;              my $trolecode=$role.'.'.$where;
             if ($ENV{'form.'.$trolecode}) {              if ($ENV{'form.'.$trolecode}) {
                my ($tstart,$tend)=split(/\./,$ENV{$envkey});   my ($tstart,$tend)=split(/\./,$ENV{$envkey});
                my $tstatus='is';   my $tstatus='is';
                if ($tstart) {   if ($tstart) {
        if ($tstart>$then) {       if ($tstart>$then) { 
                      $tstatus='future';   $tstatus='future';
                   }      }
                }   }
                if ($tend) {   if ($tend) {
                   if ($tend<$then) { $tstatus='expired'; }      if ($tend<$then) { $tstatus='expired'; }
                   if ($tend<$now) { $tstatus='will_not'; }      if ($tend<$now) { $tstatus='will_not'; }
                }   }
                if ($tstatus eq 'is') {   if ($tstatus eq 'is') {
                    $where=~s/^\///;      $where=~s/^\///;
                    my ($cdom,$cnum,$csec)=split(/\//,$where);      my ($cdom,$cnum,$csec)=split(/\//,$where);
                    &Apache::lonnet::appenv('request.role' => $trolecode,  # check for keyed access
                                            'request.course.sec' => $csec);      if (($role eq 'st') && 
                    my $msg='Entering course ...';                         ($ENV{'course.'.$cdom.'_'.$cnum.'.keyaccess'} eq 'yes')) {
                    if (($cnum) && ($role ne 'ca')) {  # who is key authority?
       my ($furl,$ferr)=   my $authdom=$cdom;
   &Apache::lonuserstate::readmap($cdom.'/'.$cnum);   my $authnum=$cnum;
                       if (($ENV{'form.orgurl'}) &&    if ($ENV{'course.'.$cdom.'_'.$cnum.'.keyauth'}) {
                           ($ENV{'form.orgurl'}!~/^\/adm\/flip/)) {      ($authnum,$authdom)=
                          $r->internal_redirect($ENV{'form.orgurl'});   split(/\W/,$ENV{'course.'.$cdom.'_'.$cnum.'.keyauth'});
                          return OK;   }
      } else {  # check with key authority
                          unless ($ENV{'request.course.id'}) {   unless (&Apache::lonnet::validate_access_key(
                              &Apache::lonnet::appenv(       $ENV{'environment.key.'.$cdom.'_'.$cnum},
  "request.course.id"  => $cdom.'_'.$cnum);       $authdom,$authnum)) {
                              $furl='/adm/notfound.html';  # there is no valid key
                              $msg=       if ($ENV{'form.newkey'}) {
  '<h1><font color=red>Could not initialize top-level map.</font></h1>';  # student attempts to register a new key
                           }   &Apache::loncommon::content_type($r,'text/html');
                  $r->content_type('text/html');   &Apache::loncommon::no_cache($r);
                          &Apache::loncommon::no_cache($r);   $r->send_http_header;
                          $r->send_http_header;   my $swinfo=&Apache::lonmenu::rawconfig();
                          my $swinfo=&Apache::lonmenu::rawconfig;   my $bodytag=&Apache::loncommon::bodytag
                          print (<<ENDREDIR);      ('Verifying Access Key to Unlock this Course');
 <head><title>Entering Course</title>   my $buttontext=&mt('Enter Course');
 <meta HTTP-EQUIV="Refresh" CONTENT="1; url=$furl">   my $message=&mt('Successfully registered key');
    my $assignresult=
        &Apache::lonnet::assign_access_key(
        $ENV{'form.newkey'},
        $authdom,$authnum,
        $cdom,$cnum,
                                                        $ENV{'user.domain'},
        $ENV{'user.name'},
         'Assigned from '.$ENV{'REMOTE_ADDR'}.' at '.localtime().' for '.
                                                        $trolecode);
    unless ($assignresult eq 'ok') {
        $assignresult=~s/^error\:\s*//;
        $message=&mt($assignresult).
        '<br /><a href="/adm/logout">'.
        &mt('Logout').'</a>';
        $buttontext=&mt('Re-Enter Key');
    }
    $r->print(<<ENDENTEREDKEY);
   <head><title>Verifying Course Access Key</title>
 </head>  </head>
 <html>  <html>
 <body bgcolor="#FFFFFF">  $bodytag
 <script>  <script>
 $swinfo  $swinfo
 </script>  </script>
 $msg  <form method="post">
 </body>  <input type="hidden" name="selectrole" value="1" />
 </html>  <input type="hidden" name="$trolecode" value="1" />
 ENDREDIR  <font size="+2">$message</font><br />
   <input type="submit" value="$buttontext" />
   </form>
   </body></html>
   ENDENTEREDKEY
                                    return OK;
        } else {
   # print form to enter a new key
    &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
       ('Enter Access Key to Unlock this Course');
    $r->print(<<ENDENTERKEY);
   <head><title>Entering Course Access Key</title>
   </head>
   <html>
   $bodytag
   <script>
   $swinfo
   </script>
   <form method="post">
   <input type="hidden" name="selectrole" value="1" />
   <input type="hidden" name="$trolecode" value="1" />
   <input type="text" size="20" name="newkey" value="$ENV{'form.newkey'}" />
   <input type="submit" value="Enter key" />
   </form>
   </body></html>
   ENDENTERKEY
    return OK;
        }
    }
        }
       &Apache::lonnet::log($ENV{'user.domain'},
    $ENV{'user.name'},
    $ENV{'user.home'},
    "Role ".$trolecode);
                       my $tadv=0;
                       if (($trolecode!~/^st/) && 
                           ($trolecode!~/^ta/) && 
                           ($trolecode!~/^cm/)) { $tadv=1; }
       &Apache::lonnet::appenv(
                                              'request.role'        => $trolecode,
      'request.role.adv'    => $tadv,
      'request.role.domain' => $cdom,
      'request.course.sec'  => $csec);
       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/)) {
       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?tryagain=1';
    $msg=
       '<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 
       # for the first time
       my (undef, undef, $role, $courseid) = split(/\./, $envkey);
       if (substr($courseid, 0, 1) eq '/') {
    $courseid = substr($courseid, 1);
       }
       $courseid =~ s/\//_/;
       if ($role eq 'cc' && $ENV{'course.' . $courseid . 
     '.course.helper.not.run'}) {
    $furl = "/adm/helper/course.initialization.helper";
       }
                               #
                               # Send the user to the course they selected
                               &redirect_user($r,&mt('Entering Course'),
                                              $furl,$msg);
                             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,&mt('Entering Construction Space'),
                                          $redirect_url);
                           return OK;
                       }
    }
               }
         }          }
    }      }
           
   
 # =============================================================== No Roles Init  # =============================================================== No Roles Init
   
     $r->content_type('text/html');      &Apache::loncommon::content_type($r,'text/html');
     &Apache::loncommon::no_cache($r);      &Apache::loncommon::no_cache($r);
     $r->send_http_header;      $r->send_http_header;
     return OK if $r->header_only;      return OK if $r->header_only;
   
     my $swinfo=&Apache::lonmenu::rawconfig;      my $swinfo=&Apache::lonmenu::rawconfig();
       my $bodytag=&Apache::loncommon::bodytag('User Roles');
       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);      $r->print(<<ENDHEADER);
 <html>  <html>
 <head>  <head>
 <title>LON-CAPA User Roles</title>  <title>LON-CAPA User Roles</title>
 </head><body bgcolor="#FFFFFF">  </head>
   $bodytag
   $helptag<br />
 <script>  <script>
 $swinfo  $swinfo
 window.focus();  window.focus();
Line 126  ENDHEADER Line 298  ENDHEADER
   
     my ($fn,$priv,$nochoose,$error,$msg)=split(/:/,$ENV{'user.error.msg'});      my ($fn,$priv,$nochoose,$error,$msg)=split(/:/,$ENV{'user.error.msg'});
     if ($ENV{'user.error.msg'}) {      if ($ENV{'user.error.msg'}) {
        $r->log_reason(   $r->log_reason(
      "$msg for $ENV{'user.name'} domain $ENV{'user.domain'} access $priv",$fn);     "$msg for $ENV{'user.name'} domain $ENV{'user.domain'} access $priv",$fn);
     }      }
   
 # ---------------------------------------------------------------- Who is this?  # ------------------------------------------------- Can this user re-init, etc?
   
     my $advanced=0;      my $advanced=$ENV{'user.adv'};
     foreach $envkey (keys %ENV) {      &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},['tryagain']);
         if ($envkey=~/^user\.role\./) {      my $tryagain=$ENV{'form.tryagain'};
     my ($dum1,$dum2,$role,@pwhere)=split(/\./,$envkey);  
             if ($role ne 'st') { $advanced=1; }  
         }  
     }  
   
 # -------------------------------------------------------- Generate Page Output  # -------------------------------------------------------- Generate Page Output
 # --------------------------------------------------------------- Error Header?  # --------------------------------------------------------------- Error Header?
Line 149  ENDHEADER Line 317  ENDHEADER
         $r->print("Resource: $fn\n");          $r->print("Resource: $fn\n");
         $r->print("Action  : $msg\n</pre><hr>");          $r->print("Action  : $msg\n</pre><hr>");
     } else {      } else {
         $r->print("<h1>LON-CAPA User Roles</h1>");  
         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".
            if ($ENV{'request.course.id'}) {        &mt('This resource might be part of'));
        $r->print(' another');      if ($ENV{'request.course.id'}) {
            } else {   $r->print(&mt(' another'));
                $r->print(' a certain');      } else {
            }    $r->print(&mt(' a certain'));
            $r->print(' course.</body></html>');      } 
            return OK;      $r->print(&mt(' course.').'</body></html>');
       return OK;
         }           } 
     } else {      } else {
         if ($advanced) {          if ($advanced) {
            $r->print("<h2>Select a User Role</h2>\n");      $r->print(&mt("Your home server is ").
         } else {        $Apache::lonnet::hostname{&Apache::lonnet::homeserver
    $r->print("<h2>Enter a Course</h2>\n");                        ($ENV{'user.name'},$ENV{'user.domain'})}.
         "<br />\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)) {          if (($ENV{'REDIRECT_QUERY_STRING'}) && ($fn)) {
        $fn.='?'.$ENV{'REDIRECT_QUERY_STRING'};         $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=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"');
 # ----------------------------------------------------------------------- Table   if ($ENV{'form.showall'}) { $r->print(' checked'); }
     $r->print('<table><tr>');   $r->print('><input type=submit value="'.&mt('Display').'">');
     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");  
   
       my (%roletext,%sortrole,%roleclass);
       my $countactive=0;
       my $inrole=0;
       my $possiblerole='';
     foreach $envkey (sort keys %ENV) {      foreach $envkey (sort keys %ENV) {
           my $button = 1;
           my $switchserver='';
    my $roletext;
    my $sortkey;
         if ($envkey=~/^user\.role\./) {          if ($envkey=~/^user\.role\./) {
     my ($dum1,$dum2,$role,@pwhere)=split(/\./,$envkey);      my (undef,undef,$role,@pwhere)=split(/\./,$envkey);
               next if (!defined($role) || $role eq '');
             my $where=join('.',@pwhere);              my $where=join('.',@pwhere);
             my $trolecode=$role.'.'.$where;              my $trolecode=$role.'.'.$where;
             my ($tstart,$tend)=split(/\./,$ENV{$envkey});              my ($tstart,$tend)=split(/\./,$ENV{$envkey});
Line 202  ENDHEADER Line 380  ENDHEADER
             my $tstatus='is';              my $tstatus='is';
             my $tpstart='&nbsp;';              my $tpstart='&nbsp;';
             my $tpend='&nbsp;';              my $tpend='&nbsp;';
               my $tfont='#000000';
             if ($tstart) {              if ($tstart) {
  if ($tstart>$then) {    if ($tstart>$then) { 
                    $tstatus='future';                      $tstatus='future';
                    if ($tstart<$now) { $tstatus='will'; }                      if ($tstart<$now) { $tstatus='will'; }
                 }                  }
                 $tpstart=localtime($tstart);                  $tpstart=&Apache::lonlocal::locallocaltime($tstart);
             }              }
             if ($tend) {              if ($tend) {
                 if ($tend<$then) {                   if ($tend<$then) { 
                    $tstatus='expired';                       $tstatus='expired'; 
                 } elsif ($tend<$now) {                   } elsif ($tend<$now) { 
                    $tstatus='will_not';                       $tstatus='will_not'; 
                 }                  }
                 $tpend=localtime($tend);                  $tpend=&Apache::lonlocal::locallocaltime($tend);
             }              }
             if ($ENV{'request.role'} eq $trolecode) {              if ($ENV{'request.role'} eq $trolecode) {
  $tstatus='selected';   $tstatus='selected';
             }              }
             my $tbg;              my $tbg;
            if (($tstatus eq 'is') || ($tstatus eq 'selected') ||              if (($tstatus eq 'is') || ($tstatus eq 'selected') ||
                ($ENV{'form.showall'})) {                  ($ENV{'form.showall'})) {
             if ($tstatus eq 'is') {                  if ($tstatus eq 'is') {
  $tbg='#77FF77';                      $tbg='#77FF77';
             } elsif ($tstatus eq 'future') {                      $tfont='#003300';
                 $tbg='#FFFF77';      $possiblerole=$trolecode;
             } elsif ($tstatus eq 'will') {      $countactive++;
                 $tbg='#FFAA77';                  } elsif ($tstatus eq 'future') {
                 $tremark.='Active at next login. ';                      $tbg='#FFFF77';
             } elsif ($tstatus eq 'expired') {                      $button=0;
                 $tbg='#FF7777';                  } elsif ($tstatus eq 'will') {
     } elsif ($tstatus eq 'will_not') {                      $tbg='#FFAA77';
                 $tbg='#AAFF77';                      $tremark.=&mt('Active at next login. ');
                 $tremark.='Expired after logout. ';                  } elsif ($tstatus eq 'expired') {
             } elsif ($tstatus eq 'selected') {                      $tbg='#FF7777';
                 $tbg='#11CC55';                      $tfont='#330000';
                 $tremark.='Currently selected. ';                      $button=0;
             }                  } elsif ($tstatus eq 'will_not') {
             my $trole;                      $tbg='#AAFF77';
             if ($role =~ /^cr\//) {                      $tremark.=&mt('Expired after logout. ');
        my ($rdummy,$rdomain,$rauthor,$rrole)=split(/\//,$role);                  } elsif ($tstatus eq 'selected') {
                $tremark.='<br>Defined by '.$rauthor.' at '.$rdomain.'.';                      $tbg='#11CC55';
                $trole=$rrole;                      $tfont='#002200';
     } else {      $inrole=1;
                $trole=Apache::lonnet::plaintext($role);      $countactive++;
             }                      $tremark.=&mt('Currently selected. ');
             my $ttype;                  }
             my $twhere;                  my $trole;
             my ($tdom,$trest,$tsection)=                  if ($role =~ /^cr\//) {
                split(/\//,Apache::lonnet::declutter($where));                      my ($rdummy,$rdomain,$rauthor,$rrole)=split(/\//,$role);
             if ($trest) {                      $tremark.='<br>'.&mt('Defined by ').$rauthor.
       if ($role eq 'ca') {   &mt(' at ').$rdomain.'.';
         $ttype='Construction Space';                      $trole=$rrole;
                 $twhere='User: '.$trest.'<br>Domain: '.$tdom;  
                 $ENV{'course.'.$tdom.'_'.$trest.'.description'}='ca';  
               } else {  
  $ttype='Course';  
                 if ($tsection) {  
                    $ttype.='<br>Section/Group: '.$tsection;  
                 }       
                 my $tcourseid=$tdom.'_'.$trest;  
                 if ($ENV{'course.'.$tcourseid.'.description'}) {  
     $twhere=$ENV{'course.'.$tcourseid.'.description'};  
                 } else {                  } else {
                     my %newhash=Apache::lonnet::coursedescription($tcourseid);                      $trole=Apache::lonnet::plaintext($role);
                     if (%newhash) {                  }
  $twhere=$newhash{'description'};                  my $ttype;
                   my $twhere;
                   my ($tdom,$trest,$tsection)=
                       split(/\//,Apache::lonnet::declutter($where));
                   # First, Co-Authorship roles
                   if ($role eq 'ca') {
                       my $home = &Apache::lonnet::homeserver($trest,$tdom);
       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}.
                            '/adm/login?domain='.$ENV{'user.domain'}.
     '&username='.$ENV{'user.name'}.
                             '&firsturl=/priv/'.$trest);
                       }
                       #next if ($home eq 'no_host');
                       $home = $Apache::lonnet::hostname{$home};
                       $ttype='Construction Space';
                       $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'});
       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}.
                             '/adm/login?domain='.$ENV{'user.domain'}.
      '&username='.$ENV{'user.name'}.
                              '&firsturl=/priv/'.$ENV{'user.name'});
                       }
                       #next if ($home eq 'no_host');
                       $home = $Apache::lonnet::hostname{$home};
                       $ttype='Construction Space';
                       $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>'.&mt('Section/Group').': '.$tsection;
       }
                       my $tcourseid=$tdom.'_'.$trest;
                       if ($ENV{'course.'.$tcourseid.'.description'}) {
                           $twhere=$ENV{'course.'.$tcourseid.'.description'};
    $sortkey=$role."\0".$tdom."\0".$twhere."\0".$envkey;
                           unless ($twhere eq &mt('Currently not available')) {
       $twhere.=' <font size="-2">'.
           &Apache::loncommon::syllabuswrapper(&mt('Syllabus'),$trest,$tdom,$tfont).
                                       '</font>';
    }
                     } else {                      } else {
                         $twhere='Currently not available';                          my %newhash=Apache::lonnet::coursedescription
                         $ENV{'course.'.$tcourseid.'.description'}=$twhere;                              ($tcourseid);
                           if (%newhash) {
       $sortkey=$role."\0".$tdom."\0".$newhash{'description'}.
    "\0".$envkey;
                               $twhere=$newhash{'description'}.
                                 ' <font size="-2">'.
           &Apache::loncommon::syllabuswrapper(&mt('Syllabus'),$trest,$tdom,$tfont).
                                 '</font>';
                           } else {
                               $twhere=&mt('Currently not available');
                               $ENV{'course.'.$tcourseid.'.description'}=$twhere;
       $sortkey=$role."\0".$tdom."\0".$twhere."\0".$envkey;
                           }
                     }                      }
                 }      if ($role ne 'st') { $twhere.="<br />".&mt('Domain').":".$tdom; }
       }                  } elsif ($tdom) {
             } elsif ($tdom) {                      $ttype='Domain';
                 $ttype='Domain';                      $twhere=$tdom;
                 $twhere=$tdom;      $sortkey=$role.$twhere;
             } else {  
                 $ttype='System';  
                 $twhere='system wide';  
             }  
                  
             $r->print('<tr bgcolor='.$tbg.'>');  
             unless ($nochoose) {  
  if ($tstatus eq 'is') {  
                     $r->print('<td><input type=submit value=Select name="'.  
                               $trolecode.'"></td>');  
                 } elsif ($ENV{'user.adv'}) {  
                     $r->print(  
                         '<td><input type=submit value="Re-Initialize" name="'.  
                               $trolecode.'"></td>');  
                 } else {                  } else {
                     $r->print('<td>&nbsp;</td>');                      $ttype='System';
                       $twhere=&mt('system wide');
       $sortkey=$role.$twhere;
                 }                  }
             }   
             $r->print('<td>'.$trole.'</td><td>'.                  $roletext.='<tr bgcolor='.$tbg.'>';
       $ttype.'</td><td>'.$twhere.'</td><td>'.$tpstart.                  unless ($nochoose) {
                       '</td><td>'.$tpend.                      if (!$button) {
                       '</td><td>'.$tremark.'&nbsp;</td></tr>'."\n");   if ($switchserver) {
  }      $roletext.='<td><a href="/adm/logout?handover='.
                                 $switchserver.'">'.&mt('Switch Server').'</a></td>';
                           } else {
                               $roletext.=('<td>&nbsp;</td>');
                           }
                       } elsif ($tstatus eq 'is') {
                           $roletext.=('<td><input type=submit value="'.
     &mt('Select').'" name="'.
                                     $trolecode.'"></td>');
                       } elsif ($tryagain) {
                           $roletext.=
       '<td><input type=submit value="'.
     &mt('Try Selecting Again').'" name="'.$trolecode.'"></td>';
                       } elsif ($advanced) {
                           $roletext.=
                               '<td><input type=submit value="'.
           &mt('Re-Initialize').'" name="'.$trolecode.'"></td>';
                       } else {
                           $roletext.='<td>&nbsp;</td>';
                       }
                   }
                   $tremark.=&Apache::lonannounce::showday(time,1,
                            &Apache::lonannounce::readcalendar($tdom.'_'.$trest));
                   
    $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";
    $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) && ($ENV{'request.role'} eq 'cm')) {
    $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 $tremark='';
       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';
     } 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="'.
        } else {        &mt('Select').'" name="cm"></td>');
           $r->print('<td>&nbsp;</td>');   } else {
        }      $r->print('<td>&nbsp;</td>');
    }
     }      }
     $r->print('<td colspan=5>No role specified'.      $r->print('<td colspan=5><font color="'.$tfont.'">'.&mt('No role specified').
                       '</td><td>'.$tremark.'&nbsp;</td></tr>'."\n");        '</font></td><td><font color="'.$tfont.'">'.$tremark.
         '&nbsp;</font></td></tr>'."\n");
   
     $r->print('</table>');      $r->print('</table>');
     unless ($nochoose) {      unless ($nochoose) {
  $r->print("</form>\n");   $r->print("</form>\n");
     }      }
 # ------------------------------------------------------------ Privileges Info  # ------------------------------------------------------------ Privileges Info
   if ($advanced) {      if (($advanced) && (($ENV{'user.error.msg'}) || ($error))) {
     $r->print('<hr><h2>Current Privileges</h2>');   $r->print('<hr><h2>Current Privileges</h2>');
   
     foreach $envkey (sort keys %ENV) {   foreach $envkey (sort keys %ENV) {
         if ($envkey=~/^user\.priv\.$ENV{'request.role'}\./) {      if ($envkey=~/^user\.priv\.$ENV{'request.role'}\./) {
             my $where=$envkey;   my $where=$envkey;
             $where=~s/^user\.priv\.$ENV{'request.role'}\.//;   $where=~s/^user\.priv\.$ENV{'request.role'}\.//;
             my $ttype;   my $ttype;
             my $twhere;   my $twhere;
             my ($tdom,$trest,$tsec)=   my ($tdom,$trest,$tsec)=
                split(/\//,Apache::lonnet::declutter($where));      split(/\//,Apache::lonnet::declutter($where));
             if ($trest) {   if ($trest) {
       if ($ENV{'course.'.$tdom.'_'.$trest.'.description'} eq 'ca') {      if ($ENV{'course.'.$tdom.'_'.$trest.'.description'} eq 'ca') {
         $ttype='Construction Space';   $ttype='Construction Space';
                 $twhere='User: '.$trest.', Domain: '.$tdom;   $twhere='User: '.$trest.', Domain: '.$tdom;
               } else {      } else {
  $ttype='Course';   $ttype='Course';
                 $twhere=$ENV{'course.'.$tdom.'_'.$trest.'.description'};   $twhere=$ENV{'course.'.$tdom.'_'.$trest.'.description'};
                 if ($tsec) {   if ($tsec) {
     $twhere.=' (Section/Group: '.$tsec.')';      $twhere.=' (Section/Group: '.$tsec.')';
                 }   }
       }      }
             } elsif ($tdom) {   } elsif ($tdom) {
                 $ttype='Domain';      $ttype='Domain';
                 $twhere=$tdom;      $twhere=$tdom;
             } else {   } else {
                 $ttype='System';      $ttype='System';
                 $twhere='/';      $twhere='/';
             }   }
             $r->print("\n<h3>".$ttype.': '.$twhere.'</h3><ul>');   $r->print("\n<h3>".$ttype.': '.$twhere.'</h3><ul>');
             map {   foreach (sort split(/:/,$ENV{$envkey})) {
               if ($_) {      if ($_) {
   my ($prv,$restr)=split(/\&/,$_);   my ($prv,$restr)=split(/\&/,$_);
                   my $trestr='';   my $trestr='';
                   if ($restr ne 'F') {   if ($restr ne 'F') {
                       my $i;      my $i;
                       $trestr.=' (';      $trestr.=' (';
                       for ($i=0;$i<length($restr);$i++) {      for ($i=0;$i<length($restr);$i++) {
          $trestr.=   $trestr.=
                            Apache::lonnet::plaintext(substr($restr,$i,1));         Apache::lonnet::plaintext(substr($restr,$i,1));
                          if ($i<length($restr)-1) { $trestr.=', '; }   if ($i<length($restr)-1) { $trestr.=', '; }
       }      }
                       $trestr.=')';      $trestr.=')';
                   }   }
                   $r->print('<li>'.Apache::lonnet::plaintext($prv).$trestr.   $r->print('<li>'.
                             '</li>');    Apache::lonnet::plaintext($prv).$trestr.
       }    '</li>');
             } sort split(/:/,$ENV{$envkey});      }
             $r->print('</ul>');   }
         }   $r->print('</ul>');
       }
    }
       }
       $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");      $r->print("</body></html>\n");
     return OK;      return OK;
 }   } 
   
 1;  1;
 __END__  __END__
   
   =head1 NAME
   
   Apache::lonroles - User Roles Screen
   
   =head1 SYNOPSIS
   
   Invoked by /etc/httpd/conf/srm.conf:
   
    <Location /adm/roles>
    PerlAccessHandler       Apache::lonacc
    SetHandler perl-script
    PerlHandler Apache::lonroles
    ErrorDocument     403 /adm/login
    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
   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

Removed from v.1.30  
changed lines
  Added in v.1.91


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