Annotation of loncom/lonnet/perl/lonnet.pm, revision 1.765
1.1 albertel 1: # The LearningOnline Network
2: # TCP networking package
1.12 www 3: #
1.765 ! albertel 4: # $Id: lonnet.pm,v 1.764 2006/07/20 03:00:45 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.761 raeburn 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);
1888: if ($section) { $key.=' (Sec/Grp '.$section.')'; }
1889: if ($returnhash{$key}) {
1890: $returnhash{$key}.=','.$username.':'.$domain;
1891: } else {
1892: $returnhash{$key}=$username.':'.$domain;
1893: }
1.400 www 1894: }
1895: return %returnhash;
1896: }
1897:
1898: sub get_my_roles {
1899: my ($uname,$udom)=@_;
1.620 albertel 1900: unless (defined($uname)) { $uname=$env{'user.name'}; }
1901: unless (defined($udom)) { $udom=$env{'user.domain'}; }
1.400 www 1902: my %dumphash=
1903: &dump('nohist_userroles',$udom,$uname);
1904: my %returnhash=();
1905: my $now=time;
1906: foreach (keys %dumphash) {
1907: my ($tend,$tstart)=split(/\:/,$dumphash{$_});
1908: if (($tstart) && ($tstart<0)) { next; }
1909: if (($tend) && ($tend<$now)) { next; }
1910: if (($tstart) && ($now<$tstart)) { next; }
1911: my ($role,$username,$domain,$section)=split(/\:/,$_);
1912: $returnhash{$username.':'.$domain.':'.$role}=$tstart.':'.$tend;
1.373 www 1913: }
1914: return %returnhash;
1.399 www 1915: }
1916:
1917: # ----------------------------------------------------- Frontpage Announcements
1918: #
1919: #
1920:
1921: sub postannounce {
1922: my ($server,$text)=@_;
1923: unless (&allowed('psa',$hostdom{$server})) { return 'refused'; }
1924: unless ($text=~/\w/) { $text=''; }
1925: return &reply('setannounce:'.&escape($text),$server);
1926: }
1927:
1928: sub getannounce {
1.448 albertel 1929:
1930: if (open(my $fh,$perlvar{'lonDocRoot'}.'/announcement.txt')) {
1.399 www 1931: my $announcement='';
1932: while (<$fh>) { $announcement .=$_; }
1.448 albertel 1933: close($fh);
1.399 www 1934: if ($announcement=~/\w/) {
1935: return
1936: '<table bgcolor="#FF5555" cellpadding="5" cellspacing="3">'.
1.518 albertel 1937: '<tr><td bgcolor="#FFFFFF"><tt>'.$announcement.'</tt></td></tr></table>';
1.399 www 1938: } else {
1939: return '';
1940: }
1941: } else {
1942: return '';
1943: }
1.351 www 1944: }
1.353 www 1945:
1946: # ---------------------------------------------------------- Course ID routines
1947: # Deal with domain's nohist_courseid.db files
1948: #
1949:
1950: sub courseidput {
1951: my ($domain,$what,$coursehome)=@_;
1952: return &reply('courseidput:'.$domain.':'.$what,$coursehome);
1953: }
1954:
1955: sub courseiddump {
1.741 raeburn 1956: my ($domfilter,$descfilter,$sincefilter,$instcodefilter,$ownerfilter,$coursefilter,$hostidflag,$hostidref,$typefilter)=@_;
1.353 www 1957: my %returnhash=();
1.355 www 1958: unless ($domfilter) { $domfilter=''; }
1.353 www 1959: foreach my $tryserver (keys %libserv) {
1.511 raeburn 1960: if ( ($hostidflag == 1 && grep/^$tryserver$/,@{$hostidref}) || (!defined($hostidflag)) ) {
1.506 raeburn 1961: if ((!$domfilter) || ($hostdom{$tryserver} eq $domfilter)) {
1962: foreach (
1963: split(/\&/,&reply('courseiddump:'.$hostdom{$tryserver}.':'.
1.571 raeburn 1964: $sincefilter.':'.&escape($descfilter).':'.
1.741 raeburn 1965: &escape($instcodefilter).':'.&escape($ownerfilter).':'.&escape($coursefilter).':'.&escape($typefilter),
1.354 www 1966: $tryserver))) {
1.506 raeburn 1967: my ($key,$value)=split(/\=/,$_);
1968: if (($key) && ($value)) {
1.516 raeburn 1969: $returnhash{&unescape($key)}=$value;
1.506 raeburn 1970: }
1.353 www 1971: }
1972: }
1973: }
1974: }
1975: return %returnhash;
1976: }
1977:
1.658 raeburn 1978: # ---------------------------------------------------------- DC e-mail
1.662 raeburn 1979:
1980: sub dcmailput {
1.685 raeburn 1981: my ($domain,$msgid,$message,$server)=@_;
1.662 raeburn 1982: my $status = &Apache::lonnet::critical(
1.740 www 1983: 'dcmailput:'.$domain.':'.&escape($msgid).'='.
1984: &escape($message),$server);
1.662 raeburn 1985: return $status;
1986: }
1987:
1.658 raeburn 1988: sub dcmaildump {
1989: my ($dom,$startdate,$enddate,$senders) = @_;
1.685 raeburn 1990: my %returnhash=();
1991: if (exists($domain_primary{$dom})) {
1992: my $cmd='dcmaildump:'.$dom.':'.&escape($startdate).':'.
1993: &escape($enddate).':';
1994: my @esc_senders=map { &escape($_)} @$senders;
1995: $cmd.=&escape(join('&',@esc_senders));
1996: foreach (split(/\&/,&reply($cmd,$domain_primary{$dom}))) {
1997: my ($key,$value) = split(/\=/,$_);
1998: if (($key) && ($value)) {
1999: $returnhash{&unescape($key)} = &unescape($value);
1.658 raeburn 2000: }
2001: }
2002: }
2003: return %returnhash;
2004: }
1.662 raeburn 2005: # ---------------------------------------------------------- Domain roles
2006:
2007: sub get_domain_roles {
2008: my ($dom,$roles,$startdate,$enddate)=@_;
2009: if (undef($startdate) || $startdate eq '') {
2010: $startdate = '.';
2011: }
2012: if (undef($enddate) || $enddate eq '') {
2013: $enddate = '.';
2014: }
2015: my $rolelist = join(':',@{$roles});
2016: my %personnel = ();
2017: foreach my $tryserver (keys(%libserv)) {
2018: if ($hostdom{$tryserver} eq $dom) {
2019: %{$personnel{$tryserver}}=();
2020: foreach (
2021: split(/\&/,&reply('domrolesdump:'.$dom.':'.
2022: &escape($startdate).':'.&escape($enddate).':'.
2023: &escape($rolelist), $tryserver))) {
2024: my($key,$value) = split(/\=/,$_);
2025: if (($key) && ($value)) {
2026: $personnel{$tryserver}{&unescape($key)} = &unescape($value);
2027: }
2028: }
2029: }
2030: }
2031: return %personnel;
2032: }
1.658 raeburn 2033:
1.149 www 2034: # ----------------------------------------------------------- Check out an item
2035:
1.504 albertel 2036: sub get_first_access {
2037: my ($type,$argsymb)=@_;
2038: my ($symb,$courseid,$udom,$uname)=&Apache::lonxml::whichuser();
2039: if ($argsymb) { $symb=$argsymb; }
2040: my ($map,$id,$res)=&decode_symb($symb);
1.588 albertel 2041: if ($type eq 'map') {
2042: $res=&symbread($map);
2043: } else {
2044: $res=$symb;
2045: }
2046: my %times=&get('firstaccesstimes',["$courseid\0$res"],$udom,$uname);
2047: return $times{"$courseid\0$res"};
1.504 albertel 2048: }
2049:
2050: sub set_first_access {
2051: my ($type)=@_;
2052: my ($symb,$courseid,$udom,$uname)=&Apache::lonxml::whichuser();
2053: my ($map,$id,$res)=&decode_symb($symb);
1.588 albertel 2054: if ($type eq 'map') {
2055: $res=&symbread($map);
2056: } else {
2057: $res=$symb;
2058: }
2059: my $firstaccess=&get_first_access($type,$symb);
1.505 albertel 2060: if (!$firstaccess) {
1.588 albertel 2061: return &put('firstaccesstimes',{"$courseid\0$res"=>time},$udom,$uname);
1.505 albertel 2062: }
2063: return 'already_set';
1.504 albertel 2064: }
2065:
1.149 www 2066: sub checkout {
2067: my ($symb,$tuname,$tudom,$tcrsid)=@_;
2068: my $now=time;
2069: my $lonhost=$perlvar{'lonHostID'};
2070: my $infostr=&escape(
1.234 www 2071: 'CHECKOUTTOKEN&'.
1.149 www 2072: $tuname.'&'.
2073: $tudom.'&'.
2074: $tcrsid.'&'.
2075: $symb.'&'.
2076: $now.'&'.$ENV{'REMOTE_ADDR'});
2077: my $token=&reply('tmpput:'.$infostr,$lonhost);
1.151 www 2078: if ($token=~/^error\:/) {
1.672 albertel 2079: &logthis("<font color=\"blue\">WARNING: ".
1.151 www 2080: "Checkout tmpput failed ".$tudom.' - '.$tuname.' - '.$symb.
2081: "</font>");
2082: return '';
2083: }
2084:
1.149 www 2085: $token=~s/^(\d+)\_.*\_(\d+)$/$1\*$2\*$lonhost/;
2086: $token=~tr/a-z/A-Z/;
2087:
1.153 www 2088: my %infohash=('resource.0.outtoken' => $token,
2089: 'resource.0.checkouttime' => $now,
2090: 'resource.0.outremote' => $ENV{'REMOTE_ADDR'});
1.149 www 2091:
2092: unless (&cstore(\%infohash,$symb,$tcrsid,$tudom,$tuname) eq 'ok') {
2093: return '';
1.151 www 2094: } else {
1.672 albertel 2095: &logthis("<font color=\"blue\">WARNING: ".
1.151 www 2096: "Checkout cstore failed ".$tudom.' - '.$tuname.' - '.$symb.
2097: "</font>");
1.149 www 2098: }
2099:
2100: if (&log($tudom,$tuname,&homeserver($tuname,$tudom),
2101: &escape('Checkout '.$infostr.' - '.
2102: $token)) ne 'ok') {
2103: return '';
1.151 www 2104: } else {
1.672 albertel 2105: &logthis("<font color=\"blue\">WARNING: ".
1.151 www 2106: "Checkout log failed ".$tudom.' - '.$tuname.' - '.$symb.
2107: "</font>");
1.149 www 2108: }
1.151 www 2109: return $token;
1.149 www 2110: }
2111:
2112: # ------------------------------------------------------------ Check in an item
2113:
2114: sub checkin {
2115: my $token=shift;
1.150 www 2116: my $now=time;
2117: my ($ta,$tb,$lonhost)=split(/\*/,$token);
2118: $lonhost=~tr/A-Z/a-z/;
1.595 albertel 2119: my $dtoken=$ta.'_'.$hostname{$lonhost}.'_'.$tb;
1.150 www 2120: $dtoken=~s/\W/\_/g;
1.234 www 2121: my ($dummy,$tuname,$tudom,$tcrsid,$symb,$chtim,$rmaddr)=
1.150 www 2122: split(/\&/,&unescape(&reply('tmpget:'.$dtoken,$lonhost)));
2123:
1.154 www 2124: unless (($tuname) && ($tudom)) {
2125: &logthis('Check in '.$token.' ('.$dtoken.') failed');
2126: return '';
2127: }
2128:
2129: unless (&allowed('mgr',$tcrsid)) {
2130: &logthis('Check in '.$token.' ('.$dtoken.') unauthorized: '.
1.620 albertel 2131: $env{'user.name'}.' - '.$env{'user.domain'});
1.154 www 2132: return '';
2133: }
2134:
1.153 www 2135: my %infohash=('resource.0.intoken' => $token,
2136: 'resource.0.checkintime' => $now,
2137: 'resource.0.inremote' => $ENV{'REMOTE_ADDR'});
1.150 www 2138:
2139: unless (&cstore(\%infohash,$symb,$tcrsid,$tudom,$tuname) eq 'ok') {
2140: return '';
2141: }
2142:
2143: if (&log($tudom,$tuname,&homeserver($tuname,$tudom),
2144: &escape('Checkin - '.$token)) ne 'ok') {
2145: return '';
2146: }
2147:
2148: return ($symb,$tuname,$tudom,$tcrsid);
1.110 www 2149: }
2150:
2151: # --------------------------------------------- Set Expire Date for Spreadsheet
2152:
2153: sub expirespread {
2154: my ($uname,$udom,$stype,$usymb)=@_;
1.620 albertel 2155: my $cid=$env{'request.course.id'};
1.110 www 2156: if ($cid) {
2157: my $now=time;
2158: my $key=$uname.':'.$udom.':'.$stype.':'.$usymb;
1.620 albertel 2159: return &reply('put:'.$env{'course.'.$cid.'.domain'}.':'.
2160: $env{'course.'.$cid.'.num'}.
1.110 www 2161: ':nohist_expirationdates:'.
2162: &escape($key).'='.$now,
1.620 albertel 2163: $env{'course.'.$cid.'.home'})
1.110 www 2164: }
2165: return 'ok';
1.14 www 2166: }
2167:
1.109 www 2168: # ----------------------------------------------------- Devalidate Spreadsheets
2169:
2170: sub devalidate {
1.325 www 2171: my ($symb,$uname,$udom)=@_;
1.620 albertel 2172: my $cid=$env{'request.course.id'};
1.109 www 2173: if ($cid) {
1.391 matthew 2174: # delete the stored spreadsheets for
2175: # - the student level sheet of this user in course's homespace
2176: # - the assessment level sheet for this resource
2177: # for this user in user's homespace
1.553 albertel 2178: # - current conditional state info
1.325 www 2179: my $key=$uname.':'.$udom.':';
1.109 www 2180: my $status=
1.299 matthew 2181: &del('nohist_calculatedsheets',
1.391 matthew 2182: [$key.'studentcalc:'],
1.620 albertel 2183: $env{'course.'.$cid.'.domain'},
2184: $env{'course.'.$cid.'.num'})
1.133 albertel 2185: .' '.
2186: &del('nohist_calculatedsheets_'.$cid,
1.391 matthew 2187: [$key.'assesscalc:'.$symb],$udom,$uname);
1.109 www 2188: unless ($status eq 'ok ok') {
2189: &logthis('Could not devalidate spreadsheet '.
1.325 www 2190: $uname.' at '.$udom.' for '.
1.109 www 2191: $symb.': '.$status);
1.133 albertel 2192: }
1.553 albertel 2193: &delenv('user.state.'.$cid);
1.109 www 2194: }
2195: }
2196:
1.265 albertel 2197: sub get_scalar {
2198: my ($string,$end) = @_;
2199: my $value;
2200: if ($$string =~ s/^([^&]*?)($end)/$2/) {
2201: $value = $1;
2202: } elsif ($$string =~ s/^([^&]*?)&//) {
2203: $value = $1;
2204: }
2205: return &unescape($value);
2206: }
2207:
2208: sub array2str {
2209: my (@array) = @_;
2210: my $result=&arrayref2str(\@array);
2211: $result=~s/^__ARRAY_REF__//;
2212: $result=~s/__END_ARRAY_REF__$//;
2213: return $result;
2214: }
2215:
1.204 albertel 2216: sub arrayref2str {
2217: my ($arrayref) = @_;
1.265 albertel 2218: my $result='__ARRAY_REF__';
1.204 albertel 2219: foreach my $elem (@$arrayref) {
1.265 albertel 2220: if(ref($elem) eq 'ARRAY') {
2221: $result.=&arrayref2str($elem).'&';
2222: } elsif(ref($elem) eq 'HASH') {
2223: $result.=&hashref2str($elem).'&';
2224: } elsif(ref($elem)) {
2225: #print("Got a ref of ".(ref($elem))." skipping.");
1.204 albertel 2226: } else {
2227: $result.=&escape($elem).'&';
2228: }
2229: }
2230: $result=~s/\&$//;
1.265 albertel 2231: $result .= '__END_ARRAY_REF__';
1.204 albertel 2232: return $result;
2233: }
2234:
1.168 albertel 2235: sub hash2str {
1.204 albertel 2236: my (%hash) = @_;
2237: my $result=&hashref2str(\%hash);
1.265 albertel 2238: $result=~s/^__HASH_REF__//;
2239: $result=~s/__END_HASH_REF__$//;
1.204 albertel 2240: return $result;
2241: }
2242:
2243: sub hashref2str {
2244: my ($hashref)=@_;
1.265 albertel 2245: my $result='__HASH_REF__';
1.495 albertel 2246: foreach (sort(keys(%$hashref))) {
1.204 albertel 2247: if (ref($_) eq 'ARRAY') {
1.265 albertel 2248: $result.=&arrayref2str($_).'=';
1.204 albertel 2249: } elsif (ref($_) eq 'HASH') {
1.265 albertel 2250: $result.=&hashref2str($_).'=';
1.204 albertel 2251: } elsif (ref($_)) {
1.265 albertel 2252: $result.='=';
2253: #print("Got a ref of ".(ref($_))." skipping.");
1.204 albertel 2254: } else {
1.265 albertel 2255: if ($_) {$result.=&escape($_).'=';} else { last; }
1.204 albertel 2256: }
2257:
1.265 albertel 2258: if(ref($hashref->{$_}) eq 'ARRAY') {
2259: $result.=&arrayref2str($hashref->{$_}).'&';
2260: } elsif(ref($hashref->{$_}) eq 'HASH') {
2261: $result.=&hashref2str($hashref->{$_}).'&';
2262: } elsif(ref($hashref->{$_})) {
2263: $result.='&';
2264: #print("Got a ref of ".(ref($hashref->{$_}))." skipping.");
1.204 albertel 2265: } else {
1.265 albertel 2266: $result.=&escape($hashref->{$_}).'&';
1.204 albertel 2267: }
2268: }
1.168 albertel 2269: $result=~s/\&$//;
1.265 albertel 2270: $result .= '__END_HASH_REF__';
1.168 albertel 2271: return $result;
2272: }
2273:
2274: sub str2hash {
1.265 albertel 2275: my ($string)=@_;
2276: my ($hash)=&str2hashref('__HASH_REF__'.$string.'__END_HASH_REF__');
2277: return %$hash;
2278: }
2279:
2280: sub str2hashref {
1.168 albertel 2281: my ($string) = @_;
1.265 albertel 2282:
2283: my %hash;
2284:
2285: if($string !~ /^__HASH_REF__/) {
2286: if (! ($string eq '' || !defined($string))) {
2287: $hash{'error'}='Not hash reference';
2288: }
2289: return (\%hash, $string);
2290: }
2291:
2292: $string =~ s/^__HASH_REF__//;
2293:
2294: while($string !~ /^__END_HASH_REF__/) {
2295: #key
2296: my $key='';
2297: if($string =~ /^__HASH_REF__/) {
2298: ($key, $string)=&str2hashref($string);
2299: if(defined($key->{'error'})) {
2300: $hash{'error'}='Bad data';
2301: return (\%hash, $string);
2302: }
2303: } elsif($string =~ /^__ARRAY_REF__/) {
2304: ($key, $string)=&str2arrayref($string);
2305: if($key->[0] eq 'Array reference error') {
2306: $hash{'error'}='Bad data';
2307: return (\%hash, $string);
2308: }
2309: } else {
2310: $string =~ s/^(.*?)=//;
1.267 albertel 2311: $key=&unescape($1);
1.265 albertel 2312: }
2313: $string =~ s/^=//;
2314:
2315: #value
2316: my $value='';
2317: if($string =~ /^__HASH_REF__/) {
2318: ($value, $string)=&str2hashref($string);
2319: if(defined($value->{'error'})) {
2320: $hash{'error'}='Bad data';
2321: return (\%hash, $string);
2322: }
2323: } elsif($string =~ /^__ARRAY_REF__/) {
2324: ($value, $string)=&str2arrayref($string);
2325: if($value->[0] eq 'Array reference error') {
2326: $hash{'error'}='Bad data';
2327: return (\%hash, $string);
2328: }
2329: } else {
2330: $value=&get_scalar(\$string,'__END_HASH_REF__');
2331: }
2332: $string =~ s/^&//;
2333:
2334: $hash{$key}=$value;
1.204 albertel 2335: }
1.265 albertel 2336:
2337: $string =~ s/^__END_HASH_REF__//;
2338:
2339: return (\%hash, $string);
1.204 albertel 2340: }
2341:
2342: sub str2array {
1.265 albertel 2343: my ($string)=@_;
2344: my ($array)=&str2arrayref('__ARRAY_REF__'.$string.'__END_ARRAY_REF__');
2345: return @$array;
2346: }
2347:
2348: sub str2arrayref {
1.204 albertel 2349: my ($string) = @_;
1.265 albertel 2350: my @array;
2351:
2352: if($string !~ /^__ARRAY_REF__/) {
2353: if (! ($string eq '' || !defined($string))) {
2354: $array[0]='Array reference error';
2355: }
2356: return (\@array, $string);
2357: }
2358:
2359: $string =~ s/^__ARRAY_REF__//;
2360:
2361: while($string !~ /^__END_ARRAY_REF__/) {
2362: my $value='';
2363: if($string =~ /^__HASH_REF__/) {
2364: ($value, $string)=&str2hashref($string);
2365: if(defined($value->{'error'})) {
2366: $array[0] ='Array reference error';
2367: return (\@array, $string);
2368: }
2369: } elsif($string =~ /^__ARRAY_REF__/) {
2370: ($value, $string)=&str2arrayref($string);
2371: if($value->[0] eq 'Array reference error') {
2372: $array[0] ='Array reference error';
2373: return (\@array, $string);
2374: }
2375: } else {
2376: $value=&get_scalar(\$string,'__END_ARRAY_REF__');
2377: }
2378: $string =~ s/^&//;
2379:
2380: push(@array, $value);
1.191 harris41 2381: }
1.265 albertel 2382:
2383: $string =~ s/^__END_ARRAY_REF__//;
2384:
2385: return (\@array, $string);
1.168 albertel 2386: }
2387:
1.167 albertel 2388: # -------------------------------------------------------------------Temp Store
2389:
1.168 albertel 2390: sub tmpreset {
2391: my ($symb,$namespace,$domain,$stuname) = @_;
2392: if (!$symb) {
2393: $symb=&symbread();
1.620 albertel 2394: if (!$symb) { $symb= $env{'request.url'}; }
1.168 albertel 2395: }
2396: $symb=escape($symb);
2397:
1.620 albertel 2398: if (!$namespace) { $namespace=$env{'request.state'}; }
1.168 albertel 2399: $namespace=~s/\//\_/g;
2400: $namespace=~s/\W//g;
2401:
1.620 albertel 2402: if (!$domain) { $domain=$env{'user.domain'}; }
2403: if (!$stuname) { $stuname=$env{'user.name'}; }
1.591 albertel 2404: if ($domain eq 'public' && $stuname eq 'public') {
2405: $stuname=$ENV{'REMOTE_ADDR'};
2406: }
1.168 albertel 2407: my $path=$perlvar{'lonDaemons'}.'/tmp';
2408: my %hash;
2409: if (tie(%hash,'GDBM_File',
2410: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
1.256 albertel 2411: &GDBM_WRCREAT(),0640)) {
1.168 albertel 2412: foreach my $key (keys %hash) {
1.180 albertel 2413: if ($key=~ /:$symb/) {
1.168 albertel 2414: delete($hash{$key});
2415: }
2416: }
2417: }
2418: }
2419:
1.167 albertel 2420: sub tmpstore {
1.168 albertel 2421: my ($storehash,$symb,$namespace,$domain,$stuname) = @_;
2422:
2423: if (!$symb) {
2424: $symb=&symbread();
1.620 albertel 2425: if (!$symb) { $symb= $env{'request.url'}; }
1.168 albertel 2426: }
2427: $symb=escape($symb);
2428:
2429: if (!$namespace) {
2430: # I don't think we would ever want to store this for a course.
2431: # it seems this will only be used if we don't have a course.
1.620 albertel 2432: #$namespace=$env{'request.course.id'};
1.168 albertel 2433: #if (!$namespace) {
1.620 albertel 2434: $namespace=$env{'request.state'};
1.168 albertel 2435: #}
2436: }
2437: $namespace=~s/\//\_/g;
2438: $namespace=~s/\W//g;
1.620 albertel 2439: if (!$domain) { $domain=$env{'user.domain'}; }
2440: if (!$stuname) { $stuname=$env{'user.name'}; }
1.591 albertel 2441: if ($domain eq 'public' && $stuname eq 'public') {
2442: $stuname=$ENV{'REMOTE_ADDR'};
2443: }
1.168 albertel 2444: my $now=time;
2445: my %hash;
2446: my $path=$perlvar{'lonDaemons'}.'/tmp';
2447: if (tie(%hash,'GDBM_File',
2448: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
1.256 albertel 2449: &GDBM_WRCREAT(),0640)) {
1.168 albertel 2450: $hash{"version:$symb"}++;
2451: my $version=$hash{"version:$symb"};
2452: my $allkeys='';
2453: foreach my $key (keys(%$storehash)) {
2454: $allkeys.=$key.':';
1.591 albertel 2455: $hash{"$version:$symb:$key"}=&freeze_escape($$storehash{$key});
1.168 albertel 2456: }
2457: $hash{"$version:$symb:timestamp"}=$now;
2458: $allkeys.='timestamp';
2459: $hash{"$version:keys:$symb"}=$allkeys;
2460: if (untie(%hash)) {
2461: return 'ok';
2462: } else {
2463: return "error:$!";
2464: }
2465: } else {
2466: return "error:$!";
2467: }
2468: }
1.167 albertel 2469:
1.168 albertel 2470: # -----------------------------------------------------------------Temp Restore
1.167 albertel 2471:
1.168 albertel 2472: sub tmprestore {
2473: my ($symb,$namespace,$domain,$stuname) = @_;
1.167 albertel 2474:
1.168 albertel 2475: if (!$symb) {
2476: $symb=&symbread();
1.620 albertel 2477: if (!$symb) { $symb= $env{'request.url'}; }
1.168 albertel 2478: }
2479: $symb=escape($symb);
2480:
1.620 albertel 2481: if (!$namespace) { $namespace=$env{'request.state'}; }
1.591 albertel 2482:
1.620 albertel 2483: if (!$domain) { $domain=$env{'user.domain'}; }
2484: if (!$stuname) { $stuname=$env{'user.name'}; }
1.591 albertel 2485: if ($domain eq 'public' && $stuname eq 'public') {
2486: $stuname=$ENV{'REMOTE_ADDR'};
2487: }
1.168 albertel 2488: my %returnhash;
2489: $namespace=~s/\//\_/g;
2490: $namespace=~s/\W//g;
2491: my %hash;
2492: my $path=$perlvar{'lonDaemons'}.'/tmp';
2493: if (tie(%hash,'GDBM_File',
2494: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
1.256 albertel 2495: &GDBM_READER(),0640)) {
1.168 albertel 2496: my $version=$hash{"version:$symb"};
2497: $returnhash{'version'}=$version;
2498: my $scope;
2499: for ($scope=1;$scope<=$version;$scope++) {
2500: my $vkeys=$hash{"$scope:keys:$symb"};
2501: my @keys=split(/:/,$vkeys);
2502: my $key;
2503: $returnhash{"$scope:keys"}=$vkeys;
2504: foreach $key (@keys) {
1.591 albertel 2505: $returnhash{"$scope:$key"}=&thaw_unescape($hash{"$scope:$symb:$key"});
2506: $returnhash{"$key"}=&thaw_unescape($hash{"$scope:$symb:$key"});
1.167 albertel 2507: }
2508: }
1.168 albertel 2509: if (!(untie(%hash))) {
2510: return "error:$!";
2511: }
2512: } else {
2513: return "error:$!";
2514: }
2515: return %returnhash;
1.167 albertel 2516: }
2517:
1.9 www 2518: # ----------------------------------------------------------------------- Store
2519:
2520: sub store {
1.124 www 2521: my ($storehash,$symb,$namespace,$domain,$stuname) = @_;
2522: my $home='';
2523:
1.168 albertel 2524: if ($stuname) { $home=&homeserver($stuname,$domain); }
1.124 www 2525:
1.213 www 2526: $symb=&symbclean($symb);
1.122 albertel 2527: if (!$symb) { unless ($symb=&symbread()) { return ''; } }
1.109 www 2528:
1.620 albertel 2529: if (!$domain) { $domain=$env{'user.domain'}; }
2530: if (!$stuname) { $stuname=$env{'user.name'}; }
1.325 www 2531:
2532: &devalidate($symb,$stuname,$domain);
1.109 www 2533:
2534: $symb=escape($symb);
1.187 www 2535: if (!$namespace) {
1.620 albertel 2536: unless ($namespace=$env{'request.course.id'}) {
1.187 www 2537: return '';
2538: }
2539: }
1.620 albertel 2540: if (!$home) { $home=$env{'user.home'}; }
1.447 www 2541:
2542: $$storehash{'ip'}=$ENV{'REMOTE_ADDR'};
2543: $$storehash{'host'}=$perlvar{'lonHostID'};
2544:
1.12 www 2545: my $namevalue='';
1.191 harris41 2546: foreach (keys %$storehash) {
1.591 albertel 2547: $namevalue.=&escape($_).'='.&freeze_escape($$storehash{$_}).'&';
1.191 harris41 2548: }
1.12 www 2549: $namevalue=~s/\&$//;
1.187 www 2550: &courselog($symb.':'.$stuname.':'.$domain.':STORE:'.$namevalue);
1.124 www 2551: return reply("store:$domain:$stuname:$namespace:$symb:$namevalue","$home");
1.9 www 2552: }
2553:
1.47 www 2554: # -------------------------------------------------------------- Critical Store
2555:
2556: sub cstore {
1.124 www 2557: my ($storehash,$symb,$namespace,$domain,$stuname) = @_;
2558: my $home='';
2559:
1.168 albertel 2560: if ($stuname) { $home=&homeserver($stuname,$domain); }
1.124 www 2561:
1.213 www 2562: $symb=&symbclean($symb);
1.122 albertel 2563: if (!$symb) { unless ($symb=&symbread()) { return ''; } }
1.109 www 2564:
1.620 albertel 2565: if (!$domain) { $domain=$env{'user.domain'}; }
2566: if (!$stuname) { $stuname=$env{'user.name'}; }
1.325 www 2567:
2568: &devalidate($symb,$stuname,$domain);
1.109 www 2569:
2570: $symb=escape($symb);
1.187 www 2571: if (!$namespace) {
1.620 albertel 2572: unless ($namespace=$env{'request.course.id'}) {
1.187 www 2573: return '';
2574: }
2575: }
1.620 albertel 2576: if (!$home) { $home=$env{'user.home'}; }
1.447 www 2577:
2578: $$storehash{'ip'}=$ENV{'REMOTE_ADDR'};
2579: $$storehash{'host'}=$perlvar{'lonHostID'};
1.122 albertel 2580:
1.47 www 2581: my $namevalue='';
1.191 harris41 2582: foreach (keys %$storehash) {
1.591 albertel 2583: $namevalue.=&escape($_).'='.&freeze_escape($$storehash{$_}).'&';
1.191 harris41 2584: }
1.47 www 2585: $namevalue=~s/\&$//;
1.187 www 2586: &courselog($symb.':'.$stuname.':'.$domain.':CSTORE:'.$namevalue);
1.188 www 2587: return critical
2588: ("store:$domain:$stuname:$namespace:$symb:$namevalue","$home");
1.47 www 2589: }
2590:
1.9 www 2591: # --------------------------------------------------------------------- Restore
2592:
2593: sub restore {
1.124 www 2594: my ($symb,$namespace,$domain,$stuname) = @_;
2595: my $home='';
2596:
1.168 albertel 2597: if ($stuname) { $home=&homeserver($stuname,$domain); }
1.124 www 2598:
1.122 albertel 2599: if (!$symb) {
2600: unless ($symb=escape(&symbread())) { return ''; }
2601: } else {
1.213 www 2602: $symb=&escape(&symbclean($symb));
1.122 albertel 2603: }
1.188 www 2604: if (!$namespace) {
1.620 albertel 2605: unless ($namespace=$env{'request.course.id'}) {
1.188 www 2606: return '';
2607: }
2608: }
1.620 albertel 2609: if (!$domain) { $domain=$env{'user.domain'}; }
2610: if (!$stuname) { $stuname=$env{'user.name'}; }
2611: if (!$home) { $home=$env{'user.home'}; }
1.122 albertel 2612: my $answer=&reply("restore:$domain:$stuname:$namespace:$symb","$home");
2613:
1.12 www 2614: my %returnhash=();
1.191 harris41 2615: foreach (split(/\&/,$answer)) {
1.12 www 2616: my ($name,$value)=split(/\=/,$_);
1.591 albertel 2617: $returnhash{&unescape($name)}=&thaw_unescape($value);
1.191 harris41 2618: }
1.75 www 2619: my $version;
2620: for ($version=1;$version<=$returnhash{'version'};$version++) {
1.191 harris41 2621: foreach (split(/\:/,$returnhash{$version.':keys'})) {
1.75 www 2622: $returnhash{$_}=$returnhash{$version.':'.$_};
1.191 harris41 2623: }
1.75 www 2624: }
1.13 www 2625: return %returnhash;
1.34 www 2626: }
2627:
2628: # ---------------------------------------------------------- Course Description
2629:
2630: sub coursedescription {
1.731 albertel 2631: my ($courseid,$args)=@_;
1.34 www 2632: $courseid=~s/^\///;
1.49 www 2633: $courseid=~s/\_/\//g;
1.34 www 2634: my ($cdomain,$cnum)=split(/\//,$courseid);
1.129 albertel 2635: my $chome=&homeserver($cnum,$cdomain);
1.302 albertel 2636: my $normalid=$cdomain.'_'.$cnum;
2637: # need to always cache even if we get errors otherwise we keep
2638: # trying and trying and trying to get the course description.
2639: my %envhash=();
2640: my %returnhash=();
1.731 albertel 2641:
2642: my $expiretime=600;
2643: if ($env{'request.course.id'} eq $normalid) {
2644: $expiretime=120;
2645: }
2646:
2647: my $prefix='course.'.$cdomain.'_'.$cnum.'.';
2648: if (!$args->{'freshen_cache'}
2649: && ((time-$env{$prefix.'last_cache'}) < $expiretime) ) {
2650: foreach my $key (keys(%env)) {
2651: next if ($key !~ /^\Q$prefix\E(.*)/);
2652: my ($setting) = $1;
2653: $returnhash{$setting} = $env{$key};
2654: }
2655: return %returnhash;
2656: }
2657:
2658: # get the data agin
2659: if (!$args->{'one_time'}) {
2660: $envhash{'course.'.$normalid.'.last_cache'}=time;
2661: }
1.34 www 2662: if ($chome ne 'no_host') {
1.302 albertel 2663: %returnhash=&dump('environment',$cdomain,$cnum);
1.129 albertel 2664: if (!exists($returnhash{'con_lost'})) {
2665: $returnhash{'home'}= $chome;
2666: $returnhash{'domain'} = $cdomain;
2667: $returnhash{'num'} = $cnum;
1.741 raeburn 2668: if (!defined($returnhash{'type'})) {
2669: $returnhash{'type'} = 'Course';
2670: }
1.130 albertel 2671: while (my ($name,$value) = each %returnhash) {
1.53 www 2672: $envhash{'course.'.$normalid.'.'.$name}=$value;
1.129 albertel 2673: }
1.270 www 2674: $returnhash{'url'}=&clutter($returnhash{'url'});
1.34 www 2675: $returnhash{'fn'}=$perlvar{'lonDaemons'}.'/tmp/'.
1.620 albertel 2676: $env{'user.name'}.'_'.$cdomain.'_'.$cnum;
1.60 www 2677: $envhash{'course.'.$normalid.'.home'}=$chome;
2678: $envhash{'course.'.$normalid.'.domain'}=$cdomain;
2679: $envhash{'course.'.$normalid.'.num'}=$cnum;
1.34 www 2680: }
2681: }
1.731 albertel 2682: if (!$args->{'one_time'}) {
2683: &appenv(%envhash);
2684: }
1.302 albertel 2685: return %returnhash;
1.461 www 2686: }
2687:
2688: # -------------------------------------------------See if a user is privileged
2689:
2690: sub privileged {
2691: my ($username,$domain)=@_;
2692: my $rolesdump=&reply("dump:$domain:$username:roles",
2693: &homeserver($username,$domain));
2694: if (($rolesdump eq 'con_lost') || ($rolesdump eq '')) { return 0; }
2695: my $now=time;
2696: if ($rolesdump ne '') {
2697: foreach (split(/&/,$rolesdump)) {
1.586 albertel 2698: if ($_!~/^rolesdef_/) {
1.461 www 2699: my ($area,$role)=split(/=/,$_);
2700: $area=~s/\_\w\w$//;
2701: my ($trole,$tend,$tstart)=split(/_/,$role);
2702: if (($trole eq 'dc') || ($trole eq 'su')) {
2703: my $active=1;
2704: if ($tend) {
2705: if ($tend<$now) { $active=0; }
2706: }
2707: if ($tstart) {
2708: if ($tstart>$now) { $active=0; }
2709: }
2710: if ($active) { return 1; }
2711: }
2712: }
2713: }
2714: }
2715: return 0;
1.9 www 2716: }
1.1 albertel 2717:
1.103 harris41 2718: # -------------------------------------------------------- Get user privileges
1.11 www 2719:
2720: sub rolesinit {
2721: my ($domain,$username,$authhost)=@_;
2722: my $rolesdump=reply("dump:$domain:$username:roles",$authhost);
1.12 www 2723: if (($rolesdump eq 'con_lost') || ($rolesdump eq '')) { return ''; }
1.11 www 2724: my %allroles=();
1.678 raeburn 2725: my %allgroups=();
1.11 www 2726: my $now=time;
1.743 albertel 2727: my %userroles = ('user.login.time' => $now);
1.678 raeburn 2728: my $group_privs;
1.11 www 2729:
2730: if ($rolesdump ne '') {
1.191 harris41 2731: foreach (split(/&/,$rolesdump)) {
1.586 albertel 2732: if ($_!~/^rolesdef_/) {
1.11 www 2733: my ($area,$role)=split(/=/,$_);
1.587 albertel 2734: $area=~s/\_\w\w$//;
1.678 raeburn 2735: my ($trole,$tend,$tstart,$group_privs);
1.587 albertel 2736: if ($role=~/^cr/) {
1.655 albertel 2737: if ($role=~m|^(cr/\w+/\w+/[a-zA-Z0-9]+)_(.*)$|) {
2738: ($trole,my $trest)=($role=~m|^(cr/\w+/\w+/[a-zA-Z0-9]+)_(.*)$|);
2739: ($tend,$tstart)=split('_',$trest);
2740: } else {
2741: $trole=$role;
2742: }
1.678 raeburn 2743: } elsif ($role =~ m|^gr/|) {
2744: ($trole,$tend,$tstart) = split(/_/,$role);
2745: ($trole,$group_privs) = split(/\//,$trole);
2746: $group_privs = &unescape($group_privs);
1.587 albertel 2747: } else {
2748: ($trole,$tend,$tstart)=split(/_/,$role);
2749: }
1.743 albertel 2750: my %new_role = &set_arearole($trole,$area,$tstart,$tend,$domain,
2751: $username);
2752: @userroles{keys(%new_role)} = @new_role{keys(%new_role)};
1.567 raeburn 2753: if (($tend!=0) && ($tend<$now)) { $trole=''; }
2754: if (($tstart!=0) && ($tstart>$now)) { $trole=''; }
1.11 www 2755: if (($area ne '') && ($trole ne '')) {
1.347 albertel 2756: my $spec=$trole.'.'.$area;
2757: my ($tdummy,$tdomain,$trest)=split(/\//,$area);
2758: if ($trole =~ /^cr\//) {
1.567 raeburn 2759: &custom_roleprivs(\%allroles,$trole,$tdomain,$trest,$spec,$area);
1.678 raeburn 2760: } elsif ($trole eq 'gr') {
2761: &group_roleprivs(\%allgroups,$area,$group_privs,$tend,$tstart);
1.347 albertel 2762: } else {
1.567 raeburn 2763: &standard_roleprivs(\%allroles,$trole,$tdomain,$spec,$trest,$area);
1.347 albertel 2764: }
1.12 www 2765: }
1.662 raeburn 2766: }
1.191 harris41 2767: }
1.743 albertel 2768: my ($author,$adv) = &set_userprivs(\%userroles,\%allroles,\%allgroups);
2769: $userroles{'user.adv'} = $adv;
2770: $userroles{'user.author'} = $author;
1.620 albertel 2771: $env{'user.adv'}=$adv;
1.11 www 2772: }
1.743 albertel 2773: return \%userroles;
1.11 www 2774: }
2775:
1.567 raeburn 2776: sub set_arearole {
2777: my ($trole,$area,$tstart,$tend,$domain,$username) = @_;
2778: # log the associated role with the area
2779: &userrolelog($trole,$username,$domain,$area,$tstart,$tend);
1.743 albertel 2780: return ('user.role.'.$trole.'.'.$area => $tstart.'.'.$tend);
1.567 raeburn 2781: }
2782:
2783: sub custom_roleprivs {
2784: my ($allroles,$trole,$tdomain,$trest,$spec,$area) = @_;
2785: my ($rdummy,$rdomain,$rauthor,$rrole)=split(/\//,$trole);
2786: my $homsvr=homeserver($rauthor,$rdomain);
2787: if ($hostname{$homsvr} ne '') {
2788: my ($rdummy,$roledef)=
2789: &get('roles',["rolesdef_$rrole"],$rdomain,$rauthor);
2790: if (($rdummy ne 'con_lost') && ($roledef ne '')) {
2791: my ($syspriv,$dompriv,$coursepriv)=split(/\_/,$roledef);
2792: if (defined($syspriv)) {
2793: $$allroles{'cm./'}.=':'.$syspriv;
2794: $$allroles{$spec.'./'}.=':'.$syspriv;
2795: }
2796: if ($tdomain ne '') {
2797: if (defined($dompriv)) {
2798: $$allroles{'cm./'.$tdomain.'/'}.=':'.$dompriv;
2799: $$allroles{$spec.'./'.$tdomain.'/'}.=':'.$dompriv;
2800: }
2801: if (($trest ne '') && (defined($coursepriv))) {
2802: $$allroles{'cm.'.$area}.=':'.$coursepriv;
2803: $$allroles{$spec.'.'.$area}.=':'.$coursepriv;
2804: }
2805: }
2806: }
2807: }
2808: }
2809:
1.678 raeburn 2810: sub group_roleprivs {
2811: my ($allgroups,$area,$group_privs,$tend,$tstart) = @_;
2812: my $access = 1;
2813: my $now = time;
2814: if (($tend!=0) && ($tend<$now)) { $access = 0; }
2815: if (($tstart!=0) && ($tstart>$now)) { $access=0; }
2816: if ($access) {
2817: my ($course,$group) = ($area =~ m|(/\w+/\w+)/([^/]+)$|);
2818: $$allgroups{$course}{$group} .=':'.$group_privs;
2819: }
2820: }
1.567 raeburn 2821:
2822: sub standard_roleprivs {
2823: my ($allroles,$trole,$tdomain,$spec,$trest,$area) = @_;
2824: if (defined($pr{$trole.':s'})) {
2825: $$allroles{'cm./'}.=':'.$pr{$trole.':s'};
2826: $$allroles{$spec.'./'}.=':'.$pr{$trole.':s'};
2827: }
2828: if ($tdomain ne '') {
2829: if (defined($pr{$trole.':d'})) {
2830: $$allroles{'cm./'.$tdomain.'/'}.=':'.$pr{$trole.':d'};
2831: $$allroles{$spec.'./'.$tdomain.'/'}.=':'.$pr{$trole.':d'};
2832: }
2833: if (($trest ne '') && (defined($pr{$trole.':c'}))) {
2834: $$allroles{'cm.'.$area}.=':'.$pr{$trole.':c'};
2835: $$allroles{$spec.'.'.$area}.=':'.$pr{$trole.':c'};
2836: }
2837: }
2838: }
2839:
2840: sub set_userprivs {
1.678 raeburn 2841: my ($userroles,$allroles,$allgroups) = @_;
1.567 raeburn 2842: my $author=0;
2843: my $adv=0;
1.678 raeburn 2844: my %grouproles = ();
2845: if (keys(%{$allgroups}) > 0) {
2846: foreach my $role (keys %{$allroles}) {
1.681 raeburn 2847: my ($trole,$area,$sec,$extendedarea);
2848: if ($role =~ m|^(\w+)\.(/\w+/\w+)(/?\w*)|) {
1.678 raeburn 2849: $trole = $1;
2850: $area = $2;
1.681 raeburn 2851: $sec = $3;
2852: $extendedarea = $area.$sec;
2853: if (exists($$allgroups{$area})) {
2854: foreach my $group (keys(%{$$allgroups{$area}})) {
2855: my $spec = $trole.'.'.$extendedarea;
2856: $grouproles{$spec.'.'.$area.'/'.$group} =
2857: $$allgroups{$area}{$group};
1.678 raeburn 2858: }
2859: }
2860: }
2861: }
2862: }
2863: foreach (keys(%grouproles)) {
2864: $$allroles{$_} = $grouproles{$_};
2865: }
1.567 raeburn 2866: foreach (keys %{$allroles}) {
2867: my %thesepriv=();
2868: if (($_=~/^au/) || ($_=~/^ca/)) { $author=1; }
2869: foreach (split(/:/,$$allroles{$_})) {
2870: if ($_ ne '') {
2871: my ($privilege,$restrictions)=split(/&/,$_);
2872: if ($restrictions eq '') {
2873: $thesepriv{$privilege}='F';
2874: } elsif ($thesepriv{$privilege} ne 'F') {
2875: $thesepriv{$privilege}.=$restrictions;
2876: }
2877: if ($thesepriv{'adv'} eq 'F') { $adv=1; }
2878: }
2879: }
2880: my $thesestr='';
2881: foreach (keys %thesepriv) { $thesestr.=':'.$_.'&'.$thesepriv{$_}; }
1.743 albertel 2882: $userroles->{'user.priv.'.$_} = $thesestr;
1.567 raeburn 2883: }
2884: return ($author,$adv);
2885: }
2886:
1.12 www 2887: # --------------------------------------------------------------- get interface
2888:
2889: sub get {
1.131 albertel 2890: my ($namespace,$storearr,$udomain,$uname)=@_;
1.12 www 2891: my $items='';
1.191 harris41 2892: foreach (@$storearr) {
1.12 www 2893: $items.=escape($_).'&';
1.191 harris41 2894: }
1.12 www 2895: $items=~s/\&$//;
1.620 albertel 2896: if (!$udomain) { $udomain=$env{'user.domain'}; }
2897: if (!$uname) { $uname=$env{'user.name'}; }
1.131 albertel 2898: my $uhome=&homeserver($uname,$udomain);
2899:
1.133 albertel 2900: my $rep=&reply("get:$udomain:$uname:$namespace:$items",$uhome);
1.15 www 2901: my @pairs=split(/\&/,$rep);
1.273 albertel 2902: if ( $#pairs==0 && $pairs[0] =~ /^(con_lost|error|no_such_host)/i) {
2903: return @pairs;
2904: }
1.15 www 2905: my %returnhash=();
1.42 www 2906: my $i=0;
1.191 harris41 2907: foreach (@$storearr) {
1.557 albertel 2908: $returnhash{$_}=&thaw_unescape($pairs[$i]);
1.42 www 2909: $i++;
1.191 harris41 2910: }
1.15 www 2911: return %returnhash;
1.27 www 2912: }
2913:
2914: # --------------------------------------------------------------- del interface
2915:
2916: sub del {
1.133 albertel 2917: my ($namespace,$storearr,$udomain,$uname)=@_;
1.27 www 2918: my $items='';
1.191 harris41 2919: foreach (@$storearr) {
1.27 www 2920: $items.=escape($_).'&';
1.191 harris41 2921: }
1.27 www 2922: $items=~s/\&$//;
1.620 albertel 2923: if (!$udomain) { $udomain=$env{'user.domain'}; }
2924: if (!$uname) { $uname=$env{'user.name'}; }
1.133 albertel 2925: my $uhome=&homeserver($uname,$udomain);
2926:
2927: return &reply("del:$udomain:$uname:$namespace:$items",$uhome);
1.15 www 2928: }
2929:
2930: # -------------------------------------------------------------- dump interface
2931:
2932: sub dump {
1.755 albertel 2933: my ($namespace,$udomain,$uname,$regexp,$range)=@_;
2934: if (!$udomain) { $udomain=$env{'user.domain'}; }
2935: if (!$uname) { $uname=$env{'user.name'}; }
2936: my $uhome=&homeserver($uname,$udomain);
2937: if ($regexp) {
2938: $regexp=&escape($regexp);
2939: } else {
2940: $regexp='.';
2941: }
2942: my $rep=&reply("dump:$udomain:$uname:$namespace:$regexp:$range",$uhome);
2943: my @pairs=split(/\&/,$rep);
2944: my %returnhash=();
2945: foreach my $item (@pairs) {
2946: my ($key,$value)=split(/=/,$item,2);
2947: $key = &unescape($key);
2948: next if ($key =~ /^error: 2 /);
2949: $returnhash{$key}=&thaw_unescape($value);
2950: }
2951: return %returnhash;
1.407 www 2952: }
2953:
1.717 albertel 2954: # --------------------------------------------------------- dumpstore interface
2955:
2956: sub dumpstore {
2957: my ($namespace,$udomain,$uname,$regexp,$range)=@_;
2958: return &dump($namespace,$udomain,$uname,$regexp,$range);
2959: }
2960:
1.407 www 2961: # -------------------------------------------------------------- keys interface
2962:
2963: sub getkeys {
2964: my ($namespace,$udomain,$uname)=@_;
1.620 albertel 2965: if (!$udomain) { $udomain=$env{'user.domain'}; }
2966: if (!$uname) { $uname=$env{'user.name'}; }
1.407 www 2967: my $uhome=&homeserver($uname,$udomain);
2968: my $rep=reply("keys:$udomain:$uname:$namespace",$uhome);
2969: my @keyarray=();
2970: foreach (split(/\&/,$rep)) {
2971: push (@keyarray,&unescape($_));
2972: }
2973: return @keyarray;
1.318 matthew 2974: }
2975:
1.319 matthew 2976: # --------------------------------------------------------------- currentdump
2977: sub currentdump {
1.328 matthew 2978: my ($courseid,$sdom,$sname)=@_;
1.620 albertel 2979: $courseid = $env{'request.course.id'} if (! defined($courseid));
2980: $sdom = $env{'user.domain'} if (! defined($sdom));
2981: $sname = $env{'user.name'} if (! defined($sname));
1.326 matthew 2982: my $uhome = &homeserver($sname,$sdom);
2983: my $rep=reply('currentdump:'.$sdom.':'.$sname.':'.$courseid,$uhome);
1.318 matthew 2984: return if ($rep =~ /^(error:|no_such_host)/);
1.319 matthew 2985: #
1.318 matthew 2986: my %returnhash=();
1.319 matthew 2987: #
2988: if ($rep eq "unknown_cmd") {
2989: # an old lond will not know currentdump
2990: # Do a dump and make it look like a currentdump
1.326 matthew 2991: my @tmp = &dump($courseid,$sdom,$sname,'.');
1.319 matthew 2992: return if ($tmp[0] =~ /^(error:|no_such_host)/);
2993: my %hash = @tmp;
2994: @tmp=();
1.424 matthew 2995: %returnhash = %{&convert_dump_to_currentdump(\%hash)};
1.319 matthew 2996: } else {
2997: my @pairs=split(/\&/,$rep);
2998: foreach (@pairs) {
2999: my ($key,$value)=split(/=/,$_);
3000: my ($symb,$param) = split(/:/,$key);
3001: $returnhash{&unescape($symb)}->{&unescape($param)} =
1.557 albertel 3002: &thaw_unescape($value);
1.319 matthew 3003: }
1.191 harris41 3004: }
1.12 www 3005: return %returnhash;
1.424 matthew 3006: }
3007:
3008: sub convert_dump_to_currentdump{
3009: my %hash = %{shift()};
3010: my %returnhash;
3011: # Code ripped from lond, essentially. The only difference
3012: # here is the unescaping done by lonnet::dump(). Conceivably
3013: # we might run in to problems with parameter names =~ /^v\./
3014: while (my ($key,$value) = each(%hash)) {
3015: my ($v,$symb,$param) = split(/:/,$key);
3016: next if ($v eq 'version' || $symb eq 'keys');
3017: next if (exists($returnhash{$symb}) &&
3018: exists($returnhash{$symb}->{$param}) &&
3019: $returnhash{$symb}->{'v.'.$param} > $v);
3020: $returnhash{$symb}->{$param}=$value;
3021: $returnhash{$symb}->{'v.'.$param}=$v;
3022: }
3023: #
3024: # Remove all of the keys in the hashes which keep track of
3025: # the version of the parameter.
3026: while (my ($symb,$param_hash) = each(%returnhash)) {
3027: # use a foreach because we are going to delete from the hash.
3028: foreach my $key (keys(%$param_hash)) {
3029: delete($param_hash->{$key}) if ($key =~ /^v\./);
3030: }
3031: }
3032: return \%returnhash;
1.12 www 3033: }
3034:
1.627 albertel 3035: # ------------------------------------------------------ critical inc interface
3036:
3037: sub cinc {
3038: return &inc(@_,'critical');
3039: }
3040:
1.449 matthew 3041: # --------------------------------------------------------------- inc interface
3042:
3043: sub inc {
1.627 albertel 3044: my ($namespace,$store,$udomain,$uname,$critical) = @_;
1.620 albertel 3045: if (!$udomain) { $udomain=$env{'user.domain'}; }
3046: if (!$uname) { $uname=$env{'user.name'}; }
1.449 matthew 3047: my $uhome=&homeserver($uname,$udomain);
3048: my $items='';
3049: if (! ref($store)) {
3050: # got a single value, so use that instead
3051: $items = &escape($store).'=&';
3052: } elsif (ref($store) eq 'SCALAR') {
3053: $items = &escape($$store).'=&';
3054: } elsif (ref($store) eq 'ARRAY') {
3055: $items = join('=&',map {&escape($_);} @{$store});
3056: } elsif (ref($store) eq 'HASH') {
3057: while (my($key,$value) = each(%{$store})) {
3058: $items.= &escape($key).'='.&escape($value).'&';
3059: }
3060: }
3061: $items=~s/\&$//;
1.627 albertel 3062: if ($critical) {
3063: return &critical("inc:$udomain:$uname:$namespace:$items",$uhome);
3064: } else {
3065: return &reply("inc:$udomain:$uname:$namespace:$items",$uhome);
3066: }
1.449 matthew 3067: }
3068:
1.12 www 3069: # --------------------------------------------------------------- put interface
3070:
3071: sub put {
1.134 albertel 3072: my ($namespace,$storehash,$udomain,$uname)=@_;
1.620 albertel 3073: if (!$udomain) { $udomain=$env{'user.domain'}; }
3074: if (!$uname) { $uname=$env{'user.name'}; }
1.134 albertel 3075: my $uhome=&homeserver($uname,$udomain);
1.12 www 3076: my $items='';
1.191 harris41 3077: foreach (keys %$storehash) {
1.557 albertel 3078: $items.=&escape($_).'='.&freeze_escape($$storehash{$_}).'&';
1.191 harris41 3079: }
1.12 www 3080: $items=~s/\&$//;
1.134 albertel 3081: return &reply("put:$udomain:$uname:$namespace:$items",$uhome);
1.47 www 3082: }
3083:
1.631 albertel 3084: # ------------------------------------------------------------ newput interface
3085:
3086: sub newput {
3087: my ($namespace,$storehash,$udomain,$uname)=@_;
3088: if (!$udomain) { $udomain=$env{'user.domain'}; }
3089: if (!$uname) { $uname=$env{'user.name'}; }
3090: my $uhome=&homeserver($uname,$udomain);
3091: my $items='';
3092: foreach my $key (keys(%$storehash)) {
3093: $items.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
3094: }
3095: $items=~s/\&$//;
3096: return &reply("newput:$udomain:$uname:$namespace:$items",$uhome);
3097: }
3098:
3099: # --------------------------------------------------------- putstore interface
3100:
1.524 raeburn 3101: sub putstore {
1.715 albertel 3102: my ($namespace,$symb,$version,$storehash,$udomain,$uname)=@_;
1.620 albertel 3103: if (!$udomain) { $udomain=$env{'user.domain'}; }
3104: if (!$uname) { $uname=$env{'user.name'}; }
1.524 raeburn 3105: my $uhome=&homeserver($uname,$udomain);
3106: my $items='';
1.715 albertel 3107: foreach my $key (keys(%$storehash)) {
3108: $items.= &escape($key).'='.&freeze_escape($storehash->{$key}).'&';
1.524 raeburn 3109: }
1.715 albertel 3110: $items=~s/\&$//;
1.716 albertel 3111: my $esc_symb=&escape($symb);
3112: my $esc_v=&escape($version);
1.715 albertel 3113: my $reply =
1.716 albertel 3114: &reply("putstore:$udomain:$uname:$namespace:$esc_symb:$esc_v:$items",
1.715 albertel 3115: $uhome);
3116: if ($reply eq 'unknown_cmd') {
1.716 albertel 3117: # gfall back to way things use to be done
1.715 albertel 3118: return &old_putstore($namespace,$symb,$version,$storehash,$udomain,
3119: $uname);
1.524 raeburn 3120: }
1.715 albertel 3121: return $reply;
3122: }
3123:
3124: sub old_putstore {
1.716 albertel 3125: my ($namespace,$symb,$version,$storehash,$udomain,$uname)=@_;
3126: if (!$udomain) { $udomain=$env{'user.domain'}; }
3127: if (!$uname) { $uname=$env{'user.name'}; }
3128: my $uhome=&homeserver($uname,$udomain);
3129: my %newstorehash;
3130: foreach (keys %$storehash) {
3131: my $key = $version.':'.&escape($symb).':'.$_;
3132: $newstorehash{$key} = $storehash->{$_};
3133: }
3134: my $items='';
3135: my %allitems = ();
3136: foreach (keys %newstorehash) {
3137: if ($_ =~ m/^([^\:]+):([^\:]+):([^\:]+)$/) {
3138: my $key = $1.':keys:'.$2;
3139: $allitems{$key} .= $3.':';
3140: }
3141: $items.=$_.'='.&freeze_escape($newstorehash{$_}).'&';
3142: }
3143: foreach (keys %allitems) {
3144: $allitems{$_} =~ s/\:$//;
3145: $items.= $_.'='.$allitems{$_}.'&';
3146: }
3147: $items=~s/\&$//;
3148: return &reply("put:$udomain:$uname:$namespace:$items",$uhome);
1.524 raeburn 3149: }
3150:
1.47 www 3151: # ------------------------------------------------------ critical put interface
3152:
3153: sub cput {
1.134 albertel 3154: my ($namespace,$storehash,$udomain,$uname)=@_;
1.620 albertel 3155: if (!$udomain) { $udomain=$env{'user.domain'}; }
3156: if (!$uname) { $uname=$env{'user.name'}; }
1.134 albertel 3157: my $uhome=&homeserver($uname,$udomain);
1.47 www 3158: my $items='';
1.191 harris41 3159: foreach (keys %$storehash) {
1.715 albertel 3160: $items.=&escape($_).'='.&freeze_escape($$storehash{$_}).'&';
1.191 harris41 3161: }
1.47 www 3162: $items=~s/\&$//;
1.134 albertel 3163: return &critical("put:$udomain:$uname:$namespace:$items",$uhome);
1.12 www 3164: }
3165:
3166: # -------------------------------------------------------------- eget interface
3167:
3168: sub eget {
1.133 albertel 3169: my ($namespace,$storearr,$udomain,$uname)=@_;
1.12 www 3170: my $items='';
1.191 harris41 3171: foreach (@$storearr) {
1.12 www 3172: $items.=escape($_).'&';
1.191 harris41 3173: }
1.12 www 3174: $items=~s/\&$//;
1.620 albertel 3175: if (!$udomain) { $udomain=$env{'user.domain'}; }
3176: if (!$uname) { $uname=$env{'user.name'}; }
1.133 albertel 3177: my $uhome=&homeserver($uname,$udomain);
3178: my $rep=&reply("eget:$udomain:$uname:$namespace:$items",$uhome);
1.12 www 3179: my @pairs=split(/\&/,$rep);
3180: my %returnhash=();
1.42 www 3181: my $i=0;
1.191 harris41 3182: foreach (@$storearr) {
1.557 albertel 3183: $returnhash{$_}=&thaw_unescape($pairs[$i]);
1.42 www 3184: $i++;
1.191 harris41 3185: }
1.12 www 3186: return %returnhash;
3187: }
3188:
1.667 albertel 3189: # ------------------------------------------------------------ tmpput interface
3190: sub tmpput {
3191: my ($storehash,$server)=@_;
3192: my $items='';
3193: foreach (keys(%$storehash)) {
3194: $items.=&escape($_).'='.&freeze_escape($$storehash{$_}).'&';
3195: }
3196: $items=~s/\&$//;
3197: return &reply("tmpput:$items",$server);
3198: }
3199:
3200: # ------------------------------------------------------------ tmpget interface
3201: sub tmpget {
1.688 albertel 3202: my ($token,$server)=@_;
3203: if (!defined($server)) { $server = $perlvar{'lonHostID'}; }
3204: my $rep=&reply("tmpget:$token",$server);
1.667 albertel 3205: my %returnhash;
3206: foreach my $item (split(/\&/,$rep)) {
3207: my ($key,$value)=split(/=/,$item);
3208: $returnhash{&unescape($key)}=&thaw_unescape($value);
3209: }
3210: return %returnhash;
3211: }
3212:
1.688 albertel 3213: # ------------------------------------------------------------ tmpget interface
3214: sub tmpdel {
3215: my ($token,$server)=@_;
3216: if (!defined($server)) { $server = $perlvar{'lonHostID'}; }
3217: return &reply("tmpdel:$token",$server);
3218: }
3219:
1.765 ! albertel 3220: # -------------------------------------------------- portfolio access checking
! 3221:
! 3222: sub portfolio_access {
! 3223: my ($r,$requrl) = @_;
! 3224: my $access=&allowed('bre',$requrl);
! 3225: if ($access eq '2' || $access eq 'F') {
! 3226: return 'ok';
! 3227: }
! 3228: my (undef,$udom,$unum,$file_name,$group) = &parse_portfolio_url($requrl);
! 3229: my $result = &get_portfolio_access($udom,$unum,$file_name,$group);
! 3230: if ($result eq 'ok') {
! 3231: return 'ok';
! 3232: } elsif ($result =~ /^[^:]+:guest_/) {
! 3233: &Apache::lonacc::passphrase_access_checker($r,$result,$requrl);
! 3234: return 'ok';
! 3235: }
! 3236: return undef;
! 3237: }
! 3238:
! 3239: sub get_portfolio_access {
! 3240: my ($udom,$unum,$file_name,$group) = @_;
! 3241:
! 3242: my $current_perms = &get_portfile_permissions($udom,$unum);
! 3243: my %access_controls = &get_access_controls($current_perms,$group,
! 3244: $file_name);
! 3245: my ($public,$guest,@domains,@users,@courses,@groups);
! 3246: my $now = time;
! 3247: my $access_hash = $access_controls{$file_name};
! 3248: if (ref($access_hash) eq 'HASH') {
! 3249: foreach my $key (keys(%{$access_hash})) {
! 3250: my ($num,$scope,$end,$start) = ($key =~ /^([^:]+):([a-z]+)_(\d*)_?(\d*)$/);
! 3251: if ($start > $now) {
! 3252: next;
! 3253: }
! 3254: if ($end && $end<$now) {
! 3255: next;
! 3256: }
! 3257: if ($scope eq 'public') {
! 3258: $public = $key;
! 3259: last;
! 3260: } elsif ($scope eq 'guest') {
! 3261: $guest = $key;
! 3262: } elsif ($scope eq 'domains') {
! 3263: push(@domains,$key);
! 3264: } elsif ($scope eq 'users') {
! 3265: push(@users,$key);
! 3266: } elsif ($scope eq 'course') {
! 3267: push(@courses,$key);
! 3268: } elsif ($scope eq 'group') {
! 3269: push(@groups,$key);
! 3270: }
! 3271: }
! 3272: if ($public) {
! 3273: return 'ok';
! 3274: }
! 3275: if ($env{'user.name'} eq 'public' && $env{'user.domain'} eq 'public') {
! 3276: if ($guest) {
! 3277: return $guest;
! 3278: }
! 3279: } else {
! 3280: if (@domains > 0) {
! 3281: foreach my $domkey (@domains) {
! 3282: if (ref($access_hash->{$domkey}{'dom'}) eq 'ARRAY') {
! 3283: if (grep(/^\Q$env{'user.domain'}\E$/,@{$access_hash->{$domkey}{'dom'}})) {
! 3284: return 'ok';
! 3285: }
! 3286: }
! 3287: }
! 3288: }
! 3289: if (@users > 0) {
! 3290: foreach my $userkey (@users) {
! 3291: if (exists($access_hash->{$userkey}{'users'}{$env{'user.name'}.':'.$env{'user.domain'}})) {
! 3292: return 'ok';
! 3293: }
! 3294: }
! 3295: }
! 3296: my %roleshash;
! 3297: my @courses_and_groups = @courses;
! 3298: push(@courses_and_groups,@groups);
! 3299: if (@courses_and_groups > 0) {
! 3300: my (%allgroups,%allroles);
! 3301: my ($start,$end,$role,$sec,$group);
! 3302: foreach my $envkey (%env) {
! 3303: if ($envkey =~ m-^user\.role\.(gr|cc|in|ta|ep|st)\./([^/]+)/([^/]+)/?([^/]*)$-) {
! 3304: my $cid = $2.'_'.$3;
! 3305: if ($1 eq 'gr') {
! 3306: $group = $4;
! 3307: $allgroups{$cid}{$group} = $env{$envkey};
! 3308: } else {
! 3309: if ($4 eq '') {
! 3310: $sec = 'none';
! 3311: } else {
! 3312: $sec = $4;
! 3313: }
! 3314: $allroles{$cid}{$1}{$sec} = $env{$envkey};
! 3315: }
! 3316: } elsif ($envkey =~ m-^user\.role\./cr/(\w+/\w+/\w*)./([^/]+)/([^/]+)/?([^/]*)$-) {
! 3317: my $cid = $2.'_'.$3;
! 3318: if ($4 eq '') {
! 3319: $sec = 'none';
! 3320: } else {
! 3321: $sec = $4;
! 3322: }
! 3323: $allroles{$cid}{$1}{$sec} = $env{$envkey};
! 3324: }
! 3325: }
! 3326: if (keys(%allroles) == 0) {
! 3327: return;
! 3328: }
! 3329: foreach my $key (@courses_and_groups) {
! 3330: my %content = %{$$access_hash{$key}};
! 3331: my $cnum = $content{'number'};
! 3332: my $cdom = $content{'domain'};
! 3333: my $cid = $cdom.'_'.$cnum;
! 3334: if (!exists($allroles{$cid})) {
! 3335: next;
! 3336: }
! 3337: foreach my $role_id (keys(%{$content{'roles'}})) {
! 3338: my @sections = @{$content{'roles'}{$role_id}{'section'}};
! 3339: my @groups = @{$content{'roles'}{$role_id}{'group'}};
! 3340: my @status = @{$content{'roles'}{$role_id}{'access'}};
! 3341: my @roles = @{$content{'roles'}{$role_id}{'role'}};
! 3342: foreach my $role (keys(%{$allroles{$cid}})) {
! 3343: if ((grep/^all$/,@roles) || (grep/^\Q$role\E$/,@roles)) {
! 3344: foreach my $sec (keys(%{$allroles{$cid}{$role}})) {
! 3345: if (&course_group_datechecker($allroles{$cid}{$role}{$sec},$now,\@status) eq 'ok') {
! 3346: if (grep/^all$/,@sections) {
! 3347: return 'ok';
! 3348: } else {
! 3349: if (grep/^$sec$/,@sections) {
! 3350: return 'ok';
! 3351: }
! 3352: }
! 3353: }
! 3354: }
! 3355: if (keys(%{$allgroups{$cid}}) == 0) {
! 3356: if (grep/^none$/,@groups) {
! 3357: return 'ok';
! 3358: }
! 3359: } else {
! 3360: if (grep/^all$/,@groups) {
! 3361: return 'ok';
! 3362: }
! 3363: foreach my $group (keys(%{$allgroups{$cid}})) {
! 3364: if (grep/^$group$/,@groups) {
! 3365: return 'ok';
! 3366: }
! 3367: }
! 3368: }
! 3369: }
! 3370: }
! 3371: }
! 3372: }
! 3373: }
! 3374: if ($guest) {
! 3375: return $guest;
! 3376: }
! 3377: }
! 3378: }
! 3379: return;
! 3380: }
! 3381:
! 3382: sub course_group_datechecker {
! 3383: my ($dates,$now,$status) = @_;
! 3384: my ($start,$end) = split(/\./,$dates);
! 3385: if (!$start && !$end) {
! 3386: return 'ok';
! 3387: }
! 3388: if (grep/^active$/,@{$status}) {
! 3389: if (((!$start) || ($start && $start <= $now)) && ((!$end) || ($end && $end >= $now))) {
! 3390: return 'ok';
! 3391: }
! 3392: }
! 3393: if (grep/^previous$/,@{$status}) {
! 3394: if ($end > $now ) {
! 3395: return 'ok';
! 3396: }
! 3397: }
! 3398: if (grep/^future$/,@{$status}) {
! 3399: if ($start > $now) {
! 3400: return 'ok';
! 3401: }
! 3402: }
! 3403: return;
! 3404: }
! 3405:
! 3406: sub parse_portfolio_url {
! 3407: my ($url) = @_;
! 3408:
! 3409: my ($type,$udom,$unum,$group,$file_name);
! 3410:
! 3411: if ($url =~ m-^/*uploaded/([^/]+)/([^/]+)/portfolio(/.+)$-) {
! 3412: $type = 1;
! 3413: $udom = $1;
! 3414: $unum = $2;
! 3415: $file_name = $3;
! 3416: } elsif ($url =~ m-^/*uploaded/([^/]+)/([^/]+)/groups/([^/]+)/portfolio/(.+)$-) {
! 3417: $type = 2;
! 3418: $udom = $1;
! 3419: $unum = $2;
! 3420: $group = $3;
! 3421: $file_name = $3.'/'.$4;
! 3422: }
! 3423: if (wantarray) {
! 3424: return ($type,$udom,$unum,$file_name,$group);
! 3425: }
! 3426: return $type;
! 3427: }
! 3428:
! 3429: sub is_portfolio_url {
! 3430: my ($url) = @_;
! 3431: return scalar(&parse_portfolio_url($url));
! 3432: }
! 3433:
1.341 www 3434: # ---------------------------------------------- Custom access rule evaluation
3435:
3436: sub customaccess {
3437: my ($priv,$uri)=@_;
1.620 albertel 3438: my ($urole,$urealm)=split(/\./,$env{'request.role'});
1.343 www 3439: $urealm=~s/^\W//;
3440: my ($udom,$ucrs,$usec)=split(/\//,$urealm);
1.341 www 3441: my $access=0;
3442: foreach (split(/\s*\,\s*/,&metadata($uri,'rule_rights'))) {
1.342 www 3443: my ($effect,$realm,$role)=split(/\:/,$_);
1.343 www 3444: if ($role) {
3445: if ($role ne $urole) { next; }
3446: }
3447: foreach (split(/\s*\,\s*/,$realm)) {
3448: my ($tdom,$tcrs,$tsec)=split(/\_/,$_);
3449: if ($tdom) {
3450: if ($tdom ne $udom) { next; }
3451: }
3452: if ($tcrs) {
3453: if ($tcrs ne $ucrs) { next; }
3454: }
3455: if ($tsec) {
3456: if ($tsec ne $usec) { next; }
3457: }
3458: $access=($effect eq 'allow');
3459: last;
1.342 www 3460: }
1.402 bowersj2 3461: if ($realm eq '' && $role eq '') {
3462: $access=($effect eq 'allow');
3463: }
1.341 www 3464: }
3465: return $access;
3466: }
3467:
1.103 harris41 3468: # ------------------------------------------------- Check for a user privilege
1.12 www 3469:
3470: sub allowed {
1.579 albertel 3471: my ($priv,$uri,$symb)=@_;
1.705 albertel 3472: my $ver_orguri=$uri;
1.439 www 3473: $uri=&deversion($uri);
1.152 www 3474: my $orguri=$uri;
1.52 www 3475: $uri=&declutter($uri);
1.545 banghart 3476:
1.620 albertel 3477: if (defined($env{'allowed.'.$priv})) { return $env{'allowed.'.$priv}; }
1.54 www 3478: # Free bre access to adm and meta resources
1.529 albertel 3479: if (((($uri=~/^adm\//) && ($uri !~ m|/bulletinboard$|))
3480: || ($uri=~/\.meta$/)) && ($priv eq 'bre')) {
1.14 www 3481: return 'F';
1.159 www 3482: }
3483:
1.545 banghart 3484: # Free bre access to user's own portfolio contents
1.714 raeburn 3485: my ($space,$domain,$name,@dir)=split('/',$uri);
1.647 raeburn 3486: if (($space=~/^(uploaded|editupload)$/) && ($env{'user.name'} eq $name) &&
1.714 raeburn 3487: ($env{'user.domain'} eq $domain) && ('portfolio' eq $dir[0])) {
1.545 banghart 3488: return 'F';
3489: }
3490:
1.762 raeburn 3491: # bre access to group portfolio for rgf priv in group, or mdg or vcg in course.
1.714 raeburn 3492: if (($space=~/^(uploaded|editupload)$/) && ($dir[0] eq 'groups')
3493: && ($dir[2] eq 'portfolio') && ($priv eq 'bre')) {
3494: if (exists($env{'request.course.id'})) {
3495: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
3496: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
3497: if (($domain eq $cdom) && ($name eq $cnum)) {
3498: my $courseprivid=$env{'request.course.id'};
3499: $courseprivid=~s/\_/\//;
3500: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid
3501: .'/'.$dir[1]} =~/rgf\&([^\:]*)/) {
3502: return $1;
1.762 raeburn 3503: } else {
3504: if ($env{'request.course.sec'}) {
3505: $courseprivid.='/'.$env{'request.course.sec'};
3506: }
3507: if ($env{'user.priv.'.$env{'request.role'}.'./'.
3508: $courseprivid} =~/(mdg|vcg)\&([^\:]*)/) {
3509: return $2;
3510: }
1.714 raeburn 3511: }
3512: }
3513: }
3514: }
3515:
1.159 www 3516: # Free bre to public access
3517:
3518: if ($priv eq 'bre') {
1.238 www 3519: my $copyright=&metadata($uri,'copyright');
1.620 albertel 3520: if (($copyright eq 'public') && (!$env{'request.course.id'})) {
1.301 www 3521: return 'F';
3522: }
1.238 www 3523: if ($copyright eq 'priv') {
3524: $uri=~/([^\/]+)\/([^\/]+)\//;
1.620 albertel 3525: unless (($env{'user.name'} eq $2) && ($env{'user.domain'} eq $1)) {
1.238 www 3526: return '';
3527: }
3528: }
3529: if ($copyright eq 'domain') {
3530: $uri=~/([^\/]+)\/([^\/]+)\//;
1.620 albertel 3531: unless (($env{'user.domain'} eq $1) ||
3532: ($env{'course.'.$env{'request.course.id'}.'.domain'} eq $1)) {
1.238 www 3533: return '';
3534: }
1.262 matthew 3535: }
1.620 albertel 3536: if ($env{'request.role'}=~ /li\.\//) {
1.262 matthew 3537: # Library role, so allow browsing of resources in this domain.
3538: return 'F';
1.238 www 3539: }
1.341 www 3540: if ($copyright eq 'custom') {
3541: unless (&customaccess($priv,$uri)) { return ''; }
3542: }
1.14 www 3543: }
1.264 matthew 3544: # Domain coordinator is trying to create a course
1.620 albertel 3545: if (($priv eq 'ccc') && ($env{'request.role'} =~ /^dc\./)) {
1.264 matthew 3546: # uri is the requested domain in this case.
3547: # comparison to 'request.role.domain' shows if the user has selected
1.678 raeburn 3548: # a role of dc for the domain in question.
1.620 albertel 3549: return 'F' if ($uri eq $env{'request.role.domain'});
1.264 matthew 3550: }
1.29 www 3551:
1.52 www 3552: my $thisallowed='';
3553: my $statecond=0;
3554: my $courseprivid='';
3555:
3556: # Course
3557:
1.620 albertel 3558: if ($env{'user.priv.'.$env{'request.role'}.'./'}=~/\Q$priv\E\&([^\:]*)/) {
1.52 www 3559: $thisallowed.=$1;
3560: }
1.29 www 3561:
1.52 www 3562: # Domain
3563:
1.620 albertel 3564: if ($env{'user.priv.'.$env{'request.role'}.'./'.(split(/\//,$uri))[0].'/'}
1.479 albertel 3565: =~/\Q$priv\E\&([^\:]*)/) {
1.12 www 3566: $thisallowed.=$1;
3567: }
1.52 www 3568:
3569: # Course: uri itself is a course
1.66 www 3570: my $courseuri=$uri;
3571: $courseuri=~s/\_(\d)/\/$1/;
1.83 www 3572: $courseuri=~s/^([^\/])/\/$1/;
1.81 www 3573:
1.620 albertel 3574: if ($env{'user.priv.'.$env{'request.role'}.'.'.$courseuri}
1.479 albertel 3575: =~/\Q$priv\E\&([^\:]*)/) {
1.12 www 3576: $thisallowed.=$1;
3577: }
1.29 www 3578:
1.665 albertel 3579: # URI is an uploaded document for this course, default permissions don't matter
1.611 albertel 3580: # not allowing 'edit' access (editupload) to uploaded course docs
1.492 albertel 3581: if (($priv eq 'bre') && ($uri=~m|^uploaded/|)) {
1.665 albertel 3582: $thisallowed='';
1.671 raeburn 3583: my ($match)=&is_on_map($uri);
3584: if ($match) {
3585: if ($env{'user.priv.'.$env{'request.role'}.'./'}
3586: =~/\Q$priv\E\&([^\:]*)/) {
3587: $thisallowed.=$1;
3588: }
3589: } else {
1.705 albertel 3590: my $refuri = $env{'httpref.'.$orguri} || $env{'httpref.'.$ver_orguri};
1.671 raeburn 3591: if ($refuri) {
3592: if ($refuri =~ m|^/adm/|) {
1.669 raeburn 3593: $thisallowed='F';
1.671 raeburn 3594: } else {
3595: $refuri=&declutter($refuri);
3596: my ($match) = &is_on_map($refuri);
3597: if ($match) {
3598: $thisallowed='F';
3599: }
1.669 raeburn 3600: }
1.671 raeburn 3601: }
3602: }
1.314 www 3603: }
1.492 albertel 3604:
1.52 www 3605: # Full access at system, domain or course-wide level? Exit.
1.29 www 3606:
3607: if ($thisallowed=~/F/) {
3608: return 'F';
3609: }
3610:
1.52 www 3611: # If this is generating or modifying users, exit with special codes
1.29 www 3612:
1.643 www 3613: if (':csu:cdc:ccc:cin:cta:cep:ccr:cst:cad:cli:cau:cdg:cca:caa:'=~/\:\Q$priv\E\:/) {
3614: if (($priv eq 'cca') || ($priv eq 'caa')) {
1.642 albertel 3615: my ($audom,$auname)=split('/',$uri);
1.643 www 3616: # no author name given, so this just checks on the general right to make a co-author in this domain
3617: unless ($auname) { return $thisallowed; }
3618: # an author name is given, so we are about to actually make a co-author for a certain account
1.642 albertel 3619: if (($auname ne $env{'user.name'} && $env{'request.role'} !~ /^dc\./) ||
3620: (($audom ne $env{'user.domain'} && $env{'request.role'} !~ /^dc\./) &&
3621: ($audom ne $env{'request.role.domain'}))) { return ''; }
3622: }
1.52 www 3623: return $thisallowed;
3624: }
3625: #
1.103 harris41 3626: # Gathered so far: system, domain and course wide privileges
1.52 www 3627: #
3628: # Course: See if uri or referer is an individual resource that is part of
3629: # the course
3630:
1.620 albertel 3631: if ($env{'request.course.id'}) {
1.232 www 3632:
1.620 albertel 3633: $courseprivid=$env{'request.course.id'};
3634: if ($env{'request.course.sec'}) {
3635: $courseprivid.='/'.$env{'request.course.sec'};
1.52 www 3636: }
3637: $courseprivid=~s/\_/\//;
3638: my $checkreferer=1;
1.232 www 3639: my ($match,$cond)=&is_on_map($uri);
3640: if ($match) {
3641: $statecond=$cond;
1.620 albertel 3642: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid}
1.479 albertel 3643: =~/\Q$priv\E\&([^\:]*)/) {
1.52 www 3644: $thisallowed.=$1;
3645: $checkreferer=0;
3646: }
1.29 www 3647: }
1.83 www 3648:
1.148 www 3649: if ($checkreferer) {
1.620 albertel 3650: my $refuri=$env{'httpref.'.$orguri};
1.148 www 3651: unless ($refuri) {
1.620 albertel 3652: foreach (keys %env) {
1.148 www 3653: if ($_=~/^httpref\..*\*/) {
3654: my $pattern=$_;
1.156 www 3655: $pattern=~s/^httpref\.\/res\///;
1.148 www 3656: $pattern=~s/\*/\[\^\/\]\+/g;
3657: $pattern=~s/\//\\\//g;
1.152 www 3658: if ($orguri=~/$pattern/) {
1.620 albertel 3659: $refuri=$env{$_};
1.148 www 3660: }
3661: }
1.191 harris41 3662: }
1.148 www 3663: }
1.232 www 3664:
1.148 www 3665: if ($refuri) {
1.152 www 3666: $refuri=&declutter($refuri);
1.232 www 3667: my ($match,$cond)=&is_on_map($refuri);
3668: if ($match) {
3669: my $refstatecond=$cond;
1.620 albertel 3670: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid}
1.479 albertel 3671: =~/\Q$priv\E\&([^\:]*)/) {
1.52 www 3672: $thisallowed.=$1;
1.53 www 3673: $uri=$refuri;
3674: $statecond=$refstatecond;
1.52 www 3675: }
3676: }
1.148 www 3677: }
1.29 www 3678: }
1.52 www 3679: }
1.29 www 3680:
1.52 www 3681: #
1.103 harris41 3682: # Gathered now: all privileges that could apply, and condition number
1.52 www 3683: #
3684: #
3685: # Full or no access?
3686: #
1.29 www 3687:
1.52 www 3688: if ($thisallowed=~/F/) {
3689: return 'F';
3690: }
1.29 www 3691:
1.52 www 3692: unless ($thisallowed) {
3693: return '';
3694: }
1.29 www 3695:
1.52 www 3696: # Restrictions exist, deal with them
3697: #
3698: # C:according to course preferences
3699: # R:according to resource settings
3700: # L:unless locked
3701: # X:according to user session state
3702: #
3703:
3704: # Possibly locked functionality, check all courses
1.54 www 3705: # Locks might take effect only after 10 minutes cache expiration for other
3706: # courses, and 2 minutes for current course
1.52 www 3707:
3708: my $envkey;
3709: if ($thisallowed=~/L/) {
1.620 albertel 3710: foreach $envkey (keys %env) {
1.54 www 3711: if ($envkey=~/^user\.role\.(st|ta)\.([^\.]*)/) {
3712: my $courseid=$2;
3713: my $roleid=$1.'.'.$2;
1.92 www 3714: $courseid=~s/^\///;
1.54 www 3715: my $expiretime=600;
1.620 albertel 3716: if ($env{'request.role'} eq $roleid) {
1.54 www 3717: $expiretime=120;
3718: }
3719: my ($cdom,$cnum,$csec)=split(/\//,$courseid);
3720: my $prefix='course.'.$cdom.'_'.$cnum.'.';
1.620 albertel 3721: if ((time-$env{$prefix.'last_cache'})>$expiretime) {
1.731 albertel 3722: &coursedescription($courseid,{'freshen_cache' => 1});
1.54 www 3723: }
1.620 albertel 3724: if (($env{$prefix.'res.'.$uri.'.lock.sections'}=~/\,\Q$csec\E\,/)
3725: || ($env{$prefix.'res.'.$uri.'.lock.sections'} eq 'all')) {
3726: if ($env{$prefix.'res.'.$uri.'.lock.expire'}>time) {
3727: &log($env{'user.domain'},$env{'user.name'},
3728: $env{'user.home'},
1.57 www 3729: 'Locked by res: '.$priv.' for '.$uri.' due to '.
1.52 www 3730: $cdom.'/'.$cnum.'/'.$csec.' expire '.
1.620 albertel 3731: $env{$prefix.'priv.'.$priv.'.lock.expire'});
1.52 www 3732: return '';
3733: }
3734: }
1.620 albertel 3735: if (($env{$prefix.'priv.'.$priv.'.lock.sections'}=~/\,\Q$csec\E\,/)
3736: || ($env{$prefix.'priv.'.$priv.'.lock.sections'} eq 'all')) {
3737: if ($env{'priv.'.$priv.'.lock.expire'}>time) {
3738: &log($env{'user.domain'},$env{'user.name'},
3739: $env{'user.home'},
1.57 www 3740: 'Locked by priv: '.$priv.' for '.$uri.' due to '.
1.52 www 3741: $cdom.'/'.$cnum.'/'.$csec.' expire '.
1.620 albertel 3742: $env{$prefix.'priv.'.$priv.'.lock.expire'});
1.52 www 3743: return '';
3744: }
3745: }
3746: }
1.29 www 3747: }
1.52 www 3748: }
3749:
3750: #
3751: # Rest of the restrictions depend on selected course
3752: #
3753:
1.620 albertel 3754: unless ($env{'request.course.id'}) {
1.52 www 3755: return '1';
3756: }
1.29 www 3757:
1.52 www 3758: #
3759: # Now user is definitely in a course
3760: #
1.53 www 3761:
3762:
3763: # Course preferences
3764:
3765: if ($thisallowed=~/C/) {
1.620 albertel 3766: my $rolecode=(split(/\./,$env{'request.role'}))[0];
3767: my $unamedom=$env{'user.name'}.':'.$env{'user.domain'};
3768: if ($env{'course.'.$env{'request.course.id'}.'.'.$priv.'.roles.denied'}
1.479 albertel 3769: =~/\Q$rolecode\E/) {
1.689 albertel 3770: if ($priv ne 'pch') {
3771: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.':'.
3772: 'Denied by role: '.$priv.' for '.$uri.' as '.$rolecode.' in '.
3773: $env{'request.course.id'});
3774: }
1.237 www 3775: return '';
3776: }
3777:
1.620 albertel 3778: if ($env{'course.'.$env{'request.course.id'}.'.'.$priv.'.users.denied'}
1.479 albertel 3779: =~/\Q$unamedom\E/) {
1.689 albertel 3780: if ($priv ne 'pch') {
3781: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.
3782: 'Denied by user: '.$priv.' for '.$uri.' as '.$unamedom.' in '.
3783: $env{'request.course.id'});
3784: }
1.54 www 3785: return '';
3786: }
1.53 www 3787: }
3788:
3789: # Resource preferences
3790:
3791: if ($thisallowed=~/R/) {
1.620 albertel 3792: my $rolecode=(split(/\./,$env{'request.role'}))[0];
1.479 albertel 3793: if (&metadata($uri,'roledeny')=~/\Q$rolecode\E/) {
1.689 albertel 3794: if ($priv ne 'pch') {
3795: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.':'.
3796: 'Denied by role: '.$priv.' for '.$uri.' as '.$rolecode);
3797: }
3798: return '';
1.54 www 3799: }
1.53 www 3800: }
1.30 www 3801:
1.246 www 3802: # Restricted by state or randomout?
1.30 www 3803:
1.52 www 3804: if ($thisallowed=~/X/) {
1.620 albertel 3805: if ($env{'acc.randomout'}) {
1.579 albertel 3806: if (!$symb) { $symb=&symbread($uri,1); }
1.620 albertel 3807: if (($symb) && ($env{'acc.randomout'}=~/\&\Q$symb\E\&/)) {
1.248 www 3808: return '';
3809: }
1.247 www 3810: }
3811: if (&condval($statecond)) {
1.52 www 3812: return '2';
3813: } else {
3814: return '';
3815: }
3816: }
1.30 www 3817:
1.52 www 3818: return 'F';
1.232 www 3819: }
3820:
1.710 albertel 3821: sub split_uri_for_cond {
3822: my $uri=&deversion(&declutter(shift));
3823: my @uriparts=split(/\//,$uri);
3824: my $filename=pop(@uriparts);
3825: my $pathname=join('/',@uriparts);
3826: return ($pathname,$filename);
3827: }
1.232 www 3828: # --------------------------------------------------- Is a resource on the map?
3829:
3830: sub is_on_map {
1.710 albertel 3831: my ($pathname,$filename) = &split_uri_for_cond(shift);
1.289 bowersj2 3832: #Trying to find the conditional for the file
1.620 albertel 3833: my $match=($env{'acc.res.'.$env{'request.course.id'}.'.'.$pathname}=~
1.289 bowersj2 3834: /\&\Q$filename\E\:([\d\|]+)\&/);
1.232 www 3835: if ($match) {
1.289 bowersj2 3836: return (1,$1);
3837: } else {
1.434 www 3838: return (0,0);
1.289 bowersj2 3839: }
1.12 www 3840: }
3841:
1.427 www 3842: # --------------------------------------------------------- Get symb from alias
3843:
3844: sub get_symb_from_alias {
3845: my $symb=shift;
3846: my ($map,$resid,$url)=&decode_symb($symb);
3847: # Already is a symb
3848: if ($url) { return $symb; }
3849: # Must be an alias
3850: my $aliassymb='';
3851: my %bighash;
1.620 albertel 3852: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
1.427 www 3853: &GDBM_READER(),0640)) {
3854: my $rid=$bighash{'mapalias_'.$symb};
3855: if ($rid) {
3856: my ($mapid,$resid)=split(/\./,$rid);
1.429 albertel 3857: $aliassymb=&encode_symb($bighash{'map_id_'.$mapid},
3858: $resid,$bighash{'src_'.$rid});
1.427 www 3859: }
3860: untie %bighash;
3861: }
3862: return $aliassymb;
3863: }
3864:
1.12 www 3865: # ----------------------------------------------------------------- Define Role
3866:
3867: sub definerole {
3868: if (allowed('mcr','/')) {
3869: my ($rolename,$sysrole,$domrole,$courole)=@_;
1.392 www 3870: foreach (split(':',$sysrole)) {
1.21 www 3871: my ($crole,$cqual)=split(/\&/,$_);
1.479 albertel 3872: if ($pr{'cr:s'}!~/\Q$crole\E/) { return "refused:s:$crole"; }
3873: if ($pr{'cr:s'}=~/\Q$crole\E\&/) {
3874: if ($pr{'cr:s'}!~/\Q$crole\E\&\w*\Q$cqual\E/) {
1.21 www 3875: return "refused:s:$crole&$cqual";
3876: }
3877: }
1.191 harris41 3878: }
1.392 www 3879: foreach (split(':',$domrole)) {
1.21 www 3880: my ($crole,$cqual)=split(/\&/,$_);
1.479 albertel 3881: if ($pr{'cr:d'}!~/\Q$crole\E/) { return "refused:d:$crole"; }
3882: if ($pr{'cr:d'}=~/\Q$crole\E\&/) {
3883: if ($pr{'cr:d'}!~/\Q$crole\W\&\w*\Q$cqual\E/) {
1.21 www 3884: return "refused:d:$crole&$cqual";
3885: }
3886: }
1.191 harris41 3887: }
1.392 www 3888: foreach (split(':',$courole)) {
1.21 www 3889: my ($crole,$cqual)=split(/\&/,$_);
1.479 albertel 3890: if ($pr{'cr:c'}!~/\Q$crole\E/) { return "refused:c:$crole"; }
3891: if ($pr{'cr:c'}=~/\Q$crole\E\&/) {
3892: if ($pr{'cr:c'}!~/\Q$crole\E\&\w*\Q$cqual\E/) {
1.21 www 3893: return "refused:c:$crole&$cqual";
3894: }
3895: }
1.191 harris41 3896: }
1.620 albertel 3897: my $command="encrypt:rolesput:$env{'user.domain'}:$env{'user.name'}:".
3898: "$env{'user.domain'}:$env{'user.name'}:".
1.21 www 3899: "rolesdef_$rolename=".
3900: escape($sysrole.'_'.$domrole.'_'.$courole);
1.620 albertel 3901: return reply($command,$env{'user.home'});
1.12 www 3902: } else {
3903: return 'refused';
3904: }
1.105 harris41 3905: }
3906:
3907: # ---------------- Make a metadata query against the network of library servers
3908:
3909: sub metadata_query {
1.244 matthew 3910: my ($query,$custom,$customshow,$server_array)=@_;
1.120 harris41 3911: my %rhash;
1.244 matthew 3912: my @server_list = (defined($server_array) ? @$server_array
3913: : keys(%libserv) );
3914: for my $server (@server_list) {
1.118 harris41 3915: unless ($custom or $customshow) {
3916: my $reply=&reply("querysend:".&escape($query),$server);
3917: $rhash{$server}=$reply;
3918: }
3919: else {
3920: my $reply=&reply("querysend:".&escape($query).':'.
3921: &escape($custom).':'.&escape($customshow),
3922: $server);
3923: $rhash{$server}=$reply;
3924: }
1.112 harris41 3925: }
1.118 harris41 3926: return \%rhash;
1.240 www 3927: }
3928:
3929: # ----------------------------------------- Send log queries and wait for reply
3930:
3931: sub log_query {
3932: my ($uname,$udom,$query,%filters)=@_;
3933: my $uhome=&homeserver($uname,$udom);
3934: if ($uhome eq 'no_host') { return 'error: no_host'; }
3935: my $uhost=$hostname{$uhome};
1.241 www 3936: my $command=&escape(join(':',map{$_.'='.$filters{$_}} keys %filters));
1.240 www 3937: my $queryid=&reply("querysend:".$query.':'.$udom.':'.$uname.':'.$command,
3938: $uhome);
1.479 albertel 3939: unless ($queryid=~/^\Q$uhost\E\_/) { return 'error: '.$queryid; }
1.242 www 3940: return get_query_reply($queryid);
3941: }
3942:
1.508 raeburn 3943: # ------- Request retrieval of institutional classlists for course(s)
1.506 raeburn 3944:
3945: sub fetch_enrollment_query {
1.511 raeburn 3946: my ($context,$affiliatesref,$replyref,$dom,$cnum) = @_;
1.508 raeburn 3947: my $homeserver;
1.547 raeburn 3948: my $maxtries = 1;
1.508 raeburn 3949: if ($context eq 'automated') {
3950: $homeserver = $perlvar{'lonHostID'};
1.547 raeburn 3951: $maxtries = 10; # will wait for up to 2000s for retrieval of classlist data before timeout
1.508 raeburn 3952: } else {
3953: $homeserver = &homeserver($cnum,$dom);
3954: }
1.506 raeburn 3955: my $host=$hostname{$homeserver};
3956: my $cmd = '';
3957: foreach (keys %{$affiliatesref}) {
1.508 raeburn 3958: $cmd .= $_.'='.join(",",@{$$affiliatesref{$_}}).'%%';
1.506 raeburn 3959: }
3960: $cmd =~ s/%%$//;
3961: $cmd = &escape($cmd);
3962: my $query = 'fetchenrollment';
1.620 albertel 3963: my $queryid=&reply("querysend:".$query.':'.$dom.':'.$env{'user.name'}.':'.$cmd,$homeserver);
1.526 raeburn 3964: unless ($queryid=~/^\Q$host\E\_/) {
3965: &logthis('fetch_enrollment_query: invalid queryid: '.$queryid.' for host: '.$host.' and homeserver: '.$homeserver.' context: '.$context.' '.$cnum);
3966: return 'error: '.$queryid;
3967: }
1.506 raeburn 3968: my $reply = &get_query_reply($queryid);
1.547 raeburn 3969: my $tries = 1;
3970: while (($reply=~/^timeout/) && ($tries < $maxtries)) {
3971: $reply = &get_query_reply($queryid);
3972: $tries ++;
3973: }
1.526 raeburn 3974: if ( ($reply =~/^timeout/) || ($reply =~/^error/) ) {
1.620 albertel 3975: &logthis('fetch_enrollment_query error: '.$reply.' for '.$dom.' '.$env{'user.name'}.' for '.$queryid.' context: '.$context.' '.$cnum.' maxtries: '.$maxtries.' tries: '.$tries);
1.526 raeburn 3976: } else {
1.515 raeburn 3977: my @responses = split/:/,$reply;
3978: if ($homeserver eq $perlvar{'lonHostID'}) {
3979: foreach (@responses) {
3980: my ($key,$value) = split/=/,$_;
3981: $$replyref{$key} = $value;
3982: }
3983: } else {
1.506 raeburn 3984: my $pathname = $perlvar{'lonDaemons'}.'/tmp';
3985: foreach (@responses) {
3986: my ($key,$value) = split/=/,$_;
3987: $$replyref{$key} = $value;
3988: if ($value > 0) {
3989: foreach (@{$$affiliatesref{$key}}) {
3990: my $filename = $dom.'_'.$key.'_'.$_.'_classlist.xml';
3991: my $destname = $pathname.'/'.$filename;
3992: my $xml_classlist = &reply("autoretrieve:".$filename,$homeserver);
1.526 raeburn 3993: if ($xml_classlist =~ /^error/) {
3994: &logthis('fetch_enrollment_query - autoretrieve error: '.$xml_classlist.' for '.$filename.' from server: '.$homeserver.' '.$context.' '.$cnum);
3995: } else {
1.506 raeburn 3996: if ( open(FILE,">$destname") ) {
3997: print FILE &unescape($xml_classlist);
3998: close(FILE);
1.526 raeburn 3999: } else {
4000: &logthis('fetch_enrollment_query - error opening classlist file '.$destname.' '.$context.' '.$cnum);
1.506 raeburn 4001: }
4002: }
4003: }
4004: }
4005: }
4006: }
4007: return 'ok';
4008: }
4009: return 'error';
4010: }
4011:
1.242 www 4012: sub get_query_reply {
4013: my $queryid=shift;
1.240 www 4014: my $replyfile=$perlvar{'lonDaemons'}.'/tmp/'.$queryid;
4015: my $reply='';
4016: for (1..100) {
4017: sleep 2;
4018: if (-e $replyfile.'.end') {
1.448 albertel 4019: if (open(my $fh,$replyfile)) {
1.240 www 4020: $reply.=<$fh>;
1.448 albertel 4021: close($fh);
1.240 www 4022: } else { return 'error: reply_file_error'; }
1.242 www 4023: return &unescape($reply);
4024: }
1.240 www 4025: }
1.242 www 4026: return 'timeout:'.$queryid;
1.240 www 4027: }
4028:
4029: sub courselog_query {
1.241 www 4030: #
4031: # possible filters:
4032: # url: url or symb
4033: # username
4034: # domain
4035: # action: view, submit, grade
4036: # start: timestamp
4037: # end: timestamp
4038: #
1.240 www 4039: my (%filters)=@_;
1.620 albertel 4040: unless ($env{'request.course.id'}) { return 'no_course'; }
1.241 www 4041: if ($filters{'url'}) {
4042: $filters{'url'}=&symbclean(&declutter($filters{'url'}));
4043: $filters{'url'}=~s/\.(\w+)$/(\\.\\d+)*\\.$1/;
4044: $filters{'url'}=~s/\.(\w+)\_\_\_/(\\.\\d+)*\\.$1/;
4045: }
1.620 albertel 4046: my $cname=$env{'course.'.$env{'request.course.id'}.'.num'};
4047: my $cdom=$env{'course.'.$env{'request.course.id'}.'.domain'};
1.240 www 4048: return &log_query($cname,$cdom,'courselog',%filters);
4049: }
4050:
4051: sub userlog_query {
4052: my ($uname,$udom,%filters)=@_;
4053: return &log_query($uname,$udom,'userlog',%filters);
1.12 www 4054: }
4055:
1.506 raeburn 4056: #--------- Call auto-enrollment subs in localenroll.pm for homeserver for course
4057:
4058: sub auto_run {
1.508 raeburn 4059: my ($cnum,$cdom) = @_;
4060: my $homeserver = &homeserver($cnum,$cdom);
1.511 raeburn 4061: my $response = &reply('autorun:'.$cdom,$homeserver);
1.506 raeburn 4062: return $response;
4063: }
4064:
4065: sub auto_get_sections {
1.508 raeburn 4066: my ($cnum,$cdom,$inst_coursecode) = @_;
4067: my $homeserver = &homeserver($cnum,$cdom);
1.506 raeburn 4068: my @secs = ();
1.511 raeburn 4069: my $response=&unescape(&reply('autogetsections:'.$inst_coursecode.':'.$cdom,$homeserver));
1.506 raeburn 4070: unless ($response eq 'refused') {
4071: @secs = split/:/,$response;
4072: }
4073: return @secs;
4074: }
4075:
4076: sub auto_new_course {
1.508 raeburn 4077: my ($cnum,$cdom,$inst_course_id,$owner) = @_;
4078: my $homeserver = &homeserver($cnum,$cdom);
1.515 raeburn 4079: my $response=&unescape(&reply('autonewcourse:'.$inst_course_id.':'.$owner.':'.$cdom,$homeserver));
1.506 raeburn 4080: return $response;
4081: }
4082:
4083: sub auto_validate_courseID {
1.508 raeburn 4084: my ($cnum,$cdom,$inst_course_id) = @_;
4085: my $homeserver = &homeserver($cnum,$cdom);
1.511 raeburn 4086: my $response=&unescape(&reply('autovalidatecourse:'.$inst_course_id.':'.$cdom,$homeserver));
1.506 raeburn 4087: return $response;
4088: }
4089:
4090: sub auto_create_password {
1.508 raeburn 4091: my ($cnum,$cdom,$authparam) = @_;
4092: my $homeserver = &homeserver($cnum,$cdom);
1.506 raeburn 4093: my $create_passwd = 0;
4094: my $authchk = '';
1.511 raeburn 4095: my $response=&unescape(&reply('autocreatepassword:'.$authparam.':'.$cdom,$homeserver));
1.506 raeburn 4096: if ($response eq 'refused') {
4097: $authchk = 'refused';
4098: } else {
4099: ($authparam,$create_passwd,$authchk) = split/:/,$response;
4100: }
4101: return ($authparam,$create_passwd,$authchk);
4102: }
4103:
1.706 raeburn 4104: sub auto_photo_permission {
4105: my ($cnum,$cdom,$students) = @_;
4106: my $homeserver = &homeserver($cnum,$cdom);
1.707 albertel 4107: my ($outcome,$perm_reqd,$conditions) =
4108: split(/:/,&unescape(&reply('autophotopermission:'.$cdom,$homeserver)),3);
1.709 albertel 4109: if ($outcome =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
4110: return (undef,undef);
4111: }
1.706 raeburn 4112: return ($outcome,$perm_reqd,$conditions);
4113: }
4114:
4115: sub auto_checkphotos {
4116: my ($uname,$udom,$pid) = @_;
4117: my $homeserver = &homeserver($uname,$udom);
4118: my ($result,$resulttype);
4119: my $outcome = &unescape(&reply('autophotocheck:'.&escape($udom).':'.
1.707 albertel 4120: &escape($uname).':'.&escape($pid),
4121: $homeserver));
1.709 albertel 4122: if ($outcome =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
4123: return (undef,undef);
4124: }
1.706 raeburn 4125: if ($outcome) {
4126: ($result,$resulttype) = split(/:/,$outcome);
4127: }
4128: return ($result,$resulttype);
4129: }
4130:
4131: sub auto_photochoice {
4132: my ($cnum,$cdom) = @_;
4133: my $homeserver = &homeserver($cnum,$cdom);
4134: my ($update,$comment) = split(/:/,&unescape(&reply('autophotochoice:'.
1.707 albertel 4135: &escape($cdom),
4136: $homeserver)));
1.709 albertel 4137: if ($update =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
4138: return (undef,undef);
4139: }
1.706 raeburn 4140: return ($update,$comment);
4141: }
4142:
4143: sub auto_photoupdate {
4144: my ($affiliatesref,$dom,$cnum,$photo) = @_;
4145: my $homeserver = &homeserver($cnum,$dom);
4146: my $host=$hostname{$homeserver};
4147: my $cmd = '';
4148: my $maxtries = 1;
4149: foreach (keys %{$affiliatesref}) {
4150: $cmd .= $_.'='.join(",",@{$$affiliatesref{$_}}).'%%';
4151: }
4152: $cmd =~ s/%%$//;
4153: $cmd = &escape($cmd);
4154: my $query = 'institutionalphotos';
4155: my $queryid=&reply("querysend:".$query.':'.$dom.':'.$cnum.':'.$cmd,$homeserver);
4156: unless ($queryid=~/^\Q$host\E\_/) {
4157: &logthis('institutionalphotos: invalid queryid: '.$queryid.' for host: '.$host.' and homeserver: '.$homeserver.' and course: '.$cnum);
4158: return 'error: '.$queryid;
4159: }
4160: my $reply = &get_query_reply($queryid);
4161: my $tries = 1;
4162: while (($reply=~/^timeout/) && ($tries < $maxtries)) {
4163: $reply = &get_query_reply($queryid);
4164: $tries ++;
4165: }
4166: if ( ($reply =~/^timeout/) || ($reply =~/^error/) ) {
4167: &logthis('institutionalphotos error: '.$reply.' for '.$dom.' '.$env{'user.name'}.' for '.$queryid.' course: '.$cnum.' maxtries: '.$maxtries.' tries: '.$tries);
4168: } else {
4169: my @responses = split(/:/,$reply);
4170: my $outcome = shift(@responses);
4171: foreach my $item (@responses) {
4172: my ($key,$value) = split(/=/,$item);
4173: $$photo{$key} = $value;
4174: }
4175: return $outcome;
4176: }
4177: return 'error';
4178: }
4179:
1.521 raeburn 4180: sub auto_instcode_format {
4181: my ($caller,$codedom,$instcodes,$codes,$codetitles,$cat_titles,$cat_order) = @_;
4182: my $courses = '';
4183: my $homeserver;
4184: if ($caller eq 'global') {
1.584 raeburn 4185: foreach my $tryserver (keys %libserv) {
4186: if ($hostdom{$tryserver} eq $codedom) {
4187: $homeserver = $tryserver;
4188: last;
4189: }
4190: }
1.620 albertel 4191: if (($env{'user.name'}) && ($env{'user.domain'} eq $codedom)) {
4192: $homeserver = &homeserver($env{'user.name'},$codedom);
1.584 raeburn 4193: }
1.521 raeburn 4194: } else {
4195: $homeserver = &homeserver($caller,$codedom);
4196: }
4197: foreach (keys %{$instcodes}) {
4198: $courses .= &escape($_).'='.&escape($$instcodes{$_}).'&';
4199: }
4200: chop($courses);
4201: my $response=&reply('autoinstcodeformat:'.$codedom.':'.$courses,$homeserver);
4202: unless ($response =~ /(con_lost|error|no_such_host|refused)/) {
4203: my ($codes_str,$codetitles_str,$cat_titles_str,$cat_order_str) = split/:/,$response;
4204: %{$codes} = &str2hash($codes_str);
4205: @{$codetitles} = &str2array($codetitles_str);
4206: %{$cat_titles} = &str2hash($cat_titles_str);
4207: %{$cat_order} = &str2hash($cat_order_str);
4208: return 'ok';
4209: }
4210: return $response;
4211: }
4212:
1.679 raeburn 4213: # ------------------------------------------------------- Course Group routines
4214:
4215: sub get_coursegroups {
1.683 raeburn 4216: my ($cdom,$cnum,$group) = @_;
4217: return(&dump('coursegroups',$cdom,$cnum,$group));
1.679 raeburn 4218: }
4219:
4220: sub modify_coursegroup {
4221: my ($cdom,$cnum,$groupsettings) = @_;
4222: return(&put('coursegroups',$groupsettings,$cdom,$cnum));
4223: }
4224:
4225: sub modify_group_roles {
4226: my ($cdom,$cnum,$group_id,$user,$end,$start,$userprivs) = @_;
4227: my $url = '/'.$cdom.'/'.$cnum.'/'.$group_id;
4228: my $role = 'gr/'.&escape($userprivs);
4229: my ($uname,$udom) = split(/:/,$user);
4230: my $result = &assignrole($udom,$uname,$url,$role,$end,$start);
1.684 raeburn 4231: if ($result eq 'ok') {
4232: &devalidate_getgroups_cache($udom,$uname,$cdom,$cnum);
4233: }
1.679 raeburn 4234: return $result;
4235: }
4236:
4237: sub modify_coursegroup_membership {
4238: my ($cdom,$cnum,$membership) = @_;
4239: my $result = &put('groupmembership',$membership,$cdom,$cnum);
4240: return $result;
4241: }
4242:
1.682 raeburn 4243: sub get_active_groups {
4244: my ($udom,$uname,$cdom,$cnum) = @_;
4245: my $now = time;
4246: my %groups = ();
4247: foreach my $key (keys(%env)) {
4248: if ($key =~ m-user\.role\.gr\./([^/]+)/([^/]+)/(\w+)$-) {
4249: my ($start,$end) = split(/\./,$env{$key});
4250: if (($end!=0) && ($end<$now)) { next; }
4251: if (($start!=0) && ($start>$now)) { next; }
4252: if ($1 eq $cdom && $2 eq $cnum) {
4253: $groups{$3} = $env{$key} ;
4254: }
4255: }
4256: }
4257: return %groups;
4258: }
4259:
1.683 raeburn 4260: sub get_group_membership {
4261: my ($cdom,$cnum,$group) = @_;
4262: return(&dump('groupmembership',$cdom,$cnum,$group));
4263: }
4264:
4265: sub get_users_groups {
4266: my ($udom,$uname,$courseid) = @_;
1.733 raeburn 4267: my @usersgroups;
1.683 raeburn 4268: my $cachetime=1800;
4269: $courseid=~s/\_/\//g;
4270: $courseid=~s/^(\w)/\/$1/;
4271:
4272: my $hashid="$udom:$uname:$courseid";
1.733 raeburn 4273: my ($grouplist,$cached)=&is_cached_new('getgroups',$hashid);
4274: if (defined($cached)) {
1.734 albertel 4275: @usersgroups = split(/:/,$grouplist);
1.733 raeburn 4276: } else {
4277: $grouplist = '';
4278: my %roleshash = &dump('roles',$udom,$uname,$courseid);
4279: my ($tmp) = keys(%roleshash);
4280: if ($tmp=~/^error:/) {
4281: &logthis('Error retrieving roles: '.$tmp.' for '.$uname.':'.$udom);
4282: } else {
4283: my $access_end = $env{'course.'.$courseid.
4284: '.default_enrollment_end_date'};
4285: my $now = time;
1.734 albertel 4286: foreach my $key (keys(%roleshash)) {
1.733 raeburn 4287: if ($key =~ /^\Q$courseid\E\/(\w+)\_gr$/) {
4288: my $group = $1;
4289: if ($roleshash{$key} =~ /_(\d+)_(\d+)$/) {
4290: my $start = $2;
4291: my $end = $1;
4292: if ($start == -1) { next; } # deleted from group
4293: if (($start!=0) && ($start>$now)) { next; }
4294: if (($end!=0) && ($end<$now)) {
4295: if ($access_end && $access_end < $now) {
4296: if ($access_end - $end < 86400) {
4297: push(@usersgroups,$group);
4298: }
4299: }
4300: next;
4301: }
4302: push(@usersgroups,$group);
4303: }
1.683 raeburn 4304: }
4305: }
1.733 raeburn 4306: @usersgroups = &sort_course_groups($courseid,@usersgroups);
4307: $grouplist = join(':',@usersgroups);
4308: &do_cache_new('getgroups',$hashid,$grouplist,$cachetime);
1.683 raeburn 4309: }
4310: }
1.733 raeburn 4311: return @usersgroups;
1.683 raeburn 4312: }
4313:
4314: sub devalidate_getgroups_cache {
4315: my ($udom,$uname,$cdom,$cnum)=@_;
4316: my $courseid = $cdom.'_'.$cnum;
4317: $courseid=~s/\_/\//g;
4318: $courseid=~s/^(\w)/\/$1/;
4319: my $hashid="$udom:$uname:$courseid";
4320: &devalidate_cache_new('getgroups',$hashid);
4321: }
4322:
1.12 www 4323: # ------------------------------------------------------------------ Plain Text
4324:
4325: sub plaintext {
1.742 raeburn 4326: my ($short,$type,$cid) = @_;
1.758 albertel 4327: if ($short =~ /^cr/) {
4328: return (split('/',$short))[-1];
4329: }
1.742 raeburn 4330: if (!defined($cid)) {
4331: $cid = $env{'request.course.id'};
4332: }
4333: if (defined($cid) && defined($env{'course.'.$cid.'.'.$short.'.plaintext'})) {
4334: return &Apache::lonlocal::mt($env{'course.'.$cid.'.'.$short.
4335: '.plaintext'});
4336: }
4337: my %rolenames = (
4338: Course => 'std',
4339: Group => 'alt1',
4340: );
4341: if (defined($type) &&
4342: defined($rolenames{$type}) &&
4343: defined($prp{$short}{$rolenames{$type}})) {
4344: return &Apache::lonlocal::mt($prp{$short}{$rolenames{$type}});
4345: } else {
4346: return &Apache::lonlocal::mt($prp{$short}{'std'});
4347: }
1.12 www 4348: }
4349:
4350: # ----------------------------------------------------------------- Assign Role
4351:
4352: sub assignrole {
1.357 www 4353: my ($udom,$uname,$url,$role,$end,$start,$deleteflag)=@_;
1.21 www 4354: my $mrole;
4355: if ($role =~ /^cr\//) {
1.393 www 4356: my $cwosec=$url;
4357: $cwosec=~s/^\/(\w+)\/(\w+)\/.*/$1\/$2/;
4358: unless (&allowed('ccr',$cwosec)) {
1.104 www 4359: &logthis('Refused custom assignrole: '.
4360: $udom.' '.$uname.' '.$url.' '.$role.' '.$end.' '.$start.' by '.
1.620 albertel 4361: $env{'user.name'}.' at '.$env{'user.domain'});
1.104 www 4362: return 'refused';
4363: }
1.21 www 4364: $mrole='cr';
1.678 raeburn 4365: } elsif ($role =~ /^gr\//) {
4366: my $cwogrp=$url;
4367: $cwogrp=~s/^\/(\w+)\/(\w+)\/.*/$1\/$2/;
4368: unless (&allowed('mdg',$cwogrp)) {
4369: &logthis('Refused group assignrole: '.
4370: $udom.' '.$uname.' '.$url.' '.$role.' '.$end.' '.$start.' by '.
4371: $env{'user.name'}.' at '.$env{'user.domain'});
4372: return 'refused';
4373: }
4374: $mrole='gr';
1.21 www 4375: } else {
1.82 www 4376: my $cwosec=$url;
1.83 www 4377: $cwosec=~s/^\/(\w+)\/(\w+)\/.*/$1\/$2/;
1.373 www 4378: unless ((&allowed('c'.$role,$cwosec)) || &allowed('c'.$role,$udom)) {
1.104 www 4379: &logthis('Refused assignrole: '.
4380: $udom.' '.$uname.' '.$url.' '.$role.' '.$end.' '.$start.' by '.
1.620 albertel 4381: $env{'user.name'}.' at '.$env{'user.domain'});
1.104 www 4382: return 'refused';
4383: }
1.21 www 4384: $mrole=$role;
4385: }
1.620 albertel 4386: my $command="encrypt:rolesput:$env{'user.domain'}:$env{'user.name'}:".
1.21 www 4387: "$udom:$uname:$url".'_'."$mrole=$role";
1.81 www 4388: if ($end) { $command.='_'.$end; }
1.21 www 4389: if ($start) {
4390: if ($end) {
1.81 www 4391: $command.='_'.$start;
1.21 www 4392: } else {
1.81 www 4393: $command.='_0_'.$start;
1.21 www 4394: }
4395: }
1.739 raeburn 4396: my $origstart = $start;
4397: my $origend = $end;
1.357 www 4398: # actually delete
4399: if ($deleteflag) {
1.373 www 4400: if ((&allowed('dro',$udom)) || (&allowed('dro',$url))) {
1.357 www 4401: # modify command to delete the role
1.620 albertel 4402: $command="encrypt:rolesdel:$env{'user.domain'}:$env{'user.name'}:".
1.357 www 4403: "$udom:$uname:$url".'_'."$mrole";
1.620 albertel 4404: &logthis("$env{'user.name'} at $env{'user.domain'} deletes $mrole in $url for $uname at $udom");
1.357 www 4405: # set start and finish to negative values for userrolelog
4406: $start=-1;
4407: $end=-1;
4408: }
4409: }
4410: # send command
1.349 www 4411: my $answer=&reply($command,&homeserver($uname,$udom));
1.357 www 4412: # log new user role if status is ok
1.349 www 4413: if ($answer eq 'ok') {
1.663 raeburn 4414: &userrolelog($role,$uname,$udom,$url,$start,$end);
1.739 raeburn 4415: # for course roles, perform group memberships changes triggered by role change.
4416: unless ($role =~ /^gr/) {
4417: &Apache::longroup::group_changes($udom,$uname,$url,$role,$origend,
4418: $origstart);
4419: }
1.349 www 4420: }
4421: return $answer;
1.169 harris41 4422: }
4423:
4424: # -------------------------------------------------- Modify user authentication
1.197 www 4425: # Overrides without validation
4426:
1.169 harris41 4427: sub modifyuserauth {
4428: my ($udom,$uname,$umode,$upass)=@_;
4429: my $uhome=&homeserver($uname,$udom);
1.197 www 4430: unless (&allowed('mau',$udom)) { return 'refused'; }
4431: &logthis('Call to modify user authentication '.$udom.', '.$uname.', '.
1.620 albertel 4432: $umode.' by '.$env{'user.name'}.' at '.$env{'user.domain'}.
4433: ' in domain '.$env{'request.role.domain'});
1.169 harris41 4434: my $reply=&reply('encrypt:changeuserauth:'.$udom.':'.$uname.':'.$umode.':'.
4435: &escape($upass),$uhome);
1.620 albertel 4436: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},
1.197 www 4437: 'Authentication changed for '.$udom.', '.$uname.', '.$umode.
4438: '(Remote '.$ENV{'REMOTE_ADDR'}.'): '.$reply);
4439: &log($udom,,$uname,$uhome,
1.620 albertel 4440: 'Authentication changed by '.$env{'user.domain'}.', '.
4441: $env{'user.name'}.', '.$umode.
1.197 www 4442: '(Remote '.$ENV{'REMOTE_ADDR'}.'): '.$reply);
1.169 harris41 4443: unless ($reply eq 'ok') {
1.197 www 4444: &logthis('Authentication mode error: '.$reply);
1.169 harris41 4445: return 'error: '.$reply;
4446: }
1.170 harris41 4447: return 'ok';
1.80 www 4448: }
4449:
1.81 www 4450: # --------------------------------------------------------------- Modify a user
1.80 www 4451:
1.81 www 4452: sub modifyuser {
1.206 matthew 4453: my ($udom, $uname, $uid,
4454: $umode, $upass, $first,
4455: $middle, $last, $gene,
1.387 www 4456: $forceid, $desiredhome, $email)=@_;
1.198 www 4457: $udom=~s/\W//g;
4458: $uname=~s/\W//g;
1.81 www 4459: &logthis('Call to modify user '.$udom.', '.$uname.', '.$uid.', '.
1.80 www 4460: $umode.', '.$first.', '.$middle.', '.
1.206 matthew 4461: $last.', '.$gene.'(forceid: '.$forceid.')'.
4462: (defined($desiredhome) ? ' desiredhome = '.$desiredhome :
4463: ' desiredhome not specified').
1.620 albertel 4464: ' by '.$env{'user.name'}.' at '.$env{'user.domain'}.
4465: ' in domain '.$env{'request.role.domain'});
1.230 stredwic 4466: my $uhome=&homeserver($uname,$udom,'true');
1.80 www 4467: # ----------------------------------------------------------------- Create User
1.406 albertel 4468: if (($uhome eq 'no_host') &&
4469: (($umode && $upass) || ($umode eq 'localauth'))) {
1.80 www 4470: my $unhome='';
1.209 matthew 4471: if (defined($desiredhome) && $hostdom{$desiredhome} eq $udom) {
4472: $unhome = $desiredhome;
1.620 albertel 4473: } elsif($env{'course.'.$env{'request.course.id'}.'.domain'} eq $udom) {
4474: $unhome=$env{'course.'.$env{'request.course.id'}.'.home'};
1.209 matthew 4475: } else { # load balancing routine for determining $unhome
1.80 www 4476: my $tryserver;
1.81 www 4477: my $loadm=10000000;
1.80 www 4478: foreach $tryserver (keys %libserv) {
4479: if ($hostdom{$tryserver} eq $udom) {
4480: my $answer=reply('load',$tryserver);
4481: if (($answer=~/\d+/) && ($answer<$loadm)) {
4482: $loadm=$answer;
4483: $unhome=$tryserver;
4484: }
4485: }
4486: }
4487: }
4488: if (($unhome eq '') || ($unhome eq 'no_host')) {
1.206 matthew 4489: return 'error: unable to find a home server for '.$uname.
4490: ' in domain '.$udom;
1.80 www 4491: }
4492: my $reply=&reply('encrypt:makeuser:'.$udom.':'.$uname.':'.$umode.':'.
4493: &escape($upass),$unhome);
4494: unless ($reply eq 'ok') {
4495: return 'error: '.$reply;
4496: }
1.230 stredwic 4497: $uhome=&homeserver($uname,$udom,'true');
1.80 www 4498: if (($uhome eq '') || ($uhome eq 'no_host') || ($uhome ne $unhome)) {
1.386 matthew 4499: return 'error: unable verify users home machine.';
1.80 www 4500: }
1.209 matthew 4501: } # End of creation of new user
1.80 www 4502: # ---------------------------------------------------------------------- Add ID
4503: if ($uid) {
4504: $uid=~tr/A-Z/a-z/;
4505: my %uidhash=&idrget($udom,$uname);
1.196 www 4506: if (($uidhash{$uname}) && ($uidhash{$uname}!~/error\:/)
4507: && (!$forceid)) {
1.80 www 4508: unless ($uid eq $uidhash{$uname}) {
1.386 matthew 4509: return 'error: user id "'.$uid.'" does not match '.
4510: 'current user id "'.$uidhash{$uname}.'".';
1.80 www 4511: }
4512: } else {
4513: &idput($udom,($uname => $uid));
4514: }
4515: }
4516: # -------------------------------------------------------------- Add names, etc
1.313 matthew 4517: my @tmp=&get('environment',
1.134 albertel 4518: ['firstname','middlename','lastname','generation'],
4519: $udom,$uname);
1.313 matthew 4520: my %names;
4521: if ($tmp[0] =~ m/^error:.*/) {
4522: %names=();
4523: } else {
4524: %names = @tmp;
4525: }
1.388 www 4526: #
4527: # Make sure to not trash student environment if instructor does not bother
4528: # to supply name and email information
4529: #
4530: if ($first) { $names{'firstname'} = $first; }
1.385 matthew 4531: if (defined($middle)) { $names{'middlename'} = $middle; }
1.388 www 4532: if ($last) { $names{'lastname'} = $last; }
1.385 matthew 4533: if (defined($gene)) { $names{'generation'} = $gene; }
1.592 www 4534: if ($email) {
4535: $email=~s/[^\w\@\.\-\,]//gs;
4536: if ($email=~/\@/) { $names{'notification'} = $email;
4537: $names{'critnotification'} = $email;
4538: $names{'permanentemail'} = $email; }
4539: }
1.134 albertel 4540: my $reply = &put('environment', \%names, $udom,$uname);
4541: if ($reply ne 'ok') { return 'error: '.$reply; }
1.680 www 4542: &devalidate_cache_new('namescache',$uname.':'.$udom);
1.81 www 4543: &logthis('Success modifying user '.$udom.', '.$uname.', '.$uid.', '.
1.80 www 4544: $umode.', '.$first.', '.$middle.', '.
4545: $last.', '.$gene.' by '.
1.620 albertel 4546: $env{'user.name'}.' at '.$env{'user.domain'});
1.134 albertel 4547: return 'ok';
1.80 www 4548: }
4549:
1.81 www 4550: # -------------------------------------------------------------- Modify student
1.80 www 4551:
1.81 www 4552: sub modifystudent {
4553: my ($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene,$usec,
1.515 raeburn 4554: $end,$start,$forceid,$desiredhome,$email,$type,$locktype,$cid)=@_;
1.455 albertel 4555: if (!$cid) {
1.620 albertel 4556: unless ($cid=$env{'request.course.id'}) {
1.455 albertel 4557: return 'not_in_class';
4558: }
1.80 www 4559: }
4560: # --------------------------------------------------------------- Make the user
1.81 www 4561: my $reply=&modifyuser
1.209 matthew 4562: ($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene,$forceid,
1.387 www 4563: $desiredhome,$email);
1.80 www 4564: unless ($reply eq 'ok') { return $reply; }
1.297 matthew 4565: # This will cause &modify_student_enrollment to get the uid from the
4566: # students environment
4567: $uid = undef if (!$forceid);
1.455 albertel 4568: $reply = &modify_student_enrollment($udom,$uname,$uid,$first,$middle,$last,
1.515 raeburn 4569: $gene,$usec,$end,$start,$type,$locktype,$cid);
1.297 matthew 4570: return $reply;
4571: }
4572:
4573: sub modify_student_enrollment {
1.515 raeburn 4574: my ($udom,$uname,$uid,$first,$middle,$last,$gene,$usec,$end,$start,$type,$locktype,$cid) = @_;
1.455 albertel 4575: my ($cdom,$cnum,$chome);
4576: if (!$cid) {
1.620 albertel 4577: unless ($cid=$env{'request.course.id'}) {
1.455 albertel 4578: return 'not_in_class';
4579: }
1.620 albertel 4580: $cdom=$env{'course.'.$cid.'.domain'};
4581: $cnum=$env{'course.'.$cid.'.num'};
1.455 albertel 4582: } else {
4583: ($cdom,$cnum)=split(/_/,$cid);
4584: }
1.620 albertel 4585: $chome=$env{'course.'.$cid.'.home'};
1.455 albertel 4586: if (!$chome) {
1.457 raeburn 4587: $chome=&homeserver($cnum,$cdom);
1.297 matthew 4588: }
1.455 albertel 4589: if (!$chome) { return 'unknown_course'; }
1.297 matthew 4590: # Make sure the user exists
1.81 www 4591: my $uhome=&homeserver($uname,$udom);
4592: if (($uhome eq '') || ($uhome eq 'no_host')) {
4593: return 'error: no such user';
4594: }
1.297 matthew 4595: # Get student data if we were not given enough information
4596: if (!defined($first) || $first eq '' ||
4597: !defined($last) || $last eq '' ||
4598: !defined($uid) || $uid eq '' ||
4599: !defined($middle) || $middle eq '' ||
4600: !defined($gene) || $gene eq '') {
1.294 matthew 4601: # They did not supply us with enough data to enroll the student, so
4602: # we need to pick up more information.
1.297 matthew 4603: my %tmp = &get('environment',
1.294 matthew 4604: ['firstname','middlename','lastname', 'generation','id']
1.297 matthew 4605: ,$udom,$uname);
4606:
1.455 albertel 4607: #foreach (keys(%tmp)) {
4608: # &logthis("key $_ = ".$tmp{$_});
4609: #}
1.294 matthew 4610: $first = $tmp{'firstname'} if (!defined($first) || $first eq '');
4611: $middle = $tmp{'middlename'} if (!defined($middle) || $middle eq '');
4612: $last = $tmp{'lastname'} if (!defined($last) || $last eq '');
1.297 matthew 4613: $gene = $tmp{'generation'} if (!defined($gene) || $gene eq '');
1.294 matthew 4614: $uid = $tmp{'id'} if (!defined($uid) || $uid eq '');
4615: }
1.556 albertel 4616: my $fullname = &format_name($first,$middle,$last,$gene,'lastname');
1.487 albertel 4617: my $reply=cput('classlist',
4618: {"$uname:$udom" =>
1.515 raeburn 4619: join(':',$end,$start,$uid,$usec,$fullname,$type,$locktype) },
1.487 albertel 4620: $cdom,$cnum);
1.81 www 4621: unless (($reply eq 'ok') || ($reply eq 'delayed')) {
4622: return 'error: '.$reply;
1.652 albertel 4623: } else {
4624: &devalidate_getsection_cache($udom,$uname,$cid);
1.81 www 4625: }
1.297 matthew 4626: # Add student role to user
1.83 www 4627: my $uurl='/'.$cid;
1.81 www 4628: $uurl=~s/\_/\//g;
4629: if ($usec) {
4630: $uurl.='/'.$usec;
4631: }
4632: return &assignrole($udom,$uname,$uurl,'st',$end,$start);
1.21 www 4633: }
4634:
1.556 albertel 4635: sub format_name {
4636: my ($firstname,$middlename,$lastname,$generation,$first)=@_;
4637: my $name;
4638: if ($first ne 'lastname') {
4639: $name=$firstname.' '.$middlename.' '.$lastname.' '.$generation;
4640: } else {
4641: if ($lastname=~/\S/) {
4642: $name.= $lastname.' '.$generation.', '.$firstname.' '.$middlename;
4643: $name=~s/\s+,/,/;
4644: } else {
4645: $name.= $firstname.' '.$middlename.' '.$generation;
4646: }
4647: }
4648: $name=~s/^\s+//;
4649: $name=~s/\s+$//;
4650: $name=~s/\s+/ /g;
4651: return $name;
4652: }
4653:
1.84 www 4654: # ------------------------------------------------- Write to course preferences
4655:
4656: sub writecoursepref {
4657: my ($courseid,%prefs)=@_;
4658: $courseid=~s/^\///;
4659: $courseid=~s/\_/\//g;
4660: my ($cdomain,$cnum)=split(/\//,$courseid);
4661: my $chome=homeserver($cnum,$cdomain);
4662: if (($chome eq '') || ($chome eq 'no_host')) {
4663: return 'error: no such course';
4664: }
4665: my $cstring='';
1.191 harris41 4666: foreach (keys %prefs) {
1.84 www 4667: $cstring.=escape($_).'='.escape($prefs{$_}).'&';
1.191 harris41 4668: }
1.84 www 4669: $cstring=~s/\&$//;
4670: return reply('put:'.$cdomain.':'.$cnum.':environment:'.$cstring,$chome);
4671: }
4672:
4673: # ---------------------------------------------------------- Make/modify course
4674:
4675: sub createcourse {
1.741 raeburn 4676: my ($udom,$description,$url,$course_server,$nonstandard,$inst_code,
4677: $course_owner,$crstype)=@_;
1.84 www 4678: $url=&declutter($url);
4679: my $cid='';
1.264 matthew 4680: unless (&allowed('ccc',$udom)) {
1.84 www 4681: return 'refused';
4682: }
4683: # ------------------------------------------------------------------- Create ID
1.674 www 4684: my $uname=int(1+rand(9)).
4685: ('a'..'z','A'..'Z','0'..'9')[int(rand(62))].
4686: substr($$.time,0,5).unpack("H8",pack("I32",time)).
1.84 www 4687: unpack("H2",pack("I32",int(rand(255)))).$perlvar{'lonHostID'};
4688: # ----------------------------------------------- Make sure that does not exist
1.230 stredwic 4689: my $uhome=&homeserver($uname,$udom,'true');
1.84 www 4690: unless (($uhome eq '') || ($uhome eq 'no_host')) {
4691: $uname=substr($$.time,0,5).unpack("H8",pack("I32",time)).
4692: unpack("H2",pack("I32",int(rand(255)))).$perlvar{'lonHostID'};
1.230 stredwic 4693: $uhome=&homeserver($uname,$udom,'true');
1.84 www 4694: unless (($uhome eq '') || ($uhome eq 'no_host')) {
4695: return 'error: unable to generate unique course-ID';
4696: }
4697: }
1.264 matthew 4698: # ------------------------------------------------ Check supplied server name
1.620 albertel 4699: $course_server = $env{'user.homeserver'} if (! defined($course_server));
1.264 matthew 4700: if (! exists($libserv{$course_server})) {
4701: return 'error:bad server name '.$course_server;
4702: }
1.84 www 4703: # ------------------------------------------------------------- Make the course
4704: my $reply=&reply('encrypt:makeuser:'.$udom.':'.$uname.':none::',
1.264 matthew 4705: $course_server);
1.84 www 4706: unless ($reply eq 'ok') { return 'error: '.$reply; }
1.230 stredwic 4707: $uhome=&homeserver($uname,$udom,'true');
1.84 www 4708: if (($uhome eq '') || ($uhome eq 'no_host')) {
4709: return 'error: no such course';
4710: }
1.271 www 4711: # ----------------------------------------------------------------- Course made
1.516 raeburn 4712: # log existence
4713: &courseidput($udom,&escape($udom.'_'.$uname).'='.&escape($description).
1.741 raeburn 4714: ':'.&escape($inst_code).':'.&escape($course_owner).':'.
4715: &escape($crstype),$uhome);
1.358 www 4716: &flushcourselogs();
4717: # set toplevel url
1.271 www 4718: my $topurl=$url;
4719: unless ($nonstandard) {
4720: # ------------------------------------------ For standard courses, make top url
4721: my $mapurl=&clutter($url);
1.278 www 4722: if ($mapurl eq '/res/') { $mapurl=''; }
1.620 albertel 4723: $env{'form.initmap'}=(<<ENDINITMAP);
1.271 www 4724: <map>
4725: <resource id="1" type="start"></resource>
4726: <resource id="2" src="$mapurl"></resource>
4727: <resource id="3" type="finish"></resource>
4728: <link index="1" from="1" to="2"></link>
4729: <link index="2" from="2" to="3"></link>
4730: </map>
4731: ENDINITMAP
4732: $topurl=&declutter(
1.638 albertel 4733: &finishuserfileupload($uname,$udom,'initmap','default.sequence')
1.271 www 4734: );
4735: }
4736: # ----------------------------------------------------------- Write preferences
1.84 www 4737: &writecoursepref($udom.'_'.$uname,
4738: ('description' => $description,
1.271 www 4739: 'url' => $topurl));
1.84 www 4740: return '/'.$udom.'/'.$uname;
4741: }
4742:
1.21 www 4743: # ---------------------------------------------------------- Assign Custom Role
4744:
4745: sub assigncustomrole {
1.357 www 4746: my ($udom,$uname,$url,$rdom,$rnam,$rolename,$end,$start,$deleteflag)=@_;
1.21 www 4747: return &assignrole($udom,$uname,$url,'cr/'.$rdom.'/'.$rnam.'/'.$rolename,
1.357 www 4748: $end,$start,$deleteflag);
1.21 www 4749: }
4750:
4751: # ----------------------------------------------------------------- Revoke Role
4752:
4753: sub revokerole {
1.357 www 4754: my ($udom,$uname,$url,$role,$deleteflag)=@_;
1.21 www 4755: my $now=time;
1.357 www 4756: return &assignrole($udom,$uname,$url,$role,$now,$deleteflag);
1.21 www 4757: }
4758:
4759: # ---------------------------------------------------------- Revoke Custom Role
4760:
4761: sub revokecustomrole {
1.357 www 4762: my ($udom,$uname,$url,$rdom,$rnam,$rolename,$deleteflag)=@_;
1.21 www 4763: my $now=time;
1.357 www 4764: return &assigncustomrole($udom,$uname,$url,$rdom,$rnam,$rolename,$now,
4765: $deleteflag);
1.17 www 4766: }
4767:
1.533 banghart 4768: # ------------------------------------------------------------ Disk usage
1.535 albertel 4769: sub diskusage {
1.533 banghart 4770: my ($udom,$uname,$directoryRoot)=@_;
4771: $directoryRoot =~ s/\/$//;
1.535 albertel 4772: my $listing=&reply('du:'.$directoryRoot,homeserver($uname,$udom));
1.514 albertel 4773: return $listing;
1.512 banghart 4774: }
4775:
1.566 banghart 4776: sub is_locked {
4777: my ($file_name, $domain, $user) = @_;
4778: my @check;
4779: my $is_locked;
4780: push @check, $file_name;
1.613 albertel 4781: my %locked = &get('file_permissions',\@check,
1.620 albertel 4782: $env{'user.domain'},$env{'user.name'});
1.615 albertel 4783: my ($tmp)=keys(%locked);
4784: if ($tmp=~/^error:/) { undef(%locked); }
1.745 raeburn 4785:
1.566 banghart 4786: if (ref($locked{$file_name}) eq 'ARRAY') {
1.745 raeburn 4787: $is_locked = 'false';
4788: foreach my $entry (@{$locked{$file_name}}) {
4789: if (ref($entry) eq 'ARRAY') {
1.746 raeburn 4790: $is_locked = 'true';
4791: last;
1.745 raeburn 4792: }
4793: }
1.566 banghart 4794: } else {
4795: $is_locked = 'false';
4796: }
4797: }
4798:
1.759 albertel 4799: sub declutter_portfile {
4800: my ($file) = @_;
4801: &logthis("got $file");
4802: $file =~ s-^(/portfolio/|portfolio/)-/-;
4803: &logthis("ret $file");
4804: return $file;
4805: }
4806:
1.559 banghart 4807: # ------------------------------------------------------------- Mark as Read Only
4808:
4809: sub mark_as_readonly {
4810: my ($domain,$user,$files,$what) = @_;
1.613 albertel 4811: my %current_permissions = &dump('file_permissions',$domain,$user);
1.615 albertel 4812: my ($tmp)=keys(%current_permissions);
4813: if ($tmp=~/^error:/) { undef(%current_permissions); }
1.560 banghart 4814: foreach my $file (@{$files}) {
1.759 albertel 4815: $file = &declutter_portfile($file);
1.561 banghart 4816: push(@{$current_permissions{$file}},$what);
1.559 banghart 4817: }
1.613 albertel 4818: &put('file_permissions',\%current_permissions,$domain,$user);
1.559 banghart 4819: return;
4820: }
4821:
1.572 banghart 4822: # ------------------------------------------------------------Save Selected Files
4823:
4824: sub save_selected_files {
4825: my ($user, $path, @files) = @_;
4826: my $filename = $user."savedfiles";
1.573 banghart 4827: my @other_files = &files_not_in_path($user, $path);
1.574 banghart 4828: open (OUT, '>'.$Apache::lonnet::perlvar{'lonDaemons'}.'/tmp/'.$filename);
1.573 banghart 4829: foreach my $file (@files) {
1.620 albertel 4830: print (OUT $env{'form.currentpath'}.$file."\n");
1.573 banghart 4831: }
4832: foreach my $file (@other_files) {
1.574 banghart 4833: print (OUT $file."\n");
1.572 banghart 4834: }
1.574 banghart 4835: close (OUT);
1.572 banghart 4836: return 'ok';
4837: }
4838:
1.574 banghart 4839: sub clear_selected_files {
4840: my ($user) = @_;
4841: my $filename = $user."savedfiles";
4842: open (OUT, '>'.$Apache::lonnet::perlvar{'lonDaemons'}.'/tmp/'.$filename);
4843: print (OUT undef);
4844: close (OUT);
4845: return ("ok");
4846: }
4847:
1.572 banghart 4848: sub files_in_path {
4849: my ($user, $path) = @_;
4850: my $filename = $user."savedfiles";
4851: my %return_files;
1.574 banghart 4852: open (IN, '<'.$Apache::lonnet::perlvar{'lonDaemons'}.'/tmp/'.$filename);
1.573 banghart 4853: while (my $line_in = <IN>) {
1.574 banghart 4854: chomp ($line_in);
4855: my @paths_and_file = split (m!/!, $line_in);
4856: my $file_part = pop (@paths_and_file);
4857: my $path_part = join ('/', @paths_and_file);
1.573 banghart 4858: $path_part.='/';
4859: my $path_and_file = $path_part.$file_part;
4860: if ($path_part eq $path) {
4861: $return_files{$file_part}= 'selected';
4862: }
4863: }
1.574 banghart 4864: close (IN);
4865: return (\%return_files);
1.572 banghart 4866: }
4867:
4868: # called in portfolio select mode, to show files selected NOT in current directory
4869: sub files_not_in_path {
4870: my ($user, $path) = @_;
4871: my $filename = $user."savedfiles";
4872: my @return_files;
4873: my $path_part;
1.574 banghart 4874: open (IN, '<'.$Apache::lonnet::perlvar{'lonDaemons'}.'/tmp/'.$filename);
1.572 banghart 4875: while (<IN>) {
4876: #ok, I know it's clunky, but I want it to work
4877: my @paths_and_file = split m!/!, $_;
1.574 banghart 4878: my $file_part = pop (@paths_and_file);
4879: chomp ($file_part);
4880: my $path_part = join ('/', @paths_and_file);
1.572 banghart 4881: $path_part .= '/';
4882: my $path_and_file = $path_part.$file_part;
4883: if ($path_part ne $path) {
1.574 banghart 4884: push (@return_files, ($path_and_file));
1.572 banghart 4885: }
4886: }
1.574 banghart 4887: close (OUT);
4888: return (@return_files);
1.572 banghart 4889: }
4890:
1.745 raeburn 4891: #----------------------------------------------Get portfolio file permissions
1.629 banghart 4892:
1.745 raeburn 4893: sub get_portfile_permissions {
4894: my ($domain,$user) = @_;
1.613 albertel 4895: my %current_permissions = &dump('file_permissions',$domain,$user);
1.615 albertel 4896: my ($tmp)=keys(%current_permissions);
4897: if ($tmp=~/^error:/) { undef(%current_permissions); }
1.745 raeburn 4898: return \%current_permissions;
4899: }
4900:
4901: #---------------------------------------------Get portfolio file access controls
4902:
1.749 raeburn 4903: sub get_access_controls {
1.745 raeburn 4904: my ($current_permissions,$group,$file) = @_;
4905: my %access;
4906: if (defined($file)) {
1.749 raeburn 4907: if (ref($$current_permissions{$file."\0".'accesscontrol'}) eq 'HASH') {
4908: foreach my $control (keys(%{$$current_permissions{$file."\0".'accesscontrol'}})) {
4909: $access{$file}{$control} = $$current_permissions{$file."\0".$control};
4910: }
4911: }
1.745 raeburn 4912: } else {
1.749 raeburn 4913: foreach my $key (keys(%{$current_permissions})) {
4914: if ($key =~ /\0accesscontrol$/) {
4915: if (defined($group)) {
4916: if ($key !~ m-^\Q$group\E/-) {
4917: next;
4918: }
4919: }
4920: my ($fullpath) = split(/\0/,$key);
4921: if (ref($$current_permissions{$key}) eq 'HASH') {
4922: foreach my $control (keys(%{$$current_permissions{$key}})) {
4923: $access{$fullpath}{$control}=$$current_permissions{$fullpath."\0".$control};
4924: }
4925: }
4926: }
4927: }
4928: }
4929: return %access;
4930: }
4931:
4932: sub modify_access_controls {
4933: my ($file_name,$changes,$domain,$user)=@_;
4934: my ($outcome,$deloutcome);
4935: my %store_permissions;
4936: my %new_values;
4937: my %new_control;
4938: my %translation;
4939: my @deletions = ();
4940: my $now = time;
4941: if (exists($$changes{'activate'})) {
4942: if (ref($$changes{'activate'}) eq 'HASH') {
4943: my @newitems = sort(keys(%{$$changes{'activate'}}));
4944: my $numnew = scalar(@newitems);
4945: for (my $i=0; $i<$numnew; $i++) {
4946: my $newkey = $newitems[$i];
4947: my $newid = &Apache::loncommon::get_cgi_id();
4948: $newkey =~ s/^(\d+)/$newid/;
4949: $translation{$1} = $newid;
4950: $new_values{$file_name."\0".$newkey} =
4951: $$changes{'activate'}{$newitems[$i]};
4952: $new_control{$newkey} = $now;
4953: }
4954: }
4955: }
4956: my %todelete;
4957: my %changed_items;
4958: foreach my $action ('delete','update') {
4959: if (exists($$changes{$action})) {
4960: if (ref($$changes{$action}) eq 'HASH') {
4961: foreach my $key (keys(%{$$changes{$action}})) {
4962: my ($itemnum) = ($key =~ /^([^:]+):/);
4963: if ($action eq 'delete') {
4964: $todelete{$itemnum} = 1;
4965: } else {
4966: $changed_items{$itemnum} = $key;
4967: }
4968: }
1.745 raeburn 4969: }
4970: }
1.749 raeburn 4971: }
4972: # get lock on access controls for file.
4973: my $lockhash = {
4974: $file_name."\0".'locked_access_records' => $env{'user.name'}.
4975: ':'.$env{'user.domain'},
4976: };
4977: my $tries = 0;
4978: my $gotlock = &newput('file_permissions',$lockhash,$domain,$user);
4979:
4980: while (($gotlock ne 'ok') && $tries <3) {
4981: $tries ++;
4982: sleep 1;
4983: $gotlock = &newput('file_permissions',$lockhash,$domain,$user);
4984: }
4985: if ($gotlock eq 'ok') {
4986: my %curr_permissions = &dump('file_permissions',$domain,$user,$file_name);
4987: my ($tmp)=keys(%curr_permissions);
4988: if ($tmp=~/^error:/) { undef(%curr_permissions); }
4989: if (exists($curr_permissions{$file_name."\0".'accesscontrol'})) {
4990: my $curr_controls = $curr_permissions{$file_name."\0".'accesscontrol'};
4991: if (ref($curr_controls) eq 'HASH') {
4992: foreach my $control_item (keys(%{$curr_controls})) {
4993: my ($itemnum) = ($control_item =~ /^([^:]+):/);
4994: if (defined($todelete{$itemnum})) {
4995: push(@deletions,$file_name."\0".$control_item);
4996: } else {
4997: if (defined($changed_items{$itemnum})) {
4998: $new_control{$changed_items{$itemnum}} = $now;
4999: push(@deletions,$file_name."\0".$control_item);
5000: $new_values{$file_name."\0".$changed_items{$itemnum}} = $$changes{'update'}{$changed_items{$itemnum}};
5001: } else {
5002: $new_control{$control_item} = $$curr_controls{$control_item};
5003: }
5004: }
1.745 raeburn 5005: }
5006: }
5007: }
1.749 raeburn 5008: $deloutcome = &del('file_permissions',\@deletions,$domain,$user);
5009: $new_values{$file_name."\0".'accesscontrol'} = \%new_control;
5010: $outcome = &put('file_permissions',\%new_values,$domain,$user);
5011: # remove lock
5012: my @del_lock = ($file_name."\0".'locked_access_records');
5013: my $dellockoutcome = &del('file_permissions',\@del_lock,$domain,$user);
5014: } else {
5015: $outcome = "error: could not obtain lockfile\n";
1.745 raeburn 5016: }
1.749 raeburn 5017: return ($outcome,$deloutcome,\%new_values,\%translation);
1.745 raeburn 5018: }
5019:
5020: #------------------------------------------------------Get Marked as Read Only
5021:
5022: sub get_marked_as_readonly {
5023: my ($domain,$user,$what,$group) = @_;
5024: my $current_permissions = &get_portfile_permissions($domain,$user);
1.563 banghart 5025: my @readonly_files;
1.629 banghart 5026: my $cmp1=$what;
5027: if (ref($what)) { $cmp1=join('',@{$what}) };
1.745 raeburn 5028: while (my ($file_name,$value) = each(%{$current_permissions})) {
5029: if (defined($group)) {
5030: if ($file_name !~ m-^\Q$group\E/-) {
5031: next;
5032: }
5033: }
1.561 banghart 5034: if (ref($value) eq "ARRAY"){
5035: foreach my $stored_what (@{$value}) {
1.629 banghart 5036: my $cmp2=$stored_what;
1.759 albertel 5037: if (ref($stored_what) eq 'ARRAY') {
1.746 raeburn 5038: $cmp2=join('',@{$stored_what});
1.745 raeburn 5039: }
1.629 banghart 5040: if ($cmp1 eq $cmp2) {
1.561 banghart 5041: push(@readonly_files, $file_name);
1.745 raeburn 5042: last;
1.563 banghart 5043: } elsif (!defined($what)) {
5044: push(@readonly_files, $file_name);
1.745 raeburn 5045: last;
1.561 banghart 5046: }
5047: }
1.745 raeburn 5048: }
1.561 banghart 5049: }
5050: return @readonly_files;
5051: }
1.577 banghart 5052: #-----------------------------------------------------------Get Marked as Read Only Hash
1.561 banghart 5053:
1.577 banghart 5054: sub get_marked_as_readonly_hash {
1.745 raeburn 5055: my ($current_permissions,$group,$what) = @_;
1.577 banghart 5056: my %readonly_files;
1.745 raeburn 5057: while (my ($file_name,$value) = each(%{$current_permissions})) {
5058: if (defined($group)) {
5059: if ($file_name !~ m-^\Q$group\E/-) {
5060: next;
5061: }
5062: }
1.577 banghart 5063: if (ref($value) eq "ARRAY"){
5064: foreach my $stored_what (@{$value}) {
1.745 raeburn 5065: if (ref($stored_what) eq 'ARRAY') {
1.750 banghart 5066: foreach my $lock_descriptor(@{$stored_what}) {
5067: if ($lock_descriptor eq 'graded') {
5068: $readonly_files{$file_name} = 'graded';
5069: } elsif ($lock_descriptor eq 'handback') {
5070: $readonly_files{$file_name} = 'handback';
5071: } else {
5072: if (!exists($readonly_files{$file_name})) {
5073: $readonly_files{$file_name} = 'locked';
5074: }
5075: }
1.745 raeburn 5076: }
1.750 banghart 5077: }
1.577 banghart 5078: }
5079: }
5080: }
5081: return %readonly_files;
5082: }
1.559 banghart 5083: # ------------------------------------------------------------ Unmark as Read Only
5084:
5085: sub unmark_as_readonly {
1.629 banghart 5086: # unmarks $file_name (if $file_name is defined), or all files locked by $what
5087: # for portfolio submissions, $what contains [$symb,$crsid]
1.745 raeburn 5088: my ($domain,$user,$what,$file_name,$group) = @_;
1.759 albertel 5089: $file_name = &declutter_portfile($file_name);
1.634 albertel 5090: my $symb_crs = $what;
5091: if (ref($what)) { $symb_crs=join('',@$what); }
1.745 raeburn 5092: my %current_permissions = &dump('file_permissions',$domain,$user,$group);
1.615 albertel 5093: my ($tmp)=keys(%current_permissions);
5094: if ($tmp=~/^error:/) { undef(%current_permissions); }
1.745 raeburn 5095: my @readonly_files = &get_marked_as_readonly($domain,$user,$what,$group);
1.650 albertel 5096: foreach my $file (@readonly_files) {
1.759 albertel 5097: my $clean_file = &declutter_portfile($file);
5098: if (defined($file_name) && ($file_name ne $clean_file)) { next; }
1.650 albertel 5099: my $current_locks = $current_permissions{$file};
1.563 banghart 5100: my @new_locks;
5101: my @del_keys;
5102: if (ref($current_locks) eq "ARRAY"){
5103: foreach my $locker (@{$current_locks}) {
1.632 albertel 5104: my $compare=$locker;
1.749 raeburn 5105: if (ref($locker) eq 'ARRAY') {
1.745 raeburn 5106: $compare=join('',@{$locker});
1.746 raeburn 5107: if ($compare ne $symb_crs) {
5108: push(@new_locks, $locker);
5109: }
1.563 banghart 5110: }
5111: }
1.650 albertel 5112: if (scalar(@new_locks) > 0) {
1.563 banghart 5113: $current_permissions{$file} = \@new_locks;
5114: } else {
5115: push(@del_keys, $file);
1.613 albertel 5116: &del('file_permissions',\@del_keys, $domain, $user);
1.650 albertel 5117: delete($current_permissions{$file});
1.563 banghart 5118: }
5119: }
1.561 banghart 5120: }
1.613 albertel 5121: &put('file_permissions',\%current_permissions,$domain,$user);
1.559 banghart 5122: return;
5123: }
1.512 banghart 5124:
1.17 www 5125: # ------------------------------------------------------------ Directory lister
5126:
5127: sub dirlist {
1.253 stredwic 5128: my ($uri,$userdomain,$username,$alternateDirectoryRoot)=@_;
5129:
1.18 www 5130: $uri=~s/^\///;
5131: $uri=~s/\/$//;
1.253 stredwic 5132: my ($udom, $uname);
5133: (undef,$udom,$uname)=split(/\//,$uri);
5134: if(defined($userdomain)) {
5135: $udom = $userdomain;
5136: }
5137: if(defined($username)) {
5138: $uname = $username;
5139: }
5140:
5141: my $dirRoot = $perlvar{'lonDocRoot'};
5142: if(defined($alternateDirectoryRoot)) {
5143: $dirRoot = $alternateDirectoryRoot;
5144: $dirRoot =~ s/\/$//;
1.751 banghart 5145: }
1.253 stredwic 5146:
5147: if($udom) {
5148: if($uname) {
1.605 matthew 5149: my $listing=reply('ls2:'.$dirRoot.'/'.$uri,
1.253 stredwic 5150: homeserver($uname,$udom));
1.605 matthew 5151: my @listing_results;
5152: if ($listing eq 'unknown_cmd') {
5153: $listing=reply('ls:'.$dirRoot.'/'.$uri,
5154: homeserver($uname,$udom));
5155: @listing_results = split(/:/,$listing);
5156: } else {
5157: @listing_results = map { &unescape($_); } split(/:/,$listing);
5158: }
5159: return @listing_results;
1.253 stredwic 5160: } elsif(!defined($alternateDirectoryRoot)) {
5161: my $tryserver;
5162: my %allusers=();
5163: foreach $tryserver (keys %libserv) {
5164: if($hostdom{$tryserver} eq $udom) {
1.605 matthew 5165: my $listing=reply('ls2:'.$perlvar{'lonDocRoot'}.'/res/'.
1.253 stredwic 5166: $udom, $tryserver);
1.605 matthew 5167: my @listing_results;
5168: if ($listing eq 'unknown_cmd') {
5169: $listing=reply('ls:'.$perlvar{'lonDocRoot'}.'/res/'.
5170: $udom, $tryserver);
5171: @listing_results = split(/:/,$listing);
5172: } else {
5173: @listing_results =
5174: map { &unescape($_); } split(/:/,$listing);
5175: }
5176: if ($listing_results[0] ne 'no_such_dir' &&
5177: $listing_results[0] ne 'empty' &&
5178: $listing_results[0] ne 'con_lost') {
5179: foreach (@listing_results) {
1.253 stredwic 5180: my ($entry,@stat)=split(/&/,$_);
5181: $allusers{$entry}=1;
5182: }
5183: }
1.191 harris41 5184: }
1.253 stredwic 5185: }
5186: my $alluserstr='';
5187: foreach (sort keys %allusers) {
5188: $alluserstr.=$_.'&user:';
5189: }
5190: $alluserstr=~s/:$//;
5191: return split(/:/,$alluserstr);
5192: } else {
5193: my @emptyResults = ();
5194: push(@emptyResults, 'missing user name');
5195: return split(':',@emptyResults);
5196: }
5197: } elsif(!defined($alternateDirectoryRoot)) {
5198: my $tryserver;
5199: my %alldom=();
5200: foreach $tryserver (keys %libserv) {
5201: $alldom{$hostdom{$tryserver}}=1;
5202: }
5203: my $alldomstr='';
5204: foreach (sort keys %alldom) {
1.397 albertel 5205: $alldomstr.=$perlvar{'lonDocRoot'}.'/res/'.$_.'/&domain:';
1.253 stredwic 5206: }
5207: $alldomstr=~s/:$//;
5208: return split(/:/,$alldomstr);
5209: } else {
5210: my @emptyResults = ();
5211: push(@emptyResults, 'missing domain');
5212: return split(':',@emptyResults);
1.275 stredwic 5213: }
5214: }
5215:
5216: # --------------------------------------------- GetFileTimestamp
5217: # This function utilizes dirlist and returns the date stamp for
5218: # when it was last modified. It will also return an error of -1
5219: # if an error occurs
5220:
1.410 matthew 5221: ##
5222: ## FIXME: This subroutine assumes its caller knows something about the
5223: ## directory structure of the home server for the student ($root).
5224: ## Not a good assumption to make. Since this is for looking up files
5225: ## in user directories, the full path should be constructed by lond, not
5226: ## whatever machine we request data from.
5227: ##
1.275 stredwic 5228: sub GetFileTimestamp {
5229: my ($studentDomain,$studentName,$filename,$root)=@_;
5230: $studentDomain=~s/\W//g;
5231: $studentName=~s/\W//g;
5232: my $subdir=$studentName.'__';
5233: $subdir =~ s/(.)(.)(.).*/$1\/$2\/$3/;
5234: my $proname="$studentDomain/$subdir/$studentName";
5235: $proname .= '/'.$filename;
1.375 matthew 5236: my ($fileStat) = &Apache::lonnet::dirlist($proname, $studentDomain,
5237: $studentName, $root);
1.275 stredwic 5238: my @stats = split('&', $fileStat);
5239: if($stats[0] ne 'empty' && $stats[0] ne 'no_such_dir') {
1.375 matthew 5240: # @stats contains first the filename, then the stat output
5241: return $stats[10]; # so this is 10 instead of 9.
1.275 stredwic 5242: } else {
5243: return -1;
1.253 stredwic 5244: }
1.26 www 5245: }
5246:
1.712 albertel 5247: sub stat_file {
5248: my ($uri) = @_;
1.722 albertel 5249: $uri = &clutter($uri);
5250:
5251: # we want just the url part without the unneeded accessor url bits
1.723 banghart 5252: if ($uri =~ m-^/adm/-) {
5253: $uri=~s-^/adm/wrapper/-/-;
5254: $uri=~s-^/adm/coursedocs/showdoc/-/-;
1.722 albertel 5255: }
1.712 albertel 5256: my ($udom,$uname,$file,$dir);
5257: if ($uri =~ m-^/(uploaded|editupload)/-) {
5258: ($udom,$uname,$file) =
5259: ($uri =~ m-/(?:uploaded|editupload)/?([^/]*)/?([^/]*)/?(.*)-);
5260: $file = 'userfiles/'.$file;
1.740 www 5261: $dir = &propath($udom,$uname);
1.712 albertel 5262: }
5263: if ($uri =~ m-^/res/-) {
5264: ($udom,$uname) =
5265: ($uri =~ m-/(?:res)/?([^/]*)/?([^/]*)/-);
5266: $file = $uri;
5267: }
5268:
5269: if (!$udom || !$uname || !$file) {
5270: # unable to handle the uri
5271: return ();
5272: }
5273:
5274: my ($result) = &dirlist($file,$udom,$uname,$dir);
5275: my @stats = split('&', $result);
1.721 banghart 5276:
1.712 albertel 5277: if($stats[0] ne 'empty' && $stats[0] ne 'no_such_dir') {
5278: shift(@stats); #filename is first
5279: return @stats;
5280: }
5281: return ();
5282: }
5283:
1.26 www 5284: # -------------------------------------------------------- Value of a Condition
5285:
1.713 albertel 5286: # gets the value of a specific preevaluated condition
5287: # stored in the string $env{user.state.<cid>}
5288: # or looks up a condition reference in the bighash and if if hasn't
5289: # already been evaluated recurses into docondval to get the value of
5290: # the condition, then memoizing it to
5291: # $env{user.state.<cid>.<condition>}
1.40 www 5292: sub directcondval {
5293: my $number=shift;
1.620 albertel 5294: if (!defined($env{'user.state.'.$env{'request.course.id'}})) {
1.555 albertel 5295: &Apache::lonuserstate::evalstate();
5296: }
1.713 albertel 5297: if (exists($env{'user.state.'.$env{'request.course.id'}.".$number"})) {
5298: return $env{'user.state.'.$env{'request.course.id'}.".$number"};
5299: } elsif ($number =~ /^_/) {
5300: my $sub_condition;
5301: if (tie(my %bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
5302: &GDBM_READER(),0640)) {
5303: $sub_condition=$bighash{'conditions'.$number};
5304: untie(%bighash);
5305: }
5306: my $value = &docondval($sub_condition);
5307: &appenv('user.state.'.$env{'request.course.id'}.".$number" => $value);
5308: return $value;
5309: }
1.620 albertel 5310: if ($env{'user.state.'.$env{'request.course.id'}}) {
5311: return substr($env{'user.state.'.$env{'request.course.id'}},$number,1);
1.40 www 5312: } else {
5313: return 2;
5314: }
5315: }
5316:
1.713 albertel 5317: # get the collection of conditions for this resource
1.26 www 5318: sub condval {
5319: my $condidx=shift;
1.54 www 5320: my $allpathcond='';
1.713 albertel 5321: foreach my $cond (split(/\|/,$condidx)) {
5322: if (defined($env{'acc.cond.'.$env{'request.course.id'}.'.'.$cond})) {
5323: $allpathcond.=
5324: '('.$env{'acc.cond.'.$env{'request.course.id'}.'.'.$cond}.')|';
5325: }
1.191 harris41 5326: }
1.54 www 5327: $allpathcond=~s/\|$//;
1.713 albertel 5328: return &docondval($allpathcond);
5329: }
5330:
5331: #evaluates an expression of conditions
5332: sub docondval {
5333: my ($allpathcond) = @_;
5334: my $result=0;
5335: if ($env{'request.course.id'}
5336: && defined($allpathcond)) {
5337: my $operand='|';
5338: my @stack;
5339: foreach my $chunk ($allpathcond=~/(\d+|_\d+\.\d+|\(|\)|\&|\|)/g) {
5340: if ($chunk eq '(') {
5341: push @stack,($operand,$result);
5342: } elsif ($chunk eq ')') {
5343: my $before=pop @stack;
5344: if (pop @stack eq '&') {
5345: $result=$result>$before?$before:$result;
5346: } else {
5347: $result=$result>$before?$result:$before;
5348: }
5349: } elsif (($chunk eq '&') || ($chunk eq '|')) {
5350: $operand=$chunk;
5351: } else {
5352: my $new=directcondval($chunk);
5353: if ($operand eq '&') {
5354: $result=$result>$new?$new:$result;
5355: } else {
5356: $result=$result>$new?$result:$new;
5357: }
5358: }
5359: }
1.26 www 5360: }
5361: return $result;
1.421 albertel 5362: }
5363:
5364: # ---------------------------------------------------- Devalidate courseresdata
5365:
5366: sub devalidatecourseresdata {
5367: my ($coursenum,$coursedomain)=@_;
5368: my $hashid=$coursenum.':'.$coursedomain;
1.599 albertel 5369: &devalidate_cache_new('courseres',$hashid);
1.28 www 5370: }
5371:
1.763 www 5372:
1.200 www 5373: # --------------------------------------------------- Course Resourcedata Query
5374:
1.624 albertel 5375: sub get_courseresdata {
5376: my ($coursenum,$coursedomain)=@_;
1.200 www 5377: my $coursehom=&homeserver($coursenum,$coursedomain);
5378: my $hashid=$coursenum.':'.$coursedomain;
1.599 albertel 5379: my ($result,$cached)=&is_cached_new('courseres',$hashid);
1.624 albertel 5380: my %dumpreply;
1.417 albertel 5381: unless (defined($cached)) {
1.624 albertel 5382: %dumpreply=&dump('resourcedata',$coursedomain,$coursenum);
1.417 albertel 5383: $result=\%dumpreply;
1.251 albertel 5384: my ($tmp) = keys(%dumpreply);
5385: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
1.599 albertel 5386: &do_cache_new('courseres',$hashid,$result,600);
1.306 albertel 5387: } elsif ($tmp =~ /^(con_lost|no_such_host)/) {
5388: return $tmp;
1.416 albertel 5389: } elsif ($tmp =~ /^(error)/) {
1.417 albertel 5390: $result=undef;
1.599 albertel 5391: &do_cache_new('courseres',$hashid,$result,600);
1.250 albertel 5392: }
5393: }
1.624 albertel 5394: return $result;
5395: }
5396:
1.633 albertel 5397: sub devalidateuserresdata {
5398: my ($uname,$udom)=@_;
5399: my $hashid="$udom:$uname";
5400: &devalidate_cache_new('userres',$hashid);
5401: }
5402:
1.624 albertel 5403: sub get_userresdata {
5404: my ($uname,$udom)=@_;
5405: #most student don\'t have any data set, check if there is some data
5406: if (&EXT_cache_status($udom,$uname)) { return undef; }
5407:
5408: my $hashid="$udom:$uname";
5409: my ($result,$cached)=&is_cached_new('userres',$hashid);
5410: if (!defined($cached)) {
5411: my %resourcedata=&dump('resourcedata',$udom,$uname);
5412: $result=\%resourcedata;
5413: &do_cache_new('userres',$hashid,$result,600);
5414: }
5415: my ($tmp)=keys(%$result);
5416: if (($tmp!~/^error\:/) && ($tmp!~/^con_lost/)) {
5417: return $result;
5418: }
5419: #error 2 occurs when the .db doesn't exist
5420: if ($tmp!~/error: 2 /) {
1.672 albertel 5421: &logthis("<font color=\"blue\">WARNING:".
1.624 albertel 5422: " Trying to get resource data for ".
5423: $uname." at ".$udom.": ".
5424: $tmp."</font>");
5425: } elsif ($tmp=~/error: 2 /) {
1.633 albertel 5426: #&EXT_cache_set($udom,$uname);
5427: &do_cache_new('userres',$hashid,undef,600);
1.636 albertel 5428: undef($tmp); # not really an error so don't send it back
1.624 albertel 5429: }
5430: return $tmp;
5431: }
5432:
5433: sub resdata {
5434: my ($name,$domain,$type,@which)=@_;
5435: my $result;
5436: if ($type eq 'course') {
5437: $result=&get_courseresdata($name,$domain);
5438: } elsif ($type eq 'user') {
5439: $result=&get_userresdata($name,$domain);
5440: }
5441: if (!ref($result)) { return $result; }
1.251 albertel 5442: foreach my $item (@which) {
1.417 albertel 5443: if (defined($result->{$item})) {
5444: return $result->{$item};
1.251 albertel 5445: }
1.250 albertel 5446: }
1.291 albertel 5447: return undef;
1.200 www 5448: }
5449:
1.379 matthew 5450: #
5451: # EXT resource caching routines
5452: #
5453:
5454: sub clear_EXT_cache_status {
1.383 albertel 5455: &delenv('cache.EXT.');
1.379 matthew 5456: }
5457:
5458: sub EXT_cache_status {
5459: my ($target_domain,$target_user) = @_;
1.383 albertel 5460: my $cachename = 'cache.EXT.'.$target_user.'.'.$target_domain;
1.620 albertel 5461: if (exists($env{$cachename}) && ($env{$cachename}+600) > time) {
1.379 matthew 5462: # We know already the user has no data
5463: return 1;
5464: } else {
5465: return 0;
5466: }
5467: }
5468:
5469: sub EXT_cache_set {
5470: my ($target_domain,$target_user) = @_;
1.383 albertel 5471: my $cachename = 'cache.EXT.'.$target_user.'.'.$target_domain;
1.633 albertel 5472: #&appenv($cachename => time);
1.379 matthew 5473: }
5474:
1.28 www 5475: # --------------------------------------------------------- Value of a Variable
1.58 www 5476: sub EXT {
1.715 albertel 5477:
1.395 albertel 5478: my ($varname,$symbparm,$udom,$uname,$usection,$recurse)=@_;
1.68 www 5479: unless ($varname) { return ''; }
1.218 albertel 5480: #get real user name/domain, courseid and symb
5481: my $courseid;
1.359 albertel 5482: my $publicuser;
1.427 www 5483: if ($symbparm) {
5484: $symbparm=&get_symb_from_alias($symbparm);
5485: }
1.218 albertel 5486: if (!($uname && $udom)) {
1.360 albertel 5487: (my $cursymb,$courseid,$udom,$uname,$publicuser)=
1.378 matthew 5488: &Apache::lonxml::whichuser($symbparm);
1.218 albertel 5489: if (!$symbparm) { $symbparm=$cursymb; }
5490: } else {
1.620 albertel 5491: $courseid=$env{'request.course.id'};
1.218 albertel 5492: }
1.48 www 5493: my ($realm,$space,$qualifier,@therest)=split(/\./,$varname);
5494: my $rest;
1.320 albertel 5495: if (defined($therest[0])) {
1.48 www 5496: $rest=join('.',@therest);
5497: } else {
5498: $rest='';
5499: }
1.320 albertel 5500:
1.57 www 5501: my $qualifierrest=$qualifier;
5502: if ($rest) { $qualifierrest.='.'.$rest; }
5503: my $spacequalifierrest=$space;
5504: if ($qualifierrest) { $spacequalifierrest.='.'.$qualifierrest; }
1.28 www 5505: if ($realm eq 'user') {
1.48 www 5506: # --------------------------------------------------------------- user.resource
5507: if ($space eq 'resource') {
1.651 albertel 5508: if ( (defined($Apache::lonhomework::parsing_a_problem)
5509: || defined($Apache::lonhomework::parsing_a_task))
5510: &&
1.744 albertel 5511: ($symbparm eq &symbread()) ) {
5512: # if we are in the middle of processing the resource the
5513: # get the value we are planning on committing
5514: if (defined($Apache::lonhomework::results{$qualifierrest})) {
5515: return $Apache::lonhomework::results{$qualifierrest};
5516: } else {
5517: return $Apache::lonhomework::history{$qualifierrest};
5518: }
1.335 albertel 5519: } else {
1.359 albertel 5520: my %restored;
1.620 albertel 5521: if ($publicuser || $env{'request.state'} eq 'construct') {
1.359 albertel 5522: %restored=&tmprestore($symbparm,$courseid,$udom,$uname);
5523: } else {
5524: %restored=&restore($symbparm,$courseid,$udom,$uname);
5525: }
1.335 albertel 5526: return $restored{$qualifierrest};
5527: }
1.48 www 5528: # ----------------------------------------------------------------- user.access
5529: } elsif ($space eq 'access') {
1.218 albertel 5530: # FIXME - not supporting calls for a specific user
1.48 www 5531: return &allowed($qualifier,$rest);
5532: # ------------------------------------------ user.preferences, user.environment
5533: } elsif (($space eq 'preferences') || ($space eq 'environment')) {
1.620 albertel 5534: if (($uname eq $env{'user.name'}) &&
5535: ($udom eq $env{'user.domain'})) {
5536: return $env{join('.',('environment',$qualifierrest))};
1.218 albertel 5537: } else {
1.359 albertel 5538: my %returnhash;
5539: if (!$publicuser) {
5540: %returnhash=&userenvironment($udom,$uname,
5541: $qualifierrest);
5542: }
1.218 albertel 5543: return $returnhash{$qualifierrest};
5544: }
1.48 www 5545: # ----------------------------------------------------------------- user.course
5546: } elsif ($space eq 'course') {
1.218 albertel 5547: # FIXME - not supporting calls for a specific user
1.620 albertel 5548: return $env{join('.',('request.course',$qualifier))};
1.48 www 5549: # ------------------------------------------------------------------- user.role
5550: } elsif ($space eq 'role') {
1.218 albertel 5551: # FIXME - not supporting calls for a specific user
1.620 albertel 5552: my ($role,$where)=split(/\./,$env{'request.role'});
1.48 www 5553: if ($qualifier eq 'value') {
5554: return $role;
5555: } elsif ($qualifier eq 'extent') {
5556: return $where;
5557: }
5558: # ----------------------------------------------------------------- user.domain
5559: } elsif ($space eq 'domain') {
1.218 albertel 5560: return $udom;
1.48 www 5561: # ------------------------------------------------------------------- user.name
5562: } elsif ($space eq 'name') {
1.218 albertel 5563: return $uname;
1.48 www 5564: # ---------------------------------------------------- Any other user namespace
1.29 www 5565: } else {
1.359 albertel 5566: my %reply;
5567: if (!$publicuser) {
5568: %reply=&get($space,[$qualifierrest],$udom,$uname);
5569: }
5570: return $reply{$qualifierrest};
1.48 www 5571: }
1.236 www 5572: } elsif ($realm eq 'query') {
5573: # ---------------------------------------------- pull stuff out of query string
1.384 albertel 5574: &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},
5575: [$spacequalifierrest]);
1.620 albertel 5576: return $env{'form.'.$spacequalifierrest};
1.236 www 5577: } elsif ($realm eq 'request') {
1.48 www 5578: # ------------------------------------------------------------- request.browser
5579: if ($space eq 'browser') {
1.430 www 5580: if ($qualifier eq 'textremote') {
1.676 albertel 5581: if (&Apache::lonlocal::mt('textual_remote_display') eq 'on') {
1.430 www 5582: return 1;
5583: } else {
5584: return 0;
5585: }
5586: } else {
1.620 albertel 5587: return $env{'browser.'.$qualifier};
1.430 www 5588: }
1.57 www 5589: # ------------------------------------------------------------ request.filename
5590: } else {
1.620 albertel 5591: return $env{'request.'.$spacequalifierrest};
1.29 www 5592: }
1.28 www 5593: } elsif ($realm eq 'course') {
1.48 www 5594: # ---------------------------------------------------------- course.description
1.620 albertel 5595: return $env{'course.'.$courseid.'.'.$spacequalifierrest};
1.57 www 5596: } elsif ($realm eq 'resource') {
1.165 www 5597:
1.620 albertel 5598: if (defined($courseid) && $courseid eq $env{'request.course.id'}) {
1.539 albertel 5599: if (!$symbparm) { $symbparm=&symbread(); }
5600: }
1.693 albertel 5601:
5602: if ($space eq 'title') {
5603: if (!$symbparm) { $symbparm = $env{'request.filename'}; }
5604: return &gettitle($symbparm);
5605: }
5606:
5607: if ($space eq 'map') {
5608: my ($map) = &decode_symb($symbparm);
5609: return &symbread($map);
5610: }
5611:
5612: my ($section, $group, @groups);
1.593 albertel 5613: my ($courselevelm,$courselevel);
1.539 albertel 5614: if ($symbparm && defined($courseid) &&
1.620 albertel 5615: $courseid eq $env{'request.course.id'}) {
1.165 www 5616:
1.218 albertel 5617: #print '<br>'.$space.' - '.$qualifier.' - '.$spacequalifierrest;
1.165 www 5618:
1.60 www 5619: # ----------------------------------------------------- Cascading lookup scheme
1.218 albertel 5620: my $symbp=$symbparm;
1.735 albertel 5621: my $mapp=&deversion((&decode_symb($symbp))[0]);
1.218 albertel 5622:
5623: my $symbparm=$symbp.'.'.$spacequalifierrest;
5624: my $mapparm=$mapp.'___(all).'.$spacequalifierrest;
5625:
1.620 albertel 5626: if (($env{'user.name'} eq $uname) &&
5627: ($env{'user.domain'} eq $udom)) {
5628: $section=$env{'request.course.sec'};
1.733 raeburn 5629: @groups = split(/:/,$env{'request.course.groups'});
5630: @groups=&sort_course_groups($courseid,@groups);
1.218 albertel 5631: } else {
1.539 albertel 5632: if (! defined($usection)) {
1.551 albertel 5633: $section=&getsection($udom,$uname,$courseid);
1.539 albertel 5634: } else {
5635: $section = $usection;
5636: }
1.733 raeburn 5637: @groups = &get_users_groups($udom,$uname,$courseid);
1.218 albertel 5638: }
5639:
5640: my $seclevel=$courseid.'.['.$section.'].'.$spacequalifierrest;
5641: my $seclevelr=$courseid.'.['.$section.'].'.$symbparm;
5642: my $seclevelm=$courseid.'.['.$section.'].'.$mapparm;
5643:
1.593 albertel 5644: $courselevel=$courseid.'.'.$spacequalifierrest;
1.218 albertel 5645: my $courselevelr=$courseid.'.'.$symbparm;
1.593 albertel 5646: $courselevelm=$courseid.'.'.$mapparm;
1.69 www 5647:
1.60 www 5648: # ----------------------------------------------------------- first, check user
1.624 albertel 5649:
5650: my $userreply=&resdata($uname,$udom,'user',
5651: ($courselevelr,$courselevelm,
5652: $courselevel));
5653: if (defined($userreply)) { return $userreply; }
1.95 www 5654:
1.594 albertel 5655: # ------------------------------------------------ second, check some of course
1.684 raeburn 5656: my $coursereply;
1.691 raeburn 5657: if (@groups > 0) {
5658: $coursereply = &check_group_parms($courseid,\@groups,$symbparm,
5659: $mapparm,$spacequalifierrest);
1.684 raeburn 5660: if (defined($coursereply)) { return $coursereply; }
5661: }
1.96 www 5662:
1.684 raeburn 5663: $coursereply=&resdata($env{'course.'.$courseid.'.num'},
1.624 albertel 5664: $env{'course.'.$courseid.'.domain'},
5665: 'course',
5666: ($seclevelr,$seclevelm,$seclevel,
5667: $courselevelr));
1.287 albertel 5668: if (defined($coursereply)) { return $coursereply; }
1.200 www 5669:
1.60 www 5670: # ------------------------------------------------------ third, check map parms
1.218 albertel 5671: my %parmhash=();
5672: my $thisparm='';
5673: if (tie(%parmhash,'GDBM_File',
1.620 albertel 5674: $env{'request.course.fn'}.'_parms.db',
1.256 albertel 5675: &GDBM_READER(),0640)) {
1.218 albertel 5676: $thisparm=$parmhash{$symbparm};
5677: untie(%parmhash);
5678: }
5679: if ($thisparm) { return $thisparm; }
5680: }
1.594 albertel 5681: # ------------------------------------------ fourth, look in resource metadata
1.71 www 5682:
1.218 albertel 5683: $spacequalifierrest=~s/\./\_/;
1.282 albertel 5684: my $filename;
5685: if (!$symbparm) { $symbparm=&symbread(); }
5686: if ($symbparm) {
1.409 www 5687: $filename=(&decode_symb($symbparm))[2];
1.282 albertel 5688: } else {
1.620 albertel 5689: $filename=$env{'request.filename'};
1.282 albertel 5690: }
5691: my $metadata=&metadata($filename,$spacequalifierrest);
1.288 albertel 5692: if (defined($metadata)) { return $metadata; }
1.282 albertel 5693: $metadata=&metadata($filename,'parameter_'.$spacequalifierrest);
1.288 albertel 5694: if (defined($metadata)) { return $metadata; }
1.142 www 5695:
1.594 albertel 5696: # ---------------------------------------------- fourth, look in rest pf course
1.593 albertel 5697: if ($symbparm && defined($courseid) &&
1.620 albertel 5698: $courseid eq $env{'request.course.id'}) {
1.624 albertel 5699: my $coursereply=&resdata($env{'course.'.$courseid.'.num'},
5700: $env{'course.'.$courseid.'.domain'},
5701: 'course',
5702: ($courselevelm,$courselevel));
1.593 albertel 5703: if (defined($coursereply)) { return $coursereply; }
5704: }
1.145 www 5705: # ------------------------------------------------------------------ Cascade up
1.218 albertel 5706: unless ($space eq '0') {
1.336 albertel 5707: my @parts=split(/_/,$space);
5708: my $id=pop(@parts);
5709: my $part=join('_',@parts);
5710: if ($part eq '') { $part='0'; }
5711: my $partgeneral=&EXT('resource.'.$part.'.'.$qualifierrest,
1.395 albertel 5712: $symbparm,$udom,$uname,$section,1);
1.337 albertel 5713: if (defined($partgeneral)) { return $partgeneral; }
1.218 albertel 5714: }
1.395 albertel 5715: if ($recurse) { return undef; }
5716: my $pack_def=&packages_tab_default($filename,$varname);
5717: if (defined($pack_def)) { return $pack_def; }
1.71 www 5718:
1.48 www 5719: # ---------------------------------------------------- Any other user namespace
5720: } elsif ($realm eq 'environment') {
5721: # ----------------------------------------------------------------- environment
1.620 albertel 5722: if (($uname eq $env{'user.name'})&&($udom eq $env{'user.domain'})) {
5723: return $env{'environment.'.$spacequalifierrest};
1.219 albertel 5724: } else {
5725: my %returnhash=&userenvironment($udom,$uname,
5726: $spacequalifierrest);
5727: return $returnhash{$spacequalifierrest};
5728: }
1.28 www 5729: } elsif ($realm eq 'system') {
1.48 www 5730: # ----------------------------------------------------------------- system.time
5731: if ($space eq 'time') {
5732: return time;
5733: }
1.696 albertel 5734: } elsif ($realm eq 'server') {
5735: # ----------------------------------------------------------------- system.time
5736: if ($space eq 'name') {
5737: return $ENV{'SERVER_NAME'};
5738: }
1.28 www 5739: }
1.48 www 5740: return '';
1.61 www 5741: }
5742:
1.691 raeburn 5743: sub check_group_parms {
5744: my ($courseid,$groups,$symbparm,$mapparm,$what) = @_;
5745: my @groupitems = ();
5746: my $resultitem;
5747: my @levels = ($symbparm,$mapparm,$what);
5748: foreach my $group (@{$groups}) {
5749: foreach my $level (@levels) {
5750: my $item = $courseid.'.['.$group.'].'.$level;
5751: push(@groupitems,$item);
5752: }
5753: }
5754: my $coursereply = &resdata($env{'course.'.$courseid.'.num'},
5755: $env{'course.'.$courseid.'.domain'},
5756: 'course',@groupitems);
5757: return $coursereply;
5758: }
5759:
5760: sub sort_course_groups { # Sort groups based on defined rankings. Default is sort().
1.733 raeburn 5761: my ($courseid,@groups) = @_;
5762: @groups = sort(@groups);
1.691 raeburn 5763: return @groups;
5764: }
5765:
1.395 albertel 5766: sub packages_tab_default {
5767: my ($uri,$varname)=@_;
5768: my (undef,$part,$name)=split(/\./,$varname);
1.738 albertel 5769:
5770: my (@extension,@specifics,$do_default);
5771: foreach my $package (split(/,/,&metadata($uri,'packages'))) {
1.395 albertel 5772: my ($pack_type,$pack_part)=split(/_/,$package,2);
1.738 albertel 5773: if ($pack_type eq 'default') {
5774: $do_default=1;
5775: } elsif ($pack_type eq 'extension') {
5776: push(@extension,[$package,$pack_type,$pack_part]);
5777: } else {
5778: push(@specifics,[$package,$pack_type,$pack_part]);
5779: }
5780: }
5781: # first look for a package that matches the requested part id
5782: foreach my $package (@specifics) {
5783: my (undef,$pack_type,$pack_part)=@{$package};
5784: next if ($pack_part ne $part);
5785: if (defined($packagetab{"$pack_type&$name&default"})) {
5786: return $packagetab{"$pack_type&$name&default"};
5787: }
5788: }
5789: # look for any possible matching non extension_ package
5790: foreach my $package (@specifics) {
5791: my (undef,$pack_type,$pack_part)=@{$package};
1.468 albertel 5792: if (defined($packagetab{"$pack_type&$name&default"})) {
5793: return $packagetab{"$pack_type&$name&default"};
5794: }
1.585 albertel 5795: if ($pack_type eq 'part') { $pack_part='0'; }
1.468 albertel 5796: if (defined($packagetab{$pack_type."_".$pack_part."&$name&default"})) {
5797: return $packagetab{$pack_type."_".$pack_part."&$name&default"};
1.395 albertel 5798: }
5799: }
1.738 albertel 5800: # look for any posible extension_ match
5801: foreach my $package (@extension) {
5802: my ($package,$pack_type)=@{$package};
5803: if (defined($packagetab{"$pack_type&$name&default"})) {
5804: return $packagetab{"$pack_type&$name&default"};
5805: }
5806: if (defined($packagetab{$package."&$name&default"})) {
5807: return $packagetab{$package."&$name&default"};
5808: }
5809: }
5810: # look for a global default setting
5811: if ($do_default && defined($packagetab{"default&$name&default"})) {
5812: return $packagetab{"default&$name&default"};
5813: }
1.395 albertel 5814: return undef;
5815: }
5816:
1.334 albertel 5817: sub add_prefix_and_part {
5818: my ($prefix,$part)=@_;
5819: my $keyroot;
5820: if (defined($prefix) && $prefix !~ /^__/) {
5821: # prefix that has a part already
5822: $keyroot=$prefix;
5823: } elsif (defined($prefix)) {
5824: # prefix that is missing a part
5825: if (defined($part)) { $keyroot='_'.$part.substr($prefix,1); }
5826: } else {
5827: # no prefix at all
5828: if (defined($part)) { $keyroot='_'.$part; }
5829: }
5830: return $keyroot;
5831: }
5832:
1.71 www 5833: # ---------------------------------------------------------------- Get metadata
5834:
1.599 albertel 5835: my %metaentry;
1.71 www 5836: sub metadata {
1.176 www 5837: my ($uri,$what,$liburi,$prefix,$depthcount)=@_;
1.71 www 5838: $uri=&declutter($uri);
1.288 albertel 5839: # if it is a non metadata possible uri return quickly
1.529 albertel 5840: if (($uri eq '') ||
5841: (($uri =~ m|^/*adm/|) &&
1.698 albertel 5842: ($uri !~ m|^adm/includes|) && ($uri !~ m|/bulletinboard$|)) ||
1.423 albertel 5843: ($uri =~ m|/$|) || ($uri =~ m|/.meta$|) || ($uri =~ /^~/) ||
1.489 albertel 5844: ($uri =~ m|home/[^/]+/public_html/|)) {
1.468 albertel 5845: return undef;
1.288 albertel 5846: }
1.73 www 5847: my $filename=$uri;
5848: $uri=~s/\.meta$//;
1.172 www 5849: #
5850: # Is the metadata already cached?
1.177 www 5851: # Look at timestamp of caching
1.172 www 5852: # Everything is cached by the main uri, libraries are never directly cached
5853: #
1.428 albertel 5854: if (!defined($liburi)) {
1.599 albertel 5855: my ($result,$cached)=&is_cached_new('meta',$uri);
1.428 albertel 5856: if (defined($cached)) { return $result->{':'.$what}; }
5857: }
5858: {
1.172 www 5859: #
5860: # Is this a recursive call for a library?
5861: #
1.599 albertel 5862: # if (! exists($metacache{$uri})) {
5863: # $metacache{$uri}={};
5864: # }
1.171 www 5865: if ($liburi) {
5866: $liburi=&declutter($liburi);
5867: $filename=$liburi;
1.401 bowersj2 5868: } else {
1.599 albertel 5869: &devalidate_cache_new('meta',$uri);
5870: undef(%metaentry);
1.401 bowersj2 5871: }
1.140 www 5872: my %metathesekeys=();
1.73 www 5873: unless ($filename=~/\.meta$/) { $filename.='.meta'; }
1.489 albertel 5874: my $metastring;
1.609 banghart 5875: if ($uri !~ m -^(uploaded|editupload)/-) {
1.543 albertel 5876: my $file=&filelocation('',&clutter($filename));
1.599 albertel 5877: #push(@{$metaentry{$uri.'.file'}},$file);
1.543 albertel 5878: $metastring=&getfile($file);
1.489 albertel 5879: }
1.208 albertel 5880: my $parser=HTML::LCParser->new(\$metastring);
1.71 www 5881: my $token;
1.140 www 5882: undef %metathesekeys;
1.71 www 5883: while ($token=$parser->get_token) {
1.339 albertel 5884: if ($token->[0] eq 'S') {
5885: if (defined($token->[2]->{'package'})) {
1.172 www 5886: #
5887: # This is a package - get package info
5888: #
1.339 albertel 5889: my $package=$token->[2]->{'package'};
5890: my $keyroot=&add_prefix_and_part($prefix,$token->[2]->{'part'});
5891: if (defined($token->[2]->{'id'})) {
5892: $keyroot.='_'.$token->[2]->{'id'};
5893: }
1.599 albertel 5894: if ($metaentry{':packages'}) {
5895: $metaentry{':packages'}.=','.$package.$keyroot;
1.339 albertel 5896: } else {
1.599 albertel 5897: $metaentry{':packages'}=$package.$keyroot;
1.339 albertel 5898: }
1.736 albertel 5899: foreach my $pack_entry (keys(%packagetab)) {
1.432 albertel 5900: my $part=$keyroot;
5901: $part=~s/^\_//;
1.736 albertel 5902: if ($pack_entry=~/^\Q$package\E\&/ ||
5903: $pack_entry=~/^\Q$package\E_0\&/) {
5904: my ($pack,$name,$subp)=split(/\&/,$pack_entry);
1.395 albertel 5905: # ignore package.tab specified default values
5906: # here &package_tab_default() will fetch those
5907: if ($subp eq 'default') { next; }
1.736 albertel 5908: my $value=$packagetab{$pack_entry};
1.432 albertel 5909: my $unikey;
5910: if ($pack =~ /_0$/) {
5911: $unikey='parameter_0_'.$name;
5912: $part=0;
5913: } else {
5914: $unikey='parameter'.$keyroot.'_'.$name;
5915: }
1.339 albertel 5916: if ($subp eq 'display') {
5917: $value.=' [Part: '.$part.']';
5918: }
1.599 albertel 5919: $metaentry{':'.$unikey.'.part'}=$part;
1.395 albertel 5920: $metathesekeys{$unikey}=1;
1.599 albertel 5921: unless (defined($metaentry{':'.$unikey.'.'.$subp})) {
5922: $metaentry{':'.$unikey.'.'.$subp}=$value;
1.339 albertel 5923: }
1.599 albertel 5924: if (defined($metaentry{':'.$unikey.'.default'})) {
5925: $metaentry{':'.$unikey}=
5926: $metaentry{':'.$unikey.'.default'};
1.356 albertel 5927: }
1.339 albertel 5928: }
5929: }
5930: } else {
1.172 www 5931: #
5932: # This is not a package - some other kind of start tag
1.339 albertel 5933: #
5934: my $entry=$token->[1];
5935: my $unikey;
5936: if ($entry eq 'import') {
5937: $unikey='';
5938: } else {
5939: $unikey=$entry;
5940: }
5941: $unikey.=&add_prefix_and_part($prefix,$token->[2]->{'part'});
5942:
5943: if (defined($token->[2]->{'id'})) {
5944: $unikey.='_'.$token->[2]->{'id'};
5945: }
1.175 www 5946:
1.339 albertel 5947: if ($entry eq 'import') {
1.175 www 5948: #
5949: # Importing a library here
1.339 albertel 5950: #
5951: if ($depthcount<20) {
5952: my $location=$parser->get_text('/import');
5953: my $dir=$filename;
5954: $dir=~s|[^/]*$||;
5955: $location=&filelocation($dir,$location);
1.736 albertel 5956: my $metadata =
5957: &metadata($uri,'keys', $location,$unikey,
5958: $depthcount+1);
5959: foreach my $meta (split(',',$metadata)) {
5960: $metaentry{':'.$meta}=$metaentry{':'.$meta};
5961: $metathesekeys{$meta}=1;
1.339 albertel 5962: }
5963: }
5964: } else {
5965:
5966: if (defined($token->[2]->{'name'})) {
5967: $unikey.='_'.$token->[2]->{'name'};
5968: }
5969: $metathesekeys{$unikey}=1;
1.736 albertel 5970: foreach my $param (@{$token->[3]}) {
5971: $metaentry{':'.$unikey.'.'.$param} =
5972: $token->[2]->{$param};
1.339 albertel 5973: }
5974: my $internaltext=&HTML::Entities::decode($parser->get_text('/'.$entry));
1.599 albertel 5975: my $default=$metaentry{':'.$unikey.'.default'};
1.339 albertel 5976: if ( $internaltext =~ /^\s*$/ && $default !~ /^\s*$/) {
5977: # only ws inside the tag, and not in default, so use default
5978: # as value
1.599 albertel 5979: $metaentry{':'.$unikey}=$default;
1.339 albertel 5980: } else {
1.321 albertel 5981: # either something interesting inside the tag or default
5982: # uninteresting
1.599 albertel 5983: $metaentry{':'.$unikey}=$internaltext;
1.339 albertel 5984: }
1.172 www 5985: # end of not-a-package not-a-library import
1.339 albertel 5986: }
1.172 www 5987: # end of not-a-package start tag
1.339 albertel 5988: }
1.172 www 5989: # the next is the end of "start tag"
1.339 albertel 5990: }
5991: }
1.483 albertel 5992: my ($extension) = ($uri =~ /\.(\w+)$/);
1.737 albertel 5993: foreach my $key (keys(%packagetab)) {
1.483 albertel 5994: #no specific packages #how's our extension
5995: if ($key!~/^extension_\Q$extension\E&/) { next; }
1.488 albertel 5996: &metadata_create_package_def($uri,$key,'extension_'.$extension,
1.483 albertel 5997: \%metathesekeys);
5998: }
1.599 albertel 5999: if (!exists($metaentry{':packages'})) {
1.737 albertel 6000: foreach my $key (keys(%packagetab)) {
1.483 albertel 6001: #no specific packages well let's get default then
6002: if ($key!~/^default&/) { next; }
1.488 albertel 6003: &metadata_create_package_def($uri,$key,'default',
1.483 albertel 6004: \%metathesekeys);
6005: }
6006: }
1.338 www 6007: # are there custom rights to evaluate
1.599 albertel 6008: if ($metaentry{':copyright'} eq 'custom') {
1.339 albertel 6009:
1.338 www 6010: #
6011: # Importing a rights file here
1.339 albertel 6012: #
6013: unless ($depthcount) {
1.599 albertel 6014: my $location=$metaentry{':customdistributionfile'};
1.339 albertel 6015: my $dir=$filename;
6016: $dir=~s|[^/]*$||;
6017: $location=&filelocation($dir,$location);
1.736 albertel 6018: my $rights_metadata =
6019: &metadata($uri,'keys',$location,'_rights',
6020: $depthcount+1);
6021: foreach my $rights (split(',',$rights_metadata)) {
6022: #$metaentry{':'.$rights}=$metacache{$uri}->{':'.$rights};
6023: $metathesekeys{$rights}=1;
1.339 albertel 6024: }
6025: }
6026: }
1.737 albertel 6027: # uniqifiy package listing
6028: my %seen;
6029: my @uniq_packages =
6030: grep { ! $seen{$_} ++ } (split(',',$metaentry{':packages'}));
6031: $metaentry{':packages'} = join(',',@uniq_packages);
6032:
6033: $metaentry{':keys'} = join(',',keys(%metathesekeys));
1.599 albertel 6034: &metadata_generate_part0(\%metathesekeys,\%metaentry,$uri);
6035: $metaentry{':allpossiblekeys'}=join(',',keys %metathesekeys);
1.699 albertel 6036: &do_cache_new('meta',$uri,\%metaentry,60*60);
1.177 www 6037: # this is the end of "was not already recently cached
1.71 www 6038: }
1.599 albertel 6039: return $metaentry{':'.$what};
1.261 albertel 6040: }
6041:
1.488 albertel 6042: sub metadata_create_package_def {
1.483 albertel 6043: my ($uri,$key,$package,$metathesekeys)=@_;
6044: my ($pack,$name,$subp)=split(/\&/,$key);
6045: if ($subp eq 'default') { next; }
6046:
1.599 albertel 6047: if (defined($metaentry{':packages'})) {
6048: $metaentry{':packages'}.=','.$package;
1.483 albertel 6049: } else {
1.599 albertel 6050: $metaentry{':packages'}=$package;
1.483 albertel 6051: }
6052: my $value=$packagetab{$key};
6053: my $unikey;
6054: $unikey='parameter_0_'.$name;
1.599 albertel 6055: $metaentry{':'.$unikey.'.part'}=0;
1.483 albertel 6056: $$metathesekeys{$unikey}=1;
1.599 albertel 6057: unless (defined($metaentry{':'.$unikey.'.'.$subp})) {
6058: $metaentry{':'.$unikey.'.'.$subp}=$value;
1.483 albertel 6059: }
1.599 albertel 6060: if (defined($metaentry{':'.$unikey.'.default'})) {
6061: $metaentry{':'.$unikey}=
6062: $metaentry{':'.$unikey.'.default'};
1.483 albertel 6063: }
6064: }
6065:
1.261 albertel 6066: sub metadata_generate_part0 {
6067: my ($metadata,$metacache,$uri) = @_;
6068: my %allnames;
1.737 albertel 6069: foreach my $metakey (keys(%$metadata)) {
1.261 albertel 6070: if ($metakey=~/^parameter\_(.*)/) {
1.428 albertel 6071: my $part=$$metacache{':'.$metakey.'.part'};
6072: my $name=$$metacache{':'.$metakey.'.name'};
1.356 albertel 6073: if (! exists($$metadata{'parameter_0_'.$name.'.name'})) {
1.261 albertel 6074: $allnames{$name}=$part;
6075: }
6076: }
6077: }
6078: foreach my $name (keys(%allnames)) {
6079: $$metadata{"parameter_0_$name"}=1;
1.428 albertel 6080: my $key=":parameter_0_$name";
1.261 albertel 6081: $$metacache{"$key.part"}='0';
6082: $$metacache{"$key.name"}=$name;
1.428 albertel 6083: $$metacache{"$key.type"}=$$metacache{':parameter_'.
1.261 albertel 6084: $allnames{$name}.'_'.$name.
6085: '.type'};
1.428 albertel 6086: my $olddis=$$metacache{':parameter_'.$allnames{$name}.'_'.$name.
1.261 albertel 6087: '.display'};
1.644 www 6088: my $expr='[Part: '.$allnames{$name}.']';
1.479 albertel 6089: $olddis=~s/\Q$expr\E/\[Part: 0\]/;
1.261 albertel 6090: $$metacache{"$key.display"}=$olddis;
6091: }
1.71 www 6092: }
6093:
1.764 albertel 6094: # ------------------------------------------------------ Devalidate title cache
6095:
6096: sub devalidate_title_cache {
6097: my ($url)=@_;
6098: if (!$env{'request.course.id'}) { return; }
6099: my $symb=&symbread($url);
6100: if (!$symb) { return; }
6101: my $key=$env{'request.course.id'}."\0".$symb;
6102: &devalidate_cache_new('title',$key);
6103: }
6104:
1.301 www 6105: # ------------------------------------------------- Get the title of a resource
6106:
6107: sub gettitle {
6108: my $urlsymb=shift;
6109: my $symb=&symbread($urlsymb);
1.534 albertel 6110: if ($symb) {
1.620 albertel 6111: my $key=$env{'request.course.id'}."\0".$symb;
1.599 albertel 6112: my ($result,$cached)=&is_cached_new('title',$key);
1.575 albertel 6113: if (defined($cached)) {
6114: return $result;
6115: }
1.534 albertel 6116: my ($map,$resid,$url)=&decode_symb($symb);
6117: my $title='';
6118: my %bighash;
1.620 albertel 6119: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
1.534 albertel 6120: &GDBM_READER(),0640)) {
6121: my $mapid=$bighash{'map_pc_'.&clutter($map)};
6122: $title=$bighash{'title_'.$mapid.'.'.$resid};
6123: untie %bighash;
6124: }
6125: $title=~s/\&colon\;/\:/gs;
6126: if ($title) {
1.599 albertel 6127: return &do_cache_new('title',$key,$title,600);
1.534 albertel 6128: }
6129: $urlsymb=$url;
6130: }
6131: my $title=&metadata($urlsymb,'title');
6132: if (!$title) { $title=(split('/',$urlsymb))[-1]; }
6133: return $title;
1.301 www 6134: }
1.613 albertel 6135:
1.614 albertel 6136: sub get_slot {
6137: my ($which,$cnum,$cdom)=@_;
6138: if (!$cnum || !$cdom) {
6139: (undef,my $courseid)=&Apache::lonxml::whichuser();
1.620 albertel 6140: $cdom=$env{'course.'.$courseid.'.domain'};
6141: $cnum=$env{'course.'.$courseid.'.num'};
1.614 albertel 6142: }
1.703 albertel 6143: my $key=join("\0",'slots',$cdom,$cnum,$which);
6144: my %slotinfo;
6145: if (exists($remembered{$key})) {
6146: $slotinfo{$which} = $remembered{$key};
6147: } else {
6148: %slotinfo=&get('slots',[$which],$cdom,$cnum);
6149: &Apache::lonhomework::showhash(%slotinfo);
6150: my ($tmp)=keys(%slotinfo);
6151: if ($tmp=~/^error:/) { return (); }
6152: $remembered{$key} = $slotinfo{$which};
6153: }
1.616 albertel 6154: if (ref($slotinfo{$which}) eq 'HASH') {
6155: return %{$slotinfo{$which}};
6156: }
6157: return $slotinfo{$which};
1.614 albertel 6158: }
1.31 www 6159: # ------------------------------------------------- Update symbolic store links
6160:
6161: sub symblist {
6162: my ($mapname,%newhash)=@_;
1.438 www 6163: $mapname=&deversion(&declutter($mapname));
1.31 www 6164: my %hash;
1.620 albertel 6165: if (($env{'request.course.fn'}) && (%newhash)) {
6166: if (tie(%hash,'GDBM_File',$env{'request.course.fn'}.'_symb.db',
1.256 albertel 6167: &GDBM_WRCREAT(),0640)) {
1.711 albertel 6168: foreach my $url (keys %newhash) {
6169: next if ($url eq 'last_known'
6170: && $env{'form.no_update_last_known'});
6171: $hash{declutter($url)}=&encode_symb($mapname,
6172: $newhash{$url}->[1],
6173: $newhash{$url}->[0]);
1.191 harris41 6174: }
1.31 www 6175: if (untie(%hash)) {
6176: return 'ok';
6177: }
6178: }
6179: }
6180: return 'error';
1.212 www 6181: }
6182:
6183: # --------------------------------------------------------------- Verify a symb
6184:
6185: sub symbverify {
1.510 www 6186: my ($symb,$thisurl)=@_;
6187: my $thisfn=$thisurl;
6188: # wrapper not part of symbs
6189: $thisfn=~s/^\/adm\/wrapper//;
1.694 albertel 6190: $thisfn=~s/^\/adm\/coursedocs\/showdoc\///;
1.439 www 6191: $thisfn=&declutter($thisfn);
1.215 www 6192: # direct jump to resource in page or to a sequence - will construct own symbs
6193: if ($thisfn=~/\.(page|sequence)$/) { return 1; }
6194: # check URL part
1.409 www 6195: my ($map,$resid,$url)=&decode_symb($symb);
1.439 www 6196:
1.431 www 6197: unless ($url eq $thisfn) { return 0; }
1.213 www 6198:
1.216 www 6199: $symb=&symbclean($symb);
1.510 www 6200: $thisurl=&deversion($thisurl);
1.439 www 6201: $thisfn=&deversion($thisfn);
1.213 www 6202:
6203: my %bighash;
6204: my $okay=0;
1.431 www 6205:
1.620 albertel 6206: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
1.256 albertel 6207: &GDBM_READER(),0640)) {
1.510 www 6208: my $ids=$bighash{'ids_'.&clutter($thisurl)};
1.216 www 6209: unless ($ids) {
1.510 www 6210: $ids=$bighash{'ids_/'.$thisurl};
1.216 www 6211: }
6212: if ($ids) {
6213: # ------------------------------------------------------------------- Has ID(s)
6214: foreach (split(/\,/,$ids)) {
1.644 www 6215: my ($mapid,$resid)=split(/\./,$_);
1.216 www 6216: if (
6217: &symbclean(&declutter($bighash{'map_id_'.$mapid}).'___'.$resid.'___'.$thisfn)
6218: eq $symb) {
1.620 albertel 6219: if (($env{'request.role.adv'}) ||
6220: $bighash{'encrypted_'.$_} eq $env{'request.enc'}) {
1.582 albertel 6221: $okay=1;
6222: }
6223: }
1.216 www 6224: }
6225: }
1.213 www 6226: untie(%bighash);
6227: }
6228: return $okay;
1.31 www 6229: }
6230:
1.210 www 6231: # --------------------------------------------------------------- Clean-up symb
6232:
6233: sub symbclean {
6234: my $symb=shift;
1.568 albertel 6235: if ($symb=~m|^/enc/|) { $symb=&Apache::lonenc::unencrypted($symb); }
1.210 www 6236: # remove version from map
6237: $symb=~s/\.(\d+)\.(\w+)\_\_\_/\.$2\_\_\_/;
1.215 www 6238:
1.210 www 6239: # remove version from URL
6240: $symb=~s/\.(\d+)\.(\w+)$/\.$2/;
1.213 www 6241:
1.507 www 6242: # remove wrapper
6243:
1.510 www 6244: $symb=~s/(\_\_\_\d+\_\_\_)adm\/wrapper\/(res\/)*/$1/;
1.694 albertel 6245: $symb=~s/(\_\_\_\d+\_\_\_)adm\/coursedocs\/showdoc\/(res\/)*/$1/;
1.210 www 6246: return $symb;
1.409 www 6247: }
6248:
6249: # ---------------------------------------------- Split symb to find map and url
1.429 albertel 6250:
6251: sub encode_symb {
6252: my ($map,$resid,$url)=@_;
6253: return &symbclean(&declutter($map).'___'.$resid.'___'.&declutter($url));
6254: }
1.409 www 6255:
6256: sub decode_symb {
1.568 albertel 6257: my $symb=shift;
6258: if ($symb=~m|^/enc/|) { $symb=&Apache::lonenc::unencrypted($symb); }
6259: my ($map,$resid,$url)=split(/___/,$symb);
1.413 www 6260: return (&fixversion($map),$resid,&fixversion($url));
6261: }
6262:
6263: sub fixversion {
6264: my $fn=shift;
1.609 banghart 6265: if ($fn=~/^(adm|uploaded|editupload|public)/) { return $fn; }
1.435 www 6266: my %bighash;
6267: my $uri=&clutter($fn);
1.620 albertel 6268: my $key=$env{'request.course.id'}.'_'.$uri;
1.440 www 6269: # is this cached?
1.599 albertel 6270: my ($result,$cached)=&is_cached_new('courseresversion',$key);
1.440 www 6271: if (defined($cached)) { return $result; }
6272: # unfortunately not cached, or expired
1.620 albertel 6273: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
1.440 www 6274: &GDBM_READER(),0640)) {
6275: if ($bighash{'version_'.$uri}) {
6276: my $version=$bighash{'version_'.$uri};
1.444 www 6277: unless (($version eq 'mostrecent') ||
6278: ($version==&getversion($uri))) {
1.440 www 6279: $uri=~s/\.(\w+)$/\.$version\.$1/;
6280: }
6281: }
6282: untie %bighash;
1.413 www 6283: }
1.599 albertel 6284: return &do_cache_new('courseresversion',$key,&declutter($uri),600);
1.438 www 6285: }
6286:
6287: sub deversion {
6288: my $url=shift;
6289: $url=~s/\.\d+\.(\w+)$/\.$1/;
6290: return $url;
1.210 www 6291: }
6292:
1.31 www 6293: # ------------------------------------------------------ Return symb list entry
6294:
6295: sub symbread {
1.249 www 6296: my ($thisfn,$donotrecurse)=@_;
1.542 albertel 6297: my $cache_str='request.symbread.cached.'.$thisfn;
1.620 albertel 6298: if (defined($env{$cache_str})) { return $env{$cache_str}; }
1.242 www 6299: # no filename provided? try from environment
1.44 www 6300: unless ($thisfn) {
1.620 albertel 6301: if ($env{'request.symb'}) {
6302: return $env{$cache_str}=&symbclean($env{'request.symb'});
1.539 albertel 6303: }
1.620 albertel 6304: $thisfn=$env{'request.filename'};
1.44 www 6305: }
1.569 albertel 6306: if ($thisfn=~m|^/enc/|) { $thisfn=&Apache::lonenc::unencrypted($thisfn); }
1.242 www 6307: # is that filename actually a symb? Verify, clean, and return
6308: if ($thisfn=~/\_\_\_\d+\_\_\_(.*)$/) {
1.539 albertel 6309: if (&symbverify($thisfn,$1)) {
1.620 albertel 6310: return $env{$cache_str}=&symbclean($thisfn);
1.539 albertel 6311: }
1.242 www 6312: }
1.44 www 6313: $thisfn=declutter($thisfn);
1.31 www 6314: my %hash;
1.37 www 6315: my %bighash;
6316: my $syval='';
1.620 albertel 6317: if (($env{'request.course.fn'}) && ($thisfn)) {
1.481 raeburn 6318: my $targetfn = $thisfn;
1.609 banghart 6319: if ( ($thisfn =~ m/^(uploaded|editupload)\//) && ($thisfn !~ m/\.(page|sequence)$/) ) {
1.481 raeburn 6320: $targetfn = 'adm/wrapper/'.$thisfn;
6321: }
1.687 albertel 6322: if ($targetfn =~ m|^adm/wrapper/(ext/.*)|) {
6323: $targetfn=$1;
6324: }
1.620 albertel 6325: if (tie(%hash,'GDBM_File',$env{'request.course.fn'}.'_symb.db',
1.256 albertel 6326: &GDBM_READER(),0640)) {
1.481 raeburn 6327: $syval=$hash{$targetfn};
1.37 www 6328: untie(%hash);
6329: }
6330: # ---------------------------------------------------------- There was an entry
6331: if ($syval) {
1.601 albertel 6332: #unless ($syval=~/\_\d+$/) {
1.620 albertel 6333: #unless ($env{'form.request.prefix'}=~/\.(\d+)\_$/) {
1.601 albertel 6334: #&appenv('request.ambiguous' => $thisfn);
1.620 albertel 6335: #return $env{$cache_str}='';
1.601 albertel 6336: #}
6337: #$syval.=$1;
6338: #}
1.37 www 6339: } else {
6340: # ------------------------------------------------------- Was not in symb table
1.620 albertel 6341: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
1.256 albertel 6342: &GDBM_READER(),0640)) {
1.37 www 6343: # ---------------------------------------------- Get ID(s) for current resource
1.280 www 6344: my $ids=$bighash{'ids_'.&clutter($thisfn)};
1.65 www 6345: unless ($ids) {
6346: $ids=$bighash{'ids_/'.$thisfn};
1.242 www 6347: }
6348: unless ($ids) {
6349: # alias?
6350: $ids=$bighash{'mapalias_'.$thisfn};
1.65 www 6351: }
1.37 www 6352: if ($ids) {
6353: # ------------------------------------------------------------------- Has ID(s)
6354: my @possibilities=split(/\,/,$ids);
1.39 www 6355: if ($#possibilities==0) {
6356: # ----------------------------------------------- There is only one possibility
1.37 www 6357: my ($mapid,$resid)=split(/\./,$ids);
1.626 albertel 6358: $syval=&encode_symb($bighash{'map_id_'.$mapid},
6359: $resid,$thisfn);
1.249 www 6360: } elsif (!$donotrecurse) {
1.39 www 6361: # ------------------------------------------ There is more than one possibility
6362: my $realpossible=0;
1.191 harris41 6363: foreach (@possibilities) {
1.39 www 6364: my $file=$bighash{'src_'.$_};
6365: if (&allowed('bre',$file)) {
6366: my ($mapid,$resid)=split(/\./,$_);
6367: if ($bighash{'map_type_'.$mapid} ne 'page') {
6368: $realpossible++;
1.626 albertel 6369: $syval=&encode_symb($bighash{'map_id_'.$mapid},
6370: $resid,$thisfn);
1.39 www 6371: }
6372: }
1.191 harris41 6373: }
1.39 www 6374: if ($realpossible!=1) { $syval=''; }
1.249 www 6375: } else {
6376: $syval='';
1.37 www 6377: }
6378: }
6379: untie(%bighash)
1.481 raeburn 6380: }
1.31 www 6381: }
1.62 www 6382: if ($syval) {
1.620 albertel 6383: return $env{$cache_str}=$syval;
1.62 www 6384: }
1.31 www 6385: }
1.44 www 6386: &appenv('request.ambiguous' => $thisfn);
1.620 albertel 6387: return $env{$cache_str}='';
1.31 www 6388: }
6389:
6390: # ---------------------------------------------------------- Return random seed
6391:
1.32 www 6392: sub numval {
6393: my $txt=shift;
6394: $txt=~tr/A-J/0-9/;
6395: $txt=~tr/a-j/0-9/;
6396: $txt=~tr/K-T/0-9/;
6397: $txt=~tr/k-t/0-9/;
6398: $txt=~tr/U-Z/0-5/;
6399: $txt=~tr/u-z/0-5/;
6400: $txt=~s/\D//g;
1.564 albertel 6401: if ($_64bit) { if ($txt > 2**32) { return -1; } }
1.32 www 6402: return int($txt);
1.368 albertel 6403: }
6404:
1.484 albertel 6405: sub numval2 {
6406: my $txt=shift;
6407: $txt=~tr/A-J/0-9/;
6408: $txt=~tr/a-j/0-9/;
6409: $txt=~tr/K-T/0-9/;
6410: $txt=~tr/k-t/0-9/;
6411: $txt=~tr/U-Z/0-5/;
6412: $txt=~tr/u-z/0-5/;
6413: $txt=~s/\D//g;
6414: my @txts=split(/(\d\d\d\d\d\d\d\d\d)/,$txt);
6415: my $total;
6416: foreach my $val (@txts) { $total+=$val; }
1.564 albertel 6417: if ($_64bit) { if ($total > 2**32) { return -1; } }
1.484 albertel 6418: return int($total);
6419: }
6420:
1.575 albertel 6421: sub numval3 {
6422: use integer;
6423: my $txt=shift;
6424: $txt=~tr/A-J/0-9/;
6425: $txt=~tr/a-j/0-9/;
6426: $txt=~tr/K-T/0-9/;
6427: $txt=~tr/k-t/0-9/;
6428: $txt=~tr/U-Z/0-5/;
6429: $txt=~tr/u-z/0-5/;
6430: $txt=~s/\D//g;
6431: my @txts=split(/(\d\d\d\d\d\d\d\d\d)/,$txt);
6432: my $total;
6433: foreach my $val (@txts) { $total+=$val; }
6434: if ($_64bit) { $total=(($total<<32)>>32); }
6435: return $total;
6436: }
6437:
1.675 albertel 6438: sub digest {
6439: my ($data)=@_;
6440: my $digest=&Digest::MD5::md5($data);
6441: my ($a,$b,$c,$d)=unpack("iiii",$digest);
6442: my ($e,$f);
6443: {
6444: use integer;
6445: $e=($a+$b);
6446: $f=($c+$d);
6447: if ($_64bit) {
6448: $e=(($e<<32)>>32);
6449: $f=(($f<<32)>>32);
6450: }
6451: }
6452: if (wantarray) {
6453: return ($e,$f);
6454: } else {
6455: my $g;
6456: {
6457: use integer;
6458: $g=($e+$f);
6459: if ($_64bit) {
6460: $g=(($g<<32)>>32);
6461: }
6462: }
6463: return $g;
6464: }
6465: }
6466:
1.368 albertel 6467: sub latest_rnd_algorithm_id {
1.675 albertel 6468: return '64bit5';
1.366 albertel 6469: }
1.32 www 6470:
1.503 albertel 6471: sub get_rand_alg {
6472: my ($courseid)=@_;
6473: if (!$courseid) { $courseid=(&Apache::lonxml::whichuser())[1]; }
6474: if ($courseid) {
1.620 albertel 6475: return $env{"course.$courseid.rndseed"};
1.503 albertel 6476: }
6477: return &latest_rnd_algorithm_id();
6478: }
6479:
1.562 albertel 6480: sub validCODE {
6481: my ($CODE)=@_;
6482: if (defined($CODE) && $CODE ne '' && $CODE =~ /^\w+$/) { return 1; }
6483: return 0;
6484: }
6485:
1.491 albertel 6486: sub getCODE {
1.620 albertel 6487: if (&validCODE($env{'form.CODE'})) { return $env{'form.CODE'}; }
1.618 albertel 6488: if ( (defined($Apache::lonhomework::parsing_a_problem) ||
6489: defined($Apache::lonhomework::parsing_a_task) ) &&
6490: &validCODE($Apache::lonhomework::history{'resource.CODE'})) {
1.491 albertel 6491: return $Apache::lonhomework::history{'resource.CODE'};
6492: }
6493: return undef;
6494: }
6495:
1.31 www 6496: sub rndseed {
1.155 albertel 6497: my ($symb,$courseid,$domain,$username)=@_;
1.366 albertel 6498:
6499: my ($wsymb,$wcourseid,$wdomain,$wusername)=&Apache::lonxml::whichuser();
1.155 albertel 6500: if (!$symb) {
1.366 albertel 6501: unless ($symb=$wsymb) { return time; }
6502: }
6503: if (!$courseid) { $courseid=$wcourseid; }
6504: if (!$domain) { $domain=$wdomain; }
6505: if (!$username) { $username=$wusername }
1.503 albertel 6506: my $which=&get_rand_alg();
1.491 albertel 6507: if (defined(&getCODE())) {
1.675 albertel 6508: if ($which eq '64bit5') {
6509: return &rndseed_CODE_64bit5($symb,$courseid,$domain,$username);
6510: } elsif ($which eq '64bit4') {
1.575 albertel 6511: return &rndseed_CODE_64bit4($symb,$courseid,$domain,$username);
6512: } else {
6513: return &rndseed_CODE_64bit($symb,$courseid,$domain,$username);
6514: }
1.675 albertel 6515: } elsif ($which eq '64bit5') {
6516: return &rndseed_64bit5($symb,$courseid,$domain,$username);
1.575 albertel 6517: } elsif ($which eq '64bit4') {
6518: return &rndseed_64bit4($symb,$courseid,$domain,$username);
1.501 albertel 6519: } elsif ($which eq '64bit3') {
6520: return &rndseed_64bit3($symb,$courseid,$domain,$username);
1.443 albertel 6521: } elsif ($which eq '64bit2') {
6522: return &rndseed_64bit2($symb,$courseid,$domain,$username);
1.366 albertel 6523: } elsif ($which eq '64bit') {
6524: return &rndseed_64bit($symb,$courseid,$domain,$username);
6525: }
6526: return &rndseed_32bit($symb,$courseid,$domain,$username);
6527: }
6528:
6529: sub rndseed_32bit {
6530: my ($symb,$courseid,$domain,$username)=@_;
6531: {
6532: use integer;
6533: my $symbchck=unpack("%32C*",$symb) << 27;
6534: my $symbseed=numval($symb) << 22;
6535: my $namechck=unpack("%32C*",$username) << 17;
6536: my $nameseed=numval($username) << 12;
6537: my $domainseed=unpack("%32C*",$domain) << 7;
6538: my $courseseed=unpack("%32C*",$courseid);
6539: my $num=$symbseed+$nameseed+$domainseed+$courseseed+$namechck+$symbchck;
6540: #&Apache::lonxml::debug("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
6541: #&Apache::lonxml::debug("rndseed :$num:$symb");
1.564 albertel 6542: if ($_64bit) { $num=(($num<<32)>>32); }
1.366 albertel 6543: return $num;
6544: }
6545: }
6546:
6547: sub rndseed_64bit {
6548: my ($symb,$courseid,$domain,$username)=@_;
6549: {
6550: use integer;
6551: my $symbchck=unpack("%32S*",$symb) << 21;
6552: my $symbseed=numval($symb) << 10;
6553: my $namechck=unpack("%32S*",$username);
6554:
6555: my $nameseed=numval($username) << 21;
6556: my $domainseed=unpack("%32S*",$domain) << 10;
6557: my $courseseed=unpack("%32S*",$courseid);
6558:
6559: my $num1=$symbchck+$symbseed+$namechck;
6560: my $num2=$nameseed+$domainseed+$courseseed;
6561: #&Apache::lonxml::debug("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
6562: #&Apache::lonxml::debug("rndseed :$num:$symb");
1.564 albertel 6563: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
6564: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
1.366 albertel 6565: return "$num1,$num2";
1.155 albertel 6566: }
1.366 albertel 6567: }
6568:
1.443 albertel 6569: sub rndseed_64bit2 {
6570: my ($symb,$courseid,$domain,$username)=@_;
6571: {
6572: use integer;
6573: # strings need to be an even # of cahracters long, it it is odd the
6574: # last characters gets thrown away
6575: my $symbchck=unpack("%32S*",$symb.' ') << 21;
6576: my $symbseed=numval($symb) << 10;
6577: my $namechck=unpack("%32S*",$username.' ');
6578:
6579: my $nameseed=numval($username) << 21;
1.501 albertel 6580: my $domainseed=unpack("%32S*",$domain.' ') << 10;
6581: my $courseseed=unpack("%32S*",$courseid.' ');
6582:
6583: my $num1=$symbchck+$symbseed+$namechck;
6584: my $num2=$nameseed+$domainseed+$courseseed;
6585: #&Apache::lonxml::debug("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
6586: #&Apache::lonxml::debug("rndseed :$num:$symb");
6587: return "$num1,$num2";
6588: }
6589: }
6590:
6591: sub rndseed_64bit3 {
6592: my ($symb,$courseid,$domain,$username)=@_;
6593: {
6594: use integer;
6595: # strings need to be an even # of cahracters long, it it is odd the
6596: # last characters gets thrown away
6597: my $symbchck=unpack("%32S*",$symb.' ') << 21;
6598: my $symbseed=numval2($symb) << 10;
6599: my $namechck=unpack("%32S*",$username.' ');
6600:
6601: my $nameseed=numval2($username) << 21;
1.443 albertel 6602: my $domainseed=unpack("%32S*",$domain.' ') << 10;
6603: my $courseseed=unpack("%32S*",$courseid.' ');
6604:
6605: my $num1=$symbchck+$symbseed+$namechck;
6606: my $num2=$nameseed+$domainseed+$courseseed;
6607: #&Apache::lonxml::debug("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
1.564 albertel 6608: #&Apache::lonxml::debug("rndseed :$num1:$num2:$_64bit");
6609: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
6610:
1.503 albertel 6611: return "$num1:$num2";
1.443 albertel 6612: }
6613: }
6614:
1.575 albertel 6615: sub rndseed_64bit4 {
6616: my ($symb,$courseid,$domain,$username)=@_;
6617: {
6618: use integer;
6619: # strings need to be an even # of cahracters long, it it is odd the
6620: # last characters gets thrown away
6621: my $symbchck=unpack("%32S*",$symb.' ') << 21;
6622: my $symbseed=numval3($symb) << 10;
6623: my $namechck=unpack("%32S*",$username.' ');
6624:
6625: my $nameseed=numval3($username) << 21;
6626: my $domainseed=unpack("%32S*",$domain.' ') << 10;
6627: my $courseseed=unpack("%32S*",$courseid.' ');
6628:
6629: my $num1=$symbchck+$symbseed+$namechck;
6630: my $num2=$nameseed+$domainseed+$courseseed;
6631: #&Apache::lonxml::debug("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
6632: #&Apache::lonxml::debug("rndseed :$num1:$num2:$_64bit");
6633: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
6634:
6635: return "$num1:$num2";
6636: }
6637: }
6638:
1.675 albertel 6639: sub rndseed_64bit5 {
6640: my ($symb,$courseid,$domain,$username)=@_;
6641: my ($num1,$num2)=&digest("$symb,$courseid,$domain,$username");
6642: return "$num1:$num2";
6643: }
6644:
1.366 albertel 6645: sub rndseed_CODE_64bit {
6646: my ($symb,$courseid,$domain,$username)=@_;
1.155 albertel 6647: {
1.366 albertel 6648: use integer;
1.443 albertel 6649: my $symbchck=unpack("%32S*",$symb.' ') << 16;
1.484 albertel 6650: my $symbseed=numval2($symb);
1.491 albertel 6651: my $CODEchck=unpack("%32S*",&getCODE().' ') << 16;
6652: my $CODEseed=numval(&getCODE());
1.443 albertel 6653: my $courseseed=unpack("%32S*",$courseid.' ');
1.484 albertel 6654: my $num1=$symbseed+$CODEchck;
6655: my $num2=$CODEseed+$courseseed+$symbchck;
6656: #&Apache::lonxml::debug("$symbseed:$CODEchck|$CODEseed:$courseseed:$symbchck");
1.366 albertel 6657: #&Apache::lonxml::debug("rndseed :$num1:$num2:$symb");
1.564 albertel 6658: if ($_64bit) { $num1=(($num1<<32)>>32); }
6659: if ($_64bit) { $num2=(($num2<<32)>>32); }
1.503 albertel 6660: return "$num1:$num2";
1.366 albertel 6661: }
6662: }
6663:
1.575 albertel 6664: sub rndseed_CODE_64bit4 {
6665: my ($symb,$courseid,$domain,$username)=@_;
6666: {
6667: use integer;
6668: my $symbchck=unpack("%32S*",$symb.' ') << 16;
6669: my $symbseed=numval3($symb);
6670: my $CODEchck=unpack("%32S*",&getCODE().' ') << 16;
6671: my $CODEseed=numval3(&getCODE());
6672: my $courseseed=unpack("%32S*",$courseid.' ');
6673: my $num1=$symbseed+$CODEchck;
6674: my $num2=$CODEseed+$courseseed+$symbchck;
6675: #&Apache::lonxml::debug("$symbseed:$CODEchck|$CODEseed:$courseseed:$symbchck");
6676: #&Apache::lonxml::debug("rndseed :$num1:$num2:$symb");
6677: if ($_64bit) { $num1=(($num1<<32)>>32); }
6678: if ($_64bit) { $num2=(($num2<<32)>>32); }
6679: return "$num1:$num2";
6680: }
6681: }
6682:
1.675 albertel 6683: sub rndseed_CODE_64bit5 {
6684: my ($symb,$courseid,$domain,$username)=@_;
6685: my $code = &getCODE();
6686: my ($num1,$num2)=&digest("$symb,$courseid,$code");
6687: return "$num1:$num2";
6688: }
6689:
1.366 albertel 6690: sub setup_random_from_rndseed {
6691: my ($rndseed)=@_;
1.503 albertel 6692: if ($rndseed =~/([,:])/) {
6693: my ($num1,$num2)=split(/[,:]/,$rndseed);
1.366 albertel 6694: &Math::Random::random_set_seed(abs($num1),abs($num2));
6695: } else {
6696: &Math::Random::random_set_seed_from_phrase($rndseed);
1.98 albertel 6697: }
1.36 albertel 6698: }
6699:
1.474 albertel 6700: sub latest_receipt_algorithm_id {
6701: return 'receipt2';
6702: }
6703:
1.480 www 6704: sub recunique {
6705: my $fucourseid=shift;
6706: my $unique;
1.620 albertel 6707: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2') {
6708: $unique=$env{"course.$fucourseid.internal.encseed"};
1.480 www 6709: } else {
6710: $unique=$perlvar{'lonReceipt'};
6711: }
6712: return unpack("%32C*",$unique);
6713: }
6714:
6715: sub recprefix {
6716: my $fucourseid=shift;
6717: my $prefix;
1.620 albertel 6718: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2') {
6719: $prefix=$env{"course.$fucourseid.internal.encpref"};
1.480 www 6720: } else {
6721: $prefix=$perlvar{'lonHostID'};
6722: }
6723: return unpack("%32C*",$prefix);
6724: }
6725:
1.76 www 6726: sub ireceipt {
1.474 albertel 6727: my ($funame,$fudom,$fucourseid,$fusymb,$part)=@_;
1.76 www 6728: my $cuname=unpack("%32C*",$funame);
6729: my $cudom=unpack("%32C*",$fudom);
6730: my $cucourseid=unpack("%32C*",$fucourseid);
6731: my $cusymb=unpack("%32C*",$fusymb);
1.480 www 6732: my $cunique=&recunique($fucourseid);
1.474 albertel 6733: my $cpart=unpack("%32S*",$part);
1.480 www 6734: my $return =&recprefix($fucourseid).'-';
1.620 albertel 6735: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2' ||
6736: $env{'request.state'} eq 'construct') {
1.474 albertel 6737: &Apache::lonxml::debug("doing receipt2 using parts $cpart, uname $cuname and udom $cudom gets ".($cpart%$cuname).
6738: " and ".($cpart%$cudom));
6739:
6740: $return.= ($cunique%$cuname+
6741: $cunique%$cudom+
6742: $cusymb%$cuname+
6743: $cusymb%$cudom+
6744: $cucourseid%$cuname+
6745: $cucourseid%$cudom+
6746: $cpart%$cuname+
6747: $cpart%$cudom);
6748: } else {
6749: $return.= ($cunique%$cuname+
6750: $cunique%$cudom+
6751: $cusymb%$cuname+
6752: $cusymb%$cudom+
6753: $cucourseid%$cuname+
6754: $cucourseid%$cudom);
6755: }
6756: return $return;
1.76 www 6757: }
6758:
6759: sub receipt {
1.474 albertel 6760: my ($part)=@_;
6761: my ($symb,$courseid,$domain,$name) = &Apache::lonxml::whichuser();
6762: return &ireceipt($name,$domain,$courseid,$symb,$part);
1.76 www 6763: }
1.260 ng 6764:
1.36 albertel 6765: # ------------------------------------------------------------ Serves up a file
1.472 albertel 6766: # returns either the contents of the file or
6767: # -1 if the file doesn't exist
1.481 raeburn 6768: #
6769: # if the target is a file that was uploaded via DOCS,
6770: # a check will be made to see if a current copy exists on the local server,
6771: # if it does this will be served, otherwise a copy will be retrieved from
6772: # the home server for the course and stored in /home/httpd/html/userfiles on
6773: # the local server.
1.472 albertel 6774:
1.36 albertel 6775: sub getfile {
1.538 albertel 6776: my ($file) = @_;
1.609 banghart 6777: if ($file =~ m -^/*(uploaded|editupload)/-) { $file=&filelocation("",$file); }
1.538 albertel 6778: &repcopy($file);
6779: return &readfile($file);
6780: }
6781:
6782: sub repcopy_userfile {
6783: my ($file)=@_;
1.609 banghart 6784: if ($file =~ m -^/*(uploaded|editupload)/-) { $file=&filelocation("",$file); }
1.610 albertel 6785: if ($file =~ m|^/home/httpd/html/lonUsers/|) { return 'ok'; }
1.538 albertel 6786: my ($cdom,$cnum,$filename) =
6787: ($file=~m|^\Q$perlvar{'lonDocRoot'}\E/+userfiles/+([^/]+)/+([^/]+)/+(.*)|);
6788: my ($info,$rtncode);
6789: my $uri="/uploaded/$cdom/$cnum/$filename";
6790: if (-e "$file") {
6791: my @fileinfo = stat($file);
6792: my $lwpresp = &getuploaded('HEAD',$uri,$cdom,$cnum,\$info,\$rtncode);
1.482 albertel 6793: if ($lwpresp ne 'ok') {
6794: if ($rtncode eq '404') {
1.538 albertel 6795: unlink($file);
1.482 albertel 6796: }
1.517 albertel 6797: #my $ua=new LWP::UserAgent;
1.538 albertel 6798: #my $request=new HTTP::Request('GET',&tokenwrapper($uri));
1.517 albertel 6799: #my $response=$ua->request($request);
6800: #if ($response->is_success()) {
6801: # return $response->content;
6802: # } else {
6803: # return -1;
6804: # }
1.482 albertel 6805: return -1;
6806: }
6807: if ($info < $fileinfo[9]) {
1.607 raeburn 6808: return 'ok';
1.482 albertel 6809: }
6810: $info = '';
1.538 albertel 6811: $lwpresp = &getuploaded('GET',$uri,$cdom,$cnum,\$info,\$rtncode);
1.482 albertel 6812: if ($lwpresp ne 'ok') {
6813: return -1;
6814: }
6815: } else {
1.538 albertel 6816: my $lwpresp = &getuploaded('GET',$uri,$cdom,$cnum,\$info,\$rtncode);
1.482 albertel 6817: if ($lwpresp ne 'ok') {
1.517 albertel 6818: my $ua=new LWP::UserAgent;
1.538 albertel 6819: my $request=new HTTP::Request('GET',&tokenwrapper($uri));
1.517 albertel 6820: my $response=$ua->request($request);
6821: if ($response->is_success()) {
1.538 albertel 6822: $info=$response->content;
1.517 albertel 6823: } else {
6824: return -1;
6825: }
1.482 albertel 6826: }
6827: my @parts = ($cdom,$cnum);
6828: if ($filename =~ m|^(.+)/[^/]+$|) {
6829: push @parts, split(/\//,$1);
1.518 albertel 6830: }
1.538 albertel 6831: my $path = $perlvar{'lonDocRoot'}.'/userfiles';
1.482 albertel 6832: foreach my $part (@parts) {
6833: $path .= '/'.$part;
6834: if (!-e $path) {
6835: mkdir($path,0770);
6836: }
6837: }
6838: }
1.538 albertel 6839: open(FILE,">$file");
1.482 albertel 6840: print FILE $info;
6841: close(FILE);
1.607 raeburn 6842: return 'ok';
1.481 raeburn 6843: }
6844:
1.517 albertel 6845: sub tokenwrapper {
6846: my $uri=shift;
1.552 albertel 6847: $uri=~s|^http\://([^/]+)||;
6848: $uri=~s|^/||;
1.620 albertel 6849: $env{'user.environment'}=~/\/([^\/]+)\.id/;
1.517 albertel 6850: my $token=$1;
1.552 albertel 6851: my (undef,$udom,$uname,$file)=split('/',$uri,4);
6852: if ($udom && $uname && $file) {
6853: $file=~s|(\?\.*)*$||;
1.620 albertel 6854: &appenv("userfile.$udom/$uname/$file" => $env{'request.course.id'});
1.552 albertel 6855: return 'http://'.$hostname{ &homeserver($uname,$udom)}.'/'.$uri.
1.517 albertel 6856: (($uri=~/\?/)?'&':'?').'token='.$token.
6857: '&tokenissued='.$perlvar{'lonHostID'};
6858: } else {
6859: return '/adm/notfound.html';
6860: }
6861: }
6862:
1.481 raeburn 6863: sub getuploaded {
6864: my ($reqtype,$uri,$cdom,$cnum,$info,$rtncode) = @_;
6865: $uri=~s/^\///;
6866: $uri = 'http://'.$hostname{ &homeserver($cnum,$cdom)}.'/raw/'.$uri;
6867: my $ua=new LWP::UserAgent;
6868: my $request=new HTTP::Request($reqtype,$uri);
6869: my $response=$ua->request($request);
6870: $$rtncode = $response->code;
1.482 albertel 6871: if (! $response->is_success()) {
6872: return 'failed';
6873: }
6874: if ($reqtype eq 'HEAD') {
1.486 www 6875: $$info = &HTTP::Date::str2time( $response->header('Last-modified') );
1.482 albertel 6876: } elsif ($reqtype eq 'GET') {
6877: $$info = $response->content;
1.472 albertel 6878: }
1.482 albertel 6879: return 'ok';
1.36 albertel 6880: }
6881:
1.481 raeburn 6882: sub readfile {
6883: my $file = shift;
6884: if ( (! -e $file ) || ($file eq '') ) { return -1; };
6885: my $fh;
6886: open($fh,"<$file");
6887: my $a='';
6888: while (<$fh>) { $a .=$_; }
6889: return $a;
6890: }
6891:
1.36 albertel 6892: sub filelocation {
1.590 banghart 6893: my ($dir,$file) = @_;
6894: my $location;
6895: $file=~ s/^\s*(\S+)\s*$/$1/; ## strip off leading and trailing spaces
1.700 albertel 6896:
6897: if ($file =~ m-^/adm/-) {
6898: $file=~s-^/adm/wrapper/-/-;
6899: $file=~s-^/adm/coursedocs/showdoc/-/-;
6900: }
1.590 banghart 6901: if ($file=~m:^/~:) { # is a contruction space reference
6902: $location = $file;
6903: $location =~ s:/~(.*?)/(.*):/home/$1/public_html/$2:;
1.649 albertel 6904: } elsif ($file=~m:^/home/[^/]*/public_html/:) {
6905: # is a correct contruction space reference
6906: $location = $file;
1.609 banghart 6907: } elsif ($file=~/^\/*(uploaded|editupload)/) { # is an uploaded file
1.590 banghart 6908: my ($udom,$uname,$filename)=
1.609 banghart 6909: ($file=~m -^/+(?:uploaded|editupload)/+([^/]+)/+([^/]+)/+(.*)$-);
1.590 banghart 6910: my $home=&homeserver($uname,$udom);
6911: my $is_me=0;
6912: my @ids=¤t_machine_ids();
6913: foreach my $id (@ids) { if ($id eq $home) { $is_me=1; } }
6914: if ($is_me) {
1.740 www 6915: $location=&propath($udom,$uname).
1.590 banghart 6916: '/userfiles/'.$filename;
6917: } else {
6918: $location=$Apache::lonnet::perlvar{'lonDocRoot'}.'/userfiles/'.
6919: $udom.'/'.$uname.'/'.$filename;
6920: }
6921: } else {
6922: $file=~s/^\Q$perlvar{'lonDocRoot'}\E//;
6923: $file=~s:^/res/:/:;
6924: if ( !( $file =~ m:^/:) ) {
6925: $location = $dir. '/'.$file;
6926: } else {
6927: $location = '/home/httpd/html/res'.$file;
6928: }
1.59 albertel 6929: }
1.590 banghart 6930: $location=~s://+:/:g; # remove duplicate /
6931: while ($location=~m:/\.\./:) {$location=~ s:/[^/]+/\.\./:/:g;} #remove dir/..
6932: while ($location=~m:/\./:) {$location=~ s:/\./:/:g;} #remove /./
6933: return $location;
1.46 www 6934: }
1.36 albertel 6935:
1.46 www 6936: sub hreflocation {
6937: my ($dir,$file)=@_;
1.460 albertel 6938: unless (($file=~m-^http://-i) || ($file=~m-^/-)) {
1.666 albertel 6939: $file=filelocation($dir,$file);
1.700 albertel 6940: } elsif ($file=~m-^/adm/-) {
6941: $file=~s-^/adm/wrapper/-/-;
6942: $file=~s-^/adm/coursedocs/showdoc/-/-;
1.666 albertel 6943: }
6944: if ($file=~m-^\Q$perlvar{'lonDocRoot'}\E-) {
6945: $file=~s-^\Q$perlvar{'lonDocRoot'}\E--;
6946: } elsif ($file=~m-/home/(\w+)/public_html/-) {
1.462 albertel 6947: $file=~s-^/home/(\w+)/public_html/-/~$1/-;
1.666 albertel 6948: } elsif ($file=~m-^\Q$perlvar{'lonUsersDir'}\E-) {
6949: $file=~s-^/home/httpd/lonUsers/([^/]*)/./././([^/]*)/userfiles/
6950: -/uploaded/$1/$2/-x;
1.46 www 6951: }
1.462 albertel 6952: return $file;
1.465 albertel 6953: }
6954:
6955: sub current_machine_domains {
6956: my $hostname=$hostname{$perlvar{'lonHostID'}};
6957: my @domains;
6958: while( my($id, $name) = each(%hostname)) {
1.467 matthew 6959: # &logthis("-$id-$name-$hostname-");
1.465 albertel 6960: if ($hostname eq $name) {
6961: push(@domains,$hostdom{$id});
6962: }
6963: }
6964: return @domains;
6965: }
6966:
6967: sub current_machine_ids {
6968: my $hostname=$hostname{$perlvar{'lonHostID'}};
6969: my @ids;
6970: while( my($id, $name) = each(%hostname)) {
1.467 matthew 6971: # &logthis("-$id-$name-$hostname-");
1.465 albertel 6972: if ($hostname eq $name) {
6973: push(@ids,$id);
6974: }
6975: }
6976: return @ids;
1.31 www 6977: }
6978:
6979: # ------------------------------------------------------------- Declutters URLs
6980:
6981: sub declutter {
6982: my $thisfn=shift;
1.569 albertel 6983: if ($thisfn=~m|^/enc/|) { $thisfn=&Apache::lonenc::unencrypted($thisfn); }
1.479 albertel 6984: $thisfn=~s/^\Q$perlvar{'lonDocRoot'}\E//;
1.31 www 6985: $thisfn=~s/^\///;
1.697 albertel 6986: $thisfn=~s|^adm/wrapper/||;
6987: $thisfn=~s|^adm/coursedocs/showdoc/||;
1.31 www 6988: $thisfn=~s/^res\///;
1.235 www 6989: $thisfn=~s/\?.+$//;
1.268 www 6990: return $thisfn;
6991: }
6992:
6993: # ------------------------------------------------------------- Clutter up URLs
6994:
6995: sub clutter {
6996: my $thisfn='/'.&declutter(shift);
1.609 banghart 6997: unless ($thisfn=~/^\/(uploaded|editupload|adm|userfiles|ext|raw|priv|public)\//) {
1.270 www 6998: $thisfn='/res'.$thisfn;
6999: }
1.694 albertel 7000: if ($thisfn !~m|/adm|) {
1.695 albertel 7001: if ($thisfn =~ m|/ext/|) {
1.694 albertel 7002: $thisfn='/adm/wrapper'.$thisfn;
1.695 albertel 7003: } else {
7004: my ($ext) = ($thisfn =~ /\.(\w+)$/);
7005: my $embstyle=&Apache::loncommon::fileembstyle($ext);
1.698 albertel 7006: if ($embstyle eq 'ssi'
7007: || ($embstyle eq 'hdn')
7008: || ($embstyle eq 'rat')
7009: || ($embstyle eq 'prv')
7010: || ($embstyle eq 'ign')) {
7011: #do nothing with these
7012: } elsif (($embstyle eq 'img')
1.695 albertel 7013: || ($embstyle eq 'emb')
7014: || ($embstyle eq 'wrp')) {
7015: $thisfn='/adm/wrapper'.$thisfn;
1.698 albertel 7016: } elsif ($embstyle eq 'unk'
7017: && $thisfn!~/\.(sequence|page)$/) {
1.695 albertel 7018: $thisfn='/adm/coursedocs/showdoc'.$thisfn;
1.698 albertel 7019: } else {
1.718 www 7020: # &logthis("Got a blank emb style");
1.695 albertel 7021: }
1.694 albertel 7022: }
7023: }
1.31 www 7024: return $thisfn;
1.12 www 7025: }
7026:
1.557 albertel 7027: sub freeze_escape {
7028: my ($value)=@_;
7029: if (ref($value)) {
7030: $value=&nfreeze($value);
7031: return '__FROZEN__'.&escape($value);
7032: }
7033: return &escape($value);
7034: }
7035:
1.11 www 7036:
1.557 albertel 7037: sub thaw_unescape {
7038: my ($value)=@_;
7039: if ($value =~ /^__FROZEN__/) {
7040: substr($value,0,10,undef);
7041: $value=&unescape($value);
7042: return &thaw($value);
7043: }
7044: return &unescape($value);
7045: }
7046:
1.436 albertel 7047: sub correct_line_ends {
7048: my ($result)=@_;
7049: $$result =~s/\r\n/\n/mg;
7050: $$result =~s/\r/\n/mg;
1.415 albertel 7051: }
1.1 albertel 7052: # ================================================================ Main Program
7053:
1.184 www 7054: sub goodbye {
1.204 albertel 7055: &logthis("Starting Shut down");
1.443 albertel 7056: #not converted to using infrastruture and probably shouldn't be
1.599 albertel 7057: &logthis(sprintf("%-20s is %s",'%badServerCache',length(&freeze(\%badServerCache))));
1.443 albertel 7058: #converted
1.599 albertel 7059: # &logthis(sprintf("%-20s is %s",'%metacache',scalar(%metacache)));
7060: &logthis(sprintf("%-20s is %s",'%homecache',length(&freeze(\%homecache))));
7061: # &logthis(sprintf("%-20s is %s",'%titlecache',length(&freeze(\%titlecache))));
7062: # &logthis(sprintf("%-20s is %s",'%courseresdatacache',length(&freeze(\%courseresdatacache))));
1.425 albertel 7063: #1.1 only
1.599 albertel 7064: # &logthis(sprintf("%-20s is %s",'%userresdatacache',length(&freeze(\%userresdatacache))));
7065: # &logthis(sprintf("%-20s is %s",'%getsectioncache',length(&freeze(\%getsectioncache))));
7066: # &logthis(sprintf("%-20s is %s",'%courseresversioncache',length(&freeze(\%courseresversioncache))));
7067: # &logthis(sprintf("%-20s is %s",'%resversioncache',length(&freeze(\%resversioncache))));
7068: &logthis(sprintf("%-20s is %s",'%remembered',length(&freeze(\%remembered))));
7069: &logthis(sprintf("%-20s is %s",'kicks',$kicks));
7070: &logthis(sprintf("%-20s is %s",'hits',$hits));
1.184 www 7071: &flushcourselogs();
7072: &logthis("Shutting down");
7073: }
7074:
1.179 www 7075: BEGIN {
1.228 harris41 7076: # ----------------------------------- Read loncapa.conf and loncapa_apache.conf
1.195 www 7077: unless ($readit) {
1.217 harris41 7078: {
1.581 matthew 7079: # FIXME: Use LONCAPA::Configuration::read_conf here and omit next block
1.448 albertel 7080: open(my $config,"</etc/httpd/conf/loncapa.conf");
1.217 harris41 7081:
7082: while (my $configline=<$config>) {
1.484 albertel 7083: if ($configline=~/\S/ && $configline =~ /^[^\#]*PerlSetVar/) {
1.1 albertel 7084: my ($dummy,$varname,$varvalue)=split(/\s+/,$configline);
1.8 www 7085: chomp($varvalue);
1.1 albertel 7086: $perlvar{$varname}=$varvalue;
7087: }
7088: }
1.448 albertel 7089: close($config);
1.1 albertel 7090: }
1.227 harris41 7091: {
1.448 albertel 7092: open(my $config,"</etc/httpd/conf/loncapa_apache.conf");
1.227 harris41 7093:
7094: while (my $configline=<$config>) {
7095: if ($configline =~ /^[^\#]*PerlSetVar/) {
7096: my ($dummy,$varname,$varvalue)=split(/\s+/,$configline);
7097: chomp($varvalue);
7098: $perlvar{$varname}=$varvalue;
7099: }
7100: }
1.448 albertel 7101: close($config);
1.227 harris41 7102: }
1.1 albertel 7103:
1.327 albertel 7104: # ------------------------------------------------------------ Read domain file
7105: {
7106: %domaindescription = ();
7107: %domain_auth_def = ();
7108: %domain_auth_arg_def = ();
1.448 albertel 7109: my $fh;
7110: if (open($fh,"<".$Apache::lonnet::perlvar{'lonTabDir'}.'/domain.tab')) {
1.327 albertel 7111: while (<$fh>) {
1.390 matthew 7112: next if (/^(\#|\s*$)/);
7113: # next if /^\#/;
1.327 albertel 7114: chomp;
1.403 www 7115: my ($domain, $domain_description, $def_auth, $def_auth_arg,
1.685 raeburn 7116: $def_lang, $city, $longi, $lati, $primary) = split(/:/,$_);
1.403 www 7117: $domain_auth_def{$domain}=$def_auth;
1.327 albertel 7118: $domain_auth_arg_def{$domain}=$def_auth_arg;
1.403 www 7119: $domaindescription{$domain}=$domain_description;
7120: $domain_lang_def{$domain}=$def_lang;
7121: $domain_city{$domain}=$city;
7122: $domain_longi{$domain}=$longi;
7123: $domain_lati{$domain}=$lati;
1.685 raeburn 7124: $domain_primary{$domain}=$primary;
1.403 www 7125:
1.448 albertel 7126: # &logthis("Domain.tab: $domain, $domain_auth_def{$domain}, $domain_auth_arg_def{$domain},$domaindescription{$domain}");
1.327 albertel 7127: # &logthis("Domain.tab: $domain ".$domaindescription{$domain} );
1.448 albertel 7128: }
1.327 albertel 7129: }
1.448 albertel 7130: close ($fh);
1.327 albertel 7131: }
7132:
7133:
1.1 albertel 7134: # ------------------------------------------------------------- Read hosts file
7135: {
1.448 albertel 7136: open(my $config,"<$perlvar{'lonTabDir'}/hosts.tab");
1.1 albertel 7137:
7138: while (my $configline=<$config>) {
1.303 matthew 7139: next if ($configline =~ /^(\#|\s*$)/);
1.154 www 7140: chomp($configline);
1.595 albertel 7141: my ($id,$domain,$role,$name)=split(/:/,$configline);
1.597 albertel 7142: $name=~s/\s//g;
1.595 albertel 7143: if ($id && $domain && $role && $name) {
1.252 albertel 7144: $hostname{$id}=$name;
7145: $hostdom{$id}=$domain;
7146: if ($role eq 'library') { $libserv{$id}=$name; }
1.245 www 7147: }
1.1 albertel 7148: }
1.448 albertel 7149: close($config);
1.619 albertel 7150: # FIXME: dev server don't want this, production servers _do_ want this
1.654 albertel 7151: #&get_iphost();
1.1 albertel 7152: }
7153:
1.598 albertel 7154: sub get_iphost {
7155: if (%iphost) { return %iphost; }
1.653 albertel 7156: my %name_to_ip;
1.598 albertel 7157: foreach my $id (keys(%hostname)) {
7158: my $name=$hostname{$id};
1.653 albertel 7159: my $ip;
7160: if (!exists($name_to_ip{$name})) {
7161: $ip = gethostbyname($name);
7162: if (!$ip || length($ip) ne 4) {
7163: &logthis("Skipping host $id name $name no IP found\n");
7164: next;
7165: }
7166: $ip=inet_ntoa($ip);
7167: $name_to_ip{$name} = $ip;
7168: } else {
7169: $ip = $name_to_ip{$name};
1.598 albertel 7170: }
7171: push(@{$iphost{$ip}},$id);
7172: }
7173: return %iphost;
7174: }
7175:
1.1 albertel 7176: # ------------------------------------------------------ Read spare server file
7177: {
1.448 albertel 7178: open(my $config,"<$perlvar{'lonTabDir'}/spare.tab");
1.1 albertel 7179:
7180: while (my $configline=<$config>) {
7181: chomp($configline);
1.284 matthew 7182: if ($configline) {
1.1 albertel 7183: $spareid{$configline}=1;
7184: }
7185: }
1.448 albertel 7186: close($config);
1.1 albertel 7187: }
1.11 www 7188: # ------------------------------------------------------------ Read permissions
7189: {
1.448 albertel 7190: open(my $config,"<$perlvar{'lonTabDir'}/roles.tab");
1.11 www 7191:
7192: while (my $configline=<$config>) {
1.448 albertel 7193: chomp($configline);
7194: if ($configline) {
7195: my ($role,$perm)=split(/ /,$configline);
7196: if ($perm ne '') { $pr{$role}=$perm; }
7197: }
1.11 www 7198: }
1.448 albertel 7199: close($config);
1.11 www 7200: }
7201:
7202: # -------------------------------------------- Read plain texts for permissions
7203: {
1.448 albertel 7204: open(my $config,"<$perlvar{'lonTabDir'}/rolesplain.tab");
1.11 www 7205:
7206: while (my $configline=<$config>) {
1.448 albertel 7207: chomp($configline);
7208: if ($configline) {
1.742 raeburn 7209: my ($short,@plain)=split(/:/,$configline);
7210: %{$prp{$short}} = ();
7211: if (@plain > 0) {
7212: $prp{$short}{'std'} = $plain[0];
7213: for (my $i=1; $i<@plain; $i++) {
7214: $prp{$short}{'alt'.$i} = $plain[$i];
7215: }
7216: }
1.448 albertel 7217: }
1.135 www 7218: }
1.448 albertel 7219: close($config);
1.135 www 7220: }
7221:
7222: # ---------------------------------------------------------- Read package table
7223: {
1.448 albertel 7224: open(my $config,"<$perlvar{'lonTabDir'}/packages.tab");
1.135 www 7225:
7226: while (my $configline=<$config>) {
1.483 albertel 7227: if ($configline !~ /\S/ || $configline=~/^#/) { next; }
1.448 albertel 7228: chomp($configline);
7229: my ($short,$plain)=split(/:/,$configline);
7230: my ($pack,$name)=split(/\&/,$short);
7231: if ($plain ne '') {
7232: $packagetab{$pack.'&'.$name.'&name'}=$name;
7233: $packagetab{$short}=$plain;
7234: }
1.11 www 7235: }
1.448 albertel 7236: close($config);
1.329 matthew 7237: }
7238:
7239: # ------------- set up temporary directory
7240: {
7241: $tmpdir = $perlvar{'lonDaemons'}.'/tmp/';
7242:
1.11 www 7243: }
7244:
1.599 albertel 7245: $memcache=new Cache::Memcached({'servers'=>['127.0.0.1:11211']});
1.185 www 7246:
1.281 www 7247: $processmarker='_'.time.'_'.$perlvar{'lonHostID'};
1.186 www 7248: $dumpcount=0;
1.22 www 7249:
1.163 harris41 7250: &logtouch();
1.672 albertel 7251: &logthis('<font color="yellow">INFO: Read configuration</font>');
1.195 www 7252: $readit=1;
1.564 albertel 7253: {
7254: use integer;
7255: my $test=(2**32)+1;
1.568 albertel 7256: if ($test != 0) { $_64bit=1; } else { $_64bit=0; }
1.564 albertel 7257: &logthis(" Detected 64bit platform ($_64bit)");
7258: }
1.195 www 7259: }
1.1 albertel 7260: }
1.179 www 7261:
1.1 albertel 7262: 1;
1.191 harris41 7263: __END__
7264:
1.243 albertel 7265: =pod
7266:
1.191 harris41 7267: =head1 NAME
7268:
1.243 albertel 7269: Apache::lonnet - Subroutines to ask questions about things in the network.
1.191 harris41 7270:
7271: =head1 SYNOPSIS
7272:
1.243 albertel 7273: Invoked by other LON-CAPA modules, when they need to talk to or about objects in the network.
1.191 harris41 7274:
7275: &Apache::lonnet::SUBROUTINENAME(ARGUMENTS);
7276:
1.243 albertel 7277: Common parameters:
7278:
7279: =over 4
7280:
7281: =item *
7282:
7283: $uname : an internal username (if $cname expecting a course Id specifically)
7284:
7285: =item *
7286:
7287: $udom : a domain (if $cdom expecting a course's domain specifically)
7288:
7289: =item *
7290:
7291: $symb : a resource instance identifier
7292:
7293: =item *
7294:
7295: $namespace : the name of a .db file that contains the data needed or
7296: being set.
7297:
7298: =back
7299:
1.394 bowersj2 7300: =head1 OVERVIEW
1.191 harris41 7301:
1.394 bowersj2 7302: lonnet provides subroutines which interact with the
7303: lonc/lond (TCP) network layer of LON-CAPA. They can be used to ask
7304: about classes, users, and resources.
1.243 albertel 7305:
7306: For many of these objects you can also use this to store data about
7307: them or modify them in various ways.
1.191 harris41 7308:
1.394 bowersj2 7309: =head2 Symbs
1.191 harris41 7310:
1.394 bowersj2 7311: To identify a specific instance of a resource, LON-CAPA uses symbols
7312: or "symbs"X<symb>. These identifiers are built from the URL of the
7313: map, the resource number of the resource in the map, and the URL of
7314: the resource itself. The latter is somewhat redundant, but might help
7315: if maps change.
7316:
7317: An example is
7318:
7319: msu/korte/parts/part1.sequence___19___msu/korte/tests/part12.problem
7320:
7321: The respective map entry is
7322:
7323: <resource id="19" src="/res/msu/korte/tests/part12.problem"
7324: title="Problem 2">
7325: </resource>
7326:
7327: Symbs are used by the random number generator, as well as to store and
7328: restore data specific to a certain instance of for example a problem.
7329:
7330: =head2 Storing And Retrieving Data
7331:
7332: X<store()>X<cstore()>X<restore()>Three of the most important functions
7333: in C<lonnet.pm> are C<&Apache::lonnet::cstore()>,
7334: C<&Apache::lonnet:restore()>, and C<&Apache::lonnet::store()>, which
7335: is is the non-critical message twin of cstore. These functions are for
7336: handlers to store a perl hash to a user's permanent data space in an
7337: easy manner, and to retrieve it again on another call. It is expected
7338: that a handler would use this once at the beginning to retrieve data,
7339: and then again once at the end to send only the new data back.
7340:
7341: The data is stored in the user's data directory on the user's
7342: homeserver under the ID of the course.
7343:
7344: The hash that is returned by restore will have all of the previous
7345: value for all of the elements of the hash.
7346:
7347: Example:
7348:
7349: #creating a hash
7350: my %hash;
7351: $hash{'foo'}='bar';
7352:
7353: #storing it
7354: &Apache::lonnet::cstore(\%hash);
7355:
7356: #changing a value
7357: $hash{'foo'}='notbar';
7358:
7359: #adding a new value
7360: $hash{'bar'}='foo';
7361: &Apache::lonnet::cstore(\%hash);
7362:
7363: #retrieving the hash
7364: my %history=&Apache::lonnet::restore();
7365:
7366: #print the hash
7367: foreach my $key (sort(keys(%history))) {
7368: print("\%history{$key} = $history{$key}");
7369: }
7370:
7371: Will print out:
1.191 harris41 7372:
1.394 bowersj2 7373: %history{1:foo} = bar
7374: %history{1:keys} = foo:timestamp
7375: %history{1:timestamp} = 990455579
7376: %history{2:bar} = foo
7377: %history{2:foo} = notbar
7378: %history{2:keys} = foo:bar:timestamp
7379: %history{2:timestamp} = 990455580
7380: %history{bar} = foo
7381: %history{foo} = notbar
7382: %history{timestamp} = 990455580
7383: %history{version} = 2
7384:
7385: Note that the special hash entries C<keys>, C<version> and
7386: C<timestamp> were added to the hash. C<version> will be equal to the
7387: total number of versions of the data that have been stored. The
7388: C<timestamp> attribute will be the UNIX time the hash was
7389: stored. C<keys> is available in every historical section to list which
7390: keys were added or changed at a specific historical revision of a
7391: hash.
7392:
7393: B<Warning>: do not store the hash that restore returns directly. This
7394: will cause a mess since it will restore the historical keys as if the
7395: were new keys. I.E. 1:foo will become 1:1:foo etc.
1.191 harris41 7396:
1.394 bowersj2 7397: Calling convention:
1.191 harris41 7398:
1.394 bowersj2 7399: my %record=&Apache::lonnet::restore($symb,$courseid,$domain,$uname,$home);
7400: &Apache::lonnet::cstore(\%newrecord,$symb,$courseid,$domain,$uname,$home);
1.191 harris41 7401:
1.394 bowersj2 7402: For more detailed information, see lonnet specific documentation.
1.191 harris41 7403:
1.394 bowersj2 7404: =head1 RETURN MESSAGES
1.191 harris41 7405:
1.394 bowersj2 7406: =over 4
1.191 harris41 7407:
1.394 bowersj2 7408: =item * B<con_lost>: unable to contact remote host
1.191 harris41 7409:
1.394 bowersj2 7410: =item * B<con_delayed>: unable to contact remote host, message will be delivered
7411: when the connection is brought back up
1.191 harris41 7412:
1.394 bowersj2 7413: =item * B<con_failed>: unable to contact remote host and unable to save message
7414: for later delivery
1.191 harris41 7415:
1.394 bowersj2 7416: =item * B<error:>: an error a occured, a description of the error follows the :
1.191 harris41 7417:
1.394 bowersj2 7418: =item * B<no_such_host>: unable to fund a host associated with the user/domain
1.243 albertel 7419: that was requested
1.191 harris41 7420:
1.243 albertel 7421: =back
1.191 harris41 7422:
1.243 albertel 7423: =head1 PUBLIC SUBROUTINES
1.191 harris41 7424:
1.243 albertel 7425: =head2 Session Environment Functions
1.191 harris41 7426:
1.243 albertel 7427: =over 4
1.191 harris41 7428:
1.394 bowersj2 7429: =item *
7430: X<appenv()>
7431: B<appenv(%hash)>: the value of %hash is written to
7432: the user envirnoment file, and will be restored for each access this
1.620 albertel 7433: user makes during this session, also modifies the %env for the current
1.394 bowersj2 7434: process
1.191 harris41 7435:
7436: =item *
1.394 bowersj2 7437: X<delenv()>
7438: B<delenv($regexp)>: removes all items from the session
7439: environment file that matches the regular expression in $regexp. The
1.620 albertel 7440: values are also delted from the current processes %env.
1.191 harris41 7441:
1.243 albertel 7442: =back
7443:
7444: =head2 User Information
1.191 harris41 7445:
1.243 albertel 7446: =over 4
1.191 harris41 7447:
7448: =item *
1.394 bowersj2 7449: X<queryauthenticate()>
7450: B<queryauthenticate($uname,$udom)>: try to determine user's current
1.191 harris41 7451: authentication scheme
7452:
7453: =item *
1.394 bowersj2 7454: X<authenticate()>
7455: B<authenticate($uname,$upass,$udom)>: try to
7456: authenticate user from domain's lib servers (first use the current
7457: one). C<$upass> should be the users password.
1.191 harris41 7458:
7459: =item *
1.394 bowersj2 7460: X<homeserver()>
7461: B<homeserver($uname,$udom)>: find the server which has
7462: the user's directory and files (there must be only one), this caches
7463: the answer, and also caches if there is a borken connection.
1.191 harris41 7464:
7465: =item *
1.394 bowersj2 7466: X<idget()>
7467: B<idget($udom,@ids)>: find the usernames behind a list of IDs
7468: (IDs are a unique resource in a domain, there must be only 1 ID per
7469: username, and only 1 username per ID in a specific domain) (returns
7470: hash: id=>name,id=>name)
1.191 harris41 7471:
7472: =item *
1.394 bowersj2 7473: X<idrget()>
7474: B<idrget($udom,@unames)>: find the IDs behind a list of
7475: usernames (returns hash: name=>id,name=>id)
1.191 harris41 7476:
7477: =item *
1.394 bowersj2 7478: X<idput()>
7479: B<idput($udom,%ids)>: store away a list of names and associated IDs
1.191 harris41 7480:
7481: =item *
1.394 bowersj2 7482: X<rolesinit()>
7483: B<rolesinit($udom,$username,$authhost)>: get user privileges
1.243 albertel 7484:
7485: =item *
1.551 albertel 7486: X<getsection()>
7487: B<getsection($udom,$uname,$cname)>: finds the section of student in the
1.243 albertel 7488: course $cname, return section name/number or '' for "not in course"
7489: and '-1' for "no section"
7490:
7491: =item *
1.394 bowersj2 7492: X<userenvironment()>
7493: B<userenvironment($udom,$uname,@what)>: gets the values of the keys
1.243 albertel 7494: passed in @what from the requested user's environment, returns a hash
7495:
7496: =back
7497:
7498: =head2 User Roles
7499:
7500: =over 4
7501:
7502: =item *
7503:
7504: allowed($priv,$uri) : check for a user privilege; returns codes for allowed
7505: actions
7506: F: full access
7507: U,I,K: authentication modes (cxx only)
7508: '': forbidden
7509: 1: user needs to choose course
7510: 2: browse allowed
7511:
7512: =item *
7513:
7514: definerole($rolename,$sysrole,$domrole,$courole) : define role; define a custom
7515: role rolename set privileges in format of lonTabs/roles.tab for system, domain,
7516: and course level
7517:
7518: =item *
7519:
7520: plaintext($short) : return value in %prp hash (rolesplain.tab); plain text
7521: explanation of a user role term
7522:
7523: =back
7524:
7525: =head2 User Modification
7526:
7527: =over 4
7528:
7529: =item *
7530:
7531: assignrole($udom,$uname,$url,$role,$end,$start) : assign role; give a role to a
7532: user for the level given by URL. Optional start and end dates (leave empty
7533: string or zero for "no date")
1.191 harris41 7534:
7535: =item *
7536:
1.243 albertel 7537: changepass($uname,$udom,$currentpass,$newpass,$server) : attempts to
7538: change a users, password, possible return values are: ok,
7539: pwchange_failure, non_authorized, auth_mode_error, unknown_user,
7540: refused
1.191 harris41 7541:
7542: =item *
7543:
1.243 albertel 7544: modifyuserauth($udom,$uname,$umode,$upass) : modify user authentication
1.191 harris41 7545:
7546: =item *
7547:
1.243 albertel 7548: modifyuser($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene) :
7549: modify user
1.191 harris41 7550:
7551: =item *
7552:
1.286 matthew 7553: modifystudent
7554:
7555: modify a students enrollment and identification information.
7556: The course id is resolved based on the current users environment.
7557: This means the envoking user must be a course coordinator or otherwise
7558: associated with a course.
7559:
1.297 matthew 7560: This call is essentially a wrapper for lonnet::modifyuser and
7561: lonnet::modify_student_enrollment
1.286 matthew 7562:
7563: Inputs:
7564:
7565: =over 4
7566:
7567: =item B<$udom> Students loncapa domain
7568:
7569: =item B<$uname> Students loncapa login name
7570:
7571: =item B<$uid> Students id/student number
7572:
7573: =item B<$umode> Students authentication mode
7574:
7575: =item B<$upass> Students password
7576:
7577: =item B<$first> Students first name
7578:
7579: =item B<$middle> Students middle name
7580:
7581: =item B<$last> Students last name
7582:
7583: =item B<$gene> Students generation
7584:
7585: =item B<$usec> Students section in course
7586:
7587: =item B<$end> Unix time of the roles expiration
7588:
7589: =item B<$start> Unix time of the roles start date
7590:
7591: =item B<$forceid> If defined, allow $uid to be changed
7592:
7593: =item B<$desiredhome> server to use as home server for student
7594:
7595: =back
1.297 matthew 7596:
7597: =item *
7598:
7599: modify_student_enrollment
7600:
7601: Change a students enrollment status in a class. The environment variable
7602: 'role.request.course' must be defined for this function to proceed.
7603:
7604: Inputs:
7605:
7606: =over 4
7607:
7608: =item $udom, students domain
7609:
7610: =item $uname, students name
7611:
7612: =item $uid, students user id
7613:
7614: =item $first, students first name
7615:
7616: =item $middle
7617:
7618: =item $last
7619:
7620: =item $gene
7621:
7622: =item $usec
7623:
7624: =item $end
7625:
7626: =item $start
7627:
7628: =back
7629:
1.191 harris41 7630:
7631: =item *
7632:
1.243 albertel 7633: assigncustomrole($udom,$uname,$url,$rdom,$rnam,$rolename,$end,$start) : assign
7634: custom role; give a custom role to a user for the level given by URL. Specify
7635: name and domain of role author, and role name
1.191 harris41 7636:
7637: =item *
7638:
1.243 albertel 7639: revokerole($udom,$uname,$url,$role) : revoke a role for url
1.191 harris41 7640:
7641: =item *
7642:
1.243 albertel 7643: revokecustomrole($udom,$uname,$url,$role) : revoke a custom role
7644:
7645: =back
7646:
7647: =head2 Course Infomation
7648:
7649: =over 4
1.191 harris41 7650:
7651: =item *
7652:
1.631 albertel 7653: coursedescription($courseid) : returns a hash of information about the
7654: specified course id, including all environment settings for the
7655: course, the description of the course will be in the hash under the
7656: key 'description'
1.191 harris41 7657:
7658: =item *
7659:
1.624 albertel 7660: resdata($name,$domain,$type,@which) : request for current parameter
7661: setting for a specific $type, where $type is either 'course' or 'user',
7662: @what should be a list of parameters to ask about. This routine caches
7663: answers for 5 minutes.
1.243 albertel 7664:
7665: =back
7666:
7667: =head2 Course Modification
7668:
7669: =over 4
1.191 harris41 7670:
7671: =item *
7672:
1.243 albertel 7673: writecoursepref($courseid,%prefs) : write preferences (environment
7674: database) for a course
1.191 harris41 7675:
7676: =item *
7677:
1.243 albertel 7678: createcourse($udom,$description,$url) : make/modify course
7679:
7680: =back
7681:
7682: =head2 Resource Subroutines
7683:
7684: =over 4
1.191 harris41 7685:
7686: =item *
7687:
1.243 albertel 7688: subscribe($fname) : subscribe to a resource, returns URL if possible (probably should use repcopy instead)
1.191 harris41 7689:
7690: =item *
7691:
1.243 albertel 7692: repcopy($filename) : subscribes to the requested file, and attempts to
7693: replicate from the owning library server, Might return
1.607 raeburn 7694: 'unavailable', 'not_found', 'forbidden', 'ok', or
7695: 'bad_request', also attempts to grab the metadata for the
1.243 albertel 7696: resource. Expects the local filesystem pathname
7697: (/home/httpd/html/res/....)
7698:
7699: =back
7700:
7701: =head2 Resource Information
7702:
7703: =over 4
1.191 harris41 7704:
7705: =item *
7706:
1.243 albertel 7707: EXT($varname,$symb,$udom,$uname) : evaluates and returns the value of
7708: a vairety of different possible values, $varname should be a request
7709: string, and the other parameters can be used to specify who and what
7710: one is asking about.
7711:
7712: Possible values for $varname are environment.lastname (or other item
7713: from the envirnment hash), user.name (or someother aspect about the
7714: user), resource.0.maxtries (or some other part and parameter of a
7715: resource)
1.204 albertel 7716:
7717: =item *
7718:
1.243 albertel 7719: directcondval($number) : get current value of a condition; reads from a state
7720: string
1.204 albertel 7721:
7722: =item *
7723:
1.243 albertel 7724: condval($condidx) : value of condition index based on state
1.204 albertel 7725:
7726: =item *
7727:
1.243 albertel 7728: metadata($uri,$what,$liburi,$prefix,$depthcount) : request a
7729: resource's metadata, $what should be either a specific key, or either
7730: 'keys' (to get a list of possible keys) or 'packages' to get a list of
7731: packages that this resource currently uses, the last 3 arguments are only used internally for recursive metadata.
7732:
7733: this function automatically caches all requests
1.191 harris41 7734:
7735: =item *
7736:
1.243 albertel 7737: metadata_query($query,$custom,$customshow) : make a metadata query against the
7738: network of library servers; returns file handle of where SQL and regex results
7739: will be stored for query
1.191 harris41 7740:
7741: =item *
7742:
1.243 albertel 7743: symbread($filename) : return symbolic list entry (filename argument optional);
7744: returns the data handle
1.191 harris41 7745:
7746: =item *
7747:
1.243 albertel 7748: symbverify($symb,$thisfn) : verifies that $symb actually exists and is
1.582 albertel 7749: a possible symb for the URL in $thisfn, and if is an encryypted
7750: resource that the user accessed using /enc/ returns a 1 on success, 0
7751: on failure, user must be in a course, as it assumes the existance of
1.620 albertel 7752: the course initial hash, and uses $env('request.course.id'}
1.243 albertel 7753:
1.191 harris41 7754:
7755: =item *
7756:
1.243 albertel 7757: symbclean($symb) : removes versions numbers from a symb, returns the
7758: cleaned symb
1.191 harris41 7759:
7760: =item *
7761:
1.243 albertel 7762: is_on_map($uri) : checks if the $uri is somewhere on the current
7763: course map, user must be in a course for it to work.
1.191 harris41 7764:
7765: =item *
7766:
1.243 albertel 7767: numval($salt) : return random seed value (addend for rndseed)
1.191 harris41 7768:
7769: =item *
7770:
1.243 albertel 7771: rndseed($symb,$courseid,$udom,$uname) : create a random sum; returns
7772: a random seed, all arguments are optional, if they aren't sent it uses the
7773: environment to derive them. Note: if symb isn't sent and it can't get one
7774: from &symbread it will use the current time as its return value
1.191 harris41 7775:
7776: =item *
7777:
1.243 albertel 7778: ireceipt($funame,$fudom,$fucourseid,$fusymb) : return unique,
7779: unfakeable, receipt
1.191 harris41 7780:
7781: =item *
7782:
1.620 albertel 7783: receipt() : API to ireceipt working off of env values; given out to users
1.191 harris41 7784:
7785: =item *
7786:
1.243 albertel 7787: countacc($url) : count the number of accesses to a given URL
1.191 harris41 7788:
7789: =item *
7790:
1.243 albertel 7791: 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 7792:
7793: =item *
7794:
1.243 albertel 7795: 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 7796:
7797: =item *
7798:
1.243 albertel 7799: expirespread($uname,$udom,$stype,$usymb) : set expire date for spreadsheet
1.191 harris41 7800:
7801: =item *
7802:
1.243 albertel 7803: devalidate($symb) : devalidate temporary spreadsheet calculations,
7804: forcing spreadsheet to reevaluate the resource scores next time.
7805:
7806: =back
7807:
7808: =head2 Storing/Retreiving Data
7809:
7810: =over 4
1.191 harris41 7811:
7812: =item *
7813:
1.243 albertel 7814: store($storehash,$symb,$namespace,$udom,$uname) : stores hash permanently
7815: for this url; hashref needs to be given and should be a \%hashname; the
7816: remaining args aren't required and if they aren't passed or are '' they will
1.620 albertel 7817: be derived from the env
1.191 harris41 7818:
7819: =item *
7820:
1.243 albertel 7821: cstore($storehash,$symb,$namespace,$udom,$uname) : same as store but
7822: uses critical subroutine
1.191 harris41 7823:
7824: =item *
7825:
1.243 albertel 7826: restore($symb,$namespace,$udom,$uname) : returns hash for this symb;
7827: all args are optional
1.191 harris41 7828:
7829: =item *
7830:
1.717 albertel 7831: dumpstore($namespace,$udom,$uname,$regexp,$range) :
7832: dumps the complete (or key matching regexp) namespace into a hash
7833: ($udom, $uname, $regexp, $range are optional) for a namespace that is
7834: normally &store()ed into
7835:
7836: $range should be either an integer '100' (give me the first 100
7837: matching records)
7838: or be two integers sperated by a - with no spaces
7839: '30-50' (give me the 30th through the 50th matching
7840: records)
7841:
7842:
7843: =item *
7844:
7845: putstore($namespace,$symb,$version,$storehash,$udomain,$uname) :
7846: replaces a &store() version of data with a replacement set of data
7847: for a particular resource in a namespace passed in the $storehash hash
7848: reference
7849:
7850: =item *
7851:
1.243 albertel 7852: tmpstore($storehash,$symb,$namespace,$udom,$uname) : storage that
7853: works very similar to store/cstore, but all data is stored in a
7854: temporary location and can be reset using tmpreset, $storehash should
7855: be a hash reference, returns nothing on success
1.191 harris41 7856:
7857: =item *
7858:
1.243 albertel 7859: tmprestore($symb,$namespace,$udom,$uname) : storage that works very
7860: similar to restore, but all data is stored in a temporary location and
7861: can be reset using tmpreset. Returns a hash of values on success,
7862: error string otherwise.
1.191 harris41 7863:
7864: =item *
7865:
1.243 albertel 7866: tmpreset($symb,$namespace,$udom,$uname) : temporary storage reset,
7867: deltes all keys for $symb form the temporary storage hash.
1.191 harris41 7868:
7869: =item *
7870:
1.243 albertel 7871: get($namespace,$storearr,$udom,$uname) : returns hash with keys from array
7872: reference filled in from namesp ($udom and $uname are optional)
1.191 harris41 7873:
7874: =item *
7875:
1.243 albertel 7876: del($namespace,$storearr,$udom,$uname) : deletes keys out of array from
7877: namesp ($udom and $uname are optional)
1.191 harris41 7878:
7879: =item *
7880:
1.702 albertel 7881: dump($namespace,$udom,$uname,$regexp,$range) :
1.243 albertel 7882: dumps the complete (or key matching regexp) namespace into a hash
1.702 albertel 7883: ($udom, $uname, $regexp, $range are optional)
1.449 matthew 7884:
1.702 albertel 7885: $range should be either an integer '100' (give me the first 100
7886: matching records)
7887: or be two integers sperated by a - with no spaces
7888: '30-50' (give me the 30th through the 50th matching
7889: records)
1.449 matthew 7890: =item *
7891:
7892: inc($namespace,$store,$udom,$uname) : increments $store in $namespace.
7893: $store can be a scalar, an array reference, or if the amount to be
7894: incremented is > 1, a hash reference.
7895:
7896: ($udom and $uname are optional)
1.191 harris41 7897:
7898: =item *
7899:
1.243 albertel 7900: put($namespace,$storehash,$udom,$uname) : stores hash in namesp
7901: ($udom and $uname are optional)
1.191 harris41 7902:
7903: =item *
7904:
1.243 albertel 7905: cput($namespace,$storehash,$udom,$uname) : critical put
7906: ($udom and $uname are optional)
1.191 harris41 7907:
7908: =item *
7909:
1.748 albertel 7910: newput($namespace,$storehash,$udom,$uname) :
7911:
7912: Attempts to store the items in the $storehash, but only if they don't
7913: currently exist, if this succeeds you can be certain that you have
7914: successfully created a new key value pair in the $namespace db.
7915:
7916:
7917: Args:
7918: $namespace: name of database to store values to
7919: $storehash: hashref to store to the db
7920: $udom: (optional) domain of user containing the db
7921: $uname: (optional) name of user caontaining the db
7922:
7923: Returns:
7924: 'ok' -> succeeded in storing all keys of $storehash
7925: 'key_exists: <key>' -> failed to anything out of $storehash, as at
7926: least <key> already existed in the db (other
7927: requested keys may also already exist)
7928: 'error: <msg>' -> unable to tie the DB or other erorr occured
7929: 'con_lost' -> unable to contact request server
7930: 'refused' -> action was not allowed by remote machine
7931:
7932:
7933: =item *
7934:
1.243 albertel 7935: eget($namespace,$storearr,$udom,$uname) : returns hash with keys from array
7936: reference filled in from namesp (encrypts the return communication)
7937: ($udom and $uname are optional)
1.191 harris41 7938:
7939: =item *
7940:
1.243 albertel 7941: log($udom,$name,$home,$message) : write to permanent log for user; use
7942: critical subroutine
7943:
7944: =back
7945:
7946: =head2 Network Status Functions
7947:
7948: =over 4
1.191 harris41 7949:
7950: =item *
7951:
7952: dirlist($uri) : return directory list based on URI
7953:
7954: =item *
7955:
1.243 albertel 7956: spareserver() : find server with least workload from spare.tab
7957:
7958: =back
7959:
7960: =head2 Apache Request
7961:
7962: =over 4
1.191 harris41 7963:
7964: =item *
7965:
1.243 albertel 7966: ssi($url,%hash) : server side include, does a complete request cycle on url to
7967: localhost, posts hash
7968:
7969: =back
7970:
7971: =head2 Data to String to Data
7972:
7973: =over 4
1.191 harris41 7974:
7975: =item *
7976:
1.243 albertel 7977: hash2str(%hash) : convert a hash into a string complete with escaping and '='
7978: and '&' separators, supports elements that are arrayrefs and hashrefs
1.191 harris41 7979:
7980: =item *
7981:
1.243 albertel 7982: hashref2str($hashref) : convert a hashref into a string complete with
7983: escaping and '=' and '&' separators, supports elements that are
7984: arrayrefs and hashrefs
1.191 harris41 7985:
7986: =item *
7987:
1.243 albertel 7988: arrayref2str($arrayref) : convert an arrayref into a string complete
7989: with escaping and '&' separators, supports elements that are arrayrefs
7990: and hashrefs
1.191 harris41 7991:
7992: =item *
7993:
1.243 albertel 7994: str2hash($string) : convert string to hash using unescaping and
7995: splitting on '=' and '&', supports elements that are arrayrefs and
7996: hashrefs
1.191 harris41 7997:
7998: =item *
7999:
1.243 albertel 8000: str2array($string) : convert string to hash using unescaping and
8001: splitting on '&', supports elements that are arrayrefs and hashrefs
8002:
8003: =back
8004:
8005: =head2 Logging Routines
8006:
8007: =over 4
8008:
8009: These routines allow one to make log messages in the lonnet.log and
8010: lonnet.perm logfiles.
1.191 harris41 8011:
8012: =item *
8013:
1.243 albertel 8014: logtouch() : make sure the logfile, lonnet.log, exists
1.191 harris41 8015:
8016: =item *
8017:
1.243 albertel 8018: logthis() : append message to the normal lonnet.log file, it gets
8019: preiodically rolled over and deleted.
1.191 harris41 8020:
8021: =item *
8022:
1.243 albertel 8023: logperm() : append a permanent message to lonnet.perm.log, this log
8024: file never gets deleted by any automated portion of the system, only
8025: messages of critical importance should go in here.
8026:
8027: =back
8028:
8029: =head2 General File Helper Routines
8030:
8031: =over 4
1.191 harris41 8032:
8033: =item *
8034:
1.481 raeburn 8035: getfile($file,$caller) : two cases - requests for files in /res or in /uploaded.
8036: (a) files in /uploaded
8037: (i) If a local copy of the file exists -
8038: compares modification date of local copy with last-modified date for
8039: definitive version stored on home server for course. If local copy is
8040: stale, requests a new version from the home server and stores it.
8041: If the original has been removed from the home server, then local copy
8042: is unlinked.
8043: (ii) If local copy does not exist -
8044: requests the file from the home server and stores it.
8045:
8046: If $caller is 'uploadrep':
8047: This indicates a call from lonuploadrep.pm (PerlHeaderParserHandler phase)
8048: for request for files originally uploaded via DOCS.
8049: - returns 'ok' if fresh local copy now available, -1 otherwise.
8050:
8051: Otherwise:
8052: This indicates a call from the content generation phase of the request.
8053: - returns the entire contents of the file or -1.
8054:
8055: (b) files in /res
8056: - returns the entire contents of a file or -1;
8057: it properly subscribes to and replicates the file if neccessary.
1.191 harris41 8058:
1.712 albertel 8059:
8060: =item *
8061:
8062: stat_file($url) : $url is expected to be a /res/ or /uploaded/ style file
8063: reference
8064:
8065: returns either a stat() list of data about the file or an empty list
8066: if the file doesn't exist or couldn't find out about it (connection
8067: problems or user unknown)
8068:
1.191 harris41 8069: =item *
8070:
1.243 albertel 8071: filelocation($dir,$file) : returns file system location of a file
8072: based on URI; meant to be "fairly clean" absolute reference, $dir is a
8073: directory that relative $file lookups are to looked in ($dir of /a/dir
8074: and a file of ../bob will become /a/bob)
1.191 harris41 8075:
8076: =item *
8077:
8078: hreflocation($dir,$file) : returns file system location or a URL; same as
8079: filelocation except for hrefs
8080:
8081: =item *
8082:
8083: declutter() : declutters URLs (remove docroot, beginning slashes, 'res' etc)
8084:
1.243 albertel 8085: =back
8086:
1.608 albertel 8087: =head2 Usererfile file routines (/uploaded*)
8088:
8089: =over 4
8090:
8091: =item *
8092:
8093: userfileupload(): main rotine for putting a file in a user or course's
8094: filespace, arguments are,
8095:
1.620 albertel 8096: formname - required - this is the name of the element in $env where the
1.608 albertel 8097: filename, and the contents of the file to create/modifed exist
1.620 albertel 8098: the filename is in $env{'form.'.$formname.'.filename'} and the
8099: contents of the file is located in $env{'form.'.$formname}
1.608 albertel 8100: coursedoc - if true, store the file in the course of the active role
8101: of the current user
8102: subdir - required - subdirectory to put the file in under ../userfiles/
8103: if undefined, it will be placed in "unknown"
8104:
8105: (This routine calls clean_filename() to remove any dangerous
8106: characters from the filename, and then calls finuserfileupload() to
8107: complete the transaction)
8108:
8109: returns either the url of the uploaded file (/uploaded/....) if successful
8110: and /adm/notfound.html if unsuccessful
8111:
8112: =item *
8113:
8114: clean_filename(): routine for cleaing a filename up for storage in
8115: userfile space, argument is:
8116:
8117: filename - proposed filename
8118:
8119: returns: the new clean filename
8120:
8121: =item *
8122:
8123: finishuserfileupload(): routine that creaes and sends the file to
8124: userspace, probably shouldn't be called directly
8125:
8126: docuname: username or courseid of destination for the file
8127: docudom: domain of user/course of destination for the file
8128: formname: same as for userfileupload()
8129: fname: filename (inculding subdirectories) for the file
8130:
8131: returns either the url of the uploaded file (/uploaded/....) if successful
8132: and /adm/notfound.html if unsuccessful
8133:
8134: =item *
8135:
8136: renameuserfile(): renames an existing userfile to a new name
8137:
8138: Args:
8139: docuname: username or courseid of destination for the file
8140: docudom: domain of user/course of destination for the file
8141: old: current file name (including any subdirs under userfiles)
8142: new: desired file name (including any subdirs under userfiles)
8143:
8144: =item *
8145:
8146: mkdiruserfile(): creates a directory is a userfiles dir
8147:
8148: Args:
8149: docuname: username or courseid of destination for the file
8150: docudom: domain of user/course of destination for the file
8151: dir: dir to create (including any subdirs under userfiles)
8152:
8153: =item *
8154:
8155: removeuserfile(): removes a file that exists in userfiles
8156:
8157: Args:
8158: docuname: username or courseid of destination for the file
8159: docudom: domain of user/course of destination for the file
8160: fname: filname to delete (including any subdirs under userfiles)
8161:
8162: =item *
8163:
8164: removeuploadedurl(): convience function for removeuserfile()
8165:
8166: Args:
8167: url: a full /uploaded/... url to delete
8168:
1.747 albertel 8169: =item *
8170:
8171: get_portfile_permissions():
8172: Args:
8173: domain: domain of user or course contain the portfolio files
8174: user: name of user or num of course contain the portfolio files
8175: Returns:
8176: hashref of a dump of the proper file_permissions.db
8177:
8178:
8179: =item *
8180:
8181: get_access_controls():
8182:
8183: Args:
8184: current_permissions: the hash ref returned from get_portfile_permissions()
8185: group: (optional) the group you want the files associated with
8186: file: (optional) the file you want access info on
8187:
8188: Returns:
1.749 raeburn 8189: a hash (keys are file names) of hashes containing
8190: keys are: path to file/file_name\0uniqueID:scope_end_start (see below)
8191: values are XML containing access control settings (see below)
1.747 albertel 8192:
8193: Internal notes:
8194:
1.749 raeburn 8195: access controls are stored in file_permissions.db as key=value pairs.
8196: key -> path to file/file_name\0uniqueID:scope_end_start
8197: where scope -> public,guest,course,group,domains or users.
8198: end -> UNIX time for end of access (0 -> no end date)
8199: start -> UNIX time for start of access
8200:
8201: value -> XML description of access control
8202: <scope type=""> (type =1 of: public,guest,course,group,domains,users">
8203: <start></start>
8204: <end></end>
8205:
8206: <password></password> for scope type = guest
8207:
8208: <domain></domain> for scope type = course or group
8209: <number></number>
8210: <roles id="">
8211: <role></role>
8212: <access></access>
8213: <section></section>
8214: <group></group>
8215: </roles>
8216:
8217: <dom></dom> for scope type = domains
8218:
8219: <users> for scope type = users
8220: <user>
8221: <uname></uname>
8222: <udom></udom>
8223: </user>
8224: </users>
8225: </scope>
8226:
8227: Access data is also aggregated for each file in an additional key=value pair:
8228: key -> path to file/file_name\0accesscontrol
8229: value -> reference to hash
8230: hash contains key = value pairs
8231: where key = uniqueID:scope_end_start
8232: value = UNIX time record was last updated
8233:
8234: Used to improve speed of look-ups of access controls for each file.
8235:
8236: Locks on files (resulting from submission of portfolio file to a homework problem stored in array of arrays.
8237:
8238: parse_access_controls():
8239:
8240: Parses XML of an access control record
8241: Args
8242: 1. Text string (XML) of access comtrol record
8243:
8244: Returns:
8245: 1. Hash of access control settings.
8246:
8247: modify_access_controls():
8248:
8249: Modifies access controls for a portfolio file
8250: Args
8251: 1. file name
8252: 2. reference to hash of required changes,
8253: 3. domain
8254: 4. username
8255: where domain,username are the domain of the portfolio owner
8256: (either a user or a course)
8257:
8258: Returns:
8259: 1. result of additions or updates ('ok' or 'error', with error message).
8260: 2. result of deletions ('ok' or 'error', with error message).
8261: 3. reference to hash of any new or updated access controls.
8262: 4. reference to hash used to map incoming IDs to uniqueIDs assigned to control.
8263: key = integer (inbound ID)
8264: value = uniqueID
1.747 albertel 8265:
1.608 albertel 8266: =back
8267:
1.243 albertel 8268: =head2 HTTP Helper Routines
8269:
8270: =over 4
8271:
1.191 harris41 8272: =item *
8273:
8274: escape() : unpack non-word characters into CGI-compatible hex codes
8275:
8276: =item *
8277:
8278: unescape() : pack CGI-compatible hex codes into actual non-word ASCII character
8279:
1.243 albertel 8280: =back
8281:
8282: =head1 PRIVATE SUBROUTINES
8283:
8284: =head2 Underlying communication routines (Shouldn't call)
8285:
8286: =over 4
8287:
8288: =item *
8289:
8290: subreply() : tries to pass a message to lonc, returns con_lost if incapable
8291:
8292: =item *
8293:
8294: reply() : uses subreply to send a message to remote machine, logs all failures
8295:
8296: =item *
8297:
8298: critical() : passes a critical message to another server; if cannot
8299: get through then place message in connection buffer directory and
8300: returns con_delayed, if incapable of saving message, returns
8301: con_failed
8302:
8303: =item *
8304:
8305: reconlonc() : tries to reconnect lonc client processes.
8306:
8307: =back
8308:
8309: =head2 Resource Access Logging
8310:
8311: =over 4
8312:
8313: =item *
8314:
8315: flushcourselogs() : flush (save) buffer logs and access logs
8316:
8317: =item *
8318:
8319: courselog($what) : save message for course in hash
8320:
8321: =item *
8322:
8323: courseacclog($what) : save message for course using &courselog(). Perform
8324: special processing for specific resource types (problems, exams, quizzes, etc).
8325:
1.191 harris41 8326: =item *
8327:
8328: goodbye() : flush course logs and log shutting down; it is called in srm.conf
8329: as a PerlChildExitHandler
1.243 albertel 8330:
8331: =back
8332:
8333: =head2 Other
8334:
8335: =over 4
8336:
8337: =item *
8338:
8339: symblist($mapname,%newhash) : update symbolic storage links
1.191 harris41 8340:
8341: =back
8342:
8343: =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