1: # The LearningOnline Network
2: # TCP networking package
3: #
4: # $Id: lonnet.pm,v 1.277 2002/08/30 20:32:21 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: # 02/27/01 Scott Harrison
51: # 3/2 Gerd Kortemeyer
52: # 3/15,3/19 Scott Harrison
53: # 3/19,3/20 Gerd Kortemeyer
54: # 3/22,3/27,4/2,4/16,4/17 Scott Harrison
55: # 5/26,5/28 Gerd Kortemeyer
56: # 5/30 H. K. Ng
57: # 6/1 Gerd Kortemeyer
58: # July Guy Albertelli
59: # 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,
60: # 10/2 Gerd Kortemeyer
61: # 10/5,10/10,11/13,11/15 Scott Harrison
62: # 11/17,11/20,11/22,11/29 Gerd Kortemeyer
63: # 12/5 Matthew Hall
64: # 12/5 Guy Albertelli
65: # 12/6,12/7,12/12 Gerd Kortemeyer
66: # 12/18 Scott Harrison
67: # 12/21,12/22,12/27,12/28 Gerd Kortemeyer
68: # YEAR=2002
69: # 1/4,2/4,2/7 Gerd Kortemeyer
70: #
71: ###
72:
73: package Apache::lonnet;
74:
75: use strict;
76: use Apache::File;
77: use LWP::UserAgent();
78: use HTTP::Headers;
79: use vars
80: qw(%perlvar %hostname %homecache %badServerCache %hostip %spareid %hostdom
81: %libserv %pr %prp %metacache %packagetab
82: %courselogs %accesshash $processmarker $dumpcount
83: %coursedombuf %coursehombuf %courseresdatacache %domaindescription);
84: use IO::Socket;
85: use GDBM_File;
86: use Apache::Constants qw(:common :http);
87: use HTML::LCParser;
88: use Fcntl qw(:flock);
89: my $readit;
90:
91: # --------------------------------------------------------------------- Logging
92:
93: sub logtouch {
94: my $execdir=$perlvar{'lonDaemons'};
95: unless (-e "$execdir/logs/lonnet.log") {
96: my $fh=Apache::File->new(">>$execdir/logs/lonnet.log");
97: close $fh;
98: }
99: my ($wwwuid,$wwwgid)=(getpwnam('www'))[2,3];
100: chown($wwwuid,$wwwgid,$execdir.'/logs/lonnet.log');
101: }
102:
103: sub logthis {
104: my $message=shift;
105: my $execdir=$perlvar{'lonDaemons'};
106: my $now=time;
107: my $local=localtime($now);
108: my $fh=Apache::File->new(">>$execdir/logs/lonnet.log");
109: print $fh "$local ($$): $message\n";
110: return 1;
111: }
112:
113: sub logperm {
114: my $message=shift;
115: my $execdir=$perlvar{'lonDaemons'};
116: my $now=time;
117: my $local=localtime($now);
118: my $fh=Apache::File->new(">>$execdir/logs/lonnet.perm.log");
119: print $fh "$now:$message:$local\n";
120: return 1;
121: }
122:
123: # -------------------------------------------------- Non-critical communication
124: sub subreply {
125: my ($cmd,$server)=@_;
126: my $peerfile="$perlvar{'lonSockDir'}/$server";
127: my $client=IO::Socket::UNIX->new(Peer =>"$peerfile",
128: Type => SOCK_STREAM,
129: Timeout => 10)
130: or return "con_lost";
131: print $client "$cmd\n";
132: my $answer=<$client>;
133: if (!$answer) { $answer="con_lost"; }
134: chomp($answer);
135: return $answer;
136: }
137:
138: sub reply {
139: my ($cmd,$server)=@_;
140: unless (defined($hostname{$server})) { return 'no_such_host'; }
141: my $answer=subreply($cmd,$server);
142: if ($answer eq 'con_lost') {
143: #sleep 5;
144: #$answer=subreply($cmd,$server);
145: #if ($answer eq 'con_lost') {
146: # &logthis("Second attempt con_lost on $server");
147: # my $peerfile="$perlvar{'lonSockDir'}/$server";
148: # my $client=IO::Socket::UNIX->new(Peer =>"$peerfile",
149: # Type => SOCK_STREAM,
150: # Timeout => 10)
151: # or return "con_lost";
152: # &logthis("Killing socket");
153: # print $client "close_connection_exit\n";
154: #sleep 5;
155: # $answer=subreply($cmd,$server);
156: #}
157: }
158: if (($answer=~/^refused/) || ($answer=~/^rejected/)) {
159: &logthis("<font color=blue>WARNING:".
160: " $cmd to $server returned $answer</font>");
161: }
162: return $answer;
163: }
164:
165: # ----------------------------------------------------------- Send USR1 to lonc
166:
167: sub reconlonc {
168: my $peerfile=shift;
169: &logthis("Trying to reconnect for $peerfile");
170: my $loncfile="$perlvar{'lonDaemons'}/logs/lonc.pid";
171: if (my $fh=Apache::File->new("$loncfile")) {
172: my $loncpid=<$fh>;
173: chomp($loncpid);
174: if (kill 0 => $loncpid) {
175: &logthis("lonc at pid $loncpid responding, sending USR1");
176: kill USR1 => $loncpid;
177: sleep 1;
178: if (-e "$peerfile") { return; }
179: &logthis("$peerfile still not there, give it another try");
180: sleep 5;
181: if (-e "$peerfile") { return; }
182: &logthis(
183: "<font color=blue>WARNING: $peerfile still not there, giving up</font>");
184: } else {
185: &logthis(
186: "<font color=blue>WARNING:".
187: " lonc at pid $loncpid not responding, giving up</font>");
188: }
189: } else {
190: &logthis('<font color=blue>WARNING: lonc not running, giving up</font>');
191: }
192: }
193:
194: # ------------------------------------------------------ Critical communication
195:
196: sub critical {
197: my ($cmd,$server)=@_;
198: unless ($hostname{$server}) {
199: &logthis("<font color=blue>WARNING:".
200: " Critical message to unknown server ($server)</font>");
201: return 'no_such_host';
202: }
203: my $answer=reply($cmd,$server);
204: if ($answer eq 'con_lost') {
205: my $pingreply=reply('ping',$server);
206: &reconlonc("$perlvar{'lonSockDir'}/$server");
207: my $pongreply=reply('pong',$server);
208: &logthis("Ping/Pong for $server: $pingreply/$pongreply");
209: $answer=reply($cmd,$server);
210: if ($answer eq 'con_lost') {
211: my $now=time;
212: my $middlename=$cmd;
213: $middlename=substr($middlename,0,16);
214: $middlename=~s/\W//g;
215: my $dfilename=
216: "$perlvar{'lonSockDir'}/delayed/$now.$middlename.$server";
217: {
218: my $dfh;
219: if ($dfh=Apache::File->new(">$dfilename")) {
220: print $dfh "$cmd\n";
221: }
222: }
223: sleep 2;
224: my $wcmd='';
225: {
226: my $dfh;
227: if ($dfh=Apache::File->new("$dfilename")) {
228: $wcmd=<$dfh>;
229: }
230: }
231: chomp($wcmd);
232: if ($wcmd eq $cmd) {
233: &logthis("<font color=blue>WARNING: ".
234: "Connection buffer $dfilename: $cmd</font>");
235: &logperm("D:$server:$cmd");
236: return 'con_delayed';
237: } else {
238: &logthis("<font color=red>CRITICAL:"
239: ." Critical connection failed: $server $cmd</font>");
240: &logperm("F:$server:$cmd");
241: return 'con_failed';
242: }
243: }
244: }
245: return $answer;
246: }
247:
248: # ---------------------------------------------------------- Append Environment
249:
250: sub appenv {
251: my %newenv=@_;
252: foreach (keys %newenv) {
253: if (($newenv{$_}=~/^user\.role/) || ($newenv{$_}=~/^user\.priv/)) {
254: &logthis("<font color=blue>WARNING: ".
255: "Attempt to modify environment ".$_." to ".$newenv{$_}
256: .'</font>');
257: delete($newenv{$_});
258: } else {
259: $ENV{$_}=$newenv{$_};
260: }
261: }
262:
263: my $lockfh;
264: unless ($lockfh=Apache::File->new("$ENV{'user.environment'}")) {
265: return 'error: '.$!;
266: }
267: unless (flock($lockfh,LOCK_EX)) {
268: &logthis("<font color=blue>WARNING: ".
269: 'Could not obtain exclusive lock in appenv: '.$!);
270: $lockfh->close();
271: return 'error: '.$!;
272: }
273:
274: my @oldenv;
275: {
276: my $fh;
277: unless ($fh=Apache::File->new("$ENV{'user.environment'}")) {
278: return 'error: '.$!;
279: }
280: @oldenv=<$fh>;
281: $fh->close();
282: }
283: for (my $i=0; $i<=$#oldenv; $i++) {
284: chomp($oldenv[$i]);
285: if ($oldenv[$i] ne '') {
286: my ($name,$value)=split(/=/,$oldenv[$i]);
287: unless (defined($newenv{$name})) {
288: $newenv{$name}=$value;
289: }
290: }
291: }
292: {
293: my $fh;
294: unless ($fh=Apache::File->new(">$ENV{'user.environment'}")) {
295: return 'error';
296: }
297: my $newname;
298: foreach $newname (keys %newenv) {
299: print $fh "$newname=$newenv{$newname}\n";
300: }
301: $fh->close();
302: }
303:
304: $lockfh->close();
305: return 'ok';
306: }
307: # ----------------------------------------------------- Delete from Environment
308:
309: sub delenv {
310: my $delthis=shift;
311: my %newenv=();
312: if (($delthis=~/user\.role/) || ($delthis=~/user\.priv/)) {
313: &logthis("<font color=blue>WARNING: ".
314: "Attempt to delete from environment ".$delthis);
315: return 'error';
316: }
317: my @oldenv;
318: {
319: my $fh;
320: unless ($fh=Apache::File->new("$ENV{'user.environment'}")) {
321: return 'error';
322: }
323: unless (flock($fh,LOCK_SH)) {
324: &logthis("<font color=blue>WARNING: ".
325: 'Could not obtain shared lock in delenv: '.$!);
326: $fh->close();
327: return 'error: '.$!;
328: }
329: @oldenv=<$fh>;
330: $fh->close();
331: }
332: {
333: my $fh;
334: unless ($fh=Apache::File->new(">$ENV{'user.environment'}")) {
335: return 'error';
336: }
337: unless (flock($fh,LOCK_EX)) {
338: &logthis("<font color=blue>WARNING: ".
339: 'Could not obtain exclusive lock in delenv: '.$!);
340: $fh->close();
341: return 'error: '.$!;
342: }
343: foreach (@oldenv) {
344: unless ($_=~/^$delthis/) { print $fh $_; }
345: }
346: $fh->close();
347: }
348: return 'ok';
349: }
350:
351: # ------------------------------ Find server with least workload from spare.tab
352:
353: sub spareserver {
354: my $tryserver;
355: my $spareserver='';
356: my $lowestserver=100;
357: foreach $tryserver (keys %spareid) {
358: my $answer=reply('load',$tryserver);
359: if (($answer =~ /\d/) && ($answer<$lowestserver)) {
360: $spareserver="http://$hostname{$tryserver}";
361: $lowestserver=$answer;
362: }
363: }
364: return $spareserver;
365: }
366:
367: # --------------------------------------------- Try to change a user's password
368:
369: sub changepass {
370: my ($uname,$udom,$currentpass,$newpass,$server)=@_;
371: $currentpass = &escape($currentpass);
372: $newpass = &escape($newpass);
373: my $answer = reply("encrypt:passwd:$udom:$uname:$currentpass:$newpass",
374: $server);
375: if (! $answer) {
376: &logthis("No reply on password change request to $server ".
377: "by $uname in domain $udom.");
378: } elsif ($answer =~ "^ok") {
379: &logthis("$uname in $udom successfully changed their password ".
380: "on $server.");
381: } elsif ($answer =~ "^pwchange_failure") {
382: &logthis("$uname in $udom was unable to change their password ".
383: "on $server. The action was blocked by either lcpasswd ".
384: "or pwchange");
385: } elsif ($answer =~ "^non_authorized") {
386: &logthis("$uname in $udom did not get their password correct when ".
387: "attempting to change it on $server.");
388: } elsif ($answer =~ "^auth_mode_error") {
389: &logthis("$uname in $udom attempted to change their password despite ".
390: "not being locally or internally authenticated on $server.");
391: } elsif ($answer =~ "^unknown_user") {
392: &logthis("$uname in $udom attempted to change their password ".
393: "on $server but were unable to because $server is not ".
394: "their home server.");
395: } elsif ($answer =~ "^refused") {
396: &logthis("$server refused to change $uname in $udom password because ".
397: "it was sent an unencrypted request to change the password.");
398: }
399: return $answer;
400: }
401:
402: # ----------------------- Try to determine user's current authentication scheme
403:
404: sub queryauthenticate {
405: my ($uname,$udom)=@_;
406: if (($perlvar{'lonRole'} eq 'library') &&
407: ($udom eq $perlvar{'lonDefDomain'})) {
408: my $answer=reply("encrypt:currentauth:$udom:$uname",
409: $perlvar{'lonHostID'});
410: unless ($answer eq 'unknown_user' or $answer eq 'refused') {
411: if (length($answer)) {
412: return $answer;
413: }
414: else {
415: &logthis("User $uname at $udom lacks an authentication mechanism");
416: return 'no_host';
417: }
418: }
419: }
420:
421: my $tryserver;
422: foreach $tryserver (keys %libserv) {
423: if ($hostdom{$tryserver} eq $udom) {
424: my $answer=reply("encrypt:currentauth:$udom:$uname",$tryserver);
425: unless ($answer eq 'unknown_user' or $answer eq 'refused') {
426: if (length($answer)) {
427: return $answer;
428: }
429: else {
430: &logthis("User $uname at $udom lacks an authentication mechanism");
431: return 'no_host';
432: }
433: }
434: }
435: }
436: &logthis("User $uname at $udom lacks an authentication mechanism");
437: return 'no_host';
438: }
439:
440: # --------- Try to authenticate user from domain's lib servers (first this one)
441:
442: sub authenticate {
443: my ($uname,$upass,$udom)=@_;
444: $upass=escape($upass);
445: $uname=~s/\W//g;
446: if (($perlvar{'lonRole'} eq 'library') &&
447: ($udom eq $perlvar{'lonDefDomain'})) {
448: my $answer=reply("encrypt:auth:$udom:$uname:$upass",$perlvar{'lonHostID'});
449: if ($answer =~ /authorized/) {
450: if ($answer eq 'authorized') {
451: &logthis("User $uname at $udom authorized by local server");
452: return $perlvar{'lonHostID'};
453: }
454: if ($answer eq 'non_authorized') {
455: &logthis("User $uname at $udom rejected by local server");
456: return 'no_host';
457: }
458: }
459: }
460:
461: my $tryserver;
462: foreach $tryserver (keys %libserv) {
463: if ($hostdom{$tryserver} eq $udom) {
464: my $answer=reply("encrypt:auth:$udom:$uname:$upass",$tryserver);
465: if ($answer =~ /authorized/) {
466: if ($answer eq 'authorized') {
467: &logthis("User $uname at $udom authorized by $tryserver");
468: return $tryserver;
469: }
470: if ($answer eq 'non_authorized') {
471: &logthis("User $uname at $udom rejected by $tryserver");
472: return 'no_host';
473: }
474: }
475: }
476: }
477: &logthis("User $uname at $udom could not be authenticated");
478: return 'no_host';
479: }
480:
481: # ---------------------- Find the homebase for a user from domain's lib servers
482:
483: sub homeserver {
484: my ($uname,$udom,$ignoreBadCache)=@_;
485: my $index="$uname:$udom";
486: if ($homecache{$index}) {
487: return "$homecache{$index}";
488: }
489: my $tryserver;
490: foreach $tryserver (keys %libserv) {
491: next if ($ignoreBadCache ne 'true' &&
492: exists($badServerCache{$tryserver}));
493: if ($hostdom{$tryserver} eq $udom) {
494: my $answer=reply("home:$udom:$uname",$tryserver);
495: if ($answer eq 'found') {
496: $homecache{$index}=$tryserver;
497: return $tryserver;
498: } elsif ($answer eq 'no_host') {
499: $badServerCache{$tryserver}=1;
500: }
501: }
502: }
503: return 'no_host';
504: }
505:
506: # ------------------------------------- Find the usernames behind a list of IDs
507:
508: sub idget {
509: my ($udom,@ids)=@_;
510: my %returnhash=();
511:
512: my $tryserver;
513: foreach $tryserver (keys %libserv) {
514: if ($hostdom{$tryserver} eq $udom) {
515: my $idlist=join('&',@ids);
516: $idlist=~tr/A-Z/a-z/;
517: my $reply=&reply("idget:$udom:".$idlist,$tryserver);
518: my @answer=();
519: if (($reply ne 'con_lost') && ($reply!~/^error\:/)) {
520: @answer=split(/\&/,$reply);
521: } ;
522: my $i;
523: for ($i=0;$i<=$#ids;$i++) {
524: if ($answer[$i]) {
525: $returnhash{$ids[$i]}=$answer[$i];
526: }
527: }
528: }
529: }
530: return %returnhash;
531: }
532:
533: # ------------------------------------- Find the IDs behind a list of usernames
534:
535: sub idrget {
536: my ($udom,@unames)=@_;
537: my %returnhash=();
538: foreach (@unames) {
539: $returnhash{$_}=(&userenvironment($udom,$_,'id'))[1];
540: }
541: return %returnhash;
542: }
543:
544: # ------------------------------- Store away a list of names and associated IDs
545:
546: sub idput {
547: my ($udom,%ids)=@_;
548: my %servers=();
549: foreach (keys %ids) {
550: my $uhom=&homeserver($_,$udom);
551: if ($uhom ne 'no_host') {
552: my $id=&escape($ids{$_});
553: $id=~tr/A-Z/a-z/;
554: my $unam=&escape($_);
555: if ($servers{$uhom}) {
556: $servers{$uhom}.='&'.$id.'='.$unam;
557: } else {
558: $servers{$uhom}=$id.'='.$unam;
559: }
560: &critical('put:'.$udom.':'.$unam.':environment:id='.$id,$uhom);
561: }
562: }
563: foreach (keys %servers) {
564: &critical('idput:'.$udom.':'.$servers{$_},$_);
565: }
566: }
567:
568: # ------------------------------------- Find the section of student in a course
569:
570: sub usection {
571: my ($udom,$unam,$courseid)=@_;
572: $courseid=~s/\_/\//g;
573: $courseid=~s/^(\w)/\/$1/;
574: foreach (split(/\&/,&reply('dump:'.$udom.':'.$unam.':roles',
575: &homeserver($unam,$udom)))) {
576: my ($key,$value)=split(/\=/,$_);
577: $key=&unescape($key);
578: if ($key=~/^$courseid(?:\/)*(\w+)*\_st$/) {
579: my $section=$1;
580: if ($key eq $courseid.'_st') { $section=''; }
581: my ($dummy,$end,$start)=split(/\_/,&unescape($value));
582: my $now=time;
583: my $notactive=0;
584: if ($start) {
585: if ($now<$start) { $notactive=1; }
586: }
587: if ($end) {
588: if ($now>$end) { $notactive=1; }
589: }
590: unless ($notactive) { return $section; }
591: }
592: }
593: return '-1';
594: }
595:
596: # ------------------------------------- Read an entry from a user's environment
597:
598: sub userenvironment {
599: my ($udom,$unam,@what)=@_;
600: my %returnhash=();
601: my @answer=split(/\&/,
602: &reply('get:'.$udom.':'.$unam.':environment:'.join('&',@what),
603: &homeserver($unam,$udom)));
604: my $i;
605: for ($i=0;$i<=$#what;$i++) {
606: $returnhash{$what[$i]}=&unescape($answer[$i]);
607: }
608: return %returnhash;
609: }
610:
611: # -------------------------------------------------------------------- New chat
612:
613: sub chatsend {
614: my ($newentry,$anon)=@_;
615: my $cnum=$ENV{'course.'.$ENV{'request.course.id'}.'.num'};
616: my $cdom=$ENV{'course.'.$ENV{'request.course.id'}.'.domain'};
617: my $chome=$ENV{'course.'.$ENV{'request.course.id'}.'.home'};
618: &reply('chatsend:'.$cdom.':'.$cnum.':'.
619: &escape($ENV{'user.domain'}.':'.$ENV{'user.name'}.':'.$anon.':'.
620: &escape($newentry)),$chome);
621: }
622:
623: # ----------------------------- Subscribe to a resource, return URL if possible
624:
625: sub subscribe {
626: my $fname=shift;
627: my $author=$fname;
628: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
629: my ($udom,$uname)=split(/\//,$author);
630: my $home=homeserver($uname,$udom);
631: if (($home eq 'no_host') || ($home eq $perlvar{'lonHostID'})) {
632: return 'not_found';
633: }
634: my $answer=reply("sub:$fname",$home);
635: if (($answer eq 'con_lost') || ($answer eq 'rejected')) {
636: $answer.=' by '.$home;
637: }
638: return $answer;
639: }
640:
641: # -------------------------------------------------------------- Replicate file
642:
643: sub repcopy {
644: my $filename=shift;
645: $filename=~s/\/+/\//g;
646: if ($filename=~/^\/home\/httpd\/html\/adm\//) { return OK; }
647: my $transname="$filename.in.transfer";
648: if ((-e $filename) || (-e $transname)) { return OK; }
649: my $remoteurl=subscribe($filename);
650: if ($remoteurl =~ /^con_lost by/) {
651: &logthis("Subscribe returned $remoteurl: $filename");
652: return HTTP_SERVICE_UNAVAILABLE;
653: } elsif ($remoteurl eq 'not_found') {
654: &logthis("Subscribe returned not_found: $filename");
655: return HTTP_NOT_FOUND;
656: } elsif ($remoteurl =~ /^rejected by/) {
657: &logthis("Subscribe returned $remoteurl: $filename");
658: return FORBIDDEN;
659: } elsif ($remoteurl eq 'directory') {
660: return OK;
661: } else {
662: my @parts=split(/\//,$filename);
663: my $path="/$parts[1]/$parts[2]/$parts[3]/$parts[4]";
664: if ($path ne "$perlvar{'lonDocRoot'}/res") {
665: &logthis("Malconfiguration for replication: $filename");
666: return HTTP_BAD_REQUEST;
667: }
668: my $count;
669: for ($count=5;$count<$#parts;$count++) {
670: $path.="/$parts[$count]";
671: if ((-e $path)!=1) {
672: mkdir($path,0777);
673: }
674: }
675: my $ua=new LWP::UserAgent;
676: my $request=new HTTP::Request('GET',"$remoteurl");
677: my $response=$ua->request($request,$transname);
678: if ($response->is_error()) {
679: unlink($transname);
680: my $message=$response->status_line;
681: &logthis("<font color=blue>WARNING:"
682: ." LWP get: $message: $filename</font>");
683: return HTTP_SERVICE_UNAVAILABLE;
684: } else {
685: if ($remoteurl!~/\.meta$/) {
686: my $mrequest=new HTTP::Request('GET',$remoteurl.'.meta');
687: my $mresponse=$ua->request($mrequest,$filename.'.meta');
688: if ($mresponse->is_error()) {
689: unlink($filename.'.meta');
690: &logthis(
691: "<font color=yellow>INFO: No metadata: $filename</font>");
692: }
693: }
694: rename($transname,$filename);
695: return OK;
696: }
697: }
698: }
699:
700: # --------------------------------------------------------- Server Side Include
701:
702: sub ssi {
703:
704: my ($fn,%form)=@_;
705:
706: my $ua=new LWP::UserAgent;
707:
708: my $request;
709:
710: if (%form) {
711: $request=new HTTP::Request('POST',"http://".$ENV{'HTTP_HOST'}.$fn);
712: $request->content(join('&',map { &escape($_).'='.&escape($form{$_}) } keys %form));
713: } else {
714: $request=new HTTP::Request('GET',"http://".$ENV{'HTTP_HOST'}.$fn);
715: }
716:
717: $request->header(Cookie => $ENV{'HTTP_COOKIE'});
718: my $response=$ua->request($request);
719:
720: return $response->content;
721: }
722:
723: # ------- Add a token to a remote URI's query string to vouch for access rights
724:
725: sub tokenwrapper {
726: my $uri=shift;
727: $uri=~s/^http\:\/\/([^\/]+)//;
728: $uri=~s/^\///;
729: $ENV{'user.environment'}=~/\/([^\/]+)\.id/;
730: my $token=$1;
731: if ($uri=~/^uploaded\/([^\/]+)\/([^\/]+)\/([^\/]+)(\?\.*)*$/) {
732: &appenv('userfile.'.$1.'/'.$2.'/'.$3 => $ENV{'request.course.id'});
733: return 'http://'.$hostname{ &homeserver($2,$1)}.'/'.$uri.
734: (($uri=~/\?/)?'&':'?').'token='.$token;
735: } else {
736: return '/adm/notfound.html';
737: }
738: }
739:
740: # --------------- Take an uploaded file and put it into the userfiles directory
741: # input: name of form element, coursedoc=1 means this is for the course
742: # output: url of file in userspace
743:
744: sub userfileupload {
745: my ($formname,$coursedoc)=@_;
746: my $fname=$ENV{'form.'.$formname.'.filename'};
747: $fname=~s/\\/\//g;
748: $fname=~s/^.*\/([^\/]+)$/$1/;
749: unless ($fname) { return 'error: no uploaded file'; }
750: chop($ENV{'form.'.$formname});
751: # Create the directory if not present
752: my $docuname='';
753: my $docudom='';
754: my $docuhome='';
755: if ($coursedoc) {
756: $docuname=$ENV{'course.'.$ENV{'request.course.id'}.'.num'};
757: $docudom=$ENV{'course.'.$ENV{'request.course.id'}.'.domain'};
758: $docuhome=$ENV{'course.'.$ENV{'request.course.id'}.'.home'};
759: } else {
760: $docuname=$ENV{'user.name'};
761: $docudom=$ENV{'user.domain'};
762: $docuhome=$ENV{'user.home'};
763: }
764: return
765: &finishuserfileupload($docuname,$docudom,$docuhome,$formname,$fname);
766: }
767:
768: sub finishuserfileupload {
769: my ($docuname,$docudom,$docuhome,$formname,$fname)=@_;
770: my $path=$docudom.'/'.$docuname.'/';
771: my $filepath=$perlvar{'lonDocRoot'};
772: my @parts=split(/\//,$filepath.'/userfiles/'.$path);
773: my $count;
774: for ($count=4;$count<=$#parts;$count++) {
775: $filepath.="/$parts[$count]";
776: if ((-e $filepath)!=1) {
777: mkdir($filepath,0777);
778: }
779: }
780: # Save the file
781: {
782: my $fh=Apache::File->new('>'.$filepath.'/'.$fname);
783: print $fh $ENV{'form.'.$formname};
784: }
785: # Notify homeserver to grep it
786: #
787: if
788: (&reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$fname,$docuhome) eq 'ok')
789: {
790: #
791: # Return the URL to it
792: return '/uploaded/'.$path.$fname;
793: } else {
794: return '/adm/notfound.html';
795: }
796: }
797:
798: # ------------------------------------------------------------------------- Log
799:
800: sub log {
801: my ($dom,$nam,$hom,$what)=@_;
802: return critical("log:$dom:$nam:$what",$hom);
803: }
804:
805: # ------------------------------------------------------------------ Course Log
806:
807: sub flushcourselogs {
808: &logthis('Flushing course log buffers');
809: foreach (keys %courselogs) {
810: my $crsid=$_;
811: if (&reply('log:'.$coursedombuf{$crsid}.':'.
812: &escape($courselogs{$crsid}),
813: $coursehombuf{$crsid}) eq 'ok') {
814: delete $courselogs{$crsid};
815: } else {
816: &logthis('Failed to flush log buffer for '.$crsid);
817: if (length($courselogs{$crsid})>40000) {
818: &logthis("<font color=blue>WARNING: Buffer for ".$crsid.
819: " exceeded maximum size, deleting.</font>");
820: delete $courselogs{$crsid};
821: }
822: }
823: }
824: &logthis('Flushing access logs');
825: foreach (keys %accesshash) {
826: my $entry=$_;
827: $entry=~/\_\_\_(\w+)\/(\w+)\/(.*)\_\_\_(\w+)$/;
828: my %temphash=($entry => $accesshash{$entry});
829: if (&Apache::lonnet::put('nohist_resevaldata',\%temphash,$1,$2) eq 'ok') {
830: delete $accesshash{$entry};
831: }
832: }
833: $dumpcount++;
834: }
835:
836: sub courselog {
837: my $what=shift;
838: $what=time.':'.$what;
839: unless ($ENV{'request.course.id'}) { return ''; }
840: $coursedombuf{$ENV{'request.course.id'}}=
841: $ENV{'course.'.$ENV{'request.course.id'}.'.domain'}.':'.
842: $ENV{'course.'.$ENV{'request.course.id'}.'.num'};
843: $coursehombuf{$ENV{'request.course.id'}}=
844: $ENV{'course.'.$ENV{'request.course.id'}.'.home'};
845: if (defined $courselogs{$ENV{'request.course.id'}}) {
846: $courselogs{$ENV{'request.course.id'}}.='&'.$what;
847: } else {
848: $courselogs{$ENV{'request.course.id'}}.=$what;
849: }
850: if (length($courselogs{$ENV{'request.course.id'}})>4048) {
851: &flushcourselogs();
852: }
853: }
854:
855: sub courseacclog {
856: my $fnsymb=shift;
857: unless ($ENV{'request.course.id'}) { return ''; }
858: my $what=$fnsymb.':'.$ENV{'user.name'}.':'.$ENV{'user.domain'};
859: if ($fnsymb=~/(problem|exam|quiz|assess|survey|form)$/) {
860: $what.=':POST';
861: foreach (keys %ENV) {
862: if ($_=~/^form\.(.*)/) {
863: $what.=':'.$1.'='.$ENV{$_};
864: }
865: }
866: }
867: &courselog($what);
868: }
869:
870: sub countacc {
871: my $url=&declutter(shift);
872: unless ($ENV{'request.course.id'}) { return ''; }
873: $accesshash{$ENV{'request.course.id'}.'___'.$url.'___course'}=1;
874: my $key=$processmarker.'_'.$dumpcount.'___'.$url.'___count';
875: if (defined($accesshash{$key})) {
876: $accesshash{$key}++;
877: } else {
878: $accesshash{$key}=1;
879: }
880: }
881:
882: # ----------------------------------------------------------- Check out an item
883:
884: sub checkout {
885: my ($symb,$tuname,$tudom,$tcrsid)=@_;
886: my $now=time;
887: my $lonhost=$perlvar{'lonHostID'};
888: my $infostr=&escape(
889: 'CHECKOUTTOKEN&'.
890: $tuname.'&'.
891: $tudom.'&'.
892: $tcrsid.'&'.
893: $symb.'&'.
894: $now.'&'.$ENV{'REMOTE_ADDR'});
895: my $token=&reply('tmpput:'.$infostr,$lonhost);
896: if ($token=~/^error\:/) {
897: &logthis("<font color=blue>WARNING: ".
898: "Checkout tmpput failed ".$tudom.' - '.$tuname.' - '.$symb.
899: "</font>");
900: return '';
901: }
902:
903: $token=~s/^(\d+)\_.*\_(\d+)$/$1\*$2\*$lonhost/;
904: $token=~tr/a-z/A-Z/;
905:
906: my %infohash=('resource.0.outtoken' => $token,
907: 'resource.0.checkouttime' => $now,
908: 'resource.0.outremote' => $ENV{'REMOTE_ADDR'});
909:
910: unless (&cstore(\%infohash,$symb,$tcrsid,$tudom,$tuname) eq 'ok') {
911: return '';
912: } else {
913: &logthis("<font color=blue>WARNING: ".
914: "Checkout cstore failed ".$tudom.' - '.$tuname.' - '.$symb.
915: "</font>");
916: }
917:
918: if (&log($tudom,$tuname,&homeserver($tuname,$tudom),
919: &escape('Checkout '.$infostr.' - '.
920: $token)) ne 'ok') {
921: return '';
922: } else {
923: &logthis("<font color=blue>WARNING: ".
924: "Checkout log failed ".$tudom.' - '.$tuname.' - '.$symb.
925: "</font>");
926: }
927: return $token;
928: }
929:
930: # ------------------------------------------------------------ Check in an item
931:
932: sub checkin {
933: my $token=shift;
934: my $now=time;
935: my ($ta,$tb,$lonhost)=split(/\*/,$token);
936: $lonhost=~tr/A-Z/a-z/;
937: my $dtoken=$ta.'_'.$hostip{$lonhost}.'_'.$tb;
938: $dtoken=~s/\W/\_/g;
939: my ($dummy,$tuname,$tudom,$tcrsid,$symb,$chtim,$rmaddr)=
940: split(/\&/,&unescape(&reply('tmpget:'.$dtoken,$lonhost)));
941:
942: unless (($tuname) && ($tudom)) {
943: &logthis('Check in '.$token.' ('.$dtoken.') failed');
944: return '';
945: }
946:
947: unless (&allowed('mgr',$tcrsid)) {
948: &logthis('Check in '.$token.' ('.$dtoken.') unauthorized: '.
949: $ENV{'user.name'}.' - '.$ENV{'user.domain'});
950: return '';
951: }
952:
953: my %infohash=('resource.0.intoken' => $token,
954: 'resource.0.checkintime' => $now,
955: 'resource.0.inremote' => $ENV{'REMOTE_ADDR'});
956:
957: unless (&cstore(\%infohash,$symb,$tcrsid,$tudom,$tuname) eq 'ok') {
958: return '';
959: }
960:
961: if (&log($tudom,$tuname,&homeserver($tuname,$tudom),
962: &escape('Checkin - '.$token)) ne 'ok') {
963: return '';
964: }
965:
966: return ($symb,$tuname,$tudom,$tcrsid);
967: }
968:
969: # --------------------------------------------- Set Expire Date for Spreadsheet
970:
971: sub expirespread {
972: my ($uname,$udom,$stype,$usymb)=@_;
973: my $cid=$ENV{'request.course.id'};
974: if ($cid) {
975: my $now=time;
976: my $key=$uname.':'.$udom.':'.$stype.':'.$usymb;
977: return &reply('put:'.$ENV{'course.'.$cid.'.domain'}.':'.
978: $ENV{'course.'.$cid.'.num'}.
979: ':nohist_expirationdates:'.
980: &escape($key).'='.$now,
981: $ENV{'course.'.$cid.'.home'})
982: }
983: return 'ok';
984: }
985:
986: # ----------------------------------------------------- Devalidate Spreadsheets
987:
988: sub devalidate {
989: my $symb=shift;
990: my $cid=$ENV{'request.course.id'};
991: if ($cid) {
992: my $key=$ENV{'user.name'}.':'.$ENV{'user.domain'}.':';
993: my $status=
994: &del('nohist_calculatedsheet',
995: [$key.'studentcalc'],
996: $ENV{'course.'.$cid.'.domain'},
997: $ENV{'course.'.$cid.'.num'})
998: .' '.
999: &del('nohist_calculatedsheets_'.$cid,
1000: [$key.'assesscalc:'.$symb]);
1001: unless ($status eq 'ok ok') {
1002: &logthis('Could not devalidate spreadsheet '.
1003: $ENV{'user.name'}.' at '.$ENV{'user.domain'}.' for '.
1004: $symb.': '.$status);
1005: }
1006: }
1007: }
1008:
1009: sub get_scalar {
1010: my ($string,$end) = @_;
1011: my $value;
1012: if ($$string =~ s/^([^&]*?)($end)/$2/) {
1013: $value = $1;
1014: } elsif ($$string =~ s/^([^&]*?)&//) {
1015: $value = $1;
1016: }
1017: return &unescape($value);
1018: }
1019:
1020: sub array2str {
1021: my (@array) = @_;
1022: my $result=&arrayref2str(\@array);
1023: $result=~s/^__ARRAY_REF__//;
1024: $result=~s/__END_ARRAY_REF__$//;
1025: return $result;
1026: }
1027:
1028: sub arrayref2str {
1029: my ($arrayref) = @_;
1030: my $result='__ARRAY_REF__';
1031: foreach my $elem (@$arrayref) {
1032: if(ref($elem) eq 'ARRAY') {
1033: $result.=&arrayref2str($elem).'&';
1034: } elsif(ref($elem) eq 'HASH') {
1035: $result.=&hashref2str($elem).'&';
1036: } elsif(ref($elem)) {
1037: #print("Got a ref of ".(ref($elem))." skipping.");
1038: } else {
1039: $result.=&escape($elem).'&';
1040: }
1041: }
1042: $result=~s/\&$//;
1043: $result .= '__END_ARRAY_REF__';
1044: return $result;
1045: }
1046:
1047: sub hash2str {
1048: my (%hash) = @_;
1049: my $result=&hashref2str(\%hash);
1050: $result=~s/^__HASH_REF__//;
1051: $result=~s/__END_HASH_REF__$//;
1052: return $result;
1053: }
1054:
1055: sub hashref2str {
1056: my ($hashref)=@_;
1057: my $result='__HASH_REF__';
1058: foreach (keys(%$hashref)) {
1059: if (ref($_) eq 'ARRAY') {
1060: $result.=&arrayref2str($_).'=';
1061: } elsif (ref($_) eq 'HASH') {
1062: $result.=&hashref2str($_).'=';
1063: } elsif (ref($_)) {
1064: $result.='=';
1065: #print("Got a ref of ".(ref($_))." skipping.");
1066: } else {
1067: if ($_) {$result.=&escape($_).'=';} else { last; }
1068: }
1069:
1070: if(ref($hashref->{$_}) eq 'ARRAY') {
1071: $result.=&arrayref2str($hashref->{$_}).'&';
1072: } elsif(ref($hashref->{$_}) eq 'HASH') {
1073: $result.=&hashref2str($hashref->{$_}).'&';
1074: } elsif(ref($hashref->{$_})) {
1075: $result.='&';
1076: #print("Got a ref of ".(ref($hashref->{$_}))." skipping.");
1077: } else {
1078: $result.=&escape($hashref->{$_}).'&';
1079: }
1080: }
1081: $result=~s/\&$//;
1082: $result .= '__END_HASH_REF__';
1083: return $result;
1084: }
1085:
1086: sub str2hash {
1087: my ($string)=@_;
1088: my ($hash)=&str2hashref('__HASH_REF__'.$string.'__END_HASH_REF__');
1089: return %$hash;
1090: }
1091:
1092: sub str2hashref {
1093: my ($string) = @_;
1094:
1095: my %hash;
1096:
1097: if($string !~ /^__HASH_REF__/) {
1098: if (! ($string eq '' || !defined($string))) {
1099: $hash{'error'}='Not hash reference';
1100: }
1101: return (\%hash, $string);
1102: }
1103:
1104: $string =~ s/^__HASH_REF__//;
1105:
1106: while($string !~ /^__END_HASH_REF__/) {
1107: #key
1108: my $key='';
1109: if($string =~ /^__HASH_REF__/) {
1110: ($key, $string)=&str2hashref($string);
1111: if(defined($key->{'error'})) {
1112: $hash{'error'}='Bad data';
1113: return (\%hash, $string);
1114: }
1115: } elsif($string =~ /^__ARRAY_REF__/) {
1116: ($key, $string)=&str2arrayref($string);
1117: if($key->[0] eq 'Array reference error') {
1118: $hash{'error'}='Bad data';
1119: return (\%hash, $string);
1120: }
1121: } else {
1122: $string =~ s/^(.*?)=//;
1123: $key=&unescape($1);
1124: }
1125: $string =~ s/^=//;
1126:
1127: #value
1128: my $value='';
1129: if($string =~ /^__HASH_REF__/) {
1130: ($value, $string)=&str2hashref($string);
1131: if(defined($value->{'error'})) {
1132: $hash{'error'}='Bad data';
1133: return (\%hash, $string);
1134: }
1135: } elsif($string =~ /^__ARRAY_REF__/) {
1136: ($value, $string)=&str2arrayref($string);
1137: if($value->[0] eq 'Array reference error') {
1138: $hash{'error'}='Bad data';
1139: return (\%hash, $string);
1140: }
1141: } else {
1142: $value=&get_scalar(\$string,'__END_HASH_REF__');
1143: }
1144: $string =~ s/^&//;
1145:
1146: $hash{$key}=$value;
1147: }
1148:
1149: $string =~ s/^__END_HASH_REF__//;
1150:
1151: return (\%hash, $string);
1152: }
1153:
1154: sub str2array {
1155: my ($string)=@_;
1156: my ($array)=&str2arrayref('__ARRAY_REF__'.$string.'__END_ARRAY_REF__');
1157: return @$array;
1158: }
1159:
1160: sub str2arrayref {
1161: my ($string) = @_;
1162: my @array;
1163:
1164: if($string !~ /^__ARRAY_REF__/) {
1165: if (! ($string eq '' || !defined($string))) {
1166: $array[0]='Array reference error';
1167: }
1168: return (\@array, $string);
1169: }
1170:
1171: $string =~ s/^__ARRAY_REF__//;
1172:
1173: while($string !~ /^__END_ARRAY_REF__/) {
1174: my $value='';
1175: if($string =~ /^__HASH_REF__/) {
1176: ($value, $string)=&str2hashref($string);
1177: if(defined($value->{'error'})) {
1178: $array[0] ='Array reference error';
1179: return (\@array, $string);
1180: }
1181: } elsif($string =~ /^__ARRAY_REF__/) {
1182: ($value, $string)=&str2arrayref($string);
1183: if($value->[0] eq 'Array reference error') {
1184: $array[0] ='Array reference error';
1185: return (\@array, $string);
1186: }
1187: } else {
1188: $value=&get_scalar(\$string,'__END_ARRAY_REF__');
1189: }
1190: $string =~ s/^&//;
1191:
1192: push(@array, $value);
1193: }
1194:
1195: $string =~ s/^__END_ARRAY_REF__//;
1196:
1197: return (\@array, $string);
1198: }
1199:
1200: # -------------------------------------------------------------------Temp Store
1201:
1202: sub tmpreset {
1203: my ($symb,$namespace,$domain,$stuname) = @_;
1204: if (!$symb) {
1205: $symb=&symbread();
1206: if (!$symb) { $symb= $ENV{'REQUEST_URI'}; }
1207: }
1208: $symb=escape($symb);
1209:
1210: if (!$namespace) { $namespace=$ENV{'request.state'}; }
1211: $namespace=~s/\//\_/g;
1212: $namespace=~s/\W//g;
1213:
1214: #FIXME needs to do something for /pub resources
1215: if (!$domain) { $domain=$ENV{'user.domain'}; }
1216: if (!$stuname) { $stuname=$ENV{'user.name'}; }
1217: my $path=$perlvar{'lonDaemons'}.'/tmp';
1218: my %hash;
1219: if (tie(%hash,'GDBM_File',
1220: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
1221: &GDBM_WRCREAT(),0640)) {
1222: foreach my $key (keys %hash) {
1223: if ($key=~ /:$symb/) {
1224: delete($hash{$key});
1225: }
1226: }
1227: }
1228: }
1229:
1230: sub tmpstore {
1231: my ($storehash,$symb,$namespace,$domain,$stuname) = @_;
1232:
1233: if (!$symb) {
1234: $symb=&symbread();
1235: if (!$symb) { $symb= $ENV{'request.url'}; }
1236: }
1237: $symb=escape($symb);
1238:
1239: if (!$namespace) {
1240: # I don't think we would ever want to store this for a course.
1241: # it seems this will only be used if we don't have a course.
1242: #$namespace=$ENV{'request.course.id'};
1243: #if (!$namespace) {
1244: $namespace=$ENV{'request.state'};
1245: #}
1246: }
1247: $namespace=~s/\//\_/g;
1248: $namespace=~s/\W//g;
1249: #FIXME needs to do something for /pub resources
1250: if (!$domain) { $domain=$ENV{'user.domain'}; }
1251: if (!$stuname) { $stuname=$ENV{'user.name'}; }
1252: my $now=time;
1253: my %hash;
1254: my $path=$perlvar{'lonDaemons'}.'/tmp';
1255: if (tie(%hash,'GDBM_File',
1256: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
1257: &GDBM_WRCREAT(),0640)) {
1258: $hash{"version:$symb"}++;
1259: my $version=$hash{"version:$symb"};
1260: my $allkeys='';
1261: foreach my $key (keys(%$storehash)) {
1262: $allkeys.=$key.':';
1263: $hash{"$version:$symb:$key"}=$$storehash{$key};
1264: }
1265: $hash{"$version:$symb:timestamp"}=$now;
1266: $allkeys.='timestamp';
1267: $hash{"$version:keys:$symb"}=$allkeys;
1268: if (untie(%hash)) {
1269: return 'ok';
1270: } else {
1271: return "error:$!";
1272: }
1273: } else {
1274: return "error:$!";
1275: }
1276: }
1277:
1278: # -----------------------------------------------------------------Temp Restore
1279:
1280: sub tmprestore {
1281: my ($symb,$namespace,$domain,$stuname) = @_;
1282:
1283: if (!$symb) {
1284: $symb=&symbread();
1285: if (!$symb) { $symb= $ENV{'request.url'}; }
1286: }
1287: $symb=escape($symb);
1288:
1289: if (!$namespace) { $namespace=$ENV{'request.state'}; }
1290: #FIXME needs to do something for /pub resources
1291: if (!$domain) { $domain=$ENV{'user.domain'}; }
1292: if (!$stuname) { $stuname=$ENV{'user.name'}; }
1293:
1294: my %returnhash;
1295: $namespace=~s/\//\_/g;
1296: $namespace=~s/\W//g;
1297: my %hash;
1298: my $path=$perlvar{'lonDaemons'}.'/tmp';
1299: if (tie(%hash,'GDBM_File',
1300: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
1301: &GDBM_READER(),0640)) {
1302: my $version=$hash{"version:$symb"};
1303: $returnhash{'version'}=$version;
1304: my $scope;
1305: for ($scope=1;$scope<=$version;$scope++) {
1306: my $vkeys=$hash{"$scope:keys:$symb"};
1307: my @keys=split(/:/,$vkeys);
1308: my $key;
1309: $returnhash{"$scope:keys"}=$vkeys;
1310: foreach $key (@keys) {
1311: $returnhash{"$scope:$key"}=$hash{"$scope:$symb:$key"};
1312: $returnhash{"$key"}=$hash{"$scope:$symb:$key"};
1313: }
1314: }
1315: if (!(untie(%hash))) {
1316: return "error:$!";
1317: }
1318: } else {
1319: return "error:$!";
1320: }
1321: return %returnhash;
1322: }
1323:
1324: # ----------------------------------------------------------------------- Store
1325:
1326: sub store {
1327: my ($storehash,$symb,$namespace,$domain,$stuname) = @_;
1328: my $home='';
1329:
1330: if ($stuname) { $home=&homeserver($stuname,$domain); }
1331:
1332: $symb=&symbclean($symb);
1333: if (!$symb) { unless ($symb=&symbread()) { return ''; } }
1334:
1335: &devalidate($symb);
1336:
1337: $symb=escape($symb);
1338: if (!$namespace) {
1339: unless ($namespace=$ENV{'request.course.id'}) {
1340: return '';
1341: }
1342: }
1343: if (!$domain) { $domain=$ENV{'user.domain'}; }
1344: if (!$stuname) { $stuname=$ENV{'user.name'}; }
1345: if (!$home) { $home=$ENV{'user.home'}; }
1346: my $namevalue='';
1347: foreach (keys %$storehash) {
1348: $namevalue.=escape($_).'='.escape($$storehash{$_}).'&';
1349: }
1350: $namevalue=~s/\&$//;
1351: &courselog($symb.':'.$stuname.':'.$domain.':STORE:'.$namevalue);
1352: return reply("store:$domain:$stuname:$namespace:$symb:$namevalue","$home");
1353: }
1354:
1355: # -------------------------------------------------------------- Critical Store
1356:
1357: sub cstore {
1358: my ($storehash,$symb,$namespace,$domain,$stuname) = @_;
1359: my $home='';
1360:
1361: if ($stuname) { $home=&homeserver($stuname,$domain); }
1362:
1363: $symb=&symbclean($symb);
1364: if (!$symb) { unless ($symb=&symbread()) { return ''; } }
1365:
1366: &devalidate($symb);
1367:
1368: $symb=escape($symb);
1369: if (!$namespace) {
1370: unless ($namespace=$ENV{'request.course.id'}) {
1371: return '';
1372: }
1373: }
1374: if (!$domain) { $domain=$ENV{'user.domain'}; }
1375: if (!$stuname) { $stuname=$ENV{'user.name'}; }
1376: if (!$home) { $home=$ENV{'user.home'}; }
1377:
1378: my $namevalue='';
1379: foreach (keys %$storehash) {
1380: $namevalue.=escape($_).'='.escape($$storehash{$_}).'&';
1381: }
1382: $namevalue=~s/\&$//;
1383: &courselog($symb.':'.$stuname.':'.$domain.':CSTORE:'.$namevalue);
1384: return critical
1385: ("store:$domain:$stuname:$namespace:$symb:$namevalue","$home");
1386: }
1387:
1388: # --------------------------------------------------------------------- Restore
1389:
1390: sub restore {
1391: my ($symb,$namespace,$domain,$stuname) = @_;
1392: my $home='';
1393:
1394: if ($stuname) { $home=&homeserver($stuname,$domain); }
1395:
1396: if (!$symb) {
1397: unless ($symb=escape(&symbread())) { return ''; }
1398: } else {
1399: $symb=&escape(&symbclean($symb));
1400: }
1401: if (!$namespace) {
1402: unless ($namespace=$ENV{'request.course.id'}) {
1403: return '';
1404: }
1405: }
1406: if (!$domain) { $domain=$ENV{'user.domain'}; }
1407: if (!$stuname) { $stuname=$ENV{'user.name'}; }
1408: if (!$home) { $home=$ENV{'user.home'}; }
1409: my $answer=&reply("restore:$domain:$stuname:$namespace:$symb","$home");
1410:
1411: my %returnhash=();
1412: foreach (split(/\&/,$answer)) {
1413: my ($name,$value)=split(/\=/,$_);
1414: $returnhash{&unescape($name)}=&unescape($value);
1415: }
1416: my $version;
1417: for ($version=1;$version<=$returnhash{'version'};$version++) {
1418: foreach (split(/\:/,$returnhash{$version.':keys'})) {
1419: $returnhash{$_}=$returnhash{$version.':'.$_};
1420: }
1421: }
1422: return %returnhash;
1423: }
1424:
1425: # ---------------------------------------------------------- Course Description
1426:
1427: sub coursedescription {
1428: my $courseid=shift;
1429: $courseid=~s/^\///;
1430: $courseid=~s/\_/\//g;
1431: my ($cdomain,$cnum)=split(/\//,$courseid);
1432: my $chome=&homeserver($cnum,$cdomain);
1433: if ($chome ne 'no_host') {
1434: my %returnhash=&dump('environment',$cdomain,$cnum);
1435: if (!exists($returnhash{'con_lost'})) {
1436: my $normalid=$cdomain.'_'.$cnum;
1437: my %envhash=();
1438: $returnhash{'home'}= $chome;
1439: $returnhash{'domain'} = $cdomain;
1440: $returnhash{'num'} = $cnum;
1441: while (my ($name,$value) = each %returnhash) {
1442: $envhash{'course.'.$normalid.'.'.$name}=$value;
1443: }
1444: $returnhash{'url'}=&clutter($returnhash{'url'});
1445: $returnhash{'fn'}=$perlvar{'lonDaemons'}.'/tmp/'.
1446: $ENV{'user.name'}.'_'.$cdomain.'_'.$cnum;
1447: $envhash{'course.'.$normalid.'.last_cache'}=time;
1448: $envhash{'course.'.$normalid.'.home'}=$chome;
1449: $envhash{'course.'.$normalid.'.domain'}=$cdomain;
1450: $envhash{'course.'.$normalid.'.num'}=$cnum;
1451: &appenv(%envhash);
1452: return %returnhash;
1453: }
1454: }
1455: return ();
1456: }
1457:
1458: # -------------------------------------------------------- Get user privileges
1459:
1460: sub rolesinit {
1461: my ($domain,$username,$authhost)=@_;
1462: my $rolesdump=reply("dump:$domain:$username:roles",$authhost);
1463: if (($rolesdump eq 'con_lost') || ($rolesdump eq '')) { return ''; }
1464: my %allroles=();
1465: my %thesepriv=();
1466: my $now=time;
1467: my $userroles="user.login.time=$now\n";
1468: my $thesestr;
1469:
1470: if ($rolesdump ne '') {
1471: foreach (split(/&/,$rolesdump)) {
1472: if ($_!~/^rolesdef\&/) {
1473: my ($area,$role)=split(/=/,$_);
1474: $area=~s/\_\w\w$//;
1475: my ($trole,$tend,$tstart)=split(/_/,$role);
1476: $userroles.='user.role.'.$trole.'.'.$area.'='.
1477: $tstart.'.'.$tend."\n";
1478: if ($tend!=0) {
1479: if ($tend<$now) {
1480: $trole='';
1481: }
1482: }
1483: if ($tstart!=0) {
1484: if ($tstart>$now) {
1485: $trole='';
1486: }
1487: }
1488: if (($area ne '') && ($trole ne '')) {
1489: my $spec=$trole.'.'.$area;
1490: my ($tdummy,$tdomain,$trest)=split(/\//,$area);
1491: if ($trole =~ /^cr\//) {
1492: my ($rdummy,$rdomain,$rauthor,$rrole)=split(/\//,$trole);
1493: my $homsvr=homeserver($rauthor,$rdomain);
1494: if ($hostname{$homsvr} ne '') {
1495: my $roledef=
1496: reply("get:$rdomain:$rauthor:roles:rolesdef_$rrole",
1497: $homsvr);
1498: if (($roledef ne 'con_lost') && ($roledef ne '')) {
1499: my ($syspriv,$dompriv,$coursepriv)=
1500: split(/\_/,unescape($roledef));
1501: $allroles{'cm./'}.=':'.$syspriv;
1502: $allroles{$spec.'./'}.=':'.$syspriv;
1503: if ($tdomain ne '') {
1504: $allroles{'cm./'.$tdomain.'/'}.=':'.$dompriv;
1505: $allroles{$spec.'./'.$tdomain.'/'}.=':'.$dompriv;
1506: if ($trest ne '') {
1507: $allroles{'cm.'.$area}.=':'.$coursepriv;
1508: $allroles{$spec.'.'.$area}.=':'.$coursepriv;
1509: }
1510: }
1511: }
1512: }
1513: } else {
1514: $allroles{'cm./'}.=':'.$pr{$trole.':s'};
1515: $allroles{$spec.'./'}.=':'.$pr{$trole.':s'};
1516: if ($tdomain ne '') {
1517: $allroles{'cm./'.$tdomain.'/'}.=':'.$pr{$trole.':d'};
1518: $allroles{$spec.'./'.$tdomain.'/'}.=':'.$pr{$trole.':d'};
1519: if ($trest ne '') {
1520: $allroles{'cm.'.$area}.=':'.$pr{$trole.':c'};
1521: $allroles{$spec.'.'.$area}.=':'.$pr{$trole.':c'};
1522: }
1523: }
1524: }
1525: }
1526: }
1527: }
1528: my $adv=0;
1529: my $author=0;
1530: foreach (keys %allroles) {
1531: %thesepriv=();
1532: if (($_!~/^st/) && ($_!~/^ta/) && ($_!~/^cm/)) { $adv=1; }
1533: if (($_=~/^au/) || ($_=~/^ca/)) { $author=1; }
1534: foreach (split(/:/,$allroles{$_})) {
1535: if ($_ ne '') {
1536: my ($privilege,$restrictions)=split(/&/,$_);
1537: if ($restrictions eq '') {
1538: $thesepriv{$privilege}='F';
1539: } else {
1540: if ($thesepriv{$privilege} ne 'F') {
1541: $thesepriv{$privilege}.=$restrictions;
1542: }
1543: }
1544: }
1545: }
1546: $thesestr='';
1547: foreach (keys %thesepriv) { $thesestr.=':'.$_.'&'.$thesepriv{$_}; }
1548: $userroles.='user.priv.'.$_.'='.$thesestr."\n";
1549: }
1550: $userroles.='user.adv='.$adv."\n".
1551: 'user.author='.$author."\n";
1552: $ENV{'user.adv'}=$adv;
1553: }
1554: return $userroles;
1555: }
1556:
1557: # --------------------------------------------------------------- get interface
1558:
1559: sub get {
1560: my ($namespace,$storearr,$udomain,$uname)=@_;
1561: my $items='';
1562: foreach (@$storearr) {
1563: $items.=escape($_).'&';
1564: }
1565: $items=~s/\&$//;
1566: if (!$udomain) { $udomain=$ENV{'user.domain'}; }
1567: if (!$uname) { $uname=$ENV{'user.name'}; }
1568: my $uhome=&homeserver($uname,$udomain);
1569:
1570: my $rep=&reply("get:$udomain:$uname:$namespace:$items",$uhome);
1571: my @pairs=split(/\&/,$rep);
1572: if ( $#pairs==0 && $pairs[0] =~ /^(con_lost|error|no_such_host)/i) {
1573: return @pairs;
1574: }
1575: my %returnhash=();
1576: my $i=0;
1577: foreach (@$storearr) {
1578: $returnhash{$_}=unescape($pairs[$i]);
1579: $i++;
1580: }
1581: return %returnhash;
1582: }
1583:
1584: # --------------------------------------------------------------- del interface
1585:
1586: sub del {
1587: my ($namespace,$storearr,$udomain,$uname)=@_;
1588: my $items='';
1589: foreach (@$storearr) {
1590: $items.=escape($_).'&';
1591: }
1592: $items=~s/\&$//;
1593: if (!$udomain) { $udomain=$ENV{'user.domain'}; }
1594: if (!$uname) { $uname=$ENV{'user.name'}; }
1595: my $uhome=&homeserver($uname,$udomain);
1596:
1597: return &reply("del:$udomain:$uname:$namespace:$items",$uhome);
1598: }
1599:
1600: # -------------------------------------------------------------- dump interface
1601:
1602: sub dump {
1603: my ($namespace,$udomain,$uname,$regexp)=@_;
1604: if (!$udomain) { $udomain=$ENV{'user.domain'}; }
1605: if (!$uname) { $uname=$ENV{'user.name'}; }
1606: my $uhome=&homeserver($uname,$udomain);
1607: if ($regexp) {
1608: $regexp=&escape($regexp);
1609: } else {
1610: $regexp='.';
1611: }
1612: my $rep=reply("dump:$udomain:$uname:$namespace:$regexp",$uhome);
1613: my @pairs=split(/\&/,$rep);
1614: my %returnhash=();
1615: foreach (@pairs) {
1616: my ($key,$value)=split(/=/,$_);
1617: $returnhash{unescape($key)}=unescape($value);
1618: }
1619: return %returnhash;
1620: }
1621:
1622: # --------------------------------------------------------------- put interface
1623:
1624: sub put {
1625: my ($namespace,$storehash,$udomain,$uname)=@_;
1626: if (!$udomain) { $udomain=$ENV{'user.domain'}; }
1627: if (!$uname) { $uname=$ENV{'user.name'}; }
1628: my $uhome=&homeserver($uname,$udomain);
1629: my $items='';
1630: foreach (keys %$storehash) {
1631: $items.=&escape($_).'='.&escape($$storehash{$_}).'&';
1632: }
1633: $items=~s/\&$//;
1634: return &reply("put:$udomain:$uname:$namespace:$items",$uhome);
1635: }
1636:
1637: # ------------------------------------------------------ critical put interface
1638:
1639: sub cput {
1640: my ($namespace,$storehash,$udomain,$uname)=@_;
1641: if (!$udomain) { $udomain=$ENV{'user.domain'}; }
1642: if (!$uname) { $uname=$ENV{'user.name'}; }
1643: my $uhome=&homeserver($uname,$udomain);
1644: my $items='';
1645: foreach (keys %$storehash) {
1646: $items.=escape($_).'='.escape($$storehash{$_}).'&';
1647: }
1648: $items=~s/\&$//;
1649: return &critical("put:$udomain:$uname:$namespace:$items",$uhome);
1650: }
1651:
1652: # -------------------------------------------------------------- eget interface
1653:
1654: sub eget {
1655: my ($namespace,$storearr,$udomain,$uname)=@_;
1656: my $items='';
1657: foreach (@$storearr) {
1658: $items.=escape($_).'&';
1659: }
1660: $items=~s/\&$//;
1661: if (!$udomain) { $udomain=$ENV{'user.domain'}; }
1662: if (!$uname) { $uname=$ENV{'user.name'}; }
1663: my $uhome=&homeserver($uname,$udomain);
1664: my $rep=&reply("eget:$udomain:$uname:$namespace:$items",$uhome);
1665: my @pairs=split(/\&/,$rep);
1666: my %returnhash=();
1667: my $i=0;
1668: foreach (@$storearr) {
1669: $returnhash{$_}=unescape($pairs[$i]);
1670: $i++;
1671: }
1672: return %returnhash;
1673: }
1674:
1675: # ------------------------------------------------- Check for a user privilege
1676:
1677: sub allowed {
1678: my ($priv,$uri)=@_;
1679:
1680: my $orguri=$uri;
1681: $uri=&declutter($uri);
1682:
1683: # Free bre access to adm and meta resources
1684:
1685: if ((($uri=~/^adm\//) || ($uri=~/\.meta$/)) && ($priv eq 'bre')) {
1686: return 'F';
1687: }
1688:
1689: # Free bre to public access
1690:
1691: if ($priv eq 'bre') {
1692: my $copyright=&metadata($uri,'copyright');
1693: if ($copyright eq 'public') { return 'F'; }
1694: if ($copyright eq 'priv') {
1695: $uri=~/([^\/]+)\/([^\/]+)\//;
1696: unless (($ENV{'user.name'} eq $2) && ($ENV{'user.domain'} eq $1)) {
1697: return '';
1698: }
1699: }
1700: if ($copyright eq 'domain') {
1701: $uri=~/([^\/]+)\/([^\/]+)\//;
1702: unless (($ENV{'user.domain'} eq $1) ||
1703: ($ENV{'course.'.$ENV{'request.course.id'}.'.domain'} eq $1)) {
1704: return '';
1705: }
1706: }
1707: if ($ENV{'request.role'}=~ /li\.\//) {
1708: # Library role, so allow browsing of resources in this domain.
1709: return 'F';
1710: }
1711: }
1712: # Domain coordinator is trying to create a course
1713: if (($priv eq 'ccc') && ($ENV{'request.role'} =~ /^dc\./)) {
1714: # uri is the requested domain in this case.
1715: # comparison to 'request.role.domain' shows if the user has selected
1716: # a role of dc for the domain in question.
1717: return 'F' if ($uri eq $ENV{'request.role.domain'});
1718: }
1719:
1720: my $thisallowed='';
1721: my $statecond=0;
1722: my $courseprivid='';
1723:
1724: # Course
1725:
1726: if ($ENV{'user.priv.'.$ENV{'request.role'}.'./'}=~/$priv\&([^\:]*)/) {
1727: $thisallowed.=$1;
1728: }
1729:
1730: # Domain
1731:
1732: if ($ENV{'user.priv.'.$ENV{'request.role'}.'./'.(split(/\//,$uri))[0].'/'}
1733: =~/$priv\&([^\:]*)/) {
1734: $thisallowed.=$1;
1735: }
1736:
1737: # Course: uri itself is a course
1738: my $courseuri=$uri;
1739: $courseuri=~s/\_(\d)/\/$1/;
1740: $courseuri=~s/^([^\/])/\/$1/;
1741:
1742: if ($ENV{'user.priv.'.$ENV{'request.role'}.'.'.$courseuri}
1743: =~/$priv\&([^\:]*)/) {
1744: $thisallowed.=$1;
1745: }
1746:
1747: # Full access at system, domain or course-wide level? Exit.
1748:
1749: if ($thisallowed=~/F/) {
1750: return 'F';
1751: }
1752:
1753: # If this is generating or modifying users, exit with special codes
1754:
1755: if (':csu:cdc:ccc:cin:cta:cep:ccr:cst:cad:cli:cau:cdg:cca:'=~/\:$priv\:/) {
1756: return $thisallowed;
1757: }
1758: #
1759: # Gathered so far: system, domain and course wide privileges
1760: #
1761: # Course: See if uri or referer is an individual resource that is part of
1762: # the course
1763:
1764: if ($ENV{'request.course.id'}) {
1765:
1766: $courseprivid=$ENV{'request.course.id'};
1767: if ($ENV{'request.course.sec'}) {
1768: $courseprivid.='/'.$ENV{'request.course.sec'};
1769: }
1770: $courseprivid=~s/\_/\//;
1771: my $checkreferer=1;
1772: my ($match,$cond)=&is_on_map($uri);
1773: if ($match) {
1774: $statecond=$cond;
1775: if ($ENV{'user.priv.'.$ENV{'request.role'}.'./'.$courseprivid}
1776: =~/$priv\&([^\:]*)/) {
1777: $thisallowed.=$1;
1778: $checkreferer=0;
1779: }
1780: }
1781:
1782: if ($checkreferer) {
1783: my $refuri=$ENV{'httpref.'.$orguri};
1784: unless ($refuri) {
1785: foreach (keys %ENV) {
1786: if ($_=~/^httpref\..*\*/) {
1787: my $pattern=$_;
1788: $pattern=~s/^httpref\.\/res\///;
1789: $pattern=~s/\*/\[\^\/\]\+/g;
1790: $pattern=~s/\//\\\//g;
1791: if ($orguri=~/$pattern/) {
1792: $refuri=$ENV{$_};
1793: }
1794: }
1795: }
1796: }
1797:
1798: if ($refuri) {
1799: $refuri=&declutter($refuri);
1800: my ($match,$cond)=&is_on_map($refuri);
1801: if ($match) {
1802: my $refstatecond=$cond;
1803: if ($ENV{'user.priv.'.$ENV{'request.role'}.'./'.$courseprivid}
1804: =~/$priv\&([^\:]*)/) {
1805: $thisallowed.=$1;
1806: $uri=$refuri;
1807: $statecond=$refstatecond;
1808: }
1809: }
1810: }
1811: }
1812: }
1813:
1814: #
1815: # Gathered now: all privileges that could apply, and condition number
1816: #
1817: #
1818: # Full or no access?
1819: #
1820:
1821: if ($thisallowed=~/F/) {
1822: return 'F';
1823: }
1824:
1825: unless ($thisallowed) {
1826: return '';
1827: }
1828:
1829: # Restrictions exist, deal with them
1830: #
1831: # C:according to course preferences
1832: # R:according to resource settings
1833: # L:unless locked
1834: # X:according to user session state
1835: #
1836:
1837: # Possibly locked functionality, check all courses
1838: # Locks might take effect only after 10 minutes cache expiration for other
1839: # courses, and 2 minutes for current course
1840:
1841: my $envkey;
1842: if ($thisallowed=~/L/) {
1843: foreach $envkey (keys %ENV) {
1844: if ($envkey=~/^user\.role\.(st|ta)\.([^\.]*)/) {
1845: my $courseid=$2;
1846: my $roleid=$1.'.'.$2;
1847: $courseid=~s/^\///;
1848: my $expiretime=600;
1849: if ($ENV{'request.role'} eq $roleid) {
1850: $expiretime=120;
1851: }
1852: my ($cdom,$cnum,$csec)=split(/\//,$courseid);
1853: my $prefix='course.'.$cdom.'_'.$cnum.'.';
1854: if ((time-$ENV{$prefix.'last_cache'})>$expiretime) {
1855: &coursedescription($courseid);
1856: }
1857: if (($ENV{$prefix.'res.'.$uri.'.lock.sections'}=~/\,$csec\,/)
1858: || ($ENV{$prefix.'res.'.$uri.'.lock.sections'} eq 'all')) {
1859: if ($ENV{$prefix.'res.'.$uri.'.lock.expire'}>time) {
1860: &log($ENV{'user.domain'},$ENV{'user.name'},
1861: $ENV{'user.home'},
1862: 'Locked by res: '.$priv.' for '.$uri.' due to '.
1863: $cdom.'/'.$cnum.'/'.$csec.' expire '.
1864: $ENV{$prefix.'priv.'.$priv.'.lock.expire'});
1865: return '';
1866: }
1867: }
1868: if (($ENV{$prefix.'priv.'.$priv.'.lock.sections'}=~/\,$csec\,/)
1869: || ($ENV{$prefix.'priv.'.$priv.'.lock.sections'} eq 'all')) {
1870: if ($ENV{'priv.'.$priv.'.lock.expire'}>time) {
1871: &log($ENV{'user.domain'},$ENV{'user.name'},
1872: $ENV{'user.home'},
1873: 'Locked by priv: '.$priv.' for '.$uri.' due to '.
1874: $cdom.'/'.$cnum.'/'.$csec.' expire '.
1875: $ENV{$prefix.'priv.'.$priv.'.lock.expire'});
1876: return '';
1877: }
1878: }
1879: }
1880: }
1881: }
1882:
1883: #
1884: # Rest of the restrictions depend on selected course
1885: #
1886:
1887: unless ($ENV{'request.course.id'}) {
1888: return '1';
1889: }
1890:
1891: #
1892: # Now user is definitely in a course
1893: #
1894:
1895:
1896: # Course preferences
1897:
1898: if ($thisallowed=~/C/) {
1899: my $rolecode=(split(/\./,$ENV{'request.role'}))[0];
1900: my $unamedom=$ENV{'user.name'}.':'.$ENV{'user.domain'};
1901: if ($ENV{'course.'.$ENV{'request.course.id'}.'.'.$priv.'.roles.denied'}
1902: =~/$rolecode/) {
1903: &log($ENV{'user.domain'},$ENV{'user.name'},$ENV{'user.host'},
1904: 'Denied by role: '.$priv.' for '.$uri.' as '.$rolecode.' in '.
1905: $ENV{'request.course.id'});
1906: return '';
1907: }
1908:
1909: if ($ENV{'course.'.$ENV{'request.course.id'}.'.'.$priv.'.users.denied'}
1910: =~/$unamedom/) {
1911: &log($ENV{'user.domain'},$ENV{'user.name'},$ENV{'user.host'},
1912: 'Denied by user: '.$priv.' for '.$uri.' as '.$unamedom.' in '.
1913: $ENV{'request.course.id'});
1914: return '';
1915: }
1916: }
1917:
1918: # Resource preferences
1919:
1920: if ($thisallowed=~/R/) {
1921: my $rolecode=(split(/\./,$ENV{'request.role'}))[0];
1922: my $filename=$perlvar{'lonDocRoot'}.'/res/'.$uri.'.meta';
1923: if (-e $filename) {
1924: my @content;
1925: {
1926: my $fh=Apache::File->new($filename);
1927: @content=<$fh>;
1928: }
1929: if (join('',@content)=~
1930: /\<roledeny[^\>]*\>[^\<]*$rolecode[^\<]*\<\/roledeny\>/) {
1931: &log($ENV{'user.domain'},$ENV{'user.name'},$ENV{'user.host'},
1932: 'Denied by role: '.$priv.' for '.$uri.' as '.$rolecode);
1933: return '';
1934:
1935: }
1936: }
1937: }
1938:
1939: # Restricted by state or randomout?
1940:
1941: if ($thisallowed=~/X/) {
1942: if ($ENV{'acc.randomout'}) {
1943: my $symb=&symbread($uri,1);
1944: if (($symb) && ($ENV{'acc.randomout'}=~/\&$symb\&/)) {
1945: return '';
1946: }
1947: }
1948: if (&condval($statecond)) {
1949: return '2';
1950: } else {
1951: return '';
1952: }
1953: }
1954:
1955: return 'F';
1956: }
1957:
1958: # --------------------------------------------------- Is a resource on the map?
1959:
1960: sub is_on_map {
1961: my $uri=&declutter(shift);
1962: my @uriparts=split(/\//,$uri);
1963: my $filename=$uriparts[$#uriparts];
1964: my $pathname=$uri;
1965: $pathname=~s/\/$filename$//;
1966: my $match=($ENV{'acc.res.'.$ENV{'request.course.id'}.'.'.$pathname}=~
1967: /\&$filename\:([\d\|]+)\&/);
1968: if ($match) {
1969: return (1,$1);
1970: } else {
1971: return (0,0);
1972: }
1973: }
1974:
1975: # ----------------------------------------------------------------- Define Role
1976:
1977: sub definerole {
1978: if (allowed('mcr','/')) {
1979: my ($rolename,$sysrole,$domrole,$courole)=@_;
1980: foreach (split('/',$sysrole)) {
1981: my ($crole,$cqual)=split(/\&/,$_);
1982: if ($pr{'cr:s'}!~/$crole/) { return "refused:s:$crole"; }
1983: if ($pr{'cr:s'}=~/$crole\&/) {
1984: if ($pr{'cr:s'}!~/$crole\&\w*$cqual/) {
1985: return "refused:s:$crole&$cqual";
1986: }
1987: }
1988: }
1989: foreach (split('/',$domrole)) {
1990: my ($crole,$cqual)=split(/\&/,$_);
1991: if ($pr{'cr:d'}!~/$crole/) { return "refused:d:$crole"; }
1992: if ($pr{'cr:d'}=~/$crole\&/) {
1993: if ($pr{'cr:d'}!~/$crole\&\w*$cqual/) {
1994: return "refused:d:$crole&$cqual";
1995: }
1996: }
1997: }
1998: foreach (split('/',$courole)) {
1999: my ($crole,$cqual)=split(/\&/,$_);
2000: if ($pr{'cr:c'}!~/$crole/) { return "refused:c:$crole"; }
2001: if ($pr{'cr:c'}=~/$crole\&/) {
2002: if ($pr{'cr:c'}!~/$crole\&\w*$cqual/) {
2003: return "refused:c:$crole&$cqual";
2004: }
2005: }
2006: }
2007: my $command="encrypt:rolesput:$ENV{'user.domain'}:$ENV{'user.name'}:".
2008: "$ENV{'user.domain'}:$ENV{'user.name'}:".
2009: "rolesdef_$rolename=".
2010: escape($sysrole.'_'.$domrole.'_'.$courole);
2011: return reply($command,$ENV{'user.home'});
2012: } else {
2013: return 'refused';
2014: }
2015: }
2016:
2017: # ---------------- Make a metadata query against the network of library servers
2018:
2019: sub metadata_query {
2020: my ($query,$custom,$customshow,$server_array)=@_;
2021: my %rhash;
2022: my @server_list = (defined($server_array) ? @$server_array
2023: : keys(%libserv) );
2024: for my $server (@server_list) {
2025: unless ($custom or $customshow) {
2026: my $reply=&reply("querysend:".&escape($query),$server);
2027: $rhash{$server}=$reply;
2028: }
2029: else {
2030: my $reply=&reply("querysend:".&escape($query).':'.
2031: &escape($custom).':'.&escape($customshow),
2032: $server);
2033: $rhash{$server}=$reply;
2034: }
2035: }
2036: return \%rhash;
2037: }
2038:
2039: # ----------------------------------------- Send log queries and wait for reply
2040:
2041: sub log_query {
2042: my ($uname,$udom,$query,%filters)=@_;
2043: my $uhome=&homeserver($uname,$udom);
2044: if ($uhome eq 'no_host') { return 'error: no_host'; }
2045: my $uhost=$hostname{$uhome};
2046: my $command=&escape(join(':',map{$_.'='.$filters{$_}} keys %filters));
2047: my $queryid=&reply("querysend:".$query.':'.$udom.':'.$uname.':'.$command,
2048: $uhome);
2049: unless ($queryid=~/^$uhost\_/) { return 'error: '.$queryid; }
2050: return get_query_reply($queryid);
2051: }
2052:
2053: sub get_query_reply {
2054: my $queryid=shift;
2055: my $replyfile=$perlvar{'lonDaemons'}.'/tmp/'.$queryid;
2056: my $reply='';
2057: for (1..100) {
2058: sleep 2;
2059: if (-e $replyfile.'.end') {
2060: if (my $fh=Apache::File->new($replyfile)) {
2061: $reply.=<$fh>;
2062: $fh->close;
2063: } else { return 'error: reply_file_error'; }
2064: return &unescape($reply);
2065: }
2066: }
2067: return 'timeout:'.$queryid;
2068: }
2069:
2070: sub courselog_query {
2071: #
2072: # possible filters:
2073: # url: url or symb
2074: # username
2075: # domain
2076: # action: view, submit, grade
2077: # start: timestamp
2078: # end: timestamp
2079: #
2080: my (%filters)=@_;
2081: unless ($ENV{'request.course.id'}) { return 'no_course'; }
2082: if ($filters{'url'}) {
2083: $filters{'url'}=&symbclean(&declutter($filters{'url'}));
2084: $filters{'url'}=~s/\.(\w+)$/(\\.\\d+)*\\.$1/;
2085: $filters{'url'}=~s/\.(\w+)\_\_\_/(\\.\\d+)*\\.$1/;
2086: }
2087: my $cname=$ENV{'course.'.$ENV{'request.course.id'}.'.num'};
2088: my $cdom=$ENV{'course.'.$ENV{'request.course.id'}.'.domain'};
2089: return &log_query($cname,$cdom,'courselog',%filters);
2090: }
2091:
2092: sub userlog_query {
2093: my ($uname,$udom,%filters)=@_;
2094: return &log_query($uname,$udom,'userlog',%filters);
2095: }
2096:
2097: # ------------------------------------------------------------------ Plain Text
2098:
2099: sub plaintext {
2100: my $short=shift;
2101: return $prp{$short};
2102: }
2103:
2104: # ----------------------------------------------------------------- Assign Role
2105:
2106: sub assignrole {
2107: my ($udom,$uname,$url,$role,$end,$start)=@_;
2108: my $mrole;
2109: if ($role =~ /^cr\//) {
2110: unless (&allowed('ccr',$url)) {
2111: &logthis('Refused custom assignrole: '.
2112: $udom.' '.$uname.' '.$url.' '.$role.' '.$end.' '.$start.' by '.
2113: $ENV{'user.name'}.' at '.$ENV{'user.domain'});
2114: return 'refused';
2115: }
2116: $mrole='cr';
2117: } else {
2118: my $cwosec=$url;
2119: $cwosec=~s/^\/(\w+)\/(\w+)\/.*/$1\/$2/;
2120: unless (&allowed('c'.$role,$cwosec)) {
2121: &logthis('Refused assignrole: '.
2122: $udom.' '.$uname.' '.$url.' '.$role.' '.$end.' '.$start.' by '.
2123: $ENV{'user.name'}.' at '.$ENV{'user.domain'});
2124: return 'refused';
2125: }
2126: $mrole=$role;
2127: }
2128: my $command="encrypt:rolesput:$ENV{'user.domain'}:$ENV{'user.name'}:".
2129: "$udom:$uname:$url".'_'."$mrole=$role";
2130: if ($end) { $command.='_'.$end; }
2131: if ($start) {
2132: if ($end) {
2133: $command.='_'.$start;
2134: } else {
2135: $command.='_0_'.$start;
2136: }
2137: }
2138: return &reply($command,&homeserver($uname,$udom));
2139: }
2140:
2141: # -------------------------------------------------- Modify user authentication
2142: # Overrides without validation
2143:
2144: sub modifyuserauth {
2145: my ($udom,$uname,$umode,$upass)=@_;
2146: my $uhome=&homeserver($uname,$udom);
2147: unless (&allowed('mau',$udom)) { return 'refused'; }
2148: &logthis('Call to modify user authentication '.$udom.', '.$uname.', '.
2149: $umode.' by '.$ENV{'user.name'}.' at '.$ENV{'user.domain'}.
2150: ' in domain '.$ENV{'request.role.domain'});
2151: my $reply=&reply('encrypt:changeuserauth:'.$udom.':'.$uname.':'.$umode.':'.
2152: &escape($upass),$uhome);
2153: &log($ENV{'user.domain'},$ENV{'user.name'},$ENV{'user.home'},
2154: 'Authentication changed for '.$udom.', '.$uname.', '.$umode.
2155: '(Remote '.$ENV{'REMOTE_ADDR'}.'): '.$reply);
2156: &log($udom,,$uname,$uhome,
2157: 'Authentication changed by '.$ENV{'user.domain'}.', '.
2158: $ENV{'user.name'}.', '.$umode.
2159: '(Remote '.$ENV{'REMOTE_ADDR'}.'): '.$reply);
2160: unless ($reply eq 'ok') {
2161: &logthis('Authentication mode error: '.$reply);
2162: return 'error: '.$reply;
2163: }
2164: return 'ok';
2165: }
2166:
2167: # --------------------------------------------------------------- Modify a user
2168:
2169: sub modifyuser {
2170: my ($udom, $uname, $uid,
2171: $umode, $upass, $first,
2172: $middle, $last, $gene,
2173: $forceid, $desiredhome)=@_;
2174: $udom=~s/\W//g;
2175: $uname=~s/\W//g;
2176: &logthis('Call to modify user '.$udom.', '.$uname.', '.$uid.', '.
2177: $umode.', '.$first.', '.$middle.', '.
2178: $last.', '.$gene.'(forceid: '.$forceid.')'.
2179: (defined($desiredhome) ? ' desiredhome = '.$desiredhome :
2180: ' desiredhome not specified').
2181: ' by '.$ENV{'user.name'}.' at '.$ENV{'user.domain'}.
2182: ' in domain '.$ENV{'request.role.domain'});
2183: my $uhome=&homeserver($uname,$udom,'true');
2184: # ----------------------------------------------------------------- Create User
2185: if (($uhome eq 'no_host') && ($umode) && ($upass)) {
2186: my $unhome='';
2187: if (defined($desiredhome) && $hostdom{$desiredhome} eq $udom) {
2188: $unhome = $desiredhome;
2189: } elsif($ENV{'course.'.$ENV{'request.course.id'}.'.domain'} eq $udom) {
2190: $unhome=$ENV{'course.'.$ENV{'request.course.id'}.'.home'};
2191: } else { # load balancing routine for determining $unhome
2192: my $tryserver;
2193: my $loadm=10000000;
2194: foreach $tryserver (keys %libserv) {
2195: if ($hostdom{$tryserver} eq $udom) {
2196: my $answer=reply('load',$tryserver);
2197: if (($answer=~/\d+/) && ($answer<$loadm)) {
2198: $loadm=$answer;
2199: $unhome=$tryserver;
2200: }
2201: }
2202: }
2203: }
2204: if (($unhome eq '') || ($unhome eq 'no_host')) {
2205: return 'error: unable to find a home server for '.$uname.
2206: ' in domain '.$udom;
2207: }
2208: my $reply=&reply('encrypt:makeuser:'.$udom.':'.$uname.':'.$umode.':'.
2209: &escape($upass),$unhome);
2210: unless ($reply eq 'ok') {
2211: return 'error: '.$reply;
2212: }
2213: $uhome=&homeserver($uname,$udom,'true');
2214: if (($uhome eq '') || ($uhome eq 'no_host') || ($uhome ne $unhome)) {
2215: return 'error: verify home';
2216: }
2217: } # End of creation of new user
2218: # ---------------------------------------------------------------------- Add ID
2219: if ($uid) {
2220: $uid=~tr/A-Z/a-z/;
2221: my %uidhash=&idrget($udom,$uname);
2222: if (($uidhash{$uname}) && ($uidhash{$uname}!~/error\:/)
2223: && (!$forceid)) {
2224: unless ($uid eq $uidhash{$uname}) {
2225: return 'error: mismatch '.$uidhash{$uname}.' versus '.$uid;
2226: }
2227: } else {
2228: &idput($udom,($uname => $uid));
2229: }
2230: }
2231: # -------------------------------------------------------------- Add names, etc
2232: my %names=&get('environment',
2233: ['firstname','middlename','lastname','generation'],
2234: $udom,$uname);
2235: if ($names{'firstname'} =~ m/^error:.*/) { %names=(); }
2236: if ($first) { $names{'firstname'} = $first; }
2237: if ($middle) { $names{'middlename'} = $middle; }
2238: if ($last) { $names{'lastname'} = $last; }
2239: if ($gene) { $names{'generation'} = $gene; }
2240: my $reply = &put('environment', \%names, $udom,$uname);
2241: if ($reply ne 'ok') { return 'error: '.$reply; }
2242: &logthis('Success modifying user '.$udom.', '.$uname.', '.$uid.', '.
2243: $umode.', '.$first.', '.$middle.', '.
2244: $last.', '.$gene.' by '.
2245: $ENV{'user.name'}.' at '.$ENV{'user.domain'});
2246: return 'ok';
2247: }
2248:
2249: # -------------------------------------------------------------- Modify student
2250:
2251: sub modifystudent {
2252: my ($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene,$usec,
2253: $end,$start,$forceid,$desiredhome)=@_;
2254: my $cid='';
2255: unless ($cid=$ENV{'request.course.id'}) {
2256: return 'not_in_class';
2257: }
2258: # --------------------------------------------------------------- Make the user
2259: my $reply=&modifyuser
2260: ($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene,$forceid,
2261: $desiredhome);
2262: unless ($reply eq 'ok') { return $reply; }
2263: my $uhome=&homeserver($uname,$udom);
2264: if (($uhome eq '') || ($uhome eq 'no_host')) {
2265: return 'error: no such user';
2266: }
2267: # -------------------------------------------------- Add student to course list
2268: $reply=critical('put:'.$ENV{'course.'.$cid.'.domain'}.':'.
2269: $ENV{'course.'.$cid.'.num'}.':classlist:'.
2270: &escape($uname.':'.$udom).'='.
2271: &escape($end.':'.$start),
2272: $ENV{'course.'.$cid.'.home'});
2273: unless (($reply eq 'ok') || ($reply eq 'delayed')) {
2274: return 'error: '.$reply;
2275: }
2276: # ---------------------------------------------------- Add student role to user
2277: my $uurl='/'.$cid;
2278: $uurl=~s/\_/\//g;
2279: if ($usec) {
2280: $uurl.='/'.$usec;
2281: }
2282: return &assignrole($udom,$uname,$uurl,'st',$end,$start);
2283: }
2284:
2285: # ------------------------------------------------- Write to course preferences
2286:
2287: sub writecoursepref {
2288: my ($courseid,%prefs)=@_;
2289: $courseid=~s/^\///;
2290: $courseid=~s/\_/\//g;
2291: my ($cdomain,$cnum)=split(/\//,$courseid);
2292: my $chome=homeserver($cnum,$cdomain);
2293: if (($chome eq '') || ($chome eq 'no_host')) {
2294: return 'error: no such course';
2295: }
2296: my $cstring='';
2297: foreach (keys %prefs) {
2298: $cstring.=escape($_).'='.escape($prefs{$_}).'&';
2299: }
2300: $cstring=~s/\&$//;
2301: return reply('put:'.$cdomain.':'.$cnum.':environment:'.$cstring,$chome);
2302: }
2303:
2304: # ---------------------------------------------------------- Make/modify course
2305:
2306: sub createcourse {
2307: my ($udom,$description,$url,$course_server,$nonstandard)=@_;
2308: $url=&declutter($url);
2309: my $cid='';
2310: unless (&allowed('ccc',$udom)) {
2311: return 'refused';
2312: }
2313: # ------------------------------------------------------------------- Create ID
2314: my $uname=substr($$.time,0,5).unpack("H8",pack("I32",time)).
2315: unpack("H2",pack("I32",int(rand(255)))).$perlvar{'lonHostID'};
2316: # ----------------------------------------------- Make sure that does not exist
2317: my $uhome=&homeserver($uname,$udom,'true');
2318: unless (($uhome eq '') || ($uhome eq 'no_host')) {
2319: $uname=substr($$.time,0,5).unpack("H8",pack("I32",time)).
2320: unpack("H2",pack("I32",int(rand(255)))).$perlvar{'lonHostID'};
2321: $uhome=&homeserver($uname,$udom,'true');
2322: unless (($uhome eq '') || ($uhome eq 'no_host')) {
2323: return 'error: unable to generate unique course-ID';
2324: }
2325: }
2326: # ------------------------------------------------ Check supplied server name
2327: $course_server = $ENV{'user.homeserver'} if (! defined($course_server));
2328: if (! exists($libserv{$course_server})) {
2329: return 'error:bad server name '.$course_server;
2330: }
2331: # ------------------------------------------------------------- Make the course
2332: my $reply=&reply('encrypt:makeuser:'.$udom.':'.$uname.':none::',
2333: $course_server);
2334: unless ($reply eq 'ok') { return 'error: '.$reply; }
2335: $uhome=&homeserver($uname,$udom,'true');
2336: if (($uhome eq '') || ($uhome eq 'no_host')) {
2337: return 'error: no such course';
2338: }
2339: # ----------------------------------------------------------------- Course made
2340: my $topurl=$url;
2341: unless ($nonstandard) {
2342: # ------------------------------------------ For standard courses, make top url
2343: my $mapurl=&clutter($url);
2344: $ENV{'form.initmap'}=(<<ENDINITMAP);
2345: <map>
2346: <resource id="1" type="start"></resource>
2347: <resource id="2" src="$mapurl"></resource>
2348: <resource id="3" type="finish"></resource>
2349: <link index="1" from="1" to="2"></link>
2350: <link index="2" from="2" to="3"></link>
2351: </map>
2352: ENDINITMAP
2353: $topurl=&declutter(
2354: &finishuserfileupload($uname,$udom,$uhome,'initmap','default.sequence')
2355: );
2356: }
2357: # ----------------------------------------------------------- Write preferences
2358: &writecoursepref($udom.'_'.$uname,
2359: ('description' => $description,
2360: 'url' => $topurl));
2361: return '/'.$udom.'/'.$uname;
2362: }
2363:
2364: # ---------------------------------------------------------- Assign Custom Role
2365:
2366: sub assigncustomrole {
2367: my ($udom,$uname,$url,$rdom,$rnam,$rolename,$end,$start)=@_;
2368: return &assignrole($udom,$uname,$url,'cr/'.$rdom.'/'.$rnam.'/'.$rolename,
2369: $end,$start);
2370: }
2371:
2372: # ----------------------------------------------------------------- Revoke Role
2373:
2374: sub revokerole {
2375: my ($udom,$uname,$url,$role)=@_;
2376: my $now=time;
2377: return &assignrole($udom,$uname,$url,$role,$now);
2378: }
2379:
2380: # ---------------------------------------------------------- Revoke Custom Role
2381:
2382: sub revokecustomrole {
2383: my ($udom,$uname,$url,$rdom,$rnam,$rolename)=@_;
2384: my $now=time;
2385: return &assigncustomrole($udom,$uname,$url,$rdom,$rnam,$rolename,$now);
2386: }
2387:
2388: # ------------------------------------------------------------ Directory lister
2389:
2390: sub dirlist {
2391: my ($uri,$userdomain,$username,$alternateDirectoryRoot)=@_;
2392:
2393: $uri=~s/^\///;
2394: $uri=~s/\/$//;
2395: my ($udom, $uname);
2396: (undef,$udom,$uname)=split(/\//,$uri);
2397: if(defined($userdomain)) {
2398: $udom = $userdomain;
2399: }
2400: if(defined($username)) {
2401: $uname = $username;
2402: }
2403:
2404: my $dirRoot = $perlvar{'lonDocRoot'};
2405: if(defined($alternateDirectoryRoot)) {
2406: $dirRoot = $alternateDirectoryRoot;
2407: $dirRoot =~ s/\/$//;
2408: }
2409:
2410: if($udom) {
2411: if($uname) {
2412: my $listing=reply('ls:'.$dirRoot.'/'.$uri,
2413: homeserver($uname,$udom));
2414: return split(/:/,$listing);
2415: } elsif(!defined($alternateDirectoryRoot)) {
2416: my $tryserver;
2417: my %allusers=();
2418: foreach $tryserver (keys %libserv) {
2419: if($hostdom{$tryserver} eq $udom) {
2420: my $listing=reply('ls:'.$perlvar{'lonDocRoot'}.'/res/'.
2421: $udom, $tryserver);
2422: if (($listing ne 'no_such_dir') && ($listing ne 'empty')
2423: && ($listing ne 'con_lost')) {
2424: foreach (split(/:/,$listing)) {
2425: my ($entry,@stat)=split(/&/,$_);
2426: $allusers{$entry}=1;
2427: }
2428: }
2429: }
2430: }
2431: my $alluserstr='';
2432: foreach (sort keys %allusers) {
2433: $alluserstr.=$_.'&user:';
2434: }
2435: $alluserstr=~s/:$//;
2436: return split(/:/,$alluserstr);
2437: } else {
2438: my @emptyResults = ();
2439: push(@emptyResults, 'missing user name');
2440: return split(':',@emptyResults);
2441: }
2442: } elsif(!defined($alternateDirectoryRoot)) {
2443: my $tryserver;
2444: my %alldom=();
2445: foreach $tryserver (keys %libserv) {
2446: $alldom{$hostdom{$tryserver}}=1;
2447: }
2448: my $alldomstr='';
2449: foreach (sort keys %alldom) {
2450: $alldomstr.=$perlvar{'lonDocRoot'}.'/res/'.$_.'&domain:';
2451: }
2452: $alldomstr=~s/:$//;
2453: return split(/:/,$alldomstr);
2454: } else {
2455: my @emptyResults = ();
2456: push(@emptyResults, 'missing domain');
2457: return split(':',@emptyResults);
2458: }
2459: }
2460:
2461: # --------------------------------------------- GetFileTimestamp
2462: # This function utilizes dirlist and returns the date stamp for
2463: # when it was last modified. It will also return an error of -1
2464: # if an error occurs
2465:
2466: sub GetFileTimestamp {
2467: my ($studentDomain,$studentName,$filename,$root)=@_;
2468: $studentDomain=~s/\W//g;
2469: $studentName=~s/\W//g;
2470: my $subdir=$studentName.'__';
2471: $subdir =~ s/(.)(.)(.).*/$1\/$2\/$3/;
2472: my $proname="$studentDomain/$subdir/$studentName";
2473: $proname .= '/'.$filename;
2474: my @dir = &Apache::lonnet::dirlist($proname, $studentDomain, $studentName,
2475: $root);
2476: my $fileStat = $dir[0];
2477: my @stats = split('&', $fileStat);
2478: if($stats[0] ne 'empty' && $stats[0] ne 'no_such_dir') {
2479: return $stats[9];
2480: } else {
2481: return -1;
2482: }
2483: }
2484:
2485: # -------------------------------------------------------- Value of a Condition
2486:
2487: sub directcondval {
2488: my $number=shift;
2489: if ($ENV{'user.state.'.$ENV{'request.course.id'}}) {
2490: return substr($ENV{'user.state.'.$ENV{'request.course.id'}},$number,1);
2491: } else {
2492: return 2;
2493: }
2494: }
2495:
2496: sub condval {
2497: my $condidx=shift;
2498: my $result=0;
2499: my $allpathcond='';
2500: foreach (split(/\|/,$condidx)) {
2501: if (defined($ENV{'acc.cond.'.$ENV{'request.course.id'}.'.'.$_})) {
2502: $allpathcond.=
2503: '('.$ENV{'acc.cond.'.$ENV{'request.course.id'}.'.'.$_}.')|';
2504: }
2505: }
2506: $allpathcond=~s/\|$//;
2507: if ($ENV{'request.course.id'}) {
2508: if ($allpathcond) {
2509: my $operand='|';
2510: my @stack;
2511: foreach ($allpathcond=~/(\d+|\(|\)|\&|\|)/g) {
2512: if ($_ eq '(') {
2513: push @stack,($operand,$result)
2514: } elsif ($_ eq ')') {
2515: my $before=pop @stack;
2516: if (pop @stack eq '&') {
2517: $result=$result>$before?$before:$result;
2518: } else {
2519: $result=$result>$before?$result:$before;
2520: }
2521: } elsif (($_ eq '&') || ($_ eq '|')) {
2522: $operand=$_;
2523: } else {
2524: my $new=directcondval($_);
2525: if ($operand eq '&') {
2526: $result=$result>$new?$new:$result;
2527: } else {
2528: $result=$result>$new?$result:$new;
2529: }
2530: }
2531: }
2532: }
2533: }
2534: return $result;
2535: }
2536:
2537: # --------------------------------------------------- Course Resourcedata Query
2538:
2539: sub courseresdata {
2540: my ($coursenum,$coursedomain,@which)=@_;
2541: my $coursehom=&homeserver($coursenum,$coursedomain);
2542: my $hashid=$coursenum.':'.$coursedomain;
2543: my $dodump=0;
2544: if (!defined($courseresdatacache{$hashid.'.time'})) {
2545: $dodump=1;
2546: } else {
2547: if (time-$courseresdatacache{$hashid.'.time'}>300) { $dodump=1; }
2548: }
2549: if ($dodump) {
2550: my %dumpreply=&dump('resourcedata',$coursedomain,$coursenum);
2551: my ($tmp) = keys(%dumpreply);
2552: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
2553: $courseresdatacache{$hashid.'.time'}=time;
2554: $courseresdatacache{$hashid}=\%dumpreply;
2555: }
2556: }
2557: foreach my $item (@which) {
2558: if ($courseresdatacache{$hashid}->{$item}) {
2559: return $courseresdatacache{$hashid}->{$item};
2560: }
2561: }
2562: return '';
2563: }
2564:
2565: # --------------------------------------------------------- Value of a Variable
2566:
2567: sub EXT {
2568: my ($varname,$symbparm,$udom,$uname)=@_;
2569:
2570: unless ($varname) { return ''; }
2571:
2572: #get real user name/domain, courseid and symb
2573: my $courseid;
2574: if (!($uname && $udom)) {
2575: (my $cursymb,$courseid,$udom,$uname)=&Apache::lonxml::whichuser();
2576: if (!$symbparm) { $symbparm=$cursymb; }
2577: } else {
2578: $courseid=$ENV{'request.course.id'};
2579: }
2580:
2581: my ($realm,$space,$qualifier,@therest)=split(/\./,$varname);
2582: my $rest;
2583: if ($therest[0]) {
2584: $rest=join('.',@therest);
2585: } else {
2586: $rest='';
2587: }
2588: my $qualifierrest=$qualifier;
2589: if ($rest) { $qualifierrest.='.'.$rest; }
2590: my $spacequalifierrest=$space;
2591: if ($qualifierrest) { $spacequalifierrest.='.'.$qualifierrest; }
2592: if ($realm eq 'user') {
2593: # --------------------------------------------------------------- user.resource
2594: if ($space eq 'resource') {
2595: my %restored=&restore(undef,undef,$udom,$uname);
2596: return $restored{$qualifierrest};
2597: # ----------------------------------------------------------------- user.access
2598: } elsif ($space eq 'access') {
2599: # FIXME - not supporting calls for a specific user
2600: return &allowed($qualifier,$rest);
2601: # ------------------------------------------ user.preferences, user.environment
2602: } elsif (($space eq 'preferences') || ($space eq 'environment')) {
2603: if (($uname eq $ENV{'user.name'}) &&
2604: ($udom eq $ENV{'user.domain'})) {
2605: return $ENV{join('.',('environment',$qualifierrest))};
2606: } else {
2607: my %returnhash=&userenvironment($udom,$uname,$qualifierrest);
2608: return $returnhash{$qualifierrest};
2609: }
2610: # ----------------------------------------------------------------- user.course
2611: } elsif ($space eq 'course') {
2612: # FIXME - not supporting calls for a specific user
2613: return $ENV{join('.',('request.course',$qualifier))};
2614: # ------------------------------------------------------------------- user.role
2615: } elsif ($space eq 'role') {
2616: # FIXME - not supporting calls for a specific user
2617: my ($role,$where)=split(/\./,$ENV{'request.role'});
2618: if ($qualifier eq 'value') {
2619: return $role;
2620: } elsif ($qualifier eq 'extent') {
2621: return $where;
2622: }
2623: # ----------------------------------------------------------------- user.domain
2624: } elsif ($space eq 'domain') {
2625: return $udom;
2626: # ------------------------------------------------------------------- user.name
2627: } elsif ($space eq 'name') {
2628: return $uname;
2629: # ---------------------------------------------------- Any other user namespace
2630: } else {
2631: my $item=($rest)?$qualifier.'.'.$rest:$qualifier;
2632: my %reply=&get($space,[$item]);
2633: return $reply{$item};
2634: }
2635: } elsif ($realm eq 'query') {
2636: # ---------------------------------------------- pull stuff out of query string
2637: &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},[$space]);
2638: return $ENV{'form.'.$space};
2639: } elsif ($realm eq 'request') {
2640: # ------------------------------------------------------------- request.browser
2641: if ($space eq 'browser') {
2642: return $ENV{'browser.'.$qualifier};
2643: # ------------------------------------------------------------ request.filename
2644: } else {
2645: return $ENV{'request.'.$spacequalifierrest};
2646: }
2647: } elsif ($realm eq 'course') {
2648: # ---------------------------------------------------------- course.description
2649: return $ENV{'course.'.$courseid.'.'.$spacequalifierrest};
2650: } elsif ($realm eq 'resource') {
2651:
2652: if ($courseid eq $ENV{'request.course.id'}) {
2653:
2654: #print '<br>'.$space.' - '.$qualifier.' - '.$spacequalifierrest;
2655:
2656: # ----------------------------------------------------- Cascading lookup scheme
2657: if (!$symbparm) { $symbparm=&symbread(); }
2658: my $symbp=$symbparm;
2659: my $mapp=(split(/\_\_\_/,$symbp))[0];
2660:
2661: my $symbparm=$symbp.'.'.$spacequalifierrest;
2662: my $mapparm=$mapp.'___(all).'.$spacequalifierrest;
2663:
2664: my $section;
2665: if (($ENV{'user.name'} eq $uname) &&
2666: ($ENV{'user.domain'} eq $udom)) {
2667: $section=$ENV{'request.course.sec'};
2668: } else {
2669: $section=&usection($udom,$uname,$courseid);
2670: }
2671:
2672: my $seclevel=$courseid.'.['.$section.'].'.$spacequalifierrest;
2673: my $seclevelr=$courseid.'.['.$section.'].'.$symbparm;
2674: my $seclevelm=$courseid.'.['.$section.'].'.$mapparm;
2675:
2676: my $courselevel=$courseid.'.'.$spacequalifierrest;
2677: my $courselevelr=$courseid.'.'.$symbparm;
2678: my $courselevelm=$courseid.'.'.$mapparm;
2679:
2680: # ----------------------------------------------------------- first, check user
2681: my %resourcedata=&get('resourcedata',
2682: [$courselevelr,$courselevelm,$courselevel],
2683: $udom,$uname);
2684: if (($resourcedata{$courselevelr}!~/^error\:/) &&
2685: ($resourcedata{$courselevelr}!~/^con_lost/)) {
2686:
2687: if ($resourcedata{$courselevelr}) {
2688: return $resourcedata{$courselevelr}; }
2689: if ($resourcedata{$courselevelm}) {
2690: return $resourcedata{$courselevelm}; }
2691: if ($resourcedata{$courselevel}) {
2692: return $resourcedata{$courselevel}; }
2693: } else {
2694: if ($resourcedata{$courselevelr}!~/No such file/) {
2695: &logthis("<font color=blue>WARNING:".
2696: " Trying to get resource data for ".
2697: $uname." at ".$udom.": ".
2698: $resourcedata{$courselevelr}."</font>");
2699: }
2700: }
2701:
2702: # -------------------------------------------------------- second, check course
2703:
2704: my $coursereply=&courseresdata($ENV{'course.'.$courseid.'.num'},
2705: $ENV{'course.'.$courseid.'.domain'},
2706: ($seclevelr,$seclevelm,$seclevel,
2707: $courselevelr,$courselevelm,
2708: $courselevel));
2709: if ($coursereply) { return $coursereply; }
2710:
2711: # ------------------------------------------------------ third, check map parms
2712: my %parmhash=();
2713: my $thisparm='';
2714: if (tie(%parmhash,'GDBM_File',
2715: $ENV{'request.course.fn'}.'_parms.db',
2716: &GDBM_READER(),0640)) {
2717: $thisparm=$parmhash{$symbparm};
2718: untie(%parmhash);
2719: }
2720: if ($thisparm) { return $thisparm; }
2721: }
2722: # --------------------------------------------- last, look in resource metadata
2723:
2724: $spacequalifierrest=~s/\./\_/;
2725: my $metadata=&metadata($ENV{'request.filename'},$spacequalifierrest);
2726: if ($metadata) { return $metadata; }
2727: $metadata=&metadata($ENV{'request.filename'},
2728: 'parameter_'.$spacequalifierrest);
2729: if ($metadata) { return $metadata; }
2730:
2731: # ------------------------------------------------------------------ Cascade up
2732: unless ($space eq '0') {
2733: my ($part,$id)=split(/\_/,$space);
2734: if ($id) {
2735: my $partgeneral=&EXT('resource.'.$part.'.'.$qualifierrest,
2736: $symbparm,$udom,$uname);
2737: if ($partgeneral) { return $partgeneral; }
2738: } else {
2739: my $resourcegeneral=&EXT('resource.0.'.$qualifierrest,
2740: $symbparm,$udom,$uname);
2741: if ($resourcegeneral) { return $resourcegeneral; }
2742: }
2743: }
2744:
2745: # ---------------------------------------------------- Any other user namespace
2746: } elsif ($realm eq 'environment') {
2747: # ----------------------------------------------------------------- environment
2748: if (($uname eq $ENV{'user.name'})&&($udom eq $ENV{'user.domain'})) {
2749: return $ENV{'environment.'.$spacequalifierrest};
2750: } else {
2751: my %returnhash=&userenvironment($udom,$uname,
2752: $spacequalifierrest);
2753: return $returnhash{$spacequalifierrest};
2754: }
2755: } elsif ($realm eq 'system') {
2756: # ----------------------------------------------------------------- system.time
2757: if ($space eq 'time') {
2758: return time;
2759: }
2760: }
2761: return '';
2762: }
2763:
2764: # ---------------------------------------------------------------- Get metadata
2765:
2766: sub metadata {
2767: my ($uri,$what,$liburi,$prefix,$depthcount)=@_;
2768:
2769: $uri=&declutter($uri);
2770: my $filename=$uri;
2771: $uri=~s/\.meta$//;
2772: #
2773: # Is the metadata already cached?
2774: # Look at timestamp of caching
2775: # Everything is cached by the main uri, libraries are never directly cached
2776: #
2777: unless (abs($metacache{$uri.':cachedtimestamp'}-time)<600 && !defined($liburi)) {
2778: #
2779: # Is this a recursive call for a library?
2780: #
2781: if ($liburi) {
2782: $liburi=&declutter($liburi);
2783: $filename=$liburi;
2784: }
2785: my %metathesekeys=();
2786: unless ($filename=~/\.meta$/) { $filename.='.meta'; }
2787: my $metastring=&getfile($perlvar{'lonDocRoot'}.'/res/'.$filename);
2788: my $parser=HTML::LCParser->new(\$metastring);
2789: my $token;
2790: undef %metathesekeys;
2791: while ($token=$parser->get_token) {
2792: if ($token->[0] eq 'S') {
2793: if (defined($token->[2]->{'package'})) {
2794: #
2795: # This is a package - get package info
2796: #
2797: my $package=$token->[2]->{'package'};
2798: my $keyroot='';
2799: if ($prefix) {
2800: $keyroot.=$prefix;
2801: } else {
2802: if (defined($token->[2]->{'part'})) {
2803: $keyroot.='_'.$token->[2]->{'part'};
2804: }
2805: }
2806: if (defined($token->[2]->{'id'})) {
2807: $keyroot.='_'.$token->[2]->{'id'};
2808: }
2809: if ($metacache{$uri.':packages'}) {
2810: $metacache{$uri.':packages'}.=','.$package.$keyroot;
2811: } else {
2812: $metacache{$uri.':packages'}=$package.$keyroot;
2813: }
2814: foreach (keys %packagetab) {
2815: if ($_=~/^$package\&/) {
2816: my ($pack,$name,$subp)=split(/\&/,$_);
2817: my $value=$packagetab{$_};
2818: my $part=$keyroot;
2819: $part=~s/^\_//;
2820: if ($subp eq 'display') {
2821: $value.=' [Part: '.$part.']';
2822: }
2823: my $unikey='parameter'.$keyroot.'_'.$name;
2824: $metathesekeys{$unikey}=1;
2825: $metacache{$uri.':'.$unikey.'.part'}=$part;
2826: unless
2827: (defined($metacache{$uri.':'.$unikey.'.'.$subp})) {
2828: $metacache{$uri.':'.$unikey.'.'.$subp}=$value;
2829: }
2830: }
2831: }
2832: } else {
2833: #
2834: # This is not a package - some other kind of start tag
2835: #
2836: my $entry=$token->[1];
2837: my $unikey;
2838: if ($entry eq 'import') {
2839: $unikey='';
2840: } else {
2841: $unikey=$entry;
2842: }
2843: if ($prefix) {
2844: $unikey.=$prefix;
2845: } else {
2846: if (defined($token->[2]->{'part'})) {
2847: $unikey.='_'.$token->[2]->{'part'};
2848: }
2849: }
2850: if (defined($token->[2]->{'id'})) {
2851: $unikey.='_'.$token->[2]->{'id'};
2852: }
2853:
2854: if ($entry eq 'import') {
2855: #
2856: # Importing a library here
2857: #
2858: if ($depthcount<20) {
2859: my $location=$parser->get_text('/import');
2860: my $dir=$filename;
2861: $dir=~s|[^/]*$||;
2862: $location=&filelocation($dir,$location);
2863: foreach (sort(split(/\,/,&metadata($uri,'keys',
2864: $location,$unikey,
2865: $depthcount+1)))) {
2866: $metathesekeys{$_}=1;
2867: }
2868: }
2869: } else {
2870:
2871: if (defined($token->[2]->{'name'})) {
2872: $unikey.='_'.$token->[2]->{'name'};
2873: }
2874: $metathesekeys{$unikey}=1;
2875: foreach (@{$token->[3]}) {
2876: $metacache{$uri.':'.$unikey.'.'.$_}=$token->[2]->{$_};
2877: }
2878: unless (
2879: $metacache{$uri.':'.$unikey}=&HTML::Entities::decode($parser->get_text('/'.$entry))
2880: ) { $metacache{$uri.':'.$unikey}=
2881: $metacache{$uri.':'.$unikey.'.default'};
2882: }
2883: # end of not-a-package not-a-library import
2884: }
2885: # end of not-a-package start tag
2886: }
2887: # the next is the end of "start tag"
2888: }
2889: }
2890: $metacache{$uri.':keys'}=join(',',keys %metathesekeys);
2891: &metadata_generate_part0(\%metathesekeys,\%metacache,$uri);
2892: $metacache{$uri.':allpossiblekeys'}=join(',',keys %metathesekeys);
2893: $metacache{$uri.':cachedtimestamp'}=time;
2894: # this is the end of "was not already recently cached
2895: }
2896: return $metacache{$uri.':'.$what};
2897: }
2898:
2899: sub metadata_generate_part0 {
2900: my ($metadata,$metacache,$uri) = @_;
2901: my %allnames;
2902: foreach my $metakey (sort keys %$metadata) {
2903: if ($metakey=~/^parameter\_(.*)/) {
2904: my $part=$$metacache{$uri.':'.$metakey.'.part'};
2905: my $name=$$metacache{$uri.':'.$metakey.'.name'};
2906: if (! exists($$metadata{'parameter_0_'.$name})) {
2907: $allnames{$name}=$part;
2908: }
2909: }
2910: }
2911: foreach my $name (keys(%allnames)) {
2912: $$metadata{"parameter_0_$name"}=1;
2913: my $key="$uri:parameter_0_$name";
2914: $$metacache{"$key.part"}='0';
2915: $$metacache{"$key.name"}=$name;
2916: $$metacache{"$key.type"}=$$metacache{$uri.':parameter_'.
2917: $allnames{$name}.'_'.$name.
2918: '.type'};
2919: my $olddis=$$metacache{$uri.':parameter_'.$allnames{$name}.'_'.$name.
2920: '.display'};
2921: my $expr='\\[Part: '.$allnames{$name}.'\\]';
2922: $olddis=~s/$expr/\[Part: 0\]/;
2923: $$metacache{"$key.display"}=$olddis;
2924: }
2925: }
2926:
2927: # ------------------------------------------------- Update symbolic store links
2928:
2929: sub symblist {
2930: my ($mapname,%newhash)=@_;
2931: $mapname=declutter($mapname);
2932: my %hash;
2933: if (($ENV{'request.course.fn'}) && (%newhash)) {
2934: if (tie(%hash,'GDBM_File',$ENV{'request.course.fn'}.'_symb.db',
2935: &GDBM_WRCREAT(),0640)) {
2936: foreach (keys %newhash) {
2937: $hash{declutter($_)}=$mapname.'___'.$newhash{$_};
2938: }
2939: if (untie(%hash)) {
2940: return 'ok';
2941: }
2942: }
2943: }
2944: return 'error';
2945: }
2946:
2947: # --------------------------------------------------------------- Verify a symb
2948:
2949: sub symbverify {
2950: my ($symb,$thisfn)=@_;
2951: $thisfn=&declutter($thisfn);
2952: # direct jump to resource in page or to a sequence - will construct own symbs
2953: if ($thisfn=~/\.(page|sequence)$/) { return 1; }
2954: # check URL part
2955: my ($map,$resid,$url)=split(/\_\_\_/,$symb);
2956: unless (&symbclean($url) eq &symbclean($thisfn)) { return 0; }
2957:
2958: $symb=&symbclean($symb);
2959:
2960: my %bighash;
2961: my $okay=0;
2962: if (tie(%bighash,'GDBM_File',$ENV{'request.course.fn'}.'.db',
2963: &GDBM_READER(),0640)) {
2964: my $ids=$bighash{'ids_/res/'.$thisfn};
2965: unless ($ids) {
2966: $ids=$bighash{'ids_/'.$thisfn};
2967: }
2968: if ($ids) {
2969: # ------------------------------------------------------------------- Has ID(s)
2970: foreach (split(/\,/,$ids)) {
2971: my ($mapid,$resid)=split(/\./,$_);
2972: if (
2973: &symbclean(&declutter($bighash{'map_id_'.$mapid}).'___'.$resid.'___'.$thisfn)
2974: eq $symb) {
2975: $okay=1;
2976: }
2977: }
2978: }
2979: untie(%bighash);
2980: }
2981: return $okay;
2982: }
2983:
2984: # --------------------------------------------------------------- Clean-up symb
2985:
2986: sub symbclean {
2987: my $symb=shift;
2988:
2989: # remove version from map
2990: $symb=~s/\.(\d+)\.(\w+)\_\_\_/\.$2\_\_\_/;
2991:
2992: # remove version from URL
2993: $symb=~s/\.(\d+)\.(\w+)$/\.$2/;
2994:
2995: return $symb;
2996: }
2997:
2998: # ------------------------------------------------------ Return symb list entry
2999:
3000: sub symbread {
3001: my ($thisfn,$donotrecurse)=@_;
3002: # no filename provided? try from environment
3003: unless ($thisfn) {
3004: if ($ENV{'request.symb'}) { return &symbclean($ENV{'request.symb'}); }
3005: $thisfn=$ENV{'request.filename'};
3006: }
3007: # is that filename actually a symb? Verify, clean, and return
3008: if ($thisfn=~/\_\_\_\d+\_\_\_(.*)$/) {
3009: if (&symbverify($thisfn,$1)) { return &symbclean($thisfn); }
3010: }
3011: $thisfn=declutter($thisfn);
3012: my %hash;
3013: my %bighash;
3014: my $syval='';
3015: if (($ENV{'request.course.fn'}) && ($thisfn)) {
3016: if (tie(%hash,'GDBM_File',$ENV{'request.course.fn'}.'_symb.db',
3017: &GDBM_READER(),0640)) {
3018: $syval=$hash{$thisfn};
3019: untie(%hash);
3020: }
3021: # ---------------------------------------------------------- There was an entry
3022: if ($syval) {
3023: unless ($syval=~/\_\d+$/) {
3024: unless ($ENV{'form.request.prefix'}=~/\.(\d+)\_$/) {
3025: &appenv('request.ambiguous' => $thisfn);
3026: return '';
3027: }
3028: $syval.=$1;
3029: }
3030: } else {
3031: # ------------------------------------------------------- Was not in symb table
3032: if (tie(%bighash,'GDBM_File',$ENV{'request.course.fn'}.'.db',
3033: &GDBM_READER(),0640)) {
3034: # ---------------------------------------------- Get ID(s) for current resource
3035: my $ids=$bighash{'ids_/res/'.$thisfn};
3036: unless ($ids) {
3037: $ids=$bighash{'ids_/'.$thisfn};
3038: }
3039: unless ($ids) {
3040: # alias?
3041: $ids=$bighash{'mapalias_'.$thisfn};
3042: }
3043: if ($ids) {
3044: # ------------------------------------------------------------------- Has ID(s)
3045: my @possibilities=split(/\,/,$ids);
3046: if ($#possibilities==0) {
3047: # ----------------------------------------------- There is only one possibility
3048: my ($mapid,$resid)=split(/\./,$ids);
3049: $syval=declutter($bighash{'map_id_'.$mapid}).'___'.$resid;
3050: } elsif (!$donotrecurse) {
3051: # ------------------------------------------ There is more than one possibility
3052: my $realpossible=0;
3053: foreach (@possibilities) {
3054: my $file=$bighash{'src_'.$_};
3055: if (&allowed('bre',$file)) {
3056: my ($mapid,$resid)=split(/\./,$_);
3057: if ($bighash{'map_type_'.$mapid} ne 'page') {
3058: $realpossible++;
3059: $syval=declutter($bighash{'map_id_'.$mapid}).
3060: '___'.$resid;
3061: }
3062: }
3063: }
3064: if ($realpossible!=1) { $syval=''; }
3065: } else {
3066: $syval='';
3067: }
3068: }
3069: untie(%bighash)
3070: }
3071: }
3072: if ($syval) {
3073: return &symbclean($syval.'___'.$thisfn);
3074: }
3075: }
3076: &appenv('request.ambiguous' => $thisfn);
3077: return '';
3078: }
3079:
3080: # ---------------------------------------------------------- Return random seed
3081:
3082: sub numval {
3083: my $txt=shift;
3084: $txt=~tr/A-J/0-9/;
3085: $txt=~tr/a-j/0-9/;
3086: $txt=~tr/K-T/0-9/;
3087: $txt=~tr/k-t/0-9/;
3088: $txt=~tr/U-Z/0-5/;
3089: $txt=~tr/u-z/0-5/;
3090: $txt=~s/\D//g;
3091: return int($txt);
3092: }
3093:
3094: sub rndseed {
3095: my ($symb,$courseid,$domain,$username)=@_;
3096: if (!$symb) {
3097: unless ($symb=&symbread()) { return time; }
3098: }
3099: if (!$courseid) { $courseid=$ENV{'request.course.id'};}
3100: if (!$domain) {$domain=$ENV{'user.domain'};}
3101: if (!$username) {$username=$ENV{'user.name'};}
3102: {
3103: use integer;
3104: my $symbchck=unpack("%32C*",$symb) << 27;
3105: my $symbseed=numval($symb) << 22;
3106: my $namechck=unpack("%32C*",$username) << 17;
3107: my $nameseed=numval($username) << 12;
3108: my $domainseed=unpack("%32C*",$domain) << 7;
3109: my $courseseed=unpack("%32C*",$courseid);
3110: my $num=$symbseed+$nameseed+$domainseed+$courseseed+$namechck+$symbchck;
3111: #uncommenting these lines can break things!
3112: #&Apache::lonxml::debug("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
3113: #&Apache::lonxml::debug("rndseed :$num:$symb");
3114: return $num;
3115: }
3116: }
3117:
3118: sub ireceipt {
3119: my ($funame,$fudom,$fucourseid,$fusymb)=@_;
3120: my $cuname=unpack("%32C*",$funame);
3121: my $cudom=unpack("%32C*",$fudom);
3122: my $cucourseid=unpack("%32C*",$fucourseid);
3123: my $cusymb=unpack("%32C*",$fusymb);
3124: my $cunique=unpack("%32C*",$perlvar{'lonReceipt'});
3125: return unpack("%32C*",$perlvar{'lonHostID'}).'-'.
3126: ($cunique%$cuname+
3127: $cunique%$cudom+
3128: $cusymb%$cuname+
3129: $cusymb%$cudom+
3130: $cucourseid%$cuname+
3131: $cucourseid%$cudom);
3132: }
3133:
3134: sub receipt {
3135: my ($symb,$courseid,$domain,$name) = &Apache::lonxml::whichuser();
3136: return &ireceipt($name,$domain,$courseid,$symb);
3137: }
3138:
3139: # ------------------------------------------------------------ Serves up a file
3140: # returns either the contents of the file or a -1
3141: sub getfile {
3142: my $file=shift;
3143: if ($file=~/^\/*uploaded\//) { # user file
3144: my $ua=new LWP::UserAgent;
3145: my $request=new HTTP::Request('GET',&tokenwrapper($file));
3146: my $response=$ua->request($request);
3147: if ($response->is_success()) {
3148: return $response->content;
3149: } else {
3150: return -1;
3151: }
3152: } else { # normal file from res space
3153: &repcopy($file);
3154: if (! -e $file ) { return -1; };
3155: my $fh=Apache::File->new($file);
3156: my $a='';
3157: while (<$fh>) { $a .=$_; }
3158: return $a;
3159: }
3160: }
3161:
3162: sub filelocation {
3163: my ($dir,$file) = @_;
3164: my $location;
3165: $file=~ s/^\s*(\S+)\s*$/$1/; ## strip off leading and trailing spaces
3166: if ($file=~m:^/~:) { # is a contruction space reference
3167: $location = $file;
3168: $location =~ s:/~(.*?)/(.*):/home/$1/public_html/$2:;
3169: } elsif ($file=~/^\/*uploaded/) { # is an uploaded file
3170: $location=$file;
3171: } else {
3172: $file=~s/^$perlvar{'lonDocRoot'}//;
3173: $file=~s:^/*res::;
3174: if ( !( $file =~ m:^/:) ) {
3175: $location = $dir. '/'.$file;
3176: } else {
3177: $location = '/home/httpd/html/res'.$file;
3178: }
3179: }
3180: $location=~s://+:/:g; # remove duplicate /
3181: while ($location=~m:/\.\./:) {$location=~ s:/[^/]+/\.\./:/:g;} #remove dir/..
3182: return $location;
3183: }
3184:
3185: sub hreflocation {
3186: my ($dir,$file)=@_;
3187: unless (($file=~/^http:\/\//i) || ($file=~/^\//)) {
3188: my $finalpath=filelocation($dir,$file);
3189: $finalpath=~s/^\/home\/httpd\/html//;
3190: $finalpath=~s-/home/(\w+)/public_html/-/~$1/-;
3191: return $finalpath;
3192: } else {
3193: return $file;
3194: }
3195: }
3196:
3197: # ------------------------------------------------------------- Declutters URLs
3198:
3199: sub declutter {
3200: my $thisfn=shift;
3201: $thisfn=~s/^$perlvar{'lonDocRoot'}//;
3202: $thisfn=~s/^\///;
3203: $thisfn=~s/^res\///;
3204: $thisfn=~s/\?.+$//;
3205: return $thisfn;
3206: }
3207:
3208: # ------------------------------------------------------------- Clutter up URLs
3209:
3210: sub clutter {
3211: my $thisfn='/'.&declutter(shift);
3212: unless ($thisfn=~/^\/(uploaded|adm|userfiles|ext|raw|priv)\//) {
3213: $thisfn='/res'.$thisfn;
3214: }
3215: return $thisfn;
3216: }
3217:
3218: # -------------------------------------------------------- Escape Special Chars
3219:
3220: sub escape {
3221: my $str=shift;
3222: $str =~ s/(\W)/"%".unpack('H2',$1)/eg;
3223: return $str;
3224: }
3225:
3226: # ----------------------------------------------------- Un-Escape Special Chars
3227:
3228: sub unescape {
3229: my $str=shift;
3230: $str =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
3231: return $str;
3232: }
3233:
3234: # ================================================================ Main Program
3235:
3236: sub goodbye {
3237: &logthis("Starting Shut down");
3238: &flushcourselogs();
3239: &logthis("Shutting down");
3240: }
3241:
3242: BEGIN {
3243: # ----------------------------------- Read loncapa.conf and loncapa_apache.conf
3244: unless ($readit) {
3245: {
3246: my $config=Apache::File->new("/etc/httpd/conf/loncapa.conf");
3247:
3248: while (my $configline=<$config>) {
3249: if ($configline =~ /^[^\#]*PerlSetVar/) {
3250: my ($dummy,$varname,$varvalue)=split(/\s+/,$configline);
3251: chomp($varvalue);
3252: $perlvar{$varname}=$varvalue;
3253: }
3254: }
3255: }
3256: {
3257: my $config=Apache::File->new("/etc/httpd/conf/loncapa_apache.conf");
3258:
3259: while (my $configline=<$config>) {
3260: if ($configline =~ /^[^\#]*PerlSetVar/) {
3261: my ($dummy,$varname,$varvalue)=split(/\s+/,$configline);
3262: chomp($varvalue);
3263: $perlvar{$varname}=$varvalue;
3264: }
3265: }
3266: }
3267:
3268: # ------------------------------------------------------------- Read hosts file
3269: {
3270: my $config=Apache::File->new("$perlvar{'lonTabDir'}/hosts.tab");
3271:
3272: while (my $configline=<$config>) {
3273: chomp($configline);
3274: my ($id,$domain,$role,$name,$ip,$domdescr)=split(/:/,$configline);
3275: if ($id && $domain && $role && $name && $ip) {
3276: $hostname{$id}=$name;
3277: $hostdom{$id}=$domain;
3278: $hostip{$id}=$ip;
3279: if ($domdescr) { $domaindescription{$domain}=$domdescr; }
3280: if ($role eq 'library') { $libserv{$id}=$name; }
3281: } else {
3282: if ($configline) {
3283: &logthis("Skipping hosts.tab line -$configline-");
3284: }
3285: }
3286: }
3287: }
3288:
3289: # ------------------------------------------------------ Read spare server file
3290: {
3291: my $config=Apache::File->new("$perlvar{'lonTabDir'}/spare.tab");
3292:
3293: while (my $configline=<$config>) {
3294: chomp($configline);
3295: if (($configline) && ($configline ne $perlvar{'lonHostID'})) {
3296: $spareid{$configline}=1;
3297: }
3298: }
3299: }
3300: # ------------------------------------------------------------ Read permissions
3301: {
3302: my $config=Apache::File->new("$perlvar{'lonTabDir'}/roles.tab");
3303:
3304: while (my $configline=<$config>) {
3305: chomp($configline);
3306: if ($configline) {
3307: my ($role,$perm)=split(/ /,$configline);
3308: if ($perm ne '') { $pr{$role}=$perm; }
3309: }
3310: }
3311: }
3312:
3313: # -------------------------------------------- Read plain texts for permissions
3314: {
3315: my $config=Apache::File->new("$perlvar{'lonTabDir'}/rolesplain.tab");
3316:
3317: while (my $configline=<$config>) {
3318: chomp($configline);
3319: if ($configline) {
3320: my ($short,$plain)=split(/:/,$configline);
3321: if ($plain ne '') { $prp{$short}=$plain; }
3322: }
3323: }
3324: }
3325:
3326: # ---------------------------------------------------------- Read package table
3327: {
3328: my $config=Apache::File->new("$perlvar{'lonTabDir'}/packages.tab");
3329:
3330: while (my $configline=<$config>) {
3331: chomp($configline);
3332: my ($short,$plain)=split(/:/,$configline);
3333: my ($pack,$name)=split(/\&/,$short);
3334: if ($plain ne '') {
3335: $packagetab{$pack.'&'.$name.'&name'}=$name;
3336: $packagetab{$short}=$plain;
3337: }
3338: }
3339: }
3340:
3341: %metacache=();
3342:
3343: $processmarker=$$.'_'.time.'_'.$perlvar{'lonHostID'};
3344: $dumpcount=0;
3345:
3346: &logtouch();
3347: &logthis('<font color=yellow>INFO: Read configuration</font>');
3348: $readit=1;
3349: }
3350: }
3351:
3352: 1;
3353: __END__
3354:
3355: =pod
3356:
3357: =head1 NAME
3358:
3359: Apache::lonnet - Subroutines to ask questions about things in the network.
3360:
3361: =head1 SYNOPSIS
3362:
3363: Invoked by other LON-CAPA modules, when they need to talk to or about objects in the network.
3364:
3365: &Apache::lonnet::SUBROUTINENAME(ARGUMENTS);
3366:
3367: Common parameters:
3368:
3369: =over 4
3370:
3371: =item *
3372:
3373: $uname : an internal username (if $cname expecting a course Id specifically)
3374:
3375: =item *
3376:
3377: $udom : a domain (if $cdom expecting a course's domain specifically)
3378:
3379: =item *
3380:
3381: $symb : a resource instance identifier
3382:
3383: =item *
3384:
3385: $namespace : the name of a .db file that contains the data needed or
3386: being set.
3387:
3388: =back
3389:
3390: =head1 INTRODUCTION
3391:
3392: This module provides subroutines which interact with the
3393: lonc/lond (TCP) network layer of LON-CAPA. And Can be used to ask about
3394: - classes
3395: - users
3396: - resources
3397:
3398: For many of these objects you can also use this to store data about
3399: them or modify them in various ways.
3400:
3401: This is part of the LearningOnline Network with CAPA project
3402: described at http://www.lon-capa.org.
3403:
3404: =head1 RETURN MESSAGES
3405:
3406: =over 4
3407:
3408: =item *
3409:
3410: con_lost : unable to contact remote host
3411:
3412: =item *
3413:
3414: con_delayed : unable to contact remote host, message will be delivered
3415: when the connection is brought back up
3416:
3417: =item *
3418:
3419: con_failed : unable to contact remote host and unable to save message
3420: for later delivery
3421:
3422: =item *
3423:
3424: error: : an error a occured, a description of the error follows the :
3425:
3426: =item *
3427:
3428: no_such_host : unable to fund a host associated with the user/domain
3429: that was requested
3430:
3431: =back
3432:
3433: =head1 PUBLIC SUBROUTINES
3434:
3435: =head2 Session Environment Functions
3436:
3437: =over 4
3438:
3439: =item *
3440:
3441: appenv(%hash) : the value of %hash is written to the user envirnoment
3442: file, and will be restored for each access this user makes during this
3443: session, also modifies the %ENV for the current process
3444:
3445: =item *
3446:
3447: delenv($regexp) : removes all items from the session environment file that matches the regular expression in $regexp. The values are also delted from the current processes %ENV.
3448:
3449: =back
3450:
3451: =head2 User Information
3452:
3453: =over 4
3454:
3455: =item *
3456:
3457: queryauthenticate($uname,$udom) : try to determine user's current
3458: authentication scheme
3459:
3460: =item *
3461:
3462: authenticate($uname,$upass,$udom) : try to authenticate user from domain's lib
3463: servers (first use the current one), $upass should be the users password
3464:
3465: =item *
3466:
3467: homeserver($uname,$udom) : find the server which has the user's
3468: directory and files (there must be only one), this caches the answer,
3469: and also caches if there is a borken connection.
3470:
3471: =item *
3472:
3473: idget($udom,@ids) : find the usernames behind a list of IDs (IDs are a
3474: unique resource in a domain, there must be only 1 ID per username, and
3475: only 1 username per ID in a specific domain) (returns hash:
3476: id=>name,id=>name)
3477:
3478: =item *
3479:
3480: idrget($udom,@unames) : find the IDs behind a list of usernames (returns hash:
3481: name=>id,name=>id)
3482:
3483: =item *
3484:
3485: idput($udom,%ids) : store away a list of names and associated IDs
3486:
3487: =item *
3488:
3489: rolesinit($udom,$username,$authhost) : get user privileges
3490:
3491: =item *
3492:
3493: usection($udom,$uname,$cname) : finds the section of student in the
3494: course $cname, return section name/number or '' for "not in course"
3495: and '-1' for "no section"
3496:
3497: =item *
3498:
3499: userenvironment($udom,$uname,@what) : gets the values of the keys
3500: passed in @what from the requested user's environment, returns a hash
3501:
3502: =back
3503:
3504: =head2 User Roles
3505:
3506: =over 4
3507:
3508: =item *
3509:
3510: allowed($priv,$uri) : check for a user privilege; returns codes for allowed
3511: actions
3512: F: full access
3513: U,I,K: authentication modes (cxx only)
3514: '': forbidden
3515: 1: user needs to choose course
3516: 2: browse allowed
3517:
3518: =item *
3519:
3520: definerole($rolename,$sysrole,$domrole,$courole) : define role; define a custom
3521: role rolename set privileges in format of lonTabs/roles.tab for system, domain,
3522: and course level
3523:
3524: =item *
3525:
3526: plaintext($short) : return value in %prp hash (rolesplain.tab); plain text
3527: explanation of a user role term
3528:
3529: =back
3530:
3531: =head2 User Modification
3532:
3533: =over 4
3534:
3535: =item *
3536:
3537: assignrole($udom,$uname,$url,$role,$end,$start) : assign role; give a role to a
3538: user for the level given by URL. Optional start and end dates (leave empty
3539: string or zero for "no date")
3540:
3541: =item *
3542:
3543: changepass($uname,$udom,$currentpass,$newpass,$server) : attempts to
3544: change a users, password, possible return values are: ok,
3545: pwchange_failure, non_authorized, auth_mode_error, unknown_user,
3546: refused
3547:
3548: =item *
3549:
3550: modifyuserauth($udom,$uname,$umode,$upass) : modify user authentication
3551:
3552: =item *
3553:
3554: modifyuser($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene) :
3555: modify user
3556:
3557: =item *
3558:
3559: modifystudent($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene,$usec,$end,$start) : modify student
3560:
3561: =item *
3562:
3563: assigncustomrole($udom,$uname,$url,$rdom,$rnam,$rolename,$end,$start) : assign
3564: custom role; give a custom role to a user for the level given by URL. Specify
3565: name and domain of role author, and role name
3566:
3567: =item *
3568:
3569: revokerole($udom,$uname,$url,$role) : revoke a role for url
3570:
3571: =item *
3572:
3573: revokecustomrole($udom,$uname,$url,$role) : revoke a custom role
3574:
3575: =back
3576:
3577: =head2 Course Infomation
3578:
3579: =over 4
3580:
3581: =item *
3582:
3583: coursedescription($courseid) : course description
3584:
3585: =item *
3586:
3587: courseresdata($coursenum,$coursedomain,@which) : request for current
3588: parameter setting for a specific course, @what should be a list of
3589: parameters to ask about. This routine caches answers for 5 minutes.
3590:
3591: =back
3592:
3593: =head2 Course Modification
3594:
3595: =over 4
3596:
3597: =item *
3598:
3599: writecoursepref($courseid,%prefs) : write preferences (environment
3600: database) for a course
3601:
3602: =item *
3603:
3604: createcourse($udom,$description,$url) : make/modify course
3605:
3606: =back
3607:
3608: =head2 Resource Subroutines
3609:
3610: =over 4
3611:
3612: =item *
3613:
3614: subscribe($fname) : subscribe to a resource, returns URL if possible (probably should use repcopy instead)
3615:
3616: =item *
3617:
3618: repcopy($filename) : subscribes to the requested file, and attempts to
3619: replicate from the owning library server, Might return
3620: HTTP_SERVICE_UNAVAILABLE, HTTP_NOT_FOUND, FORBIDDEN, OK, or
3621: HTTP_BAD_REQUEST, also attempts to grab the metadata for the
3622: resource. Expects the local filesystem pathname
3623: (/home/httpd/html/res/....)
3624:
3625: =back
3626:
3627: =head2 Resource Information
3628:
3629: =over 4
3630:
3631: =item *
3632:
3633: EXT($varname,$symb,$udom,$uname) : evaluates and returns the value of
3634: a vairety of different possible values, $varname should be a request
3635: string, and the other parameters can be used to specify who and what
3636: one is asking about.
3637:
3638: Possible values for $varname are environment.lastname (or other item
3639: from the envirnment hash), user.name (or someother aspect about the
3640: user), resource.0.maxtries (or some other part and parameter of a
3641: resource)
3642:
3643: =item *
3644:
3645: directcondval($number) : get current value of a condition; reads from a state
3646: string
3647:
3648: =item *
3649:
3650: condval($condidx) : value of condition index based on state
3651:
3652: =item *
3653:
3654: metadata($uri,$what,$liburi,$prefix,$depthcount) : request a
3655: resource's metadata, $what should be either a specific key, or either
3656: 'keys' (to get a list of possible keys) or 'packages' to get a list of
3657: packages that this resource currently uses, the last 3 arguments are only used internally for recursive metadata.
3658:
3659: this function automatically caches all requests
3660:
3661: =item *
3662:
3663: metadata_query($query,$custom,$customshow) : make a metadata query against the
3664: network of library servers; returns file handle of where SQL and regex results
3665: will be stored for query
3666:
3667: =item *
3668:
3669: symbread($filename) : return symbolic list entry (filename argument optional);
3670: returns the data handle
3671:
3672: =item *
3673:
3674: symbverify($symb,$thisfn) : verifies that $symb actually exists and is
3675: a possible symb for the URL in $thisfn, returns a 1 on success, 0 on
3676: failure, user must be in a course, as it assumes the existance of the
3677: course initi hash, and uses $ENV('request.course.id'}
3678:
3679:
3680: =item *
3681:
3682: symbclean($symb) : removes versions numbers from a symb, returns the
3683: cleaned symb
3684:
3685: =item *
3686:
3687: is_on_map($uri) : checks if the $uri is somewhere on the current
3688: course map, user must be in a course for it to work.
3689:
3690: =item *
3691:
3692: numval($salt) : return random seed value (addend for rndseed)
3693:
3694: =item *
3695:
3696: rndseed($symb,$courseid,$udom,$uname) : create a random sum; returns
3697: a random seed, all arguments are optional, if they aren't sent it uses the
3698: environment to derive them. Note: if symb isn't sent and it can't get one
3699: from &symbread it will use the current time as its return value
3700:
3701: =item *
3702:
3703: ireceipt($funame,$fudom,$fucourseid,$fusymb) : return unique,
3704: unfakeable, receipt
3705:
3706: =item *
3707:
3708: receipt() : API to ireceipt working off of ENV values; given out to users
3709:
3710: =item *
3711:
3712: countacc($url) : count the number of accesses to a given URL
3713:
3714: =item *
3715:
3716: 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
3717:
3718: =item *
3719:
3720: 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)
3721:
3722: =item *
3723:
3724: expirespread($uname,$udom,$stype,$usymb) : set expire date for spreadsheet
3725:
3726: =item *
3727:
3728: devalidate($symb) : devalidate temporary spreadsheet calculations,
3729: forcing spreadsheet to reevaluate the resource scores next time.
3730:
3731: =back
3732:
3733: =head2 Storing/Retreiving Data
3734:
3735: =over 4
3736:
3737: =item *
3738:
3739: store($storehash,$symb,$namespace,$udom,$uname) : stores hash permanently
3740: for this url; hashref needs to be given and should be a \%hashname; the
3741: remaining args aren't required and if they aren't passed or are '' they will
3742: be derived from the ENV
3743:
3744: =item *
3745:
3746: cstore($storehash,$symb,$namespace,$udom,$uname) : same as store but
3747: uses critical subroutine
3748:
3749: =item *
3750:
3751: restore($symb,$namespace,$udom,$uname) : returns hash for this symb;
3752: all args are optional
3753:
3754: =item *
3755:
3756: tmpstore($storehash,$symb,$namespace,$udom,$uname) : storage that
3757: works very similar to store/cstore, but all data is stored in a
3758: temporary location and can be reset using tmpreset, $storehash should
3759: be a hash reference, returns nothing on success
3760:
3761: =item *
3762:
3763: tmprestore($symb,$namespace,$udom,$uname) : storage that works very
3764: similar to restore, but all data is stored in a temporary location and
3765: can be reset using tmpreset. Returns a hash of values on success,
3766: error string otherwise.
3767:
3768: =item *
3769:
3770: tmpreset($symb,$namespace,$udom,$uname) : temporary storage reset,
3771: deltes all keys for $symb form the temporary storage hash.
3772:
3773: =item *
3774:
3775: get($namespace,$storearr,$udom,$uname) : returns hash with keys from array
3776: reference filled in from namesp ($udom and $uname are optional)
3777:
3778: =item *
3779:
3780: del($namespace,$storearr,$udom,$uname) : deletes keys out of array from
3781: namesp ($udom and $uname are optional)
3782:
3783: =item *
3784:
3785: dump($namespace,$udom,$uname,$regexp) :
3786: dumps the complete (or key matching regexp) namespace into a hash
3787: ($udom, $uname and $regexp are optional)
3788:
3789: =item *
3790:
3791: put($namespace,$storehash,$udom,$uname) : stores hash in namesp
3792: ($udom and $uname are optional)
3793:
3794: =item *
3795:
3796: cput($namespace,$storehash,$udom,$uname) : critical put
3797: ($udom and $uname are optional)
3798:
3799: =item *
3800:
3801: eget($namespace,$storearr,$udom,$uname) : returns hash with keys from array
3802: reference filled in from namesp (encrypts the return communication)
3803: ($udom and $uname are optional)
3804:
3805: =item *
3806:
3807: log($udom,$name,$home,$message) : write to permanent log for user; use
3808: critical subroutine
3809:
3810: =back
3811:
3812: =head2 Network Status Functions
3813:
3814: =over 4
3815:
3816: =item *
3817:
3818: dirlist($uri) : return directory list based on URI
3819:
3820: =item *
3821:
3822: spareserver() : find server with least workload from spare.tab
3823:
3824: =back
3825:
3826: =head2 Apache Request
3827:
3828: =over 4
3829:
3830: =item *
3831:
3832: ssi($url,%hash) : server side include, does a complete request cycle on url to
3833: localhost, posts hash
3834:
3835: =back
3836:
3837: =head2 Data to String to Data
3838:
3839: =over 4
3840:
3841: =item *
3842:
3843: hash2str(%hash) : convert a hash into a string complete with escaping and '='
3844: and '&' separators, supports elements that are arrayrefs and hashrefs
3845:
3846: =item *
3847:
3848: hashref2str($hashref) : convert a hashref into a string complete with
3849: escaping and '=' and '&' separators, supports elements that are
3850: arrayrefs and hashrefs
3851:
3852: =item *
3853:
3854: arrayref2str($arrayref) : convert an arrayref into a string complete
3855: with escaping and '&' separators, supports elements that are arrayrefs
3856: and hashrefs
3857:
3858: =item *
3859:
3860: str2hash($string) : convert string to hash using unescaping and
3861: splitting on '=' and '&', supports elements that are arrayrefs and
3862: hashrefs
3863:
3864: =item *
3865:
3866: str2array($string) : convert string to hash using unescaping and
3867: splitting on '&', supports elements that are arrayrefs and hashrefs
3868:
3869: =back
3870:
3871: =head2 Logging Routines
3872:
3873: =over 4
3874:
3875: These routines allow one to make log messages in the lonnet.log and
3876: lonnet.perm logfiles.
3877:
3878: =item *
3879:
3880: logtouch() : make sure the logfile, lonnet.log, exists
3881:
3882: =item *
3883:
3884: logthis() : append message to the normal lonnet.log file, it gets
3885: preiodically rolled over and deleted.
3886:
3887: =item *
3888:
3889: logperm() : append a permanent message to lonnet.perm.log, this log
3890: file never gets deleted by any automated portion of the system, only
3891: messages of critical importance should go in here.
3892:
3893: =back
3894:
3895: =head2 General File Helper Routines
3896:
3897: =over 4
3898:
3899: =item *
3900:
3901: getfile($file) : returns the entire contents of a file or -1; it
3902: properly subscribes to and replicates the file if neccessary.
3903:
3904: =item *
3905:
3906: filelocation($dir,$file) : returns file system location of a file
3907: based on URI; meant to be "fairly clean" absolute reference, $dir is a
3908: directory that relative $file lookups are to looked in ($dir of /a/dir
3909: and a file of ../bob will become /a/bob)
3910:
3911: =item *
3912:
3913: hreflocation($dir,$file) : returns file system location or a URL; same as
3914: filelocation except for hrefs
3915:
3916: =item *
3917:
3918: declutter() : declutters URLs (remove docroot, beginning slashes, 'res' etc)
3919:
3920: =back
3921:
3922: =head2 HTTP Helper Routines
3923:
3924: =over 4
3925:
3926: =item *
3927:
3928: escape() : unpack non-word characters into CGI-compatible hex codes
3929:
3930: =item *
3931:
3932: unescape() : pack CGI-compatible hex codes into actual non-word ASCII character
3933:
3934: =back
3935:
3936: =head1 PRIVATE SUBROUTINES
3937:
3938: =head2 Underlying communication routines (Shouldn't call)
3939:
3940: =over 4
3941:
3942: =item *
3943:
3944: subreply() : tries to pass a message to lonc, returns con_lost if incapable
3945:
3946: =item *
3947:
3948: reply() : uses subreply to send a message to remote machine, logs all failures
3949:
3950: =item *
3951:
3952: critical() : passes a critical message to another server; if cannot
3953: get through then place message in connection buffer directory and
3954: returns con_delayed, if incapable of saving message, returns
3955: con_failed
3956:
3957: =item *
3958:
3959: reconlonc() : tries to reconnect lonc client processes.
3960:
3961: =back
3962:
3963: =head2 Resource Access Logging
3964:
3965: =over 4
3966:
3967: =item *
3968:
3969: flushcourselogs() : flush (save) buffer logs and access logs
3970:
3971: =item *
3972:
3973: courselog($what) : save message for course in hash
3974:
3975: =item *
3976:
3977: courseacclog($what) : save message for course using &courselog(). Perform
3978: special processing for specific resource types (problems, exams, quizzes, etc).
3979:
3980: =item *
3981:
3982: goodbye() : flush course logs and log shutting down; it is called in srm.conf
3983: as a PerlChildExitHandler
3984:
3985: =back
3986:
3987: =head2 Other
3988:
3989: =over 4
3990:
3991: =item *
3992:
3993: symblist($mapname,%newhash) : update symbolic storage links
3994:
3995: =back
3996:
3997: =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