1: # The LearningOnline Network
2: # TCP networking package
3: #
4: # $Id: lonnet.pm,v 1.898 2007/07/20 23:16:19 albertel Exp $
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: #
28: ###
29:
30: package Apache::lonnet;
31:
32: use strict;
33: use LWP::UserAgent();
34: use HTTP::Date;
35: # use Date::Parse;
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);
43:
44: use IO::Socket;
45: use GDBM_File;
46: use HTML::LCParser;
47: use Fcntl qw(:flock);
48: use Storable qw(thaw nfreeze);
49: use Time::HiRes qw( gettimeofday tv_interval );
50: use Cache::Memcached;
51: use Digest::MD5;
52: use Math::Random;
53: use LONCAPA qw(:DEFAULT :match);
54: use LONCAPA::Configuration;
55:
56: my $readit;
57: my $max_connection_retries = 10; # Or some such value.
58:
59: require Exporter;
60:
61: our @ISA = qw (Exporter);
62: our @EXPORT = qw(%env);
63:
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:
87: # --------------------------------------------------------------------- Logging
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,
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: },
106: $env{'course.'.$env{'request.course.id'}.'.domain'},
107: $env{'course.'.$env{'request.course.id'}.'.num'}
108: );
109: }
110: }
111:
112: sub logtouch {
113: my $execdir=$perlvar{'lonDaemons'};
114: unless (-e "$execdir/logs/lonnet.log") {
115: open(my $fh,">>$execdir/logs/lonnet.log");
116: close $fh;
117: }
118: my ($wwwuid,$wwwgid)=(getpwnam('www'))[2,3];
119: chown($wwwuid,$wwwgid,$execdir.'/logs/lonnet.log');
120: }
121:
122: sub logthis {
123: my $message=shift;
124: my $execdir=$perlvar{'lonDaemons'};
125: my $now=time;
126: my $local=localtime($now);
127: if (open(my $fh,">>$execdir/logs/lonnet.log")) {
128: print $fh "$local ($$): $message\n";
129: close($fh);
130: }
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);
139: if (open(my $fh,">>$execdir/logs/lonnet.perm.log")) {
140: print $fh "$now:$message:$local\n";
141: close($fh);
142: }
143: return 1;
144: }
145:
146: sub create_connection {
147: my ($hostname,$lonid) = @_;
148: my $client=IO::Socket::UNIX->new(Peer => $perlvar{'lonSockCreate'},
149: Type => SOCK_STREAM,
150: Timeout => 10);
151: return 0 if (!$client);
152: print $client (join(':',$hostname,$lonid,&machine_ids($hostname))."\n");
153: my $result = <$client>;
154: chomp($result);
155: return 1 if ($result eq 'done');
156: return 0;
157: }
158:
159:
160: # -------------------------------------------------- Non-critical communication
161: sub subreply {
162: my ($cmd,$server)=@_;
163: my $peerfile="$perlvar{'lonSockDir'}/".&hostname($server);
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
174: # or loncnew child is listening so we can connect or everything's dead.
175: #
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);
184: if ($client) {
185: last; # Connected!
186: } else {
187: &create_connection(&hostname($server),$server);
188: }
189: sleep(1); # Try again later if failed connection.
190: }
191: my $answer;
192: if ($client) {
193: print $client "sethost:$server:$cmd\n";
194: $answer=<$client>;
195: if (!$answer) { $answer="con_lost"; }
196: chomp($answer);
197: } else {
198: $answer = 'con_lost'; # Failed connection.
199: }
200: return $answer;
201: }
202:
203: sub reply {
204: my ($cmd,$server)=@_;
205: unless (defined(&hostname($server))) { return 'no_such_host'; }
206: my $answer=subreply($cmd,$server);
207: if (($answer=~/^refused/) || ($answer=~/^rejected/)) {
208: &logthis("<font color=\"blue\">WARNING:".
209: " $cmd to $server returned $answer</font>");
210: }
211: return $answer;
212: }
213:
214: # ----------------------------------------------------------- Send USR1 to lonc
215:
216: sub reconlonc {
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:
235: &logthis("Trying to reconnect lonc");
236: my $loncfile="$perlvar{'lonDaemons'}/logs/lonc.pid";
237: if (open(my $fh,"<$loncfile")) {
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;
244: } else {
245: &logthis(
246: "<font color=\"blue\">WARNING:".
247: " lonc at pid $loncpid not responding, giving up</font>");
248: }
249: } else {
250: &logthis('<font color="blue">WARNING: lonc not running, giving up</font>');
251: }
252: }
253:
254: # ------------------------------------------------------ Critical communication
255:
256: sub critical {
257: my ($cmd,$server)=@_;
258: unless (&hostname($server)) {
259: &logthis("<font color=\"blue\">WARNING:".
260: " Critical message to unknown server ($server)</font>");
261: return 'no_such_host';
262: }
263: my $answer=reply($cmd,$server);
264: if ($answer eq 'con_lost') {
265: &reconlonc("$perlvar{'lonSockDir'}/$server");
266: my $answer=reply($cmd,$server);
267: if ($answer eq 'con_lost') {
268: my $now=time;
269: my $middlename=$cmd;
270: $middlename=substr($middlename,0,16);
271: $middlename=~s/\W//g;
272: my $dfilename=
273: "$perlvar{'lonSockDir'}/delayed/$now.$dumpcount.$$.$middlename.$server";
274: $dumpcount++;
275: {
276: my $dfh;
277: if (open($dfh,">$dfilename")) {
278: print $dfh "$cmd\n";
279: close($dfh);
280: }
281: }
282: sleep 2;
283: my $wcmd='';
284: {
285: my $dfh;
286: if (open($dfh,"<$dfilename")) {
287: $wcmd=<$dfh>;
288: close($dfh);
289: }
290: }
291: chomp($wcmd);
292: if ($wcmd eq $cmd) {
293: &logthis("<font color=\"blue\">WARNING: ".
294: "Connection buffer $dfilename: $cmd</font>");
295: &logperm("D:$server:$cmd");
296: return 'con_delayed';
297: } else {
298: &logthis("<font color=\"red\">CRITICAL:"
299: ." Critical connection failed: $server $cmd</font>");
300: &logperm("F:$server:$cmd");
301: return 'con_failed';
302: }
303: }
304: }
305: return $answer;
306: }
307:
308: # ------------------------------------------- check if return value is an error
309:
310: sub error {
311: my ($result) = @_;
312: if ($result =~ /^(con_lost|no_such_host|error: (\d+) (.*))/) {
313: if ($2 == 2) { return undef; }
314: return $1;
315: }
316: return undef;
317: }
318:
319: sub convert_and_load_session_env {
320: my ($lonidsdir,$handle)=@_;
321: my @profile;
322: {
323: open(my $idf,"$lonidsdir/$handle.id");
324: flock($idf,LOCK_SH);
325: @profile=<$idf>;
326: close($idf);
327: }
328: my %temp_env;
329: foreach my $line (@profile) {
330: if ($line !~ m/=/) {
331: return 0;
332: }
333: chomp($line);
334: my ($envname,$envvalue)=split(/=/,$line,2);
335: $temp_env{&unescape($envname)} = &unescape($envvalue);
336: }
337: unlink("$lonidsdir/$handle.id");
338: if (tie(my %disk_env,'GDBM_File',"$lonidsdir/$handle.id",&GDBM_WRCREAT(),
339: 0640)) {
340: %disk_env = %temp_env;
341: @env{keys(%temp_env)} = @disk_env{keys(%temp_env)};
342: untie(%disk_env);
343: }
344: return 1;
345: }
346:
347: # ------------------------------------------- Transfer profile into environment
348: my $env_loaded;
349: sub transfer_profile_to_env {
350: my ($lonidsdir,$handle,$force_transfer) = @_;
351: if (!$force_transfer && $env_loaded) { return; }
352:
353: if (!defined($lonidsdir)) {
354: $lonidsdir = $perlvar{'lonIDsDir'};
355: }
356: if (!defined($handle)) {
357: ($handle) = ($env{'user.environment'} =~m|/([^/]+)\.id$| );
358: }
359:
360: my $convert;
361: {
362: open(my $idf,"$lonidsdir/$handle.id");
363: flock($idf,LOCK_SH);
364: if (tie(my %disk_env,'GDBM_File',"$lonidsdir/$handle.id",
365: &GDBM_READER(),0640)) {
366: @env{keys(%disk_env)} = @disk_env{keys(%disk_env)};
367: untie(%disk_env);
368: } else {
369: $convert = 1;
370: }
371: }
372: if ($convert) {
373: if (!&convert_and_load_session_env($lonidsdir,$handle)) {
374: &logthis("Failed to load session, or convert session.");
375: }
376: }
377:
378: my %remove;
379: while ( my $envname = each(%env) ) {
380: if (my ($key,$time) = ($envname =~ /^(cgi\.(\d+)_\d+\.)/)) {
381: if ($time < time-300) {
382: $remove{$key}++;
383: }
384: }
385: }
386:
387: $env{'user.environment'} = "$lonidsdir/$handle.id";
388: $env_loaded=1;
389: foreach my $expired_key (keys(%remove)) {
390: &delenv($expired_key);
391: }
392: }
393:
394: sub timed_flock {
395: my ($file,$lock_type) = @_;
396: my $failed=0;
397: eval {
398: local $SIG{__DIE__}='DEFAULT';
399: local $SIG{ALRM}=sub {
400: $failed=1;
401: die("failed lock");
402: };
403: alarm(13);
404: flock($file,$lock_type);
405: alarm(0);
406: };
407: if ($failed) {
408: return undef;
409: } else {
410: return 1;
411: }
412: }
413:
414: # ---------------------------------------------------------- Append Environment
415:
416: sub appenv {
417: my %newenv=@_;
418: foreach my $key (keys(%newenv)) {
419: if (($newenv{$key}=~/^user\.role/) || ($newenv{$key}=~/^user\.priv/)) {
420: &logthis("<font color=\"blue\">WARNING: ".
421: "Attempt to modify environment ".$key." to ".$newenv{$key}
422: .'</font>');
423: delete($newenv{$key});
424: } else {
425: $env{$key}=$newenv{$key};
426: }
427: }
428: open(my $env_file,$env{'user.environment'});
429: if (&timed_flock($env_file,LOCK_EX)
430: &&
431: tie(my %disk_env,'GDBM_File',$env{'user.environment'},
432: (&GDBM_WRITER()|&GDBM_NOLOCK()),0640)) {
433: while (my ($key,$value) = each(%newenv)) {
434: $disk_env{$key} = $value;
435: }
436: untie(%disk_env);
437: }
438: return 'ok';
439: }
440: # ----------------------------------------------------- Delete from Environment
441:
442: sub delenv {
443: my $delthis=shift;
444: if (($delthis=~/user\.role/) || ($delthis=~/user\.priv/)) {
445: &logthis("<font color=\"blue\">WARNING: ".
446: "Attempt to delete from environment ".$delthis);
447: return 'error';
448: }
449: open(my $env_file,$env{'user.environment'});
450: if (&timed_flock($env_file,LOCK_EX)
451: &&
452: tie(my %disk_env,'GDBM_File',$env{'user.environment'},
453: (&GDBM_WRITER()|&GDBM_NOLOCK()),0640)) {
454: foreach my $key (keys(%disk_env)) {
455: if ($key=~/^$delthis/) {
456: delete($env{$key});
457: delete($disk_env{$key});
458: }
459: }
460: untie(%disk_env);
461: }
462: return 'ok';
463: }
464:
465: sub get_env_multiple {
466: my ($name) = @_;
467: my @values;
468: if (defined($env{$name})) {
469: # exists is it an array
470: if (ref($env{$name})) {
471: @values=@{ $env{$name} };
472: } else {
473: $values[0]=$env{$name};
474: }
475: }
476: return(@values);
477: }
478:
479: # ------------------------------------------ Find out current server userload
480: # there is a copy in lond
481: sub userload {
482: my $numusers=0;
483: {
484: opendir(LONIDS,$perlvar{'lonIDsDir'});
485: my $filename;
486: my $curtime=time;
487: while ($filename=readdir(LONIDS)) {
488: if ($filename eq '.' || $filename eq '..') {next;}
489: my ($mtime)=(stat($perlvar{'lonIDsDir'}.'/'.$filename))[9];
490: if ($curtime-$mtime < 1800) { $numusers++; }
491: }
492: closedir(LONIDS);
493: }
494: my $userloadpercent=0;
495: my $maxuserload=$perlvar{'lonUserLoadLim'};
496: if ($maxuserload) {
497: $userloadpercent=100*$numusers/$maxuserload;
498: }
499: $userloadpercent=sprintf("%.2f",$userloadpercent);
500: return $userloadpercent;
501: }
502:
503: # ------------------------------------------ Fight off request when overloaded
504:
505: sub overloaderror {
506: my ($r,$checkserver)=@_;
507: unless ($checkserver) { $checkserver=$perlvar{'lonHostID'}; }
508: my $loadavg;
509: if ($checkserver eq $perlvar{'lonHostID'}) {
510: open(my $loadfile,'/proc/loadavg');
511: $loadavg=<$loadfile>;
512: $loadavg =~ s/\s.*//g;
513: $loadavg = 100*$loadavg/$perlvar{'lonLoadLim'};
514: close($loadfile);
515: } else {
516: $loadavg=&reply('load',$checkserver);
517: }
518: my $overload=$loadavg-100;
519: if ($overload>0) {
520: $r->err_headers_out->{'Retry-After'}=$overload;
521: $r->log_error('Overload of '.$overload.' on '.$checkserver);
522: return 413;
523: }
524: return '';
525: }
526:
527: # ------------------------------ Find server with least workload from spare.tab
528:
529: sub spareserver {
530: my ($loadpercent,$userloadpercent,$want_server_name) = @_;
531: my $spare_server;
532: if ($userloadpercent !~ /\d/) { $userloadpercent=0; }
533: my $lowest_load=($loadpercent > $userloadpercent) ? $loadpercent
534: : $userloadpercent;
535:
536: foreach my $try_server (@{ $spareid{'primary'} }) {
537: ($spare_server, $lowest_load) =
538: &compare_server_load($try_server, $spare_server, $lowest_load);
539: }
540:
541: my $found_server = ($spare_server ne '' && $lowest_load < 100);
542:
543: if (!$found_server) {
544: foreach my $try_server (@{ $spareid{'default'} }) {
545: ($spare_server, $lowest_load) =
546: &compare_server_load($try_server, $spare_server, $lowest_load);
547: }
548: }
549:
550: if (!$want_server_name) {
551: $spare_server="http://".&hostname($spare_server);
552: }
553: return $spare_server;
554: }
555:
556: sub compare_server_load {
557: my ($try_server, $spare_server, $lowest_load) = @_;
558:
559: my $loadans = &reply('load', $try_server);
560: my $userloadans = &reply('userload',$try_server);
561:
562: if ($loadans !~ /\d/ && $userloadans !~ /\d/) {
563: next; #didn't get a number from the server
564: }
565:
566: my $load;
567: if ($loadans =~ /\d/) {
568: if ($userloadans =~ /\d/) {
569: #both are numbers, pick the bigger one
570: $load = ($loadans > $userloadans) ? $loadans
571: : $userloadans;
572: } else {
573: $load = $loadans;
574: }
575: } else {
576: $load = $userloadans;
577: }
578:
579: if (($load =~ /\d/) && ($load < $lowest_load)) {
580: $spare_server = $try_server;
581: $lowest_load = $load;
582: }
583: return ($spare_server,$lowest_load);
584: }
585: # --------------------------------------------- Try to change a user's password
586:
587: sub changepass {
588: my ($uname,$udom,$currentpass,$newpass,$server,$context)=@_;
589: $currentpass = &escape($currentpass);
590: $newpass = &escape($newpass);
591: my $answer = reply("encrypt:passwd:$udom:$uname:$currentpass:$newpass:$context",
592: $server);
593: if (! $answer) {
594: &logthis("No reply on password change request to $server ".
595: "by $uname in domain $udom.");
596: } elsif ($answer =~ "^ok") {
597: &logthis("$uname in $udom successfully changed their password ".
598: "on $server.");
599: } elsif ($answer =~ "^pwchange_failure") {
600: &logthis("$uname in $udom was unable to change their password ".
601: "on $server. The action was blocked by either lcpasswd ".
602: "or pwchange");
603: } elsif ($answer =~ "^non_authorized") {
604: &logthis("$uname in $udom did not get their password correct when ".
605: "attempting to change it on $server.");
606: } elsif ($answer =~ "^auth_mode_error") {
607: &logthis("$uname in $udom attempted to change their password despite ".
608: "not being locally or internally authenticated on $server.");
609: } elsif ($answer =~ "^unknown_user") {
610: &logthis("$uname in $udom attempted to change their password ".
611: "on $server but were unable to because $server is not ".
612: "their home server.");
613: } elsif ($answer =~ "^refused") {
614: &logthis("$server refused to change $uname in $udom password because ".
615: "it was sent an unencrypted request to change the password.");
616: }
617: return $answer;
618: }
619:
620: # ----------------------- Try to determine user's current authentication scheme
621:
622: sub queryauthenticate {
623: my ($uname,$udom)=@_;
624: my $uhome=&homeserver($uname,$udom);
625: if (!$uhome) {
626: &logthis("User $uname at $udom is unknown when looking for authentication mechanism");
627: return 'no_host';
628: }
629: my $answer=reply("encrypt:currentauth:$udom:$uname",$uhome);
630: if ($answer =~ /^(unknown_user|refused|con_lost)/) {
631: &logthis("User $uname at $udom threw error $answer when checking authentication mechanism");
632: }
633: return $answer;
634: }
635:
636: # --------- Try to authenticate user from domain's lib servers (first this one)
637:
638: sub authenticate {
639: my ($uname,$upass,$udom)=@_;
640: $upass=&escape($upass);
641: $uname= &LONCAPA::clean_username($uname);
642: my $uhome=&homeserver($uname,$udom,1);
643: if ((!$uhome) || ($uhome eq 'no_host')) {
644: # Maybe the machine was offline and only re-appeared again recently?
645: &reconlonc();
646: # One more
647: my $uhome=&homeserver($uname,$udom,1);
648: if ((!$uhome) || ($uhome eq 'no_host')) {
649: &logthis("User $uname at $udom is unknown in authenticate");
650: }
651: return 'no_host';
652: }
653: my $answer=reply("encrypt:auth:$udom:$uname:$upass",$uhome);
654: if ($answer eq 'authorized') {
655: &logthis("User $uname at $udom authorized by $uhome");
656: return $uhome;
657: }
658: if ($answer eq 'non_authorized') {
659: &logthis("User $uname at $udom rejected by $uhome");
660: return 'no_host';
661: }
662: &logthis("User $uname at $udom threw error $answer when checking authentication mechanism");
663: return 'no_host';
664: }
665:
666: # ---------------------- Find the homebase for a user from domain's lib servers
667:
668: my %homecache;
669: sub homeserver {
670: my ($uname,$udom,$ignoreBadCache)=@_;
671: my $index="$uname:$udom";
672:
673: if (exists($homecache{$index})) { return $homecache{$index}; }
674:
675: my %servers = &get_servers($udom,'library');
676: foreach my $tryserver (keys(%servers)) {
677: next if ($ignoreBadCache ne 'true' &&
678: exists($badServerCache{$tryserver}));
679:
680: my $answer=reply("home:$udom:$uname",$tryserver);
681: if ($answer eq 'found') {
682: delete($badServerCache{$tryserver});
683: return $homecache{$index}=$tryserver;
684: } elsif ($answer eq 'no_host') {
685: $badServerCache{$tryserver}=1;
686: }
687: }
688: return 'no_host';
689: }
690:
691: # ------------------------------------- Find the usernames behind a list of IDs
692:
693: sub idget {
694: my ($udom,@ids)=@_;
695: my %returnhash=();
696:
697: my %servers = &get_servers($udom,'library');
698: foreach my $tryserver (keys(%servers)) {
699: my $idlist=join('&',@ids);
700: $idlist=~tr/A-Z/a-z/;
701: my $reply=&reply("idget:$udom:".$idlist,$tryserver);
702: my @answer=();
703: if (($reply ne 'con_lost') && ($reply!~/^error\:/)) {
704: @answer=split(/\&/,$reply);
705: } ;
706: my $i;
707: for ($i=0;$i<=$#ids;$i++) {
708: if ($answer[$i]) {
709: $returnhash{$ids[$i]}=$answer[$i];
710: }
711: }
712: }
713: return %returnhash;
714: }
715:
716: # ------------------------------------- Find the IDs behind a list of usernames
717:
718: sub idrget {
719: my ($udom,@unames)=@_;
720: my %returnhash=();
721: foreach my $uname (@unames) {
722: $returnhash{$uname}=(&userenvironment($udom,$uname,'id'))[1];
723: }
724: return %returnhash;
725: }
726:
727: # ------------------------------- Store away a list of names and associated IDs
728:
729: sub idput {
730: my ($udom,%ids)=@_;
731: my %servers=();
732: foreach my $uname (keys(%ids)) {
733: &cput('environment',{'id'=>$ids{$uname}},$udom,$uname);
734: my $uhom=&homeserver($uname,$udom);
735: if ($uhom ne 'no_host') {
736: my $id=&escape($ids{$uname});
737: $id=~tr/A-Z/a-z/;
738: my $esc_unam=&escape($uname);
739: if ($servers{$uhom}) {
740: $servers{$uhom}.='&'.$id.'='.$esc_unam;
741: } else {
742: $servers{$uhom}=$id.'='.$esc_unam;
743: }
744: }
745: }
746: foreach my $server (keys(%servers)) {
747: &critical('idput:'.$udom.':'.$servers{$server},$server);
748: }
749: }
750:
751: # ------------------------------------------- get items from domain db files
752:
753: sub get_dom {
754: my ($namespace,$storearr,$udom,$uhome)=@_;
755: my $items='';
756: foreach my $item (@$storearr) {
757: $items.=&escape($item).'&';
758: }
759: $items=~s/\&$//;
760: if (!$udom) {
761: $udom=$env{'user.domain'};
762: if (defined(&domain($udom,'primary'))) {
763: $uhome=&domain($udom,'primary');
764: } else {
765: undef($uhome);
766: }
767: } else {
768: if (!$uhome) {
769: if (defined(&domain($udom,'primary'))) {
770: $uhome=&domain($udom,'primary');
771: }
772: }
773: }
774: if ($udom && $uhome && ($uhome ne 'no_host')) {
775: my $rep=&reply("getdom:$udom:$namespace:$items",$uhome);
776: my %returnhash;
777: if ($rep eq '' || $rep =~ /^error: 2 /) {
778: return %returnhash;
779: }
780: my @pairs=split(/\&/,$rep);
781: if ( $#pairs==0 && $pairs[0] =~ /^(con_lost|error|no_such_host)/i) {
782: return @pairs;
783: }
784: my $i=0;
785: foreach my $item (@$storearr) {
786: $returnhash{$item}=&thaw_unescape($pairs[$i]);
787: $i++;
788: }
789: return %returnhash;
790: } else {
791: &logthis("get_dom failed - no homeserver and/or domain ($udom) ($uhome)");
792: }
793: }
794:
795: # -------------------------------------------- put items in domain db files
796:
797: sub put_dom {
798: my ($namespace,$storehash,$udom,$uhome)=@_;
799: if (!$udom) {
800: $udom=$env{'user.domain'};
801: if (defined(&domain($udom,'primary'))) {
802: $uhome=&domain($udom,'primary');
803: } else {
804: undef($uhome);
805: }
806: } else {
807: if (!$uhome) {
808: if (defined(&domain($udom,'primary'))) {
809: $uhome=&domain($udom,'primary');
810: }
811: }
812: }
813: if ($udom && $uhome && ($uhome ne 'no_host')) {
814: my $items='';
815: foreach my $item (keys(%$storehash)) {
816: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
817: }
818: $items=~s/\&$//;
819: return &reply("putdom:$udom:$namespace:$items",$uhome);
820: } else {
821: &logthis("put_dom failed - no homeserver and/or domain");
822: }
823: }
824:
825: sub retrieve_inst_usertypes {
826: my ($udom) = @_;
827: my (%returnhash,@order);
828: if (defined(&domain($udom,'primary'))) {
829: my $uhome=&domain($udom,'primary');
830: my $rep=&reply("inst_usertypes:$udom",$uhome);
831: my ($hashitems,$orderitems) = split(/:/,$rep);
832: my @pairs=split(/\&/,$hashitems);
833: foreach my $item (@pairs) {
834: my ($key,$value)=split(/=/,$item,2);
835: $key = &unescape($key);
836: next if ($key =~ /^error: 2 /);
837: $returnhash{$key}=&thaw_unescape($value);
838: }
839: my @esc_order = split(/\&/,$orderitems);
840: foreach my $item (@esc_order) {
841: push(@order,&unescape($item));
842: }
843: } else {
844: &logthis("get_dom failed - no primary domain server for $udom");
845: }
846: return (\%returnhash,\@order);
847: }
848:
849: sub is_domainimage {
850: my ($url) = @_;
851: if ($url=~m-^/+res/+($match_domain)/+\1\-domainconfig/+(img|logo|domlogo)/+-) {
852: if (&domain($1) ne '') {
853: return '1';
854: }
855: }
856: return;
857: }
858:
859: # --------------------------------------------------- Assign a key to a student
860:
861: sub assign_access_key {
862: #
863: # a valid key looks like uname:udom#comments
864: # comments are being appended
865: #
866: my ($ckey,$kdom,$knum,$cdom,$cnum,$udom,$uname,$logentry)=@_;
867: $kdom=
868: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($kdom));
869: $knum=
870: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($knum));
871: $cdom=
872: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
873: $cnum=
874: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
875: $udom=$env{'user.name'} unless (defined($udom));
876: $uname=$env{'user.domain'} unless (defined($uname));
877: my %existing=&get('accesskeys',[$ckey],$kdom,$knum);
878: if (($existing{$ckey}=~/^\#(.*)$/) || # - new key
879: ($existing{$ckey}=~/^\Q$uname\E\:\Q$udom\E\#(.*)$/)) {
880: # assigned to this person
881: # - this should not happen,
882: # unless something went wrong
883: # the first time around
884: # ready to assign
885: $logentry=$1.'; '.$logentry;
886: if (&put('accesskeys',{$ckey=>$uname.':'.$udom.'#'.$logentry},
887: $kdom,$knum) eq 'ok') {
888: # key now belongs to user
889: my $envkey='key.'.$cdom.'_'.$cnum;
890: if (&put('environment',{$envkey => $ckey}) eq 'ok') {
891: &appenv('environment.'.$envkey => $ckey);
892: return 'ok';
893: } else {
894: return
895: 'error: Count not permanently assign key, will need to be re-entered later.';
896: }
897: } else {
898: return 'error: Could not assign key, try again later.';
899: }
900: } elsif (!$existing{$ckey}) {
901: # the key does not exist
902: return 'error: The key does not exist';
903: } else {
904: # the key is somebody else's
905: return 'error: The key is already in use';
906: }
907: }
908:
909: # ------------------------------------------ put an additional comment on a key
910:
911: sub comment_access_key {
912: #
913: # a valid key looks like uname:udom#comments
914: # comments are being appended
915: #
916: my ($ckey,$cdom,$cnum,$logentry)=@_;
917: $cdom=
918: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
919: $cnum=
920: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
921: my %existing=&get('accesskeys',[$ckey],$cdom,$cnum);
922: if ($existing{$ckey}) {
923: $existing{$ckey}.='; '.$logentry;
924: # ready to assign
925: if (&put('accesskeys',{$ckey=>$existing{$ckey}},
926: $cdom,$cnum) eq 'ok') {
927: return 'ok';
928: } else {
929: return 'error: Count not store comment.';
930: }
931: } else {
932: # the key does not exist
933: return 'error: The key does not exist';
934: }
935: }
936:
937: # ------------------------------------------------------ Generate a set of keys
938:
939: sub generate_access_keys {
940: my ($number,$cdom,$cnum,$logentry)=@_;
941: $cdom=
942: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
943: $cnum=
944: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
945: unless (&allowed('mky',$cdom)) { return 0; }
946: unless (($cdom) && ($cnum)) { return 0; }
947: if ($number>10000) { return 0; }
948: sleep(2); # make sure don't get same seed twice
949: srand(time()^($$+($$<<15))); # from "Programming Perl"
950: my $total=0;
951: for (my $i=1;$i<=$number;$i++) {
952: my $newkey=sprintf("%lx",int(100000*rand)).'-'.
953: sprintf("%lx",int(100000*rand)).'-'.
954: sprintf("%lx",int(100000*rand));
955: $newkey=~s/1/g/g; # folks mix up 1 and l
956: $newkey=~s/0/h/g; # and also 0 and O
957: my %existing=&get('accesskeys',[$newkey],$cdom,$cnum);
958: if ($existing{$newkey}) {
959: $i--;
960: } else {
961: if (&put('accesskeys',
962: { $newkey => '# generated '.localtime().
963: ' by '.$env{'user.name'}.'@'.$env{'user.domain'}.
964: '; '.$logentry },
965: $cdom,$cnum) eq 'ok') {
966: $total++;
967: }
968: }
969: }
970: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},
971: 'Generated '.$total.' keys for '.$cnum.' at '.$cdom);
972: return $total;
973: }
974:
975: # ------------------------------------------------------- Validate an accesskey
976:
977: sub validate_access_key {
978: my ($ckey,$cdom,$cnum,$udom,$uname)=@_;
979: $cdom=
980: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
981: $cnum=
982: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
983: $udom=$env{'user.domain'} unless (defined($udom));
984: $uname=$env{'user.name'} unless (defined($uname));
985: my %existing=&get('accesskeys',[$ckey],$cdom,$cnum);
986: return ($existing{$ckey}=~/^\Q$uname\E\:\Q$udom\E\#/);
987: }
988:
989: # ------------------------------------- Find the section of student in a course
990: sub devalidate_getsection_cache {
991: my ($udom,$unam,$courseid)=@_;
992: my $hashid="$udom:$unam:$courseid";
993: &devalidate_cache_new('getsection',$hashid);
994: }
995:
996: sub courseid_to_courseurl {
997: my ($courseid) = @_;
998: #already url style courseid
999: return $courseid if ($courseid =~ m{^/});
1000:
1001: if (exists($env{'course.'.$courseid.'.num'})) {
1002: my $cnum = $env{'course.'.$courseid.'.num'};
1003: my $cdom = $env{'course.'.$courseid.'.domain'};
1004: return "/$cdom/$cnum";
1005: }
1006:
1007: my %courseinfo=&Apache::lonnet::coursedescription($courseid);
1008: if (exists($courseinfo{'num'})) {
1009: return "/$courseinfo{'domain'}/$courseinfo{'num'}";
1010: }
1011:
1012: return undef;
1013: }
1014:
1015: sub getsection {
1016: my ($udom,$unam,$courseid)=@_;
1017: my $cachetime=1800;
1018:
1019: my $hashid="$udom:$unam:$courseid";
1020: my ($result,$cached)=&is_cached_new('getsection',$hashid);
1021: if (defined($cached)) { return $result; }
1022:
1023: my %Pending;
1024: my %Expired;
1025: #
1026: # Each role can either have not started yet (pending), be active,
1027: # or have expired.
1028: #
1029: # If there is an active role, we are done.
1030: #
1031: # If there is more than one role which has not started yet,
1032: # choose the one which will start sooner
1033: # If there is one role which has not started yet, return it.
1034: #
1035: # If there is more than one expired role, choose the one which ended last.
1036: # If there is a role which has expired, return it.
1037: #
1038: $courseid = &courseid_to_courseurl($courseid);
1039: my %roleshash = &dump('roles',$udom,$unam,$courseid);
1040: foreach my $key (keys(%roleshash)) {
1041: next if ($key !~/^\Q$courseid\E(?:\/)*(\w+)*\_st$/);
1042: my $section=$1;
1043: if ($key eq $courseid.'_st') { $section=''; }
1044: my ($dummy,$end,$start)=split(/\_/,&unescape($roleshash{$key}));
1045: my $now=time;
1046: if (defined($end) && $end && ($now > $end)) {
1047: $Expired{$end}=$section;
1048: next;
1049: }
1050: if (defined($start) && $start && ($now < $start)) {
1051: $Pending{$start}=$section;
1052: next;
1053: }
1054: return &do_cache_new('getsection',$hashid,$section,$cachetime);
1055: }
1056: #
1057: # Presumedly there will be few matching roles from the above
1058: # loop and the sorting time will be negligible.
1059: if (scalar(keys(%Pending))) {
1060: my ($time) = sort {$a <=> $b} keys(%Pending);
1061: return &do_cache_new('getsection',$hashid,$Pending{$time},$cachetime);
1062: }
1063: if (scalar(keys(%Expired))) {
1064: my @sorted = sort {$a <=> $b} keys(%Expired);
1065: my $time = pop(@sorted);
1066: return &do_cache_new('getsection',$hashid,$Expired{$time},$cachetime);
1067: }
1068: return &do_cache_new('getsection',$hashid,'-1',$cachetime);
1069: }
1070:
1071: sub save_cache {
1072: &purge_remembered();
1073: #&Apache::loncommon::validate_page();
1074: undef(%env);
1075: undef($env_loaded);
1076: }
1077:
1078: my $to_remember=-1;
1079: my %remembered;
1080: my %accessed;
1081: my $kicks=0;
1082: my $hits=0;
1083: sub make_key {
1084: my ($name,$id) = @_;
1085: if (length($id) > 65
1086: && length(&escape($id)) > 200) {
1087: $id=length($id).':'.&Digest::MD5::md5_hex($id);
1088: }
1089: return &escape($name.':'.$id);
1090: }
1091:
1092: sub devalidate_cache_new {
1093: my ($name,$id,$debug) = @_;
1094: if ($debug) { &Apache::lonnet::logthis("deleting $name:$id"); }
1095: $id=&make_key($name,$id);
1096: $memcache->delete($id);
1097: delete($remembered{$id});
1098: delete($accessed{$id});
1099: }
1100:
1101: sub is_cached_new {
1102: my ($name,$id,$debug) = @_;
1103: $id=&make_key($name,$id);
1104: if (exists($remembered{$id})) {
1105: if ($debug) { &Apache::lonnet::logthis("Earyl return $id of $remembered{$id} "); }
1106: $accessed{$id}=[&gettimeofday()];
1107: $hits++;
1108: return ($remembered{$id},1);
1109: }
1110: my $value = $memcache->get($id);
1111: if (!(defined($value))) {
1112: if ($debug) { &Apache::lonnet::logthis("getting $id is not defined"); }
1113: return (undef,undef);
1114: }
1115: if ($value eq '__undef__') {
1116: if ($debug) { &Apache::lonnet::logthis("getting $id is __undef__"); }
1117: $value=undef;
1118: }
1119: &make_room($id,$value,$debug);
1120: if ($debug) { &Apache::lonnet::logthis("getting $id is $value"); }
1121: return ($value,1);
1122: }
1123:
1124: sub do_cache_new {
1125: my ($name,$id,$value,$time,$debug) = @_;
1126: $id=&make_key($name,$id);
1127: my $setvalue=$value;
1128: if (!defined($setvalue)) {
1129: $setvalue='__undef__';
1130: }
1131: if (!defined($time) ) {
1132: $time=600;
1133: }
1134: if ($debug) { &Apache::lonnet::logthis("Setting $id to $value"); }
1135: if (!($memcache->set($id,$setvalue,$time))) {
1136: &logthis("caching of id -> $id failed");
1137: }
1138: # need to make a copy of $value
1139: #&make_room($id,$value,$debug);
1140: return $value;
1141: }
1142:
1143: sub make_room {
1144: my ($id,$value,$debug)=@_;
1145: $remembered{$id}=$value;
1146: if ($to_remember<0) { return; }
1147: $accessed{$id}=[&gettimeofday()];
1148: if (scalar(keys(%remembered)) <= $to_remember) { return; }
1149: my $to_kick;
1150: my $max_time=0;
1151: foreach my $other (keys(%accessed)) {
1152: if (&tv_interval($accessed{$other}) > $max_time) {
1153: $to_kick=$other;
1154: $max_time=&tv_interval($accessed{$other});
1155: }
1156: }
1157: delete($remembered{$to_kick});
1158: delete($accessed{$to_kick});
1159: $kicks++;
1160: if ($debug) { &logthis("kicking $to_kick $max_time $kicks\n"); }
1161: return;
1162: }
1163:
1164: sub purge_remembered {
1165: #&logthis("Tossing ".scalar(keys(%remembered)));
1166: #&logthis(sprintf("%-20s is %s",'%remembered',length(&freeze(\%remembered))));
1167: undef(%remembered);
1168: undef(%accessed);
1169: }
1170: # ------------------------------------- Read an entry from a user's environment
1171:
1172: sub userenvironment {
1173: my ($udom,$unam,@what)=@_;
1174: my %returnhash=();
1175: my @answer=split(/\&/,
1176: &reply('get:'.$udom.':'.$unam.':environment:'.join('&',@what),
1177: &homeserver($unam,$udom)));
1178: my $i;
1179: for ($i=0;$i<=$#what;$i++) {
1180: $returnhash{$what[$i]}=&unescape($answer[$i]);
1181: }
1182: return %returnhash;
1183: }
1184:
1185: # ---------------------------------------------------------- Get a studentphoto
1186: sub studentphoto {
1187: my ($udom,$unam,$ext) = @_;
1188: my $home=&Apache::lonnet::homeserver($unam,$udom);
1189: if (defined($env{'request.course.id'})) {
1190: if ($env{'course.'.$env{'request.course.id'}.'.internal.showphoto'}) {
1191: if ($udom eq $env{'course.'.$env{'request.course.id'}.'.domain'}) {
1192: return(&retrievestudentphoto($udom,$unam,$ext));
1193: } else {
1194: my ($result,$perm_reqd)=
1195: &Apache::lonnet::auto_photo_permission($unam,$udom);
1196: if ($result eq 'ok') {
1197: if (!($perm_reqd eq 'yes')) {
1198: return(&retrievestudentphoto($udom,$unam,$ext));
1199: }
1200: }
1201: }
1202: }
1203: } else {
1204: my ($result,$perm_reqd) =
1205: &Apache::lonnet::auto_photo_permission($unam,$udom);
1206: if ($result eq 'ok') {
1207: if (!($perm_reqd eq 'yes')) {
1208: return(&retrievestudentphoto($udom,$unam,$ext));
1209: }
1210: }
1211: }
1212: return '/adm/lonKaputt/lonlogo_broken.gif';
1213: }
1214:
1215: sub retrievestudentphoto {
1216: my ($udom,$unam,$ext,$type) = @_;
1217: my $home=&Apache::lonnet::homeserver($unam,$udom);
1218: my $ret=&Apache::lonnet::reply("studentphoto:$udom:$unam:$ext:$type",$home);
1219: if ($ret eq 'ok') {
1220: my $url="/uploaded/$udom/$unam/internal/studentphoto.$ext";
1221: if ($type eq 'thumbnail') {
1222: $url="/uploaded/$udom/$unam/internal/studentphoto_tn.$ext";
1223: }
1224: my $tokenurl=&Apache::lonnet::tokenwrapper($url);
1225: return $tokenurl;
1226: } else {
1227: if ($type eq 'thumbnail') {
1228: return '/adm/lonKaputt/genericstudent_tn.gif';
1229: } else {
1230: return '/adm/lonKaputt/lonlogo_broken.gif';
1231: }
1232: }
1233: }
1234:
1235: # -------------------------------------------------------------------- New chat
1236:
1237: sub chatsend {
1238: my ($newentry,$anon,$group)=@_;
1239: my $cnum=$env{'course.'.$env{'request.course.id'}.'.num'};
1240: my $cdom=$env{'course.'.$env{'request.course.id'}.'.domain'};
1241: my $chome=$env{'course.'.$env{'request.course.id'}.'.home'};
1242: &reply('chatsend:'.$cdom.':'.$cnum.':'.
1243: &escape($env{'user.domain'}.':'.$env{'user.name'}.':'.$anon.':'.
1244: &escape($newentry)).':'.$group,$chome);
1245: }
1246:
1247: # ------------------------------------------ Find current version of a resource
1248:
1249: sub getversion {
1250: my $fname=&clutter(shift);
1251: unless ($fname=~/^\/res\//) { return -1; }
1252: return ¤tversion(&filelocation('',$fname));
1253: }
1254:
1255: sub currentversion {
1256: my $fname=shift;
1257: my ($result,$cached)=&is_cached_new('resversion',$fname);
1258: if (defined($cached)) { return $result; }
1259: my $author=$fname;
1260: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
1261: my ($udom,$uname)=split(/\//,$author);
1262: my $home=homeserver($uname,$udom);
1263: if ($home eq 'no_host') {
1264: return -1;
1265: }
1266: my $answer=reply("currentversion:$fname",$home);
1267: if (($answer eq 'con_lost') || ($answer eq 'rejected')) {
1268: return -1;
1269: }
1270: return &do_cache_new('resversion',$fname,$answer,600);
1271: }
1272:
1273: # ----------------------------- Subscribe to a resource, return URL if possible
1274:
1275: sub subscribe {
1276: my $fname=shift;
1277: if ($fname=~/\/(aboutme|syllabus|bulletinboard|smppg)$/) { return ''; }
1278: $fname=~s/[\n\r]//g;
1279: my $author=$fname;
1280: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
1281: my ($udom,$uname)=split(/\//,$author);
1282: my $home=homeserver($uname,$udom);
1283: if ($home eq 'no_host') {
1284: return 'not_found';
1285: }
1286: my $answer=reply("sub:$fname",$home);
1287: if (($answer eq 'con_lost') || ($answer eq 'rejected')) {
1288: $answer.=' by '.$home;
1289: }
1290: return $answer;
1291: }
1292:
1293: # -------------------------------------------------------------- Replicate file
1294:
1295: sub repcopy {
1296: my $filename=shift;
1297: $filename=~s/\/+/\//g;
1298: if ($filename=~m|^/home/httpd/html/adm/|) { return 'ok'; }
1299: if ($filename=~m|^/home/httpd/html/lonUsers/|) { return 'ok'; }
1300: if ($filename=~m|^/home/httpd/html/userfiles/| or
1301: $filename=~m -^/*(uploaded|editupload)/-) {
1302: return &repcopy_userfile($filename);
1303: }
1304: $filename=~s/[\n\r]//g;
1305: my $transname="$filename.in.transfer";
1306: # FIXME: this should flock
1307: if ((-e $filename) || (-e $transname)) { return 'ok'; }
1308: my $remoteurl=subscribe($filename);
1309: if ($remoteurl =~ /^con_lost by/) {
1310: &logthis("Subscribe returned $remoteurl: $filename");
1311: return 'unavailable';
1312: } elsif ($remoteurl eq 'not_found') {
1313: #&logthis("Subscribe returned not_found: $filename");
1314: return 'not_found';
1315: } elsif ($remoteurl =~ /^rejected by/) {
1316: &logthis("Subscribe returned $remoteurl: $filename");
1317: return 'forbidden';
1318: } elsif ($remoteurl eq 'directory') {
1319: return 'ok';
1320: } else {
1321: my $author=$filename;
1322: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
1323: my ($udom,$uname)=split(/\//,$author);
1324: my $home=homeserver($uname,$udom);
1325: unless ($home eq $perlvar{'lonHostID'}) {
1326: my @parts=split(/\//,$filename);
1327: my $path="/$parts[1]/$parts[2]/$parts[3]/$parts[4]";
1328: if ($path ne "$perlvar{'lonDocRoot'}/res") {
1329: &logthis("Malconfiguration for replication: $filename");
1330: return 'bad_request';
1331: }
1332: my $count;
1333: for ($count=5;$count<$#parts;$count++) {
1334: $path.="/$parts[$count]";
1335: if ((-e $path)!=1) {
1336: mkdir($path,0777);
1337: }
1338: }
1339: my $ua=new LWP::UserAgent;
1340: my $request=new HTTP::Request('GET',"$remoteurl");
1341: my $response=$ua->request($request,$transname);
1342: if ($response->is_error()) {
1343: unlink($transname);
1344: my $message=$response->status_line;
1345: &logthis("<font color=\"blue\">WARNING:"
1346: ." LWP get: $message: $filename</font>");
1347: return 'unavailable';
1348: } else {
1349: if ($remoteurl!~/\.meta$/) {
1350: my $mrequest=new HTTP::Request('GET',$remoteurl.'.meta');
1351: my $mresponse=$ua->request($mrequest,$filename.'.meta');
1352: if ($mresponse->is_error()) {
1353: unlink($filename.'.meta');
1354: &logthis(
1355: "<font color=\"yellow\">INFO: No metadata: $filename</font>");
1356: }
1357: }
1358: rename($transname,$filename);
1359: return 'ok';
1360: }
1361: }
1362: }
1363: }
1364:
1365: # ------------------------------------------------ Get server side include body
1366: sub ssi_body {
1367: my ($filelink,%form)=@_;
1368: if (! exists($form{'LONCAPA_INTERNAL_no_discussion'})) {
1369: $form{'LONCAPA_INTERNAL_no_discussion'}='true';
1370: }
1371: my $output=($filelink=~/^http\:/?&externalssi($filelink):
1372: &ssi($filelink,%form));
1373: $output=~s|//(\s*<!--)? BEGIN LON-CAPA Internal.+?// END LON-CAPA Internal\s*(-->)?\s||gs;
1374: $output=~s/^.*?\<body[^\>]*\>//si;
1375: $output=~s/(.*)\<\/body\s*\>.*?$/$1/si;
1376: return $output;
1377: }
1378:
1379: # --------------------------------------------------------- Server Side Include
1380:
1381: sub absolute_url {
1382: my ($host_name) = @_;
1383: my $protocol = ($ENV{'SERVER_PORT'} == 443?'https://':'http://');
1384: if ($host_name eq '') {
1385: $host_name = $ENV{'SERVER_NAME'};
1386: }
1387: return $protocol.$host_name;
1388: }
1389:
1390: sub ssi {
1391:
1392: my ($fn,%form)=@_;
1393:
1394: my $ua=new LWP::UserAgent;
1395:
1396: my $request;
1397:
1398: $form{'no_update_last_known'}=1;
1399: &Apache::lonenc::check_encrypt(\$fn);
1400: if (%form) {
1401: $request=new HTTP::Request('POST',&absolute_url().$fn);
1402: $request->content(join('&',map { &escape($_).'='.&escape($form{$_}) } keys %form));
1403: } else {
1404: $request=new HTTP::Request('GET',&absolute_url().$fn);
1405: }
1406:
1407: $request->header(Cookie => $ENV{'HTTP_COOKIE'});
1408: my $response=$ua->request($request);
1409:
1410: return $response->content;
1411: }
1412:
1413: sub externalssi {
1414: my ($url)=@_;
1415: my $ua=new LWP::UserAgent;
1416: my $request=new HTTP::Request('GET',$url);
1417: my $response=$ua->request($request);
1418: return $response->content;
1419: }
1420:
1421: # -------------------------------- Allow a /uploaded/ URI to be vouched for
1422:
1423: sub allowuploaded {
1424: my ($srcurl,$url)=@_;
1425: $url=&clutter(&declutter($url));
1426: my $dir=$url;
1427: $dir=~s/\/[^\/]+$//;
1428: my %httpref=();
1429: my $httpurl=&hreflocation('',$url);
1430: $httpref{'httpref.'.$httpurl}=$srcurl;
1431: &Apache::lonnet::appenv(%httpref);
1432: }
1433:
1434: # --------- File operations in /home/httpd/html/userfiles/$domain/1/2/3/$course
1435: # input: action, courseID, current domain, intended
1436: # path to file, source of file, instruction to parse file for objects,
1437: # ref to hash for embedded objects,
1438: # ref to hash for codebase of java objects.
1439: #
1440: # output: url to file (if action was uploaddoc),
1441: # ok if successful, or diagnostic message otherwise (if action was propagate or copy)
1442: #
1443: # Allows directory structure to be used within lonUsers/../userfiles/ for a
1444: # course.
1445: #
1446: # action = propagate - /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
1447: # will be copied to /home/httpd/lonUsers/1/2/3/$course/userfiles in
1448: # course's home server.
1449: #
1450: # action = copy - /home/httpd/html/userfiles/$domain/1/2/3/$course/$file will
1451: # be copied from $source (current location) to
1452: # /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
1453: # and will then be copied to
1454: # /home/httpd/lonUsers/$domain/1/2/3/$course/userfiles/$file in
1455: # course's home server.
1456: #
1457: # action = uploaddoc - /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
1458: # will be retrived from $env{form.uploaddoc} (from DOCS interface) to
1459: # /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
1460: # and will then be copied to /home/httpd/lonUsers/1/2/3/$course/userfiles/$file
1461: # in course's home server.
1462: #
1463:
1464: sub process_coursefile {
1465: my ($action,$docuname,$docudom,$file,$source,$parser,$allfiles,$codebase)=@_;
1466: my $fetchresult;
1467: my $home=&homeserver($docuname,$docudom);
1468: if ($action eq 'propagate') {
1469: $fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
1470: $home);
1471: } else {
1472: my $fpath = '';
1473: my $fname = $file;
1474: ($fpath,$fname) = ($file =~ m|^(.*)/([^/]+)$|);
1475: $fpath=$docudom.'/'.$docuname.'/'.$fpath;
1476: my $filepath = &build_filepath($fpath);
1477: if ($action eq 'copy') {
1478: if ($source eq '') {
1479: $fetchresult = 'no source file';
1480: return $fetchresult;
1481: } else {
1482: my $destination = $filepath.'/'.$fname;
1483: rename($source,$destination);
1484: $fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
1485: $home);
1486: }
1487: } elsif ($action eq 'uploaddoc') {
1488: open(my $fh,'>'.$filepath.'/'.$fname);
1489: print $fh $env{'form.'.$source};
1490: close($fh);
1491: if ($parser eq 'parse') {
1492: my $parse_result = &extract_embedded_items($filepath,$fname,$allfiles,$codebase);
1493: unless ($parse_result eq 'ok') {
1494: &logthis('Failed to parse '.$filepath.'/'.$fname.' for embedded media: '.$parse_result);
1495: }
1496: }
1497: $fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
1498: $home);
1499: if ($fetchresult eq 'ok') {
1500: return '/uploaded/'.$fpath.'/'.$fname;
1501: } else {
1502: &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$file.
1503: ' to host '.$home.': '.$fetchresult);
1504: return '/adm/notfound.html';
1505: }
1506: }
1507: }
1508: unless ( $fetchresult eq 'ok') {
1509: &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$file.
1510: ' to host '.$home.': '.$fetchresult);
1511: }
1512: return $fetchresult;
1513: }
1514:
1515: sub build_filepath {
1516: my ($fpath) = @_;
1517: my $filepath=$perlvar{'lonDocRoot'}.'/userfiles';
1518: unless ($fpath eq '') {
1519: my @parts=split('/',$fpath);
1520: foreach my $part (@parts) {
1521: $filepath.= '/'.$part;
1522: if ((-e $filepath)!=1) {
1523: mkdir($filepath,0777);
1524: }
1525: }
1526: }
1527: return $filepath;
1528: }
1529:
1530: sub store_edited_file {
1531: my ($primary_url,$content,$docudom,$docuname,$fetchresult) = @_;
1532: my $file = $primary_url;
1533: $file =~ s#^/uploaded/$docudom/$docuname/##;
1534: my $fpath = '';
1535: my $fname = $file;
1536: ($fpath,$fname) = ($file =~ m|^(.*)/([^/]+)$|);
1537: $fpath=$docudom.'/'.$docuname.'/'.$fpath;
1538: my $filepath = &build_filepath($fpath);
1539: open(my $fh,'>'.$filepath.'/'.$fname);
1540: print $fh $content;
1541: close($fh);
1542: my $home=&homeserver($docuname,$docudom);
1543: $$fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
1544: $home);
1545: if ($$fetchresult eq 'ok') {
1546: return '/uploaded/'.$fpath.'/'.$fname;
1547: } else {
1548: &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$file.
1549: ' to host '.$home.': '.$$fetchresult);
1550: return '/adm/notfound.html';
1551: }
1552: }
1553:
1554: sub clean_filename {
1555: my ($fname,$args)=@_;
1556: # Replace Windows backslashes by forward slashes
1557: $fname=~s/\\/\//g;
1558: if (!$args->{'keep_path'}) {
1559: # Get rid of everything but the actual filename
1560: $fname=~s/^.*\/([^\/]+)$/$1/;
1561: }
1562: # Replace spaces by underscores
1563: $fname=~s/\s+/\_/g;
1564: # Replace all other weird characters by nothing
1565: $fname=~s{[^/\w\.\-]}{}g;
1566: # Replace all .\d. sequences with _\d. so they no longer look like version
1567: # numbers
1568: $fname=~s/\.(\d+)(?=\.)/_$1/g;
1569: return $fname;
1570: }
1571:
1572: # --------------- Take an uploaded file and put it into the userfiles directory
1573: # input: $formname - the contents of the file are in $env{"form.$formname"}
1574: # the desired filenam is in $env{"form.$formname.filename"}
1575: # $coursedoc - if true up to the current course
1576: # if false
1577: # $subdir - directory in userfile to store the file into
1578: # $parser - instruction to parse file for objects ($parser = parse)
1579: # $allfiles - reference to hash for embedded objects
1580: # $codebase - reference to hash for codebase of java objects
1581: # $desuname - username for permanent storage of uploaded file
1582: # $dsetudom - domain for permanaent storage of uploaded file
1583: # $thumbwidth - width (pixels) of thumbnail to make for uploaded image
1584: # $thumbheight - height (pixels) of thumbnail to make for uploaded image
1585: #
1586: # output: url of file in userspace, or error: <message>
1587: # or /adm/notfound.html if failure to upload occurse
1588:
1589:
1590: sub userfileupload {
1591: my ($formname,$coursedoc,$subdir,$parser,$allfiles,$codebase,$destuname,
1592: $destudom,$thumbwidth,$thumbheight)=@_;
1593: if (!defined($subdir)) { $subdir='unknown'; }
1594: my $fname=$env{'form.'.$formname.'.filename'};
1595: $fname=&clean_filename($fname);
1596: # See if there is anything left
1597: unless ($fname) { return 'error: no uploaded file'; }
1598: chop($env{'form.'.$formname});
1599: if (($formname eq 'screenshot') && ($subdir eq 'helprequests')) { #files uploaded to help request form are handled differently
1600: my $now = time;
1601: my $filepath = 'tmp/helprequests/'.$now;
1602: my @parts=split(/\//,$filepath);
1603: my $fullpath = $perlvar{'lonDaemons'};
1604: for (my $i=0;$i<@parts;$i++) {
1605: $fullpath .= '/'.$parts[$i];
1606: if ((-e $fullpath)!=1) {
1607: mkdir($fullpath,0777);
1608: }
1609: }
1610: open(my $fh,'>'.$fullpath.'/'.$fname);
1611: print $fh $env{'form.'.$formname};
1612: close($fh);
1613: return $fullpath.'/'.$fname;
1614: } elsif (($formname eq 'coursecreatorxml') && ($subdir eq 'batchupload')) { #files uploaded to create course page are handled differently
1615: my $filepath = 'tmp/addcourse/'.$destudom.'/web/'.$env{'user.name'}.
1616: '_'.$env{'user.domain'}.'/pending';
1617: my @parts=split(/\//,$filepath);
1618: my $fullpath = $perlvar{'lonDaemons'};
1619: for (my $i=0;$i<@parts;$i++) {
1620: $fullpath .= '/'.$parts[$i];
1621: if ((-e $fullpath)!=1) {
1622: mkdir($fullpath,0777);
1623: }
1624: }
1625: open(my $fh,'>'.$fullpath.'/'.$fname);
1626: print $fh $env{'form.'.$formname};
1627: close($fh);
1628: return $fullpath.'/'.$fname;
1629: }
1630:
1631: # Create the directory if not present
1632: $fname="$subdir/$fname";
1633: if ($coursedoc) {
1634: my $docuname=$env{'course.'.$env{'request.course.id'}.'.num'};
1635: my $docudom=$env{'course.'.$env{'request.course.id'}.'.domain'};
1636: if ($env{'form.folder'} =~ m/^(default|supplemental)/) {
1637: return &finishuserfileupload($docuname,$docudom,
1638: $formname,$fname,$parser,$allfiles,
1639: $codebase,$thumbwidth,$thumbheight);
1640: } else {
1641: $fname=$env{'form.folder'}.'/'.$fname;
1642: return &process_coursefile('uploaddoc',$docuname,$docudom,
1643: $fname,$formname,$parser,
1644: $allfiles,$codebase);
1645: }
1646: } elsif (defined($destuname)) {
1647: my $docuname=$destuname;
1648: my $docudom=$destudom;
1649: return &finishuserfileupload($docuname,$docudom,$formname,$fname,
1650: $parser,$allfiles,$codebase,
1651: $thumbwidth,$thumbheight);
1652:
1653: } else {
1654: my $docuname=$env{'user.name'};
1655: my $docudom=$env{'user.domain'};
1656: if (exists($env{'form.group'})) {
1657: $docuname=$env{'course.'.$env{'request.course.id'}.'.num'};
1658: $docudom=$env{'course.'.$env{'request.course.id'}.'.domain'};
1659: }
1660: return &finishuserfileupload($docuname,$docudom,$formname,$fname,
1661: $parser,$allfiles,$codebase,
1662: $thumbwidth,$thumbheight);
1663: }
1664: }
1665:
1666: sub finishuserfileupload {
1667: my ($docuname,$docudom,$formname,$fname,$parser,$allfiles,$codebase,
1668: $thumbwidth,$thumbheight) = @_;
1669: my $path=$docudom.'/'.$docuname.'/';
1670: my $filepath=$perlvar{'lonDocRoot'};
1671: my ($fnamepath,$file,$fetchthumb);
1672: $file=$fname;
1673: if ($fname=~m|/|) {
1674: ($fnamepath,$file) = ($fname =~ m|^(.*)/([^/]+)$|);
1675: $path.=$fnamepath.'/';
1676: }
1677: my @parts=split(/\//,$filepath.'/userfiles/'.$path);
1678: my $count;
1679: for ($count=4;$count<=$#parts;$count++) {
1680: $filepath.="/$parts[$count]";
1681: if ((-e $filepath)!=1) {
1682: mkdir($filepath,0777);
1683: }
1684: }
1685: # Save the file
1686: {
1687: if (!open(FH,'>'.$filepath.'/'.$file)) {
1688: &logthis('Failed to create '.$filepath.'/'.$file);
1689: print STDERR ('Failed to create '.$filepath.'/'.$file."\n");
1690: return '/adm/notfound.html';
1691: }
1692: if (!print FH ($env{'form.'.$formname})) {
1693: &logthis('Failed to write to '.$filepath.'/'.$file);
1694: print STDERR ('Failed to write to '.$filepath.'/'.$file."\n");
1695: return '/adm/notfound.html';
1696: }
1697: close(FH);
1698: }
1699: if ($parser eq 'parse') {
1700: my $parse_result = &extract_embedded_items($filepath,$file,$allfiles,
1701: $codebase);
1702: unless ($parse_result eq 'ok') {
1703: &logthis('Failed to parse '.$filepath.$file.
1704: ' for embedded media: '.$parse_result);
1705: }
1706: }
1707: if (($thumbwidth =~ /^\d+$/) && ($thumbheight =~ /^\d+$/)) {
1708: my $input = $filepath.'/'.$file;
1709: my $output = $filepath.'/'.'tn-'.$file;
1710: my $thumbsize = $thumbwidth.'x'.$thumbheight;
1711: system("convert -sample $thumbsize $input $output");
1712: if (-e $filepath.'/'.'tn-'.$file) {
1713: $fetchthumb = 1;
1714: }
1715: }
1716:
1717: # Notify homeserver to grep it
1718: #
1719: my $docuhome=&homeserver($docuname,$docudom);
1720: my $fetchresult= &reply('fetchuserfile:'.$path.$file,$docuhome);
1721: if ($fetchresult eq 'ok') {
1722: if ($fetchthumb) {
1723: my $thumbresult= &reply('fetchuserfile:'.$path.'tn-'.$file,$docuhome);
1724: if ($thumbresult ne 'ok') {
1725: &logthis('Failed to transfer '.$path.'tn-'.$file.' to host '.
1726: $docuhome.': '.$thumbresult);
1727: }
1728: }
1729: #
1730: # Return the URL to it
1731: return '/uploaded/'.$path.$file;
1732: } else {
1733: &logthis('Failed to transfer '.$path.$file.' to host '.$docuhome.
1734: ': '.$fetchresult);
1735: return '/adm/notfound.html';
1736: }
1737: }
1738:
1739: sub extract_embedded_items {
1740: my ($filepath,$file,$allfiles,$codebase,$content) = @_;
1741: my @state = ();
1742: my %javafiles = (
1743: codebase => '',
1744: code => '',
1745: archive => ''
1746: );
1747: my %mediafiles = (
1748: src => '',
1749: movie => '',
1750: );
1751: my $p;
1752: if ($content) {
1753: $p = HTML::LCParser->new($content);
1754: } else {
1755: $p = HTML::LCParser->new($filepath.'/'.$file);
1756: }
1757: while (my $t=$p->get_token()) {
1758: if ($t->[0] eq 'S') {
1759: my ($tagname, $attr) = ($t->[1],$t->[2]);
1760: push(@state, $tagname);
1761: if (lc($tagname) eq 'allow') {
1762: &add_filetype($allfiles,$attr->{'src'},'src');
1763: }
1764: if (lc($tagname) eq 'img') {
1765: &add_filetype($allfiles,$attr->{'src'},'src');
1766: }
1767: if (lc($tagname) eq 'a') {
1768: &add_filetype($allfiles,$attr->{'href'},'href');
1769: }
1770: if (lc($tagname) eq 'script') {
1771: if ($attr->{'archive'} =~ /\.jar$/i) {
1772: &add_filetype($allfiles,$attr->{'archive'},'archive');
1773: } else {
1774: &add_filetype($allfiles,$attr->{'src'},'src');
1775: }
1776: }
1777: if (lc($tagname) eq 'link') {
1778: if (lc($attr->{'rel'}) eq 'stylesheet') {
1779: &add_filetype($allfiles,$attr->{'href'},'href');
1780: }
1781: }
1782: if (lc($tagname) eq 'object' ||
1783: (lc($tagname) eq 'embed' && lc($state[-2]) ne 'object')) {
1784: foreach my $item (keys(%javafiles)) {
1785: $javafiles{$item} = '';
1786: }
1787: }
1788: if (lc($state[-2]) eq 'object' && lc($tagname) eq 'param') {
1789: my $name = lc($attr->{'name'});
1790: foreach my $item (keys(%javafiles)) {
1791: if ($name eq $item) {
1792: $javafiles{$item} = $attr->{'value'};
1793: last;
1794: }
1795: }
1796: foreach my $item (keys(%mediafiles)) {
1797: if ($name eq $item) {
1798: &add_filetype($allfiles, $attr->{'value'}, 'value');
1799: last;
1800: }
1801: }
1802: }
1803: if (lc($tagname) eq 'embed' || lc($tagname) eq 'applet') {
1804: foreach my $item (keys(%javafiles)) {
1805: if ($attr->{$item}) {
1806: $javafiles{$item} = $attr->{$item};
1807: last;
1808: }
1809: }
1810: foreach my $item (keys(%mediafiles)) {
1811: if ($attr->{$item}) {
1812: &add_filetype($allfiles,$attr->{$item},$item);
1813: last;
1814: }
1815: }
1816: }
1817: } elsif ($t->[0] eq 'E') {
1818: my ($tagname) = ($t->[1]);
1819: if ($javafiles{'codebase'} ne '') {
1820: $javafiles{'codebase'} .= '/';
1821: }
1822: if (lc($tagname) eq 'applet' ||
1823: lc($tagname) eq 'object' ||
1824: (lc($tagname) eq 'embed' && lc($state[-2]) ne 'object')
1825: ) {
1826: foreach my $item (keys(%javafiles)) {
1827: if ($item ne 'codebase' && $javafiles{$item} ne '') {
1828: my $file=$javafiles{'codebase'}.$javafiles{$item};
1829: &add_filetype($allfiles,$file,$item);
1830: }
1831: }
1832: }
1833: pop @state;
1834: }
1835: }
1836: return 'ok';
1837: }
1838:
1839: sub add_filetype {
1840: my ($allfiles,$file,$type)=@_;
1841: if (exists($allfiles->{$file})) {
1842: unless (grep/^\Q$type\E$/, @{$allfiles->{$file}}) {
1843: push(@{$allfiles->{$file}}, &escape($type));
1844: }
1845: } else {
1846: @{$allfiles->{$file}} = (&escape($type));
1847: }
1848: }
1849:
1850: sub removeuploadedurl {
1851: my ($url)=@_;
1852: my (undef,undef,$udom,$uname,$fname)=split('/',$url,5);
1853: return &removeuserfile($uname,$udom,$fname);
1854: }
1855:
1856: sub removeuserfile {
1857: my ($docuname,$docudom,$fname)=@_;
1858: my $home=&homeserver($docuname,$docudom);
1859: my $result = &reply("removeuserfile:$docudom/$docuname/$fname",$home);
1860: if ($result eq 'ok') {
1861: if (($fname !~ /\.meta$/) && (&is_portfolio_file($fname))) {
1862: my $metafile = $fname.'.meta';
1863: my $metaresult = &removeuserfile($docuname,$docudom,$metafile);
1864: my $url = "/uploaded/$docudom/$docuname/$fname";
1865: my ($file,$group) = (&parse_portfolio_url($url))[3,4];
1866: my $sqlresult =
1867: &update_portfolio_table($docuname,$docudom,$file,
1868: 'portfolio_metadata',$group,
1869: 'delete');
1870: }
1871: }
1872: return $result;
1873: }
1874:
1875: sub mkdiruserfile {
1876: my ($docuname,$docudom,$dir)=@_;
1877: my $home=&homeserver($docuname,$docudom);
1878: return &reply("mkdiruserfile:".&escape("$docudom/$docuname/$dir"),$home);
1879: }
1880:
1881: sub renameuserfile {
1882: my ($docuname,$docudom,$old,$new)=@_;
1883: my $home=&homeserver($docuname,$docudom);
1884: my $result = &reply("renameuserfile:$docudom:$docuname:".
1885: &escape("$old").':'.&escape("$new"),$home);
1886: if ($result eq 'ok') {
1887: if (($old !~ /\.meta$/) && (&is_portfolio_file($old))) {
1888: my $oldmeta = $old.'.meta';
1889: my $newmeta = $new.'.meta';
1890: my $metaresult =
1891: &renameuserfile($docuname,$docudom,$oldmeta,$newmeta);
1892: my $url = "/uploaded/$docudom/$docuname/$old";
1893: my ($file,$group) = (&parse_portfolio_url($url))[3,4];
1894: my $sqlresult =
1895: &update_portfolio_table($docuname,$docudom,$file,
1896: 'portfolio_metadata',$group,
1897: 'delete');
1898: }
1899: }
1900: return $result;
1901: }
1902:
1903: # ------------------------------------------------------------------------- Log
1904:
1905: sub log {
1906: my ($dom,$nam,$hom,$what)=@_;
1907: return critical("log:$dom:$nam:$what",$hom);
1908: }
1909:
1910: # ------------------------------------------------------------------ Course Log
1911: #
1912: # This routine flushes several buffers of non-mission-critical nature
1913: #
1914:
1915: sub flushcourselogs {
1916: &logthis('Flushing log buffers');
1917: #
1918: # course logs
1919: # This is a log of all transactions in a course, which can be used
1920: # for data mining purposes
1921: #
1922: # It also collects the courseid database, which lists last transaction
1923: # times and course titles for all courseids
1924: #
1925: my %courseidbuffer=();
1926: foreach my $crsid (keys %courselogs) {
1927: if (&reply('log:'.$coursedombuf{$crsid}.':'.$coursenumbuf{$crsid}.':'.
1928: &escape($courselogs{$crsid}),
1929: $coursehombuf{$crsid}) eq 'ok') {
1930: delete $courselogs{$crsid};
1931: } else {
1932: &logthis('Failed to flush log buffer for '.$crsid);
1933: if (length($courselogs{$crsid})>40000) {
1934: &logthis("<font color=\"blue\">WARNING: Buffer for ".$crsid.
1935: " exceeded maximum size, deleting.</font>");
1936: delete $courselogs{$crsid};
1937: }
1938: }
1939: if ($courseidbuffer{$coursehombuf{$crsid}}) {
1940: $courseidbuffer{$coursehombuf{$crsid}}.='&'.
1941: &escape($crsid).'='.&escape($coursedescrbuf{$crsid}).
1942: ':'.&escape($courseinstcodebuf{$crsid}).':'.&escape($courseownerbuf{$crsid}).':'.&escape($coursetypebuf{$crsid});
1943: } else {
1944: $courseidbuffer{$coursehombuf{$crsid}}=
1945: &escape($crsid).'='.&escape($coursedescrbuf{$crsid}).
1946: ':'.&escape($courseinstcodebuf{$crsid}).':'.&escape($courseownerbuf{$crsid}).':'.&escape($coursetypebuf{$crsid});
1947: }
1948: }
1949: #
1950: # Write course id database (reverse lookup) to homeserver of courses
1951: # Is used in pickcourse
1952: #
1953: foreach my $crs_home (keys(%courseidbuffer)) {
1954: &courseidput(&host_domain($crs_home),$courseidbuffer{$crs_home},
1955: $crs_home);
1956: }
1957: #
1958: # File accesses
1959: # Writes to the dynamic metadata of resources to get hit counts, etc.
1960: #
1961: foreach my $entry (keys(%accesshash)) {
1962: if ($entry =~ /___count$/) {
1963: my ($dom,$name);
1964: ($dom,$name,undef)=
1965: ($entry=~m{___($match_domain)/($match_name)/(.*)___count$});
1966: if (! defined($dom) || $dom eq '' ||
1967: ! defined($name) || $name eq '') {
1968: my $cid = $env{'request.course.id'};
1969: $dom = $env{'request.'.$cid.'.domain'};
1970: $name = $env{'request.'.$cid.'.num'};
1971: }
1972: my $value = $accesshash{$entry};
1973: my (undef,$url,undef) = ($entry =~ /^(.*)___(.*)___count$/);
1974: my %temphash=($url => $value);
1975: my $result = &inc('nohist_accesscount',\%temphash,$dom,$name);
1976: if ($result eq 'ok') {
1977: delete $accesshash{$entry};
1978: } elsif ($result eq 'unknown_cmd') {
1979: # Target server has old code running on it.
1980: my %temphash=($entry => $value);
1981: if (&put('nohist_resevaldata',\%temphash,$dom,$name) eq 'ok') {
1982: delete $accesshash{$entry};
1983: }
1984: }
1985: } else {
1986: my ($dom,$name) = ($entry=~m{___($match_domain)/($match_name)/(.*)___(\w+)$});
1987: my %temphash=($entry => $accesshash{$entry});
1988: if (&put('nohist_resevaldata',\%temphash,$dom,$name) eq 'ok') {
1989: delete $accesshash{$entry};
1990: }
1991: }
1992: }
1993: #
1994: # Roles
1995: # Reverse lookup of user roles for course faculty/staff and co-authorship
1996: #
1997: foreach my $entry (keys(%userrolehash)) {
1998: my ($role,$uname,$udom,$runame,$rudom,$rsec)=
1999: split(/\:/,$entry);
2000: if (&Apache::lonnet::put('nohist_userroles',
2001: { $role.':'.$uname.':'.$udom.':'.$rsec => $userrolehash{$entry} },
2002: $rudom,$runame) eq 'ok') {
2003: delete $userrolehash{$entry};
2004: }
2005: }
2006: #
2007: # Reverse lookup of domain roles (dc, ad, li, sc, au)
2008: #
2009: my %domrolebuffer = ();
2010: foreach my $entry (keys %domainrolehash) {
2011: my ($role,$uname,$udom,$runame,$rudom,$rsec)=split/:/,$entry;
2012: if ($domrolebuffer{$rudom}) {
2013: $domrolebuffer{$rudom}.='&'.&escape($entry).
2014: '='.&escape($domainrolehash{$entry});
2015: } else {
2016: $domrolebuffer{$rudom}.=&escape($entry).
2017: '='.&escape($domainrolehash{$entry});
2018: }
2019: delete $domainrolehash{$entry};
2020: }
2021: foreach my $dom (keys(%domrolebuffer)) {
2022: my %servers = &get_servers($dom,'library');
2023: foreach my $tryserver (keys(%servers)) {
2024: unless (&reply('domroleput:'.$dom.':'.
2025: $domrolebuffer{$dom},$tryserver) eq 'ok') {
2026: &logthis('Put of domain roles failed for '.$dom.' and '.$tryserver);
2027: }
2028: }
2029: }
2030: $dumpcount++;
2031: }
2032:
2033: sub courselog {
2034: my $what=shift;
2035: $what=time.':'.$what;
2036: unless ($env{'request.course.id'}) { return ''; }
2037: $coursedombuf{$env{'request.course.id'}}=
2038: $env{'course.'.$env{'request.course.id'}.'.domain'};
2039: $coursenumbuf{$env{'request.course.id'}}=
2040: $env{'course.'.$env{'request.course.id'}.'.num'};
2041: $coursehombuf{$env{'request.course.id'}}=
2042: $env{'course.'.$env{'request.course.id'}.'.home'};
2043: $coursedescrbuf{$env{'request.course.id'}}=
2044: $env{'course.'.$env{'request.course.id'}.'.description'};
2045: $courseinstcodebuf{$env{'request.course.id'}}=
2046: $env{'course.'.$env{'request.course.id'}.'.internal.coursecode'};
2047: $courseownerbuf{$env{'request.course.id'}}=
2048: $env{'course.'.$env{'request.course.id'}.'.internal.courseowner'};
2049: $coursetypebuf{$env{'request.course.id'}}=
2050: $env{'course.'.$env{'request.course.id'}.'.type'};
2051: if (defined $courselogs{$env{'request.course.id'}}) {
2052: $courselogs{$env{'request.course.id'}}.='&'.$what;
2053: } else {
2054: $courselogs{$env{'request.course.id'}}.=$what;
2055: }
2056: if (length($courselogs{$env{'request.course.id'}})>4048) {
2057: &flushcourselogs();
2058: }
2059: }
2060:
2061: sub courseacclog {
2062: my $fnsymb=shift;
2063: unless ($env{'request.course.id'}) { return ''; }
2064: my $what=$fnsymb.':'.$env{'user.name'}.':'.$env{'user.domain'};
2065: if ($fnsymb=~/(problem|exam|quiz|assess|survey|form|task|page)$/) {
2066: $what.=':POST';
2067: # FIXME: Probably ought to escape things....
2068: foreach my $key (keys(%env)) {
2069: if ($key=~/^form\.(.*)/) {
2070: $what.=':'.$1.'='.$env{$key};
2071: }
2072: }
2073: } elsif ($fnsymb =~ m:^/adm/searchcat:) {
2074: # FIXME: We should not be depending on a form parameter that someone
2075: # editing lonsearchcat.pm might change in the future.
2076: if ($env{'form.phase'} eq 'course_search') {
2077: $what.= ':POST';
2078: # FIXME: Probably ought to escape things....
2079: foreach my $element ('courseexp','crsfulltext','crsrelated',
2080: 'crsdiscuss') {
2081: $what.=':'.$element.'='.$env{'form.'.$element};
2082: }
2083: }
2084: }
2085: &courselog($what);
2086: }
2087:
2088: sub countacc {
2089: my $url=&declutter(shift);
2090: return if (! defined($url) || $url eq '');
2091: unless ($env{'request.course.id'}) { return ''; }
2092: $accesshash{$env{'request.course.id'}.'___'.$url.'___course'}=1;
2093: my $key=$$.$processmarker.'_'.$dumpcount.'___'.$url.'___count';
2094: $accesshash{$key}++;
2095: }
2096:
2097: sub linklog {
2098: my ($from,$to)=@_;
2099: $from=&declutter($from);
2100: $to=&declutter($to);
2101: $accesshash{$from.'___'.$to.'___comefrom'}=1;
2102: $accesshash{$to.'___'.$from.'___goto'}=1;
2103: }
2104:
2105: sub userrolelog {
2106: my ($trole,$username,$domain,$area,$tstart,$tend)=@_;
2107: if (($trole=~/^ca/) || ($trole=~/^aa/) ||
2108: ($trole=~/^in/) || ($trole=~/^cc/) ||
2109: ($trole=~/^ep/) || ($trole=~/^cr/) ||
2110: ($trole=~/^ta/)) {
2111: my (undef,$rudom,$runame,$rsec)=split(/\//,$area);
2112: $userrolehash
2113: {$trole.':'.$username.':'.$domain.':'.$runame.':'.$rudom.':'.$rsec}
2114: =$tend.':'.$tstart;
2115: }
2116: if (($env{'request.role'} =~ /dc\./) &&
2117: (($trole=~/^au/) || ($trole=~/^in/) ||
2118: ($trole=~/^cc/) || ($trole=~/^ep/) ||
2119: ($trole=~/^cr/) || ($trole=~/^ta/))) {
2120: $userrolehash
2121: {$trole.':'.$username.':'.$domain.':'.$env{'user.name'}.':'.$env{'user.domain'}.':'}
2122: =$tend.':'.$tstart;
2123: }
2124: if (($trole=~/^dc/) || ($trole=~/^ad/) ||
2125: ($trole=~/^li/) || ($trole=~/^li/) ||
2126: ($trole=~/^au/) || ($trole=~/^dg/) ||
2127: ($trole=~/^sc/)) {
2128: my (undef,$rudom,$runame,$rsec)=split(/\//,$area);
2129: $domainrolehash
2130: {$trole.':'.$username.':'.$domain.':'.$runame.':'.$rudom.':'.$rsec}
2131: = $tend.':'.$tstart;
2132: }
2133: &flushcourselogs();
2134: }
2135:
2136: sub get_course_adv_roles {
2137: my $cid=shift;
2138: $cid=$env{'request.course.id'} unless (defined($cid));
2139: my %coursehash=&coursedescription($cid);
2140: my %nothide=();
2141: foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
2142: $nothide{join(':',split(/[\@\:]/,$user))}=1;
2143: }
2144: my %returnhash=();
2145: my %dumphash=
2146: &dump('nohist_userroles',$coursehash{'domain'},$coursehash{'num'});
2147: my $now=time;
2148: foreach my $entry (keys %dumphash) {
2149: my ($tend,$tstart)=split(/\:/,$dumphash{$entry});
2150: if (($tstart) && ($tstart<0)) { next; }
2151: if (($tend) && ($tend<$now)) { next; }
2152: if (($tstart) && ($now<$tstart)) { next; }
2153: my ($role,$username,$domain,$section)=split(/\:/,$entry);
2154: if ($username eq '' || $domain eq '') { next; }
2155: if ((&privileged($username,$domain)) &&
2156: (!$nothide{$username.':'.$domain})) { next; }
2157: if ($role eq 'cr') { next; }
2158: my $key=&plaintext($role);
2159: if ($section) { $key.=' (Sec/Grp '.$section.')'; }
2160: if ($returnhash{$key}) {
2161: $returnhash{$key}.=','.$username.':'.$domain;
2162: } else {
2163: $returnhash{$key}=$username.':'.$domain;
2164: }
2165: }
2166: return %returnhash;
2167: }
2168:
2169: sub get_my_roles {
2170: my ($uname,$udom,$context,$types,$roles,$roledoms)=@_;
2171: unless (defined($uname)) { $uname=$env{'user.name'}; }
2172: unless (defined($udom)) { $udom=$env{'user.domain'}; }
2173: my %dumphash;
2174: if ($context eq 'userroles') {
2175: %dumphash = &dump('roles',$udom,$uname);
2176: } else {
2177: %dumphash=
2178: &dump('nohist_userroles',$udom,$uname);
2179: }
2180: my %returnhash=();
2181: my $now=time;
2182: foreach my $entry (keys(%dumphash)) {
2183: my ($role,$tend,$tstart);
2184: if ($context eq 'userroles') {
2185: ($role,$tend,$tstart)=split(/_/,$dumphash{$entry});
2186: } else {
2187: ($tend,$tstart)=split(/\:/,$dumphash{$entry});
2188: }
2189: if (($tstart) && ($tstart<0)) { next; }
2190: my $status = 'active';
2191: if (($tend) && ($tend<$now)) {
2192: $status = 'previous';
2193: }
2194: if (($tstart) && ($now<$tstart)) {
2195: $status = 'future';
2196: }
2197: if (ref($types) eq 'ARRAY') {
2198: if (!grep(/^\Q$status\E$/,@{$types})) {
2199: next;
2200: }
2201: } else {
2202: if ($status ne 'active') {
2203: next;
2204: }
2205: }
2206: my ($rolecode,$username,$domain,$section,$area);
2207: if ($context eq 'userroles') {
2208: ($area,$rolecode) = split(/_/,$entry);
2209: (undef,$domain,$username,$section) = split(/\//,$area);
2210: } else {
2211: ($role,$username,$domain,$section) = split(/\:/,$entry);
2212: }
2213: if (ref($roledoms) eq 'ARRAY') {
2214: if (!grep(/^\Q$domain\E$/,@{$roledoms})) {
2215: next;
2216: }
2217: }
2218: if (ref($roles) eq 'ARRAY') {
2219: if (!grep(/^\Q$role\E$/,@{$roles})) {
2220: next;
2221: }
2222: }
2223: $returnhash{$username.':'.$domain.':'.$role}=$tstart.':'.$tend;
2224: }
2225: return %returnhash;
2226: }
2227:
2228: # ----------------------------------------------------- Frontpage Announcements
2229: #
2230: #
2231:
2232: sub postannounce {
2233: my ($server,$text)=@_;
2234: unless (&allowed('psa',&host_domain($server))) { return 'refused'; }
2235: unless ($text=~/\w/) { $text=''; }
2236: return &reply('setannounce:'.&escape($text),$server);
2237: }
2238:
2239: sub getannounce {
2240:
2241: if (open(my $fh,$perlvar{'lonDocRoot'}.'/announcement.txt')) {
2242: my $announcement='';
2243: while (my $line = <$fh>) { $announcement .= $line; }
2244: close($fh);
2245: if ($announcement=~/\w/) {
2246: return
2247: '<table bgcolor="#FF5555" cellpadding="5" cellspacing="3">'.
2248: '<tr><td bgcolor="#FFFFFF"><tt>'.$announcement.'</tt></td></tr></table>';
2249: } else {
2250: return '';
2251: }
2252: } else {
2253: return '';
2254: }
2255: }
2256:
2257: # ---------------------------------------------------------- Course ID routines
2258: # Deal with domain's nohist_courseid.db files
2259: #
2260:
2261: sub courseidput {
2262: my ($domain,$what,$coursehome)=@_;
2263: return &reply('courseidput:'.$domain.':'.$what,$coursehome);
2264: }
2265:
2266: sub courseiddump {
2267: my ($domfilter,$descfilter,$sincefilter,$instcodefilter,$ownerfilter,$coursefilter,$hostidflag,$hostidref,$typefilter,$regexp_ok)=@_;
2268: my %returnhash=();
2269: unless ($domfilter) { $domfilter=''; }
2270: my %libserv = &all_library();
2271: foreach my $tryserver (keys(%libserv)) {
2272: if ( ( $hostidflag == 1
2273: && grep(/^\Q$tryserver\E$/,@{$hostidref}) )
2274: || (!defined($hostidflag)) ) {
2275:
2276: if ($domfilter eq ''
2277: || (&host_domain($tryserver) eq $domfilter)) {
2278: foreach my $line (
2279: split(/\&/,&reply('courseiddump:'.&host_domain($tryserver).':'.
2280: $sincefilter.':'.&escape($descfilter).':'.
2281: &escape($instcodefilter).':'.&escape($ownerfilter).':'.&escape($coursefilter).':'.&escape($typefilter).':'.&escape($regexp_ok),
2282: $tryserver))) {
2283: my ($key,$value)=split(/\=/,$line,2);
2284: if (($key) && ($value)) {
2285: $returnhash{&unescape($key)}=$value;
2286: }
2287: }
2288: }
2289: }
2290: }
2291: return %returnhash;
2292: }
2293:
2294: # ---------------------------------------------------------- DC e-mail
2295:
2296: sub dcmailput {
2297: my ($domain,$msgid,$message,$server)=@_;
2298: my $status = &Apache::lonnet::critical(
2299: 'dcmailput:'.$domain.':'.&escape($msgid).'='.
2300: &escape($message),$server);
2301: return $status;
2302: }
2303:
2304: sub dcmaildump {
2305: my ($dom,$startdate,$enddate,$senders) = @_;
2306: my %returnhash=();
2307:
2308: if (defined(&domain($dom,'primary'))) {
2309: my $cmd='dcmaildump:'.$dom.':'.&escape($startdate).':'.
2310: &escape($enddate).':';
2311: my @esc_senders=map { &escape($_)} @$senders;
2312: $cmd.=&escape(join('&',@esc_senders));
2313: foreach my $line (split(/\&/,&reply($cmd,&domain($dom,'primary')))) {
2314: my ($key,$value) = split(/\=/,$line,2);
2315: if (($key) && ($value)) {
2316: $returnhash{&unescape($key)} = &unescape($value);
2317: }
2318: }
2319: }
2320: return %returnhash;
2321: }
2322: # ---------------------------------------------------------- Domain roles
2323:
2324: sub get_domain_roles {
2325: my ($dom,$roles,$startdate,$enddate)=@_;
2326: if (undef($startdate) || $startdate eq '') {
2327: $startdate = '.';
2328: }
2329: if (undef($enddate) || $enddate eq '') {
2330: $enddate = '.';
2331: }
2332: my $rolelist = join(':',@{$roles});
2333: my %personnel = ();
2334:
2335: my %servers = &get_servers($dom,'library');
2336: foreach my $tryserver (keys(%servers)) {
2337: %{$personnel{$tryserver}}=();
2338: foreach my $line (split(/\&/,&reply('domrolesdump:'.$dom.':'.
2339: &escape($startdate).':'.
2340: &escape($enddate).':'.
2341: &escape($rolelist), $tryserver))) {
2342: my ($key,$value) = split(/\=/,$line,2);
2343: if (($key) && ($value)) {
2344: $personnel{$tryserver}{&unescape($key)} = &unescape($value);
2345: }
2346: }
2347: }
2348: return %personnel;
2349: }
2350:
2351: # ----------------------------------------------------------- Check out an item
2352:
2353: sub get_first_access {
2354: my ($type,$argsymb)=@_;
2355: my ($symb,$courseid,$udom,$uname)=&whichuser();
2356: if ($argsymb) { $symb=$argsymb; }
2357: my ($map,$id,$res)=&decode_symb($symb);
2358: if ($type eq 'map') {
2359: $res=&symbread($map);
2360: } else {
2361: $res=$symb;
2362: }
2363: my %times=&get('firstaccesstimes',["$courseid\0$res"],$udom,$uname);
2364: return $times{"$courseid\0$res"};
2365: }
2366:
2367: sub set_first_access {
2368: my ($type)=@_;
2369: my ($symb,$courseid,$udom,$uname)=&whichuser();
2370: my ($map,$id,$res)=&decode_symb($symb);
2371: if ($type eq 'map') {
2372: $res=&symbread($map);
2373: } else {
2374: $res=$symb;
2375: }
2376: my $firstaccess=&get_first_access($type,$symb);
2377: if (!$firstaccess) {
2378: return &put('firstaccesstimes',{"$courseid\0$res"=>time},$udom,$uname);
2379: }
2380: return 'already_set';
2381: }
2382:
2383: sub checkout {
2384: my ($symb,$tuname,$tudom,$tcrsid)=@_;
2385: my $now=time;
2386: my $lonhost=$perlvar{'lonHostID'};
2387: my $infostr=&escape(
2388: 'CHECKOUTTOKEN&'.
2389: $tuname.'&'.
2390: $tudom.'&'.
2391: $tcrsid.'&'.
2392: $symb.'&'.
2393: $now.'&'.$ENV{'REMOTE_ADDR'});
2394: my $token=&reply('tmpput:'.$infostr,$lonhost);
2395: if ($token=~/^error\:/) {
2396: &logthis("<font color=\"blue\">WARNING: ".
2397: "Checkout tmpput failed ".$tudom.' - '.$tuname.' - '.$symb.
2398: "</font>");
2399: return '';
2400: }
2401:
2402: $token=~s/^(\d+)\_.*\_(\d+)$/$1\*$2\*$lonhost/;
2403: $token=~tr/a-z/A-Z/;
2404:
2405: my %infohash=('resource.0.outtoken' => $token,
2406: 'resource.0.checkouttime' => $now,
2407: 'resource.0.outremote' => $ENV{'REMOTE_ADDR'});
2408:
2409: unless (&cstore(\%infohash,$symb,$tcrsid,$tudom,$tuname) eq 'ok') {
2410: return '';
2411: } else {
2412: &logthis("<font color=\"blue\">WARNING: ".
2413: "Checkout cstore failed ".$tudom.' - '.$tuname.' - '.$symb.
2414: "</font>");
2415: }
2416:
2417: if (&log($tudom,$tuname,&homeserver($tuname,$tudom),
2418: &escape('Checkout '.$infostr.' - '.
2419: $token)) ne 'ok') {
2420: return '';
2421: } else {
2422: &logthis("<font color=\"blue\">WARNING: ".
2423: "Checkout log failed ".$tudom.' - '.$tuname.' - '.$symb.
2424: "</font>");
2425: }
2426: return $token;
2427: }
2428:
2429: # ------------------------------------------------------------ Check in an item
2430:
2431: sub checkin {
2432: my $token=shift;
2433: my $now=time;
2434: my ($ta,$tb,$lonhost)=split(/\*/,$token);
2435: $lonhost=~tr/A-Z/a-z/;
2436: my $dtoken=$ta.'_'.&hostname($lonhost).'_'.$tb;
2437: $dtoken=~s/\W/\_/g;
2438: my ($dummy,$tuname,$tudom,$tcrsid,$symb,$chtim,$rmaddr)=
2439: split(/\&/,&unescape(&reply('tmpget:'.$dtoken,$lonhost)));
2440:
2441: unless (($tuname) && ($tudom)) {
2442: &logthis('Check in '.$token.' ('.$dtoken.') failed');
2443: return '';
2444: }
2445:
2446: unless (&allowed('mgr',$tcrsid)) {
2447: &logthis('Check in '.$token.' ('.$dtoken.') unauthorized: '.
2448: $env{'user.name'}.' - '.$env{'user.domain'});
2449: return '';
2450: }
2451:
2452: my %infohash=('resource.0.intoken' => $token,
2453: 'resource.0.checkintime' => $now,
2454: 'resource.0.inremote' => $ENV{'REMOTE_ADDR'});
2455:
2456: unless (&cstore(\%infohash,$symb,$tcrsid,$tudom,$tuname) eq 'ok') {
2457: return '';
2458: }
2459:
2460: if (&log($tudom,$tuname,&homeserver($tuname,$tudom),
2461: &escape('Checkin - '.$token)) ne 'ok') {
2462: return '';
2463: }
2464:
2465: return ($symb,$tuname,$tudom,$tcrsid);
2466: }
2467:
2468: # --------------------------------------------- Set Expire Date for Spreadsheet
2469:
2470: sub expirespread {
2471: my ($uname,$udom,$stype,$usymb)=@_;
2472: my $cid=$env{'request.course.id'};
2473: if ($cid) {
2474: my $now=time;
2475: my $key=$uname.':'.$udom.':'.$stype.':'.$usymb;
2476: return &reply('put:'.$env{'course.'.$cid.'.domain'}.':'.
2477: $env{'course.'.$cid.'.num'}.
2478: ':nohist_expirationdates:'.
2479: &escape($key).'='.$now,
2480: $env{'course.'.$cid.'.home'})
2481: }
2482: return 'ok';
2483: }
2484:
2485: # ----------------------------------------------------- Devalidate Spreadsheets
2486:
2487: sub devalidate {
2488: my ($symb,$uname,$udom)=@_;
2489: my $cid=$env{'request.course.id'};
2490: if ($cid) {
2491: # delete the stored spreadsheets for
2492: # - the student level sheet of this user in course's homespace
2493: # - the assessment level sheet for this resource
2494: # for this user in user's homespace
2495: # - current conditional state info
2496: my $key=$uname.':'.$udom.':';
2497: my $status=
2498: &del('nohist_calculatedsheets',
2499: [$key.'studentcalc:'],
2500: $env{'course.'.$cid.'.domain'},
2501: $env{'course.'.$cid.'.num'})
2502: .' '.
2503: &del('nohist_calculatedsheets_'.$cid,
2504: [$key.'assesscalc:'.$symb],$udom,$uname);
2505: unless ($status eq 'ok ok') {
2506: &logthis('Could not devalidate spreadsheet '.
2507: $uname.' at '.$udom.' for '.
2508: $symb.': '.$status);
2509: }
2510: &delenv('user.state.'.$cid);
2511: }
2512: }
2513:
2514: sub get_scalar {
2515: my ($string,$end) = @_;
2516: my $value;
2517: if ($$string =~ s/^([^&]*?)($end)/$2/) {
2518: $value = $1;
2519: } elsif ($$string =~ s/^([^&]*?)&//) {
2520: $value = $1;
2521: }
2522: return &unescape($value);
2523: }
2524:
2525: sub array2str {
2526: my (@array) = @_;
2527: my $result=&arrayref2str(\@array);
2528: $result=~s/^__ARRAY_REF__//;
2529: $result=~s/__END_ARRAY_REF__$//;
2530: return $result;
2531: }
2532:
2533: sub arrayref2str {
2534: my ($arrayref) = @_;
2535: my $result='__ARRAY_REF__';
2536: foreach my $elem (@$arrayref) {
2537: if(ref($elem) eq 'ARRAY') {
2538: $result.=&arrayref2str($elem).'&';
2539: } elsif(ref($elem) eq 'HASH') {
2540: $result.=&hashref2str($elem).'&';
2541: } elsif(ref($elem)) {
2542: #print("Got a ref of ".(ref($elem))." skipping.");
2543: } else {
2544: $result.=&escape($elem).'&';
2545: }
2546: }
2547: $result=~s/\&$//;
2548: $result .= '__END_ARRAY_REF__';
2549: return $result;
2550: }
2551:
2552: sub hash2str {
2553: my (%hash) = @_;
2554: my $result=&hashref2str(\%hash);
2555: $result=~s/^__HASH_REF__//;
2556: $result=~s/__END_HASH_REF__$//;
2557: return $result;
2558: }
2559:
2560: sub hashref2str {
2561: my ($hashref)=@_;
2562: my $result='__HASH_REF__';
2563: foreach my $key (sort(keys(%$hashref))) {
2564: if (ref($key) eq 'ARRAY') {
2565: $result.=&arrayref2str($key).'=';
2566: } elsif (ref($key) eq 'HASH') {
2567: $result.=&hashref2str($key).'=';
2568: } elsif (ref($key)) {
2569: $result.='=';
2570: #print("Got a ref of ".(ref($key))." skipping.");
2571: } else {
2572: if ($key) {$result.=&escape($key).'=';} else { last; }
2573: }
2574:
2575: if(ref($hashref->{$key}) eq 'ARRAY') {
2576: $result.=&arrayref2str($hashref->{$key}).'&';
2577: } elsif(ref($hashref->{$key}) eq 'HASH') {
2578: $result.=&hashref2str($hashref->{$key}).'&';
2579: } elsif(ref($hashref->{$key})) {
2580: $result.='&';
2581: #print("Got a ref of ".(ref($hashref->{$key}))." skipping.");
2582: } else {
2583: $result.=&escape($hashref->{$key}).'&';
2584: }
2585: }
2586: $result=~s/\&$//;
2587: $result .= '__END_HASH_REF__';
2588: return $result;
2589: }
2590:
2591: sub str2hash {
2592: my ($string)=@_;
2593: my ($hash)=&str2hashref('__HASH_REF__'.$string.'__END_HASH_REF__');
2594: return %$hash;
2595: }
2596:
2597: sub str2hashref {
2598: my ($string) = @_;
2599:
2600: my %hash;
2601:
2602: if($string !~ /^__HASH_REF__/) {
2603: if (! ($string eq '' || !defined($string))) {
2604: $hash{'error'}='Not hash reference';
2605: }
2606: return (\%hash, $string);
2607: }
2608:
2609: $string =~ s/^__HASH_REF__//;
2610:
2611: while($string !~ /^__END_HASH_REF__/) {
2612: #key
2613: my $key='';
2614: if($string =~ /^__HASH_REF__/) {
2615: ($key, $string)=&str2hashref($string);
2616: if(defined($key->{'error'})) {
2617: $hash{'error'}='Bad data';
2618: return (\%hash, $string);
2619: }
2620: } elsif($string =~ /^__ARRAY_REF__/) {
2621: ($key, $string)=&str2arrayref($string);
2622: if($key->[0] eq 'Array reference error') {
2623: $hash{'error'}='Bad data';
2624: return (\%hash, $string);
2625: }
2626: } else {
2627: $string =~ s/^(.*?)=//;
2628: $key=&unescape($1);
2629: }
2630: $string =~ s/^=//;
2631:
2632: #value
2633: my $value='';
2634: if($string =~ /^__HASH_REF__/) {
2635: ($value, $string)=&str2hashref($string);
2636: if(defined($value->{'error'})) {
2637: $hash{'error'}='Bad data';
2638: return (\%hash, $string);
2639: }
2640: } elsif($string =~ /^__ARRAY_REF__/) {
2641: ($value, $string)=&str2arrayref($string);
2642: if($value->[0] eq 'Array reference error') {
2643: $hash{'error'}='Bad data';
2644: return (\%hash, $string);
2645: }
2646: } else {
2647: $value=&get_scalar(\$string,'__END_HASH_REF__');
2648: }
2649: $string =~ s/^&//;
2650:
2651: $hash{$key}=$value;
2652: }
2653:
2654: $string =~ s/^__END_HASH_REF__//;
2655:
2656: return (\%hash, $string);
2657: }
2658:
2659: sub str2array {
2660: my ($string)=@_;
2661: my ($array)=&str2arrayref('__ARRAY_REF__'.$string.'__END_ARRAY_REF__');
2662: return @$array;
2663: }
2664:
2665: sub str2arrayref {
2666: my ($string) = @_;
2667: my @array;
2668:
2669: if($string !~ /^__ARRAY_REF__/) {
2670: if (! ($string eq '' || !defined($string))) {
2671: $array[0]='Array reference error';
2672: }
2673: return (\@array, $string);
2674: }
2675:
2676: $string =~ s/^__ARRAY_REF__//;
2677:
2678: while($string !~ /^__END_ARRAY_REF__/) {
2679: my $value='';
2680: if($string =~ /^__HASH_REF__/) {
2681: ($value, $string)=&str2hashref($string);
2682: if(defined($value->{'error'})) {
2683: $array[0] ='Array reference error';
2684: return (\@array, $string);
2685: }
2686: } elsif($string =~ /^__ARRAY_REF__/) {
2687: ($value, $string)=&str2arrayref($string);
2688: if($value->[0] eq 'Array reference error') {
2689: $array[0] ='Array reference error';
2690: return (\@array, $string);
2691: }
2692: } else {
2693: $value=&get_scalar(\$string,'__END_ARRAY_REF__');
2694: }
2695: $string =~ s/^&//;
2696:
2697: push(@array, $value);
2698: }
2699:
2700: $string =~ s/^__END_ARRAY_REF__//;
2701:
2702: return (\@array, $string);
2703: }
2704:
2705: # -------------------------------------------------------------------Temp Store
2706:
2707: sub tmpreset {
2708: my ($symb,$namespace,$domain,$stuname) = @_;
2709: if (!$symb) {
2710: $symb=&symbread();
2711: if (!$symb) { $symb= $env{'request.url'}; }
2712: }
2713: $symb=escape($symb);
2714:
2715: if (!$namespace) { $namespace=$env{'request.state'}; }
2716: $namespace=~s/\//\_/g;
2717: $namespace=~s/\W//g;
2718:
2719: if (!$domain) { $domain=$env{'user.domain'}; }
2720: if (!$stuname) { $stuname=$env{'user.name'}; }
2721: if ($domain eq 'public' && $stuname eq 'public') {
2722: $stuname=$ENV{'REMOTE_ADDR'};
2723: }
2724: my $path=$perlvar{'lonDaemons'}.'/tmp';
2725: my %hash;
2726: if (tie(%hash,'GDBM_File',
2727: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
2728: &GDBM_WRCREAT(),0640)) {
2729: foreach my $key (keys %hash) {
2730: if ($key=~ /:$symb/) {
2731: delete($hash{$key});
2732: }
2733: }
2734: }
2735: }
2736:
2737: sub tmpstore {
2738: my ($storehash,$symb,$namespace,$domain,$stuname) = @_;
2739:
2740: if (!$symb) {
2741: $symb=&symbread();
2742: if (!$symb) { $symb= $env{'request.url'}; }
2743: }
2744: $symb=escape($symb);
2745:
2746: if (!$namespace) {
2747: # I don't think we would ever want to store this for a course.
2748: # it seems this will only be used if we don't have a course.
2749: #$namespace=$env{'request.course.id'};
2750: #if (!$namespace) {
2751: $namespace=$env{'request.state'};
2752: #}
2753: }
2754: $namespace=~s/\//\_/g;
2755: $namespace=~s/\W//g;
2756: if (!$domain) { $domain=$env{'user.domain'}; }
2757: if (!$stuname) { $stuname=$env{'user.name'}; }
2758: if ($domain eq 'public' && $stuname eq 'public') {
2759: $stuname=$ENV{'REMOTE_ADDR'};
2760: }
2761: my $now=time;
2762: my %hash;
2763: my $path=$perlvar{'lonDaemons'}.'/tmp';
2764: if (tie(%hash,'GDBM_File',
2765: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
2766: &GDBM_WRCREAT(),0640)) {
2767: $hash{"version:$symb"}++;
2768: my $version=$hash{"version:$symb"};
2769: my $allkeys='';
2770: foreach my $key (keys(%$storehash)) {
2771: $allkeys.=$key.':';
2772: $hash{"$version:$symb:$key"}=&freeze_escape($$storehash{$key});
2773: }
2774: $hash{"$version:$symb:timestamp"}=$now;
2775: $allkeys.='timestamp';
2776: $hash{"$version:keys:$symb"}=$allkeys;
2777: if (untie(%hash)) {
2778: return 'ok';
2779: } else {
2780: return "error:$!";
2781: }
2782: } else {
2783: return "error:$!";
2784: }
2785: }
2786:
2787: # -----------------------------------------------------------------Temp Restore
2788:
2789: sub tmprestore {
2790: my ($symb,$namespace,$domain,$stuname) = @_;
2791:
2792: if (!$symb) {
2793: $symb=&symbread();
2794: if (!$symb) { $symb= $env{'request.url'}; }
2795: }
2796: $symb=escape($symb);
2797:
2798: if (!$namespace) { $namespace=$env{'request.state'}; }
2799:
2800: if (!$domain) { $domain=$env{'user.domain'}; }
2801: if (!$stuname) { $stuname=$env{'user.name'}; }
2802: if ($domain eq 'public' && $stuname eq 'public') {
2803: $stuname=$ENV{'REMOTE_ADDR'};
2804: }
2805: my %returnhash;
2806: $namespace=~s/\//\_/g;
2807: $namespace=~s/\W//g;
2808: my %hash;
2809: my $path=$perlvar{'lonDaemons'}.'/tmp';
2810: if (tie(%hash,'GDBM_File',
2811: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
2812: &GDBM_READER(),0640)) {
2813: my $version=$hash{"version:$symb"};
2814: $returnhash{'version'}=$version;
2815: my $scope;
2816: for ($scope=1;$scope<=$version;$scope++) {
2817: my $vkeys=$hash{"$scope:keys:$symb"};
2818: my @keys=split(/:/,$vkeys);
2819: my $key;
2820: $returnhash{"$scope:keys"}=$vkeys;
2821: foreach $key (@keys) {
2822: $returnhash{"$scope:$key"}=&thaw_unescape($hash{"$scope:$symb:$key"});
2823: $returnhash{"$key"}=&thaw_unescape($hash{"$scope:$symb:$key"});
2824: }
2825: }
2826: if (!(untie(%hash))) {
2827: return "error:$!";
2828: }
2829: } else {
2830: return "error:$!";
2831: }
2832: return %returnhash;
2833: }
2834:
2835: # ----------------------------------------------------------------------- Store
2836:
2837: sub store {
2838: my ($storehash,$symb,$namespace,$domain,$stuname) = @_;
2839: my $home='';
2840:
2841: if ($stuname) { $home=&homeserver($stuname,$domain); }
2842:
2843: $symb=&symbclean($symb);
2844: if (!$symb) { unless ($symb=&symbread()) { return ''; } }
2845:
2846: if (!$domain) { $domain=$env{'user.domain'}; }
2847: if (!$stuname) { $stuname=$env{'user.name'}; }
2848:
2849: &devalidate($symb,$stuname,$domain);
2850:
2851: $symb=escape($symb);
2852: if (!$namespace) {
2853: unless ($namespace=$env{'request.course.id'}) {
2854: return '';
2855: }
2856: }
2857: if (!$home) { $home=$env{'user.home'}; }
2858:
2859: $$storehash{'ip'}=$ENV{'REMOTE_ADDR'};
2860: $$storehash{'host'}=$perlvar{'lonHostID'};
2861:
2862: my $namevalue='';
2863: foreach my $key (keys(%$storehash)) {
2864: $namevalue.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
2865: }
2866: $namevalue=~s/\&$//;
2867: &courselog($symb.':'.$stuname.':'.$domain.':STORE:'.$namevalue);
2868: return reply("store:$domain:$stuname:$namespace:$symb:$namevalue","$home");
2869: }
2870:
2871: # -------------------------------------------------------------- Critical Store
2872:
2873: sub cstore {
2874: my ($storehash,$symb,$namespace,$domain,$stuname) = @_;
2875: my $home='';
2876:
2877: if ($stuname) { $home=&homeserver($stuname,$domain); }
2878:
2879: $symb=&symbclean($symb);
2880: if (!$symb) { unless ($symb=&symbread()) { return ''; } }
2881:
2882: if (!$domain) { $domain=$env{'user.domain'}; }
2883: if (!$stuname) { $stuname=$env{'user.name'}; }
2884:
2885: &devalidate($symb,$stuname,$domain);
2886:
2887: $symb=escape($symb);
2888: if (!$namespace) {
2889: unless ($namespace=$env{'request.course.id'}) {
2890: return '';
2891: }
2892: }
2893: if (!$home) { $home=$env{'user.home'}; }
2894:
2895: $$storehash{'ip'}=$ENV{'REMOTE_ADDR'};
2896: $$storehash{'host'}=$perlvar{'lonHostID'};
2897:
2898: my $namevalue='';
2899: foreach my $key (keys(%$storehash)) {
2900: $namevalue.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
2901: }
2902: $namevalue=~s/\&$//;
2903: &courselog($symb.':'.$stuname.':'.$domain.':CSTORE:'.$namevalue);
2904: return critical
2905: ("store:$domain:$stuname:$namespace:$symb:$namevalue","$home");
2906: }
2907:
2908: # --------------------------------------------------------------------- Restore
2909:
2910: sub restore {
2911: my ($symb,$namespace,$domain,$stuname) = @_;
2912: my $home='';
2913:
2914: if ($stuname) { $home=&homeserver($stuname,$domain); }
2915:
2916: if (!$symb) {
2917: unless ($symb=escape(&symbread())) { return ''; }
2918: } else {
2919: $symb=&escape(&symbclean($symb));
2920: }
2921: if (!$namespace) {
2922: unless ($namespace=$env{'request.course.id'}) {
2923: return '';
2924: }
2925: }
2926: if (!$domain) { $domain=$env{'user.domain'}; }
2927: if (!$stuname) { $stuname=$env{'user.name'}; }
2928: if (!$home) { $home=$env{'user.home'}; }
2929: my $answer=&reply("restore:$domain:$stuname:$namespace:$symb","$home");
2930:
2931: my %returnhash=();
2932: foreach my $line (split(/\&/,$answer)) {
2933: my ($name,$value)=split(/\=/,$line);
2934: $returnhash{&unescape($name)}=&thaw_unescape($value);
2935: }
2936: my $version;
2937: for ($version=1;$version<=$returnhash{'version'};$version++) {
2938: foreach my $item (split(/\:/,$returnhash{$version.':keys'})) {
2939: $returnhash{$item}=$returnhash{$version.':'.$item};
2940: }
2941: }
2942: return %returnhash;
2943: }
2944:
2945: # ---------------------------------------------------------- Course Description
2946:
2947: sub coursedescription {
2948: my ($courseid,$args)=@_;
2949: $courseid=~s/^\///;
2950: $courseid=~s/\_/\//g;
2951: my ($cdomain,$cnum)=split(/\//,$courseid);
2952: my $chome=&homeserver($cnum,$cdomain);
2953: my $normalid=$cdomain.'_'.$cnum;
2954: # need to always cache even if we get errors otherwise we keep
2955: # trying and trying and trying to get the course description.
2956: my %envhash=();
2957: my %returnhash=();
2958:
2959: my $expiretime=600;
2960: if ($env{'request.course.id'} eq $normalid) {
2961: $expiretime=120;
2962: }
2963:
2964: my $prefix='course.'.$cdomain.'_'.$cnum.'.';
2965: if (!$args->{'freshen_cache'}
2966: && ((time-$env{$prefix.'last_cache'}) < $expiretime) ) {
2967: foreach my $key (keys(%env)) {
2968: next if ($key !~ /^\Q$prefix\E(.*)/);
2969: my ($setting) = $1;
2970: $returnhash{$setting} = $env{$key};
2971: }
2972: return %returnhash;
2973: }
2974:
2975: # get the data agin
2976: if (!$args->{'one_time'}) {
2977: $envhash{'course.'.$normalid.'.last_cache'}=time;
2978: }
2979:
2980: if ($chome ne 'no_host') {
2981: %returnhash=&dump('environment',$cdomain,$cnum);
2982: if (!exists($returnhash{'con_lost'})) {
2983: $returnhash{'home'}= $chome;
2984: $returnhash{'domain'} = $cdomain;
2985: $returnhash{'num'} = $cnum;
2986: if (!defined($returnhash{'type'})) {
2987: $returnhash{'type'} = 'Course';
2988: }
2989: while (my ($name,$value) = each %returnhash) {
2990: $envhash{'course.'.$normalid.'.'.$name}=$value;
2991: }
2992: $returnhash{'url'}=&clutter($returnhash{'url'});
2993: $returnhash{'fn'}=$perlvar{'lonDaemons'}.'/tmp/'.
2994: $env{'user.name'}.'_'.$cdomain.'_'.$cnum;
2995: $envhash{'course.'.$normalid.'.home'}=$chome;
2996: $envhash{'course.'.$normalid.'.domain'}=$cdomain;
2997: $envhash{'course.'.$normalid.'.num'}=$cnum;
2998: }
2999: }
3000: if (!$args->{'one_time'}) {
3001: &appenv(%envhash);
3002: }
3003: return %returnhash;
3004: }
3005:
3006: # -------------------------------------------------See if a user is privileged
3007:
3008: sub privileged {
3009: my ($username,$domain)=@_;
3010: my $rolesdump=&reply("dump:$domain:$username:roles",
3011: &homeserver($username,$domain));
3012: if (($rolesdump eq 'con_lost') || ($rolesdump eq '')) { return 0; }
3013: my $now=time;
3014: if ($rolesdump ne '') {
3015: foreach my $entry (split(/&/,$rolesdump)) {
3016: if ($entry!~/^rolesdef_/) {
3017: my ($area,$role)=split(/=/,$entry);
3018: $area=~s/\_\w\w$//;
3019: my ($trole,$tend,$tstart)=split(/_/,$role);
3020: if (($trole eq 'dc') || ($trole eq 'su')) {
3021: my $active=1;
3022: if ($tend) {
3023: if ($tend<$now) { $active=0; }
3024: }
3025: if ($tstart) {
3026: if ($tstart>$now) { $active=0; }
3027: }
3028: if ($active) { return 1; }
3029: }
3030: }
3031: }
3032: }
3033: return 0;
3034: }
3035:
3036: # -------------------------------------------------------- Get user privileges
3037:
3038: sub rolesinit {
3039: my ($domain,$username,$authhost)=@_;
3040: my $rolesdump=reply("dump:$domain:$username:roles",$authhost);
3041: if (($rolesdump eq 'con_lost') || ($rolesdump eq '')) { return ''; }
3042: my %allroles=();
3043: my %allgroups=();
3044: my $now=time;
3045: my %userroles = ('user.login.time' => $now);
3046: my $group_privs;
3047:
3048: if ($rolesdump ne '') {
3049: foreach my $entry (split(/&/,$rolesdump)) {
3050: if ($entry!~/^rolesdef_/) {
3051: my ($area,$role)=split(/=/,$entry);
3052: $area=~s/\_\w\w$//;
3053: my ($trole,$tend,$tstart,$group_privs);
3054: if ($role=~/^cr/) {
3055: if ($role=~m|^(cr/$match_domain/$match_username/[a-zA-Z0-9]+)_(.*)$|) {
3056: ($trole,my $trest)=($role=~m|^(cr/$match_domain/$match_username/[a-zA-Z0-9]+)_(.*)$|);
3057: ($tend,$tstart)=split('_',$trest);
3058: } else {
3059: $trole=$role;
3060: }
3061: } elsif ($role =~ m|^gr/|) {
3062: ($trole,$tend,$tstart) = split(/_/,$role);
3063: ($trole,$group_privs) = split(/\//,$trole);
3064: $group_privs = &unescape($group_privs);
3065: } else {
3066: ($trole,$tend,$tstart)=split(/_/,$role);
3067: }
3068: my %new_role = &set_arearole($trole,$area,$tstart,$tend,$domain,
3069: $username);
3070: @userroles{keys(%new_role)} = @new_role{keys(%new_role)};
3071: if (($tend!=0) && ($tend<$now)) { $trole=''; }
3072: if (($tstart!=0) && ($tstart>$now)) { $trole=''; }
3073: if (($area ne '') && ($trole ne '')) {
3074: my $spec=$trole.'.'.$area;
3075: my ($tdummy,$tdomain,$trest)=split(/\//,$area);
3076: if ($trole =~ /^cr\//) {
3077: &custom_roleprivs(\%allroles,$trole,$tdomain,$trest,$spec,$area);
3078: } elsif ($trole eq 'gr') {
3079: &group_roleprivs(\%allgroups,$area,$group_privs,$tend,$tstart);
3080: } else {
3081: &standard_roleprivs(\%allroles,$trole,$tdomain,$spec,$trest,$area);
3082: }
3083: }
3084: }
3085: }
3086: my ($author,$adv) = &set_userprivs(\%userroles,\%allroles,\%allgroups);
3087: $userroles{'user.adv'} = $adv;
3088: $userroles{'user.author'} = $author;
3089: $env{'user.adv'}=$adv;
3090: }
3091: return \%userroles;
3092: }
3093:
3094: sub set_arearole {
3095: my ($trole,$area,$tstart,$tend,$domain,$username) = @_;
3096: # log the associated role with the area
3097: &userrolelog($trole,$username,$domain,$area,$tstart,$tend);
3098: return ('user.role.'.$trole.'.'.$area => $tstart.'.'.$tend);
3099: }
3100:
3101: sub custom_roleprivs {
3102: my ($allroles,$trole,$tdomain,$trest,$spec,$area) = @_;
3103: my ($rdummy,$rdomain,$rauthor,$rrole)=split(/\//,$trole);
3104: my $homsvr=homeserver($rauthor,$rdomain);
3105: if (&hostname($homsvr) ne '') {
3106: my ($rdummy,$roledef)=
3107: &get('roles',["rolesdef_$rrole"],$rdomain,$rauthor);
3108: if (($rdummy ne 'con_lost') && ($roledef ne '')) {
3109: my ($syspriv,$dompriv,$coursepriv)=split(/\_/,$roledef);
3110: if (defined($syspriv)) {
3111: $$allroles{'cm./'}.=':'.$syspriv;
3112: $$allroles{$spec.'./'}.=':'.$syspriv;
3113: }
3114: if ($tdomain ne '') {
3115: if (defined($dompriv)) {
3116: $$allroles{'cm./'.$tdomain.'/'}.=':'.$dompriv;
3117: $$allroles{$spec.'./'.$tdomain.'/'}.=':'.$dompriv;
3118: }
3119: if (($trest ne '') && (defined($coursepriv))) {
3120: $$allroles{'cm.'.$area}.=':'.$coursepriv;
3121: $$allroles{$spec.'.'.$area}.=':'.$coursepriv;
3122: }
3123: }
3124: }
3125: }
3126: }
3127:
3128: sub group_roleprivs {
3129: my ($allgroups,$area,$group_privs,$tend,$tstart) = @_;
3130: my $access = 1;
3131: my $now = time;
3132: if (($tend!=0) && ($tend<$now)) { $access = 0; }
3133: if (($tstart!=0) && ($tstart>$now)) { $access=0; }
3134: if ($access) {
3135: my ($course,$group) = ($area =~ m|(/$match_domain/$match_courseid)/([^/]+)$|);
3136: $$allgroups{$course}{$group} .=':'.$group_privs;
3137: }
3138: }
3139:
3140: sub standard_roleprivs {
3141: my ($allroles,$trole,$tdomain,$spec,$trest,$area) = @_;
3142: if (defined($pr{$trole.':s'})) {
3143: $$allroles{'cm./'}.=':'.$pr{$trole.':s'};
3144: $$allroles{$spec.'./'}.=':'.$pr{$trole.':s'};
3145: }
3146: if ($tdomain ne '') {
3147: if (defined($pr{$trole.':d'})) {
3148: $$allroles{'cm./'.$tdomain.'/'}.=':'.$pr{$trole.':d'};
3149: $$allroles{$spec.'./'.$tdomain.'/'}.=':'.$pr{$trole.':d'};
3150: }
3151: if (($trest ne '') && (defined($pr{$trole.':c'}))) {
3152: $$allroles{'cm.'.$area}.=':'.$pr{$trole.':c'};
3153: $$allroles{$spec.'.'.$area}.=':'.$pr{$trole.':c'};
3154: }
3155: }
3156: }
3157:
3158: sub set_userprivs {
3159: my ($userroles,$allroles,$allgroups) = @_;
3160: my $author=0;
3161: my $adv=0;
3162: my %grouproles = ();
3163: if (keys(%{$allgroups}) > 0) {
3164: foreach my $role (keys %{$allroles}) {
3165: my ($trole,$area,$sec,$extendedarea);
3166: if ($role =~ m-^(\w+|cr/$match_domain/$match_username/\w+)\.(/$match_domain/$match_courseid)(/?\w*)\.-) {
3167: $trole = $1;
3168: $area = $2;
3169: $sec = $3;
3170: $extendedarea = $area.$sec;
3171: if (exists($$allgroups{$area})) {
3172: foreach my $group (keys(%{$$allgroups{$area}})) {
3173: my $spec = $trole.'.'.$extendedarea;
3174: $grouproles{$spec.'.'.$area.'/'.$group} =
3175: $$allgroups{$area}{$group};
3176: }
3177: }
3178: }
3179: }
3180: }
3181: foreach my $group (keys(%grouproles)) {
3182: $$allroles{$group} = $grouproles{$group};
3183: }
3184: foreach my $role (keys(%{$allroles})) {
3185: my %thesepriv;
3186: if (($role=~/^au/) || ($role=~/^ca/)) { $author=1; }
3187: foreach my $item (split(/:/,$$allroles{$role})) {
3188: if ($item ne '') {
3189: my ($privilege,$restrictions)=split(/&/,$item);
3190: if ($restrictions eq '') {
3191: $thesepriv{$privilege}='F';
3192: } elsif ($thesepriv{$privilege} ne 'F') {
3193: $thesepriv{$privilege}.=$restrictions;
3194: }
3195: if ($thesepriv{'adv'} eq 'F') { $adv=1; }
3196: }
3197: }
3198: my $thesestr='';
3199: foreach my $priv (keys(%thesepriv)) {
3200: $thesestr.=':'.$priv.'&'.$thesepriv{$priv};
3201: }
3202: $userroles->{'user.priv.'.$role} = $thesestr;
3203: }
3204: return ($author,$adv);
3205: }
3206:
3207: # --------------------------------------------------------------- get interface
3208:
3209: sub get {
3210: my ($namespace,$storearr,$udomain,$uname)=@_;
3211: my $items='';
3212: foreach my $item (@$storearr) {
3213: $items.=&escape($item).'&';
3214: }
3215: $items=~s/\&$//;
3216: if (!$udomain) { $udomain=$env{'user.domain'}; }
3217: if (!$uname) { $uname=$env{'user.name'}; }
3218: my $uhome=&homeserver($uname,$udomain);
3219:
3220: my $rep=&reply("get:$udomain:$uname:$namespace:$items",$uhome);
3221: my @pairs=split(/\&/,$rep);
3222: if ( $#pairs==0 && $pairs[0] =~ /^(con_lost|error|no_such_host)/i) {
3223: return @pairs;
3224: }
3225: my %returnhash=();
3226: my $i=0;
3227: foreach my $item (@$storearr) {
3228: $returnhash{$item}=&thaw_unescape($pairs[$i]);
3229: $i++;
3230: }
3231: return %returnhash;
3232: }
3233:
3234: # --------------------------------------------------------------- del interface
3235:
3236: sub del {
3237: my ($namespace,$storearr,$udomain,$uname)=@_;
3238: my $items='';
3239: foreach my $item (@$storearr) {
3240: $items.=&escape($item).'&';
3241: }
3242: $items=~s/\&$//;
3243: if (!$udomain) { $udomain=$env{'user.domain'}; }
3244: if (!$uname) { $uname=$env{'user.name'}; }
3245: my $uhome=&homeserver($uname,$udomain);
3246:
3247: return &reply("del:$udomain:$uname:$namespace:$items",$uhome);
3248: }
3249:
3250: # -------------------------------------------------------------- dump interface
3251:
3252: sub dump {
3253: my ($namespace,$udomain,$uname,$regexp,$range)=@_;
3254: if (!$udomain) { $udomain=$env{'user.domain'}; }
3255: if (!$uname) { $uname=$env{'user.name'}; }
3256: my $uhome=&homeserver($uname,$udomain);
3257: if ($regexp) {
3258: $regexp=&escape($regexp);
3259: } else {
3260: $regexp='.';
3261: }
3262: my $rep=&reply("dump:$udomain:$uname:$namespace:$regexp:$range",$uhome);
3263: my @pairs=split(/\&/,$rep);
3264: my %returnhash=();
3265: foreach my $item (@pairs) {
3266: my ($key,$value)=split(/=/,$item,2);
3267: $key = &unescape($key);
3268: next if ($key =~ /^error: 2 /);
3269: $returnhash{$key}=&thaw_unescape($value);
3270: }
3271: return %returnhash;
3272: }
3273:
3274: # --------------------------------------------------------- dumpstore interface
3275:
3276: sub dumpstore {
3277: my ($namespace,$udomain,$uname,$regexp,$range)=@_;
3278: if (!$udomain) { $udomain=$env{'user.domain'}; }
3279: if (!$uname) { $uname=$env{'user.name'}; }
3280: my $uhome=&homeserver($uname,$udomain);
3281: if ($regexp) {
3282: $regexp=&escape($regexp);
3283: } else {
3284: $regexp='.';
3285: }
3286: my $rep=&reply("dump:$udomain:$uname:$namespace:$regexp:$range",$uhome);
3287: my @pairs=split(/\&/,$rep);
3288: my %returnhash=();
3289: foreach my $item (@pairs) {
3290: my ($key,$value)=split(/=/,$item,2);
3291: next if ($key =~ /^error: 2 /);
3292: $returnhash{$key}=&thaw_unescape($value);
3293: }
3294: return %returnhash;
3295: }
3296:
3297: # -------------------------------------------------------------- keys interface
3298:
3299: sub getkeys {
3300: my ($namespace,$udomain,$uname)=@_;
3301: if (!$udomain) { $udomain=$env{'user.domain'}; }
3302: if (!$uname) { $uname=$env{'user.name'}; }
3303: my $uhome=&homeserver($uname,$udomain);
3304: my $rep=reply("keys:$udomain:$uname:$namespace",$uhome);
3305: my @keyarray=();
3306: foreach my $key (split(/\&/,$rep)) {
3307: next if ($key =~ /^error: 2 /);
3308: push(@keyarray,&unescape($key));
3309: }
3310: return @keyarray;
3311: }
3312:
3313: # --------------------------------------------------------------- currentdump
3314: sub currentdump {
3315: my ($courseid,$sdom,$sname)=@_;
3316: $courseid = $env{'request.course.id'} if (! defined($courseid));
3317: $sdom = $env{'user.domain'} if (! defined($sdom));
3318: $sname = $env{'user.name'} if (! defined($sname));
3319: my $uhome = &homeserver($sname,$sdom);
3320: my $rep=reply('currentdump:'.$sdom.':'.$sname.':'.$courseid,$uhome);
3321: return if ($rep =~ /^(error:|no_such_host)/);
3322: #
3323: my %returnhash=();
3324: #
3325: if ($rep eq "unknown_cmd") {
3326: # an old lond will not know currentdump
3327: # Do a dump and make it look like a currentdump
3328: my @tmp = &dumpstore($courseid,$sdom,$sname,'.');
3329: return if ($tmp[0] =~ /^(error:|no_such_host)/);
3330: my %hash = @tmp;
3331: @tmp=();
3332: %returnhash = %{&convert_dump_to_currentdump(\%hash)};
3333: } else {
3334: my @pairs=split(/\&/,$rep);
3335: foreach my $pair (@pairs) {
3336: my ($key,$value)=split(/=/,$pair,2);
3337: my ($symb,$param) = split(/:/,$key);
3338: $returnhash{&unescape($symb)}->{&unescape($param)} =
3339: &thaw_unescape($value);
3340: }
3341: }
3342: return %returnhash;
3343: }
3344:
3345: sub convert_dump_to_currentdump{
3346: my %hash = %{shift()};
3347: my %returnhash;
3348: # Code ripped from lond, essentially. The only difference
3349: # here is the unescaping done by lonnet::dump(). Conceivably
3350: # we might run in to problems with parameter names =~ /^v\./
3351: while (my ($key,$value) = each(%hash)) {
3352: my ($v,$symb,$param) = split(/:/,$key);
3353: $symb = &unescape($symb);
3354: $param = &unescape($param);
3355: next if ($v eq 'version' || $symb eq 'keys');
3356: next if (exists($returnhash{$symb}) &&
3357: exists($returnhash{$symb}->{$param}) &&
3358: $returnhash{$symb}->{'v.'.$param} > $v);
3359: $returnhash{$symb}->{$param}=$value;
3360: $returnhash{$symb}->{'v.'.$param}=$v;
3361: }
3362: #
3363: # Remove all of the keys in the hashes which keep track of
3364: # the version of the parameter.
3365: while (my ($symb,$param_hash) = each(%returnhash)) {
3366: # use a foreach because we are going to delete from the hash.
3367: foreach my $key (keys(%$param_hash)) {
3368: delete($param_hash->{$key}) if ($key =~ /^v\./);
3369: }
3370: }
3371: return \%returnhash;
3372: }
3373:
3374: # ------------------------------------------------------ critical inc interface
3375:
3376: sub cinc {
3377: return &inc(@_,'critical');
3378: }
3379:
3380: # --------------------------------------------------------------- inc interface
3381:
3382: sub inc {
3383: my ($namespace,$store,$udomain,$uname,$critical) = @_;
3384: if (!$udomain) { $udomain=$env{'user.domain'}; }
3385: if (!$uname) { $uname=$env{'user.name'}; }
3386: my $uhome=&homeserver($uname,$udomain);
3387: my $items='';
3388: if (! ref($store)) {
3389: # got a single value, so use that instead
3390: $items = &escape($store).'=&';
3391: } elsif (ref($store) eq 'SCALAR') {
3392: $items = &escape($$store).'=&';
3393: } elsif (ref($store) eq 'ARRAY') {
3394: $items = join('=&',map {&escape($_);} @{$store});
3395: } elsif (ref($store) eq 'HASH') {
3396: while (my($key,$value) = each(%{$store})) {
3397: $items.= &escape($key).'='.&escape($value).'&';
3398: }
3399: }
3400: $items=~s/\&$//;
3401: if ($critical) {
3402: return &critical("inc:$udomain:$uname:$namespace:$items",$uhome);
3403: } else {
3404: return &reply("inc:$udomain:$uname:$namespace:$items",$uhome);
3405: }
3406: }
3407:
3408: # --------------------------------------------------------------- put interface
3409:
3410: sub put {
3411: my ($namespace,$storehash,$udomain,$uname)=@_;
3412: if (!$udomain) { $udomain=$env{'user.domain'}; }
3413: if (!$uname) { $uname=$env{'user.name'}; }
3414: my $uhome=&homeserver($uname,$udomain);
3415: my $items='';
3416: foreach my $item (keys(%$storehash)) {
3417: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
3418: }
3419: $items=~s/\&$//;
3420: return &reply("put:$udomain:$uname:$namespace:$items",$uhome);
3421: }
3422:
3423: # ------------------------------------------------------------ newput interface
3424:
3425: sub newput {
3426: my ($namespace,$storehash,$udomain,$uname)=@_;
3427: if (!$udomain) { $udomain=$env{'user.domain'}; }
3428: if (!$uname) { $uname=$env{'user.name'}; }
3429: my $uhome=&homeserver($uname,$udomain);
3430: my $items='';
3431: foreach my $key (keys(%$storehash)) {
3432: $items.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
3433: }
3434: $items=~s/\&$//;
3435: return &reply("newput:$udomain:$uname:$namespace:$items",$uhome);
3436: }
3437:
3438: # --------------------------------------------------------- putstore interface
3439:
3440: sub putstore {
3441: my ($namespace,$symb,$version,$storehash,$udomain,$uname)=@_;
3442: if (!$udomain) { $udomain=$env{'user.domain'}; }
3443: if (!$uname) { $uname=$env{'user.name'}; }
3444: my $uhome=&homeserver($uname,$udomain);
3445: my $items='';
3446: foreach my $key (keys(%$storehash)) {
3447: $items.= &escape($key).'='.&freeze_escape($storehash->{$key}).'&';
3448: }
3449: $items=~s/\&$//;
3450: my $esc_symb=&escape($symb);
3451: my $esc_v=&escape($version);
3452: my $reply =
3453: &reply("putstore:$udomain:$uname:$namespace:$esc_symb:$esc_v:$items",
3454: $uhome);
3455: if ($reply eq 'unknown_cmd') {
3456: # gfall back to way things use to be done
3457: return &old_putstore($namespace,$symb,$version,$storehash,$udomain,
3458: $uname);
3459: }
3460: return $reply;
3461: }
3462:
3463: sub old_putstore {
3464: my ($namespace,$symb,$version,$storehash,$udomain,$uname)=@_;
3465: if (!$udomain) { $udomain=$env{'user.domain'}; }
3466: if (!$uname) { $uname=$env{'user.name'}; }
3467: my $uhome=&homeserver($uname,$udomain);
3468: my %newstorehash;
3469: foreach my $item (keys(%$storehash)) {
3470: my $key = $version.':'.&escape($symb).':'.$item;
3471: $newstorehash{$key} = $storehash->{$item};
3472: }
3473: my $items='';
3474: my %allitems = ();
3475: foreach my $item (keys(%newstorehash)) {
3476: if ($item =~ m/^([^\:]+):([^\:]+):([^\:]+)$/) {
3477: my $key = $1.':keys:'.$2;
3478: $allitems{$key} .= $3.':';
3479: }
3480: $items.=$item.'='.&freeze_escape($newstorehash{$item}).'&';
3481: }
3482: foreach my $item (keys(%allitems)) {
3483: $allitems{$item} =~ s/\:$//;
3484: $items.= $item.'='.$allitems{$item}.'&';
3485: }
3486: $items=~s/\&$//;
3487: return &reply("put:$udomain:$uname:$namespace:$items",$uhome);
3488: }
3489:
3490: # ------------------------------------------------------ critical put interface
3491:
3492: sub cput {
3493: my ($namespace,$storehash,$udomain,$uname)=@_;
3494: if (!$udomain) { $udomain=$env{'user.domain'}; }
3495: if (!$uname) { $uname=$env{'user.name'}; }
3496: my $uhome=&homeserver($uname,$udomain);
3497: my $items='';
3498: foreach my $item (keys(%$storehash)) {
3499: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
3500: }
3501: $items=~s/\&$//;
3502: return &critical("put:$udomain:$uname:$namespace:$items",$uhome);
3503: }
3504:
3505: # -------------------------------------------------------------- eget interface
3506:
3507: sub eget {
3508: my ($namespace,$storearr,$udomain,$uname)=@_;
3509: my $items='';
3510: foreach my $item (@$storearr) {
3511: $items.=&escape($item).'&';
3512: }
3513: $items=~s/\&$//;
3514: if (!$udomain) { $udomain=$env{'user.domain'}; }
3515: if (!$uname) { $uname=$env{'user.name'}; }
3516: my $uhome=&homeserver($uname,$udomain);
3517: my $rep=&reply("eget:$udomain:$uname:$namespace:$items",$uhome);
3518: my @pairs=split(/\&/,$rep);
3519: my %returnhash=();
3520: my $i=0;
3521: foreach my $item (@$storearr) {
3522: $returnhash{$item}=&thaw_unescape($pairs[$i]);
3523: $i++;
3524: }
3525: return %returnhash;
3526: }
3527:
3528: # ------------------------------------------------------------ tmpput interface
3529: sub tmpput {
3530: my ($storehash,$server,$context)=@_;
3531: my $items='';
3532: foreach my $item (keys(%$storehash)) {
3533: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
3534: }
3535: $items=~s/\&$//;
3536: if (defined($context)) {
3537: $items .= ':'.&escape($context);
3538: }
3539: return &reply("tmpput:$items",$server);
3540: }
3541:
3542: # ------------------------------------------------------------ tmpget interface
3543: sub tmpget {
3544: my ($token,$server)=@_;
3545: if (!defined($server)) { $server = $perlvar{'lonHostID'}; }
3546: my $rep=&reply("tmpget:$token",$server);
3547: my %returnhash;
3548: foreach my $item (split(/\&/,$rep)) {
3549: my ($key,$value)=split(/=/,$item);
3550: $returnhash{&unescape($key)}=&thaw_unescape($value);
3551: }
3552: return %returnhash;
3553: }
3554:
3555: # ------------------------------------------------------------ tmpget interface
3556: sub tmpdel {
3557: my ($token,$server)=@_;
3558: if (!defined($server)) { $server = $perlvar{'lonHostID'}; }
3559: return &reply("tmpdel:$token",$server);
3560: }
3561:
3562: # -------------------------------------------------- portfolio access checking
3563:
3564: sub portfolio_access {
3565: my ($requrl) = @_;
3566: my (undef,$udom,$unum,$file_name,$group) = &parse_portfolio_url($requrl);
3567: my $result = &get_portfolio_access($udom,$unum,$file_name,$group);
3568: if ($result) {
3569: my %setters;
3570: if ($env{'user.name'} eq 'public' && $env{'user.domain'} eq 'public') {
3571: my ($startblock,$endblock) =
3572: &Apache::loncommon::blockcheck(\%setters,'port',$unum,$udom);
3573: if ($startblock && $endblock) {
3574: return 'B';
3575: }
3576: } else {
3577: my ($startblock,$endblock) =
3578: &Apache::loncommon::blockcheck(\%setters,'port');
3579: if ($startblock && $endblock) {
3580: return 'B';
3581: }
3582: }
3583: }
3584: if ($result eq 'ok') {
3585: return 'F';
3586: } elsif ($result =~ /^[^:]+:guest_/) {
3587: return 'A';
3588: }
3589: return '';
3590: }
3591:
3592: sub get_portfolio_access {
3593: my ($udom,$unum,$file_name,$group,$access_hash) = @_;
3594:
3595: if (!ref($access_hash)) {
3596: my $current_perms = &get_portfile_permissions($udom,$unum);
3597: my %access_controls = &get_access_controls($current_perms,$group,
3598: $file_name);
3599: $access_hash = $access_controls{$file_name};
3600: }
3601:
3602: my ($public,$guest,@domains,@users,@courses,@groups);
3603: my $now = time;
3604: if (ref($access_hash) eq 'HASH') {
3605: foreach my $key (keys(%{$access_hash})) {
3606: my ($num,$scope,$end,$start) = ($key =~ /^([^:]+):([a-z]+)_(\d*)_?(\d*)$/);
3607: if ($start > $now) {
3608: next;
3609: }
3610: if ($end && $end<$now) {
3611: next;
3612: }
3613: if ($scope eq 'public') {
3614: $public = $key;
3615: last;
3616: } elsif ($scope eq 'guest') {
3617: $guest = $key;
3618: } elsif ($scope eq 'domains') {
3619: push(@domains,$key);
3620: } elsif ($scope eq 'users') {
3621: push(@users,$key);
3622: } elsif ($scope eq 'course') {
3623: push(@courses,$key);
3624: } elsif ($scope eq 'group') {
3625: push(@groups,$key);
3626: }
3627: }
3628: if ($public) {
3629: return 'ok';
3630: }
3631: if ($env{'user.name'} eq 'public' && $env{'user.domain'} eq 'public') {
3632: if ($guest) {
3633: return $guest;
3634: }
3635: } else {
3636: if (@domains > 0) {
3637: foreach my $domkey (@domains) {
3638: if (ref($access_hash->{$domkey}{'dom'}) eq 'ARRAY') {
3639: if (grep(/^\Q$env{'user.domain'}\E$/,@{$access_hash->{$domkey}{'dom'}})) {
3640: return 'ok';
3641: }
3642: }
3643: }
3644: }
3645: if (@users > 0) {
3646: foreach my $userkey (@users) {
3647: if (ref($access_hash->{$userkey}{'users'}) eq 'ARRAY') {
3648: foreach my $item (@{$access_hash->{$userkey}{'users'}}) {
3649: if (ref($item) eq 'HASH') {
3650: if (($item->{'uname'} eq $env{'user.name'}) &&
3651: ($item->{'udom'} eq $env{'user.domain'})) {
3652: return 'ok';
3653: }
3654: }
3655: }
3656: }
3657: }
3658: }
3659: my %roleshash;
3660: my @courses_and_groups = @courses;
3661: push(@courses_and_groups,@groups);
3662: if (@courses_and_groups > 0) {
3663: my (%allgroups,%allroles);
3664: my ($start,$end,$role,$sec,$group);
3665: foreach my $envkey (%env) {
3666: if ($envkey =~ m-^user\.role\.(gr|cc|in|ta|ep|st)\./($match_domain)/($match_courseid)/?([^/]*)$-) {
3667: my $cid = $2.'_'.$3;
3668: if ($1 eq 'gr') {
3669: $group = $4;
3670: $allgroups{$cid}{$group} = $env{$envkey};
3671: } else {
3672: if ($4 eq '') {
3673: $sec = 'none';
3674: } else {
3675: $sec = $4;
3676: }
3677: $allroles{$cid}{$1}{$sec} = $env{$envkey};
3678: }
3679: } elsif ($envkey =~ m-^user\.role\./cr/($match_domain/$match_username/\w*)./($match_domain)/($match_courseid)/?([^/]*)$-) {
3680: my $cid = $2.'_'.$3;
3681: if ($4 eq '') {
3682: $sec = 'none';
3683: } else {
3684: $sec = $4;
3685: }
3686: $allroles{$cid}{$1}{$sec} = $env{$envkey};
3687: }
3688: }
3689: if (keys(%allroles) == 0) {
3690: return;
3691: }
3692: foreach my $key (@courses_and_groups) {
3693: my %content = %{$$access_hash{$key}};
3694: my $cnum = $content{'number'};
3695: my $cdom = $content{'domain'};
3696: my $cid = $cdom.'_'.$cnum;
3697: if (!exists($allroles{$cid})) {
3698: next;
3699: }
3700: foreach my $role_id (keys(%{$content{'roles'}})) {
3701: my @sections = @{$content{'roles'}{$role_id}{'section'}};
3702: my @groups = @{$content{'roles'}{$role_id}{'group'}};
3703: my @status = @{$content{'roles'}{$role_id}{'access'}};
3704: my @roles = @{$content{'roles'}{$role_id}{'role'}};
3705: foreach my $role (keys(%{$allroles{$cid}})) {
3706: if ((grep/^all$/,@roles) || (grep/^\Q$role\E$/,@roles)) {
3707: foreach my $sec (keys(%{$allroles{$cid}{$role}})) {
3708: if (&course_group_datechecker($allroles{$cid}{$role}{$sec},$now,\@status) eq 'ok') {
3709: if (grep/^all$/,@sections) {
3710: return 'ok';
3711: } else {
3712: if (grep/^$sec$/,@sections) {
3713: return 'ok';
3714: }
3715: }
3716: }
3717: }
3718: if (keys(%{$allgroups{$cid}}) == 0) {
3719: if (grep/^none$/,@groups) {
3720: return 'ok';
3721: }
3722: } else {
3723: if (grep/^all$/,@groups) {
3724: return 'ok';
3725: }
3726: foreach my $group (keys(%{$allgroups{$cid}})) {
3727: if (grep/^$group$/,@groups) {
3728: return 'ok';
3729: }
3730: }
3731: }
3732: }
3733: }
3734: }
3735: }
3736: }
3737: if ($guest) {
3738: return $guest;
3739: }
3740: }
3741: }
3742: return;
3743: }
3744:
3745: sub course_group_datechecker {
3746: my ($dates,$now,$status) = @_;
3747: my ($start,$end) = split(/\./,$dates);
3748: if (!$start && !$end) {
3749: return 'ok';
3750: }
3751: if (grep/^active$/,@{$status}) {
3752: if (((!$start) || ($start && $start <= $now)) && ((!$end) || ($end && $end >= $now))) {
3753: return 'ok';
3754: }
3755: }
3756: if (grep/^previous$/,@{$status}) {
3757: if ($end > $now ) {
3758: return 'ok';
3759: }
3760: }
3761: if (grep/^future$/,@{$status}) {
3762: if ($start > $now) {
3763: return 'ok';
3764: }
3765: }
3766: return;
3767: }
3768:
3769: sub parse_portfolio_url {
3770: my ($url) = @_;
3771:
3772: my ($type,$udom,$unum,$group,$file_name);
3773:
3774: if ($url =~ m-^/*(?:uploaded|editupload)/($match_domain)/($match_username)/portfolio(/.+)$-) {
3775: $type = 1;
3776: $udom = $1;
3777: $unum = $2;
3778: $file_name = $3;
3779: } elsif ($url =~ m-^/*(?:uploaded|editupload)/($match_domain)/($match_courseid)/groups/([^/]+)/portfolio/(.+)$-) {
3780: $type = 2;
3781: $udom = $1;
3782: $unum = $2;
3783: $group = $3;
3784: $file_name = $3.'/'.$4;
3785: }
3786: if (wantarray) {
3787: return ($type,$udom,$unum,$file_name,$group);
3788: }
3789: return $type;
3790: }
3791:
3792: sub is_portfolio_url {
3793: my ($url) = @_;
3794: return scalar(&parse_portfolio_url($url));
3795: }
3796:
3797: sub is_portfolio_file {
3798: my ($file) = @_;
3799: if (($file =~ /^portfolio/) || ($file =~ /^groups\/\w+\/portfolio/)) {
3800: return 1;
3801: }
3802: return;
3803: }
3804:
3805:
3806: # ---------------------------------------------- Custom access rule evaluation
3807:
3808: sub customaccess {
3809: my ($priv,$uri)=@_;
3810: my ($urole,$urealm)=split(/\./,$env{'request.role'},2);
3811: my (undef,$udom,$ucrs,$usec)=split(/\//,$urealm);
3812: $udom = &LONCAPA::clean_domain($udom);
3813: $ucrs = &LONCAPA::clean_username($ucrs);
3814: my $access=0;
3815: foreach my $right (split(/\s*\,\s*/,&metadata($uri,'rule_rights'))) {
3816: my ($effect,$realm,$role,$type)=split(/\:/,$right);
3817: if ($type eq 'user') {
3818: foreach my $scope (split(/\s*\,\s*/,$realm)) {
3819: my ($tdom,$tuname)=split(m{/},$scope);
3820: if ($tdom) {
3821: if ($tdom ne $env{'user.domain'}) { next; }
3822: }
3823: if ($tuname) {
3824: if ($tuname ne $env{'user.name'}) { next; }
3825: }
3826: $access=($effect eq 'allow');
3827: last;
3828: }
3829: } else {
3830: if ($role) {
3831: if ($role ne $urole) { next; }
3832: }
3833: foreach my $scope (split(/\s*\,\s*/,$realm)) {
3834: my ($tdom,$tcrs,$tsec)=split(/\_/,$scope);
3835: if ($tdom) {
3836: if ($tdom ne $udom) { next; }
3837: }
3838: if ($tcrs) {
3839: if ($tcrs ne $ucrs) { next; }
3840: }
3841: if ($tsec) {
3842: if ($tsec ne $usec) { next; }
3843: }
3844: $access=($effect eq 'allow');
3845: last;
3846: }
3847: if ($realm eq '' && $role eq '') {
3848: $access=($effect eq 'allow');
3849: }
3850: }
3851: }
3852: return $access;
3853: }
3854:
3855: # ------------------------------------------------- Check for a user privilege
3856:
3857: sub allowed {
3858: my ($priv,$uri,$symb,$role)=@_;
3859: my $ver_orguri=$uri;
3860: $uri=&deversion($uri);
3861: my $orguri=$uri;
3862: $uri=&declutter($uri);
3863:
3864: if ($priv eq 'evb') {
3865: # Evade communication block restrictions for specified role in a course
3866: if ($env{'user.priv.'.$role} =~/evb\&([^\:]*)/) {
3867: return $1;
3868: } else {
3869: return;
3870: }
3871: }
3872:
3873: if (defined($env{'allowed.'.$priv})) { return $env{'allowed.'.$priv}; }
3874: # Free bre access to adm and meta resources
3875: if (((($uri=~/^adm\//) && ($uri !~ m{/(?:smppg|bulletinboard)$}))
3876: || (($uri=~/\.meta$/) && ($uri!~m|^uploaded/|) ))
3877: && ($priv eq 'bre')) {
3878: return 'F';
3879: }
3880:
3881: # Free bre access to user's own portfolio contents
3882: my ($space,$domain,$name,@dir)=split('/',$uri);
3883: if (($space=~/^(uploaded|editupload)$/) && ($env{'user.name'} eq $name) &&
3884: ($env{'user.domain'} eq $domain) && ('portfolio' eq $dir[0])) {
3885: my %setters;
3886: my ($startblock,$endblock) =
3887: &Apache::loncommon::blockcheck(\%setters,'port');
3888: if ($startblock && $endblock) {
3889: return 'B';
3890: } else {
3891: return 'F';
3892: }
3893: }
3894:
3895: # bre access to group portfolio for rgf priv in group, or mdg or vcg in course.
3896: if (($space=~/^(uploaded|editupload)$/) && ($dir[0] eq 'groups')
3897: && ($dir[2] eq 'portfolio') && ($priv eq 'bre')) {
3898: if (exists($env{'request.course.id'})) {
3899: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
3900: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
3901: if (($domain eq $cdom) && ($name eq $cnum)) {
3902: my $courseprivid=$env{'request.course.id'};
3903: $courseprivid=~s/\_/\//;
3904: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid
3905: .'/'.$dir[1]} =~/rgf\&([^\:]*)/) {
3906: return $1;
3907: } else {
3908: if ($env{'request.course.sec'}) {
3909: $courseprivid.='/'.$env{'request.course.sec'};
3910: }
3911: if ($env{'user.priv.'.$env{'request.role'}.'./'.
3912: $courseprivid} =~/(mdg|vcg)\&([^\:]*)/) {
3913: return $2;
3914: }
3915: }
3916: }
3917: }
3918: }
3919:
3920: # Free bre to public access
3921:
3922: if ($priv eq 'bre') {
3923: my $copyright=&metadata($uri,'copyright');
3924: if (($copyright eq 'public') && (!$env{'request.course.id'})) {
3925: return 'F';
3926: }
3927: if ($copyright eq 'priv') {
3928: $uri=~/([^\/]+)\/([^\/]+)\//;
3929: unless (($env{'user.name'} eq $2) && ($env{'user.domain'} eq $1)) {
3930: return '';
3931: }
3932: }
3933: if ($copyright eq 'domain') {
3934: $uri=~/([^\/]+)\/([^\/]+)\//;
3935: unless (($env{'user.domain'} eq $1) ||
3936: ($env{'course.'.$env{'request.course.id'}.'.domain'} eq $1)) {
3937: return '';
3938: }
3939: }
3940: if ($env{'request.role'}=~ /li\.\//) {
3941: # Library role, so allow browsing of resources in this domain.
3942: return 'F';
3943: }
3944: if ($copyright eq 'custom') {
3945: unless (&customaccess($priv,$uri)) { return ''; }
3946: }
3947: }
3948: # Domain coordinator is trying to create a course
3949: if (($priv eq 'ccc') && ($env{'request.role'} =~ /^dc\./)) {
3950: # uri is the requested domain in this case.
3951: # comparison to 'request.role.domain' shows if the user has selected
3952: # a role of dc for the domain in question.
3953: return 'F' if ($uri eq $env{'request.role.domain'});
3954: }
3955:
3956: my $thisallowed='';
3957: my $statecond=0;
3958: my $courseprivid='';
3959:
3960: # Course
3961:
3962: if ($env{'user.priv.'.$env{'request.role'}.'./'}=~/\Q$priv\E\&([^\:]*)/) {
3963: $thisallowed.=$1;
3964: }
3965:
3966: # Domain
3967:
3968: if ($env{'user.priv.'.$env{'request.role'}.'./'.(split(/\//,$uri))[0].'/'}
3969: =~/\Q$priv\E\&([^\:]*)/) {
3970: $thisallowed.=$1;
3971: }
3972:
3973: # Course: uri itself is a course
3974: my $courseuri=$uri;
3975: $courseuri=~s/\_(\d)/\/$1/;
3976: $courseuri=~s/^([^\/])/\/$1/;
3977:
3978: if ($env{'user.priv.'.$env{'request.role'}.'.'.$courseuri}
3979: =~/\Q$priv\E\&([^\:]*)/) {
3980: $thisallowed.=$1;
3981: }
3982:
3983: # URI is an uploaded document for this course, default permissions don't matter
3984: # not allowing 'edit' access (editupload) to uploaded course docs
3985: if (($priv eq 'bre') && ($uri=~m|^uploaded/|)) {
3986: $thisallowed='';
3987: my ($match)=&is_on_map($uri);
3988: if ($match) {
3989: if ($env{'user.priv.'.$env{'request.role'}.'./'}
3990: =~/\Q$priv\E\&([^\:]*)/) {
3991: $thisallowed.=$1;
3992: }
3993: } else {
3994: my $refuri = $env{'httpref.'.$orguri} || $env{'httpref.'.$ver_orguri};
3995: if ($refuri) {
3996: if ($refuri =~ m|^/adm/|) {
3997: $thisallowed='F';
3998: } else {
3999: $refuri=&declutter($refuri);
4000: my ($match) = &is_on_map($refuri);
4001: if ($match) {
4002: $thisallowed='F';
4003: }
4004: }
4005: }
4006: }
4007: }
4008:
4009: if ($priv eq 'bre'
4010: && $thisallowed ne 'F'
4011: && $thisallowed ne '2'
4012: && &is_portfolio_url($uri)) {
4013: $thisallowed = &portfolio_access($uri);
4014: }
4015:
4016: # Full access at system, domain or course-wide level? Exit.
4017:
4018: if ($thisallowed=~/F/) {
4019: return 'F';
4020: }
4021:
4022: # If this is generating or modifying users, exit with special codes
4023:
4024: if (':csu:cdc:ccc:cin:cta:cep:ccr:cst:cad:cli:cau:cdg:cca:caa:'=~/\:\Q$priv\E\:/) {
4025: if (($priv eq 'cca') || ($priv eq 'caa')) {
4026: my ($audom,$auname)=split('/',$uri);
4027: # no author name given, so this just checks on the general right to make a co-author in this domain
4028: unless ($auname) { return $thisallowed; }
4029: # an author name is given, so we are about to actually make a co-author for a certain account
4030: if (($auname ne $env{'user.name'} && $env{'request.role'} !~ /^dc\./) ||
4031: (($audom ne $env{'user.domain'} && $env{'request.role'} !~ /^dc\./) &&
4032: ($audom ne $env{'request.role.domain'}))) { return ''; }
4033: }
4034: return $thisallowed;
4035: }
4036: #
4037: # Gathered so far: system, domain and course wide privileges
4038: #
4039: # Course: See if uri or referer is an individual resource that is part of
4040: # the course
4041:
4042: if ($env{'request.course.id'}) {
4043:
4044: $courseprivid=$env{'request.course.id'};
4045: if ($env{'request.course.sec'}) {
4046: $courseprivid.='/'.$env{'request.course.sec'};
4047: }
4048: $courseprivid=~s/\_/\//;
4049: my $checkreferer=1;
4050: my ($match,$cond)=&is_on_map($uri);
4051: if ($match) {
4052: $statecond=$cond;
4053: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid}
4054: =~/\Q$priv\E\&([^\:]*)/) {
4055: $thisallowed.=$1;
4056: $checkreferer=0;
4057: }
4058: }
4059:
4060: if ($checkreferer) {
4061: my $refuri=$env{'httpref.'.$orguri};
4062: unless ($refuri) {
4063: foreach my $key (keys(%env)) {
4064: if ($key=~/^httpref\..*\*/) {
4065: my $pattern=$key;
4066: $pattern=~s/^httpref\.\/res\///;
4067: $pattern=~s/\*/\[\^\/\]\+/g;
4068: $pattern=~s/\//\\\//g;
4069: if ($orguri=~/$pattern/) {
4070: $refuri=$env{$key};
4071: }
4072: }
4073: }
4074: }
4075:
4076: if ($refuri) {
4077: $refuri=&declutter($refuri);
4078: my ($match,$cond)=&is_on_map($refuri);
4079: if ($match) {
4080: my $refstatecond=$cond;
4081: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid}
4082: =~/\Q$priv\E\&([^\:]*)/) {
4083: $thisallowed.=$1;
4084: $uri=$refuri;
4085: $statecond=$refstatecond;
4086: }
4087: }
4088: }
4089: }
4090: }
4091:
4092: #
4093: # Gathered now: all privileges that could apply, and condition number
4094: #
4095: #
4096: # Full or no access?
4097: #
4098:
4099: if ($thisallowed=~/F/) {
4100: return 'F';
4101: }
4102:
4103: unless ($thisallowed) {
4104: return '';
4105: }
4106:
4107: # Restrictions exist, deal with them
4108: #
4109: # C:according to course preferences
4110: # R:according to resource settings
4111: # L:unless locked
4112: # X:according to user session state
4113: #
4114:
4115: # Possibly locked functionality, check all courses
4116: # Locks might take effect only after 10 minutes cache expiration for other
4117: # courses, and 2 minutes for current course
4118:
4119: my $envkey;
4120: if ($thisallowed=~/L/) {
4121: foreach $envkey (keys %env) {
4122: if ($envkey=~/^user\.role\.(st|ta)\.([^\.]*)/) {
4123: my $courseid=$2;
4124: my $roleid=$1.'.'.$2;
4125: $courseid=~s/^\///;
4126: my $expiretime=600;
4127: if ($env{'request.role'} eq $roleid) {
4128: $expiretime=120;
4129: }
4130: my ($cdom,$cnum,$csec)=split(/\//,$courseid);
4131: my $prefix='course.'.$cdom.'_'.$cnum.'.';
4132: if ((time-$env{$prefix.'last_cache'})>$expiretime) {
4133: &coursedescription($courseid,{'freshen_cache' => 1});
4134: }
4135: if (($env{$prefix.'res.'.$uri.'.lock.sections'}=~/\,\Q$csec\E\,/)
4136: || ($env{$prefix.'res.'.$uri.'.lock.sections'} eq 'all')) {
4137: if ($env{$prefix.'res.'.$uri.'.lock.expire'}>time) {
4138: &log($env{'user.domain'},$env{'user.name'},
4139: $env{'user.home'},
4140: 'Locked by res: '.$priv.' for '.$uri.' due to '.
4141: $cdom.'/'.$cnum.'/'.$csec.' expire '.
4142: $env{$prefix.'priv.'.$priv.'.lock.expire'});
4143: return '';
4144: }
4145: }
4146: if (($env{$prefix.'priv.'.$priv.'.lock.sections'}=~/\,\Q$csec\E\,/)
4147: || ($env{$prefix.'priv.'.$priv.'.lock.sections'} eq 'all')) {
4148: if ($env{'priv.'.$priv.'.lock.expire'}>time) {
4149: &log($env{'user.domain'},$env{'user.name'},
4150: $env{'user.home'},
4151: 'Locked by priv: '.$priv.' for '.$uri.' due to '.
4152: $cdom.'/'.$cnum.'/'.$csec.' expire '.
4153: $env{$prefix.'priv.'.$priv.'.lock.expire'});
4154: return '';
4155: }
4156: }
4157: }
4158: }
4159: }
4160:
4161: #
4162: # Rest of the restrictions depend on selected course
4163: #
4164:
4165: unless ($env{'request.course.id'}) {
4166: if ($thisallowed eq 'A') {
4167: return 'A';
4168: } elsif ($thisallowed eq 'B') {
4169: return 'B';
4170: } else {
4171: return '1';
4172: }
4173: }
4174:
4175: #
4176: # Now user is definitely in a course
4177: #
4178:
4179:
4180: # Course preferences
4181:
4182: if ($thisallowed=~/C/) {
4183: my $rolecode=(split(/\./,$env{'request.role'}))[0];
4184: my $unamedom=$env{'user.name'}.':'.$env{'user.domain'};
4185: if ($env{'course.'.$env{'request.course.id'}.'.'.$priv.'.roles.denied'}
4186: =~/\Q$rolecode\E/) {
4187: if ($priv ne 'pch') {
4188: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.':'.
4189: 'Denied by role: '.$priv.' for '.$uri.' as '.$rolecode.' in '.
4190: $env{'request.course.id'});
4191: }
4192: return '';
4193: }
4194:
4195: if ($env{'course.'.$env{'request.course.id'}.'.'.$priv.'.users.denied'}
4196: =~/\Q$unamedom\E/) {
4197: if ($priv ne 'pch') {
4198: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.
4199: 'Denied by user: '.$priv.' for '.$uri.' as '.$unamedom.' in '.
4200: $env{'request.course.id'});
4201: }
4202: return '';
4203: }
4204: }
4205:
4206: # Resource preferences
4207:
4208: if ($thisallowed=~/R/) {
4209: my $rolecode=(split(/\./,$env{'request.role'}))[0];
4210: if (&metadata($uri,'roledeny')=~/\Q$rolecode\E/) {
4211: if ($priv ne 'pch') {
4212: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.':'.
4213: 'Denied by role: '.$priv.' for '.$uri.' as '.$rolecode);
4214: }
4215: return '';
4216: }
4217: }
4218:
4219: # Restricted by state or randomout?
4220:
4221: if ($thisallowed=~/X/) {
4222: if ($env{'acc.randomout'}) {
4223: if (!$symb) { $symb=&symbread($uri,1); }
4224: if (($symb) && ($env{'acc.randomout'}=~/\&\Q$symb\E\&/)) {
4225: return '';
4226: }
4227: }
4228: if (&condval($statecond)) {
4229: return '2';
4230: } else {
4231: return '';
4232: }
4233: }
4234:
4235: if ($thisallowed eq 'A') {
4236: return 'A';
4237: } elsif ($thisallowed eq 'B') {
4238: return 'B';
4239: }
4240: return 'F';
4241: }
4242:
4243: sub split_uri_for_cond {
4244: my $uri=&deversion(&declutter(shift));
4245: my @uriparts=split(/\//,$uri);
4246: my $filename=pop(@uriparts);
4247: my $pathname=join('/',@uriparts);
4248: return ($pathname,$filename);
4249: }
4250: # --------------------------------------------------- Is a resource on the map?
4251:
4252: sub is_on_map {
4253: my ($pathname,$filename) = &split_uri_for_cond(shift);
4254: #Trying to find the conditional for the file
4255: my $match=($env{'acc.res.'.$env{'request.course.id'}.'.'.$pathname}=~
4256: /\&\Q$filename\E\:([\d\|]+)\&/);
4257: if ($match) {
4258: return (1,$1);
4259: } else {
4260: return (0,0);
4261: }
4262: }
4263:
4264: # --------------------------------------------------------- Get symb from alias
4265:
4266: sub get_symb_from_alias {
4267: my $symb=shift;
4268: my ($map,$resid,$url)=&decode_symb($symb);
4269: # Already is a symb
4270: if ($url) { return $symb; }
4271: # Must be an alias
4272: my $aliassymb='';
4273: my %bighash;
4274: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
4275: &GDBM_READER(),0640)) {
4276: my $rid=$bighash{'mapalias_'.$symb};
4277: if ($rid) {
4278: my ($mapid,$resid)=split(/\./,$rid);
4279: $aliassymb=&encode_symb($bighash{'map_id_'.$mapid},
4280: $resid,$bighash{'src_'.$rid});
4281: }
4282: untie %bighash;
4283: }
4284: return $aliassymb;
4285: }
4286:
4287: # ----------------------------------------------------------------- Define Role
4288:
4289: sub definerole {
4290: if (allowed('mcr','/')) {
4291: my ($rolename,$sysrole,$domrole,$courole)=@_;
4292: foreach my $role (split(':',$sysrole)) {
4293: my ($crole,$cqual)=split(/\&/,$role);
4294: if ($pr{'cr:s'}!~/\Q$crole\E/) { return "refused:s:$crole"; }
4295: if ($pr{'cr:s'}=~/\Q$crole\E\&/) {
4296: if ($pr{'cr:s'}!~/\Q$crole\E\&\w*\Q$cqual\E/) {
4297: return "refused:s:$crole&$cqual";
4298: }
4299: }
4300: }
4301: foreach my $role (split(':',$domrole)) {
4302: my ($crole,$cqual)=split(/\&/,$role);
4303: if ($pr{'cr:d'}!~/\Q$crole\E/) { return "refused:d:$crole"; }
4304: if ($pr{'cr:d'}=~/\Q$crole\E\&/) {
4305: if ($pr{'cr:d'}!~/\Q$crole\W\&\w*\Q$cqual\E/) {
4306: return "refused:d:$crole&$cqual";
4307: }
4308: }
4309: }
4310: foreach my $role (split(':',$courole)) {
4311: my ($crole,$cqual)=split(/\&/,$role);
4312: if ($pr{'cr:c'}!~/\Q$crole\E/) { return "refused:c:$crole"; }
4313: if ($pr{'cr:c'}=~/\Q$crole\E\&/) {
4314: if ($pr{'cr:c'}!~/\Q$crole\E\&\w*\Q$cqual\E/) {
4315: return "refused:c:$crole&$cqual";
4316: }
4317: }
4318: }
4319: my $command="encrypt:rolesput:$env{'user.domain'}:$env{'user.name'}:".
4320: "$env{'user.domain'}:$env{'user.name'}:".
4321: "rolesdef_$rolename=".
4322: escape($sysrole.'_'.$domrole.'_'.$courole);
4323: return reply($command,$env{'user.home'});
4324: } else {
4325: return 'refused';
4326: }
4327: }
4328:
4329: # ---------------- Make a metadata query against the network of library servers
4330:
4331: sub metadata_query {
4332: my ($query,$custom,$customshow,$server_array)=@_;
4333: my %rhash;
4334: my %libserv = &all_library();
4335: my @server_list = (defined($server_array) ? @$server_array
4336: : keys(%libserv) );
4337: for my $server (@server_list) {
4338: unless ($custom or $customshow) {
4339: my $reply=&reply("querysend:".&escape($query),$server);
4340: $rhash{$server}=$reply;
4341: }
4342: else {
4343: my $reply=&reply("querysend:".&escape($query).':'.
4344: &escape($custom).':'.&escape($customshow),
4345: $server);
4346: $rhash{$server}=$reply;
4347: }
4348: }
4349: return \%rhash;
4350: }
4351:
4352: # ----------------------------------------- Send log queries and wait for reply
4353:
4354: sub log_query {
4355: my ($uname,$udom,$query,%filters)=@_;
4356: my $uhome=&homeserver($uname,$udom);
4357: if ($uhome eq 'no_host') { return 'error: no_host'; }
4358: my $uhost=&hostname($uhome);
4359: my $command=&escape(join(':',map{$_.'='.$filters{$_}} keys(%filters)));
4360: my $queryid=&reply("querysend:".$query.':'.$udom.':'.$uname.':'.$command,
4361: $uhome);
4362: unless ($queryid=~/^\Q$uhost\E\_/) { return 'error: '.$queryid; }
4363: return get_query_reply($queryid);
4364: }
4365:
4366: # -------------------------- Update MySQL table for portfolio file
4367:
4368: sub update_portfolio_table {
4369: my ($uname,$udom,$file_name,$query,$group,$action) = @_;
4370: my $homeserver = &homeserver($uname,$udom);
4371: my $queryid=
4372: &reply("querysend:".$query.':'.&escape($uname.':'.$udom.':'.$group).
4373: ':'.&escape($file_name).':'.$action,$homeserver);
4374: my $reply = &get_query_reply($queryid);
4375: return $reply;
4376: }
4377:
4378: # ------- Request retrieval of institutional classlists for course(s)
4379:
4380: sub fetch_enrollment_query {
4381: my ($context,$affiliatesref,$replyref,$dom,$cnum) = @_;
4382: my $homeserver;
4383: my $maxtries = 1;
4384: if ($context eq 'automated') {
4385: $homeserver = $perlvar{'lonHostID'};
4386: $maxtries = 10; # will wait for up to 2000s for retrieval of classlist data before timeout
4387: } else {
4388: $homeserver = &homeserver($cnum,$dom);
4389: }
4390: my $host=&hostname($homeserver);
4391: my $cmd = '';
4392: foreach my $affiliate (keys %{$affiliatesref}) {
4393: $cmd .= $affiliate.'='.join(",",@{$$affiliatesref{$affiliate}}).'%%';
4394: }
4395: $cmd =~ s/%%$//;
4396: $cmd = &escape($cmd);
4397: my $query = 'fetchenrollment';
4398: my $queryid=&reply("querysend:".$query.':'.$dom.':'.$env{'user.name'}.':'.$cmd,$homeserver);
4399: unless ($queryid=~/^\Q$host\E\_/) {
4400: &logthis('fetch_enrollment_query: invalid queryid: '.$queryid.' for host: '.$host.' and homeserver: '.$homeserver.' context: '.$context.' '.$cnum);
4401: return 'error: '.$queryid;
4402: }
4403: my $reply = &get_query_reply($queryid);
4404: my $tries = 1;
4405: while (($reply=~/^timeout/) && ($tries < $maxtries)) {
4406: $reply = &get_query_reply($queryid);
4407: $tries ++;
4408: }
4409: if ( ($reply =~/^timeout/) || ($reply =~/^error/) ) {
4410: &logthis('fetch_enrollment_query error: '.$reply.' for '.$dom.' '.$env{'user.name'}.' for '.$queryid.' context: '.$context.' '.$cnum.' maxtries: '.$maxtries.' tries: '.$tries);
4411: } else {
4412: my @responses = split/:/,$reply;
4413: if ($homeserver eq $perlvar{'lonHostID'}) {
4414: foreach my $line (@responses) {
4415: my ($key,$value) = split(/=/,$line,2);
4416: $$replyref{$key} = $value;
4417: }
4418: } else {
4419: my $pathname = $perlvar{'lonDaemons'}.'/tmp';
4420: foreach my $line (@responses) {
4421: my ($key,$value) = split(/=/,$line);
4422: $$replyref{$key} = $value;
4423: if ($value > 0) {
4424: foreach my $item (@{$$affiliatesref{$key}}) {
4425: my $filename = $dom.'_'.$key.'_'.$item.'_classlist.xml';
4426: my $destname = $pathname.'/'.$filename;
4427: my $xml_classlist = &reply("autoretrieve:".$filename,$homeserver);
4428: if ($xml_classlist =~ /^error/) {
4429: &logthis('fetch_enrollment_query - autoretrieve error: '.$xml_classlist.' for '.$filename.' from server: '.$homeserver.' '.$context.' '.$cnum);
4430: } else {
4431: if ( open(FILE,">$destname") ) {
4432: print FILE &unescape($xml_classlist);
4433: close(FILE);
4434: } else {
4435: &logthis('fetch_enrollment_query - error opening classlist file '.$destname.' '.$context.' '.$cnum);
4436: }
4437: }
4438: }
4439: }
4440: }
4441: }
4442: return 'ok';
4443: }
4444: return 'error';
4445: }
4446:
4447: sub get_query_reply {
4448: my $queryid=shift;
4449: my $replyfile=$perlvar{'lonDaemons'}.'/tmp/'.$queryid;
4450: my $reply='';
4451: for (1..100) {
4452: sleep 2;
4453: if (-e $replyfile.'.end') {
4454: if (open(my $fh,$replyfile)) {
4455: $reply.=<$fh>;
4456: close($fh);
4457: } else { return 'error: reply_file_error'; }
4458: return &unescape($reply);
4459: }
4460: }
4461: return 'timeout:'.$queryid;
4462: }
4463:
4464: sub courselog_query {
4465: #
4466: # possible filters:
4467: # url: url or symb
4468: # username
4469: # domain
4470: # action: view, submit, grade
4471: # start: timestamp
4472: # end: timestamp
4473: #
4474: my (%filters)=@_;
4475: unless ($env{'request.course.id'}) { return 'no_course'; }
4476: if ($filters{'url'}) {
4477: $filters{'url'}=&symbclean(&declutter($filters{'url'}));
4478: $filters{'url'}=~s/\.(\w+)$/(\\.\\d+)*\\.$1/;
4479: $filters{'url'}=~s/\.(\w+)\_\_\_/(\\.\\d+)*\\.$1/;
4480: }
4481: my $cname=$env{'course.'.$env{'request.course.id'}.'.num'};
4482: my $cdom=$env{'course.'.$env{'request.course.id'}.'.domain'};
4483: return &log_query($cname,$cdom,'courselog',%filters);
4484: }
4485:
4486: sub userlog_query {
4487: #
4488: # possible filters:
4489: # action: log check role
4490: # start: timestamp
4491: # end: timestamp
4492: #
4493: my ($uname,$udom,%filters)=@_;
4494: return &log_query($uname,$udom,'userlog',%filters);
4495: }
4496:
4497: #--------- Call auto-enrollment subs in localenroll.pm for homeserver for course
4498:
4499: sub auto_run {
4500: my ($cnum,$cdom) = @_;
4501: my $response = 0;
4502: my $settings;
4503: my %domconfig = &get_dom('configuration',['autoenroll'],$cdom);
4504: if (ref($domconfig{'autoenroll'}) eq 'HASH') {
4505: $settings = $domconfig{'autoenroll'};
4506: if ($settings->{'run'} eq '1') {
4507: $response = 1;
4508: }
4509: } else {
4510: my $homeserver = &homeserver($cnum,$cdom);
4511: $response = &reply('autorun:'.$cdom,$homeserver);
4512: }
4513: return $response;
4514: }
4515:
4516: sub auto_get_sections {
4517: my ($cnum,$cdom,$inst_coursecode) = @_;
4518: my $homeserver = &homeserver($cnum,$cdom);
4519: my @secs = ();
4520: my $response=&unescape(&reply('autogetsections:'.$inst_coursecode.':'.$cdom,$homeserver));
4521: unless ($response eq 'refused') {
4522: @secs = split/:/,$response;
4523: }
4524: return @secs;
4525: }
4526:
4527: sub auto_new_course {
4528: my ($cnum,$cdom,$inst_course_id,$owner) = @_;
4529: my $homeserver = &homeserver($cnum,$cdom);
4530: my $response=&unescape(&reply('autonewcourse:'.$inst_course_id.':'.$owner.':'.$cdom,$homeserver));
4531: return $response;
4532: }
4533:
4534: sub auto_validate_courseID {
4535: my ($cnum,$cdom,$inst_course_id) = @_;
4536: my $homeserver = &homeserver($cnum,$cdom);
4537: my $response=&unescape(&reply('autovalidatecourse:'.$inst_course_id.':'.$cdom,$homeserver));
4538: return $response;
4539: }
4540:
4541: sub auto_create_password {
4542: my ($cnum,$cdom,$authparam,$udom) = @_;
4543: my ($homeserver,$response);
4544: my $create_passwd = 0;
4545: my $authchk = '';
4546: if ($udom =~ /^$match_domain$/) {
4547: $homeserver = &domain($udom,'primary');
4548: }
4549: if ($homeserver eq '') {
4550: if (($cdom =~ /^$match_domain$/) && ($cnum =~ /^$match_courseid$/)) {
4551: $homeserver = &homeserver($cnum,$cdom);
4552: }
4553: }
4554: if ($homeserver eq '') {
4555: $authchk = 'nodomain';
4556: } else {
4557: $response=&unescape(&reply('autocreatepassword:'.$authparam.':'.$cdom,$homeserver));
4558: if ($response eq 'refused') {
4559: $authchk = 'refused';
4560: } else {
4561: ($authparam,$create_passwd,$authchk) = split/:/,$response;
4562: }
4563: }
4564: return ($authparam,$create_passwd,$authchk);
4565: }
4566:
4567: sub auto_photo_permission {
4568: my ($cnum,$cdom,$students) = @_;
4569: my $homeserver = &homeserver($cnum,$cdom);
4570: my ($outcome,$perm_reqd,$conditions) =
4571: split(/:/,&unescape(&reply('autophotopermission:'.$cdom,$homeserver)),3);
4572: if ($outcome =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
4573: return (undef,undef);
4574: }
4575: return ($outcome,$perm_reqd,$conditions);
4576: }
4577:
4578: sub auto_checkphotos {
4579: my ($uname,$udom,$pid) = @_;
4580: my $homeserver = &homeserver($uname,$udom);
4581: my ($result,$resulttype);
4582: my $outcome = &unescape(&reply('autophotocheck:'.&escape($udom).':'.
4583: &escape($uname).':'.&escape($pid),
4584: $homeserver));
4585: if ($outcome =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
4586: return (undef,undef);
4587: }
4588: if ($outcome) {
4589: ($result,$resulttype) = split(/:/,$outcome);
4590: }
4591: return ($result,$resulttype);
4592: }
4593:
4594: sub auto_photochoice {
4595: my ($cnum,$cdom) = @_;
4596: my $homeserver = &homeserver($cnum,$cdom);
4597: my ($update,$comment) = split(/:/,&unescape(&reply('autophotochoice:'.
4598: &escape($cdom),
4599: $homeserver)));
4600: if ($update =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
4601: return (undef,undef);
4602: }
4603: return ($update,$comment);
4604: }
4605:
4606: sub auto_photoupdate {
4607: my ($affiliatesref,$dom,$cnum,$photo) = @_;
4608: my $homeserver = &homeserver($cnum,$dom);
4609: my $host=&hostname($homeserver);
4610: my $cmd = '';
4611: my $maxtries = 1;
4612: foreach my $affiliate (keys(%{$affiliatesref})) {
4613: $cmd .= $affiliate.'='.join(",",@{$$affiliatesref{$affiliate}}).'%%';
4614: }
4615: $cmd =~ s/%%$//;
4616: $cmd = &escape($cmd);
4617: my $query = 'institutionalphotos';
4618: my $queryid=&reply("querysend:".$query.':'.$dom.':'.$cnum.':'.$cmd,$homeserver);
4619: unless ($queryid=~/^\Q$host\E\_/) {
4620: &logthis('institutionalphotos: invalid queryid: '.$queryid.' for host: '.$host.' and homeserver: '.$homeserver.' and course: '.$cnum);
4621: return 'error: '.$queryid;
4622: }
4623: my $reply = &get_query_reply($queryid);
4624: my $tries = 1;
4625: while (($reply=~/^timeout/) && ($tries < $maxtries)) {
4626: $reply = &get_query_reply($queryid);
4627: $tries ++;
4628: }
4629: if ( ($reply =~/^timeout/) || ($reply =~/^error/) ) {
4630: &logthis('institutionalphotos error: '.$reply.' for '.$dom.' '.$env{'user.name'}.' for '.$queryid.' course: '.$cnum.' maxtries: '.$maxtries.' tries: '.$tries);
4631: } else {
4632: my @responses = split(/:/,$reply);
4633: my $outcome = shift(@responses);
4634: foreach my $item (@responses) {
4635: my ($key,$value) = split(/=/,$item);
4636: $$photo{$key} = $value;
4637: }
4638: return $outcome;
4639: }
4640: return 'error';
4641: }
4642:
4643: sub auto_instcode_format {
4644: my ($caller,$codedom,$instcodes,$codes,$codetitles,$cat_titles,
4645: $cat_order) = @_;
4646: my $courses = '';
4647: my @homeservers;
4648: if ($caller eq 'global') {
4649: my %servers = &get_servers($codedom,'library');
4650: foreach my $tryserver (keys(%servers)) {
4651: if (!grep(/^\Q$tryserver\E$/,@homeservers)) {
4652: push(@homeservers,$tryserver);
4653: }
4654: }
4655: } else {
4656: push(@homeservers,&homeserver($caller,$codedom));
4657: }
4658: foreach my $code (keys(%{$instcodes})) {
4659: $courses .= &escape($code).'='.&escape($$instcodes{$code}).'&';
4660: }
4661: chop($courses);
4662: my $ok_response = 0;
4663: my $response;
4664: while (@homeservers > 0 && $ok_response == 0) {
4665: my $server = shift(@homeservers);
4666: $response=&reply('autoinstcodeformat:'.$codedom.':'.$courses,$server);
4667: if ($response !~ /(con_lost|error|no_such_host|refused)/) {
4668: my ($codes_str,$codetitles_str,$cat_titles_str,$cat_order_str) =
4669: split/:/,$response;
4670: %{$codes} = (%{$codes},&str2hash($codes_str));
4671: push(@{$codetitles},&str2array($codetitles_str));
4672: %{$cat_titles} = (%{$cat_titles},&str2hash($cat_titles_str));
4673: %{$cat_order} = (%{$cat_order},&str2hash($cat_order_str));
4674: $ok_response = 1;
4675: }
4676: }
4677: if ($ok_response) {
4678: return 'ok';
4679: } else {
4680: return $response;
4681: }
4682: }
4683:
4684: sub auto_instcode_defaults {
4685: my ($domain,$returnhash,$code_order) = @_;
4686: my @homeservers;
4687:
4688: my %servers = &get_servers($domain,'library');
4689: foreach my $tryserver (keys(%servers)) {
4690: if (!grep(/^\Q$tryserver\E$/,@homeservers)) {
4691: push(@homeservers,$tryserver);
4692: }
4693: }
4694:
4695: my $response;
4696: foreach my $server (@homeservers) {
4697: $response=&reply('autoinstcodedefaults:'.$domain,$server);
4698: next if ($response =~ /(con_lost|error|no_such_host|refused)/);
4699:
4700: foreach my $pair (split(/\&/,$response)) {
4701: my ($name,$value)=split(/\=/,$pair);
4702: if ($name eq 'code_order') {
4703: @{$code_order} = split(/\&/,&unescape($value));
4704: } else {
4705: $returnhash->{&unescape($name)}=&unescape($value);
4706: }
4707: }
4708: return 'ok';
4709: }
4710:
4711: return $response;
4712: }
4713:
4714: sub auto_validate_class_sec {
4715: my ($cdom,$cnum,$owner,$inst_class) = @_;
4716: my $homeserver = &homeserver($cnum,$cdom);
4717: my $response=&reply('autovalidateclass_sec:'.$inst_class.':'.
4718: &escape($owner).':'.$cdom,$homeserver);
4719: return $response;
4720: }
4721:
4722: # ------------------------------------------------------- Course Group routines
4723:
4724: sub get_coursegroups {
4725: my ($cdom,$cnum,$group,$namespace) = @_;
4726: return(&dump($namespace,$cdom,$cnum,$group));
4727: }
4728:
4729: sub modify_coursegroup {
4730: my ($cdom,$cnum,$groupsettings) = @_;
4731: return(&put('coursegroups',$groupsettings,$cdom,$cnum));
4732: }
4733:
4734: sub toggle_coursegroup_status {
4735: my ($cdom,$cnum,$group,$action) = @_;
4736: my ($from_namespace,$to_namespace);
4737: if ($action eq 'delete') {
4738: $from_namespace = 'coursegroups';
4739: $to_namespace = 'deleted_groups';
4740: } else {
4741: $from_namespace = 'deleted_groups';
4742: $to_namespace = 'coursegroups';
4743: }
4744: my %curr_group = &get_coursegroups($cdom,$cnum,$group,$from_namespace);
4745: if (my $tmp = &error(%curr_group)) {
4746: &Apache::lonnet::logthis('Error retrieving group: '.$tmp.' in '.$cnum.':'.$cdom);
4747: return ('read error',$tmp);
4748: } else {
4749: my %savedsettings = %curr_group;
4750: my $result = &put($to_namespace,\%savedsettings,$cdom,$cnum);
4751: my $deloutcome;
4752: if ($result eq 'ok') {
4753: $deloutcome = &del($from_namespace,[$group],$cdom,$cnum);
4754: } else {
4755: return ('write error',$result);
4756: }
4757: if ($deloutcome eq 'ok') {
4758: return 'ok';
4759: } else {
4760: return ('delete error',$deloutcome);
4761: }
4762: }
4763: }
4764:
4765: sub modify_group_roles {
4766: my ($cdom,$cnum,$group_id,$user,$end,$start,$userprivs) = @_;
4767: my $url = '/'.$cdom.'/'.$cnum.'/'.$group_id;
4768: my $role = 'gr/'.&escape($userprivs);
4769: my ($uname,$udom) = split(/:/,$user);
4770: my $result = &assignrole($udom,$uname,$url,$role,$end,$start);
4771: if ($result eq 'ok') {
4772: &devalidate_getgroups_cache($udom,$uname,$cdom,$cnum);
4773: }
4774: return $result;
4775: }
4776:
4777: sub modify_coursegroup_membership {
4778: my ($cdom,$cnum,$membership) = @_;
4779: my $result = &put('groupmembership',$membership,$cdom,$cnum);
4780: return $result;
4781: }
4782:
4783: sub get_active_groups {
4784: my ($udom,$uname,$cdom,$cnum) = @_;
4785: my $now = time;
4786: my %groups = ();
4787: foreach my $key (keys(%env)) {
4788: if ($key =~ m-user\.role\.gr\./($match_domain)/($match_courseid)/(\w+)$-) {
4789: my ($start,$end) = split(/\./,$env{$key});
4790: if (($end!=0) && ($end<$now)) { next; }
4791: if (($start!=0) && ($start>$now)) { next; }
4792: if ($1 eq $cdom && $2 eq $cnum) {
4793: $groups{$3} = $env{$key} ;
4794: }
4795: }
4796: }
4797: return %groups;
4798: }
4799:
4800: sub get_group_membership {
4801: my ($cdom,$cnum,$group) = @_;
4802: return(&dump('groupmembership',$cdom,$cnum,$group));
4803: }
4804:
4805: sub get_users_groups {
4806: my ($udom,$uname,$courseid) = @_;
4807: my @usersgroups;
4808: my $cachetime=1800;
4809:
4810: my $hashid="$udom:$uname:$courseid";
4811: my ($grouplist,$cached)=&is_cached_new('getgroups',$hashid);
4812: if (defined($cached)) {
4813: @usersgroups = split(/:/,$grouplist);
4814: } else {
4815: $grouplist = '';
4816: my $courseurl = &courseid_to_courseurl($courseid);
4817: my %roleshash = &dump('roles',$udom,$uname,$courseurl);
4818: my $access_end = $env{'course.'.$courseid.
4819: '.default_enrollment_end_date'};
4820: my $now = time;
4821: foreach my $key (keys(%roleshash)) {
4822: if ($key =~ /^\Q$courseurl\E\/(\w+)\_gr$/) {
4823: my $group = $1;
4824: if ($roleshash{$key} =~ /_(\d+)_(\d+)$/) {
4825: my $start = $2;
4826: my $end = $1;
4827: if ($start == -1) { next; } # deleted from group
4828: if (($start!=0) && ($start>$now)) { next; }
4829: if (($end!=0) && ($end<$now)) {
4830: if ($access_end && $access_end < $now) {
4831: if ($access_end - $end < 86400) {
4832: push(@usersgroups,$group);
4833: }
4834: }
4835: next;
4836: }
4837: push(@usersgroups,$group);
4838: }
4839: }
4840: }
4841: @usersgroups = &sort_course_groups($courseid,@usersgroups);
4842: $grouplist = join(':',@usersgroups);
4843: &do_cache_new('getgroups',$hashid,$grouplist,$cachetime);
4844: }
4845: return @usersgroups;
4846: }
4847:
4848: sub devalidate_getgroups_cache {
4849: my ($udom,$uname,$cdom,$cnum)=@_;
4850: my $courseid = $cdom.'_'.$cnum;
4851:
4852: my $hashid="$udom:$uname:$courseid";
4853: &devalidate_cache_new('getgroups',$hashid);
4854: }
4855:
4856: # ------------------------------------------------------------------ Plain Text
4857:
4858: sub plaintext {
4859: my ($short,$type,$cid) = @_;
4860: if ($short =~ /^cr/) {
4861: return (split('/',$short))[-1];
4862: }
4863: if (!defined($cid)) {
4864: $cid = $env{'request.course.id'};
4865: }
4866: if (defined($cid) && defined($env{'course.'.$cid.'.'.$short.'.plaintext'})) {
4867: return &Apache::lonlocal::mt($env{'course.'.$cid.'.'.$short.
4868: '.plaintext'});
4869: }
4870: my %rolenames = (
4871: Course => 'std',
4872: Group => 'alt1',
4873: );
4874: if (defined($type) &&
4875: defined($rolenames{$type}) &&
4876: defined($prp{$short}{$rolenames{$type}})) {
4877: return &Apache::lonlocal::mt($prp{$short}{$rolenames{$type}});
4878: } else {
4879: return &Apache::lonlocal::mt($prp{$short}{'std'});
4880: }
4881: }
4882:
4883: # ----------------------------------------------------------------- Assign Role
4884:
4885: sub assignrole {
4886: my ($udom,$uname,$url,$role,$end,$start,$deleteflag)=@_;
4887: my $mrole;
4888: if ($role =~ /^cr\//) {
4889: my $cwosec=$url;
4890: $cwosec=~s/^\/($match_domain)\/($match_courseid)\/.*/$1\/$2/;
4891: unless (&allowed('ccr',$cwosec)) {
4892: &logthis('Refused custom assignrole: '.
4893: $udom.' '.$uname.' '.$url.' '.$role.' '.$end.' '.$start.' by '.
4894: $env{'user.name'}.' at '.$env{'user.domain'});
4895: return 'refused';
4896: }
4897: $mrole='cr';
4898: } elsif ($role =~ /^gr\//) {
4899: my $cwogrp=$url;
4900: $cwogrp=~s{^/($match_domain)/($match_courseid)/.*}{$1/$2};
4901: unless (&allowed('mdg',$cwogrp)) {
4902: &logthis('Refused group assignrole: '.
4903: $udom.' '.$uname.' '.$url.' '.$role.' '.$end.' '.$start.' by '.
4904: $env{'user.name'}.' at '.$env{'user.domain'});
4905: return 'refused';
4906: }
4907: $mrole='gr';
4908: } else {
4909: my $cwosec=$url;
4910: $cwosec=~s/^\/($match_domain)\/($match_courseid)\/.*/$1\/$2/;
4911: unless ((&allowed('c'.$role,$cwosec)) || &allowed('c'.$role,$udom)) {
4912: &logthis('Refused assignrole: '.
4913: $udom.' '.$uname.' '.$url.' '.$role.' '.$end.' '.$start.' by '.
4914: $env{'user.name'}.' at '.$env{'user.domain'});
4915: return 'refused';
4916: }
4917: $mrole=$role;
4918: }
4919: my $command="encrypt:rolesput:$env{'user.domain'}:$env{'user.name'}:".
4920: "$udom:$uname:$url".'_'."$mrole=$role";
4921: if ($end) { $command.='_'.$end; }
4922: if ($start) {
4923: if ($end) {
4924: $command.='_'.$start;
4925: } else {
4926: $command.='_0_'.$start;
4927: }
4928: }
4929: my $origstart = $start;
4930: my $origend = $end;
4931: # actually delete
4932: if ($deleteflag) {
4933: if ((&allowed('dro',$udom)) || (&allowed('dro',$url))) {
4934: # modify command to delete the role
4935: $command="encrypt:rolesdel:$env{'user.domain'}:$env{'user.name'}:".
4936: "$udom:$uname:$url".'_'."$mrole";
4937: &logthis("$env{'user.name'} at $env{'user.domain'} deletes $mrole in $url for $uname at $udom");
4938: # set start and finish to negative values for userrolelog
4939: $start=-1;
4940: $end=-1;
4941: }
4942: }
4943: # send command
4944: my $answer=&reply($command,&homeserver($uname,$udom));
4945: # log new user role if status is ok
4946: if ($answer eq 'ok') {
4947: &userrolelog($role,$uname,$udom,$url,$start,$end);
4948: # for course roles, perform group memberships changes triggered by role change.
4949: unless ($role =~ /^gr/) {
4950: &Apache::longroup::group_changes($udom,$uname,$url,$role,$origend,
4951: $origstart);
4952: }
4953: }
4954: return $answer;
4955: }
4956:
4957: # -------------------------------------------------- Modify user authentication
4958: # Overrides without validation
4959:
4960: sub modifyuserauth {
4961: my ($udom,$uname,$umode,$upass)=@_;
4962: my $uhome=&homeserver($uname,$udom);
4963: unless (&allowed('mau',$udom)) { return 'refused'; }
4964: &logthis('Call to modify user authentication '.$udom.', '.$uname.', '.
4965: $umode.' by '.$env{'user.name'}.' at '.$env{'user.domain'}.
4966: ' in domain '.$env{'request.role.domain'});
4967: my $reply=&reply('encrypt:changeuserauth:'.$udom.':'.$uname.':'.$umode.':'.
4968: &escape($upass),$uhome);
4969: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},
4970: 'Authentication changed for '.$udom.', '.$uname.', '.$umode.
4971: '(Remote '.$ENV{'REMOTE_ADDR'}.'): '.$reply);
4972: &log($udom,,$uname,$uhome,
4973: 'Authentication changed by '.$env{'user.domain'}.', '.
4974: $env{'user.name'}.', '.$umode.
4975: '(Remote '.$ENV{'REMOTE_ADDR'}.'): '.$reply);
4976: unless ($reply eq 'ok') {
4977: &logthis('Authentication mode error: '.$reply);
4978: return 'error: '.$reply;
4979: }
4980: return 'ok';
4981: }
4982:
4983: # --------------------------------------------------------------- Modify a user
4984:
4985: sub modifyuser {
4986: my ($udom, $uname, $uid,
4987: $umode, $upass, $first,
4988: $middle, $last, $gene,
4989: $forceid, $desiredhome, $email)=@_;
4990: $udom= &LONCAPA::clean_domain($udom);
4991: $uname=&LONCAPA::clean_username($uname);
4992: &logthis('Call to modify user '.$udom.', '.$uname.', '.$uid.', '.
4993: $umode.', '.$first.', '.$middle.', '.
4994: $last.', '.$gene.'(forceid: '.$forceid.')'.
4995: (defined($desiredhome) ? ' desiredhome = '.$desiredhome :
4996: ' desiredhome not specified').
4997: ' by '.$env{'user.name'}.' at '.$env{'user.domain'}.
4998: ' in domain '.$env{'request.role.domain'});
4999: my $uhome=&homeserver($uname,$udom,'true');
5000: # ----------------------------------------------------------------- Create User
5001: if (($uhome eq 'no_host') &&
5002: (($umode && $upass) || ($umode eq 'localauth'))) {
5003: my $unhome='';
5004: if (defined($desiredhome) && &host_domain($desiredhome) eq $udom) {
5005: $unhome = $desiredhome;
5006: } elsif($env{'course.'.$env{'request.course.id'}.'.domain'} eq $udom) {
5007: $unhome=$env{'course.'.$env{'request.course.id'}.'.home'};
5008: } else { # load balancing routine for determining $unhome
5009: my $loadm=10000000;
5010: my %servers = &get_servers($udom,'library');
5011: foreach my $tryserver (keys(%servers)) {
5012: my $answer=reply('load',$tryserver);
5013: if (($answer=~/\d+/) && ($answer<$loadm)) {
5014: $loadm=$answer;
5015: $unhome=$tryserver;
5016: }
5017: }
5018: }
5019: if (($unhome eq '') || ($unhome eq 'no_host')) {
5020: return 'error: unable to find a home server for '.$uname.
5021: ' in domain '.$udom;
5022: }
5023: my $reply=&reply('encrypt:makeuser:'.$udom.':'.$uname.':'.$umode.':'.
5024: &escape($upass),$unhome);
5025: unless ($reply eq 'ok') {
5026: return 'error: '.$reply;
5027: }
5028: $uhome=&homeserver($uname,$udom,'true');
5029: if (($uhome eq '') || ($uhome eq 'no_host') || ($uhome ne $unhome)) {
5030: return 'error: unable verify users home machine.';
5031: }
5032: } # End of creation of new user
5033: # ---------------------------------------------------------------------- Add ID
5034: if ($uid) {
5035: $uid=~tr/A-Z/a-z/;
5036: my %uidhash=&idrget($udom,$uname);
5037: if (($uidhash{$uname}) && ($uidhash{$uname}!~/error\:/)
5038: && (!$forceid)) {
5039: unless ($uid eq $uidhash{$uname}) {
5040: return 'error: user id "'.$uid.'" does not match '.
5041: 'current user id "'.$uidhash{$uname}.'".';
5042: }
5043: } else {
5044: &idput($udom,($uname => $uid));
5045: }
5046: }
5047: # -------------------------------------------------------------- Add names, etc
5048: my @tmp=&get('environment',
5049: ['firstname','middlename','lastname','generation'],
5050: $udom,$uname);
5051: my %names;
5052: if ($tmp[0] =~ m/^error:.*/) {
5053: %names=();
5054: } else {
5055: %names = @tmp;
5056: }
5057: #
5058: # Make sure to not trash student environment if instructor does not bother
5059: # to supply name and email information
5060: #
5061: if ($first) { $names{'firstname'} = $first; }
5062: if (defined($middle)) { $names{'middlename'} = $middle; }
5063: if ($last) { $names{'lastname'} = $last; }
5064: if (defined($gene)) { $names{'generation'} = $gene; }
5065: if ($email) {
5066: $email=~s/[^\w\@\.\-\,]//gs;
5067: if ($email=~/\@/) { $names{'notification'} = $email;
5068: $names{'critnotification'} = $email;
5069: $names{'permanentemail'} = $email; }
5070: }
5071: my $reply = &put('environment', \%names, $udom,$uname);
5072: if ($reply ne 'ok') { return 'error: '.$reply; }
5073: &devalidate_cache_new('namescache',$uname.':'.$udom);
5074: &logthis('Success modifying user '.$udom.', '.$uname.', '.$uid.', '.
5075: $umode.', '.$first.', '.$middle.', '.
5076: $last.', '.$gene.' by '.
5077: $env{'user.name'}.' at '.$env{'user.domain'});
5078: return 'ok';
5079: }
5080:
5081: # -------------------------------------------------------------- Modify student
5082:
5083: sub modifystudent {
5084: my ($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene,$usec,
5085: $end,$start,$forceid,$desiredhome,$email,$type,$locktype,$cid)=@_;
5086: if (!$cid) {
5087: unless ($cid=$env{'request.course.id'}) {
5088: return 'not_in_class';
5089: }
5090: }
5091: # --------------------------------------------------------------- Make the user
5092: my $reply=&modifyuser
5093: ($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene,$forceid,
5094: $desiredhome,$email);
5095: unless ($reply eq 'ok') { return $reply; }
5096: # This will cause &modify_student_enrollment to get the uid from the
5097: # students environment
5098: $uid = undef if (!$forceid);
5099: $reply = &modify_student_enrollment($udom,$uname,$uid,$first,$middle,$last,
5100: $gene,$usec,$end,$start,$type,$locktype,$cid);
5101: return $reply;
5102: }
5103:
5104: sub modify_student_enrollment {
5105: my ($udom,$uname,$uid,$first,$middle,$last,$gene,$usec,$end,$start,$type,$locktype,$cid) = @_;
5106: my ($cdom,$cnum,$chome);
5107: if (!$cid) {
5108: unless ($cid=$env{'request.course.id'}) {
5109: return 'not_in_class';
5110: }
5111: $cdom=$env{'course.'.$cid.'.domain'};
5112: $cnum=$env{'course.'.$cid.'.num'};
5113: } else {
5114: ($cdom,$cnum)=split(/_/,$cid);
5115: }
5116: $chome=$env{'course.'.$cid.'.home'};
5117: if (!$chome) {
5118: $chome=&homeserver($cnum,$cdom);
5119: }
5120: if (!$chome) { return 'unknown_course'; }
5121: # Make sure the user exists
5122: my $uhome=&homeserver($uname,$udom);
5123: if (($uhome eq '') || ($uhome eq 'no_host')) {
5124: return 'error: no such user';
5125: }
5126: # Get student data if we were not given enough information
5127: if (!defined($first) || $first eq '' ||
5128: !defined($last) || $last eq '' ||
5129: !defined($uid) || $uid eq '' ||
5130: !defined($middle) || $middle eq '' ||
5131: !defined($gene) || $gene eq '') {
5132: # They did not supply us with enough data to enroll the student, so
5133: # we need to pick up more information.
5134: my %tmp = &get('environment',
5135: ['firstname','middlename','lastname', 'generation','id']
5136: ,$udom,$uname);
5137:
5138: #foreach my $key (keys(%tmp)) {
5139: # &logthis("key $key = ".$tmp{$key});
5140: #}
5141: $first = $tmp{'firstname'} if (!defined($first) || $first eq '');
5142: $middle = $tmp{'middlename'} if (!defined($middle) || $middle eq '');
5143: $last = $tmp{'lastname'} if (!defined($last) || $last eq '');
5144: $gene = $tmp{'generation'} if (!defined($gene) || $gene eq '');
5145: $uid = $tmp{'id'} if (!defined($uid) || $uid eq '');
5146: }
5147: my $fullname = &format_name($first,$middle,$last,$gene,'lastname');
5148: my $reply=cput('classlist',
5149: {"$uname:$udom" =>
5150: join(':',$end,$start,$uid,$usec,$fullname,$type,$locktype) },
5151: $cdom,$cnum);
5152: unless (($reply eq 'ok') || ($reply eq 'delayed')) {
5153: return 'error: '.$reply;
5154: } else {
5155: &devalidate_getsection_cache($udom,$uname,$cid);
5156: }
5157: # Add student role to user
5158: my $uurl='/'.$cid;
5159: $uurl=~s/\_/\//g;
5160: if ($usec) {
5161: $uurl.='/'.$usec;
5162: }
5163: return &assignrole($udom,$uname,$uurl,'st',$end,$start);
5164: }
5165:
5166: sub format_name {
5167: my ($firstname,$middlename,$lastname,$generation,$first)=@_;
5168: my $name;
5169: if ($first ne 'lastname') {
5170: $name=$firstname.' '.$middlename.' '.$lastname.' '.$generation;
5171: } else {
5172: if ($lastname=~/\S/) {
5173: $name.= $lastname.' '.$generation.', '.$firstname.' '.$middlename;
5174: $name=~s/\s+,/,/;
5175: } else {
5176: $name.= $firstname.' '.$middlename.' '.$generation;
5177: }
5178: }
5179: $name=~s/^\s+//;
5180: $name=~s/\s+$//;
5181: $name=~s/\s+/ /g;
5182: return $name;
5183: }
5184:
5185: # ------------------------------------------------- Write to course preferences
5186:
5187: sub writecoursepref {
5188: my ($courseid,%prefs)=@_;
5189: $courseid=~s/^\///;
5190: $courseid=~s/\_/\//g;
5191: my ($cdomain,$cnum)=split(/\//,$courseid);
5192: my $chome=homeserver($cnum,$cdomain);
5193: if (($chome eq '') || ($chome eq 'no_host')) {
5194: return 'error: no such course';
5195: }
5196: my $cstring='';
5197: foreach my $pref (keys(%prefs)) {
5198: $cstring.=&escape($pref).'='.&escape($prefs{$pref}).'&';
5199: }
5200: $cstring=~s/\&$//;
5201: return reply('put:'.$cdomain.':'.$cnum.':environment:'.$cstring,$chome);
5202: }
5203:
5204: # ---------------------------------------------------------- Make/modify course
5205:
5206: sub createcourse {
5207: my ($udom,$description,$url,$course_server,$nonstandard,$inst_code,
5208: $course_owner,$crstype)=@_;
5209: $url=&declutter($url);
5210: my $cid='';
5211: unless (&allowed('ccc',$udom)) {
5212: return 'refused';
5213: }
5214: # ------------------------------------------------------------------- Create ID
5215: my $uname=int(1+rand(9)).
5216: ('a'..'z','A'..'Z','0'..'9')[int(rand(62))].
5217: substr($$.time,0,5).unpack("H8",pack("I32",time)).
5218: unpack("H2",pack("I32",int(rand(255)))).$perlvar{'lonHostID'};
5219: # ----------------------------------------------- Make sure that does not exist
5220: my $uhome=&homeserver($uname,$udom,'true');
5221: unless (($uhome eq '') || ($uhome eq 'no_host')) {
5222: $uname=substr($$.time,0,5).unpack("H8",pack("I32",time)).
5223: unpack("H2",pack("I32",int(rand(255)))).$perlvar{'lonHostID'};
5224: $uhome=&homeserver($uname,$udom,'true');
5225: unless (($uhome eq '') || ($uhome eq 'no_host')) {
5226: return 'error: unable to generate unique course-ID';
5227: }
5228: }
5229: # ------------------------------------------------ Check supplied server name
5230: $course_server = $env{'user.homeserver'} if (! defined($course_server));
5231: if (! &is_library($course_server)) {
5232: return 'error:bad server name '.$course_server;
5233: }
5234: # ------------------------------------------------------------- Make the course
5235: my $reply=&reply('encrypt:makeuser:'.$udom.':'.$uname.':none::',
5236: $course_server);
5237: unless ($reply eq 'ok') { return 'error: '.$reply; }
5238: $uhome=&homeserver($uname,$udom,'true');
5239: if (($uhome eq '') || ($uhome eq 'no_host')) {
5240: return 'error: no such course';
5241: }
5242: # ----------------------------------------------------------------- Course made
5243: # log existence
5244: &courseidput($udom,&escape($udom.'_'.$uname).'='.&escape($description).
5245: ':'.&escape($inst_code).':'.&escape($course_owner).':'.
5246: &escape($crstype),$uhome);
5247: &flushcourselogs();
5248: # set toplevel url
5249: my $topurl=$url;
5250: unless ($nonstandard) {
5251: # ------------------------------------------ For standard courses, make top url
5252: my $mapurl=&clutter($url);
5253: if ($mapurl eq '/res/') { $mapurl=''; }
5254: $env{'form.initmap'}=(<<ENDINITMAP);
5255: <map>
5256: <resource id="1" type="start"></resource>
5257: <resource id="2" src="$mapurl"></resource>
5258: <resource id="3" type="finish"></resource>
5259: <link index="1" from="1" to="2"></link>
5260: <link index="2" from="2" to="3"></link>
5261: </map>
5262: ENDINITMAP
5263: $topurl=&declutter(
5264: &finishuserfileupload($uname,$udom,'initmap','default.sequence')
5265: );
5266: }
5267: # ----------------------------------------------------------- Write preferences
5268: &writecoursepref($udom.'_'.$uname,
5269: ('description' => $description,
5270: 'url' => $topurl));
5271: return '/'.$udom.'/'.$uname;
5272: }
5273:
5274: sub is_course {
5275: my ($cdom,$cnum) = @_;
5276: my %courses = &courseiddump($cdom,'.',1,'.','.',$cnum,undef,
5277: undef,'.');
5278: if (exists($courses{$cdom.'_'.$cnum})) {
5279: return 1;
5280: }
5281: return 0;
5282: }
5283:
5284: # ---------------------------------------------------------- Assign Custom Role
5285:
5286: sub assigncustomrole {
5287: my ($udom,$uname,$url,$rdom,$rnam,$rolename,$end,$start,$deleteflag)=@_;
5288: return &assignrole($udom,$uname,$url,'cr/'.$rdom.'/'.$rnam.'/'.$rolename,
5289: $end,$start,$deleteflag);
5290: }
5291:
5292: # ----------------------------------------------------------------- Revoke Role
5293:
5294: sub revokerole {
5295: my ($udom,$uname,$url,$role,$deleteflag)=@_;
5296: my $now=time;
5297: return &assignrole($udom,$uname,$url,$role,$now,$deleteflag);
5298: }
5299:
5300: # ---------------------------------------------------------- Revoke Custom Role
5301:
5302: sub revokecustomrole {
5303: my ($udom,$uname,$url,$rdom,$rnam,$rolename,$deleteflag)=@_;
5304: my $now=time;
5305: return &assigncustomrole($udom,$uname,$url,$rdom,$rnam,$rolename,$now,
5306: $deleteflag);
5307: }
5308:
5309: # ------------------------------------------------------------ Disk usage
5310: sub diskusage {
5311: my ($udom,$uname,$directoryRoot)=@_;
5312: $directoryRoot =~ s/\/$//;
5313: my $listing=&reply('du:'.$directoryRoot,homeserver($uname,$udom));
5314: return $listing;
5315: }
5316:
5317: sub is_locked {
5318: my ($file_name, $domain, $user) = @_;
5319: my @check;
5320: my $is_locked;
5321: push @check, $file_name;
5322: my %locked = &get('file_permissions',\@check,
5323: $env{'user.domain'},$env{'user.name'});
5324: my ($tmp)=keys(%locked);
5325: if ($tmp=~/^error:/) { undef(%locked); }
5326:
5327: if (ref($locked{$file_name}) eq 'ARRAY') {
5328: $is_locked = 'false';
5329: foreach my $entry (@{$locked{$file_name}}) {
5330: if (ref($entry) eq 'ARRAY') {
5331: $is_locked = 'true';
5332: last;
5333: }
5334: }
5335: } else {
5336: $is_locked = 'false';
5337: }
5338: }
5339:
5340: sub declutter_portfile {
5341: my ($file) = @_;
5342: $file =~ s{^(/portfolio/|portfolio/)}{/};
5343: return $file;
5344: }
5345:
5346: # ------------------------------------------------------------- Mark as Read Only
5347:
5348: sub mark_as_readonly {
5349: my ($domain,$user,$files,$what) = @_;
5350: my %current_permissions = &dump('file_permissions',$domain,$user);
5351: my ($tmp)=keys(%current_permissions);
5352: if ($tmp=~/^error:/) { undef(%current_permissions); }
5353: foreach my $file (@{$files}) {
5354: $file = &declutter_portfile($file);
5355: push(@{$current_permissions{$file}},$what);
5356: }
5357: &put('file_permissions',\%current_permissions,$domain,$user);
5358: return;
5359: }
5360:
5361: # ------------------------------------------------------------Save Selected Files
5362:
5363: sub save_selected_files {
5364: my ($user, $path, @files) = @_;
5365: my $filename = $user."savedfiles";
5366: my @other_files = &files_not_in_path($user, $path);
5367: open (OUT, '>'.$tmpdir.$filename);
5368: foreach my $file (@files) {
5369: print (OUT $env{'form.currentpath'}.$file."\n");
5370: }
5371: foreach my $file (@other_files) {
5372: print (OUT $file."\n");
5373: }
5374: close (OUT);
5375: return 'ok';
5376: }
5377:
5378: sub clear_selected_files {
5379: my ($user) = @_;
5380: my $filename = $user."savedfiles";
5381: open (OUT, '>'.$Apache::lonnet::perlvar{'lonDaemons'}.'/tmp/'.$filename);
5382: print (OUT undef);
5383: close (OUT);
5384: return ("ok");
5385: }
5386:
5387: sub files_in_path {
5388: my ($user, $path) = @_;
5389: my $filename = $user."savedfiles";
5390: my %return_files;
5391: open (IN, '<'.$Apache::lonnet::perlvar{'lonDaemons'}.'/tmp/'.$filename);
5392: while (my $line_in = <IN>) {
5393: chomp ($line_in);
5394: my @paths_and_file = split (m!/!, $line_in);
5395: my $file_part = pop (@paths_and_file);
5396: my $path_part = join ('/', @paths_and_file);
5397: $path_part.='/';
5398: my $path_and_file = $path_part.$file_part;
5399: if ($path_part eq $path) {
5400: $return_files{$file_part}= 'selected';
5401: }
5402: }
5403: close (IN);
5404: return (\%return_files);
5405: }
5406:
5407: # called in portfolio select mode, to show files selected NOT in current directory
5408: sub files_not_in_path {
5409: my ($user, $path) = @_;
5410: my $filename = $user."savedfiles";
5411: my @return_files;
5412: my $path_part;
5413: open(IN, '<'.$Apache::lonnet::perlvar{'lonDaemons'}.'/tmp/'.$filename);
5414: while (my $line = <IN>) {
5415: #ok, I know it's clunky, but I want it to work
5416: my @paths_and_file = split(m|/|, $line);
5417: my $file_part = pop(@paths_and_file);
5418: chomp($file_part);
5419: my $path_part = join('/', @paths_and_file);
5420: $path_part .= '/';
5421: my $path_and_file = $path_part.$file_part;
5422: if ($path_part ne $path) {
5423: push(@return_files, ($path_and_file));
5424: }
5425: }
5426: close(OUT);
5427: return (@return_files);
5428: }
5429:
5430: #----------------------------------------------Get portfolio file permissions
5431:
5432: sub get_portfile_permissions {
5433: my ($domain,$user) = @_;
5434: my %current_permissions = &dump('file_permissions',$domain,$user);
5435: my ($tmp)=keys(%current_permissions);
5436: if ($tmp=~/^error:/) { undef(%current_permissions); }
5437: return \%current_permissions;
5438: }
5439:
5440: #---------------------------------------------Get portfolio file access controls
5441:
5442: sub get_access_controls {
5443: my ($current_permissions,$group,$file) = @_;
5444: my %access;
5445: my $real_file = $file;
5446: $file =~ s/\.meta$//;
5447: if (defined($file)) {
5448: if (ref($$current_permissions{$file."\0".'accesscontrol'}) eq 'HASH') {
5449: foreach my $control (keys(%{$$current_permissions{$file."\0".'accesscontrol'}})) {
5450: $access{$real_file}{$control} = $$current_permissions{$file."\0".$control};
5451: }
5452: }
5453: } else {
5454: foreach my $key (keys(%{$current_permissions})) {
5455: if ($key =~ /\0accesscontrol$/) {
5456: if (defined($group)) {
5457: if ($key !~ m-^\Q$group\E/-) {
5458: next;
5459: }
5460: }
5461: my ($fullpath) = split(/\0/,$key);
5462: if (ref($$current_permissions{$key}) eq 'HASH') {
5463: foreach my $control (keys(%{$$current_permissions{$key}})) {
5464: $access{$fullpath}{$control}=$$current_permissions{$fullpath."\0".$control};
5465: }
5466: }
5467: }
5468: }
5469: }
5470: return %access;
5471: }
5472:
5473: sub modify_access_controls {
5474: my ($file_name,$changes,$domain,$user)=@_;
5475: my ($outcome,$deloutcome);
5476: my %store_permissions;
5477: my %new_values;
5478: my %new_control;
5479: my %translation;
5480: my @deletions = ();
5481: my $now = time;
5482: if (exists($$changes{'activate'})) {
5483: if (ref($$changes{'activate'}) eq 'HASH') {
5484: my @newitems = sort(keys(%{$$changes{'activate'}}));
5485: my $numnew = scalar(@newitems);
5486: for (my $i=0; $i<$numnew; $i++) {
5487: my $newkey = $newitems[$i];
5488: my $newid = &Apache::loncommon::get_cgi_id();
5489: if ($newkey =~ /^\d+:/) {
5490: $newkey =~ s/^(\d+)/$newid/;
5491: $translation{$1} = $newid;
5492: } elsif ($newkey =~ /^\d+_\d+_\d+:/) {
5493: $newkey =~ s/^(\d+_\d+_\d+)/$newid/;
5494: $translation{$1} = $newid;
5495: }
5496: $new_values{$file_name."\0".$newkey} =
5497: $$changes{'activate'}{$newitems[$i]};
5498: $new_control{$newkey} = $now;
5499: }
5500: }
5501: }
5502: my %todelete;
5503: my %changed_items;
5504: foreach my $action ('delete','update') {
5505: if (exists($$changes{$action})) {
5506: if (ref($$changes{$action}) eq 'HASH') {
5507: foreach my $key (keys(%{$$changes{$action}})) {
5508: my ($itemnum) = ($key =~ /^([^:]+):/);
5509: if ($action eq 'delete') {
5510: $todelete{$itemnum} = 1;
5511: } else {
5512: $changed_items{$itemnum} = $key;
5513: }
5514: }
5515: }
5516: }
5517: }
5518: # get lock on access controls for file.
5519: my $lockhash = {
5520: $file_name."\0".'locked_access_records' => $env{'user.name'}.
5521: ':'.$env{'user.domain'},
5522: };
5523: my $tries = 0;
5524: my $gotlock = &newput('file_permissions',$lockhash,$domain,$user);
5525:
5526: while (($gotlock ne 'ok') && $tries <3) {
5527: $tries ++;
5528: sleep 1;
5529: $gotlock = &newput('file_permissions',$lockhash,$domain,$user);
5530: }
5531: if ($gotlock eq 'ok') {
5532: my %curr_permissions = &dump('file_permissions',$domain,$user,$file_name);
5533: my ($tmp)=keys(%curr_permissions);
5534: if ($tmp=~/^error:/) { undef(%curr_permissions); }
5535: if (exists($curr_permissions{$file_name."\0".'accesscontrol'})) {
5536: my $curr_controls = $curr_permissions{$file_name."\0".'accesscontrol'};
5537: if (ref($curr_controls) eq 'HASH') {
5538: foreach my $control_item (keys(%{$curr_controls})) {
5539: my ($itemnum) = ($control_item =~ /^([^:]+):/);
5540: if (defined($todelete{$itemnum})) {
5541: push(@deletions,$file_name."\0".$control_item);
5542: } else {
5543: if (defined($changed_items{$itemnum})) {
5544: $new_control{$changed_items{$itemnum}} = $now;
5545: push(@deletions,$file_name."\0".$control_item);
5546: $new_values{$file_name."\0".$changed_items{$itemnum}} = $$changes{'update'}{$changed_items{$itemnum}};
5547: } else {
5548: $new_control{$control_item} = $$curr_controls{$control_item};
5549: }
5550: }
5551: }
5552: }
5553: }
5554: $deloutcome = &del('file_permissions',\@deletions,$domain,$user);
5555: $new_values{$file_name."\0".'accesscontrol'} = \%new_control;
5556: $outcome = &put('file_permissions',\%new_values,$domain,$user);
5557: # remove lock
5558: my @del_lock = ($file_name."\0".'locked_access_records');
5559: my $dellockoutcome = &del('file_permissions',\@del_lock,$domain,$user);
5560: my ($file,$group);
5561: if (&is_course($domain,$user)) {
5562: ($group,$file) = split(/\//,$file_name,2);
5563: } else {
5564: $file = $file_name;
5565: }
5566: my $sqlresult =
5567: &update_portfolio_table($user,$domain,$file,'portfolio_access',
5568: $group);
5569: } else {
5570: $outcome = "error: could not obtain lockfile\n";
5571: }
5572: return ($outcome,$deloutcome,\%new_values,\%translation);
5573: }
5574:
5575: sub make_public_indefinitely {
5576: my ($requrl) = @_;
5577: my $now = time;
5578: my $action = 'activate';
5579: my $aclnum = 0;
5580: if (&is_portfolio_url($requrl)) {
5581: my (undef,$udom,$unum,$file_name,$group) =
5582: &parse_portfolio_url($requrl);
5583: my $current_perms = &get_portfile_permissions($udom,$unum);
5584: my %access_controls = &get_access_controls($current_perms,
5585: $group,$file_name);
5586: foreach my $key (keys(%{$access_controls{$file_name}})) {
5587: my ($num,$scope,$end,$start) =
5588: ($key =~ /^([^:]+):([a-z]+)_(\d*)_?(\d*)$/);
5589: if ($scope eq 'public') {
5590: if ($start <= $now && $end == 0) {
5591: $action = 'none';
5592: } else {
5593: $action = 'update';
5594: $aclnum = $num;
5595: }
5596: last;
5597: }
5598: }
5599: if ($action eq 'none') {
5600: return 'ok';
5601: } else {
5602: my %changes;
5603: my $newend = 0;
5604: my $newstart = $now;
5605: my $newkey = $aclnum.':public_'.$newend.'_'.$newstart;
5606: $changes{$action}{$newkey} = {
5607: type => 'public',
5608: time => {
5609: start => $newstart,
5610: end => $newend,
5611: },
5612: };
5613: my ($outcome,$deloutcome,$new_values,$translation) =
5614: &modify_access_controls($file_name,\%changes,$udom,$unum);
5615: return $outcome;
5616: }
5617: } else {
5618: return 'invalid';
5619: }
5620: }
5621:
5622: #------------------------------------------------------Get Marked as Read Only
5623:
5624: sub get_marked_as_readonly {
5625: my ($domain,$user,$what,$group) = @_;
5626: my $current_permissions = &get_portfile_permissions($domain,$user);
5627: my @readonly_files;
5628: my $cmp1=$what;
5629: if (ref($what)) { $cmp1=join('',@{$what}) };
5630: while (my ($file_name,$value) = each(%{$current_permissions})) {
5631: if (defined($group)) {
5632: if ($file_name !~ m-^\Q$group\E/-) {
5633: next;
5634: }
5635: }
5636: if (ref($value) eq "ARRAY"){
5637: foreach my $stored_what (@{$value}) {
5638: my $cmp2=$stored_what;
5639: if (ref($stored_what) eq 'ARRAY') {
5640: $cmp2=join('',@{$stored_what});
5641: }
5642: if ($cmp1 eq $cmp2) {
5643: push(@readonly_files, $file_name);
5644: last;
5645: } elsif (!defined($what)) {
5646: push(@readonly_files, $file_name);
5647: last;
5648: }
5649: }
5650: }
5651: }
5652: return @readonly_files;
5653: }
5654: #-----------------------------------------------------------Get Marked as Read Only Hash
5655:
5656: sub get_marked_as_readonly_hash {
5657: my ($current_permissions,$group,$what) = @_;
5658: my %readonly_files;
5659: while (my ($file_name,$value) = each(%{$current_permissions})) {
5660: if (defined($group)) {
5661: if ($file_name !~ m-^\Q$group\E/-) {
5662: next;
5663: }
5664: }
5665: if (ref($value) eq "ARRAY"){
5666: foreach my $stored_what (@{$value}) {
5667: if (ref($stored_what) eq 'ARRAY') {
5668: foreach my $lock_descriptor(@{$stored_what}) {
5669: if ($lock_descriptor eq 'graded') {
5670: $readonly_files{$file_name} = 'graded';
5671: } elsif ($lock_descriptor eq 'handback') {
5672: $readonly_files{$file_name} = 'handback';
5673: } else {
5674: if (!exists($readonly_files{$file_name})) {
5675: $readonly_files{$file_name} = 'locked';
5676: }
5677: }
5678: }
5679: }
5680: }
5681: }
5682: }
5683: return %readonly_files;
5684: }
5685: # ------------------------------------------------------------ Unmark as Read Only
5686:
5687: sub unmark_as_readonly {
5688: # unmarks $file_name (if $file_name is defined), or all files locked by $what
5689: # for portfolio submissions, $what contains [$symb,$crsid]
5690: my ($domain,$user,$what,$file_name,$group) = @_;
5691: $file_name = &declutter_portfile($file_name);
5692: my $symb_crs = $what;
5693: if (ref($what)) { $symb_crs=join('',@$what); }
5694: my %current_permissions = &dump('file_permissions',$domain,$user,$group);
5695: my ($tmp)=keys(%current_permissions);
5696: if ($tmp=~/^error:/) { undef(%current_permissions); }
5697: my @readonly_files = &get_marked_as_readonly($domain,$user,$what,$group);
5698: foreach my $file (@readonly_files) {
5699: my $clean_file = &declutter_portfile($file);
5700: if (defined($file_name) && ($file_name ne $clean_file)) { next; }
5701: my $current_locks = $current_permissions{$file};
5702: my @new_locks;
5703: my @del_keys;
5704: if (ref($current_locks) eq "ARRAY"){
5705: foreach my $locker (@{$current_locks}) {
5706: my $compare=$locker;
5707: if (ref($locker) eq 'ARRAY') {
5708: $compare=join('',@{$locker});
5709: if ($compare ne $symb_crs) {
5710: push(@new_locks, $locker);
5711: }
5712: }
5713: }
5714: if (scalar(@new_locks) > 0) {
5715: $current_permissions{$file} = \@new_locks;
5716: } else {
5717: push(@del_keys, $file);
5718: &del('file_permissions',\@del_keys, $domain, $user);
5719: delete($current_permissions{$file});
5720: }
5721: }
5722: }
5723: &put('file_permissions',\%current_permissions,$domain,$user);
5724: return;
5725: }
5726:
5727: # ------------------------------------------------------------ Directory lister
5728:
5729: sub dirlist {
5730: my ($uri,$userdomain,$username,$alternateDirectoryRoot)=@_;
5731:
5732: $uri=~s/^\///;
5733: $uri=~s/\/$//;
5734: my ($udom, $uname);
5735: (undef,$udom,$uname)=split(/\//,$uri);
5736: if(defined($userdomain)) {
5737: $udom = $userdomain;
5738: }
5739: if(defined($username)) {
5740: $uname = $username;
5741: }
5742:
5743: my $dirRoot = $perlvar{'lonDocRoot'};
5744: if(defined($alternateDirectoryRoot)) {
5745: $dirRoot = $alternateDirectoryRoot;
5746: $dirRoot =~ s/\/$//;
5747: }
5748:
5749: if($udom) {
5750: if($uname) {
5751: my $listing = &reply('ls2:'.$dirRoot.'/'.$uri,
5752: &homeserver($uname,$udom));
5753: my @listing_results;
5754: if ($listing eq 'unknown_cmd') {
5755: $listing = &reply('ls:'.$dirRoot.'/'.$uri,
5756: &homeserver($uname,$udom));
5757: @listing_results = split(/:/,$listing);
5758: } else {
5759: @listing_results = map { &unescape($_); } split(/:/,$listing);
5760: }
5761: return @listing_results;
5762: } elsif(!defined($alternateDirectoryRoot)) {
5763: my %allusers;
5764: my %servers = &get_servers($udom,'library');
5765: foreach my $tryserver (keys(%servers)) {
5766: my $listing = &reply('ls2:'.$perlvar{'lonDocRoot'}.'/res/'.
5767: $udom, $tryserver);
5768: my @listing_results;
5769: if ($listing eq 'unknown_cmd') {
5770: $listing = &reply('ls:'.$perlvar{'lonDocRoot'}.'/res/'.
5771: $udom, $tryserver);
5772: @listing_results = split(/:/,$listing);
5773: } else {
5774: @listing_results =
5775: map { &unescape($_); } split(/:/,$listing);
5776: }
5777: if ($listing_results[0] ne 'no_such_dir' &&
5778: $listing_results[0] ne 'empty' &&
5779: $listing_results[0] ne 'con_lost') {
5780: foreach my $line (@listing_results) {
5781: my ($entry) = split(/&/,$line,2);
5782: $allusers{$entry} = 1;
5783: }
5784: }
5785: }
5786: my $alluserstr='';
5787: foreach my $user (sort(keys(%allusers))) {
5788: $alluserstr.=$user.'&user:';
5789: }
5790: $alluserstr=~s/:$//;
5791: return split(/:/,$alluserstr);
5792: } else {
5793: return ('missing user name');
5794: }
5795: } elsif(!defined($alternateDirectoryRoot)) {
5796: my @all_domains = sort(&all_domains());
5797: foreach my $domain (@all_domains) {
5798: $domain = $perlvar{'lonDocRoot'}.'/res/'.$domain.'/&domain';
5799: }
5800: return @all_domains;
5801: } else {
5802: return ('missing domain');
5803: }
5804: }
5805:
5806: # --------------------------------------------- GetFileTimestamp
5807: # This function utilizes dirlist and returns the date stamp for
5808: # when it was last modified. It will also return an error of -1
5809: # if an error occurs
5810:
5811: ##
5812: ## FIXME: This subroutine assumes its caller knows something about the
5813: ## directory structure of the home server for the student ($root).
5814: ## Not a good assumption to make. Since this is for looking up files
5815: ## in user directories, the full path should be constructed by lond, not
5816: ## whatever machine we request data from.
5817: ##
5818: sub GetFileTimestamp {
5819: my ($studentDomain,$studentName,$filename,$root)=@_;
5820: $studentDomain = &LONCAPA::clean_domain($studentDomain);
5821: $studentName = &LONCAPA::clean_username($studentName);
5822: my $subdir=$studentName.'__';
5823: $subdir =~ s/(.)(.)(.).*/$1\/$2\/$3/;
5824: my $proname="$studentDomain/$subdir/$studentName";
5825: $proname .= '/'.$filename;
5826: my ($fileStat) = &Apache::lonnet::dirlist($proname, $studentDomain,
5827: $studentName, $root);
5828: my @stats = split('&', $fileStat);
5829: if($stats[0] ne 'empty' && $stats[0] ne 'no_such_dir') {
5830: # @stats contains first the filename, then the stat output
5831: return $stats[10]; # so this is 10 instead of 9.
5832: } else {
5833: return -1;
5834: }
5835: }
5836:
5837: sub stat_file {
5838: my ($uri) = @_;
5839: $uri = &clutter_with_no_wrapper($uri);
5840:
5841: my ($udom,$uname,$file,$dir);
5842: if ($uri =~ m-^/(uploaded|editupload)/-) {
5843: ($udom,$uname,$file) =
5844: ($uri =~ m-/(?:uploaded|editupload)/?($match_domain)/?($match_name)/?(.*)-);
5845: $file = 'userfiles/'.$file;
5846: $dir = &propath($udom,$uname);
5847: }
5848: if ($uri =~ m-^/res/-) {
5849: ($udom,$uname) =
5850: ($uri =~ m-/(?:res)/?($match_domain)/?($match_username)/-);
5851: $file = $uri;
5852: }
5853:
5854: if (!$udom || !$uname || !$file) {
5855: # unable to handle the uri
5856: return ();
5857: }
5858:
5859: my ($result) = &dirlist($file,$udom,$uname,$dir);
5860: my @stats = split('&', $result);
5861:
5862: if($stats[0] ne 'empty' && $stats[0] ne 'no_such_dir') {
5863: shift(@stats); #filename is first
5864: return @stats;
5865: }
5866: return ();
5867: }
5868:
5869: # -------------------------------------------------------- Value of a Condition
5870:
5871: # gets the value of a specific preevaluated condition
5872: # stored in the string $env{user.state.<cid>}
5873: # or looks up a condition reference in the bighash and if if hasn't
5874: # already been evaluated recurses into docondval to get the value of
5875: # the condition, then memoizing it to
5876: # $env{user.state.<cid>.<condition>}
5877: sub directcondval {
5878: my $number=shift;
5879: if (!defined($env{'user.state.'.$env{'request.course.id'}})) {
5880: &Apache::lonuserstate::evalstate();
5881: }
5882: if (exists($env{'user.state.'.$env{'request.course.id'}.".$number"})) {
5883: return $env{'user.state.'.$env{'request.course.id'}.".$number"};
5884: } elsif ($number =~ /^_/) {
5885: my $sub_condition;
5886: if (tie(my %bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
5887: &GDBM_READER(),0640)) {
5888: $sub_condition=$bighash{'conditions'.$number};
5889: untie(%bighash);
5890: }
5891: my $value = &docondval($sub_condition);
5892: &appenv('user.state.'.$env{'request.course.id'}.".$number" => $value);
5893: return $value;
5894: }
5895: if ($env{'user.state.'.$env{'request.course.id'}}) {
5896: return substr($env{'user.state.'.$env{'request.course.id'}},$number,1);
5897: } else {
5898: return 2;
5899: }
5900: }
5901:
5902: # get the collection of conditions for this resource
5903: sub condval {
5904: my $condidx=shift;
5905: my $allpathcond='';
5906: foreach my $cond (split(/\|/,$condidx)) {
5907: if (defined($env{'acc.cond.'.$env{'request.course.id'}.'.'.$cond})) {
5908: $allpathcond.=
5909: '('.$env{'acc.cond.'.$env{'request.course.id'}.'.'.$cond}.')|';
5910: }
5911: }
5912: $allpathcond=~s/\|$//;
5913: return &docondval($allpathcond);
5914: }
5915:
5916: #evaluates an expression of conditions
5917: sub docondval {
5918: my ($allpathcond) = @_;
5919: my $result=0;
5920: if ($env{'request.course.id'}
5921: && defined($allpathcond)) {
5922: my $operand='|';
5923: my @stack;
5924: foreach my $chunk ($allpathcond=~/(\d+|_\d+\.\d+|\(|\)|\&|\|)/g) {
5925: if ($chunk eq '(') {
5926: push @stack,($operand,$result);
5927: } elsif ($chunk eq ')') {
5928: my $before=pop @stack;
5929: if (pop @stack eq '&') {
5930: $result=$result>$before?$before:$result;
5931: } else {
5932: $result=$result>$before?$result:$before;
5933: }
5934: } elsif (($chunk eq '&') || ($chunk eq '|')) {
5935: $operand=$chunk;
5936: } else {
5937: my $new=directcondval($chunk);
5938: if ($operand eq '&') {
5939: $result=$result>$new?$new:$result;
5940: } else {
5941: $result=$result>$new?$result:$new;
5942: }
5943: }
5944: }
5945: }
5946: return $result;
5947: }
5948:
5949: # ---------------------------------------------------- Devalidate courseresdata
5950:
5951: sub devalidatecourseresdata {
5952: my ($coursenum,$coursedomain)=@_;
5953: my $hashid=$coursenum.':'.$coursedomain;
5954: &devalidate_cache_new('courseres',$hashid);
5955: }
5956:
5957:
5958: # --------------------------------------------------- Course Resourcedata Query
5959: #
5960: # Parameters:
5961: # $coursenum - Number of the course.
5962: # $coursedomain - Domain at which the course was created.
5963: # Returns:
5964: # A hash of the course parameters along (I think) with timestamps
5965: # and version info.
5966:
5967: sub get_courseresdata {
5968: my ($coursenum,$coursedomain)=@_;
5969: my $coursehom=&homeserver($coursenum,$coursedomain);
5970: my $hashid=$coursenum.':'.$coursedomain;
5971: my ($result,$cached)=&is_cached_new('courseres',$hashid);
5972: my %dumpreply;
5973: unless (defined($cached)) {
5974: %dumpreply=&dump('resourcedata',$coursedomain,$coursenum);
5975: $result=\%dumpreply;
5976: my ($tmp) = keys(%dumpreply);
5977: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
5978: &do_cache_new('courseres',$hashid,$result,600);
5979: } elsif ($tmp =~ /^(con_lost|no_such_host)/) {
5980: return $tmp;
5981: } elsif ($tmp =~ /^(error)/) {
5982: $result=undef;
5983: &do_cache_new('courseres',$hashid,$result,600);
5984: }
5985: }
5986: return $result;
5987: }
5988:
5989: sub devalidateuserresdata {
5990: my ($uname,$udom)=@_;
5991: my $hashid="$udom:$uname";
5992: &devalidate_cache_new('userres',$hashid);
5993: }
5994:
5995: sub get_userresdata {
5996: my ($uname,$udom)=@_;
5997: #most student don\'t have any data set, check if there is some data
5998: if (&EXT_cache_status($udom,$uname)) { return undef; }
5999:
6000: my $hashid="$udom:$uname";
6001: my ($result,$cached)=&is_cached_new('userres',$hashid);
6002: if (!defined($cached)) {
6003: my %resourcedata=&dump('resourcedata',$udom,$uname);
6004: $result=\%resourcedata;
6005: &do_cache_new('userres',$hashid,$result,600);
6006: }
6007: my ($tmp)=keys(%$result);
6008: if (($tmp!~/^error\:/) && ($tmp!~/^con_lost/)) {
6009: return $result;
6010: }
6011: #error 2 occurs when the .db doesn't exist
6012: if ($tmp!~/error: 2 /) {
6013: &logthis("<font color=\"blue\">WARNING:".
6014: " Trying to get resource data for ".
6015: $uname." at ".$udom.": ".
6016: $tmp."</font>");
6017: } elsif ($tmp=~/error: 2 /) {
6018: #&EXT_cache_set($udom,$uname);
6019: &do_cache_new('userres',$hashid,undef,600);
6020: undef($tmp); # not really an error so don't send it back
6021: }
6022: return $tmp;
6023: }
6024: #----------------------------------------------- resdata - return resource data
6025: # Purpose:
6026: # Return resource data for either users or for a course.
6027: # Parameters:
6028: # $name - Course/user name.
6029: # $domain - Name of the domain the user/course is registered on.
6030: # $type - Type of thing $name is (must be 'course' or 'user'
6031: # @which - Array of names of resources desired.
6032: # Returns:
6033: # The value of the first reasource in @which that is found in the
6034: # resource hash.
6035: # Exceptional Conditions:
6036: # If the $type passed in is not valid (not the string 'course' or
6037: # 'user', an undefined reference is returned.
6038: # If none of the resources are found, an undef is returned
6039: sub resdata {
6040: my ($name,$domain,$type,@which)=@_;
6041: my $result;
6042: if ($type eq 'course') {
6043: $result=&get_courseresdata($name,$domain);
6044: } elsif ($type eq 'user') {
6045: $result=&get_userresdata($name,$domain);
6046: }
6047: if (!ref($result)) { return $result; }
6048: foreach my $item (@which) {
6049: if (defined($result->{$item})) {
6050: return $result->{$item};
6051: }
6052: }
6053: return undef;
6054: }
6055:
6056: #
6057: # EXT resource caching routines
6058: #
6059:
6060: sub clear_EXT_cache_status {
6061: &delenv('cache.EXT.');
6062: }
6063:
6064: sub EXT_cache_status {
6065: my ($target_domain,$target_user) = @_;
6066: my $cachename = 'cache.EXT.'.$target_user.'.'.$target_domain;
6067: if (exists($env{$cachename}) && ($env{$cachename}+600) > time) {
6068: # We know already the user has no data
6069: return 1;
6070: } else {
6071: return 0;
6072: }
6073: }
6074:
6075: sub EXT_cache_set {
6076: my ($target_domain,$target_user) = @_;
6077: my $cachename = 'cache.EXT.'.$target_user.'.'.$target_domain;
6078: #&appenv($cachename => time);
6079: }
6080:
6081: # --------------------------------------------------------- Value of a Variable
6082: sub EXT {
6083:
6084: my ($varname,$symbparm,$udom,$uname,$usection,$recurse)=@_;
6085: unless ($varname) { return ''; }
6086: #get real user name/domain, courseid and symb
6087: my $courseid;
6088: my $publicuser;
6089: if ($symbparm) {
6090: $symbparm=&get_symb_from_alias($symbparm);
6091: }
6092: if (!($uname && $udom)) {
6093: (my $cursymb,$courseid,$udom,$uname,$publicuser)= &whichuser($symbparm);
6094: if (!$symbparm) { $symbparm=$cursymb; }
6095: } else {
6096: $courseid=$env{'request.course.id'};
6097: }
6098: my ($realm,$space,$qualifier,@therest)=split(/\./,$varname);
6099: my $rest;
6100: if (defined($therest[0])) {
6101: $rest=join('.',@therest);
6102: } else {
6103: $rest='';
6104: }
6105:
6106: my $qualifierrest=$qualifier;
6107: if ($rest) { $qualifierrest.='.'.$rest; }
6108: my $spacequalifierrest=$space;
6109: if ($qualifierrest) { $spacequalifierrest.='.'.$qualifierrest; }
6110: if ($realm eq 'user') {
6111: # --------------------------------------------------------------- user.resource
6112: if ($space eq 'resource') {
6113: if ( (defined($Apache::lonhomework::parsing_a_problem)
6114: || defined($Apache::lonhomework::parsing_a_task))
6115: &&
6116: ($symbparm eq &symbread()) ) {
6117: # if we are in the middle of processing the resource the
6118: # get the value we are planning on committing
6119: if (defined($Apache::lonhomework::results{$qualifierrest})) {
6120: return $Apache::lonhomework::results{$qualifierrest};
6121: } else {
6122: return $Apache::lonhomework::history{$qualifierrest};
6123: }
6124: } else {
6125: my %restored;
6126: if ($publicuser || $env{'request.state'} eq 'construct') {
6127: %restored=&tmprestore($symbparm,$courseid,$udom,$uname);
6128: } else {
6129: %restored=&restore($symbparm,$courseid,$udom,$uname);
6130: }
6131: return $restored{$qualifierrest};
6132: }
6133: # ----------------------------------------------------------------- user.access
6134: } elsif ($space eq 'access') {
6135: # FIXME - not supporting calls for a specific user
6136: return &allowed($qualifier,$rest);
6137: # ------------------------------------------ user.preferences, user.environment
6138: } elsif (($space eq 'preferences') || ($space eq 'environment')) {
6139: if (($uname eq $env{'user.name'}) &&
6140: ($udom eq $env{'user.domain'})) {
6141: return $env{join('.',('environment',$qualifierrest))};
6142: } else {
6143: my %returnhash;
6144: if (!$publicuser) {
6145: %returnhash=&userenvironment($udom,$uname,
6146: $qualifierrest);
6147: }
6148: return $returnhash{$qualifierrest};
6149: }
6150: # ----------------------------------------------------------------- user.course
6151: } elsif ($space eq 'course') {
6152: # FIXME - not supporting calls for a specific user
6153: return $env{join('.',('request.course',$qualifier))};
6154: # ------------------------------------------------------------------- user.role
6155: } elsif ($space eq 'role') {
6156: # FIXME - not supporting calls for a specific user
6157: my ($role,$where)=split(/\./,$env{'request.role'});
6158: if ($qualifier eq 'value') {
6159: return $role;
6160: } elsif ($qualifier eq 'extent') {
6161: return $where;
6162: }
6163: # ----------------------------------------------------------------- user.domain
6164: } elsif ($space eq 'domain') {
6165: return $udom;
6166: # ------------------------------------------------------------------- user.name
6167: } elsif ($space eq 'name') {
6168: return $uname;
6169: # ---------------------------------------------------- Any other user namespace
6170: } else {
6171: my %reply;
6172: if (!$publicuser) {
6173: %reply=&get($space,[$qualifierrest],$udom,$uname);
6174: }
6175: return $reply{$qualifierrest};
6176: }
6177: } elsif ($realm eq 'query') {
6178: # ---------------------------------------------- pull stuff out of query string
6179: &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},
6180: [$spacequalifierrest]);
6181: return $env{'form.'.$spacequalifierrest};
6182: } elsif ($realm eq 'request') {
6183: # ------------------------------------------------------------- request.browser
6184: if ($space eq 'browser') {
6185: if ($qualifier eq 'textremote') {
6186: if (&Apache::lonlocal::mt('textual_remote_display') eq 'on') {
6187: return 1;
6188: } else {
6189: return 0;
6190: }
6191: } else {
6192: return $env{'browser.'.$qualifier};
6193: }
6194: # ------------------------------------------------------------ request.filename
6195: } else {
6196: return $env{'request.'.$spacequalifierrest};
6197: }
6198: } elsif ($realm eq 'course') {
6199: # ---------------------------------------------------------- course.description
6200: return $env{'course.'.$courseid.'.'.$spacequalifierrest};
6201: } elsif ($realm eq 'resource') {
6202:
6203: if (defined($courseid) && $courseid eq $env{'request.course.id'}) {
6204: if (!$symbparm) { $symbparm=&symbread(); }
6205: }
6206:
6207: if ($space eq 'title') {
6208: if (!$symbparm) { $symbparm = $env{'request.filename'}; }
6209: return &gettitle($symbparm);
6210: }
6211:
6212: if ($space eq 'map') {
6213: my ($map) = &decode_symb($symbparm);
6214: return &symbread($map);
6215: }
6216:
6217: my ($section, $group, @groups);
6218: my ($courselevelm,$courselevel);
6219: if ($symbparm && defined($courseid) &&
6220: $courseid eq $env{'request.course.id'}) {
6221:
6222: #print '<br>'.$space.' - '.$qualifier.' - '.$spacequalifierrest;
6223:
6224: # ----------------------------------------------------- Cascading lookup scheme
6225: my $symbp=$symbparm;
6226: my $mapp=&deversion((&decode_symb($symbp))[0]);
6227:
6228: my $symbparm=$symbp.'.'.$spacequalifierrest;
6229: my $mapparm=$mapp.'___(all).'.$spacequalifierrest;
6230:
6231: if (($env{'user.name'} eq $uname) &&
6232: ($env{'user.domain'} eq $udom)) {
6233: $section=$env{'request.course.sec'};
6234: @groups = split(/:/,$env{'request.course.groups'});
6235: @groups=&sort_course_groups($courseid,@groups);
6236: } else {
6237: if (! defined($usection)) {
6238: $section=&getsection($udom,$uname,$courseid);
6239: } else {
6240: $section = $usection;
6241: }
6242: @groups = &get_users_groups($udom,$uname,$courseid);
6243: }
6244:
6245: my $seclevel=$courseid.'.['.$section.'].'.$spacequalifierrest;
6246: my $seclevelr=$courseid.'.['.$section.'].'.$symbparm;
6247: my $seclevelm=$courseid.'.['.$section.'].'.$mapparm;
6248:
6249: $courselevel=$courseid.'.'.$spacequalifierrest;
6250: my $courselevelr=$courseid.'.'.$symbparm;
6251: $courselevelm=$courseid.'.'.$mapparm;
6252:
6253: # ----------------------------------------------------------- first, check user
6254:
6255: my $userreply=&resdata($uname,$udom,'user',
6256: ($courselevelr,$courselevelm,
6257: $courselevel));
6258: if (defined($userreply)) { return $userreply; }
6259:
6260: # ------------------------------------------------ second, check some of course
6261: my $coursereply;
6262: if (@groups > 0) {
6263: $coursereply = &check_group_parms($courseid,\@groups,$symbparm,
6264: $mapparm,$spacequalifierrest);
6265: if (defined($coursereply)) { return $coursereply; }
6266: }
6267:
6268: $coursereply=&resdata($env{'course.'.$courseid.'.num'},
6269: $env{'course.'.$courseid.'.domain'},
6270: 'course',
6271: ($seclevelr,$seclevelm,$seclevel,
6272: $courselevelr));
6273: if (defined($coursereply)) { return $coursereply; }
6274:
6275: # ------------------------------------------------------ third, check map parms
6276: my %parmhash=();
6277: my $thisparm='';
6278: if (tie(%parmhash,'GDBM_File',
6279: $env{'request.course.fn'}.'_parms.db',
6280: &GDBM_READER(),0640)) {
6281: $thisparm=$parmhash{$symbparm};
6282: untie(%parmhash);
6283: }
6284: if ($thisparm) { return $thisparm; }
6285: }
6286: # ------------------------------------------ fourth, look in resource metadata
6287:
6288: $spacequalifierrest=~s/\./\_/;
6289: my $filename;
6290: if (!$symbparm) { $symbparm=&symbread(); }
6291: if ($symbparm) {
6292: $filename=(&decode_symb($symbparm))[2];
6293: } else {
6294: $filename=$env{'request.filename'};
6295: }
6296: my $metadata=&metadata($filename,$spacequalifierrest);
6297: if (defined($metadata)) { return $metadata; }
6298: $metadata=&metadata($filename,'parameter_'.$spacequalifierrest);
6299: if (defined($metadata)) { return $metadata; }
6300:
6301: # ---------------------------------------------- fourth, look in rest pf course
6302: if ($symbparm && defined($courseid) &&
6303: $courseid eq $env{'request.course.id'}) {
6304: my $coursereply=&resdata($env{'course.'.$courseid.'.num'},
6305: $env{'course.'.$courseid.'.domain'},
6306: 'course',
6307: ($courselevelm,$courselevel));
6308: if (defined($coursereply)) { return $coursereply; }
6309: }
6310: # ------------------------------------------------------------------ Cascade up
6311: unless ($space eq '0') {
6312: my @parts=split(/_/,$space);
6313: my $id=pop(@parts);
6314: my $part=join('_',@parts);
6315: if ($part eq '') { $part='0'; }
6316: my $partgeneral=&EXT('resource.'.$part.'.'.$qualifierrest,
6317: $symbparm,$udom,$uname,$section,1);
6318: if (defined($partgeneral)) { return $partgeneral; }
6319: }
6320: if ($recurse) { return undef; }
6321: my $pack_def=&packages_tab_default($filename,$varname);
6322: if (defined($pack_def)) { return $pack_def; }
6323:
6324: # ---------------------------------------------------- Any other user namespace
6325: } elsif ($realm eq 'environment') {
6326: # ----------------------------------------------------------------- environment
6327: if (($uname eq $env{'user.name'})&&($udom eq $env{'user.domain'})) {
6328: return $env{'environment.'.$spacequalifierrest};
6329: } else {
6330: if ($uname eq 'anonymous' && $udom eq '') {
6331: return '';
6332: }
6333: my %returnhash=&userenvironment($udom,$uname,
6334: $spacequalifierrest);
6335: return $returnhash{$spacequalifierrest};
6336: }
6337: } elsif ($realm eq 'system') {
6338: # ----------------------------------------------------------------- system.time
6339: if ($space eq 'time') {
6340: return time;
6341: }
6342: } elsif ($realm eq 'server') {
6343: # ----------------------------------------------------------------- system.time
6344: if ($space eq 'name') {
6345: return $ENV{'SERVER_NAME'};
6346: }
6347: }
6348: return '';
6349: }
6350:
6351: sub check_group_parms {
6352: my ($courseid,$groups,$symbparm,$mapparm,$what) = @_;
6353: my @groupitems = ();
6354: my $resultitem;
6355: my @levels = ($symbparm,$mapparm,$what);
6356: foreach my $group (@{$groups}) {
6357: foreach my $level (@levels) {
6358: my $item = $courseid.'.['.$group.'].'.$level;
6359: push(@groupitems,$item);
6360: }
6361: }
6362: my $coursereply = &resdata($env{'course.'.$courseid.'.num'},
6363: $env{'course.'.$courseid.'.domain'},
6364: 'course',@groupitems);
6365: return $coursereply;
6366: }
6367:
6368: sub sort_course_groups { # Sort groups based on defined rankings. Default is sort().
6369: my ($courseid,@groups) = @_;
6370: @groups = sort(@groups);
6371: return @groups;
6372: }
6373:
6374: sub packages_tab_default {
6375: my ($uri,$varname)=@_;
6376: my (undef,$part,$name)=split(/\./,$varname);
6377:
6378: my (@extension,@specifics,$do_default);
6379: foreach my $package (split(/,/,&metadata($uri,'packages'))) {
6380: my ($pack_type,$pack_part)=split(/_/,$package,2);
6381: if ($pack_type eq 'default') {
6382: $do_default=1;
6383: } elsif ($pack_type eq 'extension') {
6384: push(@extension,[$package,$pack_type,$pack_part]);
6385: } elsif ($pack_part eq $part || $pack_type eq 'part') {
6386: # only look at packages defaults for packages that this id is
6387: push(@specifics,[$package,$pack_type,$pack_part]);
6388: }
6389: }
6390: # first look for a package that matches the requested part id
6391: foreach my $package (@specifics) {
6392: my (undef,$pack_type,$pack_part)=@{$package};
6393: next if ($pack_part ne $part);
6394: if (defined($packagetab{"$pack_type&$name&default"})) {
6395: return $packagetab{"$pack_type&$name&default"};
6396: }
6397: }
6398: # look for any possible matching non extension_ package
6399: foreach my $package (@specifics) {
6400: my (undef,$pack_type,$pack_part)=@{$package};
6401: if (defined($packagetab{"$pack_type&$name&default"})) {
6402: return $packagetab{"$pack_type&$name&default"};
6403: }
6404: if ($pack_type eq 'part') { $pack_part='0'; }
6405: if (defined($packagetab{$pack_type."_".$pack_part."&$name&default"})) {
6406: return $packagetab{$pack_type."_".$pack_part."&$name&default"};
6407: }
6408: }
6409: # look for any posible extension_ match
6410: foreach my $package (@extension) {
6411: my ($package,$pack_type)=@{$package};
6412: if (defined($packagetab{"$pack_type&$name&default"})) {
6413: return $packagetab{"$pack_type&$name&default"};
6414: }
6415: if (defined($packagetab{$package."&$name&default"})) {
6416: return $packagetab{$package."&$name&default"};
6417: }
6418: }
6419: # look for a global default setting
6420: if ($do_default && defined($packagetab{"default&$name&default"})) {
6421: return $packagetab{"default&$name&default"};
6422: }
6423: return undef;
6424: }
6425:
6426: sub add_prefix_and_part {
6427: my ($prefix,$part)=@_;
6428: my $keyroot;
6429: if (defined($prefix) && $prefix !~ /^__/) {
6430: # prefix that has a part already
6431: $keyroot=$prefix;
6432: } elsif (defined($prefix)) {
6433: # prefix that is missing a part
6434: if (defined($part)) { $keyroot='_'.$part.substr($prefix,1); }
6435: } else {
6436: # no prefix at all
6437: if (defined($part)) { $keyroot='_'.$part; }
6438: }
6439: return $keyroot;
6440: }
6441:
6442: # ---------------------------------------------------------------- Get metadata
6443:
6444: my %metaentry;
6445: sub metadata {
6446: my ($uri,$what,$liburi,$prefix,$depthcount)=@_;
6447: $uri=&declutter($uri);
6448: # if it is a non metadata possible uri return quickly
6449: if (($uri eq '') ||
6450: (($uri =~ m|^/*adm/|) &&
6451: ($uri !~ m|^adm/includes|) && ($uri !~ m|/bulletinboard$|)) ||
6452: ($uri =~ m|/$|) || ($uri =~ m|/.meta$|) || ($uri =~ /^~/) ||
6453: ($uri =~ m|home/$match_username/public_html/|)) {
6454: return undef;
6455: }
6456: my $filename=$uri;
6457: $uri=~s/\.meta$//;
6458: #
6459: # Is the metadata already cached?
6460: # Look at timestamp of caching
6461: # Everything is cached by the main uri, libraries are never directly cached
6462: #
6463: if (!defined($liburi)) {
6464: my ($result,$cached)=&is_cached_new('meta',$uri);
6465: if (defined($cached)) { return $result->{':'.$what}; }
6466: }
6467: {
6468: #
6469: # Is this a recursive call for a library?
6470: #
6471: # if (! exists($metacache{$uri})) {
6472: # $metacache{$uri}={};
6473: # }
6474: if ($liburi) {
6475: $liburi=&declutter($liburi);
6476: $filename=$liburi;
6477: } else {
6478: &devalidate_cache_new('meta',$uri);
6479: undef(%metaentry);
6480: }
6481: my %metathesekeys=();
6482: unless ($filename=~/\.meta$/) { $filename.='.meta'; }
6483: my $metastring;
6484: if ($uri !~ m -^(editupload)/-) {
6485: my $file=&filelocation('',&clutter($filename));
6486: #push(@{$metaentry{$uri.'.file'}},$file);
6487: $metastring=&getfile($file);
6488: }
6489: my $parser=HTML::LCParser->new(\$metastring);
6490: my $token;
6491: undef %metathesekeys;
6492: while ($token=$parser->get_token) {
6493: if ($token->[0] eq 'S') {
6494: if (defined($token->[2]->{'package'})) {
6495: #
6496: # This is a package - get package info
6497: #
6498: my $package=$token->[2]->{'package'};
6499: my $keyroot=&add_prefix_and_part($prefix,$token->[2]->{'part'});
6500: if (defined($token->[2]->{'id'})) {
6501: $keyroot.='_'.$token->[2]->{'id'};
6502: }
6503: if ($metaentry{':packages'}) {
6504: $metaentry{':packages'}.=','.$package.$keyroot;
6505: } else {
6506: $metaentry{':packages'}=$package.$keyroot;
6507: }
6508: foreach my $pack_entry (keys(%packagetab)) {
6509: my $part=$keyroot;
6510: $part=~s/^\_//;
6511: if ($pack_entry=~/^\Q$package\E\&/ ||
6512: $pack_entry=~/^\Q$package\E_0\&/) {
6513: my ($pack,$name,$subp)=split(/\&/,$pack_entry);
6514: # ignore package.tab specified default values
6515: # here &package_tab_default() will fetch those
6516: if ($subp eq 'default') { next; }
6517: my $value=$packagetab{$pack_entry};
6518: my $unikey;
6519: if ($pack =~ /_0$/) {
6520: $unikey='parameter_0_'.$name;
6521: $part=0;
6522: } else {
6523: $unikey='parameter'.$keyroot.'_'.$name;
6524: }
6525: if ($subp eq 'display') {
6526: $value.=' [Part: '.$part.']';
6527: }
6528: $metaentry{':'.$unikey.'.part'}=$part;
6529: $metathesekeys{$unikey}=1;
6530: unless (defined($metaentry{':'.$unikey.'.'.$subp})) {
6531: $metaentry{':'.$unikey.'.'.$subp}=$value;
6532: }
6533: if (defined($metaentry{':'.$unikey.'.default'})) {
6534: $metaentry{':'.$unikey}=
6535: $metaentry{':'.$unikey.'.default'};
6536: }
6537: }
6538: }
6539: } else {
6540: #
6541: # This is not a package - some other kind of start tag
6542: #
6543: my $entry=$token->[1];
6544: my $unikey;
6545: if ($entry eq 'import') {
6546: $unikey='';
6547: } else {
6548: $unikey=$entry;
6549: }
6550: $unikey.=&add_prefix_and_part($prefix,$token->[2]->{'part'});
6551:
6552: if (defined($token->[2]->{'id'})) {
6553: $unikey.='_'.$token->[2]->{'id'};
6554: }
6555:
6556: if ($entry eq 'import') {
6557: #
6558: # Importing a library here
6559: #
6560: if ($depthcount<20) {
6561: my $location=$parser->get_text('/import');
6562: my $dir=$filename;
6563: $dir=~s|[^/]*$||;
6564: $location=&filelocation($dir,$location);
6565: my $metadata =
6566: &metadata($uri,'keys', $location,$unikey,
6567: $depthcount+1);
6568: foreach my $meta (split(',',$metadata)) {
6569: $metaentry{':'.$meta}=$metaentry{':'.$meta};
6570: $metathesekeys{$meta}=1;
6571: }
6572: }
6573: } else {
6574:
6575: if (defined($token->[2]->{'name'})) {
6576: $unikey.='_'.$token->[2]->{'name'};
6577: }
6578: $metathesekeys{$unikey}=1;
6579: foreach my $param (@{$token->[3]}) {
6580: $metaentry{':'.$unikey.'.'.$param} =
6581: $token->[2]->{$param};
6582: }
6583: my $internaltext=&HTML::Entities::decode($parser->get_text('/'.$entry));
6584: my $default=$metaentry{':'.$unikey.'.default'};
6585: if ( $internaltext =~ /^\s*$/ && $default !~ /^\s*$/) {
6586: # only ws inside the tag, and not in default, so use default
6587: # as value
6588: $metaentry{':'.$unikey}=$default;
6589: } else {
6590: # either something interesting inside the tag or default
6591: # uninteresting
6592: $metaentry{':'.$unikey}=$internaltext;
6593: }
6594: # end of not-a-package not-a-library import
6595: }
6596: # end of not-a-package start tag
6597: }
6598: # the next is the end of "start tag"
6599: }
6600: }
6601: my ($extension) = ($uri =~ /\.(\w+)$/);
6602: $extension = lc($extension);
6603: if ($extension eq 'htm') { $extension='html'; }
6604:
6605: foreach my $key (keys(%packagetab)) {
6606: #no specific packages #how's our extension
6607: if ($key!~/^extension_\Q$extension\E&/) { next; }
6608: &metadata_create_package_def($uri,$key,'extension_'.$extension,
6609: \%metathesekeys);
6610: }
6611:
6612: if (!exists($metaentry{':packages'})
6613: || $packagetab{"import_defaults&extension_$extension"}) {
6614: foreach my $key (keys(%packagetab)) {
6615: #no specific packages well let's get default then
6616: if ($key!~/^default&/) { next; }
6617: &metadata_create_package_def($uri,$key,'default',
6618: \%metathesekeys);
6619: }
6620: }
6621: # are there custom rights to evaluate
6622: if ($metaentry{':copyright'} eq 'custom') {
6623:
6624: #
6625: # Importing a rights file here
6626: #
6627: unless ($depthcount) {
6628: my $location=$metaentry{':customdistributionfile'};
6629: my $dir=$filename;
6630: $dir=~s|[^/]*$||;
6631: $location=&filelocation($dir,$location);
6632: my $rights_metadata =
6633: &metadata($uri,'keys',$location,'_rights',
6634: $depthcount+1);
6635: foreach my $rights (split(',',$rights_metadata)) {
6636: #$metaentry{':'.$rights}=$metacache{$uri}->{':'.$rights};
6637: $metathesekeys{$rights}=1;
6638: }
6639: }
6640: }
6641: # uniqifiy package listing
6642: my %seen;
6643: my @uniq_packages =
6644: grep { ! $seen{$_} ++ } (split(',',$metaentry{':packages'}));
6645: $metaentry{':packages'} = join(',',@uniq_packages);
6646:
6647: $metaentry{':keys'} = join(',',keys(%metathesekeys));
6648: &metadata_generate_part0(\%metathesekeys,\%metaentry,$uri);
6649: $metaentry{':allpossiblekeys'}=join(',',keys %metathesekeys);
6650: &do_cache_new('meta',$uri,\%metaentry,60*60);
6651: # this is the end of "was not already recently cached
6652: }
6653: return $metaentry{':'.$what};
6654: }
6655:
6656: sub metadata_create_package_def {
6657: my ($uri,$key,$package,$metathesekeys)=@_;
6658: my ($pack,$name,$subp)=split(/\&/,$key);
6659: if ($subp eq 'default') { next; }
6660:
6661: if (defined($metaentry{':packages'})) {
6662: $metaentry{':packages'}.=','.$package;
6663: } else {
6664: $metaentry{':packages'}=$package;
6665: }
6666: my $value=$packagetab{$key};
6667: my $unikey;
6668: $unikey='parameter_0_'.$name;
6669: $metaentry{':'.$unikey.'.part'}=0;
6670: $$metathesekeys{$unikey}=1;
6671: unless (defined($metaentry{':'.$unikey.'.'.$subp})) {
6672: $metaentry{':'.$unikey.'.'.$subp}=$value;
6673: }
6674: if (defined($metaentry{':'.$unikey.'.default'})) {
6675: $metaentry{':'.$unikey}=
6676: $metaentry{':'.$unikey.'.default'};
6677: }
6678: }
6679:
6680: sub metadata_generate_part0 {
6681: my ($metadata,$metacache,$uri) = @_;
6682: my %allnames;
6683: foreach my $metakey (keys(%$metadata)) {
6684: if ($metakey=~/^parameter\_(.*)/) {
6685: my $part=$$metacache{':'.$metakey.'.part'};
6686: my $name=$$metacache{':'.$metakey.'.name'};
6687: if (! exists($$metadata{'parameter_0_'.$name.'.name'})) {
6688: $allnames{$name}=$part;
6689: }
6690: }
6691: }
6692: foreach my $name (keys(%allnames)) {
6693: $$metadata{"parameter_0_$name"}=1;
6694: my $key=":parameter_0_$name";
6695: $$metacache{"$key.part"}='0';
6696: $$metacache{"$key.name"}=$name;
6697: $$metacache{"$key.type"}=$$metacache{':parameter_'.
6698: $allnames{$name}.'_'.$name.
6699: '.type'};
6700: my $olddis=$$metacache{':parameter_'.$allnames{$name}.'_'.$name.
6701: '.display'};
6702: my $expr='[Part: '.$allnames{$name}.']';
6703: $olddis=~s/\Q$expr\E/\[Part: 0\]/;
6704: $$metacache{"$key.display"}=$olddis;
6705: }
6706: }
6707:
6708: # ------------------------------------------------------ Devalidate title cache
6709:
6710: sub devalidate_title_cache {
6711: my ($url)=@_;
6712: if (!$env{'request.course.id'}) { return; }
6713: my $symb=&symbread($url);
6714: if (!$symb) { return; }
6715: my $key=$env{'request.course.id'}."\0".$symb;
6716: &devalidate_cache_new('title',$key);
6717: }
6718:
6719: # ------------------------------------------------- Get the title of a resource
6720:
6721: sub gettitle {
6722: my $urlsymb=shift;
6723: my $symb=&symbread($urlsymb);
6724: if ($symb) {
6725: my $key=$env{'request.course.id'}."\0".$symb;
6726: my ($result,$cached)=&is_cached_new('title',$key);
6727: if (defined($cached)) {
6728: return $result;
6729: }
6730: my ($map,$resid,$url)=&decode_symb($symb);
6731: my $title='';
6732: my %bighash;
6733: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
6734: &GDBM_READER(),0640)) {
6735: my $mapid=$bighash{'map_pc_'.&clutter($map)};
6736: $title=$bighash{'title_'.$mapid.'.'.$resid};
6737: untie %bighash;
6738: }
6739: $title=~s/\&colon\;/\:/gs;
6740: if ($title) {
6741: return &do_cache_new('title',$key,$title,600);
6742: }
6743: $urlsymb=$url;
6744: }
6745: my $title=&metadata($urlsymb,'title');
6746: if (!$title) { $title=(split('/',$urlsymb))[-1]; }
6747: return $title;
6748: }
6749:
6750: sub get_slot {
6751: my ($which,$cnum,$cdom)=@_;
6752: if (!$cnum || !$cdom) {
6753: (undef,my $courseid)=&whichuser();
6754: $cdom=$env{'course.'.$courseid.'.domain'};
6755: $cnum=$env{'course.'.$courseid.'.num'};
6756: }
6757: my $key=join("\0",'slots',$cdom,$cnum,$which);
6758: my %slotinfo;
6759: if (exists($remembered{$key})) {
6760: $slotinfo{$which} = $remembered{$key};
6761: } else {
6762: %slotinfo=&get('slots',[$which],$cdom,$cnum);
6763: &Apache::lonhomework::showhash(%slotinfo);
6764: my ($tmp)=keys(%slotinfo);
6765: if ($tmp=~/^error:/) { return (); }
6766: $remembered{$key} = $slotinfo{$which};
6767: }
6768: if (ref($slotinfo{$which}) eq 'HASH') {
6769: return %{$slotinfo{$which}};
6770: }
6771: return $slotinfo{$which};
6772: }
6773: # ------------------------------------------------- Update symbolic store links
6774:
6775: sub symblist {
6776: my ($mapname,%newhash)=@_;
6777: $mapname=&deversion(&declutter($mapname));
6778: my %hash;
6779: if (($env{'request.course.fn'}) && (%newhash)) {
6780: if (tie(%hash,'GDBM_File',$env{'request.course.fn'}.'_symb.db',
6781: &GDBM_WRCREAT(),0640)) {
6782: foreach my $url (keys %newhash) {
6783: next if ($url eq 'last_known'
6784: && $env{'form.no_update_last_known'});
6785: $hash{declutter($url)}=&encode_symb($mapname,
6786: $newhash{$url}->[1],
6787: $newhash{$url}->[0]);
6788: }
6789: if (untie(%hash)) {
6790: return 'ok';
6791: }
6792: }
6793: }
6794: return 'error';
6795: }
6796:
6797: # --------------------------------------------------------------- Verify a symb
6798:
6799: sub symbverify {
6800: my ($symb,$thisurl)=@_;
6801: my $thisfn=$thisurl;
6802: $thisfn=&declutter($thisfn);
6803: # direct jump to resource in page or to a sequence - will construct own symbs
6804: if ($thisfn=~/\.(page|sequence)$/) { return 1; }
6805: # check URL part
6806: my ($map,$resid,$url)=&decode_symb($symb);
6807:
6808: unless ($url eq $thisfn) { return 0; }
6809:
6810: $symb=&symbclean($symb);
6811: $thisurl=&deversion($thisurl);
6812: $thisfn=&deversion($thisfn);
6813:
6814: my %bighash;
6815: my $okay=0;
6816:
6817: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
6818: &GDBM_READER(),0640)) {
6819: my $ids=$bighash{'ids_'.&clutter($thisurl)};
6820: unless ($ids) {
6821: $ids=$bighash{'ids_/'.$thisurl};
6822: }
6823: if ($ids) {
6824: # ------------------------------------------------------------------- Has ID(s)
6825: foreach my $id (split(/\,/,$ids)) {
6826: my ($mapid,$resid)=split(/\./,$id);
6827: if (
6828: &symbclean(&declutter($bighash{'map_id_'.$mapid}).'___'.$resid.'___'.$thisfn)
6829: eq $symb) {
6830: if (($env{'request.role.adv'}) ||
6831: $bighash{'encrypted_'.$id} eq $env{'request.enc'}) {
6832: $okay=1;
6833: }
6834: }
6835: }
6836: }
6837: untie(%bighash);
6838: }
6839: return $okay;
6840: }
6841:
6842: # --------------------------------------------------------------- Clean-up symb
6843:
6844: sub symbclean {
6845: my $symb=shift;
6846: if ($symb=~m|^/enc/|) { $symb=&Apache::lonenc::unencrypted($symb); }
6847: # remove version from map
6848: $symb=~s/\.(\d+)\.(\w+)\_\_\_/\.$2\_\_\_/;
6849:
6850: # remove version from URL
6851: $symb=~s/\.(\d+)\.(\w+)$/\.$2/;
6852:
6853: # remove wrapper
6854:
6855: $symb=~s/(\_\_\_\d+\_\_\_)adm\/wrapper\/(res\/)*/$1/;
6856: $symb=~s/(\_\_\_\d+\_\_\_)adm\/coursedocs\/showdoc\/(res\/)*/$1/;
6857: return $symb;
6858: }
6859:
6860: # ---------------------------------------------- Split symb to find map and url
6861:
6862: sub encode_symb {
6863: my ($map,$resid,$url)=@_;
6864: return &symbclean(&declutter($map).'___'.$resid.'___'.&declutter($url));
6865: }
6866:
6867: sub decode_symb {
6868: my $symb=shift;
6869: if ($symb=~m|^/enc/|) { $symb=&Apache::lonenc::unencrypted($symb); }
6870: my ($map,$resid,$url)=split(/___/,$symb);
6871: return (&fixversion($map),$resid,&fixversion($url));
6872: }
6873:
6874: sub fixversion {
6875: my $fn=shift;
6876: if ($fn=~/^(adm|uploaded|editupload|public)/) { return $fn; }
6877: my %bighash;
6878: my $uri=&clutter($fn);
6879: my $key=$env{'request.course.id'}.'_'.$uri;
6880: # is this cached?
6881: my ($result,$cached)=&is_cached_new('courseresversion',$key);
6882: if (defined($cached)) { return $result; }
6883: # unfortunately not cached, or expired
6884: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
6885: &GDBM_READER(),0640)) {
6886: if ($bighash{'version_'.$uri}) {
6887: my $version=$bighash{'version_'.$uri};
6888: unless (($version eq 'mostrecent') ||
6889: ($version==&getversion($uri))) {
6890: $uri=~s/\.(\w+)$/\.$version\.$1/;
6891: }
6892: }
6893: untie %bighash;
6894: }
6895: return &do_cache_new('courseresversion',$key,&declutter($uri),600);
6896: }
6897:
6898: sub deversion {
6899: my $url=shift;
6900: $url=~s/\.\d+\.(\w+)$/\.$1/;
6901: return $url;
6902: }
6903:
6904: # ------------------------------------------------------ Return symb list entry
6905:
6906: sub symbread {
6907: my ($thisfn,$donotrecurse)=@_;
6908: my $cache_str='request.symbread.cached.'.$thisfn;
6909: if (defined($env{$cache_str})) { return $env{$cache_str}; }
6910: # no filename provided? try from environment
6911: unless ($thisfn) {
6912: if ($env{'request.symb'}) {
6913: return $env{$cache_str}=&symbclean($env{'request.symb'});
6914: }
6915: $thisfn=$env{'request.filename'};
6916: }
6917: if ($thisfn=~m|^/enc/|) { $thisfn=&Apache::lonenc::unencrypted($thisfn); }
6918: # is that filename actually a symb? Verify, clean, and return
6919: if ($thisfn=~/\_\_\_\d+\_\_\_(.*)$/) {
6920: if (&symbverify($thisfn,$1)) {
6921: return $env{$cache_str}=&symbclean($thisfn);
6922: }
6923: }
6924: $thisfn=declutter($thisfn);
6925: my %hash;
6926: my %bighash;
6927: my $syval='';
6928: if (($env{'request.course.fn'}) && ($thisfn)) {
6929: my $targetfn = $thisfn;
6930: if ( ($thisfn =~ m/^(uploaded|editupload)\//) && ($thisfn !~ m/\.(page|sequence)$/) ) {
6931: $targetfn = 'adm/wrapper/'.$thisfn;
6932: }
6933: if ($targetfn =~ m|^adm/wrapper/(ext/.*)|) {
6934: $targetfn=$1;
6935: }
6936: if (tie(%hash,'GDBM_File',$env{'request.course.fn'}.'_symb.db',
6937: &GDBM_READER(),0640)) {
6938: $syval=$hash{$targetfn};
6939: untie(%hash);
6940: }
6941: # ---------------------------------------------------------- There was an entry
6942: if ($syval) {
6943: #unless ($syval=~/\_\d+$/) {
6944: #unless ($env{'form.request.prefix'}=~/\.(\d+)\_$/) {
6945: #&appenv('request.ambiguous' => $thisfn);
6946: #return $env{$cache_str}='';
6947: #}
6948: #$syval.=$1;
6949: #}
6950: } else {
6951: # ------------------------------------------------------- Was not in symb table
6952: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
6953: &GDBM_READER(),0640)) {
6954: # ---------------------------------------------- Get ID(s) for current resource
6955: my $ids=$bighash{'ids_'.&clutter($thisfn)};
6956: unless ($ids) {
6957: $ids=$bighash{'ids_/'.$thisfn};
6958: }
6959: unless ($ids) {
6960: # alias?
6961: $ids=$bighash{'mapalias_'.$thisfn};
6962: }
6963: if ($ids) {
6964: # ------------------------------------------------------------------- Has ID(s)
6965: my @possibilities=split(/\,/,$ids);
6966: if ($#possibilities==0) {
6967: # ----------------------------------------------- There is only one possibility
6968: my ($mapid,$resid)=split(/\./,$ids);
6969: $syval=&encode_symb($bighash{'map_id_'.$mapid},
6970: $resid,$thisfn);
6971: } elsif (!$donotrecurse) {
6972: # ------------------------------------------ There is more than one possibility
6973: my $realpossible=0;
6974: foreach my $id (@possibilities) {
6975: my $file=$bighash{'src_'.$id};
6976: if (&allowed('bre',$file)) {
6977: my ($mapid,$resid)=split(/\./,$id);
6978: if ($bighash{'map_type_'.$mapid} ne 'page') {
6979: $realpossible++;
6980: $syval=&encode_symb($bighash{'map_id_'.$mapid},
6981: $resid,$thisfn);
6982: }
6983: }
6984: }
6985: if ($realpossible!=1) { $syval=''; }
6986: } else {
6987: $syval='';
6988: }
6989: }
6990: untie(%bighash)
6991: }
6992: }
6993: if ($syval) {
6994: return $env{$cache_str}=$syval;
6995: }
6996: }
6997: &appenv('request.ambiguous' => $thisfn);
6998: return $env{$cache_str}='';
6999: }
7000:
7001: # ---------------------------------------------------------- Return random seed
7002:
7003: sub numval {
7004: my $txt=shift;
7005: $txt=~tr/A-J/0-9/;
7006: $txt=~tr/a-j/0-9/;
7007: $txt=~tr/K-T/0-9/;
7008: $txt=~tr/k-t/0-9/;
7009: $txt=~tr/U-Z/0-5/;
7010: $txt=~tr/u-z/0-5/;
7011: $txt=~s/\D//g;
7012: if ($_64bit) { if ($txt > 2**32) { return -1; } }
7013: return int($txt);
7014: }
7015:
7016: sub numval2 {
7017: my $txt=shift;
7018: $txt=~tr/A-J/0-9/;
7019: $txt=~tr/a-j/0-9/;
7020: $txt=~tr/K-T/0-9/;
7021: $txt=~tr/k-t/0-9/;
7022: $txt=~tr/U-Z/0-5/;
7023: $txt=~tr/u-z/0-5/;
7024: $txt=~s/\D//g;
7025: my @txts=split(/(\d\d\d\d\d\d\d\d\d)/,$txt);
7026: my $total;
7027: foreach my $val (@txts) { $total+=$val; }
7028: if ($_64bit) { if ($total > 2**32) { return -1; } }
7029: return int($total);
7030: }
7031:
7032: sub numval3 {
7033: use integer;
7034: my $txt=shift;
7035: $txt=~tr/A-J/0-9/;
7036: $txt=~tr/a-j/0-9/;
7037: $txt=~tr/K-T/0-9/;
7038: $txt=~tr/k-t/0-9/;
7039: $txt=~tr/U-Z/0-5/;
7040: $txt=~tr/u-z/0-5/;
7041: $txt=~s/\D//g;
7042: my @txts=split(/(\d\d\d\d\d\d\d\d\d)/,$txt);
7043: my $total;
7044: foreach my $val (@txts) { $total+=$val; }
7045: if ($_64bit) { $total=(($total<<32)>>32); }
7046: return $total;
7047: }
7048:
7049: sub digest {
7050: my ($data)=@_;
7051: my $digest=&Digest::MD5::md5($data);
7052: my ($a,$b,$c,$d)=unpack("iiii",$digest);
7053: my ($e,$f);
7054: {
7055: use integer;
7056: $e=($a+$b);
7057: $f=($c+$d);
7058: if ($_64bit) {
7059: $e=(($e<<32)>>32);
7060: $f=(($f<<32)>>32);
7061: }
7062: }
7063: if (wantarray) {
7064: return ($e,$f);
7065: } else {
7066: my $g;
7067: {
7068: use integer;
7069: $g=($e+$f);
7070: if ($_64bit) {
7071: $g=(($g<<32)>>32);
7072: }
7073: }
7074: return $g;
7075: }
7076: }
7077:
7078: sub latest_rnd_algorithm_id {
7079: return '64bit5';
7080: }
7081:
7082: sub get_rand_alg {
7083: my ($courseid)=@_;
7084: if (!$courseid) { $courseid=(&whichuser())[1]; }
7085: if ($courseid) {
7086: return $env{"course.$courseid.rndseed"};
7087: }
7088: return &latest_rnd_algorithm_id();
7089: }
7090:
7091: sub validCODE {
7092: my ($CODE)=@_;
7093: if (defined($CODE) && $CODE ne '' && $CODE =~ /^\w+$/) { return 1; }
7094: return 0;
7095: }
7096:
7097: sub getCODE {
7098: if (&validCODE($env{'form.CODE'})) { return $env{'form.CODE'}; }
7099: if ( (defined($Apache::lonhomework::parsing_a_problem) ||
7100: defined($Apache::lonhomework::parsing_a_task) ) &&
7101: &validCODE($Apache::lonhomework::history{'resource.CODE'})) {
7102: return $Apache::lonhomework::history{'resource.CODE'};
7103: }
7104: return undef;
7105: }
7106:
7107: sub rndseed {
7108: my ($symb,$courseid,$domain,$username)=@_;
7109: my ($wsymb,$wcourseid,$wdomain,$wusername)=&whichuser();
7110: if (!defined($symb)) {
7111: unless ($symb=$wsymb) { return time; }
7112: }
7113: if (!$courseid) { $courseid=$wcourseid; }
7114: if (!$domain) { $domain=$wdomain; }
7115: if (!$username) { $username=$wusername }
7116: my $which=&get_rand_alg();
7117:
7118: if (defined(&getCODE())) {
7119: if ($which eq '64bit5') {
7120: return &rndseed_CODE_64bit5($symb,$courseid,$domain,$username);
7121: } elsif ($which eq '64bit4') {
7122: return &rndseed_CODE_64bit4($symb,$courseid,$domain,$username);
7123: } else {
7124: return &rndseed_CODE_64bit($symb,$courseid,$domain,$username);
7125: }
7126: } elsif ($which eq '64bit5') {
7127: return &rndseed_64bit5($symb,$courseid,$domain,$username);
7128: } elsif ($which eq '64bit4') {
7129: return &rndseed_64bit4($symb,$courseid,$domain,$username);
7130: } elsif ($which eq '64bit3') {
7131: return &rndseed_64bit3($symb,$courseid,$domain,$username);
7132: } elsif ($which eq '64bit2') {
7133: return &rndseed_64bit2($symb,$courseid,$domain,$username);
7134: } elsif ($which eq '64bit') {
7135: return &rndseed_64bit($symb,$courseid,$domain,$username);
7136: }
7137: return &rndseed_32bit($symb,$courseid,$domain,$username);
7138: }
7139:
7140: sub rndseed_32bit {
7141: my ($symb,$courseid,$domain,$username)=@_;
7142: {
7143: use integer;
7144: my $symbchck=unpack("%32C*",$symb) << 27;
7145: my $symbseed=numval($symb) << 22;
7146: my $namechck=unpack("%32C*",$username) << 17;
7147: my $nameseed=numval($username) << 12;
7148: my $domainseed=unpack("%32C*",$domain) << 7;
7149: my $courseseed=unpack("%32C*",$courseid);
7150: my $num=$symbseed+$nameseed+$domainseed+$courseseed+$namechck+$symbchck;
7151: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
7152: #&logthis("rndseed :$num:$symb");
7153: if ($_64bit) { $num=(($num<<32)>>32); }
7154: return $num;
7155: }
7156: }
7157:
7158: sub rndseed_64bit {
7159: my ($symb,$courseid,$domain,$username)=@_;
7160: {
7161: use integer;
7162: my $symbchck=unpack("%32S*",$symb) << 21;
7163: my $symbseed=numval($symb) << 10;
7164: my $namechck=unpack("%32S*",$username);
7165:
7166: my $nameseed=numval($username) << 21;
7167: my $domainseed=unpack("%32S*",$domain) << 10;
7168: my $courseseed=unpack("%32S*",$courseid);
7169:
7170: my $num1=$symbchck+$symbseed+$namechck;
7171: my $num2=$nameseed+$domainseed+$courseseed;
7172: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
7173: #&logthis("rndseed :$num:$symb");
7174: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
7175: return "$num1,$num2";
7176: }
7177: }
7178:
7179: sub rndseed_64bit2 {
7180: my ($symb,$courseid,$domain,$username)=@_;
7181: {
7182: use integer;
7183: # strings need to be an even # of cahracters long, it it is odd the
7184: # last characters gets thrown away
7185: my $symbchck=unpack("%32S*",$symb.' ') << 21;
7186: my $symbseed=numval($symb) << 10;
7187: my $namechck=unpack("%32S*",$username.' ');
7188:
7189: my $nameseed=numval($username) << 21;
7190: my $domainseed=unpack("%32S*",$domain.' ') << 10;
7191: my $courseseed=unpack("%32S*",$courseid.' ');
7192:
7193: my $num1=$symbchck+$symbseed+$namechck;
7194: my $num2=$nameseed+$domainseed+$courseseed;
7195: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
7196: #&logthis("rndseed :$num:$symb");
7197: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
7198: return "$num1,$num2";
7199: }
7200: }
7201:
7202: sub rndseed_64bit3 {
7203: my ($symb,$courseid,$domain,$username)=@_;
7204: {
7205: use integer;
7206: # strings need to be an even # of cahracters long, it it is odd the
7207: # last characters gets thrown away
7208: my $symbchck=unpack("%32S*",$symb.' ') << 21;
7209: my $symbseed=numval2($symb) << 10;
7210: my $namechck=unpack("%32S*",$username.' ');
7211:
7212: my $nameseed=numval2($username) << 21;
7213: my $domainseed=unpack("%32S*",$domain.' ') << 10;
7214: my $courseseed=unpack("%32S*",$courseid.' ');
7215:
7216: my $num1=$symbchck+$symbseed+$namechck;
7217: my $num2=$nameseed+$domainseed+$courseseed;
7218: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
7219: #&logthis("rndseed :$num1:$num2:$_64bit");
7220: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
7221:
7222: return "$num1:$num2";
7223: }
7224: }
7225:
7226: sub rndseed_64bit4 {
7227: my ($symb,$courseid,$domain,$username)=@_;
7228: {
7229: use integer;
7230: # strings need to be an even # of cahracters long, it it is odd the
7231: # last characters gets thrown away
7232: my $symbchck=unpack("%32S*",$symb.' ') << 21;
7233: my $symbseed=numval3($symb) << 10;
7234: my $namechck=unpack("%32S*",$username.' ');
7235:
7236: my $nameseed=numval3($username) << 21;
7237: my $domainseed=unpack("%32S*",$domain.' ') << 10;
7238: my $courseseed=unpack("%32S*",$courseid.' ');
7239:
7240: my $num1=$symbchck+$symbseed+$namechck;
7241: my $num2=$nameseed+$domainseed+$courseseed;
7242: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
7243: #&logthis("rndseed :$num1:$num2:$_64bit");
7244: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
7245:
7246: return "$num1:$num2";
7247: }
7248: }
7249:
7250: sub rndseed_64bit5 {
7251: my ($symb,$courseid,$domain,$username)=@_;
7252: my ($num1,$num2)=&digest("$symb,$courseid,$domain,$username");
7253: return "$num1:$num2";
7254: }
7255:
7256: sub rndseed_CODE_64bit {
7257: my ($symb,$courseid,$domain,$username)=@_;
7258: {
7259: use integer;
7260: my $symbchck=unpack("%32S*",$symb.' ') << 16;
7261: my $symbseed=numval2($symb);
7262: my $CODEchck=unpack("%32S*",&getCODE().' ') << 16;
7263: my $CODEseed=numval(&getCODE());
7264: my $courseseed=unpack("%32S*",$courseid.' ');
7265: my $num1=$symbseed+$CODEchck;
7266: my $num2=$CODEseed+$courseseed+$symbchck;
7267: #&logthis("$symbseed:$CODEchck|$CODEseed:$courseseed:$symbchck");
7268: #&logthis("rndseed :$num1:$num2:$symb");
7269: if ($_64bit) { $num1=(($num1<<32)>>32); }
7270: if ($_64bit) { $num2=(($num2<<32)>>32); }
7271: return "$num1:$num2";
7272: }
7273: }
7274:
7275: sub rndseed_CODE_64bit4 {
7276: my ($symb,$courseid,$domain,$username)=@_;
7277: {
7278: use integer;
7279: my $symbchck=unpack("%32S*",$symb.' ') << 16;
7280: my $symbseed=numval3($symb);
7281: my $CODEchck=unpack("%32S*",&getCODE().' ') << 16;
7282: my $CODEseed=numval3(&getCODE());
7283: my $courseseed=unpack("%32S*",$courseid.' ');
7284: my $num1=$symbseed+$CODEchck;
7285: my $num2=$CODEseed+$courseseed+$symbchck;
7286: #&logthis("$symbseed:$CODEchck|$CODEseed:$courseseed:$symbchck");
7287: #&logthis("rndseed :$num1:$num2:$symb");
7288: if ($_64bit) { $num1=(($num1<<32)>>32); }
7289: if ($_64bit) { $num2=(($num2<<32)>>32); }
7290: return "$num1:$num2";
7291: }
7292: }
7293:
7294: sub rndseed_CODE_64bit5 {
7295: my ($symb,$courseid,$domain,$username)=@_;
7296: my $code = &getCODE();
7297: my ($num1,$num2)=&digest("$symb,$courseid,$code");
7298: return "$num1:$num2";
7299: }
7300:
7301: sub setup_random_from_rndseed {
7302: my ($rndseed)=@_;
7303: if ($rndseed =~/([,:])/) {
7304: my ($num1,$num2)=split(/[,:]/,$rndseed);
7305: &Math::Random::random_set_seed(abs($num1),abs($num2));
7306: } else {
7307: &Math::Random::random_set_seed_from_phrase($rndseed);
7308: }
7309: }
7310:
7311: sub latest_receipt_algorithm_id {
7312: return 'receipt3';
7313: }
7314:
7315: sub recunique {
7316: my $fucourseid=shift;
7317: my $unique;
7318: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2' ||
7319: $env{"course.$fucourseid.receiptalg"} eq 'receipt3' ) {
7320: $unique=$env{"course.$fucourseid.internal.encseed"};
7321: } else {
7322: $unique=$perlvar{'lonReceipt'};
7323: }
7324: return unpack("%32C*",$unique);
7325: }
7326:
7327: sub recprefix {
7328: my $fucourseid=shift;
7329: my $prefix;
7330: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2'||
7331: $env{"course.$fucourseid.receiptalg"} eq 'receipt3' ) {
7332: $prefix=$env{"course.$fucourseid.internal.encpref"};
7333: } else {
7334: $prefix=$perlvar{'lonHostID'};
7335: }
7336: return unpack("%32C*",$prefix);
7337: }
7338:
7339: sub ireceipt {
7340: my ($funame,$fudom,$fucourseid,$fusymb,$part)=@_;
7341:
7342: my $return =&recprefix($fucourseid).'-';
7343:
7344: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt3' ||
7345: $env{'request.state'} eq 'construct') {
7346: $return .= (&digest("$funame,$fudom,$fucourseid,$fusymb,$part")%10000);
7347: return $return;
7348: }
7349:
7350: my $cuname=unpack("%32C*",$funame);
7351: my $cudom=unpack("%32C*",$fudom);
7352: my $cucourseid=unpack("%32C*",$fucourseid);
7353: my $cusymb=unpack("%32C*",$fusymb);
7354: my $cunique=&recunique($fucourseid);
7355: my $cpart=unpack("%32S*",$part);
7356: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2') {
7357:
7358: #&logthis("doing receipt2 using parts $cpart, uname $cuname and udom $cudom gets ".($cpart%$cuname)." and ".($cpart%$cudom));
7359:
7360: $return.= ($cunique%$cuname+
7361: $cunique%$cudom+
7362: $cusymb%$cuname+
7363: $cusymb%$cudom+
7364: $cucourseid%$cuname+
7365: $cucourseid%$cudom+
7366: $cpart%$cuname+
7367: $cpart%$cudom);
7368: } else {
7369: $return.= ($cunique%$cuname+
7370: $cunique%$cudom+
7371: $cusymb%$cuname+
7372: $cusymb%$cudom+
7373: $cucourseid%$cuname+
7374: $cucourseid%$cudom);
7375: }
7376: return $return;
7377: }
7378:
7379: sub receipt {
7380: my ($part)=@_;
7381: my ($symb,$courseid,$domain,$name) = &whichuser();
7382: return &ireceipt($name,$domain,$courseid,$symb,$part);
7383: }
7384:
7385: sub whichuser {
7386: my ($passedsymb)=@_;
7387: my ($symb,$courseid,$domain,$name,$publicuser);
7388: if (defined($env{'form.grade_symb'})) {
7389: my ($tmp_courseid)=&get_env_multiple('form.grade_courseid');
7390: my $allowed=&allowed('vgr',$tmp_courseid);
7391: if (!$allowed &&
7392: exists($env{'request.course.sec'}) &&
7393: $env{'request.course.sec'} !~ /^\s*$/) {
7394: $allowed=&allowed('vgr',$tmp_courseid.
7395: '/'.$env{'request.course.sec'});
7396: }
7397: if ($allowed) {
7398: ($symb)=&get_env_multiple('form.grade_symb');
7399: $courseid=$tmp_courseid;
7400: ($domain)=&get_env_multiple('form.grade_domain');
7401: ($name)=&get_env_multiple('form.grade_username');
7402: return ($symb,$courseid,$domain,$name,$publicuser);
7403: }
7404: }
7405: if (!$passedsymb) {
7406: $symb=&symbread();
7407: } else {
7408: $symb=$passedsymb;
7409: }
7410: $courseid=$env{'request.course.id'};
7411: $domain=$env{'user.domain'};
7412: $name=$env{'user.name'};
7413: if ($name eq 'public' && $domain eq 'public') {
7414: if (!defined($env{'form.username'})) {
7415: $env{'form.username'}.=time.rand(10000000);
7416: }
7417: $name.=$env{'form.username'};
7418: }
7419: return ($symb,$courseid,$domain,$name,$publicuser);
7420:
7421: }
7422:
7423: # ------------------------------------------------------------ Serves up a file
7424: # returns either the contents of the file or
7425: # -1 if the file doesn't exist
7426: #
7427: # if the target is a file that was uploaded via DOCS,
7428: # a check will be made to see if a current copy exists on the local server,
7429: # if it does this will be served, otherwise a copy will be retrieved from
7430: # the home server for the course and stored in /home/httpd/html/userfiles on
7431: # the local server.
7432:
7433: sub getfile {
7434: my ($file) = @_;
7435: if ($file =~ m -^/*(uploaded|editupload)/-) { $file=&filelocation("",$file); }
7436: &repcopy($file);
7437: return &readfile($file);
7438: }
7439:
7440: sub repcopy_userfile {
7441: my ($file)=@_;
7442: if ($file =~ m -^/*(uploaded|editupload)/-) { $file=&filelocation("",$file); }
7443: if ($file =~ m|^/home/httpd/html/lonUsers/|) { return 'ok'; }
7444: my ($cdom,$cnum,$filename) =
7445: ($file=~m|^\Q$perlvar{'lonDocRoot'}\E/+userfiles/+($match_domain)/+($match_name)/+(.*)|);
7446: my $uri="/uploaded/$cdom/$cnum/$filename";
7447: if (-e "$file") {
7448: # we already have a local copy, check it out
7449: my @fileinfo = stat($file);
7450: my $rtncode;
7451: my $info;
7452: my $lwpresp = &getuploaded('HEAD',$uri,$cdom,$cnum,\$info,\$rtncode);
7453: if ($lwpresp ne 'ok') {
7454: # there is no such file anymore, even though we had a local copy
7455: if ($rtncode eq '404') {
7456: unlink($file);
7457: }
7458: return -1;
7459: }
7460: if ($info < $fileinfo[9]) {
7461: # nice, the file we have is up-to-date, just say okay
7462: return 'ok';
7463: } else {
7464: # the file is outdated, get rid of it
7465: unlink($file);
7466: }
7467: }
7468: # one way or the other, at this point, we don't have the file
7469: # construct the correct path for the file
7470: my @parts = ($cdom,$cnum);
7471: if ($filename =~ m|^(.+)/[^/]+$|) {
7472: push @parts, split(/\//,$1);
7473: }
7474: my $path = $perlvar{'lonDocRoot'}.'/userfiles';
7475: foreach my $part (@parts) {
7476: $path .= '/'.$part;
7477: if (!-e $path) {
7478: mkdir($path,0770);
7479: }
7480: }
7481: # now the path exists for sure
7482: # get a user agent
7483: my $ua=new LWP::UserAgent;
7484: my $transferfile=$file.'.in.transfer';
7485: # FIXME: this should flock
7486: if (-e $transferfile) { return 'ok'; }
7487: my $request;
7488: $uri=~s/^\///;
7489: $request=new HTTP::Request('GET','http://'.&hostname(&homeserver($cnum,$cdom)).'/raw/'.$uri);
7490: my $response=$ua->request($request,$transferfile);
7491: # did it work?
7492: if ($response->is_error()) {
7493: unlink($transferfile);
7494: &logthis("Userfile repcopy failed for $uri");
7495: return -1;
7496: }
7497: # worked, rename the transfer file
7498: rename($transferfile,$file);
7499: return 'ok';
7500: }
7501:
7502: sub tokenwrapper {
7503: my $uri=shift;
7504: $uri=~s|^http\://([^/]+)||;
7505: $uri=~s|^/||;
7506: $env{'user.environment'}=~/\/([^\/]+)\.id/;
7507: my $token=$1;
7508: my (undef,$udom,$uname,$file)=split('/',$uri,4);
7509: if ($udom && $uname && $file) {
7510: $file=~s|(\?\.*)*$||;
7511: &appenv("userfile.$udom/$uname/$file" => $env{'request.course.id'});
7512: return 'http://'.&hostname(&homeserver($uname,$udom)).'/'.$uri.
7513: (($uri=~/\?/)?'&':'?').'token='.$token.
7514: '&tokenissued='.$perlvar{'lonHostID'};
7515: } else {
7516: return '/adm/notfound.html';
7517: }
7518: }
7519:
7520: # call with reqtype HEAD: get last modification time
7521: # call with reqtype GET: get the file contents
7522: # Do not call this with reqtype GET for large files! It loads everything into memory
7523: #
7524: sub getuploaded {
7525: my ($reqtype,$uri,$cdom,$cnum,$info,$rtncode) = @_;
7526: $uri=~s/^\///;
7527: $uri = 'http://'.&hostname(&homeserver($cnum,$cdom)).'/raw/'.$uri;
7528: my $ua=new LWP::UserAgent;
7529: my $request=new HTTP::Request($reqtype,$uri);
7530: my $response=$ua->request($request);
7531: $$rtncode = $response->code;
7532: if (! $response->is_success()) {
7533: return 'failed';
7534: }
7535: if ($reqtype eq 'HEAD') {
7536: $$info = &HTTP::Date::str2time( $response->header('Last-modified') );
7537: } elsif ($reqtype eq 'GET') {
7538: $$info = $response->content;
7539: }
7540: return 'ok';
7541: }
7542:
7543: sub readfile {
7544: my $file = shift;
7545: if ( (! -e $file ) || ($file eq '') ) { return -1; };
7546: my $fh;
7547: open($fh,"<$file");
7548: my $a='';
7549: while (my $line = <$fh>) { $a .= $line; }
7550: return $a;
7551: }
7552:
7553: sub filelocation {
7554: my ($dir,$file) = @_;
7555: my $location;
7556: $file=~ s/^\s*(\S+)\s*$/$1/; ## strip off leading and trailing spaces
7557:
7558: if ($file =~ m-^/adm/-) {
7559: $file=~s-^/adm/wrapper/-/-;
7560: $file=~s-^/adm/coursedocs/showdoc/-/-;
7561: }
7562:
7563: if ($file=~m:^/~:) { # is a contruction space reference
7564: $location = $file;
7565: $location =~ s:/~(.*?)/(.*):/home/$1/public_html/$2:;
7566: } elsif ($file=~m{^/home/$match_username/public_html/}) {
7567: # is a correct contruction space reference
7568: $location = $file;
7569: } elsif ($file=~/^\/*(uploaded|editupload)/) { # is an uploaded file
7570: my ($udom,$uname,$filename)=
7571: ($file=~m -^/+(?:uploaded|editupload)/+($match_domain)/+($match_name)/+(.*)$-);
7572: my $home=&homeserver($uname,$udom);
7573: my $is_me=0;
7574: my @ids=¤t_machine_ids();
7575: foreach my $id (@ids) { if ($id eq $home) { $is_me=1; } }
7576: if ($is_me) {
7577: $location=&propath($udom,$uname).
7578: '/userfiles/'.$filename;
7579: } else {
7580: $location=$Apache::lonnet::perlvar{'lonDocRoot'}.'/userfiles/'.
7581: $udom.'/'.$uname.'/'.$filename;
7582: }
7583: } elsif ($file =~ m-^/adm/-) {
7584: $location = $perlvar{'lonDocRoot'}.'/'.$file;
7585: } else {
7586: $file=~s/^\Q$perlvar{'lonDocRoot'}\E//;
7587: $file=~s:^/res/:/:;
7588: if ( !( $file =~ m:^/:) ) {
7589: $location = $dir. '/'.$file;
7590: } else {
7591: $location = '/home/httpd/html/res'.$file;
7592: }
7593: }
7594: $location=~s://+:/:g; # remove duplicate /
7595: while ($location=~m:/\.\./:) {$location=~ s:/[^/]+/\.\./:/:g;} #remove dir/..
7596: while ($location=~m:/\./:) {$location=~ s:/\./:/:g;} #remove /./
7597: return $location;
7598: }
7599:
7600: sub hreflocation {
7601: my ($dir,$file)=@_;
7602: unless (($file=~m-^http://-i) || ($file=~m-^/-)) {
7603: $file=filelocation($dir,$file);
7604: } elsif ($file=~m-^/adm/-) {
7605: $file=~s-^/adm/wrapper/-/-;
7606: $file=~s-^/adm/coursedocs/showdoc/-/-;
7607: }
7608: if ($file=~m-^\Q$perlvar{'lonDocRoot'}\E-) {
7609: $file=~s-^\Q$perlvar{'lonDocRoot'}\E--;
7610: } elsif ($file=~m-/home/($match_username)/public_html/-) {
7611: $file=~s-^/home/($match_username)/public_html/-/~$1/-;
7612: } elsif ($file=~m-^\Q$perlvar{'lonUsersDir'}\E-) {
7613: $file=~s-^/home/httpd/lonUsers/($match_domain)/./././($match_name)/userfiles/
7614: -/uploaded/$1/$2/-x;
7615: }
7616: return $file;
7617: }
7618:
7619: sub current_machine_domains {
7620: return &machine_domains(&hostname($perlvar{'lonHostID'}));
7621: }
7622:
7623: sub machine_domains {
7624: my ($hostname) = @_;
7625: my @domains;
7626: my %hostname = &all_hostnames();
7627: while( my($id, $name) = each(%hostname)) {
7628: # &logthis("-$id-$name-$hostname-");
7629: if ($hostname eq $name) {
7630: push(@domains,&host_domain($id));
7631: }
7632: }
7633: return @domains;
7634: }
7635:
7636: sub current_machine_ids {
7637: return &machine_ids(&hostname($perlvar{'lonHostID'}));
7638: }
7639:
7640: sub machine_ids {
7641: my ($hostname) = @_;
7642: $hostname ||= &hostname($perlvar{'lonHostID'});
7643: my @ids;
7644: my %name_to_host = &all_names();
7645: if (ref($name_to_host{$hostname}) eq 'ARRAY') {
7646: return @{ $name_to_host{$hostname} };
7647: }
7648: return;
7649: }
7650:
7651: sub additional_machine_domains {
7652: my @domains;
7653: open(my $fh,"<$perlvar{'lonTabDir'}/expected_domains.tab");
7654: while( my $line = <$fh>) {
7655: $line =~ s/\s//g;
7656: push(@domains,$line);
7657: }
7658: return @domains;
7659: }
7660:
7661: sub default_login_domain {
7662: my $domain = $perlvar{'lonDefDomain'};
7663: my $testdomain=(split(/\./,$ENV{'HTTP_HOST'}))[0];
7664: foreach my $posdom (¤t_machine_domains(),
7665: &additional_machine_domains()) {
7666: if (lc($posdom) eq lc($testdomain)) {
7667: $domain=$posdom;
7668: last;
7669: }
7670: }
7671: return $domain;
7672: }
7673:
7674: # ------------------------------------------------------------- Declutters URLs
7675:
7676: sub declutter {
7677: my $thisfn=shift;
7678: if ($thisfn=~m|^/enc/|) { $thisfn=&Apache::lonenc::unencrypted($thisfn); }
7679: $thisfn=~s/^\Q$perlvar{'lonDocRoot'}\E//;
7680: $thisfn=~s/^\///;
7681: $thisfn=~s|^adm/wrapper/||;
7682: $thisfn=~s|^adm/coursedocs/showdoc/||;
7683: $thisfn=~s/^res\///;
7684: $thisfn=~s/\?.+$//;
7685: return $thisfn;
7686: }
7687:
7688: # ------------------------------------------------------------- Clutter up URLs
7689:
7690: sub clutter {
7691: my $thisfn='/'.&declutter(shift);
7692: if ($thisfn !~ m{^/(uploaded|editupload|adm|userfiles|ext|raw|priv|public)/}
7693: || $thisfn =~ m{^/adm/(includes|pages)} ) {
7694: $thisfn='/res'.$thisfn;
7695: }
7696: if ($thisfn !~m|/adm|) {
7697: if ($thisfn =~ m|/ext/|) {
7698: $thisfn='/adm/wrapper'.$thisfn;
7699: } else {
7700: my ($ext) = ($thisfn =~ /\.(\w+)$/);
7701: my $embstyle=&Apache::loncommon::fileembstyle($ext);
7702: if ($embstyle eq 'ssi'
7703: || ($embstyle eq 'hdn')
7704: || ($embstyle eq 'rat')
7705: || ($embstyle eq 'prv')
7706: || ($embstyle eq 'ign')) {
7707: #do nothing with these
7708: } elsif (($embstyle eq 'img')
7709: || ($embstyle eq 'emb')
7710: || ($embstyle eq 'wrp')) {
7711: $thisfn='/adm/wrapper'.$thisfn;
7712: } elsif ($embstyle eq 'unk'
7713: && $thisfn!~/\.(sequence|page)$/) {
7714: $thisfn='/adm/coursedocs/showdoc'.$thisfn;
7715: } else {
7716: # &logthis("Got a blank emb style");
7717: }
7718: }
7719: }
7720: return $thisfn;
7721: }
7722:
7723: sub clutter_with_no_wrapper {
7724: my $uri = &clutter(shift);
7725: if ($uri =~ m-^/adm/-) {
7726: $uri =~ s-^/adm/wrapper/-/-;
7727: $uri =~ s-^/adm/coursedocs/showdoc/-/-;
7728: }
7729: return $uri;
7730: }
7731:
7732: sub freeze_escape {
7733: my ($value)=@_;
7734: if (ref($value)) {
7735: $value=&nfreeze($value);
7736: return '__FROZEN__'.&escape($value);
7737: }
7738: return &escape($value);
7739: }
7740:
7741:
7742: sub thaw_unescape {
7743: my ($value)=@_;
7744: if ($value =~ /^__FROZEN__/) {
7745: substr($value,0,10,undef);
7746: $value=&unescape($value);
7747: return &thaw($value);
7748: }
7749: return &unescape($value);
7750: }
7751:
7752: sub correct_line_ends {
7753: my ($result)=@_;
7754: $$result =~s/\r\n/\n/mg;
7755: $$result =~s/\r/\n/mg;
7756: }
7757: # ================================================================ Main Program
7758:
7759: sub goodbye {
7760: &logthis("Starting Shut down");
7761: #not converted to using infrastruture and probably shouldn't be
7762: &logthis(sprintf("%-20s is %s",'%badServerCache',length(&nfreeze(\%badServerCache))));
7763: #converted
7764: # &logthis(sprintf("%-20s is %s",'%metacache',scalar(%metacache)));
7765: &logthis(sprintf("%-20s is %s",'%homecache',length(&nfreeze(\%homecache))));
7766: # &logthis(sprintf("%-20s is %s",'%titlecache',length(&nfreeze(\%titlecache))));
7767: # &logthis(sprintf("%-20s is %s",'%courseresdatacache',length(&nfreeze(\%courseresdatacache))));
7768: #1.1 only
7769: # &logthis(sprintf("%-20s is %s",'%userresdatacache',length(&nfreeze(\%userresdatacache))));
7770: # &logthis(sprintf("%-20s is %s",'%getsectioncache',length(&nfreeze(\%getsectioncache))));
7771: # &logthis(sprintf("%-20s is %s",'%courseresversioncache',length(&nfreeze(\%courseresversioncache))));
7772: # &logthis(sprintf("%-20s is %s",'%resversioncache',length(&nfreeze(\%resversioncache))));
7773: &logthis(sprintf("%-20s is %s",'%remembered',length(&nfreeze(\%remembered))));
7774: &logthis(sprintf("%-20s is %s",'kicks',$kicks));
7775: &logthis(sprintf("%-20s is %s",'hits',$hits));
7776: &flushcourselogs();
7777: &logthis("Shutting down");
7778: }
7779:
7780: sub get_dns {
7781: my ($url,$func,$ignore_cache) = @_;
7782: if (!$ignore_cache) {
7783: my ($content,$cached)=
7784: &Apache::lonnet::is_cached_new('dns',$url);
7785: if ($cached) {
7786: &$func($content);
7787: return;
7788: }
7789: }
7790:
7791: my %alldns;
7792: open(my $config,"<$perlvar{'lonTabDir'}/hosts.tab");
7793: foreach my $dns (<$config>) {
7794: next if ($dns !~ /^\^(\S*)/x);
7795: $alldns{$1} = 1;
7796: }
7797: while (%alldns) {
7798: my ($dns) = keys(%alldns);
7799: delete($alldns{$dns});
7800: my $ua=new LWP::UserAgent;
7801: my $request=new HTTP::Request('GET',"http://$dns$url");
7802: my $response=$ua->request($request);
7803: next if ($response->is_error());
7804: my @content = split("\n",$response->content);
7805: &Apache::lonnet::do_cache_new('dns',$url,\@content,30*24*60*60);
7806: &$func(\@content);
7807: return;
7808: }
7809: close($config);
7810: my $which = (split('/',$url))[3];
7811: &logthis("unable to contact DNS defaulting to on disk file dns_$which.tab\n");
7812: open($config,"<$perlvar{'lonTabDir'}/dns_$which.tab");
7813: my @content = <$config>;
7814: &$func(\@content);
7815: return;
7816: }
7817: # ------------------------------------------------------------ Read domain file
7818: {
7819: my $loaded;
7820: my %domain;
7821:
7822: sub parse_domain_tab {
7823: my ($lines) = @_;
7824: foreach my $line (@$lines) {
7825: next if ($line =~ /^(\#|\s*$ )/x);
7826:
7827: chomp($line);
7828: my ($name,@elements) = split(/:/,$line,9);
7829: my %this_domain;
7830: foreach my $field ('description', 'auth_def', 'auth_arg_def',
7831: 'lang_def', 'city', 'longi', 'lati',
7832: 'primary') {
7833: $this_domain{$field} = shift(@elements);
7834: }
7835: $domain{$name} = \%this_domain;
7836: }
7837: }
7838:
7839: sub reset_domain_info {
7840: undef($loaded);
7841: undef(%domain);
7842: }
7843:
7844: sub load_domain_tab {
7845: my ($ignore_cache) = @_;
7846: &get_dns('/adm/dns/domain',\&parse_domain_tab,$ignore_cache);
7847: my $fh;
7848: if (open($fh,"<".$perlvar{'lonTabDir'}.'/domain.tab')) {
7849: my @lines = <$fh>;
7850: &parse_domain_tab(\@lines);
7851: }
7852: close($fh);
7853: $loaded = 1;
7854: }
7855:
7856: sub domain {
7857: &load_domain_tab() if (!$loaded);
7858:
7859: my ($name,$what) = @_;
7860: return if ( !exists($domain{$name}) );
7861:
7862: if (!$what) {
7863: return $domain{$name}{'description'};
7864: }
7865: return $domain{$name}{$what};
7866: }
7867: }
7868:
7869:
7870: # ------------------------------------------------------------- Read hosts file
7871: {
7872: my %hostname;
7873: my %hostdom;
7874: my %libserv;
7875: my $loaded;
7876: my %name_to_host;
7877:
7878: sub parse_hosts_tab {
7879: my ($file) = @_;
7880: foreach my $configline (@$file) {
7881: next if ($configline =~ /^(\#|\s*$ )/x);
7882: next if ($configline =~ /^\^/);
7883: chomp($configline);
7884: my ($id,$domain,$role,$name)=split(/:/,$configline);
7885: $name=~s/\s//g;
7886: if ($id && $domain && $role && $name) {
7887: $hostname{$id}=$name;
7888: push(@{$name_to_host{$name}}, $id);
7889: $hostdom{$id}=$domain;
7890: if ($role eq 'library') { $libserv{$id}=$name; }
7891: }
7892: }
7893: }
7894:
7895: sub reset_hosts_info {
7896: &purge_remembered();
7897: &reset_domain_info();
7898: &reset_hosts_ip_info();
7899: undef(%name_to_host);
7900: undef(%hostname);
7901: undef(%hostdom);
7902: undef(%libserv);
7903: undef($loaded);
7904: }
7905:
7906: sub load_hosts_tab {
7907: my ($ignore_cache) = @_;
7908: &get_dns('/adm/dns/hosts',\&parse_hosts_tab,$ignore_cache);
7909: open(my $config,"<$perlvar{'lonTabDir'}/hosts.tab");
7910: my @config = <$config>;
7911: &parse_hosts_tab(\@config);
7912: close($config);
7913: $loaded=1;
7914: }
7915:
7916: sub hostname {
7917: &load_hosts_tab() if (!$loaded);
7918:
7919: my ($lonid) = @_;
7920: return $hostname{$lonid};
7921: }
7922:
7923: sub all_hostnames {
7924: &load_hosts_tab() if (!$loaded);
7925:
7926: return %hostname;
7927: }
7928:
7929: sub all_names {
7930: &load_hosts_tab() if (!$loaded);
7931:
7932: return %name_to_host;
7933: }
7934:
7935: sub is_library {
7936: &load_hosts_tab() if (!$loaded);
7937:
7938: return exists($libserv{$_[0]});
7939: }
7940:
7941: sub all_library {
7942: &load_hosts_tab() if (!$loaded);
7943:
7944: return %libserv;
7945: }
7946:
7947: sub get_servers {
7948: &load_hosts_tab() if (!$loaded);
7949:
7950: my ($domain,$type) = @_;
7951: my %possible_hosts = ($type eq 'library') ? %libserv
7952: : %hostname;
7953: my %result;
7954: if (ref($domain) eq 'ARRAY') {
7955: while ( my ($host,$hostname) = each(%possible_hosts)) {
7956: if (grep(/^\Q$hostdom{$host}\E$/,@$domain)) {
7957: $result{$host} = $hostname;
7958: }
7959: }
7960: } else {
7961: while ( my ($host,$hostname) = each(%possible_hosts)) {
7962: if ($hostdom{$host} eq $domain) {
7963: $result{$host} = $hostname;
7964: }
7965: }
7966: }
7967: return %result;
7968: }
7969:
7970: sub host_domain {
7971: &load_hosts_tab() if (!$loaded);
7972:
7973: my ($lonid) = @_;
7974: return $hostdom{$lonid};
7975: }
7976:
7977: sub all_domains {
7978: &load_hosts_tab() if (!$loaded);
7979:
7980: my %seen;
7981: my @uniq = grep(!$seen{$_}++, values(%hostdom));
7982: return @uniq;
7983: }
7984: }
7985:
7986: {
7987: my %iphost;
7988: my %name_to_ip;
7989: my %lonid_to_ip;
7990:
7991: sub get_hosts_from_ip {
7992: my ($ip) = @_;
7993: my %iphosts = &get_iphost();
7994: if (ref($iphosts{$ip})) {
7995: return @{$iphosts{$ip}};
7996: }
7997: return;
7998: }
7999:
8000: sub reset_hosts_ip_info {
8001: undef(%iphost);
8002: undef(%name_to_ip);
8003: undef(%lonid_to_ip);
8004: }
8005:
8006: sub get_host_ip {
8007: my ($lonid) = @_;
8008: if (exists($lonid_to_ip{$lonid})) {
8009: return $lonid_to_ip{$lonid};
8010: }
8011: my $name=&hostname($lonid);
8012: my $ip = gethostbyname($name);
8013: return if (!$ip || length($ip) ne 4);
8014: $ip=inet_ntoa($ip);
8015: $name_to_ip{$name} = $ip;
8016: $lonid_to_ip{$lonid} = $ip;
8017: return $ip;
8018: }
8019:
8020: sub get_iphost {
8021: my ($ignore_cache) = @_;
8022:
8023: if (!$ignore_cache) {
8024: if (%iphost) {
8025: return %iphost;
8026: }
8027: my ($ip_info,$cached)=
8028: &Apache::lonnet::is_cached_new('iphost','iphost');
8029: if ($cached) {
8030: %iphost = %{$ip_info->[0]};
8031: %name_to_ip = %{$ip_info->[1]};
8032: %lonid_to_ip = %{$ip_info->[2]};
8033: return %iphost;
8034: }
8035: }
8036:
8037: # get yesterday's info for fallback
8038: my %old_name_to_ip;
8039: my ($ip_info,$cached)=
8040: &Apache::lonnet::is_cached_new('iphost','iphost');
8041: if ($cached) {
8042: %old_name_to_ip = %{$ip_info->[1]};
8043: }
8044:
8045: my %name_to_host = &all_names();
8046: foreach my $name (keys(%name_to_host)) {
8047: my $ip;
8048: if (!exists($name_to_ip{$name})) {
8049: $ip = gethostbyname($name);
8050: if (!$ip || length($ip) ne 4) {
8051: if (defined($old_name_to_ip{$name})) {
8052: $ip = $old_name_to_ip{$name};
8053: &logthis("Can't find $name defaulting to old $ip");
8054: } else {
8055: &logthis("Name $name no IP found");
8056: next;
8057: }
8058: } else {
8059: $ip=inet_ntoa($ip);
8060: }
8061: $name_to_ip{$name} = $ip;
8062: } else {
8063: $ip = $name_to_ip{$name};
8064: }
8065: foreach my $id (@{ $name_to_host{$name} }) {
8066: $lonid_to_ip{$id} = $ip;
8067: }
8068: push(@{$iphost{$ip}},@{$name_to_host{$name}});
8069: }
8070: &Apache::lonnet::do_cache_new('iphost','iphost',
8071: [\%iphost,\%name_to_ip,\%lonid_to_ip],
8072: 48*60*60);
8073:
8074: return %iphost;
8075: }
8076: }
8077:
8078: BEGIN {
8079:
8080: # ----------------------------------- Read loncapa.conf and loncapa_apache.conf
8081: unless ($readit) {
8082: {
8083: my $configvars = LONCAPA::Configuration::read_conf('loncapa.conf');
8084: %perlvar = (%perlvar,%{$configvars});
8085: }
8086:
8087:
8088: # ------------------------------------------------------ Read spare server file
8089: {
8090: open(my $config,"<$perlvar{'lonTabDir'}/spare.tab");
8091:
8092: while (my $configline=<$config>) {
8093: chomp($configline);
8094: if ($configline) {
8095: my ($host,$type) = split(':',$configline,2);
8096: if (!defined($type) || $type eq '') { $type = 'default' };
8097: push(@{ $spareid{$type} }, $host);
8098: }
8099: }
8100: close($config);
8101: }
8102: # ------------------------------------------------------------ Read permissions
8103: {
8104: open(my $config,"<$perlvar{'lonTabDir'}/roles.tab");
8105:
8106: while (my $configline=<$config>) {
8107: chomp($configline);
8108: if ($configline) {
8109: my ($role,$perm)=split(/ /,$configline);
8110: if ($perm ne '') { $pr{$role}=$perm; }
8111: }
8112: }
8113: close($config);
8114: }
8115:
8116: # -------------------------------------------- Read plain texts for permissions
8117: {
8118: open(my $config,"<$perlvar{'lonTabDir'}/rolesplain.tab");
8119:
8120: while (my $configline=<$config>) {
8121: chomp($configline);
8122: if ($configline) {
8123: my ($short,@plain)=split(/:/,$configline);
8124: %{$prp{$short}} = ();
8125: if (@plain > 0) {
8126: $prp{$short}{'std'} = $plain[0];
8127: for (my $i=1; $i<@plain; $i++) {
8128: $prp{$short}{'alt'.$i} = $plain[$i];
8129: }
8130: }
8131: }
8132: }
8133: close($config);
8134: }
8135:
8136: # ---------------------------------------------------------- Read package table
8137: {
8138: open(my $config,"<$perlvar{'lonTabDir'}/packages.tab");
8139:
8140: while (my $configline=<$config>) {
8141: if ($configline !~ /\S/ || $configline=~/^#/) { next; }
8142: chomp($configline);
8143: my ($short,$plain)=split(/:/,$configline);
8144: my ($pack,$name)=split(/\&/,$short);
8145: if ($plain ne '') {
8146: $packagetab{$pack.'&'.$name.'&name'}=$name;
8147: $packagetab{$short}=$plain;
8148: }
8149: }
8150: close($config);
8151: }
8152:
8153: # ------------- set up temporary directory
8154: {
8155: $tmpdir = $perlvar{'lonDaemons'}.'/tmp/';
8156:
8157: }
8158:
8159: $memcache=new Cache::Memcached({'servers' => ['127.0.0.1:11211'],
8160: 'compress_threshold'=> 20_000,
8161: });
8162:
8163: $processmarker='_'.time.'_'.$perlvar{'lonHostID'};
8164: $dumpcount=0;
8165:
8166: &logtouch();
8167: &logthis('<font color="yellow">INFO: Read configuration</font>');
8168: $readit=1;
8169: {
8170: use integer;
8171: my $test=(2**32)+1;
8172: if ($test != 0) { $_64bit=1; } else { $_64bit=0; }
8173: &logthis(" Detected 64bit platform ($_64bit)");
8174: }
8175: }
8176: }
8177:
8178: 1;
8179: __END__
8180:
8181: =pod
8182:
8183: =head1 NAME
8184:
8185: Apache::lonnet - Subroutines to ask questions about things in the network.
8186:
8187: =head1 SYNOPSIS
8188:
8189: Invoked by other LON-CAPA modules, when they need to talk to or about objects in the network.
8190:
8191: &Apache::lonnet::SUBROUTINENAME(ARGUMENTS);
8192:
8193: Common parameters:
8194:
8195: =over 4
8196:
8197: =item *
8198:
8199: $uname : an internal username (if $cname expecting a course Id specifically)
8200:
8201: =item *
8202:
8203: $udom : a domain (if $cdom expecting a course's domain specifically)
8204:
8205: =item *
8206:
8207: $symb : a resource instance identifier
8208:
8209: =item *
8210:
8211: $namespace : the name of a .db file that contains the data needed or
8212: being set.
8213:
8214: =back
8215:
8216: =head1 OVERVIEW
8217:
8218: lonnet provides subroutines which interact with the
8219: lonc/lond (TCP) network layer of LON-CAPA. They can be used to ask
8220: about classes, users, and resources.
8221:
8222: For many of these objects you can also use this to store data about
8223: them or modify them in various ways.
8224:
8225: =head2 Symbs
8226:
8227: To identify a specific instance of a resource, LON-CAPA uses symbols
8228: or "symbs"X<symb>. These identifiers are built from the URL of the
8229: map, the resource number of the resource in the map, and the URL of
8230: the resource itself. The latter is somewhat redundant, but might help
8231: if maps change.
8232:
8233: An example is
8234:
8235: msu/korte/parts/part1.sequence___19___msu/korte/tests/part12.problem
8236:
8237: The respective map entry is
8238:
8239: <resource id="19" src="/res/msu/korte/tests/part12.problem"
8240: title="Problem 2">
8241: </resource>
8242:
8243: Symbs are used by the random number generator, as well as to store and
8244: restore data specific to a certain instance of for example a problem.
8245:
8246: =head2 Storing And Retrieving Data
8247:
8248: X<store()>X<cstore()>X<restore()>Three of the most important functions
8249: in C<lonnet.pm> are C<&Apache::lonnet::cstore()>,
8250: C<&Apache::lonnet:restore()>, and C<&Apache::lonnet::store()>, which
8251: is is the non-critical message twin of cstore. These functions are for
8252: handlers to store a perl hash to a user's permanent data space in an
8253: easy manner, and to retrieve it again on another call. It is expected
8254: that a handler would use this once at the beginning to retrieve data,
8255: and then again once at the end to send only the new data back.
8256:
8257: The data is stored in the user's data directory on the user's
8258: homeserver under the ID of the course.
8259:
8260: The hash that is returned by restore will have all of the previous
8261: value for all of the elements of the hash.
8262:
8263: Example:
8264:
8265: #creating a hash
8266: my %hash;
8267: $hash{'foo'}='bar';
8268:
8269: #storing it
8270: &Apache::lonnet::cstore(\%hash);
8271:
8272: #changing a value
8273: $hash{'foo'}='notbar';
8274:
8275: #adding a new value
8276: $hash{'bar'}='foo';
8277: &Apache::lonnet::cstore(\%hash);
8278:
8279: #retrieving the hash
8280: my %history=&Apache::lonnet::restore();
8281:
8282: #print the hash
8283: foreach my $key (sort(keys(%history))) {
8284: print("\%history{$key} = $history{$key}");
8285: }
8286:
8287: Will print out:
8288:
8289: %history{1:foo} = bar
8290: %history{1:keys} = foo:timestamp
8291: %history{1:timestamp} = 990455579
8292: %history{2:bar} = foo
8293: %history{2:foo} = notbar
8294: %history{2:keys} = foo:bar:timestamp
8295: %history{2:timestamp} = 990455580
8296: %history{bar} = foo
8297: %history{foo} = notbar
8298: %history{timestamp} = 990455580
8299: %history{version} = 2
8300:
8301: Note that the special hash entries C<keys>, C<version> and
8302: C<timestamp> were added to the hash. C<version> will be equal to the
8303: total number of versions of the data that have been stored. The
8304: C<timestamp> attribute will be the UNIX time the hash was
8305: stored. C<keys> is available in every historical section to list which
8306: keys were added or changed at a specific historical revision of a
8307: hash.
8308:
8309: B<Warning>: do not store the hash that restore returns directly. This
8310: will cause a mess since it will restore the historical keys as if the
8311: were new keys. I.E. 1:foo will become 1:1:foo etc.
8312:
8313: Calling convention:
8314:
8315: my %record=&Apache::lonnet::restore($symb,$courseid,$domain,$uname,$home);
8316: &Apache::lonnet::cstore(\%newrecord,$symb,$courseid,$domain,$uname,$home);
8317:
8318: For more detailed information, see lonnet specific documentation.
8319:
8320: =head1 RETURN MESSAGES
8321:
8322: =over 4
8323:
8324: =item * B<con_lost>: unable to contact remote host
8325:
8326: =item * B<con_delayed>: unable to contact remote host, message will be delivered
8327: when the connection is brought back up
8328:
8329: =item * B<con_failed>: unable to contact remote host and unable to save message
8330: for later delivery
8331:
8332: =item * B<error:>: an error a occured, a description of the error follows the :
8333:
8334: =item * B<no_such_host>: unable to fund a host associated with the user/domain
8335: that was requested
8336:
8337: =back
8338:
8339: =head1 PUBLIC SUBROUTINES
8340:
8341: =head2 Session Environment Functions
8342:
8343: =over 4
8344:
8345: =item *
8346: X<appenv()>
8347: B<appenv(%hash)>: the value of %hash is written to
8348: the user envirnoment file, and will be restored for each access this
8349: user makes during this session, also modifies the %env for the current
8350: process
8351:
8352: =item *
8353: X<delenv()>
8354: B<delenv($regexp)>: removes all items from the session
8355: environment file that matches the regular expression in $regexp. The
8356: values are also delted from the current processes %env.
8357:
8358: =item * get_env_multiple($name)
8359:
8360: gets $name from the %env hash, it seemlessly handles the cases where multiple
8361: values may be defined and end up as an array ref.
8362:
8363: returns an array of values
8364:
8365: =back
8366:
8367: =head2 User Information
8368:
8369: =over 4
8370:
8371: =item *
8372: X<queryauthenticate()>
8373: B<queryauthenticate($uname,$udom)>: try to determine user's current
8374: authentication scheme
8375:
8376: =item *
8377: X<authenticate()>
8378: B<authenticate($uname,$upass,$udom)>: try to
8379: authenticate user from domain's lib servers (first use the current
8380: one). C<$upass> should be the users password.
8381:
8382: =item *
8383: X<homeserver()>
8384: B<homeserver($uname,$udom)>: find the server which has
8385: the user's directory and files (there must be only one), this caches
8386: the answer, and also caches if there is a borken connection.
8387:
8388: =item *
8389: X<idget()>
8390: B<idget($udom,@ids)>: find the usernames behind a list of IDs
8391: (IDs are a unique resource in a domain, there must be only 1 ID per
8392: username, and only 1 username per ID in a specific domain) (returns
8393: hash: id=>name,id=>name)
8394:
8395: =item *
8396: X<idrget()>
8397: B<idrget($udom,@unames)>: find the IDs behind a list of
8398: usernames (returns hash: name=>id,name=>id)
8399:
8400: =item *
8401: X<idput()>
8402: B<idput($udom,%ids)>: store away a list of names and associated IDs
8403:
8404: =item *
8405: X<rolesinit()>
8406: B<rolesinit($udom,$username,$authhost)>: get user privileges
8407:
8408: =item *
8409: X<getsection()>
8410: B<getsection($udom,$uname,$cname)>: finds the section of student in the
8411: course $cname, return section name/number or '' for "not in course"
8412: and '-1' for "no section"
8413:
8414: =item *
8415: X<userenvironment()>
8416: B<userenvironment($udom,$uname,@what)>: gets the values of the keys
8417: passed in @what from the requested user's environment, returns a hash
8418:
8419: =item *
8420: X<userlog_query()>
8421: B<userlog_query($uname,$udom,%filters)>: retrieves data from a user's
8422: activity.log file. %filters defines filters applied when parsing the
8423: log file. These can be start or end timestamps, or the type of action
8424: - log to look for Login or Logout events, check for Checkin or
8425: Checkout, role for role selection. The response is in the form
8426: timestamp1:hostid1:event1×tamp2:hostid2:event2 where events are
8427: escaped strings of the action recorded in the activity.log file.
8428:
8429: =back
8430:
8431: =head2 User Roles
8432:
8433: =over 4
8434:
8435: =item *
8436:
8437: allowed($priv,$uri,$symb,$role) : check for a user privilege; returns codes for allowed actions
8438: F: full access
8439: U,I,K: authentication modes (cxx only)
8440: '': forbidden
8441: 1: user needs to choose course
8442: 2: browse allowed
8443: A: passphrase authentication needed
8444:
8445: =item *
8446:
8447: definerole($rolename,$sysrole,$domrole,$courole) : define role; define a custom
8448: role rolename set privileges in format of lonTabs/roles.tab for system, domain,
8449: and course level
8450:
8451: =item *
8452:
8453: plaintext($short) : return value in %prp hash (rolesplain.tab); plain text
8454: explanation of a user role term
8455:
8456: =item *
8457:
8458: get_my_roles($uname,$udom,$context,$types,$roles,$roledoms) :
8459: All arguments are optional. Returns a hash of a roles, either for
8460: co-author/assistant author roles for a user's Construction Space
8461: (default), or if $context is 'user', roles for the user himself,
8462: In the hash, keys are set to colon-sparated $uname,$udom,and $role,
8463: and value is set to colon-separated start and end times for the role.
8464: If no username and domain are specified, will default to current
8465: user/domain. Types, roles, and roledoms are references to arrays,
8466: of role statuses (active, future or previous), roles
8467: (e.g., cc,in, st etc.) and domains of the roles which can be used
8468: to restrict the list of roles reported. If no array ref is
8469: provided for types, will default to return only active roles.
8470:
8471: =back
8472:
8473: =head2 User Modification
8474:
8475: =over 4
8476:
8477: =item *
8478:
8479: assignrole($udom,$uname,$url,$role,$end,$start) : assign role; give a role to a
8480: user for the level given by URL. Optional start and end dates (leave empty
8481: string or zero for "no date")
8482:
8483: =item *
8484:
8485: changepass($uname,$udom,$currentpass,$newpass,$server) : attempts to
8486: change a users, password, possible return values are: ok,
8487: pwchange_failure, non_authorized, auth_mode_error, unknown_user,
8488: refused
8489:
8490: =item *
8491:
8492: modifyuserauth($udom,$uname,$umode,$upass) : modify user authentication
8493:
8494: =item *
8495:
8496: modifyuser($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene) :
8497: modify user
8498:
8499: =item *
8500:
8501: modifystudent
8502:
8503: modify a students enrollment and identification information.
8504: The course id is resolved based on the current users environment.
8505: This means the envoking user must be a course coordinator or otherwise
8506: associated with a course.
8507:
8508: This call is essentially a wrapper for lonnet::modifyuser and
8509: lonnet::modify_student_enrollment
8510:
8511: Inputs:
8512:
8513: =over 4
8514:
8515: =item B<$udom> Students loncapa domain
8516:
8517: =item B<$uname> Students loncapa login name
8518:
8519: =item B<$uid> Students id/student number
8520:
8521: =item B<$umode> Students authentication mode
8522:
8523: =item B<$upass> Students password
8524:
8525: =item B<$first> Students first name
8526:
8527: =item B<$middle> Students middle name
8528:
8529: =item B<$last> Students last name
8530:
8531: =item B<$gene> Students generation
8532:
8533: =item B<$usec> Students section in course
8534:
8535: =item B<$end> Unix time of the roles expiration
8536:
8537: =item B<$start> Unix time of the roles start date
8538:
8539: =item B<$forceid> If defined, allow $uid to be changed
8540:
8541: =item B<$desiredhome> server to use as home server for student
8542:
8543: =back
8544:
8545: =item *
8546:
8547: modify_student_enrollment
8548:
8549: Change a students enrollment status in a class. The environment variable
8550: 'role.request.course' must be defined for this function to proceed.
8551:
8552: Inputs:
8553:
8554: =over 4
8555:
8556: =item $udom, students domain
8557:
8558: =item $uname, students name
8559:
8560: =item $uid, students user id
8561:
8562: =item $first, students first name
8563:
8564: =item $middle
8565:
8566: =item $last
8567:
8568: =item $gene
8569:
8570: =item $usec
8571:
8572: =item $end
8573:
8574: =item $start
8575:
8576: =back
8577:
8578:
8579: =item *
8580:
8581: assigncustomrole($udom,$uname,$url,$rdom,$rnam,$rolename,$end,$start) : assign
8582: custom role; give a custom role to a user for the level given by URL. Specify
8583: name and domain of role author, and role name
8584:
8585: =item *
8586:
8587: revokerole($udom,$uname,$url,$role) : revoke a role for url
8588:
8589: =item *
8590:
8591: revokecustomrole($udom,$uname,$url,$role) : revoke a custom role
8592:
8593: =back
8594:
8595: =head2 Course Infomation
8596:
8597: =over 4
8598:
8599: =item *
8600:
8601: coursedescription($courseid) : returns a hash of information about the
8602: specified course id, including all environment settings for the
8603: course, the description of the course will be in the hash under the
8604: key 'description'
8605:
8606: =item *
8607:
8608: resdata($name,$domain,$type,@which) : request for current parameter
8609: setting for a specific $type, where $type is either 'course' or 'user',
8610: @what should be a list of parameters to ask about. This routine caches
8611: answers for 5 minutes.
8612:
8613: =item *
8614:
8615: get_courseresdata($courseid, $domain) : dump the entire course resource
8616: data base, returning a hash that is keyed by the resource name and has
8617: values that are the resource value. I believe that the timestamps and
8618: versions are also returned.
8619:
8620:
8621: =back
8622:
8623: =head2 Course Modification
8624:
8625: =over 4
8626:
8627: =item *
8628:
8629: writecoursepref($courseid,%prefs) : write preferences (environment
8630: database) for a course
8631:
8632: =item *
8633:
8634: createcourse($udom,$description,$url) : make/modify course
8635:
8636: =back
8637:
8638: =head2 Resource Subroutines
8639:
8640: =over 4
8641:
8642: =item *
8643:
8644: subscribe($fname) : subscribe to a resource, returns URL if possible (probably should use repcopy instead)
8645:
8646: =item *
8647:
8648: repcopy($filename) : subscribes to the requested file, and attempts to
8649: replicate from the owning library server, Might return
8650: 'unavailable', 'not_found', 'forbidden', 'ok', or
8651: 'bad_request', also attempts to grab the metadata for the
8652: resource. Expects the local filesystem pathname
8653: (/home/httpd/html/res/....)
8654:
8655: =back
8656:
8657: =head2 Resource Information
8658:
8659: =over 4
8660:
8661: =item *
8662:
8663: EXT($varname,$symb,$udom,$uname) : evaluates and returns the value of
8664: a vairety of different possible values, $varname should be a request
8665: string, and the other parameters can be used to specify who and what
8666: one is asking about.
8667:
8668: Possible values for $varname are environment.lastname (or other item
8669: from the envirnment hash), user.name (or someother aspect about the
8670: user), resource.0.maxtries (or some other part and parameter of a
8671: resource)
8672:
8673: =item *
8674:
8675: directcondval($number) : get current value of a condition; reads from a state
8676: string
8677:
8678: =item *
8679:
8680: condval($condidx) : value of condition index based on state
8681:
8682: =item *
8683:
8684: metadata($uri,$what,$liburi,$prefix,$depthcount) : request a
8685: resource's metadata, $what should be either a specific key, or either
8686: 'keys' (to get a list of possible keys) or 'packages' to get a list of
8687: packages that this resource currently uses, the last 3 arguments are only used internally for recursive metadata.
8688:
8689: this function automatically caches all requests
8690:
8691: =item *
8692:
8693: metadata_query($query,$custom,$customshow) : make a metadata query against the
8694: network of library servers; returns file handle of where SQL and regex results
8695: will be stored for query
8696:
8697: =item *
8698:
8699: symbread($filename) : return symbolic list entry (filename argument optional);
8700: returns the data handle
8701:
8702: =item *
8703:
8704: symbverify($symb,$thisfn) : verifies that $symb actually exists and is
8705: a possible symb for the URL in $thisfn, and if is an encryypted
8706: resource that the user accessed using /enc/ returns a 1 on success, 0
8707: on failure, user must be in a course, as it assumes the existance of
8708: the course initial hash, and uses $env('request.course.id'}
8709:
8710:
8711: =item *
8712:
8713: symbclean($symb) : removes versions numbers from a symb, returns the
8714: cleaned symb
8715:
8716: =item *
8717:
8718: is_on_map($uri) : checks if the $uri is somewhere on the current
8719: course map, user must be in a course for it to work.
8720:
8721: =item *
8722:
8723: numval($salt) : return random seed value (addend for rndseed)
8724:
8725: =item *
8726:
8727: rndseed($symb,$courseid,$udom,$uname) : create a random sum; returns
8728: a random seed, all arguments are optional, if they aren't sent it uses the
8729: environment to derive them. Note: if symb isn't sent and it can't get one
8730: from &symbread it will use the current time as its return value
8731:
8732: =item *
8733:
8734: ireceipt($funame,$fudom,$fucourseid,$fusymb) : return unique,
8735: unfakeable, receipt
8736:
8737: =item *
8738:
8739: receipt() : API to ireceipt working off of env values; given out to users
8740:
8741: =item *
8742:
8743: countacc($url) : count the number of accesses to a given URL
8744:
8745: =item *
8746:
8747: 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
8748:
8749: =item *
8750:
8751: 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)
8752:
8753: =item *
8754:
8755: expirespread($uname,$udom,$stype,$usymb) : set expire date for spreadsheet
8756:
8757: =item *
8758:
8759: devalidate($symb) : devalidate temporary spreadsheet calculations,
8760: forcing spreadsheet to reevaluate the resource scores next time.
8761:
8762: =back
8763:
8764: =head2 Storing/Retreiving Data
8765:
8766: =over 4
8767:
8768: =item *
8769:
8770: store($storehash,$symb,$namespace,$udom,$uname) : stores hash permanently
8771: for this url; hashref needs to be given and should be a \%hashname; the
8772: remaining args aren't required and if they aren't passed or are '' they will
8773: be derived from the env
8774:
8775: =item *
8776:
8777: cstore($storehash,$symb,$namespace,$udom,$uname) : same as store but
8778: uses critical subroutine
8779:
8780: =item *
8781:
8782: restore($symb,$namespace,$udom,$uname) : returns hash for this symb;
8783: all args are optional
8784:
8785: =item *
8786:
8787: dumpstore($namespace,$udom,$uname,$regexp,$range) :
8788: dumps the complete (or key matching regexp) namespace into a hash
8789: ($udom, $uname, $regexp, $range are optional) for a namespace that is
8790: normally &store()ed into
8791:
8792: $range should be either an integer '100' (give me the first 100
8793: matching records)
8794: or be two integers sperated by a - with no spaces
8795: '30-50' (give me the 30th through the 50th matching
8796: records)
8797:
8798:
8799: =item *
8800:
8801: putstore($namespace,$symb,$version,$storehash,$udomain,$uname) :
8802: replaces a &store() version of data with a replacement set of data
8803: for a particular resource in a namespace passed in the $storehash hash
8804: reference
8805:
8806: =item *
8807:
8808: tmpstore($storehash,$symb,$namespace,$udom,$uname) : storage that
8809: works very similar to store/cstore, but all data is stored in a
8810: temporary location and can be reset using tmpreset, $storehash should
8811: be a hash reference, returns nothing on success
8812:
8813: =item *
8814:
8815: tmprestore($symb,$namespace,$udom,$uname) : storage that works very
8816: similar to restore, but all data is stored in a temporary location and
8817: can be reset using tmpreset. Returns a hash of values on success,
8818: error string otherwise.
8819:
8820: =item *
8821:
8822: tmpreset($symb,$namespace,$udom,$uname) : temporary storage reset,
8823: deltes all keys for $symb form the temporary storage hash.
8824:
8825: =item *
8826:
8827: get($namespace,$storearr,$udom,$uname) : returns hash with keys from array
8828: reference filled in from namesp ($udom and $uname are optional)
8829:
8830: =item *
8831:
8832: del($namespace,$storearr,$udom,$uname) : deletes keys out of array from
8833: namesp ($udom and $uname are optional)
8834:
8835: =item *
8836:
8837: dump($namespace,$udom,$uname,$regexp,$range) :
8838: dumps the complete (or key matching regexp) namespace into a hash
8839: ($udom, $uname, $regexp, $range are optional)
8840:
8841: $range should be either an integer '100' (give me the first 100
8842: matching records)
8843: or be two integers sperated by a - with no spaces
8844: '30-50' (give me the 30th through the 50th matching
8845: records)
8846: =item *
8847:
8848: inc($namespace,$store,$udom,$uname) : increments $store in $namespace.
8849: $store can be a scalar, an array reference, or if the amount to be
8850: incremented is > 1, a hash reference.
8851:
8852: ($udom and $uname are optional)
8853:
8854: =item *
8855:
8856: put($namespace,$storehash,$udom,$uname) : stores hash in namesp
8857: ($udom and $uname are optional)
8858:
8859: =item *
8860:
8861: cput($namespace,$storehash,$udom,$uname) : critical put
8862: ($udom and $uname are optional)
8863:
8864: =item *
8865:
8866: newput($namespace,$storehash,$udom,$uname) :
8867:
8868: Attempts to store the items in the $storehash, but only if they don't
8869: currently exist, if this succeeds you can be certain that you have
8870: successfully created a new key value pair in the $namespace db.
8871:
8872:
8873: Args:
8874: $namespace: name of database to store values to
8875: $storehash: hashref to store to the db
8876: $udom: (optional) domain of user containing the db
8877: $uname: (optional) name of user caontaining the db
8878:
8879: Returns:
8880: 'ok' -> succeeded in storing all keys of $storehash
8881: 'key_exists: <key>' -> failed to anything out of $storehash, as at
8882: least <key> already existed in the db (other
8883: requested keys may also already exist)
8884: 'error: <msg>' -> unable to tie the DB or other erorr occured
8885: 'con_lost' -> unable to contact request server
8886: 'refused' -> action was not allowed by remote machine
8887:
8888:
8889: =item *
8890:
8891: eget($namespace,$storearr,$udom,$uname) : returns hash with keys from array
8892: reference filled in from namesp (encrypts the return communication)
8893: ($udom and $uname are optional)
8894:
8895: =item *
8896:
8897: log($udom,$name,$home,$message) : write to permanent log for user; use
8898: critical subroutine
8899:
8900: =item *
8901:
8902: get_dom($namespace,$storearr,$udom,$uhome) : returns hash with keys from
8903: array reference filled in from namespace found in domain level on either
8904: specified domain server ($uhome) or primary domain server ($udom and $uhome are optional).
8905:
8906: =item *
8907:
8908: put_dom($namespace,$storehash,$udom,$uhome) : stores hash in namespace at
8909: domain level either on specified domain server ($uhome) or primary domain
8910: server ($udom and $uhome are optional)
8911:
8912: =back
8913:
8914: =head2 Network Status Functions
8915:
8916: =over 4
8917:
8918: =item *
8919:
8920: dirlist($uri) : return directory list based on URI
8921:
8922: =item *
8923:
8924: spareserver() : find server with least workload from spare.tab
8925:
8926: =back
8927:
8928: =head2 Apache Request
8929:
8930: =over 4
8931:
8932: =item *
8933:
8934: ssi($url,%hash) : server side include, does a complete request cycle on url to
8935: localhost, posts hash
8936:
8937: =back
8938:
8939: =head2 Data to String to Data
8940:
8941: =over 4
8942:
8943: =item *
8944:
8945: hash2str(%hash) : convert a hash into a string complete with escaping and '='
8946: and '&' separators, supports elements that are arrayrefs and hashrefs
8947:
8948: =item *
8949:
8950: hashref2str($hashref) : convert a hashref into a string complete with
8951: escaping and '=' and '&' separators, supports elements that are
8952: arrayrefs and hashrefs
8953:
8954: =item *
8955:
8956: arrayref2str($arrayref) : convert an arrayref into a string complete
8957: with escaping and '&' separators, supports elements that are arrayrefs
8958: and hashrefs
8959:
8960: =item *
8961:
8962: str2hash($string) : convert string to hash using unescaping and
8963: splitting on '=' and '&', supports elements that are arrayrefs and
8964: hashrefs
8965:
8966: =item *
8967:
8968: str2array($string) : convert string to hash using unescaping and
8969: splitting on '&', supports elements that are arrayrefs and hashrefs
8970:
8971: =back
8972:
8973: =head2 Logging Routines
8974:
8975: =over 4
8976:
8977: These routines allow one to make log messages in the lonnet.log and
8978: lonnet.perm logfiles.
8979:
8980: =item *
8981:
8982: logtouch() : make sure the logfile, lonnet.log, exists
8983:
8984: =item *
8985:
8986: logthis() : append message to the normal lonnet.log file, it gets
8987: preiodically rolled over and deleted.
8988:
8989: =item *
8990:
8991: logperm() : append a permanent message to lonnet.perm.log, this log
8992: file never gets deleted by any automated portion of the system, only
8993: messages of critical importance should go in here.
8994:
8995: =back
8996:
8997: =head2 General File Helper Routines
8998:
8999: =over 4
9000:
9001: =item *
9002:
9003: getfile($file,$caller) : two cases - requests for files in /res or in /uploaded.
9004: (a) files in /uploaded
9005: (i) If a local copy of the file exists -
9006: compares modification date of local copy with last-modified date for
9007: definitive version stored on home server for course. If local copy is
9008: stale, requests a new version from the home server and stores it.
9009: If the original has been removed from the home server, then local copy
9010: is unlinked.
9011: (ii) If local copy does not exist -
9012: requests the file from the home server and stores it.
9013:
9014: If $caller is 'uploadrep':
9015: This indicates a call from lonuploadrep.pm (PerlHeaderParserHandler phase)
9016: for request for files originally uploaded via DOCS.
9017: - returns 'ok' if fresh local copy now available, -1 otherwise.
9018:
9019: Otherwise:
9020: This indicates a call from the content generation phase of the request.
9021: - returns the entire contents of the file or -1.
9022:
9023: (b) files in /res
9024: - returns the entire contents of a file or -1;
9025: it properly subscribes to and replicates the file if neccessary.
9026:
9027:
9028: =item *
9029:
9030: stat_file($url) : $url is expected to be a /res/ or /uploaded/ style file
9031: reference
9032:
9033: returns either a stat() list of data about the file or an empty list
9034: if the file doesn't exist or couldn't find out about it (connection
9035: problems or user unknown)
9036:
9037: =item *
9038:
9039: filelocation($dir,$file) : returns file system location of a file
9040: based on URI; meant to be "fairly clean" absolute reference, $dir is a
9041: directory that relative $file lookups are to looked in ($dir of /a/dir
9042: and a file of ../bob will become /a/bob)
9043:
9044: =item *
9045:
9046: hreflocation($dir,$file) : returns file system location or a URL; same as
9047: filelocation except for hrefs
9048:
9049: =item *
9050:
9051: declutter() : declutters URLs (remove docroot, beginning slashes, 'res' etc)
9052:
9053: =back
9054:
9055: =head2 Usererfile file routines (/uploaded*)
9056:
9057: =over 4
9058:
9059: =item *
9060:
9061: userfileupload(): main rotine for putting a file in a user or course's
9062: filespace, arguments are,
9063:
9064: formname - required - this is the name of the element in $env where the
9065: filename, and the contents of the file to create/modifed exist
9066: the filename is in $env{'form.'.$formname.'.filename'} and the
9067: contents of the file is located in $env{'form.'.$formname}
9068: coursedoc - if true, store the file in the course of the active role
9069: of the current user
9070: subdir - required - subdirectory to put the file in under ../userfiles/
9071: if undefined, it will be placed in "unknown"
9072:
9073: (This routine calls clean_filename() to remove any dangerous
9074: characters from the filename, and then calls finuserfileupload() to
9075: complete the transaction)
9076:
9077: returns either the url of the uploaded file (/uploaded/....) if successful
9078: and /adm/notfound.html if unsuccessful
9079:
9080: =item *
9081:
9082: clean_filename(): routine for cleaing a filename up for storage in
9083: userfile space, argument is:
9084:
9085: filename - proposed filename
9086:
9087: returns: the new clean filename
9088:
9089: =item *
9090:
9091: finishuserfileupload(): routine that creaes and sends the file to
9092: userspace, probably shouldn't be called directly
9093:
9094: docuname: username or courseid of destination for the file
9095: docudom: domain of user/course of destination for the file
9096: formname: same as for userfileupload()
9097: fname: filename (inculding subdirectories) for the file
9098:
9099: returns either the url of the uploaded file (/uploaded/....) if successful
9100: and /adm/notfound.html if unsuccessful
9101:
9102: =item *
9103:
9104: renameuserfile(): renames an existing userfile to a new name
9105:
9106: Args:
9107: docuname: username or courseid of destination for the file
9108: docudom: domain of user/course of destination for the file
9109: old: current file name (including any subdirs under userfiles)
9110: new: desired file name (including any subdirs under userfiles)
9111:
9112: =item *
9113:
9114: mkdiruserfile(): creates a directory is a userfiles dir
9115:
9116: Args:
9117: docuname: username or courseid of destination for the file
9118: docudom: domain of user/course of destination for the file
9119: dir: dir to create (including any subdirs under userfiles)
9120:
9121: =item *
9122:
9123: removeuserfile(): removes a file that exists in userfiles
9124:
9125: Args:
9126: docuname: username or courseid of destination for the file
9127: docudom: domain of user/course of destination for the file
9128: fname: filname to delete (including any subdirs under userfiles)
9129:
9130: =item *
9131:
9132: removeuploadedurl(): convience function for removeuserfile()
9133:
9134: Args:
9135: url: a full /uploaded/... url to delete
9136:
9137: =item *
9138:
9139: get_portfile_permissions():
9140: Args:
9141: domain: domain of user or course contain the portfolio files
9142: user: name of user or num of course contain the portfolio files
9143: Returns:
9144: hashref of a dump of the proper file_permissions.db
9145:
9146:
9147: =item *
9148:
9149: get_access_controls():
9150:
9151: Args:
9152: current_permissions: the hash ref returned from get_portfile_permissions()
9153: group: (optional) the group you want the files associated with
9154: file: (optional) the file you want access info on
9155:
9156: Returns:
9157: a hash (keys are file names) of hashes containing
9158: keys are: path to file/file_name\0uniqueID:scope_end_start (see below)
9159: values are XML containing access control settings (see below)
9160:
9161: Internal notes:
9162:
9163: access controls are stored in file_permissions.db as key=value pairs.
9164: key -> path to file/file_name\0uniqueID:scope_end_start
9165: where scope -> public,guest,course,group,domains or users.
9166: end -> UNIX time for end of access (0 -> no end date)
9167: start -> UNIX time for start of access
9168:
9169: value -> XML description of access control
9170: <scope type=""> (type =1 of: public,guest,course,group,domains,users">
9171: <start></start>
9172: <end></end>
9173:
9174: <password></password> for scope type = guest
9175:
9176: <domain></domain> for scope type = course or group
9177: <number></number>
9178: <roles id="">
9179: <role></role>
9180: <access></access>
9181: <section></section>
9182: <group></group>
9183: </roles>
9184:
9185: <dom></dom> for scope type = domains
9186:
9187: <users> for scope type = users
9188: <user>
9189: <uname></uname>
9190: <udom></udom>
9191: </user>
9192: </users>
9193: </scope>
9194:
9195: Access data is also aggregated for each file in an additional key=value pair:
9196: key -> path to file/file_name\0accesscontrol
9197: value -> reference to hash
9198: hash contains key = value pairs
9199: where key = uniqueID:scope_end_start
9200: value = UNIX time record was last updated
9201:
9202: Used to improve speed of look-ups of access controls for each file.
9203:
9204: Locks on files (resulting from submission of portfolio file to a homework problem stored in array of arrays.
9205:
9206: modify_access_controls():
9207:
9208: Modifies access controls for a portfolio file
9209: Args
9210: 1. file name
9211: 2. reference to hash of required changes,
9212: 3. domain
9213: 4. username
9214: where domain,username are the domain of the portfolio owner
9215: (either a user or a course)
9216:
9217: Returns:
9218: 1. result of additions or updates ('ok' or 'error', with error message).
9219: 2. result of deletions ('ok' or 'error', with error message).
9220: 3. reference to hash of any new or updated access controls.
9221: 4. reference to hash used to map incoming IDs to uniqueIDs assigned to control.
9222: key = integer (inbound ID)
9223: value = uniqueID
9224:
9225: =back
9226:
9227: =head2 HTTP Helper Routines
9228:
9229: =over 4
9230:
9231: =item *
9232:
9233: escape() : unpack non-word characters into CGI-compatible hex codes
9234:
9235: =item *
9236:
9237: unescape() : pack CGI-compatible hex codes into actual non-word ASCII character
9238:
9239: =back
9240:
9241: =head1 PRIVATE SUBROUTINES
9242:
9243: =head2 Underlying communication routines (Shouldn't call)
9244:
9245: =over 4
9246:
9247: =item *
9248:
9249: subreply() : tries to pass a message to lonc, returns con_lost if incapable
9250:
9251: =item *
9252:
9253: reply() : uses subreply to send a message to remote machine, logs all failures
9254:
9255: =item *
9256:
9257: critical() : passes a critical message to another server; if cannot
9258: get through then place message in connection buffer directory and
9259: returns con_delayed, if incapable of saving message, returns
9260: con_failed
9261:
9262: =item *
9263:
9264: reconlonc() : tries to reconnect lonc client processes.
9265:
9266: =back
9267:
9268: =head2 Resource Access Logging
9269:
9270: =over 4
9271:
9272: =item *
9273:
9274: flushcourselogs() : flush (save) buffer logs and access logs
9275:
9276: =item *
9277:
9278: courselog($what) : save message for course in hash
9279:
9280: =item *
9281:
9282: courseacclog($what) : save message for course using &courselog(). Perform
9283: special processing for specific resource types (problems, exams, quizzes, etc).
9284:
9285: =item *
9286:
9287: goodbye() : flush course logs and log shutting down; it is called in srm.conf
9288: as a PerlChildExitHandler
9289:
9290: =back
9291:
9292: =head2 Other
9293:
9294: =over 4
9295:
9296: =item *
9297:
9298: symblist($mapname,%newhash) : update symbolic storage links
9299:
9300: =back
9301:
9302: =cut
9303:
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