File:  [LON-CAPA] / loncom / auth / lonroles.pm
Revision 1.209: download - view: text, annotated - select for diffs
Mon Oct 20 03:25:48 2008 UTC (15 years, 7 months ago) by raeburn
Branches: MAIN
CVS tags: version_2_8_X, version_2_7_99_0, HEAD, GCI_1
- "Re-initialize" button in roles screen no longer restricted to advanced users.
- Show appropriate message on roles screen when navmap object could not be created because inactivity caused deletion of $user_$course.db and/or $user_$course_params.db from lonDaemns/tmp directory.

    1: # The LearningOnline Network with CAPA
    2: # User Roles Screen
    3: #
    4: # $Id: lonroles.pm,v 1.209 2008/10/20 03:25:48 raeburn 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::lonhtmlcommon;
   40: use Apache::lonannounce;
   41: use Apache::lonlocal;
   42: use Apache::lonpageflip();
   43: use Apache::lonnavdisplay();
   44: use GDBM_File;
   45: use LONCAPA qw(:DEFAULT :match);
   46: use HTML::Entities;
   47:  
   48: 
   49: sub redirect_user {
   50:     my ($r,$title,$url,$msg,$launch_nav) = @_;
   51:     $msg = $title if (! defined($msg));
   52:     &Apache::loncommon::content_type($r,'text/html');
   53:     &Apache::loncommon::no_cache($r);
   54:     $r->send_http_header;
   55:     my $swinfo=&Apache::lonmenu::rawconfig();
   56:     my $navwindow;
   57:     if ($launch_nav eq 'on') {
   58: 	$navwindow.=&Apache::lonnavdisplay::launch_win('now',undef,undef,
   59: 						       ($url =~ m-^/adm/whatsnew-));
   60:     } else {
   61: 	$navwindow.=&Apache::lonnavmaps::close();
   62:     }
   63:     my $start_page = &Apache::loncommon::start_page('Switching Role',undef,
   64: 						    {'redirect' => [1,$url],});
   65:     my $end_page   = &Apache::loncommon::end_page();
   66: 
   67: # Note to style police: 
   68: # This must only replace the spaces, nothing else, or it bombs elsewhere.
   69:     $url=~s/ /\%20/g;
   70:     $r->print(<<ENDREDIR);
   71: $start_page
   72: <script type="text/javascript">
   73: $swinfo
   74: </script>
   75: $navwindow
   76: <h1>$msg</h1>
   77: $end_page
   78: ENDREDIR
   79:     return;
   80: }
   81: 
   82: sub error_page {
   83:     my ($r,$error,$dest)=@_;
   84:     &Apache::loncommon::content_type($r,'text/html');
   85:     &Apache::loncommon::no_cache($r);
   86:     $r->send_http_header;
   87:     return OK if $r->header_only;
   88:     $r->print(&Apache::loncommon::start_page('Problems during Course Initialization').
   89: 	      '<script type="text/javascript">'.
   90: 	      &Apache::lonmenu::rawconfig().'</script>'.
   91: 	      '<p>'.&mt('The following problems occurred:').
   92: 	      $error.
   93: 	      '</p><br /><a href="'.$dest.'">'.&mt('Continue').'</a>'.
   94: 	      &Apache::loncommon::end_page());
   95: }
   96: 
   97: sub handler {
   98: 
   99:     my $r = shift;
  100: 
  101:     my $now=time;
  102:     my $then=$env{'user.login.time'};
  103:     my $envkey;
  104:     my %dcroles = ();
  105:     my $numdc = &check_fordc(\%dcroles,$then);
  106:     &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'});
  107: 
  108: # ================================================================== Roles Init
  109:     if ($env{'form.selectrole'}) {
  110: 
  111:         my $locknum=&Apache::lonnet::get_locks();
  112:         if ($locknum) { return 409; }
  113: 
  114:         if ($env{'form.newrole'}) {
  115:             $env{'form.'.$env{'form.newrole'}}=1;
  116: 	}
  117: 	if ($env{'request.course.id'}) {
  118:             # Check if user is CC trying to select a course role
  119:             if ($env{'form.switchrole'}) {
  120:                 if (!defined($env{'user.role.'.$env{'form.switchrole'}})) {
  121:                     &adhoc_course_role($then);
  122:                 }
  123:             }
  124: 	    my %temp=('logout_'.$env{'request.course.id'} => time);
  125: 	    &Apache::lonnet::put('email_status',\%temp);
  126: 	    &Apache::lonnet::delenv('user.state.'.$env{'request.course.id'});
  127: 	}
  128: 	&Apache::lonnet::appenv({"request.course.id"   => '',
  129: 			 	 "request.course.fn"   => '',
  130: 				 "request.course.uri"  => '',
  131: 				 "request.course.sec"  => '',
  132: 				 "request.role"        => 'cm',
  133:                                  "request.role.adv"    => $env{'user.adv'},
  134: 				 "request.role.domain" => $env{'user.domain'}});
  135: # Check if user is a DC trying to enter a course or author space and needs privs to be created
  136:         if ($numdc > 0) {
  137:             foreach my $envkey (keys %env) {
  138: # Is this an ad-hoc CC-role?
  139:                 if (my ($domain,$coursenum) =
  140: 		    ($envkey =~ m-^form\.cc\./($match_domain)/($match_courseid)$-)) {
  141:                     if ($dcroles{$domain}) {
  142:                         &check_privs($domain,$coursenum,$then,$now,'cc');
  143:                     }
  144:                     last;
  145:                 }
  146: # Is this an ad-hoc CA-role?
  147:                 if (my ($domain,$user) =
  148: 		    ($envkey =~ m-^form\.ca\./($match_domain)/($match_username)$-)) {
  149:                     if (($domain eq $env{'user.domain'}) && ($user eq $env{'user.name'})) {
  150:                         delete($env{$envkey});
  151:                         $env{'form.au./'.$domain.'/'} = 1;
  152:                         my ($server_status,$home) = &check_author_homeserver($user,$domain);
  153:                         if ($server_status eq 'switchserver') {
  154:                             my $trolecode = 'au./'.$domain.'/';
  155:                             my $switchserver = '/adm/switchserver?otherserver='.$home.'&role='.$trolecode;
  156:                             $r->internal_redirect($switchserver);
  157:                         }
  158:                         last;
  159:                     }
  160:                     if (my ($castart,$caend) = ($env{'user.role.ca./'.$domain.'/'.$user} =~ /^(\d*)\.(\d*)$/)) {
  161:                         if (((($castart) && ($castart < $now)) || !$castart) && 
  162:                             ((!$caend) || (($caend) && ($caend > $now)))) {
  163:                             my ($server_status,$home) = &check_author_homeserver($user,$domain);
  164:                             if ($server_status eq 'switchserver') {
  165:                                 my $trolecode = 'ca./'.$domain.'/'.$user;
  166:                                 my $switchserver = '/adm/switchserver?otherserver='.$home.'&role='.$trolecode;
  167:                                 $r->internal_redirect($switchserver);
  168:                             }
  169:                             last;
  170:                         }
  171:                     }
  172:                     # Check if author blocked ca-access
  173:                     my %blocked=&Apache::lonnet::get('environment',['domcoord.author'],$domain,$user);
  174:                     if ($blocked{'domcoord.author'} eq 'blocked') {
  175:                         delete($env{$envkey});
  176:                         $env{'user.error.msg'}=':::1:User '.$user.' in domain '.$domain.' blocked domain coordinator access';
  177:                         last;
  178:                     }
  179:                     if ($dcroles{$domain}) {
  180:                         my ($server_status,$home) = &check_author_homeserver($user,$domain);
  181:                         if (($server_status eq 'ok') || ($server_status eq 'switchserver')) {
  182:                             &check_privs($domain,$user,$then,$now,'ca');
  183:                             if ($server_status eq 'switchserver') {
  184:                                 my $trolecode = 'ca./'.$domain.'/'.$user; 
  185:                                 my $switchserver = '/adm/switchserver?'
  186:                                                   .'otherserver='.$home.'&role='.$trolecode;
  187:                                 $r->internal_redirect($switchserver);
  188:                             }
  189:                         } else {
  190:                             delete($env{$envkey});
  191:                         }
  192:                     } else {
  193:                         delete($env{$envkey});
  194:                     }
  195:                     last;
  196:                 }
  197:             }
  198:         }
  199: 
  200:         foreach $envkey (keys %env) {
  201:             next if ($envkey!~/^user\.role\./);
  202:             my ($where,$trolecode,$role,$tstatus,$tend,$tstart);
  203:             &role_status($envkey,$then,$now,\$role,\$where,\$trolecode,\$tstatus,\$tstart,\$tend);
  204:             if ($env{'form.'.$trolecode}) {
  205: 		if ($tstatus eq 'is') {
  206: 		    $where=~s/^\///;
  207: 		    my ($cdom,$cnum,$csec)=split(/\//,$where);
  208: # check for course groups
  209:                     my %coursegroups = &Apache::lonnet::get_active_groups(
  210:                           $env{'user.domain'},$env{'user.name'},$cdom, $cnum);
  211:                     my $cgrps = join(':',keys(%coursegroups));
  212: 
  213: # store role if recent_role list being kept
  214:                     if ($env{'environment.recentroles'}) {
  215:                         my %frozen_roles =
  216:                            &Apache::lonhtmlcommon::get_recent_frozen('roles',$env{'environment.recentrolesn'});
  217: 			&Apache::lonhtmlcommon::store_recent('roles',
  218: 							     $trolecode,' ',$frozen_roles{$trolecode});
  219:                     }
  220: 
  221: 
  222: # check for keyed access
  223: 		    if (($role eq 'st') && 
  224:                        ($env{'course.'.$cdom.'_'.$cnum.'.keyaccess'} eq 'yes')) {
  225: # who is key authority?
  226: 			my $authdom=$cdom;
  227: 			my $authnum=$cnum;
  228: 			if ($env{'course.'.$cdom.'_'.$cnum.'.keyauth'}) {
  229: 			    ($authnum,$authdom)=
  230: 				split(/:/,$env{'course.'.$cdom.'_'.$cnum.'.keyauth'});
  231: 			}
  232: # check with key authority
  233: 			unless (&Apache::lonnet::validate_access_key(
  234: 				     $env{'environment.key.'.$cdom.'_'.$cnum},
  235: 					     $authdom,$authnum)) {
  236: # there is no valid key
  237: 			     if ($env{'form.newkey'}) {
  238: # student attempts to register a new key
  239: 				 &Apache::loncommon::content_type($r,'text/html');
  240: 				 &Apache::loncommon::no_cache($r);
  241: 				 $r->send_http_header;
  242: 				 my $swinfo=&Apache::lonmenu::rawconfig();
  243: 				 my $start_page=&Apache::loncommon::start_page
  244: 				    ('Verifying Access Key to Unlock this Course');
  245: 				 my $end_page=&Apache::loncommon::end_page();
  246: 				 my $buttontext=&mt('Enter Course');
  247: 				 my $message=&mt('Successfully registered key');
  248: 				 my $assignresult=
  249: 				     &Apache::lonnet::assign_access_key(
  250: 						     $env{'form.newkey'},
  251: 						     $authdom,$authnum,
  252: 						     $cdom,$cnum,
  253:                                                      $env{'user.domain'},
  254: 						     $env{'user.name'},
  255:                                                      &mt('Assigned from [_1] at [_2] for [_3]'
  256:                                                         ,$ENV{'REMOTE_ADDR'}
  257:                                                         ,&Apache::lonlocal::locallocaltime()
  258:                                                         ,$trolecode)
  259:                                                      );
  260: 				 unless ($assignresult eq 'ok') {
  261: 				     $assignresult=~s/^error\:\s*//;
  262: 				     $message=&mt($assignresult).
  263: 				     '<br /><a href="/adm/logout">'.
  264: 				     &mt('Logout').'</a>';
  265: 				     $buttontext=&mt('Re-Enter Key');
  266: 				 }
  267: 				 $r->print(<<ENDENTEREDKEY);
  268: $start_page
  269: <script type="text/javascript">
  270: $swinfo
  271: </script>
  272: <form method="post">
  273: <input type="hidden" name="selectrole" value="1" />
  274: <input type="hidden" name="$trolecode" value="1" />
  275: <font size="+2">$message</font><br />
  276: <input type="submit" value="$buttontext" />
  277: </form>
  278: $end_page
  279: ENDENTEREDKEY
  280:                                  return OK;
  281: 			     } else {
  282: # print form to enter a new key
  283: 				 &Apache::loncommon::content_type($r,'text/html');
  284: 				 &Apache::loncommon::no_cache($r);
  285: 				 $r->send_http_header;
  286: 				 my $swinfo=&Apache::lonmenu::rawconfig();
  287: 				 my $start_page=&Apache::loncommon::start_page
  288: 				    ('Enter Access Key to Unlock this Course');
  289: 				 my $end_page=&Apache::loncommon::end_page();
  290: 				 $r->print(<<ENDENTERKEY);
  291: $start_page
  292: <script type="text/javascript">
  293: $swinfo
  294: </script>
  295: <form method="post">
  296: <input type="hidden" name="selectrole" value="1" />
  297: <input type="hidden" name="$trolecode" value="1" />
  298: <input type="text" size="20" name="newkey" value="$env{'form.newkey'}" />
  299: <input type="submit" value="Enter key" />
  300: </form>
  301: $end_page
  302: ENDENTERKEY
  303: 				 return OK;
  304: 			     }
  305: 			 }
  306: 		     }
  307: 		    &Apache::lonnet::log($env{'user.domain'},
  308: 					 $env{'user.name'},
  309: 					 $env{'user.home'},
  310: 					 "Role ".$trolecode);
  311: 		    
  312: 		    &Apache::lonnet::appenv(
  313: 					   {'request.role'        => $trolecode,
  314: 					    'request.role.domain' => $cdom,
  315: 					    'request.course.sec'  => $csec,
  316:                                             'request.course.groups' => $cgrps});
  317:                     my $tadv=0;
  318: 
  319: 		    if (($cnum) && ($role ne 'ca') && ($role ne 'aa')) {
  320:                         my $msg;
  321: 			my ($furl,$ferr)=
  322: 			    &Apache::lonuserstate::readmap($cdom.'/'.$cnum);
  323: 			if (($env{'form.orgurl'}) && 
  324: 			    ($env{'form.orgurl'}!~/^\/adm\/flip/)) {
  325: 			    my $dest=$env{'form.orgurl'};
  326: 			    if (&Apache::lonnet::allowed('adv') eq 'F') { $tadv=1; }
  327: 			    &Apache::lonnet::appenv({'request.role.adv'=>$tadv});
  328:                             if (($ferr) && ($tadv)) {
  329: 				&error_page($r,$ferr,$dest);
  330: 			    } else {
  331: 				$r->internal_redirect($dest);
  332: 			    }
  333: 			    return OK;
  334: 			} else {
  335: 			    if (!$env{'request.course.id'}) {
  336: 				&Apache::lonnet::appenv(
  337: 				      {"request.course.id"  => $cdom.'_'.$cnum});
  338: 				$furl='/adm/roles?tryagain=1';
  339: 				$msg=
  340: 				    '<h1><span class="LC_error">'.
  341: 				    &mt('Could not initialize [_1] at this time.',
  342: 					$env{'course.'.$cdom.'_'.$cnum.'.description'}).
  343: 				    '</span></h1><h3>'.&mt('Please try again.').'</h3>'.$ferr;
  344: 			    }
  345: 			    if (&Apache::lonnet::allowed('adv') eq 'F') { $tadv=1; }
  346: 			    &Apache::lonnet::appenv({'request.role.adv'=>$tadv});
  347: 
  348: 			    if (($ferr) && ($tadv)) {
  349: 				&error_page($r,$ferr,$furl);
  350: 			    } else {
  351: 				# Check to see if the user is a CC entering a course 
  352: 				# for the first time
  353: 				my (undef, undef, $role, $courseid) = split(/\./, $envkey);
  354: 				if (substr($courseid, 0, 1) eq '/') {
  355: 				    $courseid = substr($courseid, 1);
  356: 				}
  357: 				$courseid =~ s/\//_/;
  358: 				if ($role eq 'cc' && $env{'course.' . $courseid . 
  359: 							      '.course.helper.not.run'}) {
  360: 				    $furl = "/adm/helper/course.initialization.helper";
  361: 				    # Send the user to the course they selected
  362: 				} elsif ($env{'request.course.id'}) {
  363:                                     if ($env{'form.destinationurl'}) {
  364:                                         my $dest = $env{'form.destinationurl'};
  365:                                         if ($env{'form.destsymb'} ne '') {
  366:                                             my $esc_symb = &HTML::Entities::encode($env{'form.destsymb'},'"<>&');
  367:                                             $dest .= '?symb='.$esc_symb;
  368:                                         }
  369:                                         &redirect_user($r,&mt('Entering [_1]',
  370:                                                       $env{'course.'.$courseid.'.description'}),
  371:                                                $dest,$msg,
  372:                                                $env{'environment.remotenavmap'});
  373:                                         return OK;
  374:                                     }
  375: 				    if (&Apache::lonnet::allowed('whn',
  376: 								 $env{'request.course.id'})
  377: 					|| &Apache::lonnet::allowed('whn',
  378: 								    $env{'request.course.id'}.'/'
  379: 								    .$env{'request.course.sec'})
  380: 					) {
  381: 					my $startpage = &courseloadpage($courseid);
  382: 					unless ($startpage eq 'firstres') {         
  383: 					    $msg = &mt('Entering [_1] ...',
  384: 						       $env{'course.'.$courseid.'.description'});
  385: 					    &redirect_user($r,&mt('New in course'),
  386: 							   '/adm/whatsnew?refpage=start',$msg,
  387: 							   $env{'environment.remotenavmap'});
  388: 					    return OK;
  389: 					}
  390: 				    }
  391: 				}
  392: # Are we allowed to look at the first resource?
  393: 				if ($furl !~ m|^/adm/|) {
  394: # Guess not ...
  395: 				    $furl=&Apache::lonpageflip::first_accessible_resource();
  396: 				}
  397:                                 $msg = &mt('Entering [_1] ...',
  398: 					   $env{'course.'.$courseid.'.description'});
  399: 				&redirect_user($r,&mt('Entering [_1]',
  400: 						      $env{'course.'.$courseid.'.description'}),
  401: 					       $furl,$msg,
  402: 					       $env{'environment.remotenavmap'});
  403: 			    }
  404: 			    return OK;
  405: 			}
  406: 		    }
  407:                     #
  408:                     # Send the user to the construction space they selected
  409:                     if ($role =~ /^(au|ca|aa)$/) {
  410:                         my $redirect_url = '/priv/';
  411:                         if ($role eq 'au') {
  412:                             $redirect_url.=$env{'user.name'};
  413:                         } else {
  414:                             $where =~ /\/(.*)$/;
  415:                             $redirect_url .= $1;
  416:                         }
  417:                         $redirect_url .= '/';
  418:                         &redirect_user($r,&mt('Entering Construction Space'),
  419:                                        $redirect_url);
  420:                         return OK;
  421:                     }
  422:                     if ($role eq 'dc') {
  423:                         my $redirect_url = '/adm/menu/';
  424:                         &redirect_user($r,&mt('Loading Domain Coordinator Menu'),
  425:                                        $redirect_url);
  426:                         return OK;
  427:                     }
  428: 		}
  429:             }
  430:         }
  431:     }
  432: 
  433: 
  434: # =============================================================== No Roles Init
  435: 
  436:     &Apache::loncommon::content_type($r,'text/html');
  437:     &Apache::loncommon::no_cache($r);
  438:     $r->send_http_header;
  439:     return OK if $r->header_only;
  440: 
  441:     my $swinfo=&Apache::lonmenu::rawconfig();
  442:     my $start_page=&Apache::loncommon::start_page('User Roles');
  443:     my $standby=&mt('Role selected. Please stand by.');
  444:     $standby=~s/\n/\\n/g;
  445:     my $noscript='<span class="LC_error">'.&mt('Use of LON-CAPA requires Javascript to be enabled in your web browser.').'<br />'.&mt('As this is not the case, most functionality in the system will be unavailable.').'</span><br />';
  446: 
  447:     $r->print(<<ENDHEADER);
  448: $start_page
  449: <br />
  450: <noscript>
  451: $noscript
  452: </noscript>
  453: <script type="text/javascript">
  454: $swinfo
  455: window.focus();
  456: 
  457: active=true;
  458: 
  459: function enterrole (thisform,rolecode,buttonname) {
  460:     if (active) {
  461: 	active=false;
  462:         document.title='$standby';
  463:         window.status='$standby';
  464: 	thisform.newrole.value=rolecode;
  465: 	thisform.submit();
  466:     } else {
  467:        alert('$standby');
  468:     }   
  469: }
  470: </script>
  471: ENDHEADER
  472: 
  473: # ------------------------------------------ Get Error Message from Environment
  474: 
  475:     my ($fn,$priv,$nochoose,$error,$msg)=split(/:/,$env{'user.error.msg'});
  476:     if ($env{'user.error.msg'}) {
  477: 	$r->log_reason(
  478:    "$msg for $env{'user.name'} domain $env{'user.domain'} access $priv",$fn);
  479:     }
  480: 
  481: # ------------------------------------------------- Can this user re-init, etc?
  482: 
  483:     my $advanced=$env{'user.adv'};
  484:     &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},['tryagain']);
  485:     my $tryagain=$env{'form.tryagain'};
  486:     my $reinit=$env{'user.reinit'};
  487:     delete $env{'user.reinit'};
  488: 
  489: # -------------------------------------------------------- Generate Page Output
  490: # --------------------------------------------------------------- Error Header?
  491:     if ($error) {
  492:         $r->print("<h1>".&mt('LON-CAPA Access Control')."</h1>");
  493: 	$r->print("<!-- LONCAPAACCESSCONTROLERRORSCREEN --><hr /><pre>");
  494: 	if ($priv ne '') {
  495:             $r->print(&mt('Access  : ').&Apache::lonnet::plaintext($priv)."\n");
  496: 	}
  497: 	if ($fn ne '') {
  498:             $r->print(&mt('Resource: ').&Apache::lonenc::check_encrypt($fn)."\n");
  499: 	}
  500: 	if ($msg ne '') {
  501:             $r->print(&mt('Action  : ').$msg."\n");
  502: 	}
  503: 	$r->print("</pre><hr />");
  504: 	my $url=$fn;
  505: 	my $last;
  506: 	if (tie(my %hash,'GDBM_File',$env{'request.course.fn'}.'_symb.db',
  507: 		&GDBM_READER(),0640)) {
  508: 	    $last=$hash{'last_known'};
  509: 	    untie(%hash);
  510: 	}
  511: 	if ($last) { $fn.='?symb='.&escape($last); }
  512: 
  513: 	&Apache::londocs::changewarning($r,undef,'You have modified your course recently, [_1] may fix this access problem.',
  514: 					&Apache::lonenc::check_encrypt($fn));
  515:     } else {
  516:         if ($env{'user.error.msg'}) {
  517:             if ($reinit) {
  518:                 $r->print(
  519:  '<h3><span class="LC_error">'.
  520:  &mt('As your session file for the course has expired, you will need to re-select the course.').'</span></h3>');
  521:             } else {
  522: 	        $r->print(
  523:  '<h3><span class="LC_error">'.
  524:  &mt('You need to choose another user role or enter a specific course for this function').'</span></h3>');
  525: 	    }
  526:         }
  527:     }
  528: # -------------------------------------------------------- Choice or no choice?
  529:     if ($nochoose) {
  530: 	$r->print("<h2>".&mt('Sorry ...')."</h2>\n<span class='LC_error'>".
  531: 		  &mt('This action is currently not authorized.').'</span>'.
  532: 		  &Apache::loncommon::end_page());
  533: 	return OK;
  534:     } else {
  535:         if (($ENV{'REDIRECT_QUERY_STRING'}) && ($fn)) {
  536:     	    $fn.='?'.$ENV{'REDIRECT_QUERY_STRING'};
  537:         }
  538:         $r->print('<form method="post" name="rolechoice" action="'.(($fn)?$fn:$r->uri).'">');
  539:         $r->print('<input type="hidden" name="orgurl" value="'.$fn.'" />');
  540:         $r->print('<input type="hidden" name="selectrole" value="1" />');
  541:         $r->print('<input type="hidden" name="newrole" value="" />');
  542:     }
  543:     my (%roletext,%sortrole,%roleclass);
  544:     my $countactive=0;
  545:     my $countfuture=0;
  546:     my $countwill=0;
  547:     my $inrole=0;
  548:     my $possiblerole='';
  549:     my %futureroles;
  550:     my %roles_nextlogin;
  551:     foreach $envkey (sort keys %env) {
  552:         my $button = 1;
  553:         my $switchserver='';
  554: 	my $roletext;
  555: 	my $sortkey;
  556:         if ($envkey=~/^user\.role\./) {
  557:             my ($role,$where,$trolecode,$tstart,$tend,$tremark,$tstatus,$tpstart,$tpend,$tfont);
  558:             &role_status($envkey,$then,$now,\$role,\$where,\$trolecode,\$tstatus,\$tstart,\$tend);
  559:             next if (!defined($role) || $role eq '' || $role =~ /^gr/);
  560:             $tremark='';
  561:             $tpstart='&nbsp;';
  562:             $tpend='&nbsp;';
  563:             $tfont='#000000';
  564:             if ($tstart) {
  565:                 $tpstart=&Apache::lonlocal::locallocaltime($tstart);
  566:             }
  567:             if ($tend) {
  568:                 $tpend=&Apache::lonlocal::locallocaltime($tend);
  569:             }
  570:             if ($env{'request.role'} eq $trolecode) {
  571: 		$tstatus='selected';
  572:             }
  573:             my $tbg;
  574:             if (($tstatus eq 'is') 
  575: 		|| ($tstatus eq 'selected') 
  576: 		|| ($tstatus eq 'will') 
  577: 		|| ($tstatus eq 'future') 
  578:                 || ($env{'form.showall'})) {
  579:                 if ($tstatus eq 'is') {
  580:                     $tbg='#77FF77';
  581:                     $tfont='#003300';
  582: 		    $possiblerole=$trolecode;
  583: 		    $countactive++;
  584:                 } elsif ($tstatus eq 'future') {
  585:                     $tbg='#FFFF77';
  586:                     $button=0;
  587:                     $futureroles{$trolecode} = $tstart.':'.$tend;
  588:                     $countfuture ++;
  589:                 } elsif ($tstatus eq 'will') {
  590:                     $tbg='#FFAA77';
  591:                     $tremark.=&mt('Active at next login.').' ';
  592:                     $roles_nextlogin{$trolecode} = $tstart.':'.$tend;
  593:                     $countwill ++;
  594:                 } elsif ($tstatus eq 'expired') {
  595:                     $tbg='#FF7777';
  596:                     $tfont='#330000';
  597:                     $button=0;
  598:                 } elsif ($tstatus eq 'will_not') {
  599:                     $tbg='#AAFF77';
  600:                     $tremark.=&mt('Expired after logout.').' ';
  601:                 } elsif ($tstatus eq 'selected') {
  602:                     $tbg='#11CC55';
  603:                     $tfont='#002200';
  604: 		    $inrole=1;
  605: 		    $countactive++;
  606:                     $tremark.=&mt('Currently selected.').' ';
  607:                 }
  608:                 my $trole;
  609:                 if ($role =~ /^cr\//) {
  610:                     my ($rdummy,$rdomain,$rauthor,$rrole)=split(/\//,$role);
  611: 		    if ($tremark) { $tremark.='<br />'; }
  612:                     $tremark.=&mt('Defined by [_1] at [_2].',$rauthor,$rdomain);
  613: 		}
  614: 		$trole=Apache::lonnet::plaintext($role);
  615:                 my $ttype;
  616:                 my $twhere;
  617:                 my ($tdom,$trest,$tsection)=
  618:                     split(/\//,Apache::lonnet::declutter($where));
  619:                 # First, Co-Authorship roles
  620:                 if (($role eq 'ca') || ($role eq 'aa')) {
  621:                     my $home = &Apache::lonnet::homeserver($trest,$tdom);
  622: 		    my $allowed=0;
  623: 		    my @ids=&Apache::lonnet::current_machine_ids();
  624: 		    foreach my $id (@ids) { if ($id eq $home) { $allowed=1; } }
  625:                     if (!$allowed) {
  626: 			$button=0;
  627:                         $switchserver='otherserver='.$home.'&role='.$trolecode;
  628:                     }
  629:                     #next if ($home eq 'no_host');
  630:                     $home = &Apache::lonnet::hostname($home);
  631:                     $ttype='Construction Space';
  632:                     $twhere=&mt('User').': '.$trest.'<br />'.&mt('Domain').
  633: 			': '.$tdom.'<br />'.
  634:                         ' '.&mt('Server').':&nbsp;'.$home;
  635:                     $env{'course.'.$tdom.'_'.$trest.'.description'}='ca';
  636: 		    $tremark.=&Apache::lonhtmlcommon::authorbombs('/res/'.$tdom.'/'.$trest.'/');
  637: 		    $sortkey=$role."$trest:$tdom";
  638:                 } elsif ($role eq 'au') {
  639:                     # Authors
  640:                     my $home = &Apache::lonnet::homeserver
  641:                         ($env{'user.name'},$env{'user.domain'});
  642: 		    my $allowed=0;
  643: 		    my @ids=&Apache::lonnet::current_machine_ids();
  644: 		    foreach my $id (@ids) { if ($id eq $home) { $allowed=1; } }
  645:                     if (!$allowed) {
  646: 			$button=0;
  647:                         $switchserver='otherserver='.$home.'&role='.$trolecode;
  648:                     }
  649:                     #next if ($home eq 'no_host');
  650:                     $home = &Apache::lonnet::hostname($home);
  651:                     $ttype='Construction Space';
  652:                     $twhere=&mt('Domain').': '.$tdom.'<br />'.&mt('Server').
  653: 			':&nbsp;'.$home;
  654:                     $env{'course.'.$tdom.'_'.$trest.'.description'}='ca';
  655: 		    $tremark.=&Apache::lonhtmlcommon::authorbombs('/res/'.$tdom.'/'.$env{'user.name'}.'/');
  656: 		    $sortkey=$role;
  657:                 } elsif ($trest) {
  658:                     my $tcourseid=$tdom.'_'.$trest;
  659:                     $ttype = &Apache::loncommon::course_type($tcourseid);
  660:                     $trole = &Apache::lonnet::plaintext($role,$ttype);
  661:                     if ($env{'course.'.$tcourseid.'.description'}) {
  662:                         $twhere=$env{'course.'.$tcourseid.'.description'};
  663: 			$sortkey=$role."\0".$tdom."\0".$twhere."\0".$envkey;
  664:                         unless ($twhere eq &mt('Currently not available')) {
  665: 			    $twhere.=' <font size="-2">'.
  666:         &Apache::loncommon::syllabuswrapper(&mt('Syllabus'),$trest,$tdom,$tfont).
  667:                                     '</font>';
  668: 			}
  669:                     } else {
  670:                         my %newhash=&Apache::lonnet::coursedescription($tcourseid);
  671:                         if (%newhash) {
  672: 			    $sortkey=$role."\0".$tdom."\0".$newhash{'description'}.
  673: 				"\0".$envkey;
  674:                             $twhere=$newhash{'description'}.
  675:                               ' <font size="-2">'.
  676:         &Apache::loncommon::syllabuswrapper(&mt('Syllabus'),$trest,$tdom,$tfont).
  677:                               '</font>';
  678:                             $ttype = $newhash{'type'};
  679:                             $trole = &Apache::lonnet::plaintext($role,$ttype);
  680:                         } else {
  681:                             $twhere=&mt('Currently not available');
  682:                             $env{'course.'.$tcourseid.'.description'}=$twhere;
  683: 			    $sortkey=$role."\0".$tdom."\0".$twhere."\0".$envkey;
  684:                             $ttype = 'Unavailable';
  685:                         }
  686:                     }
  687:                     if ($tsection) {
  688:                         $twhere.='<br />'.&mt('Section').': '.$tsection;
  689: 		    }
  690: 		    if ($role ne 'st') { $twhere.="<br />".&mt('Domain').":".$tdom; }
  691:                 } elsif ($tdom) {
  692:                     $ttype='Domain';
  693:                     $twhere=$tdom;
  694: 		    $sortkey=$role.$twhere;
  695:                 } else {
  696:                     $ttype='System';
  697:                     $twhere=&mt('system wide');
  698: 		    $sortkey=$role.$twhere;
  699:                 }
  700:                 $roletext.=&build_roletext($trolecode,$tdom,$trest,$tstatus,$tryagain,$advanced,$tremark,$tbg,$tfont,$trole,$twhere,$tpstart,$tpend,$nochoose,$button,$switchserver,$reinit);
  701: 		$roletext{$envkey}=$roletext;
  702: 		if (!$sortkey) {$sortkey=$twhere."\0".$envkey;}
  703: 		$sortrole{$sortkey}=$envkey;
  704: 		$roleclass{$envkey}=$ttype;
  705: 	    }
  706:         }
  707:     }
  708:     if ($env{'user.adv'}) {
  709:         $r->print(
  710:               '<br /><span class="LC_rolesinfo"><label>'.&mt('Show all roles').': <input type="checkbox" name="showall"');
  711:         if ($env{'form.showall'}) { $r->print(' checked="checked" '); }
  712:         $r->print(' /></label><input type="submit" value="'.&mt('Display').'" /></span>');
  713:     } else {
  714:         if ($countactive > 0) {
  715:             my $domdesc = &Apache::lonnet::domain($env{'user.domain'},'description');
  716:             my $esc_dom = &HTML::Entities::encode($env{'user.domain'},'"<>&'); 
  717:             $r->print('<p>'.&mt('[_1]Visit the [_2]Course Catalog[_3] to view all [_4] LON-CAPA courses.','<b>','<a href="/adm/coursecatalog?showdom='.$esc_dom.'">','</a></b>',$domdesc).'<br />'.&mt('If a course is [_1]not[_2] in your list of current courses below, you may be able to enroll if self-enrollment is permitted.','<b>','</b>').'</p>');
  718:         }
  719:     }
  720: 
  721: # No active roles
  722:     if ($countactive==0) {
  723: 	if ($inrole) {
  724: 	    $r->print('<h2>'.&mt('Currently no additional roles or courses').'</h2>');
  725: 	} else {
  726: 	    $r->print('<h2>'.&mt('Currently no active roles or courses').'</h2>');
  727: 	}
  728:         &findcourse_advice($r);
  729: 	$r->print('</form>');
  730:         if ($countfuture) {
  731:             $r->print(&mt('The following [quant,_1,role,roles] will become active in the future:',$countfuture));
  732:             my $doheaders = &roletable_headers($r,\%roleclass,\%sortrole,
  733:                                                $nochoose);
  734:             &print_rolerows($r,$doheaders,\%roleclass,\%sortrole,\%dcroles,
  735:                             \%roletext);
  736:             my $tremark='';
  737:             my $tfont='#003300';
  738:             if ($env{'request.role'} eq 'cm') {
  739:                 $r->print('<tr bgcolor="#11CC55">');
  740:                 $tremark=&mt('Currently selected.').' ';
  741:                 $tfont='#002200';
  742:             } else {
  743:                 $r->print('<tr bgcolor="#77FF77">');
  744:             }
  745:             $r->print('<td></td><td colspan="3"><font color="'.$tfont.'"><span class="LC_rolesinfo">'.&mt('No role specified').
  746:                       '</span></font></td><td><font color="'.$tfont.'">'.$tremark.
  747:                       '&nbsp;</font></td></tr>'."\n");
  748: 
  749:             $r->print('</table>');
  750:         }
  751:         $r->print(&Apache::loncommon::end_page());
  752: 	return OK;
  753:     }
  754: # ----------------------------------------------------------------------- Table
  755:     unless ((!&Apache::lonmenu::show_course()) || ($nochoose) || ($countactive==1)) {
  756: 	$r->print("<h2>".&mt('Select a Course to Enter')."</h2>\n");
  757:     }
  758:     my $doheaders = &roletable_headers($r,\%roleclass,\%sortrole,$nochoose);
  759:     if ($env{'environment.recentroles'}) {
  760:         my %recent_roles =
  761:                &Apache::lonhtmlcommon::get_recent('roles',$env{'environment.recentrolesn'});
  762: 	my $output='';
  763: 	foreach (sort(keys(%recent_roles))) {
  764: 	    if (defined($roletext{'user.role.'.$_})) {
  765: 		$output.=$roletext{'user.role.'.$_};
  766:                 if ($_ =~ m-dc\./($match_domain)/- 
  767: 		    && $dcroles{$1}) {
  768: 		    $output .= &adhoc_roles_row($1,'recent');
  769:                 }
  770: 	    } elsif ($numdc > 0) {
  771:                 unless ($_ =~/^error\:/) {
  772:                     $output.=&display_cc_role('user.role.'.$_);
  773:                 }
  774:             } 
  775: 	}
  776: 	if ($output) {
  777: 	    $r->print("<tr><td align='center' colspan='5'><font face='arial'>".
  778: 		      &mt('Recent Roles')."</font></td></tr>");
  779: 	    $r->print($output);
  780:             $doheaders ++;
  781: 	}
  782:     }
  783: 
  784:     if ($numdc > 0) {
  785:         $r->print(&coursepick_jscript());
  786:         $r->print(&Apache::loncommon::coursebrowser_javascript().
  787:                   &Apache::loncommon::authorbrowser_javascript());
  788:     }
  789:     &print_rolerows($r,$doheaders,\%roleclass,\%sortrole,\%dcroles,\%roletext);
  790:     if ($countactive > 1) {
  791:         my $tremark='';
  792:         my $tfont='#003300';
  793:         if ($env{'request.role'} eq 'cm') {
  794: 	    $r->print('<tr bgcolor="#11CC55">');
  795:             $tremark=&mt('Currently selected.').' ';
  796:             $tfont='#002200';
  797:         } else {
  798:             $r->print('<tr bgcolor="#77FF77">');
  799:         }
  800:         unless ($nochoose) {
  801: 	    if ($env{'request.role'} ne 'cm') {
  802: 	        $r->print('<td><input type="submit" value="'.
  803: 		          &mt('Select').'" name="cm" /></td>');
  804: 	    } else {
  805: 	        $r->print('<td>&nbsp;</td>');
  806: 	    }
  807:         }
  808:         $r->print('<td colspan="3"><font color="'.$tfont.'"><span class="LC_rolesinfo">'.&mt('No role specified').
  809:                   '</span></font></td><td><font color="'.$tfont.'">'.$tremark.
  810:                   '&nbsp;</font></td></tr>'."\n");
  811:     } 
  812:     $r->print('</table>');
  813:     unless ($nochoose) {
  814: 	$r->print("</form>\n");
  815:     }
  816: # ------------------------------------------------------------ Privileges Info
  817:     if (($advanced) && (($env{'user.error.msg'}) || ($error))) {
  818: 	$r->print('<hr /><h2>Current Privileges</h2>');
  819: 	$r->print(&privileges_info());
  820:     }
  821:     $r->print(&Apache::lonnet::getannounce());
  822:     if ($advanced) {
  823:         my $esc_dom = &HTML::Entities::encode($env{'user.domain'},'"<>&');
  824: 	$r->print('<p><small><i>'
  825:                  .&mt('This is LON-CAPA [_1]',$r->dir_config('lonVersion'))
  826: 		 .'</i><br />'
  827: 		 .'<a href="/adm/logout">'.&mt('Logout').'</a>&nbsp;&nbsp;'
  828:                  .'<a href="/adm/coursecatalog?showdom='.$esc_dom.'">'
  829:                  .&mt('Course Catalog')
  830:                  .'</small></p>');
  831:     }
  832:     $r->print(&Apache::loncommon::end_page());
  833:     return OK;
  834: }
  835: 
  836: sub roletable_headers {
  837:     my ($r,$roleclass,$sortrole,$nochoose) = @_;
  838:     my $doheaders;
  839:     if ((ref($sortrole) eq 'HASH') && (ref($roleclass) eq 'HASH')) {
  840:         $r->print('<br /><table id="LC_rolesmenu"><tr>');
  841:         if (!$nochoose) { $r->print('<th>&nbsp;</th>'); }
  842:         $r->print('<th>'.&mt('User Role').'</th><th>'.&mt('Extent')
  843:                   .'</th><th>'.&mt('Start').'</th><th>'.&mt('End')
  844:                   .'</th></tr>'."\n");
  845:         $doheaders=-1;
  846:         my @roletypes = &roletypes();
  847:         foreach my $type (@roletypes) {
  848:             my $haverole=0;
  849:             foreach my $which (sort {uc($a) cmp uc($b)} (keys(%{$sortrole}))) {
  850:                 if ($roleclass->{$sortrole->{$which}} =~ /^\Q$type\E/) {
  851:                     $haverole=1;
  852:                 }
  853:             }
  854:             if ($haverole) { $doheaders++; }
  855:         }
  856:     }
  857:     return $doheaders;
  858: }
  859: 
  860: sub roletypes {
  861:     my @types = ('Domain','Construction Space','Course','Unavailable','System');
  862:     return @types; 
  863: }
  864: 
  865: sub print_rolerows {
  866:     my ($r,$doheaders,$roleclass,$sortrole,$dcroles,$roletext) = @_;
  867:     if ((ref($roleclass) eq 'HASH') && (ref($sortrole) eq 'HASH')) {
  868:         my @types = &roletypes();
  869:         foreach my $type (@types) {
  870:             my $output;
  871:             foreach my $which (sort {uc($a) cmp uc($b)} (keys(%{$sortrole}))) {
  872:                 if ($roleclass->{$sortrole->{$which}} =~ /^\Q$type\E/) {
  873:                     if (ref($roletext) eq 'HASH') {
  874:                         $output.=$roletext->{$sortrole->{$which}};
  875:                         if ($sortrole->{$which} =~ m-dc\./($match_domain)/-) {
  876:                             if (ref($dcroles) eq 'HASH') {
  877:                                 if ($dcroles->{$1}) {
  878:                                     $output .= &adhoc_roles_row($1,'');
  879:                                 }
  880:                             }
  881:                         }
  882:                     }
  883:                 }
  884:             }
  885:             if ($output) {
  886:                 if ($doheaders > 0) {
  887:                     $r->print("<tr>".
  888:                               "<td align='center' colspan='5'><font face='arial'>".
  889:                               &mt($type)."</font></td></tr>");
  890:                 }
  891:                 $r->print($output);
  892:             }
  893:         }
  894:     }
  895: }
  896: 
  897: sub findcourse_advice {
  898:     my ($r) = @_;
  899:     my $domdesc = &Apache::lonnet::domain($env{'user.domain'},'description');
  900:     my $esc_dom = &HTML::Entities::encode($env{'user.domain'},'"<>&');
  901:     if (&Apache::lonnet::auto_run(undef,$env{'user.domain'})) {
  902:         $r->print(&mt('If you were expecting to see an active role listed for a particular course in the [_1] domain, it may be missing for one of the following reasons:',$domdesc).'
  903: <ul>
  904:  <li>'.&mt('The course has yet to be created.').'</li>
  905:  <li>'.&mt('Automatic enrollment of registered students has not been enabled for the course.').'</li>
  906:  <li>'.&mt('You are in a section of course for which automatic enrollment in the corresponding LON-CAPA course is not active.').'</li>
  907:  <li>'.&mt('The start date for automated enrollment has yet to be reached.').'</li>
  908:  <li>'.&mt('You registered for the course recently and there is a time lag between the time you register, and the time this information becomes available for the update of LON-CAPA course rosters.').'</li>
  909:  </ul>');
  910:     } else {
  911:         $r->print(&mt('If you were expecting to see an active role listed for a particular course, that course may not have been created yet.').'<br />');
  912:     }
  913:     $r->print('<p>'.&mt('The [_1]Course Catalog[_2] provides information about all [_3] classes for which LON-CAPA courses have been created.','<a href="/adm/coursecatalog?showdom='.$esc_dom.'">','</a>',$domdesc).'<br />');
  914:     $r->print(&mt('You can search the course catalog for courses which permit self-enrollment, if you would like to enroll in a course.').'</p>');
  915:     return;
  916: }
  917: 
  918: sub privileges_info {
  919:     my ($which) = @_;
  920:     my $output;
  921: 
  922:     $which ||= $env{'request.role'};
  923: 
  924:     foreach my $envkey (sort(keys(%env))) {
  925: 	next if ($envkey!~/^user\.priv\.\Q$which\E\.(.*)/);
  926: 
  927: 	my $where=$1;
  928: 	my $ttype;
  929: 	my $twhere;
  930: 	my (undef,$tdom,$trest,$tsec)=split(m{/},$where);
  931: 	if ($trest) {
  932: 	    if ($env{'course.'.$tdom.'_'.$trest.'.description'} eq 'ca') {
  933: 		$ttype='Construction Space';
  934: 		$twhere='User: '.$trest.', Domain: '.$tdom;
  935: 	    } else {
  936: 		$ttype= &Apache::loncommon::course_type($tdom.'_'.$trest);
  937: 		$twhere=$env{'course.'.$tdom.'_'.$trest.'.description'};
  938: 		if ($tsec) {
  939: 		    my $sec_type = 'Section';
  940: 		    if (exists($env{"user.role.gr.$where"})) {
  941: 			$sec_type = 'Group';
  942: 		    }
  943: 		    $twhere.=' ('.$sec_type.': '.$tsec.')';
  944: 		}
  945: 	    }
  946: 	} elsif ($tdom) {
  947: 	    $ttype='Domain';
  948: 	    $twhere=$tdom;
  949: 	} else {
  950: 	    $ttype='System';
  951: 	    $twhere='/';
  952: 	}
  953: 	$output .= "\n<h3>".&mt($ttype).': '.$twhere.'</h3>'."\n<ul>";
  954: 	foreach my $priv (sort(split(/:/,$env{$envkey}))) {
  955: 	    next if (!$priv);
  956: 
  957: 	    my ($prv,$restr)=split(/\&/,$priv);
  958: 	    my $trestr='';
  959: 	    if ($restr ne 'F') {
  960: 		$trestr.=' ('.
  961: 		    join(', ',
  962: 			 map { &Apache::lonnet::plaintext($_) } 
  963: 			     (split('',$restr))).') ';
  964: 	    }
  965: 	    $output .= "\n\t".
  966: 		'<li>'.&Apache::lonnet::plaintext($prv).$trestr.'</li>';
  967: 	}
  968: 	$output .= "\n".'</ul>';
  969:     }
  970:     return $output;
  971: }
  972: 
  973: sub role_status {
  974:     my ($rolekey,$then,$now,$role,$where,$trolecode,$tstatus,$tstart,$tend) = @_;
  975:     my @pwhere = ();
  976:     if (exists($env{$rolekey}) && $env{$rolekey} ne '') {
  977:         (undef,undef,$$role,@pwhere)=split(/\./,$rolekey);
  978:         unless (!defined($$role) || $$role eq '') {
  979:             $$where=join('.',@pwhere);
  980:             $$trolecode=$$role.'.'.$$where;
  981:             ($$tstart,$$tend)=split(/\./,$env{$rolekey});
  982:             $$tstatus='is';
  983:             if ($$tstart && $$tstart>$then) {
  984: 		$$tstatus='future';
  985: 		if ($$tstart<$now) { $$tstatus='will'; }
  986:             }
  987:             if ($$tend) {
  988:                 if ($$tend<$then) {
  989:                     $$tstatus='expired';
  990:                 } elsif ($$tend<$now) {
  991:                     $$tstatus='will_not';
  992:                 }
  993:             }
  994:         }
  995:     }
  996: }
  997: 
  998: sub build_roletext {
  999:     my ($trolecode,$tdom,$trest,$tstatus,$tryagain,$advanced,$tremark,$tbg,$tfont,$trole,$twhere,$tpstart,$tpend,$nochoose,$button,$switchserver,$reinit) = @_;
 1000:     my $roletext='<tr bgcolor="'.$tbg.'" class="LC_rolesmenu_'.$tstatus.'">';
 1001:     my $is_dc=($trolecode =~ m/^dc\./);
 1002:     my $rowspan=($is_dc) ? ''
 1003:                          : ' rowspan="2" ';
 1004: 
 1005:     unless ($nochoose) {
 1006:         my $buttonname=$trolecode;
 1007:         $buttonname=~s/\W//g;
 1008:         if (!$button) {
 1009:             if ($switchserver) {
 1010:                 $roletext.='<td'.$rowspan.'><span class="LC_rolesinfo"><a href="/adm/switchserver?'.
 1011:                 $switchserver.'">'.&mt('Switch Server').'</a></span></td>';
 1012:             } else {
 1013:                 $roletext.=('<td'.$rowspan.'>&nbsp;</td>');
 1014:             }
 1015:         } elsif ($tstatus eq 'is') {
 1016:             $roletext.='<td'.$rowspan.'><input name="'.$buttonname.'" type="button" value="'.
 1017:                         &mt('Select').'" onClick="javascript:enterrole(this.form,\''.
 1018:                         $trolecode."','".$buttonname.'\');" /></td>';
 1019:         } elsif ($tryagain) {
 1020:             $roletext.=
 1021:                 '<td'.$rowspan.'><input name="'.$buttonname.'" type="button" value="'.
 1022:                 &mt('Try Selecting Again').'" onClick="javascript:enterrole(this.form,\''.
 1023:                         $trolecode."','".$buttonname.'\');" /></td>';
 1024:         } elsif ($advanced) {
 1025:             $roletext.=
 1026:                 '<td'.$rowspan.'><input name="'.$buttonname.'" type="button" value="'.
 1027:                 &mt('Re-Initialize').'" onClick="javascript:enterrole(this.form,\''.
 1028:                         $trolecode."','".$buttonname.'\');" /></td>';
 1029:         } elsif ($reinit) {
 1030:             $roletext.= 
 1031:                 '<td'.$rowspan.'><input name="'.$buttonname.'" type="button" value="'.
 1032:                 &mt('Re-Select').'" onClick="javascript:enterrole(this.form,\''.
 1033:                         $trolecode."','".$buttonname.'\');" /></td>';
 1034:         } else {
 1035:             $roletext.=
 1036:                 '<td'.$rowspan.'><input name="'.$buttonname.'" type="button" value="'.
 1037:                 &mt('Re-Initialize').'" onClick="javascript:enterrole(this.form,\''.
 1038:                         $trolecode."','".$buttonname.'\');" /></td>';
 1039:         }
 1040:     }
 1041:     if ($trolecode !~ m/^(dc|ca|au|aa)\./) {
 1042: 	$tremark.=&Apache::lonannounce::showday(time,1,
 1043: 			 &Apache::lonannounce::readcalendar($tdom.'_'.$trest));
 1044:     }
 1045:     $roletext.='<td><font color="'.$tfont.'">'.$trole.
 1046: 	       '</font></td><td><font color="'.$tfont.'">'.$twhere.
 1047:                '</font></td><td><font color="'.$tfont.'">'.$tpstart.
 1048:                '</font></td><td><font color="'.$tfont.'">'.$tpend.
 1049:                '</font></td></tr>';
 1050:     if (!$is_dc) {
 1051: 	$roletext.='<tr bgcolor="'.$tbg.'"><td colspan="4"><font color="'.$tfont.'"><span class="LC_rolesinfo">'.$tremark.
 1052: 	    '</span>&nbsp;</font></td></tr><tr><td colspan="5" height="3"></td></tr>'."\n";
 1053:     }
 1054:     return $roletext;
 1055: }
 1056: 
 1057: sub check_needs_switchserver {
 1058:     my ($possiblerole) = @_;
 1059:     my $needs_switchserver;
 1060:     my ($role,$where) = split(/\./,$possiblerole,2);
 1061:     my (undef,$tdom,$twho) = split(/\//,$where);
 1062:     my ($server_status,$home);
 1063:     if (($role eq 'ca') || ($role eq 'aa')) {
 1064:         ($server_status,$home) = &check_author_homeserver($twho,$tdom);
 1065:     } else {
 1066:         ($server_status,$home) = &check_author_homeserver($env{'user.name'},
 1067:                                                           $env{'user.domain'});
 1068:     }
 1069:     if ($server_status eq 'switchserver') {
 1070:         $needs_switchserver = 1;
 1071:     }
 1072:     return $needs_switchserver;
 1073: }
 1074: 
 1075: sub check_author_homeserver {
 1076:     my ($uname,$udom)=@_;
 1077:     if (($uname eq '') || ($udom eq '')) {
 1078:         return ('fail','');
 1079:     }
 1080:     my $home = &Apache::lonnet::homeserver($uname,$udom);
 1081:     if (&Apache::lonnet::host_domain($home) ne $udom) {
 1082:         return ('fail',$home);
 1083:     }
 1084:     my @ids=&Apache::lonnet::current_machine_ids();
 1085:     if (grep(/^\Q$home\E$/,@ids)) {
 1086:         return ('ok',$home);
 1087:     } else {
 1088:         return ('switchserver',$home);
 1089:     }
 1090: }
 1091: 
 1092: sub check_privs {
 1093:     my ($cdom,$cnum,$then,$now,$checkrole) = @_;
 1094:     my $cckey = 'user.role.'.$checkrole.'./'.$cdom.'/'.$cnum; 
 1095:     if ($env{$cckey}) {
 1096:         my ($role,$where,$trolecode,$tstart,$tend,$tremark,$tstatus,$tpstart,$tpend,$tfont);
 1097:         &role_status($cckey,$then,$now,\$role,\$where,\$trolecode,\$tstatus,\$tstart,\$tend);
 1098:         unless (($tstatus eq 'is') || ($tstatus eq 'will_not')) {
 1099:             &set_privileges($cdom,$cnum,$checkrole);
 1100:         }
 1101:     } else {
 1102:         &set_privileges($cdom,$cnum,$checkrole);
 1103:     }
 1104: }
 1105: 
 1106: sub check_fordc {
 1107:     my ($dcroles,$then) = @_;
 1108:     my $numdc = 0;
 1109:     if ($env{'user.adv'}) {
 1110:         foreach my $envkey (sort keys %env) {
 1111:             if ($envkey=~/^user\.role\.dc\.\/($match_domain)\/$/) {
 1112:                 my $dcdom = $1;
 1113:                 my $livedc = 1;
 1114:                 my ($tstart,$tend)=split(/\./,$env{$envkey});
 1115:                 if ($tstart && $tstart>$then) { $livedc = 0; }
 1116:                 if ($tend   && $tend  <$then) { $livedc = 0; }
 1117:                 if ($livedc) {
 1118:                     $$dcroles{$dcdom} = $envkey;
 1119:                     $numdc++;
 1120:                 }
 1121:             }
 1122:         }
 1123:     }
 1124:     return $numdc;
 1125: }
 1126: 
 1127: sub adhoc_course_role {
 1128:     my ($then) = @_; 
 1129:     my ($cdom,$cnum);
 1130:     $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
 1131:     $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
 1132:     if (&check_forcc($cdom,$cnum,$then)) {
 1133:         my $setprivs;
 1134:         if (!defined($env{'user.role.'.$env{'form.switchrole'}})) {
 1135:             $setprivs = 1;
 1136:         } else {
 1137:             my ($start,$end) = split(/\./,$env{'user.role.'.$env{'form.switchrole'}});
 1138:             if (($start && ($start>$then || $start == -1)) ||
 1139:                 ($end && $end<$then)) {
 1140:                 $setprivs = 1;
 1141:             }
 1142:         } 
 1143:         if ($setprivs) {
 1144:             if ($env{'form.switchrole'} =~ m-^(in|ta|ep|ad|st|cr)([\w/]*)\./\Q$cdom\E/\Q$cnum\E/?(\w*)$-) {
 1145:                 my $role = $1;
 1146:                 my $custom_role = $2;
 1147:                 my $usec = $3;
 1148:                 if ($role eq 'cr') {
 1149:                     if ($custom_role =~ m-^/$match_domain/$match_username/\w+$-) {
 1150:                         $role .= $custom_role;
 1151:                     } else {
 1152:                         return;
 1153:                     }
 1154:                 }
 1155:                 my (%userroles,%newrole,%newgroups,%group_privs);
 1156:                 my %cgroups =
 1157:                     &Apache::lonnet::get_active_groups($env{'user.domain'},
 1158:                                             $env{'user.name'},$cdom,$cnum);
 1159:                 foreach my $group (keys(%cgroups)) {
 1160:                     $group_privs{$group} =
 1161:                         $env{'user.priv.cc./'.$cdom.'/'.$cnum.'./'.$cdom.'/'.$cnum.'/'.$group};
 1162:                 }
 1163:                 $newgroups{'/'.$cdom.'/'.$cnum} = \%group_privs;
 1164:                 my $area = '/'.$cdom.'/'.$cnum;
 1165:                 my $spec = $role.'.'.$area;
 1166:                 if ($usec ne '') {
 1167:                     $spec .= '/'.$usec;
 1168:                     $area .= '/'.$usec;
 1169:                 }
 1170:                 &Apache::lonnet::standard_roleprivs(\%newrole,$role,$cdom,$spec,$cnum,$area);
 1171:                 &Apache::lonnet::set_userprivs(\%userroles,\%newrole,\%newgroups);
 1172:                 my $adhocstart = $then-1;
 1173:                 $userroles{'user.role.'.$spec} = $adhocstart.'.';
 1174:                 &Apache::lonnet::appenv(\%userroles,[$role,'cm']);
 1175:             }
 1176:         }
 1177:     }
 1178:     return;
 1179: }
 1180: 
 1181: sub check_forcc {
 1182:     my ($cdom,$cnum,$then) = @_;
 1183:     my $is_cc;
 1184:     if ($cdom ne '' && $cnum ne '') {
 1185:         if (&Apache::lonnet::is_course($cdom,$cnum)) {
 1186:             my $envkey = 'user.role.cc./'.$cdom.'/'.$cnum;
 1187:             if (defined($env{$envkey})) {
 1188:                 $is_cc = 1;
 1189:                 my ($tstart,$tend)=split(/\./,$env{$envkey});
 1190:                 if ($tstart && $tstart>$then) { $is_cc = 0; }
 1191:                 if ($tend   && $tend  <$then) { $is_cc = 0; }
 1192:             }
 1193:         }
 1194:     }
 1195:     return $is_cc;
 1196: }
 1197: 
 1198: sub courselink {
 1199:     my ($dcdom,$rowtype) = @_;
 1200:     my $courseform=&Apache::loncommon::selectcourse_link
 1201:                    ('rolechoice','dccourse'.$rowtype.'_'.$dcdom,
 1202:                     'dcdomain'.$rowtype.'_'.$dcdom,'coursedesc'.$rowtype.'_'.
 1203:                     $dcdom,$dcdom,undef);
 1204:     my $hiddenitems = '<input type="hidden" name="dcdomain'.$rowtype.'_'.$dcdom.'" value="'.$dcdom.'" />'.
 1205:                       '<input type="hidden" name="origdom'.$rowtype.'_'.$dcdom.'" value="'.$dcdom.'" />'.
 1206:                       '<input type="hidden" name="dccourse'.$rowtype.'_'.$dcdom.'" value="" />'.
 1207:                       '<input type="hidden" name="coursedesc'.$rowtype.'_'.$dcdom.'" value="" />';
 1208:     return $courseform.$hiddenitems;
 1209: }
 1210: 
 1211: sub coursepick_jscript {
 1212:     my %lt = &Apache::lonlocal::texthash(
 1213:                   plsu => "Please use the 'Select Course' link to open a separate pick course window where you may select the course you wish to enter.",
 1214:                   youc => 'You can only use this screen to select courses in the current domain.',
 1215:              );
 1216:     my $verify_script = <<"END";
 1217: <script type="text/javascript">
 1218: function verifyCoursePick(caller) {
 1219:     var numbutton = getIndex(caller)
 1220:     var pickedCourse = document.rolechoice.elements[numbutton+4].value
 1221:     var pickedDomain = document.rolechoice.elements[numbutton+2].value
 1222:     if (document.rolechoice.elements[numbutton+2].value == document.rolechoice.elements[numbutton+3].value) {
 1223:         if (pickedCourse != '') {
 1224:             if (numbutton != -1) {
 1225:                 var courseTarget = "cc./"+pickedDomain+"/"+pickedCourse
 1226:                 document.rolechoice.elements[numbutton+1].name = courseTarget
 1227:                 document.rolechoice.submit()
 1228:             }
 1229:         }
 1230:         else {
 1231:             alert("$lt{'plsu'}");
 1232:         }
 1233:     }
 1234:     else {
 1235:         alert("$lt{'youc'}")
 1236:     }
 1237: }
 1238: function getIndex(caller) {
 1239:     for (var i=0;i<document.rolechoice.elements.length;i++) {
 1240:         if (document.rolechoice.elements[i] == caller) {
 1241:             return i;
 1242:         }
 1243:     }
 1244:     return -1;
 1245: }
 1246: </script>
 1247: END
 1248:     return $verify_script;
 1249: }
 1250: 
 1251: sub coauthorlink {
 1252:     my ($dcdom,$rowtype) = @_;
 1253:     my $coauthorform=&Apache::loncommon::selectauthor_link('rolechoice',$dcdom);
 1254:     my $hiddenitems = '<input type="hidden" name="adhoccauname'.$rowtype.'_'.$dcdom.'" value="" />';
 1255:     return $coauthorform.$hiddenitems;
 1256: }
 1257: 
 1258: sub display_cc_role {
 1259:     my $rolekey = shift;
 1260:     my $roletext;
 1261:     my $advanced = $env{'user.adv'};
 1262:     my $tryagain = $env{'form.tryagain'};
 1263:     unless ($rolekey =~/^error\:/) {
 1264:         if ($rolekey =~ m-^user\.role.cc\./($match_domain)/($match_courseid)$-) {
 1265:             my $tcourseid = $1.'_'.$2;
 1266:             my $trolecode = 'cc./'.$1.'/'.$2;
 1267:             my $twhere;
 1268:             my $ttype;
 1269:             my $tbg='#77FF77';
 1270:             my $tfont='#003300';
 1271:             my %newhash=&Apache::lonnet::coursedescription($tcourseid);
 1272:             if (%newhash) {
 1273:                 $twhere=$newhash{'description'}.
 1274:                         ' <font size="-2">'.
 1275:                         &Apache::loncommon::syllabuswrapper(&mt('Syllabus'),$2,$1,$tfont).
 1276:                         '</font>';
 1277:                 $ttype = $newhash{'type'};
 1278:             } else {
 1279:                 $twhere=&mt('Currently not available');
 1280:                 $env{'course.'.$tcourseid.'.description'}=$twhere;
 1281:             }
 1282:             my $trole = &Apache::lonnet::plaintext('cc',$ttype);
 1283:             $twhere.="<br />".&mt('Domain').":".$1;
 1284:             $roletext = &build_roletext($trolecode,$1,$2,'is',$tryagain,$advanced,'',$tbg,$tfont,$trole,$twhere,'','','',1,'');
 1285:         }
 1286:     }
 1287:     return ($roletext);
 1288: }
 1289: 
 1290: sub adhoc_roles_row {
 1291:     my ($dcdom,$rowtype) = @_;
 1292:     my $output = '<tr bgcolor="#77FF77">'.
 1293:                  ' <td colspan="5"><table><tr><td><span class="LC_rolesinfo">'
 1294:                  .&mt('[_1]Ad hoc[_2] roles in domain [_3] --',
 1295:                  '<span class="LC_cusr_emph">','</span>',$dcdom).'</span></td><td>';
 1296:     my $selectcclink = &courselink($dcdom,$rowtype);
 1297:     my $ccrole = &Apache::lonnet::plaintext('cc');
 1298:     my $carole = &Apache::lonnet::plaintext('ca');
 1299:     my $selectcalink = &coauthorlink($dcdom,$rowtype);
 1300:     $output.= '<span class="LC_rolesinfo">'.
 1301:             &mt('[_1]: [_2]',$ccrole,$selectcclink).
 1302:             '</span><br /></td><td>&nbsp;&nbsp;</td><td><span class="LC_rolesinfo">'.
 1303:             &mt('[_1]: [_2]',$carole,$selectcalink).
 1304:             '</span><br /></td></tr></table></td></tr>'.
 1305:             '<tr><td colspan="5" height="3"></td></tr>'."\n";
 1306:     return $output;
 1307: }
 1308: 
 1309: sub recent_filename {
 1310:     my $area=shift;
 1311:     return 'nohist_recent_'.&escape($area);
 1312: }
 1313: 
 1314: sub set_privileges {
 1315: # role can be cc or ca
 1316:     my ($dcdom,$pickedcourse,$role) = @_;
 1317:     my $area = '/'.$dcdom.'/'.$pickedcourse;
 1318:     my $spec = $role.'.'.$area;
 1319:     my %userroles = &Apache::lonnet::set_arearole($role,$area,'','',
 1320: 						  $env{'user.domain'},
 1321: 						  $env{'user.name'});
 1322:     my %ccrole = ();
 1323:     &Apache::lonnet::standard_roleprivs(\%ccrole,$role,$dcdom,$spec,$pickedcourse,$area);
 1324:     my ($author,$adv)= &Apache::lonnet::set_userprivs(\%userroles,\%ccrole);
 1325:     &Apache::lonnet::appenv(\%userroles,[$role,'cm']);
 1326: 
 1327:     &Apache::lonnet::log($env{'user.domain'},
 1328:                          $env{'user.name'},
 1329:                          $env{'user.home'},
 1330:                         "Role ".$role);
 1331:     &Apache::lonnet::appenv(
 1332:                           {'request.role'        => $spec,
 1333:                           'request.role.domain' => $dcdom,
 1334:                           'request.course.sec'  => ''});
 1335:     my $tadv=0;
 1336:     if (&Apache::lonnet::allowed('adv') eq 'F') { $tadv=1; }
 1337:     &Apache::lonnet::appenv({'request.role.adv'    => $tadv});
 1338: }
 1339: 
 1340: sub courseloadpage {
 1341:     my ($courseid) = @_;
 1342:     my $startpage;
 1343:     my %entry_settings = &Apache::lonnet::get('nohist_whatsnew',
 1344: 					      [$courseid.':courseinit']);
 1345:     my ($tmp) = %entry_settings;
 1346:     unless ($tmp =~ /^error: 2 /) {
 1347:         $startpage = $entry_settings{$courseid.':courseinit'};
 1348:     }
 1349:     if ($startpage eq '') {
 1350:         if (exists($env{'environment.course_init_display'})) {
 1351:             $startpage = $env{'environment.course_init_display'};
 1352:         }
 1353:     }
 1354:     return $startpage;
 1355: }
 1356: 
 1357: 1;
 1358: __END__
 1359: 
 1360: =head1 NAME
 1361: 
 1362: Apache::lonroles - User Roles Screen
 1363: 
 1364: =head1 SYNOPSIS
 1365: 
 1366: Invoked by /etc/httpd/conf/srm.conf:
 1367: 
 1368:  <Location /adm/roles>
 1369:  PerlAccessHandler       Apache::lonacc
 1370:  SetHandler perl-script
 1371:  PerlHandler Apache::lonroles
 1372:  ErrorDocument     403 /adm/login
 1373:  ErrorDocument	  500 /adm/errorhandler
 1374:  </Location>
 1375: 
 1376: =head1 OVERVIEW
 1377: 
 1378: =head2 Choosing Roles
 1379: 
 1380: C<lonroles> is a handler that allows a user to switch roles in
 1381: mid-session. LON-CAPA attempts to work with "No Role Specified", the
 1382: default role that a user has before selecting a role, as widely as
 1383: possible, but certain handlers for example need specification which
 1384: course they should act on, etc. Both in this scenario, and when the
 1385: handler determines via C<lonnet>'s C<&allowed> function that a certain
 1386: action is not allowed, C<lonroles> is used as error handler. This
 1387: allows the user to select another role which may have permission to do
 1388: what they were trying to do. C<lonroles> can also be accessed via the
 1389: B<CRS> button in the Remote Control. 
 1390: 
 1391: =begin latex
 1392: 
 1393: \begin{figure}
 1394: \begin{center}
 1395: \includegraphics[width=0.45\paperwidth,keepaspectratio]{Sample_Roles_Screen}
 1396:   \caption{\label{Sample_Roles_Screen}Sample Roles Screen} 
 1397: \end{center}
 1398: \end{figure}
 1399: 
 1400: =end latex
 1401: 
 1402: =head2 Role Initialization
 1403: 
 1404: 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.
 1405: 
 1406: =head1 INTRODUCTION
 1407: 
 1408: This module enables a user to select what role he wishes to
 1409: operate under (instructor, student, teaching assistant, course
 1410: coordinator, etc).  These roles are pre-established by the actions
 1411: of upper-level users.
 1412: 
 1413: This is part of the LearningOnline Network with CAPA project
 1414: described at http://www.lon-capa.org.
 1415: 
 1416: =head1 HANDLER SUBROUTINE
 1417: 
 1418: This routine is called by Apache and mod_perl.
 1419: 
 1420: =over 4
 1421: 
 1422: =item *
 1423: 
 1424: Roles Initialization (yes/no)
 1425: 
 1426: =item *
 1427: 
 1428: Get Error Message from Environment
 1429: 
 1430: =item *
 1431: 
 1432: Who is this?
 1433: 
 1434: =item *
 1435: 
 1436: Generate Page Output
 1437: 
 1438: =item *
 1439: 
 1440: Choice or no choice
 1441: 
 1442: =item *
 1443: 
 1444: Table
 1445: 
 1446: =item *
 1447: 
 1448: Privileges
 1449: 
 1450: =back
 1451: 
 1452: =cut

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