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