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