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