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