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