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