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