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