Annotation of loncom/lonnet/perl/lonnet.pm, revision 1.741
1.1 albertel 1: # The LearningOnline Network
2: # TCP networking package
1.12 www 3: #
1.741 ! raeburn 4: # $Id: lonnet.pm,v 1.740 2006/05/30 12:47:18 www Exp $
1.178 www 5: #
6: # Copyright Michigan State University Board of Trustees
7: #
8: # This file is part of the LearningOnline Network with CAPA (LON-CAPA).
9: #
10: # LON-CAPA is free software; you can redistribute it and/or modify
11: # it under the terms of the GNU General Public License as published by
12: # the Free Software Foundation; either version 2 of the License, or
13: # (at your option) any later version.
14: #
15: # LON-CAPA is distributed in the hope that it will be useful,
16: # but WITHOUT ANY WARRANTY; without even the implied warranty of
17: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18: # GNU General Public License for more details.
19: #
20: # You should have received a copy of the GNU General Public License
21: # along with LON-CAPA; if not, write to the Free Software
22: # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
23: #
24: # /home/httpd/html/adm/gpl.txt
25: #
26: # http://www.lon-capa.org/
27: #
1.169 harris41 28: ###
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.741 ! raeburn 41: %coursedombuf %coursenumbuf %coursehombuf %coursedescrbuf %courseinstcodebuf %courseownerbuf %coursetypebuf
1.599 albertel 42: %domaindescription %domain_auth_def %domain_auth_arg_def
1.685 raeburn 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.208 albertel 48: use HTML::LCParser;
1.637 raeburn 49: use HTML::Parser;
1.88 www 50: use Fcntl qw(:flock);
1.557 albertel 51: use Storable qw(lock_store lock_nstore lock_retrieve freeze thaw nfreeze);
1.539 albertel 52: use Time::HiRes qw( gettimeofday tv_interval );
1.599 albertel 53: use Cache::Memcached;
1.676 albertel 54: use Digest::MD5;
1.740 www 55: use lib '/home/httpd/lib/perl';
56: use LONCAPA;
57: use LONCAPA::Configuration;
1.676 albertel 58:
1.195 www 59: my $readit;
1.550 foxr 60: my $max_connection_retries = 10; # Or some such value.
1.1 albertel 61:
1.619 albertel 62: require Exporter;
63:
64: our @ISA = qw (Exporter);
65: our @EXPORT = qw(%env);
66:
1.449 matthew 67: =pod
68:
69: =head1 Package Variables
70:
71: These are largely undocumented, so if you decipher one please note it here.
72:
73: =over 4
74:
75: =item $processmarker
76:
77: Contains the time this process was started and this servers host id.
78:
79: =item $dumpcount
80:
81: Counts the number of times a message log flush has been attempted (regardless
82: of success) by this process. Used as part of the filename when messages are
83: delayed.
84:
85: =back
86:
87: =cut
88:
89:
1.1 albertel 90: # --------------------------------------------------------------------- Logging
1.729 www 91: {
92: my $logid;
93: sub instructor_log {
94: my ($hash_name,$storehash,$delflag,$uname,$udom)=@_;
95: $logid++;
96: my $id=time().'00000'.$$.'00000'.$logid;
97: return &Apache::lonnet::put('nohist_'.$hash_name,
1.730 www 98: { $id => {
99: 'exe_uname' => $env{'user.name'},
100: 'exe_udom' => $env{'user.domain'},
101: 'exe_time' => time(),
102: 'exe_ip' => $ENV{'REMOTE_ADDR'},
103: 'delflag' => $delflag,
104: 'logentry' => $storehash,
105: 'uname' => $uname,
106: 'udom' => $udom,
107: }
108: },
1.729 www 109: $env{'course.'.$env{'request.course.id'}.'.domain'},
110: $env{'course.'.$env{'request.course.id'}.'.num'}
111: );
112: }
113: }
1.1 albertel 114:
1.163 harris41 115: sub logtouch {
116: my $execdir=$perlvar{'lonDaemons'};
1.448 albertel 117: unless (-e "$execdir/logs/lonnet.log") {
118: open(my $fh,">>$execdir/logs/lonnet.log");
1.163 harris41 119: close $fh;
120: }
121: my ($wwwuid,$wwwgid)=(getpwnam('www'))[2,3];
122: chown($wwwuid,$wwwgid,$execdir.'/logs/lonnet.log');
123: }
124:
1.1 albertel 125: sub logthis {
126: my $message=shift;
127: my $execdir=$perlvar{'lonDaemons'};
128: my $now=time;
129: my $local=localtime($now);
1.448 albertel 130: if (open(my $fh,">>$execdir/logs/lonnet.log")) {
131: print $fh "$local ($$): $message\n";
132: close($fh);
133: }
1.1 albertel 134: return 1;
135: }
136:
137: sub logperm {
138: my $message=shift;
139: my $execdir=$perlvar{'lonDaemons'};
140: my $now=time;
141: my $local=localtime($now);
1.448 albertel 142: if (open(my $fh,">>$execdir/logs/lonnet.perm.log")) {
143: print $fh "$now:$message:$local\n";
144: close($fh);
145: }
1.1 albertel 146: return 1;
147: }
148:
149: # -------------------------------------------------- Non-critical communication
150: sub subreply {
151: my ($cmd,$server)=@_;
1.704 albertel 152: my $peerfile="$perlvar{'lonSockDir'}/".$hostname{$server};
1.549 foxr 153: #
154: # With loncnew process trimming, there's a timing hole between lonc server
155: # process exit and the master server picking up the listen on the AF_UNIX
156: # socket. In that time interval, a lock file will exist:
157:
158: my $lockfile=$peerfile.".lock";
159: while (-e $lockfile) { # Need to wait for the lockfile to disappear.
160: sleep(1);
161: }
162: # At this point, either a loncnew parent is listening or an old lonc
1.550 foxr 163: # or loncnew child is listening so we can connect or everything's dead.
1.549 foxr 164: #
1.550 foxr 165: # We'll give the connection a few tries before abandoning it. If
166: # connection is not possible, we'll con_lost back to the client.
167: #
168: my $client;
169: for (my $retries = 0; $retries < $max_connection_retries; $retries++) {
170: $client=IO::Socket::UNIX->new(Peer =>"$peerfile",
171: Type => SOCK_STREAM,
172: Timeout => 10);
173: if($client) {
174: last; # Connected!
175: }
176: sleep(1); # Try again later if failed connection.
177: }
178: my $answer;
179: if ($client) {
1.704 albertel 180: print $client "sethost:$server:$cmd\n";
1.550 foxr 181: $answer=<$client>;
182: if (!$answer) { $answer="con_lost"; }
183: chomp($answer);
184: } else {
185: $answer = 'con_lost'; # Failed connection.
186: }
1.1 albertel 187: return $answer;
188: }
189:
190: sub reply {
191: my ($cmd,$server)=@_;
1.205 www 192: unless (defined($hostname{$server})) { return 'no_such_host'; }
1.1 albertel 193: my $answer=subreply($cmd,$server);
1.65 www 194: if (($answer=~/^refused/) || ($answer=~/^rejected/)) {
1.672 albertel 195: &logthis("<font color=\"blue\">WARNING:".
1.12 www 196: " $cmd to $server returned $answer</font>");
197: }
1.1 albertel 198: return $answer;
199: }
200:
201: # ----------------------------------------------------------- Send USR1 to lonc
202:
203: sub reconlonc {
204: my $peerfile=shift;
205: &logthis("Trying to reconnect for $peerfile");
206: my $loncfile="$perlvar{'lonDaemons'}/logs/lonc.pid";
1.448 albertel 207: if (open(my $fh,"<$loncfile")) {
1.1 albertel 208: my $loncpid=<$fh>;
209: chomp($loncpid);
210: if (kill 0 => $loncpid) {
211: &logthis("lonc at pid $loncpid responding, sending USR1");
212: kill USR1 => $loncpid;
213: sleep 1;
214: if (-e "$peerfile") { return; }
215: &logthis("$peerfile still not there, give it another try");
216: sleep 5;
217: if (-e "$peerfile") { return; }
1.12 www 218: &logthis(
1.672 albertel 219: "<font color=\"blue\">WARNING: $peerfile still not there, giving up</font>");
1.1 albertel 220: } else {
1.12 www 221: &logthis(
1.672 albertel 222: "<font color=\"blue\">WARNING:".
1.12 www 223: " lonc at pid $loncpid not responding, giving up</font>");
1.1 albertel 224: }
225: } else {
1.672 albertel 226: &logthis('<font color="blue">WARNING: lonc not running, giving up</font>');
1.1 albertel 227: }
228: }
229:
230: # ------------------------------------------------------ Critical communication
1.12 www 231:
1.1 albertel 232: sub critical {
233: my ($cmd,$server)=@_;
1.89 www 234: unless ($hostname{$server}) {
1.672 albertel 235: &logthis("<font color=\"blue\">WARNING:".
1.89 www 236: " Critical message to unknown server ($server)</font>");
237: return 'no_such_host';
238: }
1.1 albertel 239: my $answer=reply($cmd,$server);
240: if ($answer eq 'con_lost') {
241: &reconlonc("$perlvar{'lonSockDir'}/$server");
1.589 albertel 242: my $answer=reply($cmd,$server);
1.1 albertel 243: if ($answer eq 'con_lost') {
244: my $now=time;
245: my $middlename=$cmd;
1.5 www 246: $middlename=substr($middlename,0,16);
1.1 albertel 247: $middlename=~s/\W//g;
248: my $dfilename=
1.305 www 249: "$perlvar{'lonSockDir'}/delayed/$now.$dumpcount.$$.$middlename.$server";
250: $dumpcount++;
1.1 albertel 251: {
1.448 albertel 252: my $dfh;
253: if (open($dfh,">$dfilename")) {
254: print $dfh "$cmd\n";
255: close($dfh);
256: }
1.1 albertel 257: }
258: sleep 2;
259: my $wcmd='';
260: {
1.448 albertel 261: my $dfh;
262: if (open($dfh,"<$dfilename")) {
263: $wcmd=<$dfh>;
264: close($dfh);
265: }
1.1 albertel 266: }
267: chomp($wcmd);
1.7 www 268: if ($wcmd eq $cmd) {
1.672 albertel 269: &logthis("<font color=\"blue\">WARNING: ".
1.12 www 270: "Connection buffer $dfilename: $cmd</font>");
1.1 albertel 271: &logperm("D:$server:$cmd");
272: return 'con_delayed';
273: } else {
1.672 albertel 274: &logthis("<font color=\"red\">CRITICAL:"
1.12 www 275: ." Critical connection failed: $server $cmd</font>");
1.1 albertel 276: &logperm("F:$server:$cmd");
277: return 'con_failed';
278: }
279: }
280: }
281: return $answer;
1.405 albertel 282: }
283:
1.374 www 284: # ------------------------------------------- Transfer profile into environment
285:
286: sub transfer_profile_to_env {
287: my ($lonidsdir,$handle)=@_;
1.720 albertel 288: if (!defined($lonidsdir)) {
289: $lonidsdir = $perlvar{'lonIDsDir'};
290: }
291: if (!defined($handle)) {
292: ($handle) = ($env{'user.environment'} =~m|/([^/]+)\.id$| );
293: }
294:
1.374 www 295: my @profile;
296: {
1.448 albertel 297: open(my $idf,"$lonidsdir/$handle.id");
1.374 www 298: flock($idf,LOCK_SH);
299: @profile=<$idf>;
1.448 albertel 300: close($idf);
1.374 www 301: }
302: my $envi;
1.433 matthew 303: my %Remove;
1.374 www 304: for ($envi=0;$envi<=$#profile;$envi++) {
305: chomp($profile[$envi]);
1.690 albertel 306: my ($envname,$envvalue)=split(/=/,$profile[$envi],2);
1.726 albertel 307: $envname=&unescape($envname);
308: $envvalue=&unescape($envvalue);
1.619 albertel 309: $env{$envname} = $envvalue;
1.433 matthew 310: if (my ($key,$time) = ($envname =~ /^(cgi\.(\d+)_\d+\.)/)) {
311: if ($time < time-300) {
312: $Remove{$key}++;
313: }
314: }
315: }
1.619 albertel 316: $env{'user.environment'} = "$lonidsdir/$handle.id";
1.433 matthew 317: foreach my $expired_key (keys(%Remove)) {
318: &delenv($expired_key);
1.374 www 319: }
1.1 albertel 320: }
321:
1.5 www 322: # ---------------------------------------------------------- Append Environment
323:
324: sub appenv {
1.6 www 325: my %newenv=@_;
1.692 albertel 326: foreach my $key (keys(%newenv)) {
327: if (($newenv{$key}=~/^user\.role/) || ($newenv{$key}=~/^user\.priv/)) {
1.672 albertel 328: &logthis("<font color=\"blue\">WARNING: ".
1.692 albertel 329: "Attempt to modify environment ".$key." to ".$newenv{$key}
1.151 www 330: .'</font>');
1.692 albertel 331: delete($newenv{$key});
1.35 www 332: } else {
1.692 albertel 333: $env{$key}=$newenv{$key};
1.35 www 334: }
1.191 harris41 335: }
1.95 www 336:
337: my $lockfh;
1.620 albertel 338: unless (open($lockfh,"$env{'user.environment'}")) {
1.448 albertel 339: return 'error: '.$!;
1.95 www 340: }
341: unless (flock($lockfh,LOCK_EX)) {
1.672 albertel 342: &logthis("<font color=\"blue\">WARNING: ".
1.95 www 343: 'Could not obtain exclusive lock in appenv: '.$!);
1.448 albertel 344: close($lockfh);
1.95 www 345: return 'error: '.$!;
346: }
347:
1.6 www 348: my @oldenv;
349: {
1.448 albertel 350: my $fh;
1.620 albertel 351: unless (open($fh,"$env{'user.environment'}")) {
1.448 albertel 352: return 'error: '.$!;
353: }
354: @oldenv=<$fh>;
355: close($fh);
1.6 www 356: }
357: for (my $i=0; $i<=$#oldenv; $i++) {
358: chomp($oldenv[$i]);
1.9 www 359: if ($oldenv[$i] ne '') {
1.690 albertel 360: my ($name,$value)=split(/=/,$oldenv[$i],2);
1.726 albertel 361: $name=&unescape($name);
362: $value=&unescape($value);
1.448 albertel 363: unless (defined($newenv{$name})) {
364: $newenv{$name}=$value;
365: }
1.9 www 366: }
1.6 www 367: }
368: {
1.448 albertel 369: my $fh;
1.620 albertel 370: unless (open($fh,">$env{'user.environment'}")) {
1.448 albertel 371: return 'error';
372: }
373: my $newname;
374: foreach $newname (keys %newenv) {
1.726 albertel 375: print $fh &escape($newname).'='.&escape($newenv{$newname})."\n";
1.448 albertel 376: }
377: close($fh);
1.56 www 378: }
1.448 albertel 379:
380: close($lockfh);
1.56 www 381: return 'ok';
382: }
383: # ----------------------------------------------------- Delete from Environment
384:
385: sub delenv {
386: my $delthis=shift;
387: if (($delthis=~/user\.role/) || ($delthis=~/user\.priv/)) {
1.672 albertel 388: &logthis("<font color=\"blue\">WARNING: ".
1.56 www 389: "Attempt to delete from environment ".$delthis);
390: return 'error';
391: }
392: my @oldenv;
393: {
1.448 albertel 394: my $fh;
1.620 albertel 395: unless (open($fh,"$env{'user.environment'}")) {
1.448 albertel 396: return 'error';
397: }
398: unless (flock($fh,LOCK_SH)) {
1.672 albertel 399: &logthis("<font color=\"blue\">WARNING: ".
1.448 albertel 400: 'Could not obtain shared lock in delenv: '.$!);
401: close($fh);
402: return 'error: '.$!;
403: }
404: @oldenv=<$fh>;
405: close($fh);
1.56 www 406: }
407: {
1.448 albertel 408: my $fh;
1.620 albertel 409: unless (open($fh,">$env{'user.environment'}")) {
1.448 albertel 410: return 'error';
411: }
412: unless (flock($fh,LOCK_EX)) {
1.672 albertel 413: &logthis("<font color=\"blue\">WARNING: ".
1.448 albertel 414: 'Could not obtain exclusive lock in delenv: '.$!);
415: close($fh);
416: return 'error: '.$!;
417: }
1.692 albertel 418: foreach my $cur_key (@oldenv) {
1.726 albertel 419: my $unescaped_cur_key = &unescape($cur_key);
420: if ($unescaped_cur_key=~/^$delthis/) {
421: my ($key) = split('=',$cur_key,2);
422: $key = &unescape($key);
1.619 albertel 423: delete($env{$key});
1.473 matthew 424: } else {
1.692 albertel 425: print $fh $cur_key;
1.473 matthew 426: }
1.448 albertel 427: }
428: close($fh);
1.5 www 429: }
430: return 'ok';
1.369 albertel 431: }
432:
433: # ------------------------------------------ Find out current server userload
434: # there is a copy in lond
435: sub userload {
436: my $numusers=0;
437: {
438: opendir(LONIDS,$perlvar{'lonIDsDir'});
439: my $filename;
440: my $curtime=time;
441: while ($filename=readdir(LONIDS)) {
442: if ($filename eq '.' || $filename eq '..') {next;}
1.404 albertel 443: my ($mtime)=(stat($perlvar{'lonIDsDir'}.'/'.$filename))[9];
1.437 albertel 444: if ($curtime-$mtime < 1800) { $numusers++; }
1.369 albertel 445: }
446: closedir(LONIDS);
447: }
448: my $userloadpercent=0;
449: my $maxuserload=$perlvar{'lonUserLoadLim'};
450: if ($maxuserload) {
1.371 albertel 451: $userloadpercent=100*$numusers/$maxuserload;
1.369 albertel 452: }
1.372 albertel 453: $userloadpercent=sprintf("%.2f",$userloadpercent);
1.369 albertel 454: return $userloadpercent;
1.283 www 455: }
456:
457: # ------------------------------------------ Fight off request when overloaded
458:
459: sub overloaderror {
460: my ($r,$checkserver)=@_;
461: unless ($checkserver) { $checkserver=$perlvar{'lonHostID'}; }
462: my $loadavg;
463: if ($checkserver eq $perlvar{'lonHostID'}) {
1.448 albertel 464: open(my $loadfile,'/proc/loadavg');
1.283 www 465: $loadavg=<$loadfile>;
466: $loadavg =~ s/\s.*//g;
1.285 matthew 467: $loadavg = 100*$loadavg/$perlvar{'lonLoadLim'};
1.448 albertel 468: close($loadfile);
1.283 www 469: } else {
470: $loadavg=&reply('load',$checkserver);
471: }
1.285 matthew 472: my $overload=$loadavg-100;
1.283 www 473: if ($overload>0) {
1.285 matthew 474: $r->err_headers_out->{'Retry-After'}=$overload;
1.283 www 475: $r->log_error('Overload of '.$overload.' on '.$checkserver);
1.554 www 476: return 413;
1.283 www 477: }
478: return '';
1.5 www 479: }
1.1 albertel 480:
481: # ------------------------------ Find server with least workload from spare.tab
1.11 www 482:
1.1 albertel 483: sub spareserver {
1.670 albertel 484: my ($loadpercent,$userloadpercent,$want_server_name) = @_;
1.1 albertel 485: my $tryserver;
486: my $spareserver='';
1.370 albertel 487: if ($userloadpercent !~ /\d/) { $userloadpercent=0; }
488: my $lowestserver=$loadpercent > $userloadpercent?
489: $loadpercent : $userloadpercent;
1.670 albertel 490: foreach $tryserver (keys(%spareid)) {
491: my $loadans=&reply('load',$tryserver);
492: my $userloadans=&reply('userload',$tryserver);
1.411 albertel 493: if ($loadans !~ /\d/ && $userloadans !~ /\d/) {
494: next; #didn't get a number from the server
495: }
496: my $answer;
497: if ($loadans =~ /\d/) {
498: if ($userloadans =~ /\d/) {
499: #both are numbers, pick the bigger one
500: $answer=$loadans > $userloadans?
501: $loadans : $userloadans;
502: } else {
503: $answer = $loadans;
504: }
505: } else {
506: $answer = $userloadans;
507: }
508: if (($answer =~ /\d/) && ($answer<$lowestserver)) {
1.670 albertel 509: if ($want_server_name) {
510: $spareserver=$tryserver;
511: } else {
512: $spareserver="http://$hostname{$tryserver}";
513: }
1.411 albertel 514: $lowestserver=$answer;
515: }
1.370 albertel 516: }
1.1 albertel 517: return $spareserver;
1.202 matthew 518: }
519:
520: # --------------------------------------------- Try to change a user's password
521:
522: sub changepass {
523: my ($uname,$udom,$currentpass,$newpass,$server)=@_;
524: $currentpass = &escape($currentpass);
525: $newpass = &escape($newpass);
526: my $answer = reply("encrypt:passwd:$udom:$uname:$currentpass:$newpass",
527: $server);
528: if (! $answer) {
529: &logthis("No reply on password change request to $server ".
530: "by $uname in domain $udom.");
531: } elsif ($answer =~ "^ok") {
532: &logthis("$uname in $udom successfully changed their password ".
533: "on $server.");
534: } elsif ($answer =~ "^pwchange_failure") {
535: &logthis("$uname in $udom was unable to change their password ".
536: "on $server. The action was blocked by either lcpasswd ".
537: "or pwchange");
538: } elsif ($answer =~ "^non_authorized") {
539: &logthis("$uname in $udom did not get their password correct when ".
540: "attempting to change it on $server.");
541: } elsif ($answer =~ "^auth_mode_error") {
542: &logthis("$uname in $udom attempted to change their password despite ".
543: "not being locally or internally authenticated on $server.");
544: } elsif ($answer =~ "^unknown_user") {
545: &logthis("$uname in $udom attempted to change their password ".
546: "on $server but were unable to because $server is not ".
547: "their home server.");
548: } elsif ($answer =~ "^refused") {
549: &logthis("$server refused to change $uname in $udom password because ".
550: "it was sent an unencrypted request to change the password.");
551: }
552: return $answer;
1.1 albertel 553: }
554:
1.169 harris41 555: # ----------------------- Try to determine user's current authentication scheme
556:
557: sub queryauthenticate {
558: my ($uname,$udom)=@_;
1.456 albertel 559: my $uhome=&homeserver($uname,$udom);
560: if (!$uhome) {
561: &logthis("User $uname at $udom is unknown when looking for authentication mechanism");
562: return 'no_host';
563: }
564: my $answer=reply("encrypt:currentauth:$udom:$uname",$uhome);
565: if ($answer =~ /^(unknown_user|refused|con_lost)/) {
566: &logthis("User $uname at $udom threw error $answer when checking authentication mechanism");
1.169 harris41 567: }
1.456 albertel 568: return $answer;
1.169 harris41 569: }
570:
1.1 albertel 571: # --------- Try to authenticate user from domain's lib servers (first this one)
1.11 www 572:
1.1 albertel 573: sub authenticate {
574: my ($uname,$upass,$udom)=@_;
1.12 www 575: $upass=escape($upass);
1.199 www 576: $uname=~s/\W//g;
1.471 albertel 577: my $uhome=&homeserver($uname,$udom);
578: if (!$uhome) {
579: &logthis("User $uname at $udom is unknown in authenticate");
580: return 'no_host';
1.1 albertel 581: }
1.471 albertel 582: my $answer=reply("encrypt:auth:$udom:$uname:$upass",$uhome);
583: if ($answer eq 'authorized') {
584: &logthis("User $uname at $udom authorized by $uhome");
585: return $uhome;
586: }
587: if ($answer eq 'non_authorized') {
588: &logthis("User $uname at $udom rejected by $uhome");
589: return 'no_host';
1.9 www 590: }
1.471 albertel 591: &logthis("User $uname at $udom threw error $answer when checking authentication mechanism");
1.1 albertel 592: return 'no_host';
593: }
594:
595: # ---------------------- Find the homebase for a user from domain's lib servers
1.11 www 596:
1.599 albertel 597: my %homecache;
1.1 albertel 598: sub homeserver {
1.230 stredwic 599: my ($uname,$udom,$ignoreBadCache)=@_;
1.1 albertel 600: my $index="$uname:$udom";
1.426 albertel 601:
1.599 albertel 602: if (exists($homecache{$index})) { return $homecache{$index}; }
1.1 albertel 603: my $tryserver;
604: foreach $tryserver (keys %libserv) {
1.230 stredwic 605: next if ($ignoreBadCache ne 'true' &&
1.231 stredwic 606: exists($badServerCache{$tryserver}));
1.1 albertel 607: if ($hostdom{$tryserver} eq $udom) {
608: my $answer=reply("home:$udom:$uname",$tryserver);
609: if ($answer eq 'found') {
1.599 albertel 610: return $homecache{$index}=$tryserver;
1.231 stredwic 611: } elsif ($answer eq 'no_host') {
612: $badServerCache{$tryserver}=1;
1.221 matthew 613: }
1.1 albertel 614: }
615: }
616: return 'no_host';
1.70 www 617: }
618:
619: # ------------------------------------- Find the usernames behind a list of IDs
620:
621: sub idget {
622: my ($udom,@ids)=@_;
623: my %returnhash=();
624:
625: my $tryserver;
626: foreach $tryserver (keys %libserv) {
627: if ($hostdom{$tryserver} eq $udom) {
628: my $idlist=join('&',@ids);
629: $idlist=~tr/A-Z/a-z/;
630: my $reply=&reply("idget:$udom:".$idlist,$tryserver);
631: my @answer=();
1.76 www 632: if (($reply ne 'con_lost') && ($reply!~/^error\:/)) {
1.70 www 633: @answer=split(/\&/,$reply);
634: } ;
635: my $i;
636: for ($i=0;$i<=$#ids;$i++) {
637: if ($answer[$i]) {
638: $returnhash{$ids[$i]}=$answer[$i];
639: }
640: }
641: }
642: }
643: return %returnhash;
644: }
645:
646: # ------------------------------------- Find the IDs behind a list of usernames
647:
648: sub idrget {
649: my ($udom,@unames)=@_;
650: my %returnhash=();
1.191 harris41 651: foreach (@unames) {
1.70 www 652: $returnhash{$_}=(&userenvironment($udom,$_,'id'))[1];
1.191 harris41 653: }
1.70 www 654: return %returnhash;
655: }
656:
657: # ------------------------------- Store away a list of names and associated IDs
658:
659: sub idput {
660: my ($udom,%ids)=@_;
661: my %servers=();
1.191 harris41 662: foreach (keys %ids) {
1.487 albertel 663: &cput('environment',{'id'=>$ids{$_}},$udom,$_);
1.70 www 664: my $uhom=&homeserver($_,$udom);
665: if ($uhom ne 'no_host') {
666: my $id=&escape($ids{$_});
667: $id=~tr/A-Z/a-z/;
668: my $unam=&escape($_);
669: if ($servers{$uhom}) {
670: $servers{$uhom}.='&'.$id.'='.$unam;
671: } else {
672: $servers{$uhom}=$id.'='.$unam;
673: }
674: }
1.191 harris41 675: }
676: foreach (keys %servers) {
1.70 www 677: &critical('idput:'.$udom.':'.$servers{$_},$_);
1.191 harris41 678: }
1.344 www 679: }
680:
681: # --------------------------------------------------- Assign a key to a student
682:
683: sub assign_access_key {
1.364 www 684: #
685: # a valid key looks like uname:udom#comments
686: # comments are being appended
687: #
1.498 www 688: my ($ckey,$kdom,$knum,$cdom,$cnum,$udom,$uname,$logentry)=@_;
689: $kdom=
1.620 albertel 690: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($kdom));
1.498 www 691: $knum=
1.620 albertel 692: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($knum));
1.344 www 693: $cdom=
1.620 albertel 694: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
1.344 www 695: $cnum=
1.620 albertel 696: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
697: $udom=$env{'user.name'} unless (defined($udom));
698: $uname=$env{'user.domain'} unless (defined($uname));
1.498 www 699: my %existing=&get('accesskeys',[$ckey],$kdom,$knum);
1.364 www 700: if (($existing{$ckey}=~/^\#(.*)$/) || # - new key
1.479 albertel 701: ($existing{$ckey}=~/^\Q$uname\E\:\Q$udom\E\#(.*)$/)) {
1.364 www 702: # assigned to this person
703: # - this should not happen,
1.345 www 704: # unless something went wrong
705: # the first time around
706: # ready to assign
1.364 www 707: $logentry=$1.'; '.$logentry;
1.496 www 708: if (&put('accesskeys',{$ckey=>$uname.':'.$udom.'#'.$logentry},
1.498 www 709: $kdom,$knum) eq 'ok') {
1.345 www 710: # key now belongs to user
1.346 www 711: my $envkey='key.'.$cdom.'_'.$cnum;
1.345 www 712: if (&put('environment',{$envkey => $ckey}) eq 'ok') {
713: &appenv('environment.'.$envkey => $ckey);
714: return 'ok';
715: } else {
716: return
717: 'error: Count not permanently assign key, will need to be re-entered later.';
718: }
719: } else {
720: return 'error: Could not assign key, try again later.';
721: }
1.364 www 722: } elsif (!$existing{$ckey}) {
1.345 www 723: # the key does not exist
724: return 'error: The key does not exist';
725: } else {
726: # the key is somebody else's
727: return 'error: The key is already in use';
728: }
1.344 www 729: }
730:
1.364 www 731: # ------------------------------------------ put an additional comment on a key
732:
733: sub comment_access_key {
734: #
735: # a valid key looks like uname:udom#comments
736: # comments are being appended
737: #
738: my ($ckey,$cdom,$cnum,$logentry)=@_;
739: $cdom=
1.620 albertel 740: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
1.364 www 741: $cnum=
1.620 albertel 742: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
1.364 www 743: my %existing=&get('accesskeys',[$ckey],$cdom,$cnum);
744: if ($existing{$ckey}) {
745: $existing{$ckey}.='; '.$logentry;
746: # ready to assign
1.367 www 747: if (&put('accesskeys',{$ckey=>$existing{$ckey}},
1.364 www 748: $cdom,$cnum) eq 'ok') {
749: return 'ok';
750: } else {
751: return 'error: Count not store comment.';
752: }
753: } else {
754: # the key does not exist
755: return 'error: The key does not exist';
756: }
757: }
758:
1.344 www 759: # ------------------------------------------------------ Generate a set of keys
760:
761: sub generate_access_keys {
1.364 www 762: my ($number,$cdom,$cnum,$logentry)=@_;
1.344 www 763: $cdom=
1.620 albertel 764: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
1.344 www 765: $cnum=
1.620 albertel 766: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
1.361 www 767: unless (&allowed('mky',$cdom)) { return 0; }
1.344 www 768: unless (($cdom) && ($cnum)) { return 0; }
769: if ($number>10000) { return 0; }
770: sleep(2); # make sure don't get same seed twice
771: srand(time()^($$+($$<<15))); # from "Programming Perl"
772: my $total=0;
773: for (my $i=1;$i<=$number;$i++) {
774: my $newkey=sprintf("%lx",int(100000*rand)).'-'.
775: sprintf("%lx",int(100000*rand)).'-'.
776: sprintf("%lx",int(100000*rand));
777: $newkey=~s/1/g/g; # folks mix up 1 and l
778: $newkey=~s/0/h/g; # and also 0 and O
779: my %existing=&get('accesskeys',[$newkey],$cdom,$cnum);
780: if ($existing{$newkey}) {
781: $i--;
782: } else {
1.364 www 783: if (&put('accesskeys',
784: { $newkey => '# generated '.localtime().
1.620 albertel 785: ' by '.$env{'user.name'}.'@'.$env{'user.domain'}.
1.364 www 786: '; '.$logentry },
787: $cdom,$cnum) eq 'ok') {
1.344 www 788: $total++;
789: }
790: }
791: }
1.620 albertel 792: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},
1.344 www 793: 'Generated '.$total.' keys for '.$cnum.' at '.$cdom);
794: return $total;
795: }
796:
797: # ------------------------------------------------------- Validate an accesskey
798:
799: sub validate_access_key {
800: my ($ckey,$cdom,$cnum,$udom,$uname)=@_;
801: $cdom=
1.620 albertel 802: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
1.344 www 803: $cnum=
1.620 albertel 804: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
805: $udom=$env{'user.domain'} unless (defined($udom));
806: $uname=$env{'user.name'} unless (defined($uname));
1.345 www 807: my %existing=&get('accesskeys',[$ckey],$cdom,$cnum);
1.479 albertel 808: return ($existing{$ckey}=~/^\Q$uname\E\:\Q$udom\E\#/);
1.70 www 809: }
810:
811: # ------------------------------------- Find the section of student in a course
1.652 albertel 812: sub devalidate_getsection_cache {
813: my ($udom,$unam,$courseid)=@_;
814: $courseid=~s/\_/\//g;
815: $courseid=~s/^(\w)/\/$1/;
816: my $hashid="$udom:$unam:$courseid";
817: &devalidate_cache_new('getsection',$hashid);
818: }
1.298 matthew 819:
820: sub getsection {
821: my ($udom,$unam,$courseid)=@_;
1.599 albertel 822: my $cachetime=1800;
1.298 matthew 823: $courseid=~s/\_/\//g;
824: $courseid=~s/^(\w)/\/$1/;
1.551 albertel 825:
826: my $hashid="$udom:$unam:$courseid";
1.599 albertel 827: my ($result,$cached)=&is_cached_new('getsection',$hashid);
1.551 albertel 828: if (defined($cached)) { return $result; }
829:
1.298 matthew 830: my %Pending;
831: my %Expired;
832: #
833: # Each role can either have not started yet (pending), be active,
834: # or have expired.
835: #
836: # If there is an active role, we are done.
837: #
838: # If there is more than one role which has not started yet,
839: # choose the one which will start sooner
840: # If there is one role which has not started yet, return it.
841: #
842: # If there is more than one expired role, choose the one which ended last.
843: # If there is a role which has expired, return it.
844: #
845: foreach (split(/\&/,&reply('dump:'.$udom.':'.$unam.':roles',
846: &homeserver($unam,$udom)))) {
847: my ($key,$value)=split(/\=/,$_);
848: $key=&unescape($key);
1.479 albertel 849: next if ($key !~/^\Q$courseid\E(?:\/)*(\w+)*\_st$/);
1.298 matthew 850: my $section=$1;
851: if ($key eq $courseid.'_st') { $section=''; }
852: my ($dummy,$end,$start)=split(/\_/,&unescape($value));
853: my $now=time;
1.548 albertel 854: if (defined($end) && $end && ($now > $end)) {
1.298 matthew 855: $Expired{$end}=$section;
856: next;
857: }
1.548 albertel 858: if (defined($start) && $start && ($now < $start)) {
1.298 matthew 859: $Pending{$start}=$section;
860: next;
861: }
1.599 albertel 862: return &do_cache_new('getsection',$hashid,$section,$cachetime);
1.298 matthew 863: }
864: #
865: # Presumedly there will be few matching roles from the above
866: # loop and the sorting time will be negligible.
867: if (scalar(keys(%Pending))) {
868: my ($time) = sort {$a <=> $b} keys(%Pending);
1.599 albertel 869: return &do_cache_new('getsection',$hashid,$Pending{$time},$cachetime);
1.298 matthew 870: }
871: if (scalar(keys(%Expired))) {
872: my @sorted = sort {$a <=> $b} keys(%Expired);
873: my $time = pop(@sorted);
1.599 albertel 874: return &do_cache_new('getsection',$hashid,$Expired{$time},$cachetime);
1.298 matthew 875: }
1.599 albertel 876: return &do_cache_new('getsection',$hashid,'-1',$cachetime);
1.298 matthew 877: }
1.70 www 878:
1.599 albertel 879: sub save_cache {
880: &purge_remembered();
1.722 albertel 881: #&Apache::loncommon::validate_page();
1.620 albertel 882: undef(%env);
1.599 albertel 883: }
1.452 albertel 884:
1.599 albertel 885: my $to_remember=-1;
886: my %remembered;
887: my %accessed;
888: my $kicks=0;
889: my $hits=0;
890: sub devalidate_cache_new {
891: my ($name,$id,$debug) = @_;
892: if ($debug) { &Apache::lonnet::logthis("deleting $name:$id"); }
893: $id=&escape($name.':'.$id);
894: $memcache->delete($id);
895: delete($remembered{$id});
896: delete($accessed{$id});
897: }
898:
899: sub is_cached_new {
900: my ($name,$id,$debug) = @_;
901: $id=&escape($name.':'.$id);
902: if (exists($remembered{$id})) {
903: if ($debug) { &Apache::lonnet::logthis("Earyl return $id of $remembered{$id} "); }
904: $accessed{$id}=[&gettimeofday()];
905: $hits++;
906: return ($remembered{$id},1);
907: }
908: my $value = $memcache->get($id);
909: if (!(defined($value))) {
910: if ($debug) { &Apache::lonnet::logthis("getting $id is not defined"); }
1.417 albertel 911: return (undef,undef);
1.416 albertel 912: }
1.599 albertel 913: if ($value eq '__undef__') {
914: if ($debug) { &Apache::lonnet::logthis("getting $id is __undef__"); }
915: $value=undef;
916: }
917: &make_room($id,$value,$debug);
918: if ($debug) { &Apache::lonnet::logthis("getting $id is $value"); }
919: return ($value,1);
920: }
921:
922: sub do_cache_new {
923: my ($name,$id,$value,$time,$debug) = @_;
924: $id=&escape($name.':'.$id);
925: my $setvalue=$value;
926: if (!defined($setvalue)) {
927: $setvalue='__undef__';
928: }
1.623 albertel 929: if (!defined($time) ) {
930: $time=600;
931: }
1.599 albertel 932: if ($debug) { &Apache::lonnet::logthis("Setting $id to $value"); }
1.600 albertel 933: $memcache->set($id,$setvalue,$time);
934: # need to make a copy of $value
935: #&make_room($id,$value,$debug);
1.599 albertel 936: return $value;
937: }
938:
939: sub make_room {
940: my ($id,$value,$debug)=@_;
941: $remembered{$id}=$value;
942: if ($to_remember<0) { return; }
943: $accessed{$id}=[&gettimeofday()];
944: if (scalar(keys(%remembered)) <= $to_remember) { return; }
945: my $to_kick;
946: my $max_time=0;
947: foreach my $other (keys(%accessed)) {
948: if (&tv_interval($accessed{$other}) > $max_time) {
949: $to_kick=$other;
950: $max_time=&tv_interval($accessed{$other});
951: }
952: }
953: delete($remembered{$to_kick});
954: delete($accessed{$to_kick});
955: $kicks++;
956: if ($debug) { &logthis("kicking $to_kick $max_time $kicks\n"); }
1.541 albertel 957: return;
958: }
959:
1.599 albertel 960: sub purge_remembered {
1.604 albertel 961: #&logthis("Tossing ".scalar(keys(%remembered)));
962: #&logthis(sprintf("%-20s is %s",'%remembered',length(&freeze(\%remembered))));
1.599 albertel 963: undef(%remembered);
964: undef(%accessed);
1.428 albertel 965: }
1.70 www 966: # ------------------------------------- Read an entry from a user's environment
967:
968: sub userenvironment {
969: my ($udom,$unam,@what)=@_;
970: my %returnhash=();
971: my @answer=split(/\&/,
972: &reply('get:'.$udom.':'.$unam.':environment:'.join('&',@what),
973: &homeserver($unam,$udom)));
974: my $i;
975: for ($i=0;$i<=$#what;$i++) {
976: $returnhash{$what[$i]}=&unescape($answer[$i]);
977: }
978: return %returnhash;
1.1 albertel 979: }
980:
1.617 albertel 981: # ---------------------------------------------------------- Get a studentphoto
982: sub studentphoto {
983: my ($udom,$unam,$ext) = @_;
984: my $home=&Apache::lonnet::homeserver($unam,$udom);
1.706 raeburn 985: if (defined($env{'request.course.id'})) {
1.708 raeburn 986: if ($env{'course.'.$env{'request.course.id'}.'.internal.showphoto'}) {
1.706 raeburn 987: if ($udom eq $env{'course.'.$env{'request.course.id'}.'.domain'}) {
988: return(&retrievestudentphoto($udom,$unam,$ext));
989: } else {
990: my ($result,$perm_reqd)=
1.707 albertel 991: &Apache::lonnet::auto_photo_permission($unam,$udom);
1.706 raeburn 992: if ($result eq 'ok') {
993: if (!($perm_reqd eq 'yes')) {
994: return(&retrievestudentphoto($udom,$unam,$ext));
995: }
996: }
997: }
998: }
999: } else {
1000: my ($result,$perm_reqd) =
1.707 albertel 1001: &Apache::lonnet::auto_photo_permission($unam,$udom);
1.706 raeburn 1002: if ($result eq 'ok') {
1003: if (!($perm_reqd eq 'yes')) {
1004: return(&retrievestudentphoto($udom,$unam,$ext));
1005: }
1006: }
1007: }
1008: return '/adm/lonKaputt/lonlogo_broken.gif';
1009: }
1010:
1011: sub retrievestudentphoto {
1012: my ($udom,$unam,$ext,$type) = @_;
1013: my $home=&Apache::lonnet::homeserver($unam,$udom);
1014: my $ret=&Apache::lonnet::reply("studentphoto:$udom:$unam:$ext:$type",$home);
1015: if ($ret eq 'ok') {
1016: my $url="/uploaded/$udom/$unam/internal/studentphoto.$ext";
1017: if ($type eq 'thumbnail') {
1018: $url="/uploaded/$udom/$unam/internal/studentphoto_tn.$ext";
1019: }
1020: my $tokenurl=&Apache::lonnet::tokenwrapper($url);
1021: return $tokenurl;
1022: } else {
1023: if ($type eq 'thumbnail') {
1024: return '/adm/lonKaputt/genericstudent_tn.gif';
1025: } else {
1026: return '/adm/lonKaputt/lonlogo_broken.gif';
1027: }
1.617 albertel 1028: }
1029: }
1030:
1.263 www 1031: # -------------------------------------------------------------------- New chat
1032:
1033: sub chatsend {
1.724 raeburn 1034: my ($newentry,$anon,$group)=@_;
1.620 albertel 1035: my $cnum=$env{'course.'.$env{'request.course.id'}.'.num'};
1036: my $cdom=$env{'course.'.$env{'request.course.id'}.'.domain'};
1037: my $chome=$env{'course.'.$env{'request.course.id'}.'.home'};
1.263 www 1038: &reply('chatsend:'.$cdom.':'.$cnum.':'.
1.620 albertel 1039: &escape($env{'user.domain'}.':'.$env{'user.name'}.':'.$anon.':'.
1.724 raeburn 1040: &escape($newentry)).':'.$group,$chome);
1.292 www 1041: }
1042:
1043: # ------------------------------------------ Find current version of a resource
1044:
1045: sub getversion {
1046: my $fname=&clutter(shift);
1047: unless ($fname=~/^\/res\//) { return -1; }
1048: return ¤tversion(&filelocation('',$fname));
1049: }
1050:
1051: sub currentversion {
1052: my $fname=shift;
1.599 albertel 1053: my ($result,$cached)=&is_cached_new('resversion',$fname);
1.440 www 1054: if (defined($cached)) { return $result; }
1.292 www 1055: my $author=$fname;
1056: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
1057: my ($udom,$uname)=split(/\//,$author);
1058: my $home=homeserver($uname,$udom);
1059: if ($home eq 'no_host') {
1060: return -1;
1061: }
1062: my $answer=reply("currentversion:$fname",$home);
1063: if (($answer eq 'con_lost') || ($answer eq 'rejected')) {
1064: return -1;
1065: }
1.599 albertel 1066: return &do_cache_new('resversion',$fname,$answer,600);
1.263 www 1067: }
1068:
1.1 albertel 1069: # ----------------------------- Subscribe to a resource, return URL if possible
1.11 www 1070:
1.1 albertel 1071: sub subscribe {
1072: my $fname=shift;
1.312 www 1073: if ($fname=~/\/(aboutme|syllabus|bulletinboard|smppg)$/) { return ''; }
1.532 albertel 1074: $fname=~s/[\n\r]//g;
1.1 albertel 1075: my $author=$fname;
1076: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
1077: my ($udom,$uname)=split(/\//,$author);
1078: my $home=homeserver($uname,$udom);
1.335 albertel 1079: if ($home eq 'no_host') {
1080: return 'not_found';
1.1 albertel 1081: }
1082: my $answer=reply("sub:$fname",$home);
1.64 www 1083: if (($answer eq 'con_lost') || ($answer eq 'rejected')) {
1084: $answer.=' by '.$home;
1085: }
1.1 albertel 1086: return $answer;
1087: }
1088:
1.8 www 1089: # -------------------------------------------------------------- Replicate file
1090:
1091: sub repcopy {
1092: my $filename=shift;
1.23 www 1093: $filename=~s/\/+/\//g;
1.607 raeburn 1094: if ($filename=~m|^/home/httpd/html/adm/|) { return 'ok'; }
1095: if ($filename=~m|^/home/httpd/html/lonUsers/|) { return 'ok'; }
1.538 albertel 1096: if ($filename=~m|^/home/httpd/html/userfiles/| or
1.609 banghart 1097: $filename=~m -^/*(uploaded|editupload)/-) {
1.538 albertel 1098: return &repcopy_userfile($filename);
1099: }
1.532 albertel 1100: $filename=~s/[\n\r]//g;
1.8 www 1101: my $transname="$filename.in.transfer";
1.607 raeburn 1102: if ((-e $filename) || (-e $transname)) { return 'ok'; }
1.8 www 1103: my $remoteurl=subscribe($filename);
1.64 www 1104: if ($remoteurl =~ /^con_lost by/) {
1105: &logthis("Subscribe returned $remoteurl: $filename");
1.607 raeburn 1106: return 'unavailable';
1.8 www 1107: } elsif ($remoteurl eq 'not_found') {
1.441 albertel 1108: #&logthis("Subscribe returned not_found: $filename");
1.607 raeburn 1109: return 'not_found';
1.64 www 1110: } elsif ($remoteurl =~ /^rejected by/) {
1111: &logthis("Subscribe returned $remoteurl: $filename");
1.607 raeburn 1112: return 'forbidden';
1.20 www 1113: } elsif ($remoteurl eq 'directory') {
1.607 raeburn 1114: return 'ok';
1.8 www 1115: } else {
1.290 www 1116: my $author=$filename;
1117: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
1118: my ($udom,$uname)=split(/\//,$author);
1119: my $home=homeserver($uname,$udom);
1120: unless ($home eq $perlvar{'lonHostID'}) {
1.8 www 1121: my @parts=split(/\//,$filename);
1122: my $path="/$parts[1]/$parts[2]/$parts[3]/$parts[4]";
1123: if ($path ne "$perlvar{'lonDocRoot'}/res") {
1124: &logthis("Malconfiguration for replication: $filename");
1.607 raeburn 1125: return 'bad_request';
1.8 www 1126: }
1127: my $count;
1128: for ($count=5;$count<$#parts;$count++) {
1129: $path.="/$parts[$count]";
1130: if ((-e $path)!=1) {
1131: mkdir($path,0777);
1132: }
1133: }
1134: my $ua=new LWP::UserAgent;
1135: my $request=new HTTP::Request('GET',"$remoteurl");
1136: my $response=$ua->request($request,$transname);
1137: if ($response->is_error()) {
1138: unlink($transname);
1139: my $message=$response->status_line;
1.672 albertel 1140: &logthis("<font color=\"blue\">WARNING:"
1.12 www 1141: ." LWP get: $message: $filename</font>");
1.607 raeburn 1142: return 'unavailable';
1.8 www 1143: } else {
1.16 www 1144: if ($remoteurl!~/\.meta$/) {
1145: my $mrequest=new HTTP::Request('GET',$remoteurl.'.meta');
1146: my $mresponse=$ua->request($mrequest,$filename.'.meta');
1147: if ($mresponse->is_error()) {
1148: unlink($filename.'.meta');
1149: &logthis(
1.672 albertel 1150: "<font color=\"yellow\">INFO: No metadata: $filename</font>");
1.16 www 1151: }
1152: }
1.8 www 1153: rename($transname,$filename);
1.607 raeburn 1154: return 'ok';
1.8 www 1155: }
1.290 www 1156: }
1.8 www 1157: }
1.330 www 1158: }
1159:
1160: # ------------------------------------------------ Get server side include body
1161: sub ssi_body {
1.381 albertel 1162: my ($filelink,%form)=@_;
1.606 matthew 1163: if (! exists($form{'LONCAPA_INTERNAL_no_discussion'})) {
1164: $form{'LONCAPA_INTERNAL_no_discussion'}='true';
1165: }
1.330 www 1166: my $output=($filelink=~/^http\:/?&externalssi($filelink):
1.381 albertel 1167: &ssi($filelink,%form));
1.565 albertel 1168: $output=~s|//(\s*<!--)? BEGIN LON-CAPA Internal.+// END LON-CAPA Internal\s*(-->)?\s||gs;
1.451 albertel 1169: $output=~s/^.*?\<body[^\>]*\>//si;
1170: $output=~s/(.*)\<\/body\s*\>.*?$/$1/si;
1.330 www 1171: return $output;
1.8 www 1172: }
1173:
1.15 www 1174: # --------------------------------------------------------- Server Side Include
1175:
1176: sub ssi {
1177:
1.23 www 1178: my ($fn,%form)=@_;
1.15 www 1179:
1180: my $ua=new LWP::UserAgent;
1.23 www 1181:
1182: my $request;
1.711 albertel 1183:
1184: $form{'no_update_last_known'}=1;
1185:
1.23 www 1186: if (%form) {
1187: $request=new HTTP::Request('POST',"http://".$ENV{'HTTP_HOST'}.$fn);
1.201 albertel 1188: $request->content(join('&',map { &escape($_).'='.&escape($form{$_}) } keys %form));
1.23 www 1189: } else {
1190: $request=new HTTP::Request('GET',"http://".$ENV{'HTTP_HOST'}.$fn);
1191: }
1192:
1.15 www 1193: $request->header(Cookie => $ENV{'HTTP_COOKIE'});
1194: my $response=$ua->request($request);
1195:
1.324 www 1196: return $response->content;
1197: }
1198:
1199: sub externalssi {
1200: my ($url)=@_;
1201: my $ua=new LWP::UserAgent;
1202: my $request=new HTTP::Request('GET',$url);
1203: my $response=$ua->request($request);
1.15 www 1204: return $response->content;
1205: }
1.254 www 1206:
1.492 albertel 1207: # -------------------------------- Allow a /uploaded/ URI to be vouched for
1208:
1209: sub allowuploaded {
1210: my ($srcurl,$url)=@_;
1211: $url=&clutter(&declutter($url));
1212: my $dir=$url;
1213: $dir=~s/\/[^\/]+$//;
1214: my %httpref=();
1215: my $httpurl=&hreflocation('',$url);
1216: $httpref{'httpref.'.$httpurl}=$srcurl;
1217: &Apache::lonnet::appenv(%httpref);
1.254 www 1218: }
1.477 raeburn 1219:
1.478 albertel 1220: # --------- File operations in /home/httpd/html/userfiles/$domain/1/2/3/$course
1.638 albertel 1221: # input: action, courseID, current domain, intended
1.637 raeburn 1222: # path to file, source of file, instruction to parse file for objects,
1223: # ref to hash for embedded objects,
1224: # ref to hash for codebase of java objects.
1225: #
1.485 raeburn 1226: # output: url to file (if action was uploaddoc),
1227: # ok if successful, or diagnostic message otherwise (if action was propagate or copy)
1.477 raeburn 1228: #
1.478 albertel 1229: # Allows directory structure to be used within lonUsers/../userfiles/ for a
1230: # course.
1.477 raeburn 1231: #
1.478 albertel 1232: # action = propagate - /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
1233: # will be copied to /home/httpd/lonUsers/1/2/3/$course/userfiles in
1234: # course's home server.
1.477 raeburn 1235: #
1.478 albertel 1236: # action = copy - /home/httpd/html/userfiles/$domain/1/2/3/$course/$file will
1237: # be copied from $source (current location) to
1238: # /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
1239: # and will then be copied to
1240: # /home/httpd/lonUsers/$domain/1/2/3/$course/userfiles/$file in
1241: # course's home server.
1.485 raeburn 1242: #
1.481 raeburn 1243: # action = uploaddoc - /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
1.620 albertel 1244: # will be retrived from $env{form.uploaddoc} (from DOCS interface) to
1.481 raeburn 1245: # /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
1246: # and will then be copied to /home/httpd/lonUsers/1/2/3/$course/userfiles/$file
1247: # in course's home server.
1.637 raeburn 1248: #
1.477 raeburn 1249:
1250: sub process_coursefile {
1.638 albertel 1251: my ($action,$docuname,$docudom,$file,$source,$parser,$allfiles,$codebase)=@_;
1.477 raeburn 1252: my $fetchresult;
1.638 albertel 1253: my $home=&homeserver($docuname,$docudom);
1.477 raeburn 1254: if ($action eq 'propagate') {
1.638 albertel 1255: $fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
1256: $home);
1.481 raeburn 1257: } else {
1.477 raeburn 1258: my $fpath = '';
1259: my $fname = $file;
1.478 albertel 1260: ($fpath,$fname) = ($file =~ m|^(.*)/([^/]+)$|);
1.477 raeburn 1261: $fpath=$docudom.'/'.$docuname.'/'.$fpath;
1.637 raeburn 1262: my $filepath = &build_filepath($fpath);
1.481 raeburn 1263: if ($action eq 'copy') {
1264: if ($source eq '') {
1265: $fetchresult = 'no source file';
1266: return $fetchresult;
1267: } else {
1268: my $destination = $filepath.'/'.$fname;
1269: rename($source,$destination);
1270: $fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
1.638 albertel 1271: $home);
1.481 raeburn 1272: }
1273: } elsif ($action eq 'uploaddoc') {
1274: open(my $fh,'>'.$filepath.'/'.$fname);
1.620 albertel 1275: print $fh $env{'form.'.$source};
1.481 raeburn 1276: close($fh);
1.637 raeburn 1277: if ($parser eq 'parse') {
1278: my $parse_result = &extract_embedded_items($filepath,$fname,$allfiles,$codebase);
1279: unless ($parse_result eq 'ok') {
1280: &logthis('Failed to parse '.$filepath.'/'.$fname.' for embedded media: '.$parse_result);
1281: }
1282: }
1.477 raeburn 1283: $fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
1.638 albertel 1284: $home);
1.481 raeburn 1285: if ($fetchresult eq 'ok') {
1286: return '/uploaded/'.$fpath.'/'.$fname;
1287: } else {
1288: &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$file.
1.638 albertel 1289: ' to host '.$home.': '.$fetchresult);
1.481 raeburn 1290: return '/adm/notfound.html';
1291: }
1.477 raeburn 1292: }
1293: }
1.485 raeburn 1294: unless ( $fetchresult eq 'ok') {
1.477 raeburn 1295: &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$file.
1.638 albertel 1296: ' to host '.$home.': '.$fetchresult);
1.477 raeburn 1297: }
1298: return $fetchresult;
1299: }
1300:
1.637 raeburn 1301: sub build_filepath {
1302: my ($fpath) = @_;
1303: my $filepath=$perlvar{'lonDocRoot'}.'/userfiles';
1304: unless ($fpath eq '') {
1305: my @parts=split('/',$fpath);
1306: foreach my $part (@parts) {
1307: $filepath.= '/'.$part;
1308: if ((-e $filepath)!=1) {
1309: mkdir($filepath,0777);
1310: }
1311: }
1312: }
1313: return $filepath;
1314: }
1315:
1316: sub store_edited_file {
1.638 albertel 1317: my ($primary_url,$content,$docudom,$docuname,$fetchresult) = @_;
1.637 raeburn 1318: my $file = $primary_url;
1319: $file =~ s#^/uploaded/$docudom/$docuname/##;
1320: my $fpath = '';
1321: my $fname = $file;
1322: ($fpath,$fname) = ($file =~ m|^(.*)/([^/]+)$|);
1323: $fpath=$docudom.'/'.$docuname.'/'.$fpath;
1324: my $filepath = &build_filepath($fpath);
1325: open(my $fh,'>'.$filepath.'/'.$fname);
1326: print $fh $content;
1327: close($fh);
1.638 albertel 1328: my $home=&homeserver($docuname,$docudom);
1.637 raeburn 1329: $$fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
1.638 albertel 1330: $home);
1.637 raeburn 1331: if ($$fetchresult eq 'ok') {
1332: return '/uploaded/'.$fpath.'/'.$fname;
1333: } else {
1.638 albertel 1334: &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$file.
1335: ' to host '.$home.': '.$$fetchresult);
1.637 raeburn 1336: return '/adm/notfound.html';
1337: }
1338: }
1339:
1.531 albertel 1340: sub clean_filename {
1341: my ($fname)=@_;
1.315 www 1342: # Replace Windows backslashes by forward slashes
1.257 www 1343: $fname=~s/\\/\//g;
1.315 www 1344: # Get rid of everything but the actual filename
1.257 www 1345: $fname=~s/^.*\/([^\/]+)$/$1/;
1.315 www 1346: # Replace spaces by underscores
1347: $fname=~s/\s+/\_/g;
1348: # Replace all other weird characters by nothing
1.317 www 1349: $fname=~s/[^\w\.\-]//g;
1.540 albertel 1350: # Replace all .\d. sequences with _\d. so they no longer look like version
1351: # numbers
1352: $fname=~s/\.(\d+)(?=\.)/_$1/g;
1.531 albertel 1353: return $fname;
1354: }
1355:
1.608 albertel 1356: # --------------- Take an uploaded file and put it into the userfiles directory
1.686 albertel 1357: # input: $formname - the contents of the file are in $env{"form.$formname"}
1.719 banghart 1358: # the desired filenam is in $env{"form.$formname.filename"}
1.686 albertel 1359: # $coursedoc - if true up to the current course
1360: # if false
1361: # $subdir - directory in userfile to store the file into
1362: # $parser, $allfiles, $codebase - unknown
1363: #
1364: # output: url of file in userspace, or error: <message>
1365: # or /adm/notfound.html if failure to upload occurse
1.608 albertel 1366:
1367:
1.531 albertel 1368: sub userfileupload {
1.719 banghart 1369: my ($formname,$coursedoc,$subdir,$parser,$allfiles,$codebase,$destuname,$destudom)=@_;
1.531 albertel 1370: if (!defined($subdir)) { $subdir='unknown'; }
1.620 albertel 1371: my $fname=$env{'form.'.$formname.'.filename'};
1.531 albertel 1372: $fname=&clean_filename($fname);
1.315 www 1373: # See if there is anything left
1.257 www 1374: unless ($fname) { return 'error: no uploaded file'; }
1.620 albertel 1375: chop($env{'form.'.$formname});
1.523 raeburn 1376: if (($formname eq 'screenshot') && ($subdir eq 'helprequests')) { #files uploaded to help request form are handled differently
1377: my $now = time;
1378: my $filepath = 'tmp/helprequests/'.$now;
1379: my @parts=split(/\//,$filepath);
1380: my $fullpath = $perlvar{'lonDaemons'};
1381: for (my $i=0;$i<@parts;$i++) {
1382: $fullpath .= '/'.$parts[$i];
1383: if ((-e $fullpath)!=1) {
1384: mkdir($fullpath,0777);
1385: }
1386: }
1387: open(my $fh,'>'.$fullpath.'/'.$fname);
1.620 albertel 1388: print $fh $env{'form.'.$formname};
1.523 raeburn 1389: close($fh);
1.741 ! raeburn 1390: return $fullpath.'/'.$fname;
! 1391: } elsif (($formname eq 'coursecreatorxml') && ($subdir eq 'batchupload')) { #files uploaded to create course page are handled differently
! 1392: my $filepath = 'tmp/addcourse/'.$destudom.'/web/'.$env{'user.name'}.
! 1393: '_'.$env{'user.domain'}.'/pending';
! 1394: my @parts=split(/\//,$filepath);
! 1395: my $fullpath = $perlvar{'lonDaemons'};
! 1396: for (my $i=0;$i<@parts;$i++) {
! 1397: $fullpath .= '/'.$parts[$i];
! 1398: if ((-e $fullpath)!=1) {
! 1399: mkdir($fullpath,0777);
! 1400: }
! 1401: }
! 1402: open(my $fh,'>'.$fullpath.'/'.$fname);
! 1403: print $fh $env{'form.'.$formname};
! 1404: close($fh);
! 1405: return $fullpath.'/'.$fname;
1.523 raeburn 1406: }
1.719 banghart 1407:
1.258 www 1408: # Create the directory if not present
1.493 albertel 1409: $fname="$subdir/$fname";
1.259 www 1410: if ($coursedoc) {
1.638 albertel 1411: my $docuname=$env{'course.'.$env{'request.course.id'}.'.num'};
1412: my $docudom=$env{'course.'.$env{'request.course.id'}.'.domain'};
1.646 raeburn 1413: if ($env{'form.folder'} =~ m/^(default|supplemental)/) {
1.638 albertel 1414: return &finishuserfileupload($docuname,$docudom,
1415: $formname,$fname,$parser,$allfiles,
1416: $codebase);
1.481 raeburn 1417: } else {
1.620 albertel 1418: $fname=$env{'form.folder'}.'/'.$fname;
1.638 albertel 1419: return &process_coursefile('uploaddoc',$docuname,$docudom,
1420: $fname,$formname,$parser,
1421: $allfiles,$codebase);
1.481 raeburn 1422: }
1.719 banghart 1423: } elsif (defined($destuname)) {
1424: my $docuname=$destuname;
1425: my $docudom=$destudom;
1426: return &finishuserfileupload($docuname,$docudom,$formname,
1427: $fname,$parser,$allfiles,$codebase);
1428:
1.259 www 1429: } else {
1.638 albertel 1430: my $docuname=$env{'user.name'};
1431: my $docudom=$env{'user.domain'};
1.714 raeburn 1432: if (exists($env{'form.group'})) {
1433: $docuname=$env{'course.'.$env{'request.course.id'}.'.num'};
1434: $docudom=$env{'course.'.$env{'request.course.id'}.'.domain'};
1435: }
1.638 albertel 1436: return &finishuserfileupload($docuname,$docudom,$formname,
1437: $fname,$parser,$allfiles,$codebase);
1.259 www 1438: }
1.271 www 1439: }
1440:
1441: sub finishuserfileupload {
1.638 albertel 1442: my ($docuname,$docudom,$formname,$fname,$parser,$allfiles,$codebase) = @_;
1.477 raeburn 1443: my $path=$docudom.'/'.$docuname.'/';
1.258 www 1444: my $filepath=$perlvar{'lonDocRoot'};
1.494 albertel 1445: my ($fnamepath,$file);
1446: $file=$fname;
1447: if ($fname=~m|/|) {
1448: ($fnamepath,$file) = ($fname =~ m|^(.*)/([^/]+)$|);
1449: $path.=$fnamepath.'/';
1450: }
1.259 www 1451: my @parts=split(/\//,$filepath.'/userfiles/'.$path);
1.258 www 1452: my $count;
1453: for ($count=4;$count<=$#parts;$count++) {
1454: $filepath.="/$parts[$count]";
1455: if ((-e $filepath)!=1) {
1456: mkdir($filepath,0777);
1457: }
1458: }
1459: # Save the file
1460: {
1.701 albertel 1461: if (!open(FH,'>'.$filepath.'/'.$file)) {
1462: &logthis('Failed to create '.$filepath.'/'.$file);
1463: print STDERR ('Failed to create '.$filepath.'/'.$file."\n");
1464: return '/adm/notfound.html';
1465: }
1466: if (!print FH ($env{'form.'.$formname})) {
1467: &logthis('Failed to write to '.$filepath.'/'.$file);
1468: print STDERR ('Failed to write to '.$filepath.'/'.$file."\n");
1469: return '/adm/notfound.html';
1470: }
1.570 albertel 1471: close(FH);
1.258 www 1472: }
1.637 raeburn 1473: if ($parser eq 'parse') {
1.638 albertel 1474: my $parse_result = &extract_embedded_items($filepath,$file,$allfiles,
1475: $codebase);
1.637 raeburn 1476: unless ($parse_result eq 'ok') {
1.638 albertel 1477: &logthis('Failed to parse '.$filepath.$file.
1478: ' for embedded media: '.$parse_result);
1.637 raeburn 1479: }
1480: }
1.259 www 1481: # Notify homeserver to grep it
1482: #
1.638 albertel 1483: my $docuhome=&homeserver($docuname,$docudom);
1.494 albertel 1484: my $fetchresult= &reply('fetchuserfile:'.$path.$file,$docuhome);
1.295 www 1485: if ($fetchresult eq 'ok') {
1.259 www 1486: #
1.258 www 1487: # Return the URL to it
1.494 albertel 1488: return '/uploaded/'.$path.$file;
1.263 www 1489: } else {
1.494 albertel 1490: &logthis('Failed to transfer '.$path.$file.' to host '.$docuhome.
1491: ': '.$fetchresult);
1.263 www 1492: return '/adm/notfound.html';
1493: }
1.493 albertel 1494: }
1495:
1.637 raeburn 1496: sub extract_embedded_items {
1.648 raeburn 1497: my ($filepath,$file,$allfiles,$codebase,$content) = @_;
1.637 raeburn 1498: my @state = ();
1499: my %javafiles = (
1500: codebase => '',
1501: code => '',
1502: archive => ''
1503: );
1504: my %mediafiles = (
1505: src => '',
1506: movie => '',
1507: );
1.648 raeburn 1508: my $p;
1509: if ($content) {
1510: $p = HTML::LCParser->new($content);
1511: } else {
1512: $p = HTML::LCParser->new($filepath.'/'.$file);
1513: }
1.641 albertel 1514: while (my $t=$p->get_token()) {
1.640 albertel 1515: if ($t->[0] eq 'S') {
1516: my ($tagname, $attr) = ($t->[1],$t->[2]);
1517: push (@state, $tagname);
1.648 raeburn 1518: if (lc($tagname) eq 'allow') {
1519: &add_filetype($allfiles,$attr->{'src'},'src');
1520: }
1.640 albertel 1521: if (lc($tagname) eq 'img') {
1522: &add_filetype($allfiles,$attr->{'src'},'src');
1523: }
1.645 raeburn 1524: if (lc($tagname) eq 'script') {
1525: if ($attr->{'archive'} =~ /\.jar$/i) {
1526: &add_filetype($allfiles,$attr->{'archive'},'archive');
1527: } else {
1528: &add_filetype($allfiles,$attr->{'src'},'src');
1529: }
1530: }
1531: if (lc($tagname) eq 'link') {
1532: if (lc($attr->{'rel'}) eq 'stylesheet') {
1533: &add_filetype($allfiles,$attr->{'href'},'href');
1534: }
1535: }
1.640 albertel 1536: if (lc($tagname) eq 'object' ||
1537: (lc($tagname) eq 'embed' && lc($state[-2]) ne 'object')) {
1538: foreach my $item (keys(%javafiles)) {
1539: $javafiles{$item} = '';
1540: }
1541: }
1542: if (lc($state[-2]) eq 'object' && lc($tagname) eq 'param') {
1543: my $name = lc($attr->{'name'});
1544: foreach my $item (keys(%javafiles)) {
1545: if ($name eq $item) {
1546: $javafiles{$item} = $attr->{'value'};
1547: last;
1548: }
1549: }
1550: foreach my $item (keys(%mediafiles)) {
1551: if ($name eq $item) {
1552: &add_filetype($allfiles, $attr->{'value'}, 'value');
1553: last;
1554: }
1555: }
1556: }
1557: if (lc($tagname) eq 'embed' || lc($tagname) eq 'applet') {
1558: foreach my $item (keys(%javafiles)) {
1559: if ($attr->{$item}) {
1560: $javafiles{$item} = $attr->{$item};
1561: last;
1562: }
1563: }
1564: foreach my $item (keys(%mediafiles)) {
1565: if ($attr->{$item}) {
1566: &add_filetype($allfiles,$attr->{$item},$item);
1567: last;
1568: }
1569: }
1570: }
1571: } elsif ($t->[0] eq 'E') {
1572: my ($tagname) = ($t->[1]);
1573: if ($javafiles{'codebase'} ne '') {
1574: $javafiles{'codebase'} .= '/';
1575: }
1576: if (lc($tagname) eq 'applet' ||
1577: lc($tagname) eq 'object' ||
1578: (lc($tagname) eq 'embed' && lc($state[-2]) ne 'object')
1579: ) {
1580: foreach my $item (keys(%javafiles)) {
1581: if ($item ne 'codebase' && $javafiles{$item} ne '') {
1582: my $file=$javafiles{'codebase'}.$javafiles{$item};
1583: &add_filetype($allfiles,$file,$item);
1584: }
1585: }
1586: }
1587: pop @state;
1588: }
1589: }
1.637 raeburn 1590: return 'ok';
1591: }
1592:
1.639 albertel 1593: sub add_filetype {
1594: my ($allfiles,$file,$type)=@_;
1595: if (exists($allfiles->{$file})) {
1596: unless (grep/^\Q$type\E$/, @{$allfiles->{$file}}) {
1597: push(@{$allfiles->{$file}}, &escape($type));
1598: }
1599: } else {
1600: @{$allfiles->{$file}} = (&escape($type));
1.637 raeburn 1601: }
1602: }
1603:
1.493 albertel 1604: sub removeuploadedurl {
1605: my ($url)=@_;
1606: my (undef,undef,$udom,$uname,$fname)=split('/',$url,5);
1.613 albertel 1607: return &removeuserfile($uname,$udom,$fname);
1.490 albertel 1608: }
1609:
1610: sub removeuserfile {
1611: my ($docuname,$docudom,$fname)=@_;
1612: my $home=&homeserver($docuname,$docudom);
1613: return &reply("removeuserfile:$docudom/$docuname/$fname",$home);
1.257 www 1614: }
1.15 www 1615:
1.530 albertel 1616: sub mkdiruserfile {
1617: my ($docuname,$docudom,$dir)=@_;
1618: my $home=&homeserver($docuname,$docudom);
1619: return &reply("mkdiruserfile:".&escape("$docudom/$docuname/$dir"),$home);
1620: }
1621:
1.531 albertel 1622: sub renameuserfile {
1623: my ($docuname,$docudom,$old,$new)=@_;
1624: my $home=&homeserver($docuname,$docudom);
1625: return &reply("renameuserfile:$docudom:$docuname:".&escape("$old").':'.
1626: &escape("$new"),$home);
1627: }
1628:
1.14 www 1629: # ------------------------------------------------------------------------- Log
1630:
1631: sub log {
1632: my ($dom,$nam,$hom,$what)=@_;
1.47 www 1633: return critical("log:$dom:$nam:$what",$hom);
1.157 www 1634: }
1635:
1636: # ------------------------------------------------------------------ Course Log
1.352 www 1637: #
1638: # This routine flushes several buffers of non-mission-critical nature
1639: #
1.157 www 1640:
1641: sub flushcourselogs {
1.352 www 1642: &logthis('Flushing log buffers');
1643: #
1644: # course logs
1645: # This is a log of all transactions in a course, which can be used
1646: # for data mining purposes
1647: #
1648: # It also collects the courseid database, which lists last transaction
1649: # times and course titles for all courseids
1650: #
1651: my %courseidbuffer=();
1.191 harris41 1652: foreach (keys %courselogs) {
1.157 www 1653: my $crsid=$_;
1.352 www 1654: if (&reply('log:'.$coursedombuf{$crsid}.':'.$coursenumbuf{$crsid}.':'.
1.188 www 1655: &escape($courselogs{$crsid}),
1656: $coursehombuf{$crsid}) eq 'ok') {
1.157 www 1657: delete $courselogs{$crsid};
1658: } else {
1659: &logthis('Failed to flush log buffer for '.$crsid);
1660: if (length($courselogs{$crsid})>40000) {
1.672 albertel 1661: &logthis("<font color=\"blue\">WARNING: Buffer for ".$crsid.
1.157 www 1662: " exceeded maximum size, deleting.</font>");
1663: delete $courselogs{$crsid};
1664: }
1.352 www 1665: }
1666: if ($courseidbuffer{$coursehombuf{$crsid}}) {
1667: $courseidbuffer{$coursehombuf{$crsid}}.='&'.
1.516 raeburn 1668: &escape($crsid).'='.&escape($coursedescrbuf{$crsid}).
1.741 ! raeburn 1669: ':'.&escape($courseinstcodebuf{$crsid}).':'.&escape($courseownerbuf{$crsid}).':'.&escape($coursetypebuf{$crsid});
1.352 www 1670: } else {
1671: $courseidbuffer{$coursehombuf{$crsid}}=
1.516 raeburn 1672: &escape($crsid).'='.&escape($coursedescrbuf{$crsid}).
1.741 ! raeburn 1673: ':'.&escape($courseinstcodebuf{$crsid}).':'.&escape($courseownerbuf{$crsid}).':'.&escape($coursetypebuf{$crsid});
1.571 raeburn 1674: }
1.191 harris41 1675: }
1.352 www 1676: #
1677: # Write course id database (reverse lookup) to homeserver of courses
1678: # Is used in pickcourse
1679: #
1680: foreach (keys %courseidbuffer) {
1.353 www 1681: &courseidput($hostdom{$_},$courseidbuffer{$_},$_);
1.352 www 1682: }
1683: #
1684: # File accesses
1685: # Writes to the dynamic metadata of resources to get hit counts, etc.
1686: #
1.449 matthew 1687: foreach my $entry (keys(%accesshash)) {
1.458 matthew 1688: if ($entry =~ /___count$/) {
1689: my ($dom,$name);
1690: ($dom,$name,undef)=($entry=~m:___(\w+)/(\w+)/(.*)___count$:);
1691: if (! defined($dom) || $dom eq '' ||
1692: ! defined($name) || $name eq '') {
1.620 albertel 1693: my $cid = $env{'request.course.id'};
1694: $dom = $env{'request.'.$cid.'.domain'};
1695: $name = $env{'request.'.$cid.'.num'};
1.458 matthew 1696: }
1.450 matthew 1697: my $value = $accesshash{$entry};
1698: my (undef,$url,undef) = ($entry =~ /^(.*)___(.*)___count$/);
1699: my %temphash=($url => $value);
1.449 matthew 1700: my $result = &inc('nohist_accesscount',\%temphash,$dom,$name);
1701: if ($result eq 'ok') {
1702: delete $accesshash{$entry};
1703: } elsif ($result eq 'unknown_cmd') {
1704: # Target server has old code running on it.
1.450 matthew 1705: my %temphash=($entry => $value);
1.449 matthew 1706: if (&put('nohist_resevaldata',\%temphash,$dom,$name) eq 'ok') {
1707: delete $accesshash{$entry};
1708: }
1709: }
1710: } else {
1.458 matthew 1711: my ($dom,$name) = ($entry=~m:___(\w+)/(\w+)/(.*)___(\w+)$:);
1.450 matthew 1712: my %temphash=($entry => $accesshash{$entry});
1.449 matthew 1713: if (&put('nohist_resevaldata',\%temphash,$dom,$name) eq 'ok') {
1714: delete $accesshash{$entry};
1715: }
1.185 www 1716: }
1.191 harris41 1717: }
1.352 www 1718: #
1719: # Roles
1720: # Reverse lookup of user roles for course faculty/staff and co-authorship
1721: #
1.349 www 1722: foreach (keys %userrolehash) {
1723: my $entry=$_;
1.351 www 1724: my ($role,$uname,$udom,$runame,$rudom,$rsec)=
1.349 www 1725: split(/\:/,$entry);
1726: if (&Apache::lonnet::put('nohist_userroles',
1.351 www 1727: { $role.':'.$uname.':'.$udom.':'.$rsec => $userrolehash{$entry} },
1.349 www 1728: $rudom,$runame) eq 'ok') {
1729: delete $userrolehash{$entry};
1730: }
1731: }
1.662 raeburn 1732: #
1733: # Reverse lookup of domain roles (dc, ad, li, sc, au)
1734: #
1735: my %domrolebuffer = ();
1736: foreach my $entry (keys %domainrolehash) {
1737: my ($role,$uname,$udom,$runame,$rudom,$rsec)=split/:/,$entry;
1738: if ($domrolebuffer{$rudom}) {
1739: $domrolebuffer{$rudom}.='&'.&escape($entry).
1740: '='.&escape($domainrolehash{$entry});
1741: } else {
1742: $domrolebuffer{$rudom}.=&escape($entry).
1743: '='.&escape($domainrolehash{$entry});
1744: }
1745: delete $domainrolehash{$entry};
1746: }
1747: foreach my $dom (keys(%domrolebuffer)) {
1748: foreach my $tryserver (keys %libserv) {
1749: if ($hostdom{$tryserver} eq $dom) {
1750: unless (&reply('domroleput:'.$dom.':'.
1751: $domrolebuffer{$dom},$tryserver) eq 'ok') {
1752: &logthis('Put of domain roles failed for '.$dom.' and '.$tryserver);
1753: }
1754: }
1755: }
1756: }
1.186 www 1757: $dumpcount++;
1.157 www 1758: }
1759:
1760: sub courselog {
1761: my $what=shift;
1.158 www 1762: $what=time.':'.$what;
1.620 albertel 1763: unless ($env{'request.course.id'}) { return ''; }
1764: $coursedombuf{$env{'request.course.id'}}=
1765: $env{'course.'.$env{'request.course.id'}.'.domain'};
1766: $coursenumbuf{$env{'request.course.id'}}=
1767: $env{'course.'.$env{'request.course.id'}.'.num'};
1768: $coursehombuf{$env{'request.course.id'}}=
1769: $env{'course.'.$env{'request.course.id'}.'.home'};
1770: $coursedescrbuf{$env{'request.course.id'}}=
1771: $env{'course.'.$env{'request.course.id'}.'.description'};
1772: $courseinstcodebuf{$env{'request.course.id'}}=
1773: $env{'course.'.$env{'request.course.id'}.'.internal.coursecode'};
1774: $courseownerbuf{$env{'request.course.id'}}=
1775: $env{'course.'.$env{'request.course.id'}.'.internal.courseowner'};
1.741 ! raeburn 1776: $coursetypebuf{$env{'request.course.id'}}=
! 1777: $env{'course.'.$env{'request.course.id'}.'.type'};
1.620 albertel 1778: if (defined $courselogs{$env{'request.course.id'}}) {
1779: $courselogs{$env{'request.course.id'}}.='&'.$what;
1.157 www 1780: } else {
1.620 albertel 1781: $courselogs{$env{'request.course.id'}}.=$what;
1.157 www 1782: }
1.620 albertel 1783: if (length($courselogs{$env{'request.course.id'}})>4048) {
1.157 www 1784: &flushcourselogs();
1785: }
1.158 www 1786: }
1787:
1788: sub courseacclog {
1789: my $fnsymb=shift;
1.620 albertel 1790: unless ($env{'request.course.id'}) { return ''; }
1791: my $what=$fnsymb.':'.$env{'user.name'}.':'.$env{'user.domain'};
1.657 albertel 1792: if ($fnsymb=~/(problem|exam|quiz|assess|survey|form|task|page)$/) {
1.187 www 1793: $what.=':POST';
1.583 matthew 1794: # FIXME: Probably ought to escape things....
1.620 albertel 1795: foreach (keys %env) {
1.158 www 1796: if ($_=~/^form\.(.*)/) {
1.620 albertel 1797: $what.=':'.$1.'='.$env{$_};
1.158 www 1798: }
1.191 harris41 1799: }
1.583 matthew 1800: } elsif ($fnsymb =~ m:^/adm/searchcat:) {
1801: # FIXME: We should not be depending on a form parameter that someone
1802: # editing lonsearchcat.pm might change in the future.
1.620 albertel 1803: if ($env{'form.phase'} eq 'course_search') {
1.583 matthew 1804: $what.= ':POST';
1805: # FIXME: Probably ought to escape things....
1806: foreach my $element ('courseexp','crsfulltext','crsrelated',
1807: 'crsdiscuss') {
1.620 albertel 1808: $what.=':'.$element.'='.$env{'form.'.$element};
1.583 matthew 1809: }
1810: }
1.158 www 1811: }
1812: &courselog($what);
1.149 www 1813: }
1814:
1.185 www 1815: sub countacc {
1816: my $url=&declutter(shift);
1.458 matthew 1817: return if (! defined($url) || $url eq '');
1.620 albertel 1818: unless ($env{'request.course.id'}) { return ''; }
1819: $accesshash{$env{'request.course.id'}.'___'.$url.'___course'}=1;
1.281 www 1820: my $key=$$.$processmarker.'_'.$dumpcount.'___'.$url.'___count';
1.450 matthew 1821: $accesshash{$key}++;
1.185 www 1822: }
1.349 www 1823:
1.361 www 1824: sub linklog {
1825: my ($from,$to)=@_;
1826: $from=&declutter($from);
1827: $to=&declutter($to);
1828: $accesshash{$from.'___'.$to.'___comefrom'}=1;
1829: $accesshash{$to.'___'.$from.'___goto'}=1;
1830: }
1831:
1.349 www 1832: sub userrolelog {
1833: my ($trole,$username,$domain,$area,$tstart,$tend)=@_;
1.661 raeburn 1834: if (($trole=~/^ca/) || ($trole=~/^aa/) ||
1.662 raeburn 1835: ($trole=~/^in/) || ($trole=~/^cc/) ||
1.661 raeburn 1836: ($trole=~/^ep/) || ($trole=~/^cr/) ||
1837: ($trole=~/^ta/)) {
1.350 www 1838: my (undef,$rudom,$runame,$rsec)=split(/\//,$area);
1839: $userrolehash
1840: {$trole.':'.$username.':'.$domain.':'.$runame.':'.$rudom.':'.$rsec}
1.349 www 1841: =$tend.':'.$tstart;
1.662 raeburn 1842: }
1843: if (($trole=~/^dc/) || ($trole=~/^ad/) ||
1844: ($trole=~/^li/) || ($trole=~/^li/) ||
1845: ($trole=~/^au/) || ($trole=~/^dg/) ||
1846: ($trole=~/^sc/)) {
1847: my (undef,$rudom,$runame,$rsec)=split(/\//,$area);
1848: $domainrolehash
1849: {$trole.':'.$username.':'.$domain.':'.$runame.':'.$rudom.':'.$rsec}
1850: = $tend.':'.$tstart;
1851: }
1.351 www 1852: }
1853:
1854: sub get_course_adv_roles {
1855: my $cid=shift;
1.620 albertel 1856: $cid=$env{'request.course.id'} unless (defined($cid));
1.351 www 1857: my %coursehash=&coursedescription($cid);
1.470 www 1858: my %nothide=();
1859: foreach (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
1860: $nothide{join(':',split(/[\@\:]/,$_))}=1;
1861: }
1.351 www 1862: my %returnhash=();
1863: my %dumphash=
1864: &dump('nohist_userroles',$coursehash{'domain'},$coursehash{'num'});
1865: my $now=time;
1866: foreach (keys %dumphash) {
1867: my ($tend,$tstart)=split(/\:/,$dumphash{$_});
1868: if (($tstart) && ($tstart<0)) { next; }
1869: if (($tend) && ($tend<$now)) { next; }
1870: if (($tstart) && ($now<$tstart)) { next; }
1871: my ($role,$username,$domain,$section)=split(/\:/,$_);
1.576 albertel 1872: if ($username eq '' || $domain eq '') { next; }
1.470 www 1873: if ((&privileged($username,$domain)) &&
1874: (!$nothide{$username.':'.$domain})) { next; }
1.656 albertel 1875: if ($role eq 'cr') { next; }
1.351 www 1876: my $key=&plaintext($role);
1.656 albertel 1877: if ($role =~ /^cr/) {
1878: $key=(split('/',$role))[3];
1879: }
1.351 www 1880: if ($section) { $key.=' (Sec/Grp '.$section.')'; }
1881: if ($returnhash{$key}) {
1882: $returnhash{$key}.=','.$username.':'.$domain;
1883: } else {
1884: $returnhash{$key}=$username.':'.$domain;
1885: }
1.400 www 1886: }
1887: return %returnhash;
1888: }
1889:
1890: sub get_my_roles {
1891: my ($uname,$udom)=@_;
1.620 albertel 1892: unless (defined($uname)) { $uname=$env{'user.name'}; }
1893: unless (defined($udom)) { $udom=$env{'user.domain'}; }
1.400 www 1894: my %dumphash=
1895: &dump('nohist_userroles',$udom,$uname);
1896: my %returnhash=();
1897: my $now=time;
1898: foreach (keys %dumphash) {
1899: my ($tend,$tstart)=split(/\:/,$dumphash{$_});
1900: if (($tstart) && ($tstart<0)) { next; }
1901: if (($tend) && ($tend<$now)) { next; }
1902: if (($tstart) && ($now<$tstart)) { next; }
1903: my ($role,$username,$domain,$section)=split(/\:/,$_);
1904: $returnhash{$username.':'.$domain.':'.$role}=$tstart.':'.$tend;
1.373 www 1905: }
1906: return %returnhash;
1.399 www 1907: }
1908:
1909: # ----------------------------------------------------- Frontpage Announcements
1910: #
1911: #
1912:
1913: sub postannounce {
1914: my ($server,$text)=@_;
1915: unless (&allowed('psa',$hostdom{$server})) { return 'refused'; }
1916: unless ($text=~/\w/) { $text=''; }
1917: return &reply('setannounce:'.&escape($text),$server);
1918: }
1919:
1920: sub getannounce {
1.448 albertel 1921:
1922: if (open(my $fh,$perlvar{'lonDocRoot'}.'/announcement.txt')) {
1.399 www 1923: my $announcement='';
1924: while (<$fh>) { $announcement .=$_; }
1.448 albertel 1925: close($fh);
1.399 www 1926: if ($announcement=~/\w/) {
1927: return
1928: '<table bgcolor="#FF5555" cellpadding="5" cellspacing="3">'.
1.518 albertel 1929: '<tr><td bgcolor="#FFFFFF"><tt>'.$announcement.'</tt></td></tr></table>';
1.399 www 1930: } else {
1931: return '';
1932: }
1933: } else {
1934: return '';
1935: }
1.351 www 1936: }
1.353 www 1937:
1938: # ---------------------------------------------------------- Course ID routines
1939: # Deal with domain's nohist_courseid.db files
1940: #
1941:
1942: sub courseidput {
1943: my ($domain,$what,$coursehome)=@_;
1944: return &reply('courseidput:'.$domain.':'.$what,$coursehome);
1945: }
1946:
1947: sub courseiddump {
1.741 ! raeburn 1948: my ($domfilter,$descfilter,$sincefilter,$instcodefilter,$ownerfilter,$coursefilter,$hostidflag,$hostidref,$typefilter)=@_;
1.353 www 1949: my %returnhash=();
1.355 www 1950: unless ($domfilter) { $domfilter=''; }
1.353 www 1951: foreach my $tryserver (keys %libserv) {
1.511 raeburn 1952: if ( ($hostidflag == 1 && grep/^$tryserver$/,@{$hostidref}) || (!defined($hostidflag)) ) {
1.506 raeburn 1953: if ((!$domfilter) || ($hostdom{$tryserver} eq $domfilter)) {
1954: foreach (
1955: split(/\&/,&reply('courseiddump:'.$hostdom{$tryserver}.':'.
1.571 raeburn 1956: $sincefilter.':'.&escape($descfilter).':'.
1.741 ! raeburn 1957: &escape($instcodefilter).':'.&escape($ownerfilter).':'.&escape($coursefilter).':'.&escape($typefilter),
1.354 www 1958: $tryserver))) {
1.506 raeburn 1959: my ($key,$value)=split(/\=/,$_);
1960: if (($key) && ($value)) {
1.516 raeburn 1961: $returnhash{&unescape($key)}=$value;
1.506 raeburn 1962: }
1.353 www 1963: }
1964: }
1965: }
1966: }
1967: return %returnhash;
1968: }
1969:
1.658 raeburn 1970: # ---------------------------------------------------------- DC e-mail
1.662 raeburn 1971:
1972: sub dcmailput {
1.685 raeburn 1973: my ($domain,$msgid,$message,$server)=@_;
1.662 raeburn 1974: my $status = &Apache::lonnet::critical(
1.740 www 1975: 'dcmailput:'.$domain.':'.&escape($msgid).'='.
1976: &escape($message),$server);
1.662 raeburn 1977: return $status;
1978: }
1979:
1.658 raeburn 1980: sub dcmaildump {
1981: my ($dom,$startdate,$enddate,$senders) = @_;
1.685 raeburn 1982: my %returnhash=();
1983: if (exists($domain_primary{$dom})) {
1984: my $cmd='dcmaildump:'.$dom.':'.&escape($startdate).':'.
1985: &escape($enddate).':';
1986: my @esc_senders=map { &escape($_)} @$senders;
1987: $cmd.=&escape(join('&',@esc_senders));
1988: foreach (split(/\&/,&reply($cmd,$domain_primary{$dom}))) {
1989: my ($key,$value) = split(/\=/,$_);
1990: if (($key) && ($value)) {
1991: $returnhash{&unescape($key)} = &unescape($value);
1.658 raeburn 1992: }
1993: }
1994: }
1995: return %returnhash;
1996: }
1.662 raeburn 1997: # ---------------------------------------------------------- Domain roles
1998:
1999: sub get_domain_roles {
2000: my ($dom,$roles,$startdate,$enddate)=@_;
2001: if (undef($startdate) || $startdate eq '') {
2002: $startdate = '.';
2003: }
2004: if (undef($enddate) || $enddate eq '') {
2005: $enddate = '.';
2006: }
2007: my $rolelist = join(':',@{$roles});
2008: my %personnel = ();
2009: foreach my $tryserver (keys(%libserv)) {
2010: if ($hostdom{$tryserver} eq $dom) {
2011: %{$personnel{$tryserver}}=();
2012: foreach (
2013: split(/\&/,&reply('domrolesdump:'.$dom.':'.
2014: &escape($startdate).':'.&escape($enddate).':'.
2015: &escape($rolelist), $tryserver))) {
2016: my($key,$value) = split(/\=/,$_);
2017: if (($key) && ($value)) {
2018: $personnel{$tryserver}{&unescape($key)} = &unescape($value);
2019: }
2020: }
2021: }
2022: }
2023: return %personnel;
2024: }
1.658 raeburn 2025:
1.149 www 2026: # ----------------------------------------------------------- Check out an item
2027:
1.504 albertel 2028: sub get_first_access {
2029: my ($type,$argsymb)=@_;
2030: my ($symb,$courseid,$udom,$uname)=&Apache::lonxml::whichuser();
2031: if ($argsymb) { $symb=$argsymb; }
2032: my ($map,$id,$res)=&decode_symb($symb);
1.588 albertel 2033: if ($type eq 'map') {
2034: $res=&symbread($map);
2035: } else {
2036: $res=$symb;
2037: }
2038: my %times=&get('firstaccesstimes',["$courseid\0$res"],$udom,$uname);
2039: return $times{"$courseid\0$res"};
1.504 albertel 2040: }
2041:
2042: sub set_first_access {
2043: my ($type)=@_;
2044: my ($symb,$courseid,$udom,$uname)=&Apache::lonxml::whichuser();
2045: my ($map,$id,$res)=&decode_symb($symb);
1.588 albertel 2046: if ($type eq 'map') {
2047: $res=&symbread($map);
2048: } else {
2049: $res=$symb;
2050: }
2051: my $firstaccess=&get_first_access($type,$symb);
1.505 albertel 2052: if (!$firstaccess) {
1.588 albertel 2053: return &put('firstaccesstimes',{"$courseid\0$res"=>time},$udom,$uname);
1.505 albertel 2054: }
2055: return 'already_set';
1.504 albertel 2056: }
2057:
1.149 www 2058: sub checkout {
2059: my ($symb,$tuname,$tudom,$tcrsid)=@_;
2060: my $now=time;
2061: my $lonhost=$perlvar{'lonHostID'};
2062: my $infostr=&escape(
1.234 www 2063: 'CHECKOUTTOKEN&'.
1.149 www 2064: $tuname.'&'.
2065: $tudom.'&'.
2066: $tcrsid.'&'.
2067: $symb.'&'.
2068: $now.'&'.$ENV{'REMOTE_ADDR'});
2069: my $token=&reply('tmpput:'.$infostr,$lonhost);
1.151 www 2070: if ($token=~/^error\:/) {
1.672 albertel 2071: &logthis("<font color=\"blue\">WARNING: ".
1.151 www 2072: "Checkout tmpput failed ".$tudom.' - '.$tuname.' - '.$symb.
2073: "</font>");
2074: return '';
2075: }
2076:
1.149 www 2077: $token=~s/^(\d+)\_.*\_(\d+)$/$1\*$2\*$lonhost/;
2078: $token=~tr/a-z/A-Z/;
2079:
1.153 www 2080: my %infohash=('resource.0.outtoken' => $token,
2081: 'resource.0.checkouttime' => $now,
2082: 'resource.0.outremote' => $ENV{'REMOTE_ADDR'});
1.149 www 2083:
2084: unless (&cstore(\%infohash,$symb,$tcrsid,$tudom,$tuname) eq 'ok') {
2085: return '';
1.151 www 2086: } else {
1.672 albertel 2087: &logthis("<font color=\"blue\">WARNING: ".
1.151 www 2088: "Checkout cstore failed ".$tudom.' - '.$tuname.' - '.$symb.
2089: "</font>");
1.149 www 2090: }
2091:
2092: if (&log($tudom,$tuname,&homeserver($tuname,$tudom),
2093: &escape('Checkout '.$infostr.' - '.
2094: $token)) ne 'ok') {
2095: return '';
1.151 www 2096: } else {
1.672 albertel 2097: &logthis("<font color=\"blue\">WARNING: ".
1.151 www 2098: "Checkout log failed ".$tudom.' - '.$tuname.' - '.$symb.
2099: "</font>");
1.149 www 2100: }
1.151 www 2101: return $token;
1.149 www 2102: }
2103:
2104: # ------------------------------------------------------------ Check in an item
2105:
2106: sub checkin {
2107: my $token=shift;
1.150 www 2108: my $now=time;
2109: my ($ta,$tb,$lonhost)=split(/\*/,$token);
2110: $lonhost=~tr/A-Z/a-z/;
1.595 albertel 2111: my $dtoken=$ta.'_'.$hostname{$lonhost}.'_'.$tb;
1.150 www 2112: $dtoken=~s/\W/\_/g;
1.234 www 2113: my ($dummy,$tuname,$tudom,$tcrsid,$symb,$chtim,$rmaddr)=
1.150 www 2114: split(/\&/,&unescape(&reply('tmpget:'.$dtoken,$lonhost)));
2115:
1.154 www 2116: unless (($tuname) && ($tudom)) {
2117: &logthis('Check in '.$token.' ('.$dtoken.') failed');
2118: return '';
2119: }
2120:
2121: unless (&allowed('mgr',$tcrsid)) {
2122: &logthis('Check in '.$token.' ('.$dtoken.') unauthorized: '.
1.620 albertel 2123: $env{'user.name'}.' - '.$env{'user.domain'});
1.154 www 2124: return '';
2125: }
2126:
1.153 www 2127: my %infohash=('resource.0.intoken' => $token,
2128: 'resource.0.checkintime' => $now,
2129: 'resource.0.inremote' => $ENV{'REMOTE_ADDR'});
1.150 www 2130:
2131: unless (&cstore(\%infohash,$symb,$tcrsid,$tudom,$tuname) eq 'ok') {
2132: return '';
2133: }
2134:
2135: if (&log($tudom,$tuname,&homeserver($tuname,$tudom),
2136: &escape('Checkin - '.$token)) ne 'ok') {
2137: return '';
2138: }
2139:
2140: return ($symb,$tuname,$tudom,$tcrsid);
1.110 www 2141: }
2142:
2143: # --------------------------------------------- Set Expire Date for Spreadsheet
2144:
2145: sub expirespread {
2146: my ($uname,$udom,$stype,$usymb)=@_;
1.620 albertel 2147: my $cid=$env{'request.course.id'};
1.110 www 2148: if ($cid) {
2149: my $now=time;
2150: my $key=$uname.':'.$udom.':'.$stype.':'.$usymb;
1.620 albertel 2151: return &reply('put:'.$env{'course.'.$cid.'.domain'}.':'.
2152: $env{'course.'.$cid.'.num'}.
1.110 www 2153: ':nohist_expirationdates:'.
2154: &escape($key).'='.$now,
1.620 albertel 2155: $env{'course.'.$cid.'.home'})
1.110 www 2156: }
2157: return 'ok';
1.14 www 2158: }
2159:
1.109 www 2160: # ----------------------------------------------------- Devalidate Spreadsheets
2161:
2162: sub devalidate {
1.325 www 2163: my ($symb,$uname,$udom)=@_;
1.620 albertel 2164: my $cid=$env{'request.course.id'};
1.109 www 2165: if ($cid) {
1.391 matthew 2166: # delete the stored spreadsheets for
2167: # - the student level sheet of this user in course's homespace
2168: # - the assessment level sheet for this resource
2169: # for this user in user's homespace
1.553 albertel 2170: # - current conditional state info
1.325 www 2171: my $key=$uname.':'.$udom.':';
1.109 www 2172: my $status=
1.299 matthew 2173: &del('nohist_calculatedsheets',
1.391 matthew 2174: [$key.'studentcalc:'],
1.620 albertel 2175: $env{'course.'.$cid.'.domain'},
2176: $env{'course.'.$cid.'.num'})
1.133 albertel 2177: .' '.
2178: &del('nohist_calculatedsheets_'.$cid,
1.391 matthew 2179: [$key.'assesscalc:'.$symb],$udom,$uname);
1.109 www 2180: unless ($status eq 'ok ok') {
2181: &logthis('Could not devalidate spreadsheet '.
1.325 www 2182: $uname.' at '.$udom.' for '.
1.109 www 2183: $symb.': '.$status);
1.133 albertel 2184: }
1.553 albertel 2185: &delenv('user.state.'.$cid);
1.109 www 2186: }
2187: }
2188:
1.265 albertel 2189: sub get_scalar {
2190: my ($string,$end) = @_;
2191: my $value;
2192: if ($$string =~ s/^([^&]*?)($end)/$2/) {
2193: $value = $1;
2194: } elsif ($$string =~ s/^([^&]*?)&//) {
2195: $value = $1;
2196: }
2197: return &unescape($value);
2198: }
2199:
2200: sub array2str {
2201: my (@array) = @_;
2202: my $result=&arrayref2str(\@array);
2203: $result=~s/^__ARRAY_REF__//;
2204: $result=~s/__END_ARRAY_REF__$//;
2205: return $result;
2206: }
2207:
1.204 albertel 2208: sub arrayref2str {
2209: my ($arrayref) = @_;
1.265 albertel 2210: my $result='__ARRAY_REF__';
1.204 albertel 2211: foreach my $elem (@$arrayref) {
1.265 albertel 2212: if(ref($elem) eq 'ARRAY') {
2213: $result.=&arrayref2str($elem).'&';
2214: } elsif(ref($elem) eq 'HASH') {
2215: $result.=&hashref2str($elem).'&';
2216: } elsif(ref($elem)) {
2217: #print("Got a ref of ".(ref($elem))." skipping.");
1.204 albertel 2218: } else {
2219: $result.=&escape($elem).'&';
2220: }
2221: }
2222: $result=~s/\&$//;
1.265 albertel 2223: $result .= '__END_ARRAY_REF__';
1.204 albertel 2224: return $result;
2225: }
2226:
1.168 albertel 2227: sub hash2str {
1.204 albertel 2228: my (%hash) = @_;
2229: my $result=&hashref2str(\%hash);
1.265 albertel 2230: $result=~s/^__HASH_REF__//;
2231: $result=~s/__END_HASH_REF__$//;
1.204 albertel 2232: return $result;
2233: }
2234:
2235: sub hashref2str {
2236: my ($hashref)=@_;
1.265 albertel 2237: my $result='__HASH_REF__';
1.495 albertel 2238: foreach (sort(keys(%$hashref))) {
1.204 albertel 2239: if (ref($_) eq 'ARRAY') {
1.265 albertel 2240: $result.=&arrayref2str($_).'=';
1.204 albertel 2241: } elsif (ref($_) eq 'HASH') {
1.265 albertel 2242: $result.=&hashref2str($_).'=';
1.204 albertel 2243: } elsif (ref($_)) {
1.265 albertel 2244: $result.='=';
2245: #print("Got a ref of ".(ref($_))." skipping.");
1.204 albertel 2246: } else {
1.265 albertel 2247: if ($_) {$result.=&escape($_).'=';} else { last; }
1.204 albertel 2248: }
2249:
1.265 albertel 2250: if(ref($hashref->{$_}) eq 'ARRAY') {
2251: $result.=&arrayref2str($hashref->{$_}).'&';
2252: } elsif(ref($hashref->{$_}) eq 'HASH') {
2253: $result.=&hashref2str($hashref->{$_}).'&';
2254: } elsif(ref($hashref->{$_})) {
2255: $result.='&';
2256: #print("Got a ref of ".(ref($hashref->{$_}))." skipping.");
1.204 albertel 2257: } else {
1.265 albertel 2258: $result.=&escape($hashref->{$_}).'&';
1.204 albertel 2259: }
2260: }
1.168 albertel 2261: $result=~s/\&$//;
1.265 albertel 2262: $result .= '__END_HASH_REF__';
1.168 albertel 2263: return $result;
2264: }
2265:
2266: sub str2hash {
1.265 albertel 2267: my ($string)=@_;
2268: my ($hash)=&str2hashref('__HASH_REF__'.$string.'__END_HASH_REF__');
2269: return %$hash;
2270: }
2271:
2272: sub str2hashref {
1.168 albertel 2273: my ($string) = @_;
1.265 albertel 2274:
2275: my %hash;
2276:
2277: if($string !~ /^__HASH_REF__/) {
2278: if (! ($string eq '' || !defined($string))) {
2279: $hash{'error'}='Not hash reference';
2280: }
2281: return (\%hash, $string);
2282: }
2283:
2284: $string =~ s/^__HASH_REF__//;
2285:
2286: while($string !~ /^__END_HASH_REF__/) {
2287: #key
2288: my $key='';
2289: if($string =~ /^__HASH_REF__/) {
2290: ($key, $string)=&str2hashref($string);
2291: if(defined($key->{'error'})) {
2292: $hash{'error'}='Bad data';
2293: return (\%hash, $string);
2294: }
2295: } elsif($string =~ /^__ARRAY_REF__/) {
2296: ($key, $string)=&str2arrayref($string);
2297: if($key->[0] eq 'Array reference error') {
2298: $hash{'error'}='Bad data';
2299: return (\%hash, $string);
2300: }
2301: } else {
2302: $string =~ s/^(.*?)=//;
1.267 albertel 2303: $key=&unescape($1);
1.265 albertel 2304: }
2305: $string =~ s/^=//;
2306:
2307: #value
2308: my $value='';
2309: if($string =~ /^__HASH_REF__/) {
2310: ($value, $string)=&str2hashref($string);
2311: if(defined($value->{'error'})) {
2312: $hash{'error'}='Bad data';
2313: return (\%hash, $string);
2314: }
2315: } elsif($string =~ /^__ARRAY_REF__/) {
2316: ($value, $string)=&str2arrayref($string);
2317: if($value->[0] eq 'Array reference error') {
2318: $hash{'error'}='Bad data';
2319: return (\%hash, $string);
2320: }
2321: } else {
2322: $value=&get_scalar(\$string,'__END_HASH_REF__');
2323: }
2324: $string =~ s/^&//;
2325:
2326: $hash{$key}=$value;
1.204 albertel 2327: }
1.265 albertel 2328:
2329: $string =~ s/^__END_HASH_REF__//;
2330:
2331: return (\%hash, $string);
1.204 albertel 2332: }
2333:
2334: sub str2array {
1.265 albertel 2335: my ($string)=@_;
2336: my ($array)=&str2arrayref('__ARRAY_REF__'.$string.'__END_ARRAY_REF__');
2337: return @$array;
2338: }
2339:
2340: sub str2arrayref {
1.204 albertel 2341: my ($string) = @_;
1.265 albertel 2342: my @array;
2343:
2344: if($string !~ /^__ARRAY_REF__/) {
2345: if (! ($string eq '' || !defined($string))) {
2346: $array[0]='Array reference error';
2347: }
2348: return (\@array, $string);
2349: }
2350:
2351: $string =~ s/^__ARRAY_REF__//;
2352:
2353: while($string !~ /^__END_ARRAY_REF__/) {
2354: my $value='';
2355: if($string =~ /^__HASH_REF__/) {
2356: ($value, $string)=&str2hashref($string);
2357: if(defined($value->{'error'})) {
2358: $array[0] ='Array reference error';
2359: return (\@array, $string);
2360: }
2361: } elsif($string =~ /^__ARRAY_REF__/) {
2362: ($value, $string)=&str2arrayref($string);
2363: if($value->[0] eq 'Array reference error') {
2364: $array[0] ='Array reference error';
2365: return (\@array, $string);
2366: }
2367: } else {
2368: $value=&get_scalar(\$string,'__END_ARRAY_REF__');
2369: }
2370: $string =~ s/^&//;
2371:
2372: push(@array, $value);
1.191 harris41 2373: }
1.265 albertel 2374:
2375: $string =~ s/^__END_ARRAY_REF__//;
2376:
2377: return (\@array, $string);
1.168 albertel 2378: }
2379:
1.167 albertel 2380: # -------------------------------------------------------------------Temp Store
2381:
1.168 albertel 2382: sub tmpreset {
2383: my ($symb,$namespace,$domain,$stuname) = @_;
2384: if (!$symb) {
2385: $symb=&symbread();
1.620 albertel 2386: if (!$symb) { $symb= $env{'request.url'}; }
1.168 albertel 2387: }
2388: $symb=escape($symb);
2389:
1.620 albertel 2390: if (!$namespace) { $namespace=$env{'request.state'}; }
1.168 albertel 2391: $namespace=~s/\//\_/g;
2392: $namespace=~s/\W//g;
2393:
1.620 albertel 2394: if (!$domain) { $domain=$env{'user.domain'}; }
2395: if (!$stuname) { $stuname=$env{'user.name'}; }
1.591 albertel 2396: if ($domain eq 'public' && $stuname eq 'public') {
2397: $stuname=$ENV{'REMOTE_ADDR'};
2398: }
1.168 albertel 2399: my $path=$perlvar{'lonDaemons'}.'/tmp';
2400: my %hash;
2401: if (tie(%hash,'GDBM_File',
2402: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
1.256 albertel 2403: &GDBM_WRCREAT(),0640)) {
1.168 albertel 2404: foreach my $key (keys %hash) {
1.180 albertel 2405: if ($key=~ /:$symb/) {
1.168 albertel 2406: delete($hash{$key});
2407: }
2408: }
2409: }
2410: }
2411:
1.167 albertel 2412: sub tmpstore {
1.168 albertel 2413: my ($storehash,$symb,$namespace,$domain,$stuname) = @_;
2414:
2415: if (!$symb) {
2416: $symb=&symbread();
1.620 albertel 2417: if (!$symb) { $symb= $env{'request.url'}; }
1.168 albertel 2418: }
2419: $symb=escape($symb);
2420:
2421: if (!$namespace) {
2422: # I don't think we would ever want to store this for a course.
2423: # it seems this will only be used if we don't have a course.
1.620 albertel 2424: #$namespace=$env{'request.course.id'};
1.168 albertel 2425: #if (!$namespace) {
1.620 albertel 2426: $namespace=$env{'request.state'};
1.168 albertel 2427: #}
2428: }
2429: $namespace=~s/\//\_/g;
2430: $namespace=~s/\W//g;
1.620 albertel 2431: if (!$domain) { $domain=$env{'user.domain'}; }
2432: if (!$stuname) { $stuname=$env{'user.name'}; }
1.591 albertel 2433: if ($domain eq 'public' && $stuname eq 'public') {
2434: $stuname=$ENV{'REMOTE_ADDR'};
2435: }
1.168 albertel 2436: my $now=time;
2437: my %hash;
2438: my $path=$perlvar{'lonDaemons'}.'/tmp';
2439: if (tie(%hash,'GDBM_File',
2440: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
1.256 albertel 2441: &GDBM_WRCREAT(),0640)) {
1.168 albertel 2442: $hash{"version:$symb"}++;
2443: my $version=$hash{"version:$symb"};
2444: my $allkeys='';
2445: foreach my $key (keys(%$storehash)) {
2446: $allkeys.=$key.':';
1.591 albertel 2447: $hash{"$version:$symb:$key"}=&freeze_escape($$storehash{$key});
1.168 albertel 2448: }
2449: $hash{"$version:$symb:timestamp"}=$now;
2450: $allkeys.='timestamp';
2451: $hash{"$version:keys:$symb"}=$allkeys;
2452: if (untie(%hash)) {
2453: return 'ok';
2454: } else {
2455: return "error:$!";
2456: }
2457: } else {
2458: return "error:$!";
2459: }
2460: }
1.167 albertel 2461:
1.168 albertel 2462: # -----------------------------------------------------------------Temp Restore
1.167 albertel 2463:
1.168 albertel 2464: sub tmprestore {
2465: my ($symb,$namespace,$domain,$stuname) = @_;
1.167 albertel 2466:
1.168 albertel 2467: if (!$symb) {
2468: $symb=&symbread();
1.620 albertel 2469: if (!$symb) { $symb= $env{'request.url'}; }
1.168 albertel 2470: }
2471: $symb=escape($symb);
2472:
1.620 albertel 2473: if (!$namespace) { $namespace=$env{'request.state'}; }
1.591 albertel 2474:
1.620 albertel 2475: if (!$domain) { $domain=$env{'user.domain'}; }
2476: if (!$stuname) { $stuname=$env{'user.name'}; }
1.591 albertel 2477: if ($domain eq 'public' && $stuname eq 'public') {
2478: $stuname=$ENV{'REMOTE_ADDR'};
2479: }
1.168 albertel 2480: my %returnhash;
2481: $namespace=~s/\//\_/g;
2482: $namespace=~s/\W//g;
2483: my %hash;
2484: my $path=$perlvar{'lonDaemons'}.'/tmp';
2485: if (tie(%hash,'GDBM_File',
2486: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
1.256 albertel 2487: &GDBM_READER(),0640)) {
1.168 albertel 2488: my $version=$hash{"version:$symb"};
2489: $returnhash{'version'}=$version;
2490: my $scope;
2491: for ($scope=1;$scope<=$version;$scope++) {
2492: my $vkeys=$hash{"$scope:keys:$symb"};
2493: my @keys=split(/:/,$vkeys);
2494: my $key;
2495: $returnhash{"$scope:keys"}=$vkeys;
2496: foreach $key (@keys) {
1.591 albertel 2497: $returnhash{"$scope:$key"}=&thaw_unescape($hash{"$scope:$symb:$key"});
2498: $returnhash{"$key"}=&thaw_unescape($hash{"$scope:$symb:$key"});
1.167 albertel 2499: }
2500: }
1.168 albertel 2501: if (!(untie(%hash))) {
2502: return "error:$!";
2503: }
2504: } else {
2505: return "error:$!";
2506: }
2507: return %returnhash;
1.167 albertel 2508: }
2509:
1.9 www 2510: # ----------------------------------------------------------------------- Store
2511:
2512: sub store {
1.124 www 2513: my ($storehash,$symb,$namespace,$domain,$stuname) = @_;
2514: my $home='';
2515:
1.168 albertel 2516: if ($stuname) { $home=&homeserver($stuname,$domain); }
1.124 www 2517:
1.213 www 2518: $symb=&symbclean($symb);
1.122 albertel 2519: if (!$symb) { unless ($symb=&symbread()) { return ''; } }
1.109 www 2520:
1.620 albertel 2521: if (!$domain) { $domain=$env{'user.domain'}; }
2522: if (!$stuname) { $stuname=$env{'user.name'}; }
1.325 www 2523:
2524: &devalidate($symb,$stuname,$domain);
1.109 www 2525:
2526: $symb=escape($symb);
1.187 www 2527: if (!$namespace) {
1.620 albertel 2528: unless ($namespace=$env{'request.course.id'}) {
1.187 www 2529: return '';
2530: }
2531: }
1.620 albertel 2532: if (!$home) { $home=$env{'user.home'}; }
1.447 www 2533:
2534: $$storehash{'ip'}=$ENV{'REMOTE_ADDR'};
2535: $$storehash{'host'}=$perlvar{'lonHostID'};
2536:
1.12 www 2537: my $namevalue='';
1.191 harris41 2538: foreach (keys %$storehash) {
1.591 albertel 2539: $namevalue.=&escape($_).'='.&freeze_escape($$storehash{$_}).'&';
1.191 harris41 2540: }
1.12 www 2541: $namevalue=~s/\&$//;
1.187 www 2542: &courselog($symb.':'.$stuname.':'.$domain.':STORE:'.$namevalue);
1.124 www 2543: return reply("store:$domain:$stuname:$namespace:$symb:$namevalue","$home");
1.9 www 2544: }
2545:
1.47 www 2546: # -------------------------------------------------------------- Critical Store
2547:
2548: sub cstore {
1.124 www 2549: my ($storehash,$symb,$namespace,$domain,$stuname) = @_;
2550: my $home='';
2551:
1.168 albertel 2552: if ($stuname) { $home=&homeserver($stuname,$domain); }
1.124 www 2553:
1.213 www 2554: $symb=&symbclean($symb);
1.122 albertel 2555: if (!$symb) { unless ($symb=&symbread()) { return ''; } }
1.109 www 2556:
1.620 albertel 2557: if (!$domain) { $domain=$env{'user.domain'}; }
2558: if (!$stuname) { $stuname=$env{'user.name'}; }
1.325 www 2559:
2560: &devalidate($symb,$stuname,$domain);
1.109 www 2561:
2562: $symb=escape($symb);
1.187 www 2563: if (!$namespace) {
1.620 albertel 2564: unless ($namespace=$env{'request.course.id'}) {
1.187 www 2565: return '';
2566: }
2567: }
1.620 albertel 2568: if (!$home) { $home=$env{'user.home'}; }
1.447 www 2569:
2570: $$storehash{'ip'}=$ENV{'REMOTE_ADDR'};
2571: $$storehash{'host'}=$perlvar{'lonHostID'};
1.122 albertel 2572:
1.47 www 2573: my $namevalue='';
1.191 harris41 2574: foreach (keys %$storehash) {
1.591 albertel 2575: $namevalue.=&escape($_).'='.&freeze_escape($$storehash{$_}).'&';
1.191 harris41 2576: }
1.47 www 2577: $namevalue=~s/\&$//;
1.187 www 2578: &courselog($symb.':'.$stuname.':'.$domain.':CSTORE:'.$namevalue);
1.188 www 2579: return critical
2580: ("store:$domain:$stuname:$namespace:$symb:$namevalue","$home");
1.47 www 2581: }
2582:
1.9 www 2583: # --------------------------------------------------------------------- Restore
2584:
2585: sub restore {
1.124 www 2586: my ($symb,$namespace,$domain,$stuname) = @_;
2587: my $home='';
2588:
1.168 albertel 2589: if ($stuname) { $home=&homeserver($stuname,$domain); }
1.124 www 2590:
1.122 albertel 2591: if (!$symb) {
2592: unless ($symb=escape(&symbread())) { return ''; }
2593: } else {
1.213 www 2594: $symb=&escape(&symbclean($symb));
1.122 albertel 2595: }
1.188 www 2596: if (!$namespace) {
1.620 albertel 2597: unless ($namespace=$env{'request.course.id'}) {
1.188 www 2598: return '';
2599: }
2600: }
1.620 albertel 2601: if (!$domain) { $domain=$env{'user.domain'}; }
2602: if (!$stuname) { $stuname=$env{'user.name'}; }
2603: if (!$home) { $home=$env{'user.home'}; }
1.122 albertel 2604: my $answer=&reply("restore:$domain:$stuname:$namespace:$symb","$home");
2605:
1.12 www 2606: my %returnhash=();
1.191 harris41 2607: foreach (split(/\&/,$answer)) {
1.12 www 2608: my ($name,$value)=split(/\=/,$_);
1.591 albertel 2609: $returnhash{&unescape($name)}=&thaw_unescape($value);
1.191 harris41 2610: }
1.75 www 2611: my $version;
2612: for ($version=1;$version<=$returnhash{'version'};$version++) {
1.191 harris41 2613: foreach (split(/\:/,$returnhash{$version.':keys'})) {
1.75 www 2614: $returnhash{$_}=$returnhash{$version.':'.$_};
1.191 harris41 2615: }
1.75 www 2616: }
1.13 www 2617: return %returnhash;
1.34 www 2618: }
2619:
2620: # ---------------------------------------------------------- Course Description
2621:
2622: sub coursedescription {
1.731 albertel 2623: my ($courseid,$args)=@_;
1.34 www 2624: $courseid=~s/^\///;
1.49 www 2625: $courseid=~s/\_/\//g;
1.34 www 2626: my ($cdomain,$cnum)=split(/\//,$courseid);
1.129 albertel 2627: my $chome=&homeserver($cnum,$cdomain);
1.302 albertel 2628: my $normalid=$cdomain.'_'.$cnum;
2629: # need to always cache even if we get errors otherwise we keep
2630: # trying and trying and trying to get the course description.
2631: my %envhash=();
2632: my %returnhash=();
1.731 albertel 2633:
2634: my $expiretime=600;
2635: if ($env{'request.course.id'} eq $normalid) {
2636: $expiretime=120;
2637: }
2638:
2639: my $prefix='course.'.$cdomain.'_'.$cnum.'.';
2640: if (!$args->{'freshen_cache'}
2641: && ((time-$env{$prefix.'last_cache'}) < $expiretime) ) {
2642: foreach my $key (keys(%env)) {
2643: next if ($key !~ /^\Q$prefix\E(.*)/);
2644: my ($setting) = $1;
2645: $returnhash{$setting} = $env{$key};
2646: }
2647: return %returnhash;
2648: }
2649:
2650: # get the data agin
2651: if (!$args->{'one_time'}) {
2652: $envhash{'course.'.$normalid.'.last_cache'}=time;
2653: }
1.34 www 2654: if ($chome ne 'no_host') {
1.302 albertel 2655: %returnhash=&dump('environment',$cdomain,$cnum);
1.129 albertel 2656: if (!exists($returnhash{'con_lost'})) {
2657: $returnhash{'home'}= $chome;
2658: $returnhash{'domain'} = $cdomain;
2659: $returnhash{'num'} = $cnum;
1.741 ! raeburn 2660: if (!defined($returnhash{'type'})) {
! 2661: $returnhash{'type'} = 'Course';
! 2662: }
1.130 albertel 2663: while (my ($name,$value) = each %returnhash) {
1.53 www 2664: $envhash{'course.'.$normalid.'.'.$name}=$value;
1.129 albertel 2665: }
1.270 www 2666: $returnhash{'url'}=&clutter($returnhash{'url'});
1.34 www 2667: $returnhash{'fn'}=$perlvar{'lonDaemons'}.'/tmp/'.
1.620 albertel 2668: $env{'user.name'}.'_'.$cdomain.'_'.$cnum;
1.60 www 2669: $envhash{'course.'.$normalid.'.home'}=$chome;
2670: $envhash{'course.'.$normalid.'.domain'}=$cdomain;
2671: $envhash{'course.'.$normalid.'.num'}=$cnum;
1.34 www 2672: }
2673: }
1.731 albertel 2674: if (!$args->{'one_time'}) {
2675: &appenv(%envhash);
2676: }
1.302 albertel 2677: return %returnhash;
1.461 www 2678: }
2679:
2680: # -------------------------------------------------See if a user is privileged
2681:
2682: sub privileged {
2683: my ($username,$domain)=@_;
2684: my $rolesdump=&reply("dump:$domain:$username:roles",
2685: &homeserver($username,$domain));
2686: if (($rolesdump eq 'con_lost') || ($rolesdump eq '')) { return 0; }
2687: my $now=time;
2688: if ($rolesdump ne '') {
2689: foreach (split(/&/,$rolesdump)) {
1.586 albertel 2690: if ($_!~/^rolesdef_/) {
1.461 www 2691: my ($area,$role)=split(/=/,$_);
2692: $area=~s/\_\w\w$//;
2693: my ($trole,$tend,$tstart)=split(/_/,$role);
2694: if (($trole eq 'dc') || ($trole eq 'su')) {
2695: my $active=1;
2696: if ($tend) {
2697: if ($tend<$now) { $active=0; }
2698: }
2699: if ($tstart) {
2700: if ($tstart>$now) { $active=0; }
2701: }
2702: if ($active) { return 1; }
2703: }
2704: }
2705: }
2706: }
2707: return 0;
1.9 www 2708: }
1.1 albertel 2709:
1.103 harris41 2710: # -------------------------------------------------------- Get user privileges
1.11 www 2711:
2712: sub rolesinit {
2713: my ($domain,$username,$authhost)=@_;
2714: my $rolesdump=reply("dump:$domain:$username:roles",$authhost);
1.12 www 2715: if (($rolesdump eq 'con_lost') || ($rolesdump eq '')) { return ''; }
1.11 www 2716: my %allroles=();
1.678 raeburn 2717: my %allgroups=();
1.11 www 2718: my $now=time;
1.21 www 2719: my $userroles="user.login.time=$now\n";
1.678 raeburn 2720: my $group_privs;
1.11 www 2721:
2722: if ($rolesdump ne '') {
1.191 harris41 2723: foreach (split(/&/,$rolesdump)) {
1.586 albertel 2724: if ($_!~/^rolesdef_/) {
1.11 www 2725: my ($area,$role)=split(/=/,$_);
1.587 albertel 2726: $area=~s/\_\w\w$//;
1.678 raeburn 2727: my ($trole,$tend,$tstart,$group_privs);
1.587 albertel 2728: if ($role=~/^cr/) {
1.655 albertel 2729: if ($role=~m|^(cr/\w+/\w+/[a-zA-Z0-9]+)_(.*)$|) {
2730: ($trole,my $trest)=($role=~m|^(cr/\w+/\w+/[a-zA-Z0-9]+)_(.*)$|);
2731: ($tend,$tstart)=split('_',$trest);
2732: } else {
2733: $trole=$role;
2734: }
1.678 raeburn 2735: } elsif ($role =~ m|^gr/|) {
2736: ($trole,$tend,$tstart) = split(/_/,$role);
2737: ($trole,$group_privs) = split(/\//,$trole);
2738: $group_privs = &unescape($group_privs);
1.587 albertel 2739: } else {
2740: ($trole,$tend,$tstart)=split(/_/,$role);
2741: }
1.576 albertel 2742: $userroles.=&set_arearole($trole,$area,$tstart,$tend,$domain,$username);
1.567 raeburn 2743: if (($tend!=0) && ($tend<$now)) { $trole=''; }
2744: if (($tstart!=0) && ($tstart>$now)) { $trole=''; }
1.11 www 2745: if (($area ne '') && ($trole ne '')) {
1.347 albertel 2746: my $spec=$trole.'.'.$area;
2747: my ($tdummy,$tdomain,$trest)=split(/\//,$area);
2748: if ($trole =~ /^cr\//) {
1.567 raeburn 2749: &custom_roleprivs(\%allroles,$trole,$tdomain,$trest,$spec,$area);
1.678 raeburn 2750: } elsif ($trole eq 'gr') {
2751: &group_roleprivs(\%allgroups,$area,$group_privs,$tend,$tstart);
1.347 albertel 2752: } else {
1.567 raeburn 2753: &standard_roleprivs(\%allroles,$trole,$tdomain,$spec,$trest,$area);
1.347 albertel 2754: }
1.12 www 2755: }
1.662 raeburn 2756: }
1.191 harris41 2757: }
1.678 raeburn 2758: my ($author,$adv) = &set_userprivs(\$userroles,\%allroles,\%allgroups);
1.128 www 2759: $userroles.='user.adv='.$adv."\n".
2760: 'user.author='.$author."\n";
1.620 albertel 2761: $env{'user.adv'}=$adv;
1.11 www 2762: }
2763: return $userroles;
2764: }
2765:
1.567 raeburn 2766: sub set_arearole {
2767: my ($trole,$area,$tstart,$tend,$domain,$username) = @_;
2768: # log the associated role with the area
2769: &userrolelog($trole,$username,$domain,$area,$tstart,$tend);
2770: return 'user.role.'.$trole.'.'.$area.'='.$tstart.'.'.$tend."\n";
2771: }
2772:
2773: sub custom_roleprivs {
2774: my ($allroles,$trole,$tdomain,$trest,$spec,$area) = @_;
2775: my ($rdummy,$rdomain,$rauthor,$rrole)=split(/\//,$trole);
2776: my $homsvr=homeserver($rauthor,$rdomain);
2777: if ($hostname{$homsvr} ne '') {
2778: my ($rdummy,$roledef)=
2779: &get('roles',["rolesdef_$rrole"],$rdomain,$rauthor);
2780: if (($rdummy ne 'con_lost') && ($roledef ne '')) {
2781: my ($syspriv,$dompriv,$coursepriv)=split(/\_/,$roledef);
2782: if (defined($syspriv)) {
2783: $$allroles{'cm./'}.=':'.$syspriv;
2784: $$allroles{$spec.'./'}.=':'.$syspriv;
2785: }
2786: if ($tdomain ne '') {
2787: if (defined($dompriv)) {
2788: $$allroles{'cm./'.$tdomain.'/'}.=':'.$dompriv;
2789: $$allroles{$spec.'./'.$tdomain.'/'}.=':'.$dompriv;
2790: }
2791: if (($trest ne '') && (defined($coursepriv))) {
2792: $$allroles{'cm.'.$area}.=':'.$coursepriv;
2793: $$allroles{$spec.'.'.$area}.=':'.$coursepriv;
2794: }
2795: }
2796: }
2797: }
2798: }
2799:
1.678 raeburn 2800: sub group_roleprivs {
2801: my ($allgroups,$area,$group_privs,$tend,$tstart) = @_;
2802: my $access = 1;
2803: my $now = time;
2804: if (($tend!=0) && ($tend<$now)) { $access = 0; }
2805: if (($tstart!=0) && ($tstart>$now)) { $access=0; }
2806: if ($access) {
2807: my ($course,$group) = ($area =~ m|(/\w+/\w+)/([^/]+)$|);
2808: $$allgroups{$course}{$group} .=':'.$group_privs;
2809: }
2810: }
1.567 raeburn 2811:
2812: sub standard_roleprivs {
2813: my ($allroles,$trole,$tdomain,$spec,$trest,$area) = @_;
2814: if (defined($pr{$trole.':s'})) {
2815: $$allroles{'cm./'}.=':'.$pr{$trole.':s'};
2816: $$allroles{$spec.'./'}.=':'.$pr{$trole.':s'};
2817: }
2818: if ($tdomain ne '') {
2819: if (defined($pr{$trole.':d'})) {
2820: $$allroles{'cm./'.$tdomain.'/'}.=':'.$pr{$trole.':d'};
2821: $$allroles{$spec.'./'.$tdomain.'/'}.=':'.$pr{$trole.':d'};
2822: }
2823: if (($trest ne '') && (defined($pr{$trole.':c'}))) {
2824: $$allroles{'cm.'.$area}.=':'.$pr{$trole.':c'};
2825: $$allroles{$spec.'.'.$area}.=':'.$pr{$trole.':c'};
2826: }
2827: }
2828: }
2829:
2830: sub set_userprivs {
1.678 raeburn 2831: my ($userroles,$allroles,$allgroups) = @_;
1.567 raeburn 2832: my $author=0;
2833: my $adv=0;
1.678 raeburn 2834: my %grouproles = ();
2835: if (keys(%{$allgroups}) > 0) {
2836: foreach my $role (keys %{$allroles}) {
1.681 raeburn 2837: my ($trole,$area,$sec,$extendedarea);
2838: if ($role =~ m|^(\w+)\.(/\w+/\w+)(/?\w*)|) {
1.678 raeburn 2839: $trole = $1;
2840: $area = $2;
1.681 raeburn 2841: $sec = $3;
2842: $extendedarea = $area.$sec;
2843: if (exists($$allgroups{$area})) {
2844: foreach my $group (keys(%{$$allgroups{$area}})) {
2845: my $spec = $trole.'.'.$extendedarea;
2846: $grouproles{$spec.'.'.$area.'/'.$group} =
2847: $$allgroups{$area}{$group};
1.678 raeburn 2848: }
2849: }
2850: }
2851: }
2852: }
2853: foreach (keys(%grouproles)) {
2854: $$allroles{$_} = $grouproles{$_};
2855: }
1.567 raeburn 2856: foreach (keys %{$allroles}) {
2857: my %thesepriv=();
2858: if (($_=~/^au/) || ($_=~/^ca/)) { $author=1; }
2859: foreach (split(/:/,$$allroles{$_})) {
2860: if ($_ ne '') {
2861: my ($privilege,$restrictions)=split(/&/,$_);
2862: if ($restrictions eq '') {
2863: $thesepriv{$privilege}='F';
2864: } elsif ($thesepriv{$privilege} ne 'F') {
2865: $thesepriv{$privilege}.=$restrictions;
2866: }
2867: if ($thesepriv{'adv'} eq 'F') { $adv=1; }
2868: }
2869: }
2870: my $thesestr='';
2871: foreach (keys %thesepriv) { $thesestr.=':'.$_.'&'.$thesepriv{$_}; }
2872: $$userroles.='user.priv.'.$_.'='.$thesestr."\n";
2873: }
2874: return ($author,$adv);
2875: }
2876:
1.12 www 2877: # --------------------------------------------------------------- get interface
2878:
2879: sub get {
1.131 albertel 2880: my ($namespace,$storearr,$udomain,$uname)=@_;
1.12 www 2881: my $items='';
1.191 harris41 2882: foreach (@$storearr) {
1.12 www 2883: $items.=escape($_).'&';
1.191 harris41 2884: }
1.12 www 2885: $items=~s/\&$//;
1.620 albertel 2886: if (!$udomain) { $udomain=$env{'user.domain'}; }
2887: if (!$uname) { $uname=$env{'user.name'}; }
1.131 albertel 2888: my $uhome=&homeserver($uname,$udomain);
2889:
1.133 albertel 2890: my $rep=&reply("get:$udomain:$uname:$namespace:$items",$uhome);
1.15 www 2891: my @pairs=split(/\&/,$rep);
1.273 albertel 2892: if ( $#pairs==0 && $pairs[0] =~ /^(con_lost|error|no_such_host)/i) {
2893: return @pairs;
2894: }
1.15 www 2895: my %returnhash=();
1.42 www 2896: my $i=0;
1.191 harris41 2897: foreach (@$storearr) {
1.557 albertel 2898: $returnhash{$_}=&thaw_unescape($pairs[$i]);
1.42 www 2899: $i++;
1.191 harris41 2900: }
1.15 www 2901: return %returnhash;
1.27 www 2902: }
2903:
2904: # --------------------------------------------------------------- del interface
2905:
2906: sub del {
1.133 albertel 2907: my ($namespace,$storearr,$udomain,$uname)=@_;
1.27 www 2908: my $items='';
1.191 harris41 2909: foreach (@$storearr) {
1.27 www 2910: $items.=escape($_).'&';
1.191 harris41 2911: }
1.27 www 2912: $items=~s/\&$//;
1.620 albertel 2913: if (!$udomain) { $udomain=$env{'user.domain'}; }
2914: if (!$uname) { $uname=$env{'user.name'}; }
1.133 albertel 2915: my $uhome=&homeserver($uname,$udomain);
2916:
2917: return &reply("del:$udomain:$uname:$namespace:$items",$uhome);
1.15 www 2918: }
2919:
2920: # -------------------------------------------------------------- dump interface
2921:
2922: sub dump {
1.702 albertel 2923: my ($namespace,$udomain,$uname,$regexp,$range)=@_;
1.620 albertel 2924: if (!$udomain) { $udomain=$env{'user.domain'}; }
2925: if (!$uname) { $uname=$env{'user.name'}; }
1.129 albertel 2926: my $uhome=&homeserver($uname,$udomain);
1.193 www 2927: if ($regexp) {
2928: $regexp=&escape($regexp);
2929: } else {
2930: $regexp='.';
2931: }
1.702 albertel 2932: my $rep=reply("dump:$udomain:$uname:$namespace:$regexp:$range",$uhome);
1.12 www 2933: my @pairs=split(/\&/,$rep);
2934: my %returnhash=();
1.191 harris41 2935: foreach (@pairs) {
1.702 albertel 2936: my ($key,$value)=split(/=/,$_,2);
1.557 albertel 2937: $returnhash{unescape($key)}=&thaw_unescape($value);
1.318 matthew 2938: }
2939: return %returnhash;
1.407 www 2940: }
2941:
1.717 albertel 2942: # --------------------------------------------------------- dumpstore interface
2943:
2944: sub dumpstore {
2945: my ($namespace,$udomain,$uname,$regexp,$range)=@_;
2946: return &dump($namespace,$udomain,$uname,$regexp,$range);
2947: }
2948:
1.407 www 2949: # -------------------------------------------------------------- keys interface
2950:
2951: sub getkeys {
2952: my ($namespace,$udomain,$uname)=@_;
1.620 albertel 2953: if (!$udomain) { $udomain=$env{'user.domain'}; }
2954: if (!$uname) { $uname=$env{'user.name'}; }
1.407 www 2955: my $uhome=&homeserver($uname,$udomain);
2956: my $rep=reply("keys:$udomain:$uname:$namespace",$uhome);
2957: my @keyarray=();
2958: foreach (split(/\&/,$rep)) {
2959: push (@keyarray,&unescape($_));
2960: }
2961: return @keyarray;
1.318 matthew 2962: }
2963:
1.319 matthew 2964: # --------------------------------------------------------------- currentdump
2965: sub currentdump {
1.328 matthew 2966: my ($courseid,$sdom,$sname)=@_;
1.620 albertel 2967: $courseid = $env{'request.course.id'} if (! defined($courseid));
2968: $sdom = $env{'user.domain'} if (! defined($sdom));
2969: $sname = $env{'user.name'} if (! defined($sname));
1.326 matthew 2970: my $uhome = &homeserver($sname,$sdom);
2971: my $rep=reply('currentdump:'.$sdom.':'.$sname.':'.$courseid,$uhome);
1.318 matthew 2972: return if ($rep =~ /^(error:|no_such_host)/);
1.319 matthew 2973: #
1.318 matthew 2974: my %returnhash=();
1.319 matthew 2975: #
2976: if ($rep eq "unknown_cmd") {
2977: # an old lond will not know currentdump
2978: # Do a dump and make it look like a currentdump
1.326 matthew 2979: my @tmp = &dump($courseid,$sdom,$sname,'.');
1.319 matthew 2980: return if ($tmp[0] =~ /^(error:|no_such_host)/);
2981: my %hash = @tmp;
2982: @tmp=();
1.424 matthew 2983: %returnhash = %{&convert_dump_to_currentdump(\%hash)};
1.319 matthew 2984: } else {
2985: my @pairs=split(/\&/,$rep);
2986: foreach (@pairs) {
2987: my ($key,$value)=split(/=/,$_);
2988: my ($symb,$param) = split(/:/,$key);
2989: $returnhash{&unescape($symb)}->{&unescape($param)} =
1.557 albertel 2990: &thaw_unescape($value);
1.319 matthew 2991: }
1.191 harris41 2992: }
1.12 www 2993: return %returnhash;
1.424 matthew 2994: }
2995:
2996: sub convert_dump_to_currentdump{
2997: my %hash = %{shift()};
2998: my %returnhash;
2999: # Code ripped from lond, essentially. The only difference
3000: # here is the unescaping done by lonnet::dump(). Conceivably
3001: # we might run in to problems with parameter names =~ /^v\./
3002: while (my ($key,$value) = each(%hash)) {
3003: my ($v,$symb,$param) = split(/:/,$key);
3004: next if ($v eq 'version' || $symb eq 'keys');
3005: next if (exists($returnhash{$symb}) &&
3006: exists($returnhash{$symb}->{$param}) &&
3007: $returnhash{$symb}->{'v.'.$param} > $v);
3008: $returnhash{$symb}->{$param}=$value;
3009: $returnhash{$symb}->{'v.'.$param}=$v;
3010: }
3011: #
3012: # Remove all of the keys in the hashes which keep track of
3013: # the version of the parameter.
3014: while (my ($symb,$param_hash) = each(%returnhash)) {
3015: # use a foreach because we are going to delete from the hash.
3016: foreach my $key (keys(%$param_hash)) {
3017: delete($param_hash->{$key}) if ($key =~ /^v\./);
3018: }
3019: }
3020: return \%returnhash;
1.12 www 3021: }
3022:
1.627 albertel 3023: # ------------------------------------------------------ critical inc interface
3024:
3025: sub cinc {
3026: return &inc(@_,'critical');
3027: }
3028:
1.449 matthew 3029: # --------------------------------------------------------------- inc interface
3030:
3031: sub inc {
1.627 albertel 3032: my ($namespace,$store,$udomain,$uname,$critical) = @_;
1.620 albertel 3033: if (!$udomain) { $udomain=$env{'user.domain'}; }
3034: if (!$uname) { $uname=$env{'user.name'}; }
1.449 matthew 3035: my $uhome=&homeserver($uname,$udomain);
3036: my $items='';
3037: if (! ref($store)) {
3038: # got a single value, so use that instead
3039: $items = &escape($store).'=&';
3040: } elsif (ref($store) eq 'SCALAR') {
3041: $items = &escape($$store).'=&';
3042: } elsif (ref($store) eq 'ARRAY') {
3043: $items = join('=&',map {&escape($_);} @{$store});
3044: } elsif (ref($store) eq 'HASH') {
3045: while (my($key,$value) = each(%{$store})) {
3046: $items.= &escape($key).'='.&escape($value).'&';
3047: }
3048: }
3049: $items=~s/\&$//;
1.627 albertel 3050: if ($critical) {
3051: return &critical("inc:$udomain:$uname:$namespace:$items",$uhome);
3052: } else {
3053: return &reply("inc:$udomain:$uname:$namespace:$items",$uhome);
3054: }
1.449 matthew 3055: }
3056:
1.12 www 3057: # --------------------------------------------------------------- put interface
3058:
3059: sub put {
1.134 albertel 3060: my ($namespace,$storehash,$udomain,$uname)=@_;
1.620 albertel 3061: if (!$udomain) { $udomain=$env{'user.domain'}; }
3062: if (!$uname) { $uname=$env{'user.name'}; }
1.134 albertel 3063: my $uhome=&homeserver($uname,$udomain);
1.12 www 3064: my $items='';
1.191 harris41 3065: foreach (keys %$storehash) {
1.557 albertel 3066: $items.=&escape($_).'='.&freeze_escape($$storehash{$_}).'&';
1.191 harris41 3067: }
1.12 www 3068: $items=~s/\&$//;
1.134 albertel 3069: return &reply("put:$udomain:$uname:$namespace:$items",$uhome);
1.47 www 3070: }
3071:
1.631 albertel 3072: # ------------------------------------------------------------ newput interface
3073:
3074: sub newput {
3075: my ($namespace,$storehash,$udomain,$uname)=@_;
3076: if (!$udomain) { $udomain=$env{'user.domain'}; }
3077: if (!$uname) { $uname=$env{'user.name'}; }
3078: my $uhome=&homeserver($uname,$udomain);
3079: my $items='';
3080: foreach my $key (keys(%$storehash)) {
3081: $items.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
3082: }
3083: $items=~s/\&$//;
3084: return &reply("newput:$udomain:$uname:$namespace:$items",$uhome);
3085: }
3086:
3087: # --------------------------------------------------------- putstore interface
3088:
1.524 raeburn 3089: sub putstore {
1.715 albertel 3090: my ($namespace,$symb,$version,$storehash,$udomain,$uname)=@_;
1.620 albertel 3091: if (!$udomain) { $udomain=$env{'user.domain'}; }
3092: if (!$uname) { $uname=$env{'user.name'}; }
1.524 raeburn 3093: my $uhome=&homeserver($uname,$udomain);
3094: my $items='';
1.715 albertel 3095: foreach my $key (keys(%$storehash)) {
3096: $items.= &escape($key).'='.&freeze_escape($storehash->{$key}).'&';
1.524 raeburn 3097: }
1.715 albertel 3098: $items=~s/\&$//;
1.716 albertel 3099: my $esc_symb=&escape($symb);
3100: my $esc_v=&escape($version);
1.715 albertel 3101: my $reply =
1.716 albertel 3102: &reply("putstore:$udomain:$uname:$namespace:$esc_symb:$esc_v:$items",
1.715 albertel 3103: $uhome);
3104: if ($reply eq 'unknown_cmd') {
1.716 albertel 3105: # gfall back to way things use to be done
1.715 albertel 3106: return &old_putstore($namespace,$symb,$version,$storehash,$udomain,
3107: $uname);
1.524 raeburn 3108: }
1.715 albertel 3109: return $reply;
3110: }
3111:
3112: sub old_putstore {
1.716 albertel 3113: my ($namespace,$symb,$version,$storehash,$udomain,$uname)=@_;
3114: if (!$udomain) { $udomain=$env{'user.domain'}; }
3115: if (!$uname) { $uname=$env{'user.name'}; }
3116: my $uhome=&homeserver($uname,$udomain);
3117: my %newstorehash;
3118: foreach (keys %$storehash) {
3119: my $key = $version.':'.&escape($symb).':'.$_;
3120: $newstorehash{$key} = $storehash->{$_};
3121: }
3122: my $items='';
3123: my %allitems = ();
3124: foreach (keys %newstorehash) {
3125: if ($_ =~ m/^([^\:]+):([^\:]+):([^\:]+)$/) {
3126: my $key = $1.':keys:'.$2;
3127: $allitems{$key} .= $3.':';
3128: }
3129: $items.=$_.'='.&freeze_escape($newstorehash{$_}).'&';
3130: }
3131: foreach (keys %allitems) {
3132: $allitems{$_} =~ s/\:$//;
3133: $items.= $_.'='.$allitems{$_}.'&';
3134: }
3135: $items=~s/\&$//;
3136: return &reply("put:$udomain:$uname:$namespace:$items",$uhome);
1.524 raeburn 3137: }
3138:
1.47 www 3139: # ------------------------------------------------------ critical put interface
3140:
3141: sub cput {
1.134 albertel 3142: my ($namespace,$storehash,$udomain,$uname)=@_;
1.620 albertel 3143: if (!$udomain) { $udomain=$env{'user.domain'}; }
3144: if (!$uname) { $uname=$env{'user.name'}; }
1.134 albertel 3145: my $uhome=&homeserver($uname,$udomain);
1.47 www 3146: my $items='';
1.191 harris41 3147: foreach (keys %$storehash) {
1.715 albertel 3148: $items.=&escape($_).'='.&freeze_escape($$storehash{$_}).'&';
1.191 harris41 3149: }
1.47 www 3150: $items=~s/\&$//;
1.134 albertel 3151: return &critical("put:$udomain:$uname:$namespace:$items",$uhome);
1.12 www 3152: }
3153:
3154: # -------------------------------------------------------------- eget interface
3155:
3156: sub eget {
1.133 albertel 3157: my ($namespace,$storearr,$udomain,$uname)=@_;
1.12 www 3158: my $items='';
1.191 harris41 3159: foreach (@$storearr) {
1.12 www 3160: $items.=escape($_).'&';
1.191 harris41 3161: }
1.12 www 3162: $items=~s/\&$//;
1.620 albertel 3163: if (!$udomain) { $udomain=$env{'user.domain'}; }
3164: if (!$uname) { $uname=$env{'user.name'}; }
1.133 albertel 3165: my $uhome=&homeserver($uname,$udomain);
3166: my $rep=&reply("eget:$udomain:$uname:$namespace:$items",$uhome);
1.12 www 3167: my @pairs=split(/\&/,$rep);
3168: my %returnhash=();
1.42 www 3169: my $i=0;
1.191 harris41 3170: foreach (@$storearr) {
1.557 albertel 3171: $returnhash{$_}=&thaw_unescape($pairs[$i]);
1.42 www 3172: $i++;
1.191 harris41 3173: }
1.12 www 3174: return %returnhash;
3175: }
3176:
1.667 albertel 3177: # ------------------------------------------------------------ tmpput interface
3178: sub tmpput {
3179: my ($storehash,$server)=@_;
3180: my $items='';
3181: foreach (keys(%$storehash)) {
3182: $items.=&escape($_).'='.&freeze_escape($$storehash{$_}).'&';
3183: }
3184: $items=~s/\&$//;
3185: return &reply("tmpput:$items",$server);
3186: }
3187:
3188: # ------------------------------------------------------------ tmpget interface
3189: sub tmpget {
1.688 albertel 3190: my ($token,$server)=@_;
3191: if (!defined($server)) { $server = $perlvar{'lonHostID'}; }
3192: my $rep=&reply("tmpget:$token",$server);
1.667 albertel 3193: my %returnhash;
3194: foreach my $item (split(/\&/,$rep)) {
3195: my ($key,$value)=split(/=/,$item);
3196: $returnhash{&unescape($key)}=&thaw_unescape($value);
3197: }
3198: return %returnhash;
3199: }
3200:
1.688 albertel 3201: # ------------------------------------------------------------ tmpget interface
3202: sub tmpdel {
3203: my ($token,$server)=@_;
3204: if (!defined($server)) { $server = $perlvar{'lonHostID'}; }
3205: return &reply("tmpdel:$token",$server);
3206: }
3207:
1.341 www 3208: # ---------------------------------------------- Custom access rule evaluation
3209:
3210: sub customaccess {
3211: my ($priv,$uri)=@_;
1.620 albertel 3212: my ($urole,$urealm)=split(/\./,$env{'request.role'});
1.343 www 3213: $urealm=~s/^\W//;
3214: my ($udom,$ucrs,$usec)=split(/\//,$urealm);
1.341 www 3215: my $access=0;
3216: foreach (split(/\s*\,\s*/,&metadata($uri,'rule_rights'))) {
1.342 www 3217: my ($effect,$realm,$role)=split(/\:/,$_);
1.343 www 3218: if ($role) {
3219: if ($role ne $urole) { next; }
3220: }
3221: foreach (split(/\s*\,\s*/,$realm)) {
3222: my ($tdom,$tcrs,$tsec)=split(/\_/,$_);
3223: if ($tdom) {
3224: if ($tdom ne $udom) { next; }
3225: }
3226: if ($tcrs) {
3227: if ($tcrs ne $ucrs) { next; }
3228: }
3229: if ($tsec) {
3230: if ($tsec ne $usec) { next; }
3231: }
3232: $access=($effect eq 'allow');
3233: last;
1.342 www 3234: }
1.402 bowersj2 3235: if ($realm eq '' && $role eq '') {
3236: $access=($effect eq 'allow');
3237: }
1.341 www 3238: }
3239: return $access;
3240: }
3241:
1.103 harris41 3242: # ------------------------------------------------- Check for a user privilege
1.12 www 3243:
3244: sub allowed {
1.579 albertel 3245: my ($priv,$uri,$symb)=@_;
1.705 albertel 3246: my $ver_orguri=$uri;
1.439 www 3247: $uri=&deversion($uri);
1.152 www 3248: my $orguri=$uri;
1.52 www 3249: $uri=&declutter($uri);
1.545 banghart 3250:
1.620 albertel 3251: if (defined($env{'allowed.'.$priv})) { return $env{'allowed.'.$priv}; }
1.54 www 3252: # Free bre access to adm and meta resources
1.529 albertel 3253: if (((($uri=~/^adm\//) && ($uri !~ m|/bulletinboard$|))
3254: || ($uri=~/\.meta$/)) && ($priv eq 'bre')) {
1.14 www 3255: return 'F';
1.159 www 3256: }
3257:
1.545 banghart 3258: # Free bre access to user's own portfolio contents
1.714 raeburn 3259: my ($space,$domain,$name,@dir)=split('/',$uri);
1.647 raeburn 3260: if (($space=~/^(uploaded|editupload)$/) && ($env{'user.name'} eq $name) &&
1.714 raeburn 3261: ($env{'user.domain'} eq $domain) && ('portfolio' eq $dir[0])) {
1.545 banghart 3262: return 'F';
3263: }
3264:
1.714 raeburn 3265: # bre access to group if user has rgf priv for this group and course.
3266: if (($space=~/^(uploaded|editupload)$/) && ($dir[0] eq 'groups')
3267: && ($dir[2] eq 'portfolio') && ($priv eq 'bre')) {
3268: if (exists($env{'request.course.id'})) {
3269: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
3270: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
3271: if (($domain eq $cdom) && ($name eq $cnum)) {
3272: my $courseprivid=$env{'request.course.id'};
3273: $courseprivid=~s/\_/\//;
3274: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid
3275: .'/'.$dir[1]} =~/rgf\&([^\:]*)/) {
3276: return $1;
3277: }
3278: }
3279: }
3280: }
3281:
1.159 www 3282: # Free bre to public access
3283:
3284: if ($priv eq 'bre') {
1.238 www 3285: my $copyright=&metadata($uri,'copyright');
1.620 albertel 3286: if (($copyright eq 'public') && (!$env{'request.course.id'})) {
1.301 www 3287: return 'F';
3288: }
1.238 www 3289: if ($copyright eq 'priv') {
3290: $uri=~/([^\/]+)\/([^\/]+)\//;
1.620 albertel 3291: unless (($env{'user.name'} eq $2) && ($env{'user.domain'} eq $1)) {
1.238 www 3292: return '';
3293: }
3294: }
3295: if ($copyright eq 'domain') {
3296: $uri=~/([^\/]+)\/([^\/]+)\//;
1.620 albertel 3297: unless (($env{'user.domain'} eq $1) ||
3298: ($env{'course.'.$env{'request.course.id'}.'.domain'} eq $1)) {
1.238 www 3299: return '';
3300: }
1.262 matthew 3301: }
1.620 albertel 3302: if ($env{'request.role'}=~ /li\.\//) {
1.262 matthew 3303: # Library role, so allow browsing of resources in this domain.
3304: return 'F';
1.238 www 3305: }
1.341 www 3306: if ($copyright eq 'custom') {
3307: unless (&customaccess($priv,$uri)) { return ''; }
3308: }
1.14 www 3309: }
1.264 matthew 3310: # Domain coordinator is trying to create a course
1.620 albertel 3311: if (($priv eq 'ccc') && ($env{'request.role'} =~ /^dc\./)) {
1.264 matthew 3312: # uri is the requested domain in this case.
3313: # comparison to 'request.role.domain' shows if the user has selected
1.678 raeburn 3314: # a role of dc for the domain in question.
1.620 albertel 3315: return 'F' if ($uri eq $env{'request.role.domain'});
1.264 matthew 3316: }
1.29 www 3317:
1.52 www 3318: my $thisallowed='';
3319: my $statecond=0;
3320: my $courseprivid='';
3321:
3322: # Course
3323:
1.620 albertel 3324: if ($env{'user.priv.'.$env{'request.role'}.'./'}=~/\Q$priv\E\&([^\:]*)/) {
1.52 www 3325: $thisallowed.=$1;
3326: }
1.29 www 3327:
1.52 www 3328: # Domain
3329:
1.620 albertel 3330: if ($env{'user.priv.'.$env{'request.role'}.'./'.(split(/\//,$uri))[0].'/'}
1.479 albertel 3331: =~/\Q$priv\E\&([^\:]*)/) {
1.12 www 3332: $thisallowed.=$1;
3333: }
1.52 www 3334:
3335: # Course: uri itself is a course
1.66 www 3336: my $courseuri=$uri;
3337: $courseuri=~s/\_(\d)/\/$1/;
1.83 www 3338: $courseuri=~s/^([^\/])/\/$1/;
1.81 www 3339:
1.620 albertel 3340: if ($env{'user.priv.'.$env{'request.role'}.'.'.$courseuri}
1.479 albertel 3341: =~/\Q$priv\E\&([^\:]*)/) {
1.12 www 3342: $thisallowed.=$1;
3343: }
1.29 www 3344:
1.678 raeburn 3345: # Group: uri itself is a group
3346: my $groupuri=$uri;
3347: $groupuri=~s/^([^\/])/\/$1/;
3348: if ($env{'user.priv.'.$env{'request.role'}.'.'.$groupuri}
3349: =~/\Q$priv\E\&([^\:]*)/) {
3350: $thisallowed.=$1;
3351: }
3352:
1.665 albertel 3353: # URI is an uploaded document for this course, default permissions don't matter
1.611 albertel 3354: # not allowing 'edit' access (editupload) to uploaded course docs
1.492 albertel 3355: if (($priv eq 'bre') && ($uri=~m|^uploaded/|)) {
1.665 albertel 3356: $thisallowed='';
1.671 raeburn 3357: my ($match)=&is_on_map($uri);
3358: if ($match) {
3359: if ($env{'user.priv.'.$env{'request.role'}.'./'}
3360: =~/\Q$priv\E\&([^\:]*)/) {
3361: $thisallowed.=$1;
3362: }
3363: } else {
1.705 albertel 3364: my $refuri = $env{'httpref.'.$orguri} || $env{'httpref.'.$ver_orguri};
1.671 raeburn 3365: if ($refuri) {
3366: if ($refuri =~ m|^/adm/|) {
1.669 raeburn 3367: $thisallowed='F';
1.671 raeburn 3368: } else {
3369: $refuri=&declutter($refuri);
3370: my ($match) = &is_on_map($refuri);
3371: if ($match) {
3372: $thisallowed='F';
3373: }
1.669 raeburn 3374: }
1.671 raeburn 3375: }
3376: }
1.314 www 3377: }
1.492 albertel 3378:
1.52 www 3379: # Full access at system, domain or course-wide level? Exit.
1.29 www 3380:
3381: if ($thisallowed=~/F/) {
3382: return 'F';
3383: }
3384:
1.52 www 3385: # If this is generating or modifying users, exit with special codes
1.29 www 3386:
1.643 www 3387: if (':csu:cdc:ccc:cin:cta:cep:ccr:cst:cad:cli:cau:cdg:cca:caa:'=~/\:\Q$priv\E\:/) {
3388: if (($priv eq 'cca') || ($priv eq 'caa')) {
1.642 albertel 3389: my ($audom,$auname)=split('/',$uri);
1.643 www 3390: # no author name given, so this just checks on the general right to make a co-author in this domain
3391: unless ($auname) { return $thisallowed; }
3392: # an author name is given, so we are about to actually make a co-author for a certain account
1.642 albertel 3393: if (($auname ne $env{'user.name'} && $env{'request.role'} !~ /^dc\./) ||
3394: (($audom ne $env{'user.domain'} && $env{'request.role'} !~ /^dc\./) &&
3395: ($audom ne $env{'request.role.domain'}))) { return ''; }
3396: }
1.52 www 3397: return $thisallowed;
3398: }
3399: #
1.103 harris41 3400: # Gathered so far: system, domain and course wide privileges
1.52 www 3401: #
3402: # Course: See if uri or referer is an individual resource that is part of
3403: # the course
3404:
1.620 albertel 3405: if ($env{'request.course.id'}) {
1.232 www 3406:
1.620 albertel 3407: $courseprivid=$env{'request.course.id'};
3408: if ($env{'request.course.sec'}) {
3409: $courseprivid.='/'.$env{'request.course.sec'};
1.52 www 3410: }
3411: $courseprivid=~s/\_/\//;
3412: my $checkreferer=1;
1.232 www 3413: my ($match,$cond)=&is_on_map($uri);
3414: if ($match) {
3415: $statecond=$cond;
1.620 albertel 3416: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid}
1.479 albertel 3417: =~/\Q$priv\E\&([^\:]*)/) {
1.52 www 3418: $thisallowed.=$1;
3419: $checkreferer=0;
3420: }
1.29 www 3421: }
1.83 www 3422:
1.148 www 3423: if ($checkreferer) {
1.620 albertel 3424: my $refuri=$env{'httpref.'.$orguri};
1.148 www 3425: unless ($refuri) {
1.620 albertel 3426: foreach (keys %env) {
1.148 www 3427: if ($_=~/^httpref\..*\*/) {
3428: my $pattern=$_;
1.156 www 3429: $pattern=~s/^httpref\.\/res\///;
1.148 www 3430: $pattern=~s/\*/\[\^\/\]\+/g;
3431: $pattern=~s/\//\\\//g;
1.152 www 3432: if ($orguri=~/$pattern/) {
1.620 albertel 3433: $refuri=$env{$_};
1.148 www 3434: }
3435: }
1.191 harris41 3436: }
1.148 www 3437: }
1.232 www 3438:
1.148 www 3439: if ($refuri) {
1.152 www 3440: $refuri=&declutter($refuri);
1.232 www 3441: my ($match,$cond)=&is_on_map($refuri);
3442: if ($match) {
3443: my $refstatecond=$cond;
1.620 albertel 3444: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid}
1.479 albertel 3445: =~/\Q$priv\E\&([^\:]*)/) {
1.52 www 3446: $thisallowed.=$1;
1.53 www 3447: $uri=$refuri;
3448: $statecond=$refstatecond;
1.52 www 3449: }
3450: }
1.148 www 3451: }
1.29 www 3452: }
1.52 www 3453: }
1.29 www 3454:
1.52 www 3455: #
1.103 harris41 3456: # Gathered now: all privileges that could apply, and condition number
1.52 www 3457: #
3458: #
3459: # Full or no access?
3460: #
1.29 www 3461:
1.52 www 3462: if ($thisallowed=~/F/) {
3463: return 'F';
3464: }
1.29 www 3465:
1.52 www 3466: unless ($thisallowed) {
3467: return '';
3468: }
1.29 www 3469:
1.52 www 3470: # Restrictions exist, deal with them
3471: #
3472: # C:according to course preferences
3473: # R:according to resource settings
3474: # L:unless locked
3475: # X:according to user session state
3476: #
3477:
3478: # Possibly locked functionality, check all courses
1.54 www 3479: # Locks might take effect only after 10 minutes cache expiration for other
3480: # courses, and 2 minutes for current course
1.52 www 3481:
3482: my $envkey;
3483: if ($thisallowed=~/L/) {
1.620 albertel 3484: foreach $envkey (keys %env) {
1.54 www 3485: if ($envkey=~/^user\.role\.(st|ta)\.([^\.]*)/) {
3486: my $courseid=$2;
3487: my $roleid=$1.'.'.$2;
1.92 www 3488: $courseid=~s/^\///;
1.54 www 3489: my $expiretime=600;
1.620 albertel 3490: if ($env{'request.role'} eq $roleid) {
1.54 www 3491: $expiretime=120;
3492: }
3493: my ($cdom,$cnum,$csec)=split(/\//,$courseid);
3494: my $prefix='course.'.$cdom.'_'.$cnum.'.';
1.620 albertel 3495: if ((time-$env{$prefix.'last_cache'})>$expiretime) {
1.731 albertel 3496: &coursedescription($courseid,{'freshen_cache' => 1});
1.54 www 3497: }
1.620 albertel 3498: if (($env{$prefix.'res.'.$uri.'.lock.sections'}=~/\,\Q$csec\E\,/)
3499: || ($env{$prefix.'res.'.$uri.'.lock.sections'} eq 'all')) {
3500: if ($env{$prefix.'res.'.$uri.'.lock.expire'}>time) {
3501: &log($env{'user.domain'},$env{'user.name'},
3502: $env{'user.home'},
1.57 www 3503: 'Locked by res: '.$priv.' for '.$uri.' due to '.
1.52 www 3504: $cdom.'/'.$cnum.'/'.$csec.' expire '.
1.620 albertel 3505: $env{$prefix.'priv.'.$priv.'.lock.expire'});
1.52 www 3506: return '';
3507: }
3508: }
1.620 albertel 3509: if (($env{$prefix.'priv.'.$priv.'.lock.sections'}=~/\,\Q$csec\E\,/)
3510: || ($env{$prefix.'priv.'.$priv.'.lock.sections'} eq 'all')) {
3511: if ($env{'priv.'.$priv.'.lock.expire'}>time) {
3512: &log($env{'user.domain'},$env{'user.name'},
3513: $env{'user.home'},
1.57 www 3514: 'Locked by priv: '.$priv.' for '.$uri.' due to '.
1.52 www 3515: $cdom.'/'.$cnum.'/'.$csec.' expire '.
1.620 albertel 3516: $env{$prefix.'priv.'.$priv.'.lock.expire'});
1.52 www 3517: return '';
3518: }
3519: }
3520: }
1.29 www 3521: }
1.52 www 3522: }
3523:
3524: #
3525: # Rest of the restrictions depend on selected course
3526: #
3527:
1.620 albertel 3528: unless ($env{'request.course.id'}) {
1.52 www 3529: return '1';
3530: }
1.29 www 3531:
1.52 www 3532: #
3533: # Now user is definitely in a course
3534: #
1.53 www 3535:
3536:
3537: # Course preferences
3538:
3539: if ($thisallowed=~/C/) {
1.620 albertel 3540: my $rolecode=(split(/\./,$env{'request.role'}))[0];
3541: my $unamedom=$env{'user.name'}.':'.$env{'user.domain'};
3542: if ($env{'course.'.$env{'request.course.id'}.'.'.$priv.'.roles.denied'}
1.479 albertel 3543: =~/\Q$rolecode\E/) {
1.689 albertel 3544: if ($priv ne 'pch') {
3545: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.':'.
3546: 'Denied by role: '.$priv.' for '.$uri.' as '.$rolecode.' in '.
3547: $env{'request.course.id'});
3548: }
1.237 www 3549: return '';
3550: }
3551:
1.620 albertel 3552: if ($env{'course.'.$env{'request.course.id'}.'.'.$priv.'.users.denied'}
1.479 albertel 3553: =~/\Q$unamedom\E/) {
1.689 albertel 3554: if ($priv ne 'pch') {
3555: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.
3556: 'Denied by user: '.$priv.' for '.$uri.' as '.$unamedom.' in '.
3557: $env{'request.course.id'});
3558: }
1.54 www 3559: return '';
3560: }
1.53 www 3561: }
3562:
3563: # Resource preferences
3564:
3565: if ($thisallowed=~/R/) {
1.620 albertel 3566: my $rolecode=(split(/\./,$env{'request.role'}))[0];
1.479 albertel 3567: if (&metadata($uri,'roledeny')=~/\Q$rolecode\E/) {
1.689 albertel 3568: if ($priv ne 'pch') {
3569: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.':'.
3570: 'Denied by role: '.$priv.' for '.$uri.' as '.$rolecode);
3571: }
3572: return '';
1.54 www 3573: }
1.53 www 3574: }
1.30 www 3575:
1.246 www 3576: # Restricted by state or randomout?
1.30 www 3577:
1.52 www 3578: if ($thisallowed=~/X/) {
1.620 albertel 3579: if ($env{'acc.randomout'}) {
1.579 albertel 3580: if (!$symb) { $symb=&symbread($uri,1); }
1.620 albertel 3581: if (($symb) && ($env{'acc.randomout'}=~/\&\Q$symb\E\&/)) {
1.248 www 3582: return '';
3583: }
1.247 www 3584: }
3585: if (&condval($statecond)) {
1.52 www 3586: return '2';
3587: } else {
3588: return '';
3589: }
3590: }
1.30 www 3591:
1.52 www 3592: return 'F';
1.232 www 3593: }
3594:
1.710 albertel 3595: sub split_uri_for_cond {
3596: my $uri=&deversion(&declutter(shift));
3597: my @uriparts=split(/\//,$uri);
3598: my $filename=pop(@uriparts);
3599: my $pathname=join('/',@uriparts);
3600: return ($pathname,$filename);
3601: }
1.232 www 3602: # --------------------------------------------------- Is a resource on the map?
3603:
3604: sub is_on_map {
1.710 albertel 3605: my ($pathname,$filename) = &split_uri_for_cond(shift);
1.289 bowersj2 3606: #Trying to find the conditional for the file
1.620 albertel 3607: my $match=($env{'acc.res.'.$env{'request.course.id'}.'.'.$pathname}=~
1.289 bowersj2 3608: /\&\Q$filename\E\:([\d\|]+)\&/);
1.232 www 3609: if ($match) {
1.289 bowersj2 3610: return (1,$1);
3611: } else {
1.434 www 3612: return (0,0);
1.289 bowersj2 3613: }
1.12 www 3614: }
3615:
1.427 www 3616: # --------------------------------------------------------- Get symb from alias
3617:
3618: sub get_symb_from_alias {
3619: my $symb=shift;
3620: my ($map,$resid,$url)=&decode_symb($symb);
3621: # Already is a symb
3622: if ($url) { return $symb; }
3623: # Must be an alias
3624: my $aliassymb='';
3625: my %bighash;
1.620 albertel 3626: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
1.427 www 3627: &GDBM_READER(),0640)) {
3628: my $rid=$bighash{'mapalias_'.$symb};
3629: if ($rid) {
3630: my ($mapid,$resid)=split(/\./,$rid);
1.429 albertel 3631: $aliassymb=&encode_symb($bighash{'map_id_'.$mapid},
3632: $resid,$bighash{'src_'.$rid});
1.427 www 3633: }
3634: untie %bighash;
3635: }
3636: return $aliassymb;
3637: }
3638:
1.12 www 3639: # ----------------------------------------------------------------- Define Role
3640:
3641: sub definerole {
3642: if (allowed('mcr','/')) {
3643: my ($rolename,$sysrole,$domrole,$courole)=@_;
1.392 www 3644: foreach (split(':',$sysrole)) {
1.21 www 3645: my ($crole,$cqual)=split(/\&/,$_);
1.479 albertel 3646: if ($pr{'cr:s'}!~/\Q$crole\E/) { return "refused:s:$crole"; }
3647: if ($pr{'cr:s'}=~/\Q$crole\E\&/) {
3648: if ($pr{'cr:s'}!~/\Q$crole\E\&\w*\Q$cqual\E/) {
1.21 www 3649: return "refused:s:$crole&$cqual";
3650: }
3651: }
1.191 harris41 3652: }
1.392 www 3653: foreach (split(':',$domrole)) {
1.21 www 3654: my ($crole,$cqual)=split(/\&/,$_);
1.479 albertel 3655: if ($pr{'cr:d'}!~/\Q$crole\E/) { return "refused:d:$crole"; }
3656: if ($pr{'cr:d'}=~/\Q$crole\E\&/) {
3657: if ($pr{'cr:d'}!~/\Q$crole\W\&\w*\Q$cqual\E/) {
1.21 www 3658: return "refused:d:$crole&$cqual";
3659: }
3660: }
1.191 harris41 3661: }
1.392 www 3662: foreach (split(':',$courole)) {
1.21 www 3663: my ($crole,$cqual)=split(/\&/,$_);
1.479 albertel 3664: if ($pr{'cr:c'}!~/\Q$crole\E/) { return "refused:c:$crole"; }
3665: if ($pr{'cr:c'}=~/\Q$crole\E\&/) {
3666: if ($pr{'cr:c'}!~/\Q$crole\E\&\w*\Q$cqual\E/) {
1.21 www 3667: return "refused:c:$crole&$cqual";
3668: }
3669: }
1.191 harris41 3670: }
1.620 albertel 3671: my $command="encrypt:rolesput:$env{'user.domain'}:$env{'user.name'}:".
3672: "$env{'user.domain'}:$env{'user.name'}:".
1.21 www 3673: "rolesdef_$rolename=".
3674: escape($sysrole.'_'.$domrole.'_'.$courole);
1.620 albertel 3675: return reply($command,$env{'user.home'});
1.12 www 3676: } else {
3677: return 'refused';
3678: }
1.105 harris41 3679: }
3680:
3681: # ---------------- Make a metadata query against the network of library servers
3682:
3683: sub metadata_query {
1.244 matthew 3684: my ($query,$custom,$customshow,$server_array)=@_;
1.120 harris41 3685: my %rhash;
1.244 matthew 3686: my @server_list = (defined($server_array) ? @$server_array
3687: : keys(%libserv) );
3688: for my $server (@server_list) {
1.118 harris41 3689: unless ($custom or $customshow) {
3690: my $reply=&reply("querysend:".&escape($query),$server);
3691: $rhash{$server}=$reply;
3692: }
3693: else {
3694: my $reply=&reply("querysend:".&escape($query).':'.
3695: &escape($custom).':'.&escape($customshow),
3696: $server);
3697: $rhash{$server}=$reply;
3698: }
1.112 harris41 3699: }
1.118 harris41 3700: return \%rhash;
1.240 www 3701: }
3702:
3703: # ----------------------------------------- Send log queries and wait for reply
3704:
3705: sub log_query {
3706: my ($uname,$udom,$query,%filters)=@_;
3707: my $uhome=&homeserver($uname,$udom);
3708: if ($uhome eq 'no_host') { return 'error: no_host'; }
3709: my $uhost=$hostname{$uhome};
1.241 www 3710: my $command=&escape(join(':',map{$_.'='.$filters{$_}} keys %filters));
1.240 www 3711: my $queryid=&reply("querysend:".$query.':'.$udom.':'.$uname.':'.$command,
3712: $uhome);
1.479 albertel 3713: unless ($queryid=~/^\Q$uhost\E\_/) { return 'error: '.$queryid; }
1.242 www 3714: return get_query_reply($queryid);
3715: }
3716:
1.508 raeburn 3717: # ------- Request retrieval of institutional classlists for course(s)
1.506 raeburn 3718:
3719: sub fetch_enrollment_query {
1.511 raeburn 3720: my ($context,$affiliatesref,$replyref,$dom,$cnum) = @_;
1.508 raeburn 3721: my $homeserver;
1.547 raeburn 3722: my $maxtries = 1;
1.508 raeburn 3723: if ($context eq 'automated') {
3724: $homeserver = $perlvar{'lonHostID'};
1.547 raeburn 3725: $maxtries = 10; # will wait for up to 2000s for retrieval of classlist data before timeout
1.508 raeburn 3726: } else {
3727: $homeserver = &homeserver($cnum,$dom);
3728: }
1.506 raeburn 3729: my $host=$hostname{$homeserver};
3730: my $cmd = '';
3731: foreach (keys %{$affiliatesref}) {
1.508 raeburn 3732: $cmd .= $_.'='.join(",",@{$$affiliatesref{$_}}).'%%';
1.506 raeburn 3733: }
3734: $cmd =~ s/%%$//;
3735: $cmd = &escape($cmd);
3736: my $query = 'fetchenrollment';
1.620 albertel 3737: my $queryid=&reply("querysend:".$query.':'.$dom.':'.$env{'user.name'}.':'.$cmd,$homeserver);
1.526 raeburn 3738: unless ($queryid=~/^\Q$host\E\_/) {
3739: &logthis('fetch_enrollment_query: invalid queryid: '.$queryid.' for host: '.$host.' and homeserver: '.$homeserver.' context: '.$context.' '.$cnum);
3740: return 'error: '.$queryid;
3741: }
1.506 raeburn 3742: my $reply = &get_query_reply($queryid);
1.547 raeburn 3743: my $tries = 1;
3744: while (($reply=~/^timeout/) && ($tries < $maxtries)) {
3745: $reply = &get_query_reply($queryid);
3746: $tries ++;
3747: }
1.526 raeburn 3748: if ( ($reply =~/^timeout/) || ($reply =~/^error/) ) {
1.620 albertel 3749: &logthis('fetch_enrollment_query error: '.$reply.' for '.$dom.' '.$env{'user.name'}.' for '.$queryid.' context: '.$context.' '.$cnum.' maxtries: '.$maxtries.' tries: '.$tries);
1.526 raeburn 3750: } else {
1.515 raeburn 3751: my @responses = split/:/,$reply;
3752: if ($homeserver eq $perlvar{'lonHostID'}) {
3753: foreach (@responses) {
3754: my ($key,$value) = split/=/,$_;
3755: $$replyref{$key} = $value;
3756: }
3757: } else {
1.506 raeburn 3758: my $pathname = $perlvar{'lonDaemons'}.'/tmp';
3759: foreach (@responses) {
3760: my ($key,$value) = split/=/,$_;
3761: $$replyref{$key} = $value;
3762: if ($value > 0) {
3763: foreach (@{$$affiliatesref{$key}}) {
3764: my $filename = $dom.'_'.$key.'_'.$_.'_classlist.xml';
3765: my $destname = $pathname.'/'.$filename;
3766: my $xml_classlist = &reply("autoretrieve:".$filename,$homeserver);
1.526 raeburn 3767: if ($xml_classlist =~ /^error/) {
3768: &logthis('fetch_enrollment_query - autoretrieve error: '.$xml_classlist.' for '.$filename.' from server: '.$homeserver.' '.$context.' '.$cnum);
3769: } else {
1.506 raeburn 3770: if ( open(FILE,">$destname") ) {
3771: print FILE &unescape($xml_classlist);
3772: close(FILE);
1.526 raeburn 3773: } else {
3774: &logthis('fetch_enrollment_query - error opening classlist file '.$destname.' '.$context.' '.$cnum);
1.506 raeburn 3775: }
3776: }
3777: }
3778: }
3779: }
3780: }
3781: return 'ok';
3782: }
3783: return 'error';
3784: }
3785:
1.242 www 3786: sub get_query_reply {
3787: my $queryid=shift;
1.240 www 3788: my $replyfile=$perlvar{'lonDaemons'}.'/tmp/'.$queryid;
3789: my $reply='';
3790: for (1..100) {
3791: sleep 2;
3792: if (-e $replyfile.'.end') {
1.448 albertel 3793: if (open(my $fh,$replyfile)) {
1.240 www 3794: $reply.=<$fh>;
1.448 albertel 3795: close($fh);
1.240 www 3796: } else { return 'error: reply_file_error'; }
1.242 www 3797: return &unescape($reply);
3798: }
1.240 www 3799: }
1.242 www 3800: return 'timeout:'.$queryid;
1.240 www 3801: }
3802:
3803: sub courselog_query {
1.241 www 3804: #
3805: # possible filters:
3806: # url: url or symb
3807: # username
3808: # domain
3809: # action: view, submit, grade
3810: # start: timestamp
3811: # end: timestamp
3812: #
1.240 www 3813: my (%filters)=@_;
1.620 albertel 3814: unless ($env{'request.course.id'}) { return 'no_course'; }
1.241 www 3815: if ($filters{'url'}) {
3816: $filters{'url'}=&symbclean(&declutter($filters{'url'}));
3817: $filters{'url'}=~s/\.(\w+)$/(\\.\\d+)*\\.$1/;
3818: $filters{'url'}=~s/\.(\w+)\_\_\_/(\\.\\d+)*\\.$1/;
3819: }
1.620 albertel 3820: my $cname=$env{'course.'.$env{'request.course.id'}.'.num'};
3821: my $cdom=$env{'course.'.$env{'request.course.id'}.'.domain'};
1.240 www 3822: return &log_query($cname,$cdom,'courselog',%filters);
3823: }
3824:
3825: sub userlog_query {
3826: my ($uname,$udom,%filters)=@_;
3827: return &log_query($uname,$udom,'userlog',%filters);
1.12 www 3828: }
3829:
1.506 raeburn 3830: #--------- Call auto-enrollment subs in localenroll.pm for homeserver for course
3831:
3832: sub auto_run {
1.508 raeburn 3833: my ($cnum,$cdom) = @_;
3834: my $homeserver = &homeserver($cnum,$cdom);
1.511 raeburn 3835: my $response = &reply('autorun:'.$cdom,$homeserver);
1.506 raeburn 3836: return $response;
3837: }
3838:
3839: sub auto_get_sections {
1.508 raeburn 3840: my ($cnum,$cdom,$inst_coursecode) = @_;
3841: my $homeserver = &homeserver($cnum,$cdom);
1.506 raeburn 3842: my @secs = ();
1.511 raeburn 3843: my $response=&unescape(&reply('autogetsections:'.$inst_coursecode.':'.$cdom,$homeserver));
1.506 raeburn 3844: unless ($response eq 'refused') {
3845: @secs = split/:/,$response;
3846: }
3847: return @secs;
3848: }
3849:
3850: sub auto_new_course {
1.508 raeburn 3851: my ($cnum,$cdom,$inst_course_id,$owner) = @_;
3852: my $homeserver = &homeserver($cnum,$cdom);
1.515 raeburn 3853: my $response=&unescape(&reply('autonewcourse:'.$inst_course_id.':'.$owner.':'.$cdom,$homeserver));
1.506 raeburn 3854: return $response;
3855: }
3856:
3857: sub auto_validate_courseID {
1.508 raeburn 3858: my ($cnum,$cdom,$inst_course_id) = @_;
3859: my $homeserver = &homeserver($cnum,$cdom);
1.511 raeburn 3860: my $response=&unescape(&reply('autovalidatecourse:'.$inst_course_id.':'.$cdom,$homeserver));
1.506 raeburn 3861: return $response;
3862: }
3863:
3864: sub auto_create_password {
1.508 raeburn 3865: my ($cnum,$cdom,$authparam) = @_;
3866: my $homeserver = &homeserver($cnum,$cdom);
1.506 raeburn 3867: my $create_passwd = 0;
3868: my $authchk = '';
1.511 raeburn 3869: my $response=&unescape(&reply('autocreatepassword:'.$authparam.':'.$cdom,$homeserver));
1.506 raeburn 3870: if ($response eq 'refused') {
3871: $authchk = 'refused';
3872: } else {
3873: ($authparam,$create_passwd,$authchk) = split/:/,$response;
3874: }
3875: return ($authparam,$create_passwd,$authchk);
3876: }
3877:
1.706 raeburn 3878: sub auto_photo_permission {
3879: my ($cnum,$cdom,$students) = @_;
3880: my $homeserver = &homeserver($cnum,$cdom);
1.707 albertel 3881: my ($outcome,$perm_reqd,$conditions) =
3882: split(/:/,&unescape(&reply('autophotopermission:'.$cdom,$homeserver)),3);
1.709 albertel 3883: if ($outcome =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
3884: return (undef,undef);
3885: }
1.706 raeburn 3886: return ($outcome,$perm_reqd,$conditions);
3887: }
3888:
3889: sub auto_checkphotos {
3890: my ($uname,$udom,$pid) = @_;
3891: my $homeserver = &homeserver($uname,$udom);
3892: my ($result,$resulttype);
3893: my $outcome = &unescape(&reply('autophotocheck:'.&escape($udom).':'.
1.707 albertel 3894: &escape($uname).':'.&escape($pid),
3895: $homeserver));
1.709 albertel 3896: if ($outcome =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
3897: return (undef,undef);
3898: }
1.706 raeburn 3899: if ($outcome) {
3900: ($result,$resulttype) = split(/:/,$outcome);
3901: }
3902: return ($result,$resulttype);
3903: }
3904:
3905: sub auto_photochoice {
3906: my ($cnum,$cdom) = @_;
3907: my $homeserver = &homeserver($cnum,$cdom);
3908: my ($update,$comment) = split(/:/,&unescape(&reply('autophotochoice:'.
1.707 albertel 3909: &escape($cdom),
3910: $homeserver)));
1.709 albertel 3911: if ($update =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
3912: return (undef,undef);
3913: }
1.706 raeburn 3914: return ($update,$comment);
3915: }
3916:
3917: sub auto_photoupdate {
3918: my ($affiliatesref,$dom,$cnum,$photo) = @_;
3919: my $homeserver = &homeserver($cnum,$dom);
3920: my $host=$hostname{$homeserver};
3921: my $cmd = '';
3922: my $maxtries = 1;
3923: foreach (keys %{$affiliatesref}) {
3924: $cmd .= $_.'='.join(",",@{$$affiliatesref{$_}}).'%%';
3925: }
3926: $cmd =~ s/%%$//;
3927: $cmd = &escape($cmd);
3928: my $query = 'institutionalphotos';
3929: my $queryid=&reply("querysend:".$query.':'.$dom.':'.$cnum.':'.$cmd,$homeserver);
3930: unless ($queryid=~/^\Q$host\E\_/) {
3931: &logthis('institutionalphotos: invalid queryid: '.$queryid.' for host: '.$host.' and homeserver: '.$homeserver.' and course: '.$cnum);
3932: return 'error: '.$queryid;
3933: }
3934: my $reply = &get_query_reply($queryid);
3935: my $tries = 1;
3936: while (($reply=~/^timeout/) && ($tries < $maxtries)) {
3937: $reply = &get_query_reply($queryid);
3938: $tries ++;
3939: }
3940: if ( ($reply =~/^timeout/) || ($reply =~/^error/) ) {
3941: &logthis('institutionalphotos error: '.$reply.' for '.$dom.' '.$env{'user.name'}.' for '.$queryid.' course: '.$cnum.' maxtries: '.$maxtries.' tries: '.$tries);
3942: } else {
3943: my @responses = split(/:/,$reply);
3944: my $outcome = shift(@responses);
3945: foreach my $item (@responses) {
3946: my ($key,$value) = split(/=/,$item);
3947: $$photo{$key} = $value;
3948: }
3949: return $outcome;
3950: }
3951: return 'error';
3952: }
3953:
1.521 raeburn 3954: sub auto_instcode_format {
3955: my ($caller,$codedom,$instcodes,$codes,$codetitles,$cat_titles,$cat_order) = @_;
3956: my $courses = '';
3957: my $homeserver;
3958: if ($caller eq 'global') {
1.584 raeburn 3959: foreach my $tryserver (keys %libserv) {
3960: if ($hostdom{$tryserver} eq $codedom) {
3961: $homeserver = $tryserver;
3962: last;
3963: }
3964: }
1.620 albertel 3965: if (($env{'user.name'}) && ($env{'user.domain'} eq $codedom)) {
3966: $homeserver = &homeserver($env{'user.name'},$codedom);
1.584 raeburn 3967: }
1.521 raeburn 3968: } else {
3969: $homeserver = &homeserver($caller,$codedom);
3970: }
3971: foreach (keys %{$instcodes}) {
3972: $courses .= &escape($_).'='.&escape($$instcodes{$_}).'&';
3973: }
3974: chop($courses);
3975: my $response=&reply('autoinstcodeformat:'.$codedom.':'.$courses,$homeserver);
3976: unless ($response =~ /(con_lost|error|no_such_host|refused)/) {
3977: my ($codes_str,$codetitles_str,$cat_titles_str,$cat_order_str) = split/:/,$response;
3978: %{$codes} = &str2hash($codes_str);
3979: @{$codetitles} = &str2array($codetitles_str);
3980: %{$cat_titles} = &str2hash($cat_titles_str);
3981: %{$cat_order} = &str2hash($cat_order_str);
3982: return 'ok';
3983: }
3984: return $response;
3985: }
3986:
1.679 raeburn 3987: # ------------------------------------------------------- Course Group routines
3988:
3989: sub get_coursegroups {
1.683 raeburn 3990: my ($cdom,$cnum,$group) = @_;
3991: return(&dump('coursegroups',$cdom,$cnum,$group));
1.679 raeburn 3992: }
3993:
3994: sub modify_coursegroup {
3995: my ($cdom,$cnum,$groupsettings) = @_;
3996: return(&put('coursegroups',$groupsettings,$cdom,$cnum));
3997: }
3998:
3999: sub modify_group_roles {
4000: my ($cdom,$cnum,$group_id,$user,$end,$start,$userprivs) = @_;
4001: my $url = '/'.$cdom.'/'.$cnum.'/'.$group_id;
4002: my $role = 'gr/'.&escape($userprivs);
4003: my ($uname,$udom) = split(/:/,$user);
4004: my $result = &assignrole($udom,$uname,$url,$role,$end,$start);
1.684 raeburn 4005: if ($result eq 'ok') {
4006: &devalidate_getgroups_cache($udom,$uname,$cdom,$cnum);
4007: }
1.679 raeburn 4008: return $result;
4009: }
4010:
4011: sub modify_coursegroup_membership {
4012: my ($cdom,$cnum,$membership) = @_;
4013: my $result = &put('groupmembership',$membership,$cdom,$cnum);
4014: return $result;
4015: }
4016:
1.682 raeburn 4017: sub get_active_groups {
4018: my ($udom,$uname,$cdom,$cnum) = @_;
4019: my $now = time;
4020: my %groups = ();
4021: foreach my $key (keys(%env)) {
4022: if ($key =~ m-user\.role\.gr\./([^/]+)/([^/]+)/(\w+)$-) {
4023: my ($start,$end) = split(/\./,$env{$key});
4024: if (($end!=0) && ($end<$now)) { next; }
4025: if (($start!=0) && ($start>$now)) { next; }
4026: if ($1 eq $cdom && $2 eq $cnum) {
4027: $groups{$3} = $env{$key} ;
4028: }
4029: }
4030: }
4031: return %groups;
4032: }
4033:
1.683 raeburn 4034: sub get_group_membership {
4035: my ($cdom,$cnum,$group) = @_;
4036: return(&dump('groupmembership',$cdom,$cnum,$group));
4037: }
4038:
4039: sub get_users_groups {
4040: my ($udom,$uname,$courseid) = @_;
1.733 raeburn 4041: my @usersgroups;
1.683 raeburn 4042: my $cachetime=1800;
4043: $courseid=~s/\_/\//g;
4044: $courseid=~s/^(\w)/\/$1/;
4045:
4046: my $hashid="$udom:$uname:$courseid";
1.733 raeburn 4047: my ($grouplist,$cached)=&is_cached_new('getgroups',$hashid);
4048: if (defined($cached)) {
1.734 albertel 4049: @usersgroups = split(/:/,$grouplist);
1.733 raeburn 4050: } else {
4051: $grouplist = '';
4052: my %roleshash = &dump('roles',$udom,$uname,$courseid);
4053: my ($tmp) = keys(%roleshash);
4054: if ($tmp=~/^error:/) {
4055: &logthis('Error retrieving roles: '.$tmp.' for '.$uname.':'.$udom);
4056: } else {
4057: my $access_end = $env{'course.'.$courseid.
4058: '.default_enrollment_end_date'};
4059: my $now = time;
1.734 albertel 4060: foreach my $key (keys(%roleshash)) {
1.733 raeburn 4061: if ($key =~ /^\Q$courseid\E\/(\w+)\_gr$/) {
4062: my $group = $1;
4063: if ($roleshash{$key} =~ /_(\d+)_(\d+)$/) {
4064: my $start = $2;
4065: my $end = $1;
4066: if ($start == -1) { next; } # deleted from group
4067: if (($start!=0) && ($start>$now)) { next; }
4068: if (($end!=0) && ($end<$now)) {
4069: if ($access_end && $access_end < $now) {
4070: if ($access_end - $end < 86400) {
4071: push(@usersgroups,$group);
4072: }
4073: }
4074: next;
4075: }
4076: push(@usersgroups,$group);
4077: }
1.683 raeburn 4078: }
4079: }
1.733 raeburn 4080: @usersgroups = &sort_course_groups($courseid,@usersgroups);
4081: $grouplist = join(':',@usersgroups);
4082: &do_cache_new('getgroups',$hashid,$grouplist,$cachetime);
1.683 raeburn 4083: }
4084: }
1.733 raeburn 4085: return @usersgroups;
1.683 raeburn 4086: }
4087:
4088: sub devalidate_getgroups_cache {
4089: my ($udom,$uname,$cdom,$cnum)=@_;
4090: my $courseid = $cdom.'_'.$cnum;
4091: $courseid=~s/\_/\//g;
4092: $courseid=~s/^(\w)/\/$1/;
4093: my $hashid="$udom:$uname:$courseid";
4094: &devalidate_cache_new('getgroups',$hashid);
4095: }
4096:
1.12 www 4097: # ------------------------------------------------------------------ Plain Text
4098:
4099: sub plaintext {
1.22 www 4100: my $short=shift;
1.676 albertel 4101: return &Apache::lonlocal::mt($prp{$short});
1.12 www 4102: }
4103:
4104: # ----------------------------------------------------------------- Assign Role
4105:
4106: sub assignrole {
1.357 www 4107: my ($udom,$uname,$url,$role,$end,$start,$deleteflag)=@_;
1.21 www 4108: my $mrole;
4109: if ($role =~ /^cr\//) {
1.393 www 4110: my $cwosec=$url;
4111: $cwosec=~s/^\/(\w+)\/(\w+)\/.*/$1\/$2/;
4112: unless (&allowed('ccr',$cwosec)) {
1.104 www 4113: &logthis('Refused custom assignrole: '.
4114: $udom.' '.$uname.' '.$url.' '.$role.' '.$end.' '.$start.' by '.
1.620 albertel 4115: $env{'user.name'}.' at '.$env{'user.domain'});
1.104 www 4116: return 'refused';
4117: }
1.21 www 4118: $mrole='cr';
1.678 raeburn 4119: } elsif ($role =~ /^gr\//) {
4120: my $cwogrp=$url;
4121: $cwogrp=~s/^\/(\w+)\/(\w+)\/.*/$1\/$2/;
4122: unless (&allowed('mdg',$cwogrp)) {
4123: &logthis('Refused group assignrole: '.
4124: $udom.' '.$uname.' '.$url.' '.$role.' '.$end.' '.$start.' by '.
4125: $env{'user.name'}.' at '.$env{'user.domain'});
4126: return 'refused';
4127: }
4128: $mrole='gr';
1.21 www 4129: } else {
1.82 www 4130: my $cwosec=$url;
1.83 www 4131: $cwosec=~s/^\/(\w+)\/(\w+)\/.*/$1\/$2/;
1.373 www 4132: unless ((&allowed('c'.$role,$cwosec)) || &allowed('c'.$role,$udom)) {
1.104 www 4133: &logthis('Refused assignrole: '.
4134: $udom.' '.$uname.' '.$url.' '.$role.' '.$end.' '.$start.' by '.
1.620 albertel 4135: $env{'user.name'}.' at '.$env{'user.domain'});
1.104 www 4136: return 'refused';
4137: }
1.21 www 4138: $mrole=$role;
4139: }
1.620 albertel 4140: my $command="encrypt:rolesput:$env{'user.domain'}:$env{'user.name'}:".
1.21 www 4141: "$udom:$uname:$url".'_'."$mrole=$role";
1.81 www 4142: if ($end) { $command.='_'.$end; }
1.21 www 4143: if ($start) {
4144: if ($end) {
1.81 www 4145: $command.='_'.$start;
1.21 www 4146: } else {
1.81 www 4147: $command.='_0_'.$start;
1.21 www 4148: }
4149: }
1.739 raeburn 4150: my $origstart = $start;
4151: my $origend = $end;
1.357 www 4152: # actually delete
4153: if ($deleteflag) {
1.373 www 4154: if ((&allowed('dro',$udom)) || (&allowed('dro',$url))) {
1.357 www 4155: # modify command to delete the role
1.620 albertel 4156: $command="encrypt:rolesdel:$env{'user.domain'}:$env{'user.name'}:".
1.357 www 4157: "$udom:$uname:$url".'_'."$mrole";
1.620 albertel 4158: &logthis("$env{'user.name'} at $env{'user.domain'} deletes $mrole in $url for $uname at $udom");
1.357 www 4159: # set start and finish to negative values for userrolelog
4160: $start=-1;
4161: $end=-1;
4162: }
4163: }
4164: # send command
1.349 www 4165: my $answer=&reply($command,&homeserver($uname,$udom));
1.357 www 4166: # log new user role if status is ok
1.349 www 4167: if ($answer eq 'ok') {
1.663 raeburn 4168: &userrolelog($role,$uname,$udom,$url,$start,$end);
1.739 raeburn 4169: # for course roles, perform group memberships changes triggered by role change.
4170: unless ($role =~ /^gr/) {
4171: &Apache::longroup::group_changes($udom,$uname,$url,$role,$origend,
4172: $origstart);
4173: }
1.349 www 4174: }
4175: return $answer;
1.169 harris41 4176: }
4177:
4178: # -------------------------------------------------- Modify user authentication
1.197 www 4179: # Overrides without validation
4180:
1.169 harris41 4181: sub modifyuserauth {
4182: my ($udom,$uname,$umode,$upass)=@_;
4183: my $uhome=&homeserver($uname,$udom);
1.197 www 4184: unless (&allowed('mau',$udom)) { return 'refused'; }
4185: &logthis('Call to modify user authentication '.$udom.', '.$uname.', '.
1.620 albertel 4186: $umode.' by '.$env{'user.name'}.' at '.$env{'user.domain'}.
4187: ' in domain '.$env{'request.role.domain'});
1.169 harris41 4188: my $reply=&reply('encrypt:changeuserauth:'.$udom.':'.$uname.':'.$umode.':'.
4189: &escape($upass),$uhome);
1.620 albertel 4190: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},
1.197 www 4191: 'Authentication changed for '.$udom.', '.$uname.', '.$umode.
4192: '(Remote '.$ENV{'REMOTE_ADDR'}.'): '.$reply);
4193: &log($udom,,$uname,$uhome,
1.620 albertel 4194: 'Authentication changed by '.$env{'user.domain'}.', '.
4195: $env{'user.name'}.', '.$umode.
1.197 www 4196: '(Remote '.$ENV{'REMOTE_ADDR'}.'): '.$reply);
1.169 harris41 4197: unless ($reply eq 'ok') {
1.197 www 4198: &logthis('Authentication mode error: '.$reply);
1.169 harris41 4199: return 'error: '.$reply;
4200: }
1.170 harris41 4201: return 'ok';
1.80 www 4202: }
4203:
1.81 www 4204: # --------------------------------------------------------------- Modify a user
1.80 www 4205:
1.81 www 4206: sub modifyuser {
1.206 matthew 4207: my ($udom, $uname, $uid,
4208: $umode, $upass, $first,
4209: $middle, $last, $gene,
1.387 www 4210: $forceid, $desiredhome, $email)=@_;
1.198 www 4211: $udom=~s/\W//g;
4212: $uname=~s/\W//g;
1.81 www 4213: &logthis('Call to modify user '.$udom.', '.$uname.', '.$uid.', '.
1.80 www 4214: $umode.', '.$first.', '.$middle.', '.
1.206 matthew 4215: $last.', '.$gene.'(forceid: '.$forceid.')'.
4216: (defined($desiredhome) ? ' desiredhome = '.$desiredhome :
4217: ' desiredhome not specified').
1.620 albertel 4218: ' by '.$env{'user.name'}.' at '.$env{'user.domain'}.
4219: ' in domain '.$env{'request.role.domain'});
1.230 stredwic 4220: my $uhome=&homeserver($uname,$udom,'true');
1.80 www 4221: # ----------------------------------------------------------------- Create User
1.406 albertel 4222: if (($uhome eq 'no_host') &&
4223: (($umode && $upass) || ($umode eq 'localauth'))) {
1.80 www 4224: my $unhome='';
1.209 matthew 4225: if (defined($desiredhome) && $hostdom{$desiredhome} eq $udom) {
4226: $unhome = $desiredhome;
1.620 albertel 4227: } elsif($env{'course.'.$env{'request.course.id'}.'.domain'} eq $udom) {
4228: $unhome=$env{'course.'.$env{'request.course.id'}.'.home'};
1.209 matthew 4229: } else { # load balancing routine for determining $unhome
1.80 www 4230: my $tryserver;
1.81 www 4231: my $loadm=10000000;
1.80 www 4232: foreach $tryserver (keys %libserv) {
4233: if ($hostdom{$tryserver} eq $udom) {
4234: my $answer=reply('load',$tryserver);
4235: if (($answer=~/\d+/) && ($answer<$loadm)) {
4236: $loadm=$answer;
4237: $unhome=$tryserver;
4238: }
4239: }
4240: }
4241: }
4242: if (($unhome eq '') || ($unhome eq 'no_host')) {
1.206 matthew 4243: return 'error: unable to find a home server for '.$uname.
4244: ' in domain '.$udom;
1.80 www 4245: }
4246: my $reply=&reply('encrypt:makeuser:'.$udom.':'.$uname.':'.$umode.':'.
4247: &escape($upass),$unhome);
4248: unless ($reply eq 'ok') {
4249: return 'error: '.$reply;
4250: }
1.230 stredwic 4251: $uhome=&homeserver($uname,$udom,'true');
1.80 www 4252: if (($uhome eq '') || ($uhome eq 'no_host') || ($uhome ne $unhome)) {
1.386 matthew 4253: return 'error: unable verify users home machine.';
1.80 www 4254: }
1.209 matthew 4255: } # End of creation of new user
1.80 www 4256: # ---------------------------------------------------------------------- Add ID
4257: if ($uid) {
4258: $uid=~tr/A-Z/a-z/;
4259: my %uidhash=&idrget($udom,$uname);
1.196 www 4260: if (($uidhash{$uname}) && ($uidhash{$uname}!~/error\:/)
4261: && (!$forceid)) {
1.80 www 4262: unless ($uid eq $uidhash{$uname}) {
1.386 matthew 4263: return 'error: user id "'.$uid.'" does not match '.
4264: 'current user id "'.$uidhash{$uname}.'".';
1.80 www 4265: }
4266: } else {
4267: &idput($udom,($uname => $uid));
4268: }
4269: }
4270: # -------------------------------------------------------------- Add names, etc
1.313 matthew 4271: my @tmp=&get('environment',
1.134 albertel 4272: ['firstname','middlename','lastname','generation'],
4273: $udom,$uname);
1.313 matthew 4274: my %names;
4275: if ($tmp[0] =~ m/^error:.*/) {
4276: %names=();
4277: } else {
4278: %names = @tmp;
4279: }
1.388 www 4280: #
4281: # Make sure to not trash student environment if instructor does not bother
4282: # to supply name and email information
4283: #
4284: if ($first) { $names{'firstname'} = $first; }
1.385 matthew 4285: if (defined($middle)) { $names{'middlename'} = $middle; }
1.388 www 4286: if ($last) { $names{'lastname'} = $last; }
1.385 matthew 4287: if (defined($gene)) { $names{'generation'} = $gene; }
1.592 www 4288: if ($email) {
4289: $email=~s/[^\w\@\.\-\,]//gs;
4290: if ($email=~/\@/) { $names{'notification'} = $email;
4291: $names{'critnotification'} = $email;
4292: $names{'permanentemail'} = $email; }
4293: }
1.134 albertel 4294: my $reply = &put('environment', \%names, $udom,$uname);
4295: if ($reply ne 'ok') { return 'error: '.$reply; }
1.680 www 4296: &devalidate_cache_new('namescache',$uname.':'.$udom);
1.81 www 4297: &logthis('Success modifying user '.$udom.', '.$uname.', '.$uid.', '.
1.80 www 4298: $umode.', '.$first.', '.$middle.', '.
4299: $last.', '.$gene.' by '.
1.620 albertel 4300: $env{'user.name'}.' at '.$env{'user.domain'});
1.134 albertel 4301: return 'ok';
1.80 www 4302: }
4303:
1.81 www 4304: # -------------------------------------------------------------- Modify student
1.80 www 4305:
1.81 www 4306: sub modifystudent {
4307: my ($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene,$usec,
1.515 raeburn 4308: $end,$start,$forceid,$desiredhome,$email,$type,$locktype,$cid)=@_;
1.455 albertel 4309: if (!$cid) {
1.620 albertel 4310: unless ($cid=$env{'request.course.id'}) {
1.455 albertel 4311: return 'not_in_class';
4312: }
1.80 www 4313: }
4314: # --------------------------------------------------------------- Make the user
1.81 www 4315: my $reply=&modifyuser
1.209 matthew 4316: ($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene,$forceid,
1.387 www 4317: $desiredhome,$email);
1.80 www 4318: unless ($reply eq 'ok') { return $reply; }
1.297 matthew 4319: # This will cause &modify_student_enrollment to get the uid from the
4320: # students environment
4321: $uid = undef if (!$forceid);
1.455 albertel 4322: $reply = &modify_student_enrollment($udom,$uname,$uid,$first,$middle,$last,
1.515 raeburn 4323: $gene,$usec,$end,$start,$type,$locktype,$cid);
1.297 matthew 4324: return $reply;
4325: }
4326:
4327: sub modify_student_enrollment {
1.515 raeburn 4328: my ($udom,$uname,$uid,$first,$middle,$last,$gene,$usec,$end,$start,$type,$locktype,$cid) = @_;
1.455 albertel 4329: my ($cdom,$cnum,$chome);
4330: if (!$cid) {
1.620 albertel 4331: unless ($cid=$env{'request.course.id'}) {
1.455 albertel 4332: return 'not_in_class';
4333: }
1.620 albertel 4334: $cdom=$env{'course.'.$cid.'.domain'};
4335: $cnum=$env{'course.'.$cid.'.num'};
1.455 albertel 4336: } else {
4337: ($cdom,$cnum)=split(/_/,$cid);
4338: }
1.620 albertel 4339: $chome=$env{'course.'.$cid.'.home'};
1.455 albertel 4340: if (!$chome) {
1.457 raeburn 4341: $chome=&homeserver($cnum,$cdom);
1.297 matthew 4342: }
1.455 albertel 4343: if (!$chome) { return 'unknown_course'; }
1.297 matthew 4344: # Make sure the user exists
1.81 www 4345: my $uhome=&homeserver($uname,$udom);
4346: if (($uhome eq '') || ($uhome eq 'no_host')) {
4347: return 'error: no such user';
4348: }
1.297 matthew 4349: # Get student data if we were not given enough information
4350: if (!defined($first) || $first eq '' ||
4351: !defined($last) || $last eq '' ||
4352: !defined($uid) || $uid eq '' ||
4353: !defined($middle) || $middle eq '' ||
4354: !defined($gene) || $gene eq '') {
1.294 matthew 4355: # They did not supply us with enough data to enroll the student, so
4356: # we need to pick up more information.
1.297 matthew 4357: my %tmp = &get('environment',
1.294 matthew 4358: ['firstname','middlename','lastname', 'generation','id']
1.297 matthew 4359: ,$udom,$uname);
4360:
1.455 albertel 4361: #foreach (keys(%tmp)) {
4362: # &logthis("key $_ = ".$tmp{$_});
4363: #}
1.294 matthew 4364: $first = $tmp{'firstname'} if (!defined($first) || $first eq '');
4365: $middle = $tmp{'middlename'} if (!defined($middle) || $middle eq '');
4366: $last = $tmp{'lastname'} if (!defined($last) || $last eq '');
1.297 matthew 4367: $gene = $tmp{'generation'} if (!defined($gene) || $gene eq '');
1.294 matthew 4368: $uid = $tmp{'id'} if (!defined($uid) || $uid eq '');
4369: }
1.556 albertel 4370: my $fullname = &format_name($first,$middle,$last,$gene,'lastname');
1.487 albertel 4371: my $reply=cput('classlist',
4372: {"$uname:$udom" =>
1.515 raeburn 4373: join(':',$end,$start,$uid,$usec,$fullname,$type,$locktype) },
1.487 albertel 4374: $cdom,$cnum);
1.81 www 4375: unless (($reply eq 'ok') || ($reply eq 'delayed')) {
4376: return 'error: '.$reply;
1.652 albertel 4377: } else {
4378: &devalidate_getsection_cache($udom,$uname,$cid);
1.81 www 4379: }
1.297 matthew 4380: # Add student role to user
1.83 www 4381: my $uurl='/'.$cid;
1.81 www 4382: $uurl=~s/\_/\//g;
4383: if ($usec) {
4384: $uurl.='/'.$usec;
4385: }
4386: return &assignrole($udom,$uname,$uurl,'st',$end,$start);
1.21 www 4387: }
4388:
1.556 albertel 4389: sub format_name {
4390: my ($firstname,$middlename,$lastname,$generation,$first)=@_;
4391: my $name;
4392: if ($first ne 'lastname') {
4393: $name=$firstname.' '.$middlename.' '.$lastname.' '.$generation;
4394: } else {
4395: if ($lastname=~/\S/) {
4396: $name.= $lastname.' '.$generation.', '.$firstname.' '.$middlename;
4397: $name=~s/\s+,/,/;
4398: } else {
4399: $name.= $firstname.' '.$middlename.' '.$generation;
4400: }
4401: }
4402: $name=~s/^\s+//;
4403: $name=~s/\s+$//;
4404: $name=~s/\s+/ /g;
4405: return $name;
4406: }
4407:
1.84 www 4408: # ------------------------------------------------- Write to course preferences
4409:
4410: sub writecoursepref {
4411: my ($courseid,%prefs)=@_;
4412: $courseid=~s/^\///;
4413: $courseid=~s/\_/\//g;
4414: my ($cdomain,$cnum)=split(/\//,$courseid);
4415: my $chome=homeserver($cnum,$cdomain);
4416: if (($chome eq '') || ($chome eq 'no_host')) {
4417: return 'error: no such course';
4418: }
4419: my $cstring='';
1.191 harris41 4420: foreach (keys %prefs) {
1.84 www 4421: $cstring.=escape($_).'='.escape($prefs{$_}).'&';
1.191 harris41 4422: }
1.84 www 4423: $cstring=~s/\&$//;
4424: return reply('put:'.$cdomain.':'.$cnum.':environment:'.$cstring,$chome);
4425: }
4426:
4427: # ---------------------------------------------------------- Make/modify course
4428:
4429: sub createcourse {
1.741 ! raeburn 4430: my ($udom,$description,$url,$course_server,$nonstandard,$inst_code,
! 4431: $course_owner,$crstype)=@_;
1.84 www 4432: $url=&declutter($url);
4433: my $cid='';
1.264 matthew 4434: unless (&allowed('ccc',$udom)) {
1.84 www 4435: return 'refused';
4436: }
4437: # ------------------------------------------------------------------- Create ID
1.674 www 4438: my $uname=int(1+rand(9)).
4439: ('a'..'z','A'..'Z','0'..'9')[int(rand(62))].
4440: substr($$.time,0,5).unpack("H8",pack("I32",time)).
1.84 www 4441: unpack("H2",pack("I32",int(rand(255)))).$perlvar{'lonHostID'};
4442: # ----------------------------------------------- Make sure that does not exist
1.230 stredwic 4443: my $uhome=&homeserver($uname,$udom,'true');
1.84 www 4444: unless (($uhome eq '') || ($uhome eq 'no_host')) {
4445: $uname=substr($$.time,0,5).unpack("H8",pack("I32",time)).
4446: unpack("H2",pack("I32",int(rand(255)))).$perlvar{'lonHostID'};
1.230 stredwic 4447: $uhome=&homeserver($uname,$udom,'true');
1.84 www 4448: unless (($uhome eq '') || ($uhome eq 'no_host')) {
4449: return 'error: unable to generate unique course-ID';
4450: }
4451: }
1.264 matthew 4452: # ------------------------------------------------ Check supplied server name
1.620 albertel 4453: $course_server = $env{'user.homeserver'} if (! defined($course_server));
1.264 matthew 4454: if (! exists($libserv{$course_server})) {
4455: return 'error:bad server name '.$course_server;
4456: }
1.84 www 4457: # ------------------------------------------------------------- Make the course
4458: my $reply=&reply('encrypt:makeuser:'.$udom.':'.$uname.':none::',
1.264 matthew 4459: $course_server);
1.84 www 4460: unless ($reply eq 'ok') { return 'error: '.$reply; }
1.230 stredwic 4461: $uhome=&homeserver($uname,$udom,'true');
1.84 www 4462: if (($uhome eq '') || ($uhome eq 'no_host')) {
4463: return 'error: no such course';
4464: }
1.271 www 4465: # ----------------------------------------------------------------- Course made
1.516 raeburn 4466: # log existence
4467: &courseidput($udom,&escape($udom.'_'.$uname).'='.&escape($description).
1.741 ! raeburn 4468: ':'.&escape($inst_code).':'.&escape($course_owner).':'.
! 4469: &escape($crstype),$uhome);
1.358 www 4470: &flushcourselogs();
4471: # set toplevel url
1.271 www 4472: my $topurl=$url;
4473: unless ($nonstandard) {
4474: # ------------------------------------------ For standard courses, make top url
4475: my $mapurl=&clutter($url);
1.278 www 4476: if ($mapurl eq '/res/') { $mapurl=''; }
1.620 albertel 4477: $env{'form.initmap'}=(<<ENDINITMAP);
1.271 www 4478: <map>
4479: <resource id="1" type="start"></resource>
4480: <resource id="2" src="$mapurl"></resource>
4481: <resource id="3" type="finish"></resource>
4482: <link index="1" from="1" to="2"></link>
4483: <link index="2" from="2" to="3"></link>
4484: </map>
4485: ENDINITMAP
4486: $topurl=&declutter(
1.638 albertel 4487: &finishuserfileupload($uname,$udom,'initmap','default.sequence')
1.271 www 4488: );
4489: }
4490: # ----------------------------------------------------------- Write preferences
1.84 www 4491: &writecoursepref($udom.'_'.$uname,
4492: ('description' => $description,
1.271 www 4493: 'url' => $topurl));
1.84 www 4494: return '/'.$udom.'/'.$uname;
4495: }
4496:
1.21 www 4497: # ---------------------------------------------------------- Assign Custom Role
4498:
4499: sub assigncustomrole {
1.357 www 4500: my ($udom,$uname,$url,$rdom,$rnam,$rolename,$end,$start,$deleteflag)=@_;
1.21 www 4501: return &assignrole($udom,$uname,$url,'cr/'.$rdom.'/'.$rnam.'/'.$rolename,
1.357 www 4502: $end,$start,$deleteflag);
1.21 www 4503: }
4504:
4505: # ----------------------------------------------------------------- Revoke Role
4506:
4507: sub revokerole {
1.357 www 4508: my ($udom,$uname,$url,$role,$deleteflag)=@_;
1.21 www 4509: my $now=time;
1.357 www 4510: return &assignrole($udom,$uname,$url,$role,$now,$deleteflag);
1.21 www 4511: }
4512:
4513: # ---------------------------------------------------------- Revoke Custom Role
4514:
4515: sub revokecustomrole {
1.357 www 4516: my ($udom,$uname,$url,$rdom,$rnam,$rolename,$deleteflag)=@_;
1.21 www 4517: my $now=time;
1.357 www 4518: return &assigncustomrole($udom,$uname,$url,$rdom,$rnam,$rolename,$now,
4519: $deleteflag);
1.17 www 4520: }
4521:
1.533 banghart 4522: # ------------------------------------------------------------ Disk usage
1.535 albertel 4523: sub diskusage {
1.533 banghart 4524: my ($udom,$uname,$directoryRoot)=@_;
4525: $directoryRoot =~ s/\/$//;
1.535 albertel 4526: my $listing=&reply('du:'.$directoryRoot,homeserver($uname,$udom));
1.514 albertel 4527: return $listing;
1.512 banghart 4528: }
4529:
1.566 banghart 4530: sub is_locked {
4531: my ($file_name, $domain, $user) = @_;
4532: my @check;
4533: my $is_locked;
4534: push @check, $file_name;
1.613 albertel 4535: my %locked = &get('file_permissions',\@check,
1.620 albertel 4536: $env{'user.domain'},$env{'user.name'});
1.615 albertel 4537: my ($tmp)=keys(%locked);
4538: if ($tmp=~/^error:/) { undef(%locked); }
1.613 albertel 4539:
1.566 banghart 4540: if (ref($locked{$file_name}) eq 'ARRAY') {
4541: $is_locked = 'true';
4542: } else {
4543: $is_locked = 'false';
4544: }
4545: }
4546:
1.559 banghart 4547: # ------------------------------------------------------------- Mark as Read Only
4548:
4549: sub mark_as_readonly {
4550: my ($domain,$user,$files,$what) = @_;
1.613 albertel 4551: my %current_permissions = &dump('file_permissions',$domain,$user);
1.615 albertel 4552: my ($tmp)=keys(%current_permissions);
4553: if ($tmp=~/^error:/) { undef(%current_permissions); }
1.560 banghart 4554: foreach my $file (@{$files}) {
1.561 banghart 4555: push(@{$current_permissions{$file}},$what);
1.559 banghart 4556: }
1.613 albertel 4557: &put('file_permissions',\%current_permissions,$domain,$user);
1.559 banghart 4558: return;
4559: }
4560:
1.572 banghart 4561: # ------------------------------------------------------------Save Selected Files
4562:
4563: sub save_selected_files {
4564: my ($user, $path, @files) = @_;
4565: my $filename = $user."savedfiles";
1.573 banghart 4566: my @other_files = &files_not_in_path($user, $path);
1.574 banghart 4567: open (OUT, '>'.$Apache::lonnet::perlvar{'lonDaemons'}.'/tmp/'.$filename);
1.573 banghart 4568: foreach my $file (@files) {
1.620 albertel 4569: print (OUT $env{'form.currentpath'}.$file."\n");
1.573 banghart 4570: }
4571: foreach my $file (@other_files) {
1.574 banghart 4572: print (OUT $file."\n");
1.572 banghart 4573: }
1.574 banghart 4574: close (OUT);
1.572 banghart 4575: return 'ok';
4576: }
4577:
1.574 banghart 4578: sub clear_selected_files {
4579: my ($user) = @_;
4580: my $filename = $user."savedfiles";
4581: open (OUT, '>'.$Apache::lonnet::perlvar{'lonDaemons'}.'/tmp/'.$filename);
4582: print (OUT undef);
4583: close (OUT);
4584: return ("ok");
4585: }
4586:
1.572 banghart 4587: sub files_in_path {
4588: my ($user, $path) = @_;
4589: my $filename = $user."savedfiles";
4590: my %return_files;
1.574 banghart 4591: open (IN, '<'.$Apache::lonnet::perlvar{'lonDaemons'}.'/tmp/'.$filename);
1.573 banghart 4592: while (my $line_in = <IN>) {
1.574 banghart 4593: chomp ($line_in);
4594: my @paths_and_file = split (m!/!, $line_in);
4595: my $file_part = pop (@paths_and_file);
4596: my $path_part = join ('/', @paths_and_file);
1.573 banghart 4597: $path_part.='/';
4598: my $path_and_file = $path_part.$file_part;
4599: if ($path_part eq $path) {
4600: $return_files{$file_part}= 'selected';
4601: }
4602: }
1.574 banghart 4603: close (IN);
4604: return (\%return_files);
1.572 banghart 4605: }
4606:
4607: # called in portfolio select mode, to show files selected NOT in current directory
4608: sub files_not_in_path {
4609: my ($user, $path) = @_;
4610: my $filename = $user."savedfiles";
4611: my @return_files;
4612: my $path_part;
1.574 banghart 4613: open (IN, '<'.$Apache::lonnet::perlvar{'lonDaemons'}.'/tmp/'.$filename);
1.572 banghart 4614: while (<IN>) {
4615: #ok, I know it's clunky, but I want it to work
4616: my @paths_and_file = split m!/!, $_;
1.574 banghart 4617: my $file_part = pop (@paths_and_file);
4618: chomp ($file_part);
4619: my $path_part = join ('/', @paths_and_file);
1.572 banghart 4620: $path_part .= '/';
4621: my $path_and_file = $path_part.$file_part;
4622: if ($path_part ne $path) {
1.574 banghart 4623: push (@return_files, ($path_and_file));
1.572 banghart 4624: }
4625: }
1.574 banghart 4626: close (OUT);
4627: return (@return_files);
1.572 banghart 4628: }
4629:
1.561 banghart 4630: #--------------------------------------------------------------Get Marked as Read Only
4631:
1.629 banghart 4632:
1.561 banghart 4633: sub get_marked_as_readonly {
4634: my ($domain,$user,$what) = @_;
1.613 albertel 4635: my %current_permissions = &dump('file_permissions',$domain,$user);
1.615 albertel 4636: my ($tmp)=keys(%current_permissions);
4637: if ($tmp=~/^error:/) { undef(%current_permissions); }
1.563 banghart 4638: my @readonly_files;
1.629 banghart 4639: my $cmp1=$what;
4640: if (ref($what)) { $cmp1=join('',@{$what}) };
1.563 banghart 4641: while (my ($file_name,$value) = each(%current_permissions)) {
1.561 banghart 4642: if (ref($value) eq "ARRAY"){
4643: foreach my $stored_what (@{$value}) {
1.629 banghart 4644: my $cmp2=$stored_what;
4645: if (ref($stored_what)) { $cmp2=join('',@{$stored_what}) };
4646: if ($cmp1 eq $cmp2) {
1.561 banghart 4647: push(@readonly_files, $file_name);
1.563 banghart 4648: } elsif (!defined($what)) {
4649: push(@readonly_files, $file_name);
1.561 banghart 4650: }
4651: }
4652: }
4653: }
4654: return @readonly_files;
4655: }
1.577 banghart 4656: #-----------------------------------------------------------Get Marked as Read Only Hash
1.561 banghart 4657:
1.577 banghart 4658: sub get_marked_as_readonly_hash {
4659: my ($domain,$user,$what) = @_;
1.613 albertel 4660: my %current_permissions = &dump('file_permissions',$domain,$user);
1.615 albertel 4661: my ($tmp)=keys(%current_permissions);
4662: if ($tmp=~/^error:/) { undef(%current_permissions); }
1.613 albertel 4663:
1.577 banghart 4664: my %readonly_files;
4665: while (my ($file_name,$value) = each(%current_permissions)) {
4666: if (ref($value) eq "ARRAY"){
4667: foreach my $stored_what (@{$value}) {
4668: if ($stored_what eq $what) {
4669: $readonly_files{$file_name} = 'locked';
4670: } elsif (!defined($what)) {
4671: $readonly_files{$file_name} = 'locked';
4672: }
4673: }
4674: }
4675: }
4676: return %readonly_files;
4677: }
1.559 banghart 4678: # ------------------------------------------------------------ Unmark as Read Only
4679:
4680: sub unmark_as_readonly {
1.629 banghart 4681: # unmarks $file_name (if $file_name is defined), or all files locked by $what
4682: # for portfolio submissions, $what contains [$symb,$crsid]
4683: my ($domain,$user,$what,$file_name) = @_;
1.634 albertel 4684: my $symb_crs = $what;
4685: if (ref($what)) { $symb_crs=join('',@$what); }
1.613 albertel 4686: my %current_permissions = &dump('file_permissions',$domain,$user);
1.615 albertel 4687: my ($tmp)=keys(%current_permissions);
4688: if ($tmp=~/^error:/) { undef(%current_permissions); }
1.613 albertel 4689: my @readonly_files = &get_marked_as_readonly($domain,$user,$what);
1.650 albertel 4690: foreach my $file (@readonly_files) {
4691: if (defined($file_name) && ($file_name ne $file)) { next; }
4692: my $current_locks = $current_permissions{$file};
1.563 banghart 4693: my @new_locks;
4694: my @del_keys;
4695: if (ref($current_locks) eq "ARRAY"){
4696: foreach my $locker (@{$current_locks}) {
1.632 albertel 4697: my $compare=$locker;
4698: if (ref($locker)) { $compare=join('',@{$locker}) };
1.650 albertel 4699: if ($compare ne $symb_crs) {
4700: push(@new_locks, $locker);
1.563 banghart 4701: }
4702: }
1.650 albertel 4703: if (scalar(@new_locks) > 0) {
1.563 banghart 4704: $current_permissions{$file} = \@new_locks;
4705: } else {
4706: push(@del_keys, $file);
1.613 albertel 4707: &del('file_permissions',\@del_keys, $domain, $user);
1.650 albertel 4708: delete($current_permissions{$file});
1.563 banghart 4709: }
4710: }
1.561 banghart 4711: }
1.613 albertel 4712: &put('file_permissions',\%current_permissions,$domain,$user);
1.559 banghart 4713: return;
4714: }
1.512 banghart 4715:
1.17 www 4716: # ------------------------------------------------------------ Directory lister
4717:
4718: sub dirlist {
1.253 stredwic 4719: my ($uri,$userdomain,$username,$alternateDirectoryRoot)=@_;
4720:
1.18 www 4721: $uri=~s/^\///;
4722: $uri=~s/\/$//;
1.253 stredwic 4723: my ($udom, $uname);
4724: (undef,$udom,$uname)=split(/\//,$uri);
4725: if(defined($userdomain)) {
4726: $udom = $userdomain;
4727: }
4728: if(defined($username)) {
4729: $uname = $username;
4730: }
4731:
4732: my $dirRoot = $perlvar{'lonDocRoot'};
4733: if(defined($alternateDirectoryRoot)) {
4734: $dirRoot = $alternateDirectoryRoot;
4735: $dirRoot =~ s/\/$//;
4736: }
4737:
4738: if($udom) {
4739: if($uname) {
1.605 matthew 4740: my $listing=reply('ls2:'.$dirRoot.'/'.$uri,
1.253 stredwic 4741: homeserver($uname,$udom));
1.605 matthew 4742: my @listing_results;
4743: if ($listing eq 'unknown_cmd') {
4744: $listing=reply('ls:'.$dirRoot.'/'.$uri,
4745: homeserver($uname,$udom));
4746: @listing_results = split(/:/,$listing);
4747: } else {
4748: @listing_results = map { &unescape($_); } split(/:/,$listing);
4749: }
4750: return @listing_results;
1.253 stredwic 4751: } elsif(!defined($alternateDirectoryRoot)) {
4752: my $tryserver;
4753: my %allusers=();
4754: foreach $tryserver (keys %libserv) {
4755: if($hostdom{$tryserver} eq $udom) {
1.605 matthew 4756: my $listing=reply('ls2:'.$perlvar{'lonDocRoot'}.'/res/'.
1.253 stredwic 4757: $udom, $tryserver);
1.605 matthew 4758: my @listing_results;
4759: if ($listing eq 'unknown_cmd') {
4760: $listing=reply('ls:'.$perlvar{'lonDocRoot'}.'/res/'.
4761: $udom, $tryserver);
4762: @listing_results = split(/:/,$listing);
4763: } else {
4764: @listing_results =
4765: map { &unescape($_); } split(/:/,$listing);
4766: }
4767: if ($listing_results[0] ne 'no_such_dir' &&
4768: $listing_results[0] ne 'empty' &&
4769: $listing_results[0] ne 'con_lost') {
4770: foreach (@listing_results) {
1.253 stredwic 4771: my ($entry,@stat)=split(/&/,$_);
4772: $allusers{$entry}=1;
4773: }
4774: }
1.191 harris41 4775: }
1.253 stredwic 4776: }
4777: my $alluserstr='';
4778: foreach (sort keys %allusers) {
4779: $alluserstr.=$_.'&user:';
4780: }
4781: $alluserstr=~s/:$//;
4782: return split(/:/,$alluserstr);
4783: } else {
4784: my @emptyResults = ();
4785: push(@emptyResults, 'missing user name');
4786: return split(':',@emptyResults);
4787: }
4788: } elsif(!defined($alternateDirectoryRoot)) {
4789: my $tryserver;
4790: my %alldom=();
4791: foreach $tryserver (keys %libserv) {
4792: $alldom{$hostdom{$tryserver}}=1;
4793: }
4794: my $alldomstr='';
4795: foreach (sort keys %alldom) {
1.397 albertel 4796: $alldomstr.=$perlvar{'lonDocRoot'}.'/res/'.$_.'/&domain:';
1.253 stredwic 4797: }
4798: $alldomstr=~s/:$//;
4799: return split(/:/,$alldomstr);
4800: } else {
4801: my @emptyResults = ();
4802: push(@emptyResults, 'missing domain');
4803: return split(':',@emptyResults);
1.275 stredwic 4804: }
4805: }
4806:
4807: # --------------------------------------------- GetFileTimestamp
4808: # This function utilizes dirlist and returns the date stamp for
4809: # when it was last modified. It will also return an error of -1
4810: # if an error occurs
4811:
1.410 matthew 4812: ##
4813: ## FIXME: This subroutine assumes its caller knows something about the
4814: ## directory structure of the home server for the student ($root).
4815: ## Not a good assumption to make. Since this is for looking up files
4816: ## in user directories, the full path should be constructed by lond, not
4817: ## whatever machine we request data from.
4818: ##
1.275 stredwic 4819: sub GetFileTimestamp {
4820: my ($studentDomain,$studentName,$filename,$root)=@_;
4821: $studentDomain=~s/\W//g;
4822: $studentName=~s/\W//g;
4823: my $subdir=$studentName.'__';
4824: $subdir =~ s/(.)(.)(.).*/$1\/$2\/$3/;
4825: my $proname="$studentDomain/$subdir/$studentName";
4826: $proname .= '/'.$filename;
1.375 matthew 4827: my ($fileStat) = &Apache::lonnet::dirlist($proname, $studentDomain,
4828: $studentName, $root);
1.275 stredwic 4829: my @stats = split('&', $fileStat);
4830: if($stats[0] ne 'empty' && $stats[0] ne 'no_such_dir') {
1.375 matthew 4831: # @stats contains first the filename, then the stat output
4832: return $stats[10]; # so this is 10 instead of 9.
1.275 stredwic 4833: } else {
4834: return -1;
1.253 stredwic 4835: }
1.26 www 4836: }
4837:
1.712 albertel 4838: sub stat_file {
4839: my ($uri) = @_;
1.722 albertel 4840: $uri = &clutter($uri);
4841:
4842: # we want just the url part without the unneeded accessor url bits
1.723 banghart 4843: if ($uri =~ m-^/adm/-) {
4844: $uri=~s-^/adm/wrapper/-/-;
4845: $uri=~s-^/adm/coursedocs/showdoc/-/-;
1.722 albertel 4846: }
1.712 albertel 4847: my ($udom,$uname,$file,$dir);
4848: if ($uri =~ m-^/(uploaded|editupload)/-) {
4849: ($udom,$uname,$file) =
4850: ($uri =~ m-/(?:uploaded|editupload)/?([^/]*)/?([^/]*)/?(.*)-);
4851: $file = 'userfiles/'.$file;
1.740 www 4852: $dir = &propath($udom,$uname);
1.712 albertel 4853: }
4854: if ($uri =~ m-^/res/-) {
4855: ($udom,$uname) =
4856: ($uri =~ m-/(?:res)/?([^/]*)/?([^/]*)/-);
4857: $file = $uri;
4858: }
4859:
4860: if (!$udom || !$uname || !$file) {
4861: # unable to handle the uri
4862: return ();
4863: }
4864:
4865: my ($result) = &dirlist($file,$udom,$uname,$dir);
4866: my @stats = split('&', $result);
1.721 banghart 4867:
1.712 albertel 4868: if($stats[0] ne 'empty' && $stats[0] ne 'no_such_dir') {
4869: shift(@stats); #filename is first
4870: return @stats;
4871: }
4872: return ();
4873: }
4874:
1.26 www 4875: # -------------------------------------------------------- Value of a Condition
4876:
1.713 albertel 4877: # gets the value of a specific preevaluated condition
4878: # stored in the string $env{user.state.<cid>}
4879: # or looks up a condition reference in the bighash and if if hasn't
4880: # already been evaluated recurses into docondval to get the value of
4881: # the condition, then memoizing it to
4882: # $env{user.state.<cid>.<condition>}
1.40 www 4883: sub directcondval {
4884: my $number=shift;
1.620 albertel 4885: if (!defined($env{'user.state.'.$env{'request.course.id'}})) {
1.555 albertel 4886: &Apache::lonuserstate::evalstate();
4887: }
1.713 albertel 4888: if (exists($env{'user.state.'.$env{'request.course.id'}.".$number"})) {
4889: return $env{'user.state.'.$env{'request.course.id'}.".$number"};
4890: } elsif ($number =~ /^_/) {
4891: my $sub_condition;
4892: if (tie(my %bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
4893: &GDBM_READER(),0640)) {
4894: $sub_condition=$bighash{'conditions'.$number};
4895: untie(%bighash);
4896: }
4897: my $value = &docondval($sub_condition);
4898: &appenv('user.state.'.$env{'request.course.id'}.".$number" => $value);
4899: return $value;
4900: }
1.620 albertel 4901: if ($env{'user.state.'.$env{'request.course.id'}}) {
4902: return substr($env{'user.state.'.$env{'request.course.id'}},$number,1);
1.40 www 4903: } else {
4904: return 2;
4905: }
4906: }
4907:
1.713 albertel 4908: # get the collection of conditions for this resource
1.26 www 4909: sub condval {
4910: my $condidx=shift;
1.54 www 4911: my $allpathcond='';
1.713 albertel 4912: foreach my $cond (split(/\|/,$condidx)) {
4913: if (defined($env{'acc.cond.'.$env{'request.course.id'}.'.'.$cond})) {
4914: $allpathcond.=
4915: '('.$env{'acc.cond.'.$env{'request.course.id'}.'.'.$cond}.')|';
4916: }
1.191 harris41 4917: }
1.54 www 4918: $allpathcond=~s/\|$//;
1.713 albertel 4919: return &docondval($allpathcond);
4920: }
4921:
4922: #evaluates an expression of conditions
4923: sub docondval {
4924: my ($allpathcond) = @_;
4925: my $result=0;
4926: if ($env{'request.course.id'}
4927: && defined($allpathcond)) {
4928: my $operand='|';
4929: my @stack;
4930: foreach my $chunk ($allpathcond=~/(\d+|_\d+\.\d+|\(|\)|\&|\|)/g) {
4931: if ($chunk eq '(') {
4932: push @stack,($operand,$result);
4933: } elsif ($chunk eq ')') {
4934: my $before=pop @stack;
4935: if (pop @stack eq '&') {
4936: $result=$result>$before?$before:$result;
4937: } else {
4938: $result=$result>$before?$result:$before;
4939: }
4940: } elsif (($chunk eq '&') || ($chunk eq '|')) {
4941: $operand=$chunk;
4942: } else {
4943: my $new=directcondval($chunk);
4944: if ($operand eq '&') {
4945: $result=$result>$new?$new:$result;
4946: } else {
4947: $result=$result>$new?$result:$new;
4948: }
4949: }
4950: }
1.26 www 4951: }
4952: return $result;
1.421 albertel 4953: }
4954:
4955: # ---------------------------------------------------- Devalidate courseresdata
4956:
4957: sub devalidatecourseresdata {
4958: my ($coursenum,$coursedomain)=@_;
4959: my $hashid=$coursenum.':'.$coursedomain;
1.599 albertel 4960: &devalidate_cache_new('courseres',$hashid);
1.28 www 4961: }
4962:
1.200 www 4963: # --------------------------------------------------- Course Resourcedata Query
4964:
1.624 albertel 4965: sub get_courseresdata {
4966: my ($coursenum,$coursedomain)=@_;
1.200 www 4967: my $coursehom=&homeserver($coursenum,$coursedomain);
4968: my $hashid=$coursenum.':'.$coursedomain;
1.599 albertel 4969: my ($result,$cached)=&is_cached_new('courseres',$hashid);
1.624 albertel 4970: my %dumpreply;
1.417 albertel 4971: unless (defined($cached)) {
1.624 albertel 4972: %dumpreply=&dump('resourcedata',$coursedomain,$coursenum);
1.417 albertel 4973: $result=\%dumpreply;
1.251 albertel 4974: my ($tmp) = keys(%dumpreply);
4975: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
1.599 albertel 4976: &do_cache_new('courseres',$hashid,$result,600);
1.306 albertel 4977: } elsif ($tmp =~ /^(con_lost|no_such_host)/) {
4978: return $tmp;
1.416 albertel 4979: } elsif ($tmp =~ /^(error)/) {
1.417 albertel 4980: $result=undef;
1.599 albertel 4981: &do_cache_new('courseres',$hashid,$result,600);
1.250 albertel 4982: }
4983: }
1.624 albertel 4984: return $result;
4985: }
4986:
1.633 albertel 4987: sub devalidateuserresdata {
4988: my ($uname,$udom)=@_;
4989: my $hashid="$udom:$uname";
4990: &devalidate_cache_new('userres',$hashid);
4991: }
4992:
1.624 albertel 4993: sub get_userresdata {
4994: my ($uname,$udom)=@_;
4995: #most student don\'t have any data set, check if there is some data
4996: if (&EXT_cache_status($udom,$uname)) { return undef; }
4997:
4998: my $hashid="$udom:$uname";
4999: my ($result,$cached)=&is_cached_new('userres',$hashid);
5000: if (!defined($cached)) {
5001: my %resourcedata=&dump('resourcedata',$udom,$uname);
5002: $result=\%resourcedata;
5003: &do_cache_new('userres',$hashid,$result,600);
5004: }
5005: my ($tmp)=keys(%$result);
5006: if (($tmp!~/^error\:/) && ($tmp!~/^con_lost/)) {
5007: return $result;
5008: }
5009: #error 2 occurs when the .db doesn't exist
5010: if ($tmp!~/error: 2 /) {
1.672 albertel 5011: &logthis("<font color=\"blue\">WARNING:".
1.624 albertel 5012: " Trying to get resource data for ".
5013: $uname." at ".$udom.": ".
5014: $tmp."</font>");
5015: } elsif ($tmp=~/error: 2 /) {
1.633 albertel 5016: #&EXT_cache_set($udom,$uname);
5017: &do_cache_new('userres',$hashid,undef,600);
1.636 albertel 5018: undef($tmp); # not really an error so don't send it back
1.624 albertel 5019: }
5020: return $tmp;
5021: }
5022:
5023: sub resdata {
5024: my ($name,$domain,$type,@which)=@_;
5025: my $result;
5026: if ($type eq 'course') {
5027: $result=&get_courseresdata($name,$domain);
5028: } elsif ($type eq 'user') {
5029: $result=&get_userresdata($name,$domain);
5030: }
5031: if (!ref($result)) { return $result; }
1.251 albertel 5032: foreach my $item (@which) {
1.417 albertel 5033: if (defined($result->{$item})) {
5034: return $result->{$item};
1.251 albertel 5035: }
1.250 albertel 5036: }
1.291 albertel 5037: return undef;
1.200 www 5038: }
5039:
1.379 matthew 5040: #
5041: # EXT resource caching routines
5042: #
5043:
5044: sub clear_EXT_cache_status {
1.383 albertel 5045: &delenv('cache.EXT.');
1.379 matthew 5046: }
5047:
5048: sub EXT_cache_status {
5049: my ($target_domain,$target_user) = @_;
1.383 albertel 5050: my $cachename = 'cache.EXT.'.$target_user.'.'.$target_domain;
1.620 albertel 5051: if (exists($env{$cachename}) && ($env{$cachename}+600) > time) {
1.379 matthew 5052: # We know already the user has no data
5053: return 1;
5054: } else {
5055: return 0;
5056: }
5057: }
5058:
5059: sub EXT_cache_set {
5060: my ($target_domain,$target_user) = @_;
1.383 albertel 5061: my $cachename = 'cache.EXT.'.$target_user.'.'.$target_domain;
1.633 albertel 5062: #&appenv($cachename => time);
1.379 matthew 5063: }
5064:
1.28 www 5065: # --------------------------------------------------------- Value of a Variable
1.58 www 5066: sub EXT {
1.715 albertel 5067:
1.395 albertel 5068: my ($varname,$symbparm,$udom,$uname,$usection,$recurse)=@_;
1.68 www 5069: unless ($varname) { return ''; }
1.218 albertel 5070: #get real user name/domain, courseid and symb
5071: my $courseid;
1.359 albertel 5072: my $publicuser;
1.427 www 5073: if ($symbparm) {
5074: $symbparm=&get_symb_from_alias($symbparm);
5075: }
1.218 albertel 5076: if (!($uname && $udom)) {
1.360 albertel 5077: (my $cursymb,$courseid,$udom,$uname,$publicuser)=
1.378 matthew 5078: &Apache::lonxml::whichuser($symbparm);
1.218 albertel 5079: if (!$symbparm) { $symbparm=$cursymb; }
5080: } else {
1.620 albertel 5081: $courseid=$env{'request.course.id'};
1.218 albertel 5082: }
1.48 www 5083: my ($realm,$space,$qualifier,@therest)=split(/\./,$varname);
5084: my $rest;
1.320 albertel 5085: if (defined($therest[0])) {
1.48 www 5086: $rest=join('.',@therest);
5087: } else {
5088: $rest='';
5089: }
1.320 albertel 5090:
1.57 www 5091: my $qualifierrest=$qualifier;
5092: if ($rest) { $qualifierrest.='.'.$rest; }
5093: my $spacequalifierrest=$space;
5094: if ($qualifierrest) { $spacequalifierrest.='.'.$qualifierrest; }
1.28 www 5095: if ($realm eq 'user') {
1.48 www 5096: # --------------------------------------------------------------- user.resource
5097: if ($space eq 'resource') {
1.651 albertel 5098: if ( (defined($Apache::lonhomework::parsing_a_problem)
5099: || defined($Apache::lonhomework::parsing_a_task))
5100: &&
5101: ($symbparm eq &symbread()) ) {
1.335 albertel 5102: return $Apache::lonhomework::history{$qualifierrest};
5103: } else {
1.359 albertel 5104: my %restored;
1.620 albertel 5105: if ($publicuser || $env{'request.state'} eq 'construct') {
1.359 albertel 5106: %restored=&tmprestore($symbparm,$courseid,$udom,$uname);
5107: } else {
5108: %restored=&restore($symbparm,$courseid,$udom,$uname);
5109: }
1.335 albertel 5110: return $restored{$qualifierrest};
5111: }
1.48 www 5112: # ----------------------------------------------------------------- user.access
5113: } elsif ($space eq 'access') {
1.218 albertel 5114: # FIXME - not supporting calls for a specific user
1.48 www 5115: return &allowed($qualifier,$rest);
5116: # ------------------------------------------ user.preferences, user.environment
5117: } elsif (($space eq 'preferences') || ($space eq 'environment')) {
1.620 albertel 5118: if (($uname eq $env{'user.name'}) &&
5119: ($udom eq $env{'user.domain'})) {
5120: return $env{join('.',('environment',$qualifierrest))};
1.218 albertel 5121: } else {
1.359 albertel 5122: my %returnhash;
5123: if (!$publicuser) {
5124: %returnhash=&userenvironment($udom,$uname,
5125: $qualifierrest);
5126: }
1.218 albertel 5127: return $returnhash{$qualifierrest};
5128: }
1.48 www 5129: # ----------------------------------------------------------------- user.course
5130: } elsif ($space eq 'course') {
1.218 albertel 5131: # FIXME - not supporting calls for a specific user
1.620 albertel 5132: return $env{join('.',('request.course',$qualifier))};
1.48 www 5133: # ------------------------------------------------------------------- user.role
5134: } elsif ($space eq 'role') {
1.218 albertel 5135: # FIXME - not supporting calls for a specific user
1.620 albertel 5136: my ($role,$where)=split(/\./,$env{'request.role'});
1.48 www 5137: if ($qualifier eq 'value') {
5138: return $role;
5139: } elsif ($qualifier eq 'extent') {
5140: return $where;
5141: }
5142: # ----------------------------------------------------------------- user.domain
5143: } elsif ($space eq 'domain') {
1.218 albertel 5144: return $udom;
1.48 www 5145: # ------------------------------------------------------------------- user.name
5146: } elsif ($space eq 'name') {
1.218 albertel 5147: return $uname;
1.48 www 5148: # ---------------------------------------------------- Any other user namespace
1.29 www 5149: } else {
1.359 albertel 5150: my %reply;
5151: if (!$publicuser) {
5152: %reply=&get($space,[$qualifierrest],$udom,$uname);
5153: }
5154: return $reply{$qualifierrest};
1.48 www 5155: }
1.236 www 5156: } elsif ($realm eq 'query') {
5157: # ---------------------------------------------- pull stuff out of query string
1.384 albertel 5158: &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},
5159: [$spacequalifierrest]);
1.620 albertel 5160: return $env{'form.'.$spacequalifierrest};
1.236 www 5161: } elsif ($realm eq 'request') {
1.48 www 5162: # ------------------------------------------------------------- request.browser
5163: if ($space eq 'browser') {
1.430 www 5164: if ($qualifier eq 'textremote') {
1.676 albertel 5165: if (&Apache::lonlocal::mt('textual_remote_display') eq 'on') {
1.430 www 5166: return 1;
5167: } else {
5168: return 0;
5169: }
5170: } else {
1.620 albertel 5171: return $env{'browser.'.$qualifier};
1.430 www 5172: }
1.57 www 5173: # ------------------------------------------------------------ request.filename
5174: } else {
1.620 albertel 5175: return $env{'request.'.$spacequalifierrest};
1.29 www 5176: }
1.28 www 5177: } elsif ($realm eq 'course') {
1.48 www 5178: # ---------------------------------------------------------- course.description
1.620 albertel 5179: return $env{'course.'.$courseid.'.'.$spacequalifierrest};
1.57 www 5180: } elsif ($realm eq 'resource') {
1.165 www 5181:
1.620 albertel 5182: if (defined($courseid) && $courseid eq $env{'request.course.id'}) {
1.539 albertel 5183: if (!$symbparm) { $symbparm=&symbread(); }
5184: }
1.693 albertel 5185:
5186: if ($space eq 'title') {
5187: if (!$symbparm) { $symbparm = $env{'request.filename'}; }
5188: return &gettitle($symbparm);
5189: }
5190:
5191: if ($space eq 'map') {
5192: my ($map) = &decode_symb($symbparm);
5193: return &symbread($map);
5194: }
5195:
5196: my ($section, $group, @groups);
1.593 albertel 5197: my ($courselevelm,$courselevel);
1.539 albertel 5198: if ($symbparm && defined($courseid) &&
1.620 albertel 5199: $courseid eq $env{'request.course.id'}) {
1.165 www 5200:
1.218 albertel 5201: #print '<br>'.$space.' - '.$qualifier.' - '.$spacequalifierrest;
1.165 www 5202:
1.60 www 5203: # ----------------------------------------------------- Cascading lookup scheme
1.218 albertel 5204: my $symbp=$symbparm;
1.735 albertel 5205: my $mapp=&deversion((&decode_symb($symbp))[0]);
1.218 albertel 5206:
5207: my $symbparm=$symbp.'.'.$spacequalifierrest;
5208: my $mapparm=$mapp.'___(all).'.$spacequalifierrest;
5209:
1.620 albertel 5210: if (($env{'user.name'} eq $uname) &&
5211: ($env{'user.domain'} eq $udom)) {
5212: $section=$env{'request.course.sec'};
1.733 raeburn 5213: @groups = split(/:/,$env{'request.course.groups'});
5214: @groups=&sort_course_groups($courseid,@groups);
1.218 albertel 5215: } else {
1.539 albertel 5216: if (! defined($usection)) {
1.551 albertel 5217: $section=&getsection($udom,$uname,$courseid);
1.539 albertel 5218: } else {
5219: $section = $usection;
5220: }
1.733 raeburn 5221: @groups = &get_users_groups($udom,$uname,$courseid);
1.218 albertel 5222: }
5223:
5224: my $seclevel=$courseid.'.['.$section.'].'.$spacequalifierrest;
5225: my $seclevelr=$courseid.'.['.$section.'].'.$symbparm;
5226: my $seclevelm=$courseid.'.['.$section.'].'.$mapparm;
5227:
1.593 albertel 5228: $courselevel=$courseid.'.'.$spacequalifierrest;
1.218 albertel 5229: my $courselevelr=$courseid.'.'.$symbparm;
1.593 albertel 5230: $courselevelm=$courseid.'.'.$mapparm;
1.69 www 5231:
1.60 www 5232: # ----------------------------------------------------------- first, check user
1.624 albertel 5233:
5234: my $userreply=&resdata($uname,$udom,'user',
5235: ($courselevelr,$courselevelm,
5236: $courselevel));
5237: if (defined($userreply)) { return $userreply; }
1.95 www 5238:
1.594 albertel 5239: # ------------------------------------------------ second, check some of course
1.684 raeburn 5240: my $coursereply;
1.691 raeburn 5241: if (@groups > 0) {
5242: $coursereply = &check_group_parms($courseid,\@groups,$symbparm,
5243: $mapparm,$spacequalifierrest);
1.684 raeburn 5244: if (defined($coursereply)) { return $coursereply; }
5245: }
1.96 www 5246:
1.684 raeburn 5247: $coursereply=&resdata($env{'course.'.$courseid.'.num'},
1.624 albertel 5248: $env{'course.'.$courseid.'.domain'},
5249: 'course',
5250: ($seclevelr,$seclevelm,$seclevel,
5251: $courselevelr));
1.287 albertel 5252: if (defined($coursereply)) { return $coursereply; }
1.200 www 5253:
1.60 www 5254: # ------------------------------------------------------ third, check map parms
1.218 albertel 5255: my %parmhash=();
5256: my $thisparm='';
5257: if (tie(%parmhash,'GDBM_File',
1.620 albertel 5258: $env{'request.course.fn'}.'_parms.db',
1.256 albertel 5259: &GDBM_READER(),0640)) {
1.218 albertel 5260: $thisparm=$parmhash{$symbparm};
5261: untie(%parmhash);
5262: }
5263: if ($thisparm) { return $thisparm; }
5264: }
1.594 albertel 5265: # ------------------------------------------ fourth, look in resource metadata
1.71 www 5266:
1.218 albertel 5267: $spacequalifierrest=~s/\./\_/;
1.282 albertel 5268: my $filename;
5269: if (!$symbparm) { $symbparm=&symbread(); }
5270: if ($symbparm) {
1.409 www 5271: $filename=(&decode_symb($symbparm))[2];
1.282 albertel 5272: } else {
1.620 albertel 5273: $filename=$env{'request.filename'};
1.282 albertel 5274: }
5275: my $metadata=&metadata($filename,$spacequalifierrest);
1.288 albertel 5276: if (defined($metadata)) { return $metadata; }
1.282 albertel 5277: $metadata=&metadata($filename,'parameter_'.$spacequalifierrest);
1.288 albertel 5278: if (defined($metadata)) { return $metadata; }
1.142 www 5279:
1.594 albertel 5280: # ---------------------------------------------- fourth, look in rest pf course
1.593 albertel 5281: if ($symbparm && defined($courseid) &&
1.620 albertel 5282: $courseid eq $env{'request.course.id'}) {
1.624 albertel 5283: my $coursereply=&resdata($env{'course.'.$courseid.'.num'},
5284: $env{'course.'.$courseid.'.domain'},
5285: 'course',
5286: ($courselevelm,$courselevel));
1.593 albertel 5287: if (defined($coursereply)) { return $coursereply; }
5288: }
1.145 www 5289: # ------------------------------------------------------------------ Cascade up
1.218 albertel 5290: unless ($space eq '0') {
1.336 albertel 5291: my @parts=split(/_/,$space);
5292: my $id=pop(@parts);
5293: my $part=join('_',@parts);
5294: if ($part eq '') { $part='0'; }
5295: my $partgeneral=&EXT('resource.'.$part.'.'.$qualifierrest,
1.395 albertel 5296: $symbparm,$udom,$uname,$section,1);
1.337 albertel 5297: if (defined($partgeneral)) { return $partgeneral; }
1.218 albertel 5298: }
1.395 albertel 5299: if ($recurse) { return undef; }
5300: my $pack_def=&packages_tab_default($filename,$varname);
5301: if (defined($pack_def)) { return $pack_def; }
1.71 www 5302:
1.48 www 5303: # ---------------------------------------------------- Any other user namespace
5304: } elsif ($realm eq 'environment') {
5305: # ----------------------------------------------------------------- environment
1.620 albertel 5306: if (($uname eq $env{'user.name'})&&($udom eq $env{'user.domain'})) {
5307: return $env{'environment.'.$spacequalifierrest};
1.219 albertel 5308: } else {
5309: my %returnhash=&userenvironment($udom,$uname,
5310: $spacequalifierrest);
5311: return $returnhash{$spacequalifierrest};
5312: }
1.28 www 5313: } elsif ($realm eq 'system') {
1.48 www 5314: # ----------------------------------------------------------------- system.time
5315: if ($space eq 'time') {
5316: return time;
5317: }
1.696 albertel 5318: } elsif ($realm eq 'server') {
5319: # ----------------------------------------------------------------- system.time
5320: if ($space eq 'name') {
5321: return $ENV{'SERVER_NAME'};
5322: }
1.28 www 5323: }
1.48 www 5324: return '';
1.61 www 5325: }
5326:
1.691 raeburn 5327: sub check_group_parms {
5328: my ($courseid,$groups,$symbparm,$mapparm,$what) = @_;
5329: my @groupitems = ();
5330: my $resultitem;
5331: my @levels = ($symbparm,$mapparm,$what);
5332: foreach my $group (@{$groups}) {
5333: foreach my $level (@levels) {
5334: my $item = $courseid.'.['.$group.'].'.$level;
5335: push(@groupitems,$item);
5336: }
5337: }
5338: my $coursereply = &resdata($env{'course.'.$courseid.'.num'},
5339: $env{'course.'.$courseid.'.domain'},
5340: 'course',@groupitems);
5341: return $coursereply;
5342: }
5343:
5344: sub sort_course_groups { # Sort groups based on defined rankings. Default is sort().
1.733 raeburn 5345: my ($courseid,@groups) = @_;
5346: @groups = sort(@groups);
1.691 raeburn 5347: return @groups;
5348: }
5349:
1.395 albertel 5350: sub packages_tab_default {
5351: my ($uri,$varname)=@_;
5352: my (undef,$part,$name)=split(/\./,$varname);
1.738 albertel 5353:
5354: my (@extension,@specifics,$do_default);
5355: foreach my $package (split(/,/,&metadata($uri,'packages'))) {
1.395 albertel 5356: my ($pack_type,$pack_part)=split(/_/,$package,2);
1.738 albertel 5357: if ($pack_type eq 'default') {
5358: $do_default=1;
5359: } elsif ($pack_type eq 'extension') {
5360: push(@extension,[$package,$pack_type,$pack_part]);
5361: } else {
5362: push(@specifics,[$package,$pack_type,$pack_part]);
5363: }
5364: }
5365: # first look for a package that matches the requested part id
5366: foreach my $package (@specifics) {
5367: my (undef,$pack_type,$pack_part)=@{$package};
5368: next if ($pack_part ne $part);
5369: if (defined($packagetab{"$pack_type&$name&default"})) {
5370: return $packagetab{"$pack_type&$name&default"};
5371: }
5372: }
5373: # look for any possible matching non extension_ package
5374: foreach my $package (@specifics) {
5375: my (undef,$pack_type,$pack_part)=@{$package};
1.468 albertel 5376: if (defined($packagetab{"$pack_type&$name&default"})) {
5377: return $packagetab{"$pack_type&$name&default"};
5378: }
1.585 albertel 5379: if ($pack_type eq 'part') { $pack_part='0'; }
1.468 albertel 5380: if (defined($packagetab{$pack_type."_".$pack_part."&$name&default"})) {
5381: return $packagetab{$pack_type."_".$pack_part."&$name&default"};
1.395 albertel 5382: }
5383: }
1.738 albertel 5384: # look for any posible extension_ match
5385: foreach my $package (@extension) {
5386: my ($package,$pack_type)=@{$package};
5387: if (defined($packagetab{"$pack_type&$name&default"})) {
5388: return $packagetab{"$pack_type&$name&default"};
5389: }
5390: if (defined($packagetab{$package."&$name&default"})) {
5391: return $packagetab{$package."&$name&default"};
5392: }
5393: }
5394: # look for a global default setting
5395: if ($do_default && defined($packagetab{"default&$name&default"})) {
5396: return $packagetab{"default&$name&default"};
5397: }
1.395 albertel 5398: return undef;
5399: }
5400:
1.334 albertel 5401: sub add_prefix_and_part {
5402: my ($prefix,$part)=@_;
5403: my $keyroot;
5404: if (defined($prefix) && $prefix !~ /^__/) {
5405: # prefix that has a part already
5406: $keyroot=$prefix;
5407: } elsif (defined($prefix)) {
5408: # prefix that is missing a part
5409: if (defined($part)) { $keyroot='_'.$part.substr($prefix,1); }
5410: } else {
5411: # no prefix at all
5412: if (defined($part)) { $keyroot='_'.$part; }
5413: }
5414: return $keyroot;
5415: }
5416:
1.71 www 5417: # ---------------------------------------------------------------- Get metadata
5418:
1.599 albertel 5419: my %metaentry;
1.71 www 5420: sub metadata {
1.176 www 5421: my ($uri,$what,$liburi,$prefix,$depthcount)=@_;
1.71 www 5422: $uri=&declutter($uri);
1.288 albertel 5423: # if it is a non metadata possible uri return quickly
1.529 albertel 5424: if (($uri eq '') ||
5425: (($uri =~ m|^/*adm/|) &&
1.698 albertel 5426: ($uri !~ m|^adm/includes|) && ($uri !~ m|/bulletinboard$|)) ||
1.423 albertel 5427: ($uri =~ m|/$|) || ($uri =~ m|/.meta$|) || ($uri =~ /^~/) ||
1.489 albertel 5428: ($uri =~ m|home/[^/]+/public_html/|)) {
1.468 albertel 5429: return undef;
1.288 albertel 5430: }
1.73 www 5431: my $filename=$uri;
5432: $uri=~s/\.meta$//;
1.172 www 5433: #
5434: # Is the metadata already cached?
1.177 www 5435: # Look at timestamp of caching
1.172 www 5436: # Everything is cached by the main uri, libraries are never directly cached
5437: #
1.428 albertel 5438: if (!defined($liburi)) {
1.599 albertel 5439: my ($result,$cached)=&is_cached_new('meta',$uri);
1.428 albertel 5440: if (defined($cached)) { return $result->{':'.$what}; }
5441: }
5442: {
1.172 www 5443: #
5444: # Is this a recursive call for a library?
5445: #
1.599 albertel 5446: # if (! exists($metacache{$uri})) {
5447: # $metacache{$uri}={};
5448: # }
1.171 www 5449: if ($liburi) {
5450: $liburi=&declutter($liburi);
5451: $filename=$liburi;
1.401 bowersj2 5452: } else {
1.599 albertel 5453: &devalidate_cache_new('meta',$uri);
5454: undef(%metaentry);
1.401 bowersj2 5455: }
1.140 www 5456: my %metathesekeys=();
1.73 www 5457: unless ($filename=~/\.meta$/) { $filename.='.meta'; }
1.489 albertel 5458: my $metastring;
1.609 banghart 5459: if ($uri !~ m -^(uploaded|editupload)/-) {
1.543 albertel 5460: my $file=&filelocation('',&clutter($filename));
1.599 albertel 5461: #push(@{$metaentry{$uri.'.file'}},$file);
1.543 albertel 5462: $metastring=&getfile($file);
1.489 albertel 5463: }
1.208 albertel 5464: my $parser=HTML::LCParser->new(\$metastring);
1.71 www 5465: my $token;
1.140 www 5466: undef %metathesekeys;
1.71 www 5467: while ($token=$parser->get_token) {
1.339 albertel 5468: if ($token->[0] eq 'S') {
5469: if (defined($token->[2]->{'package'})) {
1.172 www 5470: #
5471: # This is a package - get package info
5472: #
1.339 albertel 5473: my $package=$token->[2]->{'package'};
5474: my $keyroot=&add_prefix_and_part($prefix,$token->[2]->{'part'});
5475: if (defined($token->[2]->{'id'})) {
5476: $keyroot.='_'.$token->[2]->{'id'};
5477: }
1.599 albertel 5478: if ($metaentry{':packages'}) {
5479: $metaentry{':packages'}.=','.$package.$keyroot;
1.339 albertel 5480: } else {
1.599 albertel 5481: $metaentry{':packages'}=$package.$keyroot;
1.339 albertel 5482: }
1.736 albertel 5483: foreach my $pack_entry (keys(%packagetab)) {
1.432 albertel 5484: my $part=$keyroot;
5485: $part=~s/^\_//;
1.736 albertel 5486: if ($pack_entry=~/^\Q$package\E\&/ ||
5487: $pack_entry=~/^\Q$package\E_0\&/) {
5488: my ($pack,$name,$subp)=split(/\&/,$pack_entry);
1.395 albertel 5489: # ignore package.tab specified default values
5490: # here &package_tab_default() will fetch those
5491: if ($subp eq 'default') { next; }
1.736 albertel 5492: my $value=$packagetab{$pack_entry};
1.432 albertel 5493: my $unikey;
5494: if ($pack =~ /_0$/) {
5495: $unikey='parameter_0_'.$name;
5496: $part=0;
5497: } else {
5498: $unikey='parameter'.$keyroot.'_'.$name;
5499: }
1.339 albertel 5500: if ($subp eq 'display') {
5501: $value.=' [Part: '.$part.']';
5502: }
1.599 albertel 5503: $metaentry{':'.$unikey.'.part'}=$part;
1.395 albertel 5504: $metathesekeys{$unikey}=1;
1.599 albertel 5505: unless (defined($metaentry{':'.$unikey.'.'.$subp})) {
5506: $metaentry{':'.$unikey.'.'.$subp}=$value;
1.339 albertel 5507: }
1.599 albertel 5508: if (defined($metaentry{':'.$unikey.'.default'})) {
5509: $metaentry{':'.$unikey}=
5510: $metaentry{':'.$unikey.'.default'};
1.356 albertel 5511: }
1.339 albertel 5512: }
5513: }
5514: } else {
1.172 www 5515: #
5516: # This is not a package - some other kind of start tag
1.339 albertel 5517: #
5518: my $entry=$token->[1];
5519: my $unikey;
5520: if ($entry eq 'import') {
5521: $unikey='';
5522: } else {
5523: $unikey=$entry;
5524: }
5525: $unikey.=&add_prefix_and_part($prefix,$token->[2]->{'part'});
5526:
5527: if (defined($token->[2]->{'id'})) {
5528: $unikey.='_'.$token->[2]->{'id'};
5529: }
1.175 www 5530:
1.339 albertel 5531: if ($entry eq 'import') {
1.175 www 5532: #
5533: # Importing a library here
1.339 albertel 5534: #
5535: if ($depthcount<20) {
5536: my $location=$parser->get_text('/import');
5537: my $dir=$filename;
5538: $dir=~s|[^/]*$||;
5539: $location=&filelocation($dir,$location);
1.736 albertel 5540: my $metadata =
5541: &metadata($uri,'keys', $location,$unikey,
5542: $depthcount+1);
5543: foreach my $meta (split(',',$metadata)) {
5544: $metaentry{':'.$meta}=$metaentry{':'.$meta};
5545: $metathesekeys{$meta}=1;
1.339 albertel 5546: }
5547: }
5548: } else {
5549:
5550: if (defined($token->[2]->{'name'})) {
5551: $unikey.='_'.$token->[2]->{'name'};
5552: }
5553: $metathesekeys{$unikey}=1;
1.736 albertel 5554: foreach my $param (@{$token->[3]}) {
5555: $metaentry{':'.$unikey.'.'.$param} =
5556: $token->[2]->{$param};
1.339 albertel 5557: }
5558: my $internaltext=&HTML::Entities::decode($parser->get_text('/'.$entry));
1.599 albertel 5559: my $default=$metaentry{':'.$unikey.'.default'};
1.339 albertel 5560: if ( $internaltext =~ /^\s*$/ && $default !~ /^\s*$/) {
5561: # only ws inside the tag, and not in default, so use default
5562: # as value
1.599 albertel 5563: $metaentry{':'.$unikey}=$default;
1.339 albertel 5564: } else {
1.321 albertel 5565: # either something interesting inside the tag or default
5566: # uninteresting
1.599 albertel 5567: $metaentry{':'.$unikey}=$internaltext;
1.339 albertel 5568: }
1.172 www 5569: # end of not-a-package not-a-library import
1.339 albertel 5570: }
1.172 www 5571: # end of not-a-package start tag
1.339 albertel 5572: }
1.172 www 5573: # the next is the end of "start tag"
1.339 albertel 5574: }
5575: }
1.483 albertel 5576: my ($extension) = ($uri =~ /\.(\w+)$/);
1.737 albertel 5577: foreach my $key (keys(%packagetab)) {
1.483 albertel 5578: #no specific packages #how's our extension
5579: if ($key!~/^extension_\Q$extension\E&/) { next; }
1.488 albertel 5580: &metadata_create_package_def($uri,$key,'extension_'.$extension,
1.483 albertel 5581: \%metathesekeys);
5582: }
1.599 albertel 5583: if (!exists($metaentry{':packages'})) {
1.737 albertel 5584: foreach my $key (keys(%packagetab)) {
1.483 albertel 5585: #no specific packages well let's get default then
5586: if ($key!~/^default&/) { next; }
1.488 albertel 5587: &metadata_create_package_def($uri,$key,'default',
1.483 albertel 5588: \%metathesekeys);
5589: }
5590: }
1.338 www 5591: # are there custom rights to evaluate
1.599 albertel 5592: if ($metaentry{':copyright'} eq 'custom') {
1.339 albertel 5593:
1.338 www 5594: #
5595: # Importing a rights file here
1.339 albertel 5596: #
5597: unless ($depthcount) {
1.599 albertel 5598: my $location=$metaentry{':customdistributionfile'};
1.339 albertel 5599: my $dir=$filename;
5600: $dir=~s|[^/]*$||;
5601: $location=&filelocation($dir,$location);
1.736 albertel 5602: my $rights_metadata =
5603: &metadata($uri,'keys',$location,'_rights',
5604: $depthcount+1);
5605: foreach my $rights (split(',',$rights_metadata)) {
5606: #$metaentry{':'.$rights}=$metacache{$uri}->{':'.$rights};
5607: $metathesekeys{$rights}=1;
1.339 albertel 5608: }
5609: }
5610: }
1.737 albertel 5611: # uniqifiy package listing
5612: my %seen;
5613: my @uniq_packages =
5614: grep { ! $seen{$_} ++ } (split(',',$metaentry{':packages'}));
5615: $metaentry{':packages'} = join(',',@uniq_packages);
5616:
5617: $metaentry{':keys'} = join(',',keys(%metathesekeys));
1.599 albertel 5618: &metadata_generate_part0(\%metathesekeys,\%metaentry,$uri);
5619: $metaentry{':allpossiblekeys'}=join(',',keys %metathesekeys);
1.699 albertel 5620: &do_cache_new('meta',$uri,\%metaentry,60*60);
1.177 www 5621: # this is the end of "was not already recently cached
1.71 www 5622: }
1.599 albertel 5623: return $metaentry{':'.$what};
1.261 albertel 5624: }
5625:
1.488 albertel 5626: sub metadata_create_package_def {
1.483 albertel 5627: my ($uri,$key,$package,$metathesekeys)=@_;
5628: my ($pack,$name,$subp)=split(/\&/,$key);
5629: if ($subp eq 'default') { next; }
5630:
1.599 albertel 5631: if (defined($metaentry{':packages'})) {
5632: $metaentry{':packages'}.=','.$package;
1.483 albertel 5633: } else {
1.599 albertel 5634: $metaentry{':packages'}=$package;
1.483 albertel 5635: }
5636: my $value=$packagetab{$key};
5637: my $unikey;
5638: $unikey='parameter_0_'.$name;
1.599 albertel 5639: $metaentry{':'.$unikey.'.part'}=0;
1.483 albertel 5640: $$metathesekeys{$unikey}=1;
1.599 albertel 5641: unless (defined($metaentry{':'.$unikey.'.'.$subp})) {
5642: $metaentry{':'.$unikey.'.'.$subp}=$value;
1.483 albertel 5643: }
1.599 albertel 5644: if (defined($metaentry{':'.$unikey.'.default'})) {
5645: $metaentry{':'.$unikey}=
5646: $metaentry{':'.$unikey.'.default'};
1.483 albertel 5647: }
5648: }
5649:
1.261 albertel 5650: sub metadata_generate_part0 {
5651: my ($metadata,$metacache,$uri) = @_;
5652: my %allnames;
1.737 albertel 5653: foreach my $metakey (keys(%$metadata)) {
1.261 albertel 5654: if ($metakey=~/^parameter\_(.*)/) {
1.428 albertel 5655: my $part=$$metacache{':'.$metakey.'.part'};
5656: my $name=$$metacache{':'.$metakey.'.name'};
1.356 albertel 5657: if (! exists($$metadata{'parameter_0_'.$name.'.name'})) {
1.261 albertel 5658: $allnames{$name}=$part;
5659: }
5660: }
5661: }
5662: foreach my $name (keys(%allnames)) {
5663: $$metadata{"parameter_0_$name"}=1;
1.428 albertel 5664: my $key=":parameter_0_$name";
1.261 albertel 5665: $$metacache{"$key.part"}='0';
5666: $$metacache{"$key.name"}=$name;
1.428 albertel 5667: $$metacache{"$key.type"}=$$metacache{':parameter_'.
1.261 albertel 5668: $allnames{$name}.'_'.$name.
5669: '.type'};
1.428 albertel 5670: my $olddis=$$metacache{':parameter_'.$allnames{$name}.'_'.$name.
1.261 albertel 5671: '.display'};
1.644 www 5672: my $expr='[Part: '.$allnames{$name}.']';
1.479 albertel 5673: $olddis=~s/\Q$expr\E/\[Part: 0\]/;
1.261 albertel 5674: $$metacache{"$key.display"}=$olddis;
5675: }
1.71 www 5676: }
5677:
1.301 www 5678: # ------------------------------------------------- Get the title of a resource
5679:
5680: sub gettitle {
5681: my $urlsymb=shift;
5682: my $symb=&symbread($urlsymb);
1.534 albertel 5683: if ($symb) {
1.620 albertel 5684: my $key=$env{'request.course.id'}."\0".$symb;
1.599 albertel 5685: my ($result,$cached)=&is_cached_new('title',$key);
1.575 albertel 5686: if (defined($cached)) {
5687: return $result;
5688: }
1.534 albertel 5689: my ($map,$resid,$url)=&decode_symb($symb);
5690: my $title='';
5691: my %bighash;
1.620 albertel 5692: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
1.534 albertel 5693: &GDBM_READER(),0640)) {
5694: my $mapid=$bighash{'map_pc_'.&clutter($map)};
5695: $title=$bighash{'title_'.$mapid.'.'.$resid};
5696: untie %bighash;
5697: }
5698: $title=~s/\&colon\;/\:/gs;
5699: if ($title) {
1.599 albertel 5700: return &do_cache_new('title',$key,$title,600);
1.534 albertel 5701: }
5702: $urlsymb=$url;
5703: }
5704: my $title=&metadata($urlsymb,'title');
5705: if (!$title) { $title=(split('/',$urlsymb))[-1]; }
5706: return $title;
1.301 www 5707: }
1.613 albertel 5708:
1.614 albertel 5709: sub get_slot {
5710: my ($which,$cnum,$cdom)=@_;
5711: if (!$cnum || !$cdom) {
5712: (undef,my $courseid)=&Apache::lonxml::whichuser();
1.620 albertel 5713: $cdom=$env{'course.'.$courseid.'.domain'};
5714: $cnum=$env{'course.'.$courseid.'.num'};
1.614 albertel 5715: }
1.703 albertel 5716: my $key=join("\0",'slots',$cdom,$cnum,$which);
5717: my %slotinfo;
5718: if (exists($remembered{$key})) {
5719: $slotinfo{$which} = $remembered{$key};
5720: } else {
5721: %slotinfo=&get('slots',[$which],$cdom,$cnum);
5722: &Apache::lonhomework::showhash(%slotinfo);
5723: my ($tmp)=keys(%slotinfo);
5724: if ($tmp=~/^error:/) { return (); }
5725: $remembered{$key} = $slotinfo{$which};
5726: }
1.616 albertel 5727: if (ref($slotinfo{$which}) eq 'HASH') {
5728: return %{$slotinfo{$which}};
5729: }
5730: return $slotinfo{$which};
1.614 albertel 5731: }
1.31 www 5732: # ------------------------------------------------- Update symbolic store links
5733:
5734: sub symblist {
5735: my ($mapname,%newhash)=@_;
1.438 www 5736: $mapname=&deversion(&declutter($mapname));
1.31 www 5737: my %hash;
1.620 albertel 5738: if (($env{'request.course.fn'}) && (%newhash)) {
5739: if (tie(%hash,'GDBM_File',$env{'request.course.fn'}.'_symb.db',
1.256 albertel 5740: &GDBM_WRCREAT(),0640)) {
1.711 albertel 5741: foreach my $url (keys %newhash) {
5742: next if ($url eq 'last_known'
5743: && $env{'form.no_update_last_known'});
5744: $hash{declutter($url)}=&encode_symb($mapname,
5745: $newhash{$url}->[1],
5746: $newhash{$url}->[0]);
1.191 harris41 5747: }
1.31 www 5748: if (untie(%hash)) {
5749: return 'ok';
5750: }
5751: }
5752: }
5753: return 'error';
1.212 www 5754: }
5755:
5756: # --------------------------------------------------------------- Verify a symb
5757:
5758: sub symbverify {
1.510 www 5759: my ($symb,$thisurl)=@_;
5760: my $thisfn=$thisurl;
5761: # wrapper not part of symbs
5762: $thisfn=~s/^\/adm\/wrapper//;
1.694 albertel 5763: $thisfn=~s/^\/adm\/coursedocs\/showdoc\///;
1.439 www 5764: $thisfn=&declutter($thisfn);
1.215 www 5765: # direct jump to resource in page or to a sequence - will construct own symbs
5766: if ($thisfn=~/\.(page|sequence)$/) { return 1; }
5767: # check URL part
1.409 www 5768: my ($map,$resid,$url)=&decode_symb($symb);
1.439 www 5769:
1.431 www 5770: unless ($url eq $thisfn) { return 0; }
1.213 www 5771:
1.216 www 5772: $symb=&symbclean($symb);
1.510 www 5773: $thisurl=&deversion($thisurl);
1.439 www 5774: $thisfn=&deversion($thisfn);
1.213 www 5775:
5776: my %bighash;
5777: my $okay=0;
1.431 www 5778:
1.620 albertel 5779: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
1.256 albertel 5780: &GDBM_READER(),0640)) {
1.510 www 5781: my $ids=$bighash{'ids_'.&clutter($thisurl)};
1.216 www 5782: unless ($ids) {
1.510 www 5783: $ids=$bighash{'ids_/'.$thisurl};
1.216 www 5784: }
5785: if ($ids) {
5786: # ------------------------------------------------------------------- Has ID(s)
5787: foreach (split(/\,/,$ids)) {
1.644 www 5788: my ($mapid,$resid)=split(/\./,$_);
1.216 www 5789: if (
5790: &symbclean(&declutter($bighash{'map_id_'.$mapid}).'___'.$resid.'___'.$thisfn)
5791: eq $symb) {
1.620 albertel 5792: if (($env{'request.role.adv'}) ||
5793: $bighash{'encrypted_'.$_} eq $env{'request.enc'}) {
1.582 albertel 5794: $okay=1;
5795: }
5796: }
1.216 www 5797: }
5798: }
1.213 www 5799: untie(%bighash);
5800: }
5801: return $okay;
1.31 www 5802: }
5803:
1.210 www 5804: # --------------------------------------------------------------- Clean-up symb
5805:
5806: sub symbclean {
5807: my $symb=shift;
1.568 albertel 5808: if ($symb=~m|^/enc/|) { $symb=&Apache::lonenc::unencrypted($symb); }
1.210 www 5809: # remove version from map
5810: $symb=~s/\.(\d+)\.(\w+)\_\_\_/\.$2\_\_\_/;
1.215 www 5811:
1.210 www 5812: # remove version from URL
5813: $symb=~s/\.(\d+)\.(\w+)$/\.$2/;
1.213 www 5814:
1.507 www 5815: # remove wrapper
5816:
1.510 www 5817: $symb=~s/(\_\_\_\d+\_\_\_)adm\/wrapper\/(res\/)*/$1/;
1.694 albertel 5818: $symb=~s/(\_\_\_\d+\_\_\_)adm\/coursedocs\/showdoc\/(res\/)*/$1/;
1.210 www 5819: return $symb;
1.409 www 5820: }
5821:
5822: # ---------------------------------------------- Split symb to find map and url
1.429 albertel 5823:
5824: sub encode_symb {
5825: my ($map,$resid,$url)=@_;
5826: return &symbclean(&declutter($map).'___'.$resid.'___'.&declutter($url));
5827: }
1.409 www 5828:
5829: sub decode_symb {
1.568 albertel 5830: my $symb=shift;
5831: if ($symb=~m|^/enc/|) { $symb=&Apache::lonenc::unencrypted($symb); }
5832: my ($map,$resid,$url)=split(/___/,$symb);
1.413 www 5833: return (&fixversion($map),$resid,&fixversion($url));
5834: }
5835:
5836: sub fixversion {
5837: my $fn=shift;
1.609 banghart 5838: if ($fn=~/^(adm|uploaded|editupload|public)/) { return $fn; }
1.435 www 5839: my %bighash;
5840: my $uri=&clutter($fn);
1.620 albertel 5841: my $key=$env{'request.course.id'}.'_'.$uri;
1.440 www 5842: # is this cached?
1.599 albertel 5843: my ($result,$cached)=&is_cached_new('courseresversion',$key);
1.440 www 5844: if (defined($cached)) { return $result; }
5845: # unfortunately not cached, or expired
1.620 albertel 5846: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
1.440 www 5847: &GDBM_READER(),0640)) {
5848: if ($bighash{'version_'.$uri}) {
5849: my $version=$bighash{'version_'.$uri};
1.444 www 5850: unless (($version eq 'mostrecent') ||
5851: ($version==&getversion($uri))) {
1.440 www 5852: $uri=~s/\.(\w+)$/\.$version\.$1/;
5853: }
5854: }
5855: untie %bighash;
1.413 www 5856: }
1.599 albertel 5857: return &do_cache_new('courseresversion',$key,&declutter($uri),600);
1.438 www 5858: }
5859:
5860: sub deversion {
5861: my $url=shift;
5862: $url=~s/\.\d+\.(\w+)$/\.$1/;
5863: return $url;
1.210 www 5864: }
5865:
1.31 www 5866: # ------------------------------------------------------ Return symb list entry
5867:
5868: sub symbread {
1.249 www 5869: my ($thisfn,$donotrecurse)=@_;
1.542 albertel 5870: my $cache_str='request.symbread.cached.'.$thisfn;
1.620 albertel 5871: if (defined($env{$cache_str})) { return $env{$cache_str}; }
1.242 www 5872: # no filename provided? try from environment
1.44 www 5873: unless ($thisfn) {
1.620 albertel 5874: if ($env{'request.symb'}) {
5875: return $env{$cache_str}=&symbclean($env{'request.symb'});
1.539 albertel 5876: }
1.620 albertel 5877: $thisfn=$env{'request.filename'};
1.44 www 5878: }
1.569 albertel 5879: if ($thisfn=~m|^/enc/|) { $thisfn=&Apache::lonenc::unencrypted($thisfn); }
1.242 www 5880: # is that filename actually a symb? Verify, clean, and return
5881: if ($thisfn=~/\_\_\_\d+\_\_\_(.*)$/) {
1.539 albertel 5882: if (&symbverify($thisfn,$1)) {
1.620 albertel 5883: return $env{$cache_str}=&symbclean($thisfn);
1.539 albertel 5884: }
1.242 www 5885: }
1.44 www 5886: $thisfn=declutter($thisfn);
1.31 www 5887: my %hash;
1.37 www 5888: my %bighash;
5889: my $syval='';
1.620 albertel 5890: if (($env{'request.course.fn'}) && ($thisfn)) {
1.481 raeburn 5891: my $targetfn = $thisfn;
1.609 banghart 5892: if ( ($thisfn =~ m/^(uploaded|editupload)\//) && ($thisfn !~ m/\.(page|sequence)$/) ) {
1.481 raeburn 5893: $targetfn = 'adm/wrapper/'.$thisfn;
5894: }
1.687 albertel 5895: if ($targetfn =~ m|^adm/wrapper/(ext/.*)|) {
5896: $targetfn=$1;
5897: }
1.620 albertel 5898: if (tie(%hash,'GDBM_File',$env{'request.course.fn'}.'_symb.db',
1.256 albertel 5899: &GDBM_READER(),0640)) {
1.481 raeburn 5900: $syval=$hash{$targetfn};
1.37 www 5901: untie(%hash);
5902: }
5903: # ---------------------------------------------------------- There was an entry
5904: if ($syval) {
1.601 albertel 5905: #unless ($syval=~/\_\d+$/) {
1.620 albertel 5906: #unless ($env{'form.request.prefix'}=~/\.(\d+)\_$/) {
1.601 albertel 5907: #&appenv('request.ambiguous' => $thisfn);
1.620 albertel 5908: #return $env{$cache_str}='';
1.601 albertel 5909: #}
5910: #$syval.=$1;
5911: #}
1.37 www 5912: } else {
5913: # ------------------------------------------------------- Was not in symb table
1.620 albertel 5914: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
1.256 albertel 5915: &GDBM_READER(),0640)) {
1.37 www 5916: # ---------------------------------------------- Get ID(s) for current resource
1.280 www 5917: my $ids=$bighash{'ids_'.&clutter($thisfn)};
1.65 www 5918: unless ($ids) {
5919: $ids=$bighash{'ids_/'.$thisfn};
1.242 www 5920: }
5921: unless ($ids) {
5922: # alias?
5923: $ids=$bighash{'mapalias_'.$thisfn};
1.65 www 5924: }
1.37 www 5925: if ($ids) {
5926: # ------------------------------------------------------------------- Has ID(s)
5927: my @possibilities=split(/\,/,$ids);
1.39 www 5928: if ($#possibilities==0) {
5929: # ----------------------------------------------- There is only one possibility
1.37 www 5930: my ($mapid,$resid)=split(/\./,$ids);
1.626 albertel 5931: $syval=&encode_symb($bighash{'map_id_'.$mapid},
5932: $resid,$thisfn);
1.249 www 5933: } elsif (!$donotrecurse) {
1.39 www 5934: # ------------------------------------------ There is more than one possibility
5935: my $realpossible=0;
1.191 harris41 5936: foreach (@possibilities) {
1.39 www 5937: my $file=$bighash{'src_'.$_};
5938: if (&allowed('bre',$file)) {
5939: my ($mapid,$resid)=split(/\./,$_);
5940: if ($bighash{'map_type_'.$mapid} ne 'page') {
5941: $realpossible++;
1.626 albertel 5942: $syval=&encode_symb($bighash{'map_id_'.$mapid},
5943: $resid,$thisfn);
1.39 www 5944: }
5945: }
1.191 harris41 5946: }
1.39 www 5947: if ($realpossible!=1) { $syval=''; }
1.249 www 5948: } else {
5949: $syval='';
1.37 www 5950: }
5951: }
5952: untie(%bighash)
1.481 raeburn 5953: }
1.31 www 5954: }
1.62 www 5955: if ($syval) {
1.620 albertel 5956: return $env{$cache_str}=$syval;
1.62 www 5957: }
1.31 www 5958: }
1.44 www 5959: &appenv('request.ambiguous' => $thisfn);
1.620 albertel 5960: return $env{$cache_str}='';
1.31 www 5961: }
5962:
5963: # ---------------------------------------------------------- Return random seed
5964:
1.32 www 5965: sub numval {
5966: my $txt=shift;
5967: $txt=~tr/A-J/0-9/;
5968: $txt=~tr/a-j/0-9/;
5969: $txt=~tr/K-T/0-9/;
5970: $txt=~tr/k-t/0-9/;
5971: $txt=~tr/U-Z/0-5/;
5972: $txt=~tr/u-z/0-5/;
5973: $txt=~s/\D//g;
1.564 albertel 5974: if ($_64bit) { if ($txt > 2**32) { return -1; } }
1.32 www 5975: return int($txt);
1.368 albertel 5976: }
5977:
1.484 albertel 5978: sub numval2 {
5979: my $txt=shift;
5980: $txt=~tr/A-J/0-9/;
5981: $txt=~tr/a-j/0-9/;
5982: $txt=~tr/K-T/0-9/;
5983: $txt=~tr/k-t/0-9/;
5984: $txt=~tr/U-Z/0-5/;
5985: $txt=~tr/u-z/0-5/;
5986: $txt=~s/\D//g;
5987: my @txts=split(/(\d\d\d\d\d\d\d\d\d)/,$txt);
5988: my $total;
5989: foreach my $val (@txts) { $total+=$val; }
1.564 albertel 5990: if ($_64bit) { if ($total > 2**32) { return -1; } }
1.484 albertel 5991: return int($total);
5992: }
5993:
1.575 albertel 5994: sub numval3 {
5995: use integer;
5996: my $txt=shift;
5997: $txt=~tr/A-J/0-9/;
5998: $txt=~tr/a-j/0-9/;
5999: $txt=~tr/K-T/0-9/;
6000: $txt=~tr/k-t/0-9/;
6001: $txt=~tr/U-Z/0-5/;
6002: $txt=~tr/u-z/0-5/;
6003: $txt=~s/\D//g;
6004: my @txts=split(/(\d\d\d\d\d\d\d\d\d)/,$txt);
6005: my $total;
6006: foreach my $val (@txts) { $total+=$val; }
6007: if ($_64bit) { $total=(($total<<32)>>32); }
6008: return $total;
6009: }
6010:
1.675 albertel 6011: sub digest {
6012: my ($data)=@_;
6013: my $digest=&Digest::MD5::md5($data);
6014: my ($a,$b,$c,$d)=unpack("iiii",$digest);
6015: my ($e,$f);
6016: {
6017: use integer;
6018: $e=($a+$b);
6019: $f=($c+$d);
6020: if ($_64bit) {
6021: $e=(($e<<32)>>32);
6022: $f=(($f<<32)>>32);
6023: }
6024: }
6025: if (wantarray) {
6026: return ($e,$f);
6027: } else {
6028: my $g;
6029: {
6030: use integer;
6031: $g=($e+$f);
6032: if ($_64bit) {
6033: $g=(($g<<32)>>32);
6034: }
6035: }
6036: return $g;
6037: }
6038: }
6039:
1.368 albertel 6040: sub latest_rnd_algorithm_id {
1.675 albertel 6041: return '64bit5';
1.366 albertel 6042: }
1.32 www 6043:
1.503 albertel 6044: sub get_rand_alg {
6045: my ($courseid)=@_;
6046: if (!$courseid) { $courseid=(&Apache::lonxml::whichuser())[1]; }
6047: if ($courseid) {
1.620 albertel 6048: return $env{"course.$courseid.rndseed"};
1.503 albertel 6049: }
6050: return &latest_rnd_algorithm_id();
6051: }
6052:
1.562 albertel 6053: sub validCODE {
6054: my ($CODE)=@_;
6055: if (defined($CODE) && $CODE ne '' && $CODE =~ /^\w+$/) { return 1; }
6056: return 0;
6057: }
6058:
1.491 albertel 6059: sub getCODE {
1.620 albertel 6060: if (&validCODE($env{'form.CODE'})) { return $env{'form.CODE'}; }
1.618 albertel 6061: if ( (defined($Apache::lonhomework::parsing_a_problem) ||
6062: defined($Apache::lonhomework::parsing_a_task) ) &&
6063: &validCODE($Apache::lonhomework::history{'resource.CODE'})) {
1.491 albertel 6064: return $Apache::lonhomework::history{'resource.CODE'};
6065: }
6066: return undef;
6067: }
6068:
1.31 www 6069: sub rndseed {
1.155 albertel 6070: my ($symb,$courseid,$domain,$username)=@_;
1.366 albertel 6071:
6072: my ($wsymb,$wcourseid,$wdomain,$wusername)=&Apache::lonxml::whichuser();
1.155 albertel 6073: if (!$symb) {
1.366 albertel 6074: unless ($symb=$wsymb) { return time; }
6075: }
6076: if (!$courseid) { $courseid=$wcourseid; }
6077: if (!$domain) { $domain=$wdomain; }
6078: if (!$username) { $username=$wusername }
1.503 albertel 6079: my $which=&get_rand_alg();
1.491 albertel 6080: if (defined(&getCODE())) {
1.675 albertel 6081: if ($which eq '64bit5') {
6082: return &rndseed_CODE_64bit5($symb,$courseid,$domain,$username);
6083: } elsif ($which eq '64bit4') {
1.575 albertel 6084: return &rndseed_CODE_64bit4($symb,$courseid,$domain,$username);
6085: } else {
6086: return &rndseed_CODE_64bit($symb,$courseid,$domain,$username);
6087: }
1.675 albertel 6088: } elsif ($which eq '64bit5') {
6089: return &rndseed_64bit5($symb,$courseid,$domain,$username);
1.575 albertel 6090: } elsif ($which eq '64bit4') {
6091: return &rndseed_64bit4($symb,$courseid,$domain,$username);
1.501 albertel 6092: } elsif ($which eq '64bit3') {
6093: return &rndseed_64bit3($symb,$courseid,$domain,$username);
1.443 albertel 6094: } elsif ($which eq '64bit2') {
6095: return &rndseed_64bit2($symb,$courseid,$domain,$username);
1.366 albertel 6096: } elsif ($which eq '64bit') {
6097: return &rndseed_64bit($symb,$courseid,$domain,$username);
6098: }
6099: return &rndseed_32bit($symb,$courseid,$domain,$username);
6100: }
6101:
6102: sub rndseed_32bit {
6103: my ($symb,$courseid,$domain,$username)=@_;
6104: {
6105: use integer;
6106: my $symbchck=unpack("%32C*",$symb) << 27;
6107: my $symbseed=numval($symb) << 22;
6108: my $namechck=unpack("%32C*",$username) << 17;
6109: my $nameseed=numval($username) << 12;
6110: my $domainseed=unpack("%32C*",$domain) << 7;
6111: my $courseseed=unpack("%32C*",$courseid);
6112: my $num=$symbseed+$nameseed+$domainseed+$courseseed+$namechck+$symbchck;
6113: #&Apache::lonxml::debug("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
6114: #&Apache::lonxml::debug("rndseed :$num:$symb");
1.564 albertel 6115: if ($_64bit) { $num=(($num<<32)>>32); }
1.366 albertel 6116: return $num;
6117: }
6118: }
6119:
6120: sub rndseed_64bit {
6121: my ($symb,$courseid,$domain,$username)=@_;
6122: {
6123: use integer;
6124: my $symbchck=unpack("%32S*",$symb) << 21;
6125: my $symbseed=numval($symb) << 10;
6126: my $namechck=unpack("%32S*",$username);
6127:
6128: my $nameseed=numval($username) << 21;
6129: my $domainseed=unpack("%32S*",$domain) << 10;
6130: my $courseseed=unpack("%32S*",$courseid);
6131:
6132: my $num1=$symbchck+$symbseed+$namechck;
6133: my $num2=$nameseed+$domainseed+$courseseed;
6134: #&Apache::lonxml::debug("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
6135: #&Apache::lonxml::debug("rndseed :$num:$symb");
1.564 albertel 6136: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
6137: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
1.366 albertel 6138: return "$num1,$num2";
1.155 albertel 6139: }
1.366 albertel 6140: }
6141:
1.443 albertel 6142: sub rndseed_64bit2 {
6143: my ($symb,$courseid,$domain,$username)=@_;
6144: {
6145: use integer;
6146: # strings need to be an even # of cahracters long, it it is odd the
6147: # last characters gets thrown away
6148: my $symbchck=unpack("%32S*",$symb.' ') << 21;
6149: my $symbseed=numval($symb) << 10;
6150: my $namechck=unpack("%32S*",$username.' ');
6151:
6152: my $nameseed=numval($username) << 21;
1.501 albertel 6153: my $domainseed=unpack("%32S*",$domain.' ') << 10;
6154: my $courseseed=unpack("%32S*",$courseid.' ');
6155:
6156: my $num1=$symbchck+$symbseed+$namechck;
6157: my $num2=$nameseed+$domainseed+$courseseed;
6158: #&Apache::lonxml::debug("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
6159: #&Apache::lonxml::debug("rndseed :$num:$symb");
6160: return "$num1,$num2";
6161: }
6162: }
6163:
6164: sub rndseed_64bit3 {
6165: my ($symb,$courseid,$domain,$username)=@_;
6166: {
6167: use integer;
6168: # strings need to be an even # of cahracters long, it it is odd the
6169: # last characters gets thrown away
6170: my $symbchck=unpack("%32S*",$symb.' ') << 21;
6171: my $symbseed=numval2($symb) << 10;
6172: my $namechck=unpack("%32S*",$username.' ');
6173:
6174: my $nameseed=numval2($username) << 21;
1.443 albertel 6175: my $domainseed=unpack("%32S*",$domain.' ') << 10;
6176: my $courseseed=unpack("%32S*",$courseid.' ');
6177:
6178: my $num1=$symbchck+$symbseed+$namechck;
6179: my $num2=$nameseed+$domainseed+$courseseed;
6180: #&Apache::lonxml::debug("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
1.564 albertel 6181: #&Apache::lonxml::debug("rndseed :$num1:$num2:$_64bit");
6182: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
6183:
1.503 albertel 6184: return "$num1:$num2";
1.443 albertel 6185: }
6186: }
6187:
1.575 albertel 6188: sub rndseed_64bit4 {
6189: my ($symb,$courseid,$domain,$username)=@_;
6190: {
6191: use integer;
6192: # strings need to be an even # of cahracters long, it it is odd the
6193: # last characters gets thrown away
6194: my $symbchck=unpack("%32S*",$symb.' ') << 21;
6195: my $symbseed=numval3($symb) << 10;
6196: my $namechck=unpack("%32S*",$username.' ');
6197:
6198: my $nameseed=numval3($username) << 21;
6199: my $domainseed=unpack("%32S*",$domain.' ') << 10;
6200: my $courseseed=unpack("%32S*",$courseid.' ');
6201:
6202: my $num1=$symbchck+$symbseed+$namechck;
6203: my $num2=$nameseed+$domainseed+$courseseed;
6204: #&Apache::lonxml::debug("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
6205: #&Apache::lonxml::debug("rndseed :$num1:$num2:$_64bit");
6206: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
6207:
6208: return "$num1:$num2";
6209: }
6210: }
6211:
1.675 albertel 6212: sub rndseed_64bit5 {
6213: my ($symb,$courseid,$domain,$username)=@_;
6214: my ($num1,$num2)=&digest("$symb,$courseid,$domain,$username");
6215: return "$num1:$num2";
6216: }
6217:
1.366 albertel 6218: sub rndseed_CODE_64bit {
6219: my ($symb,$courseid,$domain,$username)=@_;
1.155 albertel 6220: {
1.366 albertel 6221: use integer;
1.443 albertel 6222: my $symbchck=unpack("%32S*",$symb.' ') << 16;
1.484 albertel 6223: my $symbseed=numval2($symb);
1.491 albertel 6224: my $CODEchck=unpack("%32S*",&getCODE().' ') << 16;
6225: my $CODEseed=numval(&getCODE());
1.443 albertel 6226: my $courseseed=unpack("%32S*",$courseid.' ');
1.484 albertel 6227: my $num1=$symbseed+$CODEchck;
6228: my $num2=$CODEseed+$courseseed+$symbchck;
6229: #&Apache::lonxml::debug("$symbseed:$CODEchck|$CODEseed:$courseseed:$symbchck");
1.366 albertel 6230: #&Apache::lonxml::debug("rndseed :$num1:$num2:$symb");
1.564 albertel 6231: if ($_64bit) { $num1=(($num1<<32)>>32); }
6232: if ($_64bit) { $num2=(($num2<<32)>>32); }
1.503 albertel 6233: return "$num1:$num2";
1.366 albertel 6234: }
6235: }
6236:
1.575 albertel 6237: sub rndseed_CODE_64bit4 {
6238: my ($symb,$courseid,$domain,$username)=@_;
6239: {
6240: use integer;
6241: my $symbchck=unpack("%32S*",$symb.' ') << 16;
6242: my $symbseed=numval3($symb);
6243: my $CODEchck=unpack("%32S*",&getCODE().' ') << 16;
6244: my $CODEseed=numval3(&getCODE());
6245: my $courseseed=unpack("%32S*",$courseid.' ');
6246: my $num1=$symbseed+$CODEchck;
6247: my $num2=$CODEseed+$courseseed+$symbchck;
6248: #&Apache::lonxml::debug("$symbseed:$CODEchck|$CODEseed:$courseseed:$symbchck");
6249: #&Apache::lonxml::debug("rndseed :$num1:$num2:$symb");
6250: if ($_64bit) { $num1=(($num1<<32)>>32); }
6251: if ($_64bit) { $num2=(($num2<<32)>>32); }
6252: return "$num1:$num2";
6253: }
6254: }
6255:
1.675 albertel 6256: sub rndseed_CODE_64bit5 {
6257: my ($symb,$courseid,$domain,$username)=@_;
6258: my $code = &getCODE();
6259: my ($num1,$num2)=&digest("$symb,$courseid,$code");
6260: return "$num1:$num2";
6261: }
6262:
1.366 albertel 6263: sub setup_random_from_rndseed {
6264: my ($rndseed)=@_;
1.503 albertel 6265: if ($rndseed =~/([,:])/) {
6266: my ($num1,$num2)=split(/[,:]/,$rndseed);
1.366 albertel 6267: &Math::Random::random_set_seed(abs($num1),abs($num2));
6268: } else {
6269: &Math::Random::random_set_seed_from_phrase($rndseed);
1.98 albertel 6270: }
1.36 albertel 6271: }
6272:
1.474 albertel 6273: sub latest_receipt_algorithm_id {
6274: return 'receipt2';
6275: }
6276:
1.480 www 6277: sub recunique {
6278: my $fucourseid=shift;
6279: my $unique;
1.620 albertel 6280: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2') {
6281: $unique=$env{"course.$fucourseid.internal.encseed"};
1.480 www 6282: } else {
6283: $unique=$perlvar{'lonReceipt'};
6284: }
6285: return unpack("%32C*",$unique);
6286: }
6287:
6288: sub recprefix {
6289: my $fucourseid=shift;
6290: my $prefix;
1.620 albertel 6291: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2') {
6292: $prefix=$env{"course.$fucourseid.internal.encpref"};
1.480 www 6293: } else {
6294: $prefix=$perlvar{'lonHostID'};
6295: }
6296: return unpack("%32C*",$prefix);
6297: }
6298:
1.76 www 6299: sub ireceipt {
1.474 albertel 6300: my ($funame,$fudom,$fucourseid,$fusymb,$part)=@_;
1.76 www 6301: my $cuname=unpack("%32C*",$funame);
6302: my $cudom=unpack("%32C*",$fudom);
6303: my $cucourseid=unpack("%32C*",$fucourseid);
6304: my $cusymb=unpack("%32C*",$fusymb);
1.480 www 6305: my $cunique=&recunique($fucourseid);
1.474 albertel 6306: my $cpart=unpack("%32S*",$part);
1.480 www 6307: my $return =&recprefix($fucourseid).'-';
1.620 albertel 6308: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2' ||
6309: $env{'request.state'} eq 'construct') {
1.474 albertel 6310: &Apache::lonxml::debug("doing receipt2 using parts $cpart, uname $cuname and udom $cudom gets ".($cpart%$cuname).
6311: " and ".($cpart%$cudom));
6312:
6313: $return.= ($cunique%$cuname+
6314: $cunique%$cudom+
6315: $cusymb%$cuname+
6316: $cusymb%$cudom+
6317: $cucourseid%$cuname+
6318: $cucourseid%$cudom+
6319: $cpart%$cuname+
6320: $cpart%$cudom);
6321: } else {
6322: $return.= ($cunique%$cuname+
6323: $cunique%$cudom+
6324: $cusymb%$cuname+
6325: $cusymb%$cudom+
6326: $cucourseid%$cuname+
6327: $cucourseid%$cudom);
6328: }
6329: return $return;
1.76 www 6330: }
6331:
6332: sub receipt {
1.474 albertel 6333: my ($part)=@_;
6334: my ($symb,$courseid,$domain,$name) = &Apache::lonxml::whichuser();
6335: return &ireceipt($name,$domain,$courseid,$symb,$part);
1.76 www 6336: }
1.260 ng 6337:
1.36 albertel 6338: # ------------------------------------------------------------ Serves up a file
1.472 albertel 6339: # returns either the contents of the file or
6340: # -1 if the file doesn't exist
1.481 raeburn 6341: #
6342: # if the target is a file that was uploaded via DOCS,
6343: # a check will be made to see if a current copy exists on the local server,
6344: # if it does this will be served, otherwise a copy will be retrieved from
6345: # the home server for the course and stored in /home/httpd/html/userfiles on
6346: # the local server.
1.472 albertel 6347:
1.36 albertel 6348: sub getfile {
1.538 albertel 6349: my ($file) = @_;
1.609 banghart 6350: if ($file =~ m -^/*(uploaded|editupload)/-) { $file=&filelocation("",$file); }
1.538 albertel 6351: &repcopy($file);
6352: return &readfile($file);
6353: }
6354:
6355: sub repcopy_userfile {
6356: my ($file)=@_;
1.609 banghart 6357: if ($file =~ m -^/*(uploaded|editupload)/-) { $file=&filelocation("",$file); }
1.610 albertel 6358: if ($file =~ m|^/home/httpd/html/lonUsers/|) { return 'ok'; }
1.538 albertel 6359: my ($cdom,$cnum,$filename) =
6360: ($file=~m|^\Q$perlvar{'lonDocRoot'}\E/+userfiles/+([^/]+)/+([^/]+)/+(.*)|);
6361: my ($info,$rtncode);
6362: my $uri="/uploaded/$cdom/$cnum/$filename";
6363: if (-e "$file") {
6364: my @fileinfo = stat($file);
6365: my $lwpresp = &getuploaded('HEAD',$uri,$cdom,$cnum,\$info,\$rtncode);
1.482 albertel 6366: if ($lwpresp ne 'ok') {
6367: if ($rtncode eq '404') {
1.538 albertel 6368: unlink($file);
1.482 albertel 6369: }
1.517 albertel 6370: #my $ua=new LWP::UserAgent;
1.538 albertel 6371: #my $request=new HTTP::Request('GET',&tokenwrapper($uri));
1.517 albertel 6372: #my $response=$ua->request($request);
6373: #if ($response->is_success()) {
6374: # return $response->content;
6375: # } else {
6376: # return -1;
6377: # }
1.482 albertel 6378: return -1;
6379: }
6380: if ($info < $fileinfo[9]) {
1.607 raeburn 6381: return 'ok';
1.482 albertel 6382: }
6383: $info = '';
1.538 albertel 6384: $lwpresp = &getuploaded('GET',$uri,$cdom,$cnum,\$info,\$rtncode);
1.482 albertel 6385: if ($lwpresp ne 'ok') {
6386: return -1;
6387: }
6388: } else {
1.538 albertel 6389: my $lwpresp = &getuploaded('GET',$uri,$cdom,$cnum,\$info,\$rtncode);
1.482 albertel 6390: if ($lwpresp ne 'ok') {
1.517 albertel 6391: my $ua=new LWP::UserAgent;
1.538 albertel 6392: my $request=new HTTP::Request('GET',&tokenwrapper($uri));
1.517 albertel 6393: my $response=$ua->request($request);
6394: if ($response->is_success()) {
1.538 albertel 6395: $info=$response->content;
1.517 albertel 6396: } else {
6397: return -1;
6398: }
1.482 albertel 6399: }
6400: my @parts = ($cdom,$cnum);
6401: if ($filename =~ m|^(.+)/[^/]+$|) {
6402: push @parts, split(/\//,$1);
1.518 albertel 6403: }
1.538 albertel 6404: my $path = $perlvar{'lonDocRoot'}.'/userfiles';
1.482 albertel 6405: foreach my $part (@parts) {
6406: $path .= '/'.$part;
6407: if (!-e $path) {
6408: mkdir($path,0770);
6409: }
6410: }
6411: }
1.538 albertel 6412: open(FILE,">$file");
1.482 albertel 6413: print FILE $info;
6414: close(FILE);
1.607 raeburn 6415: return 'ok';
1.481 raeburn 6416: }
6417:
1.517 albertel 6418: sub tokenwrapper {
6419: my $uri=shift;
1.552 albertel 6420: $uri=~s|^http\://([^/]+)||;
6421: $uri=~s|^/||;
1.620 albertel 6422: $env{'user.environment'}=~/\/([^\/]+)\.id/;
1.517 albertel 6423: my $token=$1;
1.552 albertel 6424: my (undef,$udom,$uname,$file)=split('/',$uri,4);
6425: if ($udom && $uname && $file) {
6426: $file=~s|(\?\.*)*$||;
1.620 albertel 6427: &appenv("userfile.$udom/$uname/$file" => $env{'request.course.id'});
1.552 albertel 6428: return 'http://'.$hostname{ &homeserver($uname,$udom)}.'/'.$uri.
1.517 albertel 6429: (($uri=~/\?/)?'&':'?').'token='.$token.
6430: '&tokenissued='.$perlvar{'lonHostID'};
6431: } else {
6432: return '/adm/notfound.html';
6433: }
6434: }
6435:
1.481 raeburn 6436: sub getuploaded {
6437: my ($reqtype,$uri,$cdom,$cnum,$info,$rtncode) = @_;
6438: $uri=~s/^\///;
6439: $uri = 'http://'.$hostname{ &homeserver($cnum,$cdom)}.'/raw/'.$uri;
6440: my $ua=new LWP::UserAgent;
6441: my $request=new HTTP::Request($reqtype,$uri);
6442: my $response=$ua->request($request);
6443: $$rtncode = $response->code;
1.482 albertel 6444: if (! $response->is_success()) {
6445: return 'failed';
6446: }
6447: if ($reqtype eq 'HEAD') {
1.486 www 6448: $$info = &HTTP::Date::str2time( $response->header('Last-modified') );
1.482 albertel 6449: } elsif ($reqtype eq 'GET') {
6450: $$info = $response->content;
1.472 albertel 6451: }
1.482 albertel 6452: return 'ok';
1.36 albertel 6453: }
6454:
1.481 raeburn 6455: sub readfile {
6456: my $file = shift;
6457: if ( (! -e $file ) || ($file eq '') ) { return -1; };
6458: my $fh;
6459: open($fh,"<$file");
6460: my $a='';
6461: while (<$fh>) { $a .=$_; }
6462: return $a;
6463: }
6464:
1.36 albertel 6465: sub filelocation {
1.590 banghart 6466: my ($dir,$file) = @_;
6467: my $location;
6468: $file=~ s/^\s*(\S+)\s*$/$1/; ## strip off leading and trailing spaces
1.700 albertel 6469:
6470: if ($file =~ m-^/adm/-) {
6471: $file=~s-^/adm/wrapper/-/-;
6472: $file=~s-^/adm/coursedocs/showdoc/-/-;
6473: }
1.590 banghart 6474: if ($file=~m:^/~:) { # is a contruction space reference
6475: $location = $file;
6476: $location =~ s:/~(.*?)/(.*):/home/$1/public_html/$2:;
1.649 albertel 6477: } elsif ($file=~m:^/home/[^/]*/public_html/:) {
6478: # is a correct contruction space reference
6479: $location = $file;
1.609 banghart 6480: } elsif ($file=~/^\/*(uploaded|editupload)/) { # is an uploaded file
1.590 banghart 6481: my ($udom,$uname,$filename)=
1.609 banghart 6482: ($file=~m -^/+(?:uploaded|editupload)/+([^/]+)/+([^/]+)/+(.*)$-);
1.590 banghart 6483: my $home=&homeserver($uname,$udom);
6484: my $is_me=0;
6485: my @ids=¤t_machine_ids();
6486: foreach my $id (@ids) { if ($id eq $home) { $is_me=1; } }
6487: if ($is_me) {
1.740 www 6488: $location=&propath($udom,$uname).
1.590 banghart 6489: '/userfiles/'.$filename;
6490: } else {
6491: $location=$Apache::lonnet::perlvar{'lonDocRoot'}.'/userfiles/'.
6492: $udom.'/'.$uname.'/'.$filename;
6493: }
6494: } else {
6495: $file=~s/^\Q$perlvar{'lonDocRoot'}\E//;
6496: $file=~s:^/res/:/:;
6497: if ( !( $file =~ m:^/:) ) {
6498: $location = $dir. '/'.$file;
6499: } else {
6500: $location = '/home/httpd/html/res'.$file;
6501: }
1.59 albertel 6502: }
1.590 banghart 6503: $location=~s://+:/:g; # remove duplicate /
6504: while ($location=~m:/\.\./:) {$location=~ s:/[^/]+/\.\./:/:g;} #remove dir/..
6505: while ($location=~m:/\./:) {$location=~ s:/\./:/:g;} #remove /./
6506: return $location;
1.46 www 6507: }
1.36 albertel 6508:
1.46 www 6509: sub hreflocation {
6510: my ($dir,$file)=@_;
1.460 albertel 6511: unless (($file=~m-^http://-i) || ($file=~m-^/-)) {
1.666 albertel 6512: $file=filelocation($dir,$file);
1.700 albertel 6513: } elsif ($file=~m-^/adm/-) {
6514: $file=~s-^/adm/wrapper/-/-;
6515: $file=~s-^/adm/coursedocs/showdoc/-/-;
1.666 albertel 6516: }
6517: if ($file=~m-^\Q$perlvar{'lonDocRoot'}\E-) {
6518: $file=~s-^\Q$perlvar{'lonDocRoot'}\E--;
6519: } elsif ($file=~m-/home/(\w+)/public_html/-) {
1.462 albertel 6520: $file=~s-^/home/(\w+)/public_html/-/~$1/-;
1.666 albertel 6521: } elsif ($file=~m-^\Q$perlvar{'lonUsersDir'}\E-) {
6522: $file=~s-^/home/httpd/lonUsers/([^/]*)/./././([^/]*)/userfiles/
6523: -/uploaded/$1/$2/-x;
1.46 www 6524: }
1.462 albertel 6525: return $file;
1.465 albertel 6526: }
6527:
6528: sub current_machine_domains {
6529: my $hostname=$hostname{$perlvar{'lonHostID'}};
6530: my @domains;
6531: while( my($id, $name) = each(%hostname)) {
1.467 matthew 6532: # &logthis("-$id-$name-$hostname-");
1.465 albertel 6533: if ($hostname eq $name) {
6534: push(@domains,$hostdom{$id});
6535: }
6536: }
6537: return @domains;
6538: }
6539:
6540: sub current_machine_ids {
6541: my $hostname=$hostname{$perlvar{'lonHostID'}};
6542: my @ids;
6543: while( my($id, $name) = each(%hostname)) {
1.467 matthew 6544: # &logthis("-$id-$name-$hostname-");
1.465 albertel 6545: if ($hostname eq $name) {
6546: push(@ids,$id);
6547: }
6548: }
6549: return @ids;
1.31 www 6550: }
6551:
6552: # ------------------------------------------------------------- Declutters URLs
6553:
6554: sub declutter {
6555: my $thisfn=shift;
1.569 albertel 6556: if ($thisfn=~m|^/enc/|) { $thisfn=&Apache::lonenc::unencrypted($thisfn); }
1.479 albertel 6557: $thisfn=~s/^\Q$perlvar{'lonDocRoot'}\E//;
1.31 www 6558: $thisfn=~s/^\///;
1.697 albertel 6559: $thisfn=~s|^adm/wrapper/||;
6560: $thisfn=~s|^adm/coursedocs/showdoc/||;
1.31 www 6561: $thisfn=~s/^res\///;
1.235 www 6562: $thisfn=~s/\?.+$//;
1.268 www 6563: return $thisfn;
6564: }
6565:
6566: # ------------------------------------------------------------- Clutter up URLs
6567:
6568: sub clutter {
6569: my $thisfn='/'.&declutter(shift);
1.609 banghart 6570: unless ($thisfn=~/^\/(uploaded|editupload|adm|userfiles|ext|raw|priv|public)\//) {
1.270 www 6571: $thisfn='/res'.$thisfn;
6572: }
1.694 albertel 6573: if ($thisfn !~m|/adm|) {
1.695 albertel 6574: if ($thisfn =~ m|/ext/|) {
1.694 albertel 6575: $thisfn='/adm/wrapper'.$thisfn;
1.695 albertel 6576: } else {
6577: my ($ext) = ($thisfn =~ /\.(\w+)$/);
6578: my $embstyle=&Apache::loncommon::fileembstyle($ext);
1.698 albertel 6579: if ($embstyle eq 'ssi'
6580: || ($embstyle eq 'hdn')
6581: || ($embstyle eq 'rat')
6582: || ($embstyle eq 'prv')
6583: || ($embstyle eq 'ign')) {
6584: #do nothing with these
6585: } elsif (($embstyle eq 'img')
1.695 albertel 6586: || ($embstyle eq 'emb')
6587: || ($embstyle eq 'wrp')) {
6588: $thisfn='/adm/wrapper'.$thisfn;
1.698 albertel 6589: } elsif ($embstyle eq 'unk'
6590: && $thisfn!~/\.(sequence|page)$/) {
1.695 albertel 6591: $thisfn='/adm/coursedocs/showdoc'.$thisfn;
1.698 albertel 6592: } else {
1.718 www 6593: # &logthis("Got a blank emb style");
1.695 albertel 6594: }
1.694 albertel 6595: }
6596: }
1.31 www 6597: return $thisfn;
1.12 www 6598: }
6599:
1.557 albertel 6600: sub freeze_escape {
6601: my ($value)=@_;
6602: if (ref($value)) {
6603: $value=&nfreeze($value);
6604: return '__FROZEN__'.&escape($value);
6605: }
6606: return &escape($value);
6607: }
6608:
1.11 www 6609:
1.557 albertel 6610: sub thaw_unescape {
6611: my ($value)=@_;
6612: if ($value =~ /^__FROZEN__/) {
6613: substr($value,0,10,undef);
6614: $value=&unescape($value);
6615: return &thaw($value);
6616: }
6617: return &unescape($value);
6618: }
6619:
1.436 albertel 6620: sub correct_line_ends {
6621: my ($result)=@_;
6622: $$result =~s/\r\n/\n/mg;
6623: $$result =~s/\r/\n/mg;
1.415 albertel 6624: }
1.1 albertel 6625: # ================================================================ Main Program
6626:
1.184 www 6627: sub goodbye {
1.204 albertel 6628: &logthis("Starting Shut down");
1.443 albertel 6629: #not converted to using infrastruture and probably shouldn't be
1.599 albertel 6630: &logthis(sprintf("%-20s is %s",'%badServerCache',length(&freeze(\%badServerCache))));
1.443 albertel 6631: #converted
1.599 albertel 6632: # &logthis(sprintf("%-20s is %s",'%metacache',scalar(%metacache)));
6633: &logthis(sprintf("%-20s is %s",'%homecache',length(&freeze(\%homecache))));
6634: # &logthis(sprintf("%-20s is %s",'%titlecache',length(&freeze(\%titlecache))));
6635: # &logthis(sprintf("%-20s is %s",'%courseresdatacache',length(&freeze(\%courseresdatacache))));
1.425 albertel 6636: #1.1 only
1.599 albertel 6637: # &logthis(sprintf("%-20s is %s",'%userresdatacache',length(&freeze(\%userresdatacache))));
6638: # &logthis(sprintf("%-20s is %s",'%getsectioncache',length(&freeze(\%getsectioncache))));
6639: # &logthis(sprintf("%-20s is %s",'%courseresversioncache',length(&freeze(\%courseresversioncache))));
6640: # &logthis(sprintf("%-20s is %s",'%resversioncache',length(&freeze(\%resversioncache))));
6641: &logthis(sprintf("%-20s is %s",'%remembered',length(&freeze(\%remembered))));
6642: &logthis(sprintf("%-20s is %s",'kicks',$kicks));
6643: &logthis(sprintf("%-20s is %s",'hits',$hits));
1.184 www 6644: &flushcourselogs();
6645: &logthis("Shutting down");
6646: }
6647:
1.179 www 6648: BEGIN {
1.228 harris41 6649: # ----------------------------------- Read loncapa.conf and loncapa_apache.conf
1.195 www 6650: unless ($readit) {
1.217 harris41 6651: {
1.581 matthew 6652: # FIXME: Use LONCAPA::Configuration::read_conf here and omit next block
1.448 albertel 6653: open(my $config,"</etc/httpd/conf/loncapa.conf");
1.217 harris41 6654:
6655: while (my $configline=<$config>) {
1.484 albertel 6656: if ($configline=~/\S/ && $configline =~ /^[^\#]*PerlSetVar/) {
1.1 albertel 6657: my ($dummy,$varname,$varvalue)=split(/\s+/,$configline);
1.8 www 6658: chomp($varvalue);
1.1 albertel 6659: $perlvar{$varname}=$varvalue;
6660: }
6661: }
1.448 albertel 6662: close($config);
1.1 albertel 6663: }
1.227 harris41 6664: {
1.448 albertel 6665: open(my $config,"</etc/httpd/conf/loncapa_apache.conf");
1.227 harris41 6666:
6667: while (my $configline=<$config>) {
6668: if ($configline =~ /^[^\#]*PerlSetVar/) {
6669: my ($dummy,$varname,$varvalue)=split(/\s+/,$configline);
6670: chomp($varvalue);
6671: $perlvar{$varname}=$varvalue;
6672: }
6673: }
1.448 albertel 6674: close($config);
1.227 harris41 6675: }
1.1 albertel 6676:
1.327 albertel 6677: # ------------------------------------------------------------ Read domain file
6678: {
6679: %domaindescription = ();
6680: %domain_auth_def = ();
6681: %domain_auth_arg_def = ();
1.448 albertel 6682: my $fh;
6683: if (open($fh,"<".$Apache::lonnet::perlvar{'lonTabDir'}.'/domain.tab')) {
1.327 albertel 6684: while (<$fh>) {
1.390 matthew 6685: next if (/^(\#|\s*$)/);
6686: # next if /^\#/;
1.327 albertel 6687: chomp;
1.403 www 6688: my ($domain, $domain_description, $def_auth, $def_auth_arg,
1.685 raeburn 6689: $def_lang, $city, $longi, $lati, $primary) = split(/:/,$_);
1.403 www 6690: $domain_auth_def{$domain}=$def_auth;
1.327 albertel 6691: $domain_auth_arg_def{$domain}=$def_auth_arg;
1.403 www 6692: $domaindescription{$domain}=$domain_description;
6693: $domain_lang_def{$domain}=$def_lang;
6694: $domain_city{$domain}=$city;
6695: $domain_longi{$domain}=$longi;
6696: $domain_lati{$domain}=$lati;
1.685 raeburn 6697: $domain_primary{$domain}=$primary;
1.403 www 6698:
1.448 albertel 6699: # &logthis("Domain.tab: $domain, $domain_auth_def{$domain}, $domain_auth_arg_def{$domain},$domaindescription{$domain}");
1.327 albertel 6700: # &logthis("Domain.tab: $domain ".$domaindescription{$domain} );
1.448 albertel 6701: }
1.327 albertel 6702: }
1.448 albertel 6703: close ($fh);
1.327 albertel 6704: }
6705:
6706:
1.1 albertel 6707: # ------------------------------------------------------------- Read hosts file
6708: {
1.448 albertel 6709: open(my $config,"<$perlvar{'lonTabDir'}/hosts.tab");
1.1 albertel 6710:
6711: while (my $configline=<$config>) {
1.303 matthew 6712: next if ($configline =~ /^(\#|\s*$)/);
1.154 www 6713: chomp($configline);
1.595 albertel 6714: my ($id,$domain,$role,$name)=split(/:/,$configline);
1.597 albertel 6715: $name=~s/\s//g;
1.595 albertel 6716: if ($id && $domain && $role && $name) {
1.252 albertel 6717: $hostname{$id}=$name;
6718: $hostdom{$id}=$domain;
6719: if ($role eq 'library') { $libserv{$id}=$name; }
1.245 www 6720: }
1.1 albertel 6721: }
1.448 albertel 6722: close($config);
1.619 albertel 6723: # FIXME: dev server don't want this, production servers _do_ want this
1.654 albertel 6724: #&get_iphost();
1.1 albertel 6725: }
6726:
1.598 albertel 6727: sub get_iphost {
6728: if (%iphost) { return %iphost; }
1.653 albertel 6729: my %name_to_ip;
1.598 albertel 6730: foreach my $id (keys(%hostname)) {
6731: my $name=$hostname{$id};
1.653 albertel 6732: my $ip;
6733: if (!exists($name_to_ip{$name})) {
6734: $ip = gethostbyname($name);
6735: if (!$ip || length($ip) ne 4) {
6736: &logthis("Skipping host $id name $name no IP found\n");
6737: next;
6738: }
6739: $ip=inet_ntoa($ip);
6740: $name_to_ip{$name} = $ip;
6741: } else {
6742: $ip = $name_to_ip{$name};
1.598 albertel 6743: }
6744: push(@{$iphost{$ip}},$id);
6745: }
6746: return %iphost;
6747: }
6748:
1.1 albertel 6749: # ------------------------------------------------------ Read spare server file
6750: {
1.448 albertel 6751: open(my $config,"<$perlvar{'lonTabDir'}/spare.tab");
1.1 albertel 6752:
6753: while (my $configline=<$config>) {
6754: chomp($configline);
1.284 matthew 6755: if ($configline) {
1.1 albertel 6756: $spareid{$configline}=1;
6757: }
6758: }
1.448 albertel 6759: close($config);
1.1 albertel 6760: }
1.11 www 6761: # ------------------------------------------------------------ Read permissions
6762: {
1.448 albertel 6763: open(my $config,"<$perlvar{'lonTabDir'}/roles.tab");
1.11 www 6764:
6765: while (my $configline=<$config>) {
1.448 albertel 6766: chomp($configline);
6767: if ($configline) {
6768: my ($role,$perm)=split(/ /,$configline);
6769: if ($perm ne '') { $pr{$role}=$perm; }
6770: }
1.11 www 6771: }
1.448 albertel 6772: close($config);
1.11 www 6773: }
6774:
6775: # -------------------------------------------- Read plain texts for permissions
6776: {
1.448 albertel 6777: open(my $config,"<$perlvar{'lonTabDir'}/rolesplain.tab");
1.11 www 6778:
6779: while (my $configline=<$config>) {
1.448 albertel 6780: chomp($configline);
6781: if ($configline) {
6782: my ($short,$plain)=split(/:/,$configline);
6783: if ($plain ne '') { $prp{$short}=$plain; }
6784: }
1.135 www 6785: }
1.448 albertel 6786: close($config);
1.135 www 6787: }
6788:
6789: # ---------------------------------------------------------- Read package table
6790: {
1.448 albertel 6791: open(my $config,"<$perlvar{'lonTabDir'}/packages.tab");
1.135 www 6792:
6793: while (my $configline=<$config>) {
1.483 albertel 6794: if ($configline !~ /\S/ || $configline=~/^#/) { next; }
1.448 albertel 6795: chomp($configline);
6796: my ($short,$plain)=split(/:/,$configline);
6797: my ($pack,$name)=split(/\&/,$short);
6798: if ($plain ne '') {
6799: $packagetab{$pack.'&'.$name.'&name'}=$name;
6800: $packagetab{$short}=$plain;
6801: }
1.11 www 6802: }
1.448 albertel 6803: close($config);
1.329 matthew 6804: }
6805:
6806: # ------------- set up temporary directory
6807: {
6808: $tmpdir = $perlvar{'lonDaemons'}.'/tmp/';
6809:
1.11 www 6810: }
6811:
1.599 albertel 6812: $memcache=new Cache::Memcached({'servers'=>['127.0.0.1:11211']});
1.185 www 6813:
1.281 www 6814: $processmarker='_'.time.'_'.$perlvar{'lonHostID'};
1.186 www 6815: $dumpcount=0;
1.22 www 6816:
1.163 harris41 6817: &logtouch();
1.672 albertel 6818: &logthis('<font color="yellow">INFO: Read configuration</font>');
1.195 www 6819: $readit=1;
1.564 albertel 6820: {
6821: use integer;
6822: my $test=(2**32)+1;
1.568 albertel 6823: if ($test != 0) { $_64bit=1; } else { $_64bit=0; }
1.564 albertel 6824: &logthis(" Detected 64bit platform ($_64bit)");
6825: }
1.195 www 6826: }
1.1 albertel 6827: }
1.179 www 6828:
1.1 albertel 6829: 1;
1.191 harris41 6830: __END__
6831:
1.243 albertel 6832: =pod
6833:
1.191 harris41 6834: =head1 NAME
6835:
1.243 albertel 6836: Apache::lonnet - Subroutines to ask questions about things in the network.
1.191 harris41 6837:
6838: =head1 SYNOPSIS
6839:
1.243 albertel 6840: Invoked by other LON-CAPA modules, when they need to talk to or about objects in the network.
1.191 harris41 6841:
6842: &Apache::lonnet::SUBROUTINENAME(ARGUMENTS);
6843:
1.243 albertel 6844: Common parameters:
6845:
6846: =over 4
6847:
6848: =item *
6849:
6850: $uname : an internal username (if $cname expecting a course Id specifically)
6851:
6852: =item *
6853:
6854: $udom : a domain (if $cdom expecting a course's domain specifically)
6855:
6856: =item *
6857:
6858: $symb : a resource instance identifier
6859:
6860: =item *
6861:
6862: $namespace : the name of a .db file that contains the data needed or
6863: being set.
6864:
6865: =back
6866:
1.394 bowersj2 6867: =head1 OVERVIEW
1.191 harris41 6868:
1.394 bowersj2 6869: lonnet provides subroutines which interact with the
6870: lonc/lond (TCP) network layer of LON-CAPA. They can be used to ask
6871: about classes, users, and resources.
1.243 albertel 6872:
6873: For many of these objects you can also use this to store data about
6874: them or modify them in various ways.
1.191 harris41 6875:
1.394 bowersj2 6876: =head2 Symbs
1.191 harris41 6877:
1.394 bowersj2 6878: To identify a specific instance of a resource, LON-CAPA uses symbols
6879: or "symbs"X<symb>. These identifiers are built from the URL of the
6880: map, the resource number of the resource in the map, and the URL of
6881: the resource itself. The latter is somewhat redundant, but might help
6882: if maps change.
6883:
6884: An example is
6885:
6886: msu/korte/parts/part1.sequence___19___msu/korte/tests/part12.problem
6887:
6888: The respective map entry is
6889:
6890: <resource id="19" src="/res/msu/korte/tests/part12.problem"
6891: title="Problem 2">
6892: </resource>
6893:
6894: Symbs are used by the random number generator, as well as to store and
6895: restore data specific to a certain instance of for example a problem.
6896:
6897: =head2 Storing And Retrieving Data
6898:
6899: X<store()>X<cstore()>X<restore()>Three of the most important functions
6900: in C<lonnet.pm> are C<&Apache::lonnet::cstore()>,
6901: C<&Apache::lonnet:restore()>, and C<&Apache::lonnet::store()>, which
6902: is is the non-critical message twin of cstore. These functions are for
6903: handlers to store a perl hash to a user's permanent data space in an
6904: easy manner, and to retrieve it again on another call. It is expected
6905: that a handler would use this once at the beginning to retrieve data,
6906: and then again once at the end to send only the new data back.
6907:
6908: The data is stored in the user's data directory on the user's
6909: homeserver under the ID of the course.
6910:
6911: The hash that is returned by restore will have all of the previous
6912: value for all of the elements of the hash.
6913:
6914: Example:
6915:
6916: #creating a hash
6917: my %hash;
6918: $hash{'foo'}='bar';
6919:
6920: #storing it
6921: &Apache::lonnet::cstore(\%hash);
6922:
6923: #changing a value
6924: $hash{'foo'}='notbar';
6925:
6926: #adding a new value
6927: $hash{'bar'}='foo';
6928: &Apache::lonnet::cstore(\%hash);
6929:
6930: #retrieving the hash
6931: my %history=&Apache::lonnet::restore();
6932:
6933: #print the hash
6934: foreach my $key (sort(keys(%history))) {
6935: print("\%history{$key} = $history{$key}");
6936: }
6937:
6938: Will print out:
1.191 harris41 6939:
1.394 bowersj2 6940: %history{1:foo} = bar
6941: %history{1:keys} = foo:timestamp
6942: %history{1:timestamp} = 990455579
6943: %history{2:bar} = foo
6944: %history{2:foo} = notbar
6945: %history{2:keys} = foo:bar:timestamp
6946: %history{2:timestamp} = 990455580
6947: %history{bar} = foo
6948: %history{foo} = notbar
6949: %history{timestamp} = 990455580
6950: %history{version} = 2
6951:
6952: Note that the special hash entries C<keys>, C<version> and
6953: C<timestamp> were added to the hash. C<version> will be equal to the
6954: total number of versions of the data that have been stored. The
6955: C<timestamp> attribute will be the UNIX time the hash was
6956: stored. C<keys> is available in every historical section to list which
6957: keys were added or changed at a specific historical revision of a
6958: hash.
6959:
6960: B<Warning>: do not store the hash that restore returns directly. This
6961: will cause a mess since it will restore the historical keys as if the
6962: were new keys. I.E. 1:foo will become 1:1:foo etc.
1.191 harris41 6963:
1.394 bowersj2 6964: Calling convention:
1.191 harris41 6965:
1.394 bowersj2 6966: my %record=&Apache::lonnet::restore($symb,$courseid,$domain,$uname,$home);
6967: &Apache::lonnet::cstore(\%newrecord,$symb,$courseid,$domain,$uname,$home);
1.191 harris41 6968:
1.394 bowersj2 6969: For more detailed information, see lonnet specific documentation.
1.191 harris41 6970:
1.394 bowersj2 6971: =head1 RETURN MESSAGES
1.191 harris41 6972:
1.394 bowersj2 6973: =over 4
1.191 harris41 6974:
1.394 bowersj2 6975: =item * B<con_lost>: unable to contact remote host
1.191 harris41 6976:
1.394 bowersj2 6977: =item * B<con_delayed>: unable to contact remote host, message will be delivered
6978: when the connection is brought back up
1.191 harris41 6979:
1.394 bowersj2 6980: =item * B<con_failed>: unable to contact remote host and unable to save message
6981: for later delivery
1.191 harris41 6982:
1.394 bowersj2 6983: =item * B<error:>: an error a occured, a description of the error follows the :
1.191 harris41 6984:
1.394 bowersj2 6985: =item * B<no_such_host>: unable to fund a host associated with the user/domain
1.243 albertel 6986: that was requested
1.191 harris41 6987:
1.243 albertel 6988: =back
1.191 harris41 6989:
1.243 albertel 6990: =head1 PUBLIC SUBROUTINES
1.191 harris41 6991:
1.243 albertel 6992: =head2 Session Environment Functions
1.191 harris41 6993:
1.243 albertel 6994: =over 4
1.191 harris41 6995:
1.394 bowersj2 6996: =item *
6997: X<appenv()>
6998: B<appenv(%hash)>: the value of %hash is written to
6999: the user envirnoment file, and will be restored for each access this
1.620 albertel 7000: user makes during this session, also modifies the %env for the current
1.394 bowersj2 7001: process
1.191 harris41 7002:
7003: =item *
1.394 bowersj2 7004: X<delenv()>
7005: B<delenv($regexp)>: removes all items from the session
7006: environment file that matches the regular expression in $regexp. The
1.620 albertel 7007: values are also delted from the current processes %env.
1.191 harris41 7008:
1.243 albertel 7009: =back
7010:
7011: =head2 User Information
1.191 harris41 7012:
1.243 albertel 7013: =over 4
1.191 harris41 7014:
7015: =item *
1.394 bowersj2 7016: X<queryauthenticate()>
7017: B<queryauthenticate($uname,$udom)>: try to determine user's current
1.191 harris41 7018: authentication scheme
7019:
7020: =item *
1.394 bowersj2 7021: X<authenticate()>
7022: B<authenticate($uname,$upass,$udom)>: try to
7023: authenticate user from domain's lib servers (first use the current
7024: one). C<$upass> should be the users password.
1.191 harris41 7025:
7026: =item *
1.394 bowersj2 7027: X<homeserver()>
7028: B<homeserver($uname,$udom)>: find the server which has
7029: the user's directory and files (there must be only one), this caches
7030: the answer, and also caches if there is a borken connection.
1.191 harris41 7031:
7032: =item *
1.394 bowersj2 7033: X<idget()>
7034: B<idget($udom,@ids)>: find the usernames behind a list of IDs
7035: (IDs are a unique resource in a domain, there must be only 1 ID per
7036: username, and only 1 username per ID in a specific domain) (returns
7037: hash: id=>name,id=>name)
1.191 harris41 7038:
7039: =item *
1.394 bowersj2 7040: X<idrget()>
7041: B<idrget($udom,@unames)>: find the IDs behind a list of
7042: usernames (returns hash: name=>id,name=>id)
1.191 harris41 7043:
7044: =item *
1.394 bowersj2 7045: X<idput()>
7046: B<idput($udom,%ids)>: store away a list of names and associated IDs
1.191 harris41 7047:
7048: =item *
1.394 bowersj2 7049: X<rolesinit()>
7050: B<rolesinit($udom,$username,$authhost)>: get user privileges
1.243 albertel 7051:
7052: =item *
1.551 albertel 7053: X<getsection()>
7054: B<getsection($udom,$uname,$cname)>: finds the section of student in the
1.243 albertel 7055: course $cname, return section name/number or '' for "not in course"
7056: and '-1' for "no section"
7057:
7058: =item *
1.394 bowersj2 7059: X<userenvironment()>
7060: B<userenvironment($udom,$uname,@what)>: gets the values of the keys
1.243 albertel 7061: passed in @what from the requested user's environment, returns a hash
7062:
7063: =back
7064:
7065: =head2 User Roles
7066:
7067: =over 4
7068:
7069: =item *
7070:
7071: allowed($priv,$uri) : check for a user privilege; returns codes for allowed
7072: actions
7073: F: full access
7074: U,I,K: authentication modes (cxx only)
7075: '': forbidden
7076: 1: user needs to choose course
7077: 2: browse allowed
7078:
7079: =item *
7080:
7081: definerole($rolename,$sysrole,$domrole,$courole) : define role; define a custom
7082: role rolename set privileges in format of lonTabs/roles.tab for system, domain,
7083: and course level
7084:
7085: =item *
7086:
7087: plaintext($short) : return value in %prp hash (rolesplain.tab); plain text
7088: explanation of a user role term
7089:
7090: =back
7091:
7092: =head2 User Modification
7093:
7094: =over 4
7095:
7096: =item *
7097:
7098: assignrole($udom,$uname,$url,$role,$end,$start) : assign role; give a role to a
7099: user for the level given by URL. Optional start and end dates (leave empty
7100: string or zero for "no date")
1.191 harris41 7101:
7102: =item *
7103:
1.243 albertel 7104: changepass($uname,$udom,$currentpass,$newpass,$server) : attempts to
7105: change a users, password, possible return values are: ok,
7106: pwchange_failure, non_authorized, auth_mode_error, unknown_user,
7107: refused
1.191 harris41 7108:
7109: =item *
7110:
1.243 albertel 7111: modifyuserauth($udom,$uname,$umode,$upass) : modify user authentication
1.191 harris41 7112:
7113: =item *
7114:
1.243 albertel 7115: modifyuser($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene) :
7116: modify user
1.191 harris41 7117:
7118: =item *
7119:
1.286 matthew 7120: modifystudent
7121:
7122: modify a students enrollment and identification information.
7123: The course id is resolved based on the current users environment.
7124: This means the envoking user must be a course coordinator or otherwise
7125: associated with a course.
7126:
1.297 matthew 7127: This call is essentially a wrapper for lonnet::modifyuser and
7128: lonnet::modify_student_enrollment
1.286 matthew 7129:
7130: Inputs:
7131:
7132: =over 4
7133:
7134: =item B<$udom> Students loncapa domain
7135:
7136: =item B<$uname> Students loncapa login name
7137:
7138: =item B<$uid> Students id/student number
7139:
7140: =item B<$umode> Students authentication mode
7141:
7142: =item B<$upass> Students password
7143:
7144: =item B<$first> Students first name
7145:
7146: =item B<$middle> Students middle name
7147:
7148: =item B<$last> Students last name
7149:
7150: =item B<$gene> Students generation
7151:
7152: =item B<$usec> Students section in course
7153:
7154: =item B<$end> Unix time of the roles expiration
7155:
7156: =item B<$start> Unix time of the roles start date
7157:
7158: =item B<$forceid> If defined, allow $uid to be changed
7159:
7160: =item B<$desiredhome> server to use as home server for student
7161:
7162: =back
1.297 matthew 7163:
7164: =item *
7165:
7166: modify_student_enrollment
7167:
7168: Change a students enrollment status in a class. The environment variable
7169: 'role.request.course' must be defined for this function to proceed.
7170:
7171: Inputs:
7172:
7173: =over 4
7174:
7175: =item $udom, students domain
7176:
7177: =item $uname, students name
7178:
7179: =item $uid, students user id
7180:
7181: =item $first, students first name
7182:
7183: =item $middle
7184:
7185: =item $last
7186:
7187: =item $gene
7188:
7189: =item $usec
7190:
7191: =item $end
7192:
7193: =item $start
7194:
7195: =back
7196:
1.191 harris41 7197:
7198: =item *
7199:
1.243 albertel 7200: assigncustomrole($udom,$uname,$url,$rdom,$rnam,$rolename,$end,$start) : assign
7201: custom role; give a custom role to a user for the level given by URL. Specify
7202: name and domain of role author, and role name
1.191 harris41 7203:
7204: =item *
7205:
1.243 albertel 7206: revokerole($udom,$uname,$url,$role) : revoke a role for url
1.191 harris41 7207:
7208: =item *
7209:
1.243 albertel 7210: revokecustomrole($udom,$uname,$url,$role) : revoke a custom role
7211:
7212: =back
7213:
7214: =head2 Course Infomation
7215:
7216: =over 4
1.191 harris41 7217:
7218: =item *
7219:
1.631 albertel 7220: coursedescription($courseid) : returns a hash of information about the
7221: specified course id, including all environment settings for the
7222: course, the description of the course will be in the hash under the
7223: key 'description'
1.191 harris41 7224:
7225: =item *
7226:
1.624 albertel 7227: resdata($name,$domain,$type,@which) : request for current parameter
7228: setting for a specific $type, where $type is either 'course' or 'user',
7229: @what should be a list of parameters to ask about. This routine caches
7230: answers for 5 minutes.
1.243 albertel 7231:
7232: =back
7233:
7234: =head2 Course Modification
7235:
7236: =over 4
1.191 harris41 7237:
7238: =item *
7239:
1.243 albertel 7240: writecoursepref($courseid,%prefs) : write preferences (environment
7241: database) for a course
1.191 harris41 7242:
7243: =item *
7244:
1.243 albertel 7245: createcourse($udom,$description,$url) : make/modify course
7246:
7247: =back
7248:
7249: =head2 Resource Subroutines
7250:
7251: =over 4
1.191 harris41 7252:
7253: =item *
7254:
1.243 albertel 7255: subscribe($fname) : subscribe to a resource, returns URL if possible (probably should use repcopy instead)
1.191 harris41 7256:
7257: =item *
7258:
1.243 albertel 7259: repcopy($filename) : subscribes to the requested file, and attempts to
7260: replicate from the owning library server, Might return
1.607 raeburn 7261: 'unavailable', 'not_found', 'forbidden', 'ok', or
7262: 'bad_request', also attempts to grab the metadata for the
1.243 albertel 7263: resource. Expects the local filesystem pathname
7264: (/home/httpd/html/res/....)
7265:
7266: =back
7267:
7268: =head2 Resource Information
7269:
7270: =over 4
1.191 harris41 7271:
7272: =item *
7273:
1.243 albertel 7274: EXT($varname,$symb,$udom,$uname) : evaluates and returns the value of
7275: a vairety of different possible values, $varname should be a request
7276: string, and the other parameters can be used to specify who and what
7277: one is asking about.
7278:
7279: Possible values for $varname are environment.lastname (or other item
7280: from the envirnment hash), user.name (or someother aspect about the
7281: user), resource.0.maxtries (or some other part and parameter of a
7282: resource)
1.204 albertel 7283:
7284: =item *
7285:
1.243 albertel 7286: directcondval($number) : get current value of a condition; reads from a state
7287: string
1.204 albertel 7288:
7289: =item *
7290:
1.243 albertel 7291: condval($condidx) : value of condition index based on state
1.204 albertel 7292:
7293: =item *
7294:
1.243 albertel 7295: metadata($uri,$what,$liburi,$prefix,$depthcount) : request a
7296: resource's metadata, $what should be either a specific key, or either
7297: 'keys' (to get a list of possible keys) or 'packages' to get a list of
7298: packages that this resource currently uses, the last 3 arguments are only used internally for recursive metadata.
7299:
7300: this function automatically caches all requests
1.191 harris41 7301:
7302: =item *
7303:
1.243 albertel 7304: metadata_query($query,$custom,$customshow) : make a metadata query against the
7305: network of library servers; returns file handle of where SQL and regex results
7306: will be stored for query
1.191 harris41 7307:
7308: =item *
7309:
1.243 albertel 7310: symbread($filename) : return symbolic list entry (filename argument optional);
7311: returns the data handle
1.191 harris41 7312:
7313: =item *
7314:
1.243 albertel 7315: symbverify($symb,$thisfn) : verifies that $symb actually exists and is
1.582 albertel 7316: a possible symb for the URL in $thisfn, and if is an encryypted
7317: resource that the user accessed using /enc/ returns a 1 on success, 0
7318: on failure, user must be in a course, as it assumes the existance of
1.620 albertel 7319: the course initial hash, and uses $env('request.course.id'}
1.243 albertel 7320:
1.191 harris41 7321:
7322: =item *
7323:
1.243 albertel 7324: symbclean($symb) : removes versions numbers from a symb, returns the
7325: cleaned symb
1.191 harris41 7326:
7327: =item *
7328:
1.243 albertel 7329: is_on_map($uri) : checks if the $uri is somewhere on the current
7330: course map, user must be in a course for it to work.
1.191 harris41 7331:
7332: =item *
7333:
1.243 albertel 7334: numval($salt) : return random seed value (addend for rndseed)
1.191 harris41 7335:
7336: =item *
7337:
1.243 albertel 7338: rndseed($symb,$courseid,$udom,$uname) : create a random sum; returns
7339: a random seed, all arguments are optional, if they aren't sent it uses the
7340: environment to derive them. Note: if symb isn't sent and it can't get one
7341: from &symbread it will use the current time as its return value
1.191 harris41 7342:
7343: =item *
7344:
1.243 albertel 7345: ireceipt($funame,$fudom,$fucourseid,$fusymb) : return unique,
7346: unfakeable, receipt
1.191 harris41 7347:
7348: =item *
7349:
1.620 albertel 7350: receipt() : API to ireceipt working off of env values; given out to users
1.191 harris41 7351:
7352: =item *
7353:
1.243 albertel 7354: countacc($url) : count the number of accesses to a given URL
1.191 harris41 7355:
7356: =item *
7357:
1.243 albertel 7358: 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 7359:
7360: =item *
7361:
1.243 albertel 7362: 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 7363:
7364: =item *
7365:
1.243 albertel 7366: expirespread($uname,$udom,$stype,$usymb) : set expire date for spreadsheet
1.191 harris41 7367:
7368: =item *
7369:
1.243 albertel 7370: devalidate($symb) : devalidate temporary spreadsheet calculations,
7371: forcing spreadsheet to reevaluate the resource scores next time.
7372:
7373: =back
7374:
7375: =head2 Storing/Retreiving Data
7376:
7377: =over 4
1.191 harris41 7378:
7379: =item *
7380:
1.243 albertel 7381: store($storehash,$symb,$namespace,$udom,$uname) : stores hash permanently
7382: for this url; hashref needs to be given and should be a \%hashname; the
7383: remaining args aren't required and if they aren't passed or are '' they will
1.620 albertel 7384: be derived from the env
1.191 harris41 7385:
7386: =item *
7387:
1.243 albertel 7388: cstore($storehash,$symb,$namespace,$udom,$uname) : same as store but
7389: uses critical subroutine
1.191 harris41 7390:
7391: =item *
7392:
1.243 albertel 7393: restore($symb,$namespace,$udom,$uname) : returns hash for this symb;
7394: all args are optional
1.191 harris41 7395:
7396: =item *
7397:
1.717 albertel 7398: dumpstore($namespace,$udom,$uname,$regexp,$range) :
7399: dumps the complete (or key matching regexp) namespace into a hash
7400: ($udom, $uname, $regexp, $range are optional) for a namespace that is
7401: normally &store()ed into
7402:
7403: $range should be either an integer '100' (give me the first 100
7404: matching records)
7405: or be two integers sperated by a - with no spaces
7406: '30-50' (give me the 30th through the 50th matching
7407: records)
7408:
7409:
7410: =item *
7411:
7412: putstore($namespace,$symb,$version,$storehash,$udomain,$uname) :
7413: replaces a &store() version of data with a replacement set of data
7414: for a particular resource in a namespace passed in the $storehash hash
7415: reference
7416:
7417: =item *
7418:
1.243 albertel 7419: tmpstore($storehash,$symb,$namespace,$udom,$uname) : storage that
7420: works very similar to store/cstore, but all data is stored in a
7421: temporary location and can be reset using tmpreset, $storehash should
7422: be a hash reference, returns nothing on success
1.191 harris41 7423:
7424: =item *
7425:
1.243 albertel 7426: tmprestore($symb,$namespace,$udom,$uname) : storage that works very
7427: similar to restore, but all data is stored in a temporary location and
7428: can be reset using tmpreset. Returns a hash of values on success,
7429: error string otherwise.
1.191 harris41 7430:
7431: =item *
7432:
1.243 albertel 7433: tmpreset($symb,$namespace,$udom,$uname) : temporary storage reset,
7434: deltes all keys for $symb form the temporary storage hash.
1.191 harris41 7435:
7436: =item *
7437:
1.243 albertel 7438: get($namespace,$storearr,$udom,$uname) : returns hash with keys from array
7439: reference filled in from namesp ($udom and $uname are optional)
1.191 harris41 7440:
7441: =item *
7442:
1.243 albertel 7443: del($namespace,$storearr,$udom,$uname) : deletes keys out of array from
7444: namesp ($udom and $uname are optional)
1.191 harris41 7445:
7446: =item *
7447:
1.702 albertel 7448: dump($namespace,$udom,$uname,$regexp,$range) :
1.243 albertel 7449: dumps the complete (or key matching regexp) namespace into a hash
1.702 albertel 7450: ($udom, $uname, $regexp, $range are optional)
1.449 matthew 7451:
1.702 albertel 7452: $range should be either an integer '100' (give me the first 100
7453: matching records)
7454: or be two integers sperated by a - with no spaces
7455: '30-50' (give me the 30th through the 50th matching
7456: records)
1.449 matthew 7457: =item *
7458:
7459: inc($namespace,$store,$udom,$uname) : increments $store in $namespace.
7460: $store can be a scalar, an array reference, or if the amount to be
7461: incremented is > 1, a hash reference.
7462:
7463: ($udom and $uname are optional)
1.191 harris41 7464:
7465: =item *
7466:
1.243 albertel 7467: put($namespace,$storehash,$udom,$uname) : stores hash in namesp
7468: ($udom and $uname are optional)
1.191 harris41 7469:
7470: =item *
7471:
1.243 albertel 7472: cput($namespace,$storehash,$udom,$uname) : critical put
7473: ($udom and $uname are optional)
1.191 harris41 7474:
7475: =item *
7476:
1.243 albertel 7477: eget($namespace,$storearr,$udom,$uname) : returns hash with keys from array
7478: reference filled in from namesp (encrypts the return communication)
7479: ($udom and $uname are optional)
1.191 harris41 7480:
7481: =item *
7482:
1.243 albertel 7483: log($udom,$name,$home,$message) : write to permanent log for user; use
7484: critical subroutine
7485:
7486: =back
7487:
7488: =head2 Network Status Functions
7489:
7490: =over 4
1.191 harris41 7491:
7492: =item *
7493:
7494: dirlist($uri) : return directory list based on URI
7495:
7496: =item *
7497:
1.243 albertel 7498: spareserver() : find server with least workload from spare.tab
7499:
7500: =back
7501:
7502: =head2 Apache Request
7503:
7504: =over 4
1.191 harris41 7505:
7506: =item *
7507:
1.243 albertel 7508: ssi($url,%hash) : server side include, does a complete request cycle on url to
7509: localhost, posts hash
7510:
7511: =back
7512:
7513: =head2 Data to String to Data
7514:
7515: =over 4
1.191 harris41 7516:
7517: =item *
7518:
1.243 albertel 7519: hash2str(%hash) : convert a hash into a string complete with escaping and '='
7520: and '&' separators, supports elements that are arrayrefs and hashrefs
1.191 harris41 7521:
7522: =item *
7523:
1.243 albertel 7524: hashref2str($hashref) : convert a hashref into a string complete with
7525: escaping and '=' and '&' separators, supports elements that are
7526: arrayrefs and hashrefs
1.191 harris41 7527:
7528: =item *
7529:
1.243 albertel 7530: arrayref2str($arrayref) : convert an arrayref into a string complete
7531: with escaping and '&' separators, supports elements that are arrayrefs
7532: and hashrefs
1.191 harris41 7533:
7534: =item *
7535:
1.243 albertel 7536: str2hash($string) : convert string to hash using unescaping and
7537: splitting on '=' and '&', supports elements that are arrayrefs and
7538: hashrefs
1.191 harris41 7539:
7540: =item *
7541:
1.243 albertel 7542: str2array($string) : convert string to hash using unescaping and
7543: splitting on '&', supports elements that are arrayrefs and hashrefs
7544:
7545: =back
7546:
7547: =head2 Logging Routines
7548:
7549: =over 4
7550:
7551: These routines allow one to make log messages in the lonnet.log and
7552: lonnet.perm logfiles.
1.191 harris41 7553:
7554: =item *
7555:
1.243 albertel 7556: logtouch() : make sure the logfile, lonnet.log, exists
1.191 harris41 7557:
7558: =item *
7559:
1.243 albertel 7560: logthis() : append message to the normal lonnet.log file, it gets
7561: preiodically rolled over and deleted.
1.191 harris41 7562:
7563: =item *
7564:
1.243 albertel 7565: logperm() : append a permanent message to lonnet.perm.log, this log
7566: file never gets deleted by any automated portion of the system, only
7567: messages of critical importance should go in here.
7568:
7569: =back
7570:
7571: =head2 General File Helper Routines
7572:
7573: =over 4
1.191 harris41 7574:
7575: =item *
7576:
1.481 raeburn 7577: getfile($file,$caller) : two cases - requests for files in /res or in /uploaded.
7578: (a) files in /uploaded
7579: (i) If a local copy of the file exists -
7580: compares modification date of local copy with last-modified date for
7581: definitive version stored on home server for course. If local copy is
7582: stale, requests a new version from the home server and stores it.
7583: If the original has been removed from the home server, then local copy
7584: is unlinked.
7585: (ii) If local copy does not exist -
7586: requests the file from the home server and stores it.
7587:
7588: If $caller is 'uploadrep':
7589: This indicates a call from lonuploadrep.pm (PerlHeaderParserHandler phase)
7590: for request for files originally uploaded via DOCS.
7591: - returns 'ok' if fresh local copy now available, -1 otherwise.
7592:
7593: Otherwise:
7594: This indicates a call from the content generation phase of the request.
7595: - returns the entire contents of the file or -1.
7596:
7597: (b) files in /res
7598: - returns the entire contents of a file or -1;
7599: it properly subscribes to and replicates the file if neccessary.
1.191 harris41 7600:
1.712 albertel 7601:
7602: =item *
7603:
7604: stat_file($url) : $url is expected to be a /res/ or /uploaded/ style file
7605: reference
7606:
7607: returns either a stat() list of data about the file or an empty list
7608: if the file doesn't exist or couldn't find out about it (connection
7609: problems or user unknown)
7610:
1.191 harris41 7611: =item *
7612:
1.243 albertel 7613: filelocation($dir,$file) : returns file system location of a file
7614: based on URI; meant to be "fairly clean" absolute reference, $dir is a
7615: directory that relative $file lookups are to looked in ($dir of /a/dir
7616: and a file of ../bob will become /a/bob)
1.191 harris41 7617:
7618: =item *
7619:
7620: hreflocation($dir,$file) : returns file system location or a URL; same as
7621: filelocation except for hrefs
7622:
7623: =item *
7624:
7625: declutter() : declutters URLs (remove docroot, beginning slashes, 'res' etc)
7626:
1.243 albertel 7627: =back
7628:
1.608 albertel 7629: =head2 Usererfile file routines (/uploaded*)
7630:
7631: =over 4
7632:
7633: =item *
7634:
7635: userfileupload(): main rotine for putting a file in a user or course's
7636: filespace, arguments are,
7637:
1.620 albertel 7638: formname - required - this is the name of the element in $env where the
1.608 albertel 7639: filename, and the contents of the file to create/modifed exist
1.620 albertel 7640: the filename is in $env{'form.'.$formname.'.filename'} and the
7641: contents of the file is located in $env{'form.'.$formname}
1.608 albertel 7642: coursedoc - if true, store the file in the course of the active role
7643: of the current user
7644: subdir - required - subdirectory to put the file in under ../userfiles/
7645: if undefined, it will be placed in "unknown"
7646:
7647: (This routine calls clean_filename() to remove any dangerous
7648: characters from the filename, and then calls finuserfileupload() to
7649: complete the transaction)
7650:
7651: returns either the url of the uploaded file (/uploaded/....) if successful
7652: and /adm/notfound.html if unsuccessful
7653:
7654: =item *
7655:
7656: clean_filename(): routine for cleaing a filename up for storage in
7657: userfile space, argument is:
7658:
7659: filename - proposed filename
7660:
7661: returns: the new clean filename
7662:
7663: =item *
7664:
7665: finishuserfileupload(): routine that creaes and sends the file to
7666: userspace, probably shouldn't be called directly
7667:
7668: docuname: username or courseid of destination for the file
7669: docudom: domain of user/course of destination for the file
7670: formname: same as for userfileupload()
7671: fname: filename (inculding subdirectories) for the file
7672:
7673: returns either the url of the uploaded file (/uploaded/....) if successful
7674: and /adm/notfound.html if unsuccessful
7675:
7676: =item *
7677:
7678: renameuserfile(): renames an existing userfile to a new name
7679:
7680: Args:
7681: docuname: username or courseid of destination for the file
7682: docudom: domain of user/course of destination for the file
7683: old: current file name (including any subdirs under userfiles)
7684: new: desired file name (including any subdirs under userfiles)
7685:
7686: =item *
7687:
7688: mkdiruserfile(): creates a directory is a userfiles dir
7689:
7690: Args:
7691: docuname: username or courseid of destination for the file
7692: docudom: domain of user/course of destination for the file
7693: dir: dir to create (including any subdirs under userfiles)
7694:
7695: =item *
7696:
7697: removeuserfile(): removes a file that exists in userfiles
7698:
7699: Args:
7700: docuname: username or courseid of destination for the file
7701: docudom: domain of user/course of destination for the file
7702: fname: filname to delete (including any subdirs under userfiles)
7703:
7704: =item *
7705:
7706: removeuploadedurl(): convience function for removeuserfile()
7707:
7708: Args:
7709: url: a full /uploaded/... url to delete
7710:
7711: =back
7712:
1.243 albertel 7713: =head2 HTTP Helper Routines
7714:
7715: =over 4
7716:
1.191 harris41 7717: =item *
7718:
7719: escape() : unpack non-word characters into CGI-compatible hex codes
7720:
7721: =item *
7722:
7723: unescape() : pack CGI-compatible hex codes into actual non-word ASCII character
7724:
1.243 albertel 7725: =back
7726:
7727: =head1 PRIVATE SUBROUTINES
7728:
7729: =head2 Underlying communication routines (Shouldn't call)
7730:
7731: =over 4
7732:
7733: =item *
7734:
7735: subreply() : tries to pass a message to lonc, returns con_lost if incapable
7736:
7737: =item *
7738:
7739: reply() : uses subreply to send a message to remote machine, logs all failures
7740:
7741: =item *
7742:
7743: critical() : passes a critical message to another server; if cannot
7744: get through then place message in connection buffer directory and
7745: returns con_delayed, if incapable of saving message, returns
7746: con_failed
7747:
7748: =item *
7749:
7750: reconlonc() : tries to reconnect lonc client processes.
7751:
7752: =back
7753:
7754: =head2 Resource Access Logging
7755:
7756: =over 4
7757:
7758: =item *
7759:
7760: flushcourselogs() : flush (save) buffer logs and access logs
7761:
7762: =item *
7763:
7764: courselog($what) : save message for course in hash
7765:
7766: =item *
7767:
7768: courseacclog($what) : save message for course using &courselog(). Perform
7769: special processing for specific resource types (problems, exams, quizzes, etc).
7770:
1.191 harris41 7771: =item *
7772:
7773: goodbye() : flush course logs and log shutting down; it is called in srm.conf
7774: as a PerlChildExitHandler
1.243 albertel 7775:
7776: =back
7777:
7778: =head2 Other
7779:
7780: =over 4
7781:
7782: =item *
7783:
7784: symblist($mapname,%newhash) : update symbolic storage links
1.191 harris41 7785:
7786: =back
7787:
7788: =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