1: # The LearningOnline Network
2: # TCP networking package
3: #
4: # $Id: lonnet.pm,v 1.398.2.1.2.1 2003/08/22 16:24:45 albertel 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: # 6/1/99,6/2,6/10,6/11,6/12,6/14,6/26,6/28,6/29,6/30,
29: # 7/1,7/2,7/9,7/10,7/12,7/14,7/15,7/19,
30: # 11/8,11/16,11/18,11/22,11/23,12/22,
31: # 01/06,01/13,02/24,02/28,02/29,
32: # 03/01,03/02,03/06,03/07,03/13,
33: # 04/05,05/29,05/31,06/01,
34: # 06/05,06/26 Gerd Kortemeyer
35: # 06/26 Ben Tyszka
36: # 06/30,07/15,07/17,07/18,07/20,07/21,07/22,07/25 Gerd Kortemeyer
37: # 08/14 Ben Tyszka
38: # 08/22,08/28,08/31,09/01,09/02,09/04,09/05,09/25,09/28,09/30 Gerd Kortemeyer
39: # 10/04 Gerd Kortemeyer
40: # 10/04 Guy Albertelli
41: # 10/06,10/09,10/10,10/11,10/14,10/20,10/23,10/25,10/26,10/27,10/28,10/29,
42: # 10/30,10/31,
43: # 11/2,11/14,11/15,11/16,11/20,11/21,11/22,11/25,11/27,
44: # 12/02,12/12,12/13,12/14,12/28,12/29 Gerd Kortemeyer
45: # 05/01/01 Guy Albertelli
46: # 05/01,06/01,09/01 Gerd Kortemeyer
47: # 09/01 Guy Albertelli
48: # 09/01,10/01,11/01 Gerd Kortemeyer
49: # YEAR=2001
50: # 3/2 Gerd Kortemeyer
51: # 3/19,3/20 Gerd Kortemeyer
52: # 5/26,5/28 Gerd Kortemeyer
53: # 5/30 H. K. Ng
54: # 6/1 Gerd Kortemeyer
55: # July Guy Albertelli
56: # 8/4,8/7,8/8,8/9,8/11,8/16,8/17,8/18,8/20,8/23,9/20,9/21,9/26,
57: # 10/2 Gerd Kortemeyer
58: # 11/17,11/20,11/22,11/29 Gerd Kortemeyer
59: # 12/5 Matthew Hall
60: # 12/5 Guy Albertelli
61: # 12/6,12/7,12/12 Gerd Kortemeyer
62: # 12/21,12/22,12/27,12/28 Gerd Kortemeyer
63: # YEAR=2002
64: # 1/4,2/4,2/7 Gerd Kortemeyer
65: #
66: ###
67:
68: package Apache::lonnet;
69:
70: use strict;
71: use Apache::File;
72: use LWP::UserAgent();
73: use HTTP::Headers;
74: use vars
75: qw(%perlvar %hostname %homecache %badServerCache %hostip %iphost %spareid %hostdom
76: %libserv %pr %prp %metacache %packagetab %titlecache
77: %courselogs %accesshash %userrolehash $processmarker $dumpcount
78: %coursedombuf %coursenumbuf %coursehombuf %coursedescrbuf %courseresdatacache
79: %domaindescription %domain_auth_def %domain_auth_arg_def $tmpdir);
80: use IO::Socket;
81: use GDBM_File;
82: use Apache::Constants qw(:common :http);
83: use HTML::LCParser;
84: use Fcntl qw(:flock);
85: use Apache::loncoursedata;
86:
87: my $readit;
88:
89: # --------------------------------------------------------------------- Logging
90:
91: sub logtouch {
92: my $execdir=$perlvar{'lonDaemons'};
93: unless (-e "$execdir/logs/lonnet.log") {
94: my $fh=Apache::File->new(">>$execdir/logs/lonnet.log");
95: close $fh;
96: }
97: my ($wwwuid,$wwwgid)=(getpwnam('www'))[2,3];
98: chown($wwwuid,$wwwgid,$execdir.'/logs/lonnet.log');
99: }
100:
101: sub logthis {
102: my $message=shift;
103: my $execdir=$perlvar{'lonDaemons'};
104: my $now=time;
105: my $local=localtime($now);
106: my $fh=Apache::File->new(">>$execdir/logs/lonnet.log");
107: print $fh "$local ($$): $message\n";
108: return 1;
109: }
110:
111: sub logperm {
112: my $message=shift;
113: my $execdir=$perlvar{'lonDaemons'};
114: my $now=time;
115: my $local=localtime($now);
116: my $fh=Apache::File->new(">>$execdir/logs/lonnet.perm.log");
117: print $fh "$now:$message:$local\n";
118: return 1;
119: }
120:
121: # -------------------------------------------------- Non-critical communication
122: sub subreply {
123: my ($cmd,$server)=@_;
124: my $peerfile="$perlvar{'lonSockDir'}/$server";
125: my $client=IO::Socket::UNIX->new(Peer =>"$peerfile",
126: Type => SOCK_STREAM,
127: Timeout => 10)
128: or return "con_lost";
129: print $client "$cmd\n";
130: my $answer=<$client>;
131: if (!$answer) { $answer="con_lost"; }
132: chomp($answer);
133: return $answer;
134: }
135:
136: sub reply {
137: my ($cmd,$server)=@_;
138: unless (defined($hostname{$server})) { return 'no_such_host'; }
139: my $answer=subreply($cmd,$server);
140: if ($answer eq 'con_lost') {
141: #sleep 5;
142: #$answer=subreply($cmd,$server);
143: #if ($answer eq 'con_lost') {
144: # &logthis("Second attempt con_lost on $server");
145: # my $peerfile="$perlvar{'lonSockDir'}/$server";
146: # my $client=IO::Socket::UNIX->new(Peer =>"$peerfile",
147: # Type => SOCK_STREAM,
148: # Timeout => 10)
149: # or return "con_lost";
150: # &logthis("Killing socket");
151: # print $client "close_connection_exit\n";
152: #sleep 5;
153: # $answer=subreply($cmd,$server);
154: #}
155: }
156: if (($answer=~/^refused/) || ($answer=~/^rejected/)) {
157: &logthis("<font color=blue>WARNING:".
158: " $cmd to $server returned $answer</font>");
159: }
160: return $answer;
161: }
162:
163: # ----------------------------------------------------------- Send USR1 to lonc
164:
165: sub reconlonc {
166: my $peerfile=shift;
167: &logthis("Trying to reconnect for $peerfile");
168: my $loncfile="$perlvar{'lonDaemons'}/logs/lonc.pid";
169: if (my $fh=Apache::File->new("$loncfile")) {
170: my $loncpid=<$fh>;
171: chomp($loncpid);
172: if (kill 0 => $loncpid) {
173: &logthis("lonc at pid $loncpid responding, sending USR1");
174: kill USR1 => $loncpid;
175: sleep 1;
176: if (-e "$peerfile") { return; }
177: &logthis("$peerfile still not there, give it another try");
178: sleep 5;
179: if (-e "$peerfile") { return; }
180: &logthis(
181: "<font color=blue>WARNING: $peerfile still not there, giving up</font>");
182: } else {
183: &logthis(
184: "<font color=blue>WARNING:".
185: " lonc at pid $loncpid not responding, giving up</font>");
186: }
187: } else {
188: &logthis('<font color=blue>WARNING: lonc not running, giving up</font>');
189: }
190: }
191:
192: # ------------------------------------------------------ Critical communication
193:
194: sub critical {
195: my ($cmd,$server)=@_;
196: unless ($hostname{$server}) {
197: &logthis("<font color=blue>WARNING:".
198: " Critical message to unknown server ($server)</font>");
199: return 'no_such_host';
200: }
201: my $answer=reply($cmd,$server);
202: if ($answer eq 'con_lost') {
203: my $pingreply=reply('ping',$server);
204: &reconlonc("$perlvar{'lonSockDir'}/$server");
205: my $pongreply=reply('pong',$server);
206: &logthis("Ping/Pong for $server: $pingreply/$pongreply");
207: $answer=reply($cmd,$server);
208: if ($answer eq 'con_lost') {
209: my $now=time;
210: my $middlename=$cmd;
211: $middlename=substr($middlename,0,16);
212: $middlename=~s/\W//g;
213: my $dfilename=
214: "$perlvar{'lonSockDir'}/delayed/$now.$dumpcount.$$.$middlename.$server";
215: $dumpcount++;
216: {
217: my $dfh;
218: if ($dfh=Apache::File->new(">$dfilename")) {
219: print $dfh "$cmd\n";
220: }
221: }
222: sleep 2;
223: my $wcmd='';
224: {
225: my $dfh;
226: if ($dfh=Apache::File->new("$dfilename")) {
227: $wcmd=<$dfh>;
228: }
229: }
230: chomp($wcmd);
231: if ($wcmd eq $cmd) {
232: &logthis("<font color=blue>WARNING: ".
233: "Connection buffer $dfilename: $cmd</font>");
234: &logperm("D:$server:$cmd");
235: return 'con_delayed';
236: } else {
237: &logthis("<font color=red>CRITICAL:"
238: ." Critical connection failed: $server $cmd</font>");
239: &logperm("F:$server:$cmd");
240: return 'con_failed';
241: }
242: }
243: }
244: return $answer;
245: }
246:
247: # ------------------------------------------- Transfer profile into environment
248:
249: sub transfer_profile_to_env {
250: my ($lonidsdir,$handle)=@_;
251: my @profile;
252: {
253: my $idf=Apache::File->new("$lonidsdir/$handle.id");
254: flock($idf,LOCK_SH);
255: @profile=<$idf>;
256: $idf->close();
257: }
258: my $envi;
259: for ($envi=0;$envi<=$#profile;$envi++) {
260: chomp($profile[$envi]);
261: my ($envname,$envvalue)=split(/=/,$profile[$envi]);
262: $ENV{$envname} = $envvalue;
263: }
264: $ENV{'user.environment'} = "$lonidsdir/$handle.id";
265: }
266:
267: # ---------------------------------------------------------- Append Environment
268:
269: sub appenv {
270: my %newenv=@_;
271: foreach (keys %newenv) {
272: if (($newenv{$_}=~/^user\.role/) || ($newenv{$_}=~/^user\.priv/)) {
273: &logthis("<font color=blue>WARNING: ".
274: "Attempt to modify environment ".$_." to ".$newenv{$_}
275: .'</font>');
276: delete($newenv{$_});
277: } else {
278: $ENV{$_}=$newenv{$_};
279: }
280: }
281:
282: my $lockfh;
283: unless ($lockfh=Apache::File->new("$ENV{'user.environment'}")) {
284: return 'error: '.$!;
285: }
286: unless (flock($lockfh,LOCK_EX)) {
287: &logthis("<font color=blue>WARNING: ".
288: 'Could not obtain exclusive lock in appenv: '.$!);
289: $lockfh->close();
290: return 'error: '.$!;
291: }
292:
293: my @oldenv;
294: {
295: my $fh;
296: unless ($fh=Apache::File->new("$ENV{'user.environment'}")) {
297: return 'error: '.$!;
298: }
299: @oldenv=<$fh>;
300: $fh->close();
301: }
302: for (my $i=0; $i<=$#oldenv; $i++) {
303: chomp($oldenv[$i]);
304: if ($oldenv[$i] ne '') {
305: my ($name,$value)=split(/=/,$oldenv[$i]);
306: unless (defined($newenv{$name})) {
307: $newenv{$name}=$value;
308: }
309: }
310: }
311: {
312: my $fh;
313: unless ($fh=Apache::File->new(">$ENV{'user.environment'}")) {
314: return 'error';
315: }
316: my $newname;
317: foreach $newname (keys %newenv) {
318: print $fh "$newname=$newenv{$newname}\n";
319: }
320: $fh->close();
321: }
322:
323: $lockfh->close();
324: return 'ok';
325: }
326: # ----------------------------------------------------- Delete from Environment
327:
328: sub delenv {
329: my $delthis=shift;
330: my %newenv=();
331: if (($delthis=~/user\.role/) || ($delthis=~/user\.priv/)) {
332: &logthis("<font color=blue>WARNING: ".
333: "Attempt to delete from environment ".$delthis);
334: return 'error';
335: }
336: my @oldenv;
337: {
338: my $fh;
339: unless ($fh=Apache::File->new("$ENV{'user.environment'}")) {
340: return 'error';
341: }
342: unless (flock($fh,LOCK_SH)) {
343: &logthis("<font color=blue>WARNING: ".
344: 'Could not obtain shared lock in delenv: '.$!);
345: $fh->close();
346: return 'error: '.$!;
347: }
348: @oldenv=<$fh>;
349: $fh->close();
350: }
351: {
352: my $fh;
353: unless ($fh=Apache::File->new(">$ENV{'user.environment'}")) {
354: return 'error';
355: }
356: unless (flock($fh,LOCK_EX)) {
357: &logthis("<font color=blue>WARNING: ".
358: 'Could not obtain exclusive lock in delenv: '.$!);
359: $fh->close();
360: return 'error: '.$!;
361: }
362: foreach (@oldenv) {
363: unless ($_=~/^$delthis/) { print $fh $_; }
364: }
365: $fh->close();
366: }
367: return 'ok';
368: }
369:
370: # ------------------------------------------ Find out current server userload
371: # there is a copy in lond
372: sub userload {
373: my $numusers=0;
374: {
375: opendir(LONIDS,$perlvar{'lonIDsDir'});
376: my $filename;
377: my $curtime=time;
378: while ($filename=readdir(LONIDS)) {
379: if ($filename eq '.' || $filename eq '..') {next;}
380: my ($mtime)=(stat($perlvar{'lonIDsDir'}.'/'.$filename))[9];
381: if ($curtime-$mtime < 3600) { $numusers++; }
382: }
383: closedir(LONIDS);
384: }
385: my $userloadpercent=0;
386: my $maxuserload=$perlvar{'lonUserLoadLim'};
387: if ($maxuserload) {
388: $userloadpercent=100*$numusers/$maxuserload;
389: }
390: $userloadpercent=sprintf("%.2f",$userloadpercent);
391: return $userloadpercent;
392: }
393:
394: # ------------------------------------------ Fight off request when overloaded
395:
396: sub overloaderror {
397: my ($r,$checkserver)=@_;
398: unless ($checkserver) { $checkserver=$perlvar{'lonHostID'}; }
399: my $loadavg;
400: if ($checkserver eq $perlvar{'lonHostID'}) {
401: my $loadfile=Apache::File->new('/proc/loadavg');
402: $loadavg=<$loadfile>;
403: $loadavg =~ s/\s.*//g;
404: $loadavg = 100*$loadavg/$perlvar{'lonLoadLim'};
405: } else {
406: $loadavg=&reply('load',$checkserver);
407: }
408: my $overload=$loadavg-100;
409: if ($overload>0) {
410: $r->err_headers_out->{'Retry-After'}=$overload;
411: $r->log_error('Overload of '.$overload.' on '.$checkserver);
412: return 413;
413: }
414: return '';
415: }
416:
417: # ------------------------------ Find server with least workload from spare.tab
418:
419: sub spareserver {
420: my ($loadpercent,$userloadpercent) = @_;
421: my $tryserver;
422: my $spareserver='';
423: if ($userloadpercent !~ /\d/) { $userloadpercent=0; }
424: my $lowestserver=$loadpercent > $userloadpercent?
425: $loadpercent : $userloadpercent;
426: foreach $tryserver (keys %spareid) {
427: my $loadans=reply('load',$tryserver);
428: my $userloadans=reply('userload',$tryserver);
429: if ($userloadans !~ /\d/) { $userloadans=0; }
430: my $answer=$loadans > $userloadans?
431: $loadans : $userloadans;
432: if (($answer =~ /\d/) && ($answer<$lowestserver)) {
433: $spareserver="http://$hostname{$tryserver}";
434: $lowestserver=$answer;
435: }
436: }
437: return $spareserver;
438: }
439:
440: # --------------------------------------------- Try to change a user's password
441:
442: sub changepass {
443: my ($uname,$udom,$currentpass,$newpass,$server)=@_;
444: $currentpass = &escape($currentpass);
445: $newpass = &escape($newpass);
446: my $answer = reply("encrypt:passwd:$udom:$uname:$currentpass:$newpass",
447: $server);
448: if (! $answer) {
449: &logthis("No reply on password change request to $server ".
450: "by $uname in domain $udom.");
451: } elsif ($answer =~ "^ok") {
452: &logthis("$uname in $udom successfully changed their password ".
453: "on $server.");
454: } elsif ($answer =~ "^pwchange_failure") {
455: &logthis("$uname in $udom was unable to change their password ".
456: "on $server. The action was blocked by either lcpasswd ".
457: "or pwchange");
458: } elsif ($answer =~ "^non_authorized") {
459: &logthis("$uname in $udom did not get their password correct when ".
460: "attempting to change it on $server.");
461: } elsif ($answer =~ "^auth_mode_error") {
462: &logthis("$uname in $udom attempted to change their password despite ".
463: "not being locally or internally authenticated on $server.");
464: } elsif ($answer =~ "^unknown_user") {
465: &logthis("$uname in $udom attempted to change their password ".
466: "on $server but were unable to because $server is not ".
467: "their home server.");
468: } elsif ($answer =~ "^refused") {
469: &logthis("$server refused to change $uname in $udom password because ".
470: "it was sent an unencrypted request to change the password.");
471: }
472: return $answer;
473: }
474:
475: # ----------------------- Try to determine user's current authentication scheme
476:
477: sub queryauthenticate {
478: my ($uname,$udom)=@_;
479: if (($perlvar{'lonRole'} eq 'library') &&
480: ($udom eq $perlvar{'lonDefDomain'})) {
481: my $answer=reply("encrypt:currentauth:$udom:$uname",
482: $perlvar{'lonHostID'});
483: unless ($answer eq 'unknown_user' or $answer eq 'refused') {
484: if (length($answer)) {
485: return $answer;
486: }
487: else {
488: &logthis("User $uname at $udom lacks an authentication mechanism");
489: return 'no_host';
490: }
491: }
492: }
493:
494: my $tryserver;
495: foreach $tryserver (keys %libserv) {
496: if ($hostdom{$tryserver} eq $udom) {
497: my $answer=reply("encrypt:currentauth:$udom:$uname",$tryserver);
498: unless ($answer eq 'unknown_user' or $answer eq 'refused') {
499: if (length($answer)) {
500: return $answer;
501: }
502: else {
503: &logthis("User $uname at $udom lacks an authentication mechanism");
504: return 'no_host';
505: }
506: }
507: }
508: }
509: &logthis("User $uname at $udom lacks an authentication mechanism");
510: return 'no_host';
511: }
512:
513: # --------- Try to authenticate user from domain's lib servers (first this one)
514:
515: sub authenticate {
516: my ($uname,$upass,$udom)=@_;
517: $upass=escape($upass);
518: $uname=~s/\W//g;
519: if (($perlvar{'lonRole'} eq 'library') &&
520: ($udom eq $perlvar{'lonDefDomain'})) {
521: my $answer=reply("encrypt:auth:$udom:$uname:$upass",$perlvar{'lonHostID'});
522: if ($answer =~ /authorized/) {
523: if ($answer eq 'authorized') {
524: &logthis("User $uname at $udom authorized by local server");
525: return $perlvar{'lonHostID'};
526: }
527: if ($answer eq 'non_authorized') {
528: &logthis("User $uname at $udom rejected by local server");
529: return 'no_host';
530: }
531: }
532: }
533:
534: my $tryserver;
535: foreach $tryserver (keys %libserv) {
536: if ($hostdom{$tryserver} eq $udom) {
537: my $answer=reply("encrypt:auth:$udom:$uname:$upass",$tryserver);
538: if ($answer =~ /authorized/) {
539: if ($answer eq 'authorized') {
540: &logthis("User $uname at $udom authorized by $tryserver");
541: return $tryserver;
542: }
543: if ($answer eq 'non_authorized') {
544: &logthis("User $uname at $udom rejected by $tryserver");
545: return 'no_host';
546: }
547: }
548: }
549: }
550: &logthis("User $uname at $udom could not be authenticated");
551: return 'no_host';
552: }
553:
554: # ---------------------- Find the homebase for a user from domain's lib servers
555:
556: sub homeserver {
557: my ($uname,$udom,$ignoreBadCache)=@_;
558: my $index="$uname:$udom";
559: if ($homecache{$index}) {
560: return "$homecache{$index}";
561: }
562: my $tryserver;
563: foreach $tryserver (keys %libserv) {
564: next if ($ignoreBadCache ne 'true' &&
565: exists($badServerCache{$tryserver}));
566: if ($hostdom{$tryserver} eq $udom) {
567: my $answer=reply("home:$udom:$uname",$tryserver);
568: if ($answer eq 'found') {
569: $homecache{$index}=$tryserver;
570: return $tryserver;
571: } elsif ($answer eq 'no_host') {
572: $badServerCache{$tryserver}=1;
573: }
574: }
575: }
576: return 'no_host';
577: }
578:
579: # ------------------------------------- Find the usernames behind a list of IDs
580:
581: sub idget {
582: my ($udom,@ids)=@_;
583: my %returnhash=();
584:
585: my $tryserver;
586: foreach $tryserver (keys %libserv) {
587: if ($hostdom{$tryserver} eq $udom) {
588: my $idlist=join('&',@ids);
589: $idlist=~tr/A-Z/a-z/;
590: my $reply=&reply("idget:$udom:".$idlist,$tryserver);
591: my @answer=();
592: if (($reply ne 'con_lost') && ($reply!~/^error\:/)) {
593: @answer=split(/\&/,$reply);
594: } ;
595: my $i;
596: for ($i=0;$i<=$#ids;$i++) {
597: if ($answer[$i]) {
598: $returnhash{$ids[$i]}=$answer[$i];
599: }
600: }
601: }
602: }
603: return %returnhash;
604: }
605:
606: # ------------------------------------- Find the IDs behind a list of usernames
607:
608: sub idrget {
609: my ($udom,@unames)=@_;
610: my %returnhash=();
611: foreach (@unames) {
612: $returnhash{$_}=(&userenvironment($udom,$_,'id'))[1];
613: }
614: return %returnhash;
615: }
616:
617: # ------------------------------- Store away a list of names and associated IDs
618:
619: sub idput {
620: my ($udom,%ids)=@_;
621: my %servers=();
622: foreach (keys %ids) {
623: my $uhom=&homeserver($_,$udom);
624: if ($uhom ne 'no_host') {
625: my $id=&escape($ids{$_});
626: $id=~tr/A-Z/a-z/;
627: my $unam=&escape($_);
628: if ($servers{$uhom}) {
629: $servers{$uhom}.='&'.$id.'='.$unam;
630: } else {
631: $servers{$uhom}=$id.'='.$unam;
632: }
633: &critical('put:'.$udom.':'.$unam.':environment:id='.$id,$uhom);
634: }
635: }
636: foreach (keys %servers) {
637: &critical('idput:'.$udom.':'.$servers{$_},$_);
638: }
639: }
640:
641: # --------------------------------------------------- Assign a key to a student
642:
643: sub assign_access_key {
644: #
645: # a valid key looks like uname:udom#comments
646: # comments are being appended
647: #
648: my ($ckey,$cdom,$cnum,$udom,$uname,$logentry)=@_;
649: $cdom=
650: $ENV{'course.'.$ENV{'request.course.id'}.'.domain'} unless (defined($cdom));
651: $cnum=
652: $ENV{'course.'.$ENV{'request.course.id'}.'.num'} unless (defined($cnum));
653: $udom=$ENV{'user.name'} unless (defined($udom));
654: $uname=$ENV{'user.domain'} unless (defined($uname));
655: my %existing=&get('accesskeys',[$ckey],$cdom,$cnum);
656: if (($existing{$ckey}=~/^\#(.*)$/) || # - new key
657: ($existing{$ckey}=~/^$uname\:$udom\#(.*)$/)) {
658: # assigned to this person
659: # - this should not happen,
660: # unless something went wrong
661: # the first time around
662: # ready to assign
663: $logentry=$1.'; '.$logentry;
664: if (&put('accesskey',{$ckey=>$uname.':'.$udom.'#'.$logentry},
665: $cdom,$cnum) eq 'ok') {
666: # key now belongs to user
667: my $envkey='key.'.$cdom.'_'.$cnum;
668: if (&put('environment',{$envkey => $ckey}) eq 'ok') {
669: &appenv('environment.'.$envkey => $ckey);
670: return 'ok';
671: } else {
672: return
673: 'error: Count not permanently assign key, will need to be re-entered later.';
674: }
675: } else {
676: return 'error: Could not assign key, try again later.';
677: }
678: } elsif (!$existing{$ckey}) {
679: # the key does not exist
680: return 'error: The key does not exist';
681: } else {
682: # the key is somebody else's
683: return 'error: The key is already in use';
684: }
685: }
686:
687: # ------------------------------------------ put an additional comment on a key
688:
689: sub comment_access_key {
690: #
691: # a valid key looks like uname:udom#comments
692: # comments are being appended
693: #
694: my ($ckey,$cdom,$cnum,$logentry)=@_;
695: $cdom=
696: $ENV{'course.'.$ENV{'request.course.id'}.'.domain'} unless (defined($cdom));
697: $cnum=
698: $ENV{'course.'.$ENV{'request.course.id'}.'.num'} unless (defined($cnum));
699: my %existing=&get('accesskeys',[$ckey],$cdom,$cnum);
700: if ($existing{$ckey}) {
701: $existing{$ckey}.='; '.$logentry;
702: # ready to assign
703: if (&put('accesskeys',{$ckey=>$existing{$ckey}},
704: $cdom,$cnum) eq 'ok') {
705: return 'ok';
706: } else {
707: return 'error: Count not store comment.';
708: }
709: } else {
710: # the key does not exist
711: return 'error: The key does not exist';
712: }
713: }
714:
715: # ------------------------------------------------------ Generate a set of keys
716:
717: sub generate_access_keys {
718: my ($number,$cdom,$cnum,$logentry)=@_;
719: $cdom=
720: $ENV{'course.'.$ENV{'request.course.id'}.'.domain'} unless (defined($cdom));
721: $cnum=
722: $ENV{'course.'.$ENV{'request.course.id'}.'.num'} unless (defined($cnum));
723: unless (&allowed('mky',$cdom)) { return 0; }
724: unless (($cdom) && ($cnum)) { return 0; }
725: if ($number>10000) { return 0; }
726: sleep(2); # make sure don't get same seed twice
727: srand(time()^($$+($$<<15))); # from "Programming Perl"
728: my $total=0;
729: for (my $i=1;$i<=$number;$i++) {
730: my $newkey=sprintf("%lx",int(100000*rand)).'-'.
731: sprintf("%lx",int(100000*rand)).'-'.
732: sprintf("%lx",int(100000*rand));
733: $newkey=~s/1/g/g; # folks mix up 1 and l
734: $newkey=~s/0/h/g; # and also 0 and O
735: my %existing=&get('accesskeys',[$newkey],$cdom,$cnum);
736: if ($existing{$newkey}) {
737: $i--;
738: } else {
739: if (&put('accesskeys',
740: { $newkey => '# generated '.localtime().
741: ' by '.$ENV{'user.name'}.'@'.$ENV{'user.domain'}.
742: '; '.$logentry },
743: $cdom,$cnum) eq 'ok') {
744: $total++;
745: }
746: }
747: }
748: &log($ENV{'user.domain'},$ENV{'user.name'},$ENV{'user.home'},
749: 'Generated '.$total.' keys for '.$cnum.' at '.$cdom);
750: return $total;
751: }
752:
753: # ------------------------------------------------------- Validate an accesskey
754:
755: sub validate_access_key {
756: my ($ckey,$cdom,$cnum,$udom,$uname)=@_;
757: $cdom=
758: $ENV{'course.'.$ENV{'request.course.id'}.'.domain'} unless (defined($cdom));
759: $cnum=
760: $ENV{'course.'.$ENV{'request.course.id'}.'.num'} unless (defined($cnum));
761: $udom=$ENV{'user.name'} unless (defined($udom));
762: $uname=$ENV{'user.domain'} unless (defined($uname));
763: my %existing=&get('accesskeys',[$ckey],$cdom,$cnum);
764: return ($existing{$ckey}=~/^$uname\:$udom\#/);
765: }
766:
767: # ------------------------------------- Find the section of student in a course
768:
769: sub getsection {
770: my ($udom,$unam,$courseid)=@_;
771: $courseid=~s/\_/\//g;
772: $courseid=~s/^(\w)/\/$1/;
773: my %Pending;
774: my %Expired;
775: #
776: # Each role can either have not started yet (pending), be active,
777: # or have expired.
778: #
779: # If there is an active role, we are done.
780: #
781: # If there is more than one role which has not started yet,
782: # choose the one which will start sooner
783: # If there is one role which has not started yet, return it.
784: #
785: # If there is more than one expired role, choose the one which ended last.
786: # If there is a role which has expired, return it.
787: #
788: foreach (split(/\&/,&reply('dump:'.$udom.':'.$unam.':roles',
789: &homeserver($unam,$udom)))) {
790: my ($key,$value)=split(/\=/,$_);
791: $key=&unescape($key);
792: next if ($key !~/^$courseid(?:\/)*(\w+)*\_st$/);
793: my $section=$1;
794: if ($key eq $courseid.'_st') { $section=''; }
795: my ($dummy,$end,$start)=split(/\_/,&unescape($value));
796: my $now=time;
797: if (defined($end) && ($now > $end)) {
798: $Expired{$end}=$section;
799: next;
800: }
801: if (defined($start) && ($now < $start)) {
802: $Pending{$start}=$section;
803: next;
804: }
805: return $section;
806: }
807: #
808: # Presumedly there will be few matching roles from the above
809: # loop and the sorting time will be negligible.
810: if (scalar(keys(%Pending))) {
811: my ($time) = sort {$a <=> $b} keys(%Pending);
812: return $Pending{$time};
813: }
814: if (scalar(keys(%Expired))) {
815: my @sorted = sort {$a <=> $b} keys(%Expired);
816: my $time = pop(@sorted);
817: return $Expired{$time};
818: }
819: return '-1';
820: }
821:
822: sub usection {
823: my ($udom,$unam,$courseid)=@_;
824: $courseid=~s/\_/\//g;
825: $courseid=~s/^(\w)/\/$1/;
826: foreach (split(/\&/,&reply('dump:'.$udom.':'.$unam.':roles',
827: &homeserver($unam,$udom)))) {
828: my ($key,$value)=split(/\=/,$_);
829: $key=&unescape($key);
830: if ($key=~/^$courseid(?:\/)*(\w+)*\_st$/) {
831: my $section=$1;
832: if ($key eq $courseid.'_st') { $section=''; }
833: my ($dummy,$end,$start)=split(/\_/,&unescape($value));
834: my $now=time;
835: my $notactive=0;
836: if ($start) {
837: if ($now<$start) { $notactive=1; }
838: }
839: if ($end) {
840: if ($now>$end) { $notactive=1; }
841: }
842: unless ($notactive) { return $section; }
843: }
844: }
845: return '-1';
846: }
847:
848: # ------------------------------------- Read an entry from a user's environment
849:
850: sub userenvironment {
851: my ($udom,$unam,@what)=@_;
852: my %returnhash=();
853: my @answer=split(/\&/,
854: &reply('get:'.$udom.':'.$unam.':environment:'.join('&',@what),
855: &homeserver($unam,$udom)));
856: my $i;
857: for ($i=0;$i<=$#what;$i++) {
858: $returnhash{$what[$i]}=&unescape($answer[$i]);
859: }
860: return %returnhash;
861: }
862:
863: # -------------------------------------------------------------------- New chat
864:
865: sub chatsend {
866: my ($newentry,$anon)=@_;
867: my $cnum=$ENV{'course.'.$ENV{'request.course.id'}.'.num'};
868: my $cdom=$ENV{'course.'.$ENV{'request.course.id'}.'.domain'};
869: my $chome=$ENV{'course.'.$ENV{'request.course.id'}.'.home'};
870: &reply('chatsend:'.$cdom.':'.$cnum.':'.
871: &escape($ENV{'user.domain'}.':'.$ENV{'user.name'}.':'.$anon.':'.
872: &escape($newentry)),$chome);
873: }
874:
875: # ------------------------------------------ Find current version of a resource
876:
877: sub getversion {
878: my $fname=&clutter(shift);
879: unless ($fname=~/^\/res\//) { return -1; }
880: return ¤tversion(&filelocation('',$fname));
881: }
882:
883: sub currentversion {
884: my $fname=shift;
885: my $author=$fname;
886: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
887: my ($udom,$uname)=split(/\//,$author);
888: my $home=homeserver($uname,$udom);
889: if ($home eq 'no_host') {
890: return -1;
891: }
892: my $answer=reply("currentversion:$fname",$home);
893: if (($answer eq 'con_lost') || ($answer eq 'rejected')) {
894: return -1;
895: }
896: return $answer;
897: }
898:
899: # ----------------------------- Subscribe to a resource, return URL if possible
900:
901: sub subscribe {
902: my $fname=shift;
903: if ($fname=~/\/(aboutme|syllabus|bulletinboard|smppg)$/) { return ''; }
904: my $author=$fname;
905: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
906: my ($udom,$uname)=split(/\//,$author);
907: my $home=homeserver($uname,$udom);
908: if ($home eq 'no_host') {
909: return 'not_found';
910: }
911: my $answer=reply("sub:$fname",$home);
912: if (($answer eq 'con_lost') || ($answer eq 'rejected')) {
913: $answer.=' by '.$home;
914: }
915: return $answer;
916: }
917:
918: # -------------------------------------------------------------- Replicate file
919:
920: sub repcopy {
921: my $filename=shift;
922: $filename=~s/\/+/\//g;
923: if ($filename=~/^\/home\/httpd\/html\/adm\//) { return OK; }
924: my $transname="$filename.in.transfer";
925: if ((-e $filename) || (-e $transname)) { return OK; }
926: my $remoteurl=subscribe($filename);
927: if ($remoteurl =~ /^con_lost by/) {
928: &logthis("Subscribe returned $remoteurl: $filename");
929: return HTTP_SERVICE_UNAVAILABLE;
930: } elsif ($remoteurl eq 'not_found') {
931: &logthis("Subscribe returned not_found: $filename");
932: return HTTP_NOT_FOUND;
933: } elsif ($remoteurl =~ /^rejected by/) {
934: &logthis("Subscribe returned $remoteurl: $filename");
935: return FORBIDDEN;
936: } elsif ($remoteurl eq 'directory') {
937: return OK;
938: } else {
939: my $author=$filename;
940: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
941: my ($udom,$uname)=split(/\//,$author);
942: my $home=homeserver($uname,$udom);
943: unless ($home eq $perlvar{'lonHostID'}) {
944: my @parts=split(/\//,$filename);
945: my $path="/$parts[1]/$parts[2]/$parts[3]/$parts[4]";
946: if ($path ne "$perlvar{'lonDocRoot'}/res") {
947: &logthis("Malconfiguration for replication: $filename");
948: return HTTP_BAD_REQUEST;
949: }
950: my $count;
951: for ($count=5;$count<$#parts;$count++) {
952: $path.="/$parts[$count]";
953: if ((-e $path)!=1) {
954: mkdir($path,0777);
955: }
956: }
957: my $ua=new LWP::UserAgent;
958: my $request=new HTTP::Request('GET',"$remoteurl");
959: my $response=$ua->request($request,$transname);
960: if ($response->is_error()) {
961: unlink($transname);
962: my $message=$response->status_line;
963: &logthis("<font color=blue>WARNING:"
964: ." LWP get: $message: $filename</font>");
965: return HTTP_SERVICE_UNAVAILABLE;
966: } else {
967: if ($remoteurl!~/\.meta$/) {
968: my $mrequest=new HTTP::Request('GET',$remoteurl.'.meta');
969: my $mresponse=$ua->request($mrequest,$filename.'.meta');
970: if ($mresponse->is_error()) {
971: unlink($filename.'.meta');
972: &logthis(
973: "<font color=yellow>INFO: No metadata: $filename</font>");
974: }
975: }
976: rename($transname,$filename);
977: return OK;
978: }
979: }
980: }
981: }
982:
983: # ------------------------------------------------ Get server side include body
984: sub ssi_body {
985: my ($filelink,%form)=@_;
986: my $output=($filelink=~/^http\:/?&externalssi($filelink):
987: &ssi($filelink,%form));
988: $output=~s/^.*\<body[^\>]*\>//si;
989: $output=~s/\<\/body\s*\>.*$//si;
990: $output=~
991: s/\/\/ BEGIN LON\-CAPA Internal.+\/\/ END LON\-CAPA Internal\s//gs;
992: return $output;
993: }
994:
995: # --------------------------------------------------------- Server Side Include
996:
997: sub ssi {
998:
999: my ($fn,%form)=@_;
1000:
1001: my $ua=new LWP::UserAgent;
1002:
1003: my $request;
1004:
1005: if (%form) {
1006: $request=new HTTP::Request('POST',"http://".$ENV{'HTTP_HOST'}.$fn);
1007: $request->content(join('&',map { &escape($_).'='.&escape($form{$_}) } keys %form));
1008: } else {
1009: $request=new HTTP::Request('GET',"http://".$ENV{'HTTP_HOST'}.$fn);
1010: }
1011:
1012: $request->header(Cookie => $ENV{'HTTP_COOKIE'});
1013: my $response=$ua->request($request);
1014:
1015: return $response->content;
1016: }
1017:
1018: sub externalssi {
1019: my ($url)=@_;
1020: my $ua=new LWP::UserAgent;
1021: my $request=new HTTP::Request('GET',$url);
1022: my $response=$ua->request($request);
1023: return $response->content;
1024: }
1025:
1026: # ------- Add a token to a remote URI's query string to vouch for access rights
1027:
1028: sub tokenwrapper {
1029: my $uri=shift;
1030: $uri=~s/^http\:\/\/([^\/]+)//;
1031: $uri=~s/^\///;
1032: $ENV{'user.environment'}=~/\/([^\/]+)\.id/;
1033: my $token=$1;
1034: if ($uri=~/^uploaded\/([^\/]+)\/([^\/]+)\/([^\/]+)(\?\.*)*$/) {
1035: &appenv('userfile.'.$1.'/'.$2.'/'.$3 => $ENV{'request.course.id'});
1036: return 'http://'.$hostname{ &homeserver($2,$1)}.'/'.$uri.
1037: (($uri=~/\?/)?'&':'?').'token='.$token.
1038: '&tokenissued='.$perlvar{'lonHostID'};
1039: } else {
1040: return '/adm/notfound.html';
1041: }
1042: }
1043:
1044: # --------------- Take an uploaded file and put it into the userfiles directory
1045: # input: name of form element, coursedoc=1 means this is for the course
1046: # output: url of file in userspace
1047:
1048: sub userfileupload {
1049: my ($formname,$coursedoc)=@_;
1050: my $fname=$ENV{'form.'.$formname.'.filename'};
1051: # Replace Windows backslashes by forward slashes
1052: $fname=~s/\\/\//g;
1053: # Get rid of everything but the actual filename
1054: $fname=~s/^.*\/([^\/]+)$/$1/;
1055: # Replace spaces by underscores
1056: $fname=~s/\s+/\_/g;
1057: # Replace all other weird characters by nothing
1058: $fname=~s/[^\w\.\-]//g;
1059: # See if there is anything left
1060: unless ($fname) { return 'error: no uploaded file'; }
1061: chop($ENV{'form.'.$formname});
1062: # Create the directory if not present
1063: my $docuname='';
1064: my $docudom='';
1065: my $docuhome='';
1066: if ($coursedoc) {
1067: $docuname=$ENV{'course.'.$ENV{'request.course.id'}.'.num'};
1068: $docudom=$ENV{'course.'.$ENV{'request.course.id'}.'.domain'};
1069: $docuhome=$ENV{'course.'.$ENV{'request.course.id'}.'.home'};
1070: } else {
1071: $docuname=$ENV{'user.name'};
1072: $docudom=$ENV{'user.domain'};
1073: $docuhome=$ENV{'user.home'};
1074: }
1075: return
1076: &finishuserfileupload($docuname,$docudom,$docuhome,$formname,$fname);
1077: }
1078:
1079: sub finishuserfileupload {
1080: my ($docuname,$docudom,$docuhome,$formname,$fname)=@_;
1081: my $path=$docudom.'/'.$docuname.'/';
1082: my $filepath=$perlvar{'lonDocRoot'};
1083: my @parts=split(/\//,$filepath.'/userfiles/'.$path);
1084: my $count;
1085: for ($count=4;$count<=$#parts;$count++) {
1086: $filepath.="/$parts[$count]";
1087: if ((-e $filepath)!=1) {
1088: mkdir($filepath,0777);
1089: }
1090: }
1091: # Save the file
1092: {
1093: my $fh=Apache::File->new('>'.$filepath.'/'.$fname);
1094: print $fh $ENV{'form.'.$formname};
1095: }
1096: # Notify homeserver to grep it
1097: #
1098:
1099: my $fetchresult=
1100: &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$fname,$docuhome);
1101: if ($fetchresult eq 'ok') {
1102: #
1103: # Return the URL to it
1104: return '/uploaded/'.$path.$fname;
1105: } else {
1106: &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$fname.
1107: ' to host '.$docuhome.': '.$fetchresult);
1108: return '/adm/notfound.html';
1109: }
1110: }
1111:
1112: # ------------------------------------------------------------------------- Log
1113:
1114: sub log {
1115: my ($dom,$nam,$hom,$what)=@_;
1116: return critical("log:$dom:$nam:$what",$hom);
1117: }
1118:
1119: # ------------------------------------------------------------------ Course Log
1120: #
1121: # This routine flushes several buffers of non-mission-critical nature
1122: #
1123:
1124: sub flushcourselogs {
1125: &logthis('Flushing log buffers');
1126: #
1127: # course logs
1128: # This is a log of all transactions in a course, which can be used
1129: # for data mining purposes
1130: #
1131: # It also collects the courseid database, which lists last transaction
1132: # times and course titles for all courseids
1133: #
1134: my %courseidbuffer=();
1135: foreach (keys %courselogs) {
1136: my $crsid=$_;
1137: if (&reply('log:'.$coursedombuf{$crsid}.':'.$coursenumbuf{$crsid}.':'.
1138: &escape($courselogs{$crsid}),
1139: $coursehombuf{$crsid}) eq 'ok') {
1140: delete $courselogs{$crsid};
1141: } else {
1142: &logthis('Failed to flush log buffer for '.$crsid);
1143: if (length($courselogs{$crsid})>40000) {
1144: &logthis("<font color=blue>WARNING: Buffer for ".$crsid.
1145: " exceeded maximum size, deleting.</font>");
1146: delete $courselogs{$crsid};
1147: }
1148: }
1149: if ($courseidbuffer{$coursehombuf{$crsid}}) {
1150: $courseidbuffer{$coursehombuf{$crsid}}.='&'.
1151: &escape($crsid).'='.&escape($coursedescrbuf{$crsid});
1152: } else {
1153: $courseidbuffer{$coursehombuf{$crsid}}=
1154: &escape($crsid).'='.&escape($coursedescrbuf{$crsid});
1155: }
1156: }
1157: #
1158: # Write course id database (reverse lookup) to homeserver of courses
1159: # Is used in pickcourse
1160: #
1161: foreach (keys %courseidbuffer) {
1162: &courseidput($hostdom{$_},$courseidbuffer{$_},$_);
1163: }
1164: #
1165: # File accesses
1166: # Writes to the dynamic metadata of resources to get hit counts, etc.
1167: #
1168: foreach (keys %accesshash) {
1169: my $entry=$_;
1170: $entry=~/\_\_\_(\w+)\/(\w+)\/(.*)\_\_\_(\w+)$/;
1171: my %temphash=($entry => $accesshash{$entry});
1172: if (&Apache::lonnet::put('nohist_resevaldata',\%temphash,$1,$2) eq 'ok') {
1173: delete $accesshash{$entry};
1174: }
1175: }
1176: #
1177: # Roles
1178: # Reverse lookup of user roles for course faculty/staff and co-authorship
1179: #
1180: foreach (keys %userrolehash) {
1181: my $entry=$_;
1182: my ($role,$uname,$udom,$runame,$rudom,$rsec)=
1183: split(/\:/,$entry);
1184: if (&Apache::lonnet::put('nohist_userroles',
1185: { $role.':'.$uname.':'.$udom.':'.$rsec => $userrolehash{$entry} },
1186: $rudom,$runame) eq 'ok') {
1187: delete $userrolehash{$entry};
1188: }
1189: }
1190: $dumpcount++;
1191: }
1192:
1193: sub courselog {
1194: my $what=shift;
1195: $what=time.':'.$what;
1196: unless ($ENV{'request.course.id'}) { return ''; }
1197: $coursedombuf{$ENV{'request.course.id'}}=
1198: $ENV{'course.'.$ENV{'request.course.id'}.'.domain'};
1199: $coursenumbuf{$ENV{'request.course.id'}}=
1200: $ENV{'course.'.$ENV{'request.course.id'}.'.num'};
1201: $coursehombuf{$ENV{'request.course.id'}}=
1202: $ENV{'course.'.$ENV{'request.course.id'}.'.home'};
1203: $coursedescrbuf{$ENV{'request.course.id'}}=
1204: $ENV{'course.'.$ENV{'request.course.id'}.'.description'};
1205: if (defined $courselogs{$ENV{'request.course.id'}}) {
1206: $courselogs{$ENV{'request.course.id'}}.='&'.$what;
1207: } else {
1208: $courselogs{$ENV{'request.course.id'}}.=$what;
1209: }
1210: if (length($courselogs{$ENV{'request.course.id'}})>4048) {
1211: &flushcourselogs();
1212: }
1213: }
1214:
1215: sub courseacclog {
1216: my $fnsymb=shift;
1217: unless ($ENV{'request.course.id'}) { return ''; }
1218: my $what=$fnsymb.':'.$ENV{'user.name'}.':'.$ENV{'user.domain'};
1219: if ($fnsymb=~/(problem|exam|quiz|assess|survey|form)$/) {
1220: $what.=':POST';
1221: foreach (keys %ENV) {
1222: if ($_=~/^form\.(.*)/) {
1223: $what.=':'.$1.'='.$ENV{$_};
1224: }
1225: }
1226: }
1227: &courselog($what);
1228: }
1229:
1230: sub countacc {
1231: my $url=&declutter(shift);
1232: unless ($ENV{'request.course.id'}) { return ''; }
1233: $accesshash{$ENV{'request.course.id'}.'___'.$url.'___course'}=1;
1234: my $key=$$.$processmarker.'_'.$dumpcount.'___'.$url.'___count';
1235: if (defined($accesshash{$key})) {
1236: $accesshash{$key}++;
1237: } else {
1238: $accesshash{$key}=1;
1239: }
1240: }
1241:
1242: sub linklog {
1243: my ($from,$to)=@_;
1244: $from=&declutter($from);
1245: $to=&declutter($to);
1246: $accesshash{$from.'___'.$to.'___comefrom'}=1;
1247: $accesshash{$to.'___'.$from.'___goto'}=1;
1248: }
1249:
1250: sub userrolelog {
1251: my ($trole,$username,$domain,$area,$tstart,$tend)=@_;
1252: if (($trole=~/^ca/) || ($trole=~/^in/) ||
1253: ($trole=~/^cc/) || ($trole=~/^ep/) ||
1254: ($trole=~/^cr/)) {
1255: my (undef,$rudom,$runame,$rsec)=split(/\//,$area);
1256: $userrolehash
1257: {$trole.':'.$username.':'.$domain.':'.$runame.':'.$rudom.':'.$rsec}
1258: =$tend.':'.$tstart;
1259: }
1260: }
1261:
1262: sub get_course_adv_roles {
1263: my $cid=shift;
1264: $cid=$ENV{'request.course.id'} unless (defined($cid));
1265: my %coursehash=&coursedescription($cid);
1266: my %returnhash=();
1267: my %dumphash=
1268: &dump('nohist_userroles',$coursehash{'domain'},$coursehash{'num'});
1269: my $now=time;
1270: foreach (keys %dumphash) {
1271: my ($tend,$tstart)=split(/\:/,$dumphash{$_});
1272: if (($tstart) && ($tstart<0)) { next; }
1273: if (($tend) && ($tend<$now)) { next; }
1274: if (($tstart) && ($now<$tstart)) { next; }
1275: my ($role,$username,$domain,$section)=split(/\:/,$_);
1276: my $key=&plaintext($role);
1277: if ($section) { $key.=' (Sec/Grp '.$section.')'; }
1278: if ($returnhash{$key}) {
1279: $returnhash{$key}.=','.$username.':'.$domain;
1280: } else {
1281: $returnhash{$key}=$username.':'.$domain;
1282: }
1283: }
1284: return %returnhash;
1285: }
1286:
1287: # ---------------------------------------------------------- Course ID routines
1288: # Deal with domain's nohist_courseid.db files
1289: #
1290:
1291: sub courseidput {
1292: my ($domain,$what,$coursehome)=@_;
1293: return &reply('courseidput:'.$domain.':'.$what,$coursehome);
1294: }
1295:
1296: sub courseiddump {
1297: my ($domfilter,$descfilter,$sincefilter)=@_;
1298: my %returnhash=();
1299: unless ($domfilter) { $domfilter=''; }
1300: foreach my $tryserver (keys %libserv) {
1301: if ((!$domfilter) || ($hostdom{$tryserver} eq $domfilter)) {
1302: foreach (
1303: split(/\&/,&reply('courseiddump:'.$hostdom{$tryserver}.':'.
1304: $sincefilter.':'.&escape($descfilter),
1305: $tryserver))) {
1306: my ($key,$value)=split(/\=/,$_);
1307: if (($key) && ($value)) {
1308: $returnhash{&unescape($key)}=&unescape($value);
1309: }
1310: }
1311:
1312: }
1313: }
1314: return %returnhash;
1315: }
1316:
1317: #
1318: # ----------------------------------------------------------- Check out an item
1319:
1320: sub checkout {
1321: my ($symb,$tuname,$tudom,$tcrsid)=@_;
1322: my $now=time;
1323: my $lonhost=$perlvar{'lonHostID'};
1324: my $infostr=&escape(
1325: 'CHECKOUTTOKEN&'.
1326: $tuname.'&'.
1327: $tudom.'&'.
1328: $tcrsid.'&'.
1329: $symb.'&'.
1330: $now.'&'.$ENV{'REMOTE_ADDR'});
1331: my $token=&reply('tmpput:'.$infostr,$lonhost);
1332: if ($token=~/^error\:/) {
1333: &logthis("<font color=blue>WARNING: ".
1334: "Checkout tmpput failed ".$tudom.' - '.$tuname.' - '.$symb.
1335: "</font>");
1336: return '';
1337: }
1338:
1339: $token=~s/^(\d+)\_.*\_(\d+)$/$1\*$2\*$lonhost/;
1340: $token=~tr/a-z/A-Z/;
1341:
1342: my %infohash=('resource.0.outtoken' => $token,
1343: 'resource.0.checkouttime' => $now,
1344: 'resource.0.outremote' => $ENV{'REMOTE_ADDR'});
1345:
1346: unless (&cstore(\%infohash,$symb,$tcrsid,$tudom,$tuname) eq 'ok') {
1347: return '';
1348: } else {
1349: &logthis("<font color=blue>WARNING: ".
1350: "Checkout cstore failed ".$tudom.' - '.$tuname.' - '.$symb.
1351: "</font>");
1352: }
1353:
1354: if (&log($tudom,$tuname,&homeserver($tuname,$tudom),
1355: &escape('Checkout '.$infostr.' - '.
1356: $token)) ne 'ok') {
1357: return '';
1358: } else {
1359: &logthis("<font color=blue>WARNING: ".
1360: "Checkout log failed ".$tudom.' - '.$tuname.' - '.$symb.
1361: "</font>");
1362: }
1363: return $token;
1364: }
1365:
1366: # ------------------------------------------------------------ Check in an item
1367:
1368: sub checkin {
1369: my $token=shift;
1370: my $now=time;
1371: my ($ta,$tb,$lonhost)=split(/\*/,$token);
1372: $lonhost=~tr/A-Z/a-z/;
1373: my $dtoken=$ta.'_'.$hostip{$lonhost}.'_'.$tb;
1374: $dtoken=~s/\W/\_/g;
1375: my ($dummy,$tuname,$tudom,$tcrsid,$symb,$chtim,$rmaddr)=
1376: split(/\&/,&unescape(&reply('tmpget:'.$dtoken,$lonhost)));
1377:
1378: unless (($tuname) && ($tudom)) {
1379: &logthis('Check in '.$token.' ('.$dtoken.') failed');
1380: return '';
1381: }
1382:
1383: unless (&allowed('mgr',$tcrsid)) {
1384: &logthis('Check in '.$token.' ('.$dtoken.') unauthorized: '.
1385: $ENV{'user.name'}.' - '.$ENV{'user.domain'});
1386: return '';
1387: }
1388:
1389: my %infohash=('resource.0.intoken' => $token,
1390: 'resource.0.checkintime' => $now,
1391: 'resource.0.inremote' => $ENV{'REMOTE_ADDR'});
1392:
1393: unless (&cstore(\%infohash,$symb,$tcrsid,$tudom,$tuname) eq 'ok') {
1394: return '';
1395: }
1396:
1397: if (&log($tudom,$tuname,&homeserver($tuname,$tudom),
1398: &escape('Checkin - '.$token)) ne 'ok') {
1399: return '';
1400: }
1401:
1402: return ($symb,$tuname,$tudom,$tcrsid);
1403: }
1404:
1405: # --------------------------------------------- Set Expire Date for Spreadsheet
1406:
1407: sub expirespread {
1408: my ($uname,$udom,$stype,$usymb)=@_;
1409: my $cid=$ENV{'request.course.id'};
1410: if ($cid) {
1411: my $now=time;
1412: my $key=$uname.':'.$udom.':'.$stype.':'.$usymb;
1413: return &reply('put:'.$ENV{'course.'.$cid.'.domain'}.':'.
1414: $ENV{'course.'.$cid.'.num'}.
1415: ':nohist_expirationdates:'.
1416: &escape($key).'='.$now,
1417: $ENV{'course.'.$cid.'.home'})
1418: }
1419: return 'ok';
1420: }
1421:
1422: # ----------------------------------------------------- Devalidate Spreadsheets
1423:
1424: sub devalidate {
1425: my ($symb,$uname,$udom)=@_;
1426: my $cid=$ENV{'request.course.id'};
1427: if ($cid) {
1428: # delete the stored spreadsheets for
1429: # - the student level sheet of this user in course's homespace
1430: # - the assessment level sheet for this resource
1431: # for this user in user's homespace
1432: my $key=$uname.':'.$udom.':';
1433: my $status=
1434: &del('nohist_calculatedsheets',
1435: [$key.'studentcalc:'],
1436: $ENV{'course.'.$cid.'.domain'},
1437: $ENV{'course.'.$cid.'.num'})
1438: .' '.
1439: &del('nohist_calculatedsheets_'.$cid,
1440: [$key.'assesscalc:'.$symb],$udom,$uname);
1441: unless ($status eq 'ok ok') {
1442: &logthis('Could not devalidate spreadsheet '.
1443: $uname.' at '.$udom.' for '.
1444: $symb.': '.$status);
1445: }
1446: }
1447: }
1448:
1449: sub get_scalar {
1450: my ($string,$end) = @_;
1451: my $value;
1452: if ($$string =~ s/^([^&]*?)($end)/$2/) {
1453: $value = $1;
1454: } elsif ($$string =~ s/^([^&]*?)&//) {
1455: $value = $1;
1456: }
1457: return &unescape($value);
1458: }
1459:
1460: sub array2str {
1461: my (@array) = @_;
1462: my $result=&arrayref2str(\@array);
1463: $result=~s/^__ARRAY_REF__//;
1464: $result=~s/__END_ARRAY_REF__$//;
1465: return $result;
1466: }
1467:
1468: sub arrayref2str {
1469: my ($arrayref) = @_;
1470: my $result='__ARRAY_REF__';
1471: foreach my $elem (@$arrayref) {
1472: if(ref($elem) eq 'ARRAY') {
1473: $result.=&arrayref2str($elem).'&';
1474: } elsif(ref($elem) eq 'HASH') {
1475: $result.=&hashref2str($elem).'&';
1476: } elsif(ref($elem)) {
1477: #print("Got a ref of ".(ref($elem))." skipping.");
1478: } else {
1479: $result.=&escape($elem).'&';
1480: }
1481: }
1482: $result=~s/\&$//;
1483: $result .= '__END_ARRAY_REF__';
1484: return $result;
1485: }
1486:
1487: sub hash2str {
1488: my (%hash) = @_;
1489: my $result=&hashref2str(\%hash);
1490: $result=~s/^__HASH_REF__//;
1491: $result=~s/__END_HASH_REF__$//;
1492: return $result;
1493: }
1494:
1495: sub hashref2str {
1496: my ($hashref)=@_;
1497: my $result='__HASH_REF__';
1498: foreach (keys(%$hashref)) {
1499: if (ref($_) eq 'ARRAY') {
1500: $result.=&arrayref2str($_).'=';
1501: } elsif (ref($_) eq 'HASH') {
1502: $result.=&hashref2str($_).'=';
1503: } elsif (ref($_)) {
1504: $result.='=';
1505: #print("Got a ref of ".(ref($_))." skipping.");
1506: } else {
1507: if ($_) {$result.=&escape($_).'=';} else { last; }
1508: }
1509:
1510: if(ref($hashref->{$_}) eq 'ARRAY') {
1511: $result.=&arrayref2str($hashref->{$_}).'&';
1512: } elsif(ref($hashref->{$_}) eq 'HASH') {
1513: $result.=&hashref2str($hashref->{$_}).'&';
1514: } elsif(ref($hashref->{$_})) {
1515: $result.='&';
1516: #print("Got a ref of ".(ref($hashref->{$_}))." skipping.");
1517: } else {
1518: $result.=&escape($hashref->{$_}).'&';
1519: }
1520: }
1521: $result=~s/\&$//;
1522: $result .= '__END_HASH_REF__';
1523: return $result;
1524: }
1525:
1526: sub str2hash {
1527: my ($string)=@_;
1528: my ($hash)=&str2hashref('__HASH_REF__'.$string.'__END_HASH_REF__');
1529: return %$hash;
1530: }
1531:
1532: sub str2hashref {
1533: my ($string) = @_;
1534:
1535: my %hash;
1536:
1537: if($string !~ /^__HASH_REF__/) {
1538: if (! ($string eq '' || !defined($string))) {
1539: $hash{'error'}='Not hash reference';
1540: }
1541: return (\%hash, $string);
1542: }
1543:
1544: $string =~ s/^__HASH_REF__//;
1545:
1546: while($string !~ /^__END_HASH_REF__/) {
1547: #key
1548: my $key='';
1549: if($string =~ /^__HASH_REF__/) {
1550: ($key, $string)=&str2hashref($string);
1551: if(defined($key->{'error'})) {
1552: $hash{'error'}='Bad data';
1553: return (\%hash, $string);
1554: }
1555: } elsif($string =~ /^__ARRAY_REF__/) {
1556: ($key, $string)=&str2arrayref($string);
1557: if($key->[0] eq 'Array reference error') {
1558: $hash{'error'}='Bad data';
1559: return (\%hash, $string);
1560: }
1561: } else {
1562: $string =~ s/^(.*?)=//;
1563: $key=&unescape($1);
1564: }
1565: $string =~ s/^=//;
1566:
1567: #value
1568: my $value='';
1569: if($string =~ /^__HASH_REF__/) {
1570: ($value, $string)=&str2hashref($string);
1571: if(defined($value->{'error'})) {
1572: $hash{'error'}='Bad data';
1573: return (\%hash, $string);
1574: }
1575: } elsif($string =~ /^__ARRAY_REF__/) {
1576: ($value, $string)=&str2arrayref($string);
1577: if($value->[0] eq 'Array reference error') {
1578: $hash{'error'}='Bad data';
1579: return (\%hash, $string);
1580: }
1581: } else {
1582: $value=&get_scalar(\$string,'__END_HASH_REF__');
1583: }
1584: $string =~ s/^&//;
1585:
1586: $hash{$key}=$value;
1587: }
1588:
1589: $string =~ s/^__END_HASH_REF__//;
1590:
1591: return (\%hash, $string);
1592: }
1593:
1594: sub str2array {
1595: my ($string)=@_;
1596: my ($array)=&str2arrayref('__ARRAY_REF__'.$string.'__END_ARRAY_REF__');
1597: return @$array;
1598: }
1599:
1600: sub str2arrayref {
1601: my ($string) = @_;
1602: my @array;
1603:
1604: if($string !~ /^__ARRAY_REF__/) {
1605: if (! ($string eq '' || !defined($string))) {
1606: $array[0]='Array reference error';
1607: }
1608: return (\@array, $string);
1609: }
1610:
1611: $string =~ s/^__ARRAY_REF__//;
1612:
1613: while($string !~ /^__END_ARRAY_REF__/) {
1614: my $value='';
1615: if($string =~ /^__HASH_REF__/) {
1616: ($value, $string)=&str2hashref($string);
1617: if(defined($value->{'error'})) {
1618: $array[0] ='Array reference error';
1619: return (\@array, $string);
1620: }
1621: } elsif($string =~ /^__ARRAY_REF__/) {
1622: ($value, $string)=&str2arrayref($string);
1623: if($value->[0] eq 'Array reference error') {
1624: $array[0] ='Array reference error';
1625: return (\@array, $string);
1626: }
1627: } else {
1628: $value=&get_scalar(\$string,'__END_ARRAY_REF__');
1629: }
1630: $string =~ s/^&//;
1631:
1632: push(@array, $value);
1633: }
1634:
1635: $string =~ s/^__END_ARRAY_REF__//;
1636:
1637: return (\@array, $string);
1638: }
1639:
1640: # -------------------------------------------------------------------Temp Store
1641:
1642: sub tmpreset {
1643: my ($symb,$namespace,$domain,$stuname) = @_;
1644: if (!$symb) {
1645: $symb=&symbread();
1646: if (!$symb) { $symb= $ENV{'request.url'}; }
1647: }
1648: $symb=escape($symb);
1649:
1650: if (!$namespace) { $namespace=$ENV{'request.state'}; }
1651: $namespace=~s/\//\_/g;
1652: $namespace=~s/\W//g;
1653:
1654: #FIXME needs to do something for /pub resources
1655: if (!$domain) { $domain=$ENV{'user.domain'}; }
1656: if (!$stuname) { $stuname=$ENV{'user.name'}; }
1657: my $path=$perlvar{'lonDaemons'}.'/tmp';
1658: my %hash;
1659: if (tie(%hash,'GDBM_File',
1660: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
1661: &GDBM_WRCREAT(),0640)) {
1662: foreach my $key (keys %hash) {
1663: if ($key=~ /:$symb/) {
1664: delete($hash{$key});
1665: }
1666: }
1667: }
1668: }
1669:
1670: sub tmpstore {
1671: my ($storehash,$symb,$namespace,$domain,$stuname) = @_;
1672:
1673: if (!$symb) {
1674: $symb=&symbread();
1675: if (!$symb) { $symb= $ENV{'request.url'}; }
1676: }
1677: $symb=escape($symb);
1678:
1679: if (!$namespace) {
1680: # I don't think we would ever want to store this for a course.
1681: # it seems this will only be used if we don't have a course.
1682: #$namespace=$ENV{'request.course.id'};
1683: #if (!$namespace) {
1684: $namespace=$ENV{'request.state'};
1685: #}
1686: }
1687: $namespace=~s/\//\_/g;
1688: $namespace=~s/\W//g;
1689: #FIXME needs to do something for /pub resources
1690: if (!$domain) { $domain=$ENV{'user.domain'}; }
1691: if (!$stuname) { $stuname=$ENV{'user.name'}; }
1692: my $now=time;
1693: my %hash;
1694: my $path=$perlvar{'lonDaemons'}.'/tmp';
1695: if (tie(%hash,'GDBM_File',
1696: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
1697: &GDBM_WRCREAT(),0640)) {
1698: $hash{"version:$symb"}++;
1699: my $version=$hash{"version:$symb"};
1700: my $allkeys='';
1701: foreach my $key (keys(%$storehash)) {
1702: $allkeys.=$key.':';
1703: $hash{"$version:$symb:$key"}=$$storehash{$key};
1704: }
1705: $hash{"$version:$symb:timestamp"}=$now;
1706: $allkeys.='timestamp';
1707: $hash{"$version:keys:$symb"}=$allkeys;
1708: if (untie(%hash)) {
1709: return 'ok';
1710: } else {
1711: return "error:$!";
1712: }
1713: } else {
1714: return "error:$!";
1715: }
1716: }
1717:
1718: # -----------------------------------------------------------------Temp Restore
1719:
1720: sub tmprestore {
1721: my ($symb,$namespace,$domain,$stuname) = @_;
1722:
1723: if (!$symb) {
1724: $symb=&symbread();
1725: if (!$symb) { $symb= $ENV{'request.url'}; }
1726: }
1727: $symb=escape($symb);
1728:
1729: if (!$namespace) { $namespace=$ENV{'request.state'}; }
1730: #FIXME needs to do something for /pub resources
1731: if (!$domain) { $domain=$ENV{'user.domain'}; }
1732: if (!$stuname) { $stuname=$ENV{'user.name'}; }
1733:
1734: my %returnhash;
1735: $namespace=~s/\//\_/g;
1736: $namespace=~s/\W//g;
1737: my %hash;
1738: my $path=$perlvar{'lonDaemons'}.'/tmp';
1739: if (tie(%hash,'GDBM_File',
1740: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
1741: &GDBM_READER(),0640)) {
1742: my $version=$hash{"version:$symb"};
1743: $returnhash{'version'}=$version;
1744: my $scope;
1745: for ($scope=1;$scope<=$version;$scope++) {
1746: my $vkeys=$hash{"$scope:keys:$symb"};
1747: my @keys=split(/:/,$vkeys);
1748: my $key;
1749: $returnhash{"$scope:keys"}=$vkeys;
1750: foreach $key (@keys) {
1751: $returnhash{"$scope:$key"}=$hash{"$scope:$symb:$key"};
1752: $returnhash{"$key"}=$hash{"$scope:$symb:$key"};
1753: }
1754: }
1755: if (!(untie(%hash))) {
1756: return "error:$!";
1757: }
1758: } else {
1759: return "error:$!";
1760: }
1761: return %returnhash;
1762: }
1763:
1764: # ----------------------------------------------------------------------- Store
1765:
1766: sub store {
1767: my ($storehash,$symb,$namespace,$domain,$stuname) = @_;
1768: my $home='';
1769:
1770: if ($stuname) { $home=&homeserver($stuname,$domain); }
1771:
1772: $symb=&symbclean($symb);
1773: if (!$symb) { unless ($symb=&symbread()) { return ''; } }
1774:
1775: if (!$domain) { $domain=$ENV{'user.domain'}; }
1776: if (!$stuname) { $stuname=$ENV{'user.name'}; }
1777:
1778: &devalidate($symb,$stuname,$domain);
1779:
1780: $symb=escape($symb);
1781: if (!$namespace) {
1782: unless ($namespace=$ENV{'request.course.id'}) {
1783: return '';
1784: }
1785: }
1786: if (!$home) { $home=$ENV{'user.home'}; }
1787: my $namevalue='';
1788: foreach (keys %$storehash) {
1789: $namevalue.=escape($_).'='.escape($$storehash{$_}).'&';
1790: }
1791: $namevalue=~s/\&$//;
1792: &courselog($symb.':'.$stuname.':'.$domain.':STORE:'.$namevalue);
1793: return reply("store:$domain:$stuname:$namespace:$symb:$namevalue","$home");
1794: }
1795:
1796: # -------------------------------------------------------------- Critical Store
1797:
1798: sub cstore {
1799: my ($storehash,$symb,$namespace,$domain,$stuname) = @_;
1800: my $home='';
1801:
1802: if ($stuname) { $home=&homeserver($stuname,$domain); }
1803:
1804: $symb=&symbclean($symb);
1805: if (!$symb) { unless ($symb=&symbread()) { return ''; } }
1806:
1807: if (!$domain) { $domain=$ENV{'user.domain'}; }
1808: if (!$stuname) { $stuname=$ENV{'user.name'}; }
1809:
1810: &devalidate($symb,$stuname,$domain);
1811:
1812: $symb=escape($symb);
1813: if (!$namespace) {
1814: unless ($namespace=$ENV{'request.course.id'}) {
1815: return '';
1816: }
1817: }
1818: if (!$home) { $home=$ENV{'user.home'}; }
1819:
1820: my $namevalue='';
1821: foreach (keys %$storehash) {
1822: $namevalue.=escape($_).'='.escape($$storehash{$_}).'&';
1823: }
1824: $namevalue=~s/\&$//;
1825: &courselog($symb.':'.$stuname.':'.$domain.':CSTORE:'.$namevalue);
1826: return critical
1827: ("store:$domain:$stuname:$namespace:$symb:$namevalue","$home");
1828: }
1829:
1830: # --------------------------------------------------------------------- Restore
1831:
1832: sub restore {
1833: my ($symb,$namespace,$domain,$stuname) = @_;
1834: my $home='';
1835:
1836: if ($stuname) { $home=&homeserver($stuname,$domain); }
1837:
1838: if (!$symb) {
1839: unless ($symb=escape(&symbread())) { return ''; }
1840: } else {
1841: $symb=&escape(&symbclean($symb));
1842: }
1843: if (!$namespace) {
1844: unless ($namespace=$ENV{'request.course.id'}) {
1845: return '';
1846: }
1847: }
1848: if (!$domain) { $domain=$ENV{'user.domain'}; }
1849: if (!$stuname) { $stuname=$ENV{'user.name'}; }
1850: if (!$home) { $home=$ENV{'user.home'}; }
1851: my $answer=&reply("restore:$domain:$stuname:$namespace:$symb","$home");
1852:
1853: my %returnhash=();
1854: foreach (split(/\&/,$answer)) {
1855: my ($name,$value)=split(/\=/,$_);
1856: $returnhash{&unescape($name)}=&unescape($value);
1857: }
1858: my $version;
1859: for ($version=1;$version<=$returnhash{'version'};$version++) {
1860: foreach (split(/\:/,$returnhash{$version.':keys'})) {
1861: $returnhash{$_}=$returnhash{$version.':'.$_};
1862: }
1863: }
1864: return %returnhash;
1865: }
1866:
1867: # ---------------------------------------------------------- Course Description
1868:
1869: sub coursedescription {
1870: my $courseid=shift;
1871: $courseid=~s/^\///;
1872: $courseid=~s/\_/\//g;
1873: my ($cdomain,$cnum)=split(/\//,$courseid);
1874: my $chome=&homeserver($cnum,$cdomain);
1875: my $normalid=$cdomain.'_'.$cnum;
1876: # need to always cache even if we get errors otherwise we keep
1877: # trying and trying and trying to get the course description.
1878: my %envhash=();
1879: my %returnhash=();
1880: $envhash{'course.'.$normalid.'.last_cache'}=time;
1881: if ($chome ne 'no_host') {
1882: %returnhash=&dump('environment',$cdomain,$cnum);
1883: if (!exists($returnhash{'con_lost'})) {
1884: $returnhash{'home'}= $chome;
1885: $returnhash{'domain'} = $cdomain;
1886: $returnhash{'num'} = $cnum;
1887: while (my ($name,$value) = each %returnhash) {
1888: $envhash{'course.'.$normalid.'.'.$name}=$value;
1889: }
1890: $returnhash{'url'}=&clutter($returnhash{'url'});
1891: $returnhash{'fn'}=$perlvar{'lonDaemons'}.'/tmp/'.
1892: $ENV{'user.name'}.'_'.$cdomain.'_'.$cnum;
1893: $envhash{'course.'.$normalid.'.home'}=$chome;
1894: $envhash{'course.'.$normalid.'.domain'}=$cdomain;
1895: $envhash{'course.'.$normalid.'.num'}=$cnum;
1896: }
1897: }
1898: &appenv(%envhash);
1899: return %returnhash;
1900: }
1901:
1902: # -------------------------------------------------------- Get user privileges
1903:
1904: sub rolesinit {
1905: my ($domain,$username,$authhost)=@_;
1906: my $rolesdump=reply("dump:$domain:$username:roles",$authhost);
1907: if (($rolesdump eq 'con_lost') || ($rolesdump eq '')) { return ''; }
1908: my %allroles=();
1909: my %thesepriv=();
1910: my $now=time;
1911: my $userroles="user.login.time=$now\n";
1912: my $thesestr;
1913:
1914: if ($rolesdump ne '') {
1915: foreach (split(/&/,$rolesdump)) {
1916: if ($_!~/^rolesdef\&/) {
1917: my ($area,$role)=split(/=/,$_);
1918: $area=~s/\_\w\w$//;
1919: my ($trole,$tend,$tstart)=split(/_/,$role);
1920: $userroles.='user.role.'.$trole.'.'.$area.'='.
1921: $tstart.'.'.$tend."\n";
1922: # log the associated role with the area
1923: &userrolelog($trole,$username,$domain,$area,$tstart,$tend);
1924: if ($tend!=0) {
1925: if ($tend<$now) {
1926: $trole='';
1927: }
1928: }
1929: if ($tstart!=0) {
1930: if ($tstart>$now) {
1931: $trole='';
1932: }
1933: }
1934: if (($area ne '') && ($trole ne '')) {
1935: my $spec=$trole.'.'.$area;
1936: my ($tdummy,$tdomain,$trest)=split(/\//,$area);
1937: if ($trole =~ /^cr\//) {
1938: my ($rdummy,$rdomain,$rauthor,$rrole)=split(/\//,$trole);
1939: my $homsvr=homeserver($rauthor,$rdomain);
1940: if ($hostname{$homsvr} ne '') {
1941: my ($rdummy,$roledef)=
1942: &get('roles',["rolesdef_$rrole"],$rdomain,$rauthor);
1943:
1944: if (($rdummy ne 'con_lost') && ($roledef ne '')) {
1945: my ($syspriv,$dompriv,$coursepriv)=
1946: split(/\_/,$roledef);
1947: if (defined($syspriv)) {
1948: $allroles{'cm./'}.=':'.$syspriv;
1949: $allroles{$spec.'./'}.=':'.$syspriv;
1950: }
1951: if ($tdomain ne '') {
1952: if (defined($dompriv)) {
1953: $allroles{'cm./'.$tdomain.'/'}.=':'.$dompriv;
1954: $allroles{$spec.'./'.$tdomain.'/'}.=':'.$dompriv;
1955: }
1956: if ($trest ne '') {
1957: if (defined($coursepriv)) {
1958: $allroles{'cm.'.$area}.=':'.$coursepriv;
1959: $allroles{$spec.'.'.$area}.=':'.$coursepriv;
1960: }
1961: }
1962: }
1963: }
1964: }
1965: } else {
1966: if (defined($pr{$trole.':s'})) {
1967: $allroles{'cm./'}.=':'.$pr{$trole.':s'};
1968: $allroles{$spec.'./'}.=':'.$pr{$trole.':s'};
1969: }
1970: if ($tdomain ne '') {
1971: if (defined($pr{$trole.':d'})) {
1972: $allroles{'cm./'.$tdomain.'/'}.=':'.$pr{$trole.':d'};
1973: $allroles{$spec.'./'.$tdomain.'/'}.=':'.$pr{$trole.':d'};
1974: }
1975: if ($trest ne '') {
1976: if (defined($pr{$trole.':c'})) {
1977: $allroles{'cm.'.$area}.=':'.$pr{$trole.':c'};
1978: $allroles{$spec.'.'.$area}.=':'.$pr{$trole.':c'};
1979: }
1980: }
1981: }
1982: }
1983: }
1984: }
1985: }
1986: my $adv=0;
1987: my $author=0;
1988: foreach (keys %allroles) {
1989: %thesepriv=();
1990: if (($_!~/^st/) && ($_!~/^ta/) && ($_!~/^cm/)) { $adv=1; }
1991: if (($_=~/^au/) || ($_=~/^ca/)) { $author=1; }
1992: foreach (split(/:/,$allroles{$_})) {
1993: if ($_ ne '') {
1994: my ($privilege,$restrictions)=split(/&/,$_);
1995: if ($restrictions eq '') {
1996: $thesepriv{$privilege}='F';
1997: } else {
1998: if ($thesepriv{$privilege} ne 'F') {
1999: $thesepriv{$privilege}.=$restrictions;
2000: }
2001: }
2002: }
2003: }
2004: $thesestr='';
2005: foreach (keys %thesepriv) { $thesestr.=':'.$_.'&'.$thesepriv{$_}; }
2006: $userroles.='user.priv.'.$_.'='.$thesestr."\n";
2007: }
2008: $userroles.='user.adv='.$adv."\n".
2009: 'user.author='.$author."\n";
2010: $ENV{'user.adv'}=$adv;
2011: }
2012: return $userroles;
2013: }
2014:
2015: # --------------------------------------------------------------- get interface
2016:
2017: sub get {
2018: my ($namespace,$storearr,$udomain,$uname)=@_;
2019: my $items='';
2020: foreach (@$storearr) {
2021: $items.=escape($_).'&';
2022: }
2023: $items=~s/\&$//;
2024: if (!$udomain) { $udomain=$ENV{'user.domain'}; }
2025: if (!$uname) { $uname=$ENV{'user.name'}; }
2026: my $uhome=&homeserver($uname,$udomain);
2027:
2028: my $rep=&reply("get:$udomain:$uname:$namespace:$items",$uhome);
2029: my @pairs=split(/\&/,$rep);
2030: if ( $#pairs==0 && $pairs[0] =~ /^(con_lost|error|no_such_host)/i) {
2031: return @pairs;
2032: }
2033: my %returnhash=();
2034: my $i=0;
2035: foreach (@$storearr) {
2036: $returnhash{$_}=unescape($pairs[$i]);
2037: $i++;
2038: }
2039: return %returnhash;
2040: }
2041:
2042: # --------------------------------------------------------------- del interface
2043:
2044: sub del {
2045: my ($namespace,$storearr,$udomain,$uname)=@_;
2046: my $items='';
2047: foreach (@$storearr) {
2048: $items.=escape($_).'&';
2049: }
2050: $items=~s/\&$//;
2051: if (!$udomain) { $udomain=$ENV{'user.domain'}; }
2052: if (!$uname) { $uname=$ENV{'user.name'}; }
2053: my $uhome=&homeserver($uname,$udomain);
2054:
2055: return &reply("del:$udomain:$uname:$namespace:$items",$uhome);
2056: }
2057:
2058: # -------------------------------------------------------------- dump interface
2059:
2060: sub dump {
2061: my ($namespace,$udomain,$uname,$regexp)=@_;
2062: if (!$udomain) { $udomain=$ENV{'user.domain'}; }
2063: if (!$uname) { $uname=$ENV{'user.name'}; }
2064: my $uhome=&homeserver($uname,$udomain);
2065: if ($regexp) {
2066: $regexp=&escape($regexp);
2067: } else {
2068: $regexp='.';
2069: }
2070: my $rep=reply("dump:$udomain:$uname:$namespace:$regexp",$uhome);
2071: my @pairs=split(/\&/,$rep);
2072: my %returnhash=();
2073: foreach (@pairs) {
2074: my ($key,$value)=split(/=/,$_);
2075: $returnhash{unescape($key)}=unescape($value);
2076: }
2077: return %returnhash;
2078: }
2079:
2080: # --------------------------------------------------------------- currentdump
2081: sub currentdump {
2082: my ($courseid,$sdom,$sname)=@_;
2083: $courseid = $ENV{'request.course.id'} if (! defined($courseid));
2084: $sdom = $ENV{'user.domain'} if (! defined($sdom));
2085: $sname = $ENV{'user.name'} if (! defined($sname));
2086: my $uhome = &homeserver($sname,$sdom);
2087: my $rep=reply('currentdump:'.$sdom.':'.$sname.':'.$courseid,$uhome);
2088: return if ($rep =~ /^(error:|no_such_host)/);
2089: #
2090: my %returnhash=();
2091: #
2092: if ($rep eq "unknown_cmd") {
2093: # an old lond will not know currentdump
2094: # Do a dump and make it look like a currentdump
2095: my @tmp = &dump($courseid,$sdom,$sname,'.');
2096: return if ($tmp[0] =~ /^(error:|no_such_host)/);
2097: my %hash = @tmp;
2098: @tmp=();
2099: # Code ripped from lond, essentially. The only difference
2100: # here is the unescaping done by lonnet::dump(). Conceivably
2101: # we might run in to problems with parameter names =~ /^v\./
2102: while (my ($key,$value) = each(%hash)) {
2103: my ($v,$symb,$param) = split(/:/,$key);
2104: next if ($v eq 'version' || $symb eq 'keys');
2105: next if (exists($returnhash{$symb}) &&
2106: exists($returnhash{$symb}->{$param}) &&
2107: $returnhash{$symb}->{'v.'.$param} > $v);
2108: $returnhash{$symb}->{$param}=$value;
2109: $returnhash{$symb}->{'v.'.$param}=$v;
2110: }
2111: #
2112: # Remove all of the keys in the hashes which keep track of
2113: # the version of the parameter.
2114: while (my ($symb,$param_hash) = each(%returnhash)) {
2115: # use a foreach because we are going to delete from the hash.
2116: foreach my $key (keys(%$param_hash)) {
2117: delete($param_hash->{$key}) if ($key =~ /^v\./);
2118: }
2119: }
2120: } else {
2121: my @pairs=split(/\&/,$rep);
2122: foreach (@pairs) {
2123: my ($key,$value)=split(/=/,$_);
2124: my ($symb,$param) = split(/:/,$key);
2125: $returnhash{&unescape($symb)}->{&unescape($param)} =
2126: &unescape($value);
2127: }
2128: }
2129: return %returnhash;
2130: }
2131:
2132: # --------------------------------------------------------------- put interface
2133:
2134: sub put {
2135: my ($namespace,$storehash,$udomain,$uname)=@_;
2136: if (!$udomain) { $udomain=$ENV{'user.domain'}; }
2137: if (!$uname) { $uname=$ENV{'user.name'}; }
2138: my $uhome=&homeserver($uname,$udomain);
2139: my $items='';
2140: foreach (keys %$storehash) {
2141: $items.=&escape($_).'='.&escape($$storehash{$_}).'&';
2142: }
2143: $items=~s/\&$//;
2144: return &reply("put:$udomain:$uname:$namespace:$items",$uhome);
2145: }
2146:
2147: # ------------------------------------------------------ critical put interface
2148:
2149: sub cput {
2150: my ($namespace,$storehash,$udomain,$uname)=@_;
2151: if (!$udomain) { $udomain=$ENV{'user.domain'}; }
2152: if (!$uname) { $uname=$ENV{'user.name'}; }
2153: my $uhome=&homeserver($uname,$udomain);
2154: my $items='';
2155: foreach (keys %$storehash) {
2156: $items.=escape($_).'='.escape($$storehash{$_}).'&';
2157: }
2158: $items=~s/\&$//;
2159: return &critical("put:$udomain:$uname:$namespace:$items",$uhome);
2160: }
2161:
2162: # -------------------------------------------------------------- eget interface
2163:
2164: sub eget {
2165: my ($namespace,$storearr,$udomain,$uname)=@_;
2166: my $items='';
2167: foreach (@$storearr) {
2168: $items.=escape($_).'&';
2169: }
2170: $items=~s/\&$//;
2171: if (!$udomain) { $udomain=$ENV{'user.domain'}; }
2172: if (!$uname) { $uname=$ENV{'user.name'}; }
2173: my $uhome=&homeserver($uname,$udomain);
2174: my $rep=&reply("eget:$udomain:$uname:$namespace:$items",$uhome);
2175: my @pairs=split(/\&/,$rep);
2176: my %returnhash=();
2177: my $i=0;
2178: foreach (@$storearr) {
2179: $returnhash{$_}=unescape($pairs[$i]);
2180: $i++;
2181: }
2182: return %returnhash;
2183: }
2184:
2185: # ---------------------------------------------- Custom access rule evaluation
2186:
2187: sub customaccess {
2188: my ($priv,$uri)=@_;
2189: my ($urole,$urealm)=split(/\./,$ENV{'request.role'});
2190: $urealm=~s/^\W//;
2191: my ($udom,$ucrs,$usec)=split(/\//,$urealm);
2192: my $access=0;
2193: foreach (split(/\s*\,\s*/,&metadata($uri,'rule_rights'))) {
2194: my ($effect,$realm,$role)=split(/\:/,$_);
2195: if ($role) {
2196: if ($role ne $urole) { next; }
2197: }
2198: foreach (split(/\s*\,\s*/,$realm)) {
2199: my ($tdom,$tcrs,$tsec)=split(/\_/,$_);
2200: if ($tdom) {
2201: if ($tdom ne $udom) { next; }
2202: }
2203: if ($tcrs) {
2204: if ($tcrs ne $ucrs) { next; }
2205: }
2206: if ($tsec) {
2207: if ($tsec ne $usec) { next; }
2208: }
2209: $access=($effect eq 'allow');
2210: last;
2211: }
2212: }
2213: return $access;
2214: }
2215:
2216: # ------------------------------------------------- Check for a user privilege
2217:
2218: sub allowed {
2219: my ($priv,$uri)=@_;
2220:
2221: my $orguri=$uri;
2222: $uri=&declutter($uri);
2223:
2224: if (defined($ENV{'allowed.'.$priv})) { return $ENV{'allowed.'.$priv}; }
2225: # Free bre access to adm and meta resources
2226:
2227: if ((($uri=~/^adm\//) || ($uri=~/\.meta$/)) && ($priv eq 'bre')) {
2228: return 'F';
2229: }
2230:
2231: # Free bre to public access
2232:
2233: if ($priv eq 'bre') {
2234: my $copyright=&metadata($uri,'copyright');
2235: if (($copyright eq 'public') && (!$ENV{'request.course.id'})) {
2236: return 'F';
2237: }
2238: if ($copyright eq 'priv') {
2239: $uri=~/([^\/]+)\/([^\/]+)\//;
2240: unless (($ENV{'user.name'} eq $2) && ($ENV{'user.domain'} eq $1)) {
2241: return '';
2242: }
2243: }
2244: if ($copyright eq 'domain') {
2245: $uri=~/([^\/]+)\/([^\/]+)\//;
2246: unless (($ENV{'user.domain'} eq $1) ||
2247: ($ENV{'course.'.$ENV{'request.course.id'}.'.domain'} eq $1)) {
2248: return '';
2249: }
2250: }
2251: if ($ENV{'request.role'}=~ /li\.\//) {
2252: # Library role, so allow browsing of resources in this domain.
2253: return 'F';
2254: }
2255: if ($copyright eq 'custom') {
2256: unless (&customaccess($priv,$uri)) { return ''; }
2257: }
2258: }
2259: # Domain coordinator is trying to create a course
2260: if (($priv eq 'ccc') && ($ENV{'request.role'} =~ /^dc\./)) {
2261: # uri is the requested domain in this case.
2262: # comparison to 'request.role.domain' shows if the user has selected
2263: # a role of dc for the domain in question.
2264: return 'F' if ($uri eq $ENV{'request.role.domain'});
2265: }
2266:
2267: my $thisallowed='';
2268: my $statecond=0;
2269: my $courseprivid='';
2270:
2271: # Course
2272:
2273: if ($ENV{'user.priv.'.$ENV{'request.role'}.'./'}=~/$priv\&([^\:]*)/) {
2274: $thisallowed.=$1;
2275: }
2276:
2277: # Domain
2278:
2279: if ($ENV{'user.priv.'.$ENV{'request.role'}.'./'.(split(/\//,$uri))[0].'/'}
2280: =~/$priv\&([^\:]*)/) {
2281: $thisallowed.=$1;
2282: }
2283:
2284: # Course: uri itself is a course
2285: my $courseuri=$uri;
2286: $courseuri=~s/\_(\d)/\/$1/;
2287: $courseuri=~s/^([^\/])/\/$1/;
2288:
2289: if ($ENV{'user.priv.'.$ENV{'request.role'}.'.'.$courseuri}
2290: =~/$priv\&([^\:]*)/) {
2291: $thisallowed.=$1;
2292: }
2293:
2294: # URI is an uploaded document for this course
2295:
2296: if (($priv eq 'bre') &&
2297: ($uri=~/^uploaded\/$ENV{'course.'.$ENV{'request.course.id'}.'.domain'}\/$ENV{'course.'.$ENV{'request.course.id'}.'.num'}/)) {
2298: return 'F';
2299: }
2300: # Full access at system, domain or course-wide level? Exit.
2301:
2302: if ($thisallowed=~/F/) {
2303: return 'F';
2304: }
2305:
2306: # If this is generating or modifying users, exit with special codes
2307:
2308: if (':csu:cdc:ccc:cin:cta:cep:ccr:cst:cad:cli:cau:cdg:cca:'=~/\:$priv\:/) {
2309: return $thisallowed;
2310: }
2311: #
2312: # Gathered so far: system, domain and course wide privileges
2313: #
2314: # Course: See if uri or referer is an individual resource that is part of
2315: # the course
2316:
2317: if ($ENV{'request.course.id'}) {
2318:
2319: $courseprivid=$ENV{'request.course.id'};
2320: if ($ENV{'request.course.sec'}) {
2321: $courseprivid.='/'.$ENV{'request.course.sec'};
2322: }
2323: $courseprivid=~s/\_/\//;
2324: my $checkreferer=1;
2325: my ($match,$cond)=&is_on_map($uri);
2326: if ($match) {
2327: $statecond=$cond;
2328: if ($ENV{'user.priv.'.$ENV{'request.role'}.'./'.$courseprivid}
2329: =~/$priv\&([^\:]*)/) {
2330: $thisallowed.=$1;
2331: $checkreferer=0;
2332: }
2333: }
2334:
2335: if ($checkreferer) {
2336: my $refuri=$ENV{'httpref.'.$orguri};
2337: unless ($refuri) {
2338: foreach (keys %ENV) {
2339: if ($_=~/^httpref\..*\*/) {
2340: my $pattern=$_;
2341: $pattern=~s/^httpref\.\/res\///;
2342: $pattern=~s/\*/\[\^\/\]\+/g;
2343: $pattern=~s/\//\\\//g;
2344: if ($orguri=~/$pattern/) {
2345: $refuri=$ENV{$_};
2346: }
2347: }
2348: }
2349: }
2350:
2351: if ($refuri) {
2352: $refuri=&declutter($refuri);
2353: my ($match,$cond)=&is_on_map($refuri);
2354: if ($match) {
2355: my $refstatecond=$cond;
2356: if ($ENV{'user.priv.'.$ENV{'request.role'}.'./'.$courseprivid}
2357: =~/$priv\&([^\:]*)/) {
2358: $thisallowed.=$1;
2359: $uri=$refuri;
2360: $statecond=$refstatecond;
2361: }
2362: }
2363: }
2364: }
2365: }
2366:
2367: #
2368: # Gathered now: all privileges that could apply, and condition number
2369: #
2370: #
2371: # Full or no access?
2372: #
2373:
2374: if ($thisallowed=~/F/) {
2375: return 'F';
2376: }
2377:
2378: unless ($thisallowed) {
2379: return '';
2380: }
2381:
2382: # Restrictions exist, deal with them
2383: #
2384: # C:according to course preferences
2385: # R:according to resource settings
2386: # L:unless locked
2387: # X:according to user session state
2388: #
2389:
2390: # Possibly locked functionality, check all courses
2391: # Locks might take effect only after 10 minutes cache expiration for other
2392: # courses, and 2 minutes for current course
2393:
2394: my $envkey;
2395: if ($thisallowed=~/L/) {
2396: foreach $envkey (keys %ENV) {
2397: if ($envkey=~/^user\.role\.(st|ta)\.([^\.]*)/) {
2398: my $courseid=$2;
2399: my $roleid=$1.'.'.$2;
2400: $courseid=~s/^\///;
2401: my $expiretime=600;
2402: if ($ENV{'request.role'} eq $roleid) {
2403: $expiretime=120;
2404: }
2405: my ($cdom,$cnum,$csec)=split(/\//,$courseid);
2406: my $prefix='course.'.$cdom.'_'.$cnum.'.';
2407: if ((time-$ENV{$prefix.'last_cache'})>$expiretime) {
2408: &coursedescription($courseid);
2409: }
2410: if (($ENV{$prefix.'res.'.$uri.'.lock.sections'}=~/\,$csec\,/)
2411: || ($ENV{$prefix.'res.'.$uri.'.lock.sections'} eq 'all')) {
2412: if ($ENV{$prefix.'res.'.$uri.'.lock.expire'}>time) {
2413: &log($ENV{'user.domain'},$ENV{'user.name'},
2414: $ENV{'user.home'},
2415: 'Locked by res: '.$priv.' for '.$uri.' due to '.
2416: $cdom.'/'.$cnum.'/'.$csec.' expire '.
2417: $ENV{$prefix.'priv.'.$priv.'.lock.expire'});
2418: return '';
2419: }
2420: }
2421: if (($ENV{$prefix.'priv.'.$priv.'.lock.sections'}=~/\,$csec\,/)
2422: || ($ENV{$prefix.'priv.'.$priv.'.lock.sections'} eq 'all')) {
2423: if ($ENV{'priv.'.$priv.'.lock.expire'}>time) {
2424: &log($ENV{'user.domain'},$ENV{'user.name'},
2425: $ENV{'user.home'},
2426: 'Locked by priv: '.$priv.' for '.$uri.' due to '.
2427: $cdom.'/'.$cnum.'/'.$csec.' expire '.
2428: $ENV{$prefix.'priv.'.$priv.'.lock.expire'});
2429: return '';
2430: }
2431: }
2432: }
2433: }
2434: }
2435:
2436: #
2437: # Rest of the restrictions depend on selected course
2438: #
2439:
2440: unless ($ENV{'request.course.id'}) {
2441: return '1';
2442: }
2443:
2444: #
2445: # Now user is definitely in a course
2446: #
2447:
2448:
2449: # Course preferences
2450:
2451: if ($thisallowed=~/C/) {
2452: my $rolecode=(split(/\./,$ENV{'request.role'}))[0];
2453: my $unamedom=$ENV{'user.name'}.':'.$ENV{'user.domain'};
2454: if ($ENV{'course.'.$ENV{'request.course.id'}.'.'.$priv.'.roles.denied'}
2455: =~/$rolecode/) {
2456: &log($ENV{'user.domain'},$ENV{'user.name'},$ENV{'user.host'},
2457: 'Denied by role: '.$priv.' for '.$uri.' as '.$rolecode.' in '.
2458: $ENV{'request.course.id'});
2459: return '';
2460: }
2461:
2462: if ($ENV{'course.'.$ENV{'request.course.id'}.'.'.$priv.'.users.denied'}
2463: =~/$unamedom/) {
2464: &log($ENV{'user.domain'},$ENV{'user.name'},$ENV{'user.host'},
2465: 'Denied by user: '.$priv.' for '.$uri.' as '.$unamedom.' in '.
2466: $ENV{'request.course.id'});
2467: return '';
2468: }
2469: }
2470:
2471: # Resource preferences
2472:
2473: if ($thisallowed=~/R/) {
2474: my $rolecode=(split(/\./,$ENV{'request.role'}))[0];
2475: if (&metadata($uri,'roledeny')=~/$rolecode/) {
2476: &log($ENV{'user.domain'},$ENV{'user.name'},$ENV{'user.host'},
2477: 'Denied by role: '.$priv.' for '.$uri.' as '.$rolecode);
2478: return '';
2479: }
2480: }
2481:
2482: # Restricted by state or randomout?
2483:
2484: if ($thisallowed=~/X/) {
2485: if ($ENV{'acc.randomout'}) {
2486: my $symb=&symbread($uri,1);
2487: if (($symb) && ($ENV{'acc.randomout'}=~/\&$symb\&/)) {
2488: return '';
2489: }
2490: }
2491: if (&condval($statecond)) {
2492: return '2';
2493: } else {
2494: return '';
2495: }
2496: }
2497:
2498: return 'F';
2499: }
2500:
2501: # --------------------------------------------------- Is a resource on the map?
2502:
2503: sub is_on_map {
2504: my $uri=&declutter(shift);
2505: my @uriparts=split(/\//,$uri);
2506: my $filename=$uriparts[$#uriparts];
2507: my $pathname=$uri;
2508: $pathname=~s|/\Q$filename\E$||;
2509: $pathname=~s/^adm\/wrapper\///;
2510: #Trying to find the conditional for the file
2511: my $match=($ENV{'acc.res.'.$ENV{'request.course.id'}.'.'.$pathname}=~
2512: /\&\Q$filename\E\:([\d\|]+)\&/);
2513: if ($match) {
2514: return (1,$1);
2515: } else {
2516: return (0,0);
2517: }
2518: }
2519:
2520: # ----------------------------------------------------------------- Define Role
2521:
2522: sub definerole {
2523: if (allowed('mcr','/')) {
2524: my ($rolename,$sysrole,$domrole,$courole)=@_;
2525: foreach (split(':',$sysrole)) {
2526: my ($crole,$cqual)=split(/\&/,$_);
2527: if ($pr{'cr:s'}!~/$crole/) { return "refused:s:$crole"; }
2528: if ($pr{'cr:s'}=~/$crole\&/) {
2529: if ($pr{'cr:s'}!~/$crole\&\w*$cqual/) {
2530: return "refused:s:$crole&$cqual";
2531: }
2532: }
2533: }
2534: foreach (split(':',$domrole)) {
2535: my ($crole,$cqual)=split(/\&/,$_);
2536: if ($pr{'cr:d'}!~/$crole/) { return "refused:d:$crole"; }
2537: if ($pr{'cr:d'}=~/$crole\&/) {
2538: if ($pr{'cr:d'}!~/$crole\&\w*$cqual/) {
2539: return "refused:d:$crole&$cqual";
2540: }
2541: }
2542: }
2543: foreach (split(':',$courole)) {
2544: my ($crole,$cqual)=split(/\&/,$_);
2545: if ($pr{'cr:c'}!~/$crole/) { return "refused:c:$crole"; }
2546: if ($pr{'cr:c'}=~/$crole\&/) {
2547: if ($pr{'cr:c'}!~/$crole\&\w*$cqual/) {
2548: return "refused:c:$crole&$cqual";
2549: }
2550: }
2551: }
2552: my $command="encrypt:rolesput:$ENV{'user.domain'}:$ENV{'user.name'}:".
2553: "$ENV{'user.domain'}:$ENV{'user.name'}:".
2554: "rolesdef_$rolename=".
2555: escape($sysrole.'_'.$domrole.'_'.$courole);
2556: return reply($command,$ENV{'user.home'});
2557: } else {
2558: return 'refused';
2559: }
2560: }
2561:
2562: # ---------------- Make a metadata query against the network of library servers
2563:
2564: sub metadata_query {
2565: my ($query,$custom,$customshow,$server_array)=@_;
2566: my %rhash;
2567: my @server_list = (defined($server_array) ? @$server_array
2568: : keys(%libserv) );
2569: for my $server (@server_list) {
2570: unless ($custom or $customshow) {
2571: my $reply=&reply("querysend:".&escape($query),$server);
2572: $rhash{$server}=$reply;
2573: }
2574: else {
2575: my $reply=&reply("querysend:".&escape($query).':'.
2576: &escape($custom).':'.&escape($customshow),
2577: $server);
2578: $rhash{$server}=$reply;
2579: }
2580: }
2581: return \%rhash;
2582: }
2583:
2584: # ----------------------------------------- Send log queries and wait for reply
2585:
2586: sub log_query {
2587: my ($uname,$udom,$query,%filters)=@_;
2588: my $uhome=&homeserver($uname,$udom);
2589: if ($uhome eq 'no_host') { return 'error: no_host'; }
2590: my $uhost=$hostname{$uhome};
2591: my $command=&escape(join(':',map{$_.'='.$filters{$_}} keys %filters));
2592: my $queryid=&reply("querysend:".$query.':'.$udom.':'.$uname.':'.$command,
2593: $uhome);
2594: unless ($queryid=~/^$uhost\_/) { return 'error: '.$queryid; }
2595: return get_query_reply($queryid);
2596: }
2597:
2598: sub get_query_reply {
2599: my $queryid=shift;
2600: my $replyfile=$perlvar{'lonDaemons'}.'/tmp/'.$queryid;
2601: my $reply='';
2602: for (1..100) {
2603: sleep 2;
2604: if (-e $replyfile.'.end') {
2605: if (my $fh=Apache::File->new($replyfile)) {
2606: $reply.=<$fh>;
2607: $fh->close;
2608: } else { return 'error: reply_file_error'; }
2609: return &unescape($reply);
2610: }
2611: }
2612: return 'timeout:'.$queryid;
2613: }
2614:
2615: sub courselog_query {
2616: #
2617: # possible filters:
2618: # url: url or symb
2619: # username
2620: # domain
2621: # action: view, submit, grade
2622: # start: timestamp
2623: # end: timestamp
2624: #
2625: my (%filters)=@_;
2626: unless ($ENV{'request.course.id'}) { return 'no_course'; }
2627: if ($filters{'url'}) {
2628: $filters{'url'}=&symbclean(&declutter($filters{'url'}));
2629: $filters{'url'}=~s/\.(\w+)$/(\\.\\d+)*\\.$1/;
2630: $filters{'url'}=~s/\.(\w+)\_\_\_/(\\.\\d+)*\\.$1/;
2631: }
2632: my $cname=$ENV{'course.'.$ENV{'request.course.id'}.'.num'};
2633: my $cdom=$ENV{'course.'.$ENV{'request.course.id'}.'.domain'};
2634: return &log_query($cname,$cdom,'courselog',%filters);
2635: }
2636:
2637: sub userlog_query {
2638: my ($uname,$udom,%filters)=@_;
2639: return &log_query($uname,$udom,'userlog',%filters);
2640: }
2641:
2642: # ------------------------------------------------------------------ Plain Text
2643:
2644: sub plaintext {
2645: my $short=shift;
2646: return $prp{$short};
2647: }
2648:
2649: # ----------------------------------------------------------------- Assign Role
2650:
2651: sub assignrole {
2652: my ($udom,$uname,$url,$role,$end,$start,$deleteflag)=@_;
2653: my $mrole;
2654: if ($role =~ /^cr\//) {
2655: my $cwosec=$url;
2656: $cwosec=~s/^\/(\w+)\/(\w+)\/.*/$1\/$2/;
2657: unless (&allowed('ccr',$cwosec)) {
2658: &logthis('Refused custom assignrole: '.
2659: $udom.' '.$uname.' '.$url.' '.$role.' '.$end.' '.$start.' by '.
2660: $ENV{'user.name'}.' at '.$ENV{'user.domain'});
2661: return 'refused';
2662: }
2663: $mrole='cr';
2664: } else {
2665: my $cwosec=$url;
2666: $cwosec=~s/^\/(\w+)\/(\w+)\/.*/$1\/$2/;
2667: unless ((&allowed('c'.$role,$cwosec)) || &allowed('c'.$role,$udom)) {
2668: &logthis('Refused assignrole: '.
2669: $udom.' '.$uname.' '.$url.' '.$role.' '.$end.' '.$start.' by '.
2670: $ENV{'user.name'}.' at '.$ENV{'user.domain'});
2671: return 'refused';
2672: }
2673: $mrole=$role;
2674: }
2675: my $command="encrypt:rolesput:$ENV{'user.domain'}:$ENV{'user.name'}:".
2676: "$udom:$uname:$url".'_'."$mrole=$role";
2677: if ($end) { $command.='_'.$end; }
2678: if ($start) {
2679: if ($end) {
2680: $command.='_'.$start;
2681: } else {
2682: $command.='_0_'.$start;
2683: }
2684: }
2685: # actually delete
2686: if ($deleteflag) {
2687: if ((&allowed('dro',$udom)) || (&allowed('dro',$url))) {
2688: # modify command to delete the role
2689: $command="encrypt:rolesdel:$ENV{'user.domain'}:$ENV{'user.name'}:".
2690: "$udom:$uname:$url".'_'."$mrole";
2691: &logthis("$ENV{'user.name'} at $ENV{'user.domain'} deletes $mrole in $url for $uname at $udom");
2692: # set start and finish to negative values for userrolelog
2693: $start=-1;
2694: $end=-1;
2695: }
2696: }
2697: # send command
2698: my $answer=&reply($command,&homeserver($uname,$udom));
2699: # log new user role if status is ok
2700: if ($answer eq 'ok') {
2701: &userrolelog($mrole,$uname,$udom,$url,$start,$end);
2702: }
2703: return $answer;
2704: }
2705:
2706: # -------------------------------------------------- Modify user authentication
2707: # Overrides without validation
2708:
2709: sub modifyuserauth {
2710: my ($udom,$uname,$umode,$upass)=@_;
2711: my $uhome=&homeserver($uname,$udom);
2712: unless (&allowed('mau',$udom)) { return 'refused'; }
2713: &logthis('Call to modify user authentication '.$udom.', '.$uname.', '.
2714: $umode.' by '.$ENV{'user.name'}.' at '.$ENV{'user.domain'}.
2715: ' in domain '.$ENV{'request.role.domain'});
2716: my $reply=&reply('encrypt:changeuserauth:'.$udom.':'.$uname.':'.$umode.':'.
2717: &escape($upass),$uhome);
2718: &log($ENV{'user.domain'},$ENV{'user.name'},$ENV{'user.home'},
2719: 'Authentication changed for '.$udom.', '.$uname.', '.$umode.
2720: '(Remote '.$ENV{'REMOTE_ADDR'}.'): '.$reply);
2721: &log($udom,,$uname,$uhome,
2722: 'Authentication changed by '.$ENV{'user.domain'}.', '.
2723: $ENV{'user.name'}.', '.$umode.
2724: '(Remote '.$ENV{'REMOTE_ADDR'}.'): '.$reply);
2725: unless ($reply eq 'ok') {
2726: &logthis('Authentication mode error: '.$reply);
2727: return 'error: '.$reply;
2728: }
2729: return 'ok';
2730: }
2731:
2732: # --------------------------------------------------------------- Modify a user
2733:
2734: sub modifyuser {
2735: my ($udom, $uname, $uid,
2736: $umode, $upass, $first,
2737: $middle, $last, $gene,
2738: $forceid, $desiredhome, $email)=@_;
2739: $udom=~s/\W//g;
2740: $uname=~s/\W//g;
2741: &logthis('Call to modify user '.$udom.', '.$uname.', '.$uid.', '.
2742: $umode.', '.$first.', '.$middle.', '.
2743: $last.', '.$gene.'(forceid: '.$forceid.')'.
2744: (defined($desiredhome) ? ' desiredhome = '.$desiredhome :
2745: ' desiredhome not specified').
2746: ' by '.$ENV{'user.name'}.' at '.$ENV{'user.domain'}.
2747: ' in domain '.$ENV{'request.role.domain'});
2748: my $uhome=&homeserver($uname,$udom,'true');
2749: # ----------------------------------------------------------------- Create User
2750: if (($uhome eq 'no_host') && ($umode) && ($upass)) {
2751: my $unhome='';
2752: if (defined($desiredhome) && $hostdom{$desiredhome} eq $udom) {
2753: $unhome = $desiredhome;
2754: } elsif($ENV{'course.'.$ENV{'request.course.id'}.'.domain'} eq $udom) {
2755: $unhome=$ENV{'course.'.$ENV{'request.course.id'}.'.home'};
2756: } else { # load balancing routine for determining $unhome
2757: my $tryserver;
2758: my $loadm=10000000;
2759: foreach $tryserver (keys %libserv) {
2760: if ($hostdom{$tryserver} eq $udom) {
2761: my $answer=reply('load',$tryserver);
2762: if (($answer=~/\d+/) && ($answer<$loadm)) {
2763: $loadm=$answer;
2764: $unhome=$tryserver;
2765: }
2766: }
2767: }
2768: }
2769: if (($unhome eq '') || ($unhome eq 'no_host')) {
2770: return 'error: unable to find a home server for '.$uname.
2771: ' in domain '.$udom;
2772: }
2773: my $reply=&reply('encrypt:makeuser:'.$udom.':'.$uname.':'.$umode.':'.
2774: &escape($upass),$unhome);
2775: unless ($reply eq 'ok') {
2776: return 'error: '.$reply;
2777: }
2778: $uhome=&homeserver($uname,$udom,'true');
2779: if (($uhome eq '') || ($uhome eq 'no_host') || ($uhome ne $unhome)) {
2780: return 'error: unable verify users home machine.';
2781: }
2782: } # End of creation of new user
2783: # ---------------------------------------------------------------------- Add ID
2784: if ($uid) {
2785: $uid=~tr/A-Z/a-z/;
2786: my %uidhash=&idrget($udom,$uname);
2787: if (($uidhash{$uname}) && ($uidhash{$uname}!~/error\:/)
2788: && (!$forceid)) {
2789: unless ($uid eq $uidhash{$uname}) {
2790: return 'error: user id "'.$uid.'" does not match '.
2791: 'current user id "'.$uidhash{$uname}.'".';
2792: }
2793: } else {
2794: &idput($udom,($uname => $uid));
2795: }
2796: }
2797: # -------------------------------------------------------------- Add names, etc
2798: my @tmp=&get('environment',
2799: ['firstname','middlename','lastname','generation'],
2800: $udom,$uname);
2801: my %names;
2802: if ($tmp[0] =~ m/^error:.*/) {
2803: %names=();
2804: } else {
2805: %names = @tmp;
2806: }
2807: #
2808: # Make sure to not trash student environment if instructor does not bother
2809: # to supply name and email information
2810: #
2811: if ($first) { $names{'firstname'} = $first; }
2812: if (defined($middle)) { $names{'middlename'} = $middle; }
2813: if ($last) { $names{'lastname'} = $last; }
2814: if (defined($gene)) { $names{'generation'} = $gene; }
2815: if ($email) { $names{'notification'} = $email;
2816: $names{'critnotification'} = $email; }
2817:
2818: my $reply = &put('environment', \%names, $udom,$uname);
2819: if ($reply ne 'ok') { return 'error: '.$reply; }
2820: &logthis('Success modifying user '.$udom.', '.$uname.', '.$uid.', '.
2821: $umode.', '.$first.', '.$middle.', '.
2822: $last.', '.$gene.' by '.
2823: $ENV{'user.name'}.' at '.$ENV{'user.domain'});
2824: return 'ok';
2825: }
2826:
2827: # -------------------------------------------------------------- Modify student
2828:
2829: sub modifystudent {
2830: my ($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene,$usec,
2831: $end,$start,$forceid,$desiredhome,$email)=@_;
2832: my $cid='';
2833: unless ($cid=$ENV{'request.course.id'}) {
2834: return 'not_in_class';
2835: }
2836: # --------------------------------------------------------------- Make the user
2837: my $reply=&modifyuser
2838: ($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene,$forceid,
2839: $desiredhome,$email);
2840: unless ($reply eq 'ok') { return $reply; }
2841: # This will cause &modify_student_enrollment to get the uid from the
2842: # students environment
2843: $uid = undef if (!$forceid);
2844: $reply = &modify_student_enrollment($udom,$uname,$uid,$first,$middle,
2845: $last,$gene,$usec,$end,$start);
2846: return $reply;
2847: }
2848:
2849: sub modify_student_enrollment {
2850: my ($udom,$uname,$uid,$first,$middle,$last,$gene,$usec,$end,$start) = @_;
2851: # Get the course id from the environment
2852: my $cid='';
2853: unless ($cid=$ENV{'request.course.id'}) {
2854: return 'not_in_class';
2855: }
2856: # Make sure the user exists
2857: my $uhome=&homeserver($uname,$udom);
2858: if (($uhome eq '') || ($uhome eq 'no_host')) {
2859: return 'error: no such user';
2860: }
2861: #
2862: # Get student data if we were not given enough information
2863: if (!defined($first) || $first eq '' ||
2864: !defined($last) || $last eq '' ||
2865: !defined($uid) || $uid eq '' ||
2866: !defined($middle) || $middle eq '' ||
2867: !defined($gene) || $gene eq '') {
2868: # They did not supply us with enough data to enroll the student, so
2869: # we need to pick up more information.
2870: my %tmp = &get('environment',
2871: ['firstname','middlename','lastname', 'generation','id']
2872: ,$udom,$uname);
2873:
2874: foreach (keys(%tmp)) {
2875: &logthis("key $_ = ".$tmp{$_});
2876: }
2877: $first = $tmp{'firstname'} if (!defined($first) || $first eq '');
2878: $middle = $tmp{'middlename'} if (!defined($middle) || $middle eq '');
2879: $last = $tmp{'lastname'} if (!defined($last) || $last eq '');
2880: $gene = $tmp{'generation'} if (!defined($gene) || $gene eq '');
2881: $uid = $tmp{'id'} if (!defined($uid) || $uid eq '');
2882: }
2883: my $fullname = &Apache::loncoursedata::ProcessFullName($last,$gene,
2884: $first,$middle);
2885: my $reply=critical('put:'.$ENV{'course.'.$cid.'.domain'}.':'.
2886: $ENV{'course.'.$cid.'.num'}.':classlist:'.
2887: &escape($uname.':'.$udom).'='.
2888: &escape(join(':',$end,$start,$uid,$usec,$fullname)),
2889: $ENV{'course.'.$cid.'.home'});
2890: unless (($reply eq 'ok') || ($reply eq 'delayed')) {
2891: return 'error: '.$reply;
2892: }
2893: # Add student role to user
2894: my $uurl='/'.$cid;
2895: $uurl=~s/\_/\//g;
2896: if ($usec) {
2897: $uurl.='/'.$usec;
2898: }
2899: return &assignrole($udom,$uname,$uurl,'st',$end,$start);
2900: }
2901:
2902: # ------------------------------------------------- Write to course preferences
2903:
2904: sub writecoursepref {
2905: my ($courseid,%prefs)=@_;
2906: $courseid=~s/^\///;
2907: $courseid=~s/\_/\//g;
2908: my ($cdomain,$cnum)=split(/\//,$courseid);
2909: my $chome=homeserver($cnum,$cdomain);
2910: if (($chome eq '') || ($chome eq 'no_host')) {
2911: return 'error: no such course';
2912: }
2913: my $cstring='';
2914: foreach (keys %prefs) {
2915: $cstring.=escape($_).'='.escape($prefs{$_}).'&';
2916: }
2917: $cstring=~s/\&$//;
2918: return reply('put:'.$cdomain.':'.$cnum.':environment:'.$cstring,$chome);
2919: }
2920:
2921: # ---------------------------------------------------------- Make/modify course
2922:
2923: sub createcourse {
2924: my ($udom,$description,$url,$course_server,$nonstandard)=@_;
2925: $url=&declutter($url);
2926: my $cid='';
2927: unless (&allowed('ccc',$udom)) {
2928: return 'refused';
2929: }
2930: # ------------------------------------------------------------------- Create ID
2931: my $uname=substr($$.time,0,5).unpack("H8",pack("I32",time)).
2932: unpack("H2",pack("I32",int(rand(255)))).$perlvar{'lonHostID'};
2933: # ----------------------------------------------- Make sure that does not exist
2934: my $uhome=&homeserver($uname,$udom,'true');
2935: unless (($uhome eq '') || ($uhome eq 'no_host')) {
2936: $uname=substr($$.time,0,5).unpack("H8",pack("I32",time)).
2937: unpack("H2",pack("I32",int(rand(255)))).$perlvar{'lonHostID'};
2938: $uhome=&homeserver($uname,$udom,'true');
2939: unless (($uhome eq '') || ($uhome eq 'no_host')) {
2940: return 'error: unable to generate unique course-ID';
2941: }
2942: }
2943: # ------------------------------------------------ Check supplied server name
2944: $course_server = $ENV{'user.homeserver'} if (! defined($course_server));
2945: if (! exists($libserv{$course_server})) {
2946: return 'error:bad server name '.$course_server;
2947: }
2948: # ------------------------------------------------------------- Make the course
2949: my $reply=&reply('encrypt:makeuser:'.$udom.':'.$uname.':none::',
2950: $course_server);
2951: unless ($reply eq 'ok') { return 'error: '.$reply; }
2952: $uhome=&homeserver($uname,$udom,'true');
2953: if (($uhome eq '') || ($uhome eq 'no_host')) {
2954: return 'error: no such course';
2955: }
2956: # ----------------------------------------------------------------- Course made
2957: # log existance
2958: &courseidput($udom,&escape($udom.'_'.$uname).'='.&escape($description),
2959: $uhome);
2960: &flushcourselogs();
2961: # set toplevel url
2962: my $topurl=$url;
2963: unless ($nonstandard) {
2964: # ------------------------------------------ For standard courses, make top url
2965: my $mapurl=&clutter($url);
2966: if ($mapurl eq '/res/') { $mapurl=''; }
2967: $ENV{'form.initmap'}=(<<ENDINITMAP);
2968: <map>
2969: <resource id="1" type="start"></resource>
2970: <resource id="2" src="$mapurl"></resource>
2971: <resource id="3" type="finish"></resource>
2972: <link index="1" from="1" to="2"></link>
2973: <link index="2" from="2" to="3"></link>
2974: </map>
2975: ENDINITMAP
2976: $topurl=&declutter(
2977: &finishuserfileupload($uname,$udom,$uhome,'initmap','default.sequence')
2978: );
2979: }
2980: # ----------------------------------------------------------- Write preferences
2981: &writecoursepref($udom.'_'.$uname,
2982: ('description' => $description,
2983: 'url' => $topurl));
2984: return '/'.$udom.'/'.$uname;
2985: }
2986:
2987: # ---------------------------------------------------------- Assign Custom Role
2988:
2989: sub assigncustomrole {
2990: my ($udom,$uname,$url,$rdom,$rnam,$rolename,$end,$start,$deleteflag)=@_;
2991: return &assignrole($udom,$uname,$url,'cr/'.$rdom.'/'.$rnam.'/'.$rolename,
2992: $end,$start,$deleteflag);
2993: }
2994:
2995: # ----------------------------------------------------------------- Revoke Role
2996:
2997: sub revokerole {
2998: my ($udom,$uname,$url,$role,$deleteflag)=@_;
2999: my $now=time;
3000: return &assignrole($udom,$uname,$url,$role,$now,$deleteflag);
3001: }
3002:
3003: # ---------------------------------------------------------- Revoke Custom Role
3004:
3005: sub revokecustomrole {
3006: my ($udom,$uname,$url,$rdom,$rnam,$rolename,$deleteflag)=@_;
3007: my $now=time;
3008: return &assigncustomrole($udom,$uname,$url,$rdom,$rnam,$rolename,$now,
3009: $deleteflag);
3010: }
3011:
3012: # ------------------------------------------------------------ Directory lister
3013:
3014: sub dirlist {
3015: my ($uri,$userdomain,$username,$alternateDirectoryRoot)=@_;
3016:
3017: $uri=~s/^\///;
3018: $uri=~s/\/$//;
3019: my ($udom, $uname);
3020: (undef,$udom,$uname)=split(/\//,$uri);
3021: if(defined($userdomain)) {
3022: $udom = $userdomain;
3023: }
3024: if(defined($username)) {
3025: $uname = $username;
3026: }
3027:
3028: my $dirRoot = $perlvar{'lonDocRoot'};
3029: if(defined($alternateDirectoryRoot)) {
3030: $dirRoot = $alternateDirectoryRoot;
3031: $dirRoot =~ s/\/$//;
3032: }
3033:
3034: if($udom) {
3035: if($uname) {
3036: my $listing=reply('ls:'.$dirRoot.'/'.$uri,
3037: homeserver($uname,$udom));
3038: return split(/:/,$listing);
3039: } elsif(!defined($alternateDirectoryRoot)) {
3040: my $tryserver;
3041: my %allusers=();
3042: foreach $tryserver (keys %libserv) {
3043: if($hostdom{$tryserver} eq $udom) {
3044: my $listing=reply('ls:'.$perlvar{'lonDocRoot'}.'/res/'.
3045: $udom, $tryserver);
3046: if (($listing ne 'no_such_dir') && ($listing ne 'empty')
3047: && ($listing ne 'con_lost')) {
3048: foreach (split(/:/,$listing)) {
3049: my ($entry,@stat)=split(/&/,$_);
3050: $allusers{$entry}=1;
3051: }
3052: }
3053: }
3054: }
3055: my $alluserstr='';
3056: foreach (sort keys %allusers) {
3057: $alluserstr.=$_.'&user:';
3058: }
3059: $alluserstr=~s/:$//;
3060: return split(/:/,$alluserstr);
3061: } else {
3062: my @emptyResults = ();
3063: push(@emptyResults, 'missing user name');
3064: return split(':',@emptyResults);
3065: }
3066: } elsif(!defined($alternateDirectoryRoot)) {
3067: my $tryserver;
3068: my %alldom=();
3069: foreach $tryserver (keys %libserv) {
3070: $alldom{$hostdom{$tryserver}}=1;
3071: }
3072: my $alldomstr='';
3073: foreach (sort keys %alldom) {
3074: $alldomstr.=$perlvar{'lonDocRoot'}.'/res/'.$_.'/&domain:';
3075: }
3076: $alldomstr=~s/:$//;
3077: return split(/:/,$alldomstr);
3078: } else {
3079: my @emptyResults = ();
3080: push(@emptyResults, 'missing domain');
3081: return split(':',@emptyResults);
3082: }
3083: }
3084:
3085: # --------------------------------------------- GetFileTimestamp
3086: # This function utilizes dirlist and returns the date stamp for
3087: # when it was last modified. It will also return an error of -1
3088: # if an error occurs
3089:
3090: sub GetFileTimestamp {
3091: my ($studentDomain,$studentName,$filename,$root)=@_;
3092: $studentDomain=~s/\W//g;
3093: $studentName=~s/\W//g;
3094: my $subdir=$studentName.'__';
3095: $subdir =~ s/(.)(.)(.).*/$1\/$2\/$3/;
3096: my $proname="$studentDomain/$subdir/$studentName";
3097: $proname .= '/'.$filename;
3098: my ($fileStat) = &Apache::lonnet::dirlist($proname, $studentDomain,
3099: $studentName, $root);
3100: my @stats = split('&', $fileStat);
3101: if($stats[0] ne 'empty' && $stats[0] ne 'no_such_dir') {
3102: # @stats contains first the filename, then the stat output
3103: return $stats[10]; # so this is 10 instead of 9.
3104: } else {
3105: return -1;
3106: }
3107: }
3108:
3109: # -------------------------------------------------------- Value of a Condition
3110:
3111: sub directcondval {
3112: my $number=shift;
3113: if ($ENV{'user.state.'.$ENV{'request.course.id'}}) {
3114: return substr($ENV{'user.state.'.$ENV{'request.course.id'}},$number,1);
3115: } else {
3116: return 2;
3117: }
3118: }
3119:
3120: sub condval {
3121: my $condidx=shift;
3122: my $result=0;
3123: my $allpathcond='';
3124: foreach (split(/\|/,$condidx)) {
3125: if (defined($ENV{'acc.cond.'.$ENV{'request.course.id'}.'.'.$_})) {
3126: $allpathcond.=
3127: '('.$ENV{'acc.cond.'.$ENV{'request.course.id'}.'.'.$_}.')|';
3128: }
3129: }
3130: $allpathcond=~s/\|$//;
3131: if ($ENV{'request.course.id'}) {
3132: if ($allpathcond) {
3133: my $operand='|';
3134: my @stack;
3135: foreach ($allpathcond=~/(\d+|\(|\)|\&|\|)/g) {
3136: if ($_ eq '(') {
3137: push @stack,($operand,$result)
3138: } elsif ($_ eq ')') {
3139: my $before=pop @stack;
3140: if (pop @stack eq '&') {
3141: $result=$result>$before?$before:$result;
3142: } else {
3143: $result=$result>$before?$result:$before;
3144: }
3145: } elsif (($_ eq '&') || ($_ eq '|')) {
3146: $operand=$_;
3147: } else {
3148: my $new=directcondval($_);
3149: if ($operand eq '&') {
3150: $result=$result>$new?$new:$result;
3151: } else {
3152: $result=$result>$new?$result:$new;
3153: }
3154: }
3155: }
3156: }
3157: }
3158: return $result;
3159: }
3160:
3161: # ---------------------------------------------------- Devalidate courseresdata
3162:
3163: sub devalidatecourseresdata {
3164: my ($coursenum,$coursedomain)=@_;
3165: my $hashid=$coursenum.':'.$coursedomain;
3166: delete $courseresdatacache{$hashid.'.time'};
3167: }
3168:
3169: # --------------------------------------------------- Course Resourcedata Query
3170:
3171: sub courseresdata {
3172: my ($coursenum,$coursedomain,@which)=@_;
3173: my $coursehom=&homeserver($coursenum,$coursedomain);
3174: my $hashid=$coursenum.':'.$coursedomain;
3175: my $dodump=0;
3176: if (!defined($courseresdatacache{$hashid.'.time'})) {
3177: $dodump=1;
3178: } else {
3179: if (time-$courseresdatacache{$hashid.'.time'}>300) { $dodump=1; }
3180: }
3181: if ($dodump) {
3182: my %dumpreply=&dump('resourcedata',$coursedomain,$coursenum);
3183: my ($tmp) = keys(%dumpreply);
3184: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
3185: $courseresdatacache{$hashid.'.time'}=time;
3186: $courseresdatacache{$hashid}=\%dumpreply;
3187: } elsif ($tmp =~ /^(con_lost|no_such_host)/) {
3188: return $tmp;
3189: }
3190: }
3191: foreach my $item (@which) {
3192: if (defined($courseresdatacache{$hashid}->{$item})) {
3193: return $courseresdatacache{$hashid}->{$item};
3194: }
3195: }
3196: return undef;
3197: }
3198:
3199: #
3200: # EXT resource caching routines
3201: #
3202:
3203: sub clear_EXT_cache_status {
3204: &delenv('cache.EXT.');
3205: }
3206:
3207: sub EXT_cache_status {
3208: my ($target_domain,$target_user) = @_;
3209: my $cachename = 'cache.EXT.'.$target_user.'.'.$target_domain;
3210: if (exists($ENV{$cachename}) && ($ENV{$cachename}+600) > time) {
3211: # We know already the user has no data
3212: return 1;
3213: } else {
3214: return 0;
3215: }
3216: }
3217:
3218: sub EXT_cache_set {
3219: my ($target_domain,$target_user) = @_;
3220: my $cachename = 'cache.EXT.'.$target_user.'.'.$target_domain;
3221: &appenv($cachename => time);
3222: }
3223:
3224: # --------------------------------------------------------- Value of a Variable
3225: sub EXT {
3226: my ($varname,$symbparm,$udom,$uname,$usection,$recurse)=@_;
3227:
3228: unless ($varname) { return ''; }
3229: #get real user name/domain, courseid and symb
3230: my $courseid;
3231: my $publicuser;
3232: if (!($uname && $udom)) {
3233: (my $cursymb,$courseid,$udom,$uname,$publicuser)=
3234: &Apache::lonxml::whichuser($symbparm);
3235: if (!$symbparm) { $symbparm=$cursymb; }
3236: } else {
3237: $courseid=$ENV{'request.course.id'};
3238: }
3239: my ($realm,$space,$qualifier,@therest)=split(/\./,$varname);
3240: my $rest;
3241: if (defined($therest[0])) {
3242: $rest=join('.',@therest);
3243: } else {
3244: $rest='';
3245: }
3246:
3247: my $qualifierrest=$qualifier;
3248: if ($rest) { $qualifierrest.='.'.$rest; }
3249: my $spacequalifierrest=$space;
3250: if ($qualifierrest) { $spacequalifierrest.='.'.$qualifierrest; }
3251: if ($realm eq 'user') {
3252: # --------------------------------------------------------------- user.resource
3253: if ($space eq 'resource') {
3254: if (defined($Apache::lonhomework::parsing_a_problem)) {
3255: return $Apache::lonhomework::history{$qualifierrest};
3256: } else {
3257: my %restored;
3258: if ($publicuser || $ENV{'request.state'} eq 'construct') {
3259: %restored=&tmprestore($symbparm,$courseid,$udom,$uname);
3260: } else {
3261: %restored=&restore($symbparm,$courseid,$udom,$uname);
3262: }
3263: return $restored{$qualifierrest};
3264: }
3265: # ----------------------------------------------------------------- user.access
3266: } elsif ($space eq 'access') {
3267: # FIXME - not supporting calls for a specific user
3268: return &allowed($qualifier,$rest);
3269: # ------------------------------------------ user.preferences, user.environment
3270: } elsif (($space eq 'preferences') || ($space eq 'environment')) {
3271: if (($uname eq $ENV{'user.name'}) &&
3272: ($udom eq $ENV{'user.domain'})) {
3273: return $ENV{join('.',('environment',$qualifierrest))};
3274: } else {
3275: my %returnhash;
3276: if (!$publicuser) {
3277: %returnhash=&userenvironment($udom,$uname,
3278: $qualifierrest);
3279: }
3280: return $returnhash{$qualifierrest};
3281: }
3282: # ----------------------------------------------------------------- user.course
3283: } elsif ($space eq 'course') {
3284: # FIXME - not supporting calls for a specific user
3285: return $ENV{join('.',('request.course',$qualifier))};
3286: # ------------------------------------------------------------------- user.role
3287: } elsif ($space eq 'role') {
3288: # FIXME - not supporting calls for a specific user
3289: my ($role,$where)=split(/\./,$ENV{'request.role'});
3290: if ($qualifier eq 'value') {
3291: return $role;
3292: } elsif ($qualifier eq 'extent') {
3293: return $where;
3294: }
3295: # ----------------------------------------------------------------- user.domain
3296: } elsif ($space eq 'domain') {
3297: return $udom;
3298: # ------------------------------------------------------------------- user.name
3299: } elsif ($space eq 'name') {
3300: return $uname;
3301: # ---------------------------------------------------- Any other user namespace
3302: } else {
3303: my %reply;
3304: if (!$publicuser) {
3305: %reply=&get($space,[$qualifierrest],$udom,$uname);
3306: }
3307: return $reply{$qualifierrest};
3308: }
3309: } elsif ($realm eq 'query') {
3310: # ---------------------------------------------- pull stuff out of query string
3311: &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},
3312: [$spacequalifierrest]);
3313: return $ENV{'form.'.$spacequalifierrest};
3314: } elsif ($realm eq 'request') {
3315: # ------------------------------------------------------------- request.browser
3316: if ($space eq 'browser') {
3317: return $ENV{'browser.'.$qualifier};
3318: # ------------------------------------------------------------ request.filename
3319: } else {
3320: return $ENV{'request.'.$spacequalifierrest};
3321: }
3322: } elsif ($realm eq 'course') {
3323: # ---------------------------------------------------------- course.description
3324: return $ENV{'course.'.$courseid.'.'.$spacequalifierrest};
3325: } elsif ($realm eq 'resource') {
3326:
3327: my $section;
3328: if (defined($courseid) && $courseid eq $ENV{'request.course.id'}) {
3329:
3330: #print '<br>'.$space.' - '.$qualifier.' - '.$spacequalifierrest;
3331:
3332: # ----------------------------------------------------- Cascading lookup scheme
3333: if (!$symbparm) { $symbparm=&symbread(); }
3334: my $symbp=$symbparm;
3335: my $mapp=(split(/\_\_\_/,$symbp))[0];
3336:
3337: my $symbparm=$symbp.'.'.$spacequalifierrest;
3338: my $mapparm=$mapp.'___(all).'.$spacequalifierrest;
3339:
3340: if (($ENV{'user.name'} eq $uname) &&
3341: ($ENV{'user.domain'} eq $udom)) {
3342: $section=$ENV{'request.course.sec'};
3343: } else {
3344: if (! defined($usection)) {
3345: $section=&usection($udom,$uname,$courseid);
3346: } else {
3347: $section = $usection;
3348: }
3349: }
3350:
3351: my $seclevel=$courseid.'.['.$section.'].'.$spacequalifierrest;
3352: my $seclevelr=$courseid.'.['.$section.'].'.$symbparm;
3353: my $seclevelm=$courseid.'.['.$section.'].'.$mapparm;
3354:
3355: my $courselevel=$courseid.'.'.$spacequalifierrest;
3356: my $courselevelr=$courseid.'.'.$symbparm;
3357: my $courselevelm=$courseid.'.'.$mapparm;
3358:
3359: # ----------------------------------------------------------- first, check user
3360: #most student don\'t have any data set, check if there is some data
3361: #every thirty minutes
3362: if (! &EXT_cache_status($udom,$uname)) {
3363: my %resourcedata=&get('resourcedata',
3364: [$courselevelr,$courselevelm,$courselevel],
3365: $udom,$uname);
3366: my ($tmp)=keys(%resourcedata);
3367: if (($tmp!~/^error\:/) && ($tmp!~/^con_lost/)) {
3368: if ($resourcedata{$courselevelr}) {
3369: return $resourcedata{$courselevelr}; }
3370: if ($resourcedata{$courselevelm}) {
3371: return $resourcedata{$courselevelm}; }
3372: if ($resourcedata{$courselevel}) {
3373: return $resourcedata{$courselevel}; }
3374: } else {
3375: if ($tmp!~/No such file/) {
3376: &logthis("<font color=blue>WARNING:".
3377: " Trying to get resource data for ".
3378: $uname." at ".$udom.": ".
3379: $tmp."</font>");
3380: } elsif ($tmp=~/error:No such file/) {
3381: &EXT_cache_set($udom,$uname);
3382: } elsif ($tmp =~ /^(con_lost|no_such_host)/) {
3383: return $tmp;
3384: }
3385: }
3386: }
3387:
3388: # -------------------------------------------------------- second, check course
3389:
3390: my $coursereply=&courseresdata($ENV{'course.'.$courseid.'.num'},
3391: $ENV{'course.'.$courseid.'.domain'},
3392: ($seclevelr,$seclevelm,$seclevel,
3393: $courselevelr,$courselevelm,
3394: $courselevel));
3395: if (defined($coursereply)) { return $coursereply; }
3396:
3397: # ------------------------------------------------------ third, check map parms
3398: my %parmhash=();
3399: my $thisparm='';
3400: if (tie(%parmhash,'GDBM_File',
3401: $ENV{'request.course.fn'}.'_parms.db',
3402: &GDBM_READER(),0640)) {
3403: $thisparm=$parmhash{$symbparm};
3404: untie(%parmhash);
3405: }
3406: if ($thisparm) { return $thisparm; }
3407: }
3408: # --------------------------------------------- last, look in resource metadata
3409:
3410: $spacequalifierrest=~s/\./\_/;
3411: my $filename;
3412: if (!$symbparm) { $symbparm=&symbread(); }
3413: if ($symbparm) {
3414: $filename=(split(/\_\_\_/,$symbparm))[2];
3415: } else {
3416: $filename=$ENV{'request.filename'};
3417: }
3418: my $metadata=&metadata($filename,$spacequalifierrest);
3419: if (defined($metadata)) { return $metadata; }
3420: $metadata=&metadata($filename,'parameter_'.$spacequalifierrest);
3421: if (defined($metadata)) { return $metadata; }
3422:
3423: # ------------------------------------------------------------------ Cascade up
3424: unless ($space eq '0') {
3425: my @parts=split(/_/,$space);
3426: my $id=pop(@parts);
3427: my $part=join('_',@parts);
3428: if ($part eq '') { $part='0'; }
3429: my $partgeneral=&EXT('resource.'.$part.'.'.$qualifierrest,
3430: $symbparm,$udom,$uname,$section,1);
3431: if (defined($partgeneral)) { return $partgeneral; }
3432: }
3433: if ($recurse) { return undef; }
3434: my $pack_def=&packages_tab_default($filename,$varname);
3435: if (defined($pack_def)) { return $pack_def; }
3436:
3437: # ---------------------------------------------------- Any other user namespace
3438: } elsif ($realm eq 'environment') {
3439: # ----------------------------------------------------------------- environment
3440: if (($uname eq $ENV{'user.name'})&&($udom eq $ENV{'user.domain'})) {
3441: return $ENV{'environment.'.$spacequalifierrest};
3442: } else {
3443: my %returnhash=&userenvironment($udom,$uname,
3444: $spacequalifierrest);
3445: return $returnhash{$spacequalifierrest};
3446: }
3447: } elsif ($realm eq 'system') {
3448: # ----------------------------------------------------------------- system.time
3449: if ($space eq 'time') {
3450: return time;
3451: }
3452: }
3453: return '';
3454: }
3455:
3456: sub packages_tab_default {
3457: my ($uri,$varname)=@_;
3458: my (undef,$part,$name)=split(/\./,$varname);
3459: my $packages=&metadata($uri,'packages');
3460: foreach my $package (split(/,/,$packages)) {
3461: my ($pack_type,$pack_part)=split(/_/,$package,2);
3462: if ($pack_part eq $part) {
3463: return $packagetab{"$pack_type&$name&default"};
3464: }
3465: }
3466: return undef;
3467: }
3468:
3469: sub add_prefix_and_part {
3470: my ($prefix,$part)=@_;
3471: my $keyroot;
3472: if (defined($prefix) && $prefix !~ /^__/) {
3473: # prefix that has a part already
3474: $keyroot=$prefix;
3475: } elsif (defined($prefix)) {
3476: # prefix that is missing a part
3477: if (defined($part)) { $keyroot='_'.$part.substr($prefix,1); }
3478: } else {
3479: # no prefix at all
3480: if (defined($part)) { $keyroot='_'.$part; }
3481: }
3482: return $keyroot;
3483: }
3484:
3485: # ---------------------------------------------------------------- Get metadata
3486:
3487: sub metadata {
3488: my ($uri,$what,$liburi,$prefix,$depthcount)=@_;
3489:
3490: $uri=&declutter($uri);
3491: # if it is a non metadata possible uri return quickly
3492: if (($uri eq '') || (($uri =~ m|^/*adm/|) && ($uri !~ m|^adm/includes|)) ||
3493: ($uri =~ m|/$|) || ($uri =~ m|/.meta$|)) {
3494: return '';
3495: }
3496: my $filename=$uri;
3497: $uri=~s/\.meta$//;
3498: #
3499: # Is the metadata already cached?
3500: # Look at timestamp of caching
3501: # Everything is cached by the main uri, libraries are never directly cached
3502: #
3503: unless (abs($metacache{$uri.':cachedtimestamp'}-time)<600 && !defined($liburi)) {
3504: #
3505: # Is this a recursive call for a library?
3506: #
3507: if ($liburi) {
3508: $liburi=&declutter($liburi);
3509: $filename=$liburi;
3510: } else {
3511: delete($metacache{$uri.':packages'});
3512: }
3513: my %metathesekeys=();
3514: unless ($filename=~/\.meta$/) { $filename.='.meta'; }
3515: my $metastring=&getfile(&filelocation('',&clutter($filename)));
3516: my $parser=HTML::LCParser->new(\$metastring);
3517: my $token;
3518: undef %metathesekeys;
3519: while ($token=$parser->get_token) {
3520: if ($token->[0] eq 'S') {
3521: if (defined($token->[2]->{'package'})) {
3522: #
3523: # This is a package - get package info
3524: #
3525: my $package=$token->[2]->{'package'};
3526: my $keyroot=&add_prefix_and_part($prefix,$token->[2]->{'part'});
3527: if (defined($token->[2]->{'id'})) {
3528: $keyroot.='_'.$token->[2]->{'id'};
3529: }
3530: if ($metacache{$uri.':packages'}) {
3531: $metacache{$uri.':packages'}.=','.$package.$keyroot;
3532: } else {
3533: $metacache{$uri.':packages'}=$package.$keyroot;
3534: }
3535: foreach (keys %packagetab) {
3536: if ($_=~/^$package\&/) {
3537: my ($pack,$name,$subp)=split(/\&/,$_);
3538: # ignore package.tab specified default values
3539: # here &package_tab_default() will fetch those
3540: if ($subp eq 'default') { next; }
3541: my $value=$packagetab{$_};
3542: my $part=$keyroot;
3543: $part=~s/^\_//;
3544: if ($subp eq 'display') {
3545: $value.=' [Part: '.$part.']';
3546: }
3547: my $unikey='parameter'.$keyroot.'_'.$name;
3548: $metacache{$uri.':'.$unikey.'.part'}=$part;
3549: $metathesekeys{$unikey}=1;
3550: unless (defined($metacache{$uri.':'.$unikey.'.'.$subp})) {
3551: $metacache{$uri.':'.$unikey.'.'.$subp}=$value;
3552: }
3553: if (defined($metacache{$uri.':'.$unikey.'.default'})) {
3554: $metacache{$uri.':'.$unikey}=
3555: $metacache{$uri.':'.$unikey.'.default'};
3556: }
3557: }
3558: }
3559: } else {
3560: #
3561: # This is not a package - some other kind of start tag
3562: #
3563: my $entry=$token->[1];
3564: my $unikey;
3565: if ($entry eq 'import') {
3566: $unikey='';
3567: } else {
3568: $unikey=$entry;
3569: }
3570: $unikey.=&add_prefix_and_part($prefix,$token->[2]->{'part'});
3571:
3572: if (defined($token->[2]->{'id'})) {
3573: $unikey.='_'.$token->[2]->{'id'};
3574: }
3575:
3576: if ($entry eq 'import') {
3577: #
3578: # Importing a library here
3579: #
3580: if ($depthcount<20) {
3581: my $location=$parser->get_text('/import');
3582: my $dir=$filename;
3583: $dir=~s|[^/]*$||;
3584: $location=&filelocation($dir,$location);
3585: foreach (sort(split(/\,/,&metadata($uri,'keys',
3586: $location,$unikey,
3587: $depthcount+1)))) {
3588: $metathesekeys{$_}=1;
3589: }
3590: }
3591: } else {
3592:
3593: if (defined($token->[2]->{'name'})) {
3594: $unikey.='_'.$token->[2]->{'name'};
3595: }
3596: $metathesekeys{$unikey}=1;
3597: foreach (@{$token->[3]}) {
3598: $metacache{$uri.':'.$unikey.'.'.$_}=$token->[2]->{$_};
3599: }
3600: my $internaltext=&HTML::Entities::decode($parser->get_text('/'.$entry));
3601: my $default=$metacache{$uri.':'.$unikey.'.default'};
3602: if ( $internaltext =~ /^\s*$/ && $default !~ /^\s*$/) {
3603: # only ws inside the tag, and not in default, so use default
3604: # as value
3605: $metacache{$uri.':'.$unikey}=$default;
3606: } else {
3607: # either something interesting inside the tag or default
3608: # uninteresting
3609: $metacache{$uri.':'.$unikey}=$internaltext;
3610: }
3611: # end of not-a-package not-a-library import
3612: }
3613: # end of not-a-package start tag
3614: }
3615: # the next is the end of "start tag"
3616: }
3617: }
3618: # are there custom rights to evaluate
3619: if ($metacache{$uri.':copyright'} eq 'custom') {
3620:
3621: #
3622: # Importing a rights file here
3623: #
3624: unless ($depthcount) {
3625: my $location=$metacache{$uri.':customdistributionfile'};
3626: my $dir=$filename;
3627: $dir=~s|[^/]*$||;
3628: $location=&filelocation($dir,$location);
3629: foreach (sort(split(/\,/,&metadata($uri,'keys',
3630: $location,'_rights',
3631: $depthcount+1)))) {
3632: $metathesekeys{$_}=1;
3633: }
3634: }
3635: }
3636: $metacache{$uri.':keys'}=join(',',keys %metathesekeys);
3637: &metadata_generate_part0(\%metathesekeys,\%metacache,$uri);
3638: $metacache{$uri.':allpossiblekeys'}=join(',',keys %metathesekeys);
3639: $metacache{$uri.':cachedtimestamp'}=time;
3640: # this is the end of "was not already recently cached
3641: }
3642: return $metacache{$uri.':'.$what};
3643: }
3644:
3645: sub metadata_generate_part0 {
3646: my ($metadata,$metacache,$uri) = @_;
3647: my %allnames;
3648: foreach my $metakey (sort keys %$metadata) {
3649: if ($metakey=~/^parameter\_(.*)/) {
3650: my $part=$$metacache{$uri.':'.$metakey.'.part'};
3651: my $name=$$metacache{$uri.':'.$metakey.'.name'};
3652: if (! exists($$metadata{'parameter_0_'.$name.'.name'})) {
3653: $allnames{$name}=$part;
3654: }
3655: }
3656: }
3657: foreach my $name (keys(%allnames)) {
3658: $$metadata{"parameter_0_$name"}=1;
3659: my $key="$uri:parameter_0_$name";
3660: $$metacache{"$key.part"}='0';
3661: $$metacache{"$key.name"}=$name;
3662: $$metacache{"$key.type"}=$$metacache{$uri.':parameter_'.
3663: $allnames{$name}.'_'.$name.
3664: '.type'};
3665: my $olddis=$$metacache{$uri.':parameter_'.$allnames{$name}.'_'.$name.
3666: '.display'};
3667: my $expr='\\[Part: '.$allnames{$name}.'\\]';
3668: $olddis=~s/$expr/\[Part: 0\]/;
3669: $$metacache{"$key.display"}=$olddis;
3670: }
3671: }
3672:
3673: # ------------------------------------------------- Get the title of a resource
3674:
3675: sub gettitle {
3676: my $urlsymb=shift;
3677: my $symb=&symbread($urlsymb);
3678: unless ($symb) {
3679: unless ($urlsymb) { $urlsymb=$ENV{'request.filename'}; }
3680: return &metadata($urlsymb,'title');
3681: }
3682: if ($titlecache{$symb}) {
3683: if (time < ($titlecache{$symb}[1] + 600)) {
3684: return $titlecache{$symb}[0];
3685: } else {
3686: delete($titlecache{$symb});
3687: }
3688: }
3689: my ($map,$resid,$url)=split(/\_\_\_/,$symb);
3690: my $title='';
3691: my %bighash;
3692: if (tie(%bighash,'GDBM_File',$ENV{'request.course.fn'}.'.db',
3693: &GDBM_READER(),0640)) {
3694: my $mapid=$bighash{'map_pc_'.&clutter($map)};
3695: $title=$bighash{'title_'.$mapid.'.'.$resid};
3696: untie %bighash;
3697: }
3698: $title=~s/\&colon\;/\:/gs;
3699: if ($title) {
3700: $titlecache{$symb}=[$title,time];
3701: return $title;
3702: } else {
3703: return &metadata($urlsymb,'title');
3704: }
3705: }
3706:
3707: # ------------------------------------------------- Update symbolic store links
3708:
3709: sub symblist {
3710: my ($mapname,%newhash)=@_;
3711: $mapname=declutter($mapname);
3712: my %hash;
3713: if (($ENV{'request.course.fn'}) && (%newhash)) {
3714: if (tie(%hash,'GDBM_File',$ENV{'request.course.fn'}.'_symb.db',
3715: &GDBM_WRCREAT(),0640)) {
3716: foreach (keys %newhash) {
3717: $hash{declutter($_)}=$mapname.'___'.$newhash{$_};
3718: }
3719: if (untie(%hash)) {
3720: return 'ok';
3721: }
3722: }
3723: }
3724: return 'error';
3725: }
3726:
3727: # --------------------------------------------------------------- Verify a symb
3728:
3729: sub symbverify {
3730: my ($symb,$thisfn)=@_;
3731: $thisfn=&declutter($thisfn);
3732: # direct jump to resource in page or to a sequence - will construct own symbs
3733: if ($thisfn=~/\.(page|sequence)$/) { return 1; }
3734: # check URL part
3735: my ($map,$resid,$url)=split(/\_\_\_/,$symb);
3736: unless (&symbclean($url) eq &symbclean($thisfn)) { return 0; }
3737:
3738: $symb=&symbclean($symb);
3739:
3740: my %bighash;
3741: my $okay=0;
3742: if (tie(%bighash,'GDBM_File',$ENV{'request.course.fn'}.'.db',
3743: &GDBM_READER(),0640)) {
3744: my $ids=$bighash{'ids_'.&clutter($thisfn)};
3745: unless ($ids) {
3746: $ids=$bighash{'ids_/'.$thisfn};
3747: }
3748: if ($ids) {
3749: # ------------------------------------------------------------------- Has ID(s)
3750: foreach (split(/\,/,$ids)) {
3751: my ($mapid,$resid)=split(/\./,$_);
3752: if (
3753: &symbclean(&declutter($bighash{'map_id_'.$mapid}).'___'.$resid.'___'.$thisfn)
3754: eq $symb) {
3755: $okay=1;
3756: }
3757: }
3758: }
3759: untie(%bighash);
3760: }
3761: return $okay;
3762: }
3763:
3764: # --------------------------------------------------------------- Clean-up symb
3765:
3766: sub symbclean {
3767: my $symb=shift;
3768:
3769: # remove version from map
3770: $symb=~s/\.(\d+)\.(\w+)\_\_\_/\.$2\_\_\_/;
3771:
3772: # remove version from URL
3773: $symb=~s/\.(\d+)\.(\w+)$/\.$2/;
3774:
3775: return $symb;
3776: }
3777:
3778: # ------------------------------------------------------ Return symb list entry
3779:
3780: sub symbread {
3781: my ($thisfn,$donotrecurse)=@_;
3782: # no filename provided? try from environment
3783: unless ($thisfn) {
3784: if ($ENV{'request.symb'}) { return &symbclean($ENV{'request.symb'}); }
3785: $thisfn=$ENV{'request.filename'};
3786: }
3787: # is that filename actually a symb? Verify, clean, and return
3788: if ($thisfn=~/\_\_\_\d+\_\_\_(.*)$/) {
3789: if (&symbverify($thisfn,$1)) { return &symbclean($thisfn); }
3790: }
3791: $thisfn=declutter($thisfn);
3792: my %hash;
3793: my %bighash;
3794: my $syval='';
3795: if (($ENV{'request.course.fn'}) && ($thisfn)) {
3796: if (tie(%hash,'GDBM_File',$ENV{'request.course.fn'}.'_symb.db',
3797: &GDBM_READER(),0640)) {
3798: $syval=$hash{$thisfn};
3799: untie(%hash);
3800: }
3801: # ---------------------------------------------------------- There was an entry
3802: if ($syval) {
3803: unless ($syval=~/\_\d+$/) {
3804: unless ($ENV{'form.request.prefix'}=~/\.(\d+)\_$/) {
3805: &appenv('request.ambiguous' => $thisfn);
3806: return '';
3807: }
3808: $syval.=$1;
3809: }
3810: } else {
3811: # ------------------------------------------------------- Was not in symb table
3812: if (tie(%bighash,'GDBM_File',$ENV{'request.course.fn'}.'.db',
3813: &GDBM_READER(),0640)) {
3814: # ---------------------------------------------- Get ID(s) for current resource
3815: my $ids=$bighash{'ids_'.&clutter($thisfn)};
3816: unless ($ids) {
3817: $ids=$bighash{'ids_/'.$thisfn};
3818: }
3819: unless ($ids) {
3820: # alias?
3821: $ids=$bighash{'mapalias_'.$thisfn};
3822: }
3823: if ($ids) {
3824: # ------------------------------------------------------------------- Has ID(s)
3825: my @possibilities=split(/\,/,$ids);
3826: if ($#possibilities==0) {
3827: # ----------------------------------------------- There is only one possibility
3828: my ($mapid,$resid)=split(/\./,$ids);
3829: $syval=declutter($bighash{'map_id_'.$mapid}).'___'.$resid;
3830: } elsif (!$donotrecurse) {
3831: # ------------------------------------------ There is more than one possibility
3832: my $realpossible=0;
3833: foreach (@possibilities) {
3834: my $file=$bighash{'src_'.$_};
3835: if (&allowed('bre',$file)) {
3836: my ($mapid,$resid)=split(/\./,$_);
3837: if ($bighash{'map_type_'.$mapid} ne 'page') {
3838: $realpossible++;
3839: $syval=declutter($bighash{'map_id_'.$mapid}).
3840: '___'.$resid;
3841: }
3842: }
3843: }
3844: if ($realpossible!=1) { $syval=''; }
3845: } else {
3846: $syval='';
3847: }
3848: }
3849: untie(%bighash)
3850: }
3851: }
3852: if ($syval) {
3853: return &symbclean($syval.'___'.$thisfn);
3854: }
3855: }
3856: &appenv('request.ambiguous' => $thisfn);
3857: return '';
3858: }
3859:
3860: # ---------------------------------------------------------- Return random seed
3861:
3862: sub numval {
3863: my $txt=shift;
3864: $txt=~tr/A-J/0-9/;
3865: $txt=~tr/a-j/0-9/;
3866: $txt=~tr/K-T/0-9/;
3867: $txt=~tr/k-t/0-9/;
3868: $txt=~tr/U-Z/0-5/;
3869: $txt=~tr/u-z/0-5/;
3870: $txt=~s/\D//g;
3871: return int($txt);
3872: }
3873:
3874: sub latest_rnd_algorithm_id {
3875: return '64bit';
3876: }
3877:
3878: sub rndseed {
3879: my ($symb,$courseid,$domain,$username)=@_;
3880:
3881: my ($wsymb,$wcourseid,$wdomain,$wusername)=&Apache::lonxml::whichuser();
3882: if (!$symb) {
3883: unless ($symb=$wsymb) { return time; }
3884: }
3885: if (!$courseid) { $courseid=$wcourseid; }
3886: if (!$domain) { $domain=$wdomain; }
3887: if (!$username) { $username=$wusername }
3888: my $which=$ENV{"course.$courseid.rndseed"};
3889: my $CODE=$ENV{'scantron.CODE'};
3890: if (defined($CODE)) {
3891: &rndseed_CODE_64bit($symb,$courseid,$domain,$username);
3892: } elsif ($which eq '64bit') {
3893: return &rndseed_64bit($symb,$courseid,$domain,$username);
3894: }
3895: return &rndseed_32bit($symb,$courseid,$domain,$username);
3896: }
3897:
3898: sub rndseed_32bit {
3899: my ($symb,$courseid,$domain,$username)=@_;
3900: {
3901: use integer;
3902: my $symbchck=unpack("%32C*",$symb) << 27;
3903: my $symbseed=numval($symb) << 22;
3904: my $namechck=unpack("%32C*",$username) << 17;
3905: my $nameseed=numval($username) << 12;
3906: my $domainseed=unpack("%32C*",$domain) << 7;
3907: my $courseseed=unpack("%32C*",$courseid);
3908: my $num=$symbseed+$nameseed+$domainseed+$courseseed+$namechck+$symbchck;
3909: #&Apache::lonxml::debug("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
3910: #&Apache::lonxml::debug("rndseed :$num:$symb");
3911: return $num;
3912: }
3913: }
3914:
3915: sub rndseed_64bit {
3916: my ($symb,$courseid,$domain,$username)=@_;
3917: {
3918: use integer;
3919: my $symbchck=unpack("%32S*",$symb) << 21;
3920: my $symbseed=numval($symb) << 10;
3921: my $namechck=unpack("%32S*",$username);
3922:
3923: my $nameseed=numval($username) << 21;
3924: my $domainseed=unpack("%32S*",$domain) << 10;
3925: my $courseseed=unpack("%32S*",$courseid);
3926:
3927: my $num1=$symbchck+$symbseed+$namechck;
3928: my $num2=$nameseed+$domainseed+$courseseed;
3929: #&Apache::lonxml::debug("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
3930: #&Apache::lonxml::debug("rndseed :$num:$symb");
3931: return "$num1,$num2";
3932: }
3933: }
3934:
3935: sub rndseed_CODE_64bit {
3936: my ($symb,$courseid,$domain,$username)=@_;
3937: {
3938: use integer;
3939: my $symbchck=unpack("%32S*",$symb) << 16;
3940: my $symbseed=numval($symb);
3941: my $CODEseed=numval($ENV{'scantron.CODE'}) << 16;
3942: my $courseseed=unpack("%32S*",$courseid);
3943: my $num1=$symbseed+$CODEseed;
3944: my $num2=$courseseed+$symbchck;
3945: #&Apache::lonxml::debug("$symbseed:$CODEseed|$courseseed:$symbchck");
3946: #&Apache::lonxml::debug("rndseed :$num1:$num2:$symb");
3947: return "$num1,$num2";
3948: }
3949: }
3950:
3951: sub setup_random_from_rndseed {
3952: my ($rndseed)=@_;
3953: if ($rndseed =~/,/) {
3954: my ($num1,$num2)=split(/,/,$rndseed);
3955: &Math::Random::random_set_seed(abs($num1),abs($num2));
3956: } else {
3957: &Math::Random::random_set_seed_from_phrase($rndseed);
3958: }
3959: }
3960:
3961: sub ireceipt {
3962: my ($funame,$fudom,$fucourseid,$fusymb)=@_;
3963: my $cuname=unpack("%32C*",$funame);
3964: my $cudom=unpack("%32C*",$fudom);
3965: my $cucourseid=unpack("%32C*",$fucourseid);
3966: my $cusymb=unpack("%32C*",$fusymb);
3967: my $cunique=unpack("%32C*",$perlvar{'lonReceipt'});
3968: return unpack("%32C*",$perlvar{'lonHostID'}).'-'.
3969: ($cunique%$cuname+
3970: $cunique%$cudom+
3971: $cusymb%$cuname+
3972: $cusymb%$cudom+
3973: $cucourseid%$cuname+
3974: $cucourseid%$cudom);
3975: }
3976:
3977: sub receipt {
3978: my ($symb,$courseid,$domain,$name) = &Apache::lonxml::whichuser();
3979: return &ireceipt($name,$domain,$courseid,$symb);
3980: }
3981:
3982: # ------------------------------------------------------------ Serves up a file
3983: # returns either the contents of the file or a -1
3984: sub getfile {
3985: my $file=shift;
3986: if ($file=~/^\/*uploaded\//) { # user file
3987: my $ua=new LWP::UserAgent;
3988: my $request=new HTTP::Request('GET',&tokenwrapper($file));
3989: my $response=$ua->request($request);
3990: if ($response->is_success()) {
3991: return $response->content;
3992: } else {
3993: return -1;
3994: }
3995: } else { # normal file from res space
3996: &repcopy($file);
3997: if (! -e $file ) { return -1; };
3998: my $fh=Apache::File->new($file);
3999: my $a='';
4000: while (<$fh>) { $a .=$_; }
4001: return $a;
4002: }
4003: }
4004:
4005: sub filelocation {
4006: my ($dir,$file) = @_;
4007: my $location;
4008: $file=~ s/^\s*(\S+)\s*$/$1/; ## strip off leading and trailing spaces
4009: if ($file=~m:^/~:) { # is a contruction space reference
4010: $location = $file;
4011: $location =~ s:/~(.*?)/(.*):/home/$1/public_html/$2:;
4012: } elsif ($file=~/^\/*uploaded/) { # is an uploaded file
4013: $location=$file;
4014: } else {
4015: $file=~s/^$perlvar{'lonDocRoot'}//;
4016: $file=~s:^/*res::;
4017: if ( !( $file =~ m:^/:) ) {
4018: $location = $dir. '/'.$file;
4019: } else {
4020: $location = '/home/httpd/html/res'.$file;
4021: }
4022: }
4023: $location=~s://+:/:g; # remove duplicate /
4024: while ($location=~m:/\.\./:) {$location=~ s:/[^/]+/\.\./:/:g;} #remove dir/..
4025: return $location;
4026: }
4027:
4028: sub hreflocation {
4029: my ($dir,$file)=@_;
4030: unless (($file=~/^http:\/\//i) || ($file=~/^\//)) {
4031: my $finalpath=filelocation($dir,$file);
4032: $finalpath=~s/^\/home\/httpd\/html//;
4033: $finalpath=~s-/home/(\w+)/public_html/-/~$1/-;
4034: return $finalpath;
4035: } else {
4036: return $file;
4037: }
4038: }
4039:
4040: # ------------------------------------------------------------- Declutters URLs
4041:
4042: sub declutter {
4043: my $thisfn=shift;
4044: $thisfn=~s/^$perlvar{'lonDocRoot'}//;
4045: $thisfn=~s/^\///;
4046: $thisfn=~s/^res\///;
4047: $thisfn=~s/\?.+$//;
4048: return $thisfn;
4049: }
4050:
4051: # ------------------------------------------------------------- Clutter up URLs
4052:
4053: sub clutter {
4054: my $thisfn='/'.&declutter(shift);
4055: unless ($thisfn=~/^\/(uploaded|adm|userfiles|ext|raw|priv)\//) {
4056: $thisfn='/res'.$thisfn;
4057: }
4058: return $thisfn;
4059: }
4060:
4061: # -------------------------------------------------------- Escape Special Chars
4062:
4063: sub escape {
4064: my $str=shift;
4065: $str =~ s/(\W)/"%".unpack('H2',$1)/eg;
4066: return $str;
4067: }
4068:
4069: # ----------------------------------------------------- Un-Escape Special Chars
4070:
4071: sub unescape {
4072: my $str=shift;
4073: $str =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
4074: return $str;
4075: }
4076:
4077: # ================================================================ Main Program
4078:
4079: sub goodbye {
4080: &logthis("Starting Shut down");
4081: &flushcourselogs();
4082: &logthis("Shutting down");
4083: return DONE;
4084: }
4085:
4086: BEGIN {
4087: # ----------------------------------- Read loncapa.conf and loncapa_apache.conf
4088: unless ($readit) {
4089: {
4090: my $config=Apache::File->new("/etc/httpd/conf/loncapa.conf");
4091:
4092: while (my $configline=<$config>) {
4093: if ($configline =~ /^[^\#]*PerlSetVar/) {
4094: my ($dummy,$varname,$varvalue)=split(/\s+/,$configline);
4095: chomp($varvalue);
4096: $perlvar{$varname}=$varvalue;
4097: }
4098: }
4099: }
4100: {
4101: my $config=Apache::File->new("/etc/httpd/conf/loncapa_apache.conf");
4102:
4103: while (my $configline=<$config>) {
4104: if ($configline =~ /^[^\#]*PerlSetVar/) {
4105: my ($dummy,$varname,$varvalue)=split(/\s+/,$configline);
4106: chomp($varvalue);
4107: $perlvar{$varname}=$varvalue;
4108: }
4109: }
4110: }
4111:
4112: # ------------------------------------------------------------ Read domain file
4113: {
4114: my $fh=Apache::File->new($Apache::lonnet::perlvar{'lonTabDir'}.
4115: '/domain.tab');
4116: %domaindescription = ();
4117: %domain_auth_def = ();
4118: %domain_auth_arg_def = ();
4119: if ($fh) {
4120: while (<$fh>) {
4121: next if (/^(\#|\s*$)/);
4122: # next if /^\#/;
4123: chomp;
4124: my ($domain, $domain_description, $def_auth, $def_auth_arg)
4125: = split(/:/,$_,4);
4126: $domain_auth_def{$domain}=$def_auth;
4127: $domain_auth_arg_def{$domain}=$def_auth_arg;
4128: $domaindescription{$domain}=$domain_description;
4129: # &logthis("Domain.tab: $domain, $domain_auth_def{$domain}, $domain_auth_arg_def{$domain},$domaindescription{$domain}");
4130: # &logthis("Domain.tab: $domain ".$domaindescription{$domain} );
4131: }
4132: }
4133: }
4134:
4135:
4136: # ------------------------------------------------------------- Read hosts file
4137: {
4138: my $config=Apache::File->new("$perlvar{'lonTabDir'}/hosts.tab");
4139:
4140: while (my $configline=<$config>) {
4141: next if ($configline =~ /^(\#|\s*$)/);
4142: chomp($configline);
4143: my ($id,$domain,$role,$name,$ip,$domdescr)=split(/:/,$configline);
4144: if ($id && $domain && $role && $name && $ip) {
4145: $hostname{$id}=$name;
4146: $hostdom{$id}=$domain;
4147: $hostip{$id}=$ip;
4148: $iphost{$ip}=$id;
4149: if ($role eq 'library') { $libserv{$id}=$name; }
4150: } else {
4151: if ($configline) {
4152: &logthis("Skipping hosts.tab line -$configline-");
4153: }
4154: }
4155: }
4156: }
4157:
4158: # ------------------------------------------------------ Read spare server file
4159: {
4160: my $config=Apache::File->new("$perlvar{'lonTabDir'}/spare.tab");
4161:
4162: while (my $configline=<$config>) {
4163: chomp($configline);
4164: if ($configline) {
4165: $spareid{$configline}=1;
4166: }
4167: }
4168: }
4169: # ------------------------------------------------------------ Read permissions
4170: {
4171: my $config=Apache::File->new("$perlvar{'lonTabDir'}/roles.tab");
4172:
4173: while (my $configline=<$config>) {
4174: chomp($configline);
4175: if ($configline) {
4176: my ($role,$perm)=split(/ /,$configline);
4177: if ($perm ne '') { $pr{$role}=$perm; }
4178: }
4179: }
4180: }
4181:
4182: # -------------------------------------------- Read plain texts for permissions
4183: {
4184: my $config=Apache::File->new("$perlvar{'lonTabDir'}/rolesplain.tab");
4185:
4186: while (my $configline=<$config>) {
4187: chomp($configline);
4188: if ($configline) {
4189: my ($short,$plain)=split(/:/,$configline);
4190: if ($plain ne '') { $prp{$short}=$plain; }
4191: }
4192: }
4193: }
4194:
4195: # ---------------------------------------------------------- Read package table
4196: {
4197: my $config=Apache::File->new("$perlvar{'lonTabDir'}/packages.tab");
4198:
4199: while (my $configline=<$config>) {
4200: chomp($configline);
4201: my ($short,$plain)=split(/:/,$configline);
4202: my ($pack,$name)=split(/\&/,$short);
4203: if ($plain ne '') {
4204: $packagetab{$pack.'&'.$name.'&name'}=$name;
4205: $packagetab{$short}=$plain;
4206: }
4207: }
4208: }
4209:
4210: # ------------- set up temporary directory
4211: {
4212: $tmpdir = $perlvar{'lonDaemons'}.'/tmp/';
4213:
4214: }
4215:
4216: %metacache=();
4217:
4218: $processmarker='_'.time.'_'.$perlvar{'lonHostID'};
4219: $dumpcount=0;
4220:
4221: &logtouch();
4222: &logthis('<font color=yellow>INFO: Read configuration</font>');
4223: $readit=1;
4224: }
4225: }
4226:
4227: 1;
4228: __END__
4229:
4230: =pod
4231:
4232: =head1 NAME
4233:
4234: Apache::lonnet - Subroutines to ask questions about things in the network.
4235:
4236: =head1 SYNOPSIS
4237:
4238: Invoked by other LON-CAPA modules, when they need to talk to or about objects in the network.
4239:
4240: &Apache::lonnet::SUBROUTINENAME(ARGUMENTS);
4241:
4242: Common parameters:
4243:
4244: =over 4
4245:
4246: =item *
4247:
4248: $uname : an internal username (if $cname expecting a course Id specifically)
4249:
4250: =item *
4251:
4252: $udom : a domain (if $cdom expecting a course's domain specifically)
4253:
4254: =item *
4255:
4256: $symb : a resource instance identifier
4257:
4258: =item *
4259:
4260: $namespace : the name of a .db file that contains the data needed or
4261: being set.
4262:
4263: =back
4264:
4265: =head1 OVERVIEW
4266:
4267: lonnet provides subroutines which interact with the
4268: lonc/lond (TCP) network layer of LON-CAPA. They can be used to ask
4269: about classes, users, and resources.
4270:
4271: For many of these objects you can also use this to store data about
4272: them or modify them in various ways.
4273:
4274: =head2 Symbs
4275:
4276: To identify a specific instance of a resource, LON-CAPA uses symbols
4277: or "symbs"X<symb>. These identifiers are built from the URL of the
4278: map, the resource number of the resource in the map, and the URL of
4279: the resource itself. The latter is somewhat redundant, but might help
4280: if maps change.
4281:
4282: An example is
4283:
4284: msu/korte/parts/part1.sequence___19___msu/korte/tests/part12.problem
4285:
4286: The respective map entry is
4287:
4288: <resource id="19" src="/res/msu/korte/tests/part12.problem"
4289: title="Problem 2">
4290: </resource>
4291:
4292: Symbs are used by the random number generator, as well as to store and
4293: restore data specific to a certain instance of for example a problem.
4294:
4295: =head2 Storing And Retrieving Data
4296:
4297: X<store()>X<cstore()>X<restore()>Three of the most important functions
4298: in C<lonnet.pm> are C<&Apache::lonnet::cstore()>,
4299: C<&Apache::lonnet:restore()>, and C<&Apache::lonnet::store()>, which
4300: is is the non-critical message twin of cstore. These functions are for
4301: handlers to store a perl hash to a user's permanent data space in an
4302: easy manner, and to retrieve it again on another call. It is expected
4303: that a handler would use this once at the beginning to retrieve data,
4304: and then again once at the end to send only the new data back.
4305:
4306: The data is stored in the user's data directory on the user's
4307: homeserver under the ID of the course.
4308:
4309: The hash that is returned by restore will have all of the previous
4310: value for all of the elements of the hash.
4311:
4312: Example:
4313:
4314: #creating a hash
4315: my %hash;
4316: $hash{'foo'}='bar';
4317:
4318: #storing it
4319: &Apache::lonnet::cstore(\%hash);
4320:
4321: #changing a value
4322: $hash{'foo'}='notbar';
4323:
4324: #adding a new value
4325: $hash{'bar'}='foo';
4326: &Apache::lonnet::cstore(\%hash);
4327:
4328: #retrieving the hash
4329: my %history=&Apache::lonnet::restore();
4330:
4331: #print the hash
4332: foreach my $key (sort(keys(%history))) {
4333: print("\%history{$key} = $history{$key}");
4334: }
4335:
4336: Will print out:
4337:
4338: %history{1:foo} = bar
4339: %history{1:keys} = foo:timestamp
4340: %history{1:timestamp} = 990455579
4341: %history{2:bar} = foo
4342: %history{2:foo} = notbar
4343: %history{2:keys} = foo:bar:timestamp
4344: %history{2:timestamp} = 990455580
4345: %history{bar} = foo
4346: %history{foo} = notbar
4347: %history{timestamp} = 990455580
4348: %history{version} = 2
4349:
4350: Note that the special hash entries C<keys>, C<version> and
4351: C<timestamp> were added to the hash. C<version> will be equal to the
4352: total number of versions of the data that have been stored. The
4353: C<timestamp> attribute will be the UNIX time the hash was
4354: stored. C<keys> is available in every historical section to list which
4355: keys were added or changed at a specific historical revision of a
4356: hash.
4357:
4358: B<Warning>: do not store the hash that restore returns directly. This
4359: will cause a mess since it will restore the historical keys as if the
4360: were new keys. I.E. 1:foo will become 1:1:foo etc.
4361:
4362: Calling convention:
4363:
4364: my %record=&Apache::lonnet::restore($symb,$courseid,$domain,$uname,$home);
4365: &Apache::lonnet::cstore(\%newrecord,$symb,$courseid,$domain,$uname,$home);
4366:
4367: For more detailed information, see lonnet specific documentation.
4368:
4369: =head1 RETURN MESSAGES
4370:
4371: =over 4
4372:
4373: =item * B<con_lost>: unable to contact remote host
4374:
4375: =item * B<con_delayed>: unable to contact remote host, message will be delivered
4376: when the connection is brought back up
4377:
4378: =item * B<con_failed>: unable to contact remote host and unable to save message
4379: for later delivery
4380:
4381: =item * B<error:>: an error a occured, a description of the error follows the :
4382:
4383: =item * B<no_such_host>: unable to fund a host associated with the user/domain
4384: that was requested
4385:
4386: =back
4387:
4388: =head1 PUBLIC SUBROUTINES
4389:
4390: =head2 Session Environment Functions
4391:
4392: =over 4
4393:
4394: =item *
4395: X<appenv()>
4396: B<appenv(%hash)>: the value of %hash is written to
4397: the user envirnoment file, and will be restored for each access this
4398: user makes during this session, also modifies the %ENV for the current
4399: process
4400:
4401: =item *
4402: X<delenv()>
4403: B<delenv($regexp)>: removes all items from the session
4404: environment file that matches the regular expression in $regexp. The
4405: values are also delted from the current processes %ENV.
4406:
4407: =back
4408:
4409: =head2 User Information
4410:
4411: =over 4
4412:
4413: =item *
4414: X<queryauthenticate()>
4415: B<queryauthenticate($uname,$udom)>: try to determine user's current
4416: authentication scheme
4417:
4418: =item *
4419: X<authenticate()>
4420: B<authenticate($uname,$upass,$udom)>: try to
4421: authenticate user from domain's lib servers (first use the current
4422: one). C<$upass> should be the users password.
4423:
4424: =item *
4425: X<homeserver()>
4426: B<homeserver($uname,$udom)>: find the server which has
4427: the user's directory and files (there must be only one), this caches
4428: the answer, and also caches if there is a borken connection.
4429:
4430: =item *
4431: X<idget()>
4432: B<idget($udom,@ids)>: find the usernames behind a list of IDs
4433: (IDs are a unique resource in a domain, there must be only 1 ID per
4434: username, and only 1 username per ID in a specific domain) (returns
4435: hash: id=>name,id=>name)
4436:
4437: =item *
4438: X<idrget()>
4439: B<idrget($udom,@unames)>: find the IDs behind a list of
4440: usernames (returns hash: name=>id,name=>id)
4441:
4442: =item *
4443: X<idput()>
4444: B<idput($udom,%ids)>: store away a list of names and associated IDs
4445:
4446: =item *
4447: X<rolesinit()>
4448: B<rolesinit($udom,$username,$authhost)>: get user privileges
4449:
4450: =item *
4451: X<usection()>
4452: B<usection($udom,$uname,$cname)>: finds the section of student in the
4453: course $cname, return section name/number or '' for "not in course"
4454: and '-1' for "no section"
4455:
4456: =item *
4457: X<userenvironment()>
4458: B<userenvironment($udom,$uname,@what)>: gets the values of the keys
4459: passed in @what from the requested user's environment, returns a hash
4460:
4461: =back
4462:
4463: =head2 User Roles
4464:
4465: =over 4
4466:
4467: =item *
4468:
4469: allowed($priv,$uri) : check for a user privilege; returns codes for allowed
4470: actions
4471: F: full access
4472: U,I,K: authentication modes (cxx only)
4473: '': forbidden
4474: 1: user needs to choose course
4475: 2: browse allowed
4476:
4477: =item *
4478:
4479: definerole($rolename,$sysrole,$domrole,$courole) : define role; define a custom
4480: role rolename set privileges in format of lonTabs/roles.tab for system, domain,
4481: and course level
4482:
4483: =item *
4484:
4485: plaintext($short) : return value in %prp hash (rolesplain.tab); plain text
4486: explanation of a user role term
4487:
4488: =back
4489:
4490: =head2 User Modification
4491:
4492: =over 4
4493:
4494: =item *
4495:
4496: assignrole($udom,$uname,$url,$role,$end,$start) : assign role; give a role to a
4497: user for the level given by URL. Optional start and end dates (leave empty
4498: string or zero for "no date")
4499:
4500: =item *
4501:
4502: changepass($uname,$udom,$currentpass,$newpass,$server) : attempts to
4503: change a users, password, possible return values are: ok,
4504: pwchange_failure, non_authorized, auth_mode_error, unknown_user,
4505: refused
4506:
4507: =item *
4508:
4509: modifyuserauth($udom,$uname,$umode,$upass) : modify user authentication
4510:
4511: =item *
4512:
4513: modifyuser($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene) :
4514: modify user
4515:
4516: =item *
4517:
4518: modifystudent
4519:
4520: modify a students enrollment and identification information.
4521: The course id is resolved based on the current users environment.
4522: This means the envoking user must be a course coordinator or otherwise
4523: associated with a course.
4524:
4525: This call is essentially a wrapper for lonnet::modifyuser and
4526: lonnet::modify_student_enrollment
4527:
4528: Inputs:
4529:
4530: =over 4
4531:
4532: =item B<$udom> Students loncapa domain
4533:
4534: =item B<$uname> Students loncapa login name
4535:
4536: =item B<$uid> Students id/student number
4537:
4538: =item B<$umode> Students authentication mode
4539:
4540: =item B<$upass> Students password
4541:
4542: =item B<$first> Students first name
4543:
4544: =item B<$middle> Students middle name
4545:
4546: =item B<$last> Students last name
4547:
4548: =item B<$gene> Students generation
4549:
4550: =item B<$usec> Students section in course
4551:
4552: =item B<$end> Unix time of the roles expiration
4553:
4554: =item B<$start> Unix time of the roles start date
4555:
4556: =item B<$forceid> If defined, allow $uid to be changed
4557:
4558: =item B<$desiredhome> server to use as home server for student
4559:
4560: =back
4561:
4562: =item *
4563:
4564: modify_student_enrollment
4565:
4566: Change a students enrollment status in a class. The environment variable
4567: 'role.request.course' must be defined for this function to proceed.
4568:
4569: Inputs:
4570:
4571: =over 4
4572:
4573: =item $udom, students domain
4574:
4575: =item $uname, students name
4576:
4577: =item $uid, students user id
4578:
4579: =item $first, students first name
4580:
4581: =item $middle
4582:
4583: =item $last
4584:
4585: =item $gene
4586:
4587: =item $usec
4588:
4589: =item $end
4590:
4591: =item $start
4592:
4593: =back
4594:
4595:
4596: =item *
4597:
4598: assigncustomrole($udom,$uname,$url,$rdom,$rnam,$rolename,$end,$start) : assign
4599: custom role; give a custom role to a user for the level given by URL. Specify
4600: name and domain of role author, and role name
4601:
4602: =item *
4603:
4604: revokerole($udom,$uname,$url,$role) : revoke a role for url
4605:
4606: =item *
4607:
4608: revokecustomrole($udom,$uname,$url,$role) : revoke a custom role
4609:
4610: =back
4611:
4612: =head2 Course Infomation
4613:
4614: =over 4
4615:
4616: =item *
4617:
4618: coursedescription($courseid) : course description
4619:
4620: =item *
4621:
4622: courseresdata($coursenum,$coursedomain,@which) : request for current
4623: parameter setting for a specific course, @what should be a list of
4624: parameters to ask about. This routine caches answers for 5 minutes.
4625:
4626: =back
4627:
4628: =head2 Course Modification
4629:
4630: =over 4
4631:
4632: =item *
4633:
4634: writecoursepref($courseid,%prefs) : write preferences (environment
4635: database) for a course
4636:
4637: =item *
4638:
4639: createcourse($udom,$description,$url) : make/modify course
4640:
4641: =back
4642:
4643: =head2 Resource Subroutines
4644:
4645: =over 4
4646:
4647: =item *
4648:
4649: subscribe($fname) : subscribe to a resource, returns URL if possible (probably should use repcopy instead)
4650:
4651: =item *
4652:
4653: repcopy($filename) : subscribes to the requested file, and attempts to
4654: replicate from the owning library server, Might return
4655: HTTP_SERVICE_UNAVAILABLE, HTTP_NOT_FOUND, FORBIDDEN, OK, or
4656: HTTP_BAD_REQUEST, also attempts to grab the metadata for the
4657: resource. Expects the local filesystem pathname
4658: (/home/httpd/html/res/....)
4659:
4660: =back
4661:
4662: =head2 Resource Information
4663:
4664: =over 4
4665:
4666: =item *
4667:
4668: EXT($varname,$symb,$udom,$uname) : evaluates and returns the value of
4669: a vairety of different possible values, $varname should be a request
4670: string, and the other parameters can be used to specify who and what
4671: one is asking about.
4672:
4673: Possible values for $varname are environment.lastname (or other item
4674: from the envirnment hash), user.name (or someother aspect about the
4675: user), resource.0.maxtries (or some other part and parameter of a
4676: resource)
4677:
4678: =item *
4679:
4680: directcondval($number) : get current value of a condition; reads from a state
4681: string
4682:
4683: =item *
4684:
4685: condval($condidx) : value of condition index based on state
4686:
4687: =item *
4688:
4689: metadata($uri,$what,$liburi,$prefix,$depthcount) : request a
4690: resource's metadata, $what should be either a specific key, or either
4691: 'keys' (to get a list of possible keys) or 'packages' to get a list of
4692: packages that this resource currently uses, the last 3 arguments are only used internally for recursive metadata.
4693:
4694: this function automatically caches all requests
4695:
4696: =item *
4697:
4698: metadata_query($query,$custom,$customshow) : make a metadata query against the
4699: network of library servers; returns file handle of where SQL and regex results
4700: will be stored for query
4701:
4702: =item *
4703:
4704: symbread($filename) : return symbolic list entry (filename argument optional);
4705: returns the data handle
4706:
4707: =item *
4708:
4709: symbverify($symb,$thisfn) : verifies that $symb actually exists and is
4710: a possible symb for the URL in $thisfn, returns a 1 on success, 0 on
4711: failure, user must be in a course, as it assumes the existance of the
4712: course initi hash, and uses $ENV('request.course.id'}
4713:
4714:
4715: =item *
4716:
4717: symbclean($symb) : removes versions numbers from a symb, returns the
4718: cleaned symb
4719:
4720: =item *
4721:
4722: is_on_map($uri) : checks if the $uri is somewhere on the current
4723: course map, user must be in a course for it to work.
4724:
4725: =item *
4726:
4727: numval($salt) : return random seed value (addend for rndseed)
4728:
4729: =item *
4730:
4731: rndseed($symb,$courseid,$udom,$uname) : create a random sum; returns
4732: a random seed, all arguments are optional, if they aren't sent it uses the
4733: environment to derive them. Note: if symb isn't sent and it can't get one
4734: from &symbread it will use the current time as its return value
4735:
4736: =item *
4737:
4738: ireceipt($funame,$fudom,$fucourseid,$fusymb) : return unique,
4739: unfakeable, receipt
4740:
4741: =item *
4742:
4743: receipt() : API to ireceipt working off of ENV values; given out to users
4744:
4745: =item *
4746:
4747: countacc($url) : count the number of accesses to a given URL
4748:
4749: =item *
4750:
4751: checkout($symb,$tuname,$tudom,$tcrsid) : creates a record of a user having looked at an item, most likely printed out or otherwise using a resource
4752:
4753: =item *
4754:
4755: checkin($token) : updates that a resource has beeen returned (a hard copy version for instance) and returns the data that $token was Checkout with ($symb, $tuname, $tudom, and $tcrsid)
4756:
4757: =item *
4758:
4759: expirespread($uname,$udom,$stype,$usymb) : set expire date for spreadsheet
4760:
4761: =item *
4762:
4763: devalidate($symb) : devalidate temporary spreadsheet calculations,
4764: forcing spreadsheet to reevaluate the resource scores next time.
4765:
4766: =back
4767:
4768: =head2 Storing/Retreiving Data
4769:
4770: =over 4
4771:
4772: =item *
4773:
4774: store($storehash,$symb,$namespace,$udom,$uname) : stores hash permanently
4775: for this url; hashref needs to be given and should be a \%hashname; the
4776: remaining args aren't required and if they aren't passed or are '' they will
4777: be derived from the ENV
4778:
4779: =item *
4780:
4781: cstore($storehash,$symb,$namespace,$udom,$uname) : same as store but
4782: uses critical subroutine
4783:
4784: =item *
4785:
4786: restore($symb,$namespace,$udom,$uname) : returns hash for this symb;
4787: all args are optional
4788:
4789: =item *
4790:
4791: tmpstore($storehash,$symb,$namespace,$udom,$uname) : storage that
4792: works very similar to store/cstore, but all data is stored in a
4793: temporary location and can be reset using tmpreset, $storehash should
4794: be a hash reference, returns nothing on success
4795:
4796: =item *
4797:
4798: tmprestore($symb,$namespace,$udom,$uname) : storage that works very
4799: similar to restore, but all data is stored in a temporary location and
4800: can be reset using tmpreset. Returns a hash of values on success,
4801: error string otherwise.
4802:
4803: =item *
4804:
4805: tmpreset($symb,$namespace,$udom,$uname) : temporary storage reset,
4806: deltes all keys for $symb form the temporary storage hash.
4807:
4808: =item *
4809:
4810: get($namespace,$storearr,$udom,$uname) : returns hash with keys from array
4811: reference filled in from namesp ($udom and $uname are optional)
4812:
4813: =item *
4814:
4815: del($namespace,$storearr,$udom,$uname) : deletes keys out of array from
4816: namesp ($udom and $uname are optional)
4817:
4818: =item *
4819:
4820: dump($namespace,$udom,$uname,$regexp) :
4821: dumps the complete (or key matching regexp) namespace into a hash
4822: ($udom, $uname and $regexp are optional)
4823:
4824: =item *
4825:
4826: put($namespace,$storehash,$udom,$uname) : stores hash in namesp
4827: ($udom and $uname are optional)
4828:
4829: =item *
4830:
4831: cput($namespace,$storehash,$udom,$uname) : critical put
4832: ($udom and $uname are optional)
4833:
4834: =item *
4835:
4836: eget($namespace,$storearr,$udom,$uname) : returns hash with keys from array
4837: reference filled in from namesp (encrypts the return communication)
4838: ($udom and $uname are optional)
4839:
4840: =item *
4841:
4842: log($udom,$name,$home,$message) : write to permanent log for user; use
4843: critical subroutine
4844:
4845: =back
4846:
4847: =head2 Network Status Functions
4848:
4849: =over 4
4850:
4851: =item *
4852:
4853: dirlist($uri) : return directory list based on URI
4854:
4855: =item *
4856:
4857: spareserver() : find server with least workload from spare.tab
4858:
4859: =back
4860:
4861: =head2 Apache Request
4862:
4863: =over 4
4864:
4865: =item *
4866:
4867: ssi($url,%hash) : server side include, does a complete request cycle on url to
4868: localhost, posts hash
4869:
4870: =back
4871:
4872: =head2 Data to String to Data
4873:
4874: =over 4
4875:
4876: =item *
4877:
4878: hash2str(%hash) : convert a hash into a string complete with escaping and '='
4879: and '&' separators, supports elements that are arrayrefs and hashrefs
4880:
4881: =item *
4882:
4883: hashref2str($hashref) : convert a hashref into a string complete with
4884: escaping and '=' and '&' separators, supports elements that are
4885: arrayrefs and hashrefs
4886:
4887: =item *
4888:
4889: arrayref2str($arrayref) : convert an arrayref into a string complete
4890: with escaping and '&' separators, supports elements that are arrayrefs
4891: and hashrefs
4892:
4893: =item *
4894:
4895: str2hash($string) : convert string to hash using unescaping and
4896: splitting on '=' and '&', supports elements that are arrayrefs and
4897: hashrefs
4898:
4899: =item *
4900:
4901: str2array($string) : convert string to hash using unescaping and
4902: splitting on '&', supports elements that are arrayrefs and hashrefs
4903:
4904: =back
4905:
4906: =head2 Logging Routines
4907:
4908: =over 4
4909:
4910: These routines allow one to make log messages in the lonnet.log and
4911: lonnet.perm logfiles.
4912:
4913: =item *
4914:
4915: logtouch() : make sure the logfile, lonnet.log, exists
4916:
4917: =item *
4918:
4919: logthis() : append message to the normal lonnet.log file, it gets
4920: preiodically rolled over and deleted.
4921:
4922: =item *
4923:
4924: logperm() : append a permanent message to lonnet.perm.log, this log
4925: file never gets deleted by any automated portion of the system, only
4926: messages of critical importance should go in here.
4927:
4928: =back
4929:
4930: =head2 General File Helper Routines
4931:
4932: =over 4
4933:
4934: =item *
4935:
4936: getfile($file) : returns the entire contents of a file or -1; it
4937: properly subscribes to and replicates the file if neccessary.
4938:
4939: =item *
4940:
4941: filelocation($dir,$file) : returns file system location of a file
4942: based on URI; meant to be "fairly clean" absolute reference, $dir is a
4943: directory that relative $file lookups are to looked in ($dir of /a/dir
4944: and a file of ../bob will become /a/bob)
4945:
4946: =item *
4947:
4948: hreflocation($dir,$file) : returns file system location or a URL; same as
4949: filelocation except for hrefs
4950:
4951: =item *
4952:
4953: declutter() : declutters URLs (remove docroot, beginning slashes, 'res' etc)
4954:
4955: =back
4956:
4957: =head2 HTTP Helper Routines
4958:
4959: =over 4
4960:
4961: =item *
4962:
4963: escape() : unpack non-word characters into CGI-compatible hex codes
4964:
4965: =item *
4966:
4967: unescape() : pack CGI-compatible hex codes into actual non-word ASCII character
4968:
4969: =back
4970:
4971: =head1 PRIVATE SUBROUTINES
4972:
4973: =head2 Underlying communication routines (Shouldn't call)
4974:
4975: =over 4
4976:
4977: =item *
4978:
4979: subreply() : tries to pass a message to lonc, returns con_lost if incapable
4980:
4981: =item *
4982:
4983: reply() : uses subreply to send a message to remote machine, logs all failures
4984:
4985: =item *
4986:
4987: critical() : passes a critical message to another server; if cannot
4988: get through then place message in connection buffer directory and
4989: returns con_delayed, if incapable of saving message, returns
4990: con_failed
4991:
4992: =item *
4993:
4994: reconlonc() : tries to reconnect lonc client processes.
4995:
4996: =back
4997:
4998: =head2 Resource Access Logging
4999:
5000: =over 4
5001:
5002: =item *
5003:
5004: flushcourselogs() : flush (save) buffer logs and access logs
5005:
5006: =item *
5007:
5008: courselog($what) : save message for course in hash
5009:
5010: =item *
5011:
5012: courseacclog($what) : save message for course using &courselog(). Perform
5013: special processing for specific resource types (problems, exams, quizzes, etc).
5014:
5015: =item *
5016:
5017: goodbye() : flush course logs and log shutting down; it is called in srm.conf
5018: as a PerlChildExitHandler
5019:
5020: =back
5021:
5022: =head2 Other
5023:
5024: =over 4
5025:
5026: =item *
5027:
5028: symblist($mapname,%newhash) : update symbolic storage links
5029:
5030: =back
5031:
5032: =cut
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>
![[BACK]](/icons/back.gif){kind=icon}
Return to lonnet.pm CVS log ![[TXT]](/icons/text.gif){kind=icon}
![[DIR]](/icons/dir.gif){kind=icon}
Up to [LON-CAPA] / loncom / lonnet / perl