Annotation of loncom/auth/lonroles.pm, revision 1.41
1.1 harris41 1: # The LearningOnline Network with CAPA
2: # User Roles Screen
1.31 www 3: #
1.41 ! www 4: # $Id: lonroles.pm,v 1.40 2002/08/08 19:29:30 matthew Exp $
1.31 www 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: #
1.1 harris41 28: # (Directory Indexer
29: # (Login Screen
1.32 harris41 30: # YEAR=1999
1.1 harris41 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)
1.32 harris41 33: # YEAR=2000
1.7 www 34: # 1/14,03/06,06/01,07/22,07/24,07/25,
1.19 www 35: # 09/04,09/06,09/28,09/29,09/30,10/2,10/5,10/26,10/28,
1.20 www 36: # 12/08,12/28,
1.32 harris41 37: # YEAR=2001
1.20 www 38: # 01/15/01 Gerd Kortemeyer
1.22 harris41 39: # 02/27/01 Scott Harrison
1.28 www 40: # 03/02,05/03,05/25,05/30,06/01,07/06,08/06 Gerd Kortemeyer
1.32 harris41 41: # 12/21 Scott Harrison
1.33 www 42: # 12/29 Gerd Kortemeyer
1.32 harris41 43: #
44: ###
1.22 harris41 45:
1.1 harris41 46: package Apache::lonroles;
47:
48: use strict;
49: use Apache::lonnet();
1.7 www 50: use Apache::lonuserstate();
1.1 harris41 51: use Apache::Constants qw(:common);
1.2 www 52: use Apache::File();
1.26 www 53: use Apache::lonmenu;
1.29 albertel 54: use Apache::loncommon;
1.1 harris41 55:
56: sub handler {
1.10 www 57:
1.1 harris41 58: my $r = shift;
59:
1.6 www 60: my $now=time;
61: my $then=$ENV{'user.login.time'};
62: my $envkey;
63:
1.10 www 64:
1.6 www 65: # ================================================================== Roles Init
66:
67: if ($ENV{'form.selectrole'}) {
1.33 www 68: if ($ENV{'request.course.id'}) {
69: my %temp=('logout_'.$ENV{'request.course.id'} => time);
70: &Apache::lonnet::put('email_status',\%temp);
71: }
1.40 matthew 72: &Apache::lonnet::appenv("request.course.id" => '',
73: "request.course.fn" => '',
74: "request.course.uri" => '',
75: "request.course.sec" => '',
76: "request.role" => 'cm',
77: "request.role.domain" => $ENV{'user.domain'});
1.13 www 78: foreach $envkey (keys %ENV) {
1.40 matthew 79: next if ($envkey!~/^user\.role\./);
80: my (undef,undef,$role,@pwhere)=split(/\./,$envkey);
1.6 www 81: my $where=join('.',@pwhere);
82: my $trolecode=$role.'.'.$where;
83: if ($ENV{'form.'.$trolecode}) {
84: my ($tstart,$tend)=split(/\./,$ENV{$envkey});
85: my $tstatus='is';
86: if ($tstart) {
87: if ($tstart>$then) {
88: $tstatus='future';
89: }
90: }
91: if ($tend) {
92: if ($tend<$then) { $tstatus='expired'; }
1.19 www 93: if ($tend<$now) { $tstatus='will_not'; }
1.6 www 94: }
95: if ($tstatus eq 'is') {
1.13 www 96: $where=~s/^\///;
97: my ($cdom,$cnum,$csec)=split(/\//,$where);
1.40 matthew 98: &Apache::lonnet::appenv('request.role' => $trolecode,
99: 'request.role.domain' => $cdom,
100: 'request.course.sec' => $csec);
1.27 www 101: my $msg='Entering course ...';
1.25 www 102: if (($cnum) && ($role ne 'ca')) {
1.19 www 103: my ($furl,$ferr)=
104: &Apache::lonuserstate::readmap($cdom.'/'.$cnum);
1.20 www 105: if (($ENV{'form.orgurl'}) &&
106: ($ENV{'form.orgurl'}!~/^\/adm\/flip/)) {
1.11 www 107: $r->internal_redirect($ENV{'form.orgurl'});
108: return OK;
1.19 www 109: } else {
1.27 www 110: unless ($ENV{'request.course.id'}) {
111: &Apache::lonnet::appenv(
112: "request.course.id" => $cdom.'_'.$cnum);
113: $furl='/adm/notfound.html';
114: $msg=
115: '<h1><font color=red>Could not initialize top-level map.</font></h1>';
116: }
1.20 www 117: $r->content_type('text/html');
1.30 albertel 118: &Apache::loncommon::no_cache($r);
1.20 www 119: $r->send_http_header;
1.36 matthew 120: my $swinfo=&Apache::lonmenu::rawconfig($r);
1.20 www 121: print (<<ENDREDIR);
122: <head><title>Entering Course</title>
123: <meta HTTP-EQUIV="Refresh" CONTENT="1; url=$furl">
124: </head>
125: <html>
126: <body bgcolor="#FFFFFF">
1.26 www 127: <script>
128: $swinfo
129: </script>
1.27 www 130: $msg
1.20 www 131: </body>
132: </html>
133: ENDREDIR
134: return OK;
1.19 www 135: }
1.7 www 136: }
1.6 www 137: }
138: }
139: }
1.40 matthew 140: }
1.6 www 141:
1.10 www 142:
1.6 www 143: # =============================================================== No Roles Init
1.10 www 144:
145: $r->content_type('text/html');
1.30 albertel 146: &Apache::loncommon::no_cache($r);
1.10 www 147: $r->send_http_header;
148: return OK if $r->header_only;
149:
1.36 matthew 150: my $swinfo=&Apache::lonmenu::rawconfig($r);
1.41 ! www 151: my $bodytag=&Apache::loncommon::bodytag('User Roles');
1.10 www 152: $r->print(<<ENDHEADER);
153: <html>
154: <head>
155: <title>LON-CAPA User Roles</title>
1.41 ! www 156: </head>
! 157: $bodytag
1.26 www 158: <script>
159: $swinfo
160: window.focus();
161: </script>
1.10 www 162: ENDHEADER
1.6 www 163:
1.2 www 164: # ------------------------------------------ Get Error Message from Environment
165:
166: my ($fn,$priv,$nochoose,$error,$msg)=split(/:/,$ENV{'user.error.msg'});
1.12 www 167: if ($ENV{'user.error.msg'}) {
168: $r->log_reason(
169: "$msg for $ENV{'user.name'} domain $ENV{'user.domain'} access $priv",$fn);
170: }
1.1 harris41 171:
1.6 www 172: # ---------------------------------------------------------------- Who is this?
173:
174: my $advanced=0;
175: foreach $envkey (keys %ENV) {
176: if ($envkey=~/^user\.role\./) {
1.40 matthew 177: my (undef,undef,$role,@pwhere)=split(/\./,$envkey);
1.6 www 178: if ($role ne 'st') { $advanced=1; }
179: }
180: }
181:
1.2 www 182: # -------------------------------------------------------- Generate Page Output
1.6 www 183: # --------------------------------------------------------------- Error Header?
1.2 www 184: if ($error) {
185: $r->print("<h1>LON-CAPA Access Control</h1>");
1.4 www 186: $r->print("<hr><pre>Access : ".
187: Apache::lonnet::plaintext($priv)."\n");
188: $r->print("Resource: $fn\n");
189: $r->print("Action : $msg\n</pre><hr>");
1.2 www 190: } else {
1.25 www 191: if ($ENV{'user.error.msg'}) {
192: $r->print(
193: '<h3><font color=red>You need to choose another user role or '.
194: 'enter a specific course for this function</font></h3>');
195: }
1.2 www 196: }
1.6 www 197: # -------------------------------------------------------- Choice or no choice?
1.2 www 198: if ($nochoose) {
1.6 www 199: if ($advanced) {
200: $r->print("<h2>Assigned User Roles</h2>\n");
201: } else {
202: $r->print("<h2>Sorry ...</h2>\nThis resource might be part of");
203: if ($ENV{'request.course.id'}) {
204: $r->print(' another');
205: } else {
206: $r->print(' a certain');
207: }
208: $r->print(' course.</body></html>');
209: return OK;
210: }
211: } else {
212: if ($advanced) {
1.35 matthew 213: $r->print("Your home server is ".
214: $Apache::lonnet::hostname{&Apache::lonnet::homeserver
1.39 stredwic 215: ($ENV{'user.name'},$ENV{'user.domain'})}.
1.38 stredwic 216: "<br />\n");
1.35 matthew 217: $r->print("Author and Co-Author roles may not be available on ".
218: "servers other than your home server.");
1.6 www 219: } else {
220: $r->print("<h2>Enter a Course</h2>\n");
1.17 www 221: }
1.18 www 222: if (($ENV{'REDIRECT_QUERY_STRING'}) && ($fn)) {
223: $fn.='?'.$ENV{'REDIRECT_QUERY_STRING'};
1.6 www 224: }
1.11 www 225: $r->print('<form method=post action="'.(($fn)?$fn:$r->uri).'">');
1.6 www 226: $r->print('<input type=hidden name=orgurl value="'.$fn.'">');
227: $r->print('<input type=hidden name=selectrole value=1>');
228: }
1.27 www 229: $r->print('<br>Show all roles: <input type=checkbox name=showall');
230: if ($ENV{'form.showall'}) { $r->print(' checked'); }
231: $r->print('><input type=submit value="Display"><br>');
1.6 www 232: # ----------------------------------------------------------------------- Table
233: $r->print('<table><tr>');
234: unless ($nochoose) { $r->print('<th> </th>'); }
235: $r->print('<th>User Role</th><th colspan=2>Extent</th>'.
236: '<th>Start</th><th>End</th><th>Remark</th></tr>'."\n");
1.4 www 237:
1.3 albertel 238: foreach $envkey (sort keys %ENV) {
1.35 matthew 239: my $button = 1;
1.2 www 240: if ($envkey=~/^user\.role\./) {
1.40 matthew 241: my (undef,undef,$role,@pwhere)=split(/\./,$envkey);
1.4 www 242: my $where=join('.',@pwhere);
1.6 www 243: my $trolecode=$role.'.'.$where;
1.4 www 244: my ($tstart,$tend)=split(/\./,$ENV{$envkey});
245: my $tremark='';
246: my $tstatus='is';
247: my $tpstart=' ';
248: my $tpend=' ';
249: if ($tstart) {
250: if ($tstart>$then) {
1.35 matthew 251: $tstatus='future';
252: if ($tstart<$now) { $tstatus='will'; }
1.4 www 253: }
254: $tpstart=localtime($tstart);
255: }
256: if ($tend) {
1.23 www 257: if ($tend<$then) {
1.35 matthew 258: $tstatus='expired';
1.23 www 259: } elsif ($tend<$now) {
1.35 matthew 260: $tstatus='will_not';
1.23 www 261: }
1.4 www 262: $tpend=localtime($tend);
263: }
1.6 www 264: if ($ENV{'request.role'} eq $trolecode) {
265: $tstatus='selected';
266: }
1.4 www 267: my $tbg;
1.35 matthew 268: if (($tstatus eq 'is') || ($tstatus eq 'selected') ||
269: ($ENV{'form.showall'})) {
270: if ($tstatus eq 'is') {
271: $tbg='#77FF77';
272: } elsif ($tstatus eq 'future') {
273: $tbg='#FFFF77';
274: } elsif ($tstatus eq 'will') {
275: $tbg='#FFAA77';
276: $tremark.='Active at next login. ';
277: } elsif ($tstatus eq 'expired') {
278: $tbg='#FF7777';
279: } elsif ($tstatus eq 'will_not') {
280: $tbg='#AAFF77';
281: $tremark.='Expired after logout. ';
282: } elsif ($tstatus eq 'selected') {
283: $tbg='#11CC55';
284: $tremark.='Currently selected. ';
285: }
286: my $trole;
287: if ($role =~ /^cr\//) {
288: my ($rdummy,$rdomain,$rauthor,$rrole)=split(/\//,$role);
289: $tremark.='<br>Defined by '.$rauthor.' at '.$rdomain.'.';
290: $trole=$rrole;
1.8 www 291: } else {
1.35 matthew 292: $trole=Apache::lonnet::plaintext($role);
293: }
294: my $ttype;
295: my $twhere;
296: my ($tdom,$trest,$tsection)=
297: split(/\//,Apache::lonnet::declutter($where));
298: # First, Co-Authorship roles
299: if ($role eq 'ca') {
1.39 stredwic 300: my $home = &Apache::lonnet::homeserver($trest,$tdom);
1.35 matthew 301: $button = 0 if ($home ne $r->dir_config('lonHostID'));
302: #next if ($home eq 'no_host');
303: $home = $Apache::lonnet::hostname{$home};
304: $ttype='Construction Space';
305: $twhere='User: '.$trest.'<br />Domain: '.$tdom.'<br />'.
306: ' Server: '.$home;
307: $ENV{'course.'.$tdom.'_'.$trest.'.description'}='ca';
308: } elsif ($role eq 'au') {
309: # Authors
310: my $home = &Apache::lonnet::homeserver
1.39 stredwic 311: ($ENV{'user.name'},$ENV{'user.domain'});
1.35 matthew 312: $button = 0 if ($home ne $r->dir_config('lonHostID'));
313: #next if ($home eq 'no_host');
314: $home = $Apache::lonnet::hostname{$home};
315: $ttype='Construction Space';
316: $twhere='Domain: '.$tdom.'<br />Server: '.$home;
317: $ENV{'course.'.$tdom.'_'.$trest.'.description'}='ca';
318: } elsif ($trest) {
319: $ttype='Course';
320: if ($tsection) {
321: $ttype.='<br>Section/Group: '.$tsection;
1.37 albertel 322: }
1.35 matthew 323: my $tcourseid=$tdom.'_'.$trest;
324: if ($ENV{'course.'.$tcourseid.'.description'}) {
325: $twhere=$ENV{'course.'.$tcourseid.'.description'};
1.8 www 326: } else {
1.35 matthew 327: my %newhash=Apache::lonnet::coursedescription
328: ($tcourseid);
329: if (%newhash) {
330: $twhere=$newhash{'description'};
331: } else {
332: $twhere='Currently not available';
333: $ENV{'course.'.$tcourseid.'.description'}=$twhere;
334: }
1.8 www 335: }
1.37 albertel 336: if ($role ne 'st') { $twhere.="<br />Domain:".$tdom; }
1.35 matthew 337: } elsif ($tdom) {
338: $ttype='Domain';
339: $twhere=$tdom;
340: } else {
341: $ttype='System';
342: $twhere='system wide';
1.13 www 343: }
1.35 matthew 344:
345: # ----- do not trust the indention below here -----
346: $r->print('<tr bgcolor='.$tbg.'>');
347: unless ($nochoose) {
348: if (!$button) {
349: $r->print('<td> </td>');
350: } elsif ($tstatus eq 'is') {
351: $r->print('<td><input type=submit value=Select name="'.
352: $trolecode.'"></td>');
353: } elsif ($ENV{'user.adv'}) {
354: $r->print
355: ('<td><input type=submit value="Re-Initialize"'.
356: ' name="'.$trolecode.'"></td>');
357: } else {
358: $r->print('<td> </td>');
359: }
1.6 www 360: }
361: $r->print('<td>'.$trole.'</td><td>'.
1.4 www 362: $ttype.'</td><td>'.$twhere.'</td><td>'.$tpstart.
363: '</td><td>'.$tpend.
364: '</td><td>'.$tremark.' </td></tr>'."\n");
1.27 www 365: }
1.4 www 366: }
367: }
1.14 www 368: my $tremark='';
369: if ($ENV{'request.role'} eq 'cm') {
1.19 www 370: $r->print('<tr bgcolor="#11CC55">');
1.14 www 371: $tremark='Currently selected.';
372: } else {
373: $r->print('<tr bgcolor="#77FF77">');
374: }
375: unless ($nochoose) {
376: if ($ENV{'request.role'} ne 'cm') {
377: $r->print('<td><input type=submit value=Select name="cm"></td>');
378: } else {
379: $r->print('<td> </td>');
380: }
381: }
382: $r->print('<td colspan=5>No role specified'.
383: '</td><td>'.$tremark.' </td></tr>'."\n");
1.4 www 384:
385: $r->print('</table>');
386: unless ($nochoose) {
387: $r->print("</form>\n");
388: }
1.22 harris41 389: # ------------------------------------------------------------ Privileges Info
1.6 www 390: if ($advanced) {
1.22 harris41 391: $r->print('<hr><h2>Current Privileges</h2>');
1.4 www 392:
393: foreach $envkey (sort keys %ENV) {
1.15 www 394: if ($envkey=~/^user\.priv\.$ENV{'request.role'}\./) {
395: my $where=$envkey;
396: $where=~s/^user\.priv\.$ENV{'request.role'}\.//;
1.4 www 397: my $ttype;
398: my $twhere;
1.15 www 399: my ($tdom,$trest,$tsec)=
1.8 www 400: split(/\//,Apache::lonnet::declutter($where));
1.6 www 401: if ($trest) {
1.24 www 402: if ($ENV{'course.'.$tdom.'_'.$trest.'.description'} eq 'ca') {
403: $ttype='Construction Space';
404: $twhere='User: '.$trest.', Domain: '.$tdom;
405: } else {
1.4 www 406: $ttype='Course';
1.16 www 407: $twhere=$ENV{'course.'.$tdom.'_'.$trest.'.description'};
1.15 www 408: if ($tsec) {
409: $twhere.=' (Section/Group: '.$tsec.')';
410: }
1.24 www 411: }
1.4 www 412: } elsif ($tdom) {
413: $ttype='Domain';
414: $twhere=$tdom;
415: } else {
416: $ttype='System';
417: $twhere='/';
418: }
419: $r->print("\n<h3>".$ttype.': '.$twhere.'</h3><ul>');
1.32 harris41 420: foreach (sort split(/:/,$ENV{$envkey})) {
1.4 www 421: if ($_) {
422: my ($prv,$restr)=split(/\&/,$_);
423: my $trestr='';
424: if ($restr ne 'F') {
425: my $i;
1.5 www 426: $trestr.=' (';
1.4 www 427: for ($i=0;$i<length($restr);$i++) {
1.5 www 428: $trestr.=
429: Apache::lonnet::plaintext(substr($restr,$i,1));
430: if ($i<length($restr)-1) { $trestr.=', '; }
431: }
432: $trestr.=')';
1.4 www 433: }
434: $r->print('<li>'.Apache::lonnet::plaintext($prv).$trestr.
435: '</li>');
436: }
1.32 harris41 437: }
1.4 www 438: $r->print('</ul>');
1.2 www 439: }
1.4 www 440: }
1.6 www 441: }
1.2 www 442:
1.1 harris41 443: $r->print("</body></html>\n");
444: return OK;
445: }
446:
447: 1;
448: __END__
1.32 harris41 449:
450: =head1 NAME
451:
452: Apache::lonroles - User Roles Screen
453:
454: =head1 SYNOPSIS
455:
456: Invoked by /etc/httpd/conf/srm.conf:
457:
458: <Location /adm/roles>
459: PerlAccessHandler Apache::lonacc
460: SetHandler perl-script
461: PerlHandler Apache::lonroles
462: ErrorDocument 403 /adm/login
463: ErrorDocument 500 /adm/errorhandler
464: </Location>
465:
466: =head1 INTRODUCTION
467:
468: This module enables a user to select what role he wishes to
469: operate under (instructor, student, teaching assistant, course
470: coordinator, etc). These roles are pre-established by the actions
471: of upper-level users.
472:
473: This is part of the LearningOnline Network with CAPA project
474: described at http://www.lon-capa.org.
475:
476: =head1 HANDLER SUBROUTINE
477:
478: This routine is called by Apache and mod_perl.
479:
480: =over 4
481:
482: =item *
483:
484: Roles Initialization (yes/no)
485:
486: =item *
487:
488: Get Error Message from Environment
489:
490: =item *
491:
492: Who is this?
493:
494: =item *
495:
496: Generate Page Output
497:
498: =item *
499:
500: Choice or no choice
501:
502: =item *
503:
504: Table
505:
506: =item *
507:
508: Privileges
509:
510: =back
511:
512: =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