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