Annotation of loncom/lonnet/perl/lonnet.pm, revision 1.468
1.1 albertel 1: # The LearningOnline Network
2: # TCP networking package
1.12 www 3: #
1.468 ! albertel 4: # $Id: lonnet.pm,v 1.467 2004/01/30 14:42:00 matthew 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: ###
29:
1.1 albertel 30: package Apache::lonnet;
31:
32: use strict;
1.8 www 33: use LWP::UserAgent();
1.15 www 34: use HTTP::Headers;
1.11 www 35: use vars
1.300 albertel 36: qw(%perlvar %hostname %homecache %badServerCache %hostip %iphost %spareid %hostdom
1.440 www 37: %libserv %pr %prp %metacache %packagetab %titlecache %courseresversioncache %resversioncache
1.349 www 38: %courselogs %accesshash %userrolehash $processmarker $dumpcount
1.352 www 39: %coursedombuf %coursenumbuf %coursehombuf %coursedescrbuf %courseresdatacache
1.420 albertel 40: %userresdatacache %usectioncache %domaindescription %domain_auth_def %domain_auth_arg_def
1.403 www 41: %domain_lang_def %domain_city %domain_longi %domain_lati $tmpdir);
42:
1.1 albertel 43: use IO::Socket;
1.31 www 44: use GDBM_File;
1.8 www 45: use Apache::Constants qw(:common :http);
1.208 albertel 46: use HTML::LCParser;
1.88 www 47: use Fcntl qw(:flock);
1.294 matthew 48: use Apache::loncoursedata;
1.414 www 49: use Apache::lonlocal;
1.428 albertel 50: use Storable qw(lock_store lock_nstore lock_retrieve freeze thaw);
1.425 albertel 51: use Time::HiRes();
1.195 www 52: my $readit;
1.1 albertel 53:
1.449 matthew 54: =pod
55:
56: =head1 Package Variables
57:
58: These are largely undocumented, so if you decipher one please note it here.
59:
60: =over 4
61:
62: =item $processmarker
63:
64: Contains the time this process was started and this servers host id.
65:
66: =item $dumpcount
67:
68: Counts the number of times a message log flush has been attempted (regardless
69: of success) by this process. Used as part of the filename when messages are
70: delayed.
71:
72: =back
73:
74: =cut
75:
76:
1.1 albertel 77: # --------------------------------------------------------------------- Logging
78:
1.163 harris41 79: sub logtouch {
80: my $execdir=$perlvar{'lonDaemons'};
1.448 albertel 81: unless (-e "$execdir/logs/lonnet.log") {
82: open(my $fh,">>$execdir/logs/lonnet.log");
1.163 harris41 83: close $fh;
84: }
85: my ($wwwuid,$wwwgid)=(getpwnam('www'))[2,3];
86: chown($wwwuid,$wwwgid,$execdir.'/logs/lonnet.log');
87: }
88:
1.1 albertel 89: sub logthis {
90: my $message=shift;
91: my $execdir=$perlvar{'lonDaemons'};
92: my $now=time;
93: my $local=localtime($now);
1.448 albertel 94: if (open(my $fh,">>$execdir/logs/lonnet.log")) {
95: print $fh "$local ($$): $message\n";
96: close($fh);
97: }
1.1 albertel 98: return 1;
99: }
100:
101: sub logperm {
102: my $message=shift;
103: my $execdir=$perlvar{'lonDaemons'};
104: my $now=time;
105: my $local=localtime($now);
1.448 albertel 106: if (open(my $fh,">>$execdir/logs/lonnet.perm.log")) {
107: print $fh "$now:$message:$local\n";
108: close($fh);
109: }
1.1 albertel 110: return 1;
111: }
112:
113: # -------------------------------------------------- Non-critical communication
114: sub subreply {
115: my ($cmd,$server)=@_;
116: my $peerfile="$perlvar{'lonSockDir'}/$server";
117: my $client=IO::Socket::UNIX->new(Peer =>"$peerfile",
118: Type => SOCK_STREAM,
119: Timeout => 10)
120: or return "con_lost";
121: print $client "$cmd\n";
122: my $answer=<$client>;
1.9 www 123: if (!$answer) { $answer="con_lost"; }
1.1 albertel 124: chomp($answer);
125: return $answer;
126: }
127:
128: sub reply {
129: my ($cmd,$server)=@_;
1.205 www 130: unless (defined($hostname{$server})) { return 'no_such_host'; }
1.1 albertel 131: my $answer=subreply($cmd,$server);
1.203 www 132: if ($answer eq 'con_lost') {
1.311 matthew 133: #sleep 5;
134: #$answer=subreply($cmd,$server);
135: #if ($answer eq 'con_lost') {
1.233 albertel 136: # &logthis("Second attempt con_lost on $server");
137: # my $peerfile="$perlvar{'lonSockDir'}/$server";
138: # my $client=IO::Socket::UNIX->new(Peer =>"$peerfile",
139: # Type => SOCK_STREAM,
140: # Timeout => 10)
141: # or return "con_lost";
142: # &logthis("Killing socket");
143: # print $client "close_connection_exit\n";
144: #sleep 5;
145: # $answer=subreply($cmd,$server);
146: #}
1.203 www 147: }
1.65 www 148: if (($answer=~/^refused/) || ($answer=~/^rejected/)) {
1.12 www 149: &logthis("<font color=blue>WARNING:".
150: " $cmd to $server returned $answer</font>");
151: }
1.1 albertel 152: return $answer;
153: }
154:
155: # ----------------------------------------------------------- Send USR1 to lonc
156:
157: sub reconlonc {
158: my $peerfile=shift;
159: &logthis("Trying to reconnect for $peerfile");
160: my $loncfile="$perlvar{'lonDaemons'}/logs/lonc.pid";
1.448 albertel 161: if (open(my $fh,"<$loncfile")) {
1.1 albertel 162: my $loncpid=<$fh>;
163: chomp($loncpid);
164: if (kill 0 => $loncpid) {
165: &logthis("lonc at pid $loncpid responding, sending USR1");
166: kill USR1 => $loncpid;
167: sleep 1;
168: if (-e "$peerfile") { return; }
169: &logthis("$peerfile still not there, give it another try");
170: sleep 5;
171: if (-e "$peerfile") { return; }
1.12 www 172: &logthis(
173: "<font color=blue>WARNING: $peerfile still not there, giving up</font>");
1.1 albertel 174: } else {
1.12 www 175: &logthis(
176: "<font color=blue>WARNING:".
177: " lonc at pid $loncpid not responding, giving up</font>");
1.1 albertel 178: }
179: } else {
1.12 www 180: &logthis('<font color=blue>WARNING: lonc not running, giving up</font>');
1.1 albertel 181: }
182: }
183:
184: # ------------------------------------------------------ Critical communication
1.12 www 185:
1.1 albertel 186: sub critical {
187: my ($cmd,$server)=@_;
1.89 www 188: unless ($hostname{$server}) {
189: &logthis("<font color=blue>WARNING:".
190: " Critical message to unknown server ($server)</font>");
191: return 'no_such_host';
192: }
1.1 albertel 193: my $answer=reply($cmd,$server);
194: if ($answer eq 'con_lost') {
195: my $pingreply=reply('ping',$server);
196: &reconlonc("$perlvar{'lonSockDir'}/$server");
197: my $pongreply=reply('pong',$server);
198: &logthis("Ping/Pong for $server: $pingreply/$pongreply");
199: $answer=reply($cmd,$server);
200: if ($answer eq 'con_lost') {
201: my $now=time;
202: my $middlename=$cmd;
1.5 www 203: $middlename=substr($middlename,0,16);
1.1 albertel 204: $middlename=~s/\W//g;
205: my $dfilename=
1.305 www 206: "$perlvar{'lonSockDir'}/delayed/$now.$dumpcount.$$.$middlename.$server";
207: $dumpcount++;
1.1 albertel 208: {
1.448 albertel 209: my $dfh;
210: if (open($dfh,">$dfilename")) {
211: print $dfh "$cmd\n";
212: close($dfh);
213: }
1.1 albertel 214: }
215: sleep 2;
216: my $wcmd='';
217: {
1.448 albertel 218: my $dfh;
219: if (open($dfh,"<$dfilename")) {
220: $wcmd=<$dfh>;
221: close($dfh);
222: }
1.1 albertel 223: }
224: chomp($wcmd);
1.7 www 225: if ($wcmd eq $cmd) {
1.12 www 226: &logthis("<font color=blue>WARNING: ".
227: "Connection buffer $dfilename: $cmd</font>");
1.1 albertel 228: &logperm("D:$server:$cmd");
229: return 'con_delayed';
230: } else {
1.12 www 231: &logthis("<font color=red>CRITICAL:"
232: ." Critical connection failed: $server $cmd</font>");
1.1 albertel 233: &logperm("F:$server:$cmd");
234: return 'con_failed';
235: }
236: }
237: }
238: return $answer;
1.405 albertel 239: }
240:
1.412 www 241: #
1.405 albertel 242: # -------------- Remove all key from the env that start witha lowercase letter
1.412 www 243: # (Which is always a lon-capa value)
244:
1.405 albertel 245: sub cleanenv {
1.412 www 246: # unless (defined(&Apache::exists_config_define("MODPERL2"))) { return; }
247: # unless (&Apache::exists_config_define("MODPERL2")) { return; }
1.405 albertel 248: foreach my $key (keys(%ENV)) {
249: if ($key =~ /^[a-z]/) {
250: delete($ENV{$key});
251: }
252: }
1.374 www 253: }
254:
255: # ------------------------------------------- Transfer profile into environment
256:
257: sub transfer_profile_to_env {
258: my ($lonidsdir,$handle)=@_;
259: my @profile;
260: {
1.448 albertel 261: open(my $idf,"$lonidsdir/$handle.id");
1.374 www 262: flock($idf,LOCK_SH);
263: @profile=<$idf>;
1.448 albertel 264: close($idf);
1.374 www 265: }
266: my $envi;
1.433 matthew 267: my %Remove;
1.374 www 268: for ($envi=0;$envi<=$#profile;$envi++) {
269: chomp($profile[$envi]);
270: my ($envname,$envvalue)=split(/=/,$profile[$envi]);
271: $ENV{$envname} = $envvalue;
1.433 matthew 272: if (my ($key,$time) = ($envname =~ /^(cgi\.(\d+)_\d+\.)/)) {
273: if ($time < time-300) {
274: $Remove{$key}++;
275: }
276: }
277: }
1.446 albertel 278: $ENV{'user.environment'} = "$lonidsdir/$handle.id";
1.433 matthew 279: foreach my $expired_key (keys(%Remove)) {
280: &delenv($expired_key);
1.374 www 281: }
1.1 albertel 282: }
283:
1.5 www 284: # ---------------------------------------------------------- Append Environment
285:
286: sub appenv {
1.6 www 287: my %newenv=@_;
1.191 harris41 288: foreach (keys %newenv) {
1.35 www 289: if (($newenv{$_}=~/^user\.role/) || ($newenv{$_}=~/^user\.priv/)) {
290: &logthis("<font color=blue>WARNING: ".
1.151 www 291: "Attempt to modify environment ".$_." to ".$newenv{$_}
292: .'</font>');
1.35 www 293: delete($newenv{$_});
294: } else {
295: $ENV{$_}=$newenv{$_};
296: }
1.191 harris41 297: }
1.95 www 298:
299: my $lockfh;
1.448 albertel 300: unless (open($lockfh,"$ENV{'user.environment'}")) {
301: return 'error: '.$!;
1.95 www 302: }
303: unless (flock($lockfh,LOCK_EX)) {
304: &logthis("<font color=blue>WARNING: ".
305: 'Could not obtain exclusive lock in appenv: '.$!);
1.448 albertel 306: close($lockfh);
1.95 www 307: return 'error: '.$!;
308: }
309:
1.6 www 310: my @oldenv;
311: {
1.448 albertel 312: my $fh;
313: unless (open($fh,"$ENV{'user.environment'}")) {
314: return 'error: '.$!;
315: }
316: @oldenv=<$fh>;
317: close($fh);
1.6 www 318: }
319: for (my $i=0; $i<=$#oldenv; $i++) {
320: chomp($oldenv[$i]);
1.9 www 321: if ($oldenv[$i] ne '') {
1.448 albertel 322: my ($name,$value)=split(/=/,$oldenv[$i]);
323: unless (defined($newenv{$name})) {
324: $newenv{$name}=$value;
325: }
1.9 www 326: }
1.6 www 327: }
328: {
1.448 albertel 329: my $fh;
330: unless (open($fh,">$ENV{'user.environment'}")) {
331: return 'error';
332: }
333: my $newname;
334: foreach $newname (keys %newenv) {
335: print $fh "$newname=$newenv{$newname}\n";
336: }
337: close($fh);
1.56 www 338: }
1.448 albertel 339:
340: close($lockfh);
1.56 www 341: return 'ok';
342: }
343: # ----------------------------------------------------- Delete from Environment
344:
345: sub delenv {
346: my $delthis=shift;
347: my %newenv=();
348: if (($delthis=~/user\.role/) || ($delthis=~/user\.priv/)) {
349: &logthis("<font color=blue>WARNING: ".
350: "Attempt to delete from environment ".$delthis);
351: return 'error';
352: }
353: my @oldenv;
354: {
1.448 albertel 355: my $fh;
356: unless (open($fh,"$ENV{'user.environment'}")) {
357: return 'error';
358: }
359: unless (flock($fh,LOCK_SH)) {
360: &logthis("<font color=blue>WARNING: ".
361: 'Could not obtain shared lock in delenv: '.$!);
362: close($fh);
363: return 'error: '.$!;
364: }
365: @oldenv=<$fh>;
366: close($fh);
1.56 www 367: }
368: {
1.448 albertel 369: my $fh;
370: unless (open($fh,">$ENV{'user.environment'}")) {
371: return 'error';
372: }
373: unless (flock($fh,LOCK_EX)) {
374: &logthis("<font color=blue>WARNING: ".
375: 'Could not obtain exclusive lock in delenv: '.$!);
376: close($fh);
377: return 'error: '.$!;
378: }
379: foreach (@oldenv) {
380: unless ($_=~/^$delthis/) { print $fh $_; }
381: }
382: close($fh);
1.5 www 383: }
384: return 'ok';
1.369 albertel 385: }
386:
387: # ------------------------------------------ Find out current server userload
388: # there is a copy in lond
389: sub userload {
390: my $numusers=0;
391: {
392: opendir(LONIDS,$perlvar{'lonIDsDir'});
393: my $filename;
394: my $curtime=time;
395: while ($filename=readdir(LONIDS)) {
396: if ($filename eq '.' || $filename eq '..') {next;}
1.404 albertel 397: my ($mtime)=(stat($perlvar{'lonIDsDir'}.'/'.$filename))[9];
1.437 albertel 398: if ($curtime-$mtime < 1800) { $numusers++; }
1.369 albertel 399: }
400: closedir(LONIDS);
401: }
402: my $userloadpercent=0;
403: my $maxuserload=$perlvar{'lonUserLoadLim'};
404: if ($maxuserload) {
1.371 albertel 405: $userloadpercent=100*$numusers/$maxuserload;
1.369 albertel 406: }
1.372 albertel 407: $userloadpercent=sprintf("%.2f",$userloadpercent);
1.369 albertel 408: return $userloadpercent;
1.283 www 409: }
410:
411: # ------------------------------------------ Fight off request when overloaded
412:
413: sub overloaderror {
414: my ($r,$checkserver)=@_;
415: unless ($checkserver) { $checkserver=$perlvar{'lonHostID'}; }
416: my $loadavg;
417: if ($checkserver eq $perlvar{'lonHostID'}) {
1.448 albertel 418: open(my $loadfile,'/proc/loadavg');
1.283 www 419: $loadavg=<$loadfile>;
420: $loadavg =~ s/\s.*//g;
1.285 matthew 421: $loadavg = 100*$loadavg/$perlvar{'lonLoadLim'};
1.448 albertel 422: close($loadfile);
1.283 www 423: } else {
424: $loadavg=&reply('load',$checkserver);
425: }
1.285 matthew 426: my $overload=$loadavg-100;
1.283 www 427: if ($overload>0) {
1.285 matthew 428: $r->err_headers_out->{'Retry-After'}=$overload;
1.283 www 429: $r->log_error('Overload of '.$overload.' on '.$checkserver);
430: return 413;
431: }
432: return '';
1.5 www 433: }
1.1 albertel 434:
435: # ------------------------------ Find server with least workload from spare.tab
1.11 www 436:
1.1 albertel 437: sub spareserver {
1.370 albertel 438: my ($loadpercent,$userloadpercent) = @_;
1.1 albertel 439: my $tryserver;
440: my $spareserver='';
1.370 albertel 441: if ($userloadpercent !~ /\d/) { $userloadpercent=0; }
442: my $lowestserver=$loadpercent > $userloadpercent?
443: $loadpercent : $userloadpercent;
1.1 albertel 444: foreach $tryserver (keys %spareid) {
1.411 albertel 445: my $loadans=reply('load',$tryserver);
446: my $userloadans=reply('userload',$tryserver);
447: if ($loadans !~ /\d/ && $userloadans !~ /\d/) {
448: next; #didn't get a number from the server
449: }
450: my $answer;
451: if ($loadans =~ /\d/) {
452: if ($userloadans =~ /\d/) {
453: #both are numbers, pick the bigger one
454: $answer=$loadans > $userloadans?
455: $loadans : $userloadans;
456: } else {
457: $answer = $loadans;
458: }
459: } else {
460: $answer = $userloadans;
461: }
462: if (($answer =~ /\d/) && ($answer<$lowestserver)) {
463: $spareserver="http://$hostname{$tryserver}";
464: $lowestserver=$answer;
465: }
1.370 albertel 466: }
1.1 albertel 467: return $spareserver;
1.202 matthew 468: }
469:
470: # --------------------------------------------- Try to change a user's password
471:
472: sub changepass {
473: my ($uname,$udom,$currentpass,$newpass,$server)=@_;
474: $currentpass = &escape($currentpass);
475: $newpass = &escape($newpass);
476: my $answer = reply("encrypt:passwd:$udom:$uname:$currentpass:$newpass",
477: $server);
478: if (! $answer) {
479: &logthis("No reply on password change request to $server ".
480: "by $uname in domain $udom.");
481: } elsif ($answer =~ "^ok") {
482: &logthis("$uname in $udom successfully changed their password ".
483: "on $server.");
484: } elsif ($answer =~ "^pwchange_failure") {
485: &logthis("$uname in $udom was unable to change their password ".
486: "on $server. The action was blocked by either lcpasswd ".
487: "or pwchange");
488: } elsif ($answer =~ "^non_authorized") {
489: &logthis("$uname in $udom did not get their password correct when ".
490: "attempting to change it on $server.");
491: } elsif ($answer =~ "^auth_mode_error") {
492: &logthis("$uname in $udom attempted to change their password despite ".
493: "not being locally or internally authenticated on $server.");
494: } elsif ($answer =~ "^unknown_user") {
495: &logthis("$uname in $udom attempted to change their password ".
496: "on $server but were unable to because $server is not ".
497: "their home server.");
498: } elsif ($answer =~ "^refused") {
499: &logthis("$server refused to change $uname in $udom password because ".
500: "it was sent an unencrypted request to change the password.");
501: }
502: return $answer;
1.1 albertel 503: }
504:
1.169 harris41 505: # ----------------------- Try to determine user's current authentication scheme
506:
507: sub queryauthenticate {
508: my ($uname,$udom)=@_;
1.456 albertel 509: my $uhome=&homeserver($uname,$udom);
510: if (!$uhome) {
511: &logthis("User $uname at $udom is unknown when looking for authentication mechanism");
512: return 'no_host';
513: }
514: my $answer=reply("encrypt:currentauth:$udom:$uname",$uhome);
515: if ($answer =~ /^(unknown_user|refused|con_lost)/) {
516: &logthis("User $uname at $udom threw error $answer when checking authentication mechanism");
1.169 harris41 517: }
1.456 albertel 518: return $answer;
1.169 harris41 519: }
520:
1.1 albertel 521: # --------- Try to authenticate user from domain's lib servers (first this one)
1.11 www 522:
1.1 albertel 523: sub authenticate {
524: my ($uname,$upass,$udom)=@_;
1.12 www 525: $upass=escape($upass);
1.199 www 526: $uname=~s/\W//g;
1.1 albertel 527: if (($perlvar{'lonRole'} eq 'library') &&
528: ($udom eq $perlvar{'lonDefDomain'})) {
1.3 www 529: my $answer=reply("encrypt:auth:$udom:$uname:$upass",$perlvar{'lonHostID'});
1.2 www 530: if ($answer =~ /authorized/) {
1.9 www 531: if ($answer eq 'authorized') {
532: &logthis("User $uname at $udom authorized by local server");
533: return $perlvar{'lonHostID'};
534: }
535: if ($answer eq 'non_authorized') {
536: &logthis("User $uname at $udom rejected by local server");
537: return 'no_host';
538: }
1.2 www 539: }
1.1 albertel 540: }
541:
542: my $tryserver;
543: foreach $tryserver (keys %libserv) {
544: if ($hostdom{$tryserver} eq $udom) {
1.10 www 545: my $answer=reply("encrypt:auth:$udom:$uname:$upass",$tryserver);
1.1 albertel 546: if ($answer =~ /authorized/) {
1.9 www 547: if ($answer eq 'authorized') {
548: &logthis("User $uname at $udom authorized by $tryserver");
549: return $tryserver;
550: }
551: if ($answer eq 'non_authorized') {
552: &logthis("User $uname at $udom rejected by $tryserver");
553: return 'no_host';
554: }
1.1 albertel 555: }
556: }
1.9 www 557: }
558: &logthis("User $uname at $udom could not be authenticated");
1.1 albertel 559: return 'no_host';
560: }
561:
562: # ---------------------- Find the homebase for a user from domain's lib servers
1.11 www 563:
1.1 albertel 564: sub homeserver {
1.230 stredwic 565: my ($uname,$udom,$ignoreBadCache)=@_;
1.1 albertel 566: my $index="$uname:$udom";
1.426 albertel 567:
568: my ($result,$cached)=&is_cached(\%homecache,$index,'home',86400);
569: if (defined($cached)) { return $result; }
1.1 albertel 570: my $tryserver;
571: foreach $tryserver (keys %libserv) {
1.230 stredwic 572: next if ($ignoreBadCache ne 'true' &&
1.231 stredwic 573: exists($badServerCache{$tryserver}));
1.1 albertel 574: if ($hostdom{$tryserver} eq $udom) {
575: my $answer=reply("home:$udom:$uname",$tryserver);
576: if ($answer eq 'found') {
1.426 albertel 577: return &do_cache(\%homecache,$index,$tryserver,'home');
1.231 stredwic 578: } elsif ($answer eq 'no_host') {
579: $badServerCache{$tryserver}=1;
1.221 matthew 580: }
1.1 albertel 581: }
582: }
583: return 'no_host';
1.70 www 584: }
585:
586: # ------------------------------------- Find the usernames behind a list of IDs
587:
588: sub idget {
589: my ($udom,@ids)=@_;
590: my %returnhash=();
591:
592: my $tryserver;
593: foreach $tryserver (keys %libserv) {
594: if ($hostdom{$tryserver} eq $udom) {
595: my $idlist=join('&',@ids);
596: $idlist=~tr/A-Z/a-z/;
597: my $reply=&reply("idget:$udom:".$idlist,$tryserver);
598: my @answer=();
1.76 www 599: if (($reply ne 'con_lost') && ($reply!~/^error\:/)) {
1.70 www 600: @answer=split(/\&/,$reply);
601: } ;
602: my $i;
603: for ($i=0;$i<=$#ids;$i++) {
604: if ($answer[$i]) {
605: $returnhash{$ids[$i]}=$answer[$i];
606: }
607: }
608: }
609: }
610: return %returnhash;
611: }
612:
613: # ------------------------------------- Find the IDs behind a list of usernames
614:
615: sub idrget {
616: my ($udom,@unames)=@_;
617: my %returnhash=();
1.191 harris41 618: foreach (@unames) {
1.70 www 619: $returnhash{$_}=(&userenvironment($udom,$_,'id'))[1];
1.191 harris41 620: }
1.70 www 621: return %returnhash;
622: }
623:
624: # ------------------------------- Store away a list of names and associated IDs
625:
626: sub idput {
627: my ($udom,%ids)=@_;
628: my %servers=();
1.191 harris41 629: foreach (keys %ids) {
1.70 www 630: my $uhom=&homeserver($_,$udom);
631: if ($uhom ne 'no_host') {
632: my $id=&escape($ids{$_});
633: $id=~tr/A-Z/a-z/;
634: my $unam=&escape($_);
635: if ($servers{$uhom}) {
636: $servers{$uhom}.='&'.$id.'='.$unam;
637: } else {
638: $servers{$uhom}=$id.'='.$unam;
639: }
640: &critical('put:'.$udom.':'.$unam.':environment:id='.$id,$uhom);
641: }
1.191 harris41 642: }
643: foreach (keys %servers) {
1.70 www 644: &critical('idput:'.$udom.':'.$servers{$_},$_);
1.191 harris41 645: }
1.344 www 646: }
647:
648: # --------------------------------------------------- Assign a key to a student
649:
650: sub assign_access_key {
1.364 www 651: #
652: # a valid key looks like uname:udom#comments
653: # comments are being appended
654: #
655: my ($ckey,$cdom,$cnum,$udom,$uname,$logentry)=@_;
1.344 www 656: $cdom=
657: $ENV{'course.'.$ENV{'request.course.id'}.'.domain'} unless (defined($cdom));
658: $cnum=
659: $ENV{'course.'.$ENV{'request.course.id'}.'.num'} unless (defined($cnum));
660: $udom=$ENV{'user.name'} unless (defined($udom));
661: $uname=$ENV{'user.domain'} unless (defined($uname));
1.345 www 662: my %existing=&get('accesskeys',[$ckey],$cdom,$cnum);
1.364 www 663: if (($existing{$ckey}=~/^\#(.*)$/) || # - new key
664: ($existing{$ckey}=~/^$uname\:$udom\#(.*)$/)) {
665: # assigned to this person
666: # - this should not happen,
1.345 www 667: # unless something went wrong
668: # the first time around
669: # ready to assign
1.364 www 670: $logentry=$1.'; '.$logentry;
671: if (&put('accesskey',{$ckey=>$uname.':'.$udom.'#'.$logentry},
672: $cdom,$cnum) eq 'ok') {
1.345 www 673: # key now belongs to user
1.346 www 674: my $envkey='key.'.$cdom.'_'.$cnum;
1.345 www 675: if (&put('environment',{$envkey => $ckey}) eq 'ok') {
676: &appenv('environment.'.$envkey => $ckey);
677: return 'ok';
678: } else {
679: return
680: 'error: Count not permanently assign key, will need to be re-entered later.';
681: }
682: } else {
683: return 'error: Could not assign key, try again later.';
684: }
1.364 www 685: } elsif (!$existing{$ckey}) {
1.345 www 686: # the key does not exist
687: return 'error: The key does not exist';
688: } else {
689: # the key is somebody else's
690: return 'error: The key is already in use';
691: }
1.344 www 692: }
693:
1.364 www 694: # ------------------------------------------ put an additional comment on a key
695:
696: sub comment_access_key {
697: #
698: # a valid key looks like uname:udom#comments
699: # comments are being appended
700: #
701: my ($ckey,$cdom,$cnum,$logentry)=@_;
702: $cdom=
703: $ENV{'course.'.$ENV{'request.course.id'}.'.domain'} unless (defined($cdom));
704: $cnum=
705: $ENV{'course.'.$ENV{'request.course.id'}.'.num'} unless (defined($cnum));
706: my %existing=&get('accesskeys',[$ckey],$cdom,$cnum);
707: if ($existing{$ckey}) {
708: $existing{$ckey}.='; '.$logentry;
709: # ready to assign
1.367 www 710: if (&put('accesskeys',{$ckey=>$existing{$ckey}},
1.364 www 711: $cdom,$cnum) eq 'ok') {
712: return 'ok';
713: } else {
714: return 'error: Count not store comment.';
715: }
716: } else {
717: # the key does not exist
718: return 'error: The key does not exist';
719: }
720: }
721:
1.344 www 722: # ------------------------------------------------------ Generate a set of keys
723:
724: sub generate_access_keys {
1.364 www 725: my ($number,$cdom,$cnum,$logentry)=@_;
1.344 www 726: $cdom=
727: $ENV{'course.'.$ENV{'request.course.id'}.'.domain'} unless (defined($cdom));
728: $cnum=
729: $ENV{'course.'.$ENV{'request.course.id'}.'.num'} unless (defined($cnum));
1.361 www 730: unless (&allowed('mky',$cdom)) { return 0; }
1.344 www 731: unless (($cdom) && ($cnum)) { return 0; }
732: if ($number>10000) { return 0; }
733: sleep(2); # make sure don't get same seed twice
734: srand(time()^($$+($$<<15))); # from "Programming Perl"
735: my $total=0;
736: for (my $i=1;$i<=$number;$i++) {
737: my $newkey=sprintf("%lx",int(100000*rand)).'-'.
738: sprintf("%lx",int(100000*rand)).'-'.
739: sprintf("%lx",int(100000*rand));
740: $newkey=~s/1/g/g; # folks mix up 1 and l
741: $newkey=~s/0/h/g; # and also 0 and O
742: my %existing=&get('accesskeys',[$newkey],$cdom,$cnum);
743: if ($existing{$newkey}) {
744: $i--;
745: } else {
1.364 www 746: if (&put('accesskeys',
747: { $newkey => '# generated '.localtime().
748: ' by '.$ENV{'user.name'}.'@'.$ENV{'user.domain'}.
749: '; '.$logentry },
750: $cdom,$cnum) eq 'ok') {
1.344 www 751: $total++;
752: }
753: }
754: }
755: &log($ENV{'user.domain'},$ENV{'user.name'},$ENV{'user.home'},
756: 'Generated '.$total.' keys for '.$cnum.' at '.$cdom);
757: return $total;
758: }
759:
760: # ------------------------------------------------------- Validate an accesskey
761:
762: sub validate_access_key {
763: my ($ckey,$cdom,$cnum,$udom,$uname)=@_;
764: $cdom=
765: $ENV{'course.'.$ENV{'request.course.id'}.'.domain'} unless (defined($cdom));
766: $cnum=
767: $ENV{'course.'.$ENV{'request.course.id'}.'.num'} unless (defined($cnum));
768: $udom=$ENV{'user.name'} unless (defined($udom));
769: $uname=$ENV{'user.domain'} unless (defined($uname));
1.345 www 770: my %existing=&get('accesskeys',[$ckey],$cdom,$cnum);
1.364 www 771: return ($existing{$ckey}=~/^$uname\:$udom\#/);
1.70 www 772: }
773:
774: # ------------------------------------- Find the section of student in a course
1.298 matthew 775:
776: sub getsection {
777: my ($udom,$unam,$courseid)=@_;
778: $courseid=~s/\_/\//g;
779: $courseid=~s/^(\w)/\/$1/;
780: my %Pending;
781: my %Expired;
782: #
783: # Each role can either have not started yet (pending), be active,
784: # or have expired.
785: #
786: # If there is an active role, we are done.
787: #
788: # If there is more than one role which has not started yet,
789: # choose the one which will start sooner
790: # If there is one role which has not started yet, return it.
791: #
792: # If there is more than one expired role, choose the one which ended last.
793: # If there is a role which has expired, return it.
794: #
795: foreach (split(/\&/,&reply('dump:'.$udom.':'.$unam.':roles',
796: &homeserver($unam,$udom)))) {
797: my ($key,$value)=split(/\=/,$_);
798: $key=&unescape($key);
799: next if ($key !~/^$courseid(?:\/)*(\w+)*\_st$/);
800: my $section=$1;
801: if ($key eq $courseid.'_st') { $section=''; }
802: my ($dummy,$end,$start)=split(/\_/,&unescape($value));
803: my $now=time;
804: if (defined($end) && ($now > $end)) {
805: $Expired{$end}=$section;
806: next;
807: }
808: if (defined($start) && ($now < $start)) {
809: $Pending{$start}=$section;
810: next;
811: }
812: return $section;
813: }
814: #
815: # Presumedly there will be few matching roles from the above
816: # loop and the sorting time will be negligible.
817: if (scalar(keys(%Pending))) {
818: my ($time) = sort {$a <=> $b} keys(%Pending);
819: return $Pending{$time};
820: }
821: if (scalar(keys(%Expired))) {
822: my @sorted = sort {$a <=> $b} keys(%Expired);
823: my $time = pop(@sorted);
824: return $Expired{$time};
825: }
826: return '-1';
827: }
1.70 www 828:
1.452 albertel 829:
830: my $disk_caching_disabled=1;
831:
1.416 albertel 832: sub devalidate_cache {
1.428 albertel 833: my ($cache,$id,$name) = @_;
1.417 albertel 834: delete $$cache{$id.'.time'};
835: delete $$cache{$id};
1.452 albertel 836: if ($disk_caching_disabled) { return; }
1.442 albertel 837: my $filename=$perlvar{'lonDaemons'}.'/tmp/lonnet_internal_cache_'.$name.".db";
1.428 albertel 838: open(DB,"$filename.lock");
839: flock(DB,LOCK_EX);
840: my %hash;
841: if (tie(%hash,'GDBM_File',$filename,&GDBM_WRCREAT(),0640)) {
1.442 albertel 842: eval <<'EVALBLOCK';
843: delete($hash{$id});
844: delete($hash{$id.'.time'});
845: EVALBLOCK
846: if ($@) {
847: &logthis("<font color='red'>devalidate_cache blew up :$@:$name</font>");
848: unlink($filename);
849: }
1.428 albertel 850: } else {
1.442 albertel 851: if (-e $filename) {
852: &logthis("Unable to tie hash (devalidate cache): $name");
853: unlink($filename);
854: }
1.428 albertel 855: }
856: untie(%hash);
857: flock(DB,LOCK_UN);
858: close(DB);
1.416 albertel 859: }
860:
861: sub is_cached {
1.425 albertel 862: my ($cache,$id,$name,$time) = @_;
1.420 albertel 863: if (!$time) { $time=300; }
1.416 albertel 864: if (!exists($$cache{$id.'.time'})) {
1.428 albertel 865: &load_cache_item($cache,$name,$id);
1.425 albertel 866: }
867: if (!exists($$cache{$id.'.time'})) {
868: # &logthis("Didn't find $id");
1.417 albertel 869: return (undef,undef);
1.416 albertel 870: } else {
1.425 albertel 871: if (time-($$cache{$id.'.time'})>$time) {
1.435 www 872: # &logthis("Devalidating $id - ".time-($$cache{$id.'.time'}));
1.428 albertel 873: &devalidate_cache($cache,$id,$name);
1.417 albertel 874: return (undef,undef);
1.416 albertel 875: }
876: }
1.417 albertel 877: return ($$cache{$id},1);
1.416 albertel 878: }
879:
880: sub do_cache {
1.425 albertel 881: my ($cache,$id,$value,$name) = @_;
1.416 albertel 882: $$cache{$id.'.time'}=time;
1.425 albertel 883: $$cache{$id}=$value;
1.428 albertel 884: # &logthis("Caching $id as :$value:");
885: &save_cache_item($cache,$name,$id);
1.416 albertel 886: # do_cache implictly return the set value
1.425 albertel 887: $$cache{$id};
888: }
889:
1.428 albertel 890: sub save_cache_item {
891: my ($cache,$name,$id)=@_;
1.452 albertel 892: if ($disk_caching_disabled) { return; }
1.428 albertel 893: my $starttime=&Time::HiRes::time();
1.442 albertel 894: # &logthis("Saving :$name:$id");
1.428 albertel 895: my %hash;
1.442 albertel 896: my $filename=$perlvar{'lonDaemons'}.'/tmp/lonnet_internal_cache_'.$name.".db";
1.428 albertel 897: open(DB,"$filename.lock");
898: flock(DB,LOCK_EX);
899: if (tie(%hash,'GDBM_File',$filename,&GDBM_WRCREAT(),0640)) {
1.442 albertel 900: eval <<'EVALBLOCK';
901: $hash{$id.'.time'}=$$cache{$id.'.time'};
902: $hash{$id}=freeze({'item'=>$$cache{$id}});
903: EVALBLOCK
904: if ($@) {
905: &logthis("<font color='red'>save_cache blew up :$@:$name</font>");
906: unlink($filename);
907: }
1.428 albertel 908: } else {
1.442 albertel 909: if (-e $filename) {
1.445 www 910: &logthis("Unable to tie hash (save cache item): $name ($!)");
1.442 albertel 911: unlink($filename);
912: }
1.428 albertel 913: }
914: untie(%hash);
915: flock(DB,LOCK_UN);
916: close(DB);
917: # &logthis("save_cache_item $name took ".(&Time::HiRes::time()-$starttime));
918: }
919:
920: sub load_cache_item {
921: my ($cache,$name,$id)=@_;
1.452 albertel 922: if ($disk_caching_disabled) { return; }
1.428 albertel 923: my $starttime=&Time::HiRes::time();
924: # &logthis("Before Loading $name for $id size is ".scalar(%$cache));
925: my %hash;
1.442 albertel 926: my $filename=$perlvar{'lonDaemons'}.'/tmp/lonnet_internal_cache_'.$name.".db";
1.428 albertel 927: open(DB,"$filename.lock");
928: flock(DB,LOCK_SH);
929: if (tie(%hash,'GDBM_File',$filename,&GDBM_READER(),0640)) {
1.442 albertel 930: eval <<'EVALBLOCK';
931: if (!%$cache) {
932: my $count;
933: while (my ($key,$value)=each(%hash)) {
934: $count++;
935: if ($key =~ /\.time$/) {
936: $$cache{$key}=$value;
937: } else {
938: my $hashref=thaw($value);
939: $$cache{$key}=$hashref->{'item'};
940: }
1.428 albertel 941: }
1.442 albertel 942: # &logthis("Initial load: $count");
943: } else {
944: my $hashref=thaw($hash{$id});
945: $$cache{$id}=$hashref->{'item'};
946: $$cache{$id.'.time'}=$hash{$id.'.time'};
1.428 albertel 947: }
1.442 albertel 948: EVALBLOCK
949: if ($@) {
950: &logthis("<font color='red'>load_cache blew up :$@:$name</font>");
951: unlink($filename);
952: }
953: } else {
954: if (-e $filename) {
1.445 www 955: &logthis("Unable to tie hash (load cache item): $name ($!)");
1.442 albertel 956: unlink($filename);
1.428 albertel 957: }
958: }
959: untie(%hash);
960: flock(DB,LOCK_UN);
961: close(DB);
962: # &logthis("After Loading $name size is ".scalar(%$cache));
963: # &logthis("load_cache_item $name took ".(&Time::HiRes::time()-$starttime));
964: }
965:
1.70 www 966: sub usection {
967: my ($udom,$unam,$courseid)=@_;
1.416 albertel 968: my $hashid="$udom:$unam:$courseid";
969:
1.425 albertel 970: my ($result,$cached)=&is_cached(\%usectioncache,$hashid,'usection');
1.417 albertel 971: if (defined($cached)) { return $result; }
1.70 www 972: $courseid=~s/\_/\//g;
973: $courseid=~s/^(\w)/\/$1/;
1.191 harris41 974: foreach (split(/\&/,&reply('dump:'.$udom.':'.$unam.':roles',
975: &homeserver($unam,$udom)))) {
1.70 www 976: my ($key,$value)=split(/\=/,$_);
977: $key=&unescape($key);
978: if ($key=~/^$courseid(?:\/)*(\w+)*\_st$/) {
979: my $section=$1;
980: if ($key eq $courseid.'_st') { $section=''; }
981: my ($dummy,$end,$start)=split(/\_/,&unescape($value));
982: my $now=time;
983: my $notactive=0;
984: if ($start) {
985: if ($now<$start) { $notactive=1; }
986: }
987: if ($end) {
988: if ($now>$end) { $notactive=1; }
989: }
1.416 albertel 990: unless ($notactive) {
1.425 albertel 991: return &do_cache(\%usectioncache,$hashid,$section,'usection');
1.416 albertel 992: }
1.70 www 993: }
1.191 harris41 994: }
1.425 albertel 995: return &do_cache(\%usectioncache,$hashid,'-1','usection');
1.70 www 996: }
997:
998: # ------------------------------------- Read an entry from a user's environment
999:
1000: sub userenvironment {
1001: my ($udom,$unam,@what)=@_;
1002: my %returnhash=();
1003: my @answer=split(/\&/,
1004: &reply('get:'.$udom.':'.$unam.':environment:'.join('&',@what),
1005: &homeserver($unam,$udom)));
1006: my $i;
1007: for ($i=0;$i<=$#what;$i++) {
1008: $returnhash{$what[$i]}=&unescape($answer[$i]);
1009: }
1010: return %returnhash;
1.1 albertel 1011: }
1012:
1.263 www 1013: # -------------------------------------------------------------------- New chat
1014:
1015: sub chatsend {
1016: my ($newentry,$anon)=@_;
1017: my $cnum=$ENV{'course.'.$ENV{'request.course.id'}.'.num'};
1018: my $cdom=$ENV{'course.'.$ENV{'request.course.id'}.'.domain'};
1019: my $chome=$ENV{'course.'.$ENV{'request.course.id'}.'.home'};
1020: &reply('chatsend:'.$cdom.':'.$cnum.':'.
1021: &escape($ENV{'user.domain'}.':'.$ENV{'user.name'}.':'.$anon.':'.
1022: &escape($newentry)),$chome);
1.292 www 1023: }
1024:
1025: # ------------------------------------------ Find current version of a resource
1026:
1027: sub getversion {
1028: my $fname=&clutter(shift);
1029: unless ($fname=~/^\/res\//) { return -1; }
1030: return ¤tversion(&filelocation('',$fname));
1031: }
1032:
1033: sub currentversion {
1034: my $fname=shift;
1.440 www 1035: my ($result,$cached)=&is_cached(\%resversioncache,$fname,'resversion',600);
1036: if (defined($cached)) { return $result; }
1.292 www 1037: my $author=$fname;
1038: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
1039: my ($udom,$uname)=split(/\//,$author);
1040: my $home=homeserver($uname,$udom);
1041: if ($home eq 'no_host') {
1042: return -1;
1043: }
1044: my $answer=reply("currentversion:$fname",$home);
1045: if (($answer eq 'con_lost') || ($answer eq 'rejected')) {
1046: return -1;
1047: }
1.440 www 1048: return &do_cache(\%resversioncache,$fname,$answer,'resversion');
1.263 www 1049: }
1050:
1.1 albertel 1051: # ----------------------------- Subscribe to a resource, return URL if possible
1.11 www 1052:
1.1 albertel 1053: sub subscribe {
1054: my $fname=shift;
1.312 www 1055: if ($fname=~/\/(aboutme|syllabus|bulletinboard|smppg)$/) { return ''; }
1.1 albertel 1056: my $author=$fname;
1057: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
1058: my ($udom,$uname)=split(/\//,$author);
1059: my $home=homeserver($uname,$udom);
1.335 albertel 1060: if ($home eq 'no_host') {
1061: return 'not_found';
1.1 albertel 1062: }
1063: my $answer=reply("sub:$fname",$home);
1.64 www 1064: if (($answer eq 'con_lost') || ($answer eq 'rejected')) {
1065: $answer.=' by '.$home;
1066: }
1.1 albertel 1067: return $answer;
1068: }
1069:
1.8 www 1070: # -------------------------------------------------------------- Replicate file
1071:
1072: sub repcopy {
1073: my $filename=shift;
1.23 www 1074: $filename=~s/\/+/\//g;
1.214 www 1075: if ($filename=~/^\/home\/httpd\/html\/adm\//) { return OK; }
1.8 www 1076: my $transname="$filename.in.transfer";
1.17 www 1077: if ((-e $filename) || (-e $transname)) { return OK; }
1.8 www 1078: my $remoteurl=subscribe($filename);
1.64 www 1079: if ($remoteurl =~ /^con_lost by/) {
1080: &logthis("Subscribe returned $remoteurl: $filename");
1.8 www 1081: return HTTP_SERVICE_UNAVAILABLE;
1082: } elsif ($remoteurl eq 'not_found') {
1.441 albertel 1083: #&logthis("Subscribe returned not_found: $filename");
1.8 www 1084: return HTTP_NOT_FOUND;
1.64 www 1085: } elsif ($remoteurl =~ /^rejected by/) {
1086: &logthis("Subscribe returned $remoteurl: $filename");
1.8 www 1087: return FORBIDDEN;
1.20 www 1088: } elsif ($remoteurl eq 'directory') {
1089: return OK;
1.8 www 1090: } else {
1.290 www 1091: my $author=$filename;
1092: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
1093: my ($udom,$uname)=split(/\//,$author);
1094: my $home=homeserver($uname,$udom);
1095: unless ($home eq $perlvar{'lonHostID'}) {
1.8 www 1096: my @parts=split(/\//,$filename);
1097: my $path="/$parts[1]/$parts[2]/$parts[3]/$parts[4]";
1098: if ($path ne "$perlvar{'lonDocRoot'}/res") {
1099: &logthis("Malconfiguration for replication: $filename");
1100: return HTTP_BAD_REQUEST;
1101: }
1102: my $count;
1103: for ($count=5;$count<$#parts;$count++) {
1104: $path.="/$parts[$count]";
1105: if ((-e $path)!=1) {
1106: mkdir($path,0777);
1107: }
1108: }
1109: my $ua=new LWP::UserAgent;
1110: my $request=new HTTP::Request('GET',"$remoteurl");
1111: my $response=$ua->request($request,$transname);
1112: if ($response->is_error()) {
1113: unlink($transname);
1114: my $message=$response->status_line;
1.12 www 1115: &logthis("<font color=blue>WARNING:"
1116: ." LWP get: $message: $filename</font>");
1.8 www 1117: return HTTP_SERVICE_UNAVAILABLE;
1118: } else {
1.16 www 1119: if ($remoteurl!~/\.meta$/) {
1120: my $mrequest=new HTTP::Request('GET',$remoteurl.'.meta');
1121: my $mresponse=$ua->request($mrequest,$filename.'.meta');
1122: if ($mresponse->is_error()) {
1123: unlink($filename.'.meta');
1124: &logthis(
1125: "<font color=yellow>INFO: No metadata: $filename</font>");
1126: }
1127: }
1.8 www 1128: rename($transname,$filename);
1129: return OK;
1130: }
1.290 www 1131: }
1.8 www 1132: }
1.330 www 1133: }
1134:
1135: # ------------------------------------------------ Get server side include body
1136: sub ssi_body {
1.381 albertel 1137: my ($filelink,%form)=@_;
1.330 www 1138: my $output=($filelink=~/^http\:/?&externalssi($filelink):
1.381 albertel 1139: &ssi($filelink,%form));
1.451 albertel 1140: $output=~s/^.*?\<body[^\>]*\>//si;
1141: $output=~s/(.*)\<\/body\s*\>.*?$/$1/si;
1.331 www 1142: $output=~
1143: s/\/\/ BEGIN LON\-CAPA Internal.+\/\/ END LON\-CAPA Internal\s//gs;
1.330 www 1144: return $output;
1.8 www 1145: }
1146:
1.15 www 1147: # --------------------------------------------------------- Server Side Include
1148:
1149: sub ssi {
1150:
1.23 www 1151: my ($fn,%form)=@_;
1.15 www 1152:
1153: my $ua=new LWP::UserAgent;
1.23 www 1154:
1155: my $request;
1156:
1157: if (%form) {
1158: $request=new HTTP::Request('POST',"http://".$ENV{'HTTP_HOST'}.$fn);
1.201 albertel 1159: $request->content(join('&',map { &escape($_).'='.&escape($form{$_}) } keys %form));
1.23 www 1160: } else {
1161: $request=new HTTP::Request('GET',"http://".$ENV{'HTTP_HOST'}.$fn);
1162: }
1163:
1.15 www 1164: $request->header(Cookie => $ENV{'HTTP_COOKIE'});
1165: my $response=$ua->request($request);
1166:
1.324 www 1167: return $response->content;
1168: }
1169:
1170: sub externalssi {
1171: my ($url)=@_;
1172: my $ua=new LWP::UserAgent;
1173: my $request=new HTTP::Request('GET',$url);
1174: my $response=$ua->request($request);
1.15 www 1175: return $response->content;
1176: }
1.254 www 1177:
1178: # ------- Add a token to a remote URI's query string to vouch for access rights
1179:
1180: sub tokenwrapper {
1181: my $uri=shift;
1.259 www 1182: $uri=~s/^http\:\/\/([^\/]+)//;
1183: $uri=~s/^\///;
1184: $ENV{'user.environment'}=~/\/([^\/]+)\.id/;
1185: my $token=$1;
1186: if ($uri=~/^uploaded\/([^\/]+)\/([^\/]+)\/([^\/]+)(\?\.*)*$/) {
1187: &appenv('userfile.'.$1.'/'.$2.'/'.$3 => $ENV{'request.course.id'});
1188: return 'http://'.$hostname{ &homeserver($2,$1)}.'/'.$uri.
1.304 www 1189: (($uri=~/\?/)?'&':'?').'token='.$token.
1190: '&tokenissued='.$perlvar{'lonHostID'};
1.259 www 1191: } else {
1192: return '/adm/notfound.html';
1193: }
1.254 www 1194: }
1195:
1.257 www 1196: # --------------- Take an uploaded file and put it into the userfiles directory
1.259 www 1197: # input: name of form element, coursedoc=1 means this is for the course
1.257 www 1198: # output: url of file in userspace
1199:
1200: sub userfileupload {
1.259 www 1201: my ($formname,$coursedoc)=@_;
1.257 www 1202: my $fname=$ENV{'form.'.$formname.'.filename'};
1.315 www 1203: # Replace Windows backslashes by forward slashes
1.257 www 1204: $fname=~s/\\/\//g;
1.315 www 1205: # Get rid of everything but the actual filename
1.257 www 1206: $fname=~s/^.*\/([^\/]+)$/$1/;
1.315 www 1207: # Replace spaces by underscores
1208: $fname=~s/\s+/\_/g;
1209: # Replace all other weird characters by nothing
1.317 www 1210: $fname=~s/[^\w\.\-]//g;
1.315 www 1211: # See if there is anything left
1.257 www 1212: unless ($fname) { return 'error: no uploaded file'; }
1213: chop($ENV{'form.'.$formname});
1.258 www 1214: # Create the directory if not present
1.259 www 1215: my $docuname='';
1216: my $docudom='';
1217: my $docuhome='';
1218: if ($coursedoc) {
1219: $docuname=$ENV{'course.'.$ENV{'request.course.id'}.'.num'};
1220: $docudom=$ENV{'course.'.$ENV{'request.course.id'}.'.domain'};
1221: $docuhome=$ENV{'course.'.$ENV{'request.course.id'}.'.home'};
1222: } else {
1223: $docuname=$ENV{'user.name'};
1224: $docudom=$ENV{'user.domain'};
1225: $docuhome=$ENV{'user.home'};
1226: }
1.271 www 1227: return
1228: &finishuserfileupload($docuname,$docudom,$docuhome,$formname,$fname);
1229: }
1230:
1231: sub finishuserfileupload {
1232: my ($docuname,$docudom,$docuhome,$formname,$fname)=@_;
1.259 www 1233: my $path=$docudom.'/'.$docuname.'/';
1.258 www 1234: my $filepath=$perlvar{'lonDocRoot'};
1.259 www 1235: my @parts=split(/\//,$filepath.'/userfiles/'.$path);
1.258 www 1236: my $count;
1237: for ($count=4;$count<=$#parts;$count++) {
1238: $filepath.="/$parts[$count]";
1239: if ((-e $filepath)!=1) {
1240: mkdir($filepath,0777);
1241: }
1242: }
1243: # Save the file
1244: {
1.448 albertel 1245: open(my $fh,'>'.$filepath.'/'.$fname);
1.258 www 1246: print $fh $ENV{'form.'.$formname};
1.448 albertel 1247: close($fh);
1.258 www 1248: }
1.259 www 1249: # Notify homeserver to grep it
1250: #
1.295 www 1251:
1252: my $fetchresult=
1253: &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$fname,$docuhome);
1254: if ($fetchresult eq 'ok') {
1.259 www 1255: #
1.258 www 1256: # Return the URL to it
1.263 www 1257: return '/uploaded/'.$path.$fname;
1258: } else {
1.295 www 1259: &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$fname.
1260: ' to host '.$docuhome.': '.$fetchresult);
1.263 www 1261: return '/adm/notfound.html';
1262: }
1.257 www 1263: }
1.15 www 1264:
1.14 www 1265: # ------------------------------------------------------------------------- Log
1266:
1267: sub log {
1268: my ($dom,$nam,$hom,$what)=@_;
1.47 www 1269: return critical("log:$dom:$nam:$what",$hom);
1.157 www 1270: }
1271:
1272: # ------------------------------------------------------------------ Course Log
1.352 www 1273: #
1274: # This routine flushes several buffers of non-mission-critical nature
1275: #
1.157 www 1276:
1277: sub flushcourselogs {
1.352 www 1278: &logthis('Flushing log buffers');
1279: #
1280: # course logs
1281: # This is a log of all transactions in a course, which can be used
1282: # for data mining purposes
1283: #
1284: # It also collects the courseid database, which lists last transaction
1285: # times and course titles for all courseids
1286: #
1287: my %courseidbuffer=();
1.191 harris41 1288: foreach (keys %courselogs) {
1.157 www 1289: my $crsid=$_;
1.352 www 1290: if (&reply('log:'.$coursedombuf{$crsid}.':'.$coursenumbuf{$crsid}.':'.
1.188 www 1291: &escape($courselogs{$crsid}),
1292: $coursehombuf{$crsid}) eq 'ok') {
1.157 www 1293: delete $courselogs{$crsid};
1294: } else {
1295: &logthis('Failed to flush log buffer for '.$crsid);
1296: if (length($courselogs{$crsid})>40000) {
1297: &logthis("<font color=blue>WARNING: Buffer for ".$crsid.
1298: " exceeded maximum size, deleting.</font>");
1299: delete $courselogs{$crsid};
1300: }
1.352 www 1301: }
1302: if ($courseidbuffer{$coursehombuf{$crsid}}) {
1303: $courseidbuffer{$coursehombuf{$crsid}}.='&'.
1304: &escape($crsid).'='.&escape($coursedescrbuf{$crsid});
1305: } else {
1306: $courseidbuffer{$coursehombuf{$crsid}}=
1307: &escape($crsid).'='.&escape($coursedescrbuf{$crsid});
1308: }
1.191 harris41 1309: }
1.352 www 1310: #
1311: # Write course id database (reverse lookup) to homeserver of courses
1312: # Is used in pickcourse
1313: #
1314: foreach (keys %courseidbuffer) {
1.353 www 1315: &courseidput($hostdom{$_},$courseidbuffer{$_},$_);
1.352 www 1316: }
1317: #
1318: # File accesses
1319: # Writes to the dynamic metadata of resources to get hit counts, etc.
1320: #
1.449 matthew 1321: foreach my $entry (keys(%accesshash)) {
1.458 matthew 1322: if ($entry =~ /___count$/) {
1323: my ($dom,$name);
1324: ($dom,$name,undef)=($entry=~m:___(\w+)/(\w+)/(.*)___count$:);
1325: if (! defined($dom) || $dom eq '' ||
1326: ! defined($name) || $name eq '') {
1327: my $cid = $ENV{'request.course.id'};
1328: $dom = $ENV{'request.'.$cid.'.domain'};
1329: $name = $ENV{'request.'.$cid.'.num'};
1330: }
1.450 matthew 1331: my $value = $accesshash{$entry};
1332: my (undef,$url,undef) = ($entry =~ /^(.*)___(.*)___count$/);
1333: my %temphash=($url => $value);
1.449 matthew 1334: my $result = &inc('nohist_accesscount',\%temphash,$dom,$name);
1335: if ($result eq 'ok') {
1336: delete $accesshash{$entry};
1337: } elsif ($result eq 'unknown_cmd') {
1338: # Target server has old code running on it.
1.450 matthew 1339: my %temphash=($entry => $value);
1.449 matthew 1340: if (&put('nohist_resevaldata',\%temphash,$dom,$name) eq 'ok') {
1341: delete $accesshash{$entry};
1342: }
1343: }
1344: } else {
1.458 matthew 1345: my ($dom,$name) = ($entry=~m:___(\w+)/(\w+)/(.*)___(\w+)$:);
1.450 matthew 1346: my %temphash=($entry => $accesshash{$entry});
1.449 matthew 1347: if (&put('nohist_resevaldata',\%temphash,$dom,$name) eq 'ok') {
1348: delete $accesshash{$entry};
1349: }
1.185 www 1350: }
1.191 harris41 1351: }
1.352 www 1352: #
1353: # Roles
1354: # Reverse lookup of user roles for course faculty/staff and co-authorship
1355: #
1.349 www 1356: foreach (keys %userrolehash) {
1357: my $entry=$_;
1.351 www 1358: my ($role,$uname,$udom,$runame,$rudom,$rsec)=
1.349 www 1359: split(/\:/,$entry);
1360: if (&Apache::lonnet::put('nohist_userroles',
1.351 www 1361: { $role.':'.$uname.':'.$udom.':'.$rsec => $userrolehash{$entry} },
1.349 www 1362: $rudom,$runame) eq 'ok') {
1363: delete $userrolehash{$entry};
1364: }
1365: }
1.186 www 1366: $dumpcount++;
1.157 www 1367: }
1368:
1369: sub courselog {
1370: my $what=shift;
1.158 www 1371: $what=time.':'.$what;
1.157 www 1372: unless ($ENV{'request.course.id'}) { return ''; }
1.188 www 1373: $coursedombuf{$ENV{'request.course.id'}}=
1.352 www 1374: $ENV{'course.'.$ENV{'request.course.id'}.'.domain'};
1375: $coursenumbuf{$ENV{'request.course.id'}}=
1.188 www 1376: $ENV{'course.'.$ENV{'request.course.id'}.'.num'};
1377: $coursehombuf{$ENV{'request.course.id'}}=
1378: $ENV{'course.'.$ENV{'request.course.id'}.'.home'};
1.352 www 1379: $coursedescrbuf{$ENV{'request.course.id'}}=
1380: $ENV{'course.'.$ENV{'request.course.id'}.'.description'};
1.157 www 1381: if (defined $courselogs{$ENV{'request.course.id'}}) {
1382: $courselogs{$ENV{'request.course.id'}}.='&'.$what;
1383: } else {
1384: $courselogs{$ENV{'request.course.id'}}.=$what;
1385: }
1.458 matthew 1386: if (length($courselogs{$ENV{'request.course.id'}})>4048) {
1.157 www 1387: &flushcourselogs();
1388: }
1.158 www 1389: }
1390:
1391: sub courseacclog {
1392: my $fnsymb=shift;
1393: unless ($ENV{'request.course.id'}) { return ''; }
1394: my $what=$fnsymb.':'.$ENV{'user.name'}.':'.$ENV{'user.domain'};
1.408 www 1395: if ($fnsymb=~/(problem|exam|quiz|assess|survey|form|page)$/) {
1.187 www 1396: $what.=':POST';
1.191 harris41 1397: foreach (keys %ENV) {
1.158 www 1398: if ($_=~/^form\.(.*)/) {
1399: $what.=':'.$1.'='.$ENV{$_};
1400: }
1.191 harris41 1401: }
1.158 www 1402: }
1403: &courselog($what);
1.149 www 1404: }
1405:
1.185 www 1406: sub countacc {
1407: my $url=&declutter(shift);
1.458 matthew 1408: return if (! defined($url) || $url eq '');
1.185 www 1409: unless ($ENV{'request.course.id'}) { return ''; }
1410: $accesshash{$ENV{'request.course.id'}.'___'.$url.'___course'}=1;
1.281 www 1411: my $key=$$.$processmarker.'_'.$dumpcount.'___'.$url.'___count';
1.450 matthew 1412: $accesshash{$key}++;
1.185 www 1413: }
1.349 www 1414:
1.361 www 1415: sub linklog {
1416: my ($from,$to)=@_;
1417: $from=&declutter($from);
1418: $to=&declutter($to);
1419: $accesshash{$from.'___'.$to.'___comefrom'}=1;
1420: $accesshash{$to.'___'.$from.'___goto'}=1;
1421: }
1422:
1.349 www 1423: sub userrolelog {
1424: my ($trole,$username,$domain,$area,$tstart,$tend)=@_;
1425: if (($trole=~/^ca/) || ($trole=~/^in/) ||
1426: ($trole=~/^cc/) || ($trole=~/^ep/) ||
1427: ($trole=~/^cr/)) {
1.350 www 1428: my (undef,$rudom,$runame,$rsec)=split(/\//,$area);
1429: $userrolehash
1430: {$trole.':'.$username.':'.$domain.':'.$runame.':'.$rudom.':'.$rsec}
1.349 www 1431: =$tend.':'.$tstart;
1432: }
1.351 www 1433: }
1434:
1435: sub get_course_adv_roles {
1436: my $cid=shift;
1437: $cid=$ENV{'request.course.id'} unless (defined($cid));
1438: my %coursehash=&coursedescription($cid);
1439: my %returnhash=();
1440: my %dumphash=
1441: &dump('nohist_userroles',$coursehash{'domain'},$coursehash{'num'});
1442: my $now=time;
1443: foreach (keys %dumphash) {
1444: my ($tend,$tstart)=split(/\:/,$dumphash{$_});
1445: if (($tstart) && ($tstart<0)) { next; }
1446: if (($tend) && ($tend<$now)) { next; }
1447: if (($tstart) && ($now<$tstart)) { next; }
1448: my ($role,$username,$domain,$section)=split(/\:/,$_);
1.466 www 1449: if (&privileged($username,$domain)) { next; }
1.351 www 1450: my $key=&plaintext($role);
1451: if ($section) { $key.=' (Sec/Grp '.$section.')'; }
1452: if ($returnhash{$key}) {
1453: $returnhash{$key}.=','.$username.':'.$domain;
1454: } else {
1455: $returnhash{$key}=$username.':'.$domain;
1456: }
1.400 www 1457: }
1458: return %returnhash;
1459: }
1460:
1461: sub get_my_roles {
1462: my ($uname,$udom)=@_;
1463: unless (defined($uname)) { $uname=$ENV{'user.name'}; }
1464: unless (defined($udom)) { $udom=$ENV{'user.domain'}; }
1465: my %dumphash=
1466: &dump('nohist_userroles',$udom,$uname);
1467: my %returnhash=();
1468: my $now=time;
1469: foreach (keys %dumphash) {
1470: my ($tend,$tstart)=split(/\:/,$dumphash{$_});
1471: if (($tstart) && ($tstart<0)) { next; }
1472: if (($tend) && ($tend<$now)) { next; }
1473: if (($tstart) && ($now<$tstart)) { next; }
1474: my ($role,$username,$domain,$section)=split(/\:/,$_);
1475: $returnhash{$username.':'.$domain.':'.$role}=$tstart.':'.$tend;
1.373 www 1476: }
1477: return %returnhash;
1.399 www 1478: }
1479:
1480: # ----------------------------------------------------- Frontpage Announcements
1481: #
1482: #
1483:
1484: sub postannounce {
1485: my ($server,$text)=@_;
1486: unless (&allowed('psa',$hostdom{$server})) { return 'refused'; }
1487: unless ($text=~/\w/) { $text=''; }
1488: return &reply('setannounce:'.&escape($text),$server);
1489: }
1490:
1491: sub getannounce {
1.448 albertel 1492:
1493: if (open(my $fh,$perlvar{'lonDocRoot'}.'/announcement.txt')) {
1.399 www 1494: my $announcement='';
1495: while (<$fh>) { $announcement .=$_; }
1.448 albertel 1496: close($fh);
1.399 www 1497: if ($announcement=~/\w/) {
1498: return
1499: '<table bgcolor="#FF5555" cellpadding="5" cellspacing="3">'.
1500: '<tr><td bgcolor="#FFFFFF"><pre>'.$announcement.'</pre></td></tr></table>';
1501: } else {
1502: return '';
1503: }
1504: } else {
1505: return '';
1506: }
1.351 www 1507: }
1.353 www 1508:
1509: # ---------------------------------------------------------- Course ID routines
1510: # Deal with domain's nohist_courseid.db files
1511: #
1512:
1513: sub courseidput {
1514: my ($domain,$what,$coursehome)=@_;
1515: return &reply('courseidput:'.$domain.':'.$what,$coursehome);
1516: }
1517:
1518: sub courseiddump {
1519: my ($domfilter,$descfilter,$sincefilter)=@_;
1520: my %returnhash=();
1.355 www 1521: unless ($domfilter) { $domfilter=''; }
1.353 www 1522: foreach my $tryserver (keys %libserv) {
1.355 www 1523: if ((!$domfilter) || ($hostdom{$tryserver} eq $domfilter)) {
1.353 www 1524: foreach (
1525: split(/\&/,&reply('courseiddump:'.$hostdom{$tryserver}.':'.
1.354 www 1526: $sincefilter.':'.&escape($descfilter),
1527: $tryserver))) {
1.353 www 1528: my ($key,$value)=split(/\=/,$_);
1529: if (($key) && ($value)) {
1530: $returnhash{&unescape($key)}=&unescape($value);
1531: }
1532: }
1533:
1534: }
1535: }
1536: return %returnhash;
1537: }
1538:
1539: #
1.149 www 1540: # ----------------------------------------------------------- Check out an item
1541:
1542: sub checkout {
1543: my ($symb,$tuname,$tudom,$tcrsid)=@_;
1544: my $now=time;
1545: my $lonhost=$perlvar{'lonHostID'};
1546: my $infostr=&escape(
1.234 www 1547: 'CHECKOUTTOKEN&'.
1.149 www 1548: $tuname.'&'.
1549: $tudom.'&'.
1550: $tcrsid.'&'.
1551: $symb.'&'.
1552: $now.'&'.$ENV{'REMOTE_ADDR'});
1553: my $token=&reply('tmpput:'.$infostr,$lonhost);
1.151 www 1554: if ($token=~/^error\:/) {
1555: &logthis("<font color=blue>WARNING: ".
1556: "Checkout tmpput failed ".$tudom.' - '.$tuname.' - '.$symb.
1557: "</font>");
1558: return '';
1559: }
1560:
1.149 www 1561: $token=~s/^(\d+)\_.*\_(\d+)$/$1\*$2\*$lonhost/;
1562: $token=~tr/a-z/A-Z/;
1563:
1.153 www 1564: my %infohash=('resource.0.outtoken' => $token,
1565: 'resource.0.checkouttime' => $now,
1566: 'resource.0.outremote' => $ENV{'REMOTE_ADDR'});
1.149 www 1567:
1568: unless (&cstore(\%infohash,$symb,$tcrsid,$tudom,$tuname) eq 'ok') {
1569: return '';
1.151 www 1570: } else {
1571: &logthis("<font color=blue>WARNING: ".
1572: "Checkout cstore failed ".$tudom.' - '.$tuname.' - '.$symb.
1573: "</font>");
1.149 www 1574: }
1575:
1576: if (&log($tudom,$tuname,&homeserver($tuname,$tudom),
1577: &escape('Checkout '.$infostr.' - '.
1578: $token)) ne 'ok') {
1579: return '';
1.151 www 1580: } else {
1581: &logthis("<font color=blue>WARNING: ".
1582: "Checkout log failed ".$tudom.' - '.$tuname.' - '.$symb.
1583: "</font>");
1.149 www 1584: }
1.151 www 1585: return $token;
1.149 www 1586: }
1587:
1588: # ------------------------------------------------------------ Check in an item
1589:
1590: sub checkin {
1591: my $token=shift;
1.150 www 1592: my $now=time;
1593: my ($ta,$tb,$lonhost)=split(/\*/,$token);
1594: $lonhost=~tr/A-Z/a-z/;
1595: my $dtoken=$ta.'_'.$hostip{$lonhost}.'_'.$tb;
1596: $dtoken=~s/\W/\_/g;
1.234 www 1597: my ($dummy,$tuname,$tudom,$tcrsid,$symb,$chtim,$rmaddr)=
1.150 www 1598: split(/\&/,&unescape(&reply('tmpget:'.$dtoken,$lonhost)));
1599:
1.154 www 1600: unless (($tuname) && ($tudom)) {
1601: &logthis('Check in '.$token.' ('.$dtoken.') failed');
1602: return '';
1603: }
1604:
1605: unless (&allowed('mgr',$tcrsid)) {
1606: &logthis('Check in '.$token.' ('.$dtoken.') unauthorized: '.
1607: $ENV{'user.name'}.' - '.$ENV{'user.domain'});
1608: return '';
1609: }
1610:
1.153 www 1611: my %infohash=('resource.0.intoken' => $token,
1612: 'resource.0.checkintime' => $now,
1613: 'resource.0.inremote' => $ENV{'REMOTE_ADDR'});
1.150 www 1614:
1615: unless (&cstore(\%infohash,$symb,$tcrsid,$tudom,$tuname) eq 'ok') {
1616: return '';
1617: }
1618:
1619: if (&log($tudom,$tuname,&homeserver($tuname,$tudom),
1620: &escape('Checkin - '.$token)) ne 'ok') {
1621: return '';
1622: }
1623:
1624: return ($symb,$tuname,$tudom,$tcrsid);
1.110 www 1625: }
1626:
1627: # --------------------------------------------- Set Expire Date for Spreadsheet
1628:
1629: sub expirespread {
1630: my ($uname,$udom,$stype,$usymb)=@_;
1631: my $cid=$ENV{'request.course.id'};
1632: if ($cid) {
1633: my $now=time;
1634: my $key=$uname.':'.$udom.':'.$stype.':'.$usymb;
1635: return &reply('put:'.$ENV{'course.'.$cid.'.domain'}.':'.
1636: $ENV{'course.'.$cid.'.num'}.
1637: ':nohist_expirationdates:'.
1638: &escape($key).'='.$now,
1639: $ENV{'course.'.$cid.'.home'})
1640: }
1641: return 'ok';
1.14 www 1642: }
1643:
1.109 www 1644: # ----------------------------------------------------- Devalidate Spreadsheets
1645:
1646: sub devalidate {
1.325 www 1647: my ($symb,$uname,$udom)=@_;
1.109 www 1648: my $cid=$ENV{'request.course.id'};
1649: if ($cid) {
1.391 matthew 1650: # delete the stored spreadsheets for
1651: # - the student level sheet of this user in course's homespace
1652: # - the assessment level sheet for this resource
1653: # for this user in user's homespace
1.325 www 1654: my $key=$uname.':'.$udom.':';
1.109 www 1655: my $status=
1.299 matthew 1656: &del('nohist_calculatedsheets',
1.391 matthew 1657: [$key.'studentcalc:'],
1.133 albertel 1658: $ENV{'course.'.$cid.'.domain'},
1659: $ENV{'course.'.$cid.'.num'})
1660: .' '.
1661: &del('nohist_calculatedsheets_'.$cid,
1.391 matthew 1662: [$key.'assesscalc:'.$symb],$udom,$uname);
1.109 www 1663: unless ($status eq 'ok ok') {
1664: &logthis('Could not devalidate spreadsheet '.
1.325 www 1665: $uname.' at '.$udom.' for '.
1.109 www 1666: $symb.': '.$status);
1.133 albertel 1667: }
1.109 www 1668: }
1669: }
1670:
1.265 albertel 1671: sub get_scalar {
1672: my ($string,$end) = @_;
1673: my $value;
1674: if ($$string =~ s/^([^&]*?)($end)/$2/) {
1675: $value = $1;
1676: } elsif ($$string =~ s/^([^&]*?)&//) {
1677: $value = $1;
1678: }
1679: return &unescape($value);
1680: }
1681:
1682: sub array2str {
1683: my (@array) = @_;
1684: my $result=&arrayref2str(\@array);
1685: $result=~s/^__ARRAY_REF__//;
1686: $result=~s/__END_ARRAY_REF__$//;
1687: return $result;
1688: }
1689:
1.204 albertel 1690: sub arrayref2str {
1691: my ($arrayref) = @_;
1.265 albertel 1692: my $result='__ARRAY_REF__';
1.204 albertel 1693: foreach my $elem (@$arrayref) {
1.265 albertel 1694: if(ref($elem) eq 'ARRAY') {
1695: $result.=&arrayref2str($elem).'&';
1696: } elsif(ref($elem) eq 'HASH') {
1697: $result.=&hashref2str($elem).'&';
1698: } elsif(ref($elem)) {
1699: #print("Got a ref of ".(ref($elem))." skipping.");
1.204 albertel 1700: } else {
1701: $result.=&escape($elem).'&';
1702: }
1703: }
1704: $result=~s/\&$//;
1.265 albertel 1705: $result .= '__END_ARRAY_REF__';
1.204 albertel 1706: return $result;
1707: }
1708:
1.168 albertel 1709: sub hash2str {
1.204 albertel 1710: my (%hash) = @_;
1711: my $result=&hashref2str(\%hash);
1.265 albertel 1712: $result=~s/^__HASH_REF__//;
1713: $result=~s/__END_HASH_REF__$//;
1.204 albertel 1714: return $result;
1715: }
1716:
1717: sub hashref2str {
1718: my ($hashref)=@_;
1.265 albertel 1719: my $result='__HASH_REF__';
1.204 albertel 1720: foreach (keys(%$hashref)) {
1721: if (ref($_) eq 'ARRAY') {
1.265 albertel 1722: $result.=&arrayref2str($_).'=';
1.204 albertel 1723: } elsif (ref($_) eq 'HASH') {
1.265 albertel 1724: $result.=&hashref2str($_).'=';
1.204 albertel 1725: } elsif (ref($_)) {
1.265 albertel 1726: $result.='=';
1727: #print("Got a ref of ".(ref($_))." skipping.");
1.204 albertel 1728: } else {
1.265 albertel 1729: if ($_) {$result.=&escape($_).'=';} else { last; }
1.204 albertel 1730: }
1731:
1.265 albertel 1732: if(ref($hashref->{$_}) eq 'ARRAY') {
1733: $result.=&arrayref2str($hashref->{$_}).'&';
1734: } elsif(ref($hashref->{$_}) eq 'HASH') {
1735: $result.=&hashref2str($hashref->{$_}).'&';
1736: } elsif(ref($hashref->{$_})) {
1737: $result.='&';
1738: #print("Got a ref of ".(ref($hashref->{$_}))." skipping.");
1.204 albertel 1739: } else {
1.265 albertel 1740: $result.=&escape($hashref->{$_}).'&';
1.204 albertel 1741: }
1742: }
1.168 albertel 1743: $result=~s/\&$//;
1.265 albertel 1744: $result .= '__END_HASH_REF__';
1.168 albertel 1745: return $result;
1746: }
1747:
1748: sub str2hash {
1.265 albertel 1749: my ($string)=@_;
1750: my ($hash)=&str2hashref('__HASH_REF__'.$string.'__END_HASH_REF__');
1751: return %$hash;
1752: }
1753:
1754: sub str2hashref {
1.168 albertel 1755: my ($string) = @_;
1.265 albertel 1756:
1757: my %hash;
1758:
1759: if($string !~ /^__HASH_REF__/) {
1760: if (! ($string eq '' || !defined($string))) {
1761: $hash{'error'}='Not hash reference';
1762: }
1763: return (\%hash, $string);
1764: }
1765:
1766: $string =~ s/^__HASH_REF__//;
1767:
1768: while($string !~ /^__END_HASH_REF__/) {
1769: #key
1770: my $key='';
1771: if($string =~ /^__HASH_REF__/) {
1772: ($key, $string)=&str2hashref($string);
1773: if(defined($key->{'error'})) {
1774: $hash{'error'}='Bad data';
1775: return (\%hash, $string);
1776: }
1777: } elsif($string =~ /^__ARRAY_REF__/) {
1778: ($key, $string)=&str2arrayref($string);
1779: if($key->[0] eq 'Array reference error') {
1780: $hash{'error'}='Bad data';
1781: return (\%hash, $string);
1782: }
1783: } else {
1784: $string =~ s/^(.*?)=//;
1.267 albertel 1785: $key=&unescape($1);
1.265 albertel 1786: }
1787: $string =~ s/^=//;
1788:
1789: #value
1790: my $value='';
1791: if($string =~ /^__HASH_REF__/) {
1792: ($value, $string)=&str2hashref($string);
1793: if(defined($value->{'error'})) {
1794: $hash{'error'}='Bad data';
1795: return (\%hash, $string);
1796: }
1797: } elsif($string =~ /^__ARRAY_REF__/) {
1798: ($value, $string)=&str2arrayref($string);
1799: if($value->[0] eq 'Array reference error') {
1800: $hash{'error'}='Bad data';
1801: return (\%hash, $string);
1802: }
1803: } else {
1804: $value=&get_scalar(\$string,'__END_HASH_REF__');
1805: }
1806: $string =~ s/^&//;
1807:
1808: $hash{$key}=$value;
1.204 albertel 1809: }
1.265 albertel 1810:
1811: $string =~ s/^__END_HASH_REF__//;
1812:
1813: return (\%hash, $string);
1.204 albertel 1814: }
1815:
1816: sub str2array {
1.265 albertel 1817: my ($string)=@_;
1818: my ($array)=&str2arrayref('__ARRAY_REF__'.$string.'__END_ARRAY_REF__');
1819: return @$array;
1820: }
1821:
1822: sub str2arrayref {
1.204 albertel 1823: my ($string) = @_;
1.265 albertel 1824: my @array;
1825:
1826: if($string !~ /^__ARRAY_REF__/) {
1827: if (! ($string eq '' || !defined($string))) {
1828: $array[0]='Array reference error';
1829: }
1830: return (\@array, $string);
1831: }
1832:
1833: $string =~ s/^__ARRAY_REF__//;
1834:
1835: while($string !~ /^__END_ARRAY_REF__/) {
1836: my $value='';
1837: if($string =~ /^__HASH_REF__/) {
1838: ($value, $string)=&str2hashref($string);
1839: if(defined($value->{'error'})) {
1840: $array[0] ='Array reference error';
1841: return (\@array, $string);
1842: }
1843: } elsif($string =~ /^__ARRAY_REF__/) {
1844: ($value, $string)=&str2arrayref($string);
1845: if($value->[0] eq 'Array reference error') {
1846: $array[0] ='Array reference error';
1847: return (\@array, $string);
1848: }
1849: } else {
1850: $value=&get_scalar(\$string,'__END_ARRAY_REF__');
1851: }
1852: $string =~ s/^&//;
1853:
1854: push(@array, $value);
1.191 harris41 1855: }
1.265 albertel 1856:
1857: $string =~ s/^__END_ARRAY_REF__//;
1858:
1859: return (\@array, $string);
1.168 albertel 1860: }
1861:
1.167 albertel 1862: # -------------------------------------------------------------------Temp Store
1863:
1.168 albertel 1864: sub tmpreset {
1865: my ($symb,$namespace,$domain,$stuname) = @_;
1866: if (!$symb) {
1867: $symb=&symbread();
1.380 albertel 1868: if (!$symb) { $symb= $ENV{'request.url'}; }
1.168 albertel 1869: }
1870: $symb=escape($symb);
1871:
1872: if (!$namespace) { $namespace=$ENV{'request.state'}; }
1873: $namespace=~s/\//\_/g;
1874: $namespace=~s/\W//g;
1875:
1876: #FIXME needs to do something for /pub resources
1877: if (!$domain) { $domain=$ENV{'user.domain'}; }
1878: if (!$stuname) { $stuname=$ENV{'user.name'}; }
1879: my $path=$perlvar{'lonDaemons'}.'/tmp';
1880: my %hash;
1881: if (tie(%hash,'GDBM_File',
1882: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
1.256 albertel 1883: &GDBM_WRCREAT(),0640)) {
1.168 albertel 1884: foreach my $key (keys %hash) {
1.180 albertel 1885: if ($key=~ /:$symb/) {
1.168 albertel 1886: delete($hash{$key});
1887: }
1888: }
1889: }
1890: }
1891:
1.167 albertel 1892: sub tmpstore {
1.168 albertel 1893: my ($storehash,$symb,$namespace,$domain,$stuname) = @_;
1894:
1895: if (!$symb) {
1896: $symb=&symbread();
1897: if (!$symb) { $symb= $ENV{'request.url'}; }
1898: }
1899: $symb=escape($symb);
1900:
1901: if (!$namespace) {
1902: # I don't think we would ever want to store this for a course.
1903: # it seems this will only be used if we don't have a course.
1904: #$namespace=$ENV{'request.course.id'};
1905: #if (!$namespace) {
1906: $namespace=$ENV{'request.state'};
1907: #}
1908: }
1909: $namespace=~s/\//\_/g;
1910: $namespace=~s/\W//g;
1911: #FIXME needs to do something for /pub resources
1912: if (!$domain) { $domain=$ENV{'user.domain'}; }
1913: if (!$stuname) { $stuname=$ENV{'user.name'}; }
1914: my $now=time;
1915: my %hash;
1916: my $path=$perlvar{'lonDaemons'}.'/tmp';
1917: if (tie(%hash,'GDBM_File',
1918: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
1.256 albertel 1919: &GDBM_WRCREAT(),0640)) {
1.168 albertel 1920: $hash{"version:$symb"}++;
1921: my $version=$hash{"version:$symb"};
1922: my $allkeys='';
1923: foreach my $key (keys(%$storehash)) {
1924: $allkeys.=$key.':';
1925: $hash{"$version:$symb:$key"}=$$storehash{$key};
1926: }
1927: $hash{"$version:$symb:timestamp"}=$now;
1928: $allkeys.='timestamp';
1929: $hash{"$version:keys:$symb"}=$allkeys;
1930: if (untie(%hash)) {
1931: return 'ok';
1932: } else {
1933: return "error:$!";
1934: }
1935: } else {
1936: return "error:$!";
1937: }
1938: }
1.167 albertel 1939:
1.168 albertel 1940: # -----------------------------------------------------------------Temp Restore
1.167 albertel 1941:
1.168 albertel 1942: sub tmprestore {
1943: my ($symb,$namespace,$domain,$stuname) = @_;
1.167 albertel 1944:
1.168 albertel 1945: if (!$symb) {
1946: $symb=&symbread();
1947: if (!$symb) { $symb= $ENV{'request.url'}; }
1948: }
1949: $symb=escape($symb);
1950:
1951: if (!$namespace) { $namespace=$ENV{'request.state'}; }
1952: #FIXME needs to do something for /pub resources
1953: if (!$domain) { $domain=$ENV{'user.domain'}; }
1954: if (!$stuname) { $stuname=$ENV{'user.name'}; }
1955:
1956: my %returnhash;
1957: $namespace=~s/\//\_/g;
1958: $namespace=~s/\W//g;
1959: my %hash;
1960: my $path=$perlvar{'lonDaemons'}.'/tmp';
1961: if (tie(%hash,'GDBM_File',
1962: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
1.256 albertel 1963: &GDBM_READER(),0640)) {
1.168 albertel 1964: my $version=$hash{"version:$symb"};
1965: $returnhash{'version'}=$version;
1966: my $scope;
1967: for ($scope=1;$scope<=$version;$scope++) {
1968: my $vkeys=$hash{"$scope:keys:$symb"};
1969: my @keys=split(/:/,$vkeys);
1970: my $key;
1971: $returnhash{"$scope:keys"}=$vkeys;
1972: foreach $key (@keys) {
1973: $returnhash{"$scope:$key"}=$hash{"$scope:$symb:$key"};
1974: $returnhash{"$key"}=$hash{"$scope:$symb:$key"};
1.167 albertel 1975: }
1976: }
1.168 albertel 1977: if (!(untie(%hash))) {
1978: return "error:$!";
1979: }
1980: } else {
1981: return "error:$!";
1982: }
1983: return %returnhash;
1.167 albertel 1984: }
1985:
1.9 www 1986: # ----------------------------------------------------------------------- Store
1987:
1988: sub store {
1.124 www 1989: my ($storehash,$symb,$namespace,$domain,$stuname) = @_;
1990: my $home='';
1991:
1.168 albertel 1992: if ($stuname) { $home=&homeserver($stuname,$domain); }
1.124 www 1993:
1.213 www 1994: $symb=&symbclean($symb);
1.122 albertel 1995: if (!$symb) { unless ($symb=&symbread()) { return ''; } }
1.109 www 1996:
1.325 www 1997: if (!$domain) { $domain=$ENV{'user.domain'}; }
1998: if (!$stuname) { $stuname=$ENV{'user.name'}; }
1999:
2000: &devalidate($symb,$stuname,$domain);
1.109 www 2001:
2002: $symb=escape($symb);
1.187 www 2003: if (!$namespace) {
2004: unless ($namespace=$ENV{'request.course.id'}) {
2005: return '';
2006: }
2007: }
1.122 albertel 2008: if (!$home) { $home=$ENV{'user.home'}; }
1.447 www 2009:
2010: $$storehash{'ip'}=$ENV{'REMOTE_ADDR'};
2011: $$storehash{'host'}=$perlvar{'lonHostID'};
2012:
1.12 www 2013: my $namevalue='';
1.191 harris41 2014: foreach (keys %$storehash) {
1.122 albertel 2015: $namevalue.=escape($_).'='.escape($$storehash{$_}).'&';
1.191 harris41 2016: }
1.12 www 2017: $namevalue=~s/\&$//;
1.187 www 2018: &courselog($symb.':'.$stuname.':'.$domain.':STORE:'.$namevalue);
1.124 www 2019: return reply("store:$domain:$stuname:$namespace:$symb:$namevalue","$home");
1.9 www 2020: }
2021:
1.47 www 2022: # -------------------------------------------------------------- Critical Store
2023:
2024: sub cstore {
1.124 www 2025: my ($storehash,$symb,$namespace,$domain,$stuname) = @_;
2026: my $home='';
2027:
1.168 albertel 2028: if ($stuname) { $home=&homeserver($stuname,$domain); }
1.124 www 2029:
1.213 www 2030: $symb=&symbclean($symb);
1.122 albertel 2031: if (!$symb) { unless ($symb=&symbread()) { return ''; } }
1.109 www 2032:
1.325 www 2033: if (!$domain) { $domain=$ENV{'user.domain'}; }
2034: if (!$stuname) { $stuname=$ENV{'user.name'}; }
2035:
2036: &devalidate($symb,$stuname,$domain);
1.109 www 2037:
2038: $symb=escape($symb);
1.187 www 2039: if (!$namespace) {
2040: unless ($namespace=$ENV{'request.course.id'}) {
2041: return '';
2042: }
2043: }
1.122 albertel 2044: if (!$home) { $home=$ENV{'user.home'}; }
1.447 www 2045:
2046: $$storehash{'ip'}=$ENV{'REMOTE_ADDR'};
2047: $$storehash{'host'}=$perlvar{'lonHostID'};
1.122 albertel 2048:
1.47 www 2049: my $namevalue='';
1.191 harris41 2050: foreach (keys %$storehash) {
1.122 albertel 2051: $namevalue.=escape($_).'='.escape($$storehash{$_}).'&';
1.191 harris41 2052: }
1.47 www 2053: $namevalue=~s/\&$//;
1.187 www 2054: &courselog($symb.':'.$stuname.':'.$domain.':CSTORE:'.$namevalue);
1.188 www 2055: return critical
2056: ("store:$domain:$stuname:$namespace:$symb:$namevalue","$home");
1.47 www 2057: }
2058:
1.9 www 2059: # --------------------------------------------------------------------- Restore
2060:
2061: sub restore {
1.124 www 2062: my ($symb,$namespace,$domain,$stuname) = @_;
2063: my $home='';
2064:
1.168 albertel 2065: if ($stuname) { $home=&homeserver($stuname,$domain); }
1.124 www 2066:
1.122 albertel 2067: if (!$symb) {
2068: unless ($symb=escape(&symbread())) { return ''; }
2069: } else {
1.213 www 2070: $symb=&escape(&symbclean($symb));
1.122 albertel 2071: }
1.188 www 2072: if (!$namespace) {
2073: unless ($namespace=$ENV{'request.course.id'}) {
2074: return '';
2075: }
2076: }
1.122 albertel 2077: if (!$domain) { $domain=$ENV{'user.domain'}; }
2078: if (!$stuname) { $stuname=$ENV{'user.name'}; }
2079: if (!$home) { $home=$ENV{'user.home'}; }
2080: my $answer=&reply("restore:$domain:$stuname:$namespace:$symb","$home");
2081:
1.12 www 2082: my %returnhash=();
1.191 harris41 2083: foreach (split(/\&/,$answer)) {
1.12 www 2084: my ($name,$value)=split(/\=/,$_);
2085: $returnhash{&unescape($name)}=&unescape($value);
1.191 harris41 2086: }
1.75 www 2087: my $version;
2088: for ($version=1;$version<=$returnhash{'version'};$version++) {
1.191 harris41 2089: foreach (split(/\:/,$returnhash{$version.':keys'})) {
1.75 www 2090: $returnhash{$_}=$returnhash{$version.':'.$_};
1.191 harris41 2091: }
1.75 www 2092: }
1.13 www 2093: return %returnhash;
1.34 www 2094: }
2095:
2096: # ---------------------------------------------------------- Course Description
2097:
2098: sub coursedescription {
2099: my $courseid=shift;
2100: $courseid=~s/^\///;
1.49 www 2101: $courseid=~s/\_/\//g;
1.34 www 2102: my ($cdomain,$cnum)=split(/\//,$courseid);
1.129 albertel 2103: my $chome=&homeserver($cnum,$cdomain);
1.302 albertel 2104: my $normalid=$cdomain.'_'.$cnum;
2105: # need to always cache even if we get errors otherwise we keep
2106: # trying and trying and trying to get the course description.
2107: my %envhash=();
2108: my %returnhash=();
2109: $envhash{'course.'.$normalid.'.last_cache'}=time;
1.34 www 2110: if ($chome ne 'no_host') {
1.302 albertel 2111: %returnhash=&dump('environment',$cdomain,$cnum);
1.129 albertel 2112: if (!exists($returnhash{'con_lost'})) {
2113: $returnhash{'home'}= $chome;
2114: $returnhash{'domain'} = $cdomain;
2115: $returnhash{'num'} = $cnum;
1.130 albertel 2116: while (my ($name,$value) = each %returnhash) {
1.53 www 2117: $envhash{'course.'.$normalid.'.'.$name}=$value;
1.129 albertel 2118: }
1.270 www 2119: $returnhash{'url'}=&clutter($returnhash{'url'});
1.34 www 2120: $returnhash{'fn'}=$perlvar{'lonDaemons'}.'/tmp/'.
1.38 www 2121: $ENV{'user.name'}.'_'.$cdomain.'_'.$cnum;
1.60 www 2122: $envhash{'course.'.$normalid.'.home'}=$chome;
2123: $envhash{'course.'.$normalid.'.domain'}=$cdomain;
2124: $envhash{'course.'.$normalid.'.num'}=$cnum;
1.34 www 2125: }
2126: }
1.302 albertel 2127: &appenv(%envhash);
2128: return %returnhash;
1.461 www 2129: }
2130:
2131: # -------------------------------------------------See if a user is privileged
2132:
2133: sub privileged {
2134: my ($username,$domain)=@_;
2135: my $rolesdump=&reply("dump:$domain:$username:roles",
2136: &homeserver($username,$domain));
2137: if (($rolesdump eq 'con_lost') || ($rolesdump eq '')) { return 0; }
2138: my $now=time;
2139: if ($rolesdump ne '') {
2140: foreach (split(/&/,$rolesdump)) {
2141: if ($_!~/^rolesdef\&/) {
2142: my ($area,$role)=split(/=/,$_);
2143: $area=~s/\_\w\w$//;
2144: my ($trole,$tend,$tstart)=split(/_/,$role);
2145: if (($trole eq 'dc') || ($trole eq 'su')) {
2146: my $active=1;
2147: if ($tend) {
2148: if ($tend<$now) { $active=0; }
2149: }
2150: if ($tstart) {
2151: if ($tstart>$now) { $active=0; }
2152: }
2153: if ($active) { return 1; }
2154: }
2155: }
2156: }
2157: }
2158: return 0;
1.9 www 2159: }
1.1 albertel 2160:
1.103 harris41 2161: # -------------------------------------------------------- Get user privileges
1.11 www 2162:
2163: sub rolesinit {
2164: my ($domain,$username,$authhost)=@_;
2165: my $rolesdump=reply("dump:$domain:$username:roles",$authhost);
1.12 www 2166: if (($rolesdump eq 'con_lost') || ($rolesdump eq '')) { return ''; }
1.11 www 2167: my %allroles=();
2168: my %thesepriv=();
2169: my $now=time;
1.21 www 2170: my $userroles="user.login.time=$now\n";
1.11 www 2171: my $thesestr;
2172:
2173: if ($rolesdump ne '') {
1.191 harris41 2174: foreach (split(/&/,$rolesdump)) {
1.21 www 2175: if ($_!~/^rolesdef\&/) {
1.11 www 2176: my ($area,$role)=split(/=/,$_);
1.21 www 2177: $area=~s/\_\w\w$//;
1.11 www 2178: my ($trole,$tend,$tstart)=split(/_/,$role);
1.21 www 2179: $userroles.='user.role.'.$trole.'.'.$area.'='.
2180: $tstart.'.'.$tend."\n";
1.349 www 2181: # log the associated role with the area
2182: &userrolelog($trole,$username,$domain,$area,$tstart,$tend);
1.11 www 2183: if ($tend!=0) {
2184: if ($tend<$now) {
2185: $trole='';
2186: }
2187: }
2188: if ($tstart!=0) {
2189: if ($tstart>$now) {
2190: $trole='';
2191: }
2192: }
2193: if (($area ne '') && ($trole ne '')) {
1.347 albertel 2194: my $spec=$trole.'.'.$area;
2195: my ($tdummy,$tdomain,$trest)=split(/\//,$area);
2196: if ($trole =~ /^cr\//) {
2197: my ($rdummy,$rdomain,$rauthor,$rrole)=split(/\//,$trole);
1.392 www 2198: my $homsvr=homeserver($rauthor,$rdomain);
1.347 albertel 2199: if ($hostname{$homsvr} ne '') {
1.392 www 2200: my ($rdummy,$roledef)=
2201: &get('roles',["rolesdef_$rrole"],$rdomain,$rauthor);
2202:
2203: if (($rdummy ne 'con_lost') && ($roledef ne '')) {
1.347 albertel 2204: my ($syspriv,$dompriv,$coursepriv)=
1.392 www 2205: split(/\_/,$roledef);
1.347 albertel 2206: if (defined($syspriv)) {
2207: $allroles{'cm./'}.=':'.$syspriv;
2208: $allroles{$spec.'./'}.=':'.$syspriv;
2209: }
2210: if ($tdomain ne '') {
2211: if (defined($dompriv)) {
2212: $allroles{'cm./'.$tdomain.'/'}.=':'.$dompriv;
2213: $allroles{$spec.'./'.$tdomain.'/'}.=':'.$dompriv;
2214: }
2215: if ($trest ne '') {
2216: if (defined($coursepriv)) {
2217: $allroles{'cm.'.$area}.=':'.$coursepriv;
2218: $allroles{$spec.'.'.$area}.=':'.$coursepriv;
2219: }
2220: }
2221: }
2222: }
2223: }
2224: } else {
2225: if (defined($pr{$trole.':s'})) {
2226: $allroles{'cm./'}.=':'.$pr{$trole.':s'};
2227: $allroles{$spec.'./'}.=':'.$pr{$trole.':s'};
2228: }
2229: if ($tdomain ne '') {
2230: if (defined($pr{$trole.':d'})) {
2231: $allroles{'cm./'.$tdomain.'/'}.=':'.$pr{$trole.':d'};
2232: $allroles{$spec.'./'.$tdomain.'/'}.=':'.$pr{$trole.':d'};
2233: }
2234: if ($trest ne '') {
2235: if (defined($pr{$trole.':c'})) {
2236: $allroles{'cm.'.$area}.=':'.$pr{$trole.':c'};
2237: $allroles{$spec.'.'.$area}.=':'.$pr{$trole.':c'};
2238: }
2239: }
2240: }
2241: }
1.12 www 2242: }
2243: }
1.191 harris41 2244: }
1.125 www 2245: my $adv=0;
1.128 www 2246: my $author=0;
1.191 harris41 2247: foreach (keys %allroles) {
1.11 www 2248: %thesepriv=();
1.146 www 2249: if (($_!~/^st/) && ($_!~/^ta/) && ($_!~/^cm/)) { $adv=1; }
1.128 www 2250: if (($_=~/^au/) || ($_=~/^ca/)) { $author=1; }
1.191 harris41 2251: foreach (split(/:/,$allroles{$_})) {
1.11 www 2252: if ($_ ne '') {
1.103 harris41 2253: my ($privilege,$restrictions)=split(/&/,$_);
1.11 www 2254: if ($restrictions eq '') {
1.103 harris41 2255: $thesepriv{$privilege}='F';
1.11 www 2256: } else {
1.103 harris41 2257: if ($thesepriv{$privilege} ne 'F') {
2258: $thesepriv{$privilege}.=$restrictions;
1.11 www 2259: }
2260: }
2261: }
1.191 harris41 2262: }
1.11 www 2263: $thesestr='';
1.191 harris41 2264: foreach (keys %thesepriv) { $thesestr.=':'.$_.'&'.$thesepriv{$_}; }
1.11 www 2265: $userroles.='user.priv.'.$_.'='.$thesestr."\n";
1.191 harris41 2266: }
1.128 www 2267: $userroles.='user.adv='.$adv."\n".
2268: 'user.author='.$author."\n";
1.126 www 2269: $ENV{'user.adv'}=$adv;
1.11 www 2270: }
2271: return $userroles;
2272: }
2273:
1.12 www 2274: # --------------------------------------------------------------- get interface
2275:
2276: sub get {
1.131 albertel 2277: my ($namespace,$storearr,$udomain,$uname)=@_;
1.12 www 2278: my $items='';
1.191 harris41 2279: foreach (@$storearr) {
1.12 www 2280: $items.=escape($_).'&';
1.191 harris41 2281: }
1.12 www 2282: $items=~s/\&$//;
1.131 albertel 2283: if (!$udomain) { $udomain=$ENV{'user.domain'}; }
2284: if (!$uname) { $uname=$ENV{'user.name'}; }
2285: my $uhome=&homeserver($uname,$udomain);
2286:
1.133 albertel 2287: my $rep=&reply("get:$udomain:$uname:$namespace:$items",$uhome);
1.15 www 2288: my @pairs=split(/\&/,$rep);
1.273 albertel 2289: if ( $#pairs==0 && $pairs[0] =~ /^(con_lost|error|no_such_host)/i) {
2290: return @pairs;
2291: }
1.15 www 2292: my %returnhash=();
1.42 www 2293: my $i=0;
1.191 harris41 2294: foreach (@$storearr) {
1.42 www 2295: $returnhash{$_}=unescape($pairs[$i]);
2296: $i++;
1.191 harris41 2297: }
1.15 www 2298: return %returnhash;
1.27 www 2299: }
2300:
2301: # --------------------------------------------------------------- del interface
2302:
2303: sub del {
1.133 albertel 2304: my ($namespace,$storearr,$udomain,$uname)=@_;
1.27 www 2305: my $items='';
1.191 harris41 2306: foreach (@$storearr) {
1.27 www 2307: $items.=escape($_).'&';
1.191 harris41 2308: }
1.27 www 2309: $items=~s/\&$//;
1.133 albertel 2310: if (!$udomain) { $udomain=$ENV{'user.domain'}; }
2311: if (!$uname) { $uname=$ENV{'user.name'}; }
2312: my $uhome=&homeserver($uname,$udomain);
2313:
2314: return &reply("del:$udomain:$uname:$namespace:$items",$uhome);
1.15 www 2315: }
2316:
2317: # -------------------------------------------------------------- dump interface
2318:
2319: sub dump {
1.193 www 2320: my ($namespace,$udomain,$uname,$regexp)=@_;
1.129 albertel 2321: if (!$udomain) { $udomain=$ENV{'user.domain'}; }
2322: if (!$uname) { $uname=$ENV{'user.name'}; }
2323: my $uhome=&homeserver($uname,$udomain);
1.193 www 2324: if ($regexp) {
2325: $regexp=&escape($regexp);
2326: } else {
2327: $regexp='.';
2328: }
2329: my $rep=reply("dump:$udomain:$uname:$namespace:$regexp",$uhome);
1.12 www 2330: my @pairs=split(/\&/,$rep);
2331: my %returnhash=();
1.191 harris41 2332: foreach (@pairs) {
1.12 www 2333: my ($key,$value)=split(/=/,$_);
1.29 www 2334: $returnhash{unescape($key)}=unescape($value);
1.318 matthew 2335: }
2336: return %returnhash;
1.407 www 2337: }
2338:
2339: # -------------------------------------------------------------- keys interface
2340:
2341: sub getkeys {
2342: my ($namespace,$udomain,$uname)=@_;
2343: if (!$udomain) { $udomain=$ENV{'user.domain'}; }
2344: if (!$uname) { $uname=$ENV{'user.name'}; }
2345: my $uhome=&homeserver($uname,$udomain);
2346: my $rep=reply("keys:$udomain:$uname:$namespace",$uhome);
2347: my @keyarray=();
2348: foreach (split(/\&/,$rep)) {
2349: push (@keyarray,&unescape($_));
2350: }
2351: return @keyarray;
1.318 matthew 2352: }
2353:
1.319 matthew 2354: # --------------------------------------------------------------- currentdump
2355: sub currentdump {
1.328 matthew 2356: my ($courseid,$sdom,$sname)=@_;
1.326 matthew 2357: $courseid = $ENV{'request.course.id'} if (! defined($courseid));
2358: $sdom = $ENV{'user.domain'} if (! defined($sdom));
2359: $sname = $ENV{'user.name'} if (! defined($sname));
2360: my $uhome = &homeserver($sname,$sdom);
2361: my $rep=reply('currentdump:'.$sdom.':'.$sname.':'.$courseid,$uhome);
1.318 matthew 2362: return if ($rep =~ /^(error:|no_such_host)/);
1.319 matthew 2363: #
1.318 matthew 2364: my %returnhash=();
1.319 matthew 2365: #
2366: if ($rep eq "unknown_cmd") {
2367: # an old lond will not know currentdump
2368: # Do a dump and make it look like a currentdump
1.326 matthew 2369: my @tmp = &dump($courseid,$sdom,$sname,'.');
1.319 matthew 2370: return if ($tmp[0] =~ /^(error:|no_such_host)/);
2371: my %hash = @tmp;
2372: @tmp=();
1.424 matthew 2373: %returnhash = %{&convert_dump_to_currentdump(\%hash)};
1.319 matthew 2374: } else {
2375: my @pairs=split(/\&/,$rep);
2376: foreach (@pairs) {
2377: my ($key,$value)=split(/=/,$_);
2378: my ($symb,$param) = split(/:/,$key);
2379: $returnhash{&unescape($symb)}->{&unescape($param)} =
2380: &unescape($value);
2381: }
1.191 harris41 2382: }
1.12 www 2383: return %returnhash;
1.424 matthew 2384: }
2385:
2386: sub convert_dump_to_currentdump{
2387: my %hash = %{shift()};
2388: my %returnhash;
2389: # Code ripped from lond, essentially. The only difference
2390: # here is the unescaping done by lonnet::dump(). Conceivably
2391: # we might run in to problems with parameter names =~ /^v\./
2392: while (my ($key,$value) = each(%hash)) {
2393: my ($v,$symb,$param) = split(/:/,$key);
2394: next if ($v eq 'version' || $symb eq 'keys');
2395: next if (exists($returnhash{$symb}) &&
2396: exists($returnhash{$symb}->{$param}) &&
2397: $returnhash{$symb}->{'v.'.$param} > $v);
2398: $returnhash{$symb}->{$param}=$value;
2399: $returnhash{$symb}->{'v.'.$param}=$v;
2400: }
2401: #
2402: # Remove all of the keys in the hashes which keep track of
2403: # the version of the parameter.
2404: while (my ($symb,$param_hash) = each(%returnhash)) {
2405: # use a foreach because we are going to delete from the hash.
2406: foreach my $key (keys(%$param_hash)) {
2407: delete($param_hash->{$key}) if ($key =~ /^v\./);
2408: }
2409: }
2410: return \%returnhash;
1.12 www 2411: }
2412:
1.449 matthew 2413: # --------------------------------------------------------------- inc interface
2414:
2415: sub inc {
2416: my ($namespace,$store,$udomain,$uname) = @_;
2417: if (!$udomain) { $udomain=$ENV{'user.domain'}; }
2418: if (!$uname) { $uname=$ENV{'user.name'}; }
2419: my $uhome=&homeserver($uname,$udomain);
2420: my $items='';
2421: if (! ref($store)) {
2422: # got a single value, so use that instead
2423: $items = &escape($store).'=&';
2424: } elsif (ref($store) eq 'SCALAR') {
2425: $items = &escape($$store).'=&';
2426: } elsif (ref($store) eq 'ARRAY') {
2427: $items = join('=&',map {&escape($_);} @{$store});
2428: } elsif (ref($store) eq 'HASH') {
2429: while (my($key,$value) = each(%{$store})) {
2430: $items.= &escape($key).'='.&escape($value).'&';
2431: }
2432: }
2433: $items=~s/\&$//;
2434: return &reply("inc:$udomain:$uname:$namespace:$items",$uhome);
2435: }
2436:
1.12 www 2437: # --------------------------------------------------------------- put interface
2438:
2439: sub put {
1.134 albertel 2440: my ($namespace,$storehash,$udomain,$uname)=@_;
2441: if (!$udomain) { $udomain=$ENV{'user.domain'}; }
2442: if (!$uname) { $uname=$ENV{'user.name'}; }
2443: my $uhome=&homeserver($uname,$udomain);
1.12 www 2444: my $items='';
1.191 harris41 2445: foreach (keys %$storehash) {
1.134 albertel 2446: $items.=&escape($_).'='.&escape($$storehash{$_}).'&';
1.191 harris41 2447: }
1.12 www 2448: $items=~s/\&$//;
1.134 albertel 2449: return &reply("put:$udomain:$uname:$namespace:$items",$uhome);
1.47 www 2450: }
2451:
2452: # ------------------------------------------------------ critical put interface
2453:
2454: sub cput {
1.134 albertel 2455: my ($namespace,$storehash,$udomain,$uname)=@_;
2456: if (!$udomain) { $udomain=$ENV{'user.domain'}; }
2457: if (!$uname) { $uname=$ENV{'user.name'}; }
2458: my $uhome=&homeserver($uname,$udomain);
1.47 www 2459: my $items='';
1.191 harris41 2460: foreach (keys %$storehash) {
1.134 albertel 2461: $items.=escape($_).'='.escape($$storehash{$_}).'&';
1.191 harris41 2462: }
1.47 www 2463: $items=~s/\&$//;
1.134 albertel 2464: return &critical("put:$udomain:$uname:$namespace:$items",$uhome);
1.12 www 2465: }
2466:
2467: # -------------------------------------------------------------- eget interface
2468:
2469: sub eget {
1.133 albertel 2470: my ($namespace,$storearr,$udomain,$uname)=@_;
1.12 www 2471: my $items='';
1.191 harris41 2472: foreach (@$storearr) {
1.12 www 2473: $items.=escape($_).'&';
1.191 harris41 2474: }
1.12 www 2475: $items=~s/\&$//;
1.133 albertel 2476: if (!$udomain) { $udomain=$ENV{'user.domain'}; }
2477: if (!$uname) { $uname=$ENV{'user.name'}; }
2478: my $uhome=&homeserver($uname,$udomain);
2479: my $rep=&reply("eget:$udomain:$uname:$namespace:$items",$uhome);
1.12 www 2480: my @pairs=split(/\&/,$rep);
2481: my %returnhash=();
1.42 www 2482: my $i=0;
1.191 harris41 2483: foreach (@$storearr) {
1.42 www 2484: $returnhash{$_}=unescape($pairs[$i]);
2485: $i++;
1.191 harris41 2486: }
1.12 www 2487: return %returnhash;
2488: }
2489:
1.341 www 2490: # ---------------------------------------------- Custom access rule evaluation
2491:
2492: sub customaccess {
2493: my ($priv,$uri)=@_;
1.342 www 2494: my ($urole,$urealm)=split(/\./,$ENV{'request.role'});
1.343 www 2495: $urealm=~s/^\W//;
2496: my ($udom,$ucrs,$usec)=split(/\//,$urealm);
1.341 www 2497: my $access=0;
2498: foreach (split(/\s*\,\s*/,&metadata($uri,'rule_rights'))) {
1.342 www 2499: my ($effect,$realm,$role)=split(/\:/,$_);
1.343 www 2500: if ($role) {
2501: if ($role ne $urole) { next; }
2502: }
2503: foreach (split(/\s*\,\s*/,$realm)) {
2504: my ($tdom,$tcrs,$tsec)=split(/\_/,$_);
2505: if ($tdom) {
2506: if ($tdom ne $udom) { next; }
2507: }
2508: if ($tcrs) {
2509: if ($tcrs ne $ucrs) { next; }
2510: }
2511: if ($tsec) {
2512: if ($tsec ne $usec) { next; }
2513: }
2514: $access=($effect eq 'allow');
2515: last;
1.342 www 2516: }
1.402 bowersj2 2517: if ($realm eq '' && $role eq '') {
2518: $access=($effect eq 'allow');
2519: }
1.341 www 2520: }
2521: return $access;
2522: }
2523:
1.103 harris41 2524: # ------------------------------------------------- Check for a user privilege
1.12 www 2525:
2526: sub allowed {
2527: my ($priv,$uri)=@_;
1.439 www 2528: $uri=&deversion($uri);
1.152 www 2529: my $orguri=$uri;
1.52 www 2530: $uri=&declutter($uri);
1.29 www 2531:
1.398 albertel 2532: if (defined($ENV{'allowed.'.$priv})) { return $ENV{'allowed.'.$priv}; }
1.54 www 2533: # Free bre access to adm and meta resources
1.29 www 2534:
1.54 www 2535: if ((($uri=~/^adm\//) || ($uri=~/\.meta$/)) && ($priv eq 'bre')) {
1.14 www 2536: return 'F';
1.159 www 2537: }
2538:
2539: # Free bre to public access
2540:
2541: if ($priv eq 'bre') {
1.238 www 2542: my $copyright=&metadata($uri,'copyright');
1.301 www 2543: if (($copyright eq 'public') && (!$ENV{'request.course.id'})) {
2544: return 'F';
2545: }
1.238 www 2546: if ($copyright eq 'priv') {
2547: $uri=~/([^\/]+)\/([^\/]+)\//;
2548: unless (($ENV{'user.name'} eq $2) && ($ENV{'user.domain'} eq $1)) {
2549: return '';
2550: }
2551: }
2552: if ($copyright eq 'domain') {
2553: $uri=~/([^\/]+)\/([^\/]+)\//;
2554: unless (($ENV{'user.domain'} eq $1) ||
2555: ($ENV{'course.'.$ENV{'request.course.id'}.'.domain'} eq $1)) {
2556: return '';
2557: }
1.262 matthew 2558: }
2559: if ($ENV{'request.role'}=~ /li\.\//) {
2560: # Library role, so allow browsing of resources in this domain.
2561: return 'F';
1.238 www 2562: }
1.341 www 2563: if ($copyright eq 'custom') {
2564: unless (&customaccess($priv,$uri)) { return ''; }
2565: }
1.14 www 2566: }
1.264 matthew 2567: # Domain coordinator is trying to create a course
2568: if (($priv eq 'ccc') && ($ENV{'request.role'} =~ /^dc\./)) {
2569: # uri is the requested domain in this case.
2570: # comparison to 'request.role.domain' shows if the user has selected
2571: # a role of dc for the domain in question.
2572: return 'F' if ($uri eq $ENV{'request.role.domain'});
2573: }
1.29 www 2574:
1.52 www 2575: my $thisallowed='';
2576: my $statecond=0;
2577: my $courseprivid='';
2578:
2579: # Course
2580:
2581: if ($ENV{'user.priv.'.$ENV{'request.role'}.'./'}=~/$priv\&([^\:]*)/) {
2582: $thisallowed.=$1;
2583: }
1.29 www 2584:
1.52 www 2585: # Domain
2586:
2587: if ($ENV{'user.priv.'.$ENV{'request.role'}.'./'.(split(/\//,$uri))[0].'/'}
2588: =~/$priv\&([^\:]*)/) {
1.12 www 2589: $thisallowed.=$1;
2590: }
1.52 www 2591:
2592: # Course: uri itself is a course
1.66 www 2593: my $courseuri=$uri;
2594: $courseuri=~s/\_(\d)/\/$1/;
1.83 www 2595: $courseuri=~s/^([^\/])/\/$1/;
1.81 www 2596:
1.83 www 2597: if ($ENV{'user.priv.'.$ENV{'request.role'}.'.'.$courseuri}
1.52 www 2598: =~/$priv\&([^\:]*)/) {
1.12 www 2599: $thisallowed.=$1;
2600: }
1.29 www 2601:
1.314 www 2602: # URI is an uploaded document for this course
2603:
2604: if (($priv eq 'bre') &&
2605: ($uri=~/^uploaded\/$ENV{'course.'.$ENV{'request.course.id'}.'.domain'}\/$ENV{'course.'.$ENV{'request.course.id'}.'.num'}/)) {
2606: return 'F';
2607: }
1.52 www 2608: # Full access at system, domain or course-wide level? Exit.
1.29 www 2609:
2610: if ($thisallowed=~/F/) {
2611: return 'F';
2612: }
2613:
1.52 www 2614: # If this is generating or modifying users, exit with special codes
1.29 www 2615:
1.166 www 2616: if (':csu:cdc:ccc:cin:cta:cep:ccr:cst:cad:cli:cau:cdg:cca:'=~/\:$priv\:/) {
1.52 www 2617: return $thisallowed;
2618: }
2619: #
1.103 harris41 2620: # Gathered so far: system, domain and course wide privileges
1.52 www 2621: #
2622: # Course: See if uri or referer is an individual resource that is part of
2623: # the course
2624:
2625: if ($ENV{'request.course.id'}) {
1.232 www 2626:
1.52 www 2627: $courseprivid=$ENV{'request.course.id'};
2628: if ($ENV{'request.course.sec'}) {
2629: $courseprivid.='/'.$ENV{'request.course.sec'};
2630: }
2631: $courseprivid=~s/\_/\//;
2632: my $checkreferer=1;
1.232 www 2633: my ($match,$cond)=&is_on_map($uri);
2634: if ($match) {
2635: $statecond=$cond;
1.52 www 2636: if ($ENV{'user.priv.'.$ENV{'request.role'}.'./'.$courseprivid}
2637: =~/$priv\&([^\:]*)/) {
2638: $thisallowed.=$1;
2639: $checkreferer=0;
2640: }
1.29 www 2641: }
1.83 www 2642:
1.148 www 2643: if ($checkreferer) {
1.152 www 2644: my $refuri=$ENV{'httpref.'.$orguri};
1.148 www 2645: unless ($refuri) {
1.191 harris41 2646: foreach (keys %ENV) {
1.148 www 2647: if ($_=~/^httpref\..*\*/) {
2648: my $pattern=$_;
1.156 www 2649: $pattern=~s/^httpref\.\/res\///;
1.148 www 2650: $pattern=~s/\*/\[\^\/\]\+/g;
2651: $pattern=~s/\//\\\//g;
1.152 www 2652: if ($orguri=~/$pattern/) {
1.148 www 2653: $refuri=$ENV{$_};
2654: }
2655: }
1.191 harris41 2656: }
1.148 www 2657: }
1.232 www 2658:
1.148 www 2659: if ($refuri) {
1.152 www 2660: $refuri=&declutter($refuri);
1.232 www 2661: my ($match,$cond)=&is_on_map($refuri);
2662: if ($match) {
2663: my $refstatecond=$cond;
1.52 www 2664: if ($ENV{'user.priv.'.$ENV{'request.role'}.'./'.$courseprivid}
2665: =~/$priv\&([^\:]*)/) {
2666: $thisallowed.=$1;
1.53 www 2667: $uri=$refuri;
2668: $statecond=$refstatecond;
1.52 www 2669: }
2670: }
1.148 www 2671: }
1.29 www 2672: }
1.52 www 2673: }
1.29 www 2674:
1.52 www 2675: #
1.103 harris41 2676: # Gathered now: all privileges that could apply, and condition number
1.52 www 2677: #
2678: #
2679: # Full or no access?
2680: #
1.29 www 2681:
1.52 www 2682: if ($thisallowed=~/F/) {
2683: return 'F';
2684: }
1.29 www 2685:
1.52 www 2686: unless ($thisallowed) {
2687: return '';
2688: }
1.29 www 2689:
1.52 www 2690: # Restrictions exist, deal with them
2691: #
2692: # C:according to course preferences
2693: # R:according to resource settings
2694: # L:unless locked
2695: # X:according to user session state
2696: #
2697:
2698: # Possibly locked functionality, check all courses
1.54 www 2699: # Locks might take effect only after 10 minutes cache expiration for other
2700: # courses, and 2 minutes for current course
1.52 www 2701:
2702: my $envkey;
2703: if ($thisallowed=~/L/) {
2704: foreach $envkey (keys %ENV) {
1.54 www 2705: if ($envkey=~/^user\.role\.(st|ta)\.([^\.]*)/) {
2706: my $courseid=$2;
2707: my $roleid=$1.'.'.$2;
1.92 www 2708: $courseid=~s/^\///;
1.54 www 2709: my $expiretime=600;
2710: if ($ENV{'request.role'} eq $roleid) {
2711: $expiretime=120;
2712: }
2713: my ($cdom,$cnum,$csec)=split(/\//,$courseid);
2714: my $prefix='course.'.$cdom.'_'.$cnum.'.';
2715: if ((time-$ENV{$prefix.'last_cache'})>$expiretime) {
2716: &coursedescription($courseid);
2717: }
2718: if (($ENV{$prefix.'res.'.$uri.'.lock.sections'}=~/\,$csec\,/)
2719: || ($ENV{$prefix.'res.'.$uri.'.lock.sections'} eq 'all')) {
2720: if ($ENV{$prefix.'res.'.$uri.'.lock.expire'}>time) {
1.57 www 2721: &log($ENV{'user.domain'},$ENV{'user.name'},
1.239 www 2722: $ENV{'user.home'},
1.57 www 2723: 'Locked by res: '.$priv.' for '.$uri.' due to '.
1.52 www 2724: $cdom.'/'.$cnum.'/'.$csec.' expire '.
1.54 www 2725: $ENV{$prefix.'priv.'.$priv.'.lock.expire'});
1.52 www 2726: return '';
2727: }
2728: }
1.54 www 2729: if (($ENV{$prefix.'priv.'.$priv.'.lock.sections'}=~/\,$csec\,/)
2730: || ($ENV{$prefix.'priv.'.$priv.'.lock.sections'} eq 'all')) {
2731: if ($ENV{'priv.'.$priv.'.lock.expire'}>time) {
1.57 www 2732: &log($ENV{'user.domain'},$ENV{'user.name'},
1.239 www 2733: $ENV{'user.home'},
1.57 www 2734: 'Locked by priv: '.$priv.' for '.$uri.' due to '.
1.52 www 2735: $cdom.'/'.$cnum.'/'.$csec.' expire '.
1.54 www 2736: $ENV{$prefix.'priv.'.$priv.'.lock.expire'});
1.52 www 2737: return '';
2738: }
2739: }
2740: }
1.29 www 2741: }
1.52 www 2742: }
2743:
2744: #
2745: # Rest of the restrictions depend on selected course
2746: #
2747:
2748: unless ($ENV{'request.course.id'}) {
2749: return '1';
2750: }
1.29 www 2751:
1.52 www 2752: #
2753: # Now user is definitely in a course
2754: #
1.53 www 2755:
2756:
2757: # Course preferences
2758:
2759: if ($thisallowed=~/C/) {
1.54 www 2760: my $rolecode=(split(/\./,$ENV{'request.role'}))[0];
1.237 www 2761: my $unamedom=$ENV{'user.name'}.':'.$ENV{'user.domain'};
1.54 www 2762: if ($ENV{'course.'.$ENV{'request.course.id'}.'.'.$priv.'.roles.denied'}
1.194 www 2763: =~/$rolecode/) {
1.57 www 2764: &log($ENV{'user.domain'},$ENV{'user.name'},$ENV{'user.host'},
2765: 'Denied by role: '.$priv.' for '.$uri.' as '.$rolecode.' in '.
1.237 www 2766: $ENV{'request.course.id'});
2767: return '';
2768: }
2769:
2770: if ($ENV{'course.'.$ENV{'request.course.id'}.'.'.$priv.'.users.denied'}
2771: =~/$unamedom/) {
2772: &log($ENV{'user.domain'},$ENV{'user.name'},$ENV{'user.host'},
2773: 'Denied by user: '.$priv.' for '.$uri.' as '.$unamedom.' in '.
1.54 www 2774: $ENV{'request.course.id'});
2775: return '';
2776: }
1.53 www 2777: }
2778:
2779: # Resource preferences
2780:
2781: if ($thisallowed=~/R/) {
1.54 www 2782: my $rolecode=(split(/\./,$ENV{'request.role'}))[0];
1.341 www 2783: if (&metadata($uri,'roledeny')=~/$rolecode/) {
2784: &log($ENV{'user.domain'},$ENV{'user.name'},$ENV{'user.host'},
1.57 www 2785: 'Denied by role: '.$priv.' for '.$uri.' as '.$rolecode);
1.341 www 2786: return '';
1.54 www 2787: }
1.53 www 2788: }
1.30 www 2789:
1.246 www 2790: # Restricted by state or randomout?
1.30 www 2791:
1.52 www 2792: if ($thisallowed=~/X/) {
1.247 www 2793: if ($ENV{'acc.randomout'}) {
1.249 www 2794: my $symb=&symbread($uri,1);
1.248 www 2795: if (($symb) && ($ENV{'acc.randomout'}=~/\&$symb\&/)) {
2796: return '';
2797: }
1.247 www 2798: }
2799: if (&condval($statecond)) {
1.52 www 2800: return '2';
2801: } else {
2802: return '';
2803: }
2804: }
1.30 www 2805:
1.52 www 2806: return 'F';
1.232 www 2807: }
2808:
2809: # --------------------------------------------------- Is a resource on the map?
2810:
2811: sub is_on_map {
2812: my $uri=&declutter(shift);
1.435 www 2813: $uri=~s/\.\d+\.(\w+)$/\.$1/;
1.232 www 2814: my @uriparts=split(/\//,$uri);
2815: my $filename=$uriparts[$#uriparts];
2816: my $pathname=$uri;
1.289 bowersj2 2817: $pathname=~s|/\Q$filename\E$||;
1.332 www 2818: $pathname=~s/^adm\/wrapper\///;
1.289 bowersj2 2819: #Trying to find the conditional for the file
1.232 www 2820: my $match=($ENV{'acc.res.'.$ENV{'request.course.id'}.'.'.$pathname}=~
1.289 bowersj2 2821: /\&\Q$filename\E\:([\d\|]+)\&/);
1.232 www 2822: if ($match) {
1.289 bowersj2 2823: return (1,$1);
2824: } else {
1.434 www 2825: return (0,0);
1.289 bowersj2 2826: }
1.12 www 2827: }
2828:
1.427 www 2829: # --------------------------------------------------------- Get symb from alias
2830:
2831: sub get_symb_from_alias {
2832: my $symb=shift;
2833: my ($map,$resid,$url)=&decode_symb($symb);
2834: # Already is a symb
2835: if ($url) { return $symb; }
2836: # Must be an alias
2837: my $aliassymb='';
2838: my %bighash;
2839: if (tie(%bighash,'GDBM_File',$ENV{'request.course.fn'}.'.db',
2840: &GDBM_READER(),0640)) {
2841: my $rid=$bighash{'mapalias_'.$symb};
2842: if ($rid) {
2843: my ($mapid,$resid)=split(/\./,$rid);
1.429 albertel 2844: $aliassymb=&encode_symb($bighash{'map_id_'.$mapid},
2845: $resid,$bighash{'src_'.$rid});
1.427 www 2846: }
2847: untie %bighash;
2848: }
2849: return $aliassymb;
2850: }
2851:
1.12 www 2852: # ----------------------------------------------------------------- Define Role
2853:
2854: sub definerole {
2855: if (allowed('mcr','/')) {
2856: my ($rolename,$sysrole,$domrole,$courole)=@_;
1.392 www 2857: foreach (split(':',$sysrole)) {
1.21 www 2858: my ($crole,$cqual)=split(/\&/,$_);
2859: if ($pr{'cr:s'}!~/$crole/) { return "refused:s:$crole"; }
2860: if ($pr{'cr:s'}=~/$crole\&/) {
2861: if ($pr{'cr:s'}!~/$crole\&\w*$cqual/) {
2862: return "refused:s:$crole&$cqual";
2863: }
2864: }
1.191 harris41 2865: }
1.392 www 2866: foreach (split(':',$domrole)) {
1.21 www 2867: my ($crole,$cqual)=split(/\&/,$_);
2868: if ($pr{'cr:d'}!~/$crole/) { return "refused:d:$crole"; }
2869: if ($pr{'cr:d'}=~/$crole\&/) {
2870: if ($pr{'cr:d'}!~/$crole\&\w*$cqual/) {
2871: return "refused:d:$crole&$cqual";
2872: }
2873: }
1.191 harris41 2874: }
1.392 www 2875: foreach (split(':',$courole)) {
1.21 www 2876: my ($crole,$cqual)=split(/\&/,$_);
2877: if ($pr{'cr:c'}!~/$crole/) { return "refused:c:$crole"; }
2878: if ($pr{'cr:c'}=~/$crole\&/) {
2879: if ($pr{'cr:c'}!~/$crole\&\w*$cqual/) {
2880: return "refused:c:$crole&$cqual";
2881: }
2882: }
1.191 harris41 2883: }
1.12 www 2884: my $command="encrypt:rolesput:$ENV{'user.domain'}:$ENV{'user.name'}:".
2885: "$ENV{'user.domain'}:$ENV{'user.name'}:".
1.21 www 2886: "rolesdef_$rolename=".
2887: escape($sysrole.'_'.$domrole.'_'.$courole);
1.12 www 2888: return reply($command,$ENV{'user.home'});
2889: } else {
2890: return 'refused';
2891: }
1.105 harris41 2892: }
2893:
2894: # ---------------- Make a metadata query against the network of library servers
2895:
2896: sub metadata_query {
1.244 matthew 2897: my ($query,$custom,$customshow,$server_array)=@_;
1.120 harris41 2898: my %rhash;
1.244 matthew 2899: my @server_list = (defined($server_array) ? @$server_array
2900: : keys(%libserv) );
2901: for my $server (@server_list) {
1.118 harris41 2902: unless ($custom or $customshow) {
2903: my $reply=&reply("querysend:".&escape($query),$server);
2904: $rhash{$server}=$reply;
2905: }
2906: else {
2907: my $reply=&reply("querysend:".&escape($query).':'.
2908: &escape($custom).':'.&escape($customshow),
2909: $server);
2910: $rhash{$server}=$reply;
2911: }
1.112 harris41 2912: }
1.118 harris41 2913: return \%rhash;
1.240 www 2914: }
2915:
2916: # ----------------------------------------- Send log queries and wait for reply
2917:
2918: sub log_query {
2919: my ($uname,$udom,$query,%filters)=@_;
2920: my $uhome=&homeserver($uname,$udom);
2921: if ($uhome eq 'no_host') { return 'error: no_host'; }
2922: my $uhost=$hostname{$uhome};
1.241 www 2923: my $command=&escape(join(':',map{$_.'='.$filters{$_}} keys %filters));
1.240 www 2924: my $queryid=&reply("querysend:".$query.':'.$udom.':'.$uname.':'.$command,
2925: $uhome);
2926: unless ($queryid=~/^$uhost\_/) { return 'error: '.$queryid; }
1.242 www 2927: return get_query_reply($queryid);
2928: }
2929:
2930: sub get_query_reply {
2931: my $queryid=shift;
1.240 www 2932: my $replyfile=$perlvar{'lonDaemons'}.'/tmp/'.$queryid;
2933: my $reply='';
2934: for (1..100) {
2935: sleep 2;
2936: if (-e $replyfile.'.end') {
1.448 albertel 2937: if (open(my $fh,$replyfile)) {
1.240 www 2938: $reply.=<$fh>;
1.448 albertel 2939: close($fh);
1.240 www 2940: } else { return 'error: reply_file_error'; }
1.242 www 2941: return &unescape($reply);
2942: }
1.240 www 2943: }
1.242 www 2944: return 'timeout:'.$queryid;
1.240 www 2945: }
2946:
2947: sub courselog_query {
1.241 www 2948: #
2949: # possible filters:
2950: # url: url or symb
2951: # username
2952: # domain
2953: # action: view, submit, grade
2954: # start: timestamp
2955: # end: timestamp
2956: #
1.240 www 2957: my (%filters)=@_;
2958: unless ($ENV{'request.course.id'}) { return 'no_course'; }
1.241 www 2959: if ($filters{'url'}) {
2960: $filters{'url'}=&symbclean(&declutter($filters{'url'}));
2961: $filters{'url'}=~s/\.(\w+)$/(\\.\\d+)*\\.$1/;
2962: $filters{'url'}=~s/\.(\w+)\_\_\_/(\\.\\d+)*\\.$1/;
2963: }
1.240 www 2964: my $cname=$ENV{'course.'.$ENV{'request.course.id'}.'.num'};
2965: my $cdom=$ENV{'course.'.$ENV{'request.course.id'}.'.domain'};
2966: return &log_query($cname,$cdom,'courselog',%filters);
2967: }
2968:
2969: sub userlog_query {
2970: my ($uname,$udom,%filters)=@_;
2971: return &log_query($uname,$udom,'userlog',%filters);
1.12 www 2972: }
2973:
2974: # ------------------------------------------------------------------ Plain Text
2975:
2976: sub plaintext {
1.22 www 2977: my $short=shift;
1.414 www 2978: return &mt($prp{$short});
1.12 www 2979: }
2980:
2981: # ----------------------------------------------------------------- Assign Role
2982:
2983: sub assignrole {
1.357 www 2984: my ($udom,$uname,$url,$role,$end,$start,$deleteflag)=@_;
1.21 www 2985: my $mrole;
2986: if ($role =~ /^cr\//) {
1.393 www 2987: my $cwosec=$url;
2988: $cwosec=~s/^\/(\w+)\/(\w+)\/.*/$1\/$2/;
2989: unless (&allowed('ccr',$cwosec)) {
1.104 www 2990: &logthis('Refused custom assignrole: '.
2991: $udom.' '.$uname.' '.$url.' '.$role.' '.$end.' '.$start.' by '.
2992: $ENV{'user.name'}.' at '.$ENV{'user.domain'});
2993: return 'refused';
2994: }
1.21 www 2995: $mrole='cr';
2996: } else {
1.82 www 2997: my $cwosec=$url;
1.83 www 2998: $cwosec=~s/^\/(\w+)\/(\w+)\/.*/$1\/$2/;
1.373 www 2999: unless ((&allowed('c'.$role,$cwosec)) || &allowed('c'.$role,$udom)) {
1.104 www 3000: &logthis('Refused assignrole: '.
3001: $udom.' '.$uname.' '.$url.' '.$role.' '.$end.' '.$start.' by '.
3002: $ENV{'user.name'}.' at '.$ENV{'user.domain'});
3003: return 'refused';
3004: }
1.21 www 3005: $mrole=$role;
3006: }
3007: my $command="encrypt:rolesput:$ENV{'user.domain'}:$ENV{'user.name'}:".
3008: "$udom:$uname:$url".'_'."$mrole=$role";
1.81 www 3009: if ($end) { $command.='_'.$end; }
1.21 www 3010: if ($start) {
3011: if ($end) {
1.81 www 3012: $command.='_'.$start;
1.21 www 3013: } else {
1.81 www 3014: $command.='_0_'.$start;
1.21 www 3015: }
3016: }
1.357 www 3017: # actually delete
3018: if ($deleteflag) {
1.373 www 3019: if ((&allowed('dro',$udom)) || (&allowed('dro',$url))) {
1.357 www 3020: # modify command to delete the role
3021: $command="encrypt:rolesdel:$ENV{'user.domain'}:$ENV{'user.name'}:".
3022: "$udom:$uname:$url".'_'."$mrole";
1.373 www 3023: &logthis("$ENV{'user.name'} at $ENV{'user.domain'} deletes $mrole in $url for $uname at $udom");
1.357 www 3024: # set start and finish to negative values for userrolelog
3025: $start=-1;
3026: $end=-1;
3027: }
3028: }
3029: # send command
1.349 www 3030: my $answer=&reply($command,&homeserver($uname,$udom));
1.357 www 3031: # log new user role if status is ok
1.349 www 3032: if ($answer eq 'ok') {
3033: &userrolelog($mrole,$uname,$udom,$url,$start,$end);
3034: }
3035: return $answer;
1.169 harris41 3036: }
3037:
3038: # -------------------------------------------------- Modify user authentication
1.197 www 3039: # Overrides without validation
3040:
1.169 harris41 3041: sub modifyuserauth {
3042: my ($udom,$uname,$umode,$upass)=@_;
3043: my $uhome=&homeserver($uname,$udom);
1.197 www 3044: unless (&allowed('mau',$udom)) { return 'refused'; }
3045: &logthis('Call to modify user authentication '.$udom.', '.$uname.', '.
1.272 matthew 3046: $umode.' by '.$ENV{'user.name'}.' at '.$ENV{'user.domain'}.
3047: ' in domain '.$ENV{'request.role.domain'});
1.169 harris41 3048: my $reply=&reply('encrypt:changeuserauth:'.$udom.':'.$uname.':'.$umode.':'.
3049: &escape($upass),$uhome);
1.197 www 3050: &log($ENV{'user.domain'},$ENV{'user.name'},$ENV{'user.home'},
3051: 'Authentication changed for '.$udom.', '.$uname.', '.$umode.
3052: '(Remote '.$ENV{'REMOTE_ADDR'}.'): '.$reply);
3053: &log($udom,,$uname,$uhome,
3054: 'Authentication changed by '.$ENV{'user.domain'}.', '.
3055: $ENV{'user.name'}.', '.$umode.
3056: '(Remote '.$ENV{'REMOTE_ADDR'}.'): '.$reply);
1.169 harris41 3057: unless ($reply eq 'ok') {
1.197 www 3058: &logthis('Authentication mode error: '.$reply);
1.169 harris41 3059: return 'error: '.$reply;
3060: }
1.170 harris41 3061: return 'ok';
1.80 www 3062: }
3063:
1.81 www 3064: # --------------------------------------------------------------- Modify a user
1.80 www 3065:
1.81 www 3066: sub modifyuser {
1.206 matthew 3067: my ($udom, $uname, $uid,
3068: $umode, $upass, $first,
3069: $middle, $last, $gene,
1.387 www 3070: $forceid, $desiredhome, $email)=@_;
1.198 www 3071: $udom=~s/\W//g;
3072: $uname=~s/\W//g;
1.81 www 3073: &logthis('Call to modify user '.$udom.', '.$uname.', '.$uid.', '.
1.80 www 3074: $umode.', '.$first.', '.$middle.', '.
1.206 matthew 3075: $last.', '.$gene.'(forceid: '.$forceid.')'.
3076: (defined($desiredhome) ? ' desiredhome = '.$desiredhome :
3077: ' desiredhome not specified').
1.272 matthew 3078: ' by '.$ENV{'user.name'}.' at '.$ENV{'user.domain'}.
3079: ' in domain '.$ENV{'request.role.domain'});
1.230 stredwic 3080: my $uhome=&homeserver($uname,$udom,'true');
1.80 www 3081: # ----------------------------------------------------------------- Create User
1.406 albertel 3082: if (($uhome eq 'no_host') &&
3083: (($umode && $upass) || ($umode eq 'localauth'))) {
1.80 www 3084: my $unhome='';
1.209 matthew 3085: if (defined($desiredhome) && $hostdom{$desiredhome} eq $udom) {
3086: $unhome = $desiredhome;
3087: } elsif($ENV{'course.'.$ENV{'request.course.id'}.'.domain'} eq $udom) {
1.80 www 3088: $unhome=$ENV{'course.'.$ENV{'request.course.id'}.'.home'};
1.209 matthew 3089: } else { # load balancing routine for determining $unhome
1.80 www 3090: my $tryserver;
1.81 www 3091: my $loadm=10000000;
1.80 www 3092: foreach $tryserver (keys %libserv) {
3093: if ($hostdom{$tryserver} eq $udom) {
3094: my $answer=reply('load',$tryserver);
3095: if (($answer=~/\d+/) && ($answer<$loadm)) {
3096: $loadm=$answer;
3097: $unhome=$tryserver;
3098: }
3099: }
3100: }
3101: }
3102: if (($unhome eq '') || ($unhome eq 'no_host')) {
1.206 matthew 3103: return 'error: unable to find a home server for '.$uname.
3104: ' in domain '.$udom;
1.80 www 3105: }
3106: my $reply=&reply('encrypt:makeuser:'.$udom.':'.$uname.':'.$umode.':'.
3107: &escape($upass),$unhome);
3108: unless ($reply eq 'ok') {
3109: return 'error: '.$reply;
3110: }
1.230 stredwic 3111: $uhome=&homeserver($uname,$udom,'true');
1.80 www 3112: if (($uhome eq '') || ($uhome eq 'no_host') || ($uhome ne $unhome)) {
1.386 matthew 3113: return 'error: unable verify users home machine.';
1.80 www 3114: }
1.209 matthew 3115: } # End of creation of new user
1.80 www 3116: # ---------------------------------------------------------------------- Add ID
3117: if ($uid) {
3118: $uid=~tr/A-Z/a-z/;
3119: my %uidhash=&idrget($udom,$uname);
1.196 www 3120: if (($uidhash{$uname}) && ($uidhash{$uname}!~/error\:/)
3121: && (!$forceid)) {
1.80 www 3122: unless ($uid eq $uidhash{$uname}) {
1.386 matthew 3123: return 'error: user id "'.$uid.'" does not match '.
3124: 'current user id "'.$uidhash{$uname}.'".';
1.80 www 3125: }
3126: } else {
3127: &idput($udom,($uname => $uid));
3128: }
3129: }
3130: # -------------------------------------------------------------- Add names, etc
1.313 matthew 3131: my @tmp=&get('environment',
1.134 albertel 3132: ['firstname','middlename','lastname','generation'],
3133: $udom,$uname);
1.313 matthew 3134: my %names;
3135: if ($tmp[0] =~ m/^error:.*/) {
3136: %names=();
3137: } else {
3138: %names = @tmp;
3139: }
1.388 www 3140: #
3141: # Make sure to not trash student environment if instructor does not bother
3142: # to supply name and email information
3143: #
3144: if ($first) { $names{'firstname'} = $first; }
1.385 matthew 3145: if (defined($middle)) { $names{'middlename'} = $middle; }
1.388 www 3146: if ($last) { $names{'lastname'} = $last; }
1.385 matthew 3147: if (defined($gene)) { $names{'generation'} = $gene; }
1.388 www 3148: if ($email) { $names{'notification'} = $email;
3149: $names{'critnotification'} = $email; }
1.387 www 3150:
1.134 albertel 3151: my $reply = &put('environment', \%names, $udom,$uname);
3152: if ($reply ne 'ok') { return 'error: '.$reply; }
1.81 www 3153: &logthis('Success modifying user '.$udom.', '.$uname.', '.$uid.', '.
1.80 www 3154: $umode.', '.$first.', '.$middle.', '.
3155: $last.', '.$gene.' by '.
3156: $ENV{'user.name'}.' at '.$ENV{'user.domain'});
1.134 albertel 3157: return 'ok';
1.80 www 3158: }
3159:
1.81 www 3160: # -------------------------------------------------------------- Modify student
1.80 www 3161:
1.81 www 3162: sub modifystudent {
3163: my ($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene,$usec,
1.455 albertel 3164: $end,$start,$forceid,$desiredhome,$email,$type,$cid)=@_;
3165: if (!$cid) {
3166: unless ($cid=$ENV{'request.course.id'}) {
3167: return 'not_in_class';
3168: }
1.80 www 3169: }
3170: # --------------------------------------------------------------- Make the user
1.81 www 3171: my $reply=&modifyuser
1.209 matthew 3172: ($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene,$forceid,
1.387 www 3173: $desiredhome,$email);
1.80 www 3174: unless ($reply eq 'ok') { return $reply; }
1.297 matthew 3175: # This will cause &modify_student_enrollment to get the uid from the
3176: # students environment
3177: $uid = undef if (!$forceid);
1.455 albertel 3178: $reply = &modify_student_enrollment($udom,$uname,$uid,$first,$middle,$last,
3179: $gene,$usec,$end,$start,$type,$cid);
1.297 matthew 3180: return $reply;
3181: }
3182:
3183: sub modify_student_enrollment {
1.455 albertel 3184: my ($udom,$uname,$uid,$first,$middle,$last,$gene,$usec,$end,$start,$type,
3185: $cid) = @_;
3186: my ($cdom,$cnum,$chome);
3187: if (!$cid) {
3188: unless ($cid=$ENV{'request.course.id'}) {
3189: return 'not_in_class';
3190: }
3191: $cdom=$ENV{'course.'.$cid.'.domain'};
3192: $cnum=$ENV{'course.'.$cid.'.num'};
3193: } else {
3194: ($cdom,$cnum)=split(/_/,$cid);
3195: }
3196: $chome=$ENV{'course.'.$cid.'.home'};
3197: if (!$chome) {
1.457 raeburn 3198: $chome=&homeserver($cnum,$cdom);
1.297 matthew 3199: }
1.455 albertel 3200: if (!$chome) { return 'unknown_course'; }
1.297 matthew 3201: # Make sure the user exists
1.81 www 3202: my $uhome=&homeserver($uname,$udom);
3203: if (($uhome eq '') || ($uhome eq 'no_host')) {
3204: return 'error: no such user';
3205: }
1.297 matthew 3206: # Get student data if we were not given enough information
3207: if (!defined($first) || $first eq '' ||
3208: !defined($last) || $last eq '' ||
3209: !defined($uid) || $uid eq '' ||
3210: !defined($middle) || $middle eq '' ||
3211: !defined($gene) || $gene eq '') {
1.294 matthew 3212: # They did not supply us with enough data to enroll the student, so
3213: # we need to pick up more information.
1.297 matthew 3214: my %tmp = &get('environment',
1.294 matthew 3215: ['firstname','middlename','lastname', 'generation','id']
1.297 matthew 3216: ,$udom,$uname);
3217:
1.455 albertel 3218: #foreach (keys(%tmp)) {
3219: # &logthis("key $_ = ".$tmp{$_});
3220: #}
1.294 matthew 3221: $first = $tmp{'firstname'} if (!defined($first) || $first eq '');
3222: $middle = $tmp{'middlename'} if (!defined($middle) || $middle eq '');
3223: $last = $tmp{'lastname'} if (!defined($last) || $last eq '');
1.297 matthew 3224: $gene = $tmp{'generation'} if (!defined($gene) || $gene eq '');
1.294 matthew 3225: $uid = $tmp{'id'} if (!defined($uid) || $uid eq '');
3226: }
3227: my $fullname = &Apache::loncoursedata::ProcessFullName($last,$gene,
3228: $first,$middle);
1.455 albertel 3229: my $value=&escape($uname.':'.$udom).'='.
1.457 raeburn 3230: &escape(join(':',$end,$start,$uid,$usec,$fullname,$type));
1.455 albertel 3231: my $reply=critical('put:'.$cdom.':'.$cnum.':classlist:'.$value,$chome);
1.81 www 3232: unless (($reply eq 'ok') || ($reply eq 'delayed')) {
3233: return 'error: '.$reply;
3234: }
1.297 matthew 3235: # Add student role to user
1.83 www 3236: my $uurl='/'.$cid;
1.81 www 3237: $uurl=~s/\_/\//g;
3238: if ($usec) {
3239: $uurl.='/'.$usec;
3240: }
3241: return &assignrole($udom,$uname,$uurl,'st',$end,$start);
1.21 www 3242: }
3243:
1.84 www 3244: # ------------------------------------------------- Write to course preferences
3245:
3246: sub writecoursepref {
3247: my ($courseid,%prefs)=@_;
3248: $courseid=~s/^\///;
3249: $courseid=~s/\_/\//g;
3250: my ($cdomain,$cnum)=split(/\//,$courseid);
3251: my $chome=homeserver($cnum,$cdomain);
3252: if (($chome eq '') || ($chome eq 'no_host')) {
3253: return 'error: no such course';
3254: }
3255: my $cstring='';
1.191 harris41 3256: foreach (keys %prefs) {
1.84 www 3257: $cstring.=escape($_).'='.escape($prefs{$_}).'&';
1.191 harris41 3258: }
1.84 www 3259: $cstring=~s/\&$//;
3260: return reply('put:'.$cdomain.':'.$cnum.':environment:'.$cstring,$chome);
3261: }
3262:
3263: # ---------------------------------------------------------- Make/modify course
3264:
3265: sub createcourse {
1.271 www 3266: my ($udom,$description,$url,$course_server,$nonstandard)=@_;
1.84 www 3267: $url=&declutter($url);
3268: my $cid='';
1.264 matthew 3269: unless (&allowed('ccc',$udom)) {
1.84 www 3270: return 'refused';
3271: }
3272: # ------------------------------------------------------------------- Create ID
3273: my $uname=substr($$.time,0,5).unpack("H8",pack("I32",time)).
3274: unpack("H2",pack("I32",int(rand(255)))).$perlvar{'lonHostID'};
3275: # ----------------------------------------------- Make sure that does not exist
1.230 stredwic 3276: my $uhome=&homeserver($uname,$udom,'true');
1.84 www 3277: unless (($uhome eq '') || ($uhome eq 'no_host')) {
3278: $uname=substr($$.time,0,5).unpack("H8",pack("I32",time)).
3279: unpack("H2",pack("I32",int(rand(255)))).$perlvar{'lonHostID'};
1.230 stredwic 3280: $uhome=&homeserver($uname,$udom,'true');
1.84 www 3281: unless (($uhome eq '') || ($uhome eq 'no_host')) {
3282: return 'error: unable to generate unique course-ID';
3283: }
3284: }
1.264 matthew 3285: # ------------------------------------------------ Check supplied server name
3286: $course_server = $ENV{'user.homeserver'} if (! defined($course_server));
3287: if (! exists($libserv{$course_server})) {
3288: return 'error:bad server name '.$course_server;
3289: }
1.84 www 3290: # ------------------------------------------------------------- Make the course
3291: my $reply=&reply('encrypt:makeuser:'.$udom.':'.$uname.':none::',
1.264 matthew 3292: $course_server);
1.84 www 3293: unless ($reply eq 'ok') { return 'error: '.$reply; }
1.230 stredwic 3294: $uhome=&homeserver($uname,$udom,'true');
1.84 www 3295: if (($uhome eq '') || ($uhome eq 'no_host')) {
3296: return 'error: no such course';
3297: }
1.271 www 3298: # ----------------------------------------------------------------- Course made
1.358 www 3299: # log existance
3300: &courseidput($udom,&escape($udom.'_'.$uname).'='.&escape($description),
3301: $uhome);
3302: &flushcourselogs();
3303: # set toplevel url
1.271 www 3304: my $topurl=$url;
3305: unless ($nonstandard) {
3306: # ------------------------------------------ For standard courses, make top url
3307: my $mapurl=&clutter($url);
1.278 www 3308: if ($mapurl eq '/res/') { $mapurl=''; }
1.271 www 3309: $ENV{'form.initmap'}=(<<ENDINITMAP);
3310: <map>
3311: <resource id="1" type="start"></resource>
3312: <resource id="2" src="$mapurl"></resource>
3313: <resource id="3" type="finish"></resource>
3314: <link index="1" from="1" to="2"></link>
3315: <link index="2" from="2" to="3"></link>
3316: </map>
3317: ENDINITMAP
3318: $topurl=&declutter(
3319: &finishuserfileupload($uname,$udom,$uhome,'initmap','default.sequence')
3320: );
3321: }
3322: # ----------------------------------------------------------- Write preferences
1.84 www 3323: &writecoursepref($udom.'_'.$uname,
3324: ('description' => $description,
1.271 www 3325: 'url' => $topurl));
1.84 www 3326: return '/'.$udom.'/'.$uname;
3327: }
3328:
1.21 www 3329: # ---------------------------------------------------------- Assign Custom Role
3330:
3331: sub assigncustomrole {
1.357 www 3332: my ($udom,$uname,$url,$rdom,$rnam,$rolename,$end,$start,$deleteflag)=@_;
1.21 www 3333: return &assignrole($udom,$uname,$url,'cr/'.$rdom.'/'.$rnam.'/'.$rolename,
1.357 www 3334: $end,$start,$deleteflag);
1.21 www 3335: }
3336:
3337: # ----------------------------------------------------------------- Revoke Role
3338:
3339: sub revokerole {
1.357 www 3340: my ($udom,$uname,$url,$role,$deleteflag)=@_;
1.21 www 3341: my $now=time;
1.357 www 3342: return &assignrole($udom,$uname,$url,$role,$now,$deleteflag);
1.21 www 3343: }
3344:
3345: # ---------------------------------------------------------- Revoke Custom Role
3346:
3347: sub revokecustomrole {
1.357 www 3348: my ($udom,$uname,$url,$rdom,$rnam,$rolename,$deleteflag)=@_;
1.21 www 3349: my $now=time;
1.357 www 3350: return &assigncustomrole($udom,$uname,$url,$rdom,$rnam,$rolename,$now,
3351: $deleteflag);
1.17 www 3352: }
3353:
3354: # ------------------------------------------------------------ Directory lister
3355:
3356: sub dirlist {
1.253 stredwic 3357: my ($uri,$userdomain,$username,$alternateDirectoryRoot)=@_;
3358:
1.18 www 3359: $uri=~s/^\///;
3360: $uri=~s/\/$//;
1.253 stredwic 3361: my ($udom, $uname);
3362: (undef,$udom,$uname)=split(/\//,$uri);
3363: if(defined($userdomain)) {
3364: $udom = $userdomain;
3365: }
3366: if(defined($username)) {
3367: $uname = $username;
3368: }
3369:
3370: my $dirRoot = $perlvar{'lonDocRoot'};
3371: if(defined($alternateDirectoryRoot)) {
3372: $dirRoot = $alternateDirectoryRoot;
3373: $dirRoot =~ s/\/$//;
3374: }
3375:
3376: if($udom) {
3377: if($uname) {
3378: my $listing=reply('ls:'.$dirRoot.'/'.$uri,
3379: homeserver($uname,$udom));
3380: return split(/:/,$listing);
3381: } elsif(!defined($alternateDirectoryRoot)) {
3382: my $tryserver;
3383: my %allusers=();
3384: foreach $tryserver (keys %libserv) {
3385: if($hostdom{$tryserver} eq $udom) {
3386: my $listing=reply('ls:'.$perlvar{'lonDocRoot'}.'/res/'.
3387: $udom, $tryserver);
3388: if (($listing ne 'no_such_dir') && ($listing ne 'empty')
3389: && ($listing ne 'con_lost')) {
3390: foreach (split(/:/,$listing)) {
3391: my ($entry,@stat)=split(/&/,$_);
3392: $allusers{$entry}=1;
3393: }
3394: }
1.191 harris41 3395: }
1.253 stredwic 3396: }
3397: my $alluserstr='';
3398: foreach (sort keys %allusers) {
3399: $alluserstr.=$_.'&user:';
3400: }
3401: $alluserstr=~s/:$//;
3402: return split(/:/,$alluserstr);
3403: } else {
3404: my @emptyResults = ();
3405: push(@emptyResults, 'missing user name');
3406: return split(':',@emptyResults);
3407: }
3408: } elsif(!defined($alternateDirectoryRoot)) {
3409: my $tryserver;
3410: my %alldom=();
3411: foreach $tryserver (keys %libserv) {
3412: $alldom{$hostdom{$tryserver}}=1;
3413: }
3414: my $alldomstr='';
3415: foreach (sort keys %alldom) {
1.397 albertel 3416: $alldomstr.=$perlvar{'lonDocRoot'}.'/res/'.$_.'/&domain:';
1.253 stredwic 3417: }
3418: $alldomstr=~s/:$//;
3419: return split(/:/,$alldomstr);
3420: } else {
3421: my @emptyResults = ();
3422: push(@emptyResults, 'missing domain');
3423: return split(':',@emptyResults);
1.275 stredwic 3424: }
3425: }
3426:
3427: # --------------------------------------------- GetFileTimestamp
3428: # This function utilizes dirlist and returns the date stamp for
3429: # when it was last modified. It will also return an error of -1
3430: # if an error occurs
3431:
1.410 matthew 3432: ##
3433: ## FIXME: This subroutine assumes its caller knows something about the
3434: ## directory structure of the home server for the student ($root).
3435: ## Not a good assumption to make. Since this is for looking up files
3436: ## in user directories, the full path should be constructed by lond, not
3437: ## whatever machine we request data from.
3438: ##
1.275 stredwic 3439: sub GetFileTimestamp {
3440: my ($studentDomain,$studentName,$filename,$root)=@_;
3441: $studentDomain=~s/\W//g;
3442: $studentName=~s/\W//g;
3443: my $subdir=$studentName.'__';
3444: $subdir =~ s/(.)(.)(.).*/$1\/$2\/$3/;
3445: my $proname="$studentDomain/$subdir/$studentName";
3446: $proname .= '/'.$filename;
1.375 matthew 3447: my ($fileStat) = &Apache::lonnet::dirlist($proname, $studentDomain,
3448: $studentName, $root);
1.275 stredwic 3449: my @stats = split('&', $fileStat);
3450: if($stats[0] ne 'empty' && $stats[0] ne 'no_such_dir') {
1.375 matthew 3451: # @stats contains first the filename, then the stat output
3452: return $stats[10]; # so this is 10 instead of 9.
1.275 stredwic 3453: } else {
3454: return -1;
1.253 stredwic 3455: }
1.26 www 3456: }
3457:
3458: # -------------------------------------------------------- Value of a Condition
3459:
1.40 www 3460: sub directcondval {
3461: my $number=shift;
3462: if ($ENV{'user.state.'.$ENV{'request.course.id'}}) {
3463: return substr($ENV{'user.state.'.$ENV{'request.course.id'}},$number,1);
3464: } else {
3465: return 2;
3466: }
3467: }
3468:
1.26 www 3469: sub condval {
3470: my $condidx=shift;
3471: my $result=0;
1.54 www 3472: my $allpathcond='';
1.191 harris41 3473: foreach (split(/\|/,$condidx)) {
1.54 www 3474: if (defined($ENV{'acc.cond.'.$ENV{'request.course.id'}.'.'.$_})) {
3475: $allpathcond.=
3476: '('.$ENV{'acc.cond.'.$ENV{'request.course.id'}.'.'.$_}.')|';
3477: }
1.191 harris41 3478: }
1.54 www 3479: $allpathcond=~s/\|$//;
1.33 www 3480: if ($ENV{'request.course.id'}) {
1.54 www 3481: if ($allpathcond) {
1.26 www 3482: my $operand='|';
3483: my @stack;
1.191 harris41 3484: foreach ($allpathcond=~/(\d+|\(|\)|\&|\|)/g) {
1.26 www 3485: if ($_ eq '(') {
3486: push @stack,($operand,$result)
3487: } elsif ($_ eq ')') {
3488: my $before=pop @stack;
3489: if (pop @stack eq '&') {
3490: $result=$result>$before?$before:$result;
3491: } else {
3492: $result=$result>$before?$result:$before;
3493: }
3494: } elsif (($_ eq '&') || ($_ eq '|')) {
3495: $operand=$_;
3496: } else {
1.40 www 3497: my $new=directcondval($_);
1.26 www 3498: if ($operand eq '&') {
3499: $result=$result>$new?$new:$result;
3500: } else {
3501: $result=$result>$new?$result:$new;
1.191 harris41 3502: }
1.26 www 3503: }
1.191 harris41 3504: }
1.26 www 3505: }
3506: }
3507: return $result;
1.421 albertel 3508: }
3509:
3510: # ---------------------------------------------------- Devalidate courseresdata
3511:
3512: sub devalidatecourseresdata {
3513: my ($coursenum,$coursedomain)=@_;
3514: my $hashid=$coursenum.':'.$coursedomain;
1.428 albertel 3515: &devalidate_cache(\%courseresdatacache,$hashid,'courseres');
1.28 www 3516: }
3517:
1.200 www 3518: # --------------------------------------------------- Course Resourcedata Query
3519:
3520: sub courseresdata {
3521: my ($coursenum,$coursedomain,@which)=@_;
3522: my $coursehom=&homeserver($coursenum,$coursedomain);
3523: my $hashid=$coursenum.':'.$coursedomain;
1.425 albertel 3524: my ($result,$cached)=&is_cached(\%courseresdatacache,$hashid,'courseres');
1.417 albertel 3525: unless (defined($cached)) {
1.251 albertel 3526: my %dumpreply=&dump('resourcedata',$coursedomain,$coursenum);
1.417 albertel 3527: $result=\%dumpreply;
1.251 albertel 3528: my ($tmp) = keys(%dumpreply);
3529: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
1.425 albertel 3530: &do_cache(\%courseresdatacache,$hashid,$result,'courseres');
1.306 albertel 3531: } elsif ($tmp =~ /^(con_lost|no_such_host)/) {
3532: return $tmp;
1.416 albertel 3533: } elsif ($tmp =~ /^(error)/) {
1.417 albertel 3534: $result=undef;
1.425 albertel 3535: &do_cache(\%courseresdatacache,$hashid,$result,'courseres');
1.250 albertel 3536: }
3537: }
1.251 albertel 3538: foreach my $item (@which) {
1.417 albertel 3539: if (defined($result->{$item})) {
3540: return $result->{$item};
1.251 albertel 3541: }
1.250 albertel 3542: }
1.291 albertel 3543: return undef;
1.200 www 3544: }
3545:
1.379 matthew 3546: #
3547: # EXT resource caching routines
3548: #
3549:
3550: sub clear_EXT_cache_status {
1.383 albertel 3551: &delenv('cache.EXT.');
1.379 matthew 3552: }
3553:
3554: sub EXT_cache_status {
3555: my ($target_domain,$target_user) = @_;
1.383 albertel 3556: my $cachename = 'cache.EXT.'.$target_user.'.'.$target_domain;
1.389 www 3557: if (exists($ENV{$cachename}) && ($ENV{$cachename}+600) > time) {
1.379 matthew 3558: # We know already the user has no data
3559: return 1;
3560: } else {
3561: return 0;
3562: }
3563: }
3564:
3565: sub EXT_cache_set {
3566: my ($target_domain,$target_user) = @_;
1.383 albertel 3567: my $cachename = 'cache.EXT.'.$target_user.'.'.$target_domain;
1.379 matthew 3568: &appenv($cachename => time);
3569: }
3570:
1.28 www 3571: # --------------------------------------------------------- Value of a Variable
1.58 www 3572: sub EXT {
1.395 albertel 3573: my ($varname,$symbparm,$udom,$uname,$usection,$recurse)=@_;
1.218 albertel 3574:
1.68 www 3575: unless ($varname) { return ''; }
1.218 albertel 3576: #get real user name/domain, courseid and symb
3577: my $courseid;
1.359 albertel 3578: my $publicuser;
1.427 www 3579: if ($symbparm) {
3580: $symbparm=&get_symb_from_alias($symbparm);
3581: }
1.218 albertel 3582: if (!($uname && $udom)) {
1.360 albertel 3583: (my $cursymb,$courseid,$udom,$uname,$publicuser)=
1.378 matthew 3584: &Apache::lonxml::whichuser($symbparm);
1.218 albertel 3585: if (!$symbparm) { $symbparm=$cursymb; }
3586: } else {
3587: $courseid=$ENV{'request.course.id'};
3588: }
1.48 www 3589: my ($realm,$space,$qualifier,@therest)=split(/\./,$varname);
3590: my $rest;
1.320 albertel 3591: if (defined($therest[0])) {
1.48 www 3592: $rest=join('.',@therest);
3593: } else {
3594: $rest='';
3595: }
1.320 albertel 3596:
1.57 www 3597: my $qualifierrest=$qualifier;
3598: if ($rest) { $qualifierrest.='.'.$rest; }
3599: my $spacequalifierrest=$space;
3600: if ($qualifierrest) { $spacequalifierrest.='.'.$qualifierrest; }
1.28 www 3601: if ($realm eq 'user') {
1.48 www 3602: # --------------------------------------------------------------- user.resource
3603: if ($space eq 'resource') {
1.335 albertel 3604: if (defined($Apache::lonhomework::parsing_a_problem)) {
3605: return $Apache::lonhomework::history{$qualifierrest};
3606: } else {
1.359 albertel 3607: my %restored;
3608: if ($publicuser || $ENV{'request.state'} eq 'construct') {
3609: %restored=&tmprestore($symbparm,$courseid,$udom,$uname);
3610: } else {
3611: %restored=&restore($symbparm,$courseid,$udom,$uname);
3612: }
1.335 albertel 3613: return $restored{$qualifierrest};
3614: }
1.48 www 3615: # ----------------------------------------------------------------- user.access
3616: } elsif ($space eq 'access') {
1.218 albertel 3617: # FIXME - not supporting calls for a specific user
1.48 www 3618: return &allowed($qualifier,$rest);
3619: # ------------------------------------------ user.preferences, user.environment
3620: } elsif (($space eq 'preferences') || ($space eq 'environment')) {
1.218 albertel 3621: if (($uname eq $ENV{'user.name'}) &&
3622: ($udom eq $ENV{'user.domain'})) {
3623: return $ENV{join('.',('environment',$qualifierrest))};
3624: } else {
1.359 albertel 3625: my %returnhash;
3626: if (!$publicuser) {
3627: %returnhash=&userenvironment($udom,$uname,
3628: $qualifierrest);
3629: }
1.218 albertel 3630: return $returnhash{$qualifierrest};
3631: }
1.48 www 3632: # ----------------------------------------------------------------- user.course
3633: } elsif ($space eq 'course') {
1.218 albertel 3634: # FIXME - not supporting calls for a specific user
1.48 www 3635: return $ENV{join('.',('request.course',$qualifier))};
3636: # ------------------------------------------------------------------- user.role
3637: } elsif ($space eq 'role') {
1.218 albertel 3638: # FIXME - not supporting calls for a specific user
1.48 www 3639: my ($role,$where)=split(/\./,$ENV{'request.role'});
3640: if ($qualifier eq 'value') {
3641: return $role;
3642: } elsif ($qualifier eq 'extent') {
3643: return $where;
3644: }
3645: # ----------------------------------------------------------------- user.domain
3646: } elsif ($space eq 'domain') {
1.218 albertel 3647: return $udom;
1.48 www 3648: # ------------------------------------------------------------------- user.name
3649: } elsif ($space eq 'name') {
1.218 albertel 3650: return $uname;
1.48 www 3651: # ---------------------------------------------------- Any other user namespace
1.29 www 3652: } else {
1.359 albertel 3653: my %reply;
3654: if (!$publicuser) {
3655: %reply=&get($space,[$qualifierrest],$udom,$uname);
3656: }
3657: return $reply{$qualifierrest};
1.48 www 3658: }
1.236 www 3659: } elsif ($realm eq 'query') {
3660: # ---------------------------------------------- pull stuff out of query string
1.384 albertel 3661: &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},
3662: [$spacequalifierrest]);
1.376 albertel 3663: return $ENV{'form.'.$spacequalifierrest};
1.236 www 3664: } elsif ($realm eq 'request') {
1.48 www 3665: # ------------------------------------------------------------- request.browser
3666: if ($space eq 'browser') {
1.430 www 3667: if ($qualifier eq 'textremote') {
3668: if (&mt('textual_remote_display') eq 'on') {
3669: return 1;
3670: } else {
3671: return 0;
3672: }
3673: } else {
3674: return $ENV{'browser.'.$qualifier};
3675: }
1.57 www 3676: # ------------------------------------------------------------ request.filename
3677: } else {
3678: return $ENV{'request.'.$spacequalifierrest};
1.29 www 3679: }
1.28 www 3680: } elsif ($realm eq 'course') {
1.48 www 3681: # ---------------------------------------------------------- course.description
1.218 albertel 3682: return $ENV{'course.'.$courseid.'.'.$spacequalifierrest};
1.57 www 3683: } elsif ($realm eq 'resource') {
1.165 www 3684:
1.395 albertel 3685: my $section;
1.359 albertel 3686: if (defined($courseid) && $courseid eq $ENV{'request.course.id'}) {
1.165 www 3687:
1.218 albertel 3688: #print '<br>'.$space.' - '.$qualifier.' - '.$spacequalifierrest;
1.165 www 3689:
1.60 www 3690: # ----------------------------------------------------- Cascading lookup scheme
1.218 albertel 3691: if (!$symbparm) { $symbparm=&symbread(); }
3692: my $symbp=$symbparm;
1.409 www 3693: my $mapp=(&decode_symb($symbp))[0];
1.218 albertel 3694:
3695: my $symbparm=$symbp.'.'.$spacequalifierrest;
3696: my $mapparm=$mapp.'___(all).'.$spacequalifierrest;
3697:
3698: if (($ENV{'user.name'} eq $uname) &&
3699: ($ENV{'user.domain'} eq $udom)) {
1.255 albertel 3700: $section=$ENV{'request.course.sec'};
1.218 albertel 3701: } else {
1.377 matthew 3702: if (! defined($usection)) {
3703: $section=&usection($udom,$uname,$courseid);
3704: } else {
3705: $section = $usection;
3706: }
1.218 albertel 3707: }
3708:
3709: my $seclevel=$courseid.'.['.$section.'].'.$spacequalifierrest;
3710: my $seclevelr=$courseid.'.['.$section.'].'.$symbparm;
3711: my $seclevelm=$courseid.'.['.$section.'].'.$mapparm;
3712:
3713: my $courselevel=$courseid.'.'.$spacequalifierrest;
3714: my $courselevelr=$courseid.'.'.$symbparm;
3715: my $courselevelm=$courseid.'.'.$mapparm;
1.69 www 3716:
1.60 www 3717: # ----------------------------------------------------------- first, check user
1.379 matthew 3718: #most student don\'t have any data set, check if there is some data
3719: if (! &EXT_cache_status($udom,$uname)) {
1.420 albertel 3720: my $hashid="$udom:$uname";
1.425 albertel 3721: my ($result,$cached)=&is_cached(\%userresdatacache,$hashid,
3722: 'userres');
1.454 albertel 3723: if (!defined($cached)) {
3724: my %resourcedata=&dump('resourcedata',$udom,$uname);
1.420 albertel 3725: $result=\%resourcedata;
1.425 albertel 3726: &do_cache(\%userresdatacache,$hashid,$result,'userres');
1.420 albertel 3727: }
3728: my ($tmp)=keys(%$result);
1.308 albertel 3729: if (($tmp!~/^error\:/) && ($tmp!~/^con_lost/)) {
1.420 albertel 3730: if ($$result{$courselevelr}) {
3731: return $$result{$courselevelr}; }
3732: if ($$result{$courselevelm}) {
3733: return $$result{$courselevelm}; }
3734: if ($$result{$courselevel}) {
3735: return $$result{$courselevel}; }
1.308 albertel 3736: } else {
1.459 albertel 3737: #error 2 occurs when the .db doesn't exist
3738: if ($tmp!~/error: 2 /) {
1.308 albertel 3739: &logthis("<font color=blue>WARNING:".
3740: " Trying to get resource data for ".
3741: $uname." at ".$udom.": ".
3742: $tmp."</font>");
1.459 albertel 3743: } elsif ($tmp=~/error: 2 /) {
1.379 matthew 3744: &EXT_cache_set($udom,$uname);
1.308 albertel 3745: } elsif ($tmp =~ /^(con_lost|no_such_host)/) {
3746: return $tmp;
3747: }
1.218 albertel 3748: }
3749: }
1.95 www 3750:
1.60 www 3751: # -------------------------------------------------------- second, check course
1.96 www 3752:
1.218 albertel 3753: my $coursereply=&courseresdata($ENV{'course.'.$courseid.'.num'},
3754: $ENV{'course.'.$courseid.'.domain'},
3755: ($seclevelr,$seclevelm,$seclevel,
3756: $courselevelr,$courselevelm,
3757: $courselevel));
1.287 albertel 3758: if (defined($coursereply)) { return $coursereply; }
1.200 www 3759:
1.60 www 3760: # ------------------------------------------------------ third, check map parms
1.218 albertel 3761: my %parmhash=();
3762: my $thisparm='';
3763: if (tie(%parmhash,'GDBM_File',
3764: $ENV{'request.course.fn'}.'_parms.db',
1.256 albertel 3765: &GDBM_READER(),0640)) {
1.218 albertel 3766: $thisparm=$parmhash{$symbparm};
3767: untie(%parmhash);
3768: }
3769: if ($thisparm) { return $thisparm; }
3770: }
1.60 www 3771: # --------------------------------------------- last, look in resource metadata
1.71 www 3772:
1.218 albertel 3773: $spacequalifierrest=~s/\./\_/;
1.282 albertel 3774: my $filename;
3775: if (!$symbparm) { $symbparm=&symbread(); }
3776: if ($symbparm) {
1.409 www 3777: $filename=(&decode_symb($symbparm))[2];
1.282 albertel 3778: } else {
3779: $filename=$ENV{'request.filename'};
3780: }
3781: my $metadata=&metadata($filename,$spacequalifierrest);
1.288 albertel 3782: if (defined($metadata)) { return $metadata; }
1.282 albertel 3783: $metadata=&metadata($filename,'parameter_'.$spacequalifierrest);
1.288 albertel 3784: if (defined($metadata)) { return $metadata; }
1.142 www 3785:
1.145 www 3786: # ------------------------------------------------------------------ Cascade up
1.218 albertel 3787: unless ($space eq '0') {
1.336 albertel 3788: my @parts=split(/_/,$space);
3789: my $id=pop(@parts);
3790: my $part=join('_',@parts);
3791: if ($part eq '') { $part='0'; }
3792: my $partgeneral=&EXT('resource.'.$part.'.'.$qualifierrest,
1.395 albertel 3793: $symbparm,$udom,$uname,$section,1);
1.337 albertel 3794: if (defined($partgeneral)) { return $partgeneral; }
1.218 albertel 3795: }
1.395 albertel 3796: if ($recurse) { return undef; }
3797: my $pack_def=&packages_tab_default($filename,$varname);
3798: if (defined($pack_def)) { return $pack_def; }
1.71 www 3799:
1.48 www 3800: # ---------------------------------------------------- Any other user namespace
3801: } elsif ($realm eq 'environment') {
3802: # ----------------------------------------------------------------- environment
1.219 albertel 3803: if (($uname eq $ENV{'user.name'})&&($udom eq $ENV{'user.domain'})) {
3804: return $ENV{'environment.'.$spacequalifierrest};
3805: } else {
3806: my %returnhash=&userenvironment($udom,$uname,
3807: $spacequalifierrest);
3808: return $returnhash{$spacequalifierrest};
3809: }
1.28 www 3810: } elsif ($realm eq 'system') {
1.48 www 3811: # ----------------------------------------------------------------- system.time
3812: if ($space eq 'time') {
3813: return time;
3814: }
1.28 www 3815: }
1.48 www 3816: return '';
1.61 www 3817: }
3818:
1.395 albertel 3819: sub packages_tab_default {
3820: my ($uri,$varname)=@_;
3821: my (undef,$part,$name)=split(/\./,$varname);
3822: my $packages=&metadata($uri,'packages');
3823: foreach my $package (split(/,/,$packages)) {
3824: my ($pack_type,$pack_part)=split(/_/,$package,2);
1.468 ! albertel 3825: if (defined($packagetab{"$pack_type&$name&default"})) {
! 3826: return $packagetab{"$pack_type&$name&default"};
! 3827: }
! 3828: if (defined($packagetab{$pack_type."_".$pack_part."&$name&default"})) {
! 3829: return $packagetab{$pack_type."_".$pack_part."&$name&default"};
1.395 albertel 3830: }
3831: }
3832: return undef;
3833: }
3834:
1.334 albertel 3835: sub add_prefix_and_part {
3836: my ($prefix,$part)=@_;
3837: my $keyroot;
3838: if (defined($prefix) && $prefix !~ /^__/) {
3839: # prefix that has a part already
3840: $keyroot=$prefix;
3841: } elsif (defined($prefix)) {
3842: # prefix that is missing a part
3843: if (defined($part)) { $keyroot='_'.$part.substr($prefix,1); }
3844: } else {
3845: # no prefix at all
3846: if (defined($part)) { $keyroot='_'.$part; }
3847: }
3848: return $keyroot;
3849: }
3850:
1.71 www 3851: # ---------------------------------------------------------------- Get metadata
3852:
3853: sub metadata {
1.176 www 3854: my ($uri,$what,$liburi,$prefix,$depthcount)=@_;
1.71 www 3855: $uri=&declutter($uri);
1.288 albertel 3856: # if it is a non metadata possible uri return quickly
1.293 matthew 3857: if (($uri eq '') || (($uri =~ m|^/*adm/|) && ($uri !~ m|^adm/includes|)) ||
1.423 albertel 3858: ($uri =~ m|/$|) || ($uri =~ m|/.meta$|) || ($uri =~ /^~/) ||
3859: ($uri =~ m|home/[^/]+/public_html/|)) {
1.468 ! albertel 3860: return undef;
1.288 albertel 3861: }
1.73 www 3862: my $filename=$uri;
3863: $uri=~s/\.meta$//;
1.172 www 3864: #
3865: # Is the metadata already cached?
1.177 www 3866: # Look at timestamp of caching
1.172 www 3867: # Everything is cached by the main uri, libraries are never directly cached
3868: #
1.428 albertel 3869: if (!defined($liburi)) {
3870: my ($result,$cached)=&is_cached(\%metacache,$uri,'meta');
3871: if (defined($cached)) { return $result->{':'.$what}; }
3872: }
3873: {
1.172 www 3874: #
3875: # Is this a recursive call for a library?
3876: #
1.453 albertel 3877: if (! exists($metacache{$uri})) {
3878: $metacache{$uri}={};
3879: }
1.171 www 3880: if ($liburi) {
3881: $liburi=&declutter($liburi);
3882: $filename=$liburi;
1.401 bowersj2 3883: } else {
1.428 albertel 3884: &devalidate_cache(\%metacache,$uri,'meta');
1.401 bowersj2 3885: }
1.140 www 3886: my %metathesekeys=();
1.73 www 3887: unless ($filename=~/\.meta$/) { $filename.='.meta'; }
1.335 albertel 3888: my $metastring=&getfile(&filelocation('',&clutter($filename)));
1.208 albertel 3889: my $parser=HTML::LCParser->new(\$metastring);
1.71 www 3890: my $token;
1.140 www 3891: undef %metathesekeys;
1.71 www 3892: while ($token=$parser->get_token) {
1.339 albertel 3893: if ($token->[0] eq 'S') {
3894: if (defined($token->[2]->{'package'})) {
1.172 www 3895: #
3896: # This is a package - get package info
3897: #
1.339 albertel 3898: my $package=$token->[2]->{'package'};
3899: my $keyroot=&add_prefix_and_part($prefix,$token->[2]->{'part'});
3900: if (defined($token->[2]->{'id'})) {
3901: $keyroot.='_'.$token->[2]->{'id'};
3902: }
1.453 albertel 3903: if ($metacache{$uri}->{':packages'}) {
3904: $metacache{$uri}->{':packages'}.=','.$package.$keyroot;
1.339 albertel 3905: } else {
1.453 albertel 3906: $metacache{$uri}->{':packages'}=$package.$keyroot;
1.339 albertel 3907: }
3908: foreach (keys %packagetab) {
1.432 albertel 3909: my $part=$keyroot;
3910: $part=~s/^\_//;
3911: if ($_=~/^\Q$package\E\&/ ||
3912: $_=~/^\Q$package\E_0\&/) {
1.339 albertel 3913: my ($pack,$name,$subp)=split(/\&/,$_);
1.395 albertel 3914: # ignore package.tab specified default values
3915: # here &package_tab_default() will fetch those
3916: if ($subp eq 'default') { next; }
1.339 albertel 3917: my $value=$packagetab{$_};
1.432 albertel 3918: my $unikey;
3919: if ($pack =~ /_0$/) {
3920: $unikey='parameter_0_'.$name;
3921: $part=0;
3922: } else {
3923: $unikey='parameter'.$keyroot.'_'.$name;
3924: }
1.339 albertel 3925: if ($subp eq 'display') {
3926: $value.=' [Part: '.$part.']';
3927: }
1.453 albertel 3928: $metacache{$uri}->{':'.$unikey.'.part'}=$part;
1.395 albertel 3929: $metathesekeys{$unikey}=1;
1.453 albertel 3930: unless (defined($metacache{$uri}->{':'.$unikey.'.'.$subp})) {
3931: $metacache{$uri}->{':'.$unikey.'.'.$subp}=$value;
1.339 albertel 3932: }
1.453 albertel 3933: if (defined($metacache{$uri}->{':'.$unikey.'.default'})) {
3934: $metacache{$uri}->{':'.$unikey}=
3935: $metacache{$uri}->{':'.$unikey.'.default'};
1.356 albertel 3936: }
1.339 albertel 3937: }
3938: }
3939: } else {
1.172 www 3940: #
3941: # This is not a package - some other kind of start tag
1.339 albertel 3942: #
3943: my $entry=$token->[1];
3944: my $unikey;
3945: if ($entry eq 'import') {
3946: $unikey='';
3947: } else {
3948: $unikey=$entry;
3949: }
3950: $unikey.=&add_prefix_and_part($prefix,$token->[2]->{'part'});
3951:
3952: if (defined($token->[2]->{'id'})) {
3953: $unikey.='_'.$token->[2]->{'id'};
3954: }
1.175 www 3955:
1.339 albertel 3956: if ($entry eq 'import') {
1.175 www 3957: #
3958: # Importing a library here
1.339 albertel 3959: #
3960: if ($depthcount<20) {
3961: my $location=$parser->get_text('/import');
3962: my $dir=$filename;
3963: $dir=~s|[^/]*$||;
3964: $location=&filelocation($dir,$location);
3965: foreach (sort(split(/\,/,&metadata($uri,'keys',
3966: $location,$unikey,
3967: $depthcount+1)))) {
1.453 albertel 3968: $metacache{$uri}->{':'.$_}=$metacache{$uri}->{':'.$_};
1.339 albertel 3969: $metathesekeys{$_}=1;
3970: }
3971: }
3972: } else {
3973:
3974: if (defined($token->[2]->{'name'})) {
3975: $unikey.='_'.$token->[2]->{'name'};
3976: }
3977: $metathesekeys{$unikey}=1;
3978: foreach (@{$token->[3]}) {
1.453 albertel 3979: $metacache{$uri}->{':'.$unikey.'.'.$_}=$token->[2]->{$_};
1.339 albertel 3980: }
3981: my $internaltext=&HTML::Entities::decode($parser->get_text('/'.$entry));
1.453 albertel 3982: my $default=$metacache{$uri}->{':'.$unikey.'.default'};
1.339 albertel 3983: if ( $internaltext =~ /^\s*$/ && $default !~ /^\s*$/) {
3984: # only ws inside the tag, and not in default, so use default
3985: # as value
1.453 albertel 3986: $metacache{$uri}->{':'.$unikey}=$default;
1.339 albertel 3987: } else {
1.321 albertel 3988: # either something interesting inside the tag or default
3989: # uninteresting
1.453 albertel 3990: $metacache{$uri}->{':'.$unikey}=$internaltext;
1.339 albertel 3991: }
1.172 www 3992: # end of not-a-package not-a-library import
1.339 albertel 3993: }
1.172 www 3994: # end of not-a-package start tag
1.339 albertel 3995: }
1.172 www 3996: # the next is the end of "start tag"
1.339 albertel 3997: }
3998: }
1.338 www 3999: # are there custom rights to evaluate
1.453 albertel 4000: if ($metacache{$uri}->{':copyright'} eq 'custom') {
1.339 albertel 4001:
1.338 www 4002: #
4003: # Importing a rights file here
1.339 albertel 4004: #
4005: unless ($depthcount) {
1.453 albertel 4006: my $location=$metacache{$uri}->{':customdistributionfile'};
1.339 albertel 4007: my $dir=$filename;
4008: $dir=~s|[^/]*$||;
4009: $location=&filelocation($dir,$location);
4010: foreach (sort(split(/\,/,&metadata($uri,'keys',
4011: $location,'_rights',
4012: $depthcount+1)))) {
1.453 albertel 4013: $metacache{$uri}->{':'.$_}=$metacache{$uri}->{':'.$_};
1.339 albertel 4014: $metathesekeys{$_}=1;
4015: }
4016: }
4017: }
1.453 albertel 4018: $metacache{$uri}->{':keys'}=join(',',keys %metathesekeys);
4019: &metadata_generate_part0(\%metathesekeys,$metacache{$uri},$uri);
4020: $metacache{$uri}->{':allpossiblekeys'}=join(',',keys %metathesekeys);
4021: &do_cache(\%metacache,$uri,$metacache{$uri},'meta');
1.177 www 4022: # this is the end of "was not already recently cached
1.71 www 4023: }
1.428 albertel 4024: return $metacache{$uri}->{':'.$what};
1.261 albertel 4025: }
4026:
4027: sub metadata_generate_part0 {
4028: my ($metadata,$metacache,$uri) = @_;
4029: my %allnames;
4030: foreach my $metakey (sort keys %$metadata) {
4031: if ($metakey=~/^parameter\_(.*)/) {
1.428 albertel 4032: my $part=$$metacache{':'.$metakey.'.part'};
4033: my $name=$$metacache{':'.$metakey.'.name'};
1.356 albertel 4034: if (! exists($$metadata{'parameter_0_'.$name.'.name'})) {
1.261 albertel 4035: $allnames{$name}=$part;
4036: }
4037: }
4038: }
4039: foreach my $name (keys(%allnames)) {
4040: $$metadata{"parameter_0_$name"}=1;
1.428 albertel 4041: my $key=":parameter_0_$name";
1.261 albertel 4042: $$metacache{"$key.part"}='0';
4043: $$metacache{"$key.name"}=$name;
1.428 albertel 4044: $$metacache{"$key.type"}=$$metacache{':parameter_'.
1.261 albertel 4045: $allnames{$name}.'_'.$name.
4046: '.type'};
1.428 albertel 4047: my $olddis=$$metacache{':parameter_'.$allnames{$name}.'_'.$name.
1.261 albertel 4048: '.display'};
4049: my $expr='\\[Part: '.$allnames{$name}.'\\]';
4050: $olddis=~s/$expr/\[Part: 0\]/;
4051: $$metacache{"$key.display"}=$olddis;
4052: }
1.71 www 4053: }
4054:
1.301 www 4055: # ------------------------------------------------- Get the title of a resource
4056:
4057: sub gettitle {
4058: my $urlsymb=shift;
4059: my $symb=&symbread($urlsymb);
4060: unless ($symb) {
4061: unless ($urlsymb) { $urlsymb=$ENV{'request.filename'}; }
4062: return &metadata($urlsymb,'title');
4063: }
1.425 albertel 4064: my ($result,$cached)=&is_cached(\%titlecache,$symb,'title',600);
1.419 albertel 4065: if (defined($cached)) { return $result; }
1.409 www 4066: my ($map,$resid,$url)=&decode_symb($symb);
1.301 www 4067: my $title='';
4068: my %bighash;
4069: if (tie(%bighash,'GDBM_File',$ENV{'request.course.fn'}.'.db',
4070: &GDBM_READER(),0640)) {
4071: my $mapid=$bighash{'map_pc_'.&clutter($map)};
4072: $title=$bighash{'title_'.$mapid.'.'.$resid};
4073: untie %bighash;
4074: }
1.363 www 4075: $title=~s/\&colon\;/\:/gs;
1.301 www 4076: if ($title) {
1.425 albertel 4077: return &do_cache(\%titlecache,$symb,$title,'title');
1.301 www 4078: } else {
4079: return &metadata($urlsymb,'title');
4080: }
4081: }
4082:
1.31 www 4083: # ------------------------------------------------- Update symbolic store links
4084:
4085: sub symblist {
4086: my ($mapname,%newhash)=@_;
1.438 www 4087: $mapname=&deversion(&declutter($mapname));
1.31 www 4088: my %hash;
4089: if (($ENV{'request.course.fn'}) && (%newhash)) {
4090: if (tie(%hash,'GDBM_File',$ENV{'request.course.fn'}.'_symb.db',
1.256 albertel 4091: &GDBM_WRCREAT(),0640)) {
1.191 harris41 4092: foreach (keys %newhash) {
1.438 www 4093: $hash{declutter($_)}=$mapname.'___'.&deversion($newhash{$_});
1.191 harris41 4094: }
1.31 www 4095: if (untie(%hash)) {
4096: return 'ok';
4097: }
4098: }
4099: }
4100: return 'error';
1.212 www 4101: }
4102:
4103: # --------------------------------------------------------------- Verify a symb
4104:
4105: sub symbverify {
4106: my ($symb,$thisfn)=@_;
1.439 www 4107: $thisfn=&declutter($thisfn);
1.215 www 4108: # direct jump to resource in page or to a sequence - will construct own symbs
4109: if ($thisfn=~/\.(page|sequence)$/) { return 1; }
4110: # check URL part
1.409 www 4111: my ($map,$resid,$url)=&decode_symb($symb);
1.439 www 4112:
1.431 www 4113: unless ($url eq $thisfn) { return 0; }
1.213 www 4114:
1.216 www 4115: $symb=&symbclean($symb);
1.439 www 4116: $thisfn=&deversion($thisfn);
1.213 www 4117:
4118: my %bighash;
4119: my $okay=0;
1.431 www 4120:
1.213 www 4121: if (tie(%bighash,'GDBM_File',$ENV{'request.course.fn'}.'.db',
1.256 albertel 4122: &GDBM_READER(),0640)) {
1.280 www 4123: my $ids=$bighash{'ids_'.&clutter($thisfn)};
1.216 www 4124: unless ($ids) {
4125: $ids=$bighash{'ids_/'.$thisfn};
4126: }
4127: if ($ids) {
4128: # ------------------------------------------------------------------- Has ID(s)
4129: foreach (split(/\,/,$ids)) {
4130: my ($mapid,$resid)=split(/\./,$_);
4131: if (
4132: &symbclean(&declutter($bighash{'map_id_'.$mapid}).'___'.$resid.'___'.$thisfn)
4133: eq $symb) {
4134: $okay=1;
4135: }
4136: }
4137: }
1.213 www 4138: untie(%bighash);
4139: }
4140: return $okay;
1.31 www 4141: }
4142:
1.210 www 4143: # --------------------------------------------------------------- Clean-up symb
4144:
4145: sub symbclean {
4146: my $symb=shift;
1.213 www 4147:
1.210 www 4148: # remove version from map
4149: $symb=~s/\.(\d+)\.(\w+)\_\_\_/\.$2\_\_\_/;
1.215 www 4150:
1.210 www 4151: # remove version from URL
4152: $symb=~s/\.(\d+)\.(\w+)$/\.$2/;
1.213 www 4153:
1.210 www 4154: return $symb;
1.409 www 4155: }
4156:
4157: # ---------------------------------------------- Split symb to find map and url
1.429 albertel 4158:
4159: sub encode_symb {
4160: my ($map,$resid,$url)=@_;
4161: return &symbclean(&declutter($map).'___'.$resid.'___'.&declutter($url));
4162: }
1.409 www 4163:
4164: sub decode_symb {
1.413 www 4165: my ($map,$resid,$url)=split(/\_\_\_/,shift);
4166: return (&fixversion($map),$resid,&fixversion($url));
4167: }
4168:
4169: sub fixversion {
4170: my $fn=shift;
4171: if ($fn=~/^(adm|uploaded|public)/) { return $fn; }
1.435 www 4172: my %bighash;
4173: my $uri=&clutter($fn);
1.440 www 4174: my $key=$ENV{'request.course.id'}.'_'.$uri;
4175: # is this cached?
4176: my ($result,$cached)=&is_cached(\%courseresversioncache,$key,
4177: 'courseresversion',600);
4178: if (defined($cached)) { return $result; }
4179: # unfortunately not cached, or expired
1.435 www 4180: if (tie(%bighash,'GDBM_File',$ENV{'request.course.fn'}.'.db',
1.440 www 4181: &GDBM_READER(),0640)) {
4182: if ($bighash{'version_'.$uri}) {
4183: my $version=$bighash{'version_'.$uri};
1.444 www 4184: unless (($version eq 'mostrecent') ||
4185: ($version==&getversion($uri))) {
1.440 www 4186: $uri=~s/\.(\w+)$/\.$version\.$1/;
4187: }
4188: }
4189: untie %bighash;
1.413 www 4190: }
1.440 www 4191: return &do_cache
4192: (\%courseresversioncache,$key,&declutter($uri),'courseresversion');
1.438 www 4193: }
4194:
4195: sub deversion {
4196: my $url=shift;
4197: $url=~s/\.\d+\.(\w+)$/\.$1/;
4198: return $url;
1.210 www 4199: }
4200:
1.31 www 4201: # ------------------------------------------------------ Return symb list entry
4202:
4203: sub symbread {
1.249 www 4204: my ($thisfn,$donotrecurse)=@_;
1.242 www 4205: # no filename provided? try from environment
1.44 www 4206: unless ($thisfn) {
1.210 www 4207: if ($ENV{'request.symb'}) { return &symbclean($ENV{'request.symb'}); }
1.44 www 4208: $thisfn=$ENV{'request.filename'};
4209: }
1.242 www 4210: # is that filename actually a symb? Verify, clean, and return
4211: if ($thisfn=~/\_\_\_\d+\_\_\_(.*)$/) {
4212: if (&symbverify($thisfn,$1)) { return &symbclean($thisfn); }
4213: }
1.44 www 4214: $thisfn=declutter($thisfn);
1.31 www 4215: my %hash;
1.37 www 4216: my %bighash;
4217: my $syval='';
1.45 www 4218: if (($ENV{'request.course.fn'}) && ($thisfn)) {
1.31 www 4219: if (tie(%hash,'GDBM_File',$ENV{'request.course.fn'}.'_symb.db',
1.256 albertel 4220: &GDBM_READER(),0640)) {
1.31 www 4221: $syval=$hash{$thisfn};
1.37 www 4222: untie(%hash);
4223: }
4224: # ---------------------------------------------------------- There was an entry
4225: if ($syval) {
4226: unless ($syval=~/\_\d+$/) {
4227: unless ($ENV{'form.request.prefix'}=~/\.(\d+)\_$/) {
1.44 www 4228: &appenv('request.ambiguous' => $thisfn);
1.37 www 4229: return '';
4230: }
4231: $syval.=$1;
4232: }
4233: } else {
4234: # ------------------------------------------------------- Was not in symb table
4235: if (tie(%bighash,'GDBM_File',$ENV{'request.course.fn'}.'.db',
1.256 albertel 4236: &GDBM_READER(),0640)) {
1.37 www 4237: # ---------------------------------------------- Get ID(s) for current resource
1.280 www 4238: my $ids=$bighash{'ids_'.&clutter($thisfn)};
1.65 www 4239: unless ($ids) {
4240: $ids=$bighash{'ids_/'.$thisfn};
1.242 www 4241: }
4242: unless ($ids) {
4243: # alias?
4244: $ids=$bighash{'mapalias_'.$thisfn};
1.65 www 4245: }
1.37 www 4246: if ($ids) {
4247: # ------------------------------------------------------------------- Has ID(s)
4248: my @possibilities=split(/\,/,$ids);
1.39 www 4249: if ($#possibilities==0) {
4250: # ----------------------------------------------- There is only one possibility
1.37 www 4251: my ($mapid,$resid)=split(/\./,$ids);
4252: $syval=declutter($bighash{'map_id_'.$mapid}).'___'.$resid;
1.249 www 4253: } elsif (!$donotrecurse) {
1.39 www 4254: # ------------------------------------------ There is more than one possibility
4255: my $realpossible=0;
1.191 harris41 4256: foreach (@possibilities) {
1.39 www 4257: my $file=$bighash{'src_'.$_};
4258: if (&allowed('bre',$file)) {
4259: my ($mapid,$resid)=split(/\./,$_);
4260: if ($bighash{'map_type_'.$mapid} ne 'page') {
4261: $realpossible++;
4262: $syval=declutter($bighash{'map_id_'.$mapid}).
4263: '___'.$resid;
4264: }
4265: }
1.191 harris41 4266: }
1.39 www 4267: if ($realpossible!=1) { $syval=''; }
1.249 www 4268: } else {
4269: $syval='';
1.37 www 4270: }
4271: }
4272: untie(%bighash)
4273: }
1.31 www 4274: }
1.62 www 4275: if ($syval) {
1.210 www 4276: return &symbclean($syval.'___'.$thisfn);
1.62 www 4277: }
1.31 www 4278: }
1.44 www 4279: &appenv('request.ambiguous' => $thisfn);
1.31 www 4280: return '';
4281: }
4282:
4283: # ---------------------------------------------------------- Return random seed
4284:
1.32 www 4285: sub numval {
4286: my $txt=shift;
4287: $txt=~tr/A-J/0-9/;
4288: $txt=~tr/a-j/0-9/;
4289: $txt=~tr/K-T/0-9/;
4290: $txt=~tr/k-t/0-9/;
4291: $txt=~tr/U-Z/0-5/;
4292: $txt=~tr/u-z/0-5/;
4293: $txt=~s/\D//g;
4294: return int($txt);
1.368 albertel 4295: }
4296:
4297: sub latest_rnd_algorithm_id {
1.443 albertel 4298: return '64bit2';
1.366 albertel 4299: }
1.32 www 4300:
1.31 www 4301: sub rndseed {
1.155 albertel 4302: my ($symb,$courseid,$domain,$username)=@_;
1.366 albertel 4303:
4304: my ($wsymb,$wcourseid,$wdomain,$wusername)=&Apache::lonxml::whichuser();
1.155 albertel 4305: if (!$symb) {
1.366 albertel 4306: unless ($symb=$wsymb) { return time; }
4307: }
4308: if (!$courseid) { $courseid=$wcourseid; }
4309: if (!$domain) { $domain=$wdomain; }
4310: if (!$username) { $username=$wusername }
4311: my $which=$ENV{"course.$courseid.rndseed"};
4312: my $CODE=$ENV{'scantron.CODE'};
4313: if (defined($CODE)) {
4314: &rndseed_CODE_64bit($symb,$courseid,$domain,$username);
1.443 albertel 4315: } elsif ($which eq '64bit2') {
4316: return &rndseed_64bit2($symb,$courseid,$domain,$username);
1.366 albertel 4317: } elsif ($which eq '64bit') {
4318: return &rndseed_64bit($symb,$courseid,$domain,$username);
4319: }
4320: return &rndseed_32bit($symb,$courseid,$domain,$username);
4321: }
4322:
4323: sub rndseed_32bit {
4324: my ($symb,$courseid,$domain,$username)=@_;
4325: {
4326: use integer;
4327: my $symbchck=unpack("%32C*",$symb) << 27;
4328: my $symbseed=numval($symb) << 22;
4329: my $namechck=unpack("%32C*",$username) << 17;
4330: my $nameseed=numval($username) << 12;
4331: my $domainseed=unpack("%32C*",$domain) << 7;
4332: my $courseseed=unpack("%32C*",$courseid);
4333: my $num=$symbseed+$nameseed+$domainseed+$courseseed+$namechck+$symbchck;
4334: #&Apache::lonxml::debug("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
4335: #&Apache::lonxml::debug("rndseed :$num:$symb");
4336: return $num;
4337: }
4338: }
4339:
4340: sub rndseed_64bit {
4341: my ($symb,$courseid,$domain,$username)=@_;
4342: {
4343: use integer;
4344: my $symbchck=unpack("%32S*",$symb) << 21;
4345: my $symbseed=numval($symb) << 10;
4346: my $namechck=unpack("%32S*",$username);
4347:
4348: my $nameseed=numval($username) << 21;
4349: my $domainseed=unpack("%32S*",$domain) << 10;
4350: my $courseseed=unpack("%32S*",$courseid);
4351:
4352: my $num1=$symbchck+$symbseed+$namechck;
4353: my $num2=$nameseed+$domainseed+$courseseed;
4354: #&Apache::lonxml::debug("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
4355: #&Apache::lonxml::debug("rndseed :$num:$symb");
4356: return "$num1,$num2";
1.155 albertel 4357: }
1.366 albertel 4358: }
4359:
1.443 albertel 4360: sub rndseed_64bit2 {
4361: my ($symb,$courseid,$domain,$username)=@_;
4362: {
4363: use integer;
4364: # strings need to be an even # of cahracters long, it it is odd the
4365: # last characters gets thrown away
4366: my $symbchck=unpack("%32S*",$symb.' ') << 21;
4367: my $symbseed=numval($symb) << 10;
4368: my $namechck=unpack("%32S*",$username.' ');
4369:
4370: my $nameseed=numval($username) << 21;
4371: my $domainseed=unpack("%32S*",$domain.' ') << 10;
4372: my $courseseed=unpack("%32S*",$courseid.' ');
4373:
4374: my $num1=$symbchck+$symbseed+$namechck;
4375: my $num2=$nameseed+$domainseed+$courseseed;
4376: #&Apache::lonxml::debug("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
4377: #&Apache::lonxml::debug("rndseed :$num:$symb");
4378: return "$num1,$num2";
4379: }
4380: }
4381:
1.366 albertel 4382: sub rndseed_CODE_64bit {
4383: my ($symb,$courseid,$domain,$username)=@_;
1.155 albertel 4384: {
1.366 albertel 4385: use integer;
1.443 albertel 4386: my $symbchck=unpack("%32S*",$symb.' ') << 16;
1.366 albertel 4387: my $symbseed=numval($symb);
4388: my $CODEseed=numval($ENV{'scantron.CODE'}) << 16;
1.443 albertel 4389: my $courseseed=unpack("%32S*",$courseid.' ');
1.366 albertel 4390: my $num1=$symbseed+$CODEseed;
4391: my $num2=$courseseed+$symbchck;
4392: #&Apache::lonxml::debug("$symbseed:$CODEseed|$courseseed:$symbchck");
4393: #&Apache::lonxml::debug("rndseed :$num1:$num2:$symb");
4394: return "$num1,$num2";
4395: }
4396: }
4397:
4398: sub setup_random_from_rndseed {
4399: my ($rndseed)=@_;
4400: if ($rndseed =~/,/) {
4401: my ($num1,$num2)=split(/,/,$rndseed);
4402: &Math::Random::random_set_seed(abs($num1),abs($num2));
4403: } else {
4404: &Math::Random::random_set_seed_from_phrase($rndseed);
1.98 albertel 4405: }
1.36 albertel 4406: }
4407:
1.76 www 4408: sub ireceipt {
4409: my ($funame,$fudom,$fucourseid,$fusymb)=@_;
4410: my $cuname=unpack("%32C*",$funame);
4411: my $cudom=unpack("%32C*",$fudom);
4412: my $cucourseid=unpack("%32C*",$fucourseid);
4413: my $cusymb=unpack("%32C*",$fusymb);
1.77 www 4414: my $cunique=unpack("%32C*",$perlvar{'lonReceipt'});
1.76 www 4415: return unpack("%32C*",$perlvar{'lonHostID'}).'-'.
4416: ($cunique%$cuname+
4417: $cunique%$cudom+
4418: $cusymb%$cuname+
4419: $cusymb%$cudom+
4420: $cucourseid%$cuname+
4421: $cucourseid%$cudom);
4422: }
4423:
4424: sub receipt {
1.260 ng 4425: my ($symb,$courseid,$domain,$name) = &Apache::lonxml::whichuser();
4426: return &ireceipt($name,$domain,$courseid,$symb);
1.76 www 4427: }
1.260 ng 4428:
1.36 albertel 4429: # ------------------------------------------------------------ Serves up a file
4430: # returns either the contents of the file or a -1
4431: sub getfile {
1.269 www 4432: my $file=shift;
4433: if ($file=~/^\/*uploaded\//) { # user file
4434: my $ua=new LWP::UserAgent;
4435: my $request=new HTTP::Request('GET',&tokenwrapper($file));
4436: my $response=$ua->request($request);
4437: if ($response->is_success()) {
4438: return $response->content;
4439: } else {
4440: return -1;
4441: }
4442: } else { # normal file from res space
1.37 www 4443: &repcopy($file);
1.36 albertel 4444: if (! -e $file ) { return -1; };
1.448 albertel 4445: my $fh;
4446: open($fh,"<$file");
1.36 albertel 4447: my $a='';
4448: while (<$fh>) { $a .=$_; }
1.269 www 4449: return $a;
4450: }
1.36 albertel 4451: }
4452:
4453: sub filelocation {
4454: my ($dir,$file) = @_;
4455: my $location;
4456: $file=~ s/^\s*(\S+)\s*$/$1/; ## strip off leading and trailing spaces
1.59 albertel 4457: if ($file=~m:^/~:) { # is a contruction space reference
4458: $location = $file;
4459: $location =~ s:/~(.*?)/(.*):/home/$1/public_html/$2:;
1.270 www 4460: } elsif ($file=~/^\/*uploaded/) { # is an uploaded file
4461: $location=$file;
1.36 albertel 4462: } else {
1.59 albertel 4463: $file=~s/^$perlvar{'lonDocRoot'}//;
1.464 albertel 4464: $file=~s:^/res/:/:;
1.59 albertel 4465: if ( !( $file =~ m:^/:) ) {
4466: $location = $dir. '/'.$file;
4467: } else {
4468: $location = '/home/httpd/html/res'.$file;
4469: }
1.36 albertel 4470: }
4471: $location=~s://+:/:g; # remove duplicate /
1.46 www 4472: while ($location=~m:/\.\./:) {$location=~ s:/[^/]+/\.\./:/:g;} #remove dir/..
4473: return $location;
4474: }
1.36 albertel 4475:
1.46 www 4476: sub hreflocation {
4477: my ($dir,$file)=@_;
1.460 albertel 4478: unless (($file=~m-^http://-i) || ($file=~m-^/-)) {
4479: my $finalpath=filelocation($dir,$file);
4480: $finalpath=~s-^/home/httpd/html--;
1.462 albertel 4481: $finalpath=~s-^/home/(\w+)/public_html/-/~$1/-;
1.460 albertel 4482: return $finalpath;
4483: } elsif ($file=~m-^/home-) {
4484: $file=~s-^/home/httpd/html--;
1.462 albertel 4485: $file=~s-^/home/(\w+)/public_html/-/~$1/-;
1.460 albertel 4486: return $file;
1.46 www 4487: }
1.462 albertel 4488: return $file;
1.465 albertel 4489: }
4490:
4491: sub current_machine_domains {
4492: my $hostname=$hostname{$perlvar{'lonHostID'}};
4493: my @domains;
4494: while( my($id, $name) = each(%hostname)) {
1.467 matthew 4495: # &logthis("-$id-$name-$hostname-");
1.465 albertel 4496: if ($hostname eq $name) {
4497: push(@domains,$hostdom{$id});
4498: }
4499: }
4500: return @domains;
4501: }
4502:
4503: sub current_machine_ids {
4504: my $hostname=$hostname{$perlvar{'lonHostID'}};
4505: my @ids;
4506: while( my($id, $name) = each(%hostname)) {
1.467 matthew 4507: # &logthis("-$id-$name-$hostname-");
1.465 albertel 4508: if ($hostname eq $name) {
4509: push(@ids,$id);
4510: }
4511: }
4512: return @ids;
1.31 www 4513: }
4514:
4515: # ------------------------------------------------------------- Declutters URLs
4516:
4517: sub declutter {
4518: my $thisfn=shift;
4519: $thisfn=~s/^$perlvar{'lonDocRoot'}//;
4520: $thisfn=~s/^\///;
4521: $thisfn=~s/^res\///;
1.235 www 4522: $thisfn=~s/\?.+$//;
1.268 www 4523: return $thisfn;
4524: }
4525:
4526: # ------------------------------------------------------------- Clutter up URLs
4527:
4528: sub clutter {
4529: my $thisfn='/'.&declutter(shift);
1.270 www 4530: unless ($thisfn=~/^\/(uploaded|adm|userfiles|ext|raw|priv)\//) {
4531: $thisfn='/res'.$thisfn;
4532: }
1.31 www 4533: return $thisfn;
1.12 www 4534: }
4535:
4536: # -------------------------------------------------------- Escape Special Chars
4537:
4538: sub escape {
4539: my $str=shift;
4540: $str =~ s/(\W)/"%".unpack('H2',$1)/eg;
4541: return $str;
4542: }
4543:
4544: # ----------------------------------------------------- Un-Escape Special Chars
4545:
4546: sub unescape {
4547: my $str=shift;
4548: $str =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
4549: return $str;
4550: }
1.11 www 4551:
1.415 albertel 4552: sub mod_perl_version {
4553: if (defined($perlvar{'MODPERL2'})) {
4554: return 2;
4555: }
4556: return 1;
1.436 albertel 4557: }
4558:
4559: sub correct_line_ends {
4560: my ($result)=@_;
4561: $$result =~s/\r\n/\n/mg;
4562: $$result =~s/\r/\n/mg;
1.415 albertel 4563: }
1.1 albertel 4564: # ================================================================ Main Program
4565:
1.184 www 4566: sub goodbye {
1.204 albertel 4567: &logthis("Starting Shut down");
1.443 albertel 4568: #not converted to using infrastruture and probably shouldn't be
1.425 albertel 4569: &logthis(sprintf("%-20s is %s",'%badServerCache',scalar(%badServerCache)));
1.443 albertel 4570: #converted
1.425 albertel 4571: &logthis(sprintf("%-20s is %s",'%metacache',scalar(%metacache)));
1.443 albertel 4572: &logthis(sprintf("%-20s is %s",'%homecache',scalar(%homecache)));
1.425 albertel 4573: &logthis(sprintf("%-20s is %s",'%titlecache',scalar(%titlecache)));
4574: &logthis(sprintf("%-20s is %s",'%courseresdatacache',scalar(%courseresdatacache)));
4575: #1.1 only
4576: &logthis(sprintf("%-20s is %s",'%userresdatacache',scalar(%userresdatacache)));
4577: &logthis(sprintf("%-20s is %s",'%usectioncache',scalar(%usectioncache)));
1.440 www 4578: &logthis(sprintf("%-20s is %s",'%courseresversioncache',scalar(%courseresversioncache)));
4579: &logthis(sprintf("%-20s is %s",'%resversioncache',scalar(%resversioncache)));
1.184 www 4580: &flushcourselogs();
4581: &logthis("Shutting down");
1.362 albertel 4582: return DONE;
1.184 www 4583: }
4584:
1.179 www 4585: BEGIN {
1.228 harris41 4586: # ----------------------------------- Read loncapa.conf and loncapa_apache.conf
1.195 www 4587: unless ($readit) {
1.217 harris41 4588: {
1.448 albertel 4589: open(my $config,"</etc/httpd/conf/loncapa.conf");
1.217 harris41 4590:
4591: while (my $configline=<$config>) {
4592: if ($configline =~ /^[^\#]*PerlSetVar/) {
1.1 albertel 4593: my ($dummy,$varname,$varvalue)=split(/\s+/,$configline);
1.8 www 4594: chomp($varvalue);
1.1 albertel 4595: $perlvar{$varname}=$varvalue;
4596: }
4597: }
1.448 albertel 4598: close($config);
1.1 albertel 4599: }
1.227 harris41 4600: {
1.448 albertel 4601: open(my $config,"</etc/httpd/conf/loncapa_apache.conf");
1.227 harris41 4602:
4603: while (my $configline=<$config>) {
4604: if ($configline =~ /^[^\#]*PerlSetVar/) {
4605: my ($dummy,$varname,$varvalue)=split(/\s+/,$configline);
4606: chomp($varvalue);
4607: $perlvar{$varname}=$varvalue;
4608: }
4609: }
1.448 albertel 4610: close($config);
1.227 harris41 4611: }
1.1 albertel 4612:
1.327 albertel 4613: # ------------------------------------------------------------ Read domain file
4614: {
4615: %domaindescription = ();
4616: %domain_auth_def = ();
4617: %domain_auth_arg_def = ();
1.448 albertel 4618: my $fh;
4619: if (open($fh,"<".$Apache::lonnet::perlvar{'lonTabDir'}.'/domain.tab')) {
1.327 albertel 4620: while (<$fh>) {
1.390 matthew 4621: next if (/^(\#|\s*$)/);
4622: # next if /^\#/;
1.327 albertel 4623: chomp;
1.403 www 4624: my ($domain, $domain_description, $def_auth, $def_auth_arg,
4625: $def_lang, $city, $longi, $lati) = split(/:/,$_);
4626: $domain_auth_def{$domain}=$def_auth;
1.327 albertel 4627: $domain_auth_arg_def{$domain}=$def_auth_arg;
1.403 www 4628: $domaindescription{$domain}=$domain_description;
4629: $domain_lang_def{$domain}=$def_lang;
4630: $domain_city{$domain}=$city;
4631: $domain_longi{$domain}=$longi;
4632: $domain_lati{$domain}=$lati;
4633:
1.448 albertel 4634: # &logthis("Domain.tab: $domain, $domain_auth_def{$domain}, $domain_auth_arg_def{$domain},$domaindescription{$domain}");
1.327 albertel 4635: # &logthis("Domain.tab: $domain ".$domaindescription{$domain} );
1.448 albertel 4636: }
1.327 albertel 4637: }
1.448 albertel 4638: close ($fh);
1.327 albertel 4639: }
4640:
4641:
1.1 albertel 4642: # ------------------------------------------------------------- Read hosts file
4643: {
1.448 albertel 4644: open(my $config,"<$perlvar{'lonTabDir'}/hosts.tab");
1.1 albertel 4645:
4646: while (my $configline=<$config>) {
1.303 matthew 4647: next if ($configline =~ /^(\#|\s*$)/);
1.154 www 4648: chomp($configline);
1.245 www 4649: my ($id,$domain,$role,$name,$ip,$domdescr)=split(/:/,$configline);
1.252 albertel 4650: if ($id && $domain && $role && $name && $ip) {
4651: $hostname{$id}=$name;
4652: $hostdom{$id}=$domain;
4653: $hostip{$id}=$ip;
1.300 albertel 4654: $iphost{$ip}=$id;
1.252 albertel 4655: if ($role eq 'library') { $libserv{$id}=$name; }
4656: } else {
4657: if ($configline) {
4658: &logthis("Skipping hosts.tab line -$configline-");
4659: }
1.245 www 4660: }
1.1 albertel 4661: }
1.448 albertel 4662: close($config);
1.1 albertel 4663: }
4664:
4665: # ------------------------------------------------------ Read spare server file
4666: {
1.448 albertel 4667: open(my $config,"<$perlvar{'lonTabDir'}/spare.tab");
1.1 albertel 4668:
4669: while (my $configline=<$config>) {
4670: chomp($configline);
1.284 matthew 4671: if ($configline) {
1.1 albertel 4672: $spareid{$configline}=1;
4673: }
4674: }
1.448 albertel 4675: close($config);
1.1 albertel 4676: }
1.11 www 4677: # ------------------------------------------------------------ Read permissions
4678: {
1.448 albertel 4679: open(my $config,"<$perlvar{'lonTabDir'}/roles.tab");
1.11 www 4680:
4681: while (my $configline=<$config>) {
1.448 albertel 4682: chomp($configline);
4683: if ($configline) {
4684: my ($role,$perm)=split(/ /,$configline);
4685: if ($perm ne '') { $pr{$role}=$perm; }
4686: }
1.11 www 4687: }
1.448 albertel 4688: close($config);
1.11 www 4689: }
4690:
4691: # -------------------------------------------- Read plain texts for permissions
4692: {
1.448 albertel 4693: open(my $config,"<$perlvar{'lonTabDir'}/rolesplain.tab");
1.11 www 4694:
4695: while (my $configline=<$config>) {
1.448 albertel 4696: chomp($configline);
4697: if ($configline) {
4698: my ($short,$plain)=split(/:/,$configline);
4699: if ($plain ne '') { $prp{$short}=$plain; }
4700: }
1.135 www 4701: }
1.448 albertel 4702: close($config);
1.135 www 4703: }
4704:
4705: # ---------------------------------------------------------- Read package table
4706: {
1.448 albertel 4707: open(my $config,"<$perlvar{'lonTabDir'}/packages.tab");
1.135 www 4708:
4709: while (my $configline=<$config>) {
1.448 albertel 4710: chomp($configline);
4711: my ($short,$plain)=split(/:/,$configline);
4712: my ($pack,$name)=split(/\&/,$short);
4713: if ($plain ne '') {
4714: $packagetab{$pack.'&'.$name.'&name'}=$name;
4715: $packagetab{$short}=$plain;
4716: }
1.11 www 4717: }
1.448 albertel 4718: close($config);
1.329 matthew 4719: }
4720:
4721: # ------------- set up temporary directory
4722: {
4723: $tmpdir = $perlvar{'lonDaemons'}.'/tmp/';
4724:
1.11 www 4725: }
4726:
1.71 www 4727: %metacache=();
1.185 www 4728:
1.281 www 4729: $processmarker='_'.time.'_'.$perlvar{'lonHostID'};
1.186 www 4730: $dumpcount=0;
1.22 www 4731:
1.163 harris41 4732: &logtouch();
1.12 www 4733: &logthis('<font color=yellow>INFO: Read configuration</font>');
1.195 www 4734: $readit=1;
4735: }
1.1 albertel 4736: }
1.179 www 4737:
1.1 albertel 4738: 1;
1.191 harris41 4739: __END__
4740:
1.243 albertel 4741: =pod
4742:
1.191 harris41 4743: =head1 NAME
4744:
1.243 albertel 4745: Apache::lonnet - Subroutines to ask questions about things in the network.
1.191 harris41 4746:
4747: =head1 SYNOPSIS
4748:
1.243 albertel 4749: Invoked by other LON-CAPA modules, when they need to talk to or about objects in the network.
1.191 harris41 4750:
4751: &Apache::lonnet::SUBROUTINENAME(ARGUMENTS);
4752:
1.243 albertel 4753: Common parameters:
4754:
4755: =over 4
4756:
4757: =item *
4758:
4759: $uname : an internal username (if $cname expecting a course Id specifically)
4760:
4761: =item *
4762:
4763: $udom : a domain (if $cdom expecting a course's domain specifically)
4764:
4765: =item *
4766:
4767: $symb : a resource instance identifier
4768:
4769: =item *
4770:
4771: $namespace : the name of a .db file that contains the data needed or
4772: being set.
4773:
4774: =back
4775:
1.394 bowersj2 4776: =head1 OVERVIEW
1.191 harris41 4777:
1.394 bowersj2 4778: lonnet provides subroutines which interact with the
4779: lonc/lond (TCP) network layer of LON-CAPA. They can be used to ask
4780: about classes, users, and resources.
1.243 albertel 4781:
4782: For many of these objects you can also use this to store data about
4783: them or modify them in various ways.
1.191 harris41 4784:
1.394 bowersj2 4785: =head2 Symbs
1.191 harris41 4786:
1.394 bowersj2 4787: To identify a specific instance of a resource, LON-CAPA uses symbols
4788: or "symbs"X<symb>. These identifiers are built from the URL of the
4789: map, the resource number of the resource in the map, and the URL of
4790: the resource itself. The latter is somewhat redundant, but might help
4791: if maps change.
4792:
4793: An example is
4794:
4795: msu/korte/parts/part1.sequence___19___msu/korte/tests/part12.problem
4796:
4797: The respective map entry is
4798:
4799: <resource id="19" src="/res/msu/korte/tests/part12.problem"
4800: title="Problem 2">
4801: </resource>
4802:
4803: Symbs are used by the random number generator, as well as to store and
4804: restore data specific to a certain instance of for example a problem.
4805:
4806: =head2 Storing And Retrieving Data
4807:
4808: X<store()>X<cstore()>X<restore()>Three of the most important functions
4809: in C<lonnet.pm> are C<&Apache::lonnet::cstore()>,
4810: C<&Apache::lonnet:restore()>, and C<&Apache::lonnet::store()>, which
4811: is is the non-critical message twin of cstore. These functions are for
4812: handlers to store a perl hash to a user's permanent data space in an
4813: easy manner, and to retrieve it again on another call. It is expected
4814: that a handler would use this once at the beginning to retrieve data,
4815: and then again once at the end to send only the new data back.
4816:
4817: The data is stored in the user's data directory on the user's
4818: homeserver under the ID of the course.
4819:
4820: The hash that is returned by restore will have all of the previous
4821: value for all of the elements of the hash.
4822:
4823: Example:
4824:
4825: #creating a hash
4826: my %hash;
4827: $hash{'foo'}='bar';
4828:
4829: #storing it
4830: &Apache::lonnet::cstore(\%hash);
4831:
4832: #changing a value
4833: $hash{'foo'}='notbar';
4834:
4835: #adding a new value
4836: $hash{'bar'}='foo';
4837: &Apache::lonnet::cstore(\%hash);
4838:
4839: #retrieving the hash
4840: my %history=&Apache::lonnet::restore();
4841:
4842: #print the hash
4843: foreach my $key (sort(keys(%history))) {
4844: print("\%history{$key} = $history{$key}");
4845: }
4846:
4847: Will print out:
1.191 harris41 4848:
1.394 bowersj2 4849: %history{1:foo} = bar
4850: %history{1:keys} = foo:timestamp
4851: %history{1:timestamp} = 990455579
4852: %history{2:bar} = foo
4853: %history{2:foo} = notbar
4854: %history{2:keys} = foo:bar:timestamp
4855: %history{2:timestamp} = 990455580
4856: %history{bar} = foo
4857: %history{foo} = notbar
4858: %history{timestamp} = 990455580
4859: %history{version} = 2
4860:
4861: Note that the special hash entries C<keys>, C<version> and
4862: C<timestamp> were added to the hash. C<version> will be equal to the
4863: total number of versions of the data that have been stored. The
4864: C<timestamp> attribute will be the UNIX time the hash was
4865: stored. C<keys> is available in every historical section to list which
4866: keys were added or changed at a specific historical revision of a
4867: hash.
4868:
4869: B<Warning>: do not store the hash that restore returns directly. This
4870: will cause a mess since it will restore the historical keys as if the
4871: were new keys. I.E. 1:foo will become 1:1:foo etc.
1.191 harris41 4872:
1.394 bowersj2 4873: Calling convention:
1.191 harris41 4874:
1.394 bowersj2 4875: my %record=&Apache::lonnet::restore($symb,$courseid,$domain,$uname,$home);
4876: &Apache::lonnet::cstore(\%newrecord,$symb,$courseid,$domain,$uname,$home);
1.191 harris41 4877:
1.394 bowersj2 4878: For more detailed information, see lonnet specific documentation.
1.191 harris41 4879:
1.394 bowersj2 4880: =head1 RETURN MESSAGES
1.191 harris41 4881:
1.394 bowersj2 4882: =over 4
1.191 harris41 4883:
1.394 bowersj2 4884: =item * B<con_lost>: unable to contact remote host
1.191 harris41 4885:
1.394 bowersj2 4886: =item * B<con_delayed>: unable to contact remote host, message will be delivered
4887: when the connection is brought back up
1.191 harris41 4888:
1.394 bowersj2 4889: =item * B<con_failed>: unable to contact remote host and unable to save message
4890: for later delivery
1.191 harris41 4891:
1.394 bowersj2 4892: =item * B<error:>: an error a occured, a description of the error follows the :
1.191 harris41 4893:
1.394 bowersj2 4894: =item * B<no_such_host>: unable to fund a host associated with the user/domain
1.243 albertel 4895: that was requested
1.191 harris41 4896:
1.243 albertel 4897: =back
1.191 harris41 4898:
1.243 albertel 4899: =head1 PUBLIC SUBROUTINES
1.191 harris41 4900:
1.243 albertel 4901: =head2 Session Environment Functions
1.191 harris41 4902:
1.243 albertel 4903: =over 4
1.191 harris41 4904:
1.394 bowersj2 4905: =item *
4906: X<appenv()>
4907: B<appenv(%hash)>: the value of %hash is written to
4908: the user envirnoment file, and will be restored for each access this
4909: user makes during this session, also modifies the %ENV for the current
4910: process
1.191 harris41 4911:
4912: =item *
1.394 bowersj2 4913: X<delenv()>
4914: B<delenv($regexp)>: removes all items from the session
4915: environment file that matches the regular expression in $regexp. The
4916: values are also delted from the current processes %ENV.
1.191 harris41 4917:
1.243 albertel 4918: =back
4919:
4920: =head2 User Information
1.191 harris41 4921:
1.243 albertel 4922: =over 4
1.191 harris41 4923:
4924: =item *
1.394 bowersj2 4925: X<queryauthenticate()>
4926: B<queryauthenticate($uname,$udom)>: try to determine user's current
1.191 harris41 4927: authentication scheme
4928:
4929: =item *
1.394 bowersj2 4930: X<authenticate()>
4931: B<authenticate($uname,$upass,$udom)>: try to
4932: authenticate user from domain's lib servers (first use the current
4933: one). C<$upass> should be the users password.
1.191 harris41 4934:
4935: =item *
1.394 bowersj2 4936: X<homeserver()>
4937: B<homeserver($uname,$udom)>: find the server which has
4938: the user's directory and files (there must be only one), this caches
4939: the answer, and also caches if there is a borken connection.
1.191 harris41 4940:
4941: =item *
1.394 bowersj2 4942: X<idget()>
4943: B<idget($udom,@ids)>: find the usernames behind a list of IDs
4944: (IDs are a unique resource in a domain, there must be only 1 ID per
4945: username, and only 1 username per ID in a specific domain) (returns
4946: hash: id=>name,id=>name)
1.191 harris41 4947:
4948: =item *
1.394 bowersj2 4949: X<idrget()>
4950: B<idrget($udom,@unames)>: find the IDs behind a list of
4951: usernames (returns hash: name=>id,name=>id)
1.191 harris41 4952:
4953: =item *
1.394 bowersj2 4954: X<idput()>
4955: B<idput($udom,%ids)>: store away a list of names and associated IDs
1.191 harris41 4956:
4957: =item *
1.394 bowersj2 4958: X<rolesinit()>
4959: B<rolesinit($udom,$username,$authhost)>: get user privileges
1.243 albertel 4960:
4961: =item *
1.394 bowersj2 4962: X<usection()>
4963: B<usection($udom,$uname,$cname)>: finds the section of student in the
1.243 albertel 4964: course $cname, return section name/number or '' for "not in course"
4965: and '-1' for "no section"
4966:
4967: =item *
1.394 bowersj2 4968: X<userenvironment()>
4969: B<userenvironment($udom,$uname,@what)>: gets the values of the keys
1.243 albertel 4970: passed in @what from the requested user's environment, returns a hash
4971:
4972: =back
4973:
4974: =head2 User Roles
4975:
4976: =over 4
4977:
4978: =item *
4979:
4980: allowed($priv,$uri) : check for a user privilege; returns codes for allowed
4981: actions
4982: F: full access
4983: U,I,K: authentication modes (cxx only)
4984: '': forbidden
4985: 1: user needs to choose course
4986: 2: browse allowed
4987:
4988: =item *
4989:
4990: definerole($rolename,$sysrole,$domrole,$courole) : define role; define a custom
4991: role rolename set privileges in format of lonTabs/roles.tab for system, domain,
4992: and course level
4993:
4994: =item *
4995:
4996: plaintext($short) : return value in %prp hash (rolesplain.tab); plain text
4997: explanation of a user role term
4998:
4999: =back
5000:
5001: =head2 User Modification
5002:
5003: =over 4
5004:
5005: =item *
5006:
5007: assignrole($udom,$uname,$url,$role,$end,$start) : assign role; give a role to a
5008: user for the level given by URL. Optional start and end dates (leave empty
5009: string or zero for "no date")
1.191 harris41 5010:
5011: =item *
5012:
1.243 albertel 5013: changepass($uname,$udom,$currentpass,$newpass,$server) : attempts to
5014: change a users, password, possible return values are: ok,
5015: pwchange_failure, non_authorized, auth_mode_error, unknown_user,
5016: refused
1.191 harris41 5017:
5018: =item *
5019:
1.243 albertel 5020: modifyuserauth($udom,$uname,$umode,$upass) : modify user authentication
1.191 harris41 5021:
5022: =item *
5023:
1.243 albertel 5024: modifyuser($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene) :
5025: modify user
1.191 harris41 5026:
5027: =item *
5028:
1.286 matthew 5029: modifystudent
5030:
5031: modify a students enrollment and identification information.
5032: The course id is resolved based on the current users environment.
5033: This means the envoking user must be a course coordinator or otherwise
5034: associated with a course.
5035:
1.297 matthew 5036: This call is essentially a wrapper for lonnet::modifyuser and
5037: lonnet::modify_student_enrollment
1.286 matthew 5038:
5039: Inputs:
5040:
5041: =over 4
5042:
5043: =item B<$udom> Students loncapa domain
5044:
5045: =item B<$uname> Students loncapa login name
5046:
5047: =item B<$uid> Students id/student number
5048:
5049: =item B<$umode> Students authentication mode
5050:
5051: =item B<$upass> Students password
5052:
5053: =item B<$first> Students first name
5054:
5055: =item B<$middle> Students middle name
5056:
5057: =item B<$last> Students last name
5058:
5059: =item B<$gene> Students generation
5060:
5061: =item B<$usec> Students section in course
5062:
5063: =item B<$end> Unix time of the roles expiration
5064:
5065: =item B<$start> Unix time of the roles start date
5066:
5067: =item B<$forceid> If defined, allow $uid to be changed
5068:
5069: =item B<$desiredhome> server to use as home server for student
5070:
5071: =back
1.297 matthew 5072:
5073: =item *
5074:
5075: modify_student_enrollment
5076:
5077: Change a students enrollment status in a class. The environment variable
5078: 'role.request.course' must be defined for this function to proceed.
5079:
5080: Inputs:
5081:
5082: =over 4
5083:
5084: =item $udom, students domain
5085:
5086: =item $uname, students name
5087:
5088: =item $uid, students user id
5089:
5090: =item $first, students first name
5091:
5092: =item $middle
5093:
5094: =item $last
5095:
5096: =item $gene
5097:
5098: =item $usec
5099:
5100: =item $end
5101:
5102: =item $start
5103:
5104: =back
5105:
1.191 harris41 5106:
5107: =item *
5108:
1.243 albertel 5109: assigncustomrole($udom,$uname,$url,$rdom,$rnam,$rolename,$end,$start) : assign
5110: custom role; give a custom role to a user for the level given by URL. Specify
5111: name and domain of role author, and role name
1.191 harris41 5112:
5113: =item *
5114:
1.243 albertel 5115: revokerole($udom,$uname,$url,$role) : revoke a role for url
1.191 harris41 5116:
5117: =item *
5118:
1.243 albertel 5119: revokecustomrole($udom,$uname,$url,$role) : revoke a custom role
5120:
5121: =back
5122:
5123: =head2 Course Infomation
5124:
5125: =over 4
1.191 harris41 5126:
5127: =item *
5128:
1.243 albertel 5129: coursedescription($courseid) : course description
1.191 harris41 5130:
5131: =item *
5132:
1.243 albertel 5133: courseresdata($coursenum,$coursedomain,@which) : request for current
5134: parameter setting for a specific course, @what should be a list of
5135: parameters to ask about. This routine caches answers for 5 minutes.
5136:
5137: =back
5138:
5139: =head2 Course Modification
5140:
5141: =over 4
1.191 harris41 5142:
5143: =item *
5144:
1.243 albertel 5145: writecoursepref($courseid,%prefs) : write preferences (environment
5146: database) for a course
1.191 harris41 5147:
5148: =item *
5149:
1.243 albertel 5150: createcourse($udom,$description,$url) : make/modify course
5151:
5152: =back
5153:
5154: =head2 Resource Subroutines
5155:
5156: =over 4
1.191 harris41 5157:
5158: =item *
5159:
1.243 albertel 5160: subscribe($fname) : subscribe to a resource, returns URL if possible (probably should use repcopy instead)
1.191 harris41 5161:
5162: =item *
5163:
1.243 albertel 5164: repcopy($filename) : subscribes to the requested file, and attempts to
5165: replicate from the owning library server, Might return
5166: HTTP_SERVICE_UNAVAILABLE, HTTP_NOT_FOUND, FORBIDDEN, OK, or
5167: HTTP_BAD_REQUEST, also attempts to grab the metadata for the
5168: resource. Expects the local filesystem pathname
5169: (/home/httpd/html/res/....)
5170:
5171: =back
5172:
5173: =head2 Resource Information
5174:
5175: =over 4
1.191 harris41 5176:
5177: =item *
5178:
1.243 albertel 5179: EXT($varname,$symb,$udom,$uname) : evaluates and returns the value of
5180: a vairety of different possible values, $varname should be a request
5181: string, and the other parameters can be used to specify who and what
5182: one is asking about.
5183:
5184: Possible values for $varname are environment.lastname (or other item
5185: from the envirnment hash), user.name (or someother aspect about the
5186: user), resource.0.maxtries (or some other part and parameter of a
5187: resource)
1.204 albertel 5188:
5189: =item *
5190:
1.243 albertel 5191: directcondval($number) : get current value of a condition; reads from a state
5192: string
1.204 albertel 5193:
5194: =item *
5195:
1.243 albertel 5196: condval($condidx) : value of condition index based on state
1.204 albertel 5197:
5198: =item *
5199:
1.243 albertel 5200: metadata($uri,$what,$liburi,$prefix,$depthcount) : request a
5201: resource's metadata, $what should be either a specific key, or either
5202: 'keys' (to get a list of possible keys) or 'packages' to get a list of
5203: packages that this resource currently uses, the last 3 arguments are only used internally for recursive metadata.
5204:
5205: this function automatically caches all requests
1.191 harris41 5206:
5207: =item *
5208:
1.243 albertel 5209: metadata_query($query,$custom,$customshow) : make a metadata query against the
5210: network of library servers; returns file handle of where SQL and regex results
5211: will be stored for query
1.191 harris41 5212:
5213: =item *
5214:
1.243 albertel 5215: symbread($filename) : return symbolic list entry (filename argument optional);
5216: returns the data handle
1.191 harris41 5217:
5218: =item *
5219:
1.243 albertel 5220: symbverify($symb,$thisfn) : verifies that $symb actually exists and is
5221: a possible symb for the URL in $thisfn, returns a 1 on success, 0 on
5222: failure, user must be in a course, as it assumes the existance of the
5223: course initi hash, and uses $ENV('request.course.id'}
5224:
1.191 harris41 5225:
5226: =item *
5227:
1.243 albertel 5228: symbclean($symb) : removes versions numbers from a symb, returns the
5229: cleaned symb
1.191 harris41 5230:
5231: =item *
5232:
1.243 albertel 5233: is_on_map($uri) : checks if the $uri is somewhere on the current
5234: course map, user must be in a course for it to work.
1.191 harris41 5235:
5236: =item *
5237:
1.243 albertel 5238: numval($salt) : return random seed value (addend for rndseed)
1.191 harris41 5239:
5240: =item *
5241:
1.243 albertel 5242: rndseed($symb,$courseid,$udom,$uname) : create a random sum; returns
5243: a random seed, all arguments are optional, if they aren't sent it uses the
5244: environment to derive them. Note: if symb isn't sent and it can't get one
5245: from &symbread it will use the current time as its return value
1.191 harris41 5246:
5247: =item *
5248:
1.243 albertel 5249: ireceipt($funame,$fudom,$fucourseid,$fusymb) : return unique,
5250: unfakeable, receipt
1.191 harris41 5251:
5252: =item *
5253:
1.243 albertel 5254: receipt() : API to ireceipt working off of ENV values; given out to users
1.191 harris41 5255:
5256: =item *
5257:
1.243 albertel 5258: countacc($url) : count the number of accesses to a given URL
1.191 harris41 5259:
5260: =item *
5261:
1.243 albertel 5262: 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 5263:
5264: =item *
5265:
1.243 albertel 5266: 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 5267:
5268: =item *
5269:
1.243 albertel 5270: expirespread($uname,$udom,$stype,$usymb) : set expire date for spreadsheet
1.191 harris41 5271:
5272: =item *
5273:
1.243 albertel 5274: devalidate($symb) : devalidate temporary spreadsheet calculations,
5275: forcing spreadsheet to reevaluate the resource scores next time.
5276:
5277: =back
5278:
5279: =head2 Storing/Retreiving Data
5280:
5281: =over 4
1.191 harris41 5282:
5283: =item *
5284:
1.243 albertel 5285: store($storehash,$symb,$namespace,$udom,$uname) : stores hash permanently
5286: for this url; hashref needs to be given and should be a \%hashname; the
5287: remaining args aren't required and if they aren't passed or are '' they will
5288: be derived from the ENV
1.191 harris41 5289:
5290: =item *
5291:
1.243 albertel 5292: cstore($storehash,$symb,$namespace,$udom,$uname) : same as store but
5293: uses critical subroutine
1.191 harris41 5294:
5295: =item *
5296:
1.243 albertel 5297: restore($symb,$namespace,$udom,$uname) : returns hash for this symb;
5298: all args are optional
1.191 harris41 5299:
5300: =item *
5301:
1.243 albertel 5302: tmpstore($storehash,$symb,$namespace,$udom,$uname) : storage that
5303: works very similar to store/cstore, but all data is stored in a
5304: temporary location and can be reset using tmpreset, $storehash should
5305: be a hash reference, returns nothing on success
1.191 harris41 5306:
5307: =item *
5308:
1.243 albertel 5309: tmprestore($symb,$namespace,$udom,$uname) : storage that works very
5310: similar to restore, but all data is stored in a temporary location and
5311: can be reset using tmpreset. Returns a hash of values on success,
5312: error string otherwise.
1.191 harris41 5313:
5314: =item *
5315:
1.243 albertel 5316: tmpreset($symb,$namespace,$udom,$uname) : temporary storage reset,
5317: deltes all keys for $symb form the temporary storage hash.
1.191 harris41 5318:
5319: =item *
5320:
1.243 albertel 5321: get($namespace,$storearr,$udom,$uname) : returns hash with keys from array
5322: reference filled in from namesp ($udom and $uname are optional)
1.191 harris41 5323:
5324: =item *
5325:
1.243 albertel 5326: del($namespace,$storearr,$udom,$uname) : deletes keys out of array from
5327: namesp ($udom and $uname are optional)
1.191 harris41 5328:
5329: =item *
5330:
1.243 albertel 5331: dump($namespace,$udom,$uname,$regexp) :
5332: dumps the complete (or key matching regexp) namespace into a hash
5333: ($udom, $uname and $regexp are optional)
1.449 matthew 5334:
5335: =item *
5336:
5337: inc($namespace,$store,$udom,$uname) : increments $store in $namespace.
5338: $store can be a scalar, an array reference, or if the amount to be
5339: incremented is > 1, a hash reference.
5340:
5341: ($udom and $uname are optional)
1.191 harris41 5342:
5343: =item *
5344:
1.243 albertel 5345: put($namespace,$storehash,$udom,$uname) : stores hash in namesp
5346: ($udom and $uname are optional)
1.191 harris41 5347:
5348: =item *
5349:
1.243 albertel 5350: cput($namespace,$storehash,$udom,$uname) : critical put
5351: ($udom and $uname are optional)
1.191 harris41 5352:
5353: =item *
5354:
1.243 albertel 5355: eget($namespace,$storearr,$udom,$uname) : returns hash with keys from array
5356: reference filled in from namesp (encrypts the return communication)
5357: ($udom and $uname are optional)
1.191 harris41 5358:
5359: =item *
5360:
1.243 albertel 5361: log($udom,$name,$home,$message) : write to permanent log for user; use
5362: critical subroutine
5363:
5364: =back
5365:
5366: =head2 Network Status Functions
5367:
5368: =over 4
1.191 harris41 5369:
5370: =item *
5371:
5372: dirlist($uri) : return directory list based on URI
5373:
5374: =item *
5375:
1.243 albertel 5376: spareserver() : find server with least workload from spare.tab
5377:
5378: =back
5379:
5380: =head2 Apache Request
5381:
5382: =over 4
1.191 harris41 5383:
5384: =item *
5385:
1.243 albertel 5386: ssi($url,%hash) : server side include, does a complete request cycle on url to
5387: localhost, posts hash
5388:
5389: =back
5390:
5391: =head2 Data to String to Data
5392:
5393: =over 4
1.191 harris41 5394:
5395: =item *
5396:
1.243 albertel 5397: hash2str(%hash) : convert a hash into a string complete with escaping and '='
5398: and '&' separators, supports elements that are arrayrefs and hashrefs
1.191 harris41 5399:
5400: =item *
5401:
1.243 albertel 5402: hashref2str($hashref) : convert a hashref into a string complete with
5403: escaping and '=' and '&' separators, supports elements that are
5404: arrayrefs and hashrefs
1.191 harris41 5405:
5406: =item *
5407:
1.243 albertel 5408: arrayref2str($arrayref) : convert an arrayref into a string complete
5409: with escaping and '&' separators, supports elements that are arrayrefs
5410: and hashrefs
1.191 harris41 5411:
5412: =item *
5413:
1.243 albertel 5414: str2hash($string) : convert string to hash using unescaping and
5415: splitting on '=' and '&', supports elements that are arrayrefs and
5416: hashrefs
1.191 harris41 5417:
5418: =item *
5419:
1.243 albertel 5420: str2array($string) : convert string to hash using unescaping and
5421: splitting on '&', supports elements that are arrayrefs and hashrefs
5422:
5423: =back
5424:
5425: =head2 Logging Routines
5426:
5427: =over 4
5428:
5429: These routines allow one to make log messages in the lonnet.log and
5430: lonnet.perm logfiles.
1.191 harris41 5431:
5432: =item *
5433:
1.243 albertel 5434: logtouch() : make sure the logfile, lonnet.log, exists
1.191 harris41 5435:
5436: =item *
5437:
1.243 albertel 5438: logthis() : append message to the normal lonnet.log file, it gets
5439: preiodically rolled over and deleted.
1.191 harris41 5440:
5441: =item *
5442:
1.243 albertel 5443: logperm() : append a permanent message to lonnet.perm.log, this log
5444: file never gets deleted by any automated portion of the system, only
5445: messages of critical importance should go in here.
5446:
5447: =back
5448:
5449: =head2 General File Helper Routines
5450:
5451: =over 4
1.191 harris41 5452:
5453: =item *
5454:
1.243 albertel 5455: getfile($file) : returns the entire contents of a file or -1; it
5456: properly subscribes to and replicates the file if neccessary.
1.191 harris41 5457:
5458: =item *
5459:
1.243 albertel 5460: filelocation($dir,$file) : returns file system location of a file
5461: based on URI; meant to be "fairly clean" absolute reference, $dir is a
5462: directory that relative $file lookups are to looked in ($dir of /a/dir
5463: and a file of ../bob will become /a/bob)
1.191 harris41 5464:
5465: =item *
5466:
5467: hreflocation($dir,$file) : returns file system location or a URL; same as
5468: filelocation except for hrefs
5469:
5470: =item *
5471:
5472: declutter() : declutters URLs (remove docroot, beginning slashes, 'res' etc)
5473:
1.243 albertel 5474: =back
5475:
5476: =head2 HTTP Helper Routines
5477:
5478: =over 4
5479:
1.191 harris41 5480: =item *
5481:
5482: escape() : unpack non-word characters into CGI-compatible hex codes
5483:
5484: =item *
5485:
5486: unescape() : pack CGI-compatible hex codes into actual non-word ASCII character
5487:
1.243 albertel 5488: =back
5489:
5490: =head1 PRIVATE SUBROUTINES
5491:
5492: =head2 Underlying communication routines (Shouldn't call)
5493:
5494: =over 4
5495:
5496: =item *
5497:
5498: subreply() : tries to pass a message to lonc, returns con_lost if incapable
5499:
5500: =item *
5501:
5502: reply() : uses subreply to send a message to remote machine, logs all failures
5503:
5504: =item *
5505:
5506: critical() : passes a critical message to another server; if cannot
5507: get through then place message in connection buffer directory and
5508: returns con_delayed, if incapable of saving message, returns
5509: con_failed
5510:
5511: =item *
5512:
5513: reconlonc() : tries to reconnect lonc client processes.
5514:
5515: =back
5516:
5517: =head2 Resource Access Logging
5518:
5519: =over 4
5520:
5521: =item *
5522:
5523: flushcourselogs() : flush (save) buffer logs and access logs
5524:
5525: =item *
5526:
5527: courselog($what) : save message for course in hash
5528:
5529: =item *
5530:
5531: courseacclog($what) : save message for course using &courselog(). Perform
5532: special processing for specific resource types (problems, exams, quizzes, etc).
5533:
1.191 harris41 5534: =item *
5535:
5536: goodbye() : flush course logs and log shutting down; it is called in srm.conf
5537: as a PerlChildExitHandler
1.243 albertel 5538:
5539: =back
5540:
5541: =head2 Other
5542:
5543: =over 4
5544:
5545: =item *
5546:
5547: symblist($mapname,%newhash) : update symbolic storage links
1.191 harris41 5548:
5549: =back
5550:
5551: =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