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