1: # The LearningOnline Network
2: # TCP networking package
3: #
4: # $Id: lonnet.pm,v 1.906 2007/08/10 23:02:36 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: sub inst_directory_query {
860: my ($srch) = @_;
861: my $udom = $srch->{'srchdomain'};
862: my %results;
863: my $homeserver = &domain($udom,'primary');
864: if ($homeserver ne '') {
865: my $queryid=&reply("querysend:instdirsearch:".
866: &escape($srch->{'srchby'}).':'.
867: &escape($srch->{'srchterm'}).':'.
868: &escape($srch->{'srchtype'}),$homeserver);
869: my $host=&hostname($homeserver);
870: if ($queryid !~/^\Q$host\E\_/) {
871: &logthis('instituional directory search invalid queryid: '.$queryid.' for host: '.$homeserver.'in domain '.$udom);
872: return;
873: }
874: my $response = &get_query_reply($queryid);
875: my $maxtries = 5;
876: my $tries = 1;
877: while (($response=~/^timeout/) && ($tries < $maxtries)) {
878: $response = &get_query_reply($queryid);
879: $tries ++;
880: }
881:
882: if (!&error($response) && $response ne 'refused') {
883: my @matches = split(/\n/,$response);
884: foreach my $match (@matches) {
885: my ($key,$value) = split(/=/,$match);
886: $results{&unescape($key).':'.$udom} = &thaw_unescape($value);
887: }
888: }
889: }
890: return %results;
891: }
892:
893: sub usersearch {
894: my ($srch) = @_;
895: my $dom = $srch->{'srchdomain'};
896: my %results;
897: my %libserv = &all_library();
898: my $query = 'usersearch';
899: foreach my $tryserver (keys(%libserv)) {
900: if (&host_domain($tryserver) eq $dom) {
901: my $host=&hostname($tryserver);
902: my $queryid=
903: &reply("querysend:".&escape($query).':'.&escape($dom).':'.
904: &escape($srch->{'srchby'}).'%%'.
905: &escape($srch->{'srchtype'}).':'.
906: &escape($srch->{'srchterm'}),$tryserver);
907: if ($queryid !~/^\Q$host\E\_/) {
908: &logthis('usersearch: invalid queryid: '.$queryid.' for host: '.$host.'in domain '.$dom.' and server: '.$tryserver);
909: next;
910: }
911: my $reply = &get_query_reply($queryid);
912: my $maxtries = 1;
913: my $tries = 1;
914: while (($reply=~/^timeout/) && ($tries < $maxtries)) {
915: $reply = &get_query_reply($queryid);
916: $tries ++;
917: }
918: if ( ($reply =~/^timeout/) || ($reply =~/^error/) ) {
919: &logthis('usersrch error: '.$reply.' for '.$dom.' - searching for : '.$srch->{'srchterm'}.' by '.$srch->{'srchby'}.' ('.$srch->{'srchtype'}.') - maxtries: '.$maxtries.' tries: '.$tries);
920: } else {
921: my @matches = split(/&/,$reply);
922: foreach my $match (@matches) {
923: my @items = split(/:/,$match);
924: my ($uname,$udom,%userhash);
925: foreach my $entry (@items) {
926: my ($key,$value) = split(/=/,$entry);
927: $key = &unescape($key);
928: $value = &unescape($value);
929: $userhash{$key} = $value;
930: if ($key eq 'username') {
931: $uname = $value;
932: } elsif ($key eq 'domain') {
933: $udom = $value;
934: }
935: }
936: $results{$uname.':'.$udom} = \%userhash;
937: }
938: }
939: }
940: }
941: return %results;
942: }
943:
944: # --------------------------------------------------- Assign a key to a student
945:
946: sub assign_access_key {
947: #
948: # a valid key looks like uname:udom#comments
949: # comments are being appended
950: #
951: my ($ckey,$kdom,$knum,$cdom,$cnum,$udom,$uname,$logentry)=@_;
952: $kdom=
953: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($kdom));
954: $knum=
955: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($knum));
956: $cdom=
957: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
958: $cnum=
959: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
960: $udom=$env{'user.name'} unless (defined($udom));
961: $uname=$env{'user.domain'} unless (defined($uname));
962: my %existing=&get('accesskeys',[$ckey],$kdom,$knum);
963: if (($existing{$ckey}=~/^\#(.*)$/) || # - new key
964: ($existing{$ckey}=~/^\Q$uname\E\:\Q$udom\E\#(.*)$/)) {
965: # assigned to this person
966: # - this should not happen,
967: # unless something went wrong
968: # the first time around
969: # ready to assign
970: $logentry=$1.'; '.$logentry;
971: if (&put('accesskeys',{$ckey=>$uname.':'.$udom.'#'.$logentry},
972: $kdom,$knum) eq 'ok') {
973: # key now belongs to user
974: my $envkey='key.'.$cdom.'_'.$cnum;
975: if (&put('environment',{$envkey => $ckey}) eq 'ok') {
976: &appenv('environment.'.$envkey => $ckey);
977: return 'ok';
978: } else {
979: return
980: 'error: Count not permanently assign key, will need to be re-entered later.';
981: }
982: } else {
983: return 'error: Could not assign key, try again later.';
984: }
985: } elsif (!$existing{$ckey}) {
986: # the key does not exist
987: return 'error: The key does not exist';
988: } else {
989: # the key is somebody else's
990: return 'error: The key is already in use';
991: }
992: }
993:
994: # ------------------------------------------ put an additional comment on a key
995:
996: sub comment_access_key {
997: #
998: # a valid key looks like uname:udom#comments
999: # comments are being appended
1000: #
1001: my ($ckey,$cdom,$cnum,$logentry)=@_;
1002: $cdom=
1003: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
1004: $cnum=
1005: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
1006: my %existing=&get('accesskeys',[$ckey],$cdom,$cnum);
1007: if ($existing{$ckey}) {
1008: $existing{$ckey}.='; '.$logentry;
1009: # ready to assign
1010: if (&put('accesskeys',{$ckey=>$existing{$ckey}},
1011: $cdom,$cnum) eq 'ok') {
1012: return 'ok';
1013: } else {
1014: return 'error: Count not store comment.';
1015: }
1016: } else {
1017: # the key does not exist
1018: return 'error: The key does not exist';
1019: }
1020: }
1021:
1022: # ------------------------------------------------------ Generate a set of keys
1023:
1024: sub generate_access_keys {
1025: my ($number,$cdom,$cnum,$logentry)=@_;
1026: $cdom=
1027: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
1028: $cnum=
1029: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
1030: unless (&allowed('mky',$cdom)) { return 0; }
1031: unless (($cdom) && ($cnum)) { return 0; }
1032: if ($number>10000) { return 0; }
1033: sleep(2); # make sure don't get same seed twice
1034: srand(time()^($$+($$<<15))); # from "Programming Perl"
1035: my $total=0;
1036: for (my $i=1;$i<=$number;$i++) {
1037: my $newkey=sprintf("%lx",int(100000*rand)).'-'.
1038: sprintf("%lx",int(100000*rand)).'-'.
1039: sprintf("%lx",int(100000*rand));
1040: $newkey=~s/1/g/g; # folks mix up 1 and l
1041: $newkey=~s/0/h/g; # and also 0 and O
1042: my %existing=&get('accesskeys',[$newkey],$cdom,$cnum);
1043: if ($existing{$newkey}) {
1044: $i--;
1045: } else {
1046: if (&put('accesskeys',
1047: { $newkey => '# generated '.localtime().
1048: ' by '.$env{'user.name'}.'@'.$env{'user.domain'}.
1049: '; '.$logentry },
1050: $cdom,$cnum) eq 'ok') {
1051: $total++;
1052: }
1053: }
1054: }
1055: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},
1056: 'Generated '.$total.' keys for '.$cnum.' at '.$cdom);
1057: return $total;
1058: }
1059:
1060: # ------------------------------------------------------- Validate an accesskey
1061:
1062: sub validate_access_key {
1063: my ($ckey,$cdom,$cnum,$udom,$uname)=@_;
1064: $cdom=
1065: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
1066: $cnum=
1067: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
1068: $udom=$env{'user.domain'} unless (defined($udom));
1069: $uname=$env{'user.name'} unless (defined($uname));
1070: my %existing=&get('accesskeys',[$ckey],$cdom,$cnum);
1071: return ($existing{$ckey}=~/^\Q$uname\E\:\Q$udom\E\#/);
1072: }
1073:
1074: # ------------------------------------- Find the section of student in a course
1075: sub devalidate_getsection_cache {
1076: my ($udom,$unam,$courseid)=@_;
1077: my $hashid="$udom:$unam:$courseid";
1078: &devalidate_cache_new('getsection',$hashid);
1079: }
1080:
1081: sub courseid_to_courseurl {
1082: my ($courseid) = @_;
1083: #already url style courseid
1084: return $courseid if ($courseid =~ m{^/});
1085:
1086: if (exists($env{'course.'.$courseid.'.num'})) {
1087: my $cnum = $env{'course.'.$courseid.'.num'};
1088: my $cdom = $env{'course.'.$courseid.'.domain'};
1089: return "/$cdom/$cnum";
1090: }
1091:
1092: my %courseinfo=&Apache::lonnet::coursedescription($courseid);
1093: if (exists($courseinfo{'num'})) {
1094: return "/$courseinfo{'domain'}/$courseinfo{'num'}";
1095: }
1096:
1097: return undef;
1098: }
1099:
1100: sub getsection {
1101: my ($udom,$unam,$courseid)=@_;
1102: my $cachetime=1800;
1103:
1104: my $hashid="$udom:$unam:$courseid";
1105: my ($result,$cached)=&is_cached_new('getsection',$hashid);
1106: if (defined($cached)) { return $result; }
1107:
1108: my %Pending;
1109: my %Expired;
1110: #
1111: # Each role can either have not started yet (pending), be active,
1112: # or have expired.
1113: #
1114: # If there is an active role, we are done.
1115: #
1116: # If there is more than one role which has not started yet,
1117: # choose the one which will start sooner
1118: # If there is one role which has not started yet, return it.
1119: #
1120: # If there is more than one expired role, choose the one which ended last.
1121: # If there is a role which has expired, return it.
1122: #
1123: $courseid = &courseid_to_courseurl($courseid);
1124: my %roleshash = &dump('roles',$udom,$unam,$courseid);
1125: foreach my $key (keys(%roleshash)) {
1126: next if ($key !~/^\Q$courseid\E(?:\/)*(\w+)*\_st$/);
1127: my $section=$1;
1128: if ($key eq $courseid.'_st') { $section=''; }
1129: my ($dummy,$end,$start)=split(/\_/,&unescape($roleshash{$key}));
1130: my $now=time;
1131: if (defined($end) && $end && ($now > $end)) {
1132: $Expired{$end}=$section;
1133: next;
1134: }
1135: if (defined($start) && $start && ($now < $start)) {
1136: $Pending{$start}=$section;
1137: next;
1138: }
1139: return &do_cache_new('getsection',$hashid,$section,$cachetime);
1140: }
1141: #
1142: # Presumedly there will be few matching roles from the above
1143: # loop and the sorting time will be negligible.
1144: if (scalar(keys(%Pending))) {
1145: my ($time) = sort {$a <=> $b} keys(%Pending);
1146: return &do_cache_new('getsection',$hashid,$Pending{$time},$cachetime);
1147: }
1148: if (scalar(keys(%Expired))) {
1149: my @sorted = sort {$a <=> $b} keys(%Expired);
1150: my $time = pop(@sorted);
1151: return &do_cache_new('getsection',$hashid,$Expired{$time},$cachetime);
1152: }
1153: return &do_cache_new('getsection',$hashid,'-1',$cachetime);
1154: }
1155:
1156: sub save_cache {
1157: &purge_remembered();
1158: #&Apache::loncommon::validate_page();
1159: undef(%env);
1160: undef($env_loaded);
1161: }
1162:
1163: my $to_remember=-1;
1164: my %remembered;
1165: my %accessed;
1166: my $kicks=0;
1167: my $hits=0;
1168: sub make_key {
1169: my ($name,$id) = @_;
1170: if (length($id) > 65
1171: && length(&escape($id)) > 200) {
1172: $id=length($id).':'.&Digest::MD5::md5_hex($id);
1173: }
1174: return &escape($name.':'.$id);
1175: }
1176:
1177: sub devalidate_cache_new {
1178: my ($name,$id,$debug) = @_;
1179: if ($debug) { &Apache::lonnet::logthis("deleting $name:$id"); }
1180: $id=&make_key($name,$id);
1181: $memcache->delete($id);
1182: delete($remembered{$id});
1183: delete($accessed{$id});
1184: }
1185:
1186: sub is_cached_new {
1187: my ($name,$id,$debug) = @_;
1188: $id=&make_key($name,$id);
1189: if (exists($remembered{$id})) {
1190: if ($debug) { &Apache::lonnet::logthis("Earyl return $id of $remembered{$id} "); }
1191: $accessed{$id}=[&gettimeofday()];
1192: $hits++;
1193: return ($remembered{$id},1);
1194: }
1195: my $value = $memcache->get($id);
1196: if (!(defined($value))) {
1197: if ($debug) { &Apache::lonnet::logthis("getting $id is not defined"); }
1198: return (undef,undef);
1199: }
1200: if ($value eq '__undef__') {
1201: if ($debug) { &Apache::lonnet::logthis("getting $id is __undef__"); }
1202: $value=undef;
1203: }
1204: &make_room($id,$value,$debug);
1205: if ($debug) { &Apache::lonnet::logthis("getting $id is $value"); }
1206: return ($value,1);
1207: }
1208:
1209: sub do_cache_new {
1210: my ($name,$id,$value,$time,$debug) = @_;
1211: $id=&make_key($name,$id);
1212: my $setvalue=$value;
1213: if (!defined($setvalue)) {
1214: $setvalue='__undef__';
1215: }
1216: if (!defined($time) ) {
1217: $time=600;
1218: }
1219: if ($debug) { &Apache::lonnet::logthis("Setting $id to $value"); }
1220: if (!($memcache->set($id,$setvalue,$time))) {
1221: &logthis("caching of id -> $id failed");
1222: }
1223: # need to make a copy of $value
1224: #&make_room($id,$value,$debug);
1225: return $value;
1226: }
1227:
1228: sub make_room {
1229: my ($id,$value,$debug)=@_;
1230: $remembered{$id}=$value;
1231: if ($to_remember<0) { return; }
1232: $accessed{$id}=[&gettimeofday()];
1233: if (scalar(keys(%remembered)) <= $to_remember) { return; }
1234: my $to_kick;
1235: my $max_time=0;
1236: foreach my $other (keys(%accessed)) {
1237: if (&tv_interval($accessed{$other}) > $max_time) {
1238: $to_kick=$other;
1239: $max_time=&tv_interval($accessed{$other});
1240: }
1241: }
1242: delete($remembered{$to_kick});
1243: delete($accessed{$to_kick});
1244: $kicks++;
1245: if ($debug) { &logthis("kicking $to_kick $max_time $kicks\n"); }
1246: return;
1247: }
1248:
1249: sub purge_remembered {
1250: #&logthis("Tossing ".scalar(keys(%remembered)));
1251: #&logthis(sprintf("%-20s is %s",'%remembered',length(&freeze(\%remembered))));
1252: undef(%remembered);
1253: undef(%accessed);
1254: }
1255: # ------------------------------------- Read an entry from a user's environment
1256:
1257: sub userenvironment {
1258: my ($udom,$unam,@what)=@_;
1259: my %returnhash=();
1260: my @answer=split(/\&/,
1261: &reply('get:'.$udom.':'.$unam.':environment:'.join('&',@what),
1262: &homeserver($unam,$udom)));
1263: my $i;
1264: for ($i=0;$i<=$#what;$i++) {
1265: $returnhash{$what[$i]}=&unescape($answer[$i]);
1266: }
1267: return %returnhash;
1268: }
1269:
1270: # ---------------------------------------------------------- Get a studentphoto
1271: sub studentphoto {
1272: my ($udom,$unam,$ext) = @_;
1273: my $home=&Apache::lonnet::homeserver($unam,$udom);
1274: if (defined($env{'request.course.id'})) {
1275: if ($env{'course.'.$env{'request.course.id'}.'.internal.showphoto'}) {
1276: if ($udom eq $env{'course.'.$env{'request.course.id'}.'.domain'}) {
1277: return(&retrievestudentphoto($udom,$unam,$ext));
1278: } else {
1279: my ($result,$perm_reqd)=
1280: &Apache::lonnet::auto_photo_permission($unam,$udom);
1281: if ($result eq 'ok') {
1282: if (!($perm_reqd eq 'yes')) {
1283: return(&retrievestudentphoto($udom,$unam,$ext));
1284: }
1285: }
1286: }
1287: }
1288: } else {
1289: my ($result,$perm_reqd) =
1290: &Apache::lonnet::auto_photo_permission($unam,$udom);
1291: if ($result eq 'ok') {
1292: if (!($perm_reqd eq 'yes')) {
1293: return(&retrievestudentphoto($udom,$unam,$ext));
1294: }
1295: }
1296: }
1297: return '/adm/lonKaputt/lonlogo_broken.gif';
1298: }
1299:
1300: sub retrievestudentphoto {
1301: my ($udom,$unam,$ext,$type) = @_;
1302: my $home=&Apache::lonnet::homeserver($unam,$udom);
1303: my $ret=&Apache::lonnet::reply("studentphoto:$udom:$unam:$ext:$type",$home);
1304: if ($ret eq 'ok') {
1305: my $url="/uploaded/$udom/$unam/internal/studentphoto.$ext";
1306: if ($type eq 'thumbnail') {
1307: $url="/uploaded/$udom/$unam/internal/studentphoto_tn.$ext";
1308: }
1309: my $tokenurl=&Apache::lonnet::tokenwrapper($url);
1310: return $tokenurl;
1311: } else {
1312: if ($type eq 'thumbnail') {
1313: return '/adm/lonKaputt/genericstudent_tn.gif';
1314: } else {
1315: return '/adm/lonKaputt/lonlogo_broken.gif';
1316: }
1317: }
1318: }
1319:
1320: # -------------------------------------------------------------------- New chat
1321:
1322: sub chatsend {
1323: my ($newentry,$anon,$group)=@_;
1324: my $cnum=$env{'course.'.$env{'request.course.id'}.'.num'};
1325: my $cdom=$env{'course.'.$env{'request.course.id'}.'.domain'};
1326: my $chome=$env{'course.'.$env{'request.course.id'}.'.home'};
1327: &reply('chatsend:'.$cdom.':'.$cnum.':'.
1328: &escape($env{'user.domain'}.':'.$env{'user.name'}.':'.$anon.':'.
1329: &escape($newentry)).':'.$group,$chome);
1330: }
1331:
1332: # ------------------------------------------ Find current version of a resource
1333:
1334: sub getversion {
1335: my $fname=&clutter(shift);
1336: unless ($fname=~/^\/res\//) { return -1; }
1337: return ¤tversion(&filelocation('',$fname));
1338: }
1339:
1340: sub currentversion {
1341: my $fname=shift;
1342: my ($result,$cached)=&is_cached_new('resversion',$fname);
1343: if (defined($cached)) { return $result; }
1344: my $author=$fname;
1345: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
1346: my ($udom,$uname)=split(/\//,$author);
1347: my $home=homeserver($uname,$udom);
1348: if ($home eq 'no_host') {
1349: return -1;
1350: }
1351: my $answer=reply("currentversion:$fname",$home);
1352: if (($answer eq 'con_lost') || ($answer eq 'rejected')) {
1353: return -1;
1354: }
1355: return &do_cache_new('resversion',$fname,$answer,600);
1356: }
1357:
1358: # ----------------------------- Subscribe to a resource, return URL if possible
1359:
1360: sub subscribe {
1361: my $fname=shift;
1362: if ($fname=~/\/(aboutme|syllabus|bulletinboard|smppg)$/) { return ''; }
1363: $fname=~s/[\n\r]//g;
1364: my $author=$fname;
1365: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
1366: my ($udom,$uname)=split(/\//,$author);
1367: my $home=homeserver($uname,$udom);
1368: if ($home eq 'no_host') {
1369: return 'not_found';
1370: }
1371: my $answer=reply("sub:$fname",$home);
1372: if (($answer eq 'con_lost') || ($answer eq 'rejected')) {
1373: $answer.=' by '.$home;
1374: }
1375: return $answer;
1376: }
1377:
1378: # -------------------------------------------------------------- Replicate file
1379:
1380: sub repcopy {
1381: my $filename=shift;
1382: $filename=~s/\/+/\//g;
1383: if ($filename=~m|^/home/httpd/html/adm/|) { return 'ok'; }
1384: if ($filename=~m|^/home/httpd/html/lonUsers/|) { return 'ok'; }
1385: if ($filename=~m|^/home/httpd/html/userfiles/| or
1386: $filename=~m -^/*(uploaded|editupload)/-) {
1387: return &repcopy_userfile($filename);
1388: }
1389: $filename=~s/[\n\r]//g;
1390: my $transname="$filename.in.transfer";
1391: # FIXME: this should flock
1392: if ((-e $filename) || (-e $transname)) { return 'ok'; }
1393: my $remoteurl=subscribe($filename);
1394: if ($remoteurl =~ /^con_lost by/) {
1395: &logthis("Subscribe returned $remoteurl: $filename");
1396: return 'unavailable';
1397: } elsif ($remoteurl eq 'not_found') {
1398: #&logthis("Subscribe returned not_found: $filename");
1399: return 'not_found';
1400: } elsif ($remoteurl =~ /^rejected by/) {
1401: &logthis("Subscribe returned $remoteurl: $filename");
1402: return 'forbidden';
1403: } elsif ($remoteurl eq 'directory') {
1404: return 'ok';
1405: } else {
1406: my $author=$filename;
1407: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
1408: my ($udom,$uname)=split(/\//,$author);
1409: my $home=homeserver($uname,$udom);
1410: unless ($home eq $perlvar{'lonHostID'}) {
1411: my @parts=split(/\//,$filename);
1412: my $path="/$parts[1]/$parts[2]/$parts[3]/$parts[4]";
1413: if ($path ne "$perlvar{'lonDocRoot'}/res") {
1414: &logthis("Malconfiguration for replication: $filename");
1415: return 'bad_request';
1416: }
1417: my $count;
1418: for ($count=5;$count<$#parts;$count++) {
1419: $path.="/$parts[$count]";
1420: if ((-e $path)!=1) {
1421: mkdir($path,0777);
1422: }
1423: }
1424: my $ua=new LWP::UserAgent;
1425: my $request=new HTTP::Request('GET',"$remoteurl");
1426: my $response=$ua->request($request,$transname);
1427: if ($response->is_error()) {
1428: unlink($transname);
1429: my $message=$response->status_line;
1430: &logthis("<font color=\"blue\">WARNING:"
1431: ." LWP get: $message: $filename</font>");
1432: return 'unavailable';
1433: } else {
1434: if ($remoteurl!~/\.meta$/) {
1435: my $mrequest=new HTTP::Request('GET',$remoteurl.'.meta');
1436: my $mresponse=$ua->request($mrequest,$filename.'.meta');
1437: if ($mresponse->is_error()) {
1438: unlink($filename.'.meta');
1439: &logthis(
1440: "<font color=\"yellow\">INFO: No metadata: $filename</font>");
1441: }
1442: }
1443: rename($transname,$filename);
1444: return 'ok';
1445: }
1446: }
1447: }
1448: }
1449:
1450: # ------------------------------------------------ Get server side include body
1451: sub ssi_body {
1452: my ($filelink,%form)=@_;
1453: if (! exists($form{'LONCAPA_INTERNAL_no_discussion'})) {
1454: $form{'LONCAPA_INTERNAL_no_discussion'}='true';
1455: }
1456: my $output=($filelink=~/^http\:/?&externalssi($filelink):
1457: &ssi($filelink,%form));
1458: $output=~s|//(\s*<!--)? BEGIN LON-CAPA Internal.+?// END LON-CAPA Internal\s*(-->)?\s||gs;
1459: $output=~s/^.*?\<body[^\>]*\>//si;
1460: $output=~s/(.*)\<\/body\s*\>.*?$/$1/si;
1461: return $output;
1462: }
1463:
1464: # --------------------------------------------------------- Server Side Include
1465:
1466: sub absolute_url {
1467: my ($host_name) = @_;
1468: my $protocol = ($ENV{'SERVER_PORT'} == 443?'https://':'http://');
1469: if ($host_name eq '') {
1470: $host_name = $ENV{'SERVER_NAME'};
1471: }
1472: return $protocol.$host_name;
1473: }
1474:
1475: sub ssi {
1476:
1477: my ($fn,%form)=@_;
1478:
1479: my $ua=new LWP::UserAgent;
1480:
1481: my $request;
1482:
1483: $form{'no_update_last_known'}=1;
1484: &Apache::lonenc::check_encrypt(\$fn);
1485: if (%form) {
1486: $request=new HTTP::Request('POST',&absolute_url().$fn);
1487: $request->content(join('&',map { &escape($_).'='.&escape($form{$_}) } keys %form));
1488: } else {
1489: $request=new HTTP::Request('GET',&absolute_url().$fn);
1490: }
1491:
1492: $request->header(Cookie => $ENV{'HTTP_COOKIE'});
1493: my $response=$ua->request($request);
1494:
1495: return $response->content;
1496: }
1497:
1498: sub externalssi {
1499: my ($url)=@_;
1500: my $ua=new LWP::UserAgent;
1501: my $request=new HTTP::Request('GET',$url);
1502: my $response=$ua->request($request);
1503: return $response->content;
1504: }
1505:
1506: # -------------------------------- Allow a /uploaded/ URI to be vouched for
1507:
1508: sub allowuploaded {
1509: my ($srcurl,$url)=@_;
1510: $url=&clutter(&declutter($url));
1511: my $dir=$url;
1512: $dir=~s/\/[^\/]+$//;
1513: my %httpref=();
1514: my $httpurl=&hreflocation('',$url);
1515: $httpref{'httpref.'.$httpurl}=$srcurl;
1516: &Apache::lonnet::appenv(%httpref);
1517: }
1518:
1519: # --------- File operations in /home/httpd/html/userfiles/$domain/1/2/3/$course
1520: # input: action, courseID, current domain, intended
1521: # path to file, source of file, instruction to parse file for objects,
1522: # ref to hash for embedded objects,
1523: # ref to hash for codebase of java objects.
1524: #
1525: # output: url to file (if action was uploaddoc),
1526: # ok if successful, or diagnostic message otherwise (if action was propagate or copy)
1527: #
1528: # Allows directory structure to be used within lonUsers/../userfiles/ for a
1529: # course.
1530: #
1531: # action = propagate - /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
1532: # will be copied to /home/httpd/lonUsers/1/2/3/$course/userfiles in
1533: # course's home server.
1534: #
1535: # action = copy - /home/httpd/html/userfiles/$domain/1/2/3/$course/$file will
1536: # be copied from $source (current location) to
1537: # /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
1538: # and will then be copied to
1539: # /home/httpd/lonUsers/$domain/1/2/3/$course/userfiles/$file in
1540: # course's home server.
1541: #
1542: # action = uploaddoc - /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
1543: # will be retrived from $env{form.uploaddoc} (from DOCS interface) to
1544: # /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
1545: # and will then be copied to /home/httpd/lonUsers/1/2/3/$course/userfiles/$file
1546: # in course's home server.
1547: #
1548:
1549: sub process_coursefile {
1550: my ($action,$docuname,$docudom,$file,$source,$parser,$allfiles,$codebase)=@_;
1551: my $fetchresult;
1552: my $home=&homeserver($docuname,$docudom);
1553: if ($action eq 'propagate') {
1554: $fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
1555: $home);
1556: } else {
1557: my $fpath = '';
1558: my $fname = $file;
1559: ($fpath,$fname) = ($file =~ m|^(.*)/([^/]+)$|);
1560: $fpath=$docudom.'/'.$docuname.'/'.$fpath;
1561: my $filepath = &build_filepath($fpath);
1562: if ($action eq 'copy') {
1563: if ($source eq '') {
1564: $fetchresult = 'no source file';
1565: return $fetchresult;
1566: } else {
1567: my $destination = $filepath.'/'.$fname;
1568: rename($source,$destination);
1569: $fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
1570: $home);
1571: }
1572: } elsif ($action eq 'uploaddoc') {
1573: open(my $fh,'>'.$filepath.'/'.$fname);
1574: print $fh $env{'form.'.$source};
1575: close($fh);
1576: if ($parser eq 'parse') {
1577: my $parse_result = &extract_embedded_items($filepath,$fname,$allfiles,$codebase);
1578: unless ($parse_result eq 'ok') {
1579: &logthis('Failed to parse '.$filepath.'/'.$fname.' for embedded media: '.$parse_result);
1580: }
1581: }
1582: $fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
1583: $home);
1584: if ($fetchresult eq 'ok') {
1585: return '/uploaded/'.$fpath.'/'.$fname;
1586: } else {
1587: &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$file.
1588: ' to host '.$home.': '.$fetchresult);
1589: return '/adm/notfound.html';
1590: }
1591: }
1592: }
1593: unless ( $fetchresult eq 'ok') {
1594: &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$file.
1595: ' to host '.$home.': '.$fetchresult);
1596: }
1597: return $fetchresult;
1598: }
1599:
1600: sub build_filepath {
1601: my ($fpath) = @_;
1602: my $filepath=$perlvar{'lonDocRoot'}.'/userfiles';
1603: unless ($fpath eq '') {
1604: my @parts=split('/',$fpath);
1605: foreach my $part (@parts) {
1606: $filepath.= '/'.$part;
1607: if ((-e $filepath)!=1) {
1608: mkdir($filepath,0777);
1609: }
1610: }
1611: }
1612: return $filepath;
1613: }
1614:
1615: sub store_edited_file {
1616: my ($primary_url,$content,$docudom,$docuname,$fetchresult) = @_;
1617: my $file = $primary_url;
1618: $file =~ s#^/uploaded/$docudom/$docuname/##;
1619: my $fpath = '';
1620: my $fname = $file;
1621: ($fpath,$fname) = ($file =~ m|^(.*)/([^/]+)$|);
1622: $fpath=$docudom.'/'.$docuname.'/'.$fpath;
1623: my $filepath = &build_filepath($fpath);
1624: open(my $fh,'>'.$filepath.'/'.$fname);
1625: print $fh $content;
1626: close($fh);
1627: my $home=&homeserver($docuname,$docudom);
1628: $$fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
1629: $home);
1630: if ($$fetchresult eq 'ok') {
1631: return '/uploaded/'.$fpath.'/'.$fname;
1632: } else {
1633: &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$file.
1634: ' to host '.$home.': '.$$fetchresult);
1635: return '/adm/notfound.html';
1636: }
1637: }
1638:
1639: sub clean_filename {
1640: my ($fname,$args)=@_;
1641: # Replace Windows backslashes by forward slashes
1642: $fname=~s/\\/\//g;
1643: if (!$args->{'keep_path'}) {
1644: # Get rid of everything but the actual filename
1645: $fname=~s/^.*\/([^\/]+)$/$1/;
1646: }
1647: # Replace spaces by underscores
1648: $fname=~s/\s+/\_/g;
1649: # Replace all other weird characters by nothing
1650: $fname=~s{[^/\w\.\-]}{}g;
1651: # Replace all .\d. sequences with _\d. so they no longer look like version
1652: # numbers
1653: $fname=~s/\.(\d+)(?=\.)/_$1/g;
1654: return $fname;
1655: }
1656:
1657: # --------------- Take an uploaded file and put it into the userfiles directory
1658: # input: $formname - the contents of the file are in $env{"form.$formname"}
1659: # the desired filenam is in $env{"form.$formname.filename"}
1660: # $coursedoc - if true up to the current course
1661: # if false
1662: # $subdir - directory in userfile to store the file into
1663: # $parser - instruction to parse file for objects ($parser = parse)
1664: # $allfiles - reference to hash for embedded objects
1665: # $codebase - reference to hash for codebase of java objects
1666: # $desuname - username for permanent storage of uploaded file
1667: # $dsetudom - domain for permanaent storage of uploaded file
1668: # $thumbwidth - width (pixels) of thumbnail to make for uploaded image
1669: # $thumbheight - height (pixels) of thumbnail to make for uploaded image
1670: #
1671: # output: url of file in userspace, or error: <message>
1672: # or /adm/notfound.html if failure to upload occurse
1673:
1674:
1675: sub userfileupload {
1676: my ($formname,$coursedoc,$subdir,$parser,$allfiles,$codebase,$destuname,
1677: $destudom,$thumbwidth,$thumbheight)=@_;
1678: if (!defined($subdir)) { $subdir='unknown'; }
1679: my $fname=$env{'form.'.$formname.'.filename'};
1680: $fname=&clean_filename($fname);
1681: # See if there is anything left
1682: unless ($fname) { return 'error: no uploaded file'; }
1683: chop($env{'form.'.$formname});
1684: if (($formname eq 'screenshot') && ($subdir eq 'helprequests')) { #files uploaded to help request form are handled differently
1685: my $now = time;
1686: my $filepath = 'tmp/helprequests/'.$now;
1687: my @parts=split(/\//,$filepath);
1688: my $fullpath = $perlvar{'lonDaemons'};
1689: for (my $i=0;$i<@parts;$i++) {
1690: $fullpath .= '/'.$parts[$i];
1691: if ((-e $fullpath)!=1) {
1692: mkdir($fullpath,0777);
1693: }
1694: }
1695: open(my $fh,'>'.$fullpath.'/'.$fname);
1696: print $fh $env{'form.'.$formname};
1697: close($fh);
1698: return $fullpath.'/'.$fname;
1699: } elsif (($formname eq 'coursecreatorxml') && ($subdir eq 'batchupload')) { #files uploaded to create course page are handled differently
1700: my $filepath = 'tmp/addcourse/'.$destudom.'/web/'.$env{'user.name'}.
1701: '_'.$env{'user.domain'}.'/pending';
1702: my @parts=split(/\//,$filepath);
1703: my $fullpath = $perlvar{'lonDaemons'};
1704: for (my $i=0;$i<@parts;$i++) {
1705: $fullpath .= '/'.$parts[$i];
1706: if ((-e $fullpath)!=1) {
1707: mkdir($fullpath,0777);
1708: }
1709: }
1710: open(my $fh,'>'.$fullpath.'/'.$fname);
1711: print $fh $env{'form.'.$formname};
1712: close($fh);
1713: return $fullpath.'/'.$fname;
1714: }
1715:
1716: # Create the directory if not present
1717: $fname="$subdir/$fname";
1718: if ($coursedoc) {
1719: my $docuname=$env{'course.'.$env{'request.course.id'}.'.num'};
1720: my $docudom=$env{'course.'.$env{'request.course.id'}.'.domain'};
1721: if ($env{'form.folder'} =~ m/^(default|supplemental)/) {
1722: return &finishuserfileupload($docuname,$docudom,
1723: $formname,$fname,$parser,$allfiles,
1724: $codebase,$thumbwidth,$thumbheight);
1725: } else {
1726: $fname=$env{'form.folder'}.'/'.$fname;
1727: return &process_coursefile('uploaddoc',$docuname,$docudom,
1728: $fname,$formname,$parser,
1729: $allfiles,$codebase);
1730: }
1731: } elsif (defined($destuname)) {
1732: my $docuname=$destuname;
1733: my $docudom=$destudom;
1734: return &finishuserfileupload($docuname,$docudom,$formname,$fname,
1735: $parser,$allfiles,$codebase,
1736: $thumbwidth,$thumbheight);
1737:
1738: } else {
1739: my $docuname=$env{'user.name'};
1740: my $docudom=$env{'user.domain'};
1741: if (exists($env{'form.group'})) {
1742: $docuname=$env{'course.'.$env{'request.course.id'}.'.num'};
1743: $docudom=$env{'course.'.$env{'request.course.id'}.'.domain'};
1744: }
1745: return &finishuserfileupload($docuname,$docudom,$formname,$fname,
1746: $parser,$allfiles,$codebase,
1747: $thumbwidth,$thumbheight);
1748: }
1749: }
1750:
1751: sub finishuserfileupload {
1752: my ($docuname,$docudom,$formname,$fname,$parser,$allfiles,$codebase,
1753: $thumbwidth,$thumbheight) = @_;
1754: my $path=$docudom.'/'.$docuname.'/';
1755: my $filepath=$perlvar{'lonDocRoot'};
1756: my ($fnamepath,$file,$fetchthumb);
1757: $file=$fname;
1758: if ($fname=~m|/|) {
1759: ($fnamepath,$file) = ($fname =~ m|^(.*)/([^/]+)$|);
1760: $path.=$fnamepath.'/';
1761: }
1762: my @parts=split(/\//,$filepath.'/userfiles/'.$path);
1763: my $count;
1764: for ($count=4;$count<=$#parts;$count++) {
1765: $filepath.="/$parts[$count]";
1766: if ((-e $filepath)!=1) {
1767: mkdir($filepath,0777);
1768: }
1769: }
1770: # Save the file
1771: {
1772: if (!open(FH,'>'.$filepath.'/'.$file)) {
1773: &logthis('Failed to create '.$filepath.'/'.$file);
1774: print STDERR ('Failed to create '.$filepath.'/'.$file."\n");
1775: return '/adm/notfound.html';
1776: }
1777: if (!print FH ($env{'form.'.$formname})) {
1778: &logthis('Failed to write to '.$filepath.'/'.$file);
1779: print STDERR ('Failed to write to '.$filepath.'/'.$file."\n");
1780: return '/adm/notfound.html';
1781: }
1782: close(FH);
1783: }
1784: if ($parser eq 'parse') {
1785: my $parse_result = &extract_embedded_items($filepath,$file,$allfiles,
1786: $codebase);
1787: unless ($parse_result eq 'ok') {
1788: &logthis('Failed to parse '.$filepath.$file.
1789: ' for embedded media: '.$parse_result);
1790: }
1791: }
1792: if (($thumbwidth =~ /^\d+$/) && ($thumbheight =~ /^\d+$/)) {
1793: my $input = $filepath.'/'.$file;
1794: my $output = $filepath.'/'.'tn-'.$file;
1795: my $thumbsize = $thumbwidth.'x'.$thumbheight;
1796: system("convert -sample $thumbsize $input $output");
1797: if (-e $filepath.'/'.'tn-'.$file) {
1798: $fetchthumb = 1;
1799: }
1800: }
1801:
1802: # Notify homeserver to grep it
1803: #
1804: my $docuhome=&homeserver($docuname,$docudom);
1805: my $fetchresult= &reply('fetchuserfile:'.$path.$file,$docuhome);
1806: if ($fetchresult eq 'ok') {
1807: if ($fetchthumb) {
1808: my $thumbresult= &reply('fetchuserfile:'.$path.'tn-'.$file,$docuhome);
1809: if ($thumbresult ne 'ok') {
1810: &logthis('Failed to transfer '.$path.'tn-'.$file.' to host '.
1811: $docuhome.': '.$thumbresult);
1812: }
1813: }
1814: #
1815: # Return the URL to it
1816: return '/uploaded/'.$path.$file;
1817: } else {
1818: &logthis('Failed to transfer '.$path.$file.' to host '.$docuhome.
1819: ': '.$fetchresult);
1820: return '/adm/notfound.html';
1821: }
1822: }
1823:
1824: sub extract_embedded_items {
1825: my ($filepath,$file,$allfiles,$codebase,$content) = @_;
1826: my @state = ();
1827: my %javafiles = (
1828: codebase => '',
1829: code => '',
1830: archive => ''
1831: );
1832: my %mediafiles = (
1833: src => '',
1834: movie => '',
1835: );
1836: my $p;
1837: if ($content) {
1838: $p = HTML::LCParser->new($content);
1839: } else {
1840: $p = HTML::LCParser->new($filepath.'/'.$file);
1841: }
1842: while (my $t=$p->get_token()) {
1843: if ($t->[0] eq 'S') {
1844: my ($tagname, $attr) = ($t->[1],$t->[2]);
1845: push(@state, $tagname);
1846: if (lc($tagname) eq 'allow') {
1847: &add_filetype($allfiles,$attr->{'src'},'src');
1848: }
1849: if (lc($tagname) eq 'img') {
1850: &add_filetype($allfiles,$attr->{'src'},'src');
1851: }
1852: if (lc($tagname) eq 'a') {
1853: &add_filetype($allfiles,$attr->{'href'},'href');
1854: }
1855: if (lc($tagname) eq 'script') {
1856: if ($attr->{'archive'} =~ /\.jar$/i) {
1857: &add_filetype($allfiles,$attr->{'archive'},'archive');
1858: } else {
1859: &add_filetype($allfiles,$attr->{'src'},'src');
1860: }
1861: }
1862: if (lc($tagname) eq 'link') {
1863: if (lc($attr->{'rel'}) eq 'stylesheet') {
1864: &add_filetype($allfiles,$attr->{'href'},'href');
1865: }
1866: }
1867: if (lc($tagname) eq 'object' ||
1868: (lc($tagname) eq 'embed' && lc($state[-2]) ne 'object')) {
1869: foreach my $item (keys(%javafiles)) {
1870: $javafiles{$item} = '';
1871: }
1872: }
1873: if (lc($state[-2]) eq 'object' && lc($tagname) eq 'param') {
1874: my $name = lc($attr->{'name'});
1875: foreach my $item (keys(%javafiles)) {
1876: if ($name eq $item) {
1877: $javafiles{$item} = $attr->{'value'};
1878: last;
1879: }
1880: }
1881: foreach my $item (keys(%mediafiles)) {
1882: if ($name eq $item) {
1883: &add_filetype($allfiles, $attr->{'value'}, 'value');
1884: last;
1885: }
1886: }
1887: }
1888: if (lc($tagname) eq 'embed' || lc($tagname) eq 'applet') {
1889: foreach my $item (keys(%javafiles)) {
1890: if ($attr->{$item}) {
1891: $javafiles{$item} = $attr->{$item};
1892: last;
1893: }
1894: }
1895: foreach my $item (keys(%mediafiles)) {
1896: if ($attr->{$item}) {
1897: &add_filetype($allfiles,$attr->{$item},$item);
1898: last;
1899: }
1900: }
1901: }
1902: } elsif ($t->[0] eq 'E') {
1903: my ($tagname) = ($t->[1]);
1904: if ($javafiles{'codebase'} ne '') {
1905: $javafiles{'codebase'} .= '/';
1906: }
1907: if (lc($tagname) eq 'applet' ||
1908: lc($tagname) eq 'object' ||
1909: (lc($tagname) eq 'embed' && lc($state[-2]) ne 'object')
1910: ) {
1911: foreach my $item (keys(%javafiles)) {
1912: if ($item ne 'codebase' && $javafiles{$item} ne '') {
1913: my $file=$javafiles{'codebase'}.$javafiles{$item};
1914: &add_filetype($allfiles,$file,$item);
1915: }
1916: }
1917: }
1918: pop @state;
1919: }
1920: }
1921: return 'ok';
1922: }
1923:
1924: sub add_filetype {
1925: my ($allfiles,$file,$type)=@_;
1926: if (exists($allfiles->{$file})) {
1927: unless (grep/^\Q$type\E$/, @{$allfiles->{$file}}) {
1928: push(@{$allfiles->{$file}}, &escape($type));
1929: }
1930: } else {
1931: @{$allfiles->{$file}} = (&escape($type));
1932: }
1933: }
1934:
1935: sub removeuploadedurl {
1936: my ($url)=@_;
1937: my (undef,undef,$udom,$uname,$fname)=split('/',$url,5);
1938: return &removeuserfile($uname,$udom,$fname);
1939: }
1940:
1941: sub removeuserfile {
1942: my ($docuname,$docudom,$fname)=@_;
1943: my $home=&homeserver($docuname,$docudom);
1944: my $result = &reply("removeuserfile:$docudom/$docuname/$fname",$home);
1945: if ($result eq 'ok') {
1946: if (($fname !~ /\.meta$/) && (&is_portfolio_file($fname))) {
1947: my $metafile = $fname.'.meta';
1948: my $metaresult = &removeuserfile($docuname,$docudom,$metafile);
1949: my $url = "/uploaded/$docudom/$docuname/$fname";
1950: my ($file,$group) = (&parse_portfolio_url($url))[3,4];
1951: my $sqlresult =
1952: &update_portfolio_table($docuname,$docudom,$file,
1953: 'portfolio_metadata',$group,
1954: 'delete');
1955: }
1956: }
1957: return $result;
1958: }
1959:
1960: sub mkdiruserfile {
1961: my ($docuname,$docudom,$dir)=@_;
1962: my $home=&homeserver($docuname,$docudom);
1963: return &reply("mkdiruserfile:".&escape("$docudom/$docuname/$dir"),$home);
1964: }
1965:
1966: sub renameuserfile {
1967: my ($docuname,$docudom,$old,$new)=@_;
1968: my $home=&homeserver($docuname,$docudom);
1969: my $result = &reply("renameuserfile:$docudom:$docuname:".
1970: &escape("$old").':'.&escape("$new"),$home);
1971: if ($result eq 'ok') {
1972: if (($old !~ /\.meta$/) && (&is_portfolio_file($old))) {
1973: my $oldmeta = $old.'.meta';
1974: my $newmeta = $new.'.meta';
1975: my $metaresult =
1976: &renameuserfile($docuname,$docudom,$oldmeta,$newmeta);
1977: my $url = "/uploaded/$docudom/$docuname/$old";
1978: my ($file,$group) = (&parse_portfolio_url($url))[3,4];
1979: my $sqlresult =
1980: &update_portfolio_table($docuname,$docudom,$file,
1981: 'portfolio_metadata',$group,
1982: 'delete');
1983: }
1984: }
1985: return $result;
1986: }
1987:
1988: # ------------------------------------------------------------------------- Log
1989:
1990: sub log {
1991: my ($dom,$nam,$hom,$what)=@_;
1992: return critical("log:$dom:$nam:$what",$hom);
1993: }
1994:
1995: # ------------------------------------------------------------------ Course Log
1996: #
1997: # This routine flushes several buffers of non-mission-critical nature
1998: #
1999:
2000: sub flushcourselogs {
2001: &logthis('Flushing log buffers');
2002: #
2003: # course logs
2004: # This is a log of all transactions in a course, which can be used
2005: # for data mining purposes
2006: #
2007: # It also collects the courseid database, which lists last transaction
2008: # times and course titles for all courseids
2009: #
2010: my %courseidbuffer=();
2011: foreach my $crsid (keys %courselogs) {
2012: if (&reply('log:'.$coursedombuf{$crsid}.':'.$coursenumbuf{$crsid}.':'.
2013: &escape($courselogs{$crsid}),
2014: $coursehombuf{$crsid}) eq 'ok') {
2015: delete $courselogs{$crsid};
2016: } else {
2017: &logthis('Failed to flush log buffer for '.$crsid);
2018: if (length($courselogs{$crsid})>40000) {
2019: &logthis("<font color=\"blue\">WARNING: Buffer for ".$crsid.
2020: " exceeded maximum size, deleting.</font>");
2021: delete $courselogs{$crsid};
2022: }
2023: }
2024: if ($courseidbuffer{$coursehombuf{$crsid}}) {
2025: $courseidbuffer{$coursehombuf{$crsid}}.='&'.
2026: &escape($crsid).'='.&escape($coursedescrbuf{$crsid}).
2027: ':'.&escape($courseinstcodebuf{$crsid}).':'.&escape($courseownerbuf{$crsid}).':'.&escape($coursetypebuf{$crsid});
2028: } else {
2029: $courseidbuffer{$coursehombuf{$crsid}}=
2030: &escape($crsid).'='.&escape($coursedescrbuf{$crsid}).
2031: ':'.&escape($courseinstcodebuf{$crsid}).':'.&escape($courseownerbuf{$crsid}).':'.&escape($coursetypebuf{$crsid});
2032: }
2033: }
2034: #
2035: # Write course id database (reverse lookup) to homeserver of courses
2036: # Is used in pickcourse
2037: #
2038: foreach my $crs_home (keys(%courseidbuffer)) {
2039: &courseidput(&host_domain($crs_home),$courseidbuffer{$crs_home},
2040: $crs_home);
2041: }
2042: #
2043: # File accesses
2044: # Writes to the dynamic metadata of resources to get hit counts, etc.
2045: #
2046: foreach my $entry (keys(%accesshash)) {
2047: if ($entry =~ /___count$/) {
2048: my ($dom,$name);
2049: ($dom,$name,undef)=
2050: ($entry=~m{___($match_domain)/($match_name)/(.*)___count$});
2051: if (! defined($dom) || $dom eq '' ||
2052: ! defined($name) || $name eq '') {
2053: my $cid = $env{'request.course.id'};
2054: $dom = $env{'request.'.$cid.'.domain'};
2055: $name = $env{'request.'.$cid.'.num'};
2056: }
2057: my $value = $accesshash{$entry};
2058: my (undef,$url,undef) = ($entry =~ /^(.*)___(.*)___count$/);
2059: my %temphash=($url => $value);
2060: my $result = &inc('nohist_accesscount',\%temphash,$dom,$name);
2061: if ($result eq 'ok') {
2062: delete $accesshash{$entry};
2063: } elsif ($result eq 'unknown_cmd') {
2064: # Target server has old code running on it.
2065: my %temphash=($entry => $value);
2066: if (&put('nohist_resevaldata',\%temphash,$dom,$name) eq 'ok') {
2067: delete $accesshash{$entry};
2068: }
2069: }
2070: } else {
2071: my ($dom,$name) = ($entry=~m{___($match_domain)/($match_name)/(.*)___(\w+)$});
2072: my %temphash=($entry => $accesshash{$entry});
2073: if (&put('nohist_resevaldata',\%temphash,$dom,$name) eq 'ok') {
2074: delete $accesshash{$entry};
2075: }
2076: }
2077: }
2078: #
2079: # Roles
2080: # Reverse lookup of user roles for course faculty/staff and co-authorship
2081: #
2082: foreach my $entry (keys(%userrolehash)) {
2083: my ($role,$uname,$udom,$runame,$rudom,$rsec)=
2084: split(/\:/,$entry);
2085: if (&Apache::lonnet::put('nohist_userroles',
2086: { $role.':'.$uname.':'.$udom.':'.$rsec => $userrolehash{$entry} },
2087: $rudom,$runame) eq 'ok') {
2088: delete $userrolehash{$entry};
2089: }
2090: }
2091: #
2092: # Reverse lookup of domain roles (dc, ad, li, sc, au)
2093: #
2094: my %domrolebuffer = ();
2095: foreach my $entry (keys %domainrolehash) {
2096: my ($role,$uname,$udom,$runame,$rudom,$rsec)=split(/:/,$entry);
2097: if ($domrolebuffer{$rudom}) {
2098: $domrolebuffer{$rudom}.='&'.&escape($entry).
2099: '='.&escape($domainrolehash{$entry});
2100: } else {
2101: $domrolebuffer{$rudom}.=&escape($entry).
2102: '='.&escape($domainrolehash{$entry});
2103: }
2104: delete $domainrolehash{$entry};
2105: }
2106: foreach my $dom (keys(%domrolebuffer)) {
2107: my %servers = &get_servers($dom,'library');
2108: foreach my $tryserver (keys(%servers)) {
2109: unless (&reply('domroleput:'.$dom.':'.
2110: $domrolebuffer{$dom},$tryserver) eq 'ok') {
2111: &logthis('Put of domain roles failed for '.$dom.' and '.$tryserver);
2112: }
2113: }
2114: }
2115: $dumpcount++;
2116: }
2117:
2118: sub courselog {
2119: my $what=shift;
2120: $what=time.':'.$what;
2121: unless ($env{'request.course.id'}) { return ''; }
2122: $coursedombuf{$env{'request.course.id'}}=
2123: $env{'course.'.$env{'request.course.id'}.'.domain'};
2124: $coursenumbuf{$env{'request.course.id'}}=
2125: $env{'course.'.$env{'request.course.id'}.'.num'};
2126: $coursehombuf{$env{'request.course.id'}}=
2127: $env{'course.'.$env{'request.course.id'}.'.home'};
2128: $coursedescrbuf{$env{'request.course.id'}}=
2129: $env{'course.'.$env{'request.course.id'}.'.description'};
2130: $courseinstcodebuf{$env{'request.course.id'}}=
2131: $env{'course.'.$env{'request.course.id'}.'.internal.coursecode'};
2132: $courseownerbuf{$env{'request.course.id'}}=
2133: $env{'course.'.$env{'request.course.id'}.'.internal.courseowner'};
2134: $coursetypebuf{$env{'request.course.id'}}=
2135: $env{'course.'.$env{'request.course.id'}.'.type'};
2136: if (defined $courselogs{$env{'request.course.id'}}) {
2137: $courselogs{$env{'request.course.id'}}.='&'.$what;
2138: } else {
2139: $courselogs{$env{'request.course.id'}}.=$what;
2140: }
2141: if (length($courselogs{$env{'request.course.id'}})>4048) {
2142: &flushcourselogs();
2143: }
2144: }
2145:
2146: sub courseacclog {
2147: my $fnsymb=shift;
2148: unless ($env{'request.course.id'}) { return ''; }
2149: my $what=$fnsymb.':'.$env{'user.name'}.':'.$env{'user.domain'};
2150: if ($fnsymb=~/(problem|exam|quiz|assess|survey|form|task|page)$/) {
2151: $what.=':POST';
2152: # FIXME: Probably ought to escape things....
2153: foreach my $key (keys(%env)) {
2154: if ($key=~/^form\.(.*)/) {
2155: $what.=':'.$1.'='.$env{$key};
2156: }
2157: }
2158: } elsif ($fnsymb =~ m:^/adm/searchcat:) {
2159: # FIXME: We should not be depending on a form parameter that someone
2160: # editing lonsearchcat.pm might change in the future.
2161: if ($env{'form.phase'} eq 'course_search') {
2162: $what.= ':POST';
2163: # FIXME: Probably ought to escape things....
2164: foreach my $element ('courseexp','crsfulltext','crsrelated',
2165: 'crsdiscuss') {
2166: $what.=':'.$element.'='.$env{'form.'.$element};
2167: }
2168: }
2169: }
2170: &courselog($what);
2171: }
2172:
2173: sub countacc {
2174: my $url=&declutter(shift);
2175: return if (! defined($url) || $url eq '');
2176: unless ($env{'request.course.id'}) { return ''; }
2177: $accesshash{$env{'request.course.id'}.'___'.$url.'___course'}=1;
2178: my $key=$$.$processmarker.'_'.$dumpcount.'___'.$url.'___count';
2179: $accesshash{$key}++;
2180: }
2181:
2182: sub linklog {
2183: my ($from,$to)=@_;
2184: $from=&declutter($from);
2185: $to=&declutter($to);
2186: $accesshash{$from.'___'.$to.'___comefrom'}=1;
2187: $accesshash{$to.'___'.$from.'___goto'}=1;
2188: }
2189:
2190: sub userrolelog {
2191: my ($trole,$username,$domain,$area,$tstart,$tend)=@_;
2192: if (($trole=~/^ca/) || ($trole=~/^aa/) ||
2193: ($trole=~/^in/) || ($trole=~/^cc/) ||
2194: ($trole=~/^ep/) || ($trole=~/^cr/) ||
2195: ($trole=~/^ta/)) {
2196: my (undef,$rudom,$runame,$rsec)=split(/\//,$area);
2197: $userrolehash
2198: {$trole.':'.$username.':'.$domain.':'.$runame.':'.$rudom.':'.$rsec}
2199: =$tend.':'.$tstart;
2200: }
2201: if (($env{'request.role'} =~ /dc\./) &&
2202: (($trole=~/^au/) || ($trole=~/^in/) ||
2203: ($trole=~/^cc/) || ($trole=~/^ep/) ||
2204: ($trole=~/^cr/) || ($trole=~/^ta/))) {
2205: $userrolehash
2206: {$trole.':'.$username.':'.$domain.':'.$env{'user.name'}.':'.$env{'user.domain'}.':'}
2207: =$tend.':'.$tstart;
2208: }
2209: if (($trole=~/^dc/) || ($trole=~/^ad/) ||
2210: ($trole=~/^li/) || ($trole=~/^li/) ||
2211: ($trole=~/^au/) || ($trole=~/^dg/) ||
2212: ($trole=~/^sc/)) {
2213: my (undef,$rudom,$runame,$rsec)=split(/\//,$area);
2214: $domainrolehash
2215: {$trole.':'.$username.':'.$domain.':'.$runame.':'.$rudom.':'.$rsec}
2216: = $tend.':'.$tstart;
2217: }
2218: }
2219:
2220: sub get_course_adv_roles {
2221: my $cid=shift;
2222: $cid=$env{'request.course.id'} unless (defined($cid));
2223: my %coursehash=&coursedescription($cid);
2224: my %nothide=();
2225: foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
2226: $nothide{join(':',split(/[\@\:]/,$user))}=1;
2227: }
2228: my %returnhash=();
2229: my %dumphash=
2230: &dump('nohist_userroles',$coursehash{'domain'},$coursehash{'num'});
2231: my $now=time;
2232: foreach my $entry (keys %dumphash) {
2233: my ($tend,$tstart)=split(/\:/,$dumphash{$entry});
2234: if (($tstart) && ($tstart<0)) { next; }
2235: if (($tend) && ($tend<$now)) { next; }
2236: if (($tstart) && ($now<$tstart)) { next; }
2237: my ($role,$username,$domain,$section)=split(/\:/,$entry);
2238: if ($username eq '' || $domain eq '') { next; }
2239: if ((&privileged($username,$domain)) &&
2240: (!$nothide{$username.':'.$domain})) { next; }
2241: if ($role eq 'cr') { next; }
2242: my $key=&plaintext($role);
2243: if ($section) { $key.=' (Sec/Grp '.$section.')'; }
2244: if ($returnhash{$key}) {
2245: $returnhash{$key}.=','.$username.':'.$domain;
2246: } else {
2247: $returnhash{$key}=$username.':'.$domain;
2248: }
2249: }
2250: return %returnhash;
2251: }
2252:
2253: sub get_my_roles {
2254: my ($uname,$udom,$context,$types,$roles,$roledoms)=@_;
2255: unless (defined($uname)) { $uname=$env{'user.name'}; }
2256: unless (defined($udom)) { $udom=$env{'user.domain'}; }
2257: my %dumphash;
2258: if ($context eq 'userroles') {
2259: %dumphash = &dump('roles',$udom,$uname);
2260: } else {
2261: %dumphash=
2262: &dump('nohist_userroles',$udom,$uname);
2263: }
2264: my %returnhash=();
2265: my $now=time;
2266: foreach my $entry (keys(%dumphash)) {
2267: my ($role,$tend,$tstart);
2268: if ($context eq 'userroles') {
2269: ($role,$tend,$tstart)=split(/_/,$dumphash{$entry});
2270: } else {
2271: ($tend,$tstart)=split(/\:/,$dumphash{$entry});
2272: }
2273: if (($tstart) && ($tstart<0)) { next; }
2274: my $status = 'active';
2275: if (($tend) && ($tend<$now)) {
2276: $status = 'previous';
2277: }
2278: if (($tstart) && ($now<$tstart)) {
2279: $status = 'future';
2280: }
2281: if (ref($types) eq 'ARRAY') {
2282: if (!grep(/^\Q$status\E$/,@{$types})) {
2283: next;
2284: }
2285: } else {
2286: if ($status ne 'active') {
2287: next;
2288: }
2289: }
2290: my ($rolecode,$username,$domain,$section,$area);
2291: if ($context eq 'userroles') {
2292: ($area,$rolecode) = split(/_/,$entry);
2293: (undef,$domain,$username,$section) = split(/\//,$area);
2294: } else {
2295: ($role,$username,$domain,$section) = split(/\:/,$entry);
2296: }
2297: if (ref($roledoms) eq 'ARRAY') {
2298: if (!grep(/^\Q$domain\E$/,@{$roledoms})) {
2299: next;
2300: }
2301: }
2302: if (ref($roles) eq 'ARRAY') {
2303: if (!grep(/^\Q$role\E$/,@{$roles})) {
2304: next;
2305: }
2306: }
2307: $returnhash{$username.':'.$domain.':'.$role}=$tstart.':'.$tend;
2308: }
2309: return %returnhash;
2310: }
2311:
2312: # ----------------------------------------------------- Frontpage Announcements
2313: #
2314: #
2315:
2316: sub postannounce {
2317: my ($server,$text)=@_;
2318: unless (&allowed('psa',&host_domain($server))) { return 'refused'; }
2319: unless ($text=~/\w/) { $text=''; }
2320: return &reply('setannounce:'.&escape($text),$server);
2321: }
2322:
2323: sub getannounce {
2324:
2325: if (open(my $fh,$perlvar{'lonDocRoot'}.'/announcement.txt')) {
2326: my $announcement='';
2327: while (my $line = <$fh>) { $announcement .= $line; }
2328: close($fh);
2329: if ($announcement=~/\w/) {
2330: return
2331: '<table bgcolor="#FF5555" cellpadding="5" cellspacing="3">'.
2332: '<tr><td bgcolor="#FFFFFF"><tt>'.$announcement.'</tt></td></tr></table>';
2333: } else {
2334: return '';
2335: }
2336: } else {
2337: return '';
2338: }
2339: }
2340:
2341: # ---------------------------------------------------------- Course ID routines
2342: # Deal with domain's nohist_courseid.db files
2343: #
2344:
2345: sub courseidput {
2346: my ($domain,$what,$coursehome)=@_;
2347: return &reply('courseidput:'.$domain.':'.$what,$coursehome);
2348: }
2349:
2350: sub courseiddump {
2351: my ($domfilter,$descfilter,$sincefilter,$instcodefilter,$ownerfilter,$coursefilter,$hostidflag,$hostidref,$typefilter,$regexp_ok)=@_;
2352: my %returnhash=();
2353: unless ($domfilter) { $domfilter=''; }
2354: my %libserv = &all_library();
2355: foreach my $tryserver (keys(%libserv)) {
2356: if ( ( $hostidflag == 1
2357: && grep(/^\Q$tryserver\E$/,@{$hostidref}) )
2358: || (!defined($hostidflag)) ) {
2359:
2360: if ($domfilter eq ''
2361: || (&host_domain($tryserver) eq $domfilter)) {
2362: foreach my $line (
2363: split(/\&/,&reply('courseiddump:'.&host_domain($tryserver).':'.
2364: $sincefilter.':'.&escape($descfilter).':'.
2365: &escape($instcodefilter).':'.&escape($ownerfilter).':'.&escape($coursefilter).':'.&escape($typefilter).':'.&escape($regexp_ok),
2366: $tryserver))) {
2367: my ($key,$value)=split(/\=/,$line,2);
2368: if (($key) && ($value)) {
2369: $returnhash{&unescape($key)}=$value;
2370: }
2371: }
2372: }
2373: }
2374: }
2375: return %returnhash;
2376: }
2377:
2378: # ---------------------------------------------------------- DC e-mail
2379:
2380: sub dcmailput {
2381: my ($domain,$msgid,$message,$server)=@_;
2382: my $status = &Apache::lonnet::critical(
2383: 'dcmailput:'.$domain.':'.&escape($msgid).'='.
2384: &escape($message),$server);
2385: return $status;
2386: }
2387:
2388: sub dcmaildump {
2389: my ($dom,$startdate,$enddate,$senders) = @_;
2390: my %returnhash=();
2391:
2392: if (defined(&domain($dom,'primary'))) {
2393: my $cmd='dcmaildump:'.$dom.':'.&escape($startdate).':'.
2394: &escape($enddate).':';
2395: my @esc_senders=map { &escape($_)} @$senders;
2396: $cmd.=&escape(join('&',@esc_senders));
2397: foreach my $line (split(/\&/,&reply($cmd,&domain($dom,'primary')))) {
2398: my ($key,$value) = split(/\=/,$line,2);
2399: if (($key) && ($value)) {
2400: $returnhash{&unescape($key)} = &unescape($value);
2401: }
2402: }
2403: }
2404: return %returnhash;
2405: }
2406: # ---------------------------------------------------------- Domain roles
2407:
2408: sub get_domain_roles {
2409: my ($dom,$roles,$startdate,$enddate)=@_;
2410: if (undef($startdate) || $startdate eq '') {
2411: $startdate = '.';
2412: }
2413: if (undef($enddate) || $enddate eq '') {
2414: $enddate = '.';
2415: }
2416: my $rolelist = join(':',@{$roles});
2417: my %personnel = ();
2418:
2419: my %servers = &get_servers($dom,'library');
2420: foreach my $tryserver (keys(%servers)) {
2421: %{$personnel{$tryserver}}=();
2422: foreach my $line (split(/\&/,&reply('domrolesdump:'.$dom.':'.
2423: &escape($startdate).':'.
2424: &escape($enddate).':'.
2425: &escape($rolelist), $tryserver))) {
2426: my ($key,$value) = split(/\=/,$line,2);
2427: if (($key) && ($value)) {
2428: $personnel{$tryserver}{&unescape($key)} = &unescape($value);
2429: }
2430: }
2431: }
2432: return %personnel;
2433: }
2434:
2435: # ----------------------------------------------------------- Check out an item
2436:
2437: sub get_first_access {
2438: my ($type,$argsymb)=@_;
2439: my ($symb,$courseid,$udom,$uname)=&whichuser();
2440: if ($argsymb) { $symb=$argsymb; }
2441: my ($map,$id,$res)=&decode_symb($symb);
2442: if ($type eq 'map') {
2443: $res=&symbread($map);
2444: } else {
2445: $res=$symb;
2446: }
2447: my %times=&get('firstaccesstimes',["$courseid\0$res"],$udom,$uname);
2448: return $times{"$courseid\0$res"};
2449: }
2450:
2451: sub set_first_access {
2452: my ($type)=@_;
2453: my ($symb,$courseid,$udom,$uname)=&whichuser();
2454: my ($map,$id,$res)=&decode_symb($symb);
2455: if ($type eq 'map') {
2456: $res=&symbread($map);
2457: } else {
2458: $res=$symb;
2459: }
2460: my $firstaccess=&get_first_access($type,$symb);
2461: if (!$firstaccess) {
2462: return &put('firstaccesstimes',{"$courseid\0$res"=>time},$udom,$uname);
2463: }
2464: return 'already_set';
2465: }
2466:
2467: sub checkout {
2468: my ($symb,$tuname,$tudom,$tcrsid)=@_;
2469: my $now=time;
2470: my $lonhost=$perlvar{'lonHostID'};
2471: my $infostr=&escape(
2472: 'CHECKOUTTOKEN&'.
2473: $tuname.'&'.
2474: $tudom.'&'.
2475: $tcrsid.'&'.
2476: $symb.'&'.
2477: $now.'&'.$ENV{'REMOTE_ADDR'});
2478: my $token=&reply('tmpput:'.$infostr,$lonhost);
2479: if ($token=~/^error\:/) {
2480: &logthis("<font color=\"blue\">WARNING: ".
2481: "Checkout tmpput failed ".$tudom.' - '.$tuname.' - '.$symb.
2482: "</font>");
2483: return '';
2484: }
2485:
2486: $token=~s/^(\d+)\_.*\_(\d+)$/$1\*$2\*$lonhost/;
2487: $token=~tr/a-z/A-Z/;
2488:
2489: my %infohash=('resource.0.outtoken' => $token,
2490: 'resource.0.checkouttime' => $now,
2491: 'resource.0.outremote' => $ENV{'REMOTE_ADDR'});
2492:
2493: unless (&cstore(\%infohash,$symb,$tcrsid,$tudom,$tuname) eq 'ok') {
2494: return '';
2495: } else {
2496: &logthis("<font color=\"blue\">WARNING: ".
2497: "Checkout cstore failed ".$tudom.' - '.$tuname.' - '.$symb.
2498: "</font>");
2499: }
2500:
2501: if (&log($tudom,$tuname,&homeserver($tuname,$tudom),
2502: &escape('Checkout '.$infostr.' - '.
2503: $token)) ne 'ok') {
2504: return '';
2505: } else {
2506: &logthis("<font color=\"blue\">WARNING: ".
2507: "Checkout log failed ".$tudom.' - '.$tuname.' - '.$symb.
2508: "</font>");
2509: }
2510: return $token;
2511: }
2512:
2513: # ------------------------------------------------------------ Check in an item
2514:
2515: sub checkin {
2516: my $token=shift;
2517: my $now=time;
2518: my ($ta,$tb,$lonhost)=split(/\*/,$token);
2519: $lonhost=~tr/A-Z/a-z/;
2520: my $dtoken=$ta.'_'.&hostname($lonhost).'_'.$tb;
2521: $dtoken=~s/\W/\_/g;
2522: my ($dummy,$tuname,$tudom,$tcrsid,$symb,$chtim,$rmaddr)=
2523: split(/\&/,&unescape(&reply('tmpget:'.$dtoken,$lonhost)));
2524:
2525: unless (($tuname) && ($tudom)) {
2526: &logthis('Check in '.$token.' ('.$dtoken.') failed');
2527: return '';
2528: }
2529:
2530: unless (&allowed('mgr',$tcrsid)) {
2531: &logthis('Check in '.$token.' ('.$dtoken.') unauthorized: '.
2532: $env{'user.name'}.' - '.$env{'user.domain'});
2533: return '';
2534: }
2535:
2536: my %infohash=('resource.0.intoken' => $token,
2537: 'resource.0.checkintime' => $now,
2538: 'resource.0.inremote' => $ENV{'REMOTE_ADDR'});
2539:
2540: unless (&cstore(\%infohash,$symb,$tcrsid,$tudom,$tuname) eq 'ok') {
2541: return '';
2542: }
2543:
2544: if (&log($tudom,$tuname,&homeserver($tuname,$tudom),
2545: &escape('Checkin - '.$token)) ne 'ok') {
2546: return '';
2547: }
2548:
2549: return ($symb,$tuname,$tudom,$tcrsid);
2550: }
2551:
2552: # --------------------------------------------- Set Expire Date for Spreadsheet
2553:
2554: sub expirespread {
2555: my ($uname,$udom,$stype,$usymb)=@_;
2556: my $cid=$env{'request.course.id'};
2557: if ($cid) {
2558: my $now=time;
2559: my $key=$uname.':'.$udom.':'.$stype.':'.$usymb;
2560: return &reply('put:'.$env{'course.'.$cid.'.domain'}.':'.
2561: $env{'course.'.$cid.'.num'}.
2562: ':nohist_expirationdates:'.
2563: &escape($key).'='.$now,
2564: $env{'course.'.$cid.'.home'})
2565: }
2566: return 'ok';
2567: }
2568:
2569: # ----------------------------------------------------- Devalidate Spreadsheets
2570:
2571: sub devalidate {
2572: my ($symb,$uname,$udom)=@_;
2573: my $cid=$env{'request.course.id'};
2574: if ($cid) {
2575: # delete the stored spreadsheets for
2576: # - the student level sheet of this user in course's homespace
2577: # - the assessment level sheet for this resource
2578: # for this user in user's homespace
2579: # - current conditional state info
2580: my $key=$uname.':'.$udom.':';
2581: my $status=
2582: &del('nohist_calculatedsheets',
2583: [$key.'studentcalc:'],
2584: $env{'course.'.$cid.'.domain'},
2585: $env{'course.'.$cid.'.num'})
2586: .' '.
2587: &del('nohist_calculatedsheets_'.$cid,
2588: [$key.'assesscalc:'.$symb],$udom,$uname);
2589: unless ($status eq 'ok ok') {
2590: &logthis('Could not devalidate spreadsheet '.
2591: $uname.' at '.$udom.' for '.
2592: $symb.': '.$status);
2593: }
2594: &delenv('user.state.'.$cid);
2595: }
2596: }
2597:
2598: sub get_scalar {
2599: my ($string,$end) = @_;
2600: my $value;
2601: if ($$string =~ s/^([^&]*?)($end)/$2/) {
2602: $value = $1;
2603: } elsif ($$string =~ s/^([^&]*?)&//) {
2604: $value = $1;
2605: }
2606: return &unescape($value);
2607: }
2608:
2609: sub array2str {
2610: my (@array) = @_;
2611: my $result=&arrayref2str(\@array);
2612: $result=~s/^__ARRAY_REF__//;
2613: $result=~s/__END_ARRAY_REF__$//;
2614: return $result;
2615: }
2616:
2617: sub arrayref2str {
2618: my ($arrayref) = @_;
2619: my $result='__ARRAY_REF__';
2620: foreach my $elem (@$arrayref) {
2621: if(ref($elem) eq 'ARRAY') {
2622: $result.=&arrayref2str($elem).'&';
2623: } elsif(ref($elem) eq 'HASH') {
2624: $result.=&hashref2str($elem).'&';
2625: } elsif(ref($elem)) {
2626: #print("Got a ref of ".(ref($elem))." skipping.");
2627: } else {
2628: $result.=&escape($elem).'&';
2629: }
2630: }
2631: $result=~s/\&$//;
2632: $result .= '__END_ARRAY_REF__';
2633: return $result;
2634: }
2635:
2636: sub hash2str {
2637: my (%hash) = @_;
2638: my $result=&hashref2str(\%hash);
2639: $result=~s/^__HASH_REF__//;
2640: $result=~s/__END_HASH_REF__$//;
2641: return $result;
2642: }
2643:
2644: sub hashref2str {
2645: my ($hashref)=@_;
2646: my $result='__HASH_REF__';
2647: foreach my $key (sort(keys(%$hashref))) {
2648: if (ref($key) eq 'ARRAY') {
2649: $result.=&arrayref2str($key).'=';
2650: } elsif (ref($key) eq 'HASH') {
2651: $result.=&hashref2str($key).'=';
2652: } elsif (ref($key)) {
2653: $result.='=';
2654: #print("Got a ref of ".(ref($key))." skipping.");
2655: } else {
2656: if ($key) {$result.=&escape($key).'=';} else { last; }
2657: }
2658:
2659: if(ref($hashref->{$key}) eq 'ARRAY') {
2660: $result.=&arrayref2str($hashref->{$key}).'&';
2661: } elsif(ref($hashref->{$key}) eq 'HASH') {
2662: $result.=&hashref2str($hashref->{$key}).'&';
2663: } elsif(ref($hashref->{$key})) {
2664: $result.='&';
2665: #print("Got a ref of ".(ref($hashref->{$key}))." skipping.");
2666: } else {
2667: $result.=&escape($hashref->{$key}).'&';
2668: }
2669: }
2670: $result=~s/\&$//;
2671: $result .= '__END_HASH_REF__';
2672: return $result;
2673: }
2674:
2675: sub str2hash {
2676: my ($string)=@_;
2677: my ($hash)=&str2hashref('__HASH_REF__'.$string.'__END_HASH_REF__');
2678: return %$hash;
2679: }
2680:
2681: sub str2hashref {
2682: my ($string) = @_;
2683:
2684: my %hash;
2685:
2686: if($string !~ /^__HASH_REF__/) {
2687: if (! ($string eq '' || !defined($string))) {
2688: $hash{'error'}='Not hash reference';
2689: }
2690: return (\%hash, $string);
2691: }
2692:
2693: $string =~ s/^__HASH_REF__//;
2694:
2695: while($string !~ /^__END_HASH_REF__/) {
2696: #key
2697: my $key='';
2698: if($string =~ /^__HASH_REF__/) {
2699: ($key, $string)=&str2hashref($string);
2700: if(defined($key->{'error'})) {
2701: $hash{'error'}='Bad data';
2702: return (\%hash, $string);
2703: }
2704: } elsif($string =~ /^__ARRAY_REF__/) {
2705: ($key, $string)=&str2arrayref($string);
2706: if($key->[0] eq 'Array reference error') {
2707: $hash{'error'}='Bad data';
2708: return (\%hash, $string);
2709: }
2710: } else {
2711: $string =~ s/^(.*?)=//;
2712: $key=&unescape($1);
2713: }
2714: $string =~ s/^=//;
2715:
2716: #value
2717: my $value='';
2718: if($string =~ /^__HASH_REF__/) {
2719: ($value, $string)=&str2hashref($string);
2720: if(defined($value->{'error'})) {
2721: $hash{'error'}='Bad data';
2722: return (\%hash, $string);
2723: }
2724: } elsif($string =~ /^__ARRAY_REF__/) {
2725: ($value, $string)=&str2arrayref($string);
2726: if($value->[0] eq 'Array reference error') {
2727: $hash{'error'}='Bad data';
2728: return (\%hash, $string);
2729: }
2730: } else {
2731: $value=&get_scalar(\$string,'__END_HASH_REF__');
2732: }
2733: $string =~ s/^&//;
2734:
2735: $hash{$key}=$value;
2736: }
2737:
2738: $string =~ s/^__END_HASH_REF__//;
2739:
2740: return (\%hash, $string);
2741: }
2742:
2743: sub str2array {
2744: my ($string)=@_;
2745: my ($array)=&str2arrayref('__ARRAY_REF__'.$string.'__END_ARRAY_REF__');
2746: return @$array;
2747: }
2748:
2749: sub str2arrayref {
2750: my ($string) = @_;
2751: my @array;
2752:
2753: if($string !~ /^__ARRAY_REF__/) {
2754: if (! ($string eq '' || !defined($string))) {
2755: $array[0]='Array reference error';
2756: }
2757: return (\@array, $string);
2758: }
2759:
2760: $string =~ s/^__ARRAY_REF__//;
2761:
2762: while($string !~ /^__END_ARRAY_REF__/) {
2763: my $value='';
2764: if($string =~ /^__HASH_REF__/) {
2765: ($value, $string)=&str2hashref($string);
2766: if(defined($value->{'error'})) {
2767: $array[0] ='Array reference error';
2768: return (\@array, $string);
2769: }
2770: } elsif($string =~ /^__ARRAY_REF__/) {
2771: ($value, $string)=&str2arrayref($string);
2772: if($value->[0] eq 'Array reference error') {
2773: $array[0] ='Array reference error';
2774: return (\@array, $string);
2775: }
2776: } else {
2777: $value=&get_scalar(\$string,'__END_ARRAY_REF__');
2778: }
2779: $string =~ s/^&//;
2780:
2781: push(@array, $value);
2782: }
2783:
2784: $string =~ s/^__END_ARRAY_REF__//;
2785:
2786: return (\@array, $string);
2787: }
2788:
2789: # -------------------------------------------------------------------Temp Store
2790:
2791: sub tmpreset {
2792: my ($symb,$namespace,$domain,$stuname) = @_;
2793: if (!$symb) {
2794: $symb=&symbread();
2795: if (!$symb) { $symb= $env{'request.url'}; }
2796: }
2797: $symb=escape($symb);
2798:
2799: if (!$namespace) { $namespace=$env{'request.state'}; }
2800: $namespace=~s/\//\_/g;
2801: $namespace=~s/\W//g;
2802:
2803: if (!$domain) { $domain=$env{'user.domain'}; }
2804: if (!$stuname) { $stuname=$env{'user.name'}; }
2805: if ($domain eq 'public' && $stuname eq 'public') {
2806: $stuname=$ENV{'REMOTE_ADDR'};
2807: }
2808: my $path=$perlvar{'lonDaemons'}.'/tmp';
2809: my %hash;
2810: if (tie(%hash,'GDBM_File',
2811: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
2812: &GDBM_WRCREAT(),0640)) {
2813: foreach my $key (keys %hash) {
2814: if ($key=~ /:$symb/) {
2815: delete($hash{$key});
2816: }
2817: }
2818: }
2819: }
2820:
2821: sub tmpstore {
2822: my ($storehash,$symb,$namespace,$domain,$stuname) = @_;
2823:
2824: if (!$symb) {
2825: $symb=&symbread();
2826: if (!$symb) { $symb= $env{'request.url'}; }
2827: }
2828: $symb=escape($symb);
2829:
2830: if (!$namespace) {
2831: # I don't think we would ever want to store this for a course.
2832: # it seems this will only be used if we don't have a course.
2833: #$namespace=$env{'request.course.id'};
2834: #if (!$namespace) {
2835: $namespace=$env{'request.state'};
2836: #}
2837: }
2838: $namespace=~s/\//\_/g;
2839: $namespace=~s/\W//g;
2840: if (!$domain) { $domain=$env{'user.domain'}; }
2841: if (!$stuname) { $stuname=$env{'user.name'}; }
2842: if ($domain eq 'public' && $stuname eq 'public') {
2843: $stuname=$ENV{'REMOTE_ADDR'};
2844: }
2845: my $now=time;
2846: my %hash;
2847: my $path=$perlvar{'lonDaemons'}.'/tmp';
2848: if (tie(%hash,'GDBM_File',
2849: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
2850: &GDBM_WRCREAT(),0640)) {
2851: $hash{"version:$symb"}++;
2852: my $version=$hash{"version:$symb"};
2853: my $allkeys='';
2854: foreach my $key (keys(%$storehash)) {
2855: $allkeys.=$key.':';
2856: $hash{"$version:$symb:$key"}=&freeze_escape($$storehash{$key});
2857: }
2858: $hash{"$version:$symb:timestamp"}=$now;
2859: $allkeys.='timestamp';
2860: $hash{"$version:keys:$symb"}=$allkeys;
2861: if (untie(%hash)) {
2862: return 'ok';
2863: } else {
2864: return "error:$!";
2865: }
2866: } else {
2867: return "error:$!";
2868: }
2869: }
2870:
2871: # -----------------------------------------------------------------Temp Restore
2872:
2873: sub tmprestore {
2874: my ($symb,$namespace,$domain,$stuname) = @_;
2875:
2876: if (!$symb) {
2877: $symb=&symbread();
2878: if (!$symb) { $symb= $env{'request.url'}; }
2879: }
2880: $symb=escape($symb);
2881:
2882: if (!$namespace) { $namespace=$env{'request.state'}; }
2883:
2884: if (!$domain) { $domain=$env{'user.domain'}; }
2885: if (!$stuname) { $stuname=$env{'user.name'}; }
2886: if ($domain eq 'public' && $stuname eq 'public') {
2887: $stuname=$ENV{'REMOTE_ADDR'};
2888: }
2889: my %returnhash;
2890: $namespace=~s/\//\_/g;
2891: $namespace=~s/\W//g;
2892: my %hash;
2893: my $path=$perlvar{'lonDaemons'}.'/tmp';
2894: if (tie(%hash,'GDBM_File',
2895: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
2896: &GDBM_READER(),0640)) {
2897: my $version=$hash{"version:$symb"};
2898: $returnhash{'version'}=$version;
2899: my $scope;
2900: for ($scope=1;$scope<=$version;$scope++) {
2901: my $vkeys=$hash{"$scope:keys:$symb"};
2902: my @keys=split(/:/,$vkeys);
2903: my $key;
2904: $returnhash{"$scope:keys"}=$vkeys;
2905: foreach $key (@keys) {
2906: $returnhash{"$scope:$key"}=&thaw_unescape($hash{"$scope:$symb:$key"});
2907: $returnhash{"$key"}=&thaw_unescape($hash{"$scope:$symb:$key"});
2908: }
2909: }
2910: if (!(untie(%hash))) {
2911: return "error:$!";
2912: }
2913: } else {
2914: return "error:$!";
2915: }
2916: return %returnhash;
2917: }
2918:
2919: # ----------------------------------------------------------------------- Store
2920:
2921: sub store {
2922: my ($storehash,$symb,$namespace,$domain,$stuname) = @_;
2923: my $home='';
2924:
2925: if ($stuname) { $home=&homeserver($stuname,$domain); }
2926:
2927: $symb=&symbclean($symb);
2928: if (!$symb) { unless ($symb=&symbread()) { return ''; } }
2929:
2930: if (!$domain) { $domain=$env{'user.domain'}; }
2931: if (!$stuname) { $stuname=$env{'user.name'}; }
2932:
2933: &devalidate($symb,$stuname,$domain);
2934:
2935: $symb=escape($symb);
2936: if (!$namespace) {
2937: unless ($namespace=$env{'request.course.id'}) {
2938: return '';
2939: }
2940: }
2941: if (!$home) { $home=$env{'user.home'}; }
2942:
2943: $$storehash{'ip'}=$ENV{'REMOTE_ADDR'};
2944: $$storehash{'host'}=$perlvar{'lonHostID'};
2945:
2946: my $namevalue='';
2947: foreach my $key (keys(%$storehash)) {
2948: $namevalue.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
2949: }
2950: $namevalue=~s/\&$//;
2951: &courselog($symb.':'.$stuname.':'.$domain.':STORE:'.$namevalue);
2952: return reply("store:$domain:$stuname:$namespace:$symb:$namevalue","$home");
2953: }
2954:
2955: # -------------------------------------------------------------- Critical Store
2956:
2957: sub cstore {
2958: my ($storehash,$symb,$namespace,$domain,$stuname) = @_;
2959: my $home='';
2960:
2961: if ($stuname) { $home=&homeserver($stuname,$domain); }
2962:
2963: $symb=&symbclean($symb);
2964: if (!$symb) { unless ($symb=&symbread()) { return ''; } }
2965:
2966: if (!$domain) { $domain=$env{'user.domain'}; }
2967: if (!$stuname) { $stuname=$env{'user.name'}; }
2968:
2969: &devalidate($symb,$stuname,$domain);
2970:
2971: $symb=escape($symb);
2972: if (!$namespace) {
2973: unless ($namespace=$env{'request.course.id'}) {
2974: return '';
2975: }
2976: }
2977: if (!$home) { $home=$env{'user.home'}; }
2978:
2979: $$storehash{'ip'}=$ENV{'REMOTE_ADDR'};
2980: $$storehash{'host'}=$perlvar{'lonHostID'};
2981:
2982: my $namevalue='';
2983: foreach my $key (keys(%$storehash)) {
2984: $namevalue.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
2985: }
2986: $namevalue=~s/\&$//;
2987: &courselog($symb.':'.$stuname.':'.$domain.':CSTORE:'.$namevalue);
2988: return critical
2989: ("store:$domain:$stuname:$namespace:$symb:$namevalue","$home");
2990: }
2991:
2992: # --------------------------------------------------------------------- Restore
2993:
2994: sub restore {
2995: my ($symb,$namespace,$domain,$stuname) = @_;
2996: my $home='';
2997:
2998: if ($stuname) { $home=&homeserver($stuname,$domain); }
2999:
3000: if (!$symb) {
3001: unless ($symb=escape(&symbread())) { return ''; }
3002: } else {
3003: $symb=&escape(&symbclean($symb));
3004: }
3005: if (!$namespace) {
3006: unless ($namespace=$env{'request.course.id'}) {
3007: return '';
3008: }
3009: }
3010: if (!$domain) { $domain=$env{'user.domain'}; }
3011: if (!$stuname) { $stuname=$env{'user.name'}; }
3012: if (!$home) { $home=$env{'user.home'}; }
3013: my $answer=&reply("restore:$domain:$stuname:$namespace:$symb","$home");
3014:
3015: my %returnhash=();
3016: foreach my $line (split(/\&/,$answer)) {
3017: my ($name,$value)=split(/\=/,$line);
3018: $returnhash{&unescape($name)}=&thaw_unescape($value);
3019: }
3020: my $version;
3021: for ($version=1;$version<=$returnhash{'version'};$version++) {
3022: foreach my $item (split(/\:/,$returnhash{$version.':keys'})) {
3023: $returnhash{$item}=$returnhash{$version.':'.$item};
3024: }
3025: }
3026: return %returnhash;
3027: }
3028:
3029: # ---------------------------------------------------------- Course Description
3030:
3031: sub coursedescription {
3032: my ($courseid,$args)=@_;
3033: $courseid=~s/^\///;
3034: $courseid=~s/\_/\//g;
3035: my ($cdomain,$cnum)=split(/\//,$courseid);
3036: my $chome=&homeserver($cnum,$cdomain);
3037: my $normalid=$cdomain.'_'.$cnum;
3038: # need to always cache even if we get errors otherwise we keep
3039: # trying and trying and trying to get the course description.
3040: my %envhash=();
3041: my %returnhash=();
3042:
3043: my $expiretime=600;
3044: if ($env{'request.course.id'} eq $normalid) {
3045: $expiretime=120;
3046: }
3047:
3048: my $prefix='course.'.$cdomain.'_'.$cnum.'.';
3049: if (!$args->{'freshen_cache'}
3050: && ((time-$env{$prefix.'last_cache'}) < $expiretime) ) {
3051: foreach my $key (keys(%env)) {
3052: next if ($key !~ /^\Q$prefix\E(.*)/);
3053: my ($setting) = $1;
3054: $returnhash{$setting} = $env{$key};
3055: }
3056: return %returnhash;
3057: }
3058:
3059: # get the data agin
3060: if (!$args->{'one_time'}) {
3061: $envhash{'course.'.$normalid.'.last_cache'}=time;
3062: }
3063:
3064: if ($chome ne 'no_host') {
3065: %returnhash=&dump('environment',$cdomain,$cnum);
3066: if (!exists($returnhash{'con_lost'})) {
3067: $returnhash{'home'}= $chome;
3068: $returnhash{'domain'} = $cdomain;
3069: $returnhash{'num'} = $cnum;
3070: if (!defined($returnhash{'type'})) {
3071: $returnhash{'type'} = 'Course';
3072: }
3073: while (my ($name,$value) = each %returnhash) {
3074: $envhash{'course.'.$normalid.'.'.$name}=$value;
3075: }
3076: $returnhash{'url'}=&clutter($returnhash{'url'});
3077: $returnhash{'fn'}=$perlvar{'lonDaemons'}.'/tmp/'.
3078: $env{'user.name'}.'_'.$cdomain.'_'.$cnum;
3079: $envhash{'course.'.$normalid.'.home'}=$chome;
3080: $envhash{'course.'.$normalid.'.domain'}=$cdomain;
3081: $envhash{'course.'.$normalid.'.num'}=$cnum;
3082: }
3083: }
3084: if (!$args->{'one_time'}) {
3085: &appenv(%envhash);
3086: }
3087: return %returnhash;
3088: }
3089:
3090: # -------------------------------------------------See if a user is privileged
3091:
3092: sub privileged {
3093: my ($username,$domain)=@_;
3094: my $rolesdump=&reply("dump:$domain:$username:roles",
3095: &homeserver($username,$domain));
3096: if (($rolesdump eq 'con_lost') || ($rolesdump eq '')) { return 0; }
3097: my $now=time;
3098: if ($rolesdump ne '') {
3099: foreach my $entry (split(/&/,$rolesdump)) {
3100: if ($entry!~/^rolesdef_/) {
3101: my ($area,$role)=split(/=/,$entry);
3102: $area=~s/\_\w\w$//;
3103: my ($trole,$tend,$tstart)=split(/_/,$role);
3104: if (($trole eq 'dc') || ($trole eq 'su')) {
3105: my $active=1;
3106: if ($tend) {
3107: if ($tend<$now) { $active=0; }
3108: }
3109: if ($tstart) {
3110: if ($tstart>$now) { $active=0; }
3111: }
3112: if ($active) { return 1; }
3113: }
3114: }
3115: }
3116: }
3117: return 0;
3118: }
3119:
3120: # -------------------------------------------------------- Get user privileges
3121:
3122: sub rolesinit {
3123: my ($domain,$username,$authhost)=@_;
3124: my $rolesdump=reply("dump:$domain:$username:roles",$authhost);
3125: if (($rolesdump eq 'con_lost') || ($rolesdump eq '')) { return ''; }
3126: my %allroles=();
3127: my %allgroups=();
3128: my $now=time;
3129: my %userroles = ('user.login.time' => $now);
3130: my $group_privs;
3131:
3132: if ($rolesdump ne '') {
3133: foreach my $entry (split(/&/,$rolesdump)) {
3134: if ($entry!~/^rolesdef_/) {
3135: my ($area,$role)=split(/=/,$entry);
3136: $area=~s/\_\w\w$//;
3137: my ($trole,$tend,$tstart,$group_privs);
3138: if ($role=~/^cr/) {
3139: if ($role=~m|^(cr/$match_domain/$match_username/[a-zA-Z0-9]+)_(.*)$|) {
3140: ($trole,my $trest)=($role=~m|^(cr/$match_domain/$match_username/[a-zA-Z0-9]+)_(.*)$|);
3141: ($tend,$tstart)=split('_',$trest);
3142: } else {
3143: $trole=$role;
3144: }
3145: } elsif ($role =~ m|^gr/|) {
3146: ($trole,$tend,$tstart) = split(/_/,$role);
3147: ($trole,$group_privs) = split(/\//,$trole);
3148: $group_privs = &unescape($group_privs);
3149: } else {
3150: ($trole,$tend,$tstart)=split(/_/,$role);
3151: }
3152: my %new_role = &set_arearole($trole,$area,$tstart,$tend,$domain,
3153: $username);
3154: @userroles{keys(%new_role)} = @new_role{keys(%new_role)};
3155: if (($tend!=0) && ($tend<$now)) { $trole=''; }
3156: if (($tstart!=0) && ($tstart>$now)) { $trole=''; }
3157: if (($area ne '') && ($trole ne '')) {
3158: my $spec=$trole.'.'.$area;
3159: my ($tdummy,$tdomain,$trest)=split(/\//,$area);
3160: if ($trole =~ /^cr\//) {
3161: &custom_roleprivs(\%allroles,$trole,$tdomain,$trest,$spec,$area);
3162: } elsif ($trole eq 'gr') {
3163: &group_roleprivs(\%allgroups,$area,$group_privs,$tend,$tstart);
3164: } else {
3165: &standard_roleprivs(\%allroles,$trole,$tdomain,$spec,$trest,$area);
3166: }
3167: }
3168: }
3169: }
3170: my ($author,$adv) = &set_userprivs(\%userroles,\%allroles,\%allgroups);
3171: $userroles{'user.adv'} = $adv;
3172: $userroles{'user.author'} = $author;
3173: $env{'user.adv'}=$adv;
3174: }
3175: return \%userroles;
3176: }
3177:
3178: sub set_arearole {
3179: my ($trole,$area,$tstart,$tend,$domain,$username) = @_;
3180: # log the associated role with the area
3181: &userrolelog($trole,$username,$domain,$area,$tstart,$tend);
3182: return ('user.role.'.$trole.'.'.$area => $tstart.'.'.$tend);
3183: }
3184:
3185: sub custom_roleprivs {
3186: my ($allroles,$trole,$tdomain,$trest,$spec,$area) = @_;
3187: my ($rdummy,$rdomain,$rauthor,$rrole)=split(/\//,$trole);
3188: my $homsvr=homeserver($rauthor,$rdomain);
3189: if (&hostname($homsvr) ne '') {
3190: my ($rdummy,$roledef)=
3191: &get('roles',["rolesdef_$rrole"],$rdomain,$rauthor);
3192: if (($rdummy ne 'con_lost') && ($roledef ne '')) {
3193: my ($syspriv,$dompriv,$coursepriv)=split(/\_/,$roledef);
3194: if (defined($syspriv)) {
3195: $$allroles{'cm./'}.=':'.$syspriv;
3196: $$allroles{$spec.'./'}.=':'.$syspriv;
3197: }
3198: if ($tdomain ne '') {
3199: if (defined($dompriv)) {
3200: $$allroles{'cm./'.$tdomain.'/'}.=':'.$dompriv;
3201: $$allroles{$spec.'./'.$tdomain.'/'}.=':'.$dompriv;
3202: }
3203: if (($trest ne '') && (defined($coursepriv))) {
3204: $$allroles{'cm.'.$area}.=':'.$coursepriv;
3205: $$allroles{$spec.'.'.$area}.=':'.$coursepriv;
3206: }
3207: }
3208: }
3209: }
3210: }
3211:
3212: sub group_roleprivs {
3213: my ($allgroups,$area,$group_privs,$tend,$tstart) = @_;
3214: my $access = 1;
3215: my $now = time;
3216: if (($tend!=0) && ($tend<$now)) { $access = 0; }
3217: if (($tstart!=0) && ($tstart>$now)) { $access=0; }
3218: if ($access) {
3219: my ($course,$group) = ($area =~ m|(/$match_domain/$match_courseid)/([^/]+)$|);
3220: $$allgroups{$course}{$group} .=':'.$group_privs;
3221: }
3222: }
3223:
3224: sub standard_roleprivs {
3225: my ($allroles,$trole,$tdomain,$spec,$trest,$area) = @_;
3226: if (defined($pr{$trole.':s'})) {
3227: $$allroles{'cm./'}.=':'.$pr{$trole.':s'};
3228: $$allroles{$spec.'./'}.=':'.$pr{$trole.':s'};
3229: }
3230: if ($tdomain ne '') {
3231: if (defined($pr{$trole.':d'})) {
3232: $$allroles{'cm./'.$tdomain.'/'}.=':'.$pr{$trole.':d'};
3233: $$allroles{$spec.'./'.$tdomain.'/'}.=':'.$pr{$trole.':d'};
3234: }
3235: if (($trest ne '') && (defined($pr{$trole.':c'}))) {
3236: $$allroles{'cm.'.$area}.=':'.$pr{$trole.':c'};
3237: $$allroles{$spec.'.'.$area}.=':'.$pr{$trole.':c'};
3238: }
3239: }
3240: }
3241:
3242: sub set_userprivs {
3243: my ($userroles,$allroles,$allgroups) = @_;
3244: my $author=0;
3245: my $adv=0;
3246: my %grouproles = ();
3247: if (keys(%{$allgroups}) > 0) {
3248: foreach my $role (keys %{$allroles}) {
3249: my ($trole,$area,$sec,$extendedarea);
3250: if ($role =~ m-^(\w+|cr/$match_domain/$match_username/\w+)\.(/$match_domain/$match_courseid)(/?\w*)\.-) {
3251: $trole = $1;
3252: $area = $2;
3253: $sec = $3;
3254: $extendedarea = $area.$sec;
3255: if (exists($$allgroups{$area})) {
3256: foreach my $group (keys(%{$$allgroups{$area}})) {
3257: my $spec = $trole.'.'.$extendedarea;
3258: $grouproles{$spec.'.'.$area.'/'.$group} =
3259: $$allgroups{$area}{$group};
3260: }
3261: }
3262: }
3263: }
3264: }
3265: foreach my $group (keys(%grouproles)) {
3266: $$allroles{$group} = $grouproles{$group};
3267: }
3268: foreach my $role (keys(%{$allroles})) {
3269: my %thesepriv;
3270: if (($role=~/^au/) || ($role=~/^ca/)) { $author=1; }
3271: foreach my $item (split(/:/,$$allroles{$role})) {
3272: if ($item ne '') {
3273: my ($privilege,$restrictions)=split(/&/,$item);
3274: if ($restrictions eq '') {
3275: $thesepriv{$privilege}='F';
3276: } elsif ($thesepriv{$privilege} ne 'F') {
3277: $thesepriv{$privilege}.=$restrictions;
3278: }
3279: if ($thesepriv{'adv'} eq 'F') { $adv=1; }
3280: }
3281: }
3282: my $thesestr='';
3283: foreach my $priv (keys(%thesepriv)) {
3284: $thesestr.=':'.$priv.'&'.$thesepriv{$priv};
3285: }
3286: $userroles->{'user.priv.'.$role} = $thesestr;
3287: }
3288: return ($author,$adv);
3289: }
3290:
3291: # --------------------------------------------------------------- get interface
3292:
3293: sub get {
3294: my ($namespace,$storearr,$udomain,$uname)=@_;
3295: my $items='';
3296: foreach my $item (@$storearr) {
3297: $items.=&escape($item).'&';
3298: }
3299: $items=~s/\&$//;
3300: if (!$udomain) { $udomain=$env{'user.domain'}; }
3301: if (!$uname) { $uname=$env{'user.name'}; }
3302: my $uhome=&homeserver($uname,$udomain);
3303:
3304: my $rep=&reply("get:$udomain:$uname:$namespace:$items",$uhome);
3305: my @pairs=split(/\&/,$rep);
3306: if ( $#pairs==0 && $pairs[0] =~ /^(con_lost|error|no_such_host)/i) {
3307: return @pairs;
3308: }
3309: my %returnhash=();
3310: my $i=0;
3311: foreach my $item (@$storearr) {
3312: $returnhash{$item}=&thaw_unescape($pairs[$i]);
3313: $i++;
3314: }
3315: return %returnhash;
3316: }
3317:
3318: # --------------------------------------------------------------- del interface
3319:
3320: sub del {
3321: my ($namespace,$storearr,$udomain,$uname)=@_;
3322: my $items='';
3323: foreach my $item (@$storearr) {
3324: $items.=&escape($item).'&';
3325: }
3326: $items=~s/\&$//;
3327: if (!$udomain) { $udomain=$env{'user.domain'}; }
3328: if (!$uname) { $uname=$env{'user.name'}; }
3329: my $uhome=&homeserver($uname,$udomain);
3330:
3331: return &reply("del:$udomain:$uname:$namespace:$items",$uhome);
3332: }
3333:
3334: # -------------------------------------------------------------- dump interface
3335:
3336: sub dump {
3337: my ($namespace,$udomain,$uname,$regexp,$range)=@_;
3338: if (!$udomain) { $udomain=$env{'user.domain'}; }
3339: if (!$uname) { $uname=$env{'user.name'}; }
3340: my $uhome=&homeserver($uname,$udomain);
3341: if ($regexp) {
3342: $regexp=&escape($regexp);
3343: } else {
3344: $regexp='.';
3345: }
3346: my $rep=&reply("dump:$udomain:$uname:$namespace:$regexp:$range",$uhome);
3347: my @pairs=split(/\&/,$rep);
3348: my %returnhash=();
3349: foreach my $item (@pairs) {
3350: my ($key,$value)=split(/=/,$item,2);
3351: $key = &unescape($key);
3352: next if ($key =~ /^error: 2 /);
3353: $returnhash{$key}=&thaw_unescape($value);
3354: }
3355: return %returnhash;
3356: }
3357:
3358: # --------------------------------------------------------- dumpstore interface
3359:
3360: sub dumpstore {
3361: my ($namespace,$udomain,$uname,$regexp,$range)=@_;
3362: if (!$udomain) { $udomain=$env{'user.domain'}; }
3363: if (!$uname) { $uname=$env{'user.name'}; }
3364: my $uhome=&homeserver($uname,$udomain);
3365: if ($regexp) {
3366: $regexp=&escape($regexp);
3367: } else {
3368: $regexp='.';
3369: }
3370: my $rep=&reply("dump:$udomain:$uname:$namespace:$regexp:$range",$uhome);
3371: my @pairs=split(/\&/,$rep);
3372: my %returnhash=();
3373: foreach my $item (@pairs) {
3374: my ($key,$value)=split(/=/,$item,2);
3375: next if ($key =~ /^error: 2 /);
3376: $returnhash{$key}=&thaw_unescape($value);
3377: }
3378: return %returnhash;
3379: }
3380:
3381: # -------------------------------------------------------------- keys interface
3382:
3383: sub getkeys {
3384: my ($namespace,$udomain,$uname)=@_;
3385: if (!$udomain) { $udomain=$env{'user.domain'}; }
3386: if (!$uname) { $uname=$env{'user.name'}; }
3387: my $uhome=&homeserver($uname,$udomain);
3388: my $rep=reply("keys:$udomain:$uname:$namespace",$uhome);
3389: my @keyarray=();
3390: foreach my $key (split(/\&/,$rep)) {
3391: next if ($key =~ /^error: 2 /);
3392: push(@keyarray,&unescape($key));
3393: }
3394: return @keyarray;
3395: }
3396:
3397: # --------------------------------------------------------------- currentdump
3398: sub currentdump {
3399: my ($courseid,$sdom,$sname)=@_;
3400: $courseid = $env{'request.course.id'} if (! defined($courseid));
3401: $sdom = $env{'user.domain'} if (! defined($sdom));
3402: $sname = $env{'user.name'} if (! defined($sname));
3403: my $uhome = &homeserver($sname,$sdom);
3404: my $rep=reply('currentdump:'.$sdom.':'.$sname.':'.$courseid,$uhome);
3405: return if ($rep =~ /^(error:|no_such_host)/);
3406: #
3407: my %returnhash=();
3408: #
3409: if ($rep eq "unknown_cmd") {
3410: # an old lond will not know currentdump
3411: # Do a dump and make it look like a currentdump
3412: my @tmp = &dumpstore($courseid,$sdom,$sname,'.');
3413: return if ($tmp[0] =~ /^(error:|no_such_host)/);
3414: my %hash = @tmp;
3415: @tmp=();
3416: %returnhash = %{&convert_dump_to_currentdump(\%hash)};
3417: } else {
3418: my @pairs=split(/\&/,$rep);
3419: foreach my $pair (@pairs) {
3420: my ($key,$value)=split(/=/,$pair,2);
3421: my ($symb,$param) = split(/:/,$key);
3422: $returnhash{&unescape($symb)}->{&unescape($param)} =
3423: &thaw_unescape($value);
3424: }
3425: }
3426: return %returnhash;
3427: }
3428:
3429: sub convert_dump_to_currentdump{
3430: my %hash = %{shift()};
3431: my %returnhash;
3432: # Code ripped from lond, essentially. The only difference
3433: # here is the unescaping done by lonnet::dump(). Conceivably
3434: # we might run in to problems with parameter names =~ /^v\./
3435: while (my ($key,$value) = each(%hash)) {
3436: my ($v,$symb,$param) = split(/:/,$key);
3437: $symb = &unescape($symb);
3438: $param = &unescape($param);
3439: next if ($v eq 'version' || $symb eq 'keys');
3440: next if (exists($returnhash{$symb}) &&
3441: exists($returnhash{$symb}->{$param}) &&
3442: $returnhash{$symb}->{'v.'.$param} > $v);
3443: $returnhash{$symb}->{$param}=$value;
3444: $returnhash{$symb}->{'v.'.$param}=$v;
3445: }
3446: #
3447: # Remove all of the keys in the hashes which keep track of
3448: # the version of the parameter.
3449: while (my ($symb,$param_hash) = each(%returnhash)) {
3450: # use a foreach because we are going to delete from the hash.
3451: foreach my $key (keys(%$param_hash)) {
3452: delete($param_hash->{$key}) if ($key =~ /^v\./);
3453: }
3454: }
3455: return \%returnhash;
3456: }
3457:
3458: # ------------------------------------------------------ critical inc interface
3459:
3460: sub cinc {
3461: return &inc(@_,'critical');
3462: }
3463:
3464: # --------------------------------------------------------------- inc interface
3465:
3466: sub inc {
3467: my ($namespace,$store,$udomain,$uname,$critical) = @_;
3468: if (!$udomain) { $udomain=$env{'user.domain'}; }
3469: if (!$uname) { $uname=$env{'user.name'}; }
3470: my $uhome=&homeserver($uname,$udomain);
3471: my $items='';
3472: if (! ref($store)) {
3473: # got a single value, so use that instead
3474: $items = &escape($store).'=&';
3475: } elsif (ref($store) eq 'SCALAR') {
3476: $items = &escape($$store).'=&';
3477: } elsif (ref($store) eq 'ARRAY') {
3478: $items = join('=&',map {&escape($_);} @{$store});
3479: } elsif (ref($store) eq 'HASH') {
3480: while (my($key,$value) = each(%{$store})) {
3481: $items.= &escape($key).'='.&escape($value).'&';
3482: }
3483: }
3484: $items=~s/\&$//;
3485: if ($critical) {
3486: return &critical("inc:$udomain:$uname:$namespace:$items",$uhome);
3487: } else {
3488: return &reply("inc:$udomain:$uname:$namespace:$items",$uhome);
3489: }
3490: }
3491:
3492: # --------------------------------------------------------------- put interface
3493:
3494: sub put {
3495: my ($namespace,$storehash,$udomain,$uname)=@_;
3496: if (!$udomain) { $udomain=$env{'user.domain'}; }
3497: if (!$uname) { $uname=$env{'user.name'}; }
3498: my $uhome=&homeserver($uname,$udomain);
3499: my $items='';
3500: foreach my $item (keys(%$storehash)) {
3501: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
3502: }
3503: $items=~s/\&$//;
3504: return &reply("put:$udomain:$uname:$namespace:$items",$uhome);
3505: }
3506:
3507: # ------------------------------------------------------------ newput interface
3508:
3509: sub newput {
3510: my ($namespace,$storehash,$udomain,$uname)=@_;
3511: if (!$udomain) { $udomain=$env{'user.domain'}; }
3512: if (!$uname) { $uname=$env{'user.name'}; }
3513: my $uhome=&homeserver($uname,$udomain);
3514: my $items='';
3515: foreach my $key (keys(%$storehash)) {
3516: $items.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
3517: }
3518: $items=~s/\&$//;
3519: return &reply("newput:$udomain:$uname:$namespace:$items",$uhome);
3520: }
3521:
3522: # --------------------------------------------------------- putstore interface
3523:
3524: sub putstore {
3525: my ($namespace,$symb,$version,$storehash,$udomain,$uname)=@_;
3526: if (!$udomain) { $udomain=$env{'user.domain'}; }
3527: if (!$uname) { $uname=$env{'user.name'}; }
3528: my $uhome=&homeserver($uname,$udomain);
3529: my $items='';
3530: foreach my $key (keys(%$storehash)) {
3531: $items.= &escape($key).'='.&freeze_escape($storehash->{$key}).'&';
3532: }
3533: $items=~s/\&$//;
3534: my $esc_symb=&escape($symb);
3535: my $esc_v=&escape($version);
3536: my $reply =
3537: &reply("putstore:$udomain:$uname:$namespace:$esc_symb:$esc_v:$items",
3538: $uhome);
3539: if ($reply eq 'unknown_cmd') {
3540: # gfall back to way things use to be done
3541: return &old_putstore($namespace,$symb,$version,$storehash,$udomain,
3542: $uname);
3543: }
3544: return $reply;
3545: }
3546:
3547: sub old_putstore {
3548: my ($namespace,$symb,$version,$storehash,$udomain,$uname)=@_;
3549: if (!$udomain) { $udomain=$env{'user.domain'}; }
3550: if (!$uname) { $uname=$env{'user.name'}; }
3551: my $uhome=&homeserver($uname,$udomain);
3552: my %newstorehash;
3553: foreach my $item (keys(%$storehash)) {
3554: my $key = $version.':'.&escape($symb).':'.$item;
3555: $newstorehash{$key} = $storehash->{$item};
3556: }
3557: my $items='';
3558: my %allitems = ();
3559: foreach my $item (keys(%newstorehash)) {
3560: if ($item =~ m/^([^\:]+):([^\:]+):([^\:]+)$/) {
3561: my $key = $1.':keys:'.$2;
3562: $allitems{$key} .= $3.':';
3563: }
3564: $items.=$item.'='.&freeze_escape($newstorehash{$item}).'&';
3565: }
3566: foreach my $item (keys(%allitems)) {
3567: $allitems{$item} =~ s/\:$//;
3568: $items.= $item.'='.$allitems{$item}.'&';
3569: }
3570: $items=~s/\&$//;
3571: return &reply("put:$udomain:$uname:$namespace:$items",$uhome);
3572: }
3573:
3574: # ------------------------------------------------------ critical put interface
3575:
3576: sub cput {
3577: my ($namespace,$storehash,$udomain,$uname)=@_;
3578: if (!$udomain) { $udomain=$env{'user.domain'}; }
3579: if (!$uname) { $uname=$env{'user.name'}; }
3580: my $uhome=&homeserver($uname,$udomain);
3581: my $items='';
3582: foreach my $item (keys(%$storehash)) {
3583: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
3584: }
3585: $items=~s/\&$//;
3586: return &critical("put:$udomain:$uname:$namespace:$items",$uhome);
3587: }
3588:
3589: # -------------------------------------------------------------- eget interface
3590:
3591: sub eget {
3592: my ($namespace,$storearr,$udomain,$uname)=@_;
3593: my $items='';
3594: foreach my $item (@$storearr) {
3595: $items.=&escape($item).'&';
3596: }
3597: $items=~s/\&$//;
3598: if (!$udomain) { $udomain=$env{'user.domain'}; }
3599: if (!$uname) { $uname=$env{'user.name'}; }
3600: my $uhome=&homeserver($uname,$udomain);
3601: my $rep=&reply("eget:$udomain:$uname:$namespace:$items",$uhome);
3602: my @pairs=split(/\&/,$rep);
3603: my %returnhash=();
3604: my $i=0;
3605: foreach my $item (@$storearr) {
3606: $returnhash{$item}=&thaw_unescape($pairs[$i]);
3607: $i++;
3608: }
3609: return %returnhash;
3610: }
3611:
3612: # ------------------------------------------------------------ tmpput interface
3613: sub tmpput {
3614: my ($storehash,$server,$context)=@_;
3615: my $items='';
3616: foreach my $item (keys(%$storehash)) {
3617: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
3618: }
3619: $items=~s/\&$//;
3620: if (defined($context)) {
3621: $items .= ':'.&escape($context);
3622: }
3623: return &reply("tmpput:$items",$server);
3624: }
3625:
3626: # ------------------------------------------------------------ tmpget interface
3627: sub tmpget {
3628: my ($token,$server)=@_;
3629: if (!defined($server)) { $server = $perlvar{'lonHostID'}; }
3630: my $rep=&reply("tmpget:$token",$server);
3631: my %returnhash;
3632: foreach my $item (split(/\&/,$rep)) {
3633: my ($key,$value)=split(/=/,$item);
3634: $returnhash{&unescape($key)}=&thaw_unescape($value);
3635: }
3636: return %returnhash;
3637: }
3638:
3639: # ------------------------------------------------------------ tmpget interface
3640: sub tmpdel {
3641: my ($token,$server)=@_;
3642: if (!defined($server)) { $server = $perlvar{'lonHostID'}; }
3643: return &reply("tmpdel:$token",$server);
3644: }
3645:
3646: # -------------------------------------------------- portfolio access checking
3647:
3648: sub portfolio_access {
3649: my ($requrl) = @_;
3650: my (undef,$udom,$unum,$file_name,$group) = &parse_portfolio_url($requrl);
3651: my $result = &get_portfolio_access($udom,$unum,$file_name,$group);
3652: if ($result) {
3653: my %setters;
3654: if ($env{'user.name'} eq 'public' && $env{'user.domain'} eq 'public') {
3655: my ($startblock,$endblock) =
3656: &Apache::loncommon::blockcheck(\%setters,'port',$unum,$udom);
3657: if ($startblock && $endblock) {
3658: return 'B';
3659: }
3660: } else {
3661: my ($startblock,$endblock) =
3662: &Apache::loncommon::blockcheck(\%setters,'port');
3663: if ($startblock && $endblock) {
3664: return 'B';
3665: }
3666: }
3667: }
3668: if ($result eq 'ok') {
3669: return 'F';
3670: } elsif ($result =~ /^[^:]+:guest_/) {
3671: return 'A';
3672: }
3673: return '';
3674: }
3675:
3676: sub get_portfolio_access {
3677: my ($udom,$unum,$file_name,$group,$access_hash) = @_;
3678:
3679: if (!ref($access_hash)) {
3680: my $current_perms = &get_portfile_permissions($udom,$unum);
3681: my %access_controls = &get_access_controls($current_perms,$group,
3682: $file_name);
3683: $access_hash = $access_controls{$file_name};
3684: }
3685:
3686: my ($public,$guest,@domains,@users,@courses,@groups);
3687: my $now = time;
3688: if (ref($access_hash) eq 'HASH') {
3689: foreach my $key (keys(%{$access_hash})) {
3690: my ($num,$scope,$end,$start) = ($key =~ /^([^:]+):([a-z]+)_(\d*)_?(\d*)$/);
3691: if ($start > $now) {
3692: next;
3693: }
3694: if ($end && $end<$now) {
3695: next;
3696: }
3697: if ($scope eq 'public') {
3698: $public = $key;
3699: last;
3700: } elsif ($scope eq 'guest') {
3701: $guest = $key;
3702: } elsif ($scope eq 'domains') {
3703: push(@domains,$key);
3704: } elsif ($scope eq 'users') {
3705: push(@users,$key);
3706: } elsif ($scope eq 'course') {
3707: push(@courses,$key);
3708: } elsif ($scope eq 'group') {
3709: push(@groups,$key);
3710: }
3711: }
3712: if ($public) {
3713: return 'ok';
3714: }
3715: if ($env{'user.name'} eq 'public' && $env{'user.domain'} eq 'public') {
3716: if ($guest) {
3717: return $guest;
3718: }
3719: } else {
3720: if (@domains > 0) {
3721: foreach my $domkey (@domains) {
3722: if (ref($access_hash->{$domkey}{'dom'}) eq 'ARRAY') {
3723: if (grep(/^\Q$env{'user.domain'}\E$/,@{$access_hash->{$domkey}{'dom'}})) {
3724: return 'ok';
3725: }
3726: }
3727: }
3728: }
3729: if (@users > 0) {
3730: foreach my $userkey (@users) {
3731: if (ref($access_hash->{$userkey}{'users'}) eq 'ARRAY') {
3732: foreach my $item (@{$access_hash->{$userkey}{'users'}}) {
3733: if (ref($item) eq 'HASH') {
3734: if (($item->{'uname'} eq $env{'user.name'}) &&
3735: ($item->{'udom'} eq $env{'user.domain'})) {
3736: return 'ok';
3737: }
3738: }
3739: }
3740: }
3741: }
3742: }
3743: my %roleshash;
3744: my @courses_and_groups = @courses;
3745: push(@courses_and_groups,@groups);
3746: if (@courses_and_groups > 0) {
3747: my (%allgroups,%allroles);
3748: my ($start,$end,$role,$sec,$group);
3749: foreach my $envkey (%env) {
3750: if ($envkey =~ m-^user\.role\.(gr|cc|in|ta|ep|st)\./($match_domain)/($match_courseid)/?([^/]*)$-) {
3751: my $cid = $2.'_'.$3;
3752: if ($1 eq 'gr') {
3753: $group = $4;
3754: $allgroups{$cid}{$group} = $env{$envkey};
3755: } else {
3756: if ($4 eq '') {
3757: $sec = 'none';
3758: } else {
3759: $sec = $4;
3760: }
3761: $allroles{$cid}{$1}{$sec} = $env{$envkey};
3762: }
3763: } elsif ($envkey =~ m-^user\.role\./cr/($match_domain/$match_username/\w*)./($match_domain)/($match_courseid)/?([^/]*)$-) {
3764: my $cid = $2.'_'.$3;
3765: if ($4 eq '') {
3766: $sec = 'none';
3767: } else {
3768: $sec = $4;
3769: }
3770: $allroles{$cid}{$1}{$sec} = $env{$envkey};
3771: }
3772: }
3773: if (keys(%allroles) == 0) {
3774: return;
3775: }
3776: foreach my $key (@courses_and_groups) {
3777: my %content = %{$$access_hash{$key}};
3778: my $cnum = $content{'number'};
3779: my $cdom = $content{'domain'};
3780: my $cid = $cdom.'_'.$cnum;
3781: if (!exists($allroles{$cid})) {
3782: next;
3783: }
3784: foreach my $role_id (keys(%{$content{'roles'}})) {
3785: my @sections = @{$content{'roles'}{$role_id}{'section'}};
3786: my @groups = @{$content{'roles'}{$role_id}{'group'}};
3787: my @status = @{$content{'roles'}{$role_id}{'access'}};
3788: my @roles = @{$content{'roles'}{$role_id}{'role'}};
3789: foreach my $role (keys(%{$allroles{$cid}})) {
3790: if ((grep/^all$/,@roles) || (grep/^\Q$role\E$/,@roles)) {
3791: foreach my $sec (keys(%{$allroles{$cid}{$role}})) {
3792: if (&course_group_datechecker($allroles{$cid}{$role}{$sec},$now,\@status) eq 'ok') {
3793: if (grep/^all$/,@sections) {
3794: return 'ok';
3795: } else {
3796: if (grep/^$sec$/,@sections) {
3797: return 'ok';
3798: }
3799: }
3800: }
3801: }
3802: if (keys(%{$allgroups{$cid}}) == 0) {
3803: if (grep/^none$/,@groups) {
3804: return 'ok';
3805: }
3806: } else {
3807: if (grep/^all$/,@groups) {
3808: return 'ok';
3809: }
3810: foreach my $group (keys(%{$allgroups{$cid}})) {
3811: if (grep/^$group$/,@groups) {
3812: return 'ok';
3813: }
3814: }
3815: }
3816: }
3817: }
3818: }
3819: }
3820: }
3821: if ($guest) {
3822: return $guest;
3823: }
3824: }
3825: }
3826: return;
3827: }
3828:
3829: sub course_group_datechecker {
3830: my ($dates,$now,$status) = @_;
3831: my ($start,$end) = split(/\./,$dates);
3832: if (!$start && !$end) {
3833: return 'ok';
3834: }
3835: if (grep/^active$/,@{$status}) {
3836: if (((!$start) || ($start && $start <= $now)) && ((!$end) || ($end && $end >= $now))) {
3837: return 'ok';
3838: }
3839: }
3840: if (grep/^previous$/,@{$status}) {
3841: if ($end > $now ) {
3842: return 'ok';
3843: }
3844: }
3845: if (grep/^future$/,@{$status}) {
3846: if ($start > $now) {
3847: return 'ok';
3848: }
3849: }
3850: return;
3851: }
3852:
3853: sub parse_portfolio_url {
3854: my ($url) = @_;
3855:
3856: my ($type,$udom,$unum,$group,$file_name);
3857:
3858: if ($url =~ m-^/*(?:uploaded|editupload)/($match_domain)/($match_username)/portfolio(/.+)$-) {
3859: $type = 1;
3860: $udom = $1;
3861: $unum = $2;
3862: $file_name = $3;
3863: } elsif ($url =~ m-^/*(?:uploaded|editupload)/($match_domain)/($match_courseid)/groups/([^/]+)/portfolio/(.+)$-) {
3864: $type = 2;
3865: $udom = $1;
3866: $unum = $2;
3867: $group = $3;
3868: $file_name = $3.'/'.$4;
3869: }
3870: if (wantarray) {
3871: return ($type,$udom,$unum,$file_name,$group);
3872: }
3873: return $type;
3874: }
3875:
3876: sub is_portfolio_url {
3877: my ($url) = @_;
3878: return scalar(&parse_portfolio_url($url));
3879: }
3880:
3881: sub is_portfolio_file {
3882: my ($file) = @_;
3883: if (($file =~ /^portfolio/) || ($file =~ /^groups\/\w+\/portfolio/)) {
3884: return 1;
3885: }
3886: return;
3887: }
3888:
3889:
3890: # ---------------------------------------------- Custom access rule evaluation
3891:
3892: sub customaccess {
3893: my ($priv,$uri)=@_;
3894: my ($urole,$urealm)=split(/\./,$env{'request.role'},2);
3895: my (undef,$udom,$ucrs,$usec)=split(/\//,$urealm);
3896: $udom = &LONCAPA::clean_domain($udom);
3897: $ucrs = &LONCAPA::clean_username($ucrs);
3898: my $access=0;
3899: foreach my $right (split(/\s*\,\s*/,&metadata($uri,'rule_rights'))) {
3900: my ($effect,$realm,$role,$type)=split(/\:/,$right);
3901: if ($type eq 'user') {
3902: foreach my $scope (split(/\s*\,\s*/,$realm)) {
3903: my ($tdom,$tuname)=split(m{/},$scope);
3904: if ($tdom) {
3905: if ($tdom ne $env{'user.domain'}) { next; }
3906: }
3907: if ($tuname) {
3908: if ($tuname ne $env{'user.name'}) { next; }
3909: }
3910: $access=($effect eq 'allow');
3911: last;
3912: }
3913: } else {
3914: if ($role) {
3915: if ($role ne $urole) { next; }
3916: }
3917: foreach my $scope (split(/\s*\,\s*/,$realm)) {
3918: my ($tdom,$tcrs,$tsec)=split(/\_/,$scope);
3919: if ($tdom) {
3920: if ($tdom ne $udom) { next; }
3921: }
3922: if ($tcrs) {
3923: if ($tcrs ne $ucrs) { next; }
3924: }
3925: if ($tsec) {
3926: if ($tsec ne $usec) { next; }
3927: }
3928: $access=($effect eq 'allow');
3929: last;
3930: }
3931: if ($realm eq '' && $role eq '') {
3932: $access=($effect eq 'allow');
3933: }
3934: }
3935: }
3936: return $access;
3937: }
3938:
3939: # ------------------------------------------------- Check for a user privilege
3940:
3941: sub allowed {
3942: my ($priv,$uri,$symb,$role)=@_;
3943: my $ver_orguri=$uri;
3944: $uri=&deversion($uri);
3945: my $orguri=$uri;
3946: $uri=&declutter($uri);
3947:
3948: if ($priv eq 'evb') {
3949: # Evade communication block restrictions for specified role in a course
3950: if ($env{'user.priv.'.$role} =~/evb\&([^\:]*)/) {
3951: return $1;
3952: } else {
3953: return;
3954: }
3955: }
3956:
3957: if (defined($env{'allowed.'.$priv})) { return $env{'allowed.'.$priv}; }
3958: # Free bre access to adm and meta resources
3959: if (((($uri=~/^adm\//) && ($uri !~ m{/(?:smppg|bulletinboard)$}))
3960: || (($uri=~/\.meta$/) && ($uri!~m|^uploaded/|) ))
3961: && ($priv eq 'bre')) {
3962: return 'F';
3963: }
3964:
3965: # Free bre access to user's own portfolio contents
3966: my ($space,$domain,$name,@dir)=split('/',$uri);
3967: if (($space=~/^(uploaded|editupload)$/) && ($env{'user.name'} eq $name) &&
3968: ($env{'user.domain'} eq $domain) && ('portfolio' eq $dir[0])) {
3969: my %setters;
3970: my ($startblock,$endblock) =
3971: &Apache::loncommon::blockcheck(\%setters,'port');
3972: if ($startblock && $endblock) {
3973: return 'B';
3974: } else {
3975: return 'F';
3976: }
3977: }
3978:
3979: # bre access to group portfolio for rgf priv in group, or mdg or vcg in course.
3980: if (($space=~/^(uploaded|editupload)$/) && ($dir[0] eq 'groups')
3981: && ($dir[2] eq 'portfolio') && ($priv eq 'bre')) {
3982: if (exists($env{'request.course.id'})) {
3983: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
3984: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
3985: if (($domain eq $cdom) && ($name eq $cnum)) {
3986: my $courseprivid=$env{'request.course.id'};
3987: $courseprivid=~s/\_/\//;
3988: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid
3989: .'/'.$dir[1]} =~/rgf\&([^\:]*)/) {
3990: return $1;
3991: } else {
3992: if ($env{'request.course.sec'}) {
3993: $courseprivid.='/'.$env{'request.course.sec'};
3994: }
3995: if ($env{'user.priv.'.$env{'request.role'}.'./'.
3996: $courseprivid} =~/(mdg|vcg)\&([^\:]*)/) {
3997: return $2;
3998: }
3999: }
4000: }
4001: }
4002: }
4003:
4004: # Free bre to public access
4005:
4006: if ($priv eq 'bre') {
4007: my $copyright=&metadata($uri,'copyright');
4008: if (($copyright eq 'public') && (!$env{'request.course.id'})) {
4009: return 'F';
4010: }
4011: if ($copyright eq 'priv') {
4012: $uri=~/([^\/]+)\/([^\/]+)\//;
4013: unless (($env{'user.name'} eq $2) && ($env{'user.domain'} eq $1)) {
4014: return '';
4015: }
4016: }
4017: if ($copyright eq 'domain') {
4018: $uri=~/([^\/]+)\/([^\/]+)\//;
4019: unless (($env{'user.domain'} eq $1) ||
4020: ($env{'course.'.$env{'request.course.id'}.'.domain'} eq $1)) {
4021: return '';
4022: }
4023: }
4024: if ($env{'request.role'}=~ /li\.\//) {
4025: # Library role, so allow browsing of resources in this domain.
4026: return 'F';
4027: }
4028: if ($copyright eq 'custom') {
4029: unless (&customaccess($priv,$uri)) { return ''; }
4030: }
4031: }
4032: # Domain coordinator is trying to create a course
4033: if (($priv eq 'ccc') && ($env{'request.role'} =~ /^dc\./)) {
4034: # uri is the requested domain in this case.
4035: # comparison to 'request.role.domain' shows if the user has selected
4036: # a role of dc for the domain in question.
4037: return 'F' if ($uri eq $env{'request.role.domain'});
4038: }
4039:
4040: my $thisallowed='';
4041: my $statecond=0;
4042: my $courseprivid='';
4043:
4044: # Course
4045:
4046: if ($env{'user.priv.'.$env{'request.role'}.'./'}=~/\Q$priv\E\&([^\:]*)/) {
4047: $thisallowed.=$1;
4048: }
4049:
4050: # Domain
4051:
4052: if ($env{'user.priv.'.$env{'request.role'}.'./'.(split(/\//,$uri))[0].'/'}
4053: =~/\Q$priv\E\&([^\:]*)/) {
4054: $thisallowed.=$1;
4055: }
4056:
4057: # Course: uri itself is a course
4058: my $courseuri=$uri;
4059: $courseuri=~s/\_(\d)/\/$1/;
4060: $courseuri=~s/^([^\/])/\/$1/;
4061:
4062: if ($env{'user.priv.'.$env{'request.role'}.'.'.$courseuri}
4063: =~/\Q$priv\E\&([^\:]*)/) {
4064: $thisallowed.=$1;
4065: }
4066:
4067: # URI is an uploaded document for this course, default permissions don't matter
4068: # not allowing 'edit' access (editupload) to uploaded course docs
4069: if (($priv eq 'bre') && ($uri=~m|^uploaded/|)) {
4070: $thisallowed='';
4071: my ($match)=&is_on_map($uri);
4072: if ($match) {
4073: if ($env{'user.priv.'.$env{'request.role'}.'./'}
4074: =~/\Q$priv\E\&([^\:]*)/) {
4075: $thisallowed.=$1;
4076: }
4077: } else {
4078: my $refuri = $env{'httpref.'.$orguri} || $env{'httpref.'.$ver_orguri};
4079: if ($refuri) {
4080: if ($refuri =~ m|^/adm/|) {
4081: $thisallowed='F';
4082: } else {
4083: $refuri=&declutter($refuri);
4084: my ($match) = &is_on_map($refuri);
4085: if ($match) {
4086: $thisallowed='F';
4087: }
4088: }
4089: }
4090: }
4091: }
4092:
4093: if ($priv eq 'bre'
4094: && $thisallowed ne 'F'
4095: && $thisallowed ne '2'
4096: && &is_portfolio_url($uri)) {
4097: $thisallowed = &portfolio_access($uri);
4098: }
4099:
4100: # Full access at system, domain or course-wide level? Exit.
4101:
4102: if ($thisallowed=~/F/) {
4103: return 'F';
4104: }
4105:
4106: # If this is generating or modifying users, exit with special codes
4107:
4108: if (':csu:cdc:ccc:cin:cta:cep:ccr:cst:cad:cli:cau:cdg:cca:caa:'=~/\:\Q$priv\E\:/) {
4109: if (($priv eq 'cca') || ($priv eq 'caa')) {
4110: my ($audom,$auname)=split('/',$uri);
4111: # no author name given, so this just checks on the general right to make a co-author in this domain
4112: unless ($auname) { return $thisallowed; }
4113: # an author name is given, so we are about to actually make a co-author for a certain account
4114: if (($auname ne $env{'user.name'} && $env{'request.role'} !~ /^dc\./) ||
4115: (($audom ne $env{'user.domain'} && $env{'request.role'} !~ /^dc\./) &&
4116: ($audom ne $env{'request.role.domain'}))) { return ''; }
4117: }
4118: return $thisallowed;
4119: }
4120: #
4121: # Gathered so far: system, domain and course wide privileges
4122: #
4123: # Course: See if uri or referer is an individual resource that is part of
4124: # the course
4125:
4126: if ($env{'request.course.id'}) {
4127:
4128: $courseprivid=$env{'request.course.id'};
4129: if ($env{'request.course.sec'}) {
4130: $courseprivid.='/'.$env{'request.course.sec'};
4131: }
4132: $courseprivid=~s/\_/\//;
4133: my $checkreferer=1;
4134: my ($match,$cond)=&is_on_map($uri);
4135: if ($match) {
4136: $statecond=$cond;
4137: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid}
4138: =~/\Q$priv\E\&([^\:]*)/) {
4139: $thisallowed.=$1;
4140: $checkreferer=0;
4141: }
4142: }
4143:
4144: if ($checkreferer) {
4145: my $refuri=$env{'httpref.'.$orguri};
4146: unless ($refuri) {
4147: foreach my $key (keys(%env)) {
4148: if ($key=~/^httpref\..*\*/) {
4149: my $pattern=$key;
4150: $pattern=~s/^httpref\.\/res\///;
4151: $pattern=~s/\*/\[\^\/\]\+/g;
4152: $pattern=~s/\//\\\//g;
4153: if ($orguri=~/$pattern/) {
4154: $refuri=$env{$key};
4155: }
4156: }
4157: }
4158: }
4159:
4160: if ($refuri) {
4161: $refuri=&declutter($refuri);
4162: my ($match,$cond)=&is_on_map($refuri);
4163: if ($match) {
4164: my $refstatecond=$cond;
4165: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid}
4166: =~/\Q$priv\E\&([^\:]*)/) {
4167: $thisallowed.=$1;
4168: $uri=$refuri;
4169: $statecond=$refstatecond;
4170: }
4171: }
4172: }
4173: }
4174: }
4175:
4176: #
4177: # Gathered now: all privileges that could apply, and condition number
4178: #
4179: #
4180: # Full or no access?
4181: #
4182:
4183: if ($thisallowed=~/F/) {
4184: return 'F';
4185: }
4186:
4187: unless ($thisallowed) {
4188: return '';
4189: }
4190:
4191: # Restrictions exist, deal with them
4192: #
4193: # C:according to course preferences
4194: # R:according to resource settings
4195: # L:unless locked
4196: # X:according to user session state
4197: #
4198:
4199: # Possibly locked functionality, check all courses
4200: # Locks might take effect only after 10 minutes cache expiration for other
4201: # courses, and 2 minutes for current course
4202:
4203: my $envkey;
4204: if ($thisallowed=~/L/) {
4205: foreach $envkey (keys %env) {
4206: if ($envkey=~/^user\.role\.(st|ta)\.([^\.]*)/) {
4207: my $courseid=$2;
4208: my $roleid=$1.'.'.$2;
4209: $courseid=~s/^\///;
4210: my $expiretime=600;
4211: if ($env{'request.role'} eq $roleid) {
4212: $expiretime=120;
4213: }
4214: my ($cdom,$cnum,$csec)=split(/\//,$courseid);
4215: my $prefix='course.'.$cdom.'_'.$cnum.'.';
4216: if ((time-$env{$prefix.'last_cache'})>$expiretime) {
4217: &coursedescription($courseid,{'freshen_cache' => 1});
4218: }
4219: if (($env{$prefix.'res.'.$uri.'.lock.sections'}=~/\,\Q$csec\E\,/)
4220: || ($env{$prefix.'res.'.$uri.'.lock.sections'} eq 'all')) {
4221: if ($env{$prefix.'res.'.$uri.'.lock.expire'}>time) {
4222: &log($env{'user.domain'},$env{'user.name'},
4223: $env{'user.home'},
4224: 'Locked by res: '.$priv.' for '.$uri.' due to '.
4225: $cdom.'/'.$cnum.'/'.$csec.' expire '.
4226: $env{$prefix.'priv.'.$priv.'.lock.expire'});
4227: return '';
4228: }
4229: }
4230: if (($env{$prefix.'priv.'.$priv.'.lock.sections'}=~/\,\Q$csec\E\,/)
4231: || ($env{$prefix.'priv.'.$priv.'.lock.sections'} eq 'all')) {
4232: if ($env{'priv.'.$priv.'.lock.expire'}>time) {
4233: &log($env{'user.domain'},$env{'user.name'},
4234: $env{'user.home'},
4235: 'Locked by priv: '.$priv.' for '.$uri.' due to '.
4236: $cdom.'/'.$cnum.'/'.$csec.' expire '.
4237: $env{$prefix.'priv.'.$priv.'.lock.expire'});
4238: return '';
4239: }
4240: }
4241: }
4242: }
4243: }
4244:
4245: #
4246: # Rest of the restrictions depend on selected course
4247: #
4248:
4249: unless ($env{'request.course.id'}) {
4250: if ($thisallowed eq 'A') {
4251: return 'A';
4252: } elsif ($thisallowed eq 'B') {
4253: return 'B';
4254: } else {
4255: return '1';
4256: }
4257: }
4258:
4259: #
4260: # Now user is definitely in a course
4261: #
4262:
4263:
4264: # Course preferences
4265:
4266: if ($thisallowed=~/C/) {
4267: my $rolecode=(split(/\./,$env{'request.role'}))[0];
4268: my $unamedom=$env{'user.name'}.':'.$env{'user.domain'};
4269: if ($env{'course.'.$env{'request.course.id'}.'.'.$priv.'.roles.denied'}
4270: =~/\Q$rolecode\E/) {
4271: if ($priv ne 'pch') {
4272: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.':'.
4273: 'Denied by role: '.$priv.' for '.$uri.' as '.$rolecode.' in '.
4274: $env{'request.course.id'});
4275: }
4276: return '';
4277: }
4278:
4279: if ($env{'course.'.$env{'request.course.id'}.'.'.$priv.'.users.denied'}
4280: =~/\Q$unamedom\E/) {
4281: if ($priv ne 'pch') {
4282: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.
4283: 'Denied by user: '.$priv.' for '.$uri.' as '.$unamedom.' in '.
4284: $env{'request.course.id'});
4285: }
4286: return '';
4287: }
4288: }
4289:
4290: # Resource preferences
4291:
4292: if ($thisallowed=~/R/) {
4293: my $rolecode=(split(/\./,$env{'request.role'}))[0];
4294: if (&metadata($uri,'roledeny')=~/\Q$rolecode\E/) {
4295: if ($priv ne 'pch') {
4296: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.':'.
4297: 'Denied by role: '.$priv.' for '.$uri.' as '.$rolecode);
4298: }
4299: return '';
4300: }
4301: }
4302:
4303: # Restricted by state or randomout?
4304:
4305: if ($thisallowed=~/X/) {
4306: if ($env{'acc.randomout'}) {
4307: if (!$symb) { $symb=&symbread($uri,1); }
4308: if (($symb) && ($env{'acc.randomout'}=~/\&\Q$symb\E\&/)) {
4309: return '';
4310: }
4311: }
4312: if (&condval($statecond)) {
4313: return '2';
4314: } else {
4315: return '';
4316: }
4317: }
4318:
4319: if ($thisallowed eq 'A') {
4320: return 'A';
4321: } elsif ($thisallowed eq 'B') {
4322: return 'B';
4323: }
4324: return 'F';
4325: }
4326:
4327: sub split_uri_for_cond {
4328: my $uri=&deversion(&declutter(shift));
4329: my @uriparts=split(/\//,$uri);
4330: my $filename=pop(@uriparts);
4331: my $pathname=join('/',@uriparts);
4332: return ($pathname,$filename);
4333: }
4334: # --------------------------------------------------- Is a resource on the map?
4335:
4336: sub is_on_map {
4337: my ($pathname,$filename) = &split_uri_for_cond(shift);
4338: #Trying to find the conditional for the file
4339: my $match=($env{'acc.res.'.$env{'request.course.id'}.'.'.$pathname}=~
4340: /\&\Q$filename\E\:([\d\|]+)\&/);
4341: if ($match) {
4342: return (1,$1);
4343: } else {
4344: return (0,0);
4345: }
4346: }
4347:
4348: # --------------------------------------------------------- Get symb from alias
4349:
4350: sub get_symb_from_alias {
4351: my $symb=shift;
4352: my ($map,$resid,$url)=&decode_symb($symb);
4353: # Already is a symb
4354: if ($url) { return $symb; }
4355: # Must be an alias
4356: my $aliassymb='';
4357: my %bighash;
4358: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
4359: &GDBM_READER(),0640)) {
4360: my $rid=$bighash{'mapalias_'.$symb};
4361: if ($rid) {
4362: my ($mapid,$resid)=split(/\./,$rid);
4363: $aliassymb=&encode_symb($bighash{'map_id_'.$mapid},
4364: $resid,$bighash{'src_'.$rid});
4365: }
4366: untie %bighash;
4367: }
4368: return $aliassymb;
4369: }
4370:
4371: # ----------------------------------------------------------------- Define Role
4372:
4373: sub definerole {
4374: if (allowed('mcr','/')) {
4375: my ($rolename,$sysrole,$domrole,$courole)=@_;
4376: foreach my $role (split(':',$sysrole)) {
4377: my ($crole,$cqual)=split(/\&/,$role);
4378: if ($pr{'cr:s'}!~/\Q$crole\E/) { return "refused:s:$crole"; }
4379: if ($pr{'cr:s'}=~/\Q$crole\E\&/) {
4380: if ($pr{'cr:s'}!~/\Q$crole\E\&\w*\Q$cqual\E/) {
4381: return "refused:s:$crole&$cqual";
4382: }
4383: }
4384: }
4385: foreach my $role (split(':',$domrole)) {
4386: my ($crole,$cqual)=split(/\&/,$role);
4387: if ($pr{'cr:d'}!~/\Q$crole\E/) { return "refused:d:$crole"; }
4388: if ($pr{'cr:d'}=~/\Q$crole\E\&/) {
4389: if ($pr{'cr:d'}!~/\Q$crole\W\&\w*\Q$cqual\E/) {
4390: return "refused:d:$crole&$cqual";
4391: }
4392: }
4393: }
4394: foreach my $role (split(':',$courole)) {
4395: my ($crole,$cqual)=split(/\&/,$role);
4396: if ($pr{'cr:c'}!~/\Q$crole\E/) { return "refused:c:$crole"; }
4397: if ($pr{'cr:c'}=~/\Q$crole\E\&/) {
4398: if ($pr{'cr:c'}!~/\Q$crole\E\&\w*\Q$cqual\E/) {
4399: return "refused:c:$crole&$cqual";
4400: }
4401: }
4402: }
4403: my $command="encrypt:rolesput:$env{'user.domain'}:$env{'user.name'}:".
4404: "$env{'user.domain'}:$env{'user.name'}:".
4405: "rolesdef_$rolename=".
4406: escape($sysrole.'_'.$domrole.'_'.$courole);
4407: return reply($command,$env{'user.home'});
4408: } else {
4409: return 'refused';
4410: }
4411: }
4412:
4413: # ---------------- Make a metadata query against the network of library servers
4414:
4415: sub metadata_query {
4416: my ($query,$custom,$customshow,$server_array)=@_;
4417: my %rhash;
4418: my %libserv = &all_library();
4419: my @server_list = (defined($server_array) ? @$server_array
4420: : keys(%libserv) );
4421: for my $server (@server_list) {
4422: unless ($custom or $customshow) {
4423: my $reply=&reply("querysend:".&escape($query),$server);
4424: $rhash{$server}=$reply;
4425: }
4426: else {
4427: my $reply=&reply("querysend:".&escape($query).':'.
4428: &escape($custom).':'.&escape($customshow),
4429: $server);
4430: $rhash{$server}=$reply;
4431: }
4432: }
4433: return \%rhash;
4434: }
4435:
4436: # ----------------------------------------- Send log queries and wait for reply
4437:
4438: sub log_query {
4439: my ($uname,$udom,$query,%filters)=@_;
4440: my $uhome=&homeserver($uname,$udom);
4441: if ($uhome eq 'no_host') { return 'error: no_host'; }
4442: my $uhost=&hostname($uhome);
4443: my $command=&escape(join(':',map{$_.'='.$filters{$_}} keys(%filters)));
4444: my $queryid=&reply("querysend:".$query.':'.$udom.':'.$uname.':'.$command,
4445: $uhome);
4446: unless ($queryid=~/^\Q$uhost\E\_/) { return 'error: '.$queryid; }
4447: return get_query_reply($queryid);
4448: }
4449:
4450: # -------------------------- Update MySQL table for portfolio file
4451:
4452: sub update_portfolio_table {
4453: my ($uname,$udom,$file_name,$query,$group,$action) = @_;
4454: my $homeserver = &homeserver($uname,$udom);
4455: my $queryid=
4456: &reply("querysend:".$query.':'.&escape($uname.':'.$udom.':'.$group).
4457: ':'.&escape($file_name).':'.$action,$homeserver);
4458: my $reply = &get_query_reply($queryid);
4459: return $reply;
4460: }
4461:
4462: # -------------------------- Update MySQL allusers table
4463:
4464: sub update_allusers_table {
4465: my ($uname,$udom,$names) = @_;
4466: my $homeserver = &homeserver($uname,$udom);
4467: my $queryid=
4468: &reply('querysend:allusers:'.&escape($uname).':'.&escape($udom).':'.
4469: 'lastname='.&escape($names->{'lastname'}).'%%'.
4470: 'firstname='.&escape($names->{'firstname'}).'%%'.
4471: 'middlename='.&escape($names->{'middlename'}).'%%'.
4472: 'generation='.&escape($names->{'generation'}).'%%'.
4473: 'permanentemail='.&escape($names->{'permanentemail'}).'%%'.
4474: 'id='.&escape($names->{'id'}),$homeserver);
4475: my $reply = &get_query_reply($queryid);
4476: return $reply;
4477: }
4478:
4479: # ------- Request retrieval of institutional classlists for course(s)
4480:
4481: sub fetch_enrollment_query {
4482: my ($context,$affiliatesref,$replyref,$dom,$cnum) = @_;
4483: my $homeserver;
4484: my $maxtries = 1;
4485: if ($context eq 'automated') {
4486: $homeserver = $perlvar{'lonHostID'};
4487: $maxtries = 10; # will wait for up to 2000s for retrieval of classlist data before timeout
4488: } else {
4489: $homeserver = &homeserver($cnum,$dom);
4490: }
4491: my $host=&hostname($homeserver);
4492: my $cmd = '';
4493: foreach my $affiliate (keys %{$affiliatesref}) {
4494: $cmd .= $affiliate.'='.join(",",@{$$affiliatesref{$affiliate}}).'%%';
4495: }
4496: $cmd =~ s/%%$//;
4497: $cmd = &escape($cmd);
4498: my $query = 'fetchenrollment';
4499: my $queryid=&reply("querysend:".$query.':'.$dom.':'.$env{'user.name'}.':'.$cmd,$homeserver);
4500: unless ($queryid=~/^\Q$host\E\_/) {
4501: &logthis('fetch_enrollment_query: invalid queryid: '.$queryid.' for host: '.$host.' and homeserver: '.$homeserver.' context: '.$context.' '.$cnum);
4502: return 'error: '.$queryid;
4503: }
4504: my $reply = &get_query_reply($queryid);
4505: my $tries = 1;
4506: while (($reply=~/^timeout/) && ($tries < $maxtries)) {
4507: $reply = &get_query_reply($queryid);
4508: $tries ++;
4509: }
4510: if ( ($reply =~/^timeout/) || ($reply =~/^error/) ) {
4511: &logthis('fetch_enrollment_query error: '.$reply.' for '.$dom.' '.$env{'user.name'}.' for '.$queryid.' context: '.$context.' '.$cnum.' maxtries: '.$maxtries.' tries: '.$tries);
4512: } else {
4513: my @responses = split(/:/,$reply);
4514: if ($homeserver eq $perlvar{'lonHostID'}) {
4515: foreach my $line (@responses) {
4516: my ($key,$value) = split(/=/,$line,2);
4517: $$replyref{$key} = $value;
4518: }
4519: } else {
4520: my $pathname = $perlvar{'lonDaemons'}.'/tmp';
4521: foreach my $line (@responses) {
4522: my ($key,$value) = split(/=/,$line);
4523: $$replyref{$key} = $value;
4524: if ($value > 0) {
4525: foreach my $item (@{$$affiliatesref{$key}}) {
4526: my $filename = $dom.'_'.$key.'_'.$item.'_classlist.xml';
4527: my $destname = $pathname.'/'.$filename;
4528: my $xml_classlist = &reply("autoretrieve:".$filename,$homeserver);
4529: if ($xml_classlist =~ /^error/) {
4530: &logthis('fetch_enrollment_query - autoretrieve error: '.$xml_classlist.' for '.$filename.' from server: '.$homeserver.' '.$context.' '.$cnum);
4531: } else {
4532: if ( open(FILE,">$destname") ) {
4533: print FILE &unescape($xml_classlist);
4534: close(FILE);
4535: } else {
4536: &logthis('fetch_enrollment_query - error opening classlist file '.$destname.' '.$context.' '.$cnum);
4537: }
4538: }
4539: }
4540: }
4541: }
4542: }
4543: return 'ok';
4544: }
4545: return 'error';
4546: }
4547:
4548: sub get_query_reply {
4549: my $queryid=shift;
4550: my $replyfile=$perlvar{'lonDaemons'}.'/tmp/'.$queryid;
4551: my $reply='';
4552: for (1..100) {
4553: sleep 2;
4554: if (-e $replyfile.'.end') {
4555: if (open(my $fh,$replyfile)) {
4556: $reply = join('',<$fh>);
4557: close($fh);
4558: } else { return 'error: reply_file_error'; }
4559: return &unescape($reply);
4560: }
4561: }
4562: return 'timeout:'.$queryid;
4563: }
4564:
4565: sub courselog_query {
4566: #
4567: # possible filters:
4568: # url: url or symb
4569: # username
4570: # domain
4571: # action: view, submit, grade
4572: # start: timestamp
4573: # end: timestamp
4574: #
4575: my (%filters)=@_;
4576: unless ($env{'request.course.id'}) { return 'no_course'; }
4577: if ($filters{'url'}) {
4578: $filters{'url'}=&symbclean(&declutter($filters{'url'}));
4579: $filters{'url'}=~s/\.(\w+)$/(\\.\\d+)*\\.$1/;
4580: $filters{'url'}=~s/\.(\w+)\_\_\_/(\\.\\d+)*\\.$1/;
4581: }
4582: my $cname=$env{'course.'.$env{'request.course.id'}.'.num'};
4583: my $cdom=$env{'course.'.$env{'request.course.id'}.'.domain'};
4584: return &log_query($cname,$cdom,'courselog',%filters);
4585: }
4586:
4587: sub userlog_query {
4588: #
4589: # possible filters:
4590: # action: log check role
4591: # start: timestamp
4592: # end: timestamp
4593: #
4594: my ($uname,$udom,%filters)=@_;
4595: return &log_query($uname,$udom,'userlog',%filters);
4596: }
4597:
4598: #--------- Call auto-enrollment subs in localenroll.pm for homeserver for course
4599:
4600: sub auto_run {
4601: my ($cnum,$cdom) = @_;
4602: my $response = 0;
4603: my $settings;
4604: my %domconfig = &get_dom('configuration',['autoenroll'],$cdom);
4605: if (ref($domconfig{'autoenroll'}) eq 'HASH') {
4606: $settings = $domconfig{'autoenroll'};
4607: if ($settings->{'run'} eq '1') {
4608: $response = 1;
4609: }
4610: } else {
4611: my $homeserver = &homeserver($cnum,$cdom);
4612: $response = &reply('autorun:'.$cdom,$homeserver);
4613: }
4614: return $response;
4615: }
4616:
4617: sub auto_get_sections {
4618: my ($cnum,$cdom,$inst_coursecode) = @_;
4619: my $homeserver = &homeserver($cnum,$cdom);
4620: my @secs = ();
4621: my $response=&unescape(&reply('autogetsections:'.$inst_coursecode.':'.$cdom,$homeserver));
4622: unless ($response eq 'refused') {
4623: @secs = split(/:/,$response);
4624: }
4625: return @secs;
4626: }
4627:
4628: sub auto_new_course {
4629: my ($cnum,$cdom,$inst_course_id,$owner) = @_;
4630: my $homeserver = &homeserver($cnum,$cdom);
4631: my $response=&unescape(&reply('autonewcourse:'.$inst_course_id.':'.$owner.':'.$cdom,$homeserver));
4632: return $response;
4633: }
4634:
4635: sub auto_validate_courseID {
4636: my ($cnum,$cdom,$inst_course_id) = @_;
4637: my $homeserver = &homeserver($cnum,$cdom);
4638: my $response=&unescape(&reply('autovalidatecourse:'.$inst_course_id.':'.$cdom,$homeserver));
4639: return $response;
4640: }
4641:
4642: sub auto_create_password {
4643: my ($cnum,$cdom,$authparam,$udom) = @_;
4644: my ($homeserver,$response);
4645: my $create_passwd = 0;
4646: my $authchk = '';
4647: if ($udom =~ /^$match_domain$/) {
4648: $homeserver = &domain($udom,'primary');
4649: }
4650: if ($homeserver eq '') {
4651: if (($cdom =~ /^$match_domain$/) && ($cnum =~ /^$match_courseid$/)) {
4652: $homeserver = &homeserver($cnum,$cdom);
4653: }
4654: }
4655: if ($homeserver eq '') {
4656: $authchk = 'nodomain';
4657: } else {
4658: $response=&unescape(&reply('autocreatepassword:'.$authparam.':'.$cdom,$homeserver));
4659: if ($response eq 'refused') {
4660: $authchk = 'refused';
4661: } else {
4662: ($authparam,$create_passwd,$authchk) = split(/:/,$response);
4663: }
4664: }
4665: return ($authparam,$create_passwd,$authchk);
4666: }
4667:
4668: sub auto_photo_permission {
4669: my ($cnum,$cdom,$students) = @_;
4670: my $homeserver = &homeserver($cnum,$cdom);
4671: my ($outcome,$perm_reqd,$conditions) =
4672: split(/:/,&unescape(&reply('autophotopermission:'.$cdom,$homeserver)),3);
4673: if ($outcome =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
4674: return (undef,undef);
4675: }
4676: return ($outcome,$perm_reqd,$conditions);
4677: }
4678:
4679: sub auto_checkphotos {
4680: my ($uname,$udom,$pid) = @_;
4681: my $homeserver = &homeserver($uname,$udom);
4682: my ($result,$resulttype);
4683: my $outcome = &unescape(&reply('autophotocheck:'.&escape($udom).':'.
4684: &escape($uname).':'.&escape($pid),
4685: $homeserver));
4686: if ($outcome =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
4687: return (undef,undef);
4688: }
4689: if ($outcome) {
4690: ($result,$resulttype) = split(/:/,$outcome);
4691: }
4692: return ($result,$resulttype);
4693: }
4694:
4695: sub auto_photochoice {
4696: my ($cnum,$cdom) = @_;
4697: my $homeserver = &homeserver($cnum,$cdom);
4698: my ($update,$comment) = split(/:/,&unescape(&reply('autophotochoice:'.
4699: &escape($cdom),
4700: $homeserver)));
4701: if ($update =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
4702: return (undef,undef);
4703: }
4704: return ($update,$comment);
4705: }
4706:
4707: sub auto_photoupdate {
4708: my ($affiliatesref,$dom,$cnum,$photo) = @_;
4709: my $homeserver = &homeserver($cnum,$dom);
4710: my $host=&hostname($homeserver);
4711: my $cmd = '';
4712: my $maxtries = 1;
4713: foreach my $affiliate (keys(%{$affiliatesref})) {
4714: $cmd .= $affiliate.'='.join(",",@{$$affiliatesref{$affiliate}}).'%%';
4715: }
4716: $cmd =~ s/%%$//;
4717: $cmd = &escape($cmd);
4718: my $query = 'institutionalphotos';
4719: my $queryid=&reply("querysend:".$query.':'.$dom.':'.$cnum.':'.$cmd,$homeserver);
4720: unless ($queryid=~/^\Q$host\E\_/) {
4721: &logthis('institutionalphotos: invalid queryid: '.$queryid.' for host: '.$host.' and homeserver: '.$homeserver.' and course: '.$cnum);
4722: return 'error: '.$queryid;
4723: }
4724: my $reply = &get_query_reply($queryid);
4725: my $tries = 1;
4726: while (($reply=~/^timeout/) && ($tries < $maxtries)) {
4727: $reply = &get_query_reply($queryid);
4728: $tries ++;
4729: }
4730: if ( ($reply =~/^timeout/) || ($reply =~/^error/) ) {
4731: &logthis('institutionalphotos error: '.$reply.' for '.$dom.' '.$env{'user.name'}.' for '.$queryid.' course: '.$cnum.' maxtries: '.$maxtries.' tries: '.$tries);
4732: } else {
4733: my @responses = split(/:/,$reply);
4734: my $outcome = shift(@responses);
4735: foreach my $item (@responses) {
4736: my ($key,$value) = split(/=/,$item);
4737: $$photo{$key} = $value;
4738: }
4739: return $outcome;
4740: }
4741: return 'error';
4742: }
4743:
4744: sub auto_instcode_format {
4745: my ($caller,$codedom,$instcodes,$codes,$codetitles,$cat_titles,
4746: $cat_order) = @_;
4747: my $courses = '';
4748: my @homeservers;
4749: if ($caller eq 'global') {
4750: my %servers = &get_servers($codedom,'library');
4751: foreach my $tryserver (keys(%servers)) {
4752: if (!grep(/^\Q$tryserver\E$/,@homeservers)) {
4753: push(@homeservers,$tryserver);
4754: }
4755: }
4756: } else {
4757: push(@homeservers,&homeserver($caller,$codedom));
4758: }
4759: foreach my $code (keys(%{$instcodes})) {
4760: $courses .= &escape($code).'='.&escape($$instcodes{$code}).'&';
4761: }
4762: chop($courses);
4763: my $ok_response = 0;
4764: my $response;
4765: while (@homeservers > 0 && $ok_response == 0) {
4766: my $server = shift(@homeservers);
4767: $response=&reply('autoinstcodeformat:'.$codedom.':'.$courses,$server);
4768: if ($response !~ /(con_lost|error|no_such_host|refused)/) {
4769: my ($codes_str,$codetitles_str,$cat_titles_str,$cat_order_str) =
4770: split(/:/,$response);
4771: %{$codes} = (%{$codes},&str2hash($codes_str));
4772: push(@{$codetitles},&str2array($codetitles_str));
4773: %{$cat_titles} = (%{$cat_titles},&str2hash($cat_titles_str));
4774: %{$cat_order} = (%{$cat_order},&str2hash($cat_order_str));
4775: $ok_response = 1;
4776: }
4777: }
4778: if ($ok_response) {
4779: return 'ok';
4780: } else {
4781: return $response;
4782: }
4783: }
4784:
4785: sub auto_instcode_defaults {
4786: my ($domain,$returnhash,$code_order) = @_;
4787: my @homeservers;
4788:
4789: my %servers = &get_servers($domain,'library');
4790: foreach my $tryserver (keys(%servers)) {
4791: if (!grep(/^\Q$tryserver\E$/,@homeservers)) {
4792: push(@homeservers,$tryserver);
4793: }
4794: }
4795:
4796: my $response;
4797: foreach my $server (@homeservers) {
4798: $response=&reply('autoinstcodedefaults:'.$domain,$server);
4799: next if ($response =~ /(con_lost|error|no_such_host|refused)/);
4800:
4801: foreach my $pair (split(/\&/,$response)) {
4802: my ($name,$value)=split(/\=/,$pair);
4803: if ($name eq 'code_order') {
4804: @{$code_order} = split(/\&/,&unescape($value));
4805: } else {
4806: $returnhash->{&unescape($name)}=&unescape($value);
4807: }
4808: }
4809: return 'ok';
4810: }
4811:
4812: return $response;
4813: }
4814:
4815: sub auto_validate_class_sec {
4816: my ($cdom,$cnum,$owner,$inst_class) = @_;
4817: my $homeserver = &homeserver($cnum,$cdom);
4818: my $response=&reply('autovalidateclass_sec:'.$inst_class.':'.
4819: &escape($owner).':'.$cdom,$homeserver);
4820: return $response;
4821: }
4822:
4823: # ------------------------------------------------------- Course Group routines
4824:
4825: sub get_coursegroups {
4826: my ($cdom,$cnum,$group,$namespace) = @_;
4827: return(&dump($namespace,$cdom,$cnum,$group));
4828: }
4829:
4830: sub modify_coursegroup {
4831: my ($cdom,$cnum,$groupsettings) = @_;
4832: return(&put('coursegroups',$groupsettings,$cdom,$cnum));
4833: }
4834:
4835: sub toggle_coursegroup_status {
4836: my ($cdom,$cnum,$group,$action) = @_;
4837: my ($from_namespace,$to_namespace);
4838: if ($action eq 'delete') {
4839: $from_namespace = 'coursegroups';
4840: $to_namespace = 'deleted_groups';
4841: } else {
4842: $from_namespace = 'deleted_groups';
4843: $to_namespace = 'coursegroups';
4844: }
4845: my %curr_group = &get_coursegroups($cdom,$cnum,$group,$from_namespace);
4846: if (my $tmp = &error(%curr_group)) {
4847: &Apache::lonnet::logthis('Error retrieving group: '.$tmp.' in '.$cnum.':'.$cdom);
4848: return ('read error',$tmp);
4849: } else {
4850: my %savedsettings = %curr_group;
4851: my $result = &put($to_namespace,\%savedsettings,$cdom,$cnum);
4852: my $deloutcome;
4853: if ($result eq 'ok') {
4854: $deloutcome = &del($from_namespace,[$group],$cdom,$cnum);
4855: } else {
4856: return ('write error',$result);
4857: }
4858: if ($deloutcome eq 'ok') {
4859: return 'ok';
4860: } else {
4861: return ('delete error',$deloutcome);
4862: }
4863: }
4864: }
4865:
4866: sub modify_group_roles {
4867: my ($cdom,$cnum,$group_id,$user,$end,$start,$userprivs) = @_;
4868: my $url = '/'.$cdom.'/'.$cnum.'/'.$group_id;
4869: my $role = 'gr/'.&escape($userprivs);
4870: my ($uname,$udom) = split(/:/,$user);
4871: my $result = &assignrole($udom,$uname,$url,$role,$end,$start);
4872: if ($result eq 'ok') {
4873: &devalidate_getgroups_cache($udom,$uname,$cdom,$cnum);
4874: }
4875: return $result;
4876: }
4877:
4878: sub modify_coursegroup_membership {
4879: my ($cdom,$cnum,$membership) = @_;
4880: my $result = &put('groupmembership',$membership,$cdom,$cnum);
4881: return $result;
4882: }
4883:
4884: sub get_active_groups {
4885: my ($udom,$uname,$cdom,$cnum) = @_;
4886: my $now = time;
4887: my %groups = ();
4888: foreach my $key (keys(%env)) {
4889: if ($key =~ m-user\.role\.gr\./($match_domain)/($match_courseid)/(\w+)$-) {
4890: my ($start,$end) = split(/\./,$env{$key});
4891: if (($end!=0) && ($end<$now)) { next; }
4892: if (($start!=0) && ($start>$now)) { next; }
4893: if ($1 eq $cdom && $2 eq $cnum) {
4894: $groups{$3} = $env{$key} ;
4895: }
4896: }
4897: }
4898: return %groups;
4899: }
4900:
4901: sub get_group_membership {
4902: my ($cdom,$cnum,$group) = @_;
4903: return(&dump('groupmembership',$cdom,$cnum,$group));
4904: }
4905:
4906: sub get_users_groups {
4907: my ($udom,$uname,$courseid) = @_;
4908: my @usersgroups;
4909: my $cachetime=1800;
4910:
4911: my $hashid="$udom:$uname:$courseid";
4912: my ($grouplist,$cached)=&is_cached_new('getgroups',$hashid);
4913: if (defined($cached)) {
4914: @usersgroups = split(/:/,$grouplist);
4915: } else {
4916: $grouplist = '';
4917: my $courseurl = &courseid_to_courseurl($courseid);
4918: my %roleshash = &dump('roles',$udom,$uname,$courseurl);
4919: my $access_end = $env{'course.'.$courseid.
4920: '.default_enrollment_end_date'};
4921: my $now = time;
4922: foreach my $key (keys(%roleshash)) {
4923: if ($key =~ /^\Q$courseurl\E\/(\w+)\_gr$/) {
4924: my $group = $1;
4925: if ($roleshash{$key} =~ /_(\d+)_(\d+)$/) {
4926: my $start = $2;
4927: my $end = $1;
4928: if ($start == -1) { next; } # deleted from group
4929: if (($start!=0) && ($start>$now)) { next; }
4930: if (($end!=0) && ($end<$now)) {
4931: if ($access_end && $access_end < $now) {
4932: if ($access_end - $end < 86400) {
4933: push(@usersgroups,$group);
4934: }
4935: }
4936: next;
4937: }
4938: push(@usersgroups,$group);
4939: }
4940: }
4941: }
4942: @usersgroups = &sort_course_groups($courseid,@usersgroups);
4943: $grouplist = join(':',@usersgroups);
4944: &do_cache_new('getgroups',$hashid,$grouplist,$cachetime);
4945: }
4946: return @usersgroups;
4947: }
4948:
4949: sub devalidate_getgroups_cache {
4950: my ($udom,$uname,$cdom,$cnum)=@_;
4951: my $courseid = $cdom.'_'.$cnum;
4952:
4953: my $hashid="$udom:$uname:$courseid";
4954: &devalidate_cache_new('getgroups',$hashid);
4955: }
4956:
4957: # ------------------------------------------------------------------ Plain Text
4958:
4959: sub plaintext {
4960: my ($short,$type,$cid) = @_;
4961: if ($short =~ /^cr/) {
4962: return (split('/',$short))[-1];
4963: }
4964: if (!defined($cid)) {
4965: $cid = $env{'request.course.id'};
4966: }
4967: if (defined($cid) && defined($env{'course.'.$cid.'.'.$short.'.plaintext'})) {
4968: return &Apache::lonlocal::mt($env{'course.'.$cid.'.'.$short.
4969: '.plaintext'});
4970: }
4971: my %rolenames = (
4972: Course => 'std',
4973: Group => 'alt1',
4974: );
4975: if (defined($type) &&
4976: defined($rolenames{$type}) &&
4977: defined($prp{$short}{$rolenames{$type}})) {
4978: return &Apache::lonlocal::mt($prp{$short}{$rolenames{$type}});
4979: } else {
4980: return &Apache::lonlocal::mt($prp{$short}{'std'});
4981: }
4982: }
4983:
4984: # ----------------------------------------------------------------- Assign Role
4985:
4986: sub assignrole {
4987: my ($udom,$uname,$url,$role,$end,$start,$deleteflag)=@_;
4988: my $mrole;
4989: if ($role =~ /^cr\//) {
4990: my $cwosec=$url;
4991: $cwosec=~s/^\/($match_domain)\/($match_courseid)\/.*/$1\/$2/;
4992: unless (&allowed('ccr',$cwosec)) {
4993: &logthis('Refused custom assignrole: '.
4994: $udom.' '.$uname.' '.$url.' '.$role.' '.$end.' '.$start.' by '.
4995: $env{'user.name'}.' at '.$env{'user.domain'});
4996: return 'refused';
4997: }
4998: $mrole='cr';
4999: } elsif ($role =~ /^gr\//) {
5000: my $cwogrp=$url;
5001: $cwogrp=~s{^/($match_domain)/($match_courseid)/.*}{$1/$2};
5002: unless (&allowed('mdg',$cwogrp)) {
5003: &logthis('Refused group assignrole: '.
5004: $udom.' '.$uname.' '.$url.' '.$role.' '.$end.' '.$start.' by '.
5005: $env{'user.name'}.' at '.$env{'user.domain'});
5006: return 'refused';
5007: }
5008: $mrole='gr';
5009: } else {
5010: my $cwosec=$url;
5011: $cwosec=~s/^\/($match_domain)\/($match_courseid)\/.*/$1\/$2/;
5012: unless ((&allowed('c'.$role,$cwosec)) || &allowed('c'.$role,$udom)) {
5013: &logthis('Refused assignrole: '.
5014: $udom.' '.$uname.' '.$url.' '.$role.' '.$end.' '.$start.' by '.
5015: $env{'user.name'}.' at '.$env{'user.domain'});
5016: return 'refused';
5017: }
5018: $mrole=$role;
5019: }
5020: my $command="encrypt:rolesput:$env{'user.domain'}:$env{'user.name'}:".
5021: "$udom:$uname:$url".'_'."$mrole=$role";
5022: if ($end) { $command.='_'.$end; }
5023: if ($start) {
5024: if ($end) {
5025: $command.='_'.$start;
5026: } else {
5027: $command.='_0_'.$start;
5028: }
5029: }
5030: my $origstart = $start;
5031: my $origend = $end;
5032: # actually delete
5033: if ($deleteflag) {
5034: if ((&allowed('dro',$udom)) || (&allowed('dro',$url))) {
5035: # modify command to delete the role
5036: $command="encrypt:rolesdel:$env{'user.domain'}:$env{'user.name'}:".
5037: "$udom:$uname:$url".'_'."$mrole";
5038: &logthis("$env{'user.name'} at $env{'user.domain'} deletes $mrole in $url for $uname at $udom");
5039: # set start and finish to negative values for userrolelog
5040: $start=-1;
5041: $end=-1;
5042: }
5043: }
5044: # send command
5045: my $answer=&reply($command,&homeserver($uname,$udom));
5046: # log new user role if status is ok
5047: if ($answer eq 'ok') {
5048: &userrolelog($role,$uname,$udom,$url,$start,$end);
5049: # for course roles, perform group memberships changes triggered by role change.
5050: unless ($role =~ /^gr/) {
5051: &Apache::longroup::group_changes($udom,$uname,$url,$role,$origend,
5052: $origstart);
5053: }
5054: }
5055: return $answer;
5056: }
5057:
5058: # -------------------------------------------------- Modify user authentication
5059: # Overrides without validation
5060:
5061: sub modifyuserauth {
5062: my ($udom,$uname,$umode,$upass)=@_;
5063: my $uhome=&homeserver($uname,$udom);
5064: unless (&allowed('mau',$udom)) { return 'refused'; }
5065: &logthis('Call to modify user authentication '.$udom.', '.$uname.', '.
5066: $umode.' by '.$env{'user.name'}.' at '.$env{'user.domain'}.
5067: ' in domain '.$env{'request.role.domain'});
5068: my $reply=&reply('encrypt:changeuserauth:'.$udom.':'.$uname.':'.$umode.':'.
5069: &escape($upass),$uhome);
5070: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},
5071: 'Authentication changed for '.$udom.', '.$uname.', '.$umode.
5072: '(Remote '.$ENV{'REMOTE_ADDR'}.'): '.$reply);
5073: &log($udom,,$uname,$uhome,
5074: 'Authentication changed by '.$env{'user.domain'}.', '.
5075: $env{'user.name'}.', '.$umode.
5076: '(Remote '.$ENV{'REMOTE_ADDR'}.'): '.$reply);
5077: unless ($reply eq 'ok') {
5078: &logthis('Authentication mode error: '.$reply);
5079: return 'error: '.$reply;
5080: }
5081: return 'ok';
5082: }
5083:
5084: # --------------------------------------------------------------- Modify a user
5085:
5086: sub modifyuser {
5087: my ($udom, $uname, $uid,
5088: $umode, $upass, $first,
5089: $middle, $last, $gene,
5090: $forceid, $desiredhome, $email)=@_;
5091: $udom= &LONCAPA::clean_domain($udom);
5092: $uname=&LONCAPA::clean_username($uname);
5093: &logthis('Call to modify user '.$udom.', '.$uname.', '.$uid.', '.
5094: $umode.', '.$first.', '.$middle.', '.
5095: $last.', '.$gene.'(forceid: '.$forceid.')'.
5096: (defined($desiredhome) ? ' desiredhome = '.$desiredhome :
5097: ' desiredhome not specified').
5098: ' by '.$env{'user.name'}.' at '.$env{'user.domain'}.
5099: ' in domain '.$env{'request.role.domain'});
5100: my $uhome=&homeserver($uname,$udom,'true');
5101: # ----------------------------------------------------------------- Create User
5102: if (($uhome eq 'no_host') &&
5103: (($umode && $upass) || ($umode eq 'localauth'))) {
5104: my $unhome='';
5105: if (defined($desiredhome) && &host_domain($desiredhome) eq $udom) {
5106: $unhome = $desiredhome;
5107: } elsif($env{'course.'.$env{'request.course.id'}.'.domain'} eq $udom) {
5108: $unhome=$env{'course.'.$env{'request.course.id'}.'.home'};
5109: } else { # load balancing routine for determining $unhome
5110: my $loadm=10000000;
5111: my %servers = &get_servers($udom,'library');
5112: foreach my $tryserver (keys(%servers)) {
5113: my $answer=reply('load',$tryserver);
5114: if (($answer=~/\d+/) && ($answer<$loadm)) {
5115: $loadm=$answer;
5116: $unhome=$tryserver;
5117: }
5118: }
5119: }
5120: if (($unhome eq '') || ($unhome eq 'no_host')) {
5121: return 'error: unable to find a home server for '.$uname.
5122: ' in domain '.$udom;
5123: }
5124: my $reply=&reply('encrypt:makeuser:'.$udom.':'.$uname.':'.$umode.':'.
5125: &escape($upass),$unhome);
5126: unless ($reply eq 'ok') {
5127: return 'error: '.$reply;
5128: }
5129: $uhome=&homeserver($uname,$udom,'true');
5130: if (($uhome eq '') || ($uhome eq 'no_host') || ($uhome ne $unhome)) {
5131: return 'error: unable verify users home machine.';
5132: }
5133: } # End of creation of new user
5134: # ---------------------------------------------------------------------- Add ID
5135: if ($uid) {
5136: $uid=~tr/A-Z/a-z/;
5137: my %uidhash=&idrget($udom,$uname);
5138: if (($uidhash{$uname}) && ($uidhash{$uname}!~/error\:/)
5139: && (!$forceid)) {
5140: unless ($uid eq $uidhash{$uname}) {
5141: return 'error: user id "'.$uid.'" does not match '.
5142: 'current user id "'.$uidhash{$uname}.'".';
5143: }
5144: } else {
5145: &idput($udom,($uname => $uid));
5146: }
5147: }
5148: # -------------------------------------------------------------- Add names, etc
5149: my @tmp=&get('environment',
5150: ['firstname','middlename','lastname','generation','id',
5151: 'permanentemail'],
5152: $udom,$uname);
5153: my %names;
5154: if ($tmp[0] =~ m/^error:.*/) {
5155: %names=();
5156: } else {
5157: %names = @tmp;
5158: }
5159: #
5160: # Make sure to not trash student environment if instructor does not bother
5161: # to supply name and email information
5162: #
5163: if ($first) { $names{'firstname'} = $first; }
5164: if (defined($middle)) { $names{'middlename'} = $middle; }
5165: if ($last) { $names{'lastname'} = $last; }
5166: if (defined($gene)) { $names{'generation'} = $gene; }
5167: if ($email) {
5168: $email=~s/[^\w\@\.\-\,]//gs;
5169: if ($email=~/\@/) { $names{'notification'} = $email;
5170: $names{'critnotification'} = $email;
5171: $names{'permanentemail'} = $email; }
5172: }
5173: if ($uid) { $names{'id'} = $uid; }
5174: my $reply = &put('environment', \%names, $udom,$uname);
5175: if ($reply ne 'ok') { return 'error: '.$reply; }
5176: my $sqlresult = &update_allusers_table($uname,$udom,\%names);
5177: &devalidate_cache_new('namescache',$uname.':'.$udom);
5178: &logthis('Success modifying user '.$udom.', '.$uname.', '.$uid.', '.
5179: $umode.', '.$first.', '.$middle.', '.
5180: $last.', '.$gene.' by '.
5181: $env{'user.name'}.' at '.$env{'user.domain'});
5182: return 'ok';
5183: }
5184:
5185: # -------------------------------------------------------------- Modify student
5186:
5187: sub modifystudent {
5188: my ($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene,$usec,
5189: $end,$start,$forceid,$desiredhome,$email,$type,$locktype,$cid)=@_;
5190: if (!$cid) {
5191: unless ($cid=$env{'request.course.id'}) {
5192: return 'not_in_class';
5193: }
5194: }
5195: # --------------------------------------------------------------- Make the user
5196: my $reply=&modifyuser
5197: ($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene,$forceid,
5198: $desiredhome,$email);
5199: unless ($reply eq 'ok') { return $reply; }
5200: # This will cause &modify_student_enrollment to get the uid from the
5201: # students environment
5202: $uid = undef if (!$forceid);
5203: $reply = &modify_student_enrollment($udom,$uname,$uid,$first,$middle,$last,
5204: $gene,$usec,$end,$start,$type,$locktype,$cid);
5205: return $reply;
5206: }
5207:
5208: sub modify_student_enrollment {
5209: my ($udom,$uname,$uid,$first,$middle,$last,$gene,$usec,$end,$start,$type,$locktype,$cid) = @_;
5210: my ($cdom,$cnum,$chome);
5211: if (!$cid) {
5212: unless ($cid=$env{'request.course.id'}) {
5213: return 'not_in_class';
5214: }
5215: $cdom=$env{'course.'.$cid.'.domain'};
5216: $cnum=$env{'course.'.$cid.'.num'};
5217: } else {
5218: ($cdom,$cnum)=split(/_/,$cid);
5219: }
5220: $chome=$env{'course.'.$cid.'.home'};
5221: if (!$chome) {
5222: $chome=&homeserver($cnum,$cdom);
5223: }
5224: if (!$chome) { return 'unknown_course'; }
5225: # Make sure the user exists
5226: my $uhome=&homeserver($uname,$udom);
5227: if (($uhome eq '') || ($uhome eq 'no_host')) {
5228: return 'error: no such user';
5229: }
5230: # Get student data if we were not given enough information
5231: if (!defined($first) || $first eq '' ||
5232: !defined($last) || $last eq '' ||
5233: !defined($uid) || $uid eq '' ||
5234: !defined($middle) || $middle eq '' ||
5235: !defined($gene) || $gene eq '') {
5236: # They did not supply us with enough data to enroll the student, so
5237: # we need to pick up more information.
5238: my %tmp = &get('environment',
5239: ['firstname','middlename','lastname', 'generation','id']
5240: ,$udom,$uname);
5241:
5242: #foreach my $key (keys(%tmp)) {
5243: # &logthis("key $key = ".$tmp{$key});
5244: #}
5245: $first = $tmp{'firstname'} if (!defined($first) || $first eq '');
5246: $middle = $tmp{'middlename'} if (!defined($middle) || $middle eq '');
5247: $last = $tmp{'lastname'} if (!defined($last) || $last eq '');
5248: $gene = $tmp{'generation'} if (!defined($gene) || $gene eq '');
5249: $uid = $tmp{'id'} if (!defined($uid) || $uid eq '');
5250: }
5251: my $fullname = &format_name($first,$middle,$last,$gene,'lastname');
5252: my $reply=cput('classlist',
5253: {"$uname:$udom" =>
5254: join(':',$end,$start,$uid,$usec,$fullname,$type,$locktype) },
5255: $cdom,$cnum);
5256: unless (($reply eq 'ok') || ($reply eq 'delayed')) {
5257: return 'error: '.$reply;
5258: } else {
5259: &devalidate_getsection_cache($udom,$uname,$cid);
5260: }
5261: # Add student role to user
5262: my $uurl='/'.$cid;
5263: $uurl=~s/\_/\//g;
5264: if ($usec) {
5265: $uurl.='/'.$usec;
5266: }
5267: return &assignrole($udom,$uname,$uurl,'st',$end,$start);
5268: }
5269:
5270: sub format_name {
5271: my ($firstname,$middlename,$lastname,$generation,$first)=@_;
5272: my $name;
5273: if ($first ne 'lastname') {
5274: $name=$firstname.' '.$middlename.' '.$lastname.' '.$generation;
5275: } else {
5276: if ($lastname=~/\S/) {
5277: $name.= $lastname.' '.$generation.', '.$firstname.' '.$middlename;
5278: $name=~s/\s+,/,/;
5279: } else {
5280: $name.= $firstname.' '.$middlename.' '.$generation;
5281: }
5282: }
5283: $name=~s/^\s+//;
5284: $name=~s/\s+$//;
5285: $name=~s/\s+/ /g;
5286: return $name;
5287: }
5288:
5289: # ------------------------------------------------- Write to course preferences
5290:
5291: sub writecoursepref {
5292: my ($courseid,%prefs)=@_;
5293: $courseid=~s/^\///;
5294: $courseid=~s/\_/\//g;
5295: my ($cdomain,$cnum)=split(/\//,$courseid);
5296: my $chome=homeserver($cnum,$cdomain);
5297: if (($chome eq '') || ($chome eq 'no_host')) {
5298: return 'error: no such course';
5299: }
5300: my $cstring='';
5301: foreach my $pref (keys(%prefs)) {
5302: $cstring.=&escape($pref).'='.&escape($prefs{$pref}).'&';
5303: }
5304: $cstring=~s/\&$//;
5305: return reply('put:'.$cdomain.':'.$cnum.':environment:'.$cstring,$chome);
5306: }
5307:
5308: # ---------------------------------------------------------- Make/modify course
5309:
5310: sub createcourse {
5311: my ($udom,$description,$url,$course_server,$nonstandard,$inst_code,
5312: $course_owner,$crstype)=@_;
5313: $url=&declutter($url);
5314: my $cid='';
5315: unless (&allowed('ccc',$udom)) {
5316: return 'refused';
5317: }
5318: # ------------------------------------------------------------------- Create ID
5319: my $uname=int(1+rand(9)).
5320: ('a'..'z','A'..'Z','0'..'9')[int(rand(62))].
5321: substr($$.time,0,5).unpack("H8",pack("I32",time)).
5322: unpack("H2",pack("I32",int(rand(255)))).$perlvar{'lonHostID'};
5323: # ----------------------------------------------- Make sure that does not exist
5324: my $uhome=&homeserver($uname,$udom,'true');
5325: unless (($uhome eq '') || ($uhome eq 'no_host')) {
5326: $uname=substr($$.time,0,5).unpack("H8",pack("I32",time)).
5327: unpack("H2",pack("I32",int(rand(255)))).$perlvar{'lonHostID'};
5328: $uhome=&homeserver($uname,$udom,'true');
5329: unless (($uhome eq '') || ($uhome eq 'no_host')) {
5330: return 'error: unable to generate unique course-ID';
5331: }
5332: }
5333: # ------------------------------------------------ Check supplied server name
5334: $course_server = $env{'user.homeserver'} if (! defined($course_server));
5335: if (! &is_library($course_server)) {
5336: return 'error:bad server name '.$course_server;
5337: }
5338: # ------------------------------------------------------------- Make the course
5339: my $reply=&reply('encrypt:makeuser:'.$udom.':'.$uname.':none::',
5340: $course_server);
5341: unless ($reply eq 'ok') { return 'error: '.$reply; }
5342: $uhome=&homeserver($uname,$udom,'true');
5343: if (($uhome eq '') || ($uhome eq 'no_host')) {
5344: return 'error: no such course';
5345: }
5346: # ----------------------------------------------------------------- Course made
5347: # log existence
5348: &courseidput($udom,&escape($udom.'_'.$uname).'='.&escape($description).
5349: ':'.&escape($inst_code).':'.&escape($course_owner).':'.
5350: &escape($crstype),$uhome);
5351: &flushcourselogs();
5352: # set toplevel url
5353: my $topurl=$url;
5354: unless ($nonstandard) {
5355: # ------------------------------------------ For standard courses, make top url
5356: my $mapurl=&clutter($url);
5357: if ($mapurl eq '/res/') { $mapurl=''; }
5358: $env{'form.initmap'}=(<<ENDINITMAP);
5359: <map>
5360: <resource id="1" type="start"></resource>
5361: <resource id="2" src="$mapurl"></resource>
5362: <resource id="3" type="finish"></resource>
5363: <link index="1" from="1" to="2"></link>
5364: <link index="2" from="2" to="3"></link>
5365: </map>
5366: ENDINITMAP
5367: $topurl=&declutter(
5368: &finishuserfileupload($uname,$udom,'initmap','default.sequence')
5369: );
5370: }
5371: # ----------------------------------------------------------- Write preferences
5372: &writecoursepref($udom.'_'.$uname,
5373: ('description' => $description,
5374: 'url' => $topurl));
5375: return '/'.$udom.'/'.$uname;
5376: }
5377:
5378: sub is_course {
5379: my ($cdom,$cnum) = @_;
5380: my %courses = &courseiddump($cdom,'.',1,'.','.',$cnum,undef,
5381: undef,'.');
5382: if (exists($courses{$cdom.'_'.$cnum})) {
5383: return 1;
5384: }
5385: return 0;
5386: }
5387:
5388: # ---------------------------------------------------------- Assign Custom Role
5389:
5390: sub assigncustomrole {
5391: my ($udom,$uname,$url,$rdom,$rnam,$rolename,$end,$start,$deleteflag)=@_;
5392: return &assignrole($udom,$uname,$url,'cr/'.$rdom.'/'.$rnam.'/'.$rolename,
5393: $end,$start,$deleteflag);
5394: }
5395:
5396: # ----------------------------------------------------------------- Revoke Role
5397:
5398: sub revokerole {
5399: my ($udom,$uname,$url,$role,$deleteflag)=@_;
5400: my $now=time;
5401: return &assignrole($udom,$uname,$url,$role,$now,$deleteflag);
5402: }
5403:
5404: # ---------------------------------------------------------- Revoke Custom Role
5405:
5406: sub revokecustomrole {
5407: my ($udom,$uname,$url,$rdom,$rnam,$rolename,$deleteflag)=@_;
5408: my $now=time;
5409: return &assigncustomrole($udom,$uname,$url,$rdom,$rnam,$rolename,$now,
5410: $deleteflag);
5411: }
5412:
5413: # ------------------------------------------------------------ Disk usage
5414: sub diskusage {
5415: my ($udom,$uname,$directoryRoot)=@_;
5416: $directoryRoot =~ s/\/$//;
5417: my $listing=&reply('du:'.$directoryRoot,homeserver($uname,$udom));
5418: return $listing;
5419: }
5420:
5421: sub is_locked {
5422: my ($file_name, $domain, $user) = @_;
5423: my @check;
5424: my $is_locked;
5425: push @check, $file_name;
5426: my %locked = &get('file_permissions',\@check,
5427: $env{'user.domain'},$env{'user.name'});
5428: my ($tmp)=keys(%locked);
5429: if ($tmp=~/^error:/) { undef(%locked); }
5430:
5431: if (ref($locked{$file_name}) eq 'ARRAY') {
5432: $is_locked = 'false';
5433: foreach my $entry (@{$locked{$file_name}}) {
5434: if (ref($entry) eq 'ARRAY') {
5435: $is_locked = 'true';
5436: last;
5437: }
5438: }
5439: } else {
5440: $is_locked = 'false';
5441: }
5442: }
5443:
5444: sub declutter_portfile {
5445: my ($file) = @_;
5446: $file =~ s{^(/portfolio/|portfolio/)}{/};
5447: return $file;
5448: }
5449:
5450: # ------------------------------------------------------------- Mark as Read Only
5451:
5452: sub mark_as_readonly {
5453: my ($domain,$user,$files,$what) = @_;
5454: my %current_permissions = &dump('file_permissions',$domain,$user);
5455: my ($tmp)=keys(%current_permissions);
5456: if ($tmp=~/^error:/) { undef(%current_permissions); }
5457: foreach my $file (@{$files}) {
5458: $file = &declutter_portfile($file);
5459: push(@{$current_permissions{$file}},$what);
5460: }
5461: &put('file_permissions',\%current_permissions,$domain,$user);
5462: return;
5463: }
5464:
5465: # ------------------------------------------------------------Save Selected Files
5466:
5467: sub save_selected_files {
5468: my ($user, $path, @files) = @_;
5469: my $filename = $user."savedfiles";
5470: my @other_files = &files_not_in_path($user, $path);
5471: open (OUT, '>'.$tmpdir.$filename);
5472: foreach my $file (@files) {
5473: print (OUT $env{'form.currentpath'}.$file."\n");
5474: }
5475: foreach my $file (@other_files) {
5476: print (OUT $file."\n");
5477: }
5478: close (OUT);
5479: return 'ok';
5480: }
5481:
5482: sub clear_selected_files {
5483: my ($user) = @_;
5484: my $filename = $user."savedfiles";
5485: open (OUT, '>'.$Apache::lonnet::perlvar{'lonDaemons'}.'/tmp/'.$filename);
5486: print (OUT undef);
5487: close (OUT);
5488: return ("ok");
5489: }
5490:
5491: sub files_in_path {
5492: my ($user, $path) = @_;
5493: my $filename = $user."savedfiles";
5494: my %return_files;
5495: open (IN, '<'.$Apache::lonnet::perlvar{'lonDaemons'}.'/tmp/'.$filename);
5496: while (my $line_in = <IN>) {
5497: chomp ($line_in);
5498: my @paths_and_file = split (m!/!, $line_in);
5499: my $file_part = pop (@paths_and_file);
5500: my $path_part = join ('/', @paths_and_file);
5501: $path_part.='/';
5502: my $path_and_file = $path_part.$file_part;
5503: if ($path_part eq $path) {
5504: $return_files{$file_part}= 'selected';
5505: }
5506: }
5507: close (IN);
5508: return (\%return_files);
5509: }
5510:
5511: # called in portfolio select mode, to show files selected NOT in current directory
5512: sub files_not_in_path {
5513: my ($user, $path) = @_;
5514: my $filename = $user."savedfiles";
5515: my @return_files;
5516: my $path_part;
5517: open(IN, '<'.$Apache::lonnet::perlvar{'lonDaemons'}.'/tmp/'.$filename);
5518: while (my $line = <IN>) {
5519: #ok, I know it's clunky, but I want it to work
5520: my @paths_and_file = split(m|/|, $line);
5521: my $file_part = pop(@paths_and_file);
5522: chomp($file_part);
5523: my $path_part = join('/', @paths_and_file);
5524: $path_part .= '/';
5525: my $path_and_file = $path_part.$file_part;
5526: if ($path_part ne $path) {
5527: push(@return_files, ($path_and_file));
5528: }
5529: }
5530: close(OUT);
5531: return (@return_files);
5532: }
5533:
5534: #----------------------------------------------Get portfolio file permissions
5535:
5536: sub get_portfile_permissions {
5537: my ($domain,$user) = @_;
5538: my %current_permissions = &dump('file_permissions',$domain,$user);
5539: my ($tmp)=keys(%current_permissions);
5540: if ($tmp=~/^error:/) { undef(%current_permissions); }
5541: return \%current_permissions;
5542: }
5543:
5544: #---------------------------------------------Get portfolio file access controls
5545:
5546: sub get_access_controls {
5547: my ($current_permissions,$group,$file) = @_;
5548: my %access;
5549: my $real_file = $file;
5550: $file =~ s/\.meta$//;
5551: if (defined($file)) {
5552: if (ref($$current_permissions{$file."\0".'accesscontrol'}) eq 'HASH') {
5553: foreach my $control (keys(%{$$current_permissions{$file."\0".'accesscontrol'}})) {
5554: $access{$real_file}{$control} = $$current_permissions{$file."\0".$control};
5555: }
5556: }
5557: } else {
5558: foreach my $key (keys(%{$current_permissions})) {
5559: if ($key =~ /\0accesscontrol$/) {
5560: if (defined($group)) {
5561: if ($key !~ m-^\Q$group\E/-) {
5562: next;
5563: }
5564: }
5565: my ($fullpath) = split(/\0/,$key);
5566: if (ref($$current_permissions{$key}) eq 'HASH') {
5567: foreach my $control (keys(%{$$current_permissions{$key}})) {
5568: $access{$fullpath}{$control}=$$current_permissions{$fullpath."\0".$control};
5569: }
5570: }
5571: }
5572: }
5573: }
5574: return %access;
5575: }
5576:
5577: sub modify_access_controls {
5578: my ($file_name,$changes,$domain,$user)=@_;
5579: my ($outcome,$deloutcome);
5580: my %store_permissions;
5581: my %new_values;
5582: my %new_control;
5583: my %translation;
5584: my @deletions = ();
5585: my $now = time;
5586: if (exists($$changes{'activate'})) {
5587: if (ref($$changes{'activate'}) eq 'HASH') {
5588: my @newitems = sort(keys(%{$$changes{'activate'}}));
5589: my $numnew = scalar(@newitems);
5590: for (my $i=0; $i<$numnew; $i++) {
5591: my $newkey = $newitems[$i];
5592: my $newid = &Apache::loncommon::get_cgi_id();
5593: if ($newkey =~ /^\d+:/) {
5594: $newkey =~ s/^(\d+)/$newid/;
5595: $translation{$1} = $newid;
5596: } elsif ($newkey =~ /^\d+_\d+_\d+:/) {
5597: $newkey =~ s/^(\d+_\d+_\d+)/$newid/;
5598: $translation{$1} = $newid;
5599: }
5600: $new_values{$file_name."\0".$newkey} =
5601: $$changes{'activate'}{$newitems[$i]};
5602: $new_control{$newkey} = $now;
5603: }
5604: }
5605: }
5606: my %todelete;
5607: my %changed_items;
5608: foreach my $action ('delete','update') {
5609: if (exists($$changes{$action})) {
5610: if (ref($$changes{$action}) eq 'HASH') {
5611: foreach my $key (keys(%{$$changes{$action}})) {
5612: my ($itemnum) = ($key =~ /^([^:]+):/);
5613: if ($action eq 'delete') {
5614: $todelete{$itemnum} = 1;
5615: } else {
5616: $changed_items{$itemnum} = $key;
5617: }
5618: }
5619: }
5620: }
5621: }
5622: # get lock on access controls for file.
5623: my $lockhash = {
5624: $file_name."\0".'locked_access_records' => $env{'user.name'}.
5625: ':'.$env{'user.domain'},
5626: };
5627: my $tries = 0;
5628: my $gotlock = &newput('file_permissions',$lockhash,$domain,$user);
5629:
5630: while (($gotlock ne 'ok') && $tries <3) {
5631: $tries ++;
5632: sleep 1;
5633: $gotlock = &newput('file_permissions',$lockhash,$domain,$user);
5634: }
5635: if ($gotlock eq 'ok') {
5636: my %curr_permissions = &dump('file_permissions',$domain,$user,$file_name);
5637: my ($tmp)=keys(%curr_permissions);
5638: if ($tmp=~/^error:/) { undef(%curr_permissions); }
5639: if (exists($curr_permissions{$file_name."\0".'accesscontrol'})) {
5640: my $curr_controls = $curr_permissions{$file_name."\0".'accesscontrol'};
5641: if (ref($curr_controls) eq 'HASH') {
5642: foreach my $control_item (keys(%{$curr_controls})) {
5643: my ($itemnum) = ($control_item =~ /^([^:]+):/);
5644: if (defined($todelete{$itemnum})) {
5645: push(@deletions,$file_name."\0".$control_item);
5646: } else {
5647: if (defined($changed_items{$itemnum})) {
5648: $new_control{$changed_items{$itemnum}} = $now;
5649: push(@deletions,$file_name."\0".$control_item);
5650: $new_values{$file_name."\0".$changed_items{$itemnum}} = $$changes{'update'}{$changed_items{$itemnum}};
5651: } else {
5652: $new_control{$control_item} = $$curr_controls{$control_item};
5653: }
5654: }
5655: }
5656: }
5657: }
5658: $deloutcome = &del('file_permissions',\@deletions,$domain,$user);
5659: $new_values{$file_name."\0".'accesscontrol'} = \%new_control;
5660: $outcome = &put('file_permissions',\%new_values,$domain,$user);
5661: # remove lock
5662: my @del_lock = ($file_name."\0".'locked_access_records');
5663: my $dellockoutcome = &del('file_permissions',\@del_lock,$domain,$user);
5664: my ($file,$group);
5665: if (&is_course($domain,$user)) {
5666: ($group,$file) = split(/\//,$file_name,2);
5667: } else {
5668: $file = $file_name;
5669: }
5670: my $sqlresult =
5671: &update_portfolio_table($user,$domain,$file,'portfolio_access',
5672: $group);
5673: } else {
5674: $outcome = "error: could not obtain lockfile\n";
5675: }
5676: return ($outcome,$deloutcome,\%new_values,\%translation);
5677: }
5678:
5679: sub make_public_indefinitely {
5680: my ($requrl) = @_;
5681: my $now = time;
5682: my $action = 'activate';
5683: my $aclnum = 0;
5684: if (&is_portfolio_url($requrl)) {
5685: my (undef,$udom,$unum,$file_name,$group) =
5686: &parse_portfolio_url($requrl);
5687: my $current_perms = &get_portfile_permissions($udom,$unum);
5688: my %access_controls = &get_access_controls($current_perms,
5689: $group,$file_name);
5690: foreach my $key (keys(%{$access_controls{$file_name}})) {
5691: my ($num,$scope,$end,$start) =
5692: ($key =~ /^([^:]+):([a-z]+)_(\d*)_?(\d*)$/);
5693: if ($scope eq 'public') {
5694: if ($start <= $now && $end == 0) {
5695: $action = 'none';
5696: } else {
5697: $action = 'update';
5698: $aclnum = $num;
5699: }
5700: last;
5701: }
5702: }
5703: if ($action eq 'none') {
5704: return 'ok';
5705: } else {
5706: my %changes;
5707: my $newend = 0;
5708: my $newstart = $now;
5709: my $newkey = $aclnum.':public_'.$newend.'_'.$newstart;
5710: $changes{$action}{$newkey} = {
5711: type => 'public',
5712: time => {
5713: start => $newstart,
5714: end => $newend,
5715: },
5716: };
5717: my ($outcome,$deloutcome,$new_values,$translation) =
5718: &modify_access_controls($file_name,\%changes,$udom,$unum);
5719: return $outcome;
5720: }
5721: } else {
5722: return 'invalid';
5723: }
5724: }
5725:
5726: #------------------------------------------------------Get Marked as Read Only
5727:
5728: sub get_marked_as_readonly {
5729: my ($domain,$user,$what,$group) = @_;
5730: my $current_permissions = &get_portfile_permissions($domain,$user);
5731: my @readonly_files;
5732: my $cmp1=$what;
5733: if (ref($what)) { $cmp1=join('',@{$what}) };
5734: while (my ($file_name,$value) = each(%{$current_permissions})) {
5735: if (defined($group)) {
5736: if ($file_name !~ m-^\Q$group\E/-) {
5737: next;
5738: }
5739: }
5740: if (ref($value) eq "ARRAY"){
5741: foreach my $stored_what (@{$value}) {
5742: my $cmp2=$stored_what;
5743: if (ref($stored_what) eq 'ARRAY') {
5744: $cmp2=join('',@{$stored_what});
5745: }
5746: if ($cmp1 eq $cmp2) {
5747: push(@readonly_files, $file_name);
5748: last;
5749: } elsif (!defined($what)) {
5750: push(@readonly_files, $file_name);
5751: last;
5752: }
5753: }
5754: }
5755: }
5756: return @readonly_files;
5757: }
5758: #-----------------------------------------------------------Get Marked as Read Only Hash
5759:
5760: sub get_marked_as_readonly_hash {
5761: my ($current_permissions,$group,$what) = @_;
5762: my %readonly_files;
5763: while (my ($file_name,$value) = each(%{$current_permissions})) {
5764: if (defined($group)) {
5765: if ($file_name !~ m-^\Q$group\E/-) {
5766: next;
5767: }
5768: }
5769: if (ref($value) eq "ARRAY"){
5770: foreach my $stored_what (@{$value}) {
5771: if (ref($stored_what) eq 'ARRAY') {
5772: foreach my $lock_descriptor(@{$stored_what}) {
5773: if ($lock_descriptor eq 'graded') {
5774: $readonly_files{$file_name} = 'graded';
5775: } elsif ($lock_descriptor eq 'handback') {
5776: $readonly_files{$file_name} = 'handback';
5777: } else {
5778: if (!exists($readonly_files{$file_name})) {
5779: $readonly_files{$file_name} = 'locked';
5780: }
5781: }
5782: }
5783: }
5784: }
5785: }
5786: }
5787: return %readonly_files;
5788: }
5789: # ------------------------------------------------------------ Unmark as Read Only
5790:
5791: sub unmark_as_readonly {
5792: # unmarks $file_name (if $file_name is defined), or all files locked by $what
5793: # for portfolio submissions, $what contains [$symb,$crsid]
5794: my ($domain,$user,$what,$file_name,$group) = @_;
5795: $file_name = &declutter_portfile($file_name);
5796: my $symb_crs = $what;
5797: if (ref($what)) { $symb_crs=join('',@$what); }
5798: my %current_permissions = &dump('file_permissions',$domain,$user,$group);
5799: my ($tmp)=keys(%current_permissions);
5800: if ($tmp=~/^error:/) { undef(%current_permissions); }
5801: my @readonly_files = &get_marked_as_readonly($domain,$user,$what,$group);
5802: foreach my $file (@readonly_files) {
5803: my $clean_file = &declutter_portfile($file);
5804: if (defined($file_name) && ($file_name ne $clean_file)) { next; }
5805: my $current_locks = $current_permissions{$file};
5806: my @new_locks;
5807: my @del_keys;
5808: if (ref($current_locks) eq "ARRAY"){
5809: foreach my $locker (@{$current_locks}) {
5810: my $compare=$locker;
5811: if (ref($locker) eq 'ARRAY') {
5812: $compare=join('',@{$locker});
5813: if ($compare ne $symb_crs) {
5814: push(@new_locks, $locker);
5815: }
5816: }
5817: }
5818: if (scalar(@new_locks) > 0) {
5819: $current_permissions{$file} = \@new_locks;
5820: } else {
5821: push(@del_keys, $file);
5822: &del('file_permissions',\@del_keys, $domain, $user);
5823: delete($current_permissions{$file});
5824: }
5825: }
5826: }
5827: &put('file_permissions',\%current_permissions,$domain,$user);
5828: return;
5829: }
5830:
5831: # ------------------------------------------------------------ Directory lister
5832:
5833: sub dirlist {
5834: my ($uri,$userdomain,$username,$alternateDirectoryRoot)=@_;
5835:
5836: $uri=~s/^\///;
5837: $uri=~s/\/$//;
5838: my ($udom, $uname);
5839: (undef,$udom,$uname)=split(/\//,$uri);
5840: if(defined($userdomain)) {
5841: $udom = $userdomain;
5842: }
5843: if(defined($username)) {
5844: $uname = $username;
5845: }
5846:
5847: my $dirRoot = $perlvar{'lonDocRoot'};
5848: if(defined($alternateDirectoryRoot)) {
5849: $dirRoot = $alternateDirectoryRoot;
5850: $dirRoot =~ s/\/$//;
5851: }
5852:
5853: if($udom) {
5854: if($uname) {
5855: my $listing = &reply('ls2:'.$dirRoot.'/'.$uri,
5856: &homeserver($uname,$udom));
5857: my @listing_results;
5858: if ($listing eq 'unknown_cmd') {
5859: $listing = &reply('ls:'.$dirRoot.'/'.$uri,
5860: &homeserver($uname,$udom));
5861: @listing_results = split(/:/,$listing);
5862: } else {
5863: @listing_results = map { &unescape($_); } split(/:/,$listing);
5864: }
5865: return @listing_results;
5866: } elsif(!defined($alternateDirectoryRoot)) {
5867: my %allusers;
5868: my %servers = &get_servers($udom,'library');
5869: foreach my $tryserver (keys(%servers)) {
5870: my $listing = &reply('ls2:'.$perlvar{'lonDocRoot'}.'/res/'.
5871: $udom, $tryserver);
5872: my @listing_results;
5873: if ($listing eq 'unknown_cmd') {
5874: $listing = &reply('ls:'.$perlvar{'lonDocRoot'}.'/res/'.
5875: $udom, $tryserver);
5876: @listing_results = split(/:/,$listing);
5877: } else {
5878: @listing_results =
5879: map { &unescape($_); } split(/:/,$listing);
5880: }
5881: if ($listing_results[0] ne 'no_such_dir' &&
5882: $listing_results[0] ne 'empty' &&
5883: $listing_results[0] ne 'con_lost') {
5884: foreach my $line (@listing_results) {
5885: my ($entry) = split(/&/,$line,2);
5886: $allusers{$entry} = 1;
5887: }
5888: }
5889: }
5890: my $alluserstr='';
5891: foreach my $user (sort(keys(%allusers))) {
5892: $alluserstr.=$user.'&user:';
5893: }
5894: $alluserstr=~s/:$//;
5895: return split(/:/,$alluserstr);
5896: } else {
5897: return ('missing user name');
5898: }
5899: } elsif(!defined($alternateDirectoryRoot)) {
5900: my @all_domains = sort(&all_domains());
5901: foreach my $domain (@all_domains) {
5902: $domain = $perlvar{'lonDocRoot'}.'/res/'.$domain.'/&domain';
5903: }
5904: return @all_domains;
5905: } else {
5906: return ('missing domain');
5907: }
5908: }
5909:
5910: # --------------------------------------------- GetFileTimestamp
5911: # This function utilizes dirlist and returns the date stamp for
5912: # when it was last modified. It will also return an error of -1
5913: # if an error occurs
5914:
5915: ##
5916: ## FIXME: This subroutine assumes its caller knows something about the
5917: ## directory structure of the home server for the student ($root).
5918: ## Not a good assumption to make. Since this is for looking up files
5919: ## in user directories, the full path should be constructed by lond, not
5920: ## whatever machine we request data from.
5921: ##
5922: sub GetFileTimestamp {
5923: my ($studentDomain,$studentName,$filename,$root)=@_;
5924: $studentDomain = &LONCAPA::clean_domain($studentDomain);
5925: $studentName = &LONCAPA::clean_username($studentName);
5926: my $subdir=$studentName.'__';
5927: $subdir =~ s/(.)(.)(.).*/$1\/$2\/$3/;
5928: my $proname="$studentDomain/$subdir/$studentName";
5929: $proname .= '/'.$filename;
5930: my ($fileStat) = &Apache::lonnet::dirlist($proname, $studentDomain,
5931: $studentName, $root);
5932: my @stats = split('&', $fileStat);
5933: if($stats[0] ne 'empty' && $stats[0] ne 'no_such_dir') {
5934: # @stats contains first the filename, then the stat output
5935: return $stats[10]; # so this is 10 instead of 9.
5936: } else {
5937: return -1;
5938: }
5939: }
5940:
5941: sub stat_file {
5942: my ($uri) = @_;
5943: $uri = &clutter_with_no_wrapper($uri);
5944:
5945: my ($udom,$uname,$file,$dir);
5946: if ($uri =~ m-^/(uploaded|editupload)/-) {
5947: ($udom,$uname,$file) =
5948: ($uri =~ m-/(?:uploaded|editupload)/?($match_domain)/?($match_name)/?(.*)-);
5949: $file = 'userfiles/'.$file;
5950: $dir = &propath($udom,$uname);
5951: }
5952: if ($uri =~ m-^/res/-) {
5953: ($udom,$uname) =
5954: ($uri =~ m-/(?:res)/?($match_domain)/?($match_username)/-);
5955: $file = $uri;
5956: }
5957:
5958: if (!$udom || !$uname || !$file) {
5959: # unable to handle the uri
5960: return ();
5961: }
5962:
5963: my ($result) = &dirlist($file,$udom,$uname,$dir);
5964: my @stats = split('&', $result);
5965:
5966: if($stats[0] ne 'empty' && $stats[0] ne 'no_such_dir') {
5967: shift(@stats); #filename is first
5968: return @stats;
5969: }
5970: return ();
5971: }
5972:
5973: # -------------------------------------------------------- Value of a Condition
5974:
5975: # gets the value of a specific preevaluated condition
5976: # stored in the string $env{user.state.<cid>}
5977: # or looks up a condition reference in the bighash and if if hasn't
5978: # already been evaluated recurses into docondval to get the value of
5979: # the condition, then memoizing it to
5980: # $env{user.state.<cid>.<condition>}
5981: sub directcondval {
5982: my $number=shift;
5983: if (!defined($env{'user.state.'.$env{'request.course.id'}})) {
5984: &Apache::lonuserstate::evalstate();
5985: }
5986: if (exists($env{'user.state.'.$env{'request.course.id'}.".$number"})) {
5987: return $env{'user.state.'.$env{'request.course.id'}.".$number"};
5988: } elsif ($number =~ /^_/) {
5989: my $sub_condition;
5990: if (tie(my %bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
5991: &GDBM_READER(),0640)) {
5992: $sub_condition=$bighash{'conditions'.$number};
5993: untie(%bighash);
5994: }
5995: my $value = &docondval($sub_condition);
5996: &appenv('user.state.'.$env{'request.course.id'}.".$number" => $value);
5997: return $value;
5998: }
5999: if ($env{'user.state.'.$env{'request.course.id'}}) {
6000: return substr($env{'user.state.'.$env{'request.course.id'}},$number,1);
6001: } else {
6002: return 2;
6003: }
6004: }
6005:
6006: # get the collection of conditions for this resource
6007: sub condval {
6008: my $condidx=shift;
6009: my $allpathcond='';
6010: foreach my $cond (split(/\|/,$condidx)) {
6011: if (defined($env{'acc.cond.'.$env{'request.course.id'}.'.'.$cond})) {
6012: $allpathcond.=
6013: '('.$env{'acc.cond.'.$env{'request.course.id'}.'.'.$cond}.')|';
6014: }
6015: }
6016: $allpathcond=~s/\|$//;
6017: return &docondval($allpathcond);
6018: }
6019:
6020: #evaluates an expression of conditions
6021: sub docondval {
6022: my ($allpathcond) = @_;
6023: my $result=0;
6024: if ($env{'request.course.id'}
6025: && defined($allpathcond)) {
6026: my $operand='|';
6027: my @stack;
6028: foreach my $chunk ($allpathcond=~/(\d+|_\d+\.\d+|\(|\)|\&|\|)/g) {
6029: if ($chunk eq '(') {
6030: push @stack,($operand,$result);
6031: } elsif ($chunk eq ')') {
6032: my $before=pop @stack;
6033: if (pop @stack eq '&') {
6034: $result=$result>$before?$before:$result;
6035: } else {
6036: $result=$result>$before?$result:$before;
6037: }
6038: } elsif (($chunk eq '&') || ($chunk eq '|')) {
6039: $operand=$chunk;
6040: } else {
6041: my $new=directcondval($chunk);
6042: if ($operand eq '&') {
6043: $result=$result>$new?$new:$result;
6044: } else {
6045: $result=$result>$new?$result:$new;
6046: }
6047: }
6048: }
6049: }
6050: return $result;
6051: }
6052:
6053: # ---------------------------------------------------- Devalidate courseresdata
6054:
6055: sub devalidatecourseresdata {
6056: my ($coursenum,$coursedomain)=@_;
6057: my $hashid=$coursenum.':'.$coursedomain;
6058: &devalidate_cache_new('courseres',$hashid);
6059: }
6060:
6061:
6062: # --------------------------------------------------- Course Resourcedata Query
6063: #
6064: # Parameters:
6065: # $coursenum - Number of the course.
6066: # $coursedomain - Domain at which the course was created.
6067: # Returns:
6068: # A hash of the course parameters along (I think) with timestamps
6069: # and version info.
6070:
6071: sub get_courseresdata {
6072: my ($coursenum,$coursedomain)=@_;
6073: my $coursehom=&homeserver($coursenum,$coursedomain);
6074: my $hashid=$coursenum.':'.$coursedomain;
6075: my ($result,$cached)=&is_cached_new('courseres',$hashid);
6076: my %dumpreply;
6077: unless (defined($cached)) {
6078: %dumpreply=&dump('resourcedata',$coursedomain,$coursenum);
6079: $result=\%dumpreply;
6080: my ($tmp) = keys(%dumpreply);
6081: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
6082: &do_cache_new('courseres',$hashid,$result,600);
6083: } elsif ($tmp =~ /^(con_lost|no_such_host)/) {
6084: return $tmp;
6085: } elsif ($tmp =~ /^(error)/) {
6086: $result=undef;
6087: &do_cache_new('courseres',$hashid,$result,600);
6088: }
6089: }
6090: return $result;
6091: }
6092:
6093: sub devalidateuserresdata {
6094: my ($uname,$udom)=@_;
6095: my $hashid="$udom:$uname";
6096: &devalidate_cache_new('userres',$hashid);
6097: }
6098:
6099: sub get_userresdata {
6100: my ($uname,$udom)=@_;
6101: #most student don\'t have any data set, check if there is some data
6102: if (&EXT_cache_status($udom,$uname)) { return undef; }
6103:
6104: my $hashid="$udom:$uname";
6105: my ($result,$cached)=&is_cached_new('userres',$hashid);
6106: if (!defined($cached)) {
6107: my %resourcedata=&dump('resourcedata',$udom,$uname);
6108: $result=\%resourcedata;
6109: &do_cache_new('userres',$hashid,$result,600);
6110: }
6111: my ($tmp)=keys(%$result);
6112: if (($tmp!~/^error\:/) && ($tmp!~/^con_lost/)) {
6113: return $result;
6114: }
6115: #error 2 occurs when the .db doesn't exist
6116: if ($tmp!~/error: 2 /) {
6117: &logthis("<font color=\"blue\">WARNING:".
6118: " Trying to get resource data for ".
6119: $uname." at ".$udom.": ".
6120: $tmp."</font>");
6121: } elsif ($tmp=~/error: 2 /) {
6122: #&EXT_cache_set($udom,$uname);
6123: &do_cache_new('userres',$hashid,undef,600);
6124: undef($tmp); # not really an error so don't send it back
6125: }
6126: return $tmp;
6127: }
6128: #----------------------------------------------- resdata - return resource data
6129: # Purpose:
6130: # Return resource data for either users or for a course.
6131: # Parameters:
6132: # $name - Course/user name.
6133: # $domain - Name of the domain the user/course is registered on.
6134: # $type - Type of thing $name is (must be 'course' or 'user'
6135: # @which - Array of names of resources desired.
6136: # Returns:
6137: # The value of the first reasource in @which that is found in the
6138: # resource hash.
6139: # Exceptional Conditions:
6140: # If the $type passed in is not valid (not the string 'course' or
6141: # 'user', an undefined reference is returned.
6142: # If none of the resources are found, an undef is returned
6143: sub resdata {
6144: my ($name,$domain,$type,@which)=@_;
6145: my $result;
6146: if ($type eq 'course') {
6147: $result=&get_courseresdata($name,$domain);
6148: } elsif ($type eq 'user') {
6149: $result=&get_userresdata($name,$domain);
6150: }
6151: if (!ref($result)) { return $result; }
6152: foreach my $item (@which) {
6153: if (defined($result->{$item})) {
6154: return $result->{$item};
6155: }
6156: }
6157: return undef;
6158: }
6159:
6160: #
6161: # EXT resource caching routines
6162: #
6163:
6164: sub clear_EXT_cache_status {
6165: &delenv('cache.EXT.');
6166: }
6167:
6168: sub EXT_cache_status {
6169: my ($target_domain,$target_user) = @_;
6170: my $cachename = 'cache.EXT.'.$target_user.'.'.$target_domain;
6171: if (exists($env{$cachename}) && ($env{$cachename}+600) > time) {
6172: # We know already the user has no data
6173: return 1;
6174: } else {
6175: return 0;
6176: }
6177: }
6178:
6179: sub EXT_cache_set {
6180: my ($target_domain,$target_user) = @_;
6181: my $cachename = 'cache.EXT.'.$target_user.'.'.$target_domain;
6182: #&appenv($cachename => time);
6183: }
6184:
6185: # --------------------------------------------------------- Value of a Variable
6186: sub EXT {
6187:
6188: my ($varname,$symbparm,$udom,$uname,$usection,$recurse)=@_;
6189: unless ($varname) { return ''; }
6190: #get real user name/domain, courseid and symb
6191: my $courseid;
6192: my $publicuser;
6193: if ($symbparm) {
6194: $symbparm=&get_symb_from_alias($symbparm);
6195: }
6196: if (!($uname && $udom)) {
6197: (my $cursymb,$courseid,$udom,$uname,$publicuser)= &whichuser($symbparm);
6198: if (!$symbparm) { $symbparm=$cursymb; }
6199: } else {
6200: $courseid=$env{'request.course.id'};
6201: }
6202: my ($realm,$space,$qualifier,@therest)=split(/\./,$varname);
6203: my $rest;
6204: if (defined($therest[0])) {
6205: $rest=join('.',@therest);
6206: } else {
6207: $rest='';
6208: }
6209:
6210: my $qualifierrest=$qualifier;
6211: if ($rest) { $qualifierrest.='.'.$rest; }
6212: my $spacequalifierrest=$space;
6213: if ($qualifierrest) { $spacequalifierrest.='.'.$qualifierrest; }
6214: if ($realm eq 'user') {
6215: # --------------------------------------------------------------- user.resource
6216: if ($space eq 'resource') {
6217: if ( (defined($Apache::lonhomework::parsing_a_problem)
6218: || defined($Apache::lonhomework::parsing_a_task))
6219: &&
6220: ($symbparm eq &symbread()) ) {
6221: # if we are in the middle of processing the resource the
6222: # get the value we are planning on committing
6223: if (defined($Apache::lonhomework::results{$qualifierrest})) {
6224: return $Apache::lonhomework::results{$qualifierrest};
6225: } else {
6226: return $Apache::lonhomework::history{$qualifierrest};
6227: }
6228: } else {
6229: my %restored;
6230: if ($publicuser || $env{'request.state'} eq 'construct') {
6231: %restored=&tmprestore($symbparm,$courseid,$udom,$uname);
6232: } else {
6233: %restored=&restore($symbparm,$courseid,$udom,$uname);
6234: }
6235: return $restored{$qualifierrest};
6236: }
6237: # ----------------------------------------------------------------- user.access
6238: } elsif ($space eq 'access') {
6239: # FIXME - not supporting calls for a specific user
6240: return &allowed($qualifier,$rest);
6241: # ------------------------------------------ user.preferences, user.environment
6242: } elsif (($space eq 'preferences') || ($space eq 'environment')) {
6243: if (($uname eq $env{'user.name'}) &&
6244: ($udom eq $env{'user.domain'})) {
6245: return $env{join('.',('environment',$qualifierrest))};
6246: } else {
6247: my %returnhash;
6248: if (!$publicuser) {
6249: %returnhash=&userenvironment($udom,$uname,
6250: $qualifierrest);
6251: }
6252: return $returnhash{$qualifierrest};
6253: }
6254: # ----------------------------------------------------------------- user.course
6255: } elsif ($space eq 'course') {
6256: # FIXME - not supporting calls for a specific user
6257: return $env{join('.',('request.course',$qualifier))};
6258: # ------------------------------------------------------------------- user.role
6259: } elsif ($space eq 'role') {
6260: # FIXME - not supporting calls for a specific user
6261: my ($role,$where)=split(/\./,$env{'request.role'});
6262: if ($qualifier eq 'value') {
6263: return $role;
6264: } elsif ($qualifier eq 'extent') {
6265: return $where;
6266: }
6267: # ----------------------------------------------------------------- user.domain
6268: } elsif ($space eq 'domain') {
6269: return $udom;
6270: # ------------------------------------------------------------------- user.name
6271: } elsif ($space eq 'name') {
6272: return $uname;
6273: # ---------------------------------------------------- Any other user namespace
6274: } else {
6275: my %reply;
6276: if (!$publicuser) {
6277: %reply=&get($space,[$qualifierrest],$udom,$uname);
6278: }
6279: return $reply{$qualifierrest};
6280: }
6281: } elsif ($realm eq 'query') {
6282: # ---------------------------------------------- pull stuff out of query string
6283: &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},
6284: [$spacequalifierrest]);
6285: return $env{'form.'.$spacequalifierrest};
6286: } elsif ($realm eq 'request') {
6287: # ------------------------------------------------------------- request.browser
6288: if ($space eq 'browser') {
6289: if ($qualifier eq 'textremote') {
6290: if (&Apache::lonlocal::mt('textual_remote_display') eq 'on') {
6291: return 1;
6292: } else {
6293: return 0;
6294: }
6295: } else {
6296: return $env{'browser.'.$qualifier};
6297: }
6298: # ------------------------------------------------------------ request.filename
6299: } else {
6300: return $env{'request.'.$spacequalifierrest};
6301: }
6302: } elsif ($realm eq 'course') {
6303: # ---------------------------------------------------------- course.description
6304: return $env{'course.'.$courseid.'.'.$spacequalifierrest};
6305: } elsif ($realm eq 'resource') {
6306:
6307: if (defined($courseid) && $courseid eq $env{'request.course.id'}) {
6308: if (!$symbparm) { $symbparm=&symbread(); }
6309: }
6310:
6311: if ($space eq 'title') {
6312: if (!$symbparm) { $symbparm = $env{'request.filename'}; }
6313: return &gettitle($symbparm);
6314: }
6315:
6316: if ($space eq 'map') {
6317: my ($map) = &decode_symb($symbparm);
6318: return &symbread($map);
6319: }
6320: if ($space eq 'filename') {
6321: if ($symbparm) {
6322: return &clutter((&decode_symb($symbparm))[2]);
6323: }
6324: return &hreflocation('',$env{'request.filename'});
6325: }
6326:
6327: my ($section, $group, @groups);
6328: my ($courselevelm,$courselevel);
6329: if ($symbparm && defined($courseid) &&
6330: $courseid eq $env{'request.course.id'}) {
6331:
6332: #print '<br>'.$space.' - '.$qualifier.' - '.$spacequalifierrest;
6333:
6334: # ----------------------------------------------------- Cascading lookup scheme
6335: my $symbp=$symbparm;
6336: my $mapp=&deversion((&decode_symb($symbp))[0]);
6337:
6338: my $symbparm=$symbp.'.'.$spacequalifierrest;
6339: my $mapparm=$mapp.'___(all).'.$spacequalifierrest;
6340:
6341: if (($env{'user.name'} eq $uname) &&
6342: ($env{'user.domain'} eq $udom)) {
6343: $section=$env{'request.course.sec'};
6344: @groups = split(/:/,$env{'request.course.groups'});
6345: @groups=&sort_course_groups($courseid,@groups);
6346: } else {
6347: if (! defined($usection)) {
6348: $section=&getsection($udom,$uname,$courseid);
6349: } else {
6350: $section = $usection;
6351: }
6352: @groups = &get_users_groups($udom,$uname,$courseid);
6353: }
6354:
6355: my $seclevel=$courseid.'.['.$section.'].'.$spacequalifierrest;
6356: my $seclevelr=$courseid.'.['.$section.'].'.$symbparm;
6357: my $seclevelm=$courseid.'.['.$section.'].'.$mapparm;
6358:
6359: $courselevel=$courseid.'.'.$spacequalifierrest;
6360: my $courselevelr=$courseid.'.'.$symbparm;
6361: $courselevelm=$courseid.'.'.$mapparm;
6362:
6363: # ----------------------------------------------------------- first, check user
6364:
6365: my $userreply=&resdata($uname,$udom,'user',
6366: ($courselevelr,$courselevelm,
6367: $courselevel));
6368: if (defined($userreply)) { return $userreply; }
6369:
6370: # ------------------------------------------------ second, check some of course
6371: my $coursereply;
6372: if (@groups > 0) {
6373: $coursereply = &check_group_parms($courseid,\@groups,$symbparm,
6374: $mapparm,$spacequalifierrest);
6375: if (defined($coursereply)) { return $coursereply; }
6376: }
6377:
6378: $coursereply=&resdata($env{'course.'.$courseid.'.num'},
6379: $env{'course.'.$courseid.'.domain'},
6380: 'course',
6381: ($seclevelr,$seclevelm,$seclevel,
6382: $courselevelr));
6383: if (defined($coursereply)) { return $coursereply; }
6384:
6385: # ------------------------------------------------------ third, check map parms
6386: my %parmhash=();
6387: my $thisparm='';
6388: if (tie(%parmhash,'GDBM_File',
6389: $env{'request.course.fn'}.'_parms.db',
6390: &GDBM_READER(),0640)) {
6391: $thisparm=$parmhash{$symbparm};
6392: untie(%parmhash);
6393: }
6394: if ($thisparm) { return $thisparm; }
6395: }
6396: # ------------------------------------------ fourth, look in resource metadata
6397:
6398: $spacequalifierrest=~s/\./\_/;
6399: my $filename;
6400: if (!$symbparm) { $symbparm=&symbread(); }
6401: if ($symbparm) {
6402: $filename=(&decode_symb($symbparm))[2];
6403: } else {
6404: $filename=$env{'request.filename'};
6405: }
6406: my $metadata=&metadata($filename,$spacequalifierrest);
6407: if (defined($metadata)) { return $metadata; }
6408: $metadata=&metadata($filename,'parameter_'.$spacequalifierrest);
6409: if (defined($metadata)) { return $metadata; }
6410:
6411: # ---------------------------------------------- fourth, look in rest pf course
6412: if ($symbparm && defined($courseid) &&
6413: $courseid eq $env{'request.course.id'}) {
6414: my $coursereply=&resdata($env{'course.'.$courseid.'.num'},
6415: $env{'course.'.$courseid.'.domain'},
6416: 'course',
6417: ($courselevelm,$courselevel));
6418: if (defined($coursereply)) { return $coursereply; }
6419: }
6420: # ------------------------------------------------------------------ Cascade up
6421: unless ($space eq '0') {
6422: my @parts=split(/_/,$space);
6423: my $id=pop(@parts);
6424: my $part=join('_',@parts);
6425: if ($part eq '') { $part='0'; }
6426: my $partgeneral=&EXT('resource.'.$part.'.'.$qualifierrest,
6427: $symbparm,$udom,$uname,$section,1);
6428: if (defined($partgeneral)) { return $partgeneral; }
6429: }
6430: if ($recurse) { return undef; }
6431: my $pack_def=&packages_tab_default($filename,$varname);
6432: if (defined($pack_def)) { return $pack_def; }
6433:
6434: # ---------------------------------------------------- Any other user namespace
6435: } elsif ($realm eq 'environment') {
6436: # ----------------------------------------------------------------- environment
6437: if (($uname eq $env{'user.name'})&&($udom eq $env{'user.domain'})) {
6438: return $env{'environment.'.$spacequalifierrest};
6439: } else {
6440: if ($uname eq 'anonymous' && $udom eq '') {
6441: return '';
6442: }
6443: my %returnhash=&userenvironment($udom,$uname,
6444: $spacequalifierrest);
6445: return $returnhash{$spacequalifierrest};
6446: }
6447: } elsif ($realm eq 'system') {
6448: # ----------------------------------------------------------------- system.time
6449: if ($space eq 'time') {
6450: return time;
6451: }
6452: } elsif ($realm eq 'server') {
6453: # ----------------------------------------------------------------- system.time
6454: if ($space eq 'name') {
6455: return $ENV{'SERVER_NAME'};
6456: }
6457: }
6458: return '';
6459: }
6460:
6461: sub check_group_parms {
6462: my ($courseid,$groups,$symbparm,$mapparm,$what) = @_;
6463: my @groupitems = ();
6464: my $resultitem;
6465: my @levels = ($symbparm,$mapparm,$what);
6466: foreach my $group (@{$groups}) {
6467: foreach my $level (@levels) {
6468: my $item = $courseid.'.['.$group.'].'.$level;
6469: push(@groupitems,$item);
6470: }
6471: }
6472: my $coursereply = &resdata($env{'course.'.$courseid.'.num'},
6473: $env{'course.'.$courseid.'.domain'},
6474: 'course',@groupitems);
6475: return $coursereply;
6476: }
6477:
6478: sub sort_course_groups { # Sort groups based on defined rankings. Default is sort().
6479: my ($courseid,@groups) = @_;
6480: @groups = sort(@groups);
6481: return @groups;
6482: }
6483:
6484: sub packages_tab_default {
6485: my ($uri,$varname)=@_;
6486: my (undef,$part,$name)=split(/\./,$varname);
6487:
6488: my (@extension,@specifics,$do_default);
6489: foreach my $package (split(/,/,&metadata($uri,'packages'))) {
6490: my ($pack_type,$pack_part)=split(/_/,$package,2);
6491: if ($pack_type eq 'default') {
6492: $do_default=1;
6493: } elsif ($pack_type eq 'extension') {
6494: push(@extension,[$package,$pack_type,$pack_part]);
6495: } elsif ($pack_part eq $part || $pack_type eq 'part') {
6496: # only look at packages defaults for packages that this id is
6497: push(@specifics,[$package,$pack_type,$pack_part]);
6498: }
6499: }
6500: # first look for a package that matches the requested part id
6501: foreach my $package (@specifics) {
6502: my (undef,$pack_type,$pack_part)=@{$package};
6503: next if ($pack_part ne $part);
6504: if (defined($packagetab{"$pack_type&$name&default"})) {
6505: return $packagetab{"$pack_type&$name&default"};
6506: }
6507: }
6508: # look for any possible matching non extension_ package
6509: foreach my $package (@specifics) {
6510: my (undef,$pack_type,$pack_part)=@{$package};
6511: if (defined($packagetab{"$pack_type&$name&default"})) {
6512: return $packagetab{"$pack_type&$name&default"};
6513: }
6514: if ($pack_type eq 'part') { $pack_part='0'; }
6515: if (defined($packagetab{$pack_type."_".$pack_part."&$name&default"})) {
6516: return $packagetab{$pack_type."_".$pack_part."&$name&default"};
6517: }
6518: }
6519: # look for any posible extension_ match
6520: foreach my $package (@extension) {
6521: my ($package,$pack_type)=@{$package};
6522: if (defined($packagetab{"$pack_type&$name&default"})) {
6523: return $packagetab{"$pack_type&$name&default"};
6524: }
6525: if (defined($packagetab{$package."&$name&default"})) {
6526: return $packagetab{$package."&$name&default"};
6527: }
6528: }
6529: # look for a global default setting
6530: if ($do_default && defined($packagetab{"default&$name&default"})) {
6531: return $packagetab{"default&$name&default"};
6532: }
6533: return undef;
6534: }
6535:
6536: sub add_prefix_and_part {
6537: my ($prefix,$part)=@_;
6538: my $keyroot;
6539: if (defined($prefix) && $prefix !~ /^__/) {
6540: # prefix that has a part already
6541: $keyroot=$prefix;
6542: } elsif (defined($prefix)) {
6543: # prefix that is missing a part
6544: if (defined($part)) { $keyroot='_'.$part.substr($prefix,1); }
6545: } else {
6546: # no prefix at all
6547: if (defined($part)) { $keyroot='_'.$part; }
6548: }
6549: return $keyroot;
6550: }
6551:
6552: # ---------------------------------------------------------------- Get metadata
6553:
6554: my %metaentry;
6555: sub metadata {
6556: my ($uri,$what,$liburi,$prefix,$depthcount)=@_;
6557: $uri=&declutter($uri);
6558: # if it is a non metadata possible uri return quickly
6559: if (($uri eq '') ||
6560: (($uri =~ m|^/*adm/|) &&
6561: ($uri !~ m|^adm/includes|) && ($uri !~ m|/bulletinboard$|)) ||
6562: ($uri =~ m|/$|) || ($uri =~ m|/.meta$|) || ($uri =~ /^~/) ||
6563: ($uri =~ m|home/$match_username/public_html/|)) {
6564: return undef;
6565: }
6566: my $filename=$uri;
6567: $uri=~s/\.meta$//;
6568: #
6569: # Is the metadata already cached?
6570: # Look at timestamp of caching
6571: # Everything is cached by the main uri, libraries are never directly cached
6572: #
6573: if (!defined($liburi)) {
6574: my ($result,$cached)=&is_cached_new('meta',$uri);
6575: if (defined($cached)) { return $result->{':'.$what}; }
6576: }
6577: {
6578: #
6579: # Is this a recursive call for a library?
6580: #
6581: # if (! exists($metacache{$uri})) {
6582: # $metacache{$uri}={};
6583: # }
6584: if ($liburi) {
6585: $liburi=&declutter($liburi);
6586: $filename=$liburi;
6587: } else {
6588: &devalidate_cache_new('meta',$uri);
6589: undef(%metaentry);
6590: }
6591: my %metathesekeys=();
6592: unless ($filename=~/\.meta$/) { $filename.='.meta'; }
6593: my $metastring;
6594: if ($uri !~ m -^(editupload)/-) {
6595: my $file=&filelocation('',&clutter($filename));
6596: #push(@{$metaentry{$uri.'.file'}},$file);
6597: $metastring=&getfile($file);
6598: }
6599: my $parser=HTML::LCParser->new(\$metastring);
6600: my $token;
6601: undef %metathesekeys;
6602: while ($token=$parser->get_token) {
6603: if ($token->[0] eq 'S') {
6604: if (defined($token->[2]->{'package'})) {
6605: #
6606: # This is a package - get package info
6607: #
6608: my $package=$token->[2]->{'package'};
6609: my $keyroot=&add_prefix_and_part($prefix,$token->[2]->{'part'});
6610: if (defined($token->[2]->{'id'})) {
6611: $keyroot.='_'.$token->[2]->{'id'};
6612: }
6613: if ($metaentry{':packages'}) {
6614: $metaentry{':packages'}.=','.$package.$keyroot;
6615: } else {
6616: $metaentry{':packages'}=$package.$keyroot;
6617: }
6618: foreach my $pack_entry (keys(%packagetab)) {
6619: my $part=$keyroot;
6620: $part=~s/^\_//;
6621: if ($pack_entry=~/^\Q$package\E\&/ ||
6622: $pack_entry=~/^\Q$package\E_0\&/) {
6623: my ($pack,$name,$subp)=split(/\&/,$pack_entry);
6624: # ignore package.tab specified default values
6625: # here &package_tab_default() will fetch those
6626: if ($subp eq 'default') { next; }
6627: my $value=$packagetab{$pack_entry};
6628: my $unikey;
6629: if ($pack =~ /_0$/) {
6630: $unikey='parameter_0_'.$name;
6631: $part=0;
6632: } else {
6633: $unikey='parameter'.$keyroot.'_'.$name;
6634: }
6635: if ($subp eq 'display') {
6636: $value.=' [Part: '.$part.']';
6637: }
6638: $metaentry{':'.$unikey.'.part'}=$part;
6639: $metathesekeys{$unikey}=1;
6640: unless (defined($metaentry{':'.$unikey.'.'.$subp})) {
6641: $metaentry{':'.$unikey.'.'.$subp}=$value;
6642: }
6643: if (defined($metaentry{':'.$unikey.'.default'})) {
6644: $metaentry{':'.$unikey}=
6645: $metaentry{':'.$unikey.'.default'};
6646: }
6647: }
6648: }
6649: } else {
6650: #
6651: # This is not a package - some other kind of start tag
6652: #
6653: my $entry=$token->[1];
6654: my $unikey;
6655: if ($entry eq 'import') {
6656: $unikey='';
6657: } else {
6658: $unikey=$entry;
6659: }
6660: $unikey.=&add_prefix_and_part($prefix,$token->[2]->{'part'});
6661:
6662: if (defined($token->[2]->{'id'})) {
6663: $unikey.='_'.$token->[2]->{'id'};
6664: }
6665:
6666: if ($entry eq 'import') {
6667: #
6668: # Importing a library here
6669: #
6670: if ($depthcount<20) {
6671: my $location=$parser->get_text('/import');
6672: my $dir=$filename;
6673: $dir=~s|[^/]*$||;
6674: $location=&filelocation($dir,$location);
6675: my $metadata =
6676: &metadata($uri,'keys', $location,$unikey,
6677: $depthcount+1);
6678: foreach my $meta (split(',',$metadata)) {
6679: $metaentry{':'.$meta}=$metaentry{':'.$meta};
6680: $metathesekeys{$meta}=1;
6681: }
6682: }
6683: } else {
6684:
6685: if (defined($token->[2]->{'name'})) {
6686: $unikey.='_'.$token->[2]->{'name'};
6687: }
6688: $metathesekeys{$unikey}=1;
6689: foreach my $param (@{$token->[3]}) {
6690: $metaentry{':'.$unikey.'.'.$param} =
6691: $token->[2]->{$param};
6692: }
6693: my $internaltext=&HTML::Entities::decode($parser->get_text('/'.$entry));
6694: my $default=$metaentry{':'.$unikey.'.default'};
6695: if ( $internaltext =~ /^\s*$/ && $default !~ /^\s*$/) {
6696: # only ws inside the tag, and not in default, so use default
6697: # as value
6698: $metaentry{':'.$unikey}=$default;
6699: } else {
6700: # either something interesting inside the tag or default
6701: # uninteresting
6702: $metaentry{':'.$unikey}=$internaltext;
6703: }
6704: # end of not-a-package not-a-library import
6705: }
6706: # end of not-a-package start tag
6707: }
6708: # the next is the end of "start tag"
6709: }
6710: }
6711: my ($extension) = ($uri =~ /\.(\w+)$/);
6712: $extension = lc($extension);
6713: if ($extension eq 'htm') { $extension='html'; }
6714:
6715: foreach my $key (keys(%packagetab)) {
6716: #no specific packages #how's our extension
6717: if ($key!~/^extension_\Q$extension\E&/) { next; }
6718: &metadata_create_package_def($uri,$key,'extension_'.$extension,
6719: \%metathesekeys);
6720: }
6721:
6722: if (!exists($metaentry{':packages'})
6723: || $packagetab{"import_defaults&extension_$extension"}) {
6724: foreach my $key (keys(%packagetab)) {
6725: #no specific packages well let's get default then
6726: if ($key!~/^default&/) { next; }
6727: &metadata_create_package_def($uri,$key,'default',
6728: \%metathesekeys);
6729: }
6730: }
6731: # are there custom rights to evaluate
6732: if ($metaentry{':copyright'} eq 'custom') {
6733:
6734: #
6735: # Importing a rights file here
6736: #
6737: unless ($depthcount) {
6738: my $location=$metaentry{':customdistributionfile'};
6739: my $dir=$filename;
6740: $dir=~s|[^/]*$||;
6741: $location=&filelocation($dir,$location);
6742: my $rights_metadata =
6743: &metadata($uri,'keys',$location,'_rights',
6744: $depthcount+1);
6745: foreach my $rights (split(',',$rights_metadata)) {
6746: #$metaentry{':'.$rights}=$metacache{$uri}->{':'.$rights};
6747: $metathesekeys{$rights}=1;
6748: }
6749: }
6750: }
6751: # uniqifiy package listing
6752: my %seen;
6753: my @uniq_packages =
6754: grep { ! $seen{$_} ++ } (split(',',$metaentry{':packages'}));
6755: $metaentry{':packages'} = join(',',@uniq_packages);
6756:
6757: $metaentry{':keys'} = join(',',keys(%metathesekeys));
6758: &metadata_generate_part0(\%metathesekeys,\%metaentry,$uri);
6759: $metaentry{':allpossiblekeys'}=join(',',keys %metathesekeys);
6760: &do_cache_new('meta',$uri,\%metaentry,60*60);
6761: # this is the end of "was not already recently cached
6762: }
6763: return $metaentry{':'.$what};
6764: }
6765:
6766: sub metadata_create_package_def {
6767: my ($uri,$key,$package,$metathesekeys)=@_;
6768: my ($pack,$name,$subp)=split(/\&/,$key);
6769: if ($subp eq 'default') { next; }
6770:
6771: if (defined($metaentry{':packages'})) {
6772: $metaentry{':packages'}.=','.$package;
6773: } else {
6774: $metaentry{':packages'}=$package;
6775: }
6776: my $value=$packagetab{$key};
6777: my $unikey;
6778: $unikey='parameter_0_'.$name;
6779: $metaentry{':'.$unikey.'.part'}=0;
6780: $$metathesekeys{$unikey}=1;
6781: unless (defined($metaentry{':'.$unikey.'.'.$subp})) {
6782: $metaentry{':'.$unikey.'.'.$subp}=$value;
6783: }
6784: if (defined($metaentry{':'.$unikey.'.default'})) {
6785: $metaentry{':'.$unikey}=
6786: $metaentry{':'.$unikey.'.default'};
6787: }
6788: }
6789:
6790: sub metadata_generate_part0 {
6791: my ($metadata,$metacache,$uri) = @_;
6792: my %allnames;
6793: foreach my $metakey (keys(%$metadata)) {
6794: if ($metakey=~/^parameter\_(.*)/) {
6795: my $part=$$metacache{':'.$metakey.'.part'};
6796: my $name=$$metacache{':'.$metakey.'.name'};
6797: if (! exists($$metadata{'parameter_0_'.$name.'.name'})) {
6798: $allnames{$name}=$part;
6799: }
6800: }
6801: }
6802: foreach my $name (keys(%allnames)) {
6803: $$metadata{"parameter_0_$name"}=1;
6804: my $key=":parameter_0_$name";
6805: $$metacache{"$key.part"}='0';
6806: $$metacache{"$key.name"}=$name;
6807: $$metacache{"$key.type"}=$$metacache{':parameter_'.
6808: $allnames{$name}.'_'.$name.
6809: '.type'};
6810: my $olddis=$$metacache{':parameter_'.$allnames{$name}.'_'.$name.
6811: '.display'};
6812: my $expr='[Part: '.$allnames{$name}.']';
6813: $olddis=~s/\Q$expr\E/\[Part: 0\]/;
6814: $$metacache{"$key.display"}=$olddis;
6815: }
6816: }
6817:
6818: # ------------------------------------------------------ Devalidate title cache
6819:
6820: sub devalidate_title_cache {
6821: my ($url)=@_;
6822: if (!$env{'request.course.id'}) { return; }
6823: my $symb=&symbread($url);
6824: if (!$symb) { return; }
6825: my $key=$env{'request.course.id'}."\0".$symb;
6826: &devalidate_cache_new('title',$key);
6827: }
6828:
6829: # ------------------------------------------------- Get the title of a resource
6830:
6831: sub gettitle {
6832: my $urlsymb=shift;
6833: my $symb=&symbread($urlsymb);
6834: if ($symb) {
6835: my $key=$env{'request.course.id'}."\0".$symb;
6836: my ($result,$cached)=&is_cached_new('title',$key);
6837: if (defined($cached)) {
6838: return $result;
6839: }
6840: my ($map,$resid,$url)=&decode_symb($symb);
6841: my $title='';
6842: my %bighash;
6843: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
6844: &GDBM_READER(),0640)) {
6845: my $mapid=$bighash{'map_pc_'.&clutter($map)};
6846: $title=$bighash{'title_'.$mapid.'.'.$resid};
6847: untie %bighash;
6848: }
6849: $title=~s/\&colon\;/\:/gs;
6850: if ($title) {
6851: return &do_cache_new('title',$key,$title,600);
6852: }
6853: $urlsymb=$url;
6854: }
6855: my $title=&metadata($urlsymb,'title');
6856: if (!$title) { $title=(split('/',$urlsymb))[-1]; }
6857: return $title;
6858: }
6859:
6860: sub get_slot {
6861: my ($which,$cnum,$cdom)=@_;
6862: if (!$cnum || !$cdom) {
6863: (undef,my $courseid)=&whichuser();
6864: $cdom=$env{'course.'.$courseid.'.domain'};
6865: $cnum=$env{'course.'.$courseid.'.num'};
6866: }
6867: my $key=join("\0",'slots',$cdom,$cnum,$which);
6868: my %slotinfo;
6869: if (exists($remembered{$key})) {
6870: $slotinfo{$which} = $remembered{$key};
6871: } else {
6872: %slotinfo=&get('slots',[$which],$cdom,$cnum);
6873: &Apache::lonhomework::showhash(%slotinfo);
6874: my ($tmp)=keys(%slotinfo);
6875: if ($tmp=~/^error:/) { return (); }
6876: $remembered{$key} = $slotinfo{$which};
6877: }
6878: if (ref($slotinfo{$which}) eq 'HASH') {
6879: return %{$slotinfo{$which}};
6880: }
6881: return $slotinfo{$which};
6882: }
6883: # ------------------------------------------------- Update symbolic store links
6884:
6885: sub symblist {
6886: my ($mapname,%newhash)=@_;
6887: $mapname=&deversion(&declutter($mapname));
6888: my %hash;
6889: if (($env{'request.course.fn'}) && (%newhash)) {
6890: if (tie(%hash,'GDBM_File',$env{'request.course.fn'}.'_symb.db',
6891: &GDBM_WRCREAT(),0640)) {
6892: foreach my $url (keys %newhash) {
6893: next if ($url eq 'last_known'
6894: && $env{'form.no_update_last_known'});
6895: $hash{declutter($url)}=&encode_symb($mapname,
6896: $newhash{$url}->[1],
6897: $newhash{$url}->[0]);
6898: }
6899: if (untie(%hash)) {
6900: return 'ok';
6901: }
6902: }
6903: }
6904: return 'error';
6905: }
6906:
6907: # --------------------------------------------------------------- Verify a symb
6908:
6909: sub symbverify {
6910: my ($symb,$thisurl)=@_;
6911: my $thisfn=$thisurl;
6912: $thisfn=&declutter($thisfn);
6913: # direct jump to resource in page or to a sequence - will construct own symbs
6914: if ($thisfn=~/\.(page|sequence)$/) { return 1; }
6915: # check URL part
6916: my ($map,$resid,$url)=&decode_symb($symb);
6917:
6918: unless ($url eq $thisfn) { return 0; }
6919:
6920: $symb=&symbclean($symb);
6921: $thisurl=&deversion($thisurl);
6922: $thisfn=&deversion($thisfn);
6923:
6924: my %bighash;
6925: my $okay=0;
6926:
6927: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
6928: &GDBM_READER(),0640)) {
6929: my $ids=$bighash{'ids_'.&clutter($thisurl)};
6930: unless ($ids) {
6931: $ids=$bighash{'ids_/'.$thisurl};
6932: }
6933: if ($ids) {
6934: # ------------------------------------------------------------------- Has ID(s)
6935: foreach my $id (split(/\,/,$ids)) {
6936: my ($mapid,$resid)=split(/\./,$id);
6937: if (
6938: &symbclean(&declutter($bighash{'map_id_'.$mapid}).'___'.$resid.'___'.$thisfn)
6939: eq $symb) {
6940: if (($env{'request.role.adv'}) ||
6941: $bighash{'encrypted_'.$id} eq $env{'request.enc'}) {
6942: $okay=1;
6943: }
6944: }
6945: }
6946: }
6947: untie(%bighash);
6948: }
6949: return $okay;
6950: }
6951:
6952: # --------------------------------------------------------------- Clean-up symb
6953:
6954: sub symbclean {
6955: my $symb=shift;
6956: if ($symb=~m|^/enc/|) { $symb=&Apache::lonenc::unencrypted($symb); }
6957: # remove version from map
6958: $symb=~s/\.(\d+)\.(\w+)\_\_\_/\.$2\_\_\_/;
6959:
6960: # remove version from URL
6961: $symb=~s/\.(\d+)\.(\w+)$/\.$2/;
6962:
6963: # remove wrapper
6964:
6965: $symb=~s/(\_\_\_\d+\_\_\_)adm\/wrapper\/(res\/)*/$1/;
6966: $symb=~s/(\_\_\_\d+\_\_\_)adm\/coursedocs\/showdoc\/(res\/)*/$1/;
6967: return $symb;
6968: }
6969:
6970: # ---------------------------------------------- Split symb to find map and url
6971:
6972: sub encode_symb {
6973: my ($map,$resid,$url)=@_;
6974: return &symbclean(&declutter($map).'___'.$resid.'___'.&declutter($url));
6975: }
6976:
6977: sub decode_symb {
6978: my $symb=shift;
6979: if ($symb=~m|^/enc/|) { $symb=&Apache::lonenc::unencrypted($symb); }
6980: my ($map,$resid,$url)=split(/___/,$symb);
6981: return (&fixversion($map),$resid,&fixversion($url));
6982: }
6983:
6984: sub fixversion {
6985: my $fn=shift;
6986: if ($fn=~/^(adm|uploaded|editupload|public)/) { return $fn; }
6987: my %bighash;
6988: my $uri=&clutter($fn);
6989: my $key=$env{'request.course.id'}.'_'.$uri;
6990: # is this cached?
6991: my ($result,$cached)=&is_cached_new('courseresversion',$key);
6992: if (defined($cached)) { return $result; }
6993: # unfortunately not cached, or expired
6994: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
6995: &GDBM_READER(),0640)) {
6996: if ($bighash{'version_'.$uri}) {
6997: my $version=$bighash{'version_'.$uri};
6998: unless (($version eq 'mostrecent') ||
6999: ($version==&getversion($uri))) {
7000: $uri=~s/\.(\w+)$/\.$version\.$1/;
7001: }
7002: }
7003: untie %bighash;
7004: }
7005: return &do_cache_new('courseresversion',$key,&declutter($uri),600);
7006: }
7007:
7008: sub deversion {
7009: my $url=shift;
7010: $url=~s/\.\d+\.(\w+)$/\.$1/;
7011: return $url;
7012: }
7013:
7014: # ------------------------------------------------------ Return symb list entry
7015:
7016: sub symbread {
7017: my ($thisfn,$donotrecurse)=@_;
7018: my $cache_str='request.symbread.cached.'.$thisfn;
7019: if (defined($env{$cache_str})) { return $env{$cache_str}; }
7020: # no filename provided? try from environment
7021: unless ($thisfn) {
7022: if ($env{'request.symb'}) {
7023: return $env{$cache_str}=&symbclean($env{'request.symb'});
7024: }
7025: $thisfn=$env{'request.filename'};
7026: }
7027: if ($thisfn=~m|^/enc/|) { $thisfn=&Apache::lonenc::unencrypted($thisfn); }
7028: # is that filename actually a symb? Verify, clean, and return
7029: if ($thisfn=~/\_\_\_\d+\_\_\_(.*)$/) {
7030: if (&symbverify($thisfn,$1)) {
7031: return $env{$cache_str}=&symbclean($thisfn);
7032: }
7033: }
7034: $thisfn=declutter($thisfn);
7035: my %hash;
7036: my %bighash;
7037: my $syval='';
7038: if (($env{'request.course.fn'}) && ($thisfn)) {
7039: my $targetfn = $thisfn;
7040: if ( ($thisfn =~ m/^(uploaded|editupload)\//) && ($thisfn !~ m/\.(page|sequence)$/) ) {
7041: $targetfn = 'adm/wrapper/'.$thisfn;
7042: }
7043: if ($targetfn =~ m|^adm/wrapper/(ext/.*)|) {
7044: $targetfn=$1;
7045: }
7046: if (tie(%hash,'GDBM_File',$env{'request.course.fn'}.'_symb.db',
7047: &GDBM_READER(),0640)) {
7048: $syval=$hash{$targetfn};
7049: untie(%hash);
7050: }
7051: # ---------------------------------------------------------- There was an entry
7052: if ($syval) {
7053: #unless ($syval=~/\_\d+$/) {
7054: #unless ($env{'form.request.prefix'}=~/\.(\d+)\_$/) {
7055: #&appenv('request.ambiguous' => $thisfn);
7056: #return $env{$cache_str}='';
7057: #}
7058: #$syval.=$1;
7059: #}
7060: } else {
7061: # ------------------------------------------------------- Was not in symb table
7062: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
7063: &GDBM_READER(),0640)) {
7064: # ---------------------------------------------- Get ID(s) for current resource
7065: my $ids=$bighash{'ids_'.&clutter($thisfn)};
7066: unless ($ids) {
7067: $ids=$bighash{'ids_/'.$thisfn};
7068: }
7069: unless ($ids) {
7070: # alias?
7071: $ids=$bighash{'mapalias_'.$thisfn};
7072: }
7073: if ($ids) {
7074: # ------------------------------------------------------------------- Has ID(s)
7075: my @possibilities=split(/\,/,$ids);
7076: if ($#possibilities==0) {
7077: # ----------------------------------------------- There is only one possibility
7078: my ($mapid,$resid)=split(/\./,$ids);
7079: $syval=&encode_symb($bighash{'map_id_'.$mapid},
7080: $resid,$thisfn);
7081: } elsif (!$donotrecurse) {
7082: # ------------------------------------------ There is more than one possibility
7083: my $realpossible=0;
7084: foreach my $id (@possibilities) {
7085: my $file=$bighash{'src_'.$id};
7086: if (&allowed('bre',$file)) {
7087: my ($mapid,$resid)=split(/\./,$id);
7088: if ($bighash{'map_type_'.$mapid} ne 'page') {
7089: $realpossible++;
7090: $syval=&encode_symb($bighash{'map_id_'.$mapid},
7091: $resid,$thisfn);
7092: }
7093: }
7094: }
7095: if ($realpossible!=1) { $syval=''; }
7096: } else {
7097: $syval='';
7098: }
7099: }
7100: untie(%bighash)
7101: }
7102: }
7103: if ($syval) {
7104: return $env{$cache_str}=$syval;
7105: }
7106: }
7107: &appenv('request.ambiguous' => $thisfn);
7108: return $env{$cache_str}='';
7109: }
7110:
7111: # ---------------------------------------------------------- Return random seed
7112:
7113: sub numval {
7114: my $txt=shift;
7115: $txt=~tr/A-J/0-9/;
7116: $txt=~tr/a-j/0-9/;
7117: $txt=~tr/K-T/0-9/;
7118: $txt=~tr/k-t/0-9/;
7119: $txt=~tr/U-Z/0-5/;
7120: $txt=~tr/u-z/0-5/;
7121: $txt=~s/\D//g;
7122: if ($_64bit) { if ($txt > 2**32) { return -1; } }
7123: return int($txt);
7124: }
7125:
7126: sub numval2 {
7127: my $txt=shift;
7128: $txt=~tr/A-J/0-9/;
7129: $txt=~tr/a-j/0-9/;
7130: $txt=~tr/K-T/0-9/;
7131: $txt=~tr/k-t/0-9/;
7132: $txt=~tr/U-Z/0-5/;
7133: $txt=~tr/u-z/0-5/;
7134: $txt=~s/\D//g;
7135: my @txts=split(/(\d\d\d\d\d\d\d\d\d)/,$txt);
7136: my $total;
7137: foreach my $val (@txts) { $total+=$val; }
7138: if ($_64bit) { if ($total > 2**32) { return -1; } }
7139: return int($total);
7140: }
7141:
7142: sub numval3 {
7143: use integer;
7144: my $txt=shift;
7145: $txt=~tr/A-J/0-9/;
7146: $txt=~tr/a-j/0-9/;
7147: $txt=~tr/K-T/0-9/;
7148: $txt=~tr/k-t/0-9/;
7149: $txt=~tr/U-Z/0-5/;
7150: $txt=~tr/u-z/0-5/;
7151: $txt=~s/\D//g;
7152: my @txts=split(/(\d\d\d\d\d\d\d\d\d)/,$txt);
7153: my $total;
7154: foreach my $val (@txts) { $total+=$val; }
7155: if ($_64bit) { $total=(($total<<32)>>32); }
7156: return $total;
7157: }
7158:
7159: sub digest {
7160: my ($data)=@_;
7161: my $digest=&Digest::MD5::md5($data);
7162: my ($a,$b,$c,$d)=unpack("iiii",$digest);
7163: my ($e,$f);
7164: {
7165: use integer;
7166: $e=($a+$b);
7167: $f=($c+$d);
7168: if ($_64bit) {
7169: $e=(($e<<32)>>32);
7170: $f=(($f<<32)>>32);
7171: }
7172: }
7173: if (wantarray) {
7174: return ($e,$f);
7175: } else {
7176: my $g;
7177: {
7178: use integer;
7179: $g=($e+$f);
7180: if ($_64bit) {
7181: $g=(($g<<32)>>32);
7182: }
7183: }
7184: return $g;
7185: }
7186: }
7187:
7188: sub latest_rnd_algorithm_id {
7189: return '64bit5';
7190: }
7191:
7192: sub get_rand_alg {
7193: my ($courseid)=@_;
7194: if (!$courseid) { $courseid=(&whichuser())[1]; }
7195: if ($courseid) {
7196: return $env{"course.$courseid.rndseed"};
7197: }
7198: return &latest_rnd_algorithm_id();
7199: }
7200:
7201: sub validCODE {
7202: my ($CODE)=@_;
7203: if (defined($CODE) && $CODE ne '' && $CODE =~ /^\w+$/) { return 1; }
7204: return 0;
7205: }
7206:
7207: sub getCODE {
7208: if (&validCODE($env{'form.CODE'})) { return $env{'form.CODE'}; }
7209: if ( (defined($Apache::lonhomework::parsing_a_problem) ||
7210: defined($Apache::lonhomework::parsing_a_task) ) &&
7211: &validCODE($Apache::lonhomework::history{'resource.CODE'})) {
7212: return $Apache::lonhomework::history{'resource.CODE'};
7213: }
7214: return undef;
7215: }
7216:
7217: sub rndseed {
7218: my ($symb,$courseid,$domain,$username)=@_;
7219: my ($wsymb,$wcourseid,$wdomain,$wusername)=&whichuser();
7220: if (!defined($symb)) {
7221: unless ($symb=$wsymb) { return time; }
7222: }
7223: if (!$courseid) { $courseid=$wcourseid; }
7224: if (!$domain) { $domain=$wdomain; }
7225: if (!$username) { $username=$wusername }
7226: my $which=&get_rand_alg();
7227:
7228: if (defined(&getCODE())) {
7229: if ($which eq '64bit5') {
7230: return &rndseed_CODE_64bit5($symb,$courseid,$domain,$username);
7231: } elsif ($which eq '64bit4') {
7232: return &rndseed_CODE_64bit4($symb,$courseid,$domain,$username);
7233: } else {
7234: return &rndseed_CODE_64bit($symb,$courseid,$domain,$username);
7235: }
7236: } elsif ($which eq '64bit5') {
7237: return &rndseed_64bit5($symb,$courseid,$domain,$username);
7238: } elsif ($which eq '64bit4') {
7239: return &rndseed_64bit4($symb,$courseid,$domain,$username);
7240: } elsif ($which eq '64bit3') {
7241: return &rndseed_64bit3($symb,$courseid,$domain,$username);
7242: } elsif ($which eq '64bit2') {
7243: return &rndseed_64bit2($symb,$courseid,$domain,$username);
7244: } elsif ($which eq '64bit') {
7245: return &rndseed_64bit($symb,$courseid,$domain,$username);
7246: }
7247: return &rndseed_32bit($symb,$courseid,$domain,$username);
7248: }
7249:
7250: sub rndseed_32bit {
7251: my ($symb,$courseid,$domain,$username)=@_;
7252: {
7253: use integer;
7254: my $symbchck=unpack("%32C*",$symb) << 27;
7255: my $symbseed=numval($symb) << 22;
7256: my $namechck=unpack("%32C*",$username) << 17;
7257: my $nameseed=numval($username) << 12;
7258: my $domainseed=unpack("%32C*",$domain) << 7;
7259: my $courseseed=unpack("%32C*",$courseid);
7260: my $num=$symbseed+$nameseed+$domainseed+$courseseed+$namechck+$symbchck;
7261: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
7262: #&logthis("rndseed :$num:$symb");
7263: if ($_64bit) { $num=(($num<<32)>>32); }
7264: return $num;
7265: }
7266: }
7267:
7268: sub rndseed_64bit {
7269: my ($symb,$courseid,$domain,$username)=@_;
7270: {
7271: use integer;
7272: my $symbchck=unpack("%32S*",$symb) << 21;
7273: my $symbseed=numval($symb) << 10;
7274: my $namechck=unpack("%32S*",$username);
7275:
7276: my $nameseed=numval($username) << 21;
7277: my $domainseed=unpack("%32S*",$domain) << 10;
7278: my $courseseed=unpack("%32S*",$courseid);
7279:
7280: my $num1=$symbchck+$symbseed+$namechck;
7281: my $num2=$nameseed+$domainseed+$courseseed;
7282: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
7283: #&logthis("rndseed :$num:$symb");
7284: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
7285: return "$num1,$num2";
7286: }
7287: }
7288:
7289: sub rndseed_64bit2 {
7290: my ($symb,$courseid,$domain,$username)=@_;
7291: {
7292: use integer;
7293: # strings need to be an even # of cahracters long, it it is odd the
7294: # last characters gets thrown away
7295: my $symbchck=unpack("%32S*",$symb.' ') << 21;
7296: my $symbseed=numval($symb) << 10;
7297: my $namechck=unpack("%32S*",$username.' ');
7298:
7299: my $nameseed=numval($username) << 21;
7300: my $domainseed=unpack("%32S*",$domain.' ') << 10;
7301: my $courseseed=unpack("%32S*",$courseid.' ');
7302:
7303: my $num1=$symbchck+$symbseed+$namechck;
7304: my $num2=$nameseed+$domainseed+$courseseed;
7305: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
7306: #&logthis("rndseed :$num:$symb");
7307: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
7308: return "$num1,$num2";
7309: }
7310: }
7311:
7312: sub rndseed_64bit3 {
7313: my ($symb,$courseid,$domain,$username)=@_;
7314: {
7315: use integer;
7316: # strings need to be an even # of cahracters long, it it is odd the
7317: # last characters gets thrown away
7318: my $symbchck=unpack("%32S*",$symb.' ') << 21;
7319: my $symbseed=numval2($symb) << 10;
7320: my $namechck=unpack("%32S*",$username.' ');
7321:
7322: my $nameseed=numval2($username) << 21;
7323: my $domainseed=unpack("%32S*",$domain.' ') << 10;
7324: my $courseseed=unpack("%32S*",$courseid.' ');
7325:
7326: my $num1=$symbchck+$symbseed+$namechck;
7327: my $num2=$nameseed+$domainseed+$courseseed;
7328: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
7329: #&logthis("rndseed :$num1:$num2:$_64bit");
7330: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
7331:
7332: return "$num1:$num2";
7333: }
7334: }
7335:
7336: sub rndseed_64bit4 {
7337: my ($symb,$courseid,$domain,$username)=@_;
7338: {
7339: use integer;
7340: # strings need to be an even # of cahracters long, it it is odd the
7341: # last characters gets thrown away
7342: my $symbchck=unpack("%32S*",$symb.' ') << 21;
7343: my $symbseed=numval3($symb) << 10;
7344: my $namechck=unpack("%32S*",$username.' ');
7345:
7346: my $nameseed=numval3($username) << 21;
7347: my $domainseed=unpack("%32S*",$domain.' ') << 10;
7348: my $courseseed=unpack("%32S*",$courseid.' ');
7349:
7350: my $num1=$symbchck+$symbseed+$namechck;
7351: my $num2=$nameseed+$domainseed+$courseseed;
7352: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
7353: #&logthis("rndseed :$num1:$num2:$_64bit");
7354: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
7355:
7356: return "$num1:$num2";
7357: }
7358: }
7359:
7360: sub rndseed_64bit5 {
7361: my ($symb,$courseid,$domain,$username)=@_;
7362: my ($num1,$num2)=&digest("$symb,$courseid,$domain,$username");
7363: return "$num1:$num2";
7364: }
7365:
7366: sub rndseed_CODE_64bit {
7367: my ($symb,$courseid,$domain,$username)=@_;
7368: {
7369: use integer;
7370: my $symbchck=unpack("%32S*",$symb.' ') << 16;
7371: my $symbseed=numval2($symb);
7372: my $CODEchck=unpack("%32S*",&getCODE().' ') << 16;
7373: my $CODEseed=numval(&getCODE());
7374: my $courseseed=unpack("%32S*",$courseid.' ');
7375: my $num1=$symbseed+$CODEchck;
7376: my $num2=$CODEseed+$courseseed+$symbchck;
7377: #&logthis("$symbseed:$CODEchck|$CODEseed:$courseseed:$symbchck");
7378: #&logthis("rndseed :$num1:$num2:$symb");
7379: if ($_64bit) { $num1=(($num1<<32)>>32); }
7380: if ($_64bit) { $num2=(($num2<<32)>>32); }
7381: return "$num1:$num2";
7382: }
7383: }
7384:
7385: sub rndseed_CODE_64bit4 {
7386: my ($symb,$courseid,$domain,$username)=@_;
7387: {
7388: use integer;
7389: my $symbchck=unpack("%32S*",$symb.' ') << 16;
7390: my $symbseed=numval3($symb);
7391: my $CODEchck=unpack("%32S*",&getCODE().' ') << 16;
7392: my $CODEseed=numval3(&getCODE());
7393: my $courseseed=unpack("%32S*",$courseid.' ');
7394: my $num1=$symbseed+$CODEchck;
7395: my $num2=$CODEseed+$courseseed+$symbchck;
7396: #&logthis("$symbseed:$CODEchck|$CODEseed:$courseseed:$symbchck");
7397: #&logthis("rndseed :$num1:$num2:$symb");
7398: if ($_64bit) { $num1=(($num1<<32)>>32); }
7399: if ($_64bit) { $num2=(($num2<<32)>>32); }
7400: return "$num1:$num2";
7401: }
7402: }
7403:
7404: sub rndseed_CODE_64bit5 {
7405: my ($symb,$courseid,$domain,$username)=@_;
7406: my $code = &getCODE();
7407: my ($num1,$num2)=&digest("$symb,$courseid,$code");
7408: return "$num1:$num2";
7409: }
7410:
7411: sub setup_random_from_rndseed {
7412: my ($rndseed)=@_;
7413: if ($rndseed =~/([,:])/) {
7414: my ($num1,$num2)=split(/[,:]/,$rndseed);
7415: &Math::Random::random_set_seed(abs($num1),abs($num2));
7416: } else {
7417: &Math::Random::random_set_seed_from_phrase($rndseed);
7418: }
7419: }
7420:
7421: sub latest_receipt_algorithm_id {
7422: return 'receipt3';
7423: }
7424:
7425: sub recunique {
7426: my $fucourseid=shift;
7427: my $unique;
7428: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2' ||
7429: $env{"course.$fucourseid.receiptalg"} eq 'receipt3' ) {
7430: $unique=$env{"course.$fucourseid.internal.encseed"};
7431: } else {
7432: $unique=$perlvar{'lonReceipt'};
7433: }
7434: return unpack("%32C*",$unique);
7435: }
7436:
7437: sub recprefix {
7438: my $fucourseid=shift;
7439: my $prefix;
7440: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2'||
7441: $env{"course.$fucourseid.receiptalg"} eq 'receipt3' ) {
7442: $prefix=$env{"course.$fucourseid.internal.encpref"};
7443: } else {
7444: $prefix=$perlvar{'lonHostID'};
7445: }
7446: return unpack("%32C*",$prefix);
7447: }
7448:
7449: sub ireceipt {
7450: my ($funame,$fudom,$fucourseid,$fusymb,$part)=@_;
7451:
7452: my $return =&recprefix($fucourseid).'-';
7453:
7454: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt3' ||
7455: $env{'request.state'} eq 'construct') {
7456: $return .= (&digest("$funame,$fudom,$fucourseid,$fusymb,$part")%10000);
7457: return $return;
7458: }
7459:
7460: my $cuname=unpack("%32C*",$funame);
7461: my $cudom=unpack("%32C*",$fudom);
7462: my $cucourseid=unpack("%32C*",$fucourseid);
7463: my $cusymb=unpack("%32C*",$fusymb);
7464: my $cunique=&recunique($fucourseid);
7465: my $cpart=unpack("%32S*",$part);
7466: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2') {
7467:
7468: #&logthis("doing receipt2 using parts $cpart, uname $cuname and udom $cudom gets ".($cpart%$cuname)." and ".($cpart%$cudom));
7469:
7470: $return.= ($cunique%$cuname+
7471: $cunique%$cudom+
7472: $cusymb%$cuname+
7473: $cusymb%$cudom+
7474: $cucourseid%$cuname+
7475: $cucourseid%$cudom+
7476: $cpart%$cuname+
7477: $cpart%$cudom);
7478: } else {
7479: $return.= ($cunique%$cuname+
7480: $cunique%$cudom+
7481: $cusymb%$cuname+
7482: $cusymb%$cudom+
7483: $cucourseid%$cuname+
7484: $cucourseid%$cudom);
7485: }
7486: return $return;
7487: }
7488:
7489: sub receipt {
7490: my ($part)=@_;
7491: my ($symb,$courseid,$domain,$name) = &whichuser();
7492: return &ireceipt($name,$domain,$courseid,$symb,$part);
7493: }
7494:
7495: sub whichuser {
7496: my ($passedsymb)=@_;
7497: my ($symb,$courseid,$domain,$name,$publicuser);
7498: if (defined($env{'form.grade_symb'})) {
7499: my ($tmp_courseid)=&get_env_multiple('form.grade_courseid');
7500: my $allowed=&allowed('vgr',$tmp_courseid);
7501: if (!$allowed &&
7502: exists($env{'request.course.sec'}) &&
7503: $env{'request.course.sec'} !~ /^\s*$/) {
7504: $allowed=&allowed('vgr',$tmp_courseid.
7505: '/'.$env{'request.course.sec'});
7506: }
7507: if ($allowed) {
7508: ($symb)=&get_env_multiple('form.grade_symb');
7509: $courseid=$tmp_courseid;
7510: ($domain)=&get_env_multiple('form.grade_domain');
7511: ($name)=&get_env_multiple('form.grade_username');
7512: return ($symb,$courseid,$domain,$name,$publicuser);
7513: }
7514: }
7515: if (!$passedsymb) {
7516: $symb=&symbread();
7517: } else {
7518: $symb=$passedsymb;
7519: }
7520: $courseid=$env{'request.course.id'};
7521: $domain=$env{'user.domain'};
7522: $name=$env{'user.name'};
7523: if ($name eq 'public' && $domain eq 'public') {
7524: if (!defined($env{'form.username'})) {
7525: $env{'form.username'}.=time.rand(10000000);
7526: }
7527: $name.=$env{'form.username'};
7528: }
7529: return ($symb,$courseid,$domain,$name,$publicuser);
7530:
7531: }
7532:
7533: # ------------------------------------------------------------ Serves up a file
7534: # returns either the contents of the file or
7535: # -1 if the file doesn't exist
7536: #
7537: # if the target is a file that was uploaded via DOCS,
7538: # a check will be made to see if a current copy exists on the local server,
7539: # if it does this will be served, otherwise a copy will be retrieved from
7540: # the home server for the course and stored in /home/httpd/html/userfiles on
7541: # the local server.
7542:
7543: sub getfile {
7544: my ($file) = @_;
7545: if ($file =~ m -^/*(uploaded|editupload)/-) { $file=&filelocation("",$file); }
7546: &repcopy($file);
7547: return &readfile($file);
7548: }
7549:
7550: sub repcopy_userfile {
7551: my ($file)=@_;
7552: if ($file =~ m -^/*(uploaded|editupload)/-) { $file=&filelocation("",$file); }
7553: if ($file =~ m|^/home/httpd/html/lonUsers/|) { return 'ok'; }
7554: my ($cdom,$cnum,$filename) =
7555: ($file=~m|^\Q$perlvar{'lonDocRoot'}\E/+userfiles/+($match_domain)/+($match_name)/+(.*)|);
7556: my $uri="/uploaded/$cdom/$cnum/$filename";
7557: if (-e "$file") {
7558: # we already have a local copy, check it out
7559: my @fileinfo = stat($file);
7560: my $rtncode;
7561: my $info;
7562: my $lwpresp = &getuploaded('HEAD',$uri,$cdom,$cnum,\$info,\$rtncode);
7563: if ($lwpresp ne 'ok') {
7564: # there is no such file anymore, even though we had a local copy
7565: if ($rtncode eq '404') {
7566: unlink($file);
7567: }
7568: return -1;
7569: }
7570: if ($info < $fileinfo[9]) {
7571: # nice, the file we have is up-to-date, just say okay
7572: return 'ok';
7573: } else {
7574: # the file is outdated, get rid of it
7575: unlink($file);
7576: }
7577: }
7578: # one way or the other, at this point, we don't have the file
7579: # construct the correct path for the file
7580: my @parts = ($cdom,$cnum);
7581: if ($filename =~ m|^(.+)/[^/]+$|) {
7582: push @parts, split(/\//,$1);
7583: }
7584: my $path = $perlvar{'lonDocRoot'}.'/userfiles';
7585: foreach my $part (@parts) {
7586: $path .= '/'.$part;
7587: if (!-e $path) {
7588: mkdir($path,0770);
7589: }
7590: }
7591: # now the path exists for sure
7592: # get a user agent
7593: my $ua=new LWP::UserAgent;
7594: my $transferfile=$file.'.in.transfer';
7595: # FIXME: this should flock
7596: if (-e $transferfile) { return 'ok'; }
7597: my $request;
7598: $uri=~s/^\///;
7599: $request=new HTTP::Request('GET','http://'.&hostname(&homeserver($cnum,$cdom)).'/raw/'.$uri);
7600: my $response=$ua->request($request,$transferfile);
7601: # did it work?
7602: if ($response->is_error()) {
7603: unlink($transferfile);
7604: &logthis("Userfile repcopy failed for $uri");
7605: return -1;
7606: }
7607: # worked, rename the transfer file
7608: rename($transferfile,$file);
7609: return 'ok';
7610: }
7611:
7612: sub tokenwrapper {
7613: my $uri=shift;
7614: $uri=~s|^http\://([^/]+)||;
7615: $uri=~s|^/||;
7616: $env{'user.environment'}=~/\/([^\/]+)\.id/;
7617: my $token=$1;
7618: my (undef,$udom,$uname,$file)=split('/',$uri,4);
7619: if ($udom && $uname && $file) {
7620: $file=~s|(\?\.*)*$||;
7621: &appenv("userfile.$udom/$uname/$file" => $env{'request.course.id'});
7622: return 'http://'.&hostname(&homeserver($uname,$udom)).'/'.$uri.
7623: (($uri=~/\?/)?'&':'?').'token='.$token.
7624: '&tokenissued='.$perlvar{'lonHostID'};
7625: } else {
7626: return '/adm/notfound.html';
7627: }
7628: }
7629:
7630: # call with reqtype HEAD: get last modification time
7631: # call with reqtype GET: get the file contents
7632: # Do not call this with reqtype GET for large files! It loads everything into memory
7633: #
7634: sub getuploaded {
7635: my ($reqtype,$uri,$cdom,$cnum,$info,$rtncode) = @_;
7636: $uri=~s/^\///;
7637: $uri = 'http://'.&hostname(&homeserver($cnum,$cdom)).'/raw/'.$uri;
7638: my $ua=new LWP::UserAgent;
7639: my $request=new HTTP::Request($reqtype,$uri);
7640: my $response=$ua->request($request);
7641: $$rtncode = $response->code;
7642: if (! $response->is_success()) {
7643: return 'failed';
7644: }
7645: if ($reqtype eq 'HEAD') {
7646: $$info = &HTTP::Date::str2time( $response->header('Last-modified') );
7647: } elsif ($reqtype eq 'GET') {
7648: $$info = $response->content;
7649: }
7650: return 'ok';
7651: }
7652:
7653: sub readfile {
7654: my $file = shift;
7655: if ( (! -e $file ) || ($file eq '') ) { return -1; };
7656: my $fh;
7657: open($fh,"<$file");
7658: my $a='';
7659: while (my $line = <$fh>) { $a .= $line; }
7660: return $a;
7661: }
7662:
7663: sub filelocation {
7664: my ($dir,$file) = @_;
7665: my $location;
7666: $file=~ s/^\s*(\S+)\s*$/$1/; ## strip off leading and trailing spaces
7667:
7668: if ($file =~ m-^/adm/-) {
7669: $file=~s-^/adm/wrapper/-/-;
7670: $file=~s-^/adm/coursedocs/showdoc/-/-;
7671: }
7672:
7673: if ($file=~m:^/~:) { # is a contruction space reference
7674: $location = $file;
7675: $location =~ s:/~(.*?)/(.*):/home/$1/public_html/$2:;
7676: } elsif ($file=~m{^/home/$match_username/public_html/}) {
7677: # is a correct contruction space reference
7678: $location = $file;
7679: } elsif ($file=~/^\/*(uploaded|editupload)/) { # is an uploaded file
7680: my ($udom,$uname,$filename)=
7681: ($file=~m -^/+(?:uploaded|editupload)/+($match_domain)/+($match_name)/+(.*)$-);
7682: my $home=&homeserver($uname,$udom);
7683: my $is_me=0;
7684: my @ids=¤t_machine_ids();
7685: foreach my $id (@ids) { if ($id eq $home) { $is_me=1; } }
7686: if ($is_me) {
7687: $location=&propath($udom,$uname).
7688: '/userfiles/'.$filename;
7689: } else {
7690: $location=$Apache::lonnet::perlvar{'lonDocRoot'}.'/userfiles/'.
7691: $udom.'/'.$uname.'/'.$filename;
7692: }
7693: } elsif ($file =~ m-^/adm/-) {
7694: $location = $perlvar{'lonDocRoot'}.'/'.$file;
7695: } else {
7696: $file=~s/^\Q$perlvar{'lonDocRoot'}\E//;
7697: $file=~s:^/res/:/:;
7698: if ( !( $file =~ m:^/:) ) {
7699: $location = $dir. '/'.$file;
7700: } else {
7701: $location = '/home/httpd/html/res'.$file;
7702: }
7703: }
7704: $location=~s://+:/:g; # remove duplicate /
7705: while ($location=~m:/\.\./:) {$location=~ s:/[^/]+/\.\./:/:g;} #remove dir/..
7706: while ($location=~m:/\./:) {$location=~ s:/\./:/:g;} #remove /./
7707: return $location;
7708: }
7709:
7710: sub hreflocation {
7711: my ($dir,$file)=@_;
7712: unless (($file=~m-^http://-i) || ($file=~m-^/-)) {
7713: $file=filelocation($dir,$file);
7714: } elsif ($file=~m-^/adm/-) {
7715: $file=~s-^/adm/wrapper/-/-;
7716: $file=~s-^/adm/coursedocs/showdoc/-/-;
7717: }
7718: if ($file=~m-^\Q$perlvar{'lonDocRoot'}\E-) {
7719: $file=~s-^\Q$perlvar{'lonDocRoot'}\E--;
7720: } elsif ($file=~m-/home/($match_username)/public_html/-) {
7721: $file=~s-^/home/($match_username)/public_html/-/~$1/-;
7722: } elsif ($file=~m-^\Q$perlvar{'lonUsersDir'}\E-) {
7723: $file=~s-^/home/httpd/lonUsers/($match_domain)/./././($match_name)/userfiles/
7724: -/uploaded/$1/$2/-x;
7725: }
7726: return $file;
7727: }
7728:
7729: sub current_machine_domains {
7730: return &machine_domains(&hostname($perlvar{'lonHostID'}));
7731: }
7732:
7733: sub machine_domains {
7734: my ($hostname) = @_;
7735: my @domains;
7736: my %hostname = &all_hostnames();
7737: while( my($id, $name) = each(%hostname)) {
7738: # &logthis("-$id-$name-$hostname-");
7739: if ($hostname eq $name) {
7740: push(@domains,&host_domain($id));
7741: }
7742: }
7743: return @domains;
7744: }
7745:
7746: sub current_machine_ids {
7747: return &machine_ids(&hostname($perlvar{'lonHostID'}));
7748: }
7749:
7750: sub machine_ids {
7751: my ($hostname) = @_;
7752: $hostname ||= &hostname($perlvar{'lonHostID'});
7753: my @ids;
7754: my %name_to_host = &all_names();
7755: if (ref($name_to_host{$hostname}) eq 'ARRAY') {
7756: return @{ $name_to_host{$hostname} };
7757: }
7758: return;
7759: }
7760:
7761: sub additional_machine_domains {
7762: my @domains;
7763: open(my $fh,"<$perlvar{'lonTabDir'}/expected_domains.tab");
7764: while( my $line = <$fh>) {
7765: $line =~ s/\s//g;
7766: push(@domains,$line);
7767: }
7768: return @domains;
7769: }
7770:
7771: sub default_login_domain {
7772: my $domain = $perlvar{'lonDefDomain'};
7773: my $testdomain=(split(/\./,$ENV{'HTTP_HOST'}))[0];
7774: foreach my $posdom (¤t_machine_domains(),
7775: &additional_machine_domains()) {
7776: if (lc($posdom) eq lc($testdomain)) {
7777: $domain=$posdom;
7778: last;
7779: }
7780: }
7781: return $domain;
7782: }
7783:
7784: # ------------------------------------------------------------- Declutters URLs
7785:
7786: sub declutter {
7787: my $thisfn=shift;
7788: if ($thisfn=~m|^/enc/|) { $thisfn=&Apache::lonenc::unencrypted($thisfn); }
7789: $thisfn=~s/^\Q$perlvar{'lonDocRoot'}\E//;
7790: $thisfn=~s/^\///;
7791: $thisfn=~s|^adm/wrapper/||;
7792: $thisfn=~s|^adm/coursedocs/showdoc/||;
7793: $thisfn=~s/^res\///;
7794: $thisfn=~s/\?.+$//;
7795: return $thisfn;
7796: }
7797:
7798: # ------------------------------------------------------------- Clutter up URLs
7799:
7800: sub clutter {
7801: my $thisfn='/'.&declutter(shift);
7802: if ($thisfn !~ m{^/(uploaded|editupload|adm|userfiles|ext|raw|priv|public)/}
7803: || $thisfn =~ m{^/adm/(includes|pages)} ) {
7804: $thisfn='/res'.$thisfn;
7805: }
7806: if ($thisfn !~m|/adm|) {
7807: if ($thisfn =~ m|/ext/|) {
7808: $thisfn='/adm/wrapper'.$thisfn;
7809: } else {
7810: my ($ext) = ($thisfn =~ /\.(\w+)$/);
7811: my $embstyle=&Apache::loncommon::fileembstyle($ext);
7812: if ($embstyle eq 'ssi'
7813: || ($embstyle eq 'hdn')
7814: || ($embstyle eq 'rat')
7815: || ($embstyle eq 'prv')
7816: || ($embstyle eq 'ign')) {
7817: #do nothing with these
7818: } elsif (($embstyle eq 'img')
7819: || ($embstyle eq 'emb')
7820: || ($embstyle eq 'wrp')) {
7821: $thisfn='/adm/wrapper'.$thisfn;
7822: } elsif ($embstyle eq 'unk'
7823: && $thisfn!~/\.(sequence|page)$/) {
7824: $thisfn='/adm/coursedocs/showdoc'.$thisfn;
7825: } else {
7826: # &logthis("Got a blank emb style");
7827: }
7828: }
7829: }
7830: return $thisfn;
7831: }
7832:
7833: sub clutter_with_no_wrapper {
7834: my $uri = &clutter(shift);
7835: if ($uri =~ m-^/adm/-) {
7836: $uri =~ s-^/adm/wrapper/-/-;
7837: $uri =~ s-^/adm/coursedocs/showdoc/-/-;
7838: }
7839: return $uri;
7840: }
7841:
7842: sub freeze_escape {
7843: my ($value)=@_;
7844: if (ref($value)) {
7845: $value=&nfreeze($value);
7846: return '__FROZEN__'.&escape($value);
7847: }
7848: return &escape($value);
7849: }
7850:
7851:
7852: sub thaw_unescape {
7853: my ($value)=@_;
7854: if ($value =~ /^__FROZEN__/) {
7855: substr($value,0,10,undef);
7856: $value=&unescape($value);
7857: return &thaw($value);
7858: }
7859: return &unescape($value);
7860: }
7861:
7862: sub correct_line_ends {
7863: my ($result)=@_;
7864: $$result =~s/\r\n/\n/mg;
7865: $$result =~s/\r/\n/mg;
7866: }
7867: # ================================================================ Main Program
7868:
7869: sub goodbye {
7870: &logthis("Starting Shut down");
7871: #not converted to using infrastruture and probably shouldn't be
7872: &logthis(sprintf("%-20s is %s",'%badServerCache',length(&nfreeze(\%badServerCache))));
7873: #converted
7874: # &logthis(sprintf("%-20s is %s",'%metacache',scalar(%metacache)));
7875: &logthis(sprintf("%-20s is %s",'%homecache',length(&nfreeze(\%homecache))));
7876: # &logthis(sprintf("%-20s is %s",'%titlecache',length(&nfreeze(\%titlecache))));
7877: # &logthis(sprintf("%-20s is %s",'%courseresdatacache',length(&nfreeze(\%courseresdatacache))));
7878: #1.1 only
7879: # &logthis(sprintf("%-20s is %s",'%userresdatacache',length(&nfreeze(\%userresdatacache))));
7880: # &logthis(sprintf("%-20s is %s",'%getsectioncache',length(&nfreeze(\%getsectioncache))));
7881: # &logthis(sprintf("%-20s is %s",'%courseresversioncache',length(&nfreeze(\%courseresversioncache))));
7882: # &logthis(sprintf("%-20s is %s",'%resversioncache',length(&nfreeze(\%resversioncache))));
7883: &logthis(sprintf("%-20s is %s",'%remembered',length(&nfreeze(\%remembered))));
7884: &logthis(sprintf("%-20s is %s",'kicks',$kicks));
7885: &logthis(sprintf("%-20s is %s",'hits',$hits));
7886: &flushcourselogs();
7887: &logthis("Shutting down");
7888: }
7889:
7890: sub get_dns {
7891: my ($url,$func,$ignore_cache) = @_;
7892: if (!$ignore_cache) {
7893: my ($content,$cached)=
7894: &Apache::lonnet::is_cached_new('dns',$url);
7895: if ($cached) {
7896: &$func($content);
7897: return;
7898: }
7899: }
7900:
7901: my %alldns;
7902: open(my $config,"<$perlvar{'lonTabDir'}/hosts.tab");
7903: foreach my $dns (<$config>) {
7904: next if ($dns !~ /^\^(\S*)/x);
7905: $alldns{$1} = 1;
7906: }
7907: while (%alldns) {
7908: my ($dns) = keys(%alldns);
7909: delete($alldns{$dns});
7910: my $ua=new LWP::UserAgent;
7911: my $request=new HTTP::Request('GET',"http://$dns$url");
7912: my $response=$ua->request($request);
7913: next if ($response->is_error());
7914: my @content = split("\n",$response->content);
7915: &Apache::lonnet::do_cache_new('dns',$url,\@content,30*24*60*60);
7916: &$func(\@content);
7917: return;
7918: }
7919: close($config);
7920: my $which = (split('/',$url))[3];
7921: &logthis("unable to contact DNS defaulting to on disk file dns_$which.tab\n");
7922: open($config,"<$perlvar{'lonTabDir'}/dns_$which.tab");
7923: my @content = <$config>;
7924: &$func(\@content);
7925: return;
7926: }
7927: # ------------------------------------------------------------ Read domain file
7928: {
7929: my $loaded;
7930: my %domain;
7931:
7932: sub parse_domain_tab {
7933: my ($lines) = @_;
7934: foreach my $line (@$lines) {
7935: next if ($line =~ /^(\#|\s*$ )/x);
7936:
7937: chomp($line);
7938: my ($name,@elements) = split(/:/,$line,9);
7939: my %this_domain;
7940: foreach my $field ('description', 'auth_def', 'auth_arg_def',
7941: 'lang_def', 'city', 'longi', 'lati',
7942: 'primary') {
7943: $this_domain{$field} = shift(@elements);
7944: }
7945: $domain{$name} = \%this_domain;
7946: }
7947: }
7948:
7949: sub reset_domain_info {
7950: undef($loaded);
7951: undef(%domain);
7952: }
7953:
7954: sub load_domain_tab {
7955: my ($ignore_cache) = @_;
7956: &get_dns('/adm/dns/domain',\&parse_domain_tab,$ignore_cache);
7957: my $fh;
7958: if (open($fh,"<".$perlvar{'lonTabDir'}.'/domain.tab')) {
7959: my @lines = <$fh>;
7960: &parse_domain_tab(\@lines);
7961: }
7962: close($fh);
7963: $loaded = 1;
7964: }
7965:
7966: sub domain {
7967: &load_domain_tab() if (!$loaded);
7968:
7969: my ($name,$what) = @_;
7970: return if ( !exists($domain{$name}) );
7971:
7972: if (!$what) {
7973: return $domain{$name}{'description'};
7974: }
7975: return $domain{$name}{$what};
7976: }
7977: }
7978:
7979:
7980: # ------------------------------------------------------------- Read hosts file
7981: {
7982: my %hostname;
7983: my %hostdom;
7984: my %libserv;
7985: my $loaded;
7986: my %name_to_host;
7987:
7988: sub parse_hosts_tab {
7989: my ($file) = @_;
7990: foreach my $configline (@$file) {
7991: next if ($configline =~ /^(\#|\s*$ )/x);
7992: next if ($configline =~ /^\^/);
7993: chomp($configline);
7994: my ($id,$domain,$role,$name)=split(/:/,$configline);
7995: $name=~s/\s//g;
7996: if ($id && $domain && $role && $name) {
7997: $hostname{$id}=$name;
7998: push(@{$name_to_host{$name}}, $id);
7999: $hostdom{$id}=$domain;
8000: if ($role eq 'library') { $libserv{$id}=$name; }
8001: }
8002: }
8003: }
8004:
8005: sub reset_hosts_info {
8006: &purge_remembered();
8007: &reset_domain_info();
8008: &reset_hosts_ip_info();
8009: undef(%name_to_host);
8010: undef(%hostname);
8011: undef(%hostdom);
8012: undef(%libserv);
8013: undef($loaded);
8014: }
8015:
8016: sub load_hosts_tab {
8017: my ($ignore_cache) = @_;
8018: &get_dns('/adm/dns/hosts',\&parse_hosts_tab,$ignore_cache);
8019: open(my $config,"<$perlvar{'lonTabDir'}/hosts.tab");
8020: my @config = <$config>;
8021: &parse_hosts_tab(\@config);
8022: close($config);
8023: $loaded=1;
8024: }
8025:
8026: sub hostname {
8027: &load_hosts_tab() if (!$loaded);
8028:
8029: my ($lonid) = @_;
8030: return $hostname{$lonid};
8031: }
8032:
8033: sub all_hostnames {
8034: &load_hosts_tab() if (!$loaded);
8035:
8036: return %hostname;
8037: }
8038:
8039: sub all_names {
8040: &load_hosts_tab() if (!$loaded);
8041:
8042: return %name_to_host;
8043: }
8044:
8045: sub is_library {
8046: &load_hosts_tab() if (!$loaded);
8047:
8048: return exists($libserv{$_[0]});
8049: }
8050:
8051: sub all_library {
8052: &load_hosts_tab() if (!$loaded);
8053:
8054: return %libserv;
8055: }
8056:
8057: sub get_servers {
8058: &load_hosts_tab() if (!$loaded);
8059:
8060: my ($domain,$type) = @_;
8061: my %possible_hosts = ($type eq 'library') ? %libserv
8062: : %hostname;
8063: my %result;
8064: if (ref($domain) eq 'ARRAY') {
8065: while ( my ($host,$hostname) = each(%possible_hosts)) {
8066: if (grep(/^\Q$hostdom{$host}\E$/,@$domain)) {
8067: $result{$host} = $hostname;
8068: }
8069: }
8070: } else {
8071: while ( my ($host,$hostname) = each(%possible_hosts)) {
8072: if ($hostdom{$host} eq $domain) {
8073: $result{$host} = $hostname;
8074: }
8075: }
8076: }
8077: return %result;
8078: }
8079:
8080: sub host_domain {
8081: &load_hosts_tab() if (!$loaded);
8082:
8083: my ($lonid) = @_;
8084: return $hostdom{$lonid};
8085: }
8086:
8087: sub all_domains {
8088: &load_hosts_tab() if (!$loaded);
8089:
8090: my %seen;
8091: my @uniq = grep(!$seen{$_}++, values(%hostdom));
8092: return @uniq;
8093: }
8094: }
8095:
8096: {
8097: my %iphost;
8098: my %name_to_ip;
8099: my %lonid_to_ip;
8100:
8101: sub get_hosts_from_ip {
8102: my ($ip) = @_;
8103: my %iphosts = &get_iphost();
8104: if (ref($iphosts{$ip})) {
8105: return @{$iphosts{$ip}};
8106: }
8107: return;
8108: }
8109:
8110: sub reset_hosts_ip_info {
8111: undef(%iphost);
8112: undef(%name_to_ip);
8113: undef(%lonid_to_ip);
8114: }
8115:
8116: sub get_host_ip {
8117: my ($lonid) = @_;
8118: if (exists($lonid_to_ip{$lonid})) {
8119: return $lonid_to_ip{$lonid};
8120: }
8121: my $name=&hostname($lonid);
8122: my $ip = gethostbyname($name);
8123: return if (!$ip || length($ip) ne 4);
8124: $ip=inet_ntoa($ip);
8125: $name_to_ip{$name} = $ip;
8126: $lonid_to_ip{$lonid} = $ip;
8127: return $ip;
8128: }
8129:
8130: sub get_iphost {
8131: my ($ignore_cache) = @_;
8132:
8133: if (!$ignore_cache) {
8134: if (%iphost) {
8135: return %iphost;
8136: }
8137: my ($ip_info,$cached)=
8138: &Apache::lonnet::is_cached_new('iphost','iphost');
8139: if ($cached) {
8140: %iphost = %{$ip_info->[0]};
8141: %name_to_ip = %{$ip_info->[1]};
8142: %lonid_to_ip = %{$ip_info->[2]};
8143: return %iphost;
8144: }
8145: }
8146:
8147: # get yesterday's info for fallback
8148: my %old_name_to_ip;
8149: my ($ip_info,$cached)=
8150: &Apache::lonnet::is_cached_new('iphost','iphost');
8151: if ($cached) {
8152: %old_name_to_ip = %{$ip_info->[1]};
8153: }
8154:
8155: my %name_to_host = &all_names();
8156: foreach my $name (keys(%name_to_host)) {
8157: my $ip;
8158: if (!exists($name_to_ip{$name})) {
8159: $ip = gethostbyname($name);
8160: if (!$ip || length($ip) ne 4) {
8161: if (defined($old_name_to_ip{$name})) {
8162: $ip = $old_name_to_ip{$name};
8163: &logthis("Can't find $name defaulting to old $ip");
8164: } else {
8165: &logthis("Name $name no IP found");
8166: next;
8167: }
8168: } else {
8169: $ip=inet_ntoa($ip);
8170: }
8171: $name_to_ip{$name} = $ip;
8172: } else {
8173: $ip = $name_to_ip{$name};
8174: }
8175: foreach my $id (@{ $name_to_host{$name} }) {
8176: $lonid_to_ip{$id} = $ip;
8177: }
8178: push(@{$iphost{$ip}},@{$name_to_host{$name}});
8179: }
8180: &Apache::lonnet::do_cache_new('iphost','iphost',
8181: [\%iphost,\%name_to_ip,\%lonid_to_ip],
8182: 48*60*60);
8183:
8184: return %iphost;
8185: }
8186: }
8187:
8188: BEGIN {
8189:
8190: # ----------------------------------- Read loncapa.conf and loncapa_apache.conf
8191: unless ($readit) {
8192: {
8193: my $configvars = LONCAPA::Configuration::read_conf('loncapa.conf');
8194: %perlvar = (%perlvar,%{$configvars});
8195: }
8196:
8197:
8198: # ------------------------------------------------------ Read spare server file
8199: {
8200: open(my $config,"<$perlvar{'lonTabDir'}/spare.tab");
8201:
8202: while (my $configline=<$config>) {
8203: chomp($configline);
8204: if ($configline) {
8205: my ($host,$type) = split(':',$configline,2);
8206: if (!defined($type) || $type eq '') { $type = 'default' };
8207: push(@{ $spareid{$type} }, $host);
8208: }
8209: }
8210: close($config);
8211: }
8212: # ------------------------------------------------------------ Read permissions
8213: {
8214: open(my $config,"<$perlvar{'lonTabDir'}/roles.tab");
8215:
8216: while (my $configline=<$config>) {
8217: chomp($configline);
8218: if ($configline) {
8219: my ($role,$perm)=split(/ /,$configline);
8220: if ($perm ne '') { $pr{$role}=$perm; }
8221: }
8222: }
8223: close($config);
8224: }
8225:
8226: # -------------------------------------------- Read plain texts for permissions
8227: {
8228: open(my $config,"<$perlvar{'lonTabDir'}/rolesplain.tab");
8229:
8230: while (my $configline=<$config>) {
8231: chomp($configline);
8232: if ($configline) {
8233: my ($short,@plain)=split(/:/,$configline);
8234: %{$prp{$short}} = ();
8235: if (@plain > 0) {
8236: $prp{$short}{'std'} = $plain[0];
8237: for (my $i=1; $i<@plain; $i++) {
8238: $prp{$short}{'alt'.$i} = $plain[$i];
8239: }
8240: }
8241: }
8242: }
8243: close($config);
8244: }
8245:
8246: # ---------------------------------------------------------- Read package table
8247: {
8248: open(my $config,"<$perlvar{'lonTabDir'}/packages.tab");
8249:
8250: while (my $configline=<$config>) {
8251: if ($configline !~ /\S/ || $configline=~/^#/) { next; }
8252: chomp($configline);
8253: my ($short,$plain)=split(/:/,$configline);
8254: my ($pack,$name)=split(/\&/,$short);
8255: if ($plain ne '') {
8256: $packagetab{$pack.'&'.$name.'&name'}=$name;
8257: $packagetab{$short}=$plain;
8258: }
8259: }
8260: close($config);
8261: }
8262:
8263: # ------------- set up temporary directory
8264: {
8265: $tmpdir = $perlvar{'lonDaemons'}.'/tmp/';
8266:
8267: }
8268:
8269: $memcache=new Cache::Memcached({'servers' => ['127.0.0.1:11211'],
8270: 'compress_threshold'=> 20_000,
8271: });
8272:
8273: $processmarker='_'.time.'_'.$perlvar{'lonHostID'};
8274: $dumpcount=0;
8275:
8276: &logtouch();
8277: &logthis('<font color="yellow">INFO: Read configuration</font>');
8278: $readit=1;
8279: {
8280: use integer;
8281: my $test=(2**32)+1;
8282: if ($test != 0) { $_64bit=1; } else { $_64bit=0; }
8283: &logthis(" Detected 64bit platform ($_64bit)");
8284: }
8285: }
8286: }
8287:
8288: 1;
8289: __END__
8290:
8291: =pod
8292:
8293: =head1 NAME
8294:
8295: Apache::lonnet - Subroutines to ask questions about things in the network.
8296:
8297: =head1 SYNOPSIS
8298:
8299: Invoked by other LON-CAPA modules, when they need to talk to or about objects in the network.
8300:
8301: &Apache::lonnet::SUBROUTINENAME(ARGUMENTS);
8302:
8303: Common parameters:
8304:
8305: =over 4
8306:
8307: =item *
8308:
8309: $uname : an internal username (if $cname expecting a course Id specifically)
8310:
8311: =item *
8312:
8313: $udom : a domain (if $cdom expecting a course's domain specifically)
8314:
8315: =item *
8316:
8317: $symb : a resource instance identifier
8318:
8319: =item *
8320:
8321: $namespace : the name of a .db file that contains the data needed or
8322: being set.
8323:
8324: =back
8325:
8326: =head1 OVERVIEW
8327:
8328: lonnet provides subroutines which interact with the
8329: lonc/lond (TCP) network layer of LON-CAPA. They can be used to ask
8330: about classes, users, and resources.
8331:
8332: For many of these objects you can also use this to store data about
8333: them or modify them in various ways.
8334:
8335: =head2 Symbs
8336:
8337: To identify a specific instance of a resource, LON-CAPA uses symbols
8338: or "symbs"X<symb>. These identifiers are built from the URL of the
8339: map, the resource number of the resource in the map, and the URL of
8340: the resource itself. The latter is somewhat redundant, but might help
8341: if maps change.
8342:
8343: An example is
8344:
8345: msu/korte/parts/part1.sequence___19___msu/korte/tests/part12.problem
8346:
8347: The respective map entry is
8348:
8349: <resource id="19" src="/res/msu/korte/tests/part12.problem"
8350: title="Problem 2">
8351: </resource>
8352:
8353: Symbs are used by the random number generator, as well as to store and
8354: restore data specific to a certain instance of for example a problem.
8355:
8356: =head2 Storing And Retrieving Data
8357:
8358: X<store()>X<cstore()>X<restore()>Three of the most important functions
8359: in C<lonnet.pm> are C<&Apache::lonnet::cstore()>,
8360: C<&Apache::lonnet:restore()>, and C<&Apache::lonnet::store()>, which
8361: is is the non-critical message twin of cstore. These functions are for
8362: handlers to store a perl hash to a user's permanent data space in an
8363: easy manner, and to retrieve it again on another call. It is expected
8364: that a handler would use this once at the beginning to retrieve data,
8365: and then again once at the end to send only the new data back.
8366:
8367: The data is stored in the user's data directory on the user's
8368: homeserver under the ID of the course.
8369:
8370: The hash that is returned by restore will have all of the previous
8371: value for all of the elements of the hash.
8372:
8373: Example:
8374:
8375: #creating a hash
8376: my %hash;
8377: $hash{'foo'}='bar';
8378:
8379: #storing it
8380: &Apache::lonnet::cstore(\%hash);
8381:
8382: #changing a value
8383: $hash{'foo'}='notbar';
8384:
8385: #adding a new value
8386: $hash{'bar'}='foo';
8387: &Apache::lonnet::cstore(\%hash);
8388:
8389: #retrieving the hash
8390: my %history=&Apache::lonnet::restore();
8391:
8392: #print the hash
8393: foreach my $key (sort(keys(%history))) {
8394: print("\%history{$key} = $history{$key}");
8395: }
8396:
8397: Will print out:
8398:
8399: %history{1:foo} = bar
8400: %history{1:keys} = foo:timestamp
8401: %history{1:timestamp} = 990455579
8402: %history{2:bar} = foo
8403: %history{2:foo} = notbar
8404: %history{2:keys} = foo:bar:timestamp
8405: %history{2:timestamp} = 990455580
8406: %history{bar} = foo
8407: %history{foo} = notbar
8408: %history{timestamp} = 990455580
8409: %history{version} = 2
8410:
8411: Note that the special hash entries C<keys>, C<version> and
8412: C<timestamp> were added to the hash. C<version> will be equal to the
8413: total number of versions of the data that have been stored. The
8414: C<timestamp> attribute will be the UNIX time the hash was
8415: stored. C<keys> is available in every historical section to list which
8416: keys were added or changed at a specific historical revision of a
8417: hash.
8418:
8419: B<Warning>: do not store the hash that restore returns directly. This
8420: will cause a mess since it will restore the historical keys as if the
8421: were new keys. I.E. 1:foo will become 1:1:foo etc.
8422:
8423: Calling convention:
8424:
8425: my %record=&Apache::lonnet::restore($symb,$courseid,$domain,$uname,$home);
8426: &Apache::lonnet::cstore(\%newrecord,$symb,$courseid,$domain,$uname,$home);
8427:
8428: For more detailed information, see lonnet specific documentation.
8429:
8430: =head1 RETURN MESSAGES
8431:
8432: =over 4
8433:
8434: =item * B<con_lost>: unable to contact remote host
8435:
8436: =item * B<con_delayed>: unable to contact remote host, message will be delivered
8437: when the connection is brought back up
8438:
8439: =item * B<con_failed>: unable to contact remote host and unable to save message
8440: for later delivery
8441:
8442: =item * B<error:>: an error a occured, a description of the error follows the :
8443:
8444: =item * B<no_such_host>: unable to fund a host associated with the user/domain
8445: that was requested
8446:
8447: =back
8448:
8449: =head1 PUBLIC SUBROUTINES
8450:
8451: =head2 Session Environment Functions
8452:
8453: =over 4
8454:
8455: =item *
8456: X<appenv()>
8457: B<appenv(%hash)>: the value of %hash is written to
8458: the user envirnoment file, and will be restored for each access this
8459: user makes during this session, also modifies the %env for the current
8460: process
8461:
8462: =item *
8463: X<delenv()>
8464: B<delenv($regexp)>: removes all items from the session
8465: environment file that matches the regular expression in $regexp. The
8466: values are also delted from the current processes %env.
8467:
8468: =item * get_env_multiple($name)
8469:
8470: gets $name from the %env hash, it seemlessly handles the cases where multiple
8471: values may be defined and end up as an array ref.
8472:
8473: returns an array of values
8474:
8475: =back
8476:
8477: =head2 User Information
8478:
8479: =over 4
8480:
8481: =item *
8482: X<queryauthenticate()>
8483: B<queryauthenticate($uname,$udom)>: try to determine user's current
8484: authentication scheme
8485:
8486: =item *
8487: X<authenticate()>
8488: B<authenticate($uname,$upass,$udom)>: try to
8489: authenticate user from domain's lib servers (first use the current
8490: one). C<$upass> should be the users password.
8491:
8492: =item *
8493: X<homeserver()>
8494: B<homeserver($uname,$udom)>: find the server which has
8495: the user's directory and files (there must be only one), this caches
8496: the answer, and also caches if there is a borken connection.
8497:
8498: =item *
8499: X<idget()>
8500: B<idget($udom,@ids)>: find the usernames behind a list of IDs
8501: (IDs are a unique resource in a domain, there must be only 1 ID per
8502: username, and only 1 username per ID in a specific domain) (returns
8503: hash: id=>name,id=>name)
8504:
8505: =item *
8506: X<idrget()>
8507: B<idrget($udom,@unames)>: find the IDs behind a list of
8508: usernames (returns hash: name=>id,name=>id)
8509:
8510: =item *
8511: X<idput()>
8512: B<idput($udom,%ids)>: store away a list of names and associated IDs
8513:
8514: =item *
8515: X<rolesinit()>
8516: B<rolesinit($udom,$username,$authhost)>: get user privileges
8517:
8518: =item *
8519: X<getsection()>
8520: B<getsection($udom,$uname,$cname)>: finds the section of student in the
8521: course $cname, return section name/number or '' for "not in course"
8522: and '-1' for "no section"
8523:
8524: =item *
8525: X<userenvironment()>
8526: B<userenvironment($udom,$uname,@what)>: gets the values of the keys
8527: passed in @what from the requested user's environment, returns a hash
8528:
8529: =item *
8530: X<userlog_query()>
8531: B<userlog_query($uname,$udom,%filters)>: retrieves data from a user's
8532: activity.log file. %filters defines filters applied when parsing the
8533: log file. These can be start or end timestamps, or the type of action
8534: - log to look for Login or Logout events, check for Checkin or
8535: Checkout, role for role selection. The response is in the form
8536: timestamp1:hostid1:event1×tamp2:hostid2:event2 where events are
8537: escaped strings of the action recorded in the activity.log file.
8538:
8539: =back
8540:
8541: =head2 User Roles
8542:
8543: =over 4
8544:
8545: =item *
8546:
8547: allowed($priv,$uri,$symb,$role) : check for a user privilege; returns codes for allowed actions
8548: F: full access
8549: U,I,K: authentication modes (cxx only)
8550: '': forbidden
8551: 1: user needs to choose course
8552: 2: browse allowed
8553: A: passphrase authentication needed
8554:
8555: =item *
8556:
8557: definerole($rolename,$sysrole,$domrole,$courole) : define role; define a custom
8558: role rolename set privileges in format of lonTabs/roles.tab for system, domain,
8559: and course level
8560:
8561: =item *
8562:
8563: plaintext($short) : return value in %prp hash (rolesplain.tab); plain text
8564: explanation of a user role term
8565:
8566: =item *
8567:
8568: get_my_roles($uname,$udom,$context,$types,$roles,$roledoms) :
8569: All arguments are optional. Returns a hash of a roles, either for
8570: co-author/assistant author roles for a user's Construction Space
8571: (default), or if $context is 'userroles', roles for the user himself,
8572: In the hash, keys are set to colon-sparated $uname,$udom,and $role,
8573: and value is set to colon-separated start and end times for the role.
8574: If no username and domain are specified, will default to current
8575: user/domain. Types, roles, and roledoms are references to arrays,
8576: of role statuses (active, future or previous), roles
8577: (e.g., cc,in, st etc.) and domains of the roles which can be used
8578: to restrict the list of roles reported. If no array ref is
8579: provided for types, will default to return only active roles.
8580:
8581: =back
8582:
8583: =head2 User Modification
8584:
8585: =over 4
8586:
8587: =item *
8588:
8589: assignrole($udom,$uname,$url,$role,$end,$start) : assign role; give a role to a
8590: user for the level given by URL. Optional start and end dates (leave empty
8591: string or zero for "no date")
8592:
8593: =item *
8594:
8595: changepass($uname,$udom,$currentpass,$newpass,$server) : attempts to
8596: change a users, password, possible return values are: ok,
8597: pwchange_failure, non_authorized, auth_mode_error, unknown_user,
8598: refused
8599:
8600: =item *
8601:
8602: modifyuserauth($udom,$uname,$umode,$upass) : modify user authentication
8603:
8604: =item *
8605:
8606: modifyuser($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene) :
8607: modify user
8608:
8609: =item *
8610:
8611: modifystudent
8612:
8613: modify a students enrollment and identification information.
8614: The course id is resolved based on the current users environment.
8615: This means the envoking user must be a course coordinator or otherwise
8616: associated with a course.
8617:
8618: This call is essentially a wrapper for lonnet::modifyuser and
8619: lonnet::modify_student_enrollment
8620:
8621: Inputs:
8622:
8623: =over 4
8624:
8625: =item B<$udom> Students loncapa domain
8626:
8627: =item B<$uname> Students loncapa login name
8628:
8629: =item B<$uid> Students id/student number
8630:
8631: =item B<$umode> Students authentication mode
8632:
8633: =item B<$upass> Students password
8634:
8635: =item B<$first> Students first name
8636:
8637: =item B<$middle> Students middle name
8638:
8639: =item B<$last> Students last name
8640:
8641: =item B<$gene> Students generation
8642:
8643: =item B<$usec> Students section in course
8644:
8645: =item B<$end> Unix time of the roles expiration
8646:
8647: =item B<$start> Unix time of the roles start date
8648:
8649: =item B<$forceid> If defined, allow $uid to be changed
8650:
8651: =item B<$desiredhome> server to use as home server for student
8652:
8653: =back
8654:
8655: =item *
8656:
8657: modify_student_enrollment
8658:
8659: Change a students enrollment status in a class. The environment variable
8660: 'role.request.course' must be defined for this function to proceed.
8661:
8662: Inputs:
8663:
8664: =over 4
8665:
8666: =item $udom, students domain
8667:
8668: =item $uname, students name
8669:
8670: =item $uid, students user id
8671:
8672: =item $first, students first name
8673:
8674: =item $middle
8675:
8676: =item $last
8677:
8678: =item $gene
8679:
8680: =item $usec
8681:
8682: =item $end
8683:
8684: =item $start
8685:
8686: =back
8687:
8688:
8689: =item *
8690:
8691: assigncustomrole($udom,$uname,$url,$rdom,$rnam,$rolename,$end,$start) : assign
8692: custom role; give a custom role to a user for the level given by URL. Specify
8693: name and domain of role author, and role name
8694:
8695: =item *
8696:
8697: revokerole($udom,$uname,$url,$role) : revoke a role for url
8698:
8699: =item *
8700:
8701: revokecustomrole($udom,$uname,$url,$role) : revoke a custom role
8702:
8703: =back
8704:
8705: =head2 Course Infomation
8706:
8707: =over 4
8708:
8709: =item *
8710:
8711: coursedescription($courseid) : returns a hash of information about the
8712: specified course id, including all environment settings for the
8713: course, the description of the course will be in the hash under the
8714: key 'description'
8715:
8716: =item *
8717:
8718: resdata($name,$domain,$type,@which) : request for current parameter
8719: setting for a specific $type, where $type is either 'course' or 'user',
8720: @what should be a list of parameters to ask about. This routine caches
8721: answers for 5 minutes.
8722:
8723: =item *
8724:
8725: get_courseresdata($courseid, $domain) : dump the entire course resource
8726: data base, returning a hash that is keyed by the resource name and has
8727: values that are the resource value. I believe that the timestamps and
8728: versions are also returned.
8729:
8730:
8731: =back
8732:
8733: =head2 Course Modification
8734:
8735: =over 4
8736:
8737: =item *
8738:
8739: writecoursepref($courseid,%prefs) : write preferences (environment
8740: database) for a course
8741:
8742: =item *
8743:
8744: createcourse($udom,$description,$url) : make/modify course
8745:
8746: =back
8747:
8748: =head2 Resource Subroutines
8749:
8750: =over 4
8751:
8752: =item *
8753:
8754: subscribe($fname) : subscribe to a resource, returns URL if possible (probably should use repcopy instead)
8755:
8756: =item *
8757:
8758: repcopy($filename) : subscribes to the requested file, and attempts to
8759: replicate from the owning library server, Might return
8760: 'unavailable', 'not_found', 'forbidden', 'ok', or
8761: 'bad_request', also attempts to grab the metadata for the
8762: resource. Expects the local filesystem pathname
8763: (/home/httpd/html/res/....)
8764:
8765: =back
8766:
8767: =head2 Resource Information
8768:
8769: =over 4
8770:
8771: =item *
8772:
8773: EXT($varname,$symb,$udom,$uname) : evaluates and returns the value of
8774: a vairety of different possible values, $varname should be a request
8775: string, and the other parameters can be used to specify who and what
8776: one is asking about.
8777:
8778: Possible values for $varname are environment.lastname (or other item
8779: from the envirnment hash), user.name (or someother aspect about the
8780: user), resource.0.maxtries (or some other part and parameter of a
8781: resource)
8782:
8783: =item *
8784:
8785: directcondval($number) : get current value of a condition; reads from a state
8786: string
8787:
8788: =item *
8789:
8790: condval($condidx) : value of condition index based on state
8791:
8792: =item *
8793:
8794: metadata($uri,$what,$liburi,$prefix,$depthcount) : request a
8795: resource's metadata, $what should be either a specific key, or either
8796: 'keys' (to get a list of possible keys) or 'packages' to get a list of
8797: packages that this resource currently uses, the last 3 arguments are only used internally for recursive metadata.
8798:
8799: this function automatically caches all requests
8800:
8801: =item *
8802:
8803: metadata_query($query,$custom,$customshow) : make a metadata query against the
8804: network of library servers; returns file handle of where SQL and regex results
8805: will be stored for query
8806:
8807: =item *
8808:
8809: symbread($filename) : return symbolic list entry (filename argument optional);
8810: returns the data handle
8811:
8812: =item *
8813:
8814: symbverify($symb,$thisfn) : verifies that $symb actually exists and is
8815: a possible symb for the URL in $thisfn, and if is an encryypted
8816: resource that the user accessed using /enc/ returns a 1 on success, 0
8817: on failure, user must be in a course, as it assumes the existance of
8818: the course initial hash, and uses $env('request.course.id'}
8819:
8820:
8821: =item *
8822:
8823: symbclean($symb) : removes versions numbers from a symb, returns the
8824: cleaned symb
8825:
8826: =item *
8827:
8828: is_on_map($uri) : checks if the $uri is somewhere on the current
8829: course map, user must be in a course for it to work.
8830:
8831: =item *
8832:
8833: numval($salt) : return random seed value (addend for rndseed)
8834:
8835: =item *
8836:
8837: rndseed($symb,$courseid,$udom,$uname) : create a random sum; returns
8838: a random seed, all arguments are optional, if they aren't sent it uses the
8839: environment to derive them. Note: if symb isn't sent and it can't get one
8840: from &symbread it will use the current time as its return value
8841:
8842: =item *
8843:
8844: ireceipt($funame,$fudom,$fucourseid,$fusymb) : return unique,
8845: unfakeable, receipt
8846:
8847: =item *
8848:
8849: receipt() : API to ireceipt working off of env values; given out to users
8850:
8851: =item *
8852:
8853: countacc($url) : count the number of accesses to a given URL
8854:
8855: =item *
8856:
8857: 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
8858:
8859: =item *
8860:
8861: 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)
8862:
8863: =item *
8864:
8865: expirespread($uname,$udom,$stype,$usymb) : set expire date for spreadsheet
8866:
8867: =item *
8868:
8869: devalidate($symb) : devalidate temporary spreadsheet calculations,
8870: forcing spreadsheet to reevaluate the resource scores next time.
8871:
8872: =back
8873:
8874: =head2 Storing/Retreiving Data
8875:
8876: =over 4
8877:
8878: =item *
8879:
8880: store($storehash,$symb,$namespace,$udom,$uname) : stores hash permanently
8881: for this url; hashref needs to be given and should be a \%hashname; the
8882: remaining args aren't required and if they aren't passed or are '' they will
8883: be derived from the env
8884:
8885: =item *
8886:
8887: cstore($storehash,$symb,$namespace,$udom,$uname) : same as store but
8888: uses critical subroutine
8889:
8890: =item *
8891:
8892: restore($symb,$namespace,$udom,$uname) : returns hash for this symb;
8893: all args are optional
8894:
8895: =item *
8896:
8897: dumpstore($namespace,$udom,$uname,$regexp,$range) :
8898: dumps the complete (or key matching regexp) namespace into a hash
8899: ($udom, $uname, $regexp, $range are optional) for a namespace that is
8900: normally &store()ed into
8901:
8902: $range should be either an integer '100' (give me the first 100
8903: matching records)
8904: or be two integers sperated by a - with no spaces
8905: '30-50' (give me the 30th through the 50th matching
8906: records)
8907:
8908:
8909: =item *
8910:
8911: putstore($namespace,$symb,$version,$storehash,$udomain,$uname) :
8912: replaces a &store() version of data with a replacement set of data
8913: for a particular resource in a namespace passed in the $storehash hash
8914: reference
8915:
8916: =item *
8917:
8918: tmpstore($storehash,$symb,$namespace,$udom,$uname) : storage that
8919: works very similar to store/cstore, but all data is stored in a
8920: temporary location and can be reset using tmpreset, $storehash should
8921: be a hash reference, returns nothing on success
8922:
8923: =item *
8924:
8925: tmprestore($symb,$namespace,$udom,$uname) : storage that works very
8926: similar to restore, but all data is stored in a temporary location and
8927: can be reset using tmpreset. Returns a hash of values on success,
8928: error string otherwise.
8929:
8930: =item *
8931:
8932: tmpreset($symb,$namespace,$udom,$uname) : temporary storage reset,
8933: deltes all keys for $symb form the temporary storage hash.
8934:
8935: =item *
8936:
8937: get($namespace,$storearr,$udom,$uname) : returns hash with keys from array
8938: reference filled in from namesp ($udom and $uname are optional)
8939:
8940: =item *
8941:
8942: del($namespace,$storearr,$udom,$uname) : deletes keys out of array from
8943: namesp ($udom and $uname are optional)
8944:
8945: =item *
8946:
8947: dump($namespace,$udom,$uname,$regexp,$range) :
8948: dumps the complete (or key matching regexp) namespace into a hash
8949: ($udom, $uname, $regexp, $range are optional)
8950:
8951: $range should be either an integer '100' (give me the first 100
8952: matching records)
8953: or be two integers sperated by a - with no spaces
8954: '30-50' (give me the 30th through the 50th matching
8955: records)
8956: =item *
8957:
8958: inc($namespace,$store,$udom,$uname) : increments $store in $namespace.
8959: $store can be a scalar, an array reference, or if the amount to be
8960: incremented is > 1, a hash reference.
8961:
8962: ($udom and $uname are optional)
8963:
8964: =item *
8965:
8966: put($namespace,$storehash,$udom,$uname) : stores hash in namesp
8967: ($udom and $uname are optional)
8968:
8969: =item *
8970:
8971: cput($namespace,$storehash,$udom,$uname) : critical put
8972: ($udom and $uname are optional)
8973:
8974: =item *
8975:
8976: newput($namespace,$storehash,$udom,$uname) :
8977:
8978: Attempts to store the items in the $storehash, but only if they don't
8979: currently exist, if this succeeds you can be certain that you have
8980: successfully created a new key value pair in the $namespace db.
8981:
8982:
8983: Args:
8984: $namespace: name of database to store values to
8985: $storehash: hashref to store to the db
8986: $udom: (optional) domain of user containing the db
8987: $uname: (optional) name of user caontaining the db
8988:
8989: Returns:
8990: 'ok' -> succeeded in storing all keys of $storehash
8991: 'key_exists: <key>' -> failed to anything out of $storehash, as at
8992: least <key> already existed in the db (other
8993: requested keys may also already exist)
8994: 'error: <msg>' -> unable to tie the DB or other erorr occured
8995: 'con_lost' -> unable to contact request server
8996: 'refused' -> action was not allowed by remote machine
8997:
8998:
8999: =item *
9000:
9001: eget($namespace,$storearr,$udom,$uname) : returns hash with keys from array
9002: reference filled in from namesp (encrypts the return communication)
9003: ($udom and $uname are optional)
9004:
9005: =item *
9006:
9007: log($udom,$name,$home,$message) : write to permanent log for user; use
9008: critical subroutine
9009:
9010: =item *
9011:
9012: get_dom($namespace,$storearr,$udom,$uhome) : returns hash with keys from
9013: array reference filled in from namespace found in domain level on either
9014: specified domain server ($uhome) or primary domain server ($udom and $uhome are optional).
9015:
9016: =item *
9017:
9018: put_dom($namespace,$storehash,$udom,$uhome) : stores hash in namespace at
9019: domain level either on specified domain server ($uhome) or primary domain
9020: server ($udom and $uhome are optional)
9021:
9022: =back
9023:
9024: =head2 Network Status Functions
9025:
9026: =over 4
9027:
9028: =item *
9029:
9030: dirlist($uri) : return directory list based on URI
9031:
9032: =item *
9033:
9034: spareserver() : find server with least workload from spare.tab
9035:
9036: =back
9037:
9038: =head2 Apache Request
9039:
9040: =over 4
9041:
9042: =item *
9043:
9044: ssi($url,%hash) : server side include, does a complete request cycle on url to
9045: localhost, posts hash
9046:
9047: =back
9048:
9049: =head2 Data to String to Data
9050:
9051: =over 4
9052:
9053: =item *
9054:
9055: hash2str(%hash) : convert a hash into a string complete with escaping and '='
9056: and '&' separators, supports elements that are arrayrefs and hashrefs
9057:
9058: =item *
9059:
9060: hashref2str($hashref) : convert a hashref into a string complete with
9061: escaping and '=' and '&' separators, supports elements that are
9062: arrayrefs and hashrefs
9063:
9064: =item *
9065:
9066: arrayref2str($arrayref) : convert an arrayref into a string complete
9067: with escaping and '&' separators, supports elements that are arrayrefs
9068: and hashrefs
9069:
9070: =item *
9071:
9072: str2hash($string) : convert string to hash using unescaping and
9073: splitting on '=' and '&', supports elements that are arrayrefs and
9074: hashrefs
9075:
9076: =item *
9077:
9078: str2array($string) : convert string to hash using unescaping and
9079: splitting on '&', supports elements that are arrayrefs and hashrefs
9080:
9081: =back
9082:
9083: =head2 Logging Routines
9084:
9085: =over 4
9086:
9087: These routines allow one to make log messages in the lonnet.log and
9088: lonnet.perm logfiles.
9089:
9090: =item *
9091:
9092: logtouch() : make sure the logfile, lonnet.log, exists
9093:
9094: =item *
9095:
9096: logthis() : append message to the normal lonnet.log file, it gets
9097: preiodically rolled over and deleted.
9098:
9099: =item *
9100:
9101: logperm() : append a permanent message to lonnet.perm.log, this log
9102: file never gets deleted by any automated portion of the system, only
9103: messages of critical importance should go in here.
9104:
9105: =back
9106:
9107: =head2 General File Helper Routines
9108:
9109: =over 4
9110:
9111: =item *
9112:
9113: getfile($file,$caller) : two cases - requests for files in /res or in /uploaded.
9114: (a) files in /uploaded
9115: (i) If a local copy of the file exists -
9116: compares modification date of local copy with last-modified date for
9117: definitive version stored on home server for course. If local copy is
9118: stale, requests a new version from the home server and stores it.
9119: If the original has been removed from the home server, then local copy
9120: is unlinked.
9121: (ii) If local copy does not exist -
9122: requests the file from the home server and stores it.
9123:
9124: If $caller is 'uploadrep':
9125: This indicates a call from lonuploadrep.pm (PerlHeaderParserHandler phase)
9126: for request for files originally uploaded via DOCS.
9127: - returns 'ok' if fresh local copy now available, -1 otherwise.
9128:
9129: Otherwise:
9130: This indicates a call from the content generation phase of the request.
9131: - returns the entire contents of the file or -1.
9132:
9133: (b) files in /res
9134: - returns the entire contents of a file or -1;
9135: it properly subscribes to and replicates the file if neccessary.
9136:
9137:
9138: =item *
9139:
9140: stat_file($url) : $url is expected to be a /res/ or /uploaded/ style file
9141: reference
9142:
9143: returns either a stat() list of data about the file or an empty list
9144: if the file doesn't exist or couldn't find out about it (connection
9145: problems or user unknown)
9146:
9147: =item *
9148:
9149: filelocation($dir,$file) : returns file system location of a file
9150: based on URI; meant to be "fairly clean" absolute reference, $dir is a
9151: directory that relative $file lookups are to looked in ($dir of /a/dir
9152: and a file of ../bob will become /a/bob)
9153:
9154: =item *
9155:
9156: hreflocation($dir,$file) : returns file system location or a URL; same as
9157: filelocation except for hrefs
9158:
9159: =item *
9160:
9161: declutter() : declutters URLs (remove docroot, beginning slashes, 'res' etc)
9162:
9163: =back
9164:
9165: =head2 Usererfile file routines (/uploaded*)
9166:
9167: =over 4
9168:
9169: =item *
9170:
9171: userfileupload(): main rotine for putting a file in a user or course's
9172: filespace, arguments are,
9173:
9174: formname - required - this is the name of the element in $env where the
9175: filename, and the contents of the file to create/modifed exist
9176: the filename is in $env{'form.'.$formname.'.filename'} and the
9177: contents of the file is located in $env{'form.'.$formname}
9178: coursedoc - if true, store the file in the course of the active role
9179: of the current user
9180: subdir - required - subdirectory to put the file in under ../userfiles/
9181: if undefined, it will be placed in "unknown"
9182:
9183: (This routine calls clean_filename() to remove any dangerous
9184: characters from the filename, and then calls finuserfileupload() to
9185: complete the transaction)
9186:
9187: returns either the url of the uploaded file (/uploaded/....) if successful
9188: and /adm/notfound.html if unsuccessful
9189:
9190: =item *
9191:
9192: clean_filename(): routine for cleaing a filename up for storage in
9193: userfile space, argument is:
9194:
9195: filename - proposed filename
9196:
9197: returns: the new clean filename
9198:
9199: =item *
9200:
9201: finishuserfileupload(): routine that creaes and sends the file to
9202: userspace, probably shouldn't be called directly
9203:
9204: docuname: username or courseid of destination for the file
9205: docudom: domain of user/course of destination for the file
9206: formname: same as for userfileupload()
9207: fname: filename (inculding subdirectories) for the file
9208:
9209: returns either the url of the uploaded file (/uploaded/....) if successful
9210: and /adm/notfound.html if unsuccessful
9211:
9212: =item *
9213:
9214: renameuserfile(): renames an existing userfile to a new name
9215:
9216: Args:
9217: docuname: username or courseid of destination for the file
9218: docudom: domain of user/course of destination for the file
9219: old: current file name (including any subdirs under userfiles)
9220: new: desired file name (including any subdirs under userfiles)
9221:
9222: =item *
9223:
9224: mkdiruserfile(): creates a directory is a userfiles dir
9225:
9226: Args:
9227: docuname: username or courseid of destination for the file
9228: docudom: domain of user/course of destination for the file
9229: dir: dir to create (including any subdirs under userfiles)
9230:
9231: =item *
9232:
9233: removeuserfile(): removes a file that exists in userfiles
9234:
9235: Args:
9236: docuname: username or courseid of destination for the file
9237: docudom: domain of user/course of destination for the file
9238: fname: filname to delete (including any subdirs under userfiles)
9239:
9240: =item *
9241:
9242: removeuploadedurl(): convience function for removeuserfile()
9243:
9244: Args:
9245: url: a full /uploaded/... url to delete
9246:
9247: =item *
9248:
9249: get_portfile_permissions():
9250: Args:
9251: domain: domain of user or course contain the portfolio files
9252: user: name of user or num of course contain the portfolio files
9253: Returns:
9254: hashref of a dump of the proper file_permissions.db
9255:
9256:
9257: =item *
9258:
9259: get_access_controls():
9260:
9261: Args:
9262: current_permissions: the hash ref returned from get_portfile_permissions()
9263: group: (optional) the group you want the files associated with
9264: file: (optional) the file you want access info on
9265:
9266: Returns:
9267: a hash (keys are file names) of hashes containing
9268: keys are: path to file/file_name\0uniqueID:scope_end_start (see below)
9269: values are XML containing access control settings (see below)
9270:
9271: Internal notes:
9272:
9273: access controls are stored in file_permissions.db as key=value pairs.
9274: key -> path to file/file_name\0uniqueID:scope_end_start
9275: where scope -> public,guest,course,group,domains or users.
9276: end -> UNIX time for end of access (0 -> no end date)
9277: start -> UNIX time for start of access
9278:
9279: value -> XML description of access control
9280: <scope type=""> (type =1 of: public,guest,course,group,domains,users">
9281: <start></start>
9282: <end></end>
9283:
9284: <password></password> for scope type = guest
9285:
9286: <domain></domain> for scope type = course or group
9287: <number></number>
9288: <roles id="">
9289: <role></role>
9290: <access></access>
9291: <section></section>
9292: <group></group>
9293: </roles>
9294:
9295: <dom></dom> for scope type = domains
9296:
9297: <users> for scope type = users
9298: <user>
9299: <uname></uname>
9300: <udom></udom>
9301: </user>
9302: </users>
9303: </scope>
9304:
9305: Access data is also aggregated for each file in an additional key=value pair:
9306: key -> path to file/file_name\0accesscontrol
9307: value -> reference to hash
9308: hash contains key = value pairs
9309: where key = uniqueID:scope_end_start
9310: value = UNIX time record was last updated
9311:
9312: Used to improve speed of look-ups of access controls for each file.
9313:
9314: Locks on files (resulting from submission of portfolio file to a homework problem stored in array of arrays.
9315:
9316: modify_access_controls():
9317:
9318: Modifies access controls for a portfolio file
9319: Args
9320: 1. file name
9321: 2. reference to hash of required changes,
9322: 3. domain
9323: 4. username
9324: where domain,username are the domain of the portfolio owner
9325: (either a user or a course)
9326:
9327: Returns:
9328: 1. result of additions or updates ('ok' or 'error', with error message).
9329: 2. result of deletions ('ok' or 'error', with error message).
9330: 3. reference to hash of any new or updated access controls.
9331: 4. reference to hash used to map incoming IDs to uniqueIDs assigned to control.
9332: key = integer (inbound ID)
9333: value = uniqueID
9334:
9335: =back
9336:
9337: =head2 HTTP Helper Routines
9338:
9339: =over 4
9340:
9341: =item *
9342:
9343: escape() : unpack non-word characters into CGI-compatible hex codes
9344:
9345: =item *
9346:
9347: unescape() : pack CGI-compatible hex codes into actual non-word ASCII character
9348:
9349: =back
9350:
9351: =head1 PRIVATE SUBROUTINES
9352:
9353: =head2 Underlying communication routines (Shouldn't call)
9354:
9355: =over 4
9356:
9357: =item *
9358:
9359: subreply() : tries to pass a message to lonc, returns con_lost if incapable
9360:
9361: =item *
9362:
9363: reply() : uses subreply to send a message to remote machine, logs all failures
9364:
9365: =item *
9366:
9367: critical() : passes a critical message to another server; if cannot
9368: get through then place message in connection buffer directory and
9369: returns con_delayed, if incapable of saving message, returns
9370: con_failed
9371:
9372: =item *
9373:
9374: reconlonc() : tries to reconnect lonc client processes.
9375:
9376: =back
9377:
9378: =head2 Resource Access Logging
9379:
9380: =over 4
9381:
9382: =item *
9383:
9384: flushcourselogs() : flush (save) buffer logs and access logs
9385:
9386: =item *
9387:
9388: courselog($what) : save message for course in hash
9389:
9390: =item *
9391:
9392: courseacclog($what) : save message for course using &courselog(). Perform
9393: special processing for specific resource types (problems, exams, quizzes, etc).
9394:
9395: =item *
9396:
9397: goodbye() : flush course logs and log shutting down; it is called in srm.conf
9398: as a PerlChildExitHandler
9399:
9400: =back
9401:
9402: =head2 Other
9403:
9404: =over 4
9405:
9406: =item *
9407:
9408: symblist($mapname,%newhash) : update symbolic storage links
9409:
9410: =back
9411:
9412: =cut
9413:
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