1: # The LearningOnline Network
2: # TCP networking package
3: #
4: # $Id: lonnet.pm,v 1.234 2002/05/27 19:03:59 www Exp $
5: #
6: # Copyright Michigan State University Board of Trustees
7: #
8: # This file is part of the LearningOnline Network with CAPA (LON-CAPA).
9: #
10: # LON-CAPA is free software; you can redistribute it and/or modify
11: # it under the terms of the GNU General Public License as published by
12: # the Free Software Foundation; either version 2 of the License, or
13: # (at your option) any later version.
14: #
15: # LON-CAPA is distributed in the hope that it will be useful,
16: # but WITHOUT ANY WARRANTY; without even the implied warranty of
17: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18: # GNU General Public License for more details.
19: #
20: # You should have received a copy of the GNU General Public License
21: # along with LON-CAPA; if not, write to the Free Software
22: # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
23: #
24: # /home/httpd/html/adm/gpl.txt
25: #
26: # http://www.lon-capa.org/
27: #
28: # 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);
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: # ----------------------------- Subscribe to a resource, return URL if possible
612:
613: sub subscribe {
614: my $fname=shift;
615: my $author=$fname;
616: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
617: my ($udom,$uname)=split(/\//,$author);
618: my $home=homeserver($uname,$udom);
619: if (($home eq 'no_host') || ($home eq $perlvar{'lonHostID'})) {
620: return 'not_found';
621: }
622: my $answer=reply("sub:$fname",$home);
623: if (($answer eq 'con_lost') || ($answer eq 'rejected')) {
624: $answer.=' by '.$home;
625: }
626: return $answer;
627: }
628:
629: # -------------------------------------------------------------- Replicate file
630:
631: sub repcopy {
632: my $filename=shift;
633: $filename=~s/\/+/\//g;
634: if ($filename=~/^\/home\/httpd\/html\/adm\//) { return OK; }
635: my $transname="$filename.in.transfer";
636: if ((-e $filename) || (-e $transname)) { return OK; }
637: my $remoteurl=subscribe($filename);
638: if ($remoteurl =~ /^con_lost by/) {
639: &logthis("Subscribe returned $remoteurl: $filename");
640: return HTTP_SERVICE_UNAVAILABLE;
641: } elsif ($remoteurl eq 'not_found') {
642: &logthis("Subscribe returned not_found: $filename");
643: return HTTP_NOT_FOUND;
644: } elsif ($remoteurl =~ /^rejected by/) {
645: &logthis("Subscribe returned $remoteurl: $filename");
646: return FORBIDDEN;
647: } elsif ($remoteurl eq 'directory') {
648: return OK;
649: } else {
650: my @parts=split(/\//,$filename);
651: my $path="/$parts[1]/$parts[2]/$parts[3]/$parts[4]";
652: if ($path ne "$perlvar{'lonDocRoot'}/res") {
653: &logthis("Malconfiguration for replication: $filename");
654: return HTTP_BAD_REQUEST;
655: }
656: my $count;
657: for ($count=5;$count<$#parts;$count++) {
658: $path.="/$parts[$count]";
659: if ((-e $path)!=1) {
660: mkdir($path,0777);
661: }
662: }
663: my $ua=new LWP::UserAgent;
664: my $request=new HTTP::Request('GET',"$remoteurl");
665: my $response=$ua->request($request,$transname);
666: if ($response->is_error()) {
667: unlink($transname);
668: my $message=$response->status_line;
669: &logthis("<font color=blue>WARNING:"
670: ." LWP get: $message: $filename</font>");
671: return HTTP_SERVICE_UNAVAILABLE;
672: } else {
673: if ($remoteurl!~/\.meta$/) {
674: my $mrequest=new HTTP::Request('GET',$remoteurl.'.meta');
675: my $mresponse=$ua->request($mrequest,$filename.'.meta');
676: if ($mresponse->is_error()) {
677: unlink($filename.'.meta');
678: &logthis(
679: "<font color=yellow>INFO: No metadata: $filename</font>");
680: }
681: }
682: rename($transname,$filename);
683: return OK;
684: }
685: }
686: }
687:
688: # --------------------------------------------------------- Server Side Include
689:
690: sub ssi {
691:
692: my ($fn,%form)=@_;
693:
694: my $ua=new LWP::UserAgent;
695:
696: my $request;
697:
698: if (%form) {
699: $request=new HTTP::Request('POST',"http://".$ENV{'HTTP_HOST'}.$fn);
700: $request->content(join('&',map { &escape($_).'='.&escape($form{$_}) } keys %form));
701: } else {
702: $request=new HTTP::Request('GET',"http://".$ENV{'HTTP_HOST'}.$fn);
703: }
704:
705: $request->header(Cookie => $ENV{'HTTP_COOKIE'});
706: my $response=$ua->request($request);
707:
708: return $response->content;
709: }
710:
711: # ------------------------------------------------------------------------- Log
712:
713: sub log {
714: my ($dom,$nam,$hom,$what)=@_;
715: return critical("log:$dom:$nam:$what",$hom);
716: }
717:
718: # ------------------------------------------------------------------ Course Log
719:
720: sub flushcourselogs {
721: &logthis('Flushing course log buffers');
722: foreach (keys %courselogs) {
723: my $crsid=$_;
724: if (&reply('log:'.$coursedombuf{$crsid}.':'.
725: &escape($courselogs{$crsid}),
726: $coursehombuf{$crsid}) eq 'ok') {
727: delete $courselogs{$crsid};
728: } else {
729: &logthis('Failed to flush log buffer for '.$crsid);
730: if (length($courselogs{$crsid})>40000) {
731: &logthis("<font color=blue>WARNING: Buffer for ".$crsid.
732: " exceeded maximum size, deleting.</font>");
733: delete $courselogs{$crsid};
734: }
735: }
736: }
737: &logthis('Flushing access logs');
738: foreach (keys %accesshash) {
739: my $entry=$_;
740: $entry=~/\_\_\_(\w+)\/(\w+)\/(.*)\_\_\_(\w+)$/;
741: my %temphash=($entry => $accesshash{$entry});
742: if (&Apache::lonnet::put('resevaldata',\%temphash,$1,$2) eq 'ok') {
743: delete $accesshash{$entry};
744: }
745: }
746: $dumpcount++;
747: }
748:
749: sub courselog {
750: my $what=shift;
751: $what=time.':'.$what;
752: unless ($ENV{'request.course.id'}) { return ''; }
753: $coursedombuf{$ENV{'request.course.id'}}=
754: $ENV{'course.'.$ENV{'request.course.id'}.'.domain'}.':'.
755: $ENV{'course.'.$ENV{'request.course.id'}.'.num'};
756: $coursehombuf{$ENV{'request.course.id'}}=
757: $ENV{'course.'.$ENV{'request.course.id'}.'.home'};
758: if (defined $courselogs{$ENV{'request.course.id'}}) {
759: $courselogs{$ENV{'request.course.id'}}.='&'.$what;
760: } else {
761: $courselogs{$ENV{'request.course.id'}}.=$what;
762: }
763: if (length($courselogs{$ENV{'request.course.id'}})>4048) {
764: &flushcourselogs();
765: }
766: }
767:
768: sub courseacclog {
769: my $fnsymb=shift;
770: unless ($ENV{'request.course.id'}) { return ''; }
771: my $what=$fnsymb.':'.$ENV{'user.name'}.':'.$ENV{'user.domain'};
772: if ($fnsymb=~/(problem|exam|quiz|assess|survey|form)$/) {
773: $what.=':POST';
774: foreach (keys %ENV) {
775: if ($_=~/^form\.(.*)/) {
776: $what.=':'.$1.'='.$ENV{$_};
777: }
778: }
779: }
780: &courselog($what);
781: }
782:
783: sub countacc {
784: my $url=&declutter(shift);
785: unless ($ENV{'request.course.id'}) { return ''; }
786: $accesshash{$ENV{'request.course.id'}.'___'.$url.'___course'}=1;
787: my $key=$processmarker.'_'.$dumpcount.'___'.$url.'___count';
788: if (defined($accesshash{$key})) {
789: $accesshash{$key}++;
790: } else {
791: $accesshash{$key}=1;
792: }
793: }
794:
795: # ----------------------------------------------------------- Check out an item
796:
797: sub checkout {
798: my ($symb,$tuname,$tudom,$tcrsid)=@_;
799: my $now=time;
800: my $lonhost=$perlvar{'lonHostID'};
801: my $infostr=&escape(
802: 'CHECKOUTTOKEN&'.
803: $tuname.'&'.
804: $tudom.'&'.
805: $tcrsid.'&'.
806: $symb.'&'.
807: $now.'&'.$ENV{'REMOTE_ADDR'});
808: my $token=&reply('tmpput:'.$infostr,$lonhost);
809: if ($token=~/^error\:/) {
810: &logthis("<font color=blue>WARNING: ".
811: "Checkout tmpput failed ".$tudom.' - '.$tuname.' - '.$symb.
812: "</font>");
813: return '';
814: }
815:
816: $token=~s/^(\d+)\_.*\_(\d+)$/$1\*$2\*$lonhost/;
817: $token=~tr/a-z/A-Z/;
818:
819: my %infohash=('resource.0.outtoken' => $token,
820: 'resource.0.checkouttime' => $now,
821: 'resource.0.outremote' => $ENV{'REMOTE_ADDR'});
822:
823: unless (&cstore(\%infohash,$symb,$tcrsid,$tudom,$tuname) eq 'ok') {
824: return '';
825: } else {
826: &logthis("<font color=blue>WARNING: ".
827: "Checkout cstore failed ".$tudom.' - '.$tuname.' - '.$symb.
828: "</font>");
829: }
830:
831: if (&log($tudom,$tuname,&homeserver($tuname,$tudom),
832: &escape('Checkout '.$infostr.' - '.
833: $token)) ne 'ok') {
834: return '';
835: } else {
836: &logthis("<font color=blue>WARNING: ".
837: "Checkout log failed ".$tudom.' - '.$tuname.' - '.$symb.
838: "</font>");
839: }
840: return $token;
841: }
842:
843: # ------------------------------------------------------------ Check in an item
844:
845: sub checkin {
846: my $token=shift;
847: my $now=time;
848: my ($ta,$tb,$lonhost)=split(/\*/,$token);
849: $lonhost=~tr/A-Z/a-z/;
850: my $dtoken=$ta.'_'.$hostip{$lonhost}.'_'.$tb;
851: $dtoken=~s/\W/\_/g;
852: my ($dummy,$tuname,$tudom,$tcrsid,$symb,$chtim,$rmaddr)=
853: split(/\&/,&unescape(&reply('tmpget:'.$dtoken,$lonhost)));
854:
855: unless (($tuname) && ($tudom)) {
856: &logthis('Check in '.$token.' ('.$dtoken.') failed');
857: return '';
858: }
859:
860: unless (&allowed('mgr',$tcrsid)) {
861: &logthis('Check in '.$token.' ('.$dtoken.') unauthorized: '.
862: $ENV{'user.name'}.' - '.$ENV{'user.domain'});
863: return '';
864: }
865:
866: my %infohash=('resource.0.intoken' => $token,
867: 'resource.0.checkintime' => $now,
868: 'resource.0.inremote' => $ENV{'REMOTE_ADDR'});
869:
870: unless (&cstore(\%infohash,$symb,$tcrsid,$tudom,$tuname) eq 'ok') {
871: return '';
872: }
873:
874: if (&log($tudom,$tuname,&homeserver($tuname,$tudom),
875: &escape('Checkin - '.$token)) ne 'ok') {
876: return '';
877: }
878:
879: return ($symb,$tuname,$tudom,$tcrsid);
880: }
881:
882: # --------------------------------------------- Set Expire Date for Spreadsheet
883:
884: sub expirespread {
885: my ($uname,$udom,$stype,$usymb)=@_;
886: my $cid=$ENV{'request.course.id'};
887: if ($cid) {
888: my $now=time;
889: my $key=$uname.':'.$udom.':'.$stype.':'.$usymb;
890: return &reply('put:'.$ENV{'course.'.$cid.'.domain'}.':'.
891: $ENV{'course.'.$cid.'.num'}.
892: ':nohist_expirationdates:'.
893: &escape($key).'='.$now,
894: $ENV{'course.'.$cid.'.home'})
895: }
896: return 'ok';
897: }
898:
899: # ----------------------------------------------------- Devalidate Spreadsheets
900:
901: sub devalidate {
902: my $symb=shift;
903: my $cid=$ENV{'request.course.id'};
904: if ($cid) {
905: my $key=$ENV{'user.name'}.':'.$ENV{'user.domain'}.':';
906: my $status=
907: &del('nohist_calculatedsheet',
908: [$key.'studentcalc'],
909: $ENV{'course.'.$cid.'.domain'},
910: $ENV{'course.'.$cid.'.num'})
911: .' '.
912: &del('nohist_calculatedsheets_'.$cid,
913: [$key.'assesscalc:'.$symb]);
914: unless ($status eq 'ok ok') {
915: &logthis('Could not devalidate spreadsheet '.
916: $ENV{'user.name'}.' at '.$ENV{'user.domain'}.' for '.
917: $symb.': '.$status);
918: }
919: }
920: }
921:
922: sub arrayref2str {
923: my ($arrayref) = @_;
924: my $result='_ARRAY_REF__';
925: foreach my $elem (@$arrayref) {
926: if (ref($elem) eq 'ARRAY') {
927: $result.=&escape(&arrayref2str($elem)).'&';
928: } elsif (ref($elem) eq 'HASH') {
929: $result.=&escape(&hashref2str($elem)).'&';
930: } elsif (ref($elem)) {
931: &logthis("Got a ref of ".(ref($elem))." skipping.");
932: } else {
933: $result.=&escape($elem).'&';
934: }
935: }
936: $result=~s/\&$//;
937: return $result;
938: }
939:
940: sub hash2str {
941: my (%hash) = @_;
942: my $result=&hashref2str(\%hash);
943: $result=~s/^_HASH_REF__//;
944: return $result;
945: }
946:
947: sub hashref2str {
948: my ($hashref)=@_;
949: my $result='_HASH_REF__';
950: foreach (keys(%$hashref)) {
951: if (ref($_) eq 'ARRAY') {
952: $result.=&escape(&arrayref2str($_)).'=';
953: } elsif (ref($_) eq 'HASH') {
954: $result.=&escape(&hashref2str($_)).'=';
955: } elsif (ref($_)) {
956: &logthis("Got a ref of ".(ref($_))." skipping.");
957: } else {
958: $result.=&escape($_).'=';
959: }
960:
961: if (ref($$hashref{$_}) eq 'ARRAY') {
962: $result.=&escape(&arrayref2str($$hashref{$_})).'&';
963: } elsif (ref($$hashref{$_}) eq 'HASH') {
964: $result.=&escape(&hashref2str($$hashref{$_})).'&';
965: } elsif (ref($$hashref{$_})) {
966: &logthis("Got a ref of ".(ref($$hashref{$_}))." skipping.");
967: } else {
968: $result.=&escape($$hashref{$_}).'&';
969: }
970: }
971: $result=~s/\&$//;
972: return $result;
973: }
974:
975: sub str2hash {
976: my ($string) = @_;
977: my %returnhash;
978: foreach (split(/\&/,$string)) {
979: my ($name,$value)=split(/\=/,$_);
980: $name=&unescape($name);
981: $value=&unescape($value);
982: if ($value =~ /^_HASH_REF__/) {
983: $value =~ s/^_HASH_REF__//;
984: my %hash=&str2hash($value);
985: $value=\%hash;
986: } elsif ($value =~ /^_ARRAY_REF__/) {
987: $value =~ s/^_ARRAY_REF__//;
988: my @array=&str2array($value);
989: $value=\@array;
990: }
991: $returnhash{$name}=$value;
992: }
993: return (%returnhash);
994: }
995:
996: sub str2array {
997: my ($string) = @_;
998: my @returnarray;
999: foreach my $value (split(/\&/,$string)) {
1000: $value=&unescape($value);
1001: if ($value =~ /^_HASH_REF__/) {
1002: $value =~ s/^_HASH_REF__//;
1003: my %hash=&str2hash($value);
1004: $value=\%hash;
1005: } elsif ($value =~ /^_ARRAY_REF__/) {
1006: $value =~ s/^_ARRAY_REF__//;
1007: my @array=&str2array($value);
1008: $value=\@array;
1009: }
1010: push(@returnarray,$value);
1011: }
1012: return (@returnarray);
1013: }
1014:
1015: # -------------------------------------------------------------------Temp Store
1016:
1017: sub tmpreset {
1018: my ($symb,$namespace,$domain,$stuname) = @_;
1019: if (!$symb) {
1020: $symb=&symbread();
1021: if (!$symb) { $symb= $ENV{'REQUEST_URI'}; }
1022: }
1023: $symb=escape($symb);
1024:
1025: if (!$namespace) { $namespace=$ENV{'request.state'}; }
1026: $namespace=~s/\//\_/g;
1027: $namespace=~s/\W//g;
1028:
1029: #FIXME needs to do something for /pub resources
1030: if (!$domain) { $domain=$ENV{'user.domain'}; }
1031: if (!$stuname) { $stuname=$ENV{'user.name'}; }
1032: my $path=$perlvar{'lonDaemons'}.'/tmp';
1033: my %hash;
1034: if (tie(%hash,'GDBM_File',
1035: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
1036: &GDBM_WRCREAT,0640)) {
1037: foreach my $key (keys %hash) {
1038: if ($key=~ /:$symb/) {
1039: delete($hash{$key});
1040: }
1041: }
1042: }
1043: }
1044:
1045: sub tmpstore {
1046: my ($storehash,$symb,$namespace,$domain,$stuname) = @_;
1047:
1048: if (!$symb) {
1049: $symb=&symbread();
1050: if (!$symb) { $symb= $ENV{'request.url'}; }
1051: }
1052: $symb=escape($symb);
1053:
1054: if (!$namespace) {
1055: # I don't think we would ever want to store this for a course.
1056: # it seems this will only be used if we don't have a course.
1057: #$namespace=$ENV{'request.course.id'};
1058: #if (!$namespace) {
1059: $namespace=$ENV{'request.state'};
1060: #}
1061: }
1062: $namespace=~s/\//\_/g;
1063: $namespace=~s/\W//g;
1064: #FIXME needs to do something for /pub resources
1065: if (!$domain) { $domain=$ENV{'user.domain'}; }
1066: if (!$stuname) { $stuname=$ENV{'user.name'}; }
1067: my $now=time;
1068: my %hash;
1069: my $path=$perlvar{'lonDaemons'}.'/tmp';
1070: if (tie(%hash,'GDBM_File',
1071: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
1072: &GDBM_WRCREAT,0640)) {
1073: $hash{"version:$symb"}++;
1074: my $version=$hash{"version:$symb"};
1075: my $allkeys='';
1076: foreach my $key (keys(%$storehash)) {
1077: $allkeys.=$key.':';
1078: $hash{"$version:$symb:$key"}=$$storehash{$key};
1079: }
1080: $hash{"$version:$symb:timestamp"}=$now;
1081: $allkeys.='timestamp';
1082: $hash{"$version:keys:$symb"}=$allkeys;
1083: if (untie(%hash)) {
1084: return 'ok';
1085: } else {
1086: return "error:$!";
1087: }
1088: } else {
1089: return "error:$!";
1090: }
1091: }
1092:
1093: # -----------------------------------------------------------------Temp Restore
1094:
1095: sub tmprestore {
1096: my ($symb,$namespace,$domain,$stuname) = @_;
1097:
1098: if (!$symb) {
1099: $symb=&symbread();
1100: if (!$symb) { $symb= $ENV{'request.url'}; }
1101: }
1102: $symb=escape($symb);
1103:
1104: if (!$namespace) { $namespace=$ENV{'request.state'}; }
1105: #FIXME needs to do something for /pub resources
1106: if (!$domain) { $domain=$ENV{'user.domain'}; }
1107: if (!$stuname) { $stuname=$ENV{'user.name'}; }
1108:
1109: my %returnhash;
1110: $namespace=~s/\//\_/g;
1111: $namespace=~s/\W//g;
1112: my %hash;
1113: my $path=$perlvar{'lonDaemons'}.'/tmp';
1114: if (tie(%hash,'GDBM_File',
1115: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
1116: &GDBM_READER,0640)) {
1117: my $version=$hash{"version:$symb"};
1118: $returnhash{'version'}=$version;
1119: my $scope;
1120: for ($scope=1;$scope<=$version;$scope++) {
1121: my $vkeys=$hash{"$scope:keys:$symb"};
1122: my @keys=split(/:/,$vkeys);
1123: my $key;
1124: $returnhash{"$scope:keys"}=$vkeys;
1125: foreach $key (@keys) {
1126: $returnhash{"$scope:$key"}=$hash{"$scope:$symb:$key"};
1127: $returnhash{"$key"}=$hash{"$scope:$symb:$key"};
1128: }
1129: }
1130: if (!(untie(%hash))) {
1131: return "error:$!";
1132: }
1133: } else {
1134: return "error:$!";
1135: }
1136: return %returnhash;
1137: }
1138:
1139: # ----------------------------------------------------------------------- Store
1140:
1141: sub store {
1142: my ($storehash,$symb,$namespace,$domain,$stuname) = @_;
1143: my $home='';
1144:
1145: if ($stuname) { $home=&homeserver($stuname,$domain); }
1146:
1147: $symb=&symbclean($symb);
1148: if (!$symb) { unless ($symb=&symbread()) { return ''; } }
1149:
1150: &devalidate($symb);
1151:
1152: $symb=escape($symb);
1153: if (!$namespace) {
1154: unless ($namespace=$ENV{'request.course.id'}) {
1155: return '';
1156: }
1157: }
1158: if (!$domain) { $domain=$ENV{'user.domain'}; }
1159: if (!$stuname) { $stuname=$ENV{'user.name'}; }
1160: if (!$home) { $home=$ENV{'user.home'}; }
1161: my $namevalue='';
1162: foreach (keys %$storehash) {
1163: $namevalue.=escape($_).'='.escape($$storehash{$_}).'&';
1164: }
1165: $namevalue=~s/\&$//;
1166: &courselog($symb.':'.$stuname.':'.$domain.':STORE:'.$namevalue);
1167: return reply("store:$domain:$stuname:$namespace:$symb:$namevalue","$home");
1168: }
1169:
1170: # -------------------------------------------------------------- Critical Store
1171:
1172: sub cstore {
1173: my ($storehash,$symb,$namespace,$domain,$stuname) = @_;
1174: my $home='';
1175:
1176: if ($stuname) { $home=&homeserver($stuname,$domain); }
1177:
1178: $symb=&symbclean($symb);
1179: if (!$symb) { unless ($symb=&symbread()) { return ''; } }
1180:
1181: &devalidate($symb);
1182:
1183: $symb=escape($symb);
1184: if (!$namespace) {
1185: unless ($namespace=$ENV{'request.course.id'}) {
1186: return '';
1187: }
1188: }
1189: if (!$domain) { $domain=$ENV{'user.domain'}; }
1190: if (!$stuname) { $stuname=$ENV{'user.name'}; }
1191: if (!$home) { $home=$ENV{'user.home'}; }
1192:
1193: my $namevalue='';
1194: foreach (keys %$storehash) {
1195: $namevalue.=escape($_).'='.escape($$storehash{$_}).'&';
1196: }
1197: $namevalue=~s/\&$//;
1198: &courselog($symb.':'.$stuname.':'.$domain.':CSTORE:'.$namevalue);
1199: return critical
1200: ("store:$domain:$stuname:$namespace:$symb:$namevalue","$home");
1201: }
1202:
1203: # --------------------------------------------------------------------- Restore
1204:
1205: sub restore {
1206: my ($symb,$namespace,$domain,$stuname) = @_;
1207: my $home='';
1208:
1209: if ($stuname) { $home=&homeserver($stuname,$domain); }
1210:
1211: if (!$symb) {
1212: unless ($symb=escape(&symbread())) { return ''; }
1213: } else {
1214: $symb=&escape(&symbclean($symb));
1215: }
1216: if (!$namespace) {
1217: unless ($namespace=$ENV{'request.course.id'}) {
1218: return '';
1219: }
1220: }
1221: if (!$domain) { $domain=$ENV{'user.domain'}; }
1222: if (!$stuname) { $stuname=$ENV{'user.name'}; }
1223: if (!$home) { $home=$ENV{'user.home'}; }
1224: my $answer=&reply("restore:$domain:$stuname:$namespace:$symb","$home");
1225:
1226: my %returnhash=();
1227: foreach (split(/\&/,$answer)) {
1228: my ($name,$value)=split(/\=/,$_);
1229: $returnhash{&unescape($name)}=&unescape($value);
1230: }
1231: my $version;
1232: for ($version=1;$version<=$returnhash{'version'};$version++) {
1233: foreach (split(/\:/,$returnhash{$version.':keys'})) {
1234: $returnhash{$_}=$returnhash{$version.':'.$_};
1235: }
1236: }
1237: return %returnhash;
1238: }
1239:
1240: # ---------------------------------------------------------- Course Description
1241:
1242: sub coursedescription {
1243: my $courseid=shift;
1244: $courseid=~s/^\///;
1245: $courseid=~s/\_/\//g;
1246: my ($cdomain,$cnum)=split(/\//,$courseid);
1247: my $chome=&homeserver($cnum,$cdomain);
1248: if ($chome ne 'no_host') {
1249: my %returnhash=&dump('environment',$cdomain,$cnum);
1250: if (!exists($returnhash{'con_lost'})) {
1251: my $normalid=$cdomain.'_'.$cnum;
1252: my %envhash=();
1253: $returnhash{'home'}= $chome;
1254: $returnhash{'domain'} = $cdomain;
1255: $returnhash{'num'} = $cnum;
1256: while (my ($name,$value) = each %returnhash) {
1257: $envhash{'course.'.$normalid.'.'.$name}=$value;
1258: }
1259: $returnhash{'url'}='/res/'.declutter($returnhash{'url'});
1260: $returnhash{'fn'}=$perlvar{'lonDaemons'}.'/tmp/'.
1261: $ENV{'user.name'}.'_'.$cdomain.'_'.$cnum;
1262: $envhash{'course.'.$normalid.'.last_cache'}=time;
1263: $envhash{'course.'.$normalid.'.home'}=$chome;
1264: $envhash{'course.'.$normalid.'.domain'}=$cdomain;
1265: $envhash{'course.'.$normalid.'.num'}=$cnum;
1266: &appenv(%envhash);
1267: return %returnhash;
1268: }
1269: }
1270: return ();
1271: }
1272:
1273: # -------------------------------------------------------- Get user privileges
1274:
1275: sub rolesinit {
1276: my ($domain,$username,$authhost)=@_;
1277: my $rolesdump=reply("dump:$domain:$username:roles",$authhost);
1278: if (($rolesdump eq 'con_lost') || ($rolesdump eq '')) { return ''; }
1279: my %allroles=();
1280: my %thesepriv=();
1281: my $now=time;
1282: my $userroles="user.login.time=$now\n";
1283: my $thesestr;
1284:
1285: if ($rolesdump ne '') {
1286: foreach (split(/&/,$rolesdump)) {
1287: if ($_!~/^rolesdef\&/) {
1288: my ($area,$role)=split(/=/,$_);
1289: $area=~s/\_\w\w$//;
1290: my ($trole,$tend,$tstart)=split(/_/,$role);
1291: $userroles.='user.role.'.$trole.'.'.$area.'='.
1292: $tstart.'.'.$tend."\n";
1293: if ($tend!=0) {
1294: if ($tend<$now) {
1295: $trole='';
1296: }
1297: }
1298: if ($tstart!=0) {
1299: if ($tstart>$now) {
1300: $trole='';
1301: }
1302: }
1303: if (($area ne '') && ($trole ne '')) {
1304: my $spec=$trole.'.'.$area;
1305: my ($tdummy,$tdomain,$trest)=split(/\//,$area);
1306: if ($trole =~ /^cr\//) {
1307: my ($rdummy,$rdomain,$rauthor,$rrole)=split(/\//,$trole);
1308: my $homsvr=homeserver($rauthor,$rdomain);
1309: if ($hostname{$homsvr} ne '') {
1310: my $roledef=
1311: reply("get:$rdomain:$rauthor:roles:rolesdef_$rrole",
1312: $homsvr);
1313: if (($roledef ne 'con_lost') && ($roledef ne '')) {
1314: my ($syspriv,$dompriv,$coursepriv)=
1315: split(/\_/,unescape($roledef));
1316: $allroles{'cm./'}.=':'.$syspriv;
1317: $allroles{$spec.'./'}.=':'.$syspriv;
1318: if ($tdomain ne '') {
1319: $allroles{'cm./'.$tdomain.'/'}.=':'.$dompriv;
1320: $allroles{$spec.'./'.$tdomain.'/'}.=':'.$dompriv;
1321: if ($trest ne '') {
1322: $allroles{'cm.'.$area}.=':'.$coursepriv;
1323: $allroles{$spec.'.'.$area}.=':'.$coursepriv;
1324: }
1325: }
1326: }
1327: }
1328: } else {
1329: $allroles{'cm./'}.=':'.$pr{$trole.':s'};
1330: $allroles{$spec.'./'}.=':'.$pr{$trole.':s'};
1331: if ($tdomain ne '') {
1332: $allroles{'cm./'.$tdomain.'/'}.=':'.$pr{$trole.':d'};
1333: $allroles{$spec.'./'.$tdomain.'/'}.=':'.$pr{$trole.':d'};
1334: if ($trest ne '') {
1335: $allroles{'cm.'.$area}.=':'.$pr{$trole.':c'};
1336: $allroles{$spec.'.'.$area}.=':'.$pr{$trole.':c'};
1337: }
1338: }
1339: }
1340: }
1341: }
1342: }
1343: my $adv=0;
1344: my $author=0;
1345: foreach (keys %allroles) {
1346: %thesepriv=();
1347: if (($_!~/^st/) && ($_!~/^ta/) && ($_!~/^cm/)) { $adv=1; }
1348: if (($_=~/^au/) || ($_=~/^ca/)) { $author=1; }
1349: foreach (split(/:/,$allroles{$_})) {
1350: if ($_ ne '') {
1351: my ($privilege,$restrictions)=split(/&/,$_);
1352: if ($restrictions eq '') {
1353: $thesepriv{$privilege}='F';
1354: } else {
1355: if ($thesepriv{$privilege} ne 'F') {
1356: $thesepriv{$privilege}.=$restrictions;
1357: }
1358: }
1359: }
1360: }
1361: $thesestr='';
1362: foreach (keys %thesepriv) { $thesestr.=':'.$_.'&'.$thesepriv{$_}; }
1363: $userroles.='user.priv.'.$_.'='.$thesestr."\n";
1364: }
1365: $userroles.='user.adv='.$adv."\n".
1366: 'user.author='.$author."\n";
1367: $ENV{'user.adv'}=$adv;
1368: }
1369: return $userroles;
1370: }
1371:
1372: # --------------------------------------------------------------- get interface
1373:
1374: sub get {
1375: my ($namespace,$storearr,$udomain,$uname)=@_;
1376: my $items='';
1377: foreach (@$storearr) {
1378: $items.=escape($_).'&';
1379: }
1380: $items=~s/\&$//;
1381: if (!$udomain) { $udomain=$ENV{'user.domain'}; }
1382: if (!$uname) { $uname=$ENV{'user.name'}; }
1383: my $uhome=&homeserver($uname,$udomain);
1384:
1385: my $rep=&reply("get:$udomain:$uname:$namespace:$items",$uhome);
1386: my @pairs=split(/\&/,$rep);
1387: my %returnhash=();
1388: my $i=0;
1389: foreach (@$storearr) {
1390: $returnhash{$_}=unescape($pairs[$i]);
1391: $i++;
1392: }
1393: return %returnhash;
1394: }
1395:
1396: # --------------------------------------------------------------- del interface
1397:
1398: sub del {
1399: my ($namespace,$storearr,$udomain,$uname)=@_;
1400: my $items='';
1401: foreach (@$storearr) {
1402: $items.=escape($_).'&';
1403: }
1404: $items=~s/\&$//;
1405: if (!$udomain) { $udomain=$ENV{'user.domain'}; }
1406: if (!$uname) { $uname=$ENV{'user.name'}; }
1407: my $uhome=&homeserver($uname,$udomain);
1408:
1409: return &reply("del:$udomain:$uname:$namespace:$items",$uhome);
1410: }
1411:
1412: # -------------------------------------------------------------- dump interface
1413:
1414: sub dump {
1415: my ($namespace,$udomain,$uname,$regexp)=@_;
1416: if (!$udomain) { $udomain=$ENV{'user.domain'}; }
1417: if (!$uname) { $uname=$ENV{'user.name'}; }
1418: my $uhome=&homeserver($uname,$udomain);
1419: if ($regexp) {
1420: $regexp=&escape($regexp);
1421: } else {
1422: $regexp='.';
1423: }
1424: my $rep=reply("dump:$udomain:$uname:$namespace:$regexp",$uhome);
1425: my @pairs=split(/\&/,$rep);
1426: my %returnhash=();
1427: foreach (@pairs) {
1428: my ($key,$value)=split(/=/,$_);
1429: $returnhash{unescape($key)}=unescape($value);
1430: }
1431: return %returnhash;
1432: }
1433:
1434: # --------------------------------------------------------------- put interface
1435:
1436: sub put {
1437: my ($namespace,$storehash,$udomain,$uname)=@_;
1438: if (!$udomain) { $udomain=$ENV{'user.domain'}; }
1439: if (!$uname) { $uname=$ENV{'user.name'}; }
1440: my $uhome=&homeserver($uname,$udomain);
1441: my $items='';
1442: foreach (keys %$storehash) {
1443: $items.=&escape($_).'='.&escape($$storehash{$_}).'&';
1444: }
1445: $items=~s/\&$//;
1446: return &reply("put:$udomain:$uname:$namespace:$items",$uhome);
1447: }
1448:
1449: # ------------------------------------------------------ critical put interface
1450:
1451: sub cput {
1452: my ($namespace,$storehash,$udomain,$uname)=@_;
1453: if (!$udomain) { $udomain=$ENV{'user.domain'}; }
1454: if (!$uname) { $uname=$ENV{'user.name'}; }
1455: my $uhome=&homeserver($uname,$udomain);
1456: my $items='';
1457: foreach (keys %$storehash) {
1458: $items.=escape($_).'='.escape($$storehash{$_}).'&';
1459: }
1460: $items=~s/\&$//;
1461: return &critical("put:$udomain:$uname:$namespace:$items",$uhome);
1462: }
1463:
1464: # -------------------------------------------------------------- eget interface
1465:
1466: sub eget {
1467: my ($namespace,$storearr,$udomain,$uname)=@_;
1468: my $items='';
1469: foreach (@$storearr) {
1470: $items.=escape($_).'&';
1471: }
1472: $items=~s/\&$//;
1473: if (!$udomain) { $udomain=$ENV{'user.domain'}; }
1474: if (!$uname) { $uname=$ENV{'user.name'}; }
1475: my $uhome=&homeserver($uname,$udomain);
1476: my $rep=&reply("eget:$udomain:$uname:$namespace:$items",$uhome);
1477: my @pairs=split(/\&/,$rep);
1478: my %returnhash=();
1479: my $i=0;
1480: foreach (@$storearr) {
1481: $returnhash{$_}=unescape($pairs[$i]);
1482: $i++;
1483: }
1484: return %returnhash;
1485: }
1486:
1487: # ------------------------------------------------- Check for a user privilege
1488:
1489: sub allowed {
1490: my ($priv,$uri)=@_;
1491:
1492: my $orguri=$uri;
1493: $uri=&declutter($uri);
1494:
1495: # Free bre access to adm and meta resources
1496:
1497: if ((($uri=~/^adm\//) || ($uri=~/\.meta$/)) && ($priv eq 'bre')) {
1498: return 'F';
1499: }
1500:
1501: # Free bre to public access
1502:
1503: if ($priv eq 'bre') {
1504: if (&metadata($uri,'copyright') eq 'public') { return 'F'; }
1505: }
1506:
1507: my $thisallowed='';
1508: my $statecond=0;
1509: my $courseprivid='';
1510:
1511: # Course
1512:
1513: if ($ENV{'user.priv.'.$ENV{'request.role'}.'./'}=~/$priv\&([^\:]*)/) {
1514: $thisallowed.=$1;
1515: }
1516:
1517: # Domain
1518:
1519: if ($ENV{'user.priv.'.$ENV{'request.role'}.'./'.(split(/\//,$uri))[0].'/'}
1520: =~/$priv\&([^\:]*)/) {
1521: $thisallowed.=$1;
1522: }
1523:
1524: # Course: uri itself is a course
1525: my $courseuri=$uri;
1526: $courseuri=~s/\_(\d)/\/$1/;
1527: $courseuri=~s/^([^\/])/\/$1/;
1528:
1529: if ($ENV{'user.priv.'.$ENV{'request.role'}.'.'.$courseuri}
1530: =~/$priv\&([^\:]*)/) {
1531: $thisallowed.=$1;
1532: }
1533:
1534: # Full access at system, domain or course-wide level? Exit.
1535:
1536: if ($thisallowed=~/F/) {
1537: return 'F';
1538: }
1539:
1540: # If this is generating or modifying users, exit with special codes
1541:
1542: if (':csu:cdc:ccc:cin:cta:cep:ccr:cst:cad:cli:cau:cdg:cca:'=~/\:$priv\:/) {
1543: return $thisallowed;
1544: }
1545: #
1546: # Gathered so far: system, domain and course wide privileges
1547: #
1548: # Course: See if uri or referer is an individual resource that is part of
1549: # the course
1550:
1551: if ($ENV{'request.course.id'}) {
1552:
1553: $courseprivid=$ENV{'request.course.id'};
1554: if ($ENV{'request.course.sec'}) {
1555: $courseprivid.='/'.$ENV{'request.course.sec'};
1556: }
1557: $courseprivid=~s/\_/\//;
1558: my $checkreferer=1;
1559: my ($match,$cond)=&is_on_map($uri);
1560: if ($match) {
1561: $statecond=$cond;
1562: if ($ENV{'user.priv.'.$ENV{'request.role'}.'./'.$courseprivid}
1563: =~/$priv\&([^\:]*)/) {
1564: $thisallowed.=$1;
1565: $checkreferer=0;
1566: }
1567: }
1568:
1569: if ($checkreferer) {
1570: my $refuri=$ENV{'httpref.'.$orguri};
1571: unless ($refuri) {
1572: foreach (keys %ENV) {
1573: if ($_=~/^httpref\..*\*/) {
1574: my $pattern=$_;
1575: $pattern=~s/^httpref\.\/res\///;
1576: $pattern=~s/\*/\[\^\/\]\+/g;
1577: $pattern=~s/\//\\\//g;
1578: if ($orguri=~/$pattern/) {
1579: $refuri=$ENV{$_};
1580: }
1581: }
1582: }
1583: }
1584:
1585: if ($refuri) {
1586: $refuri=&declutter($refuri);
1587: my ($match,$cond)=&is_on_map($refuri);
1588: if ($match) {
1589: my $refstatecond=$cond;
1590: if ($ENV{'user.priv.'.$ENV{'request.role'}.'./'.$courseprivid}
1591: =~/$priv\&([^\:]*)/) {
1592: $thisallowed.=$1;
1593: $uri=$refuri;
1594: $statecond=$refstatecond;
1595: }
1596: }
1597: }
1598: }
1599: }
1600:
1601: #
1602: # Gathered now: all privileges that could apply, and condition number
1603: #
1604: #
1605: # Full or no access?
1606: #
1607:
1608: if ($thisallowed=~/F/) {
1609: return 'F';
1610: }
1611:
1612: unless ($thisallowed) {
1613: return '';
1614: }
1615:
1616: # Restrictions exist, deal with them
1617: #
1618: # C:according to course preferences
1619: # R:according to resource settings
1620: # L:unless locked
1621: # X:according to user session state
1622: #
1623:
1624: # Possibly locked functionality, check all courses
1625: # Locks might take effect only after 10 minutes cache expiration for other
1626: # courses, and 2 minutes for current course
1627:
1628: my $envkey;
1629: if ($thisallowed=~/L/) {
1630: foreach $envkey (keys %ENV) {
1631: if ($envkey=~/^user\.role\.(st|ta)\.([^\.]*)/) {
1632: my $courseid=$2;
1633: my $roleid=$1.'.'.$2;
1634: $courseid=~s/^\///;
1635: my $expiretime=600;
1636: if ($ENV{'request.role'} eq $roleid) {
1637: $expiretime=120;
1638: }
1639: my ($cdom,$cnum,$csec)=split(/\//,$courseid);
1640: my $prefix='course.'.$cdom.'_'.$cnum.'.';
1641: if ((time-$ENV{$prefix.'last_cache'})>$expiretime) {
1642: &coursedescription($courseid);
1643: }
1644: if (($ENV{$prefix.'res.'.$uri.'.lock.sections'}=~/\,$csec\,/)
1645: || ($ENV{$prefix.'res.'.$uri.'.lock.sections'} eq 'all')) {
1646: if ($ENV{$prefix.'res.'.$uri.'.lock.expire'}>time) {
1647: &log($ENV{'user.domain'},$ENV{'user.name'},
1648: $ENV{'user.host'},
1649: 'Locked by res: '.$priv.' for '.$uri.' due to '.
1650: $cdom.'/'.$cnum.'/'.$csec.' expire '.
1651: $ENV{$prefix.'priv.'.$priv.'.lock.expire'});
1652: return '';
1653: }
1654: }
1655: if (($ENV{$prefix.'priv.'.$priv.'.lock.sections'}=~/\,$csec\,/)
1656: || ($ENV{$prefix.'priv.'.$priv.'.lock.sections'} eq 'all')) {
1657: if ($ENV{'priv.'.$priv.'.lock.expire'}>time) {
1658: &log($ENV{'user.domain'},$ENV{'user.name'},
1659: $ENV{'user.host'},
1660: 'Locked by priv: '.$priv.' for '.$uri.' due to '.
1661: $cdom.'/'.$cnum.'/'.$csec.' expire '.
1662: $ENV{$prefix.'priv.'.$priv.'.lock.expire'});
1663: return '';
1664: }
1665: }
1666: }
1667: }
1668: }
1669:
1670: #
1671: # Rest of the restrictions depend on selected course
1672: #
1673:
1674: unless ($ENV{'request.course.id'}) {
1675: return '1';
1676: }
1677:
1678: #
1679: # Now user is definitely in a course
1680: #
1681:
1682:
1683: # Course preferences
1684:
1685: if ($thisallowed=~/C/) {
1686: my $rolecode=(split(/\./,$ENV{'request.role'}))[0];
1687: if ($ENV{'course.'.$ENV{'request.course.id'}.'.'.$priv.'.roles.denied'}
1688: =~/$rolecode/) {
1689: &log($ENV{'user.domain'},$ENV{'user.name'},$ENV{'user.host'},
1690: 'Denied by role: '.$priv.' for '.$uri.' as '.$rolecode.' in '.
1691: $ENV{'request.course.id'});
1692: return '';
1693: }
1694: }
1695:
1696: # Resource preferences
1697:
1698: if ($thisallowed=~/R/) {
1699: my $rolecode=(split(/\./,$ENV{'request.role'}))[0];
1700: my $filename=$perlvar{'lonDocRoot'}.'/res/'.$uri.'.meta';
1701: if (-e $filename) {
1702: my @content;
1703: {
1704: my $fh=Apache::File->new($filename);
1705: @content=<$fh>;
1706: }
1707: if (join('',@content)=~
1708: /\<roledeny[^\>]*\>[^\<]*$rolecode[^\<]*\<\/roledeny\>/) {
1709: &log($ENV{'user.domain'},$ENV{'user.name'},$ENV{'user.host'},
1710: 'Denied by role: '.$priv.' for '.$uri.' as '.$rolecode);
1711: return '';
1712:
1713: }
1714: }
1715: }
1716:
1717: # Restricted by state?
1718:
1719: if ($thisallowed=~/X/) {
1720: if (&condval($statecond)) {
1721: return '2';
1722: } else {
1723: return '';
1724: }
1725: }
1726:
1727: return 'F';
1728: }
1729:
1730: # --------------------------------------------------- Is a resource on the map?
1731:
1732: sub is_on_map {
1733: my $uri=&declutter(shift);
1734: my @uriparts=split(/\//,$uri);
1735: my $filename=$uriparts[$#uriparts];
1736: my $pathname=$uri;
1737: $pathname=~s/\/$filename$//;
1738: my $match=($ENV{'acc.res.'.$ENV{'request.course.id'}.'.'.$pathname}=~
1739: /\&$filename\:([\d\|]+)\&/);
1740: &logthis('is: '.$uri.' '.$match.' '.$1);
1741: if ($match) {
1742: return (1,$1);
1743: } else {
1744: return (0,0);
1745: }
1746: }
1747:
1748: # ----------------------------------------------------------------- Define Role
1749:
1750: sub definerole {
1751: if (allowed('mcr','/')) {
1752: my ($rolename,$sysrole,$domrole,$courole)=@_;
1753: foreach (split('/',$sysrole)) {
1754: my ($crole,$cqual)=split(/\&/,$_);
1755: if ($pr{'cr:s'}!~/$crole/) { return "refused:s:$crole"; }
1756: if ($pr{'cr:s'}=~/$crole\&/) {
1757: if ($pr{'cr:s'}!~/$crole\&\w*$cqual/) {
1758: return "refused:s:$crole&$cqual";
1759: }
1760: }
1761: }
1762: foreach (split('/',$domrole)) {
1763: my ($crole,$cqual)=split(/\&/,$_);
1764: if ($pr{'cr:d'}!~/$crole/) { return "refused:d:$crole"; }
1765: if ($pr{'cr:d'}=~/$crole\&/) {
1766: if ($pr{'cr:d'}!~/$crole\&\w*$cqual/) {
1767: return "refused:d:$crole&$cqual";
1768: }
1769: }
1770: }
1771: foreach (split('/',$courole)) {
1772: my ($crole,$cqual)=split(/\&/,$_);
1773: if ($pr{'cr:c'}!~/$crole/) { return "refused:c:$crole"; }
1774: if ($pr{'cr:c'}=~/$crole\&/) {
1775: if ($pr{'cr:c'}!~/$crole\&\w*$cqual/) {
1776: return "refused:c:$crole&$cqual";
1777: }
1778: }
1779: }
1780: my $command="encrypt:rolesput:$ENV{'user.domain'}:$ENV{'user.name'}:".
1781: "$ENV{'user.domain'}:$ENV{'user.name'}:".
1782: "rolesdef_$rolename=".
1783: escape($sysrole.'_'.$domrole.'_'.$courole);
1784: return reply($command,$ENV{'user.home'});
1785: } else {
1786: return 'refused';
1787: }
1788: }
1789:
1790: # ---------------- Make a metadata query against the network of library servers
1791:
1792: sub metadata_query {
1793: my ($query,$custom,$customshow)=@_;
1794: my %rhash;
1795: for my $server (keys %libserv) {
1796: unless ($custom or $customshow) {
1797: my $reply=&reply("querysend:".&escape($query),$server);
1798: $rhash{$server}=$reply;
1799: }
1800: else {
1801: my $reply=&reply("querysend:".&escape($query).':'.
1802: &escape($custom).':'.&escape($customshow),
1803: $server);
1804: $rhash{$server}=$reply;
1805: }
1806: }
1807: return \%rhash;
1808: }
1809:
1810: # ------------------------------------------------------------------ Plain Text
1811:
1812: sub plaintext {
1813: my $short=shift;
1814: return $prp{$short};
1815: }
1816:
1817: # ----------------------------------------------------------------- Assign Role
1818:
1819: sub assignrole {
1820: my ($udom,$uname,$url,$role,$end,$start)=@_;
1821: my $mrole;
1822: if ($role =~ /^cr\//) {
1823: unless (&allowed('ccr',$url)) {
1824: &logthis('Refused custom assignrole: '.
1825: $udom.' '.$uname.' '.$url.' '.$role.' '.$end.' '.$start.' by '.
1826: $ENV{'user.name'}.' at '.$ENV{'user.domain'});
1827: return 'refused';
1828: }
1829: $mrole='cr';
1830: } else {
1831: my $cwosec=$url;
1832: $cwosec=~s/^\/(\w+)\/(\w+)\/.*/$1\/$2/;
1833: unless (&allowed('c'.$role,$cwosec)) {
1834: &logthis('Refused assignrole: '.
1835: $udom.' '.$uname.' '.$url.' '.$role.' '.$end.' '.$start.' by '.
1836: $ENV{'user.name'}.' at '.$ENV{'user.domain'});
1837: return 'refused';
1838: }
1839: $mrole=$role;
1840: }
1841: my $command="encrypt:rolesput:$ENV{'user.domain'}:$ENV{'user.name'}:".
1842: "$udom:$uname:$url".'_'."$mrole=$role";
1843: if ($end) { $command.='_'.$end; }
1844: if ($start) {
1845: if ($end) {
1846: $command.='_'.$start;
1847: } else {
1848: $command.='_0_'.$start;
1849: }
1850: }
1851: return &reply($command,&homeserver($uname,$udom));
1852: }
1853:
1854: # -------------------------------------------------- Modify user authentication
1855: # Overrides without validation
1856:
1857: sub modifyuserauth {
1858: my ($udom,$uname,$umode,$upass)=@_;
1859: my $uhome=&homeserver($uname,$udom);
1860: unless (&allowed('mau',$udom)) { return 'refused'; }
1861: &logthis('Call to modify user authentication '.$udom.', '.$uname.', '.
1862: $umode.' by '.$ENV{'user.name'}.' at '.$ENV{'user.domain'});
1863: my $reply=&reply('encrypt:changeuserauth:'.$udom.':'.$uname.':'.$umode.':'.
1864: &escape($upass),$uhome);
1865: &log($ENV{'user.domain'},$ENV{'user.name'},$ENV{'user.home'},
1866: 'Authentication changed for '.$udom.', '.$uname.', '.$umode.
1867: '(Remote '.$ENV{'REMOTE_ADDR'}.'): '.$reply);
1868: &log($udom,,$uname,$uhome,
1869: 'Authentication changed by '.$ENV{'user.domain'}.', '.
1870: $ENV{'user.name'}.', '.$umode.
1871: '(Remote '.$ENV{'REMOTE_ADDR'}.'): '.$reply);
1872: unless ($reply eq 'ok') {
1873: &logthis('Authentication mode error: '.$reply);
1874: return 'error: '.$reply;
1875: }
1876: return 'ok';
1877: }
1878:
1879: # --------------------------------------------------------------- Modify a user
1880:
1881: sub modifyuser {
1882: my ($udom, $uname, $uid,
1883: $umode, $upass, $first,
1884: $middle, $last, $gene,
1885: $forceid, $desiredhome)=@_;
1886: $udom=~s/\W//g;
1887: $uname=~s/\W//g;
1888: &logthis('Call to modify user '.$udom.', '.$uname.', '.$uid.', '.
1889: $umode.', '.$first.', '.$middle.', '.
1890: $last.', '.$gene.'(forceid: '.$forceid.')'.
1891: (defined($desiredhome) ? ' desiredhome = '.$desiredhome :
1892: ' desiredhome not specified').
1893: ' by '.$ENV{'user.name'}.' at '.$ENV{'user.domain'});
1894: my $uhome=&homeserver($uname,$udom,'true');
1895: # ----------------------------------------------------------------- Create User
1896: if (($uhome eq 'no_host') && ($umode) && ($upass)) {
1897: my $unhome='';
1898: if (defined($desiredhome) && $hostdom{$desiredhome} eq $udom) {
1899: $unhome = $desiredhome;
1900: } elsif($ENV{'course.'.$ENV{'request.course.id'}.'.domain'} eq $udom) {
1901: $unhome=$ENV{'course.'.$ENV{'request.course.id'}.'.home'};
1902: } else { # load balancing routine for determining $unhome
1903: my $tryserver;
1904: my $loadm=10000000;
1905: foreach $tryserver (keys %libserv) {
1906: if ($hostdom{$tryserver} eq $udom) {
1907: my $answer=reply('load',$tryserver);
1908: if (($answer=~/\d+/) && ($answer<$loadm)) {
1909: $loadm=$answer;
1910: $unhome=$tryserver;
1911: }
1912: }
1913: }
1914: }
1915: if (($unhome eq '') || ($unhome eq 'no_host')) {
1916: return 'error: unable to find a home server for '.$uname.
1917: ' in domain '.$udom;
1918: }
1919: my $reply=&reply('encrypt:makeuser:'.$udom.':'.$uname.':'.$umode.':'.
1920: &escape($upass),$unhome);
1921: unless ($reply eq 'ok') {
1922: return 'error: '.$reply;
1923: }
1924: $uhome=&homeserver($uname,$udom,'true');
1925: if (($uhome eq '') || ($uhome eq 'no_host') || ($uhome ne $unhome)) {
1926: return 'error: verify home';
1927: }
1928: } # End of creation of new user
1929: # ---------------------------------------------------------------------- Add ID
1930: if ($uid) {
1931: $uid=~tr/A-Z/a-z/;
1932: my %uidhash=&idrget($udom,$uname);
1933: if (($uidhash{$uname}) && ($uidhash{$uname}!~/error\:/)
1934: && (!$forceid)) {
1935: unless ($uid eq $uidhash{$uname}) {
1936: return 'error: mismatch '.$uidhash{$uname}.' versus '.$uid;
1937: }
1938: } else {
1939: &idput($udom,($uname => $uid));
1940: }
1941: }
1942: # -------------------------------------------------------------- Add names, etc
1943: my %names=&get('environment',
1944: ['firstname','middlename','lastname','generation'],
1945: $udom,$uname);
1946: if ($names{'firstname'} =~ m/^error:.*/) { %names=(); }
1947: if ($first) { $names{'firstname'} = $first; }
1948: if ($middle) { $names{'middlename'} = $middle; }
1949: if ($last) { $names{'lastname'} = $last; }
1950: if ($gene) { $names{'generation'} = $gene; }
1951: my $reply = &put('environment', \%names, $udom,$uname);
1952: if ($reply ne 'ok') { return 'error: '.$reply; }
1953: &logthis('Success modifying user '.$udom.', '.$uname.', '.$uid.', '.
1954: $umode.', '.$first.', '.$middle.', '.
1955: $last.', '.$gene.' by '.
1956: $ENV{'user.name'}.' at '.$ENV{'user.domain'});
1957: return 'ok';
1958: }
1959:
1960: # -------------------------------------------------------------- Modify student
1961:
1962: sub modifystudent {
1963: my ($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene,$usec,
1964: $end,$start,$forceid,$desiredhome)=@_;
1965: my $cid='';
1966: unless ($cid=$ENV{'request.course.id'}) {
1967: return 'not_in_class';
1968: }
1969: # --------------------------------------------------------------- Make the user
1970: my $reply=&modifyuser
1971: ($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene,$forceid,
1972: $desiredhome);
1973: unless ($reply eq 'ok') { return $reply; }
1974: my $uhome=&homeserver($uname,$udom);
1975: if (($uhome eq '') || ($uhome eq 'no_host')) {
1976: return 'error: no such user';
1977: }
1978: # -------------------------------------------------- Add student to course list
1979: $reply=critical('put:'.$ENV{'course.'.$cid.'.domain'}.':'.
1980: $ENV{'course.'.$cid.'.num'}.':classlist:'.
1981: &escape($uname.':'.$udom).'='.
1982: &escape($end.':'.$start),
1983: $ENV{'course.'.$cid.'.home'});
1984: unless (($reply eq 'ok') || ($reply eq 'delayed')) {
1985: return 'error: '.$reply;
1986: }
1987: # ---------------------------------------------------- Add student role to user
1988: my $uurl='/'.$cid;
1989: $uurl=~s/\_/\//g;
1990: if ($usec) {
1991: $uurl.='/'.$usec;
1992: }
1993: return &assignrole($udom,$uname,$uurl,'st',$end,$start);
1994: }
1995:
1996: # ------------------------------------------------- Write to course preferences
1997:
1998: sub writecoursepref {
1999: my ($courseid,%prefs)=@_;
2000: $courseid=~s/^\///;
2001: $courseid=~s/\_/\//g;
2002: my ($cdomain,$cnum)=split(/\//,$courseid);
2003: my $chome=homeserver($cnum,$cdomain);
2004: if (($chome eq '') || ($chome eq 'no_host')) {
2005: return 'error: no such course';
2006: }
2007: my $cstring='';
2008: foreach (keys %prefs) {
2009: $cstring.=escape($_).'='.escape($prefs{$_}).'&';
2010: }
2011: $cstring=~s/\&$//;
2012: return reply('put:'.$cdomain.':'.$cnum.':environment:'.$cstring,$chome);
2013: }
2014:
2015: # ---------------------------------------------------------- Make/modify course
2016:
2017: sub createcourse {
2018: my ($udom,$description,$url)=@_;
2019: $url=&declutter($url);
2020: my $cid='';
2021: unless (&allowed('ccc',$ENV{'user.domain'})) {
2022: return 'refused';
2023: }
2024: unless ($udom eq $ENV{'user.domain'}) {
2025: return 'refused';
2026: }
2027: # ------------------------------------------------------------------- Create ID
2028: my $uname=substr($$.time,0,5).unpack("H8",pack("I32",time)).
2029: unpack("H2",pack("I32",int(rand(255)))).$perlvar{'lonHostID'};
2030: # ----------------------------------------------- Make sure that does not exist
2031: my $uhome=&homeserver($uname,$udom,'true');
2032: unless (($uhome eq '') || ($uhome eq 'no_host')) {
2033: $uname=substr($$.time,0,5).unpack("H8",pack("I32",time)).
2034: unpack("H2",pack("I32",int(rand(255)))).$perlvar{'lonHostID'};
2035: $uhome=&homeserver($uname,$udom,'true');
2036: unless (($uhome eq '') || ($uhome eq 'no_host')) {
2037: return 'error: unable to generate unique course-ID';
2038: }
2039: }
2040: # ------------------------------------------------------------- Make the course
2041: my $reply=&reply('encrypt:makeuser:'.$udom.':'.$uname.':none::',
2042: $ENV{'user.home'});
2043: unless ($reply eq 'ok') { return 'error: '.$reply; }
2044: $uhome=&homeserver($uname,$udom,'true');
2045: if (($uhome eq '') || ($uhome eq 'no_host')) {
2046: return 'error: no such course';
2047: }
2048: &writecoursepref($udom.'_'.$uname,
2049: ('description' => $description,
2050: 'url' => $url));
2051: return '/'.$udom.'/'.$uname;
2052: }
2053:
2054: # ---------------------------------------------------------- Assign Custom Role
2055:
2056: sub assigncustomrole {
2057: my ($udom,$uname,$url,$rdom,$rnam,$rolename,$end,$start)=@_;
2058: return &assignrole($udom,$uname,$url,'cr/'.$rdom.'/'.$rnam.'/'.$rolename,
2059: $end,$start);
2060: }
2061:
2062: # ----------------------------------------------------------------- Revoke Role
2063:
2064: sub revokerole {
2065: my ($udom,$uname,$url,$role)=@_;
2066: my $now=time;
2067: return &assignrole($udom,$uname,$url,$role,$now);
2068: }
2069:
2070: # ---------------------------------------------------------- Revoke Custom Role
2071:
2072: sub revokecustomrole {
2073: my ($udom,$uname,$url,$rdom,$rnam,$rolename)=@_;
2074: my $now=time;
2075: return &assigncustomrole($udom,$uname,$url,$rdom,$rnam,$rolename,$now);
2076: }
2077:
2078: # ------------------------------------------------------------ Directory lister
2079:
2080: sub dirlist {
2081: my $uri=shift;
2082: $uri=~s/^\///;
2083: $uri=~s/\/$//;
2084: my ($res,$udom,$uname,@rest)=split(/\//,$uri);
2085: if ($udom) {
2086: if ($uname) {
2087: my $listing=reply('ls:'.$perlvar{'lonDocRoot'}.'/'.$uri,
2088: homeserver($uname,$udom));
2089: return split(/:/,$listing);
2090: } else {
2091: my $tryserver;
2092: my %allusers=();
2093: foreach $tryserver (keys %libserv) {
2094: if ($hostdom{$tryserver} eq $udom) {
2095: my $listing=reply('ls:'.$perlvar{'lonDocRoot'}.'/res/'.$udom,
2096: $tryserver);
2097: if (($listing ne 'no_such_dir') && ($listing ne 'empty')
2098: && ($listing ne 'con_lost')) {
2099: foreach (split(/:/,$listing)) {
2100: my ($entry,@stat)=split(/&/,$_);
2101: $allusers{$entry}=1;
2102: }
2103: }
2104: }
2105: }
2106: my $alluserstr='';
2107: foreach (sort keys %allusers) {
2108: $alluserstr.=$_.'&user:';
2109: }
2110: $alluserstr=~s/:$//;
2111: return split(/:/,$alluserstr);
2112: }
2113: } else {
2114: my $tryserver;
2115: my %alldom=();
2116: foreach $tryserver (keys %libserv) {
2117: $alldom{$hostdom{$tryserver}}=1;
2118: }
2119: my $alldomstr='';
2120: foreach (sort keys %alldom) {
2121: $alldomstr.=$perlvar{'lonDocRoot'}.'/res/'.$_.'&domain:';
2122: }
2123: $alldomstr=~s/:$//;
2124: return split(/:/,$alldomstr);
2125: }
2126: }
2127:
2128: # -------------------------------------------------------- Value of a Condition
2129:
2130: sub directcondval {
2131: my $number=shift;
2132: if ($ENV{'user.state.'.$ENV{'request.course.id'}}) {
2133: return substr($ENV{'user.state.'.$ENV{'request.course.id'}},$number,1);
2134: } else {
2135: return 2;
2136: }
2137: }
2138:
2139: sub condval {
2140: my $condidx=shift;
2141: my $result=0;
2142: my $allpathcond='';
2143: foreach (split(/\|/,$condidx)) {
2144: if (defined($ENV{'acc.cond.'.$ENV{'request.course.id'}.'.'.$_})) {
2145: $allpathcond.=
2146: '('.$ENV{'acc.cond.'.$ENV{'request.course.id'}.'.'.$_}.')|';
2147: }
2148: }
2149: $allpathcond=~s/\|$//;
2150: if ($ENV{'request.course.id'}) {
2151: if ($allpathcond) {
2152: my $operand='|';
2153: my @stack;
2154: foreach ($allpathcond=~/(\d+|\(|\)|\&|\|)/g) {
2155: if ($_ eq '(') {
2156: push @stack,($operand,$result)
2157: } elsif ($_ eq ')') {
2158: my $before=pop @stack;
2159: if (pop @stack eq '&') {
2160: $result=$result>$before?$before:$result;
2161: } else {
2162: $result=$result>$before?$result:$before;
2163: }
2164: } elsif (($_ eq '&') || ($_ eq '|')) {
2165: $operand=$_;
2166: } else {
2167: my $new=directcondval($_);
2168: if ($operand eq '&') {
2169: $result=$result>$new?$new:$result;
2170: } else {
2171: $result=$result>$new?$result:$new;
2172: }
2173: }
2174: }
2175: }
2176: }
2177: return $result;
2178: }
2179:
2180: # --------------------------------------------------- Course Resourcedata Query
2181:
2182: sub courseresdata {
2183: my ($coursenum,$coursedomain,@which)=@_;
2184: my $coursehom=&homeserver($coursenum,$coursedomain);
2185: my $hashid=$coursenum.':'.$coursedomain;
2186: unless (defined($courseresdatacache{$hashid.'.time'})) {
2187: unless (time-$courseresdatacache{$hashid.'.time'}<300) {
2188: my $coursehom=&homeserver($coursenum,$coursedomain);
2189: if ($coursehom) {
2190: my $dumpreply=&reply('dump:'.$coursedomain.':'.$coursenum.
2191: ':resourcedata:.',$coursehom);
2192: unless ($dumpreply=~/^error\:/) {
2193: $courseresdatacache{$hashid.'.time'}=time;
2194: $courseresdatacache{$hashid}=$dumpreply;
2195: }
2196: }
2197: }
2198: }
2199: my @pairs=split(/\&/,$courseresdatacache{$hashid});
2200: my %returnhash=();
2201: foreach (@pairs) {
2202: my ($key,$value)=split(/=/,$_);
2203: $returnhash{unescape($key)}=unescape($value);
2204: }
2205: my $item;
2206: foreach $item (@which) {
2207: if ($returnhash{$item}) { return $returnhash{$item}; }
2208: }
2209: return '';
2210: }
2211:
2212: # --------------------------------------------------------- Value of a Variable
2213:
2214: sub EXT {
2215: my ($varname,$symbparm,$udom,$uname)=@_;
2216:
2217: unless ($varname) { return ''; }
2218:
2219: #get real user name/domain, courseid and symb
2220: my $courseid;
2221: if (!($uname && $udom)) {
2222: (my $cursymb,$courseid,$udom,$uname)=&Apache::lonxml::whichuser();
2223: if (!$symbparm) { $symbparm=$cursymb; }
2224: } else {
2225: $courseid=$ENV{'request.course.id'};
2226: }
2227:
2228: my ($realm,$space,$qualifier,@therest)=split(/\./,$varname);
2229: my $rest;
2230: if ($therest[0]) {
2231: $rest=join('.',@therest);
2232: } else {
2233: $rest='';
2234: }
2235: my $qualifierrest=$qualifier;
2236: if ($rest) { $qualifierrest.='.'.$rest; }
2237: my $spacequalifierrest=$space;
2238: if ($qualifierrest) { $spacequalifierrest.='.'.$qualifierrest; }
2239: if ($realm eq 'user') {
2240: # --------------------------------------------------------------- user.resource
2241: if ($space eq 'resource') {
2242: my %restored=&restore(undef,undef,$udom,$uname);
2243: return $restored{$qualifierrest};
2244: # ----------------------------------------------------------------- user.access
2245: } elsif ($space eq 'access') {
2246: # FIXME - not supporting calls for a specific user
2247: return &allowed($qualifier,$rest);
2248: # ------------------------------------------ user.preferences, user.environment
2249: } elsif (($space eq 'preferences') || ($space eq 'environment')) {
2250: if (($uname eq $ENV{'user.name'}) &&
2251: ($udom eq $ENV{'user.domain'})) {
2252: return $ENV{join('.',('environment',$qualifierrest))};
2253: } else {
2254: my %returnhash=&userenvironment($udom,$uname,$qualifierrest);
2255: return $returnhash{$qualifierrest};
2256: }
2257: # ----------------------------------------------------------------- user.course
2258: } elsif ($space eq 'course') {
2259: # FIXME - not supporting calls for a specific user
2260: return $ENV{join('.',('request.course',$qualifier))};
2261: # ------------------------------------------------------------------- user.role
2262: } elsif ($space eq 'role') {
2263: # FIXME - not supporting calls for a specific user
2264: my ($role,$where)=split(/\./,$ENV{'request.role'});
2265: if ($qualifier eq 'value') {
2266: return $role;
2267: } elsif ($qualifier eq 'extent') {
2268: return $where;
2269: }
2270: # ----------------------------------------------------------------- user.domain
2271: } elsif ($space eq 'domain') {
2272: return $udom;
2273: # ------------------------------------------------------------------- user.name
2274: } elsif ($space eq 'name') {
2275: return $uname;
2276: # ---------------------------------------------------- Any other user namespace
2277: } else {
2278: my $item=($rest)?$qualifier.'.'.$rest:$qualifier;
2279: my %reply=&get($space,[$item]);
2280: return $reply{$item};
2281: }
2282: } elsif ($realm eq 'request') {
2283: # ------------------------------------------------------------- request.browser
2284: if ($space eq 'browser') {
2285: return $ENV{'browser.'.$qualifier};
2286: # ------------------------------------------------------------ request.filename
2287: } else {
2288: return $ENV{'request.'.$spacequalifierrest};
2289: }
2290: } elsif ($realm eq 'course') {
2291: # ---------------------------------------------------------- course.description
2292: return $ENV{'course.'.$courseid.'.'.$spacequalifierrest};
2293: } elsif ($realm eq 'resource') {
2294:
2295: if ($courseid eq $ENV{'request.course.id'}) {
2296:
2297: #print '<br>'.$space.' - '.$qualifier.' - '.$spacequalifierrest;
2298:
2299: # ----------------------------------------------------- Cascading lookup scheme
2300: if (!$symbparm) { $symbparm=&symbread(); }
2301: my $symbp=$symbparm;
2302: my $mapp=(split(/\_\_\_/,$symbp))[0];
2303:
2304: my $symbparm=$symbp.'.'.$spacequalifierrest;
2305: my $mapparm=$mapp.'___(all).'.$spacequalifierrest;
2306:
2307: my $section;
2308: if (($ENV{'user.name'} eq $uname) &&
2309: ($ENV{'user.domain'} eq $udom)) {
2310: $section={'request.course.sec'};
2311: } else {
2312: $section=&usection($udom,$uname,$courseid);
2313: }
2314:
2315: my $seclevel=$courseid.'.['.$section.'].'.$spacequalifierrest;
2316: my $seclevelr=$courseid.'.['.$section.'].'.$symbparm;
2317: my $seclevelm=$courseid.'.['.$section.'].'.$mapparm;
2318:
2319: my $courselevel=$courseid.'.'.$spacequalifierrest;
2320: my $courselevelr=$courseid.'.'.$symbparm;
2321: my $courselevelm=$courseid.'.'.$mapparm;
2322:
2323: # ----------------------------------------------------------- first, check user
2324: my %resourcedata=&get('resourcedata',
2325: [$courselevelr,$courselevelm,$courselevel],
2326: $udom,$uname);
2327: if (($resourcedata{$courselevelr}!~/^error\:/) &&
2328: ($resourcedata{$courselevelr}!~/^con_lost/)) {
2329:
2330: if ($resourcedata{$courselevelr}) {
2331: return $resourcedata{$courselevelr}; }
2332: if ($resourcedata{$courselevelm}) {
2333: return $resourcedata{$courselevelm}; }
2334: if ($resourcedata{$courselevel}) {
2335: return $resourcedata{$courselevel}; }
2336: } else {
2337: if ($resourcedata{$courselevelr}!~/No such file/) {
2338: &logthis("<font color=blue>WARNING:".
2339: " Trying to get resource data for ".
2340: $uname." at ".$udom.": ".
2341: $resourcedata{$courselevelr}."</font>");
2342: }
2343: }
2344:
2345: # -------------------------------------------------------- second, check course
2346:
2347: my $coursereply=&courseresdata($ENV{'course.'.$courseid.'.num'},
2348: $ENV{'course.'.$courseid.'.domain'},
2349: ($seclevelr,$seclevelm,$seclevel,
2350: $courselevelr,$courselevelm,
2351: $courselevel));
2352: if ($coursereply) { return $coursereply; }
2353:
2354: # ------------------------------------------------------ third, check map parms
2355: my %parmhash=();
2356: my $thisparm='';
2357: if (tie(%parmhash,'GDBM_File',
2358: $ENV{'request.course.fn'}.'_parms.db',
2359: &GDBM_READER,0640)) {
2360: $thisparm=$parmhash{$symbparm};
2361: untie(%parmhash);
2362: }
2363: if ($thisparm) { return $thisparm; }
2364: }
2365: # --------------------------------------------- last, look in resource metadata
2366:
2367: $spacequalifierrest=~s/\./\_/;
2368: my $metadata=&metadata($ENV{'request.filename'},$spacequalifierrest);
2369: if ($metadata) { return $metadata; }
2370: $metadata=&metadata($ENV{'request.filename'},
2371: 'parameter_'.$spacequalifierrest);
2372: if ($metadata) { return $metadata; }
2373:
2374: # ------------------------------------------------------------------ Cascade up
2375: unless ($space eq '0') {
2376: my ($part,$id)=split(/\_/,$space);
2377: if ($id) {
2378: my $partgeneral=&EXT('resource.'.$part.'.'.$qualifierrest,
2379: $symbparm,$udom,$uname);
2380: if ($partgeneral) { return $partgeneral; }
2381: } else {
2382: my $resourcegeneral=&EXT('resource.0.'.$qualifierrest,
2383: $symbparm,$udom,$uname);
2384: if ($resourcegeneral) { return $resourcegeneral; }
2385: }
2386: }
2387:
2388: # ---------------------------------------------------- Any other user namespace
2389: } elsif ($realm eq 'environment') {
2390: # ----------------------------------------------------------------- environment
2391: if (($uname eq $ENV{'user.name'})&&($udom eq $ENV{'user.domain'})) {
2392: return $ENV{'environment.'.$spacequalifierrest};
2393: } else {
2394: my %returnhash=&userenvironment($udom,$uname,
2395: $spacequalifierrest);
2396: return $returnhash{$spacequalifierrest};
2397: }
2398: } elsif ($realm eq 'system') {
2399: # ----------------------------------------------------------------- system.time
2400: if ($space eq 'time') {
2401: return time;
2402: }
2403: }
2404: return '';
2405: }
2406:
2407: # ---------------------------------------------------------------- Get metadata
2408:
2409: sub metadata {
2410: my ($uri,$what,$liburi,$prefix,$depthcount)=@_;
2411:
2412: $uri=&declutter($uri);
2413: my $filename=$uri;
2414: $uri=~s/\.meta$//;
2415: #
2416: # Is the metadata already cached?
2417: # Look at timestamp of caching
2418: # Everything is cached by the main uri, libraries are never directly cached
2419: #
2420: unless (abs($metacache{$uri.':cachedtimestamp'}-time)<600) {
2421: #
2422: # Is this a recursive call for a library?
2423: #
2424: if ($liburi) {
2425: $liburi=&declutter($liburi);
2426: $filename=$liburi;
2427: }
2428: my %metathesekeys=();
2429: unless ($filename=~/\.meta$/) { $filename.='.meta'; }
2430: my $metastring=&getfile($perlvar{'lonDocRoot'}.'/res/'.$filename);
2431: my $parser=HTML::LCParser->new(\$metastring);
2432: my $token;
2433: undef %metathesekeys;
2434: while ($token=$parser->get_token) {
2435: if ($token->[0] eq 'S') {
2436: if (defined($token->[2]->{'package'})) {
2437: #
2438: # This is a package - get package info
2439: #
2440: my $package=$token->[2]->{'package'};
2441: my $keyroot='';
2442: if ($prefix) {
2443: $keyroot.='_'.$prefix;
2444: } else {
2445: if (defined($token->[2]->{'part'})) {
2446: $keyroot.='_'.$token->[2]->{'part'};
2447: }
2448: }
2449: if (defined($token->[2]->{'id'})) {
2450: $keyroot.='_'.$token->[2]->{'id'};
2451: }
2452: if ($metacache{$uri.':packages'}) {
2453: $metacache{$uri.':packages'}.=','.$package.$keyroot;
2454: } else {
2455: $metacache{$uri.':packages'}=$package.$keyroot;
2456: }
2457: foreach (keys %packagetab) {
2458: if ($_=~/^$package\&/) {
2459: my ($pack,$name,$subp)=split(/\&/,$_);
2460: my $value=$packagetab{$_};
2461: my $part=$keyroot;
2462: $part=~s/^\_//;
2463: if ($subp eq 'display') {
2464: $value.=' [Part: '.$part.']';
2465: }
2466: my $unikey='parameter'.$keyroot.'_'.$name;
2467: $metathesekeys{$unikey}=1;
2468: $metacache{$uri.':'.$unikey.'.part'}=$part;
2469: unless
2470: (defined($metacache{$uri.':'.$unikey.'.'.$subp})) {
2471: $metacache{$uri.':'.$unikey.'.'.$subp}=$value;
2472: }
2473: }
2474: }
2475: } else {
2476: #
2477: # This is not a package - some other kind of start tag
2478: #
2479: my $entry=$token->[1];
2480: my $unikey;
2481: if ($entry eq 'import') {
2482: $unikey='';
2483: } else {
2484: $unikey=$entry;
2485: }
2486: if ($prefix) {
2487: $unikey.=$prefix;
2488: } else {
2489: if (defined($token->[2]->{'part'})) {
2490: $unikey.='_'.$token->[2]->{'part'};
2491: }
2492: }
2493: if (defined($token->[2]->{'id'})) {
2494: $unikey.='_'.$token->[2]->{'id'};
2495: }
2496:
2497: if ($entry eq 'import') {
2498: #
2499: # Importing a library here
2500: #
2501: if (defined($depthcount)) { $depthcount++; } else
2502: { $depthcount=0; }
2503: if ($depthcount<20) {
2504: foreach (split(/\,/,&metadata($uri,'keys',
2505: $parser->get_text('/import'),$unikey,
2506: $depthcount))) {
2507: $metathesekeys{$_}=1;
2508: }
2509: }
2510: } else {
2511:
2512: if (defined($token->[2]->{'name'})) {
2513: $unikey.='_'.$token->[2]->{'name'};
2514: }
2515: $metathesekeys{$unikey}=1;
2516: foreach (@{$token->[3]}) {
2517: $metacache{$uri.':'.$unikey.'.'.$_}=$token->[2]->{$_};
2518: }
2519: unless (
2520: $metacache{$uri.':'.$unikey}=&HTML::Entities::decode($parser->get_text('/'.$entry))
2521: ) { $metacache{$uri.':'.$unikey}=
2522: $metacache{$uri.':'.$unikey.'.default'};
2523: }
2524: # end of not-a-package not-a-library import
2525: }
2526: # end of not-a-package start tag
2527: }
2528: # the next is the end of "start tag"
2529: }
2530: }
2531: $metacache{$uri.':keys'}=join(',',keys %metathesekeys);
2532: $metacache{$uri.':cachedtimestamp'}=time;
2533: # this is the end of "was not already recently cached
2534: }
2535: return $metacache{$uri.':'.$what};
2536: }
2537:
2538: # ------------------------------------------------- Update symbolic store links
2539:
2540: sub symblist {
2541: my ($mapname,%newhash)=@_;
2542: $mapname=declutter($mapname);
2543: my %hash;
2544: if (($ENV{'request.course.fn'}) && (%newhash)) {
2545: if (tie(%hash,'GDBM_File',$ENV{'request.course.fn'}.'_symb.db',
2546: &GDBM_WRCREAT,0640)) {
2547: foreach (keys %newhash) {
2548: $hash{declutter($_)}=$mapname.'___'.$newhash{$_};
2549: }
2550: if (untie(%hash)) {
2551: return 'ok';
2552: }
2553: }
2554: }
2555: return 'error';
2556: }
2557:
2558: # --------------------------------------------------------------- Verify a symb
2559:
2560: sub symbverify {
2561: my ($symb,$thisfn)=@_;
2562: $thisfn=&declutter($thisfn);
2563: # direct jump to resource in page or to a sequence - will construct own symbs
2564: if ($thisfn=~/\.(page|sequence)$/) { return 1; }
2565: # check URL part
2566: my ($map,$resid,$url)=split(/\_\_\_/,$symb);
2567: unless (&symbclean($url) eq &symbclean($thisfn)) { return 0; }
2568:
2569: $symb=&symbclean($symb);
2570:
2571: my %bighash;
2572: my $okay=0;
2573: if (tie(%bighash,'GDBM_File',$ENV{'request.course.fn'}.'.db',
2574: &GDBM_READER,0640)) {
2575: my $ids=$bighash{'ids_/res/'.$thisfn};
2576: unless ($ids) {
2577: $ids=$bighash{'ids_/'.$thisfn};
2578: }
2579: if ($ids) {
2580: # ------------------------------------------------------------------- Has ID(s)
2581: foreach (split(/\,/,$ids)) {
2582: my ($mapid,$resid)=split(/\./,$_);
2583: if (
2584: &symbclean(&declutter($bighash{'map_id_'.$mapid}).'___'.$resid.'___'.$thisfn)
2585: eq $symb) {
2586: $okay=1;
2587: }
2588: }
2589: }
2590: untie(%bighash);
2591: }
2592: return $okay;
2593: }
2594:
2595: # --------------------------------------------------------------- Clean-up symb
2596:
2597: sub symbclean {
2598: my $symb=shift;
2599:
2600: # remove version from map
2601: $symb=~s/\.(\d+)\.(\w+)\_\_\_/\.$2\_\_\_/;
2602:
2603: # remove version from URL
2604: $symb=~s/\.(\d+)\.(\w+)$/\.$2/;
2605:
2606: return $symb;
2607: }
2608:
2609: # ------------------------------------------------------ Return symb list entry
2610:
2611: sub symbread {
2612: my $thisfn=shift;
2613: unless ($thisfn) {
2614: if ($ENV{'request.symb'}) { return &symbclean($ENV{'request.symb'}); }
2615: $thisfn=$ENV{'request.filename'};
2616: }
2617: $thisfn=declutter($thisfn);
2618: my %hash;
2619: my %bighash;
2620: my $syval='';
2621: if (($ENV{'request.course.fn'}) && ($thisfn)) {
2622: if (tie(%hash,'GDBM_File',$ENV{'request.course.fn'}.'_symb.db',
2623: &GDBM_READER,0640)) {
2624: $syval=$hash{$thisfn};
2625: untie(%hash);
2626: }
2627: # ---------------------------------------------------------- There was an entry
2628: if ($syval) {
2629: unless ($syval=~/\_\d+$/) {
2630: unless ($ENV{'form.request.prefix'}=~/\.(\d+)\_$/) {
2631: &appenv('request.ambiguous' => $thisfn);
2632: return '';
2633: }
2634: $syval.=$1;
2635: }
2636: } else {
2637: # ------------------------------------------------------- Was not in symb table
2638: if (tie(%bighash,'GDBM_File',$ENV{'request.course.fn'}.'.db',
2639: &GDBM_READER,0640)) {
2640: # ---------------------------------------------- Get ID(s) for current resource
2641: my $ids=$bighash{'ids_/res/'.$thisfn};
2642: unless ($ids) {
2643: $ids=$bighash{'ids_/'.$thisfn};
2644: }
2645: if ($ids) {
2646: # ------------------------------------------------------------------- Has ID(s)
2647: my @possibilities=split(/\,/,$ids);
2648: if ($#possibilities==0) {
2649: # ----------------------------------------------- There is only one possibility
2650: my ($mapid,$resid)=split(/\./,$ids);
2651: $syval=declutter($bighash{'map_id_'.$mapid}).'___'.$resid;
2652: } else {
2653: # ------------------------------------------ There is more than one possibility
2654: my $realpossible=0;
2655: foreach (@possibilities) {
2656: my $file=$bighash{'src_'.$_};
2657: if (&allowed('bre',$file)) {
2658: my ($mapid,$resid)=split(/\./,$_);
2659: if ($bighash{'map_type_'.$mapid} ne 'page') {
2660: $realpossible++;
2661: $syval=declutter($bighash{'map_id_'.$mapid}).
2662: '___'.$resid;
2663: }
2664: }
2665: }
2666: if ($realpossible!=1) { $syval=''; }
2667: }
2668: }
2669: untie(%bighash)
2670: }
2671: }
2672: if ($syval) {
2673: return &symbclean($syval.'___'.$thisfn);
2674: }
2675: }
2676: &appenv('request.ambiguous' => $thisfn);
2677: return '';
2678: }
2679:
2680: # ---------------------------------------------------------- Return random seed
2681:
2682: sub numval {
2683: my $txt=shift;
2684: $txt=~tr/A-J/0-9/;
2685: $txt=~tr/a-j/0-9/;
2686: $txt=~tr/K-T/0-9/;
2687: $txt=~tr/k-t/0-9/;
2688: $txt=~tr/U-Z/0-5/;
2689: $txt=~tr/u-z/0-5/;
2690: $txt=~s/\D//g;
2691: return int($txt);
2692: }
2693:
2694: sub rndseed {
2695: my ($symb,$courseid,$domain,$username)=@_;
2696: if (!$symb) {
2697: unless ($symb=&symbread()) { return time; }
2698: }
2699: if (!$courseid) { $courseid=$ENV{'request.course.id'};}
2700: if (!$domain) {$domain=$ENV{'user.domain'};}
2701: if (!$username) {$username=$ENV{'user.name'};}
2702: {
2703: use integer;
2704: my $symbchck=unpack("%32C*",$symb) << 27;
2705: my $symbseed=numval($symb) << 22;
2706: my $namechck=unpack("%32C*",$username) << 17;
2707: my $nameseed=numval($username) << 12;
2708: my $domainseed=unpack("%32C*",$domain) << 7;
2709: my $courseseed=unpack("%32C*",$courseid);
2710: my $num=$symbseed+$nameseed+$domainseed+$courseseed+$namechck+$symbchck;
2711: #uncommenting these lines can break things!
2712: #&Apache::lonxml::debug("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
2713: #&Apache::lonxml::debug("rndseed :$num:$symb");
2714: return $num;
2715: }
2716: }
2717:
2718: sub ireceipt {
2719: my ($funame,$fudom,$fucourseid,$fusymb)=@_;
2720: my $cuname=unpack("%32C*",$funame);
2721: my $cudom=unpack("%32C*",$fudom);
2722: my $cucourseid=unpack("%32C*",$fucourseid);
2723: my $cusymb=unpack("%32C*",$fusymb);
2724: my $cunique=unpack("%32C*",$perlvar{'lonReceipt'});
2725: return unpack("%32C*",$perlvar{'lonHostID'}).'-'.
2726: ($cunique%$cuname+
2727: $cunique%$cudom+
2728: $cusymb%$cuname+
2729: $cusymb%$cudom+
2730: $cucourseid%$cuname+
2731: $cucourseid%$cudom);
2732: }
2733:
2734: sub receipt {
2735: return &ireceipt($ENV{'user.name'},$ENV{'user.domain'},
2736: $ENV{'request.course.id'},&symbread());
2737: }
2738:
2739: # ------------------------------------------------------------ Serves up a file
2740: # returns either the contents of the file or a -1
2741: sub getfile {
2742: my $file=shift;
2743: &repcopy($file);
2744: if (! -e $file ) { return -1; };
2745: my $fh=Apache::File->new($file);
2746: my $a='';
2747: while (<$fh>) { $a .=$_; }
2748: return $a
2749: }
2750:
2751: sub filelocation {
2752: my ($dir,$file) = @_;
2753: my $location;
2754: $file=~ s/^\s*(\S+)\s*$/$1/; ## strip off leading and trailing spaces
2755: if ($file=~m:^/~:) { # is a contruction space reference
2756: $location = $file;
2757: $location =~ s:/~(.*?)/(.*):/home/$1/public_html/$2:;
2758: } else {
2759: $file=~s/^$perlvar{'lonDocRoot'}//;
2760: $file=~s:^/*res::;
2761: if ( !( $file =~ m:^/:) ) {
2762: $location = $dir. '/'.$file;
2763: } else {
2764: $location = '/home/httpd/html/res'.$file;
2765: }
2766: }
2767: $location=~s://+:/:g; # remove duplicate /
2768: while ($location=~m:/\.\./:) {$location=~ s:/[^/]+/\.\./:/:g;} #remove dir/..
2769: return $location;
2770: }
2771:
2772: sub hreflocation {
2773: my ($dir,$file)=@_;
2774: unless (($file=~/^http:\/\//i) || ($file=~/^\//)) {
2775: my $finalpath=filelocation($dir,$file);
2776: $finalpath=~s/^\/home\/httpd\/html//;
2777: $finalpath=~s-/home/(\w+)/public_html/-/~$1/-;
2778: return $finalpath;
2779: } else {
2780: return $file;
2781: }
2782: }
2783:
2784: # ------------------------------------------------------------- Declutters URLs
2785:
2786: sub declutter {
2787: my $thisfn=shift;
2788: $thisfn=~s/^$perlvar{'lonDocRoot'}//;
2789: $thisfn=~s/^\///;
2790: $thisfn=~s/^res\///;
2791: return $thisfn;
2792: }
2793:
2794: # -------------------------------------------------------- Escape Special Chars
2795:
2796: sub escape {
2797: my $str=shift;
2798: $str =~ s/(\W)/"%".unpack('H2',$1)/eg;
2799: return $str;
2800: }
2801:
2802: # ----------------------------------------------------- Un-Escape Special Chars
2803:
2804: sub unescape {
2805: my $str=shift;
2806: $str =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
2807: return $str;
2808: }
2809:
2810: # ================================================================ Main Program
2811:
2812: sub goodbye {
2813: &logthis("Starting Shut down");
2814: &flushcourselogs();
2815: &logthis("Shutting down");
2816: }
2817:
2818: BEGIN {
2819: # ----------------------------------- Read loncapa.conf and loncapa_apache.conf
2820: unless ($readit) {
2821: {
2822: my $config=Apache::File->new("/etc/httpd/conf/loncapa.conf");
2823:
2824: while (my $configline=<$config>) {
2825: if ($configline =~ /^[^\#]*PerlSetVar/) {
2826: my ($dummy,$varname,$varvalue)=split(/\s+/,$configline);
2827: chomp($varvalue);
2828: $perlvar{$varname}=$varvalue;
2829: }
2830: }
2831: }
2832: {
2833: my $config=Apache::File->new("/etc/httpd/conf/loncapa_apache.conf");
2834:
2835: while (my $configline=<$config>) {
2836: if ($configline =~ /^[^\#]*PerlSetVar/) {
2837: my ($dummy,$varname,$varvalue)=split(/\s+/,$configline);
2838: chomp($varvalue);
2839: $perlvar{$varname}=$varvalue;
2840: }
2841: }
2842: }
2843:
2844: # ------------------------------------------------------------- Read hosts file
2845: {
2846: my $config=Apache::File->new("$perlvar{'lonTabDir'}/hosts.tab");
2847:
2848: while (my $configline=<$config>) {
2849: chomp($configline);
2850: my ($id,$domain,$role,$name,$ip)=split(/:/,$configline);
2851: $hostname{$id}=$name;
2852: $hostdom{$id}=$domain;
2853: $hostip{$id}=$ip;
2854: if ($role eq 'library') { $libserv{$id}=$name; }
2855: }
2856: }
2857:
2858: # ------------------------------------------------------ Read spare server file
2859: {
2860: my $config=Apache::File->new("$perlvar{'lonTabDir'}/spare.tab");
2861:
2862: while (my $configline=<$config>) {
2863: chomp($configline);
2864: if (($configline) && ($configline ne $perlvar{'lonHostID'})) {
2865: $spareid{$configline}=1;
2866: }
2867: }
2868: }
2869: # ------------------------------------------------------------ Read permissions
2870: {
2871: my $config=Apache::File->new("$perlvar{'lonTabDir'}/roles.tab");
2872:
2873: while (my $configline=<$config>) {
2874: chomp($configline);
2875: if ($configline) {
2876: my ($role,$perm)=split(/ /,$configline);
2877: if ($perm ne '') { $pr{$role}=$perm; }
2878: }
2879: }
2880: }
2881:
2882: # -------------------------------------------- Read plain texts for permissions
2883: {
2884: my $config=Apache::File->new("$perlvar{'lonTabDir'}/rolesplain.tab");
2885:
2886: while (my $configline=<$config>) {
2887: chomp($configline);
2888: if ($configline) {
2889: my ($short,$plain)=split(/:/,$configline);
2890: if ($plain ne '') { $prp{$short}=$plain; }
2891: }
2892: }
2893: }
2894:
2895: # ---------------------------------------------------------- Read package table
2896: {
2897: my $config=Apache::File->new("$perlvar{'lonTabDir'}/packages.tab");
2898:
2899: while (my $configline=<$config>) {
2900: chomp($configline);
2901: my ($short,$plain)=split(/:/,$configline);
2902: my ($pack,$name)=split(/\&/,$short);
2903: if ($plain ne '') {
2904: $packagetab{$pack.'&'.$name.'&name'}=$name;
2905: $packagetab{$short}=$plain;
2906: }
2907: }
2908: }
2909:
2910: %metacache=();
2911:
2912: $processmarker=$$.'_'.time.'_'.$perlvar{'lonHostID'};
2913: $dumpcount=0;
2914:
2915: &logtouch();
2916: &logthis('<font color=yellow>INFO: Read configuration</font>');
2917: $readit=1;
2918: }
2919: }
2920:
2921: 1;
2922: __END__
2923:
2924: =head1 NAME
2925:
2926: Apache::lonnet - TCP networking package
2927:
2928: =head1 SYNOPSIS
2929:
2930: Invoked by other LON-CAPA modules.
2931:
2932: &Apache::lonnet::SUBROUTINENAME(ARGUMENTS);
2933:
2934: =head1 INTRODUCTION
2935:
2936: This module provides subroutines which interact with the
2937: lonc/lond (TCP) network layer of LON-CAPA.
2938:
2939: This is part of the LearningOnline Network with CAPA project
2940: described at http://www.lon-capa.org.
2941:
2942: =head1 HANDLER SUBROUTINE
2943:
2944: There is no handler routine for this module.
2945:
2946: =head1 OTHER SUBROUTINES
2947:
2948: =over 4
2949:
2950: =item *
2951:
2952: logtouch() : make sure the logfile, lonnet.log, exists
2953:
2954: =item *
2955:
2956: logthis() : append message to lonnet.log
2957:
2958: =item *
2959:
2960: logperm() : append a permanent message to lonnet.perm.log
2961:
2962: =item *
2963:
2964: subreply() : non-critical communication, called by &reply
2965:
2966: =item *
2967:
2968: reply() : makes two attempts to pass message; logs refusals and rejections
2969:
2970: =item *
2971:
2972: reconlonc() : tries to reconnect lonc client processes.
2973:
2974: =item *
2975:
2976: critical() : passes a critical message to another server; if cannot get
2977: through then place message in connection buffer
2978:
2979: =item *
2980:
2981: appenv(%hash) : read in current user environment, append new environment
2982: values to make new user environment
2983:
2984: =item *
2985:
2986: delenv($varname) : read in current user environment, remove all values
2987: beginning with $varname, write new user environment (note: flock is used
2988: to prevent conflicting shared read/writes with file)
2989:
2990: =item *
2991:
2992: spareserver() : find server with least workload from spare.tab
2993:
2994: =item *
2995:
2996: queryauthenticate($uname,$udom) : try to determine user's current
2997: authentication scheme
2998:
2999: =item *
3000:
3001: authenticate($uname,$upass,$udom) : try to authenticate user from domain's lib
3002: servers (first use the current one)
3003:
3004: =item *
3005:
3006: homeserver($uname,$udom) : find the homebase for a user from domain's lib
3007: servers
3008:
3009: =item *
3010:
3011: idget($udom,@ids) : find the usernames behind a list of IDs (returns hash:
3012: id=>name,id=>name)
3013:
3014: =item *
3015:
3016: idrget($udom,@unames) : find the IDs behind a list of usernames (returns hash:
3017: name=>id,name=>id)
3018:
3019: =item *
3020:
3021: idput($udom,%ids) : store away a list of names and associated IDs
3022:
3023: =item *
3024:
3025: usection($domain,$user,$courseid) : output of section name/number or '' for
3026: "not in course" and '-1' for "no section"
3027:
3028: =item *
3029:
3030: userenvironment($domain,$user,$what) : puts out any environment parameter
3031: for a user
3032:
3033: =item *
3034:
3035: subscribe($fname) : subscribe to a resource, return URL if possible
3036:
3037: =item *
3038:
3039: repcopy($filename) : replicate file
3040:
3041: =item *
3042:
3043: ssi($url,%hash) : server side include, does a complete request cycle on url to
3044: localhost, posts hash
3045:
3046: =item *
3047:
3048: log($domain,$name,$home,$message) : write to permanent log for user; use
3049: critical subroutine
3050:
3051: =item *
3052:
3053: flushcourselogs() : flush (save) buffer logs and access logs
3054:
3055: =item *
3056:
3057: courselog($what) : save message for course in hash
3058:
3059: =item *
3060:
3061: courseacclog($what) : save message for course using &courselog(). Perform
3062: special processing for specific resource types (problems, exams, quizzes, etc).
3063:
3064: =item *
3065:
3066: countacc($url) : count the number of accesses to a given URL
3067:
3068: =item *
3069:
3070: sub checkout($symb,$tuname,$tudom,$tcrsid) : check out an item
3071:
3072: =item *
3073:
3074: sub checkin($token) : check in an item
3075:
3076: =item *
3077:
3078: sub expirespread($uname,$udom,$stype,$usymb) : set expire date for spreadsheet
3079:
3080: =item *
3081:
3082: devalidate($symb) : devalidate spreadsheets
3083:
3084: =item *
3085:
3086: hash2str(%hash) : convert a hash into a string complete with escaping and '='
3087: and '&' separators, supports elements that are arrayrefs and hashrefs
3088:
3089: =item *
3090:
3091: hashref2str($hashref) : convert a hashref into a string complete with
3092: escaping and '=' and '&' separators, supports elements that are
3093: arrayrefs and hashrefs
3094:
3095: =item *
3096:
3097: arrayref2str($arrayref) : convert an arrayref into a string complete
3098: with escaping and '&' separators, supports elements that are arrayrefs
3099: and hashrefs
3100:
3101: =item *
3102:
3103: str2hash($string) : convert string to hash using unescaping and
3104: splitting on '=' and '&', supports elements that are arrayrefs and
3105: hashrefs
3106:
3107: =item *
3108:
3109: str2array($string) : convert string to hash using unescaping and
3110: splitting on '&', supports elements that are arrayrefs and hashrefs
3111:
3112: =item *
3113:
3114: tmpreset($symb,$namespace,$domain,$stuname) : temporary storage
3115:
3116: =item *
3117:
3118: tmprestore($symb,$namespace,$domain,$stuname) : temporary restore
3119:
3120: =item *
3121:
3122: store($storehash,$symb,$namespace,$domain,$stuname) : stores hash permanently
3123: for this url; hashref needs to be given and should be a \%hashname; the
3124: remaining args aren't required and if they aren't passed or are '' they will
3125: be derived from the ENV
3126:
3127: =item *
3128:
3129: cstore($storehash,$symb,$namespace,$domain,$stuname) : same as store but
3130: uses critical subroutine
3131:
3132: =item *
3133:
3134: restore($symb,$namespace,$domain,$stuname) : returns hash for this symb;
3135: all args are optional
3136:
3137: =item *
3138:
3139: coursedescription($courseid) : course description
3140:
3141: =item *
3142:
3143: rolesinit($domain,$username,$authhost) : get user privileges
3144:
3145: =item *
3146:
3147: get($namespace,$storearr,$udomain,$uname) : returns hash with keys from array
3148: reference filled in from namesp ($udomain and $uname are optional)
3149:
3150: =item *
3151:
3152: del($namespace,$storearr,$udomain,$uname) : deletes keys out of array from
3153: namesp ($udomain and $uname are optional)
3154:
3155: =item *
3156:
3157: dump($namespace,$udomain,$uname,$regexp) :
3158: dumps the complete (or key matching regexp) namespace into a hash
3159: ($udomain, $uname and $regexp are optional)
3160:
3161: =item *
3162:
3163: put($namespace,$storehash,$udomain,$uname) : stores hash in namesp
3164: ($udomain and $uname are optional)
3165:
3166: =item *
3167:
3168: cput($namespace,$storehash,$udomain,$uname) : critical put
3169: ($udomain and $uname are optional)
3170:
3171: =item *
3172:
3173: eget($namespace,$storearr,$udomain,$uname) : returns hash with keys from array
3174: reference filled in from namesp (encrypts the return communication)
3175: ($udomain and $uname are optional)
3176:
3177: =item *
3178:
3179: allowed($priv,$uri) : check for a user privilege; returns codes for allowed
3180: actions
3181: F: full access
3182: U,I,K: authentication modes (cxx only)
3183: '': forbidden
3184: 1: user needs to choose course
3185: 2: browse allowed
3186:
3187: =item *
3188:
3189: definerole($rolename,$sysrole,$domrole,$courole) : define role; define a custom
3190: role rolename set privileges in format of lonTabs/roles.tab for system, domain,
3191: and course level
3192:
3193: =item *
3194:
3195: metadata_query($query,$custom,$customshow) : make a metadata query against the
3196: network of library servers; returns file handle of where SQL and regex results
3197: will be stored for query
3198:
3199: =item *
3200:
3201: plaintext($short) : return value in %prp hash (rolesplain.tab); plain text
3202: explanation of a user role term
3203:
3204: =item *
3205:
3206: assignrole($udom,$uname,$url,$role,$end,$start) : assign role; give a role to a
3207: user for the level given by URL. Optional start and end dates (leave empty
3208: string or zero for "no date")
3209:
3210: =item *
3211:
3212: modifyuserauth($udom,$uname,$umode,$upass) : modify user authentication
3213:
3214: =item *
3215:
3216: modifyuser($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene) :
3217: modify user
3218:
3219: =item *
3220:
3221: modifystudent($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene,$usec,
3222: $end,$start) : modify student
3223:
3224: =item *
3225:
3226: writecoursepref($courseid,%prefs) : write preferences for a course
3227:
3228: =item *
3229:
3230: createcourse($udom,$description,$url) : make/modify course
3231:
3232: =item *
3233:
3234: assigncustomrole($udom,$uname,$url,$rdom,$rnam,$rolename,$end,$start) : assign
3235: custom role; give a custom role to a user for the level given by URL. Specify
3236: name and domain of role author, and role name
3237:
3238: =item *
3239:
3240: revokerole($udom,$uname,$url,$role) : revoke a role for url
3241:
3242: =item *
3243:
3244: revokecustomrole($udom,$uname,$url,$role) : revoke a custom role
3245:
3246: =item *
3247:
3248: dirlist($uri) : return directory list based on URI
3249:
3250: =item *
3251:
3252: directcondval($number) : get current value of a condition; reads from a state
3253: string
3254:
3255: =item *
3256:
3257: condval($condidx) : value of condition index based on state
3258:
3259: =item *
3260:
3261: EXT($varname,$symbparm) : value of a variable
3262:
3263: =item *
3264:
3265: metadata($uri,$what,$liburi,$prefix,$depthcount) : get metadata; returns the
3266: metadata entry for a file; entry='keys', returns a comma separated list of keys
3267:
3268: =item *
3269:
3270: symblist($mapname,%newhash) : update symbolic storage links
3271:
3272: =item *
3273:
3274: symbread($filename) : return symbolic list entry (filename argument optional);
3275: returns the data handle
3276:
3277: =item *
3278:
3279: numval($salt) : return random seed value (addend for rndseed)
3280:
3281: =item *
3282:
3283: rndseed($symb,$courseid,$domain,$username) : create a random sum; returns
3284: a random seed, all arguments are optional, if they aren't sent it uses the
3285: environment to derive them. Note: if symb isn't sent and it can't get one
3286: from &symbread it will use the current time as its return value
3287:
3288: =item *
3289:
3290: ireceipt($funame,$fudom,$fucourseid,$fusymb) : return unique,
3291: unfakeable, receipt
3292:
3293: =item *
3294:
3295: receipt() : API to ireceipt working off of ENV values; given out to users
3296:
3297: =item *
3298:
3299: getfile($file) : serves up a file, returns the contents of a file or -1;
3300: replicates and subscribes to the file
3301:
3302: =item *
3303:
3304: filelocation($dir,$file) : returns file system location of a file based on URI;
3305: meant to be "fairly clean" absolute reference, $dir is a directory that relative $file lookups are to looked in ($dir of /a/dir and a file of ../bob will become /a/bob)
3306:
3307: =item *
3308:
3309: hreflocation($dir,$file) : returns file system location or a URL; same as
3310: filelocation except for hrefs
3311:
3312: =item *
3313:
3314: declutter() : declutters URLs (remove docroot, beginning slashes, 'res' etc)
3315:
3316: =item *
3317:
3318: escape() : unpack non-word characters into CGI-compatible hex codes
3319:
3320: =item *
3321:
3322: unescape() : pack CGI-compatible hex codes into actual non-word ASCII character
3323:
3324: =item *
3325:
3326: goodbye() : flush course logs and log shutting down; it is called in srm.conf
3327: as a PerlChildExitHandler
3328:
3329: =back
3330:
3331: =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