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