File:
[LON-CAPA] /
loncom /
lonnet /
perl /
lonnet.pm
Revision
1.956:
download - view:
text,
annotated -
select for diffs
Mon Apr 21 15:58:12 2008 UTC (16 years, 3 months ago) by
raeburn
Branches:
MAIN
CVS tags:
HEAD
&dirlist() - call to ls3 should include $dirRoot not $alternateRoot.
&stat_file() - $getpropath only set to 1 if filepath begins with "userfiles".
&filelocation() - files with paths beginning with lonTabDir have $location = $file.
1: # The LearningOnline Network
2: # TCP networking package
3: #
4: # $Id: lonnet.pm,v 1.956 2008/04/21 15:58:12 raeburn 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: my $opened = open(my $idf,'+<',"$lonidsdir/$handle.id");
324: if (!$opened) {
325: return 0;
326: }
327: flock($idf,LOCK_SH);
328: @profile=<$idf>;
329: close($idf);
330: }
331: my %temp_env;
332: foreach my $line (@profile) {
333: if ($line !~ m/=/) {
334: return 0;
335: }
336: chomp($line);
337: my ($envname,$envvalue)=split(/=/,$line,2);
338: $temp_env{&unescape($envname)} = &unescape($envvalue);
339: }
340: unlink("$lonidsdir/$handle.id");
341: if (tie(my %disk_env,'GDBM_File',"$lonidsdir/$handle.id",&GDBM_WRCREAT(),
342: 0640)) {
343: %disk_env = %temp_env;
344: @env{keys(%temp_env)} = @disk_env{keys(%temp_env)};
345: untie(%disk_env);
346: }
347: return 1;
348: }
349:
350: # ------------------------------------------- Transfer profile into environment
351: my $env_loaded;
352: sub transfer_profile_to_env {
353: my ($lonidsdir,$handle,$force_transfer) = @_;
354: if (!$force_transfer && $env_loaded) { return; }
355:
356: if (!defined($lonidsdir)) {
357: $lonidsdir = $perlvar{'lonIDsDir'};
358: }
359: if (!defined($handle)) {
360: ($handle) = ($env{'user.environment'} =~m|/([^/]+)\.id$| );
361: }
362:
363: my $convert;
364: {
365: my $opened = open(my $idf,'+<',"$lonidsdir/$handle.id");
366: if (!$opened) {
367: return;
368: }
369: flock($idf,LOCK_SH);
370: if (tie(my %disk_env,'GDBM_File',"$lonidsdir/$handle.id",
371: &GDBM_READER(),0640)) {
372: @env{keys(%disk_env)} = @disk_env{keys(%disk_env)};
373: untie(%disk_env);
374: } else {
375: $convert = 1;
376: }
377: }
378: if ($convert) {
379: if (!&convert_and_load_session_env($lonidsdir,$handle)) {
380: &logthis("Failed to load session, or convert session.");
381: }
382: }
383:
384: my %remove;
385: while ( my $envname = each(%env) ) {
386: if (my ($key,$time) = ($envname =~ /^(cgi\.(\d+)_\d+\.)/)) {
387: if ($time < time-300) {
388: $remove{$key}++;
389: }
390: }
391: }
392:
393: $env{'user.environment'} = "$lonidsdir/$handle.id";
394: $env_loaded=1;
395: foreach my $expired_key (keys(%remove)) {
396: &delenv($expired_key);
397: }
398: }
399:
400: # ---------------------------------------------------- Check for valid session
401: sub check_for_valid_session {
402: my ($r) = @_;
403: my %cookies=CGI::Cookie->parse($r->header_in('Cookie'));
404: my $lonid=$cookies{'lonID'};
405: return undef if (!$lonid);
406:
407: my $handle=&LONCAPA::clean_handle($lonid->value);
408: my $lonidsdir=$r->dir_config('lonIDsDir');
409: return undef if (!-e "$lonidsdir/$handle.id");
410:
411: my $opened = open(my $idf,'+<',"$lonidsdir/$handle.id");
412: return undef if (!$opened);
413:
414: flock($idf,LOCK_SH);
415: my %disk_env;
416: if (!tie(%disk_env,'GDBM_File',"$lonidsdir/$handle.id",
417: &GDBM_READER(),0640)) {
418: return undef;
419: }
420:
421: if (!defined($disk_env{'user.name'})
422: || !defined($disk_env{'user.domain'})) {
423: return undef;
424: }
425: return $handle;
426: }
427:
428: sub timed_flock {
429: my ($file,$lock_type) = @_;
430: my $failed=0;
431: eval {
432: local $SIG{__DIE__}='DEFAULT';
433: local $SIG{ALRM}=sub {
434: $failed=1;
435: die("failed lock");
436: };
437: alarm(13);
438: flock($file,$lock_type);
439: alarm(0);
440: };
441: if ($failed) {
442: return undef;
443: } else {
444: return 1;
445: }
446: }
447:
448: # ---------------------------------------------------------- Append Environment
449:
450: sub appenv {
451: my ($newenv,$roles) = @_;
452: if (ref($newenv) eq 'HASH') {
453: foreach my $key (keys(%{$newenv})) {
454: my $refused = 0;
455: if (($key =~ /^user\.role/) || ($key =~ /^user\.priv/)) {
456: $refused = 1;
457: if (ref($roles) eq 'ARRAY') {
458: my ($type,$role) = ($key =~ /^user\.(role|priv)\.([^.]+)\./);
459: if (grep(/^\Q$role\E$/,@{$roles})) {
460: $refused = 0;
461: }
462: }
463: }
464: if ($refused) {
465: &logthis("<font color=\"blue\">WARNING: ".
466: "Attempt to modify environment ".$key." to ".$newenv->{$key}
467: .'</font>');
468: delete($newenv->{$key});
469: } else {
470: $env{$key}=$newenv->{$key};
471: }
472: }
473: my $opened = open(my $env_file,'+<',$env{'user.environment'});
474: if ($opened
475: && &timed_flock($env_file,LOCK_EX)
476: &&
477: tie(my %disk_env,'GDBM_File',$env{'user.environment'},
478: (&GDBM_WRITER()|&GDBM_NOLOCK()),0640)) {
479: while (my ($key,$value) = each(%{$newenv})) {
480: $disk_env{$key} = $value;
481: }
482: untie(%disk_env);
483: }
484: }
485: return 'ok';
486: }
487: # ----------------------------------------------------- Delete from Environment
488:
489: sub delenv {
490: my $delthis=shift;
491: if (($delthis=~/user\.role/) || ($delthis=~/user\.priv/)) {
492: &logthis("<font color=\"blue\">WARNING: ".
493: "Attempt to delete from environment ".$delthis);
494: return 'error';
495: }
496: my $opened = open(my $env_file,'+<',$env{'user.environment'});
497: if ($opened
498: && &timed_flock($env_file,LOCK_EX)
499: &&
500: tie(my %disk_env,'GDBM_File',$env{'user.environment'},
501: (&GDBM_WRITER()|&GDBM_NOLOCK()),0640)) {
502: foreach my $key (keys(%disk_env)) {
503: if ($key=~/^$delthis/) {
504: delete($env{$key});
505: delete($disk_env{$key});
506: }
507: }
508: untie(%disk_env);
509: }
510: return 'ok';
511: }
512:
513: sub get_env_multiple {
514: my ($name) = @_;
515: my @values;
516: if (defined($env{$name})) {
517: # exists is it an array
518: if (ref($env{$name})) {
519: @values=@{ $env{$name} };
520: } else {
521: $values[0]=$env{$name};
522: }
523: }
524: return(@values);
525: }
526:
527: # ------------------------------------------ Find out current server userload
528: sub userload {
529: my $numusers=0;
530: {
531: opendir(LONIDS,$perlvar{'lonIDsDir'});
532: my $filename;
533: my $curtime=time;
534: while ($filename=readdir(LONIDS)) {
535: next if ($filename eq '.' || $filename eq '..');
536: next if ($filename =~ /publicuser_\d+\.id/);
537: my ($mtime)=(stat($perlvar{'lonIDsDir'}.'/'.$filename))[9];
538: if ($curtime-$mtime < 1800) { $numusers++; }
539: }
540: closedir(LONIDS);
541: }
542: my $userloadpercent=0;
543: my $maxuserload=$perlvar{'lonUserLoadLim'};
544: if ($maxuserload) {
545: $userloadpercent=100*$numusers/$maxuserload;
546: }
547: $userloadpercent=sprintf("%.2f",$userloadpercent);
548: return $userloadpercent;
549: }
550:
551: # ------------------------------------------ Fight off request when overloaded
552:
553: sub overloaderror {
554: my ($r,$checkserver)=@_;
555: unless ($checkserver) { $checkserver=$perlvar{'lonHostID'}; }
556: my $loadavg;
557: if ($checkserver eq $perlvar{'lonHostID'}) {
558: open(my $loadfile,'/proc/loadavg');
559: $loadavg=<$loadfile>;
560: $loadavg =~ s/\s.*//g;
561: $loadavg = 100*$loadavg/$perlvar{'lonLoadLim'};
562: close($loadfile);
563: } else {
564: $loadavg=&reply('load',$checkserver);
565: }
566: my $overload=$loadavg-100;
567: if ($overload>0) {
568: $r->err_headers_out->{'Retry-After'}=$overload;
569: $r->log_error('Overload of '.$overload.' on '.$checkserver);
570: return 413;
571: }
572: return '';
573: }
574:
575: # ------------------------------ Find server with least workload from spare.tab
576:
577: sub spareserver {
578: my ($loadpercent,$userloadpercent,$want_server_name) = @_;
579: my $spare_server;
580: if ($userloadpercent !~ /\d/) { $userloadpercent=0; }
581: my $lowest_load=($loadpercent > $userloadpercent) ? $loadpercent
582: : $userloadpercent;
583:
584: foreach my $try_server (@{ $spareid{'primary'} }) {
585: ($spare_server, $lowest_load) =
586: &compare_server_load($try_server, $spare_server, $lowest_load);
587: }
588:
589: my $found_server = ($spare_server ne '' && $lowest_load < 100);
590:
591: if (!$found_server) {
592: foreach my $try_server (@{ $spareid{'default'} }) {
593: ($spare_server, $lowest_load) =
594: &compare_server_load($try_server, $spare_server, $lowest_load);
595: }
596: }
597:
598: if (!$want_server_name) {
599: $spare_server="http://".&hostname($spare_server);
600: }
601: return $spare_server;
602: }
603:
604: sub compare_server_load {
605: my ($try_server, $spare_server, $lowest_load) = @_;
606:
607: my $loadans = &reply('load', $try_server);
608: my $userloadans = &reply('userload',$try_server);
609:
610: if ($loadans !~ /\d/ && $userloadans !~ /\d/) {
611: next; #didn't get a number from the server
612: }
613:
614: my $load;
615: if ($loadans =~ /\d/) {
616: if ($userloadans =~ /\d/) {
617: #both are numbers, pick the bigger one
618: $load = ($loadans > $userloadans) ? $loadans
619: : $userloadans;
620: } else {
621: $load = $loadans;
622: }
623: } else {
624: $load = $userloadans;
625: }
626:
627: if (($load =~ /\d/) && ($load < $lowest_load)) {
628: $spare_server = $try_server;
629: $lowest_load = $load;
630: }
631: return ($spare_server,$lowest_load);
632: }
633:
634: # --------------------------- ask offload servers if user already has a session
635: sub find_existing_session {
636: my ($udom,$uname) = @_;
637: foreach my $try_server (@{ $spareid{'primary'} },
638: @{ $spareid{'default'} }) {
639: return $try_server if (&has_user_session($try_server, $udom, $uname));
640: }
641: return;
642: }
643:
644: # -------------------------------- ask if server already has a session for user
645: sub has_user_session {
646: my ($lonid,$udom,$uname) = @_;
647: my $result = &reply(join(':','userhassession',
648: map {&escape($_)} ($udom,$uname)),$lonid);
649: return 1 if ($result eq 'ok');
650:
651: return 0;
652: }
653:
654: # --------------------------------------------- Try to change a user's password
655:
656: sub changepass {
657: my ($uname,$udom,$currentpass,$newpass,$server,$context)=@_;
658: $currentpass = &escape($currentpass);
659: $newpass = &escape($newpass);
660: my $answer = reply("encrypt:passwd:$udom:$uname:$currentpass:$newpass:$context",
661: $server);
662: if (! $answer) {
663: &logthis("No reply on password change request to $server ".
664: "by $uname in domain $udom.");
665: } elsif ($answer =~ "^ok") {
666: &logthis("$uname in $udom successfully changed their password ".
667: "on $server.");
668: } elsif ($answer =~ "^pwchange_failure") {
669: &logthis("$uname in $udom was unable to change their password ".
670: "on $server. The action was blocked by either lcpasswd ".
671: "or pwchange");
672: } elsif ($answer =~ "^non_authorized") {
673: &logthis("$uname in $udom did not get their password correct when ".
674: "attempting to change it on $server.");
675: } elsif ($answer =~ "^auth_mode_error") {
676: &logthis("$uname in $udom attempted to change their password despite ".
677: "not being locally or internally authenticated on $server.");
678: } elsif ($answer =~ "^unknown_user") {
679: &logthis("$uname in $udom attempted to change their password ".
680: "on $server but were unable to because $server is not ".
681: "their home server.");
682: } elsif ($answer =~ "^refused") {
683: &logthis("$server refused to change $uname in $udom password because ".
684: "it was sent an unencrypted request to change the password.");
685: }
686: return $answer;
687: }
688:
689: # ----------------------- Try to determine user's current authentication scheme
690:
691: sub queryauthenticate {
692: my ($uname,$udom)=@_;
693: my $uhome=&homeserver($uname,$udom);
694: if (!$uhome) {
695: &logthis("User $uname at $udom is unknown when looking for authentication mechanism");
696: return 'no_host';
697: }
698: my $answer=reply("encrypt:currentauth:$udom:$uname",$uhome);
699: if ($answer =~ /^(unknown_user|refused|con_lost)/) {
700: &logthis("User $uname at $udom threw error $answer when checking authentication mechanism");
701: }
702: return $answer;
703: }
704:
705: # --------- Try to authenticate user from domain's lib servers (first this one)
706:
707: sub authenticate {
708: my ($uname,$upass,$udom,$checkdefauth)=@_;
709: $upass=&escape($upass);
710: $uname= &LONCAPA::clean_username($uname);
711: my $uhome=&homeserver($uname,$udom,1);
712: my $newhome;
713: if ((!$uhome) || ($uhome eq 'no_host')) {
714: # Maybe the machine was offline and only re-appeared again recently?
715: &reconlonc();
716: # One more
717: $uhome=&homeserver($uname,$udom,1);
718: if (($uhome eq 'no_host') && $checkdefauth) {
719: if (defined(&domain($udom,'primary'))) {
720: $newhome=&domain($udom,'primary');
721: }
722: if ($newhome ne '') {
723: $uhome = $newhome;
724: }
725: }
726: if ((!$uhome) || ($uhome eq 'no_host')) {
727: &logthis("User $uname at $udom is unknown in authenticate");
728: return 'no_host';
729: }
730: }
731: my $answer=reply("encrypt:auth:$udom:$uname:$upass:$checkdefauth",$uhome);
732: if ($answer eq 'authorized') {
733: if ($newhome) {
734: &logthis("User $uname at $udom authorized by $uhome, but needs account");
735: return 'no_account_on_host';
736: } else {
737: &logthis("User $uname at $udom authorized by $uhome");
738: return $uhome;
739: }
740: }
741: if ($answer eq 'non_authorized') {
742: &logthis("User $uname at $udom rejected by $uhome");
743: return 'no_host';
744: }
745: &logthis("User $uname at $udom threw error $answer when checking authentication mechanism");
746: return 'no_host';
747: }
748:
749: # ---------------------- Find the homebase for a user from domain's lib servers
750:
751: my %homecache;
752: sub homeserver {
753: my ($uname,$udom,$ignoreBadCache)=@_;
754: my $index="$uname:$udom";
755:
756: if (exists($homecache{$index})) { return $homecache{$index}; }
757:
758: my %servers = &get_servers($udom,'library');
759: foreach my $tryserver (keys(%servers)) {
760: next if ($ignoreBadCache ne 'true' &&
761: exists($badServerCache{$tryserver}));
762:
763: my $answer=reply("home:$udom:$uname",$tryserver);
764: if ($answer eq 'found') {
765: delete($badServerCache{$tryserver});
766: return $homecache{$index}=$tryserver;
767: } elsif ($answer eq 'no_host') {
768: $badServerCache{$tryserver}=1;
769: }
770: }
771: return 'no_host';
772: }
773:
774: # ------------------------------------- Find the usernames behind a list of IDs
775:
776: sub idget {
777: my ($udom,@ids)=@_;
778: my %returnhash=();
779:
780: my %servers = &get_servers($udom,'library');
781: foreach my $tryserver (keys(%servers)) {
782: my $idlist=join('&',@ids);
783: $idlist=~tr/A-Z/a-z/;
784: my $reply=&reply("idget:$udom:".$idlist,$tryserver);
785: my @answer=();
786: if (($reply ne 'con_lost') && ($reply!~/^error\:/)) {
787: @answer=split(/\&/,$reply);
788: } ;
789: my $i;
790: for ($i=0;$i<=$#ids;$i++) {
791: if ($answer[$i]) {
792: $returnhash{$ids[$i]}=$answer[$i];
793: }
794: }
795: }
796: return %returnhash;
797: }
798:
799: # ------------------------------------- Find the IDs behind a list of usernames
800:
801: sub idrget {
802: my ($udom,@unames)=@_;
803: my %returnhash=();
804: foreach my $uname (@unames) {
805: $returnhash{$uname}=(&userenvironment($udom,$uname,'id'))[1];
806: }
807: return %returnhash;
808: }
809:
810: # ------------------------------- Store away a list of names and associated IDs
811:
812: sub idput {
813: my ($udom,%ids)=@_;
814: my %servers=();
815: foreach my $uname (keys(%ids)) {
816: &cput('environment',{'id'=>$ids{$uname}},$udom,$uname);
817: my $uhom=&homeserver($uname,$udom);
818: if ($uhom ne 'no_host') {
819: my $id=&escape($ids{$uname});
820: $id=~tr/A-Z/a-z/;
821: my $esc_unam=&escape($uname);
822: if ($servers{$uhom}) {
823: $servers{$uhom}.='&'.$id.'='.$esc_unam;
824: } else {
825: $servers{$uhom}=$id.'='.$esc_unam;
826: }
827: }
828: }
829: foreach my $server (keys(%servers)) {
830: &critical('idput:'.$udom.':'.$servers{$server},$server);
831: }
832: }
833:
834: # ------------------------------------------- get items from domain db files
835:
836: sub get_dom {
837: my ($namespace,$storearr,$udom,$uhome)=@_;
838: my $items='';
839: foreach my $item (@$storearr) {
840: $items.=&escape($item).'&';
841: }
842: $items=~s/\&$//;
843: if (!$udom) {
844: $udom=$env{'user.domain'};
845: if (defined(&domain($udom,'primary'))) {
846: $uhome=&domain($udom,'primary');
847: } else {
848: undef($uhome);
849: }
850: } else {
851: if (!$uhome) {
852: if (defined(&domain($udom,'primary'))) {
853: $uhome=&domain($udom,'primary');
854: }
855: }
856: }
857: if ($udom && $uhome && ($uhome ne 'no_host')) {
858: my $rep=&reply("getdom:$udom:$namespace:$items",$uhome);
859: my %returnhash;
860: if ($rep eq '' || $rep =~ /^error: 2 /) {
861: return %returnhash;
862: }
863: my @pairs=split(/\&/,$rep);
864: if ( $#pairs==0 && $pairs[0] =~ /^(con_lost|error|no_such_host)/i) {
865: return @pairs;
866: }
867: my $i=0;
868: foreach my $item (@$storearr) {
869: $returnhash{$item}=&thaw_unescape($pairs[$i]);
870: $i++;
871: }
872: return %returnhash;
873: } else {
874: &logthis("get_dom failed - no homeserver and/or domain ($udom) ($uhome)");
875: }
876: }
877:
878: # -------------------------------------------- put items in domain db files
879:
880: sub put_dom {
881: my ($namespace,$storehash,$udom,$uhome)=@_;
882: if (!$udom) {
883: $udom=$env{'user.domain'};
884: if (defined(&domain($udom,'primary'))) {
885: $uhome=&domain($udom,'primary');
886: } else {
887: undef($uhome);
888: }
889: } else {
890: if (!$uhome) {
891: if (defined(&domain($udom,'primary'))) {
892: $uhome=&domain($udom,'primary');
893: }
894: }
895: }
896: if ($udom && $uhome && ($uhome ne 'no_host')) {
897: my $items='';
898: foreach my $item (keys(%$storehash)) {
899: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
900: }
901: $items=~s/\&$//;
902: return &reply("putdom:$udom:$namespace:$items",$uhome);
903: } else {
904: &logthis("put_dom failed - no homeserver and/or domain");
905: }
906: }
907:
908: sub retrieve_inst_usertypes {
909: my ($udom) = @_;
910: my (%returnhash,@order);
911: if (defined(&domain($udom,'primary'))) {
912: my $uhome=&domain($udom,'primary');
913: my $rep=&reply("inst_usertypes:$udom",$uhome);
914: my ($hashitems,$orderitems) = split(/:/,$rep);
915: my @pairs=split(/\&/,$hashitems);
916: foreach my $item (@pairs) {
917: my ($key,$value)=split(/=/,$item,2);
918: $key = &unescape($key);
919: next if ($key =~ /^error: 2 /);
920: $returnhash{$key}=&thaw_unescape($value);
921: }
922: my @esc_order = split(/\&/,$orderitems);
923: foreach my $item (@esc_order) {
924: push(@order,&unescape($item));
925: }
926: } else {
927: &logthis("get_dom failed - no primary domain server for $udom");
928: }
929: return (\%returnhash,\@order);
930: }
931:
932: sub is_domainimage {
933: my ($url) = @_;
934: if ($url=~m-^/+res/+($match_domain)/+\1\-domainconfig/+(img|logo|domlogo)/+-) {
935: if (&domain($1) ne '') {
936: return '1';
937: }
938: }
939: return;
940: }
941:
942: sub inst_directory_query {
943: my ($srch) = @_;
944: my $udom = $srch->{'srchdomain'};
945: my %results;
946: my $homeserver = &domain($udom,'primary');
947: my $outcome;
948: if ($homeserver ne '') {
949: my $queryid=&reply("querysend:instdirsearch:".
950: &escape($srch->{'srchby'}).':'.
951: &escape($srch->{'srchterm'}).':'.
952: &escape($srch->{'srchtype'}),$homeserver);
953: my $host=&hostname($homeserver);
954: if ($queryid !~/^\Q$host\E\_/) {
955: &logthis('instituional directory search invalid queryid: '.$queryid.' for host: '.$homeserver.'in domain '.$udom);
956: return;
957: }
958: my $response = &get_query_reply($queryid);
959: my $maxtries = 5;
960: my $tries = 1;
961: while (($response=~/^timeout/) && ($tries < $maxtries)) {
962: $response = &get_query_reply($queryid);
963: $tries ++;
964: }
965:
966: if (!&error($response) && $response ne 'refused') {
967: if ($response eq 'unavailable') {
968: $outcome = $response;
969: } else {
970: $outcome = 'ok';
971: my @matches = split(/\n/,$response);
972: foreach my $match (@matches) {
973: my ($key,$value) = split(/=/,$match);
974: $results{&unescape($key).':'.$udom} = &thaw_unescape($value);
975: }
976: }
977: }
978: }
979: return ($outcome,%results);
980: }
981:
982: sub usersearch {
983: my ($srch) = @_;
984: my $dom = $srch->{'srchdomain'};
985: my %results;
986: my %libserv = &all_library();
987: my $query = 'usersearch';
988: foreach my $tryserver (keys(%libserv)) {
989: if (&host_domain($tryserver) eq $dom) {
990: my $host=&hostname($tryserver);
991: my $queryid=
992: &reply("querysend:".&escape($query).':'.
993: &escape($srch->{'srchby'}).':'.
994: &escape($srch->{'srchtype'}).':'.
995: &escape($srch->{'srchterm'}),$tryserver);
996: if ($queryid !~/^\Q$host\E\_/) {
997: &logthis('usersearch: invalid queryid: '.$queryid.' for host: '.$host.'in domain '.$dom.' and server: '.$tryserver);
998: next;
999: }
1000: my $reply = &get_query_reply($queryid);
1001: my $maxtries = 1;
1002: my $tries = 1;
1003: while (($reply=~/^timeout/) && ($tries < $maxtries)) {
1004: $reply = &get_query_reply($queryid);
1005: $tries ++;
1006: }
1007: if ( ($reply =~/^timeout/) || ($reply =~/^error/) ) {
1008: &logthis('usersrch error: '.$reply.' for '.$dom.' - searching for : '.$srch->{'srchterm'}.' by '.$srch->{'srchby'}.' ('.$srch->{'srchtype'}.') - maxtries: '.$maxtries.' tries: '.$tries);
1009: } else {
1010: my @matches;
1011: if ($reply =~ /\n/) {
1012: @matches = split(/\n/,$reply);
1013: } else {
1014: @matches = split(/\&/,$reply);
1015: }
1016: foreach my $match (@matches) {
1017: my ($uname,$udom,%userhash);
1018: foreach my $entry (split(/:/,$match)) {
1019: my ($key,$value) =
1020: map {&unescape($_);} split(/=/,$entry);
1021: $userhash{$key} = $value;
1022: if ($key eq 'username') {
1023: $uname = $value;
1024: } elsif ($key eq 'domain') {
1025: $udom = $value;
1026: }
1027: }
1028: $results{$uname.':'.$udom} = \%userhash;
1029: }
1030: }
1031: }
1032: }
1033: return %results;
1034: }
1035:
1036: sub get_instuser {
1037: my ($udom,$uname,$id) = @_;
1038: my $homeserver = &domain($udom,'primary');
1039: my ($outcome,%results);
1040: if ($homeserver ne '') {
1041: my $queryid=&reply("querysend:getinstuser:".&escape($uname).':'.
1042: &escape($id).':'.&escape($udom),$homeserver);
1043: my $host=&hostname($homeserver);
1044: if ($queryid !~/^\Q$host\E\_/) {
1045: &logthis('get_instuser invalid queryid: '.$queryid.' for host: '.$homeserver.'in domain '.$udom);
1046: return;
1047: }
1048: my $response = &get_query_reply($queryid);
1049: my $maxtries = 5;
1050: my $tries = 1;
1051: while (($response=~/^timeout/) && ($tries < $maxtries)) {
1052: $response = &get_query_reply($queryid);
1053: $tries ++;
1054: }
1055: if (!&error($response) && $response ne 'refused') {
1056: if ($response eq 'unavailable') {
1057: $outcome = $response;
1058: } else {
1059: $outcome = 'ok';
1060: my @matches = split(/\n/,$response);
1061: foreach my $match (@matches) {
1062: my ($key,$value) = split(/=/,$match);
1063: $results{&unescape($key)} = &thaw_unescape($value);
1064: }
1065: }
1066: }
1067: }
1068: my %userinfo;
1069: if (ref($results{$uname}) eq 'HASH') {
1070: %userinfo = %{$results{$uname}};
1071: }
1072: return ($outcome,%userinfo);
1073: }
1074:
1075: sub inst_rulecheck {
1076: my ($udom,$uname,$id,$item,$rules) = @_;
1077: my %returnhash;
1078: if ($udom ne '') {
1079: if (ref($rules) eq 'ARRAY') {
1080: @{$rules} = map {&escape($_);} (@{$rules});
1081: my $rulestr = join(':',@{$rules});
1082: my $homeserver=&domain($udom,'primary');
1083: if (($homeserver ne '') && ($homeserver ne 'no_host')) {
1084: my $response;
1085: if ($item eq 'username') {
1086: $response=&unescape(&reply('instrulecheck:'.&escape($udom).
1087: ':'.&escape($uname).':'.$rulestr,
1088: $homeserver));
1089: } elsif ($item eq 'id') {
1090: $response=&unescape(&reply('instidrulecheck:'.&escape($udom).
1091: ':'.&escape($id).':'.$rulestr,
1092: $homeserver));
1093: } elsif ($item eq 'selfcreate') {
1094: $response=&unescape(&reply('instselfcreatecheck:'.
1095: &escape($udom).':'.&escape($uname).
1096: ':'.$rulestr,$homeserver));
1097: }
1098: if ($response ne 'refused') {
1099: my @pairs=split(/\&/,$response);
1100: foreach my $item (@pairs) {
1101: my ($key,$value)=split(/=/,$item,2);
1102: $key = &unescape($key);
1103: next if ($key =~ /^error: 2 /);
1104: $returnhash{$key}=&thaw_unescape($value);
1105: }
1106: }
1107: }
1108: }
1109: }
1110: return %returnhash;
1111: }
1112:
1113: sub inst_userrules {
1114: my ($udom,$check) = @_;
1115: my (%ruleshash,@ruleorder);
1116: if ($udom ne '') {
1117: my $homeserver=&domain($udom,'primary');
1118: if (($homeserver ne '') && ($homeserver ne 'no_host')) {
1119: my $response;
1120: if ($check eq 'id') {
1121: $response=&reply('instidrules:'.&escape($udom),
1122: $homeserver);
1123: } elsif ($check eq 'email') {
1124: $response=&reply('instemailrules:'.&escape($udom),
1125: $homeserver);
1126: } else {
1127: $response=&reply('instuserrules:'.&escape($udom),
1128: $homeserver);
1129: }
1130: if (($response ne 'refused') && ($response ne 'error') &&
1131: ($response ne 'unknown_cmd') &&
1132: ($response ne 'no_such_host')) {
1133: my ($hashitems,$orderitems) = split(/:/,$response);
1134: my @pairs=split(/\&/,$hashitems);
1135: foreach my $item (@pairs) {
1136: my ($key,$value)=split(/=/,$item,2);
1137: $key = &unescape($key);
1138: next if ($key =~ /^error: 2 /);
1139: $ruleshash{$key}=&thaw_unescape($value);
1140: }
1141: my @esc_order = split(/\&/,$orderitems);
1142: foreach my $item (@esc_order) {
1143: push(@ruleorder,&unescape($item));
1144: }
1145: }
1146: }
1147: }
1148: return (\%ruleshash,\@ruleorder);
1149: }
1150:
1151: # ------------------------- Get Authentication and Language Defaults for Domain
1152:
1153: sub get_domain_defaults {
1154: my ($domain) = @_;
1155: my $cachetime = 60*60*24;
1156: my ($defauthtype,$defautharg,$deflang);
1157: my ($result,$cached)=&is_cached_new('domdefaults',$domain);
1158: if (defined($cached)) {
1159: if (ref($result) eq 'HASH') {
1160: return %{$result};
1161: }
1162: }
1163: my %domdefaults;
1164: my %domconfig =
1165: &Apache::lonnet::get_dom('configuration',['defaults'],$domain);
1166: if (ref($domconfig{'defaults'}) eq 'HASH') {
1167: $domdefaults{'lang_def'} = $domconfig{'defaults'}{'lang_def'};
1168: $domdefaults{'auth_def'} = $domconfig{'defaults'}{'auth_def'};
1169: $domdefaults{'auth_arg_def'} = $domconfig{'defaults'}{'auth_arg_def'};
1170: } else {
1171: $domdefaults{'lang_def'} = &domain($domain,'lang_def');
1172: $domdefaults{'auth_def'} = &domain($domain,'auth_def');
1173: $domdefaults{'auth_arg_def'} = &domain($domain,'auth_arg_def');
1174: }
1175: &Apache::lonnet::do_cache_new('domdefaults',$domain,\%domdefaults,
1176: $cachetime);
1177: return %domdefaults;
1178: }
1179:
1180: # --------------------------------------------------- Assign a key to a student
1181:
1182: sub assign_access_key {
1183: #
1184: # a valid key looks like uname:udom#comments
1185: # comments are being appended
1186: #
1187: my ($ckey,$kdom,$knum,$cdom,$cnum,$udom,$uname,$logentry)=@_;
1188: $kdom=
1189: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($kdom));
1190: $knum=
1191: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($knum));
1192: $cdom=
1193: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
1194: $cnum=
1195: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
1196: $udom=$env{'user.name'} unless (defined($udom));
1197: $uname=$env{'user.domain'} unless (defined($uname));
1198: my %existing=&get('accesskeys',[$ckey],$kdom,$knum);
1199: if (($existing{$ckey}=~/^\#(.*)$/) || # - new key
1200: ($existing{$ckey}=~/^\Q$uname\E\:\Q$udom\E\#(.*)$/)) {
1201: # assigned to this person
1202: # - this should not happen,
1203: # unless something went wrong
1204: # the first time around
1205: # ready to assign
1206: $logentry=$1.'; '.$logentry;
1207: if (&put('accesskeys',{$ckey=>$uname.':'.$udom.'#'.$logentry},
1208: $kdom,$knum) eq 'ok') {
1209: # key now belongs to user
1210: my $envkey='key.'.$cdom.'_'.$cnum;
1211: if (&put('environment',{$envkey => $ckey}) eq 'ok') {
1212: &appenv({'environment.'.$envkey => $ckey});
1213: return 'ok';
1214: } else {
1215: return
1216: 'error: Count not permanently assign key, will need to be re-entered later.';
1217: }
1218: } else {
1219: return 'error: Could not assign key, try again later.';
1220: }
1221: } elsif (!$existing{$ckey}) {
1222: # the key does not exist
1223: return 'error: The key does not exist';
1224: } else {
1225: # the key is somebody else's
1226: return 'error: The key is already in use';
1227: }
1228: }
1229:
1230: # ------------------------------------------ put an additional comment on a key
1231:
1232: sub comment_access_key {
1233: #
1234: # a valid key looks like uname:udom#comments
1235: # comments are being appended
1236: #
1237: my ($ckey,$cdom,$cnum,$logentry)=@_;
1238: $cdom=
1239: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
1240: $cnum=
1241: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
1242: my %existing=&get('accesskeys',[$ckey],$cdom,$cnum);
1243: if ($existing{$ckey}) {
1244: $existing{$ckey}.='; '.$logentry;
1245: # ready to assign
1246: if (&put('accesskeys',{$ckey=>$existing{$ckey}},
1247: $cdom,$cnum) eq 'ok') {
1248: return 'ok';
1249: } else {
1250: return 'error: Count not store comment.';
1251: }
1252: } else {
1253: # the key does not exist
1254: return 'error: The key does not exist';
1255: }
1256: }
1257:
1258: # ------------------------------------------------------ Generate a set of keys
1259:
1260: sub generate_access_keys {
1261: my ($number,$cdom,$cnum,$logentry)=@_;
1262: $cdom=
1263: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
1264: $cnum=
1265: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
1266: unless (&allowed('mky',$cdom)) { return 0; }
1267: unless (($cdom) && ($cnum)) { return 0; }
1268: if ($number>10000) { return 0; }
1269: sleep(2); # make sure don't get same seed twice
1270: srand(time()^($$+($$<<15))); # from "Programming Perl"
1271: my $total=0;
1272: for (my $i=1;$i<=$number;$i++) {
1273: my $newkey=sprintf("%lx",int(100000*rand)).'-'.
1274: sprintf("%lx",int(100000*rand)).'-'.
1275: sprintf("%lx",int(100000*rand));
1276: $newkey=~s/1/g/g; # folks mix up 1 and l
1277: $newkey=~s/0/h/g; # and also 0 and O
1278: my %existing=&get('accesskeys',[$newkey],$cdom,$cnum);
1279: if ($existing{$newkey}) {
1280: $i--;
1281: } else {
1282: if (&put('accesskeys',
1283: { $newkey => '# generated '.localtime().
1284: ' by '.$env{'user.name'}.'@'.$env{'user.domain'}.
1285: '; '.$logentry },
1286: $cdom,$cnum) eq 'ok') {
1287: $total++;
1288: }
1289: }
1290: }
1291: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},
1292: 'Generated '.$total.' keys for '.$cnum.' at '.$cdom);
1293: return $total;
1294: }
1295:
1296: # ------------------------------------------------------- Validate an accesskey
1297:
1298: sub validate_access_key {
1299: my ($ckey,$cdom,$cnum,$udom,$uname)=@_;
1300: $cdom=
1301: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
1302: $cnum=
1303: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
1304: $udom=$env{'user.domain'} unless (defined($udom));
1305: $uname=$env{'user.name'} unless (defined($uname));
1306: my %existing=&get('accesskeys',[$ckey],$cdom,$cnum);
1307: return ($existing{$ckey}=~/^\Q$uname\E\:\Q$udom\E\#/);
1308: }
1309:
1310: # ------------------------------------- Find the section of student in a course
1311: sub devalidate_getsection_cache {
1312: my ($udom,$unam,$courseid)=@_;
1313: my $hashid="$udom:$unam:$courseid";
1314: &devalidate_cache_new('getsection',$hashid);
1315: }
1316:
1317: sub courseid_to_courseurl {
1318: my ($courseid) = @_;
1319: #already url style courseid
1320: return $courseid if ($courseid =~ m{^/});
1321:
1322: if (exists($env{'course.'.$courseid.'.num'})) {
1323: my $cnum = $env{'course.'.$courseid.'.num'};
1324: my $cdom = $env{'course.'.$courseid.'.domain'};
1325: return "/$cdom/$cnum";
1326: }
1327:
1328: my %courseinfo=&Apache::lonnet::coursedescription($courseid);
1329: if (exists($courseinfo{'num'})) {
1330: return "/$courseinfo{'domain'}/$courseinfo{'num'}";
1331: }
1332:
1333: return undef;
1334: }
1335:
1336: sub getsection {
1337: my ($udom,$unam,$courseid)=@_;
1338: my $cachetime=1800;
1339:
1340: my $hashid="$udom:$unam:$courseid";
1341: my ($result,$cached)=&is_cached_new('getsection',$hashid);
1342: if (defined($cached)) { return $result; }
1343:
1344: my %Pending;
1345: my %Expired;
1346: #
1347: # Each role can either have not started yet (pending), be active,
1348: # or have expired.
1349: #
1350: # If there is an active role, we are done.
1351: #
1352: # If there is more than one role which has not started yet,
1353: # choose the one which will start sooner
1354: # If there is one role which has not started yet, return it.
1355: #
1356: # If there is more than one expired role, choose the one which ended last.
1357: # If there is a role which has expired, return it.
1358: #
1359: $courseid = &courseid_to_courseurl($courseid);
1360: my %roleshash = &dump('roles',$udom,$unam,$courseid);
1361: foreach my $key (keys(%roleshash)) {
1362: next if ($key !~/^\Q$courseid\E(?:\/)*(\w+)*\_st$/);
1363: my $section=$1;
1364: if ($key eq $courseid.'_st') { $section=''; }
1365: my ($dummy,$end,$start)=split(/\_/,&unescape($roleshash{$key}));
1366: my $now=time;
1367: if (defined($end) && $end && ($now > $end)) {
1368: $Expired{$end}=$section;
1369: next;
1370: }
1371: if (defined($start) && $start && ($now < $start)) {
1372: $Pending{$start}=$section;
1373: next;
1374: }
1375: return &do_cache_new('getsection',$hashid,$section,$cachetime);
1376: }
1377: #
1378: # Presumedly there will be few matching roles from the above
1379: # loop and the sorting time will be negligible.
1380: if (scalar(keys(%Pending))) {
1381: my ($time) = sort {$a <=> $b} keys(%Pending);
1382: return &do_cache_new('getsection',$hashid,$Pending{$time},$cachetime);
1383: }
1384: if (scalar(keys(%Expired))) {
1385: my @sorted = sort {$a <=> $b} keys(%Expired);
1386: my $time = pop(@sorted);
1387: return &do_cache_new('getsection',$hashid,$Expired{$time},$cachetime);
1388: }
1389: return &do_cache_new('getsection',$hashid,'-1',$cachetime);
1390: }
1391:
1392: sub save_cache {
1393: &purge_remembered();
1394: #&Apache::loncommon::validate_page();
1395: undef(%env);
1396: undef($env_loaded);
1397: }
1398:
1399: my $to_remember=-1;
1400: my %remembered;
1401: my %accessed;
1402: my $kicks=0;
1403: my $hits=0;
1404: sub make_key {
1405: my ($name,$id) = @_;
1406: if (length($id) > 65
1407: && length(&escape($id)) > 200) {
1408: $id=length($id).':'.&Digest::MD5::md5_hex($id);
1409: }
1410: return &escape($name.':'.$id);
1411: }
1412:
1413: sub devalidate_cache_new {
1414: my ($name,$id,$debug) = @_;
1415: if ($debug) { &Apache::lonnet::logthis("deleting $name:$id"); }
1416: $id=&make_key($name,$id);
1417: $memcache->delete($id);
1418: delete($remembered{$id});
1419: delete($accessed{$id});
1420: }
1421:
1422: sub is_cached_new {
1423: my ($name,$id,$debug) = @_;
1424: $id=&make_key($name,$id);
1425: if (exists($remembered{$id})) {
1426: if ($debug) { &Apache::lonnet::logthis("Earyl return $id of $remembered{$id} "); }
1427: $accessed{$id}=[&gettimeofday()];
1428: $hits++;
1429: return ($remembered{$id},1);
1430: }
1431: my $value = $memcache->get($id);
1432: if (!(defined($value))) {
1433: if ($debug) { &Apache::lonnet::logthis("getting $id is not defined"); }
1434: return (undef,undef);
1435: }
1436: if ($value eq '__undef__') {
1437: if ($debug) { &Apache::lonnet::logthis("getting $id is __undef__"); }
1438: $value=undef;
1439: }
1440: &make_room($id,$value,$debug);
1441: if ($debug) { &Apache::lonnet::logthis("getting $id is $value"); }
1442: return ($value,1);
1443: }
1444:
1445: sub do_cache_new {
1446: my ($name,$id,$value,$time,$debug) = @_;
1447: $id=&make_key($name,$id);
1448: my $setvalue=$value;
1449: if (!defined($setvalue)) {
1450: $setvalue='__undef__';
1451: }
1452: if (!defined($time) ) {
1453: $time=600;
1454: }
1455: if ($debug) { &Apache::lonnet::logthis("Setting $id to $value"); }
1456: my $result = $memcache->set($id,$setvalue,$time);
1457: if (! $result) {
1458: &logthis("caching of id -> $id failed");
1459: $memcache->disconnect_all();
1460: }
1461: # need to make a copy of $value
1462: &make_room($id,$value,$debug);
1463: return $value;
1464: }
1465:
1466: sub make_room {
1467: my ($id,$value,$debug)=@_;
1468:
1469: $remembered{$id}= (ref($value)) ? &Storable::dclone($value)
1470: : $value;
1471: if ($to_remember<0) { return; }
1472: $accessed{$id}=[&gettimeofday()];
1473: if (scalar(keys(%remembered)) <= $to_remember) { return; }
1474: my $to_kick;
1475: my $max_time=0;
1476: foreach my $other (keys(%accessed)) {
1477: if (&tv_interval($accessed{$other}) > $max_time) {
1478: $to_kick=$other;
1479: $max_time=&tv_interval($accessed{$other});
1480: }
1481: }
1482: delete($remembered{$to_kick});
1483: delete($accessed{$to_kick});
1484: $kicks++;
1485: if ($debug) { &logthis("kicking $to_kick $max_time $kicks\n"); }
1486: return;
1487: }
1488:
1489: sub purge_remembered {
1490: #&logthis("Tossing ".scalar(keys(%remembered)));
1491: #&logthis(sprintf("%-20s is %s",'%remembered',length(&freeze(\%remembered))));
1492: undef(%remembered);
1493: undef(%accessed);
1494: }
1495: # ------------------------------------- Read an entry from a user's environment
1496:
1497: sub userenvironment {
1498: my ($udom,$unam,@what)=@_;
1499: my %returnhash=();
1500: my @answer=split(/\&/,
1501: &reply('get:'.$udom.':'.$unam.':environment:'.join('&',@what),
1502: &homeserver($unam,$udom)));
1503: my $i;
1504: for ($i=0;$i<=$#what;$i++) {
1505: $returnhash{$what[$i]}=&unescape($answer[$i]);
1506: }
1507: return %returnhash;
1508: }
1509:
1510: # ---------------------------------------------------------- Get a studentphoto
1511: sub studentphoto {
1512: my ($udom,$unam,$ext) = @_;
1513: my $home=&Apache::lonnet::homeserver($unam,$udom);
1514: if (defined($env{'request.course.id'})) {
1515: if ($env{'course.'.$env{'request.course.id'}.'.internal.showphoto'}) {
1516: if ($udom eq $env{'course.'.$env{'request.course.id'}.'.domain'}) {
1517: return(&retrievestudentphoto($udom,$unam,$ext));
1518: } else {
1519: my ($result,$perm_reqd)=
1520: &Apache::lonnet::auto_photo_permission($unam,$udom);
1521: if ($result eq 'ok') {
1522: if (!($perm_reqd eq 'yes')) {
1523: return(&retrievestudentphoto($udom,$unam,$ext));
1524: }
1525: }
1526: }
1527: }
1528: } else {
1529: my ($result,$perm_reqd) =
1530: &Apache::lonnet::auto_photo_permission($unam,$udom);
1531: if ($result eq 'ok') {
1532: if (!($perm_reqd eq 'yes')) {
1533: return(&retrievestudentphoto($udom,$unam,$ext));
1534: }
1535: }
1536: }
1537: return '/adm/lonKaputt/lonlogo_broken.gif';
1538: }
1539:
1540: sub retrievestudentphoto {
1541: my ($udom,$unam,$ext,$type) = @_;
1542: my $home=&Apache::lonnet::homeserver($unam,$udom);
1543: my $ret=&Apache::lonnet::reply("studentphoto:$udom:$unam:$ext:$type",$home);
1544: if ($ret eq 'ok') {
1545: my $url="/uploaded/$udom/$unam/internal/studentphoto.$ext";
1546: if ($type eq 'thumbnail') {
1547: $url="/uploaded/$udom/$unam/internal/studentphoto_tn.$ext";
1548: }
1549: my $tokenurl=&Apache::lonnet::tokenwrapper($url);
1550: return $tokenurl;
1551: } else {
1552: if ($type eq 'thumbnail') {
1553: return '/adm/lonKaputt/genericstudent_tn.gif';
1554: } else {
1555: return '/adm/lonKaputt/lonlogo_broken.gif';
1556: }
1557: }
1558: }
1559:
1560: # -------------------------------------------------------------------- New chat
1561:
1562: sub chatsend {
1563: my ($newentry,$anon,$group)=@_;
1564: my $cnum=$env{'course.'.$env{'request.course.id'}.'.num'};
1565: my $cdom=$env{'course.'.$env{'request.course.id'}.'.domain'};
1566: my $chome=$env{'course.'.$env{'request.course.id'}.'.home'};
1567: &reply('chatsend:'.$cdom.':'.$cnum.':'.
1568: &escape($env{'user.domain'}.':'.$env{'user.name'}.':'.$anon.':'.
1569: &escape($newentry)).':'.$group,$chome);
1570: }
1571:
1572: # ------------------------------------------ Find current version of a resource
1573:
1574: sub getversion {
1575: my $fname=&clutter(shift);
1576: unless ($fname=~/^\/res\//) { return -1; }
1577: return ¤tversion(&filelocation('',$fname));
1578: }
1579:
1580: sub currentversion {
1581: my $fname=shift;
1582: my ($result,$cached)=&is_cached_new('resversion',$fname);
1583: if (defined($cached)) { return $result; }
1584: my $author=$fname;
1585: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
1586: my ($udom,$uname)=split(/\//,$author);
1587: my $home=homeserver($uname,$udom);
1588: if ($home eq 'no_host') {
1589: return -1;
1590: }
1591: my $answer=reply("currentversion:$fname",$home);
1592: if (($answer eq 'con_lost') || ($answer eq 'rejected')) {
1593: return -1;
1594: }
1595: return &do_cache_new('resversion',$fname,$answer,600);
1596: }
1597:
1598: # ----------------------------- Subscribe to a resource, return URL if possible
1599:
1600: sub subscribe {
1601: my $fname=shift;
1602: if ($fname=~/\/(aboutme|syllabus|bulletinboard|smppg)$/) { return ''; }
1603: $fname=~s/[\n\r]//g;
1604: my $author=$fname;
1605: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
1606: my ($udom,$uname)=split(/\//,$author);
1607: my $home=homeserver($uname,$udom);
1608: if ($home eq 'no_host') {
1609: return 'not_found';
1610: }
1611: my $answer=reply("sub:$fname",$home);
1612: if (($answer eq 'con_lost') || ($answer eq 'rejected')) {
1613: $answer.=' by '.$home;
1614: }
1615: return $answer;
1616: }
1617:
1618: # -------------------------------------------------------------- Replicate file
1619:
1620: sub repcopy {
1621: my $filename=shift;
1622: $filename=~s/\/+/\//g;
1623: if ($filename=~m|^/home/httpd/html/adm/|) { return 'ok'; }
1624: if ($filename=~m|^/home/httpd/html/lonUsers/|) { return 'ok'; }
1625: if ($filename=~m|^/home/httpd/html/userfiles/| or
1626: $filename=~m -^/*(uploaded|editupload)/-) {
1627: return &repcopy_userfile($filename);
1628: }
1629: $filename=~s/[\n\r]//g;
1630: my $transname="$filename.in.transfer";
1631: # FIXME: this should flock
1632: if ((-e $filename) || (-e $transname)) { return 'ok'; }
1633: my $remoteurl=subscribe($filename);
1634: if ($remoteurl =~ /^con_lost by/) {
1635: &logthis("Subscribe returned $remoteurl: $filename");
1636: return 'unavailable';
1637: } elsif ($remoteurl eq 'not_found') {
1638: #&logthis("Subscribe returned not_found: $filename");
1639: return 'not_found';
1640: } elsif ($remoteurl =~ /^rejected by/) {
1641: &logthis("Subscribe returned $remoteurl: $filename");
1642: return 'forbidden';
1643: } elsif ($remoteurl eq 'directory') {
1644: return 'ok';
1645: } else {
1646: my $author=$filename;
1647: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
1648: my ($udom,$uname)=split(/\//,$author);
1649: my $home=homeserver($uname,$udom);
1650: unless ($home eq $perlvar{'lonHostID'}) {
1651: my @parts=split(/\//,$filename);
1652: my $path="/$parts[1]/$parts[2]/$parts[3]/$parts[4]";
1653: if ($path ne "$perlvar{'lonDocRoot'}/res") {
1654: &logthis("Malconfiguration for replication: $filename");
1655: return 'bad_request';
1656: }
1657: my $count;
1658: for ($count=5;$count<$#parts;$count++) {
1659: $path.="/$parts[$count]";
1660: if ((-e $path)!=1) {
1661: mkdir($path,0777);
1662: }
1663: }
1664: my $ua=new LWP::UserAgent;
1665: my $request=new HTTP::Request('GET',"$remoteurl");
1666: my $response=$ua->request($request,$transname);
1667: if ($response->is_error()) {
1668: unlink($transname);
1669: my $message=$response->status_line;
1670: &logthis("<font color=\"blue\">WARNING:"
1671: ." LWP get: $message: $filename</font>");
1672: return 'unavailable';
1673: } else {
1674: if ($remoteurl!~/\.meta$/) {
1675: my $mrequest=new HTTP::Request('GET',$remoteurl.'.meta');
1676: my $mresponse=$ua->request($mrequest,$filename.'.meta');
1677: if ($mresponse->is_error()) {
1678: unlink($filename.'.meta');
1679: &logthis(
1680: "<font color=\"yellow\">INFO: No metadata: $filename</font>");
1681: }
1682: }
1683: rename($transname,$filename);
1684: return 'ok';
1685: }
1686: }
1687: }
1688: }
1689:
1690: # ------------------------------------------------ Get server side include body
1691: sub ssi_body {
1692: my ($filelink,%form)=@_;
1693: if (! exists($form{'LONCAPA_INTERNAL_no_discussion'})) {
1694: $form{'LONCAPA_INTERNAL_no_discussion'}='true';
1695: }
1696: my $output='';
1697: my $response;
1698: if ($filelink=~/^http\:/) {
1699: ($output,$response)=&externalssi($filelink);
1700: } else {
1701: ($output,$response)=&ssi($filelink,%form);
1702: }
1703: $output=~s|//(\s*<!--)? BEGIN LON-CAPA Internal.+?// END LON-CAPA Internal\s*(-->)?\s||gs;
1704: $output=~s/^.*?\<body[^\>]*\>//si;
1705: $output=~s/\<\/body\s*\>.*?$//si;
1706: if (wantarray) {
1707: return ($output, $response);
1708: } else {
1709: return $output;
1710: }
1711: }
1712:
1713: # --------------------------------------------------------- Server Side Include
1714:
1715: sub absolute_url {
1716: my ($host_name) = @_;
1717: my $protocol = ($ENV{'SERVER_PORT'} == 443?'https://':'http://');
1718: if ($host_name eq '') {
1719: $host_name = $ENV{'SERVER_NAME'};
1720: }
1721: return $protocol.$host_name;
1722: }
1723:
1724: #
1725: # Server side include.
1726: # Parameters:
1727: # fn Possibly encrypted resource name/id.
1728: # form Hash that describes how the rendering should be done
1729: # and other things.
1730: # Returns:
1731: # Scalar context: The content of the response.
1732: # Array context: 2 element list of the content and the full response object.
1733: #
1734: sub ssi {
1735:
1736: my ($fn,%form)=@_;
1737: my $ua=new LWP::UserAgent;
1738: my $request;
1739:
1740: $form{'no_update_last_known'}=1;
1741: &Apache::lonenc::check_encrypt(\$fn);
1742: if (%form) {
1743: $request=new HTTP::Request('POST',&absolute_url().$fn);
1744: $request->content(join('&',map { &escape($_).'='.&escape($form{$_}) } keys %form));
1745: } else {
1746: $request=new HTTP::Request('GET',&absolute_url().$fn);
1747: }
1748:
1749: $request->header(Cookie => $ENV{'HTTP_COOKIE'});
1750: my $response=$ua->request($request);
1751:
1752: if (wantarray) {
1753: return ($response->content, $response);
1754: } else {
1755: return $response->content;
1756: }
1757: }
1758:
1759: sub externalssi {
1760: my ($url)=@_;
1761: my $ua=new LWP::UserAgent;
1762: my $request=new HTTP::Request('GET',$url);
1763: my $response=$ua->request($request);
1764: if (wantarray) {
1765: return ($response->content, $response);
1766: } else {
1767: return $response->content;
1768: }
1769: }
1770:
1771: # -------------------------------- Allow a /uploaded/ URI to be vouched for
1772:
1773: sub allowuploaded {
1774: my ($srcurl,$url)=@_;
1775: $url=&clutter(&declutter($url));
1776: my $dir=$url;
1777: $dir=~s/\/[^\/]+$//;
1778: my %httpref=();
1779: my $httpurl=&hreflocation('',$url);
1780: $httpref{'httpref.'.$httpurl}=$srcurl;
1781: &Apache::lonnet::appenv(\%httpref);
1782: }
1783:
1784: # --------- File operations in /home/httpd/html/userfiles/$domain/1/2/3/$course
1785: # input: action, courseID, current domain, intended
1786: # path to file, source of file, instruction to parse file for objects,
1787: # ref to hash for embedded objects,
1788: # ref to hash for codebase of java objects.
1789: #
1790: # output: url to file (if action was uploaddoc),
1791: # ok if successful, or diagnostic message otherwise (if action was propagate or copy)
1792: #
1793: # Allows directory structure to be used within lonUsers/../userfiles/ for a
1794: # course.
1795: #
1796: # action = propagate - /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
1797: # will be copied to /home/httpd/lonUsers/1/2/3/$course/userfiles in
1798: # course's home server.
1799: #
1800: # action = copy - /home/httpd/html/userfiles/$domain/1/2/3/$course/$file will
1801: # be copied from $source (current location) to
1802: # /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
1803: # and will then be copied to
1804: # /home/httpd/lonUsers/$domain/1/2/3/$course/userfiles/$file in
1805: # course's home server.
1806: #
1807: # action = uploaddoc - /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
1808: # will be retrived from $env{form.uploaddoc} (from DOCS interface) to
1809: # /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
1810: # and will then be copied to /home/httpd/lonUsers/1/2/3/$course/userfiles/$file
1811: # in course's home server.
1812: #
1813:
1814: sub process_coursefile {
1815: my ($action,$docuname,$docudom,$file,$source,$parser,$allfiles,$codebase)=@_;
1816: my $fetchresult;
1817: my $home=&homeserver($docuname,$docudom);
1818: if ($action eq 'propagate') {
1819: $fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
1820: $home);
1821: } else {
1822: my $fpath = '';
1823: my $fname = $file;
1824: ($fpath,$fname) = ($file =~ m|^(.*)/([^/]+)$|);
1825: $fpath=$docudom.'/'.$docuname.'/'.$fpath;
1826: my $filepath = &build_filepath($fpath);
1827: if ($action eq 'copy') {
1828: if ($source eq '') {
1829: $fetchresult = 'no source file';
1830: return $fetchresult;
1831: } else {
1832: my $destination = $filepath.'/'.$fname;
1833: rename($source,$destination);
1834: $fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
1835: $home);
1836: }
1837: } elsif ($action eq 'uploaddoc') {
1838: open(my $fh,'>'.$filepath.'/'.$fname);
1839: print $fh $env{'form.'.$source};
1840: close($fh);
1841: if ($parser eq 'parse') {
1842: my $parse_result = &extract_embedded_items($filepath,$fname,$allfiles,$codebase);
1843: unless ($parse_result eq 'ok') {
1844: &logthis('Failed to parse '.$filepath.'/'.$fname.' for embedded media: '.$parse_result);
1845: }
1846: }
1847: $fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
1848: $home);
1849: if ($fetchresult eq 'ok') {
1850: return '/uploaded/'.$fpath.'/'.$fname;
1851: } else {
1852: &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$file.
1853: ' to host '.$home.': '.$fetchresult);
1854: return '/adm/notfound.html';
1855: }
1856: }
1857: }
1858: unless ( $fetchresult eq 'ok') {
1859: &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$file.
1860: ' to host '.$home.': '.$fetchresult);
1861: }
1862: return $fetchresult;
1863: }
1864:
1865: sub build_filepath {
1866: my ($fpath) = @_;
1867: my $filepath=$perlvar{'lonDocRoot'}.'/userfiles';
1868: unless ($fpath eq '') {
1869: my @parts=split('/',$fpath);
1870: foreach my $part (@parts) {
1871: $filepath.= '/'.$part;
1872: if ((-e $filepath)!=1) {
1873: mkdir($filepath,0777);
1874: }
1875: }
1876: }
1877: return $filepath;
1878: }
1879:
1880: sub store_edited_file {
1881: my ($primary_url,$content,$docudom,$docuname,$fetchresult) = @_;
1882: my $file = $primary_url;
1883: $file =~ s#^/uploaded/$docudom/$docuname/##;
1884: my $fpath = '';
1885: my $fname = $file;
1886: ($fpath,$fname) = ($file =~ m|^(.*)/([^/]+)$|);
1887: $fpath=$docudom.'/'.$docuname.'/'.$fpath;
1888: my $filepath = &build_filepath($fpath);
1889: open(my $fh,'>'.$filepath.'/'.$fname);
1890: print $fh $content;
1891: close($fh);
1892: my $home=&homeserver($docuname,$docudom);
1893: $$fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
1894: $home);
1895: if ($$fetchresult eq 'ok') {
1896: return '/uploaded/'.$fpath.'/'.$fname;
1897: } else {
1898: &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$file.
1899: ' to host '.$home.': '.$$fetchresult);
1900: return '/adm/notfound.html';
1901: }
1902: }
1903:
1904: sub clean_filename {
1905: my ($fname,$args)=@_;
1906: # Replace Windows backslashes by forward slashes
1907: $fname=~s/\\/\//g;
1908: if (!$args->{'keep_path'}) {
1909: # Get rid of everything but the actual filename
1910: $fname=~s/^.*\/([^\/]+)$/$1/;
1911: }
1912: # Replace spaces by underscores
1913: $fname=~s/\s+/\_/g;
1914: # Replace all other weird characters by nothing
1915: $fname=~s{[^/\w\.\-]}{}g;
1916: # Replace all .\d. sequences with _\d. so they no longer look like version
1917: # numbers
1918: $fname=~s/\.(\d+)(?=\.)/_$1/g;
1919: return $fname;
1920: }
1921:
1922: # --------------- Take an uploaded file and put it into the userfiles directory
1923: # input: $formname - the contents of the file are in $env{"form.$formname"}
1924: # the desired filenam is in $env{"form.$formname.filename"}
1925: # $coursedoc - if true up to the current course
1926: # if false
1927: # $subdir - directory in userfile to store the file into
1928: # $parser - instruction to parse file for objects ($parser = parse)
1929: # $allfiles - reference to hash for embedded objects
1930: # $codebase - reference to hash for codebase of java objects
1931: # $desuname - username for permanent storage of uploaded file
1932: # $dsetudom - domain for permanaent storage of uploaded file
1933: # $thumbwidth - width (pixels) of thumbnail to make for uploaded image
1934: # $thumbheight - height (pixels) of thumbnail to make for uploaded image
1935: #
1936: # output: url of file in userspace, or error: <message>
1937: # or /adm/notfound.html if failure to upload occurse
1938:
1939:
1940: sub userfileupload {
1941: my ($formname,$coursedoc,$subdir,$parser,$allfiles,$codebase,$destuname,
1942: $destudom,$thumbwidth,$thumbheight)=@_;
1943: if (!defined($subdir)) { $subdir='unknown'; }
1944: my $fname=$env{'form.'.$formname.'.filename'};
1945: $fname=&clean_filename($fname);
1946: # See if there is anything left
1947: unless ($fname) { return 'error: no uploaded file'; }
1948: chop($env{'form.'.$formname});
1949: if (($formname eq 'screenshot') && ($subdir eq 'helprequests')) { #files uploaded to help request form are handled differently
1950: my $now = time;
1951: my $filepath = 'tmp/helprequests/'.$now;
1952: my @parts=split(/\//,$filepath);
1953: my $fullpath = $perlvar{'lonDaemons'};
1954: for (my $i=0;$i<@parts;$i++) {
1955: $fullpath .= '/'.$parts[$i];
1956: if ((-e $fullpath)!=1) {
1957: mkdir($fullpath,0777);
1958: }
1959: }
1960: open(my $fh,'>'.$fullpath.'/'.$fname);
1961: print $fh $env{'form.'.$formname};
1962: close($fh);
1963: return $fullpath.'/'.$fname;
1964: } elsif (($formname eq 'coursecreatorxml') && ($subdir eq 'batchupload')) { #files uploaded to create course page are handled differently
1965: my $filepath = 'tmp/addcourse/'.$destudom.'/web/'.$env{'user.name'}.
1966: '_'.$env{'user.domain'}.'/pending';
1967: my @parts=split(/\//,$filepath);
1968: my $fullpath = $perlvar{'lonDaemons'};
1969: for (my $i=0;$i<@parts;$i++) {
1970: $fullpath .= '/'.$parts[$i];
1971: if ((-e $fullpath)!=1) {
1972: mkdir($fullpath,0777);
1973: }
1974: }
1975: open(my $fh,'>'.$fullpath.'/'.$fname);
1976: print $fh $env{'form.'.$formname};
1977: close($fh);
1978: return $fullpath.'/'.$fname;
1979: }
1980:
1981: # Create the directory if not present
1982: $fname="$subdir/$fname";
1983: if ($coursedoc) {
1984: my $docuname=$env{'course.'.$env{'request.course.id'}.'.num'};
1985: my $docudom=$env{'course.'.$env{'request.course.id'}.'.domain'};
1986: if ($env{'form.folder'} =~ m/^(default|supplemental)/) {
1987: return &finishuserfileupload($docuname,$docudom,
1988: $formname,$fname,$parser,$allfiles,
1989: $codebase,$thumbwidth,$thumbheight);
1990: } else {
1991: $fname=$env{'form.folder'}.'/'.$fname;
1992: return &process_coursefile('uploaddoc',$docuname,$docudom,
1993: $fname,$formname,$parser,
1994: $allfiles,$codebase);
1995: }
1996: } elsif (defined($destuname)) {
1997: my $docuname=$destuname;
1998: my $docudom=$destudom;
1999: return &finishuserfileupload($docuname,$docudom,$formname,$fname,
2000: $parser,$allfiles,$codebase,
2001: $thumbwidth,$thumbheight);
2002:
2003: } else {
2004: my $docuname=$env{'user.name'};
2005: my $docudom=$env{'user.domain'};
2006: if (exists($env{'form.group'})) {
2007: $docuname=$env{'course.'.$env{'request.course.id'}.'.num'};
2008: $docudom=$env{'course.'.$env{'request.course.id'}.'.domain'};
2009: }
2010: return &finishuserfileupload($docuname,$docudom,$formname,$fname,
2011: $parser,$allfiles,$codebase,
2012: $thumbwidth,$thumbheight);
2013: }
2014: }
2015:
2016: sub finishuserfileupload {
2017: my ($docuname,$docudom,$formname,$fname,$parser,$allfiles,$codebase,
2018: $thumbwidth,$thumbheight) = @_;
2019: my $path=$docudom.'/'.$docuname.'/';
2020: my $filepath=$perlvar{'lonDocRoot'};
2021: my ($fnamepath,$file,$fetchthumb);
2022: $file=$fname;
2023: if ($fname=~m|/|) {
2024: ($fnamepath,$file) = ($fname =~ m|^(.*)/([^/]+)$|);
2025: $path.=$fnamepath.'/';
2026: }
2027: my @parts=split(/\//,$filepath.'/userfiles/'.$path);
2028: my $count;
2029: for ($count=4;$count<=$#parts;$count++) {
2030: $filepath.="/$parts[$count]";
2031: if ((-e $filepath)!=1) {
2032: mkdir($filepath,0777);
2033: }
2034: }
2035: # Save the file
2036: {
2037: if (!open(FH,'>'.$filepath.'/'.$file)) {
2038: &logthis('Failed to create '.$filepath.'/'.$file);
2039: print STDERR ('Failed to create '.$filepath.'/'.$file."\n");
2040: return '/adm/notfound.html';
2041: }
2042: if (!print FH ($env{'form.'.$formname})) {
2043: &logthis('Failed to write to '.$filepath.'/'.$file);
2044: print STDERR ('Failed to write to '.$filepath.'/'.$file."\n");
2045: return '/adm/notfound.html';
2046: }
2047: close(FH);
2048: }
2049: if ($parser eq 'parse') {
2050: my $parse_result = &extract_embedded_items($filepath,$file,$allfiles,
2051: $codebase);
2052: unless ($parse_result eq 'ok') {
2053: &logthis('Failed to parse '.$filepath.$file.
2054: ' for embedded media: '.$parse_result);
2055: }
2056: }
2057: if (($thumbwidth =~ /^\d+$/) && ($thumbheight =~ /^\d+$/)) {
2058: my $input = $filepath.'/'.$file;
2059: my $output = $filepath.'/'.'tn-'.$file;
2060: my $thumbsize = $thumbwidth.'x'.$thumbheight;
2061: system("convert -sample $thumbsize $input $output");
2062: if (-e $filepath.'/'.'tn-'.$file) {
2063: $fetchthumb = 1;
2064: }
2065: }
2066:
2067: # Notify homeserver to grep it
2068: #
2069: my $docuhome=&homeserver($docuname,$docudom);
2070: my $fetchresult= &reply('fetchuserfile:'.$path.$file,$docuhome);
2071: if ($fetchresult eq 'ok') {
2072: if ($fetchthumb) {
2073: my $thumbresult= &reply('fetchuserfile:'.$path.'tn-'.$file,$docuhome);
2074: if ($thumbresult ne 'ok') {
2075: &logthis('Failed to transfer '.$path.'tn-'.$file.' to host '.
2076: $docuhome.': '.$thumbresult);
2077: }
2078: }
2079: #
2080: # Return the URL to it
2081: return '/uploaded/'.$path.$file;
2082: } else {
2083: &logthis('Failed to transfer '.$path.$file.' to host '.$docuhome.
2084: ': '.$fetchresult);
2085: return '/adm/notfound.html';
2086: }
2087: }
2088:
2089: sub extract_embedded_items {
2090: my ($filepath,$file,$allfiles,$codebase,$content) = @_;
2091: my @state = ();
2092: my %javafiles = (
2093: codebase => '',
2094: code => '',
2095: archive => ''
2096: );
2097: my %mediafiles = (
2098: src => '',
2099: movie => '',
2100: );
2101: my $p;
2102: if ($content) {
2103: $p = HTML::LCParser->new($content);
2104: } else {
2105: $p = HTML::LCParser->new($filepath.'/'.$file);
2106: }
2107: while (my $t=$p->get_token()) {
2108: if ($t->[0] eq 'S') {
2109: my ($tagname, $attr) = ($t->[1],$t->[2]);
2110: push(@state, $tagname);
2111: if (lc($tagname) eq 'allow') {
2112: &add_filetype($allfiles,$attr->{'src'},'src');
2113: }
2114: if (lc($tagname) eq 'img') {
2115: &add_filetype($allfiles,$attr->{'src'},'src');
2116: }
2117: if (lc($tagname) eq 'a') {
2118: &add_filetype($allfiles,$attr->{'href'},'href');
2119: }
2120: if (lc($tagname) eq 'script') {
2121: if ($attr->{'archive'} =~ /\.jar$/i) {
2122: &add_filetype($allfiles,$attr->{'archive'},'archive');
2123: } else {
2124: &add_filetype($allfiles,$attr->{'src'},'src');
2125: }
2126: }
2127: if (lc($tagname) eq 'link') {
2128: if (lc($attr->{'rel'}) eq 'stylesheet') {
2129: &add_filetype($allfiles,$attr->{'href'},'href');
2130: }
2131: }
2132: if (lc($tagname) eq 'object' ||
2133: (lc($tagname) eq 'embed' && lc($state[-2]) ne 'object')) {
2134: foreach my $item (keys(%javafiles)) {
2135: $javafiles{$item} = '';
2136: }
2137: }
2138: if (lc($state[-2]) eq 'object' && lc($tagname) eq 'param') {
2139: my $name = lc($attr->{'name'});
2140: foreach my $item (keys(%javafiles)) {
2141: if ($name eq $item) {
2142: $javafiles{$item} = $attr->{'value'};
2143: last;
2144: }
2145: }
2146: foreach my $item (keys(%mediafiles)) {
2147: if ($name eq $item) {
2148: &add_filetype($allfiles, $attr->{'value'}, 'value');
2149: last;
2150: }
2151: }
2152: }
2153: if (lc($tagname) eq 'embed' || lc($tagname) eq 'applet') {
2154: foreach my $item (keys(%javafiles)) {
2155: if ($attr->{$item}) {
2156: $javafiles{$item} = $attr->{$item};
2157: last;
2158: }
2159: }
2160: foreach my $item (keys(%mediafiles)) {
2161: if ($attr->{$item}) {
2162: &add_filetype($allfiles,$attr->{$item},$item);
2163: last;
2164: }
2165: }
2166: }
2167: } elsif ($t->[0] eq 'E') {
2168: my ($tagname) = ($t->[1]);
2169: if ($javafiles{'codebase'} ne '') {
2170: $javafiles{'codebase'} .= '/';
2171: }
2172: if (lc($tagname) eq 'applet' ||
2173: lc($tagname) eq 'object' ||
2174: (lc($tagname) eq 'embed' && lc($state[-2]) ne 'object')
2175: ) {
2176: foreach my $item (keys(%javafiles)) {
2177: if ($item ne 'codebase' && $javafiles{$item} ne '') {
2178: my $file=$javafiles{'codebase'}.$javafiles{$item};
2179: &add_filetype($allfiles,$file,$item);
2180: }
2181: }
2182: }
2183: pop @state;
2184: }
2185: }
2186: return 'ok';
2187: }
2188:
2189: sub add_filetype {
2190: my ($allfiles,$file,$type)=@_;
2191: if (exists($allfiles->{$file})) {
2192: unless (grep/^\Q$type\E$/, @{$allfiles->{$file}}) {
2193: push(@{$allfiles->{$file}}, &escape($type));
2194: }
2195: } else {
2196: @{$allfiles->{$file}} = (&escape($type));
2197: }
2198: }
2199:
2200: sub removeuploadedurl {
2201: my ($url)=@_;
2202: my (undef,undef,$udom,$uname,$fname)=split('/',$url,5);
2203: return &removeuserfile($uname,$udom,$fname);
2204: }
2205:
2206: sub removeuserfile {
2207: my ($docuname,$docudom,$fname)=@_;
2208: my $home=&homeserver($docuname,$docudom);
2209: my $result = &reply("removeuserfile:$docudom/$docuname/$fname",$home);
2210: if ($result eq 'ok') {
2211: if (($fname !~ /\.meta$/) && (&is_portfolio_file($fname))) {
2212: my $metafile = $fname.'.meta';
2213: my $metaresult = &removeuserfile($docuname,$docudom,$metafile);
2214: my $url = "/uploaded/$docudom/$docuname/$fname";
2215: my ($file,$group) = (&parse_portfolio_url($url))[3,4];
2216: my $sqlresult =
2217: &update_portfolio_table($docuname,$docudom,$file,
2218: 'portfolio_metadata',$group,
2219: 'delete');
2220: }
2221: }
2222: return $result;
2223: }
2224:
2225: sub mkdiruserfile {
2226: my ($docuname,$docudom,$dir)=@_;
2227: my $home=&homeserver($docuname,$docudom);
2228: return &reply("mkdiruserfile:".&escape("$docudom/$docuname/$dir"),$home);
2229: }
2230:
2231: sub renameuserfile {
2232: my ($docuname,$docudom,$old,$new)=@_;
2233: my $home=&homeserver($docuname,$docudom);
2234: my $result = &reply("renameuserfile:$docudom:$docuname:".
2235: &escape("$old").':'.&escape("$new"),$home);
2236: if ($result eq 'ok') {
2237: if (($old !~ /\.meta$/) && (&is_portfolio_file($old))) {
2238: my $oldmeta = $old.'.meta';
2239: my $newmeta = $new.'.meta';
2240: my $metaresult =
2241: &renameuserfile($docuname,$docudom,$oldmeta,$newmeta);
2242: my $url = "/uploaded/$docudom/$docuname/$old";
2243: my ($file,$group) = (&parse_portfolio_url($url))[3,4];
2244: my $sqlresult =
2245: &update_portfolio_table($docuname,$docudom,$file,
2246: 'portfolio_metadata',$group,
2247: 'delete');
2248: }
2249: }
2250: return $result;
2251: }
2252:
2253: # ------------------------------------------------------------------------- Log
2254:
2255: sub log {
2256: my ($dom,$nam,$hom,$what)=@_;
2257: return critical("log:$dom:$nam:$what",$hom);
2258: }
2259:
2260: # ------------------------------------------------------------------ Course Log
2261: #
2262: # This routine flushes several buffers of non-mission-critical nature
2263: #
2264:
2265: sub flushcourselogs {
2266: &logthis('Flushing log buffers');
2267: #
2268: # course logs
2269: # This is a log of all transactions in a course, which can be used
2270: # for data mining purposes
2271: #
2272: # It also collects the courseid database, which lists last transaction
2273: # times and course titles for all courseids
2274: #
2275: my %courseidbuffer=();
2276: foreach my $crsid (keys(%courselogs)) {
2277: if (&reply('log:'.$coursedombuf{$crsid}.':'.$coursenumbuf{$crsid}.':'.
2278: &escape($courselogs{$crsid}),
2279: $coursehombuf{$crsid}) eq 'ok') {
2280: delete $courselogs{$crsid};
2281: } else {
2282: &logthis('Failed to flush log buffer for '.$crsid);
2283: if (length($courselogs{$crsid})>40000) {
2284: &logthis("<font color=\"blue\">WARNING: Buffer for ".$crsid.
2285: " exceeded maximum size, deleting.</font>");
2286: delete $courselogs{$crsid};
2287: }
2288: }
2289: $courseidbuffer{$coursehombuf{$crsid}}{$crsid} = {
2290: 'description' => $coursedescrbuf{$crsid},
2291: 'inst_code' => $courseinstcodebuf{$crsid},
2292: 'type' => $coursetypebuf{$crsid},
2293: 'owner' => $courseownerbuf{$crsid},
2294: };
2295: }
2296: #
2297: # Write course id database (reverse lookup) to homeserver of courses
2298: # Is used in pickcourse
2299: #
2300: foreach my $crs_home (keys(%courseidbuffer)) {
2301: my $response = &courseidput(&host_domain($crs_home),
2302: $courseidbuffer{$crs_home},
2303: $crs_home,'timeonly');
2304: }
2305: #
2306: # File accesses
2307: # Writes to the dynamic metadata of resources to get hit counts, etc.
2308: #
2309: foreach my $entry (keys(%accesshash)) {
2310: if ($entry =~ /___count$/) {
2311: my ($dom,$name);
2312: ($dom,$name,undef)=
2313: ($entry=~m{___($match_domain)/($match_name)/(.*)___count$});
2314: if (! defined($dom) || $dom eq '' ||
2315: ! defined($name) || $name eq '') {
2316: my $cid = $env{'request.course.id'};
2317: $dom = $env{'request.'.$cid.'.domain'};
2318: $name = $env{'request.'.$cid.'.num'};
2319: }
2320: my $value = $accesshash{$entry};
2321: my (undef,$url,undef) = ($entry =~ /^(.*)___(.*)___count$/);
2322: my %temphash=($url => $value);
2323: my $result = &inc('nohist_accesscount',\%temphash,$dom,$name);
2324: if ($result eq 'ok') {
2325: delete $accesshash{$entry};
2326: } elsif ($result eq 'unknown_cmd') {
2327: # Target server has old code running on it.
2328: my %temphash=($entry => $value);
2329: if (&put('nohist_resevaldata',\%temphash,$dom,$name) eq 'ok') {
2330: delete $accesshash{$entry};
2331: }
2332: }
2333: } else {
2334: my ($dom,$name) = ($entry=~m{___($match_domain)/($match_name)/(.*)___(\w+)$});
2335: my %temphash=($entry => $accesshash{$entry});
2336: if (&put('nohist_resevaldata',\%temphash,$dom,$name) eq 'ok') {
2337: delete $accesshash{$entry};
2338: }
2339: }
2340: }
2341: #
2342: # Roles
2343: # Reverse lookup of user roles for course faculty/staff and co-authorship
2344: #
2345: foreach my $entry (keys(%userrolehash)) {
2346: my ($role,$uname,$udom,$runame,$rudom,$rsec)=
2347: split(/\:/,$entry);
2348: if (&Apache::lonnet::put('nohist_userroles',
2349: { $role.':'.$uname.':'.$udom.':'.$rsec => $userrolehash{$entry} },
2350: $rudom,$runame) eq 'ok') {
2351: delete $userrolehash{$entry};
2352: }
2353: }
2354: #
2355: # Reverse lookup of domain roles (dc, ad, li, sc, au)
2356: #
2357: my %domrolebuffer = ();
2358: foreach my $entry (keys %domainrolehash) {
2359: my ($role,$uname,$udom,$runame,$rudom,$rsec)=split(/:/,$entry);
2360: if ($domrolebuffer{$rudom}) {
2361: $domrolebuffer{$rudom}.='&'.&escape($entry).
2362: '='.&escape($domainrolehash{$entry});
2363: } else {
2364: $domrolebuffer{$rudom}.=&escape($entry).
2365: '='.&escape($domainrolehash{$entry});
2366: }
2367: delete $domainrolehash{$entry};
2368: }
2369: foreach my $dom (keys(%domrolebuffer)) {
2370: my %servers = &get_servers($dom,'library');
2371: foreach my $tryserver (keys(%servers)) {
2372: unless (&reply('domroleput:'.$dom.':'.
2373: $domrolebuffer{$dom},$tryserver) eq 'ok') {
2374: &logthis('Put of domain roles failed for '.$dom.' and '.$tryserver);
2375: }
2376: }
2377: }
2378: $dumpcount++;
2379: }
2380:
2381: sub courselog {
2382: my $what=shift;
2383: $what=time.':'.$what;
2384: unless ($env{'request.course.id'}) { return ''; }
2385: $coursedombuf{$env{'request.course.id'}}=
2386: $env{'course.'.$env{'request.course.id'}.'.domain'};
2387: $coursenumbuf{$env{'request.course.id'}}=
2388: $env{'course.'.$env{'request.course.id'}.'.num'};
2389: $coursehombuf{$env{'request.course.id'}}=
2390: $env{'course.'.$env{'request.course.id'}.'.home'};
2391: $coursedescrbuf{$env{'request.course.id'}}=
2392: $env{'course.'.$env{'request.course.id'}.'.description'};
2393: $courseinstcodebuf{$env{'request.course.id'}}=
2394: $env{'course.'.$env{'request.course.id'}.'.internal.coursecode'};
2395: $courseownerbuf{$env{'request.course.id'}}=
2396: $env{'course.'.$env{'request.course.id'}.'.internal.courseowner'};
2397: $coursetypebuf{$env{'request.course.id'}}=
2398: $env{'course.'.$env{'request.course.id'}.'.type'};
2399: if (defined $courselogs{$env{'request.course.id'}}) {
2400: $courselogs{$env{'request.course.id'}}.='&'.$what;
2401: } else {
2402: $courselogs{$env{'request.course.id'}}.=$what;
2403: }
2404: if (length($courselogs{$env{'request.course.id'}})>4048) {
2405: &flushcourselogs();
2406: }
2407: }
2408:
2409: sub courseacclog {
2410: my $fnsymb=shift;
2411: unless ($env{'request.course.id'}) { return ''; }
2412: my $what=$fnsymb.':'.$env{'user.name'}.':'.$env{'user.domain'};
2413: if ($fnsymb=~/(problem|exam|quiz|assess|survey|form|task|page)$/) {
2414: $what.=':POST';
2415: # FIXME: Probably ought to escape things....
2416: foreach my $key (keys(%env)) {
2417: if ($key=~/^form\.(.*)/) {
2418: $what.=':'.$1.'='.$env{$key};
2419: }
2420: }
2421: } elsif ($fnsymb =~ m:^/adm/searchcat:) {
2422: # FIXME: We should not be depending on a form parameter that someone
2423: # editing lonsearchcat.pm might change in the future.
2424: if ($env{'form.phase'} eq 'course_search') {
2425: $what.= ':POST';
2426: # FIXME: Probably ought to escape things....
2427: foreach my $element ('courseexp','crsfulltext','crsrelated',
2428: 'crsdiscuss') {
2429: $what.=':'.$element.'='.$env{'form.'.$element};
2430: }
2431: }
2432: }
2433: &courselog($what);
2434: }
2435:
2436: sub countacc {
2437: my $url=&declutter(shift);
2438: return if (! defined($url) || $url eq '');
2439: unless ($env{'request.course.id'}) { return ''; }
2440: $accesshash{$env{'request.course.id'}.'___'.$url.'___course'}=1;
2441: my $key=$$.$processmarker.'_'.$dumpcount.'___'.$url.'___count';
2442: $accesshash{$key}++;
2443: }
2444:
2445: sub linklog {
2446: my ($from,$to)=@_;
2447: $from=&declutter($from);
2448: $to=&declutter($to);
2449: $accesshash{$from.'___'.$to.'___comefrom'}=1;
2450: $accesshash{$to.'___'.$from.'___goto'}=1;
2451: }
2452:
2453: sub userrolelog {
2454: my ($trole,$username,$domain,$area,$tstart,$tend)=@_;
2455: if (($trole=~/^ca/) || ($trole=~/^aa/) ||
2456: ($trole=~/^in/) || ($trole=~/^cc/) ||
2457: ($trole=~/^ep/) || ($trole=~/^cr/) ||
2458: ($trole=~/^ta/)) {
2459: my (undef,$rudom,$runame,$rsec)=split(/\//,$area);
2460: $userrolehash
2461: {$trole.':'.$username.':'.$domain.':'.$runame.':'.$rudom.':'.$rsec}
2462: =$tend.':'.$tstart;
2463: }
2464: if (($env{'request.role'} =~ /dc\./) &&
2465: (($trole=~/^au/) || ($trole=~/^in/) ||
2466: ($trole=~/^cc/) || ($trole=~/^ep/) ||
2467: ($trole=~/^cr/) || ($trole=~/^ta/))) {
2468: $userrolehash
2469: {$trole.':'.$username.':'.$domain.':'.$env{'user.name'}.':'.$env{'user.domain'}.':'}
2470: =$tend.':'.$tstart;
2471: }
2472: if (($trole=~/^dc/) || ($trole=~/^ad/) ||
2473: ($trole=~/^li/) || ($trole=~/^li/) ||
2474: ($trole=~/^au/) || ($trole=~/^dg/) ||
2475: ($trole=~/^sc/)) {
2476: my (undef,$rudom,$runame,$rsec)=split(/\//,$area);
2477: $domainrolehash
2478: {$trole.':'.$username.':'.$domain.':'.$runame.':'.$rudom.':'.$rsec}
2479: = $tend.':'.$tstart;
2480: }
2481: }
2482:
2483: sub get_course_adv_roles {
2484: my ($cid,$codes) = @_;
2485: $cid=$env{'request.course.id'} unless (defined($cid));
2486: my %coursehash=&coursedescription($cid);
2487: my %nothide=();
2488: foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
2489: if ($user !~ /:/) {
2490: $nothide{join(':',split(/[\@]/,$user))}=1;
2491: } else {
2492: $nothide{$user}=1;
2493: }
2494: }
2495: my %returnhash=();
2496: my %dumphash=
2497: &dump('nohist_userroles',$coursehash{'domain'},$coursehash{'num'});
2498: my $now=time;
2499: foreach my $entry (keys %dumphash) {
2500: my ($tend,$tstart)=split(/\:/,$dumphash{$entry});
2501: if (($tstart) && ($tstart<0)) { next; }
2502: if (($tend) && ($tend<$now)) { next; }
2503: if (($tstart) && ($now<$tstart)) { next; }
2504: my ($role,$username,$domain,$section)=split(/\:/,$entry);
2505: if ($username eq '' || $domain eq '') { next; }
2506: if ((&privileged($username,$domain)) &&
2507: (!$nothide{$username.':'.$domain})) { next; }
2508: if ($role eq 'cr') { next; }
2509: if ($codes) {
2510: if ($section) { $role .= ':'.$section; }
2511: if ($returnhash{$role}) {
2512: $returnhash{$role}.=','.$username.':'.$domain;
2513: } else {
2514: $returnhash{$role}=$username.':'.$domain;
2515: }
2516: } else {
2517: my $key=&plaintext($role);
2518: if ($section) { $key.=' (Section '.$section.')'; }
2519: if ($returnhash{$key}) {
2520: $returnhash{$key}.=','.$username.':'.$domain;
2521: } else {
2522: $returnhash{$key}=$username.':'.$domain;
2523: }
2524: }
2525: }
2526: return %returnhash;
2527: }
2528:
2529: sub get_my_roles {
2530: my ($uname,$udom,$context,$types,$roles,$roledoms,$withsec,$hidepriv)=@_;
2531: unless (defined($uname)) { $uname=$env{'user.name'}; }
2532: unless (defined($udom)) { $udom=$env{'user.domain'}; }
2533: my (%dumphash,%nothide);
2534: if ($context eq 'userroles') {
2535: %dumphash = &dump('roles',$udom,$uname);
2536: } else {
2537: %dumphash=
2538: &dump('nohist_userroles',$udom,$uname);
2539: if ($hidepriv) {
2540: my %coursehash=&coursedescription($udom.'_'.$uname);
2541: foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
2542: if ($user !~ /:/) {
2543: $nothide{join(':',split(/[\@]/,$user))} = 1;
2544: } else {
2545: $nothide{$user} = 1;
2546: }
2547: }
2548: }
2549: }
2550: my %returnhash=();
2551: my $now=time;
2552: foreach my $entry (keys(%dumphash)) {
2553: my ($role,$tend,$tstart);
2554: if ($context eq 'userroles') {
2555: ($role,$tend,$tstart)=split(/_/,$dumphash{$entry});
2556: } else {
2557: ($tend,$tstart)=split(/\:/,$dumphash{$entry});
2558: }
2559: if (($tstart) && ($tstart<0)) { next; }
2560: my $status = 'active';
2561: if (($tend) && ($tend<=$now)) {
2562: $status = 'previous';
2563: }
2564: if (($tstart) && ($now<$tstart)) {
2565: $status = 'future';
2566: }
2567: if (ref($types) eq 'ARRAY') {
2568: if (!grep(/^\Q$status\E$/,@{$types})) {
2569: next;
2570: }
2571: } else {
2572: if ($status ne 'active') {
2573: next;
2574: }
2575: }
2576: my ($rolecode,$username,$domain,$section,$area);
2577: if ($context eq 'userroles') {
2578: ($area,$rolecode) = split(/_/,$entry);
2579: (undef,$domain,$username,$section) = split(/\//,$area);
2580: } else {
2581: ($role,$username,$domain,$section) = split(/\:/,$entry);
2582: }
2583: if (ref($roledoms) eq 'ARRAY') {
2584: if (!grep(/^\Q$domain\E$/,@{$roledoms})) {
2585: next;
2586: }
2587: }
2588: if (ref($roles) eq 'ARRAY') {
2589: if (!grep(/^\Q$role\E$/,@{$roles})) {
2590: if ($role =~ /^cr\//) {
2591: if (!grep(/^cr$/,@{$roles})) {
2592: next;
2593: }
2594: } else {
2595: next;
2596: }
2597: }
2598: }
2599: if ($hidepriv) {
2600: if ((&privileged($username,$domain)) &&
2601: (!$nothide{$username.':'.$domain})) {
2602: next;
2603: }
2604: }
2605: if ($withsec) {
2606: $returnhash{$username.':'.$domain.':'.$role.':'.$section} =
2607: $tstart.':'.$tend;
2608: } else {
2609: $returnhash{$username.':'.$domain.':'.$role}=$tstart.':'.$tend;
2610: }
2611: }
2612: return %returnhash;
2613: }
2614:
2615: # ----------------------------------------------------- Frontpage Announcements
2616: #
2617: #
2618:
2619: sub postannounce {
2620: my ($server,$text)=@_;
2621: unless (&allowed('psa',&host_domain($server))) { return 'refused'; }
2622: unless ($text=~/\w/) { $text=''; }
2623: return &reply('setannounce:'.&escape($text),$server);
2624: }
2625:
2626: sub getannounce {
2627:
2628: if (open(my $fh,$perlvar{'lonDocRoot'}.'/announcement.txt')) {
2629: my $announcement='';
2630: while (my $line = <$fh>) { $announcement .= $line; }
2631: close($fh);
2632: if ($announcement=~/\w/) {
2633: return
2634: '<table bgcolor="#FF5555" cellpadding="5" cellspacing="3">'.
2635: '<tr><td bgcolor="#FFFFFF"><tt>'.$announcement.'</tt></td></tr></table>';
2636: } else {
2637: return '';
2638: }
2639: } else {
2640: return '';
2641: }
2642: }
2643:
2644: # ---------------------------------------------------------- Course ID routines
2645: # Deal with domain's nohist_courseid.db files
2646: #
2647:
2648: sub courseidput {
2649: my ($domain,$storehash,$coursehome,$caller) = @_;
2650: my $outcome;
2651: if ($caller eq 'timeonly') {
2652: my $cids = '';
2653: foreach my $item (keys(%$storehash)) {
2654: $cids.=&escape($item).'&';
2655: }
2656: $cids=~s/\&$//;
2657: $outcome = &reply('courseidputhash:'.$domain.':'.$caller.':'.$cids,
2658: $coursehome);
2659: } else {
2660: my $items = '';
2661: foreach my $item (keys(%$storehash)) {
2662: $items.= &escape($item).'='.
2663: &freeze_escape($$storehash{$item}).'&';
2664: }
2665: $items=~s/\&$//;
2666: $outcome = &reply('courseidputhash:'.$domain.':'.$caller.':'.$items,
2667: $coursehome);
2668: }
2669: if ($outcome eq 'unknown_cmd') {
2670: my $what;
2671: foreach my $cid (keys(%$storehash)) {
2672: $what .= &escape($cid).'=';
2673: foreach my $item ('description','inst_code','owner','type') {
2674: $what .= &escape($storehash->{$cid}{$item}).':';
2675: }
2676: $what =~ s/\:$/&/;
2677: }
2678: $what =~ s/\&$//;
2679: return &reply('courseidput:'.$domain.':'.$what,$coursehome);
2680: } else {
2681: return $outcome;
2682: }
2683: }
2684:
2685: sub courseiddump {
2686: my ($domfilter,$descfilter,$sincefilter,$instcodefilter,$ownerfilter,
2687: $coursefilter,$hostidflag,$hostidref,$typefilter,$regexp_ok,
2688: $selfenrollonly)=@_;
2689: my $as_hash = 1;
2690: my %returnhash;
2691: if (!$domfilter) { $domfilter=''; }
2692: my %libserv = &all_library();
2693: foreach my $tryserver (keys(%libserv)) {
2694: if ( ( $hostidflag == 1
2695: && grep(/^\Q$tryserver\E$/,@{$hostidref}) )
2696: || (!defined($hostidflag)) ) {
2697:
2698: if (($domfilter eq '') ||
2699: (&host_domain($tryserver) eq $domfilter)) {
2700: my $rep =
2701: &reply('courseiddump:'.&host_domain($tryserver).':'.
2702: $sincefilter.':'.&escape($descfilter).':'.
2703: &escape($instcodefilter).':'.&escape($ownerfilter).
2704: ':'.&escape($coursefilter).':'.&escape($typefilter).
2705: ':'.&escape($regexp_ok).':'.$as_hash.':'.
2706: &escape($selfenrollonly),$tryserver);
2707: my @pairs=split(/\&/,$rep);
2708: foreach my $item (@pairs) {
2709: my ($key,$value)=split(/\=/,$item,2);
2710: $key = &unescape($key);
2711: next if ($key =~ /^error: 2 /);
2712: my $result = &thaw_unescape($value);
2713: if (ref($result) eq 'HASH') {
2714: $returnhash{$key}=$result;
2715: } else {
2716: my @responses = split(/:/,$value);
2717: my @items = ('description','inst_code','owner','type');
2718: for (my $i=0; $i<@responses; $i++) {
2719: $returnhash{$key}{$items[$i]} = &unescape($responses[$i]);
2720: }
2721: }
2722: }
2723: }
2724: }
2725: }
2726: return %returnhash;
2727: }
2728:
2729: # ---------------------------------------------------------- DC e-mail
2730:
2731: sub dcmailput {
2732: my ($domain,$msgid,$message,$server)=@_;
2733: my $status = &Apache::lonnet::critical(
2734: 'dcmailput:'.$domain.':'.&escape($msgid).'='.
2735: &escape($message),$server);
2736: return $status;
2737: }
2738:
2739: sub dcmaildump {
2740: my ($dom,$startdate,$enddate,$senders) = @_;
2741: my %returnhash=();
2742:
2743: if (defined(&domain($dom,'primary'))) {
2744: my $cmd='dcmaildump:'.$dom.':'.&escape($startdate).':'.
2745: &escape($enddate).':';
2746: my @esc_senders=map { &escape($_)} @$senders;
2747: $cmd.=&escape(join('&',@esc_senders));
2748: foreach my $line (split(/\&/,&reply($cmd,&domain($dom,'primary')))) {
2749: my ($key,$value) = split(/\=/,$line,2);
2750: if (($key) && ($value)) {
2751: $returnhash{&unescape($key)} = &unescape($value);
2752: }
2753: }
2754: }
2755: return %returnhash;
2756: }
2757: # ---------------------------------------------------------- Domain roles
2758:
2759: sub get_domain_roles {
2760: my ($dom,$roles,$startdate,$enddate)=@_;
2761: if (undef($startdate) || $startdate eq '') {
2762: $startdate = '.';
2763: }
2764: if (undef($enddate) || $enddate eq '') {
2765: $enddate = '.';
2766: }
2767: my $rolelist;
2768: if (ref($roles) eq 'ARRAY') {
2769: $rolelist = join(':',@{$roles});
2770: }
2771: my %personnel = ();
2772:
2773: my %servers = &get_servers($dom,'library');
2774: foreach my $tryserver (keys(%servers)) {
2775: %{$personnel{$tryserver}}=();
2776: foreach my $line (split(/\&/,&reply('domrolesdump:'.$dom.':'.
2777: &escape($startdate).':'.
2778: &escape($enddate).':'.
2779: &escape($rolelist), $tryserver))) {
2780: my ($key,$value) = split(/\=/,$line,2);
2781: if (($key) && ($value)) {
2782: $personnel{$tryserver}{&unescape($key)} = &unescape($value);
2783: }
2784: }
2785: }
2786: return %personnel;
2787: }
2788:
2789: # ----------------------------------------------------------- Check out an item
2790:
2791: sub get_first_access {
2792: my ($type,$argsymb)=@_;
2793: my ($symb,$courseid,$udom,$uname)=&whichuser();
2794: if ($argsymb) { $symb=$argsymb; }
2795: my ($map,$id,$res)=&decode_symb($symb);
2796: if ($type eq 'course') {
2797: $res='course';
2798: } elsif ($type eq 'map') {
2799: $res=&symbread($map);
2800: } else {
2801: $res=$symb;
2802: }
2803: my %times=&get('firstaccesstimes',["$courseid\0$res"],$udom,$uname);
2804: return $times{"$courseid\0$res"};
2805: }
2806:
2807: sub set_first_access {
2808: my ($type)=@_;
2809: my ($symb,$courseid,$udom,$uname)=&whichuser();
2810: my ($map,$id,$res)=&decode_symb($symb);
2811: if ($type eq 'course') {
2812: $res='course';
2813: } elsif ($type eq 'map') {
2814: $res=&symbread($map);
2815: } else {
2816: $res=$symb;
2817: }
2818: my $firstaccess=&get_first_access($type,$symb);
2819: if (!$firstaccess) {
2820: return &put('firstaccesstimes',{"$courseid\0$res"=>time},$udom,$uname);
2821: }
2822: return 'already_set';
2823: }
2824:
2825: sub checkout {
2826: my ($symb,$tuname,$tudom,$tcrsid)=@_;
2827: my $now=time;
2828: my $lonhost=$perlvar{'lonHostID'};
2829: my $infostr=&escape(
2830: 'CHECKOUTTOKEN&'.
2831: $tuname.'&'.
2832: $tudom.'&'.
2833: $tcrsid.'&'.
2834: $symb.'&'.
2835: $now.'&'.$ENV{'REMOTE_ADDR'});
2836: my $token=&reply('tmpput:'.$infostr,$lonhost);
2837: if ($token=~/^error\:/) {
2838: &logthis("<font color=\"blue\">WARNING: ".
2839: "Checkout tmpput failed ".$tudom.' - '.$tuname.' - '.$symb.
2840: "</font>");
2841: return '';
2842: }
2843:
2844: $token=~s/^(\d+)\_.*\_(\d+)$/$1\*$2\*$lonhost/;
2845: $token=~tr/a-z/A-Z/;
2846:
2847: my %infohash=('resource.0.outtoken' => $token,
2848: 'resource.0.checkouttime' => $now,
2849: 'resource.0.outremote' => $ENV{'REMOTE_ADDR'});
2850:
2851: unless (&cstore(\%infohash,$symb,$tcrsid,$tudom,$tuname) eq 'ok') {
2852: return '';
2853: } else {
2854: &logthis("<font color=\"blue\">WARNING: ".
2855: "Checkout cstore failed ".$tudom.' - '.$tuname.' - '.$symb.
2856: "</font>");
2857: }
2858:
2859: if (&log($tudom,$tuname,&homeserver($tuname,$tudom),
2860: &escape('Checkout '.$infostr.' - '.
2861: $token)) ne 'ok') {
2862: return '';
2863: } else {
2864: &logthis("<font color=\"blue\">WARNING: ".
2865: "Checkout log failed ".$tudom.' - '.$tuname.' - '.$symb.
2866: "</font>");
2867: }
2868: return $token;
2869: }
2870:
2871: # ------------------------------------------------------------ Check in an item
2872:
2873: sub checkin {
2874: my $token=shift;
2875: my $now=time;
2876: my ($ta,$tb,$lonhost)=split(/\*/,$token);
2877: $lonhost=~tr/A-Z/a-z/;
2878: my $dtoken=$ta.'_'.&hostname($lonhost).'_'.$tb;
2879: $dtoken=~s/\W/\_/g;
2880: my ($dummy,$tuname,$tudom,$tcrsid,$symb,$chtim,$rmaddr)=
2881: split(/\&/,&unescape(&reply('tmpget:'.$dtoken,$lonhost)));
2882:
2883: unless (($tuname) && ($tudom)) {
2884: &logthis('Check in '.$token.' ('.$dtoken.') failed');
2885: return '';
2886: }
2887:
2888: unless (&allowed('mgr',$tcrsid)) {
2889: &logthis('Check in '.$token.' ('.$dtoken.') unauthorized: '.
2890: $env{'user.name'}.' - '.$env{'user.domain'});
2891: return '';
2892: }
2893:
2894: my %infohash=('resource.0.intoken' => $token,
2895: 'resource.0.checkintime' => $now,
2896: 'resource.0.inremote' => $ENV{'REMOTE_ADDR'});
2897:
2898: unless (&cstore(\%infohash,$symb,$tcrsid,$tudom,$tuname) eq 'ok') {
2899: return '';
2900: }
2901:
2902: if (&log($tudom,$tuname,&homeserver($tuname,$tudom),
2903: &escape('Checkin - '.$token)) ne 'ok') {
2904: return '';
2905: }
2906:
2907: return ($symb,$tuname,$tudom,$tcrsid);
2908: }
2909:
2910: # --------------------------------------------- Set Expire Date for Spreadsheet
2911:
2912: sub expirespread {
2913: my ($uname,$udom,$stype,$usymb)=@_;
2914: my $cid=$env{'request.course.id'};
2915: if ($cid) {
2916: my $now=time;
2917: my $key=$uname.':'.$udom.':'.$stype.':'.$usymb;
2918: return &reply('put:'.$env{'course.'.$cid.'.domain'}.':'.
2919: $env{'course.'.$cid.'.num'}.
2920: ':nohist_expirationdates:'.
2921: &escape($key).'='.$now,
2922: $env{'course.'.$cid.'.home'})
2923: }
2924: return 'ok';
2925: }
2926:
2927: # ----------------------------------------------------- Devalidate Spreadsheets
2928:
2929: sub devalidate {
2930: my ($symb,$uname,$udom)=@_;
2931: my $cid=$env{'request.course.id'};
2932: if ($cid) {
2933: # delete the stored spreadsheets for
2934: # - the student level sheet of this user in course's homespace
2935: # - the assessment level sheet for this resource
2936: # for this user in user's homespace
2937: # - current conditional state info
2938: my $key=$uname.':'.$udom.':';
2939: my $status=
2940: &del('nohist_calculatedsheets',
2941: [$key.'studentcalc:'],
2942: $env{'course.'.$cid.'.domain'},
2943: $env{'course.'.$cid.'.num'})
2944: .' '.
2945: &del('nohist_calculatedsheets_'.$cid,
2946: [$key.'assesscalc:'.$symb],$udom,$uname);
2947: unless ($status eq 'ok ok') {
2948: &logthis('Could not devalidate spreadsheet '.
2949: $uname.' at '.$udom.' for '.
2950: $symb.': '.$status);
2951: }
2952: &delenv('user.state.'.$cid);
2953: }
2954: }
2955:
2956: sub get_scalar {
2957: my ($string,$end) = @_;
2958: my $value;
2959: if ($$string =~ s/^([^&]*?)($end)/$2/) {
2960: $value = $1;
2961: } elsif ($$string =~ s/^([^&]*?)&//) {
2962: $value = $1;
2963: }
2964: return &unescape($value);
2965: }
2966:
2967: sub array2str {
2968: my (@array) = @_;
2969: my $result=&arrayref2str(\@array);
2970: $result=~s/^__ARRAY_REF__//;
2971: $result=~s/__END_ARRAY_REF__$//;
2972: return $result;
2973: }
2974:
2975: sub arrayref2str {
2976: my ($arrayref) = @_;
2977: my $result='__ARRAY_REF__';
2978: foreach my $elem (@$arrayref) {
2979: if(ref($elem) eq 'ARRAY') {
2980: $result.=&arrayref2str($elem).'&';
2981: } elsif(ref($elem) eq 'HASH') {
2982: $result.=&hashref2str($elem).'&';
2983: } elsif(ref($elem)) {
2984: #print("Got a ref of ".(ref($elem))." skipping.");
2985: } else {
2986: $result.=&escape($elem).'&';
2987: }
2988: }
2989: $result=~s/\&$//;
2990: $result .= '__END_ARRAY_REF__';
2991: return $result;
2992: }
2993:
2994: sub hash2str {
2995: my (%hash) = @_;
2996: my $result=&hashref2str(\%hash);
2997: $result=~s/^__HASH_REF__//;
2998: $result=~s/__END_HASH_REF__$//;
2999: return $result;
3000: }
3001:
3002: sub hashref2str {
3003: my ($hashref)=@_;
3004: my $result='__HASH_REF__';
3005: foreach my $key (sort(keys(%$hashref))) {
3006: if (ref($key) eq 'ARRAY') {
3007: $result.=&arrayref2str($key).'=';
3008: } elsif (ref($key) eq 'HASH') {
3009: $result.=&hashref2str($key).'=';
3010: } elsif (ref($key)) {
3011: $result.='=';
3012: #print("Got a ref of ".(ref($key))." skipping.");
3013: } else {
3014: if ($key) {$result.=&escape($key).'=';} else { last; }
3015: }
3016:
3017: if(ref($hashref->{$key}) eq 'ARRAY') {
3018: $result.=&arrayref2str($hashref->{$key}).'&';
3019: } elsif(ref($hashref->{$key}) eq 'HASH') {
3020: $result.=&hashref2str($hashref->{$key}).'&';
3021: } elsif(ref($hashref->{$key})) {
3022: $result.='&';
3023: #print("Got a ref of ".(ref($hashref->{$key}))." skipping.");
3024: } else {
3025: $result.=&escape($hashref->{$key}).'&';
3026: }
3027: }
3028: $result=~s/\&$//;
3029: $result .= '__END_HASH_REF__';
3030: return $result;
3031: }
3032:
3033: sub str2hash {
3034: my ($string)=@_;
3035: my ($hash)=&str2hashref('__HASH_REF__'.$string.'__END_HASH_REF__');
3036: return %$hash;
3037: }
3038:
3039: sub str2hashref {
3040: my ($string) = @_;
3041:
3042: my %hash;
3043:
3044: if($string !~ /^__HASH_REF__/) {
3045: if (! ($string eq '' || !defined($string))) {
3046: $hash{'error'}='Not hash reference';
3047: }
3048: return (\%hash, $string);
3049: }
3050:
3051: $string =~ s/^__HASH_REF__//;
3052:
3053: while($string !~ /^__END_HASH_REF__/) {
3054: #key
3055: my $key='';
3056: if($string =~ /^__HASH_REF__/) {
3057: ($key, $string)=&str2hashref($string);
3058: if(defined($key->{'error'})) {
3059: $hash{'error'}='Bad data';
3060: return (\%hash, $string);
3061: }
3062: } elsif($string =~ /^__ARRAY_REF__/) {
3063: ($key, $string)=&str2arrayref($string);
3064: if($key->[0] eq 'Array reference error') {
3065: $hash{'error'}='Bad data';
3066: return (\%hash, $string);
3067: }
3068: } else {
3069: $string =~ s/^(.*?)=//;
3070: $key=&unescape($1);
3071: }
3072: $string =~ s/^=//;
3073:
3074: #value
3075: my $value='';
3076: if($string =~ /^__HASH_REF__/) {
3077: ($value, $string)=&str2hashref($string);
3078: if(defined($value->{'error'})) {
3079: $hash{'error'}='Bad data';
3080: return (\%hash, $string);
3081: }
3082: } elsif($string =~ /^__ARRAY_REF__/) {
3083: ($value, $string)=&str2arrayref($string);
3084: if($value->[0] eq 'Array reference error') {
3085: $hash{'error'}='Bad data';
3086: return (\%hash, $string);
3087: }
3088: } else {
3089: $value=&get_scalar(\$string,'__END_HASH_REF__');
3090: }
3091: $string =~ s/^&//;
3092:
3093: $hash{$key}=$value;
3094: }
3095:
3096: $string =~ s/^__END_HASH_REF__//;
3097:
3098: return (\%hash, $string);
3099: }
3100:
3101: sub str2array {
3102: my ($string)=@_;
3103: my ($array)=&str2arrayref('__ARRAY_REF__'.$string.'__END_ARRAY_REF__');
3104: return @$array;
3105: }
3106:
3107: sub str2arrayref {
3108: my ($string) = @_;
3109: my @array;
3110:
3111: if($string !~ /^__ARRAY_REF__/) {
3112: if (! ($string eq '' || !defined($string))) {
3113: $array[0]='Array reference error';
3114: }
3115: return (\@array, $string);
3116: }
3117:
3118: $string =~ s/^__ARRAY_REF__//;
3119:
3120: while($string !~ /^__END_ARRAY_REF__/) {
3121: my $value='';
3122: if($string =~ /^__HASH_REF__/) {
3123: ($value, $string)=&str2hashref($string);
3124: if(defined($value->{'error'})) {
3125: $array[0] ='Array reference error';
3126: return (\@array, $string);
3127: }
3128: } elsif($string =~ /^__ARRAY_REF__/) {
3129: ($value, $string)=&str2arrayref($string);
3130: if($value->[0] eq 'Array reference error') {
3131: $array[0] ='Array reference error';
3132: return (\@array, $string);
3133: }
3134: } else {
3135: $value=&get_scalar(\$string,'__END_ARRAY_REF__');
3136: }
3137: $string =~ s/^&//;
3138:
3139: push(@array, $value);
3140: }
3141:
3142: $string =~ s/^__END_ARRAY_REF__//;
3143:
3144: return (\@array, $string);
3145: }
3146:
3147: # -------------------------------------------------------------------Temp Store
3148:
3149: sub tmpreset {
3150: my ($symb,$namespace,$domain,$stuname) = @_;
3151: if (!$symb) {
3152: $symb=&symbread();
3153: if (!$symb) { $symb= $env{'request.url'}; }
3154: }
3155: $symb=escape($symb);
3156:
3157: if (!$namespace) { $namespace=$env{'request.state'}; }
3158: $namespace=~s/\//\_/g;
3159: $namespace=~s/\W//g;
3160:
3161: if (!$domain) { $domain=$env{'user.domain'}; }
3162: if (!$stuname) { $stuname=$env{'user.name'}; }
3163: if ($domain eq 'public' && $stuname eq 'public') {
3164: $stuname=$ENV{'REMOTE_ADDR'};
3165: }
3166: my $path=$perlvar{'lonDaemons'}.'/tmp';
3167: my %hash;
3168: if (tie(%hash,'GDBM_File',
3169: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
3170: &GDBM_WRCREAT(),0640)) {
3171: foreach my $key (keys %hash) {
3172: if ($key=~ /:$symb/) {
3173: delete($hash{$key});
3174: }
3175: }
3176: }
3177: }
3178:
3179: sub tmpstore {
3180: my ($storehash,$symb,$namespace,$domain,$stuname) = @_;
3181:
3182: if (!$symb) {
3183: $symb=&symbread();
3184: if (!$symb) { $symb= $env{'request.url'}; }
3185: }
3186: $symb=escape($symb);
3187:
3188: if (!$namespace) {
3189: # I don't think we would ever want to store this for a course.
3190: # it seems this will only be used if we don't have a course.
3191: #$namespace=$env{'request.course.id'};
3192: #if (!$namespace) {
3193: $namespace=$env{'request.state'};
3194: #}
3195: }
3196: $namespace=~s/\//\_/g;
3197: $namespace=~s/\W//g;
3198: if (!$domain) { $domain=$env{'user.domain'}; }
3199: if (!$stuname) { $stuname=$env{'user.name'}; }
3200: if ($domain eq 'public' && $stuname eq 'public') {
3201: $stuname=$ENV{'REMOTE_ADDR'};
3202: }
3203: my $now=time;
3204: my %hash;
3205: my $path=$perlvar{'lonDaemons'}.'/tmp';
3206: if (tie(%hash,'GDBM_File',
3207: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
3208: &GDBM_WRCREAT(),0640)) {
3209: $hash{"version:$symb"}++;
3210: my $version=$hash{"version:$symb"};
3211: my $allkeys='';
3212: foreach my $key (keys(%$storehash)) {
3213: $allkeys.=$key.':';
3214: $hash{"$version:$symb:$key"}=&freeze_escape($$storehash{$key});
3215: }
3216: $hash{"$version:$symb:timestamp"}=$now;
3217: $allkeys.='timestamp';
3218: $hash{"$version:keys:$symb"}=$allkeys;
3219: if (untie(%hash)) {
3220: return 'ok';
3221: } else {
3222: return "error:$!";
3223: }
3224: } else {
3225: return "error:$!";
3226: }
3227: }
3228:
3229: # -----------------------------------------------------------------Temp Restore
3230:
3231: sub tmprestore {
3232: my ($symb,$namespace,$domain,$stuname) = @_;
3233:
3234: if (!$symb) {
3235: $symb=&symbread();
3236: if (!$symb) { $symb= $env{'request.url'}; }
3237: }
3238: $symb=escape($symb);
3239:
3240: if (!$namespace) { $namespace=$env{'request.state'}; }
3241:
3242: if (!$domain) { $domain=$env{'user.domain'}; }
3243: if (!$stuname) { $stuname=$env{'user.name'}; }
3244: if ($domain eq 'public' && $stuname eq 'public') {
3245: $stuname=$ENV{'REMOTE_ADDR'};
3246: }
3247: my %returnhash;
3248: $namespace=~s/\//\_/g;
3249: $namespace=~s/\W//g;
3250: my %hash;
3251: my $path=$perlvar{'lonDaemons'}.'/tmp';
3252: if (tie(%hash,'GDBM_File',
3253: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
3254: &GDBM_READER(),0640)) {
3255: my $version=$hash{"version:$symb"};
3256: $returnhash{'version'}=$version;
3257: my $scope;
3258: for ($scope=1;$scope<=$version;$scope++) {
3259: my $vkeys=$hash{"$scope:keys:$symb"};
3260: my @keys=split(/:/,$vkeys);
3261: my $key;
3262: $returnhash{"$scope:keys"}=$vkeys;
3263: foreach $key (@keys) {
3264: $returnhash{"$scope:$key"}=&thaw_unescape($hash{"$scope:$symb:$key"});
3265: $returnhash{"$key"}=&thaw_unescape($hash{"$scope:$symb:$key"});
3266: }
3267: }
3268: if (!(untie(%hash))) {
3269: return "error:$!";
3270: }
3271: } else {
3272: return "error:$!";
3273: }
3274: return %returnhash;
3275: }
3276:
3277: # ----------------------------------------------------------------------- Store
3278:
3279: sub store {
3280: my ($storehash,$symb,$namespace,$domain,$stuname) = @_;
3281: my $home='';
3282:
3283: if ($stuname) { $home=&homeserver($stuname,$domain); }
3284:
3285: $symb=&symbclean($symb);
3286: if (!$symb) { unless ($symb=&symbread()) { return ''; } }
3287:
3288: if (!$domain) { $domain=$env{'user.domain'}; }
3289: if (!$stuname) { $stuname=$env{'user.name'}; }
3290:
3291: &devalidate($symb,$stuname,$domain);
3292:
3293: $symb=escape($symb);
3294: if (!$namespace) {
3295: unless ($namespace=$env{'request.course.id'}) {
3296: return '';
3297: }
3298: }
3299: if (!$home) { $home=$env{'user.home'}; }
3300:
3301: $$storehash{'ip'}=$ENV{'REMOTE_ADDR'};
3302: $$storehash{'host'}=$perlvar{'lonHostID'};
3303:
3304: my $namevalue='';
3305: foreach my $key (keys(%$storehash)) {
3306: $namevalue.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
3307: }
3308: $namevalue=~s/\&$//;
3309: &courselog($symb.':'.$stuname.':'.$domain.':STORE:'.$namevalue);
3310: return reply("store:$domain:$stuname:$namespace:$symb:$namevalue","$home");
3311: }
3312:
3313: # -------------------------------------------------------------- Critical Store
3314:
3315: sub cstore {
3316: my ($storehash,$symb,$namespace,$domain,$stuname) = @_;
3317: my $home='';
3318:
3319: if ($stuname) { $home=&homeserver($stuname,$domain); }
3320:
3321: $symb=&symbclean($symb);
3322: if (!$symb) { unless ($symb=&symbread()) { return ''; } }
3323:
3324: if (!$domain) { $domain=$env{'user.domain'}; }
3325: if (!$stuname) { $stuname=$env{'user.name'}; }
3326:
3327: &devalidate($symb,$stuname,$domain);
3328:
3329: $symb=escape($symb);
3330: if (!$namespace) {
3331: unless ($namespace=$env{'request.course.id'}) {
3332: return '';
3333: }
3334: }
3335: if (!$home) { $home=$env{'user.home'}; }
3336:
3337: $$storehash{'ip'}=$ENV{'REMOTE_ADDR'};
3338: $$storehash{'host'}=$perlvar{'lonHostID'};
3339:
3340: my $namevalue='';
3341: foreach my $key (keys(%$storehash)) {
3342: $namevalue.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
3343: }
3344: $namevalue=~s/\&$//;
3345: &courselog($symb.':'.$stuname.':'.$domain.':CSTORE:'.$namevalue);
3346: return critical
3347: ("store:$domain:$stuname:$namespace:$symb:$namevalue","$home");
3348: }
3349:
3350: # --------------------------------------------------------------------- Restore
3351:
3352: sub restore {
3353: my ($symb,$namespace,$domain,$stuname) = @_;
3354: my $home='';
3355:
3356: if ($stuname) { $home=&homeserver($stuname,$domain); }
3357:
3358: if (!$symb) {
3359: unless ($symb=escape(&symbread())) { return ''; }
3360: } else {
3361: $symb=&escape(&symbclean($symb));
3362: }
3363: if (!$namespace) {
3364: unless ($namespace=$env{'request.course.id'}) {
3365: return '';
3366: }
3367: }
3368: if (!$domain) { $domain=$env{'user.domain'}; }
3369: if (!$stuname) { $stuname=$env{'user.name'}; }
3370: if (!$home) { $home=$env{'user.home'}; }
3371: my $answer=&reply("restore:$domain:$stuname:$namespace:$symb","$home");
3372:
3373: my %returnhash=();
3374: foreach my $line (split(/\&/,$answer)) {
3375: my ($name,$value)=split(/\=/,$line);
3376: $returnhash{&unescape($name)}=&thaw_unescape($value);
3377: }
3378: my $version;
3379: for ($version=1;$version<=$returnhash{'version'};$version++) {
3380: foreach my $item (split(/\:/,$returnhash{$version.':keys'})) {
3381: $returnhash{$item}=$returnhash{$version.':'.$item};
3382: }
3383: }
3384: return %returnhash;
3385: }
3386:
3387: # ---------------------------------------------------------- Course Description
3388:
3389: sub coursedescription {
3390: my ($courseid,$args)=@_;
3391: $courseid=~s/^\///;
3392: $courseid=~s/\_/\//g;
3393: my ($cdomain,$cnum)=split(/\//,$courseid);
3394: my $chome=&homeserver($cnum,$cdomain);
3395: my $normalid=$cdomain.'_'.$cnum;
3396: # need to always cache even if we get errors otherwise we keep
3397: # trying and trying and trying to get the course description.
3398: my %envhash=();
3399: my %returnhash=();
3400:
3401: my $expiretime=600;
3402: if ($env{'request.course.id'} eq $normalid) {
3403: $expiretime=120;
3404: }
3405:
3406: my $prefix='course.'.$cdomain.'_'.$cnum.'.';
3407: if (!$args->{'freshen_cache'}
3408: && ((time-$env{$prefix.'last_cache'}) < $expiretime) ) {
3409: foreach my $key (keys(%env)) {
3410: next if ($key !~ /^\Q$prefix\E(.*)/);
3411: my ($setting) = $1;
3412: $returnhash{$setting} = $env{$key};
3413: }
3414: return %returnhash;
3415: }
3416:
3417: # get the data agin
3418: if (!$args->{'one_time'}) {
3419: $envhash{'course.'.$normalid.'.last_cache'}=time;
3420: }
3421:
3422: if ($chome ne 'no_host') {
3423: %returnhash=&dump('environment',$cdomain,$cnum);
3424: if (!exists($returnhash{'con_lost'})) {
3425: $returnhash{'home'}= $chome;
3426: $returnhash{'domain'} = $cdomain;
3427: $returnhash{'num'} = $cnum;
3428: if (!defined($returnhash{'type'})) {
3429: $returnhash{'type'} = 'Course';
3430: }
3431: while (my ($name,$value) = each %returnhash) {
3432: $envhash{'course.'.$normalid.'.'.$name}=$value;
3433: }
3434: $returnhash{'url'}=&clutter($returnhash{'url'});
3435: $returnhash{'fn'}=$perlvar{'lonDaemons'}.'/tmp/'.
3436: $env{'user.name'}.'_'.$cdomain.'_'.$cnum;
3437: $envhash{'course.'.$normalid.'.home'}=$chome;
3438: $envhash{'course.'.$normalid.'.domain'}=$cdomain;
3439: $envhash{'course.'.$normalid.'.num'}=$cnum;
3440: }
3441: }
3442: if (!$args->{'one_time'}) {
3443: &appenv(\%envhash);
3444: }
3445: return %returnhash;
3446: }
3447:
3448: # -------------------------------------------------See if a user is privileged
3449:
3450: sub privileged {
3451: my ($username,$domain)=@_;
3452: my $rolesdump=&reply("dump:$domain:$username:roles",
3453: &homeserver($username,$domain));
3454: if (($rolesdump eq 'con_lost') || ($rolesdump eq '')) { return 0; }
3455: my $now=time;
3456: if ($rolesdump ne '') {
3457: foreach my $entry (split(/&/,$rolesdump)) {
3458: if ($entry!~/^rolesdef_/) {
3459: my ($area,$role)=split(/=/,$entry);
3460: $area=~s/\_\w\w$//;
3461: my ($trole,$tend,$tstart)=split(/_/,$role);
3462: if (($trole eq 'dc') || ($trole eq 'su')) {
3463: my $active=1;
3464: if ($tend) {
3465: if ($tend<$now) { $active=0; }
3466: }
3467: if ($tstart) {
3468: if ($tstart>$now) { $active=0; }
3469: }
3470: if ($active) { return 1; }
3471: }
3472: }
3473: }
3474: }
3475: return 0;
3476: }
3477:
3478: # -------------------------------------------------------- Get user privileges
3479:
3480: sub rolesinit {
3481: my ($domain,$username,$authhost)=@_;
3482: my $rolesdump=reply("dump:$domain:$username:roles",$authhost);
3483: if (($rolesdump eq 'con_lost') || ($rolesdump eq '')) { return ''; }
3484: my %allroles=();
3485: my %allgroups=();
3486: my $now=time;
3487: my %userroles = ('user.login.time' => $now);
3488: my $group_privs;
3489:
3490: if ($rolesdump ne '') {
3491: foreach my $entry (split(/&/,$rolesdump)) {
3492: if ($entry!~/^rolesdef_/) {
3493: my ($area,$role)=split(/=/,$entry);
3494: $area=~s/\_\w\w$//;
3495: my ($trole,$tend,$tstart,$group_privs);
3496: if ($role=~/^cr/) {
3497: if ($role=~m|^(cr/$match_domain/$match_username/[a-zA-Z0-9]+)_(.*)$|) {
3498: ($trole,my $trest)=($role=~m|^(cr/$match_domain/$match_username/[a-zA-Z0-9]+)_(.*)$|);
3499: ($tend,$tstart)=split('_',$trest);
3500: } else {
3501: $trole=$role;
3502: }
3503: } elsif ($role =~ m|^gr/|) {
3504: ($trole,$tend,$tstart) = split(/_/,$role);
3505: ($trole,$group_privs) = split(/\//,$trole);
3506: $group_privs = &unescape($group_privs);
3507: } else {
3508: ($trole,$tend,$tstart)=split(/_/,$role);
3509: }
3510: my %new_role = &set_arearole($trole,$area,$tstart,$tend,$domain,
3511: $username);
3512: @userroles{keys(%new_role)} = @new_role{keys(%new_role)};
3513: if (($tend!=0) && ($tend<$now)) { $trole=''; }
3514: if (($tstart!=0) && ($tstart>$now)) { $trole=''; }
3515: if (($area ne '') && ($trole ne '')) {
3516: my $spec=$trole.'.'.$area;
3517: my ($tdummy,$tdomain,$trest)=split(/\//,$area);
3518: if ($trole =~ /^cr\//) {
3519: &custom_roleprivs(\%allroles,$trole,$tdomain,$trest,$spec,$area);
3520: } elsif ($trole eq 'gr') {
3521: &group_roleprivs(\%allgroups,$area,$group_privs,$tend,$tstart);
3522: } else {
3523: &standard_roleprivs(\%allroles,$trole,$tdomain,$spec,$trest,$area);
3524: }
3525: }
3526: }
3527: }
3528: my ($author,$adv) = &set_userprivs(\%userroles,\%allroles,\%allgroups);
3529: $userroles{'user.adv'} = $adv;
3530: $userroles{'user.author'} = $author;
3531: $env{'user.adv'}=$adv;
3532: }
3533: return \%userroles;
3534: }
3535:
3536: sub set_arearole {
3537: my ($trole,$area,$tstart,$tend,$domain,$username) = @_;
3538: # log the associated role with the area
3539: &userrolelog($trole,$username,$domain,$area,$tstart,$tend);
3540: return ('user.role.'.$trole.'.'.$area => $tstart.'.'.$tend);
3541: }
3542:
3543: sub custom_roleprivs {
3544: my ($allroles,$trole,$tdomain,$trest,$spec,$area) = @_;
3545: my ($rdummy,$rdomain,$rauthor,$rrole)=split(/\//,$trole);
3546: my $homsvr=homeserver($rauthor,$rdomain);
3547: if (&hostname($homsvr) ne '') {
3548: my ($rdummy,$roledef)=
3549: &get('roles',["rolesdef_$rrole"],$rdomain,$rauthor);
3550: if (($rdummy ne 'con_lost') && ($roledef ne '')) {
3551: my ($syspriv,$dompriv,$coursepriv)=split(/\_/,$roledef);
3552: if (defined($syspriv)) {
3553: $$allroles{'cm./'}.=':'.$syspriv;
3554: $$allroles{$spec.'./'}.=':'.$syspriv;
3555: }
3556: if ($tdomain ne '') {
3557: if (defined($dompriv)) {
3558: $$allroles{'cm./'.$tdomain.'/'}.=':'.$dompriv;
3559: $$allroles{$spec.'./'.$tdomain.'/'}.=':'.$dompriv;
3560: }
3561: if (($trest ne '') && (defined($coursepriv))) {
3562: $$allroles{'cm.'.$area}.=':'.$coursepriv;
3563: $$allroles{$spec.'.'.$area}.=':'.$coursepriv;
3564: }
3565: }
3566: }
3567: }
3568: }
3569:
3570: sub group_roleprivs {
3571: my ($allgroups,$area,$group_privs,$tend,$tstart) = @_;
3572: my $access = 1;
3573: my $now = time;
3574: if (($tend!=0) && ($tend<$now)) { $access = 0; }
3575: if (($tstart!=0) && ($tstart>$now)) { $access=0; }
3576: if ($access) {
3577: my ($course,$group) = ($area =~ m|(/$match_domain/$match_courseid)/([^/]+)$|);
3578: $$allgroups{$course}{$group} .=':'.$group_privs;
3579: }
3580: }
3581:
3582: sub standard_roleprivs {
3583: my ($allroles,$trole,$tdomain,$spec,$trest,$area) = @_;
3584: if (defined($pr{$trole.':s'})) {
3585: $$allroles{'cm./'}.=':'.$pr{$trole.':s'};
3586: $$allroles{$spec.'./'}.=':'.$pr{$trole.':s'};
3587: }
3588: if ($tdomain ne '') {
3589: if (defined($pr{$trole.':d'})) {
3590: $$allroles{'cm./'.$tdomain.'/'}.=':'.$pr{$trole.':d'};
3591: $$allroles{$spec.'./'.$tdomain.'/'}.=':'.$pr{$trole.':d'};
3592: }
3593: if (($trest ne '') && (defined($pr{$trole.':c'}))) {
3594: $$allroles{'cm.'.$area}.=':'.$pr{$trole.':c'};
3595: $$allroles{$spec.'.'.$area}.=':'.$pr{$trole.':c'};
3596: }
3597: }
3598: }
3599:
3600: sub set_userprivs {
3601: my ($userroles,$allroles,$allgroups) = @_;
3602: my $author=0;
3603: my $adv=0;
3604: my %grouproles = ();
3605: if (keys(%{$allgroups}) > 0) {
3606: foreach my $role (keys %{$allroles}) {
3607: my ($trole,$area,$sec,$extendedarea);
3608: if ($role =~ m-^(\w+|cr/$match_domain/$match_username/\w+)\.(/$match_domain/$match_courseid)(/?\w*)\.-) {
3609: $trole = $1;
3610: $area = $2;
3611: $sec = $3;
3612: $extendedarea = $area.$sec;
3613: if (exists($$allgroups{$area})) {
3614: foreach my $group (keys(%{$$allgroups{$area}})) {
3615: my $spec = $trole.'.'.$extendedarea;
3616: $grouproles{$spec.'.'.$area.'/'.$group} =
3617: $$allgroups{$area}{$group};
3618: }
3619: }
3620: }
3621: }
3622: }
3623: foreach my $group (keys(%grouproles)) {
3624: $$allroles{$group} = $grouproles{$group};
3625: }
3626: foreach my $role (keys(%{$allroles})) {
3627: my %thesepriv;
3628: if (($role=~/^au/) || ($role=~/^ca/) || ($role=~/^aa/)) { $author=1; }
3629: foreach my $item (split(/:/,$$allroles{$role})) {
3630: if ($item ne '') {
3631: my ($privilege,$restrictions)=split(/&/,$item);
3632: if ($restrictions eq '') {
3633: $thesepriv{$privilege}='F';
3634: } elsif ($thesepriv{$privilege} ne 'F') {
3635: $thesepriv{$privilege}.=$restrictions;
3636: }
3637: if ($thesepriv{'adv'} eq 'F') { $adv=1; }
3638: }
3639: }
3640: my $thesestr='';
3641: foreach my $priv (keys(%thesepriv)) {
3642: $thesestr.=':'.$priv.'&'.$thesepriv{$priv};
3643: }
3644: $userroles->{'user.priv.'.$role} = $thesestr;
3645: }
3646: return ($author,$adv);
3647: }
3648:
3649: # --------------------------------------------------------------- get interface
3650:
3651: sub get {
3652: my ($namespace,$storearr,$udomain,$uname)=@_;
3653: my $items='';
3654: foreach my $item (@$storearr) {
3655: $items.=&escape($item).'&';
3656: }
3657: $items=~s/\&$//;
3658: if (!$udomain) { $udomain=$env{'user.domain'}; }
3659: if (!$uname) { $uname=$env{'user.name'}; }
3660: my $uhome=&homeserver($uname,$udomain);
3661:
3662: my $rep=&reply("get:$udomain:$uname:$namespace:$items",$uhome);
3663: my @pairs=split(/\&/,$rep);
3664: if ( $#pairs==0 && $pairs[0] =~ /^(con_lost|error|no_such_host)/i) {
3665: return @pairs;
3666: }
3667: my %returnhash=();
3668: my $i=0;
3669: foreach my $item (@$storearr) {
3670: $returnhash{$item}=&thaw_unescape($pairs[$i]);
3671: $i++;
3672: }
3673: return %returnhash;
3674: }
3675:
3676: # --------------------------------------------------------------- del interface
3677:
3678: sub del {
3679: my ($namespace,$storearr,$udomain,$uname)=@_;
3680: my $items='';
3681: foreach my $item (@$storearr) {
3682: $items.=&escape($item).'&';
3683: }
3684: $items=~s/\&$//;
3685: if (!$udomain) { $udomain=$env{'user.domain'}; }
3686: if (!$uname) { $uname=$env{'user.name'}; }
3687: my $uhome=&homeserver($uname,$udomain);
3688:
3689: return &reply("del:$udomain:$uname:$namespace:$items",$uhome);
3690: }
3691:
3692: # -------------------------------------------------------------- dump interface
3693:
3694: sub dump {
3695: my ($namespace,$udomain,$uname,$regexp,$range)=@_;
3696: if (!$udomain) { $udomain=$env{'user.domain'}; }
3697: if (!$uname) { $uname=$env{'user.name'}; }
3698: my $uhome=&homeserver($uname,$udomain);
3699: if ($regexp) {
3700: $regexp=&escape($regexp);
3701: } else {
3702: $regexp='.';
3703: }
3704: my $rep=&reply("dump:$udomain:$uname:$namespace:$regexp:$range",$uhome);
3705: my @pairs=split(/\&/,$rep);
3706: my %returnhash=();
3707: foreach my $item (@pairs) {
3708: my ($key,$value)=split(/=/,$item,2);
3709: $key = &unescape($key);
3710: next if ($key =~ /^error: 2 /);
3711: $returnhash{$key}=&thaw_unescape($value);
3712: }
3713: return %returnhash;
3714: }
3715:
3716: # --------------------------------------------------------- dumpstore interface
3717:
3718: sub dumpstore {
3719: my ($namespace,$udomain,$uname,$regexp,$range)=@_;
3720: if (!$udomain) { $udomain=$env{'user.domain'}; }
3721: if (!$uname) { $uname=$env{'user.name'}; }
3722: my $uhome=&homeserver($uname,$udomain);
3723: if ($regexp) {
3724: $regexp=&escape($regexp);
3725: } else {
3726: $regexp='.';
3727: }
3728: my $rep=&reply("dump:$udomain:$uname:$namespace:$regexp:$range",$uhome);
3729: my @pairs=split(/\&/,$rep);
3730: my %returnhash=();
3731: foreach my $item (@pairs) {
3732: my ($key,$value)=split(/=/,$item,2);
3733: next if ($key =~ /^error: 2 /);
3734: $returnhash{$key}=&thaw_unescape($value);
3735: }
3736: return %returnhash;
3737: }
3738:
3739: # -------------------------------------------------------------- keys interface
3740:
3741: sub getkeys {
3742: my ($namespace,$udomain,$uname)=@_;
3743: if (!$udomain) { $udomain=$env{'user.domain'}; }
3744: if (!$uname) { $uname=$env{'user.name'}; }
3745: my $uhome=&homeserver($uname,$udomain);
3746: my $rep=reply("keys:$udomain:$uname:$namespace",$uhome);
3747: my @keyarray=();
3748: foreach my $key (split(/\&/,$rep)) {
3749: next if ($key =~ /^error: 2 /);
3750: push(@keyarray,&unescape($key));
3751: }
3752: return @keyarray;
3753: }
3754:
3755: # --------------------------------------------------------------- currentdump
3756: sub currentdump {
3757: my ($courseid,$sdom,$sname)=@_;
3758: $courseid = $env{'request.course.id'} if (! defined($courseid));
3759: $sdom = $env{'user.domain'} if (! defined($sdom));
3760: $sname = $env{'user.name'} if (! defined($sname));
3761: my $uhome = &homeserver($sname,$sdom);
3762: my $rep=reply('currentdump:'.$sdom.':'.$sname.':'.$courseid,$uhome);
3763: return if ($rep =~ /^(error:|no_such_host)/);
3764: #
3765: my %returnhash=();
3766: #
3767: if ($rep eq "unknown_cmd") {
3768: # an old lond will not know currentdump
3769: # Do a dump and make it look like a currentdump
3770: my @tmp = &dumpstore($courseid,$sdom,$sname,'.');
3771: return if ($tmp[0] =~ /^(error:|no_such_host)/);
3772: my %hash = @tmp;
3773: @tmp=();
3774: %returnhash = %{&convert_dump_to_currentdump(\%hash)};
3775: } else {
3776: my @pairs=split(/\&/,$rep);
3777: foreach my $pair (@pairs) {
3778: my ($key,$value)=split(/=/,$pair,2);
3779: my ($symb,$param) = split(/:/,$key);
3780: $returnhash{&unescape($symb)}->{&unescape($param)} =
3781: &thaw_unescape($value);
3782: }
3783: }
3784: return %returnhash;
3785: }
3786:
3787: sub convert_dump_to_currentdump{
3788: my %hash = %{shift()};
3789: my %returnhash;
3790: # Code ripped from lond, essentially. The only difference
3791: # here is the unescaping done by lonnet::dump(). Conceivably
3792: # we might run in to problems with parameter names =~ /^v\./
3793: while (my ($key,$value) = each(%hash)) {
3794: my ($v,$symb,$param) = split(/:/,$key);
3795: $symb = &unescape($symb);
3796: $param = &unescape($param);
3797: next if ($v eq 'version' || $symb eq 'keys');
3798: next if (exists($returnhash{$symb}) &&
3799: exists($returnhash{$symb}->{$param}) &&
3800: $returnhash{$symb}->{'v.'.$param} > $v);
3801: $returnhash{$symb}->{$param}=$value;
3802: $returnhash{$symb}->{'v.'.$param}=$v;
3803: }
3804: #
3805: # Remove all of the keys in the hashes which keep track of
3806: # the version of the parameter.
3807: while (my ($symb,$param_hash) = each(%returnhash)) {
3808: # use a foreach because we are going to delete from the hash.
3809: foreach my $key (keys(%$param_hash)) {
3810: delete($param_hash->{$key}) if ($key =~ /^v\./);
3811: }
3812: }
3813: return \%returnhash;
3814: }
3815:
3816: # ------------------------------------------------------ critical inc interface
3817:
3818: sub cinc {
3819: return &inc(@_,'critical');
3820: }
3821:
3822: # --------------------------------------------------------------- inc interface
3823:
3824: sub inc {
3825: my ($namespace,$store,$udomain,$uname,$critical) = @_;
3826: if (!$udomain) { $udomain=$env{'user.domain'}; }
3827: if (!$uname) { $uname=$env{'user.name'}; }
3828: my $uhome=&homeserver($uname,$udomain);
3829: my $items='';
3830: if (! ref($store)) {
3831: # got a single value, so use that instead
3832: $items = &escape($store).'=&';
3833: } elsif (ref($store) eq 'SCALAR') {
3834: $items = &escape($$store).'=&';
3835: } elsif (ref($store) eq 'ARRAY') {
3836: $items = join('=&',map {&escape($_);} @{$store});
3837: } elsif (ref($store) eq 'HASH') {
3838: while (my($key,$value) = each(%{$store})) {
3839: $items.= &escape($key).'='.&escape($value).'&';
3840: }
3841: }
3842: $items=~s/\&$//;
3843: if ($critical) {
3844: return &critical("inc:$udomain:$uname:$namespace:$items",$uhome);
3845: } else {
3846: return &reply("inc:$udomain:$uname:$namespace:$items",$uhome);
3847: }
3848: }
3849:
3850: # --------------------------------------------------------------- put interface
3851:
3852: sub put {
3853: my ($namespace,$storehash,$udomain,$uname)=@_;
3854: if (!$udomain) { $udomain=$env{'user.domain'}; }
3855: if (!$uname) { $uname=$env{'user.name'}; }
3856: my $uhome=&homeserver($uname,$udomain);
3857: my $items='';
3858: foreach my $item (keys(%$storehash)) {
3859: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
3860: }
3861: $items=~s/\&$//;
3862: return &reply("put:$udomain:$uname:$namespace:$items",$uhome);
3863: }
3864:
3865: # ------------------------------------------------------------ newput interface
3866:
3867: sub newput {
3868: my ($namespace,$storehash,$udomain,$uname)=@_;
3869: if (!$udomain) { $udomain=$env{'user.domain'}; }
3870: if (!$uname) { $uname=$env{'user.name'}; }
3871: my $uhome=&homeserver($uname,$udomain);
3872: my $items='';
3873: foreach my $key (keys(%$storehash)) {
3874: $items.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
3875: }
3876: $items=~s/\&$//;
3877: return &reply("newput:$udomain:$uname:$namespace:$items",$uhome);
3878: }
3879:
3880: # --------------------------------------------------------- putstore interface
3881:
3882: sub putstore {
3883: my ($namespace,$symb,$version,$storehash,$udomain,$uname)=@_;
3884: if (!$udomain) { $udomain=$env{'user.domain'}; }
3885: if (!$uname) { $uname=$env{'user.name'}; }
3886: my $uhome=&homeserver($uname,$udomain);
3887: my $items='';
3888: foreach my $key (keys(%$storehash)) {
3889: $items.= &escape($key).'='.&freeze_escape($storehash->{$key}).'&';
3890: }
3891: $items=~s/\&$//;
3892: my $esc_symb=&escape($symb);
3893: my $esc_v=&escape($version);
3894: my $reply =
3895: &reply("putstore:$udomain:$uname:$namespace:$esc_symb:$esc_v:$items",
3896: $uhome);
3897: if ($reply eq 'unknown_cmd') {
3898: # gfall back to way things use to be done
3899: return &old_putstore($namespace,$symb,$version,$storehash,$udomain,
3900: $uname);
3901: }
3902: return $reply;
3903: }
3904:
3905: sub old_putstore {
3906: my ($namespace,$symb,$version,$storehash,$udomain,$uname)=@_;
3907: if (!$udomain) { $udomain=$env{'user.domain'}; }
3908: if (!$uname) { $uname=$env{'user.name'}; }
3909: my $uhome=&homeserver($uname,$udomain);
3910: my %newstorehash;
3911: foreach my $item (keys(%$storehash)) {
3912: my $key = $version.':'.&escape($symb).':'.$item;
3913: $newstorehash{$key} = $storehash->{$item};
3914: }
3915: my $items='';
3916: my %allitems = ();
3917: foreach my $item (keys(%newstorehash)) {
3918: if ($item =~ m/^([^\:]+):([^\:]+):([^\:]+)$/) {
3919: my $key = $1.':keys:'.$2;
3920: $allitems{$key} .= $3.':';
3921: }
3922: $items.=$item.'='.&freeze_escape($newstorehash{$item}).'&';
3923: }
3924: foreach my $item (keys(%allitems)) {
3925: $allitems{$item} =~ s/\:$//;
3926: $items.= $item.'='.$allitems{$item}.'&';
3927: }
3928: $items=~s/\&$//;
3929: return &reply("put:$udomain:$uname:$namespace:$items",$uhome);
3930: }
3931:
3932: # ------------------------------------------------------ critical put interface
3933:
3934: sub cput {
3935: my ($namespace,$storehash,$udomain,$uname)=@_;
3936: if (!$udomain) { $udomain=$env{'user.domain'}; }
3937: if (!$uname) { $uname=$env{'user.name'}; }
3938: my $uhome=&homeserver($uname,$udomain);
3939: my $items='';
3940: foreach my $item (keys(%$storehash)) {
3941: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
3942: }
3943: $items=~s/\&$//;
3944: return &critical("put:$udomain:$uname:$namespace:$items",$uhome);
3945: }
3946:
3947: # -------------------------------------------------------------- eget interface
3948:
3949: sub eget {
3950: my ($namespace,$storearr,$udomain,$uname)=@_;
3951: my $items='';
3952: foreach my $item (@$storearr) {
3953: $items.=&escape($item).'&';
3954: }
3955: $items=~s/\&$//;
3956: if (!$udomain) { $udomain=$env{'user.domain'}; }
3957: if (!$uname) { $uname=$env{'user.name'}; }
3958: my $uhome=&homeserver($uname,$udomain);
3959: my $rep=&reply("eget:$udomain:$uname:$namespace:$items",$uhome);
3960: my @pairs=split(/\&/,$rep);
3961: my %returnhash=();
3962: my $i=0;
3963: foreach my $item (@$storearr) {
3964: $returnhash{$item}=&thaw_unescape($pairs[$i]);
3965: $i++;
3966: }
3967: return %returnhash;
3968: }
3969:
3970: # ------------------------------------------------------------ tmpput interface
3971: sub tmpput {
3972: my ($storehash,$server,$context)=@_;
3973: my $items='';
3974: foreach my $item (keys(%$storehash)) {
3975: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
3976: }
3977: $items=~s/\&$//;
3978: if (defined($context)) {
3979: $items .= ':'.&escape($context);
3980: }
3981: return &reply("tmpput:$items",$server);
3982: }
3983:
3984: # ------------------------------------------------------------ tmpget interface
3985: sub tmpget {
3986: my ($token,$server)=@_;
3987: if (!defined($server)) { $server = $perlvar{'lonHostID'}; }
3988: my $rep=&reply("tmpget:$token",$server);
3989: my %returnhash;
3990: foreach my $item (split(/\&/,$rep)) {
3991: my ($key,$value)=split(/=/,$item);
3992: next if ($key =~ /^error: 2 /);
3993: $returnhash{&unescape($key)}=&thaw_unescape($value);
3994: }
3995: return %returnhash;
3996: }
3997:
3998: # ------------------------------------------------------------ tmpget interface
3999: sub tmpdel {
4000: my ($token,$server)=@_;
4001: if (!defined($server)) { $server = $perlvar{'lonHostID'}; }
4002: return &reply("tmpdel:$token",$server);
4003: }
4004:
4005: # -------------------------------------------------- portfolio access checking
4006:
4007: sub portfolio_access {
4008: my ($requrl) = @_;
4009: my (undef,$udom,$unum,$file_name,$group) = &parse_portfolio_url($requrl);
4010: my $result = &get_portfolio_access($udom,$unum,$file_name,$group);
4011: if ($result) {
4012: my %setters;
4013: if ($env{'user.name'} eq 'public' && $env{'user.domain'} eq 'public') {
4014: my ($startblock,$endblock) =
4015: &Apache::loncommon::blockcheck(\%setters,'port',$unum,$udom);
4016: if ($startblock && $endblock) {
4017: return 'B';
4018: }
4019: } else {
4020: my ($startblock,$endblock) =
4021: &Apache::loncommon::blockcheck(\%setters,'port');
4022: if ($startblock && $endblock) {
4023: return 'B';
4024: }
4025: }
4026: }
4027: if ($result eq 'ok') {
4028: return 'F';
4029: } elsif ($result =~ /^[^:]+:guest_/) {
4030: return 'A';
4031: }
4032: return '';
4033: }
4034:
4035: sub get_portfolio_access {
4036: my ($udom,$unum,$file_name,$group,$access_hash) = @_;
4037:
4038: if (!ref($access_hash)) {
4039: my $current_perms = &get_portfile_permissions($udom,$unum);
4040: my %access_controls = &get_access_controls($current_perms,$group,
4041: $file_name);
4042: $access_hash = $access_controls{$file_name};
4043: }
4044:
4045: my ($public,$guest,@domains,@users,@courses,@groups);
4046: my $now = time;
4047: if (ref($access_hash) eq 'HASH') {
4048: foreach my $key (keys(%{$access_hash})) {
4049: my ($num,$scope,$end,$start) = ($key =~ /^([^:]+):([a-z]+)_(\d*)_?(\d*)$/);
4050: if ($start > $now) {
4051: next;
4052: }
4053: if ($end && $end<$now) {
4054: next;
4055: }
4056: if ($scope eq 'public') {
4057: $public = $key;
4058: last;
4059: } elsif ($scope eq 'guest') {
4060: $guest = $key;
4061: } elsif ($scope eq 'domains') {
4062: push(@domains,$key);
4063: } elsif ($scope eq 'users') {
4064: push(@users,$key);
4065: } elsif ($scope eq 'course') {
4066: push(@courses,$key);
4067: } elsif ($scope eq 'group') {
4068: push(@groups,$key);
4069: }
4070: }
4071: if ($public) {
4072: return 'ok';
4073: }
4074: if ($env{'user.name'} eq 'public' && $env{'user.domain'} eq 'public') {
4075: if ($guest) {
4076: return $guest;
4077: }
4078: } else {
4079: if (@domains > 0) {
4080: foreach my $domkey (@domains) {
4081: if (ref($access_hash->{$domkey}{'dom'}) eq 'ARRAY') {
4082: if (grep(/^\Q$env{'user.domain'}\E$/,@{$access_hash->{$domkey}{'dom'}})) {
4083: return 'ok';
4084: }
4085: }
4086: }
4087: }
4088: if (@users > 0) {
4089: foreach my $userkey (@users) {
4090: if (ref($access_hash->{$userkey}{'users'}) eq 'ARRAY') {
4091: foreach my $item (@{$access_hash->{$userkey}{'users'}}) {
4092: if (ref($item) eq 'HASH') {
4093: if (($item->{'uname'} eq $env{'user.name'}) &&
4094: ($item->{'udom'} eq $env{'user.domain'})) {
4095: return 'ok';
4096: }
4097: }
4098: }
4099: }
4100: }
4101: }
4102: my %roleshash;
4103: my @courses_and_groups = @courses;
4104: push(@courses_and_groups,@groups);
4105: if (@courses_and_groups > 0) {
4106: my (%allgroups,%allroles);
4107: my ($start,$end,$role,$sec,$group);
4108: foreach my $envkey (%env) {
4109: if ($envkey =~ m-^user\.role\.(gr|cc|in|ta|ep|st)\./($match_domain)/($match_courseid)/?([^/]*)$-) {
4110: my $cid = $2.'_'.$3;
4111: if ($1 eq 'gr') {
4112: $group = $4;
4113: $allgroups{$cid}{$group} = $env{$envkey};
4114: } else {
4115: if ($4 eq '') {
4116: $sec = 'none';
4117: } else {
4118: $sec = $4;
4119: }
4120: $allroles{$cid}{$1}{$sec} = $env{$envkey};
4121: }
4122: } elsif ($envkey =~ m-^user\.role\./cr/($match_domain/$match_username/\w*)./($match_domain)/($match_courseid)/?([^/]*)$-) {
4123: my $cid = $2.'_'.$3;
4124: if ($4 eq '') {
4125: $sec = 'none';
4126: } else {
4127: $sec = $4;
4128: }
4129: $allroles{$cid}{$1}{$sec} = $env{$envkey};
4130: }
4131: }
4132: if (keys(%allroles) == 0) {
4133: return;
4134: }
4135: foreach my $key (@courses_and_groups) {
4136: my %content = %{$$access_hash{$key}};
4137: my $cnum = $content{'number'};
4138: my $cdom = $content{'domain'};
4139: my $cid = $cdom.'_'.$cnum;
4140: if (!exists($allroles{$cid})) {
4141: next;
4142: }
4143: foreach my $role_id (keys(%{$content{'roles'}})) {
4144: my @sections = @{$content{'roles'}{$role_id}{'section'}};
4145: my @groups = @{$content{'roles'}{$role_id}{'group'}};
4146: my @status = @{$content{'roles'}{$role_id}{'access'}};
4147: my @roles = @{$content{'roles'}{$role_id}{'role'}};
4148: foreach my $role (keys(%{$allroles{$cid}})) {
4149: if ((grep/^all$/,@roles) || (grep/^\Q$role\E$/,@roles)) {
4150: foreach my $sec (keys(%{$allroles{$cid}{$role}})) {
4151: if (&course_group_datechecker($allroles{$cid}{$role}{$sec},$now,\@status) eq 'ok') {
4152: if (grep/^all$/,@sections) {
4153: return 'ok';
4154: } else {
4155: if (grep/^$sec$/,@sections) {
4156: return 'ok';
4157: }
4158: }
4159: }
4160: }
4161: if (keys(%{$allgroups{$cid}}) == 0) {
4162: if (grep/^none$/,@groups) {
4163: return 'ok';
4164: }
4165: } else {
4166: if (grep/^all$/,@groups) {
4167: return 'ok';
4168: }
4169: foreach my $group (keys(%{$allgroups{$cid}})) {
4170: if (grep/^$group$/,@groups) {
4171: return 'ok';
4172: }
4173: }
4174: }
4175: }
4176: }
4177: }
4178: }
4179: }
4180: if ($guest) {
4181: return $guest;
4182: }
4183: }
4184: }
4185: return;
4186: }
4187:
4188: sub course_group_datechecker {
4189: my ($dates,$now,$status) = @_;
4190: my ($start,$end) = split(/\./,$dates);
4191: if (!$start && !$end) {
4192: return 'ok';
4193: }
4194: if (grep/^active$/,@{$status}) {
4195: if (((!$start) || ($start && $start <= $now)) && ((!$end) || ($end && $end >= $now))) {
4196: return 'ok';
4197: }
4198: }
4199: if (grep/^previous$/,@{$status}) {
4200: if ($end > $now ) {
4201: return 'ok';
4202: }
4203: }
4204: if (grep/^future$/,@{$status}) {
4205: if ($start > $now) {
4206: return 'ok';
4207: }
4208: }
4209: return;
4210: }
4211:
4212: sub parse_portfolio_url {
4213: my ($url) = @_;
4214:
4215: my ($type,$udom,$unum,$group,$file_name);
4216:
4217: if ($url =~ m-^/*(?:uploaded|editupload)/($match_domain)/($match_username)/portfolio(/.+)$-) {
4218: $type = 1;
4219: $udom = $1;
4220: $unum = $2;
4221: $file_name = $3;
4222: } elsif ($url =~ m-^/*(?:uploaded|editupload)/($match_domain)/($match_courseid)/groups/([^/]+)/portfolio/(.+)$-) {
4223: $type = 2;
4224: $udom = $1;
4225: $unum = $2;
4226: $group = $3;
4227: $file_name = $3.'/'.$4;
4228: }
4229: if (wantarray) {
4230: return ($type,$udom,$unum,$file_name,$group);
4231: }
4232: return $type;
4233: }
4234:
4235: sub is_portfolio_url {
4236: my ($url) = @_;
4237: return scalar(&parse_portfolio_url($url));
4238: }
4239:
4240: sub is_portfolio_file {
4241: my ($file) = @_;
4242: if (($file =~ /^portfolio/) || ($file =~ /^groups\/\w+\/portfolio/)) {
4243: return 1;
4244: }
4245: return;
4246: }
4247:
4248:
4249: # ---------------------------------------------- Custom access rule evaluation
4250:
4251: sub customaccess {
4252: my ($priv,$uri)=@_;
4253: my ($urole,$urealm)=split(/\./,$env{'request.role'},2);
4254: my (undef,$udom,$ucrs,$usec)=split(/\//,$urealm);
4255: $udom = &LONCAPA::clean_domain($udom);
4256: $ucrs = &LONCAPA::clean_username($ucrs);
4257: my $access=0;
4258: foreach my $right (split(/\s*\,\s*/,&metadata($uri,'rule_rights'))) {
4259: my ($effect,$realm,$role,$type)=split(/\:/,$right);
4260: if ($type eq 'user') {
4261: foreach my $scope (split(/\s*\,\s*/,$realm)) {
4262: my ($tdom,$tuname)=split(m{/},$scope);
4263: if ($tdom) {
4264: if ($tdom ne $env{'user.domain'}) { next; }
4265: }
4266: if ($tuname) {
4267: if ($tuname ne $env{'user.name'}) { next; }
4268: }
4269: $access=($effect eq 'allow');
4270: last;
4271: }
4272: } else {
4273: if ($role) {
4274: if ($role ne $urole) { next; }
4275: }
4276: foreach my $scope (split(/\s*\,\s*/,$realm)) {
4277: my ($tdom,$tcrs,$tsec)=split(/\_/,$scope);
4278: if ($tdom) {
4279: if ($tdom ne $udom) { next; }
4280: }
4281: if ($tcrs) {
4282: if ($tcrs ne $ucrs) { next; }
4283: }
4284: if ($tsec) {
4285: if ($tsec ne $usec) { next; }
4286: }
4287: $access=($effect eq 'allow');
4288: last;
4289: }
4290: if ($realm eq '' && $role eq '') {
4291: $access=($effect eq 'allow');
4292: }
4293: }
4294: }
4295: return $access;
4296: }
4297:
4298: # ------------------------------------------------- Check for a user privilege
4299:
4300: sub allowed {
4301: my ($priv,$uri,$symb,$role)=@_;
4302: my $ver_orguri=$uri;
4303: $uri=&deversion($uri);
4304: my $orguri=$uri;
4305: $uri=&declutter($uri);
4306:
4307: if ($priv eq 'evb') {
4308: # Evade communication block restrictions for specified role in a course
4309: if ($env{'user.priv.'.$role} =~/evb\&([^\:]*)/) {
4310: return $1;
4311: } else {
4312: return;
4313: }
4314: }
4315:
4316: if (defined($env{'allowed.'.$priv})) { return $env{'allowed.'.$priv}; }
4317: # Free bre access to adm and meta resources
4318: if (((($uri=~/^adm\//) && ($uri !~ m{/(?:smppg|bulletinboard)$}))
4319: || (($uri=~/\.meta$/) && ($uri!~m|^uploaded/|) ))
4320: && ($priv eq 'bre')) {
4321: return 'F';
4322: }
4323:
4324: # Free bre access to user's own portfolio contents
4325: my ($space,$domain,$name,@dir)=split('/',$uri);
4326: if (($space=~/^(uploaded|editupload)$/) && ($env{'user.name'} eq $name) &&
4327: ($env{'user.domain'} eq $domain) && ('portfolio' eq $dir[0])) {
4328: my %setters;
4329: my ($startblock,$endblock) =
4330: &Apache::loncommon::blockcheck(\%setters,'port');
4331: if ($startblock && $endblock) {
4332: return 'B';
4333: } else {
4334: return 'F';
4335: }
4336: }
4337:
4338: # bre access to group portfolio for rgf priv in group, or mdg or vcg in course.
4339: if (($space=~/^(uploaded|editupload)$/) && ($dir[0] eq 'groups')
4340: && ($dir[2] eq 'portfolio') && ($priv eq 'bre')) {
4341: if (exists($env{'request.course.id'})) {
4342: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
4343: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
4344: if (($domain eq $cdom) && ($name eq $cnum)) {
4345: my $courseprivid=$env{'request.course.id'};
4346: $courseprivid=~s/\_/\//;
4347: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid
4348: .'/'.$dir[1]} =~/rgf\&([^\:]*)/) {
4349: return $1;
4350: } else {
4351: if ($env{'request.course.sec'}) {
4352: $courseprivid.='/'.$env{'request.course.sec'};
4353: }
4354: if ($env{'user.priv.'.$env{'request.role'}.'./'.
4355: $courseprivid} =~/(mdg|vcg)\&([^\:]*)/) {
4356: return $2;
4357: }
4358: }
4359: }
4360: }
4361: }
4362:
4363: # Free bre to public access
4364:
4365: if ($priv eq 'bre') {
4366: my $copyright=&metadata($uri,'copyright');
4367: if (($copyright eq 'public') && (!$env{'request.course.id'})) {
4368: return 'F';
4369: }
4370: if ($copyright eq 'priv') {
4371: $uri=~/([^\/]+)\/([^\/]+)\//;
4372: unless (($env{'user.name'} eq $2) && ($env{'user.domain'} eq $1)) {
4373: return '';
4374: }
4375: }
4376: if ($copyright eq 'domain') {
4377: $uri=~/([^\/]+)\/([^\/]+)\//;
4378: unless (($env{'user.domain'} eq $1) ||
4379: ($env{'course.'.$env{'request.course.id'}.'.domain'} eq $1)) {
4380: return '';
4381: }
4382: }
4383: if ($env{'request.role'}=~ /li\.\//) {
4384: # Library role, so allow browsing of resources in this domain.
4385: return 'F';
4386: }
4387: if ($copyright eq 'custom') {
4388: unless (&customaccess($priv,$uri)) { return ''; }
4389: }
4390: }
4391: # Domain coordinator is trying to create a course
4392: if (($priv eq 'ccc') && ($env{'request.role'} =~ /^dc\./)) {
4393: # uri is the requested domain in this case.
4394: # comparison to 'request.role.domain' shows if the user has selected
4395: # a role of dc for the domain in question.
4396: return 'F' if ($uri eq $env{'request.role.domain'});
4397: }
4398:
4399: my $thisallowed='';
4400: my $statecond=0;
4401: my $courseprivid='';
4402:
4403: # Course
4404:
4405: if ($env{'user.priv.'.$env{'request.role'}.'./'}=~/\Q$priv\E\&([^\:]*)/) {
4406: $thisallowed.=$1;
4407: }
4408:
4409: # Domain
4410:
4411: if ($env{'user.priv.'.$env{'request.role'}.'./'.(split(/\//,$uri))[0].'/'}
4412: =~/\Q$priv\E\&([^\:]*)/) {
4413: $thisallowed.=$1;
4414: }
4415:
4416: # Course: uri itself is a course
4417: my $courseuri=$uri;
4418: $courseuri=~s/\_(\d)/\/$1/;
4419: $courseuri=~s/^([^\/])/\/$1/;
4420:
4421: if ($env{'user.priv.'.$env{'request.role'}.'.'.$courseuri}
4422: =~/\Q$priv\E\&([^\:]*)/) {
4423: $thisallowed.=$1;
4424: }
4425:
4426: # URI is an uploaded document for this course, default permissions don't matter
4427: # not allowing 'edit' access (editupload) to uploaded course docs
4428: if (($priv eq 'bre') && ($uri=~m|^uploaded/|)) {
4429: $thisallowed='';
4430: my ($match)=&is_on_map($uri);
4431: if ($match) {
4432: if ($env{'user.priv.'.$env{'request.role'}.'./'}
4433: =~/\Q$priv\E\&([^\:]*)/) {
4434: $thisallowed.=$1;
4435: }
4436: } else {
4437: my $refuri = $env{'httpref.'.$orguri} || $env{'httpref.'.$ver_orguri};
4438: if ($refuri) {
4439: if ($refuri =~ m|^/adm/|) {
4440: $thisallowed='F';
4441: } else {
4442: $refuri=&declutter($refuri);
4443: my ($match) = &is_on_map($refuri);
4444: if ($match) {
4445: $thisallowed='F';
4446: }
4447: }
4448: }
4449: }
4450: }
4451:
4452: if ($priv eq 'bre'
4453: && $thisallowed ne 'F'
4454: && $thisallowed ne '2'
4455: && &is_portfolio_url($uri)) {
4456: $thisallowed = &portfolio_access($uri);
4457: }
4458:
4459: # Full access at system, domain or course-wide level? Exit.
4460:
4461: if ($thisallowed=~/F/) {
4462: return 'F';
4463: }
4464:
4465: # If this is generating or modifying users, exit with special codes
4466:
4467: if (':csu:cdc:ccc:cin:cta:cep:ccr:cst:cad:cli:cau:cdg:cca:caa:'=~/\:\Q$priv\E\:/) {
4468: if (($priv eq 'cca') || ($priv eq 'caa')) {
4469: my ($audom,$auname)=split('/',$uri);
4470: # no author name given, so this just checks on the general right to make a co-author in this domain
4471: unless ($auname) { return $thisallowed; }
4472: # an author name is given, so we are about to actually make a co-author for a certain account
4473: if (($auname ne $env{'user.name'} && $env{'request.role'} !~ /^dc\./) ||
4474: (($audom ne $env{'user.domain'} && $env{'request.role'} !~ /^dc\./) &&
4475: ($audom ne $env{'request.role.domain'}))) { return ''; }
4476: }
4477: return $thisallowed;
4478: }
4479: #
4480: # Gathered so far: system, domain and course wide privileges
4481: #
4482: # Course: See if uri or referer is an individual resource that is part of
4483: # the course
4484:
4485: if ($env{'request.course.id'}) {
4486:
4487: $courseprivid=$env{'request.course.id'};
4488: if ($env{'request.course.sec'}) {
4489: $courseprivid.='/'.$env{'request.course.sec'};
4490: }
4491: $courseprivid=~s/\_/\//;
4492: my $checkreferer=1;
4493: my ($match,$cond)=&is_on_map($uri);
4494: if ($match) {
4495: $statecond=$cond;
4496: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid}
4497: =~/\Q$priv\E\&([^\:]*)/) {
4498: $thisallowed.=$1;
4499: $checkreferer=0;
4500: }
4501: }
4502:
4503: if ($checkreferer) {
4504: my $refuri=$env{'httpref.'.$orguri};
4505: unless ($refuri) {
4506: foreach my $key (keys(%env)) {
4507: if ($key=~/^httpref\..*\*/) {
4508: my $pattern=$key;
4509: $pattern=~s/^httpref\.\/res\///;
4510: $pattern=~s/\*/\[\^\/\]\+/g;
4511: $pattern=~s/\//\\\//g;
4512: if ($orguri=~/$pattern/) {
4513: $refuri=$env{$key};
4514: }
4515: }
4516: }
4517: }
4518:
4519: if ($refuri) {
4520: $refuri=&declutter($refuri);
4521: my ($match,$cond)=&is_on_map($refuri);
4522: if ($match) {
4523: my $refstatecond=$cond;
4524: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid}
4525: =~/\Q$priv\E\&([^\:]*)/) {
4526: $thisallowed.=$1;
4527: $uri=$refuri;
4528: $statecond=$refstatecond;
4529: }
4530: }
4531: }
4532: }
4533: }
4534:
4535: #
4536: # Gathered now: all privileges that could apply, and condition number
4537: #
4538: #
4539: # Full or no access?
4540: #
4541:
4542: if ($thisallowed=~/F/) {
4543: return 'F';
4544: }
4545:
4546: unless ($thisallowed) {
4547: return '';
4548: }
4549:
4550: # Restrictions exist, deal with them
4551: #
4552: # C:according to course preferences
4553: # R:according to resource settings
4554: # L:unless locked
4555: # X:according to user session state
4556: #
4557:
4558: # Possibly locked functionality, check all courses
4559: # Locks might take effect only after 10 minutes cache expiration for other
4560: # courses, and 2 minutes for current course
4561:
4562: my $envkey;
4563: if ($thisallowed=~/L/) {
4564: foreach $envkey (keys %env) {
4565: if ($envkey=~/^user\.role\.(st|ta)\.([^\.]*)/) {
4566: my $courseid=$2;
4567: my $roleid=$1.'.'.$2;
4568: $courseid=~s/^\///;
4569: my $expiretime=600;
4570: if ($env{'request.role'} eq $roleid) {
4571: $expiretime=120;
4572: }
4573: my ($cdom,$cnum,$csec)=split(/\//,$courseid);
4574: my $prefix='course.'.$cdom.'_'.$cnum.'.';
4575: if ((time-$env{$prefix.'last_cache'})>$expiretime) {
4576: &coursedescription($courseid,{'freshen_cache' => 1});
4577: }
4578: if (($env{$prefix.'res.'.$uri.'.lock.sections'}=~/\,\Q$csec\E\,/)
4579: || ($env{$prefix.'res.'.$uri.'.lock.sections'} eq 'all')) {
4580: if ($env{$prefix.'res.'.$uri.'.lock.expire'}>time) {
4581: &log($env{'user.domain'},$env{'user.name'},
4582: $env{'user.home'},
4583: 'Locked by res: '.$priv.' for '.$uri.' due to '.
4584: $cdom.'/'.$cnum.'/'.$csec.' expire '.
4585: $env{$prefix.'priv.'.$priv.'.lock.expire'});
4586: return '';
4587: }
4588: }
4589: if (($env{$prefix.'priv.'.$priv.'.lock.sections'}=~/\,\Q$csec\E\,/)
4590: || ($env{$prefix.'priv.'.$priv.'.lock.sections'} eq 'all')) {
4591: if ($env{'priv.'.$priv.'.lock.expire'}>time) {
4592: &log($env{'user.domain'},$env{'user.name'},
4593: $env{'user.home'},
4594: 'Locked by priv: '.$priv.' for '.$uri.' due to '.
4595: $cdom.'/'.$cnum.'/'.$csec.' expire '.
4596: $env{$prefix.'priv.'.$priv.'.lock.expire'});
4597: return '';
4598: }
4599: }
4600: }
4601: }
4602: }
4603:
4604: #
4605: # Rest of the restrictions depend on selected course
4606: #
4607:
4608: unless ($env{'request.course.id'}) {
4609: if ($thisallowed eq 'A') {
4610: return 'A';
4611: } elsif ($thisallowed eq 'B') {
4612: return 'B';
4613: } else {
4614: return '1';
4615: }
4616: }
4617:
4618: #
4619: # Now user is definitely in a course
4620: #
4621:
4622:
4623: # Course preferences
4624:
4625: if ($thisallowed=~/C/) {
4626: my $rolecode=(split(/\./,$env{'request.role'}))[0];
4627: my $unamedom=$env{'user.name'}.':'.$env{'user.domain'};
4628: if ($env{'course.'.$env{'request.course.id'}.'.'.$priv.'.roles.denied'}
4629: =~/\Q$rolecode\E/) {
4630: if ($priv ne 'pch') {
4631: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.':'.
4632: 'Denied by role: '.$priv.' for '.$uri.' as '.$rolecode.' in '.
4633: $env{'request.course.id'});
4634: }
4635: return '';
4636: }
4637:
4638: if ($env{'course.'.$env{'request.course.id'}.'.'.$priv.'.users.denied'}
4639: =~/\Q$unamedom\E/) {
4640: if ($priv ne 'pch') {
4641: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.
4642: 'Denied by user: '.$priv.' for '.$uri.' as '.$unamedom.' in '.
4643: $env{'request.course.id'});
4644: }
4645: return '';
4646: }
4647: }
4648:
4649: # Resource preferences
4650:
4651: if ($thisallowed=~/R/) {
4652: my $rolecode=(split(/\./,$env{'request.role'}))[0];
4653: if (&metadata($uri,'roledeny')=~/\Q$rolecode\E/) {
4654: if ($priv ne 'pch') {
4655: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.':'.
4656: 'Denied by role: '.$priv.' for '.$uri.' as '.$rolecode);
4657: }
4658: return '';
4659: }
4660: }
4661:
4662: # Restricted by state or randomout?
4663:
4664: if ($thisallowed=~/X/) {
4665: if ($env{'acc.randomout'}) {
4666: if (!$symb) { $symb=&symbread($uri,1); }
4667: if (($symb) && ($env{'acc.randomout'}=~/\&\Q$symb\E\&/)) {
4668: return '';
4669: }
4670: }
4671: if (&condval($statecond)) {
4672: return '2';
4673: } else {
4674: return '';
4675: }
4676: }
4677:
4678: if ($thisallowed eq 'A') {
4679: return 'A';
4680: } elsif ($thisallowed eq 'B') {
4681: return 'B';
4682: }
4683: return 'F';
4684: }
4685:
4686: sub split_uri_for_cond {
4687: my $uri=&deversion(&declutter(shift));
4688: my @uriparts=split(/\//,$uri);
4689: my $filename=pop(@uriparts);
4690: my $pathname=join('/',@uriparts);
4691: return ($pathname,$filename);
4692: }
4693: # --------------------------------------------------- Is a resource on the map?
4694:
4695: sub is_on_map {
4696: my ($pathname,$filename) = &split_uri_for_cond(shift);
4697: #Trying to find the conditional for the file
4698: my $match=($env{'acc.res.'.$env{'request.course.id'}.'.'.$pathname}=~
4699: /\&\Q$filename\E\:([\d\|]+)\&/);
4700: if ($match) {
4701: return (1,$1);
4702: } else {
4703: return (0,0);
4704: }
4705: }
4706:
4707: # --------------------------------------------------------- Get symb from alias
4708:
4709: sub get_symb_from_alias {
4710: my $symb=shift;
4711: my ($map,$resid,$url)=&decode_symb($symb);
4712: # Already is a symb
4713: if ($url) { return $symb; }
4714: # Must be an alias
4715: my $aliassymb='';
4716: my %bighash;
4717: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
4718: &GDBM_READER(),0640)) {
4719: my $rid=$bighash{'mapalias_'.$symb};
4720: if ($rid) {
4721: my ($mapid,$resid)=split(/\./,$rid);
4722: $aliassymb=&encode_symb($bighash{'map_id_'.$mapid},
4723: $resid,$bighash{'src_'.$rid});
4724: }
4725: untie %bighash;
4726: }
4727: return $aliassymb;
4728: }
4729:
4730: # ----------------------------------------------------------------- Define Role
4731:
4732: sub definerole {
4733: if (allowed('mcr','/')) {
4734: my ($rolename,$sysrole,$domrole,$courole)=@_;
4735: foreach my $role (split(':',$sysrole)) {
4736: my ($crole,$cqual)=split(/\&/,$role);
4737: if ($pr{'cr:s'}!~/\Q$crole\E/) { return "refused:s:$crole"; }
4738: if ($pr{'cr:s'}=~/\Q$crole\E\&/) {
4739: if ($pr{'cr:s'}!~/\Q$crole\E\&\w*\Q$cqual\E/) {
4740: return "refused:s:$crole&$cqual";
4741: }
4742: }
4743: }
4744: foreach my $role (split(':',$domrole)) {
4745: my ($crole,$cqual)=split(/\&/,$role);
4746: if ($pr{'cr:d'}!~/\Q$crole\E/) { return "refused:d:$crole"; }
4747: if ($pr{'cr:d'}=~/\Q$crole\E\&/) {
4748: if ($pr{'cr:d'}!~/\Q$crole\W\&\w*\Q$cqual\E/) {
4749: return "refused:d:$crole&$cqual";
4750: }
4751: }
4752: }
4753: foreach my $role (split(':',$courole)) {
4754: my ($crole,$cqual)=split(/\&/,$role);
4755: if ($pr{'cr:c'}!~/\Q$crole\E/) { return "refused:c:$crole"; }
4756: if ($pr{'cr:c'}=~/\Q$crole\E\&/) {
4757: if ($pr{'cr:c'}!~/\Q$crole\E\&\w*\Q$cqual\E/) {
4758: return "refused:c:$crole&$cqual";
4759: }
4760: }
4761: }
4762: my $command="encrypt:rolesput:$env{'user.domain'}:$env{'user.name'}:".
4763: "$env{'user.domain'}:$env{'user.name'}:".
4764: "rolesdef_$rolename=".
4765: escape($sysrole.'_'.$domrole.'_'.$courole);
4766: return reply($command,$env{'user.home'});
4767: } else {
4768: return 'refused';
4769: }
4770: }
4771:
4772: # ---------------- Make a metadata query against the network of library servers
4773:
4774: sub metadata_query {
4775: my ($query,$custom,$customshow,$server_array)=@_;
4776: my %rhash;
4777: my %libserv = &all_library();
4778: my @server_list = (defined($server_array) ? @$server_array
4779: : keys(%libserv) );
4780: for my $server (@server_list) {
4781: unless ($custom or $customshow) {
4782: my $reply=&reply("querysend:".&escape($query),$server);
4783: $rhash{$server}=$reply;
4784: }
4785: else {
4786: my $reply=&reply("querysend:".&escape($query).':'.
4787: &escape($custom).':'.&escape($customshow),
4788: $server);
4789: $rhash{$server}=$reply;
4790: }
4791: }
4792: return \%rhash;
4793: }
4794:
4795: # ----------------------------------------- Send log queries and wait for reply
4796:
4797: sub log_query {
4798: my ($uname,$udom,$query,%filters)=@_;
4799: my $uhome=&homeserver($uname,$udom);
4800: if ($uhome eq 'no_host') { return 'error: no_host'; }
4801: my $uhost=&hostname($uhome);
4802: my $command=&escape(join(':',map{$_.'='.$filters{$_}} keys(%filters)));
4803: my $queryid=&reply("querysend:".$query.':'.$udom.':'.$uname.':'.$command,
4804: $uhome);
4805: unless ($queryid=~/^\Q$uhost\E\_/) { return 'error: '.$queryid; }
4806: return get_query_reply($queryid);
4807: }
4808:
4809: # -------------------------- Update MySQL table for portfolio file
4810:
4811: sub update_portfolio_table {
4812: my ($uname,$udom,$file_name,$query,$group,$action) = @_;
4813: my $homeserver = &homeserver($uname,$udom);
4814: my $queryid=
4815: &reply("querysend:".$query.':'.&escape($uname.':'.$udom.':'.$group).
4816: ':'.&escape($file_name).':'.$action,$homeserver);
4817: my $reply = &get_query_reply($queryid);
4818: return $reply;
4819: }
4820:
4821: # -------------------------- Update MySQL allusers table
4822:
4823: sub update_allusers_table {
4824: my ($uname,$udom,$names) = @_;
4825: my $homeserver = &homeserver($uname,$udom);
4826: my $queryid=
4827: &reply('querysend:allusers:'.&escape($uname).':'.&escape($udom).':'.
4828: 'lastname='.&escape($names->{'lastname'}).'%%'.
4829: 'firstname='.&escape($names->{'firstname'}).'%%'.
4830: 'middlename='.&escape($names->{'middlename'}).'%%'.
4831: 'generation='.&escape($names->{'generation'}).'%%'.
4832: 'permanentemail='.&escape($names->{'permanentemail'}).'%%'.
4833: 'id='.&escape($names->{'id'}),$homeserver);
4834: my $reply = &get_query_reply($queryid);
4835: return $reply;
4836: }
4837:
4838: # ------- Request retrieval of institutional classlists for course(s)
4839:
4840: sub fetch_enrollment_query {
4841: my ($context,$affiliatesref,$replyref,$dom,$cnum) = @_;
4842: my $homeserver;
4843: my $maxtries = 1;
4844: if ($context eq 'automated') {
4845: $homeserver = $perlvar{'lonHostID'};
4846: $maxtries = 10; # will wait for up to 2000s for retrieval of classlist data before timeout
4847: } else {
4848: $homeserver = &homeserver($cnum,$dom);
4849: }
4850: my $host=&hostname($homeserver);
4851: my $cmd = '';
4852: foreach my $affiliate (keys %{$affiliatesref}) {
4853: $cmd .= $affiliate.'='.join(",",@{$$affiliatesref{$affiliate}}).'%%';
4854: }
4855: $cmd =~ s/%%$//;
4856: $cmd = &escape($cmd);
4857: my $query = 'fetchenrollment';
4858: my $queryid=&reply("querysend:".$query.':'.$dom.':'.$env{'user.name'}.':'.$cmd,$homeserver);
4859: unless ($queryid=~/^\Q$host\E\_/) {
4860: &logthis('fetch_enrollment_query: invalid queryid: '.$queryid.' for host: '.$host.' and homeserver: '.$homeserver.' context: '.$context.' '.$cnum);
4861: return 'error: '.$queryid;
4862: }
4863: my $reply = &get_query_reply($queryid);
4864: my $tries = 1;
4865: while (($reply=~/^timeout/) && ($tries < $maxtries)) {
4866: $reply = &get_query_reply($queryid);
4867: $tries ++;
4868: }
4869: if ( ($reply =~/^timeout/) || ($reply =~/^error/) ) {
4870: &logthis('fetch_enrollment_query error: '.$reply.' for '.$dom.' '.$env{'user.name'}.' for '.$queryid.' context: '.$context.' '.$cnum.' maxtries: '.$maxtries.' tries: '.$tries);
4871: } else {
4872: my @responses = split(/:/,$reply);
4873: if ($homeserver eq $perlvar{'lonHostID'}) {
4874: foreach my $line (@responses) {
4875: my ($key,$value) = split(/=/,$line,2);
4876: $$replyref{$key} = $value;
4877: }
4878: } else {
4879: my $pathname = $perlvar{'lonDaemons'}.'/tmp';
4880: foreach my $line (@responses) {
4881: my ($key,$value) = split(/=/,$line);
4882: $$replyref{$key} = $value;
4883: if ($value > 0) {
4884: foreach my $item (@{$$affiliatesref{$key}}) {
4885: my $filename = $dom.'_'.$key.'_'.$item.'_classlist.xml';
4886: my $destname = $pathname.'/'.$filename;
4887: my $xml_classlist = &reply("autoretrieve:".$filename,$homeserver);
4888: if ($xml_classlist =~ /^error/) {
4889: &logthis('fetch_enrollment_query - autoretrieve error: '.$xml_classlist.' for '.$filename.' from server: '.$homeserver.' '.$context.' '.$cnum);
4890: } else {
4891: if ( open(FILE,">$destname") ) {
4892: print FILE &unescape($xml_classlist);
4893: close(FILE);
4894: } else {
4895: &logthis('fetch_enrollment_query - error opening classlist file '.$destname.' '.$context.' '.$cnum);
4896: }
4897: }
4898: }
4899: }
4900: }
4901: }
4902: return 'ok';
4903: }
4904: return 'error';
4905: }
4906:
4907: sub get_query_reply {
4908: my $queryid=shift;
4909: my $replyfile=$perlvar{'lonDaemons'}.'/tmp/'.$queryid;
4910: my $reply='';
4911: for (1..100) {
4912: sleep 2;
4913: if (-e $replyfile.'.end') {
4914: if (open(my $fh,$replyfile)) {
4915: $reply = join('',<$fh>);
4916: close($fh);
4917: } else { return 'error: reply_file_error'; }
4918: return &unescape($reply);
4919: }
4920: }
4921: return 'timeout:'.$queryid;
4922: }
4923:
4924: sub courselog_query {
4925: #
4926: # possible filters:
4927: # url: url or symb
4928: # username
4929: # domain
4930: # action: view, submit, grade
4931: # start: timestamp
4932: # end: timestamp
4933: #
4934: my (%filters)=@_;
4935: unless ($env{'request.course.id'}) { return 'no_course'; }
4936: if ($filters{'url'}) {
4937: $filters{'url'}=&symbclean(&declutter($filters{'url'}));
4938: $filters{'url'}=~s/\.(\w+)$/(\\.\\d+)*\\.$1/;
4939: $filters{'url'}=~s/\.(\w+)\_\_\_/(\\.\\d+)*\\.$1/;
4940: }
4941: my $cname=$env{'course.'.$env{'request.course.id'}.'.num'};
4942: my $cdom=$env{'course.'.$env{'request.course.id'}.'.domain'};
4943: return &log_query($cname,$cdom,'courselog',%filters);
4944: }
4945:
4946: sub userlog_query {
4947: #
4948: # possible filters:
4949: # action: log check role
4950: # start: timestamp
4951: # end: timestamp
4952: #
4953: my ($uname,$udom,%filters)=@_;
4954: return &log_query($uname,$udom,'userlog',%filters);
4955: }
4956:
4957: #--------- Call auto-enrollment subs in localenroll.pm for homeserver for course
4958:
4959: sub auto_run {
4960: my ($cnum,$cdom) = @_;
4961: my $response = 0;
4962: my $settings;
4963: my %domconfig = &get_dom('configuration',['autoenroll'],$cdom);
4964: if (ref($domconfig{'autoenroll'}) eq 'HASH') {
4965: $settings = $domconfig{'autoenroll'};
4966: if ($settings->{'run'} eq '1') {
4967: $response = 1;
4968: }
4969: } else {
4970: my $homeserver;
4971: if (&is_course($cdom,$cnum)) {
4972: $homeserver = &homeserver($cnum,$cdom);
4973: } else {
4974: $homeserver = &domain($cdom,'primary');
4975: }
4976: if ($homeserver ne 'no_host') {
4977: $response = &reply('autorun:'.$cdom,$homeserver);
4978: }
4979: }
4980: return $response;
4981: }
4982:
4983: sub auto_get_sections {
4984: my ($cnum,$cdom,$inst_coursecode) = @_;
4985: my $homeserver = &homeserver($cnum,$cdom);
4986: my @secs = ();
4987: my $response=&unescape(&reply('autogetsections:'.$inst_coursecode.':'.$cdom,$homeserver));
4988: unless ($response eq 'refused') {
4989: @secs = split(/:/,$response);
4990: }
4991: return @secs;
4992: }
4993:
4994: sub auto_new_course {
4995: my ($cnum,$cdom,$inst_course_id,$owner) = @_;
4996: my $homeserver = &homeserver($cnum,$cdom);
4997: my $response=&unescape(&reply('autonewcourse:'.$inst_course_id.':'.$owner.':'.$cdom,$homeserver));
4998: return $response;
4999: }
5000:
5001: sub auto_validate_courseID {
5002: my ($cnum,$cdom,$inst_course_id) = @_;
5003: my $homeserver = &homeserver($cnum,$cdom);
5004: my $response=&unescape(&reply('autovalidatecourse:'.$inst_course_id.':'.$cdom,$homeserver));
5005: return $response;
5006: }
5007:
5008: sub auto_create_password {
5009: my ($cnum,$cdom,$authparam,$udom) = @_;
5010: my ($homeserver,$response);
5011: my $create_passwd = 0;
5012: my $authchk = '';
5013: if ($udom =~ /^$match_domain$/) {
5014: $homeserver = &domain($udom,'primary');
5015: }
5016: if ($homeserver eq '') {
5017: if (($cdom =~ /^$match_domain$/) && ($cnum =~ /^$match_courseid$/)) {
5018: $homeserver = &homeserver($cnum,$cdom);
5019: }
5020: }
5021: if ($homeserver eq '') {
5022: $authchk = 'nodomain';
5023: } else {
5024: $response=&unescape(&reply('autocreatepassword:'.$authparam.':'.$cdom,$homeserver));
5025: if ($response eq 'refused') {
5026: $authchk = 'refused';
5027: } else {
5028: ($authparam,$create_passwd,$authchk) = split(/:/,$response);
5029: }
5030: }
5031: return ($authparam,$create_passwd,$authchk);
5032: }
5033:
5034: sub auto_photo_permission {
5035: my ($cnum,$cdom,$students) = @_;
5036: my $homeserver = &homeserver($cnum,$cdom);
5037: my ($outcome,$perm_reqd,$conditions) =
5038: split(/:/,&unescape(&reply('autophotopermission:'.$cdom,$homeserver)),3);
5039: if ($outcome =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
5040: return (undef,undef);
5041: }
5042: return ($outcome,$perm_reqd,$conditions);
5043: }
5044:
5045: sub auto_checkphotos {
5046: my ($uname,$udom,$pid) = @_;
5047: my $homeserver = &homeserver($uname,$udom);
5048: my ($result,$resulttype);
5049: my $outcome = &unescape(&reply('autophotocheck:'.&escape($udom).':'.
5050: &escape($uname).':'.&escape($pid),
5051: $homeserver));
5052: if ($outcome =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
5053: return (undef,undef);
5054: }
5055: if ($outcome) {
5056: ($result,$resulttype) = split(/:/,$outcome);
5057: }
5058: return ($result,$resulttype);
5059: }
5060:
5061: sub auto_photochoice {
5062: my ($cnum,$cdom) = @_;
5063: my $homeserver = &homeserver($cnum,$cdom);
5064: my ($update,$comment) = split(/:/,&unescape(&reply('autophotochoice:'.
5065: &escape($cdom),
5066: $homeserver)));
5067: if ($update =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
5068: return (undef,undef);
5069: }
5070: return ($update,$comment);
5071: }
5072:
5073: sub auto_photoupdate {
5074: my ($affiliatesref,$dom,$cnum,$photo) = @_;
5075: my $homeserver = &homeserver($cnum,$dom);
5076: my $host=&hostname($homeserver);
5077: my $cmd = '';
5078: my $maxtries = 1;
5079: foreach my $affiliate (keys(%{$affiliatesref})) {
5080: $cmd .= $affiliate.'='.join(",",@{$$affiliatesref{$affiliate}}).'%%';
5081: }
5082: $cmd =~ s/%%$//;
5083: $cmd = &escape($cmd);
5084: my $query = 'institutionalphotos';
5085: my $queryid=&reply("querysend:".$query.':'.$dom.':'.$cnum.':'.$cmd,$homeserver);
5086: unless ($queryid=~/^\Q$host\E\_/) {
5087: &logthis('institutionalphotos: invalid queryid: '.$queryid.' for host: '.$host.' and homeserver: '.$homeserver.' and course: '.$cnum);
5088: return 'error: '.$queryid;
5089: }
5090: my $reply = &get_query_reply($queryid);
5091: my $tries = 1;
5092: while (($reply=~/^timeout/) && ($tries < $maxtries)) {
5093: $reply = &get_query_reply($queryid);
5094: $tries ++;
5095: }
5096: if ( ($reply =~/^timeout/) || ($reply =~/^error/) ) {
5097: &logthis('institutionalphotos error: '.$reply.' for '.$dom.' '.$env{'user.name'}.' for '.$queryid.' course: '.$cnum.' maxtries: '.$maxtries.' tries: '.$tries);
5098: } else {
5099: my @responses = split(/:/,$reply);
5100: my $outcome = shift(@responses);
5101: foreach my $item (@responses) {
5102: my ($key,$value) = split(/=/,$item);
5103: $$photo{$key} = $value;
5104: }
5105: return $outcome;
5106: }
5107: return 'error';
5108: }
5109:
5110: sub auto_instcode_format {
5111: my ($caller,$codedom,$instcodes,$codes,$codetitles,$cat_titles,
5112: $cat_order) = @_;
5113: my $courses = '';
5114: my @homeservers;
5115: if ($caller eq 'global') {
5116: my %servers = &get_servers($codedom,'library');
5117: foreach my $tryserver (keys(%servers)) {
5118: if (!grep(/^\Q$tryserver\E$/,@homeservers)) {
5119: push(@homeservers,$tryserver);
5120: }
5121: }
5122: } else {
5123: push(@homeservers,&homeserver($caller,$codedom));
5124: }
5125: foreach my $code (keys(%{$instcodes})) {
5126: $courses .= &escape($code).'='.&escape($$instcodes{$code}).'&';
5127: }
5128: chop($courses);
5129: my $ok_response = 0;
5130: my $response;
5131: while (@homeservers > 0 && $ok_response == 0) {
5132: my $server = shift(@homeservers);
5133: $response=&reply('autoinstcodeformat:'.$codedom.':'.$courses,$server);
5134: if ($response !~ /(con_lost|error|no_such_host|refused)/) {
5135: my ($codes_str,$codetitles_str,$cat_titles_str,$cat_order_str) =
5136: split(/:/,$response);
5137: %{$codes} = (%{$codes},&str2hash($codes_str));
5138: push(@{$codetitles},&str2array($codetitles_str));
5139: %{$cat_titles} = (%{$cat_titles},&str2hash($cat_titles_str));
5140: %{$cat_order} = (%{$cat_order},&str2hash($cat_order_str));
5141: $ok_response = 1;
5142: }
5143: }
5144: if ($ok_response) {
5145: return 'ok';
5146: } else {
5147: return $response;
5148: }
5149: }
5150:
5151: sub auto_instcode_defaults {
5152: my ($domain,$returnhash,$code_order) = @_;
5153: my @homeservers;
5154:
5155: my %servers = &get_servers($domain,'library');
5156: foreach my $tryserver (keys(%servers)) {
5157: if (!grep(/^\Q$tryserver\E$/,@homeservers)) {
5158: push(@homeservers,$tryserver);
5159: }
5160: }
5161:
5162: my $response;
5163: foreach my $server (@homeservers) {
5164: $response=&reply('autoinstcodedefaults:'.$domain,$server);
5165: next if ($response =~ /(con_lost|error|no_such_host|refused)/);
5166:
5167: foreach my $pair (split(/\&/,$response)) {
5168: my ($name,$value)=split(/\=/,$pair);
5169: if ($name eq 'code_order') {
5170: @{$code_order} = split(/\&/,&unescape($value));
5171: } else {
5172: $returnhash->{&unescape($name)}=&unescape($value);
5173: }
5174: }
5175: return 'ok';
5176: }
5177:
5178: return $response;
5179: }
5180:
5181: sub auto_validate_class_sec {
5182: my ($cdom,$cnum,$owners,$inst_class) = @_;
5183: my $homeserver = &homeserver($cnum,$cdom);
5184: my $ownerlist;
5185: if (ref($owners) eq 'ARRAY') {
5186: $ownerlist = join(',',@{$owners});
5187: } else {
5188: $ownerlist = $owners;
5189: }
5190: my $response=&reply('autovalidateclass_sec:'.$inst_class.':'.
5191: &escape($ownerlist).':'.$cdom,$homeserver);
5192: return $response;
5193: }
5194:
5195: # ------------------------------------------------------- Course Group routines
5196:
5197: sub get_coursegroups {
5198: my ($cdom,$cnum,$group,$namespace) = @_;
5199: return(&dump($namespace,$cdom,$cnum,$group));
5200: }
5201:
5202: sub modify_coursegroup {
5203: my ($cdom,$cnum,$groupsettings) = @_;
5204: return(&put('coursegroups',$groupsettings,$cdom,$cnum));
5205: }
5206:
5207: sub toggle_coursegroup_status {
5208: my ($cdom,$cnum,$group,$action) = @_;
5209: my ($from_namespace,$to_namespace);
5210: if ($action eq 'delete') {
5211: $from_namespace = 'coursegroups';
5212: $to_namespace = 'deleted_groups';
5213: } else {
5214: $from_namespace = 'deleted_groups';
5215: $to_namespace = 'coursegroups';
5216: }
5217: my %curr_group = &get_coursegroups($cdom,$cnum,$group,$from_namespace);
5218: if (my $tmp = &error(%curr_group)) {
5219: &Apache::lonnet::logthis('Error retrieving group: '.$tmp.' in '.$cnum.':'.$cdom);
5220: return ('read error',$tmp);
5221: } else {
5222: my %savedsettings = %curr_group;
5223: my $result = &put($to_namespace,\%savedsettings,$cdom,$cnum);
5224: my $deloutcome;
5225: if ($result eq 'ok') {
5226: $deloutcome = &del($from_namespace,[$group],$cdom,$cnum);
5227: } else {
5228: return ('write error',$result);
5229: }
5230: if ($deloutcome eq 'ok') {
5231: return 'ok';
5232: } else {
5233: return ('delete error',$deloutcome);
5234: }
5235: }
5236: }
5237:
5238: sub modify_group_roles {
5239: my ($cdom,$cnum,$group_id,$user,$end,$start,$userprivs) = @_;
5240: my $url = '/'.$cdom.'/'.$cnum.'/'.$group_id;
5241: my $role = 'gr/'.&escape($userprivs);
5242: my ($uname,$udom) = split(/:/,$user);
5243: my $result = &assignrole($udom,$uname,$url,$role,$end,$start);
5244: if ($result eq 'ok') {
5245: &devalidate_getgroups_cache($udom,$uname,$cdom,$cnum);
5246: }
5247: return $result;
5248: }
5249:
5250: sub modify_coursegroup_membership {
5251: my ($cdom,$cnum,$membership) = @_;
5252: my $result = &put('groupmembership',$membership,$cdom,$cnum);
5253: return $result;
5254: }
5255:
5256: sub get_active_groups {
5257: my ($udom,$uname,$cdom,$cnum) = @_;
5258: my $now = time;
5259: my %groups = ();
5260: foreach my $key (keys(%env)) {
5261: if ($key =~ m-user\.role\.gr\./($match_domain)/($match_courseid)/(\w+)$-) {
5262: my ($start,$end) = split(/\./,$env{$key});
5263: if (($end!=0) && ($end<$now)) { next; }
5264: if (($start!=0) && ($start>$now)) { next; }
5265: if ($1 eq $cdom && $2 eq $cnum) {
5266: $groups{$3} = $env{$key} ;
5267: }
5268: }
5269: }
5270: return %groups;
5271: }
5272:
5273: sub get_group_membership {
5274: my ($cdom,$cnum,$group) = @_;
5275: return(&dump('groupmembership',$cdom,$cnum,$group));
5276: }
5277:
5278: sub get_users_groups {
5279: my ($udom,$uname,$courseid) = @_;
5280: my @usersgroups;
5281: my $cachetime=1800;
5282:
5283: my $hashid="$udom:$uname:$courseid";
5284: my ($grouplist,$cached)=&is_cached_new('getgroups',$hashid);
5285: if (defined($cached)) {
5286: @usersgroups = split(/:/,$grouplist);
5287: } else {
5288: $grouplist = '';
5289: my $courseurl = &courseid_to_courseurl($courseid);
5290: my %roleshash = &dump('roles',$udom,$uname,$courseurl);
5291: my $access_end = $env{'course.'.$courseid.
5292: '.default_enrollment_end_date'};
5293: my $now = time;
5294: foreach my $key (keys(%roleshash)) {
5295: if ($key =~ /^\Q$courseurl\E\/(\w+)\_gr$/) {
5296: my $group = $1;
5297: if ($roleshash{$key} =~ /_(\d+)_(\d+)$/) {
5298: my $start = $2;
5299: my $end = $1;
5300: if ($start == -1) { next; } # deleted from group
5301: if (($start!=0) && ($start>$now)) { next; }
5302: if (($end!=0) && ($end<$now)) {
5303: if ($access_end && $access_end < $now) {
5304: if ($access_end - $end < 86400) {
5305: push(@usersgroups,$group);
5306: }
5307: }
5308: next;
5309: }
5310: push(@usersgroups,$group);
5311: }
5312: }
5313: }
5314: @usersgroups = &sort_course_groups($courseid,@usersgroups);
5315: $grouplist = join(':',@usersgroups);
5316: &do_cache_new('getgroups',$hashid,$grouplist,$cachetime);
5317: }
5318: return @usersgroups;
5319: }
5320:
5321: sub devalidate_getgroups_cache {
5322: my ($udom,$uname,$cdom,$cnum)=@_;
5323: my $courseid = $cdom.'_'.$cnum;
5324:
5325: my $hashid="$udom:$uname:$courseid";
5326: &devalidate_cache_new('getgroups',$hashid);
5327: }
5328:
5329: # ------------------------------------------------------------------ Plain Text
5330:
5331: sub plaintext {
5332: my ($short,$type,$cid) = @_;
5333: if ($short =~ /^cr/) {
5334: return (split('/',$short))[-1];
5335: }
5336: if (!defined($cid)) {
5337: $cid = $env{'request.course.id'};
5338: }
5339: if (defined($cid) && defined($env{'course.'.$cid.'.'.$short.'.plaintext'})) {
5340: return &Apache::lonlocal::mt($env{'course.'.$cid.'.'.$short.
5341: '.plaintext'});
5342: }
5343: my %rolenames = (
5344: Course => 'std',
5345: Group => 'alt1',
5346: );
5347: if (defined($type) &&
5348: defined($rolenames{$type}) &&
5349: defined($prp{$short}{$rolenames{$type}})) {
5350: return &Apache::lonlocal::mt($prp{$short}{$rolenames{$type}});
5351: } else {
5352: return &Apache::lonlocal::mt($prp{$short}{'std'});
5353: }
5354: }
5355:
5356: # ----------------------------------------------------------------- Assign Role
5357:
5358: sub assignrole {
5359: my ($udom,$uname,$url,$role,$end,$start,$deleteflag,$selfenroll)=@_;
5360: my $mrole;
5361: if ($role =~ /^cr\//) {
5362: my $cwosec=$url;
5363: $cwosec=~s/^\/($match_domain)\/($match_courseid)\/.*/$1\/$2/;
5364: unless (&allowed('ccr',$cwosec)) {
5365: &logthis('Refused custom assignrole: '.
5366: $udom.' '.$uname.' '.$url.' '.$role.' '.$end.' '.$start.' by '.
5367: $env{'user.name'}.' at '.$env{'user.domain'});
5368: return 'refused';
5369: }
5370: $mrole='cr';
5371: } elsif ($role =~ /^gr\//) {
5372: my $cwogrp=$url;
5373: $cwogrp=~s{^/($match_domain)/($match_courseid)/.*}{$1/$2};
5374: unless (&allowed('mdg',$cwogrp)) {
5375: &logthis('Refused group assignrole: '.
5376: $udom.' '.$uname.' '.$url.' '.$role.' '.$end.' '.$start.' by '.
5377: $env{'user.name'}.' at '.$env{'user.domain'});
5378: return 'refused';
5379: }
5380: $mrole='gr';
5381: } else {
5382: my $cwosec=$url;
5383: $cwosec=~s/^\/($match_domain)\/($match_courseid)\/.*/$1\/$2/;
5384: if (!(&allowed('c'.$role,$cwosec)) && !(&allowed('c'.$role,$udom))) {
5385: my $refused;
5386: if (($env{'request.course.sec'} ne '') && ($role eq 'st')) {
5387: if (!(&allowed('c'.$role,$url))) {
5388: $refused = 1;
5389: }
5390: } else {
5391: $refused = 1;
5392: }
5393: if ($refused) {
5394: if (($selfenroll == 1) && ($role eq 'st') && ($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'})) {
5395: $refused = '';
5396: } else {
5397: &logthis('Refused assignrole: '.$udom.' '.$uname.' '.$url.
5398: ' '.$role.' '.$end.' '.$start.' by '.
5399: $env{'user.name'}.' at '.$env{'user.domain'});
5400: return 'refused';
5401: }
5402: }
5403: }
5404: $mrole=$role;
5405: }
5406: my $command="encrypt:rolesput:$env{'user.domain'}:$env{'user.name'}:".
5407: "$udom:$uname:$url".'_'."$mrole=$role";
5408: if ($end) { $command.='_'.$end; }
5409: if ($start) {
5410: if ($end) {
5411: $command.='_'.$start;
5412: } else {
5413: $command.='_0_'.$start;
5414: }
5415: }
5416: my $origstart = $start;
5417: my $origend = $end;
5418: # actually delete
5419: if ($deleteflag) {
5420: if ((&allowed('dro',$udom)) || (&allowed('dro',$url))) {
5421: # modify command to delete the role
5422: $command="encrypt:rolesdel:$env{'user.domain'}:$env{'user.name'}:".
5423: "$udom:$uname:$url".'_'."$mrole";
5424: &logthis("$env{'user.name'} at $env{'user.domain'} deletes $mrole in $url for $uname at $udom");
5425: # set start and finish to negative values for userrolelog
5426: $start=-1;
5427: $end=-1;
5428: }
5429: }
5430: # send command
5431: my $answer=&reply($command,&homeserver($uname,$udom));
5432: # log new user role if status is ok
5433: if ($answer eq 'ok') {
5434: &userrolelog($role,$uname,$udom,$url,$start,$end);
5435: # for course roles, perform group memberships changes triggered by role change.
5436: unless ($role =~ /^gr/) {
5437: &Apache::longroup::group_changes($udom,$uname,$url,$role,$origend,
5438: $origstart);
5439: }
5440: }
5441: return $answer;
5442: }
5443:
5444: # -------------------------------------------------- Modify user authentication
5445: # Overrides without validation
5446:
5447: sub modifyuserauth {
5448: my ($udom,$uname,$umode,$upass)=@_;
5449: my $uhome=&homeserver($uname,$udom);
5450: unless (&allowed('mau',$udom)) { return 'refused'; }
5451: &logthis('Call to modify user authentication '.$udom.', '.$uname.', '.
5452: $umode.' by '.$env{'user.name'}.' at '.$env{'user.domain'}.
5453: ' in domain '.$env{'request.role.domain'});
5454: my $reply=&reply('encrypt:changeuserauth:'.$udom.':'.$uname.':'.$umode.':'.
5455: &escape($upass),$uhome);
5456: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},
5457: 'Authentication changed for '.$udom.', '.$uname.', '.$umode.
5458: '(Remote '.$ENV{'REMOTE_ADDR'}.'): '.$reply);
5459: &log($udom,,$uname,$uhome,
5460: 'Authentication changed by '.$env{'user.domain'}.', '.
5461: $env{'user.name'}.', '.$umode.
5462: '(Remote '.$ENV{'REMOTE_ADDR'}.'): '.$reply);
5463: unless ($reply eq 'ok') {
5464: &logthis('Authentication mode error: '.$reply);
5465: return 'error: '.$reply;
5466: }
5467: return 'ok';
5468: }
5469:
5470: # --------------------------------------------------------------- Modify a user
5471:
5472: sub modifyuser {
5473: my ($udom, $uname, $uid,
5474: $umode, $upass, $first,
5475: $middle, $last, $gene,
5476: $forceid, $desiredhome, $email)=@_;
5477: $udom= &LONCAPA::clean_domain($udom);
5478: $uname=&LONCAPA::clean_username($uname);
5479: &logthis('Call to modify user '.$udom.', '.$uname.', '.$uid.', '.
5480: $umode.', '.$first.', '.$middle.', '.
5481: $last.', '.$gene.'(forceid: '.$forceid.')'.
5482: (defined($desiredhome) ? ' desiredhome = '.$desiredhome :
5483: ' desiredhome not specified').
5484: ' by '.$env{'user.name'}.' at '.$env{'user.domain'}.
5485: ' in domain '.$env{'request.role.domain'});
5486: my $uhome=&homeserver($uname,$udom,'true');
5487: # ----------------------------------------------------------------- Create User
5488: if (($uhome eq 'no_host') &&
5489: (($umode && $upass) || ($umode eq 'localauth'))) {
5490: my $unhome='';
5491: if (defined($desiredhome) && &host_domain($desiredhome) eq $udom) {
5492: $unhome = $desiredhome;
5493: } elsif($env{'course.'.$env{'request.course.id'}.'.domain'} eq $udom) {
5494: $unhome=$env{'course.'.$env{'request.course.id'}.'.home'};
5495: } else { # load balancing routine for determining $unhome
5496: my $loadm=10000000;
5497: my %servers = &get_servers($udom,'library');
5498: foreach my $tryserver (keys(%servers)) {
5499: my $answer=reply('load',$tryserver);
5500: if (($answer=~/\d+/) && ($answer<$loadm)) {
5501: $loadm=$answer;
5502: $unhome=$tryserver;
5503: }
5504: }
5505: }
5506: if (($unhome eq '') || ($unhome eq 'no_host')) {
5507: return 'error: unable to find a home server for '.$uname.
5508: ' in domain '.$udom;
5509: }
5510: my $reply=&reply('encrypt:makeuser:'.$udom.':'.$uname.':'.$umode.':'.
5511: &escape($upass),$unhome);
5512: unless ($reply eq 'ok') {
5513: return 'error: '.$reply;
5514: }
5515: $uhome=&homeserver($uname,$udom,'true');
5516: if (($uhome eq '') || ($uhome eq 'no_host') || ($uhome ne $unhome)) {
5517: return 'error: unable verify users home machine.';
5518: }
5519: } # End of creation of new user
5520: # ---------------------------------------------------------------------- Add ID
5521: if ($uid) {
5522: $uid=~tr/A-Z/a-z/;
5523: my %uidhash=&idrget($udom,$uname);
5524: if (($uidhash{$uname}) && ($uidhash{$uname}!~/error\:/)
5525: && (!$forceid)) {
5526: unless ($uid eq $uidhash{$uname}) {
5527: return 'error: user id "'.$uid.'" does not match '.
5528: 'current user id "'.$uidhash{$uname}.'".';
5529: }
5530: } else {
5531: &idput($udom,($uname => $uid));
5532: }
5533: }
5534: # -------------------------------------------------------------- Add names, etc
5535: my @tmp=&get('environment',
5536: ['firstname','middlename','lastname','generation','id',
5537: 'permanentemail'],
5538: $udom,$uname);
5539: my %names;
5540: if ($tmp[0] =~ m/^error:.*/) {
5541: %names=();
5542: } else {
5543: %names = @tmp;
5544: }
5545: #
5546: # Make sure to not trash student environment if instructor does not bother
5547: # to supply name and email information
5548: #
5549: if ($first) { $names{'firstname'} = $first; }
5550: if (defined($middle)) { $names{'middlename'} = $middle; }
5551: if ($last) { $names{'lastname'} = $last; }
5552: if (defined($gene)) { $names{'generation'} = $gene; }
5553: if ($email) {
5554: $email=~s/[^\w\@\.\-\,]//gs;
5555: if ($email=~/\@/) { $names{'notification'} = $email;
5556: $names{'critnotification'} = $email;
5557: $names{'permanentemail'} = $email; }
5558: }
5559: if ($uid) { $names{'id'} = $uid; }
5560: my $reply = &put('environment', \%names, $udom,$uname);
5561: if ($reply ne 'ok') { return 'error: '.$reply; }
5562: my $sqlresult = &update_allusers_table($uname,$udom,\%names);
5563: &devalidate_cache_new('namescache',$uname.':'.$udom);
5564: &logthis('Success modifying user '.$udom.', '.$uname.', '.$uid.', '.
5565: $umode.', '.$first.', '.$middle.', '.
5566: $last.', '.$gene.' by '.
5567: $env{'user.name'}.' at '.$env{'user.domain'});
5568: return 'ok';
5569: }
5570:
5571: # -------------------------------------------------------------- Modify student
5572:
5573: sub modifystudent {
5574: my ($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene,$usec,
5575: $end,$start,$forceid,$desiredhome,$email,$type,$locktype,$cid)=@_;
5576: if (!$cid) {
5577: unless ($cid=$env{'request.course.id'}) {
5578: return 'not_in_class';
5579: }
5580: }
5581: # --------------------------------------------------------------- Make the user
5582: my $reply=&modifyuser
5583: ($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene,$forceid,
5584: $desiredhome,$email);
5585: unless ($reply eq 'ok') { return $reply; }
5586: # This will cause &modify_student_enrollment to get the uid from the
5587: # students environment
5588: $uid = undef if (!$forceid);
5589: $reply = &modify_student_enrollment($udom,$uname,$uid,$first,$middle,$last,
5590: $gene,$usec,$end,$start,$type,$locktype,$cid);
5591: return $reply;
5592: }
5593:
5594: sub modify_student_enrollment {
5595: my ($udom,$uname,$uid,$first,$middle,$last,$gene,$usec,$end,$start,$type,$locktype,$cid,$selfenroll) = @_;
5596: my ($cdom,$cnum,$chome);
5597: if (!$cid) {
5598: unless ($cid=$env{'request.course.id'}) {
5599: return 'not_in_class';
5600: }
5601: $cdom=$env{'course.'.$cid.'.domain'};
5602: $cnum=$env{'course.'.$cid.'.num'};
5603: } else {
5604: ($cdom,$cnum)=split(/_/,$cid);
5605: }
5606: $chome=$env{'course.'.$cid.'.home'};
5607: if (!$chome) {
5608: $chome=&homeserver($cnum,$cdom);
5609: }
5610: if (!$chome) { return 'unknown_course'; }
5611: # Make sure the user exists
5612: my $uhome=&homeserver($uname,$udom);
5613: if (($uhome eq '') || ($uhome eq 'no_host')) {
5614: return 'error: no such user';
5615: }
5616: # Get student data if we were not given enough information
5617: if (!defined($first) || $first eq '' ||
5618: !defined($last) || $last eq '' ||
5619: !defined($uid) || $uid eq '' ||
5620: !defined($middle) || $middle eq '' ||
5621: !defined($gene) || $gene eq '') {
5622: # They did not supply us with enough data to enroll the student, so
5623: # we need to pick up more information.
5624: my %tmp = &get('environment',
5625: ['firstname','middlename','lastname', 'generation','id']
5626: ,$udom,$uname);
5627:
5628: #foreach my $key (keys(%tmp)) {
5629: # &logthis("key $key = ".$tmp{$key});
5630: #}
5631: $first = $tmp{'firstname'} if (!defined($first) || $first eq '');
5632: $middle = $tmp{'middlename'} if (!defined($middle) || $middle eq '');
5633: $last = $tmp{'lastname'} if (!defined($last) || $last eq '');
5634: $gene = $tmp{'generation'} if (!defined($gene) || $gene eq '');
5635: $uid = $tmp{'id'} if (!defined($uid) || $uid eq '');
5636: }
5637: my $fullname = &format_name($first,$middle,$last,$gene,'lastname');
5638: my $reply=cput('classlist',
5639: {"$uname:$udom" =>
5640: join(':',$end,$start,$uid,$usec,$fullname,$type,$locktype) },
5641: $cdom,$cnum);
5642: unless (($reply eq 'ok') || ($reply eq 'delayed')) {
5643: return 'error: '.$reply;
5644: } else {
5645: &devalidate_getsection_cache($udom,$uname,$cid);
5646: }
5647: # Add student role to user
5648: my $uurl='/'.$cid;
5649: $uurl=~s/\_/\//g;
5650: if ($usec) {
5651: $uurl.='/'.$usec;
5652: }
5653: return &assignrole($udom,$uname,$uurl,'st',$end,$start,undef,$selfenroll);
5654: }
5655:
5656: sub format_name {
5657: my ($firstname,$middlename,$lastname,$generation,$first)=@_;
5658: my $name;
5659: if ($first ne 'lastname') {
5660: $name=$firstname.' '.$middlename.' '.$lastname.' '.$generation;
5661: } else {
5662: if ($lastname=~/\S/) {
5663: $name.= $lastname.' '.$generation.', '.$firstname.' '.$middlename;
5664: $name=~s/\s+,/,/;
5665: } else {
5666: $name.= $firstname.' '.$middlename.' '.$generation;
5667: }
5668: }
5669: $name=~s/^\s+//;
5670: $name=~s/\s+$//;
5671: $name=~s/\s+/ /g;
5672: return $name;
5673: }
5674:
5675: # ------------------------------------------------- Write to course preferences
5676:
5677: sub writecoursepref {
5678: my ($courseid,%prefs)=@_;
5679: $courseid=~s/^\///;
5680: $courseid=~s/\_/\//g;
5681: my ($cdomain,$cnum)=split(/\//,$courseid);
5682: my $chome=homeserver($cnum,$cdomain);
5683: if (($chome eq '') || ($chome eq 'no_host')) {
5684: return 'error: no such course';
5685: }
5686: my $cstring='';
5687: foreach my $pref (keys(%prefs)) {
5688: $cstring.=&escape($pref).'='.&escape($prefs{$pref}).'&';
5689: }
5690: $cstring=~s/\&$//;
5691: return reply('put:'.$cdomain.':'.$cnum.':environment:'.$cstring,$chome);
5692: }
5693:
5694: # ---------------------------------------------------------- Make/modify course
5695:
5696: sub createcourse {
5697: my ($udom,$description,$url,$course_server,$nonstandard,$inst_code,
5698: $course_owner,$crstype)=@_;
5699: $url=&declutter($url);
5700: my $cid='';
5701: unless (&allowed('ccc',$udom)) {
5702: return 'refused';
5703: }
5704: # ------------------------------------------------------------------- Create ID
5705: my $uname=int(1+rand(9)).
5706: ('a'..'z','A'..'Z','0'..'9')[int(rand(62))].
5707: substr($$.time,0,5).unpack("H8",pack("I32",time)).
5708: unpack("H2",pack("I32",int(rand(255)))).$perlvar{'lonHostID'};
5709: # ----------------------------------------------- Make sure that does not exist
5710: my $uhome=&homeserver($uname,$udom,'true');
5711: unless (($uhome eq '') || ($uhome eq 'no_host')) {
5712: $uname=substr($$.time,0,5).unpack("H8",pack("I32",time)).
5713: unpack("H2",pack("I32",int(rand(255)))).$perlvar{'lonHostID'};
5714: $uhome=&homeserver($uname,$udom,'true');
5715: unless (($uhome eq '') || ($uhome eq 'no_host')) {
5716: return 'error: unable to generate unique course-ID';
5717: }
5718: }
5719: # ------------------------------------------------ Check supplied server name
5720: $course_server = $env{'user.homeserver'} if (! defined($course_server));
5721: if (! &is_library($course_server)) {
5722: return 'error:bad server name '.$course_server;
5723: }
5724: # ------------------------------------------------------------- Make the course
5725: my $reply=&reply('encrypt:makeuser:'.$udom.':'.$uname.':none::',
5726: $course_server);
5727: unless ($reply eq 'ok') { return 'error: '.$reply; }
5728: $uhome=&homeserver($uname,$udom,'true');
5729: if (($uhome eq '') || ($uhome eq 'no_host')) {
5730: return 'error: no such course';
5731: }
5732: # ----------------------------------------------------------------- Course made
5733: # log existence
5734: my $newcourse = {
5735: $udom.'_'.$uname => {
5736: description => $description,
5737: inst_code => $inst_code,
5738: owner => $course_owner,
5739: type => $crstype,
5740: },
5741: };
5742: &courseidput($udom,$newcourse,$uhome,'notime');
5743: # set toplevel url
5744: my $topurl=$url;
5745: unless ($nonstandard) {
5746: # ------------------------------------------ For standard courses, make top url
5747: my $mapurl=&clutter($url);
5748: if ($mapurl eq '/res/') { $mapurl=''; }
5749: $env{'form.initmap'}=(<<ENDINITMAP);
5750: <map>
5751: <resource id="1" type="start"></resource>
5752: <resource id="2" src="$mapurl"></resource>
5753: <resource id="3" type="finish"></resource>
5754: <link index="1" from="1" to="2"></link>
5755: <link index="2" from="2" to="3"></link>
5756: </map>
5757: ENDINITMAP
5758: $topurl=&declutter(
5759: &finishuserfileupload($uname,$udom,'initmap','default.sequence')
5760: );
5761: }
5762: # ----------------------------------------------------------- Write preferences
5763: &writecoursepref($udom.'_'.$uname,
5764: ('description' => $description,
5765: 'url' => $topurl));
5766: return '/'.$udom.'/'.$uname;
5767: }
5768:
5769: sub is_course {
5770: my ($cdom,$cnum) = @_;
5771: my %courses = &courseiddump($cdom,'.',1,'.','.',$cnum,undef,
5772: undef,'.');
5773: if (exists($courses{$cdom.'_'.$cnum})) {
5774: return 1;
5775: }
5776: return 0;
5777: }
5778:
5779: # ---------------------------------------------------------- Assign Custom Role
5780:
5781: sub assigncustomrole {
5782: my ($udom,$uname,$url,$rdom,$rnam,$rolename,$end,$start,$deleteflag)=@_;
5783: return &assignrole($udom,$uname,$url,'cr/'.$rdom.'/'.$rnam.'/'.$rolename,
5784: $end,$start,$deleteflag);
5785: }
5786:
5787: # ----------------------------------------------------------------- Revoke Role
5788:
5789: sub revokerole {
5790: my ($udom,$uname,$url,$role,$deleteflag)=@_;
5791: my $now=time;
5792: return &assignrole($udom,$uname,$url,$role,$now,$deleteflag);
5793: }
5794:
5795: # ---------------------------------------------------------- Revoke Custom Role
5796:
5797: sub revokecustomrole {
5798: my ($udom,$uname,$url,$rdom,$rnam,$rolename,$deleteflag)=@_;
5799: my $now=time;
5800: return &assigncustomrole($udom,$uname,$url,$rdom,$rnam,$rolename,$now,
5801: $deleteflag);
5802: }
5803:
5804: # ------------------------------------------------------------ Disk usage
5805: sub diskusage {
5806: my ($udom,$uname,$directorypath,$getpropath)=@_;
5807: $directorypath =~ s/\/$//;
5808: my $listing=&reply('du2:'.&escape($directorypath).':'
5809: .&escape($getpropath).':'.&escape($uname).':'
5810: .&escape($udom),homeserver($uname,$udom));
5811: if ($listing eq 'unknown_cmd') {
5812: if ($getpropath) {
5813: $directorypath = &propath($udom,$uname).'/'.$directorypath;
5814: }
5815: $listing = &reply('du:'.$directorypath,homeserver($uname,$udom));
5816: }
5817: return $listing;
5818: }
5819:
5820: sub is_locked {
5821: my ($file_name, $domain, $user) = @_;
5822: my @check;
5823: my $is_locked;
5824: push @check, $file_name;
5825: my %locked = &get('file_permissions',\@check,
5826: $env{'user.domain'},$env{'user.name'});
5827: my ($tmp)=keys(%locked);
5828: if ($tmp=~/^error:/) { undef(%locked); }
5829:
5830: if (ref($locked{$file_name}) eq 'ARRAY') {
5831: $is_locked = 'false';
5832: foreach my $entry (@{$locked{$file_name}}) {
5833: if (ref($entry) eq 'ARRAY') {
5834: $is_locked = 'true';
5835: last;
5836: }
5837: }
5838: } else {
5839: $is_locked = 'false';
5840: }
5841: }
5842:
5843: sub declutter_portfile {
5844: my ($file) = @_;
5845: $file =~ s{^(/portfolio/|portfolio/)}{/};
5846: return $file;
5847: }
5848:
5849: # ------------------------------------------------------------- Mark as Read Only
5850:
5851: sub mark_as_readonly {
5852: my ($domain,$user,$files,$what) = @_;
5853: my %current_permissions = &dump('file_permissions',$domain,$user);
5854: my ($tmp)=keys(%current_permissions);
5855: if ($tmp=~/^error:/) { undef(%current_permissions); }
5856: foreach my $file (@{$files}) {
5857: $file = &declutter_portfile($file);
5858: push(@{$current_permissions{$file}},$what);
5859: }
5860: &put('file_permissions',\%current_permissions,$domain,$user);
5861: return;
5862: }
5863:
5864: # ------------------------------------------------------------Save Selected Files
5865:
5866: sub save_selected_files {
5867: my ($user, $path, @files) = @_;
5868: my $filename = $user."savedfiles";
5869: my @other_files = &files_not_in_path($user, $path);
5870: open (OUT, '>'.$tmpdir.$filename);
5871: foreach my $file (@files) {
5872: print (OUT $env{'form.currentpath'}.$file."\n");
5873: }
5874: foreach my $file (@other_files) {
5875: print (OUT $file."\n");
5876: }
5877: close (OUT);
5878: return 'ok';
5879: }
5880:
5881: sub clear_selected_files {
5882: my ($user) = @_;
5883: my $filename = $user."savedfiles";
5884: open (OUT, '>'.$Apache::lonnet::perlvar{'lonDaemons'}.'/tmp/'.$filename);
5885: print (OUT undef);
5886: close (OUT);
5887: return ("ok");
5888: }
5889:
5890: sub files_in_path {
5891: my ($user, $path) = @_;
5892: my $filename = $user."savedfiles";
5893: my %return_files;
5894: open (IN, '<'.$Apache::lonnet::perlvar{'lonDaemons'}.'/tmp/'.$filename);
5895: while (my $line_in = <IN>) {
5896: chomp ($line_in);
5897: my @paths_and_file = split (m!/!, $line_in);
5898: my $file_part = pop (@paths_and_file);
5899: my $path_part = join ('/', @paths_and_file);
5900: $path_part.='/';
5901: my $path_and_file = $path_part.$file_part;
5902: if ($path_part eq $path) {
5903: $return_files{$file_part}= 'selected';
5904: }
5905: }
5906: close (IN);
5907: return (\%return_files);
5908: }
5909:
5910: # called in portfolio select mode, to show files selected NOT in current directory
5911: sub files_not_in_path {
5912: my ($user, $path) = @_;
5913: my $filename = $user."savedfiles";
5914: my @return_files;
5915: my $path_part;
5916: open(IN, '<'.$Apache::lonnet::perlvar{'lonDaemons'}.'/tmp/'.$filename);
5917: while (my $line = <IN>) {
5918: #ok, I know it's clunky, but I want it to work
5919: my @paths_and_file = split(m|/|, $line);
5920: my $file_part = pop(@paths_and_file);
5921: chomp($file_part);
5922: my $path_part = join('/', @paths_and_file);
5923: $path_part .= '/';
5924: my $path_and_file = $path_part.$file_part;
5925: if ($path_part ne $path) {
5926: push(@return_files, ($path_and_file));
5927: }
5928: }
5929: close(OUT);
5930: return (@return_files);
5931: }
5932:
5933: #----------------------------------------------Get portfolio file permissions
5934:
5935: sub get_portfile_permissions {
5936: my ($domain,$user) = @_;
5937: my %current_permissions = &dump('file_permissions',$domain,$user);
5938: my ($tmp)=keys(%current_permissions);
5939: if ($tmp=~/^error:/) { undef(%current_permissions); }
5940: return \%current_permissions;
5941: }
5942:
5943: #---------------------------------------------Get portfolio file access controls
5944:
5945: sub get_access_controls {
5946: my ($current_permissions,$group,$file) = @_;
5947: my %access;
5948: my $real_file = $file;
5949: $file =~ s/\.meta$//;
5950: if (defined($file)) {
5951: if (ref($$current_permissions{$file."\0".'accesscontrol'}) eq 'HASH') {
5952: foreach my $control (keys(%{$$current_permissions{$file."\0".'accesscontrol'}})) {
5953: $access{$real_file}{$control} = $$current_permissions{$file."\0".$control};
5954: }
5955: }
5956: } else {
5957: foreach my $key (keys(%{$current_permissions})) {
5958: if ($key =~ /\0accesscontrol$/) {
5959: if (defined($group)) {
5960: if ($key !~ m-^\Q$group\E/-) {
5961: next;
5962: }
5963: }
5964: my ($fullpath) = split(/\0/,$key);
5965: if (ref($$current_permissions{$key}) eq 'HASH') {
5966: foreach my $control (keys(%{$$current_permissions{$key}})) {
5967: $access{$fullpath}{$control}=$$current_permissions{$fullpath."\0".$control};
5968: }
5969: }
5970: }
5971: }
5972: }
5973: return %access;
5974: }
5975:
5976: sub modify_access_controls {
5977: my ($file_name,$changes,$domain,$user)=@_;
5978: my ($outcome,$deloutcome);
5979: my %store_permissions;
5980: my %new_values;
5981: my %new_control;
5982: my %translation;
5983: my @deletions = ();
5984: my $now = time;
5985: if (exists($$changes{'activate'})) {
5986: if (ref($$changes{'activate'}) eq 'HASH') {
5987: my @newitems = sort(keys(%{$$changes{'activate'}}));
5988: my $numnew = scalar(@newitems);
5989: for (my $i=0; $i<$numnew; $i++) {
5990: my $newkey = $newitems[$i];
5991: my $newid = &Apache::loncommon::get_cgi_id();
5992: if ($newkey =~ /^\d+:/) {
5993: $newkey =~ s/^(\d+)/$newid/;
5994: $translation{$1} = $newid;
5995: } elsif ($newkey =~ /^\d+_\d+_\d+:/) {
5996: $newkey =~ s/^(\d+_\d+_\d+)/$newid/;
5997: $translation{$1} = $newid;
5998: }
5999: $new_values{$file_name."\0".$newkey} =
6000: $$changes{'activate'}{$newitems[$i]};
6001: $new_control{$newkey} = $now;
6002: }
6003: }
6004: }
6005: my %todelete;
6006: my %changed_items;
6007: foreach my $action ('delete','update') {
6008: if (exists($$changes{$action})) {
6009: if (ref($$changes{$action}) eq 'HASH') {
6010: foreach my $key (keys(%{$$changes{$action}})) {
6011: my ($itemnum) = ($key =~ /^([^:]+):/);
6012: if ($action eq 'delete') {
6013: $todelete{$itemnum} = 1;
6014: } else {
6015: $changed_items{$itemnum} = $key;
6016: }
6017: }
6018: }
6019: }
6020: }
6021: # get lock on access controls for file.
6022: my $lockhash = {
6023: $file_name."\0".'locked_access_records' => $env{'user.name'}.
6024: ':'.$env{'user.domain'},
6025: };
6026: my $tries = 0;
6027: my $gotlock = &newput('file_permissions',$lockhash,$domain,$user);
6028:
6029: while (($gotlock ne 'ok') && $tries <3) {
6030: $tries ++;
6031: sleep 1;
6032: $gotlock = &newput('file_permissions',$lockhash,$domain,$user);
6033: }
6034: if ($gotlock eq 'ok') {
6035: my %curr_permissions = &dump('file_permissions',$domain,$user,$file_name);
6036: my ($tmp)=keys(%curr_permissions);
6037: if ($tmp=~/^error:/) { undef(%curr_permissions); }
6038: if (exists($curr_permissions{$file_name."\0".'accesscontrol'})) {
6039: my $curr_controls = $curr_permissions{$file_name."\0".'accesscontrol'};
6040: if (ref($curr_controls) eq 'HASH') {
6041: foreach my $control_item (keys(%{$curr_controls})) {
6042: my ($itemnum) = ($control_item =~ /^([^:]+):/);
6043: if (defined($todelete{$itemnum})) {
6044: push(@deletions,$file_name."\0".$control_item);
6045: } else {
6046: if (defined($changed_items{$itemnum})) {
6047: $new_control{$changed_items{$itemnum}} = $now;
6048: push(@deletions,$file_name."\0".$control_item);
6049: $new_values{$file_name."\0".$changed_items{$itemnum}} = $$changes{'update'}{$changed_items{$itemnum}};
6050: } else {
6051: $new_control{$control_item} = $$curr_controls{$control_item};
6052: }
6053: }
6054: }
6055: }
6056: }
6057: $deloutcome = &del('file_permissions',\@deletions,$domain,$user);
6058: $new_values{$file_name."\0".'accesscontrol'} = \%new_control;
6059: $outcome = &put('file_permissions',\%new_values,$domain,$user);
6060: # remove lock
6061: my @del_lock = ($file_name."\0".'locked_access_records');
6062: my $dellockoutcome = &del('file_permissions',\@del_lock,$domain,$user);
6063: my ($file,$group);
6064: if (&is_course($domain,$user)) {
6065: ($group,$file) = split(/\//,$file_name,2);
6066: } else {
6067: $file = $file_name;
6068: }
6069: my $sqlresult =
6070: &update_portfolio_table($user,$domain,$file,'portfolio_access',
6071: $group);
6072: } else {
6073: $outcome = "error: could not obtain lockfile\n";
6074: }
6075: return ($outcome,$deloutcome,\%new_values,\%translation);
6076: }
6077:
6078: sub make_public_indefinitely {
6079: my ($requrl) = @_;
6080: my $now = time;
6081: my $action = 'activate';
6082: my $aclnum = 0;
6083: if (&is_portfolio_url($requrl)) {
6084: my (undef,$udom,$unum,$file_name,$group) =
6085: &parse_portfolio_url($requrl);
6086: my $current_perms = &get_portfile_permissions($udom,$unum);
6087: my %access_controls = &get_access_controls($current_perms,
6088: $group,$file_name);
6089: foreach my $key (keys(%{$access_controls{$file_name}})) {
6090: my ($num,$scope,$end,$start) =
6091: ($key =~ /^([^:]+):([a-z]+)_(\d*)_?(\d*)$/);
6092: if ($scope eq 'public') {
6093: if ($start <= $now && $end == 0) {
6094: $action = 'none';
6095: } else {
6096: $action = 'update';
6097: $aclnum = $num;
6098: }
6099: last;
6100: }
6101: }
6102: if ($action eq 'none') {
6103: return 'ok';
6104: } else {
6105: my %changes;
6106: my $newend = 0;
6107: my $newstart = $now;
6108: my $newkey = $aclnum.':public_'.$newend.'_'.$newstart;
6109: $changes{$action}{$newkey} = {
6110: type => 'public',
6111: time => {
6112: start => $newstart,
6113: end => $newend,
6114: },
6115: };
6116: my ($outcome,$deloutcome,$new_values,$translation) =
6117: &modify_access_controls($file_name,\%changes,$udom,$unum);
6118: return $outcome;
6119: }
6120: } else {
6121: return 'invalid';
6122: }
6123: }
6124:
6125: #------------------------------------------------------Get Marked as Read Only
6126:
6127: sub get_marked_as_readonly {
6128: my ($domain,$user,$what,$group) = @_;
6129: my $current_permissions = &get_portfile_permissions($domain,$user);
6130: my @readonly_files;
6131: my $cmp1=$what;
6132: if (ref($what)) { $cmp1=join('',@{$what}) };
6133: while (my ($file_name,$value) = each(%{$current_permissions})) {
6134: if (defined($group)) {
6135: if ($file_name !~ m-^\Q$group\E/-) {
6136: next;
6137: }
6138: }
6139: if (ref($value) eq "ARRAY"){
6140: foreach my $stored_what (@{$value}) {
6141: my $cmp2=$stored_what;
6142: if (ref($stored_what) eq 'ARRAY') {
6143: $cmp2=join('',@{$stored_what});
6144: }
6145: if ($cmp1 eq $cmp2) {
6146: push(@readonly_files, $file_name);
6147: last;
6148: } elsif (!defined($what)) {
6149: push(@readonly_files, $file_name);
6150: last;
6151: }
6152: }
6153: }
6154: }
6155: return @readonly_files;
6156: }
6157: #-----------------------------------------------------------Get Marked as Read Only Hash
6158:
6159: sub get_marked_as_readonly_hash {
6160: my ($current_permissions,$group,$what) = @_;
6161: my %readonly_files;
6162: while (my ($file_name,$value) = each(%{$current_permissions})) {
6163: if (defined($group)) {
6164: if ($file_name !~ m-^\Q$group\E/-) {
6165: next;
6166: }
6167: }
6168: if (ref($value) eq "ARRAY"){
6169: foreach my $stored_what (@{$value}) {
6170: if (ref($stored_what) eq 'ARRAY') {
6171: foreach my $lock_descriptor(@{$stored_what}) {
6172: if ($lock_descriptor eq 'graded') {
6173: $readonly_files{$file_name} = 'graded';
6174: } elsif ($lock_descriptor eq 'handback') {
6175: $readonly_files{$file_name} = 'handback';
6176: } else {
6177: if (!exists($readonly_files{$file_name})) {
6178: $readonly_files{$file_name} = 'locked';
6179: }
6180: }
6181: }
6182: }
6183: }
6184: }
6185: }
6186: return %readonly_files;
6187: }
6188: # ------------------------------------------------------------ Unmark as Read Only
6189:
6190: sub unmark_as_readonly {
6191: # unmarks $file_name (if $file_name is defined), or all files locked by $what
6192: # for portfolio submissions, $what contains [$symb,$crsid]
6193: my ($domain,$user,$what,$file_name,$group) = @_;
6194: $file_name = &declutter_portfile($file_name);
6195: my $symb_crs = $what;
6196: if (ref($what)) { $symb_crs=join('',@$what); }
6197: my %current_permissions = &dump('file_permissions',$domain,$user,$group);
6198: my ($tmp)=keys(%current_permissions);
6199: if ($tmp=~/^error:/) { undef(%current_permissions); }
6200: my @readonly_files = &get_marked_as_readonly($domain,$user,$what,$group);
6201: foreach my $file (@readonly_files) {
6202: my $clean_file = &declutter_portfile($file);
6203: if (defined($file_name) && ($file_name ne $clean_file)) { next; }
6204: my $current_locks = $current_permissions{$file};
6205: my @new_locks;
6206: my @del_keys;
6207: if (ref($current_locks) eq "ARRAY"){
6208: foreach my $locker (@{$current_locks}) {
6209: my $compare=$locker;
6210: if (ref($locker) eq 'ARRAY') {
6211: $compare=join('',@{$locker});
6212: if ($compare ne $symb_crs) {
6213: push(@new_locks, $locker);
6214: }
6215: }
6216: }
6217: if (scalar(@new_locks) > 0) {
6218: $current_permissions{$file} = \@new_locks;
6219: } else {
6220: push(@del_keys, $file);
6221: &del('file_permissions',\@del_keys, $domain, $user);
6222: delete($current_permissions{$file});
6223: }
6224: }
6225: }
6226: &put('file_permissions',\%current_permissions,$domain,$user);
6227: return;
6228: }
6229:
6230: # ------------------------------------------------------------ Directory lister
6231:
6232: sub dirlist {
6233: my ($uri,$userdomain,$username,$getpropath,$getuserdir,$alternateRoot)=@_;
6234: $uri=~s/^\///;
6235: $uri=~s/\/$//;
6236: my ($udom, $uname);
6237: if ($getuserdir) {
6238: $udom = $userdomain;
6239: $uname = $username;
6240: } else {
6241: (undef,$udom,$uname)=split(/\//,$uri);
6242: if(defined($userdomain)) {
6243: $udom = $userdomain;
6244: }
6245: if(defined($username)) {
6246: $uname = $username;
6247: }
6248: }
6249: my ($dirRoot,$listing,@listing_results);
6250:
6251: $dirRoot = $perlvar{'lonDocRoot'};
6252: if (defined($getpropath)) {
6253: $dirRoot = &propath($udom,$uname);
6254: $dirRoot =~ s/\/$//;
6255: } elsif (defined($getuserdir)) {
6256: my $subdir=$uname.'__';
6257: $subdir =~ s/(.)(.)(.).*/$1\/$2\/$3/;
6258: $dirRoot = $Apache::lonnet::perlvar{'lonUsersDir'}
6259: ."/$udom/$subdir/$uname";
6260: } elsif (defined($alternateRoot)) {
6261: $dirRoot = $alternateRoot;
6262: }
6263:
6264: if($udom) {
6265: if($uname) {
6266: $listing = &reply('ls3:'.&escape('/'.$uri).':'.$getpropath.':'
6267: .$getuserdir.':'.&escape($dirRoot)
6268: .':'.&escape($uname).':'.&escape($udom),
6269: &homeserver($uname,$udom));
6270: if ($listing eq 'unknown_cmd') {
6271: $listing = &reply('ls2:'.$dirRoot.'/'.$uri,
6272: &homeserver($uname,$udom));
6273: } else {
6274: @listing_results = map { &unescape($_); } split(/:/,$listing);
6275: }
6276: if ($listing eq 'unknown_cmd') {
6277: $listing = &reply('ls:'.$dirRoot.'/'.$uri,
6278: &homeserver($uname,$udom));
6279: @listing_results = split(/:/,$listing);
6280: } else {
6281: @listing_results = map { &unescape($_); } split(/:/,$listing);
6282: }
6283: return @listing_results;
6284: } elsif(!$alternateRoot) {
6285: my %allusers;
6286: my %servers = &get_servers($udom,'library');
6287: foreach my $tryserver (keys(%servers)) {
6288: $listing = &reply('ls3:'.&escape("/res/$udom").':::::'.
6289: &escape($udom),$tryserver);
6290: if ($listing eq 'unknown_cmd') {
6291: $listing = &reply('ls2:'.$perlvar{'lonDocRoot'}.'/res/'.
6292: $udom, $tryserver);
6293: } else {
6294: @listing_results = map { &unescape($_); } split(/:/,$listing);
6295: }
6296: if ($listing eq 'unknown_cmd') {
6297: $listing = &reply('ls:'.$perlvar{'lonDocRoot'}.'/res/'.
6298: $udom, $tryserver);
6299: @listing_results = split(/:/,$listing);
6300: } else {
6301: @listing_results =
6302: map { &unescape($_); } split(/:/,$listing);
6303: }
6304: if ($listing_results[0] ne 'no_such_dir' &&
6305: $listing_results[0] ne 'empty' &&
6306: $listing_results[0] ne 'con_lost') {
6307: foreach my $line (@listing_results) {
6308: my ($entry) = split(/&/,$line,2);
6309: $allusers{$entry} = 1;
6310: }
6311: }
6312: }
6313: my $alluserstr='';
6314: foreach my $user (sort(keys(%allusers))) {
6315: $alluserstr.=$user.'&user:';
6316: }
6317: $alluserstr=~s/:$//;
6318: return split(/:/,$alluserstr);
6319: } else {
6320: return ('missing user name');
6321: }
6322: } elsif(!defined($getpropath)) {
6323: my @all_domains = sort(&all_domains());
6324: foreach my $domain (@all_domains) {
6325: $domain = $perlvar{'lonDocRoot'}.'/res/'.$domain.'/&domain';
6326: }
6327: return @all_domains;
6328: } else {
6329: return ('missing domain');
6330: }
6331: }
6332:
6333: # --------------------------------------------- GetFileTimestamp
6334: # This function utilizes dirlist and returns the date stamp for
6335: # when it was last modified. It will also return an error of -1
6336: # if an error occurs
6337:
6338: sub GetFileTimestamp {
6339: my ($studentDomain,$studentName,$filename,$getuserdir)=@_;
6340: $studentDomain = &LONCAPA::clean_domain($studentDomain);
6341: $studentName = &LONCAPA::clean_username($studentName);
6342: my ($fileStat) =
6343: &Apache::lonnet::dirlist($filename,$studentDomain,$studentName,
6344: undef,$getuserdir);
6345: my @stats = split('&', $fileStat);
6346: if($stats[0] ne 'empty' && $stats[0] ne 'no_such_dir') {
6347: # @stats contains first the filename, then the stat output
6348: return $stats[10]; # so this is 10 instead of 9.
6349: } else {
6350: return -1;
6351: }
6352: }
6353:
6354: sub stat_file {
6355: my ($uri) = @_;
6356: $uri = &clutter_with_no_wrapper($uri);
6357:
6358: my ($udom,$uname,$file);
6359: if ($uri =~ m-^/(uploaded|editupload)/-) {
6360: ($udom,$uname,$file) =
6361: ($uri =~ m-/(?:uploaded|editupload)/?($match_domain)/?($match_name)/?(.*)-);
6362: $file = 'userfiles/'.$file;
6363: }
6364: if ($uri =~ m-^/res/-) {
6365: ($udom,$uname) =
6366: ($uri =~ m-/(?:res)/?($match_domain)/?($match_username)/-);
6367: $file = $uri;
6368: }
6369:
6370: if (!$udom || !$uname || !$file) {
6371: # unable to handle the uri
6372: return ();
6373: }
6374: my $getpropath;
6375: if ($file =~ /^userfiles\//) {
6376: $getpropath = 1;
6377: }
6378: my ($result) = &dirlist($file,$udom,$uname,$getpropath);
6379: my @stats = split('&', $result);
6380:
6381: if($stats[0] ne 'empty' && $stats[0] ne 'no_such_dir') {
6382: shift(@stats); #filename is first
6383: return @stats;
6384: }
6385: return ();
6386: }
6387:
6388: # -------------------------------------------------------- Value of a Condition
6389:
6390: # gets the value of a specific preevaluated condition
6391: # stored in the string $env{user.state.<cid>}
6392: # or looks up a condition reference in the bighash and if if hasn't
6393: # already been evaluated recurses into docondval to get the value of
6394: # the condition, then memoizing it to
6395: # $env{user.state.<cid>.<condition>}
6396: sub directcondval {
6397: my $number=shift;
6398: if (!defined($env{'user.state.'.$env{'request.course.id'}})) {
6399: &Apache::lonuserstate::evalstate();
6400: }
6401: if (exists($env{'user.state.'.$env{'request.course.id'}.".$number"})) {
6402: return $env{'user.state.'.$env{'request.course.id'}.".$number"};
6403: } elsif ($number =~ /^_/) {
6404: my $sub_condition;
6405: if (tie(my %bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
6406: &GDBM_READER(),0640)) {
6407: $sub_condition=$bighash{'conditions'.$number};
6408: untie(%bighash);
6409: }
6410: my $value = &docondval($sub_condition);
6411: &appenv({'user.state.'.$env{'request.course.id'}.".$number" => $value});
6412: return $value;
6413: }
6414: if ($env{'user.state.'.$env{'request.course.id'}}) {
6415: return substr($env{'user.state.'.$env{'request.course.id'}},$number,1);
6416: } else {
6417: return 2;
6418: }
6419: }
6420:
6421: # get the collection of conditions for this resource
6422: sub condval {
6423: my $condidx=shift;
6424: my $allpathcond='';
6425: foreach my $cond (split(/\|/,$condidx)) {
6426: if (defined($env{'acc.cond.'.$env{'request.course.id'}.'.'.$cond})) {
6427: $allpathcond.=
6428: '('.$env{'acc.cond.'.$env{'request.course.id'}.'.'.$cond}.')|';
6429: }
6430: }
6431: $allpathcond=~s/\|$//;
6432: return &docondval($allpathcond);
6433: }
6434:
6435: #evaluates an expression of conditions
6436: sub docondval {
6437: my ($allpathcond) = @_;
6438: my $result=0;
6439: if ($env{'request.course.id'}
6440: && defined($allpathcond)) {
6441: my $operand='|';
6442: my @stack;
6443: foreach my $chunk ($allpathcond=~/(\d+|_\d+\.\d+|\(|\)|\&|\|)/g) {
6444: if ($chunk eq '(') {
6445: push @stack,($operand,$result);
6446: } elsif ($chunk eq ')') {
6447: my $before=pop @stack;
6448: if (pop @stack eq '&') {
6449: $result=$result>$before?$before:$result;
6450: } else {
6451: $result=$result>$before?$result:$before;
6452: }
6453: } elsif (($chunk eq '&') || ($chunk eq '|')) {
6454: $operand=$chunk;
6455: } else {
6456: my $new=directcondval($chunk);
6457: if ($operand eq '&') {
6458: $result=$result>$new?$new:$result;
6459: } else {
6460: $result=$result>$new?$result:$new;
6461: }
6462: }
6463: }
6464: }
6465: return $result;
6466: }
6467:
6468: # ---------------------------------------------------- Devalidate courseresdata
6469:
6470: sub devalidatecourseresdata {
6471: my ($coursenum,$coursedomain)=@_;
6472: my $hashid=$coursenum.':'.$coursedomain;
6473: &devalidate_cache_new('courseres',$hashid);
6474: }
6475:
6476:
6477: # --------------------------------------------------- Course Resourcedata Query
6478: #
6479: # Parameters:
6480: # $coursenum - Number of the course.
6481: # $coursedomain - Domain at which the course was created.
6482: # Returns:
6483: # A hash of the course parameters along (I think) with timestamps
6484: # and version info.
6485:
6486: sub get_courseresdata {
6487: my ($coursenum,$coursedomain)=@_;
6488: my $coursehom=&homeserver($coursenum,$coursedomain);
6489: my $hashid=$coursenum.':'.$coursedomain;
6490: my ($result,$cached)=&is_cached_new('courseres',$hashid);
6491: my %dumpreply;
6492: unless (defined($cached)) {
6493: %dumpreply=&dump('resourcedata',$coursedomain,$coursenum);
6494: $result=\%dumpreply;
6495: my ($tmp) = keys(%dumpreply);
6496: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
6497: &do_cache_new('courseres',$hashid,$result,600);
6498: } elsif ($tmp =~ /^(con_lost|no_such_host)/) {
6499: return $tmp;
6500: } elsif ($tmp =~ /^(error)/) {
6501: $result=undef;
6502: &do_cache_new('courseres',$hashid,$result,600);
6503: }
6504: }
6505: return $result;
6506: }
6507:
6508: sub devalidateuserresdata {
6509: my ($uname,$udom)=@_;
6510: my $hashid="$udom:$uname";
6511: &devalidate_cache_new('userres',$hashid);
6512: }
6513:
6514: sub get_userresdata {
6515: my ($uname,$udom)=@_;
6516: #most student don\'t have any data set, check if there is some data
6517: if (&EXT_cache_status($udom,$uname)) { return undef; }
6518:
6519: my $hashid="$udom:$uname";
6520: my ($result,$cached)=&is_cached_new('userres',$hashid);
6521: if (!defined($cached)) {
6522: my %resourcedata=&dump('resourcedata',$udom,$uname);
6523: $result=\%resourcedata;
6524: &do_cache_new('userres',$hashid,$result,600);
6525: }
6526: my ($tmp)=keys(%$result);
6527: if (($tmp!~/^error\:/) && ($tmp!~/^con_lost/)) {
6528: return $result;
6529: }
6530: #error 2 occurs when the .db doesn't exist
6531: if ($tmp!~/error: 2 /) {
6532: &logthis("<font color=\"blue\">WARNING:".
6533: " Trying to get resource data for ".
6534: $uname." at ".$udom.": ".
6535: $tmp."</font>");
6536: } elsif ($tmp=~/error: 2 /) {
6537: #&EXT_cache_set($udom,$uname);
6538: &do_cache_new('userres',$hashid,undef,600);
6539: undef($tmp); # not really an error so don't send it back
6540: }
6541: return $tmp;
6542: }
6543: #----------------------------------------------- resdata - return resource data
6544: # Purpose:
6545: # Return resource data for either users or for a course.
6546: # Parameters:
6547: # $name - Course/user name.
6548: # $domain - Name of the domain the user/course is registered on.
6549: # $type - Type of thing $name is (must be 'course' or 'user'
6550: # @which - Array of names of resources desired.
6551: # Returns:
6552: # The value of the first reasource in @which that is found in the
6553: # resource hash.
6554: # Exceptional Conditions:
6555: # If the $type passed in is not valid (not the string 'course' or
6556: # 'user', an undefined reference is returned.
6557: # If none of the resources are found, an undef is returned
6558: sub resdata {
6559: my ($name,$domain,$type,@which)=@_;
6560: my $result;
6561: if ($type eq 'course') {
6562: $result=&get_courseresdata($name,$domain);
6563: } elsif ($type eq 'user') {
6564: $result=&get_userresdata($name,$domain);
6565: }
6566: if (!ref($result)) { return $result; }
6567: foreach my $item (@which) {
6568: if (defined($result->{$item->[0]})) {
6569: return [$result->{$item->[0]},$item->[1]];
6570: }
6571: }
6572: return undef;
6573: }
6574:
6575: #
6576: # EXT resource caching routines
6577: #
6578:
6579: sub clear_EXT_cache_status {
6580: &delenv('cache.EXT.');
6581: }
6582:
6583: sub EXT_cache_status {
6584: my ($target_domain,$target_user) = @_;
6585: my $cachename = 'cache.EXT.'.$target_user.'.'.$target_domain;
6586: if (exists($env{$cachename}) && ($env{$cachename}+600) > time) {
6587: # We know already the user has no data
6588: return 1;
6589: } else {
6590: return 0;
6591: }
6592: }
6593:
6594: sub EXT_cache_set {
6595: my ($target_domain,$target_user) = @_;
6596: my $cachename = 'cache.EXT.'.$target_user.'.'.$target_domain;
6597: #&appenv({$cachename => time});
6598: }
6599:
6600: # --------------------------------------------------------- Value of a Variable
6601: sub EXT {
6602:
6603: my ($varname,$symbparm,$udom,$uname,$usection,$recurse)=@_;
6604: unless ($varname) { return ''; }
6605: #get real user name/domain, courseid and symb
6606: my $courseid;
6607: my $publicuser;
6608: if ($symbparm) {
6609: $symbparm=&get_symb_from_alias($symbparm);
6610: }
6611: if (!($uname && $udom)) {
6612: (my $cursymb,$courseid,$udom,$uname,$publicuser)= &whichuser($symbparm);
6613: if (!$symbparm) { $symbparm=$cursymb; }
6614: } else {
6615: $courseid=$env{'request.course.id'};
6616: }
6617: my ($realm,$space,$qualifier,@therest)=split(/\./,$varname);
6618: my $rest;
6619: if (defined($therest[0])) {
6620: $rest=join('.',@therest);
6621: } else {
6622: $rest='';
6623: }
6624:
6625: my $qualifierrest=$qualifier;
6626: if ($rest) { $qualifierrest.='.'.$rest; }
6627: my $spacequalifierrest=$space;
6628: if ($qualifierrest) { $spacequalifierrest.='.'.$qualifierrest; }
6629: if ($realm eq 'user') {
6630: # --------------------------------------------------------------- user.resource
6631: if ($space eq 'resource') {
6632: if ( (defined($Apache::lonhomework::parsing_a_problem)
6633: || defined($Apache::lonhomework::parsing_a_task))
6634: &&
6635: ($symbparm eq &symbread()) ) {
6636: # if we are in the middle of processing the resource the
6637: # get the value we are planning on committing
6638: if (defined($Apache::lonhomework::results{$qualifierrest})) {
6639: return $Apache::lonhomework::results{$qualifierrest};
6640: } else {
6641: return $Apache::lonhomework::history{$qualifierrest};
6642: }
6643: } else {
6644: my %restored;
6645: if ($publicuser || $env{'request.state'} eq 'construct') {
6646: %restored=&tmprestore($symbparm,$courseid,$udom,$uname);
6647: } else {
6648: %restored=&restore($symbparm,$courseid,$udom,$uname);
6649: }
6650: return $restored{$qualifierrest};
6651: }
6652: # ----------------------------------------------------------------- user.access
6653: } elsif ($space eq 'access') {
6654: # FIXME - not supporting calls for a specific user
6655: return &allowed($qualifier,$rest);
6656: # ------------------------------------------ user.preferences, user.environment
6657: } elsif (($space eq 'preferences') || ($space eq 'environment')) {
6658: if (($uname eq $env{'user.name'}) &&
6659: ($udom eq $env{'user.domain'})) {
6660: return $env{join('.',('environment',$qualifierrest))};
6661: } else {
6662: my %returnhash;
6663: if (!$publicuser) {
6664: %returnhash=&userenvironment($udom,$uname,
6665: $qualifierrest);
6666: }
6667: return $returnhash{$qualifierrest};
6668: }
6669: # ----------------------------------------------------------------- user.course
6670: } elsif ($space eq 'course') {
6671: # FIXME - not supporting calls for a specific user
6672: return $env{join('.',('request.course',$qualifier))};
6673: # ------------------------------------------------------------------- user.role
6674: } elsif ($space eq 'role') {
6675: # FIXME - not supporting calls for a specific user
6676: my ($role,$where)=split(/\./,$env{'request.role'});
6677: if ($qualifier eq 'value') {
6678: return $role;
6679: } elsif ($qualifier eq 'extent') {
6680: return $where;
6681: }
6682: # ----------------------------------------------------------------- user.domain
6683: } elsif ($space eq 'domain') {
6684: return $udom;
6685: # ------------------------------------------------------------------- user.name
6686: } elsif ($space eq 'name') {
6687: return $uname;
6688: # ---------------------------------------------------- Any other user namespace
6689: } else {
6690: my %reply;
6691: if (!$publicuser) {
6692: %reply=&get($space,[$qualifierrest],$udom,$uname);
6693: }
6694: return $reply{$qualifierrest};
6695: }
6696: } elsif ($realm eq 'query') {
6697: # ---------------------------------------------- pull stuff out of query string
6698: &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},
6699: [$spacequalifierrest]);
6700: return $env{'form.'.$spacequalifierrest};
6701: } elsif ($realm eq 'request') {
6702: # ------------------------------------------------------------- request.browser
6703: if ($space eq 'browser') {
6704: if ($qualifier eq 'textremote') {
6705: if (&Apache::lonlocal::mt('textual_remote_display') eq 'on') {
6706: return 1;
6707: } else {
6708: return 0;
6709: }
6710: } else {
6711: return $env{'browser.'.$qualifier};
6712: }
6713: # ------------------------------------------------------------ request.filename
6714: } else {
6715: return $env{'request.'.$spacequalifierrest};
6716: }
6717: } elsif ($realm eq 'course') {
6718: # ---------------------------------------------------------- course.description
6719: return $env{'course.'.$courseid.'.'.$spacequalifierrest};
6720: } elsif ($realm eq 'resource') {
6721:
6722: if (defined($courseid) && $courseid eq $env{'request.course.id'}) {
6723: if (!$symbparm) { $symbparm=&symbread(); }
6724: }
6725:
6726: if ($space eq 'title') {
6727: if (!$symbparm) { $symbparm = $env{'request.filename'}; }
6728: return &gettitle($symbparm);
6729: }
6730:
6731: if ($space eq 'map') {
6732: my ($map) = &decode_symb($symbparm);
6733: return &symbread($map);
6734: }
6735: if ($space eq 'filename') {
6736: if ($symbparm) {
6737: return &clutter((&decode_symb($symbparm))[2]);
6738: }
6739: return &hreflocation('',$env{'request.filename'});
6740: }
6741:
6742: my ($section, $group, @groups);
6743: my ($courselevelm,$courselevel);
6744: if ($symbparm && defined($courseid) &&
6745: $courseid eq $env{'request.course.id'}) {
6746:
6747: #print '<br>'.$space.' - '.$qualifier.' - '.$spacequalifierrest;
6748:
6749: # ----------------------------------------------------- Cascading lookup scheme
6750: my $symbp=$symbparm;
6751: my $mapp=&deversion((&decode_symb($symbp))[0]);
6752:
6753: my $symbparm=$symbp.'.'.$spacequalifierrest;
6754: my $mapparm=$mapp.'___(all).'.$spacequalifierrest;
6755:
6756: if (($env{'user.name'} eq $uname) &&
6757: ($env{'user.domain'} eq $udom)) {
6758: $section=$env{'request.course.sec'};
6759: @groups = split(/:/,$env{'request.course.groups'});
6760: @groups=&sort_course_groups($courseid,@groups);
6761: } else {
6762: if (! defined($usection)) {
6763: $section=&getsection($udom,$uname,$courseid);
6764: } else {
6765: $section = $usection;
6766: }
6767: @groups = &get_users_groups($udom,$uname,$courseid);
6768: }
6769:
6770: my $seclevel=$courseid.'.['.$section.'].'.$spacequalifierrest;
6771: my $seclevelr=$courseid.'.['.$section.'].'.$symbparm;
6772: my $seclevelm=$courseid.'.['.$section.'].'.$mapparm;
6773:
6774: $courselevel=$courseid.'.'.$spacequalifierrest;
6775: my $courselevelr=$courseid.'.'.$symbparm;
6776: $courselevelm=$courseid.'.'.$mapparm;
6777:
6778: # ----------------------------------------------------------- first, check user
6779:
6780: my $userreply=&resdata($uname,$udom,'user',
6781: ([$courselevelr,'resource'],
6782: [$courselevelm,'map' ],
6783: [$courselevel, 'course' ]));
6784: if (defined($userreply)) { return &get_reply($userreply); }
6785:
6786: # ------------------------------------------------ second, check some of course
6787: my $coursereply;
6788: if (@groups > 0) {
6789: $coursereply = &check_group_parms($courseid,\@groups,$symbparm,
6790: $mapparm,$spacequalifierrest);
6791: if (defined($coursereply)) { return &get_reply($coursereply); }
6792: }
6793:
6794: $coursereply=&resdata($env{'course.'.$courseid.'.num'},
6795: $env{'course.'.$courseid.'.domain'},
6796: 'course',
6797: ([$seclevelr, 'resource'],
6798: [$seclevelm, 'map' ],
6799: [$seclevel, 'course' ],
6800: [$courselevelr,'resource']));
6801: if (defined($coursereply)) { return &get_reply($coursereply); }
6802:
6803: # ------------------------------------------------------ third, check map parms
6804: my %parmhash=();
6805: my $thisparm='';
6806: if (tie(%parmhash,'GDBM_File',
6807: $env{'request.course.fn'}.'_parms.db',
6808: &GDBM_READER(),0640)) {
6809: $thisparm=$parmhash{$symbparm};
6810: untie(%parmhash);
6811: }
6812: if ($thisparm) { return &get_reply([$thisparm,'resource']); }
6813: }
6814: # ------------------------------------------ fourth, look in resource metadata
6815:
6816: $spacequalifierrest=~s/\./\_/;
6817: my $filename;
6818: if (!$symbparm) { $symbparm=&symbread(); }
6819: if ($symbparm) {
6820: $filename=(&decode_symb($symbparm))[2];
6821: } else {
6822: $filename=$env{'request.filename'};
6823: }
6824: my $metadata=&metadata($filename,$spacequalifierrest);
6825: if (defined($metadata)) { return &get_reply([$metadata,'resource']); }
6826: $metadata=&metadata($filename,'parameter_'.$spacequalifierrest);
6827: if (defined($metadata)) { return &get_reply([$metadata,'resource']); }
6828:
6829: # ---------------------------------------------- fourth, look in rest of course
6830: if ($symbparm && defined($courseid) &&
6831: $courseid eq $env{'request.course.id'}) {
6832: my $coursereply=&resdata($env{'course.'.$courseid.'.num'},
6833: $env{'course.'.$courseid.'.domain'},
6834: 'course',
6835: ([$courselevelm,'map' ],
6836: [$courselevel, 'course']));
6837: if (defined($coursereply)) { return &get_reply($coursereply); }
6838: }
6839: # ------------------------------------------------------------------ Cascade up
6840: unless ($space eq '0') {
6841: my @parts=split(/_/,$space);
6842: my $id=pop(@parts);
6843: my $part=join('_',@parts);
6844: if ($part eq '') { $part='0'; }
6845: my @partgeneral=&EXT('resource.'.$part.'.'.$qualifierrest,
6846: $symbparm,$udom,$uname,$section,1);
6847: if (defined($partgeneral[0])) { return &get_reply(\@partgeneral); }
6848: }
6849: if ($recurse) { return undef; }
6850: my $pack_def=&packages_tab_default($filename,$varname);
6851: if (defined($pack_def)) { return &get_reply([$pack_def,'resource']); }
6852: # ---------------------------------------------------- Any other user namespace
6853: } elsif ($realm eq 'environment') {
6854: # ----------------------------------------------------------------- environment
6855: if (($uname eq $env{'user.name'})&&($udom eq $env{'user.domain'})) {
6856: return $env{'environment.'.$spacequalifierrest};
6857: } else {
6858: if ($uname eq 'anonymous' && $udom eq '') {
6859: return '';
6860: }
6861: my %returnhash=&userenvironment($udom,$uname,
6862: $spacequalifierrest);
6863: return $returnhash{$spacequalifierrest};
6864: }
6865: } elsif ($realm eq 'system') {
6866: # ----------------------------------------------------------------- system.time
6867: if ($space eq 'time') {
6868: return time;
6869: }
6870: } elsif ($realm eq 'server') {
6871: # ----------------------------------------------------------------- system.time
6872: if ($space eq 'name') {
6873: return $ENV{'SERVER_NAME'};
6874: }
6875: }
6876: return '';
6877: }
6878:
6879: sub get_reply {
6880: my ($reply_value) = @_;
6881: if (ref($reply_value) eq 'ARRAY') {
6882: if (wantarray) {
6883: return @$reply_value;
6884: }
6885: return $reply_value->[0];
6886: } else {
6887: return $reply_value;
6888: }
6889: }
6890:
6891: sub check_group_parms {
6892: my ($courseid,$groups,$symbparm,$mapparm,$what) = @_;
6893: my @groupitems = ();
6894: my $resultitem;
6895: my @levels = ([$symbparm,'resource'],[$mapparm,'map'],[$what,'course']);
6896: foreach my $group (@{$groups}) {
6897: foreach my $level (@levels) {
6898: my $item = $courseid.'.['.$group.'].'.$level->[0];
6899: push(@groupitems,[$item,$level->[1]]);
6900: }
6901: }
6902: my $coursereply = &resdata($env{'course.'.$courseid.'.num'},
6903: $env{'course.'.$courseid.'.domain'},
6904: 'course',@groupitems);
6905: return $coursereply;
6906: }
6907:
6908: sub sort_course_groups { # Sort groups based on defined rankings. Default is sort().
6909: my ($courseid,@groups) = @_;
6910: @groups = sort(@groups);
6911: return @groups;
6912: }
6913:
6914: sub packages_tab_default {
6915: my ($uri,$varname)=@_;
6916: my (undef,$part,$name)=split(/\./,$varname);
6917:
6918: my (@extension,@specifics,$do_default);
6919: foreach my $package (split(/,/,&metadata($uri,'packages'))) {
6920: my ($pack_type,$pack_part)=split(/_/,$package,2);
6921: if ($pack_type eq 'default') {
6922: $do_default=1;
6923: } elsif ($pack_type eq 'extension') {
6924: push(@extension,[$package,$pack_type,$pack_part]);
6925: } elsif ($pack_part eq $part || $pack_type eq 'part') {
6926: # only look at packages defaults for packages that this id is
6927: push(@specifics,[$package,$pack_type,$pack_part]);
6928: }
6929: }
6930: # first look for a package that matches the requested part id
6931: foreach my $package (@specifics) {
6932: my (undef,$pack_type,$pack_part)=@{$package};
6933: next if ($pack_part ne $part);
6934: if (defined($packagetab{"$pack_type&$name&default"})) {
6935: return $packagetab{"$pack_type&$name&default"};
6936: }
6937: }
6938: # look for any possible matching non extension_ package
6939: foreach my $package (@specifics) {
6940: my (undef,$pack_type,$pack_part)=@{$package};
6941: if (defined($packagetab{"$pack_type&$name&default"})) {
6942: return $packagetab{"$pack_type&$name&default"};
6943: }
6944: if ($pack_type eq 'part') { $pack_part='0'; }
6945: if (defined($packagetab{$pack_type."_".$pack_part."&$name&default"})) {
6946: return $packagetab{$pack_type."_".$pack_part."&$name&default"};
6947: }
6948: }
6949: # look for any posible extension_ match
6950: foreach my $package (@extension) {
6951: my ($package,$pack_type)=@{$package};
6952: if (defined($packagetab{"$pack_type&$name&default"})) {
6953: return $packagetab{"$pack_type&$name&default"};
6954: }
6955: if (defined($packagetab{$package."&$name&default"})) {
6956: return $packagetab{$package."&$name&default"};
6957: }
6958: }
6959: # look for a global default setting
6960: if ($do_default && defined($packagetab{"default&$name&default"})) {
6961: return $packagetab{"default&$name&default"};
6962: }
6963: return undef;
6964: }
6965:
6966: sub add_prefix_and_part {
6967: my ($prefix,$part)=@_;
6968: my $keyroot;
6969: if (defined($prefix) && $prefix !~ /^__/) {
6970: # prefix that has a part already
6971: $keyroot=$prefix;
6972: } elsif (defined($prefix)) {
6973: # prefix that is missing a part
6974: if (defined($part)) { $keyroot='_'.$part.substr($prefix,1); }
6975: } else {
6976: # no prefix at all
6977: if (defined($part)) { $keyroot='_'.$part; }
6978: }
6979: return $keyroot;
6980: }
6981:
6982: # ---------------------------------------------------------------- Get metadata
6983:
6984: my %metaentry;
6985: sub metadata {
6986: my ($uri,$what,$liburi,$prefix,$depthcount)=@_;
6987: $uri=&declutter($uri);
6988: # if it is a non metadata possible uri return quickly
6989: if (($uri eq '') ||
6990: (($uri =~ m|^/*adm/|) &&
6991: ($uri !~ m|^adm/includes|) && ($uri !~ m|/bulletinboard$|)) ||
6992: ($uri =~ m|/$|) || ($uri =~ m|/.meta$|) ) {
6993: return undef;
6994: }
6995: if (($uri =~ /^~/ || $uri =~ m{home/$match_username/public_html/})
6996: && &Apache::lonxml::get_state('target') =~ /^(|meta)$/) {
6997: return undef;
6998: }
6999: my $filename=$uri;
7000: $uri=~s/\.meta$//;
7001: #
7002: # Is the metadata already cached?
7003: # Look at timestamp of caching
7004: # Everything is cached by the main uri, libraries are never directly cached
7005: #
7006: if (!defined($liburi)) {
7007: my ($result,$cached)=&is_cached_new('meta',$uri);
7008: if (defined($cached)) { return $result->{':'.$what}; }
7009: }
7010: {
7011: #
7012: # Is this a recursive call for a library?
7013: #
7014: # if (! exists($metacache{$uri})) {
7015: # $metacache{$uri}={};
7016: # }
7017: my $cachetime = 60*60;
7018: if ($liburi) {
7019: $liburi=&declutter($liburi);
7020: $filename=$liburi;
7021: } else {
7022: &devalidate_cache_new('meta',$uri);
7023: undef(%metaentry);
7024: }
7025: my %metathesekeys=();
7026: unless ($filename=~/\.meta$/) { $filename.='.meta'; }
7027: my $metastring;
7028: if ($uri =~ /^~/ || $uri =~ m{home/$match_username/public_html/}) {
7029: my $which = &hreflocation('','/'.($liburi || $uri));
7030: $metastring =
7031: &Apache::lonnet::ssi_body($which,
7032: ('grade_target' => 'meta'));
7033: $cachetime = 1; # only want this cached in the child not long term
7034: } elsif ($uri !~ m -^(editupload)/-) {
7035: my $file=&filelocation('',&clutter($filename));
7036: #push(@{$metaentry{$uri.'.file'}},$file);
7037: $metastring=&getfile($file);
7038: }
7039: my $parser=HTML::LCParser->new(\$metastring);
7040: my $token;
7041: undef %metathesekeys;
7042: while ($token=$parser->get_token) {
7043: if ($token->[0] eq 'S') {
7044: if (defined($token->[2]->{'package'})) {
7045: #
7046: # This is a package - get package info
7047: #
7048: my $package=$token->[2]->{'package'};
7049: my $keyroot=&add_prefix_and_part($prefix,$token->[2]->{'part'});
7050: if (defined($token->[2]->{'id'})) {
7051: $keyroot.='_'.$token->[2]->{'id'};
7052: }
7053: if ($metaentry{':packages'}) {
7054: $metaentry{':packages'}.=','.$package.$keyroot;
7055: } else {
7056: $metaentry{':packages'}=$package.$keyroot;
7057: }
7058: foreach my $pack_entry (keys(%packagetab)) {
7059: my $part=$keyroot;
7060: $part=~s/^\_//;
7061: if ($pack_entry=~/^\Q$package\E\&/ ||
7062: $pack_entry=~/^\Q$package\E_0\&/) {
7063: my ($pack,$name,$subp)=split(/\&/,$pack_entry);
7064: # ignore package.tab specified default values
7065: # here &package_tab_default() will fetch those
7066: if ($subp eq 'default') { next; }
7067: my $value=$packagetab{$pack_entry};
7068: my $unikey;
7069: if ($pack =~ /_0$/) {
7070: $unikey='parameter_0_'.$name;
7071: $part=0;
7072: } else {
7073: $unikey='parameter'.$keyroot.'_'.$name;
7074: }
7075: if ($subp eq 'display') {
7076: $value.=' [Part: '.$part.']';
7077: }
7078: $metaentry{':'.$unikey.'.part'}=$part;
7079: $metathesekeys{$unikey}=1;
7080: unless (defined($metaentry{':'.$unikey.'.'.$subp})) {
7081: $metaentry{':'.$unikey.'.'.$subp}=$value;
7082: }
7083: if (defined($metaentry{':'.$unikey.'.default'})) {
7084: $metaentry{':'.$unikey}=
7085: $metaentry{':'.$unikey.'.default'};
7086: }
7087: }
7088: }
7089: } else {
7090: #
7091: # This is not a package - some other kind of start tag
7092: #
7093: my $entry=$token->[1];
7094: my $unikey;
7095: if ($entry eq 'import') {
7096: $unikey='';
7097: } else {
7098: $unikey=$entry;
7099: }
7100: $unikey.=&add_prefix_and_part($prefix,$token->[2]->{'part'});
7101:
7102: if (defined($token->[2]->{'id'})) {
7103: $unikey.='_'.$token->[2]->{'id'};
7104: }
7105:
7106: if ($entry eq 'import') {
7107: #
7108: # Importing a library here
7109: #
7110: if ($depthcount<20) {
7111: my $location=$parser->get_text('/import');
7112: my $dir=$filename;
7113: $dir=~s|[^/]*$||;
7114: $location=&filelocation($dir,$location);
7115: my $metadata =
7116: &metadata($uri,'keys', $location,$unikey,
7117: $depthcount+1);
7118: foreach my $meta (split(',',$metadata)) {
7119: $metaentry{':'.$meta}=$metaentry{':'.$meta};
7120: $metathesekeys{$meta}=1;
7121: }
7122: }
7123: } else {
7124:
7125: if (defined($token->[2]->{'name'})) {
7126: $unikey.='_'.$token->[2]->{'name'};
7127: }
7128: $metathesekeys{$unikey}=1;
7129: foreach my $param (@{$token->[3]}) {
7130: $metaentry{':'.$unikey.'.'.$param} =
7131: $token->[2]->{$param};
7132: }
7133: my $internaltext=&HTML::Entities::decode($parser->get_text('/'.$entry));
7134: my $default=$metaentry{':'.$unikey.'.default'};
7135: if ( $internaltext =~ /^\s*$/ && $default !~ /^\s*$/) {
7136: # only ws inside the tag, and not in default, so use default
7137: # as value
7138: $metaentry{':'.$unikey}=$default;
7139: } elsif ( $internaltext =~ /\S/ ) {
7140: # something interesting inside the tag
7141: $metaentry{':'.$unikey}=$internaltext;
7142: } else {
7143: # no interesting values, don't set a default
7144: }
7145: # end of not-a-package not-a-library import
7146: }
7147: # end of not-a-package start tag
7148: }
7149: # the next is the end of "start tag"
7150: }
7151: }
7152: my ($extension) = ($uri =~ /\.(\w+)$/);
7153: $extension = lc($extension);
7154: if ($extension eq 'htm') { $extension='html'; }
7155:
7156: foreach my $key (keys(%packagetab)) {
7157: #no specific packages #how's our extension
7158: if ($key!~/^extension_\Q$extension\E&/) { next; }
7159: &metadata_create_package_def($uri,$key,'extension_'.$extension,
7160: \%metathesekeys);
7161: }
7162:
7163: if (!exists($metaentry{':packages'})
7164: || $packagetab{"import_defaults&extension_$extension"}) {
7165: foreach my $key (keys(%packagetab)) {
7166: #no specific packages well let's get default then
7167: if ($key!~/^default&/) { next; }
7168: &metadata_create_package_def($uri,$key,'default',
7169: \%metathesekeys);
7170: }
7171: }
7172: # are there custom rights to evaluate
7173: if ($metaentry{':copyright'} eq 'custom') {
7174:
7175: #
7176: # Importing a rights file here
7177: #
7178: unless ($depthcount) {
7179: my $location=$metaentry{':customdistributionfile'};
7180: my $dir=$filename;
7181: $dir=~s|[^/]*$||;
7182: $location=&filelocation($dir,$location);
7183: my $rights_metadata =
7184: &metadata($uri,'keys',$location,'_rights',
7185: $depthcount+1);
7186: foreach my $rights (split(',',$rights_metadata)) {
7187: #$metaentry{':'.$rights}=$metacache{$uri}->{':'.$rights};
7188: $metathesekeys{$rights}=1;
7189: }
7190: }
7191: }
7192: # uniqifiy package listing
7193: my %seen;
7194: my @uniq_packages =
7195: grep { ! $seen{$_} ++ } (split(',',$metaentry{':packages'}));
7196: $metaentry{':packages'} = join(',',@uniq_packages);
7197:
7198: $metaentry{':keys'} = join(',',keys(%metathesekeys));
7199: &metadata_generate_part0(\%metathesekeys,\%metaentry,$uri);
7200: $metaentry{':allpossiblekeys'}=join(',',keys %metathesekeys);
7201: &do_cache_new('meta',$uri,\%metaentry,$cachetime);
7202: # this is the end of "was not already recently cached
7203: }
7204: return $metaentry{':'.$what};
7205: }
7206:
7207: sub metadata_create_package_def {
7208: my ($uri,$key,$package,$metathesekeys)=@_;
7209: my ($pack,$name,$subp)=split(/\&/,$key);
7210: if ($subp eq 'default') { next; }
7211:
7212: if (defined($metaentry{':packages'})) {
7213: $metaentry{':packages'}.=','.$package;
7214: } else {
7215: $metaentry{':packages'}=$package;
7216: }
7217: my $value=$packagetab{$key};
7218: my $unikey;
7219: $unikey='parameter_0_'.$name;
7220: $metaentry{':'.$unikey.'.part'}=0;
7221: $$metathesekeys{$unikey}=1;
7222: unless (defined($metaentry{':'.$unikey.'.'.$subp})) {
7223: $metaentry{':'.$unikey.'.'.$subp}=$value;
7224: }
7225: if (defined($metaentry{':'.$unikey.'.default'})) {
7226: $metaentry{':'.$unikey}=
7227: $metaentry{':'.$unikey.'.default'};
7228: }
7229: }
7230:
7231: sub metadata_generate_part0 {
7232: my ($metadata,$metacache,$uri) = @_;
7233: my %allnames;
7234: foreach my $metakey (keys(%$metadata)) {
7235: if ($metakey=~/^parameter\_(.*)/) {
7236: my $part=$$metacache{':'.$metakey.'.part'};
7237: my $name=$$metacache{':'.$metakey.'.name'};
7238: if (! exists($$metadata{'parameter_0_'.$name.'.name'})) {
7239: $allnames{$name}=$part;
7240: }
7241: }
7242: }
7243: foreach my $name (keys(%allnames)) {
7244: $$metadata{"parameter_0_$name"}=1;
7245: my $key=":parameter_0_$name";
7246: $$metacache{"$key.part"}='0';
7247: $$metacache{"$key.name"}=$name;
7248: $$metacache{"$key.type"}=$$metacache{':parameter_'.
7249: $allnames{$name}.'_'.$name.
7250: '.type'};
7251: my $olddis=$$metacache{':parameter_'.$allnames{$name}.'_'.$name.
7252: '.display'};
7253: my $expr='[Part: '.$allnames{$name}.']';
7254: $olddis=~s/\Q$expr\E/\[Part: 0\]/;
7255: $$metacache{"$key.display"}=$olddis;
7256: }
7257: }
7258:
7259: # ------------------------------------------------------ Devalidate title cache
7260:
7261: sub devalidate_title_cache {
7262: my ($url)=@_;
7263: if (!$env{'request.course.id'}) { return; }
7264: my $symb=&symbread($url);
7265: if (!$symb) { return; }
7266: my $key=$env{'request.course.id'}."\0".$symb;
7267: &devalidate_cache_new('title',$key);
7268: }
7269:
7270: # ------------------------------------------------- Get the title of a resource
7271:
7272: sub gettitle {
7273: my $urlsymb=shift;
7274: my $symb=&symbread($urlsymb);
7275: if ($symb) {
7276: my $key=$env{'request.course.id'}."\0".$symb;
7277: my ($result,$cached)=&is_cached_new('title',$key);
7278: if (defined($cached)) {
7279: return $result;
7280: }
7281: my ($map,$resid,$url)=&decode_symb($symb);
7282: my $title='';
7283: if (!$map && $resid == 0 && $url =~/default\.sequence$/) {
7284: $title = $env{'course.'.$env{'request.course.id'}.'.description'};
7285: } else {
7286: if (tie(my %bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
7287: &GDBM_READER(),0640)) {
7288: my $mapid=$bighash{'map_pc_'.&clutter($map)};
7289: $title=$bighash{'title_'.$mapid.'.'.$resid};
7290: untie(%bighash);
7291: }
7292: }
7293: $title=~s/\&colon\;/\:/gs;
7294: if ($title) {
7295: return &do_cache_new('title',$key,$title,600);
7296: }
7297: $urlsymb=$url;
7298: }
7299: my $title=&metadata($urlsymb,'title');
7300: if (!$title) { $title=(split('/',$urlsymb))[-1]; }
7301: return $title;
7302: }
7303:
7304: sub get_slot {
7305: my ($which,$cnum,$cdom)=@_;
7306: if (!$cnum || !$cdom) {
7307: (undef,my $courseid)=&whichuser();
7308: $cdom=$env{'course.'.$courseid.'.domain'};
7309: $cnum=$env{'course.'.$courseid.'.num'};
7310: }
7311: my $key=join("\0",'slots',$cdom,$cnum,$which);
7312: my %slotinfo;
7313: if (exists($remembered{$key})) {
7314: $slotinfo{$which} = $remembered{$key};
7315: } else {
7316: %slotinfo=&get('slots',[$which],$cdom,$cnum);
7317: &Apache::lonhomework::showhash(%slotinfo);
7318: my ($tmp)=keys(%slotinfo);
7319: if ($tmp=~/^error:/) { return (); }
7320: $remembered{$key} = $slotinfo{$which};
7321: }
7322: if (ref($slotinfo{$which}) eq 'HASH') {
7323: return %{$slotinfo{$which}};
7324: }
7325: return $slotinfo{$which};
7326: }
7327: # ------------------------------------------------- Update symbolic store links
7328:
7329: sub symblist {
7330: my ($mapname,%newhash)=@_;
7331: $mapname=&deversion(&declutter($mapname));
7332: my %hash;
7333: if (($env{'request.course.fn'}) && (%newhash)) {
7334: if (tie(%hash,'GDBM_File',$env{'request.course.fn'}.'_symb.db',
7335: &GDBM_WRCREAT(),0640)) {
7336: foreach my $url (keys %newhash) {
7337: next if ($url eq 'last_known'
7338: && $env{'form.no_update_last_known'});
7339: $hash{declutter($url)}=&encode_symb($mapname,
7340: $newhash{$url}->[1],
7341: $newhash{$url}->[0]);
7342: }
7343: if (untie(%hash)) {
7344: return 'ok';
7345: }
7346: }
7347: }
7348: return 'error';
7349: }
7350:
7351: # --------------------------------------------------------------- Verify a symb
7352:
7353: sub symbverify {
7354: my ($symb,$thisurl)=@_;
7355: my $thisfn=$thisurl;
7356: $thisfn=&declutter($thisfn);
7357: # direct jump to resource in page or to a sequence - will construct own symbs
7358: if ($thisfn=~/\.(page|sequence)$/) { return 1; }
7359: # check URL part
7360: my ($map,$resid,$url)=&decode_symb($symb);
7361:
7362: unless ($url eq $thisfn) { return 0; }
7363:
7364: $symb=&symbclean($symb);
7365: $thisurl=&deversion($thisurl);
7366: $thisfn=&deversion($thisfn);
7367:
7368: my %bighash;
7369: my $okay=0;
7370:
7371: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
7372: &GDBM_READER(),0640)) {
7373: my $ids=$bighash{'ids_'.&clutter($thisurl)};
7374: unless ($ids) {
7375: $ids=$bighash{'ids_/'.$thisurl};
7376: }
7377: if ($ids) {
7378: # ------------------------------------------------------------------- Has ID(s)
7379: foreach my $id (split(/\,/,$ids)) {
7380: my ($mapid,$resid)=split(/\./,$id);
7381: if (
7382: &symbclean(&declutter($bighash{'map_id_'.$mapid}).'___'.$resid.'___'.$thisfn)
7383: eq $symb) {
7384: if (($env{'request.role.adv'}) ||
7385: $bighash{'encrypted_'.$id} eq $env{'request.enc'}) {
7386: $okay=1;
7387: }
7388: }
7389: }
7390: }
7391: untie(%bighash);
7392: }
7393: return $okay;
7394: }
7395:
7396: # --------------------------------------------------------------- Clean-up symb
7397:
7398: sub symbclean {
7399: my $symb=shift;
7400: if ($symb=~m|^/enc/|) { $symb=&Apache::lonenc::unencrypted($symb); }
7401: # remove version from map
7402: $symb=~s/\.(\d+)\.(\w+)\_\_\_/\.$2\_\_\_/;
7403:
7404: # remove version from URL
7405: $symb=~s/\.(\d+)\.(\w+)$/\.$2/;
7406:
7407: # remove wrapper
7408:
7409: $symb=~s/(\_\_\_\d+\_\_\_)adm\/wrapper\/(res\/)*/$1/;
7410: $symb=~s/(\_\_\_\d+\_\_\_)adm\/coursedocs\/showdoc\/(res\/)*/$1/;
7411: return $symb;
7412: }
7413:
7414: # ---------------------------------------------- Split symb to find map and url
7415:
7416: sub encode_symb {
7417: my ($map,$resid,$url)=@_;
7418: return &symbclean(&declutter($map).'___'.$resid.'___'.&declutter($url));
7419: }
7420:
7421: sub decode_symb {
7422: my $symb=shift;
7423: if ($symb=~m|^/enc/|) { $symb=&Apache::lonenc::unencrypted($symb); }
7424: my ($map,$resid,$url)=split(/___/,$symb);
7425: return (&fixversion($map),$resid,&fixversion($url));
7426: }
7427:
7428: sub fixversion {
7429: my $fn=shift;
7430: if ($fn=~/^(adm|uploaded|editupload|public)/) { return $fn; }
7431: my %bighash;
7432: my $uri=&clutter($fn);
7433: my $key=$env{'request.course.id'}.'_'.$uri;
7434: # is this cached?
7435: my ($result,$cached)=&is_cached_new('courseresversion',$key);
7436: if (defined($cached)) { return $result; }
7437: # unfortunately not cached, or expired
7438: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
7439: &GDBM_READER(),0640)) {
7440: if ($bighash{'version_'.$uri}) {
7441: my $version=$bighash{'version_'.$uri};
7442: unless (($version eq 'mostrecent') ||
7443: ($version==&getversion($uri))) {
7444: $uri=~s/\.(\w+)$/\.$version\.$1/;
7445: }
7446: }
7447: untie %bighash;
7448: }
7449: return &do_cache_new('courseresversion',$key,&declutter($uri),600);
7450: }
7451:
7452: sub deversion {
7453: my $url=shift;
7454: $url=~s/\.\d+\.(\w+)$/\.$1/;
7455: return $url;
7456: }
7457:
7458: # ------------------------------------------------------ Return symb list entry
7459:
7460: sub symbread {
7461: my ($thisfn,$donotrecurse)=@_;
7462: my $cache_str='request.symbread.cached.'.$thisfn;
7463: if (defined($env{$cache_str})) { return $env{$cache_str}; }
7464: # no filename provided? try from environment
7465: unless ($thisfn) {
7466: if ($env{'request.symb'}) {
7467: return $env{$cache_str}=&symbclean($env{'request.symb'});
7468: }
7469: $thisfn=$env{'request.filename'};
7470: }
7471: if ($thisfn=~m|^/enc/|) { $thisfn=&Apache::lonenc::unencrypted($thisfn); }
7472: # is that filename actually a symb? Verify, clean, and return
7473: if ($thisfn=~/\_\_\_\d+\_\_\_(.*)$/) {
7474: if (&symbverify($thisfn,$1)) {
7475: return $env{$cache_str}=&symbclean($thisfn);
7476: }
7477: }
7478: $thisfn=declutter($thisfn);
7479: my %hash;
7480: my %bighash;
7481: my $syval='';
7482: if (($env{'request.course.fn'}) && ($thisfn)) {
7483: my $targetfn = $thisfn;
7484: if ( ($thisfn =~ m/^(uploaded|editupload)\//) && ($thisfn !~ m/\.(page|sequence)$/) ) {
7485: $targetfn = 'adm/wrapper/'.$thisfn;
7486: }
7487: if ($targetfn =~ m|^adm/wrapper/(ext/.*)|) {
7488: $targetfn=$1;
7489: }
7490: if (tie(%hash,'GDBM_File',$env{'request.course.fn'}.'_symb.db',
7491: &GDBM_READER(),0640)) {
7492: $syval=$hash{$targetfn};
7493: untie(%hash);
7494: }
7495: # ---------------------------------------------------------- There was an entry
7496: if ($syval) {
7497: #unless ($syval=~/\_\d+$/) {
7498: #unless ($env{'form.request.prefix'}=~/\.(\d+)\_$/) {
7499: #&appenv({'request.ambiguous' => $thisfn});
7500: #return $env{$cache_str}='';
7501: #}
7502: #$syval.=$1;
7503: #}
7504: } else {
7505: # ------------------------------------------------------- Was not in symb table
7506: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
7507: &GDBM_READER(),0640)) {
7508: # ---------------------------------------------- Get ID(s) for current resource
7509: my $ids=$bighash{'ids_'.&clutter($thisfn)};
7510: unless ($ids) {
7511: $ids=$bighash{'ids_/'.$thisfn};
7512: }
7513: unless ($ids) {
7514: # alias?
7515: $ids=$bighash{'mapalias_'.$thisfn};
7516: }
7517: if ($ids) {
7518: # ------------------------------------------------------------------- Has ID(s)
7519: my @possibilities=split(/\,/,$ids);
7520: if ($#possibilities==0) {
7521: # ----------------------------------------------- There is only one possibility
7522: my ($mapid,$resid)=split(/\./,$ids);
7523: $syval=&encode_symb($bighash{'map_id_'.$mapid},
7524: $resid,$thisfn);
7525: } elsif (!$donotrecurse) {
7526: # ------------------------------------------ There is more than one possibility
7527: my $realpossible=0;
7528: foreach my $id (@possibilities) {
7529: my $file=$bighash{'src_'.$id};
7530: if (&allowed('bre',$file)) {
7531: my ($mapid,$resid)=split(/\./,$id);
7532: if ($bighash{'map_type_'.$mapid} ne 'page') {
7533: $realpossible++;
7534: $syval=&encode_symb($bighash{'map_id_'.$mapid},
7535: $resid,$thisfn);
7536: }
7537: }
7538: }
7539: if ($realpossible!=1) { $syval=''; }
7540: } else {
7541: $syval='';
7542: }
7543: }
7544: untie(%bighash)
7545: }
7546: }
7547: if ($syval) {
7548: return $env{$cache_str}=$syval;
7549: }
7550: }
7551: &appenv({'request.ambiguous' => $thisfn});
7552: return $env{$cache_str}='';
7553: }
7554:
7555: # ---------------------------------------------------------- Return random seed
7556:
7557: sub numval {
7558: my $txt=shift;
7559: $txt=~tr/A-J/0-9/;
7560: $txt=~tr/a-j/0-9/;
7561: $txt=~tr/K-T/0-9/;
7562: $txt=~tr/k-t/0-9/;
7563: $txt=~tr/U-Z/0-5/;
7564: $txt=~tr/u-z/0-5/;
7565: $txt=~s/\D//g;
7566: if ($_64bit) { if ($txt > 2**32) { return -1; } }
7567: return int($txt);
7568: }
7569:
7570: sub numval2 {
7571: my $txt=shift;
7572: $txt=~tr/A-J/0-9/;
7573: $txt=~tr/a-j/0-9/;
7574: $txt=~tr/K-T/0-9/;
7575: $txt=~tr/k-t/0-9/;
7576: $txt=~tr/U-Z/0-5/;
7577: $txt=~tr/u-z/0-5/;
7578: $txt=~s/\D//g;
7579: my @txts=split(/(\d\d\d\d\d\d\d\d\d)/,$txt);
7580: my $total;
7581: foreach my $val (@txts) { $total+=$val; }
7582: if ($_64bit) { if ($total > 2**32) { return -1; } }
7583: return int($total);
7584: }
7585:
7586: sub numval3 {
7587: use integer;
7588: my $txt=shift;
7589: $txt=~tr/A-J/0-9/;
7590: $txt=~tr/a-j/0-9/;
7591: $txt=~tr/K-T/0-9/;
7592: $txt=~tr/k-t/0-9/;
7593: $txt=~tr/U-Z/0-5/;
7594: $txt=~tr/u-z/0-5/;
7595: $txt=~s/\D//g;
7596: my @txts=split(/(\d\d\d\d\d\d\d\d\d)/,$txt);
7597: my $total;
7598: foreach my $val (@txts) { $total+=$val; }
7599: if ($_64bit) { $total=(($total<<32)>>32); }
7600: return $total;
7601: }
7602:
7603: sub digest {
7604: my ($data)=@_;
7605: my $digest=&Digest::MD5::md5($data);
7606: my ($a,$b,$c,$d)=unpack("iiii",$digest);
7607: my ($e,$f);
7608: {
7609: use integer;
7610: $e=($a+$b);
7611: $f=($c+$d);
7612: if ($_64bit) {
7613: $e=(($e<<32)>>32);
7614: $f=(($f<<32)>>32);
7615: }
7616: }
7617: if (wantarray) {
7618: return ($e,$f);
7619: } else {
7620: my $g;
7621: {
7622: use integer;
7623: $g=($e+$f);
7624: if ($_64bit) {
7625: $g=(($g<<32)>>32);
7626: }
7627: }
7628: return $g;
7629: }
7630: }
7631:
7632: sub latest_rnd_algorithm_id {
7633: return '64bit5';
7634: }
7635:
7636: sub get_rand_alg {
7637: my ($courseid)=@_;
7638: if (!$courseid) { $courseid=(&whichuser())[1]; }
7639: if ($courseid) {
7640: return $env{"course.$courseid.rndseed"};
7641: }
7642: return &latest_rnd_algorithm_id();
7643: }
7644:
7645: sub validCODE {
7646: my ($CODE)=@_;
7647: if (defined($CODE) && $CODE ne '' && $CODE =~ /^\w+$/) { return 1; }
7648: return 0;
7649: }
7650:
7651: sub getCODE {
7652: if (&validCODE($env{'form.CODE'})) { return $env{'form.CODE'}; }
7653: if ( (defined($Apache::lonhomework::parsing_a_problem) ||
7654: defined($Apache::lonhomework::parsing_a_task) ) &&
7655: &validCODE($Apache::lonhomework::history{'resource.CODE'})) {
7656: return $Apache::lonhomework::history{'resource.CODE'};
7657: }
7658: return undef;
7659: }
7660:
7661: sub rndseed {
7662: my ($symb,$courseid,$domain,$username)=@_;
7663: my ($wsymb,$wcourseid,$wdomain,$wusername)=&whichuser();
7664: if (!defined($symb)) {
7665: unless ($symb=$wsymb) { return time; }
7666: }
7667: if (!$courseid) { $courseid=$wcourseid; }
7668: if (!$domain) { $domain=$wdomain; }
7669: if (!$username) { $username=$wusername }
7670: my $which=&get_rand_alg();
7671:
7672: if (defined(&getCODE())) {
7673: if ($which eq '64bit5') {
7674: return &rndseed_CODE_64bit5($symb,$courseid,$domain,$username);
7675: } elsif ($which eq '64bit4') {
7676: return &rndseed_CODE_64bit4($symb,$courseid,$domain,$username);
7677: } else {
7678: return &rndseed_CODE_64bit($symb,$courseid,$domain,$username);
7679: }
7680: } elsif ($which eq '64bit5') {
7681: return &rndseed_64bit5($symb,$courseid,$domain,$username);
7682: } elsif ($which eq '64bit4') {
7683: return &rndseed_64bit4($symb,$courseid,$domain,$username);
7684: } elsif ($which eq '64bit3') {
7685: return &rndseed_64bit3($symb,$courseid,$domain,$username);
7686: } elsif ($which eq '64bit2') {
7687: return &rndseed_64bit2($symb,$courseid,$domain,$username);
7688: } elsif ($which eq '64bit') {
7689: return &rndseed_64bit($symb,$courseid,$domain,$username);
7690: }
7691: return &rndseed_32bit($symb,$courseid,$domain,$username);
7692: }
7693:
7694: sub rndseed_32bit {
7695: my ($symb,$courseid,$domain,$username)=@_;
7696: {
7697: use integer;
7698: my $symbchck=unpack("%32C*",$symb) << 27;
7699: my $symbseed=numval($symb) << 22;
7700: my $namechck=unpack("%32C*",$username) << 17;
7701: my $nameseed=numval($username) << 12;
7702: my $domainseed=unpack("%32C*",$domain) << 7;
7703: my $courseseed=unpack("%32C*",$courseid);
7704: my $num=$symbseed+$nameseed+$domainseed+$courseseed+$namechck+$symbchck;
7705: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
7706: #&logthis("rndseed :$num:$symb");
7707: if ($_64bit) { $num=(($num<<32)>>32); }
7708: return $num;
7709: }
7710: }
7711:
7712: sub rndseed_64bit {
7713: my ($symb,$courseid,$domain,$username)=@_;
7714: {
7715: use integer;
7716: my $symbchck=unpack("%32S*",$symb) << 21;
7717: my $symbseed=numval($symb) << 10;
7718: my $namechck=unpack("%32S*",$username);
7719:
7720: my $nameseed=numval($username) << 21;
7721: my $domainseed=unpack("%32S*",$domain) << 10;
7722: my $courseseed=unpack("%32S*",$courseid);
7723:
7724: my $num1=$symbchck+$symbseed+$namechck;
7725: my $num2=$nameseed+$domainseed+$courseseed;
7726: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
7727: #&logthis("rndseed :$num:$symb");
7728: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
7729: return "$num1,$num2";
7730: }
7731: }
7732:
7733: sub rndseed_64bit2 {
7734: my ($symb,$courseid,$domain,$username)=@_;
7735: {
7736: use integer;
7737: # strings need to be an even # of cahracters long, it it is odd the
7738: # last characters gets thrown away
7739: my $symbchck=unpack("%32S*",$symb.' ') << 21;
7740: my $symbseed=numval($symb) << 10;
7741: my $namechck=unpack("%32S*",$username.' ');
7742:
7743: my $nameseed=numval($username) << 21;
7744: my $domainseed=unpack("%32S*",$domain.' ') << 10;
7745: my $courseseed=unpack("%32S*",$courseid.' ');
7746:
7747: my $num1=$symbchck+$symbseed+$namechck;
7748: my $num2=$nameseed+$domainseed+$courseseed;
7749: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
7750: #&logthis("rndseed :$num:$symb");
7751: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
7752: return "$num1,$num2";
7753: }
7754: }
7755:
7756: sub rndseed_64bit3 {
7757: my ($symb,$courseid,$domain,$username)=@_;
7758: {
7759: use integer;
7760: # strings need to be an even # of cahracters long, it it is odd the
7761: # last characters gets thrown away
7762: my $symbchck=unpack("%32S*",$symb.' ') << 21;
7763: my $symbseed=numval2($symb) << 10;
7764: my $namechck=unpack("%32S*",$username.' ');
7765:
7766: my $nameseed=numval2($username) << 21;
7767: my $domainseed=unpack("%32S*",$domain.' ') << 10;
7768: my $courseseed=unpack("%32S*",$courseid.' ');
7769:
7770: my $num1=$symbchck+$symbseed+$namechck;
7771: my $num2=$nameseed+$domainseed+$courseseed;
7772: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
7773: #&logthis("rndseed :$num1:$num2:$_64bit");
7774: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
7775:
7776: return "$num1:$num2";
7777: }
7778: }
7779:
7780: sub rndseed_64bit4 {
7781: my ($symb,$courseid,$domain,$username)=@_;
7782: {
7783: use integer;
7784: # strings need to be an even # of cahracters long, it it is odd the
7785: # last characters gets thrown away
7786: my $symbchck=unpack("%32S*",$symb.' ') << 21;
7787: my $symbseed=numval3($symb) << 10;
7788: my $namechck=unpack("%32S*",$username.' ');
7789:
7790: my $nameseed=numval3($username) << 21;
7791: my $domainseed=unpack("%32S*",$domain.' ') << 10;
7792: my $courseseed=unpack("%32S*",$courseid.' ');
7793:
7794: my $num1=$symbchck+$symbseed+$namechck;
7795: my $num2=$nameseed+$domainseed+$courseseed;
7796: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
7797: #&logthis("rndseed :$num1:$num2:$_64bit");
7798: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
7799:
7800: return "$num1:$num2";
7801: }
7802: }
7803:
7804: sub rndseed_64bit5 {
7805: my ($symb,$courseid,$domain,$username)=@_;
7806: my ($num1,$num2)=&digest("$symb,$courseid,$domain,$username");
7807: return "$num1:$num2";
7808: }
7809:
7810: sub rndseed_CODE_64bit {
7811: my ($symb,$courseid,$domain,$username)=@_;
7812: {
7813: use integer;
7814: my $symbchck=unpack("%32S*",$symb.' ') << 16;
7815: my $symbseed=numval2($symb);
7816: my $CODEchck=unpack("%32S*",&getCODE().' ') << 16;
7817: my $CODEseed=numval(&getCODE());
7818: my $courseseed=unpack("%32S*",$courseid.' ');
7819: my $num1=$symbseed+$CODEchck;
7820: my $num2=$CODEseed+$courseseed+$symbchck;
7821: #&logthis("$symbseed:$CODEchck|$CODEseed:$courseseed:$symbchck");
7822: #&logthis("rndseed :$num1:$num2:$symb");
7823: if ($_64bit) { $num1=(($num1<<32)>>32); }
7824: if ($_64bit) { $num2=(($num2<<32)>>32); }
7825: return "$num1:$num2";
7826: }
7827: }
7828:
7829: sub rndseed_CODE_64bit4 {
7830: my ($symb,$courseid,$domain,$username)=@_;
7831: {
7832: use integer;
7833: my $symbchck=unpack("%32S*",$symb.' ') << 16;
7834: my $symbseed=numval3($symb);
7835: my $CODEchck=unpack("%32S*",&getCODE().' ') << 16;
7836: my $CODEseed=numval3(&getCODE());
7837: my $courseseed=unpack("%32S*",$courseid.' ');
7838: my $num1=$symbseed+$CODEchck;
7839: my $num2=$CODEseed+$courseseed+$symbchck;
7840: #&logthis("$symbseed:$CODEchck|$CODEseed:$courseseed:$symbchck");
7841: #&logthis("rndseed :$num1:$num2:$symb");
7842: if ($_64bit) { $num1=(($num1<<32)>>32); }
7843: if ($_64bit) { $num2=(($num2<<32)>>32); }
7844: return "$num1:$num2";
7845: }
7846: }
7847:
7848: sub rndseed_CODE_64bit5 {
7849: my ($symb,$courseid,$domain,$username)=@_;
7850: my $code = &getCODE();
7851: my ($num1,$num2)=&digest("$symb,$courseid,$code");
7852: return "$num1:$num2";
7853: }
7854:
7855: sub setup_random_from_rndseed {
7856: my ($rndseed)=@_;
7857: if ($rndseed =~/([,:])/) {
7858: my ($num1,$num2)=split(/[,:]/,$rndseed);
7859: &Math::Random::random_set_seed(abs($num1),abs($num2));
7860: } else {
7861: &Math::Random::random_set_seed_from_phrase($rndseed);
7862: }
7863: }
7864:
7865: sub latest_receipt_algorithm_id {
7866: return 'receipt3';
7867: }
7868:
7869: sub recunique {
7870: my $fucourseid=shift;
7871: my $unique;
7872: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2' ||
7873: $env{"course.$fucourseid.receiptalg"} eq 'receipt3' ) {
7874: $unique=$env{"course.$fucourseid.internal.encseed"};
7875: } else {
7876: $unique=$perlvar{'lonReceipt'};
7877: }
7878: return unpack("%32C*",$unique);
7879: }
7880:
7881: sub recprefix {
7882: my $fucourseid=shift;
7883: my $prefix;
7884: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2'||
7885: $env{"course.$fucourseid.receiptalg"} eq 'receipt3' ) {
7886: $prefix=$env{"course.$fucourseid.internal.encpref"};
7887: } else {
7888: $prefix=$perlvar{'lonHostID'};
7889: }
7890: return unpack("%32C*",$prefix);
7891: }
7892:
7893: sub ireceipt {
7894: my ($funame,$fudom,$fucourseid,$fusymb,$part)=@_;
7895:
7896: my $return =&recprefix($fucourseid).'-';
7897:
7898: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt3' ||
7899: $env{'request.state'} eq 'construct') {
7900: $return .= (&digest("$funame,$fudom,$fucourseid,$fusymb,$part")%10000);
7901: return $return;
7902: }
7903:
7904: my $cuname=unpack("%32C*",$funame);
7905: my $cudom=unpack("%32C*",$fudom);
7906: my $cucourseid=unpack("%32C*",$fucourseid);
7907: my $cusymb=unpack("%32C*",$fusymb);
7908: my $cunique=&recunique($fucourseid);
7909: my $cpart=unpack("%32S*",$part);
7910: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2') {
7911:
7912: #&logthis("doing receipt2 using parts $cpart, uname $cuname and udom $cudom gets ".($cpart%$cuname)." and ".($cpart%$cudom));
7913:
7914: $return.= ($cunique%$cuname+
7915: $cunique%$cudom+
7916: $cusymb%$cuname+
7917: $cusymb%$cudom+
7918: $cucourseid%$cuname+
7919: $cucourseid%$cudom+
7920: $cpart%$cuname+
7921: $cpart%$cudom);
7922: } else {
7923: $return.= ($cunique%$cuname+
7924: $cunique%$cudom+
7925: $cusymb%$cuname+
7926: $cusymb%$cudom+
7927: $cucourseid%$cuname+
7928: $cucourseid%$cudom);
7929: }
7930: return $return;
7931: }
7932:
7933: sub receipt {
7934: my ($part)=@_;
7935: my ($symb,$courseid,$domain,$name) = &whichuser();
7936: return &ireceipt($name,$domain,$courseid,$symb,$part);
7937: }
7938:
7939: sub whichuser {
7940: my ($passedsymb)=@_;
7941: my ($symb,$courseid,$domain,$name,$publicuser);
7942: if (defined($env{'form.grade_symb'})) {
7943: my ($tmp_courseid)=&get_env_multiple('form.grade_courseid');
7944: my $allowed=&allowed('vgr',$tmp_courseid);
7945: if (!$allowed &&
7946: exists($env{'request.course.sec'}) &&
7947: $env{'request.course.sec'} !~ /^\s*$/) {
7948: $allowed=&allowed('vgr',$tmp_courseid.
7949: '/'.$env{'request.course.sec'});
7950: }
7951: if ($allowed) {
7952: ($symb)=&get_env_multiple('form.grade_symb');
7953: $courseid=$tmp_courseid;
7954: ($domain)=&get_env_multiple('form.grade_domain');
7955: ($name)=&get_env_multiple('form.grade_username');
7956: return ($symb,$courseid,$domain,$name,$publicuser);
7957: }
7958: }
7959: if (!$passedsymb) {
7960: $symb=&symbread();
7961: } else {
7962: $symb=$passedsymb;
7963: }
7964: $courseid=$env{'request.course.id'};
7965: $domain=$env{'user.domain'};
7966: $name=$env{'user.name'};
7967: if ($name eq 'public' && $domain eq 'public') {
7968: if (!defined($env{'form.username'})) {
7969: $env{'form.username'}.=time.rand(10000000);
7970: }
7971: $name.=$env{'form.username'};
7972: }
7973: return ($symb,$courseid,$domain,$name,$publicuser);
7974:
7975: }
7976:
7977: # ------------------------------------------------------------ Serves up a file
7978: # returns either the contents of the file or
7979: # -1 if the file doesn't exist
7980: #
7981: # if the target is a file that was uploaded via DOCS,
7982: # a check will be made to see if a current copy exists on the local server,
7983: # if it does this will be served, otherwise a copy will be retrieved from
7984: # the home server for the course and stored in /home/httpd/html/userfiles on
7985: # the local server.
7986:
7987: sub getfile {
7988: my ($file) = @_;
7989: if ($file =~ m -^/*(uploaded|editupload)/-) { $file=&filelocation("",$file); }
7990: &repcopy($file);
7991: return &readfile($file);
7992: }
7993:
7994: sub repcopy_userfile {
7995: my ($file)=@_;
7996: if ($file =~ m -^/*(uploaded|editupload)/-) { $file=&filelocation("",$file); }
7997: if ($file =~ m|^/home/httpd/html/lonUsers/|) { return 'ok'; }
7998: my ($cdom,$cnum,$filename) =
7999: ($file=~m|^\Q$perlvar{'lonDocRoot'}\E/+userfiles/+($match_domain)/+($match_name)/+(.*)|);
8000: my $uri="/uploaded/$cdom/$cnum/$filename";
8001: if (-e "$file") {
8002: # we already have a local copy, check it out
8003: my @fileinfo = stat($file);
8004: my $rtncode;
8005: my $info;
8006: my $lwpresp = &getuploaded('HEAD',$uri,$cdom,$cnum,\$info,\$rtncode);
8007: if ($lwpresp ne 'ok') {
8008: # there is no such file anymore, even though we had a local copy
8009: if ($rtncode eq '404') {
8010: unlink($file);
8011: }
8012: return -1;
8013: }
8014: if ($info < $fileinfo[9]) {
8015: # nice, the file we have is up-to-date, just say okay
8016: return 'ok';
8017: } else {
8018: # the file is outdated, get rid of it
8019: unlink($file);
8020: }
8021: }
8022: # one way or the other, at this point, we don't have the file
8023: # construct the correct path for the file
8024: my @parts = ($cdom,$cnum);
8025: if ($filename =~ m|^(.+)/[^/]+$|) {
8026: push @parts, split(/\//,$1);
8027: }
8028: my $path = $perlvar{'lonDocRoot'}.'/userfiles';
8029: foreach my $part (@parts) {
8030: $path .= '/'.$part;
8031: if (!-e $path) {
8032: mkdir($path,0770);
8033: }
8034: }
8035: # now the path exists for sure
8036: # get a user agent
8037: my $ua=new LWP::UserAgent;
8038: my $transferfile=$file.'.in.transfer';
8039: # FIXME: this should flock
8040: if (-e $transferfile) { return 'ok'; }
8041: my $request;
8042: $uri=~s/^\///;
8043: $request=new HTTP::Request('GET','http://'.&hostname(&homeserver($cnum,$cdom)).'/raw/'.$uri);
8044: my $response=$ua->request($request,$transferfile);
8045: # did it work?
8046: if ($response->is_error()) {
8047: unlink($transferfile);
8048: &logthis("Userfile repcopy failed for $uri");
8049: return -1;
8050: }
8051: # worked, rename the transfer file
8052: rename($transferfile,$file);
8053: return 'ok';
8054: }
8055:
8056: sub tokenwrapper {
8057: my $uri=shift;
8058: $uri=~s|^http\://([^/]+)||;
8059: $uri=~s|^/||;
8060: $env{'user.environment'}=~/\/([^\/]+)\.id/;
8061: my $token=$1;
8062: my (undef,$udom,$uname,$file)=split('/',$uri,4);
8063: if ($udom && $uname && $file) {
8064: $file=~s|(\?\.*)*$||;
8065: &appenv({"userfile.$udom/$uname/$file" => $env{'request.course.id'}});
8066: return 'http://'.&hostname(&homeserver($uname,$udom)).'/'.$uri.
8067: (($uri=~/\?/)?'&':'?').'token='.$token.
8068: '&tokenissued='.$perlvar{'lonHostID'};
8069: } else {
8070: return '/adm/notfound.html';
8071: }
8072: }
8073:
8074: # call with reqtype HEAD: get last modification time
8075: # call with reqtype GET: get the file contents
8076: # Do not call this with reqtype GET for large files! It loads everything into memory
8077: #
8078: sub getuploaded {
8079: my ($reqtype,$uri,$cdom,$cnum,$info,$rtncode) = @_;
8080: $uri=~s/^\///;
8081: $uri = 'http://'.&hostname(&homeserver($cnum,$cdom)).'/raw/'.$uri;
8082: my $ua=new LWP::UserAgent;
8083: my $request=new HTTP::Request($reqtype,$uri);
8084: my $response=$ua->request($request);
8085: $$rtncode = $response->code;
8086: if (! $response->is_success()) {
8087: return 'failed';
8088: }
8089: if ($reqtype eq 'HEAD') {
8090: $$info = &HTTP::Date::str2time( $response->header('Last-modified') );
8091: } elsif ($reqtype eq 'GET') {
8092: $$info = $response->content;
8093: }
8094: return 'ok';
8095: }
8096:
8097: sub readfile {
8098: my $file = shift;
8099: if ( (! -e $file ) || ($file eq '') ) { return -1; };
8100: my $fh;
8101: open($fh,"<$file");
8102: my $a='';
8103: while (my $line = <$fh>) { $a .= $line; }
8104: return $a;
8105: }
8106:
8107: sub filelocation {
8108: my ($dir,$file) = @_;
8109: my $location;
8110: $file=~ s/^\s*(\S+)\s*$/$1/; ## strip off leading and trailing spaces
8111:
8112: if ($file =~ m-^/adm/-) {
8113: $file=~s-^/adm/wrapper/-/-;
8114: $file=~s-^/adm/coursedocs/showdoc/-/-;
8115: }
8116:
8117: if ($file=~m:^/~:) { # is a contruction space reference
8118: $location = $file;
8119: $location =~ s:/~(.*?)/(.*):/home/$1/public_html/$2:;
8120: } elsif ($file=~m{^/home/$match_username/public_html/}) {
8121: # is a correct contruction space reference
8122: $location = $file;
8123: } elsif ($file =~ m-^\Q$Apache::lonnet::perlvar{'lonTabDir'}\E/-) {
8124: $location = $file;
8125: } elsif ($file=~/^\/*(uploaded|editupload)/) { # is an uploaded file
8126: my ($udom,$uname,$filename)=
8127: ($file=~m -^/+(?:uploaded|editupload)/+($match_domain)/+($match_name)/+(.*)$-);
8128: my $home=&homeserver($uname,$udom);
8129: my $is_me=0;
8130: my @ids=¤t_machine_ids();
8131: foreach my $id (@ids) { if ($id eq $home) { $is_me=1; } }
8132: if ($is_me) {
8133: $location=&propath($udom,$uname).'/userfiles/'.$filename;
8134: } else {
8135: $location=$Apache::lonnet::perlvar{'lonDocRoot'}.'/userfiles/'.
8136: $udom.'/'.$uname.'/'.$filename;
8137: }
8138: } elsif ($file =~ m-^/adm/-) {
8139: $location = $perlvar{'lonDocRoot'}.'/'.$file;
8140: } else {
8141: $file=~s/^\Q$perlvar{'lonDocRoot'}\E//;
8142: $file=~s:^/res/:/:;
8143: if ( !( $file =~ m:^/:) ) {
8144: $location = $dir. '/'.$file;
8145: } else {
8146: $location = '/home/httpd/html/res'.$file;
8147: }
8148: }
8149: $location=~s://+:/:g; # remove duplicate /
8150: while ($location=~m{/\.\./}) {
8151: if ($location =~ m{/[^/]+/\.\./}) {
8152: $location=~ s{/[^/]+/\.\./}{/}g;
8153: } else {
8154: $location=~ s{/\.\./}{/}g;
8155: }
8156: } #remove dir/..
8157: while ($location=~m:/\./:) {$location=~ s:/\./:/:g;} #remove /./
8158: return $location;
8159: }
8160:
8161: sub hreflocation {
8162: my ($dir,$file)=@_;
8163: unless (($file=~m-^http://-i) || ($file=~m-^/-)) {
8164: $file=filelocation($dir,$file);
8165: } elsif ($file=~m-^/adm/-) {
8166: $file=~s-^/adm/wrapper/-/-;
8167: $file=~s-^/adm/coursedocs/showdoc/-/-;
8168: }
8169: if ($file=~m-^\Q$perlvar{'lonDocRoot'}\E-) {
8170: $file=~s-^\Q$perlvar{'lonDocRoot'}\E--;
8171: } elsif ($file=~m-/home/($match_username)/public_html/-) {
8172: $file=~s-^/home/($match_username)/public_html/-/~$1/-;
8173: } elsif ($file=~m-^\Q$perlvar{'lonUsersDir'}\E-) {
8174: $file=~s-^/home/httpd/lonUsers/($match_domain)/./././($match_name)/userfiles/
8175: -/uploaded/$1/$2/-x;
8176: }
8177: if ($file=~ m{^/userfiles/}) {
8178: $file =~ s{^/userfiles/}{/uploaded/};
8179: }
8180: return $file;
8181: }
8182:
8183: sub current_machine_domains {
8184: return &machine_domains(&hostname($perlvar{'lonHostID'}));
8185: }
8186:
8187: sub machine_domains {
8188: my ($hostname) = @_;
8189: my @domains;
8190: my %hostname = &all_hostnames();
8191: while( my($id, $name) = each(%hostname)) {
8192: # &logthis("-$id-$name-$hostname-");
8193: if ($hostname eq $name) {
8194: push(@domains,&host_domain($id));
8195: }
8196: }
8197: return @domains;
8198: }
8199:
8200: sub current_machine_ids {
8201: return &machine_ids(&hostname($perlvar{'lonHostID'}));
8202: }
8203:
8204: sub machine_ids {
8205: my ($hostname) = @_;
8206: $hostname ||= &hostname($perlvar{'lonHostID'});
8207: my @ids;
8208: my %name_to_host = &all_names();
8209: if (ref($name_to_host{$hostname}) eq 'ARRAY') {
8210: return @{ $name_to_host{$hostname} };
8211: }
8212: return;
8213: }
8214:
8215: sub additional_machine_domains {
8216: my @domains;
8217: open(my $fh,"<$perlvar{'lonTabDir'}/expected_domains.tab");
8218: while( my $line = <$fh>) {
8219: $line =~ s/\s//g;
8220: push(@domains,$line);
8221: }
8222: return @domains;
8223: }
8224:
8225: sub default_login_domain {
8226: my $domain = $perlvar{'lonDefDomain'};
8227: my $testdomain=(split(/\./,$ENV{'HTTP_HOST'}))[0];
8228: foreach my $posdom (¤t_machine_domains(),
8229: &additional_machine_domains()) {
8230: if (lc($posdom) eq lc($testdomain)) {
8231: $domain=$posdom;
8232: last;
8233: }
8234: }
8235: return $domain;
8236: }
8237:
8238: # ------------------------------------------------------------- Declutters URLs
8239:
8240: sub declutter {
8241: my $thisfn=shift;
8242: if ($thisfn=~m|^/enc/|) { $thisfn=&Apache::lonenc::unencrypted($thisfn); }
8243: $thisfn=~s/^\Q$perlvar{'lonDocRoot'}\E//;
8244: $thisfn=~s/^\///;
8245: $thisfn=~s|^adm/wrapper/||;
8246: $thisfn=~s|^adm/coursedocs/showdoc/||;
8247: $thisfn=~s/^res\///;
8248: $thisfn=~s/\?.+$//;
8249: return $thisfn;
8250: }
8251:
8252: # ------------------------------------------------------------- Clutter up URLs
8253:
8254: sub clutter {
8255: my $thisfn='/'.&declutter(shift);
8256: if ($thisfn !~ m{^/(uploaded|editupload|adm|userfiles|ext|raw|priv|public)/}
8257: || $thisfn =~ m{^/adm/(includes|pages)} ) {
8258: $thisfn='/res'.$thisfn;
8259: }
8260: if ($thisfn !~m|/adm|) {
8261: if ($thisfn =~ m|/ext/|) {
8262: $thisfn='/adm/wrapper'.$thisfn;
8263: } else {
8264: my ($ext) = ($thisfn =~ /\.(\w+)$/);
8265: my $embstyle=&Apache::loncommon::fileembstyle($ext);
8266: if ($embstyle eq 'ssi'
8267: || ($embstyle eq 'hdn')
8268: || ($embstyle eq 'rat')
8269: || ($embstyle eq 'prv')
8270: || ($embstyle eq 'ign')) {
8271: #do nothing with these
8272: } elsif (($embstyle eq 'img')
8273: || ($embstyle eq 'emb')
8274: || ($embstyle eq 'wrp')) {
8275: $thisfn='/adm/wrapper'.$thisfn;
8276: } elsif ($embstyle eq 'unk'
8277: && $thisfn!~/\.(sequence|page)$/) {
8278: $thisfn='/adm/coursedocs/showdoc'.$thisfn;
8279: } else {
8280: # &logthis("Got a blank emb style");
8281: }
8282: }
8283: }
8284: return $thisfn;
8285: }
8286:
8287: sub clutter_with_no_wrapper {
8288: my $uri = &clutter(shift);
8289: if ($uri =~ m-^/adm/-) {
8290: $uri =~ s-^/adm/wrapper/-/-;
8291: $uri =~ s-^/adm/coursedocs/showdoc/-/-;
8292: }
8293: return $uri;
8294: }
8295:
8296: sub freeze_escape {
8297: my ($value)=@_;
8298: if (ref($value)) {
8299: $value=&nfreeze($value);
8300: return '__FROZEN__'.&escape($value);
8301: }
8302: return &escape($value);
8303: }
8304:
8305:
8306: sub thaw_unescape {
8307: my ($value)=@_;
8308: if ($value =~ /^__FROZEN__/) {
8309: substr($value,0,10,undef);
8310: $value=&unescape($value);
8311: return &thaw($value);
8312: }
8313: return &unescape($value);
8314: }
8315:
8316: sub correct_line_ends {
8317: my ($result)=@_;
8318: $$result =~s/\r\n/\n/mg;
8319: $$result =~s/\r/\n/mg;
8320: }
8321: # ================================================================ Main Program
8322:
8323: sub goodbye {
8324: &logthis("Starting Shut down");
8325: #not converted to using infrastruture and probably shouldn't be
8326: &logthis(sprintf("%-20s is %s",'%badServerCache',length(&nfreeze(\%badServerCache))));
8327: #converted
8328: # &logthis(sprintf("%-20s is %s",'%metacache',scalar(%metacache)));
8329: &logthis(sprintf("%-20s is %s",'%homecache',length(&nfreeze(\%homecache))));
8330: # &logthis(sprintf("%-20s is %s",'%titlecache',length(&nfreeze(\%titlecache))));
8331: # &logthis(sprintf("%-20s is %s",'%courseresdatacache',length(&nfreeze(\%courseresdatacache))));
8332: #1.1 only
8333: # &logthis(sprintf("%-20s is %s",'%userresdatacache',length(&nfreeze(\%userresdatacache))));
8334: # &logthis(sprintf("%-20s is %s",'%getsectioncache',length(&nfreeze(\%getsectioncache))));
8335: # &logthis(sprintf("%-20s is %s",'%courseresversioncache',length(&nfreeze(\%courseresversioncache))));
8336: # &logthis(sprintf("%-20s is %s",'%resversioncache',length(&nfreeze(\%resversioncache))));
8337: &logthis(sprintf("%-20s is %s",'%remembered',length(&nfreeze(\%remembered))));
8338: &logthis(sprintf("%-20s is %s",'kicks',$kicks));
8339: &logthis(sprintf("%-20s is %s",'hits',$hits));
8340: &flushcourselogs();
8341: &logthis("Shutting down");
8342: }
8343:
8344: sub get_dns {
8345: my ($url,$func,$ignore_cache) = @_;
8346: if (!$ignore_cache) {
8347: my ($content,$cached)=
8348: &Apache::lonnet::is_cached_new('dns',$url);
8349: if ($cached) {
8350: &$func($content);
8351: return;
8352: }
8353: }
8354:
8355: my %alldns;
8356: open(my $config,"<$perlvar{'lonTabDir'}/hosts.tab");
8357: foreach my $dns (<$config>) {
8358: next if ($dns !~ /^\^(\S*)/x);
8359: $alldns{$1} = 1;
8360: }
8361: while (%alldns) {
8362: my ($dns) = keys(%alldns);
8363: delete($alldns{$dns});
8364: my $ua=new LWP::UserAgent;
8365: my $request=new HTTP::Request('GET',"http://$dns$url");
8366: my $response=$ua->request($request);
8367: next if ($response->is_error());
8368: my @content = split("\n",$response->content);
8369: &Apache::lonnet::do_cache_new('dns',$url,\@content,30*24*60*60);
8370: &$func(\@content);
8371: return;
8372: }
8373: close($config);
8374: my $which = (split('/',$url))[3];
8375: &logthis("unable to contact DNS defaulting to on disk file dns_$which.tab\n");
8376: open($config,"<$perlvar{'lonTabDir'}/dns_$which.tab");
8377: my @content = <$config>;
8378: &$func(\@content);
8379: return;
8380: }
8381: # ------------------------------------------------------------ Read domain file
8382: {
8383: my $loaded;
8384: my %domain;
8385:
8386: sub parse_domain_tab {
8387: my ($lines) = @_;
8388: foreach my $line (@$lines) {
8389: next if ($line =~ /^(\#|\s*$ )/x);
8390:
8391: chomp($line);
8392: my ($name,@elements) = split(/:/,$line,9);
8393: my %this_domain;
8394: foreach my $field ('description', 'auth_def', 'auth_arg_def',
8395: 'lang_def', 'city', 'longi', 'lati',
8396: 'primary') {
8397: $this_domain{$field} = shift(@elements);
8398: }
8399: $domain{$name} = \%this_domain;
8400: }
8401: }
8402:
8403: sub reset_domain_info {
8404: undef($loaded);
8405: undef(%domain);
8406: }
8407:
8408: sub load_domain_tab {
8409: my ($ignore_cache) = @_;
8410: &get_dns('/adm/dns/domain',\&parse_domain_tab,$ignore_cache);
8411: my $fh;
8412: if (open($fh,"<".$perlvar{'lonTabDir'}.'/domain.tab')) {
8413: my @lines = <$fh>;
8414: &parse_domain_tab(\@lines);
8415: }
8416: close($fh);
8417: $loaded = 1;
8418: }
8419:
8420: sub domain {
8421: &load_domain_tab() if (!$loaded);
8422:
8423: my ($name,$what) = @_;
8424: return if ( !exists($domain{$name}) );
8425:
8426: if (!$what) {
8427: return $domain{$name}{'description'};
8428: }
8429: return $domain{$name}{$what};
8430: }
8431: }
8432:
8433:
8434: # ------------------------------------------------------------- Read hosts file
8435: {
8436: my %hostname;
8437: my %hostdom;
8438: my %libserv;
8439: my $loaded;
8440: my %name_to_host;
8441:
8442: sub parse_hosts_tab {
8443: my ($file) = @_;
8444: foreach my $configline (@$file) {
8445: next if ($configline =~ /^(\#|\s*$ )/x);
8446: next if ($configline =~ /^\^/);
8447: chomp($configline);
8448: my ($id,$domain,$role,$name)=split(/:/,$configline);
8449: $name=~s/\s//g;
8450: if ($id && $domain && $role && $name) {
8451: $hostname{$id}=$name;
8452: push(@{$name_to_host{$name}}, $id);
8453: $hostdom{$id}=$domain;
8454: if ($role eq 'library') { $libserv{$id}=$name; }
8455: }
8456: }
8457: }
8458:
8459: sub reset_hosts_info {
8460: &purge_remembered();
8461: &reset_domain_info();
8462: &reset_hosts_ip_info();
8463: undef(%name_to_host);
8464: undef(%hostname);
8465: undef(%hostdom);
8466: undef(%libserv);
8467: undef($loaded);
8468: }
8469:
8470: sub load_hosts_tab {
8471: my ($ignore_cache) = @_;
8472: &get_dns('/adm/dns/hosts',\&parse_hosts_tab,$ignore_cache);
8473: open(my $config,"<$perlvar{'lonTabDir'}/hosts.tab");
8474: my @config = <$config>;
8475: &parse_hosts_tab(\@config);
8476: close($config);
8477: $loaded=1;
8478: }
8479:
8480: sub hostname {
8481: &load_hosts_tab() if (!$loaded);
8482:
8483: my ($lonid) = @_;
8484: return $hostname{$lonid};
8485: }
8486:
8487: sub all_hostnames {
8488: &load_hosts_tab() if (!$loaded);
8489:
8490: return %hostname;
8491: }
8492:
8493: sub all_names {
8494: &load_hosts_tab() if (!$loaded);
8495:
8496: return %name_to_host;
8497: }
8498:
8499: sub is_library {
8500: &load_hosts_tab() if (!$loaded);
8501:
8502: return exists($libserv{$_[0]});
8503: }
8504:
8505: sub all_library {
8506: &load_hosts_tab() if (!$loaded);
8507:
8508: return %libserv;
8509: }
8510:
8511: sub get_servers {
8512: &load_hosts_tab() if (!$loaded);
8513:
8514: my ($domain,$type) = @_;
8515: my %possible_hosts = ($type eq 'library') ? %libserv
8516: : %hostname;
8517: my %result;
8518: if (ref($domain) eq 'ARRAY') {
8519: while ( my ($host,$hostname) = each(%possible_hosts)) {
8520: if (grep(/^\Q$hostdom{$host}\E$/,@$domain)) {
8521: $result{$host} = $hostname;
8522: }
8523: }
8524: } else {
8525: while ( my ($host,$hostname) = each(%possible_hosts)) {
8526: if ($hostdom{$host} eq $domain) {
8527: $result{$host} = $hostname;
8528: }
8529: }
8530: }
8531: return %result;
8532: }
8533:
8534: sub host_domain {
8535: &load_hosts_tab() if (!$loaded);
8536:
8537: my ($lonid) = @_;
8538: return $hostdom{$lonid};
8539: }
8540:
8541: sub all_domains {
8542: &load_hosts_tab() if (!$loaded);
8543:
8544: my %seen;
8545: my @uniq = grep(!$seen{$_}++, values(%hostdom));
8546: return @uniq;
8547: }
8548: }
8549:
8550: {
8551: my %iphost;
8552: my %name_to_ip;
8553: my %lonid_to_ip;
8554:
8555: sub get_hosts_from_ip {
8556: my ($ip) = @_;
8557: my %iphosts = &get_iphost();
8558: if (ref($iphosts{$ip})) {
8559: return @{$iphosts{$ip}};
8560: }
8561: return;
8562: }
8563:
8564: sub reset_hosts_ip_info {
8565: undef(%iphost);
8566: undef(%name_to_ip);
8567: undef(%lonid_to_ip);
8568: }
8569:
8570: sub get_host_ip {
8571: my ($lonid) = @_;
8572: if (exists($lonid_to_ip{$lonid})) {
8573: return $lonid_to_ip{$lonid};
8574: }
8575: my $name=&hostname($lonid);
8576: my $ip = gethostbyname($name);
8577: return if (!$ip || length($ip) ne 4);
8578: $ip=inet_ntoa($ip);
8579: $name_to_ip{$name} = $ip;
8580: $lonid_to_ip{$lonid} = $ip;
8581: return $ip;
8582: }
8583:
8584: sub get_iphost {
8585: my ($ignore_cache) = @_;
8586:
8587: if (!$ignore_cache) {
8588: if (%iphost) {
8589: return %iphost;
8590: }
8591: my ($ip_info,$cached)=
8592: &Apache::lonnet::is_cached_new('iphost','iphost');
8593: if ($cached) {
8594: %iphost = %{$ip_info->[0]};
8595: %name_to_ip = %{$ip_info->[1]};
8596: %lonid_to_ip = %{$ip_info->[2]};
8597: return %iphost;
8598: }
8599: }
8600:
8601: # get yesterday's info for fallback
8602: my %old_name_to_ip;
8603: my ($ip_info,$cached)=
8604: &Apache::lonnet::is_cached_new('iphost','iphost');
8605: if ($cached) {
8606: %old_name_to_ip = %{$ip_info->[1]};
8607: }
8608:
8609: my %name_to_host = &all_names();
8610: foreach my $name (keys(%name_to_host)) {
8611: my $ip;
8612: if (!exists($name_to_ip{$name})) {
8613: $ip = gethostbyname($name);
8614: if (!$ip || length($ip) ne 4) {
8615: if (defined($old_name_to_ip{$name})) {
8616: $ip = $old_name_to_ip{$name};
8617: &logthis("Can't find $name defaulting to old $ip");
8618: } else {
8619: &logthis("Name $name no IP found");
8620: next;
8621: }
8622: } else {
8623: $ip=inet_ntoa($ip);
8624: }
8625: $name_to_ip{$name} = $ip;
8626: } else {
8627: $ip = $name_to_ip{$name};
8628: }
8629: foreach my $id (@{ $name_to_host{$name} }) {
8630: $lonid_to_ip{$id} = $ip;
8631: }
8632: push(@{$iphost{$ip}},@{$name_to_host{$name}});
8633: }
8634: &Apache::lonnet::do_cache_new('iphost','iphost',
8635: [\%iphost,\%name_to_ip,\%lonid_to_ip],
8636: 48*60*60);
8637:
8638: return %iphost;
8639: }
8640: }
8641:
8642: BEGIN {
8643:
8644: # ----------------------------------- Read loncapa.conf and loncapa_apache.conf
8645: unless ($readit) {
8646: {
8647: my $configvars = LONCAPA::Configuration::read_conf('loncapa.conf');
8648: %perlvar = (%perlvar,%{$configvars});
8649: }
8650:
8651:
8652: # ------------------------------------------------------ Read spare server file
8653: {
8654: open(my $config,"<$perlvar{'lonTabDir'}/spare.tab");
8655:
8656: while (my $configline=<$config>) {
8657: chomp($configline);
8658: if ($configline) {
8659: my ($host,$type) = split(':',$configline,2);
8660: if (!defined($type) || $type eq '') { $type = 'default' };
8661: push(@{ $spareid{$type} }, $host);
8662: }
8663: }
8664: close($config);
8665: }
8666: # ------------------------------------------------------------ Read permissions
8667: {
8668: open(my $config,"<$perlvar{'lonTabDir'}/roles.tab");
8669:
8670: while (my $configline=<$config>) {
8671: chomp($configline);
8672: if ($configline) {
8673: my ($role,$perm)=split(/ /,$configline);
8674: if ($perm ne '') { $pr{$role}=$perm; }
8675: }
8676: }
8677: close($config);
8678: }
8679:
8680: # -------------------------------------------- Read plain texts for permissions
8681: {
8682: open(my $config,"<$perlvar{'lonTabDir'}/rolesplain.tab");
8683:
8684: while (my $configline=<$config>) {
8685: chomp($configline);
8686: if ($configline) {
8687: my ($short,@plain)=split(/:/,$configline);
8688: %{$prp{$short}} = ();
8689: if (@plain > 0) {
8690: $prp{$short}{'std'} = $plain[0];
8691: for (my $i=1; $i<@plain; $i++) {
8692: $prp{$short}{'alt'.$i} = $plain[$i];
8693: }
8694: }
8695: }
8696: }
8697: close($config);
8698: }
8699:
8700: # ---------------------------------------------------------- Read package table
8701: {
8702: open(my $config,"<$perlvar{'lonTabDir'}/packages.tab");
8703:
8704: while (my $configline=<$config>) {
8705: if ($configline !~ /\S/ || $configline=~/^#/) { next; }
8706: chomp($configline);
8707: my ($short,$plain)=split(/:/,$configline);
8708: my ($pack,$name)=split(/\&/,$short);
8709: if ($plain ne '') {
8710: $packagetab{$pack.'&'.$name.'&name'}=$name;
8711: $packagetab{$short}=$plain;
8712: }
8713: }
8714: close($config);
8715: }
8716:
8717: # ------------- set up temporary directory
8718: {
8719: $tmpdir = $perlvar{'lonDaemons'}.'/tmp/';
8720:
8721: }
8722:
8723: $memcache=new Cache::Memcached({'servers' => ['127.0.0.1:11211'],
8724: 'compress_threshold'=> 20_000,
8725: });
8726:
8727: $processmarker='_'.time.'_'.$perlvar{'lonHostID'};
8728: $dumpcount=0;
8729:
8730: &logtouch();
8731: &logthis('<font color="yellow">INFO: Read configuration</font>');
8732: $readit=1;
8733: {
8734: use integer;
8735: my $test=(2**32)+1;
8736: if ($test != 0) { $_64bit=1; } else { $_64bit=0; }
8737: &logthis(" Detected 64bit platform ($_64bit)");
8738: }
8739: }
8740: }
8741:
8742: 1;
8743: __END__
8744:
8745: =pod
8746:
8747: =head1 NAME
8748:
8749: Apache::lonnet - Subroutines to ask questions about things in the network.
8750:
8751: =head1 SYNOPSIS
8752:
8753: Invoked by other LON-CAPA modules, when they need to talk to or about objects in the network.
8754:
8755: &Apache::lonnet::SUBROUTINENAME(ARGUMENTS);
8756:
8757: Common parameters:
8758:
8759: =over 4
8760:
8761: =item *
8762:
8763: $uname : an internal username (if $cname expecting a course Id specifically)
8764:
8765: =item *
8766:
8767: $udom : a domain (if $cdom expecting a course's domain specifically)
8768:
8769: =item *
8770:
8771: $symb : a resource instance identifier
8772:
8773: =item *
8774:
8775: $namespace : the name of a .db file that contains the data needed or
8776: being set.
8777:
8778: =back
8779:
8780: =head1 OVERVIEW
8781:
8782: lonnet provides subroutines which interact with the
8783: lonc/lond (TCP) network layer of LON-CAPA. They can be used to ask
8784: about classes, users, and resources.
8785:
8786: For many of these objects you can also use this to store data about
8787: them or modify them in various ways.
8788:
8789: =head2 Symbs
8790:
8791: To identify a specific instance of a resource, LON-CAPA uses symbols
8792: or "symbs"X<symb>. These identifiers are built from the URL of the
8793: map, the resource number of the resource in the map, and the URL of
8794: the resource itself. The latter is somewhat redundant, but might help
8795: if maps change.
8796:
8797: An example is
8798:
8799: msu/korte/parts/part1.sequence___19___msu/korte/tests/part12.problem
8800:
8801: The respective map entry is
8802:
8803: <resource id="19" src="/res/msu/korte/tests/part12.problem"
8804: title="Problem 2">
8805: </resource>
8806:
8807: Symbs are used by the random number generator, as well as to store and
8808: restore data specific to a certain instance of for example a problem.
8809:
8810: =head2 Storing And Retrieving Data
8811:
8812: X<store()>X<cstore()>X<restore()>Three of the most important functions
8813: in C<lonnet.pm> are C<&Apache::lonnet::cstore()>,
8814: C<&Apache::lonnet:restore()>, and C<&Apache::lonnet::store()>, which
8815: is is the non-critical message twin of cstore. These functions are for
8816: handlers to store a perl hash to a user's permanent data space in an
8817: easy manner, and to retrieve it again on another call. It is expected
8818: that a handler would use this once at the beginning to retrieve data,
8819: and then again once at the end to send only the new data back.
8820:
8821: The data is stored in the user's data directory on the user's
8822: homeserver under the ID of the course.
8823:
8824: The hash that is returned by restore will have all of the previous
8825: value for all of the elements of the hash.
8826:
8827: Example:
8828:
8829: #creating a hash
8830: my %hash;
8831: $hash{'foo'}='bar';
8832:
8833: #storing it
8834: &Apache::lonnet::cstore(\%hash);
8835:
8836: #changing a value
8837: $hash{'foo'}='notbar';
8838:
8839: #adding a new value
8840: $hash{'bar'}='foo';
8841: &Apache::lonnet::cstore(\%hash);
8842:
8843: #retrieving the hash
8844: my %history=&Apache::lonnet::restore();
8845:
8846: #print the hash
8847: foreach my $key (sort(keys(%history))) {
8848: print("\%history{$key} = $history{$key}");
8849: }
8850:
8851: Will print out:
8852:
8853: %history{1:foo} = bar
8854: %history{1:keys} = foo:timestamp
8855: %history{1:timestamp} = 990455579
8856: %history{2:bar} = foo
8857: %history{2:foo} = notbar
8858: %history{2:keys} = foo:bar:timestamp
8859: %history{2:timestamp} = 990455580
8860: %history{bar} = foo
8861: %history{foo} = notbar
8862: %history{timestamp} = 990455580
8863: %history{version} = 2
8864:
8865: Note that the special hash entries C<keys>, C<version> and
8866: C<timestamp> were added to the hash. C<version> will be equal to the
8867: total number of versions of the data that have been stored. The
8868: C<timestamp> attribute will be the UNIX time the hash was
8869: stored. C<keys> is available in every historical section to list which
8870: keys were added or changed at a specific historical revision of a
8871: hash.
8872:
8873: B<Warning>: do not store the hash that restore returns directly. This
8874: will cause a mess since it will restore the historical keys as if the
8875: were new keys. I.E. 1:foo will become 1:1:foo etc.
8876:
8877: Calling convention:
8878:
8879: my %record=&Apache::lonnet::restore($symb,$courseid,$domain,$uname,$home);
8880: &Apache::lonnet::cstore(\%newrecord,$symb,$courseid,$domain,$uname,$home);
8881:
8882: For more detailed information, see lonnet specific documentation.
8883:
8884: =head1 RETURN MESSAGES
8885:
8886: =over 4
8887:
8888: =item * B<con_lost>: unable to contact remote host
8889:
8890: =item * B<con_delayed>: unable to contact remote host, message will be delivered
8891: when the connection is brought back up
8892:
8893: =item * B<con_failed>: unable to contact remote host and unable to save message
8894: for later delivery
8895:
8896: =item * B<error:>: an error a occured, a description of the error follows the :
8897:
8898: =item * B<no_such_host>: unable to fund a host associated with the user/domain
8899: that was requested
8900:
8901: =back
8902:
8903: =head1 PUBLIC SUBROUTINES
8904:
8905: =head2 Session Environment Functions
8906:
8907: =over 4
8908:
8909: =item *
8910: X<appenv()>
8911: B<appenv($hashref,$rolesarrayref)>: the value of %{$hashref} is written to
8912: the user envirnoment file, and will be restored for each access this
8913: user makes during this session, also modifies the %env for the current
8914: process. Optional rolesarrayref - if defined contains a reference to an array
8915: of roles which are exempt from the restriction on modifying user.role entries
8916: in the user's environment.db and in %env.
8917:
8918: =item *
8919: X<delenv()>
8920: B<delenv($regexp)>: removes all items from the session
8921: environment file that matches the regular expression in $regexp. The
8922: values are also delted from the current processes %env.
8923:
8924: =item * get_env_multiple($name)
8925:
8926: gets $name from the %env hash, it seemlessly handles the cases where multiple
8927: values may be defined and end up as an array ref.
8928:
8929: returns an array of values
8930:
8931: =back
8932:
8933: =head2 User Information
8934:
8935: =over 4
8936:
8937: =item *
8938: X<queryauthenticate()>
8939: B<queryauthenticate($uname,$udom)>: try to determine user's current
8940: authentication scheme
8941:
8942: =item *
8943: X<authenticate()>
8944: B<authenticate($uname,$upass,$udom)>: try to
8945: authenticate user from domain's lib servers (first use the current
8946: one). C<$upass> should be the users password.
8947:
8948: =item *
8949: X<homeserver()>
8950: B<homeserver($uname,$udom)>: find the server which has
8951: the user's directory and files (there must be only one), this caches
8952: the answer, and also caches if there is a borken connection.
8953:
8954: =item *
8955: X<idget()>
8956: B<idget($udom,@ids)>: find the usernames behind a list of IDs
8957: (IDs are a unique resource in a domain, there must be only 1 ID per
8958: username, and only 1 username per ID in a specific domain) (returns
8959: hash: id=>name,id=>name)
8960:
8961: =item *
8962: X<idrget()>
8963: B<idrget($udom,@unames)>: find the IDs behind a list of
8964: usernames (returns hash: name=>id,name=>id)
8965:
8966: =item *
8967: X<idput()>
8968: B<idput($udom,%ids)>: store away a list of names and associated IDs
8969:
8970: =item *
8971: X<rolesinit()>
8972: B<rolesinit($udom,$username,$authhost)>: get user privileges
8973:
8974: =item *
8975: X<getsection()>
8976: B<getsection($udom,$uname,$cname)>: finds the section of student in the
8977: course $cname, return section name/number or '' for "not in course"
8978: and '-1' for "no section"
8979:
8980: =item *
8981: X<userenvironment()>
8982: B<userenvironment($udom,$uname,@what)>: gets the values of the keys
8983: passed in @what from the requested user's environment, returns a hash
8984:
8985: =item *
8986: X<userlog_query()>
8987: B<userlog_query($uname,$udom,%filters)>: retrieves data from a user's
8988: activity.log file. %filters defines filters applied when parsing the
8989: log file. These can be start or end timestamps, or the type of action
8990: - log to look for Login or Logout events, check for Checkin or
8991: Checkout, role for role selection. The response is in the form
8992: timestamp1:hostid1:event1×tamp2:hostid2:event2 where events are
8993: escaped strings of the action recorded in the activity.log file.
8994:
8995: =back
8996:
8997: =head2 User Roles
8998:
8999: =over 4
9000:
9001: =item *
9002:
9003: allowed($priv,$uri,$symb,$role) : check for a user privilege; returns codes for allowed actions
9004: F: full access
9005: U,I,K: authentication modes (cxx only)
9006: '': forbidden
9007: 1: user needs to choose course
9008: 2: browse allowed
9009: A: passphrase authentication needed
9010:
9011: =item *
9012:
9013: definerole($rolename,$sysrole,$domrole,$courole) : define role; define a custom
9014: role rolename set privileges in format of lonTabs/roles.tab for system, domain,
9015: and course level
9016:
9017: =item *
9018:
9019: plaintext($short) : return value in %prp hash (rolesplain.tab); plain text
9020: explanation of a user role term
9021:
9022: =item *
9023:
9024: get_my_roles($uname,$udom,$context,$types,$roles,$roledoms,$withsec) :
9025: All arguments are optional. Returns a hash of a roles, either for
9026: co-author/assistant author roles for a user's Construction Space
9027: (default), or if $context is 'userroles', roles for the user himself,
9028: In the hash, keys are set to colon-separated $uname,$udom,$role, and
9029: (optionally) if $withsec is true, a fourth colon-separated item - $section.
9030: For each key, value is set to colon-separated start and end times for
9031: the role. If no username and domain are specified, will default to
9032: current user/domain. Types, roles, and roledoms are references to arrays
9033: of role statuses (active, future or previous), roles
9034: (e.g., cc,in, st etc.) and domains of the roles which can be used
9035: to restrict the list of roles reported. If no array ref is
9036: provided for types, will default to return only active roles.
9037:
9038: =back
9039:
9040: =head2 User Modification
9041:
9042: =over 4
9043:
9044: =item *
9045:
9046: assignrole($udom,$uname,$url,$role,$end,$start) : assign role; give a role to a
9047: user for the level given by URL. Optional start and end dates (leave empty
9048: string or zero for "no date")
9049:
9050: =item *
9051:
9052: changepass($uname,$udom,$currentpass,$newpass,$server) : attempts to
9053: change a users, password, possible return values are: ok,
9054: pwchange_failure, non_authorized, auth_mode_error, unknown_user,
9055: refused
9056:
9057: =item *
9058:
9059: modifyuserauth($udom,$uname,$umode,$upass) : modify user authentication
9060:
9061: =item *
9062:
9063: modifyuser($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene) :
9064: modify user
9065:
9066: =item *
9067:
9068: modifystudent
9069:
9070: modify a students enrollment and identification information.
9071: The course id is resolved based on the current users environment.
9072: This means the envoking user must be a course coordinator or otherwise
9073: associated with a course.
9074:
9075: This call is essentially a wrapper for lonnet::modifyuser and
9076: lonnet::modify_student_enrollment
9077:
9078: Inputs:
9079:
9080: =over 4
9081:
9082: =item B<$udom> Students loncapa domain
9083:
9084: =item B<$uname> Students loncapa login name
9085:
9086: =item B<$uid> Students id/student number
9087:
9088: =item B<$umode> Students authentication mode
9089:
9090: =item B<$upass> Students password
9091:
9092: =item B<$first> Students first name
9093:
9094: =item B<$middle> Students middle name
9095:
9096: =item B<$last> Students last name
9097:
9098: =item B<$gene> Students generation
9099:
9100: =item B<$usec> Students section in course
9101:
9102: =item B<$end> Unix time of the roles expiration
9103:
9104: =item B<$start> Unix time of the roles start date
9105:
9106: =item B<$forceid> If defined, allow $uid to be changed
9107:
9108: =item B<$desiredhome> server to use as home server for student
9109:
9110: =back
9111:
9112: =item *
9113:
9114: modify_student_enrollment
9115:
9116: Change a students enrollment status in a class. The environment variable
9117: 'role.request.course' must be defined for this function to proceed.
9118:
9119: Inputs:
9120:
9121: =over 4
9122:
9123: =item $udom, students domain
9124:
9125: =item $uname, students name
9126:
9127: =item $uid, students user id
9128:
9129: =item $first, students first name
9130:
9131: =item $middle
9132:
9133: =item $last
9134:
9135: =item $gene
9136:
9137: =item $usec
9138:
9139: =item $end
9140:
9141: =item $start
9142:
9143: =back
9144:
9145:
9146: =item *
9147:
9148: assigncustomrole($udom,$uname,$url,$rdom,$rnam,$rolename,$end,$start) : assign
9149: custom role; give a custom role to a user for the level given by URL. Specify
9150: name and domain of role author, and role name
9151:
9152: =item *
9153:
9154: revokerole($udom,$uname,$url,$role) : revoke a role for url
9155:
9156: =item *
9157:
9158: revokecustomrole($udom,$uname,$url,$role) : revoke a custom role
9159:
9160: =back
9161:
9162: =head2 Course Infomation
9163:
9164: =over 4
9165:
9166: =item *
9167:
9168: coursedescription($courseid) : returns a hash of information about the
9169: specified course id, including all environment settings for the
9170: course, the description of the course will be in the hash under the
9171: key 'description'
9172:
9173: =item *
9174:
9175: resdata($name,$domain,$type,@which) : request for current parameter
9176: setting for a specific $type, where $type is either 'course' or 'user',
9177: @what should be a list of parameters to ask about. This routine caches
9178: answers for 5 minutes.
9179:
9180: =item *
9181:
9182: get_courseresdata($courseid, $domain) : dump the entire course resource
9183: data base, returning a hash that is keyed by the resource name and has
9184: values that are the resource value. I believe that the timestamps and
9185: versions are also returned.
9186:
9187:
9188: =back
9189:
9190: =head2 Course Modification
9191:
9192: =over 4
9193:
9194: =item *
9195:
9196: writecoursepref($courseid,%prefs) : write preferences (environment
9197: database) for a course
9198:
9199: =item *
9200:
9201: createcourse($udom,$description,$url) : make/modify course
9202:
9203: =back
9204:
9205: =head2 Resource Subroutines
9206:
9207: =over 4
9208:
9209: =item *
9210:
9211: subscribe($fname) : subscribe to a resource, returns URL if possible (probably should use repcopy instead)
9212:
9213: =item *
9214:
9215: repcopy($filename) : subscribes to the requested file, and attempts to
9216: replicate from the owning library server, Might return
9217: 'unavailable', 'not_found', 'forbidden', 'ok', or
9218: 'bad_request', also attempts to grab the metadata for the
9219: resource. Expects the local filesystem pathname
9220: (/home/httpd/html/res/....)
9221:
9222: =back
9223:
9224: =head2 Resource Information
9225:
9226: =over 4
9227:
9228: =item *
9229:
9230: EXT($varname,$symb,$udom,$uname) : evaluates and returns the value of
9231: a vairety of different possible values, $varname should be a request
9232: string, and the other parameters can be used to specify who and what
9233: one is asking about.
9234:
9235: Possible values for $varname are environment.lastname (or other item
9236: from the envirnment hash), user.name (or someother aspect about the
9237: user), resource.0.maxtries (or some other part and parameter of a
9238: resource)
9239:
9240: =item *
9241:
9242: directcondval($number) : get current value of a condition; reads from a state
9243: string
9244:
9245: =item *
9246:
9247: condval($condidx) : value of condition index based on state
9248:
9249: =item *
9250:
9251: metadata($uri,$what,$liburi,$prefix,$depthcount) : request a
9252: resource's metadata, $what should be either a specific key, or either
9253: 'keys' (to get a list of possible keys) or 'packages' to get a list of
9254: packages that this resource currently uses, the last 3 arguments are only used internally for recursive metadata.
9255:
9256: this function automatically caches all requests
9257:
9258: =item *
9259:
9260: metadata_query($query,$custom,$customshow) : make a metadata query against the
9261: network of library servers; returns file handle of where SQL and regex results
9262: will be stored for query
9263:
9264: =item *
9265:
9266: symbread($filename) : return symbolic list entry (filename argument optional);
9267: returns the data handle
9268:
9269: =item *
9270:
9271: symbverify($symb,$thisfn) : verifies that $symb actually exists and is
9272: a possible symb for the URL in $thisfn, and if is an encryypted
9273: resource that the user accessed using /enc/ returns a 1 on success, 0
9274: on failure, user must be in a course, as it assumes the existance of
9275: the course initial hash, and uses $env('request.course.id'}
9276:
9277:
9278: =item *
9279:
9280: symbclean($symb) : removes versions numbers from a symb, returns the
9281: cleaned symb
9282:
9283: =item *
9284:
9285: is_on_map($uri) : checks if the $uri is somewhere on the current
9286: course map, user must be in a course for it to work.
9287:
9288: =item *
9289:
9290: numval($salt) : return random seed value (addend for rndseed)
9291:
9292: =item *
9293:
9294: rndseed($symb,$courseid,$udom,$uname) : create a random sum; returns
9295: a random seed, all arguments are optional, if they aren't sent it uses the
9296: environment to derive them. Note: if symb isn't sent and it can't get one
9297: from &symbread it will use the current time as its return value
9298:
9299: =item *
9300:
9301: ireceipt($funame,$fudom,$fucourseid,$fusymb) : return unique,
9302: unfakeable, receipt
9303:
9304: =item *
9305:
9306: receipt() : API to ireceipt working off of env values; given out to users
9307:
9308: =item *
9309:
9310: countacc($url) : count the number of accesses to a given URL
9311:
9312: =item *
9313:
9314: 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
9315:
9316: =item *
9317:
9318: 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)
9319:
9320: =item *
9321:
9322: expirespread($uname,$udom,$stype,$usymb) : set expire date for spreadsheet
9323:
9324: =item *
9325:
9326: devalidate($symb) : devalidate temporary spreadsheet calculations,
9327: forcing spreadsheet to reevaluate the resource scores next time.
9328:
9329: =back
9330:
9331: =head2 Storing/Retreiving Data
9332:
9333: =over 4
9334:
9335: =item *
9336:
9337: store($storehash,$symb,$namespace,$udom,$uname) : stores hash permanently
9338: for this url; hashref needs to be given and should be a \%hashname; the
9339: remaining args aren't required and if they aren't passed or are '' they will
9340: be derived from the env
9341:
9342: =item *
9343:
9344: cstore($storehash,$symb,$namespace,$udom,$uname) : same as store but
9345: uses critical subroutine
9346:
9347: =item *
9348:
9349: restore($symb,$namespace,$udom,$uname) : returns hash for this symb;
9350: all args are optional
9351:
9352: =item *
9353:
9354: dumpstore($namespace,$udom,$uname,$regexp,$range) :
9355: dumps the complete (or key matching regexp) namespace into a hash
9356: ($udom, $uname, $regexp, $range are optional) for a namespace that is
9357: normally &store()ed into
9358:
9359: $range should be either an integer '100' (give me the first 100
9360: matching records)
9361: or be two integers sperated by a - with no spaces
9362: '30-50' (give me the 30th through the 50th matching
9363: records)
9364:
9365:
9366: =item *
9367:
9368: putstore($namespace,$symb,$version,$storehash,$udomain,$uname) :
9369: replaces a &store() version of data with a replacement set of data
9370: for a particular resource in a namespace passed in the $storehash hash
9371: reference
9372:
9373: =item *
9374:
9375: tmpstore($storehash,$symb,$namespace,$udom,$uname) : storage that
9376: works very similar to store/cstore, but all data is stored in a
9377: temporary location and can be reset using tmpreset, $storehash should
9378: be a hash reference, returns nothing on success
9379:
9380: =item *
9381:
9382: tmprestore($symb,$namespace,$udom,$uname) : storage that works very
9383: similar to restore, but all data is stored in a temporary location and
9384: can be reset using tmpreset. Returns a hash of values on success,
9385: error string otherwise.
9386:
9387: =item *
9388:
9389: tmpreset($symb,$namespace,$udom,$uname) : temporary storage reset,
9390: deltes all keys for $symb form the temporary storage hash.
9391:
9392: =item *
9393:
9394: get($namespace,$storearr,$udom,$uname) : returns hash with keys from array
9395: reference filled in from namesp ($udom and $uname are optional)
9396:
9397: =item *
9398:
9399: del($namespace,$storearr,$udom,$uname) : deletes keys out of array from
9400: namesp ($udom and $uname are optional)
9401:
9402: =item *
9403:
9404: dump($namespace,$udom,$uname,$regexp,$range) :
9405: dumps the complete (or key matching regexp) namespace into a hash
9406: ($udom, $uname, $regexp, $range are optional)
9407:
9408: $range should be either an integer '100' (give me the first 100
9409: matching records)
9410: or be two integers sperated by a - with no spaces
9411: '30-50' (give me the 30th through the 50th matching
9412: records)
9413: =item *
9414:
9415: inc($namespace,$store,$udom,$uname) : increments $store in $namespace.
9416: $store can be a scalar, an array reference, or if the amount to be
9417: incremented is > 1, a hash reference.
9418:
9419: ($udom and $uname are optional)
9420:
9421: =item *
9422:
9423: put($namespace,$storehash,$udom,$uname) : stores hash in namesp
9424: ($udom and $uname are optional)
9425:
9426: =item *
9427:
9428: cput($namespace,$storehash,$udom,$uname) : critical put
9429: ($udom and $uname are optional)
9430:
9431: =item *
9432:
9433: newput($namespace,$storehash,$udom,$uname) :
9434:
9435: Attempts to store the items in the $storehash, but only if they don't
9436: currently exist, if this succeeds you can be certain that you have
9437: successfully created a new key value pair in the $namespace db.
9438:
9439:
9440: Args:
9441: $namespace: name of database to store values to
9442: $storehash: hashref to store to the db
9443: $udom: (optional) domain of user containing the db
9444: $uname: (optional) name of user caontaining the db
9445:
9446: Returns:
9447: 'ok' -> succeeded in storing all keys of $storehash
9448: 'key_exists: <key>' -> failed to anything out of $storehash, as at
9449: least <key> already existed in the db (other
9450: requested keys may also already exist)
9451: 'error: <msg>' -> unable to tie the DB or other erorr occured
9452: 'con_lost' -> unable to contact request server
9453: 'refused' -> action was not allowed by remote machine
9454:
9455:
9456: =item *
9457:
9458: eget($namespace,$storearr,$udom,$uname) : returns hash with keys from array
9459: reference filled in from namesp (encrypts the return communication)
9460: ($udom and $uname are optional)
9461:
9462: =item *
9463:
9464: log($udom,$name,$home,$message) : write to permanent log for user; use
9465: critical subroutine
9466:
9467: =item *
9468:
9469: get_dom($namespace,$storearr,$udom,$uhome) : returns hash with keys from
9470: array reference filled in from namespace found in domain level on either
9471: specified domain server ($uhome) or primary domain server ($udom and $uhome are optional).
9472:
9473: =item *
9474:
9475: put_dom($namespace,$storehash,$udom,$uhome) : stores hash in namespace at
9476: domain level either on specified domain server ($uhome) or primary domain
9477: server ($udom and $uhome are optional)
9478:
9479: =item *
9480:
9481: get_domain_defaults($target_domain) : returns hash with defaults for
9482: authentication and language in the domain. Keys are: auth_def, auth_arg_def,
9483: lang_def; corresponsing values are authentication type (internal, krb4, krb5,
9484: or localauth), initial password or a kerberos realm, language (e.g., en-us).
9485: Values are retrieved from cache (if current), or from domain's configuration.db
9486: (if available), or lastly from values in lonTabs/dns_domain,tab,
9487: or lonTabs/domain.tab.
9488:
9489: %domdefaults = &get_auth_defaults($target_domain);
9490:
9491: =back
9492:
9493: =head2 Network Status Functions
9494:
9495: =over 4
9496:
9497: =item *
9498:
9499: dirlist($uri) : return directory list based on URI
9500:
9501: =item *
9502:
9503: spareserver() : find server with least workload from spare.tab
9504:
9505: =back
9506:
9507: =head2 Apache Request
9508:
9509: =over 4
9510:
9511: =item *
9512:
9513: ssi($url,%hash) : server side include, does a complete request cycle on url to
9514: localhost, posts hash
9515:
9516: =back
9517:
9518: =head2 Data to String to Data
9519:
9520: =over 4
9521:
9522: =item *
9523:
9524: hash2str(%hash) : convert a hash into a string complete with escaping and '='
9525: and '&' separators, supports elements that are arrayrefs and hashrefs
9526:
9527: =item *
9528:
9529: hashref2str($hashref) : convert a hashref into a string complete with
9530: escaping and '=' and '&' separators, supports elements that are
9531: arrayrefs and hashrefs
9532:
9533: =item *
9534:
9535: arrayref2str($arrayref) : convert an arrayref into a string complete
9536: with escaping and '&' separators, supports elements that are arrayrefs
9537: and hashrefs
9538:
9539: =item *
9540:
9541: str2hash($string) : convert string to hash using unescaping and
9542: splitting on '=' and '&', supports elements that are arrayrefs and
9543: hashrefs
9544:
9545: =item *
9546:
9547: str2array($string) : convert string to hash using unescaping and
9548: splitting on '&', supports elements that are arrayrefs and hashrefs
9549:
9550: =back
9551:
9552: =head2 Logging Routines
9553:
9554: =over 4
9555:
9556: These routines allow one to make log messages in the lonnet.log and
9557: lonnet.perm logfiles.
9558:
9559: =item *
9560:
9561: logtouch() : make sure the logfile, lonnet.log, exists
9562:
9563: =item *
9564:
9565: logthis() : append message to the normal lonnet.log file, it gets
9566: preiodically rolled over and deleted.
9567:
9568: =item *
9569:
9570: logperm() : append a permanent message to lonnet.perm.log, this log
9571: file never gets deleted by any automated portion of the system, only
9572: messages of critical importance should go in here.
9573:
9574: =back
9575:
9576: =head2 General File Helper Routines
9577:
9578: =over 4
9579:
9580: =item *
9581:
9582: getfile($file,$caller) : two cases - requests for files in /res or in /uploaded.
9583: (a) files in /uploaded
9584: (i) If a local copy of the file exists -
9585: compares modification date of local copy with last-modified date for
9586: definitive version stored on home server for course. If local copy is
9587: stale, requests a new version from the home server and stores it.
9588: If the original has been removed from the home server, then local copy
9589: is unlinked.
9590: (ii) If local copy does not exist -
9591: requests the file from the home server and stores it.
9592:
9593: If $caller is 'uploadrep':
9594: This indicates a call from lonuploadrep.pm (PerlHeaderParserHandler phase)
9595: for request for files originally uploaded via DOCS.
9596: - returns 'ok' if fresh local copy now available, -1 otherwise.
9597:
9598: Otherwise:
9599: This indicates a call from the content generation phase of the request.
9600: - returns the entire contents of the file or -1.
9601:
9602: (b) files in /res
9603: - returns the entire contents of a file or -1;
9604: it properly subscribes to and replicates the file if neccessary.
9605:
9606:
9607: =item *
9608:
9609: stat_file($url) : $url is expected to be a /res/ or /uploaded/ style file
9610: reference
9611:
9612: returns either a stat() list of data about the file or an empty list
9613: if the file doesn't exist or couldn't find out about it (connection
9614: problems or user unknown)
9615:
9616: =item *
9617:
9618: filelocation($dir,$file) : returns file system location of a file
9619: based on URI; meant to be "fairly clean" absolute reference, $dir is a
9620: directory that relative $file lookups are to looked in ($dir of /a/dir
9621: and a file of ../bob will become /a/bob)
9622:
9623: =item *
9624:
9625: hreflocation($dir,$file) : returns file system location or a URL; same as
9626: filelocation except for hrefs
9627:
9628: =item *
9629:
9630: declutter() : declutters URLs (remove docroot, beginning slashes, 'res' etc)
9631:
9632: =back
9633:
9634: =head2 Usererfile file routines (/uploaded*)
9635:
9636: =over 4
9637:
9638: =item *
9639:
9640: userfileupload(): main rotine for putting a file in a user or course's
9641: filespace, arguments are,
9642:
9643: formname - required - this is the name of the element in $env where the
9644: filename, and the contents of the file to create/modifed exist
9645: the filename is in $env{'form.'.$formname.'.filename'} and the
9646: contents of the file is located in $env{'form.'.$formname}
9647: coursedoc - if true, store the file in the course of the active role
9648: of the current user
9649: subdir - required - subdirectory to put the file in under ../userfiles/
9650: if undefined, it will be placed in "unknown"
9651:
9652: (This routine calls clean_filename() to remove any dangerous
9653: characters from the filename, and then calls finuserfileupload() to
9654: complete the transaction)
9655:
9656: returns either the url of the uploaded file (/uploaded/....) if successful
9657: and /adm/notfound.html if unsuccessful
9658:
9659: =item *
9660:
9661: clean_filename(): routine for cleaing a filename up for storage in
9662: userfile space, argument is:
9663:
9664: filename - proposed filename
9665:
9666: returns: the new clean filename
9667:
9668: =item *
9669:
9670: finishuserfileupload(): routine that creaes and sends the file to
9671: userspace, probably shouldn't be called directly
9672:
9673: docuname: username or courseid of destination for the file
9674: docudom: domain of user/course of destination for the file
9675: formname: same as for userfileupload()
9676: fname: filename (inculding subdirectories) for the file
9677:
9678: returns either the url of the uploaded file (/uploaded/....) if successful
9679: and /adm/notfound.html if unsuccessful
9680:
9681: =item *
9682:
9683: renameuserfile(): renames an existing userfile to a new name
9684:
9685: Args:
9686: docuname: username or courseid of destination for the file
9687: docudom: domain of user/course of destination for the file
9688: old: current file name (including any subdirs under userfiles)
9689: new: desired file name (including any subdirs under userfiles)
9690:
9691: =item *
9692:
9693: mkdiruserfile(): creates a directory is a userfiles dir
9694:
9695: Args:
9696: docuname: username or courseid of destination for the file
9697: docudom: domain of user/course of destination for the file
9698: dir: dir to create (including any subdirs under userfiles)
9699:
9700: =item *
9701:
9702: removeuserfile(): removes a file that exists in userfiles
9703:
9704: Args:
9705: docuname: username or courseid of destination for the file
9706: docudom: domain of user/course of destination for the file
9707: fname: filname to delete (including any subdirs under userfiles)
9708:
9709: =item *
9710:
9711: removeuploadedurl(): convience function for removeuserfile()
9712:
9713: Args:
9714: url: a full /uploaded/... url to delete
9715:
9716: =item *
9717:
9718: get_portfile_permissions():
9719: Args:
9720: domain: domain of user or course contain the portfolio files
9721: user: name of user or num of course contain the portfolio files
9722: Returns:
9723: hashref of a dump of the proper file_permissions.db
9724:
9725:
9726: =item *
9727:
9728: get_access_controls():
9729:
9730: Args:
9731: current_permissions: the hash ref returned from get_portfile_permissions()
9732: group: (optional) the group you want the files associated with
9733: file: (optional) the file you want access info on
9734:
9735: Returns:
9736: a hash (keys are file names) of hashes containing
9737: keys are: path to file/file_name\0uniqueID:scope_end_start (see below)
9738: values are XML containing access control settings (see below)
9739:
9740: Internal notes:
9741:
9742: access controls are stored in file_permissions.db as key=value pairs.
9743: key -> path to file/file_name\0uniqueID:scope_end_start
9744: where scope -> public,guest,course,group,domains or users.
9745: end -> UNIX time for end of access (0 -> no end date)
9746: start -> UNIX time for start of access
9747:
9748: value -> XML description of access control
9749: <scope type=""> (type =1 of: public,guest,course,group,domains,users">
9750: <start></start>
9751: <end></end>
9752:
9753: <password></password> for scope type = guest
9754:
9755: <domain></domain> for scope type = course or group
9756: <number></number>
9757: <roles id="">
9758: <role></role>
9759: <access></access>
9760: <section></section>
9761: <group></group>
9762: </roles>
9763:
9764: <dom></dom> for scope type = domains
9765:
9766: <users> for scope type = users
9767: <user>
9768: <uname></uname>
9769: <udom></udom>
9770: </user>
9771: </users>
9772: </scope>
9773:
9774: Access data is also aggregated for each file in an additional key=value pair:
9775: key -> path to file/file_name\0accesscontrol
9776: value -> reference to hash
9777: hash contains key = value pairs
9778: where key = uniqueID:scope_end_start
9779: value = UNIX time record was last updated
9780:
9781: Used to improve speed of look-ups of access controls for each file.
9782:
9783: Locks on files (resulting from submission of portfolio file to a homework problem stored in array of arrays.
9784:
9785: modify_access_controls():
9786:
9787: Modifies access controls for a portfolio file
9788: Args
9789: 1. file name
9790: 2. reference to hash of required changes,
9791: 3. domain
9792: 4. username
9793: where domain,username are the domain of the portfolio owner
9794: (either a user or a course)
9795:
9796: Returns:
9797: 1. result of additions or updates ('ok' or 'error', with error message).
9798: 2. result of deletions ('ok' or 'error', with error message).
9799: 3. reference to hash of any new or updated access controls.
9800: 4. reference to hash used to map incoming IDs to uniqueIDs assigned to control.
9801: key = integer (inbound ID)
9802: value = uniqueID
9803:
9804: =back
9805:
9806: =head2 HTTP Helper Routines
9807:
9808: =over 4
9809:
9810: =item *
9811:
9812: escape() : unpack non-word characters into CGI-compatible hex codes
9813:
9814: =item *
9815:
9816: unescape() : pack CGI-compatible hex codes into actual non-word ASCII character
9817:
9818: =back
9819:
9820: =head1 PRIVATE SUBROUTINES
9821:
9822: =head2 Underlying communication routines (Shouldn't call)
9823:
9824: =over 4
9825:
9826: =item *
9827:
9828: subreply() : tries to pass a message to lonc, returns con_lost if incapable
9829:
9830: =item *
9831:
9832: reply() : uses subreply to send a message to remote machine, logs all failures
9833:
9834: =item *
9835:
9836: critical() : passes a critical message to another server; if cannot
9837: get through then place message in connection buffer directory and
9838: returns con_delayed, if incapable of saving message, returns
9839: con_failed
9840:
9841: =item *
9842:
9843: reconlonc() : tries to reconnect lonc client processes.
9844:
9845: =back
9846:
9847: =head2 Resource Access Logging
9848:
9849: =over 4
9850:
9851: =item *
9852:
9853: flushcourselogs() : flush (save) buffer logs and access logs
9854:
9855: =item *
9856:
9857: courselog($what) : save message for course in hash
9858:
9859: =item *
9860:
9861: courseacclog($what) : save message for course using &courselog(). Perform
9862: special processing for specific resource types (problems, exams, quizzes, etc).
9863:
9864: =item *
9865:
9866: goodbye() : flush course logs and log shutting down; it is called in srm.conf
9867: as a PerlChildExitHandler
9868:
9869: =back
9870:
9871: =head2 Other
9872:
9873: =over 4
9874:
9875: =item *
9876:
9877: symblist($mapname,%newhash) : update symbolic storage links
9878:
9879: =back
9880:
9881: =cut
9882:
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