1: # The LearningOnline Network with CAPA
2: # User Roles Screen
3: #
4: # $Id: lonroles.pm,v 1.78 2003/12/05 14:18:00 sakharuk 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: # (Directory Indexer
29: # (Login Screen
30: # YEAR=1999
31: # 5/21/99,5/22,5/25,5/26,5/31,6/2,6/10,7/12,7/14 Gerd Kortemeyer)
32: # 11/23 Gerd Kortemeyer)
33: # YEAR=2000
34: # 1/14,03/06,06/01,07/22,07/24,07/25,
35: # 09/04,09/06,09/28,09/29,09/30,10/2,10/5,10/26,10/28,
36: # 12/08,12/28,
37: # YEAR=2001
38: # 01/15/01 Gerd Kortemeyer
39: # 03/02,05/03,05/25,05/30,06/01,07/06,08/06 Gerd Kortemeyer
40: # 12/29 Gerd Kortemeyer
41: #
42: ###
43:
44: package Apache::lonroles;
45:
46: use strict;
47: use Apache::lonnet();
48: use Apache::lonuserstate();
49: use Apache::Constants qw(:common);
50: use Apache::File();
51: use Apache::lonmenu;
52: use Apache::loncommon;
53: use Apache::lonannounce;
54: use Apache::lonlocal;
55:
56: sub redirect_user {
57: my ($r,$title,$url,$msg) = @_;
58: $msg = $title if (! defined($msg));
59: &Apache::loncommon::content_type($r,'text/html');
60: &Apache::loncommon::no_cache($r);
61: $r->send_http_header;
62: my $swinfo=&Apache::lonmenu::rawconfig();
63: my $bodytag=&Apache::loncommon::bodytag('Switching Role');
64: $r->print (<<ENDREDIR);
65: <head><title>$title</title>
66: <meta HTTP-EQUIV="Refresh" CONTENT="1; url=$url">
67: </head>
68: <html>
69: $bodytag
70: <script>
71: $swinfo
72: </script>
73: <h1>$msg</h1>
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:
88:
89: # ================================================================== Roles Init
90:
91: if ($ENV{'form.selectrole'}) {
92: if ($ENV{'request.course.id'}) {
93: my %temp=('logout_'.$ENV{'request.course.id'} => time);
94: &Apache::lonnet::put('email_status',\%temp);
95: }
96: &Apache::lonnet::appenv("request.course.id" => '',
97: "request.course.fn" => '',
98: "request.course.uri" => '',
99: "request.course.sec" => '',
100: "request.role" => 'cm',
101: "request.role.adv" => $ENV{'user.adv'},
102: "request.role.domain" => $ENV{'user.domain'});
103: foreach $envkey (keys %ENV) {
104: next if ($envkey!~/^user\.role\./);
105: my (undef,undef,$role,@pwhere)=split(/\./,$envkey);
106: my $where=join('.',@pwhere);
107: my $trolecode=$role.'.'.$where;
108: if ($ENV{'form.'.$trolecode}) {
109: my ($tstart,$tend)=split(/\./,$ENV{$envkey});
110: my $tstatus='is';
111: if ($tstart) {
112: if ($tstart>$then) {
113: $tstatus='future';
114: }
115: }
116: if ($tend) {
117: if ($tend<$then) { $tstatus='expired'; }
118: if ($tend<$now) { $tstatus='will_not'; }
119: }
120: if ($tstatus eq 'is') {
121: $where=~s/^\///;
122: my ($cdom,$cnum,$csec)=split(/\//,$where);
123: # check for keyed access
124: if (($role eq 'st') &&
125: ($ENV{'course.'.$cdom.'_'.$cnum.'.keyaccess'} eq 'yes')) {
126: unless (&Apache::lonnet::validate_access_key(
127: $ENV{'environment.key.'.$cdom.'_'.$cnum},
128: $cdom,$cnum)) {
129: # there is no valid key
130: if ($ENV{'form.newkey'}) {
131: # student attempts to register a new key
132: } else {
133: # print form to enter a new key
134: &Apache::loncommon::content_type($r,'text/html');
135: &Apache::loncommon::no_cache($r);
136: $r->send_http_header;
137: my $swinfo=&Apache::lonmenu::rawconfig();
138: my $bodytag=&Apache::loncommon::bodytag
139: ('Enter Access Key to Unlock this Course');
140: $r->print(<<ENDENTERKEY);
141: <head><title>Entering Course Access Key</title>
142: </head>
143: <html>
144: $bodytag
145: <script>
146: $swinfo
147: </script>
148: <form method="post">
149: <input type="hidden" name="selectrole" value="$ENV{'form.selectrole'}" />
150: <input type="text" size="20" name="newkey" value="$ENV{'form.newkey'}" />
151: <input type="submit" value="Enter key" />
152: </form>
153: </body></html>
154: ENDENTERKEY
155: return OK;
156: }
157: }
158: }
159: my $tadv=0;
160: if (($trolecode!~/^st/) &&
161: ($trolecode!~/^ta/) &&
162: ($trolecode!~/^cm/)) { $tadv=1; }
163: &Apache::lonnet::appenv(
164: 'request.role' => $trolecode,
165: 'request.role.adv' => $tadv,
166: 'request.role.domain' => $cdom,
167: 'request.course.sec' => $csec);
168: my $msg=&mt('Entering course ...');
169:
170: if (($cnum) && ($role ne 'ca')) {
171: my ($furl,$ferr)=
172: &Apache::lonuserstate::readmap($cdom.'/'.$cnum);
173: if (($ENV{'form.orgurl'}) &&
174: ($ENV{'form.orgurl'}!~/^\/adm\/flip/)) {
175: my $dest=$ENV{'form.orgurl'};
176: if ( &Apache::lonnet::mod_perl_version() == 2 ) {
177: &Apache::lonnet::cleanenv();
178: }
179: $r->internal_redirect($dest);
180: return OK;
181: } else {
182: unless ($ENV{'request.course.id'}) {
183: &Apache::lonnet::appenv(
184: "request.course.id" => $cdom.'_'.$cnum);
185: $furl='/adm/roles?tryagain=1';
186: $msg=
187: '<h1><font color=red>'.
188: &mt('Could not initialize course at this time.').
189: '</font></h1><h3>'.&mt('Please try again.').'</h3>'.$ferr;
190: }
191:
192: # Check to see if the user is a CC entering a course
193: # for the first time
194: my (undef, undef, $role, $courseid) = split(/\./, $envkey);
195: if (substr($courseid, 0, 1) eq '/') {
196: $courseid = substr($courseid, 1);
197: }
198: $courseid =~ s/\//_/;
199: if ($role eq 'cc' && $ENV{'course.' . $courseid .
200: '.course.helper.not.run'}) {
201: $furl = "/adm/helper/course.initialization.helper";
202: }
203: #
204: # Send the user to the course they selected
205: &redirect_user($r,&mt('Entering Course'),
206: $furl,$msg);
207: return OK;
208: }
209: }
210: #
211: # Send the user to the construction space they selected
212: if ($role =~ /^(au|ca)$/) {
213: my $redirect_url = '/priv/';
214: if ($role eq 'au') {
215: $redirect_url.=$ENV{'user.name'};
216: } else {
217: $where =~ /\/(.*)$/;
218: $redirect_url .= $1;
219: }
220: $redirect_url .= '/';
221: &redirect_user($r,&mt('Entering Construction Space'),
222: $redirect_url);
223: return OK;
224: }
225: }
226: }
227: }
228: }
229:
230:
231: # =============================================================== No Roles Init
232:
233: &Apache::loncommon::content_type($r,'text/html');
234: &Apache::loncommon::no_cache($r);
235: $r->send_http_header;
236: return OK if $r->header_only;
237:
238: my $swinfo=&Apache::lonmenu::rawconfig();
239: my $bodytag=&Apache::loncommon::bodytag('User Roles');
240: my $helptag=&Apache::loncommon::help_open_topic
241: ("General_Intro","Click here for help");
242: $r->print(<<ENDHEADER);
243: <html>
244: <head>
245: <title>LON-CAPA User Roles</title>
246: </head>
247: $bodytag
248: $helptag<br />
249: <script>
250: $swinfo
251: window.focus();
252: </script>
253: ENDHEADER
254:
255: # ------------------------------------------ Get Error Message from Environment
256:
257: my ($fn,$priv,$nochoose,$error,$msg)=split(/:/,$ENV{'user.error.msg'});
258: if ($ENV{'user.error.msg'}) {
259: $r->log_reason(
260: "$msg for $ENV{'user.name'} domain $ENV{'user.domain'} access $priv",$fn);
261: }
262:
263: # ------------------------------------------------- Can this user re-init, etc?
264:
265: my $advanced=$ENV{'user.adv'};
266: &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},['tryagain']);
267: my $tryagain=$ENV{'form.tryagain'};
268:
269: # -------------------------------------------------------- Generate Page Output
270: # --------------------------------------------------------------- Error Header?
271: if ($error) {
272: $r->print("<h1>LON-CAPA Access Control</h1>");
273: $r->print("<hr><pre>Access : ".
274: Apache::lonnet::plaintext($priv)."\n");
275: $r->print("Resource: $fn\n");
276: $r->print("Action : $msg\n</pre><hr>");
277: } else {
278: if ($ENV{'user.error.msg'}) {
279: $r->print(
280: '<h3><font color=red>'.
281: &mt('You need to choose another user role or enter a specific course for this function').'</font></h3>');
282: }
283: }
284: # -------------------------------------------------------- Choice or no choice?
285: if ($nochoose) {
286: if ($advanced) {
287: $r->print("<h2>".&mt('Assigned User Roles')."</h2>\n");
288: } else {
289: $r->print("<h2>".&mt('Sorry ...')."</h2>\n".
290: &mt('This resource might be part of'));
291: if ($ENV{'request.course.id'}) {
292: $r->print(&mt(' another'));
293: } else {
294: $r->print(&mt(' a certain'));
295: }
296: $r->print(&mt(' course.').'</body></html>');
297: return OK;
298: }
299: } else {
300: if ($advanced) {
301: $r->print(&mt("Your home server is ").
302: $Apache::lonnet::hostname{&Apache::lonnet::homeserver
303: ($ENV{'user.name'},$ENV{'user.domain'})}.
304: "<br />\n");
305: $r->print(&mt(
306: "Author and Co-Author roles may not be available on servers other than your home server."));
307: } else {
308: $r->print("<h2>".&mt('Select a Course to Enter')."</h2>\n");
309: }
310: if (($ENV{'REDIRECT_QUERY_STRING'}) && ($fn)) {
311: $fn.='?'.$ENV{'REDIRECT_QUERY_STRING'};
312: }
313: $r->print('<form method=post action="'.(($fn)?$fn:$r->uri).'">');
314: $r->print('<input type=hidden name=orgurl value="'.$fn.'">');
315: $r->print('<input type=hidden name=selectrole value=1>');
316: }
317: if ($ENV{'user.adv'}) {
318: $r->print(
319: '<br />'.&mt('Show all roles').': <input type="checkbox" name="showall"');
320: if ($ENV{'form.showall'}) { $r->print(' checked'); }
321: $r->print('><input type=submit value="'.&mt('Display').'">');
322: }
323: # ----------------------------------------------------------------------- Table
324: $r->print('<br /><table><tr>');
325: unless ($nochoose) { $r->print('<th> </th>'); }
326: $r->print('<th>'.&mt('User Role').'</th><th colspan=2>'.&mt('Extent').
327: '</th><th>'.&mt('Start').'</th><th>'.&mt('End').'</th><th>'.
328: &mt('Remark').'</th></tr>'."\n");
329:
330: my (%roletext,%sortrole,%roleclass);
331: foreach $envkey (sort keys %ENV) {
332: my $button = 1;
333: my $switchserver='';
334: my $roletext;
335: my $sortkey;
336: if ($envkey=~/^user\.role\./) {
337: my (undef,undef,$role,@pwhere)=split(/\./,$envkey);
338: next if (!defined($role) || $role eq '');
339: my $where=join('.',@pwhere);
340: my $trolecode=$role.'.'.$where;
341: my ($tstart,$tend)=split(/\./,$ENV{$envkey});
342: my $tremark='';
343: my $tstatus='is';
344: my $tpstart=' ';
345: my $tpend=' ';
346: my $tfont='#000000';
347: if ($tstart) {
348: if ($tstart>$then) {
349: $tstatus='future';
350: if ($tstart<$now) { $tstatus='will'; }
351: }
352: $tpstart=&Apache::lonlocal::locallocaltime($tstart);
353: }
354: if ($tend) {
355: if ($tend<$then) {
356: $tstatus='expired';
357: } elsif ($tend<$now) {
358: $tstatus='will_not';
359: }
360: $tpend=&Apache::lonlocal::locallocaltime($tend);
361: }
362: if ($ENV{'request.role'} eq $trolecode) {
363: $tstatus='selected';
364: }
365: my $tbg;
366: if (($tstatus eq 'is') || ($tstatus eq 'selected') ||
367: ($ENV{'form.showall'})) {
368: if ($tstatus eq 'is') {
369: $tbg='#77FF77';
370: $tfont='#003300';
371: } elsif ($tstatus eq 'future') {
372: $tbg='#FFFF77';
373: $button=0;
374: } elsif ($tstatus eq 'will') {
375: $tbg='#FFAA77';
376: $tremark.=&mt('Active at next login. ');
377: } elsif ($tstatus eq 'expired') {
378: $tbg='#FF7777';
379: $tfont='#330000';
380: $button=0;
381: } elsif ($tstatus eq 'will_not') {
382: $tbg='#AAFF77';
383: $tremark.=&mt('Expired after logout. ');
384: } elsif ($tstatus eq 'selected') {
385: $tbg='#11CC55';
386: $tfont='#002200';
387: $tremark.=&mt('Currently selected. ');
388: }
389: my $trole;
390: if ($role =~ /^cr\//) {
391: my ($rdummy,$rdomain,$rauthor,$rrole)=split(/\//,$role);
392: $tremark.='<br>'.&mt('Defined by ').$rauthor.
393: &mt(' at ').$rdomain.'.';
394: $trole=$rrole;
395: } else {
396: $trole=Apache::lonnet::plaintext($role);
397: }
398: my $ttype;
399: my $twhere;
400: my ($tdom,$trest,$tsection)=
401: split(/\//,Apache::lonnet::declutter($where));
402: # First, Co-Authorship roles
403: if ($role eq 'ca') {
404: my $home = &Apache::lonnet::homeserver($trest,$tdom);
405: if ($home ne $r->dir_config('lonHostID')) {
406: $button=0;
407: $switchserver=&Apache::lonnet::escape('http://'.
408: $Apache::lonnet::hostname{$home}.
409: '/adm/login?domain='.$ENV{'user.domain'}.
410: '&username='.$ENV{'user.name'}.
411: '&firsturl=/priv/'.$trest);
412: }
413: #next if ($home eq 'no_host');
414: $home = $Apache::lonnet::hostname{$home};
415: $ttype='Construction Space';
416: $twhere=&mt('User').': '.$trest.'<br />'.&mt('Domain').
417: ': '.$tdom.'<br />'.
418: ' '.&mt('Server').': '.$home;
419: $ENV{'course.'.$tdom.'_'.$trest.'.description'}='ca';
420: $sortkey=$role."$trest:$tdom";
421: } elsif ($role eq 'au') {
422: # Authors
423: my $home = &Apache::lonnet::homeserver
424: ($ENV{'user.name'},$ENV{'user.domain'});
425: if ($home ne $r->dir_config('lonHostID')) {
426: $button=0;
427: $switchserver=&Apache::lonnet::escape('http://'.
428: $Apache::lonnet::hostname{$home}.
429: '/adm/login?domain='.$ENV{'user.domain'}.
430: '&username='.$ENV{'user.name'}.
431: '&firsturl=/priv/'.$ENV{'user.name'});
432: }
433: #next if ($home eq 'no_host');
434: $home = $Apache::lonnet::hostname{$home};
435: $ttype='Construction Space';
436: $twhere=&mt('Domain').': '.$tdom.'<br />'.&mt('Server').
437: ': '.$home;
438: $ENV{'course.'.$tdom.'_'.$trest.'.description'}='ca';
439: $sortkey=$role;
440: } elsif ($trest) {
441: $ttype='Course';
442: if ($tsection) {
443: $ttype.='<br>'.&mt('Section/Group').': '.$tsection;
444: }
445: my $tcourseid=$tdom.'_'.$trest;
446: if ($ENV{'course.'.$tcourseid.'.description'}) {
447: $twhere=$ENV{'course.'.$tcourseid.'.description'};
448: $sortkey=$tdom."\0".$twhere."\0".$envkey;
449: unless ($twhere eq &mt('Currently not available')) {
450: $twhere.=' <font size="-2">'.
451: &Apache::loncommon::syllabuswrapper(&mt('Syllabus'),$trest,$tdom,$tfont).
452: '</font>';
453: }
454: } else {
455: my %newhash=Apache::lonnet::coursedescription
456: ($tcourseid);
457: if (%newhash) {
458: $sortkey=$tdom."\0".$newhash{'description'}.
459: "\0".$envkey;
460: $twhere=$newhash{'description'}.
461: ' <font size="-2">'.
462: &Apache::loncommon::syllabuswrapper(&mt('Syllabus'),$trest,$tdom,$tfont).
463: '</font>';
464: } else {
465: $twhere=&mt('Currently not available');
466: $ENV{'course.'.$tcourseid.'.description'}=$twhere;
467: $sortkey=$tdom."\0".$twhere."\0".$envkey;
468: }
469: }
470: if ($role ne 'st') { $twhere.="<br />".&mt('Domain').":".$tdom; }
471: } elsif ($tdom) {
472: $ttype='Domain';
473: $twhere=$tdom;
474: $sortkey=$role.$twhere;
475: } else {
476: $ttype='System';
477: $twhere=&mt('system wide');
478: $sortkey=$role.$twhere;
479: }
480:
481: $roletext.='<tr bgcolor='.$tbg.'>';
482: unless ($nochoose) {
483: if (!$button) {
484: if ($switchserver) {
485: $roletext.='<td><a href="/adm/logout?handover='.
486: $switchserver.'">'.&mt('Switch Server').'</a></td>';
487: } else {
488: $roletext.=('<td> </td>');
489: }
490: } elsif ($tstatus eq 'is') {
491: $roletext.=('<td><input type=submit value="'.
492: &mt('Select').'" name="'.
493: $trolecode.'"></td>');
494: } elsif ($tryagain) {
495: $roletext.=
496: '<td><input type=submit value="'.
497: &mt('Try Selecting Again').'" name="'.$trolecode.'"></td>';
498: } elsif ($advanced) {
499: $roletext.=
500: '<td><input type=submit value="'.
501: &mt('Re-Initialize').'" name="'.$trolecode.'"></td>';
502: } else {
503: $roletext.='<td> </td>';
504: }
505: }
506: $tremark.=&Apache::lonannounce::showday(time,1,
507: &Apache::lonannounce::readcalendar($tdom.'_'.$trest));
508:
509: $roletext.='<td><font color="'.$tfont.'">'.$trole.
510: '</font></td><td><font color="'.$tfont.'">'.$ttype.
511: '</font></td><td><font color="'.$tfont.'">'.$twhere.
512: '</font></td><td><font color="'.$tfont.'">'.$tpstart.
513: '</font></td><td><font color="'.$tfont.'">'.$tpend.
514: '</font></td><td><font color="'.$tfont.'">'.$tremark.
515: ' </font></td></tr>'."\n";
516: $roletext{$envkey}=$roletext;
517: if (!$sortkey) {$sortkey=$twhere."\0".$envkey;}
518: $sortrole{$sortkey}=$envkey;
519: $roleclass{$envkey}=$ttype;
520: }
521: }
522: }
523: my $doheaders=-1;
524: foreach my $type ('Construction Space','Course','Domain','System') {
525: my $haverole=0;
526: foreach my $which (sort {uc($a) cmp uc($b)} (keys(%sortrole))) {
527: if ($roleclass{$sortrole{$which}} =~ /^\Q$type\E/) {
528: $haverole=1;
529: }
530: }
531: if ($haverole) { $doheaders++; }
532: }
533: foreach my $type ('Construction Space','Course','Domain','System') {
534: my $output;
535: foreach my $which (sort {uc($a) cmp uc($b)} (keys(%sortrole))) {
536: if ($roleclass{$sortrole{$which}} =~ /^\Q$type\E/) {
537: $output.=&mt($roletext{$sortrole{$which}});
538: }
539: }
540: if ($output) {
541: if ($doheaders > 0) {
542: $r->print("<tr bgcolor='#BBffBB'>".
543: "<td align='center' colspan='7'>$type</td>");
544: }
545: $r->print($output);
546: }
547: }
548: my $tremark='';
549: my $tfont='#003300';
550: if ($ENV{'request.role'} eq 'cm') {
551: $r->print('<tr bgcolor="#11CC55">');
552: $tremark=&mt('Currently selected. ');
553: $tfont='#002200';
554: } else {
555: $r->print('<tr bgcolor="#77FF77">');
556: }
557: unless ($nochoose) {
558: if ($ENV{'request.role'} ne 'cm') {
559: $r->print('<td><input type=submit value="'.
560: &mt('Select').'" name="cm"></td>');
561: } else {
562: $r->print('<td> </td>');
563: }
564: }
565: $r->print('<td colspan=5><font color="'.$tfont.'">'.&mt('No role specified').
566: '</font></td><td><font color="'.$tfont.'">'.$tremark.
567: ' </font></td></tr>'."\n");
568:
569: $r->print('</table>');
570: unless ($nochoose) {
571: $r->print("</form>\n");
572: }
573: # ------------------------------------------------------------ Privileges Info
574: if (($advanced) && (($ENV{'user.error.msg'}) || ($error))) {
575: $r->print('<hr><h2>Current Privileges</h2>');
576:
577: foreach $envkey (sort keys %ENV) {
578: if ($envkey=~/^user\.priv\.$ENV{'request.role'}\./) {
579: my $where=$envkey;
580: $where=~s/^user\.priv\.$ENV{'request.role'}\.//;
581: my $ttype;
582: my $twhere;
583: my ($tdom,$trest,$tsec)=
584: split(/\//,Apache::lonnet::declutter($where));
585: if ($trest) {
586: if ($ENV{'course.'.$tdom.'_'.$trest.'.description'} eq 'ca') {
587: $ttype='Construction Space';
588: $twhere='User: '.$trest.', Domain: '.$tdom;
589: } else {
590: $ttype='Course';
591: $twhere=$ENV{'course.'.$tdom.'_'.$trest.'.description'};
592: if ($tsec) {
593: $twhere.=' (Section/Group: '.$tsec.')';
594: }
595: }
596: } elsif ($tdom) {
597: $ttype='Domain';
598: $twhere=$tdom;
599: } else {
600: $ttype='System';
601: $twhere='/';
602: }
603: $r->print("\n<h3>".$ttype.': '.$twhere.'</h3><ul>');
604: foreach (sort split(/:/,$ENV{$envkey})) {
605: if ($_) {
606: my ($prv,$restr)=split(/\&/,$_);
607: my $trestr='';
608: if ($restr ne 'F') {
609: my $i;
610: $trestr.=' (';
611: for ($i=0;$i<length($restr);$i++) {
612: $trestr.=
613: Apache::lonnet::plaintext(substr($restr,$i,1));
614: if ($i<length($restr)-1) { $trestr.=', '; }
615: }
616: $trestr.=')';
617: }
618: $r->print('<li>'.
619: Apache::lonnet::plaintext($prv).$trestr.
620: '</li>');
621: }
622: }
623: $r->print('</ul>');
624: }
625: }
626: }
627: $r->print(&Apache::lonnet::getannounce());
628: if ($advanced) {
629: $r->print('<p><small><i>This is LON-CAPA '.
630: $r->dir_config('lonVersion').'</i></small></p>');
631: }
632: $r->print("</body></html>\n");
633: return OK;
634: }
635:
636: 1;
637: __END__
638:
639: =head1 NAME
640:
641: Apache::lonroles - User Roles Screen
642:
643: =head1 SYNOPSIS
644:
645: Invoked by /etc/httpd/conf/srm.conf:
646:
647: <Location /adm/roles>
648: PerlAccessHandler Apache::lonacc
649: SetHandler perl-script
650: PerlHandler Apache::lonroles
651: ErrorDocument 403 /adm/login
652: ErrorDocument 500 /adm/errorhandler
653: </Location>
654:
655: =head1 OVERVIEW
656:
657: =head2 Choosing Roles
658:
659: C<lonroles> is a handler that allows a user to switch roles in
660: mid-session. LON-CAPA attempts to work with "No Role Specified", the
661: default role that a user has before selecting a role, as widely as
662: possible, but certain handlers for example need specification which
663: course they should act on, etc. Both in this scenario, and when the
664: handler determines via C<lonnet>'s C<&allowed> function that a certain
665: action is not allowed, C<lonroles> is used as error handler. This
666: allows the user to select another role which may have permission to do
667: what they were trying to do. C<lonroles> can also be accessed via the
668: B<CRS> button in the Remote Control.
669:
670: =begin latex
671:
672: \begin{figure}
673: \begin{center}
674: \includegraphics[width=0.45\paperwidth,keepaspectratio]{Sample_Roles_Screen}
675: \caption{\label{Sample_Roles_Screen}Sample Roles Screen}
676: \end{center}
677: \end{figure}
678:
679: =end latex
680:
681: =head2 Role Initialization
682:
683: 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.
684:
685: =head1 INTRODUCTION
686:
687: This module enables a user to select what role he wishes to
688: operate under (instructor, student, teaching assistant, course
689: coordinator, etc). These roles are pre-established by the actions
690: of upper-level users.
691:
692: This is part of the LearningOnline Network with CAPA project
693: described at http://www.lon-capa.org.
694:
695: =head1 HANDLER SUBROUTINE
696:
697: This routine is called by Apache and mod_perl.
698:
699: =over 4
700:
701: =item *
702:
703: Roles Initialization (yes/no)
704:
705: =item *
706:
707: Get Error Message from Environment
708:
709: =item *
710:
711: Who is this?
712:
713: =item *
714:
715: Generate Page Output
716:
717: =item *
718:
719: Choice or no choice
720:
721: =item *
722:
723: Table
724:
725: =item *
726:
727: Privileges
728:
729: =back
730:
731: =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