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