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