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