Annotation of loncom/lonnet/perl/lonnet.pm, revision 1.924
1.1 albertel 1: # The LearningOnline Network
2: # TCP networking package
1.12 www 3: #
1.924 ! albertel 4: # $Id: lonnet.pm,v 1.923 2007/11/10 03:51:10 raeburn Exp $
1.178 www 5: #
6: # Copyright Michigan State University Board of Trustees
7: #
8: # This file is part of the LearningOnline Network with CAPA (LON-CAPA).
9: #
10: # LON-CAPA is free software; you can redistribute it and/or modify
11: # it under the terms of the GNU General Public License as published by
12: # the Free Software Foundation; either version 2 of the License, or
13: # (at your option) any later version.
14: #
15: # LON-CAPA is distributed in the hope that it will be useful,
16: # but WITHOUT ANY WARRANTY; without even the implied warranty of
17: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18: # GNU General Public License for more details.
19: #
20: # You should have received a copy of the GNU General Public License
21: # along with LON-CAPA; if not, write to the Free Software
22: # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
23: #
24: # /home/httpd/html/adm/gpl.txt
25: #
26: # http://www.lon-capa.org/
27: #
1.169 harris41 28: ###
29:
1.1 albertel 30: package Apache::lonnet;
31:
32: use strict;
1.8 www 33: use LWP::UserAgent();
1.486 www 34: use HTTP::Date;
35: # use Date::Parse;
1.871 albertel 36: use vars qw(%perlvar %spareid %pr %prp $memcache %packagetab $tmpdir
37: $_64bit %env);
38:
39: my (%badServerCache, $memcache, %courselogs, %accesshash, %domainrolehash,
40: %userrolehash, $processmarker, $dumpcount, %coursedombuf,
41: %coursenumbuf, %coursehombuf, %coursedescrbuf, %courseinstcodebuf,
42: %courseownerbuf, %coursetypebuf);
1.403 www 43:
1.1 albertel 44: use IO::Socket;
1.31 www 45: use GDBM_File;
1.208 albertel 46: use HTML::LCParser;
1.88 www 47: use Fcntl qw(:flock);
1.870 albertel 48: use Storable qw(thaw nfreeze);
1.539 albertel 49: use Time::HiRes qw( gettimeofday tv_interval );
1.599 albertel 50: use Cache::Memcached;
1.676 albertel 51: use Digest::MD5;
1.790 albertel 52: use Math::Random;
1.807 albertel 53: use LONCAPA qw(:DEFAULT :match);
1.740 www 54: use LONCAPA::Configuration;
1.676 albertel 55:
1.195 www 56: my $readit;
1.550 foxr 57: my $max_connection_retries = 10; # Or some such value.
1.1 albertel 58:
1.619 albertel 59: require Exporter;
60:
61: our @ISA = qw (Exporter);
62: our @EXPORT = qw(%env);
63:
1.449 matthew 64: =pod
65:
66: =head1 Package Variables
67:
68: These are largely undocumented, so if you decipher one please note it here.
69:
70: =over 4
71:
72: =item $processmarker
73:
74: Contains the time this process was started and this servers host id.
75:
76: =item $dumpcount
77:
78: Counts the number of times a message log flush has been attempted (regardless
79: of success) by this process. Used as part of the filename when messages are
80: delayed.
81:
82: =back
83:
84: =cut
85:
86:
1.1 albertel 87: # --------------------------------------------------------------------- Logging
1.729 www 88: {
89: my $logid;
90: sub instructor_log {
91: my ($hash_name,$storehash,$delflag,$uname,$udom)=@_;
92: $logid++;
93: my $id=time().'00000'.$$.'00000'.$logid;
94: return &Apache::lonnet::put('nohist_'.$hash_name,
1.730 www 95: { $id => {
96: 'exe_uname' => $env{'user.name'},
97: 'exe_udom' => $env{'user.domain'},
98: 'exe_time' => time(),
99: 'exe_ip' => $ENV{'REMOTE_ADDR'},
100: 'delflag' => $delflag,
101: 'logentry' => $storehash,
102: 'uname' => $uname,
103: 'udom' => $udom,
104: }
105: },
1.729 www 106: $env{'course.'.$env{'request.course.id'}.'.domain'},
107: $env{'course.'.$env{'request.course.id'}.'.num'}
108: );
109: }
110: }
1.1 albertel 111:
1.163 harris41 112: sub logtouch {
113: my $execdir=$perlvar{'lonDaemons'};
1.448 albertel 114: unless (-e "$execdir/logs/lonnet.log") {
115: open(my $fh,">>$execdir/logs/lonnet.log");
1.163 harris41 116: close $fh;
117: }
118: my ($wwwuid,$wwwgid)=(getpwnam('www'))[2,3];
119: chown($wwwuid,$wwwgid,$execdir.'/logs/lonnet.log');
120: }
121:
1.1 albertel 122: sub logthis {
123: my $message=shift;
124: my $execdir=$perlvar{'lonDaemons'};
125: my $now=time;
126: my $local=localtime($now);
1.448 albertel 127: if (open(my $fh,">>$execdir/logs/lonnet.log")) {
128: print $fh "$local ($$): $message\n";
129: close($fh);
130: }
1.1 albertel 131: return 1;
132: }
133:
134: sub logperm {
135: my $message=shift;
136: my $execdir=$perlvar{'lonDaemons'};
137: my $now=time;
138: my $local=localtime($now);
1.448 albertel 139: if (open(my $fh,">>$execdir/logs/lonnet.perm.log")) {
140: print $fh "$now:$message:$local\n";
141: close($fh);
142: }
1.1 albertel 143: return 1;
144: }
145:
1.850 albertel 146: sub create_connection {
1.853 albertel 147: my ($hostname,$lonid) = @_;
1.851 albertel 148: my $client=IO::Socket::UNIX->new(Peer => $perlvar{'lonSockCreate'},
1.850 albertel 149: Type => SOCK_STREAM,
150: Timeout => 10);
151: return 0 if (!$client);
1.890 albertel 152: print $client (join(':',$hostname,$lonid,&machine_ids($hostname))."\n");
1.850 albertel 153: my $result = <$client>;
154: chomp($result);
155: return 1 if ($result eq 'done');
156: return 0;
157: }
158:
159:
1.1 albertel 160: # -------------------------------------------------- Non-critical communication
161: sub subreply {
162: my ($cmd,$server)=@_;
1.838 albertel 163: my $peerfile="$perlvar{'lonSockDir'}/".&hostname($server);
1.549 foxr 164: #
165: # With loncnew process trimming, there's a timing hole between lonc server
166: # process exit and the master server picking up the listen on the AF_UNIX
167: # socket. In that time interval, a lock file will exist:
168:
169: my $lockfile=$peerfile.".lock";
170: while (-e $lockfile) { # Need to wait for the lockfile to disappear.
171: sleep(1);
172: }
173: # At this point, either a loncnew parent is listening or an old lonc
1.550 foxr 174: # or loncnew child is listening so we can connect or everything's dead.
1.549 foxr 175: #
1.550 foxr 176: # We'll give the connection a few tries before abandoning it. If
177: # connection is not possible, we'll con_lost back to the client.
178: #
179: my $client;
180: for (my $retries = 0; $retries < $max_connection_retries; $retries++) {
181: $client=IO::Socket::UNIX->new(Peer =>"$peerfile",
182: Type => SOCK_STREAM,
183: Timeout => 10);
1.869 albertel 184: if ($client) {
1.550 foxr 185: last; # Connected!
1.850 albertel 186: } else {
1.853 albertel 187: &create_connection(&hostname($server),$server);
1.550 foxr 188: }
1.850 albertel 189: sleep(1); # Try again later if failed connection.
1.550 foxr 190: }
191: my $answer;
192: if ($client) {
1.704 albertel 193: print $client "sethost:$server:$cmd\n";
1.550 foxr 194: $answer=<$client>;
195: if (!$answer) { $answer="con_lost"; }
196: chomp($answer);
197: } else {
198: $answer = 'con_lost'; # Failed connection.
199: }
1.1 albertel 200: return $answer;
201: }
202:
203: sub reply {
204: my ($cmd,$server)=@_;
1.838 albertel 205: unless (defined(&hostname($server))) { return 'no_such_host'; }
1.1 albertel 206: my $answer=subreply($cmd,$server);
1.65 www 207: if (($answer=~/^refused/) || ($answer=~/^rejected/)) {
1.672 albertel 208: &logthis("<font color=\"blue\">WARNING:".
1.12 www 209: " $cmd to $server returned $answer</font>");
210: }
1.1 albertel 211: return $answer;
212: }
213:
214: # ----------------------------------------------------------- Send USR1 to lonc
215:
216: sub reconlonc {
1.891 albertel 217: my ($lonid) = @_;
218: my $hostname = &hostname($lonid);
219: if ($lonid) {
220: my $peerfile="$perlvar{'lonSockDir'}/$hostname";
221: if ($hostname && -e $peerfile) {
222: &logthis("Trying to reconnect lonc for $lonid ($hostname)");
223: my $client=IO::Socket::UNIX->new(Peer => $peerfile,
224: Type => SOCK_STREAM,
225: Timeout => 10);
226: if ($client) {
227: print $client ("reset_retries\n");
228: my $answer=<$client>;
229: #reset just this one.
230: }
231: }
232: return;
233: }
234:
1.836 www 235: &logthis("Trying to reconnect lonc");
1.1 albertel 236: my $loncfile="$perlvar{'lonDaemons'}/logs/lonc.pid";
1.448 albertel 237: if (open(my $fh,"<$loncfile")) {
1.1 albertel 238: my $loncpid=<$fh>;
239: chomp($loncpid);
240: if (kill 0 => $loncpid) {
241: &logthis("lonc at pid $loncpid responding, sending USR1");
242: kill USR1 => $loncpid;
243: sleep 1;
1.836 www 244: } else {
1.12 www 245: &logthis(
1.672 albertel 246: "<font color=\"blue\">WARNING:".
1.12 www 247: " lonc at pid $loncpid not responding, giving up</font>");
1.1 albertel 248: }
249: } else {
1.836 www 250: &logthis('<font color="blue">WARNING: lonc not running, giving up</font>');
1.1 albertel 251: }
252: }
253:
254: # ------------------------------------------------------ Critical communication
1.12 www 255:
1.1 albertel 256: sub critical {
257: my ($cmd,$server)=@_;
1.838 albertel 258: unless (&hostname($server)) {
1.672 albertel 259: &logthis("<font color=\"blue\">WARNING:".
1.89 www 260: " Critical message to unknown server ($server)</font>");
261: return 'no_such_host';
262: }
1.1 albertel 263: my $answer=reply($cmd,$server);
264: if ($answer eq 'con_lost') {
265: &reconlonc("$perlvar{'lonSockDir'}/$server");
1.589 albertel 266: my $answer=reply($cmd,$server);
1.1 albertel 267: if ($answer eq 'con_lost') {
268: my $now=time;
269: my $middlename=$cmd;
1.5 www 270: $middlename=substr($middlename,0,16);
1.1 albertel 271: $middlename=~s/\W//g;
272: my $dfilename=
1.305 www 273: "$perlvar{'lonSockDir'}/delayed/$now.$dumpcount.$$.$middlename.$server";
274: $dumpcount++;
1.1 albertel 275: {
1.448 albertel 276: my $dfh;
277: if (open($dfh,">$dfilename")) {
278: print $dfh "$cmd\n";
279: close($dfh);
280: }
1.1 albertel 281: }
282: sleep 2;
283: my $wcmd='';
284: {
1.448 albertel 285: my $dfh;
286: if (open($dfh,"<$dfilename")) {
287: $wcmd=<$dfh>;
288: close($dfh);
289: }
1.1 albertel 290: }
291: chomp($wcmd);
1.7 www 292: if ($wcmd eq $cmd) {
1.672 albertel 293: &logthis("<font color=\"blue\">WARNING: ".
1.12 www 294: "Connection buffer $dfilename: $cmd</font>");
1.1 albertel 295: &logperm("D:$server:$cmd");
296: return 'con_delayed';
297: } else {
1.672 albertel 298: &logthis("<font color=\"red\">CRITICAL:"
1.12 www 299: ." Critical connection failed: $server $cmd</font>");
1.1 albertel 300: &logperm("F:$server:$cmd");
301: return 'con_failed';
302: }
303: }
304: }
305: return $answer;
1.405 albertel 306: }
307:
1.755 albertel 308: # ------------------------------------------- check if return value is an error
309:
310: sub error {
311: my ($result) = @_;
1.756 albertel 312: if ($result =~ /^(con_lost|no_such_host|error: (\d+) (.*))/) {
1.755 albertel 313: if ($2 == 2) { return undef; }
314: return $1;
315: }
316: return undef;
317: }
318:
1.783 albertel 319: sub convert_and_load_session_env {
320: my ($lonidsdir,$handle)=@_;
321: my @profile;
322: {
1.917 albertel 323: my $opened = open(my $idf,'+<',"$lonidsdir/$handle.id");
324: if (!$opened) {
1.915 albertel 325: return 0;
326: }
1.783 albertel 327: flock($idf,LOCK_SH);
328: @profile=<$idf>;
329: close($idf);
330: }
331: my %temp_env;
332: foreach my $line (@profile) {
1.786 albertel 333: if ($line !~ m/=/) {
334: return 0;
335: }
1.783 albertel 336: chomp($line);
337: my ($envname,$envvalue)=split(/=/,$line,2);
338: $temp_env{&unescape($envname)} = &unescape($envvalue);
339: }
340: unlink("$lonidsdir/$handle.id");
341: if (tie(my %disk_env,'GDBM_File',"$lonidsdir/$handle.id",&GDBM_WRCREAT(),
342: 0640)) {
343: %disk_env = %temp_env;
344: @env{keys(%temp_env)} = @disk_env{keys(%temp_env)};
345: untie(%disk_env);
346: }
1.786 albertel 347: return 1;
1.783 albertel 348: }
349:
1.374 www 350: # ------------------------------------------- Transfer profile into environment
1.780 albertel 351: my $env_loaded;
352: sub transfer_profile_to_env {
1.788 albertel 353: my ($lonidsdir,$handle,$force_transfer) = @_;
354: if (!$force_transfer && $env_loaded) { return; }
1.374 www 355:
1.720 albertel 356: if (!defined($lonidsdir)) {
357: $lonidsdir = $perlvar{'lonIDsDir'};
358: }
359: if (!defined($handle)) {
360: ($handle) = ($env{'user.environment'} =~m|/([^/]+)\.id$| );
361: }
362:
1.786 albertel 363: my $convert;
364: {
1.917 albertel 365: my $opened = open(my $idf,'+<',"$lonidsdir/$handle.id");
366: if (!$opened) {
1.915 albertel 367: return;
368: }
1.786 albertel 369: flock($idf,LOCK_SH);
370: if (tie(my %disk_env,'GDBM_File',"$lonidsdir/$handle.id",
371: &GDBM_READER(),0640)) {
372: @env{keys(%disk_env)} = @disk_env{keys(%disk_env)};
373: untie(%disk_env);
374: } else {
375: $convert = 1;
376: }
377: }
378: if ($convert) {
379: if (!&convert_and_load_session_env($lonidsdir,$handle)) {
380: &logthis("Failed to load session, or convert session.");
381: }
1.374 www 382: }
1.783 albertel 383:
1.786 albertel 384: my %remove;
1.783 albertel 385: while ( my $envname = each(%env) ) {
1.433 matthew 386: if (my ($key,$time) = ($envname =~ /^(cgi\.(\d+)_\d+\.)/)) {
387: if ($time < time-300) {
1.783 albertel 388: $remove{$key}++;
1.433 matthew 389: }
390: }
391: }
1.783 albertel 392:
1.619 albertel 393: $env{'user.environment'} = "$lonidsdir/$handle.id";
1.780 albertel 394: $env_loaded=1;
1.783 albertel 395: foreach my $expired_key (keys(%remove)) {
1.433 matthew 396: &delenv($expired_key);
1.374 www 397: }
1.1 albertel 398: }
399:
1.916 albertel 400: # ---------------------------------------------------- Check for valid session
401: sub check_for_valid_session {
402: my ($r) = @_;
403: my %cookies=CGI::Cookie->parse($r->header_in('Cookie'));
404: my $lonid=$cookies{'lonID'};
405: return undef if (!$lonid);
406:
407: my $handle=&LONCAPA::clean_handle($lonid->value);
408: my $lonidsdir=$r->dir_config('lonIDsDir');
409: return undef if (!-e "$lonidsdir/$handle.id");
410:
1.917 albertel 411: my $opened = open(my $idf,'+<',"$lonidsdir/$handle.id");
412: return undef if (!$opened);
1.916 albertel 413:
414: flock($idf,LOCK_SH);
415: my %disk_env;
416: if (!tie(%disk_env,'GDBM_File',"$lonidsdir/$handle.id",
417: &GDBM_READER(),0640)) {
418: return undef;
419: }
420:
421: if (!defined($disk_env{'user.name'})
422: || !defined($disk_env{'user.domain'})) {
423: return undef;
424: }
425: return $handle;
426: }
427:
1.830 albertel 428: sub timed_flock {
429: my ($file,$lock_type) = @_;
430: my $failed=0;
431: eval {
432: local $SIG{__DIE__}='DEFAULT';
433: local $SIG{ALRM}=sub {
434: $failed=1;
435: die("failed lock");
436: };
437: alarm(13);
438: flock($file,$lock_type);
439: alarm(0);
440: };
441: if ($failed) {
442: return undef;
443: } else {
444: return 1;
445: }
446: }
447:
1.5 www 448: # ---------------------------------------------------------- Append Environment
449:
450: sub appenv {
1.6 www 451: my %newenv=@_;
1.692 albertel 452: foreach my $key (keys(%newenv)) {
453: if (($newenv{$key}=~/^user\.role/) || ($newenv{$key}=~/^user\.priv/)) {
1.672 albertel 454: &logthis("<font color=\"blue\">WARNING: ".
1.692 albertel 455: "Attempt to modify environment ".$key." to ".$newenv{$key}
1.151 www 456: .'</font>');
1.692 albertel 457: delete($newenv{$key});
1.35 www 458: } else {
1.692 albertel 459: $env{$key}=$newenv{$key};
1.35 www 460: }
1.191 harris41 461: }
1.917 albertel 462: my $opened = open(my $env_file,'+<',$env{'user.environment'});
463: if ($opened
1.915 albertel 464: && &timed_flock($env_file,LOCK_EX)
1.830 albertel 465: &&
466: tie(my %disk_env,'GDBM_File',$env{'user.environment'},
467: (&GDBM_WRITER()|&GDBM_NOLOCK()),0640)) {
1.783 albertel 468: while (my ($key,$value) = each(%newenv)) {
469: $disk_env{$key} = $value;
1.448 albertel 470: }
1.783 albertel 471: untie(%disk_env);
1.56 www 472: }
473: return 'ok';
474: }
475: # ----------------------------------------------------- Delete from Environment
476:
477: sub delenv {
478: my $delthis=shift;
479: if (($delthis=~/user\.role/) || ($delthis=~/user\.priv/)) {
1.672 albertel 480: &logthis("<font color=\"blue\">WARNING: ".
1.56 www 481: "Attempt to delete from environment ".$delthis);
482: return 'error';
483: }
1.917 albertel 484: my $opened = open(my $env_file,'+<',$env{'user.environment'});
485: if ($opened
1.915 albertel 486: && &timed_flock($env_file,LOCK_EX)
1.830 albertel 487: &&
488: tie(my %disk_env,'GDBM_File',$env{'user.environment'},
489: (&GDBM_WRITER()|&GDBM_NOLOCK()),0640)) {
1.783 albertel 490: foreach my $key (keys(%disk_env)) {
491: if ($key=~/^$delthis/) {
1.915 albertel 492: delete($env{$key});
493: delete($disk_env{$key});
494: }
1.448 albertel 495: }
1.783 albertel 496: untie(%disk_env);
1.5 www 497: }
498: return 'ok';
1.369 albertel 499: }
500:
1.790 albertel 501: sub get_env_multiple {
502: my ($name) = @_;
503: my @values;
504: if (defined($env{$name})) {
505: # exists is it an array
506: if (ref($env{$name})) {
507: @values=@{ $env{$name} };
508: } else {
509: $values[0]=$env{$name};
510: }
511: }
512: return(@values);
513: }
514:
1.369 albertel 515: # ------------------------------------------ Find out current server userload
516: # there is a copy in lond
517: sub userload {
518: my $numusers=0;
519: {
520: opendir(LONIDS,$perlvar{'lonIDsDir'});
521: my $filename;
522: my $curtime=time;
523: while ($filename=readdir(LONIDS)) {
524: if ($filename eq '.' || $filename eq '..') {next;}
1.404 albertel 525: my ($mtime)=(stat($perlvar{'lonIDsDir'}.'/'.$filename))[9];
1.437 albertel 526: if ($curtime-$mtime < 1800) { $numusers++; }
1.369 albertel 527: }
528: closedir(LONIDS);
529: }
530: my $userloadpercent=0;
531: my $maxuserload=$perlvar{'lonUserLoadLim'};
532: if ($maxuserload) {
1.371 albertel 533: $userloadpercent=100*$numusers/$maxuserload;
1.369 albertel 534: }
1.372 albertel 535: $userloadpercent=sprintf("%.2f",$userloadpercent);
1.369 albertel 536: return $userloadpercent;
1.283 www 537: }
538:
539: # ------------------------------------------ Fight off request when overloaded
540:
541: sub overloaderror {
542: my ($r,$checkserver)=@_;
543: unless ($checkserver) { $checkserver=$perlvar{'lonHostID'}; }
544: my $loadavg;
545: if ($checkserver eq $perlvar{'lonHostID'}) {
1.448 albertel 546: open(my $loadfile,'/proc/loadavg');
1.283 www 547: $loadavg=<$loadfile>;
548: $loadavg =~ s/\s.*//g;
1.285 matthew 549: $loadavg = 100*$loadavg/$perlvar{'lonLoadLim'};
1.448 albertel 550: close($loadfile);
1.283 www 551: } else {
552: $loadavg=&reply('load',$checkserver);
553: }
1.285 matthew 554: my $overload=$loadavg-100;
1.283 www 555: if ($overload>0) {
1.285 matthew 556: $r->err_headers_out->{'Retry-After'}=$overload;
1.283 www 557: $r->log_error('Overload of '.$overload.' on '.$checkserver);
1.554 www 558: return 413;
1.283 www 559: }
560: return '';
1.5 www 561: }
1.1 albertel 562:
563: # ------------------------------ Find server with least workload from spare.tab
1.11 www 564:
1.1 albertel 565: sub spareserver {
1.670 albertel 566: my ($loadpercent,$userloadpercent,$want_server_name) = @_;
1.784 albertel 567: my $spare_server;
1.370 albertel 568: if ($userloadpercent !~ /\d/) { $userloadpercent=0; }
1.784 albertel 569: my $lowest_load=($loadpercent > $userloadpercent) ? $loadpercent
570: : $userloadpercent;
571:
572: foreach my $try_server (@{ $spareid{'primary'} }) {
573: ($spare_server, $lowest_load) =
574: &compare_server_load($try_server, $spare_server, $lowest_load);
575: }
576:
577: my $found_server = ($spare_server ne '' && $lowest_load < 100);
578:
579: if (!$found_server) {
580: foreach my $try_server (@{ $spareid{'default'} }) {
581: ($spare_server, $lowest_load) =
582: &compare_server_load($try_server, $spare_server, $lowest_load);
583: }
584: }
585:
586: if (!$want_server_name) {
1.838 albertel 587: $spare_server="http://".&hostname($spare_server);
1.784 albertel 588: }
589: return $spare_server;
590: }
591:
592: sub compare_server_load {
593: my ($try_server, $spare_server, $lowest_load) = @_;
594:
595: my $loadans = &reply('load', $try_server);
596: my $userloadans = &reply('userload',$try_server);
597:
598: if ($loadans !~ /\d/ && $userloadans !~ /\d/) {
599: next; #didn't get a number from the server
600: }
601:
602: my $load;
603: if ($loadans =~ /\d/) {
604: if ($userloadans =~ /\d/) {
605: #both are numbers, pick the bigger one
606: $load = ($loadans > $userloadans) ? $loadans
607: : $userloadans;
1.411 albertel 608: } else {
1.784 albertel 609: $load = $loadans;
1.411 albertel 610: }
1.784 albertel 611: } else {
612: $load = $userloadans;
613: }
614:
615: if (($load =~ /\d/) && ($load < $lowest_load)) {
616: $spare_server = $try_server;
617: $lowest_load = $load;
1.370 albertel 618: }
1.784 albertel 619: return ($spare_server,$lowest_load);
1.202 matthew 620: }
1.914 albertel 621:
622: # --------------------------- ask offload servers if user already has a session
623: sub find_existing_session {
624: my ($udom,$uname) = @_;
625: foreach my $try_server (@{ $spareid{'primary'} },
626: @{ $spareid{'default'} }) {
627: return $try_server if (&has_user_session($try_server, $udom, $uname));
628: }
629: return;
630: }
631:
632: # -------------------------------- ask if server already has a session for user
633: sub has_user_session {
634: my ($lonid,$udom,$uname) = @_;
635: my $result = &reply(join(':','userhassession',
636: map {&escape($_)} ($udom,$uname)),$lonid);
637: return 1 if ($result eq 'ok');
638:
639: return 0;
640: }
641:
1.202 matthew 642: # --------------------------------------------- Try to change a user's password
643:
644: sub changepass {
1.799 raeburn 645: my ($uname,$udom,$currentpass,$newpass,$server,$context)=@_;
1.202 matthew 646: $currentpass = &escape($currentpass);
647: $newpass = &escape($newpass);
1.799 raeburn 648: my $answer = reply("encrypt:passwd:$udom:$uname:$currentpass:$newpass:$context",
1.202 matthew 649: $server);
650: if (! $answer) {
651: &logthis("No reply on password change request to $server ".
652: "by $uname in domain $udom.");
653: } elsif ($answer =~ "^ok") {
654: &logthis("$uname in $udom successfully changed their password ".
655: "on $server.");
656: } elsif ($answer =~ "^pwchange_failure") {
657: &logthis("$uname in $udom was unable to change their password ".
658: "on $server. The action was blocked by either lcpasswd ".
659: "or pwchange");
660: } elsif ($answer =~ "^non_authorized") {
661: &logthis("$uname in $udom did not get their password correct when ".
662: "attempting to change it on $server.");
663: } elsif ($answer =~ "^auth_mode_error") {
664: &logthis("$uname in $udom attempted to change their password despite ".
665: "not being locally or internally authenticated on $server.");
666: } elsif ($answer =~ "^unknown_user") {
667: &logthis("$uname in $udom attempted to change their password ".
668: "on $server but were unable to because $server is not ".
669: "their home server.");
670: } elsif ($answer =~ "^refused") {
671: &logthis("$server refused to change $uname in $udom password because ".
672: "it was sent an unencrypted request to change the password.");
673: }
674: return $answer;
1.1 albertel 675: }
676:
1.169 harris41 677: # ----------------------- Try to determine user's current authentication scheme
678:
679: sub queryauthenticate {
680: my ($uname,$udom)=@_;
1.456 albertel 681: my $uhome=&homeserver($uname,$udom);
682: if (!$uhome) {
683: &logthis("User $uname at $udom is unknown when looking for authentication mechanism");
684: return 'no_host';
685: }
686: my $answer=reply("encrypt:currentauth:$udom:$uname",$uhome);
687: if ($answer =~ /^(unknown_user|refused|con_lost)/) {
688: &logthis("User $uname at $udom threw error $answer when checking authentication mechanism");
1.169 harris41 689: }
1.456 albertel 690: return $answer;
1.169 harris41 691: }
692:
1.1 albertel 693: # --------- Try to authenticate user from domain's lib servers (first this one)
1.11 www 694:
1.1 albertel 695: sub authenticate {
696: my ($uname,$upass,$udom)=@_;
1.807 albertel 697: $upass=&escape($upass);
698: $uname= &LONCAPA::clean_username($uname);
1.836 www 699: my $uhome=&homeserver($uname,$udom,1);
700: if ((!$uhome) || ($uhome eq 'no_host')) {
701: # Maybe the machine was offline and only re-appeared again recently?
702: &reconlonc();
703: # One more
704: my $uhome=&homeserver($uname,$udom,1);
705: if ((!$uhome) || ($uhome eq 'no_host')) {
706: &logthis("User $uname at $udom is unknown in authenticate");
707: }
1.471 albertel 708: return 'no_host';
1.1 albertel 709: }
1.471 albertel 710: my $answer=reply("encrypt:auth:$udom:$uname:$upass",$uhome);
711: if ($answer eq 'authorized') {
712: &logthis("User $uname at $udom authorized by $uhome");
713: return $uhome;
714: }
715: if ($answer eq 'non_authorized') {
716: &logthis("User $uname at $udom rejected by $uhome");
717: return 'no_host';
1.9 www 718: }
1.471 albertel 719: &logthis("User $uname at $udom threw error $answer when checking authentication mechanism");
1.1 albertel 720: return 'no_host';
721: }
722:
723: # ---------------------- Find the homebase for a user from domain's lib servers
1.11 www 724:
1.599 albertel 725: my %homecache;
1.1 albertel 726: sub homeserver {
1.230 stredwic 727: my ($uname,$udom,$ignoreBadCache)=@_;
1.1 albertel 728: my $index="$uname:$udom";
1.426 albertel 729:
1.599 albertel 730: if (exists($homecache{$index})) { return $homecache{$index}; }
1.841 albertel 731:
732: my %servers = &get_servers($udom,'library');
733: foreach my $tryserver (keys(%servers)) {
1.230 stredwic 734: next if ($ignoreBadCache ne 'true' &&
1.231 stredwic 735: exists($badServerCache{$tryserver}));
1.841 albertel 736:
737: my $answer=reply("home:$udom:$uname",$tryserver);
738: if ($answer eq 'found') {
739: delete($badServerCache{$tryserver});
740: return $homecache{$index}=$tryserver;
741: } elsif ($answer eq 'no_host') {
742: $badServerCache{$tryserver}=1;
743: }
1.1 albertel 744: }
745: return 'no_host';
1.70 www 746: }
747:
748: # ------------------------------------- Find the usernames behind a list of IDs
749:
750: sub idget {
751: my ($udom,@ids)=@_;
752: my %returnhash=();
753:
1.841 albertel 754: my %servers = &get_servers($udom,'library');
755: foreach my $tryserver (keys(%servers)) {
756: my $idlist=join('&',@ids);
757: $idlist=~tr/A-Z/a-z/;
758: my $reply=&reply("idget:$udom:".$idlist,$tryserver);
759: my @answer=();
760: if (($reply ne 'con_lost') && ($reply!~/^error\:/)) {
761: @answer=split(/\&/,$reply);
762: } ;
763: my $i;
764: for ($i=0;$i<=$#ids;$i++) {
765: if ($answer[$i]) {
766: $returnhash{$ids[$i]}=$answer[$i];
767: }
768: }
769: }
1.70 www 770: return %returnhash;
771: }
772:
773: # ------------------------------------- Find the IDs behind a list of usernames
774:
775: sub idrget {
776: my ($udom,@unames)=@_;
777: my %returnhash=();
1.800 albertel 778: foreach my $uname (@unames) {
779: $returnhash{$uname}=(&userenvironment($udom,$uname,'id'))[1];
1.191 harris41 780: }
1.70 www 781: return %returnhash;
782: }
783:
784: # ------------------------------- Store away a list of names and associated IDs
785:
786: sub idput {
787: my ($udom,%ids)=@_;
788: my %servers=();
1.800 albertel 789: foreach my $uname (keys(%ids)) {
790: &cput('environment',{'id'=>$ids{$uname}},$udom,$uname);
791: my $uhom=&homeserver($uname,$udom);
1.70 www 792: if ($uhom ne 'no_host') {
1.800 albertel 793: my $id=&escape($ids{$uname});
1.70 www 794: $id=~tr/A-Z/a-z/;
1.800 albertel 795: my $esc_unam=&escape($uname);
1.70 www 796: if ($servers{$uhom}) {
1.800 albertel 797: $servers{$uhom}.='&'.$id.'='.$esc_unam;
1.70 www 798: } else {
1.800 albertel 799: $servers{$uhom}=$id.'='.$esc_unam;
1.70 www 800: }
801: }
1.191 harris41 802: }
1.800 albertel 803: foreach my $server (keys(%servers)) {
804: &critical('idput:'.$udom.':'.$servers{$server},$server);
1.191 harris41 805: }
1.344 www 806: }
807:
1.806 raeburn 808: # ------------------------------------------- get items from domain db files
809:
810: sub get_dom {
1.860 raeburn 811: my ($namespace,$storearr,$udom,$uhome)=@_;
1.806 raeburn 812: my $items='';
813: foreach my $item (@$storearr) {
814: $items.=&escape($item).'&';
815: }
816: $items=~s/\&$//;
1.860 raeburn 817: if (!$udom) {
818: $udom=$env{'user.domain'};
819: if (defined(&domain($udom,'primary'))) {
820: $uhome=&domain($udom,'primary');
821: } else {
1.874 albertel 822: undef($uhome);
1.860 raeburn 823: }
824: } else {
825: if (!$uhome) {
826: if (defined(&domain($udom,'primary'))) {
827: $uhome=&domain($udom,'primary');
828: }
829: }
830: }
831: if ($udom && $uhome && ($uhome ne 'no_host')) {
1.806 raeburn 832: my $rep=&reply("getdom:$udom:$namespace:$items",$uhome);
1.866 raeburn 833: my %returnhash;
1.875 albertel 834: if ($rep eq '' || $rep =~ /^error: 2 /) {
1.866 raeburn 835: return %returnhash;
836: }
1.806 raeburn 837: my @pairs=split(/\&/,$rep);
838: if ( $#pairs==0 && $pairs[0] =~ /^(con_lost|error|no_such_host)/i) {
839: return @pairs;
840: }
841: my $i=0;
842: foreach my $item (@$storearr) {
843: $returnhash{$item}=&thaw_unescape($pairs[$i]);
844: $i++;
845: }
846: return %returnhash;
847: } else {
1.880 banghart 848: &logthis("get_dom failed - no homeserver and/or domain ($udom) ($uhome)");
1.806 raeburn 849: }
850: }
851:
852: # -------------------------------------------- put items in domain db files
853:
854: sub put_dom {
1.860 raeburn 855: my ($namespace,$storehash,$udom,$uhome)=@_;
856: if (!$udom) {
857: $udom=$env{'user.domain'};
858: if (defined(&domain($udom,'primary'))) {
859: $uhome=&domain($udom,'primary');
860: } else {
1.874 albertel 861: undef($uhome);
1.860 raeburn 862: }
863: } else {
864: if (!$uhome) {
865: if (defined(&domain($udom,'primary'))) {
866: $uhome=&domain($udom,'primary');
867: }
868: }
869: }
870: if ($udom && $uhome && ($uhome ne 'no_host')) {
1.806 raeburn 871: my $items='';
872: foreach my $item (keys(%$storehash)) {
873: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
874: }
875: $items=~s/\&$//;
876: return &reply("putdom:$udom:$namespace:$items",$uhome);
877: } else {
1.860 raeburn 878: &logthis("put_dom failed - no homeserver and/or domain");
1.806 raeburn 879: }
880: }
881:
1.837 raeburn 882: sub retrieve_inst_usertypes {
883: my ($udom) = @_;
884: my (%returnhash,@order);
1.846 albertel 885: if (defined(&domain($udom,'primary'))) {
886: my $uhome=&domain($udom,'primary');
1.837 raeburn 887: my $rep=&reply("inst_usertypes:$udom",$uhome);
888: my ($hashitems,$orderitems) = split(/:/,$rep);
889: my @pairs=split(/\&/,$hashitems);
890: foreach my $item (@pairs) {
891: my ($key,$value)=split(/=/,$item,2);
892: $key = &unescape($key);
893: next if ($key =~ /^error: 2 /);
894: $returnhash{$key}=&thaw_unescape($value);
895: }
896: my @esc_order = split(/\&/,$orderitems);
897: foreach my $item (@esc_order) {
898: push(@order,&unescape($item));
899: }
900: } else {
901: &logthis("get_dom failed - no primary domain server for $udom");
902: }
903: return (\%returnhash,\@order);
904: }
905:
1.868 raeburn 906: sub is_domainimage {
907: my ($url) = @_;
908: if ($url=~m-^/+res/+($match_domain)/+\1\-domainconfig/+(img|logo|domlogo)/+-) {
909: if (&domain($1) ne '') {
910: return '1';
911: }
912: }
913: return;
914: }
915:
1.899 raeburn 916: sub inst_directory_query {
917: my ($srch) = @_;
918: my $udom = $srch->{'srchdomain'};
919: my %results;
920: my $homeserver = &domain($udom,'primary');
1.909 raeburn 921: my $outcome;
1.899 raeburn 922: if ($homeserver ne '') {
1.904 albertel 923: my $queryid=&reply("querysend:instdirsearch:".
924: &escape($srch->{'srchby'}).':'.
925: &escape($srch->{'srchterm'}).':'.
926: &escape($srch->{'srchtype'}),$homeserver);
927: my $host=&hostname($homeserver);
928: if ($queryid !~/^\Q$host\E\_/) {
929: &logthis('instituional directory search invalid queryid: '.$queryid.' for host: '.$homeserver.'in domain '.$udom);
930: return;
931: }
932: my $response = &get_query_reply($queryid);
933: my $maxtries = 5;
934: my $tries = 1;
935: while (($response=~/^timeout/) && ($tries < $maxtries)) {
936: $response = &get_query_reply($queryid);
937: $tries ++;
938: }
939:
940: if (!&error($response) && $response ne 'refused') {
1.909 raeburn 941: if ($response eq 'unavailable') {
942: $outcome = $response;
943: } else {
944: $outcome = 'ok';
945: my @matches = split(/\n/,$response);
946: foreach my $match (@matches) {
947: my ($key,$value) = split(/=/,$match);
948: $results{&unescape($key).':'.$udom} = &thaw_unescape($value);
949: }
1.899 raeburn 950: }
951: }
952: }
1.909 raeburn 953: return ($outcome,%results);
1.899 raeburn 954: }
955:
956: sub usersearch {
957: my ($srch) = @_;
958: my $dom = $srch->{'srchdomain'};
959: my %results;
960: my %libserv = &all_library();
961: my $query = 'usersearch';
962: foreach my $tryserver (keys(%libserv)) {
963: if (&host_domain($tryserver) eq $dom) {
964: my $host=&hostname($tryserver);
965: my $queryid=
1.911 raeburn 966: &reply("querysend:".&escape($query).':'.
967: &escape($srch->{'srchby'}).':'.
1.899 raeburn 968: &escape($srch->{'srchtype'}).':'.
969: &escape($srch->{'srchterm'}),$tryserver);
970: if ($queryid !~/^\Q$host\E\_/) {
971: &logthis('usersearch: invalid queryid: '.$queryid.' for host: '.$host.'in domain '.$dom.' and server: '.$tryserver);
1.902 raeburn 972: next;
1.899 raeburn 973: }
974: my $reply = &get_query_reply($queryid);
975: my $maxtries = 1;
976: my $tries = 1;
977: while (($reply=~/^timeout/) && ($tries < $maxtries)) {
978: $reply = &get_query_reply($queryid);
979: $tries ++;
980: }
981: if ( ($reply =~/^timeout/) || ($reply =~/^error/) ) {
982: &logthis('usersrch error: '.$reply.' for '.$dom.' - searching for : '.$srch->{'srchterm'}.' by '.$srch->{'srchby'}.' ('.$srch->{'srchtype'}.') - maxtries: '.$maxtries.' tries: '.$tries);
983: } else {
1.911 raeburn 984: my @matches;
985: if ($reply =~ /\n/) {
986: @matches = split(/\n/,$reply);
987: } else {
988: @matches = split(/\&/,$reply);
989: }
1.899 raeburn 990: foreach my $match (@matches) {
991: my ($uname,$udom,%userhash);
1.911 raeburn 992: foreach my $entry (split(/:/,$match)) {
993: my ($key,$value) =
994: map {&unescape($_);} split(/=/,$entry);
1.899 raeburn 995: $userhash{$key} = $value;
996: if ($key eq 'username') {
997: $uname = $value;
998: } elsif ($key eq 'domain') {
999: $udom = $value;
1.911 raeburn 1000: }
1.899 raeburn 1001: }
1002: $results{$uname.':'.$udom} = \%userhash;
1003: }
1004: }
1005: }
1006: }
1007: return %results;
1008: }
1009:
1.912 raeburn 1010: sub get_instuser {
1011: my ($udom,$uname,$id) = @_;
1012: my $homeserver = &domain($udom,'primary');
1013: my ($outcome,%results);
1014: if ($homeserver ne '') {
1015: my $queryid=&reply("querysend:getinstuser:".&escape($uname).':'.
1016: &escape($id).':'.&escape($udom),$homeserver);
1017: my $host=&hostname($homeserver);
1018: if ($queryid !~/^\Q$host\E\_/) {
1019: &logthis('get_instuser invalid queryid: '.$queryid.' for host: '.$homeserver.'in domain '.$udom);
1020: return;
1021: }
1022: my $response = &get_query_reply($queryid);
1023: my $maxtries = 5;
1024: my $tries = 1;
1025: while (($response=~/^timeout/) && ($tries < $maxtries)) {
1026: $response = &get_query_reply($queryid);
1027: $tries ++;
1028: }
1029: if (!&error($response) && $response ne 'refused') {
1030: if ($response eq 'unavailable') {
1031: $outcome = $response;
1032: } else {
1033: $outcome = 'ok';
1034: my @matches = split(/\n/,$response);
1035: foreach my $match (@matches) {
1036: my ($key,$value) = split(/=/,$match);
1037: $results{&unescape($key)} = &thaw_unescape($value);
1038: }
1039: }
1040: }
1041: }
1042: my %userinfo;
1043: if (ref($results{$uname}) eq 'HASH') {
1044: %userinfo = %{$results{$uname}};
1045: }
1046: return ($outcome,%userinfo);
1047: }
1048:
1049: sub inst_rulecheck {
1.923 raeburn 1050: my ($udom,$uname,$id,$item,$rules) = @_;
1.912 raeburn 1051: my %returnhash;
1052: if ($udom ne '') {
1053: if (ref($rules) eq 'ARRAY') {
1054: @{$rules} = map {&escape($_);} (@{$rules});
1055: my $rulestr = join(':',@{$rules});
1056: my $homeserver=&domain($udom,'primary');
1057: if (($homeserver ne '') && ($homeserver ne 'no_host')) {
1.923 raeburn 1058: my $response;
1059: if ($item eq 'username') {
1060: $response=&unescape(&reply('instrulecheck:'.&escape($udom).
1061: ':'.&escape($uname).':'.$rulestr,
1.912 raeburn 1062: $homeserver));
1.923 raeburn 1063: } elsif ($item eq 'id') {
1064: $response=&unescape(&reply('instidrulecheck:'.&escape($udom).
1065: ':'.&escape($id).':'.$rulestr,
1066: $homeserver));
1067: }
1.912 raeburn 1068: if ($response ne 'refused') {
1069: my @pairs=split(/\&/,$response);
1070: foreach my $item (@pairs) {
1071: my ($key,$value)=split(/=/,$item,2);
1072: $key = &unescape($key);
1073: next if ($key =~ /^error: 2 /);
1074: $returnhash{$key}=&thaw_unescape($value);
1075: }
1076: }
1077: }
1078: }
1079: }
1080: return %returnhash;
1081: }
1082:
1083: sub inst_userrules {
1.923 raeburn 1084: my ($udom,$check) = @_;
1.912 raeburn 1085: my (%ruleshash,@ruleorder);
1086: if ($udom ne '') {
1087: my $homeserver=&domain($udom,'primary');
1088: if (($homeserver ne '') && ($homeserver ne 'no_host')) {
1.923 raeburn 1089: my $response;
1090: if ($check eq 'id') {
1091: $response=&reply('instidrules:'.&escape($udom),
1.912 raeburn 1092: $homeserver);
1.923 raeburn 1093: } else {
1094: $response=&reply('instuserrules:'.&escape($udom),
1095: $homeserver);
1096: }
1.912 raeburn 1097: if (($response ne 'refused') && ($response ne 'error') &&
1.923 raeburn 1098: ($response ne 'unknown_cmd') &&
1.912 raeburn 1099: ($response ne 'no_such_host')) {
1100: my ($hashitems,$orderitems) = split(/:/,$response);
1101: my @pairs=split(/\&/,$hashitems);
1102: foreach my $item (@pairs) {
1103: my ($key,$value)=split(/=/,$item,2);
1104: $key = &unescape($key);
1105: next if ($key =~ /^error: 2 /);
1106: $ruleshash{$key}=&thaw_unescape($value);
1107: }
1108: my @esc_order = split(/\&/,$orderitems);
1109: foreach my $item (@esc_order) {
1110: push(@ruleorder,&unescape($item));
1111: }
1112: }
1113: }
1114: }
1115: return (\%ruleshash,\@ruleorder);
1116: }
1117:
1.344 www 1118: # --------------------------------------------------- Assign a key to a student
1119:
1120: sub assign_access_key {
1.364 www 1121: #
1122: # a valid key looks like uname:udom#comments
1123: # comments are being appended
1124: #
1.498 www 1125: my ($ckey,$kdom,$knum,$cdom,$cnum,$udom,$uname,$logentry)=@_;
1126: $kdom=
1.620 albertel 1127: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($kdom));
1.498 www 1128: $knum=
1.620 albertel 1129: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($knum));
1.344 www 1130: $cdom=
1.620 albertel 1131: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
1.344 www 1132: $cnum=
1.620 albertel 1133: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
1134: $udom=$env{'user.name'} unless (defined($udom));
1135: $uname=$env{'user.domain'} unless (defined($uname));
1.498 www 1136: my %existing=&get('accesskeys',[$ckey],$kdom,$knum);
1.364 www 1137: if (($existing{$ckey}=~/^\#(.*)$/) || # - new key
1.479 albertel 1138: ($existing{$ckey}=~/^\Q$uname\E\:\Q$udom\E\#(.*)$/)) {
1.364 www 1139: # assigned to this person
1140: # - this should not happen,
1.345 www 1141: # unless something went wrong
1142: # the first time around
1143: # ready to assign
1.364 www 1144: $logentry=$1.'; '.$logentry;
1.496 www 1145: if (&put('accesskeys',{$ckey=>$uname.':'.$udom.'#'.$logentry},
1.498 www 1146: $kdom,$knum) eq 'ok') {
1.345 www 1147: # key now belongs to user
1.346 www 1148: my $envkey='key.'.$cdom.'_'.$cnum;
1.345 www 1149: if (&put('environment',{$envkey => $ckey}) eq 'ok') {
1150: &appenv('environment.'.$envkey => $ckey);
1151: return 'ok';
1152: } else {
1153: return
1154: 'error: Count not permanently assign key, will need to be re-entered later.';
1155: }
1156: } else {
1157: return 'error: Could not assign key, try again later.';
1158: }
1.364 www 1159: } elsif (!$existing{$ckey}) {
1.345 www 1160: # the key does not exist
1161: return 'error: The key does not exist';
1162: } else {
1163: # the key is somebody else's
1164: return 'error: The key is already in use';
1165: }
1.344 www 1166: }
1167:
1.364 www 1168: # ------------------------------------------ put an additional comment on a key
1169:
1170: sub comment_access_key {
1171: #
1172: # a valid key looks like uname:udom#comments
1173: # comments are being appended
1174: #
1175: my ($ckey,$cdom,$cnum,$logentry)=@_;
1176: $cdom=
1.620 albertel 1177: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
1.364 www 1178: $cnum=
1.620 albertel 1179: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
1.364 www 1180: my %existing=&get('accesskeys',[$ckey],$cdom,$cnum);
1181: if ($existing{$ckey}) {
1182: $existing{$ckey}.='; '.$logentry;
1183: # ready to assign
1.367 www 1184: if (&put('accesskeys',{$ckey=>$existing{$ckey}},
1.364 www 1185: $cdom,$cnum) eq 'ok') {
1186: return 'ok';
1187: } else {
1188: return 'error: Count not store comment.';
1189: }
1190: } else {
1191: # the key does not exist
1192: return 'error: The key does not exist';
1193: }
1194: }
1195:
1.344 www 1196: # ------------------------------------------------------ Generate a set of keys
1197:
1198: sub generate_access_keys {
1.364 www 1199: my ($number,$cdom,$cnum,$logentry)=@_;
1.344 www 1200: $cdom=
1.620 albertel 1201: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
1.344 www 1202: $cnum=
1.620 albertel 1203: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
1.361 www 1204: unless (&allowed('mky',$cdom)) { return 0; }
1.344 www 1205: unless (($cdom) && ($cnum)) { return 0; }
1206: if ($number>10000) { return 0; }
1207: sleep(2); # make sure don't get same seed twice
1208: srand(time()^($$+($$<<15))); # from "Programming Perl"
1209: my $total=0;
1210: for (my $i=1;$i<=$number;$i++) {
1211: my $newkey=sprintf("%lx",int(100000*rand)).'-'.
1212: sprintf("%lx",int(100000*rand)).'-'.
1213: sprintf("%lx",int(100000*rand));
1214: $newkey=~s/1/g/g; # folks mix up 1 and l
1215: $newkey=~s/0/h/g; # and also 0 and O
1216: my %existing=&get('accesskeys',[$newkey],$cdom,$cnum);
1217: if ($existing{$newkey}) {
1218: $i--;
1219: } else {
1.364 www 1220: if (&put('accesskeys',
1221: { $newkey => '# generated '.localtime().
1.620 albertel 1222: ' by '.$env{'user.name'}.'@'.$env{'user.domain'}.
1.364 www 1223: '; '.$logentry },
1224: $cdom,$cnum) eq 'ok') {
1.344 www 1225: $total++;
1226: }
1227: }
1228: }
1.620 albertel 1229: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},
1.344 www 1230: 'Generated '.$total.' keys for '.$cnum.' at '.$cdom);
1231: return $total;
1232: }
1233:
1234: # ------------------------------------------------------- Validate an accesskey
1235:
1236: sub validate_access_key {
1237: my ($ckey,$cdom,$cnum,$udom,$uname)=@_;
1238: $cdom=
1.620 albertel 1239: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
1.344 www 1240: $cnum=
1.620 albertel 1241: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
1242: $udom=$env{'user.domain'} unless (defined($udom));
1243: $uname=$env{'user.name'} unless (defined($uname));
1.345 www 1244: my %existing=&get('accesskeys',[$ckey],$cdom,$cnum);
1.479 albertel 1245: return ($existing{$ckey}=~/^\Q$uname\E\:\Q$udom\E\#/);
1.70 www 1246: }
1247:
1248: # ------------------------------------- Find the section of student in a course
1.652 albertel 1249: sub devalidate_getsection_cache {
1250: my ($udom,$unam,$courseid)=@_;
1251: my $hashid="$udom:$unam:$courseid";
1252: &devalidate_cache_new('getsection',$hashid);
1253: }
1.298 matthew 1254:
1.815 albertel 1255: sub courseid_to_courseurl {
1256: my ($courseid) = @_;
1257: #already url style courseid
1258: return $courseid if ($courseid =~ m{^/});
1259:
1260: if (exists($env{'course.'.$courseid.'.num'})) {
1261: my $cnum = $env{'course.'.$courseid.'.num'};
1262: my $cdom = $env{'course.'.$courseid.'.domain'};
1263: return "/$cdom/$cnum";
1264: }
1265:
1266: my %courseinfo=&Apache::lonnet::coursedescription($courseid);
1267: if (exists($courseinfo{'num'})) {
1268: return "/$courseinfo{'domain'}/$courseinfo{'num'}";
1269: }
1270:
1271: return undef;
1272: }
1273:
1.298 matthew 1274: sub getsection {
1275: my ($udom,$unam,$courseid)=@_;
1.599 albertel 1276: my $cachetime=1800;
1.551 albertel 1277:
1278: my $hashid="$udom:$unam:$courseid";
1.599 albertel 1279: my ($result,$cached)=&is_cached_new('getsection',$hashid);
1.551 albertel 1280: if (defined($cached)) { return $result; }
1281:
1.298 matthew 1282: my %Pending;
1283: my %Expired;
1284: #
1285: # Each role can either have not started yet (pending), be active,
1286: # or have expired.
1287: #
1288: # If there is an active role, we are done.
1289: #
1290: # If there is more than one role which has not started yet,
1291: # choose the one which will start sooner
1292: # If there is one role which has not started yet, return it.
1293: #
1294: # If there is more than one expired role, choose the one which ended last.
1295: # If there is a role which has expired, return it.
1296: #
1.815 albertel 1297: $courseid = &courseid_to_courseurl($courseid);
1.817 raeburn 1298: my %roleshash = &dump('roles',$udom,$unam,$courseid);
1299: foreach my $key (keys(%roleshash)) {
1.479 albertel 1300: next if ($key !~/^\Q$courseid\E(?:\/)*(\w+)*\_st$/);
1.298 matthew 1301: my $section=$1;
1302: if ($key eq $courseid.'_st') { $section=''; }
1.817 raeburn 1303: my ($dummy,$end,$start)=split(/\_/,&unescape($roleshash{$key}));
1.298 matthew 1304: my $now=time;
1.548 albertel 1305: if (defined($end) && $end && ($now > $end)) {
1.298 matthew 1306: $Expired{$end}=$section;
1307: next;
1308: }
1.548 albertel 1309: if (defined($start) && $start && ($now < $start)) {
1.298 matthew 1310: $Pending{$start}=$section;
1311: next;
1312: }
1.599 albertel 1313: return &do_cache_new('getsection',$hashid,$section,$cachetime);
1.298 matthew 1314: }
1315: #
1316: # Presumedly there will be few matching roles from the above
1317: # loop and the sorting time will be negligible.
1318: if (scalar(keys(%Pending))) {
1319: my ($time) = sort {$a <=> $b} keys(%Pending);
1.599 albertel 1320: return &do_cache_new('getsection',$hashid,$Pending{$time},$cachetime);
1.298 matthew 1321: }
1322: if (scalar(keys(%Expired))) {
1323: my @sorted = sort {$a <=> $b} keys(%Expired);
1324: my $time = pop(@sorted);
1.599 albertel 1325: return &do_cache_new('getsection',$hashid,$Expired{$time},$cachetime);
1.298 matthew 1326: }
1.599 albertel 1327: return &do_cache_new('getsection',$hashid,'-1',$cachetime);
1.298 matthew 1328: }
1.70 www 1329:
1.599 albertel 1330: sub save_cache {
1331: &purge_remembered();
1.722 albertel 1332: #&Apache::loncommon::validate_page();
1.620 albertel 1333: undef(%env);
1.780 albertel 1334: undef($env_loaded);
1.599 albertel 1335: }
1.452 albertel 1336:
1.599 albertel 1337: my $to_remember=-1;
1338: my %remembered;
1339: my %accessed;
1340: my $kicks=0;
1341: my $hits=0;
1.849 albertel 1342: sub make_key {
1343: my ($name,$id) = @_;
1.872 albertel 1344: if (length($id) > 65
1345: && length(&escape($id)) > 200) {
1346: $id=length($id).':'.&Digest::MD5::md5_hex($id);
1347: }
1.849 albertel 1348: return &escape($name.':'.$id);
1349: }
1350:
1.599 albertel 1351: sub devalidate_cache_new {
1352: my ($name,$id,$debug) = @_;
1353: if ($debug) { &Apache::lonnet::logthis("deleting $name:$id"); }
1.849 albertel 1354: $id=&make_key($name,$id);
1.599 albertel 1355: $memcache->delete($id);
1356: delete($remembered{$id});
1357: delete($accessed{$id});
1358: }
1359:
1360: sub is_cached_new {
1361: my ($name,$id,$debug) = @_;
1.849 albertel 1362: $id=&make_key($name,$id);
1.599 albertel 1363: if (exists($remembered{$id})) {
1364: if ($debug) { &Apache::lonnet::logthis("Earyl return $id of $remembered{$id} "); }
1365: $accessed{$id}=[&gettimeofday()];
1366: $hits++;
1367: return ($remembered{$id},1);
1368: }
1369: my $value = $memcache->get($id);
1370: if (!(defined($value))) {
1371: if ($debug) { &Apache::lonnet::logthis("getting $id is not defined"); }
1.417 albertel 1372: return (undef,undef);
1.416 albertel 1373: }
1.599 albertel 1374: if ($value eq '__undef__') {
1375: if ($debug) { &Apache::lonnet::logthis("getting $id is __undef__"); }
1376: $value=undef;
1377: }
1378: &make_room($id,$value,$debug);
1379: if ($debug) { &Apache::lonnet::logthis("getting $id is $value"); }
1380: return ($value,1);
1381: }
1382:
1383: sub do_cache_new {
1384: my ($name,$id,$value,$time,$debug) = @_;
1.849 albertel 1385: $id=&make_key($name,$id);
1.599 albertel 1386: my $setvalue=$value;
1387: if (!defined($setvalue)) {
1388: $setvalue='__undef__';
1389: }
1.623 albertel 1390: if (!defined($time) ) {
1391: $time=600;
1392: }
1.599 albertel 1393: if ($debug) { &Apache::lonnet::logthis("Setting $id to $value"); }
1.910 albertel 1394: my $result = $memcache->set($id,$setvalue,$time);
1395: if (! $result) {
1.872 albertel 1396: &logthis("caching of id -> $id failed");
1.910 albertel 1397: $memcache->disconnect_all();
1.872 albertel 1398: }
1.600 albertel 1399: # need to make a copy of $value
1.919 albertel 1400: &make_room($id,$value,$debug);
1.599 albertel 1401: return $value;
1402: }
1403:
1404: sub make_room {
1405: my ($id,$value,$debug)=@_;
1.919 albertel 1406:
1407: $remembered{$id}= (ref($value)) ? &Storable::dclone($value)
1408: : $value;
1.599 albertel 1409: if ($to_remember<0) { return; }
1410: $accessed{$id}=[&gettimeofday()];
1411: if (scalar(keys(%remembered)) <= $to_remember) { return; }
1412: my $to_kick;
1413: my $max_time=0;
1414: foreach my $other (keys(%accessed)) {
1415: if (&tv_interval($accessed{$other}) > $max_time) {
1416: $to_kick=$other;
1417: $max_time=&tv_interval($accessed{$other});
1418: }
1419: }
1420: delete($remembered{$to_kick});
1421: delete($accessed{$to_kick});
1422: $kicks++;
1423: if ($debug) { &logthis("kicking $to_kick $max_time $kicks\n"); }
1.541 albertel 1424: return;
1425: }
1426:
1.599 albertel 1427: sub purge_remembered {
1.604 albertel 1428: #&logthis("Tossing ".scalar(keys(%remembered)));
1429: #&logthis(sprintf("%-20s is %s",'%remembered',length(&freeze(\%remembered))));
1.599 albertel 1430: undef(%remembered);
1431: undef(%accessed);
1.428 albertel 1432: }
1.70 www 1433: # ------------------------------------- Read an entry from a user's environment
1434:
1435: sub userenvironment {
1436: my ($udom,$unam,@what)=@_;
1437: my %returnhash=();
1438: my @answer=split(/\&/,
1439: &reply('get:'.$udom.':'.$unam.':environment:'.join('&',@what),
1440: &homeserver($unam,$udom)));
1441: my $i;
1442: for ($i=0;$i<=$#what;$i++) {
1443: $returnhash{$what[$i]}=&unescape($answer[$i]);
1444: }
1445: return %returnhash;
1.1 albertel 1446: }
1447:
1.617 albertel 1448: # ---------------------------------------------------------- Get a studentphoto
1449: sub studentphoto {
1450: my ($udom,$unam,$ext) = @_;
1451: my $home=&Apache::lonnet::homeserver($unam,$udom);
1.706 raeburn 1452: if (defined($env{'request.course.id'})) {
1.708 raeburn 1453: if ($env{'course.'.$env{'request.course.id'}.'.internal.showphoto'}) {
1.706 raeburn 1454: if ($udom eq $env{'course.'.$env{'request.course.id'}.'.domain'}) {
1455: return(&retrievestudentphoto($udom,$unam,$ext));
1456: } else {
1457: my ($result,$perm_reqd)=
1.707 albertel 1458: &Apache::lonnet::auto_photo_permission($unam,$udom);
1.706 raeburn 1459: if ($result eq 'ok') {
1460: if (!($perm_reqd eq 'yes')) {
1461: return(&retrievestudentphoto($udom,$unam,$ext));
1462: }
1463: }
1464: }
1465: }
1466: } else {
1467: my ($result,$perm_reqd) =
1.707 albertel 1468: &Apache::lonnet::auto_photo_permission($unam,$udom);
1.706 raeburn 1469: if ($result eq 'ok') {
1470: if (!($perm_reqd eq 'yes')) {
1471: return(&retrievestudentphoto($udom,$unam,$ext));
1472: }
1473: }
1474: }
1475: return '/adm/lonKaputt/lonlogo_broken.gif';
1476: }
1477:
1478: sub retrievestudentphoto {
1479: my ($udom,$unam,$ext,$type) = @_;
1480: my $home=&Apache::lonnet::homeserver($unam,$udom);
1481: my $ret=&Apache::lonnet::reply("studentphoto:$udom:$unam:$ext:$type",$home);
1482: if ($ret eq 'ok') {
1483: my $url="/uploaded/$udom/$unam/internal/studentphoto.$ext";
1484: if ($type eq 'thumbnail') {
1485: $url="/uploaded/$udom/$unam/internal/studentphoto_tn.$ext";
1486: }
1487: my $tokenurl=&Apache::lonnet::tokenwrapper($url);
1488: return $tokenurl;
1489: } else {
1490: if ($type eq 'thumbnail') {
1491: return '/adm/lonKaputt/genericstudent_tn.gif';
1492: } else {
1493: return '/adm/lonKaputt/lonlogo_broken.gif';
1494: }
1.617 albertel 1495: }
1496: }
1497:
1.263 www 1498: # -------------------------------------------------------------------- New chat
1499:
1500: sub chatsend {
1.724 raeburn 1501: my ($newentry,$anon,$group)=@_;
1.620 albertel 1502: my $cnum=$env{'course.'.$env{'request.course.id'}.'.num'};
1503: my $cdom=$env{'course.'.$env{'request.course.id'}.'.domain'};
1504: my $chome=$env{'course.'.$env{'request.course.id'}.'.home'};
1.263 www 1505: &reply('chatsend:'.$cdom.':'.$cnum.':'.
1.620 albertel 1506: &escape($env{'user.domain'}.':'.$env{'user.name'}.':'.$anon.':'.
1.724 raeburn 1507: &escape($newentry)).':'.$group,$chome);
1.292 www 1508: }
1509:
1510: # ------------------------------------------ Find current version of a resource
1511:
1512: sub getversion {
1513: my $fname=&clutter(shift);
1514: unless ($fname=~/^\/res\//) { return -1; }
1515: return ¤tversion(&filelocation('',$fname));
1516: }
1517:
1518: sub currentversion {
1519: my $fname=shift;
1.599 albertel 1520: my ($result,$cached)=&is_cached_new('resversion',$fname);
1.440 www 1521: if (defined($cached)) { return $result; }
1.292 www 1522: my $author=$fname;
1523: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
1524: my ($udom,$uname)=split(/\//,$author);
1525: my $home=homeserver($uname,$udom);
1526: if ($home eq 'no_host') {
1527: return -1;
1528: }
1529: my $answer=reply("currentversion:$fname",$home);
1530: if (($answer eq 'con_lost') || ($answer eq 'rejected')) {
1531: return -1;
1532: }
1.599 albertel 1533: return &do_cache_new('resversion',$fname,$answer,600);
1.263 www 1534: }
1535:
1.1 albertel 1536: # ----------------------------- Subscribe to a resource, return URL if possible
1.11 www 1537:
1.1 albertel 1538: sub subscribe {
1539: my $fname=shift;
1.761 raeburn 1540: if ($fname=~/\/(aboutme|syllabus|bulletinboard|smppg)$/) { return ''; }
1.532 albertel 1541: $fname=~s/[\n\r]//g;
1.1 albertel 1542: my $author=$fname;
1543: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
1544: my ($udom,$uname)=split(/\//,$author);
1545: my $home=homeserver($uname,$udom);
1.335 albertel 1546: if ($home eq 'no_host') {
1547: return 'not_found';
1.1 albertel 1548: }
1549: my $answer=reply("sub:$fname",$home);
1.64 www 1550: if (($answer eq 'con_lost') || ($answer eq 'rejected')) {
1551: $answer.=' by '.$home;
1552: }
1.1 albertel 1553: return $answer;
1554: }
1555:
1.8 www 1556: # -------------------------------------------------------------- Replicate file
1557:
1558: sub repcopy {
1559: my $filename=shift;
1.23 www 1560: $filename=~s/\/+/\//g;
1.607 raeburn 1561: if ($filename=~m|^/home/httpd/html/adm/|) { return 'ok'; }
1562: if ($filename=~m|^/home/httpd/html/lonUsers/|) { return 'ok'; }
1.538 albertel 1563: if ($filename=~m|^/home/httpd/html/userfiles/| or
1.609 banghart 1564: $filename=~m -^/*(uploaded|editupload)/-) {
1.538 albertel 1565: return &repcopy_userfile($filename);
1566: }
1.532 albertel 1567: $filename=~s/[\n\r]//g;
1.8 www 1568: my $transname="$filename.in.transfer";
1.828 www 1569: # FIXME: this should flock
1.607 raeburn 1570: if ((-e $filename) || (-e $transname)) { return 'ok'; }
1.8 www 1571: my $remoteurl=subscribe($filename);
1.64 www 1572: if ($remoteurl =~ /^con_lost by/) {
1573: &logthis("Subscribe returned $remoteurl: $filename");
1.607 raeburn 1574: return 'unavailable';
1.8 www 1575: } elsif ($remoteurl eq 'not_found') {
1.441 albertel 1576: #&logthis("Subscribe returned not_found: $filename");
1.607 raeburn 1577: return 'not_found';
1.64 www 1578: } elsif ($remoteurl =~ /^rejected by/) {
1579: &logthis("Subscribe returned $remoteurl: $filename");
1.607 raeburn 1580: return 'forbidden';
1.20 www 1581: } elsif ($remoteurl eq 'directory') {
1.607 raeburn 1582: return 'ok';
1.8 www 1583: } else {
1.290 www 1584: my $author=$filename;
1585: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
1586: my ($udom,$uname)=split(/\//,$author);
1587: my $home=homeserver($uname,$udom);
1588: unless ($home eq $perlvar{'lonHostID'}) {
1.8 www 1589: my @parts=split(/\//,$filename);
1590: my $path="/$parts[1]/$parts[2]/$parts[3]/$parts[4]";
1591: if ($path ne "$perlvar{'lonDocRoot'}/res") {
1592: &logthis("Malconfiguration for replication: $filename");
1.607 raeburn 1593: return 'bad_request';
1.8 www 1594: }
1595: my $count;
1596: for ($count=5;$count<$#parts;$count++) {
1597: $path.="/$parts[$count]";
1598: if ((-e $path)!=1) {
1599: mkdir($path,0777);
1600: }
1601: }
1602: my $ua=new LWP::UserAgent;
1603: my $request=new HTTP::Request('GET',"$remoteurl");
1604: my $response=$ua->request($request,$transname);
1605: if ($response->is_error()) {
1606: unlink($transname);
1607: my $message=$response->status_line;
1.672 albertel 1608: &logthis("<font color=\"blue\">WARNING:"
1.12 www 1609: ." LWP get: $message: $filename</font>");
1.607 raeburn 1610: return 'unavailable';
1.8 www 1611: } else {
1.16 www 1612: if ($remoteurl!~/\.meta$/) {
1613: my $mrequest=new HTTP::Request('GET',$remoteurl.'.meta');
1614: my $mresponse=$ua->request($mrequest,$filename.'.meta');
1615: if ($mresponse->is_error()) {
1616: unlink($filename.'.meta');
1617: &logthis(
1.672 albertel 1618: "<font color=\"yellow\">INFO: No metadata: $filename</font>");
1.16 www 1619: }
1620: }
1.8 www 1621: rename($transname,$filename);
1.607 raeburn 1622: return 'ok';
1.8 www 1623: }
1.290 www 1624: }
1.8 www 1625: }
1.330 www 1626: }
1627:
1628: # ------------------------------------------------ Get server side include body
1629: sub ssi_body {
1.381 albertel 1630: my ($filelink,%form)=@_;
1.606 matthew 1631: if (! exists($form{'LONCAPA_INTERNAL_no_discussion'})) {
1632: $form{'LONCAPA_INTERNAL_no_discussion'}='true';
1633: }
1.330 www 1634: my $output=($filelink=~/^http\:/?&externalssi($filelink):
1.381 albertel 1635: &ssi($filelink,%form));
1.778 albertel 1636: $output=~s|//(\s*<!--)? BEGIN LON-CAPA Internal.+?// END LON-CAPA Internal\s*(-->)?\s||gs;
1.451 albertel 1637: $output=~s/^.*?\<body[^\>]*\>//si;
1638: $output=~s/(.*)\<\/body\s*\>.*?$/$1/si;
1.330 www 1639: return $output;
1.8 www 1640: }
1641:
1.15 www 1642: # --------------------------------------------------------- Server Side Include
1643:
1.782 albertel 1644: sub absolute_url {
1645: my ($host_name) = @_;
1646: my $protocol = ($ENV{'SERVER_PORT'} == 443?'https://':'http://');
1647: if ($host_name eq '') {
1648: $host_name = $ENV{'SERVER_NAME'};
1649: }
1650: return $protocol.$host_name;
1651: }
1652:
1.15 www 1653: sub ssi {
1654:
1.23 www 1655: my ($fn,%form)=@_;
1.15 www 1656:
1657: my $ua=new LWP::UserAgent;
1.23 www 1658:
1659: my $request;
1.711 albertel 1660:
1661: $form{'no_update_last_known'}=1;
1.895 albertel 1662: &Apache::lonenc::check_encrypt(\$fn);
1.23 www 1663: if (%form) {
1.782 albertel 1664: $request=new HTTP::Request('POST',&absolute_url().$fn);
1.201 albertel 1665: $request->content(join('&',map { &escape($_).'='.&escape($form{$_}) } keys %form));
1.23 www 1666: } else {
1.782 albertel 1667: $request=new HTTP::Request('GET',&absolute_url().$fn);
1.23 www 1668: }
1669:
1.15 www 1670: $request->header(Cookie => $ENV{'HTTP_COOKIE'});
1671: my $response=$ua->request($request);
1672:
1.324 www 1673: return $response->content;
1674: }
1675:
1676: sub externalssi {
1677: my ($url)=@_;
1678: my $ua=new LWP::UserAgent;
1679: my $request=new HTTP::Request('GET',$url);
1680: my $response=$ua->request($request);
1.15 www 1681: return $response->content;
1682: }
1.254 www 1683:
1.492 albertel 1684: # -------------------------------- Allow a /uploaded/ URI to be vouched for
1685:
1686: sub allowuploaded {
1687: my ($srcurl,$url)=@_;
1688: $url=&clutter(&declutter($url));
1689: my $dir=$url;
1690: $dir=~s/\/[^\/]+$//;
1691: my %httpref=();
1692: my $httpurl=&hreflocation('',$url);
1693: $httpref{'httpref.'.$httpurl}=$srcurl;
1694: &Apache::lonnet::appenv(%httpref);
1.254 www 1695: }
1.477 raeburn 1696:
1.478 albertel 1697: # --------- File operations in /home/httpd/html/userfiles/$domain/1/2/3/$course
1.638 albertel 1698: # input: action, courseID, current domain, intended
1.637 raeburn 1699: # path to file, source of file, instruction to parse file for objects,
1700: # ref to hash for embedded objects,
1701: # ref to hash for codebase of java objects.
1702: #
1.485 raeburn 1703: # output: url to file (if action was uploaddoc),
1704: # ok if successful, or diagnostic message otherwise (if action was propagate or copy)
1.477 raeburn 1705: #
1.478 albertel 1706: # Allows directory structure to be used within lonUsers/../userfiles/ for a
1707: # course.
1.477 raeburn 1708: #
1.478 albertel 1709: # action = propagate - /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
1710: # will be copied to /home/httpd/lonUsers/1/2/3/$course/userfiles in
1711: # course's home server.
1.477 raeburn 1712: #
1.478 albertel 1713: # action = copy - /home/httpd/html/userfiles/$domain/1/2/3/$course/$file will
1714: # be copied from $source (current location) to
1715: # /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
1716: # and will then be copied to
1717: # /home/httpd/lonUsers/$domain/1/2/3/$course/userfiles/$file in
1718: # course's home server.
1.485 raeburn 1719: #
1.481 raeburn 1720: # action = uploaddoc - /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
1.620 albertel 1721: # will be retrived from $env{form.uploaddoc} (from DOCS interface) to
1.481 raeburn 1722: # /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
1723: # and will then be copied to /home/httpd/lonUsers/1/2/3/$course/userfiles/$file
1724: # in course's home server.
1.637 raeburn 1725: #
1.477 raeburn 1726:
1727: sub process_coursefile {
1.638 albertel 1728: my ($action,$docuname,$docudom,$file,$source,$parser,$allfiles,$codebase)=@_;
1.477 raeburn 1729: my $fetchresult;
1.638 albertel 1730: my $home=&homeserver($docuname,$docudom);
1.477 raeburn 1731: if ($action eq 'propagate') {
1.638 albertel 1732: $fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
1733: $home);
1.481 raeburn 1734: } else {
1.477 raeburn 1735: my $fpath = '';
1736: my $fname = $file;
1.478 albertel 1737: ($fpath,$fname) = ($file =~ m|^(.*)/([^/]+)$|);
1.477 raeburn 1738: $fpath=$docudom.'/'.$docuname.'/'.$fpath;
1.637 raeburn 1739: my $filepath = &build_filepath($fpath);
1.481 raeburn 1740: if ($action eq 'copy') {
1741: if ($source eq '') {
1742: $fetchresult = 'no source file';
1743: return $fetchresult;
1744: } else {
1745: my $destination = $filepath.'/'.$fname;
1746: rename($source,$destination);
1747: $fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
1.638 albertel 1748: $home);
1.481 raeburn 1749: }
1750: } elsif ($action eq 'uploaddoc') {
1751: open(my $fh,'>'.$filepath.'/'.$fname);
1.620 albertel 1752: print $fh $env{'form.'.$source};
1.481 raeburn 1753: close($fh);
1.637 raeburn 1754: if ($parser eq 'parse') {
1755: my $parse_result = &extract_embedded_items($filepath,$fname,$allfiles,$codebase);
1756: unless ($parse_result eq 'ok') {
1757: &logthis('Failed to parse '.$filepath.'/'.$fname.' for embedded media: '.$parse_result);
1758: }
1759: }
1.477 raeburn 1760: $fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
1.638 albertel 1761: $home);
1.481 raeburn 1762: if ($fetchresult eq 'ok') {
1763: return '/uploaded/'.$fpath.'/'.$fname;
1764: } else {
1765: &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$file.
1.638 albertel 1766: ' to host '.$home.': '.$fetchresult);
1.481 raeburn 1767: return '/adm/notfound.html';
1768: }
1.477 raeburn 1769: }
1770: }
1.485 raeburn 1771: unless ( $fetchresult eq 'ok') {
1.477 raeburn 1772: &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$file.
1.638 albertel 1773: ' to host '.$home.': '.$fetchresult);
1.477 raeburn 1774: }
1775: return $fetchresult;
1776: }
1777:
1.637 raeburn 1778: sub build_filepath {
1779: my ($fpath) = @_;
1780: my $filepath=$perlvar{'lonDocRoot'}.'/userfiles';
1781: unless ($fpath eq '') {
1782: my @parts=split('/',$fpath);
1783: foreach my $part (@parts) {
1784: $filepath.= '/'.$part;
1785: if ((-e $filepath)!=1) {
1786: mkdir($filepath,0777);
1787: }
1788: }
1789: }
1790: return $filepath;
1791: }
1792:
1793: sub store_edited_file {
1.638 albertel 1794: my ($primary_url,$content,$docudom,$docuname,$fetchresult) = @_;
1.637 raeburn 1795: my $file = $primary_url;
1796: $file =~ s#^/uploaded/$docudom/$docuname/##;
1797: my $fpath = '';
1798: my $fname = $file;
1799: ($fpath,$fname) = ($file =~ m|^(.*)/([^/]+)$|);
1800: $fpath=$docudom.'/'.$docuname.'/'.$fpath;
1801: my $filepath = &build_filepath($fpath);
1802: open(my $fh,'>'.$filepath.'/'.$fname);
1803: print $fh $content;
1804: close($fh);
1.638 albertel 1805: my $home=&homeserver($docuname,$docudom);
1.637 raeburn 1806: $$fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
1.638 albertel 1807: $home);
1.637 raeburn 1808: if ($$fetchresult eq 'ok') {
1809: return '/uploaded/'.$fpath.'/'.$fname;
1810: } else {
1.638 albertel 1811: &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$file.
1812: ' to host '.$home.': '.$$fetchresult);
1.637 raeburn 1813: return '/adm/notfound.html';
1814: }
1815: }
1816:
1.531 albertel 1817: sub clean_filename {
1.831 albertel 1818: my ($fname,$args)=@_;
1.315 www 1819: # Replace Windows backslashes by forward slashes
1.257 www 1820: $fname=~s/\\/\//g;
1.831 albertel 1821: if (!$args->{'keep_path'}) {
1822: # Get rid of everything but the actual filename
1823: $fname=~s/^.*\/([^\/]+)$/$1/;
1824: }
1.315 www 1825: # Replace spaces by underscores
1826: $fname=~s/\s+/\_/g;
1827: # Replace all other weird characters by nothing
1.831 albertel 1828: $fname=~s{[^/\w\.\-]}{}g;
1.540 albertel 1829: # Replace all .\d. sequences with _\d. so they no longer look like version
1830: # numbers
1831: $fname=~s/\.(\d+)(?=\.)/_$1/g;
1.531 albertel 1832: return $fname;
1833: }
1834:
1.608 albertel 1835: # --------------- Take an uploaded file and put it into the userfiles directory
1.686 albertel 1836: # input: $formname - the contents of the file are in $env{"form.$formname"}
1.719 banghart 1837: # the desired filenam is in $env{"form.$formname.filename"}
1.686 albertel 1838: # $coursedoc - if true up to the current course
1839: # if false
1840: # $subdir - directory in userfile to store the file into
1.858 raeburn 1841: # $parser - instruction to parse file for objects ($parser = parse)
1842: # $allfiles - reference to hash for embedded objects
1843: # $codebase - reference to hash for codebase of java objects
1844: # $desuname - username for permanent storage of uploaded file
1845: # $dsetudom - domain for permanaent storage of uploaded file
1.860 raeburn 1846: # $thumbwidth - width (pixels) of thumbnail to make for uploaded image
1847: # $thumbheight - height (pixels) of thumbnail to make for uploaded image
1.858 raeburn 1848: #
1.686 albertel 1849: # output: url of file in userspace, or error: <message>
1850: # or /adm/notfound.html if failure to upload occurse
1.608 albertel 1851:
1852:
1.531 albertel 1853: sub userfileupload {
1.860 raeburn 1854: my ($formname,$coursedoc,$subdir,$parser,$allfiles,$codebase,$destuname,
1855: $destudom,$thumbwidth,$thumbheight)=@_;
1.531 albertel 1856: if (!defined($subdir)) { $subdir='unknown'; }
1.620 albertel 1857: my $fname=$env{'form.'.$formname.'.filename'};
1.531 albertel 1858: $fname=&clean_filename($fname);
1.315 www 1859: # See if there is anything left
1.257 www 1860: unless ($fname) { return 'error: no uploaded file'; }
1.620 albertel 1861: chop($env{'form.'.$formname});
1.523 raeburn 1862: if (($formname eq 'screenshot') && ($subdir eq 'helprequests')) { #files uploaded to help request form are handled differently
1863: my $now = time;
1864: my $filepath = 'tmp/helprequests/'.$now;
1865: my @parts=split(/\//,$filepath);
1866: my $fullpath = $perlvar{'lonDaemons'};
1867: for (my $i=0;$i<@parts;$i++) {
1868: $fullpath .= '/'.$parts[$i];
1869: if ((-e $fullpath)!=1) {
1870: mkdir($fullpath,0777);
1871: }
1872: }
1873: open(my $fh,'>'.$fullpath.'/'.$fname);
1.620 albertel 1874: print $fh $env{'form.'.$formname};
1.523 raeburn 1875: close($fh);
1.741 raeburn 1876: return $fullpath.'/'.$fname;
1877: } elsif (($formname eq 'coursecreatorxml') && ($subdir eq 'batchupload')) { #files uploaded to create course page are handled differently
1878: my $filepath = 'tmp/addcourse/'.$destudom.'/web/'.$env{'user.name'}.
1879: '_'.$env{'user.domain'}.'/pending';
1880: my @parts=split(/\//,$filepath);
1881: my $fullpath = $perlvar{'lonDaemons'};
1882: for (my $i=0;$i<@parts;$i++) {
1883: $fullpath .= '/'.$parts[$i];
1884: if ((-e $fullpath)!=1) {
1885: mkdir($fullpath,0777);
1886: }
1887: }
1888: open(my $fh,'>'.$fullpath.'/'.$fname);
1889: print $fh $env{'form.'.$formname};
1890: close($fh);
1891: return $fullpath.'/'.$fname;
1.523 raeburn 1892: }
1.719 banghart 1893:
1.258 www 1894: # Create the directory if not present
1.493 albertel 1895: $fname="$subdir/$fname";
1.259 www 1896: if ($coursedoc) {
1.638 albertel 1897: my $docuname=$env{'course.'.$env{'request.course.id'}.'.num'};
1898: my $docudom=$env{'course.'.$env{'request.course.id'}.'.domain'};
1.646 raeburn 1899: if ($env{'form.folder'} =~ m/^(default|supplemental)/) {
1.638 albertel 1900: return &finishuserfileupload($docuname,$docudom,
1901: $formname,$fname,$parser,$allfiles,
1.860 raeburn 1902: $codebase,$thumbwidth,$thumbheight);
1.481 raeburn 1903: } else {
1.620 albertel 1904: $fname=$env{'form.folder'}.'/'.$fname;
1.638 albertel 1905: return &process_coursefile('uploaddoc',$docuname,$docudom,
1906: $fname,$formname,$parser,
1907: $allfiles,$codebase);
1.481 raeburn 1908: }
1.719 banghart 1909: } elsif (defined($destuname)) {
1910: my $docuname=$destuname;
1911: my $docudom=$destudom;
1.860 raeburn 1912: return &finishuserfileupload($docuname,$docudom,$formname,$fname,
1913: $parser,$allfiles,$codebase,
1914: $thumbwidth,$thumbheight);
1.719 banghart 1915:
1.259 www 1916: } else {
1.638 albertel 1917: my $docuname=$env{'user.name'};
1918: my $docudom=$env{'user.domain'};
1.714 raeburn 1919: if (exists($env{'form.group'})) {
1920: $docuname=$env{'course.'.$env{'request.course.id'}.'.num'};
1921: $docudom=$env{'course.'.$env{'request.course.id'}.'.domain'};
1922: }
1.860 raeburn 1923: return &finishuserfileupload($docuname,$docudom,$formname,$fname,
1924: $parser,$allfiles,$codebase,
1925: $thumbwidth,$thumbheight);
1.259 www 1926: }
1.271 www 1927: }
1928:
1929: sub finishuserfileupload {
1.860 raeburn 1930: my ($docuname,$docudom,$formname,$fname,$parser,$allfiles,$codebase,
1931: $thumbwidth,$thumbheight) = @_;
1.477 raeburn 1932: my $path=$docudom.'/'.$docuname.'/';
1.258 www 1933: my $filepath=$perlvar{'lonDocRoot'};
1.860 raeburn 1934: my ($fnamepath,$file,$fetchthumb);
1.494 albertel 1935: $file=$fname;
1936: if ($fname=~m|/|) {
1937: ($fnamepath,$file) = ($fname =~ m|^(.*)/([^/]+)$|);
1938: $path.=$fnamepath.'/';
1939: }
1.259 www 1940: my @parts=split(/\//,$filepath.'/userfiles/'.$path);
1.258 www 1941: my $count;
1942: for ($count=4;$count<=$#parts;$count++) {
1943: $filepath.="/$parts[$count]";
1944: if ((-e $filepath)!=1) {
1945: mkdir($filepath,0777);
1946: }
1947: }
1948: # Save the file
1949: {
1.701 albertel 1950: if (!open(FH,'>'.$filepath.'/'.$file)) {
1951: &logthis('Failed to create '.$filepath.'/'.$file);
1952: print STDERR ('Failed to create '.$filepath.'/'.$file."\n");
1953: return '/adm/notfound.html';
1954: }
1955: if (!print FH ($env{'form.'.$formname})) {
1956: &logthis('Failed to write to '.$filepath.'/'.$file);
1957: print STDERR ('Failed to write to '.$filepath.'/'.$file."\n");
1958: return '/adm/notfound.html';
1959: }
1.570 albertel 1960: close(FH);
1.258 www 1961: }
1.637 raeburn 1962: if ($parser eq 'parse') {
1.638 albertel 1963: my $parse_result = &extract_embedded_items($filepath,$file,$allfiles,
1964: $codebase);
1.637 raeburn 1965: unless ($parse_result eq 'ok') {
1.638 albertel 1966: &logthis('Failed to parse '.$filepath.$file.
1967: ' for embedded media: '.$parse_result);
1.637 raeburn 1968: }
1969: }
1.860 raeburn 1970: if (($thumbwidth =~ /^\d+$/) && ($thumbheight =~ /^\d+$/)) {
1971: my $input = $filepath.'/'.$file;
1972: my $output = $filepath.'/'.'tn-'.$file;
1973: my $thumbsize = $thumbwidth.'x'.$thumbheight;
1974: system("convert -sample $thumbsize $input $output");
1975: if (-e $filepath.'/'.'tn-'.$file) {
1976: $fetchthumb = 1;
1977: }
1978: }
1.858 raeburn 1979:
1.259 www 1980: # Notify homeserver to grep it
1981: #
1.638 albertel 1982: my $docuhome=&homeserver($docuname,$docudom);
1.494 albertel 1983: my $fetchresult= &reply('fetchuserfile:'.$path.$file,$docuhome);
1.295 www 1984: if ($fetchresult eq 'ok') {
1.860 raeburn 1985: if ($fetchthumb) {
1986: my $thumbresult= &reply('fetchuserfile:'.$path.'tn-'.$file,$docuhome);
1987: if ($thumbresult ne 'ok') {
1988: &logthis('Failed to transfer '.$path.'tn-'.$file.' to host '.
1989: $docuhome.': '.$thumbresult);
1990: }
1991: }
1.259 www 1992: #
1.258 www 1993: # Return the URL to it
1.494 albertel 1994: return '/uploaded/'.$path.$file;
1.263 www 1995: } else {
1.494 albertel 1996: &logthis('Failed to transfer '.$path.$file.' to host '.$docuhome.
1997: ': '.$fetchresult);
1.263 www 1998: return '/adm/notfound.html';
1.858 raeburn 1999: }
1.493 albertel 2000: }
2001:
1.637 raeburn 2002: sub extract_embedded_items {
1.648 raeburn 2003: my ($filepath,$file,$allfiles,$codebase,$content) = @_;
1.637 raeburn 2004: my @state = ();
2005: my %javafiles = (
2006: codebase => '',
2007: code => '',
2008: archive => ''
2009: );
2010: my %mediafiles = (
2011: src => '',
2012: movie => '',
2013: );
1.648 raeburn 2014: my $p;
2015: if ($content) {
2016: $p = HTML::LCParser->new($content);
2017: } else {
2018: $p = HTML::LCParser->new($filepath.'/'.$file);
2019: }
1.641 albertel 2020: while (my $t=$p->get_token()) {
1.640 albertel 2021: if ($t->[0] eq 'S') {
2022: my ($tagname, $attr) = ($t->[1],$t->[2]);
1.886 albertel 2023: push(@state, $tagname);
1.648 raeburn 2024: if (lc($tagname) eq 'allow') {
2025: &add_filetype($allfiles,$attr->{'src'},'src');
2026: }
1.640 albertel 2027: if (lc($tagname) eq 'img') {
2028: &add_filetype($allfiles,$attr->{'src'},'src');
2029: }
1.886 albertel 2030: if (lc($tagname) eq 'a') {
2031: &add_filetype($allfiles,$attr->{'href'},'href');
2032: }
1.645 raeburn 2033: if (lc($tagname) eq 'script') {
2034: if ($attr->{'archive'} =~ /\.jar$/i) {
2035: &add_filetype($allfiles,$attr->{'archive'},'archive');
2036: } else {
2037: &add_filetype($allfiles,$attr->{'src'},'src');
2038: }
2039: }
2040: if (lc($tagname) eq 'link') {
2041: if (lc($attr->{'rel'}) eq 'stylesheet') {
2042: &add_filetype($allfiles,$attr->{'href'},'href');
2043: }
2044: }
1.640 albertel 2045: if (lc($tagname) eq 'object' ||
2046: (lc($tagname) eq 'embed' && lc($state[-2]) ne 'object')) {
2047: foreach my $item (keys(%javafiles)) {
2048: $javafiles{$item} = '';
2049: }
2050: }
2051: if (lc($state[-2]) eq 'object' && lc($tagname) eq 'param') {
2052: my $name = lc($attr->{'name'});
2053: foreach my $item (keys(%javafiles)) {
2054: if ($name eq $item) {
2055: $javafiles{$item} = $attr->{'value'};
2056: last;
2057: }
2058: }
2059: foreach my $item (keys(%mediafiles)) {
2060: if ($name eq $item) {
2061: &add_filetype($allfiles, $attr->{'value'}, 'value');
2062: last;
2063: }
2064: }
2065: }
2066: if (lc($tagname) eq 'embed' || lc($tagname) eq 'applet') {
2067: foreach my $item (keys(%javafiles)) {
2068: if ($attr->{$item}) {
2069: $javafiles{$item} = $attr->{$item};
2070: last;
2071: }
2072: }
2073: foreach my $item (keys(%mediafiles)) {
2074: if ($attr->{$item}) {
2075: &add_filetype($allfiles,$attr->{$item},$item);
2076: last;
2077: }
2078: }
2079: }
2080: } elsif ($t->[0] eq 'E') {
2081: my ($tagname) = ($t->[1]);
2082: if ($javafiles{'codebase'} ne '') {
2083: $javafiles{'codebase'} .= '/';
2084: }
2085: if (lc($tagname) eq 'applet' ||
2086: lc($tagname) eq 'object' ||
2087: (lc($tagname) eq 'embed' && lc($state[-2]) ne 'object')
2088: ) {
2089: foreach my $item (keys(%javafiles)) {
2090: if ($item ne 'codebase' && $javafiles{$item} ne '') {
2091: my $file=$javafiles{'codebase'}.$javafiles{$item};
2092: &add_filetype($allfiles,$file,$item);
2093: }
2094: }
2095: }
2096: pop @state;
2097: }
2098: }
1.637 raeburn 2099: return 'ok';
2100: }
2101:
1.639 albertel 2102: sub add_filetype {
2103: my ($allfiles,$file,$type)=@_;
2104: if (exists($allfiles->{$file})) {
2105: unless (grep/^\Q$type\E$/, @{$allfiles->{$file}}) {
2106: push(@{$allfiles->{$file}}, &escape($type));
2107: }
2108: } else {
2109: @{$allfiles->{$file}} = (&escape($type));
1.637 raeburn 2110: }
2111: }
2112:
1.493 albertel 2113: sub removeuploadedurl {
2114: my ($url)=@_;
2115: my (undef,undef,$udom,$uname,$fname)=split('/',$url,5);
1.613 albertel 2116: return &removeuserfile($uname,$udom,$fname);
1.490 albertel 2117: }
2118:
2119: sub removeuserfile {
2120: my ($docuname,$docudom,$fname)=@_;
2121: my $home=&homeserver($docuname,$docudom);
1.798 raeburn 2122: my $result = &reply("removeuserfile:$docudom/$docuname/$fname",$home);
2123: if ($result eq 'ok') {
2124: if (($fname !~ /\.meta$/) && (&is_portfolio_file($fname))) {
2125: my $metafile = $fname.'.meta';
2126: my $metaresult = &removeuserfile($docuname,$docudom,$metafile);
1.823 albertel 2127: my $url = "/uploaded/$docudom/$docuname/$fname";
2128: my ($file,$group) = (&parse_portfolio_url($url))[3,4];
1.821 raeburn 2129: my $sqlresult =
1.823 albertel 2130: &update_portfolio_table($docuname,$docudom,$file,
1.821 raeburn 2131: 'portfolio_metadata',$group,
2132: 'delete');
1.798 raeburn 2133: }
2134: }
2135: return $result;
1.257 www 2136: }
1.15 www 2137:
1.530 albertel 2138: sub mkdiruserfile {
2139: my ($docuname,$docudom,$dir)=@_;
2140: my $home=&homeserver($docuname,$docudom);
2141: return &reply("mkdiruserfile:".&escape("$docudom/$docuname/$dir"),$home);
2142: }
2143:
1.531 albertel 2144: sub renameuserfile {
2145: my ($docuname,$docudom,$old,$new)=@_;
2146: my $home=&homeserver($docuname,$docudom);
1.798 raeburn 2147: my $result = &reply("renameuserfile:$docudom:$docuname:".
2148: &escape("$old").':'.&escape("$new"),$home);
2149: if ($result eq 'ok') {
2150: if (($old !~ /\.meta$/) && (&is_portfolio_file($old))) {
2151: my $oldmeta = $old.'.meta';
2152: my $newmeta = $new.'.meta';
2153: my $metaresult =
2154: &renameuserfile($docuname,$docudom,$oldmeta,$newmeta);
1.823 albertel 2155: my $url = "/uploaded/$docudom/$docuname/$old";
2156: my ($file,$group) = (&parse_portfolio_url($url))[3,4];
1.821 raeburn 2157: my $sqlresult =
1.823 albertel 2158: &update_portfolio_table($docuname,$docudom,$file,
1.821 raeburn 2159: 'portfolio_metadata',$group,
2160: 'delete');
1.798 raeburn 2161: }
2162: }
2163: return $result;
1.531 albertel 2164: }
2165:
1.14 www 2166: # ------------------------------------------------------------------------- Log
2167:
2168: sub log {
2169: my ($dom,$nam,$hom,$what)=@_;
1.47 www 2170: return critical("log:$dom:$nam:$what",$hom);
1.157 www 2171: }
2172:
2173: # ------------------------------------------------------------------ Course Log
1.352 www 2174: #
2175: # This routine flushes several buffers of non-mission-critical nature
2176: #
1.157 www 2177:
2178: sub flushcourselogs {
1.352 www 2179: &logthis('Flushing log buffers');
2180: #
2181: # course logs
2182: # This is a log of all transactions in a course, which can be used
2183: # for data mining purposes
2184: #
2185: # It also collects the courseid database, which lists last transaction
2186: # times and course titles for all courseids
2187: #
2188: my %courseidbuffer=();
1.921 raeburn 2189: foreach my $crsid (keys(%courselogs)) {
1.352 www 2190: if (&reply('log:'.$coursedombuf{$crsid}.':'.$coursenumbuf{$crsid}.':'.
1.188 www 2191: &escape($courselogs{$crsid}),
2192: $coursehombuf{$crsid}) eq 'ok') {
1.157 www 2193: delete $courselogs{$crsid};
2194: } else {
2195: &logthis('Failed to flush log buffer for '.$crsid);
2196: if (length($courselogs{$crsid})>40000) {
1.672 albertel 2197: &logthis("<font color=\"blue\">WARNING: Buffer for ".$crsid.
1.157 www 2198: " exceeded maximum size, deleting.</font>");
2199: delete $courselogs{$crsid};
2200: }
1.352 www 2201: }
1.920 raeburn 2202: $courseidbuffer{$coursehombuf{$crsid}}{$crsid} = {
1.918 raeburn 2203: 'description' => &escape($coursedescrbuf{$crsid}),
1.921 raeburn 2204: 'inst_code' => &escape($courseinstcodebuf{$crsid}),
1.918 raeburn 2205: 'type' => &escape($coursetypebuf{$crsid}),
2206: 'owner' => &escape($courseownerbuf{$crsid}),
1.920 raeburn 2207: };
1.191 harris41 2208: }
1.352 www 2209: #
2210: # Write course id database (reverse lookup) to homeserver of courses
2211: # Is used in pickcourse
2212: #
1.840 albertel 2213: foreach my $crs_home (keys(%courseidbuffer)) {
1.918 raeburn 2214: my $response = &courseidput(&host_domain($crs_home),
1.921 raeburn 2215: $courseidbuffer{$crs_home},
2216: $crs_home,'timeonly');
1.352 www 2217: }
2218: #
2219: # File accesses
2220: # Writes to the dynamic metadata of resources to get hit counts, etc.
2221: #
1.449 matthew 2222: foreach my $entry (keys(%accesshash)) {
1.458 matthew 2223: if ($entry =~ /___count$/) {
2224: my ($dom,$name);
1.807 albertel 2225: ($dom,$name,undef)=
1.811 albertel 2226: ($entry=~m{___($match_domain)/($match_name)/(.*)___count$});
1.458 matthew 2227: if (! defined($dom) || $dom eq '' ||
2228: ! defined($name) || $name eq '') {
1.620 albertel 2229: my $cid = $env{'request.course.id'};
2230: $dom = $env{'request.'.$cid.'.domain'};
2231: $name = $env{'request.'.$cid.'.num'};
1.458 matthew 2232: }
1.450 matthew 2233: my $value = $accesshash{$entry};
2234: my (undef,$url,undef) = ($entry =~ /^(.*)___(.*)___count$/);
2235: my %temphash=($url => $value);
1.449 matthew 2236: my $result = &inc('nohist_accesscount',\%temphash,$dom,$name);
2237: if ($result eq 'ok') {
2238: delete $accesshash{$entry};
2239: } elsif ($result eq 'unknown_cmd') {
2240: # Target server has old code running on it.
1.450 matthew 2241: my %temphash=($entry => $value);
1.449 matthew 2242: if (&put('nohist_resevaldata',\%temphash,$dom,$name) eq 'ok') {
2243: delete $accesshash{$entry};
2244: }
2245: }
2246: } else {
1.811 albertel 2247: my ($dom,$name) = ($entry=~m{___($match_domain)/($match_name)/(.*)___(\w+)$});
1.450 matthew 2248: my %temphash=($entry => $accesshash{$entry});
1.449 matthew 2249: if (&put('nohist_resevaldata',\%temphash,$dom,$name) eq 'ok') {
2250: delete $accesshash{$entry};
2251: }
1.185 www 2252: }
1.191 harris41 2253: }
1.352 www 2254: #
2255: # Roles
2256: # Reverse lookup of user roles for course faculty/staff and co-authorship
2257: #
1.800 albertel 2258: foreach my $entry (keys(%userrolehash)) {
1.351 www 2259: my ($role,$uname,$udom,$runame,$rudom,$rsec)=
1.349 www 2260: split(/\:/,$entry);
2261: if (&Apache::lonnet::put('nohist_userroles',
1.351 www 2262: { $role.':'.$uname.':'.$udom.':'.$rsec => $userrolehash{$entry} },
1.349 www 2263: $rudom,$runame) eq 'ok') {
2264: delete $userrolehash{$entry};
2265: }
2266: }
1.662 raeburn 2267: #
2268: # Reverse lookup of domain roles (dc, ad, li, sc, au)
2269: #
2270: my %domrolebuffer = ();
2271: foreach my $entry (keys %domainrolehash) {
1.901 albertel 2272: my ($role,$uname,$udom,$runame,$rudom,$rsec)=split(/:/,$entry);
1.662 raeburn 2273: if ($domrolebuffer{$rudom}) {
2274: $domrolebuffer{$rudom}.='&'.&escape($entry).
2275: '='.&escape($domainrolehash{$entry});
2276: } else {
2277: $domrolebuffer{$rudom}.=&escape($entry).
2278: '='.&escape($domainrolehash{$entry});
2279: }
2280: delete $domainrolehash{$entry};
2281: }
2282: foreach my $dom (keys(%domrolebuffer)) {
1.841 albertel 2283: my %servers = &get_servers($dom,'library');
2284: foreach my $tryserver (keys(%servers)) {
2285: unless (&reply('domroleput:'.$dom.':'.
2286: $domrolebuffer{$dom},$tryserver) eq 'ok') {
2287: &logthis('Put of domain roles failed for '.$dom.' and '.$tryserver);
2288: }
1.662 raeburn 2289: }
2290: }
1.186 www 2291: $dumpcount++;
1.157 www 2292: }
2293:
2294: sub courselog {
2295: my $what=shift;
1.158 www 2296: $what=time.':'.$what;
1.620 albertel 2297: unless ($env{'request.course.id'}) { return ''; }
2298: $coursedombuf{$env{'request.course.id'}}=
2299: $env{'course.'.$env{'request.course.id'}.'.domain'};
2300: $coursenumbuf{$env{'request.course.id'}}=
2301: $env{'course.'.$env{'request.course.id'}.'.num'};
2302: $coursehombuf{$env{'request.course.id'}}=
2303: $env{'course.'.$env{'request.course.id'}.'.home'};
2304: $coursedescrbuf{$env{'request.course.id'}}=
2305: $env{'course.'.$env{'request.course.id'}.'.description'};
2306: $courseinstcodebuf{$env{'request.course.id'}}=
2307: $env{'course.'.$env{'request.course.id'}.'.internal.coursecode'};
2308: $courseownerbuf{$env{'request.course.id'}}=
2309: $env{'course.'.$env{'request.course.id'}.'.internal.courseowner'};
1.741 raeburn 2310: $coursetypebuf{$env{'request.course.id'}}=
2311: $env{'course.'.$env{'request.course.id'}.'.type'};
1.620 albertel 2312: if (defined $courselogs{$env{'request.course.id'}}) {
2313: $courselogs{$env{'request.course.id'}}.='&'.$what;
1.157 www 2314: } else {
1.620 albertel 2315: $courselogs{$env{'request.course.id'}}.=$what;
1.157 www 2316: }
1.620 albertel 2317: if (length($courselogs{$env{'request.course.id'}})>4048) {
1.157 www 2318: &flushcourselogs();
2319: }
1.158 www 2320: }
2321:
2322: sub courseacclog {
2323: my $fnsymb=shift;
1.620 albertel 2324: unless ($env{'request.course.id'}) { return ''; }
2325: my $what=$fnsymb.':'.$env{'user.name'}.':'.$env{'user.domain'};
1.657 albertel 2326: if ($fnsymb=~/(problem|exam|quiz|assess|survey|form|task|page)$/) {
1.187 www 2327: $what.=':POST';
1.583 matthew 2328: # FIXME: Probably ought to escape things....
1.800 albertel 2329: foreach my $key (keys(%env)) {
2330: if ($key=~/^form\.(.*)/) {
2331: $what.=':'.$1.'='.$env{$key};
1.158 www 2332: }
1.191 harris41 2333: }
1.583 matthew 2334: } elsif ($fnsymb =~ m:^/adm/searchcat:) {
2335: # FIXME: We should not be depending on a form parameter that someone
2336: # editing lonsearchcat.pm might change in the future.
1.620 albertel 2337: if ($env{'form.phase'} eq 'course_search') {
1.583 matthew 2338: $what.= ':POST';
2339: # FIXME: Probably ought to escape things....
2340: foreach my $element ('courseexp','crsfulltext','crsrelated',
2341: 'crsdiscuss') {
1.620 albertel 2342: $what.=':'.$element.'='.$env{'form.'.$element};
1.583 matthew 2343: }
2344: }
1.158 www 2345: }
2346: &courselog($what);
1.149 www 2347: }
2348:
1.185 www 2349: sub countacc {
2350: my $url=&declutter(shift);
1.458 matthew 2351: return if (! defined($url) || $url eq '');
1.620 albertel 2352: unless ($env{'request.course.id'}) { return ''; }
2353: $accesshash{$env{'request.course.id'}.'___'.$url.'___course'}=1;
1.281 www 2354: my $key=$$.$processmarker.'_'.$dumpcount.'___'.$url.'___count';
1.450 matthew 2355: $accesshash{$key}++;
1.185 www 2356: }
1.349 www 2357:
1.361 www 2358: sub linklog {
2359: my ($from,$to)=@_;
2360: $from=&declutter($from);
2361: $to=&declutter($to);
2362: $accesshash{$from.'___'.$to.'___comefrom'}=1;
2363: $accesshash{$to.'___'.$from.'___goto'}=1;
2364: }
2365:
1.349 www 2366: sub userrolelog {
2367: my ($trole,$username,$domain,$area,$tstart,$tend)=@_;
1.661 raeburn 2368: if (($trole=~/^ca/) || ($trole=~/^aa/) ||
1.662 raeburn 2369: ($trole=~/^in/) || ($trole=~/^cc/) ||
1.661 raeburn 2370: ($trole=~/^ep/) || ($trole=~/^cr/) ||
2371: ($trole=~/^ta/)) {
1.350 www 2372: my (undef,$rudom,$runame,$rsec)=split(/\//,$area);
2373: $userrolehash
2374: {$trole.':'.$username.':'.$domain.':'.$runame.':'.$rudom.':'.$rsec}
1.349 www 2375: =$tend.':'.$tstart;
1.662 raeburn 2376: }
1.898 albertel 2377: if (($env{'request.role'} =~ /dc\./) &&
2378: (($trole=~/^au/) || ($trole=~/^in/) ||
2379: ($trole=~/^cc/) || ($trole=~/^ep/) ||
2380: ($trole=~/^cr/) || ($trole=~/^ta/))) {
2381: $userrolehash
2382: {$trole.':'.$username.':'.$domain.':'.$env{'user.name'}.':'.$env{'user.domain'}.':'}
2383: =$tend.':'.$tstart;
2384: }
1.662 raeburn 2385: if (($trole=~/^dc/) || ($trole=~/^ad/) ||
2386: ($trole=~/^li/) || ($trole=~/^li/) ||
2387: ($trole=~/^au/) || ($trole=~/^dg/) ||
2388: ($trole=~/^sc/)) {
2389: my (undef,$rudom,$runame,$rsec)=split(/\//,$area);
2390: $domainrolehash
2391: {$trole.':'.$username.':'.$domain.':'.$runame.':'.$rudom.':'.$rsec}
2392: = $tend.':'.$tstart;
2393: }
1.351 www 2394: }
2395:
2396: sub get_course_adv_roles {
2397: my $cid=shift;
1.620 albertel 2398: $cid=$env{'request.course.id'} unless (defined($cid));
1.351 www 2399: my %coursehash=&coursedescription($cid);
1.470 www 2400: my %nothide=();
1.800 albertel 2401: foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
2402: $nothide{join(':',split(/[\@\:]/,$user))}=1;
1.470 www 2403: }
1.351 www 2404: my %returnhash=();
2405: my %dumphash=
2406: &dump('nohist_userroles',$coursehash{'domain'},$coursehash{'num'});
2407: my $now=time;
1.800 albertel 2408: foreach my $entry (keys %dumphash) {
2409: my ($tend,$tstart)=split(/\:/,$dumphash{$entry});
1.351 www 2410: if (($tstart) && ($tstart<0)) { next; }
2411: if (($tend) && ($tend<$now)) { next; }
2412: if (($tstart) && ($now<$tstart)) { next; }
1.800 albertel 2413: my ($role,$username,$domain,$section)=split(/\:/,$entry);
1.576 albertel 2414: if ($username eq '' || $domain eq '') { next; }
1.470 www 2415: if ((&privileged($username,$domain)) &&
2416: (!$nothide{$username.':'.$domain})) { next; }
1.656 albertel 2417: if ($role eq 'cr') { next; }
1.351 www 2418: my $key=&plaintext($role);
2419: if ($section) { $key.=' (Sec/Grp '.$section.')'; }
2420: if ($returnhash{$key}) {
2421: $returnhash{$key}.=','.$username.':'.$domain;
2422: } else {
2423: $returnhash{$key}=$username.':'.$domain;
2424: }
1.400 www 2425: }
2426: return %returnhash;
2427: }
2428:
2429: sub get_my_roles {
1.858 raeburn 2430: my ($uname,$udom,$context,$types,$roles,$roledoms)=@_;
1.620 albertel 2431: unless (defined($uname)) { $uname=$env{'user.name'}; }
2432: unless (defined($udom)) { $udom=$env{'user.domain'}; }
1.858 raeburn 2433: my %dumphash;
2434: if ($context eq 'userroles') {
2435: %dumphash = &dump('roles',$udom,$uname);
2436: } else {
2437: %dumphash=
1.400 www 2438: &dump('nohist_userroles',$udom,$uname);
1.858 raeburn 2439: }
1.400 www 2440: my %returnhash=();
2441: my $now=time;
1.800 albertel 2442: foreach my $entry (keys(%dumphash)) {
1.867 raeburn 2443: my ($role,$tend,$tstart);
2444: if ($context eq 'userroles') {
2445: ($role,$tend,$tstart)=split(/_/,$dumphash{$entry});
2446: } else {
2447: ($tend,$tstart)=split(/\:/,$dumphash{$entry});
2448: }
1.400 www 2449: if (($tstart) && ($tstart<0)) { next; }
1.832 raeburn 2450: my $status = 'active';
2451: if (($tend) && ($tend<$now)) {
2452: $status = 'previous';
2453: }
2454: if (($tstart) && ($now<$tstart)) {
2455: $status = 'future';
2456: }
2457: if (ref($types) eq 'ARRAY') {
2458: if (!grep(/^\Q$status\E$/,@{$types})) {
2459: next;
2460: }
2461: } else {
2462: if ($status ne 'active') {
2463: next;
2464: }
2465: }
1.867 raeburn 2466: my ($rolecode,$username,$domain,$section,$area);
2467: if ($context eq 'userroles') {
2468: ($area,$rolecode) = split(/_/,$entry);
2469: (undef,$domain,$username,$section) = split(/\//,$area);
2470: } else {
2471: ($role,$username,$domain,$section) = split(/\:/,$entry);
2472: }
1.832 raeburn 2473: if (ref($roledoms) eq 'ARRAY') {
2474: if (!grep(/^\Q$domain\E$/,@{$roledoms})) {
2475: next;
2476: }
2477: }
2478: if (ref($roles) eq 'ARRAY') {
2479: if (!grep(/^\Q$role\E$/,@{$roles})) {
1.922 raeburn 2480: if ($role =~ /^cr\//) {
2481: if (!grep(/^cr$/,@{$roles})) {
2482: next;
2483: }
2484: } else {
2485: next;
2486: }
1.832 raeburn 2487: }
1.867 raeburn 2488: }
1.400 www 2489: $returnhash{$username.':'.$domain.':'.$role}=$tstart.':'.$tend;
1.832 raeburn 2490: }
1.373 www 2491: return %returnhash;
1.399 www 2492: }
2493:
2494: # ----------------------------------------------------- Frontpage Announcements
2495: #
2496: #
2497:
2498: sub postannounce {
2499: my ($server,$text)=@_;
1.844 albertel 2500: unless (&allowed('psa',&host_domain($server))) { return 'refused'; }
1.399 www 2501: unless ($text=~/\w/) { $text=''; }
2502: return &reply('setannounce:'.&escape($text),$server);
2503: }
2504:
2505: sub getannounce {
1.448 albertel 2506:
2507: if (open(my $fh,$perlvar{'lonDocRoot'}.'/announcement.txt')) {
1.399 www 2508: my $announcement='';
1.800 albertel 2509: while (my $line = <$fh>) { $announcement .= $line; }
1.448 albertel 2510: close($fh);
1.399 www 2511: if ($announcement=~/\w/) {
2512: return
2513: '<table bgcolor="#FF5555" cellpadding="5" cellspacing="3">'.
1.518 albertel 2514: '<tr><td bgcolor="#FFFFFF"><tt>'.$announcement.'</tt></td></tr></table>';
1.399 www 2515: } else {
2516: return '';
2517: }
2518: } else {
2519: return '';
2520: }
1.351 www 2521: }
1.353 www 2522:
2523: # ---------------------------------------------------------- Course ID routines
2524: # Deal with domain's nohist_courseid.db files
2525: #
2526:
2527: sub courseidput {
1.921 raeburn 2528: my ($domain,$storehash,$coursehome,$caller) = @_;
2529: my $outcome;
2530: if ($caller eq 'timeonly') {
2531: my $cids = '';
2532: foreach my $item (keys(%$storehash)) {
2533: $cids.=&escape($item).'&';
2534: }
2535: $cids=~s/\&$//;
2536: $outcome = &reply('courseidputhash:'.$domain.':'.$caller.':'.$cids,
2537: $coursehome);
2538: } else {
2539: my $items = '';
2540: foreach my $item (keys(%$storehash)) {
2541: $items.= &escape($item).'='.
2542: &freeze_escape($$storehash{$item}).'&';
2543: }
2544: $items=~s/\&$//;
2545: $outcome = &reply('courseidputhash:'.$domain.':'.$caller.':'.$items,
2546: $coursehome);
1.918 raeburn 2547: }
2548: if ($outcome eq 'unknown_cmd') {
2549: my $what;
2550: foreach my $cid (keys(%$storehash)) {
2551: $what .= &escape($cid).'=';
1.921 raeburn 2552: foreach my $item ('description','inst_code','owner','type') {
2553: $what .= &escape($storehash->{$item}).':';
1.918 raeburn 2554: }
2555: $what =~ s/\:$/&/;
2556: }
2557: $what =~ s/\&$//;
2558: return &reply('courseidput:'.$domain.':'.$what,$coursehome);
2559: } else {
2560: return $outcome;
2561: }
1.353 www 2562: }
2563:
2564: sub courseiddump {
1.921 raeburn 2565: my ($domfilter,$descfilter,$sincefilter,$instcodefilter,$ownerfilter,
2566: $coursefilter,$hostidflag,$hostidref,$typefilter,$regexp_ok)=@_;
1.918 raeburn 2567: my $as_hash = 1;
2568: my %returnhash;
2569: if (!$domfilter) { $domfilter=''; }
1.845 albertel 2570: my %libserv = &all_library();
2571: foreach my $tryserver (keys(%libserv)) {
2572: if ( ( $hostidflag == 1
2573: && grep(/^\Q$tryserver\E$/,@{$hostidref}) )
2574: || (!defined($hostidflag)) ) {
2575:
1.918 raeburn 2576: if (($domfilter eq '') ||
2577: (&host_domain($tryserver) eq $domfilter)) {
2578: my $rep =
2579: &reply('courseiddump:'.&host_domain($tryserver).':'.
2580: $sincefilter.':'.&escape($descfilter).':'.
2581: &escape($instcodefilter).':'.&escape($ownerfilter).
2582: ':'.&escape($coursefilter).':'.&escape($typefilter).
1.921 raeburn 2583: ':'.&escape($regexp_ok).':'.$as_hash,$tryserver);
1.918 raeburn 2584: my @pairs=split(/\&/,$rep);
2585: foreach my $item (@pairs) {
2586: my ($key,$value)=split(/\=/,$item,2);
2587: $key = &unescape($key);
2588: next if ($key =~ /^error: 2 /);
2589: my $result = &thaw_unescape($value);
2590: if (ref($result) eq 'HASH') {
2591: $returnhash{$key}=$result;
2592: } else {
1.921 raeburn 2593: my @responses = split(/:/,$value);
2594: my @items = ('description','inst_code','owner','type');
1.918 raeburn 2595: for (my $i=0; $i<@responses; $i++) {
1.921 raeburn 2596: $returnhash{$key}{$items[$i]} = &unescape($responses[$i]);
1.918 raeburn 2597: }
2598: }
1.353 www 2599: }
2600: }
2601: }
2602: }
2603: return %returnhash;
2604: }
2605:
1.658 raeburn 2606: # ---------------------------------------------------------- DC e-mail
1.662 raeburn 2607:
2608: sub dcmailput {
1.685 raeburn 2609: my ($domain,$msgid,$message,$server)=@_;
1.662 raeburn 2610: my $status = &Apache::lonnet::critical(
1.740 www 2611: 'dcmailput:'.$domain.':'.&escape($msgid).'='.
2612: &escape($message),$server);
1.662 raeburn 2613: return $status;
2614: }
2615:
1.658 raeburn 2616: sub dcmaildump {
2617: my ($dom,$startdate,$enddate,$senders) = @_;
1.685 raeburn 2618: my %returnhash=();
1.846 albertel 2619:
2620: if (defined(&domain($dom,'primary'))) {
1.685 raeburn 2621: my $cmd='dcmaildump:'.$dom.':'.&escape($startdate).':'.
2622: &escape($enddate).':';
2623: my @esc_senders=map { &escape($_)} @$senders;
2624: $cmd.=&escape(join('&',@esc_senders));
1.846 albertel 2625: foreach my $line (split(/\&/,&reply($cmd,&domain($dom,'primary')))) {
1.800 albertel 2626: my ($key,$value) = split(/\=/,$line,2);
1.685 raeburn 2627: if (($key) && ($value)) {
2628: $returnhash{&unescape($key)} = &unescape($value);
1.658 raeburn 2629: }
2630: }
2631: }
2632: return %returnhash;
2633: }
1.662 raeburn 2634: # ---------------------------------------------------------- Domain roles
2635:
2636: sub get_domain_roles {
2637: my ($dom,$roles,$startdate,$enddate)=@_;
2638: if (undef($startdate) || $startdate eq '') {
2639: $startdate = '.';
2640: }
2641: if (undef($enddate) || $enddate eq '') {
2642: $enddate = '.';
2643: }
1.922 raeburn 2644: my $rolelist;
2645: if (ref($roles) eq 'ARRAY') {
2646: $rolelist = join(':',@{$roles});
2647: }
1.662 raeburn 2648: my %personnel = ();
1.841 albertel 2649:
2650: my %servers = &get_servers($dom,'library');
2651: foreach my $tryserver (keys(%servers)) {
2652: %{$personnel{$tryserver}}=();
2653: foreach my $line (split(/\&/,&reply('domrolesdump:'.$dom.':'.
2654: &escape($startdate).':'.
2655: &escape($enddate).':'.
2656: &escape($rolelist), $tryserver))) {
2657: my ($key,$value) = split(/\=/,$line,2);
2658: if (($key) && ($value)) {
2659: $personnel{$tryserver}{&unescape($key)} = &unescape($value);
2660: }
2661: }
1.662 raeburn 2662: }
2663: return %personnel;
2664: }
1.658 raeburn 2665:
1.149 www 2666: # ----------------------------------------------------------- Check out an item
2667:
1.504 albertel 2668: sub get_first_access {
2669: my ($type,$argsymb)=@_;
1.790 albertel 2670: my ($symb,$courseid,$udom,$uname)=&whichuser();
1.504 albertel 2671: if ($argsymb) { $symb=$argsymb; }
2672: my ($map,$id,$res)=&decode_symb($symb);
1.588 albertel 2673: if ($type eq 'map') {
2674: $res=&symbread($map);
2675: } else {
2676: $res=$symb;
2677: }
2678: my %times=&get('firstaccesstimes',["$courseid\0$res"],$udom,$uname);
2679: return $times{"$courseid\0$res"};
1.504 albertel 2680: }
2681:
2682: sub set_first_access {
2683: my ($type)=@_;
1.790 albertel 2684: my ($symb,$courseid,$udom,$uname)=&whichuser();
1.504 albertel 2685: my ($map,$id,$res)=&decode_symb($symb);
1.588 albertel 2686: if ($type eq 'map') {
2687: $res=&symbread($map);
2688: } else {
2689: $res=$symb;
2690: }
2691: my $firstaccess=&get_first_access($type,$symb);
1.505 albertel 2692: if (!$firstaccess) {
1.588 albertel 2693: return &put('firstaccesstimes',{"$courseid\0$res"=>time},$udom,$uname);
1.505 albertel 2694: }
2695: return 'already_set';
1.504 albertel 2696: }
2697:
1.149 www 2698: sub checkout {
2699: my ($symb,$tuname,$tudom,$tcrsid)=@_;
2700: my $now=time;
2701: my $lonhost=$perlvar{'lonHostID'};
2702: my $infostr=&escape(
1.234 www 2703: 'CHECKOUTTOKEN&'.
1.149 www 2704: $tuname.'&'.
2705: $tudom.'&'.
2706: $tcrsid.'&'.
2707: $symb.'&'.
2708: $now.'&'.$ENV{'REMOTE_ADDR'});
2709: my $token=&reply('tmpput:'.$infostr,$lonhost);
1.151 www 2710: if ($token=~/^error\:/) {
1.672 albertel 2711: &logthis("<font color=\"blue\">WARNING: ".
1.151 www 2712: "Checkout tmpput failed ".$tudom.' - '.$tuname.' - '.$symb.
2713: "</font>");
2714: return '';
2715: }
2716:
1.149 www 2717: $token=~s/^(\d+)\_.*\_(\d+)$/$1\*$2\*$lonhost/;
2718: $token=~tr/a-z/A-Z/;
2719:
1.153 www 2720: my %infohash=('resource.0.outtoken' => $token,
2721: 'resource.0.checkouttime' => $now,
2722: 'resource.0.outremote' => $ENV{'REMOTE_ADDR'});
1.149 www 2723:
2724: unless (&cstore(\%infohash,$symb,$tcrsid,$tudom,$tuname) eq 'ok') {
2725: return '';
1.151 www 2726: } else {
1.672 albertel 2727: &logthis("<font color=\"blue\">WARNING: ".
1.151 www 2728: "Checkout cstore failed ".$tudom.' - '.$tuname.' - '.$symb.
2729: "</font>");
1.149 www 2730: }
2731:
2732: if (&log($tudom,$tuname,&homeserver($tuname,$tudom),
2733: &escape('Checkout '.$infostr.' - '.
2734: $token)) ne 'ok') {
2735: return '';
1.151 www 2736: } else {
1.672 albertel 2737: &logthis("<font color=\"blue\">WARNING: ".
1.151 www 2738: "Checkout log failed ".$tudom.' - '.$tuname.' - '.$symb.
2739: "</font>");
1.149 www 2740: }
1.151 www 2741: return $token;
1.149 www 2742: }
2743:
2744: # ------------------------------------------------------------ Check in an item
2745:
2746: sub checkin {
2747: my $token=shift;
1.150 www 2748: my $now=time;
2749: my ($ta,$tb,$lonhost)=split(/\*/,$token);
2750: $lonhost=~tr/A-Z/a-z/;
1.838 albertel 2751: my $dtoken=$ta.'_'.&hostname($lonhost).'_'.$tb;
1.150 www 2752: $dtoken=~s/\W/\_/g;
1.234 www 2753: my ($dummy,$tuname,$tudom,$tcrsid,$symb,$chtim,$rmaddr)=
1.150 www 2754: split(/\&/,&unescape(&reply('tmpget:'.$dtoken,$lonhost)));
2755:
1.154 www 2756: unless (($tuname) && ($tudom)) {
2757: &logthis('Check in '.$token.' ('.$dtoken.') failed');
2758: return '';
2759: }
2760:
2761: unless (&allowed('mgr',$tcrsid)) {
2762: &logthis('Check in '.$token.' ('.$dtoken.') unauthorized: '.
1.620 albertel 2763: $env{'user.name'}.' - '.$env{'user.domain'});
1.154 www 2764: return '';
2765: }
2766:
1.153 www 2767: my %infohash=('resource.0.intoken' => $token,
2768: 'resource.0.checkintime' => $now,
2769: 'resource.0.inremote' => $ENV{'REMOTE_ADDR'});
1.150 www 2770:
2771: unless (&cstore(\%infohash,$symb,$tcrsid,$tudom,$tuname) eq 'ok') {
2772: return '';
2773: }
2774:
2775: if (&log($tudom,$tuname,&homeserver($tuname,$tudom),
2776: &escape('Checkin - '.$token)) ne 'ok') {
2777: return '';
2778: }
2779:
2780: return ($symb,$tuname,$tudom,$tcrsid);
1.110 www 2781: }
2782:
2783: # --------------------------------------------- Set Expire Date for Spreadsheet
2784:
2785: sub expirespread {
2786: my ($uname,$udom,$stype,$usymb)=@_;
1.620 albertel 2787: my $cid=$env{'request.course.id'};
1.110 www 2788: if ($cid) {
2789: my $now=time;
2790: my $key=$uname.':'.$udom.':'.$stype.':'.$usymb;
1.620 albertel 2791: return &reply('put:'.$env{'course.'.$cid.'.domain'}.':'.
2792: $env{'course.'.$cid.'.num'}.
1.110 www 2793: ':nohist_expirationdates:'.
2794: &escape($key).'='.$now,
1.620 albertel 2795: $env{'course.'.$cid.'.home'})
1.110 www 2796: }
2797: return 'ok';
1.14 www 2798: }
2799:
1.109 www 2800: # ----------------------------------------------------- Devalidate Spreadsheets
2801:
2802: sub devalidate {
1.325 www 2803: my ($symb,$uname,$udom)=@_;
1.620 albertel 2804: my $cid=$env{'request.course.id'};
1.109 www 2805: if ($cid) {
1.391 matthew 2806: # delete the stored spreadsheets for
2807: # - the student level sheet of this user in course's homespace
2808: # - the assessment level sheet for this resource
2809: # for this user in user's homespace
1.553 albertel 2810: # - current conditional state info
1.325 www 2811: my $key=$uname.':'.$udom.':';
1.109 www 2812: my $status=
1.299 matthew 2813: &del('nohist_calculatedsheets',
1.391 matthew 2814: [$key.'studentcalc:'],
1.620 albertel 2815: $env{'course.'.$cid.'.domain'},
2816: $env{'course.'.$cid.'.num'})
1.133 albertel 2817: .' '.
2818: &del('nohist_calculatedsheets_'.$cid,
1.391 matthew 2819: [$key.'assesscalc:'.$symb],$udom,$uname);
1.109 www 2820: unless ($status eq 'ok ok') {
2821: &logthis('Could not devalidate spreadsheet '.
1.325 www 2822: $uname.' at '.$udom.' for '.
1.109 www 2823: $symb.': '.$status);
1.133 albertel 2824: }
1.553 albertel 2825: &delenv('user.state.'.$cid);
1.109 www 2826: }
2827: }
2828:
1.265 albertel 2829: sub get_scalar {
2830: my ($string,$end) = @_;
2831: my $value;
2832: if ($$string =~ s/^([^&]*?)($end)/$2/) {
2833: $value = $1;
2834: } elsif ($$string =~ s/^([^&]*?)&//) {
2835: $value = $1;
2836: }
2837: return &unescape($value);
2838: }
2839:
2840: sub array2str {
2841: my (@array) = @_;
2842: my $result=&arrayref2str(\@array);
2843: $result=~s/^__ARRAY_REF__//;
2844: $result=~s/__END_ARRAY_REF__$//;
2845: return $result;
2846: }
2847:
1.204 albertel 2848: sub arrayref2str {
2849: my ($arrayref) = @_;
1.265 albertel 2850: my $result='__ARRAY_REF__';
1.204 albertel 2851: foreach my $elem (@$arrayref) {
1.265 albertel 2852: if(ref($elem) eq 'ARRAY') {
2853: $result.=&arrayref2str($elem).'&';
2854: } elsif(ref($elem) eq 'HASH') {
2855: $result.=&hashref2str($elem).'&';
2856: } elsif(ref($elem)) {
2857: #print("Got a ref of ".(ref($elem))." skipping.");
1.204 albertel 2858: } else {
2859: $result.=&escape($elem).'&';
2860: }
2861: }
2862: $result=~s/\&$//;
1.265 albertel 2863: $result .= '__END_ARRAY_REF__';
1.204 albertel 2864: return $result;
2865: }
2866:
1.168 albertel 2867: sub hash2str {
1.204 albertel 2868: my (%hash) = @_;
2869: my $result=&hashref2str(\%hash);
1.265 albertel 2870: $result=~s/^__HASH_REF__//;
2871: $result=~s/__END_HASH_REF__$//;
1.204 albertel 2872: return $result;
2873: }
2874:
2875: sub hashref2str {
2876: my ($hashref)=@_;
1.265 albertel 2877: my $result='__HASH_REF__';
1.800 albertel 2878: foreach my $key (sort(keys(%$hashref))) {
2879: if (ref($key) eq 'ARRAY') {
2880: $result.=&arrayref2str($key).'=';
2881: } elsif (ref($key) eq 'HASH') {
2882: $result.=&hashref2str($key).'=';
2883: } elsif (ref($key)) {
1.265 albertel 2884: $result.='=';
1.800 albertel 2885: #print("Got a ref of ".(ref($key))." skipping.");
1.204 albertel 2886: } else {
1.800 albertel 2887: if ($key) {$result.=&escape($key).'=';} else { last; }
1.204 albertel 2888: }
2889:
1.800 albertel 2890: if(ref($hashref->{$key}) eq 'ARRAY') {
2891: $result.=&arrayref2str($hashref->{$key}).'&';
2892: } elsif(ref($hashref->{$key}) eq 'HASH') {
2893: $result.=&hashref2str($hashref->{$key}).'&';
2894: } elsif(ref($hashref->{$key})) {
1.265 albertel 2895: $result.='&';
1.800 albertel 2896: #print("Got a ref of ".(ref($hashref->{$key}))." skipping.");
1.204 albertel 2897: } else {
1.800 albertel 2898: $result.=&escape($hashref->{$key}).'&';
1.204 albertel 2899: }
2900: }
1.168 albertel 2901: $result=~s/\&$//;
1.265 albertel 2902: $result .= '__END_HASH_REF__';
1.168 albertel 2903: return $result;
2904: }
2905:
2906: sub str2hash {
1.265 albertel 2907: my ($string)=@_;
2908: my ($hash)=&str2hashref('__HASH_REF__'.$string.'__END_HASH_REF__');
2909: return %$hash;
2910: }
2911:
2912: sub str2hashref {
1.168 albertel 2913: my ($string) = @_;
1.265 albertel 2914:
2915: my %hash;
2916:
2917: if($string !~ /^__HASH_REF__/) {
2918: if (! ($string eq '' || !defined($string))) {
2919: $hash{'error'}='Not hash reference';
2920: }
2921: return (\%hash, $string);
2922: }
2923:
2924: $string =~ s/^__HASH_REF__//;
2925:
2926: while($string !~ /^__END_HASH_REF__/) {
2927: #key
2928: my $key='';
2929: if($string =~ /^__HASH_REF__/) {
2930: ($key, $string)=&str2hashref($string);
2931: if(defined($key->{'error'})) {
2932: $hash{'error'}='Bad data';
2933: return (\%hash, $string);
2934: }
2935: } elsif($string =~ /^__ARRAY_REF__/) {
2936: ($key, $string)=&str2arrayref($string);
2937: if($key->[0] eq 'Array reference error') {
2938: $hash{'error'}='Bad data';
2939: return (\%hash, $string);
2940: }
2941: } else {
2942: $string =~ s/^(.*?)=//;
1.267 albertel 2943: $key=&unescape($1);
1.265 albertel 2944: }
2945: $string =~ s/^=//;
2946:
2947: #value
2948: my $value='';
2949: if($string =~ /^__HASH_REF__/) {
2950: ($value, $string)=&str2hashref($string);
2951: if(defined($value->{'error'})) {
2952: $hash{'error'}='Bad data';
2953: return (\%hash, $string);
2954: }
2955: } elsif($string =~ /^__ARRAY_REF__/) {
2956: ($value, $string)=&str2arrayref($string);
2957: if($value->[0] eq 'Array reference error') {
2958: $hash{'error'}='Bad data';
2959: return (\%hash, $string);
2960: }
2961: } else {
2962: $value=&get_scalar(\$string,'__END_HASH_REF__');
2963: }
2964: $string =~ s/^&//;
2965:
2966: $hash{$key}=$value;
1.204 albertel 2967: }
1.265 albertel 2968:
2969: $string =~ s/^__END_HASH_REF__//;
2970:
2971: return (\%hash, $string);
1.204 albertel 2972: }
2973:
2974: sub str2array {
1.265 albertel 2975: my ($string)=@_;
2976: my ($array)=&str2arrayref('__ARRAY_REF__'.$string.'__END_ARRAY_REF__');
2977: return @$array;
2978: }
2979:
2980: sub str2arrayref {
1.204 albertel 2981: my ($string) = @_;
1.265 albertel 2982: my @array;
2983:
2984: if($string !~ /^__ARRAY_REF__/) {
2985: if (! ($string eq '' || !defined($string))) {
2986: $array[0]='Array reference error';
2987: }
2988: return (\@array, $string);
2989: }
2990:
2991: $string =~ s/^__ARRAY_REF__//;
2992:
2993: while($string !~ /^__END_ARRAY_REF__/) {
2994: my $value='';
2995: if($string =~ /^__HASH_REF__/) {
2996: ($value, $string)=&str2hashref($string);
2997: if(defined($value->{'error'})) {
2998: $array[0] ='Array reference error';
2999: return (\@array, $string);
3000: }
3001: } elsif($string =~ /^__ARRAY_REF__/) {
3002: ($value, $string)=&str2arrayref($string);
3003: if($value->[0] eq 'Array reference error') {
3004: $array[0] ='Array reference error';
3005: return (\@array, $string);
3006: }
3007: } else {
3008: $value=&get_scalar(\$string,'__END_ARRAY_REF__');
3009: }
3010: $string =~ s/^&//;
3011:
3012: push(@array, $value);
1.191 harris41 3013: }
1.265 albertel 3014:
3015: $string =~ s/^__END_ARRAY_REF__//;
3016:
3017: return (\@array, $string);
1.168 albertel 3018: }
3019:
1.167 albertel 3020: # -------------------------------------------------------------------Temp Store
3021:
1.168 albertel 3022: sub tmpreset {
3023: my ($symb,$namespace,$domain,$stuname) = @_;
3024: if (!$symb) {
3025: $symb=&symbread();
1.620 albertel 3026: if (!$symb) { $symb= $env{'request.url'}; }
1.168 albertel 3027: }
3028: $symb=escape($symb);
3029:
1.620 albertel 3030: if (!$namespace) { $namespace=$env{'request.state'}; }
1.168 albertel 3031: $namespace=~s/\//\_/g;
3032: $namespace=~s/\W//g;
3033:
1.620 albertel 3034: if (!$domain) { $domain=$env{'user.domain'}; }
3035: if (!$stuname) { $stuname=$env{'user.name'}; }
1.591 albertel 3036: if ($domain eq 'public' && $stuname eq 'public') {
3037: $stuname=$ENV{'REMOTE_ADDR'};
3038: }
1.168 albertel 3039: my $path=$perlvar{'lonDaemons'}.'/tmp';
3040: my %hash;
3041: if (tie(%hash,'GDBM_File',
3042: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
1.256 albertel 3043: &GDBM_WRCREAT(),0640)) {
1.168 albertel 3044: foreach my $key (keys %hash) {
1.180 albertel 3045: if ($key=~ /:$symb/) {
1.168 albertel 3046: delete($hash{$key});
3047: }
3048: }
3049: }
3050: }
3051:
1.167 albertel 3052: sub tmpstore {
1.168 albertel 3053: my ($storehash,$symb,$namespace,$domain,$stuname) = @_;
3054:
3055: if (!$symb) {
3056: $symb=&symbread();
1.620 albertel 3057: if (!$symb) { $symb= $env{'request.url'}; }
1.168 albertel 3058: }
3059: $symb=escape($symb);
3060:
3061: if (!$namespace) {
3062: # I don't think we would ever want to store this for a course.
3063: # it seems this will only be used if we don't have a course.
1.620 albertel 3064: #$namespace=$env{'request.course.id'};
1.168 albertel 3065: #if (!$namespace) {
1.620 albertel 3066: $namespace=$env{'request.state'};
1.168 albertel 3067: #}
3068: }
3069: $namespace=~s/\//\_/g;
3070: $namespace=~s/\W//g;
1.620 albertel 3071: if (!$domain) { $domain=$env{'user.domain'}; }
3072: if (!$stuname) { $stuname=$env{'user.name'}; }
1.591 albertel 3073: if ($domain eq 'public' && $stuname eq 'public') {
3074: $stuname=$ENV{'REMOTE_ADDR'};
3075: }
1.168 albertel 3076: my $now=time;
3077: my %hash;
3078: my $path=$perlvar{'lonDaemons'}.'/tmp';
3079: if (tie(%hash,'GDBM_File',
3080: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
1.256 albertel 3081: &GDBM_WRCREAT(),0640)) {
1.168 albertel 3082: $hash{"version:$symb"}++;
3083: my $version=$hash{"version:$symb"};
3084: my $allkeys='';
3085: foreach my $key (keys(%$storehash)) {
3086: $allkeys.=$key.':';
1.591 albertel 3087: $hash{"$version:$symb:$key"}=&freeze_escape($$storehash{$key});
1.168 albertel 3088: }
3089: $hash{"$version:$symb:timestamp"}=$now;
3090: $allkeys.='timestamp';
3091: $hash{"$version:keys:$symb"}=$allkeys;
3092: if (untie(%hash)) {
3093: return 'ok';
3094: } else {
3095: return "error:$!";
3096: }
3097: } else {
3098: return "error:$!";
3099: }
3100: }
1.167 albertel 3101:
1.168 albertel 3102: # -----------------------------------------------------------------Temp Restore
1.167 albertel 3103:
1.168 albertel 3104: sub tmprestore {
3105: my ($symb,$namespace,$domain,$stuname) = @_;
1.167 albertel 3106:
1.168 albertel 3107: if (!$symb) {
3108: $symb=&symbread();
1.620 albertel 3109: if (!$symb) { $symb= $env{'request.url'}; }
1.168 albertel 3110: }
3111: $symb=escape($symb);
3112:
1.620 albertel 3113: if (!$namespace) { $namespace=$env{'request.state'}; }
1.591 albertel 3114:
1.620 albertel 3115: if (!$domain) { $domain=$env{'user.domain'}; }
3116: if (!$stuname) { $stuname=$env{'user.name'}; }
1.591 albertel 3117: if ($domain eq 'public' && $stuname eq 'public') {
3118: $stuname=$ENV{'REMOTE_ADDR'};
3119: }
1.168 albertel 3120: my %returnhash;
3121: $namespace=~s/\//\_/g;
3122: $namespace=~s/\W//g;
3123: my %hash;
3124: my $path=$perlvar{'lonDaemons'}.'/tmp';
3125: if (tie(%hash,'GDBM_File',
3126: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
1.256 albertel 3127: &GDBM_READER(),0640)) {
1.168 albertel 3128: my $version=$hash{"version:$symb"};
3129: $returnhash{'version'}=$version;
3130: my $scope;
3131: for ($scope=1;$scope<=$version;$scope++) {
3132: my $vkeys=$hash{"$scope:keys:$symb"};
3133: my @keys=split(/:/,$vkeys);
3134: my $key;
3135: $returnhash{"$scope:keys"}=$vkeys;
3136: foreach $key (@keys) {
1.591 albertel 3137: $returnhash{"$scope:$key"}=&thaw_unescape($hash{"$scope:$symb:$key"});
3138: $returnhash{"$key"}=&thaw_unescape($hash{"$scope:$symb:$key"});
1.167 albertel 3139: }
3140: }
1.168 albertel 3141: if (!(untie(%hash))) {
3142: return "error:$!";
3143: }
3144: } else {
3145: return "error:$!";
3146: }
3147: return %returnhash;
1.167 albertel 3148: }
3149:
1.9 www 3150: # ----------------------------------------------------------------------- Store
3151:
3152: sub store {
1.124 www 3153: my ($storehash,$symb,$namespace,$domain,$stuname) = @_;
3154: my $home='';
3155:
1.168 albertel 3156: if ($stuname) { $home=&homeserver($stuname,$domain); }
1.124 www 3157:
1.213 www 3158: $symb=&symbclean($symb);
1.122 albertel 3159: if (!$symb) { unless ($symb=&symbread()) { return ''; } }
1.109 www 3160:
1.620 albertel 3161: if (!$domain) { $domain=$env{'user.domain'}; }
3162: if (!$stuname) { $stuname=$env{'user.name'}; }
1.325 www 3163:
3164: &devalidate($symb,$stuname,$domain);
1.109 www 3165:
3166: $symb=escape($symb);
1.187 www 3167: if (!$namespace) {
1.620 albertel 3168: unless ($namespace=$env{'request.course.id'}) {
1.187 www 3169: return '';
3170: }
3171: }
1.620 albertel 3172: if (!$home) { $home=$env{'user.home'}; }
1.447 www 3173:
3174: $$storehash{'ip'}=$ENV{'REMOTE_ADDR'};
3175: $$storehash{'host'}=$perlvar{'lonHostID'};
3176:
1.12 www 3177: my $namevalue='';
1.800 albertel 3178: foreach my $key (keys(%$storehash)) {
3179: $namevalue.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
1.191 harris41 3180: }
1.12 www 3181: $namevalue=~s/\&$//;
1.187 www 3182: &courselog($symb.':'.$stuname.':'.$domain.':STORE:'.$namevalue);
1.124 www 3183: return reply("store:$domain:$stuname:$namespace:$symb:$namevalue","$home");
1.9 www 3184: }
3185:
1.47 www 3186: # -------------------------------------------------------------- Critical Store
3187:
3188: sub cstore {
1.124 www 3189: my ($storehash,$symb,$namespace,$domain,$stuname) = @_;
3190: my $home='';
3191:
1.168 albertel 3192: if ($stuname) { $home=&homeserver($stuname,$domain); }
1.124 www 3193:
1.213 www 3194: $symb=&symbclean($symb);
1.122 albertel 3195: if (!$symb) { unless ($symb=&symbread()) { return ''; } }
1.109 www 3196:
1.620 albertel 3197: if (!$domain) { $domain=$env{'user.domain'}; }
3198: if (!$stuname) { $stuname=$env{'user.name'}; }
1.325 www 3199:
3200: &devalidate($symb,$stuname,$domain);
1.109 www 3201:
3202: $symb=escape($symb);
1.187 www 3203: if (!$namespace) {
1.620 albertel 3204: unless ($namespace=$env{'request.course.id'}) {
1.187 www 3205: return '';
3206: }
3207: }
1.620 albertel 3208: if (!$home) { $home=$env{'user.home'}; }
1.447 www 3209:
3210: $$storehash{'ip'}=$ENV{'REMOTE_ADDR'};
3211: $$storehash{'host'}=$perlvar{'lonHostID'};
1.122 albertel 3212:
1.47 www 3213: my $namevalue='';
1.800 albertel 3214: foreach my $key (keys(%$storehash)) {
3215: $namevalue.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
1.191 harris41 3216: }
1.47 www 3217: $namevalue=~s/\&$//;
1.187 www 3218: &courselog($symb.':'.$stuname.':'.$domain.':CSTORE:'.$namevalue);
1.188 www 3219: return critical
3220: ("store:$domain:$stuname:$namespace:$symb:$namevalue","$home");
1.47 www 3221: }
3222:
1.9 www 3223: # --------------------------------------------------------------------- Restore
3224:
3225: sub restore {
1.124 www 3226: my ($symb,$namespace,$domain,$stuname) = @_;
3227: my $home='';
3228:
1.168 albertel 3229: if ($stuname) { $home=&homeserver($stuname,$domain); }
1.124 www 3230:
1.122 albertel 3231: if (!$symb) {
3232: unless ($symb=escape(&symbread())) { return ''; }
3233: } else {
1.213 www 3234: $symb=&escape(&symbclean($symb));
1.122 albertel 3235: }
1.188 www 3236: if (!$namespace) {
1.620 albertel 3237: unless ($namespace=$env{'request.course.id'}) {
1.188 www 3238: return '';
3239: }
3240: }
1.620 albertel 3241: if (!$domain) { $domain=$env{'user.domain'}; }
3242: if (!$stuname) { $stuname=$env{'user.name'}; }
3243: if (!$home) { $home=$env{'user.home'}; }
1.122 albertel 3244: my $answer=&reply("restore:$domain:$stuname:$namespace:$symb","$home");
3245:
1.12 www 3246: my %returnhash=();
1.800 albertel 3247: foreach my $line (split(/\&/,$answer)) {
3248: my ($name,$value)=split(/\=/,$line);
1.591 albertel 3249: $returnhash{&unescape($name)}=&thaw_unescape($value);
1.191 harris41 3250: }
1.75 www 3251: my $version;
3252: for ($version=1;$version<=$returnhash{'version'};$version++) {
1.800 albertel 3253: foreach my $item (split(/\:/,$returnhash{$version.':keys'})) {
3254: $returnhash{$item}=$returnhash{$version.':'.$item};
1.191 harris41 3255: }
1.75 www 3256: }
1.13 www 3257: return %returnhash;
1.34 www 3258: }
3259:
3260: # ---------------------------------------------------------- Course Description
3261:
3262: sub coursedescription {
1.731 albertel 3263: my ($courseid,$args)=@_;
1.34 www 3264: $courseid=~s/^\///;
1.49 www 3265: $courseid=~s/\_/\//g;
1.34 www 3266: my ($cdomain,$cnum)=split(/\//,$courseid);
1.129 albertel 3267: my $chome=&homeserver($cnum,$cdomain);
1.302 albertel 3268: my $normalid=$cdomain.'_'.$cnum;
3269: # need to always cache even if we get errors otherwise we keep
3270: # trying and trying and trying to get the course description.
3271: my %envhash=();
3272: my %returnhash=();
1.731 albertel 3273:
3274: my $expiretime=600;
3275: if ($env{'request.course.id'} eq $normalid) {
3276: $expiretime=120;
3277: }
3278:
3279: my $prefix='course.'.$cdomain.'_'.$cnum.'.';
3280: if (!$args->{'freshen_cache'}
3281: && ((time-$env{$prefix.'last_cache'}) < $expiretime) ) {
3282: foreach my $key (keys(%env)) {
3283: next if ($key !~ /^\Q$prefix\E(.*)/);
3284: my ($setting) = $1;
3285: $returnhash{$setting} = $env{$key};
3286: }
3287: return %returnhash;
3288: }
3289:
3290: # get the data agin
3291: if (!$args->{'one_time'}) {
3292: $envhash{'course.'.$normalid.'.last_cache'}=time;
3293: }
1.811 albertel 3294:
1.34 www 3295: if ($chome ne 'no_host') {
1.302 albertel 3296: %returnhash=&dump('environment',$cdomain,$cnum);
1.129 albertel 3297: if (!exists($returnhash{'con_lost'})) {
3298: $returnhash{'home'}= $chome;
3299: $returnhash{'domain'} = $cdomain;
3300: $returnhash{'num'} = $cnum;
1.741 raeburn 3301: if (!defined($returnhash{'type'})) {
3302: $returnhash{'type'} = 'Course';
3303: }
1.130 albertel 3304: while (my ($name,$value) = each %returnhash) {
1.53 www 3305: $envhash{'course.'.$normalid.'.'.$name}=$value;
1.129 albertel 3306: }
1.270 www 3307: $returnhash{'url'}=&clutter($returnhash{'url'});
1.34 www 3308: $returnhash{'fn'}=$perlvar{'lonDaemons'}.'/tmp/'.
1.620 albertel 3309: $env{'user.name'}.'_'.$cdomain.'_'.$cnum;
1.60 www 3310: $envhash{'course.'.$normalid.'.home'}=$chome;
3311: $envhash{'course.'.$normalid.'.domain'}=$cdomain;
3312: $envhash{'course.'.$normalid.'.num'}=$cnum;
1.34 www 3313: }
3314: }
1.731 albertel 3315: if (!$args->{'one_time'}) {
3316: &appenv(%envhash);
3317: }
1.302 albertel 3318: return %returnhash;
1.461 www 3319: }
3320:
3321: # -------------------------------------------------See if a user is privileged
3322:
3323: sub privileged {
3324: my ($username,$domain)=@_;
3325: my $rolesdump=&reply("dump:$domain:$username:roles",
3326: &homeserver($username,$domain));
3327: if (($rolesdump eq 'con_lost') || ($rolesdump eq '')) { return 0; }
3328: my $now=time;
3329: if ($rolesdump ne '') {
1.800 albertel 3330: foreach my $entry (split(/&/,$rolesdump)) {
3331: if ($entry!~/^rolesdef_/) {
3332: my ($area,$role)=split(/=/,$entry);
1.461 www 3333: $area=~s/\_\w\w$//;
3334: my ($trole,$tend,$tstart)=split(/_/,$role);
3335: if (($trole eq 'dc') || ($trole eq 'su')) {
3336: my $active=1;
3337: if ($tend) {
3338: if ($tend<$now) { $active=0; }
3339: }
3340: if ($tstart) {
3341: if ($tstart>$now) { $active=0; }
3342: }
3343: if ($active) { return 1; }
3344: }
3345: }
3346: }
3347: }
3348: return 0;
1.9 www 3349: }
1.1 albertel 3350:
1.103 harris41 3351: # -------------------------------------------------------- Get user privileges
1.11 www 3352:
3353: sub rolesinit {
3354: my ($domain,$username,$authhost)=@_;
3355: my $rolesdump=reply("dump:$domain:$username:roles",$authhost);
1.12 www 3356: if (($rolesdump eq 'con_lost') || ($rolesdump eq '')) { return ''; }
1.11 www 3357: my %allroles=();
1.678 raeburn 3358: my %allgroups=();
1.11 www 3359: my $now=time;
1.743 albertel 3360: my %userroles = ('user.login.time' => $now);
1.678 raeburn 3361: my $group_privs;
1.11 www 3362:
3363: if ($rolesdump ne '') {
1.800 albertel 3364: foreach my $entry (split(/&/,$rolesdump)) {
3365: if ($entry!~/^rolesdef_/) {
3366: my ($area,$role)=split(/=/,$entry);
1.587 albertel 3367: $area=~s/\_\w\w$//;
1.678 raeburn 3368: my ($trole,$tend,$tstart,$group_privs);
1.587 albertel 3369: if ($role=~/^cr/) {
1.807 albertel 3370: if ($role=~m|^(cr/$match_domain/$match_username/[a-zA-Z0-9]+)_(.*)$|) {
3371: ($trole,my $trest)=($role=~m|^(cr/$match_domain/$match_username/[a-zA-Z0-9]+)_(.*)$|);
1.655 albertel 3372: ($tend,$tstart)=split('_',$trest);
3373: } else {
3374: $trole=$role;
3375: }
1.678 raeburn 3376: } elsif ($role =~ m|^gr/|) {
3377: ($trole,$tend,$tstart) = split(/_/,$role);
3378: ($trole,$group_privs) = split(/\//,$trole);
3379: $group_privs = &unescape($group_privs);
1.587 albertel 3380: } else {
3381: ($trole,$tend,$tstart)=split(/_/,$role);
3382: }
1.743 albertel 3383: my %new_role = &set_arearole($trole,$area,$tstart,$tend,$domain,
3384: $username);
3385: @userroles{keys(%new_role)} = @new_role{keys(%new_role)};
1.567 raeburn 3386: if (($tend!=0) && ($tend<$now)) { $trole=''; }
3387: if (($tstart!=0) && ($tstart>$now)) { $trole=''; }
1.11 www 3388: if (($area ne '') && ($trole ne '')) {
1.347 albertel 3389: my $spec=$trole.'.'.$area;
3390: my ($tdummy,$tdomain,$trest)=split(/\//,$area);
3391: if ($trole =~ /^cr\//) {
1.567 raeburn 3392: &custom_roleprivs(\%allroles,$trole,$tdomain,$trest,$spec,$area);
1.678 raeburn 3393: } elsif ($trole eq 'gr') {
3394: &group_roleprivs(\%allgroups,$area,$group_privs,$tend,$tstart);
1.347 albertel 3395: } else {
1.567 raeburn 3396: &standard_roleprivs(\%allroles,$trole,$tdomain,$spec,$trest,$area);
1.347 albertel 3397: }
1.12 www 3398: }
1.662 raeburn 3399: }
1.191 harris41 3400: }
1.743 albertel 3401: my ($author,$adv) = &set_userprivs(\%userroles,\%allroles,\%allgroups);
3402: $userroles{'user.adv'} = $adv;
3403: $userroles{'user.author'} = $author;
1.620 albertel 3404: $env{'user.adv'}=$adv;
1.11 www 3405: }
1.743 albertel 3406: return \%userroles;
1.11 www 3407: }
3408:
1.567 raeburn 3409: sub set_arearole {
3410: my ($trole,$area,$tstart,$tend,$domain,$username) = @_;
3411: # log the associated role with the area
3412: &userrolelog($trole,$username,$domain,$area,$tstart,$tend);
1.743 albertel 3413: return ('user.role.'.$trole.'.'.$area => $tstart.'.'.$tend);
1.567 raeburn 3414: }
3415:
3416: sub custom_roleprivs {
3417: my ($allroles,$trole,$tdomain,$trest,$spec,$area) = @_;
3418: my ($rdummy,$rdomain,$rauthor,$rrole)=split(/\//,$trole);
3419: my $homsvr=homeserver($rauthor,$rdomain);
1.838 albertel 3420: if (&hostname($homsvr) ne '') {
1.567 raeburn 3421: my ($rdummy,$roledef)=
3422: &get('roles',["rolesdef_$rrole"],$rdomain,$rauthor);
3423: if (($rdummy ne 'con_lost') && ($roledef ne '')) {
3424: my ($syspriv,$dompriv,$coursepriv)=split(/\_/,$roledef);
3425: if (defined($syspriv)) {
3426: $$allroles{'cm./'}.=':'.$syspriv;
3427: $$allroles{$spec.'./'}.=':'.$syspriv;
3428: }
3429: if ($tdomain ne '') {
3430: if (defined($dompriv)) {
3431: $$allroles{'cm./'.$tdomain.'/'}.=':'.$dompriv;
3432: $$allroles{$spec.'./'.$tdomain.'/'}.=':'.$dompriv;
3433: }
3434: if (($trest ne '') && (defined($coursepriv))) {
3435: $$allroles{'cm.'.$area}.=':'.$coursepriv;
3436: $$allroles{$spec.'.'.$area}.=':'.$coursepriv;
3437: }
3438: }
3439: }
3440: }
3441: }
3442:
1.678 raeburn 3443: sub group_roleprivs {
3444: my ($allgroups,$area,$group_privs,$tend,$tstart) = @_;
3445: my $access = 1;
3446: my $now = time;
3447: if (($tend!=0) && ($tend<$now)) { $access = 0; }
3448: if (($tstart!=0) && ($tstart>$now)) { $access=0; }
3449: if ($access) {
1.811 albertel 3450: my ($course,$group) = ($area =~ m|(/$match_domain/$match_courseid)/([^/]+)$|);
1.678 raeburn 3451: $$allgroups{$course}{$group} .=':'.$group_privs;
3452: }
3453: }
1.567 raeburn 3454:
3455: sub standard_roleprivs {
3456: my ($allroles,$trole,$tdomain,$spec,$trest,$area) = @_;
3457: if (defined($pr{$trole.':s'})) {
3458: $$allroles{'cm./'}.=':'.$pr{$trole.':s'};
3459: $$allroles{$spec.'./'}.=':'.$pr{$trole.':s'};
3460: }
3461: if ($tdomain ne '') {
3462: if (defined($pr{$trole.':d'})) {
3463: $$allroles{'cm./'.$tdomain.'/'}.=':'.$pr{$trole.':d'};
3464: $$allroles{$spec.'./'.$tdomain.'/'}.=':'.$pr{$trole.':d'};
3465: }
3466: if (($trest ne '') && (defined($pr{$trole.':c'}))) {
3467: $$allroles{'cm.'.$area}.=':'.$pr{$trole.':c'};
3468: $$allroles{$spec.'.'.$area}.=':'.$pr{$trole.':c'};
3469: }
3470: }
3471: }
3472:
3473: sub set_userprivs {
1.678 raeburn 3474: my ($userroles,$allroles,$allgroups) = @_;
1.567 raeburn 3475: my $author=0;
3476: my $adv=0;
1.678 raeburn 3477: my %grouproles = ();
3478: if (keys(%{$allgroups}) > 0) {
3479: foreach my $role (keys %{$allroles}) {
1.681 raeburn 3480: my ($trole,$area,$sec,$extendedarea);
1.881 raeburn 3481: if ($role =~ m-^(\w+|cr/$match_domain/$match_username/\w+)\.(/$match_domain/$match_courseid)(/?\w*)\.-) {
1.678 raeburn 3482: $trole = $1;
3483: $area = $2;
1.681 raeburn 3484: $sec = $3;
3485: $extendedarea = $area.$sec;
3486: if (exists($$allgroups{$area})) {
3487: foreach my $group (keys(%{$$allgroups{$area}})) {
3488: my $spec = $trole.'.'.$extendedarea;
3489: $grouproles{$spec.'.'.$area.'/'.$group} =
3490: $$allgroups{$area}{$group};
1.678 raeburn 3491: }
3492: }
3493: }
3494: }
3495: }
1.800 albertel 3496: foreach my $group (keys(%grouproles)) {
3497: $$allroles{$group} = $grouproles{$group};
1.678 raeburn 3498: }
1.800 albertel 3499: foreach my $role (keys(%{$allroles})) {
3500: my %thesepriv;
3501: if (($role=~/^au/) || ($role=~/^ca/)) { $author=1; }
3502: foreach my $item (split(/:/,$$allroles{$role})) {
3503: if ($item ne '') {
3504: my ($privilege,$restrictions)=split(/&/,$item);
1.567 raeburn 3505: if ($restrictions eq '') {
3506: $thesepriv{$privilege}='F';
3507: } elsif ($thesepriv{$privilege} ne 'F') {
3508: $thesepriv{$privilege}.=$restrictions;
3509: }
3510: if ($thesepriv{'adv'} eq 'F') { $adv=1; }
3511: }
3512: }
3513: my $thesestr='';
1.800 albertel 3514: foreach my $priv (keys(%thesepriv)) {
3515: $thesestr.=':'.$priv.'&'.$thesepriv{$priv};
3516: }
3517: $userroles->{'user.priv.'.$role} = $thesestr;
1.567 raeburn 3518: }
3519: return ($author,$adv);
3520: }
3521:
1.12 www 3522: # --------------------------------------------------------------- get interface
3523:
3524: sub get {
1.131 albertel 3525: my ($namespace,$storearr,$udomain,$uname)=@_;
1.12 www 3526: my $items='';
1.800 albertel 3527: foreach my $item (@$storearr) {
3528: $items.=&escape($item).'&';
1.191 harris41 3529: }
1.12 www 3530: $items=~s/\&$//;
1.620 albertel 3531: if (!$udomain) { $udomain=$env{'user.domain'}; }
3532: if (!$uname) { $uname=$env{'user.name'}; }
1.131 albertel 3533: my $uhome=&homeserver($uname,$udomain);
3534:
1.133 albertel 3535: my $rep=&reply("get:$udomain:$uname:$namespace:$items",$uhome);
1.15 www 3536: my @pairs=split(/\&/,$rep);
1.273 albertel 3537: if ( $#pairs==0 && $pairs[0] =~ /^(con_lost|error|no_such_host)/i) {
3538: return @pairs;
3539: }
1.15 www 3540: my %returnhash=();
1.42 www 3541: my $i=0;
1.800 albertel 3542: foreach my $item (@$storearr) {
3543: $returnhash{$item}=&thaw_unescape($pairs[$i]);
1.42 www 3544: $i++;
1.191 harris41 3545: }
1.15 www 3546: return %returnhash;
1.27 www 3547: }
3548:
3549: # --------------------------------------------------------------- del interface
3550:
3551: sub del {
1.133 albertel 3552: my ($namespace,$storearr,$udomain,$uname)=@_;
1.27 www 3553: my $items='';
1.800 albertel 3554: foreach my $item (@$storearr) {
3555: $items.=&escape($item).'&';
1.191 harris41 3556: }
1.27 www 3557: $items=~s/\&$//;
1.620 albertel 3558: if (!$udomain) { $udomain=$env{'user.domain'}; }
3559: if (!$uname) { $uname=$env{'user.name'}; }
1.133 albertel 3560: my $uhome=&homeserver($uname,$udomain);
3561:
3562: return &reply("del:$udomain:$uname:$namespace:$items",$uhome);
1.15 www 3563: }
3564:
3565: # -------------------------------------------------------------- dump interface
3566:
3567: sub dump {
1.755 albertel 3568: my ($namespace,$udomain,$uname,$regexp,$range)=@_;
3569: if (!$udomain) { $udomain=$env{'user.domain'}; }
3570: if (!$uname) { $uname=$env{'user.name'}; }
3571: my $uhome=&homeserver($uname,$udomain);
3572: if ($regexp) {
3573: $regexp=&escape($regexp);
3574: } else {
3575: $regexp='.';
3576: }
3577: my $rep=&reply("dump:$udomain:$uname:$namespace:$regexp:$range",$uhome);
3578: my @pairs=split(/\&/,$rep);
3579: my %returnhash=();
3580: foreach my $item (@pairs) {
3581: my ($key,$value)=split(/=/,$item,2);
3582: $key = &unescape($key);
3583: next if ($key =~ /^error: 2 /);
3584: $returnhash{$key}=&thaw_unescape($value);
3585: }
3586: return %returnhash;
1.407 www 3587: }
3588:
1.717 albertel 3589: # --------------------------------------------------------- dumpstore interface
3590:
3591: sub dumpstore {
3592: my ($namespace,$udomain,$uname,$regexp,$range)=@_;
1.822 albertel 3593: if (!$udomain) { $udomain=$env{'user.domain'}; }
3594: if (!$uname) { $uname=$env{'user.name'}; }
3595: my $uhome=&homeserver($uname,$udomain);
3596: if ($regexp) {
3597: $regexp=&escape($regexp);
3598: } else {
3599: $regexp='.';
3600: }
3601: my $rep=&reply("dump:$udomain:$uname:$namespace:$regexp:$range",$uhome);
3602: my @pairs=split(/\&/,$rep);
3603: my %returnhash=();
3604: foreach my $item (@pairs) {
3605: my ($key,$value)=split(/=/,$item,2);
3606: next if ($key =~ /^error: 2 /);
3607: $returnhash{$key}=&thaw_unescape($value);
3608: }
3609: return %returnhash;
1.717 albertel 3610: }
3611:
1.407 www 3612: # -------------------------------------------------------------- keys interface
3613:
3614: sub getkeys {
3615: my ($namespace,$udomain,$uname)=@_;
1.620 albertel 3616: if (!$udomain) { $udomain=$env{'user.domain'}; }
3617: if (!$uname) { $uname=$env{'user.name'}; }
1.407 www 3618: my $uhome=&homeserver($uname,$udomain);
3619: my $rep=reply("keys:$udomain:$uname:$namespace",$uhome);
3620: my @keyarray=();
1.800 albertel 3621: foreach my $key (split(/\&/,$rep)) {
1.812 raeburn 3622: next if ($key =~ /^error: 2 /);
1.800 albertel 3623: push(@keyarray,&unescape($key));
1.407 www 3624: }
3625: return @keyarray;
1.318 matthew 3626: }
3627:
1.319 matthew 3628: # --------------------------------------------------------------- currentdump
3629: sub currentdump {
1.328 matthew 3630: my ($courseid,$sdom,$sname)=@_;
1.620 albertel 3631: $courseid = $env{'request.course.id'} if (! defined($courseid));
3632: $sdom = $env{'user.domain'} if (! defined($sdom));
3633: $sname = $env{'user.name'} if (! defined($sname));
1.326 matthew 3634: my $uhome = &homeserver($sname,$sdom);
3635: my $rep=reply('currentdump:'.$sdom.':'.$sname.':'.$courseid,$uhome);
1.318 matthew 3636: return if ($rep =~ /^(error:|no_such_host)/);
1.319 matthew 3637: #
1.318 matthew 3638: my %returnhash=();
1.319 matthew 3639: #
3640: if ($rep eq "unknown_cmd") {
3641: # an old lond will not know currentdump
3642: # Do a dump and make it look like a currentdump
1.822 albertel 3643: my @tmp = &dumpstore($courseid,$sdom,$sname,'.');
1.319 matthew 3644: return if ($tmp[0] =~ /^(error:|no_such_host)/);
3645: my %hash = @tmp;
3646: @tmp=();
1.424 matthew 3647: %returnhash = %{&convert_dump_to_currentdump(\%hash)};
1.319 matthew 3648: } else {
3649: my @pairs=split(/\&/,$rep);
1.800 albertel 3650: foreach my $pair (@pairs) {
3651: my ($key,$value)=split(/=/,$pair,2);
1.319 matthew 3652: my ($symb,$param) = split(/:/,$key);
3653: $returnhash{&unescape($symb)}->{&unescape($param)} =
1.557 albertel 3654: &thaw_unescape($value);
1.319 matthew 3655: }
1.191 harris41 3656: }
1.12 www 3657: return %returnhash;
1.424 matthew 3658: }
3659:
3660: sub convert_dump_to_currentdump{
3661: my %hash = %{shift()};
3662: my %returnhash;
3663: # Code ripped from lond, essentially. The only difference
3664: # here is the unescaping done by lonnet::dump(). Conceivably
3665: # we might run in to problems with parameter names =~ /^v\./
3666: while (my ($key,$value) = each(%hash)) {
3667: my ($v,$symb,$param) = split(/:/,$key);
1.822 albertel 3668: $symb = &unescape($symb);
3669: $param = &unescape($param);
1.424 matthew 3670: next if ($v eq 'version' || $symb eq 'keys');
3671: next if (exists($returnhash{$symb}) &&
3672: exists($returnhash{$symb}->{$param}) &&
3673: $returnhash{$symb}->{'v.'.$param} > $v);
3674: $returnhash{$symb}->{$param}=$value;
3675: $returnhash{$symb}->{'v.'.$param}=$v;
3676: }
3677: #
3678: # Remove all of the keys in the hashes which keep track of
3679: # the version of the parameter.
3680: while (my ($symb,$param_hash) = each(%returnhash)) {
3681: # use a foreach because we are going to delete from the hash.
3682: foreach my $key (keys(%$param_hash)) {
3683: delete($param_hash->{$key}) if ($key =~ /^v\./);
3684: }
3685: }
3686: return \%returnhash;
1.12 www 3687: }
3688:
1.627 albertel 3689: # ------------------------------------------------------ critical inc interface
3690:
3691: sub cinc {
3692: return &inc(@_,'critical');
3693: }
3694:
1.449 matthew 3695: # --------------------------------------------------------------- inc interface
3696:
3697: sub inc {
1.627 albertel 3698: my ($namespace,$store,$udomain,$uname,$critical) = @_;
1.620 albertel 3699: if (!$udomain) { $udomain=$env{'user.domain'}; }
3700: if (!$uname) { $uname=$env{'user.name'}; }
1.449 matthew 3701: my $uhome=&homeserver($uname,$udomain);
3702: my $items='';
3703: if (! ref($store)) {
3704: # got a single value, so use that instead
3705: $items = &escape($store).'=&';
3706: } elsif (ref($store) eq 'SCALAR') {
3707: $items = &escape($$store).'=&';
3708: } elsif (ref($store) eq 'ARRAY') {
3709: $items = join('=&',map {&escape($_);} @{$store});
3710: } elsif (ref($store) eq 'HASH') {
3711: while (my($key,$value) = each(%{$store})) {
3712: $items.= &escape($key).'='.&escape($value).'&';
3713: }
3714: }
3715: $items=~s/\&$//;
1.627 albertel 3716: if ($critical) {
3717: return &critical("inc:$udomain:$uname:$namespace:$items",$uhome);
3718: } else {
3719: return &reply("inc:$udomain:$uname:$namespace:$items",$uhome);
3720: }
1.449 matthew 3721: }
3722:
1.12 www 3723: # --------------------------------------------------------------- put interface
3724:
3725: sub put {
1.134 albertel 3726: my ($namespace,$storehash,$udomain,$uname)=@_;
1.620 albertel 3727: if (!$udomain) { $udomain=$env{'user.domain'}; }
3728: if (!$uname) { $uname=$env{'user.name'}; }
1.134 albertel 3729: my $uhome=&homeserver($uname,$udomain);
1.12 www 3730: my $items='';
1.800 albertel 3731: foreach my $item (keys(%$storehash)) {
3732: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
1.191 harris41 3733: }
1.12 www 3734: $items=~s/\&$//;
1.134 albertel 3735: return &reply("put:$udomain:$uname:$namespace:$items",$uhome);
1.47 www 3736: }
3737:
1.631 albertel 3738: # ------------------------------------------------------------ newput interface
3739:
3740: sub newput {
3741: my ($namespace,$storehash,$udomain,$uname)=@_;
3742: if (!$udomain) { $udomain=$env{'user.domain'}; }
3743: if (!$uname) { $uname=$env{'user.name'}; }
3744: my $uhome=&homeserver($uname,$udomain);
3745: my $items='';
3746: foreach my $key (keys(%$storehash)) {
3747: $items.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
3748: }
3749: $items=~s/\&$//;
3750: return &reply("newput:$udomain:$uname:$namespace:$items",$uhome);
3751: }
3752:
3753: # --------------------------------------------------------- putstore interface
3754:
1.524 raeburn 3755: sub putstore {
1.715 albertel 3756: my ($namespace,$symb,$version,$storehash,$udomain,$uname)=@_;
1.620 albertel 3757: if (!$udomain) { $udomain=$env{'user.domain'}; }
3758: if (!$uname) { $uname=$env{'user.name'}; }
1.524 raeburn 3759: my $uhome=&homeserver($uname,$udomain);
3760: my $items='';
1.715 albertel 3761: foreach my $key (keys(%$storehash)) {
3762: $items.= &escape($key).'='.&freeze_escape($storehash->{$key}).'&';
1.524 raeburn 3763: }
1.715 albertel 3764: $items=~s/\&$//;
1.716 albertel 3765: my $esc_symb=&escape($symb);
3766: my $esc_v=&escape($version);
1.715 albertel 3767: my $reply =
1.716 albertel 3768: &reply("putstore:$udomain:$uname:$namespace:$esc_symb:$esc_v:$items",
1.715 albertel 3769: $uhome);
3770: if ($reply eq 'unknown_cmd') {
1.716 albertel 3771: # gfall back to way things use to be done
1.715 albertel 3772: return &old_putstore($namespace,$symb,$version,$storehash,$udomain,
3773: $uname);
1.524 raeburn 3774: }
1.715 albertel 3775: return $reply;
3776: }
3777:
3778: sub old_putstore {
1.716 albertel 3779: my ($namespace,$symb,$version,$storehash,$udomain,$uname)=@_;
3780: if (!$udomain) { $udomain=$env{'user.domain'}; }
3781: if (!$uname) { $uname=$env{'user.name'}; }
3782: my $uhome=&homeserver($uname,$udomain);
3783: my %newstorehash;
1.800 albertel 3784: foreach my $item (keys(%$storehash)) {
3785: my $key = $version.':'.&escape($symb).':'.$item;
3786: $newstorehash{$key} = $storehash->{$item};
1.716 albertel 3787: }
3788: my $items='';
3789: my %allitems = ();
1.800 albertel 3790: foreach my $item (keys(%newstorehash)) {
3791: if ($item =~ m/^([^\:]+):([^\:]+):([^\:]+)$/) {
1.716 albertel 3792: my $key = $1.':keys:'.$2;
3793: $allitems{$key} .= $3.':';
3794: }
1.800 albertel 3795: $items.=$item.'='.&freeze_escape($newstorehash{$item}).'&';
1.716 albertel 3796: }
1.800 albertel 3797: foreach my $item (keys(%allitems)) {
3798: $allitems{$item} =~ s/\:$//;
3799: $items.= $item.'='.$allitems{$item}.'&';
1.716 albertel 3800: }
3801: $items=~s/\&$//;
3802: return &reply("put:$udomain:$uname:$namespace:$items",$uhome);
1.524 raeburn 3803: }
3804:
1.47 www 3805: # ------------------------------------------------------ critical put interface
3806:
3807: sub cput {
1.134 albertel 3808: my ($namespace,$storehash,$udomain,$uname)=@_;
1.620 albertel 3809: if (!$udomain) { $udomain=$env{'user.domain'}; }
3810: if (!$uname) { $uname=$env{'user.name'}; }
1.134 albertel 3811: my $uhome=&homeserver($uname,$udomain);
1.47 www 3812: my $items='';
1.800 albertel 3813: foreach my $item (keys(%$storehash)) {
3814: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
1.191 harris41 3815: }
1.47 www 3816: $items=~s/\&$//;
1.134 albertel 3817: return &critical("put:$udomain:$uname:$namespace:$items",$uhome);
1.12 www 3818: }
3819:
3820: # -------------------------------------------------------------- eget interface
3821:
3822: sub eget {
1.133 albertel 3823: my ($namespace,$storearr,$udomain,$uname)=@_;
1.12 www 3824: my $items='';
1.800 albertel 3825: foreach my $item (@$storearr) {
3826: $items.=&escape($item).'&';
1.191 harris41 3827: }
1.12 www 3828: $items=~s/\&$//;
1.620 albertel 3829: if (!$udomain) { $udomain=$env{'user.domain'}; }
3830: if (!$uname) { $uname=$env{'user.name'}; }
1.133 albertel 3831: my $uhome=&homeserver($uname,$udomain);
3832: my $rep=&reply("eget:$udomain:$uname:$namespace:$items",$uhome);
1.12 www 3833: my @pairs=split(/\&/,$rep);
3834: my %returnhash=();
1.42 www 3835: my $i=0;
1.800 albertel 3836: foreach my $item (@$storearr) {
3837: $returnhash{$item}=&thaw_unescape($pairs[$i]);
1.42 www 3838: $i++;
1.191 harris41 3839: }
1.12 www 3840: return %returnhash;
3841: }
3842:
1.667 albertel 3843: # ------------------------------------------------------------ tmpput interface
3844: sub tmpput {
1.802 raeburn 3845: my ($storehash,$server,$context)=@_;
1.667 albertel 3846: my $items='';
1.800 albertel 3847: foreach my $item (keys(%$storehash)) {
3848: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
1.667 albertel 3849: }
3850: $items=~s/\&$//;
1.802 raeburn 3851: if (defined($context)) {
3852: $items .= ':'.&escape($context);
3853: }
1.667 albertel 3854: return &reply("tmpput:$items",$server);
3855: }
3856:
3857: # ------------------------------------------------------------ tmpget interface
3858: sub tmpget {
1.688 albertel 3859: my ($token,$server)=@_;
3860: if (!defined($server)) { $server = $perlvar{'lonHostID'}; }
3861: my $rep=&reply("tmpget:$token",$server);
1.667 albertel 3862: my %returnhash;
3863: foreach my $item (split(/\&/,$rep)) {
3864: my ($key,$value)=split(/=/,$item);
3865: $returnhash{&unescape($key)}=&thaw_unescape($value);
3866: }
3867: return %returnhash;
3868: }
3869:
1.688 albertel 3870: # ------------------------------------------------------------ tmpget interface
3871: sub tmpdel {
3872: my ($token,$server)=@_;
3873: if (!defined($server)) { $server = $perlvar{'lonHostID'}; }
3874: return &reply("tmpdel:$token",$server);
3875: }
3876:
1.765 albertel 3877: # -------------------------------------------------- portfolio access checking
3878:
3879: sub portfolio_access {
1.766 albertel 3880: my ($requrl) = @_;
1.765 albertel 3881: my (undef,$udom,$unum,$file_name,$group) = &parse_portfolio_url($requrl);
3882: my $result = &get_portfolio_access($udom,$unum,$file_name,$group);
1.814 raeburn 3883: if ($result) {
3884: my %setters;
3885: if ($env{'user.name'} eq 'public' && $env{'user.domain'} eq 'public') {
3886: my ($startblock,$endblock) =
3887: &Apache::loncommon::blockcheck(\%setters,'port',$unum,$udom);
3888: if ($startblock && $endblock) {
3889: return 'B';
3890: }
3891: } else {
3892: my ($startblock,$endblock) =
3893: &Apache::loncommon::blockcheck(\%setters,'port');
3894: if ($startblock && $endblock) {
3895: return 'B';
3896: }
3897: }
3898: }
1.765 albertel 3899: if ($result eq 'ok') {
1.766 albertel 3900: return 'F';
1.765 albertel 3901: } elsif ($result =~ /^[^:]+:guest_/) {
1.766 albertel 3902: return 'A';
1.765 albertel 3903: }
1.766 albertel 3904: return '';
1.765 albertel 3905: }
3906:
3907: sub get_portfolio_access {
1.767 albertel 3908: my ($udom,$unum,$file_name,$group,$access_hash) = @_;
3909:
3910: if (!ref($access_hash)) {
3911: my $current_perms = &get_portfile_permissions($udom,$unum);
3912: my %access_controls = &get_access_controls($current_perms,$group,
3913: $file_name);
3914: $access_hash = $access_controls{$file_name};
3915: }
3916:
1.765 albertel 3917: my ($public,$guest,@domains,@users,@courses,@groups);
3918: my $now = time;
3919: if (ref($access_hash) eq 'HASH') {
3920: foreach my $key (keys(%{$access_hash})) {
3921: my ($num,$scope,$end,$start) = ($key =~ /^([^:]+):([a-z]+)_(\d*)_?(\d*)$/);
3922: if ($start > $now) {
3923: next;
3924: }
3925: if ($end && $end<$now) {
3926: next;
3927: }
3928: if ($scope eq 'public') {
3929: $public = $key;
3930: last;
3931: } elsif ($scope eq 'guest') {
3932: $guest = $key;
3933: } elsif ($scope eq 'domains') {
3934: push(@domains,$key);
3935: } elsif ($scope eq 'users') {
3936: push(@users,$key);
3937: } elsif ($scope eq 'course') {
3938: push(@courses,$key);
3939: } elsif ($scope eq 'group') {
3940: push(@groups,$key);
3941: }
3942: }
3943: if ($public) {
3944: return 'ok';
3945: }
3946: if ($env{'user.name'} eq 'public' && $env{'user.domain'} eq 'public') {
3947: if ($guest) {
3948: return $guest;
3949: }
3950: } else {
3951: if (@domains > 0) {
3952: foreach my $domkey (@domains) {
3953: if (ref($access_hash->{$domkey}{'dom'}) eq 'ARRAY') {
3954: if (grep(/^\Q$env{'user.domain'}\E$/,@{$access_hash->{$domkey}{'dom'}})) {
3955: return 'ok';
3956: }
3957: }
3958: }
3959: }
3960: if (@users > 0) {
3961: foreach my $userkey (@users) {
1.865 raeburn 3962: if (ref($access_hash->{$userkey}{'users'}) eq 'ARRAY') {
3963: foreach my $item (@{$access_hash->{$userkey}{'users'}}) {
3964: if (ref($item) eq 'HASH') {
3965: if (($item->{'uname'} eq $env{'user.name'}) &&
3966: ($item->{'udom'} eq $env{'user.domain'})) {
3967: return 'ok';
3968: }
3969: }
3970: }
3971: }
1.765 albertel 3972: }
3973: }
3974: my %roleshash;
3975: my @courses_and_groups = @courses;
3976: push(@courses_and_groups,@groups);
3977: if (@courses_and_groups > 0) {
3978: my (%allgroups,%allroles);
3979: my ($start,$end,$role,$sec,$group);
3980: foreach my $envkey (%env) {
1.811 albertel 3981: if ($envkey =~ m-^user\.role\.(gr|cc|in|ta|ep|st)\./($match_domain)/($match_courseid)/?([^/]*)$-) {
1.765 albertel 3982: my $cid = $2.'_'.$3;
3983: if ($1 eq 'gr') {
3984: $group = $4;
3985: $allgroups{$cid}{$group} = $env{$envkey};
3986: } else {
3987: if ($4 eq '') {
3988: $sec = 'none';
3989: } else {
3990: $sec = $4;
3991: }
3992: $allroles{$cid}{$1}{$sec} = $env{$envkey};
3993: }
1.811 albertel 3994: } elsif ($envkey =~ m-^user\.role\./cr/($match_domain/$match_username/\w*)./($match_domain)/($match_courseid)/?([^/]*)$-) {
1.765 albertel 3995: my $cid = $2.'_'.$3;
3996: if ($4 eq '') {
3997: $sec = 'none';
3998: } else {
3999: $sec = $4;
4000: }
4001: $allroles{$cid}{$1}{$sec} = $env{$envkey};
4002: }
4003: }
4004: if (keys(%allroles) == 0) {
4005: return;
4006: }
4007: foreach my $key (@courses_and_groups) {
4008: my %content = %{$$access_hash{$key}};
4009: my $cnum = $content{'number'};
4010: my $cdom = $content{'domain'};
4011: my $cid = $cdom.'_'.$cnum;
4012: if (!exists($allroles{$cid})) {
4013: next;
4014: }
4015: foreach my $role_id (keys(%{$content{'roles'}})) {
4016: my @sections = @{$content{'roles'}{$role_id}{'section'}};
4017: my @groups = @{$content{'roles'}{$role_id}{'group'}};
4018: my @status = @{$content{'roles'}{$role_id}{'access'}};
4019: my @roles = @{$content{'roles'}{$role_id}{'role'}};
4020: foreach my $role (keys(%{$allroles{$cid}})) {
4021: if ((grep/^all$/,@roles) || (grep/^\Q$role\E$/,@roles)) {
4022: foreach my $sec (keys(%{$allroles{$cid}{$role}})) {
4023: if (&course_group_datechecker($allroles{$cid}{$role}{$sec},$now,\@status) eq 'ok') {
4024: if (grep/^all$/,@sections) {
4025: return 'ok';
4026: } else {
4027: if (grep/^$sec$/,@sections) {
4028: return 'ok';
4029: }
4030: }
4031: }
4032: }
4033: if (keys(%{$allgroups{$cid}}) == 0) {
4034: if (grep/^none$/,@groups) {
4035: return 'ok';
4036: }
4037: } else {
4038: if (grep/^all$/,@groups) {
4039: return 'ok';
4040: }
4041: foreach my $group (keys(%{$allgroups{$cid}})) {
4042: if (grep/^$group$/,@groups) {
4043: return 'ok';
4044: }
4045: }
4046: }
4047: }
4048: }
4049: }
4050: }
4051: }
4052: if ($guest) {
4053: return $guest;
4054: }
4055: }
4056: }
4057: return;
4058: }
4059:
4060: sub course_group_datechecker {
4061: my ($dates,$now,$status) = @_;
4062: my ($start,$end) = split(/\./,$dates);
4063: if (!$start && !$end) {
4064: return 'ok';
4065: }
4066: if (grep/^active$/,@{$status}) {
4067: if (((!$start) || ($start && $start <= $now)) && ((!$end) || ($end && $end >= $now))) {
4068: return 'ok';
4069: }
4070: }
4071: if (grep/^previous$/,@{$status}) {
4072: if ($end > $now ) {
4073: return 'ok';
4074: }
4075: }
4076: if (grep/^future$/,@{$status}) {
4077: if ($start > $now) {
4078: return 'ok';
4079: }
4080: }
4081: return;
4082: }
4083:
4084: sub parse_portfolio_url {
4085: my ($url) = @_;
4086:
4087: my ($type,$udom,$unum,$group,$file_name);
4088:
1.823 albertel 4089: if ($url =~ m-^/*(?:uploaded|editupload)/($match_domain)/($match_username)/portfolio(/.+)$-) {
1.765 albertel 4090: $type = 1;
4091: $udom = $1;
4092: $unum = $2;
4093: $file_name = $3;
1.823 albertel 4094: } elsif ($url =~ m-^/*(?:uploaded|editupload)/($match_domain)/($match_courseid)/groups/([^/]+)/portfolio/(.+)$-) {
1.765 albertel 4095: $type = 2;
4096: $udom = $1;
4097: $unum = $2;
4098: $group = $3;
4099: $file_name = $3.'/'.$4;
4100: }
4101: if (wantarray) {
4102: return ($type,$udom,$unum,$file_name,$group);
4103: }
4104: return $type;
4105: }
4106:
4107: sub is_portfolio_url {
4108: my ($url) = @_;
4109: return scalar(&parse_portfolio_url($url));
4110: }
4111:
1.798 raeburn 4112: sub is_portfolio_file {
4113: my ($file) = @_;
1.820 raeburn 4114: if (($file =~ /^portfolio/) || ($file =~ /^groups\/\w+\/portfolio/)) {
1.798 raeburn 4115: return 1;
4116: }
4117: return;
4118: }
4119:
4120:
1.341 www 4121: # ---------------------------------------------- Custom access rule evaluation
4122:
4123: sub customaccess {
4124: my ($priv,$uri)=@_;
1.807 albertel 4125: my ($urole,$urealm)=split(/\./,$env{'request.role'},2);
1.819 www 4126: my (undef,$udom,$ucrs,$usec)=split(/\//,$urealm);
1.807 albertel 4127: $udom = &LONCAPA::clean_domain($udom);
4128: $ucrs = &LONCAPA::clean_username($ucrs);
1.341 www 4129: my $access=0;
1.800 albertel 4130: foreach my $right (split(/\s*\,\s*/,&metadata($uri,'rule_rights'))) {
1.893 albertel 4131: my ($effect,$realm,$role,$type)=split(/\:/,$right);
4132: if ($type eq 'user') {
4133: foreach my $scope (split(/\s*\,\s*/,$realm)) {
1.896 albertel 4134: my ($tdom,$tuname)=split(m{/},$scope);
1.893 albertel 4135: if ($tdom) {
4136: if ($tdom ne $env{'user.domain'}) { next; }
4137: }
1.896 albertel 4138: if ($tuname) {
4139: if ($tuname ne $env{'user.name'}) { next; }
1.893 albertel 4140: }
4141: $access=($effect eq 'allow');
4142: last;
4143: }
4144: } else {
4145: if ($role) {
4146: if ($role ne $urole) { next; }
4147: }
4148: foreach my $scope (split(/\s*\,\s*/,$realm)) {
4149: my ($tdom,$tcrs,$tsec)=split(/\_/,$scope);
4150: if ($tdom) {
4151: if ($tdom ne $udom) { next; }
4152: }
4153: if ($tcrs) {
4154: if ($tcrs ne $ucrs) { next; }
4155: }
4156: if ($tsec) {
4157: if ($tsec ne $usec) { next; }
4158: }
4159: $access=($effect eq 'allow');
4160: last;
4161: }
4162: if ($realm eq '' && $role eq '') {
4163: $access=($effect eq 'allow');
4164: }
1.402 bowersj2 4165: }
1.341 www 4166: }
4167: return $access;
4168: }
4169:
1.103 harris41 4170: # ------------------------------------------------- Check for a user privilege
1.12 www 4171:
4172: sub allowed {
1.810 raeburn 4173: my ($priv,$uri,$symb,$role)=@_;
1.705 albertel 4174: my $ver_orguri=$uri;
1.439 www 4175: $uri=&deversion($uri);
1.152 www 4176: my $orguri=$uri;
1.52 www 4177: $uri=&declutter($uri);
1.809 raeburn 4178:
1.810 raeburn 4179: if ($priv eq 'evb') {
4180: # Evade communication block restrictions for specified role in a course
4181: if ($env{'user.priv.'.$role} =~/evb\&([^\:]*)/) {
4182: return $1;
4183: } else {
4184: return;
4185: }
4186: }
4187:
1.620 albertel 4188: if (defined($env{'allowed.'.$priv})) { return $env{'allowed.'.$priv}; }
1.54 www 4189: # Free bre access to adm and meta resources
1.775 albertel 4190: if (((($uri=~/^adm\//) && ($uri !~ m{/(?:smppg|bulletinboard)$}))
1.769 albertel 4191: || (($uri=~/\.meta$/) && ($uri!~m|^uploaded/|) ))
4192: && ($priv eq 'bre')) {
1.14 www 4193: return 'F';
1.159 www 4194: }
4195:
1.545 banghart 4196: # Free bre access to user's own portfolio contents
1.714 raeburn 4197: my ($space,$domain,$name,@dir)=split('/',$uri);
1.647 raeburn 4198: if (($space=~/^(uploaded|editupload)$/) && ($env{'user.name'} eq $name) &&
1.714 raeburn 4199: ($env{'user.domain'} eq $domain) && ('portfolio' eq $dir[0])) {
1.814 raeburn 4200: my %setters;
4201: my ($startblock,$endblock) =
4202: &Apache::loncommon::blockcheck(\%setters,'port');
4203: if ($startblock && $endblock) {
4204: return 'B';
4205: } else {
4206: return 'F';
4207: }
1.545 banghart 4208: }
4209:
1.762 raeburn 4210: # bre access to group portfolio for rgf priv in group, or mdg or vcg in course.
1.714 raeburn 4211: if (($space=~/^(uploaded|editupload)$/) && ($dir[0] eq 'groups')
4212: && ($dir[2] eq 'portfolio') && ($priv eq 'bre')) {
4213: if (exists($env{'request.course.id'})) {
4214: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
4215: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
4216: if (($domain eq $cdom) && ($name eq $cnum)) {
4217: my $courseprivid=$env{'request.course.id'};
4218: $courseprivid=~s/\_/\//;
4219: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid
4220: .'/'.$dir[1]} =~/rgf\&([^\:]*)/) {
4221: return $1;
1.762 raeburn 4222: } else {
4223: if ($env{'request.course.sec'}) {
4224: $courseprivid.='/'.$env{'request.course.sec'};
4225: }
4226: if ($env{'user.priv.'.$env{'request.role'}.'./'.
4227: $courseprivid} =~/(mdg|vcg)\&([^\:]*)/) {
4228: return $2;
4229: }
1.714 raeburn 4230: }
4231: }
4232: }
4233: }
4234:
1.159 www 4235: # Free bre to public access
4236:
4237: if ($priv eq 'bre') {
1.238 www 4238: my $copyright=&metadata($uri,'copyright');
1.620 albertel 4239: if (($copyright eq 'public') && (!$env{'request.course.id'})) {
1.301 www 4240: return 'F';
4241: }
1.238 www 4242: if ($copyright eq 'priv') {
4243: $uri=~/([^\/]+)\/([^\/]+)\//;
1.620 albertel 4244: unless (($env{'user.name'} eq $2) && ($env{'user.domain'} eq $1)) {
1.238 www 4245: return '';
4246: }
4247: }
4248: if ($copyright eq 'domain') {
4249: $uri=~/([^\/]+)\/([^\/]+)\//;
1.620 albertel 4250: unless (($env{'user.domain'} eq $1) ||
4251: ($env{'course.'.$env{'request.course.id'}.'.domain'} eq $1)) {
1.238 www 4252: return '';
4253: }
1.262 matthew 4254: }
1.620 albertel 4255: if ($env{'request.role'}=~ /li\.\//) {
1.262 matthew 4256: # Library role, so allow browsing of resources in this domain.
4257: return 'F';
1.238 www 4258: }
1.341 www 4259: if ($copyright eq 'custom') {
4260: unless (&customaccess($priv,$uri)) { return ''; }
4261: }
1.14 www 4262: }
1.264 matthew 4263: # Domain coordinator is trying to create a course
1.620 albertel 4264: if (($priv eq 'ccc') && ($env{'request.role'} =~ /^dc\./)) {
1.264 matthew 4265: # uri is the requested domain in this case.
4266: # comparison to 'request.role.domain' shows if the user has selected
1.678 raeburn 4267: # a role of dc for the domain in question.
1.620 albertel 4268: return 'F' if ($uri eq $env{'request.role.domain'});
1.264 matthew 4269: }
1.29 www 4270:
1.52 www 4271: my $thisallowed='';
4272: my $statecond=0;
4273: my $courseprivid='';
4274:
4275: # Course
4276:
1.620 albertel 4277: if ($env{'user.priv.'.$env{'request.role'}.'./'}=~/\Q$priv\E\&([^\:]*)/) {
1.52 www 4278: $thisallowed.=$1;
4279: }
1.29 www 4280:
1.52 www 4281: # Domain
4282:
1.620 albertel 4283: if ($env{'user.priv.'.$env{'request.role'}.'./'.(split(/\//,$uri))[0].'/'}
1.479 albertel 4284: =~/\Q$priv\E\&([^\:]*)/) {
1.12 www 4285: $thisallowed.=$1;
4286: }
1.52 www 4287:
4288: # Course: uri itself is a course
1.66 www 4289: my $courseuri=$uri;
4290: $courseuri=~s/\_(\d)/\/$1/;
1.83 www 4291: $courseuri=~s/^([^\/])/\/$1/;
1.81 www 4292:
1.620 albertel 4293: if ($env{'user.priv.'.$env{'request.role'}.'.'.$courseuri}
1.479 albertel 4294: =~/\Q$priv\E\&([^\:]*)/) {
1.12 www 4295: $thisallowed.=$1;
4296: }
1.29 www 4297:
1.665 albertel 4298: # URI is an uploaded document for this course, default permissions don't matter
1.611 albertel 4299: # not allowing 'edit' access (editupload) to uploaded course docs
1.492 albertel 4300: if (($priv eq 'bre') && ($uri=~m|^uploaded/|)) {
1.665 albertel 4301: $thisallowed='';
1.671 raeburn 4302: my ($match)=&is_on_map($uri);
4303: if ($match) {
4304: if ($env{'user.priv.'.$env{'request.role'}.'./'}
4305: =~/\Q$priv\E\&([^\:]*)/) {
4306: $thisallowed.=$1;
4307: }
4308: } else {
1.705 albertel 4309: my $refuri = $env{'httpref.'.$orguri} || $env{'httpref.'.$ver_orguri};
1.671 raeburn 4310: if ($refuri) {
4311: if ($refuri =~ m|^/adm/|) {
1.669 raeburn 4312: $thisallowed='F';
1.671 raeburn 4313: } else {
4314: $refuri=&declutter($refuri);
4315: my ($match) = &is_on_map($refuri);
4316: if ($match) {
4317: $thisallowed='F';
4318: }
1.669 raeburn 4319: }
1.671 raeburn 4320: }
4321: }
1.314 www 4322: }
1.492 albertel 4323:
1.766 albertel 4324: if ($priv eq 'bre'
4325: && $thisallowed ne 'F'
4326: && $thisallowed ne '2'
4327: && &is_portfolio_url($uri)) {
4328: $thisallowed = &portfolio_access($uri);
4329: }
4330:
1.52 www 4331: # Full access at system, domain or course-wide level? Exit.
1.29 www 4332:
4333: if ($thisallowed=~/F/) {
4334: return 'F';
4335: }
4336:
1.52 www 4337: # If this is generating or modifying users, exit with special codes
1.29 www 4338:
1.643 www 4339: if (':csu:cdc:ccc:cin:cta:cep:ccr:cst:cad:cli:cau:cdg:cca:caa:'=~/\:\Q$priv\E\:/) {
4340: if (($priv eq 'cca') || ($priv eq 'caa')) {
1.642 albertel 4341: my ($audom,$auname)=split('/',$uri);
1.643 www 4342: # no author name given, so this just checks on the general right to make a co-author in this domain
4343: unless ($auname) { return $thisallowed; }
4344: # an author name is given, so we are about to actually make a co-author for a certain account
1.642 albertel 4345: if (($auname ne $env{'user.name'} && $env{'request.role'} !~ /^dc\./) ||
4346: (($audom ne $env{'user.domain'} && $env{'request.role'} !~ /^dc\./) &&
4347: ($audom ne $env{'request.role.domain'}))) { return ''; }
4348: }
1.52 www 4349: return $thisallowed;
4350: }
4351: #
1.103 harris41 4352: # Gathered so far: system, domain and course wide privileges
1.52 www 4353: #
4354: # Course: See if uri or referer is an individual resource that is part of
4355: # the course
4356:
1.620 albertel 4357: if ($env{'request.course.id'}) {
1.232 www 4358:
1.620 albertel 4359: $courseprivid=$env{'request.course.id'};
4360: if ($env{'request.course.sec'}) {
4361: $courseprivid.='/'.$env{'request.course.sec'};
1.52 www 4362: }
4363: $courseprivid=~s/\_/\//;
4364: my $checkreferer=1;
1.232 www 4365: my ($match,$cond)=&is_on_map($uri);
4366: if ($match) {
4367: $statecond=$cond;
1.620 albertel 4368: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid}
1.479 albertel 4369: =~/\Q$priv\E\&([^\:]*)/) {
1.52 www 4370: $thisallowed.=$1;
4371: $checkreferer=0;
4372: }
1.29 www 4373: }
1.83 www 4374:
1.148 www 4375: if ($checkreferer) {
1.620 albertel 4376: my $refuri=$env{'httpref.'.$orguri};
1.148 www 4377: unless ($refuri) {
1.800 albertel 4378: foreach my $key (keys(%env)) {
4379: if ($key=~/^httpref\..*\*/) {
4380: my $pattern=$key;
1.156 www 4381: $pattern=~s/^httpref\.\/res\///;
1.148 www 4382: $pattern=~s/\*/\[\^\/\]\+/g;
4383: $pattern=~s/\//\\\//g;
1.152 www 4384: if ($orguri=~/$pattern/) {
1.800 albertel 4385: $refuri=$env{$key};
1.148 www 4386: }
4387: }
1.191 harris41 4388: }
1.148 www 4389: }
1.232 www 4390:
1.148 www 4391: if ($refuri) {
1.152 www 4392: $refuri=&declutter($refuri);
1.232 www 4393: my ($match,$cond)=&is_on_map($refuri);
4394: if ($match) {
4395: my $refstatecond=$cond;
1.620 albertel 4396: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid}
1.479 albertel 4397: =~/\Q$priv\E\&([^\:]*)/) {
1.52 www 4398: $thisallowed.=$1;
1.53 www 4399: $uri=$refuri;
4400: $statecond=$refstatecond;
1.52 www 4401: }
4402: }
1.148 www 4403: }
1.29 www 4404: }
1.52 www 4405: }
1.29 www 4406:
1.52 www 4407: #
1.103 harris41 4408: # Gathered now: all privileges that could apply, and condition number
1.52 www 4409: #
4410: #
4411: # Full or no access?
4412: #
1.29 www 4413:
1.52 www 4414: if ($thisallowed=~/F/) {
4415: return 'F';
4416: }
1.29 www 4417:
1.52 www 4418: unless ($thisallowed) {
4419: return '';
4420: }
1.29 www 4421:
1.52 www 4422: # Restrictions exist, deal with them
4423: #
4424: # C:according to course preferences
4425: # R:according to resource settings
4426: # L:unless locked
4427: # X:according to user session state
4428: #
4429:
4430: # Possibly locked functionality, check all courses
1.54 www 4431: # Locks might take effect only after 10 minutes cache expiration for other
4432: # courses, and 2 minutes for current course
1.52 www 4433:
4434: my $envkey;
4435: if ($thisallowed=~/L/) {
1.620 albertel 4436: foreach $envkey (keys %env) {
1.54 www 4437: if ($envkey=~/^user\.role\.(st|ta)\.([^\.]*)/) {
4438: my $courseid=$2;
4439: my $roleid=$1.'.'.$2;
1.92 www 4440: $courseid=~s/^\///;
1.54 www 4441: my $expiretime=600;
1.620 albertel 4442: if ($env{'request.role'} eq $roleid) {
1.54 www 4443: $expiretime=120;
4444: }
4445: my ($cdom,$cnum,$csec)=split(/\//,$courseid);
4446: my $prefix='course.'.$cdom.'_'.$cnum.'.';
1.620 albertel 4447: if ((time-$env{$prefix.'last_cache'})>$expiretime) {
1.731 albertel 4448: &coursedescription($courseid,{'freshen_cache' => 1});
1.54 www 4449: }
1.620 albertel 4450: if (($env{$prefix.'res.'.$uri.'.lock.sections'}=~/\,\Q$csec\E\,/)
4451: || ($env{$prefix.'res.'.$uri.'.lock.sections'} eq 'all')) {
4452: if ($env{$prefix.'res.'.$uri.'.lock.expire'}>time) {
4453: &log($env{'user.domain'},$env{'user.name'},
4454: $env{'user.home'},
1.57 www 4455: 'Locked by res: '.$priv.' for '.$uri.' due to '.
1.52 www 4456: $cdom.'/'.$cnum.'/'.$csec.' expire '.
1.620 albertel 4457: $env{$prefix.'priv.'.$priv.'.lock.expire'});
1.52 www 4458: return '';
4459: }
4460: }
1.620 albertel 4461: if (($env{$prefix.'priv.'.$priv.'.lock.sections'}=~/\,\Q$csec\E\,/)
4462: || ($env{$prefix.'priv.'.$priv.'.lock.sections'} eq 'all')) {
4463: if ($env{'priv.'.$priv.'.lock.expire'}>time) {
4464: &log($env{'user.domain'},$env{'user.name'},
4465: $env{'user.home'},
1.57 www 4466: 'Locked by priv: '.$priv.' for '.$uri.' due to '.
1.52 www 4467: $cdom.'/'.$cnum.'/'.$csec.' expire '.
1.620 albertel 4468: $env{$prefix.'priv.'.$priv.'.lock.expire'});
1.52 www 4469: return '';
4470: }
4471: }
4472: }
1.29 www 4473: }
1.52 www 4474: }
4475:
4476: #
4477: # Rest of the restrictions depend on selected course
4478: #
4479:
1.620 albertel 4480: unless ($env{'request.course.id'}) {
1.766 albertel 4481: if ($thisallowed eq 'A') {
4482: return 'A';
1.814 raeburn 4483: } elsif ($thisallowed eq 'B') {
4484: return 'B';
1.766 albertel 4485: } else {
4486: return '1';
4487: }
1.52 www 4488: }
1.29 www 4489:
1.52 www 4490: #
4491: # Now user is definitely in a course
4492: #
1.53 www 4493:
4494:
4495: # Course preferences
4496:
4497: if ($thisallowed=~/C/) {
1.620 albertel 4498: my $rolecode=(split(/\./,$env{'request.role'}))[0];
4499: my $unamedom=$env{'user.name'}.':'.$env{'user.domain'};
4500: if ($env{'course.'.$env{'request.course.id'}.'.'.$priv.'.roles.denied'}
1.479 albertel 4501: =~/\Q$rolecode\E/) {
1.689 albertel 4502: if ($priv ne 'pch') {
4503: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.':'.
4504: 'Denied by role: '.$priv.' for '.$uri.' as '.$rolecode.' in '.
4505: $env{'request.course.id'});
4506: }
1.237 www 4507: return '';
4508: }
4509:
1.620 albertel 4510: if ($env{'course.'.$env{'request.course.id'}.'.'.$priv.'.users.denied'}
1.479 albertel 4511: =~/\Q$unamedom\E/) {
1.689 albertel 4512: if ($priv ne 'pch') {
4513: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.
4514: 'Denied by user: '.$priv.' for '.$uri.' as '.$unamedom.' in '.
4515: $env{'request.course.id'});
4516: }
1.54 www 4517: return '';
4518: }
1.53 www 4519: }
4520:
4521: # Resource preferences
4522:
4523: if ($thisallowed=~/R/) {
1.620 albertel 4524: my $rolecode=(split(/\./,$env{'request.role'}))[0];
1.479 albertel 4525: if (&metadata($uri,'roledeny')=~/\Q$rolecode\E/) {
1.689 albertel 4526: if ($priv ne 'pch') {
4527: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.':'.
4528: 'Denied by role: '.$priv.' for '.$uri.' as '.$rolecode);
4529: }
4530: return '';
1.54 www 4531: }
1.53 www 4532: }
1.30 www 4533:
1.246 www 4534: # Restricted by state or randomout?
1.30 www 4535:
1.52 www 4536: if ($thisallowed=~/X/) {
1.620 albertel 4537: if ($env{'acc.randomout'}) {
1.579 albertel 4538: if (!$symb) { $symb=&symbread($uri,1); }
1.620 albertel 4539: if (($symb) && ($env{'acc.randomout'}=~/\&\Q$symb\E\&/)) {
1.248 www 4540: return '';
4541: }
1.247 www 4542: }
4543: if (&condval($statecond)) {
1.52 www 4544: return '2';
4545: } else {
4546: return '';
4547: }
4548: }
1.30 www 4549:
1.766 albertel 4550: if ($thisallowed eq 'A') {
4551: return 'A';
1.814 raeburn 4552: } elsif ($thisallowed eq 'B') {
4553: return 'B';
1.766 albertel 4554: }
1.52 www 4555: return 'F';
1.232 www 4556: }
4557:
1.710 albertel 4558: sub split_uri_for_cond {
4559: my $uri=&deversion(&declutter(shift));
4560: my @uriparts=split(/\//,$uri);
4561: my $filename=pop(@uriparts);
4562: my $pathname=join('/',@uriparts);
4563: return ($pathname,$filename);
4564: }
1.232 www 4565: # --------------------------------------------------- Is a resource on the map?
4566:
4567: sub is_on_map {
1.710 albertel 4568: my ($pathname,$filename) = &split_uri_for_cond(shift);
1.289 bowersj2 4569: #Trying to find the conditional for the file
1.620 albertel 4570: my $match=($env{'acc.res.'.$env{'request.course.id'}.'.'.$pathname}=~
1.289 bowersj2 4571: /\&\Q$filename\E\:([\d\|]+)\&/);
1.232 www 4572: if ($match) {
1.289 bowersj2 4573: return (1,$1);
4574: } else {
1.434 www 4575: return (0,0);
1.289 bowersj2 4576: }
1.12 www 4577: }
4578:
1.427 www 4579: # --------------------------------------------------------- Get symb from alias
4580:
4581: sub get_symb_from_alias {
4582: my $symb=shift;
4583: my ($map,$resid,$url)=&decode_symb($symb);
4584: # Already is a symb
4585: if ($url) { return $symb; }
4586: # Must be an alias
4587: my $aliassymb='';
4588: my %bighash;
1.620 albertel 4589: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
1.427 www 4590: &GDBM_READER(),0640)) {
4591: my $rid=$bighash{'mapalias_'.$symb};
4592: if ($rid) {
4593: my ($mapid,$resid)=split(/\./,$rid);
1.429 albertel 4594: $aliassymb=&encode_symb($bighash{'map_id_'.$mapid},
4595: $resid,$bighash{'src_'.$rid});
1.427 www 4596: }
4597: untie %bighash;
4598: }
4599: return $aliassymb;
4600: }
4601:
1.12 www 4602: # ----------------------------------------------------------------- Define Role
4603:
4604: sub definerole {
4605: if (allowed('mcr','/')) {
4606: my ($rolename,$sysrole,$domrole,$courole)=@_;
1.800 albertel 4607: foreach my $role (split(':',$sysrole)) {
4608: my ($crole,$cqual)=split(/\&/,$role);
1.479 albertel 4609: if ($pr{'cr:s'}!~/\Q$crole\E/) { return "refused:s:$crole"; }
4610: if ($pr{'cr:s'}=~/\Q$crole\E\&/) {
4611: if ($pr{'cr:s'}!~/\Q$crole\E\&\w*\Q$cqual\E/) {
1.21 www 4612: return "refused:s:$crole&$cqual";
4613: }
4614: }
1.191 harris41 4615: }
1.800 albertel 4616: foreach my $role (split(':',$domrole)) {
4617: my ($crole,$cqual)=split(/\&/,$role);
1.479 albertel 4618: if ($pr{'cr:d'}!~/\Q$crole\E/) { return "refused:d:$crole"; }
4619: if ($pr{'cr:d'}=~/\Q$crole\E\&/) {
4620: if ($pr{'cr:d'}!~/\Q$crole\W\&\w*\Q$cqual\E/) {
1.21 www 4621: return "refused:d:$crole&$cqual";
4622: }
4623: }
1.191 harris41 4624: }
1.800 albertel 4625: foreach my $role (split(':',$courole)) {
4626: my ($crole,$cqual)=split(/\&/,$role);
1.479 albertel 4627: if ($pr{'cr:c'}!~/\Q$crole\E/) { return "refused:c:$crole"; }
4628: if ($pr{'cr:c'}=~/\Q$crole\E\&/) {
4629: if ($pr{'cr:c'}!~/\Q$crole\E\&\w*\Q$cqual\E/) {
1.21 www 4630: return "refused:c:$crole&$cqual";
4631: }
4632: }
1.191 harris41 4633: }
1.620 albertel 4634: my $command="encrypt:rolesput:$env{'user.domain'}:$env{'user.name'}:".
4635: "$env{'user.domain'}:$env{'user.name'}:".
1.21 www 4636: "rolesdef_$rolename=".
4637: escape($sysrole.'_'.$domrole.'_'.$courole);
1.620 albertel 4638: return reply($command,$env{'user.home'});
1.12 www 4639: } else {
4640: return 'refused';
4641: }
1.105 harris41 4642: }
4643:
4644: # ---------------- Make a metadata query against the network of library servers
4645:
4646: sub metadata_query {
1.244 matthew 4647: my ($query,$custom,$customshow,$server_array)=@_;
1.120 harris41 4648: my %rhash;
1.845 albertel 4649: my %libserv = &all_library();
1.244 matthew 4650: my @server_list = (defined($server_array) ? @$server_array
4651: : keys(%libserv) );
4652: for my $server (@server_list) {
1.118 harris41 4653: unless ($custom or $customshow) {
4654: my $reply=&reply("querysend:".&escape($query),$server);
4655: $rhash{$server}=$reply;
4656: }
4657: else {
4658: my $reply=&reply("querysend:".&escape($query).':'.
4659: &escape($custom).':'.&escape($customshow),
4660: $server);
4661: $rhash{$server}=$reply;
4662: }
1.112 harris41 4663: }
1.118 harris41 4664: return \%rhash;
1.240 www 4665: }
4666:
4667: # ----------------------------------------- Send log queries and wait for reply
4668:
4669: sub log_query {
4670: my ($uname,$udom,$query,%filters)=@_;
4671: my $uhome=&homeserver($uname,$udom);
4672: if ($uhome eq 'no_host') { return 'error: no_host'; }
1.838 albertel 4673: my $uhost=&hostname($uhome);
1.800 albertel 4674: my $command=&escape(join(':',map{$_.'='.$filters{$_}} keys(%filters)));
1.240 www 4675: my $queryid=&reply("querysend:".$query.':'.$udom.':'.$uname.':'.$command,
4676: $uhome);
1.479 albertel 4677: unless ($queryid=~/^\Q$uhost\E\_/) { return 'error: '.$queryid; }
1.242 www 4678: return get_query_reply($queryid);
4679: }
4680:
1.818 raeburn 4681: # -------------------------- Update MySQL table for portfolio file
4682:
4683: sub update_portfolio_table {
1.821 raeburn 4684: my ($uname,$udom,$file_name,$query,$group,$action) = @_;
1.818 raeburn 4685: my $homeserver = &homeserver($uname,$udom);
4686: my $queryid=
1.821 raeburn 4687: &reply("querysend:".$query.':'.&escape($uname.':'.$udom.':'.$group).
4688: ':'.&escape($file_name).':'.$action,$homeserver);
1.818 raeburn 4689: my $reply = &get_query_reply($queryid);
4690: return $reply;
4691: }
4692:
1.899 raeburn 4693: # -------------------------- Update MySQL allusers table
4694:
4695: sub update_allusers_table {
4696: my ($uname,$udom,$names) = @_;
4697: my $homeserver = &homeserver($uname,$udom);
4698: my $queryid=
4699: &reply('querysend:allusers:'.&escape($uname).':'.&escape($udom).':'.
4700: 'lastname='.&escape($names->{'lastname'}).'%%'.
4701: 'firstname='.&escape($names->{'firstname'}).'%%'.
4702: 'middlename='.&escape($names->{'middlename'}).'%%'.
4703: 'generation='.&escape($names->{'generation'}).'%%'.
4704: 'permanentemail='.&escape($names->{'permanentemail'}).'%%'.
4705: 'id='.&escape($names->{'id'}),$homeserver);
4706: my $reply = &get_query_reply($queryid);
4707: return $reply;
4708: }
4709:
1.508 raeburn 4710: # ------- Request retrieval of institutional classlists for course(s)
1.506 raeburn 4711:
4712: sub fetch_enrollment_query {
1.511 raeburn 4713: my ($context,$affiliatesref,$replyref,$dom,$cnum) = @_;
1.508 raeburn 4714: my $homeserver;
1.547 raeburn 4715: my $maxtries = 1;
1.508 raeburn 4716: if ($context eq 'automated') {
4717: $homeserver = $perlvar{'lonHostID'};
1.547 raeburn 4718: $maxtries = 10; # will wait for up to 2000s for retrieval of classlist data before timeout
1.508 raeburn 4719: } else {
4720: $homeserver = &homeserver($cnum,$dom);
4721: }
1.838 albertel 4722: my $host=&hostname($homeserver);
1.506 raeburn 4723: my $cmd = '';
1.800 albertel 4724: foreach my $affiliate (keys %{$affiliatesref}) {
4725: $cmd .= $affiliate.'='.join(",",@{$$affiliatesref{$affiliate}}).'%%';
1.506 raeburn 4726: }
4727: $cmd =~ s/%%$//;
4728: $cmd = &escape($cmd);
4729: my $query = 'fetchenrollment';
1.620 albertel 4730: my $queryid=&reply("querysend:".$query.':'.$dom.':'.$env{'user.name'}.':'.$cmd,$homeserver);
1.526 raeburn 4731: unless ($queryid=~/^\Q$host\E\_/) {
4732: &logthis('fetch_enrollment_query: invalid queryid: '.$queryid.' for host: '.$host.' and homeserver: '.$homeserver.' context: '.$context.' '.$cnum);
4733: return 'error: '.$queryid;
4734: }
1.506 raeburn 4735: my $reply = &get_query_reply($queryid);
1.547 raeburn 4736: my $tries = 1;
4737: while (($reply=~/^timeout/) && ($tries < $maxtries)) {
4738: $reply = &get_query_reply($queryid);
4739: $tries ++;
4740: }
1.526 raeburn 4741: if ( ($reply =~/^timeout/) || ($reply =~/^error/) ) {
1.620 albertel 4742: &logthis('fetch_enrollment_query error: '.$reply.' for '.$dom.' '.$env{'user.name'}.' for '.$queryid.' context: '.$context.' '.$cnum.' maxtries: '.$maxtries.' tries: '.$tries);
1.526 raeburn 4743: } else {
1.901 albertel 4744: my @responses = split(/:/,$reply);
1.515 raeburn 4745: if ($homeserver eq $perlvar{'lonHostID'}) {
1.800 albertel 4746: foreach my $line (@responses) {
4747: my ($key,$value) = split(/=/,$line,2);
1.515 raeburn 4748: $$replyref{$key} = $value;
4749: }
4750: } else {
1.506 raeburn 4751: my $pathname = $perlvar{'lonDaemons'}.'/tmp';
1.800 albertel 4752: foreach my $line (@responses) {
4753: my ($key,$value) = split(/=/,$line);
1.506 raeburn 4754: $$replyref{$key} = $value;
4755: if ($value > 0) {
1.800 albertel 4756: foreach my $item (@{$$affiliatesref{$key}}) {
4757: my $filename = $dom.'_'.$key.'_'.$item.'_classlist.xml';
1.506 raeburn 4758: my $destname = $pathname.'/'.$filename;
4759: my $xml_classlist = &reply("autoretrieve:".$filename,$homeserver);
1.526 raeburn 4760: if ($xml_classlist =~ /^error/) {
4761: &logthis('fetch_enrollment_query - autoretrieve error: '.$xml_classlist.' for '.$filename.' from server: '.$homeserver.' '.$context.' '.$cnum);
4762: } else {
1.506 raeburn 4763: if ( open(FILE,">$destname") ) {
4764: print FILE &unescape($xml_classlist);
4765: close(FILE);
1.526 raeburn 4766: } else {
4767: &logthis('fetch_enrollment_query - error opening classlist file '.$destname.' '.$context.' '.$cnum);
1.506 raeburn 4768: }
4769: }
4770: }
4771: }
4772: }
4773: }
4774: return 'ok';
4775: }
4776: return 'error';
4777: }
4778:
1.242 www 4779: sub get_query_reply {
4780: my $queryid=shift;
1.240 www 4781: my $replyfile=$perlvar{'lonDaemons'}.'/tmp/'.$queryid;
4782: my $reply='';
4783: for (1..100) {
4784: sleep 2;
4785: if (-e $replyfile.'.end') {
1.448 albertel 4786: if (open(my $fh,$replyfile)) {
1.904 albertel 4787: $reply = join('',<$fh>);
4788: close($fh);
1.240 www 4789: } else { return 'error: reply_file_error'; }
1.242 www 4790: return &unescape($reply);
4791: }
1.240 www 4792: }
1.242 www 4793: return 'timeout:'.$queryid;
1.240 www 4794: }
4795:
4796: sub courselog_query {
1.241 www 4797: #
4798: # possible filters:
4799: # url: url or symb
4800: # username
4801: # domain
4802: # action: view, submit, grade
4803: # start: timestamp
4804: # end: timestamp
4805: #
1.240 www 4806: my (%filters)=@_;
1.620 albertel 4807: unless ($env{'request.course.id'}) { return 'no_course'; }
1.241 www 4808: if ($filters{'url'}) {
4809: $filters{'url'}=&symbclean(&declutter($filters{'url'}));
4810: $filters{'url'}=~s/\.(\w+)$/(\\.\\d+)*\\.$1/;
4811: $filters{'url'}=~s/\.(\w+)\_\_\_/(\\.\\d+)*\\.$1/;
4812: }
1.620 albertel 4813: my $cname=$env{'course.'.$env{'request.course.id'}.'.num'};
4814: my $cdom=$env{'course.'.$env{'request.course.id'}.'.domain'};
1.240 www 4815: return &log_query($cname,$cdom,'courselog',%filters);
4816: }
4817:
4818: sub userlog_query {
1.858 raeburn 4819: #
4820: # possible filters:
4821: # action: log check role
4822: # start: timestamp
4823: # end: timestamp
4824: #
1.240 www 4825: my ($uname,$udom,%filters)=@_;
4826: return &log_query($uname,$udom,'userlog',%filters);
1.12 www 4827: }
4828:
1.506 raeburn 4829: #--------- Call auto-enrollment subs in localenroll.pm for homeserver for course
4830:
4831: sub auto_run {
1.508 raeburn 4832: my ($cnum,$cdom) = @_;
1.876 raeburn 4833: my $response = 0;
4834: my $settings;
4835: my %domconfig = &get_dom('configuration',['autoenroll'],$cdom);
4836: if (ref($domconfig{'autoenroll'}) eq 'HASH') {
4837: $settings = $domconfig{'autoenroll'};
4838: if ($settings->{'run'} eq '1') {
4839: $response = 1;
4840: }
4841: } else {
4842: my $homeserver = &homeserver($cnum,$cdom);
4843: $response = &reply('autorun:'.$cdom,$homeserver);
4844: }
1.506 raeburn 4845: return $response;
4846: }
1.776 albertel 4847:
1.506 raeburn 4848: sub auto_get_sections {
1.508 raeburn 4849: my ($cnum,$cdom,$inst_coursecode) = @_;
4850: my $homeserver = &homeserver($cnum,$cdom);
1.506 raeburn 4851: my @secs = ();
1.511 raeburn 4852: my $response=&unescape(&reply('autogetsections:'.$inst_coursecode.':'.$cdom,$homeserver));
1.506 raeburn 4853: unless ($response eq 'refused') {
1.901 albertel 4854: @secs = split(/:/,$response);
1.506 raeburn 4855: }
4856: return @secs;
4857: }
1.776 albertel 4858:
1.506 raeburn 4859: sub auto_new_course {
1.508 raeburn 4860: my ($cnum,$cdom,$inst_course_id,$owner) = @_;
4861: my $homeserver = &homeserver($cnum,$cdom);
1.515 raeburn 4862: my $response=&unescape(&reply('autonewcourse:'.$inst_course_id.':'.$owner.':'.$cdom,$homeserver));
1.506 raeburn 4863: return $response;
4864: }
1.776 albertel 4865:
1.506 raeburn 4866: sub auto_validate_courseID {
1.508 raeburn 4867: my ($cnum,$cdom,$inst_course_id) = @_;
4868: my $homeserver = &homeserver($cnum,$cdom);
1.511 raeburn 4869: my $response=&unescape(&reply('autovalidatecourse:'.$inst_course_id.':'.$cdom,$homeserver));
1.506 raeburn 4870: return $response;
4871: }
1.776 albertel 4872:
1.506 raeburn 4873: sub auto_create_password {
1.873 raeburn 4874: my ($cnum,$cdom,$authparam,$udom) = @_;
4875: my ($homeserver,$response);
1.506 raeburn 4876: my $create_passwd = 0;
4877: my $authchk = '';
1.873 raeburn 4878: if ($udom =~ /^$match_domain$/) {
4879: $homeserver = &domain($udom,'primary');
4880: }
4881: if ($homeserver eq '') {
4882: if (($cdom =~ /^$match_domain$/) && ($cnum =~ /^$match_courseid$/)) {
4883: $homeserver = &homeserver($cnum,$cdom);
4884: }
4885: }
4886: if ($homeserver eq '') {
4887: $authchk = 'nodomain';
1.506 raeburn 4888: } else {
1.873 raeburn 4889: $response=&unescape(&reply('autocreatepassword:'.$authparam.':'.$cdom,$homeserver));
4890: if ($response eq 'refused') {
4891: $authchk = 'refused';
4892: } else {
1.901 albertel 4893: ($authparam,$create_passwd,$authchk) = split(/:/,$response);
1.873 raeburn 4894: }
1.506 raeburn 4895: }
4896: return ($authparam,$create_passwd,$authchk);
4897: }
4898:
1.706 raeburn 4899: sub auto_photo_permission {
4900: my ($cnum,$cdom,$students) = @_;
4901: my $homeserver = &homeserver($cnum,$cdom);
1.707 albertel 4902: my ($outcome,$perm_reqd,$conditions) =
4903: split(/:/,&unescape(&reply('autophotopermission:'.$cdom,$homeserver)),3);
1.709 albertel 4904: if ($outcome =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
4905: return (undef,undef);
4906: }
1.706 raeburn 4907: return ($outcome,$perm_reqd,$conditions);
4908: }
4909:
4910: sub auto_checkphotos {
4911: my ($uname,$udom,$pid) = @_;
4912: my $homeserver = &homeserver($uname,$udom);
4913: my ($result,$resulttype);
4914: my $outcome = &unescape(&reply('autophotocheck:'.&escape($udom).':'.
1.707 albertel 4915: &escape($uname).':'.&escape($pid),
4916: $homeserver));
1.709 albertel 4917: if ($outcome =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
4918: return (undef,undef);
4919: }
1.706 raeburn 4920: if ($outcome) {
4921: ($result,$resulttype) = split(/:/,$outcome);
4922: }
4923: return ($result,$resulttype);
4924: }
4925:
4926: sub auto_photochoice {
4927: my ($cnum,$cdom) = @_;
4928: my $homeserver = &homeserver($cnum,$cdom);
4929: my ($update,$comment) = split(/:/,&unescape(&reply('autophotochoice:'.
1.707 albertel 4930: &escape($cdom),
4931: $homeserver)));
1.709 albertel 4932: if ($update =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
4933: return (undef,undef);
4934: }
1.706 raeburn 4935: return ($update,$comment);
4936: }
4937:
4938: sub auto_photoupdate {
4939: my ($affiliatesref,$dom,$cnum,$photo) = @_;
4940: my $homeserver = &homeserver($cnum,$dom);
1.838 albertel 4941: my $host=&hostname($homeserver);
1.706 raeburn 4942: my $cmd = '';
4943: my $maxtries = 1;
1.800 albertel 4944: foreach my $affiliate (keys(%{$affiliatesref})) {
4945: $cmd .= $affiliate.'='.join(",",@{$$affiliatesref{$affiliate}}).'%%';
1.706 raeburn 4946: }
4947: $cmd =~ s/%%$//;
4948: $cmd = &escape($cmd);
4949: my $query = 'institutionalphotos';
4950: my $queryid=&reply("querysend:".$query.':'.$dom.':'.$cnum.':'.$cmd,$homeserver);
4951: unless ($queryid=~/^\Q$host\E\_/) {
4952: &logthis('institutionalphotos: invalid queryid: '.$queryid.' for host: '.$host.' and homeserver: '.$homeserver.' and course: '.$cnum);
4953: return 'error: '.$queryid;
4954: }
4955: my $reply = &get_query_reply($queryid);
4956: my $tries = 1;
4957: while (($reply=~/^timeout/) && ($tries < $maxtries)) {
4958: $reply = &get_query_reply($queryid);
4959: $tries ++;
4960: }
4961: if ( ($reply =~/^timeout/) || ($reply =~/^error/) ) {
4962: &logthis('institutionalphotos error: '.$reply.' for '.$dom.' '.$env{'user.name'}.' for '.$queryid.' course: '.$cnum.' maxtries: '.$maxtries.' tries: '.$tries);
4963: } else {
4964: my @responses = split(/:/,$reply);
4965: my $outcome = shift(@responses);
4966: foreach my $item (@responses) {
4967: my ($key,$value) = split(/=/,$item);
4968: $$photo{$key} = $value;
4969: }
4970: return $outcome;
4971: }
4972: return 'error';
4973: }
4974:
1.521 raeburn 4975: sub auto_instcode_format {
1.793 albertel 4976: my ($caller,$codedom,$instcodes,$codes,$codetitles,$cat_titles,
4977: $cat_order) = @_;
1.521 raeburn 4978: my $courses = '';
1.772 raeburn 4979: my @homeservers;
1.521 raeburn 4980: if ($caller eq 'global') {
1.841 albertel 4981: my %servers = &get_servers($codedom,'library');
4982: foreach my $tryserver (keys(%servers)) {
4983: if (!grep(/^\Q$tryserver\E$/,@homeservers)) {
4984: push(@homeservers,$tryserver);
4985: }
1.584 raeburn 4986: }
1.521 raeburn 4987: } else {
1.772 raeburn 4988: push(@homeservers,&homeserver($caller,$codedom));
1.521 raeburn 4989: }
1.793 albertel 4990: foreach my $code (keys(%{$instcodes})) {
4991: $courses .= &escape($code).'='.&escape($$instcodes{$code}).'&';
1.521 raeburn 4992: }
4993: chop($courses);
1.772 raeburn 4994: my $ok_response = 0;
4995: my $response;
4996: while (@homeservers > 0 && $ok_response == 0) {
4997: my $server = shift(@homeservers);
4998: $response=&reply('autoinstcodeformat:'.$codedom.':'.$courses,$server);
4999: if ($response !~ /(con_lost|error|no_such_host|refused)/) {
5000: my ($codes_str,$codetitles_str,$cat_titles_str,$cat_order_str) =
1.901 albertel 5001: split(/:/,$response);
1.772 raeburn 5002: %{$codes} = (%{$codes},&str2hash($codes_str));
5003: push(@{$codetitles},&str2array($codetitles_str));
5004: %{$cat_titles} = (%{$cat_titles},&str2hash($cat_titles_str));
5005: %{$cat_order} = (%{$cat_order},&str2hash($cat_order_str));
5006: $ok_response = 1;
5007: }
5008: }
5009: if ($ok_response) {
1.521 raeburn 5010: return 'ok';
1.772 raeburn 5011: } else {
5012: return $response;
1.521 raeburn 5013: }
5014: }
5015:
1.792 raeburn 5016: sub auto_instcode_defaults {
5017: my ($domain,$returnhash,$code_order) = @_;
5018: my @homeservers;
1.841 albertel 5019:
5020: my %servers = &get_servers($domain,'library');
5021: foreach my $tryserver (keys(%servers)) {
5022: if (!grep(/^\Q$tryserver\E$/,@homeservers)) {
5023: push(@homeservers,$tryserver);
5024: }
1.792 raeburn 5025: }
1.841 albertel 5026:
1.792 raeburn 5027: my $response;
1.841 albertel 5028: foreach my $server (@homeservers) {
1.792 raeburn 5029: $response=&reply('autoinstcodedefaults:'.$domain,$server);
1.841 albertel 5030: next if ($response =~ /(con_lost|error|no_such_host|refused)/);
5031:
5032: foreach my $pair (split(/\&/,$response)) {
5033: my ($name,$value)=split(/\=/,$pair);
5034: if ($name eq 'code_order') {
5035: @{$code_order} = split(/\&/,&unescape($value));
5036: } else {
5037: $returnhash->{&unescape($name)}=&unescape($value);
5038: }
5039: }
5040: return 'ok';
1.792 raeburn 5041: }
1.841 albertel 5042:
5043: return $response;
1.792 raeburn 5044: }
5045:
1.777 albertel 5046: sub auto_validate_class_sec {
1.918 raeburn 5047: my ($cdom,$cnum,$owners,$inst_class) = @_;
1.773 raeburn 5048: my $homeserver = &homeserver($cnum,$cdom);
1.918 raeburn 5049: my $ownerlist;
5050: if (ref($owners) eq 'ARRAY') {
5051: $ownerlist = join(',',@{$owners});
5052: } else {
5053: $ownerlist = $owners;
5054: }
1.773 raeburn 5055: my $response=&reply('autovalidateclass_sec:'.$inst_class.':'.
1.918 raeburn 5056: &escape($ownerlist).':'.$cdom,$homeserver);
1.773 raeburn 5057: return $response;
5058: }
5059:
1.679 raeburn 5060: # ------------------------------------------------------- Course Group routines
5061:
5062: sub get_coursegroups {
1.809 raeburn 5063: my ($cdom,$cnum,$group,$namespace) = @_;
5064: return(&dump($namespace,$cdom,$cnum,$group));
1.805 raeburn 5065: }
5066:
1.679 raeburn 5067: sub modify_coursegroup {
5068: my ($cdom,$cnum,$groupsettings) = @_;
5069: return(&put('coursegroups',$groupsettings,$cdom,$cnum));
5070: }
5071:
1.809 raeburn 5072: sub toggle_coursegroup_status {
5073: my ($cdom,$cnum,$group,$action) = @_;
5074: my ($from_namespace,$to_namespace);
5075: if ($action eq 'delete') {
5076: $from_namespace = 'coursegroups';
5077: $to_namespace = 'deleted_groups';
5078: } else {
5079: $from_namespace = 'deleted_groups';
5080: $to_namespace = 'coursegroups';
5081: }
5082: my %curr_group = &get_coursegroups($cdom,$cnum,$group,$from_namespace);
1.805 raeburn 5083: if (my $tmp = &error(%curr_group)) {
5084: &Apache::lonnet::logthis('Error retrieving group: '.$tmp.' in '.$cnum.':'.$cdom);
5085: return ('read error',$tmp);
5086: } else {
5087: my %savedsettings = %curr_group;
1.809 raeburn 5088: my $result = &put($to_namespace,\%savedsettings,$cdom,$cnum);
1.805 raeburn 5089: my $deloutcome;
5090: if ($result eq 'ok') {
1.809 raeburn 5091: $deloutcome = &del($from_namespace,[$group],$cdom,$cnum);
1.805 raeburn 5092: } else {
5093: return ('write error',$result);
5094: }
5095: if ($deloutcome eq 'ok') {
5096: return 'ok';
5097: } else {
5098: return ('delete error',$deloutcome);
5099: }
5100: }
5101: }
5102:
1.679 raeburn 5103: sub modify_group_roles {
5104: my ($cdom,$cnum,$group_id,$user,$end,$start,$userprivs) = @_;
5105: my $url = '/'.$cdom.'/'.$cnum.'/'.$group_id;
5106: my $role = 'gr/'.&escape($userprivs);
5107: my ($uname,$udom) = split(/:/,$user);
5108: my $result = &assignrole($udom,$uname,$url,$role,$end,$start);
1.684 raeburn 5109: if ($result eq 'ok') {
5110: &devalidate_getgroups_cache($udom,$uname,$cdom,$cnum);
5111: }
1.679 raeburn 5112: return $result;
5113: }
5114:
5115: sub modify_coursegroup_membership {
5116: my ($cdom,$cnum,$membership) = @_;
5117: my $result = &put('groupmembership',$membership,$cdom,$cnum);
5118: return $result;
5119: }
5120:
1.682 raeburn 5121: sub get_active_groups {
5122: my ($udom,$uname,$cdom,$cnum) = @_;
5123: my $now = time;
5124: my %groups = ();
5125: foreach my $key (keys(%env)) {
1.811 albertel 5126: if ($key =~ m-user\.role\.gr\./($match_domain)/($match_courseid)/(\w+)$-) {
1.682 raeburn 5127: my ($start,$end) = split(/\./,$env{$key});
5128: if (($end!=0) && ($end<$now)) { next; }
5129: if (($start!=0) && ($start>$now)) { next; }
5130: if ($1 eq $cdom && $2 eq $cnum) {
5131: $groups{$3} = $env{$key} ;
5132: }
5133: }
5134: }
5135: return %groups;
5136: }
5137:
1.683 raeburn 5138: sub get_group_membership {
5139: my ($cdom,$cnum,$group) = @_;
5140: return(&dump('groupmembership',$cdom,$cnum,$group));
5141: }
5142:
5143: sub get_users_groups {
5144: my ($udom,$uname,$courseid) = @_;
1.733 raeburn 5145: my @usersgroups;
1.683 raeburn 5146: my $cachetime=1800;
5147:
5148: my $hashid="$udom:$uname:$courseid";
1.733 raeburn 5149: my ($grouplist,$cached)=&is_cached_new('getgroups',$hashid);
5150: if (defined($cached)) {
1.734 albertel 5151: @usersgroups = split(/:/,$grouplist);
1.733 raeburn 5152: } else {
5153: $grouplist = '';
1.816 raeburn 5154: my $courseurl = &courseid_to_courseurl($courseid);
5155: my %roleshash = &dump('roles',$udom,$uname,$courseurl);
1.817 raeburn 5156: my $access_end = $env{'course.'.$courseid.
5157: '.default_enrollment_end_date'};
5158: my $now = time;
5159: foreach my $key (keys(%roleshash)) {
5160: if ($key =~ /^\Q$courseurl\E\/(\w+)\_gr$/) {
5161: my $group = $1;
5162: if ($roleshash{$key} =~ /_(\d+)_(\d+)$/) {
5163: my $start = $2;
5164: my $end = $1;
5165: if ($start == -1) { next; } # deleted from group
5166: if (($start!=0) && ($start>$now)) { next; }
5167: if (($end!=0) && ($end<$now)) {
5168: if ($access_end && $access_end < $now) {
5169: if ($access_end - $end < 86400) {
5170: push(@usersgroups,$group);
1.733 raeburn 5171: }
5172: }
1.817 raeburn 5173: next;
1.733 raeburn 5174: }
1.817 raeburn 5175: push(@usersgroups,$group);
1.683 raeburn 5176: }
5177: }
5178: }
1.817 raeburn 5179: @usersgroups = &sort_course_groups($courseid,@usersgroups);
5180: $grouplist = join(':',@usersgroups);
5181: &do_cache_new('getgroups',$hashid,$grouplist,$cachetime);
1.683 raeburn 5182: }
1.733 raeburn 5183: return @usersgroups;
1.683 raeburn 5184: }
5185:
5186: sub devalidate_getgroups_cache {
5187: my ($udom,$uname,$cdom,$cnum)=@_;
5188: my $courseid = $cdom.'_'.$cnum;
1.807 albertel 5189:
1.683 raeburn 5190: my $hashid="$udom:$uname:$courseid";
5191: &devalidate_cache_new('getgroups',$hashid);
5192: }
5193:
1.12 www 5194: # ------------------------------------------------------------------ Plain Text
5195:
5196: sub plaintext {
1.742 raeburn 5197: my ($short,$type,$cid) = @_;
1.758 albertel 5198: if ($short =~ /^cr/) {
5199: return (split('/',$short))[-1];
5200: }
1.742 raeburn 5201: if (!defined($cid)) {
5202: $cid = $env{'request.course.id'};
5203: }
5204: if (defined($cid) && defined($env{'course.'.$cid.'.'.$short.'.plaintext'})) {
5205: return &Apache::lonlocal::mt($env{'course.'.$cid.'.'.$short.
5206: '.plaintext'});
5207: }
5208: my %rolenames = (
5209: Course => 'std',
5210: Group => 'alt1',
5211: );
5212: if (defined($type) &&
5213: defined($rolenames{$type}) &&
5214: defined($prp{$short}{$rolenames{$type}})) {
5215: return &Apache::lonlocal::mt($prp{$short}{$rolenames{$type}});
5216: } else {
5217: return &Apache::lonlocal::mt($prp{$short}{'std'});
5218: }
1.12 www 5219: }
5220:
5221: # ----------------------------------------------------------------- Assign Role
5222:
5223: sub assignrole {
1.357 www 5224: my ($udom,$uname,$url,$role,$end,$start,$deleteflag)=@_;
1.21 www 5225: my $mrole;
5226: if ($role =~ /^cr\//) {
1.393 www 5227: my $cwosec=$url;
1.811 albertel 5228: $cwosec=~s/^\/($match_domain)\/($match_courseid)\/.*/$1\/$2/;
1.393 www 5229: unless (&allowed('ccr',$cwosec)) {
1.104 www 5230: &logthis('Refused custom assignrole: '.
5231: $udom.' '.$uname.' '.$url.' '.$role.' '.$end.' '.$start.' by '.
1.620 albertel 5232: $env{'user.name'}.' at '.$env{'user.domain'});
1.104 www 5233: return 'refused';
5234: }
1.21 www 5235: $mrole='cr';
1.678 raeburn 5236: } elsif ($role =~ /^gr\//) {
5237: my $cwogrp=$url;
1.811 albertel 5238: $cwogrp=~s{^/($match_domain)/($match_courseid)/.*}{$1/$2};
1.678 raeburn 5239: unless (&allowed('mdg',$cwogrp)) {
5240: &logthis('Refused group assignrole: '.
5241: $udom.' '.$uname.' '.$url.' '.$role.' '.$end.' '.$start.' by '.
5242: $env{'user.name'}.' at '.$env{'user.domain'});
5243: return 'refused';
5244: }
5245: $mrole='gr';
1.21 www 5246: } else {
1.82 www 5247: my $cwosec=$url;
1.811 albertel 5248: $cwosec=~s/^\/($match_domain)\/($match_courseid)\/.*/$1\/$2/;
1.373 www 5249: unless ((&allowed('c'.$role,$cwosec)) || &allowed('c'.$role,$udom)) {
1.104 www 5250: &logthis('Refused assignrole: '.
5251: $udom.' '.$uname.' '.$url.' '.$role.' '.$end.' '.$start.' by '.
1.620 albertel 5252: $env{'user.name'}.' at '.$env{'user.domain'});
1.104 www 5253: return 'refused';
5254: }
1.21 www 5255: $mrole=$role;
5256: }
1.620 albertel 5257: my $command="encrypt:rolesput:$env{'user.domain'}:$env{'user.name'}:".
1.21 www 5258: "$udom:$uname:$url".'_'."$mrole=$role";
1.81 www 5259: if ($end) { $command.='_'.$end; }
1.21 www 5260: if ($start) {
5261: if ($end) {
1.81 www 5262: $command.='_'.$start;
1.21 www 5263: } else {
1.81 www 5264: $command.='_0_'.$start;
1.21 www 5265: }
5266: }
1.739 raeburn 5267: my $origstart = $start;
5268: my $origend = $end;
1.357 www 5269: # actually delete
5270: if ($deleteflag) {
1.373 www 5271: if ((&allowed('dro',$udom)) || (&allowed('dro',$url))) {
1.357 www 5272: # modify command to delete the role
1.620 albertel 5273: $command="encrypt:rolesdel:$env{'user.domain'}:$env{'user.name'}:".
1.357 www 5274: "$udom:$uname:$url".'_'."$mrole";
1.620 albertel 5275: &logthis("$env{'user.name'} at $env{'user.domain'} deletes $mrole in $url for $uname at $udom");
1.357 www 5276: # set start and finish to negative values for userrolelog
5277: $start=-1;
5278: $end=-1;
5279: }
5280: }
5281: # send command
1.349 www 5282: my $answer=&reply($command,&homeserver($uname,$udom));
1.357 www 5283: # log new user role if status is ok
1.349 www 5284: if ($answer eq 'ok') {
1.663 raeburn 5285: &userrolelog($role,$uname,$udom,$url,$start,$end);
1.739 raeburn 5286: # for course roles, perform group memberships changes triggered by role change.
5287: unless ($role =~ /^gr/) {
5288: &Apache::longroup::group_changes($udom,$uname,$url,$role,$origend,
5289: $origstart);
5290: }
1.349 www 5291: }
5292: return $answer;
1.169 harris41 5293: }
5294:
5295: # -------------------------------------------------- Modify user authentication
1.197 www 5296: # Overrides without validation
5297:
1.169 harris41 5298: sub modifyuserauth {
5299: my ($udom,$uname,$umode,$upass)=@_;
5300: my $uhome=&homeserver($uname,$udom);
1.197 www 5301: unless (&allowed('mau',$udom)) { return 'refused'; }
5302: &logthis('Call to modify user authentication '.$udom.', '.$uname.', '.
1.620 albertel 5303: $umode.' by '.$env{'user.name'}.' at '.$env{'user.domain'}.
5304: ' in domain '.$env{'request.role.domain'});
1.169 harris41 5305: my $reply=&reply('encrypt:changeuserauth:'.$udom.':'.$uname.':'.$umode.':'.
5306: &escape($upass),$uhome);
1.620 albertel 5307: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},
1.197 www 5308: 'Authentication changed for '.$udom.', '.$uname.', '.$umode.
5309: '(Remote '.$ENV{'REMOTE_ADDR'}.'): '.$reply);
5310: &log($udom,,$uname,$uhome,
1.620 albertel 5311: 'Authentication changed by '.$env{'user.domain'}.', '.
5312: $env{'user.name'}.', '.$umode.
1.197 www 5313: '(Remote '.$ENV{'REMOTE_ADDR'}.'): '.$reply);
1.169 harris41 5314: unless ($reply eq 'ok') {
1.197 www 5315: &logthis('Authentication mode error: '.$reply);
1.169 harris41 5316: return 'error: '.$reply;
5317: }
1.170 harris41 5318: return 'ok';
1.80 www 5319: }
5320:
1.81 www 5321: # --------------------------------------------------------------- Modify a user
1.80 www 5322:
1.81 www 5323: sub modifyuser {
1.206 matthew 5324: my ($udom, $uname, $uid,
5325: $umode, $upass, $first,
5326: $middle, $last, $gene,
1.387 www 5327: $forceid, $desiredhome, $email)=@_;
1.807 albertel 5328: $udom= &LONCAPA::clean_domain($udom);
5329: $uname=&LONCAPA::clean_username($uname);
1.81 www 5330: &logthis('Call to modify user '.$udom.', '.$uname.', '.$uid.', '.
1.80 www 5331: $umode.', '.$first.', '.$middle.', '.
1.206 matthew 5332: $last.', '.$gene.'(forceid: '.$forceid.')'.
5333: (defined($desiredhome) ? ' desiredhome = '.$desiredhome :
5334: ' desiredhome not specified').
1.620 albertel 5335: ' by '.$env{'user.name'}.' at '.$env{'user.domain'}.
5336: ' in domain '.$env{'request.role.domain'});
1.230 stredwic 5337: my $uhome=&homeserver($uname,$udom,'true');
1.80 www 5338: # ----------------------------------------------------------------- Create User
1.406 albertel 5339: if (($uhome eq 'no_host') &&
5340: (($umode && $upass) || ($umode eq 'localauth'))) {
1.80 www 5341: my $unhome='';
1.844 albertel 5342: if (defined($desiredhome) && &host_domain($desiredhome) eq $udom) {
1.209 matthew 5343: $unhome = $desiredhome;
1.620 albertel 5344: } elsif($env{'course.'.$env{'request.course.id'}.'.domain'} eq $udom) {
5345: $unhome=$env{'course.'.$env{'request.course.id'}.'.home'};
1.209 matthew 5346: } else { # load balancing routine for determining $unhome
1.81 www 5347: my $loadm=10000000;
1.841 albertel 5348: my %servers = &get_servers($udom,'library');
5349: foreach my $tryserver (keys(%servers)) {
5350: my $answer=reply('load',$tryserver);
5351: if (($answer=~/\d+/) && ($answer<$loadm)) {
5352: $loadm=$answer;
5353: $unhome=$tryserver;
5354: }
1.80 www 5355: }
5356: }
5357: if (($unhome eq '') || ($unhome eq 'no_host')) {
1.206 matthew 5358: return 'error: unable to find a home server for '.$uname.
5359: ' in domain '.$udom;
1.80 www 5360: }
5361: my $reply=&reply('encrypt:makeuser:'.$udom.':'.$uname.':'.$umode.':'.
5362: &escape($upass),$unhome);
5363: unless ($reply eq 'ok') {
5364: return 'error: '.$reply;
5365: }
1.230 stredwic 5366: $uhome=&homeserver($uname,$udom,'true');
1.80 www 5367: if (($uhome eq '') || ($uhome eq 'no_host') || ($uhome ne $unhome)) {
1.386 matthew 5368: return 'error: unable verify users home machine.';
1.80 www 5369: }
1.209 matthew 5370: } # End of creation of new user
1.80 www 5371: # ---------------------------------------------------------------------- Add ID
5372: if ($uid) {
5373: $uid=~tr/A-Z/a-z/;
5374: my %uidhash=&idrget($udom,$uname);
1.196 www 5375: if (($uidhash{$uname}) && ($uidhash{$uname}!~/error\:/)
5376: && (!$forceid)) {
1.80 www 5377: unless ($uid eq $uidhash{$uname}) {
1.386 matthew 5378: return 'error: user id "'.$uid.'" does not match '.
5379: 'current user id "'.$uidhash{$uname}.'".';
1.80 www 5380: }
5381: } else {
5382: &idput($udom,($uname => $uid));
5383: }
5384: }
5385: # -------------------------------------------------------------- Add names, etc
1.313 matthew 5386: my @tmp=&get('environment',
1.899 raeburn 5387: ['firstname','middlename','lastname','generation','id',
5388: 'permanentemail'],
1.134 albertel 5389: $udom,$uname);
1.313 matthew 5390: my %names;
5391: if ($tmp[0] =~ m/^error:.*/) {
5392: %names=();
5393: } else {
5394: %names = @tmp;
5395: }
1.388 www 5396: #
5397: # Make sure to not trash student environment if instructor does not bother
5398: # to supply name and email information
5399: #
5400: if ($first) { $names{'firstname'} = $first; }
1.385 matthew 5401: if (defined($middle)) { $names{'middlename'} = $middle; }
1.388 www 5402: if ($last) { $names{'lastname'} = $last; }
1.385 matthew 5403: if (defined($gene)) { $names{'generation'} = $gene; }
1.592 www 5404: if ($email) {
5405: $email=~s/[^\w\@\.\-\,]//gs;
5406: if ($email=~/\@/) { $names{'notification'} = $email;
5407: $names{'critnotification'} = $email;
5408: $names{'permanentemail'} = $email; }
5409: }
1.899 raeburn 5410: if ($uid) { $names{'id'} = $uid; }
1.134 albertel 5411: my $reply = &put('environment', \%names, $udom,$uname);
5412: if ($reply ne 'ok') { return 'error: '.$reply; }
1.899 raeburn 5413: my $sqlresult = &update_allusers_table($uname,$udom,\%names);
1.680 www 5414: &devalidate_cache_new('namescache',$uname.':'.$udom);
1.81 www 5415: &logthis('Success modifying user '.$udom.', '.$uname.', '.$uid.', '.
1.80 www 5416: $umode.', '.$first.', '.$middle.', '.
5417: $last.', '.$gene.' by '.
1.620 albertel 5418: $env{'user.name'}.' at '.$env{'user.domain'});
1.134 albertel 5419: return 'ok';
1.80 www 5420: }
5421:
1.81 www 5422: # -------------------------------------------------------------- Modify student
1.80 www 5423:
1.81 www 5424: sub modifystudent {
5425: my ($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene,$usec,
1.515 raeburn 5426: $end,$start,$forceid,$desiredhome,$email,$type,$locktype,$cid)=@_;
1.455 albertel 5427: if (!$cid) {
1.620 albertel 5428: unless ($cid=$env{'request.course.id'}) {
1.455 albertel 5429: return 'not_in_class';
5430: }
1.80 www 5431: }
5432: # --------------------------------------------------------------- Make the user
1.81 www 5433: my $reply=&modifyuser
1.209 matthew 5434: ($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene,$forceid,
1.387 www 5435: $desiredhome,$email);
1.80 www 5436: unless ($reply eq 'ok') { return $reply; }
1.297 matthew 5437: # This will cause &modify_student_enrollment to get the uid from the
5438: # students environment
5439: $uid = undef if (!$forceid);
1.455 albertel 5440: $reply = &modify_student_enrollment($udom,$uname,$uid,$first,$middle,$last,
1.515 raeburn 5441: $gene,$usec,$end,$start,$type,$locktype,$cid);
1.297 matthew 5442: return $reply;
5443: }
5444:
5445: sub modify_student_enrollment {
1.515 raeburn 5446: my ($udom,$uname,$uid,$first,$middle,$last,$gene,$usec,$end,$start,$type,$locktype,$cid) = @_;
1.455 albertel 5447: my ($cdom,$cnum,$chome);
5448: if (!$cid) {
1.620 albertel 5449: unless ($cid=$env{'request.course.id'}) {
1.455 albertel 5450: return 'not_in_class';
5451: }
1.620 albertel 5452: $cdom=$env{'course.'.$cid.'.domain'};
5453: $cnum=$env{'course.'.$cid.'.num'};
1.455 albertel 5454: } else {
5455: ($cdom,$cnum)=split(/_/,$cid);
5456: }
1.620 albertel 5457: $chome=$env{'course.'.$cid.'.home'};
1.455 albertel 5458: if (!$chome) {
1.457 raeburn 5459: $chome=&homeserver($cnum,$cdom);
1.297 matthew 5460: }
1.455 albertel 5461: if (!$chome) { return 'unknown_course'; }
1.297 matthew 5462: # Make sure the user exists
1.81 www 5463: my $uhome=&homeserver($uname,$udom);
5464: if (($uhome eq '') || ($uhome eq 'no_host')) {
5465: return 'error: no such user';
5466: }
1.297 matthew 5467: # Get student data if we were not given enough information
5468: if (!defined($first) || $first eq '' ||
5469: !defined($last) || $last eq '' ||
5470: !defined($uid) || $uid eq '' ||
5471: !defined($middle) || $middle eq '' ||
5472: !defined($gene) || $gene eq '') {
1.294 matthew 5473: # They did not supply us with enough data to enroll the student, so
5474: # we need to pick up more information.
1.297 matthew 5475: my %tmp = &get('environment',
1.294 matthew 5476: ['firstname','middlename','lastname', 'generation','id']
1.297 matthew 5477: ,$udom,$uname);
5478:
1.800 albertel 5479: #foreach my $key (keys(%tmp)) {
5480: # &logthis("key $key = ".$tmp{$key});
1.455 albertel 5481: #}
1.294 matthew 5482: $first = $tmp{'firstname'} if (!defined($first) || $first eq '');
5483: $middle = $tmp{'middlename'} if (!defined($middle) || $middle eq '');
5484: $last = $tmp{'lastname'} if (!defined($last) || $last eq '');
1.297 matthew 5485: $gene = $tmp{'generation'} if (!defined($gene) || $gene eq '');
1.294 matthew 5486: $uid = $tmp{'id'} if (!defined($uid) || $uid eq '');
5487: }
1.556 albertel 5488: my $fullname = &format_name($first,$middle,$last,$gene,'lastname');
1.487 albertel 5489: my $reply=cput('classlist',
5490: {"$uname:$udom" =>
1.515 raeburn 5491: join(':',$end,$start,$uid,$usec,$fullname,$type,$locktype) },
1.487 albertel 5492: $cdom,$cnum);
1.81 www 5493: unless (($reply eq 'ok') || ($reply eq 'delayed')) {
5494: return 'error: '.$reply;
1.652 albertel 5495: } else {
5496: &devalidate_getsection_cache($udom,$uname,$cid);
1.81 www 5497: }
1.297 matthew 5498: # Add student role to user
1.83 www 5499: my $uurl='/'.$cid;
1.81 www 5500: $uurl=~s/\_/\//g;
5501: if ($usec) {
5502: $uurl.='/'.$usec;
5503: }
5504: return &assignrole($udom,$uname,$uurl,'st',$end,$start);
1.21 www 5505: }
5506:
1.556 albertel 5507: sub format_name {
5508: my ($firstname,$middlename,$lastname,$generation,$first)=@_;
5509: my $name;
5510: if ($first ne 'lastname') {
5511: $name=$firstname.' '.$middlename.' '.$lastname.' '.$generation;
5512: } else {
5513: if ($lastname=~/\S/) {
5514: $name.= $lastname.' '.$generation.', '.$firstname.' '.$middlename;
5515: $name=~s/\s+,/,/;
5516: } else {
5517: $name.= $firstname.' '.$middlename.' '.$generation;
5518: }
5519: }
5520: $name=~s/^\s+//;
5521: $name=~s/\s+$//;
5522: $name=~s/\s+/ /g;
5523: return $name;
5524: }
5525:
1.84 www 5526: # ------------------------------------------------- Write to course preferences
5527:
5528: sub writecoursepref {
5529: my ($courseid,%prefs)=@_;
5530: $courseid=~s/^\///;
5531: $courseid=~s/\_/\//g;
5532: my ($cdomain,$cnum)=split(/\//,$courseid);
5533: my $chome=homeserver($cnum,$cdomain);
5534: if (($chome eq '') || ($chome eq 'no_host')) {
5535: return 'error: no such course';
5536: }
5537: my $cstring='';
1.800 albertel 5538: foreach my $pref (keys(%prefs)) {
5539: $cstring.=&escape($pref).'='.&escape($prefs{$pref}).'&';
1.191 harris41 5540: }
1.84 www 5541: $cstring=~s/\&$//;
5542: return reply('put:'.$cdomain.':'.$cnum.':environment:'.$cstring,$chome);
5543: }
5544:
5545: # ---------------------------------------------------------- Make/modify course
5546:
5547: sub createcourse {
1.741 raeburn 5548: my ($udom,$description,$url,$course_server,$nonstandard,$inst_code,
5549: $course_owner,$crstype)=@_;
1.84 www 5550: $url=&declutter($url);
5551: my $cid='';
1.264 matthew 5552: unless (&allowed('ccc',$udom)) {
1.84 www 5553: return 'refused';
5554: }
5555: # ------------------------------------------------------------------- Create ID
1.674 www 5556: my $uname=int(1+rand(9)).
5557: ('a'..'z','A'..'Z','0'..'9')[int(rand(62))].
5558: substr($$.time,0,5).unpack("H8",pack("I32",time)).
1.84 www 5559: unpack("H2",pack("I32",int(rand(255)))).$perlvar{'lonHostID'};
5560: # ----------------------------------------------- Make sure that does not exist
1.230 stredwic 5561: my $uhome=&homeserver($uname,$udom,'true');
1.84 www 5562: unless (($uhome eq '') || ($uhome eq 'no_host')) {
5563: $uname=substr($$.time,0,5).unpack("H8",pack("I32",time)).
5564: unpack("H2",pack("I32",int(rand(255)))).$perlvar{'lonHostID'};
1.230 stredwic 5565: $uhome=&homeserver($uname,$udom,'true');
1.84 www 5566: unless (($uhome eq '') || ($uhome eq 'no_host')) {
5567: return 'error: unable to generate unique course-ID';
5568: }
5569: }
1.264 matthew 5570: # ------------------------------------------------ Check supplied server name
1.620 albertel 5571: $course_server = $env{'user.homeserver'} if (! defined($course_server));
1.845 albertel 5572: if (! &is_library($course_server)) {
1.264 matthew 5573: return 'error:bad server name '.$course_server;
5574: }
1.84 www 5575: # ------------------------------------------------------------- Make the course
5576: my $reply=&reply('encrypt:makeuser:'.$udom.':'.$uname.':none::',
1.264 matthew 5577: $course_server);
1.84 www 5578: unless ($reply eq 'ok') { return 'error: '.$reply; }
1.230 stredwic 5579: $uhome=&homeserver($uname,$udom,'true');
1.84 www 5580: if (($uhome eq '') || ($uhome eq 'no_host')) {
5581: return 'error: no such course';
5582: }
1.271 www 5583: # ----------------------------------------------------------------- Course made
1.516 raeburn 5584: # log existence
1.918 raeburn 5585: my $newcourse = {
5586: $udom.'_'.$uname => {
1.921 raeburn 5587: description => $description,
5588: inst_code => $inst_code,
5589: owner => $course_owner,
5590: type => $crstype,
1.918 raeburn 5591: },
5592: };
1.921 raeburn 5593: &courseidput($udom,$newcourse,$uhome,'notime');
1.358 www 5594: # set toplevel url
1.271 www 5595: my $topurl=$url;
5596: unless ($nonstandard) {
5597: # ------------------------------------------ For standard courses, make top url
5598: my $mapurl=&clutter($url);
1.278 www 5599: if ($mapurl eq '/res/') { $mapurl=''; }
1.620 albertel 5600: $env{'form.initmap'}=(<<ENDINITMAP);
1.271 www 5601: <map>
5602: <resource id="1" type="start"></resource>
5603: <resource id="2" src="$mapurl"></resource>
5604: <resource id="3" type="finish"></resource>
5605: <link index="1" from="1" to="2"></link>
5606: <link index="2" from="2" to="3"></link>
5607: </map>
5608: ENDINITMAP
5609: $topurl=&declutter(
1.638 albertel 5610: &finishuserfileupload($uname,$udom,'initmap','default.sequence')
1.271 www 5611: );
5612: }
5613: # ----------------------------------------------------------- Write preferences
1.84 www 5614: &writecoursepref($udom.'_'.$uname,
5615: ('description' => $description,
1.271 www 5616: 'url' => $topurl));
1.84 www 5617: return '/'.$udom.'/'.$uname;
5618: }
5619:
1.813 albertel 5620: sub is_course {
5621: my ($cdom,$cnum) = @_;
5622: my %courses = &courseiddump($cdom,'.',1,'.','.',$cnum,undef,
1.918 raeburn 5623: undef,'.',undef,1);
1.813 albertel 5624: if (exists($courses{$cdom.'_'.$cnum})) {
5625: return 1;
5626: }
5627: return 0;
5628: }
5629:
1.21 www 5630: # ---------------------------------------------------------- Assign Custom Role
5631:
5632: sub assigncustomrole {
1.357 www 5633: my ($udom,$uname,$url,$rdom,$rnam,$rolename,$end,$start,$deleteflag)=@_;
1.21 www 5634: return &assignrole($udom,$uname,$url,'cr/'.$rdom.'/'.$rnam.'/'.$rolename,
1.357 www 5635: $end,$start,$deleteflag);
1.21 www 5636: }
5637:
5638: # ----------------------------------------------------------------- Revoke Role
5639:
5640: sub revokerole {
1.357 www 5641: my ($udom,$uname,$url,$role,$deleteflag)=@_;
1.21 www 5642: my $now=time;
1.357 www 5643: return &assignrole($udom,$uname,$url,$role,$now,$deleteflag);
1.21 www 5644: }
5645:
5646: # ---------------------------------------------------------- Revoke Custom Role
5647:
5648: sub revokecustomrole {
1.357 www 5649: my ($udom,$uname,$url,$rdom,$rnam,$rolename,$deleteflag)=@_;
1.21 www 5650: my $now=time;
1.357 www 5651: return &assigncustomrole($udom,$uname,$url,$rdom,$rnam,$rolename,$now,
5652: $deleteflag);
1.17 www 5653: }
5654:
1.533 banghart 5655: # ------------------------------------------------------------ Disk usage
1.535 albertel 5656: sub diskusage {
1.533 banghart 5657: my ($udom,$uname,$directoryRoot)=@_;
5658: $directoryRoot =~ s/\/$//;
1.535 albertel 5659: my $listing=&reply('du:'.$directoryRoot,homeserver($uname,$udom));
1.514 albertel 5660: return $listing;
1.512 banghart 5661: }
5662:
1.566 banghart 5663: sub is_locked {
5664: my ($file_name, $domain, $user) = @_;
5665: my @check;
5666: my $is_locked;
5667: push @check, $file_name;
1.613 albertel 5668: my %locked = &get('file_permissions',\@check,
1.620 albertel 5669: $env{'user.domain'},$env{'user.name'});
1.615 albertel 5670: my ($tmp)=keys(%locked);
5671: if ($tmp=~/^error:/) { undef(%locked); }
1.745 raeburn 5672:
1.566 banghart 5673: if (ref($locked{$file_name}) eq 'ARRAY') {
1.745 raeburn 5674: $is_locked = 'false';
5675: foreach my $entry (@{$locked{$file_name}}) {
5676: if (ref($entry) eq 'ARRAY') {
1.746 raeburn 5677: $is_locked = 'true';
5678: last;
1.745 raeburn 5679: }
5680: }
1.566 banghart 5681: } else {
5682: $is_locked = 'false';
5683: }
5684: }
5685:
1.759 albertel 5686: sub declutter_portfile {
5687: my ($file) = @_;
1.833 albertel 5688: $file =~ s{^(/portfolio/|portfolio/)}{/};
1.759 albertel 5689: return $file;
5690: }
5691:
1.559 banghart 5692: # ------------------------------------------------------------- Mark as Read Only
5693:
5694: sub mark_as_readonly {
5695: my ($domain,$user,$files,$what) = @_;
1.613 albertel 5696: my %current_permissions = &dump('file_permissions',$domain,$user);
1.615 albertel 5697: my ($tmp)=keys(%current_permissions);
5698: if ($tmp=~/^error:/) { undef(%current_permissions); }
1.560 banghart 5699: foreach my $file (@{$files}) {
1.759 albertel 5700: $file = &declutter_portfile($file);
1.561 banghart 5701: push(@{$current_permissions{$file}},$what);
1.559 banghart 5702: }
1.613 albertel 5703: &put('file_permissions',\%current_permissions,$domain,$user);
1.559 banghart 5704: return;
5705: }
5706:
1.572 banghart 5707: # ------------------------------------------------------------Save Selected Files
5708:
5709: sub save_selected_files {
5710: my ($user, $path, @files) = @_;
5711: my $filename = $user."savedfiles";
1.573 banghart 5712: my @other_files = &files_not_in_path($user, $path);
1.871 albertel 5713: open (OUT, '>'.$tmpdir.$filename);
1.573 banghart 5714: foreach my $file (@files) {
1.620 albertel 5715: print (OUT $env{'form.currentpath'}.$file."\n");
1.573 banghart 5716: }
5717: foreach my $file (@other_files) {
1.574 banghart 5718: print (OUT $file."\n");
1.572 banghart 5719: }
1.574 banghart 5720: close (OUT);
1.572 banghart 5721: return 'ok';
5722: }
5723:
1.574 banghart 5724: sub clear_selected_files {
5725: my ($user) = @_;
5726: my $filename = $user."savedfiles";
5727: open (OUT, '>'.$Apache::lonnet::perlvar{'lonDaemons'}.'/tmp/'.$filename);
5728: print (OUT undef);
5729: close (OUT);
5730: return ("ok");
5731: }
5732:
1.572 banghart 5733: sub files_in_path {
5734: my ($user, $path) = @_;
5735: my $filename = $user."savedfiles";
5736: my %return_files;
1.574 banghart 5737: open (IN, '<'.$Apache::lonnet::perlvar{'lonDaemons'}.'/tmp/'.$filename);
1.573 banghart 5738: while (my $line_in = <IN>) {
1.574 banghart 5739: chomp ($line_in);
5740: my @paths_and_file = split (m!/!, $line_in);
5741: my $file_part = pop (@paths_and_file);
5742: my $path_part = join ('/', @paths_and_file);
1.573 banghart 5743: $path_part.='/';
5744: my $path_and_file = $path_part.$file_part;
5745: if ($path_part eq $path) {
5746: $return_files{$file_part}= 'selected';
5747: }
5748: }
1.574 banghart 5749: close (IN);
5750: return (\%return_files);
1.572 banghart 5751: }
5752:
5753: # called in portfolio select mode, to show files selected NOT in current directory
5754: sub files_not_in_path {
5755: my ($user, $path) = @_;
5756: my $filename = $user."savedfiles";
5757: my @return_files;
5758: my $path_part;
1.800 albertel 5759: open(IN, '<'.$Apache::lonnet::perlvar{'lonDaemons'}.'/tmp/'.$filename);
5760: while (my $line = <IN>) {
1.572 banghart 5761: #ok, I know it's clunky, but I want it to work
1.800 albertel 5762: my @paths_and_file = split(m|/|, $line);
5763: my $file_part = pop(@paths_and_file);
5764: chomp($file_part);
5765: my $path_part = join('/', @paths_and_file);
1.572 banghart 5766: $path_part .= '/';
5767: my $path_and_file = $path_part.$file_part;
5768: if ($path_part ne $path) {
1.800 albertel 5769: push(@return_files, ($path_and_file));
1.572 banghart 5770: }
5771: }
1.800 albertel 5772: close(OUT);
1.574 banghart 5773: return (@return_files);
1.572 banghart 5774: }
5775:
1.745 raeburn 5776: #----------------------------------------------Get portfolio file permissions
1.629 banghart 5777:
1.745 raeburn 5778: sub get_portfile_permissions {
5779: my ($domain,$user) = @_;
1.613 albertel 5780: my %current_permissions = &dump('file_permissions',$domain,$user);
1.615 albertel 5781: my ($tmp)=keys(%current_permissions);
5782: if ($tmp=~/^error:/) { undef(%current_permissions); }
1.745 raeburn 5783: return \%current_permissions;
5784: }
5785:
5786: #---------------------------------------------Get portfolio file access controls
5787:
1.749 raeburn 5788: sub get_access_controls {
1.745 raeburn 5789: my ($current_permissions,$group,$file) = @_;
1.769 albertel 5790: my %access;
5791: my $real_file = $file;
5792: $file =~ s/\.meta$//;
1.745 raeburn 5793: if (defined($file)) {
1.749 raeburn 5794: if (ref($$current_permissions{$file."\0".'accesscontrol'}) eq 'HASH') {
5795: foreach my $control (keys(%{$$current_permissions{$file."\0".'accesscontrol'}})) {
1.769 albertel 5796: $access{$real_file}{$control} = $$current_permissions{$file."\0".$control};
1.749 raeburn 5797: }
5798: }
1.745 raeburn 5799: } else {
1.749 raeburn 5800: foreach my $key (keys(%{$current_permissions})) {
5801: if ($key =~ /\0accesscontrol$/) {
5802: if (defined($group)) {
5803: if ($key !~ m-^\Q$group\E/-) {
5804: next;
5805: }
5806: }
5807: my ($fullpath) = split(/\0/,$key);
5808: if (ref($$current_permissions{$key}) eq 'HASH') {
5809: foreach my $control (keys(%{$$current_permissions{$key}})) {
5810: $access{$fullpath}{$control}=$$current_permissions{$fullpath."\0".$control};
5811: }
5812: }
5813: }
5814: }
5815: }
5816: return %access;
5817: }
5818:
5819: sub modify_access_controls {
5820: my ($file_name,$changes,$domain,$user)=@_;
5821: my ($outcome,$deloutcome);
5822: my %store_permissions;
5823: my %new_values;
5824: my %new_control;
5825: my %translation;
5826: my @deletions = ();
5827: my $now = time;
5828: if (exists($$changes{'activate'})) {
5829: if (ref($$changes{'activate'}) eq 'HASH') {
5830: my @newitems = sort(keys(%{$$changes{'activate'}}));
5831: my $numnew = scalar(@newitems);
5832: for (my $i=0; $i<$numnew; $i++) {
5833: my $newkey = $newitems[$i];
5834: my $newid = &Apache::loncommon::get_cgi_id();
1.797 raeburn 5835: if ($newkey =~ /^\d+:/) {
5836: $newkey =~ s/^(\d+)/$newid/;
5837: $translation{$1} = $newid;
5838: } elsif ($newkey =~ /^\d+_\d+_\d+:/) {
5839: $newkey =~ s/^(\d+_\d+_\d+)/$newid/;
5840: $translation{$1} = $newid;
5841: }
1.749 raeburn 5842: $new_values{$file_name."\0".$newkey} =
5843: $$changes{'activate'}{$newitems[$i]};
5844: $new_control{$newkey} = $now;
5845: }
5846: }
5847: }
5848: my %todelete;
5849: my %changed_items;
5850: foreach my $action ('delete','update') {
5851: if (exists($$changes{$action})) {
5852: if (ref($$changes{$action}) eq 'HASH') {
5853: foreach my $key (keys(%{$$changes{$action}})) {
5854: my ($itemnum) = ($key =~ /^([^:]+):/);
5855: if ($action eq 'delete') {
5856: $todelete{$itemnum} = 1;
5857: } else {
5858: $changed_items{$itemnum} = $key;
5859: }
5860: }
1.745 raeburn 5861: }
5862: }
1.749 raeburn 5863: }
5864: # get lock on access controls for file.
5865: my $lockhash = {
5866: $file_name."\0".'locked_access_records' => $env{'user.name'}.
5867: ':'.$env{'user.domain'},
5868: };
5869: my $tries = 0;
5870: my $gotlock = &newput('file_permissions',$lockhash,$domain,$user);
5871:
5872: while (($gotlock ne 'ok') && $tries <3) {
5873: $tries ++;
5874: sleep 1;
5875: $gotlock = &newput('file_permissions',$lockhash,$domain,$user);
5876: }
5877: if ($gotlock eq 'ok') {
5878: my %curr_permissions = &dump('file_permissions',$domain,$user,$file_name);
5879: my ($tmp)=keys(%curr_permissions);
5880: if ($tmp=~/^error:/) { undef(%curr_permissions); }
5881: if (exists($curr_permissions{$file_name."\0".'accesscontrol'})) {
5882: my $curr_controls = $curr_permissions{$file_name."\0".'accesscontrol'};
5883: if (ref($curr_controls) eq 'HASH') {
5884: foreach my $control_item (keys(%{$curr_controls})) {
5885: my ($itemnum) = ($control_item =~ /^([^:]+):/);
5886: if (defined($todelete{$itemnum})) {
5887: push(@deletions,$file_name."\0".$control_item);
5888: } else {
5889: if (defined($changed_items{$itemnum})) {
5890: $new_control{$changed_items{$itemnum}} = $now;
5891: push(@deletions,$file_name."\0".$control_item);
5892: $new_values{$file_name."\0".$changed_items{$itemnum}} = $$changes{'update'}{$changed_items{$itemnum}};
5893: } else {
5894: $new_control{$control_item} = $$curr_controls{$control_item};
5895: }
5896: }
1.745 raeburn 5897: }
5898: }
5899: }
1.749 raeburn 5900: $deloutcome = &del('file_permissions',\@deletions,$domain,$user);
5901: $new_values{$file_name."\0".'accesscontrol'} = \%new_control;
5902: $outcome = &put('file_permissions',\%new_values,$domain,$user);
5903: # remove lock
5904: my @del_lock = ($file_name."\0".'locked_access_records');
5905: my $dellockoutcome = &del('file_permissions',\@del_lock,$domain,$user);
1.818 raeburn 5906: my ($file,$group);
5907: if (&is_course($domain,$user)) {
5908: ($group,$file) = split(/\//,$file_name,2);
5909: } else {
5910: $file = $file_name;
5911: }
5912: my $sqlresult =
5913: &update_portfolio_table($user,$domain,$file,'portfolio_access',
5914: $group);
1.749 raeburn 5915: } else {
5916: $outcome = "error: could not obtain lockfile\n";
1.745 raeburn 5917: }
1.749 raeburn 5918: return ($outcome,$deloutcome,\%new_values,\%translation);
1.745 raeburn 5919: }
5920:
1.827 raeburn 5921: sub make_public_indefinitely {
5922: my ($requrl) = @_;
5923: my $now = time;
5924: my $action = 'activate';
5925: my $aclnum = 0;
5926: if (&is_portfolio_url($requrl)) {
5927: my (undef,$udom,$unum,$file_name,$group) =
5928: &parse_portfolio_url($requrl);
5929: my $current_perms = &get_portfile_permissions($udom,$unum);
5930: my %access_controls = &get_access_controls($current_perms,
5931: $group,$file_name);
5932: foreach my $key (keys(%{$access_controls{$file_name}})) {
5933: my ($num,$scope,$end,$start) =
5934: ($key =~ /^([^:]+):([a-z]+)_(\d*)_?(\d*)$/);
5935: if ($scope eq 'public') {
5936: if ($start <= $now && $end == 0) {
5937: $action = 'none';
5938: } else {
5939: $action = 'update';
5940: $aclnum = $num;
5941: }
5942: last;
5943: }
5944: }
5945: if ($action eq 'none') {
5946: return 'ok';
5947: } else {
5948: my %changes;
5949: my $newend = 0;
5950: my $newstart = $now;
5951: my $newkey = $aclnum.':public_'.$newend.'_'.$newstart;
5952: $changes{$action}{$newkey} = {
5953: type => 'public',
5954: time => {
5955: start => $newstart,
5956: end => $newend,
5957: },
5958: };
5959: my ($outcome,$deloutcome,$new_values,$translation) =
5960: &modify_access_controls($file_name,\%changes,$udom,$unum);
5961: return $outcome;
5962: }
5963: } else {
5964: return 'invalid';
5965: }
5966: }
5967:
1.745 raeburn 5968: #------------------------------------------------------Get Marked as Read Only
5969:
5970: sub get_marked_as_readonly {
5971: my ($domain,$user,$what,$group) = @_;
5972: my $current_permissions = &get_portfile_permissions($domain,$user);
1.563 banghart 5973: my @readonly_files;
1.629 banghart 5974: my $cmp1=$what;
5975: if (ref($what)) { $cmp1=join('',@{$what}) };
1.745 raeburn 5976: while (my ($file_name,$value) = each(%{$current_permissions})) {
5977: if (defined($group)) {
5978: if ($file_name !~ m-^\Q$group\E/-) {
5979: next;
5980: }
5981: }
1.561 banghart 5982: if (ref($value) eq "ARRAY"){
5983: foreach my $stored_what (@{$value}) {
1.629 banghart 5984: my $cmp2=$stored_what;
1.759 albertel 5985: if (ref($stored_what) eq 'ARRAY') {
1.746 raeburn 5986: $cmp2=join('',@{$stored_what});
1.745 raeburn 5987: }
1.629 banghart 5988: if ($cmp1 eq $cmp2) {
1.561 banghart 5989: push(@readonly_files, $file_name);
1.745 raeburn 5990: last;
1.563 banghart 5991: } elsif (!defined($what)) {
5992: push(@readonly_files, $file_name);
1.745 raeburn 5993: last;
1.561 banghart 5994: }
5995: }
1.745 raeburn 5996: }
1.561 banghart 5997: }
5998: return @readonly_files;
5999: }
1.577 banghart 6000: #-----------------------------------------------------------Get Marked as Read Only Hash
1.561 banghart 6001:
1.577 banghart 6002: sub get_marked_as_readonly_hash {
1.745 raeburn 6003: my ($current_permissions,$group,$what) = @_;
1.577 banghart 6004: my %readonly_files;
1.745 raeburn 6005: while (my ($file_name,$value) = each(%{$current_permissions})) {
6006: if (defined($group)) {
6007: if ($file_name !~ m-^\Q$group\E/-) {
6008: next;
6009: }
6010: }
1.577 banghart 6011: if (ref($value) eq "ARRAY"){
6012: foreach my $stored_what (@{$value}) {
1.745 raeburn 6013: if (ref($stored_what) eq 'ARRAY') {
1.750 banghart 6014: foreach my $lock_descriptor(@{$stored_what}) {
6015: if ($lock_descriptor eq 'graded') {
6016: $readonly_files{$file_name} = 'graded';
6017: } elsif ($lock_descriptor eq 'handback') {
6018: $readonly_files{$file_name} = 'handback';
6019: } else {
6020: if (!exists($readonly_files{$file_name})) {
6021: $readonly_files{$file_name} = 'locked';
6022: }
6023: }
1.745 raeburn 6024: }
1.750 banghart 6025: }
1.577 banghart 6026: }
6027: }
6028: }
6029: return %readonly_files;
6030: }
1.559 banghart 6031: # ------------------------------------------------------------ Unmark as Read Only
6032:
6033: sub unmark_as_readonly {
1.629 banghart 6034: # unmarks $file_name (if $file_name is defined), or all files locked by $what
6035: # for portfolio submissions, $what contains [$symb,$crsid]
1.745 raeburn 6036: my ($domain,$user,$what,$file_name,$group) = @_;
1.759 albertel 6037: $file_name = &declutter_portfile($file_name);
1.634 albertel 6038: my $symb_crs = $what;
6039: if (ref($what)) { $symb_crs=join('',@$what); }
1.745 raeburn 6040: my %current_permissions = &dump('file_permissions',$domain,$user,$group);
1.615 albertel 6041: my ($tmp)=keys(%current_permissions);
6042: if ($tmp=~/^error:/) { undef(%current_permissions); }
1.745 raeburn 6043: my @readonly_files = &get_marked_as_readonly($domain,$user,$what,$group);
1.650 albertel 6044: foreach my $file (@readonly_files) {
1.759 albertel 6045: my $clean_file = &declutter_portfile($file);
6046: if (defined($file_name) && ($file_name ne $clean_file)) { next; }
1.650 albertel 6047: my $current_locks = $current_permissions{$file};
1.563 banghart 6048: my @new_locks;
6049: my @del_keys;
6050: if (ref($current_locks) eq "ARRAY"){
6051: foreach my $locker (@{$current_locks}) {
1.632 albertel 6052: my $compare=$locker;
1.749 raeburn 6053: if (ref($locker) eq 'ARRAY') {
1.745 raeburn 6054: $compare=join('',@{$locker});
1.746 raeburn 6055: if ($compare ne $symb_crs) {
6056: push(@new_locks, $locker);
6057: }
1.563 banghart 6058: }
6059: }
1.650 albertel 6060: if (scalar(@new_locks) > 0) {
1.563 banghart 6061: $current_permissions{$file} = \@new_locks;
6062: } else {
6063: push(@del_keys, $file);
1.613 albertel 6064: &del('file_permissions',\@del_keys, $domain, $user);
1.650 albertel 6065: delete($current_permissions{$file});
1.563 banghart 6066: }
6067: }
1.561 banghart 6068: }
1.613 albertel 6069: &put('file_permissions',\%current_permissions,$domain,$user);
1.559 banghart 6070: return;
6071: }
1.512 banghart 6072:
1.17 www 6073: # ------------------------------------------------------------ Directory lister
6074:
6075: sub dirlist {
1.253 stredwic 6076: my ($uri,$userdomain,$username,$alternateDirectoryRoot)=@_;
6077:
1.18 www 6078: $uri=~s/^\///;
6079: $uri=~s/\/$//;
1.253 stredwic 6080: my ($udom, $uname);
6081: (undef,$udom,$uname)=split(/\//,$uri);
6082: if(defined($userdomain)) {
6083: $udom = $userdomain;
6084: }
6085: if(defined($username)) {
6086: $uname = $username;
6087: }
6088:
6089: my $dirRoot = $perlvar{'lonDocRoot'};
6090: if(defined($alternateDirectoryRoot)) {
6091: $dirRoot = $alternateDirectoryRoot;
6092: $dirRoot =~ s/\/$//;
1.751 banghart 6093: }
1.253 stredwic 6094:
6095: if($udom) {
6096: if($uname) {
1.800 albertel 6097: my $listing = &reply('ls2:'.$dirRoot.'/'.$uri,
6098: &homeserver($uname,$udom));
1.605 matthew 6099: my @listing_results;
6100: if ($listing eq 'unknown_cmd') {
1.800 albertel 6101: $listing = &reply('ls:'.$dirRoot.'/'.$uri,
6102: &homeserver($uname,$udom));
1.605 matthew 6103: @listing_results = split(/:/,$listing);
6104: } else {
6105: @listing_results = map { &unescape($_); } split(/:/,$listing);
6106: }
6107: return @listing_results;
1.253 stredwic 6108: } elsif(!defined($alternateDirectoryRoot)) {
1.800 albertel 6109: my %allusers;
1.841 albertel 6110: my %servers = &get_servers($udom,'library');
6111: foreach my $tryserver (keys(%servers)) {
6112: my $listing = &reply('ls2:'.$perlvar{'lonDocRoot'}.'/res/'.
6113: $udom, $tryserver);
6114: my @listing_results;
6115: if ($listing eq 'unknown_cmd') {
6116: $listing = &reply('ls:'.$perlvar{'lonDocRoot'}.'/res/'.
6117: $udom, $tryserver);
6118: @listing_results = split(/:/,$listing);
6119: } else {
6120: @listing_results =
6121: map { &unescape($_); } split(/:/,$listing);
6122: }
6123: if ($listing_results[0] ne 'no_such_dir' &&
6124: $listing_results[0] ne 'empty' &&
6125: $listing_results[0] ne 'con_lost') {
6126: foreach my $line (@listing_results) {
6127: my ($entry) = split(/&/,$line,2);
6128: $allusers{$entry} = 1;
6129: }
6130: }
1.253 stredwic 6131: }
6132: my $alluserstr='';
1.800 albertel 6133: foreach my $user (sort(keys(%allusers))) {
6134: $alluserstr.=$user.'&user:';
1.253 stredwic 6135: }
6136: $alluserstr=~s/:$//;
6137: return split(/:/,$alluserstr);
6138: } else {
1.800 albertel 6139: return ('missing user name');
1.253 stredwic 6140: }
6141: } elsif(!defined($alternateDirectoryRoot)) {
1.841 albertel 6142: my @all_domains = sort(&all_domains());
6143: foreach my $domain (@all_domains) {
6144: $domain = $perlvar{'lonDocRoot'}.'/res/'.$domain.'/&domain';
6145: }
6146: return @all_domains;
6147: } else {
1.800 albertel 6148: return ('missing domain');
1.275 stredwic 6149: }
6150: }
6151:
6152: # --------------------------------------------- GetFileTimestamp
6153: # This function utilizes dirlist and returns the date stamp for
6154: # when it was last modified. It will also return an error of -1
6155: # if an error occurs
6156:
1.410 matthew 6157: ##
6158: ## FIXME: This subroutine assumes its caller knows something about the
6159: ## directory structure of the home server for the student ($root).
6160: ## Not a good assumption to make. Since this is for looking up files
6161: ## in user directories, the full path should be constructed by lond, not
6162: ## whatever machine we request data from.
6163: ##
1.275 stredwic 6164: sub GetFileTimestamp {
6165: my ($studentDomain,$studentName,$filename,$root)=@_;
1.807 albertel 6166: $studentDomain = &LONCAPA::clean_domain($studentDomain);
6167: $studentName = &LONCAPA::clean_username($studentName);
1.275 stredwic 6168: my $subdir=$studentName.'__';
6169: $subdir =~ s/(.)(.)(.).*/$1\/$2\/$3/;
6170: my $proname="$studentDomain/$subdir/$studentName";
6171: $proname .= '/'.$filename;
1.375 matthew 6172: my ($fileStat) = &Apache::lonnet::dirlist($proname, $studentDomain,
6173: $studentName, $root);
1.275 stredwic 6174: my @stats = split('&', $fileStat);
6175: if($stats[0] ne 'empty' && $stats[0] ne 'no_such_dir') {
1.375 matthew 6176: # @stats contains first the filename, then the stat output
6177: return $stats[10]; # so this is 10 instead of 9.
1.275 stredwic 6178: } else {
6179: return -1;
1.253 stredwic 6180: }
1.26 www 6181: }
6182:
1.712 albertel 6183: sub stat_file {
6184: my ($uri) = @_;
1.787 albertel 6185: $uri = &clutter_with_no_wrapper($uri);
1.722 albertel 6186:
1.712 albertel 6187: my ($udom,$uname,$file,$dir);
6188: if ($uri =~ m-^/(uploaded|editupload)/-) {
6189: ($udom,$uname,$file) =
1.811 albertel 6190: ($uri =~ m-/(?:uploaded|editupload)/?($match_domain)/?($match_name)/?(.*)-);
1.712 albertel 6191: $file = 'userfiles/'.$file;
1.740 www 6192: $dir = &propath($udom,$uname);
1.712 albertel 6193: }
6194: if ($uri =~ m-^/res/-) {
6195: ($udom,$uname) =
1.807 albertel 6196: ($uri =~ m-/(?:res)/?($match_domain)/?($match_username)/-);
1.712 albertel 6197: $file = $uri;
6198: }
6199:
6200: if (!$udom || !$uname || !$file) {
6201: # unable to handle the uri
6202: return ();
6203: }
6204:
6205: my ($result) = &dirlist($file,$udom,$uname,$dir);
6206: my @stats = split('&', $result);
1.721 banghart 6207:
1.712 albertel 6208: if($stats[0] ne 'empty' && $stats[0] ne 'no_such_dir') {
6209: shift(@stats); #filename is first
6210: return @stats;
6211: }
6212: return ();
6213: }
6214:
1.26 www 6215: # -------------------------------------------------------- Value of a Condition
6216:
1.713 albertel 6217: # gets the value of a specific preevaluated condition
6218: # stored in the string $env{user.state.<cid>}
6219: # or looks up a condition reference in the bighash and if if hasn't
6220: # already been evaluated recurses into docondval to get the value of
6221: # the condition, then memoizing it to
6222: # $env{user.state.<cid>.<condition>}
1.40 www 6223: sub directcondval {
6224: my $number=shift;
1.620 albertel 6225: if (!defined($env{'user.state.'.$env{'request.course.id'}})) {
1.555 albertel 6226: &Apache::lonuserstate::evalstate();
6227: }
1.713 albertel 6228: if (exists($env{'user.state.'.$env{'request.course.id'}.".$number"})) {
6229: return $env{'user.state.'.$env{'request.course.id'}.".$number"};
6230: } elsif ($number =~ /^_/) {
6231: my $sub_condition;
6232: if (tie(my %bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
6233: &GDBM_READER(),0640)) {
6234: $sub_condition=$bighash{'conditions'.$number};
6235: untie(%bighash);
6236: }
6237: my $value = &docondval($sub_condition);
6238: &appenv('user.state.'.$env{'request.course.id'}.".$number" => $value);
6239: return $value;
6240: }
1.620 albertel 6241: if ($env{'user.state.'.$env{'request.course.id'}}) {
6242: return substr($env{'user.state.'.$env{'request.course.id'}},$number,1);
1.40 www 6243: } else {
6244: return 2;
6245: }
6246: }
6247:
1.713 albertel 6248: # get the collection of conditions for this resource
1.26 www 6249: sub condval {
6250: my $condidx=shift;
1.54 www 6251: my $allpathcond='';
1.713 albertel 6252: foreach my $cond (split(/\|/,$condidx)) {
6253: if (defined($env{'acc.cond.'.$env{'request.course.id'}.'.'.$cond})) {
6254: $allpathcond.=
6255: '('.$env{'acc.cond.'.$env{'request.course.id'}.'.'.$cond}.')|';
6256: }
1.191 harris41 6257: }
1.54 www 6258: $allpathcond=~s/\|$//;
1.713 albertel 6259: return &docondval($allpathcond);
6260: }
6261:
6262: #evaluates an expression of conditions
6263: sub docondval {
6264: my ($allpathcond) = @_;
6265: my $result=0;
6266: if ($env{'request.course.id'}
6267: && defined($allpathcond)) {
6268: my $operand='|';
6269: my @stack;
6270: foreach my $chunk ($allpathcond=~/(\d+|_\d+\.\d+|\(|\)|\&|\|)/g) {
6271: if ($chunk eq '(') {
6272: push @stack,($operand,$result);
6273: } elsif ($chunk eq ')') {
6274: my $before=pop @stack;
6275: if (pop @stack eq '&') {
6276: $result=$result>$before?$before:$result;
6277: } else {
6278: $result=$result>$before?$result:$before;
6279: }
6280: } elsif (($chunk eq '&') || ($chunk eq '|')) {
6281: $operand=$chunk;
6282: } else {
6283: my $new=directcondval($chunk);
6284: if ($operand eq '&') {
6285: $result=$result>$new?$new:$result;
6286: } else {
6287: $result=$result>$new?$result:$new;
6288: }
6289: }
6290: }
1.26 www 6291: }
6292: return $result;
1.421 albertel 6293: }
6294:
6295: # ---------------------------------------------------- Devalidate courseresdata
6296:
6297: sub devalidatecourseresdata {
6298: my ($coursenum,$coursedomain)=@_;
6299: my $hashid=$coursenum.':'.$coursedomain;
1.599 albertel 6300: &devalidate_cache_new('courseres',$hashid);
1.28 www 6301: }
6302:
1.763 www 6303:
1.200 www 6304: # --------------------------------------------------- Course Resourcedata Query
1.878 foxr 6305: #
6306: # Parameters:
6307: # $coursenum - Number of the course.
6308: # $coursedomain - Domain at which the course was created.
6309: # Returns:
6310: # A hash of the course parameters along (I think) with timestamps
6311: # and version info.
1.877 foxr 6312:
1.624 albertel 6313: sub get_courseresdata {
6314: my ($coursenum,$coursedomain)=@_;
1.200 www 6315: my $coursehom=&homeserver($coursenum,$coursedomain);
6316: my $hashid=$coursenum.':'.$coursedomain;
1.599 albertel 6317: my ($result,$cached)=&is_cached_new('courseres',$hashid);
1.624 albertel 6318: my %dumpreply;
1.417 albertel 6319: unless (defined($cached)) {
1.624 albertel 6320: %dumpreply=&dump('resourcedata',$coursedomain,$coursenum);
1.417 albertel 6321: $result=\%dumpreply;
1.251 albertel 6322: my ($tmp) = keys(%dumpreply);
6323: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
1.599 albertel 6324: &do_cache_new('courseres',$hashid,$result,600);
1.306 albertel 6325: } elsif ($tmp =~ /^(con_lost|no_such_host)/) {
6326: return $tmp;
1.416 albertel 6327: } elsif ($tmp =~ /^(error)/) {
1.417 albertel 6328: $result=undef;
1.599 albertel 6329: &do_cache_new('courseres',$hashid,$result,600);
1.250 albertel 6330: }
6331: }
1.624 albertel 6332: return $result;
6333: }
6334:
1.633 albertel 6335: sub devalidateuserresdata {
6336: my ($uname,$udom)=@_;
6337: my $hashid="$udom:$uname";
6338: &devalidate_cache_new('userres',$hashid);
6339: }
6340:
1.624 albertel 6341: sub get_userresdata {
6342: my ($uname,$udom)=@_;
6343: #most student don\'t have any data set, check if there is some data
6344: if (&EXT_cache_status($udom,$uname)) { return undef; }
6345:
6346: my $hashid="$udom:$uname";
6347: my ($result,$cached)=&is_cached_new('userres',$hashid);
6348: if (!defined($cached)) {
6349: my %resourcedata=&dump('resourcedata',$udom,$uname);
6350: $result=\%resourcedata;
6351: &do_cache_new('userres',$hashid,$result,600);
6352: }
6353: my ($tmp)=keys(%$result);
6354: if (($tmp!~/^error\:/) && ($tmp!~/^con_lost/)) {
6355: return $result;
6356: }
6357: #error 2 occurs when the .db doesn't exist
6358: if ($tmp!~/error: 2 /) {
1.672 albertel 6359: &logthis("<font color=\"blue\">WARNING:".
1.624 albertel 6360: " Trying to get resource data for ".
6361: $uname." at ".$udom.": ".
6362: $tmp."</font>");
6363: } elsif ($tmp=~/error: 2 /) {
1.633 albertel 6364: #&EXT_cache_set($udom,$uname);
6365: &do_cache_new('userres',$hashid,undef,600);
1.636 albertel 6366: undef($tmp); # not really an error so don't send it back
1.624 albertel 6367: }
6368: return $tmp;
6369: }
1.879 foxr 6370: #----------------------------------------------- resdata - return resource data
6371: # Purpose:
6372: # Return resource data for either users or for a course.
6373: # Parameters:
6374: # $name - Course/user name.
6375: # $domain - Name of the domain the user/course is registered on.
6376: # $type - Type of thing $name is (must be 'course' or 'user'
6377: # @which - Array of names of resources desired.
6378: # Returns:
6379: # The value of the first reasource in @which that is found in the
6380: # resource hash.
6381: # Exceptional Conditions:
6382: # If the $type passed in is not valid (not the string 'course' or
6383: # 'user', an undefined reference is returned.
6384: # If none of the resources are found, an undef is returned
1.624 albertel 6385: sub resdata {
6386: my ($name,$domain,$type,@which)=@_;
6387: my $result;
6388: if ($type eq 'course') {
6389: $result=&get_courseresdata($name,$domain);
6390: } elsif ($type eq 'user') {
6391: $result=&get_userresdata($name,$domain);
6392: }
6393: if (!ref($result)) { return $result; }
1.251 albertel 6394: foreach my $item (@which) {
1.417 albertel 6395: if (defined($result->{$item})) {
6396: return $result->{$item};
1.251 albertel 6397: }
1.250 albertel 6398: }
1.291 albertel 6399: return undef;
1.200 www 6400: }
6401:
1.379 matthew 6402: #
6403: # EXT resource caching routines
6404: #
6405:
6406: sub clear_EXT_cache_status {
1.383 albertel 6407: &delenv('cache.EXT.');
1.379 matthew 6408: }
6409:
6410: sub EXT_cache_status {
6411: my ($target_domain,$target_user) = @_;
1.383 albertel 6412: my $cachename = 'cache.EXT.'.$target_user.'.'.$target_domain;
1.620 albertel 6413: if (exists($env{$cachename}) && ($env{$cachename}+600) > time) {
1.379 matthew 6414: # We know already the user has no data
6415: return 1;
6416: } else {
6417: return 0;
6418: }
6419: }
6420:
6421: sub EXT_cache_set {
6422: my ($target_domain,$target_user) = @_;
1.383 albertel 6423: my $cachename = 'cache.EXT.'.$target_user.'.'.$target_domain;
1.633 albertel 6424: #&appenv($cachename => time);
1.379 matthew 6425: }
6426:
1.28 www 6427: # --------------------------------------------------------- Value of a Variable
1.58 www 6428: sub EXT {
1.715 albertel 6429:
1.395 albertel 6430: my ($varname,$symbparm,$udom,$uname,$usection,$recurse)=@_;
1.68 www 6431: unless ($varname) { return ''; }
1.218 albertel 6432: #get real user name/domain, courseid and symb
6433: my $courseid;
1.359 albertel 6434: my $publicuser;
1.427 www 6435: if ($symbparm) {
6436: $symbparm=&get_symb_from_alias($symbparm);
6437: }
1.218 albertel 6438: if (!($uname && $udom)) {
1.790 albertel 6439: (my $cursymb,$courseid,$udom,$uname,$publicuser)= &whichuser($symbparm);
1.218 albertel 6440: if (!$symbparm) { $symbparm=$cursymb; }
6441: } else {
1.620 albertel 6442: $courseid=$env{'request.course.id'};
1.218 albertel 6443: }
1.48 www 6444: my ($realm,$space,$qualifier,@therest)=split(/\./,$varname);
6445: my $rest;
1.320 albertel 6446: if (defined($therest[0])) {
1.48 www 6447: $rest=join('.',@therest);
6448: } else {
6449: $rest='';
6450: }
1.320 albertel 6451:
1.57 www 6452: my $qualifierrest=$qualifier;
6453: if ($rest) { $qualifierrest.='.'.$rest; }
6454: my $spacequalifierrest=$space;
6455: if ($qualifierrest) { $spacequalifierrest.='.'.$qualifierrest; }
1.28 www 6456: if ($realm eq 'user') {
1.48 www 6457: # --------------------------------------------------------------- user.resource
6458: if ($space eq 'resource') {
1.651 albertel 6459: if ( (defined($Apache::lonhomework::parsing_a_problem)
6460: || defined($Apache::lonhomework::parsing_a_task))
6461: &&
1.744 albertel 6462: ($symbparm eq &symbread()) ) {
6463: # if we are in the middle of processing the resource the
6464: # get the value we are planning on committing
6465: if (defined($Apache::lonhomework::results{$qualifierrest})) {
6466: return $Apache::lonhomework::results{$qualifierrest};
6467: } else {
6468: return $Apache::lonhomework::history{$qualifierrest};
6469: }
1.335 albertel 6470: } else {
1.359 albertel 6471: my %restored;
1.620 albertel 6472: if ($publicuser || $env{'request.state'} eq 'construct') {
1.359 albertel 6473: %restored=&tmprestore($symbparm,$courseid,$udom,$uname);
6474: } else {
6475: %restored=&restore($symbparm,$courseid,$udom,$uname);
6476: }
1.335 albertel 6477: return $restored{$qualifierrest};
6478: }
1.48 www 6479: # ----------------------------------------------------------------- user.access
6480: } elsif ($space eq 'access') {
1.218 albertel 6481: # FIXME - not supporting calls for a specific user
1.48 www 6482: return &allowed($qualifier,$rest);
6483: # ------------------------------------------ user.preferences, user.environment
6484: } elsif (($space eq 'preferences') || ($space eq 'environment')) {
1.620 albertel 6485: if (($uname eq $env{'user.name'}) &&
6486: ($udom eq $env{'user.domain'})) {
6487: return $env{join('.',('environment',$qualifierrest))};
1.218 albertel 6488: } else {
1.359 albertel 6489: my %returnhash;
6490: if (!$publicuser) {
6491: %returnhash=&userenvironment($udom,$uname,
6492: $qualifierrest);
6493: }
1.218 albertel 6494: return $returnhash{$qualifierrest};
6495: }
1.48 www 6496: # ----------------------------------------------------------------- user.course
6497: } elsif ($space eq 'course') {
1.218 albertel 6498: # FIXME - not supporting calls for a specific user
1.620 albertel 6499: return $env{join('.',('request.course',$qualifier))};
1.48 www 6500: # ------------------------------------------------------------------- user.role
6501: } elsif ($space eq 'role') {
1.218 albertel 6502: # FIXME - not supporting calls for a specific user
1.620 albertel 6503: my ($role,$where)=split(/\./,$env{'request.role'});
1.48 www 6504: if ($qualifier eq 'value') {
6505: return $role;
6506: } elsif ($qualifier eq 'extent') {
6507: return $where;
6508: }
6509: # ----------------------------------------------------------------- user.domain
6510: } elsif ($space eq 'domain') {
1.218 albertel 6511: return $udom;
1.48 www 6512: # ------------------------------------------------------------------- user.name
6513: } elsif ($space eq 'name') {
1.218 albertel 6514: return $uname;
1.48 www 6515: # ---------------------------------------------------- Any other user namespace
1.29 www 6516: } else {
1.359 albertel 6517: my %reply;
6518: if (!$publicuser) {
6519: %reply=&get($space,[$qualifierrest],$udom,$uname);
6520: }
6521: return $reply{$qualifierrest};
1.48 www 6522: }
1.236 www 6523: } elsif ($realm eq 'query') {
6524: # ---------------------------------------------- pull stuff out of query string
1.384 albertel 6525: &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},
6526: [$spacequalifierrest]);
1.620 albertel 6527: return $env{'form.'.$spacequalifierrest};
1.236 www 6528: } elsif ($realm eq 'request') {
1.48 www 6529: # ------------------------------------------------------------- request.browser
6530: if ($space eq 'browser') {
1.430 www 6531: if ($qualifier eq 'textremote') {
1.676 albertel 6532: if (&Apache::lonlocal::mt('textual_remote_display') eq 'on') {
1.430 www 6533: return 1;
6534: } else {
6535: return 0;
6536: }
6537: } else {
1.620 albertel 6538: return $env{'browser.'.$qualifier};
1.430 www 6539: }
1.57 www 6540: # ------------------------------------------------------------ request.filename
6541: } else {
1.620 albertel 6542: return $env{'request.'.$spacequalifierrest};
1.29 www 6543: }
1.28 www 6544: } elsif ($realm eq 'course') {
1.48 www 6545: # ---------------------------------------------------------- course.description
1.620 albertel 6546: return $env{'course.'.$courseid.'.'.$spacequalifierrest};
1.57 www 6547: } elsif ($realm eq 'resource') {
1.165 www 6548:
1.620 albertel 6549: if (defined($courseid) && $courseid eq $env{'request.course.id'}) {
1.539 albertel 6550: if (!$symbparm) { $symbparm=&symbread(); }
6551: }
1.693 albertel 6552:
6553: if ($space eq 'title') {
6554: if (!$symbparm) { $symbparm = $env{'request.filename'}; }
6555: return &gettitle($symbparm);
6556: }
6557:
6558: if ($space eq 'map') {
6559: my ($map) = &decode_symb($symbparm);
6560: return &symbread($map);
6561: }
1.905 albertel 6562: if ($space eq 'filename') {
6563: if ($symbparm) {
6564: return &clutter((&decode_symb($symbparm))[2]);
6565: }
6566: return &hreflocation('',$env{'request.filename'});
6567: }
1.693 albertel 6568:
6569: my ($section, $group, @groups);
1.593 albertel 6570: my ($courselevelm,$courselevel);
1.539 albertel 6571: if ($symbparm && defined($courseid) &&
1.620 albertel 6572: $courseid eq $env{'request.course.id'}) {
1.165 www 6573:
1.218 albertel 6574: #print '<br>'.$space.' - '.$qualifier.' - '.$spacequalifierrest;
1.165 www 6575:
1.60 www 6576: # ----------------------------------------------------- Cascading lookup scheme
1.218 albertel 6577: my $symbp=$symbparm;
1.735 albertel 6578: my $mapp=&deversion((&decode_symb($symbp))[0]);
1.218 albertel 6579:
6580: my $symbparm=$symbp.'.'.$spacequalifierrest;
6581: my $mapparm=$mapp.'___(all).'.$spacequalifierrest;
6582:
1.620 albertel 6583: if (($env{'user.name'} eq $uname) &&
6584: ($env{'user.domain'} eq $udom)) {
6585: $section=$env{'request.course.sec'};
1.733 raeburn 6586: @groups = split(/:/,$env{'request.course.groups'});
6587: @groups=&sort_course_groups($courseid,@groups);
1.218 albertel 6588: } else {
1.539 albertel 6589: if (! defined($usection)) {
1.551 albertel 6590: $section=&getsection($udom,$uname,$courseid);
1.539 albertel 6591: } else {
6592: $section = $usection;
6593: }
1.733 raeburn 6594: @groups = &get_users_groups($udom,$uname,$courseid);
1.218 albertel 6595: }
6596:
6597: my $seclevel=$courseid.'.['.$section.'].'.$spacequalifierrest;
6598: my $seclevelr=$courseid.'.['.$section.'].'.$symbparm;
6599: my $seclevelm=$courseid.'.['.$section.'].'.$mapparm;
6600:
1.593 albertel 6601: $courselevel=$courseid.'.'.$spacequalifierrest;
1.218 albertel 6602: my $courselevelr=$courseid.'.'.$symbparm;
1.593 albertel 6603: $courselevelm=$courseid.'.'.$mapparm;
1.69 www 6604:
1.60 www 6605: # ----------------------------------------------------------- first, check user
1.624 albertel 6606:
6607: my $userreply=&resdata($uname,$udom,'user',
6608: ($courselevelr,$courselevelm,
6609: $courselevel));
6610: if (defined($userreply)) { return $userreply; }
1.95 www 6611:
1.594 albertel 6612: # ------------------------------------------------ second, check some of course
1.684 raeburn 6613: my $coursereply;
1.691 raeburn 6614: if (@groups > 0) {
6615: $coursereply = &check_group_parms($courseid,\@groups,$symbparm,
6616: $mapparm,$spacequalifierrest);
1.684 raeburn 6617: if (defined($coursereply)) { return $coursereply; }
6618: }
1.96 www 6619:
1.684 raeburn 6620: $coursereply=&resdata($env{'course.'.$courseid.'.num'},
1.624 albertel 6621: $env{'course.'.$courseid.'.domain'},
6622: 'course',
6623: ($seclevelr,$seclevelm,$seclevel,
6624: $courselevelr));
1.287 albertel 6625: if (defined($coursereply)) { return $coursereply; }
1.200 www 6626:
1.60 www 6627: # ------------------------------------------------------ third, check map parms
1.218 albertel 6628: my %parmhash=();
6629: my $thisparm='';
6630: if (tie(%parmhash,'GDBM_File',
1.620 albertel 6631: $env{'request.course.fn'}.'_parms.db',
1.256 albertel 6632: &GDBM_READER(),0640)) {
1.218 albertel 6633: $thisparm=$parmhash{$symbparm};
6634: untie(%parmhash);
6635: }
6636: if ($thisparm) { return $thisparm; }
6637: }
1.594 albertel 6638: # ------------------------------------------ fourth, look in resource metadata
1.71 www 6639:
1.218 albertel 6640: $spacequalifierrest=~s/\./\_/;
1.282 albertel 6641: my $filename;
6642: if (!$symbparm) { $symbparm=&symbread(); }
6643: if ($symbparm) {
1.409 www 6644: $filename=(&decode_symb($symbparm))[2];
1.282 albertel 6645: } else {
1.620 albertel 6646: $filename=$env{'request.filename'};
1.282 albertel 6647: }
6648: my $metadata=&metadata($filename,$spacequalifierrest);
1.288 albertel 6649: if (defined($metadata)) { return $metadata; }
1.282 albertel 6650: $metadata=&metadata($filename,'parameter_'.$spacequalifierrest);
1.288 albertel 6651: if (defined($metadata)) { return $metadata; }
1.142 www 6652:
1.594 albertel 6653: # ---------------------------------------------- fourth, look in rest pf course
1.593 albertel 6654: if ($symbparm && defined($courseid) &&
1.620 albertel 6655: $courseid eq $env{'request.course.id'}) {
1.624 albertel 6656: my $coursereply=&resdata($env{'course.'.$courseid.'.num'},
6657: $env{'course.'.$courseid.'.domain'},
6658: 'course',
6659: ($courselevelm,$courselevel));
1.593 albertel 6660: if (defined($coursereply)) { return $coursereply; }
6661: }
1.145 www 6662: # ------------------------------------------------------------------ Cascade up
1.218 albertel 6663: unless ($space eq '0') {
1.336 albertel 6664: my @parts=split(/_/,$space);
6665: my $id=pop(@parts);
6666: my $part=join('_',@parts);
6667: if ($part eq '') { $part='0'; }
6668: my $partgeneral=&EXT('resource.'.$part.'.'.$qualifierrest,
1.395 albertel 6669: $symbparm,$udom,$uname,$section,1);
1.337 albertel 6670: if (defined($partgeneral)) { return $partgeneral; }
1.218 albertel 6671: }
1.395 albertel 6672: if ($recurse) { return undef; }
6673: my $pack_def=&packages_tab_default($filename,$varname);
6674: if (defined($pack_def)) { return $pack_def; }
1.71 www 6675:
1.48 www 6676: # ---------------------------------------------------- Any other user namespace
6677: } elsif ($realm eq 'environment') {
6678: # ----------------------------------------------------------------- environment
1.620 albertel 6679: if (($uname eq $env{'user.name'})&&($udom eq $env{'user.domain'})) {
6680: return $env{'environment.'.$spacequalifierrest};
1.219 albertel 6681: } else {
1.770 albertel 6682: if ($uname eq 'anonymous' && $udom eq '') {
6683: return '';
6684: }
1.219 albertel 6685: my %returnhash=&userenvironment($udom,$uname,
6686: $spacequalifierrest);
6687: return $returnhash{$spacequalifierrest};
6688: }
1.28 www 6689: } elsif ($realm eq 'system') {
1.48 www 6690: # ----------------------------------------------------------------- system.time
6691: if ($space eq 'time') {
6692: return time;
6693: }
1.696 albertel 6694: } elsif ($realm eq 'server') {
6695: # ----------------------------------------------------------------- system.time
6696: if ($space eq 'name') {
6697: return $ENV{'SERVER_NAME'};
6698: }
1.28 www 6699: }
1.48 www 6700: return '';
1.61 www 6701: }
6702:
1.691 raeburn 6703: sub check_group_parms {
6704: my ($courseid,$groups,$symbparm,$mapparm,$what) = @_;
6705: my @groupitems = ();
6706: my $resultitem;
6707: my @levels = ($symbparm,$mapparm,$what);
6708: foreach my $group (@{$groups}) {
6709: foreach my $level (@levels) {
6710: my $item = $courseid.'.['.$group.'].'.$level;
6711: push(@groupitems,$item);
6712: }
6713: }
6714: my $coursereply = &resdata($env{'course.'.$courseid.'.num'},
6715: $env{'course.'.$courseid.'.domain'},
6716: 'course',@groupitems);
6717: return $coursereply;
6718: }
6719:
6720: sub sort_course_groups { # Sort groups based on defined rankings. Default is sort().
1.733 raeburn 6721: my ($courseid,@groups) = @_;
6722: @groups = sort(@groups);
1.691 raeburn 6723: return @groups;
6724: }
6725:
1.395 albertel 6726: sub packages_tab_default {
6727: my ($uri,$varname)=@_;
6728: my (undef,$part,$name)=split(/\./,$varname);
1.738 albertel 6729:
6730: my (@extension,@specifics,$do_default);
6731: foreach my $package (split(/,/,&metadata($uri,'packages'))) {
1.395 albertel 6732: my ($pack_type,$pack_part)=split(/_/,$package,2);
1.738 albertel 6733: if ($pack_type eq 'default') {
6734: $do_default=1;
6735: } elsif ($pack_type eq 'extension') {
6736: push(@extension,[$package,$pack_type,$pack_part]);
1.885 albertel 6737: } elsif ($pack_part eq $part || $pack_type eq 'part') {
1.848 albertel 6738: # only look at packages defaults for packages that this id is
1.738 albertel 6739: push(@specifics,[$package,$pack_type,$pack_part]);
6740: }
6741: }
6742: # first look for a package that matches the requested part id
6743: foreach my $package (@specifics) {
6744: my (undef,$pack_type,$pack_part)=@{$package};
6745: next if ($pack_part ne $part);
6746: if (defined($packagetab{"$pack_type&$name&default"})) {
6747: return $packagetab{"$pack_type&$name&default"};
6748: }
6749: }
6750: # look for any possible matching non extension_ package
6751: foreach my $package (@specifics) {
6752: my (undef,$pack_type,$pack_part)=@{$package};
1.468 albertel 6753: if (defined($packagetab{"$pack_type&$name&default"})) {
6754: return $packagetab{"$pack_type&$name&default"};
6755: }
1.585 albertel 6756: if ($pack_type eq 'part') { $pack_part='0'; }
1.468 albertel 6757: if (defined($packagetab{$pack_type."_".$pack_part."&$name&default"})) {
6758: return $packagetab{$pack_type."_".$pack_part."&$name&default"};
1.395 albertel 6759: }
6760: }
1.738 albertel 6761: # look for any posible extension_ match
6762: foreach my $package (@extension) {
6763: my ($package,$pack_type)=@{$package};
6764: if (defined($packagetab{"$pack_type&$name&default"})) {
6765: return $packagetab{"$pack_type&$name&default"};
6766: }
6767: if (defined($packagetab{$package."&$name&default"})) {
6768: return $packagetab{$package."&$name&default"};
6769: }
6770: }
6771: # look for a global default setting
6772: if ($do_default && defined($packagetab{"default&$name&default"})) {
6773: return $packagetab{"default&$name&default"};
6774: }
1.395 albertel 6775: return undef;
6776: }
6777:
1.334 albertel 6778: sub add_prefix_and_part {
6779: my ($prefix,$part)=@_;
6780: my $keyroot;
6781: if (defined($prefix) && $prefix !~ /^__/) {
6782: # prefix that has a part already
6783: $keyroot=$prefix;
6784: } elsif (defined($prefix)) {
6785: # prefix that is missing a part
6786: if (defined($part)) { $keyroot='_'.$part.substr($prefix,1); }
6787: } else {
6788: # no prefix at all
6789: if (defined($part)) { $keyroot='_'.$part; }
6790: }
6791: return $keyroot;
6792: }
6793:
1.71 www 6794: # ---------------------------------------------------------------- Get metadata
6795:
1.599 albertel 6796: my %metaentry;
1.71 www 6797: sub metadata {
1.176 www 6798: my ($uri,$what,$liburi,$prefix,$depthcount)=@_;
1.71 www 6799: $uri=&declutter($uri);
1.288 albertel 6800: # if it is a non metadata possible uri return quickly
1.529 albertel 6801: if (($uri eq '') ||
6802: (($uri =~ m|^/*adm/|) &&
1.698 albertel 6803: ($uri !~ m|^adm/includes|) && ($uri !~ m|/bulletinboard$|)) ||
1.924 ! albertel 6804: ($uri =~ m|/$|) || ($uri =~ m|/.meta$|) ) {
! 6805: return undef;
! 6806: }
! 6807: if (($uri =~ /^~/ || $uri =~ m{home/$match_username/public_html/})
! 6808: && &Apache::lonxml::get_state('target') =~ /^(|meta)$/) {
1.468 albertel 6809: return undef;
1.288 albertel 6810: }
1.73 www 6811: my $filename=$uri;
6812: $uri=~s/\.meta$//;
1.172 www 6813: #
6814: # Is the metadata already cached?
1.177 www 6815: # Look at timestamp of caching
1.172 www 6816: # Everything is cached by the main uri, libraries are never directly cached
6817: #
1.428 albertel 6818: if (!defined($liburi)) {
1.599 albertel 6819: my ($result,$cached)=&is_cached_new('meta',$uri);
1.428 albertel 6820: if (defined($cached)) { return $result->{':'.$what}; }
6821: }
6822: {
1.172 www 6823: #
6824: # Is this a recursive call for a library?
6825: #
1.599 albertel 6826: # if (! exists($metacache{$uri})) {
6827: # $metacache{$uri}={};
6828: # }
1.924 ! albertel 6829: my $cachetime = 60*60;
1.171 www 6830: if ($liburi) {
6831: $liburi=&declutter($liburi);
6832: $filename=$liburi;
1.401 bowersj2 6833: } else {
1.599 albertel 6834: &devalidate_cache_new('meta',$uri);
6835: undef(%metaentry);
1.401 bowersj2 6836: }
1.140 www 6837: my %metathesekeys=();
1.73 www 6838: unless ($filename=~/\.meta$/) { $filename.='.meta'; }
1.489 albertel 6839: my $metastring;
1.924 ! albertel 6840: if ($uri =~ /^~/ || $uri =~ m{home/$match_username/public_html/}) {
! 6841: $metastring =
! 6842: &Apache::lonnet::ssi_body(&hreflocation('','/'.$uri),
! 6843: ('grade_target' => 'meta'));
! 6844: $cachetime = 1; # only want this cached in the child not long term
! 6845: } elsif ($uri !~ m -^(editupload)/-) {
1.543 albertel 6846: my $file=&filelocation('',&clutter($filename));
1.599 albertel 6847: #push(@{$metaentry{$uri.'.file'}},$file);
1.543 albertel 6848: $metastring=&getfile($file);
1.489 albertel 6849: }
1.208 albertel 6850: my $parser=HTML::LCParser->new(\$metastring);
1.71 www 6851: my $token;
1.140 www 6852: undef %metathesekeys;
1.71 www 6853: while ($token=$parser->get_token) {
1.339 albertel 6854: if ($token->[0] eq 'S') {
6855: if (defined($token->[2]->{'package'})) {
1.172 www 6856: #
6857: # This is a package - get package info
6858: #
1.339 albertel 6859: my $package=$token->[2]->{'package'};
6860: my $keyroot=&add_prefix_and_part($prefix,$token->[2]->{'part'});
6861: if (defined($token->[2]->{'id'})) {
6862: $keyroot.='_'.$token->[2]->{'id'};
6863: }
1.599 albertel 6864: if ($metaentry{':packages'}) {
6865: $metaentry{':packages'}.=','.$package.$keyroot;
1.339 albertel 6866: } else {
1.599 albertel 6867: $metaentry{':packages'}=$package.$keyroot;
1.339 albertel 6868: }
1.736 albertel 6869: foreach my $pack_entry (keys(%packagetab)) {
1.432 albertel 6870: my $part=$keyroot;
6871: $part=~s/^\_//;
1.736 albertel 6872: if ($pack_entry=~/^\Q$package\E\&/ ||
6873: $pack_entry=~/^\Q$package\E_0\&/) {
6874: my ($pack,$name,$subp)=split(/\&/,$pack_entry);
1.395 albertel 6875: # ignore package.tab specified default values
6876: # here &package_tab_default() will fetch those
6877: if ($subp eq 'default') { next; }
1.736 albertel 6878: my $value=$packagetab{$pack_entry};
1.432 albertel 6879: my $unikey;
6880: if ($pack =~ /_0$/) {
6881: $unikey='parameter_0_'.$name;
6882: $part=0;
6883: } else {
6884: $unikey='parameter'.$keyroot.'_'.$name;
6885: }
1.339 albertel 6886: if ($subp eq 'display') {
6887: $value.=' [Part: '.$part.']';
6888: }
1.599 albertel 6889: $metaentry{':'.$unikey.'.part'}=$part;
1.395 albertel 6890: $metathesekeys{$unikey}=1;
1.599 albertel 6891: unless (defined($metaentry{':'.$unikey.'.'.$subp})) {
6892: $metaentry{':'.$unikey.'.'.$subp}=$value;
1.339 albertel 6893: }
1.599 albertel 6894: if (defined($metaentry{':'.$unikey.'.default'})) {
6895: $metaentry{':'.$unikey}=
6896: $metaentry{':'.$unikey.'.default'};
1.356 albertel 6897: }
1.339 albertel 6898: }
6899: }
6900: } else {
1.172 www 6901: #
6902: # This is not a package - some other kind of start tag
1.339 albertel 6903: #
6904: my $entry=$token->[1];
6905: my $unikey;
6906: if ($entry eq 'import') {
6907: $unikey='';
6908: } else {
6909: $unikey=$entry;
6910: }
6911: $unikey.=&add_prefix_and_part($prefix,$token->[2]->{'part'});
6912:
6913: if (defined($token->[2]->{'id'})) {
6914: $unikey.='_'.$token->[2]->{'id'};
6915: }
1.175 www 6916:
1.339 albertel 6917: if ($entry eq 'import') {
1.175 www 6918: #
6919: # Importing a library here
1.339 albertel 6920: #
6921: if ($depthcount<20) {
6922: my $location=$parser->get_text('/import');
6923: my $dir=$filename;
6924: $dir=~s|[^/]*$||;
6925: $location=&filelocation($dir,$location);
1.736 albertel 6926: my $metadata =
6927: &metadata($uri,'keys', $location,$unikey,
6928: $depthcount+1);
6929: foreach my $meta (split(',',$metadata)) {
6930: $metaentry{':'.$meta}=$metaentry{':'.$meta};
6931: $metathesekeys{$meta}=1;
1.339 albertel 6932: }
6933: }
6934: } else {
6935:
6936: if (defined($token->[2]->{'name'})) {
6937: $unikey.='_'.$token->[2]->{'name'};
6938: }
6939: $metathesekeys{$unikey}=1;
1.736 albertel 6940: foreach my $param (@{$token->[3]}) {
6941: $metaentry{':'.$unikey.'.'.$param} =
6942: $token->[2]->{$param};
1.339 albertel 6943: }
6944: my $internaltext=&HTML::Entities::decode($parser->get_text('/'.$entry));
1.599 albertel 6945: my $default=$metaentry{':'.$unikey.'.default'};
1.339 albertel 6946: if ( $internaltext =~ /^\s*$/ && $default !~ /^\s*$/) {
6947: # only ws inside the tag, and not in default, so use default
6948: # as value
1.599 albertel 6949: $metaentry{':'.$unikey}=$default;
1.908 albertel 6950: } elsif ( $internaltext =~ /\S/ ) {
6951: # something interesting inside the tag
6952: $metaentry{':'.$unikey}=$internaltext;
1.339 albertel 6953: } else {
1.908 albertel 6954: # no interesting values, don't set a default
1.339 albertel 6955: }
1.172 www 6956: # end of not-a-package not-a-library import
1.339 albertel 6957: }
1.172 www 6958: # end of not-a-package start tag
1.339 albertel 6959: }
1.172 www 6960: # the next is the end of "start tag"
1.339 albertel 6961: }
6962: }
1.483 albertel 6963: my ($extension) = ($uri =~ /\.(\w+)$/);
1.883 albertel 6964: $extension = lc($extension);
6965: if ($extension eq 'htm') { $extension='html'; }
6966:
1.737 albertel 6967: foreach my $key (keys(%packagetab)) {
1.483 albertel 6968: #no specific packages #how's our extension
6969: if ($key!~/^extension_\Q$extension\E&/) { next; }
1.488 albertel 6970: &metadata_create_package_def($uri,$key,'extension_'.$extension,
1.483 albertel 6971: \%metathesekeys);
6972: }
1.883 albertel 6973:
6974: if (!exists($metaentry{':packages'})
6975: || $packagetab{"import_defaults&extension_$extension"}) {
1.737 albertel 6976: foreach my $key (keys(%packagetab)) {
1.483 albertel 6977: #no specific packages well let's get default then
6978: if ($key!~/^default&/) { next; }
1.488 albertel 6979: &metadata_create_package_def($uri,$key,'default',
1.483 albertel 6980: \%metathesekeys);
6981: }
6982: }
1.338 www 6983: # are there custom rights to evaluate
1.599 albertel 6984: if ($metaentry{':copyright'} eq 'custom') {
1.339 albertel 6985:
1.338 www 6986: #
6987: # Importing a rights file here
1.339 albertel 6988: #
6989: unless ($depthcount) {
1.599 albertel 6990: my $location=$metaentry{':customdistributionfile'};
1.339 albertel 6991: my $dir=$filename;
6992: $dir=~s|[^/]*$||;
6993: $location=&filelocation($dir,$location);
1.736 albertel 6994: my $rights_metadata =
6995: &metadata($uri,'keys',$location,'_rights',
6996: $depthcount+1);
6997: foreach my $rights (split(',',$rights_metadata)) {
6998: #$metaentry{':'.$rights}=$metacache{$uri}->{':'.$rights};
6999: $metathesekeys{$rights}=1;
1.339 albertel 7000: }
7001: }
7002: }
1.737 albertel 7003: # uniqifiy package listing
7004: my %seen;
7005: my @uniq_packages =
7006: grep { ! $seen{$_} ++ } (split(',',$metaentry{':packages'}));
7007: $metaentry{':packages'} = join(',',@uniq_packages);
7008:
7009: $metaentry{':keys'} = join(',',keys(%metathesekeys));
1.599 albertel 7010: &metadata_generate_part0(\%metathesekeys,\%metaentry,$uri);
7011: $metaentry{':allpossiblekeys'}=join(',',keys %metathesekeys);
1.924 ! albertel 7012: &do_cache_new('meta',$uri,\%metaentry,$cachetime);
1.177 www 7013: # this is the end of "was not already recently cached
1.71 www 7014: }
1.599 albertel 7015: return $metaentry{':'.$what};
1.261 albertel 7016: }
7017:
1.488 albertel 7018: sub metadata_create_package_def {
1.483 albertel 7019: my ($uri,$key,$package,$metathesekeys)=@_;
7020: my ($pack,$name,$subp)=split(/\&/,$key);
7021: if ($subp eq 'default') { next; }
7022:
1.599 albertel 7023: if (defined($metaentry{':packages'})) {
7024: $metaentry{':packages'}.=','.$package;
1.483 albertel 7025: } else {
1.599 albertel 7026: $metaentry{':packages'}=$package;
1.483 albertel 7027: }
7028: my $value=$packagetab{$key};
7029: my $unikey;
7030: $unikey='parameter_0_'.$name;
1.599 albertel 7031: $metaentry{':'.$unikey.'.part'}=0;
1.483 albertel 7032: $$metathesekeys{$unikey}=1;
1.599 albertel 7033: unless (defined($metaentry{':'.$unikey.'.'.$subp})) {
7034: $metaentry{':'.$unikey.'.'.$subp}=$value;
1.483 albertel 7035: }
1.599 albertel 7036: if (defined($metaentry{':'.$unikey.'.default'})) {
7037: $metaentry{':'.$unikey}=
7038: $metaentry{':'.$unikey.'.default'};
1.483 albertel 7039: }
7040: }
7041:
1.261 albertel 7042: sub metadata_generate_part0 {
7043: my ($metadata,$metacache,$uri) = @_;
7044: my %allnames;
1.737 albertel 7045: foreach my $metakey (keys(%$metadata)) {
1.261 albertel 7046: if ($metakey=~/^parameter\_(.*)/) {
1.428 albertel 7047: my $part=$$metacache{':'.$metakey.'.part'};
7048: my $name=$$metacache{':'.$metakey.'.name'};
1.356 albertel 7049: if (! exists($$metadata{'parameter_0_'.$name.'.name'})) {
1.261 albertel 7050: $allnames{$name}=$part;
7051: }
7052: }
7053: }
7054: foreach my $name (keys(%allnames)) {
7055: $$metadata{"parameter_0_$name"}=1;
1.428 albertel 7056: my $key=":parameter_0_$name";
1.261 albertel 7057: $$metacache{"$key.part"}='0';
7058: $$metacache{"$key.name"}=$name;
1.428 albertel 7059: $$metacache{"$key.type"}=$$metacache{':parameter_'.
1.261 albertel 7060: $allnames{$name}.'_'.$name.
7061: '.type'};
1.428 albertel 7062: my $olddis=$$metacache{':parameter_'.$allnames{$name}.'_'.$name.
1.261 albertel 7063: '.display'};
1.644 www 7064: my $expr='[Part: '.$allnames{$name}.']';
1.479 albertel 7065: $olddis=~s/\Q$expr\E/\[Part: 0\]/;
1.261 albertel 7066: $$metacache{"$key.display"}=$olddis;
7067: }
1.71 www 7068: }
7069:
1.764 albertel 7070: # ------------------------------------------------------ Devalidate title cache
7071:
7072: sub devalidate_title_cache {
7073: my ($url)=@_;
7074: if (!$env{'request.course.id'}) { return; }
7075: my $symb=&symbread($url);
7076: if (!$symb) { return; }
7077: my $key=$env{'request.course.id'}."\0".$symb;
7078: &devalidate_cache_new('title',$key);
7079: }
7080:
1.301 www 7081: # ------------------------------------------------- Get the title of a resource
7082:
7083: sub gettitle {
7084: my $urlsymb=shift;
7085: my $symb=&symbread($urlsymb);
1.534 albertel 7086: if ($symb) {
1.620 albertel 7087: my $key=$env{'request.course.id'}."\0".$symb;
1.599 albertel 7088: my ($result,$cached)=&is_cached_new('title',$key);
1.575 albertel 7089: if (defined($cached)) {
7090: return $result;
7091: }
1.534 albertel 7092: my ($map,$resid,$url)=&decode_symb($symb);
7093: my $title='';
1.907 albertel 7094: if (!$map && $resid == 0 && $url =~/default\.sequence$/) {
7095: $title = $env{'course.'.$env{'request.course.id'}.'.description'};
7096: } else {
7097: if (tie(my %bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
7098: &GDBM_READER(),0640)) {
7099: my $mapid=$bighash{'map_pc_'.&clutter($map)};
7100: $title=$bighash{'title_'.$mapid.'.'.$resid};
7101: untie(%bighash);
7102: }
1.534 albertel 7103: }
7104: $title=~s/\&colon\;/\:/gs;
7105: if ($title) {
1.599 albertel 7106: return &do_cache_new('title',$key,$title,600);
1.534 albertel 7107: }
7108: $urlsymb=$url;
7109: }
7110: my $title=&metadata($urlsymb,'title');
7111: if (!$title) { $title=(split('/',$urlsymb))[-1]; }
7112: return $title;
1.301 www 7113: }
1.613 albertel 7114:
1.614 albertel 7115: sub get_slot {
7116: my ($which,$cnum,$cdom)=@_;
7117: if (!$cnum || !$cdom) {
1.790 albertel 7118: (undef,my $courseid)=&whichuser();
1.620 albertel 7119: $cdom=$env{'course.'.$courseid.'.domain'};
7120: $cnum=$env{'course.'.$courseid.'.num'};
1.614 albertel 7121: }
1.703 albertel 7122: my $key=join("\0",'slots',$cdom,$cnum,$which);
7123: my %slotinfo;
7124: if (exists($remembered{$key})) {
7125: $slotinfo{$which} = $remembered{$key};
7126: } else {
7127: %slotinfo=&get('slots',[$which],$cdom,$cnum);
7128: &Apache::lonhomework::showhash(%slotinfo);
7129: my ($tmp)=keys(%slotinfo);
7130: if ($tmp=~/^error:/) { return (); }
7131: $remembered{$key} = $slotinfo{$which};
7132: }
1.616 albertel 7133: if (ref($slotinfo{$which}) eq 'HASH') {
7134: return %{$slotinfo{$which}};
7135: }
7136: return $slotinfo{$which};
1.614 albertel 7137: }
1.31 www 7138: # ------------------------------------------------- Update symbolic store links
7139:
7140: sub symblist {
7141: my ($mapname,%newhash)=@_;
1.438 www 7142: $mapname=&deversion(&declutter($mapname));
1.31 www 7143: my %hash;
1.620 albertel 7144: if (($env{'request.course.fn'}) && (%newhash)) {
7145: if (tie(%hash,'GDBM_File',$env{'request.course.fn'}.'_symb.db',
1.256 albertel 7146: &GDBM_WRCREAT(),0640)) {
1.711 albertel 7147: foreach my $url (keys %newhash) {
7148: next if ($url eq 'last_known'
7149: && $env{'form.no_update_last_known'});
7150: $hash{declutter($url)}=&encode_symb($mapname,
7151: $newhash{$url}->[1],
7152: $newhash{$url}->[0]);
1.191 harris41 7153: }
1.31 www 7154: if (untie(%hash)) {
7155: return 'ok';
7156: }
7157: }
7158: }
7159: return 'error';
1.212 www 7160: }
7161:
7162: # --------------------------------------------------------------- Verify a symb
7163:
7164: sub symbverify {
1.510 www 7165: my ($symb,$thisurl)=@_;
7166: my $thisfn=$thisurl;
1.439 www 7167: $thisfn=&declutter($thisfn);
1.215 www 7168: # direct jump to resource in page or to a sequence - will construct own symbs
7169: if ($thisfn=~/\.(page|sequence)$/) { return 1; }
7170: # check URL part
1.409 www 7171: my ($map,$resid,$url)=&decode_symb($symb);
1.439 www 7172:
1.431 www 7173: unless ($url eq $thisfn) { return 0; }
1.213 www 7174:
1.216 www 7175: $symb=&symbclean($symb);
1.510 www 7176: $thisurl=&deversion($thisurl);
1.439 www 7177: $thisfn=&deversion($thisfn);
1.213 www 7178:
7179: my %bighash;
7180: my $okay=0;
1.431 www 7181:
1.620 albertel 7182: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
1.256 albertel 7183: &GDBM_READER(),0640)) {
1.510 www 7184: my $ids=$bighash{'ids_'.&clutter($thisurl)};
1.216 www 7185: unless ($ids) {
1.510 www 7186: $ids=$bighash{'ids_/'.$thisurl};
1.216 www 7187: }
7188: if ($ids) {
7189: # ------------------------------------------------------------------- Has ID(s)
1.800 albertel 7190: foreach my $id (split(/\,/,$ids)) {
7191: my ($mapid,$resid)=split(/\./,$id);
1.216 www 7192: if (
7193: &symbclean(&declutter($bighash{'map_id_'.$mapid}).'___'.$resid.'___'.$thisfn)
7194: eq $symb) {
1.620 albertel 7195: if (($env{'request.role.adv'}) ||
1.800 albertel 7196: $bighash{'encrypted_'.$id} eq $env{'request.enc'}) {
1.582 albertel 7197: $okay=1;
7198: }
7199: }
1.216 www 7200: }
7201: }
1.213 www 7202: untie(%bighash);
7203: }
7204: return $okay;
1.31 www 7205: }
7206:
1.210 www 7207: # --------------------------------------------------------------- Clean-up symb
7208:
7209: sub symbclean {
7210: my $symb=shift;
1.568 albertel 7211: if ($symb=~m|^/enc/|) { $symb=&Apache::lonenc::unencrypted($symb); }
1.210 www 7212: # remove version from map
7213: $symb=~s/\.(\d+)\.(\w+)\_\_\_/\.$2\_\_\_/;
1.215 www 7214:
1.210 www 7215: # remove version from URL
7216: $symb=~s/\.(\d+)\.(\w+)$/\.$2/;
1.213 www 7217:
1.507 www 7218: # remove wrapper
7219:
1.510 www 7220: $symb=~s/(\_\_\_\d+\_\_\_)adm\/wrapper\/(res\/)*/$1/;
1.694 albertel 7221: $symb=~s/(\_\_\_\d+\_\_\_)adm\/coursedocs\/showdoc\/(res\/)*/$1/;
1.210 www 7222: return $symb;
1.409 www 7223: }
7224:
7225: # ---------------------------------------------- Split symb to find map and url
1.429 albertel 7226:
7227: sub encode_symb {
7228: my ($map,$resid,$url)=@_;
7229: return &symbclean(&declutter($map).'___'.$resid.'___'.&declutter($url));
7230: }
1.409 www 7231:
7232: sub decode_symb {
1.568 albertel 7233: my $symb=shift;
7234: if ($symb=~m|^/enc/|) { $symb=&Apache::lonenc::unencrypted($symb); }
7235: my ($map,$resid,$url)=split(/___/,$symb);
1.413 www 7236: return (&fixversion($map),$resid,&fixversion($url));
7237: }
7238:
7239: sub fixversion {
7240: my $fn=shift;
1.609 banghart 7241: if ($fn=~/^(adm|uploaded|editupload|public)/) { return $fn; }
1.435 www 7242: my %bighash;
7243: my $uri=&clutter($fn);
1.620 albertel 7244: my $key=$env{'request.course.id'}.'_'.$uri;
1.440 www 7245: # is this cached?
1.599 albertel 7246: my ($result,$cached)=&is_cached_new('courseresversion',$key);
1.440 www 7247: if (defined($cached)) { return $result; }
7248: # unfortunately not cached, or expired
1.620 albertel 7249: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
1.440 www 7250: &GDBM_READER(),0640)) {
7251: if ($bighash{'version_'.$uri}) {
7252: my $version=$bighash{'version_'.$uri};
1.444 www 7253: unless (($version eq 'mostrecent') ||
7254: ($version==&getversion($uri))) {
1.440 www 7255: $uri=~s/\.(\w+)$/\.$version\.$1/;
7256: }
7257: }
7258: untie %bighash;
1.413 www 7259: }
1.599 albertel 7260: return &do_cache_new('courseresversion',$key,&declutter($uri),600);
1.438 www 7261: }
7262:
7263: sub deversion {
7264: my $url=shift;
7265: $url=~s/\.\d+\.(\w+)$/\.$1/;
7266: return $url;
1.210 www 7267: }
7268:
1.31 www 7269: # ------------------------------------------------------ Return symb list entry
7270:
7271: sub symbread {
1.249 www 7272: my ($thisfn,$donotrecurse)=@_;
1.542 albertel 7273: my $cache_str='request.symbread.cached.'.$thisfn;
1.620 albertel 7274: if (defined($env{$cache_str})) { return $env{$cache_str}; }
1.242 www 7275: # no filename provided? try from environment
1.44 www 7276: unless ($thisfn) {
1.620 albertel 7277: if ($env{'request.symb'}) {
7278: return $env{$cache_str}=&symbclean($env{'request.symb'});
1.539 albertel 7279: }
1.620 albertel 7280: $thisfn=$env{'request.filename'};
1.44 www 7281: }
1.569 albertel 7282: if ($thisfn=~m|^/enc/|) { $thisfn=&Apache::lonenc::unencrypted($thisfn); }
1.242 www 7283: # is that filename actually a symb? Verify, clean, and return
7284: if ($thisfn=~/\_\_\_\d+\_\_\_(.*)$/) {
1.539 albertel 7285: if (&symbverify($thisfn,$1)) {
1.620 albertel 7286: return $env{$cache_str}=&symbclean($thisfn);
1.539 albertel 7287: }
1.242 www 7288: }
1.44 www 7289: $thisfn=declutter($thisfn);
1.31 www 7290: my %hash;
1.37 www 7291: my %bighash;
7292: my $syval='';
1.620 albertel 7293: if (($env{'request.course.fn'}) && ($thisfn)) {
1.481 raeburn 7294: my $targetfn = $thisfn;
1.609 banghart 7295: if ( ($thisfn =~ m/^(uploaded|editupload)\//) && ($thisfn !~ m/\.(page|sequence)$/) ) {
1.481 raeburn 7296: $targetfn = 'adm/wrapper/'.$thisfn;
7297: }
1.687 albertel 7298: if ($targetfn =~ m|^adm/wrapper/(ext/.*)|) {
7299: $targetfn=$1;
7300: }
1.620 albertel 7301: if (tie(%hash,'GDBM_File',$env{'request.course.fn'}.'_symb.db',
1.256 albertel 7302: &GDBM_READER(),0640)) {
1.481 raeburn 7303: $syval=$hash{$targetfn};
1.37 www 7304: untie(%hash);
7305: }
7306: # ---------------------------------------------------------- There was an entry
7307: if ($syval) {
1.601 albertel 7308: #unless ($syval=~/\_\d+$/) {
1.620 albertel 7309: #unless ($env{'form.request.prefix'}=~/\.(\d+)\_$/) {
1.601 albertel 7310: #&appenv('request.ambiguous' => $thisfn);
1.620 albertel 7311: #return $env{$cache_str}='';
1.601 albertel 7312: #}
7313: #$syval.=$1;
7314: #}
1.37 www 7315: } else {
7316: # ------------------------------------------------------- Was not in symb table
1.620 albertel 7317: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
1.256 albertel 7318: &GDBM_READER(),0640)) {
1.37 www 7319: # ---------------------------------------------- Get ID(s) for current resource
1.280 www 7320: my $ids=$bighash{'ids_'.&clutter($thisfn)};
1.65 www 7321: unless ($ids) {
7322: $ids=$bighash{'ids_/'.$thisfn};
1.242 www 7323: }
7324: unless ($ids) {
7325: # alias?
7326: $ids=$bighash{'mapalias_'.$thisfn};
1.65 www 7327: }
1.37 www 7328: if ($ids) {
7329: # ------------------------------------------------------------------- Has ID(s)
7330: my @possibilities=split(/\,/,$ids);
1.39 www 7331: if ($#possibilities==0) {
7332: # ----------------------------------------------- There is only one possibility
1.37 www 7333: my ($mapid,$resid)=split(/\./,$ids);
1.626 albertel 7334: $syval=&encode_symb($bighash{'map_id_'.$mapid},
7335: $resid,$thisfn);
1.249 www 7336: } elsif (!$donotrecurse) {
1.39 www 7337: # ------------------------------------------ There is more than one possibility
7338: my $realpossible=0;
1.800 albertel 7339: foreach my $id (@possibilities) {
7340: my $file=$bighash{'src_'.$id};
1.39 www 7341: if (&allowed('bre',$file)) {
1.800 albertel 7342: my ($mapid,$resid)=split(/\./,$id);
1.39 www 7343: if ($bighash{'map_type_'.$mapid} ne 'page') {
7344: $realpossible++;
1.626 albertel 7345: $syval=&encode_symb($bighash{'map_id_'.$mapid},
7346: $resid,$thisfn);
1.39 www 7347: }
7348: }
1.191 harris41 7349: }
1.39 www 7350: if ($realpossible!=1) { $syval=''; }
1.249 www 7351: } else {
7352: $syval='';
1.37 www 7353: }
7354: }
7355: untie(%bighash)
1.481 raeburn 7356: }
1.31 www 7357: }
1.62 www 7358: if ($syval) {
1.620 albertel 7359: return $env{$cache_str}=$syval;
1.62 www 7360: }
1.31 www 7361: }
1.44 www 7362: &appenv('request.ambiguous' => $thisfn);
1.620 albertel 7363: return $env{$cache_str}='';
1.31 www 7364: }
7365:
7366: # ---------------------------------------------------------- Return random seed
7367:
1.32 www 7368: sub numval {
7369: my $txt=shift;
7370: $txt=~tr/A-J/0-9/;
7371: $txt=~tr/a-j/0-9/;
7372: $txt=~tr/K-T/0-9/;
7373: $txt=~tr/k-t/0-9/;
7374: $txt=~tr/U-Z/0-5/;
7375: $txt=~tr/u-z/0-5/;
7376: $txt=~s/\D//g;
1.564 albertel 7377: if ($_64bit) { if ($txt > 2**32) { return -1; } }
1.32 www 7378: return int($txt);
1.368 albertel 7379: }
7380:
1.484 albertel 7381: sub numval2 {
7382: my $txt=shift;
7383: $txt=~tr/A-J/0-9/;
7384: $txt=~tr/a-j/0-9/;
7385: $txt=~tr/K-T/0-9/;
7386: $txt=~tr/k-t/0-9/;
7387: $txt=~tr/U-Z/0-5/;
7388: $txt=~tr/u-z/0-5/;
7389: $txt=~s/\D//g;
7390: my @txts=split(/(\d\d\d\d\d\d\d\d\d)/,$txt);
7391: my $total;
7392: foreach my $val (@txts) { $total+=$val; }
1.564 albertel 7393: if ($_64bit) { if ($total > 2**32) { return -1; } }
1.484 albertel 7394: return int($total);
7395: }
7396:
1.575 albertel 7397: sub numval3 {
7398: use integer;
7399: my $txt=shift;
7400: $txt=~tr/A-J/0-9/;
7401: $txt=~tr/a-j/0-9/;
7402: $txt=~tr/K-T/0-9/;
7403: $txt=~tr/k-t/0-9/;
7404: $txt=~tr/U-Z/0-5/;
7405: $txt=~tr/u-z/0-5/;
7406: $txt=~s/\D//g;
7407: my @txts=split(/(\d\d\d\d\d\d\d\d\d)/,$txt);
7408: my $total;
7409: foreach my $val (@txts) { $total+=$val; }
7410: if ($_64bit) { $total=(($total<<32)>>32); }
7411: return $total;
7412: }
7413:
1.675 albertel 7414: sub digest {
7415: my ($data)=@_;
7416: my $digest=&Digest::MD5::md5($data);
7417: my ($a,$b,$c,$d)=unpack("iiii",$digest);
7418: my ($e,$f);
7419: {
7420: use integer;
7421: $e=($a+$b);
7422: $f=($c+$d);
7423: if ($_64bit) {
7424: $e=(($e<<32)>>32);
7425: $f=(($f<<32)>>32);
7426: }
7427: }
7428: if (wantarray) {
7429: return ($e,$f);
7430: } else {
7431: my $g;
7432: {
7433: use integer;
7434: $g=($e+$f);
7435: if ($_64bit) {
7436: $g=(($g<<32)>>32);
7437: }
7438: }
7439: return $g;
7440: }
7441: }
7442:
1.368 albertel 7443: sub latest_rnd_algorithm_id {
1.675 albertel 7444: return '64bit5';
1.366 albertel 7445: }
1.32 www 7446:
1.503 albertel 7447: sub get_rand_alg {
7448: my ($courseid)=@_;
1.790 albertel 7449: if (!$courseid) { $courseid=(&whichuser())[1]; }
1.503 albertel 7450: if ($courseid) {
1.620 albertel 7451: return $env{"course.$courseid.rndseed"};
1.503 albertel 7452: }
7453: return &latest_rnd_algorithm_id();
7454: }
7455:
1.562 albertel 7456: sub validCODE {
7457: my ($CODE)=@_;
7458: if (defined($CODE) && $CODE ne '' && $CODE =~ /^\w+$/) { return 1; }
7459: return 0;
7460: }
7461:
1.491 albertel 7462: sub getCODE {
1.620 albertel 7463: if (&validCODE($env{'form.CODE'})) { return $env{'form.CODE'}; }
1.618 albertel 7464: if ( (defined($Apache::lonhomework::parsing_a_problem) ||
7465: defined($Apache::lonhomework::parsing_a_task) ) &&
7466: &validCODE($Apache::lonhomework::history{'resource.CODE'})) {
1.491 albertel 7467: return $Apache::lonhomework::history{'resource.CODE'};
7468: }
7469: return undef;
7470: }
7471:
1.31 www 7472: sub rndseed {
1.155 albertel 7473: my ($symb,$courseid,$domain,$username)=@_;
1.790 albertel 7474: my ($wsymb,$wcourseid,$wdomain,$wusername)=&whichuser();
1.896 albertel 7475: if (!defined($symb)) {
1.366 albertel 7476: unless ($symb=$wsymb) { return time; }
7477: }
7478: if (!$courseid) { $courseid=$wcourseid; }
7479: if (!$domain) { $domain=$wdomain; }
7480: if (!$username) { $username=$wusername }
1.503 albertel 7481: my $which=&get_rand_alg();
1.803 albertel 7482:
1.491 albertel 7483: if (defined(&getCODE())) {
1.675 albertel 7484: if ($which eq '64bit5') {
7485: return &rndseed_CODE_64bit5($symb,$courseid,$domain,$username);
7486: } elsif ($which eq '64bit4') {
1.575 albertel 7487: return &rndseed_CODE_64bit4($symb,$courseid,$domain,$username);
7488: } else {
7489: return &rndseed_CODE_64bit($symb,$courseid,$domain,$username);
7490: }
1.675 albertel 7491: } elsif ($which eq '64bit5') {
7492: return &rndseed_64bit5($symb,$courseid,$domain,$username);
1.575 albertel 7493: } elsif ($which eq '64bit4') {
7494: return &rndseed_64bit4($symb,$courseid,$domain,$username);
1.501 albertel 7495: } elsif ($which eq '64bit3') {
7496: return &rndseed_64bit3($symb,$courseid,$domain,$username);
1.443 albertel 7497: } elsif ($which eq '64bit2') {
7498: return &rndseed_64bit2($symb,$courseid,$domain,$username);
1.366 albertel 7499: } elsif ($which eq '64bit') {
7500: return &rndseed_64bit($symb,$courseid,$domain,$username);
7501: }
7502: return &rndseed_32bit($symb,$courseid,$domain,$username);
7503: }
7504:
7505: sub rndseed_32bit {
7506: my ($symb,$courseid,$domain,$username)=@_;
7507: {
7508: use integer;
7509: my $symbchck=unpack("%32C*",$symb) << 27;
7510: my $symbseed=numval($symb) << 22;
7511: my $namechck=unpack("%32C*",$username) << 17;
7512: my $nameseed=numval($username) << 12;
7513: my $domainseed=unpack("%32C*",$domain) << 7;
7514: my $courseseed=unpack("%32C*",$courseid);
7515: my $num=$symbseed+$nameseed+$domainseed+$courseseed+$namechck+$symbchck;
1.790 albertel 7516: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
7517: #&logthis("rndseed :$num:$symb");
1.564 albertel 7518: if ($_64bit) { $num=(($num<<32)>>32); }
1.366 albertel 7519: return $num;
7520: }
7521: }
7522:
7523: sub rndseed_64bit {
7524: my ($symb,$courseid,$domain,$username)=@_;
7525: {
7526: use integer;
7527: my $symbchck=unpack("%32S*",$symb) << 21;
7528: my $symbseed=numval($symb) << 10;
7529: my $namechck=unpack("%32S*",$username);
7530:
7531: my $nameseed=numval($username) << 21;
7532: my $domainseed=unpack("%32S*",$domain) << 10;
7533: my $courseseed=unpack("%32S*",$courseid);
7534:
7535: my $num1=$symbchck+$symbseed+$namechck;
7536: my $num2=$nameseed+$domainseed+$courseseed;
1.790 albertel 7537: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
7538: #&logthis("rndseed :$num:$symb");
1.564 albertel 7539: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
1.366 albertel 7540: return "$num1,$num2";
1.155 albertel 7541: }
1.366 albertel 7542: }
7543:
1.443 albertel 7544: sub rndseed_64bit2 {
7545: my ($symb,$courseid,$domain,$username)=@_;
7546: {
7547: use integer;
7548: # strings need to be an even # of cahracters long, it it is odd the
7549: # last characters gets thrown away
7550: my $symbchck=unpack("%32S*",$symb.' ') << 21;
7551: my $symbseed=numval($symb) << 10;
7552: my $namechck=unpack("%32S*",$username.' ');
7553:
7554: my $nameseed=numval($username) << 21;
1.501 albertel 7555: my $domainseed=unpack("%32S*",$domain.' ') << 10;
7556: my $courseseed=unpack("%32S*",$courseid.' ');
7557:
7558: my $num1=$symbchck+$symbseed+$namechck;
7559: my $num2=$nameseed+$domainseed+$courseseed;
1.790 albertel 7560: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
7561: #&logthis("rndseed :$num:$symb");
1.803 albertel 7562: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
1.501 albertel 7563: return "$num1,$num2";
7564: }
7565: }
7566:
7567: sub rndseed_64bit3 {
7568: my ($symb,$courseid,$domain,$username)=@_;
7569: {
7570: use integer;
7571: # strings need to be an even # of cahracters long, it it is odd the
7572: # last characters gets thrown away
7573: my $symbchck=unpack("%32S*",$symb.' ') << 21;
7574: my $symbseed=numval2($symb) << 10;
7575: my $namechck=unpack("%32S*",$username.' ');
7576:
7577: my $nameseed=numval2($username) << 21;
1.443 albertel 7578: my $domainseed=unpack("%32S*",$domain.' ') << 10;
7579: my $courseseed=unpack("%32S*",$courseid.' ');
7580:
7581: my $num1=$symbchck+$symbseed+$namechck;
7582: my $num2=$nameseed+$domainseed+$courseseed;
1.790 albertel 7583: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
7584: #&logthis("rndseed :$num1:$num2:$_64bit");
1.564 albertel 7585: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
7586:
1.503 albertel 7587: return "$num1:$num2";
1.443 albertel 7588: }
7589: }
7590:
1.575 albertel 7591: sub rndseed_64bit4 {
7592: my ($symb,$courseid,$domain,$username)=@_;
7593: {
7594: use integer;
7595: # strings need to be an even # of cahracters long, it it is odd the
7596: # last characters gets thrown away
7597: my $symbchck=unpack("%32S*",$symb.' ') << 21;
7598: my $symbseed=numval3($symb) << 10;
7599: my $namechck=unpack("%32S*",$username.' ');
7600:
7601: my $nameseed=numval3($username) << 21;
7602: my $domainseed=unpack("%32S*",$domain.' ') << 10;
7603: my $courseseed=unpack("%32S*",$courseid.' ');
7604:
7605: my $num1=$symbchck+$symbseed+$namechck;
7606: my $num2=$nameseed+$domainseed+$courseseed;
1.790 albertel 7607: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
7608: #&logthis("rndseed :$num1:$num2:$_64bit");
1.575 albertel 7609: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
7610:
7611: return "$num1:$num2";
7612: }
7613: }
7614:
1.675 albertel 7615: sub rndseed_64bit5 {
7616: my ($symb,$courseid,$domain,$username)=@_;
7617: my ($num1,$num2)=&digest("$symb,$courseid,$domain,$username");
7618: return "$num1:$num2";
7619: }
7620:
1.366 albertel 7621: sub rndseed_CODE_64bit {
7622: my ($symb,$courseid,$domain,$username)=@_;
1.155 albertel 7623: {
1.366 albertel 7624: use integer;
1.443 albertel 7625: my $symbchck=unpack("%32S*",$symb.' ') << 16;
1.484 albertel 7626: my $symbseed=numval2($symb);
1.491 albertel 7627: my $CODEchck=unpack("%32S*",&getCODE().' ') << 16;
7628: my $CODEseed=numval(&getCODE());
1.443 albertel 7629: my $courseseed=unpack("%32S*",$courseid.' ');
1.484 albertel 7630: my $num1=$symbseed+$CODEchck;
7631: my $num2=$CODEseed+$courseseed+$symbchck;
1.790 albertel 7632: #&logthis("$symbseed:$CODEchck|$CODEseed:$courseseed:$symbchck");
7633: #&logthis("rndseed :$num1:$num2:$symb");
1.564 albertel 7634: if ($_64bit) { $num1=(($num1<<32)>>32); }
7635: if ($_64bit) { $num2=(($num2<<32)>>32); }
1.503 albertel 7636: return "$num1:$num2";
1.366 albertel 7637: }
7638: }
7639:
1.575 albertel 7640: sub rndseed_CODE_64bit4 {
7641: my ($symb,$courseid,$domain,$username)=@_;
7642: {
7643: use integer;
7644: my $symbchck=unpack("%32S*",$symb.' ') << 16;
7645: my $symbseed=numval3($symb);
7646: my $CODEchck=unpack("%32S*",&getCODE().' ') << 16;
7647: my $CODEseed=numval3(&getCODE());
7648: my $courseseed=unpack("%32S*",$courseid.' ');
7649: my $num1=$symbseed+$CODEchck;
7650: my $num2=$CODEseed+$courseseed+$symbchck;
1.790 albertel 7651: #&logthis("$symbseed:$CODEchck|$CODEseed:$courseseed:$symbchck");
7652: #&logthis("rndseed :$num1:$num2:$symb");
1.575 albertel 7653: if ($_64bit) { $num1=(($num1<<32)>>32); }
7654: if ($_64bit) { $num2=(($num2<<32)>>32); }
7655: return "$num1:$num2";
7656: }
7657: }
7658:
1.675 albertel 7659: sub rndseed_CODE_64bit5 {
7660: my ($symb,$courseid,$domain,$username)=@_;
7661: my $code = &getCODE();
7662: my ($num1,$num2)=&digest("$symb,$courseid,$code");
7663: return "$num1:$num2";
7664: }
7665:
1.366 albertel 7666: sub setup_random_from_rndseed {
7667: my ($rndseed)=@_;
1.503 albertel 7668: if ($rndseed =~/([,:])/) {
7669: my ($num1,$num2)=split(/[,:]/,$rndseed);
1.366 albertel 7670: &Math::Random::random_set_seed(abs($num1),abs($num2));
7671: } else {
7672: &Math::Random::random_set_seed_from_phrase($rndseed);
1.98 albertel 7673: }
1.36 albertel 7674: }
7675:
1.474 albertel 7676: sub latest_receipt_algorithm_id {
1.835 albertel 7677: return 'receipt3';
1.474 albertel 7678: }
7679:
1.480 www 7680: sub recunique {
7681: my $fucourseid=shift;
7682: my $unique;
1.835 albertel 7683: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2' ||
7684: $env{"course.$fucourseid.receiptalg"} eq 'receipt3' ) {
1.620 albertel 7685: $unique=$env{"course.$fucourseid.internal.encseed"};
1.480 www 7686: } else {
7687: $unique=$perlvar{'lonReceipt'};
7688: }
7689: return unpack("%32C*",$unique);
7690: }
7691:
7692: sub recprefix {
7693: my $fucourseid=shift;
7694: my $prefix;
1.835 albertel 7695: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2'||
7696: $env{"course.$fucourseid.receiptalg"} eq 'receipt3' ) {
1.620 albertel 7697: $prefix=$env{"course.$fucourseid.internal.encpref"};
1.480 www 7698: } else {
7699: $prefix=$perlvar{'lonHostID'};
7700: }
7701: return unpack("%32C*",$prefix);
7702: }
7703:
1.76 www 7704: sub ireceipt {
1.474 albertel 7705: my ($funame,$fudom,$fucourseid,$fusymb,$part)=@_;
1.835 albertel 7706:
7707: my $return =&recprefix($fucourseid).'-';
7708:
7709: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt3' ||
7710: $env{'request.state'} eq 'construct') {
7711: $return .= (&digest("$funame,$fudom,$fucourseid,$fusymb,$part")%10000);
7712: return $return;
7713: }
7714:
1.76 www 7715: my $cuname=unpack("%32C*",$funame);
7716: my $cudom=unpack("%32C*",$fudom);
7717: my $cucourseid=unpack("%32C*",$fucourseid);
7718: my $cusymb=unpack("%32C*",$fusymb);
1.480 www 7719: my $cunique=&recunique($fucourseid);
1.474 albertel 7720: my $cpart=unpack("%32S*",$part);
1.835 albertel 7721: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2') {
7722:
1.790 albertel 7723: #&logthis("doing receipt2 using parts $cpart, uname $cuname and udom $cudom gets ".($cpart%$cuname)." and ".($cpart%$cudom));
1.474 albertel 7724:
7725: $return.= ($cunique%$cuname+
7726: $cunique%$cudom+
7727: $cusymb%$cuname+
7728: $cusymb%$cudom+
7729: $cucourseid%$cuname+
7730: $cucourseid%$cudom+
7731: $cpart%$cuname+
7732: $cpart%$cudom);
7733: } else {
7734: $return.= ($cunique%$cuname+
7735: $cunique%$cudom+
7736: $cusymb%$cuname+
7737: $cusymb%$cudom+
7738: $cucourseid%$cuname+
7739: $cucourseid%$cudom);
7740: }
7741: return $return;
1.76 www 7742: }
7743:
7744: sub receipt {
1.474 albertel 7745: my ($part)=@_;
1.790 albertel 7746: my ($symb,$courseid,$domain,$name) = &whichuser();
1.474 albertel 7747: return &ireceipt($name,$domain,$courseid,$symb,$part);
1.76 www 7748: }
1.260 ng 7749:
1.790 albertel 7750: sub whichuser {
7751: my ($passedsymb)=@_;
7752: my ($symb,$courseid,$domain,$name,$publicuser);
7753: if (defined($env{'form.grade_symb'})) {
7754: my ($tmp_courseid)=&get_env_multiple('form.grade_courseid');
7755: my $allowed=&allowed('vgr',$tmp_courseid);
7756: if (!$allowed &&
7757: exists($env{'request.course.sec'}) &&
7758: $env{'request.course.sec'} !~ /^\s*$/) {
7759: $allowed=&allowed('vgr',$tmp_courseid.
7760: '/'.$env{'request.course.sec'});
7761: }
7762: if ($allowed) {
7763: ($symb)=&get_env_multiple('form.grade_symb');
7764: $courseid=$tmp_courseid;
7765: ($domain)=&get_env_multiple('form.grade_domain');
7766: ($name)=&get_env_multiple('form.grade_username');
7767: return ($symb,$courseid,$domain,$name,$publicuser);
7768: }
7769: }
7770: if (!$passedsymb) {
7771: $symb=&symbread();
7772: } else {
7773: $symb=$passedsymb;
7774: }
7775: $courseid=$env{'request.course.id'};
7776: $domain=$env{'user.domain'};
7777: $name=$env{'user.name'};
7778: if ($name eq 'public' && $domain eq 'public') {
7779: if (!defined($env{'form.username'})) {
7780: $env{'form.username'}.=time.rand(10000000);
7781: }
7782: $name.=$env{'form.username'};
7783: }
7784: return ($symb,$courseid,$domain,$name,$publicuser);
7785:
7786: }
7787:
1.36 albertel 7788: # ------------------------------------------------------------ Serves up a file
1.472 albertel 7789: # returns either the contents of the file or
7790: # -1 if the file doesn't exist
1.481 raeburn 7791: #
7792: # if the target is a file that was uploaded via DOCS,
7793: # a check will be made to see if a current copy exists on the local server,
7794: # if it does this will be served, otherwise a copy will be retrieved from
7795: # the home server for the course and stored in /home/httpd/html/userfiles on
7796: # the local server.
1.472 albertel 7797:
1.36 albertel 7798: sub getfile {
1.538 albertel 7799: my ($file) = @_;
1.609 banghart 7800: if ($file =~ m -^/*(uploaded|editupload)/-) { $file=&filelocation("",$file); }
1.538 albertel 7801: &repcopy($file);
7802: return &readfile($file);
7803: }
7804:
7805: sub repcopy_userfile {
7806: my ($file)=@_;
1.609 banghart 7807: if ($file =~ m -^/*(uploaded|editupload)/-) { $file=&filelocation("",$file); }
1.610 albertel 7808: if ($file =~ m|^/home/httpd/html/lonUsers/|) { return 'ok'; }
1.538 albertel 7809: my ($cdom,$cnum,$filename) =
1.811 albertel 7810: ($file=~m|^\Q$perlvar{'lonDocRoot'}\E/+userfiles/+($match_domain)/+($match_name)/+(.*)|);
1.538 albertel 7811: my $uri="/uploaded/$cdom/$cnum/$filename";
7812: if (-e "$file") {
1.828 www 7813: # we already have a local copy, check it out
1.538 albertel 7814: my @fileinfo = stat($file);
1.828 www 7815: my $rtncode;
7816: my $info;
1.538 albertel 7817: my $lwpresp = &getuploaded('HEAD',$uri,$cdom,$cnum,\$info,\$rtncode);
1.482 albertel 7818: if ($lwpresp ne 'ok') {
1.828 www 7819: # there is no such file anymore, even though we had a local copy
1.482 albertel 7820: if ($rtncode eq '404') {
1.538 albertel 7821: unlink($file);
1.482 albertel 7822: }
7823: return -1;
7824: }
7825: if ($info < $fileinfo[9]) {
1.828 www 7826: # nice, the file we have is up-to-date, just say okay
1.607 raeburn 7827: return 'ok';
1.828 www 7828: } else {
7829: # the file is outdated, get rid of it
7830: unlink($file);
1.482 albertel 7831: }
1.828 www 7832: }
7833: # one way or the other, at this point, we don't have the file
7834: # construct the correct path for the file
7835: my @parts = ($cdom,$cnum);
7836: if ($filename =~ m|^(.+)/[^/]+$|) {
7837: push @parts, split(/\//,$1);
7838: }
7839: my $path = $perlvar{'lonDocRoot'}.'/userfiles';
7840: foreach my $part (@parts) {
7841: $path .= '/'.$part;
7842: if (!-e $path) {
7843: mkdir($path,0770);
1.482 albertel 7844: }
7845: }
1.828 www 7846: # now the path exists for sure
7847: # get a user agent
7848: my $ua=new LWP::UserAgent;
7849: my $transferfile=$file.'.in.transfer';
7850: # FIXME: this should flock
7851: if (-e $transferfile) { return 'ok'; }
7852: my $request;
7853: $uri=~s/^\///;
1.838 albertel 7854: $request=new HTTP::Request('GET','http://'.&hostname(&homeserver($cnum,$cdom)).'/raw/'.$uri);
1.828 www 7855: my $response=$ua->request($request,$transferfile);
7856: # did it work?
7857: if ($response->is_error()) {
7858: unlink($transferfile);
7859: &logthis("Userfile repcopy failed for $uri");
7860: return -1;
7861: }
7862: # worked, rename the transfer file
7863: rename($transferfile,$file);
1.607 raeburn 7864: return 'ok';
1.481 raeburn 7865: }
7866:
1.517 albertel 7867: sub tokenwrapper {
7868: my $uri=shift;
1.552 albertel 7869: $uri=~s|^http\://([^/]+)||;
7870: $uri=~s|^/||;
1.620 albertel 7871: $env{'user.environment'}=~/\/([^\/]+)\.id/;
1.517 albertel 7872: my $token=$1;
1.552 albertel 7873: my (undef,$udom,$uname,$file)=split('/',$uri,4);
7874: if ($udom && $uname && $file) {
7875: $file=~s|(\?\.*)*$||;
1.620 albertel 7876: &appenv("userfile.$udom/$uname/$file" => $env{'request.course.id'});
1.838 albertel 7877: return 'http://'.&hostname(&homeserver($uname,$udom)).'/'.$uri.
1.517 albertel 7878: (($uri=~/\?/)?'&':'?').'token='.$token.
7879: '&tokenissued='.$perlvar{'lonHostID'};
7880: } else {
7881: return '/adm/notfound.html';
7882: }
7883: }
7884:
1.828 www 7885: # call with reqtype HEAD: get last modification time
7886: # call with reqtype GET: get the file contents
7887: # Do not call this with reqtype GET for large files! It loads everything into memory
7888: #
1.481 raeburn 7889: sub getuploaded {
7890: my ($reqtype,$uri,$cdom,$cnum,$info,$rtncode) = @_;
7891: $uri=~s/^\///;
1.838 albertel 7892: $uri = 'http://'.&hostname(&homeserver($cnum,$cdom)).'/raw/'.$uri;
1.481 raeburn 7893: my $ua=new LWP::UserAgent;
7894: my $request=new HTTP::Request($reqtype,$uri);
7895: my $response=$ua->request($request);
7896: $$rtncode = $response->code;
1.482 albertel 7897: if (! $response->is_success()) {
7898: return 'failed';
7899: }
7900: if ($reqtype eq 'HEAD') {
1.486 www 7901: $$info = &HTTP::Date::str2time( $response->header('Last-modified') );
1.482 albertel 7902: } elsif ($reqtype eq 'GET') {
7903: $$info = $response->content;
1.472 albertel 7904: }
1.482 albertel 7905: return 'ok';
1.36 albertel 7906: }
7907:
1.481 raeburn 7908: sub readfile {
7909: my $file = shift;
7910: if ( (! -e $file ) || ($file eq '') ) { return -1; };
7911: my $fh;
7912: open($fh,"<$file");
7913: my $a='';
1.800 albertel 7914: while (my $line = <$fh>) { $a .= $line; }
1.481 raeburn 7915: return $a;
7916: }
7917:
1.36 albertel 7918: sub filelocation {
1.590 banghart 7919: my ($dir,$file) = @_;
7920: my $location;
7921: $file=~ s/^\s*(\S+)\s*$/$1/; ## strip off leading and trailing spaces
1.700 albertel 7922:
7923: if ($file =~ m-^/adm/-) {
7924: $file=~s-^/adm/wrapper/-/-;
7925: $file=~s-^/adm/coursedocs/showdoc/-/-;
7926: }
1.882 albertel 7927:
1.590 banghart 7928: if ($file=~m:^/~:) { # is a contruction space reference
7929: $location = $file;
7930: $location =~ s:/~(.*?)/(.*):/home/$1/public_html/$2:;
1.807 albertel 7931: } elsif ($file=~m{^/home/$match_username/public_html/}) {
1.649 albertel 7932: # is a correct contruction space reference
7933: $location = $file;
1.609 banghart 7934: } elsif ($file=~/^\/*(uploaded|editupload)/) { # is an uploaded file
1.590 banghart 7935: my ($udom,$uname,$filename)=
1.811 albertel 7936: ($file=~m -^/+(?:uploaded|editupload)/+($match_domain)/+($match_name)/+(.*)$-);
1.590 banghart 7937: my $home=&homeserver($uname,$udom);
7938: my $is_me=0;
7939: my @ids=¤t_machine_ids();
7940: foreach my $id (@ids) { if ($id eq $home) { $is_me=1; } }
7941: if ($is_me) {
1.740 www 7942: $location=&propath($udom,$uname).
1.590 banghart 7943: '/userfiles/'.$filename;
7944: } else {
7945: $location=$Apache::lonnet::perlvar{'lonDocRoot'}.'/userfiles/'.
7946: $udom.'/'.$uname.'/'.$filename;
7947: }
1.882 albertel 7948: } elsif ($file =~ m-^/adm/-) {
7949: $location = $perlvar{'lonDocRoot'}.'/'.$file;
1.590 banghart 7950: } else {
7951: $file=~s/^\Q$perlvar{'lonDocRoot'}\E//;
7952: $file=~s:^/res/:/:;
7953: if ( !( $file =~ m:^/:) ) {
7954: $location = $dir. '/'.$file;
7955: } else {
7956: $location = '/home/httpd/html/res'.$file;
7957: }
1.59 albertel 7958: }
1.590 banghart 7959: $location=~s://+:/:g; # remove duplicate /
7960: while ($location=~m:/\.\./:) {$location=~ s:/[^/]+/\.\./:/:g;} #remove dir/..
7961: while ($location=~m:/\./:) {$location=~ s:/\./:/:g;} #remove /./
7962: return $location;
1.46 www 7963: }
1.36 albertel 7964:
1.46 www 7965: sub hreflocation {
7966: my ($dir,$file)=@_;
1.460 albertel 7967: unless (($file=~m-^http://-i) || ($file=~m-^/-)) {
1.666 albertel 7968: $file=filelocation($dir,$file);
1.700 albertel 7969: } elsif ($file=~m-^/adm/-) {
7970: $file=~s-^/adm/wrapper/-/-;
7971: $file=~s-^/adm/coursedocs/showdoc/-/-;
1.666 albertel 7972: }
7973: if ($file=~m-^\Q$perlvar{'lonDocRoot'}\E-) {
7974: $file=~s-^\Q$perlvar{'lonDocRoot'}\E--;
1.807 albertel 7975: } elsif ($file=~m-/home/($match_username)/public_html/-) {
7976: $file=~s-^/home/($match_username)/public_html/-/~$1/-;
1.666 albertel 7977: } elsif ($file=~m-^\Q$perlvar{'lonUsersDir'}\E-) {
1.811 albertel 7978: $file=~s-^/home/httpd/lonUsers/($match_domain)/./././($match_name)/userfiles/
1.666 albertel 7979: -/uploaded/$1/$2/-x;
1.46 www 7980: }
1.913 albertel 7981: if ($file=~ m{^/userfiles/}) {
7982: $file =~ s{^/userfiles/}{/uploaded/};
7983: }
1.462 albertel 7984: return $file;
1.465 albertel 7985: }
7986:
7987: sub current_machine_domains {
1.853 albertel 7988: return &machine_domains(&hostname($perlvar{'lonHostID'}));
7989: }
7990:
7991: sub machine_domains {
7992: my ($hostname) = @_;
1.465 albertel 7993: my @domains;
1.838 albertel 7994: my %hostname = &all_hostnames();
1.465 albertel 7995: while( my($id, $name) = each(%hostname)) {
1.467 matthew 7996: # &logthis("-$id-$name-$hostname-");
1.465 albertel 7997: if ($hostname eq $name) {
1.844 albertel 7998: push(@domains,&host_domain($id));
1.465 albertel 7999: }
8000: }
8001: return @domains;
8002: }
8003:
8004: sub current_machine_ids {
1.853 albertel 8005: return &machine_ids(&hostname($perlvar{'lonHostID'}));
8006: }
8007:
8008: sub machine_ids {
8009: my ($hostname) = @_;
8010: $hostname ||= &hostname($perlvar{'lonHostID'});
1.465 albertel 8011: my @ids;
1.888 albertel 8012: my %name_to_host = &all_names();
1.889 albertel 8013: if (ref($name_to_host{$hostname}) eq 'ARRAY') {
8014: return @{ $name_to_host{$hostname} };
8015: }
8016: return;
1.31 www 8017: }
8018:
1.824 raeburn 8019: sub additional_machine_domains {
8020: my @domains;
8021: open(my $fh,"<$perlvar{'lonTabDir'}/expected_domains.tab");
8022: while( my $line = <$fh>) {
8023: $line =~ s/\s//g;
8024: push(@domains,$line);
8025: }
8026: return @domains;
8027: }
8028:
8029: sub default_login_domain {
8030: my $domain = $perlvar{'lonDefDomain'};
8031: my $testdomain=(split(/\./,$ENV{'HTTP_HOST'}))[0];
8032: foreach my $posdom (¤t_machine_domains(),
8033: &additional_machine_domains()) {
8034: if (lc($posdom) eq lc($testdomain)) {
8035: $domain=$posdom;
8036: last;
8037: }
8038: }
8039: return $domain;
8040: }
8041:
1.31 www 8042: # ------------------------------------------------------------- Declutters URLs
8043:
8044: sub declutter {
8045: my $thisfn=shift;
1.569 albertel 8046: if ($thisfn=~m|^/enc/|) { $thisfn=&Apache::lonenc::unencrypted($thisfn); }
1.479 albertel 8047: $thisfn=~s/^\Q$perlvar{'lonDocRoot'}\E//;
1.31 www 8048: $thisfn=~s/^\///;
1.697 albertel 8049: $thisfn=~s|^adm/wrapper/||;
8050: $thisfn=~s|^adm/coursedocs/showdoc/||;
1.31 www 8051: $thisfn=~s/^res\///;
1.235 www 8052: $thisfn=~s/\?.+$//;
1.268 www 8053: return $thisfn;
8054: }
8055:
8056: # ------------------------------------------------------------- Clutter up URLs
8057:
8058: sub clutter {
8059: my $thisfn='/'.&declutter(shift);
1.887 albertel 8060: if ($thisfn !~ m{^/(uploaded|editupload|adm|userfiles|ext|raw|priv|public)/}
1.884 albertel 8061: || $thisfn =~ m{^/adm/(includes|pages)} ) {
1.270 www 8062: $thisfn='/res'.$thisfn;
8063: }
1.694 albertel 8064: if ($thisfn !~m|/adm|) {
1.695 albertel 8065: if ($thisfn =~ m|/ext/|) {
1.694 albertel 8066: $thisfn='/adm/wrapper'.$thisfn;
1.695 albertel 8067: } else {
8068: my ($ext) = ($thisfn =~ /\.(\w+)$/);
8069: my $embstyle=&Apache::loncommon::fileembstyle($ext);
1.698 albertel 8070: if ($embstyle eq 'ssi'
8071: || ($embstyle eq 'hdn')
8072: || ($embstyle eq 'rat')
8073: || ($embstyle eq 'prv')
8074: || ($embstyle eq 'ign')) {
8075: #do nothing with these
8076: } elsif (($embstyle eq 'img')
1.695 albertel 8077: || ($embstyle eq 'emb')
8078: || ($embstyle eq 'wrp')) {
8079: $thisfn='/adm/wrapper'.$thisfn;
1.698 albertel 8080: } elsif ($embstyle eq 'unk'
8081: && $thisfn!~/\.(sequence|page)$/) {
1.695 albertel 8082: $thisfn='/adm/coursedocs/showdoc'.$thisfn;
1.698 albertel 8083: } else {
1.718 www 8084: # &logthis("Got a blank emb style");
1.695 albertel 8085: }
1.694 albertel 8086: }
8087: }
1.31 www 8088: return $thisfn;
1.12 www 8089: }
8090:
1.787 albertel 8091: sub clutter_with_no_wrapper {
8092: my $uri = &clutter(shift);
8093: if ($uri =~ m-^/adm/-) {
8094: $uri =~ s-^/adm/wrapper/-/-;
8095: $uri =~ s-^/adm/coursedocs/showdoc/-/-;
8096: }
8097: return $uri;
8098: }
8099:
1.557 albertel 8100: sub freeze_escape {
8101: my ($value)=@_;
8102: if (ref($value)) {
8103: $value=&nfreeze($value);
8104: return '__FROZEN__'.&escape($value);
8105: }
8106: return &escape($value);
8107: }
8108:
1.11 www 8109:
1.557 albertel 8110: sub thaw_unescape {
8111: my ($value)=@_;
8112: if ($value =~ /^__FROZEN__/) {
8113: substr($value,0,10,undef);
8114: $value=&unescape($value);
8115: return &thaw($value);
8116: }
8117: return &unescape($value);
8118: }
8119:
1.436 albertel 8120: sub correct_line_ends {
8121: my ($result)=@_;
8122: $$result =~s/\r\n/\n/mg;
8123: $$result =~s/\r/\n/mg;
1.415 albertel 8124: }
1.1 albertel 8125: # ================================================================ Main Program
8126:
1.184 www 8127: sub goodbye {
1.204 albertel 8128: &logthis("Starting Shut down");
1.443 albertel 8129: #not converted to using infrastruture and probably shouldn't be
1.870 albertel 8130: &logthis(sprintf("%-20s is %s",'%badServerCache',length(&nfreeze(\%badServerCache))));
1.443 albertel 8131: #converted
1.599 albertel 8132: # &logthis(sprintf("%-20s is %s",'%metacache',scalar(%metacache)));
1.870 albertel 8133: &logthis(sprintf("%-20s is %s",'%homecache',length(&nfreeze(\%homecache))));
8134: # &logthis(sprintf("%-20s is %s",'%titlecache',length(&nfreeze(\%titlecache))));
8135: # &logthis(sprintf("%-20s is %s",'%courseresdatacache',length(&nfreeze(\%courseresdatacache))));
1.425 albertel 8136: #1.1 only
1.870 albertel 8137: # &logthis(sprintf("%-20s is %s",'%userresdatacache',length(&nfreeze(\%userresdatacache))));
8138: # &logthis(sprintf("%-20s is %s",'%getsectioncache',length(&nfreeze(\%getsectioncache))));
8139: # &logthis(sprintf("%-20s is %s",'%courseresversioncache',length(&nfreeze(\%courseresversioncache))));
8140: # &logthis(sprintf("%-20s is %s",'%resversioncache',length(&nfreeze(\%resversioncache))));
8141: &logthis(sprintf("%-20s is %s",'%remembered',length(&nfreeze(\%remembered))));
1.599 albertel 8142: &logthis(sprintf("%-20s is %s",'kicks',$kicks));
8143: &logthis(sprintf("%-20s is %s",'hits',$hits));
1.184 www 8144: &flushcourselogs();
8145: &logthis("Shutting down");
8146: }
8147:
1.852 albertel 8148: sub get_dns {
1.869 albertel 8149: my ($url,$func,$ignore_cache) = @_;
8150: if (!$ignore_cache) {
8151: my ($content,$cached)=
8152: &Apache::lonnet::is_cached_new('dns',$url);
8153: if ($cached) {
8154: &$func($content);
8155: return;
8156: }
8157: }
8158:
8159: my %alldns;
1.852 albertel 8160: open(my $config,"<$perlvar{'lonTabDir'}/hosts.tab");
8161: foreach my $dns (<$config>) {
8162: next if ($dns !~ /^\^(\S*)/x);
1.869 albertel 8163: $alldns{$1} = 1;
8164: }
8165: while (%alldns) {
8166: my ($dns) = keys(%alldns);
8167: delete($alldns{$dns});
1.852 albertel 8168: my $ua=new LWP::UserAgent;
8169: my $request=new HTTP::Request('GET',"http://$dns$url");
8170: my $response=$ua->request($request);
8171: next if ($response->is_error());
8172: my @content = split("\n",$response->content);
1.869 albertel 8173: &Apache::lonnet::do_cache_new('dns',$url,\@content,30*24*60*60);
1.852 albertel 8174: &$func(\@content);
1.869 albertel 8175: return;
1.852 albertel 8176: }
8177: close($config);
1.871 albertel 8178: my $which = (split('/',$url))[3];
8179: &logthis("unable to contact DNS defaulting to on disk file dns_$which.tab\n");
8180: open($config,"<$perlvar{'lonTabDir'}/dns_$which.tab");
1.869 albertel 8181: my @content = <$config>;
8182: &$func(\@content);
8183: return;
1.852 albertel 8184: }
1.327 albertel 8185: # ------------------------------------------------------------ Read domain file
8186: {
1.852 albertel 8187: my $loaded;
1.846 albertel 8188: my %domain;
8189:
1.852 albertel 8190: sub parse_domain_tab {
8191: my ($lines) = @_;
8192: foreach my $line (@$lines) {
8193: next if ($line =~ /^(\#|\s*$ )/x);
1.403 www 8194:
1.846 albertel 8195: chomp($line);
1.852 albertel 8196: my ($name,@elements) = split(/:/,$line,9);
1.846 albertel 8197: my %this_domain;
8198: foreach my $field ('description', 'auth_def', 'auth_arg_def',
8199: 'lang_def', 'city', 'longi', 'lati',
8200: 'primary') {
8201: $this_domain{$field} = shift(@elements);
8202: }
8203: $domain{$name} = \%this_domain;
1.852 albertel 8204: }
8205: }
1.864 albertel 8206:
8207: sub reset_domain_info {
8208: undef($loaded);
8209: undef(%domain);
8210: }
8211:
1.852 albertel 8212: sub load_domain_tab {
1.869 albertel 8213: my ($ignore_cache) = @_;
8214: &get_dns('/adm/dns/domain',\&parse_domain_tab,$ignore_cache);
1.852 albertel 8215: my $fh;
8216: if (open($fh,"<".$perlvar{'lonTabDir'}.'/domain.tab')) {
8217: my @lines = <$fh>;
8218: &parse_domain_tab(\@lines);
1.448 albertel 8219: }
1.852 albertel 8220: close($fh);
8221: $loaded = 1;
1.327 albertel 8222: }
1.846 albertel 8223:
8224: sub domain {
1.852 albertel 8225: &load_domain_tab() if (!$loaded);
8226:
1.846 albertel 8227: my ($name,$what) = @_;
8228: return if ( !exists($domain{$name}) );
8229:
8230: if (!$what) {
8231: return $domain{$name}{'description'};
8232: }
8233: return $domain{$name}{$what};
8234: }
1.327 albertel 8235: }
8236:
8237:
1.1 albertel 8238: # ------------------------------------------------------------- Read hosts file
8239: {
1.838 albertel 8240: my %hostname;
1.844 albertel 8241: my %hostdom;
1.845 albertel 8242: my %libserv;
1.852 albertel 8243: my $loaded;
1.888 albertel 8244: my %name_to_host;
1.852 albertel 8245:
8246: sub parse_hosts_tab {
8247: my ($file) = @_;
8248: foreach my $configline (@$file) {
8249: next if ($configline =~ /^(\#|\s*$ )/x);
8250: next if ($configline =~ /^\^/);
8251: chomp($configline);
8252: my ($id,$domain,$role,$name)=split(/:/,$configline);
8253: $name=~s/\s//g;
8254: if ($id && $domain && $role && $name) {
8255: $hostname{$id}=$name;
1.888 albertel 8256: push(@{$name_to_host{$name}}, $id);
1.852 albertel 8257: $hostdom{$id}=$domain;
8258: if ($role eq 'library') { $libserv{$id}=$name; }
8259: }
8260: }
8261: }
1.864 albertel 8262:
8263: sub reset_hosts_info {
1.897 albertel 8264: &purge_remembered();
1.864 albertel 8265: &reset_domain_info();
8266: &reset_hosts_ip_info();
1.892 albertel 8267: undef(%name_to_host);
1.864 albertel 8268: undef(%hostname);
8269: undef(%hostdom);
8270: undef(%libserv);
8271: undef($loaded);
8272: }
1.1 albertel 8273:
1.852 albertel 8274: sub load_hosts_tab {
1.869 albertel 8275: my ($ignore_cache) = @_;
8276: &get_dns('/adm/dns/hosts',\&parse_hosts_tab,$ignore_cache);
1.852 albertel 8277: open(my $config,"<$perlvar{'lonTabDir'}/hosts.tab");
8278: my @config = <$config>;
8279: &parse_hosts_tab(\@config);
8280: close($config);
8281: $loaded=1;
1.1 albertel 8282: }
1.852 albertel 8283:
1.838 albertel 8284: sub hostname {
1.852 albertel 8285: &load_hosts_tab() if (!$loaded);
8286:
1.838 albertel 8287: my ($lonid) = @_;
8288: return $hostname{$lonid};
8289: }
1.845 albertel 8290:
1.838 albertel 8291: sub all_hostnames {
1.852 albertel 8292: &load_hosts_tab() if (!$loaded);
8293:
1.838 albertel 8294: return %hostname;
8295: }
1.845 albertel 8296:
1.888 albertel 8297: sub all_names {
8298: &load_hosts_tab() if (!$loaded);
8299:
8300: return %name_to_host;
8301: }
8302:
1.845 albertel 8303: sub is_library {
1.852 albertel 8304: &load_hosts_tab() if (!$loaded);
8305:
1.845 albertel 8306: return exists($libserv{$_[0]});
8307: }
8308:
8309: sub all_library {
1.852 albertel 8310: &load_hosts_tab() if (!$loaded);
8311:
1.845 albertel 8312: return %libserv;
8313: }
8314:
1.841 albertel 8315: sub get_servers {
1.852 albertel 8316: &load_hosts_tab() if (!$loaded);
8317:
1.841 albertel 8318: my ($domain,$type) = @_;
8319: my %possible_hosts = ($type eq 'library') ? %libserv
8320: : %hostname;
8321: my %result;
1.842 albertel 8322: if (ref($domain) eq 'ARRAY') {
8323: while ( my ($host,$hostname) = each(%possible_hosts)) {
1.843 albertel 8324: if (grep(/^\Q$hostdom{$host}\E$/,@$domain)) {
1.842 albertel 8325: $result{$host} = $hostname;
8326: }
8327: }
8328: } else {
8329: while ( my ($host,$hostname) = each(%possible_hosts)) {
8330: if ($hostdom{$host} eq $domain) {
8331: $result{$host} = $hostname;
8332: }
1.841 albertel 8333: }
8334: }
8335: return %result;
8336: }
1.845 albertel 8337:
1.844 albertel 8338: sub host_domain {
1.852 albertel 8339: &load_hosts_tab() if (!$loaded);
8340:
1.844 albertel 8341: my ($lonid) = @_;
8342: return $hostdom{$lonid};
8343: }
8344:
1.841 albertel 8345: sub all_domains {
1.852 albertel 8346: &load_hosts_tab() if (!$loaded);
8347:
1.841 albertel 8348: my %seen;
8349: my @uniq = grep(!$seen{$_}++, values(%hostdom));
8350: return @uniq;
8351: }
1.1 albertel 8352: }
8353:
1.847 albertel 8354: {
8355: my %iphost;
1.856 albertel 8356: my %name_to_ip;
8357: my %lonid_to_ip;
1.869 albertel 8358:
1.847 albertel 8359: sub get_hosts_from_ip {
8360: my ($ip) = @_;
8361: my %iphosts = &get_iphost();
8362: if (ref($iphosts{$ip})) {
8363: return @{$iphosts{$ip}};
8364: }
8365: return;
1.839 albertel 8366: }
1.864 albertel 8367:
8368: sub reset_hosts_ip_info {
8369: undef(%iphost);
8370: undef(%name_to_ip);
8371: undef(%lonid_to_ip);
8372: }
1.856 albertel 8373:
8374: sub get_host_ip {
8375: my ($lonid) = @_;
8376: if (exists($lonid_to_ip{$lonid})) {
8377: return $lonid_to_ip{$lonid};
8378: }
8379: my $name=&hostname($lonid);
8380: my $ip = gethostbyname($name);
8381: return if (!$ip || length($ip) ne 4);
8382: $ip=inet_ntoa($ip);
8383: $name_to_ip{$name} = $ip;
8384: $lonid_to_ip{$lonid} = $ip;
8385: return $ip;
8386: }
1.847 albertel 8387:
8388: sub get_iphost {
1.869 albertel 8389: my ($ignore_cache) = @_;
1.894 albertel 8390:
1.869 albertel 8391: if (!$ignore_cache) {
8392: if (%iphost) {
8393: return %iphost;
8394: }
8395: my ($ip_info,$cached)=
8396: &Apache::lonnet::is_cached_new('iphost','iphost');
8397: if ($cached) {
8398: %iphost = %{$ip_info->[0]};
8399: %name_to_ip = %{$ip_info->[1]};
8400: %lonid_to_ip = %{$ip_info->[2]};
8401: return %iphost;
8402: }
8403: }
1.894 albertel 8404:
8405: # get yesterday's info for fallback
8406: my %old_name_to_ip;
8407: my ($ip_info,$cached)=
8408: &Apache::lonnet::is_cached_new('iphost','iphost');
8409: if ($cached) {
8410: %old_name_to_ip = %{$ip_info->[1]};
8411: }
8412:
1.888 albertel 8413: my %name_to_host = &all_names();
8414: foreach my $name (keys(%name_to_host)) {
1.847 albertel 8415: my $ip;
8416: if (!exists($name_to_ip{$name})) {
8417: $ip = gethostbyname($name);
8418: if (!$ip || length($ip) ne 4) {
1.894 albertel 8419: if (defined($old_name_to_ip{$name})) {
8420: $ip = $old_name_to_ip{$name};
8421: &logthis("Can't find $name defaulting to old $ip");
8422: } else {
8423: &logthis("Name $name no IP found");
8424: next;
8425: }
8426: } else {
8427: $ip=inet_ntoa($ip);
1.847 albertel 8428: }
8429: $name_to_ip{$name} = $ip;
8430: } else {
8431: $ip = $name_to_ip{$name};
1.653 albertel 8432: }
1.888 albertel 8433: foreach my $id (@{ $name_to_host{$name} }) {
8434: $lonid_to_ip{$id} = $ip;
8435: }
8436: push(@{$iphost{$ip}},@{$name_to_host{$name}});
1.598 albertel 8437: }
1.869 albertel 8438: &Apache::lonnet::do_cache_new('iphost','iphost',
8439: [\%iphost,\%name_to_ip,\%lonid_to_ip],
1.894 albertel 8440: 48*60*60);
1.869 albertel 8441:
1.847 albertel 8442: return %iphost;
1.598 albertel 8443: }
8444: }
8445:
1.862 albertel 8446: BEGIN {
8447:
8448: # ----------------------------------- Read loncapa.conf and loncapa_apache.conf
8449: unless ($readit) {
8450: {
8451: my $configvars = LONCAPA::Configuration::read_conf('loncapa.conf');
8452: %perlvar = (%perlvar,%{$configvars});
8453: }
8454:
8455:
1.1 albertel 8456: # ------------------------------------------------------ Read spare server file
8457: {
1.448 albertel 8458: open(my $config,"<$perlvar{'lonTabDir'}/spare.tab");
1.1 albertel 8459:
8460: while (my $configline=<$config>) {
8461: chomp($configline);
1.284 matthew 8462: if ($configline) {
1.784 albertel 8463: my ($host,$type) = split(':',$configline,2);
1.785 albertel 8464: if (!defined($type) || $type eq '') { $type = 'default' };
1.784 albertel 8465: push(@{ $spareid{$type} }, $host);
1.1 albertel 8466: }
8467: }
1.448 albertel 8468: close($config);
1.1 albertel 8469: }
1.11 www 8470: # ------------------------------------------------------------ Read permissions
8471: {
1.448 albertel 8472: open(my $config,"<$perlvar{'lonTabDir'}/roles.tab");
1.11 www 8473:
8474: while (my $configline=<$config>) {
1.448 albertel 8475: chomp($configline);
8476: if ($configline) {
8477: my ($role,$perm)=split(/ /,$configline);
8478: if ($perm ne '') { $pr{$role}=$perm; }
8479: }
1.11 www 8480: }
1.448 albertel 8481: close($config);
1.11 www 8482: }
8483:
8484: # -------------------------------------------- Read plain texts for permissions
8485: {
1.448 albertel 8486: open(my $config,"<$perlvar{'lonTabDir'}/rolesplain.tab");
1.11 www 8487:
8488: while (my $configline=<$config>) {
1.448 albertel 8489: chomp($configline);
8490: if ($configline) {
1.742 raeburn 8491: my ($short,@plain)=split(/:/,$configline);
8492: %{$prp{$short}} = ();
8493: if (@plain > 0) {
8494: $prp{$short}{'std'} = $plain[0];
8495: for (my $i=1; $i<@plain; $i++) {
8496: $prp{$short}{'alt'.$i} = $plain[$i];
8497: }
8498: }
1.448 albertel 8499: }
1.135 www 8500: }
1.448 albertel 8501: close($config);
1.135 www 8502: }
8503:
8504: # ---------------------------------------------------------- Read package table
8505: {
1.448 albertel 8506: open(my $config,"<$perlvar{'lonTabDir'}/packages.tab");
1.135 www 8507:
8508: while (my $configline=<$config>) {
1.483 albertel 8509: if ($configline !~ /\S/ || $configline=~/^#/) { next; }
1.448 albertel 8510: chomp($configline);
8511: my ($short,$plain)=split(/:/,$configline);
8512: my ($pack,$name)=split(/\&/,$short);
8513: if ($plain ne '') {
8514: $packagetab{$pack.'&'.$name.'&name'}=$name;
8515: $packagetab{$short}=$plain;
8516: }
1.11 www 8517: }
1.448 albertel 8518: close($config);
1.329 matthew 8519: }
8520:
8521: # ------------- set up temporary directory
8522: {
8523: $tmpdir = $perlvar{'lonDaemons'}.'/tmp/';
8524:
1.11 www 8525: }
8526:
1.794 albertel 8527: $memcache=new Cache::Memcached({'servers' => ['127.0.0.1:11211'],
8528: 'compress_threshold'=> 20_000,
8529: });
1.185 www 8530:
1.281 www 8531: $processmarker='_'.time.'_'.$perlvar{'lonHostID'};
1.186 www 8532: $dumpcount=0;
1.22 www 8533:
1.163 harris41 8534: &logtouch();
1.672 albertel 8535: &logthis('<font color="yellow">INFO: Read configuration</font>');
1.195 www 8536: $readit=1;
1.564 albertel 8537: {
8538: use integer;
8539: my $test=(2**32)+1;
1.568 albertel 8540: if ($test != 0) { $_64bit=1; } else { $_64bit=0; }
1.564 albertel 8541: &logthis(" Detected 64bit platform ($_64bit)");
8542: }
1.195 www 8543: }
1.1 albertel 8544: }
1.179 www 8545:
1.1 albertel 8546: 1;
1.191 harris41 8547: __END__
8548:
1.243 albertel 8549: =pod
8550:
1.191 harris41 8551: =head1 NAME
8552:
1.243 albertel 8553: Apache::lonnet - Subroutines to ask questions about things in the network.
1.191 harris41 8554:
8555: =head1 SYNOPSIS
8556:
1.243 albertel 8557: Invoked by other LON-CAPA modules, when they need to talk to or about objects in the network.
1.191 harris41 8558:
8559: &Apache::lonnet::SUBROUTINENAME(ARGUMENTS);
8560:
1.243 albertel 8561: Common parameters:
8562:
8563: =over 4
8564:
8565: =item *
8566:
8567: $uname : an internal username (if $cname expecting a course Id specifically)
8568:
8569: =item *
8570:
8571: $udom : a domain (if $cdom expecting a course's domain specifically)
8572:
8573: =item *
8574:
8575: $symb : a resource instance identifier
8576:
8577: =item *
8578:
8579: $namespace : the name of a .db file that contains the data needed or
8580: being set.
8581:
8582: =back
8583:
1.394 bowersj2 8584: =head1 OVERVIEW
1.191 harris41 8585:
1.394 bowersj2 8586: lonnet provides subroutines which interact with the
8587: lonc/lond (TCP) network layer of LON-CAPA. They can be used to ask
8588: about classes, users, and resources.
1.243 albertel 8589:
8590: For many of these objects you can also use this to store data about
8591: them or modify them in various ways.
1.191 harris41 8592:
1.394 bowersj2 8593: =head2 Symbs
1.191 harris41 8594:
1.394 bowersj2 8595: To identify a specific instance of a resource, LON-CAPA uses symbols
8596: or "symbs"X<symb>. These identifiers are built from the URL of the
8597: map, the resource number of the resource in the map, and the URL of
8598: the resource itself. The latter is somewhat redundant, but might help
8599: if maps change.
8600:
8601: An example is
8602:
8603: msu/korte/parts/part1.sequence___19___msu/korte/tests/part12.problem
8604:
8605: The respective map entry is
8606:
8607: <resource id="19" src="/res/msu/korte/tests/part12.problem"
8608: title="Problem 2">
8609: </resource>
8610:
8611: Symbs are used by the random number generator, as well as to store and
8612: restore data specific to a certain instance of for example a problem.
8613:
8614: =head2 Storing And Retrieving Data
8615:
8616: X<store()>X<cstore()>X<restore()>Three of the most important functions
8617: in C<lonnet.pm> are C<&Apache::lonnet::cstore()>,
8618: C<&Apache::lonnet:restore()>, and C<&Apache::lonnet::store()>, which
8619: is is the non-critical message twin of cstore. These functions are for
8620: handlers to store a perl hash to a user's permanent data space in an
8621: easy manner, and to retrieve it again on another call. It is expected
8622: that a handler would use this once at the beginning to retrieve data,
8623: and then again once at the end to send only the new data back.
8624:
8625: The data is stored in the user's data directory on the user's
8626: homeserver under the ID of the course.
8627:
8628: The hash that is returned by restore will have all of the previous
8629: value for all of the elements of the hash.
8630:
8631: Example:
8632:
8633: #creating a hash
8634: my %hash;
8635: $hash{'foo'}='bar';
8636:
8637: #storing it
8638: &Apache::lonnet::cstore(\%hash);
8639:
8640: #changing a value
8641: $hash{'foo'}='notbar';
8642:
8643: #adding a new value
8644: $hash{'bar'}='foo';
8645: &Apache::lonnet::cstore(\%hash);
8646:
8647: #retrieving the hash
8648: my %history=&Apache::lonnet::restore();
8649:
8650: #print the hash
8651: foreach my $key (sort(keys(%history))) {
8652: print("\%history{$key} = $history{$key}");
8653: }
8654:
8655: Will print out:
1.191 harris41 8656:
1.394 bowersj2 8657: %history{1:foo} = bar
8658: %history{1:keys} = foo:timestamp
8659: %history{1:timestamp} = 990455579
8660: %history{2:bar} = foo
8661: %history{2:foo} = notbar
8662: %history{2:keys} = foo:bar:timestamp
8663: %history{2:timestamp} = 990455580
8664: %history{bar} = foo
8665: %history{foo} = notbar
8666: %history{timestamp} = 990455580
8667: %history{version} = 2
8668:
8669: Note that the special hash entries C<keys>, C<version> and
8670: C<timestamp> were added to the hash. C<version> will be equal to the
8671: total number of versions of the data that have been stored. The
8672: C<timestamp> attribute will be the UNIX time the hash was
8673: stored. C<keys> is available in every historical section to list which
8674: keys were added or changed at a specific historical revision of a
8675: hash.
8676:
8677: B<Warning>: do not store the hash that restore returns directly. This
8678: will cause a mess since it will restore the historical keys as if the
8679: were new keys. I.E. 1:foo will become 1:1:foo etc.
1.191 harris41 8680:
1.394 bowersj2 8681: Calling convention:
1.191 harris41 8682:
1.394 bowersj2 8683: my %record=&Apache::lonnet::restore($symb,$courseid,$domain,$uname,$home);
8684: &Apache::lonnet::cstore(\%newrecord,$symb,$courseid,$domain,$uname,$home);
1.191 harris41 8685:
1.394 bowersj2 8686: For more detailed information, see lonnet specific documentation.
1.191 harris41 8687:
1.394 bowersj2 8688: =head1 RETURN MESSAGES
1.191 harris41 8689:
1.394 bowersj2 8690: =over 4
1.191 harris41 8691:
1.394 bowersj2 8692: =item * B<con_lost>: unable to contact remote host
1.191 harris41 8693:
1.394 bowersj2 8694: =item * B<con_delayed>: unable to contact remote host, message will be delivered
8695: when the connection is brought back up
1.191 harris41 8696:
1.394 bowersj2 8697: =item * B<con_failed>: unable to contact remote host and unable to save message
8698: for later delivery
1.191 harris41 8699:
1.394 bowersj2 8700: =item * B<error:>: an error a occured, a description of the error follows the :
1.191 harris41 8701:
1.394 bowersj2 8702: =item * B<no_such_host>: unable to fund a host associated with the user/domain
1.243 albertel 8703: that was requested
1.191 harris41 8704:
1.243 albertel 8705: =back
1.191 harris41 8706:
1.243 albertel 8707: =head1 PUBLIC SUBROUTINES
1.191 harris41 8708:
1.243 albertel 8709: =head2 Session Environment Functions
1.191 harris41 8710:
1.243 albertel 8711: =over 4
1.191 harris41 8712:
1.394 bowersj2 8713: =item *
8714: X<appenv()>
8715: B<appenv(%hash)>: the value of %hash is written to
8716: the user envirnoment file, and will be restored for each access this
1.620 albertel 8717: user makes during this session, also modifies the %env for the current
1.394 bowersj2 8718: process
1.191 harris41 8719:
8720: =item *
1.394 bowersj2 8721: X<delenv()>
8722: B<delenv($regexp)>: removes all items from the session
8723: environment file that matches the regular expression in $regexp. The
1.620 albertel 8724: values are also delted from the current processes %env.
1.191 harris41 8725:
1.795 albertel 8726: =item * get_env_multiple($name)
8727:
8728: gets $name from the %env hash, it seemlessly handles the cases where multiple
8729: values may be defined and end up as an array ref.
8730:
8731: returns an array of values
8732:
1.243 albertel 8733: =back
8734:
8735: =head2 User Information
1.191 harris41 8736:
1.243 albertel 8737: =over 4
1.191 harris41 8738:
8739: =item *
1.394 bowersj2 8740: X<queryauthenticate()>
8741: B<queryauthenticate($uname,$udom)>: try to determine user's current
1.191 harris41 8742: authentication scheme
8743:
8744: =item *
1.394 bowersj2 8745: X<authenticate()>
8746: B<authenticate($uname,$upass,$udom)>: try to
8747: authenticate user from domain's lib servers (first use the current
8748: one). C<$upass> should be the users password.
1.191 harris41 8749:
8750: =item *
1.394 bowersj2 8751: X<homeserver()>
8752: B<homeserver($uname,$udom)>: find the server which has
8753: the user's directory and files (there must be only one), this caches
8754: the answer, and also caches if there is a borken connection.
1.191 harris41 8755:
8756: =item *
1.394 bowersj2 8757: X<idget()>
8758: B<idget($udom,@ids)>: find the usernames behind a list of IDs
8759: (IDs are a unique resource in a domain, there must be only 1 ID per
8760: username, and only 1 username per ID in a specific domain) (returns
8761: hash: id=>name,id=>name)
1.191 harris41 8762:
8763: =item *
1.394 bowersj2 8764: X<idrget()>
8765: B<idrget($udom,@unames)>: find the IDs behind a list of
8766: usernames (returns hash: name=>id,name=>id)
1.191 harris41 8767:
8768: =item *
1.394 bowersj2 8769: X<idput()>
8770: B<idput($udom,%ids)>: store away a list of names and associated IDs
1.191 harris41 8771:
8772: =item *
1.394 bowersj2 8773: X<rolesinit()>
8774: B<rolesinit($udom,$username,$authhost)>: get user privileges
1.243 albertel 8775:
8776: =item *
1.551 albertel 8777: X<getsection()>
8778: B<getsection($udom,$uname,$cname)>: finds the section of student in the
1.243 albertel 8779: course $cname, return section name/number or '' for "not in course"
8780: and '-1' for "no section"
8781:
8782: =item *
1.394 bowersj2 8783: X<userenvironment()>
8784: B<userenvironment($udom,$uname,@what)>: gets the values of the keys
1.243 albertel 8785: passed in @what from the requested user's environment, returns a hash
8786:
1.858 raeburn 8787: =item *
8788: X<userlog_query()>
1.859 albertel 8789: B<userlog_query($uname,$udom,%filters)>: retrieves data from a user's
8790: activity.log file. %filters defines filters applied when parsing the
8791: log file. These can be start or end timestamps, or the type of action
8792: - log to look for Login or Logout events, check for Checkin or
8793: Checkout, role for role selection. The response is in the form
8794: timestamp1:hostid1:event1×tamp2:hostid2:event2 where events are
8795: escaped strings of the action recorded in the activity.log file.
1.858 raeburn 8796:
1.243 albertel 8797: =back
8798:
8799: =head2 User Roles
8800:
8801: =over 4
8802:
8803: =item *
8804:
1.810 raeburn 8805: allowed($priv,$uri,$symb,$role) : check for a user privilege; returns codes for allowed actions
1.243 albertel 8806: F: full access
8807: U,I,K: authentication modes (cxx only)
8808: '': forbidden
8809: 1: user needs to choose course
8810: 2: browse allowed
1.766 albertel 8811: A: passphrase authentication needed
1.243 albertel 8812:
8813: =item *
8814:
8815: definerole($rolename,$sysrole,$domrole,$courole) : define role; define a custom
8816: role rolename set privileges in format of lonTabs/roles.tab for system, domain,
8817: and course level
8818:
8819: =item *
8820:
8821: plaintext($short) : return value in %prp hash (rolesplain.tab); plain text
8822: explanation of a user role term
8823:
1.832 raeburn 8824: =item *
8825:
1.858 raeburn 8826: get_my_roles($uname,$udom,$context,$types,$roles,$roledoms) :
8827: All arguments are optional. Returns a hash of a roles, either for
8828: co-author/assistant author roles for a user's Construction Space
1.906 albertel 8829: (default), or if $context is 'userroles', roles for the user himself,
1.858 raeburn 8830: In the hash, keys are set to colon-sparated $uname,$udom,and $role,
8831: and value is set to colon-separated start and end times for the role.
8832: If no username and domain are specified, will default to current
8833: user/domain. Types, roles, and roledoms are references to arrays,
8834: of role statuses (active, future or previous), roles
8835: (e.g., cc,in, st etc.) and domains of the roles which can be used
8836: to restrict the list of roles reported. If no array ref is
8837: provided for types, will default to return only active roles.
1.834 albertel 8838:
1.243 albertel 8839: =back
8840:
8841: =head2 User Modification
8842:
8843: =over 4
8844:
8845: =item *
8846:
8847: assignrole($udom,$uname,$url,$role,$end,$start) : assign role; give a role to a
8848: user for the level given by URL. Optional start and end dates (leave empty
8849: string or zero for "no date")
1.191 harris41 8850:
8851: =item *
8852:
1.243 albertel 8853: changepass($uname,$udom,$currentpass,$newpass,$server) : attempts to
8854: change a users, password, possible return values are: ok,
8855: pwchange_failure, non_authorized, auth_mode_error, unknown_user,
8856: refused
1.191 harris41 8857:
8858: =item *
8859:
1.243 albertel 8860: modifyuserauth($udom,$uname,$umode,$upass) : modify user authentication
1.191 harris41 8861:
8862: =item *
8863:
1.243 albertel 8864: modifyuser($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene) :
8865: modify user
1.191 harris41 8866:
8867: =item *
8868:
1.286 matthew 8869: modifystudent
8870:
8871: modify a students enrollment and identification information.
8872: The course id is resolved based on the current users environment.
8873: This means the envoking user must be a course coordinator or otherwise
8874: associated with a course.
8875:
1.297 matthew 8876: This call is essentially a wrapper for lonnet::modifyuser and
8877: lonnet::modify_student_enrollment
1.286 matthew 8878:
8879: Inputs:
8880:
8881: =over 4
8882:
8883: =item B<$udom> Students loncapa domain
8884:
8885: =item B<$uname> Students loncapa login name
8886:
8887: =item B<$uid> Students id/student number
8888:
8889: =item B<$umode> Students authentication mode
8890:
8891: =item B<$upass> Students password
8892:
8893: =item B<$first> Students first name
8894:
8895: =item B<$middle> Students middle name
8896:
8897: =item B<$last> Students last name
8898:
8899: =item B<$gene> Students generation
8900:
8901: =item B<$usec> Students section in course
8902:
8903: =item B<$end> Unix time of the roles expiration
8904:
8905: =item B<$start> Unix time of the roles start date
8906:
8907: =item B<$forceid> If defined, allow $uid to be changed
8908:
8909: =item B<$desiredhome> server to use as home server for student
8910:
8911: =back
1.297 matthew 8912:
8913: =item *
8914:
8915: modify_student_enrollment
8916:
8917: Change a students enrollment status in a class. The environment variable
8918: 'role.request.course' must be defined for this function to proceed.
8919:
8920: Inputs:
8921:
8922: =over 4
8923:
8924: =item $udom, students domain
8925:
8926: =item $uname, students name
8927:
8928: =item $uid, students user id
8929:
8930: =item $first, students first name
8931:
8932: =item $middle
8933:
8934: =item $last
8935:
8936: =item $gene
8937:
8938: =item $usec
8939:
8940: =item $end
8941:
8942: =item $start
8943:
8944: =back
8945:
1.191 harris41 8946:
8947: =item *
8948:
1.243 albertel 8949: assigncustomrole($udom,$uname,$url,$rdom,$rnam,$rolename,$end,$start) : assign
8950: custom role; give a custom role to a user for the level given by URL. Specify
8951: name and domain of role author, and role name
1.191 harris41 8952:
8953: =item *
8954:
1.243 albertel 8955: revokerole($udom,$uname,$url,$role) : revoke a role for url
1.191 harris41 8956:
8957: =item *
8958:
1.243 albertel 8959: revokecustomrole($udom,$uname,$url,$role) : revoke a custom role
8960:
8961: =back
8962:
8963: =head2 Course Infomation
8964:
8965: =over 4
1.191 harris41 8966:
8967: =item *
8968:
1.631 albertel 8969: coursedescription($courseid) : returns a hash of information about the
8970: specified course id, including all environment settings for the
8971: course, the description of the course will be in the hash under the
8972: key 'description'
1.191 harris41 8973:
8974: =item *
8975:
1.624 albertel 8976: resdata($name,$domain,$type,@which) : request for current parameter
8977: setting for a specific $type, where $type is either 'course' or 'user',
8978: @what should be a list of parameters to ask about. This routine caches
8979: answers for 5 minutes.
1.243 albertel 8980:
1.877 foxr 8981: =item *
8982:
8983: get_courseresdata($courseid, $domain) : dump the entire course resource
8984: data base, returning a hash that is keyed by the resource name and has
8985: values that are the resource value. I believe that the timestamps and
8986: versions are also returned.
8987:
8988:
1.243 albertel 8989: =back
8990:
8991: =head2 Course Modification
8992:
8993: =over 4
1.191 harris41 8994:
8995: =item *
8996:
1.243 albertel 8997: writecoursepref($courseid,%prefs) : write preferences (environment
8998: database) for a course
1.191 harris41 8999:
9000: =item *
9001:
1.243 albertel 9002: createcourse($udom,$description,$url) : make/modify course
9003:
9004: =back
9005:
9006: =head2 Resource Subroutines
9007:
9008: =over 4
1.191 harris41 9009:
9010: =item *
9011:
1.243 albertel 9012: subscribe($fname) : subscribe to a resource, returns URL if possible (probably should use repcopy instead)
1.191 harris41 9013:
9014: =item *
9015:
1.243 albertel 9016: repcopy($filename) : subscribes to the requested file, and attempts to
9017: replicate from the owning library server, Might return
1.607 raeburn 9018: 'unavailable', 'not_found', 'forbidden', 'ok', or
9019: 'bad_request', also attempts to grab the metadata for the
1.243 albertel 9020: resource. Expects the local filesystem pathname
9021: (/home/httpd/html/res/....)
9022:
9023: =back
9024:
9025: =head2 Resource Information
9026:
9027: =over 4
1.191 harris41 9028:
9029: =item *
9030:
1.243 albertel 9031: EXT($varname,$symb,$udom,$uname) : evaluates and returns the value of
9032: a vairety of different possible values, $varname should be a request
9033: string, and the other parameters can be used to specify who and what
9034: one is asking about.
9035:
9036: Possible values for $varname are environment.lastname (or other item
9037: from the envirnment hash), user.name (or someother aspect about the
9038: user), resource.0.maxtries (or some other part and parameter of a
9039: resource)
1.204 albertel 9040:
9041: =item *
9042:
1.243 albertel 9043: directcondval($number) : get current value of a condition; reads from a state
9044: string
1.204 albertel 9045:
9046: =item *
9047:
1.243 albertel 9048: condval($condidx) : value of condition index based on state
1.204 albertel 9049:
9050: =item *
9051:
1.243 albertel 9052: metadata($uri,$what,$liburi,$prefix,$depthcount) : request a
9053: resource's metadata, $what should be either a specific key, or either
9054: 'keys' (to get a list of possible keys) or 'packages' to get a list of
9055: packages that this resource currently uses, the last 3 arguments are only used internally for recursive metadata.
9056:
9057: this function automatically caches all requests
1.191 harris41 9058:
9059: =item *
9060:
1.243 albertel 9061: metadata_query($query,$custom,$customshow) : make a metadata query against the
9062: network of library servers; returns file handle of where SQL and regex results
9063: will be stored for query
1.191 harris41 9064:
9065: =item *
9066:
1.243 albertel 9067: symbread($filename) : return symbolic list entry (filename argument optional);
9068: returns the data handle
1.191 harris41 9069:
9070: =item *
9071:
1.243 albertel 9072: symbverify($symb,$thisfn) : verifies that $symb actually exists and is
1.582 albertel 9073: a possible symb for the URL in $thisfn, and if is an encryypted
9074: resource that the user accessed using /enc/ returns a 1 on success, 0
9075: on failure, user must be in a course, as it assumes the existance of
1.620 albertel 9076: the course initial hash, and uses $env('request.course.id'}
1.243 albertel 9077:
1.191 harris41 9078:
9079: =item *
9080:
1.243 albertel 9081: symbclean($symb) : removes versions numbers from a symb, returns the
9082: cleaned symb
1.191 harris41 9083:
9084: =item *
9085:
1.243 albertel 9086: is_on_map($uri) : checks if the $uri is somewhere on the current
9087: course map, user must be in a course for it to work.
1.191 harris41 9088:
9089: =item *
9090:
1.243 albertel 9091: numval($salt) : return random seed value (addend for rndseed)
1.191 harris41 9092:
9093: =item *
9094:
1.243 albertel 9095: rndseed($symb,$courseid,$udom,$uname) : create a random sum; returns
9096: a random seed, all arguments are optional, if they aren't sent it uses the
9097: environment to derive them. Note: if symb isn't sent and it can't get one
9098: from &symbread it will use the current time as its return value
1.191 harris41 9099:
9100: =item *
9101:
1.243 albertel 9102: ireceipt($funame,$fudom,$fucourseid,$fusymb) : return unique,
9103: unfakeable, receipt
1.191 harris41 9104:
9105: =item *
9106:
1.620 albertel 9107: receipt() : API to ireceipt working off of env values; given out to users
1.191 harris41 9108:
9109: =item *
9110:
1.243 albertel 9111: countacc($url) : count the number of accesses to a given URL
1.191 harris41 9112:
9113: =item *
9114:
1.243 albertel 9115: 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 9116:
9117: =item *
9118:
1.243 albertel 9119: 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 9120:
9121: =item *
9122:
1.243 albertel 9123: expirespread($uname,$udom,$stype,$usymb) : set expire date for spreadsheet
1.191 harris41 9124:
9125: =item *
9126:
1.243 albertel 9127: devalidate($symb) : devalidate temporary spreadsheet calculations,
9128: forcing spreadsheet to reevaluate the resource scores next time.
9129:
9130: =back
9131:
9132: =head2 Storing/Retreiving Data
9133:
9134: =over 4
1.191 harris41 9135:
9136: =item *
9137:
1.243 albertel 9138: store($storehash,$symb,$namespace,$udom,$uname) : stores hash permanently
9139: for this url; hashref needs to be given and should be a \%hashname; the
9140: remaining args aren't required and if they aren't passed or are '' they will
1.620 albertel 9141: be derived from the env
1.191 harris41 9142:
9143: =item *
9144:
1.243 albertel 9145: cstore($storehash,$symb,$namespace,$udom,$uname) : same as store but
9146: uses critical subroutine
1.191 harris41 9147:
9148: =item *
9149:
1.243 albertel 9150: restore($symb,$namespace,$udom,$uname) : returns hash for this symb;
9151: all args are optional
1.191 harris41 9152:
9153: =item *
9154:
1.717 albertel 9155: dumpstore($namespace,$udom,$uname,$regexp,$range) :
9156: dumps the complete (or key matching regexp) namespace into a hash
9157: ($udom, $uname, $regexp, $range are optional) for a namespace that is
9158: normally &store()ed into
9159:
9160: $range should be either an integer '100' (give me the first 100
9161: matching records)
9162: or be two integers sperated by a - with no spaces
9163: '30-50' (give me the 30th through the 50th matching
9164: records)
9165:
9166:
9167: =item *
9168:
9169: putstore($namespace,$symb,$version,$storehash,$udomain,$uname) :
9170: replaces a &store() version of data with a replacement set of data
9171: for a particular resource in a namespace passed in the $storehash hash
9172: reference
9173:
9174: =item *
9175:
1.243 albertel 9176: tmpstore($storehash,$symb,$namespace,$udom,$uname) : storage that
9177: works very similar to store/cstore, but all data is stored in a
9178: temporary location and can be reset using tmpreset, $storehash should
9179: be a hash reference, returns nothing on success
1.191 harris41 9180:
9181: =item *
9182:
1.243 albertel 9183: tmprestore($symb,$namespace,$udom,$uname) : storage that works very
9184: similar to restore, but all data is stored in a temporary location and
9185: can be reset using tmpreset. Returns a hash of values on success,
9186: error string otherwise.
1.191 harris41 9187:
9188: =item *
9189:
1.243 albertel 9190: tmpreset($symb,$namespace,$udom,$uname) : temporary storage reset,
9191: deltes all keys for $symb form the temporary storage hash.
1.191 harris41 9192:
9193: =item *
9194:
1.243 albertel 9195: get($namespace,$storearr,$udom,$uname) : returns hash with keys from array
9196: reference filled in from namesp ($udom and $uname are optional)
1.191 harris41 9197:
9198: =item *
9199:
1.243 albertel 9200: del($namespace,$storearr,$udom,$uname) : deletes keys out of array from
9201: namesp ($udom and $uname are optional)
1.191 harris41 9202:
9203: =item *
9204:
1.702 albertel 9205: dump($namespace,$udom,$uname,$regexp,$range) :
1.243 albertel 9206: dumps the complete (or key matching regexp) namespace into a hash
1.702 albertel 9207: ($udom, $uname, $regexp, $range are optional)
1.449 matthew 9208:
1.702 albertel 9209: $range should be either an integer '100' (give me the first 100
9210: matching records)
9211: or be two integers sperated by a - with no spaces
9212: '30-50' (give me the 30th through the 50th matching
9213: records)
1.449 matthew 9214: =item *
9215:
9216: inc($namespace,$store,$udom,$uname) : increments $store in $namespace.
9217: $store can be a scalar, an array reference, or if the amount to be
9218: incremented is > 1, a hash reference.
9219:
9220: ($udom and $uname are optional)
1.191 harris41 9221:
9222: =item *
9223:
1.243 albertel 9224: put($namespace,$storehash,$udom,$uname) : stores hash in namesp
9225: ($udom and $uname are optional)
1.191 harris41 9226:
9227: =item *
9228:
1.243 albertel 9229: cput($namespace,$storehash,$udom,$uname) : critical put
9230: ($udom and $uname are optional)
1.191 harris41 9231:
9232: =item *
9233:
1.748 albertel 9234: newput($namespace,$storehash,$udom,$uname) :
9235:
9236: Attempts to store the items in the $storehash, but only if they don't
9237: currently exist, if this succeeds you can be certain that you have
9238: successfully created a new key value pair in the $namespace db.
9239:
9240:
9241: Args:
9242: $namespace: name of database to store values to
9243: $storehash: hashref to store to the db
9244: $udom: (optional) domain of user containing the db
9245: $uname: (optional) name of user caontaining the db
9246:
9247: Returns:
9248: 'ok' -> succeeded in storing all keys of $storehash
9249: 'key_exists: <key>' -> failed to anything out of $storehash, as at
9250: least <key> already existed in the db (other
9251: requested keys may also already exist)
9252: 'error: <msg>' -> unable to tie the DB or other erorr occured
9253: 'con_lost' -> unable to contact request server
9254: 'refused' -> action was not allowed by remote machine
9255:
9256:
9257: =item *
9258:
1.243 albertel 9259: eget($namespace,$storearr,$udom,$uname) : returns hash with keys from array
9260: reference filled in from namesp (encrypts the return communication)
9261: ($udom and $uname are optional)
1.191 harris41 9262:
9263: =item *
9264:
1.243 albertel 9265: log($udom,$name,$home,$message) : write to permanent log for user; use
9266: critical subroutine
9267:
1.806 raeburn 9268: =item *
9269:
1.860 raeburn 9270: get_dom($namespace,$storearr,$udom,$uhome) : returns hash with keys from
9271: array reference filled in from namespace found in domain level on either
9272: specified domain server ($uhome) or primary domain server ($udom and $uhome are optional).
1.806 raeburn 9273:
9274: =item *
9275:
1.860 raeburn 9276: put_dom($namespace,$storehash,$udom,$uhome) : stores hash in namespace at
9277: domain level either on specified domain server ($uhome) or primary domain
9278: server ($udom and $uhome are optional)
1.806 raeburn 9279:
1.243 albertel 9280: =back
9281:
9282: =head2 Network Status Functions
9283:
9284: =over 4
1.191 harris41 9285:
9286: =item *
9287:
9288: dirlist($uri) : return directory list based on URI
9289:
9290: =item *
9291:
1.243 albertel 9292: spareserver() : find server with least workload from spare.tab
9293:
9294: =back
9295:
9296: =head2 Apache Request
9297:
9298: =over 4
1.191 harris41 9299:
9300: =item *
9301:
1.243 albertel 9302: ssi($url,%hash) : server side include, does a complete request cycle on url to
9303: localhost, posts hash
9304:
9305: =back
9306:
9307: =head2 Data to String to Data
9308:
9309: =over 4
1.191 harris41 9310:
9311: =item *
9312:
1.243 albertel 9313: hash2str(%hash) : convert a hash into a string complete with escaping and '='
9314: and '&' separators, supports elements that are arrayrefs and hashrefs
1.191 harris41 9315:
9316: =item *
9317:
1.243 albertel 9318: hashref2str($hashref) : convert a hashref into a string complete with
9319: escaping and '=' and '&' separators, supports elements that are
9320: arrayrefs and hashrefs
1.191 harris41 9321:
9322: =item *
9323:
1.243 albertel 9324: arrayref2str($arrayref) : convert an arrayref into a string complete
9325: with escaping and '&' separators, supports elements that are arrayrefs
9326: and hashrefs
1.191 harris41 9327:
9328: =item *
9329:
1.243 albertel 9330: str2hash($string) : convert string to hash using unescaping and
9331: splitting on '=' and '&', supports elements that are arrayrefs and
9332: hashrefs
1.191 harris41 9333:
9334: =item *
9335:
1.243 albertel 9336: str2array($string) : convert string to hash using unescaping and
9337: splitting on '&', supports elements that are arrayrefs and hashrefs
9338:
9339: =back
9340:
9341: =head2 Logging Routines
9342:
9343: =over 4
9344:
9345: These routines allow one to make log messages in the lonnet.log and
9346: lonnet.perm logfiles.
1.191 harris41 9347:
9348: =item *
9349:
1.243 albertel 9350: logtouch() : make sure the logfile, lonnet.log, exists
1.191 harris41 9351:
9352: =item *
9353:
1.243 albertel 9354: logthis() : append message to the normal lonnet.log file, it gets
9355: preiodically rolled over and deleted.
1.191 harris41 9356:
9357: =item *
9358:
1.243 albertel 9359: logperm() : append a permanent message to lonnet.perm.log, this log
9360: file never gets deleted by any automated portion of the system, only
9361: messages of critical importance should go in here.
9362:
9363: =back
9364:
9365: =head2 General File Helper Routines
9366:
9367: =over 4
1.191 harris41 9368:
9369: =item *
9370:
1.481 raeburn 9371: getfile($file,$caller) : two cases - requests for files in /res or in /uploaded.
9372: (a) files in /uploaded
9373: (i) If a local copy of the file exists -
9374: compares modification date of local copy with last-modified date for
9375: definitive version stored on home server for course. If local copy is
9376: stale, requests a new version from the home server and stores it.
9377: If the original has been removed from the home server, then local copy
9378: is unlinked.
9379: (ii) If local copy does not exist -
9380: requests the file from the home server and stores it.
9381:
9382: If $caller is 'uploadrep':
9383: This indicates a call from lonuploadrep.pm (PerlHeaderParserHandler phase)
9384: for request for files originally uploaded via DOCS.
9385: - returns 'ok' if fresh local copy now available, -1 otherwise.
9386:
9387: Otherwise:
9388: This indicates a call from the content generation phase of the request.
9389: - returns the entire contents of the file or -1.
9390:
9391: (b) files in /res
9392: - returns the entire contents of a file or -1;
9393: it properly subscribes to and replicates the file if neccessary.
1.191 harris41 9394:
1.712 albertel 9395:
9396: =item *
9397:
9398: stat_file($url) : $url is expected to be a /res/ or /uploaded/ style file
9399: reference
9400:
9401: returns either a stat() list of data about the file or an empty list
9402: if the file doesn't exist or couldn't find out about it (connection
9403: problems or user unknown)
9404:
1.191 harris41 9405: =item *
9406:
1.243 albertel 9407: filelocation($dir,$file) : returns file system location of a file
9408: based on URI; meant to be "fairly clean" absolute reference, $dir is a
9409: directory that relative $file lookups are to looked in ($dir of /a/dir
9410: and a file of ../bob will become /a/bob)
1.191 harris41 9411:
9412: =item *
9413:
9414: hreflocation($dir,$file) : returns file system location or a URL; same as
9415: filelocation except for hrefs
9416:
9417: =item *
9418:
9419: declutter() : declutters URLs (remove docroot, beginning slashes, 'res' etc)
9420:
1.243 albertel 9421: =back
9422:
1.608 albertel 9423: =head2 Usererfile file routines (/uploaded*)
9424:
9425: =over 4
9426:
9427: =item *
9428:
9429: userfileupload(): main rotine for putting a file in a user or course's
9430: filespace, arguments are,
9431:
1.620 albertel 9432: formname - required - this is the name of the element in $env where the
1.608 albertel 9433: filename, and the contents of the file to create/modifed exist
1.620 albertel 9434: the filename is in $env{'form.'.$formname.'.filename'} and the
9435: contents of the file is located in $env{'form.'.$formname}
1.608 albertel 9436: coursedoc - if true, store the file in the course of the active role
9437: of the current user
9438: subdir - required - subdirectory to put the file in under ../userfiles/
9439: if undefined, it will be placed in "unknown"
9440:
9441: (This routine calls clean_filename() to remove any dangerous
9442: characters from the filename, and then calls finuserfileupload() to
9443: complete the transaction)
9444:
9445: returns either the url of the uploaded file (/uploaded/....) if successful
9446: and /adm/notfound.html if unsuccessful
9447:
9448: =item *
9449:
9450: clean_filename(): routine for cleaing a filename up for storage in
9451: userfile space, argument is:
9452:
9453: filename - proposed filename
9454:
9455: returns: the new clean filename
9456:
9457: =item *
9458:
9459: finishuserfileupload(): routine that creaes and sends the file to
9460: userspace, probably shouldn't be called directly
9461:
9462: docuname: username or courseid of destination for the file
9463: docudom: domain of user/course of destination for the file
9464: formname: same as for userfileupload()
9465: fname: filename (inculding subdirectories) for the file
9466:
9467: returns either the url of the uploaded file (/uploaded/....) if successful
9468: and /adm/notfound.html if unsuccessful
9469:
9470: =item *
9471:
9472: renameuserfile(): renames an existing userfile to a new name
9473:
9474: Args:
9475: docuname: username or courseid of destination for the file
9476: docudom: domain of user/course of destination for the file
9477: old: current file name (including any subdirs under userfiles)
9478: new: desired file name (including any subdirs under userfiles)
9479:
9480: =item *
9481:
9482: mkdiruserfile(): creates a directory is a userfiles dir
9483:
9484: Args:
9485: docuname: username or courseid of destination for the file
9486: docudom: domain of user/course of destination for the file
9487: dir: dir to create (including any subdirs under userfiles)
9488:
9489: =item *
9490:
9491: removeuserfile(): removes a file that exists in userfiles
9492:
9493: Args:
9494: docuname: username or courseid of destination for the file
9495: docudom: domain of user/course of destination for the file
9496: fname: filname to delete (including any subdirs under userfiles)
9497:
9498: =item *
9499:
9500: removeuploadedurl(): convience function for removeuserfile()
9501:
9502: Args:
9503: url: a full /uploaded/... url to delete
9504:
1.747 albertel 9505: =item *
9506:
9507: get_portfile_permissions():
9508: Args:
9509: domain: domain of user or course contain the portfolio files
9510: user: name of user or num of course contain the portfolio files
9511: Returns:
9512: hashref of a dump of the proper file_permissions.db
9513:
9514:
9515: =item *
9516:
9517: get_access_controls():
9518:
9519: Args:
9520: current_permissions: the hash ref returned from get_portfile_permissions()
9521: group: (optional) the group you want the files associated with
9522: file: (optional) the file you want access info on
9523:
9524: Returns:
1.749 raeburn 9525: a hash (keys are file names) of hashes containing
9526: keys are: path to file/file_name\0uniqueID:scope_end_start (see below)
9527: values are XML containing access control settings (see below)
1.747 albertel 9528:
9529: Internal notes:
9530:
1.749 raeburn 9531: access controls are stored in file_permissions.db as key=value pairs.
9532: key -> path to file/file_name\0uniqueID:scope_end_start
9533: where scope -> public,guest,course,group,domains or users.
9534: end -> UNIX time for end of access (0 -> no end date)
9535: start -> UNIX time for start of access
9536:
9537: value -> XML description of access control
9538: <scope type=""> (type =1 of: public,guest,course,group,domains,users">
9539: <start></start>
9540: <end></end>
9541:
9542: <password></password> for scope type = guest
9543:
9544: <domain></domain> for scope type = course or group
9545: <number></number>
9546: <roles id="">
9547: <role></role>
9548: <access></access>
9549: <section></section>
9550: <group></group>
9551: </roles>
9552:
9553: <dom></dom> for scope type = domains
9554:
9555: <users> for scope type = users
9556: <user>
9557: <uname></uname>
9558: <udom></udom>
9559: </user>
9560: </users>
9561: </scope>
9562:
9563: Access data is also aggregated for each file in an additional key=value pair:
9564: key -> path to file/file_name\0accesscontrol
9565: value -> reference to hash
9566: hash contains key = value pairs
9567: where key = uniqueID:scope_end_start
9568: value = UNIX time record was last updated
9569:
9570: Used to improve speed of look-ups of access controls for each file.
9571:
9572: Locks on files (resulting from submission of portfolio file to a homework problem stored in array of arrays.
9573:
9574: modify_access_controls():
9575:
9576: Modifies access controls for a portfolio file
9577: Args
9578: 1. file name
9579: 2. reference to hash of required changes,
9580: 3. domain
9581: 4. username
9582: where domain,username are the domain of the portfolio owner
9583: (either a user or a course)
9584:
9585: Returns:
9586: 1. result of additions or updates ('ok' or 'error', with error message).
9587: 2. result of deletions ('ok' or 'error', with error message).
9588: 3. reference to hash of any new or updated access controls.
9589: 4. reference to hash used to map incoming IDs to uniqueIDs assigned to control.
9590: key = integer (inbound ID)
9591: value = uniqueID
1.747 albertel 9592:
1.608 albertel 9593: =back
9594:
1.243 albertel 9595: =head2 HTTP Helper Routines
9596:
9597: =over 4
9598:
1.191 harris41 9599: =item *
9600:
9601: escape() : unpack non-word characters into CGI-compatible hex codes
9602:
9603: =item *
9604:
9605: unescape() : pack CGI-compatible hex codes into actual non-word ASCII character
9606:
1.243 albertel 9607: =back
9608:
9609: =head1 PRIVATE SUBROUTINES
9610:
9611: =head2 Underlying communication routines (Shouldn't call)
9612:
9613: =over 4
9614:
9615: =item *
9616:
9617: subreply() : tries to pass a message to lonc, returns con_lost if incapable
9618:
9619: =item *
9620:
9621: reply() : uses subreply to send a message to remote machine, logs all failures
9622:
9623: =item *
9624:
9625: critical() : passes a critical message to another server; if cannot
9626: get through then place message in connection buffer directory and
9627: returns con_delayed, if incapable of saving message, returns
9628: con_failed
9629:
9630: =item *
9631:
9632: reconlonc() : tries to reconnect lonc client processes.
9633:
9634: =back
9635:
9636: =head2 Resource Access Logging
9637:
9638: =over 4
9639:
9640: =item *
9641:
9642: flushcourselogs() : flush (save) buffer logs and access logs
9643:
9644: =item *
9645:
9646: courselog($what) : save message for course in hash
9647:
9648: =item *
9649:
9650: courseacclog($what) : save message for course using &courselog(). Perform
9651: special processing for specific resource types (problems, exams, quizzes, etc).
9652:
1.191 harris41 9653: =item *
9654:
9655: goodbye() : flush course logs and log shutting down; it is called in srm.conf
9656: as a PerlChildExitHandler
1.243 albertel 9657:
9658: =back
9659:
9660: =head2 Other
9661:
9662: =over 4
9663:
9664: =item *
9665:
9666: symblist($mapname,%newhash) : update symbolic storage links
1.191 harris41 9667:
9668: =back
9669:
9670: =cut
1.877 foxr 9671:
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