Diff for /loncom/auth/lonroles.pm between versions 1.22 and 1.43

version 1.22, 2001/02/27 20:44:18 version 1.43, 2002/08/31 00:43:12
Line 1 Line 1
 # The LearningOnline Network with CAPA  # The LearningOnline Network with CAPA
 # User Roles Screen  # User Roles Screen
   #
   # $Id$
   #
   # Copyright Michigan State University Board of Trustees
   #
   # This file is part of the LearningOnline Network with CAPA (LON-CAPA).
   #
   # LON-CAPA is free software; you can redistribute it and/or modify
   # it under the terms of the GNU General Public License as published by
   # 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/
   #
 # (Directory Indexer  # (Directory Indexer
 # (Login Screen  # (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)  # 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)  # 11/23 Gerd Kortemeyer)
   # YEAR=2000
 # 1/14,03/06,06/01,07/22,07/24,07/25,  # 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,  # 09/04,09/06,09/28,09/29,09/30,10/2,10/5,10/26,10/28,
 # 12/08,12/28,  # 12/08,12/28,
   # YEAR=2001
 # 01/15/01 Gerd Kortemeyer  # 01/15/01 Gerd Kortemeyer
 # 02/27/01 Scott Harrison  # 02/27/01 Scott Harrison
   # 03/02,05/03,05/25,05/30,06/01,07/06,08/06 Gerd Kortemeyer
   # 12/21 Scott Harrison
   # 12/29 Gerd Kortemeyer
   #
   ###
   
 package Apache::lonroles;  package Apache::lonroles;
   
Line 17  use Apache::lonnet(); Line 50  use Apache::lonnet();
 use Apache::lonuserstate();  use Apache::lonuserstate();
 use Apache::Constants qw(:common);  use Apache::Constants qw(:common);
 use Apache::File();  use Apache::File();
   use Apache::lonmenu;
   use Apache::loncommon;
   
 sub handler {  sub handler {
   
Line 30  sub handler { Line 65  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.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}) {
Line 55  sub handler { Line 95  sub handler {
                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,                     &Apache::lonnet::appenv('request.role'        => $trolecode,
                                            'request.course.sec' => $csec);                                             'request.role.domain' => $cdom,
                    if ($cnum) {                                             'request.course.sec'  => $csec);
                      my $msg='Entering course ...';
                      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'}) && 
Line 65  sub handler { Line 107  sub handler {
                          $r->internal_redirect($ENV{'form.orgurl'});                           $r->internal_redirect($ENV{'form.orgurl'});
                          return OK;                           return OK;
      } else {       } else {
                            unless ($ENV{'request.course.id'}) {
                                &Apache::lonnet::appenv(
    "request.course.id"  => $cdom.'_'.$cnum);
                                $furl='/adm/notfound.html';
                                $msg=
    '<h1><font color=red>Could not initialize top-level map.</font></h1>';
                             }
                  $r->content_type('text/html');                   $r->content_type('text/html');
                            &Apache::loncommon::no_cache($r);
                          $r->send_http_header;                           $r->send_http_header;
                            my $swinfo=&Apache::lonmenu::rawconfig($r);
                            my $bodytag=&Apache::loncommon::bodytag('Switching Role');
                          print (<<ENDREDIR);                           print (<<ENDREDIR);
 <head><title>Entering Course</title>  <head><title>Entering Course</title>
 <meta HTTP-EQUIV="Refresh" CONTENT="1; url=$furl">  <meta HTTP-EQUIV="Refresh" CONTENT="1; url=$furl">
 </head>  </head>
 <html>  <html>
 <body bgcolor="#FFFFFF">  $bodytag
 Entering course ...  <script>
   $swinfo
   </script>
   <h1>$msg</h1>
 </body>  </body>
 </html>  </html>
 ENDREDIR  ENDREDIR
Line 82  ENDREDIR Line 137  ENDREDIR
                    }                     }
                }                 }
             }               } 
   }  
         }          }
    }      }
                   
   
 # =============================================================== No Roles Init  # =============================================================== No Roles Init
   
     $r->content_type('text/html');      $r->content_type('text/html');
       &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($r);
       my $bodytag=&Apache::loncommon::bodytag('User Roles');
     $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>
 <script>window.focus();</script>  $bodytag
   <script>
   $swinfo
   window.focus();
   </script>
 ENDHEADER  ENDHEADER
   
 # ------------------------------------------ Get Error Message from Environment  # ------------------------------------------ Get Error Message from Environment
Line 114  ENDHEADER Line 175  ENDHEADER
     my $advanced=0;      my $advanced=0;
     foreach $envkey (keys %ENV) {      foreach $envkey (keys %ENV) {
         if ($envkey=~/^user\.role\./) {          if ($envkey=~/^user\.role\./) {
     my ($dum1,$dum2,$role,@pwhere)=split(/\./,$envkey);      my (undef,undef,$role,@pwhere)=split(/\./,$envkey);
             if ($role ne 'st') { $advanced=1; }              if ($role ne 'st') { $advanced=1; }
         }          }
     }      }
Line 128  ENDHEADER Line 189  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'}) {
       $r->print(
    '<h3><font color=red>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) {
Line 146  ENDHEADER Line 211  ENDHEADER
         }           } 
     } else {      } else {
         if ($advanced) {          if ($advanced) {
            $r->print("<h2>Select a User Role</h2>\n");             $r->print("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 {          } else {
    $r->print("<h2>Enter a Course</h2>\n");     $r->print("<h2>Enter a Course</h2>\n");
         }          }
Line 157  ENDHEADER Line 227  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{'form.showall'}) { $r->print(' checked'); }
       $r->print('><input type=submit value="Display"><br>');
 # ----------------------------------------------------------------------- Table  # ----------------------------------------------------------------------- Table
     $r->print('<table><tr>');      $r->print('<table><tr>');
     unless ($nochoose) { $r->print('<th>&nbsp;</th>'); }      unless ($nochoose) { $r->print('<th>&nbsp;</th>'); }
Line 164  ENDHEADER Line 237  ENDHEADER
                  '<th>Start</th><th>End</th><th>Remark</th></tr>'."\n");                   '<th>Start</th><th>End</th><th>Remark</th></tr>'."\n");
   
     foreach $envkey (sort keys %ENV) {      foreach $envkey (sort keys %ENV) {
           my $button = 1;
         if ($envkey=~/^user\.role\./) {          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;
             my ($tstart,$tend)=split(/\./,$ENV{$envkey});              my ($tstart,$tend)=split(/\./,$ENV{$envkey});
Line 175  ENDHEADER Line 249  ENDHEADER
             my $tpend='&nbsp;';              my $tpend='&nbsp;';
             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=localtime($tstart);
             }              }
             if ($tend) {              if ($tend) {
                 if ($tend<$then) { $tstatus='expired'; }                  if ($tend<$then) { 
                 if ($tend<$now) { $tstatus='will_not'; }                      $tstatus='expired'; 
                   } elsif ($tend<$now) { 
                       $tstatus='will_not'; 
                   }
                 $tpend=localtime($tend);                  $tpend=localtime($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') {              if (($tstatus eq 'is') || ($tstatus eq 'selected') ||
  $tbg='#77FF77';                  ($ENV{'form.showall'})) {
             } elsif ($tstatus eq 'future') {                  if ($tstatus eq 'is') {
                 $tbg='#FFFF77';                      $tbg='#77FF77';
             } elsif ($tstatus eq 'will') {                  } elsif ($tstatus eq 'future') {
                 $tbg='#FFAA77';                      $tbg='#FFFF77';
                 $tremark.='Active at next login. ';                  } elsif ($tstatus eq 'will') {
             } elsif ($tstatus eq 'expired') {                      $tbg='#FFAA77';
                 $tbg='#FF7777';                      $tremark.='Active at next login. ';
     } elsif ($tstatus eq 'will_not') {                  } elsif ($tstatus eq 'expired') {
                 $tbg='#AAFF77';                      $tbg='#FF7777';
                 $tremark.='Expired after logout. ';                  } elsif ($tstatus eq 'will_not') {
             } elsif ($tstatus eq 'selected') {                      $tbg='#AAFF77';
                 $tbg='#11CC55';                      $tremark.='Expired after logout. ';
                 $tremark.='Currently selected. ';                  } elsif ($tstatus eq 'selected') {
             }                      $tbg='#11CC55';
             my $trole;                      $tremark.='Currently selected. ';
             if ($role =~ /^cr\//) {                  }
        my ($rdummy,$rdomain,$rauthor,$rrole)=split(/\//,$role);                  my $trole;
                $tremark.='<br>Defined by '.$rauthor.' at '.$rdomain.'.';                  if ($role =~ /^cr\//) {
                $trole=$rrole;                      my ($rdummy,$rdomain,$rauthor,$rrole)=split(/\//,$role);
     } else {                      $tremark.='<br>Defined by '.$rauthor.' at '.$rdomain.'.';
                $trole=Apache::lonnet::plaintext($role);                      $trole=$rrole;
             }  
             my $ttype;  
             my $twhere;  
             my ($tdom,$trest,$tsection)=  
                split(/\//,Apache::lonnet::declutter($where));  
             if ($trest) {  
  $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);
                       $button = 0 if ($home ne $r->dir_config('lonHostID'));
                       #next if ($home eq 'no_host');
                       $home = $Apache::lonnet::hostname{$home};
                       $ttype='Construction Space';
                       $twhere='User: '.$trest.'<br />Domain: '.$tdom.'<br />'.
                           ' Server:&nbsp;'.$home;
                       $ENV{'course.'.$tdom.'_'.$trest.'.description'}='ca';
                   } elsif ($role eq 'au') {
                       # Authors
                       my $home = &Apache::lonnet::homeserver
                           ($ENV{'user.name'},$ENV{'user.domain'});
                       $button = 0 if ($home ne $r->dir_config('lonHostID'));
                       #next if ($home eq 'no_host');
                       $home = $Apache::lonnet::hostname{$home};
                       $ttype='Construction Space';
                       $twhere='Domain: '.$tdom.'<br />Server:&nbsp;'.$home;
                       $ENV{'course.'.$tdom.'_'.$trest.'.description'}='ca';
                   } elsif ($trest) {
                       $ttype='Course';
                       if ($tsection) {
                           $ttype.='<br>Section/Group: '.$tsection;
       }
                       my $tcourseid=$tdom.'_'.$trest;
                       if ($ENV{'course.'.$tcourseid.'.description'}) {
                           $twhere=
   &Apache::loncommon::syllabuswrapper($ENV{'course.'.$tcourseid.'.description'},
   $trest,$tdom);
                     } else {                      } else {
                         $twhere='Currently not available';                          my %newhash=Apache::lonnet::coursedescription
                         $ENV{'course.'.$tcourseid.'.description'}=$twhere;                              ($tcourseid);
                           if (%newhash) {
                               $twhere=
   &Apache::loncommon::syllabuswrapper($newhash{'description'},$trest,$tdom);
                           } else {
                               $twhere='Currently not available';
                               $ENV{'course.'.$tcourseid.'.description'}=$twhere;
                           }
                     }                      }
                 }      if ($role ne 'st') { $twhere.="<br />Domain:".$tdom; }
             } elsif ($tdom) {                  } elsif ($tdom) {
                 $ttype='Domain';                      $ttype='Domain';
                 $twhere=$tdom;                      $twhere=$tdom;
             } 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>');  
                 } else {                  } else {
                     $r->print('<td>&nbsp;</td>');                      $ttype='System';
                       $twhere='system wide';
                   }
    
   # ----- do not trust the indention below here -----              
                   $r->print('<tr bgcolor='.$tbg.'>');
                   unless ($nochoose) {
                       if (!$button) {
                           $r->print('<td>&nbsp;</td>');
                       } elsif ($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 {
                           $r->print('<td>&nbsp;</td>');
                       }
                 }                  }
             }  
             $r->print('<td>'.$trole.'</td><td>'.              $r->print('<td>'.$trole.'</td><td>'.
       $ttype.'</td><td>'.$twhere.'</td><td>'.$tpstart.        $ttype.'</td><td>'.$twhere.'</td><td>'.$tpstart.
                       '</td><td>'.$tpend.                        '</td><td>'.$tpend.
                       '</td><td>'.$tremark.'&nbsp;</td></tr>'."\n");                        '</td><td>'.$tremark.'&nbsp;</td></tr>'."\n");
    }
         }          }
     }      }
     my $tremark='';      my $tremark='';
Line 279  ENDHEADER Line 391  ENDHEADER
  $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) {
Line 291  ENDHEADER Line 403  ENDHEADER
             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') {
           $ttype='Construction Space';
                   $twhere='User: '.$trest.', Domain: '.$tdom;
                 } 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;
Line 304  ENDHEADER Line 421  ENDHEADER
                 $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='';
Line 321  ENDHEADER Line 438  ENDHEADER
                   $r->print('<li>'.Apache::lonnet::plaintext($prv).$trestr.                    $r->print('<li>'.Apache::lonnet::plaintext($prv).$trestr.
                             '</li>');                              '</li>');
       }        }
             } sort split(/:/,$ENV{$envkey});              }
             $r->print('</ul>');              $r->print('</ul>');
         }          }
     }      }
Line 333  ENDHEADER Line 450  ENDHEADER
   
 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 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.22  
changed lines
  Added in v.1.43


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