1: # The LearningOnline Network
2: # TCP networking package
3: #
4: # $Id: lonnet.pm,v 1.1371 2018/03/30 21:30:00 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: =pod
31:
32: =head1 NAME
33:
34: Apache::lonnet.pm
35:
36: =head1 SYNOPSIS
37:
38: This file is an interface to the lonc processes of
39: the LON-CAPA network as well as set of elaborated functions for handling information
40: necessary for navigating through a given cluster of LON-CAPA machines within a
41: domain. There are over 40 specialized functions in this module which handle the
42: reading and transmission of metadata, user information (ids, names, environments, roles,
43: logs), file information (storage, reading, directories, extensions, replication, embedded
44: styles and descriptors), educational resources (course descriptions, section names and
45: numbers), url hashing (to assign roles on a url basis), and translating abbreviated symbols to
46: and from more descriptive phrases or explanations.
47:
48: This is part of the LearningOnline Network with CAPA project
49: described at http://www.lon-capa.org.
50:
51: =head1 Package Variables
52:
53: These are largely undocumented, so if you decipher one please note it here.
54:
55: =over 4
56:
57: =item $processmarker
58:
59: Contains the time this process was started and this servers host id.
60:
61: =item $dumpcount
62:
63: Counts the number of times a message log flush has been attempted (regardless
64: of success) by this process. Used as part of the filename when messages are
65: delayed.
66:
67: =back
68:
69: =cut
70:
71: package Apache::lonnet;
72:
73: use strict;
74: use HTTP::Date;
75: use Image::Magick;
76:
77:
78: use Encode;
79:
80: use vars qw(%perlvar %spareid %pr %prp $memcache %packagetab $tmpdir
81: $_64bit %env %protocol %loncaparevs %serverhomeIDs %needsrelease
82: %managerstab);
83:
84: my (%badServerCache, $memcache, %courselogs, %accesshash, %domainrolehash,
85: %userrolehash, $processmarker, $dumpcount, %coursedombuf,
86: %coursenumbuf, %coursehombuf, %coursedescrbuf, %courseinstcodebuf,
87: %courseownerbuf, %coursetypebuf,$locknum);
88:
89: use IO::Socket;
90: use GDBM_File;
91: use HTML::LCParser;
92: use Fcntl qw(:flock);
93: use Storable qw(thaw nfreeze);
94: use Time::HiRes qw( sleep gettimeofday tv_interval );
95: use Cache::Memcached;
96: use Digest::MD5;
97: use Math::Random;
98: use File::MMagic;
99: use LONCAPA qw(:DEFAULT :match);
100: use LONCAPA::Configuration;
101: use LONCAPA::lonmetadata;
102: use LONCAPA::Lond;
103: use LONCAPA::LWPReq;
104:
105: use File::Copy;
106:
107: my $readit;
108: my $max_connection_retries = 20; # Or some such value.
109:
110: require Exporter;
111:
112: our @ISA = qw (Exporter);
113: our @EXPORT = qw(%env);
114:
115:
116: # ------------------------------------ Logging (parameters, docs, slots, roles)
117: {
118: my $logid;
119: sub write_log {
120: my ($context,$hash_name,$storehash,$delflag,$uname,$udom,$cnum,$cdom)=@_;
121: if ($context eq 'course') {
122: if (($cnum eq '') || ($cdom eq '')) {
123: $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
124: $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
125: }
126: }
127: $logid ++;
128: my $now = time();
129: my $id=$now.'00000'.$$.'00000'.$logid;
130: my $logentry = {
131: $id => {
132: 'exe_uname' => $env{'user.name'},
133: 'exe_udom' => $env{'user.domain'},
134: 'exe_time' => $now,
135: 'exe_ip' => $ENV{'REMOTE_ADDR'},
136: 'delflag' => $delflag,
137: 'logentry' => $storehash,
138: 'uname' => $uname,
139: 'udom' => $udom,
140: }
141: };
142: return &put('nohist_'.$hash_name,$logentry,$cdom,$cnum);
143: }
144: }
145:
146: sub logtouch {
147: my $execdir=$perlvar{'lonDaemons'};
148: unless (-e "$execdir/logs/lonnet.log") {
149: open(my $fh,">>","$execdir/logs/lonnet.log");
150: close $fh;
151: }
152: my ($wwwuid,$wwwgid)=(getpwnam('www'))[2,3];
153: chown($wwwuid,$wwwgid,$execdir.'/logs/lonnet.log');
154: }
155:
156: sub logthis {
157: my $message=shift;
158: my $execdir=$perlvar{'lonDaemons'};
159: my $now=time;
160: my $local=localtime($now);
161: if (open(my $fh,">>","$execdir/logs/lonnet.log")) {
162: my $logstring = $local. " ($$): ".$message."\n"; # Keep any \'s in string.
163: print $fh $logstring;
164: close($fh);
165: }
166: return 1;
167: }
168:
169: sub logperm {
170: my $message=shift;
171: my $execdir=$perlvar{'lonDaemons'};
172: my $now=time;
173: my $local=localtime($now);
174: if (open(my $fh,">>","$execdir/logs/lonnet.perm.log")) {
175: print $fh "$now:$message:$local\n";
176: close($fh);
177: }
178: return 1;
179: }
180:
181: sub create_connection {
182: my ($hostname,$lonid) = @_;
183: my $client=IO::Socket::UNIX->new(Peer => $perlvar{'lonSockCreate'},
184: Type => SOCK_STREAM,
185: Timeout => 10);
186: return 0 if (!$client);
187: print $client (join(':',$hostname,$lonid,&machine_ids($hostname))."\n");
188: my $result = <$client>;
189: chomp($result);
190: return 1 if ($result eq 'done');
191: return 0;
192: }
193:
194: sub get_server_timezone {
195: my ($cnum,$cdom) = @_;
196: my $home=&homeserver($cnum,$cdom);
197: if ($home ne 'no_host') {
198: my $cachetime = 24*3600;
199: my ($timezone,$cached)=&is_cached_new('servertimezone',$home);
200: if (defined($cached)) {
201: return $timezone;
202: } else {
203: my $timezone = &reply('servertimezone',$home);
204: return &do_cache_new('servertimezone',$home,$timezone,$cachetime);
205: }
206: }
207: }
208:
209: sub get_server_distarch {
210: my ($lonhost,$ignore_cache) = @_;
211: if (defined($lonhost)) {
212: if (!defined(&hostname($lonhost))) {
213: return;
214: }
215: my $cachetime = 12*3600;
216: if (!$ignore_cache) {
217: my ($distarch,$cached)=&is_cached_new('serverdistarch',$lonhost);
218: if (defined($cached)) {
219: return $distarch;
220: }
221: }
222: my $rep = &reply('serverdistarch',$lonhost);
223: unless ($rep eq 'unknown_command' || $rep eq 'no_such_host' ||
224: $rep eq 'con_lost' || $rep eq 'rejected' || $rep eq 'refused' ||
225: $rep eq '') {
226: return &do_cache_new('serverdistarch',$lonhost,$rep,$cachetime);
227: }
228: }
229: return;
230: }
231:
232: sub get_servercerts_info {
233: my ($lonhost,$context) = @_;
234: my ($rep,$uselocal);
235: if (grep { $_ eq $lonhost } ¤t_machine_ids()) {
236: $uselocal = 1;
237: }
238: if (($context ne 'cgi') && ($uselocal)) {
239: my $distro = (split(/\:/,&get_server_distarch($lonhost)))[0];
240: if ($distro eq '') {
241: $uselocal = 0;
242: } elsif ($distro =~ /^(?:centos|redhat|scientific)(\d+)$/) {
243: if ($1 < 6) {
244: $uselocal = 0;
245: }
246: } elsif ($distro =~ /^(?:sles)(\d+)$/) {
247: if ($1 < 12) {
248: $uselocal = 0;
249: }
250: }
251: }
252: if ($uselocal) {
253: $rep = LONCAPA::Lond::server_certs(\%perlvar);
254: } else {
255: $rep=&reply('servercerts',$lonhost);
256: }
257: my ($result,%returnhash);
258: if (defined($lonhost)) {
259: if (!defined(&hostname($lonhost))) {
260: return;
261: }
262: }
263: if (($rep=~/^(refused|rejected|error)/) || ($rep eq 'con_lost') ||
264: ($rep eq 'unknown_cmd')) {
265: $result = $rep;
266: } else {
267: $result = 'ok';
268: my @pairs=split(/\&/,$rep);
269: foreach my $item (@pairs) {
270: my ($key,$value)=split(/=/,$item,2);
271: my $what = &unescape($key);
272: $returnhash{$what}=&thaw_unescape($value);
273: }
274: }
275: return ($result,\%returnhash);
276: }
277:
278: sub get_server_loncaparev {
279: my ($dom,$lonhost,$ignore_cache,$caller) = @_;
280: if (defined($lonhost)) {
281: if (!defined(&hostname($lonhost))) {
282: undef($lonhost);
283: }
284: }
285: if (!defined($lonhost)) {
286: if (defined(&domain($dom,'primary'))) {
287: $lonhost=&domain($dom,'primary');
288: if ($lonhost eq 'no_host') {
289: undef($lonhost);
290: }
291: }
292: }
293: if (defined($lonhost)) {
294: my $cachetime = 12*3600;
295: if (!$ignore_cache) {
296: my ($loncaparev,$cached)=&is_cached_new('serverloncaparev',$lonhost);
297: if (defined($cached)) {
298: return $loncaparev;
299: }
300: }
301: my ($answer,$loncaparev);
302: my @ids=¤t_machine_ids();
303: if (grep(/^\Q$lonhost\E$/,@ids)) {
304: $answer = $perlvar{'lonVersion'};
305: if ($answer =~ /^[\'\"]?([\w.\-]+)[\'\"]?$/) {
306: $loncaparev = $1;
307: }
308: } else {
309: $answer = &reply('serverloncaparev',$lonhost);
310: if (($answer eq 'unknown_cmd') || ($answer eq 'con_lost')) {
311: if ($caller eq 'loncron') {
312: my $protocol = $protocol{$lonhost};
313: $protocol = 'http' if ($protocol ne 'https');
314: my $url = $protocol.'://'.&hostname($lonhost).'/adm/about.html';
315: my $request=new HTTP::Request('GET',$url);
316: my $response=&LONCAPA::LWPReq::makerequest($lonhost,$request,'',\%perlvar,4,1);
317: unless ($response->is_error()) {
318: my $content = $response->content;
319: if ($content =~ /<p>VERSION\:\s*([\w.\-]+)<\/p>/) {
320: $loncaparev = $1;
321: }
322: }
323: } else {
324: $loncaparev = $loncaparevs{$lonhost};
325: }
326: } elsif ($answer =~ /^[\'\"]?([\w.\-]+)[\'\"]?$/) {
327: $loncaparev = $1;
328: }
329: }
330: return &do_cache_new('serverloncaparev',$lonhost,$loncaparev,$cachetime);
331: }
332: }
333:
334: sub get_server_homeID {
335: my ($hostname,$ignore_cache,$caller) = @_;
336: unless ($ignore_cache) {
337: my ($serverhomeID,$cached)=&is_cached_new('serverhomeID',$hostname);
338: if (defined($cached)) {
339: return $serverhomeID;
340: }
341: }
342: my $cachetime = 12*3600;
343: my $serverhomeID;
344: if ($caller eq 'loncron') {
345: my @machine_ids = &machine_ids($hostname);
346: foreach my $id (@machine_ids) {
347: my $response = &reply('serverhomeID',$id);
348: unless (($response eq 'unknown_cmd') || ($response eq 'con_lost')) {
349: $serverhomeID = $response;
350: last;
351: }
352: }
353: if ($serverhomeID eq '') {
354: $serverhomeID = $machine_ids[-1];
355: }
356: } else {
357: $serverhomeID = $serverhomeIDs{$hostname};
358: }
359: return &do_cache_new('serverhomeID',$hostname,$serverhomeID,$cachetime);
360: }
361:
362: sub get_remote_globals {
363: my ($lonhost,$whathash,$ignore_cache) = @_;
364: my ($result,%returnhash,%whatneeded);
365: if (ref($whathash) eq 'HASH') {
366: foreach my $what (sort(keys(%{$whathash}))) {
367: my $hashid = $lonhost.'-'.$what;
368: my ($response,$cached);
369: unless ($ignore_cache) {
370: ($response,$cached)=&is_cached_new('lonnetglobal',$hashid);
371: }
372: if (defined($cached)) {
373: $returnhash{$what} = $response;
374: } else {
375: $whatneeded{$what} = 1;
376: }
377: }
378: if (keys(%whatneeded) == 0) {
379: $result = 'ok';
380: } else {
381: my $requested = &freeze_escape(\%whatneeded);
382: my $rep=&reply('readlonnetglobal:'.$requested,$lonhost);
383: if (($rep=~/^(refused|rejected|error)/) || ($rep eq 'con_lost') ||
384: ($rep eq 'unknown_cmd')) {
385: $result = $rep;
386: } else {
387: $result = 'ok';
388: my @pairs=split(/\&/,$rep);
389: foreach my $item (@pairs) {
390: my ($key,$value)=split(/=/,$item,2);
391: my $what = &unescape($key);
392: my $hashid = $lonhost.'-'.$what;
393: $returnhash{$what}=&thaw_unescape($value);
394: &do_cache_new('lonnetglobal',$hashid,$returnhash{$what},600);
395: }
396: }
397: }
398: }
399: return ($result,\%returnhash);
400: }
401:
402: sub remote_devalidate_cache {
403: my ($lonhost,$cachekeys) = @_;
404: my $items;
405: return unless (ref($cachekeys) eq 'ARRAY');
406: my $cachestr = join('&',@{$cachekeys});
407: my $response = &reply('devalidatecache:'.&escape($cachestr),$lonhost);
408: return $response;
409: }
410:
411: # -------------------------------------------------- Non-critical communication
412: sub subreply {
413: my ($cmd,$server)=@_;
414: my $peerfile="$perlvar{'lonSockDir'}/".&hostname($server);
415: #
416: # With loncnew process trimming, there's a timing hole between lonc server
417: # process exit and the master server picking up the listen on the AF_UNIX
418: # socket. In that time interval, a lock file will exist:
419:
420: my $lockfile=$peerfile.".lock";
421: while (-e $lockfile) { # Need to wait for the lockfile to disappear.
422: sleep(0.1);
423: }
424: # At this point, either a loncnew parent is listening or an old lonc
425: # or loncnew child is listening so we can connect or everything's dead.
426: #
427: # We'll give the connection a few tries before abandoning it. If
428: # connection is not possible, we'll con_lost back to the client.
429: #
430: my $client;
431: for (my $retries = 0; $retries < $max_connection_retries; $retries++) {
432: $client=IO::Socket::UNIX->new(Peer =>"$peerfile",
433: Type => SOCK_STREAM,
434: Timeout => 10);
435: if ($client) {
436: last; # Connected!
437: } else {
438: &create_connection(&hostname($server),$server);
439: }
440: sleep(0.1); # Try again later if failed connection.
441: }
442: my $answer;
443: if ($client) {
444: print $client "sethost:$server:$cmd\n";
445: $answer=<$client>;
446: if (!$answer) { $answer="con_lost"; }
447: chomp($answer);
448: } else {
449: $answer = 'con_lost'; # Failed connection.
450: }
451: return $answer;
452: }
453:
454: sub reply {
455: my ($cmd,$server)=@_;
456: unless (defined(&hostname($server))) { return 'no_such_host'; }
457: my $answer=subreply($cmd,$server);
458: if (($answer=~/^refused/) || ($answer=~/^rejected/)) {
459: &logthis("<font color=\"blue\">WARNING:".
460: " $cmd to $server returned $answer</font>");
461: }
462: return $answer;
463: }
464:
465: # ----------------------------------------------------------- Send USR1 to lonc
466:
467: sub reconlonc {
468: my ($lonid) = @_;
469: if ($lonid) {
470: my $hostname = &hostname($lonid);
471: my $peerfile="$perlvar{'lonSockDir'}/$hostname";
472: if ($hostname && -e $peerfile) {
473: &logthis("Trying to reconnect lonc for $lonid ($hostname)");
474: my $client=IO::Socket::UNIX->new(Peer => $peerfile,
475: Type => SOCK_STREAM,
476: Timeout => 10);
477: if ($client) {
478: print $client ("reset_retries\n");
479: my $answer=<$client>;
480: #reset just this one.
481: }
482: }
483: return;
484: }
485:
486: &logthis("Trying to reconnect lonc");
487: my $loncfile="$perlvar{'lonDaemons'}/logs/lonc.pid";
488: if (open(my $fh,"<",$loncfile)) {
489: my $loncpid=<$fh>;
490: chomp($loncpid);
491: if (kill 0 => $loncpid) {
492: &logthis("lonc at pid $loncpid responding, sending USR1");
493: kill USR1 => $loncpid;
494: sleep 1;
495: } else {
496: &logthis(
497: "<font color=\"blue\">WARNING:".
498: " lonc at pid $loncpid not responding, giving up</font>");
499: }
500: } else {
501: &logthis('<font color="blue">WARNING: lonc not running, giving up</font>');
502: }
503: }
504:
505: # ------------------------------------------------------ Critical communication
506:
507: sub critical {
508: my ($cmd,$server)=@_;
509: unless (&hostname($server)) {
510: &logthis("<font color=\"blue\">WARNING:".
511: " Critical message to unknown server ($server)</font>");
512: return 'no_such_host';
513: }
514: my $answer=reply($cmd,$server);
515: if ($answer eq 'con_lost') {
516: &reconlonc($server);
517: my $answer=reply($cmd,$server);
518: if ($answer eq 'con_lost') {
519: my $now=time;
520: my $middlename=$cmd;
521: $middlename=substr($middlename,0,16);
522: $middlename=~s/\W//g;
523: my $dfilename=
524: "$perlvar{'lonSockDir'}/delayed/$now.$dumpcount.$$.$middlename.$server";
525: $dumpcount++;
526: {
527: my $dfh;
528: if (open($dfh,">",$dfilename)) {
529: print $dfh "$cmd\n";
530: close($dfh);
531: }
532: }
533: sleep 1;
534: my $wcmd='';
535: {
536: my $dfh;
537: if (open($dfh,"<",$dfilename)) {
538: $wcmd=<$dfh>;
539: close($dfh);
540: }
541: }
542: chomp($wcmd);
543: if ($wcmd eq $cmd) {
544: &logthis("<font color=\"blue\">WARNING: ".
545: "Connection buffer $dfilename: $cmd</font>");
546: &logperm("D:$server:$cmd");
547: return 'con_delayed';
548: } else {
549: &logthis("<font color=\"red\">CRITICAL:"
550: ." Critical connection failed: $server $cmd</font>");
551: &logperm("F:$server:$cmd");
552: return 'con_failed';
553: }
554: }
555: }
556: return $answer;
557: }
558:
559: # ------------------------------------------- check if return value is an error
560:
561: sub error {
562: my ($result) = @_;
563: if ($result =~ /^(con_lost|no_such_host|error: (\d+) (.*))/) {
564: if ($2 == 2) { return undef; }
565: return $1;
566: }
567: return undef;
568: }
569:
570: sub convert_and_load_session_env {
571: my ($lonidsdir,$handle)=@_;
572: my @profile;
573: {
574: my $opened = open(my $idf,'+<',"$lonidsdir/$handle.id");
575: if (!$opened) {
576: return 0;
577: }
578: flock($idf,LOCK_SH);
579: @profile=<$idf>;
580: close($idf);
581: }
582: my %temp_env;
583: foreach my $line (@profile) {
584: if ($line !~ m/=/) {
585: return 0;
586: }
587: chomp($line);
588: my ($envname,$envvalue)=split(/=/,$line,2);
589: $temp_env{&unescape($envname)} = &unescape($envvalue);
590: }
591: unlink("$lonidsdir/$handle.id");
592: if (tie(my %disk_env,'GDBM_File',"$lonidsdir/$handle.id",&GDBM_WRCREAT(),
593: 0640)) {
594: %disk_env = %temp_env;
595: @env{keys(%temp_env)} = @disk_env{keys(%temp_env)};
596: untie(%disk_env);
597: }
598: return 1;
599: }
600:
601: # ------------------------------------------- Transfer profile into environment
602: my $env_loaded;
603: sub transfer_profile_to_env {
604: my ($lonidsdir,$handle,$force_transfer) = @_;
605: if (!$force_transfer && $env_loaded) { return; }
606:
607: if (!defined($lonidsdir)) {
608: $lonidsdir = $perlvar{'lonIDsDir'};
609: }
610: if (!defined($handle)) {
611: ($handle) = ($env{'user.environment'} =~m|/([^/]+)\.id$| );
612: }
613:
614: my $convert;
615: {
616: my $opened = open(my $idf,'+<',"$lonidsdir/$handle.id");
617: if (!$opened) {
618: return;
619: }
620: flock($idf,LOCK_SH);
621: if (tie(my %disk_env,'GDBM_File',"$lonidsdir/$handle.id",
622: &GDBM_READER(),0640)) {
623: @env{keys(%disk_env)} = @disk_env{keys(%disk_env)};
624: untie(%disk_env);
625: } else {
626: $convert = 1;
627: }
628: }
629: if ($convert) {
630: if (!&convert_and_load_session_env($lonidsdir,$handle)) {
631: &logthis("Failed to load session, or convert session.");
632: }
633: }
634:
635: my %remove;
636: while ( my $envname = each(%env) ) {
637: if (my ($key,$time) = ($envname =~ /^(cgi\.(\d+)_\d+\.)/)) {
638: if ($time < time-300) {
639: $remove{$key}++;
640: }
641: }
642: }
643:
644: $env{'user.environment'} = "$lonidsdir/$handle.id";
645: $env_loaded=1;
646: foreach my $expired_key (keys(%remove)) {
647: &delenv($expired_key);
648: }
649: }
650:
651: # ---------------------------------------------------- Check for valid session
652: sub check_for_valid_session {
653: my ($r,$name,$userhashref,$domref) = @_;
654: my %cookies=CGI::Cookie->parse($r->header_in('Cookie'));
655: my ($linkname,$pubname);
656: if ($name eq '') {
657: $name = 'lonID';
658: $linkname = 'lonLinkID';
659: $pubname = 'lonPubID';
660: }
661: my $lonid=$cookies{$name};
662: if (!$lonid) {
663: if (($name eq 'lonID') && ($ENV{'SERVER_PORT'} != 443) && ($linkname)) {
664: $lonid=$cookies{$linkname};
665: }
666: if (!$lonid) {
667: if (($name eq 'lonID') && ($pubname)) {
668: $lonid=$cookies{$pubname};
669: }
670: }
671: }
672: return undef if (!$lonid);
673:
674: my $handle=&LONCAPA::clean_handle($lonid->value);
675: my $lonidsdir;
676: if ($name eq 'lonDAV') {
677: $lonidsdir=$r->dir_config('lonDAVsessDir');
678: } else {
679: $lonidsdir=$r->dir_config('lonIDsDir');
680: }
681: if (!-e "$lonidsdir/$handle.id") {
682: if ((ref($domref)) && ($name eq 'lonID') &&
683: ($handle =~ /^($match_username)\_\d+\_($match_domain)\_(.+)$/)) {
684: my ($possuname,$possudom,$possuhome) = ($1,$2,$3);
685: if ((&domain($possudom) ne '') && (&homeserver($possuname,$possudom) eq $possuhome)) {
686: $$domref = $possudom;
687: }
688: }
689: return undef;
690: }
691:
692: my $opened = open(my $idf,'+<',"$lonidsdir/$handle.id");
693: return undef if (!$opened);
694:
695: flock($idf,LOCK_SH);
696: my %disk_env;
697: if (!tie(%disk_env,'GDBM_File',"$lonidsdir/$handle.id",
698: &GDBM_READER(),0640)) {
699: return undef;
700: }
701:
702: if (!defined($disk_env{'user.name'})
703: || !defined($disk_env{'user.domain'})) {
704: return undef;
705: }
706:
707: if (ref($userhashref) eq 'HASH') {
708: $userhashref->{'name'} = $disk_env{'user.name'};
709: $userhashref->{'domain'} = $disk_env{'user.domain'};
710: $userhashref->{'lti'} = $disk_env{'request.lti.login'};
711: }
712:
713: return $handle;
714: }
715:
716: sub timed_flock {
717: my ($file,$lock_type) = @_;
718: my $failed=0;
719: eval {
720: local $SIG{__DIE__}='DEFAULT';
721: local $SIG{ALRM}=sub {
722: $failed=1;
723: die("failed lock");
724: };
725: alarm(13);
726: flock($file,$lock_type);
727: alarm(0);
728: };
729: if ($failed) {
730: return undef;
731: } else {
732: return 1;
733: }
734: }
735:
736: # ---------------------------------------------------------- Append Environment
737:
738: sub appenv {
739: my ($newenv,$roles) = @_;
740: if (ref($newenv) eq 'HASH') {
741: foreach my $key (keys(%{$newenv})) {
742: my $refused = 0;
743: if (($key =~ /^user\.role/) || ($key =~ /^user\.priv/)) {
744: $refused = 1;
745: if (ref($roles) eq 'ARRAY') {
746: my ($type,$role) = ($key =~ m{^user\.(role|priv)\.(.+?)\./});
747: if (grep(/^\Q$role\E$/,@{$roles})) {
748: $refused = 0;
749: }
750: }
751: }
752: if ($refused) {
753: &logthis("<font color=\"blue\">WARNING: ".
754: "Attempt to modify environment ".$key." to ".$newenv->{$key}
755: .'</font>');
756: delete($newenv->{$key});
757: } else {
758: $env{$key}=$newenv->{$key};
759: }
760: }
761: my $opened = open(my $env_file,'+<',$env{'user.environment'});
762: if ($opened
763: && &timed_flock($env_file,LOCK_EX)
764: &&
765: tie(my %disk_env,'GDBM_File',$env{'user.environment'},
766: (&GDBM_WRITER()|&GDBM_NOLOCK()),0640)) {
767: while (my ($key,$value) = each(%{$newenv})) {
768: $disk_env{$key} = $value;
769: }
770: untie(%disk_env);
771: }
772: }
773: return 'ok';
774: }
775: # ----------------------------------------------------- Delete from Environment
776:
777: sub delenv {
778: my ($delthis,$regexp,$roles) = @_;
779: if (($delthis=~/^user\.role/) || ($delthis=~/^user\.priv/)) {
780: my $refused = 1;
781: if (ref($roles) eq 'ARRAY') {
782: my ($type,$role) = ($delthis =~ /^user\.(role|priv)\.([^.]+)\./);
783: if (grep(/^\Q$role\E$/,@{$roles})) {
784: $refused = 0;
785: }
786: }
787: if ($refused) {
788: &logthis("<font color=\"blue\">WARNING: ".
789: "Attempt to delete from environment ".$delthis);
790: return 'error';
791: }
792: }
793: my $opened = open(my $env_file,'+<',$env{'user.environment'});
794: if ($opened
795: && &timed_flock($env_file,LOCK_EX)
796: &&
797: tie(my %disk_env,'GDBM_File',$env{'user.environment'},
798: (&GDBM_WRITER()|&GDBM_NOLOCK()),0640)) {
799: foreach my $key (keys(%disk_env)) {
800: if ($regexp) {
801: if ($key=~/^$delthis/) {
802: delete($env{$key});
803: delete($disk_env{$key});
804: }
805: } else {
806: if ($key=~/^\Q$delthis\E/) {
807: delete($env{$key});
808: delete($disk_env{$key});
809: }
810: }
811: }
812: untie(%disk_env);
813: }
814: return 'ok';
815: }
816:
817: sub get_env_multiple {
818: my ($name) = @_;
819: my @values;
820: if (defined($env{$name})) {
821: # exists is it an array
822: if (ref($env{$name})) {
823: @values=@{ $env{$name} };
824: } else {
825: $values[0]=$env{$name};
826: }
827: }
828: return(@values);
829: }
830:
831: # ------------------------------------------------------------------- Locking
832:
833: sub set_lock {
834: my ($text)=@_;
835: $locknum++;
836: my $id=$$.'-'.$locknum;
837: &appenv({'session.locks' => $env{'session.locks'}.','.$id,
838: 'session.lock.'.$id => $text});
839: return $id;
840: }
841:
842: sub get_locks {
843: my $num=0;
844: my %texts=();
845: foreach my $lock (split(/\,/,$env{'session.locks'})) {
846: if ($lock=~/\w/) {
847: $num++;
848: $texts{$lock}=$env{'session.lock.'.$lock};
849: }
850: }
851: return ($num,%texts);
852: }
853:
854: sub remove_lock {
855: my ($id)=@_;
856: my $newlocks='';
857: foreach my $lock (split(/\,/,$env{'session.locks'})) {
858: if (($lock=~/\w/) && ($lock ne $id)) {
859: $newlocks.=','.$lock;
860: }
861: }
862: &appenv({'session.locks' => $newlocks});
863: &delenv('session.lock.'.$id);
864: }
865:
866: sub remove_all_locks {
867: my $activelocks=$env{'session.locks'};
868: foreach my $lock (split(/\,/,$env{'session.locks'})) {
869: if ($lock=~/\w/) {
870: &remove_lock($lock);
871: }
872: }
873: }
874:
875:
876: # ------------------------------------------ Find out current server userload
877: sub userload {
878: my $numusers=0;
879: {
880: opendir(LONIDS,$perlvar{'lonIDsDir'});
881: my $filename;
882: my $curtime=time;
883: while ($filename=readdir(LONIDS)) {
884: next if ($filename eq '.' || $filename eq '..');
885: next if ($filename =~ /publicuser_\d+\.id/);
886: my ($mtime)=(stat($perlvar{'lonIDsDir'}.'/'.$filename))[9];
887: if ($curtime-$mtime < 1800) { $numusers++; }
888: }
889: closedir(LONIDS);
890: }
891: my $userloadpercent=0;
892: my $maxuserload=$perlvar{'lonUserLoadLim'};
893: if ($maxuserload) {
894: $userloadpercent=100*$numusers/$maxuserload;
895: }
896: $userloadpercent=sprintf("%.2f",$userloadpercent);
897: return $userloadpercent;
898: }
899:
900: # ------------------------------ Find server with least workload from spare.tab
901:
902: sub spareserver {
903: my ($loadpercent,$userloadpercent,$want_server_name,$udom) = @_;
904: my $spare_server;
905: if ($userloadpercent !~ /\d/) { $userloadpercent=0; }
906: my $lowest_load=($loadpercent > $userloadpercent) ? $loadpercent
907: : $userloadpercent;
908: my ($uint_dom,$remotesessions);
909: if (($udom ne '') && (&domain($udom) ne '')) {
910: my $uprimary_id = &Apache::lonnet::domain($udom,'primary');
911: $uint_dom = &Apache::lonnet::internet_dom($uprimary_id);
912: my %udomdefaults = &Apache::lonnet::get_domain_defaults($udom);
913: $remotesessions = $udomdefaults{'remotesessions'};
914: }
915: my $spareshash = &this_host_spares($udom);
916: if (ref($spareshash) eq 'HASH') {
917: if (ref($spareshash->{'primary'}) eq 'ARRAY') {
918: foreach my $try_server (@{ $spareshash->{'primary'} }) {
919: next unless (&spare_can_host($udom,$uint_dom,$remotesessions,
920: $try_server));
921: ($spare_server, $lowest_load) =
922: &compare_server_load($try_server, $spare_server, $lowest_load);
923: }
924: }
925:
926: my $found_server = ($spare_server ne '' && $lowest_load < 100);
927:
928: if (!$found_server) {
929: if (ref($spareshash->{'default'}) eq 'ARRAY') {
930: foreach my $try_server (@{ $spareshash->{'default'} }) {
931: next unless (&spare_can_host($udom,$uint_dom,
932: $remotesessions,$try_server));
933: ($spare_server, $lowest_load) =
934: &compare_server_load($try_server, $spare_server, $lowest_load);
935: }
936: }
937: }
938: }
939:
940: if (!$want_server_name) {
941: my $protocol = 'http';
942: if ($protocol{$spare_server} eq 'https') {
943: $protocol = $protocol{$spare_server};
944: }
945: if (defined($spare_server)) {
946: my $hostname = &hostname($spare_server);
947: if (defined($hostname)) {
948: $spare_server = $protocol.'://'.$hostname;
949: }
950: }
951: }
952: return $spare_server;
953: }
954:
955: sub compare_server_load {
956: my ($try_server, $spare_server, $lowest_load, $required) = @_;
957:
958: if ($required) {
959: my ($reqdmajor,$reqdminor) = ($required =~ /^(\d+)\.(\d+)$/);
960: my $remoterev = &get_server_loncaparev(undef,$try_server);
961: my ($major,$minor) = ($remoterev =~ /^\'?(\d+)\.(\d+)\.[\w.\-]+\'?$/);
962: if (($major eq '' && $minor eq '') ||
963: (($reqdmajor > $major) || (($reqdmajor == $major) && ($reqdminor > $minor)))) {
964: return ($spare_server,$lowest_load);
965: }
966: }
967:
968: my $loadans = &reply('load', $try_server);
969: my $userloadans = &reply('userload',$try_server);
970:
971: if ($loadans !~ /\d/ && $userloadans !~ /\d/) {
972: return ($spare_server, $lowest_load); #didn't get a number from the server
973: }
974:
975: my $load;
976: if ($loadans =~ /\d/) {
977: if ($userloadans =~ /\d/) {
978: #both are numbers, pick the bigger one
979: $load = ($loadans > $userloadans) ? $loadans
980: : $userloadans;
981: } else {
982: $load = $loadans;
983: }
984: } else {
985: $load = $userloadans;
986: }
987:
988: if (($load =~ /\d/) && ($load < $lowest_load)) {
989: $spare_server = $try_server;
990: $lowest_load = $load;
991: }
992: return ($spare_server,$lowest_load);
993: }
994:
995: # --------------------------- ask offload servers if user already has a session
996: sub find_existing_session {
997: my ($udom,$uname) = @_;
998: my $spareshash = &this_host_spares($udom);
999: if (ref($spareshash) eq 'HASH') {
1000: if (ref($spareshash->{'primary'}) eq 'ARRAY') {
1001: foreach my $try_server (@{ $spareshash->{'primary'} }) {
1002: return $try_server if (&has_user_session($try_server, $udom, $uname));
1003: }
1004: }
1005: if (ref($spareshash->{'default'}) eq 'ARRAY') {
1006: foreach my $try_server (@{ $spareshash->{'default'} }) {
1007: return $try_server if (&has_user_session($try_server, $udom, $uname));
1008: }
1009: }
1010: }
1011: return;
1012: }
1013:
1014: # -------------------------------- ask if server already has a session for user
1015: sub has_user_session {
1016: my ($lonid,$udom,$uname) = @_;
1017: my $result = &reply(join(':','userhassession',
1018: map {&escape($_)} ($udom,$uname)),$lonid);
1019: return 1 if ($result eq 'ok');
1020:
1021: return 0;
1022: }
1023:
1024: # --------- determine least loaded server in a user's domain which allows login
1025:
1026: sub choose_server {
1027: my ($udom,$checkloginvia,$required,$skiploadbal) = @_;
1028: my %domconfhash = &Apache::loncommon::get_domainconf($udom);
1029: my %servers = &get_servers($udom);
1030: my $lowest_load = 30000;
1031: my ($login_host,$hostname,$portal_path,$isredirect,$balancers);
1032: if ($skiploadbal) {
1033: ($balancers,my $cached)=&is_cached_new('loadbalancing',$udom);
1034: unless (defined($cached)) {
1035: my $cachetime = 60*60*24;
1036: my %domconfig =
1037: &Apache::lonnet::get_dom('configuration',['loadbalancing'],$udom);
1038: if (ref($domconfig{'loadbalancing'}) eq 'HASH') {
1039: $balancers = &do_cache_new('loadbalancing',$udom,$domconfig{'loadbalancing'},
1040: $cachetime);
1041: }
1042: }
1043: }
1044: foreach my $lonhost (keys(%servers)) {
1045: if ($skiploadbal) {
1046: if (ref($balancers) eq 'HASH') {
1047: next if (exists($balancers->{$lonhost}));
1048: }
1049: }
1050: my $loginvia;
1051: if ($checkloginvia) {
1052: $loginvia = $domconfhash{$udom.'.login.loginvia_'.$lonhost};
1053: if ($loginvia) {
1054: my ($server,$path) = split(/:/,$loginvia);
1055: ($login_host, $lowest_load) =
1056: &compare_server_load($server, $login_host, $lowest_load, $required);
1057: if ($login_host eq $server) {
1058: $portal_path = $path;
1059: $isredirect = 1;
1060: }
1061: } else {
1062: ($login_host, $lowest_load) =
1063: &compare_server_load($lonhost, $login_host, $lowest_load, $required);
1064: if ($login_host eq $lonhost) {
1065: $portal_path = '';
1066: $isredirect = '';
1067: }
1068: }
1069: } else {
1070: ($login_host, $lowest_load) =
1071: &compare_server_load($lonhost, $login_host, $lowest_load, $required);
1072: }
1073: }
1074: if ($login_host ne '') {
1075: $hostname = &hostname($login_host);
1076: }
1077: return ($login_host,$hostname,$portal_path,$isredirect,$lowest_load);
1078: }
1079:
1080: # --------------------------------------------- Try to change a user's password
1081:
1082: sub changepass {
1083: my ($uname,$udom,$currentpass,$newpass,$server,$context)=@_;
1084: $currentpass = &escape($currentpass);
1085: $newpass = &escape($newpass);
1086: my $lonhost = $perlvar{'lonHostID'};
1087: my $answer = reply("encrypt:passwd:$udom:$uname:$currentpass:$newpass:$context:$lonhost",
1088: $server);
1089: if (! $answer) {
1090: &logthis("No reply on password change request to $server ".
1091: "by $uname in domain $udom.");
1092: } elsif ($answer =~ "^ok") {
1093: &logthis("$uname in $udom successfully changed their password ".
1094: "on $server.");
1095: } elsif ($answer =~ "^pwchange_failure") {
1096: &logthis("$uname in $udom was unable to change their password ".
1097: "on $server. The action was blocked by either lcpasswd ".
1098: "or pwchange");
1099: } elsif ($answer =~ "^non_authorized") {
1100: &logthis("$uname in $udom did not get their password correct when ".
1101: "attempting to change it on $server.");
1102: } elsif ($answer =~ "^auth_mode_error") {
1103: &logthis("$uname in $udom attempted to change their password despite ".
1104: "not being locally or internally authenticated on $server.");
1105: } elsif ($answer =~ "^unknown_user") {
1106: &logthis("$uname in $udom attempted to change their password ".
1107: "on $server but were unable to because $server is not ".
1108: "their home server.");
1109: } elsif ($answer =~ "^refused") {
1110: &logthis("$server refused to change $uname in $udom password because ".
1111: "it was sent an unencrypted request to change the password.");
1112: } elsif ($answer =~ "invalid_client") {
1113: &logthis("$server refused to change $uname in $udom password because ".
1114: "it was a reset by e-mail originating from an invalid server.");
1115: }
1116: return $answer;
1117: }
1118:
1119: # ----------------------- Try to determine user's current authentication scheme
1120:
1121: sub queryauthenticate {
1122: my ($uname,$udom)=@_;
1123: my $uhome=&homeserver($uname,$udom);
1124: if (!$uhome) {
1125: &logthis("User $uname at $udom is unknown when looking for authentication mechanism");
1126: return 'no_host';
1127: }
1128: my $answer=reply("encrypt:currentauth:$udom:$uname",$uhome);
1129: if ($answer =~ /^(unknown_user|refused|con_lost)/) {
1130: &logthis("User $uname at $udom threw error $answer when checking authentication mechanism");
1131: }
1132: return $answer;
1133: }
1134:
1135: # --------- Try to authenticate user from domain's lib servers (first this one)
1136:
1137: sub authenticate {
1138: my ($uname,$upass,$udom,$checkdefauth,$clientcancheckhost)=@_;
1139: $upass=&escape($upass);
1140: $uname= &LONCAPA::clean_username($uname);
1141: my $uhome=&homeserver($uname,$udom,1);
1142: my $newhome;
1143: if ((!$uhome) || ($uhome eq 'no_host')) {
1144: # Maybe the machine was offline and only re-appeared again recently?
1145: &reconlonc();
1146: # One more
1147: $uhome=&homeserver($uname,$udom,1);
1148: if (($uhome eq 'no_host') && $checkdefauth) {
1149: if (defined(&domain($udom,'primary'))) {
1150: $newhome=&domain($udom,'primary');
1151: }
1152: if ($newhome ne '') {
1153: $uhome = $newhome;
1154: }
1155: }
1156: if ((!$uhome) || ($uhome eq 'no_host')) {
1157: &logthis("User $uname at $udom is unknown in authenticate");
1158: return 'no_host';
1159: }
1160: }
1161: my $answer=reply("encrypt:auth:$udom:$uname:$upass:$checkdefauth:$clientcancheckhost",$uhome);
1162: if ($answer eq 'authorized') {
1163: if ($newhome) {
1164: &logthis("User $uname at $udom authorized by $uhome, but needs account");
1165: return 'no_account_on_host';
1166: } else {
1167: &logthis("User $uname at $udom authorized by $uhome");
1168: return $uhome;
1169: }
1170: }
1171: if ($answer eq 'non_authorized') {
1172: &logthis("User $uname at $udom rejected by $uhome");
1173: return 'no_host';
1174: }
1175: &logthis("User $uname at $udom threw error $answer when checking authentication mechanism");
1176: return 'no_host';
1177: }
1178:
1179: sub can_host_session {
1180: my ($udom,$lonhost,$remoterev,$remotesessions,$hostedsessions) = @_;
1181: my $canhost = 1;
1182: my $host_idn = &Apache::lonnet::internet_dom($lonhost);
1183: if (ref($remotesessions) eq 'HASH') {
1184: if (ref($remotesessions->{'excludedomain'}) eq 'ARRAY') {
1185: if (grep(/^\Q$host_idn\E$/,@{$remotesessions->{'excludedomain'}})) {
1186: $canhost = 0;
1187: } else {
1188: $canhost = 1;
1189: }
1190: }
1191: if (ref($remotesessions->{'includedomain'}) eq 'ARRAY') {
1192: if (grep(/^\Q$host_idn\E$/,@{$remotesessions->{'includedomain'}})) {
1193: $canhost = 1;
1194: } else {
1195: $canhost = 0;
1196: }
1197: }
1198: if ($canhost) {
1199: if ($remotesessions->{'version'} ne '') {
1200: my ($reqmajor,$reqminor) = ($remotesessions->{'version'} =~ /^(\d+)\.(\d+)$/);
1201: if ($reqmajor ne '' && $reqminor ne '') {
1202: if ($remoterev =~ /^\'?(\d+)\.(\d+)/) {
1203: my $major = $1;
1204: my $minor = $2;
1205: if (($major < $reqmajor ) ||
1206: (($major == $reqmajor) && ($minor < $reqminor))) {
1207: $canhost = 0;
1208: }
1209: } else {
1210: $canhost = 0;
1211: }
1212: }
1213: }
1214: }
1215: }
1216: if ($canhost) {
1217: if (ref($hostedsessions) eq 'HASH') {
1218: my $uprimary_id = &Apache::lonnet::domain($udom,'primary');
1219: my $uint_dom = &Apache::lonnet::internet_dom($uprimary_id);
1220: if (ref($hostedsessions->{'excludedomain'}) eq 'ARRAY') {
1221: if (($uint_dom ne '') &&
1222: (grep(/^\Q$uint_dom\E$/,@{$hostedsessions->{'excludedomain'}}))) {
1223: $canhost = 0;
1224: } else {
1225: $canhost = 1;
1226: }
1227: }
1228: if (ref($hostedsessions->{'includedomain'}) eq 'ARRAY') {
1229: if (($uint_dom ne '') &&
1230: (grep(/^\Q$uint_dom\E$/,@{$hostedsessions->{'includedomain'}}))) {
1231: $canhost = 1;
1232: } else {
1233: $canhost = 0;
1234: }
1235: }
1236: }
1237: }
1238: return $canhost;
1239: }
1240:
1241: sub spare_can_host {
1242: my ($udom,$uint_dom,$remotesessions,$try_server)=@_;
1243: my $canhost=1;
1244: my $try_server_hostname = &hostname($try_server);
1245: my $serverhomeID = &get_server_homeID($try_server_hostname);
1246: my $serverhomedom = &host_domain($serverhomeID);
1247: my %defdomdefaults = &get_domain_defaults($serverhomedom);
1248: if (ref($defdomdefaults{'offloadnow'}) eq 'HASH') {
1249: if ($defdomdefaults{'offloadnow'}{$try_server}) {
1250: $canhost = 0;
1251: }
1252: }
1253: if (($canhost) && ($uint_dom)) {
1254: my @intdoms;
1255: my $internet_names = &get_internet_names($try_server);
1256: if (ref($internet_names) eq 'ARRAY') {
1257: @intdoms = @{$internet_names};
1258: }
1259: unless (grep(/^\Q$uint_dom\E$/,@intdoms)) {
1260: my $remoterev = &get_server_loncaparev(undef,$try_server);
1261: $canhost = &can_host_session($udom,$try_server,$remoterev,
1262: $remotesessions,
1263: $defdomdefaults{'hostedsessions'});
1264: }
1265: }
1266: return $canhost;
1267: }
1268:
1269: sub this_host_spares {
1270: my ($dom) = @_;
1271: my ($dom_in_use,$lonhost_in_use,$result);
1272: my @hosts = ¤t_machine_ids();
1273: foreach my $lonhost (@hosts) {
1274: if (&host_domain($lonhost) eq $dom) {
1275: $dom_in_use = $dom;
1276: $lonhost_in_use = $lonhost;
1277: last;
1278: }
1279: }
1280: if ($dom_in_use ne '') {
1281: $result = &spares_for_offload($dom_in_use,$lonhost_in_use);
1282: }
1283: if (ref($result) ne 'HASH') {
1284: $lonhost_in_use = $perlvar{'lonHostID'};
1285: $dom_in_use = &host_domain($lonhost_in_use);
1286: $result = &spares_for_offload($dom_in_use,$lonhost_in_use);
1287: if (ref($result) ne 'HASH') {
1288: $result = \%spareid;
1289: }
1290: }
1291: return $result;
1292: }
1293:
1294: sub spares_for_offload {
1295: my ($dom_in_use,$lonhost_in_use) = @_;
1296: my ($result,$cached)=&is_cached_new('spares',$dom_in_use);
1297: if (defined($cached)) {
1298: return $result;
1299: } else {
1300: my $cachetime = 60*60*24;
1301: my %domconfig =
1302: &Apache::lonnet::get_dom('configuration',['usersessions'],$dom_in_use);
1303: if (ref($domconfig{'usersessions'}) eq 'HASH') {
1304: if (ref($domconfig{'usersessions'}{'spares'}) eq 'HASH') {
1305: if (ref($domconfig{'usersessions'}{'spares'}{$lonhost_in_use}) eq 'HASH') {
1306: return &do_cache_new('spares',$dom_in_use,$domconfig{'usersessions'}{'spares'}{$lonhost_in_use},$cachetime);
1307: }
1308: }
1309: }
1310: }
1311: return;
1312: }
1313:
1314: sub get_lonbalancer_config {
1315: my ($servers) = @_;
1316: my ($currbalancer,$currtargets);
1317: if (ref($servers) eq 'HASH') {
1318: foreach my $server (keys(%{$servers})) {
1319: my %what = (
1320: spareid => 1,
1321: perlvar => 1,
1322: );
1323: my ($result,$returnhash) = &get_remote_globals($server,\%what);
1324: if ($result eq 'ok') {
1325: if (ref($returnhash) eq 'HASH') {
1326: if (ref($returnhash->{'perlvar'}) eq 'HASH') {
1327: if ($returnhash->{'perlvar'}->{'lonBalancer'} eq 'yes') {
1328: $currbalancer = $server;
1329: $currtargets = {};
1330: if (ref($returnhash->{'spareid'}) eq 'HASH') {
1331: if (ref($returnhash->{'spareid'}->{'primary'}) eq 'ARRAY') {
1332: $currtargets->{'primary'} = $returnhash->{'spareid'}->{'primary'};
1333: }
1334: if (ref($returnhash->{'spareid'}->{'default'}) eq 'ARRAY') {
1335: $currtargets->{'default'} = $returnhash->{'spareid'}->{'default'};
1336: }
1337: }
1338: last;
1339: }
1340: }
1341: }
1342: }
1343: }
1344: }
1345: return ($currbalancer,$currtargets);
1346: }
1347:
1348: sub check_loadbalancing {
1349: my ($uname,$udom,$caller) = @_;
1350: my ($is_balancer,$currtargets,$currrules,$dom_in_use,$homeintdom,
1351: $rule_in_effect,$offloadto,$otherserver);
1352: my $lonhost = $perlvar{'lonHostID'};
1353: my @hosts = ¤t_machine_ids();
1354: my $uprimary_id = &Apache::lonnet::domain($udom,'primary');
1355: my $uintdom = &Apache::lonnet::internet_dom($uprimary_id);
1356: my $intdom = &Apache::lonnet::internet_dom($lonhost);
1357: my $serverhomedom = &host_domain($lonhost);
1358: my $domneedscache;
1359: my $cachetime = 60*60*24;
1360:
1361: if (($uintdom ne '') && ($uintdom eq $intdom)) {
1362: $dom_in_use = $udom;
1363: $homeintdom = 1;
1364: } else {
1365: $dom_in_use = $serverhomedom;
1366: }
1367: my ($result,$cached)=&is_cached_new('loadbalancing',$dom_in_use);
1368: unless (defined($cached)) {
1369: my %domconfig =
1370: &Apache::lonnet::get_dom('configuration',['loadbalancing'],$dom_in_use);
1371: if (ref($domconfig{'loadbalancing'}) eq 'HASH') {
1372: $result = &do_cache_new('loadbalancing',$dom_in_use,$domconfig{'loadbalancing'},$cachetime);
1373: } else {
1374: $domneedscache = $dom_in_use;
1375: }
1376: }
1377: if (ref($result) eq 'HASH') {
1378: ($is_balancer,$currtargets,$currrules) =
1379: &check_balancer_result($result,@hosts);
1380: if ($is_balancer) {
1381: if (ref($currrules) eq 'HASH') {
1382: if ($homeintdom) {
1383: if ($uname ne '') {
1384: if (($currrules->{'_LC_adv'} ne '') || ($currrules->{'_LC_author'} ne '')) {
1385: my ($is_adv,$is_author) = &is_advanced_user($udom,$uname);
1386: if (($currrules->{'_LC_author'} ne '') && ($is_author)) {
1387: $rule_in_effect = $currrules->{'_LC_author'};
1388: } elsif (($currrules->{'_LC_adv'} ne '') && ($is_adv)) {
1389: $rule_in_effect = $currrules->{'_LC_adv'}
1390: }
1391: }
1392: if ($rule_in_effect eq '') {
1393: my %userenv = &userenvironment($udom,$uname,'inststatus');
1394: if ($userenv{'inststatus'} ne '') {
1395: my @statuses = map { &unescape($_); } split(/:/,$userenv{'inststatus'});
1396: my ($othertitle,$usertypes,$types) =
1397: &Apache::loncommon::sorted_inst_types($udom);
1398: if (ref($types) eq 'ARRAY') {
1399: foreach my $type (@{$types}) {
1400: if (grep(/^\Q$type\E$/,@statuses)) {
1401: if (exists($currrules->{$type})) {
1402: $rule_in_effect = $currrules->{$type};
1403: }
1404: }
1405: }
1406: }
1407: } else {
1408: if (exists($currrules->{'default'})) {
1409: $rule_in_effect = $currrules->{'default'};
1410: }
1411: }
1412: }
1413: } else {
1414: if (exists($currrules->{'default'})) {
1415: $rule_in_effect = $currrules->{'default'};
1416: }
1417: }
1418: } else {
1419: if ($currrules->{'_LC_external'} ne '') {
1420: $rule_in_effect = $currrules->{'_LC_external'};
1421: }
1422: }
1423: $offloadto = &get_loadbalancer_targets($rule_in_effect,$currtargets,
1424: $uname,$udom);
1425: }
1426: }
1427: } elsif (($homeintdom) && ($udom ne $serverhomedom)) {
1428: ($result,$cached)=&is_cached_new('loadbalancing',$serverhomedom);
1429: unless (defined($cached)) {
1430: my %domconfig =
1431: &Apache::lonnet::get_dom('configuration',['loadbalancing'],$serverhomedom);
1432: if (ref($domconfig{'loadbalancing'}) eq 'HASH') {
1433: $result = &do_cache_new('loadbalancing',$serverhomedom,$domconfig{'loadbalancing'},$cachetime);
1434: } else {
1435: $domneedscache = $serverhomedom;
1436: }
1437: }
1438: if (ref($result) eq 'HASH') {
1439: ($is_balancer,$currtargets,$currrules) =
1440: &check_balancer_result($result,@hosts);
1441: if ($is_balancer) {
1442: if (ref($currrules) eq 'HASH') {
1443: if ($currrules->{'_LC_internetdom'} ne '') {
1444: $rule_in_effect = $currrules->{'_LC_internetdom'};
1445: }
1446: }
1447: $offloadto = &get_loadbalancer_targets($rule_in_effect,$currtargets,
1448: $uname,$udom);
1449: }
1450: } else {
1451: if ($perlvar{'lonBalancer'} eq 'yes') {
1452: $is_balancer = 1;
1453: $offloadto = &this_host_spares($dom_in_use);
1454: }
1455: unless (defined($cached)) {
1456: $domneedscache = $serverhomedom;
1457: }
1458: }
1459: } else {
1460: if ($perlvar{'lonBalancer'} eq 'yes') {
1461: $is_balancer = 1;
1462: $offloadto = &this_host_spares($dom_in_use);
1463: }
1464: unless (defined($cached)) {
1465: $domneedscache = $serverhomedom;
1466: }
1467: }
1468: if ($domneedscache) {
1469: &do_cache_new('loadbalancing',$domneedscache,$is_balancer,$cachetime);
1470: }
1471: if ($is_balancer) {
1472: my $lowest_load = 30000;
1473: if (ref($offloadto) eq 'HASH') {
1474: if (ref($offloadto->{'primary'}) eq 'ARRAY') {
1475: foreach my $try_server (@{$offloadto->{'primary'}}) {
1476: ($otherserver,$lowest_load) =
1477: &compare_server_load($try_server,$otherserver,$lowest_load);
1478: }
1479: }
1480: my $found_server = ($otherserver ne '' && $lowest_load < 100);
1481:
1482: if (!$found_server) {
1483: if (ref($offloadto->{'default'}) eq 'ARRAY') {
1484: foreach my $try_server (@{$offloadto->{'default'}}) {
1485: ($otherserver,$lowest_load) =
1486: &compare_server_load($try_server,$otherserver,$lowest_load);
1487: }
1488: }
1489: }
1490: } elsif (ref($offloadto) eq 'ARRAY') {
1491: if (@{$offloadto} == 1) {
1492: $otherserver = $offloadto->[0];
1493: } elsif (@{$offloadto} > 1) {
1494: foreach my $try_server (@{$offloadto}) {
1495: ($otherserver,$lowest_load) =
1496: &compare_server_load($try_server,$otherserver,$lowest_load);
1497: }
1498: }
1499: }
1500: unless ($caller eq 'login') {
1501: if (($otherserver ne '') && (grep(/^\Q$otherserver\E$/,@hosts))) {
1502: $is_balancer = 0;
1503: if ($uname ne '' && $udom ne '') {
1504: if (($env{'user.name'} eq $uname) && ($env{'user.domain'} eq $udom)) {
1505:
1506: &appenv({'user.loadbalexempt' => $lonhost,
1507: 'user.loadbalcheck.time' => time});
1508: }
1509: }
1510: }
1511: }
1512: }
1513: return ($is_balancer,$otherserver);
1514: }
1515:
1516: sub check_balancer_result {
1517: my ($result,@hosts) = @_;
1518: my ($is_balancer,$currtargets,$currrules);
1519: if (ref($result) eq 'HASH') {
1520: if ($result->{'lonhost'} ne '') {
1521: my $currbalancer = $result->{'lonhost'};
1522: if (grep(/^\Q$currbalancer\E$/,@hosts)) {
1523: $is_balancer = 1;
1524: $currtargets = $result->{'targets'};
1525: $currrules = $result->{'rules'};
1526: }
1527: } else {
1528: foreach my $key (keys(%{$result})) {
1529: if (($key ne '') && (grep(/^\Q$key\E$/,@hosts)) &&
1530: (ref($result->{$key}) eq 'HASH')) {
1531: $is_balancer = 1;
1532: $currrules = $result->{$key}{'rules'};
1533: $currtargets = $result->{$key}{'targets'};
1534: last;
1535: }
1536: }
1537: }
1538: }
1539: return ($is_balancer,$currtargets,$currrules);
1540: }
1541:
1542: sub get_loadbalancer_targets {
1543: my ($rule_in_effect,$currtargets,$uname,$udom) = @_;
1544: my $offloadto;
1545: if ($rule_in_effect eq 'none') {
1546: return [$perlvar{'lonHostID'}];
1547: } elsif ($rule_in_effect eq '') {
1548: $offloadto = $currtargets;
1549: } else {
1550: if ($rule_in_effect eq 'homeserver') {
1551: my $homeserver = &homeserver($uname,$udom);
1552: if ($homeserver ne 'no_host') {
1553: $offloadto = [$homeserver];
1554: }
1555: } elsif ($rule_in_effect eq 'externalbalancer') {
1556: my %domconfig =
1557: &Apache::lonnet::get_dom('configuration',['loadbalancing'],$udom);
1558: if (ref($domconfig{'loadbalancing'}) eq 'HASH') {
1559: if ($domconfig{'loadbalancing'}{'lonhost'} ne '') {
1560: if (&hostname($domconfig{'loadbalancing'}{'lonhost'}) ne '') {
1561: $offloadto = [$domconfig{'loadbalancing'}{'lonhost'}];
1562: }
1563: }
1564: } else {
1565: my %servers = &internet_dom_servers($udom);
1566: my ($remotebalancer,$remotetargets) = &get_lonbalancer_config(\%servers);
1567: if (&hostname($remotebalancer) ne '') {
1568: $offloadto = [$remotebalancer];
1569: }
1570: }
1571: } elsif (&hostname($rule_in_effect) ne '') {
1572: $offloadto = [$rule_in_effect];
1573: }
1574: }
1575: return $offloadto;
1576: }
1577:
1578: sub internet_dom_servers {
1579: my ($dom) = @_;
1580: my (%uniqservers,%servers);
1581: my $primaryserver = &hostname(&domain($dom,'primary'));
1582: my @machinedoms = &machine_domains($primaryserver);
1583: foreach my $mdom (@machinedoms) {
1584: my %currservers = %servers;
1585: my %server = &get_servers($mdom);
1586: %servers = (%currservers,%server);
1587: }
1588: my %by_hostname;
1589: foreach my $id (keys(%servers)) {
1590: push(@{$by_hostname{$servers{$id}}},$id);
1591: }
1592: foreach my $hostname (sort(keys(%by_hostname))) {
1593: if (@{$by_hostname{$hostname}} > 1) {
1594: my $match = 0;
1595: foreach my $id (@{$by_hostname{$hostname}}) {
1596: if (&host_domain($id) eq $dom) {
1597: $uniqservers{$id} = $hostname;
1598: $match = 1;
1599: }
1600: }
1601: unless ($match) {
1602: $uniqservers{$by_hostname{$hostname}[0]} = $hostname;
1603: }
1604: } else {
1605: $uniqservers{$by_hostname{$hostname}[0]} = $hostname;
1606: }
1607: }
1608: return %uniqservers;
1609: }
1610:
1611: sub trusted_domains {
1612: my ($cmdtype,$calldom) = @_;
1613: my ($trusted,$untrusted);
1614: if (&domain($calldom) eq '') {
1615: return ($trusted,$untrusted);
1616: }
1617: unless ($cmdtype =~ /^(content|shared|enroll|coaurem|domroles|catalog|reqcrs|msg)$/) {
1618: return ($trusted,$untrusted);
1619: }
1620: my $callprimary = &domain($calldom,'primary');
1621: my $intcalldom = &Apache::lonnet::internet_dom($callprimary);
1622: if ($intcalldom eq '') {
1623: return ($trusted,$untrusted);
1624: }
1625:
1626: my ($trustconfig,$cached)=&Apache::lonnet::is_cached_new('trust',$calldom);
1627: unless (defined($cached)) {
1628: my %domconfig = &Apache::lonnet::get_dom('configuration',['trust'],$calldom);
1629: &Apache::lonnet::do_cache_new('trust',$calldom,$domconfig{'trust'},3600);
1630: $trustconfig = $domconfig{'trust'};
1631: }
1632: if (ref($trustconfig)) {
1633: my (%possexc,%possinc,@allexc,@allinc);
1634: if (ref($trustconfig->{$cmdtype}) eq 'HASH') {
1635: if (ref($trustconfig->{$cmdtype}->{'exc'}) eq 'ARRAY') {
1636: map { $possexc{$_} = 1; } @{$trustconfig->{$cmdtype}->{'exc'}};
1637: }
1638: if (ref($trustconfig->{$cmdtype}->{'inc'}) eq 'ARRAY') {
1639: map { $possinc{$_} = 1; } @{$trustconfig->{$cmdtype}->{'inc'}};
1640: }
1641: }
1642: if (keys(%possexc)) {
1643: if (keys(%possinc)) {
1644: foreach my $key (sort(keys(%possexc))) {
1645: next if ($key eq $intcalldom);
1646: unless ($possinc{$key}) {
1647: push(@allexc,$key);
1648: }
1649: }
1650: } else {
1651: @allexc = sort(keys(%possexc));
1652: }
1653: }
1654: if (keys(%possinc)) {
1655: $possinc{$intcalldom} = 1;
1656: @allinc = sort(keys(%possinc));
1657: }
1658: if ((@allexc > 0) || (@allinc > 0)) {
1659: my %doms_by_intdom;
1660: my %allintdoms = &all_host_intdom();
1661: my %alldoms = &all_host_domain();
1662: foreach my $key (%allintdoms) {
1663: if (ref($doms_by_intdom{$allintdoms{$key}}) eq 'ARRAY') {
1664: unless (grep(/^\Q$alldoms{$key}\E$/,@{$doms_by_intdom{$allintdoms{$key}}})) {
1665: push(@{$doms_by_intdom{$allintdoms{$key}}},$alldoms{$key});
1666: }
1667: } else {
1668: $doms_by_intdom{$allintdoms{$key}} = [$alldoms{$key}];
1669: }
1670: }
1671: foreach my $exc (@allexc) {
1672: if (ref($doms_by_intdom{$exc}) eq 'ARRAY') {
1673: $untrusted = $doms_by_intdom{$exc};
1674: }
1675: }
1676: foreach my $inc (@allinc) {
1677: if (ref($doms_by_intdom{$inc}) eq 'ARRAY') {
1678: $trusted = $doms_by_intdom{$inc};
1679: }
1680: }
1681: }
1682: }
1683: return ($trusted,$untrusted);
1684: }
1685:
1686: sub will_trust {
1687: my ($cmdtype,$domain,$possdom) = @_;
1688: return 1 if ($domain eq $possdom);
1689: my ($trustedref,$untrustedref) = &trusted_domains($cmdtype,$possdom);
1690: my $willtrust;
1691: if ((ref($trustedref) eq 'ARRAY') && (@{$trustedref} > 0)) {
1692: if (grep(/^\Q$domain\E$/,@{$trustedref})) {
1693: $willtrust = 1;
1694: }
1695: } elsif ((ref($untrustedref) eq 'ARRAY') && (@{$untrustedref} > 0)) {
1696: unless (grep(/^\Q$domain\E$/,@{$untrustedref})) {
1697: $willtrust = 1;
1698: }
1699: } else {
1700: $willtrust = 1;
1701: }
1702: return $willtrust;
1703: }
1704:
1705: # ---------------------- Find the homebase for a user from domain's lib servers
1706:
1707: my %homecache;
1708: sub homeserver {
1709: my ($uname,$udom,$ignoreBadCache)=@_;
1710: my $index="$uname:$udom";
1711:
1712: if (exists($homecache{$index})) { return $homecache{$index}; }
1713:
1714: my %servers = &get_servers($udom,'library');
1715: foreach my $tryserver (keys(%servers)) {
1716: next if ($ignoreBadCache ne 'true' &&
1717: exists($badServerCache{$tryserver}));
1718:
1719: my $answer=reply("home:$udom:$uname",$tryserver);
1720: if ($answer eq 'found') {
1721: delete($badServerCache{$tryserver});
1722: return $homecache{$index}=$tryserver;
1723: } elsif ($answer eq 'no_host') {
1724: $badServerCache{$tryserver}=1;
1725: }
1726: }
1727: return 'no_host';
1728: }
1729:
1730: # ----- Find the usernames behind a list of student/employee IDs or clicker IDs
1731:
1732: sub idget {
1733: my ($udom,$idsref,$namespace)=@_;
1734: my %returnhash=();
1735: my @ids=();
1736: if (ref($idsref) eq 'ARRAY') {
1737: @ids = @{$idsref};
1738: } else {
1739: return %returnhash;
1740: }
1741: if ($namespace eq '') {
1742: $namespace = 'ids';
1743: }
1744:
1745: my %servers = &get_servers($udom,'library');
1746: foreach my $tryserver (keys(%servers)) {
1747: my $idlist=join('&', map { &escape($_); } @ids);
1748: if ($namespace eq 'ids') {
1749: $idlist=~tr/A-Z/a-z/;
1750: }
1751: my $reply;
1752: if ($namespace eq 'ids') {
1753: $reply=&reply("idget:$udom:".$idlist,$tryserver);
1754: } else {
1755: $reply=&reply("getdom:$udom:$namespace:$idlist",$tryserver);
1756: }
1757: my @answer=();
1758: if (($reply ne 'con_lost') && ($reply!~/^error\:/)) {
1759: @answer=split(/\&/,$reply);
1760: } ;
1761: my $i;
1762: for ($i=0;$i<=$#ids;$i++) {
1763: if ($answer[$i]) {
1764: $returnhash{$ids[$i]}=&unescape($answer[$i]);
1765: }
1766: }
1767: }
1768: return %returnhash;
1769: }
1770:
1771: # ------------------------------------- Find the IDs behind a list of usernames
1772:
1773: sub idrget {
1774: my ($udom,@unames)=@_;
1775: my %returnhash=();
1776: foreach my $uname (@unames) {
1777: $returnhash{$uname}=(&userenvironment($udom,$uname,'id'))[1];
1778: }
1779: return %returnhash;
1780: }
1781:
1782: # Store away a list of names and associated student/employee IDs or clicker IDs
1783:
1784: sub idput {
1785: my ($udom,$idsref,$uhom,$namespace)=@_;
1786: my %servers=();
1787: my %ids=();
1788: my %byid = ();
1789: if (ref($idsref) eq 'HASH') {
1790: %ids=%{$idsref};
1791: }
1792: if ($namespace eq '') {
1793: $namespace = 'ids';
1794: }
1795: foreach my $uname (keys(%ids)) {
1796: &cput('environment',{'id'=>$ids{$uname}},$udom,$uname);
1797: if ($uhom eq '') {
1798: $uhom=&homeserver($uname,$udom);
1799: }
1800: if ($uhom ne 'no_host') {
1801: my $esc_unam=&escape($uname);
1802: if ($namespace eq 'ids') {
1803: my $id=&escape($ids{$uname});
1804: $id=~tr/A-Z/a-z/;
1805: my $esc_unam=&escape($uname);
1806: $servers{$uhom}.=$id.'='.$esc_unam.'&';
1807: } else {
1808: my @currids = split(/,/,$ids{$uname});
1809: foreach my $id (@currids) {
1810: $byid{$uhom}{$id} .= $uname.',';
1811: }
1812: }
1813: }
1814: }
1815: if ($namespace eq 'clickers') {
1816: foreach my $server (keys(%byid)) {
1817: if (ref($byid{$server}) eq 'HASH') {
1818: foreach my $id (keys(%{$byid{$server}})) {
1819: $byid{$server} =~ s/,$//;
1820: $servers{$uhom}.=&escape($id).'='.&escape($byid{$server}).'&';
1821: }
1822: }
1823: }
1824: }
1825: foreach my $server (keys(%servers)) {
1826: $servers{$server} =~ s/\&$//;
1827: if ($namespace eq 'ids') {
1828: &critical('idput:'.$udom.':'.$servers{$server},$server);
1829: } else {
1830: &critical('updateclickers:'.$udom.':add:'.$servers{$server},$server);
1831: }
1832: }
1833: }
1834:
1835: # ------------- Delete unwanted student/employee IDs or clicker IDs from domain
1836:
1837: sub iddel {
1838: my ($udom,$idshashref,$uhome,$namespace)=@_;
1839: my %result=();
1840: my %ids=();
1841: my %byid = ();
1842: if (ref($idshashref) eq 'HASH') {
1843: %ids=%{$idshashref};
1844: } else {
1845: return %result;
1846: }
1847: if ($namespace eq '') {
1848: $namespace = 'ids';
1849: }
1850: my %servers=();
1851: while (my ($id,$unamestr) = each(%ids)) {
1852: if ($namespace eq 'ids') {
1853: my $uhom = $uhome;
1854: if ($uhom eq '') {
1855: $uhom=&homeserver($unamestr,$udom);
1856: }
1857: if ($uhom ne 'no_host') {
1858: $servers{$uhom}.='&'.&escape($id);
1859: }
1860: } else {
1861: my @curritems = split(/,/,$ids{$id});
1862: foreach my $uname (@curritems) {
1863: my $uhom = $uhome;
1864: if ($uhom eq '') {
1865: $uhom=&homeserver($uname,$udom);
1866: }
1867: if ($uhom ne 'no_host') {
1868: $byid{$uhom}{$id} .= $uname.',';
1869: }
1870: }
1871: }
1872: }
1873: if ($namespace eq 'clickers') {
1874: foreach my $server (keys(%byid)) {
1875: if (ref($byid{$server}) eq 'HASH') {
1876: foreach my $id (keys(%{$byid{$server}})) {
1877: $byid{$server}{$id} =~ s/,$//;
1878: $servers{$server}.=&escape($id).'='.&escape($byid{$server}{$id}).'&';
1879: }
1880: }
1881: }
1882: }
1883: foreach my $server (keys(%servers)) {
1884: $servers{$server} =~ s/\&$//;
1885: if ($namespace eq 'ids') {
1886: $result{$server} = &critical('iddel:'.$udom.':'.$servers{$server},$uhome);
1887: } elsif ($namespace eq 'clickers') {
1888: $result{$server} = &critical('updateclickers:'.$udom.':del:'.$servers{$server},$server);
1889: }
1890: }
1891: return %result;
1892: }
1893:
1894: # ----- Update clicker ID-to-username look-ups in clickers.db on library server
1895:
1896: sub updateclickers {
1897: my ($udom,$action,$idshashref,$uhome,$critical) = @_;
1898: my %clickers;
1899: if (ref($idshashref) eq 'HASH') {
1900: %clickers=%{$idshashref};
1901: } else {
1902: return;
1903: }
1904: my $items='';
1905: foreach my $item (keys(%clickers)) {
1906: $items.=&escape($item).'='.&escape($clickers{$item}).'&';
1907: }
1908: $items=~s/\&$//;
1909: my $request = "updateclickers:$udom:$action:$items";
1910: if ($critical) {
1911: return &critical($request,$uhome);
1912: } else {
1913: return &reply($request,$uhome);
1914: }
1915: }
1916:
1917: # ------------------------------dump from db file owned by domainconfig user
1918: sub dump_dom {
1919: my ($namespace, $udom, $regexp) = @_;
1920:
1921: $udom ||= $env{'user.domain'};
1922:
1923: return () unless $udom;
1924:
1925: return &dump($namespace, $udom, &get_domainconfiguser($udom), $regexp);
1926: }
1927:
1928: # ------------------------------------------ get items from domain db files
1929:
1930: sub get_dom {
1931: my ($namespace,$storearr,$udom,$uhome)=@_;
1932: return if ($udom eq 'public');
1933: my $items='';
1934: foreach my $item (@$storearr) {
1935: $items.=&escape($item).'&';
1936: }
1937: $items=~s/\&$//;
1938: if (!$udom) {
1939: $udom=$env{'user.domain'};
1940: return if ($udom eq 'public');
1941: if (defined(&domain($udom,'primary'))) {
1942: $uhome=&domain($udom,'primary');
1943: } else {
1944: undef($uhome);
1945: }
1946: } else {
1947: if (!$uhome) {
1948: if (defined(&domain($udom,'primary'))) {
1949: $uhome=&domain($udom,'primary');
1950: }
1951: }
1952: }
1953: if ($udom && $uhome && ($uhome ne 'no_host')) {
1954: my $rep;
1955: if ($namespace =~ /^enc/) {
1956: $rep=&reply("encrypt:egetdom:$udom:$namespace:$items",$uhome);
1957: } else {
1958: $rep=&reply("getdom:$udom:$namespace:$items",$uhome);
1959: }
1960: my %returnhash;
1961: if ($rep eq '' || $rep =~ /^error: 2 /) {
1962: return %returnhash;
1963: }
1964: my @pairs=split(/\&/,$rep);
1965: if ( $#pairs==0 && $pairs[0] =~ /^(con_lost|error|no_such_host)/i) {
1966: return @pairs;
1967: }
1968: my $i=0;
1969: foreach my $item (@$storearr) {
1970: $returnhash{$item}=&thaw_unescape($pairs[$i]);
1971: $i++;
1972: }
1973: return %returnhash;
1974: } else {
1975: &logthis("get_dom failed - no homeserver and/or domain ($udom) ($uhome)");
1976: }
1977: }
1978:
1979: # -------------------------------------------- put items in domain db files
1980:
1981: sub put_dom {
1982: my ($namespace,$storehash,$udom,$uhome)=@_;
1983: if (!$udom) {
1984: $udom=$env{'user.domain'};
1985: if (defined(&domain($udom,'primary'))) {
1986: $uhome=&domain($udom,'primary');
1987: } else {
1988: undef($uhome);
1989: }
1990: } else {
1991: if (!$uhome) {
1992: if (defined(&domain($udom,'primary'))) {
1993: $uhome=&domain($udom,'primary');
1994: }
1995: }
1996: }
1997: if ($udom && $uhome && ($uhome ne 'no_host')) {
1998: my $items='';
1999: foreach my $item (keys(%$storehash)) {
2000: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
2001: }
2002: $items=~s/\&$//;
2003: if ($namespace =~ /^enc/) {
2004: return &reply("encrypt:putdom:$udom:$namespace:$items",$uhome);
2005: } else {
2006: return &reply("putdom:$udom:$namespace:$items",$uhome);
2007: }
2008: } else {
2009: &logthis("put_dom failed - no homeserver and/or domain");
2010: }
2011: }
2012:
2013: # --------------------- newput for items in db file owned by domainconfig user
2014: sub newput_dom {
2015: my ($namespace,$storehash,$udom) = @_;
2016: my $result;
2017: if (!$udom) {
2018: $udom=$env{'user.domain'};
2019: }
2020: if ($udom) {
2021: my $uname = &get_domainconfiguser($udom);
2022: $result = &newput($namespace,$storehash,$udom,$uname);
2023: }
2024: return $result;
2025: }
2026:
2027: # --------------------- delete for items in db file owned by domainconfig user
2028: sub del_dom {
2029: my ($namespace,$storearr,$udom)=@_;
2030: if (ref($storearr) eq 'ARRAY') {
2031: if (!$udom) {
2032: $udom=$env{'user.domain'};
2033: }
2034: if ($udom) {
2035: my $uname = &get_domainconfiguser($udom);
2036: return &del($namespace,$storearr,$udom,$uname);
2037: }
2038: }
2039: }
2040:
2041: # ----------------------------------construct domainconfig user for a domain
2042: sub get_domainconfiguser {
2043: my ($udom) = @_;
2044: return $udom.'-domainconfig';
2045: }
2046:
2047: sub retrieve_inst_usertypes {
2048: my ($udom) = @_;
2049: my (%returnhash,@order);
2050: my %domdefs = &Apache::lonnet::get_domain_defaults($udom);
2051: if ((ref($domdefs{'inststatustypes'}) eq 'HASH') &&
2052: (ref($domdefs{'inststatusorder'}) eq 'ARRAY')) {
2053: return ($domdefs{'inststatustypes'},$domdefs{'inststatusorder'});
2054: } else {
2055: if (defined(&domain($udom,'primary'))) {
2056: my $uhome=&domain($udom,'primary');
2057: my $rep=&reply("inst_usertypes:$udom",$uhome);
2058: if ($rep =~ /^(con_lost|error|no_such_host|refused)/) {
2059: &logthis("retrieve_inst_usertypes failed - $rep returned from $uhome in domain: $udom");
2060: return (\%returnhash,\@order);
2061: }
2062: my ($hashitems,$orderitems) = split(/:/,$rep);
2063: my @pairs=split(/\&/,$hashitems);
2064: foreach my $item (@pairs) {
2065: my ($key,$value)=split(/=/,$item,2);
2066: $key = &unescape($key);
2067: next if ($key =~ /^error: 2 /);
2068: $returnhash{$key}=&thaw_unescape($value);
2069: }
2070: my @esc_order = split(/\&/,$orderitems);
2071: foreach my $item (@esc_order) {
2072: push(@order,&unescape($item));
2073: }
2074: } else {
2075: &logthis("retrieve_inst_usertypes failed - no primary domain server for $udom");
2076: }
2077: return (\%returnhash,\@order);
2078: }
2079: }
2080:
2081: sub is_domainimage {
2082: my ($url) = @_;
2083: if ($url=~m-^/+res/+($match_domain)/+\1\-domainconfig/+(img|logo|domlogo)/+[^/]-) {
2084: if (&domain($1) ne '') {
2085: return '1';
2086: }
2087: }
2088: return;
2089: }
2090:
2091: sub inst_directory_query {
2092: my ($srch) = @_;
2093: my $udom = $srch->{'srchdomain'};
2094: my %results;
2095: my $homeserver = &domain($udom,'primary');
2096: my $outcome;
2097: if ($homeserver ne '') {
2098: unless ($homeserver eq $perlvar{'lonHostID'}) {
2099: if ($srch->{'srchby'} eq 'email') {
2100: my $lcrev = &get_server_loncaparev(undef,$homeserver);
2101: my ($major,$minor) = ($lcrev =~ /^\'?(\d+)\.(\d+)\.[\w.\-]+\'?$/);
2102: if (($major eq '' && $minor eq '') || ($major < 2) ||
2103: (($major == 2) && ($minor < 12))) {
2104: return;
2105: }
2106: }
2107: }
2108: my $queryid=&reply("querysend:instdirsearch:".
2109: &escape($srch->{'srchby'}).':'.
2110: &escape($srch->{'srchterm'}).':'.
2111: &escape($srch->{'srchtype'}),$homeserver);
2112: my $host=&hostname($homeserver);
2113: if ($queryid !~/^\Q$host\E\_/) {
2114: &logthis('institutional directory search invalid queryid: '.$queryid.' for host: '.$homeserver.' in domain '.$udom);
2115: return;
2116: }
2117: my $response = &get_query_reply($queryid);
2118: my $maxtries = 5;
2119: my $tries = 1;
2120: while (($response=~/^timeout/) && ($tries < $maxtries)) {
2121: $response = &get_query_reply($queryid);
2122: $tries ++;
2123: }
2124:
2125: if (!&error($response) && $response ne 'refused') {
2126: if ($response eq 'unavailable') {
2127: $outcome = $response;
2128: } else {
2129: $outcome = 'ok';
2130: my @matches = split(/\n/,$response);
2131: foreach my $match (@matches) {
2132: my ($key,$value) = split(/=/,$match);
2133: $results{&unescape($key).':'.$udom} = &thaw_unescape($value);
2134: }
2135: }
2136: }
2137: }
2138: return ($outcome,%results);
2139: }
2140:
2141: sub usersearch {
2142: my ($srch) = @_;
2143: my $dom = $srch->{'srchdomain'};
2144: my %results;
2145: my %libserv = &all_library();
2146: my $query = 'usersearch';
2147: foreach my $tryserver (keys(%libserv)) {
2148: if (&host_domain($tryserver) eq $dom) {
2149: unless ($tryserver eq $perlvar{'lonHostID'}) {
2150: if ($srch->{'srchby'} eq 'email') {
2151: my $lcrev = &get_server_loncaparev(undef,$tryserver);
2152: my ($major,$minor) = ($lcrev =~ /^\'?(\d+)\.(\d+)\.[\w.\-]+\'?$/);
2153: next if (($major eq '' && $minor eq '') || ($major < 2) ||
2154: (($major == 2) && ($minor < 12)));
2155: }
2156: }
2157: my $host=&hostname($tryserver);
2158: my $queryid=
2159: &reply("querysend:".&escape($query).':'.
2160: &escape($srch->{'srchby'}).':'.
2161: &escape($srch->{'srchtype'}).':'.
2162: &escape($srch->{'srchterm'}),$tryserver);
2163: if ($queryid !~/^\Q$host\E\_/) {
2164: &logthis('usersearch: invalid queryid: '.$queryid.' for host: '.$host.'in domain '.$dom.' and server: '.$tryserver);
2165: next;
2166: }
2167: my $reply = &get_query_reply($queryid);
2168: my $maxtries = 1;
2169: my $tries = 1;
2170: while (($reply=~/^timeout/) && ($tries < $maxtries)) {
2171: $reply = &get_query_reply($queryid);
2172: $tries ++;
2173: }
2174: if ( ($reply =~/^timeout/) || ($reply =~/^error/) ) {
2175: &logthis('usersrch error: '.$reply.' for '.$dom.' - searching for : '.$srch->{'srchterm'}.' by '.$srch->{'srchby'}.' ('.$srch->{'srchtype'}.') - maxtries: '.$maxtries.' tries: '.$tries);
2176: } else {
2177: my @matches;
2178: if ($reply =~ /\n/) {
2179: @matches = split(/\n/,$reply);
2180: } else {
2181: @matches = split(/\&/,$reply);
2182: }
2183: foreach my $match (@matches) {
2184: my ($uname,$udom,%userhash);
2185: foreach my $entry (split(/:/,$match)) {
2186: my ($key,$value) =
2187: map {&unescape($_);} split(/=/,$entry);
2188: $userhash{$key} = $value;
2189: if ($key eq 'username') {
2190: $uname = $value;
2191: } elsif ($key eq 'domain') {
2192: $udom = $value;
2193: }
2194: }
2195: $results{$uname.':'.$udom} = \%userhash;
2196: }
2197: }
2198: }
2199: }
2200: return %results;
2201: }
2202:
2203: sub get_instuser {
2204: my ($udom,$uname,$id) = @_;
2205: my $homeserver = &domain($udom,'primary');
2206: my ($outcome,%results);
2207: if ($homeserver ne '') {
2208: my $queryid=&reply("querysend:getinstuser:".&escape($uname).':'.
2209: &escape($id).':'.&escape($udom),$homeserver);
2210: my $host=&hostname($homeserver);
2211: if ($queryid !~/^\Q$host\E\_/) {
2212: &logthis('get_instuser invalid queryid: '.$queryid.' for host: '.$homeserver.'in domain '.$udom);
2213: return;
2214: }
2215: my $response = &get_query_reply($queryid);
2216: my $maxtries = 5;
2217: my $tries = 1;
2218: while (($response=~/^timeout/) && ($tries < $maxtries)) {
2219: $response = &get_query_reply($queryid);
2220: $tries ++;
2221: }
2222: if (!&error($response) && $response ne 'refused') {
2223: if ($response eq 'unavailable') {
2224: $outcome = $response;
2225: } else {
2226: $outcome = 'ok';
2227: my @matches = split(/\n/,$response);
2228: foreach my $match (@matches) {
2229: my ($key,$value) = split(/=/,$match);
2230: $results{&unescape($key)} = &thaw_unescape($value);
2231: }
2232: }
2233: }
2234: }
2235: my %userinfo;
2236: if (ref($results{$uname}) eq 'HASH') {
2237: %userinfo = %{$results{$uname}};
2238: }
2239: return ($outcome,%userinfo);
2240: }
2241:
2242: sub get_multiple_instusers {
2243: my ($udom,$users,$caller) = @_;
2244: my ($outcome,$results);
2245: if (ref($users) eq 'HASH') {
2246: my $count = keys(%{$users});
2247: my $requested = &freeze_escape($users);
2248: my $homeserver = &domain($udom,'primary');
2249: if ($homeserver ne '') {
2250: my $queryid=&reply('querysend:getmultinstusers:::'.$caller.'='.$requested,$homeserver);
2251: my $host=&hostname($homeserver);
2252: if ($queryid !~/^\Q$host\E\_/) {
2253: &logthis('get_multiple_instusers invalid queryid: '.$queryid.
2254: ' for host: '.$homeserver.'in domain '.$udom);
2255: return ($outcome,$results);
2256: }
2257: my $response = &get_query_reply($queryid);
2258: my $maxtries = 5;
2259: if ($count > 100) {
2260: $maxtries = 1+int($count/20);
2261: }
2262: my $tries = 1;
2263: while (($response=~/^timeout/) && ($tries <= $maxtries)) {
2264: $response = &get_query_reply($queryid);
2265: $tries ++;
2266: }
2267: if ($response eq '') {
2268: $results = {};
2269: foreach my $key (keys(%{$users})) {
2270: my ($uname,$id);
2271: if ($caller eq 'id') {
2272: $id = $key;
2273: } else {
2274: $uname = $key;
2275: }
2276: my ($resp,%info) = &get_instuser($udom,$uname,$id);
2277: $outcome = $resp;
2278: if ($resp eq 'ok') {
2279: %{$results} = (%{$results}, %info);
2280: } else {
2281: last;
2282: }
2283: }
2284: } elsif(!&error($response) && ($response ne 'refused')) {
2285: if (($response eq 'unavailable') || ($response eq 'invalid') || ($response eq 'timeout')) {
2286: $outcome = $response;
2287: } else {
2288: ($outcome,my $userdata) = split(/=/,$response,2);
2289: if ($outcome eq 'ok') {
2290: $results = &thaw_unescape($userdata);
2291: }
2292: }
2293: }
2294: }
2295: }
2296: return ($outcome,$results);
2297: }
2298:
2299: sub inst_rulecheck {
2300: my ($udom,$uname,$id,$item,$rules) = @_;
2301: my %returnhash;
2302: if ($udom ne '') {
2303: if (ref($rules) eq 'ARRAY') {
2304: @{$rules} = map {&escape($_);} (@{$rules});
2305: my $rulestr = join(':',@{$rules});
2306: my $homeserver=&domain($udom,'primary');
2307: if (($homeserver ne '') && ($homeserver ne 'no_host')) {
2308: my $response;
2309: if ($item eq 'username') {
2310: $response=&unescape(&reply('instrulecheck:'.&escape($udom).
2311: ':'.&escape($uname).':'.$rulestr,
2312: $homeserver));
2313: } elsif ($item eq 'id') {
2314: $response=&unescape(&reply('instidrulecheck:'.&escape($udom).
2315: ':'.&escape($id).':'.$rulestr,
2316: $homeserver));
2317: } elsif ($item eq 'selfcreate') {
2318: $response=&unescape(&reply('instselfcreatecheck:'.
2319: &escape($udom).':'.&escape($uname).
2320: ':'.$rulestr,$homeserver));
2321: }
2322: if ($response ne 'refused') {
2323: my @pairs=split(/\&/,$response);
2324: foreach my $item (@pairs) {
2325: my ($key,$value)=split(/=/,$item,2);
2326: $key = &unescape($key);
2327: next if ($key =~ /^error: 2 /);
2328: $returnhash{$key}=&thaw_unescape($value);
2329: }
2330: }
2331: }
2332: }
2333: }
2334: return %returnhash;
2335: }
2336:
2337: sub inst_userrules {
2338: my ($udom,$check) = @_;
2339: my (%ruleshash,@ruleorder);
2340: if ($udom ne '') {
2341: my $homeserver=&domain($udom,'primary');
2342: if (($homeserver ne '') && ($homeserver ne 'no_host')) {
2343: my $response;
2344: if ($check eq 'id') {
2345: $response=&reply('instidrules:'.&escape($udom),
2346: $homeserver);
2347: } elsif ($check eq 'email') {
2348: $response=&reply('instemailrules:'.&escape($udom),
2349: $homeserver);
2350: } else {
2351: $response=&reply('instuserrules:'.&escape($udom),
2352: $homeserver);
2353: }
2354: if (($response ne 'refused') && ($response ne 'error') &&
2355: ($response ne 'unknown_cmd') &&
2356: ($response ne 'no_such_host')) {
2357: my ($hashitems,$orderitems) = split(/:/,$response);
2358: my @pairs=split(/\&/,$hashitems);
2359: foreach my $item (@pairs) {
2360: my ($key,$value)=split(/=/,$item,2);
2361: $key = &unescape($key);
2362: next if ($key =~ /^error: 2 /);
2363: $ruleshash{$key}=&thaw_unescape($value);
2364: }
2365: my @esc_order = split(/\&/,$orderitems);
2366: foreach my $item (@esc_order) {
2367: push(@ruleorder,&unescape($item));
2368: }
2369: }
2370: }
2371: }
2372: return (\%ruleshash,\@ruleorder);
2373: }
2374:
2375: # ------------- Get Authentication, Language and User Tools Defaults for Domain
2376:
2377: sub get_domain_defaults {
2378: my ($domain,$ignore_cache) = @_;
2379: return if (($domain eq '') || ($domain eq 'public'));
2380: my $cachetime = 60*60*24;
2381: unless ($ignore_cache) {
2382: my ($result,$cached)=&is_cached_new('domdefaults',$domain);
2383: if (defined($cached)) {
2384: if (ref($result) eq 'HASH') {
2385: return %{$result};
2386: }
2387: }
2388: }
2389: my %domdefaults;
2390: my %domconfig =
2391: &Apache::lonnet::get_dom('configuration',['defaults','quotas',
2392: 'requestcourses','inststatus',
2393: 'coursedefaults','usersessions',
2394: 'requestauthor','selfenrollment',
2395: 'coursecategories','ssl','autoenroll',
2396: 'trust','helpsettings'],$domain);
2397: my @coursetypes = ('official','unofficial','community','textbook','placement');
2398: if (ref($domconfig{'defaults'}) eq 'HASH') {
2399: $domdefaults{'lang_def'} = $domconfig{'defaults'}{'lang_def'};
2400: $domdefaults{'auth_def'} = $domconfig{'defaults'}{'auth_def'};
2401: $domdefaults{'auth_arg_def'} = $domconfig{'defaults'}{'auth_arg_def'};
2402: $domdefaults{'timezone_def'} = $domconfig{'defaults'}{'timezone_def'};
2403: $domdefaults{'datelocale_def'} = $domconfig{'defaults'}{'datelocale_def'};
2404: $domdefaults{'portal_def'} = $domconfig{'defaults'}{'portal_def'};
2405: $domdefaults{'intauth_cost'} = $domconfig{'defaults'}{'intauth_cost'};
2406: $domdefaults{'intauth_switch'} = $domconfig{'defaults'}{'intauth_switch'};
2407: $domdefaults{'intauth_check'} = $domconfig{'defaults'}{'intauth_check'};
2408: } else {
2409: $domdefaults{'lang_def'} = &domain($domain,'lang_def');
2410: $domdefaults{'auth_def'} = &domain($domain,'auth_def');
2411: $domdefaults{'auth_arg_def'} = &domain($domain,'auth_arg_def');
2412: }
2413: if (ref($domconfig{'quotas'}) eq 'HASH') {
2414: if (ref($domconfig{'quotas'}{'defaultquota'}) eq 'HASH') {
2415: $domdefaults{'defaultquota'} = $domconfig{'quotas'}{'defaultquota'};
2416: } else {
2417: $domdefaults{'defaultquota'} = $domconfig{'quotas'};
2418: }
2419: my @usertools = ('aboutme','blog','webdav','portfolio');
2420: foreach my $item (@usertools) {
2421: if (ref($domconfig{'quotas'}{$item}) eq 'HASH') {
2422: $domdefaults{$item} = $domconfig{'quotas'}{$item};
2423: }
2424: }
2425: if (ref($domconfig{'quotas'}{'authorquota'}) eq 'HASH') {
2426: $domdefaults{'authorquota'} = $domconfig{'quotas'}{'authorquota'};
2427: }
2428: }
2429: if (ref($domconfig{'requestcourses'}) eq 'HASH') {
2430: foreach my $item ('official','unofficial','community','textbook','placement') {
2431: $domdefaults{$item} = $domconfig{'requestcourses'}{$item};
2432: }
2433: }
2434: if (ref($domconfig{'requestauthor'}) eq 'HASH') {
2435: $domdefaults{'requestauthor'} = $domconfig{'requestauthor'};
2436: }
2437: if (ref($domconfig{'inststatus'}) eq 'HASH') {
2438: foreach my $item ('inststatustypes','inststatusorder','inststatusguest') {
2439: $domdefaults{$item} = $domconfig{'inststatus'}{$item};
2440: }
2441: }
2442: if (ref($domconfig{'coursedefaults'}) eq 'HASH') {
2443: $domdefaults{'canuse_pdfforms'} = $domconfig{'coursedefaults'}{'canuse_pdfforms'};
2444: $domdefaults{'usejsme'} = $domconfig{'coursedefaults'}{'usejsme'};
2445: $domdefaults{'uselcmath'} = $domconfig{'coursedefaults'}{'uselcmath'};
2446: if (ref($domconfig{'coursedefaults'}{'postsubmit'}) eq 'HASH') {
2447: $domdefaults{'postsubmit'} = $domconfig{'coursedefaults'}{'postsubmit'}{'client'};
2448: }
2449: foreach my $type (@coursetypes) {
2450: if (ref($domconfig{'coursedefaults'}{'coursecredits'}) eq 'HASH') {
2451: unless ($type eq 'community') {
2452: $domdefaults{$type.'credits'} = $domconfig{'coursedefaults'}{'coursecredits'}{$type};
2453: }
2454: }
2455: if (ref($domconfig{'coursedefaults'}{'uploadquota'}) eq 'HASH') {
2456: $domdefaults{$type.'quota'} = $domconfig{'coursedefaults'}{'uploadquota'}{$type};
2457: }
2458: if ($domdefaults{'postsubmit'} eq 'on') {
2459: if (ref($domconfig{'coursedefaults'}{'postsubmit'}{'timeout'}) eq 'HASH') {
2460: $domdefaults{$type.'postsubtimeout'} =
2461: $domconfig{'coursedefaults'}{'postsubmit'}{'timeout'}{$type};
2462: }
2463: }
2464: }
2465: if (ref($domconfig{'coursedefaults'}{'canclone'}) eq 'HASH') {
2466: if (ref($domconfig{'coursedefaults'}{'canclone'}{'instcode'}) eq 'ARRAY') {
2467: my @clonecodes = @{$domconfig{'coursedefaults'}{'canclone'}{'instcode'}};
2468: if (@clonecodes) {
2469: $domdefaults{'canclone'} = join('+',@clonecodes);
2470: }
2471: }
2472: } elsif ($domconfig{'coursedefaults'}{'canclone'}) {
2473: $domdefaults{'canclone'}=$domconfig{'coursedefaults'}{'canclone'};
2474: }
2475: if ($domconfig{'coursedefaults'}{'texengine'}) {
2476: $domdefaults{'texengine'} = $domconfig{'coursedefaults'}{'texengine'};
2477: }
2478: }
2479: if (ref($domconfig{'usersessions'}) eq 'HASH') {
2480: if (ref($domconfig{'usersessions'}{'remote'}) eq 'HASH') {
2481: $domdefaults{'remotesessions'} = $domconfig{'usersessions'}{'remote'};
2482: }
2483: if (ref($domconfig{'usersessions'}{'hosted'}) eq 'HASH') {
2484: $domdefaults{'hostedsessions'} = $domconfig{'usersessions'}{'hosted'};
2485: }
2486: if (ref($domconfig{'usersessions'}{'offloadnow'}) eq 'HASH') {
2487: $domdefaults{'offloadnow'} = $domconfig{'usersessions'}{'offloadnow'};
2488: }
2489: }
2490: if (ref($domconfig{'selfenrollment'}) eq 'HASH') {
2491: if (ref($domconfig{'selfenrollment'}{'admin'}) eq 'HASH') {
2492: my @settings = ('types','registered','enroll_dates','access_dates','section',
2493: 'approval','limit');
2494: foreach my $type (@coursetypes) {
2495: if (ref($domconfig{'selfenrollment'}{'admin'}{$type}) eq 'HASH') {
2496: my @mgrdc = ();
2497: foreach my $item (@settings) {
2498: if ($domconfig{'selfenrollment'}{'admin'}{$type}{$item} eq '0') {
2499: push(@mgrdc,$item);
2500: }
2501: }
2502: if (@mgrdc) {
2503: $domdefaults{$type.'selfenrolladmdc'} = join(',',@mgrdc);
2504: }
2505: }
2506: }
2507: }
2508: if (ref($domconfig{'selfenrollment'}{'default'}) eq 'HASH') {
2509: foreach my $type (@coursetypes) {
2510: if (ref($domconfig{'selfenrollment'}{'default'}{$type}) eq 'HASH') {
2511: foreach my $item (keys(%{$domconfig{'selfenrollment'}{'default'}{$type}})) {
2512: $domdefaults{$type.'selfenroll'.$item} = $domconfig{'selfenrollment'}{'default'}{$type}{$item};
2513: }
2514: }
2515: }
2516: }
2517: }
2518: if (ref($domconfig{'coursecategories'}) eq 'HASH') {
2519: $domdefaults{'catauth'} = 'std';
2520: $domdefaults{'catunauth'} = 'std';
2521: if ($domconfig{'coursecategories'}{'auth'}) {
2522: $domdefaults{'catauth'} = $domconfig{'coursecategories'}{'auth'};
2523: }
2524: if ($domconfig{'coursecategories'}{'unauth'}) {
2525: $domdefaults{'catunauth'} = $domconfig{'coursecategories'}{'unauth'};
2526: }
2527: }
2528: if (ref($domconfig{'ssl'}) eq 'HASH') {
2529: if (ref($domconfig{'ssl'}{'replication'}) eq 'HASH') {
2530: $domdefaults{'replication'} = $domconfig{'ssl'}{'replication'};
2531: }
2532: if (ref($domconfig{'ssl'}{'connto'}) eq 'HASH') {
2533: $domdefaults{'connect'} = $domconfig{'ssl'}{'connto'};
2534: }
2535: if (ref($domconfig{'ssl'}{'connfrom'}) eq 'HASH') {
2536: $domdefaults{'connect'} = $domconfig{'ssl'}{'connfrom'};
2537: }
2538: }
2539: if (ref($domconfig{'trust'}) eq 'HASH') {
2540: my @prefixes = qw(content shared enroll othcoau coaurem domroles catalog reqcrs msg);
2541: foreach my $prefix (@prefixes) {
2542: if (ref($domconfig{'trust'}{$prefix}) eq 'HASH') {
2543: $domdefaults{'trust'.$prefix} = $domconfig{'trust'}{$prefix};
2544: }
2545: }
2546: }
2547: if (ref($domconfig{'autoenroll'}) eq 'HASH') {
2548: $domdefaults{'autofailsafe'} = $domconfig{'autoenroll'}{'autofailsafe'};
2549: }
2550: if (ref($domconfig{'helpsettings'}) eq 'HASH') {
2551: $domdefaults{'submitbugs'} = $domconfig{'helpsettings'}{'submitbugs'};
2552: if (ref($domconfig{'helpsettings'}{'adhoc'}) eq 'HASH') {
2553: $domdefaults{'adhocroles'} = $domconfig{'helpsettings'}{'adhoc'};
2554: }
2555: }
2556: &do_cache_new('domdefaults',$domain,\%domdefaults,$cachetime);
2557: return %domdefaults;
2558: }
2559:
2560: sub course_portal_url {
2561: my ($cnum,$cdom) = @_;
2562: my $chome = &homeserver($cnum,$cdom);
2563: my $hostname = &hostname($chome);
2564: my $protocol = $protocol{$chome};
2565: $protocol = 'http' if ($protocol ne 'https');
2566: my %domdefaults = &get_domain_defaults($cdom);
2567: my $firsturl;
2568: if ($domdefaults{'portal_def'}) {
2569: $firsturl = $domdefaults{'portal_def'};
2570: } else {
2571: $firsturl = $protocol.'://'.$hostname;
2572: }
2573: return $firsturl;
2574: }
2575:
2576: # --------------------------------------------------- Assign a key to a student
2577:
2578: sub assign_access_key {
2579: #
2580: # a valid key looks like uname:udom#comments
2581: # comments are being appended
2582: #
2583: my ($ckey,$kdom,$knum,$cdom,$cnum,$udom,$uname,$logentry)=@_;
2584: $kdom=
2585: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($kdom));
2586: $knum=
2587: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($knum));
2588: $cdom=
2589: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
2590: $cnum=
2591: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
2592: $udom=$env{'user.name'} unless (defined($udom));
2593: $uname=$env{'user.domain'} unless (defined($uname));
2594: my %existing=&get('accesskeys',[$ckey],$kdom,$knum);
2595: if (($existing{$ckey}=~/^\#(.*)$/) || # - new key
2596: ($existing{$ckey}=~/^\Q$uname\E\:\Q$udom\E\#(.*)$/)) {
2597: # assigned to this person
2598: # - this should not happen,
2599: # unless something went wrong
2600: # the first time around
2601: # ready to assign
2602: $logentry=$1.'; '.$logentry;
2603: if (&put('accesskeys',{$ckey=>$uname.':'.$udom.'#'.$logentry},
2604: $kdom,$knum) eq 'ok') {
2605: # key now belongs to user
2606: my $envkey='key.'.$cdom.'_'.$cnum;
2607: if (&put('environment',{$envkey => $ckey}) eq 'ok') {
2608: &appenv({'environment.'.$envkey => $ckey});
2609: return 'ok';
2610: } else {
2611: return
2612: 'error: Count not permanently assign key, will need to be re-entered later.';
2613: }
2614: } else {
2615: return 'error: Could not assign key, try again later.';
2616: }
2617: } elsif (!$existing{$ckey}) {
2618: # the key does not exist
2619: return 'error: The key does not exist';
2620: } else {
2621: # the key is somebody else's
2622: return 'error: The key is already in use';
2623: }
2624: }
2625:
2626: # ------------------------------------------ put an additional comment on a key
2627:
2628: sub comment_access_key {
2629: #
2630: # a valid key looks like uname:udom#comments
2631: # comments are being appended
2632: #
2633: my ($ckey,$cdom,$cnum,$logentry)=@_;
2634: $cdom=
2635: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
2636: $cnum=
2637: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
2638: my %existing=&get('accesskeys',[$ckey],$cdom,$cnum);
2639: if ($existing{$ckey}) {
2640: $existing{$ckey}.='; '.$logentry;
2641: # ready to assign
2642: if (&put('accesskeys',{$ckey=>$existing{$ckey}},
2643: $cdom,$cnum) eq 'ok') {
2644: return 'ok';
2645: } else {
2646: return 'error: Count not store comment.';
2647: }
2648: } else {
2649: # the key does not exist
2650: return 'error: The key does not exist';
2651: }
2652: }
2653:
2654: # ------------------------------------------------------ Generate a set of keys
2655:
2656: sub generate_access_keys {
2657: my ($number,$cdom,$cnum,$logentry)=@_;
2658: $cdom=
2659: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
2660: $cnum=
2661: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
2662: unless (&allowed('mky',$cdom)) { return 0; }
2663: unless (($cdom) && ($cnum)) { return 0; }
2664: if ($number>10000) { return 0; }
2665: sleep(2); # make sure don't get same seed twice
2666: srand(time()^($$+($$<<15))); # from "Programming Perl"
2667: my $total=0;
2668: for (my $i=1;$i<=$number;$i++) {
2669: my $newkey=sprintf("%lx",int(100000*rand)).'-'.
2670: sprintf("%lx",int(100000*rand)).'-'.
2671: sprintf("%lx",int(100000*rand));
2672: $newkey=~s/1/g/g; # folks mix up 1 and l
2673: $newkey=~s/0/h/g; # and also 0 and O
2674: my %existing=&get('accesskeys',[$newkey],$cdom,$cnum);
2675: if ($existing{$newkey}) {
2676: $i--;
2677: } else {
2678: if (&put('accesskeys',
2679: { $newkey => '# generated '.localtime().
2680: ' by '.$env{'user.name'}.'@'.$env{'user.domain'}.
2681: '; '.$logentry },
2682: $cdom,$cnum) eq 'ok') {
2683: $total++;
2684: }
2685: }
2686: }
2687: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},
2688: 'Generated '.$total.' keys for '.$cnum.' at '.$cdom);
2689: return $total;
2690: }
2691:
2692: # ------------------------------------------------------- Validate an accesskey
2693:
2694: sub validate_access_key {
2695: my ($ckey,$cdom,$cnum,$udom,$uname)=@_;
2696: $cdom=
2697: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
2698: $cnum=
2699: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
2700: $udom=$env{'user.domain'} unless (defined($udom));
2701: $uname=$env{'user.name'} unless (defined($uname));
2702: my %existing=&get('accesskeys',[$ckey],$cdom,$cnum);
2703: return ($existing{$ckey}=~/^\Q$uname\E\:\Q$udom\E\#/);
2704: }
2705:
2706: # ------------------------------------- Find the section of student in a course
2707: sub devalidate_getsection_cache {
2708: my ($udom,$unam,$courseid)=@_;
2709: my $hashid="$udom:$unam:$courseid";
2710: &devalidate_cache_new('getsection',$hashid);
2711: }
2712:
2713: sub courseid_to_courseurl {
2714: my ($courseid) = @_;
2715: #already url style courseid
2716: return $courseid if ($courseid =~ m{^/});
2717:
2718: if (exists($env{'course.'.$courseid.'.num'})) {
2719: my $cnum = $env{'course.'.$courseid.'.num'};
2720: my $cdom = $env{'course.'.$courseid.'.domain'};
2721: return "/$cdom/$cnum";
2722: }
2723:
2724: my %courseinfo=&Apache::lonnet::coursedescription($courseid);
2725: if (exists($courseinfo{'num'})) {
2726: return "/$courseinfo{'domain'}/$courseinfo{'num'}";
2727: }
2728:
2729: return undef;
2730: }
2731:
2732: sub getsection {
2733: my ($udom,$unam,$courseid)=@_;
2734: my $cachetime=1800;
2735:
2736: my $hashid="$udom:$unam:$courseid";
2737: my ($result,$cached)=&is_cached_new('getsection',$hashid);
2738: if (defined($cached)) { return $result; }
2739:
2740: my %Pending;
2741: my %Expired;
2742: #
2743: # Each role can either have not started yet (pending), be active,
2744: # or have expired.
2745: #
2746: # If there is an active role, we are done.
2747: #
2748: # If there is more than one role which has not started yet,
2749: # choose the one which will start sooner
2750: # If there is one role which has not started yet, return it.
2751: #
2752: # If there is more than one expired role, choose the one which ended last.
2753: # If there is a role which has expired, return it.
2754: #
2755: $courseid = &courseid_to_courseurl($courseid);
2756: my %roleshash = &dump('roles',$udom,$unam,$courseid);
2757: foreach my $key (keys(%roleshash)) {
2758: next if ($key !~/^\Q$courseid\E(?:\/)*(\w+)*\_st$/);
2759: my $section=$1;
2760: if ($key eq $courseid.'_st') { $section=''; }
2761: my ($dummy,$end,$start)=split(/\_/,&unescape($roleshash{$key}));
2762: my $now=time;
2763: if (defined($end) && $end && ($now > $end)) {
2764: $Expired{$end}=$section;
2765: next;
2766: }
2767: if (defined($start) && $start && ($now < $start)) {
2768: $Pending{$start}=$section;
2769: next;
2770: }
2771: return &do_cache_new('getsection',$hashid,$section,$cachetime);
2772: }
2773: #
2774: # Presumedly there will be few matching roles from the above
2775: # loop and the sorting time will be negligible.
2776: if (scalar(keys(%Pending))) {
2777: my ($time) = sort {$a <=> $b} keys(%Pending);
2778: return &do_cache_new('getsection',$hashid,$Pending{$time},$cachetime);
2779: }
2780: if (scalar(keys(%Expired))) {
2781: my @sorted = sort {$a <=> $b} keys(%Expired);
2782: my $time = pop(@sorted);
2783: return &do_cache_new('getsection',$hashid,$Expired{$time},$cachetime);
2784: }
2785: return &do_cache_new('getsection',$hashid,'-1',$cachetime);
2786: }
2787:
2788: sub save_cache {
2789: &purge_remembered();
2790: #&Apache::loncommon::validate_page();
2791: undef(%env);
2792: undef($env_loaded);
2793: }
2794:
2795: my $to_remember=-1;
2796: my %remembered;
2797: my %accessed;
2798: my $kicks=0;
2799: my $hits=0;
2800: sub make_key {
2801: my ($name,$id) = @_;
2802: if (length($id) > 65
2803: && length(&escape($id)) > 200) {
2804: $id=length($id).':'.&Digest::MD5::md5_hex($id);
2805: }
2806: return &escape($name.':'.$id);
2807: }
2808:
2809: sub devalidate_cache_new {
2810: my ($name,$id,$debug) = @_;
2811: if ($debug) { &Apache::lonnet::logthis("deleting $name:$id"); }
2812: my $remembered_id=$name.':'.$id;
2813: $id=&make_key($name,$id);
2814: $memcache->delete($id);
2815: delete($remembered{$remembered_id});
2816: delete($accessed{$remembered_id});
2817: }
2818:
2819: sub is_cached_new {
2820: my ($name,$id,$debug) = @_;
2821: my $remembered_id=$name.':'.$id; # this is to avoid make_key (which is slow) whenever possible
2822: if (exists($remembered{$remembered_id})) {
2823: if ($debug) { &Apache::lonnet::logthis("Early return $remembered_id of $remembered{$remembered_id} "); }
2824: $accessed{$remembered_id}=[&gettimeofday()];
2825: $hits++;
2826: return ($remembered{$remembered_id},1);
2827: }
2828: $id=&make_key($name,$id);
2829: my $value = $memcache->get($id);
2830: if (!(defined($value))) {
2831: if ($debug) { &Apache::lonnet::logthis("getting $id is not defined"); }
2832: return (undef,undef);
2833: }
2834: if ($value eq '__undef__') {
2835: if ($debug) { &Apache::lonnet::logthis("getting $id is __undef__"); }
2836: $value=undef;
2837: }
2838: &make_room($remembered_id,$value,$debug);
2839: if ($debug) { &Apache::lonnet::logthis("getting $id is $value"); }
2840: return ($value,1);
2841: }
2842:
2843: sub do_cache_new {
2844: my ($name,$id,$value,$time,$debug) = @_;
2845: my $remembered_id=$name.':'.$id;
2846: $id=&make_key($name,$id);
2847: my $setvalue=$value;
2848: if (!defined($setvalue)) {
2849: $setvalue='__undef__';
2850: }
2851: if (!defined($time) ) {
2852: $time=600;
2853: }
2854: if ($debug) { &Apache::lonnet::logthis("Setting $id to $value"); }
2855: my $result = $memcache->set($id,$setvalue,$time);
2856: if (! $result) {
2857: &logthis("caching of id -> $id failed");
2858: $memcache->disconnect_all();
2859: }
2860: # need to make a copy of $value
2861: &make_room($remembered_id,$value,$debug);
2862: return $value;
2863: }
2864:
2865: sub make_room {
2866: my ($remembered_id,$value,$debug)=@_;
2867:
2868: $remembered{$remembered_id}= (ref($value)) ? &Storable::dclone($value)
2869: : $value;
2870: if ($to_remember<0) { return; }
2871: $accessed{$remembered_id}=[&gettimeofday()];
2872: if (scalar(keys(%remembered)) <= $to_remember) { return; }
2873: my $to_kick;
2874: my $max_time=0;
2875: foreach my $other (keys(%accessed)) {
2876: if (&tv_interval($accessed{$other}) > $max_time) {
2877: $to_kick=$other;
2878: $max_time=&tv_interval($accessed{$other});
2879: }
2880: }
2881: delete($remembered{$to_kick});
2882: delete($accessed{$to_kick});
2883: $kicks++;
2884: if ($debug) { &logthis("kicking $to_kick $max_time $kicks\n"); }
2885: return;
2886: }
2887:
2888: sub purge_remembered {
2889: #&logthis("Tossing ".scalar(keys(%remembered)));
2890: #&logthis(sprintf("%-20s is %s",'%remembered',length(&freeze(\%remembered))));
2891: undef(%remembered);
2892: undef(%accessed);
2893: }
2894: # ------------------------------------- Read an entry from a user's environment
2895:
2896: sub userenvironment {
2897: my ($udom,$unam,@what)=@_;
2898: my $items;
2899: foreach my $item (@what) {
2900: $items.=&escape($item).'&';
2901: }
2902: $items=~s/\&$//;
2903: my %returnhash=();
2904: my $uhome = &homeserver($unam,$udom);
2905: unless ($uhome eq 'no_host') {
2906: my @answer=split(/\&/,
2907: &reply('get:'.$udom.':'.$unam.':environment:'.$items,$uhome));
2908: if ($#answer==0 && $answer[0] =~ /^(con_lost|error:|no_such_host)/i) {
2909: return %returnhash;
2910: }
2911: my $i;
2912: for ($i=0;$i<=$#what;$i++) {
2913: $returnhash{$what[$i]}=&unescape($answer[$i]);
2914: }
2915: }
2916: return %returnhash;
2917: }
2918:
2919: # ---------------------------------------------------------- Get a studentphoto
2920: sub studentphoto {
2921: my ($udom,$unam,$ext) = @_;
2922: my $home=&Apache::lonnet::homeserver($unam,$udom);
2923: if (defined($env{'request.course.id'})) {
2924: if ($env{'course.'.$env{'request.course.id'}.'.internal.showphoto'}) {
2925: if ($udom eq $env{'course.'.$env{'request.course.id'}.'.domain'}) {
2926: return(&retrievestudentphoto($udom,$unam,$ext));
2927: } else {
2928: my ($result,$perm_reqd)=
2929: &Apache::lonnet::auto_photo_permission($unam,$udom);
2930: if ($result eq 'ok') {
2931: if (!($perm_reqd eq 'yes')) {
2932: return(&retrievestudentphoto($udom,$unam,$ext));
2933: }
2934: }
2935: }
2936: }
2937: } else {
2938: my ($result,$perm_reqd) =
2939: &Apache::lonnet::auto_photo_permission($unam,$udom);
2940: if ($result eq 'ok') {
2941: if (!($perm_reqd eq 'yes')) {
2942: return(&retrievestudentphoto($udom,$unam,$ext));
2943: }
2944: }
2945: }
2946: return '/adm/lonKaputt/lonlogo_broken.gif';
2947: }
2948:
2949: sub retrievestudentphoto {
2950: my ($udom,$unam,$ext,$type) = @_;
2951: my $home=&Apache::lonnet::homeserver($unam,$udom);
2952: my $ret=&Apache::lonnet::reply("studentphoto:$udom:$unam:$ext:$type",$home);
2953: if ($ret eq 'ok') {
2954: my $url="/uploaded/$udom/$unam/internal/studentphoto.$ext";
2955: if ($type eq 'thumbnail') {
2956: $url="/uploaded/$udom/$unam/internal/studentphoto_tn.$ext";
2957: }
2958: my $tokenurl=&Apache::lonnet::tokenwrapper($url);
2959: return $tokenurl;
2960: } else {
2961: if ($type eq 'thumbnail') {
2962: return '/adm/lonKaputt/genericstudent_tn.gif';
2963: } else {
2964: return '/adm/lonKaputt/lonlogo_broken.gif';
2965: }
2966: }
2967: }
2968:
2969: # -------------------------------------------------------------------- New chat
2970:
2971: sub chatsend {
2972: my ($newentry,$anon,$group)=@_;
2973: my $cnum=$env{'course.'.$env{'request.course.id'}.'.num'};
2974: my $cdom=$env{'course.'.$env{'request.course.id'}.'.domain'};
2975: my $chome=$env{'course.'.$env{'request.course.id'}.'.home'};
2976: &reply('chatsend:'.$cdom.':'.$cnum.':'.
2977: &escape($env{'user.domain'}.':'.$env{'user.name'}.':'.$anon.':'.
2978: &escape($newentry)).':'.$group,$chome);
2979: }
2980:
2981: # ------------------------------------------ Find current version of a resource
2982:
2983: sub getversion {
2984: my $fname=&clutter(shift);
2985: unless ($fname=~m{^(/adm/wrapper|)/res/}) { return -1; }
2986: return ¤tversion(&filelocation('',$fname));
2987: }
2988:
2989: sub currentversion {
2990: my $fname=shift;
2991: my $author=$fname;
2992: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
2993: my ($udom,$uname)=split(/\//,$author);
2994: my $home=&homeserver($uname,$udom);
2995: if ($home eq 'no_host') {
2996: return -1;
2997: }
2998: my $answer=&reply("currentversion:$fname",$home);
2999: if (($answer eq 'con_lost') || ($answer eq 'rejected')) {
3000: return -1;
3001: }
3002: return $answer;
3003: }
3004:
3005: #
3006: # Return special version number of resource if set by override, empty otherwise
3007: #
3008: sub usedversion {
3009: my $fname=shift;
3010: unless ($fname) { $fname=$env{'request.uri'}; }
3011: my ($urlversion)=($fname=~/\.(\d+)\.\w+$/);
3012: if ($urlversion) { return $urlversion; }
3013: return '';
3014: }
3015:
3016: # ----------------------------- Subscribe to a resource, return URL if possible
3017:
3018: sub subscribe {
3019: my $fname=shift;
3020: if ($fname=~/\/(aboutme|syllabus|bulletinboard|smppg)$/) { return ''; }
3021: $fname=~s/[\n\r]//g;
3022: my $author=$fname;
3023: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
3024: my ($udom,$uname)=split(/\//,$author);
3025: my $home=homeserver($uname,$udom);
3026: if ($home eq 'no_host') {
3027: return 'not_found';
3028: }
3029: my $answer=reply("sub:$fname",$home);
3030: if (($answer eq 'con_lost') || ($answer eq 'rejected')) {
3031: $answer.=' by '.$home;
3032: }
3033: return $answer;
3034: }
3035:
3036: # -------------------------------------------------------------- Replicate file
3037:
3038: sub repcopy {
3039: my $filename=shift;
3040: $filename=~s/\/+/\//g;
3041: my $londocroot = $perlvar{'lonDocRoot'};
3042: if ($filename=~m{^\Q$londocroot/adm/\E}) { return 'ok'; }
3043: if ($filename=~m{^\Q/home/httpd/lonUsers/\E}) { return 'ok'; }
3044: if ($filename=~m{^\Q$londocroot/userfiles/\E} or
3045: $filename=~m{^/*(uploaded|editupload)/}) {
3046: return &repcopy_userfile($filename);
3047: }
3048: $filename=~s/[\n\r]//g;
3049: my $transname="$filename.in.transfer";
3050: # FIXME: this should flock
3051: if ((-e $filename) || (-e $transname)) { return 'ok'; }
3052: my $remoteurl=subscribe($filename);
3053: if ($remoteurl =~ /^con_lost by/) {
3054: &logthis("Subscribe returned $remoteurl: $filename");
3055: return 'unavailable';
3056: } elsif ($remoteurl eq 'not_found') {
3057: #&logthis("Subscribe returned not_found: $filename");
3058: return 'not_found';
3059: } elsif ($remoteurl =~ /^rejected by/) {
3060: &logthis("Subscribe returned $remoteurl: $filename");
3061: return 'forbidden';
3062: } elsif ($remoteurl eq 'directory') {
3063: return 'ok';
3064: } else {
3065: my $author=$filename;
3066: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
3067: my ($udom,$uname)=split(/\//,$author);
3068: my $home=homeserver($uname,$udom);
3069: unless ($home eq $perlvar{'lonHostID'}) {
3070: my @parts=split(/\//,$filename);
3071: my $path="/$parts[1]/$parts[2]/$parts[3]/$parts[4]";
3072: if ($path ne "$londocroot/res") {
3073: &logthis("Malconfiguration for replication: $filename");
3074: return 'bad_request';
3075: }
3076: my $count;
3077: for ($count=5;$count<$#parts;$count++) {
3078: $path.="/$parts[$count]";
3079: if ((-e $path)!=1) {
3080: mkdir($path,0777);
3081: }
3082: }
3083: my $request=new HTTP::Request('GET',"$remoteurl");
3084: my $response;
3085: if ($remoteurl =~ m{/raw/}) {
3086: $response=&LONCAPA::LWPReq::makerequest($home,$request,$transname,\%perlvar,'',0,1);
3087: } else {
3088: $response=&LONCAPA::LWPReq::makerequest($home,$request,$transname,\%perlvar,'',1);
3089: }
3090: if ($response->is_error()) {
3091: unlink($transname);
3092: my $message=$response->status_line;
3093: &logthis("<font color=\"blue\">WARNING:"
3094: ." LWP get: $message: $filename</font>");
3095: return 'unavailable';
3096: } else {
3097: if ($remoteurl!~/\.meta$/) {
3098: my $mrequest=new HTTP::Request('GET',$remoteurl.'.meta');
3099: my $mresponse;
3100: if ($remoteurl =~ m{/raw/}) {
3101: $mresponse = &LONCAPA::LWPReq::makerequest($home,$mrequest,$filename.'.meta',\%perlvar,'',0,1);
3102: } else {
3103: $mresponse = &LONCAPA::LWPReq::makerequest($home,$mrequest,$filename.'.meta',\%perlvar,'',1);
3104: }
3105: if ($mresponse->is_error()) {
3106: unlink($filename.'.meta');
3107: &logthis(
3108: "<font color=\"yellow\">INFO: No metadata: $filename</font>");
3109: }
3110: }
3111: rename($transname,$filename);
3112: return 'ok';
3113: }
3114: }
3115: }
3116: }
3117:
3118: # ------------------------------------------------ Get server side include body
3119: sub ssi_body {
3120: my ($filelink,%form)=@_;
3121: if (! exists($form{'LONCAPA_INTERNAL_no_discussion'})) {
3122: $form{'LONCAPA_INTERNAL_no_discussion'}='true';
3123: }
3124: my $output='';
3125: my $response;
3126: if ($filelink=~/^https?\:/) {
3127: ($output,$response)=&externalssi($filelink);
3128: } else {
3129: $filelink .= $filelink=~/\?/ ? '&' : '?';
3130: $filelink .= 'inhibitmenu=yes';
3131: ($output,$response)=&ssi($filelink,%form);
3132: }
3133: $output=~s|//(\s*<!--)? BEGIN LON-CAPA Internal.+?// END LON-CAPA Internal\s*(-->)?\s||gs;
3134: $output=~s/^.*?\<body[^\>]*\>//si;
3135: $output=~s/\<\/body\s*\>.*?$//si;
3136: if (wantarray) {
3137: return ($output, $response);
3138: } else {
3139: return $output;
3140: }
3141: }
3142:
3143: # --------------------------------------------------------- Server Side Include
3144:
3145: sub absolute_url {
3146: my ($host_name) = @_;
3147: my $protocol = ($ENV{'SERVER_PORT'} == 443?'https://':'http://');
3148: if ($host_name eq '') {
3149: $host_name = $ENV{'SERVER_NAME'};
3150: }
3151: return $protocol.$host_name;
3152: }
3153:
3154: #
3155: # Server side include.
3156: # Parameters:
3157: # fn Possibly encrypted resource name/id.
3158: # form Hash that describes how the rendering should be done
3159: # and other things.
3160: # Returns:
3161: # Scalar context: The content of the response.
3162: # Array context: 2 element list of the content and the full response object.
3163: #
3164: sub ssi {
3165:
3166: my ($fn,%form)=@_;
3167: my $request;
3168:
3169: $form{'no_update_last_known'}=1;
3170: &Apache::lonenc::check_encrypt(\$fn);
3171: if (%form) {
3172: $request=new HTTP::Request('POST',&absolute_url().$fn);
3173: $request->content(join('&',map {
3174: my $name = escape($_);
3175: "$name=" . ( ref($form{$_}) eq 'ARRAY'
3176: ? join("&$name=", map {escape($_) } @{$form{$_}})
3177: : &escape($form{$_}) );
3178: } keys(%form)));
3179: } else {
3180: $request=new HTTP::Request('GET',&absolute_url().$fn);
3181: }
3182:
3183: $request->header(Cookie => $ENV{'HTTP_COOKIE'});
3184: my $lonhost = $perlvar{'lonHostID'};
3185: my $response= &LONCAPA::LWPReq::makerequest($lonhost,$request,'',\%perlvar);
3186:
3187: if (wantarray) {
3188: return ($response->content, $response);
3189: } else {
3190: return $response->content;
3191: }
3192: }
3193:
3194: sub externalssi {
3195: my ($url)=@_;
3196: my $request=new HTTP::Request('GET',$url);
3197: my $response = &LONCAPA::LWPReq::makerequest('',$request,'',\%perlvar);
3198: if (wantarray) {
3199: return ($response->content, $response);
3200: } else {
3201: return $response->content;
3202: }
3203: }
3204:
3205:
3206: # If the local copy of a replicated resource is outdated, trigger a
3207: # connection from the homeserver to flush the delayed queue. If no update
3208: # happens, remove local copies of outdated resource (and corresponding
3209: # metadata file).
3210:
3211: sub remove_stale_resfile {
3212: my ($url) = @_;
3213: my $removed;
3214: if ($url=~m{^/res/($match_domain)/($match_username)/}) {
3215: my $audom = $1;
3216: my $auname = $2;
3217: unless (($url =~ /\.\d+\.\w+$/) || ($url =~ m{^/res/lib/templates/})) {
3218: my $homeserver = &homeserver($auname,$audom);
3219: unless (($homeserver eq 'no_host') ||
3220: (grep { $_ eq $homeserver } ¤t_machine_ids())) {
3221: my $fname = &filelocation('',$url);
3222: if (-e $fname) {
3223: my $protocol = $protocol{$homeserver};
3224: $protocol = 'http' if ($protocol ne 'https');
3225: my $hostname = &hostname($homeserver);
3226: if ($hostname) {
3227: my $uri = &declutter($url);
3228: my $request=new HTTP::Request('HEAD',$protocol.'://'.$hostname.'/raw/'.$uri);
3229: my $response = &LONCAPA::LWPReq::makerequest($homeserver,$request,'',\%perlvar,5,0,1);
3230: if ($response->is_success()) {
3231: my $remmodtime = &HTTP::Date::str2time( $response->header('Last-modified') );
3232: my $locmodtime = (stat($fname))[9];
3233: if ($locmodtime < $remmodtime) {
3234: my $stale;
3235: my $answer = &reply('pong',$homeserver);
3236: if ($answer eq $homeserver.':'.$perlvar{'lonHostID'}) {
3237: sleep(0.2);
3238: $locmodtime = (stat($fname))[9];
3239: if ($locmodtime < $remmodtime) {
3240: my $posstransfer = $fname.'.in.transfer';
3241: if ((-e $posstransfer) && ($remmodtime < (stat($posstransfer))[9])) {
3242: $removed = 1;
3243: } else {
3244: $stale = 1;
3245: }
3246: } else {
3247: $removed = 1;
3248: }
3249: } else {
3250: $stale = 1;
3251: }
3252: if ($stale) {
3253: unlink($fname);
3254: if ($uri!~/\.meta$/) {
3255: unlink($fname.'.meta');
3256: }
3257: &reply("unsub:$fname",$homeserver);
3258: $removed = 1;
3259: }
3260: }
3261: }
3262: }
3263: }
3264: }
3265: }
3266: }
3267: return $removed;
3268: }
3269:
3270: # -------------------------------- Allow a /uploaded/ URI to be vouched for
3271:
3272: sub allowuploaded {
3273: my ($srcurl,$url)=@_;
3274: $url=&clutter(&declutter($url));
3275: my $dir=$url;
3276: $dir=~s/\/[^\/]+$//;
3277: my %httpref=();
3278: my $httpurl=&hreflocation('',$url);
3279: $httpref{'httpref.'.$httpurl}=$srcurl;
3280: &Apache::lonnet::appenv(\%httpref);
3281: }
3282:
3283: #
3284: # Determine if the current user should be able to edit a particular resource,
3285: # when viewing in course context.
3286: # (a) When viewing resource used to determine if "Edit" item is included in
3287: # Functions.
3288: # (b) When displaying folder contents in course editor, used to determine if
3289: # "Edit" link will be displayed alongside resource.
3290: #
3291: # input: six args -- filename (decluttered), course number, course domain,
3292: # url, symb (if registered) and group (if this is a group
3293: # item -- e.g., bulletin board, group page etc.).
3294: # output: array of five scalars --
3295: # $cfile -- url for file editing if editable on current server
3296: # $home -- homeserver of resource (i.e., for author if published,
3297: # or course if uploaded.).
3298: # $switchserver -- 1 if server switch will be needed.
3299: # $forceedit -- 1 if icon/link should be to go to edit mode
3300: # $forceview -- 1 if icon/link should be to go to view mode
3301: #
3302:
3303: sub can_edit_resource {
3304: my ($file,$cnum,$cdom,$resurl,$symb,$group) = @_;
3305: my ($cfile,$home,$switchserver,$forceedit,$forceview,$uploaded,$incourse);
3306: #
3307: # For aboutme pages user can only edit his/her own.
3308: #
3309: if ($resurl =~ m{^/?adm/($match_domain)/($match_username)/aboutme$}) {
3310: my ($sdom,$sname) = ($1,$2);
3311: if (($sdom eq $env{'user.domain'}) && ($sname eq $env{'user.name'})) {
3312: $home = $env{'user.home'};
3313: $cfile = $resurl;
3314: if ($env{'form.forceedit'}) {
3315: $forceview = 1;
3316: } else {
3317: $forceedit = 1;
3318: }
3319: return ($cfile,$home,$switchserver,$forceedit,$forceview);
3320: } else {
3321: return;
3322: }
3323: }
3324:
3325: if ($env{'request.course.id'}) {
3326: my $crsedit = &Apache::lonnet::allowed('mdc',$env{'request.course.id'});
3327: if ($group ne '') {
3328: # if this is a group homepage or group bulletin board, check group privs
3329: my $allowed = 0;
3330: if ($resurl =~ m{^/?adm/$cdom/$cnum/$group/smppg$}) {
3331: if ((&allowed('mdg',$env{'request.course.id'}.
3332: ($env{'request.course.sec'}?'/'.$env{'request.course.sec'}:''))) ||
3333: (&allowed('mgh',$env{'request.course.id'}.'/'.$group)) || $crsedit) {
3334: $allowed = 1;
3335: }
3336: } elsif ($resurl =~ m{^/?adm/$cdom/$cnum/\d+/bulletinboard$}) {
3337: if ((&allowed('mdg',$env{'request.course.id'}.($env{'request.course.sec'}?'/'.$env{'request.course.sec'}:''))) ||
3338: (&allowed('cgb',$env{'request.course.id'}.'/'.$group)) || $crsedit) {
3339: $allowed = 1;
3340: }
3341: }
3342: if ($allowed) {
3343: $home=&homeserver($cnum,$cdom);
3344: if ($env{'form.forceedit'}) {
3345: $forceview = 1;
3346: } else {
3347: $forceedit = 1;
3348: }
3349: $cfile = $resurl;
3350: } else {
3351: return;
3352: }
3353: } else {
3354: if ($resurl =~ m{^/?adm/viewclasslist$}) {
3355: unless (&Apache::lonnet::allowed('opa',$env{'request.course.id'})) {
3356: return;
3357: }
3358: } elsif (!$crsedit) {
3359: #
3360: # No edit allowed where CC has switched to student role.
3361: #
3362: return;
3363: }
3364: }
3365: }
3366:
3367: if ($file ne '') {
3368: if (($cnum =~ /$match_courseid/) && ($cdom =~ /$match_domain/)) {
3369: if (&is_course_upload($file,$cnum,$cdom)) {
3370: $uploaded = 1;
3371: $incourse = 1;
3372: if ($file =~/\.(htm|html|css|js|txt)$/) {
3373: $cfile = &hreflocation('',$file);
3374: if ($env{'form.forceedit'}) {
3375: $forceview = 1;
3376: } else {
3377: $forceedit = 1;
3378: }
3379: }
3380: } elsif ($resurl =~ m{^/public/$cdom/$cnum/syllabus}) {
3381: $incourse = 1;
3382: if ($env{'form.forceedit'}) {
3383: $forceview = 1;
3384: } else {
3385: $forceedit = 1;
3386: }
3387: $cfile = $resurl;
3388: } elsif (($resurl ne '') && (&is_on_map($resurl))) {
3389: if ($resurl =~ m{^/adm/$match_domain/$match_username/\d+/smppg|bulletinboard$}) {
3390: $incourse = 1;
3391: if ($env{'form.forceedit'}) {
3392: $forceview = 1;
3393: } else {
3394: $forceedit = 1;
3395: }
3396: $cfile = $resurl;
3397: } elsif ($resurl eq '/res/lib/templates/simpleproblem.problem') {
3398: $incourse = 1;
3399: $cfile = $resurl.'/smpedit';
3400: } elsif ($resurl =~ m{^/adm/wrapper/ext/}) {
3401: $incourse = 1;
3402: if ($env{'form.forceedit'}) {
3403: $forceview = 1;
3404: } else {
3405: $forceedit = 1;
3406: }
3407: $cfile = $resurl;
3408: } elsif ($resurl =~ m{^/adm/wrapper/adm/$cdom/$cnum/\d+/ext\.tool$}) {
3409: $incourse = 1;
3410: if ($env{'form.forceedit'}) {
3411: $forceview = 1;
3412: } else {
3413: $forceedit = 1;
3414: }
3415: $cfile = $resurl;
3416: } elsif ($resurl =~ m{^/?adm/viewclasslist$}) {
3417: $incourse = 1;
3418: if ($env{'form.forceedit'}) {
3419: $forceview = 1;
3420: } else {
3421: $forceedit = 1;
3422: }
3423: $cfile = ($resurl =~ m{^/} ? $resurl : "/$resurl");
3424: }
3425: } elsif ($resurl eq '/res/lib/templates/simpleproblem.problem/smpedit') {
3426: my $template = '/res/lib/templates/simpleproblem.problem';
3427: if (&is_on_map($template)) {
3428: $incourse = 1;
3429: $forceview = 1;
3430: $cfile = $template;
3431: }
3432: } elsif (($resurl =~ m{^/adm/wrapper/ext/}) && ($env{'form.folderpath'} =~ /^supplemental/)) {
3433: $incourse = 1;
3434: if ($env{'form.forceedit'}) {
3435: $forceview = 1;
3436: } else {
3437: $forceedit = 1;
3438: }
3439: $cfile = $resurl;
3440: } elsif (($resurl =~ m{^/adm/wrapper/adm/$cdom/$cnum/\d+/ext\.tool$}) && ($env{'form.folderpath'} =~ /^supplemental/)) {
3441: $incourse = 1;
3442: if ($env{'form.forceedit'}) {
3443: $forceview = 1;
3444: } else {
3445: $forceedit = 1;
3446: }
3447: $cfile = $resurl;
3448: } elsif (($resurl eq '/adm/extresedit') && ($symb || $env{'form.folderpath'})) {
3449: $incourse = 1;
3450: $forceview = 1;
3451: if ($symb) {
3452: my ($map,$id,$res)=&decode_symb($symb);
3453: $env{'request.symb'} = $symb;
3454: $cfile = &clutter($res);
3455: } else {
3456: $cfile = $env{'form.suppurl'};
3457: my $escfile = &unescape($cfile);
3458: if ($escfile =~ m{^/adm/$cdom/$cnum/\d+/ext\.tool$}) {
3459: $cfile = '/adm/wrapper'.$escfile;
3460: } else {
3461: $escfile =~ s{^http://}{};
3462: $cfile = &escape("/adm/wrapper/ext/$escfile");
3463: }
3464: }
3465: } elsif ($resurl =~ m{^/?adm/viewclasslist$}) {
3466: if ($env{'form.forceedit'}) {
3467: $forceview = 1;
3468: } else {
3469: $forceedit = 1;
3470: }
3471: $cfile = ($resurl =~ m{^/} ? $resurl : "/$resurl");
3472: }
3473: }
3474: if ($uploaded || $incourse) {
3475: $home=&homeserver($cnum,$cdom);
3476: } elsif ($file !~ m{/$}) {
3477: $file=~s{^(priv/$match_domain/$match_username)}{/$1};
3478: $file=~s{^($match_domain/$match_username)}{/priv/$1};
3479: # Check that the user has permission to edit this resource
3480: my $setpriv = 1;
3481: my ($cfuname,$cfudom)=&constructaccess($file,$setpriv);
3482: if (defined($cfudom)) {
3483: $home=&homeserver($cfuname,$cfudom);
3484: $cfile=$file;
3485: }
3486: }
3487: if (($cfile ne '') && (!$incourse || $uploaded) &&
3488: (($home ne '') && ($home ne 'no_host'))) {
3489: my @ids=¤t_machine_ids();
3490: unless (grep(/^\Q$home\E$/,@ids)) {
3491: $switchserver=1;
3492: }
3493: }
3494: }
3495: return ($cfile,$home,$switchserver,$forceedit,$forceview);
3496: }
3497:
3498: sub is_course_upload {
3499: my ($file,$cnum,$cdom) = @_;
3500: my $uploadpath = &LONCAPA::propath($cdom,$cnum);
3501: $uploadpath =~ s{^\/}{};
3502: if (($file =~ m{^\Q$uploadpath\E/userfiles/(docs|supplemental)/}) ||
3503: ($file =~ m{^userfiles/\Q$cdom\E/\Q$cnum\E/(docs|supplemental)/})) {
3504: return 1;
3505: }
3506: return;
3507: }
3508:
3509: sub in_course {
3510: my ($udom,$uname,$cdom,$cnum,$type,$hideprivileged) = @_;
3511: if ($hideprivileged) {
3512: my $skipuser;
3513: my %coursehash = &coursedescription($cdom.'_'.$cnum);
3514: my @possdoms = ($cdom);
3515: if ($coursehash{'checkforpriv'}) {
3516: push(@possdoms,split(/,/,$coursehash{'checkforpriv'}));
3517: }
3518: if (&privileged($uname,$udom,\@possdoms)) {
3519: $skipuser = 1;
3520: if ($coursehash{'nothideprivileged'}) {
3521: foreach my $item (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
3522: my $user;
3523: if ($item =~ /:/) {
3524: $user = $item;
3525: } else {
3526: $user = join(':',split(/[\@]/,$item));
3527: }
3528: if ($user eq $uname.':'.$udom) {
3529: undef($skipuser);
3530: last;
3531: }
3532: }
3533: }
3534: if ($skipuser) {
3535: return 0;
3536: }
3537: }
3538: }
3539: $type ||= 'any';
3540: if (!defined($cdom) || !defined($cnum)) {
3541: my $cid = $env{'request.course.id'};
3542: $cdom = $env{'course.'.$cid.'.domain'};
3543: $cnum = $env{'course.'.$cid.'.num'};
3544: }
3545: my $typesref;
3546: if (($type eq 'any') || ($type eq 'all')) {
3547: $typesref = ['active','previous','future'];
3548: } elsif ($type eq 'previous' || $type eq 'future') {
3549: $typesref = [$type];
3550: }
3551: my %roles = &get_my_roles($uname,$udom,'userroles',
3552: $typesref,undef,[$cdom]);
3553: my ($tmp) = keys(%roles);
3554: return 0 if ($tmp =~ /^(con_lost|error|no_such_host)/i);
3555: my @course_roles = grep(/^\Q$cnum\E:\Q$cdom\E:/, keys(%roles));
3556: if (@course_roles > 0) {
3557: return 1;
3558: }
3559: return 0;
3560: }
3561:
3562: # --------- File operations in /home/httpd/html/userfiles/$domain/1/2/3/$course
3563: # input: action, courseID, current domain, intended
3564: # path to file, source of file, instruction to parse file for objects,
3565: # ref to hash for embedded objects,
3566: # ref to hash for codebase of java objects.
3567: # reference to scalar to accommodate mime type determined
3568: # from File::MMagic if $parser = parse.
3569: #
3570: # output: url to file (if action was uploaddoc),
3571: # ok if successful, or diagnostic message otherwise (if action was propagate or copy)
3572: #
3573: # Allows directory structure to be used within lonUsers/../userfiles/ for a
3574: # course.
3575: #
3576: # action = propagate - /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
3577: # will be copied to /home/httpd/lonUsers/1/2/3/$course/userfiles in
3578: # course's home server.
3579: #
3580: # action = copy - /home/httpd/html/userfiles/$domain/1/2/3/$course/$file will
3581: # be copied from $source (current location) to
3582: # /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
3583: # and will then be copied to
3584: # /home/httpd/lonUsers/$domain/1/2/3/$course/userfiles/$file in
3585: # course's home server.
3586: #
3587: # action = uploaddoc - /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
3588: # will be retrived from $env{form.uploaddoc} (from DOCS interface) to
3589: # /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
3590: # and will then be copied to /home/httpd/lonUsers/1/2/3/$course/userfiles/$file
3591: # in course's home server.
3592: #
3593:
3594: sub process_coursefile {
3595: my ($action,$docuname,$docudom,$file,$source,$parser,$allfiles,$codebase,
3596: $mimetype)=@_;
3597: my $fetchresult;
3598: my $home=&homeserver($docuname,$docudom);
3599: if ($action eq 'propagate') {
3600: $fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
3601: $home);
3602: } else {
3603: my $fpath = '';
3604: my $fname = $file;
3605: ($fpath,$fname) = ($file =~ m|^(.*)/([^/]+)$|);
3606: $fpath=$docudom.'/'.$docuname.'/'.$fpath;
3607: my $filepath = &build_filepath($fpath);
3608: if ($action eq 'copy') {
3609: if ($source eq '') {
3610: $fetchresult = 'no source file';
3611: return $fetchresult;
3612: } else {
3613: my $destination = $filepath.'/'.$fname;
3614: rename($source,$destination);
3615: $fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
3616: $home);
3617: }
3618: } elsif ($action eq 'uploaddoc') {
3619: open(my $fh,'>',$filepath.'/'.$fname);
3620: print $fh $env{'form.'.$source};
3621: close($fh);
3622: if ($parser eq 'parse') {
3623: my $mm = new File::MMagic;
3624: my $type = $mm->checktype_filename($filepath.'/'.$fname);
3625: if ($type eq 'text/html') {
3626: my $parse_result = &extract_embedded_items($filepath.'/'.$fname,$allfiles,$codebase);
3627: unless ($parse_result eq 'ok') {
3628: &logthis('Failed to parse '.$filepath.'/'.$fname.' for embedded media: '.$parse_result);
3629: }
3630: }
3631: if (ref($mimetype)) {
3632: $$mimetype = $type;
3633: }
3634: }
3635: $fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
3636: $home);
3637: if ($fetchresult eq 'ok') {
3638: return '/uploaded/'.$fpath.'/'.$fname;
3639: } else {
3640: &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$file.
3641: ' to host '.$home.': '.$fetchresult);
3642: return '/adm/notfound.html';
3643: }
3644: }
3645: }
3646: unless ( $fetchresult eq 'ok') {
3647: &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$file.
3648: ' to host '.$home.': '.$fetchresult);
3649: }
3650: return $fetchresult;
3651: }
3652:
3653: sub build_filepath {
3654: my ($fpath) = @_;
3655: my $filepath=$perlvar{'lonDocRoot'}.'/userfiles';
3656: unless ($fpath eq '') {
3657: my @parts=split('/',$fpath);
3658: foreach my $part (@parts) {
3659: $filepath.= '/'.$part;
3660: if ((-e $filepath)!=1) {
3661: mkdir($filepath,0777);
3662: }
3663: }
3664: }
3665: return $filepath;
3666: }
3667:
3668: sub store_edited_file {
3669: my ($primary_url,$content,$docudom,$docuname,$fetchresult) = @_;
3670: my $file = $primary_url;
3671: $file =~ s#^/uploaded/$docudom/$docuname/##;
3672: my $fpath = '';
3673: my $fname = $file;
3674: ($fpath,$fname) = ($file =~ m|^(.*)/([^/]+)$|);
3675: $fpath=$docudom.'/'.$docuname.'/'.$fpath;
3676: my $filepath = &build_filepath($fpath);
3677: open(my $fh,'>',$filepath.'/'.$fname);
3678: print $fh $content;
3679: close($fh);
3680: my $home=&homeserver($docuname,$docudom);
3681: $$fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
3682: $home);
3683: if ($$fetchresult eq 'ok') {
3684: return '/uploaded/'.$fpath.'/'.$fname;
3685: } else {
3686: &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$file.
3687: ' to host '.$home.': '.$$fetchresult);
3688: return '/adm/notfound.html';
3689: }
3690: }
3691:
3692: sub clean_filename {
3693: my ($fname,$args)=@_;
3694: # Replace Windows backslashes by forward slashes
3695: $fname=~s/\\/\//g;
3696: if (!$args->{'keep_path'}) {
3697: # Get rid of everything but the actual filename
3698: $fname=~s/^.*\/([^\/]+)$/$1/;
3699: }
3700: # Replace spaces by underscores
3701: $fname=~s/\s+/\_/g;
3702: # Replace all other weird characters by nothing
3703: $fname=~s{[^/\w\.\-]}{}g;
3704: # Replace all .\d. sequences with _\d. so they no longer look like version
3705: # numbers
3706: $fname=~s/\.(\d+)(?=\.)/_$1/g;
3707: return $fname;
3708: }
3709: # This Function checks if an Image's dimensions exceed either $resizewidth (width)
3710: # or $resizeheight (height) - both pixels. If so, the image is scaled to produce an
3711: # image with the same aspect ratio as the original, but with dimensions which do
3712: # not exceed $resizewidth and $resizeheight.
3713:
3714: sub resizeImage {
3715: my ($img_path,$resizewidth,$resizeheight) = @_;
3716: my $ima = Image::Magick->new;
3717: my $resized;
3718: if (-e $img_path) {
3719: $ima->Read($img_path);
3720: if (($resizewidth =~ /^\d+$/) && ($resizeheight > 0)) {
3721: my $width = $ima->Get('width');
3722: my $height = $ima->Get('height');
3723: if ($width > $resizewidth) {
3724: my $factor = $width/$resizewidth;
3725: my $newheight = $height/$factor;
3726: $ima->Scale(width=>$resizewidth,height=>$newheight);
3727: $resized = 1;
3728: }
3729: }
3730: if (($resizeheight =~ /^\d+$/) && ($resizeheight > 0)) {
3731: my $width = $ima->Get('width');
3732: my $height = $ima->Get('height');
3733: if ($height > $resizeheight) {
3734: my $factor = $height/$resizeheight;
3735: my $newwidth = $width/$factor;
3736: $ima->Scale(width=>$newwidth,height=>$resizeheight);
3737: $resized = 1;
3738: }
3739: }
3740: if ($resized) {
3741: $ima->Write($img_path);
3742: }
3743: }
3744: return;
3745: }
3746:
3747: # --------------- Take an uploaded file and put it into the userfiles directory
3748: # input: $formname - the contents of the file are in $env{"form.$formname"}
3749: # the desired filename is in $env{"form.$formname.filename"}
3750: # $context - possible values: coursedoc, existingfile, overwrite,
3751: # canceloverwrite, or ''.
3752: # if 'coursedoc': upload to the current course
3753: # if 'existingfile': write file to tmp/overwrites directory
3754: # if 'canceloverwrite': delete file written to tmp/overwrites directory
3755: # $context is passed as argument to &finishuserfileupload
3756: # $subdir - directory in userfile to store the file into
3757: # $parser - instruction to parse file for objects ($parser = parse)
3758: # $allfiles - reference to hash for embedded objects
3759: # $codebase - reference to hash for codebase of java objects
3760: # $desuname - username for permanent storage of uploaded file
3761: # $dsetudom - domain for permanaent storage of uploaded file
3762: # $thumbwidth - width (pixels) of thumbnail to make for uploaded image
3763: # $thumbheight - height (pixels) of thumbnail to make for uploaded image
3764: # $resizewidth - width (pixels) to which to resize uploaded image
3765: # $resizeheight - height (pixels) to which to resize uploaded image
3766: # $mimetype - reference to scalar to accommodate mime type determined
3767: # from File::MMagic.
3768: #
3769: # output: url of file in userspace, or error: <message>
3770: # or /adm/notfound.html if failure to upload occurse
3771:
3772: sub userfileupload {
3773: my ($formname,$context,$subdir,$parser,$allfiles,$codebase,$destuname,
3774: $destudom,$thumbwidth,$thumbheight,$resizewidth,$resizeheight,$mimetype)=@_;
3775: if (!defined($subdir)) { $subdir='unknown'; }
3776: my $fname=$env{'form.'.$formname.'.filename'};
3777: $fname=&clean_filename($fname);
3778: # See if there is anything left
3779: unless ($fname) { return 'error: no uploaded file'; }
3780: # Files uploaded to help request form, or uploaded to "create course" page are handled differently
3781: if ((($formname eq 'screenshot') && ($subdir eq 'helprequests')) ||
3782: (($formname eq 'coursecreatorxml') && ($subdir eq 'batchupload')) ||
3783: ($context eq 'existingfile') || ($context eq 'canceloverwrite')) {
3784: my $now = time;
3785: my $filepath;
3786: if (($formname eq 'screenshot') && ($subdir eq 'helprequests')) {
3787: $filepath = 'tmp/helprequests/'.$now;
3788: } elsif (($formname eq 'coursecreatorxml') && ($subdir eq 'batchupload')) {
3789: $filepath = 'tmp/addcourse/'.$destudom.'/web/'.$env{'user.name'}.
3790: '_'.$env{'user.domain'}.'/pending';
3791: } elsif (($context eq 'existingfile') || ($context eq 'canceloverwrite')) {
3792: my ($docuname,$docudom);
3793: if ($destudom =~ /^$match_domain$/) {
3794: $docudom = $destudom;
3795: } else {
3796: $docudom = $env{'user.domain'};
3797: }
3798: if ($destuname =~ /^$match_username$/) {
3799: $docuname = $destuname;
3800: } else {
3801: $docuname = $env{'user.name'};
3802: }
3803: if (exists($env{'form.group'})) {
3804: $docuname=$env{'course.'.$env{'request.course.id'}.'.num'};
3805: $docudom=$env{'course.'.$env{'request.course.id'}.'.domain'};
3806: }
3807: $filepath = 'tmp/overwrites/'.$docudom.'/'.$docuname.'/'.$subdir;
3808: if ($context eq 'canceloverwrite') {
3809: my $tempfile = $perlvar{'lonDaemons'}.'/'.$filepath.'/'.$fname;
3810: if (-e $tempfile) {
3811: my @info = stat($tempfile);
3812: if ($info[9] eq $env{'form.timestamp'}) {
3813: unlink($tempfile);
3814: }
3815: }
3816: return;
3817: }
3818: }
3819: # Create the directory if not present
3820: my @parts=split(/\//,$filepath);
3821: my $fullpath = $perlvar{'lonDaemons'};
3822: for (my $i=0;$i<@parts;$i++) {
3823: $fullpath .= '/'.$parts[$i];
3824: if ((-e $fullpath)!=1) {
3825: mkdir($fullpath,0777);
3826: }
3827: }
3828: open(my $fh,'>',$fullpath.'/'.$fname);
3829: print $fh $env{'form.'.$formname};
3830: close($fh);
3831: if ($context eq 'existingfile') {
3832: my @info = stat($fullpath.'/'.$fname);
3833: return ($fullpath.'/'.$fname,$info[9]);
3834: } else {
3835: return $fullpath.'/'.$fname;
3836: }
3837: }
3838: if ($subdir eq 'scantron') {
3839: $fname = 'scantron_orig_'.$fname;
3840: } else {
3841: $fname="$subdir/$fname";
3842: }
3843: if ($context eq 'coursedoc') {
3844: my $docuname=$env{'course.'.$env{'request.course.id'}.'.num'};
3845: my $docudom=$env{'course.'.$env{'request.course.id'}.'.domain'};
3846: if ($env{'form.folder'} =~ m/^(default|supplemental)/) {
3847: return &finishuserfileupload($docuname,$docudom,
3848: $formname,$fname,$parser,$allfiles,
3849: $codebase,$thumbwidth,$thumbheight,
3850: $resizewidth,$resizeheight,$context,$mimetype);
3851: } else {
3852: if ($env{'form.folder'}) {
3853: $fname=$env{'form.folder'}.'/'.$fname;
3854: }
3855: return &process_coursefile('uploaddoc',$docuname,$docudom,
3856: $fname,$formname,$parser,
3857: $allfiles,$codebase,$mimetype);
3858: }
3859: } elsif (defined($destuname)) {
3860: my $docuname=$destuname;
3861: my $docudom=$destudom;
3862: return &finishuserfileupload($docuname,$docudom,$formname,$fname,
3863: $parser,$allfiles,$codebase,
3864: $thumbwidth,$thumbheight,
3865: $resizewidth,$resizeheight,$context,$mimetype);
3866: } else {
3867: my $docuname=$env{'user.name'};
3868: my $docudom=$env{'user.domain'};
3869: if ((exists($env{'form.group'})) || ($context eq 'syllabus')) {
3870: $docuname=$env{'course.'.$env{'request.course.id'}.'.num'};
3871: $docudom=$env{'course.'.$env{'request.course.id'}.'.domain'};
3872: }
3873: return &finishuserfileupload($docuname,$docudom,$formname,$fname,
3874: $parser,$allfiles,$codebase,
3875: $thumbwidth,$thumbheight,
3876: $resizewidth,$resizeheight,$context,$mimetype);
3877: }
3878: }
3879:
3880: sub finishuserfileupload {
3881: my ($docuname,$docudom,$formname,$fname,$parser,$allfiles,$codebase,
3882: $thumbwidth,$thumbheight,$resizewidth,$resizeheight,$context,$mimetype) = @_;
3883: my $path=$docudom.'/'.$docuname.'/';
3884: my $filepath=$perlvar{'lonDocRoot'};
3885:
3886: my ($fnamepath,$file,$fetchthumb);
3887: $file=$fname;
3888: if ($fname=~m|/|) {
3889: ($fnamepath,$file) = ($fname =~ m|^(.*)/([^/]+)$|);
3890: $path.=$fnamepath.'/';
3891: }
3892: my @parts=split(/\//,$filepath.'/userfiles/'.$path);
3893: my $count;
3894: for ($count=4;$count<=$#parts;$count++) {
3895: $filepath.="/$parts[$count]";
3896: if ((-e $filepath)!=1) {
3897: mkdir($filepath,0777);
3898: }
3899: }
3900:
3901: # Save the file
3902: {
3903: if (!open(FH,'>',$filepath.'/'.$file)) {
3904: &logthis('Failed to create '.$filepath.'/'.$file);
3905: print STDERR ('Failed to create '.$filepath.'/'.$file."\n");
3906: return '/adm/notfound.html';
3907: }
3908: if ($context eq 'overwrite') {
3909: my $source = LONCAPA::tempdir().'/overwrites/'.$docudom.'/'.$docuname.'/'.$fname;
3910: my $target = $filepath.'/'.$file;
3911: if (-e $source) {
3912: my @info = stat($source);
3913: if ($info[9] eq $env{'form.timestamp'}) {
3914: unless (&File::Copy::move($source,$target)) {
3915: &logthis('Failed to overwrite '.$filepath.'/'.$file);
3916: return "Moving from $source failed";
3917: }
3918: } else {
3919: return "Temporary file: $source had unexpected date/time for last modification";
3920: }
3921: } else {
3922: return "Temporary file: $source missing";
3923: }
3924: } elsif (!print FH ($env{'form.'.$formname})) {
3925: &logthis('Failed to write to '.$filepath.'/'.$file);
3926: print STDERR ('Failed to write to '.$filepath.'/'.$file."\n");
3927: return '/adm/notfound.html';
3928: }
3929: close(FH);
3930: if ($resizewidth && $resizeheight) {
3931: my $mm = new File::MMagic;
3932: my $mime_type = $mm->checktype_filename($filepath.'/'.$file);
3933: if ($mime_type =~ m{^image/}) {
3934: &resizeImage($filepath.'/'.$file,$resizewidth,$resizeheight);
3935: }
3936: }
3937: }
3938: if (($context eq 'coursedoc') || ($parser eq 'parse')) {
3939: if (ref($mimetype)) {
3940: if ($$mimetype eq '') {
3941: my $mm = new File::MMagic;
3942: my $type = $mm->checktype_filename($filepath.'/'.$file);
3943: $$mimetype = $type;
3944: }
3945: }
3946: }
3947: if ($parser eq 'parse') {
3948: if ((ref($mimetype)) && ($$mimetype eq 'text/html')) {
3949: my $parse_result = &extract_embedded_items($filepath.'/'.$file,
3950: $allfiles,$codebase);
3951: unless ($parse_result eq 'ok') {
3952: &logthis('Failed to parse '.$filepath.$file.
3953: ' for embedded media: '.$parse_result);
3954: }
3955: }
3956: }
3957: if (($thumbwidth =~ /^\d+$/) && ($thumbheight =~ /^\d+$/)) {
3958: my $input = $filepath.'/'.$file;
3959: my $output = $filepath.'/'.'tn-'.$file;
3960: my $thumbsize = $thumbwidth.'x'.$thumbheight;
3961: my @args = ('convert','-sample',$thumbsize,$input,$output);
3962: system({$args[0]} @args);
3963: if (-e $filepath.'/'.'tn-'.$file) {
3964: $fetchthumb = 1;
3965: }
3966: }
3967:
3968: # Notify homeserver to grep it
3969: #
3970: my $docuhome=&homeserver($docuname,$docudom);
3971: my $fetchresult= &reply('fetchuserfile:'.$path.$file,$docuhome);
3972: if ($fetchresult eq 'ok') {
3973: if ($fetchthumb) {
3974: my $thumbresult= &reply('fetchuserfile:'.$path.'tn-'.$file,$docuhome);
3975: if ($thumbresult ne 'ok') {
3976: &logthis('Failed to transfer '.$path.'tn-'.$file.' to host '.
3977: $docuhome.': '.$thumbresult);
3978: }
3979: }
3980: #
3981: # Return the URL to it
3982: return '/uploaded/'.$path.$file;
3983: } else {
3984: &logthis('Failed to transfer '.$path.$file.' to host '.$docuhome.
3985: ': '.$fetchresult);
3986: return '/adm/notfound.html';
3987: }
3988: }
3989:
3990: sub extract_embedded_items {
3991: my ($fullpath,$allfiles,$codebase,$content) = @_;
3992: my @state = ();
3993: my (%lastids,%related,%shockwave,%flashvars);
3994: my %javafiles = (
3995: codebase => '',
3996: code => '',
3997: archive => ''
3998: );
3999: my %mediafiles = (
4000: src => '',
4001: movie => '',
4002: );
4003: my $p;
4004: if ($content) {
4005: $p = HTML::LCParser->new($content);
4006: } else {
4007: $p = HTML::LCParser->new($fullpath);
4008: }
4009: while (my $t=$p->get_token()) {
4010: if ($t->[0] eq 'S') {
4011: my ($tagname, $attr) = ($t->[1],$t->[2]);
4012: push(@state, $tagname);
4013: if (lc($tagname) eq 'allow') {
4014: &add_filetype($allfiles,$attr->{'src'},'src');
4015: }
4016: if (lc($tagname) eq 'img') {
4017: &add_filetype($allfiles,$attr->{'src'},'src');
4018: }
4019: if (lc($tagname) eq 'a') {
4020: unless (($attr->{'href'} =~ /^#/) || ($attr->{'href'} eq '')) {
4021: &add_filetype($allfiles,$attr->{'href'},'href');
4022: }
4023: }
4024: if (lc($tagname) eq 'script') {
4025: my $src;
4026: if ($attr->{'archive'} =~ /\.jar$/i) {
4027: &add_filetype($allfiles,$attr->{'archive'},'archive');
4028: } else {
4029: if ($attr->{'src'} ne '') {
4030: $src = $attr->{'src'};
4031: &add_filetype($allfiles,$src,'src');
4032: }
4033: }
4034: my $text = $p->get_trimmed_text();
4035: if ($text =~ /\Qswfobject.registerObject(\E([^\)]+)\)/) {
4036: my @swfargs = split(/,/,$1);
4037: foreach my $item (@swfargs) {
4038: $item =~ s/["']//g;
4039: $item =~ s/^\s+//;
4040: $item =~ s/\s+$//;
4041: }
4042: if (($swfargs[0] ne'') && ($swfargs[2] ne '')) {
4043: if (ref($related{$swfargs[0]}) eq 'ARRAY') {
4044: push(@{$related{$swfargs[0]}},$swfargs[2]);
4045: } else {
4046: $related{$swfargs[0]} = [$swfargs[2]];
4047: }
4048: }
4049: }
4050: }
4051: if (lc($tagname) eq 'link') {
4052: if (lc($attr->{'rel'}) eq 'stylesheet') {
4053: &add_filetype($allfiles,$attr->{'href'},'href');
4054: }
4055: }
4056: if (lc($tagname) eq 'object' ||
4057: (lc($tagname) eq 'embed' && lc($state[-2]) ne 'object')) {
4058: foreach my $item (keys(%javafiles)) {
4059: $javafiles{$item} = '';
4060: }
4061: if ((lc($tagname) eq 'object') && (lc($state[-2]) ne 'object')) {
4062: $lastids{lc($tagname)} = $attr->{'id'};
4063: }
4064: }
4065: if (lc($state[-2]) eq 'object' && lc($tagname) eq 'param') {
4066: my $name = lc($attr->{'name'});
4067: foreach my $item (keys(%javafiles)) {
4068: if ($name eq $item) {
4069: $javafiles{$item} = $attr->{'value'};
4070: last;
4071: }
4072: }
4073: my $pathfrom;
4074: foreach my $item (keys(%mediafiles)) {
4075: if ($name eq $item) {
4076: $pathfrom = $attr->{'value'};
4077: $shockwave{$lastids{lc($state[-2])}} = $pathfrom;
4078: &add_filetype($allfiles,$pathfrom,$name);
4079: last;
4080: }
4081: }
4082: if ($name eq 'flashvars') {
4083: $flashvars{$lastids{lc($state[-2])}} = $attr->{'value'};
4084: }
4085: if ($pathfrom ne '') {
4086: &embedded_dependency($allfiles,\%related,$lastids{lc($state[-2])},
4087: $pathfrom);
4088: }
4089: }
4090: if (lc($tagname) eq 'embed' || lc($tagname) eq 'applet') {
4091: foreach my $item (keys(%javafiles)) {
4092: if ($attr->{$item}) {
4093: $javafiles{$item} = $attr->{$item};
4094: last;
4095: }
4096: }
4097: foreach my $item (keys(%mediafiles)) {
4098: if ($attr->{$item}) {
4099: &add_filetype($allfiles,$attr->{$item},$item);
4100: last;
4101: }
4102: }
4103: if (lc($tagname) eq 'embed') {
4104: if (($attr->{'name'} ne '') && ($attr->{'src'} ne '')) {
4105: &embedded_dependency($allfiles,\%related,$attr->{'name'},
4106: $attr->{'src'});
4107: }
4108: }
4109: }
4110: if (lc($tagname) eq 'iframe') {
4111: my $src = $attr->{'src'} ;
4112: if (($src ne '') && ($src !~ m{^(/|https?://)})) {
4113: &add_filetype($allfiles,$src,'src');
4114: } elsif ($src =~ m{^/}) {
4115: if ($env{'request.course.id'}) {
4116: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
4117: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
4118: my $url = &hreflocation('',$fullpath);
4119: if ($url =~ m{^/uploaded/$cdom/$cnum/docs/(\w+/\d+)/}) {
4120: my $relpath = $1;
4121: if ($src =~ m{^/uploaded/$cdom/$cnum/docs/\Q$relpath\E/(.+)$}) {
4122: &add_filetype($allfiles,$1,'src');
4123: }
4124: }
4125: }
4126: }
4127: }
4128: if ($t->[4] =~ m{/>$}) {
4129: pop(@state);
4130: }
4131: } elsif ($t->[0] eq 'E') {
4132: my ($tagname) = ($t->[1]);
4133: if ($javafiles{'codebase'} ne '') {
4134: $javafiles{'codebase'} .= '/';
4135: }
4136: if (lc($tagname) eq 'applet' ||
4137: lc($tagname) eq 'object' ||
4138: (lc($tagname) eq 'embed' && lc($state[-2]) ne 'object')
4139: ) {
4140: foreach my $item (keys(%javafiles)) {
4141: if ($item ne 'codebase' && $javafiles{$item} ne '') {
4142: my $file=$javafiles{'codebase'}.$javafiles{$item};
4143: &add_filetype($allfiles,$file,$item);
4144: }
4145: }
4146: }
4147: pop @state;
4148: }
4149: }
4150: foreach my $id (sort(keys(%flashvars))) {
4151: if ($shockwave{$id} ne '') {
4152: my @pairs = split(/\&/,$flashvars{$id});
4153: foreach my $pair (@pairs) {
4154: my ($key,$value) = split(/\=/,$pair);
4155: if ($key eq 'thumb') {
4156: &add_filetype($allfiles,$value,$key);
4157: } elsif ($key eq 'content') {
4158: my ($path) = ($shockwave{$id} =~ m{^(.+/)[^/]+$});
4159: my ($ext) = ($value =~ /\.([^.]+)$/);
4160: if ($ext ne '') {
4161: &add_filetype($allfiles,$path.$value,$ext);
4162: }
4163: }
4164: }
4165: }
4166: }
4167: return 'ok';
4168: }
4169:
4170: sub add_filetype {
4171: my ($allfiles,$file,$type)=@_;
4172: if (exists($allfiles->{$file})) {
4173: unless (grep/^\Q$type\E$/, @{$allfiles->{$file}}) {
4174: push(@{$allfiles->{$file}}, &escape($type));
4175: }
4176: } else {
4177: @{$allfiles->{$file}} = (&escape($type));
4178: }
4179: }
4180:
4181: sub embedded_dependency {
4182: my ($allfiles,$related,$identifier,$pathfrom) = @_;
4183: if ((ref($allfiles) eq 'HASH') && (ref($related) eq 'HASH')) {
4184: if (($identifier ne '') &&
4185: (ref($related->{$identifier}) eq 'ARRAY') &&
4186: ($pathfrom ne '')) {
4187: my ($path) = ($pathfrom =~ m{^(.+/)[^/]+$});
4188: foreach my $dep (@{$related->{$identifier}}) {
4189: &add_filetype($allfiles,$path.$dep,'object');
4190: }
4191: }
4192: }
4193: return;
4194: }
4195:
4196: sub removeuploadedurl {
4197: my ($url)=@_;
4198: my (undef,undef,$udom,$uname,$fname)=split('/',$url,5);
4199: return &removeuserfile($uname,$udom,$fname);
4200: }
4201:
4202: sub removeuserfile {
4203: my ($docuname,$docudom,$fname)=@_;
4204: my $home=&homeserver($docuname,$docudom);
4205: my $result = &reply("removeuserfile:$docudom/$docuname/$fname",$home);
4206: if ($result eq 'ok') {
4207: if (($fname !~ /\.meta$/) && (&is_portfolio_file($fname))) {
4208: my $metafile = $fname.'.meta';
4209: my $metaresult = &removeuserfile($docuname,$docudom,$metafile);
4210: my $url = "/uploaded/$docudom/$docuname/$fname";
4211: my ($file,$group) = (&parse_portfolio_url($url))[3,4];
4212: my $sqlresult =
4213: &update_portfolio_table($docuname,$docudom,$file,
4214: 'portfolio_metadata',$group,
4215: 'delete');
4216: }
4217: }
4218: return $result;
4219: }
4220:
4221: sub mkdiruserfile {
4222: my ($docuname,$docudom,$dir)=@_;
4223: my $home=&homeserver($docuname,$docudom);
4224: return &reply("mkdiruserfile:".&escape("$docudom/$docuname/$dir"),$home);
4225: }
4226:
4227: sub renameuserfile {
4228: my ($docuname,$docudom,$old,$new)=@_;
4229: my $home=&homeserver($docuname,$docudom);
4230: my $result = &reply("renameuserfile:$docudom:$docuname:".
4231: &escape("$old").':'.&escape("$new"),$home);
4232: if ($result eq 'ok') {
4233: if (($old !~ /\.meta$/) && (&is_portfolio_file($old))) {
4234: my $oldmeta = $old.'.meta';
4235: my $newmeta = $new.'.meta';
4236: my $metaresult =
4237: &renameuserfile($docuname,$docudom,$oldmeta,$newmeta);
4238: my $url = "/uploaded/$docudom/$docuname/$old";
4239: my ($file,$group) = (&parse_portfolio_url($url))[3,4];
4240: my $sqlresult =
4241: &update_portfolio_table($docuname,$docudom,$file,
4242: 'portfolio_metadata',$group,
4243: 'delete');
4244: }
4245: }
4246: return $result;
4247: }
4248:
4249: # ------------------------------------------------------------------------- Log
4250:
4251: sub log {
4252: my ($dom,$nam,$hom,$what)=@_;
4253: return critical("log:$dom:$nam:$what",$hom);
4254: }
4255:
4256: # ------------------------------------------------------------------ Course Log
4257: #
4258: # This routine flushes several buffers of non-mission-critical nature
4259: #
4260:
4261: sub flushcourselogs {
4262: &logthis('Flushing log buffers');
4263: #
4264: # course logs
4265: # This is a log of all transactions in a course, which can be used
4266: # for data mining purposes
4267: #
4268: # It also collects the courseid database, which lists last transaction
4269: # times and course titles for all courseids
4270: #
4271: my %courseidbuffer=();
4272: foreach my $crsid (keys(%courselogs)) {
4273: if (&reply('log:'.$coursedombuf{$crsid}.':'.$coursenumbuf{$crsid}.':'.
4274: &escape($courselogs{$crsid}),
4275: $coursehombuf{$crsid}) eq 'ok') {
4276: delete $courselogs{$crsid};
4277: } else {
4278: &logthis('Failed to flush log buffer for '.$crsid);
4279: if (length($courselogs{$crsid})>40000) {
4280: &logthis("<font color=\"blue\">WARNING: Buffer for ".$crsid.
4281: " exceeded maximum size, deleting.</font>");
4282: delete $courselogs{$crsid};
4283: }
4284: }
4285: $courseidbuffer{$coursehombuf{$crsid}}{$crsid} = {
4286: 'description' => $coursedescrbuf{$crsid},
4287: 'inst_code' => $courseinstcodebuf{$crsid},
4288: 'type' => $coursetypebuf{$crsid},
4289: 'owner' => $courseownerbuf{$crsid},
4290: };
4291: }
4292: #
4293: # Write course id database (reverse lookup) to homeserver of courses
4294: # Is used in pickcourse
4295: #
4296: foreach my $crs_home (keys(%courseidbuffer)) {
4297: my $response = &courseidput(&host_domain($crs_home),
4298: $courseidbuffer{$crs_home},
4299: $crs_home,'timeonly');
4300: }
4301: #
4302: # File accesses
4303: # Writes to the dynamic metadata of resources to get hit counts, etc.
4304: #
4305: foreach my $entry (keys(%accesshash)) {
4306: if ($entry =~ /___count$/) {
4307: my ($dom,$name);
4308: ($dom,$name,undef)=
4309: ($entry=~m{___($match_domain)/($match_name)/(.*)___count$});
4310: if (! defined($dom) || $dom eq '' ||
4311: ! defined($name) || $name eq '') {
4312: my $cid = $env{'request.course.id'};
4313: $dom = $env{'request.'.$cid.'.domain'};
4314: $name = $env{'request.'.$cid.'.num'};
4315: }
4316: my $value = $accesshash{$entry};
4317: my (undef,$url,undef) = ($entry =~ /^(.*)___(.*)___count$/);
4318: my %temphash=($url => $value);
4319: my $result = &inc('nohist_accesscount',\%temphash,$dom,$name);
4320: if ($result eq 'ok') {
4321: delete $accesshash{$entry};
4322: }
4323: } else {
4324: my ($dom,$name) = ($entry=~m{___($match_domain)/($match_name)/(.*)___(\w+)$});
4325: if (($dom eq 'uploaded') || ($dom eq 'adm')) { next; }
4326: my %temphash=($entry => $accesshash{$entry});
4327: if (&put('nohist_resevaldata',\%temphash,$dom,$name) eq 'ok') {
4328: delete $accesshash{$entry};
4329: }
4330: }
4331: }
4332: #
4333: # Roles
4334: # Reverse lookup of user roles for course faculty/staff and co-authorship
4335: #
4336: foreach my $entry (keys(%userrolehash)) {
4337: my ($role,$uname,$udom,$runame,$rudom,$rsec)=
4338: split(/\:/,$entry);
4339: if (&Apache::lonnet::put('nohist_userroles',
4340: { $role.':'.$uname.':'.$udom.':'.$rsec => $userrolehash{$entry} },
4341: $rudom,$runame) eq 'ok') {
4342: delete $userrolehash{$entry};
4343: }
4344: }
4345: #
4346: # Reverse lookup of domain roles (dc, ad, li, sc, dh, da, au)
4347: #
4348: my %domrolebuffer = ();
4349: foreach my $entry (keys(%domainrolehash)) {
4350: my ($role,$uname,$udom,$runame,$rudom,$rsec)=split(/:/,$entry);
4351: if ($domrolebuffer{$rudom}) {
4352: $domrolebuffer{$rudom}.='&'.&escape($entry).
4353: '='.&escape($domainrolehash{$entry});
4354: } else {
4355: $domrolebuffer{$rudom}.=&escape($entry).
4356: '='.&escape($domainrolehash{$entry});
4357: }
4358: delete $domainrolehash{$entry};
4359: }
4360: foreach my $dom (keys(%domrolebuffer)) {
4361: my %servers;
4362: if (defined(&domain($dom,'primary'))) {
4363: my $primary=&domain($dom,'primary');
4364: my $hostname=&hostname($primary);
4365: $servers{$primary} = $hostname;
4366: } else {
4367: %servers = &get_servers($dom,'library');
4368: }
4369: foreach my $tryserver (keys(%servers)) {
4370: if (&reply('domroleput:'.$dom.':'.
4371: $domrolebuffer{$dom},$tryserver) eq 'ok') {
4372: last;
4373: } else {
4374: &logthis('Put of domain roles failed for '.$dom.' and '.$tryserver);
4375: }
4376: }
4377: }
4378: $dumpcount++;
4379: }
4380:
4381: sub courselog {
4382: my $what=shift;
4383: $what=time.':'.$what;
4384: unless ($env{'request.course.id'}) { return ''; }
4385: $coursedombuf{$env{'request.course.id'}}=
4386: $env{'course.'.$env{'request.course.id'}.'.domain'};
4387: $coursenumbuf{$env{'request.course.id'}}=
4388: $env{'course.'.$env{'request.course.id'}.'.num'};
4389: $coursehombuf{$env{'request.course.id'}}=
4390: $env{'course.'.$env{'request.course.id'}.'.home'};
4391: $coursedescrbuf{$env{'request.course.id'}}=
4392: $env{'course.'.$env{'request.course.id'}.'.description'};
4393: $courseinstcodebuf{$env{'request.course.id'}}=
4394: $env{'course.'.$env{'request.course.id'}.'.internal.coursecode'};
4395: $courseownerbuf{$env{'request.course.id'}}=
4396: $env{'course.'.$env{'request.course.id'}.'.internal.courseowner'};
4397: $coursetypebuf{$env{'request.course.id'}}=
4398: $env{'course.'.$env{'request.course.id'}.'.type'};
4399: if (defined $courselogs{$env{'request.course.id'}}) {
4400: $courselogs{$env{'request.course.id'}}.='&'.$what;
4401: } else {
4402: $courselogs{$env{'request.course.id'}}.=$what;
4403: }
4404: if (length($courselogs{$env{'request.course.id'}})>4048) {
4405: &flushcourselogs();
4406: }
4407: }
4408:
4409: sub courseacclog {
4410: my $fnsymb=shift;
4411: unless ($env{'request.course.id'}) { return ''; }
4412: my $what=$fnsymb.':'.$env{'user.name'}.':'.$env{'user.domain'};
4413: if ($fnsymb=~/$LONCAPA::assess_re/) {
4414: $what.=':POST';
4415: # FIXME: Probably ought to escape things....
4416: foreach my $key (keys(%env)) {
4417: if ($key=~/^form\.(.*)/) {
4418: my $formitem = $1;
4419: if ($formitem =~ /^HWFILE(?:SIZE|TOOBIG)/) {
4420: $what.=':'.$formitem.'='.$env{$key};
4421: } elsif ($formitem !~ /^HWFILE(?:[^.]+)$/) {
4422: $what.=':'.$formitem.'='.$env{$key};
4423: }
4424: }
4425: }
4426: } elsif ($fnsymb =~ m:^/adm/searchcat:) {
4427: # FIXME: We should not be depending on a form parameter that someone
4428: # editing lonsearchcat.pm might change in the future.
4429: if ($env{'form.phase'} eq 'course_search') {
4430: $what.= ':POST';
4431: # FIXME: Probably ought to escape things....
4432: foreach my $element ('courseexp','crsfulltext','crsrelated',
4433: 'crsdiscuss') {
4434: $what.=':'.$element.'='.$env{'form.'.$element};
4435: }
4436: }
4437: }
4438: &courselog($what);
4439: }
4440:
4441: sub countacc {
4442: my $url=&declutter(shift);
4443: return if (! defined($url) || $url eq '');
4444: unless ($env{'request.course.id'}) { return ''; }
4445: #
4446: # Mark that this url was used in this course
4447: #
4448: $accesshash{$env{'request.course.id'}.'___'.$url.'___course'}=1;
4449: #
4450: # Increase the access count for this resource in this child process
4451: #
4452: my $key=$$.$processmarker.'_'.$dumpcount.'___'.$url.'___count';
4453: $accesshash{$key}++;
4454: }
4455:
4456: sub linklog {
4457: my ($from,$to)=@_;
4458: $from=&declutter($from);
4459: $to=&declutter($to);
4460: $accesshash{$from.'___'.$to.'___comefrom'}=1;
4461: $accesshash{$to.'___'.$from.'___goto'}=1;
4462: }
4463:
4464: sub statslog {
4465: my ($symb,$part,$users,$av_attempts,$degdiff)=@_;
4466: if ($users<2) { return; }
4467: my %dynstore=&LONCAPA::lonmetadata::dynamic_metadata_storage({
4468: 'course' => $env{'request.course.id'},
4469: 'sections' => '"all"',
4470: 'num_students' => $users,
4471: 'part' => $part,
4472: 'symb' => $symb,
4473: 'mean_tries' => $av_attempts,
4474: 'deg_of_diff' => $degdiff});
4475: foreach my $key (keys(%dynstore)) {
4476: $accesshash{$key}=$dynstore{$key};
4477: }
4478: }
4479:
4480: sub userrolelog {
4481: my ($trole,$username,$domain,$area,$tstart,$tend)=@_;
4482: if ( $trole =~ /^(ca|aa|in|cc|ep|cr|ta|co)/ ) {
4483: my (undef,$rudom,$runame,$rsec)=split(/\//,$area);
4484: $userrolehash
4485: {$trole.':'.$username.':'.$domain.':'.$runame.':'.$rudom.':'.$rsec}
4486: =$tend.':'.$tstart;
4487: }
4488: if ($env{'request.role'} =~ /dc\./ && $trole =~ /^(au|in|cc|ep|cr|ta|co)/) {
4489: $userrolehash
4490: {$trole.':'.$username.':'.$domain.':'.$env{'user.name'}.':'.$env{'user.domain'}.':'}
4491: =$tend.':'.$tstart;
4492: }
4493: if ($trole =~ /^(dc|ad|li|au|dg|sc|dh|da)/ ) {
4494: my (undef,$rudom,$runame,$rsec)=split(/\//,$area);
4495: $domainrolehash
4496: {$trole.':'.$username.':'.$domain.':'.$runame.':'.$rudom.':'.$rsec}
4497: = $tend.':'.$tstart;
4498: }
4499: }
4500:
4501: sub courserolelog {
4502: my ($trole,$username,$domain,$area,$tstart,$tend,$delflag,$selfenroll,$context)=@_;
4503: if ($area =~ m-^/($match_domain)/($match_courseid)/?([^/]*)-) {
4504: my $cdom = $1;
4505: my $cnum = $2;
4506: my $sec = $3;
4507: my $namespace = 'rolelog';
4508: my %storehash = (
4509: role => $trole,
4510: start => $tstart,
4511: end => $tend,
4512: selfenroll => $selfenroll,
4513: context => $context,
4514: );
4515: if ($trole eq 'gr') {
4516: $namespace = 'groupslog';
4517: $storehash{'group'} = $sec;
4518: } else {
4519: $storehash{'section'} = $sec;
4520: }
4521: &write_log('course',$namespace,\%storehash,$delflag,$username,
4522: $domain,$cnum,$cdom);
4523: if (($trole ne 'st') || ($sec ne '')) {
4524: &devalidate_cache_new('getcourseroles',$cdom.'_'.$cnum);
4525: }
4526: }
4527: return;
4528: }
4529:
4530: sub domainrolelog {
4531: my ($trole,$username,$domain,$area,$tstart,$tend,$delflag,$context)=@_;
4532: if ($area =~ m{^/($match_domain)/$}) {
4533: my $cdom = $1;
4534: my $domconfiguser = &Apache::lonnet::get_domainconfiguser($cdom);
4535: my $namespace = 'rolelog';
4536: my %storehash = (
4537: role => $trole,
4538: start => $tstart,
4539: end => $tend,
4540: context => $context,
4541: );
4542: &write_log('domain',$namespace,\%storehash,$delflag,$username,
4543: $domain,$domconfiguser,$cdom);
4544: }
4545: return;
4546:
4547: }
4548:
4549: sub coauthorrolelog {
4550: my ($trole,$username,$domain,$area,$tstart,$tend,$delflag,$context)=@_;
4551: if ($area =~ m{^/($match_domain)/($match_username)$}) {
4552: my $audom = $1;
4553: my $auname = $2;
4554: my $namespace = 'rolelog';
4555: my %storehash = (
4556: role => $trole,
4557: start => $tstart,
4558: end => $tend,
4559: context => $context,
4560: );
4561: &write_log('author',$namespace,\%storehash,$delflag,$username,
4562: $domain,$auname,$audom);
4563: }
4564: return;
4565: }
4566:
4567: sub get_course_adv_roles {
4568: my ($cid,$codes) = @_;
4569: $cid=$env{'request.course.id'} unless (defined($cid));
4570: my %coursehash=&coursedescription($cid);
4571: my $crstype = &Apache::loncommon::course_type($cid);
4572: my %nothide=();
4573: foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
4574: if ($user !~ /:/) {
4575: $nothide{join(':',split(/[\@]/,$user))}=1;
4576: } else {
4577: $nothide{$user}=1;
4578: }
4579: }
4580: my @possdoms = ($coursehash{'domain'});
4581: if ($coursehash{'checkforpriv'}) {
4582: push(@possdoms,split(/,/,$coursehash{'checkforpriv'}));
4583: }
4584: my %returnhash=();
4585: my %dumphash=
4586: &dump('nohist_userroles',$coursehash{'domain'},$coursehash{'num'});
4587: my $now=time;
4588: my %privileged;
4589: foreach my $entry (keys(%dumphash)) {
4590: my ($tend,$tstart)=split(/\:/,$dumphash{$entry});
4591: if (($tstart) && ($tstart<0)) { next; }
4592: if (($tend) && ($tend<$now)) { next; }
4593: if (($tstart) && ($now<$tstart)) { next; }
4594: my ($role,$username,$domain,$section)=split(/\:/,$entry);
4595: if ($username eq '' || $domain eq '') { next; }
4596: if ((&privileged($username,$domain,\@possdoms)) &&
4597: (!$nothide{$username.':'.$domain})) { next; }
4598: if ($role eq 'cr') { next; }
4599: if ($codes) {
4600: if ($section) { $role .= ':'.$section; }
4601: if ($returnhash{$role}) {
4602: $returnhash{$role}.=','.$username.':'.$domain;
4603: } else {
4604: $returnhash{$role}=$username.':'.$domain;
4605: }
4606: } else {
4607: my $key=&plaintext($role,$crstype);
4608: if ($section) { $key.=' ('.&Apache::lonlocal::mt('Section [_1]',$section).')'; }
4609: if ($returnhash{$key}) {
4610: $returnhash{$key}.=','.$username.':'.$domain;
4611: } else {
4612: $returnhash{$key}=$username.':'.$domain;
4613: }
4614: }
4615: }
4616: return %returnhash;
4617: }
4618:
4619: sub get_my_roles {
4620: my ($uname,$udom,$context,$types,$roles,$roledoms,$withsec,$hidepriv)=@_;
4621: unless (defined($uname)) { $uname=$env{'user.name'}; }
4622: unless (defined($udom)) { $udom=$env{'user.domain'}; }
4623: my (%dumphash,%nothide);
4624: if ($context eq 'userroles') {
4625: %dumphash = &dump('roles',$udom,$uname);
4626: } else {
4627: %dumphash = &dump('nohist_userroles',$udom,$uname);
4628: if ($hidepriv) {
4629: my %coursehash=&coursedescription($udom.'_'.$uname);
4630: foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
4631: if ($user !~ /:/) {
4632: $nothide{join(':',split(/[\@]/,$user))} = 1;
4633: } else {
4634: $nothide{$user} = 1;
4635: }
4636: }
4637: }
4638: }
4639: my %returnhash=();
4640: my $now=time;
4641: my %privileged;
4642: foreach my $entry (keys(%dumphash)) {
4643: my ($role,$tend,$tstart);
4644: if ($context eq 'userroles') {
4645: next if ($entry =~ /^rolesdef/);
4646: ($role,$tend,$tstart)=split(/_/,$dumphash{$entry});
4647: } else {
4648: ($tend,$tstart)=split(/\:/,$dumphash{$entry});
4649: }
4650: if (($tstart) && ($tstart<0)) { next; }
4651: my $status = 'active';
4652: if (($tend) && ($tend<=$now)) {
4653: $status = 'previous';
4654: }
4655: if (($tstart) && ($now<$tstart)) {
4656: $status = 'future';
4657: }
4658: if (ref($types) eq 'ARRAY') {
4659: if (!grep(/^\Q$status\E$/,@{$types})) {
4660: next;
4661: }
4662: } else {
4663: if ($status ne 'active') {
4664: next;
4665: }
4666: }
4667: my ($rolecode,$username,$domain,$section,$area);
4668: if ($context eq 'userroles') {
4669: ($area,$rolecode) = ($entry =~ /^(.+)_([^_]+)$/);
4670: (undef,$domain,$username,$section) = split(/\//,$area);
4671: } else {
4672: ($role,$username,$domain,$section) = split(/\:/,$entry);
4673: }
4674: if (ref($roledoms) eq 'ARRAY') {
4675: if (!grep(/^\Q$domain\E$/,@{$roledoms})) {
4676: next;
4677: }
4678: }
4679: if (ref($roles) eq 'ARRAY') {
4680: if (!grep(/^\Q$role\E$/,@{$roles})) {
4681: if ($role =~ /^cr\//) {
4682: if (!grep(/^cr$/,@{$roles})) {
4683: next;
4684: }
4685: } elsif ($role =~ /^gr\//) {
4686: if (!grep(/^gr$/,@{$roles})) {
4687: next;
4688: }
4689: } else {
4690: next;
4691: }
4692: }
4693: }
4694: if ($hidepriv) {
4695: my @privroles = ('dc','su');
4696: if ($context eq 'userroles') {
4697: next if (grep(/^\Q$role\E$/,@privroles));
4698: } else {
4699: my $possdoms = [$domain];
4700: if (ref($roledoms) eq 'ARRAY') {
4701: push(@{$possdoms},@{$roledoms});
4702: }
4703: if (&privileged($username,$domain,$possdoms,\@privroles)) {
4704: if (!$nothide{$username.':'.$domain}) {
4705: next;
4706: }
4707: }
4708: }
4709: }
4710: if ($withsec) {
4711: $returnhash{$username.':'.$domain.':'.$role.':'.$section} =
4712: $tstart.':'.$tend;
4713: } else {
4714: $returnhash{$username.':'.$domain.':'.$role}=$tstart.':'.$tend;
4715: }
4716: }
4717: return %returnhash;
4718: }
4719:
4720: sub get_all_adhocroles {
4721: my ($dom) = @_;
4722: my @roles_by_num = ();
4723: my %domdefaults = &get_domain_defaults($dom);
4724: my (%description,%access_in_dom,%access_info);
4725: if (ref($domdefaults{'adhocroles'}) eq 'HASH') {
4726: my $count = 0;
4727: my %domcurrent = %{$domdefaults{'adhocroles'}};
4728: my %ordered;
4729: foreach my $role (sort(keys(%domcurrent))) {
4730: my ($order,$desc,$access_in_dom);
4731: if (ref($domcurrent{$role}) eq 'HASH') {
4732: $order = $domcurrent{$role}{'order'};
4733: $desc = $domcurrent{$role}{'desc'};
4734: $access_in_dom{$role} = $domcurrent{$role}{'access'};
4735: $access_info{$role} = $domcurrent{$role}{$access_in_dom{$role}};
4736: }
4737: if ($order eq '') {
4738: $order = $count;
4739: }
4740: $ordered{$order} = $role;
4741: if ($desc ne '') {
4742: $description{$role} = $desc;
4743: } else {
4744: $description{$role}= $role;
4745: }
4746: $count++;
4747: }
4748: foreach my $item (sort {$a <=> $b } (keys(%ordered))) {
4749: push(@roles_by_num,$ordered{$item});
4750: }
4751: }
4752: return (\@roles_by_num,\%description,\%access_in_dom,\%access_info);
4753: }
4754:
4755: sub get_my_adhocroles {
4756: my ($cid,$checkreg) = @_;
4757: my ($cdom,$cnum,%info,@possroles,$description,$roles_by_num);
4758: if ($env{'request.course.id'} eq $cid) {
4759: $cdom = $env{'course.'.$cid.'.domain'};
4760: $cnum = $env{'course.'.$cid.'.num'};
4761: $info{'internal.coursecode'} = $env{'course.'.$cid.'.internal.coursecode'};
4762: } elsif ($cid =~ /^($match_domain)_($match_courseid)$/) {
4763: $cdom = $1;
4764: $cnum = $2;
4765: %info = &Apache::lonnet::get('environment',['internal.coursecode'],
4766: $cdom,$cnum);
4767: }
4768: if (($info{'internal.coursecode'} ne '') && ($checkreg)) {
4769: my $user = $env{'user.name'}.':'.$env{'user.domain'};
4770: my %rosterhash = &get('classlist',[$user],$cdom,$cnum);
4771: if ($rosterhash{$user} ne '') {
4772: my $type = (split(/:/,$rosterhash{$user}))[5];
4773: return ([],{}) if ($type eq 'auto');
4774: }
4775: }
4776: if (($cdom ne '') && ($cnum ne '')) {
4777: if (($env{"user.role.dh./$cdom/"}) || ($env{"user.role.da./$cdom/"})) {
4778: my $then=$env{'user.login.time'};
4779: my $update=$env{'user.update.time'};
4780: if (!$update) {
4781: $update = $then;
4782: }
4783: my @liveroles;
4784: foreach my $role ('dh','da') {
4785: if ($env{"user.role.$role./$cdom/"}) {
4786: my ($tstart,$tend)=split(/\./,$env{"user.role.$role./$cdom/"});
4787: my $limit = $update;
4788: if ($env{'request.role'} eq "$role./$cdom/") {
4789: $limit = $then;
4790: }
4791: my $activerole = 1;
4792: if ($tstart && $tstart>$limit) { $activerole = 0; }
4793: if ($tend && $tend <$limit) { $activerole = 0; }
4794: if ($activerole) {
4795: push(@liveroles,$role);
4796: }
4797: }
4798: }
4799: if (@liveroles) {
4800: if (&homeserver($cnum,$cdom) ne 'no_host') {
4801: my ($accessref,$accessinfo,%access_in_dom);
4802: ($roles_by_num,$description,$accessref,$accessinfo) = &get_all_adhocroles($cdom);
4803: if (ref($roles_by_num) eq 'ARRAY') {
4804: if (@{$roles_by_num}) {
4805: my %settings;
4806: if ($env{'request.course.id'} eq $cid) {
4807: foreach my $envkey (keys(%env)) {
4808: if ($envkey =~ /^\Qcourse.$cid.\E(internal\.adhoc.+)$/) {
4809: $settings{$1} = $env{$envkey};
4810: }
4811: }
4812: } else {
4813: %settings = &dump('environment',$cdom,$cnum,'internal\.adhoc');
4814: }
4815: my %setincrs;
4816: if ($settings{'internal.adhocaccess'}) {
4817: map { $setincrs{$_} = 1; } split(/,/,$settings{'internal.adhocaccess'});
4818: }
4819: my @statuses;
4820: if ($env{'environment.inststatus'}) {
4821: @statuses = split(/,/,$env{'environment.inststatus'});
4822: }
4823: my $user = $env{'user.name'}.':'.$env{'user.domain'};
4824: if (ref($accessref) eq 'HASH') {
4825: %access_in_dom = %{$accessref};
4826: }
4827: foreach my $role (@{$roles_by_num}) {
4828: my ($curraccess,@okstatus,@personnel);
4829: if ($setincrs{$role}) {
4830: ($curraccess,my $rest) = split(/=/,$settings{'internal.adhoc.'.$role});
4831: if ($curraccess eq 'status') {
4832: @okstatus = split(/\&/,$rest);
4833: } elsif (($curraccess eq 'exc') || ($curraccess eq 'inc')) {
4834: @personnel = split(/\&/,$rest);
4835: }
4836: } else {
4837: $curraccess = $access_in_dom{$role};
4838: if (ref($accessinfo) eq 'HASH') {
4839: if ($curraccess eq 'status') {
4840: if (ref($accessinfo->{$role}) eq 'ARRAY') {
4841: @okstatus = @{$accessinfo->{$role}};
4842: }
4843: } elsif (($curraccess eq 'exc') || ($curraccess eq 'inc')) {
4844: if (ref($accessinfo->{$role}) eq 'ARRAY') {
4845: @personnel = @{$accessinfo->{$role}};
4846: }
4847: }
4848: }
4849: }
4850: if ($curraccess eq 'none') {
4851: next;
4852: } elsif ($curraccess eq 'all') {
4853: push(@possroles,$role);
4854: } elsif ($curraccess eq 'dh') {
4855: if (grep(/^dh$/,@liveroles)) {
4856: push(@possroles,$role);
4857: } else {
4858: next;
4859: }
4860: } elsif ($curraccess eq 'da') {
4861: if (grep(/^da$/,@liveroles)) {
4862: push(@possroles,$role);
4863: } else {
4864: next;
4865: }
4866: } elsif ($curraccess eq 'status') {
4867: if (@okstatus) {
4868: if (!@statuses) {
4869: if (grep(/^default$/,@okstatus)) {
4870: push(@possroles,$role);
4871: }
4872: } else {
4873: foreach my $status (@okstatus) {
4874: if (grep(/^\Q$status\E$/,@statuses)) {
4875: push(@possroles,$role);
4876: last;
4877: }
4878: }
4879: }
4880: }
4881: } elsif (($curraccess eq 'exc') || ($curraccess eq 'inc')) {
4882: if (grep(/^\Q$user\E$/,@personnel)) {
4883: if ($curraccess eq 'exc') {
4884: push(@possroles,$role);
4885: }
4886: } elsif ($curraccess eq 'inc') {
4887: push(@possroles,$role);
4888: }
4889: }
4890: }
4891: }
4892: }
4893: }
4894: }
4895: }
4896: }
4897: unless (ref($description) eq 'HASH') {
4898: if (ref($roles_by_num) eq 'ARRAY') {
4899: my %desc;
4900: map { $desc{$_} = $_; } (@{$roles_by_num});
4901: $description = \%desc;
4902: } else {
4903: $description = {};
4904: }
4905: }
4906: return (\@possroles,$description);
4907: }
4908:
4909: # ----------------------------------------------------- Frontpage Announcements
4910: #
4911: #
4912:
4913: sub postannounce {
4914: my ($server,$text)=@_;
4915: unless (&allowed('psa',&host_domain($server))) { return 'refused'; }
4916: unless ($text=~/\w/) { $text=''; }
4917: return &reply('setannounce:'.&escape($text),$server);
4918: }
4919:
4920: sub getannounce {
4921:
4922: if (open(my $fh,"<",$perlvar{'lonDocRoot'}.'/announcement.txt')) {
4923: my $announcement='';
4924: while (my $line = <$fh>) { $announcement .= $line; }
4925: close($fh);
4926: if ($announcement=~/\w/) {
4927: return
4928: '<table bgcolor="#FF5555" cellpadding="5" cellspacing="3">'.
4929: '<tr><td bgcolor="#FFFFFF"><tt>'.$announcement.'</tt></td></tr></table>';
4930: } else {
4931: return '';
4932: }
4933: } else {
4934: return '';
4935: }
4936: }
4937:
4938: # ---------------------------------------------------------- Course ID routines
4939: # Deal with domain's nohist_courseid.db files
4940: #
4941:
4942: sub courseidput {
4943: my ($domain,$storehash,$coursehome,$caller) = @_;
4944: return unless (ref($storehash) eq 'HASH');
4945: my $outcome;
4946: if ($caller eq 'timeonly') {
4947: my $cids = '';
4948: foreach my $item (keys(%$storehash)) {
4949: $cids.=&escape($item).'&';
4950: }
4951: $cids=~s/\&$//;
4952: $outcome = &reply('courseidputhash:'.$domain.':'.$caller.':'.$cids,
4953: $coursehome);
4954: } else {
4955: my $items = '';
4956: foreach my $item (keys(%$storehash)) {
4957: $items.= &escape($item).'='.
4958: &freeze_escape($$storehash{$item}).'&';
4959: }
4960: $items=~s/\&$//;
4961: $outcome = &reply('courseidputhash:'.$domain.':'.$caller.':'.$items,
4962: $coursehome);
4963: }
4964: if ($outcome eq 'unknown_cmd') {
4965: my $what;
4966: foreach my $cid (keys(%$storehash)) {
4967: $what .= &escape($cid).'=';
4968: foreach my $item ('description','inst_code','owner','type') {
4969: $what .= &escape($storehash->{$cid}{$item}).':';
4970: }
4971: $what =~ s/\:$/&/;
4972: }
4973: $what =~ s/\&$//;
4974: return &reply('courseidput:'.$domain.':'.$what,$coursehome);
4975: } else {
4976: return $outcome;
4977: }
4978: }
4979:
4980: sub courseiddump {
4981: my ($domfilter,$descfilter,$sincefilter,$instcodefilter,$ownerfilter,
4982: $coursefilter,$hostidflag,$hostidref,$typefilter,$regexp_ok,
4983: $selfenrollonly,$catfilter,$showhidden,$caller,$cloner,$cc_clone,
4984: $cloneonly,$createdbefore,$createdafter,$creationcontext,$domcloner,
4985: $hasuniquecode,$reqcrsdom,$reqinstcode)=@_;
4986: my $as_hash = 1;
4987: my %returnhash;
4988: if (!$domfilter) { $domfilter=''; }
4989: my %libserv = &all_library();
4990: foreach my $tryserver (keys(%libserv)) {
4991: if ( ( $hostidflag == 1
4992: && grep(/^\Q$tryserver\E$/,@{$hostidref}) )
4993: || (!defined($hostidflag)) ) {
4994:
4995: if (($domfilter eq '') ||
4996: (&host_domain($tryserver) eq $domfilter)) {
4997: my $rep;
4998: if (grep { $_ eq $tryserver } current_machine_ids()) {
4999: $rep = LONCAPA::Lond::dump_course_id_handler(
5000: join(":", (&host_domain($tryserver), $sincefilter,
5001: &escape($descfilter), &escape($instcodefilter),
5002: &escape($ownerfilter), &escape($coursefilter),
5003: &escape($typefilter), &escape($regexp_ok),
5004: $as_hash, &escape($selfenrollonly),
5005: &escape($catfilter), $showhidden, $caller,
5006: &escape($cloner), &escape($cc_clone), $cloneonly,
5007: &escape($createdbefore), &escape($createdafter),
5008: &escape($creationcontext),$domcloner,$hasuniquecode,
5009: $reqcrsdom,&escape($reqinstcode))));
5010: } else {
5011: $rep = &reply('courseiddump:'.&host_domain($tryserver).':'.
5012: $sincefilter.':'.&escape($descfilter).':'.
5013: &escape($instcodefilter).':'.&escape($ownerfilter).
5014: ':'.&escape($coursefilter).':'.&escape($typefilter).
5015: ':'.&escape($regexp_ok).':'.$as_hash.':'.
5016: &escape($selfenrollonly).':'.&escape($catfilter).':'.
5017: $showhidden.':'.$caller.':'.&escape($cloner).':'.
5018: &escape($cc_clone).':'.$cloneonly.':'.
5019: &escape($createdbefore).':'.&escape($createdafter).':'.
5020: &escape($creationcontext).':'.$domcloner.':'.$hasuniquecode.
5021: ':'.$reqcrsdom.':'.&escape($reqinstcode),$tryserver);
5022: }
5023:
5024: my @pairs=split(/\&/,$rep);
5025: foreach my $item (@pairs) {
5026: my ($key,$value)=split(/\=/,$item,2);
5027: $key = &unescape($key);
5028: next if ($key =~ /^error: 2 /);
5029: my $result = &thaw_unescape($value);
5030: if (ref($result) eq 'HASH') {
5031: $returnhash{$key}=$result;
5032: } else {
5033: my @responses = split(/:/,$value);
5034: my @items = ('description','inst_code','owner','type');
5035: for (my $i=0; $i<@responses; $i++) {
5036: $returnhash{$key}{$items[$i]} = &unescape($responses[$i]);
5037: }
5038: }
5039: }
5040: }
5041: }
5042: }
5043: return %returnhash;
5044: }
5045:
5046: sub courselastaccess {
5047: my ($cdom,$cnum,$hostidref) = @_;
5048: my %returnhash;
5049: if ($cdom && $cnum) {
5050: my $chome = &homeserver($cnum,$cdom);
5051: if ($chome ne 'no_host') {
5052: my $rep = &reply('courselastaccess:'.$cdom.':'.$cnum,$chome);
5053: &extract_lastaccess(\%returnhash,$rep);
5054: }
5055: } else {
5056: if (!$cdom) { $cdom=''; }
5057: my %libserv = &all_library();
5058: foreach my $tryserver (keys(%libserv)) {
5059: if (ref($hostidref) eq 'ARRAY') {
5060: next unless (grep(/^\Q$tryserver\E$/,@{$hostidref}));
5061: }
5062: if (($cdom eq '') || (&host_domain($tryserver) eq $cdom)) {
5063: my $rep = &reply('courselastaccess:'.&host_domain($tryserver).':',$tryserver);
5064: &extract_lastaccess(\%returnhash,$rep);
5065: }
5066: }
5067: }
5068: return %returnhash;
5069: }
5070:
5071: sub extract_lastaccess {
5072: my ($returnhash,$rep) = @_;
5073: if (ref($returnhash) eq 'HASH') {
5074: unless ($rep eq 'unknown_command' || $rep eq 'no_such_host' ||
5075: $rep eq 'con_lost' || $rep eq 'rejected' || $rep eq 'refused' ||
5076: $rep eq '') {
5077: my @pairs=split(/\&/,$rep);
5078: foreach my $item (@pairs) {
5079: my ($key,$value)=split(/\=/,$item,2);
5080: $key = &unescape($key);
5081: next if ($key =~ /^error: 2 /);
5082: $returnhash->{$key} = &thaw_unescape($value);
5083: }
5084: }
5085: }
5086: return;
5087: }
5088:
5089: # ---------------------------------------------------------- DC e-mail
5090:
5091: sub dcmailput {
5092: my ($domain,$msgid,$message,$server)=@_;
5093: my $status = &Apache::lonnet::critical(
5094: 'dcmailput:'.$domain.':'.&escape($msgid).'='.
5095: &escape($message),$server);
5096: return $status;
5097: }
5098:
5099: sub dcmaildump {
5100: my ($dom,$startdate,$enddate,$senders) = @_;
5101: my %returnhash=();
5102:
5103: if (defined(&domain($dom,'primary'))) {
5104: my $cmd='dcmaildump:'.$dom.':'.&escape($startdate).':'.
5105: &escape($enddate).':';
5106: my @esc_senders=map { &escape($_)} @$senders;
5107: $cmd.=&escape(join('&',@esc_senders));
5108: foreach my $line (split(/\&/,&reply($cmd,&domain($dom,'primary')))) {
5109: my ($key,$value) = split(/\=/,$line,2);
5110: if (($key) && ($value)) {
5111: $returnhash{&unescape($key)} = &unescape($value);
5112: }
5113: }
5114: }
5115: return %returnhash;
5116: }
5117: # ---------------------------------------------------------- Domain roles
5118:
5119: sub get_domain_roles {
5120: my ($dom,$roles,$startdate,$enddate)=@_;
5121: if ((!defined($startdate)) || ($startdate eq '')) {
5122: $startdate = '.';
5123: }
5124: if ((!defined($enddate)) || ($enddate eq '')) {
5125: $enddate = '.';
5126: }
5127: my $rolelist;
5128: if (ref($roles) eq 'ARRAY') {
5129: $rolelist = join('&',@{$roles});
5130: }
5131: my %personnel = ();
5132:
5133: my %servers = &get_servers($dom,'library');
5134: foreach my $tryserver (keys(%servers)) {
5135: %{$personnel{$tryserver}}=();
5136: foreach my $line (split(/\&/,&reply('domrolesdump:'.$dom.':'.
5137: &escape($startdate).':'.
5138: &escape($enddate).':'.
5139: &escape($rolelist), $tryserver))) {
5140: my ($key,$value) = split(/\=/,$line,2);
5141: if (($key) && ($value)) {
5142: $personnel{$tryserver}{&unescape($key)} = &unescape($value);
5143: }
5144: }
5145: }
5146: return %personnel;
5147: }
5148:
5149: sub get_active_domroles {
5150: my ($dom,$roles) = @_;
5151: return () unless (ref($roles) eq 'ARRAY');
5152: my $now = time;
5153: my %dompersonnel = &get_domain_roles($dom,$roles,$now,$now);
5154: my %domroles;
5155: foreach my $server (keys(%dompersonnel)) {
5156: foreach my $user (sort(keys(%{$dompersonnel{$server}}))) {
5157: my ($trole,$uname,$udom,$runame,$rudom,$rsec) = split(/:/,$user);
5158: $domroles{$uname.':'.$udom} = $dompersonnel{$server}{$user};
5159: }
5160: }
5161: return %domroles;
5162: }
5163:
5164: # ----------------------------------------------------------- Interval timing
5165:
5166: {
5167: # Caches needed for speedup of navmaps
5168: # We don't want to cache this for very long at all (5 seconds at most)
5169: #
5170: # The user for whom we cache
5171: my $cachedkey='';
5172: # The cached times for this user
5173: my %cachedtimes=();
5174: # When this was last done
5175: my $cachedtime='';
5176:
5177: sub load_all_first_access {
5178: my ($uname,$udom,$ignorecache)=@_;
5179: if (($cachedkey eq $uname.':'.$udom) &&
5180: (abs($cachedtime-time)<5) && (!$env{'form.markaccess'}) &&
5181: (!$ignorecache)) {
5182: return;
5183: }
5184: $cachedtime=time;
5185: $cachedkey=$uname.':'.$udom;
5186: %cachedtimes=&dump('firstaccesstimes',$udom,$uname);
5187: }
5188:
5189: sub get_first_access {
5190: my ($type,$argsymb,$argmap,$ignorecache)=@_;
5191: my ($symb,$courseid,$udom,$uname)=&whichuser();
5192: if ($argsymb) { $symb=$argsymb; }
5193: my ($map,$id,$res)=&decode_symb($symb);
5194: if ($argmap) { $map = $argmap; }
5195: if ($type eq 'course') {
5196: $res='course';
5197: } elsif ($type eq 'map') {
5198: $res=&symbread($map);
5199: } else {
5200: $res=$symb;
5201: }
5202: &load_all_first_access($uname,$udom,$ignorecache);
5203: return $cachedtimes{"$courseid\0$res"};
5204: }
5205:
5206: sub set_first_access {
5207: my ($type,$interval)=@_;
5208: my ($symb,$courseid,$udom,$uname)=&whichuser();
5209: my ($map,$id,$res)=&decode_symb($symb);
5210: if ($type eq 'course') {
5211: $res='course';
5212: } elsif ($type eq 'map') {
5213: $res=&symbread($map);
5214: } else {
5215: $res=$symb;
5216: }
5217: $cachedkey='';
5218: my $firstaccess=&get_first_access($type,$symb,$map);
5219: if (!$firstaccess) {
5220: my $start = time;
5221: my $putres = &put('firstaccesstimes',{"$courseid\0$res"=>$start},
5222: $udom,$uname);
5223: if ($putres eq 'ok') {
5224: &put('timerinterval',{"$courseid\0$res"=>$interval},
5225: $udom,$uname);
5226: &appenv(
5227: {
5228: 'course.'.$courseid.'.firstaccess.'.$res => $start,
5229: 'course.'.$courseid.'.timerinterval.'.$res => $interval,
5230: }
5231: );
5232: if (($cachedtime) && (abs($start-$cachedtime) < 5)) {
5233: $cachedtimes{"$courseid\0$res"} = $start;
5234: }
5235: }
5236: return $putres;
5237: }
5238: return 'already_set';
5239: }
5240: }
5241:
5242: # --------------------------------------------- Set Expire Date for Spreadsheet
5243:
5244: sub expirespread {
5245: my ($uname,$udom,$stype,$usymb)=@_;
5246: my $cid=$env{'request.course.id'};
5247: if ($cid) {
5248: my $now=time;
5249: my $key=$uname.':'.$udom.':'.$stype.':'.$usymb;
5250: return &reply('put:'.$env{'course.'.$cid.'.domain'}.':'.
5251: $env{'course.'.$cid.'.num'}.
5252: ':nohist_expirationdates:'.
5253: &escape($key).'='.$now,
5254: $env{'course.'.$cid.'.home'})
5255: }
5256: return 'ok';
5257: }
5258:
5259: # ----------------------------------------------------- Devalidate Spreadsheets
5260:
5261: sub devalidate {
5262: my ($symb,$uname,$udom)=@_;
5263: my $cid=$env{'request.course.id'};
5264: if ($cid) {
5265: # delete the stored spreadsheets for
5266: # - the student level sheet of this user in course's homespace
5267: # - the assessment level sheet for this resource
5268: # for this user in user's homespace
5269: # - current conditional state info
5270: my $key=$uname.':'.$udom.':';
5271: my $status=
5272: &del('nohist_calculatedsheets',
5273: [$key.'studentcalc:'],
5274: $env{'course.'.$cid.'.domain'},
5275: $env{'course.'.$cid.'.num'})
5276: .' '.
5277: &del('nohist_calculatedsheets_'.$cid,
5278: [$key.'assesscalc:'.$symb],$udom,$uname);
5279: unless ($status eq 'ok ok') {
5280: &logthis('Could not devalidate spreadsheet '.
5281: $uname.' at '.$udom.' for '.
5282: $symb.': '.$status);
5283: }
5284: &delenv('user.state.'.$cid);
5285: }
5286: }
5287:
5288: sub get_scalar {
5289: my ($string,$end) = @_;
5290: my $value;
5291: if ($$string =~ s/^([^&]*?)($end)/$2/) {
5292: $value = $1;
5293: } elsif ($$string =~ s/^([^&]*?)&//) {
5294: $value = $1;
5295: }
5296: return &unescape($value);
5297: }
5298:
5299: sub array2str {
5300: my (@array) = @_;
5301: my $result=&arrayref2str(\@array);
5302: $result=~s/^__ARRAY_REF__//;
5303: $result=~s/__END_ARRAY_REF__$//;
5304: return $result;
5305: }
5306:
5307: sub arrayref2str {
5308: my ($arrayref) = @_;
5309: my $result='__ARRAY_REF__';
5310: foreach my $elem (@$arrayref) {
5311: if(ref($elem) eq 'ARRAY') {
5312: $result.=&arrayref2str($elem).'&';
5313: } elsif(ref($elem) eq 'HASH') {
5314: $result.=&hashref2str($elem).'&';
5315: } elsif(ref($elem)) {
5316: #print("Got a ref of ".(ref($elem))." skipping.");
5317: } else {
5318: $result.=&escape($elem).'&';
5319: }
5320: }
5321: $result=~s/\&$//;
5322: $result .= '__END_ARRAY_REF__';
5323: return $result;
5324: }
5325:
5326: sub hash2str {
5327: my (%hash) = @_;
5328: my $result=&hashref2str(\%hash);
5329: $result=~s/^__HASH_REF__//;
5330: $result=~s/__END_HASH_REF__$//;
5331: return $result;
5332: }
5333:
5334: sub hashref2str {
5335: my ($hashref)=@_;
5336: my $result='__HASH_REF__';
5337: foreach my $key (sort(keys(%$hashref))) {
5338: if (ref($key) eq 'ARRAY') {
5339: $result.=&arrayref2str($key).'=';
5340: } elsif (ref($key) eq 'HASH') {
5341: $result.=&hashref2str($key).'=';
5342: } elsif (ref($key)) {
5343: $result.='=';
5344: #print("Got a ref of ".(ref($key))." skipping.");
5345: } else {
5346: if (defined($key)) {$result.=&escape($key).'=';} else { last; }
5347: }
5348:
5349: if(ref($hashref->{$key}) eq 'ARRAY') {
5350: $result.=&arrayref2str($hashref->{$key}).'&';
5351: } elsif(ref($hashref->{$key}) eq 'HASH') {
5352: $result.=&hashref2str($hashref->{$key}).'&';
5353: } elsif(ref($hashref->{$key})) {
5354: $result.='&';
5355: #print("Got a ref of ".(ref($hashref->{$key}))." skipping.");
5356: } else {
5357: $result.=&escape($hashref->{$key}).'&';
5358: }
5359: }
5360: $result=~s/\&$//;
5361: $result .= '__END_HASH_REF__';
5362: return $result;
5363: }
5364:
5365: sub str2hash {
5366: my ($string)=@_;
5367: my ($hash)=&str2hashref('__HASH_REF__'.$string.'__END_HASH_REF__');
5368: return %$hash;
5369: }
5370:
5371: sub str2hashref {
5372: my ($string) = @_;
5373:
5374: my %hash;
5375:
5376: if($string !~ /^__HASH_REF__/) {
5377: if (! ($string eq '' || !defined($string))) {
5378: $hash{'error'}='Not hash reference';
5379: }
5380: return (\%hash, $string);
5381: }
5382:
5383: $string =~ s/^__HASH_REF__//;
5384:
5385: while($string !~ /^__END_HASH_REF__/) {
5386: #key
5387: my $key='';
5388: if($string =~ /^__HASH_REF__/) {
5389: ($key, $string)=&str2hashref($string);
5390: if(defined($key->{'error'})) {
5391: $hash{'error'}='Bad data';
5392: return (\%hash, $string);
5393: }
5394: } elsif($string =~ /^__ARRAY_REF__/) {
5395: ($key, $string)=&str2arrayref($string);
5396: if($key->[0] eq 'Array reference error') {
5397: $hash{'error'}='Bad data';
5398: return (\%hash, $string);
5399: }
5400: } else {
5401: $string =~ s/^(.*?)=//;
5402: $key=&unescape($1);
5403: }
5404: $string =~ s/^=//;
5405:
5406: #value
5407: my $value='';
5408: if($string =~ /^__HASH_REF__/) {
5409: ($value, $string)=&str2hashref($string);
5410: if(defined($value->{'error'})) {
5411: $hash{'error'}='Bad data';
5412: return (\%hash, $string);
5413: }
5414: } elsif($string =~ /^__ARRAY_REF__/) {
5415: ($value, $string)=&str2arrayref($string);
5416: if($value->[0] eq 'Array reference error') {
5417: $hash{'error'}='Bad data';
5418: return (\%hash, $string);
5419: }
5420: } else {
5421: $value=&get_scalar(\$string,'__END_HASH_REF__');
5422: }
5423: $string =~ s/^&//;
5424:
5425: $hash{$key}=$value;
5426: }
5427:
5428: $string =~ s/^__END_HASH_REF__//;
5429:
5430: return (\%hash, $string);
5431: }
5432:
5433: sub str2array {
5434: my ($string)=@_;
5435: my ($array)=&str2arrayref('__ARRAY_REF__'.$string.'__END_ARRAY_REF__');
5436: return @$array;
5437: }
5438:
5439: sub str2arrayref {
5440: my ($string) = @_;
5441: my @array;
5442:
5443: if($string !~ /^__ARRAY_REF__/) {
5444: if (! ($string eq '' || !defined($string))) {
5445: $array[0]='Array reference error';
5446: }
5447: return (\@array, $string);
5448: }
5449:
5450: $string =~ s/^__ARRAY_REF__//;
5451:
5452: while($string !~ /^__END_ARRAY_REF__/) {
5453: my $value='';
5454: if($string =~ /^__HASH_REF__/) {
5455: ($value, $string)=&str2hashref($string);
5456: if(defined($value->{'error'})) {
5457: $array[0] ='Array reference error';
5458: return (\@array, $string);
5459: }
5460: } elsif($string =~ /^__ARRAY_REF__/) {
5461: ($value, $string)=&str2arrayref($string);
5462: if($value->[0] eq 'Array reference error') {
5463: $array[0] ='Array reference error';
5464: return (\@array, $string);
5465: }
5466: } else {
5467: $value=&get_scalar(\$string,'__END_ARRAY_REF__');
5468: }
5469: $string =~ s/^&//;
5470:
5471: push(@array, $value);
5472: }
5473:
5474: $string =~ s/^__END_ARRAY_REF__//;
5475:
5476: return (\@array, $string);
5477: }
5478:
5479: # -------------------------------------------------------------------Temp Store
5480:
5481: sub tmpreset {
5482: my ($symb,$namespace,$domain,$stuname) = @_;
5483: if (!$symb) {
5484: $symb=&symbread();
5485: if (!$symb) { $symb= $env{'request.url'}; }
5486: }
5487: $symb=escape($symb);
5488:
5489: if (!$namespace) { $namespace=$env{'request.state'}; }
5490: $namespace=~s/\//\_/g;
5491: $namespace=~s/\W//g;
5492:
5493: if (!$domain) { $domain=$env{'user.domain'}; }
5494: if (!$stuname) { $stuname=$env{'user.name'}; }
5495: if ($domain eq 'public' && $stuname eq 'public') {
5496: $stuname=$ENV{'REMOTE_ADDR'};
5497: }
5498: my $path=LONCAPA::tempdir();
5499: my %hash;
5500: if (tie(%hash,'GDBM_File',
5501: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
5502: &GDBM_WRCREAT(),0640)) {
5503: foreach my $key (keys(%hash)) {
5504: if ($key=~ /:$symb/) {
5505: delete($hash{$key});
5506: }
5507: }
5508: }
5509: }
5510:
5511: sub tmpstore {
5512: my ($storehash,$symb,$namespace,$domain,$stuname) = @_;
5513:
5514: if (!$symb) {
5515: $symb=&symbread();
5516: if (!$symb) { $symb= $env{'request.url'}; }
5517: }
5518: $symb=escape($symb);
5519:
5520: if (!$namespace) {
5521: # I don't think we would ever want to store this for a course.
5522: # it seems this will only be used if we don't have a course.
5523: #$namespace=$env{'request.course.id'};
5524: #if (!$namespace) {
5525: $namespace=$env{'request.state'};
5526: #}
5527: }
5528: $namespace=~s/\//\_/g;
5529: $namespace=~s/\W//g;
5530: if (!$domain) { $domain=$env{'user.domain'}; }
5531: if (!$stuname) { $stuname=$env{'user.name'}; }
5532: if ($domain eq 'public' && $stuname eq 'public') {
5533: $stuname=$ENV{'REMOTE_ADDR'};
5534: }
5535: my $now=time;
5536: my %hash;
5537: my $path=LONCAPA::tempdir();
5538: if (tie(%hash,'GDBM_File',
5539: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
5540: &GDBM_WRCREAT(),0640)) {
5541: $hash{"version:$symb"}++;
5542: my $version=$hash{"version:$symb"};
5543: my $allkeys='';
5544: foreach my $key (keys(%$storehash)) {
5545: $allkeys.=$key.':';
5546: $hash{"$version:$symb:$key"}=&freeze_escape($$storehash{$key});
5547: }
5548: $hash{"$version:$symb:timestamp"}=$now;
5549: $allkeys.='timestamp';
5550: $hash{"$version:keys:$symb"}=$allkeys;
5551: if (untie(%hash)) {
5552: return 'ok';
5553: } else {
5554: return "error:$!";
5555: }
5556: } else {
5557: return "error:$!";
5558: }
5559: }
5560:
5561: # -----------------------------------------------------------------Temp Restore
5562:
5563: sub tmprestore {
5564: my ($symb,$namespace,$domain,$stuname) = @_;
5565:
5566: if (!$symb) {
5567: $symb=&symbread();
5568: if (!$symb) { $symb= $env{'request.url'}; }
5569: }
5570: $symb=escape($symb);
5571:
5572: if (!$namespace) { $namespace=$env{'request.state'}; }
5573:
5574: if (!$domain) { $domain=$env{'user.domain'}; }
5575: if (!$stuname) { $stuname=$env{'user.name'}; }
5576: if ($domain eq 'public' && $stuname eq 'public') {
5577: $stuname=$ENV{'REMOTE_ADDR'};
5578: }
5579: my %returnhash;
5580: $namespace=~s/\//\_/g;
5581: $namespace=~s/\W//g;
5582: my %hash;
5583: my $path=LONCAPA::tempdir();
5584: if (tie(%hash,'GDBM_File',
5585: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
5586: &GDBM_READER(),0640)) {
5587: my $version=$hash{"version:$symb"};
5588: $returnhash{'version'}=$version;
5589: my $scope;
5590: for ($scope=1;$scope<=$version;$scope++) {
5591: my $vkeys=$hash{"$scope:keys:$symb"};
5592: my @keys=split(/:/,$vkeys);
5593: my $key;
5594: $returnhash{"$scope:keys"}=$vkeys;
5595: foreach $key (@keys) {
5596: $returnhash{"$scope:$key"}=&thaw_unescape($hash{"$scope:$symb:$key"});
5597: $returnhash{"$key"}=&thaw_unescape($hash{"$scope:$symb:$key"});
5598: }
5599: }
5600: if (!(untie(%hash))) {
5601: return "error:$!";
5602: }
5603: } else {
5604: return "error:$!";
5605: }
5606: return %returnhash;
5607: }
5608:
5609: # ----------------------------------------------------------------------- Store
5610:
5611: sub store {
5612: my ($storehash,$symb,$namespace,$domain,$stuname,$laststore) = @_;
5613: my $home='';
5614:
5615: if ($stuname) { $home=&homeserver($stuname,$domain); }
5616:
5617: $symb=&symbclean($symb);
5618: if (!$symb) { unless ($symb=&symbread()) { return ''; } }
5619:
5620: if (!$domain) { $domain=$env{'user.domain'}; }
5621: if (!$stuname) { $stuname=$env{'user.name'}; }
5622:
5623: &devalidate($symb,$stuname,$domain);
5624:
5625: $symb=escape($symb);
5626: if (!$namespace) {
5627: unless ($namespace=$env{'request.course.id'}) {
5628: return '';
5629: }
5630: }
5631: if (!$home) { $home=$env{'user.home'}; }
5632:
5633: $$storehash{'ip'}=$ENV{'REMOTE_ADDR'};
5634: $$storehash{'host'}=$perlvar{'lonHostID'};
5635:
5636: my $namevalue='';
5637: foreach my $key (keys(%$storehash)) {
5638: $namevalue.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
5639: }
5640: $namevalue=~s/\&$//;
5641: &courselog($symb.':'.$stuname.':'.$domain.':STORE:'.$namevalue);
5642: return reply("store:$domain:$stuname:$namespace:$symb:$namevalue:$laststore","$home");
5643: }
5644:
5645: # -------------------------------------------------------------- Critical Store
5646:
5647: sub cstore {
5648: my ($storehash,$symb,$namespace,$domain,$stuname,$laststore) = @_;
5649: my $home='';
5650:
5651: if ($stuname) { $home=&homeserver($stuname,$domain); }
5652:
5653: $symb=&symbclean($symb);
5654: if (!$symb) { unless ($symb=&symbread()) { return ''; } }
5655:
5656: if (!$domain) { $domain=$env{'user.domain'}; }
5657: if (!$stuname) { $stuname=$env{'user.name'}; }
5658:
5659: &devalidate($symb,$stuname,$domain);
5660:
5661: $symb=escape($symb);
5662: if (!$namespace) {
5663: unless ($namespace=$env{'request.course.id'}) {
5664: return '';
5665: }
5666: }
5667: if (!$home) { $home=$env{'user.home'}; }
5668:
5669: $$storehash{'ip'}=$ENV{'REMOTE_ADDR'};
5670: $$storehash{'host'}=$perlvar{'lonHostID'};
5671:
5672: my $namevalue='';
5673: foreach my $key (keys(%$storehash)) {
5674: $namevalue.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
5675: }
5676: $namevalue=~s/\&$//;
5677: &courselog($symb.':'.$stuname.':'.$domain.':CSTORE:'.$namevalue);
5678: return critical
5679: ("store:$domain:$stuname:$namespace:$symb:$namevalue:$laststore","$home");
5680: }
5681:
5682: # --------------------------------------------------------------------- Restore
5683:
5684: sub restore {
5685: my ($symb,$namespace,$domain,$stuname) = @_;
5686: my $home='';
5687:
5688: if ($stuname) { $home=&homeserver($stuname,$domain); }
5689:
5690: if (!$symb) {
5691: return if ($namespace eq 'courserequests');
5692: unless ($symb=escape(&symbread())) { return ''; }
5693: } else {
5694: unless ($namespace eq 'courserequests') {
5695: $symb=&escape(&symbclean($symb));
5696: }
5697: }
5698: if (!$namespace) {
5699: unless ($namespace=$env{'request.course.id'}) {
5700: return '';
5701: }
5702: }
5703: if (!$domain) { $domain=$env{'user.domain'}; }
5704: if (!$stuname) { $stuname=$env{'user.name'}; }
5705: if (!$home) { $home=$env{'user.home'}; }
5706: my $answer=&reply("restore:$domain:$stuname:$namespace:$symb","$home");
5707:
5708: my %returnhash=();
5709: foreach my $line (split(/\&/,$answer)) {
5710: my ($name,$value)=split(/\=/,$line);
5711: $returnhash{&unescape($name)}=&thaw_unescape($value);
5712: }
5713: my $version;
5714: for ($version=1;$version<=$returnhash{'version'};$version++) {
5715: foreach my $item (split(/\:/,$returnhash{$version.':keys'})) {
5716: $returnhash{$item}=$returnhash{$version.':'.$item};
5717: }
5718: }
5719: return %returnhash;
5720: }
5721:
5722: # ---------------------------------------------------------- Course Description
5723: #
5724: #
5725:
5726: sub coursedescription {
5727: my ($courseid,$args)=@_;
5728: $courseid=~s/^\///;
5729: $courseid=~s/\_/\//g;
5730: my ($cdomain,$cnum)=split(/\//,$courseid);
5731: my $chome=&homeserver($cnum,$cdomain);
5732: my $normalid=$cdomain.'_'.$cnum;
5733: # need to always cache even if we get errors otherwise we keep
5734: # trying and trying and trying to get the course description.
5735: my %envhash=();
5736: my %returnhash=();
5737:
5738: my $expiretime=600;
5739: if ($env{'request.course.id'} eq $normalid) {
5740: $expiretime=120;
5741: }
5742:
5743: my $prefix='course.'.$cdomain.'_'.$cnum.'.';
5744: if (!$args->{'freshen_cache'}
5745: && ((time-$env{$prefix.'last_cache'}) < $expiretime) ) {
5746: foreach my $key (keys(%env)) {
5747: next if ($key !~ /^\Q$prefix\E(.*)/);
5748: my ($setting) = $1;
5749: $returnhash{$setting} = $env{$key};
5750: }
5751: return %returnhash;
5752: }
5753:
5754: # get the data again
5755:
5756: if (!$args->{'one_time'}) {
5757: $envhash{'course.'.$normalid.'.last_cache'}=time;
5758: }
5759:
5760: if ($chome ne 'no_host') {
5761: %returnhash=&dump('environment',$cdomain,$cnum);
5762: if (!exists($returnhash{'con_lost'})) {
5763: my $username = $env{'user.name'}; # Defult username
5764: if(defined $args->{'user'}) {
5765: $username = $args->{'user'};
5766: }
5767: $returnhash{'home'}= $chome;
5768: $returnhash{'domain'} = $cdomain;
5769: $returnhash{'num'} = $cnum;
5770: if (!defined($returnhash{'type'})) {
5771: $returnhash{'type'} = 'Course';
5772: }
5773: while (my ($name,$value) = each %returnhash) {
5774: $envhash{'course.'.$normalid.'.'.$name}=$value;
5775: }
5776: $returnhash{'url'}=&clutter($returnhash{'url'});
5777: $returnhash{'fn'}=LONCAPA::tempdir() .
5778: $username.'_'.$cdomain.'_'.$cnum;
5779: $envhash{'course.'.$normalid.'.home'}=$chome;
5780: $envhash{'course.'.$normalid.'.domain'}=$cdomain;
5781: $envhash{'course.'.$normalid.'.num'}=$cnum;
5782: }
5783: }
5784: if (!$args->{'one_time'}) {
5785: &appenv(\%envhash);
5786: }
5787: return %returnhash;
5788: }
5789:
5790: sub update_released_required {
5791: my ($needsrelease,$cdom,$cnum,$chome,$cid) = @_;
5792: if ($cdom eq '' || $cnum eq '' || $chome eq '' || $cid eq '') {
5793: $cid = $env{'request.course.id'};
5794: $cdom = $env{'course.'.$cid.'.domain'};
5795: $cnum = $env{'course.'.$cid.'.num'};
5796: $chome = $env{'course.'.$cid.'.home'};
5797: }
5798: if ($needsrelease) {
5799: my %curr_reqd_hash = &userenvironment($cdom,$cnum,'internal.releaserequired');
5800: my $needsupdate;
5801: if ($curr_reqd_hash{'internal.releaserequired'} eq '') {
5802: $needsupdate = 1;
5803: } else {
5804: my ($currmajor,$currminor) = split(/\./,$curr_reqd_hash{'internal.releaserequired'});
5805: my ($needsmajor,$needsminor) = split(/\./,$needsrelease);
5806: if (($currmajor < $needsmajor) || ($currmajor == $needsmajor && $currminor < $needsminor)) {
5807: $needsupdate = 1;
5808: }
5809: }
5810: if ($needsupdate) {
5811: my %needshash = (
5812: 'internal.releaserequired' => $needsrelease,
5813: );
5814: my $putresult = &put('environment',\%needshash,$cdom,$cnum);
5815: if ($putresult eq 'ok') {
5816: &appenv({'course.'.$cid.'.internal.releaserequired' => $needsrelease});
5817: my %crsinfo = &courseiddump($cdom,'.',1,'.','.',$cnum,undef,undef,'.');
5818: if (ref($crsinfo{$cid}) eq 'HASH') {
5819: $crsinfo{$cid}{'releaserequired'} = $needsrelease;
5820: &courseidput($cdom,\%crsinfo,$chome,'notime');
5821: }
5822: }
5823: }
5824: }
5825: return;
5826: }
5827:
5828: # -------------------------------------------------See if a user is privileged
5829:
5830: sub privileged {
5831: my ($username,$domain,$possdomains,$possroles)=@_;
5832: my $now = time;
5833: my $roles;
5834: if (ref($possroles) eq 'ARRAY') {
5835: $roles = $possroles;
5836: } else {
5837: $roles = ['dc','su'];
5838: }
5839: if (ref($possdomains) eq 'ARRAY') {
5840: my %privileged = &privileged_by_domain($possdomains,$roles);
5841: foreach my $dom (@{$possdomains}) {
5842: if (($username =~ /^$match_username$/) && ($domain =~ /^$match_domain$/) &&
5843: (ref($privileged{$dom}) eq 'HASH')) {
5844: foreach my $role (@{$roles}) {
5845: if (ref($privileged{$dom}{$role}) eq 'HASH') {
5846: if (exists($privileged{$dom}{$role}{$username.':'.$domain})) {
5847: my ($end,$start) = split(/:/,$privileged{$dom}{$role}{$username.':'.$domain});
5848: return 1 unless (($end && $end < $now) ||
5849: ($start && $start > $now));
5850: }
5851: }
5852: }
5853: }
5854: }
5855: } else {
5856: my %rolesdump = &dump("roles", $domain, $username) or return 0;
5857: my $now = time;
5858:
5859: for my $role (@rolesdump{grep { ! /^rolesdef_/ } keys(%rolesdump)}) {
5860: my ($trole, $tend, $tstart) = split(/_/, $role);
5861: if (grep(/^\Q$trole\E$/,@{$roles})) {
5862: return 1 unless ($tend && $tend < $now)
5863: or ($tstart && $tstart > $now);
5864: }
5865: }
5866: }
5867: return 0;
5868: }
5869:
5870: sub privileged_by_domain {
5871: my ($domains,$roles) = @_;
5872: my %privileged = ();
5873: my $cachetime = 60*60*24;
5874: my $now = time;
5875: unless ((ref($domains) eq 'ARRAY') && (ref($roles) eq 'ARRAY')) {
5876: return %privileged;
5877: }
5878: foreach my $dom (@{$domains}) {
5879: next if (ref($privileged{$dom}) eq 'HASH');
5880: my $needroles;
5881: foreach my $role (@{$roles}) {
5882: my ($result,$cached)=&is_cached_new('priv_'.$role,$dom);
5883: if (defined($cached)) {
5884: if (ref($result) eq 'HASH') {
5885: $privileged{$dom}{$role} = $result;
5886: }
5887: } else {
5888: $needroles = 1;
5889: }
5890: }
5891: if ($needroles) {
5892: my %dompersonnel = &get_domain_roles($dom,$roles);
5893: $privileged{$dom} = {};
5894: foreach my $server (keys(%dompersonnel)) {
5895: if (ref($dompersonnel{$server}) eq 'HASH') {
5896: foreach my $item (keys(%{$dompersonnel{$server}})) {
5897: my ($trole,$uname,$udom,$rest) = split(/:/,$item,4);
5898: my ($end,$start) = split(/:/,$dompersonnel{$server}{$item});
5899: next if ($end && $end < $now);
5900: $privileged{$dom}{$trole}{$uname.':'.$udom} =
5901: $dompersonnel{$server}{$item};
5902: }
5903: }
5904: }
5905: if (ref($privileged{$dom}) eq 'HASH') {
5906: foreach my $role (@{$roles}) {
5907: if (ref($privileged{$dom}{$role}) eq 'HASH') {
5908: &do_cache_new('priv_'.$role,$dom,$privileged{$dom}{$role},$cachetime);
5909: } else {
5910: my %hash = ();
5911: &do_cache_new('priv_'.$role,$dom,\%hash,$cachetime);
5912: }
5913: }
5914: }
5915: }
5916: }
5917: return %privileged;
5918: }
5919:
5920: # -------------------------------------------------------- Get user privileges
5921:
5922: sub rolesinit {
5923: my ($domain, $username) = @_;
5924: my %userroles = ('user.login.time' => time);
5925: my %rolesdump = &dump("roles", $domain, $username) or return \%userroles;
5926:
5927: # firstaccess and timerinterval are related to timed maps/resources.
5928: # also, blocking can be triggered by an activating timer
5929: # it's saved in the user's %env.
5930: my %firstaccess = &dump('firstaccesstimes', $domain, $username);
5931: my %timerinterval = &dump('timerinterval', $domain, $username);
5932: my (%coursetimerstarts, %firstaccchk, %firstaccenv, %coursetimerintervals,
5933: %timerintchk, %timerintenv);
5934:
5935: foreach my $key (keys(%firstaccess)) {
5936: my ($cid, $rest) = split(/\0/, $key);
5937: $coursetimerstarts{$cid}{$rest} = $firstaccess{$key};
5938: }
5939:
5940: foreach my $key (keys(%timerinterval)) {
5941: my ($cid,$rest) = split(/\0/,$key);
5942: $coursetimerintervals{$cid}{$rest} = $timerinterval{$key};
5943: }
5944:
5945: my %allroles=();
5946: my %allgroups=();
5947:
5948: for my $area (grep { ! /^rolesdef_/ } keys(%rolesdump)) {
5949: my $role = $rolesdump{$area};
5950: $area =~ s/\_\w\w$//;
5951:
5952: my ($trole, $tend, $tstart, $group_privs);
5953:
5954: if ($role =~ /^cr/) {
5955: # Custom role, defined by a user
5956: # e.g., user.role.cr/msu/smith/mynewrole
5957: if ($role =~ m|^(cr/$match_domain/$match_username/[a-zA-Z0-9]+)_(.*)$|) {
5958: $trole = $1;
5959: ($tend, $tstart) = split('_', $2);
5960: } else {
5961: $trole = $role;
5962: }
5963: } elsif ($role =~ m|^gr/|) {
5964: # Role of member in a group, defined within a course/community
5965: # e.g., user.role.gr/msu/04935610a19ee4a5fmsul1/leopards
5966: ($trole, $tend, $tstart) = split(/_/, $role);
5967: next if $tstart eq '-1';
5968: ($trole, $group_privs) = split(/\//, $trole);
5969: $group_privs = &unescape($group_privs);
5970: } else {
5971: # Just a normal role, defined in roles.tab
5972: ($trole, $tend, $tstart) = split(/_/,$role);
5973: }
5974:
5975: my %new_role = &set_arearole($trole,$area,$tstart,$tend,$domain,
5976: $username);
5977: @userroles{keys(%new_role)} = @new_role{keys(%new_role)};
5978:
5979: # role expired or not available yet?
5980: $trole = '' if ($tend != 0 && $tend < $userroles{'user.login.time'}) or
5981: ($tstart != 0 && $tstart > $userroles{'user.login.time'});
5982:
5983: next if $area eq '' or $trole eq '';
5984:
5985: my $spec = "$trole.$area";
5986: my ($tdummy, $tdomain, $trest) = split(/\//, $area);
5987:
5988: if ($trole =~ /^cr\//) {
5989: # Custom role, defined by a user
5990: &custom_roleprivs(\%allroles,$trole,$tdomain,$trest,$spec,$area);
5991: } elsif ($trole eq 'gr') {
5992: # Role of a member in a group, defined within a course/community
5993: &group_roleprivs(\%allgroups,$area,$group_privs,$tend,$tstart);
5994: next;
5995: } else {
5996: # Normal role, defined in roles.tab
5997: &standard_roleprivs(\%allroles,$trole,$tdomain,$spec,$trest,$area);
5998: }
5999:
6000: my $cid = $tdomain.'_'.$trest;
6001: unless ($firstaccchk{$cid}) {
6002: if (ref($coursetimerstarts{$cid}) eq 'HASH') {
6003: foreach my $item (keys(%{$coursetimerstarts{$cid}})) {
6004: $firstaccenv{'course.'.$cid.'.firstaccess.'.$item} =
6005: $coursetimerstarts{$cid}{$item};
6006: }
6007: }
6008: $firstaccchk{$cid} = 1;
6009: }
6010: unless ($timerintchk{$cid}) {
6011: if (ref($coursetimerintervals{$cid}) eq 'HASH') {
6012: foreach my $item (keys(%{$coursetimerintervals{$cid}})) {
6013: $timerintenv{'course.'.$cid.'.timerinterval.'.$item} =
6014: $coursetimerintervals{$cid}{$item};
6015: }
6016: }
6017: $timerintchk{$cid} = 1;
6018: }
6019: }
6020:
6021: @userroles{'user.author','user.adv','user.rar'} = &set_userprivs(\%userroles,
6022: \%allroles, \%allgroups);
6023: $env{'user.adv'} = $userroles{'user.adv'};
6024: $env{'user.rar'} = $userroles{'user.rar'};
6025:
6026: return (\%userroles,\%firstaccenv,\%timerintenv);
6027: }
6028:
6029: sub set_arearole {
6030: my ($trole,$area,$tstart,$tend,$domain,$username,$nolog) = @_;
6031: unless ($nolog) {
6032: # log the associated role with the area
6033: &userrolelog($trole,$username,$domain,$area,$tstart,$tend);
6034: }
6035: return ('user.role.'.$trole.'.'.$area => $tstart.'.'.$tend);
6036: }
6037:
6038: sub custom_roleprivs {
6039: my ($allroles,$trole,$tdomain,$trest,$spec,$area) = @_;
6040: my ($rdummy,$rdomain,$rauthor,$rrole)=split(/\//,$trole);
6041: my $homsvr = &homeserver($rauthor,$rdomain);
6042: if (&hostname($homsvr) ne '') {
6043: my ($rdummy,$roledef)=
6044: &get('roles',["rolesdef_$rrole"],$rdomain,$rauthor);
6045: if (($rdummy ne 'con_lost') && ($roledef ne '')) {
6046: my ($syspriv,$dompriv,$coursepriv)=split(/\_/,$roledef);
6047: if (defined($syspriv)) {
6048: if ($trest =~ /^$match_community$/) {
6049: $syspriv =~ s/bre\&S//;
6050: }
6051: $$allroles{'cm./'}.=':'.$syspriv;
6052: $$allroles{$spec.'./'}.=':'.$syspriv;
6053: }
6054: if ($tdomain ne '') {
6055: if (defined($dompriv)) {
6056: $$allroles{'cm./'.$tdomain.'/'}.=':'.$dompriv;
6057: $$allroles{$spec.'./'.$tdomain.'/'}.=':'.$dompriv;
6058: }
6059: if (($trest ne '') && (defined($coursepriv))) {
6060: if ($trole =~ m{^cr/$tdomain/$tdomain\Q-domainconfig\E/([^/]+)$}) {
6061: my $rolename = $1;
6062: $coursepriv = &course_adhocrole_privs($rolename,$tdomain,$trest,$coursepriv);
6063: }
6064: $$allroles{'cm.'.$area}.=':'.$coursepriv;
6065: $$allroles{$spec.'.'.$area}.=':'.$coursepriv;
6066: }
6067: }
6068: }
6069: }
6070: }
6071:
6072: sub course_adhocrole_privs {
6073: my ($rolename,$cdom,$cnum,$coursepriv) = @_;
6074: my %overrides = &get('environment',["internal.adhocpriv.$rolename"],$cdom,$cnum);
6075: if ($overrides{"internal.adhocpriv.$rolename"}) {
6076: my (%currprivs,%storeprivs);
6077: foreach my $item (split(/:/,$coursepriv)) {
6078: my ($priv,$restrict) = split(/\&/,$item);
6079: $currprivs{$priv} = $restrict;
6080: }
6081: my (%possadd,%possremove,%full);
6082: foreach my $item (split(/\:/,$Apache::lonnet::pr{'cr:c'})) {
6083: my ($priv,$restrict)=split(/\&/,$item);
6084: $full{$priv} = $restrict;
6085: }
6086: foreach my $item (split(/,/,$overrides{"internal.adhocpriv.$rolename"})) {
6087: next if ($item eq '');
6088: my ($rule,$rest) = split(/=/,$item);
6089: next unless (($rule eq 'off') || ($rule eq 'on'));
6090: foreach my $priv (split(/:/,$rest)) {
6091: if ($priv ne '') {
6092: if ($rule eq 'off') {
6093: $possremove{$priv} = 1;
6094: } else {
6095: $possadd{$priv} = 1;
6096: }
6097: }
6098: }
6099: }
6100: foreach my $priv (sort(keys(%full))) {
6101: if (exists($currprivs{$priv})) {
6102: unless (exists($possremove{$priv})) {
6103: $storeprivs{$priv} = $currprivs{$priv};
6104: }
6105: } elsif (exists($possadd{$priv})) {
6106: $storeprivs{$priv} = $full{$priv};
6107: }
6108: }
6109: $coursepriv = ':'.join(':',map { $_.'&'.$storeprivs{$_}; } sort(keys(%storeprivs)));
6110: }
6111: return $coursepriv;
6112: }
6113:
6114: sub group_roleprivs {
6115: my ($allgroups,$area,$group_privs,$tend,$tstart) = @_;
6116: my $access = 1;
6117: my $now = time;
6118: if (($tend!=0) && ($tend<$now)) { $access = 0; }
6119: if (($tstart!=0) && ($tstart>$now)) { $access=0; }
6120: if ($access) {
6121: my ($course,$group) = ($area =~ m|(/$match_domain/$match_courseid)/([^/]+)$|);
6122: $$allgroups{$course}{$group} .=':'.$group_privs;
6123: }
6124: }
6125:
6126: sub standard_roleprivs {
6127: my ($allroles,$trole,$tdomain,$spec,$trest,$area) = @_;
6128: if (defined($pr{$trole.':s'})) {
6129: $$allroles{'cm./'}.=':'.$pr{$trole.':s'};
6130: $$allroles{$spec.'./'}.=':'.$pr{$trole.':s'};
6131: }
6132: if ($tdomain ne '') {
6133: if (defined($pr{$trole.':d'})) {
6134: $$allroles{'cm./'.$tdomain.'/'}.=':'.$pr{$trole.':d'};
6135: $$allroles{$spec.'./'.$tdomain.'/'}.=':'.$pr{$trole.':d'};
6136: }
6137: if (($trest ne '') && (defined($pr{$trole.':c'}))) {
6138: $$allroles{'cm.'.$area}.=':'.$pr{$trole.':c'};
6139: $$allroles{$spec.'.'.$area}.=':'.$pr{$trole.':c'};
6140: }
6141: }
6142: }
6143:
6144: sub set_userprivs {
6145: my ($userroles,$allroles,$allgroups,$groups_roles) = @_;
6146: my $author=0;
6147: my $adv=0;
6148: my $rar=0;
6149: my %grouproles = ();
6150: if (keys(%{$allgroups}) > 0) {
6151: my @groupkeys;
6152: foreach my $role (keys(%{$allroles})) {
6153: push(@groupkeys,$role);
6154: }
6155: if (ref($groups_roles) eq 'HASH') {
6156: foreach my $key (keys(%{$groups_roles})) {
6157: unless (grep(/^\Q$key\E$/,@groupkeys)) {
6158: push(@groupkeys,$key);
6159: }
6160: }
6161: }
6162: if (@groupkeys > 0) {
6163: foreach my $role (@groupkeys) {
6164: my ($trole,$area,$sec,$extendedarea);
6165: if ($role =~ m-^(\w+|cr/$match_domain/$match_username/\w+)\.(/$match_domain/$match_courseid)(/?\w*)\.-) {
6166: $trole = $1;
6167: $area = $2;
6168: $sec = $3;
6169: $extendedarea = $area.$sec;
6170: if (exists($$allgroups{$area})) {
6171: foreach my $group (keys(%{$$allgroups{$area}})) {
6172: my $spec = $trole.'.'.$extendedarea;
6173: $grouproles{$spec.'.'.$area.'/'.$group} =
6174: $$allgroups{$area}{$group};
6175: }
6176: }
6177: }
6178: }
6179: }
6180: }
6181: foreach my $group (keys(%grouproles)) {
6182: $$allroles{$group} = $grouproles{$group};
6183: }
6184: foreach my $role (keys(%{$allroles})) {
6185: my %thesepriv;
6186: if (($role=~/^au/) || ($role=~/^ca/) || ($role=~/^aa/)) { $author=1; }
6187: foreach my $item (split(/:/,$$allroles{$role})) {
6188: if ($item ne '') {
6189: my ($privilege,$restrictions)=split(/&/,$item);
6190: if ($restrictions eq '') {
6191: $thesepriv{$privilege}='F';
6192: } elsif ($thesepriv{$privilege} ne 'F') {
6193: $thesepriv{$privilege}.=$restrictions;
6194: }
6195: if ($thesepriv{'adv'} eq 'F') { $adv=1; }
6196: if ($thesepriv{'rar'} eq 'F') { $rar=1; }
6197: }
6198: }
6199: my $thesestr='';
6200: foreach my $priv (sort(keys(%thesepriv))) {
6201: $thesestr.=':'.$priv.'&'.$thesepriv{$priv};
6202: }
6203: $userroles->{'user.priv.'.$role} = $thesestr;
6204: }
6205: return ($author,$adv,$rar);
6206: }
6207:
6208: sub role_status {
6209: my ($rolekey,$update,$refresh,$now,$role,$where,$trolecode,$tstatus,$tstart,$tend) = @_;
6210: if (exists($env{$rolekey}) && $env{$rolekey} ne '') {
6211: my ($one,$two) = split(m{\./},$rolekey,2);
6212: (undef,undef,$$role) = split(/\./,$one,3);
6213: unless (!defined($$role) || $$role eq '') {
6214: $$where = '/'.$two;
6215: $$trolecode=$$role.'.'.$$where;
6216: ($$tstart,$$tend)=split(/\./,$env{$rolekey});
6217: $$tstatus='is';
6218: if ($$tstart && $$tstart>$update) {
6219: $$tstatus='future';
6220: if ($$tstart<$now) {
6221: if ($$tstart && $$tstart>$refresh) {
6222: if (($$where ne '') && ($$role ne '')) {
6223: my (%allroles,%allgroups,$group_privs,
6224: %groups_roles,@rolecodes);
6225: my %userroles = (
6226: 'user.role.'.$$role.'.'.$$where => $$tstart.'.'.$$tend
6227: );
6228: @rolecodes = ('cm');
6229: my $spec=$$role.'.'.$$where;
6230: my ($tdummy,$tdomain,$trest)=split(/\//,$$where);
6231: if ($$role =~ /^cr\//) {
6232: &custom_roleprivs(\%allroles,$$role,$tdomain,$trest,$spec,$$where);
6233: push(@rolecodes,'cr');
6234: } elsif ($$role eq 'gr') {
6235: push(@rolecodes,$$role);
6236: my %rolehash = &get('roles',[$$where.'_'.$$role],$env{'user.domain'},
6237: $env{'user.name'});
6238: my ($trole) = split('_',$rolehash{$$where.'_'.$$role},2);
6239: (undef,my $group_privs) = split(/\//,$trole);
6240: $group_privs = &unescape($group_privs);
6241: &group_roleprivs(\%allgroups,$$where,$group_privs,$$tend,$$tstart);
6242: my %course_roles = &get_my_roles($env{'user.name'},$env{'user.domain'},'userroles',['active'],['cc','co','in','ta','ep','ad','st','cr'],[$tdomain],1);
6243: &get_groups_roles($tdomain,$trest,
6244: \%course_roles,\@rolecodes,
6245: \%groups_roles);
6246: } else {
6247: push(@rolecodes,$$role);
6248: &standard_roleprivs(\%allroles,$$role,$tdomain,$spec,$trest,$$where);
6249: }
6250: my ($author,$adv,$rar)= &set_userprivs(\%userroles,\%allroles,\%allgroups,
6251: \%groups_roles);
6252: &appenv(\%userroles,\@rolecodes);
6253: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},"Role ".$spec);
6254: }
6255: }
6256: $$tstatus = 'is';
6257: }
6258: }
6259: if ($$tend) {
6260: if ($$tend<$update) {
6261: $$tstatus='expired';
6262: } elsif ($$tend<$now) {
6263: $$tstatus='will_not';
6264: }
6265: }
6266: }
6267: }
6268: }
6269:
6270: sub get_groups_roles {
6271: my ($cdom,$rest,$cdom_courseroles,$rolecodes,$groups_roles) = @_;
6272: return unless((ref($cdom_courseroles) eq 'HASH') &&
6273: (ref($rolecodes) eq 'ARRAY') &&
6274: (ref($groups_roles) eq 'HASH'));
6275: if (keys(%{$cdom_courseroles}) > 0) {
6276: my ($cnum) = ($rest =~ /^($match_courseid)/);
6277: if ($cdom ne '' && $cnum ne '') {
6278: foreach my $key (keys(%{$cdom_courseroles})) {
6279: if ($key =~ /^\Q$cnum\E:\Q$cdom\E:([^:]+):?([^:]*)/) {
6280: my $crsrole = $1;
6281: my $crssec = $2;
6282: if ($crsrole =~ /^cr/) {
6283: unless (grep(/^cr$/,@{$rolecodes})) {
6284: push(@{$rolecodes},'cr');
6285: }
6286: } else {
6287: unless(grep(/^\Q$crsrole\E$/,@{$rolecodes})) {
6288: push(@{$rolecodes},$crsrole);
6289: }
6290: }
6291: my $rolekey = "$crsrole./$cdom/$cnum";
6292: if ($crssec ne '') {
6293: $rolekey .= "/$crssec";
6294: }
6295: $rolekey .= './';
6296: $groups_roles->{$rolekey} = $rolecodes;
6297: }
6298: }
6299: }
6300: }
6301: return;
6302: }
6303:
6304: sub delete_env_groupprivs {
6305: my ($where,$courseroles,$possroles) = @_;
6306: return unless((ref($courseroles) eq 'HASH') && (ref($possroles) eq 'ARRAY'));
6307: my ($dummy,$udom,$uname,$group) = split(/\//,$where);
6308: unless (ref($courseroles->{$udom}) eq 'HASH') {
6309: %{$courseroles->{$udom}} =
6310: &get_my_roles('','','userroles',['active'],
6311: $possroles,[$udom],1);
6312: }
6313: if (ref($courseroles->{$udom}) eq 'HASH') {
6314: foreach my $item (keys(%{$courseroles->{$udom}})) {
6315: my ($cnum,$cdom,$crsrole,$crssec) = split(/:/,$item);
6316: my $area = '/'.$cdom.'/'.$cnum;
6317: my $privkey = "user.priv.$crsrole.$area";
6318: if ($crssec ne '') {
6319: $privkey .= '/'.$crssec;
6320: }
6321: $privkey .= ".$area/$group";
6322: &Apache::lonnet::delenv($privkey,undef,[$crsrole]);
6323: }
6324: }
6325: return;
6326: }
6327:
6328: sub check_adhoc_privs {
6329: my ($cdom,$cnum,$update,$refresh,$now,$checkrole,$caller,$sec) = @_;
6330: my $cckey = 'user.role.'.$checkrole.'./'.$cdom.'/'.$cnum;
6331: if ($sec) {
6332: $cckey .= '/'.$sec;
6333: }
6334: my $setprivs;
6335: if ($env{$cckey}) {
6336: my ($role,$where,$trolecode,$tstart,$tend,$tremark,$tstatus,$tpstart,$tpend);
6337: &role_status($cckey,$update,$refresh,$now,\$role,\$where,\$trolecode,\$tstatus,\$tstart,\$tend);
6338: unless (($tstatus eq 'is') || ($tstatus eq 'will_not')) {
6339: &set_adhoc_privileges($cdom,$cnum,$checkrole,$caller,$sec);
6340: $setprivs = 1;
6341: }
6342: } else {
6343: &set_adhoc_privileges($cdom,$cnum,$checkrole,$caller,$sec);
6344: $setprivs = 1;
6345: }
6346: return $setprivs;
6347: }
6348:
6349: sub set_adhoc_privileges {
6350: # role can be cc, ca, or cr/<dom>/<dom>-domainconfig/role
6351: my ($dcdom,$pickedcourse,$role,$caller,$sec) = @_;
6352: my $area = '/'.$dcdom.'/'.$pickedcourse;
6353: if ($sec ne '') {
6354: $area .= '/'.$sec;
6355: }
6356: my $spec = $role.'.'.$area;
6357: my %userroles = &set_arearole($role,$area,'','',$env{'user.domain'},
6358: $env{'user.name'},1);
6359: my %rolehash = ();
6360: if ($role =~ m{^\Qcr/$dcdom/$dcdom\E\-domainconfig/(\w+)$}) {
6361: my $rolename = $1;
6362: &custom_roleprivs(\%rolehash,$role,$dcdom,$pickedcourse,$spec,$area);
6363: my %domdef = &get_domain_defaults($dcdom);
6364: if (ref($domdef{'adhocroles'}) eq 'HASH') {
6365: if (ref($domdef{'adhocroles'}{$rolename}) eq 'HASH') {
6366: &appenv({'request.role.desc' => $domdef{'adhocroles'}{$rolename}{'desc'},});
6367: }
6368: }
6369: } else {
6370: &standard_roleprivs(\%rolehash,$role,$dcdom,$spec,$pickedcourse,$area);
6371: }
6372: my ($author,$adv,$rar)= &set_userprivs(\%userroles,\%rolehash);
6373: &appenv(\%userroles,[$role,'cm']);
6374: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},"Role ".$spec);
6375: unless ($caller eq 'constructaccess' && $env{'request.course.id'}) {
6376: &appenv( {'request.role' => $spec,
6377: 'request.role.domain' => $dcdom,
6378: 'request.course.sec' => $sec,
6379: }
6380: );
6381: my $tadv=0;
6382: if (&allowed('adv') eq 'F') { $tadv=1; }
6383: &appenv({'request.role.adv' => $tadv});
6384: }
6385: }
6386:
6387: # --------------------------------------------------------------- get interface
6388:
6389: sub get {
6390: my ($namespace,$storearr,$udomain,$uname)=@_;
6391: my $items='';
6392: foreach my $item (@$storearr) {
6393: $items.=&escape($item).'&';
6394: }
6395: $items=~s/\&$//;
6396: if (!$udomain) { $udomain=$env{'user.domain'}; }
6397: if (!$uname) { $uname=$env{'user.name'}; }
6398: my $uhome=&homeserver($uname,$udomain);
6399:
6400: my $rep=&reply("get:$udomain:$uname:$namespace:$items",$uhome);
6401: my @pairs=split(/\&/,$rep);
6402: if ( $#pairs==0 && $pairs[0] =~ /^(con_lost|error|no_such_host)/i) {
6403: return @pairs;
6404: }
6405: my %returnhash=();
6406: my $i=0;
6407: foreach my $item (@$storearr) {
6408: $returnhash{$item}=&thaw_unescape($pairs[$i]);
6409: $i++;
6410: }
6411: return %returnhash;
6412: }
6413:
6414: # --------------------------------------------------------------- del interface
6415:
6416: sub del {
6417: my ($namespace,$storearr,$udomain,$uname)=@_;
6418: my $items='';
6419: foreach my $item (@$storearr) {
6420: $items.=&escape($item).'&';
6421: }
6422:
6423: $items=~s/\&$//;
6424: if (!$udomain) { $udomain=$env{'user.domain'}; }
6425: if (!$uname) { $uname=$env{'user.name'}; }
6426: my $uhome=&homeserver($uname,$udomain);
6427: return &reply("del:$udomain:$uname:$namespace:$items",$uhome);
6428: }
6429:
6430: # -------------------------------------------------------------- dump interface
6431:
6432: sub unserialize {
6433: my ($rep, $escapedkeys) = @_;
6434:
6435: return {} if $rep =~ /^error/;
6436:
6437: my %returnhash=();
6438: foreach my $item (split(/\&/,$rep)) {
6439: my ($key, $value) = split(/=/, $item, 2);
6440: $key = unescape($key) unless $escapedkeys;
6441: next if $key =~ /^error: 2 /;
6442: $returnhash{$key} = &thaw_unescape($value);
6443: }
6444: #return %returnhash;
6445: return \%returnhash;
6446: }
6447:
6448: # see Lond::dump_with_regexp
6449: # if $escapedkeys hash keys won't get unescaped.
6450: sub dump {
6451: my ($namespace,$udomain,$uname,$regexp,$range,$escapedkeys)=@_;
6452: if (!$udomain) { $udomain=$env{'user.domain'}; }
6453: if (!$uname) { $uname=$env{'user.name'}; }
6454: my $uhome=&homeserver($uname,$udomain);
6455:
6456: if ($regexp) {
6457: $regexp=&escape($regexp);
6458: } else {
6459: $regexp='.';
6460: }
6461: if (grep { $_ eq $uhome } current_machine_ids()) {
6462: # user is hosted on this machine
6463: my $reply = LONCAPA::Lond::dump_with_regexp(join(":", ($udomain,
6464: $uname, $namespace, $regexp, $range)), $perlvar{'lonVersion'});
6465: return %{unserialize($reply, $escapedkeys)};
6466: }
6467: my $rep=&reply("dump:$udomain:$uname:$namespace:$regexp:$range",$uhome);
6468: my @pairs=split(/\&/,$rep);
6469: my %returnhash=();
6470: if (!($rep =~ /^error/ )) {
6471: foreach my $item (@pairs) {
6472: my ($key,$value)=split(/=/,$item,2);
6473: $key = unescape($key) unless $escapedkeys;
6474: #$key = &unescape($key);
6475: next if ($key =~ /^error: 2 /);
6476: $returnhash{$key}=&thaw_unescape($value);
6477: }
6478: }
6479: return %returnhash;
6480: }
6481:
6482:
6483: # --------------------------------------------------------- dumpstore interface
6484:
6485: sub dumpstore {
6486: my ($namespace,$udomain,$uname,$regexp,$range)=@_;
6487: # same as dump but keys must be escaped. They may contain colon separated
6488: # lists of values that may themself contain colons (e.g. symbs).
6489: return &dump($namespace, $udomain, $uname, $regexp, $range, 1);
6490: }
6491:
6492: # -------------------------------------------------------------- keys interface
6493:
6494: sub getkeys {
6495: my ($namespace,$udomain,$uname)=@_;
6496: if (!$udomain) { $udomain=$env{'user.domain'}; }
6497: if (!$uname) { $uname=$env{'user.name'}; }
6498: my $uhome=&homeserver($uname,$udomain);
6499: my $rep=reply("keys:$udomain:$uname:$namespace",$uhome);
6500: my @keyarray=();
6501: foreach my $key (split(/\&/,$rep)) {
6502: next if ($key =~ /^error: 2 /);
6503: push(@keyarray,&unescape($key));
6504: }
6505: return @keyarray;
6506: }
6507:
6508: # --------------------------------------------------------------- currentdump
6509: sub currentdump {
6510: my ($courseid,$sdom,$sname)=@_;
6511: $courseid = $env{'request.course.id'} if (! defined($courseid));
6512: $sdom = $env{'user.domain'} if (! defined($sdom));
6513: $sname = $env{'user.name'} if (! defined($sname));
6514: my $uhome = &homeserver($sname,$sdom);
6515: my $rep;
6516:
6517: if (grep { $_ eq $uhome } current_machine_ids()) {
6518: $rep = LONCAPA::Lond::dump_profile_database(join(":", ($sdom, $sname,
6519: $courseid)));
6520: } else {
6521: $rep = reply('currentdump:'.$sdom.':'.$sname.':'.$courseid,$uhome);
6522: }
6523:
6524: return if ($rep =~ /^(error:|no_such_host)/);
6525: #
6526: my %returnhash=();
6527: #
6528: if ($rep eq 'unknown_cmd') {
6529: # an old lond will not know currentdump
6530: # Do a dump and make it look like a currentdump
6531: my @tmp = &dumpstore($courseid,$sdom,$sname,'.');
6532: return if ($tmp[0] =~ /^(error:|no_such_host)/);
6533: my %hash = @tmp;
6534: @tmp=();
6535: %returnhash = %{&convert_dump_to_currentdump(\%hash)};
6536: } else {
6537: my @pairs=split(/\&/,$rep);
6538: foreach my $pair (@pairs) {
6539: my ($key,$value)=split(/=/,$pair,2);
6540: my ($symb,$param) = split(/:/,$key);
6541: $returnhash{&unescape($symb)}->{&unescape($param)} =
6542: &thaw_unescape($value);
6543: }
6544: }
6545: return %returnhash;
6546: }
6547:
6548: sub convert_dump_to_currentdump{
6549: my %hash = %{shift()};
6550: my %returnhash;
6551: # Code ripped from lond, essentially. The only difference
6552: # here is the unescaping done by lonnet::dump(). Conceivably
6553: # we might run in to problems with parameter names =~ /^v\./
6554: while (my ($key,$value) = each(%hash)) {
6555: my ($v,$symb,$param) = split(/:/,$key);
6556: $symb = &unescape($symb);
6557: $param = &unescape($param);
6558: next if ($v eq 'version' || $symb eq 'keys');
6559: next if (exists($returnhash{$symb}) &&
6560: exists($returnhash{$symb}->{$param}) &&
6561: $returnhash{$symb}->{'v.'.$param} > $v);
6562: $returnhash{$symb}->{$param}=$value;
6563: $returnhash{$symb}->{'v.'.$param}=$v;
6564: }
6565: #
6566: # Remove all of the keys in the hashes which keep track of
6567: # the version of the parameter.
6568: while (my ($symb,$param_hash) = each(%returnhash)) {
6569: # use a foreach because we are going to delete from the hash.
6570: foreach my $key (keys(%$param_hash)) {
6571: delete($param_hash->{$key}) if ($key =~ /^v\./);
6572: }
6573: }
6574: return \%returnhash;
6575: }
6576:
6577: # ------------------------------------------------------ critical inc interface
6578:
6579: sub cinc {
6580: return &inc(@_,'critical');
6581: }
6582:
6583: # --------------------------------------------------------------- inc interface
6584:
6585: sub inc {
6586: my ($namespace,$store,$udomain,$uname,$critical) = @_;
6587: if (!$udomain) { $udomain=$env{'user.domain'}; }
6588: if (!$uname) { $uname=$env{'user.name'}; }
6589: my $uhome=&homeserver($uname,$udomain);
6590: my $items='';
6591: if (! ref($store)) {
6592: # got a single value, so use that instead
6593: $items = &escape($store).'=&';
6594: } elsif (ref($store) eq 'SCALAR') {
6595: $items = &escape($$store).'=&';
6596: } elsif (ref($store) eq 'ARRAY') {
6597: $items = join('=&',map {&escape($_);} @{$store});
6598: } elsif (ref($store) eq 'HASH') {
6599: while (my($key,$value) = each(%{$store})) {
6600: $items.= &escape($key).'='.&escape($value).'&';
6601: }
6602: }
6603: $items=~s/\&$//;
6604: if ($critical) {
6605: return &critical("inc:$udomain:$uname:$namespace:$items",$uhome);
6606: } else {
6607: return &reply("inc:$udomain:$uname:$namespace:$items",$uhome);
6608: }
6609: }
6610:
6611: # --------------------------------------------------------------- put interface
6612:
6613: sub put {
6614: my ($namespace,$storehash,$udomain,$uname)=@_;
6615: if (!$udomain) { $udomain=$env{'user.domain'}; }
6616: if (!$uname) { $uname=$env{'user.name'}; }
6617: my $uhome=&homeserver($uname,$udomain);
6618: my $items='';
6619: foreach my $item (keys(%$storehash)) {
6620: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
6621: }
6622: $items=~s/\&$//;
6623: return &reply("put:$udomain:$uname:$namespace:$items",$uhome);
6624: }
6625:
6626: # ------------------------------------------------------------ newput interface
6627:
6628: sub newput {
6629: my ($namespace,$storehash,$udomain,$uname)=@_;
6630: if (!$udomain) { $udomain=$env{'user.domain'}; }
6631: if (!$uname) { $uname=$env{'user.name'}; }
6632: my $uhome=&homeserver($uname,$udomain);
6633: my $items='';
6634: foreach my $key (keys(%$storehash)) {
6635: $items.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
6636: }
6637: $items=~s/\&$//;
6638: return &reply("newput:$udomain:$uname:$namespace:$items",$uhome);
6639: }
6640:
6641: # --------------------------------------------------------- putstore interface
6642:
6643: sub putstore {
6644: my ($namespace,$symb,$version,$storehash,$udomain,$uname,$tolog)=@_;
6645: if (!$udomain) { $udomain=$env{'user.domain'}; }
6646: if (!$uname) { $uname=$env{'user.name'}; }
6647: my $uhome=&homeserver($uname,$udomain);
6648: my $items='';
6649: foreach my $key (keys(%$storehash)) {
6650: $items.= &escape($key).'='.&freeze_escape($storehash->{$key}).'&';
6651: }
6652: $items=~s/\&$//;
6653: my $esc_symb=&escape($symb);
6654: my $esc_v=&escape($version);
6655: my $reply =
6656: &reply("putstore:$udomain:$uname:$namespace:$esc_symb:$esc_v:$items",
6657: $uhome);
6658: if (($tolog) && ($reply eq 'ok')) {
6659: my $namevalue='';
6660: foreach my $key (keys(%{$storehash})) {
6661: $namevalue.=&escape($key).'='.&freeze_escape($storehash->{$key}).'&';
6662: }
6663: $namevalue .= 'ip='.&escape($ENV{'REMOTE_ADDR'}).
6664: '&host='.&escape($perlvar{'lonHostID'}).
6665: '&version='.$esc_v.
6666: '&by='.&escape($env{'user.name'}.':'.$env{'user.domain'});
6667: &Apache::lonnet::courselog($symb.':'.$uname.':'.$udomain.':PUTSTORE:'.$namevalue);
6668: }
6669: if ($reply eq 'unknown_cmd') {
6670: # gfall back to way things use to be done
6671: return &old_putstore($namespace,$symb,$version,$storehash,$udomain,
6672: $uname);
6673: }
6674: return $reply;
6675: }
6676:
6677: sub old_putstore {
6678: my ($namespace,$symb,$version,$storehash,$udomain,$uname)=@_;
6679: if (!$udomain) { $udomain=$env{'user.domain'}; }
6680: if (!$uname) { $uname=$env{'user.name'}; }
6681: my $uhome=&homeserver($uname,$udomain);
6682: my %newstorehash;
6683: foreach my $item (keys(%$storehash)) {
6684: my $key = $version.':'.&escape($symb).':'.$item;
6685: $newstorehash{$key} = $storehash->{$item};
6686: }
6687: my $items='';
6688: my %allitems = ();
6689: foreach my $item (keys(%newstorehash)) {
6690: if ($item =~ m/^([^\:]+):([^\:]+):([^\:]+)$/) {
6691: my $key = $1.':keys:'.$2;
6692: $allitems{$key} .= $3.':';
6693: }
6694: $items.=$item.'='.&freeze_escape($newstorehash{$item}).'&';
6695: }
6696: foreach my $item (keys(%allitems)) {
6697: $allitems{$item} =~ s/\:$//;
6698: $items.= $item.'='.$allitems{$item}.'&';
6699: }
6700: $items=~s/\&$//;
6701: return &reply("put:$udomain:$uname:$namespace:$items",$uhome);
6702: }
6703:
6704: # ------------------------------------------------------ critical put interface
6705:
6706: sub cput {
6707: my ($namespace,$storehash,$udomain,$uname)=@_;
6708: if (!$udomain) { $udomain=$env{'user.domain'}; }
6709: if (!$uname) { $uname=$env{'user.name'}; }
6710: my $uhome=&homeserver($uname,$udomain);
6711: my $items='';
6712: foreach my $item (keys(%$storehash)) {
6713: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
6714: }
6715: $items=~s/\&$//;
6716: return &critical("put:$udomain:$uname:$namespace:$items",$uhome);
6717: }
6718:
6719: # -------------------------------------------------------------- eget interface
6720:
6721: sub eget {
6722: my ($namespace,$storearr,$udomain,$uname)=@_;
6723: my $items='';
6724: foreach my $item (@$storearr) {
6725: $items.=&escape($item).'&';
6726: }
6727: $items=~s/\&$//;
6728: if (!$udomain) { $udomain=$env{'user.domain'}; }
6729: if (!$uname) { $uname=$env{'user.name'}; }
6730: my $uhome=&homeserver($uname,$udomain);
6731: my $rep=&reply("eget:$udomain:$uname:$namespace:$items",$uhome);
6732: my @pairs=split(/\&/,$rep);
6733: my %returnhash=();
6734: my $i=0;
6735: foreach my $item (@$storearr) {
6736: $returnhash{$item}=&thaw_unescape($pairs[$i]);
6737: $i++;
6738: }
6739: return %returnhash;
6740: }
6741:
6742: # ------------------------------------------------------------ tmpput interface
6743: sub tmpput {
6744: my ($storehash,$server,$context)=@_;
6745: my $items='';
6746: foreach my $item (keys(%$storehash)) {
6747: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
6748: }
6749: $items=~s/\&$//;
6750: if (defined($context)) {
6751: $items .= ':'.&escape($context);
6752: }
6753: return &reply("tmpput:$items",$server);
6754: }
6755:
6756: # ------------------------------------------------------------ tmpget interface
6757: sub tmpget {
6758: my ($token,$server)=@_;
6759: if (!defined($server)) { $server = $perlvar{'lonHostID'}; }
6760: my $rep=&reply("tmpget:$token",$server);
6761: my %returnhash;
6762: if ($rep =~ /^(con_lost|error|no_such_host)/i) {
6763: return %returnhash;
6764: }
6765: foreach my $item (split(/\&/,$rep)) {
6766: my ($key,$value)=split(/=/,$item);
6767: $returnhash{&unescape($key)}=&thaw_unescape($value);
6768: }
6769: return %returnhash;
6770: }
6771:
6772: # ------------------------------------------------------------ tmpdel interface
6773: sub tmpdel {
6774: my ($token,$server)=@_;
6775: if (!defined($server)) { $server = $perlvar{'lonHostID'}; }
6776: return &reply("tmpdel:$token",$server);
6777: }
6778:
6779: # ------------------------------------------------------------ get_timebased_id
6780:
6781: sub get_timebased_id {
6782: my ($prefix,$keyid,$namespace,$cdom,$cnum,$idtype,$who,$locktries,
6783: $maxtries) = @_;
6784: my ($newid,$error,$dellock);
6785: unless (($prefix =~ /^\w+$/) && ($keyid =~ /^\w+$/) && ($namespace ne '')) {
6786: return ('','ok','invalid call to get suffix');
6787: }
6788:
6789: # set defaults for any optional args for which values were not supplied
6790: if ($who eq '') {
6791: $who = $env{'user.name'}.':'.$env{'user.domain'};
6792: }
6793: if (!$locktries) {
6794: $locktries = 3;
6795: }
6796: if (!$maxtries) {
6797: $maxtries = 10;
6798: }
6799:
6800: if (($cdom eq '') || ($cnum eq '')) {
6801: if ($env{'request.course.id'}) {
6802: $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
6803: $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
6804: }
6805: if (($cdom eq '') || ($cnum eq '')) {
6806: return ('','ok','call to get suffix not in course context');
6807: }
6808: }
6809:
6810: # construct locking item
6811: my $lockhash = {
6812: $prefix."\0".'locked_'.$keyid => $who,
6813: };
6814: my $tries = 0;
6815:
6816: # attempt to get lock on nohist_$namespace file
6817: my $gotlock = &Apache::lonnet::newput('nohist_'.$namespace,$lockhash,$cdom,$cnum);
6818: while (($gotlock ne 'ok') && $tries <$locktries) {
6819: $tries ++;
6820: sleep 1;
6821: $gotlock = &Apache::lonnet::newput('nohist_'.$namespace,$lockhash,$cdom,$cnum);
6822: }
6823:
6824: # attempt to get unique identifier, based on current timestamp
6825: if ($gotlock eq 'ok') {
6826: my %inuse = &Apache::lonnet::dump('nohist_'.$namespace,$cdom,$cnum,$prefix);
6827: my $id = time;
6828: $newid = $id;
6829: if ($idtype eq 'addcode') {
6830: $newid .= &sixnum_code();
6831: }
6832: my $idtries = 0;
6833: while (exists($inuse{$prefix."\0".$newid}) && $idtries < $maxtries) {
6834: if ($idtype eq 'concat') {
6835: $newid = $id.$idtries;
6836: } elsif ($idtype eq 'addcode') {
6837: $newid = $newid.&sixnum_code();
6838: } else {
6839: $newid ++;
6840: }
6841: $idtries ++;
6842: }
6843: if (!exists($inuse{$prefix."\0".$newid})) {
6844: my %new_item = (
6845: $prefix."\0".$newid => $who,
6846: );
6847: my $putresult = &Apache::lonnet::put('nohist_'.$namespace,\%new_item,
6848: $cdom,$cnum);
6849: if ($putresult ne 'ok') {
6850: undef($newid);
6851: $error = 'error saving new item: '.$putresult;
6852: }
6853: } else {
6854: undef($newid);
6855: $error = ('error: no unique suffix available for the new item ');
6856: }
6857: # remove lock
6858: my @del_lock = ($prefix."\0".'locked_'.$keyid);
6859: $dellock = &Apache::lonnet::del('nohist_'.$namespace,\@del_lock,$cdom,$cnum);
6860: } else {
6861: $error = "error: could not obtain lockfile\n";
6862: $dellock = 'ok';
6863: if (($prefix eq 'paste') && ($namespace eq 'courseeditor') && ($keyid eq 'num')) {
6864: $dellock = 'nolock';
6865: }
6866: }
6867: return ($newid,$dellock,$error);
6868: }
6869:
6870: sub sixnum_code {
6871: my $code;
6872: for (0..6) {
6873: $code .= int( rand(9) );
6874: }
6875: return $code;
6876: }
6877:
6878: # -------------------------------------------------- portfolio access checking
6879:
6880: sub portfolio_access {
6881: my ($requrl,$clientip) = @_;
6882: my (undef,$udom,$unum,$file_name,$group) = &parse_portfolio_url($requrl);
6883: my $result = &get_portfolio_access($udom,$unum,$file_name,$group,$clientip);
6884: if ($result) {
6885: my %setters;
6886: if ($env{'user.name'} eq 'public' && $env{'user.domain'} eq 'public') {
6887: my ($startblock,$endblock) =
6888: &Apache::loncommon::blockcheck(\%setters,'port',$unum,$udom);
6889: if ($startblock && $endblock) {
6890: return 'B';
6891: }
6892: } else {
6893: my ($startblock,$endblock) =
6894: &Apache::loncommon::blockcheck(\%setters,'port');
6895: if ($startblock && $endblock) {
6896: return 'B';
6897: }
6898: }
6899: }
6900: if ($result eq 'ok') {
6901: return 'F';
6902: } elsif ($result =~ /^[^:]+:guest_/) {
6903: return 'A';
6904: }
6905: return '';
6906: }
6907:
6908: sub get_portfolio_access {
6909: my ($udom,$unum,$file_name,$group,$clientip,$access_hash) = @_;
6910:
6911: if (!ref($access_hash)) {
6912: my $current_perms = &get_portfile_permissions($udom,$unum);
6913: my %access_controls = &get_access_controls($current_perms,$group,
6914: $file_name);
6915: $access_hash = $access_controls{$file_name};
6916: }
6917:
6918: my ($public,$guest,@domains,@users,@courses,@groups,@ips);
6919: my $now = time;
6920: if (ref($access_hash) eq 'HASH') {
6921: foreach my $key (keys(%{$access_hash})) {
6922: my ($num,$scope,$end,$start) = ($key =~ /^([^:]+):([a-z]+)_(\d*)_?(\d*)$/);
6923: if ($start > $now) {
6924: next;
6925: }
6926: if ($end && $end<$now) {
6927: next;
6928: }
6929: if ($scope eq 'public') {
6930: $public = $key;
6931: last;
6932: } elsif ($scope eq 'guest') {
6933: $guest = $key;
6934: } elsif ($scope eq 'domains') {
6935: push(@domains,$key);
6936: } elsif ($scope eq 'users') {
6937: push(@users,$key);
6938: } elsif ($scope eq 'course') {
6939: push(@courses,$key);
6940: } elsif ($scope eq 'group') {
6941: push(@groups,$key);
6942: } elsif ($scope eq 'ip') {
6943: push(@ips,$key);
6944: }
6945: }
6946: if ($public) {
6947: return 'ok';
6948: } elsif (@ips > 0) {
6949: my $allowed;
6950: foreach my $ipkey (@ips) {
6951: if (ref($access_hash->{$ipkey}{'ip'}) eq 'ARRAY') {
6952: if (&Apache::loncommon::check_ip_acc(join(',',@{$access_hash->{$ipkey}{'ip'}}),$clientip)) {
6953: $allowed = 1;
6954: last;
6955: }
6956: }
6957: }
6958: if ($allowed) {
6959: return 'ok';
6960: }
6961: }
6962: if ($env{'user.name'} eq 'public' && $env{'user.domain'} eq 'public') {
6963: if ($guest) {
6964: return $guest;
6965: }
6966: } else {
6967: if (@domains > 0) {
6968: foreach my $domkey (@domains) {
6969: if (ref($access_hash->{$domkey}{'dom'}) eq 'ARRAY') {
6970: if (grep(/^\Q$env{'user.domain'}\E$/,@{$access_hash->{$domkey}{'dom'}})) {
6971: return 'ok';
6972: }
6973: }
6974: }
6975: }
6976: if (@users > 0) {
6977: foreach my $userkey (@users) {
6978: if (ref($access_hash->{$userkey}{'users'}) eq 'ARRAY') {
6979: foreach my $item (@{$access_hash->{$userkey}{'users'}}) {
6980: if (ref($item) eq 'HASH') {
6981: if (($item->{'uname'} eq $env{'user.name'}) &&
6982: ($item->{'udom'} eq $env{'user.domain'})) {
6983: return 'ok';
6984: }
6985: }
6986: }
6987: }
6988: }
6989: }
6990: my %roleshash;
6991: my @courses_and_groups = @courses;
6992: push(@courses_and_groups,@groups);
6993: if (@courses_and_groups > 0) {
6994: my (%allgroups,%allroles);
6995: my ($start,$end,$role,$sec,$group);
6996: foreach my $envkey (%env) {
6997: if ($envkey =~ m-^user\.role\.(gr|cc|co|in|ta|ep|ad|st)\./($match_domain)/($match_courseid)/?([^/]*)$-) {
6998: my $cid = $2.'_'.$3;
6999: if ($1 eq 'gr') {
7000: $group = $4;
7001: $allgroups{$cid}{$group} = $env{$envkey};
7002: } else {
7003: if ($4 eq '') {
7004: $sec = 'none';
7005: } else {
7006: $sec = $4;
7007: }
7008: $allroles{$cid}{$1}{$sec} = $env{$envkey};
7009: }
7010: } elsif ($envkey =~ m-^user\.role\./cr/($match_domain/$match_username/\w*)./($match_domain)/($match_courseid)/?([^/]*)$-) {
7011: my $cid = $2.'_'.$3;
7012: if ($4 eq '') {
7013: $sec = 'none';
7014: } else {
7015: $sec = $4;
7016: }
7017: $allroles{$cid}{$1}{$sec} = $env{$envkey};
7018: }
7019: }
7020: if (keys(%allroles) == 0) {
7021: return;
7022: }
7023: foreach my $key (@courses_and_groups) {
7024: my %content = %{$$access_hash{$key}};
7025: my $cnum = $content{'number'};
7026: my $cdom = $content{'domain'};
7027: my $cid = $cdom.'_'.$cnum;
7028: if (!exists($allroles{$cid})) {
7029: next;
7030: }
7031: foreach my $role_id (keys(%{$content{'roles'}})) {
7032: my @sections = @{$content{'roles'}{$role_id}{'section'}};
7033: my @groups = @{$content{'roles'}{$role_id}{'group'}};
7034: my @status = @{$content{'roles'}{$role_id}{'access'}};
7035: my @roles = @{$content{'roles'}{$role_id}{'role'}};
7036: foreach my $role (keys(%{$allroles{$cid}})) {
7037: if ((grep/^all$/,@roles) || (grep/^\Q$role\E$/,@roles)) {
7038: foreach my $sec (keys(%{$allroles{$cid}{$role}})) {
7039: if (&course_group_datechecker($allroles{$cid}{$role}{$sec},$now,\@status) eq 'ok') {
7040: if (grep/^all$/,@sections) {
7041: return 'ok';
7042: } else {
7043: if (grep/^$sec$/,@sections) {
7044: return 'ok';
7045: }
7046: }
7047: }
7048: }
7049: if (keys(%{$allgroups{$cid}}) == 0) {
7050: if (grep/^none$/,@groups) {
7051: return 'ok';
7052: }
7053: } else {
7054: if (grep/^all$/,@groups) {
7055: return 'ok';
7056: }
7057: foreach my $group (keys(%{$allgroups{$cid}})) {
7058: if (grep/^$group$/,@groups) {
7059: return 'ok';
7060: }
7061: }
7062: }
7063: }
7064: }
7065: }
7066: }
7067: }
7068: if ($guest) {
7069: return $guest;
7070: }
7071: }
7072: }
7073: return;
7074: }
7075:
7076: sub course_group_datechecker {
7077: my ($dates,$now,$status) = @_;
7078: my ($start,$end) = split(/\./,$dates);
7079: if (!$start && !$end) {
7080: return 'ok';
7081: }
7082: if (grep/^active$/,@{$status}) {
7083: if (((!$start) || ($start && $start <= $now)) && ((!$end) || ($end && $end >= $now))) {
7084: return 'ok';
7085: }
7086: }
7087: if (grep/^previous$/,@{$status}) {
7088: if ($end > $now ) {
7089: return 'ok';
7090: }
7091: }
7092: if (grep/^future$/,@{$status}) {
7093: if ($start > $now) {
7094: return 'ok';
7095: }
7096: }
7097: return;
7098: }
7099:
7100: sub parse_portfolio_url {
7101: my ($url) = @_;
7102:
7103: my ($type,$udom,$unum,$group,$file_name);
7104:
7105: if ($url =~ m-^/*(?:uploaded|editupload)/($match_domain)/($match_username)/portfolio(/.+)$-) {
7106: $type = 1;
7107: $udom = $1;
7108: $unum = $2;
7109: $file_name = $3;
7110: } elsif ($url =~ m-^/*(?:uploaded|editupload)/($match_domain)/($match_courseid)/groups/([^/]+)/portfolio/(.+)$-) {
7111: $type = 2;
7112: $udom = $1;
7113: $unum = $2;
7114: $group = $3;
7115: $file_name = $3.'/'.$4;
7116: }
7117: if (wantarray) {
7118: return ($type,$udom,$unum,$file_name,$group);
7119: }
7120: return $type;
7121: }
7122:
7123: sub is_portfolio_url {
7124: my ($url) = @_;
7125: return scalar(&parse_portfolio_url($url));
7126: }
7127:
7128: sub is_portfolio_file {
7129: my ($file) = @_;
7130: if (($file =~ /^portfolio/) || ($file =~ /^groups\/\w+\/portfolio/)) {
7131: return 1;
7132: }
7133: return;
7134: }
7135:
7136: sub usertools_access {
7137: my ($uname,$udom,$tool,$action,$context,$userenvref,$domdefref,$is_advref)=@_;
7138: my ($access,%tools);
7139: if ($context eq '') {
7140: $context = 'tools';
7141: }
7142: if ($context eq 'requestcourses') {
7143: %tools = (
7144: official => 1,
7145: unofficial => 1,
7146: community => 1,
7147: textbook => 1,
7148: placement => 1,
7149: lti => 1,
7150: );
7151: } elsif ($context eq 'requestauthor') {
7152: %tools = (
7153: requestauthor => 1,
7154: );
7155: } else {
7156: %tools = (
7157: aboutme => 1,
7158: blog => 1,
7159: webdav => 1,
7160: portfolio => 1,
7161: );
7162: }
7163: return if (!defined($tools{$tool}));
7164:
7165: if (($udom eq '') || ($uname eq '')) {
7166: $udom = $env{'user.domain'};
7167: $uname = $env{'user.name'};
7168: }
7169:
7170: if (($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'})) {
7171: if ($action ne 'reload') {
7172: if ($context eq 'requestcourses') {
7173: return $env{'environment.canrequest.'.$tool};
7174: } elsif ($context eq 'requestauthor') {
7175: return $env{'environment.canrequest.author'};
7176: } else {
7177: return $env{'environment.availabletools.'.$tool};
7178: }
7179: }
7180: }
7181:
7182: my ($toolstatus,$inststatus,$envkey);
7183: if ($context eq 'requestauthor') {
7184: $envkey = $context;
7185: } else {
7186: $envkey = $context.'.'.$tool;
7187: }
7188:
7189: if (($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'}) &&
7190: ($action ne 'reload')) {
7191: $toolstatus = $env{'environment.'.$envkey};
7192: $inststatus = $env{'environment.inststatus'};
7193: } else {
7194: if (ref($userenvref) eq 'HASH') {
7195: $toolstatus = $userenvref->{$envkey};
7196: $inststatus = $userenvref->{'inststatus'};
7197: } else {
7198: my %userenv = &userenvironment($udom,$uname,$envkey,'inststatus');
7199: $toolstatus = $userenv{$envkey};
7200: $inststatus = $userenv{'inststatus'};
7201: }
7202: }
7203:
7204: if ($toolstatus ne '') {
7205: if ($toolstatus) {
7206: $access = 1;
7207: } else {
7208: $access = 0;
7209: }
7210: return $access;
7211: }
7212:
7213: my ($is_adv,%domdef);
7214: if (ref($is_advref) eq 'HASH') {
7215: $is_adv = $is_advref->{'is_adv'};
7216: } else {
7217: $is_adv = &is_advanced_user($udom,$uname);
7218: }
7219: if (ref($domdefref) eq 'HASH') {
7220: %domdef = %{$domdefref};
7221: } else {
7222: %domdef = &get_domain_defaults($udom);
7223: }
7224: if (ref($domdef{$tool}) eq 'HASH') {
7225: if ($is_adv) {
7226: if ($domdef{$tool}{'_LC_adv'} ne '') {
7227: if ($domdef{$tool}{'_LC_adv'}) {
7228: $access = 1;
7229: } else {
7230: $access = 0;
7231: }
7232: return $access;
7233: }
7234: }
7235: if ($inststatus ne '') {
7236: my ($hasaccess,$hasnoaccess);
7237: foreach my $affiliation (split(/:/,$inststatus)) {
7238: if ($domdef{$tool}{$affiliation} ne '') {
7239: if ($domdef{$tool}{$affiliation}) {
7240: $hasaccess = 1;
7241: } else {
7242: $hasnoaccess = 1;
7243: }
7244: }
7245: }
7246: if ($hasaccess || $hasnoaccess) {
7247: if ($hasaccess) {
7248: $access = 1;
7249: } elsif ($hasnoaccess) {
7250: $access = 0;
7251: }
7252: return $access;
7253: }
7254: } else {
7255: if ($domdef{$tool}{'default'} ne '') {
7256: if ($domdef{$tool}{'default'}) {
7257: $access = 1;
7258: } elsif ($domdef{$tool}{'default'} == 0) {
7259: $access = 0;
7260: }
7261: return $access;
7262: }
7263: }
7264: } else {
7265: if (($context eq 'tools') && ($tool ne 'webdav')) {
7266: $access = 1;
7267: } else {
7268: $access = 0;
7269: }
7270: return $access;
7271: }
7272: }
7273:
7274: sub is_course_owner {
7275: my ($cdom,$cnum,$udom,$uname) = @_;
7276: if (($udom eq '') || ($uname eq '')) {
7277: $udom = $env{'user.domain'};
7278: $uname = $env{'user.name'};
7279: }
7280: unless (($udom eq '') || ($uname eq '')) {
7281: if (exists($env{'course.'.$cdom.'_'.$cnum.'.internal.courseowner'})) {
7282: if ($env{'course.'.$cdom.'_'.$cnum.'.internal.courseowner'} eq $uname.':'.$udom) {
7283: return 1;
7284: } else {
7285: my %courseinfo = &Apache::lonnet::coursedescription($cdom.'/'.$cnum);
7286: if ($courseinfo{'internal.courseowner'} eq $uname.':'.$udom) {
7287: return 1;
7288: }
7289: }
7290: }
7291: }
7292: return;
7293: }
7294:
7295: sub is_advanced_user {
7296: my ($udom,$uname) = @_;
7297: if ($udom ne '' && $uname ne '') {
7298: if (($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'})) {
7299: if (wantarray) {
7300: return ($env{'user.adv'},$env{'user.author'});
7301: } else {
7302: return $env{'user.adv'};
7303: }
7304: }
7305: }
7306: my %roleshash = &get_my_roles($uname,$udom,'userroles',undef,undef,undef,1);
7307: my %allroles;
7308: my ($is_adv,$is_author);
7309: foreach my $role (keys(%roleshash)) {
7310: my ($trest,$tdomain,$trole,$sec) = split(/:/,$role);
7311: my $area = '/'.$tdomain.'/'.$trest;
7312: if ($sec ne '') {
7313: $area .= '/'.$sec;
7314: }
7315: if (($area ne '') && ($trole ne '')) {
7316: my $spec=$trole.'.'.$area;
7317: if ($trole =~ /^cr\//) {
7318: &custom_roleprivs(\%allroles,$trole,$tdomain,$trest,$spec,$area);
7319: } elsif ($trole ne 'gr') {
7320: &standard_roleprivs(\%allroles,$trole,$tdomain,$spec,$trest,$area);
7321: }
7322: if ($trole eq 'au') {
7323: $is_author = 1;
7324: }
7325: }
7326: }
7327: foreach my $role (keys(%allroles)) {
7328: last if ($is_adv);
7329: foreach my $item (split(/:/,$allroles{$role})) {
7330: if ($item ne '') {
7331: my ($privilege,$restrictions)=split(/&/,$item);
7332: if ($privilege eq 'adv') {
7333: $is_adv = 1;
7334: last;
7335: }
7336: }
7337: }
7338: }
7339: if (wantarray) {
7340: return ($is_adv,$is_author);
7341: }
7342: return $is_adv;
7343: }
7344:
7345: sub check_can_request {
7346: my ($dom,$can_request,$request_domains,$uname,$udom) = @_;
7347: my $canreq = 0;
7348: if (($env{'user.name'} ne '') && ($env{'user.domain'} ne '')) {
7349: $uname = $env{'user.name'};
7350: $udom = $env{'user.domain'};
7351: }
7352: my ($types,$typename) = &Apache::loncommon::course_types();
7353: my @options = ('approval','validate','autolimit');
7354: my $optregex = join('|',@options);
7355: if ((ref($can_request) eq 'HASH') && (ref($types) eq 'ARRAY')) {
7356: foreach my $type (@{$types}) {
7357: if (&usertools_access($uname,$udom,$type,undef,
7358: 'requestcourses')) {
7359: $canreq ++;
7360: if (ref($request_domains) eq 'HASH') {
7361: push(@{$request_domains->{$type}},$udom);
7362: }
7363: if ($dom eq $udom) {
7364: $can_request->{$type} = 1;
7365: }
7366: }
7367: if (($env{'user.name'} ne '') && ($env{'user.domain'} ne '') &&
7368: ($env{'environment.reqcrsotherdom.'.$type} ne '')) {
7369: my @curr = split(',',$env{'environment.reqcrsotherdom.'.$type});
7370: if (@curr > 0) {
7371: foreach my $item (@curr) {
7372: if (ref($request_domains) eq 'HASH') {
7373: my ($otherdom) = ($item =~ /^($match_domain):($optregex)(=?\d*)$/);
7374: if ($otherdom ne '') {
7375: if (ref($request_domains->{$type}) eq 'ARRAY') {
7376: unless (grep(/^\Q$otherdom\E$/,@{$request_domains->{$type}})) {
7377: push(@{$request_domains->{$type}},$otherdom);
7378: }
7379: } else {
7380: push(@{$request_domains->{$type}},$otherdom);
7381: }
7382: }
7383: }
7384: }
7385: unless ($dom eq $env{'user.domain'}) {
7386: $canreq ++;
7387: if (grep(/^\Q$dom\E:($optregex)(=?\d*)$/,@curr)) {
7388: $can_request->{$type} = 1;
7389: }
7390: }
7391: }
7392: }
7393: }
7394: }
7395: return $canreq;
7396: }
7397:
7398: # ---------------------------------------------- Custom access rule evaluation
7399:
7400: sub customaccess {
7401: my ($priv,$uri)=@_;
7402: my ($urole,$urealm)=split(/\./,$env{'request.role'},2);
7403: my (undef,$udom,$ucrs,$usec)=split(/\//,$urealm);
7404: $udom = &LONCAPA::clean_domain($udom);
7405: $ucrs = &LONCAPA::clean_username($ucrs);
7406: my $access=0;
7407: foreach my $right (split(/\s*\,\s*/,&metadata($uri,'rule_rights'))) {
7408: my ($effect,$realm,$role,$type)=split(/\:/,$right);
7409: if ($type eq 'user') {
7410: foreach my $scope (split(/\s*\,\s*/,$realm)) {
7411: my ($tdom,$tuname)=split(m{/},$scope);
7412: if ($tdom) {
7413: if ($tdom ne $env{'user.domain'}) { next; }
7414: }
7415: if ($tuname) {
7416: if ($tuname ne $env{'user.name'}) { next; }
7417: }
7418: $access=($effect eq 'allow');
7419: last;
7420: }
7421: } else {
7422: if ($role) {
7423: if ($role ne $urole) { next; }
7424: }
7425: foreach my $scope (split(/\s*\,\s*/,$realm)) {
7426: my ($tdom,$tcrs,$tsec)=split(/\_/,$scope);
7427: if ($tdom) {
7428: if ($tdom ne $udom) { next; }
7429: }
7430: if ($tcrs) {
7431: if ($tcrs ne $ucrs) { next; }
7432: }
7433: if ($tsec) {
7434: if ($tsec ne $usec) { next; }
7435: }
7436: $access=($effect eq 'allow');
7437: last;
7438: }
7439: if ($realm eq '' && $role eq '') {
7440: $access=($effect eq 'allow');
7441: }
7442: }
7443: }
7444: return $access;
7445: }
7446:
7447: # ------------------------------------------------- Check for a user privilege
7448:
7449: sub allowed {
7450: my ($priv,$uri,$symb,$role,$clientip,$noblockcheck)=@_;
7451: my $ver_orguri=$uri;
7452: $uri=&deversion($uri);
7453: my $orguri=$uri;
7454: $uri=&declutter($uri);
7455:
7456: if ($priv eq 'evb') {
7457: # Evade communication block restrictions for specified role in a course
7458: if ($env{'user.priv.'.$role} =~/evb\&([^\:]*)/) {
7459: return $1;
7460: } else {
7461: return;
7462: }
7463: }
7464:
7465: if (defined($env{'allowed.'.$priv})) { return $env{'allowed.'.$priv}; }
7466: # Free bre access to adm and meta resources
7467: if (((($uri=~/^adm\//) && ($uri !~ m{/(?:smppg|bulletinboard|ext\.tool)$}))
7468: || (($uri=~/\.meta$/) && ($uri!~m|^uploaded/|) ))
7469: && ($priv eq 'bre')) {
7470: return 'F';
7471: }
7472:
7473: # Free bre access to user's own portfolio contents
7474: my ($space,$domain,$name,@dir)=split('/',$uri);
7475: if (($space=~/^(uploaded|editupload)$/) && ($env{'user.name'} eq $name) &&
7476: ($env{'user.domain'} eq $domain) && ('portfolio' eq $dir[0])) {
7477: my %setters;
7478: my ($startblock,$endblock) =
7479: &Apache::loncommon::blockcheck(\%setters,'port');
7480: if ($startblock && $endblock) {
7481: return 'B';
7482: } else {
7483: return 'F';
7484: }
7485: }
7486:
7487: # bre access to group portfolio for rgf priv in group, or mdg or vcg in course.
7488: if (($space=~/^(uploaded|editupload)$/) && ($dir[0] eq 'groups')
7489: && ($dir[2] eq 'portfolio') && ($priv eq 'bre')) {
7490: if (exists($env{'request.course.id'})) {
7491: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
7492: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
7493: if (($domain eq $cdom) && ($name eq $cnum)) {
7494: my $courseprivid=$env{'request.course.id'};
7495: $courseprivid=~s/\_/\//;
7496: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid
7497: .'/'.$dir[1]} =~/rgf\&([^\:]*)/) {
7498: return $1;
7499: } else {
7500: if ($env{'request.course.sec'}) {
7501: $courseprivid.='/'.$env{'request.course.sec'};
7502: }
7503: if ($env{'user.priv.'.$env{'request.role'}.'./'.
7504: $courseprivid} =~/(mdg|vcg)\&([^\:]*)/) {
7505: return $2;
7506: }
7507: }
7508: }
7509: }
7510: }
7511:
7512: # Free bre to public access
7513:
7514: if ($priv eq 'bre') {
7515: my $copyright;
7516: unless ($uri =~ /ext\.tool/) {
7517: $copyright=&metadata($uri,'copyright');
7518: }
7519: if (($copyright eq 'public') && (!$env{'request.course.id'})) {
7520: return 'F';
7521: }
7522: if ($copyright eq 'priv') {
7523: $uri=~/([^\/]+)\/([^\/]+)\//;
7524: unless (($env{'user.name'} eq $2) && ($env{'user.domain'} eq $1)) {
7525: return '';
7526: }
7527: }
7528: if ($copyright eq 'domain') {
7529: $uri=~/([^\/]+)\/([^\/]+)\//;
7530: unless (($env{'user.domain'} eq $1) ||
7531: ($env{'course.'.$env{'request.course.id'}.'.domain'} eq $1)) {
7532: return '';
7533: }
7534: }
7535: if ($env{'request.role'}=~ /li\.\//) {
7536: # Library role, so allow browsing of resources in this domain.
7537: return 'F';
7538: }
7539: if ($copyright eq 'custom') {
7540: unless (&customaccess($priv,$uri)) { return ''; }
7541: }
7542: }
7543: # Domain coordinator is trying to create a course
7544: if (($priv eq 'ccc') && ($env{'request.role'} =~ /^dc\./)) {
7545: # uri is the requested domain in this case.
7546: # comparison to 'request.role.domain' shows if the user has selected
7547: # a role of dc for the domain in question.
7548: return 'F' if ($uri eq $env{'request.role.domain'});
7549: }
7550:
7551: my $thisallowed='';
7552: my $statecond=0;
7553: my $courseprivid='';
7554:
7555: my $ownaccess;
7556: # Community Coordinator or Assistant Co-author browsing resource space.
7557: if (($priv eq 'bro') && ($env{'user.author'})) {
7558: if ($uri eq '') {
7559: $ownaccess = 1;
7560: } else {
7561: if (($env{'user.domain'} ne '') && ($env{'user.name'} ne '')) {
7562: my $udom = $env{'user.domain'};
7563: my $uname = $env{'user.name'};
7564: if ($uri =~ m{^\Q$udom\E/?$}) {
7565: $ownaccess = 1;
7566: } elsif ($uri =~ m{^\Q$udom\E/\Q$uname\E/?}) {
7567: unless ($uri =~ m{\.\./}) {
7568: $ownaccess = 1;
7569: }
7570: } elsif (($udom ne 'public') && ($uname ne 'public')) {
7571: my $now = time;
7572: if ($uri =~ m{^([^/]+)/?$}) {
7573: my $adom = $1;
7574: foreach my $key (keys(%env)) {
7575: if ($key =~ m{^user\.role\.(ca|aa)/\Q$adom\E}) {
7576: my ($start,$end) = split('.',$env{$key});
7577: if (($now >= $start) && (!$end || $end < $now)) {
7578: $ownaccess = 1;
7579: last;
7580: }
7581: }
7582: }
7583: } elsif ($uri =~ m{^([^/]+)/([^/]+)/?}) {
7584: my $adom = $1;
7585: my $aname = $2;
7586: foreach my $role ('ca','aa') {
7587: if ($env{"user.role.$role./$adom/$aname"}) {
7588: my ($start,$end) =
7589: split('.',$env{"user.role.$role./$adom/$aname"});
7590: if (($now >= $start) && (!$end || $end < $now)) {
7591: $ownaccess = 1;
7592: last;
7593: }
7594: }
7595: }
7596: }
7597: }
7598: }
7599: }
7600: }
7601:
7602: # Course
7603:
7604: if ($env{'user.priv.'.$env{'request.role'}.'./'}=~/\Q$priv\E\&([^\:]*)/) {
7605: unless (($priv eq 'bro') && (!$ownaccess)) {
7606: $thisallowed.=$1;
7607: }
7608: }
7609:
7610: # Domain
7611:
7612: if ($env{'user.priv.'.$env{'request.role'}.'./'.(split(/\//,$uri))[0].'/'}
7613: =~/\Q$priv\E\&([^\:]*)/) {
7614: unless (($priv eq 'bro') && (!$ownaccess)) {
7615: $thisallowed.=$1;
7616: }
7617: }
7618:
7619: # User who is not author or co-author might still be able to edit
7620: # resource of an author in the domain (e.g., if Domain Coordinator).
7621: if (($priv eq 'eco') && ($thisallowed eq '') && ($env{'request.course.id'}) &&
7622: (&allowed('mdc',$env{'request.course.id'}))) {
7623: if ($env{"user.priv.cm./$uri/"}=~/\Q$priv\E\&([^\:]*)/) {
7624: $thisallowed.=$1;
7625: }
7626: }
7627:
7628: # Course: uri itself is a course
7629: my $courseuri=$uri;
7630: $courseuri=~s/\_(\d)/\/$1/;
7631: $courseuri=~s/^([^\/])/\/$1/;
7632:
7633: if ($env{'user.priv.'.$env{'request.role'}.'.'.$courseuri}
7634: =~/\Q$priv\E\&([^\:]*)/) {
7635: unless (($priv eq 'bro') && (!$ownaccess)) {
7636: $thisallowed.=$1;
7637: }
7638: }
7639:
7640: # URI is an uploaded document for this course, default permissions don't matter
7641: # not allowing 'edit' access (editupload) to uploaded course docs
7642: if (($priv eq 'bre') && ($uri=~m|^uploaded/|)) {
7643: $thisallowed='';
7644: my ($match)=&is_on_map($uri);
7645: if ($match) {
7646: if ($env{'user.priv.'.$env{'request.role'}.'./'}
7647: =~/\Q$priv\E\&([^\:]*)/) {
7648: my $value = $1;
7649: if ($noblockcheck) {
7650: $thisallowed.=$value;
7651: } else {
7652: my @blockers = &has_comm_blocking($priv,$symb,$uri);
7653: if (@blockers > 0) {
7654: $thisallowed = 'B';
7655: } else {
7656: $thisallowed.=$value;
7657: }
7658: }
7659: }
7660: } else {
7661: my $refuri = $env{'httpref.'.$orguri} || $env{'httpref.'.$ver_orguri};
7662: if ($refuri) {
7663: if ($refuri =~ m|^/adm/|) {
7664: $thisallowed='F';
7665: } else {
7666: $refuri=&declutter($refuri);
7667: my ($match) = &is_on_map($refuri);
7668: if ($match) {
7669: if ($noblockcheck) {
7670: $thisallowed='F';
7671: } else {
7672: my @blockers = &has_comm_blocking($priv,$symb,$refuri);
7673: if (@blockers > 0) {
7674: $thisallowed = 'B';
7675: } else {
7676: $thisallowed='F';
7677: }
7678: }
7679: }
7680: }
7681: }
7682: }
7683: }
7684:
7685: if ($priv eq 'bre'
7686: && $thisallowed ne 'F'
7687: && $thisallowed ne '2'
7688: && &is_portfolio_url($uri)) {
7689: $thisallowed = &portfolio_access($uri,$clientip);
7690: }
7691:
7692: # Full access at system, domain or course-wide level? Exit.
7693: if ($thisallowed=~/F/) {
7694: return 'F';
7695: }
7696:
7697: # If this is generating or modifying users, exit with special codes
7698:
7699: if (':csu:cdc:ccc:cin:cta:cep:ccr:cst:cad:cli:cau:cdg:cca:caa:'=~/\:\Q$priv\E\:/) {
7700: if (($priv eq 'cca') || ($priv eq 'caa')) {
7701: my ($audom,$auname)=split('/',$uri);
7702: # no author name given, so this just checks on the general right to make a co-author in this domain
7703: unless ($auname) { return $thisallowed; }
7704: # an author name is given, so we are about to actually make a co-author for a certain account
7705: if (($auname ne $env{'user.name'} && $env{'request.role'} !~ /^dc\./) ||
7706: (($audom ne $env{'user.domain'} && $env{'request.role'} !~ /^dc\./) &&
7707: ($audom ne $env{'request.role.domain'}))) { return ''; }
7708: }
7709: return $thisallowed;
7710: }
7711: #
7712: # Gathered so far: system, domain and course wide privileges
7713: #
7714: # Course: See if uri or referer is an individual resource that is part of
7715: # the course
7716:
7717: if ($env{'request.course.id'}) {
7718:
7719: $courseprivid=$env{'request.course.id'};
7720: if ($env{'request.course.sec'}) {
7721: $courseprivid.='/'.$env{'request.course.sec'};
7722: }
7723: $courseprivid=~s/\_/\//;
7724: my $checkreferer=1;
7725: my ($match,$cond)=&is_on_map($uri);
7726: if ($match) {
7727: $statecond=$cond;
7728: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid}
7729: =~/\Q$priv\E\&([^\:]*)/) {
7730: my $value = $1;
7731: if ($priv eq 'bre') {
7732: if ($noblockcheck) {
7733: $thisallowed.=$value;
7734: } else {
7735: my @blockers = &has_comm_blocking($priv,$symb,$uri);
7736: if (@blockers > 0) {
7737: $thisallowed = 'B';
7738: } else {
7739: $thisallowed.=$value;
7740: }
7741: }
7742: } else {
7743: $thisallowed.=$value;
7744: }
7745: $checkreferer=0;
7746: }
7747: }
7748:
7749: if ($checkreferer) {
7750: my $refuri=$env{'httpref.'.$orguri};
7751: unless ($refuri) {
7752: foreach my $key (keys(%env)) {
7753: if ($key=~/^httpref\..*\*/) {
7754: my $pattern=$key;
7755: $pattern=~s/^httpref\.\/res\///;
7756: $pattern=~s/\*/\[\^\/\]\+/g;
7757: $pattern=~s/\//\\\//g;
7758: if ($orguri=~/$pattern/) {
7759: $refuri=$env{$key};
7760: }
7761: }
7762: }
7763: }
7764:
7765: if ($refuri) {
7766: $refuri=&declutter($refuri);
7767: my ($match,$cond)=&is_on_map($refuri);
7768: if ($match) {
7769: my $refstatecond=$cond;
7770: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid}
7771: =~/\Q$priv\E\&([^\:]*)/) {
7772: my $value = $1;
7773: if ($priv eq 'bre') {
7774: if ($noblockcheck) {
7775: $thisallowed.=$value;
7776: } else {
7777: my @blockers = &has_comm_blocking($priv,$symb,$refuri);
7778: if (@blockers > 0) {
7779: $thisallowed = 'B';
7780: } else {
7781: $thisallowed.=$value;
7782: }
7783: }
7784: } else {
7785: $thisallowed.=$value;
7786: }
7787: $uri=$refuri;
7788: $statecond=$refstatecond;
7789: }
7790: }
7791: }
7792: }
7793: }
7794:
7795: #
7796: # Gathered now: all privileges that could apply, and condition number
7797: #
7798: #
7799: # Full or no access?
7800: #
7801:
7802: if ($thisallowed=~/F/) {
7803: return 'F';
7804: }
7805:
7806: unless ($thisallowed) {
7807: return '';
7808: }
7809:
7810: # Restrictions exist, deal with them
7811: #
7812: # C:according to course preferences
7813: # R:according to resource settings
7814: # L:unless locked
7815: # X:according to user session state
7816: #
7817:
7818: # Possibly locked functionality, check all courses
7819: # Locks might take effect only after 10 minutes cache expiration for other
7820: # courses, and 2 minutes for current course
7821:
7822: my $envkey;
7823: if ($thisallowed=~/L/) {
7824: foreach $envkey (keys(%env)) {
7825: if ($envkey=~/^user\.role\.(st|ta)\.([^\.]*)/) {
7826: my $courseid=$2;
7827: my $roleid=$1.'.'.$2;
7828: $courseid=~s/^\///;
7829: my $expiretime=600;
7830: if ($env{'request.role'} eq $roleid) {
7831: $expiretime=120;
7832: }
7833: my ($cdom,$cnum,$csec)=split(/\//,$courseid);
7834: my $prefix='course.'.$cdom.'_'.$cnum.'.';
7835: if ((time-$env{$prefix.'last_cache'})>$expiretime) {
7836: &coursedescription($courseid,{'freshen_cache' => 1});
7837: }
7838: if (($env{$prefix.'res.'.$uri.'.lock.sections'}=~/\,\Q$csec\E\,/)
7839: || ($env{$prefix.'res.'.$uri.'.lock.sections'} eq 'all')) {
7840: if ($env{$prefix.'res.'.$uri.'.lock.expire'}>time) {
7841: &log($env{'user.domain'},$env{'user.name'},
7842: $env{'user.home'},
7843: 'Locked by res: '.$priv.' for '.$uri.' due to '.
7844: $cdom.'/'.$cnum.'/'.$csec.' expire '.
7845: $env{$prefix.'priv.'.$priv.'.lock.expire'});
7846: return '';
7847: }
7848: }
7849: if (($env{$prefix.'priv.'.$priv.'.lock.sections'}=~/\,\Q$csec\E\,/)
7850: || ($env{$prefix.'priv.'.$priv.'.lock.sections'} eq 'all')) {
7851: if ($env{'priv.'.$priv.'.lock.expire'}>time) {
7852: &log($env{'user.domain'},$env{'user.name'},
7853: $env{'user.home'},
7854: 'Locked by priv: '.$priv.' for '.$uri.' due to '.
7855: $cdom.'/'.$cnum.'/'.$csec.' expire '.
7856: $env{$prefix.'priv.'.$priv.'.lock.expire'});
7857: return '';
7858: }
7859: }
7860: }
7861: }
7862: }
7863:
7864: #
7865: # Rest of the restrictions depend on selected course
7866: #
7867:
7868: unless ($env{'request.course.id'}) {
7869: if ($thisallowed eq 'A') {
7870: return 'A';
7871: } elsif ($thisallowed eq 'B') {
7872: return 'B';
7873: } else {
7874: return '1';
7875: }
7876: }
7877:
7878: #
7879: # Now user is definitely in a course
7880: #
7881:
7882:
7883: # Course preferences
7884:
7885: if ($thisallowed=~/C/) {
7886: my $rolecode=(split(/\./,$env{'request.role'}))[0];
7887: my $unamedom=$env{'user.name'}.':'.$env{'user.domain'};
7888: if ($env{'course.'.$env{'request.course.id'}.'.'.$priv.'.roles.denied'}
7889: =~/\Q$rolecode\E/) {
7890: if (($priv ne 'pch') && ($priv ne 'plc') && ($priv ne 'pac')) {
7891: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.':'.
7892: 'Denied by role: '.$priv.' for '.$uri.' as '.$rolecode.' in '.
7893: $env{'request.course.id'});
7894: }
7895: return '';
7896: }
7897:
7898: if ($env{'course.'.$env{'request.course.id'}.'.'.$priv.'.users.denied'}
7899: =~/\Q$unamedom\E/) {
7900: if (($priv ne 'pch') && ($priv ne 'plc') && ($priv ne 'pac')) {
7901: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.
7902: 'Denied by user: '.$priv.' for '.$uri.' as '.$unamedom.' in '.
7903: $env{'request.course.id'});
7904: }
7905: return '';
7906: }
7907: }
7908:
7909: # Resource preferences
7910:
7911: if ($thisallowed=~/R/) {
7912: my $rolecode=(split(/\./,$env{'request.role'}))[0];
7913: if (&metadata($uri,'roledeny')=~/\Q$rolecode\E/) {
7914: if (($priv ne 'pch') && ($priv ne 'plc')) {
7915: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.':'.
7916: 'Denied by role: '.$priv.' for '.$uri.' as '.$rolecode);
7917: }
7918: return '';
7919: }
7920: }
7921:
7922: # Restricted by state or randomout?
7923:
7924: if ($thisallowed=~/X/) {
7925: if ($env{'acc.randomout'}) {
7926: if (!$symb) { $symb=&symbread($uri,1); }
7927: if (($symb) && ($env{'acc.randomout'}=~/\&\Q$symb\E\&/)) {
7928: return '';
7929: }
7930: }
7931: if (&condval($statecond)) {
7932: return '2';
7933: } else {
7934: return '';
7935: }
7936: }
7937:
7938: if ($thisallowed eq 'A') {
7939: return 'A';
7940: } elsif ($thisallowed eq 'B') {
7941: return 'B';
7942: }
7943: return 'F';
7944: }
7945:
7946: # ------------------------------------------- Check construction space access
7947:
7948: sub constructaccess {
7949: my ($url,$setpriv)=@_;
7950:
7951: # We do not allow editing of previous versions of files
7952: if ($url=~/\.(\d+)\.(\w+)$/) { return ''; }
7953:
7954: # Get username and domain from URL
7955: my ($ownername,$ownerdomain,$ownerhome);
7956:
7957: ($ownerdomain,$ownername) =
7958: ($url=~ m{^(?:\Q$perlvar{'lonDocRoot'}\E|)(?:/daxepage|/daxeopen)?/priv/($match_domain)/($match_username)(?:/|$)});
7959:
7960: # The URL does not really point to any authorspace, forget it
7961: unless (($ownername) && ($ownerdomain)) { return ''; }
7962:
7963: # Now we need to see if the user has access to the authorspace of
7964: # $ownername at $ownerdomain
7965:
7966: if (($ownername eq $env{'user.name'}) && ($ownerdomain eq $env{'user.domain'})) {
7967: # Real author for this?
7968: $ownerhome = $env{'user.home'};
7969: if (exists($env{'user.priv.au./'.$ownerdomain.'/./'})) {
7970: return ($ownername,$ownerdomain,$ownerhome);
7971: }
7972: } else {
7973: # Co-author for this?
7974: if (exists($env{'user.priv.ca./'.$ownerdomain.'/'.$ownername.'./'}) ||
7975: exists($env{'user.priv.aa./'.$ownerdomain.'/'.$ownername.'./'}) ) {
7976: $ownerhome = &homeserver($ownername,$ownerdomain);
7977: return ($ownername,$ownerdomain,$ownerhome);
7978: }
7979: if ($env{'request.course.id'}) {
7980: if (($ownername eq $env{'course.'.$env{'request.course.id'}.'.num'}) &&
7981: ($ownerdomain eq $env{'course.'.$env{'request.course.id'}.'.domain'})) {
7982: if (&allowed('mdc',$env{'request.course.id'})) {
7983: $ownerhome = $env{'course.'.$env{'request.course.id'}.'.home'};
7984: return ($ownername,$ownerdomain,$ownerhome);
7985: }
7986: }
7987: }
7988: }
7989:
7990: # We don't have any access right now. If we are not possibly going to do anything about this,
7991: # we might as well leave
7992: unless ($setpriv) { return ''; }
7993:
7994: # Backdoor access?
7995: my $allowed=&allowed('eco',$ownerdomain);
7996: # Nope
7997: unless ($allowed) { return ''; }
7998: # Looks like we may have access, but could be locked by the owner of the construction space
7999: if ($allowed eq 'U') {
8000: my %blocked=&get('environment',['domcoord.author'],
8001: $ownerdomain,$ownername);
8002: # Is blocked by owner
8003: if ($blocked{'domcoord.author'} eq 'blocked') { return ''; }
8004: }
8005: if (($allowed eq 'F') || ($allowed eq 'U')) {
8006: # Grant temporary access
8007: my $then=$env{'user.login.time'};
8008: my $update=$env{'user.update.time'};
8009: if (!$update) { $update = $then; }
8010: my $refresh=$env{'user.refresh.time'};
8011: if (!$refresh) { $refresh = $update; }
8012: my $now = time;
8013: &check_adhoc_privs($ownerdomain,$ownername,$update,$refresh,
8014: $now,'ca','constructaccess');
8015: $ownerhome = &homeserver($ownername,$ownerdomain);
8016: return($ownername,$ownerdomain,$ownerhome);
8017: }
8018: # No business here
8019: return '';
8020: }
8021:
8022: # ----------------------------------------------------------- Content Blocking
8023:
8024: {
8025: # Caches for faster Course Contents display where content blocking
8026: # is in operation (i.e., interval param set) for timed quiz.
8027: #
8028: # User for whom data are being temporarily cached.
8029: my $cacheduser='';
8030: # Cached blockers for this user (a hash of blocking items).
8031: my %cachedblockers=();
8032: # When the data were last cached.
8033: my $cachedlast='';
8034:
8035: sub load_all_blockers {
8036: my ($uname,$udom,$blocks)=@_;
8037: if (($uname ne '') && ($udom ne '')) {
8038: if (($cacheduser eq $uname.':'.$udom) &&
8039: (abs($cachedlast-time)<5)) {
8040: return;
8041: }
8042: }
8043: $cachedlast=time;
8044: $cacheduser=$uname.':'.$udom;
8045: %cachedblockers = &get_commblock_resources($blocks);
8046: }
8047:
8048: sub get_comm_blocks {
8049: my ($cdom,$cnum) = @_;
8050: if ($cdom eq '' || $cnum eq '') {
8051: return unless ($env{'request.course.id'});
8052: $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
8053: $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
8054: }
8055: my %commblocks;
8056: my $hashid=$cdom.'_'.$cnum;
8057: my ($blocksref,$cached)=&is_cached_new('comm_block',$hashid);
8058: if ((defined($cached)) && (ref($blocksref) eq 'HASH')) {
8059: %commblocks = %{$blocksref};
8060: } else {
8061: %commblocks = &Apache::lonnet::dump('comm_block',$cdom,$cnum);
8062: my $cachetime = 600;
8063: &do_cache_new('comm_block',$hashid,\%commblocks,$cachetime);
8064: }
8065: return %commblocks;
8066: }
8067:
8068: sub get_commblock_resources {
8069: my ($blocks) = @_;
8070: my %blockers = ();
8071: return %blockers unless ($env{'request.course.id'});
8072: return %blockers if ($env{'user.priv.'.$env{'request.role'}} =~/evb\&([^\:]*)/);
8073: my %commblocks;
8074: if (ref($blocks) eq 'HASH') {
8075: %commblocks = %{$blocks};
8076: } else {
8077: %commblocks = &get_comm_blocks();
8078: }
8079: return %blockers unless (keys(%commblocks) > 0);
8080: my $navmap = Apache::lonnavmaps::navmap->new();
8081: return %blockers unless (ref($navmap));
8082: my $now = time;
8083: foreach my $block (keys(%commblocks)) {
8084: if ($block =~ /^(\d+)____(\d+)$/) {
8085: my ($start,$end) = ($1,$2);
8086: if ($start <= $now && $end >= $now) {
8087: if (ref($commblocks{$block}{'blocks'}) eq 'HASH') {
8088: if (ref($commblocks{$block}{'blocks'}{'docs'}) eq 'HASH') {
8089: if (ref($commblocks{$block}{'blocks'}{'docs'}{'maps'}) eq 'HASH') {
8090: if (keys(%{$commblocks{$block}{'blocks'}{'docs'}{'maps'}})) {
8091: $blockers{$block}{maps} = $commblocks{$block}{'blocks'}{'docs'}{'maps'};
8092: }
8093: }
8094: if (ref($commblocks{$block}{'blocks'}{'docs'}{'resources'}) eq 'HASH') {
8095: if (keys(%{$commblocks{$block}{'blocks'}{'docs'}{'resources'}})) {
8096: $blockers{$block}{'resources'} = $commblocks{$block}{'blocks'}{'docs'}{'resources'};
8097: }
8098: }
8099: }
8100: }
8101: }
8102: } elsif ($block =~ /^firstaccess____(.+)$/) {
8103: my $item = $1;
8104: my @to_test;
8105: if (ref($commblocks{$block}{'blocks'}) eq 'HASH') {
8106: if (ref($commblocks{$block}{'blocks'}{'docs'}) eq 'HASH') {
8107: my @interval;
8108: my $type = 'map';
8109: if ($item eq 'course') {
8110: $type = 'course';
8111: @interval=&EXT("resource.0.interval");
8112: } else {
8113: if ($item =~ /___\d+___/) {
8114: $type = 'resource';
8115: @interval=&EXT("resource.0.interval",$item);
8116: if (ref($navmap)) {
8117: my $res = $navmap->getBySymb($item);
8118: push(@to_test,$res);
8119: }
8120: } else {
8121: my $mapsymb = &symbread($item,1);
8122: if ($mapsymb) {
8123: if (ref($navmap)) {
8124: my $mapres = $navmap->getBySymb($mapsymb);
8125: @to_test = $mapres->retrieveResources($mapres,undef,0,0,0,1);
8126: foreach my $res (@to_test) {
8127: my $symb = $res->symb();
8128: next if ($symb eq $mapsymb);
8129: if ($symb ne '') {
8130: @interval=&EXT("resource.0.interval",$symb);
8131: if ($interval[1] eq 'map') {
8132: last;
8133: }
8134: }
8135: }
8136: }
8137: }
8138: }
8139: }
8140: if ($interval[0] =~ /^(\d+)/) {
8141: my $timelimit = $1;
8142: my $first_access;
8143: if ($type eq 'resource') {
8144: $first_access=&get_first_access($interval[1],$item);
8145: } elsif ($type eq 'map') {
8146: $first_access=&get_first_access($interval[1],undef,$item);
8147: } else {
8148: $first_access=&get_first_access($interval[1]);
8149: }
8150: if ($first_access) {
8151: my $timesup = $first_access+$timelimit;
8152: if ($timesup > $now) {
8153: my $activeblock;
8154: foreach my $res (@to_test) {
8155: if ($res->answerable()) {
8156: $activeblock = 1;
8157: last;
8158: }
8159: }
8160: if ($activeblock) {
8161: if (ref($commblocks{$block}{'blocks'}{'docs'}{'maps'}) eq 'HASH') {
8162: if (keys(%{$commblocks{$block}{'blocks'}{'docs'}{'maps'}})) {
8163: $blockers{$block}{'maps'} = $commblocks{$block}{'blocks'}{'docs'}{'maps'};
8164: }
8165: }
8166: if (ref($commblocks{$block}{'blocks'}{'docs'}{'resources'}) eq 'HASH') {
8167: if (keys(%{$commblocks{$block}{'blocks'}{'docs'}{'resources'}})) {
8168: $blockers{$block}{'resources'} = $commblocks{$block}{'blocks'}{'docs'}{'resources'};
8169: }
8170: }
8171: }
8172: }
8173: }
8174: }
8175: }
8176: }
8177: }
8178: }
8179: return %blockers;
8180: }
8181:
8182: sub has_comm_blocking {
8183: my ($priv,$symb,$uri,$blocks) = @_;
8184: my @blockers;
8185: return unless ($env{'request.course.id'});
8186: return unless ($priv eq 'bre');
8187: return if ($env{'user.priv.'.$env{'request.role'}} =~/evb\&([^\:]*)/);
8188: return if ($env{'request.state'} eq 'construct');
8189: &load_all_blockers($env{'user.name'},$env{'user.domain'},$blocks);
8190: return unless (keys(%cachedblockers) > 0);
8191: my (%possibles,@symbs);
8192: if (!$symb) {
8193: $symb = &symbread($uri,1,1,1,\%possibles);
8194: }
8195: if ($symb) {
8196: @symbs = ($symb);
8197: } elsif (keys(%possibles)) {
8198: @symbs = keys(%possibles);
8199: }
8200: my $noblock;
8201: foreach my $symb (@symbs) {
8202: last if ($noblock);
8203: my ($map,$resid,$resurl)=&decode_symb($symb);
8204: foreach my $block (keys(%cachedblockers)) {
8205: if ($block =~ /^firstaccess____(.+)$/) {
8206: my $item = $1;
8207: if (($item eq $map) || ($item eq $symb)) {
8208: $noblock = 1;
8209: last;
8210: }
8211: }
8212: if (ref($cachedblockers{$block}) eq 'HASH') {
8213: if (ref($cachedblockers{$block}{'resources'}) eq 'HASH') {
8214: if ($cachedblockers{$block}{'resources'}{$symb}) {
8215: unless (grep(/^\Q$block\E$/,@blockers)) {
8216: push(@blockers,$block);
8217: }
8218: }
8219: }
8220: }
8221: if (ref($cachedblockers{$block}{'maps'}) eq 'HASH') {
8222: if ($cachedblockers{$block}{'maps'}{$map}) {
8223: unless (grep(/^\Q$block\E$/,@blockers)) {
8224: push(@blockers,$block);
8225: }
8226: }
8227: }
8228: }
8229: }
8230: return if ($noblock);
8231: return @blockers;
8232: }
8233: }
8234:
8235: # -------------------------------- Deversion and split uri into path an filename
8236:
8237: #
8238: # Removes the version from a URI and
8239: # splits it in to its filename and path to the filename.
8240: # Seems like File::Basename could have done this more clearly.
8241: # Parameters:
8242: # $uri - input URI
8243: # Returns:
8244: # Two element list consisting of
8245: # $pathname - the URI up to and excluding the trailing /
8246: # $filename - The part of the URI following the last /
8247: # NOTE:
8248: # Another realization of this is simply:
8249: # use File::Basename;
8250: # ...
8251: # $uri = shift;
8252: # $filename = basename($uri);
8253: # $path = dirname($uri);
8254: # return ($filename, $path);
8255: #
8256: # The implementation below is probably faster however.
8257: #
8258: sub split_uri_for_cond {
8259: my $uri=&deversion(&declutter(shift));
8260: my @uriparts=split(/\//,$uri);
8261: my $filename=pop(@uriparts);
8262: my $pathname=join('/',@uriparts);
8263: return ($pathname,$filename);
8264: }
8265: # --------------------------------------------------- Is a resource on the map?
8266:
8267: sub is_on_map {
8268: my ($pathname,$filename) = &split_uri_for_cond(shift);
8269: #Trying to find the conditional for the file
8270: my $match=($env{'acc.res.'.$env{'request.course.id'}.'.'.$pathname}=~
8271: /\&\Q$filename\E\:([\d\|]+)\&/);
8272: if ($match) {
8273: return (1,$1);
8274: } else {
8275: return (0,0);
8276: }
8277: }
8278:
8279: # --------------------------------------------------------- Get symb from alias
8280:
8281: sub get_symb_from_alias {
8282: my $symb=shift;
8283: my ($map,$resid,$url)=&decode_symb($symb);
8284: # Already is a symb
8285: if ($url) { return $symb; }
8286: # Must be an alias
8287: my $aliassymb='';
8288: my %bighash;
8289: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
8290: &GDBM_READER(),0640)) {
8291: my $rid=$bighash{'mapalias_'.$symb};
8292: if ($rid) {
8293: my ($mapid,$resid)=split(/\./,$rid);
8294: $aliassymb=&encode_symb($bighash{'map_id_'.$mapid},
8295: $resid,$bighash{'src_'.$rid});
8296: }
8297: untie %bighash;
8298: }
8299: return $aliassymb;
8300: }
8301:
8302: # ----------------------------------------------------------------- Define Role
8303:
8304: sub definerole {
8305: if (allowed('mcr','/')) {
8306: my ($rolename,$sysrole,$domrole,$courole,$uname,$udom)=@_;
8307: foreach my $role (split(':',$sysrole)) {
8308: my ($crole,$cqual)=split(/\&/,$role);
8309: if ($pr{'cr:s'}!~/\Q$crole\E/) { return "refused:s:$crole"; }
8310: if ($pr{'cr:s'}=~/\Q$crole\E\&/) {
8311: if ($pr{'cr:s'}!~/\Q$crole\E\&\w*\Q$cqual\E/) {
8312: return "refused:s:$crole&$cqual";
8313: }
8314: }
8315: }
8316: foreach my $role (split(':',$domrole)) {
8317: my ($crole,$cqual)=split(/\&/,$role);
8318: if ($pr{'cr:d'}!~/\Q$crole\E/) { return "refused:d:$crole"; }
8319: if ($pr{'cr:d'}=~/\Q$crole\E\&/) {
8320: if ($pr{'cr:d'}!~/\Q$crole\W\&\w*\Q$cqual\E/) {
8321: return "refused:d:$crole&$cqual";
8322: }
8323: }
8324: }
8325: foreach my $role (split(':',$courole)) {
8326: my ($crole,$cqual)=split(/\&/,$role);
8327: if ($pr{'cr:c'}!~/\Q$crole\E/) { return "refused:c:$crole"; }
8328: if ($pr{'cr:c'}=~/\Q$crole\E\&/) {
8329: if ($pr{'cr:c'}!~/\Q$crole\E\&\w*\Q$cqual\E/) {
8330: return "refused:c:$crole&$cqual";
8331: }
8332: }
8333: }
8334: my $uhome;
8335: if (($uname ne '') && ($udom ne '')) {
8336: $uhome = &homeserver($uname,$udom);
8337: return $uhome if ($uhome eq 'no_host');
8338: } else {
8339: $uname = $env{'user.name'};
8340: $udom = $env{'user.domain'};
8341: $uhome = $env{'user.home'};
8342: }
8343: my $command="encrypt:rolesput:$env{'user.domain'}:$env{'user.name'}:".
8344: "$udom:$uname:rolesdef_$rolename=".
8345: escape($sysrole.'_'.$domrole.'_'.$courole);
8346: return reply($command,$uhome);
8347: } else {
8348: return 'refused';
8349: }
8350: }
8351:
8352: # ---------------- Make a metadata query against the network of library servers
8353:
8354: sub metadata_query {
8355: my ($query,$custom,$customshow,$server_array,$domains_hash)=@_;
8356: my %rhash;
8357: my %libserv = &all_library();
8358: my @server_list = (defined($server_array) ? @$server_array
8359: : keys(%libserv) );
8360: for my $server (@server_list) {
8361: my $domains = '';
8362: if (ref($domains_hash) eq 'HASH') {
8363: $domains = $domains_hash->{$server};
8364: }
8365: unless ($custom or $customshow) {
8366: my $reply=&reply("querysend:".&escape($query).':::'.&escape($domains),$server);
8367: $rhash{$server}=$reply;
8368: }
8369: else {
8370: my $reply=&reply("querysend:".&escape($query).':'.
8371: &escape($custom).':'.&escape($customshow).':'.&escape($domains),
8372: $server);
8373: $rhash{$server}=$reply;
8374: }
8375: }
8376: return \%rhash;
8377: }
8378:
8379: # ----------------------------------------- Send log queries and wait for reply
8380:
8381: sub log_query {
8382: my ($uname,$udom,$query,%filters)=@_;
8383: my $uhome=&homeserver($uname,$udom);
8384: if ($uhome eq 'no_host') { return 'error: no_host'; }
8385: my $uhost=&hostname($uhome);
8386: my $command=&escape(join(':',map{$_.'='.$filters{$_}} keys(%filters)));
8387: my $queryid=&reply("querysend:".$query.':'.$udom.':'.$uname.':'.$command,
8388: $uhome);
8389: unless ($queryid=~/^\Q$uhost\E\_/) { return 'error: '.$queryid; }
8390: return get_query_reply($queryid);
8391: }
8392:
8393: # -------------------------- Update MySQL table for portfolio file
8394:
8395: sub update_portfolio_table {
8396: my ($uname,$udom,$file_name,$query,$group,$action) = @_;
8397: if ($group ne '') {
8398: $file_name =~s /^\Q$group\E//;
8399: }
8400: my $homeserver = &homeserver($uname,$udom);
8401: my $queryid=
8402: &reply("querysend:".$query.':'.&escape($uname.':'.$udom.':'.$group).
8403: ':'.&escape($file_name).':'.$action,$homeserver);
8404: my $reply = &get_query_reply($queryid);
8405: return $reply;
8406: }
8407:
8408: # -------------------------- Update MySQL allusers table
8409:
8410: sub update_allusers_table {
8411: my ($uname,$udom,$names) = @_;
8412: my $homeserver = &homeserver($uname,$udom);
8413: my $queryid=
8414: &reply('querysend:allusers:'.&escape($uname).':'.&escape($udom).':'.
8415: 'lastname='.&escape($names->{'lastname'}).'%%'.
8416: 'firstname='.&escape($names->{'firstname'}).'%%'.
8417: 'middlename='.&escape($names->{'middlename'}).'%%'.
8418: 'generation='.&escape($names->{'generation'}).'%%'.
8419: 'permanentemail='.&escape($names->{'permanentemail'}).'%%'.
8420: 'id='.&escape($names->{'id'}),$homeserver);
8421: return;
8422: }
8423:
8424: # ------- Request retrieval of institutional classlists for course(s)
8425:
8426: sub fetch_enrollment_query {
8427: my ($context,$affiliatesref,$replyref,$dom,$cnum) = @_;
8428: my ($homeserver,$sleep,$loopmax);
8429: my $maxtries = 1;
8430: if ($context eq 'automated') {
8431: $homeserver = $perlvar{'lonHostID'};
8432: $sleep = 2;
8433: $loopmax = 100;
8434: $maxtries = 10; # will wait for up to 2000s for retrieval of classlist data before timeout
8435: } else {
8436: $homeserver = &homeserver($cnum,$dom);
8437: }
8438: my $host=&hostname($homeserver);
8439: my $cmd = '';
8440: foreach my $affiliate (keys(%{$affiliatesref})) {
8441: $cmd .= $affiliate.'='.join(",",@{$$affiliatesref{$affiliate}}).'%%';
8442: }
8443: $cmd =~ s/%%$//;
8444: $cmd = &escape($cmd);
8445: my $query = 'fetchenrollment';
8446: my $queryid=&reply("querysend:".$query.':'.$dom.':'.$env{'user.name'}.':'.$cmd,$homeserver);
8447: unless ($queryid=~/^\Q$host\E\_/) {
8448: &logthis('fetch_enrollment_query: invalid queryid: '.$queryid.' for host: '.$host.' and homeserver: '.$homeserver.' context: '.$context.' '.$cnum);
8449: return 'error: '.$queryid;
8450: }
8451: my $reply = &get_query_reply($queryid,$sleep,$loopmax);
8452: my $tries = 1;
8453: while (($reply=~/^timeout/) && ($tries < $maxtries)) {
8454: $reply = &get_query_reply($queryid,$sleep,$loopmax);
8455: $tries ++;
8456: }
8457: if ( ($reply =~/^timeout/) || ($reply =~/^error/) ) {
8458: &logthis('fetch_enrollment_query error: '.$reply.' for '.$dom.' '.$env{'user.name'}.' for '.$queryid.' context: '.$context.' '.$cnum.' maxtries: '.$maxtries.' tries: '.$tries);
8459: } else {
8460: my @responses = split(/:/,$reply);
8461: if (grep { $_ eq $homeserver } ¤t_machine_ids()) {
8462: foreach my $line (@responses) {
8463: my ($key,$value) = split(/=/,$line,2);
8464: $$replyref{$key} = $value;
8465: }
8466: } else {
8467: my $pathname = LONCAPA::tempdir();
8468: foreach my $line (@responses) {
8469: my ($key,$value) = split(/=/,$line);
8470: $$replyref{$key} = $value;
8471: if ($value > 0) {
8472: foreach my $item (@{$$affiliatesref{$key}}) {
8473: my $filename = $dom.'_'.$key.'_'.$item.'_classlist.xml';
8474: my $destname = $pathname.'/'.$filename;
8475: my $xml_classlist = &reply("autoretrieve:".$filename,$homeserver);
8476: if ($xml_classlist =~ /^error/) {
8477: &logthis('fetch_enrollment_query - autoretrieve error: '.$xml_classlist.' for '.$filename.' from server: '.$homeserver.' '.$context.' '.$cnum);
8478: } else {
8479: if ( open(FILE,">",$destname) ) {
8480: print FILE &unescape($xml_classlist);
8481: close(FILE);
8482: } else {
8483: &logthis('fetch_enrollment_query - error opening classlist file '.$destname.' '.$context.' '.$cnum);
8484: }
8485: }
8486: }
8487: }
8488: }
8489: }
8490: return 'ok';
8491: }
8492: return 'error';
8493: }
8494:
8495: sub get_query_reply {
8496: my ($queryid,$sleep,$loopmax) = @_;;
8497: if (($sleep eq '') || ($sleep !~ /^\d+\.?\d*$/)) {
8498: $sleep = 0.2;
8499: }
8500: if (($loopmax eq '') || ($loopmax =~ /\D/)) {
8501: $loopmax = 100;
8502: }
8503: my $replyfile=LONCAPA::tempdir().$queryid;
8504: my $reply='';
8505: for (1..$loopmax) {
8506: sleep($sleep);
8507: if (-e $replyfile.'.end') {
8508: if (open(my $fh,"<",$replyfile)) {
8509: $reply = join('',<$fh>);
8510: close($fh);
8511: } else { return 'error: reply_file_error'; }
8512: return &unescape($reply);
8513: }
8514: }
8515: return 'timeout:'.$queryid;
8516: }
8517:
8518: sub courselog_query {
8519: #
8520: # possible filters:
8521: # url: url or symb
8522: # username
8523: # domain
8524: # action: view, submit, grade
8525: # start: timestamp
8526: # end: timestamp
8527: #
8528: my (%filters)=@_;
8529: unless ($env{'request.course.id'}) { return 'no_course'; }
8530: if ($filters{'url'}) {
8531: $filters{'url'}=&symbclean(&declutter($filters{'url'}));
8532: $filters{'url'}=~s/\.(\w+)$/(\\.\\d+)*\\.$1/;
8533: $filters{'url'}=~s/\.(\w+)\_\_\_/(\\.\\d+)*\\.$1/;
8534: }
8535: my $cname=$env{'course.'.$env{'request.course.id'}.'.num'};
8536: my $cdom=$env{'course.'.$env{'request.course.id'}.'.domain'};
8537: return &log_query($cname,$cdom,'courselog',%filters);
8538: }
8539:
8540: sub userlog_query {
8541: #
8542: # possible filters:
8543: # action: log check role
8544: # start: timestamp
8545: # end: timestamp
8546: #
8547: my ($uname,$udom,%filters)=@_;
8548: return &log_query($uname,$udom,'userlog',%filters);
8549: }
8550:
8551: #--------- Call auto-enrollment subs in localenroll.pm for homeserver for course
8552:
8553: sub auto_run {
8554: my ($cnum,$cdom) = @_;
8555: my $response = 0;
8556: my $settings;
8557: my %domconfig = &get_dom('configuration',['autoenroll'],$cdom);
8558: if (ref($domconfig{'autoenroll'}) eq 'HASH') {
8559: $settings = $domconfig{'autoenroll'};
8560: if ($settings->{'run'} eq '1') {
8561: $response = 1;
8562: }
8563: } else {
8564: my $homeserver;
8565: if (&is_course($cdom,$cnum)) {
8566: $homeserver = &homeserver($cnum,$cdom);
8567: } else {
8568: $homeserver = &domain($cdom,'primary');
8569: }
8570: if ($homeserver ne 'no_host') {
8571: $response = &reply('autorun:'.$cdom,$homeserver);
8572: }
8573: }
8574: return $response;
8575: }
8576:
8577: sub auto_get_sections {
8578: my ($cnum,$cdom,$inst_coursecode) = @_;
8579: my $homeserver;
8580: if (($cdom =~ /^$match_domain$/) && ($cnum =~ /^$match_courseid$/)) {
8581: $homeserver = &homeserver($cnum,$cdom);
8582: }
8583: if (!defined($homeserver)) {
8584: if ($cdom =~ /^$match_domain$/) {
8585: $homeserver = &domain($cdom,'primary');
8586: }
8587: }
8588: my @secs;
8589: if (defined($homeserver)) {
8590: my $response=&unescape(&reply('autogetsections:'.$inst_coursecode.':'.$cdom,$homeserver));
8591: unless ($response eq 'refused') {
8592: @secs = split(/:/,$response);
8593: }
8594: }
8595: return @secs;
8596: }
8597:
8598: sub auto_new_course {
8599: my ($cnum,$cdom,$inst_course_id,$owner,$coowners) = @_;
8600: my $homeserver = &homeserver($cnum,$cdom);
8601: my $response=&unescape(&reply('autonewcourse:'.$inst_course_id.':'.&escape($owner).':'.$cdom.':'.&escape($coowners),$homeserver));
8602: return $response;
8603: }
8604:
8605: sub auto_validate_courseID {
8606: my ($cnum,$cdom,$inst_course_id) = @_;
8607: my $homeserver = &homeserver($cnum,$cdom);
8608: my $response=&unescape(&reply('autovalidatecourse:'.$inst_course_id.':'.$cdom,$homeserver));
8609: return $response;
8610: }
8611:
8612: sub auto_validate_instcode {
8613: my ($cnum,$cdom,$instcode,$owner) = @_;
8614: my ($homeserver,$response);
8615: if (($cdom =~ /^$match_domain$/) && ($cnum =~ /^$match_courseid$/)) {
8616: $homeserver = &homeserver($cnum,$cdom);
8617: }
8618: if (!defined($homeserver)) {
8619: if ($cdom =~ /^$match_domain$/) {
8620: $homeserver = &domain($cdom,'primary');
8621: }
8622: }
8623: $response=&unescape(&reply('autovalidateinstcode:'.$cdom.':'.
8624: &escape($instcode).':'.&escape($owner),$homeserver));
8625: my ($outcome,$description,$defaultcredits) = map { &unescape($_); } split('&',$response,3);
8626: return ($outcome,$description,$defaultcredits);
8627: }
8628:
8629: sub auto_create_password {
8630: my ($cnum,$cdom,$authparam,$udom) = @_;
8631: my ($homeserver,$response);
8632: my $create_passwd = 0;
8633: my $authchk = '';
8634: if ($udom =~ /^$match_domain$/) {
8635: $homeserver = &domain($udom,'primary');
8636: }
8637: if ($homeserver eq '') {
8638: if (($cdom =~ /^$match_domain$/) && ($cnum =~ /^$match_courseid$/)) {
8639: $homeserver = &homeserver($cnum,$cdom);
8640: }
8641: }
8642: if ($homeserver eq '') {
8643: $authchk = 'nodomain';
8644: } else {
8645: $response=&unescape(&reply('autocreatepassword:'.$authparam.':'.$cdom,$homeserver));
8646: if ($response eq 'refused') {
8647: $authchk = 'refused';
8648: } else {
8649: ($authparam,$create_passwd,$authchk) = split(/:/,$response);
8650: }
8651: }
8652: return ($authparam,$create_passwd,$authchk);
8653: }
8654:
8655: sub auto_photo_permission {
8656: my ($cnum,$cdom,$students) = @_;
8657: my $homeserver = &homeserver($cnum,$cdom);
8658: my ($outcome,$perm_reqd,$conditions) =
8659: split(/:/,&unescape(&reply('autophotopermission:'.$cdom,$homeserver)),3);
8660: if ($outcome =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
8661: return (undef,undef);
8662: }
8663: return ($outcome,$perm_reqd,$conditions);
8664: }
8665:
8666: sub auto_checkphotos {
8667: my ($uname,$udom,$pid) = @_;
8668: my $homeserver = &homeserver($uname,$udom);
8669: my ($result,$resulttype);
8670: my $outcome = &unescape(&reply('autophotocheck:'.&escape($udom).':'.
8671: &escape($uname).':'.&escape($pid),
8672: $homeserver));
8673: if ($outcome =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
8674: return (undef,undef);
8675: }
8676: if ($outcome) {
8677: ($result,$resulttype) = split(/:/,$outcome);
8678: }
8679: return ($result,$resulttype);
8680: }
8681:
8682: sub auto_photochoice {
8683: my ($cnum,$cdom) = @_;
8684: my $homeserver = &homeserver($cnum,$cdom);
8685: my ($update,$comment) = split(/:/,&unescape(&reply('autophotochoice:'.
8686: &escape($cdom),
8687: $homeserver)));
8688: if ($update =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
8689: return (undef,undef);
8690: }
8691: return ($update,$comment);
8692: }
8693:
8694: sub auto_photoupdate {
8695: my ($affiliatesref,$dom,$cnum,$photo) = @_;
8696: my $homeserver = &homeserver($cnum,$dom);
8697: my $host=&hostname($homeserver);
8698: my $cmd = '';
8699: my $maxtries = 1;
8700: foreach my $affiliate (keys(%{$affiliatesref})) {
8701: $cmd .= $affiliate.'='.join(",",@{$$affiliatesref{$affiliate}}).'%%';
8702: }
8703: $cmd =~ s/%%$//;
8704: $cmd = &escape($cmd);
8705: my $query = 'institutionalphotos';
8706: my $queryid=&reply("querysend:".$query.':'.$dom.':'.$cnum.':'.$cmd,$homeserver);
8707: unless ($queryid=~/^\Q$host\E\_/) {
8708: &logthis('institutionalphotos: invalid queryid: '.$queryid.' for host: '.$host.' and homeserver: '.$homeserver.' and course: '.$cnum);
8709: return 'error: '.$queryid;
8710: }
8711: my $reply = &get_query_reply($queryid);
8712: my $tries = 1;
8713: while (($reply=~/^timeout/) && ($tries < $maxtries)) {
8714: $reply = &get_query_reply($queryid);
8715: $tries ++;
8716: }
8717: if ( ($reply =~/^timeout/) || ($reply =~/^error/) ) {
8718: &logthis('institutionalphotos error: '.$reply.' for '.$dom.' '.$env{'user.name'}.' for '.$queryid.' course: '.$cnum.' maxtries: '.$maxtries.' tries: '.$tries);
8719: } else {
8720: my @responses = split(/:/,$reply);
8721: my $outcome = shift(@responses);
8722: foreach my $item (@responses) {
8723: my ($key,$value) = split(/=/,$item);
8724: $$photo{$key} = $value;
8725: }
8726: return $outcome;
8727: }
8728: return 'error';
8729: }
8730:
8731: sub auto_instcode_format {
8732: my ($caller,$codedom,$instcodes,$codes,$codetitles,$cat_titles,
8733: $cat_order) = @_;
8734: my $courses = '';
8735: my @homeservers;
8736: if ($caller eq 'global') {
8737: my %servers = &get_servers($codedom,'library');
8738: foreach my $tryserver (keys(%servers)) {
8739: if (!grep(/^\Q$tryserver\E$/,@homeservers)) {
8740: push(@homeservers,$tryserver);
8741: }
8742: }
8743: } elsif ($caller eq 'requests') {
8744: if ($codedom =~ /^$match_domain$/) {
8745: my $chome = &domain($codedom,'primary');
8746: unless ($chome eq 'no_host') {
8747: push(@homeservers,$chome);
8748: }
8749: }
8750: } else {
8751: push(@homeservers,&homeserver($caller,$codedom));
8752: }
8753: foreach my $code (keys(%{$instcodes})) {
8754: $courses .= &escape($code).'='.&escape($$instcodes{$code}).'&';
8755: }
8756: chop($courses);
8757: my $ok_response = 0;
8758: my $response;
8759: while (@homeservers > 0 && $ok_response == 0) {
8760: my $server = shift(@homeservers);
8761: $response=&reply('autoinstcodeformat:'.$codedom.':'.$courses,$server);
8762: if ($response !~ /(con_lost|error|no_such_host|refused)/) {
8763: my ($codes_str,$codetitles_str,$cat_titles_str,$cat_order_str) =
8764: split(/:/,$response);
8765: %{$codes} = (%{$codes},&str2hash($codes_str));
8766: push(@{$codetitles},&str2array($codetitles_str));
8767: %{$cat_titles} = (%{$cat_titles},&str2hash($cat_titles_str));
8768: %{$cat_order} = (%{$cat_order},&str2hash($cat_order_str));
8769: $ok_response = 1;
8770: }
8771: }
8772: if ($ok_response) {
8773: return 'ok';
8774: } else {
8775: return $response;
8776: }
8777: }
8778:
8779: sub auto_instcode_defaults {
8780: my ($domain,$returnhash,$code_order) = @_;
8781: my @homeservers;
8782:
8783: my %servers = &get_servers($domain,'library');
8784: foreach my $tryserver (keys(%servers)) {
8785: if (!grep(/^\Q$tryserver\E$/,@homeservers)) {
8786: push(@homeservers,$tryserver);
8787: }
8788: }
8789:
8790: my $response;
8791: foreach my $server (@homeservers) {
8792: $response=&reply('autoinstcodedefaults:'.$domain,$server);
8793: next if ($response =~ /(con_lost|error|no_such_host|refused)/);
8794:
8795: foreach my $pair (split(/\&/,$response)) {
8796: my ($name,$value)=split(/\=/,$pair);
8797: if ($name eq 'code_order') {
8798: @{$code_order} = split(/\&/,&unescape($value));
8799: } else {
8800: $returnhash->{&unescape($name)}=&unescape($value);
8801: }
8802: }
8803: return 'ok';
8804: }
8805:
8806: return $response;
8807: }
8808:
8809: sub auto_possible_instcodes {
8810: my ($domain,$codetitles,$cat_titles,$cat_orders,$code_order) = @_;
8811: unless ((ref($codetitles) eq 'ARRAY') && (ref($cat_titles) eq 'HASH') &&
8812: (ref($cat_orders) eq 'HASH') && (ref($code_order) eq 'ARRAY')) {
8813: return;
8814: }
8815: my (@homeservers,$uhome);
8816: if (defined(&domain($domain,'primary'))) {
8817: $uhome=&domain($domain,'primary');
8818: push(@homeservers,&domain($domain,'primary'));
8819: } else {
8820: my %servers = &get_servers($domain,'library');
8821: foreach my $tryserver (keys(%servers)) {
8822: if (!grep(/^\Q$tryserver\E$/,@homeservers)) {
8823: push(@homeservers,$tryserver);
8824: }
8825: }
8826: }
8827: my $response;
8828: foreach my $server (@homeservers) {
8829: $response=&reply('autopossibleinstcodes:'.$domain,$server);
8830: next if ($response =~ /(con_lost|error|no_such_host|refused)/);
8831: my ($codetitlestr,$codeorderstr,$cat_title,$cat_order) =
8832: split(':',$response);
8833: @{$codetitles} = map { &unescape($_); } (split('&',$codetitlestr));
8834: @{$code_order} = map { &unescape($_); } (split('&',$codeorderstr));
8835: foreach my $item (split('&',$cat_title)) {
8836: my ($name,$value)=split('=',$item);
8837: $cat_titles->{&unescape($name)}=&thaw_unescape($value);
8838: }
8839: foreach my $item (split('&',$cat_order)) {
8840: my ($name,$value)=split('=',$item);
8841: $cat_orders->{&unescape($name)}=&thaw_unescape($value);
8842: }
8843: return 'ok';
8844: }
8845: return $response;
8846: }
8847:
8848: sub auto_courserequest_checks {
8849: my ($dom) = @_;
8850: my ($homeserver,%validations);
8851: if ($dom =~ /^$match_domain$/) {
8852: $homeserver = &domain($dom,'primary');
8853: }
8854: unless ($homeserver eq 'no_host') {
8855: my $response=&reply('autocrsreqchecks:'.$dom,$homeserver);
8856: unless ($response =~ /(con_lost|error|no_such_host|refused)/) {
8857: my @items = split(/&/,$response);
8858: foreach my $item (@items) {
8859: my ($key,$value) = split('=',$item);
8860: $validations{&unescape($key)} = &thaw_unescape($value);
8861: }
8862: }
8863: }
8864: return %validations;
8865: }
8866:
8867: sub auto_courserequest_validation {
8868: my ($dom,$owner,$crstype,$inststatuslist,$instcode,$instseclist,$custominfo) = @_;
8869: my ($homeserver,$response);
8870: if ($dom =~ /^$match_domain$/) {
8871: $homeserver = &domain($dom,'primary');
8872: }
8873: unless ($homeserver eq 'no_host') {
8874: my $customdata;
8875: if (ref($custominfo) eq 'HASH') {
8876: $customdata = &freeze_escape($custominfo);
8877: }
8878: $response=&unescape(&reply('autocrsreqvalidation:'.$dom.':'.&escape($owner).
8879: ':'.&escape($crstype).':'.&escape($inststatuslist).
8880: ':'.&escape($instcode).':'.&escape($instseclist).':'.
8881: $customdata,$homeserver));
8882: }
8883: return $response;
8884: }
8885:
8886: sub auto_validate_class_sec {
8887: my ($cdom,$cnum,$owners,$inst_class) = @_;
8888: my $homeserver = &homeserver($cnum,$cdom);
8889: my $ownerlist;
8890: if (ref($owners) eq 'ARRAY') {
8891: $ownerlist = join(',',@{$owners});
8892: } else {
8893: $ownerlist = $owners;
8894: }
8895: my $response=&reply('autovalidateclass_sec:'.$inst_class.':'.
8896: &escape($ownerlist).':'.$cdom,$homeserver);
8897: return $response;
8898: }
8899:
8900: sub auto_validate_instclasses {
8901: my ($cdom,$cnum,$owners,$classesref) = @_;
8902: my ($homeserver,%validations);
8903: $homeserver = &homeserver($cnum,$cdom);
8904: unless ($homeserver eq 'no_host') {
8905: my $ownerlist;
8906: if (ref($owners) eq 'ARRAY') {
8907: $ownerlist = join(',',@{$owners});
8908: } else {
8909: $ownerlist = $owners;
8910: }
8911: if (ref($classesref) eq 'HASH') {
8912: my $classes = &freeze_escape($classesref);
8913: my $response=&reply('autovalidateinstclasses:'.&escape($ownerlist).
8914: ':'.$cdom.':'.$classes,$homeserver);
8915: unless ($response =~ /(con_lost|error|no_such_host|refused)/) {
8916: my @items = split(/&/,$response);
8917: foreach my $item (@items) {
8918: my ($key,$value) = split('=',$item);
8919: $validations{&unescape($key)} = &thaw_unescape($value);
8920: }
8921: }
8922: }
8923: }
8924: return %validations;
8925: }
8926:
8927: sub auto_crsreq_update {
8928: my ($cdom,$cnum,$crstype,$action,$ownername,$ownerdomain,$fullname,$title,
8929: $code,$accessstart,$accessend,$inbound) = @_;
8930: my ($homeserver,%crsreqresponse);
8931: if ($cdom =~ /^$match_domain$/) {
8932: $homeserver = &domain($cdom,'primary');
8933: }
8934: unless (($homeserver eq 'no_host') || ($homeserver eq '')) {
8935: my $info;
8936: if (ref($inbound) eq 'HASH') {
8937: $info = &freeze_escape($inbound);
8938: }
8939: my $response=&reply('autocrsrequpdate:'.$cdom.':'.$cnum.':'.&escape($crstype).
8940: ':'.&escape($action).':'.&escape($ownername).':'.
8941: &escape($ownerdomain).':'.&escape($fullname).':'.
8942: &escape($title).':'.&escape($code).':'.
8943: &escape($accessstart).':'.&escape($accessend).':'.$info,
8944: $homeserver);
8945: unless ($response =~ /(con_lost|error|no_such_host|refused)/) {
8946: my @items = split(/&/,$response);
8947: foreach my $item (@items) {
8948: my ($key,$value) = split('=',$item);
8949: $crsreqresponse{&unescape($key)} = &thaw_unescape($value);
8950: }
8951: }
8952: }
8953: return \%crsreqresponse;
8954: }
8955:
8956: sub auto_export_grades {
8957: my ($cdom,$cnum,$inforef,$gradesref) = @_;
8958: my ($homeserver,%exportresponse);
8959: if ($cdom =~ /^$match_domain$/) {
8960: $homeserver = &domain($cdom,'primary');
8961: }
8962: unless (($homeserver eq 'no_host') || ($homeserver eq '')) {
8963: my $info;
8964: if (ref($inforef) eq 'HASH') {
8965: $info = &freeze_escape($inforef);
8966: }
8967: if (ref($gradesref) eq 'HASH') {
8968: my $grades = &freeze_escape($gradesref);
8969: my $response=&reply('encrypt:autoexportgrades:'.$cdom.':'.$cnum.':'.
8970: $info.':'.$grades,$homeserver);
8971: unless ($response =~ /(con_lost|error|no_such_host|refused|unknown_command)/) {
8972: my @items = split(/&/,$response);
8973: foreach my $item (@items) {
8974: my ($key,$value) = split('=',$item);
8975: $exportresponse{&unescape($key)} = &thaw_unescape($value);
8976: }
8977: }
8978: }
8979: }
8980: return \%exportresponse;
8981: }
8982:
8983: sub check_instcode_cloning {
8984: my ($codedefaults,$code_order,$cloner,$clonefromcode,$clonetocode) = @_;
8985: unless ((ref($codedefaults) eq 'HASH') && (ref($code_order) eq 'ARRAY')) {
8986: return;
8987: }
8988: my $canclone;
8989: if (@{$code_order} > 0) {
8990: my $instcoderegexp ='^';
8991: my @clonecodes = split(/\&/,$cloner);
8992: foreach my $item (@{$code_order}) {
8993: if (grep(/^\Q$item\E=/,@clonecodes)) {
8994: foreach my $pair (@clonecodes) {
8995: my ($key,$val) = split(/\=/,$pair,2);
8996: $val = &unescape($val);
8997: if ($key eq $item) {
8998: $instcoderegexp .= '('.$val.')';
8999: last;
9000: }
9001: }
9002: } else {
9003: $instcoderegexp .= $codedefaults->{$item};
9004: }
9005: }
9006: $instcoderegexp .= '$';
9007: my (@from,@to);
9008: eval {
9009: (@from) = ($clonefromcode =~ /$instcoderegexp/);
9010: (@to) = ($clonetocode =~ /$instcoderegexp/);
9011: };
9012: if ((@from > 0) && (@to > 0)) {
9013: my @diffs = &Apache::loncommon::compare_arrays(\@from,\@to);
9014: if (!@diffs) {
9015: $canclone = 1;
9016: }
9017: }
9018: }
9019: return $canclone;
9020: }
9021:
9022: sub default_instcode_cloning {
9023: my ($clonedom,$domdefclone,$clonefromcode,$clonetocode,$codedefaultsref,$codeorderref) = @_;
9024: my (%codedefaults,@code_order,$canclone);
9025: if ((ref($codedefaultsref) eq 'HASH') && (ref($codeorderref) eq 'ARRAY')) {
9026: %codedefaults = %{$codedefaultsref};
9027: @code_order = @{$codeorderref};
9028: } elsif ($clonedom) {
9029: &auto_instcode_defaults($clonedom,\%codedefaults,\@code_order);
9030: }
9031: if (($domdefclone) && (@code_order)) {
9032: my @clonecodes = split(/\+/,$domdefclone);
9033: my $instcoderegexp ='^';
9034: foreach my $item (@code_order) {
9035: if (grep(/^\Q$item\E$/,@clonecodes)) {
9036: $instcoderegexp .= '('.$codedefaults{$item}.')';
9037: } else {
9038: $instcoderegexp .= $codedefaults{$item};
9039: }
9040: }
9041: $instcoderegexp .= '$';
9042: my (@from,@to);
9043: eval {
9044: (@from) = ($clonefromcode =~ /$instcoderegexp/);
9045: (@to) = ($clonetocode =~ /$instcoderegexp/);
9046: };
9047: if ((@from > 0) && (@to > 0)) {
9048: my @diffs = &Apache::loncommon::compare_arrays(\@from,\@to);
9049: if (!@diffs) {
9050: $canclone = 1;
9051: }
9052: }
9053: }
9054: return $canclone;
9055: }
9056:
9057: # ------------------------------------------------------- Course Group routines
9058:
9059: sub get_coursegroups {
9060: my ($cdom,$cnum,$group,$namespace) = @_;
9061: return(&dump($namespace,$cdom,$cnum,$group));
9062: }
9063:
9064: sub modify_coursegroup {
9065: my ($cdom,$cnum,$groupsettings) = @_;
9066: return(&put('coursegroups',$groupsettings,$cdom,$cnum));
9067: }
9068:
9069: sub toggle_coursegroup_status {
9070: my ($cdom,$cnum,$group,$action) = @_;
9071: my ($from_namespace,$to_namespace);
9072: if ($action eq 'delete') {
9073: $from_namespace = 'coursegroups';
9074: $to_namespace = 'deleted_groups';
9075: } else {
9076: $from_namespace = 'deleted_groups';
9077: $to_namespace = 'coursegroups';
9078: }
9079: my %curr_group = &get_coursegroups($cdom,$cnum,$group,$from_namespace);
9080: if (my $tmp = &error(%curr_group)) {
9081: &Apache::lonnet::logthis('Error retrieving group: '.$tmp.' in '.$cnum.':'.$cdom);
9082: return ('read error',$tmp);
9083: } else {
9084: my %savedsettings = %curr_group;
9085: my $result = &put($to_namespace,\%savedsettings,$cdom,$cnum);
9086: my $deloutcome;
9087: if ($result eq 'ok') {
9088: $deloutcome = &del($from_namespace,[$group],$cdom,$cnum);
9089: } else {
9090: return ('write error',$result);
9091: }
9092: if ($deloutcome eq 'ok') {
9093: return 'ok';
9094: } else {
9095: return ('delete error',$deloutcome);
9096: }
9097: }
9098: }
9099:
9100: sub modify_group_roles {
9101: my ($cdom,$cnum,$group_id,$user,$end,$start,$userprivs,$selfenroll,$context) = @_;
9102: my $url = '/'.$cdom.'/'.$cnum.'/'.$group_id;
9103: my $role = 'gr/'.&escape($userprivs);
9104: my ($uname,$udom) = split(/:/,$user);
9105: my $result = &assignrole($udom,$uname,$url,$role,$end,$start,'',$selfenroll,$context);
9106: if ($result eq 'ok') {
9107: &devalidate_getgroups_cache($udom,$uname,$cdom,$cnum);
9108: }
9109: return $result;
9110: }
9111:
9112: sub modify_coursegroup_membership {
9113: my ($cdom,$cnum,$membership) = @_;
9114: my $result = &put('groupmembership',$membership,$cdom,$cnum);
9115: return $result;
9116: }
9117:
9118: sub get_active_groups {
9119: my ($udom,$uname,$cdom,$cnum) = @_;
9120: my $now = time;
9121: my %groups = ();
9122: foreach my $key (keys(%env)) {
9123: if ($key =~ m-user\.role\.gr\./($match_domain)/($match_courseid)/(\w+)$-) {
9124: my ($start,$end) = split(/\./,$env{$key});
9125: if (($end!=0) && ($end<$now)) { next; }
9126: if (($start!=0) && ($start>$now)) { next; }
9127: if ($1 eq $cdom && $2 eq $cnum) {
9128: $groups{$3} = $env{$key} ;
9129: }
9130: }
9131: }
9132: return %groups;
9133: }
9134:
9135: sub get_group_membership {
9136: my ($cdom,$cnum,$group) = @_;
9137: return(&dump('groupmembership',$cdom,$cnum,$group));
9138: }
9139:
9140: sub get_users_groups {
9141: my ($udom,$uname,$courseid) = @_;
9142: my @usersgroups;
9143: my $cachetime=1800;
9144:
9145: my $hashid="$udom:$uname:$courseid";
9146: my ($grouplist,$cached)=&is_cached_new('getgroups',$hashid);
9147: if (defined($cached)) {
9148: @usersgroups = split(/:/,$grouplist);
9149: } else {
9150: $grouplist = '';
9151: my $courseurl = &courseid_to_courseurl($courseid);
9152: my %roleshash = &dump('roles',$udom,$uname,$courseurl);
9153: my $access_end = $env{'course.'.$courseid.
9154: '.default_enrollment_end_date'};
9155: my $now = time;
9156: foreach my $key (keys(%roleshash)) {
9157: if ($key =~ /^\Q$courseurl\E\/(\w+)\_gr$/) {
9158: my $group = $1;
9159: if ($roleshash{$key} =~ /_(\d+)_(\d+)$/) {
9160: my $start = $2;
9161: my $end = $1;
9162: if ($start == -1) { next; } # deleted from group
9163: if (($start!=0) && ($start>$now)) { next; }
9164: if (($end!=0) && ($end<$now)) {
9165: if ($access_end && $access_end < $now) {
9166: if ($access_end - $end < 86400) {
9167: push(@usersgroups,$group);
9168: }
9169: }
9170: next;
9171: }
9172: push(@usersgroups,$group);
9173: }
9174: }
9175: }
9176: @usersgroups = &sort_course_groups($courseid,@usersgroups);
9177: $grouplist = join(':',@usersgroups);
9178: &do_cache_new('getgroups',$hashid,$grouplist,$cachetime);
9179: }
9180: return @usersgroups;
9181: }
9182:
9183: sub devalidate_getgroups_cache {
9184: my ($udom,$uname,$cdom,$cnum)=@_;
9185: my $courseid = $cdom.'_'.$cnum;
9186:
9187: my $hashid="$udom:$uname:$courseid";
9188: &devalidate_cache_new('getgroups',$hashid);
9189: }
9190:
9191: # ------------------------------------------------------------------ Plain Text
9192:
9193: sub plaintext {
9194: my ($short,$type,$cid,$forcedefault) = @_;
9195: if ($short =~ m{^cr/}) {
9196: return (split('/',$short))[-1];
9197: }
9198: if (!defined($cid)) {
9199: $cid = $env{'request.course.id'};
9200: }
9201: my %rolenames = (
9202: Course => 'std',
9203: Community => 'alt1',
9204: Placement => 'std',
9205: );
9206: if ($cid ne '') {
9207: if ($env{'course.'.$cid.'.'.$short.'.plaintext'} ne '') {
9208: unless ($forcedefault) {
9209: my $roletext = $env{'course.'.$cid.'.'.$short.'.plaintext'};
9210: &Apache::lonlocal::mt_escape(\$roletext);
9211: return &Apache::lonlocal::mt($roletext);
9212: }
9213: }
9214: }
9215: if ((defined($type)) && (defined($rolenames{$type})) &&
9216: (defined($rolenames{$type})) &&
9217: (defined($prp{$short}{$rolenames{$type}}))) {
9218: return &Apache::lonlocal::mt($prp{$short}{$rolenames{$type}});
9219: } elsif ($cid ne '') {
9220: my $crstype = $env{'course.'.$cid.'.type'};
9221: if (($crstype ne '') && (defined($rolenames{$crstype})) &&
9222: (defined($prp{$short}{$rolenames{$crstype}}))) {
9223: return &Apache::lonlocal::mt($prp{$short}{$rolenames{$crstype}});
9224: }
9225: }
9226: return &Apache::lonlocal::mt($prp{$short}{'std'});
9227: }
9228:
9229: # ----------------------------------------------------------------- Assign Role
9230:
9231: sub assignrole {
9232: my ($udom,$uname,$url,$role,$end,$start,$deleteflag,$selfenroll,
9233: $context)=@_;
9234: my $mrole;
9235: if ($role =~ /^cr\//) {
9236: my $cwosec=$url;
9237: $cwosec=~s/^\/($match_domain)\/($match_courseid)\/.*/$1\/$2/;
9238: unless (&allowed('ccr',$cwosec)) {
9239: my $refused = 1;
9240: if ($context eq 'requestcourses') {
9241: if (($env{'user.name'} ne '') && ($env{'user.domain'} ne '')) {
9242: if ($role =~ m{^cr/($match_domain)/($match_username)/([^/]+)$}) {
9243: if (($1 eq $env{'user.domain'}) && ($2 eq $env{'user.name'})) {
9244: my ($cdom,$cnum) = ($cwosec =~ m{^/?($match_domain)/($match_courseid)$});
9245: my %crsenv = &userenvironment($cdom,$cnum,('internal.courseowner'));
9246: if ($crsenv{'internal.courseowner'} eq
9247: $env{'user.name'}.':'.$env{'user.domain'}) {
9248: $refused = '';
9249: }
9250: }
9251: }
9252: }
9253: }
9254: if ($refused) {
9255: &logthis('Refused custom assignrole: '.
9256: $udom.' '.$uname.' '.$url.' '.$role.' '.$end.' '.$start.
9257: ' by '.$env{'user.name'}.' at '.$env{'user.domain'});
9258: return 'refused';
9259: }
9260: }
9261: $mrole='cr';
9262: } elsif ($role =~ /^gr\//) {
9263: my $cwogrp=$url;
9264: $cwogrp=~s{^/($match_domain)/($match_courseid)/.*}{$1/$2};
9265: unless (&allowed('mdg',$cwogrp)) {
9266: &logthis('Refused group assignrole: '.
9267: $udom.' '.$uname.' '.$url.' '.$role.' '.$end.' '.$start.' by '.
9268: $env{'user.name'}.' at '.$env{'user.domain'});
9269: return 'refused';
9270: }
9271: $mrole='gr';
9272: } else {
9273: my $cwosec=$url;
9274: $cwosec=~s/^\/($match_domain)\/($match_courseid)\/.*/$1\/$2/;
9275: if (!(&allowed('c'.$role,$cwosec)) && !(&allowed('c'.$role,$udom))) {
9276: my $refused;
9277: if (($env{'request.course.sec'} ne '') && ($role eq 'st')) {
9278: if (!(&allowed('c'.$role,$url))) {
9279: $refused = 1;
9280: }
9281: } else {
9282: $refused = 1;
9283: }
9284: if ($refused) {
9285: my ($cdom,$cnum) = ($cwosec =~ m{^/?($match_domain)/($match_courseid)$});
9286: if (!$selfenroll && $context eq 'course') {
9287: my %crsenv;
9288: if ($role eq 'cc' || $role eq 'co') {
9289: %crsenv = &userenvironment($cdom,$cnum,('internal.courseowner'));
9290: if (($role eq 'cc') && ($cnum !~ /^$match_community$/)) {
9291: if ($env{'request.role'} eq 'cc./'.$cdom.'/'.$cnum) {
9292: if ($crsenv{'internal.courseowner'} eq
9293: $env{'user.name'}.':'.$env{'user.domain'}) {
9294: $refused = '';
9295: }
9296: }
9297: } elsif (($role eq 'co') && ($cnum =~ /^$match_community$/)) {
9298: if ($env{'request.role'} eq 'co./'.$cdom.'/'.$cnum) {
9299: if ($crsenv{'internal.courseowner'} eq
9300: $env{'user.name'}.':'.$env{'user.domain'}) {
9301: $refused = '';
9302: }
9303: }
9304: }
9305: }
9306: } elsif (($selfenroll == 1) && ($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'})) {
9307: if ($role eq 'st') {
9308: $refused = '';
9309: } elsif (($context eq 'ltienroll') && ($env{'request.lti'})) {
9310: $refused = '';
9311: }
9312: } elsif ($context eq 'requestcourses') {
9313: my @possroles = ('st','ta','ep','in','cc','co');
9314: if ((grep(/^\Q$role\E$/,@possroles)) && ($env{'user.name'} ne '' && $env{'user.domain'} ne '')) {
9315: my $wrongcc;
9316: if ($cnum =~ /^$match_community$/) {
9317: $wrongcc = 1 if ($role eq 'cc');
9318: } else {
9319: $wrongcc = 1 if ($role eq 'co');
9320: }
9321: unless ($wrongcc) {
9322: my %crsenv = &userenvironment($cdom,$cnum,('internal.courseowner'));
9323: if ($crsenv{'internal.courseowner'} eq
9324: $env{'user.name'}.':'.$env{'user.domain'}) {
9325: $refused = '';
9326: }
9327: }
9328: }
9329: } elsif ($context eq 'requestauthor') {
9330: if (($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'}) &&
9331: ($url eq '/'.$udom.'/') && ($role eq 'au')) {
9332: if ($env{'environment.requestauthor'} eq 'automatic') {
9333: $refused = '';
9334: } else {
9335: my %domdefaults = &get_domain_defaults($udom);
9336: if (ref($domdefaults{'requestauthor'}) eq 'HASH') {
9337: my $checkbystatus;
9338: if ($env{'user.adv'}) {
9339: my $disposition = $domdefaults{'requestauthor'}{'_LC_adv'};
9340: if ($disposition eq 'automatic') {
9341: $refused = '';
9342: } elsif ($disposition eq '') {
9343: $checkbystatus = 1;
9344: }
9345: } else {
9346: $checkbystatus = 1;
9347: }
9348: if ($checkbystatus) {
9349: if ($env{'environment.inststatus'}) {
9350: my @inststatuses = split(/,/,$env{'environment.inststatus'});
9351: foreach my $type (@inststatuses) {
9352: if (($type ne '') &&
9353: ($domdefaults{'requestauthor'}{$type} eq 'automatic')) {
9354: $refused = '';
9355: }
9356: }
9357: } elsif ($domdefaults{'requestauthor'}{'default'} eq 'automatic') {
9358: $refused = '';
9359: }
9360: }
9361: }
9362: }
9363: }
9364: }
9365: if ($refused) {
9366: &logthis('Refused assignrole: '.$udom.' '.$uname.' '.$url.
9367: ' '.$role.' '.$end.' '.$start.' by '.
9368: $env{'user.name'}.' at '.$env{'user.domain'});
9369: return 'refused';
9370: }
9371: }
9372: } elsif ($role eq 'au') {
9373: if ($url ne '/'.$udom.'/') {
9374: &logthis('Attempt by '.$env{'user.name'}.':'.$env{'user.domain'}.
9375: ' to assign author role for '.$uname.':'.$udom.
9376: ' in domain: '.$url.' refused (wrong domain).');
9377: return 'refused';
9378: }
9379: }
9380: $mrole=$role;
9381: }
9382: my $command="encrypt:rolesput:$env{'user.domain'}:$env{'user.name'}:".
9383: "$udom:$uname:$url".'_'."$mrole=$role";
9384: if ($end) { $command.='_'.$end; }
9385: if ($start) {
9386: if ($end) {
9387: $command.='_'.$start;
9388: } else {
9389: $command.='_0_'.$start;
9390: }
9391: }
9392: my $origstart = $start;
9393: my $origend = $end;
9394: my $delflag;
9395: # actually delete
9396: if ($deleteflag) {
9397: if ((&allowed('dro',$udom)) || (&allowed('dro',$url))) {
9398: # modify command to delete the role
9399: $command="encrypt:rolesdel:$env{'user.domain'}:$env{'user.name'}:".
9400: "$udom:$uname:$url".'_'."$mrole";
9401: &logthis("$env{'user.name'} at $env{'user.domain'} deletes $mrole in $url for $uname at $udom");
9402: # set start and finish to negative values for userrolelog
9403: $start=-1;
9404: $end=-1;
9405: $delflag = 1;
9406: }
9407: }
9408: # send command
9409: my $answer=&reply($command,&homeserver($uname,$udom));
9410: # log new user role if status is ok
9411: if ($answer eq 'ok') {
9412: &userrolelog($role,$uname,$udom,$url,$start,$end);
9413: if (($role eq 'cc') || ($role eq 'in') ||
9414: ($role eq 'ep') || ($role eq 'ad') ||
9415: ($role eq 'ta') || ($role eq 'st') ||
9416: ($role=~/^cr/) || ($role eq 'gr') ||
9417: ($role eq 'co')) {
9418: # for course roles, perform group memberships changes triggered by role change.
9419: unless ($role =~ /^gr/) {
9420: &Apache::longroup::group_changes($udom,$uname,$url,$role,$origend,
9421: $origstart,$selfenroll,$context);
9422: }
9423: &courserolelog($role,$uname,$udom,$url,$origstart,$origend,$delflag,
9424: $selfenroll,$context);
9425: } elsif (($role eq 'li') || ($role eq 'dg') || ($role eq 'sc') ||
9426: ($role eq 'au') || ($role eq 'dc') || ($role eq 'dh') ||
9427: ($role eq 'da')) {
9428: &domainrolelog($role,$uname,$udom,$url,$origstart,$origend,$delflag,
9429: $context);
9430: } elsif (($role eq 'ca') || ($role eq 'aa')) {
9431: &coauthorrolelog($role,$uname,$udom,$url,$origstart,$origend,$delflag,
9432: $context);
9433: }
9434: if ($role eq 'cc') {
9435: &autoupdate_coowners($url,$end,$start,$uname,$udom);
9436: }
9437: }
9438: return $answer;
9439: }
9440:
9441: sub autoupdate_coowners {
9442: my ($url,$end,$start,$uname,$udom) = @_;
9443: my ($cdom,$cnum) = ($url =~ m{^/($match_domain)/($match_courseid)});
9444: if (($cdom ne '') && ($cnum ne '')) {
9445: my $now = time;
9446: my %domdesign = &Apache::loncommon::get_domainconf($cdom);
9447: if ($domdesign{$cdom.'.autoassign.co-owners'}) {
9448: my %coursehash = &coursedescription($cdom.'_'.$cnum);
9449: my $instcode = $coursehash{'internal.coursecode'};
9450: if ($instcode ne '') {
9451: if (($start && $start <= $now) && ($end == 0) || ($end > $now)) {
9452: unless ($coursehash{'internal.courseowner'} eq $uname.':'.$udom) {
9453: my ($delcoowners,@newcoowners,$putresult,$delresult,$coowners);
9454: my ($result,$desc) = &auto_validate_instcode($cnum,$cdom,$instcode,$uname.':'.$udom);
9455: if ($result eq 'valid') {
9456: if ($coursehash{'internal.co-owners'}) {
9457: foreach my $coowner (split(',',$coursehash{'internal.co-owners'})) {
9458: push(@newcoowners,$coowner);
9459: }
9460: unless (grep(/^\Q$uname\E:\Q$udom\E$/,@newcoowners)) {
9461: push(@newcoowners,$uname.':'.$udom);
9462: }
9463: @newcoowners = sort(@newcoowners);
9464: } else {
9465: push(@newcoowners,$uname.':'.$udom);
9466: }
9467: } else {
9468: if ($coursehash{'internal.co-owners'}) {
9469: foreach my $coowner (split(',',$coursehash{'internal.co-owners'})) {
9470: unless ($coowner eq $uname.':'.$udom) {
9471: push(@newcoowners,$coowner);
9472: }
9473: }
9474: unless (@newcoowners > 0) {
9475: $delcoowners = 1;
9476: $coowners = '';
9477: }
9478: }
9479: }
9480: if (@newcoowners || $delcoowners) {
9481: &store_coowners($cdom,$cnum,$coursehash{'home'},
9482: $delcoowners,@newcoowners);
9483: }
9484: }
9485: }
9486: }
9487: }
9488: }
9489: }
9490:
9491: sub store_coowners {
9492: my ($cdom,$cnum,$chome,$delcoowners,@newcoowners) = @_;
9493: my $cid = $cdom.'_'.$cnum;
9494: my ($coowners,$delresult,$putresult);
9495: if (@newcoowners) {
9496: $coowners = join(',',@newcoowners);
9497: my %coownershash = (
9498: 'internal.co-owners' => $coowners,
9499: );
9500: $putresult = &put('environment',\%coownershash,$cdom,$cnum);
9501: if ($putresult eq 'ok') {
9502: if ($env{'course.'.$cid.'.num'} eq $cnum) {
9503: &appenv({'course.'.$cid.'.internal.co-owners' => $coowners});
9504: }
9505: }
9506: }
9507: if ($delcoowners) {
9508: $delresult = &Apache::lonnet::del('environment',['internal.co-owners'],$cdom,$cnum);
9509: if ($delresult eq 'ok') {
9510: if ($env{'course.'.$cid.'.internal.co-owners'}) {
9511: &Apache::lonnet::delenv('course.'.$cid.'.internal.co-owners');
9512: }
9513: }
9514: }
9515: if (($putresult eq 'ok') || ($delresult eq 'ok')) {
9516: my %crsinfo =
9517: &Apache::lonnet::courseiddump($cdom,'.',1,'.','.',$cnum,undef,undef,'.');
9518: if (ref($crsinfo{$cid}) eq 'HASH') {
9519: $crsinfo{$cid}{'co-owners'} = \@newcoowners;
9520: my $cidput = &Apache::lonnet::courseidput($cdom,\%crsinfo,$chome,'notime');
9521: }
9522: }
9523: }
9524:
9525: # -------------------------------------------------- Modify user authentication
9526: # Overrides without validation
9527:
9528: sub modifyuserauth {
9529: my ($udom,$uname,$umode,$upass)=@_;
9530: my $uhome=&homeserver($uname,$udom);
9531: unless (&allowed('mau',$udom)) { return 'refused'; }
9532: &logthis('Call to modify user authentication '.$udom.', '.$uname.', '.
9533: $umode.' by '.$env{'user.name'}.' at '.$env{'user.domain'}.
9534: ' in domain '.$env{'request.role.domain'});
9535: my $reply=&reply('encrypt:changeuserauth:'.$udom.':'.$uname.':'.$umode.':'.
9536: &escape($upass),$uhome);
9537: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},
9538: 'Authentication changed for '.$udom.', '.$uname.', '.$umode.
9539: '(Remote '.$ENV{'REMOTE_ADDR'}.'): '.$reply);
9540: &log($udom,,$uname,$uhome,
9541: 'Authentication changed by '.$env{'user.domain'}.', '.
9542: $env{'user.name'}.', '.$umode.
9543: '(Remote '.$ENV{'REMOTE_ADDR'}.'): '.$reply);
9544: unless ($reply eq 'ok') {
9545: &logthis('Authentication mode error: '.$reply);
9546: return 'error: '.$reply;
9547: }
9548: return 'ok';
9549: }
9550:
9551: # --------------------------------------------------------------- Modify a user
9552:
9553: sub modifyuser {
9554: my ($udom, $uname, $uid,
9555: $umode, $upass, $first,
9556: $middle, $last, $gene,
9557: $forceid, $desiredhome, $email, $inststatus, $candelete)=@_;
9558: $udom= &LONCAPA::clean_domain($udom);
9559: $uname=&LONCAPA::clean_username($uname);
9560: my $showcandelete = 'none';
9561: if (ref($candelete) eq 'ARRAY') {
9562: if (@{$candelete} > 0) {
9563: $showcandelete = join(', ',@{$candelete});
9564: }
9565: }
9566: &logthis('Call to modify user '.$udom.', '.$uname.', '.$uid.', '.
9567: $umode.', '.$first.', '.$middle.', '.
9568: $last.', '.$gene.'(forceid: '.$forceid.'; candelete: '.$showcandelete.')'.
9569: (defined($desiredhome) ? ' desiredhome = '.$desiredhome :
9570: ' desiredhome not specified').
9571: ' by '.$env{'user.name'}.' at '.$env{'user.domain'}.
9572: ' in domain '.$env{'request.role.domain'});
9573: my $uhome=&homeserver($uname,$udom,'true');
9574: my $newuser;
9575: if ($uhome eq 'no_host') {
9576: $newuser = 1;
9577: unless (($umode && ($upass ne '')) || ($umode eq 'localauth') ||
9578: ($umode eq 'lti')) {
9579: return 'error: more information needed to create new user';
9580: }
9581: }
9582: # ----------------------------------------------------------------- Create User
9583: if (($uhome eq 'no_host') &&
9584: (($umode && $upass) || ($umode eq 'localauth') || ($umode eq 'lti'))) {
9585: my $unhome='';
9586: if (defined($desiredhome) && &host_domain($desiredhome) eq $udom) {
9587: $unhome = $desiredhome;
9588: } elsif($env{'course.'.$env{'request.course.id'}.'.domain'} eq $udom) {
9589: $unhome=$env{'course.'.$env{'request.course.id'}.'.home'};
9590: } else { # load balancing routine for determining $unhome
9591: my $loadm=10000000;
9592: my %servers = &get_servers($udom,'library');
9593: foreach my $tryserver (keys(%servers)) {
9594: my $answer=reply('load',$tryserver);
9595: if (($answer=~/\d+/) && ($answer<$loadm)) {
9596: $loadm=$answer;
9597: $unhome=$tryserver;
9598: }
9599: }
9600: }
9601: if (($unhome eq '') || ($unhome eq 'no_host')) {
9602: return 'error: unable to find a home server for '.$uname.
9603: ' in domain '.$udom;
9604: }
9605: my $reply=&reply('encrypt:makeuser:'.$udom.':'.$uname.':'.$umode.':'.
9606: &escape($upass),$unhome);
9607: unless ($reply eq 'ok') {
9608: return 'error: '.$reply;
9609: }
9610: $uhome=&homeserver($uname,$udom,'true');
9611: if (($uhome eq '') || ($uhome eq 'no_host') || ($uhome ne $unhome)) {
9612: return 'error: unable verify users home machine.';
9613: }
9614: } # End of creation of new user
9615: # ---------------------------------------------------------------------- Add ID
9616: if ($uid) {
9617: $uid=~tr/A-Z/a-z/;
9618: my %uidhash=&idrget($udom,$uname);
9619: if (($uidhash{$uname}) && ($uidhash{$uname}!~/error\:/)
9620: && (!$forceid)) {
9621: unless ($uid eq $uidhash{$uname}) {
9622: return 'error: user id "'.$uid.'" does not match '.
9623: 'current user id "'.$uidhash{$uname}.'".';
9624: }
9625: } else {
9626: &idput($udom,{$uname => $uid},$uhome,'ids');
9627: }
9628: }
9629: # -------------------------------------------------------------- Add names, etc
9630: my @tmp=&get('environment',
9631: ['firstname','middlename','lastname','generation','id',
9632: 'permanentemail','inststatus'],
9633: $udom,$uname);
9634: my (%names,%oldnames);
9635: if ($tmp[0] =~ m/^error:.*/) {
9636: %names=();
9637: } else {
9638: %names = @tmp;
9639: %oldnames = %names;
9640: }
9641: #
9642: # If name, email and/or uid are blank (e.g., because an uploaded file
9643: # of users did not contain them), do not overwrite existing values
9644: # unless field is in $candelete array ref.
9645: #
9646:
9647: my @fields = ('firstname','middlename','lastname','generation',
9648: 'permanentemail','id');
9649: my %newvalues;
9650: if (ref($candelete) eq 'ARRAY') {
9651: foreach my $field (@fields) {
9652: if (grep(/^\Q$field\E$/,@{$candelete})) {
9653: if ($field eq 'firstname') {
9654: $names{$field} = $first;
9655: } elsif ($field eq 'middlename') {
9656: $names{$field} = $middle;
9657: } elsif ($field eq 'lastname') {
9658: $names{$field} = $last;
9659: } elsif ($field eq 'generation') {
9660: $names{$field} = $gene;
9661: } elsif ($field eq 'permanentemail') {
9662: $names{$field} = $email;
9663: } elsif ($field eq 'id') {
9664: $names{$field} = $uid;
9665: }
9666: }
9667: }
9668: }
9669: if ($first) { $names{'firstname'} = $first; }
9670: if (defined($middle)) { $names{'middlename'} = $middle; }
9671: if ($last) { $names{'lastname'} = $last; }
9672: if (defined($gene)) { $names{'generation'} = $gene; }
9673: if ($email) {
9674: $email=~s/[^\w\@\.\-\,]//gs;
9675: if ($email=~/\@/) { $names{'permanentemail'} = $email; }
9676: }
9677: if ($uid) { $names{'id'} = $uid; }
9678: if (defined($inststatus)) {
9679: $names{'inststatus'} = '';
9680: my ($usertypes,$typesorder) = &retrieve_inst_usertypes($udom);
9681: if (ref($usertypes) eq 'HASH') {
9682: my @okstatuses;
9683: foreach my $item (split(/:/,$inststatus)) {
9684: if (defined($usertypes->{$item})) {
9685: push(@okstatuses,$item);
9686: }
9687: }
9688: if (@okstatuses) {
9689: $names{'inststatus'} = join(':', map { &escape($_); } @okstatuses);
9690: }
9691: }
9692: }
9693: my $logmsg = $udom.', '.$uname.', '.$uid.', '.
9694: $umode.', '.$first.', '.$middle.', '.
9695: $last.', '.$gene.', '.$email.', '.$inststatus;
9696: if ($env{'user.name'} ne '' && $env{'user.domain'}) {
9697: $logmsg .= ' by '.$env{'user.name'}.' at '.$env{'user.domain'};
9698: } else {
9699: $logmsg .= ' during self creation';
9700: }
9701: my $changed;
9702: if ($newuser) {
9703: $changed = 1;
9704: } else {
9705: foreach my $field (@fields) {
9706: if ($names{$field} ne $oldnames{$field}) {
9707: $changed = 1;
9708: last;
9709: }
9710: }
9711: }
9712: unless ($changed) {
9713: $logmsg = 'No changes in user information needed for: '.$logmsg;
9714: &logthis($logmsg);
9715: return 'ok';
9716: }
9717: my $reply = &put('environment', \%names, $udom,$uname);
9718: if ($reply ne 'ok') {
9719: return 'error: '.$reply;
9720: }
9721: if ($names{'permanentemail'} ne $oldnames{'permanentemail'}) {
9722: &Apache::lonnet::devalidate_cache_new('emailscache',$uname.':'.$udom);
9723: }
9724: my $sqlresult = &update_allusers_table($uname,$udom,\%names);
9725: &devalidate_cache_new('namescache',$uname.':'.$udom);
9726: $logmsg = 'Success modifying user '.$logmsg;
9727: &logthis($logmsg);
9728: return 'ok';
9729: }
9730:
9731: # -------------------------------------------------------------- Modify student
9732:
9733: sub modifystudent {
9734: my ($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene,$usec,
9735: $end,$start,$forceid,$desiredhome,$email,$type,$locktype,$cid,
9736: $selfenroll,$context,$inststatus,$credits,$instsec)=@_;
9737: if (!$cid) {
9738: unless ($cid=$env{'request.course.id'}) {
9739: return 'not_in_class';
9740: }
9741: }
9742: # --------------------------------------------------------------- Make the user
9743: my $reply=&modifyuser
9744: ($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene,$forceid,
9745: $desiredhome,$email,$inststatus);
9746: unless ($reply eq 'ok') { return $reply; }
9747: # This will cause &modify_student_enrollment to get the uid from the
9748: # student's environment
9749: $uid = undef if (!$forceid);
9750: $reply = &modify_student_enrollment($udom,$uname,$uid,$first,$middle,$last,
9751: $gene,$usec,$end,$start,$type,$locktype,
9752: $cid,$selfenroll,$context,$credits,$instsec);
9753: return $reply;
9754: }
9755:
9756: sub modify_student_enrollment {
9757: my ($udom,$uname,$uid,$first,$middle,$last,$gene,$usec,$end,$start,$type,
9758: $locktype,$cid,$selfenroll,$context,$credits,$instsec) = @_;
9759: my ($cdom,$cnum,$chome);
9760: if (!$cid) {
9761: unless ($cid=$env{'request.course.id'}) {
9762: return 'not_in_class';
9763: }
9764: $cdom=$env{'course.'.$cid.'.domain'};
9765: $cnum=$env{'course.'.$cid.'.num'};
9766: } else {
9767: ($cdom,$cnum)=split(/_/,$cid);
9768: }
9769: $chome=$env{'course.'.$cid.'.home'};
9770: if (!$chome) {
9771: $chome=&homeserver($cnum,$cdom);
9772: }
9773: if (!$chome) { return 'unknown_course'; }
9774: # Make sure the user exists
9775: my $uhome=&homeserver($uname,$udom);
9776: if (($uhome eq '') || ($uhome eq 'no_host')) {
9777: return 'error: no such user';
9778: }
9779: # Get student data if we were not given enough information
9780: if (!defined($first) || $first eq '' ||
9781: !defined($last) || $last eq '' ||
9782: !defined($uid) || $uid eq '' ||
9783: !defined($middle) || $middle eq '' ||
9784: !defined($gene) || $gene eq '') {
9785: # They did not supply us with enough data to enroll the student, so
9786: # we need to pick up more information.
9787: my %tmp = &get('environment',
9788: ['firstname','middlename','lastname', 'generation','id']
9789: ,$udom,$uname);
9790:
9791: #foreach my $key (keys(%tmp)) {
9792: # &logthis("key $key = ".$tmp{$key});
9793: #}
9794: $first = $tmp{'firstname'} if (!defined($first) || $first eq '');
9795: $middle = $tmp{'middlename'} if (!defined($middle) || $middle eq '');
9796: $last = $tmp{'lastname'} if (!defined($last) || $last eq '');
9797: $gene = $tmp{'generation'} if (!defined($gene) || $gene eq '');
9798: $uid = $tmp{'id'} if (!defined($uid) || $uid eq '');
9799: }
9800: my $fullname = &format_name($first,$middle,$last,$gene,'lastname');
9801: my $user = "$uname:$udom";
9802: my %old_entry = &Apache::lonnet::get('classlist',[$user],$cdom,$cnum);
9803: my $reply=cput('classlist',
9804: {$user =>
9805: join(':',$end,$start,$uid,$usec,$fullname,$type,$locktype,$credits,$instsec) },
9806: $cdom,$cnum);
9807: if (($reply eq 'ok') || ($reply eq 'delayed')) {
9808: &devalidate_getsection_cache($udom,$uname,$cid);
9809: } else {
9810: return 'error: '.$reply;
9811: }
9812: # Add student role to user
9813: my $uurl='/'.$cid;
9814: $uurl=~s/\_/\//g;
9815: if ($usec) {
9816: $uurl.='/'.$usec;
9817: }
9818: my $result = &assignrole($udom,$uname,$uurl,'st',$end,$start,undef,
9819: $selfenroll,$context);
9820: if ($result ne 'ok') {
9821: if ($old_entry{$user} ne '') {
9822: $reply = &cput('classlist',\%old_entry,$cdom,$cnum);
9823: } else {
9824: $reply = &del('classlist',[$user],$cdom,$cnum);
9825: }
9826: }
9827: return $result;
9828: }
9829:
9830: sub format_name {
9831: my ($firstname,$middlename,$lastname,$generation,$first)=@_;
9832: my $name;
9833: if ($first ne 'lastname') {
9834: $name=$firstname.' '.$middlename.' '.$lastname.' '.$generation;
9835: } else {
9836: if ($lastname=~/\S/) {
9837: $name.= $lastname.' '.$generation.', '.$firstname.' '.$middlename;
9838: $name=~s/\s+,/,/;
9839: } else {
9840: $name.= $firstname.' '.$middlename.' '.$generation;
9841: }
9842: }
9843: $name=~s/^\s+//;
9844: $name=~s/\s+$//;
9845: $name=~s/\s+/ /g;
9846: return $name;
9847: }
9848:
9849: # ------------------------------------------------- Write to course preferences
9850:
9851: sub writecoursepref {
9852: my ($courseid,%prefs)=@_;
9853: $courseid=~s/^\///;
9854: $courseid=~s/\_/\//g;
9855: my ($cdomain,$cnum)=split(/\//,$courseid);
9856: my $chome=homeserver($cnum,$cdomain);
9857: if (($chome eq '') || ($chome eq 'no_host')) {
9858: return 'error: no such course';
9859: }
9860: my $cstring='';
9861: foreach my $pref (keys(%prefs)) {
9862: $cstring.=&escape($pref).'='.&escape($prefs{$pref}).'&';
9863: }
9864: $cstring=~s/\&$//;
9865: return reply('put:'.$cdomain.':'.$cnum.':environment:'.$cstring,$chome);
9866: }
9867:
9868: # ---------------------------------------------------------- Make/modify course
9869:
9870: sub createcourse {
9871: my ($udom,$description,$url,$course_server,$nonstandard,$inst_code,
9872: $course_owner,$crstype,$cnum,$context,$category)=@_;
9873: $url=&declutter($url);
9874: my $cid='';
9875: if ($context eq 'requestcourses') {
9876: my $can_create = 0;
9877: my ($ownername,$ownerdom) = split(':',$course_owner);
9878: if ($udom eq $ownerdom) {
9879: if (&usertools_access($ownername,$ownerdom,$category,undef,
9880: $context)) {
9881: $can_create = 1;
9882: }
9883: } else {
9884: my %userenv = &userenvironment($ownerdom,$ownername,'reqcrsotherdom.'.
9885: $category);
9886: if ($userenv{'reqcrsotherdom.'.$category} ne '') {
9887: my @curr = split(',',$userenv{'reqcrsotherdom.'.$category});
9888: if (@curr > 0) {
9889: my @options = qw(approval validate autolimit);
9890: my $optregex = join('|',@options);
9891: if (grep(/^\Q$udom\E:($optregex)(=?\d*)$/,@curr)) {
9892: $can_create = 1;
9893: }
9894: }
9895: }
9896: }
9897: if ($can_create) {
9898: unless ($ownername eq $env{'user.name'} && $ownerdom eq $env{'user.domain'}) {
9899: unless (&allowed('ccc',$udom)) {
9900: return 'refused';
9901: }
9902: }
9903: } else {
9904: return 'refused';
9905: }
9906: } elsif (!&allowed('ccc',$udom)) {
9907: return 'refused';
9908: }
9909: # --------------------------------------------------------------- Get Unique ID
9910: my $uname;
9911: if ($cnum =~ /^$match_courseid$/) {
9912: my $chome=&homeserver($cnum,$udom,'true');
9913: if (($chome eq '') || ($chome eq 'no_host')) {
9914: $uname = $cnum;
9915: } else {
9916: $uname = &generate_coursenum($udom,$crstype);
9917: }
9918: } else {
9919: $uname = &generate_coursenum($udom,$crstype);
9920: }
9921: return $uname if ($uname =~ /^error/);
9922: # -------------------------------------------------- Check supplied server name
9923: if (!defined($course_server)) {
9924: if (defined(&domain($udom,'primary'))) {
9925: $course_server = &domain($udom,'primary');
9926: } else {
9927: $course_server = $env{'user.home'};
9928: }
9929: }
9930: my %host_servers =
9931: &Apache::lonnet::get_servers($udom,'library');
9932: unless ($host_servers{$course_server}) {
9933: return 'error: invalid home server for course: '.$course_server;
9934: }
9935: # ------------------------------------------------------------- Make the course
9936: my $reply=&reply('encrypt:makeuser:'.$udom.':'.$uname.':none::',
9937: $course_server);
9938: unless ($reply eq 'ok') { return 'error: '.$reply; }
9939: my $uhome=&homeserver($uname,$udom,'true');
9940: if (($uhome eq '') || ($uhome eq 'no_host')) {
9941: return 'error: no such course';
9942: }
9943: # ----------------------------------------------------------------- Course made
9944: # log existence
9945: my $now = time;
9946: my $newcourse = {
9947: $udom.'_'.$uname => {
9948: description => $description,
9949: inst_code => $inst_code,
9950: owner => $course_owner,
9951: type => $crstype,
9952: creator => $env{'user.name'}.':'.
9953: $env{'user.domain'},
9954: created => $now,
9955: context => $context,
9956: },
9957: };
9958: &courseidput($udom,$newcourse,$uhome,'notime');
9959: # set toplevel url
9960: my $topurl=$url;
9961: unless ($nonstandard) {
9962: # ------------------------------------------ For standard courses, make top url
9963: my $mapurl=&clutter($url);
9964: if ($mapurl eq '/res/') { $mapurl=''; }
9965: $env{'form.initmap'}=(<<ENDINITMAP);
9966: <map>
9967: <resource id="1" type="start"></resource>
9968: <resource id="2" src="$mapurl"></resource>
9969: <resource id="3" type="finish"></resource>
9970: <link index="1" from="1" to="2"></link>
9971: <link index="2" from="2" to="3"></link>
9972: </map>
9973: ENDINITMAP
9974: $topurl=&declutter(
9975: &finishuserfileupload($uname,$udom,'initmap','default.sequence')
9976: );
9977: }
9978: # ----------------------------------------------------------- Write preferences
9979: &writecoursepref($udom.'_'.$uname,
9980: ('description' => $description,
9981: 'url' => $topurl,
9982: 'internal.creator' => $env{'user.name'}.':'.
9983: $env{'user.domain'},
9984: 'internal.created' => $now,
9985: 'internal.creationcontext' => $context)
9986: );
9987: return '/'.$udom.'/'.$uname;
9988: }
9989:
9990: # ------------------------------------------------------------------- Create ID
9991: sub generate_coursenum {
9992: my ($udom,$crstype) = @_;
9993: my $domdesc = &domain($udom);
9994: return 'error: invalid domain' if ($domdesc eq '');
9995: my $first;
9996: if ($crstype eq 'Community') {
9997: $first = '0';
9998: } else {
9999: $first = int(1+rand(9));
10000: }
10001: my $uname=$first.
10002: ('a'..'z','A'..'Z','0'..'9')[int(rand(62))].
10003: substr($$.time,0,5).unpack("H8",pack("I32",time)).
10004: unpack("H2",pack("I32",int(rand(255)))).$perlvar{'lonHostID'};
10005: # ----------------------------------------------- Make sure that does not exist
10006: my $uhome=&homeserver($uname,$udom,'true');
10007: unless (($uhome eq '') || ($uhome eq 'no_host')) {
10008: if ($crstype eq 'Community') {
10009: $first = '0';
10010: } else {
10011: $first = int(1+rand(9));
10012: }
10013: $uname=$first.
10014: ('a'..'z','A'..'Z','0'..'9')[int(rand(62))].
10015: substr($$.time,0,5).unpack("H8",pack("I32",time)).
10016: unpack("H2",pack("I32",int(rand(255)))).$perlvar{'lonHostID'};
10017: $uhome=&homeserver($uname,$udom,'true');
10018: unless (($uhome eq '') || ($uhome eq 'no_host')) {
10019: return 'error: unable to generate unique course-ID';
10020: }
10021: }
10022: return $uname;
10023: }
10024:
10025: sub is_course {
10026: my ($cdom, $cnum) = scalar(@_) == 1 ?
10027: ($_[0] =~ /^($match_domain)_($match_courseid)$/) : @_;
10028:
10029: return unless $cdom and $cnum;
10030:
10031: my %courses = &courseiddump($cdom, '.', 1, '.', '.', $cnum, undef, undef,
10032: '.');
10033:
10034: return unless(exists($courses{$cdom.'_'.$cnum}));
10035: return wantarray ? ($cdom, $cnum) : $cdom.'_'.$cnum;
10036: }
10037:
10038: sub store_userdata {
10039: my ($storehash,$datakey,$namespace,$udom,$uname) = @_;
10040: my $result;
10041: if ($datakey ne '') {
10042: if (ref($storehash) eq 'HASH') {
10043: if ($udom eq '' || $uname eq '') {
10044: $udom = $env{'user.domain'};
10045: $uname = $env{'user.name'};
10046: }
10047: my $uhome=&homeserver($uname,$udom);
10048: if (($uhome eq '') || ($uhome eq 'no_host')) {
10049: $result = 'error: no_host';
10050: } else {
10051: $storehash->{'ip'} = $ENV{'REMOTE_ADDR'};
10052: $storehash->{'host'} = $perlvar{'lonHostID'};
10053:
10054: my $namevalue='';
10055: foreach my $key (keys(%{$storehash})) {
10056: $namevalue.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
10057: }
10058: $namevalue=~s/\&$//;
10059: unless ($namespace eq 'courserequests') {
10060: $datakey = &escape($datakey);
10061: }
10062: $result = &reply("store:$udom:$uname:$namespace:$datakey:".
10063: $namevalue,$uhome);
10064: }
10065: } else {
10066: $result = 'error: data to store was not a hash reference';
10067: }
10068: } else {
10069: $result= 'error: invalid requestkey';
10070: }
10071: return $result;
10072: }
10073:
10074: # ---------------------------------------------------------- Assign Custom Role
10075:
10076: sub assigncustomrole {
10077: my ($udom,$uname,$url,$rdom,$rnam,$rolename,$end,$start,$deleteflag,$selfenroll,$context)=@_;
10078: return &assignrole($udom,$uname,$url,'cr/'.$rdom.'/'.$rnam.'/'.$rolename,
10079: $end,$start,$deleteflag,$selfenroll,$context);
10080: }
10081:
10082: # ----------------------------------------------------------------- Revoke Role
10083:
10084: sub revokerole {
10085: my ($udom,$uname,$url,$role,$deleteflag,$selfenroll,$context)=@_;
10086: my $now=time;
10087: return &assignrole($udom,$uname,$url,$role,$now,undef,$deleteflag,$selfenroll,$context);
10088: }
10089:
10090: # ---------------------------------------------------------- Revoke Custom Role
10091:
10092: sub revokecustomrole {
10093: my ($udom,$uname,$url,$rdom,$rnam,$rolename,$deleteflag,$selfenroll,$context)=@_;
10094: my $now=time;
10095: return &assigncustomrole($udom,$uname,$url,$rdom,$rnam,$rolename,$now,
10096: $deleteflag,$selfenroll,$context);
10097: }
10098:
10099: # ------------------------------------------------------------ Disk usage
10100: sub diskusage {
10101: my ($udom,$uname,$directorypath,$getpropath)=@_;
10102: $directorypath =~ s/\/$//;
10103: my $listing=&reply('du2:'.&escape($directorypath).':'
10104: .&escape($getpropath).':'.&escape($uname).':'
10105: .&escape($udom),homeserver($uname,$udom));
10106: if ($listing eq 'unknown_cmd') {
10107: if ($getpropath) {
10108: $directorypath = &propath($udom,$uname).'/'.$directorypath;
10109: }
10110: $listing = &reply('du:'.$directorypath,homeserver($uname,$udom));
10111: }
10112: return $listing;
10113: }
10114:
10115: sub is_locked {
10116: my ($file_name, $domain, $user, $which) = @_;
10117: my @check;
10118: my $is_locked;
10119: push (@check,$file_name);
10120: my %locked = &get('file_permissions',\@check,
10121: $env{'user.domain'},$env{'user.name'});
10122: my ($tmp)=keys(%locked);
10123: if ($tmp=~/^error:/) { undef(%locked); }
10124:
10125: if (ref($locked{$file_name}) eq 'ARRAY') {
10126: $is_locked = 'false';
10127: foreach my $entry (@{$locked{$file_name}}) {
10128: if (ref($entry) eq 'ARRAY') {
10129: $is_locked = 'true';
10130: if (ref($which) eq 'ARRAY') {
10131: push(@{$which},$entry);
10132: } else {
10133: last;
10134: }
10135: }
10136: }
10137: } else {
10138: $is_locked = 'false';
10139: }
10140: return $is_locked;
10141: }
10142:
10143: sub declutter_portfile {
10144: my ($file) = @_;
10145: $file =~ s{^(/portfolio/|portfolio/)}{/};
10146: return $file;
10147: }
10148:
10149: # ------------------------------------------------------------- Mark as Read Only
10150:
10151: sub mark_as_readonly {
10152: my ($domain,$user,$files,$what) = @_;
10153: my %current_permissions = &dump('file_permissions',$domain,$user);
10154: my ($tmp)=keys(%current_permissions);
10155: if ($tmp=~/^error:/) { undef(%current_permissions); }
10156: foreach my $file (@{$files}) {
10157: $file = &declutter_portfile($file);
10158: push(@{$current_permissions{$file}},$what);
10159: }
10160: &put('file_permissions',\%current_permissions,$domain,$user);
10161: return;
10162: }
10163:
10164: # ------------------------------------------------------------Save Selected Files
10165:
10166: sub save_selected_files {
10167: my ($user, $path, @files) = @_;
10168: my $filename = $user."savedfiles";
10169: my @other_files = &files_not_in_path($user, $path);
10170: open (OUT,'>',LONCAPA::tempdir().$filename);
10171: foreach my $file (@files) {
10172: print (OUT $env{'form.currentpath'}.$file."\n");
10173: }
10174: foreach my $file (@other_files) {
10175: print (OUT $file."\n");
10176: }
10177: close (OUT);
10178: return 'ok';
10179: }
10180:
10181: sub clear_selected_files {
10182: my ($user) = @_;
10183: my $filename = $user."savedfiles";
10184: open (OUT,'>',LONCAPA::tempdir().$filename);
10185: print (OUT undef);
10186: close (OUT);
10187: return ("ok");
10188: }
10189:
10190: sub files_in_path {
10191: my ($user, $path) = @_;
10192: my $filename = $user."savedfiles";
10193: my %return_files;
10194: open (IN,'<',LONCAPA::tempdir().$filename);
10195: while (my $line_in = <IN>) {
10196: chomp ($line_in);
10197: my @paths_and_file = split (m!/!, $line_in);
10198: my $file_part = pop (@paths_and_file);
10199: my $path_part = join ('/', @paths_and_file);
10200: $path_part.='/';
10201: my $path_and_file = $path_part.$file_part;
10202: if ($path_part eq $path) {
10203: $return_files{$file_part}= 'selected';
10204: }
10205: }
10206: close (IN);
10207: return (\%return_files);
10208: }
10209:
10210: # called in portfolio select mode, to show files selected NOT in current directory
10211: sub files_not_in_path {
10212: my ($user, $path) = @_;
10213: my $filename = $user."savedfiles";
10214: my @return_files;
10215: my $path_part;
10216: open(IN, '<',LONCAPA::tempdir().$filename);
10217: while (my $line = <IN>) {
10218: #ok, I know it's clunky, but I want it to work
10219: my @paths_and_file = split(m|/|, $line);
10220: my $file_part = pop(@paths_and_file);
10221: chomp($file_part);
10222: my $path_part = join('/', @paths_and_file);
10223: $path_part .= '/';
10224: my $path_and_file = $path_part.$file_part;
10225: if ($path_part ne $path) {
10226: push(@return_files, ($path_and_file));
10227: }
10228: }
10229: close(OUT);
10230: return (@return_files);
10231: }
10232:
10233: #------------------------------Submitted/Handedback Portfolio Files Versioning
10234:
10235: sub portfiles_versioning {
10236: my ($symb,$domain,$stu_name,$portfiles,$versioned_portfiles) = @_;
10237: my $portfolio_root = '/userfiles/portfolio';
10238: return unless ((ref($portfiles) eq 'ARRAY') && (ref($versioned_portfiles) eq 'ARRAY'));
10239: foreach my $file (@{$portfiles}) {
10240: &unmark_as_readonly($domain,$stu_name,[$symb,$env{'request.course.id'}],$file);
10241: my ($directory,$answer_file) =($file =~ /^(.*?)([^\/]*)$/);
10242: my ($answer_name,$answer_ver,$answer_ext) = &file_name_version_ext($answer_file);
10243: my $getpropath = 1;
10244: my ($dir_list,$listerror) = &dirlist($portfolio_root.$directory,$domain,
10245: $stu_name,$getpropath);
10246: my $version = &get_next_version($answer_name,$answer_ext,$dir_list);
10247: my $new_answer =
10248: &version_selected_portfile($domain,$stu_name,$directory,$answer_file,$version);
10249: if ($new_answer ne 'problem getting file') {
10250: push(@{$versioned_portfiles}, $directory.$new_answer);
10251: &mark_as_readonly($domain,$stu_name,[$directory.$new_answer],
10252: [$symb,$env{'request.course.id'},'graded']);
10253: }
10254: }
10255: }
10256:
10257: sub get_next_version {
10258: my ($answer_name, $answer_ext, $dir_list) = @_;
10259: my $version;
10260: if (ref($dir_list) eq 'ARRAY') {
10261: foreach my $row (@{$dir_list}) {
10262: my ($file) = split(/\&/,$row,2);
10263: my ($file_name,$file_version,$file_ext) =
10264: &file_name_version_ext($file);
10265: if (($file_name eq $answer_name) &&
10266: ($file_ext eq $answer_ext)) {
10267: # gets here if filename and extension match,
10268: # regardless of version
10269: if ($file_version ne '') {
10270: # a versioned file is found so save it for later
10271: if ($file_version > $version) {
10272: $version = $file_version;
10273: }
10274: }
10275: }
10276: }
10277: }
10278: $version ++;
10279: return($version);
10280: }
10281:
10282: sub version_selected_portfile {
10283: my ($domain,$stu_name,$directory,$file_name,$version) = @_;
10284: my ($answer_name,$answer_ver,$answer_ext) =
10285: &file_name_version_ext($file_name);
10286: my $new_answer;
10287: $env{'form.copy'} =
10288: &getfile("/uploaded/$domain/$stu_name/portfolio$directory$file_name");
10289: if($env{'form.copy'} eq '-1') {
10290: $new_answer = 'problem getting file';
10291: } else {
10292: $new_answer = $answer_name.'.'.$version.'.'.$answer_ext;
10293: my $copy_result =
10294: &finishuserfileupload($stu_name,$domain,'copy',
10295: '/portfolio'.$directory.$new_answer);
10296: }
10297: undef($env{'form.copy'});
10298: return ($new_answer);
10299: }
10300:
10301: sub file_name_version_ext {
10302: my ($file)=@_;
10303: my @file_parts = split(/\./, $file);
10304: my ($name,$version,$ext);
10305: if (@file_parts > 1) {
10306: $ext=pop(@file_parts);
10307: if (@file_parts > 1 && $file_parts[-1] =~ /^\d+$/) {
10308: $version=pop(@file_parts);
10309: }
10310: $name=join('.',@file_parts);
10311: } else {
10312: $name=join('.',@file_parts);
10313: }
10314: return($name,$version,$ext);
10315: }
10316:
10317: #----------------------------------------------Get portfolio file permissions
10318:
10319: sub get_portfile_permissions {
10320: my ($domain,$user) = @_;
10321: my %current_permissions = &dump('file_permissions',$domain,$user);
10322: my ($tmp)=keys(%current_permissions);
10323: if ($tmp=~/^error:/) { undef(%current_permissions); }
10324: return \%current_permissions;
10325: }
10326:
10327: #---------------------------------------------Get portfolio file access controls
10328:
10329: sub get_access_controls {
10330: my ($current_permissions,$group,$file) = @_;
10331: my %access;
10332: my $real_file = $file;
10333: $file =~ s/\.meta$//;
10334: if (defined($file)) {
10335: if (ref($$current_permissions{$file."\0".'accesscontrol'}) eq 'HASH') {
10336: foreach my $control (keys(%{$$current_permissions{$file."\0".'accesscontrol'}})) {
10337: $access{$real_file}{$control} = $$current_permissions{$file."\0".$control};
10338: }
10339: }
10340: } else {
10341: foreach my $key (keys(%{$current_permissions})) {
10342: if ($key =~ /\0accesscontrol$/) {
10343: if (defined($group)) {
10344: if ($key !~ m-^\Q$group\E/-) {
10345: next;
10346: }
10347: }
10348: my ($fullpath) = split(/\0/,$key);
10349: if (ref($$current_permissions{$key}) eq 'HASH') {
10350: foreach my $control (keys(%{$$current_permissions{$key}})) {
10351: $access{$fullpath}{$control}=$$current_permissions{$fullpath."\0".$control};
10352: }
10353: }
10354: }
10355: }
10356: }
10357: return %access;
10358: }
10359:
10360: sub modify_access_controls {
10361: my ($file_name,$changes,$domain,$user)=@_;
10362: my ($outcome,$deloutcome);
10363: my %store_permissions;
10364: my %new_values;
10365: my %new_control;
10366: my %translation;
10367: my @deletions = ();
10368: my $now = time;
10369: if (exists($$changes{'activate'})) {
10370: if (ref($$changes{'activate'}) eq 'HASH') {
10371: my @newitems = sort(keys(%{$$changes{'activate'}}));
10372: my $numnew = scalar(@newitems);
10373: for (my $i=0; $i<$numnew; $i++) {
10374: my $newkey = $newitems[$i];
10375: my $newid = &Apache::loncommon::get_cgi_id();
10376: if ($newkey =~ /^\d+:/) {
10377: $newkey =~ s/^(\d+)/$newid/;
10378: $translation{$1} = $newid;
10379: } elsif ($newkey =~ /^\d+_\d+_\d+:/) {
10380: $newkey =~ s/^(\d+_\d+_\d+)/$newid/;
10381: $translation{$1} = $newid;
10382: }
10383: $new_values{$file_name."\0".$newkey} =
10384: $$changes{'activate'}{$newitems[$i]};
10385: $new_control{$newkey} = $now;
10386: }
10387: }
10388: }
10389: my %todelete;
10390: my %changed_items;
10391: foreach my $action ('delete','update') {
10392: if (exists($$changes{$action})) {
10393: if (ref($$changes{$action}) eq 'HASH') {
10394: foreach my $key (keys(%{$$changes{$action}})) {
10395: my ($itemnum) = ($key =~ /^([^:]+):/);
10396: if ($action eq 'delete') {
10397: $todelete{$itemnum} = 1;
10398: } else {
10399: $changed_items{$itemnum} = $key;
10400: }
10401: }
10402: }
10403: }
10404: }
10405: # get lock on access controls for file.
10406: my $lockhash = {
10407: $file_name."\0".'locked_access_records' => $env{'user.name'}.
10408: ':'.$env{'user.domain'},
10409: };
10410: my $tries = 0;
10411: my $gotlock = &newput('file_permissions',$lockhash,$domain,$user);
10412:
10413: while (($gotlock ne 'ok') && $tries < 10) {
10414: $tries ++;
10415: sleep(0.1);
10416: $gotlock = &newput('file_permissions',$lockhash,$domain,$user);
10417: }
10418: if ($gotlock eq 'ok') {
10419: my %curr_permissions = &dump('file_permissions',$domain,$user,$file_name);
10420: my ($tmp)=keys(%curr_permissions);
10421: if ($tmp=~/^error:/) { undef(%curr_permissions); }
10422: if (exists($curr_permissions{$file_name."\0".'accesscontrol'})) {
10423: my $curr_controls = $curr_permissions{$file_name."\0".'accesscontrol'};
10424: if (ref($curr_controls) eq 'HASH') {
10425: foreach my $control_item (keys(%{$curr_controls})) {
10426: my ($itemnum) = ($control_item =~ /^([^:]+):/);
10427: if (defined($todelete{$itemnum})) {
10428: push(@deletions,$file_name."\0".$control_item);
10429: } else {
10430: if (defined($changed_items{$itemnum})) {
10431: $new_control{$changed_items{$itemnum}} = $now;
10432: push(@deletions,$file_name."\0".$control_item);
10433: $new_values{$file_name."\0".$changed_items{$itemnum}} = $$changes{'update'}{$changed_items{$itemnum}};
10434: } else {
10435: $new_control{$control_item} = $$curr_controls{$control_item};
10436: }
10437: }
10438: }
10439: }
10440: }
10441: my ($group);
10442: if (&is_course($domain,$user)) {
10443: ($group,my $file) = split(/\//,$file_name,2);
10444: }
10445: $deloutcome = &del('file_permissions',\@deletions,$domain,$user);
10446: $new_values{$file_name."\0".'accesscontrol'} = \%new_control;
10447: $outcome = &put('file_permissions',\%new_values,$domain,$user);
10448: # remove lock
10449: my @del_lock = ($file_name."\0".'locked_access_records');
10450: my $dellockoutcome = &del('file_permissions',\@del_lock,$domain,$user);
10451: my $sqlresult =
10452: &update_portfolio_table($user,$domain,$file_name,'portfolio_access',
10453: $group);
10454: } else {
10455: $outcome = "error: could not obtain lockfile\n";
10456: }
10457: return ($outcome,$deloutcome,\%new_values,\%translation);
10458: }
10459:
10460: sub make_public_indefinitely {
10461: my (@requrl) = @_;
10462: return &automated_portfile_access('public',\@requrl);
10463: }
10464:
10465: sub automated_portfile_access {
10466: my ($accesstype,$addsref,$delsref,$info) = @_;
10467: unless (($accesstype eq 'public') || ($accesstype eq 'ip')) {
10468: return 'invalid';
10469: }
10470: my %urls;
10471: if (ref($addsref) eq 'ARRAY') {
10472: foreach my $requrl (@{$addsref}) {
10473: if (&is_portfolio_url($requrl)) {
10474: unless (exists($urls{$requrl})) {
10475: $urls{$requrl} = 'add';
10476: }
10477: }
10478: }
10479: }
10480: if (ref($delsref) eq 'ARRAY') {
10481: foreach my $requrl (@{$delsref}) {
10482: if (&is_portfolio_url($requrl)) {
10483: unless (exists($urls{$requrl})) {
10484: $urls{$requrl} = 'delete';
10485: }
10486: }
10487: }
10488: }
10489: unless (keys(%urls)) {
10490: return 'invalid';
10491: }
10492: my $ip;
10493: if ($accesstype eq 'ip') {
10494: if (ref($info) eq 'HASH') {
10495: if ($info->{'ip'} ne '') {
10496: $ip = $info->{'ip'};
10497: }
10498: }
10499: if ($ip eq '') {
10500: return 'invalid';
10501: }
10502: }
10503: my $errors;
10504: my $now = time;
10505: my %current_perms;
10506: foreach my $requrl (sort(keys(%urls))) {
10507: my $action;
10508: if ($urls{$requrl} eq 'add') {
10509: $action = 'activate';
10510: } else {
10511: $action = 'none';
10512: }
10513: my $aclnum = 0;
10514: my (undef,$udom,$unum,$file_name,$group) =
10515: &parse_portfolio_url($requrl);
10516: unless (exists($current_perms{$unum.':'.$udom})) {
10517: $current_perms{$unum.':'.$udom} = &get_portfile_permissions($udom,$unum);
10518: }
10519: my %access_controls = &get_access_controls($current_perms{$unum.':'.$udom},
10520: $group,$file_name);
10521: foreach my $key (keys(%{$access_controls{$file_name}})) {
10522: my ($num,$scope,$end,$start) =
10523: ($key =~ /^([^:]+):([a-z]+)_(\d*)_?(\d*)$/);
10524: if ($scope eq $accesstype) {
10525: if (($start <= $now) && ($end == 0)) {
10526: if ($accesstype eq 'ip') {
10527: if (ref($access_controls{$file_name}{$key}) eq 'HASH') {
10528: if (ref($access_controls{$file_name}{$key}{'ip'}) eq 'ARRAY') {
10529: if (grep(/^\Q$ip\E$/,@{$access_controls{$file_name}{$key}{'ip'}})) {
10530: if ($urls{$requrl} eq 'add') {
10531: $action = 'none';
10532: last;
10533: } else {
10534: $action = 'delete';
10535: $aclnum = $num;
10536: last;
10537: }
10538: }
10539: }
10540: }
10541: } elsif ($accesstype eq 'public') {
10542: if ($urls{$requrl} eq 'add') {
10543: $action = 'none';
10544: last;
10545: } else {
10546: $action = 'delete';
10547: $aclnum = $num;
10548: last;
10549: }
10550: }
10551: } elsif ($accesstype eq 'public') {
10552: $action = 'update';
10553: $aclnum = $num;
10554: last;
10555: }
10556: }
10557: }
10558: if ($action eq 'none') {
10559: next;
10560: } else {
10561: my %changes;
10562: my $newend = 0;
10563: my $newstart = $now;
10564: my $newkey = $aclnum.':'.$accesstype.'_'.$newend.'_'.$newstart;
10565: $changes{$action}{$newkey} = {
10566: type => $accesstype,
10567: time => {
10568: start => $newstart,
10569: end => $newend,
10570: },
10571: };
10572: if ($accesstype eq 'ip') {
10573: $changes{$action}{$newkey}{'ip'} = [$ip];
10574: }
10575: my ($outcome,$deloutcome,$new_values,$translation) =
10576: &modify_access_controls($file_name,\%changes,$udom,$unum);
10577: unless ($outcome eq 'ok') {
10578: $errors .= $outcome.' ';
10579: }
10580: }
10581: }
10582: if ($errors) {
10583: $errors =~ s/\s$//;
10584: return $errors;
10585: } else {
10586: return 'ok';
10587: }
10588: }
10589:
10590: #------------------------------------------------------Get Marked as Read Only
10591:
10592: sub get_marked_as_readonly {
10593: my ($domain,$user,$what,$group) = @_;
10594: my $current_permissions = &get_portfile_permissions($domain,$user);
10595: my @readonly_files;
10596: my $cmp1=$what;
10597: if (ref($what)) { $cmp1=join('',@{$what}) };
10598: while (my ($file_name,$value) = each(%{$current_permissions})) {
10599: if (defined($group)) {
10600: if ($file_name !~ m-^\Q$group\E/-) {
10601: next;
10602: }
10603: }
10604: if (ref($value) eq "ARRAY"){
10605: foreach my $stored_what (@{$value}) {
10606: my $cmp2=$stored_what;
10607: if (ref($stored_what) eq 'ARRAY') {
10608: $cmp2=join('',@{$stored_what});
10609: }
10610: if ($cmp1 eq $cmp2) {
10611: push(@readonly_files, $file_name);
10612: last;
10613: } elsif (!defined($what)) {
10614: push(@readonly_files, $file_name);
10615: last;
10616: }
10617: }
10618: }
10619: }
10620: return @readonly_files;
10621: }
10622: #-----------------------------------------------------------Get Marked as Read Only Hash
10623:
10624: sub get_marked_as_readonly_hash {
10625: my ($current_permissions,$group,$what) = @_;
10626: my %readonly_files;
10627: while (my ($file_name,$value) = each(%{$current_permissions})) {
10628: if (defined($group)) {
10629: if ($file_name !~ m-^\Q$group\E/-) {
10630: next;
10631: }
10632: }
10633: if (ref($value) eq "ARRAY"){
10634: foreach my $stored_what (@{$value}) {
10635: if (ref($stored_what) eq 'ARRAY') {
10636: foreach my $lock_descriptor(@{$stored_what}) {
10637: if ($lock_descriptor eq 'graded') {
10638: $readonly_files{$file_name} = 'graded';
10639: } elsif ($lock_descriptor eq 'handback') {
10640: $readonly_files{$file_name} = 'handback';
10641: } else {
10642: if (!exists($readonly_files{$file_name})) {
10643: $readonly_files{$file_name} = 'locked';
10644: }
10645: }
10646: }
10647: }
10648: }
10649: }
10650: }
10651: return %readonly_files;
10652: }
10653: # ------------------------------------------------------------ Unmark as Read Only
10654:
10655: sub unmark_as_readonly {
10656: # unmarks $file_name (if $file_name is defined), or all files locked by $what
10657: # for portfolio submissions, $what contains [$symb,$crsid]
10658: my ($domain,$user,$what,$file_name,$group) = @_;
10659: $file_name = &declutter_portfile($file_name);
10660: my $symb_crs = $what;
10661: if (ref($what)) { $symb_crs=join('',@$what); }
10662: my %current_permissions = &dump('file_permissions',$domain,$user,$group);
10663: my ($tmp)=keys(%current_permissions);
10664: if ($tmp=~/^error:/) { undef(%current_permissions); }
10665: my @readonly_files = &get_marked_as_readonly($domain,$user,$what,$group);
10666: foreach my $file (@readonly_files) {
10667: my $clean_file = &declutter_portfile($file);
10668: if (defined($file_name) && ($file_name ne $clean_file)) { next; }
10669: my $current_locks = $current_permissions{$file};
10670: my @new_locks;
10671: my @del_keys;
10672: if (ref($current_locks) eq "ARRAY"){
10673: foreach my $locker (@{$current_locks}) {
10674: my $compare=$locker;
10675: if (ref($locker) eq 'ARRAY') {
10676: $compare=join('',@{$locker});
10677: if ($compare ne $symb_crs) {
10678: push(@new_locks, $locker);
10679: }
10680: }
10681: }
10682: if (scalar(@new_locks) > 0) {
10683: $current_permissions{$file} = \@new_locks;
10684: } else {
10685: push(@del_keys, $file);
10686: &del('file_permissions',\@del_keys, $domain, $user);
10687: delete($current_permissions{$file});
10688: }
10689: }
10690: }
10691: &put('file_permissions',\%current_permissions,$domain,$user);
10692: return;
10693: }
10694:
10695: # ------------------------------------------------------------ Directory lister
10696:
10697: sub dirlist {
10698: my ($uri,$userdomain,$username,$getpropath,$getuserdir,$alternateRoot)=@_;
10699: $uri=~s/^\///;
10700: $uri=~s/\/$//;
10701: my ($udom, $uname);
10702: if ($getuserdir) {
10703: $udom = $userdomain;
10704: $uname = $username;
10705: } else {
10706: (undef,$udom,$uname)=split(/\//,$uri);
10707: if(defined($userdomain)) {
10708: $udom = $userdomain;
10709: }
10710: if(defined($username)) {
10711: $uname = $username;
10712: }
10713: }
10714: my ($dirRoot,$listing,@listing_results);
10715:
10716: $dirRoot = $perlvar{'lonDocRoot'};
10717: if (defined($getpropath)) {
10718: $dirRoot = &propath($udom,$uname);
10719: $dirRoot =~ s/\/$//;
10720: } elsif (defined($getuserdir)) {
10721: my $subdir=$uname.'__';
10722: $subdir =~ s/(.)(.)(.).*/$1\/$2\/$3/;
10723: $dirRoot = $Apache::lonnet::perlvar{'lonUsersDir'}
10724: ."/$udom/$subdir/$uname";
10725: } elsif (defined($alternateRoot)) {
10726: $dirRoot = $alternateRoot;
10727: }
10728:
10729: if($udom) {
10730: if($uname) {
10731: my $uhome = &homeserver($uname,$udom);
10732: if ($uhome eq 'no_host') {
10733: return ([],'no_host');
10734: }
10735: $listing = &reply('ls3:'.&escape('/'.$uri).':'.$getpropath.':'
10736: .$getuserdir.':'.&escape($dirRoot)
10737: .':'.&escape($uname).':'.&escape($udom),$uhome);
10738: if ($listing eq 'unknown_cmd') {
10739: $listing = &reply('ls2:'.$dirRoot.'/'.$uri,$uhome);
10740: } else {
10741: @listing_results = map { &unescape($_); } split(/:/,$listing);
10742: }
10743: if ($listing eq 'unknown_cmd') {
10744: $listing = &reply('ls:'.$dirRoot.'/'.$uri,$uhome);
10745: @listing_results = split(/:/,$listing);
10746: } else {
10747: @listing_results = map { &unescape($_); } split(/:/,$listing);
10748: }
10749: if (($listing eq 'no_such_host') || ($listing eq 'con_lost') ||
10750: ($listing eq 'rejected') || ($listing eq 'refused') ||
10751: ($listing eq 'no_such_dir') || ($listing eq 'empty')) {
10752: return ([],$listing);
10753: } else {
10754: return (\@listing_results);
10755: }
10756: } elsif(!$alternateRoot) {
10757: my (%allusers,%listerror);
10758: my %servers = &get_servers($udom,'library');
10759: foreach my $tryserver (keys(%servers)) {
10760: $listing = &reply('ls3:'.&escape("/res/$udom").':::::'.
10761: &escape($udom),$tryserver);
10762: if ($listing eq 'unknown_cmd') {
10763: $listing = &reply('ls2:'.$perlvar{'lonDocRoot'}.'/res/'.
10764: $udom, $tryserver);
10765: } else {
10766: @listing_results = map { &unescape($_); } split(/:/,$listing);
10767: }
10768: if ($listing eq 'unknown_cmd') {
10769: $listing = &reply('ls:'.$perlvar{'lonDocRoot'}.'/res/'.
10770: $udom, $tryserver);
10771: @listing_results = split(/:/,$listing);
10772: } else {
10773: @listing_results =
10774: map { &unescape($_); } split(/:/,$listing);
10775: }
10776: if (($listing eq 'no_such_host') || ($listing eq 'con_lost') ||
10777: ($listing eq 'rejected') || ($listing eq 'refused') ||
10778: ($listing eq 'no_such_dir') || ($listing eq 'empty')) {
10779: $listerror{$tryserver} = $listing;
10780: } else {
10781: foreach my $line (@listing_results) {
10782: my ($entry) = split(/&/,$line,2);
10783: $allusers{$entry} = 1;
10784: }
10785: }
10786: }
10787: my @alluserslist=();
10788: foreach my $user (sort(keys(%allusers))) {
10789: push(@alluserslist,$user.'&user');
10790: }
10791:
10792: if (!%listerror) {
10793: # no errors
10794: return (\@alluserslist);
10795: } elsif (scalar(keys(%servers)) == 1) {
10796: # one library server, one error
10797: my ($key) = keys(%listerror);
10798: return (\@alluserslist, $listerror{$key});
10799: } elsif ( grep { $_ eq 'con_lost' } values(%listerror) ) {
10800: # con_lost indicates that we might miss data from at least one
10801: # library server
10802: return (\@alluserslist, 'con_lost');
10803: } else {
10804: # multiple library servers and no con_lost -> data should be
10805: # complete.
10806: return (\@alluserslist);
10807: }
10808:
10809: } else {
10810: return ([],'missing username');
10811: }
10812: } elsif(!defined($getpropath)) {
10813: my $path = $perlvar{'lonDocRoot'}.'/res/';
10814: my @all_domains = map { $path.$_.'/&domain'; } (sort(&all_domains()));
10815: return (\@all_domains);
10816: } else {
10817: return ([],'missing domain');
10818: }
10819: }
10820:
10821: # --------------------------------------------- GetFileTimestamp
10822: # This function utilizes dirlist and returns the date stamp for
10823: # when it was last modified. It will also return an error of -1
10824: # if an error occurs
10825:
10826: sub GetFileTimestamp {
10827: my ($studentDomain,$studentName,$filename,$getuserdir)=@_;
10828: $studentDomain = &LONCAPA::clean_domain($studentDomain);
10829: $studentName = &LONCAPA::clean_username($studentName);
10830: my ($fileref,$error) = &dirlist($filename,$studentDomain,$studentName,
10831: undef,$getuserdir);
10832: if (($error eq 'empty') || ($error eq 'no_such_dir')) {
10833: return -1;
10834: }
10835: if (ref($fileref) eq 'ARRAY') {
10836: my @stats = split('&',$fileref->[0]);
10837: # @stats contains first the filename, then the stat output
10838: return $stats[10]; # so this is 10 instead of 9.
10839: } else {
10840: return -1;
10841: }
10842: }
10843:
10844: sub stat_file {
10845: my ($uri) = @_;
10846: $uri = &clutter_with_no_wrapper($uri);
10847:
10848: my ($udom,$uname,$file);
10849: if ($uri =~ m-^/(uploaded|editupload)/-) {
10850: ($udom,$uname,$file) =
10851: ($uri =~ m-/(?:uploaded|editupload)/?($match_domain)/?($match_name)/?(.*)-);
10852: $file = 'userfiles/'.$file;
10853: }
10854: if ($uri =~ m-^/res/-) {
10855: ($udom,$uname) =
10856: ($uri =~ m-/(?:res)/?($match_domain)/?($match_username)/-);
10857: $file = $uri;
10858: }
10859:
10860: if (!$udom || !$uname || !$file) {
10861: # unable to handle the uri
10862: return ();
10863: }
10864: my $getpropath;
10865: if ($file =~ /^userfiles\//) {
10866: $getpropath = 1;
10867: }
10868: my ($listref,$error) = &dirlist($file,$udom,$uname,$getpropath);
10869: if (($error eq 'empty') || ($error eq 'no_such_dir')) {
10870: return ();
10871: } else {
10872: if (ref($listref) eq 'ARRAY') {
10873: my @stats = split('&',$listref->[0]);
10874: shift(@stats); #filename is first
10875: return @stats;
10876: }
10877: }
10878: return ();
10879: }
10880:
10881: # --------------------------------------------------------- recursedirs
10882: # Recursive function to traverse either a specific user's Authoring Space
10883: # or corresponding Published Resource Space, and populate the hash ref:
10884: # $dirhashref with URLs of all directories, and if $filehashref hash
10885: # ref arg is provided, the URLs of any files, excluding versioned, .meta,
10886: # or .rights files in resource space, and .meta, .save, .log, and .bak
10887: # files in Authoring Space.
10888: #
10889: # Inputs:
10890: #
10891: # $is_home - true if current server is home server for user's space
10892: # $context - either: priv, or res respectively for Authoring or Resource Space.
10893: # $docroot - Document root (i.e., /home/httpd/html
10894: # $toppath - Top level directory (i.e., /res/$dom/$uname or /priv/$dom/$uname
10895: # $relpath - Current path (relative to top level).
10896: # $dirhashref - reference to hash to populate with URLs of directories (Required)
10897: # $filehashref - reference to hash to populate with URLs of files (Optional)
10898: #
10899: # Returns: nothing
10900: #
10901: # Side Effects: populates $dirhashref, and $filehashref (if provided).
10902: #
10903: # Currently used by interface/londocs.pm to create linked select boxes for
10904: # directory and filename to import a Course "Author" resource into a course, and
10905: # also to create linked select boxes for Authoring Space and Directory to choose
10906: # save location for creation of a new "standard" problem from the Course Editor.
10907: #
10908:
10909: sub recursedirs {
10910: my ($is_home,$context,$docroot,$toppath,$relpath,$dirhashref,$filehashref) = @_;
10911: return unless (ref($dirhashref) eq 'HASH');
10912: my $currpath = $docroot.$toppath;
10913: if ($relpath) {
10914: $currpath .= "/$relpath";
10915: }
10916: my $savefile;
10917: if (ref($filehashref)) {
10918: $savefile = 1;
10919: }
10920: if ($is_home) {
10921: if (opendir(my $dirh,$currpath)) {
10922: foreach my $item (sort { lc($a) cmp lc($b) } grep(!/^\.+$/,readdir($dirh))) {
10923: next if ($item eq '');
10924: if (-d "$currpath/$item") {
10925: my $newpath;
10926: if ($relpath) {
10927: $newpath = "$relpath/$item";
10928: } else {
10929: $newpath = $item;
10930: }
10931: $dirhashref->{&Apache::lonlocal::js_escape($newpath)} = 1;
10932: &recursedirs($is_home,$context,$docroot,$toppath,$newpath,$dirhashref,$filehashref);
10933: } elsif ($savefile) {
10934: if ($context eq 'priv') {
10935: unless ($item =~ /\.(meta|save|log|bak|DS_Store)$/) {
10936: $filehashref->{&Apache::lonlocal::js_escape($relpath)}{$item} = 1;
10937: }
10938: } else {
10939: unless (($item =~ /\.meta$/) || ($item =~ /\.\d+\.\w+$/) || ($item =~ /\.rights$/)) {
10940: $filehashref->{&Apache::lonlocal::js_escape($relpath)}{$item} = 1;
10941: }
10942: }
10943: }
10944: }
10945: closedir($dirh);
10946: }
10947: } else {
10948: my ($dirlistref,$listerror) =
10949: &dirlist($toppath.$relpath);
10950: my @dir_lines;
10951: my $dirptr=16384;
10952: if (ref($dirlistref) eq 'ARRAY') {
10953: foreach my $dir_line (sort
10954: {
10955: my ($afile)=split('&',$a,2);
10956: my ($bfile)=split('&',$b,2);
10957: return (lc($afile) cmp lc($bfile));
10958: } (@{$dirlistref})) {
10959: my ($item,$dom,undef,$testdir,undef,undef,undef,undef,$size,undef,$mtime,undef,undef,undef,$obs,undef) =
10960: split(/\&/,$dir_line,16);
10961: $item =~ s/\s+$//;
10962: next if (($item =~ /^\.\.?$/) || ($obs));
10963: if ($dirptr&$testdir) {
10964: my $newpath;
10965: if ($relpath) {
10966: $newpath = "$relpath/$item";
10967: } else {
10968: $relpath = '/';
10969: $newpath = $item;
10970: }
10971: $dirhashref->{&Apache::lonlocal::js_escape($newpath)} = 1;
10972: &recursedirs($is_home,$context,$docroot,$toppath,$newpath,$dirhashref,$filehashref);
10973: } elsif ($savefile) {
10974: if ($context eq 'priv') {
10975: unless ($item =~ /\.(meta|save|log|bak|DS_Store)$/) {
10976: $filehashref->{$relpath}{$item} = 1;
10977: }
10978: } else {
10979: unless (($item =~ /\.meta$/) || ($item =~ /\.\d+\.\w+$/)) {
10980: $filehashref->{$relpath}{$item} = 1;
10981: }
10982: }
10983: }
10984: }
10985: }
10986: }
10987: return;
10988: }
10989:
10990: # -------------------------------------------------------- Value of a Condition
10991:
10992: # gets the value of a specific preevaluated condition
10993: # stored in the string $env{user.state.<cid>}
10994: # or looks up a condition reference in the bighash and if if hasn't
10995: # already been evaluated recurses into docondval to get the value of
10996: # the condition, then memoizing it to
10997: # $env{user.state.<cid>.<condition>}
10998: sub directcondval {
10999: my $number=shift;
11000: if (!defined($env{'user.state.'.$env{'request.course.id'}})) {
11001: &Apache::lonuserstate::evalstate();
11002: }
11003: if (exists($env{'user.state.'.$env{'request.course.id'}.".$number"})) {
11004: return $env{'user.state.'.$env{'request.course.id'}.".$number"};
11005: } elsif ($number =~ /^_/) {
11006: my $sub_condition;
11007: if (tie(my %bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
11008: &GDBM_READER(),0640)) {
11009: $sub_condition=$bighash{'conditions'.$number};
11010: untie(%bighash);
11011: }
11012: my $value = &docondval($sub_condition);
11013: &appenv({'user.state.'.$env{'request.course.id'}.".$number" => $value});
11014: return $value;
11015: }
11016: if ($env{'user.state.'.$env{'request.course.id'}}) {
11017: return substr($env{'user.state.'.$env{'request.course.id'}},$number,1);
11018: } else {
11019: return 2;
11020: }
11021: }
11022:
11023: # get the collection of conditions for this resource
11024: sub condval {
11025: my $condidx=shift;
11026: my $allpathcond='';
11027: foreach my $cond (split(/\|/,$condidx)) {
11028: if (defined($env{'acc.cond.'.$env{'request.course.id'}.'.'.$cond})) {
11029: $allpathcond.=
11030: '('.$env{'acc.cond.'.$env{'request.course.id'}.'.'.$cond}.')|';
11031: }
11032: }
11033: $allpathcond=~s/\|$//;
11034: return &docondval($allpathcond);
11035: }
11036:
11037: #evaluates an expression of conditions
11038: sub docondval {
11039: my ($allpathcond) = @_;
11040: my $result=0;
11041: if ($env{'request.course.id'}
11042: && defined($allpathcond)) {
11043: my $operand='|';
11044: my @stack;
11045: foreach my $chunk ($allpathcond=~/(\d+|_\d+\.\d+|\(|\)|\&|\|)/g) {
11046: if ($chunk eq '(') {
11047: push @stack,($operand,$result);
11048: } elsif ($chunk eq ')') {
11049: my $before=pop @stack;
11050: if (pop @stack eq '&') {
11051: $result=$result>$before?$before:$result;
11052: } else {
11053: $result=$result>$before?$result:$before;
11054: }
11055: } elsif (($chunk eq '&') || ($chunk eq '|')) {
11056: $operand=$chunk;
11057: } else {
11058: my $new=directcondval($chunk);
11059: if ($operand eq '&') {
11060: $result=$result>$new?$new:$result;
11061: } else {
11062: $result=$result>$new?$result:$new;
11063: }
11064: }
11065: }
11066: }
11067: return $result;
11068: }
11069:
11070: # ---------------------------------------------------- Devalidate courseresdata
11071:
11072: sub devalidatecourseresdata {
11073: my ($coursenum,$coursedomain)=@_;
11074: my $hashid=$coursenum.':'.$coursedomain;
11075: &devalidate_cache_new('courseres',$hashid);
11076: }
11077:
11078:
11079: # --------------------------------------------------- Course Resourcedata Query
11080: #
11081: # Parameters:
11082: # $coursenum - Number of the course.
11083: # $coursedomain - Domain at which the course was created.
11084: # Returns:
11085: # A hash of the course parameters along (I think) with timestamps
11086: # and version info.
11087:
11088: sub get_courseresdata {
11089: my ($coursenum,$coursedomain)=@_;
11090: my $coursehom=&homeserver($coursenum,$coursedomain);
11091: my $hashid=$coursenum.':'.$coursedomain;
11092: my ($result,$cached)=&is_cached_new('courseres',$hashid);
11093: my %dumpreply;
11094: unless (defined($cached)) {
11095: %dumpreply=&dump('resourcedata',$coursedomain,$coursenum);
11096: $result=\%dumpreply;
11097: my ($tmp) = keys(%dumpreply);
11098: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
11099: &do_cache_new('courseres',$hashid,$result,600);
11100: } elsif ($tmp =~ /^(con_lost|no_such_host)/) {
11101: return $tmp;
11102: } elsif ($tmp =~ /^(error)/) {
11103: $result=undef;
11104: &do_cache_new('courseres',$hashid,$result,600);
11105: }
11106: }
11107: return $result;
11108: }
11109:
11110: sub devalidateuserresdata {
11111: my ($uname,$udom)=@_;
11112: my $hashid="$udom:$uname";
11113: &devalidate_cache_new('userres',$hashid);
11114: }
11115:
11116: sub get_userresdata {
11117: my ($uname,$udom)=@_;
11118: #most student don\'t have any data set, check if there is some data
11119: if (&EXT_cache_status($udom,$uname)) { return undef; }
11120:
11121: my $hashid="$udom:$uname";
11122: my ($result,$cached)=&is_cached_new('userres',$hashid);
11123: if (!defined($cached)) {
11124: my %resourcedata=&dump('resourcedata',$udom,$uname);
11125: $result=\%resourcedata;
11126: &do_cache_new('userres',$hashid,$result,600);
11127: }
11128: my ($tmp)=keys(%$result);
11129: if (($tmp!~/^error\:/) && ($tmp!~/^con_lost/)) {
11130: return $result;
11131: }
11132: #error 2 occurs when the .db doesn't exist
11133: if ($tmp!~/error: 2 /) {
11134: if ((!defined($cached)) || ($tmp ne 'con_lost')) {
11135: &logthis("<font color=\"blue\">WARNING:".
11136: " Trying to get resource data for ".
11137: $uname." at ".$udom.": ".
11138: $tmp."</font>");
11139: }
11140: } elsif ($tmp=~/error: 2 /) {
11141: #&EXT_cache_set($udom,$uname);
11142: &do_cache_new('userres',$hashid,undef,600);
11143: undef($tmp); # not really an error so don't send it back
11144: }
11145: return $tmp;
11146: }
11147: #----------------------------------------------- resdata - return resource data
11148: # Purpose:
11149: # Return resource data for either users or for a course.
11150: # Parameters:
11151: # $name - Course/user name.
11152: # $domain - Name of the domain the user/course is registered on.
11153: # $type - Type of thing $name is (must be 'course' or 'user')
11154: # $mapp - decluttered URL of enclosing map
11155: # $recursed - Ref to scalar -- set to 1, if nested maps have been recursed.
11156: # $recurseup - Ref to array of map URLs, starting with map containing
11157: # $mapp up through hierarchy of nested maps to top level map.
11158: # $courseid - CourseID (first part of param identifier).
11159: # $modifier - Middle part of param identifier.
11160: # $what - Last part of param identifier.
11161: # @which - Array of names of resources desired.
11162: # Returns:
11163: # The value of the first reasource in @which that is found in the
11164: # resource hash.
11165: # Exceptional Conditions:
11166: # If the $type passed in is not valid (not the string 'course' or
11167: # 'user', an undefined reference is returned.
11168: # If none of the resources are found, an undef is returned
11169: sub resdata {
11170: my ($name,$domain,$type,$mapp,$recursed,$recurseup,$courseid,
11171: $modifier,$what,@which)=@_;
11172: my $result;
11173: if ($type eq 'course') {
11174: $result=&get_courseresdata($name,$domain);
11175: } elsif ($type eq 'user') {
11176: $result=&get_userresdata($name,$domain);
11177: }
11178: if (!ref($result)) { return $result; }
11179: foreach my $item (@which) {
11180: if ($item->[1] eq 'course') {
11181: if ((ref($recurseup) eq 'ARRAY') && (ref($recursed) eq 'SCALAR')) {
11182: unless ($$recursed) {
11183: @{$recurseup} = &get_map_hierarchy($mapp,$courseid);
11184: $$recursed = 1;
11185: }
11186: foreach my $item (@${recurseup}) {
11187: my $norecursechk=$courseid.$modifier.$item.'___(all).'.$what;
11188: last if (defined($result->{$norecursechk}));
11189: my $recursechk=$courseid.$modifier.$item.'___(rec).'.$what;
11190: if (defined($result->{$recursechk})) { return [$result->{$recursechk},'map']; }
11191: }
11192: }
11193: }
11194: if (defined($result->{$item->[0]})) {
11195: return [$result->{$item->[0]},$item->[1]];
11196: }
11197: }
11198: return undef;
11199: }
11200:
11201: sub get_domain_lti {
11202: my ($cdom,$context) = @_;
11203: my ($name,%lti);
11204: if ($context eq 'consumer') {
11205: $name = 'ltitools';
11206: } elsif ($context eq 'provider') {
11207: $name = 'lti';
11208: } else {
11209: return %lti;
11210: }
11211: my ($result,$cached)=&is_cached_new($name,$cdom);
11212: if (defined($cached)) {
11213: if (ref($result) eq 'HASH') {
11214: %lti = %{$result};
11215: }
11216: } else {
11217: my %domconfig = &get_dom('configuration',[$name],$cdom);
11218: if (ref($domconfig{$name}) eq 'HASH') {
11219: %lti = %{$domconfig{$name}};
11220: my %encdomconfig = &get_dom('encconfig',[$name],$cdom);
11221: if (ref($encdomconfig{$name}) eq 'HASH') {
11222: foreach my $id (keys(%lti)) {
11223: if (ref($encdomconfig{$name}{$id}) eq 'HASH') {
11224: foreach my $item ('key','secret') {
11225: $lti{$id}{$item} = $encdomconfig{$name}{$id}{$item};
11226: }
11227: }
11228: }
11229: }
11230: }
11231: my $cachetime = 24*60*60;
11232: &do_cache_new($name,$cdom,\%lti,$cachetime);
11233: }
11234: return %lti;
11235: }
11236:
11237: sub get_numsuppfiles {
11238: my ($cnum,$cdom,$ignorecache)=@_;
11239: my $hashid=$cnum.':'.$cdom;
11240: my ($suppcount,$cached);
11241: unless ($ignorecache) {
11242: ($suppcount,$cached) = &is_cached_new('suppcount',$hashid);
11243: }
11244: unless (defined($cached)) {
11245: my $chome=&homeserver($cnum,$cdom);
11246: unless ($chome eq 'no_host') {
11247: ($suppcount,my $supptools,my $errors) = (0,0,0);
11248: my $suppmap = 'supplemental.sequence';
11249: ($suppcount,$supptools,$errors) =
11250: &Apache::loncommon::recurse_supplemental($cnum,$cdom,$suppmap,$suppcount,
11251: $supptools,$errors);
11252: }
11253: &do_cache_new('suppcount',$hashid,$suppcount,600);
11254: }
11255: return $suppcount;
11256: }
11257:
11258: #
11259: # EXT resource caching routines
11260: #
11261:
11262: {
11263: # Cache (5 seconds) of map hierarchy for speedup of navmaps display
11264: #
11265: # The course for which we cache
11266: my $cachedmapkey='';
11267: # The cached recursive maps for this course
11268: my %cachedmaps=();
11269: # When this was last done
11270: my $cachedmaptime='';
11271:
11272: sub clear_EXT_cache_status {
11273: &delenv('cache.EXT.');
11274: }
11275:
11276: sub EXT_cache_status {
11277: my ($target_domain,$target_user) = @_;
11278: my $cachename = 'cache.EXT.'.$target_user.'.'.$target_domain;
11279: if (exists($env{$cachename}) && ($env{$cachename}+600) > time) {
11280: # We know already the user has no data
11281: return 1;
11282: } else {
11283: return 0;
11284: }
11285: }
11286:
11287: sub EXT_cache_set {
11288: my ($target_domain,$target_user) = @_;
11289: my $cachename = 'cache.EXT.'.$target_user.'.'.$target_domain;
11290: #&appenv({$cachename => time});
11291: }
11292:
11293: # --------------------------------------------------------- Value of a Variable
11294: sub EXT {
11295:
11296: my ($varname,$symbparm,$udom,$uname,$usection,$recurse,$cid)=@_;
11297: unless ($varname) { return ''; }
11298: #get real user name/domain, courseid and symb
11299: my $courseid;
11300: my $publicuser;
11301: if ($symbparm) {
11302: $symbparm=&get_symb_from_alias($symbparm);
11303: }
11304: if (!($uname && $udom)) {
11305: (my $cursymb,$courseid,$udom,$uname,$publicuser)= &whichuser($symbparm);
11306: if (!$symbparm) { $symbparm=$cursymb; }
11307: } else {
11308: $courseid=$env{'request.course.id'};
11309: }
11310: my ($realm,$space,$qualifier,@therest)=split(/\./,$varname);
11311: my $rest;
11312: if (defined($therest[0])) {
11313: $rest=join('.',@therest);
11314: } else {
11315: $rest='';
11316: }
11317:
11318: my $qualifierrest=$qualifier;
11319: if ($rest) { $qualifierrest.='.'.$rest; }
11320: my $spacequalifierrest=$space;
11321: if ($qualifierrest) { $spacequalifierrest.='.'.$qualifierrest; }
11322: if ($realm eq 'user') {
11323: # --------------------------------------------------------------- user.resource
11324: if ($space eq 'resource') {
11325: if ( (defined($Apache::lonhomework::parsing_a_problem)
11326: || defined($Apache::lonhomework::parsing_a_task))
11327: &&
11328: ($symbparm eq &symbread()) ) {
11329: # if we are in the middle of processing the resource the
11330: # get the value we are planning on committing
11331: if (defined($Apache::lonhomework::results{$qualifierrest})) {
11332: return $Apache::lonhomework::results{$qualifierrest};
11333: } else {
11334: return $Apache::lonhomework::history{$qualifierrest};
11335: }
11336: } else {
11337: my %restored;
11338: if ($publicuser || $env{'request.state'} eq 'construct') {
11339: %restored=&tmprestore($symbparm,$courseid,$udom,$uname);
11340: } else {
11341: %restored=&restore($symbparm,$courseid,$udom,$uname);
11342: }
11343: return $restored{$qualifierrest};
11344: }
11345: # ----------------------------------------------------------------- user.access
11346: } elsif ($space eq 'access') {
11347: # FIXME - not supporting calls for a specific user
11348: return &allowed($qualifier,$rest);
11349: # ------------------------------------------ user.preferences, user.environment
11350: } elsif (($space eq 'preferences') || ($space eq 'environment')) {
11351: if (($uname eq $env{'user.name'}) &&
11352: ($udom eq $env{'user.domain'})) {
11353: return $env{join('.',('environment',$qualifierrest))};
11354: } else {
11355: my %returnhash;
11356: if (!$publicuser) {
11357: %returnhash=&userenvironment($udom,$uname,
11358: $qualifierrest);
11359: }
11360: return $returnhash{$qualifierrest};
11361: }
11362: # ----------------------------------------------------------------- user.course
11363: } elsif ($space eq 'course') {
11364: # FIXME - not supporting calls for a specific user
11365: return $env{join('.',('request.course',$qualifier))};
11366: # ------------------------------------------------------------------- user.role
11367: } elsif ($space eq 'role') {
11368: # FIXME - not supporting calls for a specific user
11369: my ($role,$where)=split(/\./,$env{'request.role'});
11370: if ($qualifier eq 'value') {
11371: return $role;
11372: } elsif ($qualifier eq 'extent') {
11373: return $where;
11374: }
11375: # ----------------------------------------------------------------- user.domain
11376: } elsif ($space eq 'domain') {
11377: return $udom;
11378: # ------------------------------------------------------------------- user.name
11379: } elsif ($space eq 'name') {
11380: return $uname;
11381: # ---------------------------------------------------- Any other user namespace
11382: } else {
11383: my %reply;
11384: if (!$publicuser) {
11385: %reply=&get($space,[$qualifierrest],$udom,$uname);
11386: }
11387: return $reply{$qualifierrest};
11388: }
11389: } elsif ($realm eq 'query') {
11390: # ---------------------------------------------- pull stuff out of query string
11391: &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},
11392: [$spacequalifierrest]);
11393: return $env{'form.'.$spacequalifierrest};
11394: } elsif ($realm eq 'request') {
11395: # ------------------------------------------------------------- request.browser
11396: if ($space eq 'browser') {
11397: return $env{'browser.'.$qualifier};
11398: # ------------------------------------------------------------ request.filename
11399: } else {
11400: return $env{'request.'.$spacequalifierrest};
11401: }
11402: } elsif ($realm eq 'course') {
11403: # ---------------------------------------------------------- course.description
11404: return $env{'course.'.$courseid.'.'.$spacequalifierrest};
11405: } elsif ($realm eq 'resource') {
11406:
11407: if (defined($courseid) && $courseid eq $env{'request.course.id'}) {
11408: if (!$symbparm) { $symbparm=&symbread(); }
11409: }
11410:
11411: if ($qualifier eq '') {
11412: if ($space eq 'title') {
11413: if (!$symbparm) { $symbparm = $env{'request.filename'}; }
11414: return &gettitle($symbparm);
11415: }
11416:
11417: if ($space eq 'map') {
11418: my ($map) = &decode_symb($symbparm);
11419: return &symbread($map);
11420: }
11421: if ($space eq 'maptitle') {
11422: my ($map) = &decode_symb($symbparm);
11423: return &gettitle($map);
11424: }
11425: if ($space eq 'filename') {
11426: if ($symbparm) {
11427: return &clutter((&decode_symb($symbparm))[2]);
11428: }
11429: return &hreflocation('',$env{'request.filename'});
11430: }
11431:
11432: if ((defined($courseid)) && ($courseid eq $env{'request.course.id'}) && $symbparm) {
11433: if ($space eq 'visibleparts') {
11434: my $navmap = Apache::lonnavmaps::navmap->new();
11435: my $item;
11436: if (ref($navmap)) {
11437: my $res = $navmap->getBySymb($symbparm);
11438: my $parts = $res->parts();
11439: if (ref($parts) eq 'ARRAY') {
11440: $item = join(',',@{$parts});
11441: }
11442: undef($navmap);
11443: }
11444: return $item;
11445: }
11446: }
11447: }
11448:
11449: my ($section, $group, @groups, @recurseup, $recursed);
11450: my ($courselevelm,$courseleveli,$courselevel,$mapp);
11451: if (($courseid eq '') && ($cid)) {
11452: $courseid = $cid;
11453: }
11454: if (($symbparm && $courseid) &&
11455: (($courseid eq $env{'request.course.id'}) || ($courseid eq $cid))) {
11456:
11457: #print '<br>'.$space.' - '.$qualifier.' - '.$spacequalifierrest;
11458:
11459: # ----------------------------------------------------- Cascading lookup scheme
11460: my $symbp=$symbparm;
11461: $mapp=&deversion((&decode_symb($symbp))[0]);
11462: my $symbparm=$symbp.'.'.$spacequalifierrest;
11463: my $recurseparm=$mapp.'___(rec).'.$spacequalifierrest;
11464: my $mapparm=$mapp.'___(all).'.$spacequalifierrest;
11465: if (($env{'user.name'} eq $uname) &&
11466: ($env{'user.domain'} eq $udom)) {
11467: $section=$env{'request.course.sec'};
11468: @groups = split(/:/,$env{'request.course.groups'});
11469: @groups=&sort_course_groups($courseid,@groups);
11470: } else {
11471: if (! defined($usection)) {
11472: $section=&getsection($udom,$uname,$courseid);
11473: } else {
11474: $section = $usection;
11475: }
11476: @groups = &get_users_groups($udom,$uname,$courseid);
11477: }
11478:
11479: my $seclevel=$courseid.'.['.$section.'].'.$spacequalifierrest;
11480: my $seclevelr=$courseid.'.['.$section.'].'.$symbparm;
11481: my $secleveli=$courseid.'.['.$section.'].'.$recurseparm;
11482: my $seclevelm=$courseid.'.['.$section.'].'.$mapparm;
11483:
11484: $courselevel=$courseid.'.'.$spacequalifierrest;
11485: my $courselevelr=$courseid.'.'.$symbparm;
11486: $courseleveli=$courseid.'.'.$recurseparm;
11487: $courselevelm=$courseid.'.'.$mapparm;
11488:
11489: # ----------------------------------------------------------- first, check user
11490:
11491: my $userreply=&resdata($uname,$udom,'user',$mapp,\$recursed,
11492: \@recurseup,$courseid,'.',$spacequalifierrest,
11493: ([$courselevelr,'resource'],
11494: [$courselevelm,'map' ],
11495: [$courseleveli,'map' ],
11496: [$courselevel, 'course' ]));
11497: if (defined($userreply)) { return &get_reply($userreply); }
11498:
11499: # ------------------------------------------------ second, check some of course
11500: my $coursereply;
11501: if (@groups > 0) {
11502: $coursereply = &check_group_parms($courseid,\@groups,$symbparm,
11503: $recurseparm,$mapparm,$spacequalifierrest,
11504: $mapp,\$recursed,\@recurseup);
11505: if (defined($coursereply)) { return &get_reply($coursereply); }
11506: }
11507:
11508: $coursereply=&resdata($env{'course.'.$courseid.'.num'},
11509: $env{'course.'.$courseid.'.domain'},
11510: 'course',$mapp,\$recursed,\@recurseup,
11511: $courseid,'.['.$section.'].',$spacequalifierrest,
11512: ([$seclevelr, 'resource'],
11513: [$seclevelm, 'map' ],
11514: [$secleveli, 'map' ],
11515: [$seclevel, 'course' ],
11516: [$courselevelr,'resource']));
11517: if (defined($coursereply)) { return &get_reply($coursereply); }
11518:
11519: # ------------------------------------------------------ third, check map parms
11520: my %parmhash=();
11521: my $thisparm='';
11522: if (tie(%parmhash,'GDBM_File',
11523: $env{'request.course.fn'}.'_parms.db',
11524: &GDBM_READER(),0640)) {
11525: $thisparm=$parmhash{$symbparm};
11526: untie(%parmhash);
11527: }
11528: if ($thisparm) { return &get_reply([$thisparm,'resource']); }
11529: }
11530: # ------------------------------------------ fourth, look in resource metadata
11531:
11532: my $what = $spacequalifierrest;
11533: $what=~s/\./\_/;
11534: my $filename;
11535: if (!$symbparm) { $symbparm=&symbread(); }
11536: if ($symbparm) {
11537: $filename=(&decode_symb($symbparm))[2];
11538: } else {
11539: $filename=$env{'request.filename'};
11540: }
11541: my $toolsymb;
11542: if (($filename =~ /ext\.tool$/) && ($what ne '0_gradable')) {
11543: $toolsymb = $symbparm;
11544: }
11545: my $metadata=&metadata($filename,$what,$toolsymb);
11546: if (defined($metadata)) { return &get_reply([$metadata,'resource']); }
11547: $metadata=&metadata($filename,'parameter_'.$what,$toolsymb);
11548: if (defined($metadata)) { return &get_reply([$metadata,'resource']); }
11549:
11550: # ----------------------------------------------- fifth, look in rest of course
11551: if ($symbparm && defined($courseid) &&
11552: $courseid eq $env{'request.course.id'}) {
11553: my $coursereply=&resdata($env{'course.'.$courseid.'.num'},
11554: $env{'course.'.$courseid.'.domain'},
11555: 'course',$mapp,\$recursed,\@recurseup,
11556: $courseid,'.',$spacequalifierrest,
11557: ([$courselevelm,'map' ],
11558: [$courseleveli,'map' ],
11559: [$courselevel, 'course']));
11560: if (defined($coursereply)) { return &get_reply($coursereply); }
11561: }
11562: # ------------------------------------------------------------------ Cascade up
11563: unless ($space eq '0') {
11564: my @parts=split(/_/,$space);
11565: my $id=pop(@parts);
11566: my $part=join('_',@parts);
11567: if ($part eq '') { $part='0'; }
11568: my @partgeneral=&EXT('resource.'.$part.'.'.$qualifierrest,
11569: $symbparm,$udom,$uname,$section,1);
11570: if (defined($partgeneral[0])) { return &get_reply(\@partgeneral); }
11571: }
11572: if ($recurse) { return undef; }
11573: my $pack_def=&packages_tab_default($filename,$varname,$toolsymb);
11574: if (defined($pack_def)) { return &get_reply([$pack_def,'resource']); }
11575: # ---------------------------------------------------- Any other user namespace
11576: } elsif ($realm eq 'environment') {
11577: # ----------------------------------------------------------------- environment
11578: if (($uname eq $env{'user.name'})&&($udom eq $env{'user.domain'})) {
11579: return $env{'environment.'.$spacequalifierrest};
11580: } else {
11581: if ($uname eq 'anonymous' && $udom eq '') {
11582: return '';
11583: }
11584: my %returnhash=&userenvironment($udom,$uname,
11585: $spacequalifierrest);
11586: return $returnhash{$spacequalifierrest};
11587: }
11588: } elsif ($realm eq 'system') {
11589: # ----------------------------------------------------------------- system.time
11590: if ($space eq 'time') {
11591: return time;
11592: }
11593: } elsif ($realm eq 'server') {
11594: # ----------------------------------------------------------------- system.time
11595: if ($space eq 'name') {
11596: return $ENV{'SERVER_NAME'};
11597: }
11598: }
11599: return '';
11600: }
11601:
11602: sub get_reply {
11603: my ($reply_value) = @_;
11604: if (ref($reply_value) eq 'ARRAY') {
11605: if (wantarray) {
11606: return @$reply_value;
11607: }
11608: return $reply_value->[0];
11609: } else {
11610: return $reply_value;
11611: }
11612: }
11613:
11614: sub check_group_parms {
11615: my ($courseid,$groups,$symbparm,$recurseparm,$mapparm,$what,$mapp,
11616: $recursed,$recurseupref) = @_;
11617: my @levels = ([$symbparm,'resource'],[$mapparm,'map'],[$recurseparm,'map'],
11618: [$what,'course']);
11619: my $coursereply;
11620: foreach my $group (@{$groups}) {
11621: my @groupitems = ();
11622: foreach my $level (@levels) {
11623: my $item = $courseid.'.['.$group.'].'.$level->[0];
11624: push(@groupitems,[$item,$level->[1]]);
11625: }
11626: my $coursereply = &resdata($env{'course.'.$courseid.'.num'},
11627: $env{'course.'.$courseid.'.domain'},
11628: 'course',$mapp,$recursed,$recurseupref,
11629: $courseid,'.['.$group.'].',$what,
11630: @groupitems);
11631: last if (defined($coursereply));
11632: }
11633: return $coursereply;
11634: }
11635:
11636: sub get_map_hierarchy {
11637: my ($mapname,$courseid) = @_;
11638: my @recurseup = ();
11639: if ($mapname) {
11640: if (($cachedmapkey eq $courseid) &&
11641: (abs($cachedmaptime-time)<5)) {
11642: if (ref($cachedmaps{$mapname}) eq 'ARRAY') {
11643: return @{$cachedmaps{$mapname}};
11644: }
11645: }
11646: my $navmap = Apache::lonnavmaps::navmap->new();
11647: if (ref($navmap)) {
11648: @recurseup = $navmap->recurseup_maps($mapname);
11649: undef($navmap);
11650: $cachedmaps{$mapname} = \@recurseup;
11651: $cachedmaptime=time;
11652: $cachedmapkey=$courseid;
11653: }
11654: }
11655: return @recurseup;
11656: }
11657:
11658: }
11659:
11660: sub sort_course_groups { # Sort groups based on defined rankings. Default is sort().
11661: my ($courseid,@groups) = @_;
11662: @groups = sort(@groups);
11663: return @groups;
11664: }
11665:
11666: sub packages_tab_default {
11667: my ($uri,$varname,$toolsymb)=@_;
11668: my (undef,$part,$name)=split(/\./,$varname);
11669:
11670: my (@extension,@specifics,$do_default);
11671: foreach my $package (split(/,/,&metadata($uri,'packages',$toolsymb))) {
11672: my ($pack_type,$pack_part)=split(/_/,$package,2);
11673: if ($pack_type eq 'default') {
11674: $do_default=1;
11675: } elsif ($pack_type eq 'extension') {
11676: push(@extension,[$package,$pack_type,$pack_part]);
11677: } elsif ($pack_part eq $part || $pack_type eq 'part') {
11678: # only look at packages defaults for packages that this id is
11679: push(@specifics,[$package,$pack_type,$pack_part]);
11680: }
11681: }
11682: # first look for a package that matches the requested part id
11683: foreach my $package (@specifics) {
11684: my (undef,$pack_type,$pack_part)=@{$package};
11685: next if ($pack_part ne $part);
11686: if (defined($packagetab{"$pack_type&$name&default"})) {
11687: return $packagetab{"$pack_type&$name&default"};
11688: }
11689: }
11690: # look for any possible matching non extension_ package
11691: foreach my $package (@specifics) {
11692: my (undef,$pack_type,$pack_part)=@{$package};
11693: if (defined($packagetab{"$pack_type&$name&default"})) {
11694: return $packagetab{"$pack_type&$name&default"};
11695: }
11696: if ($pack_type eq 'part') { $pack_part='0'; }
11697: if (defined($packagetab{$pack_type."_".$pack_part."&$name&default"})) {
11698: return $packagetab{$pack_type."_".$pack_part."&$name&default"};
11699: }
11700: }
11701: # look for any posible extension_ match
11702: foreach my $package (@extension) {
11703: my ($package,$pack_type)=@{$package};
11704: if (defined($packagetab{"$pack_type&$name&default"})) {
11705: return $packagetab{"$pack_type&$name&default"};
11706: }
11707: if (defined($packagetab{$package."&$name&default"})) {
11708: return $packagetab{$package."&$name&default"};
11709: }
11710: }
11711: # look for a global default setting
11712: if ($do_default && defined($packagetab{"default&$name&default"})) {
11713: return $packagetab{"default&$name&default"};
11714: }
11715: return undef;
11716: }
11717:
11718: sub add_prefix_and_part {
11719: my ($prefix,$part)=@_;
11720: my $keyroot;
11721: if (defined($prefix) && $prefix !~ /^__/) {
11722: # prefix that has a part already
11723: $keyroot=$prefix;
11724: } elsif (defined($prefix)) {
11725: # prefix that is missing a part
11726: if (defined($part)) { $keyroot='_'.$part.substr($prefix,1); }
11727: } else {
11728: # no prefix at all
11729: if (defined($part)) { $keyroot='_'.$part; }
11730: }
11731: return $keyroot;
11732: }
11733:
11734: # ---------------------------------------------------------------- Get metadata
11735:
11736: my %metaentry;
11737: my %importedpartids;
11738: my %importedrespids;
11739: sub metadata {
11740: my ($uri,$what,$toolsymb,$liburi,$prefix,$depthcount)=@_;
11741: $uri=&declutter($uri);
11742: # if it is a non metadata possible uri return quickly
11743: if (($uri eq '') ||
11744: (($uri =~ m|^/*adm/|) &&
11745: ($uri !~ m|^adm/includes|) && ($uri !~ m{/(smppg|bulletinboard|ext\.tool)$})) ||
11746: ($uri =~ m|/$|) || ($uri =~ m|/.meta$|) || ($uri =~ m{^/*uploaded/.+\.sequence$})) {
11747: return undef;
11748: }
11749: if (($uri =~ /^priv/ || $uri=~m{^home/httpd/html/priv})
11750: && &Apache::lonxml::get_state('target') =~ /^(|meta)$/) {
11751: return undef;
11752: }
11753: my $filename=$uri;
11754: $uri=~s/\.meta$//;
11755: #
11756: # Is the metadata already cached?
11757: # Look at timestamp of caching
11758: # Everything is cached by the main uri, libraries are never directly cached
11759: #
11760: if (!defined($liburi)) {
11761: my ($result,$cached)=&is_cached_new('meta',$uri);
11762: if (defined($cached)) { return $result->{':'.$what}; }
11763: }
11764:
11765: #
11766: # If the uri is for an external tool the file from
11767: # which metadata should be retrieved depends on whether
11768: # the tool had been configured to be gradable (set in the Course
11769: # Editor or Resource Editor).
11770: #
11771: # If a valid symb has been included as the third arg in the call
11772: # to &metadata() that can be used to retrieve the value of
11773: # parameter_0_gradable set for the resource, and included in the
11774: # uploaded map containing the tool. The value is retrieved via
11775: # &EXT(), if a valid symb is available. Otherwise the value of
11776: # gradable in the exttool_$marker.db file for the tool instance
11777: # is retrieved via &get().
11778: #
11779: # When lonuserstate::traceroute() calls lonnet::EXT() for
11780: # hiddenresource and encrypturl (during course initialization)
11781: # the map-level parameter for resource.0.gradable included in the
11782: # uploaded map containing the tool will not yet have been stored
11783: # in the user_course_parms.db file for the user's session, so in
11784: # this case fall back to retrieving gradable status from the
11785: # exttool_$marker.db file.
11786: #
11787: # In order to avoid an infinite loop, &metadata() will return
11788: # before a call to &EXT(), if the uri is for an external tool
11789: # and the $what for which metadata is being requested is
11790: # parameter_0_gradable or 0_gradable.
11791: #
11792:
11793: if ($uri =~ /ext\.tool$/) {
11794: if (($what eq 'parameter_0_gradable') || ($what eq '0_gradable')) {
11795: return;
11796: } else {
11797: my ($checked,$use_passback);
11798: if ($toolsymb ne '') {
11799: (undef,undef,my $tooluri) = &decode_symb($toolsymb);
11800: if (($tooluri eq $uri) && (&EXT('resource.0.gradable',$toolsymb))) {
11801: $checked = 1;
11802: if (&EXT('resource.0.gradable',$toolsymb) =~ /^yes$/i) {
11803: $use_passback = 1;
11804: }
11805: }
11806: }
11807: unless ($checked) {
11808: my ($ignore,$cdom,$cnum,$marker) = split(m{/},$uri);
11809: $marker=~s/\D//g;
11810: if ($marker) {
11811: my %toolsettings=&get('exttool_'.$marker,['gradable'],$cdom,$cnum);
11812: $use_passback = $toolsettings{'gradable'};
11813: }
11814: }
11815: if ($use_passback) {
11816: $filename = '/home/httpd/html/res/lib/templates/LTIpassback.tool';
11817: } else {
11818: $filename = '/home/httpd/html/res/lib/templates/LTIstandard.tool';
11819: }
11820: }
11821: }
11822:
11823: {
11824: # Imported parts would go here
11825: my @origfiletagids=();
11826: my $importedparts=0;
11827:
11828: # Imported responseids would go here
11829: my $importedresponses=0;
11830: #
11831: # Is this a recursive call for a library?
11832: #
11833: # if (! exists($metacache{$uri})) {
11834: # $metacache{$uri}={};
11835: # }
11836: my $cachetime = 60*60;
11837: if ($liburi) {
11838: $liburi=&declutter($liburi);
11839: $filename=$liburi;
11840: } else {
11841: &devalidate_cache_new('meta',$uri);
11842: undef(%metaentry);
11843: }
11844: my %metathesekeys=();
11845: unless ($filename=~/\.meta$/) { $filename.='.meta'; }
11846: my $metastring;
11847: if ($uri =~ /^priv/ || $uri=~/home\/httpd\/html\/priv/) {
11848: my $which = &hreflocation('','/'.($liburi || $uri));
11849: $metastring =
11850: &Apache::lonnet::ssi_body($which,
11851: ('grade_target' => 'meta'));
11852: $cachetime = 1; # only want this cached in the child not long term
11853: } elsif (($uri !~ m -^(editupload)/-) &&
11854: ($uri !~ m{^/*uploaded/$match_domain/$match_courseid/docs/})) {
11855: my $file=&filelocation('',&clutter($filename));
11856: #push(@{$metaentry{$uri.'.file'}},$file);
11857: $metastring=&getfile($file);
11858: }
11859: my $parser=HTML::LCParser->new(\$metastring);
11860: my $token;
11861: undef %metathesekeys;
11862: while ($token=$parser->get_token) {
11863: if ($token->[0] eq 'S') {
11864: if (defined($token->[2]->{'package'})) {
11865: #
11866: # This is a package - get package info
11867: #
11868: my $package=$token->[2]->{'package'};
11869: my $keyroot=&add_prefix_and_part($prefix,$token->[2]->{'part'});
11870: if (defined($token->[2]->{'id'})) {
11871: $keyroot.='_'.$token->[2]->{'id'};
11872: }
11873: if ($metaentry{':packages'}) {
11874: $metaentry{':packages'}.=','.$package.$keyroot;
11875: } else {
11876: $metaentry{':packages'}=$package.$keyroot;
11877: }
11878: foreach my $pack_entry (keys(%packagetab)) {
11879: my $part=$keyroot;
11880: $part=~s/^\_//;
11881: if ($pack_entry=~/^\Q$package\E\&/ ||
11882: $pack_entry=~/^\Q$package\E_0\&/) {
11883: my ($pack,$name,$subp)=split(/\&/,$pack_entry);
11884: # ignore package.tab specified default values
11885: # here &package_tab_default() will fetch those
11886: if ($subp eq 'default') { next; }
11887: my $value=$packagetab{$pack_entry};
11888: my $unikey;
11889: if ($pack =~ /_0$/) {
11890: $unikey='parameter_0_'.$name;
11891: $part=0;
11892: } else {
11893: $unikey='parameter'.$keyroot.'_'.$name;
11894: }
11895: if ($subp eq 'display') {
11896: $value.=' [Part: '.$part.']';
11897: }
11898: $metaentry{':'.$unikey.'.part'}=$part;
11899: $metathesekeys{$unikey}=1;
11900: unless (defined($metaentry{':'.$unikey.'.'.$subp})) {
11901: $metaentry{':'.$unikey.'.'.$subp}=$value;
11902: }
11903: if (defined($metaentry{':'.$unikey.'.default'})) {
11904: $metaentry{':'.$unikey}=
11905: $metaentry{':'.$unikey.'.default'};
11906: }
11907: }
11908: }
11909: } else {
11910: #
11911: # This is not a package - some other kind of start tag
11912: #
11913: my $entry=$token->[1];
11914: my $unikey='';
11915:
11916: if ($entry eq 'import') {
11917: #
11918: # Importing a library here
11919: #
11920: my $location=$parser->get_text('/import');
11921: my $dir=$filename;
11922: $dir=~s|[^/]*$||;
11923: $location=&filelocation($dir,$location);
11924:
11925: my $importid=$token->[2]->{'id'};
11926: my $importmode=$token->[2]->{'importmode'};
11927: #
11928: # Check metadata for imported file to
11929: # see if it contained response items
11930: #
11931: my %currmetaentry = %metaentry;
11932: my $libresponseorder = &metadata($location,'responseorder');
11933: my $origfile;
11934: if ($libresponseorder ne '') {
11935: if ($#origfiletagids<0) {
11936: undef(%importedrespids);
11937: undef(%importedpartids);
11938: }
11939: @{$importedrespids{$importid}} = split(/\s*,\s*/,$libresponseorder);
11940: if (@{$importedrespids{$importid}} > 0) {
11941: $importedresponses = 1;
11942: # We need to get the original file and the imported file to get the response order correct
11943: # Load and inspect original file
11944: if ($#origfiletagids<0) {
11945: my $origfilelocation=$perlvar{'lonDocRoot'}.&clutter($uri);
11946: $origfile=&getfile($origfilelocation);
11947: @origfiletagids=($origfile=~/<((?:\w+)response|import|part)[^>]*id\s*=\s*[\"\']([^\"\']+)[\"\'][^>]*>/gs);
11948: }
11949: }
11950: }
11951: # Do not overwrite contents of %metaentry hash for resource itself with
11952: # hash populated for imported library file
11953: %metaentry = %currmetaentry;
11954: undef(%currmetaentry);
11955: if ($importmode eq 'problem') {
11956: # Import as problem/response
11957: $unikey=&add_prefix_and_part($prefix,$token->[2]->{'part'});
11958: } elsif ($importmode eq 'part') {
11959: # Import as part(s)
11960: $importedparts=1;
11961: # We need to get the original file and the imported file to get the part order correct
11962: # Good news: we do not need to worry about nested libraries, since parts cannot be nested
11963: # Load and inspect original file if we didn't do that already
11964: if ($#origfiletagids<0) {
11965: undef(%importedrespids);
11966: undef(%importedpartids);
11967: if ($origfile eq '') {
11968: my $origfilelocation=$perlvar{'lonDocRoot'}.&clutter($uri);
11969: $origfile=&getfile($origfilelocation);
11970: @origfiletagids=($origfile=~/<(part|import)[^>]*id\s*=\s*[\"\']([^\"\']+)[\"\'][^>]*>/gs);
11971: }
11972: }
11973:
11974: # Load and inspect imported file
11975: my $impfile=&getfile($location);
11976: my @impfilepartids=($impfile=~/<part[^>]*id\s*=\s*[\"\']([^\"\']+)[\"\'][^>]*>/gs);
11977: if ($#impfilepartids>=0) {
11978: # This problem had parts
11979: $importedpartids{$token->[2]->{'id'}}=join(',',@impfilepartids);
11980: } else {
11981: # Importing by turning a single problem into a problem part
11982: # It gets the import-tags ID as part-ID
11983: $unikey=&add_prefix_and_part($prefix,$token->[2]->{'id'});
11984: $importedpartids{$token->[2]->{'id'}}=$token->[2]->{'id'};
11985: }
11986: } else {
11987: # Normal import
11988: $unikey=&add_prefix_and_part($prefix,$token->[2]->{'part'});
11989: if (defined($token->[2]->{'id'})) {
11990: $unikey.='_'.$token->[2]->{'id'};
11991: }
11992: }
11993:
11994: if ($depthcount<20) {
11995: my $metadata =
11996: &metadata($uri,'keys',$toolsymb,$location,$unikey,
11997: $depthcount+1);
11998: foreach my $meta (split(',',$metadata)) {
11999: $metaentry{':'.$meta}=$metaentry{':'.$meta};
12000: $metathesekeys{$meta}=1;
12001: }
12002: }
12003: } else {
12004: #
12005: # Not importing, some other kind of non-package, non-library start tag
12006: #
12007: $unikey=$entry.&add_prefix_and_part($prefix,$token->[2]->{'part'});
12008: if (defined($token->[2]->{'id'})) {
12009: $unikey.='_'.$token->[2]->{'id'};
12010: }
12011: if (defined($token->[2]->{'name'})) {
12012: $unikey.='_'.$token->[2]->{'name'};
12013: }
12014: $metathesekeys{$unikey}=1;
12015: foreach my $param (@{$token->[3]}) {
12016: $metaentry{':'.$unikey.'.'.$param} =
12017: $token->[2]->{$param};
12018: }
12019: my $internaltext=&HTML::Entities::decode($parser->get_text('/'.$entry));
12020: my $default=$metaentry{':'.$unikey.'.default'};
12021: if ( $internaltext =~ /^\s*$/ && $default !~ /^\s*$/) {
12022: # only ws inside the tag, and not in default, so use default
12023: # as value
12024: $metaentry{':'.$unikey}=$default;
12025: } elsif ( $internaltext =~ /\S/ ) {
12026: # something interesting inside the tag
12027: $metaentry{':'.$unikey}=$internaltext;
12028: } else {
12029: # no interesting values, don't set a default
12030: }
12031: # end of not-a-package not-a-library import
12032: }
12033: # end of not-a-package start tag
12034: }
12035: # the next is the end of "start tag"
12036: }
12037: }
12038: my ($extension) = ($uri =~ /\.(\w+)$/);
12039: $extension = lc($extension);
12040: if ($extension eq 'htm') { $extension='html'; }
12041:
12042: foreach my $key (keys(%packagetab)) {
12043: #no specific packages #how's our extension
12044: if ($key!~/^extension_\Q$extension\E&/) { next; }
12045: &metadata_create_package_def($uri,$key,'extension_'.$extension,
12046: \%metathesekeys);
12047: }
12048:
12049: if (!exists($metaentry{':packages'})
12050: || $packagetab{"import_defaults&extension_$extension"}) {
12051: foreach my $key (keys(%packagetab)) {
12052: #no specific packages well let's get default then
12053: if ($key!~/^default&/) { next; }
12054: &metadata_create_package_def($uri,$key,'default',
12055: \%metathesekeys);
12056: }
12057: }
12058: # are there custom rights to evaluate
12059: if ($metaentry{':copyright'} eq 'custom') {
12060:
12061: #
12062: # Importing a rights file here
12063: #
12064: unless ($depthcount) {
12065: my $location=$metaentry{':customdistributionfile'};
12066: my $dir=$filename;
12067: $dir=~s|[^/]*$||;
12068: $location=&filelocation($dir,$location);
12069: my $rights_metadata =
12070: &metadata($uri,'keys',$toolsymb,$location,'_rights',
12071: $depthcount+1);
12072: foreach my $rights (split(',',$rights_metadata)) {
12073: #$metaentry{':'.$rights}=$metacache{$uri}->{':'.$rights};
12074: $metathesekeys{$rights}=1;
12075: }
12076: }
12077: }
12078: # uniqifiy package listing
12079: my %seen;
12080: my @uniq_packages =
12081: grep { ! $seen{$_} ++ } (split(',',$metaentry{':packages'}));
12082: $metaentry{':packages'} = join(',',@uniq_packages);
12083:
12084: if (($importedresponses) || ($importedparts)) {
12085: if ($importedparts) {
12086: # We had imported parts and need to rebuild partorder
12087: $metaentry{':partorder'}='';
12088: $metathesekeys{'partorder'}=1;
12089: }
12090: if ($importedresponses) {
12091: # We had imported responses and need to rebuil responseorder
12092: $metaentry{':responseorder'}='';
12093: $metathesekeys{'responseorder'}=1;
12094: }
12095: for (my $index=0;$index<$#origfiletagids;$index+=2) {
12096: my $origid = $origfiletagids[$index+1];
12097: if ($origfiletagids[$index] eq 'part') {
12098: # Original part, part of the problem
12099: if ($importedparts) {
12100: $metaentry{':partorder'}.=','.$origid;
12101: }
12102: } elsif ($origfiletagids[$index] eq 'import') {
12103: if ($importedparts) {
12104: # We have imported parts at this position
12105: $metaentry{':partorder'}.=','.$importedpartids{$origid};
12106: }
12107: if ($importedresponses) {
12108: # We have imported responses at this position
12109: if (ref($importedrespids{$origid}) eq 'ARRAY') {
12110: $metaentry{':responseorder'}.=','.join(',',map { $origid.'_'.$_ } @{$importedrespids{$origid}});
12111: }
12112: }
12113: } else {
12114: # Original response item, part of the problem
12115: if ($importedresponses) {
12116: $metaentry{':responseorder'}.=','.$origid;
12117: }
12118: }
12119: }
12120: if ($importedparts) {
12121: $metaentry{':partorder'}=~s/^\,//;
12122: }
12123: if ($importedresponses) {
12124: $metaentry{':responseorder'}=~s/^\,//;
12125: }
12126: }
12127:
12128: $metaentry{':keys'} = join(',',keys(%metathesekeys));
12129: &metadata_generate_part0(\%metathesekeys,\%metaentry,$uri);
12130: $metaentry{':allpossiblekeys'}=join(',',keys(%metathesekeys));
12131: unless ($liburi) {
12132: &do_cache_new('meta',$uri,\%metaentry,$cachetime);
12133: }
12134: # this is the end of "was not already recently cached
12135: }
12136: return $metaentry{':'.$what};
12137: }
12138:
12139: sub metadata_create_package_def {
12140: my ($uri,$key,$package,$metathesekeys)=@_;
12141: my ($pack,$name,$subp)=split(/\&/,$key);
12142: if ($subp eq 'default') { next; }
12143:
12144: if (defined($metaentry{':packages'})) {
12145: $metaentry{':packages'}.=','.$package;
12146: } else {
12147: $metaentry{':packages'}=$package;
12148: }
12149: my $value=$packagetab{$key};
12150: my $unikey;
12151: $unikey='parameter_0_'.$name;
12152: $metaentry{':'.$unikey.'.part'}=0;
12153: $$metathesekeys{$unikey}=1;
12154: unless (defined($metaentry{':'.$unikey.'.'.$subp})) {
12155: $metaentry{':'.$unikey.'.'.$subp}=$value;
12156: }
12157: if (defined($metaentry{':'.$unikey.'.default'})) {
12158: $metaentry{':'.$unikey}=
12159: $metaentry{':'.$unikey.'.default'};
12160: }
12161: }
12162:
12163: sub metadata_generate_part0 {
12164: my ($metadata,$metacache,$uri) = @_;
12165: my %allnames;
12166: foreach my $metakey (keys(%$metadata)) {
12167: if ($metakey=~/^parameter\_(.*)/) {
12168: my $part=$$metacache{':'.$metakey.'.part'};
12169: my $name=$$metacache{':'.$metakey.'.name'};
12170: if (! exists($$metadata{'parameter_0_'.$name.'.name'})) {
12171: $allnames{$name}=$part;
12172: }
12173: }
12174: }
12175: foreach my $name (keys(%allnames)) {
12176: $$metadata{"parameter_0_$name"}=1;
12177: my $key=":parameter_0_$name";
12178: $$metacache{"$key.part"}='0';
12179: $$metacache{"$key.name"}=$name;
12180: $$metacache{"$key.type"}=$$metacache{':parameter_'.
12181: $allnames{$name}.'_'.$name.
12182: '.type'};
12183: my $olddis=$$metacache{':parameter_'.$allnames{$name}.'_'.$name.
12184: '.display'};
12185: my $expr='[Part: '.$allnames{$name}.']';
12186: $olddis=~s/\Q$expr\E/\[Part: 0\]/;
12187: $$metacache{"$key.display"}=$olddis;
12188: }
12189: }
12190:
12191: # ------------------------------------------------------ Devalidate title cache
12192:
12193: sub devalidate_title_cache {
12194: my ($url)=@_;
12195: if (!$env{'request.course.id'}) { return; }
12196: my $symb=&symbread($url);
12197: if (!$symb) { return; }
12198: my $key=$env{'request.course.id'}."\0".$symb;
12199: &devalidate_cache_new('title',$key);
12200: }
12201:
12202: # ------------------------------------------------- Get the title of a course
12203:
12204: sub current_course_title {
12205: return $env{ 'course.' . $env{'request.course.id'} . '.description' };
12206: }
12207: # ------------------------------------------------- Get the title of a resource
12208:
12209: sub gettitle {
12210: my $urlsymb=shift;
12211: my $symb=&symbread($urlsymb);
12212: if ($symb) {
12213: my $key=$env{'request.course.id'}."\0".$symb;
12214: my ($result,$cached)=&is_cached_new('title',$key);
12215: if (defined($cached)) {
12216: return $result;
12217: }
12218: my ($map,$resid,$url)=&decode_symb($symb);
12219: my $title='';
12220: if (!$map && $resid == 0 && $url =~/default\.sequence$/) {
12221: $title = $env{'course.'.$env{'request.course.id'}.'.description'};
12222: } else {
12223: if (tie(my %bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
12224: &GDBM_READER(),0640)) {
12225: my $mapid=$bighash{'map_pc_'.&clutter($map)};
12226: $title=$bighash{'title_'.$mapid.'.'.$resid};
12227: untie(%bighash);
12228: }
12229: }
12230: $title=~s/\&colon\;/\:/gs;
12231: if ($title) {
12232: # Remember both $symb and $title for dynamic metadata
12233: $accesshash{$symb.'___crstitle'}=$title;
12234: $accesshash{&declutter($map).'___'.&declutter($url).'___usage'}=time;
12235: # Cache this title and then return it
12236: return &do_cache_new('title',$key,$title,600);
12237: }
12238: $urlsymb=$url;
12239: }
12240: my $title=&metadata($urlsymb,'title');
12241: if (!$title) { $title=(split('/',$urlsymb))[-1]; }
12242: return $title;
12243: }
12244:
12245: sub get_slot {
12246: my ($which,$cnum,$cdom)=@_;
12247: if (!$cnum || !$cdom) {
12248: (undef,my $courseid)=&whichuser();
12249: $cdom=$env{'course.'.$courseid.'.domain'};
12250: $cnum=$env{'course.'.$courseid.'.num'};
12251: }
12252: my $key=join("\0",'slots',$cdom,$cnum,$which);
12253: my %slotinfo;
12254: if (exists($remembered{$key})) {
12255: $slotinfo{$which} = $remembered{$key};
12256: } else {
12257: %slotinfo=&get('slots',[$which],$cdom,$cnum);
12258: &Apache::lonhomework::showhash(%slotinfo);
12259: my ($tmp)=keys(%slotinfo);
12260: if ($tmp=~/^error:/) { return (); }
12261: $remembered{$key} = $slotinfo{$which};
12262: }
12263: if (ref($slotinfo{$which}) eq 'HASH') {
12264: return %{$slotinfo{$which}};
12265: }
12266: return $slotinfo{$which};
12267: }
12268:
12269: sub get_reservable_slots {
12270: my ($cnum,$cdom,$uname,$udom) = @_;
12271: my $now = time;
12272: my $reservable_info;
12273: my $key=join("\0",'reservableslots',$cdom,$cnum,$uname,$udom);
12274: if (exists($remembered{$key})) {
12275: $reservable_info = $remembered{$key};
12276: } else {
12277: my %resv;
12278: ($resv{'now_order'},$resv{'now'},$resv{'future_order'},$resv{'future'}) =
12279: &Apache::loncommon::get_future_slots($cnum,$cdom,$now);
12280: $reservable_info = \%resv;
12281: $remembered{$key} = $reservable_info;
12282: }
12283: return $reservable_info;
12284: }
12285:
12286: sub get_course_slots {
12287: my ($cnum,$cdom) = @_;
12288: my $hashid=$cnum.':'.$cdom;
12289: my ($result,$cached) = &Apache::lonnet::is_cached_new('allslots',$hashid);
12290: if (defined($cached)) {
12291: if (ref($result) eq 'HASH') {
12292: return %{$result};
12293: }
12294: } else {
12295: my %slots=&Apache::lonnet::dump('slots',$cdom,$cnum);
12296: my ($tmp) = keys(%slots);
12297: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
12298: &do_cache_new('allslots',$hashid,\%slots,600);
12299: return %slots;
12300: }
12301: }
12302: return;
12303: }
12304:
12305: sub devalidate_slots_cache {
12306: my ($cnum,$cdom)=@_;
12307: my $hashid=$cnum.':'.$cdom;
12308: &devalidate_cache_new('allslots',$hashid);
12309: }
12310:
12311: sub get_coursechange {
12312: my ($cdom,$cnum) = @_;
12313: if ($cdom eq '' || $cnum eq '') {
12314: return unless ($env{'request.course.id'});
12315: $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
12316: $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
12317: }
12318: my $hashid=$cdom.'_'.$cnum;
12319: my ($change,$cached)=&is_cached_new('crschange',$hashid);
12320: if ((defined($cached)) && ($change ne '')) {
12321: return $change;
12322: } else {
12323: my %crshash;
12324: %crshash = &get('environment',['internal.contentchange'],$cdom,$cnum);
12325: if ($crshash{'internal.contentchange'} eq '') {
12326: $change = $env{'course.'.$cdom.'_'.$cnum.'.internal.created'};
12327: if ($change eq '') {
12328: %crshash = &get('environment',['internal.created'],$cdom,$cnum);
12329: $change = $crshash{'internal.created'};
12330: }
12331: } else {
12332: $change = $crshash{'internal.contentchange'};
12333: }
12334: my $cachetime = 600;
12335: &do_cache_new('crschange',$hashid,$change,$cachetime);
12336: }
12337: return $change;
12338: }
12339:
12340: sub devalidate_coursechange_cache {
12341: my ($cnum,$cdom)=@_;
12342: my $hashid=$cnum.':'.$cdom;
12343: &devalidate_cache_new('crschange',$hashid);
12344: }
12345:
12346: # ------------------------------------------------- Update symbolic store links
12347:
12348: sub symblist {
12349: my ($mapname,%newhash)=@_;
12350: $mapname=&deversion(&declutter($mapname));
12351: my %hash;
12352: if (($env{'request.course.fn'}) && (%newhash)) {
12353: if (tie(%hash,'GDBM_File',$env{'request.course.fn'}.'_symb.db',
12354: &GDBM_WRCREAT(),0640)) {
12355: foreach my $url (keys(%newhash)) {
12356: next if ($url eq 'last_known'
12357: && $env{'form.no_update_last_known'});
12358: $hash{declutter($url)}=&encode_symb($mapname,
12359: $newhash{$url}->[1],
12360: $newhash{$url}->[0]);
12361: }
12362: if (untie(%hash)) {
12363: return 'ok';
12364: }
12365: }
12366: }
12367: return 'error';
12368: }
12369:
12370: # --------------------------------------------------------------- Verify a symb
12371:
12372: sub symbverify {
12373: my ($symb,$thisurl,$encstate)=@_;
12374: my $thisfn=$thisurl;
12375: $thisfn=&declutter($thisfn);
12376: # direct jump to resource in page or to a sequence - will construct own symbs
12377: if ($thisfn=~/\.(page|sequence)$/) { return 1; }
12378: # check URL part
12379: my ($map,$resid,$url)=&decode_symb($symb);
12380:
12381: unless ($url eq $thisfn) { return 0; }
12382:
12383: $symb=&symbclean($symb);
12384: $thisurl=&deversion($thisurl);
12385: $thisfn=&deversion($thisfn);
12386:
12387: my %bighash;
12388: my $okay=0;
12389:
12390: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
12391: &GDBM_READER(),0640)) {
12392: my $noclutter;
12393: if (($thisurl =~ m{^/adm/wrapper/ext/}) || ($thisurl =~ m{^ext/})) {
12394: $thisurl =~ s/\?.+$//;
12395: if ($map =~ m{^uploaded/.+\.page$}) {
12396: $thisurl =~ s{^(/adm/wrapper|)/ext/}{http://};
12397: $thisurl =~ s{^\Qhttp://https://\E}{https://};
12398: $noclutter = 1;
12399: }
12400: }
12401: my $ids;
12402: if ($noclutter) {
12403: $ids=$bighash{'ids_'.$thisurl};
12404: } else {
12405: $ids=$bighash{'ids_'.&clutter($thisurl)};
12406: }
12407: unless ($ids) {
12408: my $idkey = 'ids_'.($thisurl =~ m{^/}? '' : '/').$thisurl;
12409: $ids=$bighash{$idkey};
12410: }
12411: if ($ids) {
12412: # ------------------------------------------------------------------- Has ID(s)
12413: if ($thisfn =~ m{^/adm/wrapper/ext/}) {
12414: $symb =~ s/\?.+$//;
12415: }
12416: foreach my $id (split(/\,/,$ids)) {
12417: my ($mapid,$resid)=split(/\./,$id);
12418: if (
12419: &symbclean(&declutter($bighash{'map_id_'.$mapid}).'___'.$resid.'___'.$thisfn)
12420: eq $symb) {
12421: if (ref($encstate)) {
12422: $$encstate = $bighash{'encrypted_'.$id};
12423: }
12424: if (($env{'request.role.adv'}) ||
12425: ($bighash{'encrypted_'.$id} eq $env{'request.enc'}) ||
12426: ($thisurl eq '/adm/navmaps')) {
12427: $okay=1;
12428: last;
12429: }
12430: }
12431: }
12432: }
12433: untie(%bighash);
12434: }
12435: return $okay;
12436: }
12437:
12438: # --------------------------------------------------------------- Clean-up symb
12439:
12440: sub symbclean {
12441: my $symb=shift;
12442: if ($symb=~m|^/enc/|) { $symb=&Apache::lonenc::unencrypted($symb); }
12443: # remove version from map
12444: $symb=~s/\.(\d+)\.(\w+)\_\_\_/\.$2\_\_\_/;
12445:
12446: # remove version from URL
12447: $symb=~s/\.(\d+)\.(\w+)$/\.$2/;
12448:
12449: # remove wrapper
12450:
12451: $symb=~s/(\_\_\_\d+\_\_\_)adm\/wrapper\/(res\/)*/$1/;
12452: $symb=~s/(\_\_\_\d+\_\_\_)adm\/coursedocs\/showdoc\/(res\/)*/$1/;
12453: return $symb;
12454: }
12455:
12456: # ---------------------------------------------- Split symb to find map and url
12457:
12458: sub encode_symb {
12459: my ($map,$resid,$url)=@_;
12460: return &symbclean(&declutter($map).'___'.$resid.'___'.&declutter($url));
12461: }
12462:
12463: sub decode_symb {
12464: my $symb=shift;
12465: if ($symb=~m|^/enc/|) { $symb=&Apache::lonenc::unencrypted($symb); }
12466: my ($map,$resid,$url)=split(/___/,$symb);
12467: return (&fixversion($map),$resid,&fixversion($url));
12468: }
12469:
12470: sub fixversion {
12471: my $fn=shift;
12472: if ($fn=~/^(adm|uploaded|editupload|public)/) { return $fn; }
12473: my %bighash;
12474: my $uri=&clutter($fn);
12475: my $key=$env{'request.course.id'}.'_'.$uri;
12476: # is this cached?
12477: my ($result,$cached)=&is_cached_new('courseresversion',$key);
12478: if (defined($cached)) { return $result; }
12479: # unfortunately not cached, or expired
12480: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
12481: &GDBM_READER(),0640)) {
12482: if ($bighash{'version_'.$uri}) {
12483: my $version=$bighash{'version_'.$uri};
12484: unless (($version eq 'mostrecent') ||
12485: ($version==&getversion($uri))) {
12486: $uri=~s/\.(\w+)$/\.$version\.$1/;
12487: }
12488: }
12489: untie %bighash;
12490: }
12491: return &do_cache_new('courseresversion',$key,&declutter($uri),600);
12492: }
12493:
12494: sub deversion {
12495: my $url=shift;
12496: $url=~s/\.\d+\.(\w+)$/\.$1/;
12497: return $url;
12498: }
12499:
12500: # ------------------------------------------------------ Return symb list entry
12501:
12502: sub symbread {
12503: my ($thisfn,$donotrecurse,$ignorecachednull,$checkforblock,$possibles)=@_;
12504: my $cache_str='request.symbread.cached.'.$thisfn;
12505: if (defined($env{$cache_str})) {
12506: if ($ignorecachednull) {
12507: return $env{$cache_str} unless ($env{$cache_str} eq '');
12508: } else {
12509: return $env{$cache_str};
12510: }
12511: }
12512: # no filename provided? try from environment
12513: unless ($thisfn) {
12514: if ($env{'request.symb'}) {
12515: return $env{$cache_str}=&symbclean($env{'request.symb'});
12516: }
12517: $thisfn=$env{'request.filename'};
12518: }
12519: if ($thisfn=~m|^/enc/|) { $thisfn=&Apache::lonenc::unencrypted($thisfn); }
12520: # is that filename actually a symb? Verify, clean, and return
12521: if ($thisfn=~/\_\_\_\d+\_\_\_(.*)$/) {
12522: if (&symbverify($thisfn,$1)) {
12523: return $env{$cache_str}=&symbclean($thisfn);
12524: }
12525: }
12526: $thisfn=declutter($thisfn);
12527: my %hash;
12528: my %bighash;
12529: my $syval='';
12530: if (($env{'request.course.fn'}) && ($thisfn)) {
12531: my $targetfn = $thisfn;
12532: if ( ($thisfn =~ m/^(uploaded|editupload)\//) && ($thisfn !~ m/\.(page|sequence)$/) ) {
12533: $targetfn = 'adm/wrapper/'.$thisfn;
12534: }
12535: if ($targetfn =~ m|^adm/wrapper/(ext/.*)|) {
12536: $targetfn=$1;
12537: }
12538: if (tie(%hash,'GDBM_File',$env{'request.course.fn'}.'_symb.db',
12539: &GDBM_READER(),0640)) {
12540: $syval=$hash{$targetfn};
12541: untie(%hash);
12542: }
12543: # ---------------------------------------------------------- There was an entry
12544: if ($syval) {
12545: #unless ($syval=~/\_\d+$/) {
12546: #unless ($env{'form.request.prefix'}=~/\.(\d+)\_$/) {
12547: #&appenv({'request.ambiguous' => $thisfn});
12548: #return $env{$cache_str}='';
12549: #}
12550: #$syval.=$1;
12551: #}
12552: } else {
12553: # ------------------------------------------------------- Was not in symb table
12554: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
12555: &GDBM_READER(),0640)) {
12556: # ---------------------------------------------- Get ID(s) for current resource
12557: my $ids=$bighash{'ids_'.&clutter($thisfn)};
12558: unless ($ids) {
12559: $ids=$bighash{'ids_/'.$thisfn};
12560: }
12561: unless ($ids) {
12562: # alias?
12563: $ids=$bighash{'mapalias_'.$thisfn};
12564: }
12565: if ($ids) {
12566: # ------------------------------------------------------------------- Has ID(s)
12567: my @possibilities=split(/\,/,$ids);
12568: if ($#possibilities==0) {
12569: # ----------------------------------------------- There is only one possibility
12570: my ($mapid,$resid)=split(/\./,$ids);
12571: $syval=&encode_symb($bighash{'map_id_'.$mapid},
12572: $resid,$thisfn);
12573: if (ref($possibles) eq 'HASH') {
12574: $possibles->{$syval} = 1;
12575: }
12576: if ($checkforblock) {
12577: my @blockers = &has_comm_blocking('bre',$syval,$bighash{'src_'.$ids});
12578: if (@blockers) {
12579: $syval = '';
12580: return;
12581: }
12582: }
12583: } elsif ((!$donotrecurse) || ($checkforblock) || (ref($possibles) eq 'HASH')) {
12584: # ------------------------------------------ There is more than one possibility
12585: my $realpossible=0;
12586: foreach my $id (@possibilities) {
12587: my $file=$bighash{'src_'.$id};
12588: my $canaccess;
12589: if (($donotrecurse) || ($checkforblock) || (ref($possibles) eq 'HASH')) {
12590: $canaccess = 1;
12591: } else {
12592: $canaccess = &allowed('bre',$file);
12593: }
12594: if ($canaccess) {
12595: my ($mapid,$resid)=split(/\./,$id);
12596: if ($bighash{'map_type_'.$mapid} ne 'page') {
12597: my $poss_syval=&encode_symb($bighash{'map_id_'.$mapid},
12598: $resid,$thisfn);
12599: if (ref($possibles) eq 'HASH') {
12600: $possibles->{$syval} = 1;
12601: }
12602: if ($checkforblock) {
12603: my @blockers = &has_comm_blocking('bre',$poss_syval,$file);
12604: unless (@blockers > 0) {
12605: $syval = $poss_syval;
12606: $realpossible++;
12607: }
12608: } else {
12609: $syval = $poss_syval;
12610: $realpossible++;
12611: }
12612: }
12613: }
12614: }
12615: if ($realpossible!=1) { $syval=''; }
12616: } else {
12617: $syval='';
12618: }
12619: }
12620: untie(%bighash);
12621: }
12622: }
12623: if ($syval) {
12624: return $env{$cache_str}=$syval;
12625: }
12626: }
12627: &appenv({'request.ambiguous' => $thisfn});
12628: return $env{$cache_str}='';
12629: }
12630:
12631: # ---------------------------------------------------------- Return random seed
12632:
12633: sub numval {
12634: my $txt=shift;
12635: $txt=~tr/A-J/0-9/;
12636: $txt=~tr/a-j/0-9/;
12637: $txt=~tr/K-T/0-9/;
12638: $txt=~tr/k-t/0-9/;
12639: $txt=~tr/U-Z/0-5/;
12640: $txt=~tr/u-z/0-5/;
12641: $txt=~s/\D//g;
12642: if ($_64bit) { if ($txt > 2**32) { return -1; } }
12643: return int($txt);
12644: }
12645:
12646: sub numval2 {
12647: my $txt=shift;
12648: $txt=~tr/A-J/0-9/;
12649: $txt=~tr/a-j/0-9/;
12650: $txt=~tr/K-T/0-9/;
12651: $txt=~tr/k-t/0-9/;
12652: $txt=~tr/U-Z/0-5/;
12653: $txt=~tr/u-z/0-5/;
12654: $txt=~s/\D//g;
12655: my @txts=split(/(\d\d\d\d\d\d\d\d\d)/,$txt);
12656: my $total;
12657: foreach my $val (@txts) { $total+=$val; }
12658: if ($_64bit) { if ($total > 2**32) { return -1; } }
12659: return int($total);
12660: }
12661:
12662: sub numval3 {
12663: use integer;
12664: my $txt=shift;
12665: $txt=~tr/A-J/0-9/;
12666: $txt=~tr/a-j/0-9/;
12667: $txt=~tr/K-T/0-9/;
12668: $txt=~tr/k-t/0-9/;
12669: $txt=~tr/U-Z/0-5/;
12670: $txt=~tr/u-z/0-5/;
12671: $txt=~s/\D//g;
12672: my @txts=split(/(\d\d\d\d\d\d\d\d\d)/,$txt);
12673: my $total;
12674: foreach my $val (@txts) { $total+=$val; }
12675: if ($_64bit) { $total=(($total<<32)>>32); }
12676: return $total;
12677: }
12678:
12679: sub digest {
12680: my ($data)=@_;
12681: my $digest=&Digest::MD5::md5($data);
12682: my ($a,$b,$c,$d)=unpack("iiii",$digest);
12683: my ($e,$f);
12684: {
12685: use integer;
12686: $e=($a+$b);
12687: $f=($c+$d);
12688: if ($_64bit) {
12689: $e=(($e<<32)>>32);
12690: $f=(($f<<32)>>32);
12691: }
12692: }
12693: if (wantarray) {
12694: return ($e,$f);
12695: } else {
12696: my $g;
12697: {
12698: use integer;
12699: $g=($e+$f);
12700: if ($_64bit) {
12701: $g=(($g<<32)>>32);
12702: }
12703: }
12704: return $g;
12705: }
12706: }
12707:
12708: sub latest_rnd_algorithm_id {
12709: return '64bit5';
12710: }
12711:
12712: sub get_rand_alg {
12713: my ($courseid)=@_;
12714: if (!$courseid) { $courseid=(&whichuser())[1]; }
12715: if ($courseid) {
12716: return $env{"course.$courseid.rndseed"};
12717: }
12718: return &latest_rnd_algorithm_id();
12719: }
12720:
12721: sub validCODE {
12722: my ($CODE)=@_;
12723: if (defined($CODE) && $CODE ne '' && $CODE =~ /^\w+$/) { return 1; }
12724: return 0;
12725: }
12726:
12727: sub getCODE {
12728: if (&validCODE($env{'form.CODE'})) { return $env{'form.CODE'}; }
12729: if ( (defined($Apache::lonhomework::parsing_a_problem) ||
12730: defined($Apache::lonhomework::parsing_a_task) ) &&
12731: &validCODE($Apache::lonhomework::history{'resource.CODE'})) {
12732: return $Apache::lonhomework::history{'resource.CODE'};
12733: }
12734: return undef;
12735: }
12736: #
12737: # Determines the random seed for a specific context:
12738: #
12739: # parameters:
12740: # symb - in course context the symb for the seed.
12741: # course_id - The course id of the form domain_coursenum.
12742: # domain - Domain for the user.
12743: # course - Course for the user.
12744: # cenv - environment of the course.
12745: #
12746: # NOTE:
12747: # All parameters are picked out of the environment if missing
12748: # or not defined.
12749: # If a symb cannot be determined the current time is used instead.
12750: #
12751: # For a given well defined symb, courside, domain, username,
12752: # and course environment, the seed is reproducible.
12753: #
12754: sub rndseed {
12755: my ($symb,$courseid,$domain,$username, $cenv)=@_;
12756: my ($wsymb,$wcourseid,$wdomain,$wusername)=&whichuser();
12757: if (!defined($symb)) {
12758: unless ($symb=$wsymb) { return time; }
12759: }
12760: if (!defined $courseid) {
12761: $courseid=$wcourseid;
12762: }
12763: if (!defined $domain) { $domain=$wdomain; }
12764: if (!defined $username) { $username=$wusername }
12765:
12766: my $which;
12767: if (defined($cenv->{'rndseed'})) {
12768: $which = $cenv->{'rndseed'};
12769: } else {
12770: $which =&get_rand_alg($courseid);
12771: }
12772: if (defined(&getCODE())) {
12773:
12774: if ($which eq '64bit5') {
12775: return &rndseed_CODE_64bit5($symb,$courseid,$domain,$username);
12776: } elsif ($which eq '64bit4') {
12777: return &rndseed_CODE_64bit4($symb,$courseid,$domain,$username);
12778: } else {
12779: return &rndseed_CODE_64bit($symb,$courseid,$domain,$username);
12780: }
12781: } elsif ($which eq '64bit5') {
12782: return &rndseed_64bit5($symb,$courseid,$domain,$username);
12783: } elsif ($which eq '64bit4') {
12784: return &rndseed_64bit4($symb,$courseid,$domain,$username);
12785: } elsif ($which eq '64bit3') {
12786: return &rndseed_64bit3($symb,$courseid,$domain,$username);
12787: } elsif ($which eq '64bit2') {
12788: return &rndseed_64bit2($symb,$courseid,$domain,$username);
12789: } elsif ($which eq '64bit') {
12790: return &rndseed_64bit($symb,$courseid,$domain,$username);
12791: }
12792: return &rndseed_32bit($symb,$courseid,$domain,$username);
12793: }
12794:
12795: sub rndseed_32bit {
12796: my ($symb,$courseid,$domain,$username)=@_;
12797: {
12798: use integer;
12799: my $symbchck=unpack("%32C*",$symb) << 27;
12800: my $symbseed=numval($symb) << 22;
12801: my $namechck=unpack("%32C*",$username) << 17;
12802: my $nameseed=numval($username) << 12;
12803: my $domainseed=unpack("%32C*",$domain) << 7;
12804: my $courseseed=unpack("%32C*",$courseid);
12805: my $num=$symbseed+$nameseed+$domainseed+$courseseed+$namechck+$symbchck;
12806: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
12807: #&logthis("rndseed :$num:$symb");
12808: if ($_64bit) { $num=(($num<<32)>>32); }
12809: return $num;
12810: }
12811: }
12812:
12813: sub rndseed_64bit {
12814: my ($symb,$courseid,$domain,$username)=@_;
12815: {
12816: use integer;
12817: my $symbchck=unpack("%32S*",$symb) << 21;
12818: my $symbseed=numval($symb) << 10;
12819: my $namechck=unpack("%32S*",$username);
12820:
12821: my $nameseed=numval($username) << 21;
12822: my $domainseed=unpack("%32S*",$domain) << 10;
12823: my $courseseed=unpack("%32S*",$courseid);
12824:
12825: my $num1=$symbchck+$symbseed+$namechck;
12826: my $num2=$nameseed+$domainseed+$courseseed;
12827: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
12828: #&logthis("rndseed :$num:$symb");
12829: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
12830: return "$num1,$num2";
12831: }
12832: }
12833:
12834: sub rndseed_64bit2 {
12835: my ($symb,$courseid,$domain,$username)=@_;
12836: {
12837: use integer;
12838: # strings need to be an even # of cahracters long, it it is odd the
12839: # last characters gets thrown away
12840: my $symbchck=unpack("%32S*",$symb.' ') << 21;
12841: my $symbseed=numval($symb) << 10;
12842: my $namechck=unpack("%32S*",$username.' ');
12843:
12844: my $nameseed=numval($username) << 21;
12845: my $domainseed=unpack("%32S*",$domain.' ') << 10;
12846: my $courseseed=unpack("%32S*",$courseid.' ');
12847:
12848: my $num1=$symbchck+$symbseed+$namechck;
12849: my $num2=$nameseed+$domainseed+$courseseed;
12850: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
12851: #&logthis("rndseed :$num:$symb");
12852: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
12853: return "$num1,$num2";
12854: }
12855: }
12856:
12857: sub rndseed_64bit3 {
12858: my ($symb,$courseid,$domain,$username)=@_;
12859: {
12860: use integer;
12861: # strings need to be an even # of cahracters long, it it is odd the
12862: # last characters gets thrown away
12863: my $symbchck=unpack("%32S*",$symb.' ') << 21;
12864: my $symbseed=numval2($symb) << 10;
12865: my $namechck=unpack("%32S*",$username.' ');
12866:
12867: my $nameseed=numval2($username) << 21;
12868: my $domainseed=unpack("%32S*",$domain.' ') << 10;
12869: my $courseseed=unpack("%32S*",$courseid.' ');
12870:
12871: my $num1=$symbchck+$symbseed+$namechck;
12872: my $num2=$nameseed+$domainseed+$courseseed;
12873: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
12874: #&logthis("rndseed :$num1:$num2:$_64bit");
12875: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
12876:
12877: return "$num1:$num2";
12878: }
12879: }
12880:
12881: sub rndseed_64bit4 {
12882: my ($symb,$courseid,$domain,$username)=@_;
12883: {
12884: use integer;
12885: # strings need to be an even # of cahracters long, it it is odd the
12886: # last characters gets thrown away
12887: my $symbchck=unpack("%32S*",$symb.' ') << 21;
12888: my $symbseed=numval3($symb) << 10;
12889: my $namechck=unpack("%32S*",$username.' ');
12890:
12891: my $nameseed=numval3($username) << 21;
12892: my $domainseed=unpack("%32S*",$domain.' ') << 10;
12893: my $courseseed=unpack("%32S*",$courseid.' ');
12894:
12895: my $num1=$symbchck+$symbseed+$namechck;
12896: my $num2=$nameseed+$domainseed+$courseseed;
12897: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
12898: #&logthis("rndseed :$num1:$num2:$_64bit");
12899: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
12900:
12901: return "$num1:$num2";
12902: }
12903: }
12904:
12905: sub rndseed_64bit5 {
12906: my ($symb,$courseid,$domain,$username)=@_;
12907: my ($num1,$num2)=&digest("$symb,$courseid,$domain,$username");
12908: return "$num1:$num2";
12909: }
12910:
12911: sub rndseed_CODE_64bit {
12912: my ($symb,$courseid,$domain,$username)=@_;
12913: {
12914: use integer;
12915: my $symbchck=unpack("%32S*",$symb.' ') << 16;
12916: my $symbseed=numval2($symb);
12917: my $CODEchck=unpack("%32S*",&getCODE().' ') << 16;
12918: my $CODEseed=numval(&getCODE());
12919: my $courseseed=unpack("%32S*",$courseid.' ');
12920: my $num1=$symbseed+$CODEchck;
12921: my $num2=$CODEseed+$courseseed+$symbchck;
12922: #&logthis("$symbseed:$CODEchck|$CODEseed:$courseseed:$symbchck");
12923: #&logthis("rndseed :$num1:$num2:$symb");
12924: if ($_64bit) { $num1=(($num1<<32)>>32); }
12925: if ($_64bit) { $num2=(($num2<<32)>>32); }
12926: return "$num1:$num2";
12927: }
12928: }
12929:
12930: sub rndseed_CODE_64bit4 {
12931: my ($symb,$courseid,$domain,$username)=@_;
12932: {
12933: use integer;
12934: my $symbchck=unpack("%32S*",$symb.' ') << 16;
12935: my $symbseed=numval3($symb);
12936: my $CODEchck=unpack("%32S*",&getCODE().' ') << 16;
12937: my $CODEseed=numval3(&getCODE());
12938: my $courseseed=unpack("%32S*",$courseid.' ');
12939: my $num1=$symbseed+$CODEchck;
12940: my $num2=$CODEseed+$courseseed+$symbchck;
12941: #&logthis("$symbseed:$CODEchck|$CODEseed:$courseseed:$symbchck");
12942: #&logthis("rndseed :$num1:$num2:$symb");
12943: if ($_64bit) { $num1=(($num1<<32)>>32); }
12944: if ($_64bit) { $num2=(($num2<<32)>>32); }
12945: return "$num1:$num2";
12946: }
12947: }
12948:
12949: sub rndseed_CODE_64bit5 {
12950: my ($symb,$courseid,$domain,$username)=@_;
12951: my $code = &getCODE();
12952: my ($num1,$num2)=&digest("$symb,$courseid,$code");
12953: return "$num1:$num2";
12954: }
12955:
12956: sub setup_random_from_rndseed {
12957: my ($rndseed)=@_;
12958: if ($rndseed =~/([,:])/) {
12959: my ($num1,$num2) = map { abs($_); } (split(/[,:]/,$rndseed));
12960: if ((!$num1) || (!$num2) || ($num1 > 2147483562) || ($num2 > 2147483398)) {
12961: &Math::Random::random_set_seed_from_phrase($rndseed);
12962: } else {
12963: &Math::Random::random_set_seed($num1,$num2);
12964: }
12965: } else {
12966: &Math::Random::random_set_seed_from_phrase($rndseed);
12967: }
12968: }
12969:
12970: sub latest_receipt_algorithm_id {
12971: return 'receipt3';
12972: }
12973:
12974: sub recunique {
12975: my $fucourseid=shift;
12976: my $unique;
12977: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2' ||
12978: $env{"course.$fucourseid.receiptalg"} eq 'receipt3' ) {
12979: $unique=$env{"course.$fucourseid.internal.encseed"};
12980: } else {
12981: $unique=$perlvar{'lonReceipt'};
12982: }
12983: return unpack("%32C*",$unique);
12984: }
12985:
12986: sub recprefix {
12987: my $fucourseid=shift;
12988: my $prefix;
12989: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2'||
12990: $env{"course.$fucourseid.receiptalg"} eq 'receipt3' ) {
12991: $prefix=$env{"course.$fucourseid.internal.encpref"};
12992: } else {
12993: $prefix=$perlvar{'lonHostID'};
12994: }
12995: return unpack("%32C*",$prefix);
12996: }
12997:
12998: sub ireceipt {
12999: my ($funame,$fudom,$fucourseid,$fusymb,$part)=@_;
13000:
13001: my $return =&recprefix($fucourseid).'-';
13002:
13003: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt3' ||
13004: $env{'request.state'} eq 'construct') {
13005: $return .= (&digest("$funame,$fudom,$fucourseid,$fusymb,$part")%10000);
13006: return $return;
13007: }
13008:
13009: my $cuname=unpack("%32C*",$funame);
13010: my $cudom=unpack("%32C*",$fudom);
13011: my $cucourseid=unpack("%32C*",$fucourseid);
13012: my $cusymb=unpack("%32C*",$fusymb);
13013: my $cunique=&recunique($fucourseid);
13014: my $cpart=unpack("%32S*",$part);
13015: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2') {
13016:
13017: #&logthis("doing receipt2 using parts $cpart, uname $cuname and udom $cudom gets ".($cpart%$cuname)." and ".($cpart%$cudom));
13018:
13019: $return.= ($cunique%$cuname+
13020: $cunique%$cudom+
13021: $cusymb%$cuname+
13022: $cusymb%$cudom+
13023: $cucourseid%$cuname+
13024: $cucourseid%$cudom+
13025: $cpart%$cuname+
13026: $cpart%$cudom);
13027: } else {
13028: $return.= ($cunique%$cuname+
13029: $cunique%$cudom+
13030: $cusymb%$cuname+
13031: $cusymb%$cudom+
13032: $cucourseid%$cuname+
13033: $cucourseid%$cudom);
13034: }
13035: return $return;
13036: }
13037:
13038: sub receipt {
13039: my ($part)=@_;
13040: my ($symb,$courseid,$domain,$name) = &whichuser();
13041: return &ireceipt($name,$domain,$courseid,$symb,$part);
13042: }
13043:
13044: sub whichuser {
13045: my ($passedsymb)=@_;
13046: my ($symb,$courseid,$domain,$name,$publicuser);
13047: if (defined($env{'form.grade_symb'})) {
13048: my ($tmp_courseid)=&get_env_multiple('form.grade_courseid');
13049: my $allowed=&allowed('vgr',$tmp_courseid);
13050: if (!$allowed &&
13051: exists($env{'request.course.sec'}) &&
13052: $env{'request.course.sec'} !~ /^\s*$/) {
13053: $allowed=&allowed('vgr',$tmp_courseid.
13054: '/'.$env{'request.course.sec'});
13055: }
13056: if ($allowed) {
13057: ($symb)=&get_env_multiple('form.grade_symb');
13058: $courseid=$tmp_courseid;
13059: ($domain)=&get_env_multiple('form.grade_domain');
13060: ($name)=&get_env_multiple('form.grade_username');
13061: return ($symb,$courseid,$domain,$name,$publicuser);
13062: }
13063: }
13064: if (!$passedsymb) {
13065: $symb=&symbread();
13066: } else {
13067: $symb=$passedsymb;
13068: }
13069: $courseid=$env{'request.course.id'};
13070: $domain=$env{'user.domain'};
13071: $name=$env{'user.name'};
13072: if ($name eq 'public' && $domain eq 'public') {
13073: if (!defined($env{'form.username'})) {
13074: $env{'form.username'}.=time.rand(10000000);
13075: }
13076: $name.=$env{'form.username'};
13077: }
13078: return ($symb,$courseid,$domain,$name,$publicuser);
13079:
13080: }
13081:
13082: # ------------------------------------------------------------ Serves up a file
13083: # returns either the contents of the file or
13084: # -1 if the file doesn't exist
13085: #
13086: # if the target is a file that was uploaded via DOCS,
13087: # a check will be made to see if a current copy exists on the local server,
13088: # if it does this will be served, otherwise a copy will be retrieved from
13089: # the home server for the course and stored in /home/httpd/html/userfiles on
13090: # the local server.
13091:
13092: sub getfile {
13093: my ($file) = @_;
13094: if ($file =~ m -^/*(uploaded|editupload)/-) { $file=&filelocation("",$file); }
13095: &repcopy($file);
13096: return &readfile($file);
13097: }
13098:
13099: sub repcopy_userfile {
13100: my ($file)=@_;
13101: my $londocroot = $perlvar{'lonDocRoot'};
13102: if ($file =~ m{^/*(uploaded|editupload)/}) { $file=&filelocation("",$file); }
13103: if ($file =~ m{^\Q/home/httpd/lonUsers/\E}) { return 'ok'; }
13104: my ($cdom,$cnum,$filename) =
13105: ($file=~m|^\Q$perlvar{'lonDocRoot'}\E/+userfiles/+($match_domain)/+($match_name)/+(.*)|);
13106: my $uri="/uploaded/$cdom/$cnum/$filename";
13107: if (-e "$file") {
13108: # we already have a local copy, check it out
13109: my @fileinfo = stat($file);
13110: my $rtncode;
13111: my $info;
13112: my $lwpresp = &getuploaded('HEAD',$uri,$cdom,$cnum,\$info,\$rtncode);
13113: if ($lwpresp ne 'ok') {
13114: # there is no such file anymore, even though we had a local copy
13115: if ($rtncode eq '404') {
13116: unlink($file);
13117: }
13118: return -1;
13119: }
13120: if ($info < $fileinfo[9]) {
13121: # nice, the file we have is up-to-date, just say okay
13122: return 'ok';
13123: } else {
13124: # the file is outdated, get rid of it
13125: unlink($file);
13126: }
13127: }
13128: # one way or the other, at this point, we don't have the file
13129: # construct the correct path for the file
13130: my @parts = ($cdom,$cnum);
13131: if ($filename =~ m|^(.+)/[^/]+$|) {
13132: push @parts, split(/\//,$1);
13133: }
13134: my $path = $perlvar{'lonDocRoot'}.'/userfiles';
13135: foreach my $part (@parts) {
13136: $path .= '/'.$part;
13137: if (!-e $path) {
13138: mkdir($path,0770);
13139: }
13140: }
13141: # now the path exists for sure
13142: # get a user agent
13143: my $transferfile=$file.'.in.transfer';
13144: # FIXME: this should flock
13145: if (-e $transferfile) { return 'ok'; }
13146: my $request;
13147: $uri=~s/^\///;
13148: my $homeserver = &homeserver($cnum,$cdom);
13149: my $protocol = $protocol{$homeserver};
13150: $protocol = 'http' if ($protocol ne 'https');
13151: $request=new HTTP::Request('GET',$protocol.'://'.&hostname($homeserver).'/raw/'.$uri);
13152: my $response = &LONCAPA::LWPReq::makerequest($homeserver,$request,$transferfile,\%perlvar,'',0,1);
13153: # did it work?
13154: if ($response->is_error()) {
13155: unlink($transferfile);
13156: &logthis("Userfile repcopy failed for $uri");
13157: return -1;
13158: }
13159: # worked, rename the transfer file
13160: rename($transferfile,$file);
13161: return 'ok';
13162: }
13163:
13164: sub tokenwrapper {
13165: my $uri=shift;
13166: $uri=~s|^https?\://([^/]+)||;
13167: $uri=~s|^/||;
13168: $env{'user.environment'}=~/\/([^\/]+)\.id/;
13169: my $token=$1;
13170: my (undef,$udom,$uname,$file)=split('/',$uri,4);
13171: if ($udom && $uname && $file) {
13172: $file=~s|(\?\.*)*$||;
13173: &appenv({"userfile.$udom/$uname/$file" => $env{'request.course.id'}});
13174: my $homeserver = &homeserver($uname,$udom);
13175: my $protocol = $protocol{$homeserver};
13176: $protocol = 'http' if ($protocol ne 'https');
13177: return $protocol.'://'.&hostname($homeserver).'/'.$uri.
13178: (($uri=~/\?/)?'&':'?').'token='.$token.
13179: '&tokenissued='.$perlvar{'lonHostID'};
13180: } else {
13181: return '/adm/notfound.html';
13182: }
13183: }
13184:
13185: # call with reqtype HEAD: get last modification time
13186: # call with reqtype GET: get the file contents
13187: # Do not call this with reqtype GET for large files! It loads everything into memory
13188: #
13189: sub getuploaded {
13190: my ($reqtype,$uri,$cdom,$cnum,$info,$rtncode) = @_;
13191: $uri=~s/^\///;
13192: my $homeserver = &homeserver($cnum,$cdom);
13193: my $protocol = $protocol{$homeserver};
13194: $protocol = 'http' if ($protocol ne 'https');
13195: $uri = $protocol.'://'.&hostname($homeserver).'/raw/'.$uri;
13196: my $request=new HTTP::Request($reqtype,$uri);
13197: my $response=&LONCAPA::LWPReq::makerequest($homeserver,$request,'',\%perlvar,'',0,1);
13198: $$rtncode = $response->code;
13199: if (! $response->is_success()) {
13200: return 'failed';
13201: }
13202: if ($reqtype eq 'HEAD') {
13203: $$info = &HTTP::Date::str2time( $response->header('Last-modified') );
13204: } elsif ($reqtype eq 'GET') {
13205: $$info = $response->content;
13206: }
13207: return 'ok';
13208: }
13209:
13210: sub readfile {
13211: my $file = shift;
13212: if ( (! -e $file ) || ($file eq '') ) { return -1; };
13213: my $fh;
13214: open($fh,"<",$file);
13215: my $a='';
13216: while (my $line = <$fh>) { $a .= $line; }
13217: return $a;
13218: }
13219:
13220: sub filelocation {
13221: my ($dir,$file) = @_;
13222: my $location;
13223: $file=~ s/^\s*(\S+)\s*$/$1/; ## strip off leading and trailing spaces
13224:
13225: if ($file =~ m-^/adm/-) {
13226: $file=~s-^/adm/wrapper/-/-;
13227: $file=~s-^/adm/coursedocs/showdoc/-/-;
13228: }
13229:
13230: if ($file =~ m-^\Q$Apache::lonnet::perlvar{'lonTabDir'}\E/-) {
13231: $location = $file;
13232: } elsif ($file=~/^\/*(uploaded|editupload)/) { # is an uploaded file
13233: my ($udom,$uname,$filename)=
13234: ($file=~m -^/+(?:uploaded|editupload)/+($match_domain)/+($match_name)/+(.*)$-);
13235: my $home=&homeserver($uname,$udom);
13236: my $is_me=0;
13237: my @ids=¤t_machine_ids();
13238: foreach my $id (@ids) { if ($id eq $home) { $is_me=1; } }
13239: if ($is_me) {
13240: $location=propath($udom,$uname).'/userfiles/'.$filename;
13241: } else {
13242: $location=$Apache::lonnet::perlvar{'lonDocRoot'}.'/userfiles/'.
13243: $udom.'/'.$uname.'/'.$filename;
13244: }
13245: } elsif ($file =~ m-^/adm/-) {
13246: $location = $perlvar{'lonDocRoot'}.'/'.$file;
13247: } else {
13248: $file=~s/^\Q$perlvar{'lonDocRoot'}\E//;
13249: $file=~s:^/(res|priv)/:/:;
13250: my $space=$1;
13251: if ( !( $file =~ m:^/:) ) {
13252: $location = $dir. '/'.$file;
13253: } else {
13254: $location = $perlvar{'lonDocRoot'}.'/'.$space.$file;
13255: }
13256: }
13257: $location=~s://+:/:g; # remove duplicate /
13258: while ($location=~m{/\.\./}) {
13259: if ($location =~ m{/[^/]+/\.\./}) {
13260: $location=~ s{/[^/]+/\.\./}{/}g;
13261: } else {
13262: $location=~ s{/\.\./}{/}g;
13263: }
13264: } #remove dir/..
13265: while ($location=~m:/\./:) {$location=~ s:/\./:/:g;} #remove /./
13266: return $location;
13267: }
13268:
13269: sub hreflocation {
13270: my ($dir,$file)=@_;
13271: unless (($file=~m-^https?\://-i) || ($file=~m-^/-)) {
13272: $file=filelocation($dir,$file);
13273: } elsif ($file=~m-^/adm/-) {
13274: $file=~s-^/adm/wrapper/-/-;
13275: $file=~s-^/adm/coursedocs/showdoc/-/-;
13276: }
13277: if ($file=~m-^\Q$perlvar{'lonDocRoot'}\E-) {
13278: $file=~s-^\Q$perlvar{'lonDocRoot'}\E--;
13279: } elsif ($file=~m-^\Q$perlvar{'lonUsersDir'}\E-) {
13280: $file=~s{^/home/httpd/lonUsers/($match_domain)/./././($match_name)/userfiles/}
13281: {/uploaded/$1/$2/}x;
13282: }
13283: if ($file=~ m{^/userfiles/}) {
13284: $file =~ s{^/userfiles/}{/uploaded/};
13285: }
13286: return $file;
13287: }
13288:
13289:
13290:
13291:
13292:
13293: sub current_machine_domains {
13294: return &machine_domains(&hostname($perlvar{'lonHostID'}));
13295: }
13296:
13297: sub machine_domains {
13298: my ($hostname) = @_;
13299: my @domains;
13300: my %hostname = &all_hostnames();
13301: while( my($id, $name) = each(%hostname)) {
13302: # &logthis("-$id-$name-$hostname-");
13303: if ($hostname eq $name) {
13304: push(@domains,&host_domain($id));
13305: }
13306: }
13307: return @domains;
13308: }
13309:
13310: sub current_machine_ids {
13311: return &machine_ids(&hostname($perlvar{'lonHostID'}));
13312: }
13313:
13314: sub machine_ids {
13315: my ($hostname) = @_;
13316: $hostname ||= &hostname($perlvar{'lonHostID'});
13317: my @ids;
13318: my %name_to_host = &all_names();
13319: if (ref($name_to_host{$hostname}) eq 'ARRAY') {
13320: return @{ $name_to_host{$hostname} };
13321: }
13322: return;
13323: }
13324:
13325: sub additional_machine_domains {
13326: my @domains;
13327: open(my $fh,"<","$perlvar{'lonTabDir'}/expected_domains.tab");
13328: while( my $line = <$fh>) {
13329: $line =~ s/\s//g;
13330: push(@domains,$line);
13331: }
13332: return @domains;
13333: }
13334:
13335: sub default_login_domain {
13336: my $domain = $perlvar{'lonDefDomain'};
13337: my $testdomain=(split(/\./,$ENV{'HTTP_HOST'}))[0];
13338: foreach my $posdom (¤t_machine_domains(),
13339: &additional_machine_domains()) {
13340: if (lc($posdom) eq lc($testdomain)) {
13341: $domain=$posdom;
13342: last;
13343: }
13344: }
13345: return $domain;
13346: }
13347:
13348: # ------------------------------------------------------------- Declutters URLs
13349:
13350: sub declutter {
13351: my $thisfn=shift;
13352: if ($thisfn=~m|^/enc/|) { $thisfn=&Apache::lonenc::unencrypted($thisfn); }
13353: unless ($thisfn=~m{^/home/httpd/html/priv/}) {
13354: $thisfn=~s{^/home/httpd/html}{};
13355: }
13356: $thisfn=~s/^\///;
13357: $thisfn=~s|^adm/wrapper/||;
13358: $thisfn=~s|^adm/coursedocs/showdoc/||;
13359: $thisfn=~s/^res\///;
13360: $thisfn=~s/^priv\///;
13361: unless (($thisfn =~ /^ext/) || ($thisfn =~ /\.(page|sequence)___\d+___ext/)) {
13362: $thisfn=~s/\?.+$//;
13363: }
13364: return $thisfn;
13365: }
13366:
13367: # ------------------------------------------------------------- Clutter up URLs
13368:
13369: sub clutter {
13370: my $thisfn='/'.&declutter(shift);
13371: if ($thisfn !~ m{^/(uploaded|editupload|adm|userfiles|ext|raw|priv|public)/}
13372: || $thisfn =~ m{^/adm/(includes|pages)} ) {
13373: $thisfn='/res'.$thisfn;
13374: }
13375: if ($thisfn !~m|^/adm|) {
13376: if ($thisfn =~ m|^/ext/|) {
13377: $thisfn='/adm/wrapper'.$thisfn;
13378: } else {
13379: my ($ext) = ($thisfn =~ /\.(\w+)$/);
13380: my $embstyle=&Apache::loncommon::fileembstyle($ext);
13381: if ($embstyle eq 'ssi'
13382: || ($embstyle eq 'hdn')
13383: || ($embstyle eq 'rat')
13384: || ($embstyle eq 'prv')
13385: || ($embstyle eq 'ign')) {
13386: #do nothing with these
13387: } elsif (($embstyle eq 'img')
13388: || ($embstyle eq 'emb')
13389: || ($embstyle eq 'wrp')) {
13390: $thisfn='/adm/wrapper'.$thisfn;
13391: } elsif ($embstyle eq 'unk'
13392: && $thisfn!~/\.(sequence|page)$/) {
13393: $thisfn='/adm/coursedocs/showdoc'.$thisfn;
13394: } else {
13395: # &logthis("Got a blank emb style");
13396: }
13397: }
13398: } elsif ($thisfn =~ m{^/adm/$match_domain/$match_courseid/\d+/ext\.tool$}) {
13399: $thisfn='/adm/wrapper'.$thisfn;
13400: }
13401: return $thisfn;
13402: }
13403:
13404: sub clutter_with_no_wrapper {
13405: my $uri = &clutter(shift);
13406: if ($uri =~ m-^/adm/-) {
13407: $uri =~ s-^/adm/wrapper/-/-;
13408: $uri =~ s-^/adm/coursedocs/showdoc/-/-;
13409: }
13410: return $uri;
13411: }
13412:
13413: sub freeze_escape {
13414: my ($value)=@_;
13415: if (ref($value)) {
13416: $value=&nfreeze($value);
13417: return '__FROZEN__'.&escape($value);
13418: }
13419: return &escape($value);
13420: }
13421:
13422:
13423: sub thaw_unescape {
13424: my ($value)=@_;
13425: if ($value =~ /^__FROZEN__/) {
13426: substr($value,0,10,undef);
13427: $value=&unescape($value);
13428: return &thaw($value);
13429: }
13430: return &unescape($value);
13431: }
13432:
13433: sub correct_line_ends {
13434: my ($result)=@_;
13435: $$result =~s/\r\n/\n/mg;
13436: $$result =~s/\r/\n/mg;
13437: }
13438: # ================================================================ Main Program
13439:
13440: sub goodbye {
13441: &logthis("Starting Shut down");
13442: #not converted to using infrastruture and probably shouldn't be
13443: &logthis(sprintf("%-20s is %s",'%badServerCache',length(&nfreeze(\%badServerCache))));
13444: #converted
13445: # &logthis(sprintf("%-20s is %s",'%metacache',scalar(%metacache)));
13446: &logthis(sprintf("%-20s is %s",'%homecache',length(&nfreeze(\%homecache))));
13447: # &logthis(sprintf("%-20s is %s",'%titlecache',length(&nfreeze(\%titlecache))));
13448: # &logthis(sprintf("%-20s is %s",'%courseresdatacache',length(&nfreeze(\%courseresdatacache))));
13449: #1.1 only
13450: # &logthis(sprintf("%-20s is %s",'%userresdatacache',length(&nfreeze(\%userresdatacache))));
13451: # &logthis(sprintf("%-20s is %s",'%getsectioncache',length(&nfreeze(\%getsectioncache))));
13452: # &logthis(sprintf("%-20s is %s",'%courseresversioncache',length(&nfreeze(\%courseresversioncache))));
13453: # &logthis(sprintf("%-20s is %s",'%resversioncache',length(&nfreeze(\%resversioncache))));
13454: &logthis(sprintf("%-20s is %s",'%remembered',length(&nfreeze(\%remembered))));
13455: &logthis(sprintf("%-20s is %s",'kicks',$kicks));
13456: &logthis(sprintf("%-20s is %s",'hits',$hits));
13457: &flushcourselogs();
13458: &logthis("Shutting down");
13459: }
13460:
13461: sub get_dns {
13462: my ($url,$func,$ignore_cache,$nocache,$hashref) = @_;
13463: if (!$ignore_cache) {
13464: my ($content,$cached)=
13465: &Apache::lonnet::is_cached_new('dns',$url);
13466: if ($cached) {
13467: &$func($content,$hashref);
13468: return;
13469: }
13470: }
13471:
13472: my %alldns;
13473: open(my $config,"<","$perlvar{'lonTabDir'}/hosts.tab");
13474: foreach my $dns (<$config>) {
13475: next if ($dns !~ /^\^(\S*)/x);
13476: my $line = $1;
13477: my ($host,$protocol) = split(/:/,$line);
13478: if ($protocol ne 'https') {
13479: $protocol = 'http';
13480: }
13481: $alldns{$host} = $protocol;
13482: }
13483: while (%alldns) {
13484: my ($dns) = sort { $b cmp $a } keys(%alldns);
13485: my $request=new HTTP::Request('GET',"$alldns{$dns}://$dns$url");
13486: my $response = &LONCAPA::LWPReq::makerequest('',$request,'',\%perlvar,30,0);
13487: delete($alldns{$dns});
13488: next if ($response->is_error());
13489: my @content = split("\n",$response->content);
13490: unless ($nocache) {
13491: &do_cache_new('dns',$url,\@content,30*24*60*60);
13492: }
13493: &$func(\@content,$hashref);
13494: return;
13495: }
13496: close($config);
13497: my $which = (split('/',$url))[3];
13498: &logthis("unable to contact DNS defaulting to on disk file dns_$which.tab\n");
13499: open($config,"<","$perlvar{'lonTabDir'}/dns_$which.tab");
13500: my @content = <$config>;
13501: &$func(\@content,$hashref);
13502: return;
13503: }
13504:
13505: # ------------------------------------------------------Get DNS checksums file
13506: sub parse_dns_checksums_tab {
13507: my ($lines,$hashref) = @_;
13508: my $lonhost = $perlvar{'lonHostID'};
13509: my $machine_dom = &Apache::lonnet::host_domain($lonhost);
13510: my $loncaparev = &get_server_loncaparev($machine_dom);
13511: my $distro = (split(/\:/,&get_server_distarch($lonhost)))[0];
13512: my $webconfdir = '/etc/httpd/conf';
13513: if ($distro =~ /^(ubuntu|debian)(\d+)$/) {
13514: $webconfdir = '/etc/apache2';
13515: } elsif ($distro =~ /^sles(\d+)$/) {
13516: if ($1 >= 10) {
13517: $webconfdir = '/etc/apache2';
13518: }
13519: } elsif ($distro =~ /^suse(\d+\.\d+)$/) {
13520: if ($1 >= 10.0) {
13521: $webconfdir = '/etc/apache2';
13522: }
13523: }
13524: my ($release,$timestamp) = split(/\-/,$loncaparev);
13525: my (%chksum,%revnum);
13526: if (ref($lines) eq 'ARRAY') {
13527: chomp(@{$lines});
13528: my $version = shift(@{$lines});
13529: if ($version eq $release) {
13530: foreach my $line (@{$lines}) {
13531: my ($file,$version,$shasum) = split(/,/,$line);
13532: if ($file =~ m{^/etc/httpd/conf}) {
13533: if ($webconfdir eq '/etc/apache2') {
13534: $file =~ s{^\Q/etc/httpd/conf/\E}{$webconfdir/};
13535: }
13536: }
13537: $chksum{$file} = $shasum;
13538: $revnum{$file} = $version;
13539: }
13540: if (ref($hashref) eq 'HASH') {
13541: %{$hashref} = (
13542: sums => \%chksum,
13543: versions => \%revnum,
13544: );
13545: }
13546: }
13547: }
13548: return;
13549: }
13550:
13551: sub fetch_dns_checksums {
13552: my %checksums;
13553: my $machine_dom = &Apache::lonnet::host_domain($perlvar{'lonHostID'});
13554: my $loncaparev = &get_server_loncaparev($machine_dom,$perlvar{'lonHostID'});
13555: my ($release,$timestamp) = split(/\-/,$loncaparev);
13556: &get_dns("/adm/dns/checksums/$release",\&parse_dns_checksums_tab,1,1,
13557: \%checksums);
13558: return \%checksums;
13559: }
13560:
13561: # ------------------------------------------------------------ Read domain file
13562: {
13563: my $loaded;
13564: my %domain;
13565:
13566: sub parse_domain_tab {
13567: my ($lines) = @_;
13568: foreach my $line (@$lines) {
13569: next if ($line =~ /^(\#|\s*$ )/x);
13570:
13571: chomp($line);
13572: my ($name,@elements) = split(/:/,$line,9);
13573: my %this_domain;
13574: foreach my $field ('description', 'auth_def', 'auth_arg_def',
13575: 'lang_def', 'city', 'longi', 'lati',
13576: 'primary') {
13577: $this_domain{$field} = shift(@elements);
13578: }
13579: $domain{$name} = \%this_domain;
13580: }
13581: }
13582:
13583: sub reset_domain_info {
13584: undef($loaded);
13585: undef(%domain);
13586: }
13587:
13588: sub load_domain_tab {
13589: my ($ignore_cache,$nocache) = @_;
13590: &get_dns('/adm/dns/domain',\&parse_domain_tab,$ignore_cache,$nocache);
13591: my $fh;
13592: if (open($fh,"<",$perlvar{'lonTabDir'}.'/domain.tab')) {
13593: my @lines = <$fh>;
13594: &parse_domain_tab(\@lines);
13595: }
13596: close($fh);
13597: $loaded = 1;
13598: }
13599:
13600: sub domain {
13601: &load_domain_tab() if (!$loaded);
13602:
13603: my ($name,$what) = @_;
13604: return if ( !exists($domain{$name}) );
13605:
13606: if (!$what) {
13607: return $domain{$name}{'description'};
13608: }
13609: return $domain{$name}{$what};
13610: }
13611:
13612: sub domain_info {
13613: &load_domain_tab() if (!$loaded);
13614: return %domain;
13615: }
13616:
13617: }
13618:
13619:
13620: # ------------------------------------------------------------- Read hosts file
13621: {
13622: my %hostname;
13623: my %hostdom;
13624: my %libserv;
13625: my $loaded;
13626: my %name_to_host;
13627: my %internetdom;
13628: my %LC_dns_serv;
13629:
13630: sub parse_hosts_tab {
13631: my ($file) = @_;
13632: foreach my $configline (@$file) {
13633: next if ($configline =~ /^(\#|\s*$ )/x);
13634: chomp($configline);
13635: if ($configline =~ /^\^/) {
13636: if ($configline =~ /^\^([\w.\-]+)/) {
13637: $LC_dns_serv{$1} = 1;
13638: }
13639: next;
13640: }
13641: my ($id,$domain,$role,$name,$protocol,$intdom)=split(/:/,$configline);
13642: $name=~s/\s//g;
13643: if ($id && $domain && $role && $name) {
13644: if ((exists($hostname{$id})) && ($hostname{$id} ne '')) {
13645: my $curr = $hostname{$id};
13646: my $skip;
13647: if (ref($name_to_host{$curr}) eq 'ARRAY') {
13648: if (($curr eq $name) && (@{$name_to_host{$curr}} == 1)) {
13649: $skip = 1;
13650: } else {
13651: @{$name_to_host{$curr}} = grep { $_ ne $id } @{$name_to_host{$curr}};
13652: }
13653: }
13654: unless ($skip) {
13655: push(@{$name_to_host{$name}},$id);
13656: }
13657: } else {
13658: push(@{$name_to_host{$name}},$id);
13659: }
13660: $hostname{$id}=$name;
13661: $hostdom{$id}=$domain;
13662: if ($role eq 'library') { $libserv{$id}=$name; }
13663: if (defined($protocol)) {
13664: if ($protocol eq 'https') {
13665: $protocol{$id} = $protocol;
13666: } else {
13667: $protocol{$id} = 'http';
13668: }
13669: } else {
13670: $protocol{$id} = 'http';
13671: }
13672: if (defined($intdom)) {
13673: $internetdom{$id} = $intdom;
13674: }
13675: }
13676: }
13677: }
13678:
13679: sub reset_hosts_info {
13680: &purge_remembered();
13681: &reset_domain_info();
13682: &reset_hosts_ip_info();
13683: undef(%internetdom);
13684: undef(%name_to_host);
13685: undef(%hostname);
13686: undef(%hostdom);
13687: undef(%libserv);
13688: undef($loaded);
13689: }
13690:
13691: sub load_hosts_tab {
13692: my ($ignore_cache,$nocache) = @_;
13693: &get_dns('/adm/dns/hosts',\&parse_hosts_tab,$ignore_cache,$nocache);
13694: open(my $config,"<","$perlvar{'lonTabDir'}/hosts.tab");
13695: my @config = <$config>;
13696: &parse_hosts_tab(\@config);
13697: close($config);
13698: $loaded=1;
13699: }
13700:
13701: sub hostname {
13702: &load_hosts_tab() if (!$loaded);
13703:
13704: my ($lonid) = @_;
13705: return $hostname{$lonid};
13706: }
13707:
13708: sub all_hostnames {
13709: &load_hosts_tab() if (!$loaded);
13710:
13711: return %hostname;
13712: }
13713:
13714: sub all_names {
13715: my ($ignore_cache,$nocache) = @_;
13716: &load_hosts_tab($ignore_cache,$nocache) if (!$loaded);
13717:
13718: return %name_to_host;
13719: }
13720:
13721: sub all_host_domain {
13722: &load_hosts_tab() if (!$loaded);
13723: return %hostdom;
13724: }
13725:
13726: sub all_host_intdom {
13727: &load_hosts_tab() if (!$loaded);
13728: return %internetdom;
13729: }
13730:
13731: sub is_library {
13732: &load_hosts_tab() if (!$loaded);
13733:
13734: return exists($libserv{$_[0]});
13735: }
13736:
13737: sub all_library {
13738: &load_hosts_tab() if (!$loaded);
13739:
13740: return %libserv;
13741: }
13742:
13743: sub unique_library {
13744: #2x reverse removes all hostnames that appear more than once
13745: my %unique = reverse &all_library();
13746: return reverse %unique;
13747: }
13748:
13749: sub get_servers {
13750: &load_hosts_tab() if (!$loaded);
13751:
13752: my ($domain,$type) = @_;
13753: my %possible_hosts = ($type eq 'library') ? %libserv
13754: : %hostname;
13755: my %result;
13756: if (ref($domain) eq 'ARRAY') {
13757: while ( my ($host,$hostname) = each(%possible_hosts)) {
13758: if (grep(/^\Q$hostdom{$host}\E$/,@$domain)) {
13759: $result{$host} = $hostname;
13760: }
13761: }
13762: } else {
13763: while ( my ($host,$hostname) = each(%possible_hosts)) {
13764: if ($hostdom{$host} eq $domain) {
13765: $result{$host} = $hostname;
13766: }
13767: }
13768: }
13769: return %result;
13770: }
13771:
13772: sub get_unique_servers {
13773: my %unique = reverse &get_servers(@_);
13774: return reverse %unique;
13775: }
13776:
13777: sub host_domain {
13778: &load_hosts_tab() if (!$loaded);
13779:
13780: my ($lonid) = @_;
13781: return $hostdom{$lonid};
13782: }
13783:
13784: sub all_domains {
13785: &load_hosts_tab() if (!$loaded);
13786:
13787: my %seen;
13788: my @uniq = grep(!$seen{$_}++, values(%hostdom));
13789: return @uniq;
13790: }
13791:
13792: sub internet_dom {
13793: &load_hosts_tab() if (!$loaded);
13794:
13795: my ($lonid) = @_;
13796: return $internetdom{$lonid};
13797: }
13798:
13799: sub is_LC_dns {
13800: &load_hosts_tab() if (!$loaded);
13801:
13802: my ($hostname) = @_;
13803: return exists($LC_dns_serv{$hostname});
13804: }
13805:
13806: }
13807:
13808: {
13809: my %iphost;
13810: my %name_to_ip;
13811: my %lonid_to_ip;
13812:
13813: sub get_hosts_from_ip {
13814: my ($ip) = @_;
13815: my %iphosts = &get_iphost();
13816: if (ref($iphosts{$ip})) {
13817: return @{$iphosts{$ip}};
13818: }
13819: return;
13820: }
13821:
13822: sub reset_hosts_ip_info {
13823: undef(%iphost);
13824: undef(%name_to_ip);
13825: undef(%lonid_to_ip);
13826: }
13827:
13828: sub get_host_ip {
13829: my ($lonid) = @_;
13830: if (exists($lonid_to_ip{$lonid})) {
13831: return $lonid_to_ip{$lonid};
13832: }
13833: my $name=&hostname($lonid);
13834: my $ip = gethostbyname($name);
13835: return if (!$ip || length($ip) ne 4);
13836: $ip=inet_ntoa($ip);
13837: $name_to_ip{$name} = $ip;
13838: $lonid_to_ip{$lonid} = $ip;
13839: return $ip;
13840: }
13841:
13842: sub get_iphost {
13843: my ($ignore_cache,$nocache) = @_;
13844:
13845: if (!$ignore_cache) {
13846: if (%iphost) {
13847: return %iphost;
13848: }
13849: my ($ip_info,$cached)=
13850: &Apache::lonnet::is_cached_new('iphost','iphost');
13851: if ($cached) {
13852: %iphost = %{$ip_info->[0]};
13853: %name_to_ip = %{$ip_info->[1]};
13854: %lonid_to_ip = %{$ip_info->[2]};
13855: return %iphost;
13856: }
13857: }
13858:
13859: # get yesterday's info for fallback
13860: my %old_name_to_ip;
13861: my ($ip_info,$cached)=
13862: &Apache::lonnet::is_cached_new('iphost','iphost');
13863: if ($cached) {
13864: %old_name_to_ip = %{$ip_info->[1]};
13865: }
13866:
13867: my %name_to_host = &all_names($ignore_cache,$nocache);
13868: foreach my $name (keys(%name_to_host)) {
13869: my $ip;
13870: if (!exists($name_to_ip{$name})) {
13871: $ip = gethostbyname($name);
13872: if (!$ip || length($ip) ne 4) {
13873: if (defined($old_name_to_ip{$name})) {
13874: $ip = $old_name_to_ip{$name};
13875: &logthis("Can't find $name defaulting to old $ip");
13876: } else {
13877: &logthis("Name $name no IP found");
13878: next;
13879: }
13880: } else {
13881: $ip=inet_ntoa($ip);
13882: }
13883: $name_to_ip{$name} = $ip;
13884: } else {
13885: $ip = $name_to_ip{$name};
13886: }
13887: foreach my $id (@{ $name_to_host{$name} }) {
13888: $lonid_to_ip{$id} = $ip;
13889: }
13890: push(@{$iphost{$ip}},@{$name_to_host{$name}});
13891: }
13892: unless ($nocache) {
13893: &do_cache_new('iphost','iphost',
13894: [\%iphost,\%name_to_ip,\%lonid_to_ip],
13895: 48*60*60);
13896: }
13897:
13898: return %iphost;
13899: }
13900:
13901: #
13902: # Given a DNS returns the loncapa host name for that DNS
13903: #
13904: sub host_from_dns {
13905: my ($dns) = @_;
13906: my @hosts;
13907: my $ip;
13908:
13909: if (exists($name_to_ip{$dns})) {
13910: $ip = $name_to_ip{$dns};
13911: }
13912: if (!$ip) {
13913: $ip = gethostbyname($dns); # Initial translation to IP is in net order.
13914: if (length($ip) == 4) {
13915: $ip = &IO::Socket::inet_ntoa($ip);
13916: }
13917: }
13918: if ($ip) {
13919: @hosts = get_hosts_from_ip($ip);
13920: return $hosts[0];
13921: }
13922: return undef;
13923: }
13924:
13925: sub get_internet_names {
13926: my ($lonid) = @_;
13927: return if ($lonid eq '');
13928: my ($idnref,$cached)=
13929: &Apache::lonnet::is_cached_new('internetnames',$lonid);
13930: if ($cached) {
13931: return $idnref;
13932: }
13933: my $ip = &get_host_ip($lonid);
13934: my @hosts = &get_hosts_from_ip($ip);
13935: my %iphost = &get_iphost();
13936: my (@idns,%seen);
13937: foreach my $id (@hosts) {
13938: my $dom = &host_domain($id);
13939: my $prim_id = &domain($dom,'primary');
13940: my $prim_ip = &get_host_ip($prim_id);
13941: next if ($seen{$prim_ip});
13942: if (ref($iphost{$prim_ip}) eq 'ARRAY') {
13943: foreach my $id (@{$iphost{$prim_ip}}) {
13944: my $intdom = &internet_dom($id);
13945: unless (grep(/^\Q$intdom\E$/,@idns)) {
13946: push(@idns,$intdom);
13947: }
13948: }
13949: }
13950: $seen{$prim_ip} = 1;
13951: }
13952: return &do_cache_new('internetnames',$lonid,\@idns,12*60*60);
13953: }
13954:
13955: }
13956:
13957: sub all_loncaparevs {
13958: return qw(1.1 1.2 1.3 2.0 2.1 2.2 2.3 2.4 2.5 2.6 2.7 2.8 2.9 2.10 2.11);
13959: }
13960:
13961: # ---------------------------------------------------------- Read loncaparev table
13962: {
13963: sub load_loncaparevs {
13964: if (-e "$perlvar{'lonTabDir'}/loncaparevs.tab") {
13965: if (open(my $config,"<","$perlvar{'lonTabDir'}/loncaparevs.tab")) {
13966: while (my $configline=<$config>) {
13967: chomp($configline);
13968: my ($hostid,$loncaparev)=split(/:/,$configline);
13969: $loncaparevs{$hostid}=$loncaparev;
13970: }
13971: close($config);
13972: }
13973: }
13974: }
13975: }
13976:
13977: # ---------------------------------------------------------- Read serverhostID table
13978: {
13979: sub load_serverhomeIDs {
13980: if (-e "$perlvar{'lonTabDir'}/serverhomeIDs.tab") {
13981: if (open(my $config,"<","$perlvar{'lonTabDir'}/serverhomeIDs.tab")) {
13982: while (my $configline=<$config>) {
13983: chomp($configline);
13984: my ($name,$id)=split(/:/,$configline);
13985: $serverhomeIDs{$name}=$id;
13986: }
13987: close($config);
13988: }
13989: }
13990: }
13991: }
13992:
13993:
13994: BEGIN {
13995:
13996: # ----------------------------------- Read loncapa.conf and loncapa_apache.conf
13997: unless ($readit) {
13998: {
13999: my $configvars = LONCAPA::Configuration::read_conf('loncapa.conf');
14000: %perlvar = (%perlvar,%{$configvars});
14001: }
14002:
14003:
14004: # ------------------------------------------------------ Read spare server file
14005: {
14006: open(my $config,"<","$perlvar{'lonTabDir'}/spare.tab");
14007:
14008: while (my $configline=<$config>) {
14009: chomp($configline);
14010: if ($configline) {
14011: my ($host,$type) = split(':',$configline,2);
14012: if (!defined($type) || $type eq '') { $type = 'default' };
14013: push(@{ $spareid{$type} }, $host);
14014: }
14015: }
14016: close($config);
14017: }
14018: # ------------------------------------------------------------ Read permissions
14019: {
14020: open(my $config,"<","$perlvar{'lonTabDir'}/roles.tab");
14021:
14022: while (my $configline=<$config>) {
14023: chomp($configline);
14024: if ($configline) {
14025: my ($role,$perm)=split(/ /,$configline);
14026: if ($perm ne '') { $pr{$role}=$perm; }
14027: }
14028: }
14029: close($config);
14030: }
14031:
14032: # -------------------------------------------- Read plain texts for permissions
14033: {
14034: open(my $config,"<","$perlvar{'lonTabDir'}/rolesplain.tab");
14035:
14036: while (my $configline=<$config>) {
14037: chomp($configline);
14038: if ($configline) {
14039: my ($short,@plain)=split(/:/,$configline);
14040: %{$prp{$short}} = ();
14041: if (@plain > 0) {
14042: $prp{$short}{'std'} = $plain[0];
14043: for (my $i=1; $i<@plain; $i++) {
14044: $prp{$short}{'alt'.$i} = $plain[$i];
14045: }
14046: }
14047: }
14048: }
14049: close($config);
14050: }
14051:
14052: # ---------------------------------------------------------- Read package table
14053: {
14054: open(my $config,"<","$perlvar{'lonTabDir'}/packages.tab");
14055:
14056: while (my $configline=<$config>) {
14057: if ($configline !~ /\S/ || $configline=~/^#/) { next; }
14058: chomp($configline);
14059: my ($short,$plain)=split(/:/,$configline);
14060: my ($pack,$name)=split(/\&/,$short);
14061: if ($plain ne '') {
14062: $packagetab{$pack.'&'.$name.'&name'}=$name;
14063: $packagetab{$short}=$plain;
14064: }
14065: }
14066: close($config);
14067: }
14068:
14069: # ---------------------------------------------------------- Read loncaparev table
14070:
14071: &load_loncaparevs();
14072:
14073: # ---------------------------------------------------------- Read serverhostID table
14074:
14075: &load_serverhomeIDs();
14076:
14077: # ---------------------------------------------------------- Read releaseslist XML
14078: {
14079: my $file = $Apache::lonnet::perlvar{'lonTabDir'}.'/releaseslist.xml';
14080: if (-e $file) {
14081: my $parser = HTML::LCParser->new($file);
14082: while (my $token = $parser->get_token()) {
14083: if ($token->[0] eq 'S') {
14084: my $item = $token->[1];
14085: my $name = $token->[2]{'name'};
14086: my $value = $token->[2]{'value'};
14087: my $valuematch = $token->[2]{'valuematch'};
14088: my $namematch = $token->[2]{'namematch'};
14089: if ($item eq 'parameter') {
14090: if (($namematch ne '') || (($name ne '') && ($value ne '' || $valuematch ne ''))) {
14091: my $release = $parser->get_text();
14092: $release =~ s/(^\s*|\s*$ )//gx;
14093: $needsrelease{$item.':'.$name.':'.$value.':'.$valuematch.':'.$namematch} = $release;
14094: }
14095: } elsif ($item ne '' && $name ne '') {
14096: my $release = $parser->get_text();
14097: $release =~ s/(^\s*|\s*$ )//gx;
14098: $needsrelease{$item.':'.$name.':'.$value} = $release;
14099: }
14100: }
14101: }
14102: }
14103: }
14104:
14105: # ---------------------------------------------------------- Read managers table
14106: {
14107: if (-e "$perlvar{'lonTabDir'}/managers.tab") {
14108: if (open(my $config,"<","$perlvar{'lonTabDir'}/managers.tab")) {
14109: while (my $configline=<$config>) {
14110: chomp($configline);
14111: next if ($configline =~ /^\#/);
14112: if (($configline =~ /^[\w\-]+$/) || ($configline =~ /^[\w\-]+\:[\w\-]+$/)) {
14113: $managerstab{$configline} = 1;
14114: }
14115: }
14116: close($config);
14117: }
14118: }
14119: }
14120:
14121: # ------------- set up temporary directory
14122: {
14123: $tmpdir = LONCAPA::tempdir();
14124:
14125: }
14126:
14127: $memcache=new Cache::Memcached({'servers' => ['127.0.0.1:11211'],
14128: 'compress_threshold'=> 20_000,
14129: });
14130:
14131: $processmarker='_'.time.'_'.$perlvar{'lonHostID'};
14132: $dumpcount=0;
14133: $locknum=0;
14134:
14135: &logtouch();
14136: &logthis('<font color="yellow">INFO: Read configuration</font>');
14137: $readit=1;
14138: {
14139: use integer;
14140: my $test=(2**32)+1;
14141: if ($test != 0) { $_64bit=1; } else { $_64bit=0; }
14142: &logthis(" Detected 64bit platform ($_64bit)");
14143: }
14144: }
14145: }
14146:
14147: 1;
14148: __END__
14149:
14150: =pod
14151:
14152: =head1 NAME
14153:
14154: Apache::lonnet - Subroutines to ask questions about things in the network.
14155:
14156: =head1 SYNOPSIS
14157:
14158: Invoked by other LON-CAPA modules, when they need to talk to or about objects in the network.
14159:
14160: &Apache::lonnet::SUBROUTINENAME(ARGUMENTS);
14161:
14162: Common parameters:
14163:
14164: =over 4
14165:
14166: =item *
14167:
14168: $uname : an internal username (if $cname expecting a course Id specifically)
14169:
14170: =item *
14171:
14172: $udom : a domain (if $cdom expecting a course's domain specifically)
14173:
14174: =item *
14175:
14176: $symb : a resource instance identifier
14177:
14178: =item *
14179:
14180: $namespace : the name of a .db file that contains the data needed or
14181: being set.
14182:
14183: =back
14184:
14185: =head1 OVERVIEW
14186:
14187: lonnet provides subroutines which interact with the
14188: lonc/lond (TCP) network layer of LON-CAPA. They can be used to ask
14189: about classes, users, and resources.
14190:
14191: For many of these objects you can also use this to store data about
14192: them or modify them in various ways.
14193:
14194: =head2 Symbs
14195:
14196: To identify a specific instance of a resource, LON-CAPA uses symbols
14197: or "symbs"X<symb>. These identifiers are built from the URL of the
14198: map, the resource number of the resource in the map, and the URL of
14199: the resource itself. The latter is somewhat redundant, but might help
14200: if maps change.
14201:
14202: An example is
14203:
14204: msu/korte/parts/part1.sequence___19___msu/korte/tests/part12.problem
14205:
14206: The respective map entry is
14207:
14208: <resource id="19" src="/res/msu/korte/tests/part12.problem"
14209: title="Problem 2">
14210: </resource>
14211:
14212: Symbs are used by the random number generator, as well as to store and
14213: restore data specific to a certain instance of for example a problem.
14214:
14215: =head2 Storing And Retrieving Data
14216:
14217: X<store()>X<cstore()>X<restore()>Three of the most important functions
14218: in C<lonnet.pm> are C<&Apache::lonnet::cstore()>,
14219: C<&Apache::lonnet:restore()>, and C<&Apache::lonnet::store()>, which
14220: is is the non-critical message twin of cstore. These functions are for
14221: handlers to store a perl hash to a user's permanent data space in an
14222: easy manner, and to retrieve it again on another call. It is expected
14223: that a handler would use this once at the beginning to retrieve data,
14224: and then again once at the end to send only the new data back.
14225:
14226: The data is stored in the user's data directory on the user's
14227: homeserver under the ID of the course.
14228:
14229: The hash that is returned by restore will have all of the previous
14230: value for all of the elements of the hash.
14231:
14232: Example:
14233:
14234: #creating a hash
14235: my %hash;
14236: $hash{'foo'}='bar';
14237:
14238: #storing it
14239: &Apache::lonnet::cstore(\%hash);
14240:
14241: #changing a value
14242: $hash{'foo'}='notbar';
14243:
14244: #adding a new value
14245: $hash{'bar'}='foo';
14246: &Apache::lonnet::cstore(\%hash);
14247:
14248: #retrieving the hash
14249: my %history=&Apache::lonnet::restore();
14250:
14251: #print the hash
14252: foreach my $key (sort(keys(%history))) {
14253: print("\%history{$key} = $history{$key}");
14254: }
14255:
14256: Will print out:
14257:
14258: %history{1:foo} = bar
14259: %history{1:keys} = foo:timestamp
14260: %history{1:timestamp} = 990455579
14261: %history{2:bar} = foo
14262: %history{2:foo} = notbar
14263: %history{2:keys} = foo:bar:timestamp
14264: %history{2:timestamp} = 990455580
14265: %history{bar} = foo
14266: %history{foo} = notbar
14267: %history{timestamp} = 990455580
14268: %history{version} = 2
14269:
14270: Note that the special hash entries C<keys>, C<version> and
14271: C<timestamp> were added to the hash. C<version> will be equal to the
14272: total number of versions of the data that have been stored. The
14273: C<timestamp> attribute will be the UNIX time the hash was
14274: stored. C<keys> is available in every historical section to list which
14275: keys were added or changed at a specific historical revision of a
14276: hash.
14277:
14278: B<Warning>: do not store the hash that restore returns directly. This
14279: will cause a mess since it will restore the historical keys as if the
14280: were new keys. I.E. 1:foo will become 1:1:foo etc.
14281:
14282: Calling convention:
14283:
14284: my %record=&Apache::lonnet::restore($symb,$courseid,$domain,$uname);
14285: &Apache::lonnet::cstore(\%newrecord,$symb,$courseid,$domain,$uname,$laststore);
14286:
14287: For more detailed information, see lonnet specific documentation.
14288:
14289: =head1 RETURN MESSAGES
14290:
14291: =over 4
14292:
14293: =item * B<con_lost>: unable to contact remote host
14294:
14295: =item * B<con_delayed>: unable to contact remote host, message will be delivered
14296: when the connection is brought back up
14297:
14298: =item * B<con_failed>: unable to contact remote host and unable to save message
14299: for later delivery
14300:
14301: =item * B<error:>: an error a occurred, a description of the error follows the :
14302:
14303: =item * B<no_such_host>: unable to fund a host associated with the user/domain
14304: that was requested
14305:
14306: =back
14307:
14308: =head1 PUBLIC SUBROUTINES
14309:
14310: =head2 Session Environment Functions
14311:
14312: =over 4
14313:
14314: =item *
14315: X<appenv()>
14316: B<appenv($hashref,$rolesarrayref)>: the value of %{$hashref} is written to
14317: the user envirnoment file, and will be restored for each access this
14318: user makes during this session, also modifies the %env for the current
14319: process. Optional rolesarrayref - if defined contains a reference to an array
14320: of roles which are exempt from the restriction on modifying user.role entries
14321: in the user's environment.db and in %env.
14322:
14323: =item *
14324: X<delenv()>
14325: B<delenv($delthis,$regexp)>: removes all items from the session
14326: environment file that begin with $delthis. If the
14327: optional second arg - $regexp - is true, $delthis is treated as a
14328: regular expression, otherwise \Q$delthis\E is used.
14329: The values are also deleted from the current processes %env.
14330:
14331: =item * get_env_multiple($name)
14332:
14333: gets $name from the %env hash, it seemlessly handles the cases where multiple
14334: values may be defined and end up as an array ref.
14335:
14336: returns an array of values
14337:
14338: =back
14339:
14340: =head2 User Information
14341:
14342: =over 4
14343:
14344: =item *
14345: X<queryauthenticate()>
14346: B<queryauthenticate($uname,$udom)>: try to determine user's current
14347: authentication scheme
14348:
14349: =item *
14350: X<authenticate()>
14351: B<authenticate($uname,$upass,$udom,$checkdefauth,$clientcancheckhost)>: try to
14352: authenticate user from domain's lib servers (first use the current
14353: one). C<$upass> should be the users password.
14354: $checkdefauth is optional (value is 1 if a check should be made to
14355: authenticate user using default authentication method, and allow
14356: account creation if username does not have account in the domain).
14357: $clientcancheckhost is optional (value is 1 if checking whether the
14358: server can host will occur on the client side in lonauth.pm).
14359:
14360: =item *
14361: X<homeserver()>
14362: B<homeserver($uname,$udom)>: find the server which has
14363: the user's directory and files (there must be only one), this caches
14364: the answer, and also caches if there is a borken connection.
14365:
14366: =item *
14367: X<idget()>
14368: B<idget($udom,$idsref,$namespace)>: find the usernames behind either
14369: a list of student/employee IDs or clicker IDs
14370: (student/employee IDs are a unique resource in a domain, there must be
14371: only 1 ID per username, and only 1 username per ID in a specific domain).
14372: clickerIDs are not necessarily unique, as students might share clickers.
14373: (returns hash: id=>name,id=>name)
14374:
14375: =item *
14376: X<idrget()>
14377: B<idrget($udom,@unames)>: find the IDs behind a list of
14378: usernames (returns hash: name=>id,name=>id)
14379:
14380: =item *
14381: X<idput()>
14382: B<idput($udom,$idsref,$uhome,$namespace)>: store away a list of
14383: names and associated student/employee IDs or clicker IDs.
14384:
14385: =item *
14386: X<iddel()>
14387: B<iddel($udom,$idshashref,$uhome,$namespace)>: delete unwanted
14388: student/employee ID or clicker ID username look-ups from domain.
14389: The homeserver ($uhome) and namespace ($namespace) are optional.
14390: If no $uhome is provided, it will be determined usig &homeserver()
14391: for each user. If no $namespace is provided, the default is ids.
14392:
14393: =item *
14394: X<updateclickers()>
14395: B<updateclickers($udom,$action,$idshashref,$uhome,$critical)>: update
14396: clicker ID-to-username look-ups in clickers.db on library server.
14397: Permitted actions are add or del (i.e., add or delete). The
14398: clickers.db contains clickerID as keys (escaped), and each corresponding
14399: value is an escaped comma-separated list of usernames (for whom the
14400: library server is the homeserver), who registered that particular ID.
14401: If $critical is true, the update will be sent via &critical, otherwise
14402: &reply() will be used.
14403:
14404: =item *
14405: X<rolesinit()>
14406: B<rolesinit($udom,$username)>: get user privileges.
14407: returns user role, first access and timer interval hashes
14408:
14409: =item *
14410: X<privileged()>
14411: B<privileged($username,$domain)>: returns a true if user has a
14412: privileged and active role (i.e. su or dc), false otherwise.
14413:
14414: =item *
14415: X<getsection()>
14416: B<getsection($udom,$uname,$cname)>: finds the section of student in the
14417: course $cname, return section name/number or '' for "not in course"
14418: and '-1' for "no section"
14419:
14420: =item *
14421: X<userenvironment()>
14422: B<userenvironment($udom,$uname,@what)>: gets the values of the keys
14423: passed in @what from the requested user's environment, returns a hash
14424:
14425: =item *
14426: X<userlog_query()>
14427: B<userlog_query($uname,$udom,%filters)>: retrieves data from a user's
14428: activity.log file. %filters defines filters applied when parsing the
14429: log file. These can be start or end timestamps, or the type of action
14430: - log to look for Login or Logout events, check for Checkin or
14431: Checkout, role for role selection. The response is in the form
14432: timestamp1:hostid1:event1×tamp2:hostid2:event2 where events are
14433: escaped strings of the action recorded in the activity.log file.
14434:
14435: =back
14436:
14437: =head2 User Roles
14438:
14439: =over 4
14440:
14441: =item *
14442:
14443: allowed($priv,$uri,$symb,$role,$clientip,$noblockcheck) : check for a user privilege;
14444: returns codes for allowed actions.
14445:
14446: The first argument is required, all others are optional.
14447:
14448: $priv is the privilege being checked.
14449: $uri contains additional information about what is being checked for access (e.g.,
14450: URL, course ID etc.).
14451: $symb is the unique resource instance identifier in a course; if needed,
14452: but not provided, it will be retrieved via a call to &symbread().
14453: $role is the role for which a priv is being checked (only used if priv is evb).
14454: $clientip is the user's IP address (only used when checking for access to portfolio
14455: files).
14456: $noblockcheck, if true, skips calls to &has_comm_blocking() for the bre priv. This
14457: prevents recursive calls to &allowed.
14458:
14459: F: full access
14460: U,I,K: authentication modes (cxx only)
14461: '': forbidden
14462: 1: user needs to choose course
14463: 2: browse allowed
14464: A: passphrase authentication needed
14465: B: access temporarily blocked because of a blocking event in a course.
14466:
14467: =item *
14468:
14469: constructaccess($url,$setpriv) : check for access to construction space URL
14470:
14471: See if the owner domain and name in the URL match those in the
14472: expected environment. If so, return three element list
14473: ($ownername,$ownerdomain,$ownerhome).
14474:
14475: Otherwise return the null string.
14476:
14477: If second argument 'setpriv' is true, it assigns the privileges,
14478: and returns the same three element list, unless the owner has
14479: blocked "ad hoc" Domain Coordinator access to the Author Space,
14480: in which case the null string is returned.
14481:
14482: =item *
14483:
14484: definerole($rolename,$sysrole,$domrole,$courole,$uname,$udom) : define role;
14485: define a custom role rolename set privileges in format of lonTabs/roles.tab
14486: for system, domain, and course level. $uname and $udom are optional (current
14487: user's username and domain will be used when either of $uname or $udom are absent.
14488:
14489: =item *
14490:
14491: plaintext($short,$type,$cid,$forcedefault) : return value in %prp hash
14492: (rolesplain.tab); plain text explanation of a user role term.
14493: $type is Course (default) or Community.
14494: If $forcedefault evaluates to true, text returned will be default
14495: text for $type. Otherwise, if this is a course, the text returned
14496: will be a custom name for the role (if defined in the course's
14497: environment). If no custom name is defined the default is returned.
14498:
14499: =item *
14500:
14501: get_my_roles($uname,$udom,$context,$types,$roles,$roledoms,$withsec,$hidepriv) :
14502: All arguments are optional. Returns a hash of a roles, either for
14503: co-author/assistant author roles for a user's Construction Space
14504: (default), or if $context is 'userroles', roles for the user himself,
14505: In the hash, keys are set to colon-separated $uname,$udom,$role, and
14506: (optionally) if $withsec is true, a fourth colon-separated item - $section.
14507: For each key, value is set to colon-separated start and end times for
14508: the role. If no username and domain are specified, will default to
14509: current user/domain. Types, roles, and roledoms are references to arrays
14510: of role statuses (active, future or previous), roles
14511: (e.g., cc,in, st etc.) and domains of the roles which can be used
14512: to restrict the list of roles reported. If no array ref is
14513: provided for types, will default to return only active roles.
14514:
14515: =item *
14516:
14517: in_course($udom,$uname,$cdom,$cnum,$type,$hideprivileged) : determine if
14518: user: $uname:$udom has a role in the course: $cdom_$cnum.
14519:
14520: Additional optional arguments are: $type (if role checking is to be restricted
14521: to certain user status types -- previous (expired roles), active (currently
14522: available roles) or future (roles available in the future), and
14523: $hideprivileged -- if true will not report course roles for users who
14524: have active Domain Coordinator role in course's domain or in additional
14525: domains (specified in 'Domains to check for privileged users' in course
14526: environment -- set via: Course Settings -> Classlists and staff listing).
14527:
14528: =item *
14529:
14530: privileged($username,$domain,$possdomains,$possroles) : returns 1 if user
14531: $username:$domain is a privileged user (e.g., Domain Coordinator or Super User)
14532: $possdomains and $possroles are optional array refs -- to domains to check and
14533: roles to check. If $possdomains is not specified, a dump will be done of the
14534: users' roles.db to check for a dc or su role in any domain. This can be
14535: time consuming if &privileged is called repeatedly (e.g., when displaying a
14536: classlist), so in such cases, supplying a $possdomains array is preferred, as
14537: this then allows &privileged_by_domain() to be used, which caches the identity
14538: of privileged users, eliminating the need for repeated calls to &dump().
14539:
14540: =item *
14541:
14542: privileged_by_domain($possdomains,$roles) : returns a hash of a hash of a hash,
14543: where the outer hash keys are domains specified in the $possdomains array ref,
14544: next inner hash keys are privileged roles specified in the $roles array ref,
14545: and the innermost hash contains key = value pairs for username:domain = end:start
14546: for active or future "privileged" users with that role in that domain. To avoid
14547: repeated dumps of domain roles -- via &get_domain_roles() -- contents of the
14548: innerhash are cached using priv_$role and $dom as the identifiers.
14549:
14550: =back
14551:
14552: =head2 User Modification
14553:
14554: =over 4
14555:
14556: =item *
14557:
14558: assignrole($udom,$uname,$url,$role,$end,$start,$deleteflag,$selfenroll,$context) : assign role; give a role to a
14559: user for the level given by URL. Optional start and end dates (leave empty
14560: string or zero for "no date")
14561:
14562: =item *
14563:
14564: changepass($uname,$udom,$currentpass,$newpass,$server) : attempts to
14565: change a users, password, possible return values are: ok,
14566: pwchange_failure, non_authorized, auth_mode_error, unknown_user,
14567: refused
14568:
14569: =item *
14570:
14571: modifyuserauth($udom,$uname,$umode,$upass) : modify user authentication
14572:
14573: =item *
14574:
14575: modifyuser($udom,$uname,$uid,$umode,$upass,$first,$middle,$last, $gene,
14576: $forceid,$desiredhome,$email,$inststatus,$candelete) :
14577:
14578: will update user information (firstname,middlename,lastname,generation,
14579: permanentemail), and if forceid is true, student/employee ID also.
14580: A user's institutional affiliation(s) can also be updated.
14581: User information fields will not be overwritten with empty entries
14582: unless the field is included in the $candelete array reference.
14583: This array is included when a single user is modified via "Manage Users",
14584: or when Autoupdate.pl is run by cron in a domain.
14585:
14586: =item *
14587:
14588: modifystudent
14589:
14590: modify a student's enrollment and identification information.
14591: The course id is resolved based on the current user's environment.
14592: This means the invoking user must be a course coordinator or otherwise
14593: associated with a course.
14594:
14595: This call is essentially a wrapper for lonnet::modifyuser and
14596: lonnet::modify_student_enrollment
14597:
14598: Inputs:
14599:
14600: =over 4
14601:
14602: =item B<$udom> Student's loncapa domain
14603:
14604: =item B<$uname> Student's loncapa login name
14605:
14606: =item B<$uid> Student/Employee ID
14607:
14608: =item B<$umode> Student's authentication mode
14609:
14610: =item B<$upass> Student's password
14611:
14612: =item B<$first> Student's first name
14613:
14614: =item B<$middle> Student's middle name
14615:
14616: =item B<$last> Student's last name
14617:
14618: =item B<$gene> Student's generation
14619:
14620: =item B<$usec> Student's section in course
14621:
14622: =item B<$end> Unix time of the roles expiration
14623:
14624: =item B<$start> Unix time of the roles start date
14625:
14626: =item B<$forceid> If defined, allow $uid to be changed
14627:
14628: =item B<$desiredhome> server to use as home server for student
14629:
14630: =item B<$email> Student's permanent e-mail address
14631:
14632: =item B<$type> Type of enrollment (auto or manual)
14633:
14634: =item B<$locktype> boolean - enrollment type locked to prevent Autoenroll.pl changing manual to auto
14635:
14636: =item B<$cid> courseID - needed if a course role is assigned by a user whose current role is DC
14637:
14638: =item B<$selfenroll> boolean - 1 if user role change occurred via self-enrollment
14639:
14640: =item B<$context> role change context (shown in User Management Logs display in a course)
14641:
14642: =item B<$inststatus> institutional status of user - : separated string of escaped status types
14643:
14644: =item B<$credits> Number of credits student will earn from this class - only needs to be supplied if value needs to be different from default credits for class.
14645:
14646: =back
14647:
14648: =item *
14649:
14650: modify_student_enrollment
14651:
14652: Change a student's enrollment status in a class. The environment variable
14653: 'role.request.course' must be defined for this function to proceed.
14654:
14655: Inputs:
14656:
14657: =over 4
14658:
14659: =item $udom, student's domain
14660:
14661: =item $uname, student's name
14662:
14663: =item $uid, student's user id
14664:
14665: =item $first, student's first name
14666:
14667: =item $middle
14668:
14669: =item $last
14670:
14671: =item $gene
14672:
14673: =item $usec
14674:
14675: =item $end
14676:
14677: =item $start
14678:
14679: =item $type
14680:
14681: =item $locktype
14682:
14683: =item $cid
14684:
14685: =item $selfenroll
14686:
14687: =item $context
14688:
14689: =item $credits, number of credits student will earn from this class
14690:
14691: =item $instsec, institutional course section code for student
14692:
14693: =back
14694:
14695:
14696: =item *
14697:
14698: assigncustomrole($udom,$uname,$url,$rdom,$rnam,$rolename,$end,$start) : assign
14699: custom role; give a custom role to a user for the level given by URL. Specify
14700: name and domain of role author, and role name
14701:
14702: =item *
14703:
14704: revokerole($udom,$uname,$url,$role) : revoke a role for url
14705:
14706: =item *
14707:
14708: revokecustomrole($udom,$uname,$url,$role) : revoke a custom role
14709:
14710: =back
14711:
14712: =head2 Course Infomation
14713:
14714: =over 4
14715:
14716: =item *
14717:
14718: coursedescription($courseid,$options) : returns a hash of information about the
14719: specified course id, including all environment settings for the
14720: course, the description of the course will be in the hash under the
14721: key 'description'
14722:
14723: $options is an optional parameter that if supplied is a hash reference that controls
14724: what how this function works. It has the following key/values:
14725:
14726: =over 4
14727:
14728: =item freshen_cache
14729:
14730: If defined, and the environment cache for the course is valid, it is
14731: returned in the returned hash.
14732:
14733: =item one_time
14734:
14735: If defined, the last cache time is set to _now_
14736:
14737: =item user
14738:
14739: If defined, the supplied username is used instead of the current user.
14740:
14741:
14742: =back
14743:
14744: =item *
14745:
14746: resdata($name,$domain,$type,@which) : request for current parameter
14747: setting for a specific $type, where $type is either 'course' or 'user',
14748: @what should be a list of parameters to ask about. This routine caches
14749: answers for 10 minutes.
14750:
14751: =item *
14752:
14753: get_courseresdata($courseid, $domain) : dump the entire course resource
14754: data base, returning a hash that is keyed by the resource name and has
14755: values that are the resource value. I believe that the timestamps and
14756: versions are also returned.
14757:
14758: get_numsuppfiles($cnum,$cdom) : retrieve number of files in a course's
14759: supplemental content area. This routine caches the number of files for
14760: 10 minutes.
14761:
14762: =back
14763:
14764: =head2 Course Modification
14765:
14766: =over 4
14767:
14768: =item *
14769:
14770: writecoursepref($courseid,%prefs) : write preferences (environment
14771: database) for a course
14772:
14773: =item *
14774:
14775: createcourse($udom,$description,$url,$course_server,$nonstandard,$inst_code,$course_owner,$crstype,$cnum) : make course
14776:
14777: =item *
14778:
14779: generate_coursenum($udom,$crstype) : get a unique (unused) course number in domain $udom for course type $crstype (Course or Community).
14780:
14781: =item *
14782:
14783: is_course($courseid), is_course($cdom, $cnum)
14784:
14785: Accepts either a combined $courseid (in the form of domain_courseid) or the
14786: two component version $cdom, $cnum. It checks if the specified course exists.
14787:
14788: Returns:
14789: undef if the course doesn't exist, otherwise
14790: in scalar context the combined courseid.
14791: in list context the two components of the course identifier, domain and
14792: courseid.
14793:
14794: =back
14795:
14796: =head2 Resource Subroutines
14797:
14798: =over 4
14799:
14800: =item *
14801:
14802: subscribe($fname) : subscribe to a resource, returns URL if possible (probably should use repcopy instead)
14803:
14804: =item *
14805:
14806: repcopy($filename) : subscribes to the requested file, and attempts to
14807: replicate from the owning library server, Might return
14808: 'unavailable', 'not_found', 'forbidden', 'ok', or
14809: 'bad_request', also attempts to grab the metadata for the
14810: resource. Expects the local filesystem pathname
14811: (/home/httpd/html/res/....)
14812:
14813: =back
14814:
14815: =head2 Resource Information
14816:
14817: =over 4
14818:
14819: =item *
14820:
14821: EXT($varname,$symb,$udom,$uname,$usection,$recurse,$cid) : evaluates
14822: and returns the value of a variety of different possible values,
14823: $varname should be a request string, and the other parameters can be
14824: used to specify who and what one is asking about. Ordinarily, $cid
14825: does not need to be specified, as it is retrived from
14826: $env{'request.course.id'}, but &Apache::lonnet::EXT() is called
14827: within lonuserstate::loadmap() when initializing a course, before
14828: $env{'request.course.id'} has been set, so it needs to be provided
14829: in that one case.
14830:
14831: Possible values for $varname are environment.lastname (or other item
14832: from the envirnment hash), user.name (or someother aspect about the
14833: user), resource.0.maxtries (or some other part and parameter of a
14834: resource)
14835:
14836: =item *
14837:
14838: directcondval($number) : get current value of a condition; reads from a state
14839: string
14840:
14841: =item *
14842:
14843: condval($condidx) : value of condition index based on state
14844:
14845: =item *
14846:
14847: metadata($uri,$what,$toolsymb,$liburi,$prefix,$depthcount) : request a
14848: resource's metadata, $what should be either a specific key, or either
14849: 'keys' (to get a list of possible keys) or 'packages' to get a list of
14850: packages that this resource currently uses, the last 3 arguments are
14851: only used internally for recursive metadata.
14852:
14853: the toolsymb is only used where the uri is for an external tool (for which
14854: the uri as well as the symb are guaranteed to be unique).
14855:
14856: this function automatically caches all requests except any made recursively
14857: to retrieve a list of metadata keys for an imported library file ($liburi is
14858: defined).
14859:
14860: =item *
14861:
14862: metadata_query($query,$custom,$customshow) : make a metadata query against the
14863: network of library servers; returns file handle of where SQL and regex results
14864: will be stored for query
14865:
14866: =item *
14867:
14868: symbread($filename,$donotrecurse,$ignorecachednull,$checkforblock,$possibles) :
14869: return symbolic list entry (all arguments optional).
14870:
14871: Args: filename is the filename (including path) for the file for which a symb
14872: is required; donotrecurse, if true will prevent calls to allowed() being made
14873: to check access status if more than one resource was found in the bighash
14874: (see rev. 1.249) to avoid an infinite loop if an ambiguous resource is part of
14875: a randompick); ignorecachednull, if true will prevent a symb of '' being
14876: returned if $env{$cache_str} is defined as ''; checkforblock if true will
14877: cause possible symbs to be checked to determine if they are subject to content
14878: blocking, if so they will not be included as possible symbs; possibles is a
14879: ref to a hash, which, as a side effect, will be populated with all possible
14880: symbs (content blocking not tested).
14881:
14882: returns the data handle
14883:
14884: =item *
14885:
14886: symbverify($symb,$thisfn,$encstate) : verifies that $symb actually exists
14887: and is a possible symb for the URL in $thisfn, and if is an encrypted
14888: resource that the user accessed using /enc/ returns a 1 on success, 0
14889: on failure, user must be in a course, as it assumes the existence of
14890: the course initial hash, and uses $env('request.course.id'}. The third
14891: arg is an optional reference to a scalar. If this arg is passed in the
14892: call to symbverify, it will be set to 1 if the symb has been set to be
14893: encrypted; otherwise it will be null.
14894:
14895: =item *
14896:
14897: symbclean($symb) : removes versions numbers from a symb, returns the
14898: cleaned symb
14899:
14900: =item *
14901:
14902: is_on_map($uri) : checks if the $uri is somewhere on the current
14903: course map, user must be in a course for it to work.
14904:
14905: =item *
14906:
14907: numval($salt) : return random seed value (addend for rndseed)
14908:
14909: =item *
14910:
14911: rndseed($symb,$courseid,$udom,$uname) : create a random sum; returns
14912: a random seed, all arguments are optional, if they aren't sent it uses the
14913: environment to derive them. Note: if symb isn't sent and it can't get one
14914: from &symbread it will use the current time as its return value
14915:
14916: =item *
14917:
14918: ireceipt($funame,$fudom,$fucourseid,$fusymb) : return unique,
14919: unfakeable, receipt
14920:
14921: =item *
14922:
14923: receipt() : API to ireceipt working off of env values; given out to users
14924:
14925: =item *
14926:
14927: countacc($url) : count the number of accesses to a given URL
14928:
14929: =item *
14930:
14931: 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
14932:
14933: =item *
14934:
14935: 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)
14936:
14937: =item *
14938:
14939: expirespread($uname,$udom,$stype,$usymb) : set expire date for spreadsheet
14940:
14941: =item *
14942:
14943: devalidate($symb) : devalidate temporary spreadsheet calculations,
14944: forcing spreadsheet to reevaluate the resource scores next time.
14945:
14946: =item *
14947:
14948: can_edit_resource($file,$cnum,$cdom,$resurl,$symb,$group) : determine if current user can edit a particular resource,
14949: when viewing in course context.
14950:
14951: input: six args -- filename (decluttered), course number, course domain,
14952: url, symb (if registered) and group (if this is a
14953: group item -- e.g., bulletin board, group page etc.).
14954:
14955: output: array of five scalars --
14956: $cfile -- url for file editing if editable on current server
14957: $home -- homeserver of resource (i.e., for author if published,
14958: or course if uploaded.).
14959: $switchserver -- 1 if server switch will be needed.
14960: $forceedit -- 1 if icon/link should be to go to edit mode
14961: $forceview -- 1 if icon/link should be to go to view mode
14962:
14963: =item *
14964:
14965: is_course_upload($file,$cnum,$cdom)
14966:
14967: Used in course context to determine if current file was uploaded to
14968: the course (i.e., would be found in /userfiles/docs on the course's
14969: homeserver.
14970:
14971: input: 3 args -- filename (decluttered), course number and course domain.
14972: output: boolean -- 1 if file was uploaded.
14973:
14974: =back
14975:
14976: =head2 Storing/Retreiving Data
14977:
14978: =over 4
14979:
14980: =item *
14981:
14982: store($storehash,$symb,$namespace,$udom,$uname,$laststore) : stores hash
14983: permanently for this url; hashref needs to be given and should be a \%hashname;
14984: the remaining args aren't required and if they aren't passed or are '' they will
14985: be derived from the env (with the exception of $laststore, which is an
14986: optional arg used when a user's submission is stored in grading).
14987: $laststore is $version=$timestamp, where $version is the most recent version
14988: number retrieved for the corresponding $symb in the $namespace db file, and
14989: $timestamp is the timestamp for that transaction (UNIX time).
14990: $laststore is currently only passed when cstore() is called by
14991: structuretags::finalize_storage().
14992:
14993: =item *
14994:
14995: cstore($storehash,$symb,$namespace,$udom,$uname,$laststore) : same as store
14996: but uses critical subroutine
14997:
14998: =item *
14999:
15000: restore($symb,$namespace,$udom,$uname) : returns hash for this symb;
15001: all args are optional
15002:
15003: =item *
15004:
15005: dumpstore($namespace,$udom,$uname,$regexp,$range) :
15006: dumps the complete (or key matching regexp) namespace into a hash
15007: ($udom, $uname, $regexp, $range are optional) for a namespace that is
15008: normally &store()ed into
15009:
15010: $range should be either an integer '100' (give me the first 100
15011: matching records)
15012: or be two integers sperated by a - with no spaces
15013: '30-50' (give me the 30th through the 50th matching
15014: records)
15015:
15016:
15017: =item *
15018:
15019: putstore($namespace,$symb,$version,$storehash,$udomain,$uname,$tolog) :
15020: replaces a &store() version of data with a replacement set of data
15021: for a particular resource in a namespace passed in the $storehash hash
15022: reference. If $tolog is true, the transaction is logged in the courselog
15023: with an action=PUTSTORE.
15024:
15025: =item *
15026:
15027: tmpstore($storehash,$symb,$namespace,$udom,$uname) : storage that
15028: works very similar to store/cstore, but all data is stored in a
15029: temporary location and can be reset using tmpreset, $storehash should
15030: be a hash reference, returns nothing on success
15031:
15032: =item *
15033:
15034: tmprestore($symb,$namespace,$udom,$uname) : storage that works very
15035: similar to restore, but all data is stored in a temporary location and
15036: can be reset using tmpreset. Returns a hash of values on success,
15037: error string otherwise.
15038:
15039: =item *
15040:
15041: tmpreset($symb,$namespace,$udom,$uname) : temporary storage reset,
15042: deltes all keys for $symb form the temporary storage hash.
15043:
15044: =item *
15045:
15046: get($namespace,$storearr,$udom,$uname) : returns hash with keys from array
15047: reference filled in from namesp ($udom and $uname are optional)
15048:
15049: =item *
15050:
15051: del($namespace,$storearr,$udom,$uname) : deletes keys out of array from
15052: namesp ($udom and $uname are optional)
15053:
15054: =item *
15055:
15056: dump($namespace,$udom,$uname,$regexp,$range) :
15057: dumps the complete (or key matching regexp) namespace into a hash
15058: ($udom, $uname, $regexp, $range are optional)
15059:
15060: $range should be either an integer '100' (give me the first 100
15061: matching records)
15062: or be two integers sperated by a - with no spaces
15063: '30-50' (give me the 30th through the 50th matching
15064: records)
15065: =item *
15066:
15067: inc($namespace,$store,$udom,$uname) : increments $store in $namespace.
15068: $store can be a scalar, an array reference, or if the amount to be
15069: incremented is > 1, a hash reference.
15070:
15071: ($udom and $uname are optional)
15072:
15073: =item *
15074:
15075: put($namespace,$storehash,$udom,$uname) : stores hash in namesp
15076: ($udom and $uname are optional)
15077:
15078: =item *
15079:
15080: cput($namespace,$storehash,$udom,$uname) : critical put
15081: ($udom and $uname are optional)
15082:
15083: =item *
15084:
15085: newput($namespace,$storehash,$udom,$uname) :
15086:
15087: Attempts to store the items in the $storehash, but only if they don't
15088: currently exist, if this succeeds you can be certain that you have
15089: successfully created a new key value pair in the $namespace db.
15090:
15091:
15092: Args:
15093: $namespace: name of database to store values to
15094: $storehash: hashref to store to the db
15095: $udom: (optional) domain of user containing the db
15096: $uname: (optional) name of user caontaining the db
15097:
15098: Returns:
15099: 'ok' -> succeeded in storing all keys of $storehash
15100: 'key_exists: <key>' -> failed to anything out of $storehash, as at
15101: least <key> already existed in the db (other
15102: requested keys may also already exist)
15103: 'error: <msg>' -> unable to tie the DB or other error occurred
15104: 'con_lost' -> unable to contact request server
15105: 'refused' -> action was not allowed by remote machine
15106:
15107:
15108: =item *
15109:
15110: eget($namespace,$storearr,$udom,$uname) : returns hash with keys from array
15111: reference filled in from namesp (encrypts the return communication)
15112: ($udom and $uname are optional)
15113:
15114: =item *
15115:
15116: log($udom,$name,$home,$message) : write to permanent log for user; use
15117: critical subroutine
15118:
15119: =item *
15120:
15121: get_dom($namespace,$storearr,$udom,$uhome) : returns hash with keys from
15122: array reference filled in from namespace found in domain level on either
15123: specified domain server ($uhome) or primary domain server ($udom and $uhome are optional).
15124:
15125: =item *
15126:
15127: put_dom($namespace,$storehash,$udom,$uhome) : stores hash in namespace at
15128: domain level either on specified domain server ($uhome) or primary domain
15129: server ($udom and $uhome are optional)
15130:
15131: =item *
15132:
15133: get_domain_defaults($target_domain,$ignore_cache) : returns hash with defaults
15134: for: authentication, language, quotas, timezone, date locale, and portal URL in
15135: the target domain.
15136:
15137: May also include additional key => value pairs for the following groups:
15138:
15139: =over
15140:
15141: =item
15142: disk quotas (MB allocated by default to portfolios and authoring spaces).
15143:
15144: =over
15145:
15146: =item defaultquota, authorquota
15147:
15148: =back
15149:
15150: =item
15151: tools (availability of aboutme page, blog, webDAV access for authoring spaces,
15152: portfolio for users).
15153:
15154: =over
15155:
15156: =item
15157: aboutme, blog, webdav, portfolio
15158:
15159: =back
15160:
15161: =item
15162: requestcourses: ability to request courses, and how requests are processed.
15163:
15164: =over
15165:
15166: =item
15167: official, unofficial, community, textbook, placement
15168:
15169: =back
15170:
15171: =item
15172: inststatus: types of institutional affiliation, and order in which they are displayed.
15173:
15174: =over
15175:
15176: =item
15177: inststatustypes, inststatusorder, inststatusguest
15178:
15179: =back
15180:
15181: =item
15182: coursedefaults: can PDF forms can be created, default credits for courses, default quotas (MB)
15183: for course's uploaded content.
15184:
15185: =over
15186:
15187: =item
15188: canuse_pdfforms, officialcredits, unofficialcredits, textbookcredits, officialquota, unofficialquota,
15189: communityquota, textbookquota, placementquota
15190:
15191: =back
15192:
15193: =item
15194: usersessions: set options for hosting of your users in other domains, and hosting of users from other domains
15195: on your servers.
15196:
15197: =over
15198:
15199: =item
15200: remotesessions, hostedsessions
15201:
15202: =back
15203:
15204: =back
15205:
15206: In cases where a domain coordinator has never used the "Set Domain Configuration"
15207: utility to create a configuration.db file on a domain's primary library server
15208: only the following domain defaults: auth_def, auth_arg_def, lang_def
15209: -- corresponding values are authentication type (internal, krb4, krb5,
15210: or localauth), initial password or a kerberos realm, language (e.g., en-us) --
15211: will be available. Values are retrieved from cache (if current), unless the
15212: optional $ignore_cache arg is true, or from domain's configuration.db (if available),
15213: or lastly from values in lonTabs/dns_domain,tab, or lonTabs/domain.tab.
15214:
15215: Typical usage:
15216:
15217: %domdefaults = &get_domain_defaults($target_domain);
15218:
15219: =back
15220:
15221: =head2 Network Status Functions
15222:
15223: =over 4
15224:
15225: =item *
15226:
15227: dirlist() : return directory list based on URI (first arg).
15228:
15229: Inputs: 1 required, 5 optional.
15230:
15231: =over
15232:
15233: =item
15234: $uri - path to file in filesystem (starts: /res or /userfiles/). Required.
15235:
15236: =item
15237: $userdomain - domain of user/course to be listed. Extracted from $uri if absent.
15238:
15239: =item
15240: $username - username of user/course to be listed. Extracted from $uri if absent.
15241:
15242: =item
15243: $getpropath - boolean: 1 if prepend path using &propath().
15244:
15245: =item
15246: $getuserdir - boolean: 1 if prepend path for "userfiles".
15247:
15248: =item
15249: $alternateRoot - path to prepend in place of path from $uri.
15250:
15251: =back
15252:
15253: Returns: Array of up to two items.
15254:
15255: =over
15256:
15257: a reference to an array of files/subdirectories
15258:
15259: =over
15260:
15261: Each element in the array of files/subdirectories is a & separated list of
15262: item name and the result of running stat on the item. If dirlist was requested
15263: for a file instead of a directory, the item name will be ''. For a directory
15264: listing, if the item is a metadata file, the element will end &N&M
15265: (where N amd M are either 0 or 1, corresponding to obsolete set (1), or
15266: default copyright set (1).
15267:
15268: =back
15269:
15270: a scalar containing error condition (if encountered).
15271:
15272: =over
15273:
15274: =item
15275: no_host (no homeserver identified for $username:$domain).
15276:
15277: =item
15278: no_such_host (server contacted for listing not identified as valid host).
15279:
15280: =item
15281: con_lost (connection to remote server failed).
15282:
15283: =item
15284: refused (invalid $username:$domain received on lond side).
15285:
15286: =item
15287: no_such_dir (directory at specified path on lond side does not exist).
15288:
15289: =item
15290: empty (directory at specified path on lond side is empty).
15291:
15292: =over
15293:
15294: This is currently not encountered because the &ls3, &ls2,
15295: &ls (_handler) routines on the lond side do not filter out
15296: . and .. from a directory listing.
15297:
15298: =back
15299:
15300: =back
15301:
15302: =back
15303:
15304: =item *
15305:
15306: spareserver() : find server with least workload from spare.tab
15307:
15308:
15309: =item *
15310:
15311: host_from_dns($dns) : Returns the loncapa hostname corresponding to a DNS name or undef
15312: if there is no corresponding loncapa host.
15313:
15314: =back
15315:
15316:
15317: =head2 Apache Request
15318:
15319: =over 4
15320:
15321: =item *
15322:
15323: ssi($url,%hash) : server side include, does a complete request cycle on url to
15324: localhost, posts hash
15325:
15326: =back
15327:
15328: =head2 Data to String to Data
15329:
15330: =over 4
15331:
15332: =item *
15333:
15334: hash2str(%hash) : convert a hash into a string complete with escaping and '='
15335: and '&' separators, supports elements that are arrayrefs and hashrefs
15336:
15337: =item *
15338:
15339: hashref2str($hashref) : convert a hashref into a string complete with
15340: escaping and '=' and '&' separators, supports elements that are
15341: arrayrefs and hashrefs
15342:
15343: =item *
15344:
15345: arrayref2str($arrayref) : convert an arrayref into a string complete
15346: with escaping and '&' separators, supports elements that are arrayrefs
15347: and hashrefs
15348:
15349: =item *
15350:
15351: str2hash($string) : convert string to hash using unescaping and
15352: splitting on '=' and '&', supports elements that are arrayrefs and
15353: hashrefs
15354:
15355: =item *
15356:
15357: str2array($string) : convert string to hash using unescaping and
15358: splitting on '&', supports elements that are arrayrefs and hashrefs
15359:
15360: =back
15361:
15362: =head2 Logging Routines
15363:
15364:
15365: These routines allow one to make log messages in the lonnet.log and
15366: lonnet.perm logfiles.
15367:
15368: =over 4
15369:
15370: =item *
15371:
15372: logtouch() : make sure the logfile, lonnet.log, exists
15373:
15374: =item *
15375:
15376: logthis() : append message to the normal lonnet.log file, it gets
15377: preiodically rolled over and deleted.
15378:
15379: =item *
15380:
15381: logperm() : append a permanent message to lonnet.perm.log, this log
15382: file never gets deleted by any automated portion of the system, only
15383: messages of critical importance should go in here.
15384:
15385:
15386: =back
15387:
15388: =head2 General File Helper Routines
15389:
15390: =over 4
15391:
15392: =item *
15393:
15394: getfile($file,$caller) : two cases - requests for files in /res or in /uploaded.
15395: (a) files in /uploaded
15396: (i) If a local copy of the file exists -
15397: compares modification date of local copy with last-modified date for
15398: definitive version stored on home server for course. If local copy is
15399: stale, requests a new version from the home server and stores it.
15400: If the original has been removed from the home server, then local copy
15401: is unlinked.
15402: (ii) If local copy does not exist -
15403: requests the file from the home server and stores it.
15404:
15405: If $caller is 'uploadrep':
15406: This indicates a call from lonuploadrep.pm (PerlHeaderParserHandler phase)
15407: for request for files originally uploaded via DOCS.
15408: - returns 'ok' if fresh local copy now available, -1 otherwise.
15409:
15410: Otherwise:
15411: This indicates a call from the content generation phase of the request.
15412: - returns the entire contents of the file or -1.
15413:
15414: (b) files in /res
15415: - returns the entire contents of a file or -1;
15416: it properly subscribes to and replicates the file if neccessary.
15417:
15418:
15419: =item *
15420:
15421: stat_file($url) : $url is expected to be a /res/ or /uploaded/ style file
15422: reference
15423:
15424: returns either a stat() list of data about the file or an empty list
15425: if the file doesn't exist or couldn't find out about it (connection
15426: problems or user unknown)
15427:
15428: =item *
15429:
15430: filelocation($dir,$file) : returns file system location of a file
15431: based on URI; meant to be "fairly clean" absolute reference, $dir is a
15432: directory that relative $file lookups are to looked in ($dir of /a/dir
15433: and a file of ../bob will become /a/bob)
15434:
15435: =item *
15436:
15437: hreflocation($dir,$file) : returns file system location or a URL; same as
15438: filelocation except for hrefs
15439:
15440: =item *
15441:
15442: declutter() : declutters URLs -- remove beginning slashes, 'res' etc.
15443: also removes beginning /home/httpd/html unless /priv/ follows it.
15444:
15445: =back
15446:
15447: =head2 Usererfile file routines (/uploaded*)
15448:
15449: =over 4
15450:
15451: =item *
15452:
15453: userfileupload(): main rotine for putting a file in a user or course's
15454: filespace, arguments are,
15455:
15456: formname - required - this is the name of the element in $env where the
15457: filename, and the contents of the file to create/modifed exist
15458: the filename is in $env{'form.'.$formname.'.filename'} and the
15459: contents of the file is located in $env{'form.'.$formname}
15460: context - if coursedoc, store the file in the course of the active role
15461: of the current user;
15462: if 'existingfile': store in 'overwrites' in /home/httpd/perl/tmp
15463: if 'canceloverwrite': delete file in tmp/overwrites directory
15464: subdir - required - subdirectory to put the file in under ../userfiles/
15465: if undefined, it will be placed in "unknown"
15466:
15467: (This routine calls clean_filename() to remove any dangerous
15468: characters from the filename, and then calls finuserfileupload() to
15469: complete the transaction)
15470:
15471: returns either the url of the uploaded file (/uploaded/....) if successful
15472: and /adm/notfound.html if unsuccessful
15473:
15474: =item *
15475:
15476: clean_filename(): routine for cleaing a filename up for storage in
15477: userfile space, argument is:
15478:
15479: filename - proposed filename
15480:
15481: returns: the new clean filename
15482:
15483: =item *
15484:
15485: finishuserfileupload(): routine that creates and sends the file to
15486: userspace, probably shouldn't be called directly
15487:
15488: docuname: username or courseid of destination for the file
15489: docudom: domain of user/course of destination for the file
15490: formname: same as for userfileupload()
15491: fname: filename (including subdirectories) for the file
15492: parser: if 'parse', will parse (html) file to extract references to objects, links etc.
15493: allfiles: reference to hash used to store objects found by parser
15494: codebase: reference to hash used for codebases of java objects found by parser
15495: thumbwidth: width (pixels) of thumbnail to be created for uploaded image
15496: thumbheight: height (pixels) of thumbnail to be created for uploaded image
15497: resizewidth: width to be used to resize image using resizeImage from ImageMagick
15498: resizeheight: height to be used to resize image using resizeImage from ImageMagick
15499: context: if 'overwrite', will move the uploaded file from its temporary location to
15500: userfiles to facilitate overwriting a previously uploaded file with same name.
15501: mimetype: reference to scalar to accommodate mime type determined
15502: from File::MMagic if $parser = parse.
15503:
15504: returns either the url of the uploaded file (/uploaded/....) if successful
15505: and /adm/notfound.html if unsuccessful (or an error message if context
15506: was 'overwrite').
15507:
15508:
15509: =item *
15510:
15511: renameuserfile(): renames an existing userfile to a new name
15512:
15513: Args:
15514: docuname: username or courseid of destination for the file
15515: docudom: domain of user/course of destination for the file
15516: old: current file name (including any subdirs under userfiles)
15517: new: desired file name (including any subdirs under userfiles)
15518:
15519: =item *
15520:
15521: mkdiruserfile(): creates a directory is a userfiles dir
15522:
15523: Args:
15524: docuname: username or courseid of destination for the file
15525: docudom: domain of user/course of destination for the file
15526: dir: dir to create (including any subdirs under userfiles)
15527:
15528: =item *
15529:
15530: removeuserfile(): removes a file that exists in userfiles
15531:
15532: Args:
15533: docuname: username or courseid of destination for the file
15534: docudom: domain of user/course of destination for the file
15535: fname: filname to delete (including any subdirs under userfiles)
15536:
15537: =item *
15538:
15539: removeuploadedurl(): convience function for removeuserfile()
15540:
15541: Args:
15542: url: a full /uploaded/... url to delete
15543:
15544: =item *
15545:
15546: get_portfile_permissions():
15547: Args:
15548: domain: domain of user or course contain the portfolio files
15549: user: name of user or num of course contain the portfolio files
15550: Returns:
15551: hashref of a dump of the proper file_permissions.db
15552:
15553:
15554: =item *
15555:
15556: get_access_controls():
15557:
15558: Args:
15559: current_permissions: the hash ref returned from get_portfile_permissions()
15560: group: (optional) the group you want the files associated with
15561: file: (optional) the file you want access info on
15562:
15563: Returns:
15564: a hash (keys are file names) of hashes containing
15565: keys are: path to file/file_name\0uniqueID:scope_end_start (see below)
15566: values are XML containing access control settings (see below)
15567:
15568: Internal notes:
15569:
15570: access controls are stored in file_permissions.db as key=value pairs.
15571: key -> path to file/file_name\0uniqueID:scope_end_start
15572: where scope -> public,guest,course,group,domains or users.
15573: end -> UNIX time for end of access (0 -> no end date)
15574: start -> UNIX time for start of access
15575:
15576: value -> XML description of access control
15577: <scope type=""> (type =1 of: public,guest,course,group,domains,users">
15578: <start></start>
15579: <end></end>
15580:
15581: <password></password> for scope type = guest
15582:
15583: <domain></domain> for scope type = course or group
15584: <number></number>
15585: <roles id="">
15586: <role></role>
15587: <access></access>
15588: <section></section>
15589: <group></group>
15590: </roles>
15591:
15592: <dom></dom> for scope type = domains
15593:
15594: <users> for scope type = users
15595: <user>
15596: <uname></uname>
15597: <udom></udom>
15598: </user>
15599: </users>
15600: </scope>
15601:
15602: Access data is also aggregated for each file in an additional key=value pair:
15603: key -> path to file/file_name\0accesscontrol
15604: value -> reference to hash
15605: hash contains key = value pairs
15606: where key = uniqueID:scope_end_start
15607: value = UNIX time record was last updated
15608:
15609: Used to improve speed of look-ups of access controls for each file.
15610:
15611: Locks on files (resulting from submission of portfolio file to a homework problem stored in array of arrays.
15612:
15613: =item *
15614:
15615: modify_access_controls():
15616:
15617: Modifies access controls for a portfolio file
15618: Args
15619: 1. file name
15620: 2. reference to hash of required changes,
15621: 3. domain
15622: 4. username
15623: where domain,username are the domain of the portfolio owner
15624: (either a user or a course)
15625:
15626: Returns:
15627: 1. result of additions or updates ('ok' or 'error', with error message).
15628: 2. result of deletions ('ok' or 'error', with error message).
15629: 3. reference to hash of any new or updated access controls.
15630: 4. reference to hash used to map incoming IDs to uniqueIDs assigned to control.
15631: key = integer (inbound ID)
15632: value = uniqueID
15633:
15634: =item *
15635:
15636: get_timebased_id():
15637:
15638: Attempts to get a unique timestamp-based suffix for use with items added to a
15639: course via the Course Editor (e.g., folders, composite pages,
15640: group bulletin boards).
15641:
15642: Args: (first three required; six others optional)
15643:
15644: 1. prefix (alphanumeric): of keys in hash, e.g., suppsequence, docspage,
15645: docssequence, or name of group
15646:
15647: 2. keyid (alphanumeric): name of temporary locking key in hash,
15648: e.g., num, boardids
15649:
15650: 3. namespace: name of gdbm file used to store suffixes already assigned;
15651: file will be named nohist_namespace.db
15652:
15653: 4. cdom: domain of course; default is current course domain from %env
15654:
15655: 5. cnum: course number; default is current course number from %env
15656:
15657: 6. idtype: set to concat if an additional digit is to be appended to the
15658: unix timestamp to form the suffix, if the plain timestamp is already
15659: in use. Default is to not do this, but simply increment the unix
15660: timestamp by 1 until a unique key is obtained.
15661:
15662: 7. who: holder of locking key; defaults to user:domain for user.
15663:
15664: 8. locktries: number of attempts to obtain a lock (sleep of 1s before
15665: retrying); default is 3.
15666:
15667: 9. maxtries: number of attempts to obtain a unique suffix; default is 20.
15668:
15669: Returns:
15670:
15671: 1. suffix obtained (numeric)
15672:
15673: 2. result of deleting locking key (ok if deleted, or lock never obtained)
15674:
15675: 3. error: contains (localized) error message if an error occurred.
15676:
15677:
15678: =back
15679:
15680: =head2 HTTP Helper Routines
15681:
15682: =over 4
15683:
15684: =item *
15685:
15686: escape() : unpack non-word characters into CGI-compatible hex codes
15687:
15688: =item *
15689:
15690: unescape() : pack CGI-compatible hex codes into actual non-word ASCII character
15691:
15692: =back
15693:
15694: =head1 PRIVATE SUBROUTINES
15695:
15696: =head2 Underlying communication routines (Shouldn't call)
15697:
15698: =over 4
15699:
15700: =item *
15701:
15702: subreply() : tries to pass a message to lonc, returns con_lost if incapable
15703:
15704: =item *
15705:
15706: reply() : uses subreply to send a message to remote machine, logs all failures
15707:
15708: =item *
15709:
15710: critical() : passes a critical message to another server; if cannot
15711: get through then place message in connection buffer directory and
15712: returns con_delayed, if incapable of saving message, returns
15713: con_failed
15714:
15715: =item *
15716:
15717: reconlonc() : tries to reconnect lonc client processes.
15718:
15719: =back
15720:
15721: =head2 Resource Access Logging
15722:
15723: =over 4
15724:
15725: =item *
15726:
15727: flushcourselogs() : flush (save) buffer logs and access logs
15728:
15729: =item *
15730:
15731: courselog($what) : save message for course in hash
15732:
15733: =item *
15734:
15735: courseacclog($what) : save message for course using &courselog(). Perform
15736: special processing for specific resource types (problems, exams, quizzes, etc).
15737:
15738: =item *
15739:
15740: goodbye() : flush course logs and log shutting down; it is called in srm.conf
15741: as a PerlChildExitHandler
15742:
15743: =back
15744:
15745: =head2 Other
15746:
15747: =over 4
15748:
15749: =item *
15750:
15751: symblist($mapname,%newhash) : update symbolic storage links
15752:
15753: =back
15754:
15755: =cut
15756:
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