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