Annotation of loncom/lonnet/perl/lonnet.pm, revision 1.754
1.1 albertel 1: # The LearningOnline Network
2: # TCP networking package
1.12 www 3: #
1.754 ! albertel 4: # $Id: lonnet.pm,v 1.753 2006/06/22 13:16:09 albertel Exp $
1.178 www 5: #
6: # Copyright Michigan State University Board of Trustees
7: #
8: # This file is part of the LearningOnline Network with CAPA (LON-CAPA).
9: #
10: # LON-CAPA is free software; you can redistribute it and/or modify
11: # it under the terms of the GNU General Public License as published by
12: # the Free Software Foundation; either version 2 of the License, or
13: # (at your option) any later version.
14: #
15: # LON-CAPA is distributed in the hope that it will be useful,
16: # but WITHOUT ANY WARRANTY; without even the implied warranty of
17: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18: # GNU General Public License for more details.
19: #
20: # You should have received a copy of the GNU General Public License
21: # along with LON-CAPA; if not, write to the Free Software
22: # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
23: #
24: # /home/httpd/html/adm/gpl.txt
25: #
26: # http://www.lon-capa.org/
27: #
1.169 harris41 28: ###
29:
1.1 albertel 30: package Apache::lonnet;
31:
32: use strict;
1.8 www 33: use LWP::UserAgent();
1.15 www 34: use HTTP::Headers;
1.486 www 35: use HTTP::Date;
36: # use Date::Parse;
1.11 www 37: use vars
1.599 albertel 38: qw(%perlvar %hostname %badServerCache %iphost %spareid %hostdom
39: %libserv %pr %prp $memcache %packagetab
1.662 raeburn 40: %courselogs %accesshash %userrolehash %domainrolehash $processmarker $dumpcount
1.741 raeburn 41: %coursedombuf %coursenumbuf %coursehombuf %coursedescrbuf %courseinstcodebuf %courseownerbuf %coursetypebuf
1.599 albertel 42: %domaindescription %domain_auth_def %domain_auth_arg_def
1.685 raeburn 43: %domain_lang_def %domain_city %domain_longi %domain_lati %domain_primary
44: $tmpdir $_64bit %env);
1.403 www 45:
1.1 albertel 46: use IO::Socket;
1.31 www 47: use GDBM_File;
1.208 albertel 48: use HTML::LCParser;
1.637 raeburn 49: use HTML::Parser;
1.88 www 50: use Fcntl qw(:flock);
1.557 albertel 51: use Storable qw(lock_store lock_nstore lock_retrieve freeze thaw nfreeze);
1.539 albertel 52: use Time::HiRes qw( gettimeofday tv_interval );
1.599 albertel 53: use Cache::Memcached;
1.676 albertel 54: use Digest::MD5;
1.740 www 55: use lib '/home/httpd/lib/perl';
56: use LONCAPA;
57: use LONCAPA::Configuration;
1.676 albertel 58:
1.195 www 59: my $readit;
1.550 foxr 60: my $max_connection_retries = 10; # Or some such value.
1.1 albertel 61:
1.619 albertel 62: require Exporter;
63:
64: our @ISA = qw (Exporter);
65: our @EXPORT = qw(%env);
66:
1.449 matthew 67: =pod
68:
69: =head1 Package Variables
70:
71: These are largely undocumented, so if you decipher one please note it here.
72:
73: =over 4
74:
75: =item $processmarker
76:
77: Contains the time this process was started and this servers host id.
78:
79: =item $dumpcount
80:
81: Counts the number of times a message log flush has been attempted (regardless
82: of success) by this process. Used as part of the filename when messages are
83: delayed.
84:
85: =back
86:
87: =cut
88:
89:
1.1 albertel 90: # --------------------------------------------------------------------- Logging
1.729 www 91: {
92: my $logid;
93: sub instructor_log {
94: my ($hash_name,$storehash,$delflag,$uname,$udom)=@_;
95: $logid++;
96: my $id=time().'00000'.$$.'00000'.$logid;
97: return &Apache::lonnet::put('nohist_'.$hash_name,
1.730 www 98: { $id => {
99: 'exe_uname' => $env{'user.name'},
100: 'exe_udom' => $env{'user.domain'},
101: 'exe_time' => time(),
102: 'exe_ip' => $ENV{'REMOTE_ADDR'},
103: 'delflag' => $delflag,
104: 'logentry' => $storehash,
105: 'uname' => $uname,
106: 'udom' => $udom,
107: }
108: },
1.729 www 109: $env{'course.'.$env{'request.course.id'}.'.domain'},
110: $env{'course.'.$env{'request.course.id'}.'.num'}
111: );
112: }
113: }
1.1 albertel 114:
1.163 harris41 115: sub logtouch {
116: my $execdir=$perlvar{'lonDaemons'};
1.448 albertel 117: unless (-e "$execdir/logs/lonnet.log") {
118: open(my $fh,">>$execdir/logs/lonnet.log");
1.163 harris41 119: close $fh;
120: }
121: my ($wwwuid,$wwwgid)=(getpwnam('www'))[2,3];
122: chown($wwwuid,$wwwgid,$execdir.'/logs/lonnet.log');
123: }
124:
1.1 albertel 125: sub logthis {
126: my $message=shift;
127: my $execdir=$perlvar{'lonDaemons'};
128: my $now=time;
129: my $local=localtime($now);
1.448 albertel 130: if (open(my $fh,">>$execdir/logs/lonnet.log")) {
131: print $fh "$local ($$): $message\n";
132: close($fh);
133: }
1.1 albertel 134: return 1;
135: }
136:
137: sub logperm {
138: my $message=shift;
139: my $execdir=$perlvar{'lonDaemons'};
140: my $now=time;
141: my $local=localtime($now);
1.448 albertel 142: if (open(my $fh,">>$execdir/logs/lonnet.perm.log")) {
143: print $fh "$now:$message:$local\n";
144: close($fh);
145: }
1.1 albertel 146: return 1;
147: }
148:
149: # -------------------------------------------------- Non-critical communication
150: sub subreply {
151: my ($cmd,$server)=@_;
1.704 albertel 152: my $peerfile="$perlvar{'lonSockDir'}/".$hostname{$server};
1.549 foxr 153: #
154: # With loncnew process trimming, there's a timing hole between lonc server
155: # process exit and the master server picking up the listen on the AF_UNIX
156: # socket. In that time interval, a lock file will exist:
157:
158: my $lockfile=$peerfile.".lock";
159: while (-e $lockfile) { # Need to wait for the lockfile to disappear.
160: sleep(1);
161: }
162: # At this point, either a loncnew parent is listening or an old lonc
1.550 foxr 163: # or loncnew child is listening so we can connect or everything's dead.
1.549 foxr 164: #
1.550 foxr 165: # We'll give the connection a few tries before abandoning it. If
166: # connection is not possible, we'll con_lost back to the client.
167: #
168: my $client;
169: for (my $retries = 0; $retries < $max_connection_retries; $retries++) {
170: $client=IO::Socket::UNIX->new(Peer =>"$peerfile",
171: Type => SOCK_STREAM,
172: Timeout => 10);
173: if($client) {
174: last; # Connected!
175: }
176: sleep(1); # Try again later if failed connection.
177: }
178: my $answer;
179: if ($client) {
1.704 albertel 180: print $client "sethost:$server:$cmd\n";
1.550 foxr 181: $answer=<$client>;
182: if (!$answer) { $answer="con_lost"; }
183: chomp($answer);
184: } else {
185: $answer = 'con_lost'; # Failed connection.
186: }
1.1 albertel 187: return $answer;
188: }
189:
190: sub reply {
191: my ($cmd,$server)=@_;
1.205 www 192: unless (defined($hostname{$server})) { return 'no_such_host'; }
1.1 albertel 193: my $answer=subreply($cmd,$server);
1.65 www 194: if (($answer=~/^refused/) || ($answer=~/^rejected/)) {
1.672 albertel 195: &logthis("<font color=\"blue\">WARNING:".
1.12 www 196: " $cmd to $server returned $answer</font>");
197: }
1.1 albertel 198: return $answer;
199: }
200:
201: # ----------------------------------------------------------- Send USR1 to lonc
202:
203: sub reconlonc {
204: my $peerfile=shift;
205: &logthis("Trying to reconnect for $peerfile");
206: my $loncfile="$perlvar{'lonDaemons'}/logs/lonc.pid";
1.448 albertel 207: if (open(my $fh,"<$loncfile")) {
1.1 albertel 208: my $loncpid=<$fh>;
209: chomp($loncpid);
210: if (kill 0 => $loncpid) {
211: &logthis("lonc at pid $loncpid responding, sending USR1");
212: kill USR1 => $loncpid;
213: sleep 1;
214: if (-e "$peerfile") { return; }
215: &logthis("$peerfile still not there, give it another try");
216: sleep 5;
217: if (-e "$peerfile") { return; }
1.12 www 218: &logthis(
1.672 albertel 219: "<font color=\"blue\">WARNING: $peerfile still not there, giving up</font>");
1.1 albertel 220: } else {
1.12 www 221: &logthis(
1.672 albertel 222: "<font color=\"blue\">WARNING:".
1.12 www 223: " lonc at pid $loncpid not responding, giving up</font>");
1.1 albertel 224: }
225: } else {
1.672 albertel 226: &logthis('<font color="blue">WARNING: lonc not running, giving up</font>');
1.1 albertel 227: }
228: }
229:
230: # ------------------------------------------------------ Critical communication
1.12 www 231:
1.1 albertel 232: sub critical {
233: my ($cmd,$server)=@_;
1.89 www 234: unless ($hostname{$server}) {
1.672 albertel 235: &logthis("<font color=\"blue\">WARNING:".
1.89 www 236: " Critical message to unknown server ($server)</font>");
237: return 'no_such_host';
238: }
1.1 albertel 239: my $answer=reply($cmd,$server);
240: if ($answer eq 'con_lost') {
241: &reconlonc("$perlvar{'lonSockDir'}/$server");
1.589 albertel 242: my $answer=reply($cmd,$server);
1.1 albertel 243: if ($answer eq 'con_lost') {
244: my $now=time;
245: my $middlename=$cmd;
1.5 www 246: $middlename=substr($middlename,0,16);
1.1 albertel 247: $middlename=~s/\W//g;
248: my $dfilename=
1.305 www 249: "$perlvar{'lonSockDir'}/delayed/$now.$dumpcount.$$.$middlename.$server";
250: $dumpcount++;
1.1 albertel 251: {
1.448 albertel 252: my $dfh;
253: if (open($dfh,">$dfilename")) {
254: print $dfh "$cmd\n";
255: close($dfh);
256: }
1.1 albertel 257: }
258: sleep 2;
259: my $wcmd='';
260: {
1.448 albertel 261: my $dfh;
262: if (open($dfh,"<$dfilename")) {
263: $wcmd=<$dfh>;
264: close($dfh);
265: }
1.1 albertel 266: }
267: chomp($wcmd);
1.7 www 268: if ($wcmd eq $cmd) {
1.672 albertel 269: &logthis("<font color=\"blue\">WARNING: ".
1.12 www 270: "Connection buffer $dfilename: $cmd</font>");
1.1 albertel 271: &logperm("D:$server:$cmd");
272: return 'con_delayed';
273: } else {
1.672 albertel 274: &logthis("<font color=\"red\">CRITICAL:"
1.12 www 275: ." Critical connection failed: $server $cmd</font>");
1.1 albertel 276: &logperm("F:$server:$cmd");
277: return 'con_failed';
278: }
279: }
280: }
281: return $answer;
1.405 albertel 282: }
283:
1.374 www 284: # ------------------------------------------- Transfer profile into environment
285:
286: sub transfer_profile_to_env {
287: my ($lonidsdir,$handle)=@_;
1.720 albertel 288: if (!defined($lonidsdir)) {
289: $lonidsdir = $perlvar{'lonIDsDir'};
290: }
291: if (!defined($handle)) {
292: ($handle) = ($env{'user.environment'} =~m|/([^/]+)\.id$| );
293: }
294:
1.374 www 295: my @profile;
296: {
1.448 albertel 297: open(my $idf,"$lonidsdir/$handle.id");
1.374 www 298: flock($idf,LOCK_SH);
299: @profile=<$idf>;
1.448 albertel 300: close($idf);
1.374 www 301: }
302: my $envi;
1.433 matthew 303: my %Remove;
1.374 www 304: for ($envi=0;$envi<=$#profile;$envi++) {
305: chomp($profile[$envi]);
1.690 albertel 306: my ($envname,$envvalue)=split(/=/,$profile[$envi],2);
1.726 albertel 307: $envname=&unescape($envname);
308: $envvalue=&unescape($envvalue);
1.619 albertel 309: $env{$envname} = $envvalue;
1.433 matthew 310: if (my ($key,$time) = ($envname =~ /^(cgi\.(\d+)_\d+\.)/)) {
311: if ($time < time-300) {
312: $Remove{$key}++;
313: }
314: }
315: }
1.619 albertel 316: $env{'user.environment'} = "$lonidsdir/$handle.id";
1.433 matthew 317: foreach my $expired_key (keys(%Remove)) {
318: &delenv($expired_key);
1.374 www 319: }
1.1 albertel 320: }
321:
1.5 www 322: # ---------------------------------------------------------- Append Environment
323:
324: sub appenv {
1.6 www 325: my %newenv=@_;
1.692 albertel 326: foreach my $key (keys(%newenv)) {
327: if (($newenv{$key}=~/^user\.role/) || ($newenv{$key}=~/^user\.priv/)) {
1.672 albertel 328: &logthis("<font color=\"blue\">WARNING: ".
1.692 albertel 329: "Attempt to modify environment ".$key." to ".$newenv{$key}
1.151 www 330: .'</font>');
1.692 albertel 331: delete($newenv{$key});
1.35 www 332: } else {
1.692 albertel 333: $env{$key}=$newenv{$key};
1.35 www 334: }
1.191 harris41 335: }
1.95 www 336:
337: my $lockfh;
1.620 albertel 338: unless (open($lockfh,"$env{'user.environment'}")) {
1.448 albertel 339: return 'error: '.$!;
1.95 www 340: }
341: unless (flock($lockfh,LOCK_EX)) {
1.672 albertel 342: &logthis("<font color=\"blue\">WARNING: ".
1.95 www 343: 'Could not obtain exclusive lock in appenv: '.$!);
1.448 albertel 344: close($lockfh);
1.95 www 345: return 'error: '.$!;
346: }
347:
1.6 www 348: my @oldenv;
349: {
1.448 albertel 350: my $fh;
1.620 albertel 351: unless (open($fh,"$env{'user.environment'}")) {
1.448 albertel 352: return 'error: '.$!;
353: }
354: @oldenv=<$fh>;
355: close($fh);
1.6 www 356: }
357: for (my $i=0; $i<=$#oldenv; $i++) {
358: chomp($oldenv[$i]);
1.9 www 359: if ($oldenv[$i] ne '') {
1.690 albertel 360: my ($name,$value)=split(/=/,$oldenv[$i],2);
1.726 albertel 361: $name=&unescape($name);
362: $value=&unescape($value);
1.448 albertel 363: unless (defined($newenv{$name})) {
364: $newenv{$name}=$value;
365: }
1.9 www 366: }
1.6 www 367: }
368: {
1.448 albertel 369: my $fh;
1.620 albertel 370: unless (open($fh,">$env{'user.environment'}")) {
1.448 albertel 371: return 'error';
372: }
373: my $newname;
374: foreach $newname (keys %newenv) {
1.726 albertel 375: print $fh &escape($newname).'='.&escape($newenv{$newname})."\n";
1.448 albertel 376: }
377: close($fh);
1.56 www 378: }
1.448 albertel 379:
380: close($lockfh);
1.56 www 381: return 'ok';
382: }
383: # ----------------------------------------------------- Delete from Environment
384:
385: sub delenv {
386: my $delthis=shift;
387: if (($delthis=~/user\.role/) || ($delthis=~/user\.priv/)) {
1.672 albertel 388: &logthis("<font color=\"blue\">WARNING: ".
1.56 www 389: "Attempt to delete from environment ".$delthis);
390: return 'error';
391: }
392: my @oldenv;
393: {
1.448 albertel 394: my $fh;
1.620 albertel 395: unless (open($fh,"$env{'user.environment'}")) {
1.448 albertel 396: return 'error';
397: }
398: unless (flock($fh,LOCK_SH)) {
1.672 albertel 399: &logthis("<font color=\"blue\">WARNING: ".
1.448 albertel 400: 'Could not obtain shared lock in delenv: '.$!);
401: close($fh);
402: return 'error: '.$!;
403: }
404: @oldenv=<$fh>;
405: close($fh);
1.56 www 406: }
407: {
1.448 albertel 408: my $fh;
1.620 albertel 409: unless (open($fh,">$env{'user.environment'}")) {
1.448 albertel 410: return 'error';
411: }
412: unless (flock($fh,LOCK_EX)) {
1.672 albertel 413: &logthis("<font color=\"blue\">WARNING: ".
1.448 albertel 414: 'Could not obtain exclusive lock in delenv: '.$!);
415: close($fh);
416: return 'error: '.$!;
417: }
1.692 albertel 418: foreach my $cur_key (@oldenv) {
1.726 albertel 419: my $unescaped_cur_key = &unescape($cur_key);
420: if ($unescaped_cur_key=~/^$delthis/) {
421: my ($key) = split('=',$cur_key,2);
422: $key = &unescape($key);
1.619 albertel 423: delete($env{$key});
1.473 matthew 424: } else {
1.692 albertel 425: print $fh $cur_key;
1.473 matthew 426: }
1.448 albertel 427: }
428: close($fh);
1.5 www 429: }
430: return 'ok';
1.369 albertel 431: }
432:
433: # ------------------------------------------ Find out current server userload
434: # there is a copy in lond
435: sub userload {
436: my $numusers=0;
437: {
438: opendir(LONIDS,$perlvar{'lonIDsDir'});
439: my $filename;
440: my $curtime=time;
441: while ($filename=readdir(LONIDS)) {
442: if ($filename eq '.' || $filename eq '..') {next;}
1.404 albertel 443: my ($mtime)=(stat($perlvar{'lonIDsDir'}.'/'.$filename))[9];
1.437 albertel 444: if ($curtime-$mtime < 1800) { $numusers++; }
1.369 albertel 445: }
446: closedir(LONIDS);
447: }
448: my $userloadpercent=0;
449: my $maxuserload=$perlvar{'lonUserLoadLim'};
450: if ($maxuserload) {
1.371 albertel 451: $userloadpercent=100*$numusers/$maxuserload;
1.369 albertel 452: }
1.372 albertel 453: $userloadpercent=sprintf("%.2f",$userloadpercent);
1.369 albertel 454: return $userloadpercent;
1.283 www 455: }
456:
457: # ------------------------------------------ Fight off request when overloaded
458:
459: sub overloaderror {
460: my ($r,$checkserver)=@_;
461: unless ($checkserver) { $checkserver=$perlvar{'lonHostID'}; }
462: my $loadavg;
463: if ($checkserver eq $perlvar{'lonHostID'}) {
1.448 albertel 464: open(my $loadfile,'/proc/loadavg');
1.283 www 465: $loadavg=<$loadfile>;
466: $loadavg =~ s/\s.*//g;
1.285 matthew 467: $loadavg = 100*$loadavg/$perlvar{'lonLoadLim'};
1.448 albertel 468: close($loadfile);
1.283 www 469: } else {
470: $loadavg=&reply('load',$checkserver);
471: }
1.285 matthew 472: my $overload=$loadavg-100;
1.283 www 473: if ($overload>0) {
1.285 matthew 474: $r->err_headers_out->{'Retry-After'}=$overload;
1.283 www 475: $r->log_error('Overload of '.$overload.' on '.$checkserver);
1.554 www 476: return 413;
1.283 www 477: }
478: return '';
1.5 www 479: }
1.1 albertel 480:
481: # ------------------------------ Find server with least workload from spare.tab
1.11 www 482:
1.1 albertel 483: sub spareserver {
1.670 albertel 484: my ($loadpercent,$userloadpercent,$want_server_name) = @_;
1.1 albertel 485: my $tryserver;
486: my $spareserver='';
1.370 albertel 487: if ($userloadpercent !~ /\d/) { $userloadpercent=0; }
488: my $lowestserver=$loadpercent > $userloadpercent?
489: $loadpercent : $userloadpercent;
1.670 albertel 490: foreach $tryserver (keys(%spareid)) {
491: my $loadans=&reply('load',$tryserver);
492: my $userloadans=&reply('userload',$tryserver);
1.411 albertel 493: if ($loadans !~ /\d/ && $userloadans !~ /\d/) {
494: next; #didn't get a number from the server
495: }
496: my $answer;
497: if ($loadans =~ /\d/) {
498: if ($userloadans =~ /\d/) {
499: #both are numbers, pick the bigger one
500: $answer=$loadans > $userloadans?
501: $loadans : $userloadans;
502: } else {
503: $answer = $loadans;
504: }
505: } else {
506: $answer = $userloadans;
507: }
508: if (($answer =~ /\d/) && ($answer<$lowestserver)) {
1.670 albertel 509: if ($want_server_name) {
510: $spareserver=$tryserver;
511: } else {
512: $spareserver="http://$hostname{$tryserver}";
513: }
1.411 albertel 514: $lowestserver=$answer;
515: }
1.370 albertel 516: }
1.1 albertel 517: return $spareserver;
1.202 matthew 518: }
519:
520: # --------------------------------------------- Try to change a user's password
521:
522: sub changepass {
523: my ($uname,$udom,$currentpass,$newpass,$server)=@_;
524: $currentpass = &escape($currentpass);
525: $newpass = &escape($newpass);
526: my $answer = reply("encrypt:passwd:$udom:$uname:$currentpass:$newpass",
527: $server);
528: if (! $answer) {
529: &logthis("No reply on password change request to $server ".
530: "by $uname in domain $udom.");
531: } elsif ($answer =~ "^ok") {
532: &logthis("$uname in $udom successfully changed their password ".
533: "on $server.");
534: } elsif ($answer =~ "^pwchange_failure") {
535: &logthis("$uname in $udom was unable to change their password ".
536: "on $server. The action was blocked by either lcpasswd ".
537: "or pwchange");
538: } elsif ($answer =~ "^non_authorized") {
539: &logthis("$uname in $udom did not get their password correct when ".
540: "attempting to change it on $server.");
541: } elsif ($answer =~ "^auth_mode_error") {
542: &logthis("$uname in $udom attempted to change their password despite ".
543: "not being locally or internally authenticated on $server.");
544: } elsif ($answer =~ "^unknown_user") {
545: &logthis("$uname in $udom attempted to change their password ".
546: "on $server but were unable to because $server is not ".
547: "their home server.");
548: } elsif ($answer =~ "^refused") {
549: &logthis("$server refused to change $uname in $udom password because ".
550: "it was sent an unencrypted request to change the password.");
551: }
552: return $answer;
1.1 albertel 553: }
554:
1.169 harris41 555: # ----------------------- Try to determine user's current authentication scheme
556:
557: sub queryauthenticate {
558: my ($uname,$udom)=@_;
1.456 albertel 559: my $uhome=&homeserver($uname,$udom);
560: if (!$uhome) {
561: &logthis("User $uname at $udom is unknown when looking for authentication mechanism");
562: return 'no_host';
563: }
564: my $answer=reply("encrypt:currentauth:$udom:$uname",$uhome);
565: if ($answer =~ /^(unknown_user|refused|con_lost)/) {
566: &logthis("User $uname at $udom threw error $answer when checking authentication mechanism");
1.169 harris41 567: }
1.456 albertel 568: return $answer;
1.169 harris41 569: }
570:
1.1 albertel 571: # --------- Try to authenticate user from domain's lib servers (first this one)
1.11 www 572:
1.1 albertel 573: sub authenticate {
574: my ($uname,$upass,$udom)=@_;
1.12 www 575: $upass=escape($upass);
1.199 www 576: $uname=~s/\W//g;
1.471 albertel 577: my $uhome=&homeserver($uname,$udom);
578: if (!$uhome) {
579: &logthis("User $uname at $udom is unknown in authenticate");
580: return 'no_host';
1.1 albertel 581: }
1.471 albertel 582: my $answer=reply("encrypt:auth:$udom:$uname:$upass",$uhome);
583: if ($answer eq 'authorized') {
584: &logthis("User $uname at $udom authorized by $uhome");
585: return $uhome;
586: }
587: if ($answer eq 'non_authorized') {
588: &logthis("User $uname at $udom rejected by $uhome");
589: return 'no_host';
1.9 www 590: }
1.471 albertel 591: &logthis("User $uname at $udom threw error $answer when checking authentication mechanism");
1.1 albertel 592: return 'no_host';
593: }
594:
595: # ---------------------- Find the homebase for a user from domain's lib servers
1.11 www 596:
1.599 albertel 597: my %homecache;
1.1 albertel 598: sub homeserver {
1.230 stredwic 599: my ($uname,$udom,$ignoreBadCache)=@_;
1.1 albertel 600: my $index="$uname:$udom";
1.426 albertel 601:
1.599 albertel 602: if (exists($homecache{$index})) { return $homecache{$index}; }
1.1 albertel 603: my $tryserver;
604: foreach $tryserver (keys %libserv) {
1.230 stredwic 605: next if ($ignoreBadCache ne 'true' &&
1.231 stredwic 606: exists($badServerCache{$tryserver}));
1.1 albertel 607: if ($hostdom{$tryserver} eq $udom) {
608: my $answer=reply("home:$udom:$uname",$tryserver);
609: if ($answer eq 'found') {
1.599 albertel 610: return $homecache{$index}=$tryserver;
1.231 stredwic 611: } elsif ($answer eq 'no_host') {
612: $badServerCache{$tryserver}=1;
1.221 matthew 613: }
1.1 albertel 614: }
615: }
616: return 'no_host';
1.70 www 617: }
618:
619: # ------------------------------------- Find the usernames behind a list of IDs
620:
621: sub idget {
622: my ($udom,@ids)=@_;
623: my %returnhash=();
624:
625: my $tryserver;
626: foreach $tryserver (keys %libserv) {
627: if ($hostdom{$tryserver} eq $udom) {
628: my $idlist=join('&',@ids);
629: $idlist=~tr/A-Z/a-z/;
630: my $reply=&reply("idget:$udom:".$idlist,$tryserver);
631: my @answer=();
1.76 www 632: if (($reply ne 'con_lost') && ($reply!~/^error\:/)) {
1.70 www 633: @answer=split(/\&/,$reply);
634: } ;
635: my $i;
636: for ($i=0;$i<=$#ids;$i++) {
637: if ($answer[$i]) {
638: $returnhash{$ids[$i]}=$answer[$i];
639: }
640: }
641: }
642: }
643: return %returnhash;
644: }
645:
646: # ------------------------------------- Find the IDs behind a list of usernames
647:
648: sub idrget {
649: my ($udom,@unames)=@_;
650: my %returnhash=();
1.191 harris41 651: foreach (@unames) {
1.70 www 652: $returnhash{$_}=(&userenvironment($udom,$_,'id'))[1];
1.191 harris41 653: }
1.70 www 654: return %returnhash;
655: }
656:
657: # ------------------------------- Store away a list of names and associated IDs
658:
659: sub idput {
660: my ($udom,%ids)=@_;
661: my %servers=();
1.191 harris41 662: foreach (keys %ids) {
1.487 albertel 663: &cput('environment',{'id'=>$ids{$_}},$udom,$_);
1.70 www 664: my $uhom=&homeserver($_,$udom);
665: if ($uhom ne 'no_host') {
666: my $id=&escape($ids{$_});
667: $id=~tr/A-Z/a-z/;
668: my $unam=&escape($_);
669: if ($servers{$uhom}) {
670: $servers{$uhom}.='&'.$id.'='.$unam;
671: } else {
672: $servers{$uhom}=$id.'='.$unam;
673: }
674: }
1.191 harris41 675: }
676: foreach (keys %servers) {
1.70 www 677: &critical('idput:'.$udom.':'.$servers{$_},$_);
1.191 harris41 678: }
1.344 www 679: }
680:
681: # --------------------------------------------------- Assign a key to a student
682:
683: sub assign_access_key {
1.364 www 684: #
685: # a valid key looks like uname:udom#comments
686: # comments are being appended
687: #
1.498 www 688: my ($ckey,$kdom,$knum,$cdom,$cnum,$udom,$uname,$logentry)=@_;
689: $kdom=
1.620 albertel 690: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($kdom));
1.498 www 691: $knum=
1.620 albertel 692: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($knum));
1.344 www 693: $cdom=
1.620 albertel 694: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
1.344 www 695: $cnum=
1.620 albertel 696: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
697: $udom=$env{'user.name'} unless (defined($udom));
698: $uname=$env{'user.domain'} unless (defined($uname));
1.498 www 699: my %existing=&get('accesskeys',[$ckey],$kdom,$knum);
1.364 www 700: if (($existing{$ckey}=~/^\#(.*)$/) || # - new key
1.479 albertel 701: ($existing{$ckey}=~/^\Q$uname\E\:\Q$udom\E\#(.*)$/)) {
1.364 www 702: # assigned to this person
703: # - this should not happen,
1.345 www 704: # unless something went wrong
705: # the first time around
706: # ready to assign
1.364 www 707: $logentry=$1.'; '.$logentry;
1.496 www 708: if (&put('accesskeys',{$ckey=>$uname.':'.$udom.'#'.$logentry},
1.498 www 709: $kdom,$knum) eq 'ok') {
1.345 www 710: # key now belongs to user
1.346 www 711: my $envkey='key.'.$cdom.'_'.$cnum;
1.345 www 712: if (&put('environment',{$envkey => $ckey}) eq 'ok') {
713: &appenv('environment.'.$envkey => $ckey);
714: return 'ok';
715: } else {
716: return
717: 'error: Count not permanently assign key, will need to be re-entered later.';
718: }
719: } else {
720: return 'error: Could not assign key, try again later.';
721: }
1.364 www 722: } elsif (!$existing{$ckey}) {
1.345 www 723: # the key does not exist
724: return 'error: The key does not exist';
725: } else {
726: # the key is somebody else's
727: return 'error: The key is already in use';
728: }
1.344 www 729: }
730:
1.364 www 731: # ------------------------------------------ put an additional comment on a key
732:
733: sub comment_access_key {
734: #
735: # a valid key looks like uname:udom#comments
736: # comments are being appended
737: #
738: my ($ckey,$cdom,$cnum,$logentry)=@_;
739: $cdom=
1.620 albertel 740: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
1.364 www 741: $cnum=
1.620 albertel 742: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
1.364 www 743: my %existing=&get('accesskeys',[$ckey],$cdom,$cnum);
744: if ($existing{$ckey}) {
745: $existing{$ckey}.='; '.$logentry;
746: # ready to assign
1.367 www 747: if (&put('accesskeys',{$ckey=>$existing{$ckey}},
1.364 www 748: $cdom,$cnum) eq 'ok') {
749: return 'ok';
750: } else {
751: return 'error: Count not store comment.';
752: }
753: } else {
754: # the key does not exist
755: return 'error: The key does not exist';
756: }
757: }
758:
1.344 www 759: # ------------------------------------------------------ Generate a set of keys
760:
761: sub generate_access_keys {
1.364 www 762: my ($number,$cdom,$cnum,$logentry)=@_;
1.344 www 763: $cdom=
1.620 albertel 764: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
1.344 www 765: $cnum=
1.620 albertel 766: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
1.361 www 767: unless (&allowed('mky',$cdom)) { return 0; }
1.344 www 768: unless (($cdom) && ($cnum)) { return 0; }
769: if ($number>10000) { return 0; }
770: sleep(2); # make sure don't get same seed twice
771: srand(time()^($$+($$<<15))); # from "Programming Perl"
772: my $total=0;
773: for (my $i=1;$i<=$number;$i++) {
774: my $newkey=sprintf("%lx",int(100000*rand)).'-'.
775: sprintf("%lx",int(100000*rand)).'-'.
776: sprintf("%lx",int(100000*rand));
777: $newkey=~s/1/g/g; # folks mix up 1 and l
778: $newkey=~s/0/h/g; # and also 0 and O
779: my %existing=&get('accesskeys',[$newkey],$cdom,$cnum);
780: if ($existing{$newkey}) {
781: $i--;
782: } else {
1.364 www 783: if (&put('accesskeys',
784: { $newkey => '# generated '.localtime().
1.620 albertel 785: ' by '.$env{'user.name'}.'@'.$env{'user.domain'}.
1.364 www 786: '; '.$logentry },
787: $cdom,$cnum) eq 'ok') {
1.344 www 788: $total++;
789: }
790: }
791: }
1.620 albertel 792: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},
1.344 www 793: 'Generated '.$total.' keys for '.$cnum.' at '.$cdom);
794: return $total;
795: }
796:
797: # ------------------------------------------------------- Validate an accesskey
798:
799: sub validate_access_key {
800: my ($ckey,$cdom,$cnum,$udom,$uname)=@_;
801: $cdom=
1.620 albertel 802: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
1.344 www 803: $cnum=
1.620 albertel 804: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
805: $udom=$env{'user.domain'} unless (defined($udom));
806: $uname=$env{'user.name'} unless (defined($uname));
1.345 www 807: my %existing=&get('accesskeys',[$ckey],$cdom,$cnum);
1.479 albertel 808: return ($existing{$ckey}=~/^\Q$uname\E\:\Q$udom\E\#/);
1.70 www 809: }
810:
811: # ------------------------------------- Find the section of student in a course
1.652 albertel 812: sub devalidate_getsection_cache {
813: my ($udom,$unam,$courseid)=@_;
814: $courseid=~s/\_/\//g;
815: $courseid=~s/^(\w)/\/$1/;
816: my $hashid="$udom:$unam:$courseid";
817: &devalidate_cache_new('getsection',$hashid);
818: }
1.298 matthew 819:
820: sub getsection {
821: my ($udom,$unam,$courseid)=@_;
1.599 albertel 822: my $cachetime=1800;
1.298 matthew 823: $courseid=~s/\_/\//g;
824: $courseid=~s/^(\w)/\/$1/;
1.551 albertel 825:
826: my $hashid="$udom:$unam:$courseid";
1.599 albertel 827: my ($result,$cached)=&is_cached_new('getsection',$hashid);
1.551 albertel 828: if (defined($cached)) { return $result; }
829:
1.298 matthew 830: my %Pending;
831: my %Expired;
832: #
833: # Each role can either have not started yet (pending), be active,
834: # or have expired.
835: #
836: # If there is an active role, we are done.
837: #
838: # If there is more than one role which has not started yet,
839: # choose the one which will start sooner
840: # If there is one role which has not started yet, return it.
841: #
842: # If there is more than one expired role, choose the one which ended last.
843: # If there is a role which has expired, return it.
844: #
845: foreach (split(/\&/,&reply('dump:'.$udom.':'.$unam.':roles',
846: &homeserver($unam,$udom)))) {
847: my ($key,$value)=split(/\=/,$_);
848: $key=&unescape($key);
1.479 albertel 849: next if ($key !~/^\Q$courseid\E(?:\/)*(\w+)*\_st$/);
1.298 matthew 850: my $section=$1;
851: if ($key eq $courseid.'_st') { $section=''; }
852: my ($dummy,$end,$start)=split(/\_/,&unescape($value));
853: my $now=time;
1.548 albertel 854: if (defined($end) && $end && ($now > $end)) {
1.298 matthew 855: $Expired{$end}=$section;
856: next;
857: }
1.548 albertel 858: if (defined($start) && $start && ($now < $start)) {
1.298 matthew 859: $Pending{$start}=$section;
860: next;
861: }
1.599 albertel 862: return &do_cache_new('getsection',$hashid,$section,$cachetime);
1.298 matthew 863: }
864: #
865: # Presumedly there will be few matching roles from the above
866: # loop and the sorting time will be negligible.
867: if (scalar(keys(%Pending))) {
868: my ($time) = sort {$a <=> $b} keys(%Pending);
1.599 albertel 869: return &do_cache_new('getsection',$hashid,$Pending{$time},$cachetime);
1.298 matthew 870: }
871: if (scalar(keys(%Expired))) {
872: my @sorted = sort {$a <=> $b} keys(%Expired);
873: my $time = pop(@sorted);
1.599 albertel 874: return &do_cache_new('getsection',$hashid,$Expired{$time},$cachetime);
1.298 matthew 875: }
1.599 albertel 876: return &do_cache_new('getsection',$hashid,'-1',$cachetime);
1.298 matthew 877: }
1.70 www 878:
1.599 albertel 879: sub save_cache {
880: &purge_remembered();
1.722 albertel 881: #&Apache::loncommon::validate_page();
1.620 albertel 882: undef(%env);
1.599 albertel 883: }
1.452 albertel 884:
1.599 albertel 885: my $to_remember=-1;
886: my %remembered;
887: my %accessed;
888: my $kicks=0;
889: my $hits=0;
890: sub devalidate_cache_new {
891: my ($name,$id,$debug) = @_;
892: if ($debug) { &Apache::lonnet::logthis("deleting $name:$id"); }
893: $id=&escape($name.':'.$id);
894: $memcache->delete($id);
895: delete($remembered{$id});
896: delete($accessed{$id});
897: }
898:
899: sub is_cached_new {
900: my ($name,$id,$debug) = @_;
901: $id=&escape($name.':'.$id);
902: if (exists($remembered{$id})) {
903: if ($debug) { &Apache::lonnet::logthis("Earyl return $id of $remembered{$id} "); }
904: $accessed{$id}=[&gettimeofday()];
905: $hits++;
906: return ($remembered{$id},1);
907: }
908: my $value = $memcache->get($id);
909: if (!(defined($value))) {
910: if ($debug) { &Apache::lonnet::logthis("getting $id is not defined"); }
1.417 albertel 911: return (undef,undef);
1.416 albertel 912: }
1.599 albertel 913: if ($value eq '__undef__') {
914: if ($debug) { &Apache::lonnet::logthis("getting $id is __undef__"); }
915: $value=undef;
916: }
917: &make_room($id,$value,$debug);
918: if ($debug) { &Apache::lonnet::logthis("getting $id is $value"); }
919: return ($value,1);
920: }
921:
922: sub do_cache_new {
923: my ($name,$id,$value,$time,$debug) = @_;
924: $id=&escape($name.':'.$id);
925: my $setvalue=$value;
926: if (!defined($setvalue)) {
927: $setvalue='__undef__';
928: }
1.623 albertel 929: if (!defined($time) ) {
930: $time=600;
931: }
1.599 albertel 932: if ($debug) { &Apache::lonnet::logthis("Setting $id to $value"); }
1.600 albertel 933: $memcache->set($id,$setvalue,$time);
934: # need to make a copy of $value
935: #&make_room($id,$value,$debug);
1.599 albertel 936: return $value;
937: }
938:
939: sub make_room {
940: my ($id,$value,$debug)=@_;
941: $remembered{$id}=$value;
942: if ($to_remember<0) { return; }
943: $accessed{$id}=[&gettimeofday()];
944: if (scalar(keys(%remembered)) <= $to_remember) { return; }
945: my $to_kick;
946: my $max_time=0;
947: foreach my $other (keys(%accessed)) {
948: if (&tv_interval($accessed{$other}) > $max_time) {
949: $to_kick=$other;
950: $max_time=&tv_interval($accessed{$other});
951: }
952: }
953: delete($remembered{$to_kick});
954: delete($accessed{$to_kick});
955: $kicks++;
956: if ($debug) { &logthis("kicking $to_kick $max_time $kicks\n"); }
1.541 albertel 957: return;
958: }
959:
1.599 albertel 960: sub purge_remembered {
1.604 albertel 961: #&logthis("Tossing ".scalar(keys(%remembered)));
962: #&logthis(sprintf("%-20s is %s",'%remembered',length(&freeze(\%remembered))));
1.599 albertel 963: undef(%remembered);
964: undef(%accessed);
1.428 albertel 965: }
1.70 www 966: # ------------------------------------- Read an entry from a user's environment
967:
968: sub userenvironment {
969: my ($udom,$unam,@what)=@_;
970: my %returnhash=();
971: my @answer=split(/\&/,
972: &reply('get:'.$udom.':'.$unam.':environment:'.join('&',@what),
973: &homeserver($unam,$udom)));
974: my $i;
975: for ($i=0;$i<=$#what;$i++) {
976: $returnhash{$what[$i]}=&unescape($answer[$i]);
977: }
978: return %returnhash;
1.1 albertel 979: }
980:
1.617 albertel 981: # ---------------------------------------------------------- Get a studentphoto
982: sub studentphoto {
983: my ($udom,$unam,$ext) = @_;
984: my $home=&Apache::lonnet::homeserver($unam,$udom);
1.706 raeburn 985: if (defined($env{'request.course.id'})) {
1.708 raeburn 986: if ($env{'course.'.$env{'request.course.id'}.'.internal.showphoto'}) {
1.706 raeburn 987: if ($udom eq $env{'course.'.$env{'request.course.id'}.'.domain'}) {
988: return(&retrievestudentphoto($udom,$unam,$ext));
989: } else {
990: my ($result,$perm_reqd)=
1.707 albertel 991: &Apache::lonnet::auto_photo_permission($unam,$udom);
1.706 raeburn 992: if ($result eq 'ok') {
993: if (!($perm_reqd eq 'yes')) {
994: return(&retrievestudentphoto($udom,$unam,$ext));
995: }
996: }
997: }
998: }
999: } else {
1000: my ($result,$perm_reqd) =
1.707 albertel 1001: &Apache::lonnet::auto_photo_permission($unam,$udom);
1.706 raeburn 1002: if ($result eq 'ok') {
1003: if (!($perm_reqd eq 'yes')) {
1004: return(&retrievestudentphoto($udom,$unam,$ext));
1005: }
1006: }
1007: }
1008: return '/adm/lonKaputt/lonlogo_broken.gif';
1009: }
1010:
1011: sub retrievestudentphoto {
1012: my ($udom,$unam,$ext,$type) = @_;
1013: my $home=&Apache::lonnet::homeserver($unam,$udom);
1014: my $ret=&Apache::lonnet::reply("studentphoto:$udom:$unam:$ext:$type",$home);
1015: if ($ret eq 'ok') {
1016: my $url="/uploaded/$udom/$unam/internal/studentphoto.$ext";
1017: if ($type eq 'thumbnail') {
1018: $url="/uploaded/$udom/$unam/internal/studentphoto_tn.$ext";
1019: }
1020: my $tokenurl=&Apache::lonnet::tokenwrapper($url);
1021: return $tokenurl;
1022: } else {
1023: if ($type eq 'thumbnail') {
1024: return '/adm/lonKaputt/genericstudent_tn.gif';
1025: } else {
1026: return '/adm/lonKaputt/lonlogo_broken.gif';
1027: }
1.617 albertel 1028: }
1029: }
1030:
1.263 www 1031: # -------------------------------------------------------------------- New chat
1032:
1033: sub chatsend {
1.724 raeburn 1034: my ($newentry,$anon,$group)=@_;
1.620 albertel 1035: my $cnum=$env{'course.'.$env{'request.course.id'}.'.num'};
1036: my $cdom=$env{'course.'.$env{'request.course.id'}.'.domain'};
1037: my $chome=$env{'course.'.$env{'request.course.id'}.'.home'};
1.263 www 1038: &reply('chatsend:'.$cdom.':'.$cnum.':'.
1.620 albertel 1039: &escape($env{'user.domain'}.':'.$env{'user.name'}.':'.$anon.':'.
1.724 raeburn 1040: &escape($newentry)).':'.$group,$chome);
1.292 www 1041: }
1042:
1043: # ------------------------------------------ Find current version of a resource
1044:
1045: sub getversion {
1046: my $fname=&clutter(shift);
1047: unless ($fname=~/^\/res\//) { return -1; }
1048: return ¤tversion(&filelocation('',$fname));
1049: }
1050:
1051: sub currentversion {
1052: my $fname=shift;
1.599 albertel 1053: my ($result,$cached)=&is_cached_new('resversion',$fname);
1.440 www 1054: if (defined($cached)) { return $result; }
1.292 www 1055: my $author=$fname;
1056: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
1057: my ($udom,$uname)=split(/\//,$author);
1058: my $home=homeserver($uname,$udom);
1059: if ($home eq 'no_host') {
1060: return -1;
1061: }
1062: my $answer=reply("currentversion:$fname",$home);
1063: if (($answer eq 'con_lost') || ($answer eq 'rejected')) {
1064: return -1;
1065: }
1.599 albertel 1066: return &do_cache_new('resversion',$fname,$answer,600);
1.263 www 1067: }
1068:
1.1 albertel 1069: # ----------------------------- Subscribe to a resource, return URL if possible
1.11 www 1070:
1.1 albertel 1071: sub subscribe {
1072: my $fname=shift;
1.312 www 1073: if ($fname=~/\/(aboutme|syllabus|bulletinboard|smppg)$/) { return ''; }
1.532 albertel 1074: $fname=~s/[\n\r]//g;
1.1 albertel 1075: my $author=$fname;
1076: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
1077: my ($udom,$uname)=split(/\//,$author);
1078: my $home=homeserver($uname,$udom);
1.335 albertel 1079: if ($home eq 'no_host') {
1080: return 'not_found';
1.1 albertel 1081: }
1082: my $answer=reply("sub:$fname",$home);
1.64 www 1083: if (($answer eq 'con_lost') || ($answer eq 'rejected')) {
1084: $answer.=' by '.$home;
1085: }
1.1 albertel 1086: return $answer;
1087: }
1088:
1.8 www 1089: # -------------------------------------------------------------- Replicate file
1090:
1091: sub repcopy {
1092: my $filename=shift;
1.23 www 1093: $filename=~s/\/+/\//g;
1.607 raeburn 1094: if ($filename=~m|^/home/httpd/html/adm/|) { return 'ok'; }
1095: if ($filename=~m|^/home/httpd/html/lonUsers/|) { return 'ok'; }
1.538 albertel 1096: if ($filename=~m|^/home/httpd/html/userfiles/| or
1.609 banghart 1097: $filename=~m -^/*(uploaded|editupload)/-) {
1.538 albertel 1098: return &repcopy_userfile($filename);
1099: }
1.532 albertel 1100: $filename=~s/[\n\r]//g;
1.8 www 1101: my $transname="$filename.in.transfer";
1.607 raeburn 1102: if ((-e $filename) || (-e $transname)) { return 'ok'; }
1.8 www 1103: my $remoteurl=subscribe($filename);
1.64 www 1104: if ($remoteurl =~ /^con_lost by/) {
1105: &logthis("Subscribe returned $remoteurl: $filename");
1.607 raeburn 1106: return 'unavailable';
1.8 www 1107: } elsif ($remoteurl eq 'not_found') {
1.441 albertel 1108: #&logthis("Subscribe returned not_found: $filename");
1.607 raeburn 1109: return 'not_found';
1.64 www 1110: } elsif ($remoteurl =~ /^rejected by/) {
1111: &logthis("Subscribe returned $remoteurl: $filename");
1.607 raeburn 1112: return 'forbidden';
1.20 www 1113: } elsif ($remoteurl eq 'directory') {
1.607 raeburn 1114: return 'ok';
1.8 www 1115: } else {
1.290 www 1116: my $author=$filename;
1117: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
1118: my ($udom,$uname)=split(/\//,$author);
1119: my $home=homeserver($uname,$udom);
1120: unless ($home eq $perlvar{'lonHostID'}) {
1.8 www 1121: my @parts=split(/\//,$filename);
1122: my $path="/$parts[1]/$parts[2]/$parts[3]/$parts[4]";
1123: if ($path ne "$perlvar{'lonDocRoot'}/res") {
1124: &logthis("Malconfiguration for replication: $filename");
1.607 raeburn 1125: return 'bad_request';
1.8 www 1126: }
1127: my $count;
1128: for ($count=5;$count<$#parts;$count++) {
1129: $path.="/$parts[$count]";
1130: if ((-e $path)!=1) {
1131: mkdir($path,0777);
1132: }
1133: }
1134: my $ua=new LWP::UserAgent;
1135: my $request=new HTTP::Request('GET',"$remoteurl");
1136: my $response=$ua->request($request,$transname);
1137: if ($response->is_error()) {
1138: unlink($transname);
1139: my $message=$response->status_line;
1.672 albertel 1140: &logthis("<font color=\"blue\">WARNING:"
1.12 www 1141: ." LWP get: $message: $filename</font>");
1.607 raeburn 1142: return 'unavailable';
1.8 www 1143: } else {
1.16 www 1144: if ($remoteurl!~/\.meta$/) {
1145: my $mrequest=new HTTP::Request('GET',$remoteurl.'.meta');
1146: my $mresponse=$ua->request($mrequest,$filename.'.meta');
1147: if ($mresponse->is_error()) {
1148: unlink($filename.'.meta');
1149: &logthis(
1.672 albertel 1150: "<font color=\"yellow\">INFO: No metadata: $filename</font>");
1.16 www 1151: }
1152: }
1.8 www 1153: rename($transname,$filename);
1.607 raeburn 1154: return 'ok';
1.8 www 1155: }
1.290 www 1156: }
1.8 www 1157: }
1.330 www 1158: }
1159:
1160: # ------------------------------------------------ Get server side include body
1161: sub ssi_body {
1.381 albertel 1162: my ($filelink,%form)=@_;
1.606 matthew 1163: if (! exists($form{'LONCAPA_INTERNAL_no_discussion'})) {
1164: $form{'LONCAPA_INTERNAL_no_discussion'}='true';
1165: }
1.330 www 1166: my $output=($filelink=~/^http\:/?&externalssi($filelink):
1.381 albertel 1167: &ssi($filelink,%form));
1.565 albertel 1168: $output=~s|//(\s*<!--)? BEGIN LON-CAPA Internal.+// END LON-CAPA Internal\s*(-->)?\s||gs;
1.451 albertel 1169: $output=~s/^.*?\<body[^\>]*\>//si;
1170: $output=~s/(.*)\<\/body\s*\>.*?$/$1/si;
1.330 www 1171: return $output;
1.8 www 1172: }
1173:
1.15 www 1174: # --------------------------------------------------------- Server Side Include
1175:
1176: sub ssi {
1177:
1.23 www 1178: my ($fn,%form)=@_;
1.15 www 1179:
1180: my $ua=new LWP::UserAgent;
1.23 www 1181:
1182: my $request;
1.711 albertel 1183:
1184: $form{'no_update_last_known'}=1;
1185:
1.23 www 1186: if (%form) {
1187: $request=new HTTP::Request('POST',"http://".$ENV{'HTTP_HOST'}.$fn);
1.201 albertel 1188: $request->content(join('&',map { &escape($_).'='.&escape($form{$_}) } keys %form));
1.23 www 1189: } else {
1190: $request=new HTTP::Request('GET',"http://".$ENV{'HTTP_HOST'}.$fn);
1191: }
1192:
1.15 www 1193: $request->header(Cookie => $ENV{'HTTP_COOKIE'});
1194: my $response=$ua->request($request);
1195:
1.324 www 1196: return $response->content;
1197: }
1198:
1199: sub externalssi {
1200: my ($url)=@_;
1201: my $ua=new LWP::UserAgent;
1202: my $request=new HTTP::Request('GET',$url);
1203: my $response=$ua->request($request);
1.15 www 1204: return $response->content;
1205: }
1.254 www 1206:
1.492 albertel 1207: # -------------------------------- Allow a /uploaded/ URI to be vouched for
1208:
1209: sub allowuploaded {
1210: my ($srcurl,$url)=@_;
1211: $url=&clutter(&declutter($url));
1212: my $dir=$url;
1213: $dir=~s/\/[^\/]+$//;
1214: my %httpref=();
1215: my $httpurl=&hreflocation('',$url);
1216: $httpref{'httpref.'.$httpurl}=$srcurl;
1217: &Apache::lonnet::appenv(%httpref);
1.254 www 1218: }
1.477 raeburn 1219:
1.478 albertel 1220: # --------- File operations in /home/httpd/html/userfiles/$domain/1/2/3/$course
1.638 albertel 1221: # input: action, courseID, current domain, intended
1.637 raeburn 1222: # path to file, source of file, instruction to parse file for objects,
1223: # ref to hash for embedded objects,
1224: # ref to hash for codebase of java objects.
1225: #
1.485 raeburn 1226: # output: url to file (if action was uploaddoc),
1227: # ok if successful, or diagnostic message otherwise (if action was propagate or copy)
1.477 raeburn 1228: #
1.478 albertel 1229: # Allows directory structure to be used within lonUsers/../userfiles/ for a
1230: # course.
1.477 raeburn 1231: #
1.478 albertel 1232: # action = propagate - /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
1233: # will be copied to /home/httpd/lonUsers/1/2/3/$course/userfiles in
1234: # course's home server.
1.477 raeburn 1235: #
1.478 albertel 1236: # action = copy - /home/httpd/html/userfiles/$domain/1/2/3/$course/$file will
1237: # be copied from $source (current location) to
1238: # /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
1239: # and will then be copied to
1240: # /home/httpd/lonUsers/$domain/1/2/3/$course/userfiles/$file in
1241: # course's home server.
1.485 raeburn 1242: #
1.481 raeburn 1243: # action = uploaddoc - /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
1.620 albertel 1244: # will be retrived from $env{form.uploaddoc} (from DOCS interface) to
1.481 raeburn 1245: # /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
1246: # and will then be copied to /home/httpd/lonUsers/1/2/3/$course/userfiles/$file
1247: # in course's home server.
1.637 raeburn 1248: #
1.477 raeburn 1249:
1250: sub process_coursefile {
1.638 albertel 1251: my ($action,$docuname,$docudom,$file,$source,$parser,$allfiles,$codebase)=@_;
1.477 raeburn 1252: my $fetchresult;
1.638 albertel 1253: my $home=&homeserver($docuname,$docudom);
1.477 raeburn 1254: if ($action eq 'propagate') {
1.638 albertel 1255: $fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
1256: $home);
1.481 raeburn 1257: } else {
1.477 raeburn 1258: my $fpath = '';
1259: my $fname = $file;
1.478 albertel 1260: ($fpath,$fname) = ($file =~ m|^(.*)/([^/]+)$|);
1.477 raeburn 1261: $fpath=$docudom.'/'.$docuname.'/'.$fpath;
1.637 raeburn 1262: my $filepath = &build_filepath($fpath);
1.481 raeburn 1263: if ($action eq 'copy') {
1264: if ($source eq '') {
1265: $fetchresult = 'no source file';
1266: return $fetchresult;
1267: } else {
1268: my $destination = $filepath.'/'.$fname;
1269: rename($source,$destination);
1270: $fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
1.638 albertel 1271: $home);
1.481 raeburn 1272: }
1273: } elsif ($action eq 'uploaddoc') {
1274: open(my $fh,'>'.$filepath.'/'.$fname);
1.620 albertel 1275: print $fh $env{'form.'.$source};
1.481 raeburn 1276: close($fh);
1.637 raeburn 1277: if ($parser eq 'parse') {
1278: my $parse_result = &extract_embedded_items($filepath,$fname,$allfiles,$codebase);
1279: unless ($parse_result eq 'ok') {
1280: &logthis('Failed to parse '.$filepath.'/'.$fname.' for embedded media: '.$parse_result);
1281: }
1282: }
1.477 raeburn 1283: $fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
1.638 albertel 1284: $home);
1.481 raeburn 1285: if ($fetchresult eq 'ok') {
1286: return '/uploaded/'.$fpath.'/'.$fname;
1287: } else {
1288: &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$file.
1.638 albertel 1289: ' to host '.$home.': '.$fetchresult);
1.481 raeburn 1290: return '/adm/notfound.html';
1291: }
1.477 raeburn 1292: }
1293: }
1.485 raeburn 1294: unless ( $fetchresult eq 'ok') {
1.477 raeburn 1295: &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$file.
1.638 albertel 1296: ' to host '.$home.': '.$fetchresult);
1.477 raeburn 1297: }
1298: return $fetchresult;
1299: }
1300:
1.637 raeburn 1301: sub build_filepath {
1302: my ($fpath) = @_;
1303: my $filepath=$perlvar{'lonDocRoot'}.'/userfiles';
1304: unless ($fpath eq '') {
1305: my @parts=split('/',$fpath);
1306: foreach my $part (@parts) {
1307: $filepath.= '/'.$part;
1308: if ((-e $filepath)!=1) {
1309: mkdir($filepath,0777);
1310: }
1311: }
1312: }
1313: return $filepath;
1314: }
1315:
1316: sub store_edited_file {
1.638 albertel 1317: my ($primary_url,$content,$docudom,$docuname,$fetchresult) = @_;
1.637 raeburn 1318: my $file = $primary_url;
1319: $file =~ s#^/uploaded/$docudom/$docuname/##;
1320: my $fpath = '';
1321: my $fname = $file;
1322: ($fpath,$fname) = ($file =~ m|^(.*)/([^/]+)$|);
1323: $fpath=$docudom.'/'.$docuname.'/'.$fpath;
1324: my $filepath = &build_filepath($fpath);
1325: open(my $fh,'>'.$filepath.'/'.$fname);
1326: print $fh $content;
1327: close($fh);
1.638 albertel 1328: my $home=&homeserver($docuname,$docudom);
1.637 raeburn 1329: $$fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
1.638 albertel 1330: $home);
1.637 raeburn 1331: if ($$fetchresult eq 'ok') {
1332: return '/uploaded/'.$fpath.'/'.$fname;
1333: } else {
1.638 albertel 1334: &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$file.
1335: ' to host '.$home.': '.$$fetchresult);
1.637 raeburn 1336: return '/adm/notfound.html';
1337: }
1338: }
1339:
1.531 albertel 1340: sub clean_filename {
1341: my ($fname)=@_;
1.315 www 1342: # Replace Windows backslashes by forward slashes
1.257 www 1343: $fname=~s/\\/\//g;
1.315 www 1344: # Get rid of everything but the actual filename
1.257 www 1345: $fname=~s/^.*\/([^\/]+)$/$1/;
1.315 www 1346: # Replace spaces by underscores
1347: $fname=~s/\s+/\_/g;
1348: # Replace all other weird characters by nothing
1.317 www 1349: $fname=~s/[^\w\.\-]//g;
1.540 albertel 1350: # Replace all .\d. sequences with _\d. so they no longer look like version
1351: # numbers
1352: $fname=~s/\.(\d+)(?=\.)/_$1/g;
1.531 albertel 1353: return $fname;
1354: }
1355:
1.608 albertel 1356: # --------------- Take an uploaded file and put it into the userfiles directory
1.686 albertel 1357: # input: $formname - the contents of the file are in $env{"form.$formname"}
1.719 banghart 1358: # the desired filenam is in $env{"form.$formname.filename"}
1.686 albertel 1359: # $coursedoc - if true up to the current course
1360: # if false
1361: # $subdir - directory in userfile to store the file into
1362: # $parser, $allfiles, $codebase - unknown
1363: #
1364: # output: url of file in userspace, or error: <message>
1365: # or /adm/notfound.html if failure to upload occurse
1.608 albertel 1366:
1367:
1.531 albertel 1368: sub userfileupload {
1.719 banghart 1369: my ($formname,$coursedoc,$subdir,$parser,$allfiles,$codebase,$destuname,$destudom)=@_;
1.531 albertel 1370: if (!defined($subdir)) { $subdir='unknown'; }
1.620 albertel 1371: my $fname=$env{'form.'.$formname.'.filename'};
1.531 albertel 1372: $fname=&clean_filename($fname);
1.315 www 1373: # See if there is anything left
1.257 www 1374: unless ($fname) { return 'error: no uploaded file'; }
1.620 albertel 1375: chop($env{'form.'.$formname});
1.523 raeburn 1376: if (($formname eq 'screenshot') && ($subdir eq 'helprequests')) { #files uploaded to help request form are handled differently
1377: my $now = time;
1378: my $filepath = 'tmp/helprequests/'.$now;
1379: my @parts=split(/\//,$filepath);
1380: my $fullpath = $perlvar{'lonDaemons'};
1381: for (my $i=0;$i<@parts;$i++) {
1382: $fullpath .= '/'.$parts[$i];
1383: if ((-e $fullpath)!=1) {
1384: mkdir($fullpath,0777);
1385: }
1386: }
1387: open(my $fh,'>'.$fullpath.'/'.$fname);
1.620 albertel 1388: print $fh $env{'form.'.$formname};
1.523 raeburn 1389: close($fh);
1.741 raeburn 1390: return $fullpath.'/'.$fname;
1391: } elsif (($formname eq 'coursecreatorxml') && ($subdir eq 'batchupload')) { #files uploaded to create course page are handled differently
1392: my $filepath = 'tmp/addcourse/'.$destudom.'/web/'.$env{'user.name'}.
1393: '_'.$env{'user.domain'}.'/pending';
1394: my @parts=split(/\//,$filepath);
1395: my $fullpath = $perlvar{'lonDaemons'};
1396: for (my $i=0;$i<@parts;$i++) {
1397: $fullpath .= '/'.$parts[$i];
1398: if ((-e $fullpath)!=1) {
1399: mkdir($fullpath,0777);
1400: }
1401: }
1402: open(my $fh,'>'.$fullpath.'/'.$fname);
1403: print $fh $env{'form.'.$formname};
1404: close($fh);
1405: return $fullpath.'/'.$fname;
1.523 raeburn 1406: }
1.719 banghart 1407:
1.258 www 1408: # Create the directory if not present
1.493 albertel 1409: $fname="$subdir/$fname";
1.259 www 1410: if ($coursedoc) {
1.638 albertel 1411: my $docuname=$env{'course.'.$env{'request.course.id'}.'.num'};
1412: my $docudom=$env{'course.'.$env{'request.course.id'}.'.domain'};
1.646 raeburn 1413: if ($env{'form.folder'} =~ m/^(default|supplemental)/) {
1.638 albertel 1414: return &finishuserfileupload($docuname,$docudom,
1415: $formname,$fname,$parser,$allfiles,
1416: $codebase);
1.481 raeburn 1417: } else {
1.620 albertel 1418: $fname=$env{'form.folder'}.'/'.$fname;
1.638 albertel 1419: return &process_coursefile('uploaddoc',$docuname,$docudom,
1420: $fname,$formname,$parser,
1421: $allfiles,$codebase);
1.481 raeburn 1422: }
1.719 banghart 1423: } elsif (defined($destuname)) {
1424: my $docuname=$destuname;
1425: my $docudom=$destudom;
1426: return &finishuserfileupload($docuname,$docudom,$formname,
1427: $fname,$parser,$allfiles,$codebase);
1428:
1.259 www 1429: } else {
1.638 albertel 1430: my $docuname=$env{'user.name'};
1431: my $docudom=$env{'user.domain'};
1.714 raeburn 1432: if (exists($env{'form.group'})) {
1433: $docuname=$env{'course.'.$env{'request.course.id'}.'.num'};
1434: $docudom=$env{'course.'.$env{'request.course.id'}.'.domain'};
1435: }
1.638 albertel 1436: return &finishuserfileupload($docuname,$docudom,$formname,
1437: $fname,$parser,$allfiles,$codebase);
1.259 www 1438: }
1.271 www 1439: }
1440:
1441: sub finishuserfileupload {
1.638 albertel 1442: my ($docuname,$docudom,$formname,$fname,$parser,$allfiles,$codebase) = @_;
1.477 raeburn 1443: my $path=$docudom.'/'.$docuname.'/';
1.258 www 1444: my $filepath=$perlvar{'lonDocRoot'};
1.494 albertel 1445: my ($fnamepath,$file);
1446: $file=$fname;
1447: if ($fname=~m|/|) {
1448: ($fnamepath,$file) = ($fname =~ m|^(.*)/([^/]+)$|);
1449: $path.=$fnamepath.'/';
1450: }
1.259 www 1451: my @parts=split(/\//,$filepath.'/userfiles/'.$path);
1.258 www 1452: my $count;
1453: for ($count=4;$count<=$#parts;$count++) {
1454: $filepath.="/$parts[$count]";
1455: if ((-e $filepath)!=1) {
1456: mkdir($filepath,0777);
1457: }
1458: }
1459: # Save the file
1460: {
1.701 albertel 1461: if (!open(FH,'>'.$filepath.'/'.$file)) {
1462: &logthis('Failed to create '.$filepath.'/'.$file);
1463: print STDERR ('Failed to create '.$filepath.'/'.$file."\n");
1464: return '/adm/notfound.html';
1465: }
1466: if (!print FH ($env{'form.'.$formname})) {
1467: &logthis('Failed to write to '.$filepath.'/'.$file);
1468: print STDERR ('Failed to write to '.$filepath.'/'.$file."\n");
1469: return '/adm/notfound.html';
1470: }
1.570 albertel 1471: close(FH);
1.258 www 1472: }
1.637 raeburn 1473: if ($parser eq 'parse') {
1.638 albertel 1474: my $parse_result = &extract_embedded_items($filepath,$file,$allfiles,
1475: $codebase);
1.637 raeburn 1476: unless ($parse_result eq 'ok') {
1.638 albertel 1477: &logthis('Failed to parse '.$filepath.$file.
1478: ' for embedded media: '.$parse_result);
1.637 raeburn 1479: }
1480: }
1.259 www 1481: # Notify homeserver to grep it
1482: #
1.638 albertel 1483: my $docuhome=&homeserver($docuname,$docudom);
1.494 albertel 1484: my $fetchresult= &reply('fetchuserfile:'.$path.$file,$docuhome);
1.295 www 1485: if ($fetchresult eq 'ok') {
1.259 www 1486: #
1.258 www 1487: # Return the URL to it
1.494 albertel 1488: return '/uploaded/'.$path.$file;
1.263 www 1489: } else {
1.494 albertel 1490: &logthis('Failed to transfer '.$path.$file.' to host '.$docuhome.
1491: ': '.$fetchresult);
1.263 www 1492: return '/adm/notfound.html';
1493: }
1.493 albertel 1494: }
1495:
1.637 raeburn 1496: sub extract_embedded_items {
1.648 raeburn 1497: my ($filepath,$file,$allfiles,$codebase,$content) = @_;
1.637 raeburn 1498: my @state = ();
1499: my %javafiles = (
1500: codebase => '',
1501: code => '',
1502: archive => ''
1503: );
1504: my %mediafiles = (
1505: src => '',
1506: movie => '',
1507: );
1.648 raeburn 1508: my $p;
1509: if ($content) {
1510: $p = HTML::LCParser->new($content);
1511: } else {
1512: $p = HTML::LCParser->new($filepath.'/'.$file);
1513: }
1.641 albertel 1514: while (my $t=$p->get_token()) {
1.640 albertel 1515: if ($t->[0] eq 'S') {
1516: my ($tagname, $attr) = ($t->[1],$t->[2]);
1517: push (@state, $tagname);
1.648 raeburn 1518: if (lc($tagname) eq 'allow') {
1519: &add_filetype($allfiles,$attr->{'src'},'src');
1520: }
1.640 albertel 1521: if (lc($tagname) eq 'img') {
1522: &add_filetype($allfiles,$attr->{'src'},'src');
1523: }
1.645 raeburn 1524: if (lc($tagname) eq 'script') {
1525: if ($attr->{'archive'} =~ /\.jar$/i) {
1526: &add_filetype($allfiles,$attr->{'archive'},'archive');
1527: } else {
1528: &add_filetype($allfiles,$attr->{'src'},'src');
1529: }
1530: }
1531: if (lc($tagname) eq 'link') {
1532: if (lc($attr->{'rel'}) eq 'stylesheet') {
1533: &add_filetype($allfiles,$attr->{'href'},'href');
1534: }
1535: }
1.640 albertel 1536: if (lc($tagname) eq 'object' ||
1537: (lc($tagname) eq 'embed' && lc($state[-2]) ne 'object')) {
1538: foreach my $item (keys(%javafiles)) {
1539: $javafiles{$item} = '';
1540: }
1541: }
1542: if (lc($state[-2]) eq 'object' && lc($tagname) eq 'param') {
1543: my $name = lc($attr->{'name'});
1544: foreach my $item (keys(%javafiles)) {
1545: if ($name eq $item) {
1546: $javafiles{$item} = $attr->{'value'};
1547: last;
1548: }
1549: }
1550: foreach my $item (keys(%mediafiles)) {
1551: if ($name eq $item) {
1552: &add_filetype($allfiles, $attr->{'value'}, 'value');
1553: last;
1554: }
1555: }
1556: }
1557: if (lc($tagname) eq 'embed' || lc($tagname) eq 'applet') {
1558: foreach my $item (keys(%javafiles)) {
1559: if ($attr->{$item}) {
1560: $javafiles{$item} = $attr->{$item};
1561: last;
1562: }
1563: }
1564: foreach my $item (keys(%mediafiles)) {
1565: if ($attr->{$item}) {
1566: &add_filetype($allfiles,$attr->{$item},$item);
1567: last;
1568: }
1569: }
1570: }
1571: } elsif ($t->[0] eq 'E') {
1572: my ($tagname) = ($t->[1]);
1573: if ($javafiles{'codebase'} ne '') {
1574: $javafiles{'codebase'} .= '/';
1575: }
1576: if (lc($tagname) eq 'applet' ||
1577: lc($tagname) eq 'object' ||
1578: (lc($tagname) eq 'embed' && lc($state[-2]) ne 'object')
1579: ) {
1580: foreach my $item (keys(%javafiles)) {
1581: if ($item ne 'codebase' && $javafiles{$item} ne '') {
1582: my $file=$javafiles{'codebase'}.$javafiles{$item};
1583: &add_filetype($allfiles,$file,$item);
1584: }
1585: }
1586: }
1587: pop @state;
1588: }
1589: }
1.637 raeburn 1590: return 'ok';
1591: }
1592:
1.639 albertel 1593: sub add_filetype {
1594: my ($allfiles,$file,$type)=@_;
1595: if (exists($allfiles->{$file})) {
1596: unless (grep/^\Q$type\E$/, @{$allfiles->{$file}}) {
1597: push(@{$allfiles->{$file}}, &escape($type));
1598: }
1599: } else {
1600: @{$allfiles->{$file}} = (&escape($type));
1.637 raeburn 1601: }
1602: }
1603:
1.493 albertel 1604: sub removeuploadedurl {
1605: my ($url)=@_;
1606: my (undef,undef,$udom,$uname,$fname)=split('/',$url,5);
1.613 albertel 1607: return &removeuserfile($uname,$udom,$fname);
1.490 albertel 1608: }
1609:
1610: sub removeuserfile {
1611: my ($docuname,$docudom,$fname)=@_;
1612: my $home=&homeserver($docuname,$docudom);
1613: return &reply("removeuserfile:$docudom/$docuname/$fname",$home);
1.257 www 1614: }
1.15 www 1615:
1.530 albertel 1616: sub mkdiruserfile {
1617: my ($docuname,$docudom,$dir)=@_;
1618: my $home=&homeserver($docuname,$docudom);
1619: return &reply("mkdiruserfile:".&escape("$docudom/$docuname/$dir"),$home);
1620: }
1621:
1.531 albertel 1622: sub renameuserfile {
1623: my ($docuname,$docudom,$old,$new)=@_;
1624: my $home=&homeserver($docuname,$docudom);
1625: return &reply("renameuserfile:$docudom:$docuname:".&escape("$old").':'.
1626: &escape("$new"),$home);
1627: }
1628:
1.14 www 1629: # ------------------------------------------------------------------------- Log
1630:
1631: sub log {
1632: my ($dom,$nam,$hom,$what)=@_;
1.47 www 1633: return critical("log:$dom:$nam:$what",$hom);
1.157 www 1634: }
1635:
1636: # ------------------------------------------------------------------ Course Log
1.352 www 1637: #
1638: # This routine flushes several buffers of non-mission-critical nature
1639: #
1.157 www 1640:
1641: sub flushcourselogs {
1.352 www 1642: &logthis('Flushing log buffers');
1643: #
1644: # course logs
1645: # This is a log of all transactions in a course, which can be used
1646: # for data mining purposes
1647: #
1648: # It also collects the courseid database, which lists last transaction
1649: # times and course titles for all courseids
1650: #
1651: my %courseidbuffer=();
1.191 harris41 1652: foreach (keys %courselogs) {
1.157 www 1653: my $crsid=$_;
1.352 www 1654: if (&reply('log:'.$coursedombuf{$crsid}.':'.$coursenumbuf{$crsid}.':'.
1.188 www 1655: &escape($courselogs{$crsid}),
1656: $coursehombuf{$crsid}) eq 'ok') {
1.157 www 1657: delete $courselogs{$crsid};
1658: } else {
1659: &logthis('Failed to flush log buffer for '.$crsid);
1660: if (length($courselogs{$crsid})>40000) {
1.672 albertel 1661: &logthis("<font color=\"blue\">WARNING: Buffer for ".$crsid.
1.157 www 1662: " exceeded maximum size, deleting.</font>");
1663: delete $courselogs{$crsid};
1664: }
1.352 www 1665: }
1666: if ($courseidbuffer{$coursehombuf{$crsid}}) {
1667: $courseidbuffer{$coursehombuf{$crsid}}.='&'.
1.516 raeburn 1668: &escape($crsid).'='.&escape($coursedescrbuf{$crsid}).
1.741 raeburn 1669: ':'.&escape($courseinstcodebuf{$crsid}).':'.&escape($courseownerbuf{$crsid}).':'.&escape($coursetypebuf{$crsid});
1.352 www 1670: } else {
1671: $courseidbuffer{$coursehombuf{$crsid}}=
1.516 raeburn 1672: &escape($crsid).'='.&escape($coursedescrbuf{$crsid}).
1.741 raeburn 1673: ':'.&escape($courseinstcodebuf{$crsid}).':'.&escape($courseownerbuf{$crsid}).':'.&escape($coursetypebuf{$crsid});
1.571 raeburn 1674: }
1.191 harris41 1675: }
1.352 www 1676: #
1677: # Write course id database (reverse lookup) to homeserver of courses
1678: # Is used in pickcourse
1679: #
1680: foreach (keys %courseidbuffer) {
1.353 www 1681: &courseidput($hostdom{$_},$courseidbuffer{$_},$_);
1.352 www 1682: }
1683: #
1684: # File accesses
1685: # Writes to the dynamic metadata of resources to get hit counts, etc.
1686: #
1.449 matthew 1687: foreach my $entry (keys(%accesshash)) {
1.458 matthew 1688: if ($entry =~ /___count$/) {
1689: my ($dom,$name);
1690: ($dom,$name,undef)=($entry=~m:___(\w+)/(\w+)/(.*)___count$:);
1691: if (! defined($dom) || $dom eq '' ||
1692: ! defined($name) || $name eq '') {
1.620 albertel 1693: my $cid = $env{'request.course.id'};
1694: $dom = $env{'request.'.$cid.'.domain'};
1695: $name = $env{'request.'.$cid.'.num'};
1.458 matthew 1696: }
1.450 matthew 1697: my $value = $accesshash{$entry};
1698: my (undef,$url,undef) = ($entry =~ /^(.*)___(.*)___count$/);
1699: my %temphash=($url => $value);
1.449 matthew 1700: my $result = &inc('nohist_accesscount',\%temphash,$dom,$name);
1701: if ($result eq 'ok') {
1702: delete $accesshash{$entry};
1703: } elsif ($result eq 'unknown_cmd') {
1704: # Target server has old code running on it.
1.450 matthew 1705: my %temphash=($entry => $value);
1.449 matthew 1706: if (&put('nohist_resevaldata',\%temphash,$dom,$name) eq 'ok') {
1707: delete $accesshash{$entry};
1708: }
1709: }
1710: } else {
1.458 matthew 1711: my ($dom,$name) = ($entry=~m:___(\w+)/(\w+)/(.*)___(\w+)$:);
1.450 matthew 1712: my %temphash=($entry => $accesshash{$entry});
1.449 matthew 1713: if (&put('nohist_resevaldata',\%temphash,$dom,$name) eq 'ok') {
1714: delete $accesshash{$entry};
1715: }
1.185 www 1716: }
1.191 harris41 1717: }
1.352 www 1718: #
1719: # Roles
1720: # Reverse lookup of user roles for course faculty/staff and co-authorship
1721: #
1.349 www 1722: foreach (keys %userrolehash) {
1723: my $entry=$_;
1.351 www 1724: my ($role,$uname,$udom,$runame,$rudom,$rsec)=
1.349 www 1725: split(/\:/,$entry);
1726: if (&Apache::lonnet::put('nohist_userroles',
1.351 www 1727: { $role.':'.$uname.':'.$udom.':'.$rsec => $userrolehash{$entry} },
1.349 www 1728: $rudom,$runame) eq 'ok') {
1729: delete $userrolehash{$entry};
1730: }
1731: }
1.662 raeburn 1732: #
1733: # Reverse lookup of domain roles (dc, ad, li, sc, au)
1734: #
1735: my %domrolebuffer = ();
1736: foreach my $entry (keys %domainrolehash) {
1737: my ($role,$uname,$udom,$runame,$rudom,$rsec)=split/:/,$entry;
1738: if ($domrolebuffer{$rudom}) {
1739: $domrolebuffer{$rudom}.='&'.&escape($entry).
1740: '='.&escape($domainrolehash{$entry});
1741: } else {
1742: $domrolebuffer{$rudom}.=&escape($entry).
1743: '='.&escape($domainrolehash{$entry});
1744: }
1745: delete $domainrolehash{$entry};
1746: }
1747: foreach my $dom (keys(%domrolebuffer)) {
1748: foreach my $tryserver (keys %libserv) {
1749: if ($hostdom{$tryserver} eq $dom) {
1750: unless (&reply('domroleput:'.$dom.':'.
1751: $domrolebuffer{$dom},$tryserver) eq 'ok') {
1752: &logthis('Put of domain roles failed for '.$dom.' and '.$tryserver);
1753: }
1754: }
1755: }
1756: }
1.186 www 1757: $dumpcount++;
1.157 www 1758: }
1759:
1760: sub courselog {
1761: my $what=shift;
1.158 www 1762: $what=time.':'.$what;
1.620 albertel 1763: unless ($env{'request.course.id'}) { return ''; }
1764: $coursedombuf{$env{'request.course.id'}}=
1765: $env{'course.'.$env{'request.course.id'}.'.domain'};
1766: $coursenumbuf{$env{'request.course.id'}}=
1767: $env{'course.'.$env{'request.course.id'}.'.num'};
1768: $coursehombuf{$env{'request.course.id'}}=
1769: $env{'course.'.$env{'request.course.id'}.'.home'};
1770: $coursedescrbuf{$env{'request.course.id'}}=
1771: $env{'course.'.$env{'request.course.id'}.'.description'};
1772: $courseinstcodebuf{$env{'request.course.id'}}=
1773: $env{'course.'.$env{'request.course.id'}.'.internal.coursecode'};
1774: $courseownerbuf{$env{'request.course.id'}}=
1775: $env{'course.'.$env{'request.course.id'}.'.internal.courseowner'};
1.741 raeburn 1776: $coursetypebuf{$env{'request.course.id'}}=
1777: $env{'course.'.$env{'request.course.id'}.'.type'};
1.620 albertel 1778: if (defined $courselogs{$env{'request.course.id'}}) {
1779: $courselogs{$env{'request.course.id'}}.='&'.$what;
1.157 www 1780: } else {
1.620 albertel 1781: $courselogs{$env{'request.course.id'}}.=$what;
1.157 www 1782: }
1.620 albertel 1783: if (length($courselogs{$env{'request.course.id'}})>4048) {
1.157 www 1784: &flushcourselogs();
1785: }
1.158 www 1786: }
1787:
1788: sub courseacclog {
1789: my $fnsymb=shift;
1.620 albertel 1790: unless ($env{'request.course.id'}) { return ''; }
1791: my $what=$fnsymb.':'.$env{'user.name'}.':'.$env{'user.domain'};
1.657 albertel 1792: if ($fnsymb=~/(problem|exam|quiz|assess|survey|form|task|page)$/) {
1.187 www 1793: $what.=':POST';
1.583 matthew 1794: # FIXME: Probably ought to escape things....
1.620 albertel 1795: foreach (keys %env) {
1.158 www 1796: if ($_=~/^form\.(.*)/) {
1.620 albertel 1797: $what.=':'.$1.'='.$env{$_};
1.158 www 1798: }
1.191 harris41 1799: }
1.583 matthew 1800: } elsif ($fnsymb =~ m:^/adm/searchcat:) {
1801: # FIXME: We should not be depending on a form parameter that someone
1802: # editing lonsearchcat.pm might change in the future.
1.620 albertel 1803: if ($env{'form.phase'} eq 'course_search') {
1.583 matthew 1804: $what.= ':POST';
1805: # FIXME: Probably ought to escape things....
1806: foreach my $element ('courseexp','crsfulltext','crsrelated',
1807: 'crsdiscuss') {
1.620 albertel 1808: $what.=':'.$element.'='.$env{'form.'.$element};
1.583 matthew 1809: }
1810: }
1.158 www 1811: }
1812: &courselog($what);
1.149 www 1813: }
1814:
1.185 www 1815: sub countacc {
1816: my $url=&declutter(shift);
1.458 matthew 1817: return if (! defined($url) || $url eq '');
1.620 albertel 1818: unless ($env{'request.course.id'}) { return ''; }
1819: $accesshash{$env{'request.course.id'}.'___'.$url.'___course'}=1;
1.281 www 1820: my $key=$$.$processmarker.'_'.$dumpcount.'___'.$url.'___count';
1.450 matthew 1821: $accesshash{$key}++;
1.185 www 1822: }
1.349 www 1823:
1.361 www 1824: sub linklog {
1825: my ($from,$to)=@_;
1826: $from=&declutter($from);
1827: $to=&declutter($to);
1828: $accesshash{$from.'___'.$to.'___comefrom'}=1;
1829: $accesshash{$to.'___'.$from.'___goto'}=1;
1830: }
1831:
1.349 www 1832: sub userrolelog {
1833: my ($trole,$username,$domain,$area,$tstart,$tend)=@_;
1.661 raeburn 1834: if (($trole=~/^ca/) || ($trole=~/^aa/) ||
1.662 raeburn 1835: ($trole=~/^in/) || ($trole=~/^cc/) ||
1.661 raeburn 1836: ($trole=~/^ep/) || ($trole=~/^cr/) ||
1837: ($trole=~/^ta/)) {
1.350 www 1838: my (undef,$rudom,$runame,$rsec)=split(/\//,$area);
1839: $userrolehash
1840: {$trole.':'.$username.':'.$domain.':'.$runame.':'.$rudom.':'.$rsec}
1.349 www 1841: =$tend.':'.$tstart;
1.662 raeburn 1842: }
1843: if (($trole=~/^dc/) || ($trole=~/^ad/) ||
1844: ($trole=~/^li/) || ($trole=~/^li/) ||
1845: ($trole=~/^au/) || ($trole=~/^dg/) ||
1846: ($trole=~/^sc/)) {
1847: my (undef,$rudom,$runame,$rsec)=split(/\//,$area);
1848: $domainrolehash
1849: {$trole.':'.$username.':'.$domain.':'.$runame.':'.$rudom.':'.$rsec}
1850: = $tend.':'.$tstart;
1851: }
1.351 www 1852: }
1853:
1854: sub get_course_adv_roles {
1855: my $cid=shift;
1.620 albertel 1856: $cid=$env{'request.course.id'} unless (defined($cid));
1.351 www 1857: my %coursehash=&coursedescription($cid);
1.470 www 1858: my %nothide=();
1859: foreach (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
1860: $nothide{join(':',split(/[\@\:]/,$_))}=1;
1861: }
1.351 www 1862: my %returnhash=();
1863: my %dumphash=
1864: &dump('nohist_userroles',$coursehash{'domain'},$coursehash{'num'});
1865: my $now=time;
1866: foreach (keys %dumphash) {
1867: my ($tend,$tstart)=split(/\:/,$dumphash{$_});
1868: if (($tstart) && ($tstart<0)) { next; }
1869: if (($tend) && ($tend<$now)) { next; }
1870: if (($tstart) && ($now<$tstart)) { next; }
1871: my ($role,$username,$domain,$section)=split(/\:/,$_);
1.576 albertel 1872: if ($username eq '' || $domain eq '') { next; }
1.470 www 1873: if ((&privileged($username,$domain)) &&
1874: (!$nothide{$username.':'.$domain})) { next; }
1.656 albertel 1875: if ($role eq 'cr') { next; }
1.351 www 1876: my $key=&plaintext($role);
1.656 albertel 1877: if ($role =~ /^cr/) {
1878: $key=(split('/',$role))[3];
1879: }
1.351 www 1880: if ($section) { $key.=' (Sec/Grp '.$section.')'; }
1881: if ($returnhash{$key}) {
1882: $returnhash{$key}.=','.$username.':'.$domain;
1883: } else {
1884: $returnhash{$key}=$username.':'.$domain;
1885: }
1.400 www 1886: }
1887: return %returnhash;
1888: }
1889:
1890: sub get_my_roles {
1891: my ($uname,$udom)=@_;
1.620 albertel 1892: unless (defined($uname)) { $uname=$env{'user.name'}; }
1893: unless (defined($udom)) { $udom=$env{'user.domain'}; }
1.400 www 1894: my %dumphash=
1895: &dump('nohist_userroles',$udom,$uname);
1896: my %returnhash=();
1897: my $now=time;
1898: foreach (keys %dumphash) {
1899: my ($tend,$tstart)=split(/\:/,$dumphash{$_});
1900: if (($tstart) && ($tstart<0)) { next; }
1901: if (($tend) && ($tend<$now)) { next; }
1902: if (($tstart) && ($now<$tstart)) { next; }
1903: my ($role,$username,$domain,$section)=split(/\:/,$_);
1904: $returnhash{$username.':'.$domain.':'.$role}=$tstart.':'.$tend;
1.373 www 1905: }
1906: return %returnhash;
1.399 www 1907: }
1908:
1909: # ----------------------------------------------------- Frontpage Announcements
1910: #
1911: #
1912:
1913: sub postannounce {
1914: my ($server,$text)=@_;
1915: unless (&allowed('psa',$hostdom{$server})) { return 'refused'; }
1916: unless ($text=~/\w/) { $text=''; }
1917: return &reply('setannounce:'.&escape($text),$server);
1918: }
1919:
1920: sub getannounce {
1.448 albertel 1921:
1922: if (open(my $fh,$perlvar{'lonDocRoot'}.'/announcement.txt')) {
1.399 www 1923: my $announcement='';
1924: while (<$fh>) { $announcement .=$_; }
1.448 albertel 1925: close($fh);
1.399 www 1926: if ($announcement=~/\w/) {
1927: return
1928: '<table bgcolor="#FF5555" cellpadding="5" cellspacing="3">'.
1.518 albertel 1929: '<tr><td bgcolor="#FFFFFF"><tt>'.$announcement.'</tt></td></tr></table>';
1.399 www 1930: } else {
1931: return '';
1932: }
1933: } else {
1934: return '';
1935: }
1.351 www 1936: }
1.353 www 1937:
1938: # ---------------------------------------------------------- Course ID routines
1939: # Deal with domain's nohist_courseid.db files
1940: #
1941:
1942: sub courseidput {
1943: my ($domain,$what,$coursehome)=@_;
1944: return &reply('courseidput:'.$domain.':'.$what,$coursehome);
1945: }
1946:
1947: sub courseiddump {
1.741 raeburn 1948: my ($domfilter,$descfilter,$sincefilter,$instcodefilter,$ownerfilter,$coursefilter,$hostidflag,$hostidref,$typefilter)=@_;
1.353 www 1949: my %returnhash=();
1.355 www 1950: unless ($domfilter) { $domfilter=''; }
1.353 www 1951: foreach my $tryserver (keys %libserv) {
1.511 raeburn 1952: if ( ($hostidflag == 1 && grep/^$tryserver$/,@{$hostidref}) || (!defined($hostidflag)) ) {
1.506 raeburn 1953: if ((!$domfilter) || ($hostdom{$tryserver} eq $domfilter)) {
1954: foreach (
1955: split(/\&/,&reply('courseiddump:'.$hostdom{$tryserver}.':'.
1.571 raeburn 1956: $sincefilter.':'.&escape($descfilter).':'.
1.741 raeburn 1957: &escape($instcodefilter).':'.&escape($ownerfilter).':'.&escape($coursefilter).':'.&escape($typefilter),
1.354 www 1958: $tryserver))) {
1.506 raeburn 1959: my ($key,$value)=split(/\=/,$_);
1960: if (($key) && ($value)) {
1.516 raeburn 1961: $returnhash{&unescape($key)}=$value;
1.506 raeburn 1962: }
1.353 www 1963: }
1964: }
1965: }
1966: }
1967: return %returnhash;
1968: }
1969:
1.658 raeburn 1970: # ---------------------------------------------------------- DC e-mail
1.662 raeburn 1971:
1972: sub dcmailput {
1.685 raeburn 1973: my ($domain,$msgid,$message,$server)=@_;
1.662 raeburn 1974: my $status = &Apache::lonnet::critical(
1.740 www 1975: 'dcmailput:'.$domain.':'.&escape($msgid).'='.
1976: &escape($message),$server);
1.662 raeburn 1977: return $status;
1978: }
1979:
1.658 raeburn 1980: sub dcmaildump {
1981: my ($dom,$startdate,$enddate,$senders) = @_;
1.685 raeburn 1982: my %returnhash=();
1983: if (exists($domain_primary{$dom})) {
1984: my $cmd='dcmaildump:'.$dom.':'.&escape($startdate).':'.
1985: &escape($enddate).':';
1986: my @esc_senders=map { &escape($_)} @$senders;
1987: $cmd.=&escape(join('&',@esc_senders));
1988: foreach (split(/\&/,&reply($cmd,$domain_primary{$dom}))) {
1989: my ($key,$value) = split(/\=/,$_);
1990: if (($key) && ($value)) {
1991: $returnhash{&unescape($key)} = &unescape($value);
1.658 raeburn 1992: }
1993: }
1994: }
1995: return %returnhash;
1996: }
1.662 raeburn 1997: # ---------------------------------------------------------- Domain roles
1998:
1999: sub get_domain_roles {
2000: my ($dom,$roles,$startdate,$enddate)=@_;
2001: if (undef($startdate) || $startdate eq '') {
2002: $startdate = '.';
2003: }
2004: if (undef($enddate) || $enddate eq '') {
2005: $enddate = '.';
2006: }
2007: my $rolelist = join(':',@{$roles});
2008: my %personnel = ();
2009: foreach my $tryserver (keys(%libserv)) {
2010: if ($hostdom{$tryserver} eq $dom) {
2011: %{$personnel{$tryserver}}=();
2012: foreach (
2013: split(/\&/,&reply('domrolesdump:'.$dom.':'.
2014: &escape($startdate).':'.&escape($enddate).':'.
2015: &escape($rolelist), $tryserver))) {
2016: my($key,$value) = split(/\=/,$_);
2017: if (($key) && ($value)) {
2018: $personnel{$tryserver}{&unescape($key)} = &unescape($value);
2019: }
2020: }
2021: }
2022: }
2023: return %personnel;
2024: }
1.658 raeburn 2025:
1.149 www 2026: # ----------------------------------------------------------- Check out an item
2027:
1.504 albertel 2028: sub get_first_access {
2029: my ($type,$argsymb)=@_;
2030: my ($symb,$courseid,$udom,$uname)=&Apache::lonxml::whichuser();
2031: if ($argsymb) { $symb=$argsymb; }
2032: my ($map,$id,$res)=&decode_symb($symb);
1.588 albertel 2033: if ($type eq 'map') {
2034: $res=&symbread($map);
2035: } else {
2036: $res=$symb;
2037: }
2038: my %times=&get('firstaccesstimes',["$courseid\0$res"],$udom,$uname);
2039: return $times{"$courseid\0$res"};
1.504 albertel 2040: }
2041:
2042: sub set_first_access {
2043: my ($type)=@_;
2044: my ($symb,$courseid,$udom,$uname)=&Apache::lonxml::whichuser();
2045: my ($map,$id,$res)=&decode_symb($symb);
1.588 albertel 2046: if ($type eq 'map') {
2047: $res=&symbread($map);
2048: } else {
2049: $res=$symb;
2050: }
2051: my $firstaccess=&get_first_access($type,$symb);
1.505 albertel 2052: if (!$firstaccess) {
1.588 albertel 2053: return &put('firstaccesstimes',{"$courseid\0$res"=>time},$udom,$uname);
1.505 albertel 2054: }
2055: return 'already_set';
1.504 albertel 2056: }
2057:
1.149 www 2058: sub checkout {
2059: my ($symb,$tuname,$tudom,$tcrsid)=@_;
2060: my $now=time;
2061: my $lonhost=$perlvar{'lonHostID'};
2062: my $infostr=&escape(
1.234 www 2063: 'CHECKOUTTOKEN&'.
1.149 www 2064: $tuname.'&'.
2065: $tudom.'&'.
2066: $tcrsid.'&'.
2067: $symb.'&'.
2068: $now.'&'.$ENV{'REMOTE_ADDR'});
2069: my $token=&reply('tmpput:'.$infostr,$lonhost);
1.151 www 2070: if ($token=~/^error\:/) {
1.672 albertel 2071: &logthis("<font color=\"blue\">WARNING: ".
1.151 www 2072: "Checkout tmpput failed ".$tudom.' - '.$tuname.' - '.$symb.
2073: "</font>");
2074: return '';
2075: }
2076:
1.149 www 2077: $token=~s/^(\d+)\_.*\_(\d+)$/$1\*$2\*$lonhost/;
2078: $token=~tr/a-z/A-Z/;
2079:
1.153 www 2080: my %infohash=('resource.0.outtoken' => $token,
2081: 'resource.0.checkouttime' => $now,
2082: 'resource.0.outremote' => $ENV{'REMOTE_ADDR'});
1.149 www 2083:
2084: unless (&cstore(\%infohash,$symb,$tcrsid,$tudom,$tuname) eq 'ok') {
2085: return '';
1.151 www 2086: } else {
1.672 albertel 2087: &logthis("<font color=\"blue\">WARNING: ".
1.151 www 2088: "Checkout cstore failed ".$tudom.' - '.$tuname.' - '.$symb.
2089: "</font>");
1.149 www 2090: }
2091:
2092: if (&log($tudom,$tuname,&homeserver($tuname,$tudom),
2093: &escape('Checkout '.$infostr.' - '.
2094: $token)) ne 'ok') {
2095: return '';
1.151 www 2096: } else {
1.672 albertel 2097: &logthis("<font color=\"blue\">WARNING: ".
1.151 www 2098: "Checkout log failed ".$tudom.' - '.$tuname.' - '.$symb.
2099: "</font>");
1.149 www 2100: }
1.151 www 2101: return $token;
1.149 www 2102: }
2103:
2104: # ------------------------------------------------------------ Check in an item
2105:
2106: sub checkin {
2107: my $token=shift;
1.150 www 2108: my $now=time;
2109: my ($ta,$tb,$lonhost)=split(/\*/,$token);
2110: $lonhost=~tr/A-Z/a-z/;
1.595 albertel 2111: my $dtoken=$ta.'_'.$hostname{$lonhost}.'_'.$tb;
1.150 www 2112: $dtoken=~s/\W/\_/g;
1.234 www 2113: my ($dummy,$tuname,$tudom,$tcrsid,$symb,$chtim,$rmaddr)=
1.150 www 2114: split(/\&/,&unescape(&reply('tmpget:'.$dtoken,$lonhost)));
2115:
1.154 www 2116: unless (($tuname) && ($tudom)) {
2117: &logthis('Check in '.$token.' ('.$dtoken.') failed');
2118: return '';
2119: }
2120:
2121: unless (&allowed('mgr',$tcrsid)) {
2122: &logthis('Check in '.$token.' ('.$dtoken.') unauthorized: '.
1.620 albertel 2123: $env{'user.name'}.' - '.$env{'user.domain'});
1.154 www 2124: return '';
2125: }
2126:
1.153 www 2127: my %infohash=('resource.0.intoken' => $token,
2128: 'resource.0.checkintime' => $now,
2129: 'resource.0.inremote' => $ENV{'REMOTE_ADDR'});
1.150 www 2130:
2131: unless (&cstore(\%infohash,$symb,$tcrsid,$tudom,$tuname) eq 'ok') {
2132: return '';
2133: }
2134:
2135: if (&log($tudom,$tuname,&homeserver($tuname,$tudom),
2136: &escape('Checkin - '.$token)) ne 'ok') {
2137: return '';
2138: }
2139:
2140: return ($symb,$tuname,$tudom,$tcrsid);
1.110 www 2141: }
2142:
2143: # --------------------------------------------- Set Expire Date for Spreadsheet
2144:
2145: sub expirespread {
2146: my ($uname,$udom,$stype,$usymb)=@_;
1.620 albertel 2147: my $cid=$env{'request.course.id'};
1.110 www 2148: if ($cid) {
2149: my $now=time;
2150: my $key=$uname.':'.$udom.':'.$stype.':'.$usymb;
1.620 albertel 2151: return &reply('put:'.$env{'course.'.$cid.'.domain'}.':'.
2152: $env{'course.'.$cid.'.num'}.
1.110 www 2153: ':nohist_expirationdates:'.
2154: &escape($key).'='.$now,
1.620 albertel 2155: $env{'course.'.$cid.'.home'})
1.110 www 2156: }
2157: return 'ok';
1.14 www 2158: }
2159:
1.109 www 2160: # ----------------------------------------------------- Devalidate Spreadsheets
2161:
2162: sub devalidate {
1.325 www 2163: my ($symb,$uname,$udom)=@_;
1.620 albertel 2164: my $cid=$env{'request.course.id'};
1.109 www 2165: if ($cid) {
1.391 matthew 2166: # delete the stored spreadsheets for
2167: # - the student level sheet of this user in course's homespace
2168: # - the assessment level sheet for this resource
2169: # for this user in user's homespace
1.553 albertel 2170: # - current conditional state info
1.325 www 2171: my $key=$uname.':'.$udom.':';
1.109 www 2172: my $status=
1.299 matthew 2173: &del('nohist_calculatedsheets',
1.391 matthew 2174: [$key.'studentcalc:'],
1.620 albertel 2175: $env{'course.'.$cid.'.domain'},
2176: $env{'course.'.$cid.'.num'})
1.133 albertel 2177: .' '.
2178: &del('nohist_calculatedsheets_'.$cid,
1.391 matthew 2179: [$key.'assesscalc:'.$symb],$udom,$uname);
1.109 www 2180: unless ($status eq 'ok ok') {
2181: &logthis('Could not devalidate spreadsheet '.
1.325 www 2182: $uname.' at '.$udom.' for '.
1.109 www 2183: $symb.': '.$status);
1.133 albertel 2184: }
1.553 albertel 2185: &delenv('user.state.'.$cid);
1.109 www 2186: }
2187: }
2188:
1.265 albertel 2189: sub get_scalar {
2190: my ($string,$end) = @_;
2191: my $value;
2192: if ($$string =~ s/^([^&]*?)($end)/$2/) {
2193: $value = $1;
2194: } elsif ($$string =~ s/^([^&]*?)&//) {
2195: $value = $1;
2196: }
2197: return &unescape($value);
2198: }
2199:
2200: sub array2str {
2201: my (@array) = @_;
2202: my $result=&arrayref2str(\@array);
2203: $result=~s/^__ARRAY_REF__//;
2204: $result=~s/__END_ARRAY_REF__$//;
2205: return $result;
2206: }
2207:
1.204 albertel 2208: sub arrayref2str {
2209: my ($arrayref) = @_;
1.265 albertel 2210: my $result='__ARRAY_REF__';
1.204 albertel 2211: foreach my $elem (@$arrayref) {
1.265 albertel 2212: if(ref($elem) eq 'ARRAY') {
2213: $result.=&arrayref2str($elem).'&';
2214: } elsif(ref($elem) eq 'HASH') {
2215: $result.=&hashref2str($elem).'&';
2216: } elsif(ref($elem)) {
2217: #print("Got a ref of ".(ref($elem))." skipping.");
1.204 albertel 2218: } else {
2219: $result.=&escape($elem).'&';
2220: }
2221: }
2222: $result=~s/\&$//;
1.265 albertel 2223: $result .= '__END_ARRAY_REF__';
1.204 albertel 2224: return $result;
2225: }
2226:
1.168 albertel 2227: sub hash2str {
1.204 albertel 2228: my (%hash) = @_;
2229: my $result=&hashref2str(\%hash);
1.265 albertel 2230: $result=~s/^__HASH_REF__//;
2231: $result=~s/__END_HASH_REF__$//;
1.204 albertel 2232: return $result;
2233: }
2234:
2235: sub hashref2str {
2236: my ($hashref)=@_;
1.265 albertel 2237: my $result='__HASH_REF__';
1.495 albertel 2238: foreach (sort(keys(%$hashref))) {
1.204 albertel 2239: if (ref($_) eq 'ARRAY') {
1.265 albertel 2240: $result.=&arrayref2str($_).'=';
1.204 albertel 2241: } elsif (ref($_) eq 'HASH') {
1.265 albertel 2242: $result.=&hashref2str($_).'=';
1.204 albertel 2243: } elsif (ref($_)) {
1.265 albertel 2244: $result.='=';
2245: #print("Got a ref of ".(ref($_))." skipping.");
1.204 albertel 2246: } else {
1.265 albertel 2247: if ($_) {$result.=&escape($_).'=';} else { last; }
1.204 albertel 2248: }
2249:
1.265 albertel 2250: if(ref($hashref->{$_}) eq 'ARRAY') {
2251: $result.=&arrayref2str($hashref->{$_}).'&';
2252: } elsif(ref($hashref->{$_}) eq 'HASH') {
2253: $result.=&hashref2str($hashref->{$_}).'&';
2254: } elsif(ref($hashref->{$_})) {
2255: $result.='&';
2256: #print("Got a ref of ".(ref($hashref->{$_}))." skipping.");
1.204 albertel 2257: } else {
1.265 albertel 2258: $result.=&escape($hashref->{$_}).'&';
1.204 albertel 2259: }
2260: }
1.168 albertel 2261: $result=~s/\&$//;
1.265 albertel 2262: $result .= '__END_HASH_REF__';
1.168 albertel 2263: return $result;
2264: }
2265:
2266: sub str2hash {
1.265 albertel 2267: my ($string)=@_;
2268: my ($hash)=&str2hashref('__HASH_REF__'.$string.'__END_HASH_REF__');
2269: return %$hash;
2270: }
2271:
2272: sub str2hashref {
1.168 albertel 2273: my ($string) = @_;
1.265 albertel 2274:
2275: my %hash;
2276:
2277: if($string !~ /^__HASH_REF__/) {
2278: if (! ($string eq '' || !defined($string))) {
2279: $hash{'error'}='Not hash reference';
2280: }
2281: return (\%hash, $string);
2282: }
2283:
2284: $string =~ s/^__HASH_REF__//;
2285:
2286: while($string !~ /^__END_HASH_REF__/) {
2287: #key
2288: my $key='';
2289: if($string =~ /^__HASH_REF__/) {
2290: ($key, $string)=&str2hashref($string);
2291: if(defined($key->{'error'})) {
2292: $hash{'error'}='Bad data';
2293: return (\%hash, $string);
2294: }
2295: } elsif($string =~ /^__ARRAY_REF__/) {
2296: ($key, $string)=&str2arrayref($string);
2297: if($key->[0] eq 'Array reference error') {
2298: $hash{'error'}='Bad data';
2299: return (\%hash, $string);
2300: }
2301: } else {
2302: $string =~ s/^(.*?)=//;
1.267 albertel 2303: $key=&unescape($1);
1.265 albertel 2304: }
2305: $string =~ s/^=//;
2306:
2307: #value
2308: my $value='';
2309: if($string =~ /^__HASH_REF__/) {
2310: ($value, $string)=&str2hashref($string);
2311: if(defined($value->{'error'})) {
2312: $hash{'error'}='Bad data';
2313: return (\%hash, $string);
2314: }
2315: } elsif($string =~ /^__ARRAY_REF__/) {
2316: ($value, $string)=&str2arrayref($string);
2317: if($value->[0] eq 'Array reference error') {
2318: $hash{'error'}='Bad data';
2319: return (\%hash, $string);
2320: }
2321: } else {
2322: $value=&get_scalar(\$string,'__END_HASH_REF__');
2323: }
2324: $string =~ s/^&//;
2325:
2326: $hash{$key}=$value;
1.204 albertel 2327: }
1.265 albertel 2328:
2329: $string =~ s/^__END_HASH_REF__//;
2330:
2331: return (\%hash, $string);
1.204 albertel 2332: }
2333:
2334: sub str2array {
1.265 albertel 2335: my ($string)=@_;
2336: my ($array)=&str2arrayref('__ARRAY_REF__'.$string.'__END_ARRAY_REF__');
2337: return @$array;
2338: }
2339:
2340: sub str2arrayref {
1.204 albertel 2341: my ($string) = @_;
1.265 albertel 2342: my @array;
2343:
2344: if($string !~ /^__ARRAY_REF__/) {
2345: if (! ($string eq '' || !defined($string))) {
2346: $array[0]='Array reference error';
2347: }
2348: return (\@array, $string);
2349: }
2350:
2351: $string =~ s/^__ARRAY_REF__//;
2352:
2353: while($string !~ /^__END_ARRAY_REF__/) {
2354: my $value='';
2355: if($string =~ /^__HASH_REF__/) {
2356: ($value, $string)=&str2hashref($string);
2357: if(defined($value->{'error'})) {
2358: $array[0] ='Array reference error';
2359: return (\@array, $string);
2360: }
2361: } elsif($string =~ /^__ARRAY_REF__/) {
2362: ($value, $string)=&str2arrayref($string);
2363: if($value->[0] eq 'Array reference error') {
2364: $array[0] ='Array reference error';
2365: return (\@array, $string);
2366: }
2367: } else {
2368: $value=&get_scalar(\$string,'__END_ARRAY_REF__');
2369: }
2370: $string =~ s/^&//;
2371:
2372: push(@array, $value);
1.191 harris41 2373: }
1.265 albertel 2374:
2375: $string =~ s/^__END_ARRAY_REF__//;
2376:
2377: return (\@array, $string);
1.168 albertel 2378: }
2379:
1.167 albertel 2380: # -------------------------------------------------------------------Temp Store
2381:
1.168 albertel 2382: sub tmpreset {
2383: my ($symb,$namespace,$domain,$stuname) = @_;
2384: if (!$symb) {
2385: $symb=&symbread();
1.620 albertel 2386: if (!$symb) { $symb= $env{'request.url'}; }
1.168 albertel 2387: }
2388: $symb=escape($symb);
2389:
1.620 albertel 2390: if (!$namespace) { $namespace=$env{'request.state'}; }
1.168 albertel 2391: $namespace=~s/\//\_/g;
2392: $namespace=~s/\W//g;
2393:
1.620 albertel 2394: if (!$domain) { $domain=$env{'user.domain'}; }
2395: if (!$stuname) { $stuname=$env{'user.name'}; }
1.591 albertel 2396: if ($domain eq 'public' && $stuname eq 'public') {
2397: $stuname=$ENV{'REMOTE_ADDR'};
2398: }
1.168 albertel 2399: my $path=$perlvar{'lonDaemons'}.'/tmp';
2400: my %hash;
2401: if (tie(%hash,'GDBM_File',
2402: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
1.256 albertel 2403: &GDBM_WRCREAT(),0640)) {
1.168 albertel 2404: foreach my $key (keys %hash) {
1.180 albertel 2405: if ($key=~ /:$symb/) {
1.168 albertel 2406: delete($hash{$key});
2407: }
2408: }
2409: }
2410: }
2411:
1.167 albertel 2412: sub tmpstore {
1.168 albertel 2413: my ($storehash,$symb,$namespace,$domain,$stuname) = @_;
2414:
2415: if (!$symb) {
2416: $symb=&symbread();
1.620 albertel 2417: if (!$symb) { $symb= $env{'request.url'}; }
1.168 albertel 2418: }
2419: $symb=escape($symb);
2420:
2421: if (!$namespace) {
2422: # I don't think we would ever want to store this for a course.
2423: # it seems this will only be used if we don't have a course.
1.620 albertel 2424: #$namespace=$env{'request.course.id'};
1.168 albertel 2425: #if (!$namespace) {
1.620 albertel 2426: $namespace=$env{'request.state'};
1.168 albertel 2427: #}
2428: }
2429: $namespace=~s/\//\_/g;
2430: $namespace=~s/\W//g;
1.620 albertel 2431: if (!$domain) { $domain=$env{'user.domain'}; }
2432: if (!$stuname) { $stuname=$env{'user.name'}; }
1.591 albertel 2433: if ($domain eq 'public' && $stuname eq 'public') {
2434: $stuname=$ENV{'REMOTE_ADDR'};
2435: }
1.168 albertel 2436: my $now=time;
2437: my %hash;
2438: my $path=$perlvar{'lonDaemons'}.'/tmp';
2439: if (tie(%hash,'GDBM_File',
2440: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
1.256 albertel 2441: &GDBM_WRCREAT(),0640)) {
1.168 albertel 2442: $hash{"version:$symb"}++;
2443: my $version=$hash{"version:$symb"};
2444: my $allkeys='';
2445: foreach my $key (keys(%$storehash)) {
2446: $allkeys.=$key.':';
1.591 albertel 2447: $hash{"$version:$symb:$key"}=&freeze_escape($$storehash{$key});
1.168 albertel 2448: }
2449: $hash{"$version:$symb:timestamp"}=$now;
2450: $allkeys.='timestamp';
2451: $hash{"$version:keys:$symb"}=$allkeys;
2452: if (untie(%hash)) {
2453: return 'ok';
2454: } else {
2455: return "error:$!";
2456: }
2457: } else {
2458: return "error:$!";
2459: }
2460: }
1.167 albertel 2461:
1.168 albertel 2462: # -----------------------------------------------------------------Temp Restore
1.167 albertel 2463:
1.168 albertel 2464: sub tmprestore {
2465: my ($symb,$namespace,$domain,$stuname) = @_;
1.167 albertel 2466:
1.168 albertel 2467: if (!$symb) {
2468: $symb=&symbread();
1.620 albertel 2469: if (!$symb) { $symb= $env{'request.url'}; }
1.168 albertel 2470: }
2471: $symb=escape($symb);
2472:
1.620 albertel 2473: if (!$namespace) { $namespace=$env{'request.state'}; }
1.591 albertel 2474:
1.620 albertel 2475: if (!$domain) { $domain=$env{'user.domain'}; }
2476: if (!$stuname) { $stuname=$env{'user.name'}; }
1.591 albertel 2477: if ($domain eq 'public' && $stuname eq 'public') {
2478: $stuname=$ENV{'REMOTE_ADDR'};
2479: }
1.168 albertel 2480: my %returnhash;
2481: $namespace=~s/\//\_/g;
2482: $namespace=~s/\W//g;
2483: my %hash;
2484: my $path=$perlvar{'lonDaemons'}.'/tmp';
2485: if (tie(%hash,'GDBM_File',
2486: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
1.256 albertel 2487: &GDBM_READER(),0640)) {
1.168 albertel 2488: my $version=$hash{"version:$symb"};
2489: $returnhash{'version'}=$version;
2490: my $scope;
2491: for ($scope=1;$scope<=$version;$scope++) {
2492: my $vkeys=$hash{"$scope:keys:$symb"};
2493: my @keys=split(/:/,$vkeys);
2494: my $key;
2495: $returnhash{"$scope:keys"}=$vkeys;
2496: foreach $key (@keys) {
1.591 albertel 2497: $returnhash{"$scope:$key"}=&thaw_unescape($hash{"$scope:$symb:$key"});
2498: $returnhash{"$key"}=&thaw_unescape($hash{"$scope:$symb:$key"});
1.167 albertel 2499: }
2500: }
1.168 albertel 2501: if (!(untie(%hash))) {
2502: return "error:$!";
2503: }
2504: } else {
2505: return "error:$!";
2506: }
2507: return %returnhash;
1.167 albertel 2508: }
2509:
1.9 www 2510: # ----------------------------------------------------------------------- Store
2511:
2512: sub store {
1.124 www 2513: my ($storehash,$symb,$namespace,$domain,$stuname) = @_;
2514: my $home='';
2515:
1.168 albertel 2516: if ($stuname) { $home=&homeserver($stuname,$domain); }
1.124 www 2517:
1.213 www 2518: $symb=&symbclean($symb);
1.122 albertel 2519: if (!$symb) { unless ($symb=&symbread()) { return ''; } }
1.109 www 2520:
1.620 albertel 2521: if (!$domain) { $domain=$env{'user.domain'}; }
2522: if (!$stuname) { $stuname=$env{'user.name'}; }
1.325 www 2523:
2524: &devalidate($symb,$stuname,$domain);
1.109 www 2525:
2526: $symb=escape($symb);
1.187 www 2527: if (!$namespace) {
1.620 albertel 2528: unless ($namespace=$env{'request.course.id'}) {
1.187 www 2529: return '';
2530: }
2531: }
1.620 albertel 2532: if (!$home) { $home=$env{'user.home'}; }
1.447 www 2533:
2534: $$storehash{'ip'}=$ENV{'REMOTE_ADDR'};
2535: $$storehash{'host'}=$perlvar{'lonHostID'};
2536:
1.12 www 2537: my $namevalue='';
1.191 harris41 2538: foreach (keys %$storehash) {
1.591 albertel 2539: $namevalue.=&escape($_).'='.&freeze_escape($$storehash{$_}).'&';
1.191 harris41 2540: }
1.12 www 2541: $namevalue=~s/\&$//;
1.187 www 2542: &courselog($symb.':'.$stuname.':'.$domain.':STORE:'.$namevalue);
1.124 www 2543: return reply("store:$domain:$stuname:$namespace:$symb:$namevalue","$home");
1.9 www 2544: }
2545:
1.47 www 2546: # -------------------------------------------------------------- Critical Store
2547:
2548: sub cstore {
1.124 www 2549: my ($storehash,$symb,$namespace,$domain,$stuname) = @_;
2550: my $home='';
2551:
1.168 albertel 2552: if ($stuname) { $home=&homeserver($stuname,$domain); }
1.124 www 2553:
1.213 www 2554: $symb=&symbclean($symb);
1.122 albertel 2555: if (!$symb) { unless ($symb=&symbread()) { return ''; } }
1.109 www 2556:
1.620 albertel 2557: if (!$domain) { $domain=$env{'user.domain'}; }
2558: if (!$stuname) { $stuname=$env{'user.name'}; }
1.325 www 2559:
2560: &devalidate($symb,$stuname,$domain);
1.109 www 2561:
2562: $symb=escape($symb);
1.187 www 2563: if (!$namespace) {
1.620 albertel 2564: unless ($namespace=$env{'request.course.id'}) {
1.187 www 2565: return '';
2566: }
2567: }
1.620 albertel 2568: if (!$home) { $home=$env{'user.home'}; }
1.447 www 2569:
2570: $$storehash{'ip'}=$ENV{'REMOTE_ADDR'};
2571: $$storehash{'host'}=$perlvar{'lonHostID'};
1.122 albertel 2572:
1.47 www 2573: my $namevalue='';
1.191 harris41 2574: foreach (keys %$storehash) {
1.591 albertel 2575: $namevalue.=&escape($_).'='.&freeze_escape($$storehash{$_}).'&';
1.191 harris41 2576: }
1.47 www 2577: $namevalue=~s/\&$//;
1.187 www 2578: &courselog($symb.':'.$stuname.':'.$domain.':CSTORE:'.$namevalue);
1.188 www 2579: return critical
2580: ("store:$domain:$stuname:$namespace:$symb:$namevalue","$home");
1.47 www 2581: }
2582:
1.9 www 2583: # --------------------------------------------------------------------- Restore
2584:
2585: sub restore {
1.124 www 2586: my ($symb,$namespace,$domain,$stuname) = @_;
2587: my $home='';
2588:
1.168 albertel 2589: if ($stuname) { $home=&homeserver($stuname,$domain); }
1.124 www 2590:
1.122 albertel 2591: if (!$symb) {
2592: unless ($symb=escape(&symbread())) { return ''; }
2593: } else {
1.213 www 2594: $symb=&escape(&symbclean($symb));
1.122 albertel 2595: }
1.188 www 2596: if (!$namespace) {
1.620 albertel 2597: unless ($namespace=$env{'request.course.id'}) {
1.188 www 2598: return '';
2599: }
2600: }
1.620 albertel 2601: if (!$domain) { $domain=$env{'user.domain'}; }
2602: if (!$stuname) { $stuname=$env{'user.name'}; }
2603: if (!$home) { $home=$env{'user.home'}; }
1.122 albertel 2604: my $answer=&reply("restore:$domain:$stuname:$namespace:$symb","$home");
2605:
1.12 www 2606: my %returnhash=();
1.191 harris41 2607: foreach (split(/\&/,$answer)) {
1.12 www 2608: my ($name,$value)=split(/\=/,$_);
1.591 albertel 2609: $returnhash{&unescape($name)}=&thaw_unescape($value);
1.191 harris41 2610: }
1.75 www 2611: my $version;
2612: for ($version=1;$version<=$returnhash{'version'};$version++) {
1.191 harris41 2613: foreach (split(/\:/,$returnhash{$version.':keys'})) {
1.75 www 2614: $returnhash{$_}=$returnhash{$version.':'.$_};
1.191 harris41 2615: }
1.75 www 2616: }
1.13 www 2617: return %returnhash;
1.34 www 2618: }
2619:
2620: # ---------------------------------------------------------- Course Description
2621:
2622: sub coursedescription {
1.731 albertel 2623: my ($courseid,$args)=@_;
1.34 www 2624: $courseid=~s/^\///;
1.49 www 2625: $courseid=~s/\_/\//g;
1.34 www 2626: my ($cdomain,$cnum)=split(/\//,$courseid);
1.129 albertel 2627: my $chome=&homeserver($cnum,$cdomain);
1.302 albertel 2628: my $normalid=$cdomain.'_'.$cnum;
2629: # need to always cache even if we get errors otherwise we keep
2630: # trying and trying and trying to get the course description.
2631: my %envhash=();
2632: my %returnhash=();
1.731 albertel 2633:
2634: my $expiretime=600;
2635: if ($env{'request.course.id'} eq $normalid) {
2636: $expiretime=120;
2637: }
2638:
2639: my $prefix='course.'.$cdomain.'_'.$cnum.'.';
2640: if (!$args->{'freshen_cache'}
2641: && ((time-$env{$prefix.'last_cache'}) < $expiretime) ) {
2642: foreach my $key (keys(%env)) {
2643: next if ($key !~ /^\Q$prefix\E(.*)/);
2644: my ($setting) = $1;
2645: $returnhash{$setting} = $env{$key};
2646: }
2647: return %returnhash;
2648: }
2649:
2650: # get the data agin
2651: if (!$args->{'one_time'}) {
2652: $envhash{'course.'.$normalid.'.last_cache'}=time;
2653: }
1.34 www 2654: if ($chome ne 'no_host') {
1.302 albertel 2655: %returnhash=&dump('environment',$cdomain,$cnum);
1.129 albertel 2656: if (!exists($returnhash{'con_lost'})) {
2657: $returnhash{'home'}= $chome;
2658: $returnhash{'domain'} = $cdomain;
2659: $returnhash{'num'} = $cnum;
1.741 raeburn 2660: if (!defined($returnhash{'type'})) {
2661: $returnhash{'type'} = 'Course';
2662: }
1.130 albertel 2663: while (my ($name,$value) = each %returnhash) {
1.53 www 2664: $envhash{'course.'.$normalid.'.'.$name}=$value;
1.129 albertel 2665: }
1.270 www 2666: $returnhash{'url'}=&clutter($returnhash{'url'});
1.34 www 2667: $returnhash{'fn'}=$perlvar{'lonDaemons'}.'/tmp/'.
1.620 albertel 2668: $env{'user.name'}.'_'.$cdomain.'_'.$cnum;
1.60 www 2669: $envhash{'course.'.$normalid.'.home'}=$chome;
2670: $envhash{'course.'.$normalid.'.domain'}=$cdomain;
2671: $envhash{'course.'.$normalid.'.num'}=$cnum;
1.34 www 2672: }
2673: }
1.731 albertel 2674: if (!$args->{'one_time'}) {
2675: &appenv(%envhash);
2676: }
1.302 albertel 2677: return %returnhash;
1.461 www 2678: }
2679:
2680: # -------------------------------------------------See if a user is privileged
2681:
2682: sub privileged {
2683: my ($username,$domain)=@_;
2684: my $rolesdump=&reply("dump:$domain:$username:roles",
2685: &homeserver($username,$domain));
2686: if (($rolesdump eq 'con_lost') || ($rolesdump eq '')) { return 0; }
2687: my $now=time;
2688: if ($rolesdump ne '') {
2689: foreach (split(/&/,$rolesdump)) {
1.586 albertel 2690: if ($_!~/^rolesdef_/) {
1.461 www 2691: my ($area,$role)=split(/=/,$_);
2692: $area=~s/\_\w\w$//;
2693: my ($trole,$tend,$tstart)=split(/_/,$role);
2694: if (($trole eq 'dc') || ($trole eq 'su')) {
2695: my $active=1;
2696: if ($tend) {
2697: if ($tend<$now) { $active=0; }
2698: }
2699: if ($tstart) {
2700: if ($tstart>$now) { $active=0; }
2701: }
2702: if ($active) { return 1; }
2703: }
2704: }
2705: }
2706: }
2707: return 0;
1.9 www 2708: }
1.1 albertel 2709:
1.103 harris41 2710: # -------------------------------------------------------- Get user privileges
1.11 www 2711:
2712: sub rolesinit {
2713: my ($domain,$username,$authhost)=@_;
2714: my $rolesdump=reply("dump:$domain:$username:roles",$authhost);
1.12 www 2715: if (($rolesdump eq 'con_lost') || ($rolesdump eq '')) { return ''; }
1.11 www 2716: my %allroles=();
1.678 raeburn 2717: my %allgroups=();
1.11 www 2718: my $now=time;
1.743 albertel 2719: my %userroles = ('user.login.time' => $now);
1.678 raeburn 2720: my $group_privs;
1.11 www 2721:
2722: if ($rolesdump ne '') {
1.191 harris41 2723: foreach (split(/&/,$rolesdump)) {
1.586 albertel 2724: if ($_!~/^rolesdef_/) {
1.11 www 2725: my ($area,$role)=split(/=/,$_);
1.587 albertel 2726: $area=~s/\_\w\w$//;
1.678 raeburn 2727: my ($trole,$tend,$tstart,$group_privs);
1.587 albertel 2728: if ($role=~/^cr/) {
1.655 albertel 2729: if ($role=~m|^(cr/\w+/\w+/[a-zA-Z0-9]+)_(.*)$|) {
2730: ($trole,my $trest)=($role=~m|^(cr/\w+/\w+/[a-zA-Z0-9]+)_(.*)$|);
2731: ($tend,$tstart)=split('_',$trest);
2732: } else {
2733: $trole=$role;
2734: }
1.678 raeburn 2735: } elsif ($role =~ m|^gr/|) {
2736: ($trole,$tend,$tstart) = split(/_/,$role);
2737: ($trole,$group_privs) = split(/\//,$trole);
2738: $group_privs = &unescape($group_privs);
1.587 albertel 2739: } else {
2740: ($trole,$tend,$tstart)=split(/_/,$role);
2741: }
1.743 albertel 2742: my %new_role = &set_arearole($trole,$area,$tstart,$tend,$domain,
2743: $username);
2744: @userroles{keys(%new_role)} = @new_role{keys(%new_role)};
1.567 raeburn 2745: if (($tend!=0) && ($tend<$now)) { $trole=''; }
2746: if (($tstart!=0) && ($tstart>$now)) { $trole=''; }
1.11 www 2747: if (($area ne '') && ($trole ne '')) {
1.347 albertel 2748: my $spec=$trole.'.'.$area;
2749: my ($tdummy,$tdomain,$trest)=split(/\//,$area);
2750: if ($trole =~ /^cr\//) {
1.567 raeburn 2751: &custom_roleprivs(\%allroles,$trole,$tdomain,$trest,$spec,$area);
1.678 raeburn 2752: } elsif ($trole eq 'gr') {
2753: &group_roleprivs(\%allgroups,$area,$group_privs,$tend,$tstart);
1.347 albertel 2754: } else {
1.567 raeburn 2755: &standard_roleprivs(\%allroles,$trole,$tdomain,$spec,$trest,$area);
1.347 albertel 2756: }
1.12 www 2757: }
1.662 raeburn 2758: }
1.191 harris41 2759: }
1.743 albertel 2760: my ($author,$adv) = &set_userprivs(\%userroles,\%allroles,\%allgroups);
2761: $userroles{'user.adv'} = $adv;
2762: $userroles{'user.author'} = $author;
1.620 albertel 2763: $env{'user.adv'}=$adv;
1.11 www 2764: }
1.743 albertel 2765: return \%userroles;
1.11 www 2766: }
2767:
1.567 raeburn 2768: sub set_arearole {
2769: my ($trole,$area,$tstart,$tend,$domain,$username) = @_;
2770: # log the associated role with the area
2771: &userrolelog($trole,$username,$domain,$area,$tstart,$tend);
1.743 albertel 2772: return ('user.role.'.$trole.'.'.$area => $tstart.'.'.$tend);
1.567 raeburn 2773: }
2774:
2775: sub custom_roleprivs {
2776: my ($allroles,$trole,$tdomain,$trest,$spec,$area) = @_;
2777: my ($rdummy,$rdomain,$rauthor,$rrole)=split(/\//,$trole);
2778: my $homsvr=homeserver($rauthor,$rdomain);
2779: if ($hostname{$homsvr} ne '') {
2780: my ($rdummy,$roledef)=
2781: &get('roles',["rolesdef_$rrole"],$rdomain,$rauthor);
2782: if (($rdummy ne 'con_lost') && ($roledef ne '')) {
2783: my ($syspriv,$dompriv,$coursepriv)=split(/\_/,$roledef);
2784: if (defined($syspriv)) {
2785: $$allroles{'cm./'}.=':'.$syspriv;
2786: $$allroles{$spec.'./'}.=':'.$syspriv;
2787: }
2788: if ($tdomain ne '') {
2789: if (defined($dompriv)) {
2790: $$allroles{'cm./'.$tdomain.'/'}.=':'.$dompriv;
2791: $$allroles{$spec.'./'.$tdomain.'/'}.=':'.$dompriv;
2792: }
2793: if (($trest ne '') && (defined($coursepriv))) {
2794: $$allroles{'cm.'.$area}.=':'.$coursepriv;
2795: $$allroles{$spec.'.'.$area}.=':'.$coursepriv;
2796: }
2797: }
2798: }
2799: }
2800: }
2801:
1.678 raeburn 2802: sub group_roleprivs {
2803: my ($allgroups,$area,$group_privs,$tend,$tstart) = @_;
2804: my $access = 1;
2805: my $now = time;
2806: if (($tend!=0) && ($tend<$now)) { $access = 0; }
2807: if (($tstart!=0) && ($tstart>$now)) { $access=0; }
2808: if ($access) {
2809: my ($course,$group) = ($area =~ m|(/\w+/\w+)/([^/]+)$|);
2810: $$allgroups{$course}{$group} .=':'.$group_privs;
2811: }
2812: }
1.567 raeburn 2813:
2814: sub standard_roleprivs {
2815: my ($allroles,$trole,$tdomain,$spec,$trest,$area) = @_;
2816: if (defined($pr{$trole.':s'})) {
2817: $$allroles{'cm./'}.=':'.$pr{$trole.':s'};
2818: $$allroles{$spec.'./'}.=':'.$pr{$trole.':s'};
2819: }
2820: if ($tdomain ne '') {
2821: if (defined($pr{$trole.':d'})) {
2822: $$allroles{'cm./'.$tdomain.'/'}.=':'.$pr{$trole.':d'};
2823: $$allroles{$spec.'./'.$tdomain.'/'}.=':'.$pr{$trole.':d'};
2824: }
2825: if (($trest ne '') && (defined($pr{$trole.':c'}))) {
2826: $$allroles{'cm.'.$area}.=':'.$pr{$trole.':c'};
2827: $$allroles{$spec.'.'.$area}.=':'.$pr{$trole.':c'};
2828: }
2829: }
2830: }
2831:
2832: sub set_userprivs {
1.678 raeburn 2833: my ($userroles,$allroles,$allgroups) = @_;
1.567 raeburn 2834: my $author=0;
2835: my $adv=0;
1.678 raeburn 2836: my %grouproles = ();
2837: if (keys(%{$allgroups}) > 0) {
2838: foreach my $role (keys %{$allroles}) {
1.681 raeburn 2839: my ($trole,$area,$sec,$extendedarea);
2840: if ($role =~ m|^(\w+)\.(/\w+/\w+)(/?\w*)|) {
1.678 raeburn 2841: $trole = $1;
2842: $area = $2;
1.681 raeburn 2843: $sec = $3;
2844: $extendedarea = $area.$sec;
2845: if (exists($$allgroups{$area})) {
2846: foreach my $group (keys(%{$$allgroups{$area}})) {
2847: my $spec = $trole.'.'.$extendedarea;
2848: $grouproles{$spec.'.'.$area.'/'.$group} =
2849: $$allgroups{$area}{$group};
1.678 raeburn 2850: }
2851: }
2852: }
2853: }
2854: }
2855: foreach (keys(%grouproles)) {
2856: $$allroles{$_} = $grouproles{$_};
2857: }
1.567 raeburn 2858: foreach (keys %{$allroles}) {
2859: my %thesepriv=();
2860: if (($_=~/^au/) || ($_=~/^ca/)) { $author=1; }
2861: foreach (split(/:/,$$allroles{$_})) {
2862: if ($_ ne '') {
2863: my ($privilege,$restrictions)=split(/&/,$_);
2864: if ($restrictions eq '') {
2865: $thesepriv{$privilege}='F';
2866: } elsif ($thesepriv{$privilege} ne 'F') {
2867: $thesepriv{$privilege}.=$restrictions;
2868: }
2869: if ($thesepriv{'adv'} eq 'F') { $adv=1; }
2870: }
2871: }
2872: my $thesestr='';
2873: foreach (keys %thesepriv) { $thesestr.=':'.$_.'&'.$thesepriv{$_}; }
1.743 albertel 2874: $userroles->{'user.priv.'.$_} = $thesestr;
1.567 raeburn 2875: }
2876: return ($author,$adv);
2877: }
2878:
1.12 www 2879: # --------------------------------------------------------------- get interface
2880:
2881: sub get {
1.131 albertel 2882: my ($namespace,$storearr,$udomain,$uname)=@_;
1.12 www 2883: my $items='';
1.191 harris41 2884: foreach (@$storearr) {
1.12 www 2885: $items.=escape($_).'&';
1.191 harris41 2886: }
1.12 www 2887: $items=~s/\&$//;
1.620 albertel 2888: if (!$udomain) { $udomain=$env{'user.domain'}; }
2889: if (!$uname) { $uname=$env{'user.name'}; }
1.131 albertel 2890: my $uhome=&homeserver($uname,$udomain);
2891:
1.133 albertel 2892: my $rep=&reply("get:$udomain:$uname:$namespace:$items",$uhome);
1.15 www 2893: my @pairs=split(/\&/,$rep);
1.273 albertel 2894: if ( $#pairs==0 && $pairs[0] =~ /^(con_lost|error|no_such_host)/i) {
2895: return @pairs;
2896: }
1.15 www 2897: my %returnhash=();
1.42 www 2898: my $i=0;
1.191 harris41 2899: foreach (@$storearr) {
1.557 albertel 2900: $returnhash{$_}=&thaw_unescape($pairs[$i]);
1.42 www 2901: $i++;
1.191 harris41 2902: }
1.15 www 2903: return %returnhash;
1.27 www 2904: }
2905:
2906: # --------------------------------------------------------------- del interface
2907:
2908: sub del {
1.133 albertel 2909: my ($namespace,$storearr,$udomain,$uname)=@_;
1.27 www 2910: my $items='';
1.191 harris41 2911: foreach (@$storearr) {
1.27 www 2912: $items.=escape($_).'&';
1.191 harris41 2913: }
1.27 www 2914: $items=~s/\&$//;
1.620 albertel 2915: if (!$udomain) { $udomain=$env{'user.domain'}; }
2916: if (!$uname) { $uname=$env{'user.name'}; }
1.133 albertel 2917: my $uhome=&homeserver($uname,$udomain);
2918:
2919: return &reply("del:$udomain:$uname:$namespace:$items",$uhome);
1.15 www 2920: }
2921:
2922: # -------------------------------------------------------------- dump interface
2923:
2924: sub dump {
1.702 albertel 2925: my ($namespace,$udomain,$uname,$regexp,$range)=@_;
1.620 albertel 2926: if (!$udomain) { $udomain=$env{'user.domain'}; }
2927: if (!$uname) { $uname=$env{'user.name'}; }
1.129 albertel 2928: my $uhome=&homeserver($uname,$udomain);
1.193 www 2929: if ($regexp) {
2930: $regexp=&escape($regexp);
2931: } else {
2932: $regexp='.';
2933: }
1.702 albertel 2934: my $rep=reply("dump:$udomain:$uname:$namespace:$regexp:$range",$uhome);
1.12 www 2935: my @pairs=split(/\&/,$rep);
2936: my %returnhash=();
1.191 harris41 2937: foreach (@pairs) {
1.702 albertel 2938: my ($key,$value)=split(/=/,$_,2);
1.557 albertel 2939: $returnhash{unescape($key)}=&thaw_unescape($value);
1.318 matthew 2940: }
2941: return %returnhash;
1.407 www 2942: }
2943:
1.717 albertel 2944: # --------------------------------------------------------- dumpstore interface
2945:
2946: sub dumpstore {
2947: my ($namespace,$udomain,$uname,$regexp,$range)=@_;
2948: return &dump($namespace,$udomain,$uname,$regexp,$range);
2949: }
2950:
1.407 www 2951: # -------------------------------------------------------------- keys interface
2952:
2953: sub getkeys {
2954: my ($namespace,$udomain,$uname)=@_;
1.620 albertel 2955: if (!$udomain) { $udomain=$env{'user.domain'}; }
2956: if (!$uname) { $uname=$env{'user.name'}; }
1.407 www 2957: my $uhome=&homeserver($uname,$udomain);
2958: my $rep=reply("keys:$udomain:$uname:$namespace",$uhome);
2959: my @keyarray=();
2960: foreach (split(/\&/,$rep)) {
2961: push (@keyarray,&unescape($_));
2962: }
2963: return @keyarray;
1.318 matthew 2964: }
2965:
1.319 matthew 2966: # --------------------------------------------------------------- currentdump
2967: sub currentdump {
1.328 matthew 2968: my ($courseid,$sdom,$sname)=@_;
1.620 albertel 2969: $courseid = $env{'request.course.id'} if (! defined($courseid));
2970: $sdom = $env{'user.domain'} if (! defined($sdom));
2971: $sname = $env{'user.name'} if (! defined($sname));
1.326 matthew 2972: my $uhome = &homeserver($sname,$sdom);
2973: my $rep=reply('currentdump:'.$sdom.':'.$sname.':'.$courseid,$uhome);
1.318 matthew 2974: return if ($rep =~ /^(error:|no_such_host)/);
1.319 matthew 2975: #
1.318 matthew 2976: my %returnhash=();
1.319 matthew 2977: #
2978: if ($rep eq "unknown_cmd") {
2979: # an old lond will not know currentdump
2980: # Do a dump and make it look like a currentdump
1.326 matthew 2981: my @tmp = &dump($courseid,$sdom,$sname,'.');
1.319 matthew 2982: return if ($tmp[0] =~ /^(error:|no_such_host)/);
2983: my %hash = @tmp;
2984: @tmp=();
1.424 matthew 2985: %returnhash = %{&convert_dump_to_currentdump(\%hash)};
1.319 matthew 2986: } else {
2987: my @pairs=split(/\&/,$rep);
2988: foreach (@pairs) {
2989: my ($key,$value)=split(/=/,$_);
2990: my ($symb,$param) = split(/:/,$key);
2991: $returnhash{&unescape($symb)}->{&unescape($param)} =
1.557 albertel 2992: &thaw_unescape($value);
1.319 matthew 2993: }
1.191 harris41 2994: }
1.12 www 2995: return %returnhash;
1.424 matthew 2996: }
2997:
2998: sub convert_dump_to_currentdump{
2999: my %hash = %{shift()};
3000: my %returnhash;
3001: # Code ripped from lond, essentially. The only difference
3002: # here is the unescaping done by lonnet::dump(). Conceivably
3003: # we might run in to problems with parameter names =~ /^v\./
3004: while (my ($key,$value) = each(%hash)) {
3005: my ($v,$symb,$param) = split(/:/,$key);
3006: next if ($v eq 'version' || $symb eq 'keys');
3007: next if (exists($returnhash{$symb}) &&
3008: exists($returnhash{$symb}->{$param}) &&
3009: $returnhash{$symb}->{'v.'.$param} > $v);
3010: $returnhash{$symb}->{$param}=$value;
3011: $returnhash{$symb}->{'v.'.$param}=$v;
3012: }
3013: #
3014: # Remove all of the keys in the hashes which keep track of
3015: # the version of the parameter.
3016: while (my ($symb,$param_hash) = each(%returnhash)) {
3017: # use a foreach because we are going to delete from the hash.
3018: foreach my $key (keys(%$param_hash)) {
3019: delete($param_hash->{$key}) if ($key =~ /^v\./);
3020: }
3021: }
3022: return \%returnhash;
1.12 www 3023: }
3024:
1.627 albertel 3025: # ------------------------------------------------------ critical inc interface
3026:
3027: sub cinc {
3028: return &inc(@_,'critical');
3029: }
3030:
1.449 matthew 3031: # --------------------------------------------------------------- inc interface
3032:
3033: sub inc {
1.627 albertel 3034: my ($namespace,$store,$udomain,$uname,$critical) = @_;
1.620 albertel 3035: if (!$udomain) { $udomain=$env{'user.domain'}; }
3036: if (!$uname) { $uname=$env{'user.name'}; }
1.449 matthew 3037: my $uhome=&homeserver($uname,$udomain);
3038: my $items='';
3039: if (! ref($store)) {
3040: # got a single value, so use that instead
3041: $items = &escape($store).'=&';
3042: } elsif (ref($store) eq 'SCALAR') {
3043: $items = &escape($$store).'=&';
3044: } elsif (ref($store) eq 'ARRAY') {
3045: $items = join('=&',map {&escape($_);} @{$store});
3046: } elsif (ref($store) eq 'HASH') {
3047: while (my($key,$value) = each(%{$store})) {
3048: $items.= &escape($key).'='.&escape($value).'&';
3049: }
3050: }
3051: $items=~s/\&$//;
1.627 albertel 3052: if ($critical) {
3053: return &critical("inc:$udomain:$uname:$namespace:$items",$uhome);
3054: } else {
3055: return &reply("inc:$udomain:$uname:$namespace:$items",$uhome);
3056: }
1.449 matthew 3057: }
3058:
1.12 www 3059: # --------------------------------------------------------------- put interface
3060:
3061: sub put {
1.134 albertel 3062: my ($namespace,$storehash,$udomain,$uname)=@_;
1.620 albertel 3063: if (!$udomain) { $udomain=$env{'user.domain'}; }
3064: if (!$uname) { $uname=$env{'user.name'}; }
1.134 albertel 3065: my $uhome=&homeserver($uname,$udomain);
1.12 www 3066: my $items='';
1.191 harris41 3067: foreach (keys %$storehash) {
1.557 albertel 3068: $items.=&escape($_).'='.&freeze_escape($$storehash{$_}).'&';
1.191 harris41 3069: }
1.12 www 3070: $items=~s/\&$//;
1.134 albertel 3071: return &reply("put:$udomain:$uname:$namespace:$items",$uhome);
1.47 www 3072: }
3073:
1.631 albertel 3074: # ------------------------------------------------------------ newput interface
3075:
3076: sub newput {
3077: my ($namespace,$storehash,$udomain,$uname)=@_;
3078: if (!$udomain) { $udomain=$env{'user.domain'}; }
3079: if (!$uname) { $uname=$env{'user.name'}; }
3080: my $uhome=&homeserver($uname,$udomain);
3081: my $items='';
3082: foreach my $key (keys(%$storehash)) {
3083: $items.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
3084: }
3085: $items=~s/\&$//;
3086: return &reply("newput:$udomain:$uname:$namespace:$items",$uhome);
3087: }
3088:
3089: # --------------------------------------------------------- putstore interface
3090:
1.524 raeburn 3091: sub putstore {
1.715 albertel 3092: my ($namespace,$symb,$version,$storehash,$udomain,$uname)=@_;
1.620 albertel 3093: if (!$udomain) { $udomain=$env{'user.domain'}; }
3094: if (!$uname) { $uname=$env{'user.name'}; }
1.524 raeburn 3095: my $uhome=&homeserver($uname,$udomain);
3096: my $items='';
1.715 albertel 3097: foreach my $key (keys(%$storehash)) {
3098: $items.= &escape($key).'='.&freeze_escape($storehash->{$key}).'&';
1.524 raeburn 3099: }
1.715 albertel 3100: $items=~s/\&$//;
1.716 albertel 3101: my $esc_symb=&escape($symb);
3102: my $esc_v=&escape($version);
1.715 albertel 3103: my $reply =
1.716 albertel 3104: &reply("putstore:$udomain:$uname:$namespace:$esc_symb:$esc_v:$items",
1.715 albertel 3105: $uhome);
3106: if ($reply eq 'unknown_cmd') {
1.716 albertel 3107: # gfall back to way things use to be done
1.715 albertel 3108: return &old_putstore($namespace,$symb,$version,$storehash,$udomain,
3109: $uname);
1.524 raeburn 3110: }
1.715 albertel 3111: return $reply;
3112: }
3113:
3114: sub old_putstore {
1.716 albertel 3115: my ($namespace,$symb,$version,$storehash,$udomain,$uname)=@_;
3116: if (!$udomain) { $udomain=$env{'user.domain'}; }
3117: if (!$uname) { $uname=$env{'user.name'}; }
3118: my $uhome=&homeserver($uname,$udomain);
3119: my %newstorehash;
3120: foreach (keys %$storehash) {
3121: my $key = $version.':'.&escape($symb).':'.$_;
3122: $newstorehash{$key} = $storehash->{$_};
3123: }
3124: my $items='';
3125: my %allitems = ();
3126: foreach (keys %newstorehash) {
3127: if ($_ =~ m/^([^\:]+):([^\:]+):([^\:]+)$/) {
3128: my $key = $1.':keys:'.$2;
3129: $allitems{$key} .= $3.':';
3130: }
3131: $items.=$_.'='.&freeze_escape($newstorehash{$_}).'&';
3132: }
3133: foreach (keys %allitems) {
3134: $allitems{$_} =~ s/\:$//;
3135: $items.= $_.'='.$allitems{$_}.'&';
3136: }
3137: $items=~s/\&$//;
3138: return &reply("put:$udomain:$uname:$namespace:$items",$uhome);
1.524 raeburn 3139: }
3140:
1.47 www 3141: # ------------------------------------------------------ critical put interface
3142:
3143: sub cput {
1.134 albertel 3144: my ($namespace,$storehash,$udomain,$uname)=@_;
1.620 albertel 3145: if (!$udomain) { $udomain=$env{'user.domain'}; }
3146: if (!$uname) { $uname=$env{'user.name'}; }
1.134 albertel 3147: my $uhome=&homeserver($uname,$udomain);
1.47 www 3148: my $items='';
1.191 harris41 3149: foreach (keys %$storehash) {
1.715 albertel 3150: $items.=&escape($_).'='.&freeze_escape($$storehash{$_}).'&';
1.191 harris41 3151: }
1.47 www 3152: $items=~s/\&$//;
1.134 albertel 3153: return &critical("put:$udomain:$uname:$namespace:$items",$uhome);
1.12 www 3154: }
3155:
3156: # -------------------------------------------------------------- eget interface
3157:
3158: sub eget {
1.133 albertel 3159: my ($namespace,$storearr,$udomain,$uname)=@_;
1.12 www 3160: my $items='';
1.191 harris41 3161: foreach (@$storearr) {
1.12 www 3162: $items.=escape($_).'&';
1.191 harris41 3163: }
1.12 www 3164: $items=~s/\&$//;
1.620 albertel 3165: if (!$udomain) { $udomain=$env{'user.domain'}; }
3166: if (!$uname) { $uname=$env{'user.name'}; }
1.133 albertel 3167: my $uhome=&homeserver($uname,$udomain);
3168: my $rep=&reply("eget:$udomain:$uname:$namespace:$items",$uhome);
1.12 www 3169: my @pairs=split(/\&/,$rep);
3170: my %returnhash=();
1.42 www 3171: my $i=0;
1.191 harris41 3172: foreach (@$storearr) {
1.557 albertel 3173: $returnhash{$_}=&thaw_unescape($pairs[$i]);
1.42 www 3174: $i++;
1.191 harris41 3175: }
1.12 www 3176: return %returnhash;
3177: }
3178:
1.667 albertel 3179: # ------------------------------------------------------------ tmpput interface
3180: sub tmpput {
3181: my ($storehash,$server)=@_;
3182: my $items='';
3183: foreach (keys(%$storehash)) {
3184: $items.=&escape($_).'='.&freeze_escape($$storehash{$_}).'&';
3185: }
3186: $items=~s/\&$//;
3187: return &reply("tmpput:$items",$server);
3188: }
3189:
3190: # ------------------------------------------------------------ tmpget interface
3191: sub tmpget {
1.688 albertel 3192: my ($token,$server)=@_;
3193: if (!defined($server)) { $server = $perlvar{'lonHostID'}; }
3194: my $rep=&reply("tmpget:$token",$server);
1.667 albertel 3195: my %returnhash;
3196: foreach my $item (split(/\&/,$rep)) {
3197: my ($key,$value)=split(/=/,$item);
3198: $returnhash{&unescape($key)}=&thaw_unescape($value);
3199: }
3200: return %returnhash;
3201: }
3202:
1.688 albertel 3203: # ------------------------------------------------------------ tmpget interface
3204: sub tmpdel {
3205: my ($token,$server)=@_;
3206: if (!defined($server)) { $server = $perlvar{'lonHostID'}; }
3207: return &reply("tmpdel:$token",$server);
3208: }
3209:
1.341 www 3210: # ---------------------------------------------- Custom access rule evaluation
3211:
3212: sub customaccess {
3213: my ($priv,$uri)=@_;
1.620 albertel 3214: my ($urole,$urealm)=split(/\./,$env{'request.role'});
1.343 www 3215: $urealm=~s/^\W//;
3216: my ($udom,$ucrs,$usec)=split(/\//,$urealm);
1.341 www 3217: my $access=0;
3218: foreach (split(/\s*\,\s*/,&metadata($uri,'rule_rights'))) {
1.342 www 3219: my ($effect,$realm,$role)=split(/\:/,$_);
1.343 www 3220: if ($role) {
3221: if ($role ne $urole) { next; }
3222: }
3223: foreach (split(/\s*\,\s*/,$realm)) {
3224: my ($tdom,$tcrs,$tsec)=split(/\_/,$_);
3225: if ($tdom) {
3226: if ($tdom ne $udom) { next; }
3227: }
3228: if ($tcrs) {
3229: if ($tcrs ne $ucrs) { next; }
3230: }
3231: if ($tsec) {
3232: if ($tsec ne $usec) { next; }
3233: }
3234: $access=($effect eq 'allow');
3235: last;
1.342 www 3236: }
1.402 bowersj2 3237: if ($realm eq '' && $role eq '') {
3238: $access=($effect eq 'allow');
3239: }
1.341 www 3240: }
3241: return $access;
3242: }
3243:
1.103 harris41 3244: # ------------------------------------------------- Check for a user privilege
1.12 www 3245:
3246: sub allowed {
1.579 albertel 3247: my ($priv,$uri,$symb)=@_;
1.705 albertel 3248: my $ver_orguri=$uri;
1.439 www 3249: $uri=&deversion($uri);
1.152 www 3250: my $orguri=$uri;
1.52 www 3251: $uri=&declutter($uri);
1.545 banghart 3252:
1.620 albertel 3253: if (defined($env{'allowed.'.$priv})) { return $env{'allowed.'.$priv}; }
1.54 www 3254: # Free bre access to adm and meta resources
1.529 albertel 3255: if (((($uri=~/^adm\//) && ($uri !~ m|/bulletinboard$|))
3256: || ($uri=~/\.meta$/)) && ($priv eq 'bre')) {
1.14 www 3257: return 'F';
1.159 www 3258: }
3259:
1.545 banghart 3260: # Free bre access to user's own portfolio contents
1.714 raeburn 3261: my ($space,$domain,$name,@dir)=split('/',$uri);
1.647 raeburn 3262: if (($space=~/^(uploaded|editupload)$/) && ($env{'user.name'} eq $name) &&
1.714 raeburn 3263: ($env{'user.domain'} eq $domain) && ('portfolio' eq $dir[0])) {
1.545 banghart 3264: return 'F';
3265: }
3266:
1.714 raeburn 3267: # bre access to group if user has rgf priv for this group and course.
3268: if (($space=~/^(uploaded|editupload)$/) && ($dir[0] eq 'groups')
3269: && ($dir[2] eq 'portfolio') && ($priv eq 'bre')) {
3270: if (exists($env{'request.course.id'})) {
3271: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
3272: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
3273: if (($domain eq $cdom) && ($name eq $cnum)) {
3274: my $courseprivid=$env{'request.course.id'};
3275: $courseprivid=~s/\_/\//;
3276: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid
3277: .'/'.$dir[1]} =~/rgf\&([^\:]*)/) {
3278: return $1;
3279: }
3280: }
3281: }
3282: }
3283:
1.159 www 3284: # Free bre to public access
3285:
3286: if ($priv eq 'bre') {
1.238 www 3287: my $copyright=&metadata($uri,'copyright');
1.620 albertel 3288: if (($copyright eq 'public') && (!$env{'request.course.id'})) {
1.301 www 3289: return 'F';
3290: }
1.238 www 3291: if ($copyright eq 'priv') {
3292: $uri=~/([^\/]+)\/([^\/]+)\//;
1.620 albertel 3293: unless (($env{'user.name'} eq $2) && ($env{'user.domain'} eq $1)) {
1.238 www 3294: return '';
3295: }
3296: }
3297: if ($copyright eq 'domain') {
3298: $uri=~/([^\/]+)\/([^\/]+)\//;
1.620 albertel 3299: unless (($env{'user.domain'} eq $1) ||
3300: ($env{'course.'.$env{'request.course.id'}.'.domain'} eq $1)) {
1.238 www 3301: return '';
3302: }
1.262 matthew 3303: }
1.620 albertel 3304: if ($env{'request.role'}=~ /li\.\//) {
1.262 matthew 3305: # Library role, so allow browsing of resources in this domain.
3306: return 'F';
1.238 www 3307: }
1.341 www 3308: if ($copyright eq 'custom') {
3309: unless (&customaccess($priv,$uri)) { return ''; }
3310: }
1.14 www 3311: }
1.264 matthew 3312: # Domain coordinator is trying to create a course
1.620 albertel 3313: if (($priv eq 'ccc') && ($env{'request.role'} =~ /^dc\./)) {
1.264 matthew 3314: # uri is the requested domain in this case.
3315: # comparison to 'request.role.domain' shows if the user has selected
1.678 raeburn 3316: # a role of dc for the domain in question.
1.620 albertel 3317: return 'F' if ($uri eq $env{'request.role.domain'});
1.264 matthew 3318: }
1.29 www 3319:
1.52 www 3320: my $thisallowed='';
3321: my $statecond=0;
3322: my $courseprivid='';
3323:
3324: # Course
3325:
1.620 albertel 3326: if ($env{'user.priv.'.$env{'request.role'}.'./'}=~/\Q$priv\E\&([^\:]*)/) {
1.52 www 3327: $thisallowed.=$1;
3328: }
1.29 www 3329:
1.52 www 3330: # Domain
3331:
1.620 albertel 3332: if ($env{'user.priv.'.$env{'request.role'}.'./'.(split(/\//,$uri))[0].'/'}
1.479 albertel 3333: =~/\Q$priv\E\&([^\:]*)/) {
1.12 www 3334: $thisallowed.=$1;
3335: }
1.52 www 3336:
3337: # Course: uri itself is a course
1.66 www 3338: my $courseuri=$uri;
3339: $courseuri=~s/\_(\d)/\/$1/;
1.83 www 3340: $courseuri=~s/^([^\/])/\/$1/;
1.81 www 3341:
1.620 albertel 3342: if ($env{'user.priv.'.$env{'request.role'}.'.'.$courseuri}
1.479 albertel 3343: =~/\Q$priv\E\&([^\:]*)/) {
1.12 www 3344: $thisallowed.=$1;
3345: }
1.29 www 3346:
1.678 raeburn 3347: # Group: uri itself is a group
3348: my $groupuri=$uri;
3349: $groupuri=~s/^([^\/])/\/$1/;
3350: if ($env{'user.priv.'.$env{'request.role'}.'.'.$groupuri}
3351: =~/\Q$priv\E\&([^\:]*)/) {
3352: $thisallowed.=$1;
3353: }
3354:
1.665 albertel 3355: # URI is an uploaded document for this course, default permissions don't matter
1.611 albertel 3356: # not allowing 'edit' access (editupload) to uploaded course docs
1.492 albertel 3357: if (($priv eq 'bre') && ($uri=~m|^uploaded/|)) {
1.665 albertel 3358: $thisallowed='';
1.671 raeburn 3359: my ($match)=&is_on_map($uri);
3360: if ($match) {
3361: if ($env{'user.priv.'.$env{'request.role'}.'./'}
3362: =~/\Q$priv\E\&([^\:]*)/) {
3363: $thisallowed.=$1;
3364: }
3365: } else {
1.705 albertel 3366: my $refuri = $env{'httpref.'.$orguri} || $env{'httpref.'.$ver_orguri};
1.671 raeburn 3367: if ($refuri) {
3368: if ($refuri =~ m|^/adm/|) {
1.669 raeburn 3369: $thisallowed='F';
1.671 raeburn 3370: } else {
3371: $refuri=&declutter($refuri);
3372: my ($match) = &is_on_map($refuri);
3373: if ($match) {
3374: $thisallowed='F';
3375: }
1.669 raeburn 3376: }
1.671 raeburn 3377: }
3378: }
1.314 www 3379: }
1.492 albertel 3380:
1.52 www 3381: # Full access at system, domain or course-wide level? Exit.
1.29 www 3382:
3383: if ($thisallowed=~/F/) {
3384: return 'F';
3385: }
3386:
1.52 www 3387: # If this is generating or modifying users, exit with special codes
1.29 www 3388:
1.643 www 3389: if (':csu:cdc:ccc:cin:cta:cep:ccr:cst:cad:cli:cau:cdg:cca:caa:'=~/\:\Q$priv\E\:/) {
3390: if (($priv eq 'cca') || ($priv eq 'caa')) {
1.642 albertel 3391: my ($audom,$auname)=split('/',$uri);
1.643 www 3392: # no author name given, so this just checks on the general right to make a co-author in this domain
3393: unless ($auname) { return $thisallowed; }
3394: # an author name is given, so we are about to actually make a co-author for a certain account
1.642 albertel 3395: if (($auname ne $env{'user.name'} && $env{'request.role'} !~ /^dc\./) ||
3396: (($audom ne $env{'user.domain'} && $env{'request.role'} !~ /^dc\./) &&
3397: ($audom ne $env{'request.role.domain'}))) { return ''; }
3398: }
1.52 www 3399: return $thisallowed;
3400: }
3401: #
1.103 harris41 3402: # Gathered so far: system, domain and course wide privileges
1.52 www 3403: #
3404: # Course: See if uri or referer is an individual resource that is part of
3405: # the course
3406:
1.620 albertel 3407: if ($env{'request.course.id'}) {
1.232 www 3408:
1.620 albertel 3409: $courseprivid=$env{'request.course.id'};
3410: if ($env{'request.course.sec'}) {
3411: $courseprivid.='/'.$env{'request.course.sec'};
1.52 www 3412: }
3413: $courseprivid=~s/\_/\//;
3414: my $checkreferer=1;
1.232 www 3415: my ($match,$cond)=&is_on_map($uri);
3416: if ($match) {
3417: $statecond=$cond;
1.620 albertel 3418: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid}
1.479 albertel 3419: =~/\Q$priv\E\&([^\:]*)/) {
1.52 www 3420: $thisallowed.=$1;
3421: $checkreferer=0;
3422: }
1.29 www 3423: }
1.83 www 3424:
1.148 www 3425: if ($checkreferer) {
1.620 albertel 3426: my $refuri=$env{'httpref.'.$orguri};
1.148 www 3427: unless ($refuri) {
1.620 albertel 3428: foreach (keys %env) {
1.148 www 3429: if ($_=~/^httpref\..*\*/) {
3430: my $pattern=$_;
1.156 www 3431: $pattern=~s/^httpref\.\/res\///;
1.148 www 3432: $pattern=~s/\*/\[\^\/\]\+/g;
3433: $pattern=~s/\//\\\//g;
1.152 www 3434: if ($orguri=~/$pattern/) {
1.620 albertel 3435: $refuri=$env{$_};
1.148 www 3436: }
3437: }
1.191 harris41 3438: }
1.148 www 3439: }
1.232 www 3440:
1.148 www 3441: if ($refuri) {
1.152 www 3442: $refuri=&declutter($refuri);
1.232 www 3443: my ($match,$cond)=&is_on_map($refuri);
3444: if ($match) {
3445: my $refstatecond=$cond;
1.620 albertel 3446: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid}
1.479 albertel 3447: =~/\Q$priv\E\&([^\:]*)/) {
1.52 www 3448: $thisallowed.=$1;
1.53 www 3449: $uri=$refuri;
3450: $statecond=$refstatecond;
1.52 www 3451: }
3452: }
1.148 www 3453: }
1.29 www 3454: }
1.52 www 3455: }
1.29 www 3456:
1.52 www 3457: #
1.103 harris41 3458: # Gathered now: all privileges that could apply, and condition number
1.52 www 3459: #
3460: #
3461: # Full or no access?
3462: #
1.29 www 3463:
1.52 www 3464: if ($thisallowed=~/F/) {
3465: return 'F';
3466: }
1.29 www 3467:
1.52 www 3468: unless ($thisallowed) {
3469: return '';
3470: }
1.29 www 3471:
1.52 www 3472: # Restrictions exist, deal with them
3473: #
3474: # C:according to course preferences
3475: # R:according to resource settings
3476: # L:unless locked
3477: # X:according to user session state
3478: #
3479:
3480: # Possibly locked functionality, check all courses
1.54 www 3481: # Locks might take effect only after 10 minutes cache expiration for other
3482: # courses, and 2 minutes for current course
1.52 www 3483:
3484: my $envkey;
3485: if ($thisallowed=~/L/) {
1.620 albertel 3486: foreach $envkey (keys %env) {
1.54 www 3487: if ($envkey=~/^user\.role\.(st|ta)\.([^\.]*)/) {
3488: my $courseid=$2;
3489: my $roleid=$1.'.'.$2;
1.92 www 3490: $courseid=~s/^\///;
1.54 www 3491: my $expiretime=600;
1.620 albertel 3492: if ($env{'request.role'} eq $roleid) {
1.54 www 3493: $expiretime=120;
3494: }
3495: my ($cdom,$cnum,$csec)=split(/\//,$courseid);
3496: my $prefix='course.'.$cdom.'_'.$cnum.'.';
1.620 albertel 3497: if ((time-$env{$prefix.'last_cache'})>$expiretime) {
1.731 albertel 3498: &coursedescription($courseid,{'freshen_cache' => 1});
1.54 www 3499: }
1.620 albertel 3500: if (($env{$prefix.'res.'.$uri.'.lock.sections'}=~/\,\Q$csec\E\,/)
3501: || ($env{$prefix.'res.'.$uri.'.lock.sections'} eq 'all')) {
3502: if ($env{$prefix.'res.'.$uri.'.lock.expire'}>time) {
3503: &log($env{'user.domain'},$env{'user.name'},
3504: $env{'user.home'},
1.57 www 3505: 'Locked by res: '.$priv.' for '.$uri.' due to '.
1.52 www 3506: $cdom.'/'.$cnum.'/'.$csec.' expire '.
1.620 albertel 3507: $env{$prefix.'priv.'.$priv.'.lock.expire'});
1.52 www 3508: return '';
3509: }
3510: }
1.620 albertel 3511: if (($env{$prefix.'priv.'.$priv.'.lock.sections'}=~/\,\Q$csec\E\,/)
3512: || ($env{$prefix.'priv.'.$priv.'.lock.sections'} eq 'all')) {
3513: if ($env{'priv.'.$priv.'.lock.expire'}>time) {
3514: &log($env{'user.domain'},$env{'user.name'},
3515: $env{'user.home'},
1.57 www 3516: 'Locked by priv: '.$priv.' for '.$uri.' due to '.
1.52 www 3517: $cdom.'/'.$cnum.'/'.$csec.' expire '.
1.620 albertel 3518: $env{$prefix.'priv.'.$priv.'.lock.expire'});
1.52 www 3519: return '';
3520: }
3521: }
3522: }
1.29 www 3523: }
1.52 www 3524: }
3525:
3526: #
3527: # Rest of the restrictions depend on selected course
3528: #
3529:
1.620 albertel 3530: unless ($env{'request.course.id'}) {
1.52 www 3531: return '1';
3532: }
1.29 www 3533:
1.52 www 3534: #
3535: # Now user is definitely in a course
3536: #
1.53 www 3537:
3538:
3539: # Course preferences
3540:
3541: if ($thisallowed=~/C/) {
1.620 albertel 3542: my $rolecode=(split(/\./,$env{'request.role'}))[0];
3543: my $unamedom=$env{'user.name'}.':'.$env{'user.domain'};
3544: if ($env{'course.'.$env{'request.course.id'}.'.'.$priv.'.roles.denied'}
1.479 albertel 3545: =~/\Q$rolecode\E/) {
1.689 albertel 3546: if ($priv ne 'pch') {
3547: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.':'.
3548: 'Denied by role: '.$priv.' for '.$uri.' as '.$rolecode.' in '.
3549: $env{'request.course.id'});
3550: }
1.237 www 3551: return '';
3552: }
3553:
1.620 albertel 3554: if ($env{'course.'.$env{'request.course.id'}.'.'.$priv.'.users.denied'}
1.479 albertel 3555: =~/\Q$unamedom\E/) {
1.689 albertel 3556: if ($priv ne 'pch') {
3557: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.
3558: 'Denied by user: '.$priv.' for '.$uri.' as '.$unamedom.' in '.
3559: $env{'request.course.id'});
3560: }
1.54 www 3561: return '';
3562: }
1.53 www 3563: }
3564:
3565: # Resource preferences
3566:
3567: if ($thisallowed=~/R/) {
1.620 albertel 3568: my $rolecode=(split(/\./,$env{'request.role'}))[0];
1.479 albertel 3569: if (&metadata($uri,'roledeny')=~/\Q$rolecode\E/) {
1.689 albertel 3570: if ($priv ne 'pch') {
3571: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.':'.
3572: 'Denied by role: '.$priv.' for '.$uri.' as '.$rolecode);
3573: }
3574: return '';
1.54 www 3575: }
1.53 www 3576: }
1.30 www 3577:
1.246 www 3578: # Restricted by state or randomout?
1.30 www 3579:
1.52 www 3580: if ($thisallowed=~/X/) {
1.620 albertel 3581: if ($env{'acc.randomout'}) {
1.579 albertel 3582: if (!$symb) { $symb=&symbread($uri,1); }
1.620 albertel 3583: if (($symb) && ($env{'acc.randomout'}=~/\&\Q$symb\E\&/)) {
1.248 www 3584: return '';
3585: }
1.247 www 3586: }
3587: if (&condval($statecond)) {
1.52 www 3588: return '2';
3589: } else {
3590: return '';
3591: }
3592: }
1.30 www 3593:
1.52 www 3594: return 'F';
1.232 www 3595: }
3596:
1.710 albertel 3597: sub split_uri_for_cond {
3598: my $uri=&deversion(&declutter(shift));
3599: my @uriparts=split(/\//,$uri);
3600: my $filename=pop(@uriparts);
3601: my $pathname=join('/',@uriparts);
3602: return ($pathname,$filename);
3603: }
1.232 www 3604: # --------------------------------------------------- Is a resource on the map?
3605:
3606: sub is_on_map {
1.710 albertel 3607: my ($pathname,$filename) = &split_uri_for_cond(shift);
1.289 bowersj2 3608: #Trying to find the conditional for the file
1.620 albertel 3609: my $match=($env{'acc.res.'.$env{'request.course.id'}.'.'.$pathname}=~
1.289 bowersj2 3610: /\&\Q$filename\E\:([\d\|]+)\&/);
1.232 www 3611: if ($match) {
1.289 bowersj2 3612: return (1,$1);
3613: } else {
1.434 www 3614: return (0,0);
1.289 bowersj2 3615: }
1.12 www 3616: }
3617:
1.427 www 3618: # --------------------------------------------------------- Get symb from alias
3619:
3620: sub get_symb_from_alias {
3621: my $symb=shift;
3622: my ($map,$resid,$url)=&decode_symb($symb);
3623: # Already is a symb
3624: if ($url) { return $symb; }
3625: # Must be an alias
3626: my $aliassymb='';
3627: my %bighash;
1.620 albertel 3628: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
1.427 www 3629: &GDBM_READER(),0640)) {
3630: my $rid=$bighash{'mapalias_'.$symb};
3631: if ($rid) {
3632: my ($mapid,$resid)=split(/\./,$rid);
1.429 albertel 3633: $aliassymb=&encode_symb($bighash{'map_id_'.$mapid},
3634: $resid,$bighash{'src_'.$rid});
1.427 www 3635: }
3636: untie %bighash;
3637: }
3638: return $aliassymb;
3639: }
3640:
1.12 www 3641: # ----------------------------------------------------------------- Define Role
3642:
3643: sub definerole {
3644: if (allowed('mcr','/')) {
3645: my ($rolename,$sysrole,$domrole,$courole)=@_;
1.392 www 3646: foreach (split(':',$sysrole)) {
1.21 www 3647: my ($crole,$cqual)=split(/\&/,$_);
1.479 albertel 3648: if ($pr{'cr:s'}!~/\Q$crole\E/) { return "refused:s:$crole"; }
3649: if ($pr{'cr:s'}=~/\Q$crole\E\&/) {
3650: if ($pr{'cr:s'}!~/\Q$crole\E\&\w*\Q$cqual\E/) {
1.21 www 3651: return "refused:s:$crole&$cqual";
3652: }
3653: }
1.191 harris41 3654: }
1.392 www 3655: foreach (split(':',$domrole)) {
1.21 www 3656: my ($crole,$cqual)=split(/\&/,$_);
1.479 albertel 3657: if ($pr{'cr:d'}!~/\Q$crole\E/) { return "refused:d:$crole"; }
3658: if ($pr{'cr:d'}=~/\Q$crole\E\&/) {
3659: if ($pr{'cr:d'}!~/\Q$crole\W\&\w*\Q$cqual\E/) {
1.21 www 3660: return "refused:d:$crole&$cqual";
3661: }
3662: }
1.191 harris41 3663: }
1.392 www 3664: foreach (split(':',$courole)) {
1.21 www 3665: my ($crole,$cqual)=split(/\&/,$_);
1.479 albertel 3666: if ($pr{'cr:c'}!~/\Q$crole\E/) { return "refused:c:$crole"; }
3667: if ($pr{'cr:c'}=~/\Q$crole\E\&/) {
3668: if ($pr{'cr:c'}!~/\Q$crole\E\&\w*\Q$cqual\E/) {
1.21 www 3669: return "refused:c:$crole&$cqual";
3670: }
3671: }
1.191 harris41 3672: }
1.620 albertel 3673: my $command="encrypt:rolesput:$env{'user.domain'}:$env{'user.name'}:".
3674: "$env{'user.domain'}:$env{'user.name'}:".
1.21 www 3675: "rolesdef_$rolename=".
3676: escape($sysrole.'_'.$domrole.'_'.$courole);
1.620 albertel 3677: return reply($command,$env{'user.home'});
1.12 www 3678: } else {
3679: return 'refused';
3680: }
1.105 harris41 3681: }
3682:
3683: # ---------------- Make a metadata query against the network of library servers
3684:
3685: sub metadata_query {
1.244 matthew 3686: my ($query,$custom,$customshow,$server_array)=@_;
1.120 harris41 3687: my %rhash;
1.244 matthew 3688: my @server_list = (defined($server_array) ? @$server_array
3689: : keys(%libserv) );
3690: for my $server (@server_list) {
1.118 harris41 3691: unless ($custom or $customshow) {
3692: my $reply=&reply("querysend:".&escape($query),$server);
3693: $rhash{$server}=$reply;
3694: }
3695: else {
3696: my $reply=&reply("querysend:".&escape($query).':'.
3697: &escape($custom).':'.&escape($customshow),
3698: $server);
3699: $rhash{$server}=$reply;
3700: }
1.112 harris41 3701: }
1.118 harris41 3702: return \%rhash;
1.240 www 3703: }
3704:
3705: # ----------------------------------------- Send log queries and wait for reply
3706:
3707: sub log_query {
3708: my ($uname,$udom,$query,%filters)=@_;
3709: my $uhome=&homeserver($uname,$udom);
3710: if ($uhome eq 'no_host') { return 'error: no_host'; }
3711: my $uhost=$hostname{$uhome};
1.241 www 3712: my $command=&escape(join(':',map{$_.'='.$filters{$_}} keys %filters));
1.240 www 3713: my $queryid=&reply("querysend:".$query.':'.$udom.':'.$uname.':'.$command,
3714: $uhome);
1.479 albertel 3715: unless ($queryid=~/^\Q$uhost\E\_/) { return 'error: '.$queryid; }
1.242 www 3716: return get_query_reply($queryid);
3717: }
3718:
1.508 raeburn 3719: # ------- Request retrieval of institutional classlists for course(s)
1.506 raeburn 3720:
3721: sub fetch_enrollment_query {
1.511 raeburn 3722: my ($context,$affiliatesref,$replyref,$dom,$cnum) = @_;
1.508 raeburn 3723: my $homeserver;
1.547 raeburn 3724: my $maxtries = 1;
1.508 raeburn 3725: if ($context eq 'automated') {
3726: $homeserver = $perlvar{'lonHostID'};
1.547 raeburn 3727: $maxtries = 10; # will wait for up to 2000s for retrieval of classlist data before timeout
1.508 raeburn 3728: } else {
3729: $homeserver = &homeserver($cnum,$dom);
3730: }
1.506 raeburn 3731: my $host=$hostname{$homeserver};
3732: my $cmd = '';
3733: foreach (keys %{$affiliatesref}) {
1.508 raeburn 3734: $cmd .= $_.'='.join(",",@{$$affiliatesref{$_}}).'%%';
1.506 raeburn 3735: }
3736: $cmd =~ s/%%$//;
3737: $cmd = &escape($cmd);
3738: my $query = 'fetchenrollment';
1.620 albertel 3739: my $queryid=&reply("querysend:".$query.':'.$dom.':'.$env{'user.name'}.':'.$cmd,$homeserver);
1.526 raeburn 3740: unless ($queryid=~/^\Q$host\E\_/) {
3741: &logthis('fetch_enrollment_query: invalid queryid: '.$queryid.' for host: '.$host.' and homeserver: '.$homeserver.' context: '.$context.' '.$cnum);
3742: return 'error: '.$queryid;
3743: }
1.506 raeburn 3744: my $reply = &get_query_reply($queryid);
1.547 raeburn 3745: my $tries = 1;
3746: while (($reply=~/^timeout/) && ($tries < $maxtries)) {
3747: $reply = &get_query_reply($queryid);
3748: $tries ++;
3749: }
1.526 raeburn 3750: if ( ($reply =~/^timeout/) || ($reply =~/^error/) ) {
1.620 albertel 3751: &logthis('fetch_enrollment_query error: '.$reply.' for '.$dom.' '.$env{'user.name'}.' for '.$queryid.' context: '.$context.' '.$cnum.' maxtries: '.$maxtries.' tries: '.$tries);
1.526 raeburn 3752: } else {
1.515 raeburn 3753: my @responses = split/:/,$reply;
3754: if ($homeserver eq $perlvar{'lonHostID'}) {
3755: foreach (@responses) {
3756: my ($key,$value) = split/=/,$_;
3757: $$replyref{$key} = $value;
3758: }
3759: } else {
1.506 raeburn 3760: my $pathname = $perlvar{'lonDaemons'}.'/tmp';
3761: foreach (@responses) {
3762: my ($key,$value) = split/=/,$_;
3763: $$replyref{$key} = $value;
3764: if ($value > 0) {
3765: foreach (@{$$affiliatesref{$key}}) {
3766: my $filename = $dom.'_'.$key.'_'.$_.'_classlist.xml';
3767: my $destname = $pathname.'/'.$filename;
3768: my $xml_classlist = &reply("autoretrieve:".$filename,$homeserver);
1.526 raeburn 3769: if ($xml_classlist =~ /^error/) {
3770: &logthis('fetch_enrollment_query - autoretrieve error: '.$xml_classlist.' for '.$filename.' from server: '.$homeserver.' '.$context.' '.$cnum);
3771: } else {
1.506 raeburn 3772: if ( open(FILE,">$destname") ) {
3773: print FILE &unescape($xml_classlist);
3774: close(FILE);
1.526 raeburn 3775: } else {
3776: &logthis('fetch_enrollment_query - error opening classlist file '.$destname.' '.$context.' '.$cnum);
1.506 raeburn 3777: }
3778: }
3779: }
3780: }
3781: }
3782: }
3783: return 'ok';
3784: }
3785: return 'error';
3786: }
3787:
1.242 www 3788: sub get_query_reply {
3789: my $queryid=shift;
1.240 www 3790: my $replyfile=$perlvar{'lonDaemons'}.'/tmp/'.$queryid;
3791: my $reply='';
3792: for (1..100) {
3793: sleep 2;
3794: if (-e $replyfile.'.end') {
1.448 albertel 3795: if (open(my $fh,$replyfile)) {
1.240 www 3796: $reply.=<$fh>;
1.448 albertel 3797: close($fh);
1.240 www 3798: } else { return 'error: reply_file_error'; }
1.242 www 3799: return &unescape($reply);
3800: }
1.240 www 3801: }
1.242 www 3802: return 'timeout:'.$queryid;
1.240 www 3803: }
3804:
3805: sub courselog_query {
1.241 www 3806: #
3807: # possible filters:
3808: # url: url or symb
3809: # username
3810: # domain
3811: # action: view, submit, grade
3812: # start: timestamp
3813: # end: timestamp
3814: #
1.240 www 3815: my (%filters)=@_;
1.620 albertel 3816: unless ($env{'request.course.id'}) { return 'no_course'; }
1.241 www 3817: if ($filters{'url'}) {
3818: $filters{'url'}=&symbclean(&declutter($filters{'url'}));
3819: $filters{'url'}=~s/\.(\w+)$/(\\.\\d+)*\\.$1/;
3820: $filters{'url'}=~s/\.(\w+)\_\_\_/(\\.\\d+)*\\.$1/;
3821: }
1.620 albertel 3822: my $cname=$env{'course.'.$env{'request.course.id'}.'.num'};
3823: my $cdom=$env{'course.'.$env{'request.course.id'}.'.domain'};
1.240 www 3824: return &log_query($cname,$cdom,'courselog',%filters);
3825: }
3826:
3827: sub userlog_query {
3828: my ($uname,$udom,%filters)=@_;
3829: return &log_query($uname,$udom,'userlog',%filters);
1.12 www 3830: }
3831:
1.506 raeburn 3832: #--------- Call auto-enrollment subs in localenroll.pm for homeserver for course
3833:
3834: sub auto_run {
1.508 raeburn 3835: my ($cnum,$cdom) = @_;
3836: my $homeserver = &homeserver($cnum,$cdom);
1.511 raeburn 3837: my $response = &reply('autorun:'.$cdom,$homeserver);
1.506 raeburn 3838: return $response;
3839: }
3840:
3841: sub auto_get_sections {
1.508 raeburn 3842: my ($cnum,$cdom,$inst_coursecode) = @_;
3843: my $homeserver = &homeserver($cnum,$cdom);
1.506 raeburn 3844: my @secs = ();
1.511 raeburn 3845: my $response=&unescape(&reply('autogetsections:'.$inst_coursecode.':'.$cdom,$homeserver));
1.506 raeburn 3846: unless ($response eq 'refused') {
3847: @secs = split/:/,$response;
3848: }
3849: return @secs;
3850: }
3851:
3852: sub auto_new_course {
1.508 raeburn 3853: my ($cnum,$cdom,$inst_course_id,$owner) = @_;
3854: my $homeserver = &homeserver($cnum,$cdom);
1.515 raeburn 3855: my $response=&unescape(&reply('autonewcourse:'.$inst_course_id.':'.$owner.':'.$cdom,$homeserver));
1.506 raeburn 3856: return $response;
3857: }
3858:
3859: sub auto_validate_courseID {
1.508 raeburn 3860: my ($cnum,$cdom,$inst_course_id) = @_;
3861: my $homeserver = &homeserver($cnum,$cdom);
1.511 raeburn 3862: my $response=&unescape(&reply('autovalidatecourse:'.$inst_course_id.':'.$cdom,$homeserver));
1.506 raeburn 3863: return $response;
3864: }
3865:
3866: sub auto_create_password {
1.508 raeburn 3867: my ($cnum,$cdom,$authparam) = @_;
3868: my $homeserver = &homeserver($cnum,$cdom);
1.506 raeburn 3869: my $create_passwd = 0;
3870: my $authchk = '';
1.511 raeburn 3871: my $response=&unescape(&reply('autocreatepassword:'.$authparam.':'.$cdom,$homeserver));
1.506 raeburn 3872: if ($response eq 'refused') {
3873: $authchk = 'refused';
3874: } else {
3875: ($authparam,$create_passwd,$authchk) = split/:/,$response;
3876: }
3877: return ($authparam,$create_passwd,$authchk);
3878: }
3879:
1.706 raeburn 3880: sub auto_photo_permission {
3881: my ($cnum,$cdom,$students) = @_;
3882: my $homeserver = &homeserver($cnum,$cdom);
1.707 albertel 3883: my ($outcome,$perm_reqd,$conditions) =
3884: split(/:/,&unescape(&reply('autophotopermission:'.$cdom,$homeserver)),3);
1.709 albertel 3885: if ($outcome =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
3886: return (undef,undef);
3887: }
1.706 raeburn 3888: return ($outcome,$perm_reqd,$conditions);
3889: }
3890:
3891: sub auto_checkphotos {
3892: my ($uname,$udom,$pid) = @_;
3893: my $homeserver = &homeserver($uname,$udom);
3894: my ($result,$resulttype);
3895: my $outcome = &unescape(&reply('autophotocheck:'.&escape($udom).':'.
1.707 albertel 3896: &escape($uname).':'.&escape($pid),
3897: $homeserver));
1.709 albertel 3898: if ($outcome =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
3899: return (undef,undef);
3900: }
1.706 raeburn 3901: if ($outcome) {
3902: ($result,$resulttype) = split(/:/,$outcome);
3903: }
3904: return ($result,$resulttype);
3905: }
3906:
3907: sub auto_photochoice {
3908: my ($cnum,$cdom) = @_;
3909: my $homeserver = &homeserver($cnum,$cdom);
3910: my ($update,$comment) = split(/:/,&unescape(&reply('autophotochoice:'.
1.707 albertel 3911: &escape($cdom),
3912: $homeserver)));
1.709 albertel 3913: if ($update =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
3914: return (undef,undef);
3915: }
1.706 raeburn 3916: return ($update,$comment);
3917: }
3918:
3919: sub auto_photoupdate {
3920: my ($affiliatesref,$dom,$cnum,$photo) = @_;
3921: my $homeserver = &homeserver($cnum,$dom);
3922: my $host=$hostname{$homeserver};
3923: my $cmd = '';
3924: my $maxtries = 1;
3925: foreach (keys %{$affiliatesref}) {
3926: $cmd .= $_.'='.join(",",@{$$affiliatesref{$_}}).'%%';
3927: }
3928: $cmd =~ s/%%$//;
3929: $cmd = &escape($cmd);
3930: my $query = 'institutionalphotos';
3931: my $queryid=&reply("querysend:".$query.':'.$dom.':'.$cnum.':'.$cmd,$homeserver);
3932: unless ($queryid=~/^\Q$host\E\_/) {
3933: &logthis('institutionalphotos: invalid queryid: '.$queryid.' for host: '.$host.' and homeserver: '.$homeserver.' and course: '.$cnum);
3934: return 'error: '.$queryid;
3935: }
3936: my $reply = &get_query_reply($queryid);
3937: my $tries = 1;
3938: while (($reply=~/^timeout/) && ($tries < $maxtries)) {
3939: $reply = &get_query_reply($queryid);
3940: $tries ++;
3941: }
3942: if ( ($reply =~/^timeout/) || ($reply =~/^error/) ) {
3943: &logthis('institutionalphotos error: '.$reply.' for '.$dom.' '.$env{'user.name'}.' for '.$queryid.' course: '.$cnum.' maxtries: '.$maxtries.' tries: '.$tries);
3944: } else {
3945: my @responses = split(/:/,$reply);
3946: my $outcome = shift(@responses);
3947: foreach my $item (@responses) {
3948: my ($key,$value) = split(/=/,$item);
3949: $$photo{$key} = $value;
3950: }
3951: return $outcome;
3952: }
3953: return 'error';
3954: }
3955:
1.521 raeburn 3956: sub auto_instcode_format {
3957: my ($caller,$codedom,$instcodes,$codes,$codetitles,$cat_titles,$cat_order) = @_;
3958: my $courses = '';
3959: my $homeserver;
3960: if ($caller eq 'global') {
1.584 raeburn 3961: foreach my $tryserver (keys %libserv) {
3962: if ($hostdom{$tryserver} eq $codedom) {
3963: $homeserver = $tryserver;
3964: last;
3965: }
3966: }
1.620 albertel 3967: if (($env{'user.name'}) && ($env{'user.domain'} eq $codedom)) {
3968: $homeserver = &homeserver($env{'user.name'},$codedom);
1.584 raeburn 3969: }
1.521 raeburn 3970: } else {
3971: $homeserver = &homeserver($caller,$codedom);
3972: }
3973: foreach (keys %{$instcodes}) {
3974: $courses .= &escape($_).'='.&escape($$instcodes{$_}).'&';
3975: }
3976: chop($courses);
3977: my $response=&reply('autoinstcodeformat:'.$codedom.':'.$courses,$homeserver);
3978: unless ($response =~ /(con_lost|error|no_such_host|refused)/) {
3979: my ($codes_str,$codetitles_str,$cat_titles_str,$cat_order_str) = split/:/,$response;
3980: %{$codes} = &str2hash($codes_str);
3981: @{$codetitles} = &str2array($codetitles_str);
3982: %{$cat_titles} = &str2hash($cat_titles_str);
3983: %{$cat_order} = &str2hash($cat_order_str);
3984: return 'ok';
3985: }
3986: return $response;
3987: }
3988:
1.679 raeburn 3989: # ------------------------------------------------------- Course Group routines
3990:
3991: sub get_coursegroups {
1.683 raeburn 3992: my ($cdom,$cnum,$group) = @_;
3993: return(&dump('coursegroups',$cdom,$cnum,$group));
1.679 raeburn 3994: }
3995:
3996: sub modify_coursegroup {
3997: my ($cdom,$cnum,$groupsettings) = @_;
3998: return(&put('coursegroups',$groupsettings,$cdom,$cnum));
3999: }
4000:
4001: sub modify_group_roles {
4002: my ($cdom,$cnum,$group_id,$user,$end,$start,$userprivs) = @_;
4003: my $url = '/'.$cdom.'/'.$cnum.'/'.$group_id;
4004: my $role = 'gr/'.&escape($userprivs);
4005: my ($uname,$udom) = split(/:/,$user);
4006: my $result = &assignrole($udom,$uname,$url,$role,$end,$start);
1.684 raeburn 4007: if ($result eq 'ok') {
4008: &devalidate_getgroups_cache($udom,$uname,$cdom,$cnum);
4009: }
1.679 raeburn 4010: return $result;
4011: }
4012:
4013: sub modify_coursegroup_membership {
4014: my ($cdom,$cnum,$membership) = @_;
4015: my $result = &put('groupmembership',$membership,$cdom,$cnum);
4016: return $result;
4017: }
4018:
1.682 raeburn 4019: sub get_active_groups {
4020: my ($udom,$uname,$cdom,$cnum) = @_;
4021: my $now = time;
4022: my %groups = ();
4023: foreach my $key (keys(%env)) {
4024: if ($key =~ m-user\.role\.gr\./([^/]+)/([^/]+)/(\w+)$-) {
4025: my ($start,$end) = split(/\./,$env{$key});
4026: if (($end!=0) && ($end<$now)) { next; }
4027: if (($start!=0) && ($start>$now)) { next; }
4028: if ($1 eq $cdom && $2 eq $cnum) {
4029: $groups{$3} = $env{$key} ;
4030: }
4031: }
4032: }
4033: return %groups;
4034: }
4035:
1.683 raeburn 4036: sub get_group_membership {
4037: my ($cdom,$cnum,$group) = @_;
4038: return(&dump('groupmembership',$cdom,$cnum,$group));
4039: }
4040:
4041: sub get_users_groups {
4042: my ($udom,$uname,$courseid) = @_;
1.733 raeburn 4043: my @usersgroups;
1.683 raeburn 4044: my $cachetime=1800;
4045: $courseid=~s/\_/\//g;
4046: $courseid=~s/^(\w)/\/$1/;
4047:
4048: my $hashid="$udom:$uname:$courseid";
1.733 raeburn 4049: my ($grouplist,$cached)=&is_cached_new('getgroups',$hashid);
4050: if (defined($cached)) {
1.734 albertel 4051: @usersgroups = split(/:/,$grouplist);
1.733 raeburn 4052: } else {
4053: $grouplist = '';
4054: my %roleshash = &dump('roles',$udom,$uname,$courseid);
4055: my ($tmp) = keys(%roleshash);
4056: if ($tmp=~/^error:/) {
4057: &logthis('Error retrieving roles: '.$tmp.' for '.$uname.':'.$udom);
4058: } else {
4059: my $access_end = $env{'course.'.$courseid.
4060: '.default_enrollment_end_date'};
4061: my $now = time;
1.734 albertel 4062: foreach my $key (keys(%roleshash)) {
1.733 raeburn 4063: if ($key =~ /^\Q$courseid\E\/(\w+)\_gr$/) {
4064: my $group = $1;
4065: if ($roleshash{$key} =~ /_(\d+)_(\d+)$/) {
4066: my $start = $2;
4067: my $end = $1;
4068: if ($start == -1) { next; } # deleted from group
4069: if (($start!=0) && ($start>$now)) { next; }
4070: if (($end!=0) && ($end<$now)) {
4071: if ($access_end && $access_end < $now) {
4072: if ($access_end - $end < 86400) {
4073: push(@usersgroups,$group);
4074: }
4075: }
4076: next;
4077: }
4078: push(@usersgroups,$group);
4079: }
1.683 raeburn 4080: }
4081: }
1.733 raeburn 4082: @usersgroups = &sort_course_groups($courseid,@usersgroups);
4083: $grouplist = join(':',@usersgroups);
4084: &do_cache_new('getgroups',$hashid,$grouplist,$cachetime);
1.683 raeburn 4085: }
4086: }
1.733 raeburn 4087: return @usersgroups;
1.683 raeburn 4088: }
4089:
4090: sub devalidate_getgroups_cache {
4091: my ($udom,$uname,$cdom,$cnum)=@_;
4092: my $courseid = $cdom.'_'.$cnum;
4093: $courseid=~s/\_/\//g;
4094: $courseid=~s/^(\w)/\/$1/;
4095: my $hashid="$udom:$uname:$courseid";
4096: &devalidate_cache_new('getgroups',$hashid);
4097: }
4098:
1.12 www 4099: # ------------------------------------------------------------------ Plain Text
4100:
4101: sub plaintext {
1.742 raeburn 4102: my ($short,$type,$cid) = @_;
4103: if (!defined($cid)) {
4104: $cid = $env{'request.course.id'};
4105: }
4106: if (defined($cid) && defined($env{'course.'.$cid.'.'.$short.'.plaintext'})) {
4107: return &Apache::lonlocal::mt($env{'course.'.$cid.'.'.$short.
4108: '.plaintext'});
4109: }
4110: my %rolenames = (
4111: Course => 'std',
4112: Group => 'alt1',
4113: );
4114: if (defined($type) &&
4115: defined($rolenames{$type}) &&
4116: defined($prp{$short}{$rolenames{$type}})) {
4117: return &Apache::lonlocal::mt($prp{$short}{$rolenames{$type}});
4118: } else {
4119: return &Apache::lonlocal::mt($prp{$short}{'std'});
4120: }
1.12 www 4121: }
4122:
4123: # ----------------------------------------------------------------- Assign Role
4124:
4125: sub assignrole {
1.357 www 4126: my ($udom,$uname,$url,$role,$end,$start,$deleteflag)=@_;
1.21 www 4127: my $mrole;
4128: if ($role =~ /^cr\//) {
1.393 www 4129: my $cwosec=$url;
4130: $cwosec=~s/^\/(\w+)\/(\w+)\/.*/$1\/$2/;
4131: unless (&allowed('ccr',$cwosec)) {
1.104 www 4132: &logthis('Refused custom assignrole: '.
4133: $udom.' '.$uname.' '.$url.' '.$role.' '.$end.' '.$start.' by '.
1.620 albertel 4134: $env{'user.name'}.' at '.$env{'user.domain'});
1.104 www 4135: return 'refused';
4136: }
1.21 www 4137: $mrole='cr';
1.678 raeburn 4138: } elsif ($role =~ /^gr\//) {
4139: my $cwogrp=$url;
4140: $cwogrp=~s/^\/(\w+)\/(\w+)\/.*/$1\/$2/;
4141: unless (&allowed('mdg',$cwogrp)) {
4142: &logthis('Refused group assignrole: '.
4143: $udom.' '.$uname.' '.$url.' '.$role.' '.$end.' '.$start.' by '.
4144: $env{'user.name'}.' at '.$env{'user.domain'});
4145: return 'refused';
4146: }
4147: $mrole='gr';
1.21 www 4148: } else {
1.82 www 4149: my $cwosec=$url;
1.83 www 4150: $cwosec=~s/^\/(\w+)\/(\w+)\/.*/$1\/$2/;
1.373 www 4151: unless ((&allowed('c'.$role,$cwosec)) || &allowed('c'.$role,$udom)) {
1.104 www 4152: &logthis('Refused assignrole: '.
4153: $udom.' '.$uname.' '.$url.' '.$role.' '.$end.' '.$start.' by '.
1.620 albertel 4154: $env{'user.name'}.' at '.$env{'user.domain'});
1.104 www 4155: return 'refused';
4156: }
1.21 www 4157: $mrole=$role;
4158: }
1.620 albertel 4159: my $command="encrypt:rolesput:$env{'user.domain'}:$env{'user.name'}:".
1.21 www 4160: "$udom:$uname:$url".'_'."$mrole=$role";
1.81 www 4161: if ($end) { $command.='_'.$end; }
1.21 www 4162: if ($start) {
4163: if ($end) {
1.81 www 4164: $command.='_'.$start;
1.21 www 4165: } else {
1.81 www 4166: $command.='_0_'.$start;
1.21 www 4167: }
4168: }
1.739 raeburn 4169: my $origstart = $start;
4170: my $origend = $end;
1.357 www 4171: # actually delete
4172: if ($deleteflag) {
1.373 www 4173: if ((&allowed('dro',$udom)) || (&allowed('dro',$url))) {
1.357 www 4174: # modify command to delete the role
1.620 albertel 4175: $command="encrypt:rolesdel:$env{'user.domain'}:$env{'user.name'}:".
1.357 www 4176: "$udom:$uname:$url".'_'."$mrole";
1.620 albertel 4177: &logthis("$env{'user.name'} at $env{'user.domain'} deletes $mrole in $url for $uname at $udom");
1.357 www 4178: # set start and finish to negative values for userrolelog
4179: $start=-1;
4180: $end=-1;
4181: }
4182: }
4183: # send command
1.349 www 4184: my $answer=&reply($command,&homeserver($uname,$udom));
1.357 www 4185: # log new user role if status is ok
1.349 www 4186: if ($answer eq 'ok') {
1.663 raeburn 4187: &userrolelog($role,$uname,$udom,$url,$start,$end);
1.739 raeburn 4188: # for course roles, perform group memberships changes triggered by role change.
4189: unless ($role =~ /^gr/) {
4190: &Apache::longroup::group_changes($udom,$uname,$url,$role,$origend,
4191: $origstart);
4192: }
1.349 www 4193: }
4194: return $answer;
1.169 harris41 4195: }
4196:
4197: # -------------------------------------------------- Modify user authentication
1.197 www 4198: # Overrides without validation
4199:
1.169 harris41 4200: sub modifyuserauth {
4201: my ($udom,$uname,$umode,$upass)=@_;
4202: my $uhome=&homeserver($uname,$udom);
1.197 www 4203: unless (&allowed('mau',$udom)) { return 'refused'; }
4204: &logthis('Call to modify user authentication '.$udom.', '.$uname.', '.
1.620 albertel 4205: $umode.' by '.$env{'user.name'}.' at '.$env{'user.domain'}.
4206: ' in domain '.$env{'request.role.domain'});
1.169 harris41 4207: my $reply=&reply('encrypt:changeuserauth:'.$udom.':'.$uname.':'.$umode.':'.
4208: &escape($upass),$uhome);
1.620 albertel 4209: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},
1.197 www 4210: 'Authentication changed for '.$udom.', '.$uname.', '.$umode.
4211: '(Remote '.$ENV{'REMOTE_ADDR'}.'): '.$reply);
4212: &log($udom,,$uname,$uhome,
1.620 albertel 4213: 'Authentication changed by '.$env{'user.domain'}.', '.
4214: $env{'user.name'}.', '.$umode.
1.197 www 4215: '(Remote '.$ENV{'REMOTE_ADDR'}.'): '.$reply);
1.169 harris41 4216: unless ($reply eq 'ok') {
1.197 www 4217: &logthis('Authentication mode error: '.$reply);
1.169 harris41 4218: return 'error: '.$reply;
4219: }
1.170 harris41 4220: return 'ok';
1.80 www 4221: }
4222:
1.81 www 4223: # --------------------------------------------------------------- Modify a user
1.80 www 4224:
1.81 www 4225: sub modifyuser {
1.206 matthew 4226: my ($udom, $uname, $uid,
4227: $umode, $upass, $first,
4228: $middle, $last, $gene,
1.387 www 4229: $forceid, $desiredhome, $email)=@_;
1.198 www 4230: $udom=~s/\W//g;
4231: $uname=~s/\W//g;
1.81 www 4232: &logthis('Call to modify user '.$udom.', '.$uname.', '.$uid.', '.
1.80 www 4233: $umode.', '.$first.', '.$middle.', '.
1.206 matthew 4234: $last.', '.$gene.'(forceid: '.$forceid.')'.
4235: (defined($desiredhome) ? ' desiredhome = '.$desiredhome :
4236: ' desiredhome not specified').
1.620 albertel 4237: ' by '.$env{'user.name'}.' at '.$env{'user.domain'}.
4238: ' in domain '.$env{'request.role.domain'});
1.230 stredwic 4239: my $uhome=&homeserver($uname,$udom,'true');
1.80 www 4240: # ----------------------------------------------------------------- Create User
1.406 albertel 4241: if (($uhome eq 'no_host') &&
4242: (($umode && $upass) || ($umode eq 'localauth'))) {
1.80 www 4243: my $unhome='';
1.209 matthew 4244: if (defined($desiredhome) && $hostdom{$desiredhome} eq $udom) {
4245: $unhome = $desiredhome;
1.620 albertel 4246: } elsif($env{'course.'.$env{'request.course.id'}.'.domain'} eq $udom) {
4247: $unhome=$env{'course.'.$env{'request.course.id'}.'.home'};
1.209 matthew 4248: } else { # load balancing routine for determining $unhome
1.80 www 4249: my $tryserver;
1.81 www 4250: my $loadm=10000000;
1.80 www 4251: foreach $tryserver (keys %libserv) {
4252: if ($hostdom{$tryserver} eq $udom) {
4253: my $answer=reply('load',$tryserver);
4254: if (($answer=~/\d+/) && ($answer<$loadm)) {
4255: $loadm=$answer;
4256: $unhome=$tryserver;
4257: }
4258: }
4259: }
4260: }
4261: if (($unhome eq '') || ($unhome eq 'no_host')) {
1.206 matthew 4262: return 'error: unable to find a home server for '.$uname.
4263: ' in domain '.$udom;
1.80 www 4264: }
4265: my $reply=&reply('encrypt:makeuser:'.$udom.':'.$uname.':'.$umode.':'.
4266: &escape($upass),$unhome);
4267: unless ($reply eq 'ok') {
4268: return 'error: '.$reply;
4269: }
1.230 stredwic 4270: $uhome=&homeserver($uname,$udom,'true');
1.80 www 4271: if (($uhome eq '') || ($uhome eq 'no_host') || ($uhome ne $unhome)) {
1.386 matthew 4272: return 'error: unable verify users home machine.';
1.80 www 4273: }
1.209 matthew 4274: } # End of creation of new user
1.80 www 4275: # ---------------------------------------------------------------------- Add ID
4276: if ($uid) {
4277: $uid=~tr/A-Z/a-z/;
4278: my %uidhash=&idrget($udom,$uname);
1.196 www 4279: if (($uidhash{$uname}) && ($uidhash{$uname}!~/error\:/)
4280: && (!$forceid)) {
1.80 www 4281: unless ($uid eq $uidhash{$uname}) {
1.386 matthew 4282: return 'error: user id "'.$uid.'" does not match '.
4283: 'current user id "'.$uidhash{$uname}.'".';
1.80 www 4284: }
4285: } else {
4286: &idput($udom,($uname => $uid));
4287: }
4288: }
4289: # -------------------------------------------------------------- Add names, etc
1.313 matthew 4290: my @tmp=&get('environment',
1.134 albertel 4291: ['firstname','middlename','lastname','generation'],
4292: $udom,$uname);
1.313 matthew 4293: my %names;
4294: if ($tmp[0] =~ m/^error:.*/) {
4295: %names=();
4296: } else {
4297: %names = @tmp;
4298: }
1.388 www 4299: #
4300: # Make sure to not trash student environment if instructor does not bother
4301: # to supply name and email information
4302: #
4303: if ($first) { $names{'firstname'} = $first; }
1.385 matthew 4304: if (defined($middle)) { $names{'middlename'} = $middle; }
1.388 www 4305: if ($last) { $names{'lastname'} = $last; }
1.385 matthew 4306: if (defined($gene)) { $names{'generation'} = $gene; }
1.592 www 4307: if ($email) {
4308: $email=~s/[^\w\@\.\-\,]//gs;
4309: if ($email=~/\@/) { $names{'notification'} = $email;
4310: $names{'critnotification'} = $email;
4311: $names{'permanentemail'} = $email; }
4312: }
1.134 albertel 4313: my $reply = &put('environment', \%names, $udom,$uname);
4314: if ($reply ne 'ok') { return 'error: '.$reply; }
1.680 www 4315: &devalidate_cache_new('namescache',$uname.':'.$udom);
1.81 www 4316: &logthis('Success modifying user '.$udom.', '.$uname.', '.$uid.', '.
1.80 www 4317: $umode.', '.$first.', '.$middle.', '.
4318: $last.', '.$gene.' by '.
1.620 albertel 4319: $env{'user.name'}.' at '.$env{'user.domain'});
1.134 albertel 4320: return 'ok';
1.80 www 4321: }
4322:
1.81 www 4323: # -------------------------------------------------------------- Modify student
1.80 www 4324:
1.81 www 4325: sub modifystudent {
4326: my ($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene,$usec,
1.515 raeburn 4327: $end,$start,$forceid,$desiredhome,$email,$type,$locktype,$cid)=@_;
1.455 albertel 4328: if (!$cid) {
1.620 albertel 4329: unless ($cid=$env{'request.course.id'}) {
1.455 albertel 4330: return 'not_in_class';
4331: }
1.80 www 4332: }
4333: # --------------------------------------------------------------- Make the user
1.81 www 4334: my $reply=&modifyuser
1.209 matthew 4335: ($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene,$forceid,
1.387 www 4336: $desiredhome,$email);
1.80 www 4337: unless ($reply eq 'ok') { return $reply; }
1.297 matthew 4338: # This will cause &modify_student_enrollment to get the uid from the
4339: # students environment
4340: $uid = undef if (!$forceid);
1.455 albertel 4341: $reply = &modify_student_enrollment($udom,$uname,$uid,$first,$middle,$last,
1.515 raeburn 4342: $gene,$usec,$end,$start,$type,$locktype,$cid);
1.297 matthew 4343: return $reply;
4344: }
4345:
4346: sub modify_student_enrollment {
1.515 raeburn 4347: my ($udom,$uname,$uid,$first,$middle,$last,$gene,$usec,$end,$start,$type,$locktype,$cid) = @_;
1.455 albertel 4348: my ($cdom,$cnum,$chome);
4349: if (!$cid) {
1.620 albertel 4350: unless ($cid=$env{'request.course.id'}) {
1.455 albertel 4351: return 'not_in_class';
4352: }
1.620 albertel 4353: $cdom=$env{'course.'.$cid.'.domain'};
4354: $cnum=$env{'course.'.$cid.'.num'};
1.455 albertel 4355: } else {
4356: ($cdom,$cnum)=split(/_/,$cid);
4357: }
1.620 albertel 4358: $chome=$env{'course.'.$cid.'.home'};
1.455 albertel 4359: if (!$chome) {
1.457 raeburn 4360: $chome=&homeserver($cnum,$cdom);
1.297 matthew 4361: }
1.455 albertel 4362: if (!$chome) { return 'unknown_course'; }
1.297 matthew 4363: # Make sure the user exists
1.81 www 4364: my $uhome=&homeserver($uname,$udom);
4365: if (($uhome eq '') || ($uhome eq 'no_host')) {
4366: return 'error: no such user';
4367: }
1.297 matthew 4368: # Get student data if we were not given enough information
4369: if (!defined($first) || $first eq '' ||
4370: !defined($last) || $last eq '' ||
4371: !defined($uid) || $uid eq '' ||
4372: !defined($middle) || $middle eq '' ||
4373: !defined($gene) || $gene eq '') {
1.294 matthew 4374: # They did not supply us with enough data to enroll the student, so
4375: # we need to pick up more information.
1.297 matthew 4376: my %tmp = &get('environment',
1.294 matthew 4377: ['firstname','middlename','lastname', 'generation','id']
1.297 matthew 4378: ,$udom,$uname);
4379:
1.455 albertel 4380: #foreach (keys(%tmp)) {
4381: # &logthis("key $_ = ".$tmp{$_});
4382: #}
1.294 matthew 4383: $first = $tmp{'firstname'} if (!defined($first) || $first eq '');
4384: $middle = $tmp{'middlename'} if (!defined($middle) || $middle eq '');
4385: $last = $tmp{'lastname'} if (!defined($last) || $last eq '');
1.297 matthew 4386: $gene = $tmp{'generation'} if (!defined($gene) || $gene eq '');
1.294 matthew 4387: $uid = $tmp{'id'} if (!defined($uid) || $uid eq '');
4388: }
1.556 albertel 4389: my $fullname = &format_name($first,$middle,$last,$gene,'lastname');
1.487 albertel 4390: my $reply=cput('classlist',
4391: {"$uname:$udom" =>
1.515 raeburn 4392: join(':',$end,$start,$uid,$usec,$fullname,$type,$locktype) },
1.487 albertel 4393: $cdom,$cnum);
1.81 www 4394: unless (($reply eq 'ok') || ($reply eq 'delayed')) {
4395: return 'error: '.$reply;
1.652 albertel 4396: } else {
4397: &devalidate_getsection_cache($udom,$uname,$cid);
1.81 www 4398: }
1.297 matthew 4399: # Add student role to user
1.83 www 4400: my $uurl='/'.$cid;
1.81 www 4401: $uurl=~s/\_/\//g;
4402: if ($usec) {
4403: $uurl.='/'.$usec;
4404: }
4405: return &assignrole($udom,$uname,$uurl,'st',$end,$start);
1.21 www 4406: }
4407:
1.556 albertel 4408: sub format_name {
4409: my ($firstname,$middlename,$lastname,$generation,$first)=@_;
4410: my $name;
4411: if ($first ne 'lastname') {
4412: $name=$firstname.' '.$middlename.' '.$lastname.' '.$generation;
4413: } else {
4414: if ($lastname=~/\S/) {
4415: $name.= $lastname.' '.$generation.', '.$firstname.' '.$middlename;
4416: $name=~s/\s+,/,/;
4417: } else {
4418: $name.= $firstname.' '.$middlename.' '.$generation;
4419: }
4420: }
4421: $name=~s/^\s+//;
4422: $name=~s/\s+$//;
4423: $name=~s/\s+/ /g;
4424: return $name;
4425: }
4426:
1.84 www 4427: # ------------------------------------------------- Write to course preferences
4428:
4429: sub writecoursepref {
4430: my ($courseid,%prefs)=@_;
4431: $courseid=~s/^\///;
4432: $courseid=~s/\_/\//g;
4433: my ($cdomain,$cnum)=split(/\//,$courseid);
4434: my $chome=homeserver($cnum,$cdomain);
4435: if (($chome eq '') || ($chome eq 'no_host')) {
4436: return 'error: no such course';
4437: }
4438: my $cstring='';
1.191 harris41 4439: foreach (keys %prefs) {
1.84 www 4440: $cstring.=escape($_).'='.escape($prefs{$_}).'&';
1.191 harris41 4441: }
1.84 www 4442: $cstring=~s/\&$//;
4443: return reply('put:'.$cdomain.':'.$cnum.':environment:'.$cstring,$chome);
4444: }
4445:
4446: # ---------------------------------------------------------- Make/modify course
4447:
4448: sub createcourse {
1.741 raeburn 4449: my ($udom,$description,$url,$course_server,$nonstandard,$inst_code,
4450: $course_owner,$crstype)=@_;
1.84 www 4451: $url=&declutter($url);
4452: my $cid='';
1.264 matthew 4453: unless (&allowed('ccc',$udom)) {
1.84 www 4454: return 'refused';
4455: }
4456: # ------------------------------------------------------------------- Create ID
1.674 www 4457: my $uname=int(1+rand(9)).
4458: ('a'..'z','A'..'Z','0'..'9')[int(rand(62))].
4459: substr($$.time,0,5).unpack("H8",pack("I32",time)).
1.84 www 4460: unpack("H2",pack("I32",int(rand(255)))).$perlvar{'lonHostID'};
4461: # ----------------------------------------------- Make sure that does not exist
1.230 stredwic 4462: my $uhome=&homeserver($uname,$udom,'true');
1.84 www 4463: unless (($uhome eq '') || ($uhome eq 'no_host')) {
4464: $uname=substr($$.time,0,5).unpack("H8",pack("I32",time)).
4465: unpack("H2",pack("I32",int(rand(255)))).$perlvar{'lonHostID'};
1.230 stredwic 4466: $uhome=&homeserver($uname,$udom,'true');
1.84 www 4467: unless (($uhome eq '') || ($uhome eq 'no_host')) {
4468: return 'error: unable to generate unique course-ID';
4469: }
4470: }
1.264 matthew 4471: # ------------------------------------------------ Check supplied server name
1.620 albertel 4472: $course_server = $env{'user.homeserver'} if (! defined($course_server));
1.264 matthew 4473: if (! exists($libserv{$course_server})) {
4474: return 'error:bad server name '.$course_server;
4475: }
1.84 www 4476: # ------------------------------------------------------------- Make the course
4477: my $reply=&reply('encrypt:makeuser:'.$udom.':'.$uname.':none::',
1.264 matthew 4478: $course_server);
1.84 www 4479: unless ($reply eq 'ok') { return 'error: '.$reply; }
1.230 stredwic 4480: $uhome=&homeserver($uname,$udom,'true');
1.84 www 4481: if (($uhome eq '') || ($uhome eq 'no_host')) {
4482: return 'error: no such course';
4483: }
1.271 www 4484: # ----------------------------------------------------------------- Course made
1.516 raeburn 4485: # log existence
4486: &courseidput($udom,&escape($udom.'_'.$uname).'='.&escape($description).
1.741 raeburn 4487: ':'.&escape($inst_code).':'.&escape($course_owner).':'.
4488: &escape($crstype),$uhome);
1.358 www 4489: &flushcourselogs();
4490: # set toplevel url
1.271 www 4491: my $topurl=$url;
4492: unless ($nonstandard) {
4493: # ------------------------------------------ For standard courses, make top url
4494: my $mapurl=&clutter($url);
1.278 www 4495: if ($mapurl eq '/res/') { $mapurl=''; }
1.620 albertel 4496: $env{'form.initmap'}=(<<ENDINITMAP);
1.271 www 4497: <map>
4498: <resource id="1" type="start"></resource>
4499: <resource id="2" src="$mapurl"></resource>
4500: <resource id="3" type="finish"></resource>
4501: <link index="1" from="1" to="2"></link>
4502: <link index="2" from="2" to="3"></link>
4503: </map>
4504: ENDINITMAP
4505: $topurl=&declutter(
1.638 albertel 4506: &finishuserfileupload($uname,$udom,'initmap','default.sequence')
1.271 www 4507: );
4508: }
4509: # ----------------------------------------------------------- Write preferences
1.84 www 4510: &writecoursepref($udom.'_'.$uname,
4511: ('description' => $description,
1.271 www 4512: 'url' => $topurl));
1.84 www 4513: return '/'.$udom.'/'.$uname;
4514: }
4515:
1.21 www 4516: # ---------------------------------------------------------- Assign Custom Role
4517:
4518: sub assigncustomrole {
1.357 www 4519: my ($udom,$uname,$url,$rdom,$rnam,$rolename,$end,$start,$deleteflag)=@_;
1.21 www 4520: return &assignrole($udom,$uname,$url,'cr/'.$rdom.'/'.$rnam.'/'.$rolename,
1.357 www 4521: $end,$start,$deleteflag);
1.21 www 4522: }
4523:
4524: # ----------------------------------------------------------------- Revoke Role
4525:
4526: sub revokerole {
1.357 www 4527: my ($udom,$uname,$url,$role,$deleteflag)=@_;
1.21 www 4528: my $now=time;
1.357 www 4529: return &assignrole($udom,$uname,$url,$role,$now,$deleteflag);
1.21 www 4530: }
4531:
4532: # ---------------------------------------------------------- Revoke Custom Role
4533:
4534: sub revokecustomrole {
1.357 www 4535: my ($udom,$uname,$url,$rdom,$rnam,$rolename,$deleteflag)=@_;
1.21 www 4536: my $now=time;
1.357 www 4537: return &assigncustomrole($udom,$uname,$url,$rdom,$rnam,$rolename,$now,
4538: $deleteflag);
1.17 www 4539: }
4540:
1.533 banghart 4541: # ------------------------------------------------------------ Disk usage
1.535 albertel 4542: sub diskusage {
1.533 banghart 4543: my ($udom,$uname,$directoryRoot)=@_;
4544: $directoryRoot =~ s/\/$//;
1.535 albertel 4545: my $listing=&reply('du:'.$directoryRoot,homeserver($uname,$udom));
1.514 albertel 4546: return $listing;
1.512 banghart 4547: }
4548:
1.566 banghart 4549: sub is_locked {
4550: my ($file_name, $domain, $user) = @_;
4551: my @check;
4552: my $is_locked;
4553: push @check, $file_name;
1.613 albertel 4554: my %locked = &get('file_permissions',\@check,
1.620 albertel 4555: $env{'user.domain'},$env{'user.name'});
1.615 albertel 4556: my ($tmp)=keys(%locked);
4557: if ($tmp=~/^error:/) { undef(%locked); }
1.745 raeburn 4558:
1.566 banghart 4559: if (ref($locked{$file_name}) eq 'ARRAY') {
1.745 raeburn 4560: $is_locked = 'false';
4561: foreach my $entry (@{$locked{$file_name}}) {
4562: if (ref($entry) eq 'ARRAY') {
1.746 raeburn 4563: $is_locked = 'true';
4564: last;
1.745 raeburn 4565: }
4566: }
1.566 banghart 4567: } else {
4568: $is_locked = 'false';
4569: }
4570: }
4571:
1.559 banghart 4572: # ------------------------------------------------------------- Mark as Read Only
4573:
4574: sub mark_as_readonly {
4575: my ($domain,$user,$files,$what) = @_;
1.613 albertel 4576: my %current_permissions = &dump('file_permissions',$domain,$user);
1.615 albertel 4577: my ($tmp)=keys(%current_permissions);
4578: if ($tmp=~/^error:/) { undef(%current_permissions); }
1.560 banghart 4579: foreach my $file (@{$files}) {
1.561 banghart 4580: push(@{$current_permissions{$file}},$what);
1.559 banghart 4581: }
1.613 albertel 4582: &put('file_permissions',\%current_permissions,$domain,$user);
1.559 banghart 4583: return;
4584: }
4585:
1.572 banghart 4586: # ------------------------------------------------------------Save Selected Files
4587:
4588: sub save_selected_files {
4589: my ($user, $path, @files) = @_;
4590: my $filename = $user."savedfiles";
1.573 banghart 4591: my @other_files = &files_not_in_path($user, $path);
1.574 banghart 4592: open (OUT, '>'.$Apache::lonnet::perlvar{'lonDaemons'}.'/tmp/'.$filename);
1.573 banghart 4593: foreach my $file (@files) {
1.620 albertel 4594: print (OUT $env{'form.currentpath'}.$file."\n");
1.573 banghart 4595: }
4596: foreach my $file (@other_files) {
1.574 banghart 4597: print (OUT $file."\n");
1.572 banghart 4598: }
1.574 banghart 4599: close (OUT);
1.572 banghart 4600: return 'ok';
4601: }
4602:
1.574 banghart 4603: sub clear_selected_files {
4604: my ($user) = @_;
4605: my $filename = $user."savedfiles";
4606: open (OUT, '>'.$Apache::lonnet::perlvar{'lonDaemons'}.'/tmp/'.$filename);
4607: print (OUT undef);
4608: close (OUT);
4609: return ("ok");
4610: }
4611:
1.572 banghart 4612: sub files_in_path {
4613: my ($user, $path) = @_;
4614: my $filename = $user."savedfiles";
4615: my %return_files;
1.574 banghart 4616: open (IN, '<'.$Apache::lonnet::perlvar{'lonDaemons'}.'/tmp/'.$filename);
1.573 banghart 4617: while (my $line_in = <IN>) {
1.574 banghart 4618: chomp ($line_in);
4619: my @paths_and_file = split (m!/!, $line_in);
4620: my $file_part = pop (@paths_and_file);
4621: my $path_part = join ('/', @paths_and_file);
1.573 banghart 4622: $path_part.='/';
4623: my $path_and_file = $path_part.$file_part;
4624: if ($path_part eq $path) {
4625: $return_files{$file_part}= 'selected';
4626: }
4627: }
1.574 banghart 4628: close (IN);
4629: return (\%return_files);
1.572 banghart 4630: }
4631:
4632: # called in portfolio select mode, to show files selected NOT in current directory
4633: sub files_not_in_path {
4634: my ($user, $path) = @_;
4635: my $filename = $user."savedfiles";
4636: my @return_files;
4637: my $path_part;
1.574 banghart 4638: open (IN, '<'.$Apache::lonnet::perlvar{'lonDaemons'}.'/tmp/'.$filename);
1.572 banghart 4639: while (<IN>) {
4640: #ok, I know it's clunky, but I want it to work
4641: my @paths_and_file = split m!/!, $_;
1.574 banghart 4642: my $file_part = pop (@paths_and_file);
4643: chomp ($file_part);
4644: my $path_part = join ('/', @paths_and_file);
1.572 banghart 4645: $path_part .= '/';
4646: my $path_and_file = $path_part.$file_part;
4647: if ($path_part ne $path) {
1.574 banghart 4648: push (@return_files, ($path_and_file));
1.572 banghart 4649: }
4650: }
1.574 banghart 4651: close (OUT);
4652: return (@return_files);
1.572 banghart 4653: }
4654:
1.745 raeburn 4655: #----------------------------------------------Get portfolio file permissions
1.629 banghart 4656:
1.745 raeburn 4657: sub get_portfile_permissions {
4658: my ($domain,$user) = @_;
1.613 albertel 4659: my %current_permissions = &dump('file_permissions',$domain,$user);
1.615 albertel 4660: my ($tmp)=keys(%current_permissions);
4661: if ($tmp=~/^error:/) { undef(%current_permissions); }
1.745 raeburn 4662: return \%current_permissions;
4663: }
4664:
4665: #---------------------------------------------Get portfolio file access controls
4666:
1.749 raeburn 4667: sub get_access_controls {
1.745 raeburn 4668: my ($current_permissions,$group,$file) = @_;
4669: my %access;
4670: if (defined($file)) {
1.749 raeburn 4671: if (ref($$current_permissions{$file."\0".'accesscontrol'}) eq 'HASH') {
4672: foreach my $control (keys(%{$$current_permissions{$file."\0".'accesscontrol'}})) {
4673: $access{$file}{$control} = $$current_permissions{$file."\0".$control};
4674: }
4675: }
1.745 raeburn 4676: } else {
1.749 raeburn 4677: foreach my $key (keys(%{$current_permissions})) {
4678: if ($key =~ /\0accesscontrol$/) {
4679: if (defined($group)) {
4680: if ($key !~ m-^\Q$group\E/-) {
4681: next;
4682: }
4683: }
4684: my ($fullpath) = split(/\0/,$key);
4685: if (ref($$current_permissions{$key}) eq 'HASH') {
4686: foreach my $control (keys(%{$$current_permissions{$key}})) {
4687: $access{$fullpath}{$control}=$$current_permissions{$fullpath."\0".$control};
4688: }
4689: }
4690: }
4691: }
4692: }
4693: return %access;
4694: }
4695:
4696: sub parse_access_controls {
4697: my ($access_item) = @_;
4698: my %content;
1.752 raeburn 4699: my $role_id;
4700: my $user;
4701: my $usercount;
1.749 raeburn 4702: my $token;
4703: my $parser=HTML::TokeParser->new(\$access_item);
4704: while ($token=$parser->get_token) {
4705: if ($token->[0] eq 'S') {
4706: my $entry=$token->[1];
4707: if ($entry eq 'scope') {
4708: my $type = $token->[2]{'type'};
1.752 raeburn 4709: if (($type eq 'course') || ($type eq 'group')) {
1.753 albertel 4710: $content{'roles'} = {};
1.752 raeburn 4711: }
4712: } elsif ($entry eq 'roles') {
4713: $role_id = $token->[2]{id};
1.754 ! albertel 4714: $content{$entry}{$role_id} = {
1.753 albertel 4715: role => [],
1.752 raeburn 4716: access => [],
4717: section => [],
4718: group => [],
1.754 ! albertel 4719: };
1.752 raeburn 4720: } elsif ($entry eq 'users') {
1.753 albertel 4721: $content{'users'} = {};
1.752 raeburn 4722: $usercount = 0;
4723: } elsif ($entry eq 'user') {
4724: $user = '';
1.749 raeburn 4725: } else {
4726: my $value=$parser->get_text('/'.$entry);
1.752 raeburn 4727: if ($entry eq 'uname') {
4728: $user = $value;
4729: } elsif ($entry eq 'udom') {
4730: $user .= ':'.$value;
4731: $content{'users'}{$user} = $usercount;
4732: } elsif ($entry eq 'role' ||
4733: $entry eq 'access' ||
4734: $entry eq 'section' ||
4735: $entry eq 'group') {
4736: if ($role_id ne '') {
4737: push(@{$content{'roles'}{$role_id}{$entry}},$value);
4738: }
4739: } elsif ($entry eq 'dom') {
4740: push(@{$content{$entry}},$value);
4741: } else {
4742: $content{$entry}=$value;
4743: }
4744: }
4745: } elsif ($token->[0] eq 'E') {
4746: if ($token->[1] eq 'user') {
4747: $user = '';
4748: $usercount ++;
4749: } elsif ($token->[1] eq 'roles') {
4750: $role_id = '';
1.749 raeburn 4751: }
4752: }
1.745 raeburn 4753: }
1.749 raeburn 4754: return %content;
4755: }
4756:
4757: sub modify_access_controls {
4758: my ($file_name,$changes,$domain,$user)=@_;
4759: my ($outcome,$deloutcome);
4760: my %store_permissions;
4761: my %new_values;
4762: my %new_control;
4763: my %translation;
4764: my @deletions = ();
4765: my $now = time;
4766: if (exists($$changes{'activate'})) {
4767: if (ref($$changes{'activate'}) eq 'HASH') {
4768: my @newitems = sort(keys(%{$$changes{'activate'}}));
4769: my $numnew = scalar(@newitems);
4770: for (my $i=0; $i<$numnew; $i++) {
4771: my $newkey = $newitems[$i];
4772: my $newid = &Apache::loncommon::get_cgi_id();
4773: $newkey =~ s/^(\d+)/$newid/;
4774: $translation{$1} = $newid;
4775: $new_values{$file_name."\0".$newkey} =
4776: $$changes{'activate'}{$newitems[$i]};
4777: $new_control{$newkey} = $now;
4778: }
4779: }
4780: }
4781: my %todelete;
4782: my %changed_items;
4783: foreach my $action ('delete','update') {
4784: if (exists($$changes{$action})) {
4785: if (ref($$changes{$action}) eq 'HASH') {
4786: foreach my $key (keys(%{$$changes{$action}})) {
4787: my ($itemnum) = ($key =~ /^([^:]+):/);
4788: if ($action eq 'delete') {
4789: $todelete{$itemnum} = 1;
4790: } else {
4791: $changed_items{$itemnum} = $key;
4792: }
4793: }
1.745 raeburn 4794: }
4795: }
1.749 raeburn 4796: }
4797: # get lock on access controls for file.
4798: my $lockhash = {
4799: $file_name."\0".'locked_access_records' => $env{'user.name'}.
4800: ':'.$env{'user.domain'},
4801: };
4802: my $tries = 0;
4803: my $gotlock = &newput('file_permissions',$lockhash,$domain,$user);
4804:
4805: while (($gotlock ne 'ok') && $tries <3) {
4806: $tries ++;
4807: sleep 1;
4808: $gotlock = &newput('file_permissions',$lockhash,$domain,$user);
4809: }
4810: if ($gotlock eq 'ok') {
4811: my %curr_permissions = &dump('file_permissions',$domain,$user,$file_name);
4812: my ($tmp)=keys(%curr_permissions);
4813: if ($tmp=~/^error:/) { undef(%curr_permissions); }
4814: if (exists($curr_permissions{$file_name."\0".'accesscontrol'})) {
4815: my $curr_controls = $curr_permissions{$file_name."\0".'accesscontrol'};
4816: if (ref($curr_controls) eq 'HASH') {
4817: foreach my $control_item (keys(%{$curr_controls})) {
4818: my ($itemnum) = ($control_item =~ /^([^:]+):/);
4819: if (defined($todelete{$itemnum})) {
4820: push(@deletions,$file_name."\0".$control_item);
4821: } else {
4822: if (defined($changed_items{$itemnum})) {
4823: $new_control{$changed_items{$itemnum}} = $now;
4824: push(@deletions,$file_name."\0".$control_item);
4825: $new_values{$file_name."\0".$changed_items{$itemnum}} = $$changes{'update'}{$changed_items{$itemnum}};
4826: } else {
4827: $new_control{$control_item} = $$curr_controls{$control_item};
4828: }
4829: }
1.745 raeburn 4830: }
4831: }
4832: }
1.749 raeburn 4833: $deloutcome = &del('file_permissions',\@deletions,$domain,$user);
4834: $new_values{$file_name."\0".'accesscontrol'} = \%new_control;
4835: $outcome = &put('file_permissions',\%new_values,$domain,$user);
4836: # remove lock
4837: my @del_lock = ($file_name."\0".'locked_access_records');
4838: my $dellockoutcome = &del('file_permissions',\@del_lock,$domain,$user);
4839: } else {
4840: $outcome = "error: could not obtain lockfile\n";
1.745 raeburn 4841: }
1.749 raeburn 4842: return ($outcome,$deloutcome,\%new_values,\%translation);
1.745 raeburn 4843: }
4844:
4845: #------------------------------------------------------Get Marked as Read Only
4846:
4847: sub get_marked_as_readonly {
4848: my ($domain,$user,$what,$group) = @_;
4849: my $current_permissions = &get_portfile_permissions($domain,$user);
1.563 banghart 4850: my @readonly_files;
1.629 banghart 4851: my $cmp1=$what;
4852: if (ref($what)) { $cmp1=join('',@{$what}) };
1.745 raeburn 4853: while (my ($file_name,$value) = each(%{$current_permissions})) {
4854: if (defined($group)) {
4855: if ($file_name !~ m-^\Q$group\E/-) {
4856: next;
4857: }
4858: }
1.561 banghart 4859: if (ref($value) eq "ARRAY"){
4860: foreach my $stored_what (@{$value}) {
1.629 banghart 4861: my $cmp2=$stored_what;
1.749 raeburn 4862: if (ref($stored_what eq 'ARRAY')) {
1.746 raeburn 4863: $cmp2=join('',@{$stored_what});
1.745 raeburn 4864: }
1.629 banghart 4865: if ($cmp1 eq $cmp2) {
1.561 banghart 4866: push(@readonly_files, $file_name);
1.745 raeburn 4867: last;
1.563 banghart 4868: } elsif (!defined($what)) {
4869: push(@readonly_files, $file_name);
1.745 raeburn 4870: last;
1.561 banghart 4871: }
4872: }
1.745 raeburn 4873: }
1.561 banghart 4874: }
4875: return @readonly_files;
4876: }
1.577 banghart 4877: #-----------------------------------------------------------Get Marked as Read Only Hash
1.561 banghart 4878:
1.577 banghart 4879: sub get_marked_as_readonly_hash {
1.745 raeburn 4880: my ($current_permissions,$group,$what) = @_;
1.577 banghart 4881: my %readonly_files;
1.745 raeburn 4882: while (my ($file_name,$value) = each(%{$current_permissions})) {
4883: if (defined($group)) {
4884: if ($file_name !~ m-^\Q$group\E/-) {
4885: next;
4886: }
4887: }
1.577 banghart 4888: if (ref($value) eq "ARRAY"){
4889: foreach my $stored_what (@{$value}) {
1.745 raeburn 4890: if (ref($stored_what) eq 'ARRAY') {
1.750 banghart 4891: foreach my $lock_descriptor(@{$stored_what}) {
4892: if ($lock_descriptor eq 'graded') {
4893: $readonly_files{$file_name} = 'graded';
4894: } elsif ($lock_descriptor eq 'handback') {
4895: $readonly_files{$file_name} = 'handback';
4896: } else {
4897: if (!exists($readonly_files{$file_name})) {
4898: $readonly_files{$file_name} = 'locked';
4899: }
4900: }
1.745 raeburn 4901: }
1.750 banghart 4902: }
1.577 banghart 4903: }
4904: }
4905: }
4906: return %readonly_files;
4907: }
1.559 banghart 4908: # ------------------------------------------------------------ Unmark as Read Only
4909:
4910: sub unmark_as_readonly {
1.629 banghart 4911: # unmarks $file_name (if $file_name is defined), or all files locked by $what
4912: # for portfolio submissions, $what contains [$symb,$crsid]
1.745 raeburn 4913: my ($domain,$user,$what,$file_name,$group) = @_;
1.634 albertel 4914: my $symb_crs = $what;
4915: if (ref($what)) { $symb_crs=join('',@$what); }
1.745 raeburn 4916: my %current_permissions = &dump('file_permissions',$domain,$user,$group);
1.615 albertel 4917: my ($tmp)=keys(%current_permissions);
4918: if ($tmp=~/^error:/) { undef(%current_permissions); }
1.745 raeburn 4919: my @readonly_files = &get_marked_as_readonly($domain,$user,$what,$group);
1.650 albertel 4920: foreach my $file (@readonly_files) {
4921: if (defined($file_name) && ($file_name ne $file)) { next; }
4922: my $current_locks = $current_permissions{$file};
1.563 banghart 4923: my @new_locks;
4924: my @del_keys;
4925: if (ref($current_locks) eq "ARRAY"){
4926: foreach my $locker (@{$current_locks}) {
1.632 albertel 4927: my $compare=$locker;
1.749 raeburn 4928: if (ref($locker) eq 'ARRAY') {
1.745 raeburn 4929: $compare=join('',@{$locker});
1.746 raeburn 4930: if ($compare ne $symb_crs) {
4931: push(@new_locks, $locker);
4932: }
1.563 banghart 4933: }
4934: }
1.650 albertel 4935: if (scalar(@new_locks) > 0) {
1.563 banghart 4936: $current_permissions{$file} = \@new_locks;
4937: } else {
4938: push(@del_keys, $file);
1.613 albertel 4939: &del('file_permissions',\@del_keys, $domain, $user);
1.650 albertel 4940: delete($current_permissions{$file});
1.563 banghart 4941: }
4942: }
1.561 banghart 4943: }
1.613 albertel 4944: &put('file_permissions',\%current_permissions,$domain,$user);
1.559 banghart 4945: return;
4946: }
1.512 banghart 4947:
1.17 www 4948: # ------------------------------------------------------------ Directory lister
4949:
4950: sub dirlist {
1.253 stredwic 4951: my ($uri,$userdomain,$username,$alternateDirectoryRoot)=@_;
4952:
1.18 www 4953: $uri=~s/^\///;
4954: $uri=~s/\/$//;
1.253 stredwic 4955: my ($udom, $uname);
4956: (undef,$udom,$uname)=split(/\//,$uri);
4957: if(defined($userdomain)) {
4958: $udom = $userdomain;
4959: }
4960: if(defined($username)) {
4961: $uname = $username;
4962: }
4963:
4964: my $dirRoot = $perlvar{'lonDocRoot'};
4965: if(defined($alternateDirectoryRoot)) {
4966: $dirRoot = $alternateDirectoryRoot;
4967: $dirRoot =~ s/\/$//;
1.751 banghart 4968: }
1.253 stredwic 4969:
4970: if($udom) {
4971: if($uname) {
1.605 matthew 4972: my $listing=reply('ls2:'.$dirRoot.'/'.$uri,
1.253 stredwic 4973: homeserver($uname,$udom));
1.605 matthew 4974: my @listing_results;
4975: if ($listing eq 'unknown_cmd') {
4976: $listing=reply('ls:'.$dirRoot.'/'.$uri,
4977: homeserver($uname,$udom));
4978: @listing_results = split(/:/,$listing);
4979: } else {
4980: @listing_results = map { &unescape($_); } split(/:/,$listing);
4981: }
4982: return @listing_results;
1.253 stredwic 4983: } elsif(!defined($alternateDirectoryRoot)) {
4984: my $tryserver;
4985: my %allusers=();
4986: foreach $tryserver (keys %libserv) {
4987: if($hostdom{$tryserver} eq $udom) {
1.605 matthew 4988: my $listing=reply('ls2:'.$perlvar{'lonDocRoot'}.'/res/'.
1.253 stredwic 4989: $udom, $tryserver);
1.605 matthew 4990: my @listing_results;
4991: if ($listing eq 'unknown_cmd') {
4992: $listing=reply('ls:'.$perlvar{'lonDocRoot'}.'/res/'.
4993: $udom, $tryserver);
4994: @listing_results = split(/:/,$listing);
4995: } else {
4996: @listing_results =
4997: map { &unescape($_); } split(/:/,$listing);
4998: }
4999: if ($listing_results[0] ne 'no_such_dir' &&
5000: $listing_results[0] ne 'empty' &&
5001: $listing_results[0] ne 'con_lost') {
5002: foreach (@listing_results) {
1.253 stredwic 5003: my ($entry,@stat)=split(/&/,$_);
5004: $allusers{$entry}=1;
5005: }
5006: }
1.191 harris41 5007: }
1.253 stredwic 5008: }
5009: my $alluserstr='';
5010: foreach (sort keys %allusers) {
5011: $alluserstr.=$_.'&user:';
5012: }
5013: $alluserstr=~s/:$//;
5014: return split(/:/,$alluserstr);
5015: } else {
5016: my @emptyResults = ();
5017: push(@emptyResults, 'missing user name');
5018: return split(':',@emptyResults);
5019: }
5020: } elsif(!defined($alternateDirectoryRoot)) {
5021: my $tryserver;
5022: my %alldom=();
5023: foreach $tryserver (keys %libserv) {
5024: $alldom{$hostdom{$tryserver}}=1;
5025: }
5026: my $alldomstr='';
5027: foreach (sort keys %alldom) {
1.397 albertel 5028: $alldomstr.=$perlvar{'lonDocRoot'}.'/res/'.$_.'/&domain:';
1.253 stredwic 5029: }
5030: $alldomstr=~s/:$//;
5031: return split(/:/,$alldomstr);
5032: } else {
5033: my @emptyResults = ();
5034: push(@emptyResults, 'missing domain');
5035: return split(':',@emptyResults);
1.275 stredwic 5036: }
5037: }
5038:
5039: # --------------------------------------------- GetFileTimestamp
5040: # This function utilizes dirlist and returns the date stamp for
5041: # when it was last modified. It will also return an error of -1
5042: # if an error occurs
5043:
1.410 matthew 5044: ##
5045: ## FIXME: This subroutine assumes its caller knows something about the
5046: ## directory structure of the home server for the student ($root).
5047: ## Not a good assumption to make. Since this is for looking up files
5048: ## in user directories, the full path should be constructed by lond, not
5049: ## whatever machine we request data from.
5050: ##
1.275 stredwic 5051: sub GetFileTimestamp {
5052: my ($studentDomain,$studentName,$filename,$root)=@_;
5053: $studentDomain=~s/\W//g;
5054: $studentName=~s/\W//g;
5055: my $subdir=$studentName.'__';
5056: $subdir =~ s/(.)(.)(.).*/$1\/$2\/$3/;
5057: my $proname="$studentDomain/$subdir/$studentName";
5058: $proname .= '/'.$filename;
1.375 matthew 5059: my ($fileStat) = &Apache::lonnet::dirlist($proname, $studentDomain,
5060: $studentName, $root);
1.275 stredwic 5061: my @stats = split('&', $fileStat);
5062: if($stats[0] ne 'empty' && $stats[0] ne 'no_such_dir') {
1.375 matthew 5063: # @stats contains first the filename, then the stat output
5064: return $stats[10]; # so this is 10 instead of 9.
1.275 stredwic 5065: } else {
5066: return -1;
1.253 stredwic 5067: }
1.26 www 5068: }
5069:
1.712 albertel 5070: sub stat_file {
5071: my ($uri) = @_;
1.722 albertel 5072: $uri = &clutter($uri);
5073:
5074: # we want just the url part without the unneeded accessor url bits
1.723 banghart 5075: if ($uri =~ m-^/adm/-) {
5076: $uri=~s-^/adm/wrapper/-/-;
5077: $uri=~s-^/adm/coursedocs/showdoc/-/-;
1.722 albertel 5078: }
1.712 albertel 5079: my ($udom,$uname,$file,$dir);
5080: if ($uri =~ m-^/(uploaded|editupload)/-) {
5081: ($udom,$uname,$file) =
5082: ($uri =~ m-/(?:uploaded|editupload)/?([^/]*)/?([^/]*)/?(.*)-);
5083: $file = 'userfiles/'.$file;
1.740 www 5084: $dir = &propath($udom,$uname);
1.712 albertel 5085: }
5086: if ($uri =~ m-^/res/-) {
5087: ($udom,$uname) =
5088: ($uri =~ m-/(?:res)/?([^/]*)/?([^/]*)/-);
5089: $file = $uri;
5090: }
5091:
5092: if (!$udom || !$uname || !$file) {
5093: # unable to handle the uri
5094: return ();
5095: }
5096:
5097: my ($result) = &dirlist($file,$udom,$uname,$dir);
5098: my @stats = split('&', $result);
1.721 banghart 5099:
1.712 albertel 5100: if($stats[0] ne 'empty' && $stats[0] ne 'no_such_dir') {
5101: shift(@stats); #filename is first
5102: return @stats;
5103: }
5104: return ();
5105: }
5106:
1.26 www 5107: # -------------------------------------------------------- Value of a Condition
5108:
1.713 albertel 5109: # gets the value of a specific preevaluated condition
5110: # stored in the string $env{user.state.<cid>}
5111: # or looks up a condition reference in the bighash and if if hasn't
5112: # already been evaluated recurses into docondval to get the value of
5113: # the condition, then memoizing it to
5114: # $env{user.state.<cid>.<condition>}
1.40 www 5115: sub directcondval {
5116: my $number=shift;
1.620 albertel 5117: if (!defined($env{'user.state.'.$env{'request.course.id'}})) {
1.555 albertel 5118: &Apache::lonuserstate::evalstate();
5119: }
1.713 albertel 5120: if (exists($env{'user.state.'.$env{'request.course.id'}.".$number"})) {
5121: return $env{'user.state.'.$env{'request.course.id'}.".$number"};
5122: } elsif ($number =~ /^_/) {
5123: my $sub_condition;
5124: if (tie(my %bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
5125: &GDBM_READER(),0640)) {
5126: $sub_condition=$bighash{'conditions'.$number};
5127: untie(%bighash);
5128: }
5129: my $value = &docondval($sub_condition);
5130: &appenv('user.state.'.$env{'request.course.id'}.".$number" => $value);
5131: return $value;
5132: }
1.620 albertel 5133: if ($env{'user.state.'.$env{'request.course.id'}}) {
5134: return substr($env{'user.state.'.$env{'request.course.id'}},$number,1);
1.40 www 5135: } else {
5136: return 2;
5137: }
5138: }
5139:
1.713 albertel 5140: # get the collection of conditions for this resource
1.26 www 5141: sub condval {
5142: my $condidx=shift;
1.54 www 5143: my $allpathcond='';
1.713 albertel 5144: foreach my $cond (split(/\|/,$condidx)) {
5145: if (defined($env{'acc.cond.'.$env{'request.course.id'}.'.'.$cond})) {
5146: $allpathcond.=
5147: '('.$env{'acc.cond.'.$env{'request.course.id'}.'.'.$cond}.')|';
5148: }
1.191 harris41 5149: }
1.54 www 5150: $allpathcond=~s/\|$//;
1.713 albertel 5151: return &docondval($allpathcond);
5152: }
5153:
5154: #evaluates an expression of conditions
5155: sub docondval {
5156: my ($allpathcond) = @_;
5157: my $result=0;
5158: if ($env{'request.course.id'}
5159: && defined($allpathcond)) {
5160: my $operand='|';
5161: my @stack;
5162: foreach my $chunk ($allpathcond=~/(\d+|_\d+\.\d+|\(|\)|\&|\|)/g) {
5163: if ($chunk eq '(') {
5164: push @stack,($operand,$result);
5165: } elsif ($chunk eq ')') {
5166: my $before=pop @stack;
5167: if (pop @stack eq '&') {
5168: $result=$result>$before?$before:$result;
5169: } else {
5170: $result=$result>$before?$result:$before;
5171: }
5172: } elsif (($chunk eq '&') || ($chunk eq '|')) {
5173: $operand=$chunk;
5174: } else {
5175: my $new=directcondval($chunk);
5176: if ($operand eq '&') {
5177: $result=$result>$new?$new:$result;
5178: } else {
5179: $result=$result>$new?$result:$new;
5180: }
5181: }
5182: }
1.26 www 5183: }
5184: return $result;
1.421 albertel 5185: }
5186:
5187: # ---------------------------------------------------- Devalidate courseresdata
5188:
5189: sub devalidatecourseresdata {
5190: my ($coursenum,$coursedomain)=@_;
5191: my $hashid=$coursenum.':'.$coursedomain;
1.599 albertel 5192: &devalidate_cache_new('courseres',$hashid);
1.28 www 5193: }
5194:
1.200 www 5195: # --------------------------------------------------- Course Resourcedata Query
5196:
1.624 albertel 5197: sub get_courseresdata {
5198: my ($coursenum,$coursedomain)=@_;
1.200 www 5199: my $coursehom=&homeserver($coursenum,$coursedomain);
5200: my $hashid=$coursenum.':'.$coursedomain;
1.599 albertel 5201: my ($result,$cached)=&is_cached_new('courseres',$hashid);
1.624 albertel 5202: my %dumpreply;
1.417 albertel 5203: unless (defined($cached)) {
1.624 albertel 5204: %dumpreply=&dump('resourcedata',$coursedomain,$coursenum);
1.417 albertel 5205: $result=\%dumpreply;
1.251 albertel 5206: my ($tmp) = keys(%dumpreply);
5207: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
1.599 albertel 5208: &do_cache_new('courseres',$hashid,$result,600);
1.306 albertel 5209: } elsif ($tmp =~ /^(con_lost|no_such_host)/) {
5210: return $tmp;
1.416 albertel 5211: } elsif ($tmp =~ /^(error)/) {
1.417 albertel 5212: $result=undef;
1.599 albertel 5213: &do_cache_new('courseres',$hashid,$result,600);
1.250 albertel 5214: }
5215: }
1.624 albertel 5216: return $result;
5217: }
5218:
1.633 albertel 5219: sub devalidateuserresdata {
5220: my ($uname,$udom)=@_;
5221: my $hashid="$udom:$uname";
5222: &devalidate_cache_new('userres',$hashid);
5223: }
5224:
1.624 albertel 5225: sub get_userresdata {
5226: my ($uname,$udom)=@_;
5227: #most student don\'t have any data set, check if there is some data
5228: if (&EXT_cache_status($udom,$uname)) { return undef; }
5229:
5230: my $hashid="$udom:$uname";
5231: my ($result,$cached)=&is_cached_new('userres',$hashid);
5232: if (!defined($cached)) {
5233: my %resourcedata=&dump('resourcedata',$udom,$uname);
5234: $result=\%resourcedata;
5235: &do_cache_new('userres',$hashid,$result,600);
5236: }
5237: my ($tmp)=keys(%$result);
5238: if (($tmp!~/^error\:/) && ($tmp!~/^con_lost/)) {
5239: return $result;
5240: }
5241: #error 2 occurs when the .db doesn't exist
5242: if ($tmp!~/error: 2 /) {
1.672 albertel 5243: &logthis("<font color=\"blue\">WARNING:".
1.624 albertel 5244: " Trying to get resource data for ".
5245: $uname." at ".$udom.": ".
5246: $tmp."</font>");
5247: } elsif ($tmp=~/error: 2 /) {
1.633 albertel 5248: #&EXT_cache_set($udom,$uname);
5249: &do_cache_new('userres',$hashid,undef,600);
1.636 albertel 5250: undef($tmp); # not really an error so don't send it back
1.624 albertel 5251: }
5252: return $tmp;
5253: }
5254:
5255: sub resdata {
5256: my ($name,$domain,$type,@which)=@_;
5257: my $result;
5258: if ($type eq 'course') {
5259: $result=&get_courseresdata($name,$domain);
5260: } elsif ($type eq 'user') {
5261: $result=&get_userresdata($name,$domain);
5262: }
5263: if (!ref($result)) { return $result; }
1.251 albertel 5264: foreach my $item (@which) {
1.417 albertel 5265: if (defined($result->{$item})) {
5266: return $result->{$item};
1.251 albertel 5267: }
1.250 albertel 5268: }
1.291 albertel 5269: return undef;
1.200 www 5270: }
5271:
1.379 matthew 5272: #
5273: # EXT resource caching routines
5274: #
5275:
5276: sub clear_EXT_cache_status {
1.383 albertel 5277: &delenv('cache.EXT.');
1.379 matthew 5278: }
5279:
5280: sub EXT_cache_status {
5281: my ($target_domain,$target_user) = @_;
1.383 albertel 5282: my $cachename = 'cache.EXT.'.$target_user.'.'.$target_domain;
1.620 albertel 5283: if (exists($env{$cachename}) && ($env{$cachename}+600) > time) {
1.379 matthew 5284: # We know already the user has no data
5285: return 1;
5286: } else {
5287: return 0;
5288: }
5289: }
5290:
5291: sub EXT_cache_set {
5292: my ($target_domain,$target_user) = @_;
1.383 albertel 5293: my $cachename = 'cache.EXT.'.$target_user.'.'.$target_domain;
1.633 albertel 5294: #&appenv($cachename => time);
1.379 matthew 5295: }
5296:
1.28 www 5297: # --------------------------------------------------------- Value of a Variable
1.58 www 5298: sub EXT {
1.715 albertel 5299:
1.395 albertel 5300: my ($varname,$symbparm,$udom,$uname,$usection,$recurse)=@_;
1.68 www 5301: unless ($varname) { return ''; }
1.218 albertel 5302: #get real user name/domain, courseid and symb
5303: my $courseid;
1.359 albertel 5304: my $publicuser;
1.427 www 5305: if ($symbparm) {
5306: $symbparm=&get_symb_from_alias($symbparm);
5307: }
1.218 albertel 5308: if (!($uname && $udom)) {
1.360 albertel 5309: (my $cursymb,$courseid,$udom,$uname,$publicuser)=
1.378 matthew 5310: &Apache::lonxml::whichuser($symbparm);
1.218 albertel 5311: if (!$symbparm) { $symbparm=$cursymb; }
5312: } else {
1.620 albertel 5313: $courseid=$env{'request.course.id'};
1.218 albertel 5314: }
1.48 www 5315: my ($realm,$space,$qualifier,@therest)=split(/\./,$varname);
5316: my $rest;
1.320 albertel 5317: if (defined($therest[0])) {
1.48 www 5318: $rest=join('.',@therest);
5319: } else {
5320: $rest='';
5321: }
1.320 albertel 5322:
1.57 www 5323: my $qualifierrest=$qualifier;
5324: if ($rest) { $qualifierrest.='.'.$rest; }
5325: my $spacequalifierrest=$space;
5326: if ($qualifierrest) { $spacequalifierrest.='.'.$qualifierrest; }
1.28 www 5327: if ($realm eq 'user') {
1.48 www 5328: # --------------------------------------------------------------- user.resource
5329: if ($space eq 'resource') {
1.651 albertel 5330: if ( (defined($Apache::lonhomework::parsing_a_problem)
5331: || defined($Apache::lonhomework::parsing_a_task))
5332: &&
1.744 albertel 5333: ($symbparm eq &symbread()) ) {
5334: # if we are in the middle of processing the resource the
5335: # get the value we are planning on committing
5336: if (defined($Apache::lonhomework::results{$qualifierrest})) {
5337: return $Apache::lonhomework::results{$qualifierrest};
5338: } else {
5339: return $Apache::lonhomework::history{$qualifierrest};
5340: }
1.335 albertel 5341: } else {
1.359 albertel 5342: my %restored;
1.620 albertel 5343: if ($publicuser || $env{'request.state'} eq 'construct') {
1.359 albertel 5344: %restored=&tmprestore($symbparm,$courseid,$udom,$uname);
5345: } else {
5346: %restored=&restore($symbparm,$courseid,$udom,$uname);
5347: }
1.335 albertel 5348: return $restored{$qualifierrest};
5349: }
1.48 www 5350: # ----------------------------------------------------------------- user.access
5351: } elsif ($space eq 'access') {
1.218 albertel 5352: # FIXME - not supporting calls for a specific user
1.48 www 5353: return &allowed($qualifier,$rest);
5354: # ------------------------------------------ user.preferences, user.environment
5355: } elsif (($space eq 'preferences') || ($space eq 'environment')) {
1.620 albertel 5356: if (($uname eq $env{'user.name'}) &&
5357: ($udom eq $env{'user.domain'})) {
5358: return $env{join('.',('environment',$qualifierrest))};
1.218 albertel 5359: } else {
1.359 albertel 5360: my %returnhash;
5361: if (!$publicuser) {
5362: %returnhash=&userenvironment($udom,$uname,
5363: $qualifierrest);
5364: }
1.218 albertel 5365: return $returnhash{$qualifierrest};
5366: }
1.48 www 5367: # ----------------------------------------------------------------- user.course
5368: } elsif ($space eq 'course') {
1.218 albertel 5369: # FIXME - not supporting calls for a specific user
1.620 albertel 5370: return $env{join('.',('request.course',$qualifier))};
1.48 www 5371: # ------------------------------------------------------------------- user.role
5372: } elsif ($space eq 'role') {
1.218 albertel 5373: # FIXME - not supporting calls for a specific user
1.620 albertel 5374: my ($role,$where)=split(/\./,$env{'request.role'});
1.48 www 5375: if ($qualifier eq 'value') {
5376: return $role;
5377: } elsif ($qualifier eq 'extent') {
5378: return $where;
5379: }
5380: # ----------------------------------------------------------------- user.domain
5381: } elsif ($space eq 'domain') {
1.218 albertel 5382: return $udom;
1.48 www 5383: # ------------------------------------------------------------------- user.name
5384: } elsif ($space eq 'name') {
1.218 albertel 5385: return $uname;
1.48 www 5386: # ---------------------------------------------------- Any other user namespace
1.29 www 5387: } else {
1.359 albertel 5388: my %reply;
5389: if (!$publicuser) {
5390: %reply=&get($space,[$qualifierrest],$udom,$uname);
5391: }
5392: return $reply{$qualifierrest};
1.48 www 5393: }
1.236 www 5394: } elsif ($realm eq 'query') {
5395: # ---------------------------------------------- pull stuff out of query string
1.384 albertel 5396: &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},
5397: [$spacequalifierrest]);
1.620 albertel 5398: return $env{'form.'.$spacequalifierrest};
1.236 www 5399: } elsif ($realm eq 'request') {
1.48 www 5400: # ------------------------------------------------------------- request.browser
5401: if ($space eq 'browser') {
1.430 www 5402: if ($qualifier eq 'textremote') {
1.676 albertel 5403: if (&Apache::lonlocal::mt('textual_remote_display') eq 'on') {
1.430 www 5404: return 1;
5405: } else {
5406: return 0;
5407: }
5408: } else {
1.620 albertel 5409: return $env{'browser.'.$qualifier};
1.430 www 5410: }
1.57 www 5411: # ------------------------------------------------------------ request.filename
5412: } else {
1.620 albertel 5413: return $env{'request.'.$spacequalifierrest};
1.29 www 5414: }
1.28 www 5415: } elsif ($realm eq 'course') {
1.48 www 5416: # ---------------------------------------------------------- course.description
1.620 albertel 5417: return $env{'course.'.$courseid.'.'.$spacequalifierrest};
1.57 www 5418: } elsif ($realm eq 'resource') {
1.165 www 5419:
1.620 albertel 5420: if (defined($courseid) && $courseid eq $env{'request.course.id'}) {
1.539 albertel 5421: if (!$symbparm) { $symbparm=&symbread(); }
5422: }
1.693 albertel 5423:
5424: if ($space eq 'title') {
5425: if (!$symbparm) { $symbparm = $env{'request.filename'}; }
5426: return &gettitle($symbparm);
5427: }
5428:
5429: if ($space eq 'map') {
5430: my ($map) = &decode_symb($symbparm);
5431: return &symbread($map);
5432: }
5433:
5434: my ($section, $group, @groups);
1.593 albertel 5435: my ($courselevelm,$courselevel);
1.539 albertel 5436: if ($symbparm && defined($courseid) &&
1.620 albertel 5437: $courseid eq $env{'request.course.id'}) {
1.165 www 5438:
1.218 albertel 5439: #print '<br>'.$space.' - '.$qualifier.' - '.$spacequalifierrest;
1.165 www 5440:
1.60 www 5441: # ----------------------------------------------------- Cascading lookup scheme
1.218 albertel 5442: my $symbp=$symbparm;
1.735 albertel 5443: my $mapp=&deversion((&decode_symb($symbp))[0]);
1.218 albertel 5444:
5445: my $symbparm=$symbp.'.'.$spacequalifierrest;
5446: my $mapparm=$mapp.'___(all).'.$spacequalifierrest;
5447:
1.620 albertel 5448: if (($env{'user.name'} eq $uname) &&
5449: ($env{'user.domain'} eq $udom)) {
5450: $section=$env{'request.course.sec'};
1.733 raeburn 5451: @groups = split(/:/,$env{'request.course.groups'});
5452: @groups=&sort_course_groups($courseid,@groups);
1.218 albertel 5453: } else {
1.539 albertel 5454: if (! defined($usection)) {
1.551 albertel 5455: $section=&getsection($udom,$uname,$courseid);
1.539 albertel 5456: } else {
5457: $section = $usection;
5458: }
1.733 raeburn 5459: @groups = &get_users_groups($udom,$uname,$courseid);
1.218 albertel 5460: }
5461:
5462: my $seclevel=$courseid.'.['.$section.'].'.$spacequalifierrest;
5463: my $seclevelr=$courseid.'.['.$section.'].'.$symbparm;
5464: my $seclevelm=$courseid.'.['.$section.'].'.$mapparm;
5465:
1.593 albertel 5466: $courselevel=$courseid.'.'.$spacequalifierrest;
1.218 albertel 5467: my $courselevelr=$courseid.'.'.$symbparm;
1.593 albertel 5468: $courselevelm=$courseid.'.'.$mapparm;
1.69 www 5469:
1.60 www 5470: # ----------------------------------------------------------- first, check user
1.624 albertel 5471:
5472: my $userreply=&resdata($uname,$udom,'user',
5473: ($courselevelr,$courselevelm,
5474: $courselevel));
5475: if (defined($userreply)) { return $userreply; }
1.95 www 5476:
1.594 albertel 5477: # ------------------------------------------------ second, check some of course
1.684 raeburn 5478: my $coursereply;
1.691 raeburn 5479: if (@groups > 0) {
5480: $coursereply = &check_group_parms($courseid,\@groups,$symbparm,
5481: $mapparm,$spacequalifierrest);
1.684 raeburn 5482: if (defined($coursereply)) { return $coursereply; }
5483: }
1.96 www 5484:
1.684 raeburn 5485: $coursereply=&resdata($env{'course.'.$courseid.'.num'},
1.624 albertel 5486: $env{'course.'.$courseid.'.domain'},
5487: 'course',
5488: ($seclevelr,$seclevelm,$seclevel,
5489: $courselevelr));
1.287 albertel 5490: if (defined($coursereply)) { return $coursereply; }
1.200 www 5491:
1.60 www 5492: # ------------------------------------------------------ third, check map parms
1.218 albertel 5493: my %parmhash=();
5494: my $thisparm='';
5495: if (tie(%parmhash,'GDBM_File',
1.620 albertel 5496: $env{'request.course.fn'}.'_parms.db',
1.256 albertel 5497: &GDBM_READER(),0640)) {
1.218 albertel 5498: $thisparm=$parmhash{$symbparm};
5499: untie(%parmhash);
5500: }
5501: if ($thisparm) { return $thisparm; }
5502: }
1.594 albertel 5503: # ------------------------------------------ fourth, look in resource metadata
1.71 www 5504:
1.218 albertel 5505: $spacequalifierrest=~s/\./\_/;
1.282 albertel 5506: my $filename;
5507: if (!$symbparm) { $symbparm=&symbread(); }
5508: if ($symbparm) {
1.409 www 5509: $filename=(&decode_symb($symbparm))[2];
1.282 albertel 5510: } else {
1.620 albertel 5511: $filename=$env{'request.filename'};
1.282 albertel 5512: }
5513: my $metadata=&metadata($filename,$spacequalifierrest);
1.288 albertel 5514: if (defined($metadata)) { return $metadata; }
1.282 albertel 5515: $metadata=&metadata($filename,'parameter_'.$spacequalifierrest);
1.288 albertel 5516: if (defined($metadata)) { return $metadata; }
1.142 www 5517:
1.594 albertel 5518: # ---------------------------------------------- fourth, look in rest pf course
1.593 albertel 5519: if ($symbparm && defined($courseid) &&
1.620 albertel 5520: $courseid eq $env{'request.course.id'}) {
1.624 albertel 5521: my $coursereply=&resdata($env{'course.'.$courseid.'.num'},
5522: $env{'course.'.$courseid.'.domain'},
5523: 'course',
5524: ($courselevelm,$courselevel));
1.593 albertel 5525: if (defined($coursereply)) { return $coursereply; }
5526: }
1.145 www 5527: # ------------------------------------------------------------------ Cascade up
1.218 albertel 5528: unless ($space eq '0') {
1.336 albertel 5529: my @parts=split(/_/,$space);
5530: my $id=pop(@parts);
5531: my $part=join('_',@parts);
5532: if ($part eq '') { $part='0'; }
5533: my $partgeneral=&EXT('resource.'.$part.'.'.$qualifierrest,
1.395 albertel 5534: $symbparm,$udom,$uname,$section,1);
1.337 albertel 5535: if (defined($partgeneral)) { return $partgeneral; }
1.218 albertel 5536: }
1.395 albertel 5537: if ($recurse) { return undef; }
5538: my $pack_def=&packages_tab_default($filename,$varname);
5539: if (defined($pack_def)) { return $pack_def; }
1.71 www 5540:
1.48 www 5541: # ---------------------------------------------------- Any other user namespace
5542: } elsif ($realm eq 'environment') {
5543: # ----------------------------------------------------------------- environment
1.620 albertel 5544: if (($uname eq $env{'user.name'})&&($udom eq $env{'user.domain'})) {
5545: return $env{'environment.'.$spacequalifierrest};
1.219 albertel 5546: } else {
5547: my %returnhash=&userenvironment($udom,$uname,
5548: $spacequalifierrest);
5549: return $returnhash{$spacequalifierrest};
5550: }
1.28 www 5551: } elsif ($realm eq 'system') {
1.48 www 5552: # ----------------------------------------------------------------- system.time
5553: if ($space eq 'time') {
5554: return time;
5555: }
1.696 albertel 5556: } elsif ($realm eq 'server') {
5557: # ----------------------------------------------------------------- system.time
5558: if ($space eq 'name') {
5559: return $ENV{'SERVER_NAME'};
5560: }
1.28 www 5561: }
1.48 www 5562: return '';
1.61 www 5563: }
5564:
1.691 raeburn 5565: sub check_group_parms {
5566: my ($courseid,$groups,$symbparm,$mapparm,$what) = @_;
5567: my @groupitems = ();
5568: my $resultitem;
5569: my @levels = ($symbparm,$mapparm,$what);
5570: foreach my $group (@{$groups}) {
5571: foreach my $level (@levels) {
5572: my $item = $courseid.'.['.$group.'].'.$level;
5573: push(@groupitems,$item);
5574: }
5575: }
5576: my $coursereply = &resdata($env{'course.'.$courseid.'.num'},
5577: $env{'course.'.$courseid.'.domain'},
5578: 'course',@groupitems);
5579: return $coursereply;
5580: }
5581:
5582: sub sort_course_groups { # Sort groups based on defined rankings. Default is sort().
1.733 raeburn 5583: my ($courseid,@groups) = @_;
5584: @groups = sort(@groups);
1.691 raeburn 5585: return @groups;
5586: }
5587:
1.395 albertel 5588: sub packages_tab_default {
5589: my ($uri,$varname)=@_;
5590: my (undef,$part,$name)=split(/\./,$varname);
1.738 albertel 5591:
5592: my (@extension,@specifics,$do_default);
5593: foreach my $package (split(/,/,&metadata($uri,'packages'))) {
1.395 albertel 5594: my ($pack_type,$pack_part)=split(/_/,$package,2);
1.738 albertel 5595: if ($pack_type eq 'default') {
5596: $do_default=1;
5597: } elsif ($pack_type eq 'extension') {
5598: push(@extension,[$package,$pack_type,$pack_part]);
5599: } else {
5600: push(@specifics,[$package,$pack_type,$pack_part]);
5601: }
5602: }
5603: # first look for a package that matches the requested part id
5604: foreach my $package (@specifics) {
5605: my (undef,$pack_type,$pack_part)=@{$package};
5606: next if ($pack_part ne $part);
5607: if (defined($packagetab{"$pack_type&$name&default"})) {
5608: return $packagetab{"$pack_type&$name&default"};
5609: }
5610: }
5611: # look for any possible matching non extension_ package
5612: foreach my $package (@specifics) {
5613: my (undef,$pack_type,$pack_part)=@{$package};
1.468 albertel 5614: if (defined($packagetab{"$pack_type&$name&default"})) {
5615: return $packagetab{"$pack_type&$name&default"};
5616: }
1.585 albertel 5617: if ($pack_type eq 'part') { $pack_part='0'; }
1.468 albertel 5618: if (defined($packagetab{$pack_type."_".$pack_part."&$name&default"})) {
5619: return $packagetab{$pack_type."_".$pack_part."&$name&default"};
1.395 albertel 5620: }
5621: }
1.738 albertel 5622: # look for any posible extension_ match
5623: foreach my $package (@extension) {
5624: my ($package,$pack_type)=@{$package};
5625: if (defined($packagetab{"$pack_type&$name&default"})) {
5626: return $packagetab{"$pack_type&$name&default"};
5627: }
5628: if (defined($packagetab{$package."&$name&default"})) {
5629: return $packagetab{$package."&$name&default"};
5630: }
5631: }
5632: # look for a global default setting
5633: if ($do_default && defined($packagetab{"default&$name&default"})) {
5634: return $packagetab{"default&$name&default"};
5635: }
1.395 albertel 5636: return undef;
5637: }
5638:
1.334 albertel 5639: sub add_prefix_and_part {
5640: my ($prefix,$part)=@_;
5641: my $keyroot;
5642: if (defined($prefix) && $prefix !~ /^__/) {
5643: # prefix that has a part already
5644: $keyroot=$prefix;
5645: } elsif (defined($prefix)) {
5646: # prefix that is missing a part
5647: if (defined($part)) { $keyroot='_'.$part.substr($prefix,1); }
5648: } else {
5649: # no prefix at all
5650: if (defined($part)) { $keyroot='_'.$part; }
5651: }
5652: return $keyroot;
5653: }
5654:
1.71 www 5655: # ---------------------------------------------------------------- Get metadata
5656:
1.599 albertel 5657: my %metaentry;
1.71 www 5658: sub metadata {
1.176 www 5659: my ($uri,$what,$liburi,$prefix,$depthcount)=@_;
1.71 www 5660: $uri=&declutter($uri);
1.288 albertel 5661: # if it is a non metadata possible uri return quickly
1.529 albertel 5662: if (($uri eq '') ||
5663: (($uri =~ m|^/*adm/|) &&
1.698 albertel 5664: ($uri !~ m|^adm/includes|) && ($uri !~ m|/bulletinboard$|)) ||
1.423 albertel 5665: ($uri =~ m|/$|) || ($uri =~ m|/.meta$|) || ($uri =~ /^~/) ||
1.489 albertel 5666: ($uri =~ m|home/[^/]+/public_html/|)) {
1.468 albertel 5667: return undef;
1.288 albertel 5668: }
1.73 www 5669: my $filename=$uri;
5670: $uri=~s/\.meta$//;
1.172 www 5671: #
5672: # Is the metadata already cached?
1.177 www 5673: # Look at timestamp of caching
1.172 www 5674: # Everything is cached by the main uri, libraries are never directly cached
5675: #
1.428 albertel 5676: if (!defined($liburi)) {
1.599 albertel 5677: my ($result,$cached)=&is_cached_new('meta',$uri);
1.428 albertel 5678: if (defined($cached)) { return $result->{':'.$what}; }
5679: }
5680: {
1.172 www 5681: #
5682: # Is this a recursive call for a library?
5683: #
1.599 albertel 5684: # if (! exists($metacache{$uri})) {
5685: # $metacache{$uri}={};
5686: # }
1.171 www 5687: if ($liburi) {
5688: $liburi=&declutter($liburi);
5689: $filename=$liburi;
1.401 bowersj2 5690: } else {
1.599 albertel 5691: &devalidate_cache_new('meta',$uri);
5692: undef(%metaentry);
1.401 bowersj2 5693: }
1.140 www 5694: my %metathesekeys=();
1.73 www 5695: unless ($filename=~/\.meta$/) { $filename.='.meta'; }
1.489 albertel 5696: my $metastring;
1.609 banghart 5697: if ($uri !~ m -^(uploaded|editupload)/-) {
1.543 albertel 5698: my $file=&filelocation('',&clutter($filename));
1.599 albertel 5699: #push(@{$metaentry{$uri.'.file'}},$file);
1.543 albertel 5700: $metastring=&getfile($file);
1.489 albertel 5701: }
1.208 albertel 5702: my $parser=HTML::LCParser->new(\$metastring);
1.71 www 5703: my $token;
1.140 www 5704: undef %metathesekeys;
1.71 www 5705: while ($token=$parser->get_token) {
1.339 albertel 5706: if ($token->[0] eq 'S') {
5707: if (defined($token->[2]->{'package'})) {
1.172 www 5708: #
5709: # This is a package - get package info
5710: #
1.339 albertel 5711: my $package=$token->[2]->{'package'};
5712: my $keyroot=&add_prefix_and_part($prefix,$token->[2]->{'part'});
5713: if (defined($token->[2]->{'id'})) {
5714: $keyroot.='_'.$token->[2]->{'id'};
5715: }
1.599 albertel 5716: if ($metaentry{':packages'}) {
5717: $metaentry{':packages'}.=','.$package.$keyroot;
1.339 albertel 5718: } else {
1.599 albertel 5719: $metaentry{':packages'}=$package.$keyroot;
1.339 albertel 5720: }
1.736 albertel 5721: foreach my $pack_entry (keys(%packagetab)) {
1.432 albertel 5722: my $part=$keyroot;
5723: $part=~s/^\_//;
1.736 albertel 5724: if ($pack_entry=~/^\Q$package\E\&/ ||
5725: $pack_entry=~/^\Q$package\E_0\&/) {
5726: my ($pack,$name,$subp)=split(/\&/,$pack_entry);
1.395 albertel 5727: # ignore package.tab specified default values
5728: # here &package_tab_default() will fetch those
5729: if ($subp eq 'default') { next; }
1.736 albertel 5730: my $value=$packagetab{$pack_entry};
1.432 albertel 5731: my $unikey;
5732: if ($pack =~ /_0$/) {
5733: $unikey='parameter_0_'.$name;
5734: $part=0;
5735: } else {
5736: $unikey='parameter'.$keyroot.'_'.$name;
5737: }
1.339 albertel 5738: if ($subp eq 'display') {
5739: $value.=' [Part: '.$part.']';
5740: }
1.599 albertel 5741: $metaentry{':'.$unikey.'.part'}=$part;
1.395 albertel 5742: $metathesekeys{$unikey}=1;
1.599 albertel 5743: unless (defined($metaentry{':'.$unikey.'.'.$subp})) {
5744: $metaentry{':'.$unikey.'.'.$subp}=$value;
1.339 albertel 5745: }
1.599 albertel 5746: if (defined($metaentry{':'.$unikey.'.default'})) {
5747: $metaentry{':'.$unikey}=
5748: $metaentry{':'.$unikey.'.default'};
1.356 albertel 5749: }
1.339 albertel 5750: }
5751: }
5752: } else {
1.172 www 5753: #
5754: # This is not a package - some other kind of start tag
1.339 albertel 5755: #
5756: my $entry=$token->[1];
5757: my $unikey;
5758: if ($entry eq 'import') {
5759: $unikey='';
5760: } else {
5761: $unikey=$entry;
5762: }
5763: $unikey.=&add_prefix_and_part($prefix,$token->[2]->{'part'});
5764:
5765: if (defined($token->[2]->{'id'})) {
5766: $unikey.='_'.$token->[2]->{'id'};
5767: }
1.175 www 5768:
1.339 albertel 5769: if ($entry eq 'import') {
1.175 www 5770: #
5771: # Importing a library here
1.339 albertel 5772: #
5773: if ($depthcount<20) {
5774: my $location=$parser->get_text('/import');
5775: my $dir=$filename;
5776: $dir=~s|[^/]*$||;
5777: $location=&filelocation($dir,$location);
1.736 albertel 5778: my $metadata =
5779: &metadata($uri,'keys', $location,$unikey,
5780: $depthcount+1);
5781: foreach my $meta (split(',',$metadata)) {
5782: $metaentry{':'.$meta}=$metaentry{':'.$meta};
5783: $metathesekeys{$meta}=1;
1.339 albertel 5784: }
5785: }
5786: } else {
5787:
5788: if (defined($token->[2]->{'name'})) {
5789: $unikey.='_'.$token->[2]->{'name'};
5790: }
5791: $metathesekeys{$unikey}=1;
1.736 albertel 5792: foreach my $param (@{$token->[3]}) {
5793: $metaentry{':'.$unikey.'.'.$param} =
5794: $token->[2]->{$param};
1.339 albertel 5795: }
5796: my $internaltext=&HTML::Entities::decode($parser->get_text('/'.$entry));
1.599 albertel 5797: my $default=$metaentry{':'.$unikey.'.default'};
1.339 albertel 5798: if ( $internaltext =~ /^\s*$/ && $default !~ /^\s*$/) {
5799: # only ws inside the tag, and not in default, so use default
5800: # as value
1.599 albertel 5801: $metaentry{':'.$unikey}=$default;
1.339 albertel 5802: } else {
1.321 albertel 5803: # either something interesting inside the tag or default
5804: # uninteresting
1.599 albertel 5805: $metaentry{':'.$unikey}=$internaltext;
1.339 albertel 5806: }
1.172 www 5807: # end of not-a-package not-a-library import
1.339 albertel 5808: }
1.172 www 5809: # end of not-a-package start tag
1.339 albertel 5810: }
1.172 www 5811: # the next is the end of "start tag"
1.339 albertel 5812: }
5813: }
1.483 albertel 5814: my ($extension) = ($uri =~ /\.(\w+)$/);
1.737 albertel 5815: foreach my $key (keys(%packagetab)) {
1.483 albertel 5816: #no specific packages #how's our extension
5817: if ($key!~/^extension_\Q$extension\E&/) { next; }
1.488 albertel 5818: &metadata_create_package_def($uri,$key,'extension_'.$extension,
1.483 albertel 5819: \%metathesekeys);
5820: }
1.599 albertel 5821: if (!exists($metaentry{':packages'})) {
1.737 albertel 5822: foreach my $key (keys(%packagetab)) {
1.483 albertel 5823: #no specific packages well let's get default then
5824: if ($key!~/^default&/) { next; }
1.488 albertel 5825: &metadata_create_package_def($uri,$key,'default',
1.483 albertel 5826: \%metathesekeys);
5827: }
5828: }
1.338 www 5829: # are there custom rights to evaluate
1.599 albertel 5830: if ($metaentry{':copyright'} eq 'custom') {
1.339 albertel 5831:
1.338 www 5832: #
5833: # Importing a rights file here
1.339 albertel 5834: #
5835: unless ($depthcount) {
1.599 albertel 5836: my $location=$metaentry{':customdistributionfile'};
1.339 albertel 5837: my $dir=$filename;
5838: $dir=~s|[^/]*$||;
5839: $location=&filelocation($dir,$location);
1.736 albertel 5840: my $rights_metadata =
5841: &metadata($uri,'keys',$location,'_rights',
5842: $depthcount+1);
5843: foreach my $rights (split(',',$rights_metadata)) {
5844: #$metaentry{':'.$rights}=$metacache{$uri}->{':'.$rights};
5845: $metathesekeys{$rights}=1;
1.339 albertel 5846: }
5847: }
5848: }
1.737 albertel 5849: # uniqifiy package listing
5850: my %seen;
5851: my @uniq_packages =
5852: grep { ! $seen{$_} ++ } (split(',',$metaentry{':packages'}));
5853: $metaentry{':packages'} = join(',',@uniq_packages);
5854:
5855: $metaentry{':keys'} = join(',',keys(%metathesekeys));
1.599 albertel 5856: &metadata_generate_part0(\%metathesekeys,\%metaentry,$uri);
5857: $metaentry{':allpossiblekeys'}=join(',',keys %metathesekeys);
1.699 albertel 5858: &do_cache_new('meta',$uri,\%metaentry,60*60);
1.177 www 5859: # this is the end of "was not already recently cached
1.71 www 5860: }
1.599 albertel 5861: return $metaentry{':'.$what};
1.261 albertel 5862: }
5863:
1.488 albertel 5864: sub metadata_create_package_def {
1.483 albertel 5865: my ($uri,$key,$package,$metathesekeys)=@_;
5866: my ($pack,$name,$subp)=split(/\&/,$key);
5867: if ($subp eq 'default') { next; }
5868:
1.599 albertel 5869: if (defined($metaentry{':packages'})) {
5870: $metaentry{':packages'}.=','.$package;
1.483 albertel 5871: } else {
1.599 albertel 5872: $metaentry{':packages'}=$package;
1.483 albertel 5873: }
5874: my $value=$packagetab{$key};
5875: my $unikey;
5876: $unikey='parameter_0_'.$name;
1.599 albertel 5877: $metaentry{':'.$unikey.'.part'}=0;
1.483 albertel 5878: $$metathesekeys{$unikey}=1;
1.599 albertel 5879: unless (defined($metaentry{':'.$unikey.'.'.$subp})) {
5880: $metaentry{':'.$unikey.'.'.$subp}=$value;
1.483 albertel 5881: }
1.599 albertel 5882: if (defined($metaentry{':'.$unikey.'.default'})) {
5883: $metaentry{':'.$unikey}=
5884: $metaentry{':'.$unikey.'.default'};
1.483 albertel 5885: }
5886: }
5887:
1.261 albertel 5888: sub metadata_generate_part0 {
5889: my ($metadata,$metacache,$uri) = @_;
5890: my %allnames;
1.737 albertel 5891: foreach my $metakey (keys(%$metadata)) {
1.261 albertel 5892: if ($metakey=~/^parameter\_(.*)/) {
1.428 albertel 5893: my $part=$$metacache{':'.$metakey.'.part'};
5894: my $name=$$metacache{':'.$metakey.'.name'};
1.356 albertel 5895: if (! exists($$metadata{'parameter_0_'.$name.'.name'})) {
1.261 albertel 5896: $allnames{$name}=$part;
5897: }
5898: }
5899: }
5900: foreach my $name (keys(%allnames)) {
5901: $$metadata{"parameter_0_$name"}=1;
1.428 albertel 5902: my $key=":parameter_0_$name";
1.261 albertel 5903: $$metacache{"$key.part"}='0';
5904: $$metacache{"$key.name"}=$name;
1.428 albertel 5905: $$metacache{"$key.type"}=$$metacache{':parameter_'.
1.261 albertel 5906: $allnames{$name}.'_'.$name.
5907: '.type'};
1.428 albertel 5908: my $olddis=$$metacache{':parameter_'.$allnames{$name}.'_'.$name.
1.261 albertel 5909: '.display'};
1.644 www 5910: my $expr='[Part: '.$allnames{$name}.']';
1.479 albertel 5911: $olddis=~s/\Q$expr\E/\[Part: 0\]/;
1.261 albertel 5912: $$metacache{"$key.display"}=$olddis;
5913: }
1.71 www 5914: }
5915:
1.301 www 5916: # ------------------------------------------------- Get the title of a resource
5917:
5918: sub gettitle {
5919: my $urlsymb=shift;
5920: my $symb=&symbread($urlsymb);
1.534 albertel 5921: if ($symb) {
1.620 albertel 5922: my $key=$env{'request.course.id'}."\0".$symb;
1.599 albertel 5923: my ($result,$cached)=&is_cached_new('title',$key);
1.575 albertel 5924: if (defined($cached)) {
5925: return $result;
5926: }
1.534 albertel 5927: my ($map,$resid,$url)=&decode_symb($symb);
5928: my $title='';
5929: my %bighash;
1.620 albertel 5930: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
1.534 albertel 5931: &GDBM_READER(),0640)) {
5932: my $mapid=$bighash{'map_pc_'.&clutter($map)};
5933: $title=$bighash{'title_'.$mapid.'.'.$resid};
5934: untie %bighash;
5935: }
5936: $title=~s/\&colon\;/\:/gs;
5937: if ($title) {
1.599 albertel 5938: return &do_cache_new('title',$key,$title,600);
1.534 albertel 5939: }
5940: $urlsymb=$url;
5941: }
5942: my $title=&metadata($urlsymb,'title');
5943: if (!$title) { $title=(split('/',$urlsymb))[-1]; }
5944: return $title;
1.301 www 5945: }
1.613 albertel 5946:
1.614 albertel 5947: sub get_slot {
5948: my ($which,$cnum,$cdom)=@_;
5949: if (!$cnum || !$cdom) {
5950: (undef,my $courseid)=&Apache::lonxml::whichuser();
1.620 albertel 5951: $cdom=$env{'course.'.$courseid.'.domain'};
5952: $cnum=$env{'course.'.$courseid.'.num'};
1.614 albertel 5953: }
1.703 albertel 5954: my $key=join("\0",'slots',$cdom,$cnum,$which);
5955: my %slotinfo;
5956: if (exists($remembered{$key})) {
5957: $slotinfo{$which} = $remembered{$key};
5958: } else {
5959: %slotinfo=&get('slots',[$which],$cdom,$cnum);
5960: &Apache::lonhomework::showhash(%slotinfo);
5961: my ($tmp)=keys(%slotinfo);
5962: if ($tmp=~/^error:/) { return (); }
5963: $remembered{$key} = $slotinfo{$which};
5964: }
1.616 albertel 5965: if (ref($slotinfo{$which}) eq 'HASH') {
5966: return %{$slotinfo{$which}};
5967: }
5968: return $slotinfo{$which};
1.614 albertel 5969: }
1.31 www 5970: # ------------------------------------------------- Update symbolic store links
5971:
5972: sub symblist {
5973: my ($mapname,%newhash)=@_;
1.438 www 5974: $mapname=&deversion(&declutter($mapname));
1.31 www 5975: my %hash;
1.620 albertel 5976: if (($env{'request.course.fn'}) && (%newhash)) {
5977: if (tie(%hash,'GDBM_File',$env{'request.course.fn'}.'_symb.db',
1.256 albertel 5978: &GDBM_WRCREAT(),0640)) {
1.711 albertel 5979: foreach my $url (keys %newhash) {
5980: next if ($url eq 'last_known'
5981: && $env{'form.no_update_last_known'});
5982: $hash{declutter($url)}=&encode_symb($mapname,
5983: $newhash{$url}->[1],
5984: $newhash{$url}->[0]);
1.191 harris41 5985: }
1.31 www 5986: if (untie(%hash)) {
5987: return 'ok';
5988: }
5989: }
5990: }
5991: return 'error';
1.212 www 5992: }
5993:
5994: # --------------------------------------------------------------- Verify a symb
5995:
5996: sub symbverify {
1.510 www 5997: my ($symb,$thisurl)=@_;
5998: my $thisfn=$thisurl;
5999: # wrapper not part of symbs
6000: $thisfn=~s/^\/adm\/wrapper//;
1.694 albertel 6001: $thisfn=~s/^\/adm\/coursedocs\/showdoc\///;
1.439 www 6002: $thisfn=&declutter($thisfn);
1.215 www 6003: # direct jump to resource in page or to a sequence - will construct own symbs
6004: if ($thisfn=~/\.(page|sequence)$/) { return 1; }
6005: # check URL part
1.409 www 6006: my ($map,$resid,$url)=&decode_symb($symb);
1.439 www 6007:
1.431 www 6008: unless ($url eq $thisfn) { return 0; }
1.213 www 6009:
1.216 www 6010: $symb=&symbclean($symb);
1.510 www 6011: $thisurl=&deversion($thisurl);
1.439 www 6012: $thisfn=&deversion($thisfn);
1.213 www 6013:
6014: my %bighash;
6015: my $okay=0;
1.431 www 6016:
1.620 albertel 6017: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
1.256 albertel 6018: &GDBM_READER(),0640)) {
1.510 www 6019: my $ids=$bighash{'ids_'.&clutter($thisurl)};
1.216 www 6020: unless ($ids) {
1.510 www 6021: $ids=$bighash{'ids_/'.$thisurl};
1.216 www 6022: }
6023: if ($ids) {
6024: # ------------------------------------------------------------------- Has ID(s)
6025: foreach (split(/\,/,$ids)) {
1.644 www 6026: my ($mapid,$resid)=split(/\./,$_);
1.216 www 6027: if (
6028: &symbclean(&declutter($bighash{'map_id_'.$mapid}).'___'.$resid.'___'.$thisfn)
6029: eq $symb) {
1.620 albertel 6030: if (($env{'request.role.adv'}) ||
6031: $bighash{'encrypted_'.$_} eq $env{'request.enc'}) {
1.582 albertel 6032: $okay=1;
6033: }
6034: }
1.216 www 6035: }
6036: }
1.213 www 6037: untie(%bighash);
6038: }
6039: return $okay;
1.31 www 6040: }
6041:
1.210 www 6042: # --------------------------------------------------------------- Clean-up symb
6043:
6044: sub symbclean {
6045: my $symb=shift;
1.568 albertel 6046: if ($symb=~m|^/enc/|) { $symb=&Apache::lonenc::unencrypted($symb); }
1.210 www 6047: # remove version from map
6048: $symb=~s/\.(\d+)\.(\w+)\_\_\_/\.$2\_\_\_/;
1.215 www 6049:
1.210 www 6050: # remove version from URL
6051: $symb=~s/\.(\d+)\.(\w+)$/\.$2/;
1.213 www 6052:
1.507 www 6053: # remove wrapper
6054:
1.510 www 6055: $symb=~s/(\_\_\_\d+\_\_\_)adm\/wrapper\/(res\/)*/$1/;
1.694 albertel 6056: $symb=~s/(\_\_\_\d+\_\_\_)adm\/coursedocs\/showdoc\/(res\/)*/$1/;
1.210 www 6057: return $symb;
1.409 www 6058: }
6059:
6060: # ---------------------------------------------- Split symb to find map and url
1.429 albertel 6061:
6062: sub encode_symb {
6063: my ($map,$resid,$url)=@_;
6064: return &symbclean(&declutter($map).'___'.$resid.'___'.&declutter($url));
6065: }
1.409 www 6066:
6067: sub decode_symb {
1.568 albertel 6068: my $symb=shift;
6069: if ($symb=~m|^/enc/|) { $symb=&Apache::lonenc::unencrypted($symb); }
6070: my ($map,$resid,$url)=split(/___/,$symb);
1.413 www 6071: return (&fixversion($map),$resid,&fixversion($url));
6072: }
6073:
6074: sub fixversion {
6075: my $fn=shift;
1.609 banghart 6076: if ($fn=~/^(adm|uploaded|editupload|public)/) { return $fn; }
1.435 www 6077: my %bighash;
6078: my $uri=&clutter($fn);
1.620 albertel 6079: my $key=$env{'request.course.id'}.'_'.$uri;
1.440 www 6080: # is this cached?
1.599 albertel 6081: my ($result,$cached)=&is_cached_new('courseresversion',$key);
1.440 www 6082: if (defined($cached)) { return $result; }
6083: # unfortunately not cached, or expired
1.620 albertel 6084: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
1.440 www 6085: &GDBM_READER(),0640)) {
6086: if ($bighash{'version_'.$uri}) {
6087: my $version=$bighash{'version_'.$uri};
1.444 www 6088: unless (($version eq 'mostrecent') ||
6089: ($version==&getversion($uri))) {
1.440 www 6090: $uri=~s/\.(\w+)$/\.$version\.$1/;
6091: }
6092: }
6093: untie %bighash;
1.413 www 6094: }
1.599 albertel 6095: return &do_cache_new('courseresversion',$key,&declutter($uri),600);
1.438 www 6096: }
6097:
6098: sub deversion {
6099: my $url=shift;
6100: $url=~s/\.\d+\.(\w+)$/\.$1/;
6101: return $url;
1.210 www 6102: }
6103:
1.31 www 6104: # ------------------------------------------------------ Return symb list entry
6105:
6106: sub symbread {
1.249 www 6107: my ($thisfn,$donotrecurse)=@_;
1.542 albertel 6108: my $cache_str='request.symbread.cached.'.$thisfn;
1.620 albertel 6109: if (defined($env{$cache_str})) { return $env{$cache_str}; }
1.242 www 6110: # no filename provided? try from environment
1.44 www 6111: unless ($thisfn) {
1.620 albertel 6112: if ($env{'request.symb'}) {
6113: return $env{$cache_str}=&symbclean($env{'request.symb'});
1.539 albertel 6114: }
1.620 albertel 6115: $thisfn=$env{'request.filename'};
1.44 www 6116: }
1.569 albertel 6117: if ($thisfn=~m|^/enc/|) { $thisfn=&Apache::lonenc::unencrypted($thisfn); }
1.242 www 6118: # is that filename actually a symb? Verify, clean, and return
6119: if ($thisfn=~/\_\_\_\d+\_\_\_(.*)$/) {
1.539 albertel 6120: if (&symbverify($thisfn,$1)) {
1.620 albertel 6121: return $env{$cache_str}=&symbclean($thisfn);
1.539 albertel 6122: }
1.242 www 6123: }
1.44 www 6124: $thisfn=declutter($thisfn);
1.31 www 6125: my %hash;
1.37 www 6126: my %bighash;
6127: my $syval='';
1.620 albertel 6128: if (($env{'request.course.fn'}) && ($thisfn)) {
1.481 raeburn 6129: my $targetfn = $thisfn;
1.609 banghart 6130: if ( ($thisfn =~ m/^(uploaded|editupload)\//) && ($thisfn !~ m/\.(page|sequence)$/) ) {
1.481 raeburn 6131: $targetfn = 'adm/wrapper/'.$thisfn;
6132: }
1.687 albertel 6133: if ($targetfn =~ m|^adm/wrapper/(ext/.*)|) {
6134: $targetfn=$1;
6135: }
1.620 albertel 6136: if (tie(%hash,'GDBM_File',$env{'request.course.fn'}.'_symb.db',
1.256 albertel 6137: &GDBM_READER(),0640)) {
1.481 raeburn 6138: $syval=$hash{$targetfn};
1.37 www 6139: untie(%hash);
6140: }
6141: # ---------------------------------------------------------- There was an entry
6142: if ($syval) {
1.601 albertel 6143: #unless ($syval=~/\_\d+$/) {
1.620 albertel 6144: #unless ($env{'form.request.prefix'}=~/\.(\d+)\_$/) {
1.601 albertel 6145: #&appenv('request.ambiguous' => $thisfn);
1.620 albertel 6146: #return $env{$cache_str}='';
1.601 albertel 6147: #}
6148: #$syval.=$1;
6149: #}
1.37 www 6150: } else {
6151: # ------------------------------------------------------- Was not in symb table
1.620 albertel 6152: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
1.256 albertel 6153: &GDBM_READER(),0640)) {
1.37 www 6154: # ---------------------------------------------- Get ID(s) for current resource
1.280 www 6155: my $ids=$bighash{'ids_'.&clutter($thisfn)};
1.65 www 6156: unless ($ids) {
6157: $ids=$bighash{'ids_/'.$thisfn};
1.242 www 6158: }
6159: unless ($ids) {
6160: # alias?
6161: $ids=$bighash{'mapalias_'.$thisfn};
1.65 www 6162: }
1.37 www 6163: if ($ids) {
6164: # ------------------------------------------------------------------- Has ID(s)
6165: my @possibilities=split(/\,/,$ids);
1.39 www 6166: if ($#possibilities==0) {
6167: # ----------------------------------------------- There is only one possibility
1.37 www 6168: my ($mapid,$resid)=split(/\./,$ids);
1.626 albertel 6169: $syval=&encode_symb($bighash{'map_id_'.$mapid},
6170: $resid,$thisfn);
1.249 www 6171: } elsif (!$donotrecurse) {
1.39 www 6172: # ------------------------------------------ There is more than one possibility
6173: my $realpossible=0;
1.191 harris41 6174: foreach (@possibilities) {
1.39 www 6175: my $file=$bighash{'src_'.$_};
6176: if (&allowed('bre',$file)) {
6177: my ($mapid,$resid)=split(/\./,$_);
6178: if ($bighash{'map_type_'.$mapid} ne 'page') {
6179: $realpossible++;
1.626 albertel 6180: $syval=&encode_symb($bighash{'map_id_'.$mapid},
6181: $resid,$thisfn);
1.39 www 6182: }
6183: }
1.191 harris41 6184: }
1.39 www 6185: if ($realpossible!=1) { $syval=''; }
1.249 www 6186: } else {
6187: $syval='';
1.37 www 6188: }
6189: }
6190: untie(%bighash)
1.481 raeburn 6191: }
1.31 www 6192: }
1.62 www 6193: if ($syval) {
1.620 albertel 6194: return $env{$cache_str}=$syval;
1.62 www 6195: }
1.31 www 6196: }
1.44 www 6197: &appenv('request.ambiguous' => $thisfn);
1.620 albertel 6198: return $env{$cache_str}='';
1.31 www 6199: }
6200:
6201: # ---------------------------------------------------------- Return random seed
6202:
1.32 www 6203: sub numval {
6204: my $txt=shift;
6205: $txt=~tr/A-J/0-9/;
6206: $txt=~tr/a-j/0-9/;
6207: $txt=~tr/K-T/0-9/;
6208: $txt=~tr/k-t/0-9/;
6209: $txt=~tr/U-Z/0-5/;
6210: $txt=~tr/u-z/0-5/;
6211: $txt=~s/\D//g;
1.564 albertel 6212: if ($_64bit) { if ($txt > 2**32) { return -1; } }
1.32 www 6213: return int($txt);
1.368 albertel 6214: }
6215:
1.484 albertel 6216: sub numval2 {
6217: my $txt=shift;
6218: $txt=~tr/A-J/0-9/;
6219: $txt=~tr/a-j/0-9/;
6220: $txt=~tr/K-T/0-9/;
6221: $txt=~tr/k-t/0-9/;
6222: $txt=~tr/U-Z/0-5/;
6223: $txt=~tr/u-z/0-5/;
6224: $txt=~s/\D//g;
6225: my @txts=split(/(\d\d\d\d\d\d\d\d\d)/,$txt);
6226: my $total;
6227: foreach my $val (@txts) { $total+=$val; }
1.564 albertel 6228: if ($_64bit) { if ($total > 2**32) { return -1; } }
1.484 albertel 6229: return int($total);
6230: }
6231:
1.575 albertel 6232: sub numval3 {
6233: use integer;
6234: my $txt=shift;
6235: $txt=~tr/A-J/0-9/;
6236: $txt=~tr/a-j/0-9/;
6237: $txt=~tr/K-T/0-9/;
6238: $txt=~tr/k-t/0-9/;
6239: $txt=~tr/U-Z/0-5/;
6240: $txt=~tr/u-z/0-5/;
6241: $txt=~s/\D//g;
6242: my @txts=split(/(\d\d\d\d\d\d\d\d\d)/,$txt);
6243: my $total;
6244: foreach my $val (@txts) { $total+=$val; }
6245: if ($_64bit) { $total=(($total<<32)>>32); }
6246: return $total;
6247: }
6248:
1.675 albertel 6249: sub digest {
6250: my ($data)=@_;
6251: my $digest=&Digest::MD5::md5($data);
6252: my ($a,$b,$c,$d)=unpack("iiii",$digest);
6253: my ($e,$f);
6254: {
6255: use integer;
6256: $e=($a+$b);
6257: $f=($c+$d);
6258: if ($_64bit) {
6259: $e=(($e<<32)>>32);
6260: $f=(($f<<32)>>32);
6261: }
6262: }
6263: if (wantarray) {
6264: return ($e,$f);
6265: } else {
6266: my $g;
6267: {
6268: use integer;
6269: $g=($e+$f);
6270: if ($_64bit) {
6271: $g=(($g<<32)>>32);
6272: }
6273: }
6274: return $g;
6275: }
6276: }
6277:
1.368 albertel 6278: sub latest_rnd_algorithm_id {
1.675 albertel 6279: return '64bit5';
1.366 albertel 6280: }
1.32 www 6281:
1.503 albertel 6282: sub get_rand_alg {
6283: my ($courseid)=@_;
6284: if (!$courseid) { $courseid=(&Apache::lonxml::whichuser())[1]; }
6285: if ($courseid) {
1.620 albertel 6286: return $env{"course.$courseid.rndseed"};
1.503 albertel 6287: }
6288: return &latest_rnd_algorithm_id();
6289: }
6290:
1.562 albertel 6291: sub validCODE {
6292: my ($CODE)=@_;
6293: if (defined($CODE) && $CODE ne '' && $CODE =~ /^\w+$/) { return 1; }
6294: return 0;
6295: }
6296:
1.491 albertel 6297: sub getCODE {
1.620 albertel 6298: if (&validCODE($env{'form.CODE'})) { return $env{'form.CODE'}; }
1.618 albertel 6299: if ( (defined($Apache::lonhomework::parsing_a_problem) ||
6300: defined($Apache::lonhomework::parsing_a_task) ) &&
6301: &validCODE($Apache::lonhomework::history{'resource.CODE'})) {
1.491 albertel 6302: return $Apache::lonhomework::history{'resource.CODE'};
6303: }
6304: return undef;
6305: }
6306:
1.31 www 6307: sub rndseed {
1.155 albertel 6308: my ($symb,$courseid,$domain,$username)=@_;
1.366 albertel 6309:
6310: my ($wsymb,$wcourseid,$wdomain,$wusername)=&Apache::lonxml::whichuser();
1.155 albertel 6311: if (!$symb) {
1.366 albertel 6312: unless ($symb=$wsymb) { return time; }
6313: }
6314: if (!$courseid) { $courseid=$wcourseid; }
6315: if (!$domain) { $domain=$wdomain; }
6316: if (!$username) { $username=$wusername }
1.503 albertel 6317: my $which=&get_rand_alg();
1.491 albertel 6318: if (defined(&getCODE())) {
1.675 albertel 6319: if ($which eq '64bit5') {
6320: return &rndseed_CODE_64bit5($symb,$courseid,$domain,$username);
6321: } elsif ($which eq '64bit4') {
1.575 albertel 6322: return &rndseed_CODE_64bit4($symb,$courseid,$domain,$username);
6323: } else {
6324: return &rndseed_CODE_64bit($symb,$courseid,$domain,$username);
6325: }
1.675 albertel 6326: } elsif ($which eq '64bit5') {
6327: return &rndseed_64bit5($symb,$courseid,$domain,$username);
1.575 albertel 6328: } elsif ($which eq '64bit4') {
6329: return &rndseed_64bit4($symb,$courseid,$domain,$username);
1.501 albertel 6330: } elsif ($which eq '64bit3') {
6331: return &rndseed_64bit3($symb,$courseid,$domain,$username);
1.443 albertel 6332: } elsif ($which eq '64bit2') {
6333: return &rndseed_64bit2($symb,$courseid,$domain,$username);
1.366 albertel 6334: } elsif ($which eq '64bit') {
6335: return &rndseed_64bit($symb,$courseid,$domain,$username);
6336: }
6337: return &rndseed_32bit($symb,$courseid,$domain,$username);
6338: }
6339:
6340: sub rndseed_32bit {
6341: my ($symb,$courseid,$domain,$username)=@_;
6342: {
6343: use integer;
6344: my $symbchck=unpack("%32C*",$symb) << 27;
6345: my $symbseed=numval($symb) << 22;
6346: my $namechck=unpack("%32C*",$username) << 17;
6347: my $nameseed=numval($username) << 12;
6348: my $domainseed=unpack("%32C*",$domain) << 7;
6349: my $courseseed=unpack("%32C*",$courseid);
6350: my $num=$symbseed+$nameseed+$domainseed+$courseseed+$namechck+$symbchck;
6351: #&Apache::lonxml::debug("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
6352: #&Apache::lonxml::debug("rndseed :$num:$symb");
1.564 albertel 6353: if ($_64bit) { $num=(($num<<32)>>32); }
1.366 albertel 6354: return $num;
6355: }
6356: }
6357:
6358: sub rndseed_64bit {
6359: my ($symb,$courseid,$domain,$username)=@_;
6360: {
6361: use integer;
6362: my $symbchck=unpack("%32S*",$symb) << 21;
6363: my $symbseed=numval($symb) << 10;
6364: my $namechck=unpack("%32S*",$username);
6365:
6366: my $nameseed=numval($username) << 21;
6367: my $domainseed=unpack("%32S*",$domain) << 10;
6368: my $courseseed=unpack("%32S*",$courseid);
6369:
6370: my $num1=$symbchck+$symbseed+$namechck;
6371: my $num2=$nameseed+$domainseed+$courseseed;
6372: #&Apache::lonxml::debug("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
6373: #&Apache::lonxml::debug("rndseed :$num:$symb");
1.564 albertel 6374: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
6375: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
1.366 albertel 6376: return "$num1,$num2";
1.155 albertel 6377: }
1.366 albertel 6378: }
6379:
1.443 albertel 6380: sub rndseed_64bit2 {
6381: my ($symb,$courseid,$domain,$username)=@_;
6382: {
6383: use integer;
6384: # strings need to be an even # of cahracters long, it it is odd the
6385: # last characters gets thrown away
6386: my $symbchck=unpack("%32S*",$symb.' ') << 21;
6387: my $symbseed=numval($symb) << 10;
6388: my $namechck=unpack("%32S*",$username.' ');
6389:
6390: my $nameseed=numval($username) << 21;
1.501 albertel 6391: my $domainseed=unpack("%32S*",$domain.' ') << 10;
6392: my $courseseed=unpack("%32S*",$courseid.' ');
6393:
6394: my $num1=$symbchck+$symbseed+$namechck;
6395: my $num2=$nameseed+$domainseed+$courseseed;
6396: #&Apache::lonxml::debug("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
6397: #&Apache::lonxml::debug("rndseed :$num:$symb");
6398: return "$num1,$num2";
6399: }
6400: }
6401:
6402: sub rndseed_64bit3 {
6403: my ($symb,$courseid,$domain,$username)=@_;
6404: {
6405: use integer;
6406: # strings need to be an even # of cahracters long, it it is odd the
6407: # last characters gets thrown away
6408: my $symbchck=unpack("%32S*",$symb.' ') << 21;
6409: my $symbseed=numval2($symb) << 10;
6410: my $namechck=unpack("%32S*",$username.' ');
6411:
6412: my $nameseed=numval2($username) << 21;
1.443 albertel 6413: my $domainseed=unpack("%32S*",$domain.' ') << 10;
6414: my $courseseed=unpack("%32S*",$courseid.' ');
6415:
6416: my $num1=$symbchck+$symbseed+$namechck;
6417: my $num2=$nameseed+$domainseed+$courseseed;
6418: #&Apache::lonxml::debug("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
1.564 albertel 6419: #&Apache::lonxml::debug("rndseed :$num1:$num2:$_64bit");
6420: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
6421:
1.503 albertel 6422: return "$num1:$num2";
1.443 albertel 6423: }
6424: }
6425:
1.575 albertel 6426: sub rndseed_64bit4 {
6427: my ($symb,$courseid,$domain,$username)=@_;
6428: {
6429: use integer;
6430: # strings need to be an even # of cahracters long, it it is odd the
6431: # last characters gets thrown away
6432: my $symbchck=unpack("%32S*",$symb.' ') << 21;
6433: my $symbseed=numval3($symb) << 10;
6434: my $namechck=unpack("%32S*",$username.' ');
6435:
6436: my $nameseed=numval3($username) << 21;
6437: my $domainseed=unpack("%32S*",$domain.' ') << 10;
6438: my $courseseed=unpack("%32S*",$courseid.' ');
6439:
6440: my $num1=$symbchck+$symbseed+$namechck;
6441: my $num2=$nameseed+$domainseed+$courseseed;
6442: #&Apache::lonxml::debug("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
6443: #&Apache::lonxml::debug("rndseed :$num1:$num2:$_64bit");
6444: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
6445:
6446: return "$num1:$num2";
6447: }
6448: }
6449:
1.675 albertel 6450: sub rndseed_64bit5 {
6451: my ($symb,$courseid,$domain,$username)=@_;
6452: my ($num1,$num2)=&digest("$symb,$courseid,$domain,$username");
6453: return "$num1:$num2";
6454: }
6455:
1.366 albertel 6456: sub rndseed_CODE_64bit {
6457: my ($symb,$courseid,$domain,$username)=@_;
1.155 albertel 6458: {
1.366 albertel 6459: use integer;
1.443 albertel 6460: my $symbchck=unpack("%32S*",$symb.' ') << 16;
1.484 albertel 6461: my $symbseed=numval2($symb);
1.491 albertel 6462: my $CODEchck=unpack("%32S*",&getCODE().' ') << 16;
6463: my $CODEseed=numval(&getCODE());
1.443 albertel 6464: my $courseseed=unpack("%32S*",$courseid.' ');
1.484 albertel 6465: my $num1=$symbseed+$CODEchck;
6466: my $num2=$CODEseed+$courseseed+$symbchck;
6467: #&Apache::lonxml::debug("$symbseed:$CODEchck|$CODEseed:$courseseed:$symbchck");
1.366 albertel 6468: #&Apache::lonxml::debug("rndseed :$num1:$num2:$symb");
1.564 albertel 6469: if ($_64bit) { $num1=(($num1<<32)>>32); }
6470: if ($_64bit) { $num2=(($num2<<32)>>32); }
1.503 albertel 6471: return "$num1:$num2";
1.366 albertel 6472: }
6473: }
6474:
1.575 albertel 6475: sub rndseed_CODE_64bit4 {
6476: my ($symb,$courseid,$domain,$username)=@_;
6477: {
6478: use integer;
6479: my $symbchck=unpack("%32S*",$symb.' ') << 16;
6480: my $symbseed=numval3($symb);
6481: my $CODEchck=unpack("%32S*",&getCODE().' ') << 16;
6482: my $CODEseed=numval3(&getCODE());
6483: my $courseseed=unpack("%32S*",$courseid.' ');
6484: my $num1=$symbseed+$CODEchck;
6485: my $num2=$CODEseed+$courseseed+$symbchck;
6486: #&Apache::lonxml::debug("$symbseed:$CODEchck|$CODEseed:$courseseed:$symbchck");
6487: #&Apache::lonxml::debug("rndseed :$num1:$num2:$symb");
6488: if ($_64bit) { $num1=(($num1<<32)>>32); }
6489: if ($_64bit) { $num2=(($num2<<32)>>32); }
6490: return "$num1:$num2";
6491: }
6492: }
6493:
1.675 albertel 6494: sub rndseed_CODE_64bit5 {
6495: my ($symb,$courseid,$domain,$username)=@_;
6496: my $code = &getCODE();
6497: my ($num1,$num2)=&digest("$symb,$courseid,$code");
6498: return "$num1:$num2";
6499: }
6500:
1.366 albertel 6501: sub setup_random_from_rndseed {
6502: my ($rndseed)=@_;
1.503 albertel 6503: if ($rndseed =~/([,:])/) {
6504: my ($num1,$num2)=split(/[,:]/,$rndseed);
1.366 albertel 6505: &Math::Random::random_set_seed(abs($num1),abs($num2));
6506: } else {
6507: &Math::Random::random_set_seed_from_phrase($rndseed);
1.98 albertel 6508: }
1.36 albertel 6509: }
6510:
1.474 albertel 6511: sub latest_receipt_algorithm_id {
6512: return 'receipt2';
6513: }
6514:
1.480 www 6515: sub recunique {
6516: my $fucourseid=shift;
6517: my $unique;
1.620 albertel 6518: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2') {
6519: $unique=$env{"course.$fucourseid.internal.encseed"};
1.480 www 6520: } else {
6521: $unique=$perlvar{'lonReceipt'};
6522: }
6523: return unpack("%32C*",$unique);
6524: }
6525:
6526: sub recprefix {
6527: my $fucourseid=shift;
6528: my $prefix;
1.620 albertel 6529: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2') {
6530: $prefix=$env{"course.$fucourseid.internal.encpref"};
1.480 www 6531: } else {
6532: $prefix=$perlvar{'lonHostID'};
6533: }
6534: return unpack("%32C*",$prefix);
6535: }
6536:
1.76 www 6537: sub ireceipt {
1.474 albertel 6538: my ($funame,$fudom,$fucourseid,$fusymb,$part)=@_;
1.76 www 6539: my $cuname=unpack("%32C*",$funame);
6540: my $cudom=unpack("%32C*",$fudom);
6541: my $cucourseid=unpack("%32C*",$fucourseid);
6542: my $cusymb=unpack("%32C*",$fusymb);
1.480 www 6543: my $cunique=&recunique($fucourseid);
1.474 albertel 6544: my $cpart=unpack("%32S*",$part);
1.480 www 6545: my $return =&recprefix($fucourseid).'-';
1.620 albertel 6546: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2' ||
6547: $env{'request.state'} eq 'construct') {
1.474 albertel 6548: &Apache::lonxml::debug("doing receipt2 using parts $cpart, uname $cuname and udom $cudom gets ".($cpart%$cuname).
6549: " and ".($cpart%$cudom));
6550:
6551: $return.= ($cunique%$cuname+
6552: $cunique%$cudom+
6553: $cusymb%$cuname+
6554: $cusymb%$cudom+
6555: $cucourseid%$cuname+
6556: $cucourseid%$cudom+
6557: $cpart%$cuname+
6558: $cpart%$cudom);
6559: } else {
6560: $return.= ($cunique%$cuname+
6561: $cunique%$cudom+
6562: $cusymb%$cuname+
6563: $cusymb%$cudom+
6564: $cucourseid%$cuname+
6565: $cucourseid%$cudom);
6566: }
6567: return $return;
1.76 www 6568: }
6569:
6570: sub receipt {
1.474 albertel 6571: my ($part)=@_;
6572: my ($symb,$courseid,$domain,$name) = &Apache::lonxml::whichuser();
6573: return &ireceipt($name,$domain,$courseid,$symb,$part);
1.76 www 6574: }
1.260 ng 6575:
1.36 albertel 6576: # ------------------------------------------------------------ Serves up a file
1.472 albertel 6577: # returns either the contents of the file or
6578: # -1 if the file doesn't exist
1.481 raeburn 6579: #
6580: # if the target is a file that was uploaded via DOCS,
6581: # a check will be made to see if a current copy exists on the local server,
6582: # if it does this will be served, otherwise a copy will be retrieved from
6583: # the home server for the course and stored in /home/httpd/html/userfiles on
6584: # the local server.
1.472 albertel 6585:
1.36 albertel 6586: sub getfile {
1.538 albertel 6587: my ($file) = @_;
1.609 banghart 6588: if ($file =~ m -^/*(uploaded|editupload)/-) { $file=&filelocation("",$file); }
1.538 albertel 6589: &repcopy($file);
6590: return &readfile($file);
6591: }
6592:
6593: sub repcopy_userfile {
6594: my ($file)=@_;
1.609 banghart 6595: if ($file =~ m -^/*(uploaded|editupload)/-) { $file=&filelocation("",$file); }
1.610 albertel 6596: if ($file =~ m|^/home/httpd/html/lonUsers/|) { return 'ok'; }
1.538 albertel 6597: my ($cdom,$cnum,$filename) =
6598: ($file=~m|^\Q$perlvar{'lonDocRoot'}\E/+userfiles/+([^/]+)/+([^/]+)/+(.*)|);
6599: my ($info,$rtncode);
6600: my $uri="/uploaded/$cdom/$cnum/$filename";
6601: if (-e "$file") {
6602: my @fileinfo = stat($file);
6603: my $lwpresp = &getuploaded('HEAD',$uri,$cdom,$cnum,\$info,\$rtncode);
1.482 albertel 6604: if ($lwpresp ne 'ok') {
6605: if ($rtncode eq '404') {
1.538 albertel 6606: unlink($file);
1.482 albertel 6607: }
1.517 albertel 6608: #my $ua=new LWP::UserAgent;
1.538 albertel 6609: #my $request=new HTTP::Request('GET',&tokenwrapper($uri));
1.517 albertel 6610: #my $response=$ua->request($request);
6611: #if ($response->is_success()) {
6612: # return $response->content;
6613: # } else {
6614: # return -1;
6615: # }
1.482 albertel 6616: return -1;
6617: }
6618: if ($info < $fileinfo[9]) {
1.607 raeburn 6619: return 'ok';
1.482 albertel 6620: }
6621: $info = '';
1.538 albertel 6622: $lwpresp = &getuploaded('GET',$uri,$cdom,$cnum,\$info,\$rtncode);
1.482 albertel 6623: if ($lwpresp ne 'ok') {
6624: return -1;
6625: }
6626: } else {
1.538 albertel 6627: my $lwpresp = &getuploaded('GET',$uri,$cdom,$cnum,\$info,\$rtncode);
1.482 albertel 6628: if ($lwpresp ne 'ok') {
1.517 albertel 6629: my $ua=new LWP::UserAgent;
1.538 albertel 6630: my $request=new HTTP::Request('GET',&tokenwrapper($uri));
1.517 albertel 6631: my $response=$ua->request($request);
6632: if ($response->is_success()) {
1.538 albertel 6633: $info=$response->content;
1.517 albertel 6634: } else {
6635: return -1;
6636: }
1.482 albertel 6637: }
6638: my @parts = ($cdom,$cnum);
6639: if ($filename =~ m|^(.+)/[^/]+$|) {
6640: push @parts, split(/\//,$1);
1.518 albertel 6641: }
1.538 albertel 6642: my $path = $perlvar{'lonDocRoot'}.'/userfiles';
1.482 albertel 6643: foreach my $part (@parts) {
6644: $path .= '/'.$part;
6645: if (!-e $path) {
6646: mkdir($path,0770);
6647: }
6648: }
6649: }
1.538 albertel 6650: open(FILE,">$file");
1.482 albertel 6651: print FILE $info;
6652: close(FILE);
1.607 raeburn 6653: return 'ok';
1.481 raeburn 6654: }
6655:
1.517 albertel 6656: sub tokenwrapper {
6657: my $uri=shift;
1.552 albertel 6658: $uri=~s|^http\://([^/]+)||;
6659: $uri=~s|^/||;
1.620 albertel 6660: $env{'user.environment'}=~/\/([^\/]+)\.id/;
1.517 albertel 6661: my $token=$1;
1.552 albertel 6662: my (undef,$udom,$uname,$file)=split('/',$uri,4);
6663: if ($udom && $uname && $file) {
6664: $file=~s|(\?\.*)*$||;
1.620 albertel 6665: &appenv("userfile.$udom/$uname/$file" => $env{'request.course.id'});
1.552 albertel 6666: return 'http://'.$hostname{ &homeserver($uname,$udom)}.'/'.$uri.
1.517 albertel 6667: (($uri=~/\?/)?'&':'?').'token='.$token.
6668: '&tokenissued='.$perlvar{'lonHostID'};
6669: } else {
6670: return '/adm/notfound.html';
6671: }
6672: }
6673:
1.481 raeburn 6674: sub getuploaded {
6675: my ($reqtype,$uri,$cdom,$cnum,$info,$rtncode) = @_;
6676: $uri=~s/^\///;
6677: $uri = 'http://'.$hostname{ &homeserver($cnum,$cdom)}.'/raw/'.$uri;
6678: my $ua=new LWP::UserAgent;
6679: my $request=new HTTP::Request($reqtype,$uri);
6680: my $response=$ua->request($request);
6681: $$rtncode = $response->code;
1.482 albertel 6682: if (! $response->is_success()) {
6683: return 'failed';
6684: }
6685: if ($reqtype eq 'HEAD') {
1.486 www 6686: $$info = &HTTP::Date::str2time( $response->header('Last-modified') );
1.482 albertel 6687: } elsif ($reqtype eq 'GET') {
6688: $$info = $response->content;
1.472 albertel 6689: }
1.482 albertel 6690: return 'ok';
1.36 albertel 6691: }
6692:
1.481 raeburn 6693: sub readfile {
6694: my $file = shift;
6695: if ( (! -e $file ) || ($file eq '') ) { return -1; };
6696: my $fh;
6697: open($fh,"<$file");
6698: my $a='';
6699: while (<$fh>) { $a .=$_; }
6700: return $a;
6701: }
6702:
1.36 albertel 6703: sub filelocation {
1.590 banghart 6704: my ($dir,$file) = @_;
6705: my $location;
6706: $file=~ s/^\s*(\S+)\s*$/$1/; ## strip off leading and trailing spaces
1.700 albertel 6707:
6708: if ($file =~ m-^/adm/-) {
6709: $file=~s-^/adm/wrapper/-/-;
6710: $file=~s-^/adm/coursedocs/showdoc/-/-;
6711: }
1.590 banghart 6712: if ($file=~m:^/~:) { # is a contruction space reference
6713: $location = $file;
6714: $location =~ s:/~(.*?)/(.*):/home/$1/public_html/$2:;
1.649 albertel 6715: } elsif ($file=~m:^/home/[^/]*/public_html/:) {
6716: # is a correct contruction space reference
6717: $location = $file;
1.609 banghart 6718: } elsif ($file=~/^\/*(uploaded|editupload)/) { # is an uploaded file
1.590 banghart 6719: my ($udom,$uname,$filename)=
1.609 banghart 6720: ($file=~m -^/+(?:uploaded|editupload)/+([^/]+)/+([^/]+)/+(.*)$-);
1.590 banghart 6721: my $home=&homeserver($uname,$udom);
6722: my $is_me=0;
6723: my @ids=¤t_machine_ids();
6724: foreach my $id (@ids) { if ($id eq $home) { $is_me=1; } }
6725: if ($is_me) {
1.740 www 6726: $location=&propath($udom,$uname).
1.590 banghart 6727: '/userfiles/'.$filename;
6728: } else {
6729: $location=$Apache::lonnet::perlvar{'lonDocRoot'}.'/userfiles/'.
6730: $udom.'/'.$uname.'/'.$filename;
6731: }
6732: } else {
6733: $file=~s/^\Q$perlvar{'lonDocRoot'}\E//;
6734: $file=~s:^/res/:/:;
6735: if ( !( $file =~ m:^/:) ) {
6736: $location = $dir. '/'.$file;
6737: } else {
6738: $location = '/home/httpd/html/res'.$file;
6739: }
1.59 albertel 6740: }
1.590 banghart 6741: $location=~s://+:/:g; # remove duplicate /
6742: while ($location=~m:/\.\./:) {$location=~ s:/[^/]+/\.\./:/:g;} #remove dir/..
6743: while ($location=~m:/\./:) {$location=~ s:/\./:/:g;} #remove /./
6744: return $location;
1.46 www 6745: }
1.36 albertel 6746:
1.46 www 6747: sub hreflocation {
6748: my ($dir,$file)=@_;
1.460 albertel 6749: unless (($file=~m-^http://-i) || ($file=~m-^/-)) {
1.666 albertel 6750: $file=filelocation($dir,$file);
1.700 albertel 6751: } elsif ($file=~m-^/adm/-) {
6752: $file=~s-^/adm/wrapper/-/-;
6753: $file=~s-^/adm/coursedocs/showdoc/-/-;
1.666 albertel 6754: }
6755: if ($file=~m-^\Q$perlvar{'lonDocRoot'}\E-) {
6756: $file=~s-^\Q$perlvar{'lonDocRoot'}\E--;
6757: } elsif ($file=~m-/home/(\w+)/public_html/-) {
1.462 albertel 6758: $file=~s-^/home/(\w+)/public_html/-/~$1/-;
1.666 albertel 6759: } elsif ($file=~m-^\Q$perlvar{'lonUsersDir'}\E-) {
6760: $file=~s-^/home/httpd/lonUsers/([^/]*)/./././([^/]*)/userfiles/
6761: -/uploaded/$1/$2/-x;
1.46 www 6762: }
1.462 albertel 6763: return $file;
1.465 albertel 6764: }
6765:
6766: sub current_machine_domains {
6767: my $hostname=$hostname{$perlvar{'lonHostID'}};
6768: my @domains;
6769: while( my($id, $name) = each(%hostname)) {
1.467 matthew 6770: # &logthis("-$id-$name-$hostname-");
1.465 albertel 6771: if ($hostname eq $name) {
6772: push(@domains,$hostdom{$id});
6773: }
6774: }
6775: return @domains;
6776: }
6777:
6778: sub current_machine_ids {
6779: my $hostname=$hostname{$perlvar{'lonHostID'}};
6780: my @ids;
6781: while( my($id, $name) = each(%hostname)) {
1.467 matthew 6782: # &logthis("-$id-$name-$hostname-");
1.465 albertel 6783: if ($hostname eq $name) {
6784: push(@ids,$id);
6785: }
6786: }
6787: return @ids;
1.31 www 6788: }
6789:
6790: # ------------------------------------------------------------- Declutters URLs
6791:
6792: sub declutter {
6793: my $thisfn=shift;
1.569 albertel 6794: if ($thisfn=~m|^/enc/|) { $thisfn=&Apache::lonenc::unencrypted($thisfn); }
1.479 albertel 6795: $thisfn=~s/^\Q$perlvar{'lonDocRoot'}\E//;
1.31 www 6796: $thisfn=~s/^\///;
1.697 albertel 6797: $thisfn=~s|^adm/wrapper/||;
6798: $thisfn=~s|^adm/coursedocs/showdoc/||;
1.31 www 6799: $thisfn=~s/^res\///;
1.235 www 6800: $thisfn=~s/\?.+$//;
1.268 www 6801: return $thisfn;
6802: }
6803:
6804: # ------------------------------------------------------------- Clutter up URLs
6805:
6806: sub clutter {
6807: my $thisfn='/'.&declutter(shift);
1.609 banghart 6808: unless ($thisfn=~/^\/(uploaded|editupload|adm|userfiles|ext|raw|priv|public)\//) {
1.270 www 6809: $thisfn='/res'.$thisfn;
6810: }
1.694 albertel 6811: if ($thisfn !~m|/adm|) {
1.695 albertel 6812: if ($thisfn =~ m|/ext/|) {
1.694 albertel 6813: $thisfn='/adm/wrapper'.$thisfn;
1.695 albertel 6814: } else {
6815: my ($ext) = ($thisfn =~ /\.(\w+)$/);
6816: my $embstyle=&Apache::loncommon::fileembstyle($ext);
1.698 albertel 6817: if ($embstyle eq 'ssi'
6818: || ($embstyle eq 'hdn')
6819: || ($embstyle eq 'rat')
6820: || ($embstyle eq 'prv')
6821: || ($embstyle eq 'ign')) {
6822: #do nothing with these
6823: } elsif (($embstyle eq 'img')
1.695 albertel 6824: || ($embstyle eq 'emb')
6825: || ($embstyle eq 'wrp')) {
6826: $thisfn='/adm/wrapper'.$thisfn;
1.698 albertel 6827: } elsif ($embstyle eq 'unk'
6828: && $thisfn!~/\.(sequence|page)$/) {
1.695 albertel 6829: $thisfn='/adm/coursedocs/showdoc'.$thisfn;
1.698 albertel 6830: } else {
1.718 www 6831: # &logthis("Got a blank emb style");
1.695 albertel 6832: }
1.694 albertel 6833: }
6834: }
1.31 www 6835: return $thisfn;
1.12 www 6836: }
6837:
1.557 albertel 6838: sub freeze_escape {
6839: my ($value)=@_;
6840: if (ref($value)) {
6841: $value=&nfreeze($value);
6842: return '__FROZEN__'.&escape($value);
6843: }
6844: return &escape($value);
6845: }
6846:
1.11 www 6847:
1.557 albertel 6848: sub thaw_unescape {
6849: my ($value)=@_;
6850: if ($value =~ /^__FROZEN__/) {
6851: substr($value,0,10,undef);
6852: $value=&unescape($value);
6853: return &thaw($value);
6854: }
6855: return &unescape($value);
6856: }
6857:
1.436 albertel 6858: sub correct_line_ends {
6859: my ($result)=@_;
6860: $$result =~s/\r\n/\n/mg;
6861: $$result =~s/\r/\n/mg;
1.415 albertel 6862: }
1.1 albertel 6863: # ================================================================ Main Program
6864:
1.184 www 6865: sub goodbye {
1.204 albertel 6866: &logthis("Starting Shut down");
1.443 albertel 6867: #not converted to using infrastruture and probably shouldn't be
1.599 albertel 6868: &logthis(sprintf("%-20s is %s",'%badServerCache',length(&freeze(\%badServerCache))));
1.443 albertel 6869: #converted
1.599 albertel 6870: # &logthis(sprintf("%-20s is %s",'%metacache',scalar(%metacache)));
6871: &logthis(sprintf("%-20s is %s",'%homecache',length(&freeze(\%homecache))));
6872: # &logthis(sprintf("%-20s is %s",'%titlecache',length(&freeze(\%titlecache))));
6873: # &logthis(sprintf("%-20s is %s",'%courseresdatacache',length(&freeze(\%courseresdatacache))));
1.425 albertel 6874: #1.1 only
1.599 albertel 6875: # &logthis(sprintf("%-20s is %s",'%userresdatacache',length(&freeze(\%userresdatacache))));
6876: # &logthis(sprintf("%-20s is %s",'%getsectioncache',length(&freeze(\%getsectioncache))));
6877: # &logthis(sprintf("%-20s is %s",'%courseresversioncache',length(&freeze(\%courseresversioncache))));
6878: # &logthis(sprintf("%-20s is %s",'%resversioncache',length(&freeze(\%resversioncache))));
6879: &logthis(sprintf("%-20s is %s",'%remembered',length(&freeze(\%remembered))));
6880: &logthis(sprintf("%-20s is %s",'kicks',$kicks));
6881: &logthis(sprintf("%-20s is %s",'hits',$hits));
1.184 www 6882: &flushcourselogs();
6883: &logthis("Shutting down");
6884: }
6885:
1.179 www 6886: BEGIN {
1.228 harris41 6887: # ----------------------------------- Read loncapa.conf and loncapa_apache.conf
1.195 www 6888: unless ($readit) {
1.217 harris41 6889: {
1.581 matthew 6890: # FIXME: Use LONCAPA::Configuration::read_conf here and omit next block
1.448 albertel 6891: open(my $config,"</etc/httpd/conf/loncapa.conf");
1.217 harris41 6892:
6893: while (my $configline=<$config>) {
1.484 albertel 6894: if ($configline=~/\S/ && $configline =~ /^[^\#]*PerlSetVar/) {
1.1 albertel 6895: my ($dummy,$varname,$varvalue)=split(/\s+/,$configline);
1.8 www 6896: chomp($varvalue);
1.1 albertel 6897: $perlvar{$varname}=$varvalue;
6898: }
6899: }
1.448 albertel 6900: close($config);
1.1 albertel 6901: }
1.227 harris41 6902: {
1.448 albertel 6903: open(my $config,"</etc/httpd/conf/loncapa_apache.conf");
1.227 harris41 6904:
6905: while (my $configline=<$config>) {
6906: if ($configline =~ /^[^\#]*PerlSetVar/) {
6907: my ($dummy,$varname,$varvalue)=split(/\s+/,$configline);
6908: chomp($varvalue);
6909: $perlvar{$varname}=$varvalue;
6910: }
6911: }
1.448 albertel 6912: close($config);
1.227 harris41 6913: }
1.1 albertel 6914:
1.327 albertel 6915: # ------------------------------------------------------------ Read domain file
6916: {
6917: %domaindescription = ();
6918: %domain_auth_def = ();
6919: %domain_auth_arg_def = ();
1.448 albertel 6920: my $fh;
6921: if (open($fh,"<".$Apache::lonnet::perlvar{'lonTabDir'}.'/domain.tab')) {
1.327 albertel 6922: while (<$fh>) {
1.390 matthew 6923: next if (/^(\#|\s*$)/);
6924: # next if /^\#/;
1.327 albertel 6925: chomp;
1.403 www 6926: my ($domain, $domain_description, $def_auth, $def_auth_arg,
1.685 raeburn 6927: $def_lang, $city, $longi, $lati, $primary) = split(/:/,$_);
1.403 www 6928: $domain_auth_def{$domain}=$def_auth;
1.327 albertel 6929: $domain_auth_arg_def{$domain}=$def_auth_arg;
1.403 www 6930: $domaindescription{$domain}=$domain_description;
6931: $domain_lang_def{$domain}=$def_lang;
6932: $domain_city{$domain}=$city;
6933: $domain_longi{$domain}=$longi;
6934: $domain_lati{$domain}=$lati;
1.685 raeburn 6935: $domain_primary{$domain}=$primary;
1.403 www 6936:
1.448 albertel 6937: # &logthis("Domain.tab: $domain, $domain_auth_def{$domain}, $domain_auth_arg_def{$domain},$domaindescription{$domain}");
1.327 albertel 6938: # &logthis("Domain.tab: $domain ".$domaindescription{$domain} );
1.448 albertel 6939: }
1.327 albertel 6940: }
1.448 albertel 6941: close ($fh);
1.327 albertel 6942: }
6943:
6944:
1.1 albertel 6945: # ------------------------------------------------------------- Read hosts file
6946: {
1.448 albertel 6947: open(my $config,"<$perlvar{'lonTabDir'}/hosts.tab");
1.1 albertel 6948:
6949: while (my $configline=<$config>) {
1.303 matthew 6950: next if ($configline =~ /^(\#|\s*$)/);
1.154 www 6951: chomp($configline);
1.595 albertel 6952: my ($id,$domain,$role,$name)=split(/:/,$configline);
1.597 albertel 6953: $name=~s/\s//g;
1.595 albertel 6954: if ($id && $domain && $role && $name) {
1.252 albertel 6955: $hostname{$id}=$name;
6956: $hostdom{$id}=$domain;
6957: if ($role eq 'library') { $libserv{$id}=$name; }
1.245 www 6958: }
1.1 albertel 6959: }
1.448 albertel 6960: close($config);
1.619 albertel 6961: # FIXME: dev server don't want this, production servers _do_ want this
1.654 albertel 6962: #&get_iphost();
1.1 albertel 6963: }
6964:
1.598 albertel 6965: sub get_iphost {
6966: if (%iphost) { return %iphost; }
1.653 albertel 6967: my %name_to_ip;
1.598 albertel 6968: foreach my $id (keys(%hostname)) {
6969: my $name=$hostname{$id};
1.653 albertel 6970: my $ip;
6971: if (!exists($name_to_ip{$name})) {
6972: $ip = gethostbyname($name);
6973: if (!$ip || length($ip) ne 4) {
6974: &logthis("Skipping host $id name $name no IP found\n");
6975: next;
6976: }
6977: $ip=inet_ntoa($ip);
6978: $name_to_ip{$name} = $ip;
6979: } else {
6980: $ip = $name_to_ip{$name};
1.598 albertel 6981: }
6982: push(@{$iphost{$ip}},$id);
6983: }
6984: return %iphost;
6985: }
6986:
1.1 albertel 6987: # ------------------------------------------------------ Read spare server file
6988: {
1.448 albertel 6989: open(my $config,"<$perlvar{'lonTabDir'}/spare.tab");
1.1 albertel 6990:
6991: while (my $configline=<$config>) {
6992: chomp($configline);
1.284 matthew 6993: if ($configline) {
1.1 albertel 6994: $spareid{$configline}=1;
6995: }
6996: }
1.448 albertel 6997: close($config);
1.1 albertel 6998: }
1.11 www 6999: # ------------------------------------------------------------ Read permissions
7000: {
1.448 albertel 7001: open(my $config,"<$perlvar{'lonTabDir'}/roles.tab");
1.11 www 7002:
7003: while (my $configline=<$config>) {
1.448 albertel 7004: chomp($configline);
7005: if ($configline) {
7006: my ($role,$perm)=split(/ /,$configline);
7007: if ($perm ne '') { $pr{$role}=$perm; }
7008: }
1.11 www 7009: }
1.448 albertel 7010: close($config);
1.11 www 7011: }
7012:
7013: # -------------------------------------------- Read plain texts for permissions
7014: {
1.448 albertel 7015: open(my $config,"<$perlvar{'lonTabDir'}/rolesplain.tab");
1.11 www 7016:
7017: while (my $configline=<$config>) {
1.448 albertel 7018: chomp($configline);
7019: if ($configline) {
1.742 raeburn 7020: my ($short,@plain)=split(/:/,$configline);
7021: %{$prp{$short}} = ();
7022: if (@plain > 0) {
7023: $prp{$short}{'std'} = $plain[0];
7024: for (my $i=1; $i<@plain; $i++) {
7025: $prp{$short}{'alt'.$i} = $plain[$i];
7026: }
7027: }
1.448 albertel 7028: }
1.135 www 7029: }
1.448 albertel 7030: close($config);
1.135 www 7031: }
7032:
7033: # ---------------------------------------------------------- Read package table
7034: {
1.448 albertel 7035: open(my $config,"<$perlvar{'lonTabDir'}/packages.tab");
1.135 www 7036:
7037: while (my $configline=<$config>) {
1.483 albertel 7038: if ($configline !~ /\S/ || $configline=~/^#/) { next; }
1.448 albertel 7039: chomp($configline);
7040: my ($short,$plain)=split(/:/,$configline);
7041: my ($pack,$name)=split(/\&/,$short);
7042: if ($plain ne '') {
7043: $packagetab{$pack.'&'.$name.'&name'}=$name;
7044: $packagetab{$short}=$plain;
7045: }
1.11 www 7046: }
1.448 albertel 7047: close($config);
1.329 matthew 7048: }
7049:
7050: # ------------- set up temporary directory
7051: {
7052: $tmpdir = $perlvar{'lonDaemons'}.'/tmp/';
7053:
1.11 www 7054: }
7055:
1.599 albertel 7056: $memcache=new Cache::Memcached({'servers'=>['127.0.0.1:11211']});
1.185 www 7057:
1.281 www 7058: $processmarker='_'.time.'_'.$perlvar{'lonHostID'};
1.186 www 7059: $dumpcount=0;
1.22 www 7060:
1.163 harris41 7061: &logtouch();
1.672 albertel 7062: &logthis('<font color="yellow">INFO: Read configuration</font>');
1.195 www 7063: $readit=1;
1.564 albertel 7064: {
7065: use integer;
7066: my $test=(2**32)+1;
1.568 albertel 7067: if ($test != 0) { $_64bit=1; } else { $_64bit=0; }
1.564 albertel 7068: &logthis(" Detected 64bit platform ($_64bit)");
7069: }
1.195 www 7070: }
1.1 albertel 7071: }
1.179 www 7072:
1.1 albertel 7073: 1;
1.191 harris41 7074: __END__
7075:
1.243 albertel 7076: =pod
7077:
1.191 harris41 7078: =head1 NAME
7079:
1.243 albertel 7080: Apache::lonnet - Subroutines to ask questions about things in the network.
1.191 harris41 7081:
7082: =head1 SYNOPSIS
7083:
1.243 albertel 7084: Invoked by other LON-CAPA modules, when they need to talk to or about objects in the network.
1.191 harris41 7085:
7086: &Apache::lonnet::SUBROUTINENAME(ARGUMENTS);
7087:
1.243 albertel 7088: Common parameters:
7089:
7090: =over 4
7091:
7092: =item *
7093:
7094: $uname : an internal username (if $cname expecting a course Id specifically)
7095:
7096: =item *
7097:
7098: $udom : a domain (if $cdom expecting a course's domain specifically)
7099:
7100: =item *
7101:
7102: $symb : a resource instance identifier
7103:
7104: =item *
7105:
7106: $namespace : the name of a .db file that contains the data needed or
7107: being set.
7108:
7109: =back
7110:
1.394 bowersj2 7111: =head1 OVERVIEW
1.191 harris41 7112:
1.394 bowersj2 7113: lonnet provides subroutines which interact with the
7114: lonc/lond (TCP) network layer of LON-CAPA. They can be used to ask
7115: about classes, users, and resources.
1.243 albertel 7116:
7117: For many of these objects you can also use this to store data about
7118: them or modify them in various ways.
1.191 harris41 7119:
1.394 bowersj2 7120: =head2 Symbs
1.191 harris41 7121:
1.394 bowersj2 7122: To identify a specific instance of a resource, LON-CAPA uses symbols
7123: or "symbs"X<symb>. These identifiers are built from the URL of the
7124: map, the resource number of the resource in the map, and the URL of
7125: the resource itself. The latter is somewhat redundant, but might help
7126: if maps change.
7127:
7128: An example is
7129:
7130: msu/korte/parts/part1.sequence___19___msu/korte/tests/part12.problem
7131:
7132: The respective map entry is
7133:
7134: <resource id="19" src="/res/msu/korte/tests/part12.problem"
7135: title="Problem 2">
7136: </resource>
7137:
7138: Symbs are used by the random number generator, as well as to store and
7139: restore data specific to a certain instance of for example a problem.
7140:
7141: =head2 Storing And Retrieving Data
7142:
7143: X<store()>X<cstore()>X<restore()>Three of the most important functions
7144: in C<lonnet.pm> are C<&Apache::lonnet::cstore()>,
7145: C<&Apache::lonnet:restore()>, and C<&Apache::lonnet::store()>, which
7146: is is the non-critical message twin of cstore. These functions are for
7147: handlers to store a perl hash to a user's permanent data space in an
7148: easy manner, and to retrieve it again on another call. It is expected
7149: that a handler would use this once at the beginning to retrieve data,
7150: and then again once at the end to send only the new data back.
7151:
7152: The data is stored in the user's data directory on the user's
7153: homeserver under the ID of the course.
7154:
7155: The hash that is returned by restore will have all of the previous
7156: value for all of the elements of the hash.
7157:
7158: Example:
7159:
7160: #creating a hash
7161: my %hash;
7162: $hash{'foo'}='bar';
7163:
7164: #storing it
7165: &Apache::lonnet::cstore(\%hash);
7166:
7167: #changing a value
7168: $hash{'foo'}='notbar';
7169:
7170: #adding a new value
7171: $hash{'bar'}='foo';
7172: &Apache::lonnet::cstore(\%hash);
7173:
7174: #retrieving the hash
7175: my %history=&Apache::lonnet::restore();
7176:
7177: #print the hash
7178: foreach my $key (sort(keys(%history))) {
7179: print("\%history{$key} = $history{$key}");
7180: }
7181:
7182: Will print out:
1.191 harris41 7183:
1.394 bowersj2 7184: %history{1:foo} = bar
7185: %history{1:keys} = foo:timestamp
7186: %history{1:timestamp} = 990455579
7187: %history{2:bar} = foo
7188: %history{2:foo} = notbar
7189: %history{2:keys} = foo:bar:timestamp
7190: %history{2:timestamp} = 990455580
7191: %history{bar} = foo
7192: %history{foo} = notbar
7193: %history{timestamp} = 990455580
7194: %history{version} = 2
7195:
7196: Note that the special hash entries C<keys>, C<version> and
7197: C<timestamp> were added to the hash. C<version> will be equal to the
7198: total number of versions of the data that have been stored. The
7199: C<timestamp> attribute will be the UNIX time the hash was
7200: stored. C<keys> is available in every historical section to list which
7201: keys were added or changed at a specific historical revision of a
7202: hash.
7203:
7204: B<Warning>: do not store the hash that restore returns directly. This
7205: will cause a mess since it will restore the historical keys as if the
7206: were new keys. I.E. 1:foo will become 1:1:foo etc.
1.191 harris41 7207:
1.394 bowersj2 7208: Calling convention:
1.191 harris41 7209:
1.394 bowersj2 7210: my %record=&Apache::lonnet::restore($symb,$courseid,$domain,$uname,$home);
7211: &Apache::lonnet::cstore(\%newrecord,$symb,$courseid,$domain,$uname,$home);
1.191 harris41 7212:
1.394 bowersj2 7213: For more detailed information, see lonnet specific documentation.
1.191 harris41 7214:
1.394 bowersj2 7215: =head1 RETURN MESSAGES
1.191 harris41 7216:
1.394 bowersj2 7217: =over 4
1.191 harris41 7218:
1.394 bowersj2 7219: =item * B<con_lost>: unable to contact remote host
1.191 harris41 7220:
1.394 bowersj2 7221: =item * B<con_delayed>: unable to contact remote host, message will be delivered
7222: when the connection is brought back up
1.191 harris41 7223:
1.394 bowersj2 7224: =item * B<con_failed>: unable to contact remote host and unable to save message
7225: for later delivery
1.191 harris41 7226:
1.394 bowersj2 7227: =item * B<error:>: an error a occured, a description of the error follows the :
1.191 harris41 7228:
1.394 bowersj2 7229: =item * B<no_such_host>: unable to fund a host associated with the user/domain
1.243 albertel 7230: that was requested
1.191 harris41 7231:
1.243 albertel 7232: =back
1.191 harris41 7233:
1.243 albertel 7234: =head1 PUBLIC SUBROUTINES
1.191 harris41 7235:
1.243 albertel 7236: =head2 Session Environment Functions
1.191 harris41 7237:
1.243 albertel 7238: =over 4
1.191 harris41 7239:
1.394 bowersj2 7240: =item *
7241: X<appenv()>
7242: B<appenv(%hash)>: the value of %hash is written to
7243: the user envirnoment file, and will be restored for each access this
1.620 albertel 7244: user makes during this session, also modifies the %env for the current
1.394 bowersj2 7245: process
1.191 harris41 7246:
7247: =item *
1.394 bowersj2 7248: X<delenv()>
7249: B<delenv($regexp)>: removes all items from the session
7250: environment file that matches the regular expression in $regexp. The
1.620 albertel 7251: values are also delted from the current processes %env.
1.191 harris41 7252:
1.243 albertel 7253: =back
7254:
7255: =head2 User Information
1.191 harris41 7256:
1.243 albertel 7257: =over 4
1.191 harris41 7258:
7259: =item *
1.394 bowersj2 7260: X<queryauthenticate()>
7261: B<queryauthenticate($uname,$udom)>: try to determine user's current
1.191 harris41 7262: authentication scheme
7263:
7264: =item *
1.394 bowersj2 7265: X<authenticate()>
7266: B<authenticate($uname,$upass,$udom)>: try to
7267: authenticate user from domain's lib servers (first use the current
7268: one). C<$upass> should be the users password.
1.191 harris41 7269:
7270: =item *
1.394 bowersj2 7271: X<homeserver()>
7272: B<homeserver($uname,$udom)>: find the server which has
7273: the user's directory and files (there must be only one), this caches
7274: the answer, and also caches if there is a borken connection.
1.191 harris41 7275:
7276: =item *
1.394 bowersj2 7277: X<idget()>
7278: B<idget($udom,@ids)>: find the usernames behind a list of IDs
7279: (IDs are a unique resource in a domain, there must be only 1 ID per
7280: username, and only 1 username per ID in a specific domain) (returns
7281: hash: id=>name,id=>name)
1.191 harris41 7282:
7283: =item *
1.394 bowersj2 7284: X<idrget()>
7285: B<idrget($udom,@unames)>: find the IDs behind a list of
7286: usernames (returns hash: name=>id,name=>id)
1.191 harris41 7287:
7288: =item *
1.394 bowersj2 7289: X<idput()>
7290: B<idput($udom,%ids)>: store away a list of names and associated IDs
1.191 harris41 7291:
7292: =item *
1.394 bowersj2 7293: X<rolesinit()>
7294: B<rolesinit($udom,$username,$authhost)>: get user privileges
1.243 albertel 7295:
7296: =item *
1.551 albertel 7297: X<getsection()>
7298: B<getsection($udom,$uname,$cname)>: finds the section of student in the
1.243 albertel 7299: course $cname, return section name/number or '' for "not in course"
7300: and '-1' for "no section"
7301:
7302: =item *
1.394 bowersj2 7303: X<userenvironment()>
7304: B<userenvironment($udom,$uname,@what)>: gets the values of the keys
1.243 albertel 7305: passed in @what from the requested user's environment, returns a hash
7306:
7307: =back
7308:
7309: =head2 User Roles
7310:
7311: =over 4
7312:
7313: =item *
7314:
7315: allowed($priv,$uri) : check for a user privilege; returns codes for allowed
7316: actions
7317: F: full access
7318: U,I,K: authentication modes (cxx only)
7319: '': forbidden
7320: 1: user needs to choose course
7321: 2: browse allowed
7322:
7323: =item *
7324:
7325: definerole($rolename,$sysrole,$domrole,$courole) : define role; define a custom
7326: role rolename set privileges in format of lonTabs/roles.tab for system, domain,
7327: and course level
7328:
7329: =item *
7330:
7331: plaintext($short) : return value in %prp hash (rolesplain.tab); plain text
7332: explanation of a user role term
7333:
7334: =back
7335:
7336: =head2 User Modification
7337:
7338: =over 4
7339:
7340: =item *
7341:
7342: assignrole($udom,$uname,$url,$role,$end,$start) : assign role; give a role to a
7343: user for the level given by URL. Optional start and end dates (leave empty
7344: string or zero for "no date")
1.191 harris41 7345:
7346: =item *
7347:
1.243 albertel 7348: changepass($uname,$udom,$currentpass,$newpass,$server) : attempts to
7349: change a users, password, possible return values are: ok,
7350: pwchange_failure, non_authorized, auth_mode_error, unknown_user,
7351: refused
1.191 harris41 7352:
7353: =item *
7354:
1.243 albertel 7355: modifyuserauth($udom,$uname,$umode,$upass) : modify user authentication
1.191 harris41 7356:
7357: =item *
7358:
1.243 albertel 7359: modifyuser($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene) :
7360: modify user
1.191 harris41 7361:
7362: =item *
7363:
1.286 matthew 7364: modifystudent
7365:
7366: modify a students enrollment and identification information.
7367: The course id is resolved based on the current users environment.
7368: This means the envoking user must be a course coordinator or otherwise
7369: associated with a course.
7370:
1.297 matthew 7371: This call is essentially a wrapper for lonnet::modifyuser and
7372: lonnet::modify_student_enrollment
1.286 matthew 7373:
7374: Inputs:
7375:
7376: =over 4
7377:
7378: =item B<$udom> Students loncapa domain
7379:
7380: =item B<$uname> Students loncapa login name
7381:
7382: =item B<$uid> Students id/student number
7383:
7384: =item B<$umode> Students authentication mode
7385:
7386: =item B<$upass> Students password
7387:
7388: =item B<$first> Students first name
7389:
7390: =item B<$middle> Students middle name
7391:
7392: =item B<$last> Students last name
7393:
7394: =item B<$gene> Students generation
7395:
7396: =item B<$usec> Students section in course
7397:
7398: =item B<$end> Unix time of the roles expiration
7399:
7400: =item B<$start> Unix time of the roles start date
7401:
7402: =item B<$forceid> If defined, allow $uid to be changed
7403:
7404: =item B<$desiredhome> server to use as home server for student
7405:
7406: =back
1.297 matthew 7407:
7408: =item *
7409:
7410: modify_student_enrollment
7411:
7412: Change a students enrollment status in a class. The environment variable
7413: 'role.request.course' must be defined for this function to proceed.
7414:
7415: Inputs:
7416:
7417: =over 4
7418:
7419: =item $udom, students domain
7420:
7421: =item $uname, students name
7422:
7423: =item $uid, students user id
7424:
7425: =item $first, students first name
7426:
7427: =item $middle
7428:
7429: =item $last
7430:
7431: =item $gene
7432:
7433: =item $usec
7434:
7435: =item $end
7436:
7437: =item $start
7438:
7439: =back
7440:
1.191 harris41 7441:
7442: =item *
7443:
1.243 albertel 7444: assigncustomrole($udom,$uname,$url,$rdom,$rnam,$rolename,$end,$start) : assign
7445: custom role; give a custom role to a user for the level given by URL. Specify
7446: name and domain of role author, and role name
1.191 harris41 7447:
7448: =item *
7449:
1.243 albertel 7450: revokerole($udom,$uname,$url,$role) : revoke a role for url
1.191 harris41 7451:
7452: =item *
7453:
1.243 albertel 7454: revokecustomrole($udom,$uname,$url,$role) : revoke a custom role
7455:
7456: =back
7457:
7458: =head2 Course Infomation
7459:
7460: =over 4
1.191 harris41 7461:
7462: =item *
7463:
1.631 albertel 7464: coursedescription($courseid) : returns a hash of information about the
7465: specified course id, including all environment settings for the
7466: course, the description of the course will be in the hash under the
7467: key 'description'
1.191 harris41 7468:
7469: =item *
7470:
1.624 albertel 7471: resdata($name,$domain,$type,@which) : request for current parameter
7472: setting for a specific $type, where $type is either 'course' or 'user',
7473: @what should be a list of parameters to ask about. This routine caches
7474: answers for 5 minutes.
1.243 albertel 7475:
7476: =back
7477:
7478: =head2 Course Modification
7479:
7480: =over 4
1.191 harris41 7481:
7482: =item *
7483:
1.243 albertel 7484: writecoursepref($courseid,%prefs) : write preferences (environment
7485: database) for a course
1.191 harris41 7486:
7487: =item *
7488:
1.243 albertel 7489: createcourse($udom,$description,$url) : make/modify course
7490:
7491: =back
7492:
7493: =head2 Resource Subroutines
7494:
7495: =over 4
1.191 harris41 7496:
7497: =item *
7498:
1.243 albertel 7499: subscribe($fname) : subscribe to a resource, returns URL if possible (probably should use repcopy instead)
1.191 harris41 7500:
7501: =item *
7502:
1.243 albertel 7503: repcopy($filename) : subscribes to the requested file, and attempts to
7504: replicate from the owning library server, Might return
1.607 raeburn 7505: 'unavailable', 'not_found', 'forbidden', 'ok', or
7506: 'bad_request', also attempts to grab the metadata for the
1.243 albertel 7507: resource. Expects the local filesystem pathname
7508: (/home/httpd/html/res/....)
7509:
7510: =back
7511:
7512: =head2 Resource Information
7513:
7514: =over 4
1.191 harris41 7515:
7516: =item *
7517:
1.243 albertel 7518: EXT($varname,$symb,$udom,$uname) : evaluates and returns the value of
7519: a vairety of different possible values, $varname should be a request
7520: string, and the other parameters can be used to specify who and what
7521: one is asking about.
7522:
7523: Possible values for $varname are environment.lastname (or other item
7524: from the envirnment hash), user.name (or someother aspect about the
7525: user), resource.0.maxtries (or some other part and parameter of a
7526: resource)
1.204 albertel 7527:
7528: =item *
7529:
1.243 albertel 7530: directcondval($number) : get current value of a condition; reads from a state
7531: string
1.204 albertel 7532:
7533: =item *
7534:
1.243 albertel 7535: condval($condidx) : value of condition index based on state
1.204 albertel 7536:
7537: =item *
7538:
1.243 albertel 7539: metadata($uri,$what,$liburi,$prefix,$depthcount) : request a
7540: resource's metadata, $what should be either a specific key, or either
7541: 'keys' (to get a list of possible keys) or 'packages' to get a list of
7542: packages that this resource currently uses, the last 3 arguments are only used internally for recursive metadata.
7543:
7544: this function automatically caches all requests
1.191 harris41 7545:
7546: =item *
7547:
1.243 albertel 7548: metadata_query($query,$custom,$customshow) : make a metadata query against the
7549: network of library servers; returns file handle of where SQL and regex results
7550: will be stored for query
1.191 harris41 7551:
7552: =item *
7553:
1.243 albertel 7554: symbread($filename) : return symbolic list entry (filename argument optional);
7555: returns the data handle
1.191 harris41 7556:
7557: =item *
7558:
1.243 albertel 7559: symbverify($symb,$thisfn) : verifies that $symb actually exists and is
1.582 albertel 7560: a possible symb for the URL in $thisfn, and if is an encryypted
7561: resource that the user accessed using /enc/ returns a 1 on success, 0
7562: on failure, user must be in a course, as it assumes the existance of
1.620 albertel 7563: the course initial hash, and uses $env('request.course.id'}
1.243 albertel 7564:
1.191 harris41 7565:
7566: =item *
7567:
1.243 albertel 7568: symbclean($symb) : removes versions numbers from a symb, returns the
7569: cleaned symb
1.191 harris41 7570:
7571: =item *
7572:
1.243 albertel 7573: is_on_map($uri) : checks if the $uri is somewhere on the current
7574: course map, user must be in a course for it to work.
1.191 harris41 7575:
7576: =item *
7577:
1.243 albertel 7578: numval($salt) : return random seed value (addend for rndseed)
1.191 harris41 7579:
7580: =item *
7581:
1.243 albertel 7582: rndseed($symb,$courseid,$udom,$uname) : create a random sum; returns
7583: a random seed, all arguments are optional, if they aren't sent it uses the
7584: environment to derive them. Note: if symb isn't sent and it can't get one
7585: from &symbread it will use the current time as its return value
1.191 harris41 7586:
7587: =item *
7588:
1.243 albertel 7589: ireceipt($funame,$fudom,$fucourseid,$fusymb) : return unique,
7590: unfakeable, receipt
1.191 harris41 7591:
7592: =item *
7593:
1.620 albertel 7594: receipt() : API to ireceipt working off of env values; given out to users
1.191 harris41 7595:
7596: =item *
7597:
1.243 albertel 7598: countacc($url) : count the number of accesses to a given URL
1.191 harris41 7599:
7600: =item *
7601:
1.243 albertel 7602: 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 7603:
7604: =item *
7605:
1.243 albertel 7606: 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 7607:
7608: =item *
7609:
1.243 albertel 7610: expirespread($uname,$udom,$stype,$usymb) : set expire date for spreadsheet
1.191 harris41 7611:
7612: =item *
7613:
1.243 albertel 7614: devalidate($symb) : devalidate temporary spreadsheet calculations,
7615: forcing spreadsheet to reevaluate the resource scores next time.
7616:
7617: =back
7618:
7619: =head2 Storing/Retreiving Data
7620:
7621: =over 4
1.191 harris41 7622:
7623: =item *
7624:
1.243 albertel 7625: store($storehash,$symb,$namespace,$udom,$uname) : stores hash permanently
7626: for this url; hashref needs to be given and should be a \%hashname; the
7627: remaining args aren't required and if they aren't passed or are '' they will
1.620 albertel 7628: be derived from the env
1.191 harris41 7629:
7630: =item *
7631:
1.243 albertel 7632: cstore($storehash,$symb,$namespace,$udom,$uname) : same as store but
7633: uses critical subroutine
1.191 harris41 7634:
7635: =item *
7636:
1.243 albertel 7637: restore($symb,$namespace,$udom,$uname) : returns hash for this symb;
7638: all args are optional
1.191 harris41 7639:
7640: =item *
7641:
1.717 albertel 7642: dumpstore($namespace,$udom,$uname,$regexp,$range) :
7643: dumps the complete (or key matching regexp) namespace into a hash
7644: ($udom, $uname, $regexp, $range are optional) for a namespace that is
7645: normally &store()ed into
7646:
7647: $range should be either an integer '100' (give me the first 100
7648: matching records)
7649: or be two integers sperated by a - with no spaces
7650: '30-50' (give me the 30th through the 50th matching
7651: records)
7652:
7653:
7654: =item *
7655:
7656: putstore($namespace,$symb,$version,$storehash,$udomain,$uname) :
7657: replaces a &store() version of data with a replacement set of data
7658: for a particular resource in a namespace passed in the $storehash hash
7659: reference
7660:
7661: =item *
7662:
1.243 albertel 7663: tmpstore($storehash,$symb,$namespace,$udom,$uname) : storage that
7664: works very similar to store/cstore, but all data is stored in a
7665: temporary location and can be reset using tmpreset, $storehash should
7666: be a hash reference, returns nothing on success
1.191 harris41 7667:
7668: =item *
7669:
1.243 albertel 7670: tmprestore($symb,$namespace,$udom,$uname) : storage that works very
7671: similar to restore, but all data is stored in a temporary location and
7672: can be reset using tmpreset. Returns a hash of values on success,
7673: error string otherwise.
1.191 harris41 7674:
7675: =item *
7676:
1.243 albertel 7677: tmpreset($symb,$namespace,$udom,$uname) : temporary storage reset,
7678: deltes all keys for $symb form the temporary storage hash.
1.191 harris41 7679:
7680: =item *
7681:
1.243 albertel 7682: get($namespace,$storearr,$udom,$uname) : returns hash with keys from array
7683: reference filled in from namesp ($udom and $uname are optional)
1.191 harris41 7684:
7685: =item *
7686:
1.243 albertel 7687: del($namespace,$storearr,$udom,$uname) : deletes keys out of array from
7688: namesp ($udom and $uname are optional)
1.191 harris41 7689:
7690: =item *
7691:
1.702 albertel 7692: dump($namespace,$udom,$uname,$regexp,$range) :
1.243 albertel 7693: dumps the complete (or key matching regexp) namespace into a hash
1.702 albertel 7694: ($udom, $uname, $regexp, $range are optional)
1.449 matthew 7695:
1.702 albertel 7696: $range should be either an integer '100' (give me the first 100
7697: matching records)
7698: or be two integers sperated by a - with no spaces
7699: '30-50' (give me the 30th through the 50th matching
7700: records)
1.449 matthew 7701: =item *
7702:
7703: inc($namespace,$store,$udom,$uname) : increments $store in $namespace.
7704: $store can be a scalar, an array reference, or if the amount to be
7705: incremented is > 1, a hash reference.
7706:
7707: ($udom and $uname are optional)
1.191 harris41 7708:
7709: =item *
7710:
1.243 albertel 7711: put($namespace,$storehash,$udom,$uname) : stores hash in namesp
7712: ($udom and $uname are optional)
1.191 harris41 7713:
7714: =item *
7715:
1.243 albertel 7716: cput($namespace,$storehash,$udom,$uname) : critical put
7717: ($udom and $uname are optional)
1.191 harris41 7718:
7719: =item *
7720:
1.748 albertel 7721: newput($namespace,$storehash,$udom,$uname) :
7722:
7723: Attempts to store the items in the $storehash, but only if they don't
7724: currently exist, if this succeeds you can be certain that you have
7725: successfully created a new key value pair in the $namespace db.
7726:
7727:
7728: Args:
7729: $namespace: name of database to store values to
7730: $storehash: hashref to store to the db
7731: $udom: (optional) domain of user containing the db
7732: $uname: (optional) name of user caontaining the db
7733:
7734: Returns:
7735: 'ok' -> succeeded in storing all keys of $storehash
7736: 'key_exists: <key>' -> failed to anything out of $storehash, as at
7737: least <key> already existed in the db (other
7738: requested keys may also already exist)
7739: 'error: <msg>' -> unable to tie the DB or other erorr occured
7740: 'con_lost' -> unable to contact request server
7741: 'refused' -> action was not allowed by remote machine
7742:
7743:
7744: =item *
7745:
1.243 albertel 7746: eget($namespace,$storearr,$udom,$uname) : returns hash with keys from array
7747: reference filled in from namesp (encrypts the return communication)
7748: ($udom and $uname are optional)
1.191 harris41 7749:
7750: =item *
7751:
1.243 albertel 7752: log($udom,$name,$home,$message) : write to permanent log for user; use
7753: critical subroutine
7754:
7755: =back
7756:
7757: =head2 Network Status Functions
7758:
7759: =over 4
1.191 harris41 7760:
7761: =item *
7762:
7763: dirlist($uri) : return directory list based on URI
7764:
7765: =item *
7766:
1.243 albertel 7767: spareserver() : find server with least workload from spare.tab
7768:
7769: =back
7770:
7771: =head2 Apache Request
7772:
7773: =over 4
1.191 harris41 7774:
7775: =item *
7776:
1.243 albertel 7777: ssi($url,%hash) : server side include, does a complete request cycle on url to
7778: localhost, posts hash
7779:
7780: =back
7781:
7782: =head2 Data to String to Data
7783:
7784: =over 4
1.191 harris41 7785:
7786: =item *
7787:
1.243 albertel 7788: hash2str(%hash) : convert a hash into a string complete with escaping and '='
7789: and '&' separators, supports elements that are arrayrefs and hashrefs
1.191 harris41 7790:
7791: =item *
7792:
1.243 albertel 7793: hashref2str($hashref) : convert a hashref into a string complete with
7794: escaping and '=' and '&' separators, supports elements that are
7795: arrayrefs and hashrefs
1.191 harris41 7796:
7797: =item *
7798:
1.243 albertel 7799: arrayref2str($arrayref) : convert an arrayref into a string complete
7800: with escaping and '&' separators, supports elements that are arrayrefs
7801: and hashrefs
1.191 harris41 7802:
7803: =item *
7804:
1.243 albertel 7805: str2hash($string) : convert string to hash using unescaping and
7806: splitting on '=' and '&', supports elements that are arrayrefs and
7807: hashrefs
1.191 harris41 7808:
7809: =item *
7810:
1.243 albertel 7811: str2array($string) : convert string to hash using unescaping and
7812: splitting on '&', supports elements that are arrayrefs and hashrefs
7813:
7814: =back
7815:
7816: =head2 Logging Routines
7817:
7818: =over 4
7819:
7820: These routines allow one to make log messages in the lonnet.log and
7821: lonnet.perm logfiles.
1.191 harris41 7822:
7823: =item *
7824:
1.243 albertel 7825: logtouch() : make sure the logfile, lonnet.log, exists
1.191 harris41 7826:
7827: =item *
7828:
1.243 albertel 7829: logthis() : append message to the normal lonnet.log file, it gets
7830: preiodically rolled over and deleted.
1.191 harris41 7831:
7832: =item *
7833:
1.243 albertel 7834: logperm() : append a permanent message to lonnet.perm.log, this log
7835: file never gets deleted by any automated portion of the system, only
7836: messages of critical importance should go in here.
7837:
7838: =back
7839:
7840: =head2 General File Helper Routines
7841:
7842: =over 4
1.191 harris41 7843:
7844: =item *
7845:
1.481 raeburn 7846: getfile($file,$caller) : two cases - requests for files in /res or in /uploaded.
7847: (a) files in /uploaded
7848: (i) If a local copy of the file exists -
7849: compares modification date of local copy with last-modified date for
7850: definitive version stored on home server for course. If local copy is
7851: stale, requests a new version from the home server and stores it.
7852: If the original has been removed from the home server, then local copy
7853: is unlinked.
7854: (ii) If local copy does not exist -
7855: requests the file from the home server and stores it.
7856:
7857: If $caller is 'uploadrep':
7858: This indicates a call from lonuploadrep.pm (PerlHeaderParserHandler phase)
7859: for request for files originally uploaded via DOCS.
7860: - returns 'ok' if fresh local copy now available, -1 otherwise.
7861:
7862: Otherwise:
7863: This indicates a call from the content generation phase of the request.
7864: - returns the entire contents of the file or -1.
7865:
7866: (b) files in /res
7867: - returns the entire contents of a file or -1;
7868: it properly subscribes to and replicates the file if neccessary.
1.191 harris41 7869:
1.712 albertel 7870:
7871: =item *
7872:
7873: stat_file($url) : $url is expected to be a /res/ or /uploaded/ style file
7874: reference
7875:
7876: returns either a stat() list of data about the file or an empty list
7877: if the file doesn't exist or couldn't find out about it (connection
7878: problems or user unknown)
7879:
1.191 harris41 7880: =item *
7881:
1.243 albertel 7882: filelocation($dir,$file) : returns file system location of a file
7883: based on URI; meant to be "fairly clean" absolute reference, $dir is a
7884: directory that relative $file lookups are to looked in ($dir of /a/dir
7885: and a file of ../bob will become /a/bob)
1.191 harris41 7886:
7887: =item *
7888:
7889: hreflocation($dir,$file) : returns file system location or a URL; same as
7890: filelocation except for hrefs
7891:
7892: =item *
7893:
7894: declutter() : declutters URLs (remove docroot, beginning slashes, 'res' etc)
7895:
1.243 albertel 7896: =back
7897:
1.608 albertel 7898: =head2 Usererfile file routines (/uploaded*)
7899:
7900: =over 4
7901:
7902: =item *
7903:
7904: userfileupload(): main rotine for putting a file in a user or course's
7905: filespace, arguments are,
7906:
1.620 albertel 7907: formname - required - this is the name of the element in $env where the
1.608 albertel 7908: filename, and the contents of the file to create/modifed exist
1.620 albertel 7909: the filename is in $env{'form.'.$formname.'.filename'} and the
7910: contents of the file is located in $env{'form.'.$formname}
1.608 albertel 7911: coursedoc - if true, store the file in the course of the active role
7912: of the current user
7913: subdir - required - subdirectory to put the file in under ../userfiles/
7914: if undefined, it will be placed in "unknown"
7915:
7916: (This routine calls clean_filename() to remove any dangerous
7917: characters from the filename, and then calls finuserfileupload() to
7918: complete the transaction)
7919:
7920: returns either the url of the uploaded file (/uploaded/....) if successful
7921: and /adm/notfound.html if unsuccessful
7922:
7923: =item *
7924:
7925: clean_filename(): routine for cleaing a filename up for storage in
7926: userfile space, argument is:
7927:
7928: filename - proposed filename
7929:
7930: returns: the new clean filename
7931:
7932: =item *
7933:
7934: finishuserfileupload(): routine that creaes and sends the file to
7935: userspace, probably shouldn't be called directly
7936:
7937: docuname: username or courseid of destination for the file
7938: docudom: domain of user/course of destination for the file
7939: formname: same as for userfileupload()
7940: fname: filename (inculding subdirectories) for the file
7941:
7942: returns either the url of the uploaded file (/uploaded/....) if successful
7943: and /adm/notfound.html if unsuccessful
7944:
7945: =item *
7946:
7947: renameuserfile(): renames an existing userfile to a new name
7948:
7949: Args:
7950: docuname: username or courseid of destination for the file
7951: docudom: domain of user/course of destination for the file
7952: old: current file name (including any subdirs under userfiles)
7953: new: desired file name (including any subdirs under userfiles)
7954:
7955: =item *
7956:
7957: mkdiruserfile(): creates a directory is a userfiles dir
7958:
7959: Args:
7960: docuname: username or courseid of destination for the file
7961: docudom: domain of user/course of destination for the file
7962: dir: dir to create (including any subdirs under userfiles)
7963:
7964: =item *
7965:
7966: removeuserfile(): removes a file that exists in userfiles
7967:
7968: Args:
7969: docuname: username or courseid of destination for the file
7970: docudom: domain of user/course of destination for the file
7971: fname: filname to delete (including any subdirs under userfiles)
7972:
7973: =item *
7974:
7975: removeuploadedurl(): convience function for removeuserfile()
7976:
7977: Args:
7978: url: a full /uploaded/... url to delete
7979:
1.747 albertel 7980: =item *
7981:
7982: get_portfile_permissions():
7983: Args:
7984: domain: domain of user or course contain the portfolio files
7985: user: name of user or num of course contain the portfolio files
7986: Returns:
7987: hashref of a dump of the proper file_permissions.db
7988:
7989:
7990: =item *
7991:
7992: get_access_controls():
7993:
7994: Args:
7995: current_permissions: the hash ref returned from get_portfile_permissions()
7996: group: (optional) the group you want the files associated with
7997: file: (optional) the file you want access info on
7998:
7999: Returns:
1.749 raeburn 8000: a hash (keys are file names) of hashes containing
8001: keys are: path to file/file_name\0uniqueID:scope_end_start (see below)
8002: values are XML containing access control settings (see below)
1.747 albertel 8003:
8004: Internal notes:
8005:
1.749 raeburn 8006: access controls are stored in file_permissions.db as key=value pairs.
8007: key -> path to file/file_name\0uniqueID:scope_end_start
8008: where scope -> public,guest,course,group,domains or users.
8009: end -> UNIX time for end of access (0 -> no end date)
8010: start -> UNIX time for start of access
8011:
8012: value -> XML description of access control
8013: <scope type=""> (type =1 of: public,guest,course,group,domains,users">
8014: <start></start>
8015: <end></end>
8016:
8017: <password></password> for scope type = guest
8018:
8019: <domain></domain> for scope type = course or group
8020: <number></number>
8021: <roles id="">
8022: <role></role>
8023: <access></access>
8024: <section></section>
8025: <group></group>
8026: </roles>
8027:
8028: <dom></dom> for scope type = domains
8029:
8030: <users> for scope type = users
8031: <user>
8032: <uname></uname>
8033: <udom></udom>
8034: </user>
8035: </users>
8036: </scope>
8037:
8038: Access data is also aggregated for each file in an additional key=value pair:
8039: key -> path to file/file_name\0accesscontrol
8040: value -> reference to hash
8041: hash contains key = value pairs
8042: where key = uniqueID:scope_end_start
8043: value = UNIX time record was last updated
8044:
8045: Used to improve speed of look-ups of access controls for each file.
8046:
8047: Locks on files (resulting from submission of portfolio file to a homework problem stored in array of arrays.
8048:
8049: parse_access_controls():
8050:
8051: Parses XML of an access control record
8052: Args
8053: 1. Text string (XML) of access comtrol record
8054:
8055: Returns:
8056: 1. Hash of access control settings.
8057:
8058: modify_access_controls():
8059:
8060: Modifies access controls for a portfolio file
8061: Args
8062: 1. file name
8063: 2. reference to hash of required changes,
8064: 3. domain
8065: 4. username
8066: where domain,username are the domain of the portfolio owner
8067: (either a user or a course)
8068:
8069: Returns:
8070: 1. result of additions or updates ('ok' or 'error', with error message).
8071: 2. result of deletions ('ok' or 'error', with error message).
8072: 3. reference to hash of any new or updated access controls.
8073: 4. reference to hash used to map incoming IDs to uniqueIDs assigned to control.
8074: key = integer (inbound ID)
8075: value = uniqueID
1.747 albertel 8076:
1.608 albertel 8077: =back
8078:
1.243 albertel 8079: =head2 HTTP Helper Routines
8080:
8081: =over 4
8082:
1.191 harris41 8083: =item *
8084:
8085: escape() : unpack non-word characters into CGI-compatible hex codes
8086:
8087: =item *
8088:
8089: unescape() : pack CGI-compatible hex codes into actual non-word ASCII character
8090:
1.243 albertel 8091: =back
8092:
8093: =head1 PRIVATE SUBROUTINES
8094:
8095: =head2 Underlying communication routines (Shouldn't call)
8096:
8097: =over 4
8098:
8099: =item *
8100:
8101: subreply() : tries to pass a message to lonc, returns con_lost if incapable
8102:
8103: =item *
8104:
8105: reply() : uses subreply to send a message to remote machine, logs all failures
8106:
8107: =item *
8108:
8109: critical() : passes a critical message to another server; if cannot
8110: get through then place message in connection buffer directory and
8111: returns con_delayed, if incapable of saving message, returns
8112: con_failed
8113:
8114: =item *
8115:
8116: reconlonc() : tries to reconnect lonc client processes.
8117:
8118: =back
8119:
8120: =head2 Resource Access Logging
8121:
8122: =over 4
8123:
8124: =item *
8125:
8126: flushcourselogs() : flush (save) buffer logs and access logs
8127:
8128: =item *
8129:
8130: courselog($what) : save message for course in hash
8131:
8132: =item *
8133:
8134: courseacclog($what) : save message for course using &courselog(). Perform
8135: special processing for specific resource types (problems, exams, quizzes, etc).
8136:
1.191 harris41 8137: =item *
8138:
8139: goodbye() : flush course logs and log shutting down; it is called in srm.conf
8140: as a PerlChildExitHandler
1.243 albertel 8141:
8142: =back
8143:
8144: =head2 Other
8145:
8146: =over 4
8147:
8148: =item *
8149:
8150: symblist($mapname,%newhash) : update symbolic storage links
1.191 harris41 8151:
8152: =back
8153:
8154: =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