1: # The LearningOnline Network with CAPA
2: # User Roles Screen
3: #
4: # $Id: lonroles.pm,v 1.160 2006/06/26 21:41:09 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: my $type = 'Course/Group';
270: if (!$env{'request.course.id'}) {
271: $type = &Apache::loncommon::course_type();
272: &Apache::lonnet::appenv(
273: "request.course.id" => $cdom.'_'.$cnum);
274: $furl='/adm/roles?tryagain=1';
275: $msg=
276: '<h1><span class="LC_error">'.
277: &mt('Could not initialize '.lc($type).' at this time.').
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 '.lc($type).' ....');
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 '.lc($type).' ...');
320: &redirect_user($r,&mt('Entering '.$type),
321: $furl,$msg,
322: $env{'environment.remotenavmap'});
323: }
324: return OK;
325: }
326: }
327: #
328: # Send the user to the construction space they selected
329: if ($role =~ /^(au|ca|aa)$/) {
330: my $redirect_url = '/priv/';
331: if ($role eq 'au') {
332: $redirect_url.=$env{'user.name'};
333: } else {
334: $where =~ /\/(.*)$/;
335: $redirect_url .= $1;
336: }
337: $redirect_url .= '/';
338: &redirect_user($r,&mt('Entering Construction Space'),
339: $redirect_url);
340: return OK;
341: }
342: if ($role eq 'dc') {
343: my $redirect_url = '/adm/menu/';
344: &redirect_user($r,&mt('Loading Domain Coordinator Menu'),
345: $redirect_url);
346: return OK;
347: }
348: }
349: }
350: }
351: }
352:
353:
354: # =============================================================== No Roles Init
355:
356: &Apache::loncommon::content_type($r,'text/html');
357: &Apache::loncommon::no_cache($r);
358: $r->send_http_header;
359: return OK if $r->header_only;
360:
361: my $swinfo=&Apache::lonmenu::rawconfig();
362: my $start_page=&Apache::loncommon::start_page('User Roles');
363: my $standby=&mt('Role selected. Please stand by.');
364: $standby=~s/\n/\\n/g;
365: my $helptag='<table><tr><td>'.&Apache::loncommon::help_open_menu('','General Intro','General_Intro','',1,undef,undef,undef,undef,,&mt("Click here for help")).'</td></td></tr></table>';
366: $r->print(<<ENDHEADER);
367: $start_page
368: $helptag<br />
369: <script>
370: $swinfo
371: window.focus();
372:
373: active=true;
374:
375: function enterrole (thisform,rolecode,buttonname) {
376: if (active) {
377: active=false;
378: document.title='$standby';
379: window.status='$standby';
380: thisform.newrole.value=rolecode;
381: thisform.submit();
382: } else {
383: alert('$standby');
384: }
385: }
386: </script>
387: ENDHEADER
388:
389: # ------------------------------------------ Get Error Message from Environment
390:
391: my ($fn,$priv,$nochoose,$error,$msg)=split(/:/,$env{'user.error.msg'});
392: if ($env{'user.error.msg'}) {
393: $r->log_reason(
394: "$msg for $env{'user.name'} domain $env{'user.domain'} access $priv",$fn);
395: }
396:
397: # ------------------------------------------------- Can this user re-init, etc?
398:
399: my $advanced=$env{'user.adv'};
400: &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},['tryagain']);
401: my $tryagain=$env{'form.tryagain'};
402:
403: # -------------------------------------------------------- Generate Page Output
404: # --------------------------------------------------------------- Error Header?
405: if ($error) {
406: $r->print("<h1>LON-CAPA Access Control</h1>");
407: $r->print("<!-- LONCAPAACCESSCONTROLERRORSCREEN --><hr /><pre>Access : ".
408: Apache::lonnet::plaintext($priv)."\n");
409: $r->print("Resource: ".&Apache::lonenc::check_encrypt($fn)."\n");
410: $r->print("Action : $msg\n</pre><hr />");
411: my $url=$fn;
412: my $last;
413: if (tie(my %hash,'GDBM_File',$env{'request.course.fn'}.'_symb.db',
414: &GDBM_READER(),0640)) {
415: $last=$hash{'last_known'};
416: untie(%hash);
417: }
418: if ($last) { $fn.='?symb='.&escape($last); }
419:
420: &Apache::londocs::changewarning($r,undef,'You have modified your course recently, [_1] may fix this access problem.',
421: &Apache::lonenc::check_encrypt($fn));
422: } else {
423: if ($env{'user.error.msg'}) {
424: $r->print(
425: '<h3><span class="LC_error">'.
426: &mt('You need to choose another user role or enter a specific course for this function').'</span></h3>');
427: }
428: }
429: # -------------------------------------------------------- Choice or no choice?
430: if ($nochoose) {
431: $r->print("<h2>".&mt('Sorry ...')."</h2>\n".
432: &mt('This action is currently not authorized.').
433: &Apache::loncommon::end_page());
434: return OK;
435: } else {
436: if ($advanced) {
437: $r->print(&mt("Your home server is ").
438: $Apache::lonnet::hostname{&Apache::lonnet::homeserver
439: ($env{'user.name'},$env{'user.domain'})}.
440: "<br />\n");
441: $r->print(&mt(
442: "Author and Co-Author roles are not available on servers other than their respective home servers."));
443: }
444: if (($ENV{'REDIRECT_QUERY_STRING'}) && ($fn)) {
445: $fn.='?'.$ENV{'REDIRECT_QUERY_STRING'};
446: }
447: $r->print('<form method="post" name="rolechoice" action="'.(($fn)?$fn:$r->uri).'">');
448: $r->print('<input type="hidden" name="orgurl" value="'.$fn.'" />');
449: $r->print('<input type="hidden" name="selectrole" value="1" />');
450: $r->print('<input type="hidden" name="newrole" value="" />');
451: }
452: if ($env{'user.adv'}) {
453: $r->print(
454: '<br /><label>'.&mt('Show all roles').': <input type="checkbox" name="showall"');
455: if ($env{'form.showall'}) { $r->print(' checked="checked" '); }
456: $r->print(' /></label><input type="submit" value="'.&mt('Display').'" />');
457: }
458:
459: my (%roletext,%sortrole,%roleclass);
460: my $countactive=0;
461: my $inrole=0;
462: my $possiblerole='';
463: foreach $envkey (sort keys %env) {
464: my $button = 1;
465: my $switchserver='';
466: my $roletext;
467: my $sortkey;
468: if ($envkey=~/^user\.role\./) {
469: my ($role,$where,$trolecode,$tstart,$tend,$tremark,$tstatus,$tpstart,$tpend,$tfont);
470: &role_status($envkey,$then,$now,\$role,\$where,\$trolecode,\$tstatus,\$tstart,\$tend);
471: next if (!defined($role) || $role eq '' || $role =~ /^gr/);
472: $tremark='';
473: $tpstart=' ';
474: $tpend=' ';
475: $tfont='#000000';
476: if ($tstart) {
477: $tpstart=&Apache::lonlocal::locallocaltime($tstart);
478: }
479: if ($tend) {
480: $tpend=&Apache::lonlocal::locallocaltime($tend);
481: }
482: if ($env{'request.role'} eq $trolecode) {
483: $tstatus='selected';
484: }
485: my $tbg;
486: if (($tstatus eq 'is') || ($tstatus eq 'selected') ||
487: ($env{'form.showall'})) {
488: if ($tstatus eq 'is') {
489: $tbg='#77FF77';
490: $tfont='#003300';
491: $possiblerole=$trolecode;
492: $countactive++;
493: } elsif ($tstatus eq 'future') {
494: $tbg='#FFFF77';
495: $button=0;
496: } elsif ($tstatus eq 'will') {
497: $tbg='#FFAA77';
498: $tremark.=&mt('Active at next login. ');
499: } elsif ($tstatus eq 'expired') {
500: $tbg='#FF7777';
501: $tfont='#330000';
502: $button=0;
503: } elsif ($tstatus eq 'will_not') {
504: $tbg='#AAFF77';
505: $tremark.=&mt('Expired after logout. ');
506: } elsif ($tstatus eq 'selected') {
507: $tbg='#11CC55';
508: $tfont='#002200';
509: $inrole=1;
510: $countactive++;
511: $tremark.=&mt('Currently selected. ');
512: }
513: my $trole;
514: if ($role =~ /^cr\//) {
515: my ($rdummy,$rdomain,$rauthor,$rrole)=split(/\//,$role);
516: if ($tremark) { $tremark.='<br />'; }
517: $tremark.=&mt('Defined by ').$rauthor.
518: &mt(' at ').$rdomain.'.';
519: }
520: $trole=Apache::lonnet::plaintext($role);
521: my $ttype;
522: my $twhere;
523: my ($tdom,$trest,$tsection)=
524: split(/\//,Apache::lonnet::declutter($where));
525: # First, Co-Authorship roles
526: if (($role eq 'ca') || ($role eq 'aa')) {
527: my $home = &Apache::lonnet::homeserver($trest,$tdom);
528: my $allowed=0;
529: my @ids=&Apache::lonnet::current_machine_ids();
530: foreach my $id (@ids) { if ($id eq $home) { $allowed=1; } }
531: if (!$allowed) {
532: $button=0;
533: $switchserver='otherserver='.$home.'&role='.$trolecode;
534: }
535: #next if ($home eq 'no_host');
536: $home = $Apache::lonnet::hostname{$home};
537: $ttype='Construction Space';
538: $twhere=&mt('User').': '.$trest.'<br />'.&mt('Domain').
539: ': '.$tdom.'<br />'.
540: ' '.&mt('Server').': '.$home;
541: $env{'course.'.$tdom.'_'.$trest.'.description'}='ca';
542: $tremark.=&Apache::lonhtmlcommon::authorbombs('/res/'.$tdom.'/'.$trest.'/');
543: $sortkey=$role."$trest:$tdom";
544: } elsif ($role eq 'au') {
545: # Authors
546: my $home = &Apache::lonnet::homeserver
547: ($env{'user.name'},$env{'user.domain'});
548: my $allowed=0;
549: my @ids=&Apache::lonnet::current_machine_ids();
550: foreach my $id (@ids) { if ($id eq $home) { $allowed=1; } }
551: if (!$allowed) {
552: $button=0;
553: $switchserver='otherserver='.$home.'&role='.$trolecode;
554: }
555: #next if ($home eq 'no_host');
556: $home = $Apache::lonnet::hostname{$home};
557: $ttype='Construction Space';
558: $twhere=&mt('Domain').': '.$tdom.'<br />'.&mt('Server').
559: ': '.$home;
560: $env{'course.'.$tdom.'_'.$trest.'.description'}='ca';
561: $tremark.=&Apache::lonhtmlcommon::authorbombs('/res/'.$tdom.'/'.$env{'user.name'}.'/');
562: $sortkey=$role;
563: } elsif ($trest) {
564: my $tcourseid=$tdom.'_'.$trest;
565: $ttype = &Apache::loncommon::course_type($tcourseid);
566: $trole = &Apache::lonnet::plaintext($role,$ttype);
567: if ($env{'course.'.$tcourseid.'.description'}) {
568: $twhere=$env{'course.'.$tcourseid.'.description'};
569: $sortkey=$role."\0".$tdom."\0".$twhere."\0".$envkey;
570: unless ($twhere eq &mt('Currently not available')) {
571: $twhere.=' <font size="-2">'.
572: &Apache::loncommon::syllabuswrapper(&mt('Syllabus'),$trest,$tdom,$tfont).
573: '</font>';
574: }
575: } else {
576: my %newhash=&Apache::lonnet::coursedescription($tcourseid);
577: if (%newhash) {
578: $sortkey=$role."\0".$tdom."\0".$newhash{'description'}.
579: "\0".$envkey;
580: $twhere=$newhash{'description'}.
581: ' <font size="-2">'.
582: &Apache::loncommon::syllabuswrapper(&mt('Syllabus'),$trest,$tdom,$tfont).
583: '</font>';
584: $ttype = $newhash{'type'};
585: $trole = &Apache::lonnet::plaintext($role,$ttype);
586: } else {
587: $twhere=&mt('Currently not available');
588: $env{'course.'.$tcourseid.'.description'}=$twhere;
589: $sortkey=$role."\0".$tdom."\0".$twhere."\0".$envkey;
590: $ttype = 'Unavailable';
591: }
592: }
593: if ($tsection) {
594: $twhere.='<br />'.&mt('Section/Group').': '.$tsection;
595: }
596: if ($role ne 'st') { $twhere.="<br />".&mt('Domain').":".$tdom; }
597: } elsif ($tdom) {
598: $ttype='Domain';
599: $twhere=$tdom;
600: $sortkey=$role.$twhere;
601: } else {
602: $ttype='System';
603: $twhere=&mt('system wide');
604: $sortkey=$role.$twhere;
605: }
606: $roletext.=&build_roletext($trolecode,$tdom,$trest,$tstatus,$tryagain,$advanced,$tremark,$tbg,$tfont,$trole,$twhere,$tpstart,$tpend,$nochoose,$button,$switchserver);
607: $roletext{$envkey}=$roletext;
608: if (!$sortkey) {$sortkey=$twhere."\0".$envkey;}
609: $sortrole{$sortkey}=$envkey;
610: $roleclass{$envkey}=$ttype;
611: }
612: }
613: }
614: # No active roles
615: if ($countactive==0) {
616: if ($inrole) {
617: $r->print('<h2>'.&mt('Currently no additional roles or courses').'</h2>');
618: } else {
619: $r->print('<h2>'.&mt('Currently no active roles or courses').'</h2>');
620: }
621: $r->print('</form>'.&Apache::loncommon::end_page());
622: return OK;
623: # Is there only one choice?
624: } elsif (($countactive==1) && ($env{'request.role'} eq 'cm')) {
625: $r->print('<h3>'.&mt('Please stand by.').'</h3>'.
626: '<input type="hidden" name="'.$possiblerole.'" value="1" />');
627: $r->print("</form>\n");
628: $r->rflush();
629: $r->print('<script>document.forms.rolechoice.submit();</script>');
630: $r->print(&Apache::loncommon::end_page());
631: return OK;
632: }
633: # More than one possible role
634: # ----------------------------------------------------------------------- Table
635: unless (($advanced) || ($nochoose)) {
636: $r->print("<h2>".&mt('Select a Course/Group to Enter')."</h2>\n");
637: }
638: $r->print('<br /><table><tr>');
639: unless ($nochoose) { $r->print('<th> </th>'); }
640: $r->print('<th>'.&mt('User Role').'</th><th>'.&mt('Extent').
641: '</th><th>'.&mt('Start').'</th><th>'.&mt('End').'</th></tr>'."\n");
642: my $doheaders=-1;
643: foreach my $type ('Domain','Construction Space','Course','Group','Unavailable','System') {
644: my $haverole=0;
645: foreach my $which (sort {uc($a) cmp uc($b)} (keys(%sortrole))) {
646: if ($roleclass{$sortrole{$which}} =~ /^\Q$type\E/) {
647: $haverole=1;
648: }
649: }
650: if ($haverole) { $doheaders++; }
651: }
652:
653: if ($env{'environment.recentroles'}) {
654: my %recent_roles =
655: &Apache::lonhtmlcommon::get_recent('roles',$env{'environment.recentrolesn'});
656: my $output='';
657: foreach (sort(keys(%recent_roles))) {
658: if (defined($roletext{'user.role.'.$_})) {
659: $output.=$roletext{'user.role.'.$_};
660: if ($_ =~ m-dc\./(\w+)/- && $dcroles{$1}) {
661: $output .= &allcourses_row($1,'recent');
662: }
663: } elsif ($numdc > 0) {
664: unless ($_ =~/^error\:/) {
665: $output.=&display_cc_role('user.role.'.$_);
666: }
667: }
668: }
669: if ($output) {
670: $r->print("<tr><td align='center' colspan='5'><font face='arial'>".
671: &mt('Recent Roles')."</font></td>");
672: $r->print($output);
673: $r->print("</tr>");
674: $doheaders ++;
675: }
676: }
677:
678: if ($numdc > 0) {
679: $r->print(&coursepick_jscript());
680: $r->print(&Apache::loncommon::coursebrowser_javascript());
681: }
682: foreach my $type ('Construction Space','Domain','Course','Group','Unavailable','System') {
683: my $output;
684: foreach my $which (sort {uc($a) cmp uc($b)} (keys(%sortrole))) {
685: if ($roleclass{$sortrole{$which}} =~ /^\Q$type\E/) {
686: $output.=$roletext{$sortrole{$which}};
687: if ($sortrole{$which} =~ m-dc\./(\w+)/-) {
688: if ($dcroles{$1}) {
689: $output .= &allcourses_row($1,'');
690: }
691: }
692: }
693: }
694: if ($output) {
695: if ($doheaders > 0) {
696: $r->print("<tr>".
697: "<td align='center' colspan='5'><font face='arial'>".&mt($type)."</font></td></tr>");
698: }
699: $r->print($output);
700: }
701: }
702: my $tremark='';
703: my $tfont='#003300';
704: if ($env{'request.role'} eq 'cm') {
705: $r->print('<tr bgcolor="#11CC55">');
706: $tremark=&mt('Currently selected. ');
707: $tfont='#002200';
708: } else {
709: $r->print('<tr bgcolor="#77FF77">');
710: }
711: unless ($nochoose) {
712: if ($env{'request.role'} ne 'cm') {
713: $r->print('<td><input type="submit" value="'.
714: &mt('Select').'" name="cm"></td>');
715: } else {
716: $r->print('<td> </td>');
717: }
718: }
719: $r->print('<td colspan="3"><font color="'.$tfont.'">'.&mt('No role specified').
720: '</font></td><td><font color="'.$tfont.'">'.$tremark.
721: ' </font></td></tr>'."\n");
722:
723: $r->print('</table>');
724: unless ($nochoose) {
725: $r->print("</form>\n");
726: }
727: # ------------------------------------------------------------ Privileges Info
728: if (($advanced) && (($env{'user.error.msg'}) || ($error))) {
729: $r->print('<hr /><h2>Current Privileges</h2>');
730:
731: foreach $envkey (sort keys %env) {
732: if ($envkey=~/^user\.priv\.$env{'request.role'}\./) {
733: my $where=$envkey;
734: $where=~s/^user\.priv\.$env{'request.role'}\.//;
735: my $ttype;
736: my $twhere;
737: my ($tdom,$trest,$tsec)=
738: split(/\//,Apache::lonnet::declutter($where));
739: if ($trest) {
740: if ($env{'course.'.$tdom.'_'.$trest.'.description'} eq 'ca') {
741: $ttype='Construction Space';
742: $twhere='User: '.$trest.', Domain: '.$tdom;
743: } else {
744: $ttype=
745: &Apache::loncommon::course_type($tdom.'_'.$trest);
746: $twhere=$env{'course.'.$tdom.'_'.$trest.'.description'};
747: if ($tsec) {
748: $twhere.=' (Section: '.$tsec.')';
749: }
750: }
751: } elsif ($tdom) {
752: $ttype='Domain';
753: $twhere=$tdom;
754: } else {
755: $ttype='System';
756: $twhere='/';
757: }
758: $r->print("\n<h3>".$ttype.': '.$twhere.'</h3><ul>');
759: foreach (sort split(/:/,$env{$envkey})) {
760: if ($_) {
761: my ($prv,$restr)=split(/\&/,$_);
762: my $trestr='';
763: if ($restr ne 'F') {
764: my $i;
765: $trestr.=' (';
766: for ($i=0;$i<length($restr);$i++) {
767: $trestr.=
768: Apache::lonnet::plaintext(substr($restr,$i,1));
769: if ($i<length($restr)-1) { $trestr.=', '; }
770: }
771: $trestr.=')';
772: }
773: $r->print('<li>'.
774: Apache::lonnet::plaintext($prv).$trestr.
775: '</li>');
776: }
777: }
778: $r->print('</ul>');
779: }
780: }
781: }
782: $r->print(&Apache::lonnet::getannounce());
783: if ($advanced) {
784: $r->print('<p><small><i>This is LON-CAPA '.
785: $r->dir_config('lonVersion').'</i><br />'.
786: '<a href="/adm/logout">'.&mt('Logout').'</a></small></p>');
787: }
788: $r->print(&Apache::loncommon::end_page());
789: return OK;
790: }
791:
792: sub role_status {
793: my ($rolekey,$then,$now,$role,$where,$trolecode,$tstatus,$tstart,$tend) = @_;
794: my @pwhere = ();
795: if (exists($env{$rolekey}) && $env{$rolekey} ne '') {
796: (undef,undef,$$role,@pwhere)=split(/\./,$rolekey);
797: unless (!defined($$role) || $$role eq '') {
798: $$where=join('.',@pwhere);
799: $$trolecode=$$role.'.'.$$where;
800: ($$tstart,$$tend)=split(/\./,$env{$rolekey});
801: $$tstatus='is';
802: if ($$tstart && $$tstart>$then) {
803: $$tstatus='future';
804: if ($$tstart<$now) { $$tstatus='will'; }
805: }
806: if ($$tend) {
807: if ($$tend<$then) {
808: $$tstatus='expired';
809: } elsif ($$tend<$now) {
810: $$tstatus='will_not';
811: }
812: }
813: }
814: }
815: }
816:
817: sub build_roletext {
818: my ($trolecode,$tdom,$trest,$tstatus,$tryagain,$advanced,$tremark,$tbg,$tfont,$trole,$twhere,$tpstart,$tpend,$nochoose,$button,$switchserver) = @_;
819: my $roletext='<tr bgcolor="'.$tbg.'">';
820: my $is_dc=($trolecode =~ m/^dc\./);
821: my $rowspan=($is_dc) ? ''
822: : ' rowspan="2" ';
823:
824: unless ($nochoose) {
825: my $buttonname=$trolecode;
826: $buttonname=~s/\W//g;
827: if (!$button) {
828: if ($switchserver) {
829: $roletext.='<td'.$rowspan.'><a href="/adm/switchserver?'.
830: $switchserver.'">'.&mt('Switch Server').'</a></td>';
831: } else {
832: $roletext.=('<td> </td>');
833: }
834: } elsif ($tstatus eq 'is') {
835: $roletext.='<td'.$rowspan.'><input name="'.$buttonname.'" type="button" value="'.
836: &mt('Select').'" onClick="javascript:enterrole(this.form,\''.
837: $trolecode."','".$buttonname.'\');"></td>';
838: } elsif ($tryagain) {
839: $roletext.=
840: '<td'.$rowspan.'><input name="'.$buttonname.'" type="button" value="'.
841: &mt('Try Selecting Again').'" onClick="javascript:enterrole(this.form,\''.
842: $trolecode."','".$buttonname.'\');"></td>';
843: } elsif ($advanced) {
844: $roletext.=
845: '<td'.$rowspan.'><input name="'.$buttonname.'" type="button" value="'.
846: &mt('Re-Initialize').'" onClick="javascript:enterrole(this.form,\''.
847: $trolecode."','".$buttonname.'\');"></td>';
848: } else {
849: $roletext.='<td'.$rowspan.'> </td>';
850: }
851: }
852: $tremark.=&Apache::lonannounce::showday(time,1,
853: &Apache::lonannounce::readcalendar($tdom.'_'.$trest));
854:
855: $roletext.='<td><font color="'.$tfont.'">'.$trole.
856: '</font></td><td><font color="'.$tfont.'">'.$twhere.
857: '</font></td><td><font color="'.$tfont.'">'.$tpstart.
858: '</font></td><td><font color="'.$tfont.'">'.$tpend.
859: '</font></td></tr>';
860: if (!$is_dc) {
861: $roletext.='<tr bgcolor="'.$tbg.'"><td colspan="4"><font color="'.$tfont.'">'.$tremark.
862: ' </font></td></tr><tr><td colspan="5" height="3"></td></tr>'."\n";
863: }
864: return $roletext;
865: }
866:
867: sub check_privs {
868: my ($cdom,$cnum,$then,$now) = @_;
869: my $cckey = 'user.role.cc./'.$cdom.'/'.$cnum;
870: if ($env{$cckey}) {
871: my ($role,$where,$trolecode,$tstart,$tend,$tremark,$tstatus,$tpstart,$tpend,$tfont);
872: &role_status($cckey,$then,$now,\$role,\$where,\$trolecode,\$tstatus,\$tstart,\$tend);
873: unless (($tstatus eq 'is') || ($tstatus eq 'will_not')) {
874: &set_privileges($cdom,$cnum);
875: }
876: } else {
877: &set_privileges($cdom,$cnum);
878: }
879: }
880:
881: sub check_fordc {
882: my ($dcroles,$then) = @_;
883: my $numdc = 0;
884: if ($env{'user.adv'}) {
885: foreach my $envkey (sort keys %env) {
886: if ($envkey=~/^user\.role\.dc\.\/(\w+)\/$/) {
887: my $dcdom = $1;
888: my $livedc = 1;
889: my ($tstart,$tend)=split(/\./,$env{$envkey});
890: if ($tstart && $tstart>$then) { $livedc = 0; }
891: if ($tend && $tend <$then) { $livedc = 0; }
892: if ($livedc) {
893: $$dcroles{$dcdom} = $envkey;
894: $numdc++;
895: }
896: }
897: }
898: }
899: return $numdc;
900: }
901:
902: sub courselink {
903: my ($dcdom,$rowtype,$selecttype) = @_;
904: my $courseform=&Apache::loncommon::selectcourse_link
905: ('rolechoice','dccourse'.$rowtype.'_'.$dcdom,
906: 'dcdomain'.$rowtype.'_'.$dcdom,'coursedesc'.$rowtype.'_'.
907: $dcdom,$dcdom,undef,$selecttype);
908: my $hiddenitems = '<input type="hidden" name="dcdomain'.$rowtype.'_'.$dcdom.'" value="'.$dcdom.'" />'.
909: '<input type="hidden" name="origdom'.$rowtype.'_'.$dcdom.'" value="'.$dcdom.'" />'.
910: '<input type="hidden" name="dccourse'.$rowtype.'_'.$dcdom.'" value="" />'.
911: '<input type="hidden" name="coursedesc'.$rowtype.'_'.$dcdom.'" value="" />';
912: return $courseform.$hiddenitems;
913: }
914:
915: sub coursepick_jscript {
916: my $verify_script = <<"END";
917: <script>
918: function verifyCoursePick(caller) {
919: var numbutton = getIndex(caller)
920: var pickedCourse = document.rolechoice.elements[numbutton+4].value
921: var pickedDomain = document.rolechoice.elements[numbutton+2].value
922: if (document.rolechoice.elements[numbutton+2].value == document.rolechoice.elements[numbutton+3].value) {
923: if (pickedCourse != '') {
924: if (numbutton != -1) {
925: var courseTarget = "cc./"+pickedDomain+"/"+pickedCourse
926: document.rolechoice.elements[numbutton+1].name = courseTarget
927: document.rolechoice.submit()
928: }
929: }
930: else {
931: alert("Please use the 'Select Course' link to open a separate pick course window where you may select the course you wish to enter.");
932: }
933: }
934: else {
935: alert("You can only use this screen to select courses in the current domain")
936: }
937: }
938: function getIndex(caller) {
939: for (var i=0;i<document.rolechoice.elements.length;i++) {
940: if (document.rolechoice.elements[i] == caller) {
941: return i;
942: }
943: }
944: return -1;
945: }
946: </script>
947: END
948: return $verify_script;
949: }
950:
951: sub processpick {
952: my $process_pick = <<"END";
953: <script>
954: function process_pick(dom) {
955: var pickedCourse=opener.document.rolechoice.$env{'form.cnumelement'}.value;
956: var pickedDomain=opener.document.rolechoice.$env{'form.cdomelement'}.value;
957: var okDomain = 0;
958:
959: if (pickedDomain == dom) {
960: if (pickedCourse != '') {
961: var courseTarget = "cc./"+pickedDomain+"/"+pickedCourse
962: opener.document.title='Role selected. Please stand by.';
963: opener.status='Role selected. Please stand by.';
964: opener.document.rolechoice.newrole.value=courseTarget
965: opener.document.rolechoice.submit()
966: }
967: } else {
968: 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");
969: }
970: }
971:
972: </script>
973: END
974: return $process_pick;
975: }
976:
977: sub display_cc_role {
978: my $rolekey = shift;
979: my $roletext;
980: my $advanced = $env{'user.adv'};
981: my $tryagain = $env{'form.tryagain'};
982: unless ($rolekey =~/^error\:/) {
983: if ($rolekey =~ m-^user\.role.cc\./(\w+)/(\w+)$-) {
984: my $tcourseid = $1.'_'.$2;
985: my $trolecode = 'cc./'.$1.'/'.$2;
986: my $twhere;
987: my $ttype;
988: my $tbg='#77FF77';
989: my $tfont='#003300';
990: my %newhash=&Apache::lonnet::coursedescription($tcourseid);
991: if (%newhash) {
992: $twhere=$newhash{'description'}.
993: ' <font size="-2">'.
994: &Apache::loncommon::syllabuswrapper(&mt('Syllabus'),$2,$1,$tfont).
995: '</font>';
996: $ttype = $newhash{'type'};
997: } else {
998: $twhere=&mt('Currently not available');
999: $env{'course.'.$tcourseid.'.description'}=$twhere;
1000: }
1001: my $trole = &Apache::lonnet::plaintext('cc',$ttype);
1002: $twhere.="<br />".&mt('Domain').":".$1;
1003: $roletext = &build_roletext($trolecode,$1,$2,'is',$tryagain,$advanced,'',$tbg,$tfont,$trole,$twhere,'','','',1,'');
1004: }
1005: }
1006: return ($roletext);
1007: }
1008:
1009: sub allcourses_row {
1010: my ($dcdom,$rowtype) = @_;
1011: my $output = '<tr bgcolor="#77FF77">'.
1012: ' <td colspan="5">';
1013: foreach my $type ('Course','Group') {
1014: my $selectlink = &courselink($dcdom,$rowtype,$type);
1015: my $ccrole = &Apache::lonnet::plaintext('cc',$type);
1016: $output.= '<font color="#002200">'.$ccrole.'</font>'.
1017: ' <b>'.$selectlink.'</b>'.
1018: ' from '.&mt('Domain').' '.$dcdom.'<br />';
1019: }
1020: $output .= '</tr><tr><td colspan="5" height="3"></td></tr>'."\n";
1021: return $output;
1022: }
1023:
1024: sub recent_filename {
1025: my $area=shift;
1026: return 'nohist_recent_'.&escape($area);
1027: }
1028:
1029: sub set_privileges {
1030: my ($dcdom,$pickedcourse) = @_;
1031: my $area = '/'.$dcdom.'/'.$pickedcourse;
1032: my $role = 'cc';
1033: my $spec = $role.'.'.$area;
1034: my %userroles = &Apache::lonnet::set_arearole($role,$area,'','',$dcdom,$env{'user.name'});
1035: my %ccrole = ();
1036: &Apache::lonnet::standard_roleprivs(\%ccrole,$role,$dcdom,$spec,$pickedcourse,$area);
1037: my ($author,$adv)= &Apache::lonnet::set_userprivs(\%userroles,\%ccrole);
1038: &Apache::lonnet::appenv(%userroles);
1039: &Apache::lonnet::log($env{'user.domain'},
1040: $env{'user.name'},
1041: $env{'user.home'},
1042: "Role ".$role);
1043: &Apache::lonnet::appenv(
1044: 'request.role' => $spec,
1045: 'request.role.domain' => $dcdom,
1046: 'request.course.sec' => '');
1047: my $tadv=0;
1048: if (&Apache::lonnet::allowed('adv') eq 'F') { $tadv=1; }
1049: &Apache::lonnet::appenv('request.role.adv' => $tadv);
1050: }
1051:
1052: sub courseloadpage {
1053: my ($courseid) = @_;
1054: my $startpage;
1055: my %entry_settings = &Apache::lonnet::get('nohist_whatsnew',
1056: [$courseid.':courseinit']);
1057: my ($tmp) = %entry_settings;
1058: unless ($tmp =~ /^error: 2 /) {
1059: $startpage = $entry_settings{$courseid.':courseinit'};
1060: }
1061: if ($startpage eq '') {
1062: if (exists($env{'environment.course_init_display'})) {
1063: $startpage = $env{'environment.course_init_display'};
1064: }
1065: }
1066: return $startpage;
1067: }
1068:
1069: 1;
1070: __END__
1071:
1072: =head1 NAME
1073:
1074: Apache::lonroles - User Roles Screen
1075:
1076: =head1 SYNOPSIS
1077:
1078: Invoked by /etc/httpd/conf/srm.conf:
1079:
1080: <Location /adm/roles>
1081: PerlAccessHandler Apache::lonacc
1082: SetHandler perl-script
1083: PerlHandler Apache::lonroles
1084: ErrorDocument 403 /adm/login
1085: ErrorDocument 500 /adm/errorhandler
1086: </Location>
1087:
1088: =head1 OVERVIEW
1089:
1090: =head2 Choosing Roles
1091:
1092: C<lonroles> is a handler that allows a user to switch roles in
1093: mid-session. LON-CAPA attempts to work with "No Role Specified", the
1094: default role that a user has before selecting a role, as widely as
1095: possible, but certain handlers for example need specification which
1096: course they should act on, etc. Both in this scenario, and when the
1097: handler determines via C<lonnet>'s C<&allowed> function that a certain
1098: action is not allowed, C<lonroles> is used as error handler. This
1099: allows the user to select another role which may have permission to do
1100: what they were trying to do. C<lonroles> can also be accessed via the
1101: B<CRS> button in the Remote Control.
1102:
1103: =begin latex
1104:
1105: \begin{figure}
1106: \begin{center}
1107: \includegraphics[width=0.45\paperwidth,keepaspectratio]{Sample_Roles_Screen}
1108: \caption{\label{Sample_Roles_Screen}Sample Roles Screen}
1109: \end{center}
1110: \end{figure}
1111:
1112: =end latex
1113:
1114: =head2 Role Initialization
1115:
1116: 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.
1117:
1118: =head1 INTRODUCTION
1119:
1120: This module enables a user to select what role he wishes to
1121: operate under (instructor, student, teaching assistant, course
1122: coordinator, etc). These roles are pre-established by the actions
1123: of upper-level users.
1124:
1125: This is part of the LearningOnline Network with CAPA project
1126: described at http://www.lon-capa.org.
1127:
1128: =head1 HANDLER SUBROUTINE
1129:
1130: This routine is called by Apache and mod_perl.
1131:
1132: =over 4
1133:
1134: =item *
1135:
1136: Roles Initialization (yes/no)
1137:
1138: =item *
1139:
1140: Get Error Message from Environment
1141:
1142: =item *
1143:
1144: Who is this?
1145:
1146: =item *
1147:
1148: Generate Page Output
1149:
1150: =item *
1151:
1152: Choice or no choice
1153:
1154: =item *
1155:
1156: Table
1157:
1158: =item *
1159:
1160: Privileges
1161:
1162: =back
1163:
1164: =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