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