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