1: # The LearningOnline Network with CAPA
2: # User Roles Screen
3: #
4: # $Id: lonroles.pm,v 1.178 2007/09/10 11:44:00 www 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: package Apache::lonroles;
31:
32: use strict;
33: use Apache::lonnet;
34: use Apache::lonuserstate();
35: use Apache::Constants qw(:common);
36: use Apache::File();
37: use Apache::lonmenu;
38: use Apache::loncommon;
39: use Apache::lonhtmlcommon;
40: use Apache::lonannounce;
41: use Apache::lonlocal;
42: use Apache::lonpageflip();
43: use Apache::lonnavdisplay();
44: use GDBM_File;
45: use LONCAPA qw(:DEFAULT :match);
46:
47:
48: sub redirect_user {
49: my ($r,$title,$url,$msg,$launch_nav) = @_;
50: $msg = $title if (! defined($msg));
51: &Apache::loncommon::content_type($r,'text/html');
52: &Apache::loncommon::no_cache($r);
53: $r->send_http_header;
54: my $swinfo=&Apache::lonmenu::rawconfig();
55: my $navwindow;
56: if ($launch_nav eq 'on') {
57: $navwindow.=&Apache::lonnavdisplay::launch_win('now',undef,undef,
58: ($url =~ m-^/adm/whatsnew-));
59: } else {
60: $navwindow.=&Apache::lonnavmaps::close();
61: }
62: my $start_page = &Apache::loncommon::start_page('Switching Role',undef,
63: {'redirect' => [1,$url],});
64: my $end_page = &Apache::loncommon::end_page();
65:
66: # Note to style police:
67: # This must only replace the spaces, nothing else, or it bombs elsewhere.
68: $url=~s/ /\%20/g;
69: $r->print(<<ENDREDIR);
70: $start_page
71: <script type="text/javascript">
72: $swinfo
73: </script>
74: $navwindow
75: <h1>$msg</h1>
76: $end_page
77: ENDREDIR
78: return;
79: }
80:
81: sub error_page {
82: my ($r,$error,$dest)=@_;
83: &Apache::loncommon::content_type($r,'text/html');
84: &Apache::loncommon::no_cache($r);
85: $r->send_http_header;
86: return OK if $r->header_only;
87: $r->print(&Apache::loncommon::start_page('Problems during Course Initialization').
88: '<script type="text/javascript">'.
89: &Apache::lonmenu::rawconfig().'</script>'.
90: '<p>'.&mt('The following problems occurred:').
91: $error.
92: '</p><br /><a href="'.$dest.'">'.&mt('Continue').'</a>'.
93: &Apache::loncommon::end_page());
94: }
95:
96: sub handler {
97:
98: my $r = shift;
99:
100: my $now=time;
101: my $then=$env{'user.login.time'};
102: my $envkey;
103: my %dcroles = ();
104: my $numdc = &check_fordc(\%dcroles,$then);
105: &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'});
106:
107: # ================================================================== Roles Init
108: if ($env{'form.selectrole'}) {
109: if ($env{'form.newrole'}) {
110: $env{'form.'.$env{'form.newrole'}}=1;
111: }
112: if ($env{'request.course.id'}) {
113: my %temp=('logout_'.$env{'request.course.id'} => time);
114: &Apache::lonnet::put('email_status',\%temp);
115: &Apache::lonnet::delenv('user.state.'.$env{'request.course.id'});
116: }
117: &Apache::lonnet::appenv("request.course.id" => '',
118: "request.course.fn" => '',
119: "request.course.uri" => '',
120: "request.course.sec" => '',
121: "request.role" => 'cm',
122: "request.role.adv" => $env{'user.adv'},
123: "request.role.domain" => $env{'user.domain'});
124:
125: # Check if user is a DC trying to enter a course and needs privs to be created
126: if ($numdc > 0) {
127: foreach my $envkey (keys %env) {
128: if (my ($domain,$coursenum) =
129: ($envkey =~ m-^form\.cc\./($match_domain)/($match_courseid)$-)) {
130: if ($dcroles{$domain}) {
131: &check_privs($domain,$coursenum,$then,$now);
132: }
133: last;
134: }
135: }
136: }
137:
138: foreach $envkey (keys %env) {
139: next if ($envkey!~/^user\.role\./);
140: my ($where,$trolecode,$role,$tstatus,$tend,$tstart);
141: &role_status($envkey,$then,$now,\$role,\$where,\$trolecode,\$tstatus,\$tstart,\$tend);
142: if ($env{'form.'.$trolecode}) {
143: if ($tstatus eq 'is') {
144: $where=~s/^\///;
145: my ($cdom,$cnum,$csec)=split(/\//,$where);
146: # check for course groups
147: my %coursegroups = &Apache::lonnet::get_active_groups(
148: $env{'user.domain'},$env{'user.name'},$cdom, $cnum);
149: my $cgrps = join(':',keys(%coursegroups));
150:
151: # store role if recent_role list being kept
152: if ($env{'environment.recentroles'}) {
153: my %frozen_roles =
154: &Apache::lonhtmlcommon::get_recent_frozen('roles',$env{'environment.recentrolesn'});
155: &Apache::lonhtmlcommon::store_recent('roles',
156: $trolecode,' ',$frozen_roles{$trolecode});
157: }
158:
159:
160: # check for keyed access
161: if (($role eq 'st') &&
162: ($env{'course.'.$cdom.'_'.$cnum.'.keyaccess'} eq 'yes')) {
163: # who is key authority?
164: my $authdom=$cdom;
165: my $authnum=$cnum;
166: if ($env{'course.'.$cdom.'_'.$cnum.'.keyauth'}) {
167: ($authnum,$authdom)=
168: split(/:/,$env{'course.'.$cdom.'_'.$cnum.'.keyauth'});
169: }
170: # check with key authority
171: unless (&Apache::lonnet::validate_access_key(
172: $env{'environment.key.'.$cdom.'_'.$cnum},
173: $authdom,$authnum)) {
174: # there is no valid key
175: if ($env{'form.newkey'}) {
176: # student attempts to register a new key
177: &Apache::loncommon::content_type($r,'text/html');
178: &Apache::loncommon::no_cache($r);
179: $r->send_http_header;
180: my $swinfo=&Apache::lonmenu::rawconfig();
181: my $start_page=&Apache::loncommon::start_page
182: ('Verifying Access Key to Unlock this Course');
183: my $end_page=&Apache::loncommon::end_page();
184: my $buttontext=&mt('Enter Course');
185: my $message=&mt('Successfully registered key');
186: my $assignresult=
187: &Apache::lonnet::assign_access_key(
188: $env{'form.newkey'},
189: $authdom,$authnum,
190: $cdom,$cnum,
191: $env{'user.domain'},
192: $env{'user.name'},
193: 'Assigned from '.$ENV{'REMOTE_ADDR'}.' at '.localtime().' for '.
194: $trolecode);
195: unless ($assignresult eq 'ok') {
196: $assignresult=~s/^error\:\s*//;
197: $message=&mt($assignresult).
198: '<br /><a href="/adm/logout">'.
199: &mt('Logout').'</a>';
200: $buttontext=&mt('Re-Enter Key');
201: }
202: $r->print(<<ENDENTEREDKEY);
203: $start_page
204: <script>
205: $swinfo
206: </script>
207: <form method="post">
208: <input type="hidden" name="selectrole" value="1" />
209: <input type="hidden" name="$trolecode" value="1" />
210: <font size="+2">$message</font><br />
211: <input type="submit" value="$buttontext" />
212: </form>
213: $end_page
214: ENDENTEREDKEY
215: return OK;
216: } else {
217: # print form to enter a new key
218: &Apache::loncommon::content_type($r,'text/html');
219: &Apache::loncommon::no_cache($r);
220: $r->send_http_header;
221: my $swinfo=&Apache::lonmenu::rawconfig();
222: my $start_page=&Apache::loncommon::start_page
223: ('Enter Access Key to Unlock this Course');
224: my $end_page=&Apache::loncommon::end_page();
225: $r->print(<<ENDENTERKEY);
226: $start_page
227: <script>
228: $swinfo
229: </script>
230: <form method="post">
231: <input type="hidden" name="selectrole" value="1" />
232: <input type="hidden" name="$trolecode" value="1" />
233: <input type="text" size="20" name="newkey" value="$env{'form.newkey'}" />
234: <input type="submit" value="Enter key" />
235: </form>
236: $end_page
237: ENDENTERKEY
238: return OK;
239: }
240: }
241: }
242: &Apache::lonnet::log($env{'user.domain'},
243: $env{'user.name'},
244: $env{'user.home'},
245: "Role ".$trolecode);
246:
247: &Apache::lonnet::appenv(
248: 'request.role' => $trolecode,
249: 'request.role.domain' => $cdom,
250: 'request.course.sec' => $csec,
251: 'request.course.groups' => $cgrps);
252: my $tadv=0;
253:
254: if (($cnum) && ($role ne 'ca') && ($role ne 'aa')) {
255: my $msg;
256: my ($furl,$ferr)=
257: &Apache::lonuserstate::readmap($cdom.'/'.$cnum);
258: if (($env{'form.orgurl'}) &&
259: ($env{'form.orgurl'}!~/^\/adm\/flip/)) {
260: my $dest=$env{'form.orgurl'};
261: if (&Apache::lonnet::allowed('adv') eq 'F') { $tadv=1; }
262: &Apache::lonnet::appenv('request.role.adv'=>$tadv);
263: if (($ferr) && ($tadv)) {
264: &error_page($r,$ferr,$dest);
265: } else {
266: $r->internal_redirect($dest);
267: }
268: return OK;
269: } else {
270: if (!$env{'request.course.id'}) {
271: &Apache::lonnet::appenv(
272: "request.course.id" => $cdom.'_'.$cnum);
273: $furl='/adm/roles?tryagain=1';
274: $msg=
275: '<h1><span class="LC_error">'.
276: &mt('Could not initialize [_1] at this time.',
277: $env{'course.'.$cdom.'_'.$cnum.'.description'}).
278: '</span></h1><h3>'.&mt('Please try again.').'</h3>'.$ferr;
279: }
280: if (&Apache::lonnet::allowed('adv') eq 'F') { $tadv=1; }
281: &Apache::lonnet::appenv('request.role.adv'=>$tadv);
282:
283: if (($ferr) && ($tadv)) {
284: &error_page($r,$ferr,$furl);
285: } else {
286: # Check to see if the user is a CC entering a course
287: # for the first time
288: my (undef, undef, $role, $courseid) = split(/\./, $envkey);
289: if (substr($courseid, 0, 1) eq '/') {
290: $courseid = substr($courseid, 1);
291: }
292: $courseid =~ s/\//_/;
293: if ($role eq 'cc' && $env{'course.' . $courseid .
294: '.course.helper.not.run'}) {
295: $furl = "/adm/helper/course.initialization.helper";
296: # Send the user to the course they selected
297: } elsif ($env{'request.course.id'}) {
298: if (&Apache::lonnet::allowed('whn',
299: $env{'request.course.id'})
300: || &Apache::lonnet::allowed('whn',
301: $env{'request.course.id'}.'/'
302: .$env{'request.course.sec'})
303: ) {
304: my $startpage = &courseloadpage($courseid);
305: unless ($startpage eq 'firstres') {
306: $msg = &mt('Entering [_1] ....',
307: $env{'course.'.$courseid.'.description'});
308: &redirect_user($r,&mt('New in course'),
309: '/adm/whatsnew?refpage=start',$msg,
310: $env{'environment.remotenavmap'});
311: return OK;
312: }
313: }
314: }
315: # Are we allowed to look at the first resource?
316: if ($furl !~ m|^/adm/|) {
317: # Guess not ...
318: $furl=&Apache::lonpageflip::first_accessible_resource();
319: }
320: $msg = &mt('Entering [_1] ...',
321: $env{'course.'.$courseid.'.description'});
322: &redirect_user($r,&mt('Entering [_1]',
323: $env{'course.'.$courseid.'.description'}),
324: $furl,$msg,
325: $env{'environment.remotenavmap'});
326: }
327: return OK;
328: }
329: }
330: #
331: # Send the user to the construction space they selected
332: if ($role =~ /^(au|ca|aa)$/) {
333: my $redirect_url = '/priv/';
334: if ($role eq 'au') {
335: $redirect_url.=$env{'user.name'};
336: } else {
337: $where =~ /\/(.*)$/;
338: $redirect_url .= $1;
339: }
340: $redirect_url .= '/';
341: &redirect_user($r,&mt('Entering Construction Space'),
342: $redirect_url);
343: return OK;
344: }
345: if ($role eq 'dc') {
346: my $redirect_url = '/adm/menu/';
347: &redirect_user($r,&mt('Loading Domain Coordinator Menu'),
348: $redirect_url);
349: return OK;
350: }
351: }
352: }
353: }
354: }
355:
356:
357: # =============================================================== No Roles Init
358:
359: &Apache::loncommon::content_type($r,'text/html');
360: &Apache::loncommon::no_cache($r);
361: $r->send_http_header;
362: return OK if $r->header_only;
363:
364: my $swinfo=&Apache::lonmenu::rawconfig();
365: my $start_page=&Apache::loncommon::start_page('User Roles');
366: my $standby=&mt('Role selected. Please stand by.');
367: $standby=~s/\n/\\n/g;
368:
369: $r->print(<<ENDHEADER);
370: $start_page
371: <br />
372: <script>
373: $swinfo
374: window.focus();
375:
376: active=true;
377:
378: function enterrole (thisform,rolecode,buttonname) {
379: if (active) {
380: active=false;
381: document.title='$standby';
382: window.status='$standby';
383: thisform.newrole.value=rolecode;
384: thisform.submit();
385: } else {
386: alert('$standby');
387: }
388: }
389: </script>
390: ENDHEADER
391:
392: # ------------------------------------------ Get Error Message from Environment
393:
394: my ($fn,$priv,$nochoose,$error,$msg)=split(/:/,$env{'user.error.msg'});
395: if ($env{'user.error.msg'}) {
396: $r->log_reason(
397: "$msg for $env{'user.name'} domain $env{'user.domain'} access $priv",$fn);
398: }
399:
400: # ------------------------------------------------- Can this user re-init, etc?
401:
402: my $advanced=$env{'user.adv'};
403: &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},['tryagain']);
404: my $tryagain=$env{'form.tryagain'};
405:
406: # -------------------------------------------------------- Generate Page Output
407: # --------------------------------------------------------------- Error Header?
408: if ($error) {
409: $r->print("<h1>LON-CAPA Access Control</h1>");
410: $r->print("<!-- LONCAPAACCESSCONTROLERRORSCREEN --><hr /><pre>");
411: if ($priv ne '') {
412: $r->print("Access : ".&Apache::lonnet::plaintext($priv)."\n");
413: }
414: if ($fn ne '') {
415: $r->print("Resource: ".&Apache::lonenc::check_encrypt($fn)."\n");
416: }
417: if ($msg ne '') {
418: $r->print("Action : $msg\n");
419: }
420: $r->print("</pre><hr />");
421: my $url=$fn;
422: my $last;
423: if (tie(my %hash,'GDBM_File',$env{'request.course.fn'}.'_symb.db',
424: &GDBM_READER(),0640)) {
425: $last=$hash{'last_known'};
426: untie(%hash);
427: }
428: if ($last) { $fn.='?symb='.&escape($last); }
429:
430: &Apache::londocs::changewarning($r,undef,'You have modified your course recently, [_1] may fix this access problem.',
431: &Apache::lonenc::check_encrypt($fn));
432: } else {
433: if ($env{'user.error.msg'}) {
434: $r->print(
435: '<h3><span class="LC_error">'.
436: &mt('You need to choose another user role or enter a specific course for this function').'</span></h3>');
437: }
438: }
439: # -------------------------------------------------------- Choice or no choice?
440: if ($nochoose) {
441: $r->print("<h2>".&mt('Sorry ...')."</h2>\n<span class='LC_error'>".
442: &mt('This action is currently not authorized.').'</span>'.
443: &Apache::loncommon::end_page());
444: return OK;
445: } else {
446: if (($ENV{'REDIRECT_QUERY_STRING'}) && ($fn)) {
447: $fn.='?'.$ENV{'REDIRECT_QUERY_STRING'};
448: }
449: $r->print('<form method="post" name="rolechoice" action="'.(($fn)?$fn:$r->uri).'">');
450: $r->print('<input type="hidden" name="orgurl" value="'.$fn.'" />');
451: $r->print('<input type="hidden" name="selectrole" value="1" />');
452: $r->print('<input type="hidden" name="newrole" value="" />');
453: }
454: if ($env{'user.adv'}) {
455: $r->print(
456: '<br /><span class="LC_rolesinfo"><label>'.&mt('Show all roles').': <input type="checkbox" name="showall"');
457: if ($env{'form.showall'}) { $r->print(' checked="checked" '); }
458: $r->print(' /></label><input type="submit" value="'.&mt('Display').'" /></span>');
459: }
460:
461: my (%roletext,%sortrole,%roleclass);
462: my $countactive=0;
463: my $inrole=0;
464: my $possiblerole='';
465: foreach $envkey (sort keys %env) {
466: my $button = 1;
467: my $switchserver='';
468: my $roletext;
469: my $sortkey;
470: if ($envkey=~/^user\.role\./) {
471: my ($role,$where,$trolecode,$tstart,$tend,$tremark,$tstatus,$tpstart,$tpend,$tfont);
472: &role_status($envkey,$then,$now,\$role,\$where,\$trolecode,\$tstatus,\$tstart,\$tend);
473: next if (!defined($role) || $role eq '' || $role =~ /^gr/);
474: $tremark='';
475: $tpstart=' ';
476: $tpend=' ';
477: $tfont='#000000';
478: if ($tstart) {
479: $tpstart=&Apache::lonlocal::locallocaltime($tstart);
480: }
481: if ($tend) {
482: $tpend=&Apache::lonlocal::locallocaltime($tend);
483: }
484: if ($env{'request.role'} eq $trolecode) {
485: $tstatus='selected';
486: }
487: my $tbg;
488: if (($tstatus eq 'is')
489: || ($tstatus eq 'selected')
490: || ($tstatus eq 'will')
491: || ($tstatus eq 'future')
492: || ($env{'form.showall'})) {
493: if ($tstatus eq 'is') {
494: $tbg='#77FF77';
495: $tfont='#003300';
496: $possiblerole=$trolecode;
497: $countactive++;
498: } elsif ($tstatus eq 'future') {
499: $tbg='#FFFF77';
500: $button=0;
501: } elsif ($tstatus eq 'will') {
502: $tbg='#FFAA77';
503: $tremark.=&mt('Active at next login. ');
504: } elsif ($tstatus eq 'expired') {
505: $tbg='#FF7777';
506: $tfont='#330000';
507: $button=0;
508: } elsif ($tstatus eq 'will_not') {
509: $tbg='#AAFF77';
510: $tremark.=&mt('Expired after logout. ');
511: } elsif ($tstatus eq 'selected') {
512: $tbg='#11CC55';
513: $tfont='#002200';
514: $inrole=1;
515: $countactive++;
516: $tremark.=&mt('Currently selected. ');
517: }
518: my $trole;
519: if ($role =~ /^cr\//) {
520: my ($rdummy,$rdomain,$rauthor,$rrole)=split(/\//,$role);
521: if ($tremark) { $tremark.='<br />'; }
522: $tremark.=&mt('Defined by ').$rauthor.
523: &mt(' at ').$rdomain.'.';
524: }
525: $trole=Apache::lonnet::plaintext($role);
526: my $ttype;
527: my $twhere;
528: my ($tdom,$trest,$tsection)=
529: split(/\//,Apache::lonnet::declutter($where));
530: # First, Co-Authorship roles
531: if (($role eq 'ca') || ($role eq 'aa')) {
532: my $home = &Apache::lonnet::homeserver($trest,$tdom);
533: my $allowed=0;
534: my @ids=&Apache::lonnet::current_machine_ids();
535: foreach my $id (@ids) { if ($id eq $home) { $allowed=1; } }
536: if (!$allowed) {
537: $button=0;
538: $switchserver='otherserver='.$home.'&role='.$trolecode;
539: }
540: #next if ($home eq 'no_host');
541: $home = &Apache::lonnet::hostname($home);
542: $ttype='Construction Space';
543: $twhere=&mt('User').': '.$trest.'<br />'.&mt('Domain').
544: ': '.$tdom.'<br />'.
545: ' '.&mt('Server').': '.$home;
546: $env{'course.'.$tdom.'_'.$trest.'.description'}='ca';
547: $tremark.=&Apache::lonhtmlcommon::authorbombs('/res/'.$tdom.'/'.$trest.'/');
548: $sortkey=$role."$trest:$tdom";
549: } elsif ($role eq 'au') {
550: # Authors
551: my $home = &Apache::lonnet::homeserver
552: ($env{'user.name'},$env{'user.domain'});
553: my $allowed=0;
554: my @ids=&Apache::lonnet::current_machine_ids();
555: foreach my $id (@ids) { if ($id eq $home) { $allowed=1; } }
556: if (!$allowed) {
557: $button=0;
558: $switchserver='otherserver='.$home.'&role='.$trolecode;
559: }
560: #next if ($home eq 'no_host');
561: $home = &Apache::lonnet::hostname($home);
562: $ttype='Construction Space';
563: $twhere=&mt('Domain').': '.$tdom.'<br />'.&mt('Server').
564: ': '.$home;
565: $env{'course.'.$tdom.'_'.$trest.'.description'}='ca';
566: $tremark.=&Apache::lonhtmlcommon::authorbombs('/res/'.$tdom.'/'.$env{'user.name'}.'/');
567: $sortkey=$role;
568: } elsif ($trest) {
569: my $tcourseid=$tdom.'_'.$trest;
570: $ttype = &Apache::loncommon::course_type($tcourseid);
571: $trole = &Apache::lonnet::plaintext($role,$ttype);
572: if ($env{'course.'.$tcourseid.'.description'}) {
573: $twhere=$env{'course.'.$tcourseid.'.description'};
574: $sortkey=$role."\0".$tdom."\0".$twhere."\0".$envkey;
575: unless ($twhere eq &mt('Currently not available')) {
576: $twhere.=' <font size="-2">'.
577: &Apache::loncommon::syllabuswrapper(&mt('Syllabus'),$trest,$tdom,$tfont).
578: '</font>';
579: }
580: } else {
581: my %newhash=&Apache::lonnet::coursedescription($tcourseid);
582: if (%newhash) {
583: $sortkey=$role."\0".$tdom."\0".$newhash{'description'}.
584: "\0".$envkey;
585: $twhere=$newhash{'description'}.
586: ' <font size="-2">'.
587: &Apache::loncommon::syllabuswrapper(&mt('Syllabus'),$trest,$tdom,$tfont).
588: '</font>';
589: $ttype = $newhash{'type'};
590: $trole = &Apache::lonnet::plaintext($role,$ttype);
591: } else {
592: $twhere=&mt('Currently not available');
593: $env{'course.'.$tcourseid.'.description'}=$twhere;
594: $sortkey=$role."\0".$tdom."\0".$twhere."\0".$envkey;
595: $ttype = 'Unavailable';
596: }
597: }
598: if ($tsection) {
599: $twhere.='<br />'.&mt('Section').': '.$tsection;
600: }
601: if ($role ne 'st') { $twhere.="<br />".&mt('Domain').":".$tdom; }
602: } elsif ($tdom) {
603: $ttype='Domain';
604: $twhere=$tdom;
605: $sortkey=$role.$twhere;
606: } else {
607: $ttype='System';
608: $twhere=&mt('system wide');
609: $sortkey=$role.$twhere;
610: }
611: $roletext.=&build_roletext($trolecode,$tdom,$trest,$tstatus,$tryagain,$advanced,$tremark,$tbg,$tfont,$trole,$twhere,$tpstart,$tpend,$nochoose,$button,$switchserver);
612: $roletext{$envkey}=$roletext;
613: if (!$sortkey) {$sortkey=$twhere."\0".$envkey;}
614: $sortrole{$sortkey}=$envkey;
615: $roleclass{$envkey}=$ttype;
616: }
617: }
618: }
619: # No active roles
620: if ($countactive==0) {
621: if ($inrole) {
622: $r->print('<h2>'.&mt('Currently no additional roles or courses').'</h2>');
623: } else {
624: $r->print('<h2>'.&mt('Currently no active roles or courses').'</h2>');
625: }
626: $r->print('</form>'.&Apache::loncommon::end_page());
627: return OK;
628: # Is there only one choice?
629: } elsif (($countactive==1) && ($env{'request.role'} eq 'cm')) {
630: $r->print('<h3>'.&mt('Please stand by.').'</h3>'.
631: '<input type="hidden" name="'.$possiblerole.'" value="1" />');
632: $r->print("</form>\n");
633: $r->rflush();
634: $r->print('<script>document.forms.rolechoice.submit();</script>');
635: $r->print(&Apache::loncommon::end_page());
636: return OK;
637: }
638: # More than one possible role
639: # ----------------------------------------------------------------------- Table
640: unless (($advanced) || ($nochoose)) {
641: $r->print("<h2>".&mt('Select a Course to Enter')."</h2>\n");
642: }
643: $r->print('<br /><table id="LC_rolesmenu"><tr>');
644: unless ($nochoose) { $r->print('<th> </th>'); }
645: $r->print('<th>'.&mt('User Role').'</th><th>'.&mt('Extent').
646: '</th><th>'.&mt('Start').'</th><th>'.&mt('End').'</th></tr>'."\n");
647: my $doheaders=-1;
648: foreach my $type ('Domain','Construction Space','Course','Unavailable','System') {
649: my $haverole=0;
650: foreach my $which (sort {uc($a) cmp uc($b)} (keys(%sortrole))) {
651: if ($roleclass{$sortrole{$which}} =~ /^\Q$type\E/) {
652: $haverole=1;
653: }
654: }
655: if ($haverole) { $doheaders++; }
656: }
657:
658: if ($env{'environment.recentroles'}) {
659: my %recent_roles =
660: &Apache::lonhtmlcommon::get_recent('roles',$env{'environment.recentrolesn'});
661: my $output='';
662: foreach (sort(keys(%recent_roles))) {
663: if (defined($roletext{'user.role.'.$_})) {
664: $output.=$roletext{'user.role.'.$_};
665: if ($_ =~ m-dc\./($match_domain)/-
666: && $dcroles{$1}) {
667: $output .= &allcourses_row($1,'recent');
668: }
669: } elsif ($numdc > 0) {
670: unless ($_ =~/^error\:/) {
671: $output.=&display_cc_role('user.role.'.$_);
672: }
673: }
674: }
675: if ($output) {
676: $r->print("<tr><td align='center' colspan='5'><font face='arial'>".
677: &mt('Recent Roles')."</font></td>");
678: $r->print($output);
679: $r->print("</tr>");
680: $doheaders ++;
681: }
682: }
683:
684: if ($numdc > 0) {
685: $r->print(&coursepick_jscript());
686: $r->print(&Apache::loncommon::coursebrowser_javascript());
687: }
688: foreach my $type ('Construction Space','Domain','Course','Unavailable','System') {
689: my $output;
690: foreach my $which (sort {uc($a) cmp uc($b)} (keys(%sortrole))) {
691: if ($roleclass{$sortrole{$which}} =~ /^\Q$type\E/) {
692: $output.=$roletext{$sortrole{$which}};
693: if ($sortrole{$which} =~ m-dc\./($match_domain)/-) {
694: if ($dcroles{$1}) {
695: $output .= &allcourses_row($1,'');
696: }
697: }
698: }
699: }
700: if ($output) {
701: if ($doheaders > 0) {
702: $r->print("<tr>".
703: "<td align='center' colspan='5'><font face='arial'>".&mt($type)."</font></td></tr>");
704: }
705: $r->print($output);
706: }
707: }
708: my $tremark='';
709: my $tfont='#003300';
710: if ($env{'request.role'} eq 'cm') {
711: $r->print('<tr bgcolor="#11CC55">');
712: $tremark=&mt('Currently selected. ');
713: $tfont='#002200';
714: } else {
715: $r->print('<tr bgcolor="#77FF77">');
716: }
717: unless ($nochoose) {
718: if ($env{'request.role'} ne 'cm') {
719: $r->print('<td><input type="submit" value="'.
720: &mt('Select').'" name="cm"></td>');
721: } else {
722: $r->print('<td> </td>');
723: }
724: }
725: $r->print('<td colspan="3"><font color="'.$tfont.'"><span class="LC_rolesinfo">'.&mt('No role specified').
726: '</font></span></td><td><font color="'.$tfont.'">'.$tremark.
727: ' </font></td></tr>'."\n");
728:
729: $r->print('</table>');
730: unless ($nochoose) {
731: $r->print("</form>\n");
732: }
733: # ------------------------------------------------------------ Privileges Info
734: if (($advanced) && (($env{'user.error.msg'}) || ($error))) {
735: $r->print('<hr /><h2>Current Privileges</h2>');
736: $r->print(&privileges_info());
737: }
738: $r->print(&Apache::lonnet::getannounce());
739: if ($advanced) {
740: $r->print('<p><small><i>This is LON-CAPA '.
741: $r->dir_config('lonVersion').'</i><br />'.
742: '<a href="/adm/logout">'.&mt('Logout').'</a></small></p>');
743: }
744: $r->print(&Apache::loncommon::end_page());
745: return OK;
746: }
747:
748: sub privileges_info {
749: my ($which) = @_;
750: my $output;
751:
752: $which ||= $env{'request.role'};
753:
754: foreach my $envkey (sort(keys(%env))) {
755: next if ($envkey!~/^user\.priv\.\Q$which\E\.(.*)/);
756:
757: my $where=$1;
758: my $ttype;
759: my $twhere;
760: my (undef,$tdom,$trest,$tsec)=split(m{/},$where);
761: if ($trest) {
762: if ($env{'course.'.$tdom.'_'.$trest.'.description'} eq 'ca') {
763: $ttype='Construction Space';
764: $twhere='User: '.$trest.', Domain: '.$tdom;
765: } else {
766: $ttype= &Apache::loncommon::course_type($tdom.'_'.$trest);
767: $twhere=$env{'course.'.$tdom.'_'.$trest.'.description'};
768: if ($tsec) {
769: my $sec_type = 'Section';
770: if (exists($env{"user.role.gr.$where"})) {
771: $sec_type = 'Group';
772: }
773: $twhere.=' ('.$sec_type.': '.$tsec.')';
774: }
775: }
776: } elsif ($tdom) {
777: $ttype='Domain';
778: $twhere=$tdom;
779: } else {
780: $ttype='System';
781: $twhere='/';
782: }
783: $output .= "\n<h3>".$ttype.': '.$twhere.'</h3>'."\n<ul>";
784: foreach my $priv (sort(split(/:/,$env{$envkey}))) {
785: next if (!$priv);
786:
787: my ($prv,$restr)=split(/\&/,$priv);
788: my $trestr='';
789: if ($restr ne 'F') {
790: $trestr.=' ('.
791: join(', ',
792: map { &Apache::lonnet::plaintext($_) }
793: (split('',$restr))).') ';
794: }
795: $output .= "\n\t".
796: '<li>'.&Apache::lonnet::plaintext($prv).$trestr.'</li>';
797: }
798: $output .= "\n".'</ul>';
799: }
800: return $output;
801: }
802:
803: sub role_status {
804: my ($rolekey,$then,$now,$role,$where,$trolecode,$tstatus,$tstart,$tend) = @_;
805: my @pwhere = ();
806: if (exists($env{$rolekey}) && $env{$rolekey} ne '') {
807: (undef,undef,$$role,@pwhere)=split(/\./,$rolekey);
808: unless (!defined($$role) || $$role eq '') {
809: $$where=join('.',@pwhere);
810: $$trolecode=$$role.'.'.$$where;
811: ($$tstart,$$tend)=split(/\./,$env{$rolekey});
812: $$tstatus='is';
813: if ($$tstart && $$tstart>$then) {
814: $$tstatus='future';
815: if ($$tstart<$now) { $$tstatus='will'; }
816: }
817: if ($$tend) {
818: if ($$tend<$then) {
819: $$tstatus='expired';
820: } elsif ($$tend<$now) {
821: $$tstatus='will_not';
822: }
823: }
824: }
825: }
826: }
827:
828: sub build_roletext {
829: my ($trolecode,$tdom,$trest,$tstatus,$tryagain,$advanced,$tremark,$tbg,$tfont,$trole,$twhere,$tpstart,$tpend,$nochoose,$button,$switchserver) = @_;
830: my $roletext='<tr bgcolor="'.$tbg.'" class="LC_rolesmenu_'.$tstatus.'">';
831: my $is_dc=($trolecode =~ m/^dc\./);
832: my $rowspan=($is_dc) ? ''
833: : ' rowspan="2" ';
834:
835: unless ($nochoose) {
836: my $buttonname=$trolecode;
837: $buttonname=~s/\W//g;
838: if (!$button) {
839: if ($switchserver) {
840: $roletext.='<td'.$rowspan.'><span class="LC_rolesinfo"><a href="/adm/switchserver?'.
841: $switchserver.'">'.&mt('Switch Server').'</a></span></td>';
842: } else {
843: $roletext.=('<td'.$rowspan.'> </td>');
844: }
845: } elsif ($tstatus eq 'is') {
846: $roletext.='<td'.$rowspan.'><input name="'.$buttonname.'" type="button" value="'.
847: &mt('Select').'" onClick="javascript:enterrole(this.form,\''.
848: $trolecode."','".$buttonname.'\');"></td>';
849: } elsif ($tryagain) {
850: $roletext.=
851: '<td'.$rowspan.'><input name="'.$buttonname.'" type="button" value="'.
852: &mt('Try Selecting Again').'" onClick="javascript:enterrole(this.form,\''.
853: $trolecode."','".$buttonname.'\');"></td>';
854: } elsif ($advanced) {
855: $roletext.=
856: '<td'.$rowspan.'><input name="'.$buttonname.'" type="button" value="'.
857: &mt('Re-Initialize').'" onClick="javascript:enterrole(this.form,\''.
858: $trolecode."','".$buttonname.'\');"></td>';
859: } else {
860: $roletext.='<td'.$rowspan.'> </td>';
861: }
862: }
863: if ($trolecode !~ m/^(dc|ca|au|aa)\./) {
864: $tremark.=&Apache::lonannounce::showday(time,1,
865: &Apache::lonannounce::readcalendar($tdom.'_'.$trest));
866: }
867: $roletext.='<td><font color="'.$tfont.'">'.$trole.
868: '</font></td><td><font color="'.$tfont.'">'.$twhere.
869: '</font></td><td><font color="'.$tfont.'">'.$tpstart.
870: '</font></td><td><font color="'.$tfont.'">'.$tpend.
871: '</font></td></tr>';
872: if (!$is_dc) {
873: $roletext.='<tr bgcolor="'.$tbg.'"><td colspan="4"><font color="'.$tfont.'"><span class="LC_rolesinfo">'.$tremark.
874: '</span> </font></td></tr><tr><td colspan="5" height="3"></td></tr>'."\n";
875: }
876: return $roletext;
877: }
878:
879: sub check_privs {
880: my ($cdom,$cnum,$then,$now) = @_;
881: my $cckey = 'user.role.cc./'.$cdom.'/'.$cnum;
882: if ($env{$cckey}) {
883: my ($role,$where,$trolecode,$tstart,$tend,$tremark,$tstatus,$tpstart,$tpend,$tfont);
884: &role_status($cckey,$then,$now,\$role,\$where,\$trolecode,\$tstatus,\$tstart,\$tend);
885: unless (($tstatus eq 'is') || ($tstatus eq 'will_not')) {
886: &set_privileges($cdom,$cnum);
887: }
888: } else {
889: &set_privileges($cdom,$cnum);
890: }
891: }
892:
893: sub check_fordc {
894: my ($dcroles,$then) = @_;
895: my $numdc = 0;
896: if ($env{'user.adv'}) {
897: foreach my $envkey (sort keys %env) {
898: if ($envkey=~/^user\.role\.dc\.\/($match_domain)\/$/) {
899: my $dcdom = $1;
900: my $livedc = 1;
901: my ($tstart,$tend)=split(/\./,$env{$envkey});
902: if ($tstart && $tstart>$then) { $livedc = 0; }
903: if ($tend && $tend <$then) { $livedc = 0; }
904: if ($livedc) {
905: $$dcroles{$dcdom} = $envkey;
906: $numdc++;
907: }
908: }
909: }
910: }
911: return $numdc;
912: }
913:
914: sub courselink {
915: my ($dcdom,$rowtype,$selecttype) = @_;
916: my $courseform=&Apache::loncommon::selectcourse_link
917: ('rolechoice','dccourse'.$rowtype.'_'.$dcdom,
918: 'dcdomain'.$rowtype.'_'.$dcdom,'coursedesc'.$rowtype.'_'.
919: $dcdom,$dcdom,undef);
920: my $hiddenitems = '<input type="hidden" name="dcdomain'.$rowtype.'_'.$dcdom.'" value="'.$dcdom.'" />'.
921: '<input type="hidden" name="origdom'.$rowtype.'_'.$dcdom.'" value="'.$dcdom.'" />'.
922: '<input type="hidden" name="dccourse'.$rowtype.'_'.$dcdom.'" value="" />'.
923: '<input type="hidden" name="coursedesc'.$rowtype.'_'.$dcdom.'" value="" />';
924: return $courseform.$hiddenitems;
925: }
926:
927: sub coursepick_jscript {
928: my $verify_script = <<"END";
929: <script>
930: function verifyCoursePick(caller) {
931: var numbutton = getIndex(caller)
932: var pickedCourse = document.rolechoice.elements[numbutton+4].value
933: var pickedDomain = document.rolechoice.elements[numbutton+2].value
934: if (document.rolechoice.elements[numbutton+2].value == document.rolechoice.elements[numbutton+3].value) {
935: if (pickedCourse != '') {
936: if (numbutton != -1) {
937: var courseTarget = "cc./"+pickedDomain+"/"+pickedCourse
938: document.rolechoice.elements[numbutton+1].name = courseTarget
939: document.rolechoice.submit()
940: }
941: }
942: else {
943: alert("Please use the 'Select Course' link to open a separate pick course window where you may select the course you wish to enter.");
944: }
945: }
946: else {
947: alert("You can only use this screen to select courses in the current domain")
948: }
949: }
950: function getIndex(caller) {
951: for (var i=0;i<document.rolechoice.elements.length;i++) {
952: if (document.rolechoice.elements[i] == caller) {
953: return i;
954: }
955: }
956: return -1;
957: }
958: </script>
959: END
960: return $verify_script;
961: }
962:
963: sub processpick {
964: my $process_pick = <<"END";
965: <script>
966: function process_pick(dom) {
967: var pickedCourse=opener.document.rolechoice.$env{'form.cnumelement'}.value;
968: var pickedDomain=opener.document.rolechoice.$env{'form.cdomelement'}.value;
969: var okDomain = 0;
970:
971: if (pickedDomain == dom) {
972: if (pickedCourse != '') {
973: var courseTarget = "cc./"+pickedDomain+"/"+pickedCourse
974: opener.document.title='Role selected. Please stand by.';
975: opener.status='Role selected. Please stand by.';
976: opener.document.rolechoice.newrole.value=courseTarget
977: opener.document.rolechoice.submit()
978: }
979: } else {
980: alert("You may only use this screen to select courses in the current domain: "+dom+"\\nPlease return to the roles page window and click the 'Select Course' link for domain: "+pickedDomain+",\\n if you are a Domain Coordinator in that domain, and wish to become a Course Coordinator in a course in the domain");
981: }
982: }
983:
984: </script>
985: END
986: return $process_pick;
987: }
988:
989: sub display_cc_role {
990: my $rolekey = shift;
991: my $roletext;
992: my $advanced = $env{'user.adv'};
993: my $tryagain = $env{'form.tryagain'};
994: unless ($rolekey =~/^error\:/) {
995: if ($rolekey =~ m-^user\.role.cc\./($match_domain)/($match_courseid)$-) {
996: my $tcourseid = $1.'_'.$2;
997: my $trolecode = 'cc./'.$1.'/'.$2;
998: my $twhere;
999: my $ttype;
1000: my $tbg='#77FF77';
1001: my $tfont='#003300';
1002: my %newhash=&Apache::lonnet::coursedescription($tcourseid);
1003: if (%newhash) {
1004: $twhere=$newhash{'description'}.
1005: ' <font size="-2">'.
1006: &Apache::loncommon::syllabuswrapper(&mt('Syllabus'),$2,$1,$tfont).
1007: '</font>';
1008: $ttype = $newhash{'type'};
1009: } else {
1010: $twhere=&mt('Currently not available');
1011: $env{'course.'.$tcourseid.'.description'}=$twhere;
1012: }
1013: my $trole = &Apache::lonnet::plaintext('cc',$ttype);
1014: $twhere.="<br />".&mt('Domain').":".$1;
1015: $roletext = &build_roletext($trolecode,$1,$2,'is',$tryagain,$advanced,'',$tbg,$tfont,$trole,$twhere,'','','',1,'');
1016: }
1017: }
1018: return ($roletext);
1019: }
1020:
1021: sub allcourses_row {
1022: my ($dcdom,$rowtype) = @_;
1023: my $output = '<tr bgcolor="#77FF77">'.
1024: ' <td colspan="5">';
1025: my $selectlink = &courselink($dcdom,$rowtype);
1026: my $ccrole = &Apache::lonnet::plaintext('cc');
1027: $output.= '<span class="LC_rolesinfo">'.
1028: &mt('[_1]: [_2] from domain [_3]',$ccrole,$selectlink,$dcdom).
1029: '</span><br /></tr><tr><td colspan="5" height="3"></td></tr>'."\n";
1030: return $output;
1031: }
1032:
1033: sub recent_filename {
1034: my $area=shift;
1035: return 'nohist_recent_'.&escape($area);
1036: }
1037:
1038: sub set_privileges {
1039: my ($dcdom,$pickedcourse) = @_;
1040: my $area = '/'.$dcdom.'/'.$pickedcourse;
1041: my $role = 'cc';
1042: my $spec = $role.'.'.$area;
1043: my %userroles = &Apache::lonnet::set_arearole($role,$area,'','',
1044: $env{'user.domain'},
1045: $env{'user.name'});
1046: my %ccrole = ();
1047: &Apache::lonnet::standard_roleprivs(\%ccrole,$role,$dcdom,$spec,$pickedcourse,$area);
1048: my ($author,$adv)= &Apache::lonnet::set_userprivs(\%userroles,\%ccrole);
1049: &Apache::lonnet::appenv(%userroles);
1050: &Apache::lonnet::log($env{'user.domain'},
1051: $env{'user.name'},
1052: $env{'user.home'},
1053: "Role ".$role);
1054: &Apache::lonnet::appenv(
1055: 'request.role' => $spec,
1056: 'request.role.domain' => $dcdom,
1057: 'request.course.sec' => '');
1058: my $tadv=0;
1059: if (&Apache::lonnet::allowed('adv') eq 'F') { $tadv=1; }
1060: &Apache::lonnet::appenv('request.role.adv' => $tadv);
1061: }
1062:
1063: sub courseloadpage {
1064: my ($courseid) = @_;
1065: my $startpage;
1066: my %entry_settings = &Apache::lonnet::get('nohist_whatsnew',
1067: [$courseid.':courseinit']);
1068: my ($tmp) = %entry_settings;
1069: unless ($tmp =~ /^error: 2 /) {
1070: $startpage = $entry_settings{$courseid.':courseinit'};
1071: }
1072: if ($startpage eq '') {
1073: if (exists($env{'environment.course_init_display'})) {
1074: $startpage = $env{'environment.course_init_display'};
1075: }
1076: }
1077: return $startpage;
1078: }
1079:
1080: 1;
1081: __END__
1082:
1083: =head1 NAME
1084:
1085: Apache::lonroles - User Roles Screen
1086:
1087: =head1 SYNOPSIS
1088:
1089: Invoked by /etc/httpd/conf/srm.conf:
1090:
1091: <Location /adm/roles>
1092: PerlAccessHandler Apache::lonacc
1093: SetHandler perl-script
1094: PerlHandler Apache::lonroles
1095: ErrorDocument 403 /adm/login
1096: ErrorDocument 500 /adm/errorhandler
1097: </Location>
1098:
1099: =head1 OVERVIEW
1100:
1101: =head2 Choosing Roles
1102:
1103: C<lonroles> is a handler that allows a user to switch roles in
1104: mid-session. LON-CAPA attempts to work with "No Role Specified", the
1105: default role that a user has before selecting a role, as widely as
1106: possible, but certain handlers for example need specification which
1107: course they should act on, etc. Both in this scenario, and when the
1108: handler determines via C<lonnet>'s C<&allowed> function that a certain
1109: action is not allowed, C<lonroles> is used as error handler. This
1110: allows the user to select another role which may have permission to do
1111: what they were trying to do. C<lonroles> can also be accessed via the
1112: B<CRS> button in the Remote Control.
1113:
1114: =begin latex
1115:
1116: \begin{figure}
1117: \begin{center}
1118: \includegraphics[width=0.45\paperwidth,keepaspectratio]{Sample_Roles_Screen}
1119: \caption{\label{Sample_Roles_Screen}Sample Roles Screen}
1120: \end{center}
1121: \end{figure}
1122:
1123: =end latex
1124:
1125: =head2 Role Initialization
1126:
1127: 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.
1128:
1129: =head1 INTRODUCTION
1130:
1131: This module enables a user to select what role he wishes to
1132: operate under (instructor, student, teaching assistant, course
1133: coordinator, etc). These roles are pre-established by the actions
1134: of upper-level users.
1135:
1136: This is part of the LearningOnline Network with CAPA project
1137: described at http://www.lon-capa.org.
1138:
1139: =head1 HANDLER SUBROUTINE
1140:
1141: This routine is called by Apache and mod_perl.
1142:
1143: =over 4
1144:
1145: =item *
1146:
1147: Roles Initialization (yes/no)
1148:
1149: =item *
1150:
1151: Get Error Message from Environment
1152:
1153: =item *
1154:
1155: Who is this?
1156:
1157: =item *
1158:
1159: Generate Page Output
1160:
1161: =item *
1162:
1163: Choice or no choice
1164:
1165: =item *
1166:
1167: Table
1168:
1169: =item *
1170:
1171: Privileges
1172:
1173: =back
1174:
1175: =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