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