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

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

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