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