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