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