Annotation of loncom/auth/lonroles.pm, revision 1.33

1.1       harris41    1: # The LearningOnline Network with CAPA
                      2: # User Roles Screen
1.31      www         3: #
1.33    ! www         4: # $Id: lonroles.pm,v 1.32 2001/12/21 16:57:54 harris41 Exp $
1.31      www         5: #
                      6: # Copyright Michigan State University Board of Trustees
                      7: #
                      8: # This file is part of the LearningOnline Network with CAPA (LON-CAPA).
                      9: #
                     10: # LON-CAPA is free software; you can redistribute it and/or modify
                     11: # it under the terms of the GNU General Public License as published by
                     12: # the Free Software Foundation; either version 2 of the License, or
                     13: # (at your option) any later version.
                     14: #
                     15: # LON-CAPA is distributed in the hope that it will be useful,
                     16: # but WITHOUT ANY WARRANTY; without even the implied warranty of
                     17: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
                     18: # GNU General Public License for more details.
                     19: #
                     20: # You should have received a copy of the GNU General Public License
                     21: # along with LON-CAPA; if not, write to the Free Software
                     22: # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
                     23: #
                     24: # /home/httpd/html/adm/gpl.txt
                     25: #
                     26: # http://www.lon-capa.org/
                     27: #
1.1       harris41   28: # (Directory Indexer
                     29: # (Login Screen
1.32      harris41   30: # YEAR=1999
1.1       harris41   31: # 5/21/99,5/22,5/25,5/26,5/31,6/2,6/10,7/12,7/14 Gerd Kortemeyer)
                     32: # 11/23 Gerd Kortemeyer)
1.32      harris41   33: # YEAR=2000
1.7       www        34: # 1/14,03/06,06/01,07/22,07/24,07/25,
1.19      www        35: # 09/04,09/06,09/28,09/29,09/30,10/2,10/5,10/26,10/28,
1.20      www        36: # 12/08,12/28,
1.32      harris41   37: # YEAR=2001
1.20      www        38: # 01/15/01 Gerd Kortemeyer
1.22      harris41   39: # 02/27/01 Scott Harrison
1.28      www        40: # 03/02,05/03,05/25,05/30,06/01,07/06,08/06 Gerd Kortemeyer
1.32      harris41   41: # 12/21 Scott Harrison
1.33    ! www        42: # 12/29 Gerd Kortemeyer
1.32      harris41   43: #
                     44: ###
1.22      harris41   45: 
1.1       harris41   46: package Apache::lonroles;
                     47: 
                     48: use strict;
                     49: use Apache::lonnet();
1.7       www        50: use Apache::lonuserstate();
1.1       harris41   51: use Apache::Constants qw(:common);
1.2       www        52: use Apache::File();
1.26      www        53: use Apache::lonmenu;
1.29      albertel   54: use Apache::loncommon;
1.1       harris41   55: 
                     56: sub handler {
1.10      www        57: 
1.1       harris41   58:     my $r = shift;
                     59: 
1.6       www        60:     my $now=time;
                     61:     my $then=$ENV{'user.login.time'};
                     62:     my $envkey;
                     63: 
1.10      www        64: 
1.6       www        65: # ================================================================== Roles Init
                     66: 
                     67:     if ($ENV{'form.selectrole'}) {
1.33    ! www        68: 	if ($ENV{'request.course.id'}) {
        !            69: 	    my %temp=('logout_'.$ENV{'request.course.id'} => time);
        !            70: 	    &Apache::lonnet::put('email_status',\%temp);
        !            71:         }
1.13      www        72:        &Apache::lonnet::appenv("request.course.id"  => '',
                     73:                                "request.course.fn"  => '',
                     74:                                "request.course.uri" => '',
                     75:                                "request.course.sec" => '',
                     76:                                "request.role" => 'cm'); 
                     77:         foreach $envkey (keys %ENV) {
                     78:          if ($envkey=~/^user\.role\./) {
1.6       www        79: 	    my ($dum1,$dum2,$role,@pwhere)=split(/\./,$envkey);
                     80:             my $where=join('.',@pwhere);
                     81:             my $trolecode=$role.'.'.$where;
                     82:             if ($ENV{'form.'.$trolecode}) {
                     83:                my ($tstart,$tend)=split(/\./,$ENV{$envkey});
                     84:                my $tstatus='is';
                     85:                if ($tstart) {
                     86:       		  if ($tstart>$then) { 
                     87:                      $tstatus='future';
                     88:                   }
                     89:                }
                     90:                if ($tend) {
                     91:                   if ($tend<$then) { $tstatus='expired'; }
1.19      www        92:                   if ($tend<$now) { $tstatus='will_not'; }
1.6       www        93:                }
                     94:                if ($tstatus eq 'is') {
1.13      www        95:                    $where=~s/^\///;
                     96:                    my ($cdom,$cnum,$csec)=split(/\//,$where);
                     97:                    &Apache::lonnet::appenv('request.role' => $trolecode,
1.14      www        98:                                            'request.course.sec' => $csec);
1.27      www        99:                    my $msg='Entering course ...';
1.25      www       100:                    if (($cnum) && ($role ne 'ca')) {
1.19      www       101: 		      my ($furl,$ferr)=
                    102: 			  &Apache::lonuserstate::readmap($cdom.'/'.$cnum);
1.20      www       103:                       if (($ENV{'form.orgurl'}) && 
                    104:                           ($ENV{'form.orgurl'}!~/^\/adm\/flip/)) {
1.11      www       105:                          $r->internal_redirect($ENV{'form.orgurl'});
                    106:                          return OK;
1.19      www       107: 		     } else {
1.27      www       108:                          unless ($ENV{'request.course.id'}) {
                    109:                              &Apache::lonnet::appenv(
                    110: 				 "request.course.id"  => $cdom.'_'.$cnum);
                    111:                              $furl='/adm/notfound.html';
                    112:                              $msg=
                    113: 	 '<h1><font color=red>Could not initialize top-level map.</font></h1>';
                    114:                           }
1.20      www       115: 	                 $r->content_type('text/html');
1.30      albertel  116:                          &Apache::loncommon::no_cache($r);
1.20      www       117:                          $r->send_http_header;
1.26      www       118:                          my $swinfo=&Apache::lonmenu::rawconfig;
1.20      www       119:                          print (<<ENDREDIR);
                    120: <head><title>Entering Course</title>
                    121: <meta HTTP-EQUIV="Refresh" CONTENT="1; url=$furl">
                    122: </head>
                    123: <html>
                    124: <body bgcolor="#FFFFFF">
1.26      www       125: <script>
                    126: $swinfo
                    127: </script>
1.27      www       128: $msg
1.20      www       129: </body>
                    130: </html>
                    131: ENDREDIR
                    132:                             return OK;
1.19      www       133:                      }
1.7       www       134:                    }
1.6       www       135:                }
                    136:             } 
                    137: 	  }
                    138:         }
1.20      www       139:    }
1.6       www       140:         
1.10      www       141: 
1.6       www       142: # =============================================================== No Roles Init
1.10      www       143: 
                    144:     $r->content_type('text/html');
1.30      albertel  145:     &Apache::loncommon::no_cache($r);
1.10      www       146:     $r->send_http_header;
                    147:     return OK if $r->header_only;
                    148: 
1.26      www       149:     my $swinfo=&Apache::lonmenu::rawconfig;
1.10      www       150:     $r->print(<<ENDHEADER);
                    151: <html>
                    152: <head>
                    153: <title>LON-CAPA User Roles</title>
                    154: </head><body bgcolor="#FFFFFF">
1.26      www       155: <script>
                    156: $swinfo
                    157: window.focus();
                    158: </script>
1.10      www       159: ENDHEADER
1.6       www       160: 
1.2       www       161: # ------------------------------------------ Get Error Message from Environment
                    162: 
                    163:     my ($fn,$priv,$nochoose,$error,$msg)=split(/:/,$ENV{'user.error.msg'});
1.12      www       164:     if ($ENV{'user.error.msg'}) {
                    165:        $r->log_reason(
                    166:      "$msg for $ENV{'user.name'} domain $ENV{'user.domain'} access $priv",$fn);
                    167:     }
1.1       harris41  168: 
1.6       www       169: # ---------------------------------------------------------------- Who is this?
                    170: 
                    171:     my $advanced=0;
                    172:     foreach $envkey (keys %ENV) {
                    173:         if ($envkey=~/^user\.role\./) {
                    174: 	    my ($dum1,$dum2,$role,@pwhere)=split(/\./,$envkey);
                    175:             if ($role ne 'st') { $advanced=1; }
                    176:         }
                    177:     }
                    178: 
1.2       www       179: # -------------------------------------------------------- Generate Page Output
1.6       www       180: # --------------------------------------------------------------- Error Header?
1.2       www       181:     if ($error) {
                    182: 	$r->print("<h1>LON-CAPA Access Control</h1>");
1.4       www       183:         $r->print("<hr><pre>Access  : ".
                    184:                   Apache::lonnet::plaintext($priv)."\n");
                    185:         $r->print("Resource: $fn\n");
                    186:         $r->print("Action  : $msg\n</pre><hr>");
1.2       www       187:     } else {
                    188:         $r->print("<h1>LON-CAPA User Roles</h1>");
1.25      www       189:         if ($ENV{'user.error.msg'}) {
                    190: 	    $r->print(
                    191:  '<h3><font color=red>You need to choose another user role or '.
                    192:  'enter a specific course for this function</font></h3>');
                    193: 	}
1.2       www       194:     }
1.6       www       195: # -------------------------------------------------------- Choice or no choice?
1.2       www       196:     if ($nochoose) {
1.6       www       197:         if ($advanced) {
                    198: 	   $r->print("<h2>Assigned User Roles</h2>\n");
                    199:         } else {
                    200:            $r->print("<h2>Sorry ...</h2>\nThis resource might be part of");
                    201:            if ($ENV{'request.course.id'}) {
                    202: 	       $r->print(' another');
                    203:            } else {
                    204:                $r->print(' a certain');
                    205:            } 
                    206:            $r->print(' course.</body></html>');
                    207:            return OK;
                    208:         } 
                    209:     } else {
                    210:         if ($advanced) {
                    211:            $r->print("<h2>Select a User Role</h2>\n");
                    212:         } else {
                    213: 	   $r->print("<h2>Enter a Course</h2>\n");
1.17      www       214:         }
1.18      www       215:         if (($ENV{'REDIRECT_QUERY_STRING'}) && ($fn)) {
                    216:     	    $fn.='?'.$ENV{'REDIRECT_QUERY_STRING'};
1.6       www       217:         }
1.11      www       218:         $r->print('<form method=post action="'.(($fn)?$fn:$r->uri).'">');
1.6       www       219:         $r->print('<input type=hidden name=orgurl value="'.$fn.'">');
                    220:         $r->print('<input type=hidden name=selectrole value=1>');
                    221:     }
1.27      www       222:     $r->print('<br>Show all roles: <input type=checkbox name=showall');
                    223:     if ($ENV{'form.showall'}) { $r->print(' checked'); }
                    224:     $r->print('><input type=submit value="Display"><br>');
1.6       www       225: # ----------------------------------------------------------------------- Table
                    226:     $r->print('<table><tr>');
                    227:     unless ($nochoose) { $r->print('<th>&nbsp;</th>'); }
                    228:        $r->print('<th>User Role</th><th colspan=2>Extent</th>'.
                    229:                  '<th>Start</th><th>End</th><th>Remark</th></tr>'."\n");
1.4       www       230: 
1.3       albertel  231:     foreach $envkey (sort keys %ENV) {
1.2       www       232:         if ($envkey=~/^user\.role\./) {
1.4       www       233: 	    my ($dum1,$dum2,$role,@pwhere)=split(/\./,$envkey);
                    234:             my $where=join('.',@pwhere);
1.6       www       235:             my $trolecode=$role.'.'.$where;
1.4       www       236:             my ($tstart,$tend)=split(/\./,$ENV{$envkey});
                    237:             my $tremark='';
                    238:             my $tstatus='is';
                    239:             my $tpstart='&nbsp;';
                    240:             my $tpend='&nbsp;';
                    241:             if ($tstart) {
                    242: 		if ($tstart>$then) { 
                    243:                    $tstatus='future';
                    244:                    if ($tstart<$now) { $tstatus='will'; }
                    245:                 }
                    246:                 $tpstart=localtime($tstart);
                    247:             }
                    248:             if ($tend) {
1.23      www       249:                 if ($tend<$then) { 
                    250:                    $tstatus='expired'; 
                    251:                 } elsif ($tend<$now) { 
                    252:                    $tstatus='will_not'; 
                    253:                 }
1.4       www       254:                 $tpend=localtime($tend);
                    255:             }
1.6       www       256:             if ($ENV{'request.role'} eq $trolecode) {
                    257: 		$tstatus='selected';
                    258:             }
1.4       www       259:             my $tbg;
1.27      www       260:            if (($tstatus eq 'is') || ($tstatus eq 'selected') ||
                    261:                ($ENV{'form.showall'})) {
1.4       www       262:             if ($tstatus eq 'is') {
                    263: 		$tbg='#77FF77';
                    264:             } elsif ($tstatus eq 'future') {
                    265:                 $tbg='#FFFF77';
                    266:             } elsif ($tstatus eq 'will') {
                    267:                 $tbg='#FFAA77';
1.6       www       268:                 $tremark.='Active at next login. ';
1.4       www       269:             } elsif ($tstatus eq 'expired') {
                    270:                 $tbg='#FF7777';
                    271: 	    } elsif ($tstatus eq 'will_not') {
                    272:                 $tbg='#AAFF77';
1.6       www       273:                 $tremark.='Expired after logout. ';
                    274:             } elsif ($tstatus eq 'selected') {
1.19      www       275:                 $tbg='#11CC55';
1.6       www       276:                 $tremark.='Currently selected. ';
1.4       www       277:             }
                    278:             my $trole;
                    279:             if ($role =~ /^cr\//) {
                    280: 	       my ($rdummy,$rdomain,$rauthor,$rrole)=split(/\//,$role);
                    281:                $tremark.='<br>Defined by '.$rauthor.' at '.$rdomain.'.';
                    282:                $trole=$rrole;
                    283: 	    } else {
                    284:                $trole=Apache::lonnet::plaintext($role);
                    285:             }
                    286:             my $ttype;
                    287:             my $twhere;
1.13      www       288:             my ($tdom,$trest,$tsection)=
1.8       www       289:                split(/\//,Apache::lonnet::declutter($where));
1.6       www       290:             if ($trest) {
1.24      www       291: 	      if ($role eq 'ca') {
                    292: 	        $ttype='Construction Space';
                    293:                 $twhere='User: '.$trest.'<br>Domain: '.$tdom;
                    294:                 $ENV{'course.'.$tdom.'_'.$trest.'.description'}='ca';
                    295:               } else {
1.4       www       296: 		$ttype='Course';
1.13      www       297:                 if ($tsection) {
                    298:                    $ttype.='<br>Section/Group: '.$tsection;
                    299:                 }     
1.16      www       300:                 my $tcourseid=$tdom.'_'.$trest;
                    301:                 if ($ENV{'course.'.$tcourseid.'.description'}) {
                    302: 		    $twhere=$ENV{'course.'.$tcourseid.'.description'};
1.8       www       303:                 } else {
                    304:                     my %newhash=Apache::lonnet::coursedescription($tcourseid);
                    305:                     if (%newhash) {
                    306: 			$twhere=$newhash{'description'};
                    307:                     } else {
                    308:                         $twhere='Currently not available';
1.16      www       309:                         $ENV{'course.'.$tcourseid.'.description'}=$twhere;
1.8       www       310:                     }
1.13      www       311:                 }
1.24      www       312: 	      }
1.4       www       313:             } elsif ($tdom) {
                    314:                 $ttype='Domain';
                    315:                 $twhere=$tdom;
                    316:             } else {
                    317:                 $ttype='System';
1.8       www       318:                 $twhere='system wide';
1.4       www       319:             }
                    320:                
1.6       www       321:             $r->print('<tr bgcolor='.$tbg.'>');
                    322:             unless ($nochoose) {
                    323: 		if ($tstatus eq 'is') {
                    324:                     $r->print('<td><input type=submit value=Select name="'.
1.28      www       325:                               $trolecode.'"></td>');
                    326:                 } elsif ($ENV{'user.adv'}) {
                    327:                     $r->print(
                    328:                         '<td><input type=submit value="Re-Initialize" name="'.
1.6       www       329:                               $trolecode.'"></td>');
                    330:                 } else {
                    331:                     $r->print('<td>&nbsp;</td>');
                    332:                 }
                    333:             }
                    334:             $r->print('<td>'.$trole.'</td><td>'.
1.4       www       335: 		      $ttype.'</td><td>'.$twhere.'</td><td>'.$tpstart.
                    336:                       '</td><td>'.$tpend.
                    337:                       '</td><td>'.$tremark.'&nbsp;</td></tr>'."\n");
1.27      www       338: 	}
1.4       www       339:         }
                    340:     }
1.14      www       341:     my $tremark='';
                    342:     if ($ENV{'request.role'} eq 'cm') {
1.19      www       343: 	$r->print('<tr bgcolor="#11CC55">');
1.14      www       344:         $tremark='Currently selected.';
                    345:     } else {
                    346:         $r->print('<tr bgcolor="#77FF77">');
                    347:     }
                    348:     unless ($nochoose) {
                    349:        if ($ENV{'request.role'} ne 'cm') {
                    350:           $r->print('<td><input type=submit value=Select name="cm"></td>');
                    351:        } else {
                    352:           $r->print('<td>&nbsp;</td>');
                    353:        }
                    354:     }
                    355:     $r->print('<td colspan=5>No role specified'.
                    356:                       '</td><td>'.$tremark.'&nbsp;</td></tr>'."\n");
1.4       www       357: 
                    358:     $r->print('</table>');
                    359:     unless ($nochoose) {
                    360: 	$r->print("</form>\n");
                    361:     }
1.22      harris41  362: # ------------------------------------------------------------ Privileges Info
1.6       www       363:   if ($advanced) {
1.22      harris41  364:     $r->print('<hr><h2>Current Privileges</h2>');
1.4       www       365: 
                    366:     foreach $envkey (sort keys %ENV) {
1.15      www       367:         if ($envkey=~/^user\.priv\.$ENV{'request.role'}\./) {
                    368:             my $where=$envkey;
                    369:             $where=~s/^user\.priv\.$ENV{'request.role'}\.//;
1.4       www       370:             my $ttype;
                    371:             my $twhere;
1.15      www       372:             my ($tdom,$trest,$tsec)=
1.8       www       373:                split(/\//,Apache::lonnet::declutter($where));
1.6       www       374:             if ($trest) {
1.24      www       375: 	      if ($ENV{'course.'.$tdom.'_'.$trest.'.description'} eq 'ca') {
                    376: 	        $ttype='Construction Space';
                    377:                 $twhere='User: '.$trest.', Domain: '.$tdom;
                    378:               } else {
1.4       www       379: 		$ttype='Course';
1.16      www       380:                 $twhere=$ENV{'course.'.$tdom.'_'.$trest.'.description'};
1.15      www       381:                 if ($tsec) {
                    382: 		    $twhere.=' (Section/Group: '.$tsec.')';
                    383:                 }
1.24      www       384: 	      }
1.4       www       385:             } elsif ($tdom) {
                    386:                 $ttype='Domain';
                    387:                 $twhere=$tdom;
                    388:             } else {
                    389:                 $ttype='System';
                    390:                 $twhere='/';
                    391:             }
                    392:             $r->print("\n<h3>".$ttype.': '.$twhere.'</h3><ul>');
1.32      harris41  393:             foreach (sort split(/:/,$ENV{$envkey})) {
1.4       www       394:               if ($_) {
                    395: 		  my ($prv,$restr)=split(/\&/,$_);
                    396:                   my $trestr='';
                    397:                   if ($restr ne 'F') {
                    398:                       my $i;
1.5       www       399:                       $trestr.=' (';
1.4       www       400:                       for ($i=0;$i<length($restr);$i++) {
1.5       www       401: 		         $trestr.=
                    402:                            Apache::lonnet::plaintext(substr($restr,$i,1));
                    403:                          if ($i<length($restr)-1) { $trestr.=', '; }
                    404: 		      }
                    405:                       $trestr.=')';
1.4       www       406:                   }
                    407:                   $r->print('<li>'.Apache::lonnet::plaintext($prv).$trestr.
                    408:                             '</li>');
                    409: 	      }
1.32      harris41  410:             }
1.4       www       411:             $r->print('</ul>');
1.2       www       412:         }
1.4       www       413:     }
1.6       www       414:   }
1.2       www       415: 
1.1       harris41  416:     $r->print("</body></html>\n");
                    417:     return OK;
                    418: } 
                    419: 
                    420: 1;
                    421: __END__
1.32      harris41  422: 
                    423: =head1 NAME
                    424: 
                    425: Apache::lonroles - User Roles Screen
                    426: 
                    427: =head1 SYNOPSIS
                    428: 
                    429: Invoked by /etc/httpd/conf/srm.conf:
                    430: 
                    431:  <Location /adm/roles>
                    432:  PerlAccessHandler       Apache::lonacc
                    433:  SetHandler perl-script
                    434:  PerlHandler Apache::lonroles
                    435:  ErrorDocument     403 /adm/login
                    436:  ErrorDocument	  500 /adm/errorhandler
                    437:  </Location>
                    438: 
                    439: =head1 INTRODUCTION
                    440: 
                    441: This module enables a user to select what role he wishes to
                    442: operate under (instructor, student, teaching assistant, course
                    443: coordinator, etc).  These roles are pre-established by the actions
                    444: of upper-level users.
                    445: 
                    446: This is part of the LearningOnline Network with CAPA project
                    447: described at http://www.lon-capa.org.
                    448: 
                    449: =head1 HANDLER SUBROUTINE
                    450: 
                    451: This routine is called by Apache and mod_perl.
                    452: 
                    453: =over 4
                    454: 
                    455: =item *
                    456: 
                    457: Roles Initialization (yes/no)
                    458: 
                    459: =item *
                    460: 
                    461: Get Error Message from Environment
                    462: 
                    463: =item *
                    464: 
                    465: Who is this?
                    466: 
                    467: =item *
                    468: 
                    469: Generate Page Output
                    470: 
                    471: =item *
                    472: 
                    473: Choice or no choice
                    474: 
                    475: =item *
                    476: 
                    477: Table
                    478: 
                    479: =item *
                    480: 
                    481: Privileges
                    482: 
                    483: =back
                    484: 
                    485: =cut

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