File:  [LON-CAPA] / loncom / auth / lonroles.pm
Revision 1.89: download - view: text, annotated - select for diffs
Sat May 8 14:12:16 2004 UTC (20 years, 2 months ago) by www
Branches: MAIN
CVS tags: HEAD
Continued work on key verification.

    1: # The LearningOnline Network with CAPA
    2: # User Roles Screen
    3: #
    4: # $Id: lonroles.pm,v 1.89 2004/05/08 14:12:16 www Exp $
    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: #
   28: ###
   29: 
   30: package Apache::lonroles;
   31: 
   32: use strict;
   33: use Apache::lonnet();
   34: use Apache::lonuserstate();
   35: use Apache::Constants qw(:common);
   36: use Apache::File();
   37: use Apache::lonmenu;
   38: use Apache::loncommon;
   39: use Apache::lonannounce;
   40: use Apache::lonlocal;
   41: 
   42: sub redirect_user {
   43:     my ($r,$title,$url,$msg) = @_;
   44:     $msg = $title if (! defined($msg));
   45:     &Apache::loncommon::content_type($r,'text/html');
   46:     &Apache::loncommon::no_cache($r);
   47:     $r->send_http_header;
   48:     my $swinfo=&Apache::lonmenu::rawconfig();
   49:     my $bodytag=&Apache::loncommon::bodytag('Switching Role');
   50:     $r->print (<<ENDREDIR);
   51: <head><title>$title</title>
   52: <meta HTTP-EQUIV="Refresh" CONTENT="1; url=$url">
   53: </head>
   54: <html>
   55: $bodytag
   56: <script>
   57: $swinfo
   58: </script>
   59: <h1>$msg</h1>
   60: </body>
   61: </html>
   62: ENDREDIR
   63:     return;
   64: }
   65: 
   66: sub handler {
   67: 
   68:     my $r = shift;
   69: 
   70:     my $now=time;
   71:     my $then=$ENV{'user.login.time'};
   72:     my $envkey;
   73: 
   74: 
   75: # ================================================================== Roles Init
   76: 
   77:     if ($ENV{'form.selectrole'}) {
   78: 	if ($ENV{'request.course.id'}) {
   79: 	    my %temp=('logout_'.$ENV{'request.course.id'} => time);
   80: 	    &Apache::lonnet::put('email_status',\%temp);
   81:         }
   82: 	&Apache::lonnet::appenv("request.course.id"   => '',
   83: 				"request.course.fn"   => '',
   84: 				"request.course.uri"  => '',
   85: 				"request.course.sec"  => '',
   86: 				"request.role"        => 'cm',
   87:                                 "request.role.adv"    => $ENV{'user.adv'},
   88: 				"request.role.domain" => $ENV{'user.domain'});
   89:         foreach $envkey (keys %ENV) {
   90:             next if ($envkey!~/^user\.role\./);
   91: 	    my (undef,undef,$role,@pwhere)=split(/\./,$envkey);
   92:             my $where=join('.',@pwhere);
   93:             my $trolecode=$role.'.'.$where;
   94:             if ($ENV{'form.'.$trolecode}) {
   95: 		my ($tstart,$tend)=split(/\./,$ENV{$envkey});
   96: 		my $tstatus='is';
   97: 		if ($tstart) {
   98: 		    if ($tstart>$then) { 
   99: 			$tstatus='future';
  100: 		    }
  101: 		}
  102: 		if ($tend) {
  103: 		    if ($tend<$then) { $tstatus='expired'; }
  104: 		    if ($tend<$now) { $tstatus='will_not'; }
  105: 		}
  106: 		if ($tstatus eq 'is') {
  107: 		    $where=~s/^\///;
  108: 		    my ($cdom,$cnum,$csec)=split(/\//,$where);
  109: # check for keyed access
  110: 		    if (($role eq 'st') && 
  111:                        ($ENV{'course.'.$cdom.'_'.$cnum.'.keyaccess'} eq 'yes')) {
  112: # who is key authority?
  113: 			my $authdom=$cdom;
  114: 			my $authnum=$cnum;
  115: 			if ($ENV{'course.'.$cdom.'_'.$cnum.'.keyauth'}) {
  116: 			    ($authnum,$authdom)=
  117: 				split(/\W/,$ENV{'course.'.$cdom.'_'.$cnum.'.keyauth'});
  118: 			}
  119: # check with key authority
  120: 			unless (&Apache::lonnet::validate_access_key(
  121: 				     $ENV{'environment.key.'.$cdom.'_'.$cnum},
  122: 					     $authdom,$authnum)) {
  123: # there is no valid key
  124: 			     if ($ENV{'form.newkey'}) {
  125: # student attempts to register a new key
  126: 				 &Apache::loncommon::content_type($r,'text/html');
  127: 				 &Apache::loncommon::no_cache($r);
  128: 				 $r->send_http_header;
  129: 				 my $swinfo=&Apache::lonmenu::rawconfig();
  130: 				 my $bodytag=&Apache::loncommon::bodytag
  131: 				    ('Verifying Access Key to Unlock this Course');
  132: 				 my $buttontext=&mt('Re-Enter Key');
  133: 				 my $message=&mt('Key Verification Failed').'<br /><a href="/adm/logout">'.
  134: 				     &mt('Logout').'</a>';
  135: 				 $r->print(<<ENDENTEREDKEY);
  136: <head><title>Verifying Course Access Key</title>
  137: </head>
  138: <html>
  139: $bodytag
  140: <script>
  141: $swinfo
  142: </script>
  143: <form method="post">
  144: <input type="hidden" name="selectrole" value="1" />
  145: <input type="hidden" name="$trolecode" value="1" />
  146: $message
  147: <input type="submit" value="$buttontext" />
  148: </form>
  149: </body></html>
  150: ENDENTEREDKEY
  151:                                  return OK;
  152: 			     } else {
  153: # print form to enter a new key
  154: 				 &Apache::loncommon::content_type($r,'text/html');
  155: 				 &Apache::loncommon::no_cache($r);
  156: 				 $r->send_http_header;
  157: 				 my $swinfo=&Apache::lonmenu::rawconfig();
  158: 				 my $bodytag=&Apache::loncommon::bodytag
  159: 				    ('Enter Access Key to Unlock this Course');
  160: 				 $r->print(<<ENDENTERKEY);
  161: <head><title>Entering Course Access Key</title>
  162: </head>
  163: <html>
  164: $bodytag
  165: <script>
  166: $swinfo
  167: </script>
  168: <form method="post">
  169: <input type="hidden" name="selectrole" value="1" />
  170: <input type="hidden" name="$trolecode" value="1" />
  171: <input type="text" size="20" name="newkey" value="$ENV{'form.newkey'}" />
  172: <input type="submit" value="Enter key" />
  173: </form>
  174: </body></html>
  175: ENDENTERKEY
  176: 				 return OK;
  177: 			     }
  178: 			 }
  179: 		     }
  180: 		    &Apache::lonnet::log($ENV{'user.domain'},
  181: 					 $ENV{'user.name'},
  182: 					 $ENV{'user.home'},
  183: 					 "Role ".$trolecode);
  184:                     my $tadv=0;
  185:                     if (($trolecode!~/^st/) && 
  186:                         ($trolecode!~/^ta/) && 
  187:                         ($trolecode!~/^cm/)) { $tadv=1; }
  188: 		    &Apache::lonnet::appenv(
  189:                                            'request.role'        => $trolecode,
  190: 					   'request.role.adv'    => $tadv,
  191: 					   'request.role.domain' => $cdom,
  192: 					   'request.course.sec'  => $csec);
  193: 		    my $msg=&mt('Entering course ...');
  194: 
  195: 		    if (($cnum) && ($role ne 'ca')) {
  196: 			my ($furl,$ferr)=
  197: 			    &Apache::lonuserstate::readmap($cdom.'/'.$cnum);
  198: 			if (($ENV{'form.orgurl'}) && 
  199: 			    ($ENV{'form.orgurl'}!~/^\/adm\/flip/)) {
  200: 			    my $dest=$ENV{'form.orgurl'};
  201: 			    if ( &Apache::lonnet::mod_perl_version() == 2 ) {
  202: 				&Apache::lonnet::cleanenv();
  203: 			    }
  204: 			    $r->internal_redirect($dest);
  205: 			    return OK;
  206: 			} else {
  207: 			    unless ($ENV{'request.course.id'}) {
  208: 				&Apache::lonnet::appenv(
  209: 				      "request.course.id"  => $cdom.'_'.$cnum);
  210: 				$furl='/adm/roles?tryagain=1';
  211: 				$msg=
  212: 				    '<h1><font color=red>'.
  213: 			 &mt('Could not initialize course at this time.').
  214: 		    '</font></h1><h3>'.&mt('Please try again.').'</h3>'.$ferr;
  215: 			    }
  216: 
  217: 			    # Check to see if the user is a CC entering a course 
  218: 			    # for the first time
  219: 			    my (undef, undef, $role, $courseid) = split(/\./, $envkey);
  220: 			    if (substr($courseid, 0, 1) eq '/') {
  221: 				$courseid = substr($courseid, 1);
  222: 			    }
  223: 			    $courseid =~ s/\//_/;
  224: 			    if ($role eq 'cc' && $ENV{'course.' . $courseid . 
  225: 							  '.course.helper.not.run'}) {
  226: 				$furl = "/adm/helper/course.initialization.helper";
  227: 			    }
  228:                             #
  229:                             # Send the user to the course they selected
  230:                             &redirect_user($r,&mt('Entering Course'),
  231:                                            $furl,$msg);
  232:                             return OK;
  233: 			}
  234: 		    }
  235:                     #
  236:                     # Send the user to the construction space they selected
  237:                     if ($role =~ /^(au|ca)$/) {
  238:                         my $redirect_url = '/priv/';
  239:                         if ($role eq 'au') {
  240:                             $redirect_url.=$ENV{'user.name'};
  241:                         } else {
  242:                             $where =~ /\/(.*)$/;
  243:                             $redirect_url .= $1;
  244:                         }
  245:                         $redirect_url .= '/';
  246:                         &redirect_user($r,&mt('Entering Construction Space'),
  247:                                        $redirect_url);
  248:                         return OK;
  249:                     }
  250: 		}
  251:             }
  252:         }
  253:     }
  254: 
  255: 
  256: # =============================================================== No Roles Init
  257: 
  258:     &Apache::loncommon::content_type($r,'text/html');
  259:     &Apache::loncommon::no_cache($r);
  260:     $r->send_http_header;
  261:     return OK if $r->header_only;
  262: 
  263:     my $swinfo=&Apache::lonmenu::rawconfig();
  264:     my $bodytag=&Apache::loncommon::bodytag('User Roles');
  265:     my $helptag='<table><tr><td>'.&Apache::loncommon::help_open_topic
  266:      ("General_Intro",&mt("Click here for help")).'</td><td>'.
  267:       &Apache::loncommon::help_open_faq(1,&mt('Click here for FAQ')).'</td><td>'.
  268:       &Apache::loncommon::help_open_bug('',&mt('Click here to report bugs')).'</td></tr></table>';
  269:     $r->print(<<ENDHEADER);
  270: <html>
  271: <head>
  272: <title>LON-CAPA User Roles</title>
  273: </head>
  274: $bodytag
  275: $helptag<br />
  276: <script>
  277: $swinfo
  278: window.focus();
  279: </script>
  280: ENDHEADER
  281: 
  282: # ------------------------------------------ Get Error Message from Environment
  283: 
  284:     my ($fn,$priv,$nochoose,$error,$msg)=split(/:/,$ENV{'user.error.msg'});
  285:     if ($ENV{'user.error.msg'}) {
  286: 	$r->log_reason(
  287:    "$msg for $ENV{'user.name'} domain $ENV{'user.domain'} access $priv",$fn);
  288:     }
  289: 
  290: # ------------------------------------------------- Can this user re-init, etc?
  291: 
  292:     my $advanced=$ENV{'user.adv'};
  293:     &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},['tryagain']);
  294:     my $tryagain=$ENV{'form.tryagain'};
  295: 
  296: # -------------------------------------------------------- Generate Page Output
  297: # --------------------------------------------------------------- Error Header?
  298:     if ($error) {
  299: 	$r->print("<h1>LON-CAPA Access Control</h1>");
  300:         $r->print("<hr><pre>Access  : ".
  301:                   Apache::lonnet::plaintext($priv)."\n");
  302:         $r->print("Resource: $fn\n");
  303:         $r->print("Action  : $msg\n</pre><hr>");
  304:     } else {
  305:         if ($ENV{'user.error.msg'}) {
  306: 	    $r->print(
  307:  '<h3><font color=red>'.
  308:  &mt('You need to choose another user role or enter a specific course for this function').'</font></h3>');
  309: 	}
  310:     }
  311: # -------------------------------------------------------- Choice or no choice?
  312:     if ($nochoose) {
  313:         if ($advanced) {
  314: 	    $r->print("<h2>".&mt('Assigned User Roles')."</h2>\n");
  315:         } else {
  316: 	    $r->print("<h2>".&mt('Sorry ...')."</h2>\n".
  317: 		      &mt('This resource might be part of'));
  318: 	    if ($ENV{'request.course.id'}) {
  319: 		$r->print(&mt(' another'));
  320: 	    } else {
  321: 		$r->print(&mt(' a certain'));
  322: 	    } 
  323: 	    $r->print(&mt(' course.').'</body></html>');
  324: 	    return OK;
  325:         } 
  326:     } else {
  327:         if ($advanced) {
  328: 	    $r->print(&mt("Your home server is ").
  329: 		      $Apache::lonnet::hostname{&Apache::lonnet::homeserver
  330:                       ($ENV{'user.name'},$ENV{'user.domain'})}.
  331: 		      "<br />\n");
  332: 	    $r->print(&mt(
  333:       "Author and Co-Author roles may not be available on servers other than your home server."));
  334:         }
  335:         if (($ENV{'REDIRECT_QUERY_STRING'}) && ($fn)) {
  336:     	    $fn.='?'.$ENV{'REDIRECT_QUERY_STRING'};
  337:         }
  338:         $r->print('<form method="post" name="rolechoice" action="'.(($fn)?$fn:$r->uri).'">');
  339:         $r->print('<input type=hidden name=orgurl value="'.$fn.'">');
  340:         $r->print('<input type=hidden name=selectrole value=1>');
  341:     }
  342:     if ($ENV{'user.adv'}) {
  343: 	$r->print(
  344: 	      '<br />'.&mt('Show all roles').': <input type="checkbox" name="showall"');
  345: 	if ($ENV{'form.showall'}) { $r->print(' checked'); }
  346: 	$r->print('><input type=submit value="'.&mt('Display').'">');
  347:     }
  348: 
  349:     my (%roletext,%sortrole,%roleclass);
  350:     my $countactive=0;
  351:     my $inrole=0;
  352:     my $possiblerole='';
  353:     foreach $envkey (sort keys %ENV) {
  354:         my $button = 1;
  355:         my $switchserver='';
  356: 	my $roletext;
  357: 	my $sortkey;
  358:         if ($envkey=~/^user\.role\./) {
  359: 	    my (undef,undef,$role,@pwhere)=split(/\./,$envkey);
  360:             next if (!defined($role) || $role eq '');
  361:             my $where=join('.',@pwhere);
  362:             my $trolecode=$role.'.'.$where;
  363:             my ($tstart,$tend)=split(/\./,$ENV{$envkey});
  364:             my $tremark='';
  365:             my $tstatus='is';
  366:             my $tpstart='&nbsp;';
  367:             my $tpend='&nbsp;';
  368:             my $tfont='#000000';
  369:             if ($tstart) {
  370: 		if ($tstart>$then) { 
  371:                     $tstatus='future';
  372:                     if ($tstart<$now) { $tstatus='will'; }
  373:                 }
  374:                 $tpstart=&Apache::lonlocal::locallocaltime($tstart);
  375:             }
  376:             if ($tend) {
  377:                 if ($tend<$then) { 
  378:                     $tstatus='expired'; 
  379:                 } elsif ($tend<$now) { 
  380:                     $tstatus='will_not'; 
  381:                 }
  382:                 $tpend=&Apache::lonlocal::locallocaltime($tend);
  383:             }
  384:             if ($ENV{'request.role'} eq $trolecode) {
  385: 		$tstatus='selected';
  386:             }
  387:             my $tbg;
  388:             if (($tstatus eq 'is') || ($tstatus eq 'selected') ||
  389:                 ($ENV{'form.showall'})) {
  390:                 if ($tstatus eq 'is') {
  391:                     $tbg='#77FF77';
  392:                     $tfont='#003300';
  393: 		    $possiblerole=$trolecode;
  394: 		    $countactive++;
  395:                 } elsif ($tstatus eq 'future') {
  396:                     $tbg='#FFFF77';
  397:                     $button=0;
  398:                 } elsif ($tstatus eq 'will') {
  399:                     $tbg='#FFAA77';
  400:                     $tremark.=&mt('Active at next login. ');
  401:                 } elsif ($tstatus eq 'expired') {
  402:                     $tbg='#FF7777';
  403:                     $tfont='#330000';
  404:                     $button=0;
  405:                 } elsif ($tstatus eq 'will_not') {
  406:                     $tbg='#AAFF77';
  407:                     $tremark.=&mt('Expired after logout. ');
  408:                 } elsif ($tstatus eq 'selected') {
  409:                     $tbg='#11CC55';
  410:                     $tfont='#002200';
  411: 		    $inrole=1;
  412: 		    $countactive++;
  413:                     $tremark.=&mt('Currently selected. ');
  414:                 }
  415:                 my $trole;
  416:                 if ($role =~ /^cr\//) {
  417:                     my ($rdummy,$rdomain,$rauthor,$rrole)=split(/\//,$role);
  418:                     $tremark.='<br>'.&mt('Defined by ').$rauthor.
  419: 			&mt(' at ').$rdomain.'.';
  420:                     $trole=$rrole;
  421:                 } else {
  422:                     $trole=Apache::lonnet::plaintext($role);
  423:                 }
  424:                 my $ttype;
  425:                 my $twhere;
  426:                 my ($tdom,$trest,$tsection)=
  427:                     split(/\//,Apache::lonnet::declutter($where));
  428:                 # First, Co-Authorship roles
  429:                 if ($role eq 'ca') {
  430:                     my $home = &Apache::lonnet::homeserver($trest,$tdom);
  431: 		    my $allowed=0;
  432: 		    my @ids=&Apache::lonnet::current_machine_ids();
  433: 		    foreach my $id (@ids) { if ($id eq $home) { $allowed=1; } }
  434:                     if (!$allowed) {
  435: 			$button=0;
  436:                         $switchserver=&Apache::lonnet::escape('http://'.
  437:                          $Apache::lonnet::hostname{$home}.
  438:                          '/adm/login?domain='.$ENV{'user.domain'}.
  439: 			  '&username='.$ENV{'user.name'}.
  440:                           '&firsturl=/priv/'.$trest);
  441:                     }
  442:                     #next if ($home eq 'no_host');
  443:                     $home = $Apache::lonnet::hostname{$home};
  444:                     $ttype='Construction Space';
  445:                     $twhere=&mt('User').': '.$trest.'<br />'.&mt('Domain').
  446: 			': '.$tdom.'<br />'.
  447:                         ' '.&mt('Server').':&nbsp;'.$home;
  448:                     $ENV{'course.'.$tdom.'_'.$trest.'.description'}='ca';
  449: 		    $tremark.=&Apache::lonhtmlcommon::authorbombs('/res/'.$tdom.'/'.$trest.'/');
  450: 		    $sortkey=$role."$trest:$tdom";
  451:                 } elsif ($role eq 'au') {
  452:                     # Authors
  453:                     my $home = &Apache::lonnet::homeserver
  454:                         ($ENV{'user.name'},$ENV{'user.domain'});
  455: 		    my $allowed=0;
  456: 		    my @ids=&Apache::lonnet::current_machine_ids();
  457: 		    foreach my $id (@ids) { if ($id eq $home) { $allowed=1; } }
  458:                     if (!$allowed) {
  459: 			$button=0;
  460:                         $switchserver=&Apache::lonnet::escape('http://'.
  461:                          $Apache::lonnet::hostname{$home}.
  462:                           '/adm/login?domain='.$ENV{'user.domain'}.
  463: 			   '&username='.$ENV{'user.name'}.
  464:                            '&firsturl=/priv/'.$ENV{'user.name'});
  465:                     }
  466:                     #next if ($home eq 'no_host');
  467:                     $home = $Apache::lonnet::hostname{$home};
  468:                     $ttype='Construction Space';
  469:                     $twhere=&mt('Domain').': '.$tdom.'<br />'.&mt('Server').
  470: 			':&nbsp;'.$home;
  471:                     $ENV{'course.'.$tdom.'_'.$trest.'.description'}='ca';
  472: 		    $tremark.=&Apache::lonhtmlcommon::authorbombs('/res/'.$tdom.'/'.$ENV{'user.name'}.'/');
  473: 		    $sortkey=$role;
  474:                 } elsif ($trest) {
  475:                     $ttype='Course';
  476:                     if ($tsection) {
  477:                         $ttype.='<br>'.&mt('Section/Group').': '.$tsection;
  478: 		    }
  479:                     my $tcourseid=$tdom.'_'.$trest;
  480:                     if ($ENV{'course.'.$tcourseid.'.description'}) {
  481:                         $twhere=$ENV{'course.'.$tcourseid.'.description'};
  482: 			$sortkey=$role."\0".$tdom."\0".$twhere."\0".$envkey;
  483:                         unless ($twhere eq &mt('Currently not available')) {
  484: 			    $twhere.=' <font size="-2">'.
  485:         &Apache::loncommon::syllabuswrapper(&mt('Syllabus'),$trest,$tdom,$tfont).
  486:                                     '</font>';
  487: 			}
  488:                     } else {
  489:                         my %newhash=Apache::lonnet::coursedescription
  490:                             ($tcourseid);
  491:                         if (%newhash) {
  492: 			    $sortkey=$role."\0".$tdom."\0".$newhash{'description'}.
  493: 				"\0".$envkey;
  494:                             $twhere=$newhash{'description'}.
  495:                               ' <font size="-2">'.
  496:         &Apache::loncommon::syllabuswrapper(&mt('Syllabus'),$trest,$tdom,$tfont).
  497:                               '</font>';
  498:                         } else {
  499:                             $twhere=&mt('Currently not available');
  500:                             $ENV{'course.'.$tcourseid.'.description'}=$twhere;
  501: 			    $sortkey=$role."\0".$tdom."\0".$twhere."\0".$envkey;
  502:                         }
  503:                     }
  504: 		    if ($role ne 'st') { $twhere.="<br />".&mt('Domain').":".$tdom; }
  505:                 } elsif ($tdom) {
  506:                     $ttype='Domain';
  507:                     $twhere=$tdom;
  508: 		    $sortkey=$role.$twhere;
  509:                 } else {
  510:                     $ttype='System';
  511:                     $twhere=&mt('system wide');
  512: 		    $sortkey=$role.$twhere;
  513:                 }
  514:  
  515:                 $roletext.='<tr bgcolor='.$tbg.'>';
  516:                 unless ($nochoose) {
  517:                     if (!$button) {
  518: 			if ($switchserver) {
  519: 			    $roletext.='<td><a href="/adm/logout?handover='.
  520:                               $switchserver.'">'.&mt('Switch Server').'</a></td>';
  521:                         } else {
  522:                             $roletext.=('<td>&nbsp;</td>');
  523:                         }
  524:                     } elsif ($tstatus eq 'is') {
  525:                         $roletext.=('<td><input type=submit value="'.
  526: 				  &mt('Select').'" name="'.
  527:                                   $trolecode.'"></td>');
  528:                     } elsif ($tryagain) {
  529:                         $roletext.=
  530: 			    '<td><input type=submit value="'.
  531: 		  &mt('Try Selecting Again').'" name="'.$trolecode.'"></td>';
  532:                     } elsif ($advanced) {
  533:                         $roletext.=
  534:                             '<td><input type=submit value="'.
  535: 		        &mt('Re-Initialize').'" name="'.$trolecode.'"></td>';
  536:                     } else {
  537:                         $roletext.='<td>&nbsp;</td>';
  538:                     }
  539:                 }
  540:                 $tremark.=&Apache::lonannounce::showday(time,1,
  541:                          &Apache::lonannounce::readcalendar($tdom.'_'.$trest));
  542:                 
  543: 		$roletext.='<td><font color="'.$tfont.'">'.$trole.
  544:                       '</font></td><td><font color="'.$tfont.'">'.$ttype.
  545:                       '</font></td><td><font color="'.$tfont.'">'.$twhere.
  546:                       '</font></td><td><font color="'.$tfont.'">'.$tpstart.
  547:                       '</font></td><td><font color="'.$tfont.'">'.$tpend.
  548:                       '</font></td><td><font color="'.$tfont.'">'.$tremark.
  549:                       '&nbsp;</font></td></tr>'."\n";
  550: 		$roletext{$envkey}=$roletext;
  551: 		if (!$sortkey) {$sortkey=$twhere."\0".$envkey;}
  552: 		$sortrole{$sortkey}=$envkey;
  553: 		$roleclass{$envkey}=$ttype;
  554: 	    }
  555:         }
  556:     }
  557: # No active roles
  558:     if ($countactive==0) {
  559: 	if ($inrole) {
  560: 	    $r->print('<h2>'.&mt('Currently no additional roles or courses').'</h2>');
  561: 	} else {
  562: 	    $r->print('<h2>'.&mt('Currently no active roles or courses').'</h2>');
  563: 	}
  564: 	$r->print('</form></body></html>');
  565: 	return OK;
  566: # Is there only one choice?
  567:     } elsif (($countactive==1) && ($ENV{'request.role'} eq 'cm')) {
  568: 	$r->print('<h3>'.&mt('Please stand by.').'</h3>'.
  569: 	    '<input type="hidden" name="'.$possiblerole.'" value="1" />');
  570: 	$r->print("</form>\n");
  571: 	$r->rflush();
  572: 	$r->print('<script>document.forms.rolechoice.submit();</script>');
  573: 	$r->print('</body></html>');
  574: 	return OK;
  575:     }
  576: # More than one possible role
  577: # ----------------------------------------------------------------------- Table
  578:     unless (($advanced) || ($nochoose)) {
  579: 	$r->print("<h2>".&mt('Select a Course to Enter')."</h2>\n");
  580:     }
  581:     $r->print('<br /><table><tr>');
  582:     unless ($nochoose) { $r->print('<th>&nbsp;</th>'); }
  583:     $r->print('<th>'.&mt('User Role').'</th><th colspan=2>'.&mt('Extent').
  584:          '</th><th>'.&mt('Start').'</th><th>'.&mt('End').'</th><th>'.
  585: 	      &mt('Remark').'</th></tr>'."\n");
  586:     my $doheaders=-1;
  587:     foreach my $type ('Construction Space','Course','Domain','System') {
  588: 	my $haverole=0;
  589: 	foreach my $which (sort {uc($a) cmp uc($b)} (keys(%sortrole))) {
  590: 	    if ($roleclass{$sortrole{$which}} =~ /^\Q$type\E/) { 
  591: 		$haverole=1;
  592: 	    }
  593: 	}
  594: 	if ($haverole) { $doheaders++; }
  595:     }
  596:     foreach my $type ('Construction Space','Course','Domain','System') {
  597: 	my $output;
  598: 	foreach my $which (sort {uc($a) cmp uc($b)} (keys(%sortrole))) {
  599: 	    if ($roleclass{$sortrole{$which}} =~ /^\Q$type\E/) { 
  600: 		$output.=&mt($roletext{$sortrole{$which}});
  601: 	    }
  602: 	}
  603: 	if ($output) {
  604: 	    if ($doheaders > 0) {
  605: 		$r->print("<tr bgcolor='#BBffBB'>".
  606: 			  "<td align='center' colspan='7'>".&mt($type)."</td>");
  607: 	    }
  608: 	    $r->print($output);	    
  609: 	}
  610:     }
  611:     my $tremark='';
  612:     my $tfont='#003300';
  613:     if ($ENV{'request.role'} eq 'cm') {
  614: 	$r->print('<tr bgcolor="#11CC55">');
  615:         $tremark=&mt('Currently selected. ');
  616:         $tfont='#002200';
  617:     } else {
  618:         $r->print('<tr bgcolor="#77FF77">');
  619:     }
  620:     unless ($nochoose) {
  621: 	if ($ENV{'request.role'} ne 'cm') {
  622: 	    $r->print('<td><input type=submit value="'.
  623: 		      &mt('Select').'" name="cm"></td>');
  624: 	} else {
  625: 	    $r->print('<td>&nbsp;</td>');
  626: 	}
  627:     }
  628:     $r->print('<td colspan=5><font color="'.$tfont.'">'.&mt('No role specified').
  629:       '</font></td><td><font color="'.$tfont.'">'.$tremark.
  630:       '&nbsp;</font></td></tr>'."\n");
  631: 
  632:     $r->print('</table>');
  633:     unless ($nochoose) {
  634: 	$r->print("</form>\n");
  635:     }
  636: # ------------------------------------------------------------ Privileges Info
  637:     if (($advanced) && (($ENV{'user.error.msg'}) || ($error))) {
  638: 	$r->print('<hr><h2>Current Privileges</h2>');
  639: 
  640: 	foreach $envkey (sort keys %ENV) {
  641: 	    if ($envkey=~/^user\.priv\.$ENV{'request.role'}\./) {
  642: 		my $where=$envkey;
  643: 		$where=~s/^user\.priv\.$ENV{'request.role'}\.//;
  644: 		my $ttype;
  645: 		my $twhere;
  646: 		my ($tdom,$trest,$tsec)=
  647: 		    split(/\//,Apache::lonnet::declutter($where));
  648: 		if ($trest) {
  649: 		    if ($ENV{'course.'.$tdom.'_'.$trest.'.description'} eq 'ca') {
  650: 			$ttype='Construction Space';
  651: 			$twhere='User: '.$trest.', Domain: '.$tdom;
  652: 		    } else {
  653: 			$ttype='Course';
  654: 			$twhere=$ENV{'course.'.$tdom.'_'.$trest.'.description'};
  655: 			if ($tsec) {
  656: 			    $twhere.=' (Section/Group: '.$tsec.')';
  657: 			}
  658: 		    }
  659: 		} elsif ($tdom) {
  660: 		    $ttype='Domain';
  661: 		    $twhere=$tdom;
  662: 		} else {
  663: 		    $ttype='System';
  664: 		    $twhere='/';
  665: 		}
  666: 		$r->print("\n<h3>".$ttype.': '.$twhere.'</h3><ul>');
  667: 		foreach (sort split(/:/,$ENV{$envkey})) {
  668: 		    if ($_) {
  669: 			my ($prv,$restr)=split(/\&/,$_);
  670: 			my $trestr='';
  671: 			if ($restr ne 'F') {
  672: 			    my $i;
  673: 			    $trestr.=' (';
  674: 			    for ($i=0;$i<length($restr);$i++) {
  675: 				$trestr.=
  676: 			       Apache::lonnet::plaintext(substr($restr,$i,1));
  677: 				if ($i<length($restr)-1) { $trestr.=', '; }
  678: 			    }
  679: 			    $trestr.=')';
  680: 			}
  681: 			$r->print('<li>'.
  682: 				  Apache::lonnet::plaintext($prv).$trestr.
  683: 				  '</li>');
  684: 		    }
  685: 		}
  686: 		$r->print('</ul>');
  687: 	    }
  688: 	}
  689:     }
  690:     $r->print(&Apache::lonnet::getannounce());
  691:     if ($advanced) {
  692: 	$r->print('<p><small><i>This is LON-CAPA '.
  693: 		  $r->dir_config('lonVersion').'</i><br />'.
  694: 		  '<a href="/adm/logout">'.&mt('Logout').'</a></small></p>');
  695:     }
  696:     $r->print("</body></html>\n");
  697:     return OK;
  698: } 
  699: 
  700: 1;
  701: __END__
  702: 
  703: =head1 NAME
  704: 
  705: Apache::lonroles - User Roles Screen
  706: 
  707: =head1 SYNOPSIS
  708: 
  709: Invoked by /etc/httpd/conf/srm.conf:
  710: 
  711:  <Location /adm/roles>
  712:  PerlAccessHandler       Apache::lonacc
  713:  SetHandler perl-script
  714:  PerlHandler Apache::lonroles
  715:  ErrorDocument     403 /adm/login
  716:  ErrorDocument	  500 /adm/errorhandler
  717:  </Location>
  718: 
  719: =head1 OVERVIEW
  720: 
  721: =head2 Choosing Roles
  722: 
  723: C<lonroles> is a handler that allows a user to switch roles in
  724: mid-session. LON-CAPA attempts to work with "No Role Specified", the
  725: default role that a user has before selecting a role, as widely as
  726: possible, but certain handlers for example need specification which
  727: course they should act on, etc. Both in this scenario, and when the
  728: handler determines via C<lonnet>'s C<&allowed> function that a certain
  729: action is not allowed, C<lonroles> is used as error handler. This
  730: allows the user to select another role which may have permission to do
  731: what they were trying to do. C<lonroles> can also be accessed via the
  732: B<CRS> button in the Remote Control. 
  733: 
  734: =begin latex
  735: 
  736: \begin{figure}
  737: \begin{center}
  738: \includegraphics[width=0.45\paperwidth,keepaspectratio]{Sample_Roles_Screen}
  739:   \caption{\label{Sample_Roles_Screen}Sample Roles Screen} 
  740: \end{center}
  741: \end{figure}
  742: 
  743: =end latex
  744: 
  745: =head2 Role Initialization
  746: 
  747: 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.
  748: 
  749: =head1 INTRODUCTION
  750: 
  751: This module enables a user to select what role he wishes to
  752: operate under (instructor, student, teaching assistant, course
  753: coordinator, etc).  These roles are pre-established by the actions
  754: of upper-level users.
  755: 
  756: This is part of the LearningOnline Network with CAPA project
  757: described at http://www.lon-capa.org.
  758: 
  759: =head1 HANDLER SUBROUTINE
  760: 
  761: This routine is called by Apache and mod_perl.
  762: 
  763: =over 4
  764: 
  765: =item *
  766: 
  767: Roles Initialization (yes/no)
  768: 
  769: =item *
  770: 
  771: Get Error Message from Environment
  772: 
  773: =item *
  774: 
  775: Who is this?
  776: 
  777: =item *
  778: 
  779: Generate Page Output
  780: 
  781: =item *
  782: 
  783: Choice or no choice
  784: 
  785: =item *
  786: 
  787: Table
  788: 
  789: =item *
  790: 
  791: Privileges
  792: 
  793: =back
  794: 
  795: =cut

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