File:
[LON-CAPA] /
loncom /
auth /
lonroles.pm
Revision
1.215:
download - view:
text,
annotated -
select for diffs
Sat Jan 3 00:16:10 2009 UTC (15 years, 4 months ago) by
raeburn
Branches:
MAIN
CVS tags:
HEAD
- Bug 5792.
- Timezones used in start and end dates on roles screen are specific to the role (appropriate course time zone for course roles, otherwise domain default for other roles based on role's domain).
1: # The LearningOnline Network with CAPA
2: # User Roles Screen
3: #
4: # $Id: lonroles.pm,v 1.215 2009/01/03 00:16:10 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: =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=>"/admm/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("<!-- LONCAPAACCESSCONTROLERRORSCREEN --><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: my %timezones;
650: foreach $envkey (sort keys %env) {
651: my $button = 1;
652: my $switchserver='';
653: my $roletext;
654: my $sortkey;
655: if ($envkey=~/^user\.role\./) {
656: my ($role,$where,$trolecode,$tstart,$tend,$tremark,$tstatus,$tpstart,$tpend);
657: &role_status($envkey,$then,$now,\$role,\$where,\$trolecode,\$tstatus,\$tstart,\$tend);
658: next if (!defined($role) || $role eq '' || $role =~ /^gr/);
659: my $timezone = &role_timezone($where,\%timezones);
660: $tremark='';
661: $tpstart=' ';
662: $tpend=' ';
663: if ($tstart) {
664: $tpstart=&Apache::lonlocal::locallocaltime($tstart,$timezone);
665: }
666: if ($tend) {
667: $tpend=&Apache::lonlocal::locallocaltime($tend,$timezone);
668: }
669: if ($env{'request.role'} eq $trolecode) {
670: $tstatus='selected';
671: }
672: my $tbg;
673: if (($tstatus eq 'is')
674: || ($tstatus eq 'selected')
675: || ($tstatus eq 'will')
676: || ($tstatus eq 'future')
677: || ($env{'form.showall'})) {
678: if ($tstatus eq 'is') {
679: $tbg='LC_roles_is';
680: $possiblerole=$trolecode;
681: $countactive++;
682: } elsif ($tstatus eq 'future') {
683: $tbg='LC_roles_future';
684: $button=0;
685: $futureroles{$trolecode} = $tstart.':'.$tend;
686: $countfuture ++;
687: } elsif ($tstatus eq 'will') {
688: $tbg='LC_roles_will';
689: $tremark.=&mt('Active at next login.').' ';
690: $roles_nextlogin{$trolecode} = $tstart.':'.$tend;
691: $countwill ++;
692: } elsif ($tstatus eq 'expired') {
693: $tbg='LC_roles_expired';
694: $button=0;
695: } elsif ($tstatus eq 'will_not') {
696: $tbg='LC_roles_will_not';
697: $tremark.=&mt('Expired after logout.').' ';
698: } elsif ($tstatus eq 'selected') {
699: $tbg='LC_roles_selected';
700: $inrole=1;
701: $countactive++;
702: $tremark.=&mt('Currently selected.').' ';
703: }
704: my $trole;
705: if ($role =~ /^cr\//) {
706: my ($rdummy,$rdomain,$rauthor,$rrole)=split(/\//,$role);
707: if ($tremark) { $tremark.='<br />'; }
708: $tremark.=&mt('Defined by [_1] at [_2].',$rauthor,$rdomain);
709: }
710: $trole=Apache::lonnet::plaintext($role);
711: my $ttype;
712: my $twhere;
713: my ($tdom,$trest,$tsection)=
714: split(/\//,Apache::lonnet::declutter($where));
715: # First, Co-Authorship roles
716: if (($role eq 'ca') || ($role eq 'aa')) {
717: my $home = &Apache::lonnet::homeserver($trest,$tdom);
718: my $allowed=0;
719: my @ids=&Apache::lonnet::current_machine_ids();
720: foreach my $id (@ids) { if ($id eq $home) { $allowed=1; } }
721: if (!$allowed) {
722: $button=0;
723: $switchserver='otherserver='.$home.'&role='.$trolecode;
724: }
725: #next if ($home eq 'no_host');
726: $home = &Apache::lonnet::hostname($home);
727: $ttype='Construction Space';
728: $twhere=&mt('User').': '.$trest.'<br />'.&mt('Domain').
729: ': '.$tdom.'<br />'.
730: ' '.&mt('Server').': '.$home;
731: $env{'course.'.$tdom.'_'.$trest.'.description'}='ca';
732: $tremark.=&Apache::lonhtmlcommon::authorbombs('/res/'.$tdom.'/'.$trest.'/');
733: $sortkey=$role."$trest:$tdom";
734: } elsif ($role eq 'au') {
735: # Authors
736: my $home = &Apache::lonnet::homeserver
737: ($env{'user.name'},$env{'user.domain'});
738: my $allowed=0;
739: my @ids=&Apache::lonnet::current_machine_ids();
740: foreach my $id (@ids) { if ($id eq $home) { $allowed=1; } }
741: if (!$allowed) {
742: $button=0;
743: $switchserver='otherserver='.$home.'&role='.$trolecode;
744: }
745: #next if ($home eq 'no_host');
746: $home = &Apache::lonnet::hostname($home);
747: $ttype='Construction Space';
748: $twhere=&mt('Domain').': '.$tdom.'<br />'.&mt('Server').
749: ': '.$home;
750: $env{'course.'.$tdom.'_'.$trest.'.description'}='ca';
751: $tremark.=&Apache::lonhtmlcommon::authorbombs('/res/'.$tdom.'/'.$env{'user.name'}.'/');
752: $sortkey=$role;
753: } elsif ($trest) {
754: my $tcourseid=$tdom.'_'.$trest;
755: $ttype = &Apache::loncommon::course_type($tcourseid);
756: $trole = &Apache::lonnet::plaintext($role,$ttype);
757: if ($env{'course.'.$tcourseid.'.description'}) {
758: $twhere=$env{'course.'.$tcourseid.'.description'};
759: $sortkey=$role."\0".$tdom."\0".$twhere."\0".$envkey;
760: unless ($twhere eq &mt('Currently not available')) {
761: $twhere.=' <span class="LC_fontsize_small">'.
762: &Apache::loncommon::syllabuswrapper(&mt('Syllabus'),$trest,$tdom).
763: '</span>';
764: }
765: } else {
766: my %newhash=&Apache::lonnet::coursedescription($tcourseid);
767: if (%newhash) {
768: $sortkey=$role."\0".$tdom."\0".$newhash{'description'}.
769: "\0".$envkey;
770: $twhere=$newhash{'description'}.
771: ' <span class="LC_fontsize_small">'.
772: &Apache::loncommon::syllabuswrapper(&mt('Syllabus'),$trest,$tdom).
773: '</span>';
774: $ttype = $newhash{'type'};
775: $trole = &Apache::lonnet::plaintext($role,$ttype);
776: } else {
777: $twhere=&mt('Currently not available');
778: $env{'course.'.$tcourseid.'.description'}=$twhere;
779: $sortkey=$role."\0".$tdom."\0".$twhere."\0".$envkey;
780: $ttype = 'Unavailable';
781: }
782: }
783: if ($tsection) {
784: $twhere.='<br />'.&mt('Section').': '.$tsection;
785: }
786: if ($role ne 'st') { $twhere.="<br />".&mt('Domain').":".$tdom; }
787: } elsif ($tdom) {
788: $ttype='Domain';
789: $twhere=$tdom;
790: $sortkey=$role.$twhere;
791: } else {
792: $ttype='System';
793: $twhere=&mt('system wide');
794: $sortkey=$role.$twhere;
795: }
796: $roletext.=&build_roletext($trolecode,$tdom,$trest,$tstatus,$tryagain,$advanced,$tremark,$tbg,$trole,$twhere,$tpstart,$tpend,$nochoose,$button,$switchserver,$reinit);
797: $roletext{$envkey}=$roletext;
798: if (!$sortkey) {$sortkey=$twhere."\0".$envkey;}
799: $sortrole{$sortkey}=$envkey;
800: $roleclass{$envkey}=$ttype;
801: }
802: }
803: }
804: if ($env{'user.adv'}) {
805: $r->print(
806: '<p><label>'.&mt('Show all roles').': <input type="checkbox" name="showall"');
807: if ($env{'form.showall'}) { $r->print(' checked="checked" '); }
808: $r->print(' /></label><input type="submit" value="'.&mt('Display').'" /></p>');
809: } else {
810: if ($countactive > 0) {
811: my $domdesc = &Apache::lonnet::domain($env{'user.domain'},'description');
812: my $esc_dom = &HTML::Entities::encode($env{'user.domain'},'"<>&');
813: $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>');
814: }
815: }
816:
817: # No active roles
818: if ($countactive==0) {
819: if ($inrole) {
820: $r->print('<h2>'.&mt('Currently no additional roles or courses').'</h2>');
821: } else {
822: $r->print('<h2>'.&mt('Currently no active roles or courses').'</h2>');
823: }
824: &findcourse_advice($r);
825: $r->print('</form>');
826: if ($countfuture) {
827: $r->print(&mt('The following [quant,_1,role,roles] will become active in the future:',$countfuture));
828: my $doheaders = &roletable_headers($r,\%roleclass,\%sortrole,
829: $nochoose);
830: &print_rolerows($r,$doheaders,\%roleclass,\%sortrole,\%dcroles,
831: \%roletext);
832: my $tremark='';
833: my $tbg;
834: if ($env{'request.role'} eq 'cm') {
835: $tbg="LC_roles_selected";
836: $tremark=&mt('Currently selected.').' ';
837: } else {
838: $tbg="LC_roles_is";
839: }
840: $r->print(&Apache::loncommon::start_data_table_row()
841: .'<td class="'.$tbg.'"> </td>'
842: .'<td colspan="3">'
843: .&mt('No role specified')
844: .'</td>'
845: .'<td>'.$tremark.' </td>'
846: .&Apache::loncommon::end_data_table_row()
847: );
848:
849: $r->print(&Apache::loncommon::end_data_table());
850: }
851: $r->print(&Apache::loncommon::end_page());
852: return OK;
853: }
854: # ----------------------------------------------------------------------- Table
855: unless ((!&Apache::lonmenu::show_course()) || ($nochoose) || ($countactive==1)) {
856: $r->print("<h2>".&mt('Select a Course to Enter')."</h2>\n");
857: }
858: my $doheaders = &roletable_headers($r,\%roleclass,\%sortrole,$nochoose);
859: if ($env{'environment.recentroles'}) {
860: my %recent_roles =
861: &Apache::lonhtmlcommon::get_recent('roles',$env{'environment.recentrolesn'});
862: my $output='';
863: foreach (sort(keys(%recent_roles))) {
864: if (defined($roletext{'user.role.'.$_})) {
865: $output.=$roletext{'user.role.'.$_};
866: if ($_ =~ m-dc\./($match_domain)/-
867: && $dcroles{$1}) {
868: $output .= &adhoc_roles_row($1,'recent');
869: }
870: } elsif ($numdc > 0) {
871: unless ($_ =~/^error\:/) {
872: $output.=&display_cc_role('user.role.'.$_);
873: }
874: }
875: }
876: if ($output) {
877: $r->print(&Apache::loncommon::start_data_table_empty_row()
878: .'<td align="center" colspan="5">'
879: .&mt('Recent Roles')
880: .'</td>'
881: .&Apache::loncommon::end_data_table_empty_row()
882: );
883: $r->print($output);
884: $doheaders ++;
885: }
886: }
887:
888: if ($numdc > 0) {
889: $r->print(&coursepick_jscript());
890: $r->print(&Apache::loncommon::coursebrowser_javascript().
891: &Apache::loncommon::authorbrowser_javascript());
892: }
893: &print_rolerows($r,$doheaders,\%roleclass,\%sortrole,\%dcroles,\%roletext);
894: if ($countactive > 1) {
895: my $tremark='';
896: my $tbg;
897: if ($env{'request.role'} eq 'cm') {
898: $tbg="LC_roles_selected";
899: $tremark=&mt('Currently selected.').' ';
900: } else {
901: $tbg="LC_roles_is";
902: }
903: $r->print(&Apache::loncommon::start_data_table_row());
904: unless ($nochoose) {
905: if ($env{'request.role'} ne 'cm') {
906: $r->print('<td class="'.$tbg.'"><input type="submit" value="'.
907: &mt('Select').'" name="cm" /></td>');
908: } else {
909: $r->print('<td class="'.$tbg.'"> </td>');
910: }
911: }
912: $r->print('<td colspan="3">'
913: .&mt('No role specified')
914: .'</td>'
915: .'<td>'.$tremark.' </td>'
916: .&Apache::loncommon::end_data_table_row()
917: );
918: }
919: $r->print(&Apache::loncommon::end_data_table());
920: unless ($nochoose) {
921: $r->print("</form>\n");
922: }
923: # ------------------------------------------------------------ Privileges Info
924: if (($advanced) && (($env{'user.error.msg'}) || ($error))) {
925: $r->print('<hr /><h2>'.&mt('Current Privileges').'</h2>');
926: $r->print(&privileges_info());
927: }
928: $r->print(&Apache::lonnet::getannounce());
929: if ($advanced) {
930: my $esc_dom = &HTML::Entities::encode($env{'user.domain'},'"<>&');
931: $r->print('<p><small><i>'
932: .&mt('This is LON-CAPA [_1]',$r->dir_config('lonVersion'))
933: .'</i><br />'
934: .'<a href="/adm/logout">'.&mt('Logout').'</a> '
935: .'<a href="/adm/coursecatalog?showdom='.$esc_dom.'">'
936: .&mt('Course Catalog')
937: .'</small></p>');
938: }
939: $r->print(&Apache::loncommon::end_page());
940: return OK;
941: }
942:
943: sub role_timezone {
944: my ($where,$timezones) = @_;
945: my $timezone;
946: if (ref($timezones) eq 'HASH') {
947: if ($where =~ m{^/($match_domain)/($match_courseid)}) {
948: my $cdom = $1;
949: my $cnum = $2;
950: if ($cdom && $cnum) {
951: if (!exists($timezones->{$cdom.'_'.$cnum})) {
952: my %timehash =
953: &Apache::lonnet::get('environment',['timezone'],$cdom,$cnum);
954: if ($timehash{'timezone'} eq '') {
955: if (!exists($timezones->{$cdom})) {
956: my %domdefaults =
957: &Apache::lonnet::get_domain_defaults($cdom);
958: if ($domdefaults{'timezone_def'} eq '') {
959: $timezones->{$cdom} = 'local';
960: } else {
961: $timezones->{$cdom} = $domdefaults{'timezone_def'};
962: }
963: }
964: $timezones->{$cdom.'_'.$cnum} = $timezones->{$cdom};
965: } else {
966: $timezones->{$cdom.'_'.$cnum} =
967: &Apache::lonlocal::gettimezone($timehash{'timezone'});
968: }
969: }
970: $timezone = $timezones->{$cdom.'_'.$cnum};
971: }
972: } else {
973: my ($tdom) = ($where =~ m{^/($match_domain)});
974: if ($tdom) {
975: if (!exists($timezones->{$tdom})) {
976: my %domdefaults = &Apache::lonnet::get_domain_defaults($tdom);
977: if ($domdefaults{'timezone_def'} eq '') {
978: $timezones->{$tdom} = 'local';
979: } else {
980: $timezones->{$tdom} = $domdefaults{'timezone_def'};
981: }
982: }
983: $timezone = $timezones->{$tdom};
984: }
985: }
986: if ($timezone eq 'local') {
987: $timezone = undef;
988: }
989: }
990: return $timezone;
991: }
992:
993: sub roletable_headers {
994: my ($r,$roleclass,$sortrole,$nochoose) = @_;
995: my $doheaders;
996: if ((ref($sortrole) eq 'HASH') && (ref($roleclass) eq 'HASH')) {
997: $r->print('<br />'
998: .&Apache::loncommon::start_data_table()
999: .&Apache::loncommon::start_data_table_header_row()
1000: );
1001: if (!$nochoose) { $r->print('<th> </th>'); }
1002: $r->print('<th>'.&mt('User Role').'</th>'
1003: .'<th>'.&mt('Extent').'</th>'
1004: .'<th>'.&mt('Start').'</th>'
1005: .'<th>'.&mt('End').'</th>'
1006: .&Apache::loncommon::end_data_table_header_row()
1007: );
1008: $doheaders=-1;
1009: my @roletypes = &roletypes();
1010: foreach my $type (@roletypes) {
1011: my $haverole=0;
1012: foreach my $which (sort {uc($a) cmp uc($b)} (keys(%{$sortrole}))) {
1013: if ($roleclass->{$sortrole->{$which}} =~ /^\Q$type\E/) {
1014: $haverole=1;
1015: }
1016: }
1017: if ($haverole) { $doheaders++; }
1018: }
1019: }
1020: return $doheaders;
1021: }
1022:
1023: sub roletypes {
1024: my @types = ('Domain','Construction Space','Course','Unavailable','System');
1025: return @types;
1026: }
1027:
1028: sub print_rolerows {
1029: my ($r,$doheaders,$roleclass,$sortrole,$dcroles,$roletext) = @_;
1030: if ((ref($roleclass) eq 'HASH') && (ref($sortrole) eq 'HASH')) {
1031: my @types = &roletypes();
1032: foreach my $type (@types) {
1033: my $output;
1034: foreach my $which (sort {uc($a) cmp uc($b)} (keys(%{$sortrole}))) {
1035: if ($roleclass->{$sortrole->{$which}} =~ /^\Q$type\E/) {
1036: if (ref($roletext) eq 'HASH') {
1037: $output.=$roletext->{$sortrole->{$which}};
1038: if ($sortrole->{$which} =~ m-dc\./($match_domain)/-) {
1039: if (ref($dcroles) eq 'HASH') {
1040: if ($dcroles->{$1}) {
1041: $output .= &adhoc_roles_row($1,'');
1042: }
1043: }
1044: }
1045: }
1046: }
1047: }
1048: if ($output) {
1049: if ($doheaders > 0) {
1050: $r->print(&Apache::loncommon::start_data_table_empty_row()
1051: .'<td align="center" colspan="5">'
1052: .&mt($type)
1053: .'</td>'
1054: .&Apache::loncommon::end_data_table_empty_row()
1055: );
1056: }
1057: $r->print($output);
1058: }
1059: }
1060: }
1061: }
1062:
1063: sub findcourse_advice {
1064: my ($r) = @_;
1065: my $domdesc = &Apache::lonnet::domain($env{'user.domain'},'description');
1066: my $esc_dom = &HTML::Entities::encode($env{'user.domain'},'"<>&');
1067: if (&Apache::lonnet::auto_run(undef,$env{'user.domain'})) {
1068: $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).'
1069: <ul>
1070: <li>'.&mt('The course has yet to be created.').'</li>
1071: <li>'.&mt('Automatic enrollment of registered students has not been enabled for the course.').'</li>
1072: <li>'.&mt('You are in a section of course for which automatic enrollment in the corresponding LON-CAPA course is not active.').'</li>
1073: <li>'.&mt('The start date for automated enrollment has yet to be reached.').'</li>
1074: <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>
1075: </ul>');
1076: } else {
1077: $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 />');
1078: }
1079: $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 />');
1080: $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>');
1081: return;
1082: }
1083:
1084: sub privileges_info {
1085: my ($which) = @_;
1086: my $output;
1087:
1088: $which ||= $env{'request.role'};
1089:
1090: foreach my $envkey (sort(keys(%env))) {
1091: next if ($envkey!~/^user\.priv\.\Q$which\E\.(.*)/);
1092:
1093: my $where=$1;
1094: my $ttype;
1095: my $twhere;
1096: my (undef,$tdom,$trest,$tsec)=split(m{/},$where);
1097: if ($trest) {
1098: if ($env{'course.'.$tdom.'_'.$trest.'.description'} eq 'ca') {
1099: $ttype='Construction Space';
1100: $twhere='User: '.$trest.', Domain: '.$tdom;
1101: } else {
1102: $ttype= &Apache::loncommon::course_type($tdom.'_'.$trest);
1103: $twhere=$env{'course.'.$tdom.'_'.$trest.'.description'};
1104: if ($tsec) {
1105: my $sec_type = 'Section';
1106: if (exists($env{"user.role.gr.$where"})) {
1107: $sec_type = 'Group';
1108: }
1109: $twhere.=' ('.$sec_type.': '.$tsec.')';
1110: }
1111: }
1112: } elsif ($tdom) {
1113: $ttype='Domain';
1114: $twhere=$tdom;
1115: } else {
1116: $ttype='System';
1117: $twhere='/';
1118: }
1119: $output .= "\n<h3>".&mt($ttype).': '.$twhere.'</h3>'."\n<ul>";
1120: foreach my $priv (sort(split(/:/,$env{$envkey}))) {
1121: next if (!$priv);
1122:
1123: my ($prv,$restr)=split(/\&/,$priv);
1124: my $trestr='';
1125: if ($restr ne 'F') {
1126: $trestr.=' ('.
1127: join(', ',
1128: map { &Apache::lonnet::plaintext($_) }
1129: (split('',$restr))).') ';
1130: }
1131: $output .= "\n\t".
1132: '<li>'.&Apache::lonnet::plaintext($prv).$trestr.'</li>';
1133: }
1134: $output .= "\n".'</ul>';
1135: }
1136: return $output;
1137: }
1138:
1139: sub role_status {
1140: my ($rolekey,$then,$now,$role,$where,$trolecode,$tstatus,$tstart,$tend) = @_;
1141: my @pwhere = ();
1142: if (exists($env{$rolekey}) && $env{$rolekey} ne '') {
1143: (undef,undef,$$role,@pwhere)=split(/\./,$rolekey);
1144: unless (!defined($$role) || $$role eq '') {
1145: $$where=join('.',@pwhere);
1146: $$trolecode=$$role.'.'.$$where;
1147: ($$tstart,$$tend)=split(/\./,$env{$rolekey});
1148: $$tstatus='is';
1149: if ($$tstart && $$tstart>$then) {
1150: $$tstatus='future';
1151: if ($$tstart<$now) { $$tstatus='will'; }
1152: }
1153: if ($$tend) {
1154: if ($$tend<$then) {
1155: $$tstatus='expired';
1156: } elsif ($$tend<$now) {
1157: $$tstatus='will_not';
1158: }
1159: }
1160: }
1161: }
1162: }
1163:
1164: sub build_roletext {
1165: my ($trolecode,$tdom,$trest,$tstatus,$tryagain,$advanced,$tremark,$tbg,$trole,$twhere,$tpstart,$tpend,$nochoose,$button,$switchserver,$reinit) = @_;
1166: my $roletext=&Apache::loncommon::start_data_table_row();
1167: my $is_dc=($trolecode =~ m/^dc\./);
1168: my $rowspan=($is_dc) ? ''
1169: : ' rowspan="2" ';
1170:
1171: unless ($nochoose) {
1172: my $buttonname=$trolecode;
1173: $buttonname=~s/\W//g;
1174: if (!$button) {
1175: if ($switchserver) {
1176: $roletext.='<td'.$rowspan.' class="'.$tbg.'">'
1177: .'<a href="/adm/switchserver?'.$switchserver.'">'
1178: .&mt('Switch Server')
1179: .'</a></td>';
1180: } else {
1181: $roletext.=('<td'.$rowspan.' class="'.$tbg.'"> </td>');
1182: }
1183: } elsif ($tstatus eq 'is') {
1184: $roletext.='<td'.$rowspan.' class="'.$tbg.'">'.
1185: '<input name="'.$buttonname.'" type="button" value="'.
1186: &mt('Select').'" onClick="javascript:enterrole(this.form,\''.
1187: $trolecode."','".$buttonname.'\');" /></td>';
1188: } elsif ($tryagain) {
1189: $roletext.=
1190: '<td'.$rowspan.' class="'.$tbg.'">'.
1191: '<input name="'.$buttonname.'" type="button" value="'.
1192: &mt('Try Selecting Again').'" onClick="javascript:enterrole(this.form,\''.
1193: $trolecode."','".$buttonname.'\');" /></td>';
1194: } elsif ($advanced) {
1195: $roletext.=
1196: '<td'.$rowspan.' class="'.$tbg.'">'.
1197: '<input name="'.$buttonname.'" type="button" value="'.
1198: &mt('Re-Initialize').'" onClick="javascript:enterrole(this.form,\''.
1199: $trolecode."','".$buttonname.'\');" /></td>';
1200: } elsif ($reinit) {
1201: $roletext.=
1202: '<td'.$rowspan.' class="'.$tbg.'">'.
1203: '<input name="'.$buttonname.'" type="button" value="'.
1204: &mt('Re-Select').'" onClick="javascript:enterrole(this.form,\''.
1205: $trolecode."','".$buttonname.'\');" /></td>';
1206: } else {
1207: $roletext.=
1208: '<td'.$rowspan.' class="'.$tbg.'">'.
1209: '<input name="'.$buttonname.'" type="button" value="'.
1210: &mt('Re-Initialize').'" onClick="javascript:enterrole(this.form,\''.
1211: $trolecode."','".$buttonname.'\');" /></td>';
1212: }
1213: }
1214: if ($trolecode !~ m/^(dc|ca|au|aa)\./) {
1215: $tremark.=&Apache::lonannounce::showday(time,1,
1216: &Apache::lonannounce::readcalendar($tdom.'_'.$trest));
1217: }
1218: $roletext.='<td>'.$trole.'</td>'
1219: .'<td>'.$twhere.'</td>'
1220: .'<td>'.$tpstart.'</td>'
1221: .'<td>'.$tpend.'</td>'
1222: .&Apache::loncommon::end_data_table_row();
1223: if (!$is_dc) {
1224: $roletext.=&Apache::loncommon::continue_data_table_row()
1225: .'<td colspan="4">'
1226: .$tremark.' '
1227: .'</td>'
1228: .&Apache::loncommon::end_data_table_row();
1229: }
1230: return $roletext;
1231: }
1232:
1233: sub check_needs_switchserver {
1234: my ($possiblerole) = @_;
1235: my $needs_switchserver;
1236: my ($role,$where) = split(/\./,$possiblerole,2);
1237: my (undef,$tdom,$twho) = split(/\//,$where);
1238: my ($server_status,$home);
1239: if (($role eq 'ca') || ($role eq 'aa')) {
1240: ($server_status,$home) = &check_author_homeserver($twho,$tdom);
1241: } else {
1242: ($server_status,$home) = &check_author_homeserver($env{'user.name'},
1243: $env{'user.domain'});
1244: }
1245: if ($server_status eq 'switchserver') {
1246: $needs_switchserver = 1;
1247: }
1248: return $needs_switchserver;
1249: }
1250:
1251: sub check_author_homeserver {
1252: my ($uname,$udom)=@_;
1253: if (($uname eq '') || ($udom eq '')) {
1254: return ('fail','');
1255: }
1256: my $home = &Apache::lonnet::homeserver($uname,$udom);
1257: if (&Apache::lonnet::host_domain($home) ne $udom) {
1258: return ('fail',$home);
1259: }
1260: my @ids=&Apache::lonnet::current_machine_ids();
1261: if (grep(/^\Q$home\E$/,@ids)) {
1262: return ('ok',$home);
1263: } else {
1264: return ('switchserver',$home);
1265: }
1266: }
1267:
1268: sub check_privs {
1269: my ($cdom,$cnum,$then,$now,$checkrole) = @_;
1270: my $cckey = 'user.role.'.$checkrole.'./'.$cdom.'/'.$cnum;
1271: if ($env{$cckey}) {
1272: my ($role,$where,$trolecode,$tstart,$tend,$tremark,$tstatus,$tpstart,$tpend);
1273: &role_status($cckey,$then,$now,\$role,\$where,\$trolecode,\$tstatus,\$tstart,\$tend);
1274: unless (($tstatus eq 'is') || ($tstatus eq 'will_not')) {
1275: &set_privileges($cdom,$cnum,$checkrole);
1276: }
1277: } else {
1278: &set_privileges($cdom,$cnum,$checkrole);
1279: }
1280: }
1281:
1282: sub check_fordc {
1283: my ($dcroles,$then) = @_;
1284: my $numdc = 0;
1285: if ($env{'user.adv'}) {
1286: foreach my $envkey (sort keys %env) {
1287: if ($envkey=~/^user\.role\.dc\.\/($match_domain)\/$/) {
1288: my $dcdom = $1;
1289: my $livedc = 1;
1290: my ($tstart,$tend)=split(/\./,$env{$envkey});
1291: if ($tstart && $tstart>$then) { $livedc = 0; }
1292: if ($tend && $tend <$then) { $livedc = 0; }
1293: if ($livedc) {
1294: $$dcroles{$dcdom} = $envkey;
1295: $numdc++;
1296: }
1297: }
1298: }
1299: }
1300: return $numdc;
1301: }
1302:
1303: sub adhoc_course_role {
1304: my ($then) = @_;
1305: my ($cdom,$cnum);
1306: $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
1307: $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
1308: if (&check_forcc($cdom,$cnum,$then)) {
1309: my $setprivs;
1310: if (!defined($env{'user.role.'.$env{'form.switchrole'}})) {
1311: $setprivs = 1;
1312: } else {
1313: my ($start,$end) = split(/\./,$env{'user.role.'.$env{'form.switchrole'}});
1314: if (($start && ($start>$then || $start == -1)) ||
1315: ($end && $end<$then)) {
1316: $setprivs = 1;
1317: }
1318: }
1319: if ($setprivs) {
1320: if ($env{'form.switchrole'} =~ m-^(in|ta|ep|ad|st|cr)([\w/]*)\./\Q$cdom\E/\Q$cnum\E/?(\w*)$-) {
1321: my $role = $1;
1322: my $custom_role = $2;
1323: my $usec = $3;
1324: if ($role eq 'cr') {
1325: if ($custom_role =~ m-^/$match_domain/$match_username/\w+$-) {
1326: $role .= $custom_role;
1327: } else {
1328: return;
1329: }
1330: }
1331: my (%userroles,%newrole,%newgroups,%group_privs);
1332: my %cgroups =
1333: &Apache::lonnet::get_active_groups($env{'user.domain'},
1334: $env{'user.name'},$cdom,$cnum);
1335: foreach my $group (keys(%cgroups)) {
1336: $group_privs{$group} =
1337: $env{'user.priv.cc./'.$cdom.'/'.$cnum.'./'.$cdom.'/'.$cnum.'/'.$group};
1338: }
1339: $newgroups{'/'.$cdom.'/'.$cnum} = \%group_privs;
1340: my $area = '/'.$cdom.'/'.$cnum;
1341: my $spec = $role.'.'.$area;
1342: if ($usec ne '') {
1343: $spec .= '/'.$usec;
1344: $area .= '/'.$usec;
1345: }
1346: &Apache::lonnet::standard_roleprivs(\%newrole,$role,$cdom,$spec,$cnum,$area);
1347: &Apache::lonnet::set_userprivs(\%userroles,\%newrole,\%newgroups);
1348: my $adhocstart = $then-1;
1349: $userroles{'user.role.'.$spec} = $adhocstart.'.';
1350: &Apache::lonnet::appenv(\%userroles,[$role,'cm']);
1351: }
1352: }
1353: }
1354: return;
1355: }
1356:
1357: sub check_forcc {
1358: my ($cdom,$cnum,$then) = @_;
1359: my $is_cc;
1360: if ($cdom ne '' && $cnum ne '') {
1361: if (&Apache::lonnet::is_course($cdom,$cnum)) {
1362: my $envkey = 'user.role.cc./'.$cdom.'/'.$cnum;
1363: if (defined($env{$envkey})) {
1364: $is_cc = 1;
1365: my ($tstart,$tend)=split(/\./,$env{$envkey});
1366: if ($tstart && $tstart>$then) { $is_cc = 0; }
1367: if ($tend && $tend <$then) { $is_cc = 0; }
1368: }
1369: }
1370: }
1371: return $is_cc;
1372: }
1373:
1374: sub courselink {
1375: my ($dcdom,$rowtype) = @_;
1376: my $courseform=&Apache::loncommon::selectcourse_link
1377: ('rolechoice','dccourse'.$rowtype.'_'.$dcdom,
1378: 'dcdomain'.$rowtype.'_'.$dcdom,'coursedesc'.$rowtype.'_'.
1379: $dcdom,$dcdom,undef);
1380: my $hiddenitems = '<input type="hidden" name="dcdomain'.$rowtype.'_'.$dcdom.'" value="'.$dcdom.'" />'.
1381: '<input type="hidden" name="origdom'.$rowtype.'_'.$dcdom.'" value="'.$dcdom.'" />'.
1382: '<input type="hidden" name="dccourse'.$rowtype.'_'.$dcdom.'" value="" />'.
1383: '<input type="hidden" name="coursedesc'.$rowtype.'_'.$dcdom.'" value="" />';
1384: return $courseform.$hiddenitems;
1385: }
1386:
1387: sub coursepick_jscript {
1388: my %lt = &Apache::lonlocal::texthash(
1389: plsu => "Please use the 'Select Course' link to open a separate pick course window where you may select the course you wish to enter.",
1390: youc => 'You can only use this screen to select courses in the current domain.',
1391: );
1392: my $verify_script = <<"END";
1393: <script type="text/javascript">
1394: function verifyCoursePick(caller) {
1395: var numbutton = getIndex(caller)
1396: var pickedCourse = document.rolechoice.elements[numbutton+4].value
1397: var pickedDomain = document.rolechoice.elements[numbutton+2].value
1398: if (document.rolechoice.elements[numbutton+2].value == document.rolechoice.elements[numbutton+3].value) {
1399: if (pickedCourse != '') {
1400: if (numbutton != -1) {
1401: var courseTarget = "cc./"+pickedDomain+"/"+pickedCourse
1402: document.rolechoice.elements[numbutton+1].name = courseTarget
1403: document.rolechoice.submit()
1404: }
1405: }
1406: else {
1407: alert("$lt{'plsu'}");
1408: }
1409: }
1410: else {
1411: alert("$lt{'youc'}")
1412: }
1413: }
1414: function getIndex(caller) {
1415: for (var i=0;i<document.rolechoice.elements.length;i++) {
1416: if (document.rolechoice.elements[i] == caller) {
1417: return i;
1418: }
1419: }
1420: return -1;
1421: }
1422: </script>
1423: END
1424: return $verify_script;
1425: }
1426:
1427: sub coauthorlink {
1428: my ($dcdom,$rowtype) = @_;
1429: my $coauthorform=&Apache::loncommon::selectauthor_link('rolechoice',$dcdom);
1430: my $hiddenitems = '<input type="hidden" name="adhoccauname'.$rowtype.'_'.$dcdom.'" value="" />';
1431: return $coauthorform.$hiddenitems;
1432: }
1433:
1434: sub display_cc_role {
1435: my $rolekey = shift;
1436: my $roletext;
1437: my $advanced = $env{'user.adv'};
1438: my $tryagain = $env{'form.tryagain'};
1439: unless ($rolekey =~/^error\:/) {
1440: if ($rolekey =~ m-^user\.role.cc\./($match_domain)/($match_courseid)$-) {
1441: my $tcourseid = $1.'_'.$2;
1442: my $trolecode = 'cc./'.$1.'/'.$2;
1443: my $twhere;
1444: my $ttype;
1445: my $tbg='LC_roles_is';
1446: my %newhash=&Apache::lonnet::coursedescription($tcourseid);
1447: if (%newhash) {
1448: $twhere=$newhash{'description'}.
1449: ' <span style="LC_fontsize_small">'.
1450: &Apache::loncommon::syllabuswrapper(&mt('Syllabus'),$2,$1).
1451: '</span>';
1452: $ttype = $newhash{'type'};
1453: } else {
1454: $twhere=&mt('Currently not available');
1455: $env{'course.'.$tcourseid.'.description'}=$twhere;
1456: }
1457: my $trole = &Apache::lonnet::plaintext('cc',$ttype);
1458: $twhere.="<br />".&mt('Domain').":".$1;
1459: $roletext = &build_roletext($trolecode,$1,$2,'is',$tryagain,$advanced,'',$tbg,$trole,$twhere,'','','',1,'');
1460: }
1461: }
1462: return ($roletext);
1463: }
1464:
1465: sub adhoc_roles_row {
1466: my ($dcdom,$rowtype) = @_;
1467: my $output = &Apache::loncommon::continue_data_table_row()
1468: .' <td colspan="5">'
1469: .'<table><tr><td>'
1470: .&mt('[_1]Ad hoc[_2] roles in domain [_3] --'
1471: ,'<span class="LC_cusr_emph">','</span>',$dcdom)
1472: .'</td>'
1473: .'<td>';
1474: my $selectcclink = &courselink($dcdom,$rowtype);
1475: my $ccrole = &Apache::lonnet::plaintext('cc');
1476: my $carole = &Apache::lonnet::plaintext('ca');
1477: my $selectcalink = &coauthorlink($dcdom,$rowtype);
1478: $output.=&mt('[_1]: [_2]',$ccrole,$selectcclink)
1479: .'<br /></td>'
1480: .'<td> </td>'
1481: .'<td>'.&mt('[_1]: [_2]',$carole,$selectcalink).'<br /></td>'
1482: .'</tr></table>'
1483: .'</td>'
1484: .&Apache::loncommon::end_data_table_row();
1485: return $output;
1486: }
1487:
1488: sub recent_filename {
1489: my $area=shift;
1490: return 'nohist_recent_'.&escape($area);
1491: }
1492:
1493: sub set_privileges {
1494: # role can be cc or ca
1495: my ($dcdom,$pickedcourse,$role) = @_;
1496: my $area = '/'.$dcdom.'/'.$pickedcourse;
1497: my $spec = $role.'.'.$area;
1498: my %userroles = &Apache::lonnet::set_arearole($role,$area,'','',
1499: $env{'user.domain'},
1500: $env{'user.name'});
1501: my %ccrole = ();
1502: &Apache::lonnet::standard_roleprivs(\%ccrole,$role,$dcdom,$spec,$pickedcourse,$area);
1503: my ($author,$adv)= &Apache::lonnet::set_userprivs(\%userroles,\%ccrole);
1504: &Apache::lonnet::appenv(\%userroles,[$role,'cm']);
1505:
1506: &Apache::lonnet::log($env{'user.domain'},
1507: $env{'user.name'},
1508: $env{'user.home'},
1509: "Role ".$role);
1510: &Apache::lonnet::appenv(
1511: {'request.role' => $spec,
1512: 'request.role.domain' => $dcdom,
1513: 'request.course.sec' => ''});
1514: my $tadv=0;
1515: if (&Apache::lonnet::allowed('adv') eq 'F') { $tadv=1; }
1516: &Apache::lonnet::appenv({'request.role.adv' => $tadv});
1517: }
1518:
1519: sub courseloadpage {
1520: my ($courseid) = @_;
1521: my $startpage;
1522: my %entry_settings = &Apache::lonnet::get('nohist_whatsnew',
1523: [$courseid.':courseinit']);
1524: my ($tmp) = %entry_settings;
1525: unless ($tmp =~ /^error: 2 /) {
1526: $startpage = $entry_settings{$courseid.':courseinit'};
1527: }
1528: if ($startpage eq '') {
1529: if (exists($env{'environment.course_init_display'})) {
1530: $startpage = $env{'environment.course_init_display'};
1531: }
1532: }
1533: return $startpage;
1534: }
1535:
1536: 1;
1537: __END__
1538:
1539: =head1 NAME
1540:
1541: Apache::lonroles - User Roles Screen
1542:
1543: =head1 SYNOPSIS
1544:
1545: Invoked by /etc/httpd/conf/srm.conf:
1546:
1547: <Location /adm/roles>
1548: PerlAccessHandler Apache::lonacc
1549: SetHandler perl-script
1550: PerlHandler Apache::lonroles
1551: ErrorDocument 403 /adm/login
1552: ErrorDocument 500 /adm/errorhandler
1553: </Location>
1554:
1555: =head1 OVERVIEW
1556:
1557: =head2 Choosing Roles
1558:
1559: C<lonroles> is a handler that allows a user to switch roles in
1560: mid-session. LON-CAPA attempts to work with "No Role Specified", the
1561: default role that a user has before selecting a role, as widely as
1562: possible, but certain handlers for example need specification which
1563: course they should act on, etc. Both in this scenario, and when the
1564: handler determines via C<lonnet>'s C<&allowed> function that a certain
1565: action is not allowed, C<lonroles> is used as error handler. This
1566: allows the user to select another role which may have permission to do
1567: what they were trying to do. C<lonroles> can also be accessed via the
1568: B<CRS> button in the Remote Control.
1569:
1570: =begin latex
1571:
1572: \begin{figure}
1573: \begin{center}
1574: \includegraphics[width=0.45\paperwidth,keepaspectratio]{Sample_Roles_Screen}
1575: \caption{\label{Sample_Roles_Screen}Sample Roles Screen}
1576: \end{center}
1577: \end{figure}
1578:
1579: =end latex
1580:
1581: =head2 Role Initialization
1582:
1583: 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.
1584:
1585: =head1 INTRODUCTION
1586:
1587: This module enables a user to select what role he wishes to
1588: operate under (instructor, student, teaching assistant, course
1589: coordinator, etc). These roles are pre-established by the actions
1590: of upper-level users.
1591:
1592: This is part of the LearningOnline Network with CAPA project
1593: described at http://www.lon-capa.org.
1594:
1595: =head1 HANDLER SUBROUTINE
1596:
1597: This routine is called by Apache and mod_perl.
1598:
1599: =over 4
1600:
1601: =item *
1602:
1603: Roles Initialization (yes/no)
1604:
1605: =item *
1606:
1607: Get Error Message from Environment
1608:
1609: =item *
1610:
1611: Who is this?
1612:
1613: =item *
1614:
1615: Generate Page Output
1616:
1617: =item *
1618:
1619: Choice or no choice
1620:
1621: =item *
1622:
1623: Table
1624:
1625: =item *
1626:
1627: Privileges
1628:
1629: =back
1630:
1631: =cut
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>
![[BACK]](/icons/back.gif){kind=icon}
Return to lonroles.pm CVS log ![[TXT]](/icons/text.gif){kind=icon}
![[DIR]](/icons/dir.gif){kind=icon}
Up to [LON-CAPA] / loncom / auth