Annotation of loncom/lonnet/perl/lonnet.pm, revision 1.756
1.1 albertel 1: # The LearningOnline Network
2: # TCP networking package
1.12 www 3: #
1.756 ! albertel 4: # $Id: lonnet.pm,v 1.755 2006/06/22 14:30:14 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.755 albertel 284: # ------------------------------------------- check if return value is an error
285:
286: sub error {
287: my ($result) = @_;
1.756 ! albertel 288: if ($result =~ /^(con_lost|no_such_host|error: (\d+) (.*))/) {
1.755 albertel 289: if ($2 == 2) { return undef; }
290: return $1;
291: }
292: return undef;
293: }
294:
1.374 www 295: # ------------------------------------------- Transfer profile into environment
296:
297: sub transfer_profile_to_env {
298: my ($lonidsdir,$handle)=@_;
1.720 albertel 299: if (!defined($lonidsdir)) {
300: $lonidsdir = $perlvar{'lonIDsDir'};
301: }
302: if (!defined($handle)) {
303: ($handle) = ($env{'user.environment'} =~m|/([^/]+)\.id$| );
304: }
305:
1.374 www 306: my @profile;
307: {
1.448 albertel 308: open(my $idf,"$lonidsdir/$handle.id");
1.374 www 309: flock($idf,LOCK_SH);
310: @profile=<$idf>;
1.448 albertel 311: close($idf);
1.374 www 312: }
313: my $envi;
1.433 matthew 314: my %Remove;
1.374 www 315: for ($envi=0;$envi<=$#profile;$envi++) {
316: chomp($profile[$envi]);
1.690 albertel 317: my ($envname,$envvalue)=split(/=/,$profile[$envi],2);
1.726 albertel 318: $envname=&unescape($envname);
319: $envvalue=&unescape($envvalue);
1.619 albertel 320: $env{$envname} = $envvalue;
1.433 matthew 321: if (my ($key,$time) = ($envname =~ /^(cgi\.(\d+)_\d+\.)/)) {
322: if ($time < time-300) {
323: $Remove{$key}++;
324: }
325: }
326: }
1.619 albertel 327: $env{'user.environment'} = "$lonidsdir/$handle.id";
1.433 matthew 328: foreach my $expired_key (keys(%Remove)) {
329: &delenv($expired_key);
1.374 www 330: }
1.1 albertel 331: }
332:
1.5 www 333: # ---------------------------------------------------------- Append Environment
334:
335: sub appenv {
1.6 www 336: my %newenv=@_;
1.692 albertel 337: foreach my $key (keys(%newenv)) {
338: if (($newenv{$key}=~/^user\.role/) || ($newenv{$key}=~/^user\.priv/)) {
1.672 albertel 339: &logthis("<font color=\"blue\">WARNING: ".
1.692 albertel 340: "Attempt to modify environment ".$key." to ".$newenv{$key}
1.151 www 341: .'</font>');
1.692 albertel 342: delete($newenv{$key});
1.35 www 343: } else {
1.692 albertel 344: $env{$key}=$newenv{$key};
1.35 www 345: }
1.191 harris41 346: }
1.95 www 347:
348: my $lockfh;
1.620 albertel 349: unless (open($lockfh,"$env{'user.environment'}")) {
1.448 albertel 350: return 'error: '.$!;
1.95 www 351: }
352: unless (flock($lockfh,LOCK_EX)) {
1.672 albertel 353: &logthis("<font color=\"blue\">WARNING: ".
1.95 www 354: 'Could not obtain exclusive lock in appenv: '.$!);
1.448 albertel 355: close($lockfh);
1.95 www 356: return 'error: '.$!;
357: }
358:
1.6 www 359: my @oldenv;
360: {
1.448 albertel 361: my $fh;
1.620 albertel 362: unless (open($fh,"$env{'user.environment'}")) {
1.448 albertel 363: return 'error: '.$!;
364: }
365: @oldenv=<$fh>;
366: close($fh);
1.6 www 367: }
368: for (my $i=0; $i<=$#oldenv; $i++) {
369: chomp($oldenv[$i]);
1.9 www 370: if ($oldenv[$i] ne '') {
1.690 albertel 371: my ($name,$value)=split(/=/,$oldenv[$i],2);
1.726 albertel 372: $name=&unescape($name);
373: $value=&unescape($value);
1.448 albertel 374: unless (defined($newenv{$name})) {
375: $newenv{$name}=$value;
376: }
1.9 www 377: }
1.6 www 378: }
379: {
1.448 albertel 380: my $fh;
1.620 albertel 381: unless (open($fh,">$env{'user.environment'}")) {
1.448 albertel 382: return 'error';
383: }
384: my $newname;
385: foreach $newname (keys %newenv) {
1.726 albertel 386: print $fh &escape($newname).'='.&escape($newenv{$newname})."\n";
1.448 albertel 387: }
388: close($fh);
1.56 www 389: }
1.448 albertel 390:
391: close($lockfh);
1.56 www 392: return 'ok';
393: }
394: # ----------------------------------------------------- Delete from Environment
395:
396: sub delenv {
397: my $delthis=shift;
398: if (($delthis=~/user\.role/) || ($delthis=~/user\.priv/)) {
1.672 albertel 399: &logthis("<font color=\"blue\">WARNING: ".
1.56 www 400: "Attempt to delete from environment ".$delthis);
401: return 'error';
402: }
403: my @oldenv;
404: {
1.448 albertel 405: my $fh;
1.620 albertel 406: unless (open($fh,"$env{'user.environment'}")) {
1.448 albertel 407: return 'error';
408: }
409: unless (flock($fh,LOCK_SH)) {
1.672 albertel 410: &logthis("<font color=\"blue\">WARNING: ".
1.448 albertel 411: 'Could not obtain shared lock in delenv: '.$!);
412: close($fh);
413: return 'error: '.$!;
414: }
415: @oldenv=<$fh>;
416: close($fh);
1.56 www 417: }
418: {
1.448 albertel 419: my $fh;
1.620 albertel 420: unless (open($fh,">$env{'user.environment'}")) {
1.448 albertel 421: return 'error';
422: }
423: unless (flock($fh,LOCK_EX)) {
1.672 albertel 424: &logthis("<font color=\"blue\">WARNING: ".
1.448 albertel 425: 'Could not obtain exclusive lock in delenv: '.$!);
426: close($fh);
427: return 'error: '.$!;
428: }
1.692 albertel 429: foreach my $cur_key (@oldenv) {
1.726 albertel 430: my $unescaped_cur_key = &unescape($cur_key);
431: if ($unescaped_cur_key=~/^$delthis/) {
432: my ($key) = split('=',$cur_key,2);
433: $key = &unescape($key);
1.619 albertel 434: delete($env{$key});
1.473 matthew 435: } else {
1.692 albertel 436: print $fh $cur_key;
1.473 matthew 437: }
1.448 albertel 438: }
439: close($fh);
1.5 www 440: }
441: return 'ok';
1.369 albertel 442: }
443:
444: # ------------------------------------------ Find out current server userload
445: # there is a copy in lond
446: sub userload {
447: my $numusers=0;
448: {
449: opendir(LONIDS,$perlvar{'lonIDsDir'});
450: my $filename;
451: my $curtime=time;
452: while ($filename=readdir(LONIDS)) {
453: if ($filename eq '.' || $filename eq '..') {next;}
1.404 albertel 454: my ($mtime)=(stat($perlvar{'lonIDsDir'}.'/'.$filename))[9];
1.437 albertel 455: if ($curtime-$mtime < 1800) { $numusers++; }
1.369 albertel 456: }
457: closedir(LONIDS);
458: }
459: my $userloadpercent=0;
460: my $maxuserload=$perlvar{'lonUserLoadLim'};
461: if ($maxuserload) {
1.371 albertel 462: $userloadpercent=100*$numusers/$maxuserload;
1.369 albertel 463: }
1.372 albertel 464: $userloadpercent=sprintf("%.2f",$userloadpercent);
1.369 albertel 465: return $userloadpercent;
1.283 www 466: }
467:
468: # ------------------------------------------ Fight off request when overloaded
469:
470: sub overloaderror {
471: my ($r,$checkserver)=@_;
472: unless ($checkserver) { $checkserver=$perlvar{'lonHostID'}; }
473: my $loadavg;
474: if ($checkserver eq $perlvar{'lonHostID'}) {
1.448 albertel 475: open(my $loadfile,'/proc/loadavg');
1.283 www 476: $loadavg=<$loadfile>;
477: $loadavg =~ s/\s.*//g;
1.285 matthew 478: $loadavg = 100*$loadavg/$perlvar{'lonLoadLim'};
1.448 albertel 479: close($loadfile);
1.283 www 480: } else {
481: $loadavg=&reply('load',$checkserver);
482: }
1.285 matthew 483: my $overload=$loadavg-100;
1.283 www 484: if ($overload>0) {
1.285 matthew 485: $r->err_headers_out->{'Retry-After'}=$overload;
1.283 www 486: $r->log_error('Overload of '.$overload.' on '.$checkserver);
1.554 www 487: return 413;
1.283 www 488: }
489: return '';
1.5 www 490: }
1.1 albertel 491:
492: # ------------------------------ Find server with least workload from spare.tab
1.11 www 493:
1.1 albertel 494: sub spareserver {
1.670 albertel 495: my ($loadpercent,$userloadpercent,$want_server_name) = @_;
1.1 albertel 496: my $tryserver;
497: my $spareserver='';
1.370 albertel 498: if ($userloadpercent !~ /\d/) { $userloadpercent=0; }
499: my $lowestserver=$loadpercent > $userloadpercent?
500: $loadpercent : $userloadpercent;
1.670 albertel 501: foreach $tryserver (keys(%spareid)) {
502: my $loadans=&reply('load',$tryserver);
503: my $userloadans=&reply('userload',$tryserver);
1.411 albertel 504: if ($loadans !~ /\d/ && $userloadans !~ /\d/) {
505: next; #didn't get a number from the server
506: }
507: my $answer;
508: if ($loadans =~ /\d/) {
509: if ($userloadans =~ /\d/) {
510: #both are numbers, pick the bigger one
511: $answer=$loadans > $userloadans?
512: $loadans : $userloadans;
513: } else {
514: $answer = $loadans;
515: }
516: } else {
517: $answer = $userloadans;
518: }
519: if (($answer =~ /\d/) && ($answer<$lowestserver)) {
1.670 albertel 520: if ($want_server_name) {
521: $spareserver=$tryserver;
522: } else {
523: $spareserver="http://$hostname{$tryserver}";
524: }
1.411 albertel 525: $lowestserver=$answer;
526: }
1.370 albertel 527: }
1.1 albertel 528: return $spareserver;
1.202 matthew 529: }
530:
531: # --------------------------------------------- Try to change a user's password
532:
533: sub changepass {
534: my ($uname,$udom,$currentpass,$newpass,$server)=@_;
535: $currentpass = &escape($currentpass);
536: $newpass = &escape($newpass);
537: my $answer = reply("encrypt:passwd:$udom:$uname:$currentpass:$newpass",
538: $server);
539: if (! $answer) {
540: &logthis("No reply on password change request to $server ".
541: "by $uname in domain $udom.");
542: } elsif ($answer =~ "^ok") {
543: &logthis("$uname in $udom successfully changed their password ".
544: "on $server.");
545: } elsif ($answer =~ "^pwchange_failure") {
546: &logthis("$uname in $udom was unable to change their password ".
547: "on $server. The action was blocked by either lcpasswd ".
548: "or pwchange");
549: } elsif ($answer =~ "^non_authorized") {
550: &logthis("$uname in $udom did not get their password correct when ".
551: "attempting to change it on $server.");
552: } elsif ($answer =~ "^auth_mode_error") {
553: &logthis("$uname in $udom attempted to change their password despite ".
554: "not being locally or internally authenticated on $server.");
555: } elsif ($answer =~ "^unknown_user") {
556: &logthis("$uname in $udom attempted to change their password ".
557: "on $server but were unable to because $server is not ".
558: "their home server.");
559: } elsif ($answer =~ "^refused") {
560: &logthis("$server refused to change $uname in $udom password because ".
561: "it was sent an unencrypted request to change the password.");
562: }
563: return $answer;
1.1 albertel 564: }
565:
1.169 harris41 566: # ----------------------- Try to determine user's current authentication scheme
567:
568: sub queryauthenticate {
569: my ($uname,$udom)=@_;
1.456 albertel 570: my $uhome=&homeserver($uname,$udom);
571: if (!$uhome) {
572: &logthis("User $uname at $udom is unknown when looking for authentication mechanism");
573: return 'no_host';
574: }
575: my $answer=reply("encrypt:currentauth:$udom:$uname",$uhome);
576: if ($answer =~ /^(unknown_user|refused|con_lost)/) {
577: &logthis("User $uname at $udom threw error $answer when checking authentication mechanism");
1.169 harris41 578: }
1.456 albertel 579: return $answer;
1.169 harris41 580: }
581:
1.1 albertel 582: # --------- Try to authenticate user from domain's lib servers (first this one)
1.11 www 583:
1.1 albertel 584: sub authenticate {
585: my ($uname,$upass,$udom)=@_;
1.12 www 586: $upass=escape($upass);
1.199 www 587: $uname=~s/\W//g;
1.471 albertel 588: my $uhome=&homeserver($uname,$udom);
589: if (!$uhome) {
590: &logthis("User $uname at $udom is unknown in authenticate");
591: return 'no_host';
1.1 albertel 592: }
1.471 albertel 593: my $answer=reply("encrypt:auth:$udom:$uname:$upass",$uhome);
594: if ($answer eq 'authorized') {
595: &logthis("User $uname at $udom authorized by $uhome");
596: return $uhome;
597: }
598: if ($answer eq 'non_authorized') {
599: &logthis("User $uname at $udom rejected by $uhome");
600: return 'no_host';
1.9 www 601: }
1.471 albertel 602: &logthis("User $uname at $udom threw error $answer when checking authentication mechanism");
1.1 albertel 603: return 'no_host';
604: }
605:
606: # ---------------------- Find the homebase for a user from domain's lib servers
1.11 www 607:
1.599 albertel 608: my %homecache;
1.1 albertel 609: sub homeserver {
1.230 stredwic 610: my ($uname,$udom,$ignoreBadCache)=@_;
1.1 albertel 611: my $index="$uname:$udom";
1.426 albertel 612:
1.599 albertel 613: if (exists($homecache{$index})) { return $homecache{$index}; }
1.1 albertel 614: my $tryserver;
615: foreach $tryserver (keys %libserv) {
1.230 stredwic 616: next if ($ignoreBadCache ne 'true' &&
1.231 stredwic 617: exists($badServerCache{$tryserver}));
1.1 albertel 618: if ($hostdom{$tryserver} eq $udom) {
619: my $answer=reply("home:$udom:$uname",$tryserver);
620: if ($answer eq 'found') {
1.599 albertel 621: return $homecache{$index}=$tryserver;
1.231 stredwic 622: } elsif ($answer eq 'no_host') {
623: $badServerCache{$tryserver}=1;
1.221 matthew 624: }
1.1 albertel 625: }
626: }
627: return 'no_host';
1.70 www 628: }
629:
630: # ------------------------------------- Find the usernames behind a list of IDs
631:
632: sub idget {
633: my ($udom,@ids)=@_;
634: my %returnhash=();
635:
636: my $tryserver;
637: foreach $tryserver (keys %libserv) {
638: if ($hostdom{$tryserver} eq $udom) {
639: my $idlist=join('&',@ids);
640: $idlist=~tr/A-Z/a-z/;
641: my $reply=&reply("idget:$udom:".$idlist,$tryserver);
642: my @answer=();
1.76 www 643: if (($reply ne 'con_lost') && ($reply!~/^error\:/)) {
1.70 www 644: @answer=split(/\&/,$reply);
645: } ;
646: my $i;
647: for ($i=0;$i<=$#ids;$i++) {
648: if ($answer[$i]) {
649: $returnhash{$ids[$i]}=$answer[$i];
650: }
651: }
652: }
653: }
654: return %returnhash;
655: }
656:
657: # ------------------------------------- Find the IDs behind a list of usernames
658:
659: sub idrget {
660: my ($udom,@unames)=@_;
661: my %returnhash=();
1.191 harris41 662: foreach (@unames) {
1.70 www 663: $returnhash{$_}=(&userenvironment($udom,$_,'id'))[1];
1.191 harris41 664: }
1.70 www 665: return %returnhash;
666: }
667:
668: # ------------------------------- Store away a list of names and associated IDs
669:
670: sub idput {
671: my ($udom,%ids)=@_;
672: my %servers=();
1.191 harris41 673: foreach (keys %ids) {
1.487 albertel 674: &cput('environment',{'id'=>$ids{$_}},$udom,$_);
1.70 www 675: my $uhom=&homeserver($_,$udom);
676: if ($uhom ne 'no_host') {
677: my $id=&escape($ids{$_});
678: $id=~tr/A-Z/a-z/;
679: my $unam=&escape($_);
680: if ($servers{$uhom}) {
681: $servers{$uhom}.='&'.$id.'='.$unam;
682: } else {
683: $servers{$uhom}=$id.'='.$unam;
684: }
685: }
1.191 harris41 686: }
687: foreach (keys %servers) {
1.70 www 688: &critical('idput:'.$udom.':'.$servers{$_},$_);
1.191 harris41 689: }
1.344 www 690: }
691:
692: # --------------------------------------------------- Assign a key to a student
693:
694: sub assign_access_key {
1.364 www 695: #
696: # a valid key looks like uname:udom#comments
697: # comments are being appended
698: #
1.498 www 699: my ($ckey,$kdom,$knum,$cdom,$cnum,$udom,$uname,$logentry)=@_;
700: $kdom=
1.620 albertel 701: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($kdom));
1.498 www 702: $knum=
1.620 albertel 703: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($knum));
1.344 www 704: $cdom=
1.620 albertel 705: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
1.344 www 706: $cnum=
1.620 albertel 707: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
708: $udom=$env{'user.name'} unless (defined($udom));
709: $uname=$env{'user.domain'} unless (defined($uname));
1.498 www 710: my %existing=&get('accesskeys',[$ckey],$kdom,$knum);
1.364 www 711: if (($existing{$ckey}=~/^\#(.*)$/) || # - new key
1.479 albertel 712: ($existing{$ckey}=~/^\Q$uname\E\:\Q$udom\E\#(.*)$/)) {
1.364 www 713: # assigned to this person
714: # - this should not happen,
1.345 www 715: # unless something went wrong
716: # the first time around
717: # ready to assign
1.364 www 718: $logentry=$1.'; '.$logentry;
1.496 www 719: if (&put('accesskeys',{$ckey=>$uname.':'.$udom.'#'.$logentry},
1.498 www 720: $kdom,$knum) eq 'ok') {
1.345 www 721: # key now belongs to user
1.346 www 722: my $envkey='key.'.$cdom.'_'.$cnum;
1.345 www 723: if (&put('environment',{$envkey => $ckey}) eq 'ok') {
724: &appenv('environment.'.$envkey => $ckey);
725: return 'ok';
726: } else {
727: return
728: 'error: Count not permanently assign key, will need to be re-entered later.';
729: }
730: } else {
731: return 'error: Could not assign key, try again later.';
732: }
1.364 www 733: } elsif (!$existing{$ckey}) {
1.345 www 734: # the key does not exist
735: return 'error: The key does not exist';
736: } else {
737: # the key is somebody else's
738: return 'error: The key is already in use';
739: }
1.344 www 740: }
741:
1.364 www 742: # ------------------------------------------ put an additional comment on a key
743:
744: sub comment_access_key {
745: #
746: # a valid key looks like uname:udom#comments
747: # comments are being appended
748: #
749: my ($ckey,$cdom,$cnum,$logentry)=@_;
750: $cdom=
1.620 albertel 751: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
1.364 www 752: $cnum=
1.620 albertel 753: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
1.364 www 754: my %existing=&get('accesskeys',[$ckey],$cdom,$cnum);
755: if ($existing{$ckey}) {
756: $existing{$ckey}.='; '.$logentry;
757: # ready to assign
1.367 www 758: if (&put('accesskeys',{$ckey=>$existing{$ckey}},
1.364 www 759: $cdom,$cnum) eq 'ok') {
760: return 'ok';
761: } else {
762: return 'error: Count not store comment.';
763: }
764: } else {
765: # the key does not exist
766: return 'error: The key does not exist';
767: }
768: }
769:
1.344 www 770: # ------------------------------------------------------ Generate a set of keys
771:
772: sub generate_access_keys {
1.364 www 773: my ($number,$cdom,$cnum,$logentry)=@_;
1.344 www 774: $cdom=
1.620 albertel 775: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
1.344 www 776: $cnum=
1.620 albertel 777: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
1.361 www 778: unless (&allowed('mky',$cdom)) { return 0; }
1.344 www 779: unless (($cdom) && ($cnum)) { return 0; }
780: if ($number>10000) { return 0; }
781: sleep(2); # make sure don't get same seed twice
782: srand(time()^($$+($$<<15))); # from "Programming Perl"
783: my $total=0;
784: for (my $i=1;$i<=$number;$i++) {
785: my $newkey=sprintf("%lx",int(100000*rand)).'-'.
786: sprintf("%lx",int(100000*rand)).'-'.
787: sprintf("%lx",int(100000*rand));
788: $newkey=~s/1/g/g; # folks mix up 1 and l
789: $newkey=~s/0/h/g; # and also 0 and O
790: my %existing=&get('accesskeys',[$newkey],$cdom,$cnum);
791: if ($existing{$newkey}) {
792: $i--;
793: } else {
1.364 www 794: if (&put('accesskeys',
795: { $newkey => '# generated '.localtime().
1.620 albertel 796: ' by '.$env{'user.name'}.'@'.$env{'user.domain'}.
1.364 www 797: '; '.$logentry },
798: $cdom,$cnum) eq 'ok') {
1.344 www 799: $total++;
800: }
801: }
802: }
1.620 albertel 803: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},
1.344 www 804: 'Generated '.$total.' keys for '.$cnum.' at '.$cdom);
805: return $total;
806: }
807:
808: # ------------------------------------------------------- Validate an accesskey
809:
810: sub validate_access_key {
811: my ($ckey,$cdom,$cnum,$udom,$uname)=@_;
812: $cdom=
1.620 albertel 813: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
1.344 www 814: $cnum=
1.620 albertel 815: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
816: $udom=$env{'user.domain'} unless (defined($udom));
817: $uname=$env{'user.name'} unless (defined($uname));
1.345 www 818: my %existing=&get('accesskeys',[$ckey],$cdom,$cnum);
1.479 albertel 819: return ($existing{$ckey}=~/^\Q$uname\E\:\Q$udom\E\#/);
1.70 www 820: }
821:
822: # ------------------------------------- Find the section of student in a course
1.652 albertel 823: sub devalidate_getsection_cache {
824: my ($udom,$unam,$courseid)=@_;
825: $courseid=~s/\_/\//g;
826: $courseid=~s/^(\w)/\/$1/;
827: my $hashid="$udom:$unam:$courseid";
828: &devalidate_cache_new('getsection',$hashid);
829: }
1.298 matthew 830:
831: sub getsection {
832: my ($udom,$unam,$courseid)=@_;
1.599 albertel 833: my $cachetime=1800;
1.298 matthew 834: $courseid=~s/\_/\//g;
835: $courseid=~s/^(\w)/\/$1/;
1.551 albertel 836:
837: my $hashid="$udom:$unam:$courseid";
1.599 albertel 838: my ($result,$cached)=&is_cached_new('getsection',$hashid);
1.551 albertel 839: if (defined($cached)) { return $result; }
840:
1.298 matthew 841: my %Pending;
842: my %Expired;
843: #
844: # Each role can either have not started yet (pending), be active,
845: # or have expired.
846: #
847: # If there is an active role, we are done.
848: #
849: # If there is more than one role which has not started yet,
850: # choose the one which will start sooner
851: # If there is one role which has not started yet, return it.
852: #
853: # If there is more than one expired role, choose the one which ended last.
854: # If there is a role which has expired, return it.
855: #
856: foreach (split(/\&/,&reply('dump:'.$udom.':'.$unam.':roles',
857: &homeserver($unam,$udom)))) {
858: my ($key,$value)=split(/\=/,$_);
859: $key=&unescape($key);
1.479 albertel 860: next if ($key !~/^\Q$courseid\E(?:\/)*(\w+)*\_st$/);
1.298 matthew 861: my $section=$1;
862: if ($key eq $courseid.'_st') { $section=''; }
863: my ($dummy,$end,$start)=split(/\_/,&unescape($value));
864: my $now=time;
1.548 albertel 865: if (defined($end) && $end && ($now > $end)) {
1.298 matthew 866: $Expired{$end}=$section;
867: next;
868: }
1.548 albertel 869: if (defined($start) && $start && ($now < $start)) {
1.298 matthew 870: $Pending{$start}=$section;
871: next;
872: }
1.599 albertel 873: return &do_cache_new('getsection',$hashid,$section,$cachetime);
1.298 matthew 874: }
875: #
876: # Presumedly there will be few matching roles from the above
877: # loop and the sorting time will be negligible.
878: if (scalar(keys(%Pending))) {
879: my ($time) = sort {$a <=> $b} keys(%Pending);
1.599 albertel 880: return &do_cache_new('getsection',$hashid,$Pending{$time},$cachetime);
1.298 matthew 881: }
882: if (scalar(keys(%Expired))) {
883: my @sorted = sort {$a <=> $b} keys(%Expired);
884: my $time = pop(@sorted);
1.599 albertel 885: return &do_cache_new('getsection',$hashid,$Expired{$time},$cachetime);
1.298 matthew 886: }
1.599 albertel 887: return &do_cache_new('getsection',$hashid,'-1',$cachetime);
1.298 matthew 888: }
1.70 www 889:
1.599 albertel 890: sub save_cache {
891: &purge_remembered();
1.722 albertel 892: #&Apache::loncommon::validate_page();
1.620 albertel 893: undef(%env);
1.599 albertel 894: }
1.452 albertel 895:
1.599 albertel 896: my $to_remember=-1;
897: my %remembered;
898: my %accessed;
899: my $kicks=0;
900: my $hits=0;
901: sub devalidate_cache_new {
902: my ($name,$id,$debug) = @_;
903: if ($debug) { &Apache::lonnet::logthis("deleting $name:$id"); }
904: $id=&escape($name.':'.$id);
905: $memcache->delete($id);
906: delete($remembered{$id});
907: delete($accessed{$id});
908: }
909:
910: sub is_cached_new {
911: my ($name,$id,$debug) = @_;
912: $id=&escape($name.':'.$id);
913: if (exists($remembered{$id})) {
914: if ($debug) { &Apache::lonnet::logthis("Earyl return $id of $remembered{$id} "); }
915: $accessed{$id}=[&gettimeofday()];
916: $hits++;
917: return ($remembered{$id},1);
918: }
919: my $value = $memcache->get($id);
920: if (!(defined($value))) {
921: if ($debug) { &Apache::lonnet::logthis("getting $id is not defined"); }
1.417 albertel 922: return (undef,undef);
1.416 albertel 923: }
1.599 albertel 924: if ($value eq '__undef__') {
925: if ($debug) { &Apache::lonnet::logthis("getting $id is __undef__"); }
926: $value=undef;
927: }
928: &make_room($id,$value,$debug);
929: if ($debug) { &Apache::lonnet::logthis("getting $id is $value"); }
930: return ($value,1);
931: }
932:
933: sub do_cache_new {
934: my ($name,$id,$value,$time,$debug) = @_;
935: $id=&escape($name.':'.$id);
936: my $setvalue=$value;
937: if (!defined($setvalue)) {
938: $setvalue='__undef__';
939: }
1.623 albertel 940: if (!defined($time) ) {
941: $time=600;
942: }
1.599 albertel 943: if ($debug) { &Apache::lonnet::logthis("Setting $id to $value"); }
1.600 albertel 944: $memcache->set($id,$setvalue,$time);
945: # need to make a copy of $value
946: #&make_room($id,$value,$debug);
1.599 albertel 947: return $value;
948: }
949:
950: sub make_room {
951: my ($id,$value,$debug)=@_;
952: $remembered{$id}=$value;
953: if ($to_remember<0) { return; }
954: $accessed{$id}=[&gettimeofday()];
955: if (scalar(keys(%remembered)) <= $to_remember) { return; }
956: my $to_kick;
957: my $max_time=0;
958: foreach my $other (keys(%accessed)) {
959: if (&tv_interval($accessed{$other}) > $max_time) {
960: $to_kick=$other;
961: $max_time=&tv_interval($accessed{$other});
962: }
963: }
964: delete($remembered{$to_kick});
965: delete($accessed{$to_kick});
966: $kicks++;
967: if ($debug) { &logthis("kicking $to_kick $max_time $kicks\n"); }
1.541 albertel 968: return;
969: }
970:
1.599 albertel 971: sub purge_remembered {
1.604 albertel 972: #&logthis("Tossing ".scalar(keys(%remembered)));
973: #&logthis(sprintf("%-20s is %s",'%remembered',length(&freeze(\%remembered))));
1.599 albertel 974: undef(%remembered);
975: undef(%accessed);
1.428 albertel 976: }
1.70 www 977: # ------------------------------------- Read an entry from a user's environment
978:
979: sub userenvironment {
980: my ($udom,$unam,@what)=@_;
981: my %returnhash=();
982: my @answer=split(/\&/,
983: &reply('get:'.$udom.':'.$unam.':environment:'.join('&',@what),
984: &homeserver($unam,$udom)));
985: my $i;
986: for ($i=0;$i<=$#what;$i++) {
987: $returnhash{$what[$i]}=&unescape($answer[$i]);
988: }
989: return %returnhash;
1.1 albertel 990: }
991:
1.617 albertel 992: # ---------------------------------------------------------- Get a studentphoto
993: sub studentphoto {
994: my ($udom,$unam,$ext) = @_;
995: my $home=&Apache::lonnet::homeserver($unam,$udom);
1.706 raeburn 996: if (defined($env{'request.course.id'})) {
1.708 raeburn 997: if ($env{'course.'.$env{'request.course.id'}.'.internal.showphoto'}) {
1.706 raeburn 998: if ($udom eq $env{'course.'.$env{'request.course.id'}.'.domain'}) {
999: return(&retrievestudentphoto($udom,$unam,$ext));
1000: } else {
1001: my ($result,$perm_reqd)=
1.707 albertel 1002: &Apache::lonnet::auto_photo_permission($unam,$udom);
1.706 raeburn 1003: if ($result eq 'ok') {
1004: if (!($perm_reqd eq 'yes')) {
1005: return(&retrievestudentphoto($udom,$unam,$ext));
1006: }
1007: }
1008: }
1009: }
1010: } else {
1011: my ($result,$perm_reqd) =
1.707 albertel 1012: &Apache::lonnet::auto_photo_permission($unam,$udom);
1.706 raeburn 1013: if ($result eq 'ok') {
1014: if (!($perm_reqd eq 'yes')) {
1015: return(&retrievestudentphoto($udom,$unam,$ext));
1016: }
1017: }
1018: }
1019: return '/adm/lonKaputt/lonlogo_broken.gif';
1020: }
1021:
1022: sub retrievestudentphoto {
1023: my ($udom,$unam,$ext,$type) = @_;
1024: my $home=&Apache::lonnet::homeserver($unam,$udom);
1025: my $ret=&Apache::lonnet::reply("studentphoto:$udom:$unam:$ext:$type",$home);
1026: if ($ret eq 'ok') {
1027: my $url="/uploaded/$udom/$unam/internal/studentphoto.$ext";
1028: if ($type eq 'thumbnail') {
1029: $url="/uploaded/$udom/$unam/internal/studentphoto_tn.$ext";
1030: }
1031: my $tokenurl=&Apache::lonnet::tokenwrapper($url);
1032: return $tokenurl;
1033: } else {
1034: if ($type eq 'thumbnail') {
1035: return '/adm/lonKaputt/genericstudent_tn.gif';
1036: } else {
1037: return '/adm/lonKaputt/lonlogo_broken.gif';
1038: }
1.617 albertel 1039: }
1040: }
1041:
1.263 www 1042: # -------------------------------------------------------------------- New chat
1043:
1044: sub chatsend {
1.724 raeburn 1045: my ($newentry,$anon,$group)=@_;
1.620 albertel 1046: my $cnum=$env{'course.'.$env{'request.course.id'}.'.num'};
1047: my $cdom=$env{'course.'.$env{'request.course.id'}.'.domain'};
1048: my $chome=$env{'course.'.$env{'request.course.id'}.'.home'};
1.263 www 1049: &reply('chatsend:'.$cdom.':'.$cnum.':'.
1.620 albertel 1050: &escape($env{'user.domain'}.':'.$env{'user.name'}.':'.$anon.':'.
1.724 raeburn 1051: &escape($newentry)).':'.$group,$chome);
1.292 www 1052: }
1053:
1054: # ------------------------------------------ Find current version of a resource
1055:
1056: sub getversion {
1057: my $fname=&clutter(shift);
1058: unless ($fname=~/^\/res\//) { return -1; }
1059: return ¤tversion(&filelocation('',$fname));
1060: }
1061:
1062: sub currentversion {
1063: my $fname=shift;
1.599 albertel 1064: my ($result,$cached)=&is_cached_new('resversion',$fname);
1.440 www 1065: if (defined($cached)) { return $result; }
1.292 www 1066: my $author=$fname;
1067: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
1068: my ($udom,$uname)=split(/\//,$author);
1069: my $home=homeserver($uname,$udom);
1070: if ($home eq 'no_host') {
1071: return -1;
1072: }
1073: my $answer=reply("currentversion:$fname",$home);
1074: if (($answer eq 'con_lost') || ($answer eq 'rejected')) {
1075: return -1;
1076: }
1.599 albertel 1077: return &do_cache_new('resversion',$fname,$answer,600);
1.263 www 1078: }
1079:
1.1 albertel 1080: # ----------------------------- Subscribe to a resource, return URL if possible
1.11 www 1081:
1.1 albertel 1082: sub subscribe {
1083: my $fname=shift;
1.312 www 1084: if ($fname=~/\/(aboutme|syllabus|bulletinboard|smppg)$/) { return ''; }
1.532 albertel 1085: $fname=~s/[\n\r]//g;
1.1 albertel 1086: my $author=$fname;
1087: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
1088: my ($udom,$uname)=split(/\//,$author);
1089: my $home=homeserver($uname,$udom);
1.335 albertel 1090: if ($home eq 'no_host') {
1091: return 'not_found';
1.1 albertel 1092: }
1093: my $answer=reply("sub:$fname",$home);
1.64 www 1094: if (($answer eq 'con_lost') || ($answer eq 'rejected')) {
1095: $answer.=' by '.$home;
1096: }
1.1 albertel 1097: return $answer;
1098: }
1099:
1.8 www 1100: # -------------------------------------------------------------- Replicate file
1101:
1102: sub repcopy {
1103: my $filename=shift;
1.23 www 1104: $filename=~s/\/+/\//g;
1.607 raeburn 1105: if ($filename=~m|^/home/httpd/html/adm/|) { return 'ok'; }
1106: if ($filename=~m|^/home/httpd/html/lonUsers/|) { return 'ok'; }
1.538 albertel 1107: if ($filename=~m|^/home/httpd/html/userfiles/| or
1.609 banghart 1108: $filename=~m -^/*(uploaded|editupload)/-) {
1.538 albertel 1109: return &repcopy_userfile($filename);
1110: }
1.532 albertel 1111: $filename=~s/[\n\r]//g;
1.8 www 1112: my $transname="$filename.in.transfer";
1.607 raeburn 1113: if ((-e $filename) || (-e $transname)) { return 'ok'; }
1.8 www 1114: my $remoteurl=subscribe($filename);
1.64 www 1115: if ($remoteurl =~ /^con_lost by/) {
1116: &logthis("Subscribe returned $remoteurl: $filename");
1.607 raeburn 1117: return 'unavailable';
1.8 www 1118: } elsif ($remoteurl eq 'not_found') {
1.441 albertel 1119: #&logthis("Subscribe returned not_found: $filename");
1.607 raeburn 1120: return 'not_found';
1.64 www 1121: } elsif ($remoteurl =~ /^rejected by/) {
1122: &logthis("Subscribe returned $remoteurl: $filename");
1.607 raeburn 1123: return 'forbidden';
1.20 www 1124: } elsif ($remoteurl eq 'directory') {
1.607 raeburn 1125: return 'ok';
1.8 www 1126: } else {
1.290 www 1127: my $author=$filename;
1128: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
1129: my ($udom,$uname)=split(/\//,$author);
1130: my $home=homeserver($uname,$udom);
1131: unless ($home eq $perlvar{'lonHostID'}) {
1.8 www 1132: my @parts=split(/\//,$filename);
1133: my $path="/$parts[1]/$parts[2]/$parts[3]/$parts[4]";
1134: if ($path ne "$perlvar{'lonDocRoot'}/res") {
1135: &logthis("Malconfiguration for replication: $filename");
1.607 raeburn 1136: return 'bad_request';
1.8 www 1137: }
1138: my $count;
1139: for ($count=5;$count<$#parts;$count++) {
1140: $path.="/$parts[$count]";
1141: if ((-e $path)!=1) {
1142: mkdir($path,0777);
1143: }
1144: }
1145: my $ua=new LWP::UserAgent;
1146: my $request=new HTTP::Request('GET',"$remoteurl");
1147: my $response=$ua->request($request,$transname);
1148: if ($response->is_error()) {
1149: unlink($transname);
1150: my $message=$response->status_line;
1.672 albertel 1151: &logthis("<font color=\"blue\">WARNING:"
1.12 www 1152: ." LWP get: $message: $filename</font>");
1.607 raeburn 1153: return 'unavailable';
1.8 www 1154: } else {
1.16 www 1155: if ($remoteurl!~/\.meta$/) {
1156: my $mrequest=new HTTP::Request('GET',$remoteurl.'.meta');
1157: my $mresponse=$ua->request($mrequest,$filename.'.meta');
1158: if ($mresponse->is_error()) {
1159: unlink($filename.'.meta');
1160: &logthis(
1.672 albertel 1161: "<font color=\"yellow\">INFO: No metadata: $filename</font>");
1.16 www 1162: }
1163: }
1.8 www 1164: rename($transname,$filename);
1.607 raeburn 1165: return 'ok';
1.8 www 1166: }
1.290 www 1167: }
1.8 www 1168: }
1.330 www 1169: }
1170:
1171: # ------------------------------------------------ Get server side include body
1172: sub ssi_body {
1.381 albertel 1173: my ($filelink,%form)=@_;
1.606 matthew 1174: if (! exists($form{'LONCAPA_INTERNAL_no_discussion'})) {
1175: $form{'LONCAPA_INTERNAL_no_discussion'}='true';
1176: }
1.330 www 1177: my $output=($filelink=~/^http\:/?&externalssi($filelink):
1.381 albertel 1178: &ssi($filelink,%form));
1.565 albertel 1179: $output=~s|//(\s*<!--)? BEGIN LON-CAPA Internal.+// END LON-CAPA Internal\s*(-->)?\s||gs;
1.451 albertel 1180: $output=~s/^.*?\<body[^\>]*\>//si;
1181: $output=~s/(.*)\<\/body\s*\>.*?$/$1/si;
1.330 www 1182: return $output;
1.8 www 1183: }
1184:
1.15 www 1185: # --------------------------------------------------------- Server Side Include
1186:
1187: sub ssi {
1188:
1.23 www 1189: my ($fn,%form)=@_;
1.15 www 1190:
1191: my $ua=new LWP::UserAgent;
1.23 www 1192:
1193: my $request;
1.711 albertel 1194:
1195: $form{'no_update_last_known'}=1;
1196:
1.23 www 1197: if (%form) {
1198: $request=new HTTP::Request('POST',"http://".$ENV{'HTTP_HOST'}.$fn);
1.201 albertel 1199: $request->content(join('&',map { &escape($_).'='.&escape($form{$_}) } keys %form));
1.23 www 1200: } else {
1201: $request=new HTTP::Request('GET',"http://".$ENV{'HTTP_HOST'}.$fn);
1202: }
1203:
1.15 www 1204: $request->header(Cookie => $ENV{'HTTP_COOKIE'});
1205: my $response=$ua->request($request);
1206:
1.324 www 1207: return $response->content;
1208: }
1209:
1210: sub externalssi {
1211: my ($url)=@_;
1212: my $ua=new LWP::UserAgent;
1213: my $request=new HTTP::Request('GET',$url);
1214: my $response=$ua->request($request);
1.15 www 1215: return $response->content;
1216: }
1.254 www 1217:
1.492 albertel 1218: # -------------------------------- Allow a /uploaded/ URI to be vouched for
1219:
1220: sub allowuploaded {
1221: my ($srcurl,$url)=@_;
1222: $url=&clutter(&declutter($url));
1223: my $dir=$url;
1224: $dir=~s/\/[^\/]+$//;
1225: my %httpref=();
1226: my $httpurl=&hreflocation('',$url);
1227: $httpref{'httpref.'.$httpurl}=$srcurl;
1228: &Apache::lonnet::appenv(%httpref);
1.254 www 1229: }
1.477 raeburn 1230:
1.478 albertel 1231: # --------- File operations in /home/httpd/html/userfiles/$domain/1/2/3/$course
1.638 albertel 1232: # input: action, courseID, current domain, intended
1.637 raeburn 1233: # path to file, source of file, instruction to parse file for objects,
1234: # ref to hash for embedded objects,
1235: # ref to hash for codebase of java objects.
1236: #
1.485 raeburn 1237: # output: url to file (if action was uploaddoc),
1238: # ok if successful, or diagnostic message otherwise (if action was propagate or copy)
1.477 raeburn 1239: #
1.478 albertel 1240: # Allows directory structure to be used within lonUsers/../userfiles/ for a
1241: # course.
1.477 raeburn 1242: #
1.478 albertel 1243: # action = propagate - /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
1244: # will be copied to /home/httpd/lonUsers/1/2/3/$course/userfiles in
1245: # course's home server.
1.477 raeburn 1246: #
1.478 albertel 1247: # action = copy - /home/httpd/html/userfiles/$domain/1/2/3/$course/$file will
1248: # be copied from $source (current location) to
1249: # /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
1250: # and will then be copied to
1251: # /home/httpd/lonUsers/$domain/1/2/3/$course/userfiles/$file in
1252: # course's home server.
1.485 raeburn 1253: #
1.481 raeburn 1254: # action = uploaddoc - /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
1.620 albertel 1255: # will be retrived from $env{form.uploaddoc} (from DOCS interface) to
1.481 raeburn 1256: # /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
1257: # and will then be copied to /home/httpd/lonUsers/1/2/3/$course/userfiles/$file
1258: # in course's home server.
1.637 raeburn 1259: #
1.477 raeburn 1260:
1261: sub process_coursefile {
1.638 albertel 1262: my ($action,$docuname,$docudom,$file,$source,$parser,$allfiles,$codebase)=@_;
1.477 raeburn 1263: my $fetchresult;
1.638 albertel 1264: my $home=&homeserver($docuname,$docudom);
1.477 raeburn 1265: if ($action eq 'propagate') {
1.638 albertel 1266: $fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
1267: $home);
1.481 raeburn 1268: } else {
1.477 raeburn 1269: my $fpath = '';
1270: my $fname = $file;
1.478 albertel 1271: ($fpath,$fname) = ($file =~ m|^(.*)/([^/]+)$|);
1.477 raeburn 1272: $fpath=$docudom.'/'.$docuname.'/'.$fpath;
1.637 raeburn 1273: my $filepath = &build_filepath($fpath);
1.481 raeburn 1274: if ($action eq 'copy') {
1275: if ($source eq '') {
1276: $fetchresult = 'no source file';
1277: return $fetchresult;
1278: } else {
1279: my $destination = $filepath.'/'.$fname;
1280: rename($source,$destination);
1281: $fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
1.638 albertel 1282: $home);
1.481 raeburn 1283: }
1284: } elsif ($action eq 'uploaddoc') {
1285: open(my $fh,'>'.$filepath.'/'.$fname);
1.620 albertel 1286: print $fh $env{'form.'.$source};
1.481 raeburn 1287: close($fh);
1.637 raeburn 1288: if ($parser eq 'parse') {
1289: my $parse_result = &extract_embedded_items($filepath,$fname,$allfiles,$codebase);
1290: unless ($parse_result eq 'ok') {
1291: &logthis('Failed to parse '.$filepath.'/'.$fname.' for embedded media: '.$parse_result);
1292: }
1293: }
1.477 raeburn 1294: $fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
1.638 albertel 1295: $home);
1.481 raeburn 1296: if ($fetchresult eq 'ok') {
1297: return '/uploaded/'.$fpath.'/'.$fname;
1298: } else {
1299: &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$file.
1.638 albertel 1300: ' to host '.$home.': '.$fetchresult);
1.481 raeburn 1301: return '/adm/notfound.html';
1302: }
1.477 raeburn 1303: }
1304: }
1.485 raeburn 1305: unless ( $fetchresult eq 'ok') {
1.477 raeburn 1306: &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$file.
1.638 albertel 1307: ' to host '.$home.': '.$fetchresult);
1.477 raeburn 1308: }
1309: return $fetchresult;
1310: }
1311:
1.637 raeburn 1312: sub build_filepath {
1313: my ($fpath) = @_;
1314: my $filepath=$perlvar{'lonDocRoot'}.'/userfiles';
1315: unless ($fpath eq '') {
1316: my @parts=split('/',$fpath);
1317: foreach my $part (@parts) {
1318: $filepath.= '/'.$part;
1319: if ((-e $filepath)!=1) {
1320: mkdir($filepath,0777);
1321: }
1322: }
1323: }
1324: return $filepath;
1325: }
1326:
1327: sub store_edited_file {
1.638 albertel 1328: my ($primary_url,$content,$docudom,$docuname,$fetchresult) = @_;
1.637 raeburn 1329: my $file = $primary_url;
1330: $file =~ s#^/uploaded/$docudom/$docuname/##;
1331: my $fpath = '';
1332: my $fname = $file;
1333: ($fpath,$fname) = ($file =~ m|^(.*)/([^/]+)$|);
1334: $fpath=$docudom.'/'.$docuname.'/'.$fpath;
1335: my $filepath = &build_filepath($fpath);
1336: open(my $fh,'>'.$filepath.'/'.$fname);
1337: print $fh $content;
1338: close($fh);
1.638 albertel 1339: my $home=&homeserver($docuname,$docudom);
1.637 raeburn 1340: $$fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
1.638 albertel 1341: $home);
1.637 raeburn 1342: if ($$fetchresult eq 'ok') {
1343: return '/uploaded/'.$fpath.'/'.$fname;
1344: } else {
1.638 albertel 1345: &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$file.
1346: ' to host '.$home.': '.$$fetchresult);
1.637 raeburn 1347: return '/adm/notfound.html';
1348: }
1349: }
1350:
1.531 albertel 1351: sub clean_filename {
1352: my ($fname)=@_;
1.315 www 1353: # Replace Windows backslashes by forward slashes
1.257 www 1354: $fname=~s/\\/\//g;
1.315 www 1355: # Get rid of everything but the actual filename
1.257 www 1356: $fname=~s/^.*\/([^\/]+)$/$1/;
1.315 www 1357: # Replace spaces by underscores
1358: $fname=~s/\s+/\_/g;
1359: # Replace all other weird characters by nothing
1.317 www 1360: $fname=~s/[^\w\.\-]//g;
1.540 albertel 1361: # Replace all .\d. sequences with _\d. so they no longer look like version
1362: # numbers
1363: $fname=~s/\.(\d+)(?=\.)/_$1/g;
1.531 albertel 1364: return $fname;
1365: }
1366:
1.608 albertel 1367: # --------------- Take an uploaded file and put it into the userfiles directory
1.686 albertel 1368: # input: $formname - the contents of the file are in $env{"form.$formname"}
1.719 banghart 1369: # the desired filenam is in $env{"form.$formname.filename"}
1.686 albertel 1370: # $coursedoc - if true up to the current course
1371: # if false
1372: # $subdir - directory in userfile to store the file into
1373: # $parser, $allfiles, $codebase - unknown
1374: #
1375: # output: url of file in userspace, or error: <message>
1376: # or /adm/notfound.html if failure to upload occurse
1.608 albertel 1377:
1378:
1.531 albertel 1379: sub userfileupload {
1.719 banghart 1380: my ($formname,$coursedoc,$subdir,$parser,$allfiles,$codebase,$destuname,$destudom)=@_;
1.531 albertel 1381: if (!defined($subdir)) { $subdir='unknown'; }
1.620 albertel 1382: my $fname=$env{'form.'.$formname.'.filename'};
1.531 albertel 1383: $fname=&clean_filename($fname);
1.315 www 1384: # See if there is anything left
1.257 www 1385: unless ($fname) { return 'error: no uploaded file'; }
1.620 albertel 1386: chop($env{'form.'.$formname});
1.523 raeburn 1387: if (($formname eq 'screenshot') && ($subdir eq 'helprequests')) { #files uploaded to help request form are handled differently
1388: my $now = time;
1389: my $filepath = 'tmp/helprequests/'.$now;
1390: my @parts=split(/\//,$filepath);
1391: my $fullpath = $perlvar{'lonDaemons'};
1392: for (my $i=0;$i<@parts;$i++) {
1393: $fullpath .= '/'.$parts[$i];
1394: if ((-e $fullpath)!=1) {
1395: mkdir($fullpath,0777);
1396: }
1397: }
1398: open(my $fh,'>'.$fullpath.'/'.$fname);
1.620 albertel 1399: print $fh $env{'form.'.$formname};
1.523 raeburn 1400: close($fh);
1.741 raeburn 1401: return $fullpath.'/'.$fname;
1402: } elsif (($formname eq 'coursecreatorxml') && ($subdir eq 'batchupload')) { #files uploaded to create course page are handled differently
1403: my $filepath = 'tmp/addcourse/'.$destudom.'/web/'.$env{'user.name'}.
1404: '_'.$env{'user.domain'}.'/pending';
1405: my @parts=split(/\//,$filepath);
1406: my $fullpath = $perlvar{'lonDaemons'};
1407: for (my $i=0;$i<@parts;$i++) {
1408: $fullpath .= '/'.$parts[$i];
1409: if ((-e $fullpath)!=1) {
1410: mkdir($fullpath,0777);
1411: }
1412: }
1413: open(my $fh,'>'.$fullpath.'/'.$fname);
1414: print $fh $env{'form.'.$formname};
1415: close($fh);
1416: return $fullpath.'/'.$fname;
1.523 raeburn 1417: }
1.719 banghart 1418:
1.258 www 1419: # Create the directory if not present
1.493 albertel 1420: $fname="$subdir/$fname";
1.259 www 1421: if ($coursedoc) {
1.638 albertel 1422: my $docuname=$env{'course.'.$env{'request.course.id'}.'.num'};
1423: my $docudom=$env{'course.'.$env{'request.course.id'}.'.domain'};
1.646 raeburn 1424: if ($env{'form.folder'} =~ m/^(default|supplemental)/) {
1.638 albertel 1425: return &finishuserfileupload($docuname,$docudom,
1426: $formname,$fname,$parser,$allfiles,
1427: $codebase);
1.481 raeburn 1428: } else {
1.620 albertel 1429: $fname=$env{'form.folder'}.'/'.$fname;
1.638 albertel 1430: return &process_coursefile('uploaddoc',$docuname,$docudom,
1431: $fname,$formname,$parser,
1432: $allfiles,$codebase);
1.481 raeburn 1433: }
1.719 banghart 1434: } elsif (defined($destuname)) {
1435: my $docuname=$destuname;
1436: my $docudom=$destudom;
1437: return &finishuserfileupload($docuname,$docudom,$formname,
1438: $fname,$parser,$allfiles,$codebase);
1439:
1.259 www 1440: } else {
1.638 albertel 1441: my $docuname=$env{'user.name'};
1442: my $docudom=$env{'user.domain'};
1.714 raeburn 1443: if (exists($env{'form.group'})) {
1444: $docuname=$env{'course.'.$env{'request.course.id'}.'.num'};
1445: $docudom=$env{'course.'.$env{'request.course.id'}.'.domain'};
1446: }
1.638 albertel 1447: return &finishuserfileupload($docuname,$docudom,$formname,
1448: $fname,$parser,$allfiles,$codebase);
1.259 www 1449: }
1.271 www 1450: }
1451:
1452: sub finishuserfileupload {
1.638 albertel 1453: my ($docuname,$docudom,$formname,$fname,$parser,$allfiles,$codebase) = @_;
1.477 raeburn 1454: my $path=$docudom.'/'.$docuname.'/';
1.258 www 1455: my $filepath=$perlvar{'lonDocRoot'};
1.494 albertel 1456: my ($fnamepath,$file);
1457: $file=$fname;
1458: if ($fname=~m|/|) {
1459: ($fnamepath,$file) = ($fname =~ m|^(.*)/([^/]+)$|);
1460: $path.=$fnamepath.'/';
1461: }
1.259 www 1462: my @parts=split(/\//,$filepath.'/userfiles/'.$path);
1.258 www 1463: my $count;
1464: for ($count=4;$count<=$#parts;$count++) {
1465: $filepath.="/$parts[$count]";
1466: if ((-e $filepath)!=1) {
1467: mkdir($filepath,0777);
1468: }
1469: }
1470: # Save the file
1471: {
1.701 albertel 1472: if (!open(FH,'>'.$filepath.'/'.$file)) {
1473: &logthis('Failed to create '.$filepath.'/'.$file);
1474: print STDERR ('Failed to create '.$filepath.'/'.$file."\n");
1475: return '/adm/notfound.html';
1476: }
1477: if (!print FH ($env{'form.'.$formname})) {
1478: &logthis('Failed to write to '.$filepath.'/'.$file);
1479: print STDERR ('Failed to write to '.$filepath.'/'.$file."\n");
1480: return '/adm/notfound.html';
1481: }
1.570 albertel 1482: close(FH);
1.258 www 1483: }
1.637 raeburn 1484: if ($parser eq 'parse') {
1.638 albertel 1485: my $parse_result = &extract_embedded_items($filepath,$file,$allfiles,
1486: $codebase);
1.637 raeburn 1487: unless ($parse_result eq 'ok') {
1.638 albertel 1488: &logthis('Failed to parse '.$filepath.$file.
1489: ' for embedded media: '.$parse_result);
1.637 raeburn 1490: }
1491: }
1.259 www 1492: # Notify homeserver to grep it
1493: #
1.638 albertel 1494: my $docuhome=&homeserver($docuname,$docudom);
1.494 albertel 1495: my $fetchresult= &reply('fetchuserfile:'.$path.$file,$docuhome);
1.295 www 1496: if ($fetchresult eq 'ok') {
1.259 www 1497: #
1.258 www 1498: # Return the URL to it
1.494 albertel 1499: return '/uploaded/'.$path.$file;
1.263 www 1500: } else {
1.494 albertel 1501: &logthis('Failed to transfer '.$path.$file.' to host '.$docuhome.
1502: ': '.$fetchresult);
1.263 www 1503: return '/adm/notfound.html';
1504: }
1.493 albertel 1505: }
1506:
1.637 raeburn 1507: sub extract_embedded_items {
1.648 raeburn 1508: my ($filepath,$file,$allfiles,$codebase,$content) = @_;
1.637 raeburn 1509: my @state = ();
1510: my %javafiles = (
1511: codebase => '',
1512: code => '',
1513: archive => ''
1514: );
1515: my %mediafiles = (
1516: src => '',
1517: movie => '',
1518: );
1.648 raeburn 1519: my $p;
1520: if ($content) {
1521: $p = HTML::LCParser->new($content);
1522: } else {
1523: $p = HTML::LCParser->new($filepath.'/'.$file);
1524: }
1.641 albertel 1525: while (my $t=$p->get_token()) {
1.640 albertel 1526: if ($t->[0] eq 'S') {
1527: my ($tagname, $attr) = ($t->[1],$t->[2]);
1528: push (@state, $tagname);
1.648 raeburn 1529: if (lc($tagname) eq 'allow') {
1530: &add_filetype($allfiles,$attr->{'src'},'src');
1531: }
1.640 albertel 1532: if (lc($tagname) eq 'img') {
1533: &add_filetype($allfiles,$attr->{'src'},'src');
1534: }
1.645 raeburn 1535: if (lc($tagname) eq 'script') {
1536: if ($attr->{'archive'} =~ /\.jar$/i) {
1537: &add_filetype($allfiles,$attr->{'archive'},'archive');
1538: } else {
1539: &add_filetype($allfiles,$attr->{'src'},'src');
1540: }
1541: }
1542: if (lc($tagname) eq 'link') {
1543: if (lc($attr->{'rel'}) eq 'stylesheet') {
1544: &add_filetype($allfiles,$attr->{'href'},'href');
1545: }
1546: }
1.640 albertel 1547: if (lc($tagname) eq 'object' ||
1548: (lc($tagname) eq 'embed' && lc($state[-2]) ne 'object')) {
1549: foreach my $item (keys(%javafiles)) {
1550: $javafiles{$item} = '';
1551: }
1552: }
1553: if (lc($state[-2]) eq 'object' && lc($tagname) eq 'param') {
1554: my $name = lc($attr->{'name'});
1555: foreach my $item (keys(%javafiles)) {
1556: if ($name eq $item) {
1557: $javafiles{$item} = $attr->{'value'};
1558: last;
1559: }
1560: }
1561: foreach my $item (keys(%mediafiles)) {
1562: if ($name eq $item) {
1563: &add_filetype($allfiles, $attr->{'value'}, 'value');
1564: last;
1565: }
1566: }
1567: }
1568: if (lc($tagname) eq 'embed' || lc($tagname) eq 'applet') {
1569: foreach my $item (keys(%javafiles)) {
1570: if ($attr->{$item}) {
1571: $javafiles{$item} = $attr->{$item};
1572: last;
1573: }
1574: }
1575: foreach my $item (keys(%mediafiles)) {
1576: if ($attr->{$item}) {
1577: &add_filetype($allfiles,$attr->{$item},$item);
1578: last;
1579: }
1580: }
1581: }
1582: } elsif ($t->[0] eq 'E') {
1583: my ($tagname) = ($t->[1]);
1584: if ($javafiles{'codebase'} ne '') {
1585: $javafiles{'codebase'} .= '/';
1586: }
1587: if (lc($tagname) eq 'applet' ||
1588: lc($tagname) eq 'object' ||
1589: (lc($tagname) eq 'embed' && lc($state[-2]) ne 'object')
1590: ) {
1591: foreach my $item (keys(%javafiles)) {
1592: if ($item ne 'codebase' && $javafiles{$item} ne '') {
1593: my $file=$javafiles{'codebase'}.$javafiles{$item};
1594: &add_filetype($allfiles,$file,$item);
1595: }
1596: }
1597: }
1598: pop @state;
1599: }
1600: }
1.637 raeburn 1601: return 'ok';
1602: }
1603:
1.639 albertel 1604: sub add_filetype {
1605: my ($allfiles,$file,$type)=@_;
1606: if (exists($allfiles->{$file})) {
1607: unless (grep/^\Q$type\E$/, @{$allfiles->{$file}}) {
1608: push(@{$allfiles->{$file}}, &escape($type));
1609: }
1610: } else {
1611: @{$allfiles->{$file}} = (&escape($type));
1.637 raeburn 1612: }
1613: }
1614:
1.493 albertel 1615: sub removeuploadedurl {
1616: my ($url)=@_;
1617: my (undef,undef,$udom,$uname,$fname)=split('/',$url,5);
1.613 albertel 1618: return &removeuserfile($uname,$udom,$fname);
1.490 albertel 1619: }
1620:
1621: sub removeuserfile {
1622: my ($docuname,$docudom,$fname)=@_;
1623: my $home=&homeserver($docuname,$docudom);
1624: return &reply("removeuserfile:$docudom/$docuname/$fname",$home);
1.257 www 1625: }
1.15 www 1626:
1.530 albertel 1627: sub mkdiruserfile {
1628: my ($docuname,$docudom,$dir)=@_;
1629: my $home=&homeserver($docuname,$docudom);
1630: return &reply("mkdiruserfile:".&escape("$docudom/$docuname/$dir"),$home);
1631: }
1632:
1.531 albertel 1633: sub renameuserfile {
1634: my ($docuname,$docudom,$old,$new)=@_;
1635: my $home=&homeserver($docuname,$docudom);
1636: return &reply("renameuserfile:$docudom:$docuname:".&escape("$old").':'.
1637: &escape("$new"),$home);
1638: }
1639:
1.14 www 1640: # ------------------------------------------------------------------------- Log
1641:
1642: sub log {
1643: my ($dom,$nam,$hom,$what)=@_;
1.47 www 1644: return critical("log:$dom:$nam:$what",$hom);
1.157 www 1645: }
1646:
1647: # ------------------------------------------------------------------ Course Log
1.352 www 1648: #
1649: # This routine flushes several buffers of non-mission-critical nature
1650: #
1.157 www 1651:
1652: sub flushcourselogs {
1.352 www 1653: &logthis('Flushing log buffers');
1654: #
1655: # course logs
1656: # This is a log of all transactions in a course, which can be used
1657: # for data mining purposes
1658: #
1659: # It also collects the courseid database, which lists last transaction
1660: # times and course titles for all courseids
1661: #
1662: my %courseidbuffer=();
1.191 harris41 1663: foreach (keys %courselogs) {
1.157 www 1664: my $crsid=$_;
1.352 www 1665: if (&reply('log:'.$coursedombuf{$crsid}.':'.$coursenumbuf{$crsid}.':'.
1.188 www 1666: &escape($courselogs{$crsid}),
1667: $coursehombuf{$crsid}) eq 'ok') {
1.157 www 1668: delete $courselogs{$crsid};
1669: } else {
1670: &logthis('Failed to flush log buffer for '.$crsid);
1671: if (length($courselogs{$crsid})>40000) {
1.672 albertel 1672: &logthis("<font color=\"blue\">WARNING: Buffer for ".$crsid.
1.157 www 1673: " exceeded maximum size, deleting.</font>");
1674: delete $courselogs{$crsid};
1675: }
1.352 www 1676: }
1677: if ($courseidbuffer{$coursehombuf{$crsid}}) {
1678: $courseidbuffer{$coursehombuf{$crsid}}.='&'.
1.516 raeburn 1679: &escape($crsid).'='.&escape($coursedescrbuf{$crsid}).
1.741 raeburn 1680: ':'.&escape($courseinstcodebuf{$crsid}).':'.&escape($courseownerbuf{$crsid}).':'.&escape($coursetypebuf{$crsid});
1.352 www 1681: } else {
1682: $courseidbuffer{$coursehombuf{$crsid}}=
1.516 raeburn 1683: &escape($crsid).'='.&escape($coursedescrbuf{$crsid}).
1.741 raeburn 1684: ':'.&escape($courseinstcodebuf{$crsid}).':'.&escape($courseownerbuf{$crsid}).':'.&escape($coursetypebuf{$crsid});
1.571 raeburn 1685: }
1.191 harris41 1686: }
1.352 www 1687: #
1688: # Write course id database (reverse lookup) to homeserver of courses
1689: # Is used in pickcourse
1690: #
1691: foreach (keys %courseidbuffer) {
1.353 www 1692: &courseidput($hostdom{$_},$courseidbuffer{$_},$_);
1.352 www 1693: }
1694: #
1695: # File accesses
1696: # Writes to the dynamic metadata of resources to get hit counts, etc.
1697: #
1.449 matthew 1698: foreach my $entry (keys(%accesshash)) {
1.458 matthew 1699: if ($entry =~ /___count$/) {
1700: my ($dom,$name);
1701: ($dom,$name,undef)=($entry=~m:___(\w+)/(\w+)/(.*)___count$:);
1702: if (! defined($dom) || $dom eq '' ||
1703: ! defined($name) || $name eq '') {
1.620 albertel 1704: my $cid = $env{'request.course.id'};
1705: $dom = $env{'request.'.$cid.'.domain'};
1706: $name = $env{'request.'.$cid.'.num'};
1.458 matthew 1707: }
1.450 matthew 1708: my $value = $accesshash{$entry};
1709: my (undef,$url,undef) = ($entry =~ /^(.*)___(.*)___count$/);
1710: my %temphash=($url => $value);
1.449 matthew 1711: my $result = &inc('nohist_accesscount',\%temphash,$dom,$name);
1712: if ($result eq 'ok') {
1713: delete $accesshash{$entry};
1714: } elsif ($result eq 'unknown_cmd') {
1715: # Target server has old code running on it.
1.450 matthew 1716: my %temphash=($entry => $value);
1.449 matthew 1717: if (&put('nohist_resevaldata',\%temphash,$dom,$name) eq 'ok') {
1718: delete $accesshash{$entry};
1719: }
1720: }
1721: } else {
1.458 matthew 1722: my ($dom,$name) = ($entry=~m:___(\w+)/(\w+)/(.*)___(\w+)$:);
1.450 matthew 1723: my %temphash=($entry => $accesshash{$entry});
1.449 matthew 1724: if (&put('nohist_resevaldata',\%temphash,$dom,$name) eq 'ok') {
1725: delete $accesshash{$entry};
1726: }
1.185 www 1727: }
1.191 harris41 1728: }
1.352 www 1729: #
1730: # Roles
1731: # Reverse lookup of user roles for course faculty/staff and co-authorship
1732: #
1.349 www 1733: foreach (keys %userrolehash) {
1734: my $entry=$_;
1.351 www 1735: my ($role,$uname,$udom,$runame,$rudom,$rsec)=
1.349 www 1736: split(/\:/,$entry);
1737: if (&Apache::lonnet::put('nohist_userroles',
1.351 www 1738: { $role.':'.$uname.':'.$udom.':'.$rsec => $userrolehash{$entry} },
1.349 www 1739: $rudom,$runame) eq 'ok') {
1740: delete $userrolehash{$entry};
1741: }
1742: }
1.662 raeburn 1743: #
1744: # Reverse lookup of domain roles (dc, ad, li, sc, au)
1745: #
1746: my %domrolebuffer = ();
1747: foreach my $entry (keys %domainrolehash) {
1748: my ($role,$uname,$udom,$runame,$rudom,$rsec)=split/:/,$entry;
1749: if ($domrolebuffer{$rudom}) {
1750: $domrolebuffer{$rudom}.='&'.&escape($entry).
1751: '='.&escape($domainrolehash{$entry});
1752: } else {
1753: $domrolebuffer{$rudom}.=&escape($entry).
1754: '='.&escape($domainrolehash{$entry});
1755: }
1756: delete $domainrolehash{$entry};
1757: }
1758: foreach my $dom (keys(%domrolebuffer)) {
1759: foreach my $tryserver (keys %libserv) {
1760: if ($hostdom{$tryserver} eq $dom) {
1761: unless (&reply('domroleput:'.$dom.':'.
1762: $domrolebuffer{$dom},$tryserver) eq 'ok') {
1763: &logthis('Put of domain roles failed for '.$dom.' and '.$tryserver);
1764: }
1765: }
1766: }
1767: }
1.186 www 1768: $dumpcount++;
1.157 www 1769: }
1770:
1771: sub courselog {
1772: my $what=shift;
1.158 www 1773: $what=time.':'.$what;
1.620 albertel 1774: unless ($env{'request.course.id'}) { return ''; }
1775: $coursedombuf{$env{'request.course.id'}}=
1776: $env{'course.'.$env{'request.course.id'}.'.domain'};
1777: $coursenumbuf{$env{'request.course.id'}}=
1778: $env{'course.'.$env{'request.course.id'}.'.num'};
1779: $coursehombuf{$env{'request.course.id'}}=
1780: $env{'course.'.$env{'request.course.id'}.'.home'};
1781: $coursedescrbuf{$env{'request.course.id'}}=
1782: $env{'course.'.$env{'request.course.id'}.'.description'};
1783: $courseinstcodebuf{$env{'request.course.id'}}=
1784: $env{'course.'.$env{'request.course.id'}.'.internal.coursecode'};
1785: $courseownerbuf{$env{'request.course.id'}}=
1786: $env{'course.'.$env{'request.course.id'}.'.internal.courseowner'};
1.741 raeburn 1787: $coursetypebuf{$env{'request.course.id'}}=
1788: $env{'course.'.$env{'request.course.id'}.'.type'};
1.620 albertel 1789: if (defined $courselogs{$env{'request.course.id'}}) {
1790: $courselogs{$env{'request.course.id'}}.='&'.$what;
1.157 www 1791: } else {
1.620 albertel 1792: $courselogs{$env{'request.course.id'}}.=$what;
1.157 www 1793: }
1.620 albertel 1794: if (length($courselogs{$env{'request.course.id'}})>4048) {
1.157 www 1795: &flushcourselogs();
1796: }
1.158 www 1797: }
1798:
1799: sub courseacclog {
1800: my $fnsymb=shift;
1.620 albertel 1801: unless ($env{'request.course.id'}) { return ''; }
1802: my $what=$fnsymb.':'.$env{'user.name'}.':'.$env{'user.domain'};
1.657 albertel 1803: if ($fnsymb=~/(problem|exam|quiz|assess|survey|form|task|page)$/) {
1.187 www 1804: $what.=':POST';
1.583 matthew 1805: # FIXME: Probably ought to escape things....
1.620 albertel 1806: foreach (keys %env) {
1.158 www 1807: if ($_=~/^form\.(.*)/) {
1.620 albertel 1808: $what.=':'.$1.'='.$env{$_};
1.158 www 1809: }
1.191 harris41 1810: }
1.583 matthew 1811: } elsif ($fnsymb =~ m:^/adm/searchcat:) {
1812: # FIXME: We should not be depending on a form parameter that someone
1813: # editing lonsearchcat.pm might change in the future.
1.620 albertel 1814: if ($env{'form.phase'} eq 'course_search') {
1.583 matthew 1815: $what.= ':POST';
1816: # FIXME: Probably ought to escape things....
1817: foreach my $element ('courseexp','crsfulltext','crsrelated',
1818: 'crsdiscuss') {
1.620 albertel 1819: $what.=':'.$element.'='.$env{'form.'.$element};
1.583 matthew 1820: }
1821: }
1.158 www 1822: }
1823: &courselog($what);
1.149 www 1824: }
1825:
1.185 www 1826: sub countacc {
1827: my $url=&declutter(shift);
1.458 matthew 1828: return if (! defined($url) || $url eq '');
1.620 albertel 1829: unless ($env{'request.course.id'}) { return ''; }
1830: $accesshash{$env{'request.course.id'}.'___'.$url.'___course'}=1;
1.281 www 1831: my $key=$$.$processmarker.'_'.$dumpcount.'___'.$url.'___count';
1.450 matthew 1832: $accesshash{$key}++;
1.185 www 1833: }
1.349 www 1834:
1.361 www 1835: sub linklog {
1836: my ($from,$to)=@_;
1837: $from=&declutter($from);
1838: $to=&declutter($to);
1839: $accesshash{$from.'___'.$to.'___comefrom'}=1;
1840: $accesshash{$to.'___'.$from.'___goto'}=1;
1841: }
1842:
1.349 www 1843: sub userrolelog {
1844: my ($trole,$username,$domain,$area,$tstart,$tend)=@_;
1.661 raeburn 1845: if (($trole=~/^ca/) || ($trole=~/^aa/) ||
1.662 raeburn 1846: ($trole=~/^in/) || ($trole=~/^cc/) ||
1.661 raeburn 1847: ($trole=~/^ep/) || ($trole=~/^cr/) ||
1848: ($trole=~/^ta/)) {
1.350 www 1849: my (undef,$rudom,$runame,$rsec)=split(/\//,$area);
1850: $userrolehash
1851: {$trole.':'.$username.':'.$domain.':'.$runame.':'.$rudom.':'.$rsec}
1.349 www 1852: =$tend.':'.$tstart;
1.662 raeburn 1853: }
1854: if (($trole=~/^dc/) || ($trole=~/^ad/) ||
1855: ($trole=~/^li/) || ($trole=~/^li/) ||
1856: ($trole=~/^au/) || ($trole=~/^dg/) ||
1857: ($trole=~/^sc/)) {
1858: my (undef,$rudom,$runame,$rsec)=split(/\//,$area);
1859: $domainrolehash
1860: {$trole.':'.$username.':'.$domain.':'.$runame.':'.$rudom.':'.$rsec}
1861: = $tend.':'.$tstart;
1862: }
1.351 www 1863: }
1864:
1865: sub get_course_adv_roles {
1866: my $cid=shift;
1.620 albertel 1867: $cid=$env{'request.course.id'} unless (defined($cid));
1.351 www 1868: my %coursehash=&coursedescription($cid);
1.470 www 1869: my %nothide=();
1870: foreach (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
1871: $nothide{join(':',split(/[\@\:]/,$_))}=1;
1872: }
1.351 www 1873: my %returnhash=();
1874: my %dumphash=
1875: &dump('nohist_userroles',$coursehash{'domain'},$coursehash{'num'});
1876: my $now=time;
1877: foreach (keys %dumphash) {
1878: my ($tend,$tstart)=split(/\:/,$dumphash{$_});
1879: if (($tstart) && ($tstart<0)) { next; }
1880: if (($tend) && ($tend<$now)) { next; }
1881: if (($tstart) && ($now<$tstart)) { next; }
1882: my ($role,$username,$domain,$section)=split(/\:/,$_);
1.576 albertel 1883: if ($username eq '' || $domain eq '') { next; }
1.470 www 1884: if ((&privileged($username,$domain)) &&
1885: (!$nothide{$username.':'.$domain})) { next; }
1.656 albertel 1886: if ($role eq 'cr') { next; }
1.351 www 1887: my $key=&plaintext($role);
1.656 albertel 1888: if ($role =~ /^cr/) {
1889: $key=(split('/',$role))[3];
1890: }
1.351 www 1891: if ($section) { $key.=' (Sec/Grp '.$section.')'; }
1892: if ($returnhash{$key}) {
1893: $returnhash{$key}.=','.$username.':'.$domain;
1894: } else {
1895: $returnhash{$key}=$username.':'.$domain;
1896: }
1.400 www 1897: }
1898: return %returnhash;
1899: }
1900:
1901: sub get_my_roles {
1902: my ($uname,$udom)=@_;
1.620 albertel 1903: unless (defined($uname)) { $uname=$env{'user.name'}; }
1904: unless (defined($udom)) { $udom=$env{'user.domain'}; }
1.400 www 1905: my %dumphash=
1906: &dump('nohist_userroles',$udom,$uname);
1907: my %returnhash=();
1908: my $now=time;
1909: foreach (keys %dumphash) {
1910: my ($tend,$tstart)=split(/\:/,$dumphash{$_});
1911: if (($tstart) && ($tstart<0)) { next; }
1912: if (($tend) && ($tend<$now)) { next; }
1913: if (($tstart) && ($now<$tstart)) { next; }
1914: my ($role,$username,$domain,$section)=split(/\:/,$_);
1915: $returnhash{$username.':'.$domain.':'.$role}=$tstart.':'.$tend;
1.373 www 1916: }
1917: return %returnhash;
1.399 www 1918: }
1919:
1920: # ----------------------------------------------------- Frontpage Announcements
1921: #
1922: #
1923:
1924: sub postannounce {
1925: my ($server,$text)=@_;
1926: unless (&allowed('psa',$hostdom{$server})) { return 'refused'; }
1927: unless ($text=~/\w/) { $text=''; }
1928: return &reply('setannounce:'.&escape($text),$server);
1929: }
1930:
1931: sub getannounce {
1.448 albertel 1932:
1933: if (open(my $fh,$perlvar{'lonDocRoot'}.'/announcement.txt')) {
1.399 www 1934: my $announcement='';
1935: while (<$fh>) { $announcement .=$_; }
1.448 albertel 1936: close($fh);
1.399 www 1937: if ($announcement=~/\w/) {
1938: return
1939: '<table bgcolor="#FF5555" cellpadding="5" cellspacing="3">'.
1.518 albertel 1940: '<tr><td bgcolor="#FFFFFF"><tt>'.$announcement.'</tt></td></tr></table>';
1.399 www 1941: } else {
1942: return '';
1943: }
1944: } else {
1945: return '';
1946: }
1.351 www 1947: }
1.353 www 1948:
1949: # ---------------------------------------------------------- Course ID routines
1950: # Deal with domain's nohist_courseid.db files
1951: #
1952:
1953: sub courseidput {
1954: my ($domain,$what,$coursehome)=@_;
1955: return &reply('courseidput:'.$domain.':'.$what,$coursehome);
1956: }
1957:
1958: sub courseiddump {
1.741 raeburn 1959: my ($domfilter,$descfilter,$sincefilter,$instcodefilter,$ownerfilter,$coursefilter,$hostidflag,$hostidref,$typefilter)=@_;
1.353 www 1960: my %returnhash=();
1.355 www 1961: unless ($domfilter) { $domfilter=''; }
1.353 www 1962: foreach my $tryserver (keys %libserv) {
1.511 raeburn 1963: if ( ($hostidflag == 1 && grep/^$tryserver$/,@{$hostidref}) || (!defined($hostidflag)) ) {
1.506 raeburn 1964: if ((!$domfilter) || ($hostdom{$tryserver} eq $domfilter)) {
1965: foreach (
1966: split(/\&/,&reply('courseiddump:'.$hostdom{$tryserver}.':'.
1.571 raeburn 1967: $sincefilter.':'.&escape($descfilter).':'.
1.741 raeburn 1968: &escape($instcodefilter).':'.&escape($ownerfilter).':'.&escape($coursefilter).':'.&escape($typefilter),
1.354 www 1969: $tryserver))) {
1.506 raeburn 1970: my ($key,$value)=split(/\=/,$_);
1971: if (($key) && ($value)) {
1.516 raeburn 1972: $returnhash{&unescape($key)}=$value;
1.506 raeburn 1973: }
1.353 www 1974: }
1975: }
1976: }
1977: }
1978: return %returnhash;
1979: }
1980:
1.658 raeburn 1981: # ---------------------------------------------------------- DC e-mail
1.662 raeburn 1982:
1983: sub dcmailput {
1.685 raeburn 1984: my ($domain,$msgid,$message,$server)=@_;
1.662 raeburn 1985: my $status = &Apache::lonnet::critical(
1.740 www 1986: 'dcmailput:'.$domain.':'.&escape($msgid).'='.
1987: &escape($message),$server);
1.662 raeburn 1988: return $status;
1989: }
1990:
1.658 raeburn 1991: sub dcmaildump {
1992: my ($dom,$startdate,$enddate,$senders) = @_;
1.685 raeburn 1993: my %returnhash=();
1994: if (exists($domain_primary{$dom})) {
1995: my $cmd='dcmaildump:'.$dom.':'.&escape($startdate).':'.
1996: &escape($enddate).':';
1997: my @esc_senders=map { &escape($_)} @$senders;
1998: $cmd.=&escape(join('&',@esc_senders));
1999: foreach (split(/\&/,&reply($cmd,$domain_primary{$dom}))) {
2000: my ($key,$value) = split(/\=/,$_);
2001: if (($key) && ($value)) {
2002: $returnhash{&unescape($key)} = &unescape($value);
1.658 raeburn 2003: }
2004: }
2005: }
2006: return %returnhash;
2007: }
1.662 raeburn 2008: # ---------------------------------------------------------- Domain roles
2009:
2010: sub get_domain_roles {
2011: my ($dom,$roles,$startdate,$enddate)=@_;
2012: if (undef($startdate) || $startdate eq '') {
2013: $startdate = '.';
2014: }
2015: if (undef($enddate) || $enddate eq '') {
2016: $enddate = '.';
2017: }
2018: my $rolelist = join(':',@{$roles});
2019: my %personnel = ();
2020: foreach my $tryserver (keys(%libserv)) {
2021: if ($hostdom{$tryserver} eq $dom) {
2022: %{$personnel{$tryserver}}=();
2023: foreach (
2024: split(/\&/,&reply('domrolesdump:'.$dom.':'.
2025: &escape($startdate).':'.&escape($enddate).':'.
2026: &escape($rolelist), $tryserver))) {
2027: my($key,$value) = split(/\=/,$_);
2028: if (($key) && ($value)) {
2029: $personnel{$tryserver}{&unescape($key)} = &unescape($value);
2030: }
2031: }
2032: }
2033: }
2034: return %personnel;
2035: }
1.658 raeburn 2036:
1.149 www 2037: # ----------------------------------------------------------- Check out an item
2038:
1.504 albertel 2039: sub get_first_access {
2040: my ($type,$argsymb)=@_;
2041: my ($symb,$courseid,$udom,$uname)=&Apache::lonxml::whichuser();
2042: if ($argsymb) { $symb=$argsymb; }
2043: my ($map,$id,$res)=&decode_symb($symb);
1.588 albertel 2044: if ($type eq 'map') {
2045: $res=&symbread($map);
2046: } else {
2047: $res=$symb;
2048: }
2049: my %times=&get('firstaccesstimes',["$courseid\0$res"],$udom,$uname);
2050: return $times{"$courseid\0$res"};
1.504 albertel 2051: }
2052:
2053: sub set_first_access {
2054: my ($type)=@_;
2055: my ($symb,$courseid,$udom,$uname)=&Apache::lonxml::whichuser();
2056: my ($map,$id,$res)=&decode_symb($symb);
1.588 albertel 2057: if ($type eq 'map') {
2058: $res=&symbread($map);
2059: } else {
2060: $res=$symb;
2061: }
2062: my $firstaccess=&get_first_access($type,$symb);
1.505 albertel 2063: if (!$firstaccess) {
1.588 albertel 2064: return &put('firstaccesstimes',{"$courseid\0$res"=>time},$udom,$uname);
1.505 albertel 2065: }
2066: return 'already_set';
1.504 albertel 2067: }
2068:
1.149 www 2069: sub checkout {
2070: my ($symb,$tuname,$tudom,$tcrsid)=@_;
2071: my $now=time;
2072: my $lonhost=$perlvar{'lonHostID'};
2073: my $infostr=&escape(
1.234 www 2074: 'CHECKOUTTOKEN&'.
1.149 www 2075: $tuname.'&'.
2076: $tudom.'&'.
2077: $tcrsid.'&'.
2078: $symb.'&'.
2079: $now.'&'.$ENV{'REMOTE_ADDR'});
2080: my $token=&reply('tmpput:'.$infostr,$lonhost);
1.151 www 2081: if ($token=~/^error\:/) {
1.672 albertel 2082: &logthis("<font color=\"blue\">WARNING: ".
1.151 www 2083: "Checkout tmpput failed ".$tudom.' - '.$tuname.' - '.$symb.
2084: "</font>");
2085: return '';
2086: }
2087:
1.149 www 2088: $token=~s/^(\d+)\_.*\_(\d+)$/$1\*$2\*$lonhost/;
2089: $token=~tr/a-z/A-Z/;
2090:
1.153 www 2091: my %infohash=('resource.0.outtoken' => $token,
2092: 'resource.0.checkouttime' => $now,
2093: 'resource.0.outremote' => $ENV{'REMOTE_ADDR'});
1.149 www 2094:
2095: unless (&cstore(\%infohash,$symb,$tcrsid,$tudom,$tuname) eq 'ok') {
2096: return '';
1.151 www 2097: } else {
1.672 albertel 2098: &logthis("<font color=\"blue\">WARNING: ".
1.151 www 2099: "Checkout cstore failed ".$tudom.' - '.$tuname.' - '.$symb.
2100: "</font>");
1.149 www 2101: }
2102:
2103: if (&log($tudom,$tuname,&homeserver($tuname,$tudom),
2104: &escape('Checkout '.$infostr.' - '.
2105: $token)) ne 'ok') {
2106: return '';
1.151 www 2107: } else {
1.672 albertel 2108: &logthis("<font color=\"blue\">WARNING: ".
1.151 www 2109: "Checkout log failed ".$tudom.' - '.$tuname.' - '.$symb.
2110: "</font>");
1.149 www 2111: }
1.151 www 2112: return $token;
1.149 www 2113: }
2114:
2115: # ------------------------------------------------------------ Check in an item
2116:
2117: sub checkin {
2118: my $token=shift;
1.150 www 2119: my $now=time;
2120: my ($ta,$tb,$lonhost)=split(/\*/,$token);
2121: $lonhost=~tr/A-Z/a-z/;
1.595 albertel 2122: my $dtoken=$ta.'_'.$hostname{$lonhost}.'_'.$tb;
1.150 www 2123: $dtoken=~s/\W/\_/g;
1.234 www 2124: my ($dummy,$tuname,$tudom,$tcrsid,$symb,$chtim,$rmaddr)=
1.150 www 2125: split(/\&/,&unescape(&reply('tmpget:'.$dtoken,$lonhost)));
2126:
1.154 www 2127: unless (($tuname) && ($tudom)) {
2128: &logthis('Check in '.$token.' ('.$dtoken.') failed');
2129: return '';
2130: }
2131:
2132: unless (&allowed('mgr',$tcrsid)) {
2133: &logthis('Check in '.$token.' ('.$dtoken.') unauthorized: '.
1.620 albertel 2134: $env{'user.name'}.' - '.$env{'user.domain'});
1.154 www 2135: return '';
2136: }
2137:
1.153 www 2138: my %infohash=('resource.0.intoken' => $token,
2139: 'resource.0.checkintime' => $now,
2140: 'resource.0.inremote' => $ENV{'REMOTE_ADDR'});
1.150 www 2141:
2142: unless (&cstore(\%infohash,$symb,$tcrsid,$tudom,$tuname) eq 'ok') {
2143: return '';
2144: }
2145:
2146: if (&log($tudom,$tuname,&homeserver($tuname,$tudom),
2147: &escape('Checkin - '.$token)) ne 'ok') {
2148: return '';
2149: }
2150:
2151: return ($symb,$tuname,$tudom,$tcrsid);
1.110 www 2152: }
2153:
2154: # --------------------------------------------- Set Expire Date for Spreadsheet
2155:
2156: sub expirespread {
2157: my ($uname,$udom,$stype,$usymb)=@_;
1.620 albertel 2158: my $cid=$env{'request.course.id'};
1.110 www 2159: if ($cid) {
2160: my $now=time;
2161: my $key=$uname.':'.$udom.':'.$stype.':'.$usymb;
1.620 albertel 2162: return &reply('put:'.$env{'course.'.$cid.'.domain'}.':'.
2163: $env{'course.'.$cid.'.num'}.
1.110 www 2164: ':nohist_expirationdates:'.
2165: &escape($key).'='.$now,
1.620 albertel 2166: $env{'course.'.$cid.'.home'})
1.110 www 2167: }
2168: return 'ok';
1.14 www 2169: }
2170:
1.109 www 2171: # ----------------------------------------------------- Devalidate Spreadsheets
2172:
2173: sub devalidate {
1.325 www 2174: my ($symb,$uname,$udom)=@_;
1.620 albertel 2175: my $cid=$env{'request.course.id'};
1.109 www 2176: if ($cid) {
1.391 matthew 2177: # delete the stored spreadsheets for
2178: # - the student level sheet of this user in course's homespace
2179: # - the assessment level sheet for this resource
2180: # for this user in user's homespace
1.553 albertel 2181: # - current conditional state info
1.325 www 2182: my $key=$uname.':'.$udom.':';
1.109 www 2183: my $status=
1.299 matthew 2184: &del('nohist_calculatedsheets',
1.391 matthew 2185: [$key.'studentcalc:'],
1.620 albertel 2186: $env{'course.'.$cid.'.domain'},
2187: $env{'course.'.$cid.'.num'})
1.133 albertel 2188: .' '.
2189: &del('nohist_calculatedsheets_'.$cid,
1.391 matthew 2190: [$key.'assesscalc:'.$symb],$udom,$uname);
1.109 www 2191: unless ($status eq 'ok ok') {
2192: &logthis('Could not devalidate spreadsheet '.
1.325 www 2193: $uname.' at '.$udom.' for '.
1.109 www 2194: $symb.': '.$status);
1.133 albertel 2195: }
1.553 albertel 2196: &delenv('user.state.'.$cid);
1.109 www 2197: }
2198: }
2199:
1.265 albertel 2200: sub get_scalar {
2201: my ($string,$end) = @_;
2202: my $value;
2203: if ($$string =~ s/^([^&]*?)($end)/$2/) {
2204: $value = $1;
2205: } elsif ($$string =~ s/^([^&]*?)&//) {
2206: $value = $1;
2207: }
2208: return &unescape($value);
2209: }
2210:
2211: sub array2str {
2212: my (@array) = @_;
2213: my $result=&arrayref2str(\@array);
2214: $result=~s/^__ARRAY_REF__//;
2215: $result=~s/__END_ARRAY_REF__$//;
2216: return $result;
2217: }
2218:
1.204 albertel 2219: sub arrayref2str {
2220: my ($arrayref) = @_;
1.265 albertel 2221: my $result='__ARRAY_REF__';
1.204 albertel 2222: foreach my $elem (@$arrayref) {
1.265 albertel 2223: if(ref($elem) eq 'ARRAY') {
2224: $result.=&arrayref2str($elem).'&';
2225: } elsif(ref($elem) eq 'HASH') {
2226: $result.=&hashref2str($elem).'&';
2227: } elsif(ref($elem)) {
2228: #print("Got a ref of ".(ref($elem))." skipping.");
1.204 albertel 2229: } else {
2230: $result.=&escape($elem).'&';
2231: }
2232: }
2233: $result=~s/\&$//;
1.265 albertel 2234: $result .= '__END_ARRAY_REF__';
1.204 albertel 2235: return $result;
2236: }
2237:
1.168 albertel 2238: sub hash2str {
1.204 albertel 2239: my (%hash) = @_;
2240: my $result=&hashref2str(\%hash);
1.265 albertel 2241: $result=~s/^__HASH_REF__//;
2242: $result=~s/__END_HASH_REF__$//;
1.204 albertel 2243: return $result;
2244: }
2245:
2246: sub hashref2str {
2247: my ($hashref)=@_;
1.265 albertel 2248: my $result='__HASH_REF__';
1.495 albertel 2249: foreach (sort(keys(%$hashref))) {
1.204 albertel 2250: if (ref($_) eq 'ARRAY') {
1.265 albertel 2251: $result.=&arrayref2str($_).'=';
1.204 albertel 2252: } elsif (ref($_) eq 'HASH') {
1.265 albertel 2253: $result.=&hashref2str($_).'=';
1.204 albertel 2254: } elsif (ref($_)) {
1.265 albertel 2255: $result.='=';
2256: #print("Got a ref of ".(ref($_))." skipping.");
1.204 albertel 2257: } else {
1.265 albertel 2258: if ($_) {$result.=&escape($_).'=';} else { last; }
1.204 albertel 2259: }
2260:
1.265 albertel 2261: if(ref($hashref->{$_}) eq 'ARRAY') {
2262: $result.=&arrayref2str($hashref->{$_}).'&';
2263: } elsif(ref($hashref->{$_}) eq 'HASH') {
2264: $result.=&hashref2str($hashref->{$_}).'&';
2265: } elsif(ref($hashref->{$_})) {
2266: $result.='&';
2267: #print("Got a ref of ".(ref($hashref->{$_}))." skipping.");
1.204 albertel 2268: } else {
1.265 albertel 2269: $result.=&escape($hashref->{$_}).'&';
1.204 albertel 2270: }
2271: }
1.168 albertel 2272: $result=~s/\&$//;
1.265 albertel 2273: $result .= '__END_HASH_REF__';
1.168 albertel 2274: return $result;
2275: }
2276:
2277: sub str2hash {
1.265 albertel 2278: my ($string)=@_;
2279: my ($hash)=&str2hashref('__HASH_REF__'.$string.'__END_HASH_REF__');
2280: return %$hash;
2281: }
2282:
2283: sub str2hashref {
1.168 albertel 2284: my ($string) = @_;
1.265 albertel 2285:
2286: my %hash;
2287:
2288: if($string !~ /^__HASH_REF__/) {
2289: if (! ($string eq '' || !defined($string))) {
2290: $hash{'error'}='Not hash reference';
2291: }
2292: return (\%hash, $string);
2293: }
2294:
2295: $string =~ s/^__HASH_REF__//;
2296:
2297: while($string !~ /^__END_HASH_REF__/) {
2298: #key
2299: my $key='';
2300: if($string =~ /^__HASH_REF__/) {
2301: ($key, $string)=&str2hashref($string);
2302: if(defined($key->{'error'})) {
2303: $hash{'error'}='Bad data';
2304: return (\%hash, $string);
2305: }
2306: } elsif($string =~ /^__ARRAY_REF__/) {
2307: ($key, $string)=&str2arrayref($string);
2308: if($key->[0] eq 'Array reference error') {
2309: $hash{'error'}='Bad data';
2310: return (\%hash, $string);
2311: }
2312: } else {
2313: $string =~ s/^(.*?)=//;
1.267 albertel 2314: $key=&unescape($1);
1.265 albertel 2315: }
2316: $string =~ s/^=//;
2317:
2318: #value
2319: my $value='';
2320: if($string =~ /^__HASH_REF__/) {
2321: ($value, $string)=&str2hashref($string);
2322: if(defined($value->{'error'})) {
2323: $hash{'error'}='Bad data';
2324: return (\%hash, $string);
2325: }
2326: } elsif($string =~ /^__ARRAY_REF__/) {
2327: ($value, $string)=&str2arrayref($string);
2328: if($value->[0] eq 'Array reference error') {
2329: $hash{'error'}='Bad data';
2330: return (\%hash, $string);
2331: }
2332: } else {
2333: $value=&get_scalar(\$string,'__END_HASH_REF__');
2334: }
2335: $string =~ s/^&//;
2336:
2337: $hash{$key}=$value;
1.204 albertel 2338: }
1.265 albertel 2339:
2340: $string =~ s/^__END_HASH_REF__//;
2341:
2342: return (\%hash, $string);
1.204 albertel 2343: }
2344:
2345: sub str2array {
1.265 albertel 2346: my ($string)=@_;
2347: my ($array)=&str2arrayref('__ARRAY_REF__'.$string.'__END_ARRAY_REF__');
2348: return @$array;
2349: }
2350:
2351: sub str2arrayref {
1.204 albertel 2352: my ($string) = @_;
1.265 albertel 2353: my @array;
2354:
2355: if($string !~ /^__ARRAY_REF__/) {
2356: if (! ($string eq '' || !defined($string))) {
2357: $array[0]='Array reference error';
2358: }
2359: return (\@array, $string);
2360: }
2361:
2362: $string =~ s/^__ARRAY_REF__//;
2363:
2364: while($string !~ /^__END_ARRAY_REF__/) {
2365: my $value='';
2366: if($string =~ /^__HASH_REF__/) {
2367: ($value, $string)=&str2hashref($string);
2368: if(defined($value->{'error'})) {
2369: $array[0] ='Array reference error';
2370: return (\@array, $string);
2371: }
2372: } elsif($string =~ /^__ARRAY_REF__/) {
2373: ($value, $string)=&str2arrayref($string);
2374: if($value->[0] eq 'Array reference error') {
2375: $array[0] ='Array reference error';
2376: return (\@array, $string);
2377: }
2378: } else {
2379: $value=&get_scalar(\$string,'__END_ARRAY_REF__');
2380: }
2381: $string =~ s/^&//;
2382:
2383: push(@array, $value);
1.191 harris41 2384: }
1.265 albertel 2385:
2386: $string =~ s/^__END_ARRAY_REF__//;
2387:
2388: return (\@array, $string);
1.168 albertel 2389: }
2390:
1.167 albertel 2391: # -------------------------------------------------------------------Temp Store
2392:
1.168 albertel 2393: sub tmpreset {
2394: my ($symb,$namespace,$domain,$stuname) = @_;
2395: if (!$symb) {
2396: $symb=&symbread();
1.620 albertel 2397: if (!$symb) { $symb= $env{'request.url'}; }
1.168 albertel 2398: }
2399: $symb=escape($symb);
2400:
1.620 albertel 2401: if (!$namespace) { $namespace=$env{'request.state'}; }
1.168 albertel 2402: $namespace=~s/\//\_/g;
2403: $namespace=~s/\W//g;
2404:
1.620 albertel 2405: if (!$domain) { $domain=$env{'user.domain'}; }
2406: if (!$stuname) { $stuname=$env{'user.name'}; }
1.591 albertel 2407: if ($domain eq 'public' && $stuname eq 'public') {
2408: $stuname=$ENV{'REMOTE_ADDR'};
2409: }
1.168 albertel 2410: my $path=$perlvar{'lonDaemons'}.'/tmp';
2411: my %hash;
2412: if (tie(%hash,'GDBM_File',
2413: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
1.256 albertel 2414: &GDBM_WRCREAT(),0640)) {
1.168 albertel 2415: foreach my $key (keys %hash) {
1.180 albertel 2416: if ($key=~ /:$symb/) {
1.168 albertel 2417: delete($hash{$key});
2418: }
2419: }
2420: }
2421: }
2422:
1.167 albertel 2423: sub tmpstore {
1.168 albertel 2424: my ($storehash,$symb,$namespace,$domain,$stuname) = @_;
2425:
2426: if (!$symb) {
2427: $symb=&symbread();
1.620 albertel 2428: if (!$symb) { $symb= $env{'request.url'}; }
1.168 albertel 2429: }
2430: $symb=escape($symb);
2431:
2432: if (!$namespace) {
2433: # I don't think we would ever want to store this for a course.
2434: # it seems this will only be used if we don't have a course.
1.620 albertel 2435: #$namespace=$env{'request.course.id'};
1.168 albertel 2436: #if (!$namespace) {
1.620 albertel 2437: $namespace=$env{'request.state'};
1.168 albertel 2438: #}
2439: }
2440: $namespace=~s/\//\_/g;
2441: $namespace=~s/\W//g;
1.620 albertel 2442: if (!$domain) { $domain=$env{'user.domain'}; }
2443: if (!$stuname) { $stuname=$env{'user.name'}; }
1.591 albertel 2444: if ($domain eq 'public' && $stuname eq 'public') {
2445: $stuname=$ENV{'REMOTE_ADDR'};
2446: }
1.168 albertel 2447: my $now=time;
2448: my %hash;
2449: my $path=$perlvar{'lonDaemons'}.'/tmp';
2450: if (tie(%hash,'GDBM_File',
2451: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
1.256 albertel 2452: &GDBM_WRCREAT(),0640)) {
1.168 albertel 2453: $hash{"version:$symb"}++;
2454: my $version=$hash{"version:$symb"};
2455: my $allkeys='';
2456: foreach my $key (keys(%$storehash)) {
2457: $allkeys.=$key.':';
1.591 albertel 2458: $hash{"$version:$symb:$key"}=&freeze_escape($$storehash{$key});
1.168 albertel 2459: }
2460: $hash{"$version:$symb:timestamp"}=$now;
2461: $allkeys.='timestamp';
2462: $hash{"$version:keys:$symb"}=$allkeys;
2463: if (untie(%hash)) {
2464: return 'ok';
2465: } else {
2466: return "error:$!";
2467: }
2468: } else {
2469: return "error:$!";
2470: }
2471: }
1.167 albertel 2472:
1.168 albertel 2473: # -----------------------------------------------------------------Temp Restore
1.167 albertel 2474:
1.168 albertel 2475: sub tmprestore {
2476: my ($symb,$namespace,$domain,$stuname) = @_;
1.167 albertel 2477:
1.168 albertel 2478: if (!$symb) {
2479: $symb=&symbread();
1.620 albertel 2480: if (!$symb) { $symb= $env{'request.url'}; }
1.168 albertel 2481: }
2482: $symb=escape($symb);
2483:
1.620 albertel 2484: if (!$namespace) { $namespace=$env{'request.state'}; }
1.591 albertel 2485:
1.620 albertel 2486: if (!$domain) { $domain=$env{'user.domain'}; }
2487: if (!$stuname) { $stuname=$env{'user.name'}; }
1.591 albertel 2488: if ($domain eq 'public' && $stuname eq 'public') {
2489: $stuname=$ENV{'REMOTE_ADDR'};
2490: }
1.168 albertel 2491: my %returnhash;
2492: $namespace=~s/\//\_/g;
2493: $namespace=~s/\W//g;
2494: my %hash;
2495: my $path=$perlvar{'lonDaemons'}.'/tmp';
2496: if (tie(%hash,'GDBM_File',
2497: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
1.256 albertel 2498: &GDBM_READER(),0640)) {
1.168 albertel 2499: my $version=$hash{"version:$symb"};
2500: $returnhash{'version'}=$version;
2501: my $scope;
2502: for ($scope=1;$scope<=$version;$scope++) {
2503: my $vkeys=$hash{"$scope:keys:$symb"};
2504: my @keys=split(/:/,$vkeys);
2505: my $key;
2506: $returnhash{"$scope:keys"}=$vkeys;
2507: foreach $key (@keys) {
1.591 albertel 2508: $returnhash{"$scope:$key"}=&thaw_unescape($hash{"$scope:$symb:$key"});
2509: $returnhash{"$key"}=&thaw_unescape($hash{"$scope:$symb:$key"});
1.167 albertel 2510: }
2511: }
1.168 albertel 2512: if (!(untie(%hash))) {
2513: return "error:$!";
2514: }
2515: } else {
2516: return "error:$!";
2517: }
2518: return %returnhash;
1.167 albertel 2519: }
2520:
1.9 www 2521: # ----------------------------------------------------------------------- Store
2522:
2523: sub store {
1.124 www 2524: my ($storehash,$symb,$namespace,$domain,$stuname) = @_;
2525: my $home='';
2526:
1.168 albertel 2527: if ($stuname) { $home=&homeserver($stuname,$domain); }
1.124 www 2528:
1.213 www 2529: $symb=&symbclean($symb);
1.122 albertel 2530: if (!$symb) { unless ($symb=&symbread()) { return ''; } }
1.109 www 2531:
1.620 albertel 2532: if (!$domain) { $domain=$env{'user.domain'}; }
2533: if (!$stuname) { $stuname=$env{'user.name'}; }
1.325 www 2534:
2535: &devalidate($symb,$stuname,$domain);
1.109 www 2536:
2537: $symb=escape($symb);
1.187 www 2538: if (!$namespace) {
1.620 albertel 2539: unless ($namespace=$env{'request.course.id'}) {
1.187 www 2540: return '';
2541: }
2542: }
1.620 albertel 2543: if (!$home) { $home=$env{'user.home'}; }
1.447 www 2544:
2545: $$storehash{'ip'}=$ENV{'REMOTE_ADDR'};
2546: $$storehash{'host'}=$perlvar{'lonHostID'};
2547:
1.12 www 2548: my $namevalue='';
1.191 harris41 2549: foreach (keys %$storehash) {
1.591 albertel 2550: $namevalue.=&escape($_).'='.&freeze_escape($$storehash{$_}).'&';
1.191 harris41 2551: }
1.12 www 2552: $namevalue=~s/\&$//;
1.187 www 2553: &courselog($symb.':'.$stuname.':'.$domain.':STORE:'.$namevalue);
1.124 www 2554: return reply("store:$domain:$stuname:$namespace:$symb:$namevalue","$home");
1.9 www 2555: }
2556:
1.47 www 2557: # -------------------------------------------------------------- Critical Store
2558:
2559: sub cstore {
1.124 www 2560: my ($storehash,$symb,$namespace,$domain,$stuname) = @_;
2561: my $home='';
2562:
1.168 albertel 2563: if ($stuname) { $home=&homeserver($stuname,$domain); }
1.124 www 2564:
1.213 www 2565: $symb=&symbclean($symb);
1.122 albertel 2566: if (!$symb) { unless ($symb=&symbread()) { return ''; } }
1.109 www 2567:
1.620 albertel 2568: if (!$domain) { $domain=$env{'user.domain'}; }
2569: if (!$stuname) { $stuname=$env{'user.name'}; }
1.325 www 2570:
2571: &devalidate($symb,$stuname,$domain);
1.109 www 2572:
2573: $symb=escape($symb);
1.187 www 2574: if (!$namespace) {
1.620 albertel 2575: unless ($namespace=$env{'request.course.id'}) {
1.187 www 2576: return '';
2577: }
2578: }
1.620 albertel 2579: if (!$home) { $home=$env{'user.home'}; }
1.447 www 2580:
2581: $$storehash{'ip'}=$ENV{'REMOTE_ADDR'};
2582: $$storehash{'host'}=$perlvar{'lonHostID'};
1.122 albertel 2583:
1.47 www 2584: my $namevalue='';
1.191 harris41 2585: foreach (keys %$storehash) {
1.591 albertel 2586: $namevalue.=&escape($_).'='.&freeze_escape($$storehash{$_}).'&';
1.191 harris41 2587: }
1.47 www 2588: $namevalue=~s/\&$//;
1.187 www 2589: &courselog($symb.':'.$stuname.':'.$domain.':CSTORE:'.$namevalue);
1.188 www 2590: return critical
2591: ("store:$domain:$stuname:$namespace:$symb:$namevalue","$home");
1.47 www 2592: }
2593:
1.9 www 2594: # --------------------------------------------------------------------- Restore
2595:
2596: sub restore {
1.124 www 2597: my ($symb,$namespace,$domain,$stuname) = @_;
2598: my $home='';
2599:
1.168 albertel 2600: if ($stuname) { $home=&homeserver($stuname,$domain); }
1.124 www 2601:
1.122 albertel 2602: if (!$symb) {
2603: unless ($symb=escape(&symbread())) { return ''; }
2604: } else {
1.213 www 2605: $symb=&escape(&symbclean($symb));
1.122 albertel 2606: }
1.188 www 2607: if (!$namespace) {
1.620 albertel 2608: unless ($namespace=$env{'request.course.id'}) {
1.188 www 2609: return '';
2610: }
2611: }
1.620 albertel 2612: if (!$domain) { $domain=$env{'user.domain'}; }
2613: if (!$stuname) { $stuname=$env{'user.name'}; }
2614: if (!$home) { $home=$env{'user.home'}; }
1.122 albertel 2615: my $answer=&reply("restore:$domain:$stuname:$namespace:$symb","$home");
2616:
1.12 www 2617: my %returnhash=();
1.191 harris41 2618: foreach (split(/\&/,$answer)) {
1.12 www 2619: my ($name,$value)=split(/\=/,$_);
1.591 albertel 2620: $returnhash{&unescape($name)}=&thaw_unescape($value);
1.191 harris41 2621: }
1.75 www 2622: my $version;
2623: for ($version=1;$version<=$returnhash{'version'};$version++) {
1.191 harris41 2624: foreach (split(/\:/,$returnhash{$version.':keys'})) {
1.75 www 2625: $returnhash{$_}=$returnhash{$version.':'.$_};
1.191 harris41 2626: }
1.75 www 2627: }
1.13 www 2628: return %returnhash;
1.34 www 2629: }
2630:
2631: # ---------------------------------------------------------- Course Description
2632:
2633: sub coursedescription {
1.731 albertel 2634: my ($courseid,$args)=@_;
1.34 www 2635: $courseid=~s/^\///;
1.49 www 2636: $courseid=~s/\_/\//g;
1.34 www 2637: my ($cdomain,$cnum)=split(/\//,$courseid);
1.129 albertel 2638: my $chome=&homeserver($cnum,$cdomain);
1.302 albertel 2639: my $normalid=$cdomain.'_'.$cnum;
2640: # need to always cache even if we get errors otherwise we keep
2641: # trying and trying and trying to get the course description.
2642: my %envhash=();
2643: my %returnhash=();
1.731 albertel 2644:
2645: my $expiretime=600;
2646: if ($env{'request.course.id'} eq $normalid) {
2647: $expiretime=120;
2648: }
2649:
2650: my $prefix='course.'.$cdomain.'_'.$cnum.'.';
2651: if (!$args->{'freshen_cache'}
2652: && ((time-$env{$prefix.'last_cache'}) < $expiretime) ) {
2653: foreach my $key (keys(%env)) {
2654: next if ($key !~ /^\Q$prefix\E(.*)/);
2655: my ($setting) = $1;
2656: $returnhash{$setting} = $env{$key};
2657: }
2658: return %returnhash;
2659: }
2660:
2661: # get the data agin
2662: if (!$args->{'one_time'}) {
2663: $envhash{'course.'.$normalid.'.last_cache'}=time;
2664: }
1.34 www 2665: if ($chome ne 'no_host') {
1.302 albertel 2666: %returnhash=&dump('environment',$cdomain,$cnum);
1.129 albertel 2667: if (!exists($returnhash{'con_lost'})) {
2668: $returnhash{'home'}= $chome;
2669: $returnhash{'domain'} = $cdomain;
2670: $returnhash{'num'} = $cnum;
1.741 raeburn 2671: if (!defined($returnhash{'type'})) {
2672: $returnhash{'type'} = 'Course';
2673: }
1.130 albertel 2674: while (my ($name,$value) = each %returnhash) {
1.53 www 2675: $envhash{'course.'.$normalid.'.'.$name}=$value;
1.129 albertel 2676: }
1.270 www 2677: $returnhash{'url'}=&clutter($returnhash{'url'});
1.34 www 2678: $returnhash{'fn'}=$perlvar{'lonDaemons'}.'/tmp/'.
1.620 albertel 2679: $env{'user.name'}.'_'.$cdomain.'_'.$cnum;
1.60 www 2680: $envhash{'course.'.$normalid.'.home'}=$chome;
2681: $envhash{'course.'.$normalid.'.domain'}=$cdomain;
2682: $envhash{'course.'.$normalid.'.num'}=$cnum;
1.34 www 2683: }
2684: }
1.731 albertel 2685: if (!$args->{'one_time'}) {
2686: &appenv(%envhash);
2687: }
1.302 albertel 2688: return %returnhash;
1.461 www 2689: }
2690:
2691: # -------------------------------------------------See if a user is privileged
2692:
2693: sub privileged {
2694: my ($username,$domain)=@_;
2695: my $rolesdump=&reply("dump:$domain:$username:roles",
2696: &homeserver($username,$domain));
2697: if (($rolesdump eq 'con_lost') || ($rolesdump eq '')) { return 0; }
2698: my $now=time;
2699: if ($rolesdump ne '') {
2700: foreach (split(/&/,$rolesdump)) {
1.586 albertel 2701: if ($_!~/^rolesdef_/) {
1.461 www 2702: my ($area,$role)=split(/=/,$_);
2703: $area=~s/\_\w\w$//;
2704: my ($trole,$tend,$tstart)=split(/_/,$role);
2705: if (($trole eq 'dc') || ($trole eq 'su')) {
2706: my $active=1;
2707: if ($tend) {
2708: if ($tend<$now) { $active=0; }
2709: }
2710: if ($tstart) {
2711: if ($tstart>$now) { $active=0; }
2712: }
2713: if ($active) { return 1; }
2714: }
2715: }
2716: }
2717: }
2718: return 0;
1.9 www 2719: }
1.1 albertel 2720:
1.103 harris41 2721: # -------------------------------------------------------- Get user privileges
1.11 www 2722:
2723: sub rolesinit {
2724: my ($domain,$username,$authhost)=@_;
2725: my $rolesdump=reply("dump:$domain:$username:roles",$authhost);
1.12 www 2726: if (($rolesdump eq 'con_lost') || ($rolesdump eq '')) { return ''; }
1.11 www 2727: my %allroles=();
1.678 raeburn 2728: my %allgroups=();
1.11 www 2729: my $now=time;
1.743 albertel 2730: my %userroles = ('user.login.time' => $now);
1.678 raeburn 2731: my $group_privs;
1.11 www 2732:
2733: if ($rolesdump ne '') {
1.191 harris41 2734: foreach (split(/&/,$rolesdump)) {
1.586 albertel 2735: if ($_!~/^rolesdef_/) {
1.11 www 2736: my ($area,$role)=split(/=/,$_);
1.587 albertel 2737: $area=~s/\_\w\w$//;
1.678 raeburn 2738: my ($trole,$tend,$tstart,$group_privs);
1.587 albertel 2739: if ($role=~/^cr/) {
1.655 albertel 2740: if ($role=~m|^(cr/\w+/\w+/[a-zA-Z0-9]+)_(.*)$|) {
2741: ($trole,my $trest)=($role=~m|^(cr/\w+/\w+/[a-zA-Z0-9]+)_(.*)$|);
2742: ($tend,$tstart)=split('_',$trest);
2743: } else {
2744: $trole=$role;
2745: }
1.678 raeburn 2746: } elsif ($role =~ m|^gr/|) {
2747: ($trole,$tend,$tstart) = split(/_/,$role);
2748: ($trole,$group_privs) = split(/\//,$trole);
2749: $group_privs = &unescape($group_privs);
1.587 albertel 2750: } else {
2751: ($trole,$tend,$tstart)=split(/_/,$role);
2752: }
1.743 albertel 2753: my %new_role = &set_arearole($trole,$area,$tstart,$tend,$domain,
2754: $username);
2755: @userroles{keys(%new_role)} = @new_role{keys(%new_role)};
1.567 raeburn 2756: if (($tend!=0) && ($tend<$now)) { $trole=''; }
2757: if (($tstart!=0) && ($tstart>$now)) { $trole=''; }
1.11 www 2758: if (($area ne '') && ($trole ne '')) {
1.347 albertel 2759: my $spec=$trole.'.'.$area;
2760: my ($tdummy,$tdomain,$trest)=split(/\//,$area);
2761: if ($trole =~ /^cr\//) {
1.567 raeburn 2762: &custom_roleprivs(\%allroles,$trole,$tdomain,$trest,$spec,$area);
1.678 raeburn 2763: } elsif ($trole eq 'gr') {
2764: &group_roleprivs(\%allgroups,$area,$group_privs,$tend,$tstart);
1.347 albertel 2765: } else {
1.567 raeburn 2766: &standard_roleprivs(\%allroles,$trole,$tdomain,$spec,$trest,$area);
1.347 albertel 2767: }
1.12 www 2768: }
1.662 raeburn 2769: }
1.191 harris41 2770: }
1.743 albertel 2771: my ($author,$adv) = &set_userprivs(\%userroles,\%allroles,\%allgroups);
2772: $userroles{'user.adv'} = $adv;
2773: $userroles{'user.author'} = $author;
1.620 albertel 2774: $env{'user.adv'}=$adv;
1.11 www 2775: }
1.743 albertel 2776: return \%userroles;
1.11 www 2777: }
2778:
1.567 raeburn 2779: sub set_arearole {
2780: my ($trole,$area,$tstart,$tend,$domain,$username) = @_;
2781: # log the associated role with the area
2782: &userrolelog($trole,$username,$domain,$area,$tstart,$tend);
1.743 albertel 2783: return ('user.role.'.$trole.'.'.$area => $tstart.'.'.$tend);
1.567 raeburn 2784: }
2785:
2786: sub custom_roleprivs {
2787: my ($allroles,$trole,$tdomain,$trest,$spec,$area) = @_;
2788: my ($rdummy,$rdomain,$rauthor,$rrole)=split(/\//,$trole);
2789: my $homsvr=homeserver($rauthor,$rdomain);
2790: if ($hostname{$homsvr} ne '') {
2791: my ($rdummy,$roledef)=
2792: &get('roles',["rolesdef_$rrole"],$rdomain,$rauthor);
2793: if (($rdummy ne 'con_lost') && ($roledef ne '')) {
2794: my ($syspriv,$dompriv,$coursepriv)=split(/\_/,$roledef);
2795: if (defined($syspriv)) {
2796: $$allroles{'cm./'}.=':'.$syspriv;
2797: $$allroles{$spec.'./'}.=':'.$syspriv;
2798: }
2799: if ($tdomain ne '') {
2800: if (defined($dompriv)) {
2801: $$allroles{'cm./'.$tdomain.'/'}.=':'.$dompriv;
2802: $$allroles{$spec.'./'.$tdomain.'/'}.=':'.$dompriv;
2803: }
2804: if (($trest ne '') && (defined($coursepriv))) {
2805: $$allroles{'cm.'.$area}.=':'.$coursepriv;
2806: $$allroles{$spec.'.'.$area}.=':'.$coursepriv;
2807: }
2808: }
2809: }
2810: }
2811: }
2812:
1.678 raeburn 2813: sub group_roleprivs {
2814: my ($allgroups,$area,$group_privs,$tend,$tstart) = @_;
2815: my $access = 1;
2816: my $now = time;
2817: if (($tend!=0) && ($tend<$now)) { $access = 0; }
2818: if (($tstart!=0) && ($tstart>$now)) { $access=0; }
2819: if ($access) {
2820: my ($course,$group) = ($area =~ m|(/\w+/\w+)/([^/]+)$|);
2821: $$allgroups{$course}{$group} .=':'.$group_privs;
2822: }
2823: }
1.567 raeburn 2824:
2825: sub standard_roleprivs {
2826: my ($allroles,$trole,$tdomain,$spec,$trest,$area) = @_;
2827: if (defined($pr{$trole.':s'})) {
2828: $$allroles{'cm./'}.=':'.$pr{$trole.':s'};
2829: $$allroles{$spec.'./'}.=':'.$pr{$trole.':s'};
2830: }
2831: if ($tdomain ne '') {
2832: if (defined($pr{$trole.':d'})) {
2833: $$allroles{'cm./'.$tdomain.'/'}.=':'.$pr{$trole.':d'};
2834: $$allroles{$spec.'./'.$tdomain.'/'}.=':'.$pr{$trole.':d'};
2835: }
2836: if (($trest ne '') && (defined($pr{$trole.':c'}))) {
2837: $$allroles{'cm.'.$area}.=':'.$pr{$trole.':c'};
2838: $$allroles{$spec.'.'.$area}.=':'.$pr{$trole.':c'};
2839: }
2840: }
2841: }
2842:
2843: sub set_userprivs {
1.678 raeburn 2844: my ($userroles,$allroles,$allgroups) = @_;
1.567 raeburn 2845: my $author=0;
2846: my $adv=0;
1.678 raeburn 2847: my %grouproles = ();
2848: if (keys(%{$allgroups}) > 0) {
2849: foreach my $role (keys %{$allroles}) {
1.681 raeburn 2850: my ($trole,$area,$sec,$extendedarea);
2851: if ($role =~ m|^(\w+)\.(/\w+/\w+)(/?\w*)|) {
1.678 raeburn 2852: $trole = $1;
2853: $area = $2;
1.681 raeburn 2854: $sec = $3;
2855: $extendedarea = $area.$sec;
2856: if (exists($$allgroups{$area})) {
2857: foreach my $group (keys(%{$$allgroups{$area}})) {
2858: my $spec = $trole.'.'.$extendedarea;
2859: $grouproles{$spec.'.'.$area.'/'.$group} =
2860: $$allgroups{$area}{$group};
1.678 raeburn 2861: }
2862: }
2863: }
2864: }
2865: }
2866: foreach (keys(%grouproles)) {
2867: $$allroles{$_} = $grouproles{$_};
2868: }
1.567 raeburn 2869: foreach (keys %{$allroles}) {
2870: my %thesepriv=();
2871: if (($_=~/^au/) || ($_=~/^ca/)) { $author=1; }
2872: foreach (split(/:/,$$allroles{$_})) {
2873: if ($_ ne '') {
2874: my ($privilege,$restrictions)=split(/&/,$_);
2875: if ($restrictions eq '') {
2876: $thesepriv{$privilege}='F';
2877: } elsif ($thesepriv{$privilege} ne 'F') {
2878: $thesepriv{$privilege}.=$restrictions;
2879: }
2880: if ($thesepriv{'adv'} eq 'F') { $adv=1; }
2881: }
2882: }
2883: my $thesestr='';
2884: foreach (keys %thesepriv) { $thesestr.=':'.$_.'&'.$thesepriv{$_}; }
1.743 albertel 2885: $userroles->{'user.priv.'.$_} = $thesestr;
1.567 raeburn 2886: }
2887: return ($author,$adv);
2888: }
2889:
1.12 www 2890: # --------------------------------------------------------------- get interface
2891:
2892: sub get {
1.131 albertel 2893: my ($namespace,$storearr,$udomain,$uname)=@_;
1.12 www 2894: my $items='';
1.191 harris41 2895: foreach (@$storearr) {
1.12 www 2896: $items.=escape($_).'&';
1.191 harris41 2897: }
1.12 www 2898: $items=~s/\&$//;
1.620 albertel 2899: if (!$udomain) { $udomain=$env{'user.domain'}; }
2900: if (!$uname) { $uname=$env{'user.name'}; }
1.131 albertel 2901: my $uhome=&homeserver($uname,$udomain);
2902:
1.133 albertel 2903: my $rep=&reply("get:$udomain:$uname:$namespace:$items",$uhome);
1.15 www 2904: my @pairs=split(/\&/,$rep);
1.273 albertel 2905: if ( $#pairs==0 && $pairs[0] =~ /^(con_lost|error|no_such_host)/i) {
2906: return @pairs;
2907: }
1.15 www 2908: my %returnhash=();
1.42 www 2909: my $i=0;
1.191 harris41 2910: foreach (@$storearr) {
1.557 albertel 2911: $returnhash{$_}=&thaw_unescape($pairs[$i]);
1.42 www 2912: $i++;
1.191 harris41 2913: }
1.15 www 2914: return %returnhash;
1.27 www 2915: }
2916:
2917: # --------------------------------------------------------------- del interface
2918:
2919: sub del {
1.133 albertel 2920: my ($namespace,$storearr,$udomain,$uname)=@_;
1.27 www 2921: my $items='';
1.191 harris41 2922: foreach (@$storearr) {
1.27 www 2923: $items.=escape($_).'&';
1.191 harris41 2924: }
1.27 www 2925: $items=~s/\&$//;
1.620 albertel 2926: if (!$udomain) { $udomain=$env{'user.domain'}; }
2927: if (!$uname) { $uname=$env{'user.name'}; }
1.133 albertel 2928: my $uhome=&homeserver($uname,$udomain);
2929:
2930: return &reply("del:$udomain:$uname:$namespace:$items",$uhome);
1.15 www 2931: }
2932:
2933: # -------------------------------------------------------------- dump interface
2934:
2935: sub dump {
1.755 albertel 2936: my ($namespace,$udomain,$uname,$regexp,$range)=@_;
2937: if (!$udomain) { $udomain=$env{'user.domain'}; }
2938: if (!$uname) { $uname=$env{'user.name'}; }
2939: my $uhome=&homeserver($uname,$udomain);
2940: if ($regexp) {
2941: $regexp=&escape($regexp);
2942: } else {
2943: $regexp='.';
2944: }
2945: my $rep=&reply("dump:$udomain:$uname:$namespace:$regexp:$range",$uhome);
2946: my @pairs=split(/\&/,$rep);
2947: my %returnhash=();
2948: foreach my $item (@pairs) {
2949: my ($key,$value)=split(/=/,$item,2);
2950: $key = &unescape($key);
2951: next if ($key =~ /^error: 2 /);
2952: $returnhash{$key}=&thaw_unescape($value);
2953: }
2954: return %returnhash;
1.407 www 2955: }
2956:
1.717 albertel 2957: # --------------------------------------------------------- dumpstore interface
2958:
2959: sub dumpstore {
2960: my ($namespace,$udomain,$uname,$regexp,$range)=@_;
2961: return &dump($namespace,$udomain,$uname,$regexp,$range);
2962: }
2963:
1.407 www 2964: # -------------------------------------------------------------- keys interface
2965:
2966: sub getkeys {
2967: my ($namespace,$udomain,$uname)=@_;
1.620 albertel 2968: if (!$udomain) { $udomain=$env{'user.domain'}; }
2969: if (!$uname) { $uname=$env{'user.name'}; }
1.407 www 2970: my $uhome=&homeserver($uname,$udomain);
2971: my $rep=reply("keys:$udomain:$uname:$namespace",$uhome);
2972: my @keyarray=();
2973: foreach (split(/\&/,$rep)) {
2974: push (@keyarray,&unescape($_));
2975: }
2976: return @keyarray;
1.318 matthew 2977: }
2978:
1.319 matthew 2979: # --------------------------------------------------------------- currentdump
2980: sub currentdump {
1.328 matthew 2981: my ($courseid,$sdom,$sname)=@_;
1.620 albertel 2982: $courseid = $env{'request.course.id'} if (! defined($courseid));
2983: $sdom = $env{'user.domain'} if (! defined($sdom));
2984: $sname = $env{'user.name'} if (! defined($sname));
1.326 matthew 2985: my $uhome = &homeserver($sname,$sdom);
2986: my $rep=reply('currentdump:'.$sdom.':'.$sname.':'.$courseid,$uhome);
1.318 matthew 2987: return if ($rep =~ /^(error:|no_such_host)/);
1.319 matthew 2988: #
1.318 matthew 2989: my %returnhash=();
1.319 matthew 2990: #
2991: if ($rep eq "unknown_cmd") {
2992: # an old lond will not know currentdump
2993: # Do a dump and make it look like a currentdump
1.326 matthew 2994: my @tmp = &dump($courseid,$sdom,$sname,'.');
1.319 matthew 2995: return if ($tmp[0] =~ /^(error:|no_such_host)/);
2996: my %hash = @tmp;
2997: @tmp=();
1.424 matthew 2998: %returnhash = %{&convert_dump_to_currentdump(\%hash)};
1.319 matthew 2999: } else {
3000: my @pairs=split(/\&/,$rep);
3001: foreach (@pairs) {
3002: my ($key,$value)=split(/=/,$_);
3003: my ($symb,$param) = split(/:/,$key);
3004: $returnhash{&unescape($symb)}->{&unescape($param)} =
1.557 albertel 3005: &thaw_unescape($value);
1.319 matthew 3006: }
1.191 harris41 3007: }
1.12 www 3008: return %returnhash;
1.424 matthew 3009: }
3010:
3011: sub convert_dump_to_currentdump{
3012: my %hash = %{shift()};
3013: my %returnhash;
3014: # Code ripped from lond, essentially. The only difference
3015: # here is the unescaping done by lonnet::dump(). Conceivably
3016: # we might run in to problems with parameter names =~ /^v\./
3017: while (my ($key,$value) = each(%hash)) {
3018: my ($v,$symb,$param) = split(/:/,$key);
3019: next if ($v eq 'version' || $symb eq 'keys');
3020: next if (exists($returnhash{$symb}) &&
3021: exists($returnhash{$symb}->{$param}) &&
3022: $returnhash{$symb}->{'v.'.$param} > $v);
3023: $returnhash{$symb}->{$param}=$value;
3024: $returnhash{$symb}->{'v.'.$param}=$v;
3025: }
3026: #
3027: # Remove all of the keys in the hashes which keep track of
3028: # the version of the parameter.
3029: while (my ($symb,$param_hash) = each(%returnhash)) {
3030: # use a foreach because we are going to delete from the hash.
3031: foreach my $key (keys(%$param_hash)) {
3032: delete($param_hash->{$key}) if ($key =~ /^v\./);
3033: }
3034: }
3035: return \%returnhash;
1.12 www 3036: }
3037:
1.627 albertel 3038: # ------------------------------------------------------ critical inc interface
3039:
3040: sub cinc {
3041: return &inc(@_,'critical');
3042: }
3043:
1.449 matthew 3044: # --------------------------------------------------------------- inc interface
3045:
3046: sub inc {
1.627 albertel 3047: my ($namespace,$store,$udomain,$uname,$critical) = @_;
1.620 albertel 3048: if (!$udomain) { $udomain=$env{'user.domain'}; }
3049: if (!$uname) { $uname=$env{'user.name'}; }
1.449 matthew 3050: my $uhome=&homeserver($uname,$udomain);
3051: my $items='';
3052: if (! ref($store)) {
3053: # got a single value, so use that instead
3054: $items = &escape($store).'=&';
3055: } elsif (ref($store) eq 'SCALAR') {
3056: $items = &escape($$store).'=&';
3057: } elsif (ref($store) eq 'ARRAY') {
3058: $items = join('=&',map {&escape($_);} @{$store});
3059: } elsif (ref($store) eq 'HASH') {
3060: while (my($key,$value) = each(%{$store})) {
3061: $items.= &escape($key).'='.&escape($value).'&';
3062: }
3063: }
3064: $items=~s/\&$//;
1.627 albertel 3065: if ($critical) {
3066: return &critical("inc:$udomain:$uname:$namespace:$items",$uhome);
3067: } else {
3068: return &reply("inc:$udomain:$uname:$namespace:$items",$uhome);
3069: }
1.449 matthew 3070: }
3071:
1.12 www 3072: # --------------------------------------------------------------- put interface
3073:
3074: sub put {
1.134 albertel 3075: my ($namespace,$storehash,$udomain,$uname)=@_;
1.620 albertel 3076: if (!$udomain) { $udomain=$env{'user.domain'}; }
3077: if (!$uname) { $uname=$env{'user.name'}; }
1.134 albertel 3078: my $uhome=&homeserver($uname,$udomain);
1.12 www 3079: my $items='';
1.191 harris41 3080: foreach (keys %$storehash) {
1.557 albertel 3081: $items.=&escape($_).'='.&freeze_escape($$storehash{$_}).'&';
1.191 harris41 3082: }
1.12 www 3083: $items=~s/\&$//;
1.134 albertel 3084: return &reply("put:$udomain:$uname:$namespace:$items",$uhome);
1.47 www 3085: }
3086:
1.631 albertel 3087: # ------------------------------------------------------------ newput interface
3088:
3089: sub newput {
3090: my ($namespace,$storehash,$udomain,$uname)=@_;
3091: if (!$udomain) { $udomain=$env{'user.domain'}; }
3092: if (!$uname) { $uname=$env{'user.name'}; }
3093: my $uhome=&homeserver($uname,$udomain);
3094: my $items='';
3095: foreach my $key (keys(%$storehash)) {
3096: $items.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
3097: }
3098: $items=~s/\&$//;
3099: return &reply("newput:$udomain:$uname:$namespace:$items",$uhome);
3100: }
3101:
3102: # --------------------------------------------------------- putstore interface
3103:
1.524 raeburn 3104: sub putstore {
1.715 albertel 3105: my ($namespace,$symb,$version,$storehash,$udomain,$uname)=@_;
1.620 albertel 3106: if (!$udomain) { $udomain=$env{'user.domain'}; }
3107: if (!$uname) { $uname=$env{'user.name'}; }
1.524 raeburn 3108: my $uhome=&homeserver($uname,$udomain);
3109: my $items='';
1.715 albertel 3110: foreach my $key (keys(%$storehash)) {
3111: $items.= &escape($key).'='.&freeze_escape($storehash->{$key}).'&';
1.524 raeburn 3112: }
1.715 albertel 3113: $items=~s/\&$//;
1.716 albertel 3114: my $esc_symb=&escape($symb);
3115: my $esc_v=&escape($version);
1.715 albertel 3116: my $reply =
1.716 albertel 3117: &reply("putstore:$udomain:$uname:$namespace:$esc_symb:$esc_v:$items",
1.715 albertel 3118: $uhome);
3119: if ($reply eq 'unknown_cmd') {
1.716 albertel 3120: # gfall back to way things use to be done
1.715 albertel 3121: return &old_putstore($namespace,$symb,$version,$storehash,$udomain,
3122: $uname);
1.524 raeburn 3123: }
1.715 albertel 3124: return $reply;
3125: }
3126:
3127: sub old_putstore {
1.716 albertel 3128: my ($namespace,$symb,$version,$storehash,$udomain,$uname)=@_;
3129: if (!$udomain) { $udomain=$env{'user.domain'}; }
3130: if (!$uname) { $uname=$env{'user.name'}; }
3131: my $uhome=&homeserver($uname,$udomain);
3132: my %newstorehash;
3133: foreach (keys %$storehash) {
3134: my $key = $version.':'.&escape($symb).':'.$_;
3135: $newstorehash{$key} = $storehash->{$_};
3136: }
3137: my $items='';
3138: my %allitems = ();
3139: foreach (keys %newstorehash) {
3140: if ($_ =~ m/^([^\:]+):([^\:]+):([^\:]+)$/) {
3141: my $key = $1.':keys:'.$2;
3142: $allitems{$key} .= $3.':';
3143: }
3144: $items.=$_.'='.&freeze_escape($newstorehash{$_}).'&';
3145: }
3146: foreach (keys %allitems) {
3147: $allitems{$_} =~ s/\:$//;
3148: $items.= $_.'='.$allitems{$_}.'&';
3149: }
3150: $items=~s/\&$//;
3151: return &reply("put:$udomain:$uname:$namespace:$items",$uhome);
1.524 raeburn 3152: }
3153:
1.47 www 3154: # ------------------------------------------------------ critical put interface
3155:
3156: sub cput {
1.134 albertel 3157: my ($namespace,$storehash,$udomain,$uname)=@_;
1.620 albertel 3158: if (!$udomain) { $udomain=$env{'user.domain'}; }
3159: if (!$uname) { $uname=$env{'user.name'}; }
1.134 albertel 3160: my $uhome=&homeserver($uname,$udomain);
1.47 www 3161: my $items='';
1.191 harris41 3162: foreach (keys %$storehash) {
1.715 albertel 3163: $items.=&escape($_).'='.&freeze_escape($$storehash{$_}).'&';
1.191 harris41 3164: }
1.47 www 3165: $items=~s/\&$//;
1.134 albertel 3166: return &critical("put:$udomain:$uname:$namespace:$items",$uhome);
1.12 www 3167: }
3168:
3169: # -------------------------------------------------------------- eget interface
3170:
3171: sub eget {
1.133 albertel 3172: my ($namespace,$storearr,$udomain,$uname)=@_;
1.12 www 3173: my $items='';
1.191 harris41 3174: foreach (@$storearr) {
1.12 www 3175: $items.=escape($_).'&';
1.191 harris41 3176: }
1.12 www 3177: $items=~s/\&$//;
1.620 albertel 3178: if (!$udomain) { $udomain=$env{'user.domain'}; }
3179: if (!$uname) { $uname=$env{'user.name'}; }
1.133 albertel 3180: my $uhome=&homeserver($uname,$udomain);
3181: my $rep=&reply("eget:$udomain:$uname:$namespace:$items",$uhome);
1.12 www 3182: my @pairs=split(/\&/,$rep);
3183: my %returnhash=();
1.42 www 3184: my $i=0;
1.191 harris41 3185: foreach (@$storearr) {
1.557 albertel 3186: $returnhash{$_}=&thaw_unescape($pairs[$i]);
1.42 www 3187: $i++;
1.191 harris41 3188: }
1.12 www 3189: return %returnhash;
3190: }
3191:
1.667 albertel 3192: # ------------------------------------------------------------ tmpput interface
3193: sub tmpput {
3194: my ($storehash,$server)=@_;
3195: my $items='';
3196: foreach (keys(%$storehash)) {
3197: $items.=&escape($_).'='.&freeze_escape($$storehash{$_}).'&';
3198: }
3199: $items=~s/\&$//;
3200: return &reply("tmpput:$items",$server);
3201: }
3202:
3203: # ------------------------------------------------------------ tmpget interface
3204: sub tmpget {
1.688 albertel 3205: my ($token,$server)=@_;
3206: if (!defined($server)) { $server = $perlvar{'lonHostID'}; }
3207: my $rep=&reply("tmpget:$token",$server);
1.667 albertel 3208: my %returnhash;
3209: foreach my $item (split(/\&/,$rep)) {
3210: my ($key,$value)=split(/=/,$item);
3211: $returnhash{&unescape($key)}=&thaw_unescape($value);
3212: }
3213: return %returnhash;
3214: }
3215:
1.688 albertel 3216: # ------------------------------------------------------------ tmpget interface
3217: sub tmpdel {
3218: my ($token,$server)=@_;
3219: if (!defined($server)) { $server = $perlvar{'lonHostID'}; }
3220: return &reply("tmpdel:$token",$server);
3221: }
3222:
1.341 www 3223: # ---------------------------------------------- Custom access rule evaluation
3224:
3225: sub customaccess {
3226: my ($priv,$uri)=@_;
1.620 albertel 3227: my ($urole,$urealm)=split(/\./,$env{'request.role'});
1.343 www 3228: $urealm=~s/^\W//;
3229: my ($udom,$ucrs,$usec)=split(/\//,$urealm);
1.341 www 3230: my $access=0;
3231: foreach (split(/\s*\,\s*/,&metadata($uri,'rule_rights'))) {
1.342 www 3232: my ($effect,$realm,$role)=split(/\:/,$_);
1.343 www 3233: if ($role) {
3234: if ($role ne $urole) { next; }
3235: }
3236: foreach (split(/\s*\,\s*/,$realm)) {
3237: my ($tdom,$tcrs,$tsec)=split(/\_/,$_);
3238: if ($tdom) {
3239: if ($tdom ne $udom) { next; }
3240: }
3241: if ($tcrs) {
3242: if ($tcrs ne $ucrs) { next; }
3243: }
3244: if ($tsec) {
3245: if ($tsec ne $usec) { next; }
3246: }
3247: $access=($effect eq 'allow');
3248: last;
1.342 www 3249: }
1.402 bowersj2 3250: if ($realm eq '' && $role eq '') {
3251: $access=($effect eq 'allow');
3252: }
1.341 www 3253: }
3254: return $access;
3255: }
3256:
1.103 harris41 3257: # ------------------------------------------------- Check for a user privilege
1.12 www 3258:
3259: sub allowed {
1.579 albertel 3260: my ($priv,$uri,$symb)=@_;
1.705 albertel 3261: my $ver_orguri=$uri;
1.439 www 3262: $uri=&deversion($uri);
1.152 www 3263: my $orguri=$uri;
1.52 www 3264: $uri=&declutter($uri);
1.545 banghart 3265:
1.620 albertel 3266: if (defined($env{'allowed.'.$priv})) { return $env{'allowed.'.$priv}; }
1.54 www 3267: # Free bre access to adm and meta resources
1.529 albertel 3268: if (((($uri=~/^adm\//) && ($uri !~ m|/bulletinboard$|))
3269: || ($uri=~/\.meta$/)) && ($priv eq 'bre')) {
1.14 www 3270: return 'F';
1.159 www 3271: }
3272:
1.545 banghart 3273: # Free bre access to user's own portfolio contents
1.714 raeburn 3274: my ($space,$domain,$name,@dir)=split('/',$uri);
1.647 raeburn 3275: if (($space=~/^(uploaded|editupload)$/) && ($env{'user.name'} eq $name) &&
1.714 raeburn 3276: ($env{'user.domain'} eq $domain) && ('portfolio' eq $dir[0])) {
1.545 banghart 3277: return 'F';
3278: }
3279:
1.714 raeburn 3280: # bre access to group if user has rgf priv for this group and course.
3281: if (($space=~/^(uploaded|editupload)$/) && ($dir[0] eq 'groups')
3282: && ($dir[2] eq 'portfolio') && ($priv eq 'bre')) {
3283: if (exists($env{'request.course.id'})) {
3284: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
3285: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
3286: if (($domain eq $cdom) && ($name eq $cnum)) {
3287: my $courseprivid=$env{'request.course.id'};
3288: $courseprivid=~s/\_/\//;
3289: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid
3290: .'/'.$dir[1]} =~/rgf\&([^\:]*)/) {
3291: return $1;
3292: }
3293: }
3294: }
3295: }
3296:
1.159 www 3297: # Free bre to public access
3298:
3299: if ($priv eq 'bre') {
1.238 www 3300: my $copyright=&metadata($uri,'copyright');
1.620 albertel 3301: if (($copyright eq 'public') && (!$env{'request.course.id'})) {
1.301 www 3302: return 'F';
3303: }
1.238 www 3304: if ($copyright eq 'priv') {
3305: $uri=~/([^\/]+)\/([^\/]+)\//;
1.620 albertel 3306: unless (($env{'user.name'} eq $2) && ($env{'user.domain'} eq $1)) {
1.238 www 3307: return '';
3308: }
3309: }
3310: if ($copyright eq 'domain') {
3311: $uri=~/([^\/]+)\/([^\/]+)\//;
1.620 albertel 3312: unless (($env{'user.domain'} eq $1) ||
3313: ($env{'course.'.$env{'request.course.id'}.'.domain'} eq $1)) {
1.238 www 3314: return '';
3315: }
1.262 matthew 3316: }
1.620 albertel 3317: if ($env{'request.role'}=~ /li\.\//) {
1.262 matthew 3318: # Library role, so allow browsing of resources in this domain.
3319: return 'F';
1.238 www 3320: }
1.341 www 3321: if ($copyright eq 'custom') {
3322: unless (&customaccess($priv,$uri)) { return ''; }
3323: }
1.14 www 3324: }
1.264 matthew 3325: # Domain coordinator is trying to create a course
1.620 albertel 3326: if (($priv eq 'ccc') && ($env{'request.role'} =~ /^dc\./)) {
1.264 matthew 3327: # uri is the requested domain in this case.
3328: # comparison to 'request.role.domain' shows if the user has selected
1.678 raeburn 3329: # a role of dc for the domain in question.
1.620 albertel 3330: return 'F' if ($uri eq $env{'request.role.domain'});
1.264 matthew 3331: }
1.29 www 3332:
1.52 www 3333: my $thisallowed='';
3334: my $statecond=0;
3335: my $courseprivid='';
3336:
3337: # Course
3338:
1.620 albertel 3339: if ($env{'user.priv.'.$env{'request.role'}.'./'}=~/\Q$priv\E\&([^\:]*)/) {
1.52 www 3340: $thisallowed.=$1;
3341: }
1.29 www 3342:
1.52 www 3343: # Domain
3344:
1.620 albertel 3345: if ($env{'user.priv.'.$env{'request.role'}.'./'.(split(/\//,$uri))[0].'/'}
1.479 albertel 3346: =~/\Q$priv\E\&([^\:]*)/) {
1.12 www 3347: $thisallowed.=$1;
3348: }
1.52 www 3349:
3350: # Course: uri itself is a course
1.66 www 3351: my $courseuri=$uri;
3352: $courseuri=~s/\_(\d)/\/$1/;
1.83 www 3353: $courseuri=~s/^([^\/])/\/$1/;
1.81 www 3354:
1.620 albertel 3355: if ($env{'user.priv.'.$env{'request.role'}.'.'.$courseuri}
1.479 albertel 3356: =~/\Q$priv\E\&([^\:]*)/) {
1.12 www 3357: $thisallowed.=$1;
3358: }
1.29 www 3359:
1.678 raeburn 3360: # Group: uri itself is a group
3361: my $groupuri=$uri;
3362: $groupuri=~s/^([^\/])/\/$1/;
3363: if ($env{'user.priv.'.$env{'request.role'}.'.'.$groupuri}
3364: =~/\Q$priv\E\&([^\:]*)/) {
3365: $thisallowed.=$1;
3366: }
3367:
1.665 albertel 3368: # URI is an uploaded document for this course, default permissions don't matter
1.611 albertel 3369: # not allowing 'edit' access (editupload) to uploaded course docs
1.492 albertel 3370: if (($priv eq 'bre') && ($uri=~m|^uploaded/|)) {
1.665 albertel 3371: $thisallowed='';
1.671 raeburn 3372: my ($match)=&is_on_map($uri);
3373: if ($match) {
3374: if ($env{'user.priv.'.$env{'request.role'}.'./'}
3375: =~/\Q$priv\E\&([^\:]*)/) {
3376: $thisallowed.=$1;
3377: }
3378: } else {
1.705 albertel 3379: my $refuri = $env{'httpref.'.$orguri} || $env{'httpref.'.$ver_orguri};
1.671 raeburn 3380: if ($refuri) {
3381: if ($refuri =~ m|^/adm/|) {
1.669 raeburn 3382: $thisallowed='F';
1.671 raeburn 3383: } else {
3384: $refuri=&declutter($refuri);
3385: my ($match) = &is_on_map($refuri);
3386: if ($match) {
3387: $thisallowed='F';
3388: }
1.669 raeburn 3389: }
1.671 raeburn 3390: }
3391: }
1.314 www 3392: }
1.492 albertel 3393:
1.52 www 3394: # Full access at system, domain or course-wide level? Exit.
1.29 www 3395:
3396: if ($thisallowed=~/F/) {
3397: return 'F';
3398: }
3399:
1.52 www 3400: # If this is generating or modifying users, exit with special codes
1.29 www 3401:
1.643 www 3402: if (':csu:cdc:ccc:cin:cta:cep:ccr:cst:cad:cli:cau:cdg:cca:caa:'=~/\:\Q$priv\E\:/) {
3403: if (($priv eq 'cca') || ($priv eq 'caa')) {
1.642 albertel 3404: my ($audom,$auname)=split('/',$uri);
1.643 www 3405: # no author name given, so this just checks on the general right to make a co-author in this domain
3406: unless ($auname) { return $thisallowed; }
3407: # an author name is given, so we are about to actually make a co-author for a certain account
1.642 albertel 3408: if (($auname ne $env{'user.name'} && $env{'request.role'} !~ /^dc\./) ||
3409: (($audom ne $env{'user.domain'} && $env{'request.role'} !~ /^dc\./) &&
3410: ($audom ne $env{'request.role.domain'}))) { return ''; }
3411: }
1.52 www 3412: return $thisallowed;
3413: }
3414: #
1.103 harris41 3415: # Gathered so far: system, domain and course wide privileges
1.52 www 3416: #
3417: # Course: See if uri or referer is an individual resource that is part of
3418: # the course
3419:
1.620 albertel 3420: if ($env{'request.course.id'}) {
1.232 www 3421:
1.620 albertel 3422: $courseprivid=$env{'request.course.id'};
3423: if ($env{'request.course.sec'}) {
3424: $courseprivid.='/'.$env{'request.course.sec'};
1.52 www 3425: }
3426: $courseprivid=~s/\_/\//;
3427: my $checkreferer=1;
1.232 www 3428: my ($match,$cond)=&is_on_map($uri);
3429: if ($match) {
3430: $statecond=$cond;
1.620 albertel 3431: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid}
1.479 albertel 3432: =~/\Q$priv\E\&([^\:]*)/) {
1.52 www 3433: $thisallowed.=$1;
3434: $checkreferer=0;
3435: }
1.29 www 3436: }
1.83 www 3437:
1.148 www 3438: if ($checkreferer) {
1.620 albertel 3439: my $refuri=$env{'httpref.'.$orguri};
1.148 www 3440: unless ($refuri) {
1.620 albertel 3441: foreach (keys %env) {
1.148 www 3442: if ($_=~/^httpref\..*\*/) {
3443: my $pattern=$_;
1.156 www 3444: $pattern=~s/^httpref\.\/res\///;
1.148 www 3445: $pattern=~s/\*/\[\^\/\]\+/g;
3446: $pattern=~s/\//\\\//g;
1.152 www 3447: if ($orguri=~/$pattern/) {
1.620 albertel 3448: $refuri=$env{$_};
1.148 www 3449: }
3450: }
1.191 harris41 3451: }
1.148 www 3452: }
1.232 www 3453:
1.148 www 3454: if ($refuri) {
1.152 www 3455: $refuri=&declutter($refuri);
1.232 www 3456: my ($match,$cond)=&is_on_map($refuri);
3457: if ($match) {
3458: my $refstatecond=$cond;
1.620 albertel 3459: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid}
1.479 albertel 3460: =~/\Q$priv\E\&([^\:]*)/) {
1.52 www 3461: $thisallowed.=$1;
1.53 www 3462: $uri=$refuri;
3463: $statecond=$refstatecond;
1.52 www 3464: }
3465: }
1.148 www 3466: }
1.29 www 3467: }
1.52 www 3468: }
1.29 www 3469:
1.52 www 3470: #
1.103 harris41 3471: # Gathered now: all privileges that could apply, and condition number
1.52 www 3472: #
3473: #
3474: # Full or no access?
3475: #
1.29 www 3476:
1.52 www 3477: if ($thisallowed=~/F/) {
3478: return 'F';
3479: }
1.29 www 3480:
1.52 www 3481: unless ($thisallowed) {
3482: return '';
3483: }
1.29 www 3484:
1.52 www 3485: # Restrictions exist, deal with them
3486: #
3487: # C:according to course preferences
3488: # R:according to resource settings
3489: # L:unless locked
3490: # X:according to user session state
3491: #
3492:
3493: # Possibly locked functionality, check all courses
1.54 www 3494: # Locks might take effect only after 10 minutes cache expiration for other
3495: # courses, and 2 minutes for current course
1.52 www 3496:
3497: my $envkey;
3498: if ($thisallowed=~/L/) {
1.620 albertel 3499: foreach $envkey (keys %env) {
1.54 www 3500: if ($envkey=~/^user\.role\.(st|ta)\.([^\.]*)/) {
3501: my $courseid=$2;
3502: my $roleid=$1.'.'.$2;
1.92 www 3503: $courseid=~s/^\///;
1.54 www 3504: my $expiretime=600;
1.620 albertel 3505: if ($env{'request.role'} eq $roleid) {
1.54 www 3506: $expiretime=120;
3507: }
3508: my ($cdom,$cnum,$csec)=split(/\//,$courseid);
3509: my $prefix='course.'.$cdom.'_'.$cnum.'.';
1.620 albertel 3510: if ((time-$env{$prefix.'last_cache'})>$expiretime) {
1.731 albertel 3511: &coursedescription($courseid,{'freshen_cache' => 1});
1.54 www 3512: }
1.620 albertel 3513: if (($env{$prefix.'res.'.$uri.'.lock.sections'}=~/\,\Q$csec\E\,/)
3514: || ($env{$prefix.'res.'.$uri.'.lock.sections'} eq 'all')) {
3515: if ($env{$prefix.'res.'.$uri.'.lock.expire'}>time) {
3516: &log($env{'user.domain'},$env{'user.name'},
3517: $env{'user.home'},
1.57 www 3518: 'Locked by res: '.$priv.' for '.$uri.' due to '.
1.52 www 3519: $cdom.'/'.$cnum.'/'.$csec.' expire '.
1.620 albertel 3520: $env{$prefix.'priv.'.$priv.'.lock.expire'});
1.52 www 3521: return '';
3522: }
3523: }
1.620 albertel 3524: if (($env{$prefix.'priv.'.$priv.'.lock.sections'}=~/\,\Q$csec\E\,/)
3525: || ($env{$prefix.'priv.'.$priv.'.lock.sections'} eq 'all')) {
3526: if ($env{'priv.'.$priv.'.lock.expire'}>time) {
3527: &log($env{'user.domain'},$env{'user.name'},
3528: $env{'user.home'},
1.57 www 3529: 'Locked by priv: '.$priv.' for '.$uri.' due to '.
1.52 www 3530: $cdom.'/'.$cnum.'/'.$csec.' expire '.
1.620 albertel 3531: $env{$prefix.'priv.'.$priv.'.lock.expire'});
1.52 www 3532: return '';
3533: }
3534: }
3535: }
1.29 www 3536: }
1.52 www 3537: }
3538:
3539: #
3540: # Rest of the restrictions depend on selected course
3541: #
3542:
1.620 albertel 3543: unless ($env{'request.course.id'}) {
1.52 www 3544: return '1';
3545: }
1.29 www 3546:
1.52 www 3547: #
3548: # Now user is definitely in a course
3549: #
1.53 www 3550:
3551:
3552: # Course preferences
3553:
3554: if ($thisallowed=~/C/) {
1.620 albertel 3555: my $rolecode=(split(/\./,$env{'request.role'}))[0];
3556: my $unamedom=$env{'user.name'}.':'.$env{'user.domain'};
3557: if ($env{'course.'.$env{'request.course.id'}.'.'.$priv.'.roles.denied'}
1.479 albertel 3558: =~/\Q$rolecode\E/) {
1.689 albertel 3559: if ($priv ne 'pch') {
3560: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.':'.
3561: 'Denied by role: '.$priv.' for '.$uri.' as '.$rolecode.' in '.
3562: $env{'request.course.id'});
3563: }
1.237 www 3564: return '';
3565: }
3566:
1.620 albertel 3567: if ($env{'course.'.$env{'request.course.id'}.'.'.$priv.'.users.denied'}
1.479 albertel 3568: =~/\Q$unamedom\E/) {
1.689 albertel 3569: if ($priv ne 'pch') {
3570: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.
3571: 'Denied by user: '.$priv.' for '.$uri.' as '.$unamedom.' in '.
3572: $env{'request.course.id'});
3573: }
1.54 www 3574: return '';
3575: }
1.53 www 3576: }
3577:
3578: # Resource preferences
3579:
3580: if ($thisallowed=~/R/) {
1.620 albertel 3581: my $rolecode=(split(/\./,$env{'request.role'}))[0];
1.479 albertel 3582: if (&metadata($uri,'roledeny')=~/\Q$rolecode\E/) {
1.689 albertel 3583: if ($priv ne 'pch') {
3584: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.':'.
3585: 'Denied by role: '.$priv.' for '.$uri.' as '.$rolecode);
3586: }
3587: return '';
1.54 www 3588: }
1.53 www 3589: }
1.30 www 3590:
1.246 www 3591: # Restricted by state or randomout?
1.30 www 3592:
1.52 www 3593: if ($thisallowed=~/X/) {
1.620 albertel 3594: if ($env{'acc.randomout'}) {
1.579 albertel 3595: if (!$symb) { $symb=&symbread($uri,1); }
1.620 albertel 3596: if (($symb) && ($env{'acc.randomout'}=~/\&\Q$symb\E\&/)) {
1.248 www 3597: return '';
3598: }
1.247 www 3599: }
3600: if (&condval($statecond)) {
1.52 www 3601: return '2';
3602: } else {
3603: return '';
3604: }
3605: }
1.30 www 3606:
1.52 www 3607: return 'F';
1.232 www 3608: }
3609:
1.710 albertel 3610: sub split_uri_for_cond {
3611: my $uri=&deversion(&declutter(shift));
3612: my @uriparts=split(/\//,$uri);
3613: my $filename=pop(@uriparts);
3614: my $pathname=join('/',@uriparts);
3615: return ($pathname,$filename);
3616: }
1.232 www 3617: # --------------------------------------------------- Is a resource on the map?
3618:
3619: sub is_on_map {
1.710 albertel 3620: my ($pathname,$filename) = &split_uri_for_cond(shift);
1.289 bowersj2 3621: #Trying to find the conditional for the file
1.620 albertel 3622: my $match=($env{'acc.res.'.$env{'request.course.id'}.'.'.$pathname}=~
1.289 bowersj2 3623: /\&\Q$filename\E\:([\d\|]+)\&/);
1.232 www 3624: if ($match) {
1.289 bowersj2 3625: return (1,$1);
3626: } else {
1.434 www 3627: return (0,0);
1.289 bowersj2 3628: }
1.12 www 3629: }
3630:
1.427 www 3631: # --------------------------------------------------------- Get symb from alias
3632:
3633: sub get_symb_from_alias {
3634: my $symb=shift;
3635: my ($map,$resid,$url)=&decode_symb($symb);
3636: # Already is a symb
3637: if ($url) { return $symb; }
3638: # Must be an alias
3639: my $aliassymb='';
3640: my %bighash;
1.620 albertel 3641: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
1.427 www 3642: &GDBM_READER(),0640)) {
3643: my $rid=$bighash{'mapalias_'.$symb};
3644: if ($rid) {
3645: my ($mapid,$resid)=split(/\./,$rid);
1.429 albertel 3646: $aliassymb=&encode_symb($bighash{'map_id_'.$mapid},
3647: $resid,$bighash{'src_'.$rid});
1.427 www 3648: }
3649: untie %bighash;
3650: }
3651: return $aliassymb;
3652: }
3653:
1.12 www 3654: # ----------------------------------------------------------------- Define Role
3655:
3656: sub definerole {
3657: if (allowed('mcr','/')) {
3658: my ($rolename,$sysrole,$domrole,$courole)=@_;
1.392 www 3659: foreach (split(':',$sysrole)) {
1.21 www 3660: my ($crole,$cqual)=split(/\&/,$_);
1.479 albertel 3661: if ($pr{'cr:s'}!~/\Q$crole\E/) { return "refused:s:$crole"; }
3662: if ($pr{'cr:s'}=~/\Q$crole\E\&/) {
3663: if ($pr{'cr:s'}!~/\Q$crole\E\&\w*\Q$cqual\E/) {
1.21 www 3664: return "refused:s:$crole&$cqual";
3665: }
3666: }
1.191 harris41 3667: }
1.392 www 3668: foreach (split(':',$domrole)) {
1.21 www 3669: my ($crole,$cqual)=split(/\&/,$_);
1.479 albertel 3670: if ($pr{'cr:d'}!~/\Q$crole\E/) { return "refused:d:$crole"; }
3671: if ($pr{'cr:d'}=~/\Q$crole\E\&/) {
3672: if ($pr{'cr:d'}!~/\Q$crole\W\&\w*\Q$cqual\E/) {
1.21 www 3673: return "refused:d:$crole&$cqual";
3674: }
3675: }
1.191 harris41 3676: }
1.392 www 3677: foreach (split(':',$courole)) {
1.21 www 3678: my ($crole,$cqual)=split(/\&/,$_);
1.479 albertel 3679: if ($pr{'cr:c'}!~/\Q$crole\E/) { return "refused:c:$crole"; }
3680: if ($pr{'cr:c'}=~/\Q$crole\E\&/) {
3681: if ($pr{'cr:c'}!~/\Q$crole\E\&\w*\Q$cqual\E/) {
1.21 www 3682: return "refused:c:$crole&$cqual";
3683: }
3684: }
1.191 harris41 3685: }
1.620 albertel 3686: my $command="encrypt:rolesput:$env{'user.domain'}:$env{'user.name'}:".
3687: "$env{'user.domain'}:$env{'user.name'}:".
1.21 www 3688: "rolesdef_$rolename=".
3689: escape($sysrole.'_'.$domrole.'_'.$courole);
1.620 albertel 3690: return reply($command,$env{'user.home'});
1.12 www 3691: } else {
3692: return 'refused';
3693: }
1.105 harris41 3694: }
3695:
3696: # ---------------- Make a metadata query against the network of library servers
3697:
3698: sub metadata_query {
1.244 matthew 3699: my ($query,$custom,$customshow,$server_array)=@_;
1.120 harris41 3700: my %rhash;
1.244 matthew 3701: my @server_list = (defined($server_array) ? @$server_array
3702: : keys(%libserv) );
3703: for my $server (@server_list) {
1.118 harris41 3704: unless ($custom or $customshow) {
3705: my $reply=&reply("querysend:".&escape($query),$server);
3706: $rhash{$server}=$reply;
3707: }
3708: else {
3709: my $reply=&reply("querysend:".&escape($query).':'.
3710: &escape($custom).':'.&escape($customshow),
3711: $server);
3712: $rhash{$server}=$reply;
3713: }
1.112 harris41 3714: }
1.118 harris41 3715: return \%rhash;
1.240 www 3716: }
3717:
3718: # ----------------------------------------- Send log queries and wait for reply
3719:
3720: sub log_query {
3721: my ($uname,$udom,$query,%filters)=@_;
3722: my $uhome=&homeserver($uname,$udom);
3723: if ($uhome eq 'no_host') { return 'error: no_host'; }
3724: my $uhost=$hostname{$uhome};
1.241 www 3725: my $command=&escape(join(':',map{$_.'='.$filters{$_}} keys %filters));
1.240 www 3726: my $queryid=&reply("querysend:".$query.':'.$udom.':'.$uname.':'.$command,
3727: $uhome);
1.479 albertel 3728: unless ($queryid=~/^\Q$uhost\E\_/) { return 'error: '.$queryid; }
1.242 www 3729: return get_query_reply($queryid);
3730: }
3731:
1.508 raeburn 3732: # ------- Request retrieval of institutional classlists for course(s)
1.506 raeburn 3733:
3734: sub fetch_enrollment_query {
1.511 raeburn 3735: my ($context,$affiliatesref,$replyref,$dom,$cnum) = @_;
1.508 raeburn 3736: my $homeserver;
1.547 raeburn 3737: my $maxtries = 1;
1.508 raeburn 3738: if ($context eq 'automated') {
3739: $homeserver = $perlvar{'lonHostID'};
1.547 raeburn 3740: $maxtries = 10; # will wait for up to 2000s for retrieval of classlist data before timeout
1.508 raeburn 3741: } else {
3742: $homeserver = &homeserver($cnum,$dom);
3743: }
1.506 raeburn 3744: my $host=$hostname{$homeserver};
3745: my $cmd = '';
3746: foreach (keys %{$affiliatesref}) {
1.508 raeburn 3747: $cmd .= $_.'='.join(",",@{$$affiliatesref{$_}}).'%%';
1.506 raeburn 3748: }
3749: $cmd =~ s/%%$//;
3750: $cmd = &escape($cmd);
3751: my $query = 'fetchenrollment';
1.620 albertel 3752: my $queryid=&reply("querysend:".$query.':'.$dom.':'.$env{'user.name'}.':'.$cmd,$homeserver);
1.526 raeburn 3753: unless ($queryid=~/^\Q$host\E\_/) {
3754: &logthis('fetch_enrollment_query: invalid queryid: '.$queryid.' for host: '.$host.' and homeserver: '.$homeserver.' context: '.$context.' '.$cnum);
3755: return 'error: '.$queryid;
3756: }
1.506 raeburn 3757: my $reply = &get_query_reply($queryid);
1.547 raeburn 3758: my $tries = 1;
3759: while (($reply=~/^timeout/) && ($tries < $maxtries)) {
3760: $reply = &get_query_reply($queryid);
3761: $tries ++;
3762: }
1.526 raeburn 3763: if ( ($reply =~/^timeout/) || ($reply =~/^error/) ) {
1.620 albertel 3764: &logthis('fetch_enrollment_query error: '.$reply.' for '.$dom.' '.$env{'user.name'}.' for '.$queryid.' context: '.$context.' '.$cnum.' maxtries: '.$maxtries.' tries: '.$tries);
1.526 raeburn 3765: } else {
1.515 raeburn 3766: my @responses = split/:/,$reply;
3767: if ($homeserver eq $perlvar{'lonHostID'}) {
3768: foreach (@responses) {
3769: my ($key,$value) = split/=/,$_;
3770: $$replyref{$key} = $value;
3771: }
3772: } else {
1.506 raeburn 3773: my $pathname = $perlvar{'lonDaemons'}.'/tmp';
3774: foreach (@responses) {
3775: my ($key,$value) = split/=/,$_;
3776: $$replyref{$key} = $value;
3777: if ($value > 0) {
3778: foreach (@{$$affiliatesref{$key}}) {
3779: my $filename = $dom.'_'.$key.'_'.$_.'_classlist.xml';
3780: my $destname = $pathname.'/'.$filename;
3781: my $xml_classlist = &reply("autoretrieve:".$filename,$homeserver);
1.526 raeburn 3782: if ($xml_classlist =~ /^error/) {
3783: &logthis('fetch_enrollment_query - autoretrieve error: '.$xml_classlist.' for '.$filename.' from server: '.$homeserver.' '.$context.' '.$cnum);
3784: } else {
1.506 raeburn 3785: if ( open(FILE,">$destname") ) {
3786: print FILE &unescape($xml_classlist);
3787: close(FILE);
1.526 raeburn 3788: } else {
3789: &logthis('fetch_enrollment_query - error opening classlist file '.$destname.' '.$context.' '.$cnum);
1.506 raeburn 3790: }
3791: }
3792: }
3793: }
3794: }
3795: }
3796: return 'ok';
3797: }
3798: return 'error';
3799: }
3800:
1.242 www 3801: sub get_query_reply {
3802: my $queryid=shift;
1.240 www 3803: my $replyfile=$perlvar{'lonDaemons'}.'/tmp/'.$queryid;
3804: my $reply='';
3805: for (1..100) {
3806: sleep 2;
3807: if (-e $replyfile.'.end') {
1.448 albertel 3808: if (open(my $fh,$replyfile)) {
1.240 www 3809: $reply.=<$fh>;
1.448 albertel 3810: close($fh);
1.240 www 3811: } else { return 'error: reply_file_error'; }
1.242 www 3812: return &unescape($reply);
3813: }
1.240 www 3814: }
1.242 www 3815: return 'timeout:'.$queryid;
1.240 www 3816: }
3817:
3818: sub courselog_query {
1.241 www 3819: #
3820: # possible filters:
3821: # url: url or symb
3822: # username
3823: # domain
3824: # action: view, submit, grade
3825: # start: timestamp
3826: # end: timestamp
3827: #
1.240 www 3828: my (%filters)=@_;
1.620 albertel 3829: unless ($env{'request.course.id'}) { return 'no_course'; }
1.241 www 3830: if ($filters{'url'}) {
3831: $filters{'url'}=&symbclean(&declutter($filters{'url'}));
3832: $filters{'url'}=~s/\.(\w+)$/(\\.\\d+)*\\.$1/;
3833: $filters{'url'}=~s/\.(\w+)\_\_\_/(\\.\\d+)*\\.$1/;
3834: }
1.620 albertel 3835: my $cname=$env{'course.'.$env{'request.course.id'}.'.num'};
3836: my $cdom=$env{'course.'.$env{'request.course.id'}.'.domain'};
1.240 www 3837: return &log_query($cname,$cdom,'courselog',%filters);
3838: }
3839:
3840: sub userlog_query {
3841: my ($uname,$udom,%filters)=@_;
3842: return &log_query($uname,$udom,'userlog',%filters);
1.12 www 3843: }
3844:
1.506 raeburn 3845: #--------- Call auto-enrollment subs in localenroll.pm for homeserver for course
3846:
3847: sub auto_run {
1.508 raeburn 3848: my ($cnum,$cdom) = @_;
3849: my $homeserver = &homeserver($cnum,$cdom);
1.511 raeburn 3850: my $response = &reply('autorun:'.$cdom,$homeserver);
1.506 raeburn 3851: return $response;
3852: }
3853:
3854: sub auto_get_sections {
1.508 raeburn 3855: my ($cnum,$cdom,$inst_coursecode) = @_;
3856: my $homeserver = &homeserver($cnum,$cdom);
1.506 raeburn 3857: my @secs = ();
1.511 raeburn 3858: my $response=&unescape(&reply('autogetsections:'.$inst_coursecode.':'.$cdom,$homeserver));
1.506 raeburn 3859: unless ($response eq 'refused') {
3860: @secs = split/:/,$response;
3861: }
3862: return @secs;
3863: }
3864:
3865: sub auto_new_course {
1.508 raeburn 3866: my ($cnum,$cdom,$inst_course_id,$owner) = @_;
3867: my $homeserver = &homeserver($cnum,$cdom);
1.515 raeburn 3868: my $response=&unescape(&reply('autonewcourse:'.$inst_course_id.':'.$owner.':'.$cdom,$homeserver));
1.506 raeburn 3869: return $response;
3870: }
3871:
3872: sub auto_validate_courseID {
1.508 raeburn 3873: my ($cnum,$cdom,$inst_course_id) = @_;
3874: my $homeserver = &homeserver($cnum,$cdom);
1.511 raeburn 3875: my $response=&unescape(&reply('autovalidatecourse:'.$inst_course_id.':'.$cdom,$homeserver));
1.506 raeburn 3876: return $response;
3877: }
3878:
3879: sub auto_create_password {
1.508 raeburn 3880: my ($cnum,$cdom,$authparam) = @_;
3881: my $homeserver = &homeserver($cnum,$cdom);
1.506 raeburn 3882: my $create_passwd = 0;
3883: my $authchk = '';
1.511 raeburn 3884: my $response=&unescape(&reply('autocreatepassword:'.$authparam.':'.$cdom,$homeserver));
1.506 raeburn 3885: if ($response eq 'refused') {
3886: $authchk = 'refused';
3887: } else {
3888: ($authparam,$create_passwd,$authchk) = split/:/,$response;
3889: }
3890: return ($authparam,$create_passwd,$authchk);
3891: }
3892:
1.706 raeburn 3893: sub auto_photo_permission {
3894: my ($cnum,$cdom,$students) = @_;
3895: my $homeserver = &homeserver($cnum,$cdom);
1.707 albertel 3896: my ($outcome,$perm_reqd,$conditions) =
3897: split(/:/,&unescape(&reply('autophotopermission:'.$cdom,$homeserver)),3);
1.709 albertel 3898: if ($outcome =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
3899: return (undef,undef);
3900: }
1.706 raeburn 3901: return ($outcome,$perm_reqd,$conditions);
3902: }
3903:
3904: sub auto_checkphotos {
3905: my ($uname,$udom,$pid) = @_;
3906: my $homeserver = &homeserver($uname,$udom);
3907: my ($result,$resulttype);
3908: my $outcome = &unescape(&reply('autophotocheck:'.&escape($udom).':'.
1.707 albertel 3909: &escape($uname).':'.&escape($pid),
3910: $homeserver));
1.709 albertel 3911: if ($outcome =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
3912: return (undef,undef);
3913: }
1.706 raeburn 3914: if ($outcome) {
3915: ($result,$resulttype) = split(/:/,$outcome);
3916: }
3917: return ($result,$resulttype);
3918: }
3919:
3920: sub auto_photochoice {
3921: my ($cnum,$cdom) = @_;
3922: my $homeserver = &homeserver($cnum,$cdom);
3923: my ($update,$comment) = split(/:/,&unescape(&reply('autophotochoice:'.
1.707 albertel 3924: &escape($cdom),
3925: $homeserver)));
1.709 albertel 3926: if ($update =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
3927: return (undef,undef);
3928: }
1.706 raeburn 3929: return ($update,$comment);
3930: }
3931:
3932: sub auto_photoupdate {
3933: my ($affiliatesref,$dom,$cnum,$photo) = @_;
3934: my $homeserver = &homeserver($cnum,$dom);
3935: my $host=$hostname{$homeserver};
3936: my $cmd = '';
3937: my $maxtries = 1;
3938: foreach (keys %{$affiliatesref}) {
3939: $cmd .= $_.'='.join(",",@{$$affiliatesref{$_}}).'%%';
3940: }
3941: $cmd =~ s/%%$//;
3942: $cmd = &escape($cmd);
3943: my $query = 'institutionalphotos';
3944: my $queryid=&reply("querysend:".$query.':'.$dom.':'.$cnum.':'.$cmd,$homeserver);
3945: unless ($queryid=~/^\Q$host\E\_/) {
3946: &logthis('institutionalphotos: invalid queryid: '.$queryid.' for host: '.$host.' and homeserver: '.$homeserver.' and course: '.$cnum);
3947: return 'error: '.$queryid;
3948: }
3949: my $reply = &get_query_reply($queryid);
3950: my $tries = 1;
3951: while (($reply=~/^timeout/) && ($tries < $maxtries)) {
3952: $reply = &get_query_reply($queryid);
3953: $tries ++;
3954: }
3955: if ( ($reply =~/^timeout/) || ($reply =~/^error/) ) {
3956: &logthis('institutionalphotos error: '.$reply.' for '.$dom.' '.$env{'user.name'}.' for '.$queryid.' course: '.$cnum.' maxtries: '.$maxtries.' tries: '.$tries);
3957: } else {
3958: my @responses = split(/:/,$reply);
3959: my $outcome = shift(@responses);
3960: foreach my $item (@responses) {
3961: my ($key,$value) = split(/=/,$item);
3962: $$photo{$key} = $value;
3963: }
3964: return $outcome;
3965: }
3966: return 'error';
3967: }
3968:
1.521 raeburn 3969: sub auto_instcode_format {
3970: my ($caller,$codedom,$instcodes,$codes,$codetitles,$cat_titles,$cat_order) = @_;
3971: my $courses = '';
3972: my $homeserver;
3973: if ($caller eq 'global') {
1.584 raeburn 3974: foreach my $tryserver (keys %libserv) {
3975: if ($hostdom{$tryserver} eq $codedom) {
3976: $homeserver = $tryserver;
3977: last;
3978: }
3979: }
1.620 albertel 3980: if (($env{'user.name'}) && ($env{'user.domain'} eq $codedom)) {
3981: $homeserver = &homeserver($env{'user.name'},$codedom);
1.584 raeburn 3982: }
1.521 raeburn 3983: } else {
3984: $homeserver = &homeserver($caller,$codedom);
3985: }
3986: foreach (keys %{$instcodes}) {
3987: $courses .= &escape($_).'='.&escape($$instcodes{$_}).'&';
3988: }
3989: chop($courses);
3990: my $response=&reply('autoinstcodeformat:'.$codedom.':'.$courses,$homeserver);
3991: unless ($response =~ /(con_lost|error|no_such_host|refused)/) {
3992: my ($codes_str,$codetitles_str,$cat_titles_str,$cat_order_str) = split/:/,$response;
3993: %{$codes} = &str2hash($codes_str);
3994: @{$codetitles} = &str2array($codetitles_str);
3995: %{$cat_titles} = &str2hash($cat_titles_str);
3996: %{$cat_order} = &str2hash($cat_order_str);
3997: return 'ok';
3998: }
3999: return $response;
4000: }
4001:
1.679 raeburn 4002: # ------------------------------------------------------- Course Group routines
4003:
4004: sub get_coursegroups {
1.683 raeburn 4005: my ($cdom,$cnum,$group) = @_;
4006: return(&dump('coursegroups',$cdom,$cnum,$group));
1.679 raeburn 4007: }
4008:
4009: sub modify_coursegroup {
4010: my ($cdom,$cnum,$groupsettings) = @_;
4011: return(&put('coursegroups',$groupsettings,$cdom,$cnum));
4012: }
4013:
4014: sub modify_group_roles {
4015: my ($cdom,$cnum,$group_id,$user,$end,$start,$userprivs) = @_;
4016: my $url = '/'.$cdom.'/'.$cnum.'/'.$group_id;
4017: my $role = 'gr/'.&escape($userprivs);
4018: my ($uname,$udom) = split(/:/,$user);
4019: my $result = &assignrole($udom,$uname,$url,$role,$end,$start);
1.684 raeburn 4020: if ($result eq 'ok') {
4021: &devalidate_getgroups_cache($udom,$uname,$cdom,$cnum);
4022: }
1.679 raeburn 4023: return $result;
4024: }
4025:
4026: sub modify_coursegroup_membership {
4027: my ($cdom,$cnum,$membership) = @_;
4028: my $result = &put('groupmembership',$membership,$cdom,$cnum);
4029: return $result;
4030: }
4031:
1.682 raeburn 4032: sub get_active_groups {
4033: my ($udom,$uname,$cdom,$cnum) = @_;
4034: my $now = time;
4035: my %groups = ();
4036: foreach my $key (keys(%env)) {
4037: if ($key =~ m-user\.role\.gr\./([^/]+)/([^/]+)/(\w+)$-) {
4038: my ($start,$end) = split(/\./,$env{$key});
4039: if (($end!=0) && ($end<$now)) { next; }
4040: if (($start!=0) && ($start>$now)) { next; }
4041: if ($1 eq $cdom && $2 eq $cnum) {
4042: $groups{$3} = $env{$key} ;
4043: }
4044: }
4045: }
4046: return %groups;
4047: }
4048:
1.683 raeburn 4049: sub get_group_membership {
4050: my ($cdom,$cnum,$group) = @_;
4051: return(&dump('groupmembership',$cdom,$cnum,$group));
4052: }
4053:
4054: sub get_users_groups {
4055: my ($udom,$uname,$courseid) = @_;
1.733 raeburn 4056: my @usersgroups;
1.683 raeburn 4057: my $cachetime=1800;
4058: $courseid=~s/\_/\//g;
4059: $courseid=~s/^(\w)/\/$1/;
4060:
4061: my $hashid="$udom:$uname:$courseid";
1.733 raeburn 4062: my ($grouplist,$cached)=&is_cached_new('getgroups',$hashid);
4063: if (defined($cached)) {
1.734 albertel 4064: @usersgroups = split(/:/,$grouplist);
1.733 raeburn 4065: } else {
4066: $grouplist = '';
4067: my %roleshash = &dump('roles',$udom,$uname,$courseid);
4068: my ($tmp) = keys(%roleshash);
4069: if ($tmp=~/^error:/) {
4070: &logthis('Error retrieving roles: '.$tmp.' for '.$uname.':'.$udom);
4071: } else {
4072: my $access_end = $env{'course.'.$courseid.
4073: '.default_enrollment_end_date'};
4074: my $now = time;
1.734 albertel 4075: foreach my $key (keys(%roleshash)) {
1.733 raeburn 4076: if ($key =~ /^\Q$courseid\E\/(\w+)\_gr$/) {
4077: my $group = $1;
4078: if ($roleshash{$key} =~ /_(\d+)_(\d+)$/) {
4079: my $start = $2;
4080: my $end = $1;
4081: if ($start == -1) { next; } # deleted from group
4082: if (($start!=0) && ($start>$now)) { next; }
4083: if (($end!=0) && ($end<$now)) {
4084: if ($access_end && $access_end < $now) {
4085: if ($access_end - $end < 86400) {
4086: push(@usersgroups,$group);
4087: }
4088: }
4089: next;
4090: }
4091: push(@usersgroups,$group);
4092: }
1.683 raeburn 4093: }
4094: }
1.733 raeburn 4095: @usersgroups = &sort_course_groups($courseid,@usersgroups);
4096: $grouplist = join(':',@usersgroups);
4097: &do_cache_new('getgroups',$hashid,$grouplist,$cachetime);
1.683 raeburn 4098: }
4099: }
1.733 raeburn 4100: return @usersgroups;
1.683 raeburn 4101: }
4102:
4103: sub devalidate_getgroups_cache {
4104: my ($udom,$uname,$cdom,$cnum)=@_;
4105: my $courseid = $cdom.'_'.$cnum;
4106: $courseid=~s/\_/\//g;
4107: $courseid=~s/^(\w)/\/$1/;
4108: my $hashid="$udom:$uname:$courseid";
4109: &devalidate_cache_new('getgroups',$hashid);
4110: }
4111:
1.12 www 4112: # ------------------------------------------------------------------ Plain Text
4113:
4114: sub plaintext {
1.742 raeburn 4115: my ($short,$type,$cid) = @_;
4116: if (!defined($cid)) {
4117: $cid = $env{'request.course.id'};
4118: }
4119: if (defined($cid) && defined($env{'course.'.$cid.'.'.$short.'.plaintext'})) {
4120: return &Apache::lonlocal::mt($env{'course.'.$cid.'.'.$short.
4121: '.plaintext'});
4122: }
4123: my %rolenames = (
4124: Course => 'std',
4125: Group => 'alt1',
4126: );
4127: if (defined($type) &&
4128: defined($rolenames{$type}) &&
4129: defined($prp{$short}{$rolenames{$type}})) {
4130: return &Apache::lonlocal::mt($prp{$short}{$rolenames{$type}});
4131: } else {
4132: return &Apache::lonlocal::mt($prp{$short}{'std'});
4133: }
1.12 www 4134: }
4135:
4136: # ----------------------------------------------------------------- Assign Role
4137:
4138: sub assignrole {
1.357 www 4139: my ($udom,$uname,$url,$role,$end,$start,$deleteflag)=@_;
1.21 www 4140: my $mrole;
4141: if ($role =~ /^cr\//) {
1.393 www 4142: my $cwosec=$url;
4143: $cwosec=~s/^\/(\w+)\/(\w+)\/.*/$1\/$2/;
4144: unless (&allowed('ccr',$cwosec)) {
1.104 www 4145: &logthis('Refused custom assignrole: '.
4146: $udom.' '.$uname.' '.$url.' '.$role.' '.$end.' '.$start.' by '.
1.620 albertel 4147: $env{'user.name'}.' at '.$env{'user.domain'});
1.104 www 4148: return 'refused';
4149: }
1.21 www 4150: $mrole='cr';
1.678 raeburn 4151: } elsif ($role =~ /^gr\//) {
4152: my $cwogrp=$url;
4153: $cwogrp=~s/^\/(\w+)\/(\w+)\/.*/$1\/$2/;
4154: unless (&allowed('mdg',$cwogrp)) {
4155: &logthis('Refused group assignrole: '.
4156: $udom.' '.$uname.' '.$url.' '.$role.' '.$end.' '.$start.' by '.
4157: $env{'user.name'}.' at '.$env{'user.domain'});
4158: return 'refused';
4159: }
4160: $mrole='gr';
1.21 www 4161: } else {
1.82 www 4162: my $cwosec=$url;
1.83 www 4163: $cwosec=~s/^\/(\w+)\/(\w+)\/.*/$1\/$2/;
1.373 www 4164: unless ((&allowed('c'.$role,$cwosec)) || &allowed('c'.$role,$udom)) {
1.104 www 4165: &logthis('Refused assignrole: '.
4166: $udom.' '.$uname.' '.$url.' '.$role.' '.$end.' '.$start.' by '.
1.620 albertel 4167: $env{'user.name'}.' at '.$env{'user.domain'});
1.104 www 4168: return 'refused';
4169: }
1.21 www 4170: $mrole=$role;
4171: }
1.620 albertel 4172: my $command="encrypt:rolesput:$env{'user.domain'}:$env{'user.name'}:".
1.21 www 4173: "$udom:$uname:$url".'_'."$mrole=$role";
1.81 www 4174: if ($end) { $command.='_'.$end; }
1.21 www 4175: if ($start) {
4176: if ($end) {
1.81 www 4177: $command.='_'.$start;
1.21 www 4178: } else {
1.81 www 4179: $command.='_0_'.$start;
1.21 www 4180: }
4181: }
1.739 raeburn 4182: my $origstart = $start;
4183: my $origend = $end;
1.357 www 4184: # actually delete
4185: if ($deleteflag) {
1.373 www 4186: if ((&allowed('dro',$udom)) || (&allowed('dro',$url))) {
1.357 www 4187: # modify command to delete the role
1.620 albertel 4188: $command="encrypt:rolesdel:$env{'user.domain'}:$env{'user.name'}:".
1.357 www 4189: "$udom:$uname:$url".'_'."$mrole";
1.620 albertel 4190: &logthis("$env{'user.name'} at $env{'user.domain'} deletes $mrole in $url for $uname at $udom");
1.357 www 4191: # set start and finish to negative values for userrolelog
4192: $start=-1;
4193: $end=-1;
4194: }
4195: }
4196: # send command
1.349 www 4197: my $answer=&reply($command,&homeserver($uname,$udom));
1.357 www 4198: # log new user role if status is ok
1.349 www 4199: if ($answer eq 'ok') {
1.663 raeburn 4200: &userrolelog($role,$uname,$udom,$url,$start,$end);
1.739 raeburn 4201: # for course roles, perform group memberships changes triggered by role change.
4202: unless ($role =~ /^gr/) {
4203: &Apache::longroup::group_changes($udom,$uname,$url,$role,$origend,
4204: $origstart);
4205: }
1.349 www 4206: }
4207: return $answer;
1.169 harris41 4208: }
4209:
4210: # -------------------------------------------------- Modify user authentication
1.197 www 4211: # Overrides without validation
4212:
1.169 harris41 4213: sub modifyuserauth {
4214: my ($udom,$uname,$umode,$upass)=@_;
4215: my $uhome=&homeserver($uname,$udom);
1.197 www 4216: unless (&allowed('mau',$udom)) { return 'refused'; }
4217: &logthis('Call to modify user authentication '.$udom.', '.$uname.', '.
1.620 albertel 4218: $umode.' by '.$env{'user.name'}.' at '.$env{'user.domain'}.
4219: ' in domain '.$env{'request.role.domain'});
1.169 harris41 4220: my $reply=&reply('encrypt:changeuserauth:'.$udom.':'.$uname.':'.$umode.':'.
4221: &escape($upass),$uhome);
1.620 albertel 4222: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},
1.197 www 4223: 'Authentication changed for '.$udom.', '.$uname.', '.$umode.
4224: '(Remote '.$ENV{'REMOTE_ADDR'}.'): '.$reply);
4225: &log($udom,,$uname,$uhome,
1.620 albertel 4226: 'Authentication changed by '.$env{'user.domain'}.', '.
4227: $env{'user.name'}.', '.$umode.
1.197 www 4228: '(Remote '.$ENV{'REMOTE_ADDR'}.'): '.$reply);
1.169 harris41 4229: unless ($reply eq 'ok') {
1.197 www 4230: &logthis('Authentication mode error: '.$reply);
1.169 harris41 4231: return 'error: '.$reply;
4232: }
1.170 harris41 4233: return 'ok';
1.80 www 4234: }
4235:
1.81 www 4236: # --------------------------------------------------------------- Modify a user
1.80 www 4237:
1.81 www 4238: sub modifyuser {
1.206 matthew 4239: my ($udom, $uname, $uid,
4240: $umode, $upass, $first,
4241: $middle, $last, $gene,
1.387 www 4242: $forceid, $desiredhome, $email)=@_;
1.198 www 4243: $udom=~s/\W//g;
4244: $uname=~s/\W//g;
1.81 www 4245: &logthis('Call to modify user '.$udom.', '.$uname.', '.$uid.', '.
1.80 www 4246: $umode.', '.$first.', '.$middle.', '.
1.206 matthew 4247: $last.', '.$gene.'(forceid: '.$forceid.')'.
4248: (defined($desiredhome) ? ' desiredhome = '.$desiredhome :
4249: ' desiredhome not specified').
1.620 albertel 4250: ' by '.$env{'user.name'}.' at '.$env{'user.domain'}.
4251: ' in domain '.$env{'request.role.domain'});
1.230 stredwic 4252: my $uhome=&homeserver($uname,$udom,'true');
1.80 www 4253: # ----------------------------------------------------------------- Create User
1.406 albertel 4254: if (($uhome eq 'no_host') &&
4255: (($umode && $upass) || ($umode eq 'localauth'))) {
1.80 www 4256: my $unhome='';
1.209 matthew 4257: if (defined($desiredhome) && $hostdom{$desiredhome} eq $udom) {
4258: $unhome = $desiredhome;
1.620 albertel 4259: } elsif($env{'course.'.$env{'request.course.id'}.'.domain'} eq $udom) {
4260: $unhome=$env{'course.'.$env{'request.course.id'}.'.home'};
1.209 matthew 4261: } else { # load balancing routine for determining $unhome
1.80 www 4262: my $tryserver;
1.81 www 4263: my $loadm=10000000;
1.80 www 4264: foreach $tryserver (keys %libserv) {
4265: if ($hostdom{$tryserver} eq $udom) {
4266: my $answer=reply('load',$tryserver);
4267: if (($answer=~/\d+/) && ($answer<$loadm)) {
4268: $loadm=$answer;
4269: $unhome=$tryserver;
4270: }
4271: }
4272: }
4273: }
4274: if (($unhome eq '') || ($unhome eq 'no_host')) {
1.206 matthew 4275: return 'error: unable to find a home server for '.$uname.
4276: ' in domain '.$udom;
1.80 www 4277: }
4278: my $reply=&reply('encrypt:makeuser:'.$udom.':'.$uname.':'.$umode.':'.
4279: &escape($upass),$unhome);
4280: unless ($reply eq 'ok') {
4281: return 'error: '.$reply;
4282: }
1.230 stredwic 4283: $uhome=&homeserver($uname,$udom,'true');
1.80 www 4284: if (($uhome eq '') || ($uhome eq 'no_host') || ($uhome ne $unhome)) {
1.386 matthew 4285: return 'error: unable verify users home machine.';
1.80 www 4286: }
1.209 matthew 4287: } # End of creation of new user
1.80 www 4288: # ---------------------------------------------------------------------- Add ID
4289: if ($uid) {
4290: $uid=~tr/A-Z/a-z/;
4291: my %uidhash=&idrget($udom,$uname);
1.196 www 4292: if (($uidhash{$uname}) && ($uidhash{$uname}!~/error\:/)
4293: && (!$forceid)) {
1.80 www 4294: unless ($uid eq $uidhash{$uname}) {
1.386 matthew 4295: return 'error: user id "'.$uid.'" does not match '.
4296: 'current user id "'.$uidhash{$uname}.'".';
1.80 www 4297: }
4298: } else {
4299: &idput($udom,($uname => $uid));
4300: }
4301: }
4302: # -------------------------------------------------------------- Add names, etc
1.313 matthew 4303: my @tmp=&get('environment',
1.134 albertel 4304: ['firstname','middlename','lastname','generation'],
4305: $udom,$uname);
1.313 matthew 4306: my %names;
4307: if ($tmp[0] =~ m/^error:.*/) {
4308: %names=();
4309: } else {
4310: %names = @tmp;
4311: }
1.388 www 4312: #
4313: # Make sure to not trash student environment if instructor does not bother
4314: # to supply name and email information
4315: #
4316: if ($first) { $names{'firstname'} = $first; }
1.385 matthew 4317: if (defined($middle)) { $names{'middlename'} = $middle; }
1.388 www 4318: if ($last) { $names{'lastname'} = $last; }
1.385 matthew 4319: if (defined($gene)) { $names{'generation'} = $gene; }
1.592 www 4320: if ($email) {
4321: $email=~s/[^\w\@\.\-\,]//gs;
4322: if ($email=~/\@/) { $names{'notification'} = $email;
4323: $names{'critnotification'} = $email;
4324: $names{'permanentemail'} = $email; }
4325: }
1.134 albertel 4326: my $reply = &put('environment', \%names, $udom,$uname);
4327: if ($reply ne 'ok') { return 'error: '.$reply; }
1.680 www 4328: &devalidate_cache_new('namescache',$uname.':'.$udom);
1.81 www 4329: &logthis('Success modifying user '.$udom.', '.$uname.', '.$uid.', '.
1.80 www 4330: $umode.', '.$first.', '.$middle.', '.
4331: $last.', '.$gene.' by '.
1.620 albertel 4332: $env{'user.name'}.' at '.$env{'user.domain'});
1.134 albertel 4333: return 'ok';
1.80 www 4334: }
4335:
1.81 www 4336: # -------------------------------------------------------------- Modify student
1.80 www 4337:
1.81 www 4338: sub modifystudent {
4339: my ($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene,$usec,
1.515 raeburn 4340: $end,$start,$forceid,$desiredhome,$email,$type,$locktype,$cid)=@_;
1.455 albertel 4341: if (!$cid) {
1.620 albertel 4342: unless ($cid=$env{'request.course.id'}) {
1.455 albertel 4343: return 'not_in_class';
4344: }
1.80 www 4345: }
4346: # --------------------------------------------------------------- Make the user
1.81 www 4347: my $reply=&modifyuser
1.209 matthew 4348: ($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene,$forceid,
1.387 www 4349: $desiredhome,$email);
1.80 www 4350: unless ($reply eq 'ok') { return $reply; }
1.297 matthew 4351: # This will cause &modify_student_enrollment to get the uid from the
4352: # students environment
4353: $uid = undef if (!$forceid);
1.455 albertel 4354: $reply = &modify_student_enrollment($udom,$uname,$uid,$first,$middle,$last,
1.515 raeburn 4355: $gene,$usec,$end,$start,$type,$locktype,$cid);
1.297 matthew 4356: return $reply;
4357: }
4358:
4359: sub modify_student_enrollment {
1.515 raeburn 4360: my ($udom,$uname,$uid,$first,$middle,$last,$gene,$usec,$end,$start,$type,$locktype,$cid) = @_;
1.455 albertel 4361: my ($cdom,$cnum,$chome);
4362: if (!$cid) {
1.620 albertel 4363: unless ($cid=$env{'request.course.id'}) {
1.455 albertel 4364: return 'not_in_class';
4365: }
1.620 albertel 4366: $cdom=$env{'course.'.$cid.'.domain'};
4367: $cnum=$env{'course.'.$cid.'.num'};
1.455 albertel 4368: } else {
4369: ($cdom,$cnum)=split(/_/,$cid);
4370: }
1.620 albertel 4371: $chome=$env{'course.'.$cid.'.home'};
1.455 albertel 4372: if (!$chome) {
1.457 raeburn 4373: $chome=&homeserver($cnum,$cdom);
1.297 matthew 4374: }
1.455 albertel 4375: if (!$chome) { return 'unknown_course'; }
1.297 matthew 4376: # Make sure the user exists
1.81 www 4377: my $uhome=&homeserver($uname,$udom);
4378: if (($uhome eq '') || ($uhome eq 'no_host')) {
4379: return 'error: no such user';
4380: }
1.297 matthew 4381: # Get student data if we were not given enough information
4382: if (!defined($first) || $first eq '' ||
4383: !defined($last) || $last eq '' ||
4384: !defined($uid) || $uid eq '' ||
4385: !defined($middle) || $middle eq '' ||
4386: !defined($gene) || $gene eq '') {
1.294 matthew 4387: # They did not supply us with enough data to enroll the student, so
4388: # we need to pick up more information.
1.297 matthew 4389: my %tmp = &get('environment',
1.294 matthew 4390: ['firstname','middlename','lastname', 'generation','id']
1.297 matthew 4391: ,$udom,$uname);
4392:
1.455 albertel 4393: #foreach (keys(%tmp)) {
4394: # &logthis("key $_ = ".$tmp{$_});
4395: #}
1.294 matthew 4396: $first = $tmp{'firstname'} if (!defined($first) || $first eq '');
4397: $middle = $tmp{'middlename'} if (!defined($middle) || $middle eq '');
4398: $last = $tmp{'lastname'} if (!defined($last) || $last eq '');
1.297 matthew 4399: $gene = $tmp{'generation'} if (!defined($gene) || $gene eq '');
1.294 matthew 4400: $uid = $tmp{'id'} if (!defined($uid) || $uid eq '');
4401: }
1.556 albertel 4402: my $fullname = &format_name($first,$middle,$last,$gene,'lastname');
1.487 albertel 4403: my $reply=cput('classlist',
4404: {"$uname:$udom" =>
1.515 raeburn 4405: join(':',$end,$start,$uid,$usec,$fullname,$type,$locktype) },
1.487 albertel 4406: $cdom,$cnum);
1.81 www 4407: unless (($reply eq 'ok') || ($reply eq 'delayed')) {
4408: return 'error: '.$reply;
1.652 albertel 4409: } else {
4410: &devalidate_getsection_cache($udom,$uname,$cid);
1.81 www 4411: }
1.297 matthew 4412: # Add student role to user
1.83 www 4413: my $uurl='/'.$cid;
1.81 www 4414: $uurl=~s/\_/\//g;
4415: if ($usec) {
4416: $uurl.='/'.$usec;
4417: }
4418: return &assignrole($udom,$uname,$uurl,'st',$end,$start);
1.21 www 4419: }
4420:
1.556 albertel 4421: sub format_name {
4422: my ($firstname,$middlename,$lastname,$generation,$first)=@_;
4423: my $name;
4424: if ($first ne 'lastname') {
4425: $name=$firstname.' '.$middlename.' '.$lastname.' '.$generation;
4426: } else {
4427: if ($lastname=~/\S/) {
4428: $name.= $lastname.' '.$generation.', '.$firstname.' '.$middlename;
4429: $name=~s/\s+,/,/;
4430: } else {
4431: $name.= $firstname.' '.$middlename.' '.$generation;
4432: }
4433: }
4434: $name=~s/^\s+//;
4435: $name=~s/\s+$//;
4436: $name=~s/\s+/ /g;
4437: return $name;
4438: }
4439:
1.84 www 4440: # ------------------------------------------------- Write to course preferences
4441:
4442: sub writecoursepref {
4443: my ($courseid,%prefs)=@_;
4444: $courseid=~s/^\///;
4445: $courseid=~s/\_/\//g;
4446: my ($cdomain,$cnum)=split(/\//,$courseid);
4447: my $chome=homeserver($cnum,$cdomain);
4448: if (($chome eq '') || ($chome eq 'no_host')) {
4449: return 'error: no such course';
4450: }
4451: my $cstring='';
1.191 harris41 4452: foreach (keys %prefs) {
1.84 www 4453: $cstring.=escape($_).'='.escape($prefs{$_}).'&';
1.191 harris41 4454: }
1.84 www 4455: $cstring=~s/\&$//;
4456: return reply('put:'.$cdomain.':'.$cnum.':environment:'.$cstring,$chome);
4457: }
4458:
4459: # ---------------------------------------------------------- Make/modify course
4460:
4461: sub createcourse {
1.741 raeburn 4462: my ($udom,$description,$url,$course_server,$nonstandard,$inst_code,
4463: $course_owner,$crstype)=@_;
1.84 www 4464: $url=&declutter($url);
4465: my $cid='';
1.264 matthew 4466: unless (&allowed('ccc',$udom)) {
1.84 www 4467: return 'refused';
4468: }
4469: # ------------------------------------------------------------------- Create ID
1.674 www 4470: my $uname=int(1+rand(9)).
4471: ('a'..'z','A'..'Z','0'..'9')[int(rand(62))].
4472: substr($$.time,0,5).unpack("H8",pack("I32",time)).
1.84 www 4473: unpack("H2",pack("I32",int(rand(255)))).$perlvar{'lonHostID'};
4474: # ----------------------------------------------- Make sure that does not exist
1.230 stredwic 4475: my $uhome=&homeserver($uname,$udom,'true');
1.84 www 4476: unless (($uhome eq '') || ($uhome eq 'no_host')) {
4477: $uname=substr($$.time,0,5).unpack("H8",pack("I32",time)).
4478: unpack("H2",pack("I32",int(rand(255)))).$perlvar{'lonHostID'};
1.230 stredwic 4479: $uhome=&homeserver($uname,$udom,'true');
1.84 www 4480: unless (($uhome eq '') || ($uhome eq 'no_host')) {
4481: return 'error: unable to generate unique course-ID';
4482: }
4483: }
1.264 matthew 4484: # ------------------------------------------------ Check supplied server name
1.620 albertel 4485: $course_server = $env{'user.homeserver'} if (! defined($course_server));
1.264 matthew 4486: if (! exists($libserv{$course_server})) {
4487: return 'error:bad server name '.$course_server;
4488: }
1.84 www 4489: # ------------------------------------------------------------- Make the course
4490: my $reply=&reply('encrypt:makeuser:'.$udom.':'.$uname.':none::',
1.264 matthew 4491: $course_server);
1.84 www 4492: unless ($reply eq 'ok') { return 'error: '.$reply; }
1.230 stredwic 4493: $uhome=&homeserver($uname,$udom,'true');
1.84 www 4494: if (($uhome eq '') || ($uhome eq 'no_host')) {
4495: return 'error: no such course';
4496: }
1.271 www 4497: # ----------------------------------------------------------------- Course made
1.516 raeburn 4498: # log existence
4499: &courseidput($udom,&escape($udom.'_'.$uname).'='.&escape($description).
1.741 raeburn 4500: ':'.&escape($inst_code).':'.&escape($course_owner).':'.
4501: &escape($crstype),$uhome);
1.358 www 4502: &flushcourselogs();
4503: # set toplevel url
1.271 www 4504: my $topurl=$url;
4505: unless ($nonstandard) {
4506: # ------------------------------------------ For standard courses, make top url
4507: my $mapurl=&clutter($url);
1.278 www 4508: if ($mapurl eq '/res/') { $mapurl=''; }
1.620 albertel 4509: $env{'form.initmap'}=(<<ENDINITMAP);
1.271 www 4510: <map>
4511: <resource id="1" type="start"></resource>
4512: <resource id="2" src="$mapurl"></resource>
4513: <resource id="3" type="finish"></resource>
4514: <link index="1" from="1" to="2"></link>
4515: <link index="2" from="2" to="3"></link>
4516: </map>
4517: ENDINITMAP
4518: $topurl=&declutter(
1.638 albertel 4519: &finishuserfileupload($uname,$udom,'initmap','default.sequence')
1.271 www 4520: );
4521: }
4522: # ----------------------------------------------------------- Write preferences
1.84 www 4523: &writecoursepref($udom.'_'.$uname,
4524: ('description' => $description,
1.271 www 4525: 'url' => $topurl));
1.84 www 4526: return '/'.$udom.'/'.$uname;
4527: }
4528:
1.21 www 4529: # ---------------------------------------------------------- Assign Custom Role
4530:
4531: sub assigncustomrole {
1.357 www 4532: my ($udom,$uname,$url,$rdom,$rnam,$rolename,$end,$start,$deleteflag)=@_;
1.21 www 4533: return &assignrole($udom,$uname,$url,'cr/'.$rdom.'/'.$rnam.'/'.$rolename,
1.357 www 4534: $end,$start,$deleteflag);
1.21 www 4535: }
4536:
4537: # ----------------------------------------------------------------- Revoke Role
4538:
4539: sub revokerole {
1.357 www 4540: my ($udom,$uname,$url,$role,$deleteflag)=@_;
1.21 www 4541: my $now=time;
1.357 www 4542: return &assignrole($udom,$uname,$url,$role,$now,$deleteflag);
1.21 www 4543: }
4544:
4545: # ---------------------------------------------------------- Revoke Custom Role
4546:
4547: sub revokecustomrole {
1.357 www 4548: my ($udom,$uname,$url,$rdom,$rnam,$rolename,$deleteflag)=@_;
1.21 www 4549: my $now=time;
1.357 www 4550: return &assigncustomrole($udom,$uname,$url,$rdom,$rnam,$rolename,$now,
4551: $deleteflag);
1.17 www 4552: }
4553:
1.533 banghart 4554: # ------------------------------------------------------------ Disk usage
1.535 albertel 4555: sub diskusage {
1.533 banghart 4556: my ($udom,$uname,$directoryRoot)=@_;
4557: $directoryRoot =~ s/\/$//;
1.535 albertel 4558: my $listing=&reply('du:'.$directoryRoot,homeserver($uname,$udom));
1.514 albertel 4559: return $listing;
1.512 banghart 4560: }
4561:
1.566 banghart 4562: sub is_locked {
4563: my ($file_name, $domain, $user) = @_;
4564: my @check;
4565: my $is_locked;
4566: push @check, $file_name;
1.613 albertel 4567: my %locked = &get('file_permissions',\@check,
1.620 albertel 4568: $env{'user.domain'},$env{'user.name'});
1.615 albertel 4569: my ($tmp)=keys(%locked);
4570: if ($tmp=~/^error:/) { undef(%locked); }
1.745 raeburn 4571:
1.566 banghart 4572: if (ref($locked{$file_name}) eq 'ARRAY') {
1.745 raeburn 4573: $is_locked = 'false';
4574: foreach my $entry (@{$locked{$file_name}}) {
4575: if (ref($entry) eq 'ARRAY') {
1.746 raeburn 4576: $is_locked = 'true';
4577: last;
1.745 raeburn 4578: }
4579: }
1.566 banghart 4580: } else {
4581: $is_locked = 'false';
4582: }
4583: }
4584:
1.559 banghart 4585: # ------------------------------------------------------------- Mark as Read Only
4586:
4587: sub mark_as_readonly {
4588: my ($domain,$user,$files,$what) = @_;
1.613 albertel 4589: my %current_permissions = &dump('file_permissions',$domain,$user);
1.615 albertel 4590: my ($tmp)=keys(%current_permissions);
4591: if ($tmp=~/^error:/) { undef(%current_permissions); }
1.560 banghart 4592: foreach my $file (@{$files}) {
1.561 banghart 4593: push(@{$current_permissions{$file}},$what);
1.559 banghart 4594: }
1.613 albertel 4595: &put('file_permissions',\%current_permissions,$domain,$user);
1.559 banghart 4596: return;
4597: }
4598:
1.572 banghart 4599: # ------------------------------------------------------------Save Selected Files
4600:
4601: sub save_selected_files {
4602: my ($user, $path, @files) = @_;
4603: my $filename = $user."savedfiles";
1.573 banghart 4604: my @other_files = &files_not_in_path($user, $path);
1.574 banghart 4605: open (OUT, '>'.$Apache::lonnet::perlvar{'lonDaemons'}.'/tmp/'.$filename);
1.573 banghart 4606: foreach my $file (@files) {
1.620 albertel 4607: print (OUT $env{'form.currentpath'}.$file."\n");
1.573 banghart 4608: }
4609: foreach my $file (@other_files) {
1.574 banghart 4610: print (OUT $file."\n");
1.572 banghart 4611: }
1.574 banghart 4612: close (OUT);
1.572 banghart 4613: return 'ok';
4614: }
4615:
1.574 banghart 4616: sub clear_selected_files {
4617: my ($user) = @_;
4618: my $filename = $user."savedfiles";
4619: open (OUT, '>'.$Apache::lonnet::perlvar{'lonDaemons'}.'/tmp/'.$filename);
4620: print (OUT undef);
4621: close (OUT);
4622: return ("ok");
4623: }
4624:
1.572 banghart 4625: sub files_in_path {
4626: my ($user, $path) = @_;
4627: my $filename = $user."savedfiles";
4628: my %return_files;
1.574 banghart 4629: open (IN, '<'.$Apache::lonnet::perlvar{'lonDaemons'}.'/tmp/'.$filename);
1.573 banghart 4630: while (my $line_in = <IN>) {
1.574 banghart 4631: chomp ($line_in);
4632: my @paths_and_file = split (m!/!, $line_in);
4633: my $file_part = pop (@paths_and_file);
4634: my $path_part = join ('/', @paths_and_file);
1.573 banghart 4635: $path_part.='/';
4636: my $path_and_file = $path_part.$file_part;
4637: if ($path_part eq $path) {
4638: $return_files{$file_part}= 'selected';
4639: }
4640: }
1.574 banghart 4641: close (IN);
4642: return (\%return_files);
1.572 banghart 4643: }
4644:
4645: # called in portfolio select mode, to show files selected NOT in current directory
4646: sub files_not_in_path {
4647: my ($user, $path) = @_;
4648: my $filename = $user."savedfiles";
4649: my @return_files;
4650: my $path_part;
1.574 banghart 4651: open (IN, '<'.$Apache::lonnet::perlvar{'lonDaemons'}.'/tmp/'.$filename);
1.572 banghart 4652: while (<IN>) {
4653: #ok, I know it's clunky, but I want it to work
4654: my @paths_and_file = split m!/!, $_;
1.574 banghart 4655: my $file_part = pop (@paths_and_file);
4656: chomp ($file_part);
4657: my $path_part = join ('/', @paths_and_file);
1.572 banghart 4658: $path_part .= '/';
4659: my $path_and_file = $path_part.$file_part;
4660: if ($path_part ne $path) {
1.574 banghart 4661: push (@return_files, ($path_and_file));
1.572 banghart 4662: }
4663: }
1.574 banghart 4664: close (OUT);
4665: return (@return_files);
1.572 banghart 4666: }
4667:
1.745 raeburn 4668: #----------------------------------------------Get portfolio file permissions
1.629 banghart 4669:
1.745 raeburn 4670: sub get_portfile_permissions {
4671: my ($domain,$user) = @_;
1.613 albertel 4672: my %current_permissions = &dump('file_permissions',$domain,$user);
1.615 albertel 4673: my ($tmp)=keys(%current_permissions);
4674: if ($tmp=~/^error:/) { undef(%current_permissions); }
1.745 raeburn 4675: return \%current_permissions;
4676: }
4677:
4678: #---------------------------------------------Get portfolio file access controls
4679:
1.749 raeburn 4680: sub get_access_controls {
1.745 raeburn 4681: my ($current_permissions,$group,$file) = @_;
4682: my %access;
4683: if (defined($file)) {
1.749 raeburn 4684: if (ref($$current_permissions{$file."\0".'accesscontrol'}) eq 'HASH') {
4685: foreach my $control (keys(%{$$current_permissions{$file."\0".'accesscontrol'}})) {
4686: $access{$file}{$control} = $$current_permissions{$file."\0".$control};
4687: }
4688: }
1.745 raeburn 4689: } else {
1.749 raeburn 4690: foreach my $key (keys(%{$current_permissions})) {
4691: if ($key =~ /\0accesscontrol$/) {
4692: if (defined($group)) {
4693: if ($key !~ m-^\Q$group\E/-) {
4694: next;
4695: }
4696: }
4697: my ($fullpath) = split(/\0/,$key);
4698: if (ref($$current_permissions{$key}) eq 'HASH') {
4699: foreach my $control (keys(%{$$current_permissions{$key}})) {
4700: $access{$fullpath}{$control}=$$current_permissions{$fullpath."\0".$control};
4701: }
4702: }
4703: }
4704: }
4705: }
4706: return %access;
4707: }
4708:
4709: sub parse_access_controls {
4710: my ($access_item) = @_;
4711: my %content;
1.752 raeburn 4712: my $role_id;
4713: my $user;
4714: my $usercount;
1.749 raeburn 4715: my $token;
4716: my $parser=HTML::TokeParser->new(\$access_item);
4717: while ($token=$parser->get_token) {
4718: if ($token->[0] eq 'S') {
4719: my $entry=$token->[1];
4720: if ($entry eq 'scope') {
4721: my $type = $token->[2]{'type'};
1.752 raeburn 4722: if (($type eq 'course') || ($type eq 'group')) {
1.753 albertel 4723: $content{'roles'} = {};
1.752 raeburn 4724: }
4725: } elsif ($entry eq 'roles') {
4726: $role_id = $token->[2]{id};
1.754 albertel 4727: $content{$entry}{$role_id} = {
1.753 albertel 4728: role => [],
1.752 raeburn 4729: access => [],
4730: section => [],
4731: group => [],
1.754 albertel 4732: };
1.752 raeburn 4733: } elsif ($entry eq 'users') {
1.753 albertel 4734: $content{'users'} = {};
1.752 raeburn 4735: $usercount = 0;
4736: } elsif ($entry eq 'user') {
4737: $user = '';
1.749 raeburn 4738: } else {
4739: my $value=$parser->get_text('/'.$entry);
1.752 raeburn 4740: if ($entry eq 'uname') {
4741: $user = $value;
4742: } elsif ($entry eq 'udom') {
4743: $user .= ':'.$value;
4744: $content{'users'}{$user} = $usercount;
4745: } elsif ($entry eq 'role' ||
4746: $entry eq 'access' ||
4747: $entry eq 'section' ||
4748: $entry eq 'group') {
4749: if ($role_id ne '') {
4750: push(@{$content{'roles'}{$role_id}{$entry}},$value);
4751: }
4752: } elsif ($entry eq 'dom') {
4753: push(@{$content{$entry}},$value);
4754: } else {
4755: $content{$entry}=$value;
4756: }
4757: }
4758: } elsif ($token->[0] eq 'E') {
4759: if ($token->[1] eq 'user') {
4760: $user = '';
4761: $usercount ++;
4762: } elsif ($token->[1] eq 'roles') {
4763: $role_id = '';
1.749 raeburn 4764: }
4765: }
1.745 raeburn 4766: }
1.749 raeburn 4767: return %content;
4768: }
4769:
4770: sub modify_access_controls {
4771: my ($file_name,$changes,$domain,$user)=@_;
4772: my ($outcome,$deloutcome);
4773: my %store_permissions;
4774: my %new_values;
4775: my %new_control;
4776: my %translation;
4777: my @deletions = ();
4778: my $now = time;
4779: if (exists($$changes{'activate'})) {
4780: if (ref($$changes{'activate'}) eq 'HASH') {
4781: my @newitems = sort(keys(%{$$changes{'activate'}}));
4782: my $numnew = scalar(@newitems);
4783: for (my $i=0; $i<$numnew; $i++) {
4784: my $newkey = $newitems[$i];
4785: my $newid = &Apache::loncommon::get_cgi_id();
4786: $newkey =~ s/^(\d+)/$newid/;
4787: $translation{$1} = $newid;
4788: $new_values{$file_name."\0".$newkey} =
4789: $$changes{'activate'}{$newitems[$i]};
4790: $new_control{$newkey} = $now;
4791: }
4792: }
4793: }
4794: my %todelete;
4795: my %changed_items;
4796: foreach my $action ('delete','update') {
4797: if (exists($$changes{$action})) {
4798: if (ref($$changes{$action}) eq 'HASH') {
4799: foreach my $key (keys(%{$$changes{$action}})) {
4800: my ($itemnum) = ($key =~ /^([^:]+):/);
4801: if ($action eq 'delete') {
4802: $todelete{$itemnum} = 1;
4803: } else {
4804: $changed_items{$itemnum} = $key;
4805: }
4806: }
1.745 raeburn 4807: }
4808: }
1.749 raeburn 4809: }
4810: # get lock on access controls for file.
4811: my $lockhash = {
4812: $file_name."\0".'locked_access_records' => $env{'user.name'}.
4813: ':'.$env{'user.domain'},
4814: };
4815: my $tries = 0;
4816: my $gotlock = &newput('file_permissions',$lockhash,$domain,$user);
4817:
4818: while (($gotlock ne 'ok') && $tries <3) {
4819: $tries ++;
4820: sleep 1;
4821: $gotlock = &newput('file_permissions',$lockhash,$domain,$user);
4822: }
4823: if ($gotlock eq 'ok') {
4824: my %curr_permissions = &dump('file_permissions',$domain,$user,$file_name);
4825: my ($tmp)=keys(%curr_permissions);
4826: if ($tmp=~/^error:/) { undef(%curr_permissions); }
4827: if (exists($curr_permissions{$file_name."\0".'accesscontrol'})) {
4828: my $curr_controls = $curr_permissions{$file_name."\0".'accesscontrol'};
4829: if (ref($curr_controls) eq 'HASH') {
4830: foreach my $control_item (keys(%{$curr_controls})) {
4831: my ($itemnum) = ($control_item =~ /^([^:]+):/);
4832: if (defined($todelete{$itemnum})) {
4833: push(@deletions,$file_name."\0".$control_item);
4834: } else {
4835: if (defined($changed_items{$itemnum})) {
4836: $new_control{$changed_items{$itemnum}} = $now;
4837: push(@deletions,$file_name."\0".$control_item);
4838: $new_values{$file_name."\0".$changed_items{$itemnum}} = $$changes{'update'}{$changed_items{$itemnum}};
4839: } else {
4840: $new_control{$control_item} = $$curr_controls{$control_item};
4841: }
4842: }
1.745 raeburn 4843: }
4844: }
4845: }
1.749 raeburn 4846: $deloutcome = &del('file_permissions',\@deletions,$domain,$user);
4847: $new_values{$file_name."\0".'accesscontrol'} = \%new_control;
4848: $outcome = &put('file_permissions',\%new_values,$domain,$user);
4849: # remove lock
4850: my @del_lock = ($file_name."\0".'locked_access_records');
4851: my $dellockoutcome = &del('file_permissions',\@del_lock,$domain,$user);
4852: } else {
4853: $outcome = "error: could not obtain lockfile\n";
1.745 raeburn 4854: }
1.749 raeburn 4855: return ($outcome,$deloutcome,\%new_values,\%translation);
1.745 raeburn 4856: }
4857:
4858: #------------------------------------------------------Get Marked as Read Only
4859:
4860: sub get_marked_as_readonly {
4861: my ($domain,$user,$what,$group) = @_;
4862: my $current_permissions = &get_portfile_permissions($domain,$user);
1.563 banghart 4863: my @readonly_files;
1.629 banghart 4864: my $cmp1=$what;
4865: if (ref($what)) { $cmp1=join('',@{$what}) };
1.745 raeburn 4866: while (my ($file_name,$value) = each(%{$current_permissions})) {
4867: if (defined($group)) {
4868: if ($file_name !~ m-^\Q$group\E/-) {
4869: next;
4870: }
4871: }
1.561 banghart 4872: if (ref($value) eq "ARRAY"){
4873: foreach my $stored_what (@{$value}) {
1.629 banghart 4874: my $cmp2=$stored_what;
1.749 raeburn 4875: if (ref($stored_what eq 'ARRAY')) {
1.746 raeburn 4876: $cmp2=join('',@{$stored_what});
1.745 raeburn 4877: }
1.629 banghart 4878: if ($cmp1 eq $cmp2) {
1.561 banghart 4879: push(@readonly_files, $file_name);
1.745 raeburn 4880: last;
1.563 banghart 4881: } elsif (!defined($what)) {
4882: push(@readonly_files, $file_name);
1.745 raeburn 4883: last;
1.561 banghart 4884: }
4885: }
1.745 raeburn 4886: }
1.561 banghart 4887: }
4888: return @readonly_files;
4889: }
1.577 banghart 4890: #-----------------------------------------------------------Get Marked as Read Only Hash
1.561 banghart 4891:
1.577 banghart 4892: sub get_marked_as_readonly_hash {
1.745 raeburn 4893: my ($current_permissions,$group,$what) = @_;
1.577 banghart 4894: my %readonly_files;
1.745 raeburn 4895: while (my ($file_name,$value) = each(%{$current_permissions})) {
4896: if (defined($group)) {
4897: if ($file_name !~ m-^\Q$group\E/-) {
4898: next;
4899: }
4900: }
1.577 banghart 4901: if (ref($value) eq "ARRAY"){
4902: foreach my $stored_what (@{$value}) {
1.745 raeburn 4903: if (ref($stored_what) eq 'ARRAY') {
1.750 banghart 4904: foreach my $lock_descriptor(@{$stored_what}) {
4905: if ($lock_descriptor eq 'graded') {
4906: $readonly_files{$file_name} = 'graded';
4907: } elsif ($lock_descriptor eq 'handback') {
4908: $readonly_files{$file_name} = 'handback';
4909: } else {
4910: if (!exists($readonly_files{$file_name})) {
4911: $readonly_files{$file_name} = 'locked';
4912: }
4913: }
1.745 raeburn 4914: }
1.750 banghart 4915: }
1.577 banghart 4916: }
4917: }
4918: }
4919: return %readonly_files;
4920: }
1.559 banghart 4921: # ------------------------------------------------------------ Unmark as Read Only
4922:
4923: sub unmark_as_readonly {
1.629 banghart 4924: # unmarks $file_name (if $file_name is defined), or all files locked by $what
4925: # for portfolio submissions, $what contains [$symb,$crsid]
1.745 raeburn 4926: my ($domain,$user,$what,$file_name,$group) = @_;
1.634 albertel 4927: my $symb_crs = $what;
4928: if (ref($what)) { $symb_crs=join('',@$what); }
1.745 raeburn 4929: my %current_permissions = &dump('file_permissions',$domain,$user,$group);
1.615 albertel 4930: my ($tmp)=keys(%current_permissions);
4931: if ($tmp=~/^error:/) { undef(%current_permissions); }
1.745 raeburn 4932: my @readonly_files = &get_marked_as_readonly($domain,$user,$what,$group);
1.650 albertel 4933: foreach my $file (@readonly_files) {
4934: if (defined($file_name) && ($file_name ne $file)) { next; }
4935: my $current_locks = $current_permissions{$file};
1.563 banghart 4936: my @new_locks;
4937: my @del_keys;
4938: if (ref($current_locks) eq "ARRAY"){
4939: foreach my $locker (@{$current_locks}) {
1.632 albertel 4940: my $compare=$locker;
1.749 raeburn 4941: if (ref($locker) eq 'ARRAY') {
1.745 raeburn 4942: $compare=join('',@{$locker});
1.746 raeburn 4943: if ($compare ne $symb_crs) {
4944: push(@new_locks, $locker);
4945: }
1.563 banghart 4946: }
4947: }
1.650 albertel 4948: if (scalar(@new_locks) > 0) {
1.563 banghart 4949: $current_permissions{$file} = \@new_locks;
4950: } else {
4951: push(@del_keys, $file);
1.613 albertel 4952: &del('file_permissions',\@del_keys, $domain, $user);
1.650 albertel 4953: delete($current_permissions{$file});
1.563 banghart 4954: }
4955: }
1.561 banghart 4956: }
1.613 albertel 4957: &put('file_permissions',\%current_permissions,$domain,$user);
1.559 banghart 4958: return;
4959: }
1.512 banghart 4960:
1.17 www 4961: # ------------------------------------------------------------ Directory lister
4962:
4963: sub dirlist {
1.253 stredwic 4964: my ($uri,$userdomain,$username,$alternateDirectoryRoot)=@_;
4965:
1.18 www 4966: $uri=~s/^\///;
4967: $uri=~s/\/$//;
1.253 stredwic 4968: my ($udom, $uname);
4969: (undef,$udom,$uname)=split(/\//,$uri);
4970: if(defined($userdomain)) {
4971: $udom = $userdomain;
4972: }
4973: if(defined($username)) {
4974: $uname = $username;
4975: }
4976:
4977: my $dirRoot = $perlvar{'lonDocRoot'};
4978: if(defined($alternateDirectoryRoot)) {
4979: $dirRoot = $alternateDirectoryRoot;
4980: $dirRoot =~ s/\/$//;
1.751 banghart 4981: }
1.253 stredwic 4982:
4983: if($udom) {
4984: if($uname) {
1.605 matthew 4985: my $listing=reply('ls2:'.$dirRoot.'/'.$uri,
1.253 stredwic 4986: homeserver($uname,$udom));
1.605 matthew 4987: my @listing_results;
4988: if ($listing eq 'unknown_cmd') {
4989: $listing=reply('ls:'.$dirRoot.'/'.$uri,
4990: homeserver($uname,$udom));
4991: @listing_results = split(/:/,$listing);
4992: } else {
4993: @listing_results = map { &unescape($_); } split(/:/,$listing);
4994: }
4995: return @listing_results;
1.253 stredwic 4996: } elsif(!defined($alternateDirectoryRoot)) {
4997: my $tryserver;
4998: my %allusers=();
4999: foreach $tryserver (keys %libserv) {
5000: if($hostdom{$tryserver} eq $udom) {
1.605 matthew 5001: my $listing=reply('ls2:'.$perlvar{'lonDocRoot'}.'/res/'.
1.253 stredwic 5002: $udom, $tryserver);
1.605 matthew 5003: my @listing_results;
5004: if ($listing eq 'unknown_cmd') {
5005: $listing=reply('ls:'.$perlvar{'lonDocRoot'}.'/res/'.
5006: $udom, $tryserver);
5007: @listing_results = split(/:/,$listing);
5008: } else {
5009: @listing_results =
5010: map { &unescape($_); } split(/:/,$listing);
5011: }
5012: if ($listing_results[0] ne 'no_such_dir' &&
5013: $listing_results[0] ne 'empty' &&
5014: $listing_results[0] ne 'con_lost') {
5015: foreach (@listing_results) {
1.253 stredwic 5016: my ($entry,@stat)=split(/&/,$_);
5017: $allusers{$entry}=1;
5018: }
5019: }
1.191 harris41 5020: }
1.253 stredwic 5021: }
5022: my $alluserstr='';
5023: foreach (sort keys %allusers) {
5024: $alluserstr.=$_.'&user:';
5025: }
5026: $alluserstr=~s/:$//;
5027: return split(/:/,$alluserstr);
5028: } else {
5029: my @emptyResults = ();
5030: push(@emptyResults, 'missing user name');
5031: return split(':',@emptyResults);
5032: }
5033: } elsif(!defined($alternateDirectoryRoot)) {
5034: my $tryserver;
5035: my %alldom=();
5036: foreach $tryserver (keys %libserv) {
5037: $alldom{$hostdom{$tryserver}}=1;
5038: }
5039: my $alldomstr='';
5040: foreach (sort keys %alldom) {
1.397 albertel 5041: $alldomstr.=$perlvar{'lonDocRoot'}.'/res/'.$_.'/&domain:';
1.253 stredwic 5042: }
5043: $alldomstr=~s/:$//;
5044: return split(/:/,$alldomstr);
5045: } else {
5046: my @emptyResults = ();
5047: push(@emptyResults, 'missing domain');
5048: return split(':',@emptyResults);
1.275 stredwic 5049: }
5050: }
5051:
5052: # --------------------------------------------- GetFileTimestamp
5053: # This function utilizes dirlist and returns the date stamp for
5054: # when it was last modified. It will also return an error of -1
5055: # if an error occurs
5056:
1.410 matthew 5057: ##
5058: ## FIXME: This subroutine assumes its caller knows something about the
5059: ## directory structure of the home server for the student ($root).
5060: ## Not a good assumption to make. Since this is for looking up files
5061: ## in user directories, the full path should be constructed by lond, not
5062: ## whatever machine we request data from.
5063: ##
1.275 stredwic 5064: sub GetFileTimestamp {
5065: my ($studentDomain,$studentName,$filename,$root)=@_;
5066: $studentDomain=~s/\W//g;
5067: $studentName=~s/\W//g;
5068: my $subdir=$studentName.'__';
5069: $subdir =~ s/(.)(.)(.).*/$1\/$2\/$3/;
5070: my $proname="$studentDomain/$subdir/$studentName";
5071: $proname .= '/'.$filename;
1.375 matthew 5072: my ($fileStat) = &Apache::lonnet::dirlist($proname, $studentDomain,
5073: $studentName, $root);
1.275 stredwic 5074: my @stats = split('&', $fileStat);
5075: if($stats[0] ne 'empty' && $stats[0] ne 'no_such_dir') {
1.375 matthew 5076: # @stats contains first the filename, then the stat output
5077: return $stats[10]; # so this is 10 instead of 9.
1.275 stredwic 5078: } else {
5079: return -1;
1.253 stredwic 5080: }
1.26 www 5081: }
5082:
1.712 albertel 5083: sub stat_file {
5084: my ($uri) = @_;
1.722 albertel 5085: $uri = &clutter($uri);
5086:
5087: # we want just the url part without the unneeded accessor url bits
1.723 banghart 5088: if ($uri =~ m-^/adm/-) {
5089: $uri=~s-^/adm/wrapper/-/-;
5090: $uri=~s-^/adm/coursedocs/showdoc/-/-;
1.722 albertel 5091: }
1.712 albertel 5092: my ($udom,$uname,$file,$dir);
5093: if ($uri =~ m-^/(uploaded|editupload)/-) {
5094: ($udom,$uname,$file) =
5095: ($uri =~ m-/(?:uploaded|editupload)/?([^/]*)/?([^/]*)/?(.*)-);
5096: $file = 'userfiles/'.$file;
1.740 www 5097: $dir = &propath($udom,$uname);
1.712 albertel 5098: }
5099: if ($uri =~ m-^/res/-) {
5100: ($udom,$uname) =
5101: ($uri =~ m-/(?:res)/?([^/]*)/?([^/]*)/-);
5102: $file = $uri;
5103: }
5104:
5105: if (!$udom || !$uname || !$file) {
5106: # unable to handle the uri
5107: return ();
5108: }
5109:
5110: my ($result) = &dirlist($file,$udom,$uname,$dir);
5111: my @stats = split('&', $result);
1.721 banghart 5112:
1.712 albertel 5113: if($stats[0] ne 'empty' && $stats[0] ne 'no_such_dir') {
5114: shift(@stats); #filename is first
5115: return @stats;
5116: }
5117: return ();
5118: }
5119:
1.26 www 5120: # -------------------------------------------------------- Value of a Condition
5121:
1.713 albertel 5122: # gets the value of a specific preevaluated condition
5123: # stored in the string $env{user.state.<cid>}
5124: # or looks up a condition reference in the bighash and if if hasn't
5125: # already been evaluated recurses into docondval to get the value of
5126: # the condition, then memoizing it to
5127: # $env{user.state.<cid>.<condition>}
1.40 www 5128: sub directcondval {
5129: my $number=shift;
1.620 albertel 5130: if (!defined($env{'user.state.'.$env{'request.course.id'}})) {
1.555 albertel 5131: &Apache::lonuserstate::evalstate();
5132: }
1.713 albertel 5133: if (exists($env{'user.state.'.$env{'request.course.id'}.".$number"})) {
5134: return $env{'user.state.'.$env{'request.course.id'}.".$number"};
5135: } elsif ($number =~ /^_/) {
5136: my $sub_condition;
5137: if (tie(my %bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
5138: &GDBM_READER(),0640)) {
5139: $sub_condition=$bighash{'conditions'.$number};
5140: untie(%bighash);
5141: }
5142: my $value = &docondval($sub_condition);
5143: &appenv('user.state.'.$env{'request.course.id'}.".$number" => $value);
5144: return $value;
5145: }
1.620 albertel 5146: if ($env{'user.state.'.$env{'request.course.id'}}) {
5147: return substr($env{'user.state.'.$env{'request.course.id'}},$number,1);
1.40 www 5148: } else {
5149: return 2;
5150: }
5151: }
5152:
1.713 albertel 5153: # get the collection of conditions for this resource
1.26 www 5154: sub condval {
5155: my $condidx=shift;
1.54 www 5156: my $allpathcond='';
1.713 albertel 5157: foreach my $cond (split(/\|/,$condidx)) {
5158: if (defined($env{'acc.cond.'.$env{'request.course.id'}.'.'.$cond})) {
5159: $allpathcond.=
5160: '('.$env{'acc.cond.'.$env{'request.course.id'}.'.'.$cond}.')|';
5161: }
1.191 harris41 5162: }
1.54 www 5163: $allpathcond=~s/\|$//;
1.713 albertel 5164: return &docondval($allpathcond);
5165: }
5166:
5167: #evaluates an expression of conditions
5168: sub docondval {
5169: my ($allpathcond) = @_;
5170: my $result=0;
5171: if ($env{'request.course.id'}
5172: && defined($allpathcond)) {
5173: my $operand='|';
5174: my @stack;
5175: foreach my $chunk ($allpathcond=~/(\d+|_\d+\.\d+|\(|\)|\&|\|)/g) {
5176: if ($chunk eq '(') {
5177: push @stack,($operand,$result);
5178: } elsif ($chunk eq ')') {
5179: my $before=pop @stack;
5180: if (pop @stack eq '&') {
5181: $result=$result>$before?$before:$result;
5182: } else {
5183: $result=$result>$before?$result:$before;
5184: }
5185: } elsif (($chunk eq '&') || ($chunk eq '|')) {
5186: $operand=$chunk;
5187: } else {
5188: my $new=directcondval($chunk);
5189: if ($operand eq '&') {
5190: $result=$result>$new?$new:$result;
5191: } else {
5192: $result=$result>$new?$result:$new;
5193: }
5194: }
5195: }
1.26 www 5196: }
5197: return $result;
1.421 albertel 5198: }
5199:
5200: # ---------------------------------------------------- Devalidate courseresdata
5201:
5202: sub devalidatecourseresdata {
5203: my ($coursenum,$coursedomain)=@_;
5204: my $hashid=$coursenum.':'.$coursedomain;
1.599 albertel 5205: &devalidate_cache_new('courseres',$hashid);
1.28 www 5206: }
5207:
1.200 www 5208: # --------------------------------------------------- Course Resourcedata Query
5209:
1.624 albertel 5210: sub get_courseresdata {
5211: my ($coursenum,$coursedomain)=@_;
1.200 www 5212: my $coursehom=&homeserver($coursenum,$coursedomain);
5213: my $hashid=$coursenum.':'.$coursedomain;
1.599 albertel 5214: my ($result,$cached)=&is_cached_new('courseres',$hashid);
1.624 albertel 5215: my %dumpreply;
1.417 albertel 5216: unless (defined($cached)) {
1.624 albertel 5217: %dumpreply=&dump('resourcedata',$coursedomain,$coursenum);
1.417 albertel 5218: $result=\%dumpreply;
1.251 albertel 5219: my ($tmp) = keys(%dumpreply);
5220: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
1.599 albertel 5221: &do_cache_new('courseres',$hashid,$result,600);
1.306 albertel 5222: } elsif ($tmp =~ /^(con_lost|no_such_host)/) {
5223: return $tmp;
1.416 albertel 5224: } elsif ($tmp =~ /^(error)/) {
1.417 albertel 5225: $result=undef;
1.599 albertel 5226: &do_cache_new('courseres',$hashid,$result,600);
1.250 albertel 5227: }
5228: }
1.624 albertel 5229: return $result;
5230: }
5231:
1.633 albertel 5232: sub devalidateuserresdata {
5233: my ($uname,$udom)=@_;
5234: my $hashid="$udom:$uname";
5235: &devalidate_cache_new('userres',$hashid);
5236: }
5237:
1.624 albertel 5238: sub get_userresdata {
5239: my ($uname,$udom)=@_;
5240: #most student don\'t have any data set, check if there is some data
5241: if (&EXT_cache_status($udom,$uname)) { return undef; }
5242:
5243: my $hashid="$udom:$uname";
5244: my ($result,$cached)=&is_cached_new('userres',$hashid);
5245: if (!defined($cached)) {
5246: my %resourcedata=&dump('resourcedata',$udom,$uname);
5247: $result=\%resourcedata;
5248: &do_cache_new('userres',$hashid,$result,600);
5249: }
5250: my ($tmp)=keys(%$result);
5251: if (($tmp!~/^error\:/) && ($tmp!~/^con_lost/)) {
5252: return $result;
5253: }
5254: #error 2 occurs when the .db doesn't exist
5255: if ($tmp!~/error: 2 /) {
1.672 albertel 5256: &logthis("<font color=\"blue\">WARNING:".
1.624 albertel 5257: " Trying to get resource data for ".
5258: $uname." at ".$udom.": ".
5259: $tmp."</font>");
5260: } elsif ($tmp=~/error: 2 /) {
1.633 albertel 5261: #&EXT_cache_set($udom,$uname);
5262: &do_cache_new('userres',$hashid,undef,600);
1.636 albertel 5263: undef($tmp); # not really an error so don't send it back
1.624 albertel 5264: }
5265: return $tmp;
5266: }
5267:
5268: sub resdata {
5269: my ($name,$domain,$type,@which)=@_;
5270: my $result;
5271: if ($type eq 'course') {
5272: $result=&get_courseresdata($name,$domain);
5273: } elsif ($type eq 'user') {
5274: $result=&get_userresdata($name,$domain);
5275: }
5276: if (!ref($result)) { return $result; }
1.251 albertel 5277: foreach my $item (@which) {
1.417 albertel 5278: if (defined($result->{$item})) {
5279: return $result->{$item};
1.251 albertel 5280: }
1.250 albertel 5281: }
1.291 albertel 5282: return undef;
1.200 www 5283: }
5284:
1.379 matthew 5285: #
5286: # EXT resource caching routines
5287: #
5288:
5289: sub clear_EXT_cache_status {
1.383 albertel 5290: &delenv('cache.EXT.');
1.379 matthew 5291: }
5292:
5293: sub EXT_cache_status {
5294: my ($target_domain,$target_user) = @_;
1.383 albertel 5295: my $cachename = 'cache.EXT.'.$target_user.'.'.$target_domain;
1.620 albertel 5296: if (exists($env{$cachename}) && ($env{$cachename}+600) > time) {
1.379 matthew 5297: # We know already the user has no data
5298: return 1;
5299: } else {
5300: return 0;
5301: }
5302: }
5303:
5304: sub EXT_cache_set {
5305: my ($target_domain,$target_user) = @_;
1.383 albertel 5306: my $cachename = 'cache.EXT.'.$target_user.'.'.$target_domain;
1.633 albertel 5307: #&appenv($cachename => time);
1.379 matthew 5308: }
5309:
1.28 www 5310: # --------------------------------------------------------- Value of a Variable
1.58 www 5311: sub EXT {
1.715 albertel 5312:
1.395 albertel 5313: my ($varname,$symbparm,$udom,$uname,$usection,$recurse)=@_;
1.68 www 5314: unless ($varname) { return ''; }
1.218 albertel 5315: #get real user name/domain, courseid and symb
5316: my $courseid;
1.359 albertel 5317: my $publicuser;
1.427 www 5318: if ($symbparm) {
5319: $symbparm=&get_symb_from_alias($symbparm);
5320: }
1.218 albertel 5321: if (!($uname && $udom)) {
1.360 albertel 5322: (my $cursymb,$courseid,$udom,$uname,$publicuser)=
1.378 matthew 5323: &Apache::lonxml::whichuser($symbparm);
1.218 albertel 5324: if (!$symbparm) { $symbparm=$cursymb; }
5325: } else {
1.620 albertel 5326: $courseid=$env{'request.course.id'};
1.218 albertel 5327: }
1.48 www 5328: my ($realm,$space,$qualifier,@therest)=split(/\./,$varname);
5329: my $rest;
1.320 albertel 5330: if (defined($therest[0])) {
1.48 www 5331: $rest=join('.',@therest);
5332: } else {
5333: $rest='';
5334: }
1.320 albertel 5335:
1.57 www 5336: my $qualifierrest=$qualifier;
5337: if ($rest) { $qualifierrest.='.'.$rest; }
5338: my $spacequalifierrest=$space;
5339: if ($qualifierrest) { $spacequalifierrest.='.'.$qualifierrest; }
1.28 www 5340: if ($realm eq 'user') {
1.48 www 5341: # --------------------------------------------------------------- user.resource
5342: if ($space eq 'resource') {
1.651 albertel 5343: if ( (defined($Apache::lonhomework::parsing_a_problem)
5344: || defined($Apache::lonhomework::parsing_a_task))
5345: &&
1.744 albertel 5346: ($symbparm eq &symbread()) ) {
5347: # if we are in the middle of processing the resource the
5348: # get the value we are planning on committing
5349: if (defined($Apache::lonhomework::results{$qualifierrest})) {
5350: return $Apache::lonhomework::results{$qualifierrest};
5351: } else {
5352: return $Apache::lonhomework::history{$qualifierrest};
5353: }
1.335 albertel 5354: } else {
1.359 albertel 5355: my %restored;
1.620 albertel 5356: if ($publicuser || $env{'request.state'} eq 'construct') {
1.359 albertel 5357: %restored=&tmprestore($symbparm,$courseid,$udom,$uname);
5358: } else {
5359: %restored=&restore($symbparm,$courseid,$udom,$uname);
5360: }
1.335 albertel 5361: return $restored{$qualifierrest};
5362: }
1.48 www 5363: # ----------------------------------------------------------------- user.access
5364: } elsif ($space eq 'access') {
1.218 albertel 5365: # FIXME - not supporting calls for a specific user
1.48 www 5366: return &allowed($qualifier,$rest);
5367: # ------------------------------------------ user.preferences, user.environment
5368: } elsif (($space eq 'preferences') || ($space eq 'environment')) {
1.620 albertel 5369: if (($uname eq $env{'user.name'}) &&
5370: ($udom eq $env{'user.domain'})) {
5371: return $env{join('.',('environment',$qualifierrest))};
1.218 albertel 5372: } else {
1.359 albertel 5373: my %returnhash;
5374: if (!$publicuser) {
5375: %returnhash=&userenvironment($udom,$uname,
5376: $qualifierrest);
5377: }
1.218 albertel 5378: return $returnhash{$qualifierrest};
5379: }
1.48 www 5380: # ----------------------------------------------------------------- user.course
5381: } elsif ($space eq 'course') {
1.218 albertel 5382: # FIXME - not supporting calls for a specific user
1.620 albertel 5383: return $env{join('.',('request.course',$qualifier))};
1.48 www 5384: # ------------------------------------------------------------------- user.role
5385: } elsif ($space eq 'role') {
1.218 albertel 5386: # FIXME - not supporting calls for a specific user
1.620 albertel 5387: my ($role,$where)=split(/\./,$env{'request.role'});
1.48 www 5388: if ($qualifier eq 'value') {
5389: return $role;
5390: } elsif ($qualifier eq 'extent') {
5391: return $where;
5392: }
5393: # ----------------------------------------------------------------- user.domain
5394: } elsif ($space eq 'domain') {
1.218 albertel 5395: return $udom;
1.48 www 5396: # ------------------------------------------------------------------- user.name
5397: } elsif ($space eq 'name') {
1.218 albertel 5398: return $uname;
1.48 www 5399: # ---------------------------------------------------- Any other user namespace
1.29 www 5400: } else {
1.359 albertel 5401: my %reply;
5402: if (!$publicuser) {
5403: %reply=&get($space,[$qualifierrest],$udom,$uname);
5404: }
5405: return $reply{$qualifierrest};
1.48 www 5406: }
1.236 www 5407: } elsif ($realm eq 'query') {
5408: # ---------------------------------------------- pull stuff out of query string
1.384 albertel 5409: &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},
5410: [$spacequalifierrest]);
1.620 albertel 5411: return $env{'form.'.$spacequalifierrest};
1.236 www 5412: } elsif ($realm eq 'request') {
1.48 www 5413: # ------------------------------------------------------------- request.browser
5414: if ($space eq 'browser') {
1.430 www 5415: if ($qualifier eq 'textremote') {
1.676 albertel 5416: if (&Apache::lonlocal::mt('textual_remote_display') eq 'on') {
1.430 www 5417: return 1;
5418: } else {
5419: return 0;
5420: }
5421: } else {
1.620 albertel 5422: return $env{'browser.'.$qualifier};
1.430 www 5423: }
1.57 www 5424: # ------------------------------------------------------------ request.filename
5425: } else {
1.620 albertel 5426: return $env{'request.'.$spacequalifierrest};
1.29 www 5427: }
1.28 www 5428: } elsif ($realm eq 'course') {
1.48 www 5429: # ---------------------------------------------------------- course.description
1.620 albertel 5430: return $env{'course.'.$courseid.'.'.$spacequalifierrest};
1.57 www 5431: } elsif ($realm eq 'resource') {
1.165 www 5432:
1.620 albertel 5433: if (defined($courseid) && $courseid eq $env{'request.course.id'}) {
1.539 albertel 5434: if (!$symbparm) { $symbparm=&symbread(); }
5435: }
1.693 albertel 5436:
5437: if ($space eq 'title') {
5438: if (!$symbparm) { $symbparm = $env{'request.filename'}; }
5439: return &gettitle($symbparm);
5440: }
5441:
5442: if ($space eq 'map') {
5443: my ($map) = &decode_symb($symbparm);
5444: return &symbread($map);
5445: }
5446:
5447: my ($section, $group, @groups);
1.593 albertel 5448: my ($courselevelm,$courselevel);
1.539 albertel 5449: if ($symbparm && defined($courseid) &&
1.620 albertel 5450: $courseid eq $env{'request.course.id'}) {
1.165 www 5451:
1.218 albertel 5452: #print '<br>'.$space.' - '.$qualifier.' - '.$spacequalifierrest;
1.165 www 5453:
1.60 www 5454: # ----------------------------------------------------- Cascading lookup scheme
1.218 albertel 5455: my $symbp=$symbparm;
1.735 albertel 5456: my $mapp=&deversion((&decode_symb($symbp))[0]);
1.218 albertel 5457:
5458: my $symbparm=$symbp.'.'.$spacequalifierrest;
5459: my $mapparm=$mapp.'___(all).'.$spacequalifierrest;
5460:
1.620 albertel 5461: if (($env{'user.name'} eq $uname) &&
5462: ($env{'user.domain'} eq $udom)) {
5463: $section=$env{'request.course.sec'};
1.733 raeburn 5464: @groups = split(/:/,$env{'request.course.groups'});
5465: @groups=&sort_course_groups($courseid,@groups);
1.218 albertel 5466: } else {
1.539 albertel 5467: if (! defined($usection)) {
1.551 albertel 5468: $section=&getsection($udom,$uname,$courseid);
1.539 albertel 5469: } else {
5470: $section = $usection;
5471: }
1.733 raeburn 5472: @groups = &get_users_groups($udom,$uname,$courseid);
1.218 albertel 5473: }
5474:
5475: my $seclevel=$courseid.'.['.$section.'].'.$spacequalifierrest;
5476: my $seclevelr=$courseid.'.['.$section.'].'.$symbparm;
5477: my $seclevelm=$courseid.'.['.$section.'].'.$mapparm;
5478:
1.593 albertel 5479: $courselevel=$courseid.'.'.$spacequalifierrest;
1.218 albertel 5480: my $courselevelr=$courseid.'.'.$symbparm;
1.593 albertel 5481: $courselevelm=$courseid.'.'.$mapparm;
1.69 www 5482:
1.60 www 5483: # ----------------------------------------------------------- first, check user
1.624 albertel 5484:
5485: my $userreply=&resdata($uname,$udom,'user',
5486: ($courselevelr,$courselevelm,
5487: $courselevel));
5488: if (defined($userreply)) { return $userreply; }
1.95 www 5489:
1.594 albertel 5490: # ------------------------------------------------ second, check some of course
1.684 raeburn 5491: my $coursereply;
1.691 raeburn 5492: if (@groups > 0) {
5493: $coursereply = &check_group_parms($courseid,\@groups,$symbparm,
5494: $mapparm,$spacequalifierrest);
1.684 raeburn 5495: if (defined($coursereply)) { return $coursereply; }
5496: }
1.96 www 5497:
1.684 raeburn 5498: $coursereply=&resdata($env{'course.'.$courseid.'.num'},
1.624 albertel 5499: $env{'course.'.$courseid.'.domain'},
5500: 'course',
5501: ($seclevelr,$seclevelm,$seclevel,
5502: $courselevelr));
1.287 albertel 5503: if (defined($coursereply)) { return $coursereply; }
1.200 www 5504:
1.60 www 5505: # ------------------------------------------------------ third, check map parms
1.218 albertel 5506: my %parmhash=();
5507: my $thisparm='';
5508: if (tie(%parmhash,'GDBM_File',
1.620 albertel 5509: $env{'request.course.fn'}.'_parms.db',
1.256 albertel 5510: &GDBM_READER(),0640)) {
1.218 albertel 5511: $thisparm=$parmhash{$symbparm};
5512: untie(%parmhash);
5513: }
5514: if ($thisparm) { return $thisparm; }
5515: }
1.594 albertel 5516: # ------------------------------------------ fourth, look in resource metadata
1.71 www 5517:
1.218 albertel 5518: $spacequalifierrest=~s/\./\_/;
1.282 albertel 5519: my $filename;
5520: if (!$symbparm) { $symbparm=&symbread(); }
5521: if ($symbparm) {
1.409 www 5522: $filename=(&decode_symb($symbparm))[2];
1.282 albertel 5523: } else {
1.620 albertel 5524: $filename=$env{'request.filename'};
1.282 albertel 5525: }
5526: my $metadata=&metadata($filename,$spacequalifierrest);
1.288 albertel 5527: if (defined($metadata)) { return $metadata; }
1.282 albertel 5528: $metadata=&metadata($filename,'parameter_'.$spacequalifierrest);
1.288 albertel 5529: if (defined($metadata)) { return $metadata; }
1.142 www 5530:
1.594 albertel 5531: # ---------------------------------------------- fourth, look in rest pf course
1.593 albertel 5532: if ($symbparm && defined($courseid) &&
1.620 albertel 5533: $courseid eq $env{'request.course.id'}) {
1.624 albertel 5534: my $coursereply=&resdata($env{'course.'.$courseid.'.num'},
5535: $env{'course.'.$courseid.'.domain'},
5536: 'course',
5537: ($courselevelm,$courselevel));
1.593 albertel 5538: if (defined($coursereply)) { return $coursereply; }
5539: }
1.145 www 5540: # ------------------------------------------------------------------ Cascade up
1.218 albertel 5541: unless ($space eq '0') {
1.336 albertel 5542: my @parts=split(/_/,$space);
5543: my $id=pop(@parts);
5544: my $part=join('_',@parts);
5545: if ($part eq '') { $part='0'; }
5546: my $partgeneral=&EXT('resource.'.$part.'.'.$qualifierrest,
1.395 albertel 5547: $symbparm,$udom,$uname,$section,1);
1.337 albertel 5548: if (defined($partgeneral)) { return $partgeneral; }
1.218 albertel 5549: }
1.395 albertel 5550: if ($recurse) { return undef; }
5551: my $pack_def=&packages_tab_default($filename,$varname);
5552: if (defined($pack_def)) { return $pack_def; }
1.71 www 5553:
1.48 www 5554: # ---------------------------------------------------- Any other user namespace
5555: } elsif ($realm eq 'environment') {
5556: # ----------------------------------------------------------------- environment
1.620 albertel 5557: if (($uname eq $env{'user.name'})&&($udom eq $env{'user.domain'})) {
5558: return $env{'environment.'.$spacequalifierrest};
1.219 albertel 5559: } else {
5560: my %returnhash=&userenvironment($udom,$uname,
5561: $spacequalifierrest);
5562: return $returnhash{$spacequalifierrest};
5563: }
1.28 www 5564: } elsif ($realm eq 'system') {
1.48 www 5565: # ----------------------------------------------------------------- system.time
5566: if ($space eq 'time') {
5567: return time;
5568: }
1.696 albertel 5569: } elsif ($realm eq 'server') {
5570: # ----------------------------------------------------------------- system.time
5571: if ($space eq 'name') {
5572: return $ENV{'SERVER_NAME'};
5573: }
1.28 www 5574: }
1.48 www 5575: return '';
1.61 www 5576: }
5577:
1.691 raeburn 5578: sub check_group_parms {
5579: my ($courseid,$groups,$symbparm,$mapparm,$what) = @_;
5580: my @groupitems = ();
5581: my $resultitem;
5582: my @levels = ($symbparm,$mapparm,$what);
5583: foreach my $group (@{$groups}) {
5584: foreach my $level (@levels) {
5585: my $item = $courseid.'.['.$group.'].'.$level;
5586: push(@groupitems,$item);
5587: }
5588: }
5589: my $coursereply = &resdata($env{'course.'.$courseid.'.num'},
5590: $env{'course.'.$courseid.'.domain'},
5591: 'course',@groupitems);
5592: return $coursereply;
5593: }
5594:
5595: sub sort_course_groups { # Sort groups based on defined rankings. Default is sort().
1.733 raeburn 5596: my ($courseid,@groups) = @_;
5597: @groups = sort(@groups);
1.691 raeburn 5598: return @groups;
5599: }
5600:
1.395 albertel 5601: sub packages_tab_default {
5602: my ($uri,$varname)=@_;
5603: my (undef,$part,$name)=split(/\./,$varname);
1.738 albertel 5604:
5605: my (@extension,@specifics,$do_default);
5606: foreach my $package (split(/,/,&metadata($uri,'packages'))) {
1.395 albertel 5607: my ($pack_type,$pack_part)=split(/_/,$package,2);
1.738 albertel 5608: if ($pack_type eq 'default') {
5609: $do_default=1;
5610: } elsif ($pack_type eq 'extension') {
5611: push(@extension,[$package,$pack_type,$pack_part]);
5612: } else {
5613: push(@specifics,[$package,$pack_type,$pack_part]);
5614: }
5615: }
5616: # first look for a package that matches the requested part id
5617: foreach my $package (@specifics) {
5618: my (undef,$pack_type,$pack_part)=@{$package};
5619: next if ($pack_part ne $part);
5620: if (defined($packagetab{"$pack_type&$name&default"})) {
5621: return $packagetab{"$pack_type&$name&default"};
5622: }
5623: }
5624: # look for any possible matching non extension_ package
5625: foreach my $package (@specifics) {
5626: my (undef,$pack_type,$pack_part)=@{$package};
1.468 albertel 5627: if (defined($packagetab{"$pack_type&$name&default"})) {
5628: return $packagetab{"$pack_type&$name&default"};
5629: }
1.585 albertel 5630: if ($pack_type eq 'part') { $pack_part='0'; }
1.468 albertel 5631: if (defined($packagetab{$pack_type."_".$pack_part."&$name&default"})) {
5632: return $packagetab{$pack_type."_".$pack_part."&$name&default"};
1.395 albertel 5633: }
5634: }
1.738 albertel 5635: # look for any posible extension_ match
5636: foreach my $package (@extension) {
5637: my ($package,$pack_type)=@{$package};
5638: if (defined($packagetab{"$pack_type&$name&default"})) {
5639: return $packagetab{"$pack_type&$name&default"};
5640: }
5641: if (defined($packagetab{$package."&$name&default"})) {
5642: return $packagetab{$package."&$name&default"};
5643: }
5644: }
5645: # look for a global default setting
5646: if ($do_default && defined($packagetab{"default&$name&default"})) {
5647: return $packagetab{"default&$name&default"};
5648: }
1.395 albertel 5649: return undef;
5650: }
5651:
1.334 albertel 5652: sub add_prefix_and_part {
5653: my ($prefix,$part)=@_;
5654: my $keyroot;
5655: if (defined($prefix) && $prefix !~ /^__/) {
5656: # prefix that has a part already
5657: $keyroot=$prefix;
5658: } elsif (defined($prefix)) {
5659: # prefix that is missing a part
5660: if (defined($part)) { $keyroot='_'.$part.substr($prefix,1); }
5661: } else {
5662: # no prefix at all
5663: if (defined($part)) { $keyroot='_'.$part; }
5664: }
5665: return $keyroot;
5666: }
5667:
1.71 www 5668: # ---------------------------------------------------------------- Get metadata
5669:
1.599 albertel 5670: my %metaentry;
1.71 www 5671: sub metadata {
1.176 www 5672: my ($uri,$what,$liburi,$prefix,$depthcount)=@_;
1.71 www 5673: $uri=&declutter($uri);
1.288 albertel 5674: # if it is a non metadata possible uri return quickly
1.529 albertel 5675: if (($uri eq '') ||
5676: (($uri =~ m|^/*adm/|) &&
1.698 albertel 5677: ($uri !~ m|^adm/includes|) && ($uri !~ m|/bulletinboard$|)) ||
1.423 albertel 5678: ($uri =~ m|/$|) || ($uri =~ m|/.meta$|) || ($uri =~ /^~/) ||
1.489 albertel 5679: ($uri =~ m|home/[^/]+/public_html/|)) {
1.468 albertel 5680: return undef;
1.288 albertel 5681: }
1.73 www 5682: my $filename=$uri;
5683: $uri=~s/\.meta$//;
1.172 www 5684: #
5685: # Is the metadata already cached?
1.177 www 5686: # Look at timestamp of caching
1.172 www 5687: # Everything is cached by the main uri, libraries are never directly cached
5688: #
1.428 albertel 5689: if (!defined($liburi)) {
1.599 albertel 5690: my ($result,$cached)=&is_cached_new('meta',$uri);
1.428 albertel 5691: if (defined($cached)) { return $result->{':'.$what}; }
5692: }
5693: {
1.172 www 5694: #
5695: # Is this a recursive call for a library?
5696: #
1.599 albertel 5697: # if (! exists($metacache{$uri})) {
5698: # $metacache{$uri}={};
5699: # }
1.171 www 5700: if ($liburi) {
5701: $liburi=&declutter($liburi);
5702: $filename=$liburi;
1.401 bowersj2 5703: } else {
1.599 albertel 5704: &devalidate_cache_new('meta',$uri);
5705: undef(%metaentry);
1.401 bowersj2 5706: }
1.140 www 5707: my %metathesekeys=();
1.73 www 5708: unless ($filename=~/\.meta$/) { $filename.='.meta'; }
1.489 albertel 5709: my $metastring;
1.609 banghart 5710: if ($uri !~ m -^(uploaded|editupload)/-) {
1.543 albertel 5711: my $file=&filelocation('',&clutter($filename));
1.599 albertel 5712: #push(@{$metaentry{$uri.'.file'}},$file);
1.543 albertel 5713: $metastring=&getfile($file);
1.489 albertel 5714: }
1.208 albertel 5715: my $parser=HTML::LCParser->new(\$metastring);
1.71 www 5716: my $token;
1.140 www 5717: undef %metathesekeys;
1.71 www 5718: while ($token=$parser->get_token) {
1.339 albertel 5719: if ($token->[0] eq 'S') {
5720: if (defined($token->[2]->{'package'})) {
1.172 www 5721: #
5722: # This is a package - get package info
5723: #
1.339 albertel 5724: my $package=$token->[2]->{'package'};
5725: my $keyroot=&add_prefix_and_part($prefix,$token->[2]->{'part'});
5726: if (defined($token->[2]->{'id'})) {
5727: $keyroot.='_'.$token->[2]->{'id'};
5728: }
1.599 albertel 5729: if ($metaentry{':packages'}) {
5730: $metaentry{':packages'}.=','.$package.$keyroot;
1.339 albertel 5731: } else {
1.599 albertel 5732: $metaentry{':packages'}=$package.$keyroot;
1.339 albertel 5733: }
1.736 albertel 5734: foreach my $pack_entry (keys(%packagetab)) {
1.432 albertel 5735: my $part=$keyroot;
5736: $part=~s/^\_//;
1.736 albertel 5737: if ($pack_entry=~/^\Q$package\E\&/ ||
5738: $pack_entry=~/^\Q$package\E_0\&/) {
5739: my ($pack,$name,$subp)=split(/\&/,$pack_entry);
1.395 albertel 5740: # ignore package.tab specified default values
5741: # here &package_tab_default() will fetch those
5742: if ($subp eq 'default') { next; }
1.736 albertel 5743: my $value=$packagetab{$pack_entry};
1.432 albertel 5744: my $unikey;
5745: if ($pack =~ /_0$/) {
5746: $unikey='parameter_0_'.$name;
5747: $part=0;
5748: } else {
5749: $unikey='parameter'.$keyroot.'_'.$name;
5750: }
1.339 albertel 5751: if ($subp eq 'display') {
5752: $value.=' [Part: '.$part.']';
5753: }
1.599 albertel 5754: $metaentry{':'.$unikey.'.part'}=$part;
1.395 albertel 5755: $metathesekeys{$unikey}=1;
1.599 albertel 5756: unless (defined($metaentry{':'.$unikey.'.'.$subp})) {
5757: $metaentry{':'.$unikey.'.'.$subp}=$value;
1.339 albertel 5758: }
1.599 albertel 5759: if (defined($metaentry{':'.$unikey.'.default'})) {
5760: $metaentry{':'.$unikey}=
5761: $metaentry{':'.$unikey.'.default'};
1.356 albertel 5762: }
1.339 albertel 5763: }
5764: }
5765: } else {
1.172 www 5766: #
5767: # This is not a package - some other kind of start tag
1.339 albertel 5768: #
5769: my $entry=$token->[1];
5770: my $unikey;
5771: if ($entry eq 'import') {
5772: $unikey='';
5773: } else {
5774: $unikey=$entry;
5775: }
5776: $unikey.=&add_prefix_and_part($prefix,$token->[2]->{'part'});
5777:
5778: if (defined($token->[2]->{'id'})) {
5779: $unikey.='_'.$token->[2]->{'id'};
5780: }
1.175 www 5781:
1.339 albertel 5782: if ($entry eq 'import') {
1.175 www 5783: #
5784: # Importing a library here
1.339 albertel 5785: #
5786: if ($depthcount<20) {
5787: my $location=$parser->get_text('/import');
5788: my $dir=$filename;
5789: $dir=~s|[^/]*$||;
5790: $location=&filelocation($dir,$location);
1.736 albertel 5791: my $metadata =
5792: &metadata($uri,'keys', $location,$unikey,
5793: $depthcount+1);
5794: foreach my $meta (split(',',$metadata)) {
5795: $metaentry{':'.$meta}=$metaentry{':'.$meta};
5796: $metathesekeys{$meta}=1;
1.339 albertel 5797: }
5798: }
5799: } else {
5800:
5801: if (defined($token->[2]->{'name'})) {
5802: $unikey.='_'.$token->[2]->{'name'};
5803: }
5804: $metathesekeys{$unikey}=1;
1.736 albertel 5805: foreach my $param (@{$token->[3]}) {
5806: $metaentry{':'.$unikey.'.'.$param} =
5807: $token->[2]->{$param};
1.339 albertel 5808: }
5809: my $internaltext=&HTML::Entities::decode($parser->get_text('/'.$entry));
1.599 albertel 5810: my $default=$metaentry{':'.$unikey.'.default'};
1.339 albertel 5811: if ( $internaltext =~ /^\s*$/ && $default !~ /^\s*$/) {
5812: # only ws inside the tag, and not in default, so use default
5813: # as value
1.599 albertel 5814: $metaentry{':'.$unikey}=$default;
1.339 albertel 5815: } else {
1.321 albertel 5816: # either something interesting inside the tag or default
5817: # uninteresting
1.599 albertel 5818: $metaentry{':'.$unikey}=$internaltext;
1.339 albertel 5819: }
1.172 www 5820: # end of not-a-package not-a-library import
1.339 albertel 5821: }
1.172 www 5822: # end of not-a-package start tag
1.339 albertel 5823: }
1.172 www 5824: # the next is the end of "start tag"
1.339 albertel 5825: }
5826: }
1.483 albertel 5827: my ($extension) = ($uri =~ /\.(\w+)$/);
1.737 albertel 5828: foreach my $key (keys(%packagetab)) {
1.483 albertel 5829: #no specific packages #how's our extension
5830: if ($key!~/^extension_\Q$extension\E&/) { next; }
1.488 albertel 5831: &metadata_create_package_def($uri,$key,'extension_'.$extension,
1.483 albertel 5832: \%metathesekeys);
5833: }
1.599 albertel 5834: if (!exists($metaentry{':packages'})) {
1.737 albertel 5835: foreach my $key (keys(%packagetab)) {
1.483 albertel 5836: #no specific packages well let's get default then
5837: if ($key!~/^default&/) { next; }
1.488 albertel 5838: &metadata_create_package_def($uri,$key,'default',
1.483 albertel 5839: \%metathesekeys);
5840: }
5841: }
1.338 www 5842: # are there custom rights to evaluate
1.599 albertel 5843: if ($metaentry{':copyright'} eq 'custom') {
1.339 albertel 5844:
1.338 www 5845: #
5846: # Importing a rights file here
1.339 albertel 5847: #
5848: unless ($depthcount) {
1.599 albertel 5849: my $location=$metaentry{':customdistributionfile'};
1.339 albertel 5850: my $dir=$filename;
5851: $dir=~s|[^/]*$||;
5852: $location=&filelocation($dir,$location);
1.736 albertel 5853: my $rights_metadata =
5854: &metadata($uri,'keys',$location,'_rights',
5855: $depthcount+1);
5856: foreach my $rights (split(',',$rights_metadata)) {
5857: #$metaentry{':'.$rights}=$metacache{$uri}->{':'.$rights};
5858: $metathesekeys{$rights}=1;
1.339 albertel 5859: }
5860: }
5861: }
1.737 albertel 5862: # uniqifiy package listing
5863: my %seen;
5864: my @uniq_packages =
5865: grep { ! $seen{$_} ++ } (split(',',$metaentry{':packages'}));
5866: $metaentry{':packages'} = join(',',@uniq_packages);
5867:
5868: $metaentry{':keys'} = join(',',keys(%metathesekeys));
1.599 albertel 5869: &metadata_generate_part0(\%metathesekeys,\%metaentry,$uri);
5870: $metaentry{':allpossiblekeys'}=join(',',keys %metathesekeys);
1.699 albertel 5871: &do_cache_new('meta',$uri,\%metaentry,60*60);
1.177 www 5872: # this is the end of "was not already recently cached
1.71 www 5873: }
1.599 albertel 5874: return $metaentry{':'.$what};
1.261 albertel 5875: }
5876:
1.488 albertel 5877: sub metadata_create_package_def {
1.483 albertel 5878: my ($uri,$key,$package,$metathesekeys)=@_;
5879: my ($pack,$name,$subp)=split(/\&/,$key);
5880: if ($subp eq 'default') { next; }
5881:
1.599 albertel 5882: if (defined($metaentry{':packages'})) {
5883: $metaentry{':packages'}.=','.$package;
1.483 albertel 5884: } else {
1.599 albertel 5885: $metaentry{':packages'}=$package;
1.483 albertel 5886: }
5887: my $value=$packagetab{$key};
5888: my $unikey;
5889: $unikey='parameter_0_'.$name;
1.599 albertel 5890: $metaentry{':'.$unikey.'.part'}=0;
1.483 albertel 5891: $$metathesekeys{$unikey}=1;
1.599 albertel 5892: unless (defined($metaentry{':'.$unikey.'.'.$subp})) {
5893: $metaentry{':'.$unikey.'.'.$subp}=$value;
1.483 albertel 5894: }
1.599 albertel 5895: if (defined($metaentry{':'.$unikey.'.default'})) {
5896: $metaentry{':'.$unikey}=
5897: $metaentry{':'.$unikey.'.default'};
1.483 albertel 5898: }
5899: }
5900:
1.261 albertel 5901: sub metadata_generate_part0 {
5902: my ($metadata,$metacache,$uri) = @_;
5903: my %allnames;
1.737 albertel 5904: foreach my $metakey (keys(%$metadata)) {
1.261 albertel 5905: if ($metakey=~/^parameter\_(.*)/) {
1.428 albertel 5906: my $part=$$metacache{':'.$metakey.'.part'};
5907: my $name=$$metacache{':'.$metakey.'.name'};
1.356 albertel 5908: if (! exists($$metadata{'parameter_0_'.$name.'.name'})) {
1.261 albertel 5909: $allnames{$name}=$part;
5910: }
5911: }
5912: }
5913: foreach my $name (keys(%allnames)) {
5914: $$metadata{"parameter_0_$name"}=1;
1.428 albertel 5915: my $key=":parameter_0_$name";
1.261 albertel 5916: $$metacache{"$key.part"}='0';
5917: $$metacache{"$key.name"}=$name;
1.428 albertel 5918: $$metacache{"$key.type"}=$$metacache{':parameter_'.
1.261 albertel 5919: $allnames{$name}.'_'.$name.
5920: '.type'};
1.428 albertel 5921: my $olddis=$$metacache{':parameter_'.$allnames{$name}.'_'.$name.
1.261 albertel 5922: '.display'};
1.644 www 5923: my $expr='[Part: '.$allnames{$name}.']';
1.479 albertel 5924: $olddis=~s/\Q$expr\E/\[Part: 0\]/;
1.261 albertel 5925: $$metacache{"$key.display"}=$olddis;
5926: }
1.71 www 5927: }
5928:
1.301 www 5929: # ------------------------------------------------- Get the title of a resource
5930:
5931: sub gettitle {
5932: my $urlsymb=shift;
5933: my $symb=&symbread($urlsymb);
1.534 albertel 5934: if ($symb) {
1.620 albertel 5935: my $key=$env{'request.course.id'}."\0".$symb;
1.599 albertel 5936: my ($result,$cached)=&is_cached_new('title',$key);
1.575 albertel 5937: if (defined($cached)) {
5938: return $result;
5939: }
1.534 albertel 5940: my ($map,$resid,$url)=&decode_symb($symb);
5941: my $title='';
5942: my %bighash;
1.620 albertel 5943: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
1.534 albertel 5944: &GDBM_READER(),0640)) {
5945: my $mapid=$bighash{'map_pc_'.&clutter($map)};
5946: $title=$bighash{'title_'.$mapid.'.'.$resid};
5947: untie %bighash;
5948: }
5949: $title=~s/\&colon\;/\:/gs;
5950: if ($title) {
1.599 albertel 5951: return &do_cache_new('title',$key,$title,600);
1.534 albertel 5952: }
5953: $urlsymb=$url;
5954: }
5955: my $title=&metadata($urlsymb,'title');
5956: if (!$title) { $title=(split('/',$urlsymb))[-1]; }
5957: return $title;
1.301 www 5958: }
1.613 albertel 5959:
1.614 albertel 5960: sub get_slot {
5961: my ($which,$cnum,$cdom)=@_;
5962: if (!$cnum || !$cdom) {
5963: (undef,my $courseid)=&Apache::lonxml::whichuser();
1.620 albertel 5964: $cdom=$env{'course.'.$courseid.'.domain'};
5965: $cnum=$env{'course.'.$courseid.'.num'};
1.614 albertel 5966: }
1.703 albertel 5967: my $key=join("\0",'slots',$cdom,$cnum,$which);
5968: my %slotinfo;
5969: if (exists($remembered{$key})) {
5970: $slotinfo{$which} = $remembered{$key};
5971: } else {
5972: %slotinfo=&get('slots',[$which],$cdom,$cnum);
5973: &Apache::lonhomework::showhash(%slotinfo);
5974: my ($tmp)=keys(%slotinfo);
5975: if ($tmp=~/^error:/) { return (); }
5976: $remembered{$key} = $slotinfo{$which};
5977: }
1.616 albertel 5978: if (ref($slotinfo{$which}) eq 'HASH') {
5979: return %{$slotinfo{$which}};
5980: }
5981: return $slotinfo{$which};
1.614 albertel 5982: }
1.31 www 5983: # ------------------------------------------------- Update symbolic store links
5984:
5985: sub symblist {
5986: my ($mapname,%newhash)=@_;
1.438 www 5987: $mapname=&deversion(&declutter($mapname));
1.31 www 5988: my %hash;
1.620 albertel 5989: if (($env{'request.course.fn'}) && (%newhash)) {
5990: if (tie(%hash,'GDBM_File',$env{'request.course.fn'}.'_symb.db',
1.256 albertel 5991: &GDBM_WRCREAT(),0640)) {
1.711 albertel 5992: foreach my $url (keys %newhash) {
5993: next if ($url eq 'last_known'
5994: && $env{'form.no_update_last_known'});
5995: $hash{declutter($url)}=&encode_symb($mapname,
5996: $newhash{$url}->[1],
5997: $newhash{$url}->[0]);
1.191 harris41 5998: }
1.31 www 5999: if (untie(%hash)) {
6000: return 'ok';
6001: }
6002: }
6003: }
6004: return 'error';
1.212 www 6005: }
6006:
6007: # --------------------------------------------------------------- Verify a symb
6008:
6009: sub symbverify {
1.510 www 6010: my ($symb,$thisurl)=@_;
6011: my $thisfn=$thisurl;
6012: # wrapper not part of symbs
6013: $thisfn=~s/^\/adm\/wrapper//;
1.694 albertel 6014: $thisfn=~s/^\/adm\/coursedocs\/showdoc\///;
1.439 www 6015: $thisfn=&declutter($thisfn);
1.215 www 6016: # direct jump to resource in page or to a sequence - will construct own symbs
6017: if ($thisfn=~/\.(page|sequence)$/) { return 1; }
6018: # check URL part
1.409 www 6019: my ($map,$resid,$url)=&decode_symb($symb);
1.439 www 6020:
1.431 www 6021: unless ($url eq $thisfn) { return 0; }
1.213 www 6022:
1.216 www 6023: $symb=&symbclean($symb);
1.510 www 6024: $thisurl=&deversion($thisurl);
1.439 www 6025: $thisfn=&deversion($thisfn);
1.213 www 6026:
6027: my %bighash;
6028: my $okay=0;
1.431 www 6029:
1.620 albertel 6030: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
1.256 albertel 6031: &GDBM_READER(),0640)) {
1.510 www 6032: my $ids=$bighash{'ids_'.&clutter($thisurl)};
1.216 www 6033: unless ($ids) {
1.510 www 6034: $ids=$bighash{'ids_/'.$thisurl};
1.216 www 6035: }
6036: if ($ids) {
6037: # ------------------------------------------------------------------- Has ID(s)
6038: foreach (split(/\,/,$ids)) {
1.644 www 6039: my ($mapid,$resid)=split(/\./,$_);
1.216 www 6040: if (
6041: &symbclean(&declutter($bighash{'map_id_'.$mapid}).'___'.$resid.'___'.$thisfn)
6042: eq $symb) {
1.620 albertel 6043: if (($env{'request.role.adv'}) ||
6044: $bighash{'encrypted_'.$_} eq $env{'request.enc'}) {
1.582 albertel 6045: $okay=1;
6046: }
6047: }
1.216 www 6048: }
6049: }
1.213 www 6050: untie(%bighash);
6051: }
6052: return $okay;
1.31 www 6053: }
6054:
1.210 www 6055: # --------------------------------------------------------------- Clean-up symb
6056:
6057: sub symbclean {
6058: my $symb=shift;
1.568 albertel 6059: if ($symb=~m|^/enc/|) { $symb=&Apache::lonenc::unencrypted($symb); }
1.210 www 6060: # remove version from map
6061: $symb=~s/\.(\d+)\.(\w+)\_\_\_/\.$2\_\_\_/;
1.215 www 6062:
1.210 www 6063: # remove version from URL
6064: $symb=~s/\.(\d+)\.(\w+)$/\.$2/;
1.213 www 6065:
1.507 www 6066: # remove wrapper
6067:
1.510 www 6068: $symb=~s/(\_\_\_\d+\_\_\_)adm\/wrapper\/(res\/)*/$1/;
1.694 albertel 6069: $symb=~s/(\_\_\_\d+\_\_\_)adm\/coursedocs\/showdoc\/(res\/)*/$1/;
1.210 www 6070: return $symb;
1.409 www 6071: }
6072:
6073: # ---------------------------------------------- Split symb to find map and url
1.429 albertel 6074:
6075: sub encode_symb {
6076: my ($map,$resid,$url)=@_;
6077: return &symbclean(&declutter($map).'___'.$resid.'___'.&declutter($url));
6078: }
1.409 www 6079:
6080: sub decode_symb {
1.568 albertel 6081: my $symb=shift;
6082: if ($symb=~m|^/enc/|) { $symb=&Apache::lonenc::unencrypted($symb); }
6083: my ($map,$resid,$url)=split(/___/,$symb);
1.413 www 6084: return (&fixversion($map),$resid,&fixversion($url));
6085: }
6086:
6087: sub fixversion {
6088: my $fn=shift;
1.609 banghart 6089: if ($fn=~/^(adm|uploaded|editupload|public)/) { return $fn; }
1.435 www 6090: my %bighash;
6091: my $uri=&clutter($fn);
1.620 albertel 6092: my $key=$env{'request.course.id'}.'_'.$uri;
1.440 www 6093: # is this cached?
1.599 albertel 6094: my ($result,$cached)=&is_cached_new('courseresversion',$key);
1.440 www 6095: if (defined($cached)) { return $result; }
6096: # unfortunately not cached, or expired
1.620 albertel 6097: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
1.440 www 6098: &GDBM_READER(),0640)) {
6099: if ($bighash{'version_'.$uri}) {
6100: my $version=$bighash{'version_'.$uri};
1.444 www 6101: unless (($version eq 'mostrecent') ||
6102: ($version==&getversion($uri))) {
1.440 www 6103: $uri=~s/\.(\w+)$/\.$version\.$1/;
6104: }
6105: }
6106: untie %bighash;
1.413 www 6107: }
1.599 albertel 6108: return &do_cache_new('courseresversion',$key,&declutter($uri),600);
1.438 www 6109: }
6110:
6111: sub deversion {
6112: my $url=shift;
6113: $url=~s/\.\d+\.(\w+)$/\.$1/;
6114: return $url;
1.210 www 6115: }
6116:
1.31 www 6117: # ------------------------------------------------------ Return symb list entry
6118:
6119: sub symbread {
1.249 www 6120: my ($thisfn,$donotrecurse)=@_;
1.542 albertel 6121: my $cache_str='request.symbread.cached.'.$thisfn;
1.620 albertel 6122: if (defined($env{$cache_str})) { return $env{$cache_str}; }
1.242 www 6123: # no filename provided? try from environment
1.44 www 6124: unless ($thisfn) {
1.620 albertel 6125: if ($env{'request.symb'}) {
6126: return $env{$cache_str}=&symbclean($env{'request.symb'});
1.539 albertel 6127: }
1.620 albertel 6128: $thisfn=$env{'request.filename'};
1.44 www 6129: }
1.569 albertel 6130: if ($thisfn=~m|^/enc/|) { $thisfn=&Apache::lonenc::unencrypted($thisfn); }
1.242 www 6131: # is that filename actually a symb? Verify, clean, and return
6132: if ($thisfn=~/\_\_\_\d+\_\_\_(.*)$/) {
1.539 albertel 6133: if (&symbverify($thisfn,$1)) {
1.620 albertel 6134: return $env{$cache_str}=&symbclean($thisfn);
1.539 albertel 6135: }
1.242 www 6136: }
1.44 www 6137: $thisfn=declutter($thisfn);
1.31 www 6138: my %hash;
1.37 www 6139: my %bighash;
6140: my $syval='';
1.620 albertel 6141: if (($env{'request.course.fn'}) && ($thisfn)) {
1.481 raeburn 6142: my $targetfn = $thisfn;
1.609 banghart 6143: if ( ($thisfn =~ m/^(uploaded|editupload)\//) && ($thisfn !~ m/\.(page|sequence)$/) ) {
1.481 raeburn 6144: $targetfn = 'adm/wrapper/'.$thisfn;
6145: }
1.687 albertel 6146: if ($targetfn =~ m|^adm/wrapper/(ext/.*)|) {
6147: $targetfn=$1;
6148: }
1.620 albertel 6149: if (tie(%hash,'GDBM_File',$env{'request.course.fn'}.'_symb.db',
1.256 albertel 6150: &GDBM_READER(),0640)) {
1.481 raeburn 6151: $syval=$hash{$targetfn};
1.37 www 6152: untie(%hash);
6153: }
6154: # ---------------------------------------------------------- There was an entry
6155: if ($syval) {
1.601 albertel 6156: #unless ($syval=~/\_\d+$/) {
1.620 albertel 6157: #unless ($env{'form.request.prefix'}=~/\.(\d+)\_$/) {
1.601 albertel 6158: #&appenv('request.ambiguous' => $thisfn);
1.620 albertel 6159: #return $env{$cache_str}='';
1.601 albertel 6160: #}
6161: #$syval.=$1;
6162: #}
1.37 www 6163: } else {
6164: # ------------------------------------------------------- Was not in symb table
1.620 albertel 6165: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
1.256 albertel 6166: &GDBM_READER(),0640)) {
1.37 www 6167: # ---------------------------------------------- Get ID(s) for current resource
1.280 www 6168: my $ids=$bighash{'ids_'.&clutter($thisfn)};
1.65 www 6169: unless ($ids) {
6170: $ids=$bighash{'ids_/'.$thisfn};
1.242 www 6171: }
6172: unless ($ids) {
6173: # alias?
6174: $ids=$bighash{'mapalias_'.$thisfn};
1.65 www 6175: }
1.37 www 6176: if ($ids) {
6177: # ------------------------------------------------------------------- Has ID(s)
6178: my @possibilities=split(/\,/,$ids);
1.39 www 6179: if ($#possibilities==0) {
6180: # ----------------------------------------------- There is only one possibility
1.37 www 6181: my ($mapid,$resid)=split(/\./,$ids);
1.626 albertel 6182: $syval=&encode_symb($bighash{'map_id_'.$mapid},
6183: $resid,$thisfn);
1.249 www 6184: } elsif (!$donotrecurse) {
1.39 www 6185: # ------------------------------------------ There is more than one possibility
6186: my $realpossible=0;
1.191 harris41 6187: foreach (@possibilities) {
1.39 www 6188: my $file=$bighash{'src_'.$_};
6189: if (&allowed('bre',$file)) {
6190: my ($mapid,$resid)=split(/\./,$_);
6191: if ($bighash{'map_type_'.$mapid} ne 'page') {
6192: $realpossible++;
1.626 albertel 6193: $syval=&encode_symb($bighash{'map_id_'.$mapid},
6194: $resid,$thisfn);
1.39 www 6195: }
6196: }
1.191 harris41 6197: }
1.39 www 6198: if ($realpossible!=1) { $syval=''; }
1.249 www 6199: } else {
6200: $syval='';
1.37 www 6201: }
6202: }
6203: untie(%bighash)
1.481 raeburn 6204: }
1.31 www 6205: }
1.62 www 6206: if ($syval) {
1.620 albertel 6207: return $env{$cache_str}=$syval;
1.62 www 6208: }
1.31 www 6209: }
1.44 www 6210: &appenv('request.ambiguous' => $thisfn);
1.620 albertel 6211: return $env{$cache_str}='';
1.31 www 6212: }
6213:
6214: # ---------------------------------------------------------- Return random seed
6215:
1.32 www 6216: sub numval {
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;
1.564 albertel 6225: if ($_64bit) { if ($txt > 2**32) { return -1; } }
1.32 www 6226: return int($txt);
1.368 albertel 6227: }
6228:
1.484 albertel 6229: sub numval2 {
6230: my $txt=shift;
6231: $txt=~tr/A-J/0-9/;
6232: $txt=~tr/a-j/0-9/;
6233: $txt=~tr/K-T/0-9/;
6234: $txt=~tr/k-t/0-9/;
6235: $txt=~tr/U-Z/0-5/;
6236: $txt=~tr/u-z/0-5/;
6237: $txt=~s/\D//g;
6238: my @txts=split(/(\d\d\d\d\d\d\d\d\d)/,$txt);
6239: my $total;
6240: foreach my $val (@txts) { $total+=$val; }
1.564 albertel 6241: if ($_64bit) { if ($total > 2**32) { return -1; } }
1.484 albertel 6242: return int($total);
6243: }
6244:
1.575 albertel 6245: sub numval3 {
6246: use integer;
6247: my $txt=shift;
6248: $txt=~tr/A-J/0-9/;
6249: $txt=~tr/a-j/0-9/;
6250: $txt=~tr/K-T/0-9/;
6251: $txt=~tr/k-t/0-9/;
6252: $txt=~tr/U-Z/0-5/;
6253: $txt=~tr/u-z/0-5/;
6254: $txt=~s/\D//g;
6255: my @txts=split(/(\d\d\d\d\d\d\d\d\d)/,$txt);
6256: my $total;
6257: foreach my $val (@txts) { $total+=$val; }
6258: if ($_64bit) { $total=(($total<<32)>>32); }
6259: return $total;
6260: }
6261:
1.675 albertel 6262: sub digest {
6263: my ($data)=@_;
6264: my $digest=&Digest::MD5::md5($data);
6265: my ($a,$b,$c,$d)=unpack("iiii",$digest);
6266: my ($e,$f);
6267: {
6268: use integer;
6269: $e=($a+$b);
6270: $f=($c+$d);
6271: if ($_64bit) {
6272: $e=(($e<<32)>>32);
6273: $f=(($f<<32)>>32);
6274: }
6275: }
6276: if (wantarray) {
6277: return ($e,$f);
6278: } else {
6279: my $g;
6280: {
6281: use integer;
6282: $g=($e+$f);
6283: if ($_64bit) {
6284: $g=(($g<<32)>>32);
6285: }
6286: }
6287: return $g;
6288: }
6289: }
6290:
1.368 albertel 6291: sub latest_rnd_algorithm_id {
1.675 albertel 6292: return '64bit5';
1.366 albertel 6293: }
1.32 www 6294:
1.503 albertel 6295: sub get_rand_alg {
6296: my ($courseid)=@_;
6297: if (!$courseid) { $courseid=(&Apache::lonxml::whichuser())[1]; }
6298: if ($courseid) {
1.620 albertel 6299: return $env{"course.$courseid.rndseed"};
1.503 albertel 6300: }
6301: return &latest_rnd_algorithm_id();
6302: }
6303:
1.562 albertel 6304: sub validCODE {
6305: my ($CODE)=@_;
6306: if (defined($CODE) && $CODE ne '' && $CODE =~ /^\w+$/) { return 1; }
6307: return 0;
6308: }
6309:
1.491 albertel 6310: sub getCODE {
1.620 albertel 6311: if (&validCODE($env{'form.CODE'})) { return $env{'form.CODE'}; }
1.618 albertel 6312: if ( (defined($Apache::lonhomework::parsing_a_problem) ||
6313: defined($Apache::lonhomework::parsing_a_task) ) &&
6314: &validCODE($Apache::lonhomework::history{'resource.CODE'})) {
1.491 albertel 6315: return $Apache::lonhomework::history{'resource.CODE'};
6316: }
6317: return undef;
6318: }
6319:
1.31 www 6320: sub rndseed {
1.155 albertel 6321: my ($symb,$courseid,$domain,$username)=@_;
1.366 albertel 6322:
6323: my ($wsymb,$wcourseid,$wdomain,$wusername)=&Apache::lonxml::whichuser();
1.155 albertel 6324: if (!$symb) {
1.366 albertel 6325: unless ($symb=$wsymb) { return time; }
6326: }
6327: if (!$courseid) { $courseid=$wcourseid; }
6328: if (!$domain) { $domain=$wdomain; }
6329: if (!$username) { $username=$wusername }
1.503 albertel 6330: my $which=&get_rand_alg();
1.491 albertel 6331: if (defined(&getCODE())) {
1.675 albertel 6332: if ($which eq '64bit5') {
6333: return &rndseed_CODE_64bit5($symb,$courseid,$domain,$username);
6334: } elsif ($which eq '64bit4') {
1.575 albertel 6335: return &rndseed_CODE_64bit4($symb,$courseid,$domain,$username);
6336: } else {
6337: return &rndseed_CODE_64bit($symb,$courseid,$domain,$username);
6338: }
1.675 albertel 6339: } elsif ($which eq '64bit5') {
6340: return &rndseed_64bit5($symb,$courseid,$domain,$username);
1.575 albertel 6341: } elsif ($which eq '64bit4') {
6342: return &rndseed_64bit4($symb,$courseid,$domain,$username);
1.501 albertel 6343: } elsif ($which eq '64bit3') {
6344: return &rndseed_64bit3($symb,$courseid,$domain,$username);
1.443 albertel 6345: } elsif ($which eq '64bit2') {
6346: return &rndseed_64bit2($symb,$courseid,$domain,$username);
1.366 albertel 6347: } elsif ($which eq '64bit') {
6348: return &rndseed_64bit($symb,$courseid,$domain,$username);
6349: }
6350: return &rndseed_32bit($symb,$courseid,$domain,$username);
6351: }
6352:
6353: sub rndseed_32bit {
6354: my ($symb,$courseid,$domain,$username)=@_;
6355: {
6356: use integer;
6357: my $symbchck=unpack("%32C*",$symb) << 27;
6358: my $symbseed=numval($symb) << 22;
6359: my $namechck=unpack("%32C*",$username) << 17;
6360: my $nameseed=numval($username) << 12;
6361: my $domainseed=unpack("%32C*",$domain) << 7;
6362: my $courseseed=unpack("%32C*",$courseid);
6363: my $num=$symbseed+$nameseed+$domainseed+$courseseed+$namechck+$symbchck;
6364: #&Apache::lonxml::debug("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
6365: #&Apache::lonxml::debug("rndseed :$num:$symb");
1.564 albertel 6366: if ($_64bit) { $num=(($num<<32)>>32); }
1.366 albertel 6367: return $num;
6368: }
6369: }
6370:
6371: sub rndseed_64bit {
6372: my ($symb,$courseid,$domain,$username)=@_;
6373: {
6374: use integer;
6375: my $symbchck=unpack("%32S*",$symb) << 21;
6376: my $symbseed=numval($symb) << 10;
6377: my $namechck=unpack("%32S*",$username);
6378:
6379: my $nameseed=numval($username) << 21;
6380: my $domainseed=unpack("%32S*",$domain) << 10;
6381: my $courseseed=unpack("%32S*",$courseid);
6382:
6383: my $num1=$symbchck+$symbseed+$namechck;
6384: my $num2=$nameseed+$domainseed+$courseseed;
6385: #&Apache::lonxml::debug("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
6386: #&Apache::lonxml::debug("rndseed :$num:$symb");
1.564 albertel 6387: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
6388: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
1.366 albertel 6389: return "$num1,$num2";
1.155 albertel 6390: }
1.366 albertel 6391: }
6392:
1.443 albertel 6393: sub rndseed_64bit2 {
6394: my ($symb,$courseid,$domain,$username)=@_;
6395: {
6396: use integer;
6397: # strings need to be an even # of cahracters long, it it is odd the
6398: # last characters gets thrown away
6399: my $symbchck=unpack("%32S*",$symb.' ') << 21;
6400: my $symbseed=numval($symb) << 10;
6401: my $namechck=unpack("%32S*",$username.' ');
6402:
6403: my $nameseed=numval($username) << 21;
1.501 albertel 6404: my $domainseed=unpack("%32S*",$domain.' ') << 10;
6405: my $courseseed=unpack("%32S*",$courseid.' ');
6406:
6407: my $num1=$symbchck+$symbseed+$namechck;
6408: my $num2=$nameseed+$domainseed+$courseseed;
6409: #&Apache::lonxml::debug("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
6410: #&Apache::lonxml::debug("rndseed :$num:$symb");
6411: return "$num1,$num2";
6412: }
6413: }
6414:
6415: sub rndseed_64bit3 {
6416: my ($symb,$courseid,$domain,$username)=@_;
6417: {
6418: use integer;
6419: # strings need to be an even # of cahracters long, it it is odd the
6420: # last characters gets thrown away
6421: my $symbchck=unpack("%32S*",$symb.' ') << 21;
6422: my $symbseed=numval2($symb) << 10;
6423: my $namechck=unpack("%32S*",$username.' ');
6424:
6425: my $nameseed=numval2($username) << 21;
1.443 albertel 6426: my $domainseed=unpack("%32S*",$domain.' ') << 10;
6427: my $courseseed=unpack("%32S*",$courseid.' ');
6428:
6429: my $num1=$symbchck+$symbseed+$namechck;
6430: my $num2=$nameseed+$domainseed+$courseseed;
6431: #&Apache::lonxml::debug("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
1.564 albertel 6432: #&Apache::lonxml::debug("rndseed :$num1:$num2:$_64bit");
6433: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
6434:
1.503 albertel 6435: return "$num1:$num2";
1.443 albertel 6436: }
6437: }
6438:
1.575 albertel 6439: sub rndseed_64bit4 {
6440: my ($symb,$courseid,$domain,$username)=@_;
6441: {
6442: use integer;
6443: # strings need to be an even # of cahracters long, it it is odd the
6444: # last characters gets thrown away
6445: my $symbchck=unpack("%32S*",$symb.' ') << 21;
6446: my $symbseed=numval3($symb) << 10;
6447: my $namechck=unpack("%32S*",$username.' ');
6448:
6449: my $nameseed=numval3($username) << 21;
6450: my $domainseed=unpack("%32S*",$domain.' ') << 10;
6451: my $courseseed=unpack("%32S*",$courseid.' ');
6452:
6453: my $num1=$symbchck+$symbseed+$namechck;
6454: my $num2=$nameseed+$domainseed+$courseseed;
6455: #&Apache::lonxml::debug("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
6456: #&Apache::lonxml::debug("rndseed :$num1:$num2:$_64bit");
6457: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
6458:
6459: return "$num1:$num2";
6460: }
6461: }
6462:
1.675 albertel 6463: sub rndseed_64bit5 {
6464: my ($symb,$courseid,$domain,$username)=@_;
6465: my ($num1,$num2)=&digest("$symb,$courseid,$domain,$username");
6466: return "$num1:$num2";
6467: }
6468:
1.366 albertel 6469: sub rndseed_CODE_64bit {
6470: my ($symb,$courseid,$domain,$username)=@_;
1.155 albertel 6471: {
1.366 albertel 6472: use integer;
1.443 albertel 6473: my $symbchck=unpack("%32S*",$symb.' ') << 16;
1.484 albertel 6474: my $symbseed=numval2($symb);
1.491 albertel 6475: my $CODEchck=unpack("%32S*",&getCODE().' ') << 16;
6476: my $CODEseed=numval(&getCODE());
1.443 albertel 6477: my $courseseed=unpack("%32S*",$courseid.' ');
1.484 albertel 6478: my $num1=$symbseed+$CODEchck;
6479: my $num2=$CODEseed+$courseseed+$symbchck;
6480: #&Apache::lonxml::debug("$symbseed:$CODEchck|$CODEseed:$courseseed:$symbchck");
1.366 albertel 6481: #&Apache::lonxml::debug("rndseed :$num1:$num2:$symb");
1.564 albertel 6482: if ($_64bit) { $num1=(($num1<<32)>>32); }
6483: if ($_64bit) { $num2=(($num2<<32)>>32); }
1.503 albertel 6484: return "$num1:$num2";
1.366 albertel 6485: }
6486: }
6487:
1.575 albertel 6488: sub rndseed_CODE_64bit4 {
6489: my ($symb,$courseid,$domain,$username)=@_;
6490: {
6491: use integer;
6492: my $symbchck=unpack("%32S*",$symb.' ') << 16;
6493: my $symbseed=numval3($symb);
6494: my $CODEchck=unpack("%32S*",&getCODE().' ') << 16;
6495: my $CODEseed=numval3(&getCODE());
6496: my $courseseed=unpack("%32S*",$courseid.' ');
6497: my $num1=$symbseed+$CODEchck;
6498: my $num2=$CODEseed+$courseseed+$symbchck;
6499: #&Apache::lonxml::debug("$symbseed:$CODEchck|$CODEseed:$courseseed:$symbchck");
6500: #&Apache::lonxml::debug("rndseed :$num1:$num2:$symb");
6501: if ($_64bit) { $num1=(($num1<<32)>>32); }
6502: if ($_64bit) { $num2=(($num2<<32)>>32); }
6503: return "$num1:$num2";
6504: }
6505: }
6506:
1.675 albertel 6507: sub rndseed_CODE_64bit5 {
6508: my ($symb,$courseid,$domain,$username)=@_;
6509: my $code = &getCODE();
6510: my ($num1,$num2)=&digest("$symb,$courseid,$code");
6511: return "$num1:$num2";
6512: }
6513:
1.366 albertel 6514: sub setup_random_from_rndseed {
6515: my ($rndseed)=@_;
1.503 albertel 6516: if ($rndseed =~/([,:])/) {
6517: my ($num1,$num2)=split(/[,:]/,$rndseed);
1.366 albertel 6518: &Math::Random::random_set_seed(abs($num1),abs($num2));
6519: } else {
6520: &Math::Random::random_set_seed_from_phrase($rndseed);
1.98 albertel 6521: }
1.36 albertel 6522: }
6523:
1.474 albertel 6524: sub latest_receipt_algorithm_id {
6525: return 'receipt2';
6526: }
6527:
1.480 www 6528: sub recunique {
6529: my $fucourseid=shift;
6530: my $unique;
1.620 albertel 6531: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2') {
6532: $unique=$env{"course.$fucourseid.internal.encseed"};
1.480 www 6533: } else {
6534: $unique=$perlvar{'lonReceipt'};
6535: }
6536: return unpack("%32C*",$unique);
6537: }
6538:
6539: sub recprefix {
6540: my $fucourseid=shift;
6541: my $prefix;
1.620 albertel 6542: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2') {
6543: $prefix=$env{"course.$fucourseid.internal.encpref"};
1.480 www 6544: } else {
6545: $prefix=$perlvar{'lonHostID'};
6546: }
6547: return unpack("%32C*",$prefix);
6548: }
6549:
1.76 www 6550: sub ireceipt {
1.474 albertel 6551: my ($funame,$fudom,$fucourseid,$fusymb,$part)=@_;
1.76 www 6552: my $cuname=unpack("%32C*",$funame);
6553: my $cudom=unpack("%32C*",$fudom);
6554: my $cucourseid=unpack("%32C*",$fucourseid);
6555: my $cusymb=unpack("%32C*",$fusymb);
1.480 www 6556: my $cunique=&recunique($fucourseid);
1.474 albertel 6557: my $cpart=unpack("%32S*",$part);
1.480 www 6558: my $return =&recprefix($fucourseid).'-';
1.620 albertel 6559: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2' ||
6560: $env{'request.state'} eq 'construct') {
1.474 albertel 6561: &Apache::lonxml::debug("doing receipt2 using parts $cpart, uname $cuname and udom $cudom gets ".($cpart%$cuname).
6562: " and ".($cpart%$cudom));
6563:
6564: $return.= ($cunique%$cuname+
6565: $cunique%$cudom+
6566: $cusymb%$cuname+
6567: $cusymb%$cudom+
6568: $cucourseid%$cuname+
6569: $cucourseid%$cudom+
6570: $cpart%$cuname+
6571: $cpart%$cudom);
6572: } else {
6573: $return.= ($cunique%$cuname+
6574: $cunique%$cudom+
6575: $cusymb%$cuname+
6576: $cusymb%$cudom+
6577: $cucourseid%$cuname+
6578: $cucourseid%$cudom);
6579: }
6580: return $return;
1.76 www 6581: }
6582:
6583: sub receipt {
1.474 albertel 6584: my ($part)=@_;
6585: my ($symb,$courseid,$domain,$name) = &Apache::lonxml::whichuser();
6586: return &ireceipt($name,$domain,$courseid,$symb,$part);
1.76 www 6587: }
1.260 ng 6588:
1.36 albertel 6589: # ------------------------------------------------------------ Serves up a file
1.472 albertel 6590: # returns either the contents of the file or
6591: # -1 if the file doesn't exist
1.481 raeburn 6592: #
6593: # if the target is a file that was uploaded via DOCS,
6594: # a check will be made to see if a current copy exists on the local server,
6595: # if it does this will be served, otherwise a copy will be retrieved from
6596: # the home server for the course and stored in /home/httpd/html/userfiles on
6597: # the local server.
1.472 albertel 6598:
1.36 albertel 6599: sub getfile {
1.538 albertel 6600: my ($file) = @_;
1.609 banghart 6601: if ($file =~ m -^/*(uploaded|editupload)/-) { $file=&filelocation("",$file); }
1.538 albertel 6602: &repcopy($file);
6603: return &readfile($file);
6604: }
6605:
6606: sub repcopy_userfile {
6607: my ($file)=@_;
1.609 banghart 6608: if ($file =~ m -^/*(uploaded|editupload)/-) { $file=&filelocation("",$file); }
1.610 albertel 6609: if ($file =~ m|^/home/httpd/html/lonUsers/|) { return 'ok'; }
1.538 albertel 6610: my ($cdom,$cnum,$filename) =
6611: ($file=~m|^\Q$perlvar{'lonDocRoot'}\E/+userfiles/+([^/]+)/+([^/]+)/+(.*)|);
6612: my ($info,$rtncode);
6613: my $uri="/uploaded/$cdom/$cnum/$filename";
6614: if (-e "$file") {
6615: my @fileinfo = stat($file);
6616: my $lwpresp = &getuploaded('HEAD',$uri,$cdom,$cnum,\$info,\$rtncode);
1.482 albertel 6617: if ($lwpresp ne 'ok') {
6618: if ($rtncode eq '404') {
1.538 albertel 6619: unlink($file);
1.482 albertel 6620: }
1.517 albertel 6621: #my $ua=new LWP::UserAgent;
1.538 albertel 6622: #my $request=new HTTP::Request('GET',&tokenwrapper($uri));
1.517 albertel 6623: #my $response=$ua->request($request);
6624: #if ($response->is_success()) {
6625: # return $response->content;
6626: # } else {
6627: # return -1;
6628: # }
1.482 albertel 6629: return -1;
6630: }
6631: if ($info < $fileinfo[9]) {
1.607 raeburn 6632: return 'ok';
1.482 albertel 6633: }
6634: $info = '';
1.538 albertel 6635: $lwpresp = &getuploaded('GET',$uri,$cdom,$cnum,\$info,\$rtncode);
1.482 albertel 6636: if ($lwpresp ne 'ok') {
6637: return -1;
6638: }
6639: } else {
1.538 albertel 6640: my $lwpresp = &getuploaded('GET',$uri,$cdom,$cnum,\$info,\$rtncode);
1.482 albertel 6641: if ($lwpresp ne 'ok') {
1.517 albertel 6642: my $ua=new LWP::UserAgent;
1.538 albertel 6643: my $request=new HTTP::Request('GET',&tokenwrapper($uri));
1.517 albertel 6644: my $response=$ua->request($request);
6645: if ($response->is_success()) {
1.538 albertel 6646: $info=$response->content;
1.517 albertel 6647: } else {
6648: return -1;
6649: }
1.482 albertel 6650: }
6651: my @parts = ($cdom,$cnum);
6652: if ($filename =~ m|^(.+)/[^/]+$|) {
6653: push @parts, split(/\//,$1);
1.518 albertel 6654: }
1.538 albertel 6655: my $path = $perlvar{'lonDocRoot'}.'/userfiles';
1.482 albertel 6656: foreach my $part (@parts) {
6657: $path .= '/'.$part;
6658: if (!-e $path) {
6659: mkdir($path,0770);
6660: }
6661: }
6662: }
1.538 albertel 6663: open(FILE,">$file");
1.482 albertel 6664: print FILE $info;
6665: close(FILE);
1.607 raeburn 6666: return 'ok';
1.481 raeburn 6667: }
6668:
1.517 albertel 6669: sub tokenwrapper {
6670: my $uri=shift;
1.552 albertel 6671: $uri=~s|^http\://([^/]+)||;
6672: $uri=~s|^/||;
1.620 albertel 6673: $env{'user.environment'}=~/\/([^\/]+)\.id/;
1.517 albertel 6674: my $token=$1;
1.552 albertel 6675: my (undef,$udom,$uname,$file)=split('/',$uri,4);
6676: if ($udom && $uname && $file) {
6677: $file=~s|(\?\.*)*$||;
1.620 albertel 6678: &appenv("userfile.$udom/$uname/$file" => $env{'request.course.id'});
1.552 albertel 6679: return 'http://'.$hostname{ &homeserver($uname,$udom)}.'/'.$uri.
1.517 albertel 6680: (($uri=~/\?/)?'&':'?').'token='.$token.
6681: '&tokenissued='.$perlvar{'lonHostID'};
6682: } else {
6683: return '/adm/notfound.html';
6684: }
6685: }
6686:
1.481 raeburn 6687: sub getuploaded {
6688: my ($reqtype,$uri,$cdom,$cnum,$info,$rtncode) = @_;
6689: $uri=~s/^\///;
6690: $uri = 'http://'.$hostname{ &homeserver($cnum,$cdom)}.'/raw/'.$uri;
6691: my $ua=new LWP::UserAgent;
6692: my $request=new HTTP::Request($reqtype,$uri);
6693: my $response=$ua->request($request);
6694: $$rtncode = $response->code;
1.482 albertel 6695: if (! $response->is_success()) {
6696: return 'failed';
6697: }
6698: if ($reqtype eq 'HEAD') {
1.486 www 6699: $$info = &HTTP::Date::str2time( $response->header('Last-modified') );
1.482 albertel 6700: } elsif ($reqtype eq 'GET') {
6701: $$info = $response->content;
1.472 albertel 6702: }
1.482 albertel 6703: return 'ok';
1.36 albertel 6704: }
6705:
1.481 raeburn 6706: sub readfile {
6707: my $file = shift;
6708: if ( (! -e $file ) || ($file eq '') ) { return -1; };
6709: my $fh;
6710: open($fh,"<$file");
6711: my $a='';
6712: while (<$fh>) { $a .=$_; }
6713: return $a;
6714: }
6715:
1.36 albertel 6716: sub filelocation {
1.590 banghart 6717: my ($dir,$file) = @_;
6718: my $location;
6719: $file=~ s/^\s*(\S+)\s*$/$1/; ## strip off leading and trailing spaces
1.700 albertel 6720:
6721: if ($file =~ m-^/adm/-) {
6722: $file=~s-^/adm/wrapper/-/-;
6723: $file=~s-^/adm/coursedocs/showdoc/-/-;
6724: }
1.590 banghart 6725: if ($file=~m:^/~:) { # is a contruction space reference
6726: $location = $file;
6727: $location =~ s:/~(.*?)/(.*):/home/$1/public_html/$2:;
1.649 albertel 6728: } elsif ($file=~m:^/home/[^/]*/public_html/:) {
6729: # is a correct contruction space reference
6730: $location = $file;
1.609 banghart 6731: } elsif ($file=~/^\/*(uploaded|editupload)/) { # is an uploaded file
1.590 banghart 6732: my ($udom,$uname,$filename)=
1.609 banghart 6733: ($file=~m -^/+(?:uploaded|editupload)/+([^/]+)/+([^/]+)/+(.*)$-);
1.590 banghart 6734: my $home=&homeserver($uname,$udom);
6735: my $is_me=0;
6736: my @ids=¤t_machine_ids();
6737: foreach my $id (@ids) { if ($id eq $home) { $is_me=1; } }
6738: if ($is_me) {
1.740 www 6739: $location=&propath($udom,$uname).
1.590 banghart 6740: '/userfiles/'.$filename;
6741: } else {
6742: $location=$Apache::lonnet::perlvar{'lonDocRoot'}.'/userfiles/'.
6743: $udom.'/'.$uname.'/'.$filename;
6744: }
6745: } else {
6746: $file=~s/^\Q$perlvar{'lonDocRoot'}\E//;
6747: $file=~s:^/res/:/:;
6748: if ( !( $file =~ m:^/:) ) {
6749: $location = $dir. '/'.$file;
6750: } else {
6751: $location = '/home/httpd/html/res'.$file;
6752: }
1.59 albertel 6753: }
1.590 banghart 6754: $location=~s://+:/:g; # remove duplicate /
6755: while ($location=~m:/\.\./:) {$location=~ s:/[^/]+/\.\./:/:g;} #remove dir/..
6756: while ($location=~m:/\./:) {$location=~ s:/\./:/:g;} #remove /./
6757: return $location;
1.46 www 6758: }
1.36 albertel 6759:
1.46 www 6760: sub hreflocation {
6761: my ($dir,$file)=@_;
1.460 albertel 6762: unless (($file=~m-^http://-i) || ($file=~m-^/-)) {
1.666 albertel 6763: $file=filelocation($dir,$file);
1.700 albertel 6764: } elsif ($file=~m-^/adm/-) {
6765: $file=~s-^/adm/wrapper/-/-;
6766: $file=~s-^/adm/coursedocs/showdoc/-/-;
1.666 albertel 6767: }
6768: if ($file=~m-^\Q$perlvar{'lonDocRoot'}\E-) {
6769: $file=~s-^\Q$perlvar{'lonDocRoot'}\E--;
6770: } elsif ($file=~m-/home/(\w+)/public_html/-) {
1.462 albertel 6771: $file=~s-^/home/(\w+)/public_html/-/~$1/-;
1.666 albertel 6772: } elsif ($file=~m-^\Q$perlvar{'lonUsersDir'}\E-) {
6773: $file=~s-^/home/httpd/lonUsers/([^/]*)/./././([^/]*)/userfiles/
6774: -/uploaded/$1/$2/-x;
1.46 www 6775: }
1.462 albertel 6776: return $file;
1.465 albertel 6777: }
6778:
6779: sub current_machine_domains {
6780: my $hostname=$hostname{$perlvar{'lonHostID'}};
6781: my @domains;
6782: while( my($id, $name) = each(%hostname)) {
1.467 matthew 6783: # &logthis("-$id-$name-$hostname-");
1.465 albertel 6784: if ($hostname eq $name) {
6785: push(@domains,$hostdom{$id});
6786: }
6787: }
6788: return @domains;
6789: }
6790:
6791: sub current_machine_ids {
6792: my $hostname=$hostname{$perlvar{'lonHostID'}};
6793: my @ids;
6794: while( my($id, $name) = each(%hostname)) {
1.467 matthew 6795: # &logthis("-$id-$name-$hostname-");
1.465 albertel 6796: if ($hostname eq $name) {
6797: push(@ids,$id);
6798: }
6799: }
6800: return @ids;
1.31 www 6801: }
6802:
6803: # ------------------------------------------------------------- Declutters URLs
6804:
6805: sub declutter {
6806: my $thisfn=shift;
1.569 albertel 6807: if ($thisfn=~m|^/enc/|) { $thisfn=&Apache::lonenc::unencrypted($thisfn); }
1.479 albertel 6808: $thisfn=~s/^\Q$perlvar{'lonDocRoot'}\E//;
1.31 www 6809: $thisfn=~s/^\///;
1.697 albertel 6810: $thisfn=~s|^adm/wrapper/||;
6811: $thisfn=~s|^adm/coursedocs/showdoc/||;
1.31 www 6812: $thisfn=~s/^res\///;
1.235 www 6813: $thisfn=~s/\?.+$//;
1.268 www 6814: return $thisfn;
6815: }
6816:
6817: # ------------------------------------------------------------- Clutter up URLs
6818:
6819: sub clutter {
6820: my $thisfn='/'.&declutter(shift);
1.609 banghart 6821: unless ($thisfn=~/^\/(uploaded|editupload|adm|userfiles|ext|raw|priv|public)\//) {
1.270 www 6822: $thisfn='/res'.$thisfn;
6823: }
1.694 albertel 6824: if ($thisfn !~m|/adm|) {
1.695 albertel 6825: if ($thisfn =~ m|/ext/|) {
1.694 albertel 6826: $thisfn='/adm/wrapper'.$thisfn;
1.695 albertel 6827: } else {
6828: my ($ext) = ($thisfn =~ /\.(\w+)$/);
6829: my $embstyle=&Apache::loncommon::fileembstyle($ext);
1.698 albertel 6830: if ($embstyle eq 'ssi'
6831: || ($embstyle eq 'hdn')
6832: || ($embstyle eq 'rat')
6833: || ($embstyle eq 'prv')
6834: || ($embstyle eq 'ign')) {
6835: #do nothing with these
6836: } elsif (($embstyle eq 'img')
1.695 albertel 6837: || ($embstyle eq 'emb')
6838: || ($embstyle eq 'wrp')) {
6839: $thisfn='/adm/wrapper'.$thisfn;
1.698 albertel 6840: } elsif ($embstyle eq 'unk'
6841: && $thisfn!~/\.(sequence|page)$/) {
1.695 albertel 6842: $thisfn='/adm/coursedocs/showdoc'.$thisfn;
1.698 albertel 6843: } else {
1.718 www 6844: # &logthis("Got a blank emb style");
1.695 albertel 6845: }
1.694 albertel 6846: }
6847: }
1.31 www 6848: return $thisfn;
1.12 www 6849: }
6850:
1.557 albertel 6851: sub freeze_escape {
6852: my ($value)=@_;
6853: if (ref($value)) {
6854: $value=&nfreeze($value);
6855: return '__FROZEN__'.&escape($value);
6856: }
6857: return &escape($value);
6858: }
6859:
1.11 www 6860:
1.557 albertel 6861: sub thaw_unescape {
6862: my ($value)=@_;
6863: if ($value =~ /^__FROZEN__/) {
6864: substr($value,0,10,undef);
6865: $value=&unescape($value);
6866: return &thaw($value);
6867: }
6868: return &unescape($value);
6869: }
6870:
1.436 albertel 6871: sub correct_line_ends {
6872: my ($result)=@_;
6873: $$result =~s/\r\n/\n/mg;
6874: $$result =~s/\r/\n/mg;
1.415 albertel 6875: }
1.1 albertel 6876: # ================================================================ Main Program
6877:
1.184 www 6878: sub goodbye {
1.204 albertel 6879: &logthis("Starting Shut down");
1.443 albertel 6880: #not converted to using infrastruture and probably shouldn't be
1.599 albertel 6881: &logthis(sprintf("%-20s is %s",'%badServerCache',length(&freeze(\%badServerCache))));
1.443 albertel 6882: #converted
1.599 albertel 6883: # &logthis(sprintf("%-20s is %s",'%metacache',scalar(%metacache)));
6884: &logthis(sprintf("%-20s is %s",'%homecache',length(&freeze(\%homecache))));
6885: # &logthis(sprintf("%-20s is %s",'%titlecache',length(&freeze(\%titlecache))));
6886: # &logthis(sprintf("%-20s is %s",'%courseresdatacache',length(&freeze(\%courseresdatacache))));
1.425 albertel 6887: #1.1 only
1.599 albertel 6888: # &logthis(sprintf("%-20s is %s",'%userresdatacache',length(&freeze(\%userresdatacache))));
6889: # &logthis(sprintf("%-20s is %s",'%getsectioncache',length(&freeze(\%getsectioncache))));
6890: # &logthis(sprintf("%-20s is %s",'%courseresversioncache',length(&freeze(\%courseresversioncache))));
6891: # &logthis(sprintf("%-20s is %s",'%resversioncache',length(&freeze(\%resversioncache))));
6892: &logthis(sprintf("%-20s is %s",'%remembered',length(&freeze(\%remembered))));
6893: &logthis(sprintf("%-20s is %s",'kicks',$kicks));
6894: &logthis(sprintf("%-20s is %s",'hits',$hits));
1.184 www 6895: &flushcourselogs();
6896: &logthis("Shutting down");
6897: }
6898:
1.179 www 6899: BEGIN {
1.228 harris41 6900: # ----------------------------------- Read loncapa.conf and loncapa_apache.conf
1.195 www 6901: unless ($readit) {
1.217 harris41 6902: {
1.581 matthew 6903: # FIXME: Use LONCAPA::Configuration::read_conf here and omit next block
1.448 albertel 6904: open(my $config,"</etc/httpd/conf/loncapa.conf");
1.217 harris41 6905:
6906: while (my $configline=<$config>) {
1.484 albertel 6907: if ($configline=~/\S/ && $configline =~ /^[^\#]*PerlSetVar/) {
1.1 albertel 6908: my ($dummy,$varname,$varvalue)=split(/\s+/,$configline);
1.8 www 6909: chomp($varvalue);
1.1 albertel 6910: $perlvar{$varname}=$varvalue;
6911: }
6912: }
1.448 albertel 6913: close($config);
1.1 albertel 6914: }
1.227 harris41 6915: {
1.448 albertel 6916: open(my $config,"</etc/httpd/conf/loncapa_apache.conf");
1.227 harris41 6917:
6918: while (my $configline=<$config>) {
6919: if ($configline =~ /^[^\#]*PerlSetVar/) {
6920: my ($dummy,$varname,$varvalue)=split(/\s+/,$configline);
6921: chomp($varvalue);
6922: $perlvar{$varname}=$varvalue;
6923: }
6924: }
1.448 albertel 6925: close($config);
1.227 harris41 6926: }
1.1 albertel 6927:
1.327 albertel 6928: # ------------------------------------------------------------ Read domain file
6929: {
6930: %domaindescription = ();
6931: %domain_auth_def = ();
6932: %domain_auth_arg_def = ();
1.448 albertel 6933: my $fh;
6934: if (open($fh,"<".$Apache::lonnet::perlvar{'lonTabDir'}.'/domain.tab')) {
1.327 albertel 6935: while (<$fh>) {
1.390 matthew 6936: next if (/^(\#|\s*$)/);
6937: # next if /^\#/;
1.327 albertel 6938: chomp;
1.403 www 6939: my ($domain, $domain_description, $def_auth, $def_auth_arg,
1.685 raeburn 6940: $def_lang, $city, $longi, $lati, $primary) = split(/:/,$_);
1.403 www 6941: $domain_auth_def{$domain}=$def_auth;
1.327 albertel 6942: $domain_auth_arg_def{$domain}=$def_auth_arg;
1.403 www 6943: $domaindescription{$domain}=$domain_description;
6944: $domain_lang_def{$domain}=$def_lang;
6945: $domain_city{$domain}=$city;
6946: $domain_longi{$domain}=$longi;
6947: $domain_lati{$domain}=$lati;
1.685 raeburn 6948: $domain_primary{$domain}=$primary;
1.403 www 6949:
1.448 albertel 6950: # &logthis("Domain.tab: $domain, $domain_auth_def{$domain}, $domain_auth_arg_def{$domain},$domaindescription{$domain}");
1.327 albertel 6951: # &logthis("Domain.tab: $domain ".$domaindescription{$domain} );
1.448 albertel 6952: }
1.327 albertel 6953: }
1.448 albertel 6954: close ($fh);
1.327 albertel 6955: }
6956:
6957:
1.1 albertel 6958: # ------------------------------------------------------------- Read hosts file
6959: {
1.448 albertel 6960: open(my $config,"<$perlvar{'lonTabDir'}/hosts.tab");
1.1 albertel 6961:
6962: while (my $configline=<$config>) {
1.303 matthew 6963: next if ($configline =~ /^(\#|\s*$)/);
1.154 www 6964: chomp($configline);
1.595 albertel 6965: my ($id,$domain,$role,$name)=split(/:/,$configline);
1.597 albertel 6966: $name=~s/\s//g;
1.595 albertel 6967: if ($id && $domain && $role && $name) {
1.252 albertel 6968: $hostname{$id}=$name;
6969: $hostdom{$id}=$domain;
6970: if ($role eq 'library') { $libserv{$id}=$name; }
1.245 www 6971: }
1.1 albertel 6972: }
1.448 albertel 6973: close($config);
1.619 albertel 6974: # FIXME: dev server don't want this, production servers _do_ want this
1.654 albertel 6975: #&get_iphost();
1.1 albertel 6976: }
6977:
1.598 albertel 6978: sub get_iphost {
6979: if (%iphost) { return %iphost; }
1.653 albertel 6980: my %name_to_ip;
1.598 albertel 6981: foreach my $id (keys(%hostname)) {
6982: my $name=$hostname{$id};
1.653 albertel 6983: my $ip;
6984: if (!exists($name_to_ip{$name})) {
6985: $ip = gethostbyname($name);
6986: if (!$ip || length($ip) ne 4) {
6987: &logthis("Skipping host $id name $name no IP found\n");
6988: next;
6989: }
6990: $ip=inet_ntoa($ip);
6991: $name_to_ip{$name} = $ip;
6992: } else {
6993: $ip = $name_to_ip{$name};
1.598 albertel 6994: }
6995: push(@{$iphost{$ip}},$id);
6996: }
6997: return %iphost;
6998: }
6999:
1.1 albertel 7000: # ------------------------------------------------------ Read spare server file
7001: {
1.448 albertel 7002: open(my $config,"<$perlvar{'lonTabDir'}/spare.tab");
1.1 albertel 7003:
7004: while (my $configline=<$config>) {
7005: chomp($configline);
1.284 matthew 7006: if ($configline) {
1.1 albertel 7007: $spareid{$configline}=1;
7008: }
7009: }
1.448 albertel 7010: close($config);
1.1 albertel 7011: }
1.11 www 7012: # ------------------------------------------------------------ Read permissions
7013: {
1.448 albertel 7014: open(my $config,"<$perlvar{'lonTabDir'}/roles.tab");
1.11 www 7015:
7016: while (my $configline=<$config>) {
1.448 albertel 7017: chomp($configline);
7018: if ($configline) {
7019: my ($role,$perm)=split(/ /,$configline);
7020: if ($perm ne '') { $pr{$role}=$perm; }
7021: }
1.11 www 7022: }
1.448 albertel 7023: close($config);
1.11 www 7024: }
7025:
7026: # -------------------------------------------- Read plain texts for permissions
7027: {
1.448 albertel 7028: open(my $config,"<$perlvar{'lonTabDir'}/rolesplain.tab");
1.11 www 7029:
7030: while (my $configline=<$config>) {
1.448 albertel 7031: chomp($configline);
7032: if ($configline) {
1.742 raeburn 7033: my ($short,@plain)=split(/:/,$configline);
7034: %{$prp{$short}} = ();
7035: if (@plain > 0) {
7036: $prp{$short}{'std'} = $plain[0];
7037: for (my $i=1; $i<@plain; $i++) {
7038: $prp{$short}{'alt'.$i} = $plain[$i];
7039: }
7040: }
1.448 albertel 7041: }
1.135 www 7042: }
1.448 albertel 7043: close($config);
1.135 www 7044: }
7045:
7046: # ---------------------------------------------------------- Read package table
7047: {
1.448 albertel 7048: open(my $config,"<$perlvar{'lonTabDir'}/packages.tab");
1.135 www 7049:
7050: while (my $configline=<$config>) {
1.483 albertel 7051: if ($configline !~ /\S/ || $configline=~/^#/) { next; }
1.448 albertel 7052: chomp($configline);
7053: my ($short,$plain)=split(/:/,$configline);
7054: my ($pack,$name)=split(/\&/,$short);
7055: if ($plain ne '') {
7056: $packagetab{$pack.'&'.$name.'&name'}=$name;
7057: $packagetab{$short}=$plain;
7058: }
1.11 www 7059: }
1.448 albertel 7060: close($config);
1.329 matthew 7061: }
7062:
7063: # ------------- set up temporary directory
7064: {
7065: $tmpdir = $perlvar{'lonDaemons'}.'/tmp/';
7066:
1.11 www 7067: }
7068:
1.599 albertel 7069: $memcache=new Cache::Memcached({'servers'=>['127.0.0.1:11211']});
1.185 www 7070:
1.281 www 7071: $processmarker='_'.time.'_'.$perlvar{'lonHostID'};
1.186 www 7072: $dumpcount=0;
1.22 www 7073:
1.163 harris41 7074: &logtouch();
1.672 albertel 7075: &logthis('<font color="yellow">INFO: Read configuration</font>');
1.195 www 7076: $readit=1;
1.564 albertel 7077: {
7078: use integer;
7079: my $test=(2**32)+1;
1.568 albertel 7080: if ($test != 0) { $_64bit=1; } else { $_64bit=0; }
1.564 albertel 7081: &logthis(" Detected 64bit platform ($_64bit)");
7082: }
1.195 www 7083: }
1.1 albertel 7084: }
1.179 www 7085:
1.1 albertel 7086: 1;
1.191 harris41 7087: __END__
7088:
1.243 albertel 7089: =pod
7090:
1.191 harris41 7091: =head1 NAME
7092:
1.243 albertel 7093: Apache::lonnet - Subroutines to ask questions about things in the network.
1.191 harris41 7094:
7095: =head1 SYNOPSIS
7096:
1.243 albertel 7097: Invoked by other LON-CAPA modules, when they need to talk to or about objects in the network.
1.191 harris41 7098:
7099: &Apache::lonnet::SUBROUTINENAME(ARGUMENTS);
7100:
1.243 albertel 7101: Common parameters:
7102:
7103: =over 4
7104:
7105: =item *
7106:
7107: $uname : an internal username (if $cname expecting a course Id specifically)
7108:
7109: =item *
7110:
7111: $udom : a domain (if $cdom expecting a course's domain specifically)
7112:
7113: =item *
7114:
7115: $symb : a resource instance identifier
7116:
7117: =item *
7118:
7119: $namespace : the name of a .db file that contains the data needed or
7120: being set.
7121:
7122: =back
7123:
1.394 bowersj2 7124: =head1 OVERVIEW
1.191 harris41 7125:
1.394 bowersj2 7126: lonnet provides subroutines which interact with the
7127: lonc/lond (TCP) network layer of LON-CAPA. They can be used to ask
7128: about classes, users, and resources.
1.243 albertel 7129:
7130: For many of these objects you can also use this to store data about
7131: them or modify them in various ways.
1.191 harris41 7132:
1.394 bowersj2 7133: =head2 Symbs
1.191 harris41 7134:
1.394 bowersj2 7135: To identify a specific instance of a resource, LON-CAPA uses symbols
7136: or "symbs"X<symb>. These identifiers are built from the URL of the
7137: map, the resource number of the resource in the map, and the URL of
7138: the resource itself. The latter is somewhat redundant, but might help
7139: if maps change.
7140:
7141: An example is
7142:
7143: msu/korte/parts/part1.sequence___19___msu/korte/tests/part12.problem
7144:
7145: The respective map entry is
7146:
7147: <resource id="19" src="/res/msu/korte/tests/part12.problem"
7148: title="Problem 2">
7149: </resource>
7150:
7151: Symbs are used by the random number generator, as well as to store and
7152: restore data specific to a certain instance of for example a problem.
7153:
7154: =head2 Storing And Retrieving Data
7155:
7156: X<store()>X<cstore()>X<restore()>Three of the most important functions
7157: in C<lonnet.pm> are C<&Apache::lonnet::cstore()>,
7158: C<&Apache::lonnet:restore()>, and C<&Apache::lonnet::store()>, which
7159: is is the non-critical message twin of cstore. These functions are for
7160: handlers to store a perl hash to a user's permanent data space in an
7161: easy manner, and to retrieve it again on another call. It is expected
7162: that a handler would use this once at the beginning to retrieve data,
7163: and then again once at the end to send only the new data back.
7164:
7165: The data is stored in the user's data directory on the user's
7166: homeserver under the ID of the course.
7167:
7168: The hash that is returned by restore will have all of the previous
7169: value for all of the elements of the hash.
7170:
7171: Example:
7172:
7173: #creating a hash
7174: my %hash;
7175: $hash{'foo'}='bar';
7176:
7177: #storing it
7178: &Apache::lonnet::cstore(\%hash);
7179:
7180: #changing a value
7181: $hash{'foo'}='notbar';
7182:
7183: #adding a new value
7184: $hash{'bar'}='foo';
7185: &Apache::lonnet::cstore(\%hash);
7186:
7187: #retrieving the hash
7188: my %history=&Apache::lonnet::restore();
7189:
7190: #print the hash
7191: foreach my $key (sort(keys(%history))) {
7192: print("\%history{$key} = $history{$key}");
7193: }
7194:
7195: Will print out:
1.191 harris41 7196:
1.394 bowersj2 7197: %history{1:foo} = bar
7198: %history{1:keys} = foo:timestamp
7199: %history{1:timestamp} = 990455579
7200: %history{2:bar} = foo
7201: %history{2:foo} = notbar
7202: %history{2:keys} = foo:bar:timestamp
7203: %history{2:timestamp} = 990455580
7204: %history{bar} = foo
7205: %history{foo} = notbar
7206: %history{timestamp} = 990455580
7207: %history{version} = 2
7208:
7209: Note that the special hash entries C<keys>, C<version> and
7210: C<timestamp> were added to the hash. C<version> will be equal to the
7211: total number of versions of the data that have been stored. The
7212: C<timestamp> attribute will be the UNIX time the hash was
7213: stored. C<keys> is available in every historical section to list which
7214: keys were added or changed at a specific historical revision of a
7215: hash.
7216:
7217: B<Warning>: do not store the hash that restore returns directly. This
7218: will cause a mess since it will restore the historical keys as if the
7219: were new keys. I.E. 1:foo will become 1:1:foo etc.
1.191 harris41 7220:
1.394 bowersj2 7221: Calling convention:
1.191 harris41 7222:
1.394 bowersj2 7223: my %record=&Apache::lonnet::restore($symb,$courseid,$domain,$uname,$home);
7224: &Apache::lonnet::cstore(\%newrecord,$symb,$courseid,$domain,$uname,$home);
1.191 harris41 7225:
1.394 bowersj2 7226: For more detailed information, see lonnet specific documentation.
1.191 harris41 7227:
1.394 bowersj2 7228: =head1 RETURN MESSAGES
1.191 harris41 7229:
1.394 bowersj2 7230: =over 4
1.191 harris41 7231:
1.394 bowersj2 7232: =item * B<con_lost>: unable to contact remote host
1.191 harris41 7233:
1.394 bowersj2 7234: =item * B<con_delayed>: unable to contact remote host, message will be delivered
7235: when the connection is brought back up
1.191 harris41 7236:
1.394 bowersj2 7237: =item * B<con_failed>: unable to contact remote host and unable to save message
7238: for later delivery
1.191 harris41 7239:
1.394 bowersj2 7240: =item * B<error:>: an error a occured, a description of the error follows the :
1.191 harris41 7241:
1.394 bowersj2 7242: =item * B<no_such_host>: unable to fund a host associated with the user/domain
1.243 albertel 7243: that was requested
1.191 harris41 7244:
1.243 albertel 7245: =back
1.191 harris41 7246:
1.243 albertel 7247: =head1 PUBLIC SUBROUTINES
1.191 harris41 7248:
1.243 albertel 7249: =head2 Session Environment Functions
1.191 harris41 7250:
1.243 albertel 7251: =over 4
1.191 harris41 7252:
1.394 bowersj2 7253: =item *
7254: X<appenv()>
7255: B<appenv(%hash)>: the value of %hash is written to
7256: the user envirnoment file, and will be restored for each access this
1.620 albertel 7257: user makes during this session, also modifies the %env for the current
1.394 bowersj2 7258: process
1.191 harris41 7259:
7260: =item *
1.394 bowersj2 7261: X<delenv()>
7262: B<delenv($regexp)>: removes all items from the session
7263: environment file that matches the regular expression in $regexp. The
1.620 albertel 7264: values are also delted from the current processes %env.
1.191 harris41 7265:
1.243 albertel 7266: =back
7267:
7268: =head2 User Information
1.191 harris41 7269:
1.243 albertel 7270: =over 4
1.191 harris41 7271:
7272: =item *
1.394 bowersj2 7273: X<queryauthenticate()>
7274: B<queryauthenticate($uname,$udom)>: try to determine user's current
1.191 harris41 7275: authentication scheme
7276:
7277: =item *
1.394 bowersj2 7278: X<authenticate()>
7279: B<authenticate($uname,$upass,$udom)>: try to
7280: authenticate user from domain's lib servers (first use the current
7281: one). C<$upass> should be the users password.
1.191 harris41 7282:
7283: =item *
1.394 bowersj2 7284: X<homeserver()>
7285: B<homeserver($uname,$udom)>: find the server which has
7286: the user's directory and files (there must be only one), this caches
7287: the answer, and also caches if there is a borken connection.
1.191 harris41 7288:
7289: =item *
1.394 bowersj2 7290: X<idget()>
7291: B<idget($udom,@ids)>: find the usernames behind a list of IDs
7292: (IDs are a unique resource in a domain, there must be only 1 ID per
7293: username, and only 1 username per ID in a specific domain) (returns
7294: hash: id=>name,id=>name)
1.191 harris41 7295:
7296: =item *
1.394 bowersj2 7297: X<idrget()>
7298: B<idrget($udom,@unames)>: find the IDs behind a list of
7299: usernames (returns hash: name=>id,name=>id)
1.191 harris41 7300:
7301: =item *
1.394 bowersj2 7302: X<idput()>
7303: B<idput($udom,%ids)>: store away a list of names and associated IDs
1.191 harris41 7304:
7305: =item *
1.394 bowersj2 7306: X<rolesinit()>
7307: B<rolesinit($udom,$username,$authhost)>: get user privileges
1.243 albertel 7308:
7309: =item *
1.551 albertel 7310: X<getsection()>
7311: B<getsection($udom,$uname,$cname)>: finds the section of student in the
1.243 albertel 7312: course $cname, return section name/number or '' for "not in course"
7313: and '-1' for "no section"
7314:
7315: =item *
1.394 bowersj2 7316: X<userenvironment()>
7317: B<userenvironment($udom,$uname,@what)>: gets the values of the keys
1.243 albertel 7318: passed in @what from the requested user's environment, returns a hash
7319:
7320: =back
7321:
7322: =head2 User Roles
7323:
7324: =over 4
7325:
7326: =item *
7327:
7328: allowed($priv,$uri) : check for a user privilege; returns codes for allowed
7329: actions
7330: F: full access
7331: U,I,K: authentication modes (cxx only)
7332: '': forbidden
7333: 1: user needs to choose course
7334: 2: browse allowed
7335:
7336: =item *
7337:
7338: definerole($rolename,$sysrole,$domrole,$courole) : define role; define a custom
7339: role rolename set privileges in format of lonTabs/roles.tab for system, domain,
7340: and course level
7341:
7342: =item *
7343:
7344: plaintext($short) : return value in %prp hash (rolesplain.tab); plain text
7345: explanation of a user role term
7346:
7347: =back
7348:
7349: =head2 User Modification
7350:
7351: =over 4
7352:
7353: =item *
7354:
7355: assignrole($udom,$uname,$url,$role,$end,$start) : assign role; give a role to a
7356: user for the level given by URL. Optional start and end dates (leave empty
7357: string or zero for "no date")
1.191 harris41 7358:
7359: =item *
7360:
1.243 albertel 7361: changepass($uname,$udom,$currentpass,$newpass,$server) : attempts to
7362: change a users, password, possible return values are: ok,
7363: pwchange_failure, non_authorized, auth_mode_error, unknown_user,
7364: refused
1.191 harris41 7365:
7366: =item *
7367:
1.243 albertel 7368: modifyuserauth($udom,$uname,$umode,$upass) : modify user authentication
1.191 harris41 7369:
7370: =item *
7371:
1.243 albertel 7372: modifyuser($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene) :
7373: modify user
1.191 harris41 7374:
7375: =item *
7376:
1.286 matthew 7377: modifystudent
7378:
7379: modify a students enrollment and identification information.
7380: The course id is resolved based on the current users environment.
7381: This means the envoking user must be a course coordinator or otherwise
7382: associated with a course.
7383:
1.297 matthew 7384: This call is essentially a wrapper for lonnet::modifyuser and
7385: lonnet::modify_student_enrollment
1.286 matthew 7386:
7387: Inputs:
7388:
7389: =over 4
7390:
7391: =item B<$udom> Students loncapa domain
7392:
7393: =item B<$uname> Students loncapa login name
7394:
7395: =item B<$uid> Students id/student number
7396:
7397: =item B<$umode> Students authentication mode
7398:
7399: =item B<$upass> Students password
7400:
7401: =item B<$first> Students first name
7402:
7403: =item B<$middle> Students middle name
7404:
7405: =item B<$last> Students last name
7406:
7407: =item B<$gene> Students generation
7408:
7409: =item B<$usec> Students section in course
7410:
7411: =item B<$end> Unix time of the roles expiration
7412:
7413: =item B<$start> Unix time of the roles start date
7414:
7415: =item B<$forceid> If defined, allow $uid to be changed
7416:
7417: =item B<$desiredhome> server to use as home server for student
7418:
7419: =back
1.297 matthew 7420:
7421: =item *
7422:
7423: modify_student_enrollment
7424:
7425: Change a students enrollment status in a class. The environment variable
7426: 'role.request.course' must be defined for this function to proceed.
7427:
7428: Inputs:
7429:
7430: =over 4
7431:
7432: =item $udom, students domain
7433:
7434: =item $uname, students name
7435:
7436: =item $uid, students user id
7437:
7438: =item $first, students first name
7439:
7440: =item $middle
7441:
7442: =item $last
7443:
7444: =item $gene
7445:
7446: =item $usec
7447:
7448: =item $end
7449:
7450: =item $start
7451:
7452: =back
7453:
1.191 harris41 7454:
7455: =item *
7456:
1.243 albertel 7457: assigncustomrole($udom,$uname,$url,$rdom,$rnam,$rolename,$end,$start) : assign
7458: custom role; give a custom role to a user for the level given by URL. Specify
7459: name and domain of role author, and role name
1.191 harris41 7460:
7461: =item *
7462:
1.243 albertel 7463: revokerole($udom,$uname,$url,$role) : revoke a role for url
1.191 harris41 7464:
7465: =item *
7466:
1.243 albertel 7467: revokecustomrole($udom,$uname,$url,$role) : revoke a custom role
7468:
7469: =back
7470:
7471: =head2 Course Infomation
7472:
7473: =over 4
1.191 harris41 7474:
7475: =item *
7476:
1.631 albertel 7477: coursedescription($courseid) : returns a hash of information about the
7478: specified course id, including all environment settings for the
7479: course, the description of the course will be in the hash under the
7480: key 'description'
1.191 harris41 7481:
7482: =item *
7483:
1.624 albertel 7484: resdata($name,$domain,$type,@which) : request for current parameter
7485: setting for a specific $type, where $type is either 'course' or 'user',
7486: @what should be a list of parameters to ask about. This routine caches
7487: answers for 5 minutes.
1.243 albertel 7488:
7489: =back
7490:
7491: =head2 Course Modification
7492:
7493: =over 4
1.191 harris41 7494:
7495: =item *
7496:
1.243 albertel 7497: writecoursepref($courseid,%prefs) : write preferences (environment
7498: database) for a course
1.191 harris41 7499:
7500: =item *
7501:
1.243 albertel 7502: createcourse($udom,$description,$url) : make/modify course
7503:
7504: =back
7505:
7506: =head2 Resource Subroutines
7507:
7508: =over 4
1.191 harris41 7509:
7510: =item *
7511:
1.243 albertel 7512: subscribe($fname) : subscribe to a resource, returns URL if possible (probably should use repcopy instead)
1.191 harris41 7513:
7514: =item *
7515:
1.243 albertel 7516: repcopy($filename) : subscribes to the requested file, and attempts to
7517: replicate from the owning library server, Might return
1.607 raeburn 7518: 'unavailable', 'not_found', 'forbidden', 'ok', or
7519: 'bad_request', also attempts to grab the metadata for the
1.243 albertel 7520: resource. Expects the local filesystem pathname
7521: (/home/httpd/html/res/....)
7522:
7523: =back
7524:
7525: =head2 Resource Information
7526:
7527: =over 4
1.191 harris41 7528:
7529: =item *
7530:
1.243 albertel 7531: EXT($varname,$symb,$udom,$uname) : evaluates and returns the value of
7532: a vairety of different possible values, $varname should be a request
7533: string, and the other parameters can be used to specify who and what
7534: one is asking about.
7535:
7536: Possible values for $varname are environment.lastname (or other item
7537: from the envirnment hash), user.name (or someother aspect about the
7538: user), resource.0.maxtries (or some other part and parameter of a
7539: resource)
1.204 albertel 7540:
7541: =item *
7542:
1.243 albertel 7543: directcondval($number) : get current value of a condition; reads from a state
7544: string
1.204 albertel 7545:
7546: =item *
7547:
1.243 albertel 7548: condval($condidx) : value of condition index based on state
1.204 albertel 7549:
7550: =item *
7551:
1.243 albertel 7552: metadata($uri,$what,$liburi,$prefix,$depthcount) : request a
7553: resource's metadata, $what should be either a specific key, or either
7554: 'keys' (to get a list of possible keys) or 'packages' to get a list of
7555: packages that this resource currently uses, the last 3 arguments are only used internally for recursive metadata.
7556:
7557: this function automatically caches all requests
1.191 harris41 7558:
7559: =item *
7560:
1.243 albertel 7561: metadata_query($query,$custom,$customshow) : make a metadata query against the
7562: network of library servers; returns file handle of where SQL and regex results
7563: will be stored for query
1.191 harris41 7564:
7565: =item *
7566:
1.243 albertel 7567: symbread($filename) : return symbolic list entry (filename argument optional);
7568: returns the data handle
1.191 harris41 7569:
7570: =item *
7571:
1.243 albertel 7572: symbverify($symb,$thisfn) : verifies that $symb actually exists and is
1.582 albertel 7573: a possible symb for the URL in $thisfn, and if is an encryypted
7574: resource that the user accessed using /enc/ returns a 1 on success, 0
7575: on failure, user must be in a course, as it assumes the existance of
1.620 albertel 7576: the course initial hash, and uses $env('request.course.id'}
1.243 albertel 7577:
1.191 harris41 7578:
7579: =item *
7580:
1.243 albertel 7581: symbclean($symb) : removes versions numbers from a symb, returns the
7582: cleaned symb
1.191 harris41 7583:
7584: =item *
7585:
1.243 albertel 7586: is_on_map($uri) : checks if the $uri is somewhere on the current
7587: course map, user must be in a course for it to work.
1.191 harris41 7588:
7589: =item *
7590:
1.243 albertel 7591: numval($salt) : return random seed value (addend for rndseed)
1.191 harris41 7592:
7593: =item *
7594:
1.243 albertel 7595: rndseed($symb,$courseid,$udom,$uname) : create a random sum; returns
7596: a random seed, all arguments are optional, if they aren't sent it uses the
7597: environment to derive them. Note: if symb isn't sent and it can't get one
7598: from &symbread it will use the current time as its return value
1.191 harris41 7599:
7600: =item *
7601:
1.243 albertel 7602: ireceipt($funame,$fudom,$fucourseid,$fusymb) : return unique,
7603: unfakeable, receipt
1.191 harris41 7604:
7605: =item *
7606:
1.620 albertel 7607: receipt() : API to ireceipt working off of env values; given out to users
1.191 harris41 7608:
7609: =item *
7610:
1.243 albertel 7611: countacc($url) : count the number of accesses to a given URL
1.191 harris41 7612:
7613: =item *
7614:
1.243 albertel 7615: 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 7616:
7617: =item *
7618:
1.243 albertel 7619: 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 7620:
7621: =item *
7622:
1.243 albertel 7623: expirespread($uname,$udom,$stype,$usymb) : set expire date for spreadsheet
1.191 harris41 7624:
7625: =item *
7626:
1.243 albertel 7627: devalidate($symb) : devalidate temporary spreadsheet calculations,
7628: forcing spreadsheet to reevaluate the resource scores next time.
7629:
7630: =back
7631:
7632: =head2 Storing/Retreiving Data
7633:
7634: =over 4
1.191 harris41 7635:
7636: =item *
7637:
1.243 albertel 7638: store($storehash,$symb,$namespace,$udom,$uname) : stores hash permanently
7639: for this url; hashref needs to be given and should be a \%hashname; the
7640: remaining args aren't required and if they aren't passed or are '' they will
1.620 albertel 7641: be derived from the env
1.191 harris41 7642:
7643: =item *
7644:
1.243 albertel 7645: cstore($storehash,$symb,$namespace,$udom,$uname) : same as store but
7646: uses critical subroutine
1.191 harris41 7647:
7648: =item *
7649:
1.243 albertel 7650: restore($symb,$namespace,$udom,$uname) : returns hash for this symb;
7651: all args are optional
1.191 harris41 7652:
7653: =item *
7654:
1.717 albertel 7655: dumpstore($namespace,$udom,$uname,$regexp,$range) :
7656: dumps the complete (or key matching regexp) namespace into a hash
7657: ($udom, $uname, $regexp, $range are optional) for a namespace that is
7658: normally &store()ed into
7659:
7660: $range should be either an integer '100' (give me the first 100
7661: matching records)
7662: or be two integers sperated by a - with no spaces
7663: '30-50' (give me the 30th through the 50th matching
7664: records)
7665:
7666:
7667: =item *
7668:
7669: putstore($namespace,$symb,$version,$storehash,$udomain,$uname) :
7670: replaces a &store() version of data with a replacement set of data
7671: for a particular resource in a namespace passed in the $storehash hash
7672: reference
7673:
7674: =item *
7675:
1.243 albertel 7676: tmpstore($storehash,$symb,$namespace,$udom,$uname) : storage that
7677: works very similar to store/cstore, but all data is stored in a
7678: temporary location and can be reset using tmpreset, $storehash should
7679: be a hash reference, returns nothing on success
1.191 harris41 7680:
7681: =item *
7682:
1.243 albertel 7683: tmprestore($symb,$namespace,$udom,$uname) : storage that works very
7684: similar to restore, but all data is stored in a temporary location and
7685: can be reset using tmpreset. Returns a hash of values on success,
7686: error string otherwise.
1.191 harris41 7687:
7688: =item *
7689:
1.243 albertel 7690: tmpreset($symb,$namespace,$udom,$uname) : temporary storage reset,
7691: deltes all keys for $symb form the temporary storage hash.
1.191 harris41 7692:
7693: =item *
7694:
1.243 albertel 7695: get($namespace,$storearr,$udom,$uname) : returns hash with keys from array
7696: reference filled in from namesp ($udom and $uname are optional)
1.191 harris41 7697:
7698: =item *
7699:
1.243 albertel 7700: del($namespace,$storearr,$udom,$uname) : deletes keys out of array from
7701: namesp ($udom and $uname are optional)
1.191 harris41 7702:
7703: =item *
7704:
1.702 albertel 7705: dump($namespace,$udom,$uname,$regexp,$range) :
1.243 albertel 7706: dumps the complete (or key matching regexp) namespace into a hash
1.702 albertel 7707: ($udom, $uname, $regexp, $range are optional)
1.449 matthew 7708:
1.702 albertel 7709: $range should be either an integer '100' (give me the first 100
7710: matching records)
7711: or be two integers sperated by a - with no spaces
7712: '30-50' (give me the 30th through the 50th matching
7713: records)
1.449 matthew 7714: =item *
7715:
7716: inc($namespace,$store,$udom,$uname) : increments $store in $namespace.
7717: $store can be a scalar, an array reference, or if the amount to be
7718: incremented is > 1, a hash reference.
7719:
7720: ($udom and $uname are optional)
1.191 harris41 7721:
7722: =item *
7723:
1.243 albertel 7724: put($namespace,$storehash,$udom,$uname) : stores hash in namesp
7725: ($udom and $uname are optional)
1.191 harris41 7726:
7727: =item *
7728:
1.243 albertel 7729: cput($namespace,$storehash,$udom,$uname) : critical put
7730: ($udom and $uname are optional)
1.191 harris41 7731:
7732: =item *
7733:
1.748 albertel 7734: newput($namespace,$storehash,$udom,$uname) :
7735:
7736: Attempts to store the items in the $storehash, but only if they don't
7737: currently exist, if this succeeds you can be certain that you have
7738: successfully created a new key value pair in the $namespace db.
7739:
7740:
7741: Args:
7742: $namespace: name of database to store values to
7743: $storehash: hashref to store to the db
7744: $udom: (optional) domain of user containing the db
7745: $uname: (optional) name of user caontaining the db
7746:
7747: Returns:
7748: 'ok' -> succeeded in storing all keys of $storehash
7749: 'key_exists: <key>' -> failed to anything out of $storehash, as at
7750: least <key> already existed in the db (other
7751: requested keys may also already exist)
7752: 'error: <msg>' -> unable to tie the DB or other erorr occured
7753: 'con_lost' -> unable to contact request server
7754: 'refused' -> action was not allowed by remote machine
7755:
7756:
7757: =item *
7758:
1.243 albertel 7759: eget($namespace,$storearr,$udom,$uname) : returns hash with keys from array
7760: reference filled in from namesp (encrypts the return communication)
7761: ($udom and $uname are optional)
1.191 harris41 7762:
7763: =item *
7764:
1.243 albertel 7765: log($udom,$name,$home,$message) : write to permanent log for user; use
7766: critical subroutine
7767:
7768: =back
7769:
7770: =head2 Network Status Functions
7771:
7772: =over 4
1.191 harris41 7773:
7774: =item *
7775:
7776: dirlist($uri) : return directory list based on URI
7777:
7778: =item *
7779:
1.243 albertel 7780: spareserver() : find server with least workload from spare.tab
7781:
7782: =back
7783:
7784: =head2 Apache Request
7785:
7786: =over 4
1.191 harris41 7787:
7788: =item *
7789:
1.243 albertel 7790: ssi($url,%hash) : server side include, does a complete request cycle on url to
7791: localhost, posts hash
7792:
7793: =back
7794:
7795: =head2 Data to String to Data
7796:
7797: =over 4
1.191 harris41 7798:
7799: =item *
7800:
1.243 albertel 7801: hash2str(%hash) : convert a hash into a string complete with escaping and '='
7802: and '&' separators, supports elements that are arrayrefs and hashrefs
1.191 harris41 7803:
7804: =item *
7805:
1.243 albertel 7806: hashref2str($hashref) : convert a hashref into a string complete with
7807: escaping and '=' and '&' separators, supports elements that are
7808: arrayrefs and hashrefs
1.191 harris41 7809:
7810: =item *
7811:
1.243 albertel 7812: arrayref2str($arrayref) : convert an arrayref into a string complete
7813: with escaping and '&' separators, supports elements that are arrayrefs
7814: and hashrefs
1.191 harris41 7815:
7816: =item *
7817:
1.243 albertel 7818: str2hash($string) : convert string to hash using unescaping and
7819: splitting on '=' and '&', supports elements that are arrayrefs and
7820: hashrefs
1.191 harris41 7821:
7822: =item *
7823:
1.243 albertel 7824: str2array($string) : convert string to hash using unescaping and
7825: splitting on '&', supports elements that are arrayrefs and hashrefs
7826:
7827: =back
7828:
7829: =head2 Logging Routines
7830:
7831: =over 4
7832:
7833: These routines allow one to make log messages in the lonnet.log and
7834: lonnet.perm logfiles.
1.191 harris41 7835:
7836: =item *
7837:
1.243 albertel 7838: logtouch() : make sure the logfile, lonnet.log, exists
1.191 harris41 7839:
7840: =item *
7841:
1.243 albertel 7842: logthis() : append message to the normal lonnet.log file, it gets
7843: preiodically rolled over and deleted.
1.191 harris41 7844:
7845: =item *
7846:
1.243 albertel 7847: logperm() : append a permanent message to lonnet.perm.log, this log
7848: file never gets deleted by any automated portion of the system, only
7849: messages of critical importance should go in here.
7850:
7851: =back
7852:
7853: =head2 General File Helper Routines
7854:
7855: =over 4
1.191 harris41 7856:
7857: =item *
7858:
1.481 raeburn 7859: getfile($file,$caller) : two cases - requests for files in /res or in /uploaded.
7860: (a) files in /uploaded
7861: (i) If a local copy of the file exists -
7862: compares modification date of local copy with last-modified date for
7863: definitive version stored on home server for course. If local copy is
7864: stale, requests a new version from the home server and stores it.
7865: If the original has been removed from the home server, then local copy
7866: is unlinked.
7867: (ii) If local copy does not exist -
7868: requests the file from the home server and stores it.
7869:
7870: If $caller is 'uploadrep':
7871: This indicates a call from lonuploadrep.pm (PerlHeaderParserHandler phase)
7872: for request for files originally uploaded via DOCS.
7873: - returns 'ok' if fresh local copy now available, -1 otherwise.
7874:
7875: Otherwise:
7876: This indicates a call from the content generation phase of the request.
7877: - returns the entire contents of the file or -1.
7878:
7879: (b) files in /res
7880: - returns the entire contents of a file or -1;
7881: it properly subscribes to and replicates the file if neccessary.
1.191 harris41 7882:
1.712 albertel 7883:
7884: =item *
7885:
7886: stat_file($url) : $url is expected to be a /res/ or /uploaded/ style file
7887: reference
7888:
7889: returns either a stat() list of data about the file or an empty list
7890: if the file doesn't exist or couldn't find out about it (connection
7891: problems or user unknown)
7892:
1.191 harris41 7893: =item *
7894:
1.243 albertel 7895: filelocation($dir,$file) : returns file system location of a file
7896: based on URI; meant to be "fairly clean" absolute reference, $dir is a
7897: directory that relative $file lookups are to looked in ($dir of /a/dir
7898: and a file of ../bob will become /a/bob)
1.191 harris41 7899:
7900: =item *
7901:
7902: hreflocation($dir,$file) : returns file system location or a URL; same as
7903: filelocation except for hrefs
7904:
7905: =item *
7906:
7907: declutter() : declutters URLs (remove docroot, beginning slashes, 'res' etc)
7908:
1.243 albertel 7909: =back
7910:
1.608 albertel 7911: =head2 Usererfile file routines (/uploaded*)
7912:
7913: =over 4
7914:
7915: =item *
7916:
7917: userfileupload(): main rotine for putting a file in a user or course's
7918: filespace, arguments are,
7919:
1.620 albertel 7920: formname - required - this is the name of the element in $env where the
1.608 albertel 7921: filename, and the contents of the file to create/modifed exist
1.620 albertel 7922: the filename is in $env{'form.'.$formname.'.filename'} and the
7923: contents of the file is located in $env{'form.'.$formname}
1.608 albertel 7924: coursedoc - if true, store the file in the course of the active role
7925: of the current user
7926: subdir - required - subdirectory to put the file in under ../userfiles/
7927: if undefined, it will be placed in "unknown"
7928:
7929: (This routine calls clean_filename() to remove any dangerous
7930: characters from the filename, and then calls finuserfileupload() to
7931: complete the transaction)
7932:
7933: returns either the url of the uploaded file (/uploaded/....) if successful
7934: and /adm/notfound.html if unsuccessful
7935:
7936: =item *
7937:
7938: clean_filename(): routine for cleaing a filename up for storage in
7939: userfile space, argument is:
7940:
7941: filename - proposed filename
7942:
7943: returns: the new clean filename
7944:
7945: =item *
7946:
7947: finishuserfileupload(): routine that creaes and sends the file to
7948: userspace, probably shouldn't be called directly
7949:
7950: docuname: username or courseid of destination for the file
7951: docudom: domain of user/course of destination for the file
7952: formname: same as for userfileupload()
7953: fname: filename (inculding subdirectories) for the file
7954:
7955: returns either the url of the uploaded file (/uploaded/....) if successful
7956: and /adm/notfound.html if unsuccessful
7957:
7958: =item *
7959:
7960: renameuserfile(): renames an existing userfile to a new name
7961:
7962: Args:
7963: docuname: username or courseid of destination for the file
7964: docudom: domain of user/course of destination for the file
7965: old: current file name (including any subdirs under userfiles)
7966: new: desired file name (including any subdirs under userfiles)
7967:
7968: =item *
7969:
7970: mkdiruserfile(): creates a directory is a userfiles dir
7971:
7972: Args:
7973: docuname: username or courseid of destination for the file
7974: docudom: domain of user/course of destination for the file
7975: dir: dir to create (including any subdirs under userfiles)
7976:
7977: =item *
7978:
7979: removeuserfile(): removes a file that exists in userfiles
7980:
7981: Args:
7982: docuname: username or courseid of destination for the file
7983: docudom: domain of user/course of destination for the file
7984: fname: filname to delete (including any subdirs under userfiles)
7985:
7986: =item *
7987:
7988: removeuploadedurl(): convience function for removeuserfile()
7989:
7990: Args:
7991: url: a full /uploaded/... url to delete
7992:
1.747 albertel 7993: =item *
7994:
7995: get_portfile_permissions():
7996: Args:
7997: domain: domain of user or course contain the portfolio files
7998: user: name of user or num of course contain the portfolio files
7999: Returns:
8000: hashref of a dump of the proper file_permissions.db
8001:
8002:
8003: =item *
8004:
8005: get_access_controls():
8006:
8007: Args:
8008: current_permissions: the hash ref returned from get_portfile_permissions()
8009: group: (optional) the group you want the files associated with
8010: file: (optional) the file you want access info on
8011:
8012: Returns:
1.749 raeburn 8013: a hash (keys are file names) of hashes containing
8014: keys are: path to file/file_name\0uniqueID:scope_end_start (see below)
8015: values are XML containing access control settings (see below)
1.747 albertel 8016:
8017: Internal notes:
8018:
1.749 raeburn 8019: access controls are stored in file_permissions.db as key=value pairs.
8020: key -> path to file/file_name\0uniqueID:scope_end_start
8021: where scope -> public,guest,course,group,domains or users.
8022: end -> UNIX time for end of access (0 -> no end date)
8023: start -> UNIX time for start of access
8024:
8025: value -> XML description of access control
8026: <scope type=""> (type =1 of: public,guest,course,group,domains,users">
8027: <start></start>
8028: <end></end>
8029:
8030: <password></password> for scope type = guest
8031:
8032: <domain></domain> for scope type = course or group
8033: <number></number>
8034: <roles id="">
8035: <role></role>
8036: <access></access>
8037: <section></section>
8038: <group></group>
8039: </roles>
8040:
8041: <dom></dom> for scope type = domains
8042:
8043: <users> for scope type = users
8044: <user>
8045: <uname></uname>
8046: <udom></udom>
8047: </user>
8048: </users>
8049: </scope>
8050:
8051: Access data is also aggregated for each file in an additional key=value pair:
8052: key -> path to file/file_name\0accesscontrol
8053: value -> reference to hash
8054: hash contains key = value pairs
8055: where key = uniqueID:scope_end_start
8056: value = UNIX time record was last updated
8057:
8058: Used to improve speed of look-ups of access controls for each file.
8059:
8060: Locks on files (resulting from submission of portfolio file to a homework problem stored in array of arrays.
8061:
8062: parse_access_controls():
8063:
8064: Parses XML of an access control record
8065: Args
8066: 1. Text string (XML) of access comtrol record
8067:
8068: Returns:
8069: 1. Hash of access control settings.
8070:
8071: modify_access_controls():
8072:
8073: Modifies access controls for a portfolio file
8074: Args
8075: 1. file name
8076: 2. reference to hash of required changes,
8077: 3. domain
8078: 4. username
8079: where domain,username are the domain of the portfolio owner
8080: (either a user or a course)
8081:
8082: Returns:
8083: 1. result of additions or updates ('ok' or 'error', with error message).
8084: 2. result of deletions ('ok' or 'error', with error message).
8085: 3. reference to hash of any new or updated access controls.
8086: 4. reference to hash used to map incoming IDs to uniqueIDs assigned to control.
8087: key = integer (inbound ID)
8088: value = uniqueID
1.747 albertel 8089:
1.608 albertel 8090: =back
8091:
1.243 albertel 8092: =head2 HTTP Helper Routines
8093:
8094: =over 4
8095:
1.191 harris41 8096: =item *
8097:
8098: escape() : unpack non-word characters into CGI-compatible hex codes
8099:
8100: =item *
8101:
8102: unescape() : pack CGI-compatible hex codes into actual non-word ASCII character
8103:
1.243 albertel 8104: =back
8105:
8106: =head1 PRIVATE SUBROUTINES
8107:
8108: =head2 Underlying communication routines (Shouldn't call)
8109:
8110: =over 4
8111:
8112: =item *
8113:
8114: subreply() : tries to pass a message to lonc, returns con_lost if incapable
8115:
8116: =item *
8117:
8118: reply() : uses subreply to send a message to remote machine, logs all failures
8119:
8120: =item *
8121:
8122: critical() : passes a critical message to another server; if cannot
8123: get through then place message in connection buffer directory and
8124: returns con_delayed, if incapable of saving message, returns
8125: con_failed
8126:
8127: =item *
8128:
8129: reconlonc() : tries to reconnect lonc client processes.
8130:
8131: =back
8132:
8133: =head2 Resource Access Logging
8134:
8135: =over 4
8136:
8137: =item *
8138:
8139: flushcourselogs() : flush (save) buffer logs and access logs
8140:
8141: =item *
8142:
8143: courselog($what) : save message for course in hash
8144:
8145: =item *
8146:
8147: courseacclog($what) : save message for course using &courselog(). Perform
8148: special processing for specific resource types (problems, exams, quizzes, etc).
8149:
1.191 harris41 8150: =item *
8151:
8152: goodbye() : flush course logs and log shutting down; it is called in srm.conf
8153: as a PerlChildExitHandler
1.243 albertel 8154:
8155: =back
8156:
8157: =head2 Other
8158:
8159: =over 4
8160:
8161: =item *
8162:
8163: symblist($mapname,%newhash) : update symbolic storage links
1.191 harris41 8164:
8165: =back
8166:
8167: =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