loncom/auth/lonroles.pm - view

File: [LON-CAPA] / loncom / auth / lonroles.pm
Revision 1.213: download - view: text, annotated - select for diffs
Wed Dec 10 21:46:50 2008 UTC (15 years, 6 months ago) by kaisler
Branches: MAIN
CVS tags: HEAD

Added Breadcrumbs in Sites that dose not have any
Added a parameter bread_crumbs to the start_page function, so it can handel the creation of breadcrumbs

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