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