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