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