1: # The LearningOnline Network
2: # TCP networking package
3: #
4: # $Id: lonnet.pm,v 1.1172.2.93 2017/05/13 13:58:49 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 LWP::UserAgent();
75: use HTTP::Date;
76: use Image::Magick;
77:
78: use vars qw(%perlvar %spareid %pr %prp $memcache %packagetab $tmpdir
79: $_64bit %env %protocol %loncaparevs %serverhomeIDs %needsrelease
80: %managerstab);
81:
82: my (%badServerCache, $memcache, %courselogs, %accesshash, %domainrolehash,
83: %userrolehash, $processmarker, $dumpcount, %coursedombuf,
84: %coursenumbuf, %coursehombuf, %coursedescrbuf, %courseinstcodebuf,
85: %courseownerbuf, %coursetypebuf,$locknum);
86:
87: use IO::Socket;
88: use GDBM_File;
89: use HTML::LCParser;
90: use Fcntl qw(:flock);
91: use Storable qw(thaw nfreeze);
92: use Time::HiRes qw( sleep gettimeofday tv_interval );
93: use Cache::Memcached;
94: use Digest::MD5;
95: use Math::Random;
96: use File::MMagic;
97: use LONCAPA qw(:DEFAULT :match);
98: use LONCAPA::Configuration;
99: use LONCAPA::lonmetadata;
100: use LONCAPA::Lond;
101:
102: use File::Copy;
103:
104: my $readit;
105: my $max_connection_retries = 20; # Or some such value.
106:
107: require Exporter;
108:
109: our @ISA = qw (Exporter);
110: our @EXPORT = qw(%env);
111:
112: # ------------------------------------ Logging (parameters, docs, slots, roles)
113: {
114: my $logid;
115: sub write_log {
116: my ($context,$hash_name,$storehash,$delflag,$uname,$udom,$cnum,$cdom)=@_;
117: if ($context eq 'course') {
118: if (($cnum eq '') || ($cdom eq '')) {
119: $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
120: $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
121: }
122: }
123: $logid ++;
124: my $now = time();
125: my $id=$now.'00000'.$$.'00000'.$logid;
126: my $logentry = {
127: $id => {
128: 'exe_uname' => $env{'user.name'},
129: 'exe_udom' => $env{'user.domain'},
130: 'exe_time' => $now,
131: 'exe_ip' => $ENV{'REMOTE_ADDR'},
132: 'delflag' => $delflag,
133: 'logentry' => $storehash,
134: 'uname' => $uname,
135: 'udom' => $udom,
136: }
137: };
138: return &put('nohist_'.$hash_name,$logentry,$cdom,$cnum);
139: }
140: }
141:
142: sub logtouch {
143: my $execdir=$perlvar{'lonDaemons'};
144: unless (-e "$execdir/logs/lonnet.log") {
145: open(my $fh,">>$execdir/logs/lonnet.log");
146: close $fh;
147: }
148: my ($wwwuid,$wwwgid)=(getpwnam('www'))[2,3];
149: chown($wwwuid,$wwwgid,$execdir.'/logs/lonnet.log');
150: }
151:
152: sub logthis {
153: my $message=shift;
154: my $execdir=$perlvar{'lonDaemons'};
155: my $now=time;
156: my $local=localtime($now);
157: if (open(my $fh,">>$execdir/logs/lonnet.log")) {
158: my $logstring = $local. " ($$): ".$message."\n"; # Keep any \'s in string.
159: print $fh $logstring;
160: close($fh);
161: }
162: return 1;
163: }
164:
165: sub logperm {
166: my $message=shift;
167: my $execdir=$perlvar{'lonDaemons'};
168: my $now=time;
169: my $local=localtime($now);
170: if (open(my $fh,">>$execdir/logs/lonnet.perm.log")) {
171: print $fh "$now:$message:$local\n";
172: close($fh);
173: }
174: return 1;
175: }
176:
177: sub create_connection {
178: my ($hostname,$lonid) = @_;
179: my $client=IO::Socket::UNIX->new(Peer => $perlvar{'lonSockCreate'},
180: Type => SOCK_STREAM,
181: Timeout => 10);
182: return 0 if (!$client);
183: print $client (join(':',$hostname,$lonid,&machine_ids($hostname))."\n");
184: my $result = <$client>;
185: chomp($result);
186: return 1 if ($result eq 'done');
187: return 0;
188: }
189:
190: sub get_server_timezone {
191: my ($cnum,$cdom) = @_;
192: my $home=&homeserver($cnum,$cdom);
193: if ($home ne 'no_host') {
194: my $cachetime = 24*3600;
195: my ($timezone,$cached)=&is_cached_new('servertimezone',$home);
196: if (defined($cached)) {
197: return $timezone;
198: } else {
199: my $timezone = &reply('servertimezone',$home);
200: return &do_cache_new('servertimezone',$home,$timezone,$cachetime);
201: }
202: }
203: }
204:
205: sub get_server_distarch {
206: my ($lonhost,$ignore_cache) = @_;
207: if (defined($lonhost)) {
208: if (!defined(&hostname($lonhost))) {
209: return;
210: }
211: my $cachetime = 12*3600;
212: if (!$ignore_cache) {
213: my ($distarch,$cached)=&is_cached_new('serverdistarch',$lonhost);
214: if (defined($cached)) {
215: return $distarch;
216: }
217: }
218: my $rep = &reply('serverdistarch',$lonhost);
219: unless ($rep eq 'unknown_command' || $rep eq 'no_such_host' ||
220: $rep eq 'con_lost' || $rep eq 'rejected' || $rep eq 'refused' ||
221: $rep eq '') {
222: return &do_cache_new('serverdistarch',$lonhost,$rep,$cachetime);
223: }
224: }
225: return;
226: }
227:
228: sub get_server_loncaparev {
229: my ($dom,$lonhost,$ignore_cache,$caller) = @_;
230: if (defined($lonhost)) {
231: if (!defined(&hostname($lonhost))) {
232: undef($lonhost);
233: }
234: }
235: if (!defined($lonhost)) {
236: if (defined(&domain($dom,'primary'))) {
237: $lonhost=&domain($dom,'primary');
238: if ($lonhost eq 'no_host') {
239: undef($lonhost);
240: }
241: }
242: }
243: if (defined($lonhost)) {
244: my $cachetime = 12*3600;
245: if (!$ignore_cache) {
246: my ($loncaparev,$cached)=&is_cached_new('serverloncaparev',$lonhost);
247: if (defined($cached)) {
248: return $loncaparev;
249: }
250: }
251: my ($answer,$loncaparev);
252: my @ids=¤t_machine_ids();
253: if (grep(/^\Q$lonhost\E$/,@ids)) {
254: $answer = $perlvar{'lonVersion'};
255: if ($answer =~ /^[\'\"]?([\w.\-]+)[\'\"]?$/) {
256: $loncaparev = $1;
257: }
258: } else {
259: $answer = &reply('serverloncaparev',$lonhost);
260: if (($answer eq 'unknown_cmd') || ($answer eq 'con_lost')) {
261: if ($caller eq 'loncron') {
262: my $ua=new LWP::UserAgent;
263: $ua->timeout(4);
264: my $protocol = $protocol{$lonhost};
265: $protocol = 'http' if ($protocol ne 'https');
266: my $url = $protocol.'://'.&hostname($lonhost).'/adm/about.html';
267: my $request=new HTTP::Request('GET',$url);
268: my $response=$ua->request($request);
269: unless ($response->is_error()) {
270: my $content = $response->content;
271: if ($content =~ /<p>VERSION\:\s*([\w.\-]+)<\/p>/) {
272: $loncaparev = $1;
273: }
274: }
275: } else {
276: $loncaparev = $loncaparevs{$lonhost};
277: }
278: } elsif ($answer =~ /^[\'\"]?([\w.\-]+)[\'\"]?$/) {
279: $loncaparev = $1;
280: }
281: }
282: return &do_cache_new('serverloncaparev',$lonhost,$loncaparev,$cachetime);
283: }
284: }
285:
286: sub get_server_homeID {
287: my ($hostname,$ignore_cache,$caller) = @_;
288: unless ($ignore_cache) {
289: my ($serverhomeID,$cached)=&is_cached_new('serverhomeID',$hostname);
290: if (defined($cached)) {
291: return $serverhomeID;
292: }
293: }
294: my $cachetime = 12*3600;
295: my $serverhomeID;
296: if ($caller eq 'loncron') {
297: my @machine_ids = &machine_ids($hostname);
298: foreach my $id (@machine_ids) {
299: my $response = &reply('serverhomeID',$id);
300: unless (($response eq 'unknown_cmd') || ($response eq 'con_lost')) {
301: $serverhomeID = $response;
302: last;
303: }
304: }
305: if ($serverhomeID eq '') {
306: $serverhomeID = $machine_ids[-1];
307: }
308: } else {
309: $serverhomeID = $serverhomeIDs{$hostname};
310: }
311: return &do_cache_new('serverhomeID',$hostname,$serverhomeID,$cachetime);
312: }
313:
314: sub get_remote_globals {
315: my ($lonhost,$whathash,$ignore_cache) = @_;
316: my ($result,%returnhash,%whatneeded);
317: if (ref($whathash) eq 'HASH') {
318: foreach my $what (sort(keys(%{$whathash}))) {
319: my $hashid = $lonhost.'-'.$what;
320: my ($response,$cached);
321: unless ($ignore_cache) {
322: ($response,$cached)=&is_cached_new('lonnetglobal',$hashid);
323: }
324: if (defined($cached)) {
325: $returnhash{$what} = $response;
326: } else {
327: $whatneeded{$what} = 1;
328: }
329: }
330: if (keys(%whatneeded) == 0) {
331: $result = 'ok';
332: } else {
333: my $requested = &freeze_escape(\%whatneeded);
334: my $rep=&reply('readlonnetglobal:'.$requested,$lonhost);
335: if (($rep=~/^(refused|rejected|error)/) || ($rep eq 'con_lost') ||
336: ($rep eq 'unknown_cmd')) {
337: $result = $rep;
338: } else {
339: $result = 'ok';
340: my @pairs=split(/\&/,$rep);
341: foreach my $item (@pairs) {
342: my ($key,$value)=split(/=/,$item,2);
343: my $what = &unescape($key);
344: my $hashid = $lonhost.'-'.$what;
345: $returnhash{$what}=&thaw_unescape($value);
346: &do_cache_new('lonnetglobal',$hashid,$returnhash{$what},600);
347: }
348: }
349: }
350: }
351: return ($result,\%returnhash);
352: }
353:
354: sub remote_devalidate_cache {
355: my ($lonhost,$cachekeys) = @_;
356: my $items;
357: return unless (ref($cachekeys) eq 'ARRAY');
358: my $cachestr = join('&',@{$cachekeys});
359: return &reply('devalidatecache:'.&escape($cachestr),$lonhost);
360: }
361:
362: # -------------------------------------------------- Non-critical communication
363: sub subreply {
364: my ($cmd,$server)=@_;
365: my $peerfile="$perlvar{'lonSockDir'}/".&hostname($server);
366: #
367: # With loncnew process trimming, there's a timing hole between lonc server
368: # process exit and the master server picking up the listen on the AF_UNIX
369: # socket. In that time interval, a lock file will exist:
370:
371: my $lockfile=$peerfile.".lock";
372: while (-e $lockfile) { # Need to wait for the lockfile to disappear.
373: sleep(0.1);
374: }
375: # At this point, either a loncnew parent is listening or an old lonc
376: # or loncnew child is listening so we can connect or everything's dead.
377: #
378: # We'll give the connection a few tries before abandoning it. If
379: # connection is not possible, we'll con_lost back to the client.
380: #
381: my $client;
382: for (my $retries = 0; $retries < $max_connection_retries; $retries++) {
383: $client=IO::Socket::UNIX->new(Peer =>"$peerfile",
384: Type => SOCK_STREAM,
385: Timeout => 10);
386: if ($client) {
387: last; # Connected!
388: } else {
389: &create_connection(&hostname($server),$server);
390: }
391: sleep(0.1); # Try again later if failed connection.
392: }
393: my $answer;
394: if ($client) {
395: print $client "sethost:$server:$cmd\n";
396: $answer=<$client>;
397: if (!$answer) { $answer="con_lost"; }
398: chomp($answer);
399: } else {
400: $answer = 'con_lost'; # Failed connection.
401: }
402: return $answer;
403: }
404:
405: sub reply {
406: my ($cmd,$server)=@_;
407: unless (defined(&hostname($server))) { return 'no_such_host'; }
408: my $answer=subreply($cmd,$server);
409: if (($answer=~/^refused/) || ($answer=~/^rejected/)) {
410: &logthis("<font color=\"blue\">WARNING:".
411: " $cmd to $server returned $answer</font>");
412: }
413: return $answer;
414: }
415:
416: # ----------------------------------------------------------- Send USR1 to lonc
417:
418: sub reconlonc {
419: my ($lonid) = @_;
420: if ($lonid) {
421: my $hostname = &hostname($lonid);
422: my $peerfile="$perlvar{'lonSockDir'}/$hostname";
423: if ($hostname && -e $peerfile) {
424: &logthis("Trying to reconnect lonc for $lonid ($hostname)");
425: my $client=IO::Socket::UNIX->new(Peer => $peerfile,
426: Type => SOCK_STREAM,
427: Timeout => 10);
428: if ($client) {
429: print $client ("reset_retries\n");
430: my $answer=<$client>;
431: #reset just this one.
432: }
433: }
434: return;
435: }
436:
437: &logthis("Trying to reconnect lonc");
438: my $loncfile="$perlvar{'lonDaemons'}/logs/lonc.pid";
439: if (open(my $fh,"<$loncfile")) {
440: my $loncpid=<$fh>;
441: chomp($loncpid);
442: if (kill 0 => $loncpid) {
443: &logthis("lonc at pid $loncpid responding, sending USR1");
444: kill USR1 => $loncpid;
445: sleep 1;
446: } else {
447: &logthis(
448: "<font color=\"blue\">WARNING:".
449: " lonc at pid $loncpid not responding, giving up</font>");
450: }
451: } else {
452: &logthis('<font color="blue">WARNING: lonc not running, giving up</font>');
453: }
454: }
455:
456: # ------------------------------------------------------ Critical communication
457:
458: sub critical {
459: my ($cmd,$server)=@_;
460: unless (&hostname($server)) {
461: &logthis("<font color=\"blue\">WARNING:".
462: " Critical message to unknown server ($server)</font>");
463: return 'no_such_host';
464: }
465: my $answer=reply($cmd,$server);
466: if ($answer eq 'con_lost') {
467: &reconlonc($server);
468: my $answer=reply($cmd,$server);
469: if ($answer eq 'con_lost') {
470: my $now=time;
471: my $middlename=$cmd;
472: $middlename=substr($middlename,0,16);
473: $middlename=~s/\W//g;
474: my $dfilename=
475: "$perlvar{'lonSockDir'}/delayed/$now.$dumpcount.$$.$middlename.$server";
476: $dumpcount++;
477: {
478: my $dfh;
479: if (open($dfh,">$dfilename")) {
480: print $dfh "$cmd\n";
481: close($dfh);
482: }
483: }
484: sleep 1;
485: my $wcmd='';
486: {
487: my $dfh;
488: if (open($dfh,"<$dfilename")) {
489: $wcmd=<$dfh>;
490: close($dfh);
491: }
492: }
493: chomp($wcmd);
494: if ($wcmd eq $cmd) {
495: &logthis("<font color=\"blue\">WARNING: ".
496: "Connection buffer $dfilename: $cmd</font>");
497: &logperm("D:$server:$cmd");
498: return 'con_delayed';
499: } else {
500: &logthis("<font color=\"red\">CRITICAL:"
501: ." Critical connection failed: $server $cmd</font>");
502: &logperm("F:$server:$cmd");
503: return 'con_failed';
504: }
505: }
506: }
507: return $answer;
508: }
509:
510: # ------------------------------------------- check if return value is an error
511:
512: sub error {
513: my ($result) = @_;
514: if ($result =~ /^(con_lost|no_such_host|error: (\d+) (.*))/) {
515: if ($2 == 2) { return undef; }
516: return $1;
517: }
518: return undef;
519: }
520:
521: sub convert_and_load_session_env {
522: my ($lonidsdir,$handle)=@_;
523: my @profile;
524: {
525: my $opened = open(my $idf,'+<',"$lonidsdir/$handle.id");
526: if (!$opened) {
527: return 0;
528: }
529: flock($idf,LOCK_SH);
530: @profile=<$idf>;
531: close($idf);
532: }
533: my %temp_env;
534: foreach my $line (@profile) {
535: if ($line !~ m/=/) {
536: return 0;
537: }
538: chomp($line);
539: my ($envname,$envvalue)=split(/=/,$line,2);
540: $temp_env{&unescape($envname)} = &unescape($envvalue);
541: }
542: unlink("$lonidsdir/$handle.id");
543: if (tie(my %disk_env,'GDBM_File',"$lonidsdir/$handle.id",&GDBM_WRCREAT(),
544: 0640)) {
545: %disk_env = %temp_env;
546: @env{keys(%temp_env)} = @disk_env{keys(%temp_env)};
547: untie(%disk_env);
548: }
549: return 1;
550: }
551:
552: # ------------------------------------------- Transfer profile into environment
553: my $env_loaded;
554: sub transfer_profile_to_env {
555: my ($lonidsdir,$handle,$force_transfer) = @_;
556: if (!$force_transfer && $env_loaded) { return; }
557:
558: if (!defined($lonidsdir)) {
559: $lonidsdir = $perlvar{'lonIDsDir'};
560: }
561: if (!defined($handle)) {
562: ($handle) = ($env{'user.environment'} =~m|/([^/]+)\.id$| );
563: }
564:
565: my $convert;
566: {
567: my $opened = open(my $idf,'+<',"$lonidsdir/$handle.id");
568: if (!$opened) {
569: return;
570: }
571: flock($idf,LOCK_SH);
572: if (tie(my %disk_env,'GDBM_File',"$lonidsdir/$handle.id",
573: &GDBM_READER(),0640)) {
574: @env{keys(%disk_env)} = @disk_env{keys(%disk_env)};
575: untie(%disk_env);
576: } else {
577: $convert = 1;
578: }
579: }
580: if ($convert) {
581: if (!&convert_and_load_session_env($lonidsdir,$handle)) {
582: &logthis("Failed to load session, or convert session.");
583: }
584: }
585:
586: my %remove;
587: while ( my $envname = each(%env) ) {
588: if (my ($key,$time) = ($envname =~ /^(cgi\.(\d+)_\d+\.)/)) {
589: if ($time < time-300) {
590: $remove{$key}++;
591: }
592: }
593: }
594:
595: $env{'user.environment'} = "$lonidsdir/$handle.id";
596: $env_loaded=1;
597: foreach my $expired_key (keys(%remove)) {
598: &delenv($expired_key);
599: }
600: }
601:
602: # ---------------------------------------------------- Check for valid session
603: sub check_for_valid_session {
604: my ($r,$name,$userhashref) = @_;
605: my %cookies=CGI::Cookie->parse($r->header_in('Cookie'));
606: if ($name eq '') {
607: $name = 'lonID';
608: }
609: my $lonid=$cookies{$name};
610: return undef if (!$lonid);
611:
612: my $handle=&LONCAPA::clean_handle($lonid->value);
613: my $lonidsdir;
614: if ($name eq 'lonDAV') {
615: $lonidsdir=$r->dir_config('lonDAVsessDir');
616: } else {
617: $lonidsdir=$r->dir_config('lonIDsDir');
618: }
619: return undef if (!-e "$lonidsdir/$handle.id");
620:
621: my $opened = open(my $idf,'+<',"$lonidsdir/$handle.id");
622: return undef if (!$opened);
623:
624: flock($idf,LOCK_SH);
625: my %disk_env;
626: if (!tie(%disk_env,'GDBM_File',"$lonidsdir/$handle.id",
627: &GDBM_READER(),0640)) {
628: return undef;
629: }
630:
631: if (!defined($disk_env{'user.name'})
632: || !defined($disk_env{'user.domain'})) {
633: return undef;
634: }
635:
636: if (ref($userhashref) eq 'HASH') {
637: $userhashref->{'name'} = $disk_env{'user.name'};
638: $userhashref->{'domain'} = $disk_env{'user.domain'};
639: }
640:
641: return $handle;
642: }
643:
644: sub timed_flock {
645: my ($file,$lock_type) = @_;
646: my $failed=0;
647: eval {
648: local $SIG{__DIE__}='DEFAULT';
649: local $SIG{ALRM}=sub {
650: $failed=1;
651: die("failed lock");
652: };
653: alarm(13);
654: flock($file,$lock_type);
655: alarm(0);
656: };
657: if ($failed) {
658: return undef;
659: } else {
660: return 1;
661: }
662: }
663:
664: # ---------------------------------------------------------- Append Environment
665:
666: sub appenv {
667: my ($newenv,$roles) = @_;
668: if (ref($newenv) eq 'HASH') {
669: foreach my $key (keys(%{$newenv})) {
670: my $refused = 0;
671: if (($key =~ /^user\.role/) || ($key =~ /^user\.priv/)) {
672: $refused = 1;
673: if (ref($roles) eq 'ARRAY') {
674: my ($type,$role) = ($key =~ m{^user\.(role|priv)\.(.+?)\./});
675: if (grep(/^\Q$role\E$/,@{$roles})) {
676: $refused = 0;
677: }
678: }
679: }
680: if ($refused) {
681: &logthis("<font color=\"blue\">WARNING: ".
682: "Attempt to modify environment ".$key." to ".$newenv->{$key}
683: .'</font>');
684: delete($newenv->{$key});
685: } else {
686: $env{$key}=$newenv->{$key};
687: }
688: }
689: my $opened = open(my $env_file,'+<',$env{'user.environment'});
690: if ($opened
691: && &timed_flock($env_file,LOCK_EX)
692: &&
693: tie(my %disk_env,'GDBM_File',$env{'user.environment'},
694: (&GDBM_WRITER()|&GDBM_NOLOCK()),0640)) {
695: while (my ($key,$value) = each(%{$newenv})) {
696: $disk_env{$key} = $value;
697: }
698: untie(%disk_env);
699: }
700: }
701: return 'ok';
702: }
703: # ----------------------------------------------------- Delete from Environment
704:
705: sub delenv {
706: my ($delthis,$regexp,$roles) = @_;
707: if (($delthis=~/^user\.role/) || ($delthis=~/^user\.priv/)) {
708: my $refused = 1;
709: if (ref($roles) eq 'ARRAY') {
710: my ($type,$role) = ($delthis =~ /^user\.(role|priv)\.([^.]+)\./);
711: if (grep(/^\Q$role\E$/,@{$roles})) {
712: $refused = 0;
713: }
714: }
715: if ($refused) {
716: &logthis("<font color=\"blue\">WARNING: ".
717: "Attempt to delete from environment ".$delthis);
718: return 'error';
719: }
720: }
721: my $opened = open(my $env_file,'+<',$env{'user.environment'});
722: if ($opened
723: && &timed_flock($env_file,LOCK_EX)
724: &&
725: tie(my %disk_env,'GDBM_File',$env{'user.environment'},
726: (&GDBM_WRITER()|&GDBM_NOLOCK()),0640)) {
727: foreach my $key (keys(%disk_env)) {
728: if ($regexp) {
729: if ($key=~/^$delthis/) {
730: delete($env{$key});
731: delete($disk_env{$key});
732: }
733: } else {
734: if ($key=~/^\Q$delthis\E/) {
735: delete($env{$key});
736: delete($disk_env{$key});
737: }
738: }
739: }
740: untie(%disk_env);
741: }
742: return 'ok';
743: }
744:
745: sub get_env_multiple {
746: my ($name) = @_;
747: my @values;
748: if (defined($env{$name})) {
749: # exists is it an array
750: if (ref($env{$name})) {
751: @values=@{ $env{$name} };
752: } else {
753: $values[0]=$env{$name};
754: }
755: }
756: return(@values);
757: }
758:
759: # ------------------------------------------------------------------- Locking
760:
761: sub set_lock {
762: my ($text)=@_;
763: $locknum++;
764: my $id=$$.'-'.$locknum;
765: &appenv({'session.locks' => $env{'session.locks'}.','.$id,
766: 'session.lock.'.$id => $text});
767: return $id;
768: }
769:
770: sub get_locks {
771: my $num=0;
772: my %texts=();
773: foreach my $lock (split(/\,/,$env{'session.locks'})) {
774: if ($lock=~/\w/) {
775: $num++;
776: $texts{$lock}=$env{'session.lock.'.$lock};
777: }
778: }
779: return ($num,%texts);
780: }
781:
782: sub remove_lock {
783: my ($id)=@_;
784: my $newlocks='';
785: foreach my $lock (split(/\,/,$env{'session.locks'})) {
786: if (($lock=~/\w/) && ($lock ne $id)) {
787: $newlocks.=','.$lock;
788: }
789: }
790: &appenv({'session.locks' => $newlocks});
791: &delenv('session.lock.'.$id);
792: }
793:
794: sub remove_all_locks {
795: my $activelocks=$env{'session.locks'};
796: foreach my $lock (split(/\,/,$env{'session.locks'})) {
797: if ($lock=~/\w/) {
798: &remove_lock($lock);
799: }
800: }
801: }
802:
803:
804: # ------------------------------------------ Find out current server userload
805: sub userload {
806: my $numusers=0;
807: {
808: opendir(LONIDS,$perlvar{'lonIDsDir'});
809: my $filename;
810: my $curtime=time;
811: while ($filename=readdir(LONIDS)) {
812: next if ($filename eq '.' || $filename eq '..');
813: next if ($filename =~ /publicuser_\d+\.id/);
814: my ($mtime)=(stat($perlvar{'lonIDsDir'}.'/'.$filename))[9];
815: if ($curtime-$mtime < 1800) { $numusers++; }
816: }
817: closedir(LONIDS);
818: }
819: my $userloadpercent=0;
820: my $maxuserload=$perlvar{'lonUserLoadLim'};
821: if ($maxuserload) {
822: $userloadpercent=100*$numusers/$maxuserload;
823: }
824: $userloadpercent=sprintf("%.2f",$userloadpercent);
825: return $userloadpercent;
826: }
827:
828: # ------------------------------ Find server with least workload from spare.tab
829:
830: sub spareserver {
831: my ($loadpercent,$userloadpercent,$want_server_name,$udom) = @_;
832: my $spare_server;
833: if ($userloadpercent !~ /\d/) { $userloadpercent=0; }
834: my $lowest_load=($loadpercent > $userloadpercent) ? $loadpercent
835: : $userloadpercent;
836: my ($uint_dom,$remotesessions);
837: if (($udom ne '') && (&domain($udom) ne '')) {
838: my $uprimary_id = &Apache::lonnet::domain($udom,'primary');
839: $uint_dom = &Apache::lonnet::internet_dom($uprimary_id);
840: my %udomdefaults = &Apache::lonnet::get_domain_defaults($udom);
841: $remotesessions = $udomdefaults{'remotesessions'};
842: }
843: my $spareshash = &this_host_spares($udom);
844: if (ref($spareshash) eq 'HASH') {
845: if (ref($spareshash->{'primary'}) eq 'ARRAY') {
846: foreach my $try_server (@{ $spareshash->{'primary'} }) {
847: next unless (&spare_can_host($udom,$uint_dom,$remotesessions,
848: $try_server));
849: ($spare_server, $lowest_load) =
850: &compare_server_load($try_server, $spare_server, $lowest_load);
851: }
852: }
853:
854: my $found_server = ($spare_server ne '' && $lowest_load < 100);
855:
856: if (!$found_server) {
857: if (ref($spareshash->{'default'}) eq 'ARRAY') {
858: foreach my $try_server (@{ $spareshash->{'default'} }) {
859: next unless (&spare_can_host($udom,$uint_dom,
860: $remotesessions,$try_server));
861: ($spare_server, $lowest_load) =
862: &compare_server_load($try_server, $spare_server, $lowest_load);
863: }
864: }
865: }
866: }
867:
868: if (!$want_server_name) {
869: my $protocol = 'http';
870: if ($protocol{$spare_server} eq 'https') {
871: $protocol = $protocol{$spare_server};
872: }
873: if (defined($spare_server)) {
874: my $hostname = &hostname($spare_server);
875: if (defined($hostname)) {
876: $spare_server = $protocol.'://'.$hostname;
877: }
878: }
879: }
880: return $spare_server;
881: }
882:
883: sub compare_server_load {
884: my ($try_server, $spare_server, $lowest_load, $required) = @_;
885:
886: if ($required) {
887: my ($reqdmajor,$reqdminor) = ($required =~ /^(\d+)\.(\d+)$/);
888: my $remoterev = &get_server_loncaparev(undef,$try_server);
889: my ($major,$minor) = ($remoterev =~ /^\'?(\d+)\.(\d+)\.[\w.\-]+\'?$/);
890: if (($major eq '' && $minor eq '') ||
891: (($reqdmajor > $major) || (($reqdmajor == $major) && ($reqdminor > $minor)))) {
892: return ($spare_server,$lowest_load);
893: }
894: }
895:
896: my $loadans = &reply('load', $try_server);
897: my $userloadans = &reply('userload',$try_server);
898:
899: if ($loadans !~ /\d/ && $userloadans !~ /\d/) {
900: return ($spare_server, $lowest_load); #didn't get a number from the server
901: }
902:
903: my $load;
904: if ($loadans =~ /\d/) {
905: if ($userloadans =~ /\d/) {
906: #both are numbers, pick the bigger one
907: $load = ($loadans > $userloadans) ? $loadans
908: : $userloadans;
909: } else {
910: $load = $loadans;
911: }
912: } else {
913: $load = $userloadans;
914: }
915:
916: if (($load =~ /\d/) && ($load < $lowest_load)) {
917: $spare_server = $try_server;
918: $lowest_load = $load;
919: }
920: return ($spare_server,$lowest_load);
921: }
922:
923: # --------------------------- ask offload servers if user already has a session
924: sub find_existing_session {
925: my ($udom,$uname) = @_;
926: my $spareshash = &this_host_spares($udom);
927: if (ref($spareshash) eq 'HASH') {
928: if (ref($spareshash->{'primary'}) eq 'ARRAY') {
929: foreach my $try_server (@{ $spareshash->{'primary'} }) {
930: return $try_server if (&has_user_session($try_server, $udom, $uname));
931: }
932: }
933: if (ref($spareshash->{'default'}) eq 'ARRAY') {
934: foreach my $try_server (@{ $spareshash->{'default'} }) {
935: return $try_server if (&has_user_session($try_server, $udom, $uname));
936: }
937: }
938: }
939: return;
940: }
941:
942: # -------------------------------- ask if server already has a session for user
943: sub has_user_session {
944: my ($lonid,$udom,$uname) = @_;
945: my $result = &reply(join(':','userhassession',
946: map {&escape($_)} ($udom,$uname)),$lonid);
947: return 1 if ($result eq 'ok');
948:
949: return 0;
950: }
951:
952: # --------- determine least loaded server in a user's domain which allows login
953:
954: sub choose_server {
955: my ($udom,$checkloginvia,$required,$skiploadbal) = @_;
956: my %domconfhash = &Apache::loncommon::get_domainconf($udom);
957: my %servers = &get_servers($udom);
958: my $lowest_load = 30000;
959: my ($login_host,$hostname,$portal_path,$isredirect,$balancers);
960: if ($skiploadbal) {
961: ($balancers,my $cached)=&is_cached_new('loadbalancing',$udom);
962: unless (defined($cached)) {
963: my $cachetime = 60*60*24;
964: my %domconfig =
965: &Apache::lonnet::get_dom('configuration',['loadbalancing'],$udom);
966: if (ref($domconfig{'loadbalancing'}) eq 'HASH') {
967: $balancers = &do_cache_new('loadbalancing',$udom,$domconfig{'loadbalancing'},
968: $cachetime);
969: }
970: }
971: }
972: foreach my $lonhost (keys(%servers)) {
973: my $loginvia;
974: if ($skiploadbal) {
975: if (ref($balancers) eq 'HASH') {
976: next if (exists($balancers->{$lonhost}));
977: }
978: }
979: if ($checkloginvia) {
980: $loginvia = $domconfhash{$udom.'.login.loginvia_'.$lonhost};
981: if ($loginvia) {
982: my ($server,$path) = split(/:/,$loginvia);
983: ($login_host, $lowest_load) =
984: &compare_server_load($server, $login_host, $lowest_load, $required);
985: if ($login_host eq $server) {
986: $portal_path = $path;
987: $isredirect = 1;
988: }
989: } else {
990: ($login_host, $lowest_load) =
991: &compare_server_load($lonhost, $login_host, $lowest_load, $required);
992: if ($login_host eq $lonhost) {
993: $portal_path = '';
994: $isredirect = '';
995: }
996: }
997: } else {
998: ($login_host, $lowest_load) =
999: &compare_server_load($lonhost, $login_host, $lowest_load, $required);
1000: }
1001: }
1002: if ($login_host ne '') {
1003: $hostname = &hostname($login_host);
1004: }
1005: return ($login_host,$hostname,$portal_path,$isredirect,$lowest_load);
1006: }
1007:
1008: # --------------------------------------------- Try to change a user's password
1009:
1010: sub changepass {
1011: my ($uname,$udom,$currentpass,$newpass,$server,$context)=@_;
1012: $currentpass = &escape($currentpass);
1013: $newpass = &escape($newpass);
1014: my $lonhost = $perlvar{'lonHostID'};
1015: my $answer = reply("encrypt:passwd:$udom:$uname:$currentpass:$newpass:$context:$lonhost",
1016: $server);
1017: if (! $answer) {
1018: &logthis("No reply on password change request to $server ".
1019: "by $uname in domain $udom.");
1020: } elsif ($answer =~ "^ok") {
1021: &logthis("$uname in $udom successfully changed their password ".
1022: "on $server.");
1023: } elsif ($answer =~ "^pwchange_failure") {
1024: &logthis("$uname in $udom was unable to change their password ".
1025: "on $server. The action was blocked by either lcpasswd ".
1026: "or pwchange");
1027: } elsif ($answer =~ "^non_authorized") {
1028: &logthis("$uname in $udom did not get their password correct when ".
1029: "attempting to change it on $server.");
1030: } elsif ($answer =~ "^auth_mode_error") {
1031: &logthis("$uname in $udom attempted to change their password despite ".
1032: "not being locally or internally authenticated on $server.");
1033: } elsif ($answer =~ "^unknown_user") {
1034: &logthis("$uname in $udom attempted to change their password ".
1035: "on $server but were unable to because $server is not ".
1036: "their home server.");
1037: } elsif ($answer =~ "^refused") {
1038: &logthis("$server refused to change $uname in $udom password because ".
1039: "it was sent an unencrypted request to change the password.");
1040: } elsif ($answer =~ "invalid_client") {
1041: &logthis("$server refused to change $uname in $udom password because ".
1042: "it was a reset by e-mail originating from an invalid server.");
1043: }
1044: return $answer;
1045: }
1046:
1047: # ----------------------- Try to determine user's current authentication scheme
1048:
1049: sub queryauthenticate {
1050: my ($uname,$udom)=@_;
1051: my $uhome=&homeserver($uname,$udom);
1052: if (!$uhome) {
1053: &logthis("User $uname at $udom is unknown when looking for authentication mechanism");
1054: return 'no_host';
1055: }
1056: my $answer=reply("encrypt:currentauth:$udom:$uname",$uhome);
1057: if ($answer =~ /^(unknown_user|refused|con_lost)/) {
1058: &logthis("User $uname at $udom threw error $answer when checking authentication mechanism");
1059: }
1060: return $answer;
1061: }
1062:
1063: # --------- Try to authenticate user from domain's lib servers (first this one)
1064:
1065: sub authenticate {
1066: my ($uname,$upass,$udom,$checkdefauth,$clientcancheckhost)=@_;
1067: $upass=&escape($upass);
1068: $uname= &LONCAPA::clean_username($uname);
1069: my $uhome=&homeserver($uname,$udom,1);
1070: my $newhome;
1071: if ((!$uhome) || ($uhome eq 'no_host')) {
1072: # Maybe the machine was offline and only re-appeared again recently?
1073: &reconlonc();
1074: # One more
1075: $uhome=&homeserver($uname,$udom,1);
1076: if (($uhome eq 'no_host') && $checkdefauth) {
1077: if (defined(&domain($udom,'primary'))) {
1078: $newhome=&domain($udom,'primary');
1079: }
1080: if ($newhome ne '') {
1081: $uhome = $newhome;
1082: }
1083: }
1084: if ((!$uhome) || ($uhome eq 'no_host')) {
1085: &logthis("User $uname at $udom is unknown in authenticate");
1086: return 'no_host';
1087: }
1088: }
1089: my $answer=reply("encrypt:auth:$udom:$uname:$upass:$checkdefauth:$clientcancheckhost",$uhome);
1090: if ($answer eq 'authorized') {
1091: if ($newhome) {
1092: &logthis("User $uname at $udom authorized by $uhome, but needs account");
1093: return 'no_account_on_host';
1094: } else {
1095: &logthis("User $uname at $udom authorized by $uhome");
1096: return $uhome;
1097: }
1098: }
1099: if ($answer eq 'non_authorized') {
1100: &logthis("User $uname at $udom rejected by $uhome");
1101: return 'no_host';
1102: }
1103: &logthis("User $uname at $udom threw error $answer when checking authentication mechanism");
1104: return 'no_host';
1105: }
1106:
1107: sub can_host_session {
1108: my ($udom,$lonhost,$remoterev,$remotesessions,$hostedsessions) = @_;
1109: my $canhost = 1;
1110: my $host_idn = &Apache::lonnet::internet_dom($lonhost);
1111: if (ref($remotesessions) eq 'HASH') {
1112: if (ref($remotesessions->{'excludedomain'}) eq 'ARRAY') {
1113: if (grep(/^\Q$host_idn\E$/,@{$remotesessions->{'excludedomain'}})) {
1114: $canhost = 0;
1115: } else {
1116: $canhost = 1;
1117: }
1118: }
1119: if (ref($remotesessions->{'includedomain'}) eq 'ARRAY') {
1120: if (grep(/^\Q$host_idn\E$/,@{$remotesessions->{'includedomain'}})) {
1121: $canhost = 1;
1122: } else {
1123: $canhost = 0;
1124: }
1125: }
1126: if ($canhost) {
1127: if ($remotesessions->{'version'} ne '') {
1128: my ($reqmajor,$reqminor) = ($remotesessions->{'version'} =~ /^(\d+)\.(\d+)$/);
1129: if ($reqmajor ne '' && $reqminor ne '') {
1130: if ($remoterev =~ /^\'?(\d+)\.(\d+)/) {
1131: my $major = $1;
1132: my $minor = $2;
1133: if (($major < $reqmajor ) ||
1134: (($major == $reqmajor) && ($minor < $reqminor))) {
1135: $canhost = 0;
1136: }
1137: } else {
1138: $canhost = 0;
1139: }
1140: }
1141: }
1142: }
1143: }
1144: if ($canhost) {
1145: if (ref($hostedsessions) eq 'HASH') {
1146: my $uprimary_id = &Apache::lonnet::domain($udom,'primary');
1147: my $uint_dom = &Apache::lonnet::internet_dom($uprimary_id);
1148: if (ref($hostedsessions->{'excludedomain'}) eq 'ARRAY') {
1149: if (($uint_dom ne '') &&
1150: (grep(/^\Q$uint_dom\E$/,@{$hostedsessions->{'excludedomain'}}))) {
1151: $canhost = 0;
1152: } else {
1153: $canhost = 1;
1154: }
1155: }
1156: if (ref($hostedsessions->{'includedomain'}) eq 'ARRAY') {
1157: if (($uint_dom ne '') &&
1158: (grep(/^\Q$uint_dom\E$/,@{$hostedsessions->{'includedomain'}}))) {
1159: $canhost = 1;
1160: } else {
1161: $canhost = 0;
1162: }
1163: }
1164: }
1165: }
1166: return $canhost;
1167: }
1168:
1169: sub spare_can_host {
1170: my ($udom,$uint_dom,$remotesessions,$try_server)=@_;
1171: my $canhost=1;
1172: my $try_server_hostname = &hostname($try_server);
1173: my $serverhomeID = &get_server_homeID($try_server_hostname);
1174: my $serverhomedom = &host_domain($serverhomeID);
1175: my %defdomdefaults = &get_domain_defaults($serverhomedom);
1176: if (ref($defdomdefaults{'offloadnow'}) eq 'HASH') {
1177: if ($defdomdefaults{'offloadnow'}{$try_server}) {
1178: $canhost = 0;
1179: }
1180: }
1181: if (($canhost) && ($uint_dom)) {
1182: my @intdoms;
1183: my $internet_names = &get_internet_names($try_server);
1184: if (ref($internet_names) eq 'ARRAY') {
1185: @intdoms = @{$internet_names};
1186: }
1187: unless (grep(/^\Q$uint_dom\E$/,@intdoms)) {
1188: my $remoterev = &get_server_loncaparev(undef,$try_server);
1189: $canhost = &can_host_session($udom,$try_server,$remoterev,
1190: $remotesessions,
1191: $defdomdefaults{'hostedsessions'});
1192: }
1193: }
1194: return $canhost;
1195: }
1196:
1197: sub this_host_spares {
1198: my ($dom) = @_;
1199: my ($dom_in_use,$lonhost_in_use,$result);
1200: my @hosts = ¤t_machine_ids();
1201: foreach my $lonhost (@hosts) {
1202: if (&host_domain($lonhost) eq $dom) {
1203: $dom_in_use = $dom;
1204: $lonhost_in_use = $lonhost;
1205: last;
1206: }
1207: }
1208: if ($dom_in_use ne '') {
1209: $result = &spares_for_offload($dom_in_use,$lonhost_in_use);
1210: }
1211: if (ref($result) ne 'HASH') {
1212: $lonhost_in_use = $perlvar{'lonHostID'};
1213: $dom_in_use = &host_domain($lonhost_in_use);
1214: $result = &spares_for_offload($dom_in_use,$lonhost_in_use);
1215: if (ref($result) ne 'HASH') {
1216: $result = \%spareid;
1217: }
1218: }
1219: return $result;
1220: }
1221:
1222: sub spares_for_offload {
1223: my ($dom_in_use,$lonhost_in_use) = @_;
1224: my ($result,$cached)=&is_cached_new('spares',$dom_in_use);
1225: if (defined($cached)) {
1226: return $result;
1227: } else {
1228: my $cachetime = 60*60*24;
1229: my %domconfig =
1230: &Apache::lonnet::get_dom('configuration',['usersessions'],$dom_in_use);
1231: if (ref($domconfig{'usersessions'}) eq 'HASH') {
1232: if (ref($domconfig{'usersessions'}{'spares'}) eq 'HASH') {
1233: if (ref($domconfig{'usersessions'}{'spares'}{$lonhost_in_use}) eq 'HASH') {
1234: return &do_cache_new('spares',$dom_in_use,$domconfig{'usersessions'}{'spares'}{$lonhost_in_use},$cachetime);
1235: }
1236: }
1237: }
1238: }
1239: return;
1240: }
1241:
1242: sub get_lonbalancer_config {
1243: my ($servers) = @_;
1244: my ($currbalancer,$currtargets);
1245: if (ref($servers) eq 'HASH') {
1246: foreach my $server (keys(%{$servers})) {
1247: my %what = (
1248: spareid => 1,
1249: perlvar => 1,
1250: );
1251: my ($result,$returnhash) = &get_remote_globals($server,\%what);
1252: if ($result eq 'ok') {
1253: if (ref($returnhash) eq 'HASH') {
1254: if (ref($returnhash->{'perlvar'}) eq 'HASH') {
1255: if ($returnhash->{'perlvar'}->{'lonBalancer'} eq 'yes') {
1256: $currbalancer = $server;
1257: $currtargets = {};
1258: if (ref($returnhash->{'spareid'}) eq 'HASH') {
1259: if (ref($returnhash->{'spareid'}->{'primary'}) eq 'ARRAY') {
1260: $currtargets->{'primary'} = $returnhash->{'spareid'}->{'primary'};
1261: }
1262: if (ref($returnhash->{'spareid'}->{'default'}) eq 'ARRAY') {
1263: $currtargets->{'default'} = $returnhash->{'spareid'}->{'default'};
1264: }
1265: }
1266: last;
1267: }
1268: }
1269: }
1270: }
1271: }
1272: }
1273: return ($currbalancer,$currtargets);
1274: }
1275:
1276: sub check_loadbalancing {
1277: my ($uname,$udom,$caller) = @_;
1278: my ($is_balancer,$currtargets,$currrules,$dom_in_use,$homeintdom,
1279: $rule_in_effect,$offloadto,$otherserver);
1280: my $lonhost = $perlvar{'lonHostID'};
1281: my @hosts = ¤t_machine_ids();
1282: my $uprimary_id = &Apache::lonnet::domain($udom,'primary');
1283: my $uintdom = &Apache::lonnet::internet_dom($uprimary_id);
1284: my $intdom = &Apache::lonnet::internet_dom($lonhost);
1285: my $serverhomedom = &host_domain($lonhost);
1286: my $domneedscache;
1287: my $cachetime = 60*60*24;
1288:
1289: if (($uintdom ne '') && ($uintdom eq $intdom)) {
1290: $dom_in_use = $udom;
1291: $homeintdom = 1;
1292: } else {
1293: $dom_in_use = $serverhomedom;
1294: }
1295: my ($result,$cached)=&is_cached_new('loadbalancing',$dom_in_use);
1296: unless (defined($cached)) {
1297: my %domconfig =
1298: &Apache::lonnet::get_dom('configuration',['loadbalancing'],$dom_in_use);
1299: if (ref($domconfig{'loadbalancing'}) eq 'HASH') {
1300: $result = &do_cache_new('loadbalancing',$dom_in_use,$domconfig{'loadbalancing'},$cachetime);
1301: } else {
1302: $domneedscache = $dom_in_use;
1303: }
1304: }
1305: if (ref($result) eq 'HASH') {
1306: ($is_balancer,$currtargets,$currrules) =
1307: &check_balancer_result($result,@hosts);
1308: if ($is_balancer) {
1309: if (ref($currrules) eq 'HASH') {
1310: if ($homeintdom) {
1311: if ($uname ne '') {
1312: if (($currrules->{'_LC_adv'} ne '') || ($currrules->{'_LC_author'} ne '')) {
1313: my ($is_adv,$is_author) = &is_advanced_user($udom,$uname);
1314: if (($currrules->{'_LC_author'} ne '') && ($is_author)) {
1315: $rule_in_effect = $currrules->{'_LC_author'};
1316: } elsif (($currrules->{'_LC_adv'} ne '') && ($is_adv)) {
1317: $rule_in_effect = $currrules->{'_LC_adv'}
1318: }
1319: }
1320: if ($rule_in_effect eq '') {
1321: my %userenv = &userenvironment($udom,$uname,'inststatus');
1322: if ($userenv{'inststatus'} ne '') {
1323: my @statuses = map { &unescape($_); } split(/:/,$userenv{'inststatus'});
1324: my ($othertitle,$usertypes,$types) =
1325: &Apache::loncommon::sorted_inst_types($udom);
1326: if (ref($types) eq 'ARRAY') {
1327: foreach my $type (@{$types}) {
1328: if (grep(/^\Q$type\E$/,@statuses)) {
1329: if (exists($currrules->{$type})) {
1330: $rule_in_effect = $currrules->{$type};
1331: }
1332: }
1333: }
1334: }
1335: } else {
1336: if (exists($currrules->{'default'})) {
1337: $rule_in_effect = $currrules->{'default'};
1338: }
1339: }
1340: }
1341: } else {
1342: if (exists($currrules->{'default'})) {
1343: $rule_in_effect = $currrules->{'default'};
1344: }
1345: }
1346: } else {
1347: if ($currrules->{'_LC_external'} ne '') {
1348: $rule_in_effect = $currrules->{'_LC_external'};
1349: }
1350: }
1351: $offloadto = &get_loadbalancer_targets($rule_in_effect,$currtargets,
1352: $uname,$udom);
1353: }
1354: }
1355: } elsif (($homeintdom) && ($udom ne $serverhomedom)) {
1356: ($result,$cached)=&is_cached_new('loadbalancing',$serverhomedom);
1357: unless (defined($cached)) {
1358: my %domconfig =
1359: &Apache::lonnet::get_dom('configuration',['loadbalancing'],$serverhomedom);
1360: if (ref($domconfig{'loadbalancing'}) eq 'HASH') {
1361: $result = &do_cache_new('loadbalancing',$serverhomedom,$domconfig{'loadbalancing'},$cachetime);
1362: } else {
1363: $domneedscache = $serverhomedom;
1364: }
1365: }
1366: if (ref($result) eq 'HASH') {
1367: ($is_balancer,$currtargets,$currrules) =
1368: &check_balancer_result($result,@hosts);
1369: if ($is_balancer) {
1370: if (ref($currrules) eq 'HASH') {
1371: if ($currrules->{'_LC_internetdom'} ne '') {
1372: $rule_in_effect = $currrules->{'_LC_internetdom'};
1373: }
1374: }
1375: $offloadto = &get_loadbalancer_targets($rule_in_effect,$currtargets,
1376: $uname,$udom);
1377: }
1378: } else {
1379: if ($perlvar{'lonBalancer'} eq 'yes') {
1380: $is_balancer = 1;
1381: $offloadto = &this_host_spares($dom_in_use);
1382: }
1383: unless (defined($cached)) {
1384: $domneedscache = $serverhomedom;
1385: }
1386: }
1387: } else {
1388: if ($perlvar{'lonBalancer'} eq 'yes') {
1389: $is_balancer = 1;
1390: $offloadto = &this_host_spares($dom_in_use);
1391: }
1392: unless (defined($cached)) {
1393: $domneedscache = $serverhomedom;
1394: }
1395: }
1396: if ($domneedscache) {
1397: &do_cache_new('loadbalancing',$domneedscache,$is_balancer,$cachetime);
1398: }
1399: if ($is_balancer) {
1400: my $lowest_load = 30000;
1401: if (ref($offloadto) eq 'HASH') {
1402: if (ref($offloadto->{'primary'}) eq 'ARRAY') {
1403: foreach my $try_server (@{$offloadto->{'primary'}}) {
1404: ($otherserver,$lowest_load) =
1405: &compare_server_load($try_server,$otherserver,$lowest_load);
1406: }
1407: }
1408: my $found_server = ($otherserver ne '' && $lowest_load < 100);
1409:
1410: if (!$found_server) {
1411: if (ref($offloadto->{'default'}) eq 'ARRAY') {
1412: foreach my $try_server (@{$offloadto->{'default'}}) {
1413: ($otherserver,$lowest_load) =
1414: &compare_server_load($try_server,$otherserver,$lowest_load);
1415: }
1416: }
1417: }
1418: } elsif (ref($offloadto) eq 'ARRAY') {
1419: if (@{$offloadto} == 1) {
1420: $otherserver = $offloadto->[0];
1421: } elsif (@{$offloadto} > 1) {
1422: foreach my $try_server (@{$offloadto}) {
1423: ($otherserver,$lowest_load) =
1424: &compare_server_load($try_server,$otherserver,$lowest_load);
1425: }
1426: }
1427: }
1428: unless ($caller eq 'login') {
1429: if (($otherserver ne '') && (grep(/^\Q$otherserver\E$/,@hosts))) {
1430: $is_balancer = 0;
1431: if ($uname ne '' && $udom ne '') {
1432: if (($env{'user.name'} eq $uname) && ($env{'user.domain'} eq $udom)) {
1433:
1434: &appenv({'user.loadbalexempt' => $lonhost,
1435: 'user.loadbalcheck.time' => time});
1436: }
1437: }
1438: }
1439: }
1440: }
1441: return ($is_balancer,$otherserver);
1442: }
1443:
1444: sub check_balancer_result {
1445: my ($result,@hosts) = @_;
1446: my ($is_balancer,$currtargets,$currrules);
1447: if (ref($result) eq 'HASH') {
1448: if ($result->{'lonhost'} ne '') {
1449: my $currbalancer = $result->{'lonhost'};
1450: if (grep(/^\Q$currbalancer\E$/,@hosts)) {
1451: $is_balancer = 1;
1452: $currtargets = $result->{'targets'};
1453: $currrules = $result->{'rules'};
1454: }
1455: } else {
1456: foreach my $key (keys(%{$result})) {
1457: if (($key ne '') && (grep(/^\Q$key\E$/,@hosts)) &&
1458: (ref($result->{$key}) eq 'HASH')) {
1459: $is_balancer = 1;
1460: $currrules = $result->{$key}{'rules'};
1461: $currtargets = $result->{$key}{'targets'};
1462: last;
1463: }
1464: }
1465: }
1466: }
1467: return ($is_balancer,$currtargets,$currrules);
1468: }
1469:
1470: sub get_loadbalancer_targets {
1471: my ($rule_in_effect,$currtargets,$uname,$udom) = @_;
1472: my $offloadto;
1473: if ($rule_in_effect eq 'none') {
1474: return [$perlvar{'lonHostID'}];
1475: } elsif ($rule_in_effect eq '') {
1476: $offloadto = $currtargets;
1477: } else {
1478: if ($rule_in_effect eq 'homeserver') {
1479: my $homeserver = &homeserver($uname,$udom);
1480: if ($homeserver ne 'no_host') {
1481: $offloadto = [$homeserver];
1482: }
1483: } elsif ($rule_in_effect eq 'externalbalancer') {
1484: my %domconfig =
1485: &Apache::lonnet::get_dom('configuration',['loadbalancing'],$udom);
1486: if (ref($domconfig{'loadbalancing'}) eq 'HASH') {
1487: if ($domconfig{'loadbalancing'}{'lonhost'} ne '') {
1488: if (&hostname($domconfig{'loadbalancing'}{'lonhost'}) ne '') {
1489: $offloadto = [$domconfig{'loadbalancing'}{'lonhost'}];
1490: }
1491: }
1492: } else {
1493: my %servers = &internet_dom_servers($udom);
1494: my ($remotebalancer,$remotetargets) = &get_lonbalancer_config(\%servers);
1495: if (&hostname($remotebalancer) ne '') {
1496: $offloadto = [$remotebalancer];
1497: }
1498: }
1499: } elsif (&hostname($rule_in_effect) ne '') {
1500: $offloadto = [$rule_in_effect];
1501: }
1502: }
1503: return $offloadto;
1504: }
1505:
1506: sub internet_dom_servers {
1507: my ($dom) = @_;
1508: my (%uniqservers,%servers);
1509: my $primaryserver = &hostname(&domain($dom,'primary'));
1510: my @machinedoms = &machine_domains($primaryserver);
1511: foreach my $mdom (@machinedoms) {
1512: my %currservers = %servers;
1513: my %server = &get_servers($mdom);
1514: %servers = (%currservers,%server);
1515: }
1516: my %by_hostname;
1517: foreach my $id (keys(%servers)) {
1518: push(@{$by_hostname{$servers{$id}}},$id);
1519: }
1520: foreach my $hostname (sort(keys(%by_hostname))) {
1521: if (@{$by_hostname{$hostname}} > 1) {
1522: my $match = 0;
1523: foreach my $id (@{$by_hostname{$hostname}}) {
1524: if (&host_domain($id) eq $dom) {
1525: $uniqservers{$id} = $hostname;
1526: $match = 1;
1527: }
1528: }
1529: unless ($match) {
1530: $uniqservers{$by_hostname{$hostname}[0]} = $hostname;
1531: }
1532: } else {
1533: $uniqservers{$by_hostname{$hostname}[0]} = $hostname;
1534: }
1535: }
1536: return %uniqservers;
1537: }
1538:
1539: # ---------------------- Find the homebase for a user from domain's lib servers
1540:
1541: my %homecache;
1542: sub homeserver {
1543: my ($uname,$udom,$ignoreBadCache)=@_;
1544: my $index="$uname:$udom";
1545:
1546: if (exists($homecache{$index})) { return $homecache{$index}; }
1547:
1548: my %servers = &get_servers($udom,'library');
1549: foreach my $tryserver (keys(%servers)) {
1550: next if ($ignoreBadCache ne 'true' &&
1551: exists($badServerCache{$tryserver}));
1552:
1553: my $answer=reply("home:$udom:$uname",$tryserver);
1554: if ($answer eq 'found') {
1555: delete($badServerCache{$tryserver});
1556: return $homecache{$index}=$tryserver;
1557: } elsif ($answer eq 'no_host') {
1558: $badServerCache{$tryserver}=1;
1559: }
1560: }
1561: return 'no_host';
1562: }
1563:
1564: # ------------------------------------- Find the usernames behind a list of IDs
1565:
1566: sub idget {
1567: my ($udom,@ids)=@_;
1568: my %returnhash=();
1569:
1570: my %servers = &get_servers($udom,'library');
1571: foreach my $tryserver (keys(%servers)) {
1572: my $idlist=join('&', map { &escape($_); } @ids);
1573: $idlist=~tr/A-Z/a-z/;
1574: my $reply=&reply("idget:$udom:".$idlist,$tryserver);
1575: my @answer=();
1576: if (($reply ne 'con_lost') && ($reply!~/^error\:/)) {
1577: @answer=split(/\&/,$reply);
1578: } ;
1579: my $i;
1580: for ($i=0;$i<=$#ids;$i++) {
1581: if ($answer[$i]) {
1582: $returnhash{$ids[$i]}=&unescape($answer[$i]);
1583: }
1584: }
1585: }
1586: return %returnhash;
1587: }
1588:
1589: # ------------------------------------- Find the IDs behind a list of usernames
1590:
1591: sub idrget {
1592: my ($udom,@unames)=@_;
1593: my %returnhash=();
1594: foreach my $uname (@unames) {
1595: $returnhash{$uname}=(&userenvironment($udom,$uname,'id'))[1];
1596: }
1597: return %returnhash;
1598: }
1599:
1600: # ------------------------------- Store away a list of names and associated IDs
1601:
1602: sub idput {
1603: my ($udom,%ids)=@_;
1604: my %servers=();
1605: foreach my $uname (keys(%ids)) {
1606: &cput('environment',{'id'=>$ids{$uname}},$udom,$uname);
1607: my $uhom=&homeserver($uname,$udom);
1608: if ($uhom ne 'no_host') {
1609: my $id=&escape($ids{$uname});
1610: $id=~tr/A-Z/a-z/;
1611: my $esc_unam=&escape($uname);
1612: if ($servers{$uhom}) {
1613: $servers{$uhom}.='&'.$id.'='.$esc_unam;
1614: } else {
1615: $servers{$uhom}=$id.'='.$esc_unam;
1616: }
1617: }
1618: }
1619: foreach my $server (keys(%servers)) {
1620: &critical('idput:'.$udom.':'.$servers{$server},$server);
1621: }
1622: }
1623:
1624: # ---------------------------------------- Delete unwanted IDs from ids.db file
1625:
1626: sub iddel {
1627: my ($udom,$idshashref,$uhome)=@_;
1628: my %result=();
1629: unless (ref($idshashref) eq 'HASH') {
1630: return %result;
1631: }
1632: my %servers=();
1633: while (my ($id,$uname) = each(%{$idshashref})) {
1634: my $uhom;
1635: if ($uhome) {
1636: $uhom = $uhome;
1637: } else {
1638: $uhom=&homeserver($uname,$udom);
1639: }
1640: if ($uhom ne 'no_host') {
1641: if ($servers{$uhom}) {
1642: $servers{$uhom}.='&'.&escape($id);
1643: } else {
1644: $servers{$uhom}=&escape($id);
1645: }
1646: }
1647: }
1648: foreach my $server (keys(%servers)) {
1649: $result{$server} = &critical('iddel:'.$udom.':'.$servers{$server},$uhome);
1650: }
1651: return %result;
1652: }
1653:
1654: # ------------------------------dump from db file owned by domainconfig user
1655: sub dump_dom {
1656: my ($namespace, $udom, $regexp) = @_;
1657:
1658: $udom ||= $env{'user.domain'};
1659:
1660: return () unless $udom;
1661:
1662: return &dump($namespace, $udom, &get_domainconfiguser($udom), $regexp);
1663: }
1664:
1665: # ------------------------------------------ get items from domain db files
1666:
1667: sub get_dom {
1668: my ($namespace,$storearr,$udom,$uhome)=@_;
1669: return if ($udom eq 'public');
1670: my $items='';
1671: foreach my $item (@$storearr) {
1672: $items.=&escape($item).'&';
1673: }
1674: $items=~s/\&$//;
1675: if (!$udom) {
1676: $udom=$env{'user.domain'};
1677: return if ($udom eq 'public');
1678: if (defined(&domain($udom,'primary'))) {
1679: $uhome=&domain($udom,'primary');
1680: } else {
1681: undef($uhome);
1682: }
1683: } else {
1684: if (!$uhome) {
1685: if (defined(&domain($udom,'primary'))) {
1686: $uhome=&domain($udom,'primary');
1687: }
1688: }
1689: }
1690: if ($udom && $uhome && ($uhome ne 'no_host')) {
1691: my $rep=&reply("getdom:$udom:$namespace:$items",$uhome);
1692: my %returnhash;
1693: if ($rep eq '' || $rep =~ /^error: 2 /) {
1694: return %returnhash;
1695: }
1696: my @pairs=split(/\&/,$rep);
1697: if ( $#pairs==0 && $pairs[0] =~ /^(con_lost|error|no_such_host)/i) {
1698: return @pairs;
1699: }
1700: my $i=0;
1701: foreach my $item (@$storearr) {
1702: $returnhash{$item}=&thaw_unescape($pairs[$i]);
1703: $i++;
1704: }
1705: return %returnhash;
1706: } else {
1707: &logthis("get_dom failed - no homeserver and/or domain ($udom) ($uhome)");
1708: }
1709: }
1710:
1711: # -------------------------------------------- put items in domain db files
1712:
1713: sub put_dom {
1714: my ($namespace,$storehash,$udom,$uhome)=@_;
1715: if (!$udom) {
1716: $udom=$env{'user.domain'};
1717: if (defined(&domain($udom,'primary'))) {
1718: $uhome=&domain($udom,'primary');
1719: } else {
1720: undef($uhome);
1721: }
1722: } else {
1723: if (!$uhome) {
1724: if (defined(&domain($udom,'primary'))) {
1725: $uhome=&domain($udom,'primary');
1726: }
1727: }
1728: }
1729: if ($udom && $uhome && ($uhome ne 'no_host')) {
1730: my $items='';
1731: foreach my $item (keys(%$storehash)) {
1732: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
1733: }
1734: $items=~s/\&$//;
1735: return &reply("putdom:$udom:$namespace:$items",$uhome);
1736: } else {
1737: &logthis("put_dom failed - no homeserver and/or domain");
1738: }
1739: }
1740:
1741: # --------------------- newput for items in db file owned by domainconfig user
1742: sub newput_dom {
1743: my ($namespace,$storehash,$udom) = @_;
1744: my $result;
1745: if (!$udom) {
1746: $udom=$env{'user.domain'};
1747: }
1748: if ($udom) {
1749: my $uname = &get_domainconfiguser($udom);
1750: $result = &newput($namespace,$storehash,$udom,$uname);
1751: }
1752: return $result;
1753: }
1754:
1755: # --------------------- delete for items in db file owned by domainconfig user
1756: sub del_dom {
1757: my ($namespace,$storearr,$udom)=@_;
1758: if (ref($storearr) eq 'ARRAY') {
1759: if (!$udom) {
1760: $udom=$env{'user.domain'};
1761: }
1762: if ($udom) {
1763: my $uname = &get_domainconfiguser($udom);
1764: return &del($namespace,$storearr,$udom,$uname);
1765: }
1766: }
1767: }
1768:
1769: # ----------------------------------construct domainconfig user for a domain
1770: sub get_domainconfiguser {
1771: my ($udom) = @_;
1772: return $udom.'-domainconfig';
1773: }
1774:
1775: sub retrieve_inst_usertypes {
1776: my ($udom) = @_;
1777: my (%returnhash,@order);
1778: my %domdefs = &Apache::lonnet::get_domain_defaults($udom);
1779: if ((ref($domdefs{'inststatustypes'}) eq 'HASH') &&
1780: (ref($domdefs{'inststatusorder'}) eq 'ARRAY')) {
1781: return ($domdefs{'inststatustypes'},$domdefs{'inststatusorder'});
1782: } else {
1783: if (defined(&domain($udom,'primary'))) {
1784: my $uhome=&domain($udom,'primary');
1785: my $rep=&reply("inst_usertypes:$udom",$uhome);
1786: if ($rep =~ /^(con_lost|error|no_such_host|refused)/) {
1787: &logthis("retrieve_inst_usertypes failed - $rep returned from $uhome in domain: $udom");
1788: return (\%returnhash,\@order);
1789: }
1790: my ($hashitems,$orderitems) = split(/:/,$rep);
1791: my @pairs=split(/\&/,$hashitems);
1792: foreach my $item (@pairs) {
1793: my ($key,$value)=split(/=/,$item,2);
1794: $key = &unescape($key);
1795: next if ($key =~ /^error: 2 /);
1796: $returnhash{$key}=&thaw_unescape($value);
1797: }
1798: my @esc_order = split(/\&/,$orderitems);
1799: foreach my $item (@esc_order) {
1800: push(@order,&unescape($item));
1801: }
1802: } else {
1803: &logthis("retrieve_inst_usertypes failed - no primary domain server for $udom");
1804: }
1805: return (\%returnhash,\@order);
1806: }
1807: }
1808:
1809: sub is_domainimage {
1810: my ($url) = @_;
1811: if ($url=~m-^/+res/+($match_domain)/+\1\-domainconfig/+(img|logo|domlogo)/+[^/]-) {
1812: if (&domain($1) ne '') {
1813: return '1';
1814: }
1815: }
1816: return;
1817: }
1818:
1819: sub inst_directory_query {
1820: my ($srch) = @_;
1821: my $udom = $srch->{'srchdomain'};
1822: my %results;
1823: my $homeserver = &domain($udom,'primary');
1824: my $outcome;
1825: if ($homeserver ne '') {
1826: my $queryid=&reply("querysend:instdirsearch:".
1827: &escape($srch->{'srchby'}).':'.
1828: &escape($srch->{'srchterm'}).':'.
1829: &escape($srch->{'srchtype'}),$homeserver);
1830: my $host=&hostname($homeserver);
1831: if ($queryid !~/^\Q$host\E\_/) {
1832: &logthis('institutional directory search invalid queryid: '.$queryid.' for host: '.$homeserver.'in domain '.$udom);
1833: return;
1834: }
1835: my $response = &get_query_reply($queryid);
1836: my $maxtries = 5;
1837: my $tries = 1;
1838: while (($response=~/^timeout/) && ($tries < $maxtries)) {
1839: $response = &get_query_reply($queryid);
1840: $tries ++;
1841: }
1842:
1843: if (!&error($response) && $response ne 'refused') {
1844: if ($response eq 'unavailable') {
1845: $outcome = $response;
1846: } else {
1847: $outcome = 'ok';
1848: my @matches = split(/\n/,$response);
1849: foreach my $match (@matches) {
1850: my ($key,$value) = split(/=/,$match);
1851: $results{&unescape($key).':'.$udom} = &thaw_unescape($value);
1852: }
1853: }
1854: }
1855: }
1856: return ($outcome,%results);
1857: }
1858:
1859: sub usersearch {
1860: my ($srch) = @_;
1861: my $dom = $srch->{'srchdomain'};
1862: my %results;
1863: my %libserv = &all_library();
1864: my $query = 'usersearch';
1865: foreach my $tryserver (keys(%libserv)) {
1866: if (&host_domain($tryserver) eq $dom) {
1867: my $host=&hostname($tryserver);
1868: my $queryid=
1869: &reply("querysend:".&escape($query).':'.
1870: &escape($srch->{'srchby'}).':'.
1871: &escape($srch->{'srchtype'}).':'.
1872: &escape($srch->{'srchterm'}),$tryserver);
1873: if ($queryid !~/^\Q$host\E\_/) {
1874: &logthis('usersearch: invalid queryid: '.$queryid.' for host: '.$host.'in domain '.$dom.' and server: '.$tryserver);
1875: next;
1876: }
1877: my $reply = &get_query_reply($queryid);
1878: my $maxtries = 1;
1879: my $tries = 1;
1880: while (($reply=~/^timeout/) && ($tries < $maxtries)) {
1881: $reply = &get_query_reply($queryid);
1882: $tries ++;
1883: }
1884: if ( ($reply =~/^timeout/) || ($reply =~/^error/) ) {
1885: &logthis('usersrch error: '.$reply.' for '.$dom.' - searching for : '.$srch->{'srchterm'}.' by '.$srch->{'srchby'}.' ('.$srch->{'srchtype'}.') - maxtries: '.$maxtries.' tries: '.$tries);
1886: } else {
1887: my @matches;
1888: if ($reply =~ /\n/) {
1889: @matches = split(/\n/,$reply);
1890: } else {
1891: @matches = split(/\&/,$reply);
1892: }
1893: foreach my $match (@matches) {
1894: my ($uname,$udom,%userhash);
1895: foreach my $entry (split(/:/,$match)) {
1896: my ($key,$value) =
1897: map {&unescape($_);} split(/=/,$entry);
1898: $userhash{$key} = $value;
1899: if ($key eq 'username') {
1900: $uname = $value;
1901: } elsif ($key eq 'domain') {
1902: $udom = $value;
1903: }
1904: }
1905: $results{$uname.':'.$udom} = \%userhash;
1906: }
1907: }
1908: }
1909: }
1910: return %results;
1911: }
1912:
1913: sub get_instuser {
1914: my ($udom,$uname,$id) = @_;
1915: my $homeserver = &domain($udom,'primary');
1916: my ($outcome,%results);
1917: if ($homeserver ne '') {
1918: my $queryid=&reply("querysend:getinstuser:".&escape($uname).':'.
1919: &escape($id).':'.&escape($udom),$homeserver);
1920: my $host=&hostname($homeserver);
1921: if ($queryid !~/^\Q$host\E\_/) {
1922: &logthis('get_instuser invalid queryid: '.$queryid.' for host: '.$homeserver.'in domain '.$udom);
1923: return;
1924: }
1925: my $response = &get_query_reply($queryid);
1926: my $maxtries = 5;
1927: my $tries = 1;
1928: while (($response=~/^timeout/) && ($tries < $maxtries)) {
1929: $response = &get_query_reply($queryid);
1930: $tries ++;
1931: }
1932: if (!&error($response) && $response ne 'refused') {
1933: if ($response eq 'unavailable') {
1934: $outcome = $response;
1935: } else {
1936: $outcome = 'ok';
1937: my @matches = split(/\n/,$response);
1938: foreach my $match (@matches) {
1939: my ($key,$value) = split(/=/,$match);
1940: $results{&unescape($key)} = &thaw_unescape($value);
1941: }
1942: }
1943: }
1944: }
1945: my %userinfo;
1946: if (ref($results{$uname}) eq 'HASH') {
1947: %userinfo = %{$results{$uname}};
1948: }
1949: return ($outcome,%userinfo);
1950: }
1951:
1952: sub get_multiple_instusers {
1953: my ($udom,$users,$caller) = @_;
1954: my ($outcome,$results);
1955: if (ref($users) eq 'HASH') {
1956: my $count = keys(%{$users});
1957: my $requested = &freeze_escape($users);
1958: my $homeserver = &domain($udom,'primary');
1959: if ($homeserver ne '') {
1960: my $queryid=&reply('querysend:getmultinstusers:::'.$caller.'='.$requested,$homeserver);
1961: my $host=&hostname($homeserver);
1962: if ($queryid !~/^\Q$host\E\_/) {
1963: &logthis('get_multiple_instusers invalid queryid: '.$queryid.
1964: ' for host: '.$homeserver.'in domain '.$udom);
1965: return ($outcome,$results);
1966: }
1967: my $response = &get_query_reply($queryid);
1968: my $maxtries = 5;
1969: if ($count > 100) {
1970: $maxtries = 1+int($count/20);
1971: }
1972: my $tries = 1;
1973: while (($response=~/^timeout/) && ($tries <= $maxtries)) {
1974: $response = &get_query_reply($queryid);
1975: $tries ++;
1976: }
1977: if ($response eq '') {
1978: $results = {};
1979: foreach my $key (keys(%{$users})) {
1980: my ($uname,$id);
1981: if ($caller eq 'id') {
1982: $id = $key;
1983: } else {
1984: $uname = $key;
1985: }
1986: my ($resp,%info) = &get_instuser($udom,$uname,$id);
1987: $outcome = $resp;
1988: if ($resp eq 'ok') {
1989: %{$results} = (%{$results}, %info);
1990: } else {
1991: last;
1992: }
1993: }
1994: } elsif(!&error($response) && ($response ne 'refused')) {
1995: if (($response eq 'unavailable') || ($response eq 'invalid') || ($response eq 'timeout')) {
1996: $outcome = $response;
1997: } else {
1998: ($outcome,my $userdata) = split(/=/,$response,2);
1999: if ($outcome eq 'ok') {
2000: $results = &thaw_unescape($userdata);
2001: }
2002: }
2003: }
2004: }
2005: }
2006: return ($outcome,$results);
2007: }
2008:
2009: sub inst_rulecheck {
2010: my ($udom,$uname,$id,$item,$rules) = @_;
2011: my %returnhash;
2012: if ($udom ne '') {
2013: if (ref($rules) eq 'ARRAY') {
2014: @{$rules} = map {&escape($_);} (@{$rules});
2015: my $rulestr = join(':',@{$rules});
2016: my $homeserver=&domain($udom,'primary');
2017: if (($homeserver ne '') && ($homeserver ne 'no_host')) {
2018: my $response;
2019: if ($item eq 'username') {
2020: $response=&unescape(&reply('instrulecheck:'.&escape($udom).
2021: ':'.&escape($uname).':'.$rulestr,
2022: $homeserver));
2023: } elsif ($item eq 'id') {
2024: $response=&unescape(&reply('instidrulecheck:'.&escape($udom).
2025: ':'.&escape($id).':'.$rulestr,
2026: $homeserver));
2027: } elsif ($item eq 'selfcreate') {
2028: $response=&unescape(&reply('instselfcreatecheck:'.
2029: &escape($udom).':'.&escape($uname).
2030: ':'.$rulestr,$homeserver));
2031: }
2032: if ($response ne 'refused') {
2033: my @pairs=split(/\&/,$response);
2034: foreach my $item (@pairs) {
2035: my ($key,$value)=split(/=/,$item,2);
2036: $key = &unescape($key);
2037: next if ($key =~ /^error: 2 /);
2038: $returnhash{$key}=&thaw_unescape($value);
2039: }
2040: }
2041: }
2042: }
2043: }
2044: return %returnhash;
2045: }
2046:
2047: sub inst_userrules {
2048: my ($udom,$check) = @_;
2049: my (%ruleshash,@ruleorder);
2050: if ($udom ne '') {
2051: my $homeserver=&domain($udom,'primary');
2052: if (($homeserver ne '') && ($homeserver ne 'no_host')) {
2053: my $response;
2054: if ($check eq 'id') {
2055: $response=&reply('instidrules:'.&escape($udom),
2056: $homeserver);
2057: } elsif ($check eq 'email') {
2058: $response=&reply('instemailrules:'.&escape($udom),
2059: $homeserver);
2060: } else {
2061: $response=&reply('instuserrules:'.&escape($udom),
2062: $homeserver);
2063: }
2064: if (($response ne 'refused') && ($response ne 'error') &&
2065: ($response ne 'unknown_cmd') &&
2066: ($response ne 'no_such_host')) {
2067: my ($hashitems,$orderitems) = split(/:/,$response);
2068: my @pairs=split(/\&/,$hashitems);
2069: foreach my $item (@pairs) {
2070: my ($key,$value)=split(/=/,$item,2);
2071: $key = &unescape($key);
2072: next if ($key =~ /^error: 2 /);
2073: $ruleshash{$key}=&thaw_unescape($value);
2074: }
2075: my @esc_order = split(/\&/,$orderitems);
2076: foreach my $item (@esc_order) {
2077: push(@ruleorder,&unescape($item));
2078: }
2079: }
2080: }
2081: }
2082: return (\%ruleshash,\@ruleorder);
2083: }
2084:
2085: # ------------- Get Authentication, Language and User Tools Defaults for Domain
2086:
2087: sub get_domain_defaults {
2088: my ($domain,$ignore_cache) = @_;
2089: return if (($domain eq '') || ($domain eq 'public'));
2090: my $cachetime = 60*60*24;
2091: unless ($ignore_cache) {
2092: my ($result,$cached)=&is_cached_new('domdefaults',$domain);
2093: if (defined($cached)) {
2094: if (ref($result) eq 'HASH') {
2095: return %{$result};
2096: }
2097: }
2098: }
2099: my %domdefaults;
2100: my %domconfig =
2101: &Apache::lonnet::get_dom('configuration',['defaults','quotas',
2102: 'requestcourses','inststatus',
2103: 'coursedefaults','usersessions',
2104: 'requestauthor','selfenrollment',
2105: 'coursecategories','autoenroll',
2106: 'helpsettings'],$domain);
2107: my @coursetypes = ('official','unofficial','community','textbook');
2108: if (ref($domconfig{'defaults'}) eq 'HASH') {
2109: $domdefaults{'lang_def'} = $domconfig{'defaults'}{'lang_def'};
2110: $domdefaults{'auth_def'} = $domconfig{'defaults'}{'auth_def'};
2111: $domdefaults{'auth_arg_def'} = $domconfig{'defaults'}{'auth_arg_def'};
2112: $domdefaults{'timezone_def'} = $domconfig{'defaults'}{'timezone_def'};
2113: $domdefaults{'datelocale_def'} = $domconfig{'defaults'}{'datelocale_def'};
2114: $domdefaults{'portal_def'} = $domconfig{'defaults'}{'portal_def'};
2115: $domdefaults{'intauth_cost'} = $domconfig{'defaults'}{'intauth_cost'};
2116: $domdefaults{'intauth_switch'} = $domconfig{'defaults'}{'intauth_switch'};
2117: $domdefaults{'intauth_check'} = $domconfig{'defaults'}{'intauth_check'};
2118: } else {
2119: $domdefaults{'lang_def'} = &domain($domain,'lang_def');
2120: $domdefaults{'auth_def'} = &domain($domain,'auth_def');
2121: $domdefaults{'auth_arg_def'} = &domain($domain,'auth_arg_def');
2122: }
2123: if (ref($domconfig{'quotas'}) eq 'HASH') {
2124: if (ref($domconfig{'quotas'}{'defaultquota'}) eq 'HASH') {
2125: $domdefaults{'defaultquota'} = $domconfig{'quotas'}{'defaultquota'};
2126: } else {
2127: $domdefaults{'defaultquota'} = $domconfig{'quotas'};
2128: }
2129: my @usertools = ('aboutme','blog','webdav','portfolio');
2130: foreach my $item (@usertools) {
2131: if (ref($domconfig{'quotas'}{$item}) eq 'HASH') {
2132: $domdefaults{$item} = $domconfig{'quotas'}{$item};
2133: }
2134: }
2135: if (ref($domconfig{'quotas'}{'authorquota'}) eq 'HASH') {
2136: $domdefaults{'authorquota'} = $domconfig{'quotas'}{'authorquota'};
2137: }
2138: }
2139: if (ref($domconfig{'requestcourses'}) eq 'HASH') {
2140: foreach my $item ('official','unofficial','community','textbook') {
2141: $domdefaults{$item} = $domconfig{'requestcourses'}{$item};
2142: }
2143: }
2144: if (ref($domconfig{'requestauthor'}) eq 'HASH') {
2145: $domdefaults{'requestauthor'} = $domconfig{'requestauthor'};
2146: }
2147: if (ref($domconfig{'inststatus'}) eq 'HASH') {
2148: foreach my $item ('inststatustypes','inststatusorder','inststatusguest') {
2149: $domdefaults{$item} = $domconfig{'inststatus'}{$item};
2150: }
2151: }
2152: if (ref($domconfig{'coursedefaults'}) eq 'HASH') {
2153: $domdefaults{'usejsme'} = $domconfig{'coursedefaults'}{'usejsme'};
2154: $domdefaults{'uselcmath'} = $domconfig{'coursedefaults'}{'uselcmath'};
2155: if (ref($domconfig{'coursedefaults'}{'postsubmit'}) eq 'HASH') {
2156: $domdefaults{'postsubmit'} = $domconfig{'coursedefaults'}{'postsubmit'}{'client'};
2157: }
2158: foreach my $type (@coursetypes) {
2159: if (ref($domconfig{'coursedefaults'}{'coursecredits'}) eq 'HASH') {
2160: unless ($type eq 'community') {
2161: $domdefaults{$type.'credits'} = $domconfig{'coursedefaults'}{'coursecredits'}{$type};
2162: }
2163: }
2164: if (ref($domconfig{'coursedefaults'}{'uploadquota'}) eq 'HASH') {
2165: $domdefaults{$type.'quota'} = $domconfig{'coursedefaults'}{'uploadquota'}{$type};
2166: }
2167: if ($domdefaults{'postsubmit'} eq 'on') {
2168: if (ref($domconfig{'coursedefaults'}{'postsubmit'}{'timeout'}) eq 'HASH') {
2169: $domdefaults{$type.'postsubtimeout'} =
2170: $domconfig{'coursedefaults'}{'postsubmit'}{'timeout'}{$type};
2171: }
2172: }
2173: }
2174: if (ref($domconfig{'coursedefaults'}{'canclone'}) eq 'HASH') {
2175: if (ref($domconfig{'coursedefaults'}{'canclone'}{'instcode'}) eq 'ARRAY') {
2176: my @clonecodes = @{$domconfig{'coursedefaults'}{'canclone'}{'instcode'}};
2177: if (@clonecodes) {
2178: $domdefaults{'canclone'} = join('+',@clonecodes);
2179: }
2180: }
2181: } elsif ($domconfig{'coursedefaults'}{'canclone'}) {
2182: $domdefaults{'canclone'}=$domconfig{'coursedefaults'}{'canclone'};
2183: }
2184: }
2185: if (ref($domconfig{'usersessions'}) eq 'HASH') {
2186: if (ref($domconfig{'usersessions'}{'remote'}) eq 'HASH') {
2187: $domdefaults{'remotesessions'} = $domconfig{'usersessions'}{'remote'};
2188: }
2189: if (ref($domconfig{'usersessions'}{'hosted'}) eq 'HASH') {
2190: $domdefaults{'hostedsessions'} = $domconfig{'usersessions'}{'hosted'};
2191: }
2192: if (ref($domconfig{'usersessions'}{'offloadnow'}) eq 'HASH') {
2193: $domdefaults{'offloadnow'} = $domconfig{'usersessions'}{'offloadnow'};
2194: }
2195: }
2196: if (ref($domconfig{'selfenrollment'}) eq 'HASH') {
2197: if (ref($domconfig{'selfenrollment'}{'admin'}) eq 'HASH') {
2198: my @settings = ('types','registered','enroll_dates','access_dates','section',
2199: 'approval','limit');
2200: foreach my $type (@coursetypes) {
2201: if (ref($domconfig{'selfenrollment'}{'admin'}{$type}) eq 'HASH') {
2202: my @mgrdc = ();
2203: foreach my $item (@settings) {
2204: if ($domconfig{'selfenrollment'}{'admin'}{$type}{$item} eq '0') {
2205: push(@mgrdc,$item);
2206: }
2207: }
2208: if (@mgrdc) {
2209: $domdefaults{$type.'selfenrolladmdc'} = join(',',@mgrdc);
2210: }
2211: }
2212: }
2213: }
2214: if (ref($domconfig{'selfenrollment'}{'default'}) eq 'HASH') {
2215: foreach my $type (@coursetypes) {
2216: if (ref($domconfig{'selfenrollment'}{'default'}{$type}) eq 'HASH') {
2217: foreach my $item (keys(%{$domconfig{'selfenrollment'}{'default'}{$type}})) {
2218: $domdefaults{$type.'selfenroll'.$item} = $domconfig{'selfenrollment'}{'default'}{$type}{$item};
2219: }
2220: }
2221: }
2222: }
2223: }
2224: if (ref($domconfig{'coursecategories'}) eq 'HASH') {
2225: $domdefaults{'catauth'} = 'std';
2226: $domdefaults{'catunauth'} = 'std';
2227: if ($domconfig{'coursecategories'}{'auth'}) {
2228: $domdefaults{'catauth'} = $domconfig{'coursecategories'}{'auth'};
2229: }
2230: if ($domconfig{'coursecategories'}{'unauth'}) {
2231: $domdefaults{'catunauth'} = $domconfig{'coursecategories'}{'unauth'};
2232: }
2233: }
2234: if (ref($domconfig{'autoenroll'}) eq 'HASH') {
2235: $domdefaults{'autofailsafe'} = $domconfig{'autoenroll'}{'autofailsafe'};
2236: }
2237: if (ref($domconfig{'helpsettings'}) eq 'HASH') {
2238: $domdefaults{'submitbugs'} = $domconfig{'helpsettings'}{'submitbugs'};
2239: if (ref($domconfig{'helpsettings'}{'adhoc'}) eq 'HASH') {
2240: $domdefaults{'adhocroles'} = $domconfig{'helpsettings'}{'adhoc'};
2241: }
2242: }
2243: &do_cache_new('domdefaults',$domain,\%domdefaults,$cachetime);
2244: return %domdefaults;
2245: }
2246:
2247: # --------------------------------------------------- Assign a key to a student
2248:
2249: sub assign_access_key {
2250: #
2251: # a valid key looks like uname:udom#comments
2252: # comments are being appended
2253: #
2254: my ($ckey,$kdom,$knum,$cdom,$cnum,$udom,$uname,$logentry)=@_;
2255: $kdom=
2256: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($kdom));
2257: $knum=
2258: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($knum));
2259: $cdom=
2260: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
2261: $cnum=
2262: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
2263: $udom=$env{'user.name'} unless (defined($udom));
2264: $uname=$env{'user.domain'} unless (defined($uname));
2265: my %existing=&get('accesskeys',[$ckey],$kdom,$knum);
2266: if (($existing{$ckey}=~/^\#(.*)$/) || # - new key
2267: ($existing{$ckey}=~/^\Q$uname\E\:\Q$udom\E\#(.*)$/)) {
2268: # assigned to this person
2269: # - this should not happen,
2270: # unless something went wrong
2271: # the first time around
2272: # ready to assign
2273: $logentry=$1.'; '.$logentry;
2274: if (&put('accesskeys',{$ckey=>$uname.':'.$udom.'#'.$logentry},
2275: $kdom,$knum) eq 'ok') {
2276: # key now belongs to user
2277: my $envkey='key.'.$cdom.'_'.$cnum;
2278: if (&put('environment',{$envkey => $ckey}) eq 'ok') {
2279: &appenv({'environment.'.$envkey => $ckey});
2280: return 'ok';
2281: } else {
2282: return
2283: 'error: Count not permanently assign key, will need to be re-entered later.';
2284: }
2285: } else {
2286: return 'error: Could not assign key, try again later.';
2287: }
2288: } elsif (!$existing{$ckey}) {
2289: # the key does not exist
2290: return 'error: The key does not exist';
2291: } else {
2292: # the key is somebody else's
2293: return 'error: The key is already in use';
2294: }
2295: }
2296:
2297: # ------------------------------------------ put an additional comment on a key
2298:
2299: sub comment_access_key {
2300: #
2301: # a valid key looks like uname:udom#comments
2302: # comments are being appended
2303: #
2304: my ($ckey,$cdom,$cnum,$logentry)=@_;
2305: $cdom=
2306: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
2307: $cnum=
2308: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
2309: my %existing=&get('accesskeys',[$ckey],$cdom,$cnum);
2310: if ($existing{$ckey}) {
2311: $existing{$ckey}.='; '.$logentry;
2312: # ready to assign
2313: if (&put('accesskeys',{$ckey=>$existing{$ckey}},
2314: $cdom,$cnum) eq 'ok') {
2315: return 'ok';
2316: } else {
2317: return 'error: Count not store comment.';
2318: }
2319: } else {
2320: # the key does not exist
2321: return 'error: The key does not exist';
2322: }
2323: }
2324:
2325: # ------------------------------------------------------ Generate a set of keys
2326:
2327: sub generate_access_keys {
2328: my ($number,$cdom,$cnum,$logentry)=@_;
2329: $cdom=
2330: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
2331: $cnum=
2332: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
2333: unless (&allowed('mky',$cdom)) { return 0; }
2334: unless (($cdom) && ($cnum)) { return 0; }
2335: if ($number>10000) { return 0; }
2336: sleep(2); # make sure don't get same seed twice
2337: srand(time()^($$+($$<<15))); # from "Programming Perl"
2338: my $total=0;
2339: for (my $i=1;$i<=$number;$i++) {
2340: my $newkey=sprintf("%lx",int(100000*rand)).'-'.
2341: sprintf("%lx",int(100000*rand)).'-'.
2342: sprintf("%lx",int(100000*rand));
2343: $newkey=~s/1/g/g; # folks mix up 1 and l
2344: $newkey=~s/0/h/g; # and also 0 and O
2345: my %existing=&get('accesskeys',[$newkey],$cdom,$cnum);
2346: if ($existing{$newkey}) {
2347: $i--;
2348: } else {
2349: if (&put('accesskeys',
2350: { $newkey => '# generated '.localtime().
2351: ' by '.$env{'user.name'}.'@'.$env{'user.domain'}.
2352: '; '.$logentry },
2353: $cdom,$cnum) eq 'ok') {
2354: $total++;
2355: }
2356: }
2357: }
2358: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},
2359: 'Generated '.$total.' keys for '.$cnum.' at '.$cdom);
2360: return $total;
2361: }
2362:
2363: # ------------------------------------------------------- Validate an accesskey
2364:
2365: sub validate_access_key {
2366: my ($ckey,$cdom,$cnum,$udom,$uname)=@_;
2367: $cdom=
2368: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
2369: $cnum=
2370: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
2371: $udom=$env{'user.domain'} unless (defined($udom));
2372: $uname=$env{'user.name'} unless (defined($uname));
2373: my %existing=&get('accesskeys',[$ckey],$cdom,$cnum);
2374: return ($existing{$ckey}=~/^\Q$uname\E\:\Q$udom\E\#/);
2375: }
2376:
2377: # ------------------------------------- Find the section of student in a course
2378: sub devalidate_getsection_cache {
2379: my ($udom,$unam,$courseid)=@_;
2380: my $hashid="$udom:$unam:$courseid";
2381: &devalidate_cache_new('getsection',$hashid);
2382: }
2383:
2384: sub courseid_to_courseurl {
2385: my ($courseid) = @_;
2386: #already url style courseid
2387: return $courseid if ($courseid =~ m{^/});
2388:
2389: if (exists($env{'course.'.$courseid.'.num'})) {
2390: my $cnum = $env{'course.'.$courseid.'.num'};
2391: my $cdom = $env{'course.'.$courseid.'.domain'};
2392: return "/$cdom/$cnum";
2393: }
2394:
2395: my %courseinfo=&Apache::lonnet::coursedescription($courseid);
2396: if (exists($courseinfo{'num'})) {
2397: return "/$courseinfo{'domain'}/$courseinfo{'num'}";
2398: }
2399:
2400: return undef;
2401: }
2402:
2403: sub getsection {
2404: my ($udom,$unam,$courseid)=@_;
2405: my $cachetime=1800;
2406:
2407: my $hashid="$udom:$unam:$courseid";
2408: my ($result,$cached)=&is_cached_new('getsection',$hashid);
2409: if (defined($cached)) { return $result; }
2410:
2411: my %Pending;
2412: my %Expired;
2413: #
2414: # Each role can either have not started yet (pending), be active,
2415: # or have expired.
2416: #
2417: # If there is an active role, we are done.
2418: #
2419: # If there is more than one role which has not started yet,
2420: # choose the one which will start sooner
2421: # If there is one role which has not started yet, return it.
2422: #
2423: # If there is more than one expired role, choose the one which ended last.
2424: # If there is a role which has expired, return it.
2425: #
2426: $courseid = &courseid_to_courseurl($courseid);
2427: my %roleshash = &dump('roles',$udom,$unam,$courseid);
2428: foreach my $key (keys(%roleshash)) {
2429: next if ($key !~/^\Q$courseid\E(?:\/)*(\w+)*\_st$/);
2430: my $section=$1;
2431: if ($key eq $courseid.'_st') { $section=''; }
2432: my ($dummy,$end,$start)=split(/\_/,&unescape($roleshash{$key}));
2433: my $now=time;
2434: if (defined($end) && $end && ($now > $end)) {
2435: $Expired{$end}=$section;
2436: next;
2437: }
2438: if (defined($start) && $start && ($now < $start)) {
2439: $Pending{$start}=$section;
2440: next;
2441: }
2442: return &do_cache_new('getsection',$hashid,$section,$cachetime);
2443: }
2444: #
2445: # Presumedly there will be few matching roles from the above
2446: # loop and the sorting time will be negligible.
2447: if (scalar(keys(%Pending))) {
2448: my ($time) = sort {$a <=> $b} keys(%Pending);
2449: return &do_cache_new('getsection',$hashid,$Pending{$time},$cachetime);
2450: }
2451: if (scalar(keys(%Expired))) {
2452: my @sorted = sort {$a <=> $b} keys(%Expired);
2453: my $time = pop(@sorted);
2454: return &do_cache_new('getsection',$hashid,$Expired{$time},$cachetime);
2455: }
2456: return &do_cache_new('getsection',$hashid,'-1',$cachetime);
2457: }
2458:
2459: sub save_cache {
2460: &purge_remembered();
2461: #&Apache::loncommon::validate_page();
2462: undef(%env);
2463: undef($env_loaded);
2464: }
2465:
2466: my $to_remember=-1;
2467: my %remembered;
2468: my %accessed;
2469: my $kicks=0;
2470: my $hits=0;
2471: sub make_key {
2472: my ($name,$id) = @_;
2473: if (length($id) > 65
2474: && length(&escape($id)) > 200) {
2475: $id=length($id).':'.&Digest::MD5::md5_hex($id);
2476: }
2477: return &escape($name.':'.$id);
2478: }
2479:
2480: sub devalidate_cache_new {
2481: my ($name,$id,$debug) = @_;
2482: if ($debug) { &Apache::lonnet::logthis("deleting $name:$id"); }
2483: my $remembered_id=$name.':'.$id;
2484: $id=&make_key($name,$id);
2485: $memcache->delete($id);
2486: delete($remembered{$remembered_id});
2487: delete($accessed{$remembered_id});
2488: }
2489:
2490: sub is_cached_new {
2491: my ($name,$id,$debug) = @_;
2492: my $remembered_id=$name.':'.$id; # this is to avoid make_key (which is slow) for
2493: # keys in %remembered hash, which persists for
2494: # duration of request (no restriction on key length).
2495: if (exists($remembered{$remembered_id})) {
2496: if ($debug) { &Apache::lonnet::logthis("Early return $remembered_id of $remembered{$remembered_id} "); }
2497: $accessed{$remembered_id}=[&gettimeofday()];
2498: $hits++;
2499: return ($remembered{$remembered_id},1);
2500: }
2501: $id=&make_key($name,$id);
2502: my $value = $memcache->get($id);
2503: if (!(defined($value))) {
2504: if ($debug) { &Apache::lonnet::logthis("getting $id is not defined"); }
2505: return (undef,undef);
2506: }
2507: if ($value eq '__undef__') {
2508: if ($debug) { &Apache::lonnet::logthis("getting $id is __undef__"); }
2509: $value=undef;
2510: }
2511: &make_room($remembered_id,$value,$debug);
2512: if ($debug) { &Apache::lonnet::logthis("getting $id is $value"); }
2513: return ($value,1);
2514: }
2515:
2516: sub do_cache_new {
2517: my ($name,$id,$value,$time,$debug) = @_;
2518: my $remembered_id=$name.':'.$id;
2519: $id=&make_key($name,$id);
2520: my $setvalue=$value;
2521: if (!defined($setvalue)) {
2522: $setvalue='__undef__';
2523: }
2524: if (!defined($time) ) {
2525: $time=600;
2526: }
2527: if ($debug) { &Apache::lonnet::logthis("Setting $id to $value"); }
2528: my $result = $memcache->set($id,$setvalue,$time);
2529: if (! $result) {
2530: &logthis("caching of id -> $id failed");
2531: $memcache->disconnect_all();
2532: }
2533: # need to make a copy of $value
2534: &make_room($remembered_id,$value,$debug);
2535: return $value;
2536: }
2537:
2538: sub make_room {
2539: my ($remembered_id,$value,$debug)=@_;
2540:
2541: $remembered{$remembered_id}= (ref($value)) ? &Storable::dclone($value)
2542: : $value;
2543: if ($to_remember<0) { return; }
2544: $accessed{$remembered_id}=[&gettimeofday()];
2545: if (scalar(keys(%remembered)) <= $to_remember) { return; }
2546: my $to_kick;
2547: my $max_time=0;
2548: foreach my $other (keys(%accessed)) {
2549: if (&tv_interval($accessed{$other}) > $max_time) {
2550: $to_kick=$other;
2551: $max_time=&tv_interval($accessed{$other});
2552: }
2553: }
2554: delete($remembered{$to_kick});
2555: delete($accessed{$to_kick});
2556: $kicks++;
2557: if ($debug) { &logthis("kicking $to_kick $max_time $kicks\n"); }
2558: return;
2559: }
2560:
2561: sub purge_remembered {
2562: #&logthis("Tossing ".scalar(keys(%remembered)));
2563: #&logthis(sprintf("%-20s is %s",'%remembered',length(&freeze(\%remembered))));
2564: undef(%remembered);
2565: undef(%accessed);
2566: }
2567: # ------------------------------------- Read an entry from a user's environment
2568:
2569: sub userenvironment {
2570: my ($udom,$unam,@what)=@_;
2571: my $items;
2572: foreach my $item (@what) {
2573: $items.=&escape($item).'&';
2574: }
2575: $items=~s/\&$//;
2576: my %returnhash=();
2577: my $uhome = &homeserver($unam,$udom);
2578: unless ($uhome eq 'no_host') {
2579: my @answer=split(/\&/,
2580: &reply('get:'.$udom.':'.$unam.':environment:'.$items,$uhome));
2581: if ($#answer==0 && $answer[0] =~ /^(con_lost|error:|no_such_host)/i) {
2582: return %returnhash;
2583: }
2584: my $i;
2585: for ($i=0;$i<=$#what;$i++) {
2586: $returnhash{$what[$i]}=&unescape($answer[$i]);
2587: }
2588: }
2589: return %returnhash;
2590: }
2591:
2592: # ---------------------------------------------------------- Get a studentphoto
2593: sub studentphoto {
2594: my ($udom,$unam,$ext) = @_;
2595: my $home=&Apache::lonnet::homeserver($unam,$udom);
2596: if (defined($env{'request.course.id'})) {
2597: if ($env{'course.'.$env{'request.course.id'}.'.internal.showphoto'}) {
2598: if ($udom eq $env{'course.'.$env{'request.course.id'}.'.domain'}) {
2599: return(&retrievestudentphoto($udom,$unam,$ext));
2600: } else {
2601: my ($result,$perm_reqd)=
2602: &Apache::lonnet::auto_photo_permission($unam,$udom);
2603: if ($result eq 'ok') {
2604: if (!($perm_reqd eq 'yes')) {
2605: return(&retrievestudentphoto($udom,$unam,$ext));
2606: }
2607: }
2608: }
2609: }
2610: } else {
2611: my ($result,$perm_reqd) =
2612: &Apache::lonnet::auto_photo_permission($unam,$udom);
2613: if ($result eq 'ok') {
2614: if (!($perm_reqd eq 'yes')) {
2615: return(&retrievestudentphoto($udom,$unam,$ext));
2616: }
2617: }
2618: }
2619: return '/adm/lonKaputt/lonlogo_broken.gif';
2620: }
2621:
2622: sub retrievestudentphoto {
2623: my ($udom,$unam,$ext,$type) = @_;
2624: my $home=&Apache::lonnet::homeserver($unam,$udom);
2625: my $ret=&Apache::lonnet::reply("studentphoto:$udom:$unam:$ext:$type",$home);
2626: if ($ret eq 'ok') {
2627: my $url="/uploaded/$udom/$unam/internal/studentphoto.$ext";
2628: if ($type eq 'thumbnail') {
2629: $url="/uploaded/$udom/$unam/internal/studentphoto_tn.$ext";
2630: }
2631: my $tokenurl=&Apache::lonnet::tokenwrapper($url);
2632: return $tokenurl;
2633: } else {
2634: if ($type eq 'thumbnail') {
2635: return '/adm/lonKaputt/genericstudent_tn.gif';
2636: } else {
2637: return '/adm/lonKaputt/lonlogo_broken.gif';
2638: }
2639: }
2640: }
2641:
2642: # -------------------------------------------------------------------- New chat
2643:
2644: sub chatsend {
2645: my ($newentry,$anon,$group)=@_;
2646: my $cnum=$env{'course.'.$env{'request.course.id'}.'.num'};
2647: my $cdom=$env{'course.'.$env{'request.course.id'}.'.domain'};
2648: my $chome=$env{'course.'.$env{'request.course.id'}.'.home'};
2649: &reply('chatsend:'.$cdom.':'.$cnum.':'.
2650: &escape($env{'user.domain'}.':'.$env{'user.name'}.':'.$anon.':'.
2651: &escape($newentry)).':'.$group,$chome);
2652: }
2653:
2654: # ------------------------------------------ Find current version of a resource
2655:
2656: sub getversion {
2657: my $fname=&clutter(shift);
2658: unless ($fname=~m{^(/adm/wrapper|)/res/}) { return -1; }
2659: return ¤tversion(&filelocation('',$fname));
2660: }
2661:
2662: sub currentversion {
2663: my $fname=shift;
2664: my $author=$fname;
2665: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
2666: my ($udom,$uname)=split(/\//,$author);
2667: my $home=&homeserver($uname,$udom);
2668: if ($home eq 'no_host') {
2669: return -1;
2670: }
2671: my $answer=&reply("currentversion:$fname",$home);
2672: if (($answer eq 'con_lost') || ($answer eq 'rejected')) {
2673: return -1;
2674: }
2675: return $answer;
2676: }
2677:
2678: #
2679: # Return special version number of resource if set by override, empty otherwise
2680: #
2681: sub usedversion {
2682: my $fname=shift;
2683: unless ($fname) { $fname=$env{'request.uri'}; }
2684: my ($urlversion)=($fname=~/\.(\d+)\.\w+$/);
2685: if ($urlversion) { return $urlversion; }
2686: return '';
2687: }
2688:
2689: # ----------------------------- Subscribe to a resource, return URL if possible
2690:
2691: sub subscribe {
2692: my $fname=shift;
2693: if ($fname=~/\/(aboutme|syllabus|bulletinboard|smppg)$/) { return ''; }
2694: $fname=~s/[\n\r]//g;
2695: my $author=$fname;
2696: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
2697: my ($udom,$uname)=split(/\//,$author);
2698: my $home=homeserver($uname,$udom);
2699: if ($home eq 'no_host') {
2700: return 'not_found';
2701: }
2702: my $answer=reply("sub:$fname",$home);
2703: if (($answer eq 'con_lost') || ($answer eq 'rejected')) {
2704: $answer.=' by '.$home;
2705: }
2706: return $answer;
2707: }
2708:
2709: # -------------------------------------------------------------- Replicate file
2710:
2711: sub repcopy {
2712: my $filename=shift;
2713: $filename=~s/\/+/\//g;
2714: my $londocroot = $perlvar{'lonDocRoot'};
2715: if ($filename=~m{^\Q$londocroot/adm/\E}) { return 'ok'; }
2716: if ($filename=~m{^\Q/home/httpd/lonUsers/\E}) { return 'ok'; }
2717: if ($filename=~m{^\Q$londocroot/userfiles/\E} or
2718: $filename=~m{^/*(uploaded|editupload)/}) {
2719: return &repcopy_userfile($filename);
2720: }
2721: $filename=~s/[\n\r]//g;
2722: my $transname="$filename.in.transfer";
2723: # FIXME: this should flock
2724: if ((-e $filename) || (-e $transname)) { return 'ok'; }
2725: my $remoteurl=subscribe($filename);
2726: if ($remoteurl =~ /^con_lost by/) {
2727: &logthis("Subscribe returned $remoteurl: $filename");
2728: return 'unavailable';
2729: } elsif ($remoteurl eq 'not_found') {
2730: #&logthis("Subscribe returned not_found: $filename");
2731: return 'not_found';
2732: } elsif ($remoteurl =~ /^rejected by/) {
2733: &logthis("Subscribe returned $remoteurl: $filename");
2734: return 'forbidden';
2735: } elsif ($remoteurl eq 'directory') {
2736: return 'ok';
2737: } else {
2738: my $author=$filename;
2739: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
2740: my ($udom,$uname)=split(/\//,$author);
2741: my $home=homeserver($uname,$udom);
2742: unless ($home eq $perlvar{'lonHostID'}) {
2743: my @parts=split(/\//,$filename);
2744: my $path="/$parts[1]/$parts[2]/$parts[3]/$parts[4]";
2745: if ($path ne "$londocroot/res") {
2746: &logthis("Malconfiguration for replication: $filename");
2747: return 'bad_request';
2748: }
2749: my $count;
2750: for ($count=5;$count<$#parts;$count++) {
2751: $path.="/$parts[$count]";
2752: if ((-e $path)!=1) {
2753: mkdir($path,0777);
2754: }
2755: }
2756: my $ua=new LWP::UserAgent;
2757: my $request=new HTTP::Request('GET',"$remoteurl");
2758: my $response=$ua->request($request,$transname);
2759: if ($response->is_error()) {
2760: unlink($transname);
2761: my $message=$response->status_line;
2762: &logthis("<font color=\"blue\">WARNING:"
2763: ." LWP get: $message: $filename</font>");
2764: return 'unavailable';
2765: } else {
2766: if ($remoteurl!~/\.meta$/) {
2767: my $mrequest=new HTTP::Request('GET',$remoteurl.'.meta');
2768: my $mresponse=$ua->request($mrequest,$filename.'.meta');
2769: if ($mresponse->is_error()) {
2770: unlink($filename.'.meta');
2771: &logthis(
2772: "<font color=\"yellow\">INFO: No metadata: $filename</font>");
2773: }
2774: }
2775: rename($transname,$filename);
2776: return 'ok';
2777: }
2778: }
2779: }
2780: }
2781:
2782: # ------------------------------------------------ Get server side include body
2783: sub ssi_body {
2784: my ($filelink,%form)=@_;
2785: if (! exists($form{'LONCAPA_INTERNAL_no_discussion'})) {
2786: $form{'LONCAPA_INTERNAL_no_discussion'}='true';
2787: }
2788: my $output='';
2789: my $response;
2790: if ($filelink=~/^https?\:/) {
2791: ($output,$response)=&externalssi($filelink);
2792: } else {
2793: $filelink .= $filelink=~/\?/ ? '&' : '?';
2794: $filelink .= 'inhibitmenu=yes';
2795: ($output,$response)=&ssi($filelink,%form);
2796: }
2797: $output=~s|//(\s*<!--)? BEGIN LON-CAPA Internal.+?// END LON-CAPA Internal\s*(-->)?\s||gs;
2798: $output=~s/^.*?\<body[^\>]*\>//si;
2799: $output=~s/\<\/body\s*\>.*?$//si;
2800: if (wantarray) {
2801: return ($output, $response);
2802: } else {
2803: return $output;
2804: }
2805: }
2806:
2807: # --------------------------------------------------------- Server Side Include
2808:
2809: sub absolute_url {
2810: my ($host_name) = @_;
2811: my $protocol = ($ENV{'SERVER_PORT'} == 443?'https://':'http://');
2812: if ($host_name eq '') {
2813: $host_name = $ENV{'SERVER_NAME'};
2814: }
2815: return $protocol.$host_name;
2816: }
2817:
2818: #
2819: # Server side include.
2820: # Parameters:
2821: # fn Possibly encrypted resource name/id.
2822: # form Hash that describes how the rendering should be done
2823: # and other things.
2824: # Returns:
2825: # Scalar context: The content of the response.
2826: # Array context: 2 element list of the content and the full response object.
2827: #
2828: sub ssi {
2829:
2830: my ($fn,%form)=@_;
2831: my $ua=new LWP::UserAgent;
2832: my $request;
2833:
2834: $form{'no_update_last_known'}=1;
2835: &Apache::lonenc::check_encrypt(\$fn);
2836: if (%form) {
2837: $request=new HTTP::Request('POST',&absolute_url().$fn);
2838: $request->content(join('&',map {
2839: my $name = escape($_);
2840: "$name=" . ( ref($form{$_}) eq 'ARRAY'
2841: ? join("&$name=", map {escape($_) } @{$form{$_}})
2842: : &escape($form{$_}) );
2843: } keys(%form)));
2844: } else {
2845: $request=new HTTP::Request('GET',&absolute_url().$fn);
2846: }
2847:
2848: $request->header(Cookie => $ENV{'HTTP_COOKIE'});
2849: my $response= $ua->request($request);
2850: if (wantarray) {
2851: return ($response->content, $response);
2852: } else {
2853: return $response->content;
2854: }
2855: }
2856:
2857: sub externalssi {
2858: my ($url)=@_;
2859: my $ua=new LWP::UserAgent;
2860: my $request=new HTTP::Request('GET',$url);
2861: my $response=$ua->request($request);
2862: if (wantarray) {
2863: return ($response->content, $response);
2864: } else {
2865: return $response->content;
2866: }
2867: }
2868:
2869: # -------------------------------- Allow a /uploaded/ URI to be vouched for
2870:
2871: sub allowuploaded {
2872: my ($srcurl,$url)=@_;
2873: $url=&clutter(&declutter($url));
2874: my $dir=$url;
2875: $dir=~s/\/[^\/]+$//;
2876: my %httpref=();
2877: my $httpurl=&hreflocation('',$url);
2878: $httpref{'httpref.'.$httpurl}=$srcurl;
2879: &Apache::lonnet::appenv(\%httpref);
2880: }
2881:
2882: #
2883: # Determine if the current user should be able to edit a particular resource,
2884: # when viewing in course context.
2885: # (a) When viewing resource used to determine if "Edit" item is included in
2886: # Functions.
2887: # (b) When displaying folder contents in course editor, used to determine if
2888: # "Edit" link will be displayed alongside resource.
2889: #
2890: # input: six args -- filename (decluttered), course number, course domain,
2891: # url, symb (if registered) and group (if this is a group
2892: # item -- e.g., bulletin board, group page etc.).
2893: # output: array of five scalars --
2894: # $cfile -- url for file editing if editable on current server
2895: # $home -- homeserver of resource (i.e., for author if published,
2896: # or course if uploaded.).
2897: # $switchserver -- 1 if server switch will be needed.
2898: # $forceedit -- 1 if icon/link should be to go to edit mode
2899: # $forceview -- 1 if icon/link should be to go to view mode
2900: #
2901:
2902: sub can_edit_resource {
2903: my ($file,$cnum,$cdom,$resurl,$symb,$group) = @_;
2904: my ($cfile,$home,$switchserver,$forceedit,$forceview,$uploaded,$incourse);
2905: #
2906: # For aboutme pages user can only edit his/her own.
2907: #
2908: if ($resurl =~ m{^/?adm/($match_domain)/($match_username)/aboutme$}) {
2909: my ($sdom,$sname) = ($1,$2);
2910: if (($sdom eq $env{'user.domain'}) && ($sname eq $env{'user.name'})) {
2911: $home = $env{'user.home'};
2912: $cfile = $resurl;
2913: if ($env{'form.forceedit'}) {
2914: $forceview = 1;
2915: } else {
2916: $forceedit = 1;
2917: }
2918: return ($cfile,$home,$switchserver,$forceedit,$forceview);
2919: } else {
2920: return;
2921: }
2922: }
2923:
2924: if ($env{'request.course.id'}) {
2925: my $crsedit = &Apache::lonnet::allowed('mdc',$env{'request.course.id'});
2926: if ($group ne '') {
2927: # if this is a group homepage or group bulletin board, check group privs
2928: my $allowed = 0;
2929: if ($resurl =~ m{^/?adm/$cdom/$cnum/$group/smppg$}) {
2930: if ((&allowed('mdg',$env{'request.course.id'}.
2931: ($env{'request.course.sec'}?'/'.$env{'request.course.sec'}:''))) ||
2932: (&allowed('mgh',$env{'request.course.id'}.'/'.$group)) || $crsedit) {
2933: $allowed = 1;
2934: }
2935: } elsif ($resurl =~ m{^/?adm/$cdom/$cnum/\d+/bulletinboard$}) {
2936: if ((&allowed('mdg',$env{'request.course.id'}.($env{'request.course.sec'}?'/'.$env{'request.course.sec'}:''))) ||
2937: (&allowed('cgb',$env{'request.course.id'}.'/'.$group)) || $crsedit) {
2938: $allowed = 1;
2939: }
2940: }
2941: if ($allowed) {
2942: $home=&homeserver($cnum,$cdom);
2943: if ($env{'form.forceedit'}) {
2944: $forceview = 1;
2945: } else {
2946: $forceedit = 1;
2947: }
2948: $cfile = $resurl;
2949: } else {
2950: return;
2951: }
2952: } else {
2953: if ($resurl =~ m{^/?adm/viewclasslist$}) {
2954: unless (&Apache::lonnet::allowed('opa',$env{'request.course.id'})) {
2955: return;
2956: }
2957: } elsif (!$crsedit) {
2958: #
2959: # No edit allowed where CC has switched to student role.
2960: #
2961: return;
2962: }
2963: }
2964: }
2965:
2966: if ($file ne '') {
2967: if (($cnum =~ /$match_courseid/) && ($cdom =~ /$match_domain/)) {
2968: if (&is_course_upload($file,$cnum,$cdom)) {
2969: $uploaded = 1;
2970: $incourse = 1;
2971: if ($file =~/\.(htm|html|css|js|txt)$/) {
2972: $cfile = &hreflocation('',$file);
2973: if ($env{'form.forceedit'}) {
2974: $forceview = 1;
2975: } else {
2976: $forceedit = 1;
2977: }
2978: }
2979: } elsif ($resurl =~ m{^/public/$cdom/$cnum/syllabus}) {
2980: $incourse = 1;
2981: if ($env{'form.forceedit'}) {
2982: $forceview = 1;
2983: } else {
2984: $forceedit = 1;
2985: }
2986: $cfile = $resurl;
2987: } elsif (($resurl ne '') && (&is_on_map($resurl))) {
2988: if ($resurl =~ m{^/adm/$match_domain/$match_username/\d+/smppg|bulletinboard$}) {
2989: $incourse = 1;
2990: if ($env{'form.forceedit'}) {
2991: $forceview = 1;
2992: } else {
2993: $forceedit = 1;
2994: }
2995: $cfile = $resurl;
2996: } elsif ($resurl eq '/res/lib/templates/simpleproblem.problem') {
2997: $incourse = 1;
2998: $cfile = $resurl.'/smpedit';
2999: } elsif ($resurl =~ m{^/adm/wrapper/ext/}) {
3000: $incourse = 1;
3001: if ($env{'form.forceedit'}) {
3002: $forceview = 1;
3003: } else {
3004: $forceedit = 1;
3005: }
3006: $cfile = $resurl;
3007: } elsif ($resurl =~ m{^/?adm/viewclasslist$}) {
3008: $incourse = 1;
3009: if ($env{'form.forceedit'}) {
3010: $forceview = 1;
3011: } else {
3012: $forceedit = 1;
3013: }
3014: $cfile = ($resurl =~ m{^/} ? $resurl : "/$resurl");
3015: }
3016: } elsif ($resurl eq '/res/lib/templates/simpleproblem.problem/smpedit') {
3017: my $template = '/res/lib/templates/simpleproblem.problem';
3018: if (&is_on_map($template)) {
3019: $incourse = 1;
3020: $forceview = 1;
3021: $cfile = $template;
3022: }
3023: } elsif (($resurl =~ m{^/adm/wrapper/ext/}) && ($env{'form.folderpath'} =~ /^supplemental/)) {
3024: $incourse = 1;
3025: if ($env{'form.forceedit'}) {
3026: $forceview = 1;
3027: } else {
3028: $forceedit = 1;
3029: }
3030: $cfile = $resurl;
3031: } elsif (($resurl eq '/adm/extresedit') && ($symb || $env{'form.folderpath'})) {
3032: $incourse = 1;
3033: $forceview = 1;
3034: if ($symb) {
3035: my ($map,$id,$res)=&decode_symb($symb);
3036: $env{'request.symb'} = $symb;
3037: $cfile = &clutter($res);
3038: } else {
3039: $cfile = $env{'form.suppurl'};
3040: $cfile =~ s{^http://}{};
3041: $cfile = '/adm/wrapper/ext/'.$cfile;
3042: }
3043: } elsif ($resurl =~ m{^/?adm/viewclasslist$}) {
3044: if ($env{'form.forceedit'}) {
3045: $forceview = 1;
3046: } else {
3047: $forceedit = 1;
3048: }
3049: $cfile = ($resurl =~ m{^/} ? $resurl : "/$resurl");
3050: }
3051: }
3052: if ($uploaded || $incourse) {
3053: $home=&homeserver($cnum,$cdom);
3054: } elsif ($file !~ m{/$}) {
3055: $file=~s{^(priv/$match_domain/$match_username)}{/$1};
3056: $file=~s{^($match_domain/$match_username)}{/priv/$1};
3057: # Check that the user has permission to edit this resource
3058: my $setpriv = 1;
3059: my ($cfuname,$cfudom)=&constructaccess($file,$setpriv);
3060: if (defined($cfudom)) {
3061: $home=&homeserver($cfuname,$cfudom);
3062: $cfile=$file;
3063: }
3064: }
3065: if (($cfile ne '') && (!$incourse || $uploaded) &&
3066: (($home ne '') && ($home ne 'no_host'))) {
3067: my @ids=¤t_machine_ids();
3068: unless (grep(/^\Q$home\E$/,@ids)) {
3069: $switchserver=1;
3070: }
3071: }
3072: }
3073: return ($cfile,$home,$switchserver,$forceedit,$forceview);
3074: }
3075:
3076: sub is_course_upload {
3077: my ($file,$cnum,$cdom) = @_;
3078: my $uploadpath = &LONCAPA::propath($cdom,$cnum);
3079: $uploadpath =~ s{^\/}{};
3080: if (($file =~ m{^\Q$uploadpath\E/userfiles/(docs|supplemental)/}) ||
3081: ($file =~ m{^userfiles/\Q$cdom\E/\Q$cnum\E/(docs|supplemental)/})) {
3082: return 1;
3083: }
3084: return;
3085: }
3086:
3087: sub in_course {
3088: my ($udom,$uname,$cdom,$cnum,$type,$hideprivileged) = @_;
3089: if ($hideprivileged) {
3090: my $skipuser;
3091: my %coursehash = &coursedescription($cdom.'_'.$cnum);
3092: my @possdoms = ($cdom);
3093: if ($coursehash{'checkforpriv'}) {
3094: push(@possdoms,split(/,/,$coursehash{'checkforpriv'}));
3095: }
3096: if (&privileged($uname,$udom,\@possdoms)) {
3097: $skipuser = 1;
3098: if ($coursehash{'nothideprivileged'}) {
3099: foreach my $item (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
3100: my $user;
3101: if ($item =~ /:/) {
3102: $user = $item;
3103: } else {
3104: $user = join(':',split(/[\@]/,$item));
3105: }
3106: if ($user eq $uname.':'.$udom) {
3107: undef($skipuser);
3108: last;
3109: }
3110: }
3111: }
3112: if ($skipuser) {
3113: return 0;
3114: }
3115: }
3116: }
3117: $type ||= 'any';
3118: if (!defined($cdom) || !defined($cnum)) {
3119: my $cid = $env{'request.course.id'};
3120: $cdom = $env{'course.'.$cid.'.domain'};
3121: $cnum = $env{'course.'.$cid.'.num'};
3122: }
3123: my $typesref;
3124: if (($type eq 'any') || ($type eq 'all')) {
3125: $typesref = ['active','previous','future'];
3126: } elsif ($type eq 'previous' || $type eq 'future') {
3127: $typesref = [$type];
3128: }
3129: my %roles = &get_my_roles($uname,$udom,'userroles',
3130: $typesref,undef,[$cdom]);
3131: my ($tmp) = keys(%roles);
3132: return 0 if ($tmp =~ /^(con_lost|error|no_such_host)/i);
3133: my @course_roles = grep(/^\Q$cnum\E:\Q$cdom\E:/, keys(%roles));
3134: if (@course_roles > 0) {
3135: return 1;
3136: }
3137: return 0;
3138: }
3139:
3140: # --------- File operations in /home/httpd/html/userfiles/$domain/1/2/3/$course
3141: # input: action, courseID, current domain, intended
3142: # path to file, source of file, instruction to parse file for objects,
3143: # ref to hash for embedded objects,
3144: # ref to hash for codebase of java objects.
3145: # reference to scalar to accommodate mime type determined
3146: # from File::MMagic if $parser = parse.
3147: #
3148: # output: url to file (if action was uploaddoc),
3149: # ok if successful, or diagnostic message otherwise (if action was propagate or copy)
3150: #
3151: # Allows directory structure to be used within lonUsers/../userfiles/ for a
3152: # course.
3153: #
3154: # action = propagate - /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
3155: # will be copied to /home/httpd/lonUsers/1/2/3/$course/userfiles in
3156: # course's home server.
3157: #
3158: # action = copy - /home/httpd/html/userfiles/$domain/1/2/3/$course/$file will
3159: # be copied from $source (current location) to
3160: # /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
3161: # and will then be copied to
3162: # /home/httpd/lonUsers/$domain/1/2/3/$course/userfiles/$file in
3163: # course's home server.
3164: #
3165: # action = uploaddoc - /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
3166: # will be retrived from $env{form.uploaddoc} (from DOCS interface) to
3167: # /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
3168: # and will then be copied to /home/httpd/lonUsers/1/2/3/$course/userfiles/$file
3169: # in course's home server.
3170: #
3171:
3172: sub process_coursefile {
3173: my ($action,$docuname,$docudom,$file,$source,$parser,$allfiles,$codebase,
3174: $mimetype)=@_;
3175: my $fetchresult;
3176: my $home=&homeserver($docuname,$docudom);
3177: if ($action eq 'propagate') {
3178: $fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
3179: $home);
3180: } else {
3181: my $fpath = '';
3182: my $fname = $file;
3183: ($fpath,$fname) = ($file =~ m|^(.*)/([^/]+)$|);
3184: $fpath=$docudom.'/'.$docuname.'/'.$fpath;
3185: my $filepath = &build_filepath($fpath);
3186: if ($action eq 'copy') {
3187: if ($source eq '') {
3188: $fetchresult = 'no source file';
3189: return $fetchresult;
3190: } else {
3191: my $destination = $filepath.'/'.$fname;
3192: rename($source,$destination);
3193: $fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
3194: $home);
3195: }
3196: } elsif ($action eq 'uploaddoc') {
3197: open(my $fh,'>'.$filepath.'/'.$fname);
3198: print $fh $env{'form.'.$source};
3199: close($fh);
3200: if ($parser eq 'parse') {
3201: my $mm = new File::MMagic;
3202: my $type = $mm->checktype_filename($filepath.'/'.$fname);
3203: if ($type eq 'text/html') {
3204: my $parse_result = &extract_embedded_items($filepath.'/'.$fname,$allfiles,$codebase);
3205: unless ($parse_result eq 'ok') {
3206: &logthis('Failed to parse '.$filepath.'/'.$fname.' for embedded media: '.$parse_result);
3207: }
3208: }
3209: if (ref($mimetype)) {
3210: $$mimetype = $type;
3211: }
3212: }
3213: $fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
3214: $home);
3215: if ($fetchresult eq 'ok') {
3216: return '/uploaded/'.$fpath.'/'.$fname;
3217: } else {
3218: &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$file.
3219: ' to host '.$home.': '.$fetchresult);
3220: return '/adm/notfound.html';
3221: }
3222: }
3223: }
3224: unless ( $fetchresult eq 'ok') {
3225: &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$file.
3226: ' to host '.$home.': '.$fetchresult);
3227: }
3228: return $fetchresult;
3229: }
3230:
3231: sub build_filepath {
3232: my ($fpath) = @_;
3233: my $filepath=$perlvar{'lonDocRoot'}.'/userfiles';
3234: unless ($fpath eq '') {
3235: my @parts=split('/',$fpath);
3236: foreach my $part (@parts) {
3237: $filepath.= '/'.$part;
3238: if ((-e $filepath)!=1) {
3239: mkdir($filepath,0777);
3240: }
3241: }
3242: }
3243: return $filepath;
3244: }
3245:
3246: sub store_edited_file {
3247: my ($primary_url,$content,$docudom,$docuname,$fetchresult) = @_;
3248: my $file = $primary_url;
3249: $file =~ s#^/uploaded/$docudom/$docuname/##;
3250: my $fpath = '';
3251: my $fname = $file;
3252: ($fpath,$fname) = ($file =~ m|^(.*)/([^/]+)$|);
3253: $fpath=$docudom.'/'.$docuname.'/'.$fpath;
3254: my $filepath = &build_filepath($fpath);
3255: open(my $fh,'>'.$filepath.'/'.$fname);
3256: print $fh $content;
3257: close($fh);
3258: my $home=&homeserver($docuname,$docudom);
3259: $$fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
3260: $home);
3261: if ($$fetchresult eq 'ok') {
3262: return '/uploaded/'.$fpath.'/'.$fname;
3263: } else {
3264: &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$file.
3265: ' to host '.$home.': '.$$fetchresult);
3266: return '/adm/notfound.html';
3267: }
3268: }
3269:
3270: sub clean_filename {
3271: my ($fname,$args)=@_;
3272: # Replace Windows backslashes by forward slashes
3273: $fname=~s/\\/\//g;
3274: if (!$args->{'keep_path'}) {
3275: # Get rid of everything but the actual filename
3276: $fname=~s/^.*\/([^\/]+)$/$1/;
3277: }
3278: # Replace spaces by underscores
3279: $fname=~s/\s+/\_/g;
3280: # Replace all other weird characters by nothing
3281: $fname=~s{[^/\w\.\-]}{}g;
3282: # Replace all .\d. sequences with _\d. so they no longer look like version
3283: # numbers
3284: $fname=~s/\.(\d+)(?=\.)/_$1/g;
3285: return $fname;
3286: }
3287: # This Function checks if an Image's dimensions exceed either $resizewidth (width)
3288: # or $resizeheight (height) - both pixels. If so, the image is scaled to produce an
3289: # image with the same aspect ratio as the original, but with dimensions which do
3290: # not exceed $resizewidth and $resizeheight.
3291:
3292: sub resizeImage {
3293: my ($img_path,$resizewidth,$resizeheight) = @_;
3294: my $ima = Image::Magick->new;
3295: my $resized;
3296: if (-e $img_path) {
3297: $ima->Read($img_path);
3298: if (($resizewidth =~ /^\d+$/) && ($resizeheight > 0)) {
3299: my $width = $ima->Get('width');
3300: my $height = $ima->Get('height');
3301: if ($width > $resizewidth) {
3302: my $factor = $width/$resizewidth;
3303: my $newheight = $height/$factor;
3304: $ima->Scale(width=>$resizewidth,height=>$newheight);
3305: $resized = 1;
3306: }
3307: }
3308: if (($resizeheight =~ /^\d+$/) && ($resizeheight > 0)) {
3309: my $width = $ima->Get('width');
3310: my $height = $ima->Get('height');
3311: if ($height > $resizeheight) {
3312: my $factor = $height/$resizeheight;
3313: my $newwidth = $width/$factor;
3314: $ima->Scale(width=>$newwidth,height=>$resizeheight);
3315: $resized = 1;
3316: }
3317: }
3318: if ($resized) {
3319: $ima->Write($img_path);
3320: }
3321: }
3322: return;
3323: }
3324:
3325: # --------------- Take an uploaded file and put it into the userfiles directory
3326: # input: $formname - the contents of the file are in $env{"form.$formname"}
3327: # the desired filename is in $env{"form.$formname.filename"}
3328: # $context - possible values: coursedoc, existingfile, overwrite,
3329: # canceloverwrite, or ''.
3330: # if 'coursedoc': upload to the current course
3331: # if 'existingfile': write file to tmp/overwrites directory
3332: # if 'canceloverwrite': delete file written to tmp/overwrites directory
3333: # $context is passed as argument to &finishuserfileupload
3334: # $subdir - directory in userfile to store the file into
3335: # $parser - instruction to parse file for objects ($parser = parse)
3336: # $allfiles - reference to hash for embedded objects
3337: # $codebase - reference to hash for codebase of java objects
3338: # $desuname - username for permanent storage of uploaded file
3339: # $dsetudom - domain for permanaent storage of uploaded file
3340: # $thumbwidth - width (pixels) of thumbnail to make for uploaded image
3341: # $thumbheight - height (pixels) of thumbnail to make for uploaded image
3342: # $resizewidth - width (pixels) to which to resize uploaded image
3343: # $resizeheight - height (pixels) to which to resize uploaded image
3344: # $mimetype - reference to scalar to accommodate mime type determined
3345: # from File::MMagic.
3346: #
3347: # output: url of file in userspace, or error: <message>
3348: # or /adm/notfound.html if failure to upload occurse
3349:
3350: sub userfileupload {
3351: my ($formname,$context,$subdir,$parser,$allfiles,$codebase,$destuname,
3352: $destudom,$thumbwidth,$thumbheight,$resizewidth,$resizeheight,$mimetype)=@_;
3353: if (!defined($subdir)) { $subdir='unknown'; }
3354: my $fname=$env{'form.'.$formname.'.filename'};
3355: $fname=&clean_filename($fname);
3356: # See if there is anything left
3357: unless ($fname) { return 'error: no uploaded file'; }
3358: # Files uploaded to help request form, or uploaded to "create course" page are handled differently
3359: if ((($formname eq 'screenshot') && ($subdir eq 'helprequests')) ||
3360: (($formname eq 'coursecreatorxml') && ($subdir eq 'batchupload')) ||
3361: ($context eq 'existingfile') || ($context eq 'canceloverwrite')) {
3362: my $now = time;
3363: my $filepath;
3364: if (($formname eq 'screenshot') && ($subdir eq 'helprequests')) {
3365: $filepath = 'tmp/helprequests/'.$now;
3366: } elsif (($formname eq 'coursecreatorxml') && ($subdir eq 'batchupload')) {
3367: $filepath = 'tmp/addcourse/'.$destudom.'/web/'.$env{'user.name'}.
3368: '_'.$env{'user.domain'}.'/pending';
3369: } elsif (($context eq 'existingfile') || ($context eq 'canceloverwrite')) {
3370: my ($docuname,$docudom);
3371: if ($destudom) {
3372: $docudom = $destudom;
3373: } else {
3374: $docudom = $env{'user.domain'};
3375: }
3376: if ($destuname) {
3377: $docuname = $destuname;
3378: } else {
3379: $docuname = $env{'user.name'};
3380: }
3381: if (exists($env{'form.group'})) {
3382: $docuname=$env{'course.'.$env{'request.course.id'}.'.num'};
3383: $docudom=$env{'course.'.$env{'request.course.id'}.'.domain'};
3384: }
3385: $filepath = 'tmp/overwrites/'.$docudom.'/'.$docuname.'/'.$subdir;
3386: if ($context eq 'canceloverwrite') {
3387: my $tempfile = $perlvar{'lonDaemons'}.'/'.$filepath.'/'.$fname;
3388: if (-e $tempfile) {
3389: my @info = stat($tempfile);
3390: if ($info[9] eq $env{'form.timestamp'}) {
3391: unlink($tempfile);
3392: }
3393: }
3394: return;
3395: }
3396: }
3397: # Create the directory if not present
3398: my @parts=split(/\//,$filepath);
3399: my $fullpath = $perlvar{'lonDaemons'};
3400: for (my $i=0;$i<@parts;$i++) {
3401: $fullpath .= '/'.$parts[$i];
3402: if ((-e $fullpath)!=1) {
3403: mkdir($fullpath,0777);
3404: }
3405: }
3406: open(my $fh,'>'.$fullpath.'/'.$fname);
3407: print $fh $env{'form.'.$formname};
3408: close($fh);
3409: if ($context eq 'existingfile') {
3410: my @info = stat($fullpath.'/'.$fname);
3411: return ($fullpath.'/'.$fname,$info[9]);
3412: } else {
3413: return $fullpath.'/'.$fname;
3414: }
3415: }
3416: if ($subdir eq 'scantron') {
3417: $fname = 'scantron_orig_'.$fname;
3418: } else {
3419: $fname="$subdir/$fname";
3420: }
3421: if ($context eq 'coursedoc') {
3422: my $docuname=$env{'course.'.$env{'request.course.id'}.'.num'};
3423: my $docudom=$env{'course.'.$env{'request.course.id'}.'.domain'};
3424: if ($env{'form.folder'} =~ m/^(default|supplemental)/) {
3425: return &finishuserfileupload($docuname,$docudom,
3426: $formname,$fname,$parser,$allfiles,
3427: $codebase,$thumbwidth,$thumbheight,
3428: $resizewidth,$resizeheight,$context,$mimetype);
3429: } else {
3430: if ($env{'form.folder'}) {
3431: $fname=$env{'form.folder'}.'/'.$fname;
3432: }
3433: return &process_coursefile('uploaddoc',$docuname,$docudom,
3434: $fname,$formname,$parser,
3435: $allfiles,$codebase,$mimetype);
3436: }
3437: } elsif (defined($destuname)) {
3438: my $docuname=$destuname;
3439: my $docudom=$destudom;
3440: return &finishuserfileupload($docuname,$docudom,$formname,$fname,
3441: $parser,$allfiles,$codebase,
3442: $thumbwidth,$thumbheight,
3443: $resizewidth,$resizeheight,$context,$mimetype);
3444: } else {
3445: my $docuname=$env{'user.name'};
3446: my $docudom=$env{'user.domain'};
3447: if ((exists($env{'form.group'})) || ($context eq 'syllabus')) {
3448: $docuname=$env{'course.'.$env{'request.course.id'}.'.num'};
3449: $docudom=$env{'course.'.$env{'request.course.id'}.'.domain'};
3450: }
3451: return &finishuserfileupload($docuname,$docudom,$formname,$fname,
3452: $parser,$allfiles,$codebase,
3453: $thumbwidth,$thumbheight,
3454: $resizewidth,$resizeheight,$context,$mimetype);
3455: }
3456: }
3457:
3458: sub finishuserfileupload {
3459: my ($docuname,$docudom,$formname,$fname,$parser,$allfiles,$codebase,
3460: $thumbwidth,$thumbheight,$resizewidth,$resizeheight,$context,$mimetype) = @_;
3461: my $path=$docudom.'/'.$docuname.'/';
3462: my $filepath=$perlvar{'lonDocRoot'};
3463:
3464: my ($fnamepath,$file,$fetchthumb);
3465: $file=$fname;
3466: if ($fname=~m|/|) {
3467: ($fnamepath,$file) = ($fname =~ m|^(.*)/([^/]+)$|);
3468: $path.=$fnamepath.'/';
3469: }
3470: my @parts=split(/\//,$filepath.'/userfiles/'.$path);
3471: my $count;
3472: for ($count=4;$count<=$#parts;$count++) {
3473: $filepath.="/$parts[$count]";
3474: if ((-e $filepath)!=1) {
3475: mkdir($filepath,0777);
3476: }
3477: }
3478:
3479: # Save the file
3480: {
3481: if (!open(FH,'>'.$filepath.'/'.$file)) {
3482: &logthis('Failed to create '.$filepath.'/'.$file);
3483: print STDERR ('Failed to create '.$filepath.'/'.$file."\n");
3484: return '/adm/notfound.html';
3485: }
3486: if ($context eq 'overwrite') {
3487: my $source = LONCAPA::tempdir().'/overwrites/'.$docudom.'/'.$docuname.'/'.$fname;
3488: my $target = $filepath.'/'.$file;
3489: if (-e $source) {
3490: my @info = stat($source);
3491: if ($info[9] eq $env{'form.timestamp'}) {
3492: unless (&File::Copy::move($source,$target)) {
3493: &logthis('Failed to overwrite '.$filepath.'/'.$file);
3494: return "Moving from $source failed";
3495: }
3496: } else {
3497: return "Temporary file: $source had unexpected date/time for last modification";
3498: }
3499: } else {
3500: return "Temporary file: $source missing";
3501: }
3502: } elsif (!print FH ($env{'form.'.$formname})) {
3503: &logthis('Failed to write to '.$filepath.'/'.$file);
3504: print STDERR ('Failed to write to '.$filepath.'/'.$file."\n");
3505: return '/adm/notfound.html';
3506: }
3507: close(FH);
3508: if ($resizewidth && $resizeheight) {
3509: my $mm = new File::MMagic;
3510: my $mime_type = $mm->checktype_filename($filepath.'/'.$file);
3511: if ($mime_type =~ m{^image/}) {
3512: &resizeImage($filepath.'/'.$file,$resizewidth,$resizeheight);
3513: }
3514: }
3515: }
3516: if (($context eq 'coursedoc') || ($parser eq 'parse')) {
3517: if (ref($mimetype)) {
3518: if ($$mimetype eq '') {
3519: my $mm = new File::MMagic;
3520: my $type = $mm->checktype_filename($filepath.'/'.$file);
3521: $$mimetype = $type;
3522: }
3523: }
3524: }
3525: if ($parser eq 'parse') {
3526: if ((ref($mimetype)) && ($$mimetype eq 'text/html')) {
3527: my $parse_result = &extract_embedded_items($filepath.'/'.$file,
3528: $allfiles,$codebase);
3529: unless ($parse_result eq 'ok') {
3530: &logthis('Failed to parse '.$filepath.$file.
3531: ' for embedded media: '.$parse_result);
3532: }
3533: }
3534: }
3535: if (($thumbwidth =~ /^\d+$/) && ($thumbheight =~ /^\d+$/)) {
3536: my $input = $filepath.'/'.$file;
3537: my $output = $filepath.'/'.'tn-'.$file;
3538: my $thumbsize = $thumbwidth.'x'.$thumbheight;
3539: system("convert -sample $thumbsize $input $output");
3540: if (-e $filepath.'/'.'tn-'.$file) {
3541: $fetchthumb = 1;
3542: }
3543: }
3544:
3545: # Notify homeserver to grep it
3546: #
3547: my $docuhome=&homeserver($docuname,$docudom);
3548: my $fetchresult= &reply('fetchuserfile:'.$path.$file,$docuhome);
3549: if ($fetchresult eq 'ok') {
3550: if ($fetchthumb) {
3551: my $thumbresult= &reply('fetchuserfile:'.$path.'tn-'.$file,$docuhome);
3552: if ($thumbresult ne 'ok') {
3553: &logthis('Failed to transfer '.$path.'tn-'.$file.' to host '.
3554: $docuhome.': '.$thumbresult);
3555: }
3556: }
3557: #
3558: # Return the URL to it
3559: return '/uploaded/'.$path.$file;
3560: } else {
3561: &logthis('Failed to transfer '.$path.$file.' to host '.$docuhome.
3562: ': '.$fetchresult);
3563: return '/adm/notfound.html';
3564: }
3565: }
3566:
3567: sub extract_embedded_items {
3568: my ($fullpath,$allfiles,$codebase,$content) = @_;
3569: my @state = ();
3570: my (%lastids,%related,%shockwave,%flashvars);
3571: my %javafiles = (
3572: codebase => '',
3573: code => '',
3574: archive => ''
3575: );
3576: my %mediafiles = (
3577: src => '',
3578: movie => '',
3579: );
3580: my $p;
3581: if ($content) {
3582: $p = HTML::LCParser->new($content);
3583: } else {
3584: $p = HTML::LCParser->new($fullpath);
3585: }
3586: while (my $t=$p->get_token()) {
3587: if ($t->[0] eq 'S') {
3588: my ($tagname, $attr) = ($t->[1],$t->[2]);
3589: push(@state, $tagname);
3590: if (lc($tagname) eq 'allow') {
3591: &add_filetype($allfiles,$attr->{'src'},'src');
3592: }
3593: if (lc($tagname) eq 'img') {
3594: &add_filetype($allfiles,$attr->{'src'},'src');
3595: }
3596: if (lc($tagname) eq 'a') {
3597: unless (($attr->{'href'} =~ /^#/) || ($attr->{'href'} eq '')) {
3598: &add_filetype($allfiles,$attr->{'href'},'href');
3599: }
3600: }
3601: if (lc($tagname) eq 'script') {
3602: my $src;
3603: if ($attr->{'archive'} =~ /\.jar$/i) {
3604: &add_filetype($allfiles,$attr->{'archive'},'archive');
3605: } else {
3606: if ($attr->{'src'} ne '') {
3607: $src = $attr->{'src'};
3608: &add_filetype($allfiles,$src,'src');
3609: }
3610: }
3611: my $text = $p->get_trimmed_text();
3612: if ($text =~ /\Qswfobject.registerObject(\E([^\)]+)\)/) {
3613: my @swfargs = split(/,/,$1);
3614: foreach my $item (@swfargs) {
3615: $item =~ s/["']//g;
3616: $item =~ s/^\s+//;
3617: $item =~ s/\s+$//;
3618: }
3619: if (($swfargs[0] ne'') && ($swfargs[2] ne '')) {
3620: if (ref($related{$swfargs[0]}) eq 'ARRAY') {
3621: push(@{$related{$swfargs[0]}},$swfargs[2]);
3622: } else {
3623: $related{$swfargs[0]} = [$swfargs[2]];
3624: }
3625: }
3626: }
3627: }
3628: if (lc($tagname) eq 'link') {
3629: if (lc($attr->{'rel'}) eq 'stylesheet') {
3630: &add_filetype($allfiles,$attr->{'href'},'href');
3631: }
3632: }
3633: if (lc($tagname) eq 'object' ||
3634: (lc($tagname) eq 'embed' && lc($state[-2]) ne 'object')) {
3635: foreach my $item (keys(%javafiles)) {
3636: $javafiles{$item} = '';
3637: }
3638: if ((lc($tagname) eq 'object') && (lc($state[-2]) ne 'object')) {
3639: $lastids{lc($tagname)} = $attr->{'id'};
3640: }
3641: }
3642: if (lc($state[-2]) eq 'object' && lc($tagname) eq 'param') {
3643: my $name = lc($attr->{'name'});
3644: foreach my $item (keys(%javafiles)) {
3645: if ($name eq $item) {
3646: $javafiles{$item} = $attr->{'value'};
3647: last;
3648: }
3649: }
3650: my $pathfrom;
3651: foreach my $item (keys(%mediafiles)) {
3652: if ($name eq $item) {
3653: $pathfrom = $attr->{'value'};
3654: $shockwave{$lastids{lc($state[-2])}} = $pathfrom;
3655: &add_filetype($allfiles,$pathfrom,$name);
3656: last;
3657: }
3658: }
3659: if ($name eq 'flashvars') {
3660: $flashvars{$lastids{lc($state[-2])}} = $attr->{'value'};
3661: }
3662: if ($pathfrom ne '') {
3663: &embedded_dependency($allfiles,\%related,$lastids{lc($state[-2])},
3664: $pathfrom);
3665: }
3666: }
3667: if (lc($tagname) eq 'embed' || lc($tagname) eq 'applet') {
3668: foreach my $item (keys(%javafiles)) {
3669: if ($attr->{$item}) {
3670: $javafiles{$item} = $attr->{$item};
3671: last;
3672: }
3673: }
3674: foreach my $item (keys(%mediafiles)) {
3675: if ($attr->{$item}) {
3676: &add_filetype($allfiles,$attr->{$item},$item);
3677: last;
3678: }
3679: }
3680: if (lc($tagname) eq 'embed') {
3681: if (($attr->{'name'} ne '') && ($attr->{'src'} ne '')) {
3682: &embedded_dependency($allfiles,\%related,$attr->{'name'},
3683: $attr->{'src'});
3684: }
3685: }
3686: }
3687: if (lc($tagname) eq 'iframe') {
3688: my $src = $attr->{'src'} ;
3689: if (($src ne '') && ($src !~ m{^(/|https?://)})) {
3690: &add_filetype($allfiles,$src,'src');
3691: } elsif ($src =~ m{^/}) {
3692: if ($env{'request.course.id'}) {
3693: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
3694: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
3695: my $url = &hreflocation('',$fullpath);
3696: if ($url =~ m{^/uploaded/$cdom/$cnum/docs/(\w+/\d+)/}) {
3697: my $relpath = $1;
3698: if ($src =~ m{^/uploaded/$cdom/$cnum/docs/\Q$relpath\E/(.+)$}) {
3699: &add_filetype($allfiles,$1,'src');
3700: }
3701: }
3702: }
3703: }
3704: }
3705: if ($t->[4] =~ m{/>$}) {
3706: pop(@state);
3707: }
3708: } elsif ($t->[0] eq 'E') {
3709: my ($tagname) = ($t->[1]);
3710: if ($javafiles{'codebase'} ne '') {
3711: $javafiles{'codebase'} .= '/';
3712: }
3713: if (lc($tagname) eq 'applet' ||
3714: lc($tagname) eq 'object' ||
3715: (lc($tagname) eq 'embed' && lc($state[-2]) ne 'object')
3716: ) {
3717: foreach my $item (keys(%javafiles)) {
3718: if ($item ne 'codebase' && $javafiles{$item} ne '') {
3719: my $file=$javafiles{'codebase'}.$javafiles{$item};
3720: &add_filetype($allfiles,$file,$item);
3721: }
3722: }
3723: }
3724: pop @state;
3725: }
3726: }
3727: foreach my $id (sort(keys(%flashvars))) {
3728: if ($shockwave{$id} ne '') {
3729: my @pairs = split(/\&/,$flashvars{$id});
3730: foreach my $pair (@pairs) {
3731: my ($key,$value) = split(/\=/,$pair);
3732: if ($key eq 'thumb') {
3733: &add_filetype($allfiles,$value,$key);
3734: } elsif ($key eq 'content') {
3735: my ($path) = ($shockwave{$id} =~ m{^(.+/)[^/]+$});
3736: my ($ext) = ($value =~ /\.([^.]+)$/);
3737: if ($ext ne '') {
3738: &add_filetype($allfiles,$path.$value,$ext);
3739: }
3740: }
3741: }
3742: }
3743: }
3744: return 'ok';
3745: }
3746:
3747: sub add_filetype {
3748: my ($allfiles,$file,$type)=@_;
3749: if (exists($allfiles->{$file})) {
3750: unless (grep/^\Q$type\E$/, @{$allfiles->{$file}}) {
3751: push(@{$allfiles->{$file}}, &escape($type));
3752: }
3753: } else {
3754: @{$allfiles->{$file}} = (&escape($type));
3755: }
3756: }
3757:
3758: sub embedded_dependency {
3759: my ($allfiles,$related,$identifier,$pathfrom) = @_;
3760: if ((ref($allfiles) eq 'HASH') && (ref($related) eq 'HASH')) {
3761: if (($identifier ne '') &&
3762: (ref($related->{$identifier}) eq 'ARRAY') &&
3763: ($pathfrom ne '')) {
3764: my ($path) = ($pathfrom =~ m{^(.+/)[^/]+$});
3765: foreach my $dep (@{$related->{$identifier}}) {
3766: &add_filetype($allfiles,$path.$dep,'object');
3767: }
3768: }
3769: }
3770: return;
3771: }
3772:
3773: sub removeuploadedurl {
3774: my ($url)=@_;
3775: my (undef,undef,$udom,$uname,$fname)=split('/',$url,5);
3776: return &removeuserfile($uname,$udom,$fname);
3777: }
3778:
3779: sub removeuserfile {
3780: my ($docuname,$docudom,$fname)=@_;
3781: my $home=&homeserver($docuname,$docudom);
3782: my $result = &reply("removeuserfile:$docudom/$docuname/$fname",$home);
3783: if ($result eq 'ok') {
3784: if (($fname !~ /\.meta$/) && (&is_portfolio_file($fname))) {
3785: my $metafile = $fname.'.meta';
3786: my $metaresult = &removeuserfile($docuname,$docudom,$metafile);
3787: my $url = "/uploaded/$docudom/$docuname/$fname";
3788: my ($file,$group) = (&parse_portfolio_url($url))[3,4];
3789: my $sqlresult =
3790: &update_portfolio_table($docuname,$docudom,$file,
3791: 'portfolio_metadata',$group,
3792: 'delete');
3793: }
3794: }
3795: return $result;
3796: }
3797:
3798: sub mkdiruserfile {
3799: my ($docuname,$docudom,$dir)=@_;
3800: my $home=&homeserver($docuname,$docudom);
3801: return &reply("mkdiruserfile:".&escape("$docudom/$docuname/$dir"),$home);
3802: }
3803:
3804: sub renameuserfile {
3805: my ($docuname,$docudom,$old,$new)=@_;
3806: my $home=&homeserver($docuname,$docudom);
3807: my $result = &reply("renameuserfile:$docudom:$docuname:".
3808: &escape("$old").':'.&escape("$new"),$home);
3809: if ($result eq 'ok') {
3810: if (($old !~ /\.meta$/) && (&is_portfolio_file($old))) {
3811: my $oldmeta = $old.'.meta';
3812: my $newmeta = $new.'.meta';
3813: my $metaresult =
3814: &renameuserfile($docuname,$docudom,$oldmeta,$newmeta);
3815: my $url = "/uploaded/$docudom/$docuname/$old";
3816: my ($file,$group) = (&parse_portfolio_url($url))[3,4];
3817: my $sqlresult =
3818: &update_portfolio_table($docuname,$docudom,$file,
3819: 'portfolio_metadata',$group,
3820: 'delete');
3821: }
3822: }
3823: return $result;
3824: }
3825:
3826: # ------------------------------------------------------------------------- Log
3827:
3828: sub log {
3829: my ($dom,$nam,$hom,$what)=@_;
3830: return critical("log:$dom:$nam:$what",$hom);
3831: }
3832:
3833: # ------------------------------------------------------------------ Course Log
3834: #
3835: # This routine flushes several buffers of non-mission-critical nature
3836: #
3837:
3838: sub flushcourselogs {
3839: &logthis('Flushing log buffers');
3840: #
3841: # course logs
3842: # This is a log of all transactions in a course, which can be used
3843: # for data mining purposes
3844: #
3845: # It also collects the courseid database, which lists last transaction
3846: # times and course titles for all courseids
3847: #
3848: my %courseidbuffer=();
3849: foreach my $crsid (keys(%courselogs)) {
3850: if (&reply('log:'.$coursedombuf{$crsid}.':'.$coursenumbuf{$crsid}.':'.
3851: &escape($courselogs{$crsid}),
3852: $coursehombuf{$crsid}) eq 'ok') {
3853: delete $courselogs{$crsid};
3854: } else {
3855: &logthis('Failed to flush log buffer for '.$crsid);
3856: if (length($courselogs{$crsid})>40000) {
3857: &logthis("<font color=\"blue\">WARNING: Buffer for ".$crsid.
3858: " exceeded maximum size, deleting.</font>");
3859: delete $courselogs{$crsid};
3860: }
3861: }
3862: $courseidbuffer{$coursehombuf{$crsid}}{$crsid} = {
3863: 'description' => $coursedescrbuf{$crsid},
3864: 'inst_code' => $courseinstcodebuf{$crsid},
3865: 'type' => $coursetypebuf{$crsid},
3866: 'owner' => $courseownerbuf{$crsid},
3867: };
3868: }
3869: #
3870: # Write course id database (reverse lookup) to homeserver of courses
3871: # Is used in pickcourse
3872: #
3873: foreach my $crs_home (keys(%courseidbuffer)) {
3874: my $response = &courseidput(&host_domain($crs_home),
3875: $courseidbuffer{$crs_home},
3876: $crs_home,'timeonly');
3877: }
3878: #
3879: # File accesses
3880: # Writes to the dynamic metadata of resources to get hit counts, etc.
3881: #
3882: foreach my $entry (keys(%accesshash)) {
3883: if ($entry =~ /___count$/) {
3884: my ($dom,$name);
3885: ($dom,$name,undef)=
3886: ($entry=~m{___($match_domain)/($match_name)/(.*)___count$});
3887: if (! defined($dom) || $dom eq '' ||
3888: ! defined($name) || $name eq '') {
3889: my $cid = $env{'request.course.id'};
3890: $dom = $env{'request.'.$cid.'.domain'};
3891: $name = $env{'request.'.$cid.'.num'};
3892: }
3893: my $value = $accesshash{$entry};
3894: my (undef,$url,undef) = ($entry =~ /^(.*)___(.*)___count$/);
3895: my %temphash=($url => $value);
3896: my $result = &inc('nohist_accesscount',\%temphash,$dom,$name);
3897: if ($result eq 'ok') {
3898: delete $accesshash{$entry};
3899: }
3900: } else {
3901: my ($dom,$name) = ($entry=~m{___($match_domain)/($match_name)/(.*)___(\w+)$});
3902: if (($dom eq 'uploaded') || ($dom eq 'adm')) { next; }
3903: my %temphash=($entry => $accesshash{$entry});
3904: if (&put('nohist_resevaldata',\%temphash,$dom,$name) eq 'ok') {
3905: delete $accesshash{$entry};
3906: }
3907: }
3908: }
3909: #
3910: # Roles
3911: # Reverse lookup of user roles for course faculty/staff and co-authorship
3912: #
3913: foreach my $entry (keys(%userrolehash)) {
3914: my ($role,$uname,$udom,$runame,$rudom,$rsec)=
3915: split(/\:/,$entry);
3916: if (&Apache::lonnet::put('nohist_userroles',
3917: { $role.':'.$uname.':'.$udom.':'.$rsec => $userrolehash{$entry} },
3918: $rudom,$runame) eq 'ok') {
3919: delete $userrolehash{$entry};
3920: }
3921: }
3922: #
3923: # Reverse lookup of domain roles (dc, ad, li, sc, dh, da, au)
3924: #
3925: my %domrolebuffer = ();
3926: foreach my $entry (keys(%domainrolehash)) {
3927: my ($role,$uname,$udom,$runame,$rudom,$rsec)=split(/:/,$entry);
3928: if ($domrolebuffer{$rudom}) {
3929: $domrolebuffer{$rudom}.='&'.&escape($entry).
3930: '='.&escape($domainrolehash{$entry});
3931: } else {
3932: $domrolebuffer{$rudom}.=&escape($entry).
3933: '='.&escape($domainrolehash{$entry});
3934: }
3935: delete $domainrolehash{$entry};
3936: }
3937: foreach my $dom (keys(%domrolebuffer)) {
3938: my %servers;
3939: if (defined(&domain($dom,'primary'))) {
3940: my $primary=&domain($dom,'primary');
3941: my $hostname=&hostname($primary);
3942: $servers{$primary} = $hostname;
3943: } else {
3944: %servers = &get_servers($dom,'library');
3945: }
3946: foreach my $tryserver (keys(%servers)) {
3947: if (&reply('domroleput:'.$dom.':'.
3948: $domrolebuffer{$dom},$tryserver) eq 'ok') {
3949: last;
3950: } else {
3951: &logthis('Put of domain roles failed for '.$dom.' and '.$tryserver);
3952: }
3953: }
3954: }
3955: $dumpcount++;
3956: }
3957:
3958: sub courselog {
3959: my $what=shift;
3960: $what=time.':'.$what;
3961: unless ($env{'request.course.id'}) { return ''; }
3962: $coursedombuf{$env{'request.course.id'}}=
3963: $env{'course.'.$env{'request.course.id'}.'.domain'};
3964: $coursenumbuf{$env{'request.course.id'}}=
3965: $env{'course.'.$env{'request.course.id'}.'.num'};
3966: $coursehombuf{$env{'request.course.id'}}=
3967: $env{'course.'.$env{'request.course.id'}.'.home'};
3968: $coursedescrbuf{$env{'request.course.id'}}=
3969: $env{'course.'.$env{'request.course.id'}.'.description'};
3970: $courseinstcodebuf{$env{'request.course.id'}}=
3971: $env{'course.'.$env{'request.course.id'}.'.internal.coursecode'};
3972: $courseownerbuf{$env{'request.course.id'}}=
3973: $env{'course.'.$env{'request.course.id'}.'.internal.courseowner'};
3974: $coursetypebuf{$env{'request.course.id'}}=
3975: $env{'course.'.$env{'request.course.id'}.'.type'};
3976: if (defined $courselogs{$env{'request.course.id'}}) {
3977: $courselogs{$env{'request.course.id'}}.='&'.$what;
3978: } else {
3979: $courselogs{$env{'request.course.id'}}.=$what;
3980: }
3981: if (length($courselogs{$env{'request.course.id'}})>4048) {
3982: &flushcourselogs();
3983: }
3984: }
3985:
3986: sub courseacclog {
3987: my $fnsymb=shift;
3988: unless ($env{'request.course.id'}) { return ''; }
3989: my $what=$fnsymb.':'.$env{'user.name'}.':'.$env{'user.domain'};
3990: if ($fnsymb=~/$LONCAPA::assess_re/) {
3991: $what.=':POST';
3992: # FIXME: Probably ought to escape things....
3993: foreach my $key (keys(%env)) {
3994: if ($key=~/^form\.(.*)/) {
3995: my $formitem = $1;
3996: if ($formitem =~ /^HWFILE(?:SIZE|TOOBIG)/) {
3997: $what.=':'.$formitem.'='.$env{$key};
3998: } elsif ($formitem !~ /^HWFILE(?:[^.]+)$/) {
3999: $what.=':'.$formitem.'='.$env{$key};
4000: }
4001: }
4002: }
4003: } elsif ($fnsymb =~ m:^/adm/searchcat:) {
4004: # FIXME: We should not be depending on a form parameter that someone
4005: # editing lonsearchcat.pm might change in the future.
4006: if ($env{'form.phase'} eq 'course_search') {
4007: $what.= ':POST';
4008: # FIXME: Probably ought to escape things....
4009: foreach my $element ('courseexp','crsfulltext','crsrelated',
4010: 'crsdiscuss') {
4011: $what.=':'.$element.'='.$env{'form.'.$element};
4012: }
4013: }
4014: }
4015: &courselog($what);
4016: }
4017:
4018: sub countacc {
4019: my $url=&declutter(shift);
4020: return if (! defined($url) || $url eq '');
4021: unless ($env{'request.course.id'}) { return ''; }
4022: #
4023: # Mark that this url was used in this course
4024: #
4025: $accesshash{$env{'request.course.id'}.'___'.$url.'___course'}=1;
4026: #
4027: # Increase the access count for this resource in this child process
4028: #
4029: my $key=$$.$processmarker.'_'.$dumpcount.'___'.$url.'___count';
4030: $accesshash{$key}++;
4031: }
4032:
4033: sub linklog {
4034: my ($from,$to)=@_;
4035: $from=&declutter($from);
4036: $to=&declutter($to);
4037: $accesshash{$from.'___'.$to.'___comefrom'}=1;
4038: $accesshash{$to.'___'.$from.'___goto'}=1;
4039: }
4040:
4041: sub statslog {
4042: my ($symb,$part,$users,$av_attempts,$degdiff)=@_;
4043: if ($users<2) { return; }
4044: my %dynstore=&LONCAPA::lonmetadata::dynamic_metadata_storage({
4045: 'course' => $env{'request.course.id'},
4046: 'sections' => '"all"',
4047: 'num_students' => $users,
4048: 'part' => $part,
4049: 'symb' => $symb,
4050: 'mean_tries' => $av_attempts,
4051: 'deg_of_diff' => $degdiff});
4052: foreach my $key (keys(%dynstore)) {
4053: $accesshash{$key}=$dynstore{$key};
4054: }
4055: }
4056:
4057: sub userrolelog {
4058: my ($trole,$username,$domain,$area,$tstart,$tend)=@_;
4059: if ( $trole =~ /^(ca|aa|in|cc|ep|cr|ta|co)/ ) {
4060: my (undef,$rudom,$runame,$rsec)=split(/\//,$area);
4061: $userrolehash
4062: {$trole.':'.$username.':'.$domain.':'.$runame.':'.$rudom.':'.$rsec}
4063: =$tend.':'.$tstart;
4064: }
4065: if ($env{'request.role'} =~ /dc\./ && $trole =~ /^(au|in|cc|ep|cr|ta|co)/) {
4066: $userrolehash
4067: {$trole.':'.$username.':'.$domain.':'.$env{'user.name'}.':'.$env{'user.domain'}.':'}
4068: =$tend.':'.$tstart;
4069: }
4070: if ($trole =~ /^(dc|ad|li|au|dg|sc|dh|da)/ ) {
4071: my (undef,$rudom,$runame,$rsec)=split(/\//,$area);
4072: $domainrolehash
4073: {$trole.':'.$username.':'.$domain.':'.$runame.':'.$rudom.':'.$rsec}
4074: = $tend.':'.$tstart;
4075: }
4076: }
4077:
4078: sub courserolelog {
4079: my ($trole,$username,$domain,$area,$tstart,$tend,$delflag,$selfenroll,$context)=@_;
4080: if ($area =~ m-^/($match_domain)/($match_courseid)/?([^/]*)-) {
4081: my $cdom = $1;
4082: my $cnum = $2;
4083: my $sec = $3;
4084: my $namespace = 'rolelog';
4085: my %storehash = (
4086: role => $trole,
4087: start => $tstart,
4088: end => $tend,
4089: selfenroll => $selfenroll,
4090: context => $context,
4091: );
4092: if ($trole eq 'gr') {
4093: $namespace = 'groupslog';
4094: $storehash{'group'} = $sec;
4095: } else {
4096: $storehash{'section'} = $sec;
4097: }
4098: &write_log('course',$namespace,\%storehash,$delflag,$username,
4099: $domain,$cnum,$cdom);
4100: if (($trole ne 'st') || ($sec ne '')) {
4101: &devalidate_cache_new('getcourseroles',$cdom.'_'.$cnum);
4102: }
4103: }
4104: return;
4105: }
4106:
4107: sub domainrolelog {
4108: my ($trole,$username,$domain,$area,$tstart,$tend,$delflag,$context)=@_;
4109: if ($area =~ m{^/($match_domain)/$}) {
4110: my $cdom = $1;
4111: my $domconfiguser = &Apache::lonnet::get_domainconfiguser($cdom);
4112: my $namespace = 'rolelog';
4113: my %storehash = (
4114: role => $trole,
4115: start => $tstart,
4116: end => $tend,
4117: context => $context,
4118: );
4119: &write_log('domain',$namespace,\%storehash,$delflag,$username,
4120: $domain,$domconfiguser,$cdom);
4121: }
4122: return;
4123:
4124: }
4125:
4126: sub coauthorrolelog {
4127: my ($trole,$username,$domain,$area,$tstart,$tend,$delflag,$context)=@_;
4128: if ($area =~ m{^/($match_domain)/($match_username)$}) {
4129: my $audom = $1;
4130: my $auname = $2;
4131: my $namespace = 'rolelog';
4132: my %storehash = (
4133: role => $trole,
4134: start => $tstart,
4135: end => $tend,
4136: context => $context,
4137: );
4138: &write_log('author',$namespace,\%storehash,$delflag,$username,
4139: $domain,$auname,$audom);
4140: }
4141: return;
4142: }
4143:
4144: sub get_course_adv_roles {
4145: my ($cid,$codes) = @_;
4146: $cid=$env{'request.course.id'} unless (defined($cid));
4147: my %coursehash=&coursedescription($cid);
4148: my $crstype = &Apache::loncommon::course_type($cid);
4149: my %nothide=();
4150: foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
4151: if ($user !~ /:/) {
4152: $nothide{join(':',split(/[\@]/,$user))}=1;
4153: } else {
4154: $nothide{$user}=1;
4155: }
4156: }
4157: my @possdoms = ($coursehash{'domain'});
4158: if ($coursehash{'checkforpriv'}) {
4159: push(@possdoms,split(/,/,$coursehash{'checkforpriv'}));
4160: }
4161: my %returnhash=();
4162: my %dumphash=
4163: &dump('nohist_userroles',$coursehash{'domain'},$coursehash{'num'});
4164: my $now=time;
4165: my %privileged;
4166: foreach my $entry (keys(%dumphash)) {
4167: my ($tend,$tstart)=split(/\:/,$dumphash{$entry});
4168: if (($tstart) && ($tstart<0)) { next; }
4169: if (($tend) && ($tend<$now)) { next; }
4170: if (($tstart) && ($now<$tstart)) { next; }
4171: my ($role,$username,$domain,$section)=split(/\:/,$entry);
4172: if ($username eq '' || $domain eq '') { next; }
4173: if ((&privileged($username,$domain,\@possdoms)) &&
4174: (!$nothide{$username.':'.$domain})) { next; }
4175: if ($role eq 'cr') { next; }
4176: if ($codes) {
4177: if ($section) { $role .= ':'.$section; }
4178: if ($returnhash{$role}) {
4179: $returnhash{$role}.=','.$username.':'.$domain;
4180: } else {
4181: $returnhash{$role}=$username.':'.$domain;
4182: }
4183: } else {
4184: my $key=&plaintext($role,$crstype);
4185: if ($section) { $key.=' ('.&Apache::lonlocal::mt('Section [_1]',$section).')'; }
4186: if ($returnhash{$key}) {
4187: $returnhash{$key}.=','.$username.':'.$domain;
4188: } else {
4189: $returnhash{$key}=$username.':'.$domain;
4190: }
4191: }
4192: }
4193: return %returnhash;
4194: }
4195:
4196: sub get_my_roles {
4197: my ($uname,$udom,$context,$types,$roles,$roledoms,$withsec,$hidepriv)=@_;
4198: unless (defined($uname)) { $uname=$env{'user.name'}; }
4199: unless (defined($udom)) { $udom=$env{'user.domain'}; }
4200: my (%dumphash,%nothide);
4201: if ($context eq 'userroles') {
4202: %dumphash = &dump('roles',$udom,$uname);
4203: } else {
4204: %dumphash = &dump('nohist_userroles',$udom,$uname);
4205: if ($hidepriv) {
4206: my %coursehash=&coursedescription($udom.'_'.$uname);
4207: foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
4208: if ($user !~ /:/) {
4209: $nothide{join(':',split(/[\@]/,$user))} = 1;
4210: } else {
4211: $nothide{$user} = 1;
4212: }
4213: }
4214: }
4215: }
4216: my %returnhash=();
4217: my $now=time;
4218: my %privileged;
4219: foreach my $entry (keys(%dumphash)) {
4220: my ($role,$tend,$tstart);
4221: if ($context eq 'userroles') {
4222: next if ($entry =~ /^rolesdef/);
4223: ($role,$tend,$tstart)=split(/_/,$dumphash{$entry});
4224: } else {
4225: ($tend,$tstart)=split(/\:/,$dumphash{$entry});
4226: }
4227: if (($tstart) && ($tstart<0)) { next; }
4228: my $status = 'active';
4229: if (($tend) && ($tend<=$now)) {
4230: $status = 'previous';
4231: }
4232: if (($tstart) && ($now<$tstart)) {
4233: $status = 'future';
4234: }
4235: if (ref($types) eq 'ARRAY') {
4236: if (!grep(/^\Q$status\E$/,@{$types})) {
4237: next;
4238: }
4239: } else {
4240: if ($status ne 'active') {
4241: next;
4242: }
4243: }
4244: my ($rolecode,$username,$domain,$section,$area);
4245: if ($context eq 'userroles') {
4246: ($area,$rolecode) = ($entry =~ /^(.+)_([^_]+)$/);
4247: (undef,$domain,$username,$section) = split(/\//,$area);
4248: } else {
4249: ($role,$username,$domain,$section) = split(/\:/,$entry);
4250: }
4251: if (ref($roledoms) eq 'ARRAY') {
4252: if (!grep(/^\Q$domain\E$/,@{$roledoms})) {
4253: next;
4254: }
4255: }
4256: if (ref($roles) eq 'ARRAY') {
4257: if (!grep(/^\Q$role\E$/,@{$roles})) {
4258: if ($role =~ /^cr\//) {
4259: if (!grep(/^cr$/,@{$roles})) {
4260: next;
4261: }
4262: } elsif ($role =~ /^gr\//) {
4263: if (!grep(/^gr$/,@{$roles})) {
4264: next;
4265: }
4266: } else {
4267: next;
4268: }
4269: }
4270: }
4271: if ($hidepriv) {
4272: my @privroles = ('dc','su');
4273: if ($context eq 'userroles') {
4274: next if (grep(/^\Q$role\E$/,@privroles));
4275: } else {
4276: my $possdoms = [$domain];
4277: if (ref($roledoms) eq 'ARRAY') {
4278: push(@{$possdoms},@{$roledoms});
4279: }
4280: if (&privileged($username,$domain,$possdoms,\@privroles)) {
4281: if (!$nothide{$username.':'.$domain}) {
4282: next;
4283: }
4284: }
4285: }
4286: }
4287: if ($withsec) {
4288: $returnhash{$username.':'.$domain.':'.$role.':'.$section} =
4289: $tstart.':'.$tend;
4290: } else {
4291: $returnhash{$username.':'.$domain.':'.$role}=$tstart.':'.$tend;
4292: }
4293: }
4294: return %returnhash;
4295: }
4296:
4297: sub get_all_adhocroles {
4298: my ($dom) = @_;
4299: my @roles_by_num = ();
4300: my %domdefaults = &get_domain_defaults($dom);
4301: my (%description,%access_in_dom,%access_info);
4302: if (ref($domdefaults{'adhocroles'}) eq 'HASH') {
4303: my $count = 0;
4304: my %domcurrent = %{$domdefaults{'adhocroles'}};
4305: my %ordered;
4306: foreach my $role (sort(keys(%domcurrent))) {
4307: my ($order,$desc,$access_in_dom);
4308: if (ref($domcurrent{$role}) eq 'HASH') {
4309: $order = $domcurrent{$role}{'order'};
4310: $desc = $domcurrent{$role}{'desc'};
4311: $access_in_dom{$role} = $domcurrent{$role}{'access'};
4312: $access_info{$role} = $domcurrent{$role}{$access_in_dom{$role}};
4313: }
4314: if ($order eq '') {
4315: $order = $count;
4316: }
4317: $ordered{$order} = $role;
4318: if ($desc ne '') {
4319: $description{$role} = $desc;
4320: } else {
4321: $description{$role}= $role;
4322: }
4323: $count++;
4324: }
4325: foreach my $item (sort {$a <=> $b } (keys(%ordered))) {
4326: push(@roles_by_num,$ordered{$item});
4327: }
4328: }
4329: return (\@roles_by_num,\%description,\%access_in_dom,\%access_info);
4330: }
4331:
4332: sub get_my_adhocroles {
4333: my ($cid,$checkreg) = @_;
4334: my ($cdom,$cnum,%info,@possroles,$description,$roles_by_num);
4335: if ($env{'request.course.id'} eq $cid) {
4336: $cdom = $env{'course.'.$cid.'.domain'};
4337: $cnum = $env{'course.'.$cid.'.num'};
4338: $info{'internal.coursecode'} = $env{'course.'.$cid.'.internal.coursecode'};
4339: } elsif ($cid =~ /^($match_domain)_($match_courseid)$/) {
4340: $cdom = $1;
4341: $cnum = $2;
4342: %info = &Apache::lonnet::get('environment',['internal.coursecode'],
4343: $cdom,$cnum);
4344: }
4345: if (($info{'internal.coursecode'} ne '') && ($checkreg)) {
4346: my $user = $env{'user.name'}.':'.$env{'user.domain'};
4347: my %rosterhash = &get('classlist',[$user],$cdom,$cnum);
4348: if ($rosterhash{$user} ne '') {
4349: my $type = (split(/:/,$rosterhash{$user}))[5];
4350: return ([],{}) if ($type eq 'auto');
4351: }
4352: }
4353: if (($cdom ne '') && ($cnum ne '')) {
4354: if (($env{"user.role.dh./$cdom/"}) || ($env{"user.role.da./$cdom/"})) {
4355: my $then=$env{'user.login.time'};
4356: my $update=$env{'user.update.time'};
4357: if (!$update) {
4358: $update = $then;
4359: }
4360: my @liveroles;
4361: foreach my $role ('dh','da') {
4362: if ($env{"user.role.$role./$cdom/"}) {
4363: my ($tstart,$tend)=split(/\./,$env{"user.role.$role./$cdom/"});
4364: my $limit = $update;
4365: if ($env{'request.role'} eq "$role./$cdom/") {
4366: $limit = $then;
4367: }
4368: my $activerole = 1;
4369: if ($tstart && $tstart>$limit) { $activerole = 0; }
4370: if ($tend && $tend <$limit) { $activerole = 0; }
4371: if ($activerole) {
4372: push(@liveroles,$role);
4373: }
4374: }
4375: }
4376: if (@liveroles) {
4377: if (&homeserver($cnum,$cdom) ne 'no_host') {
4378: my ($accessref,$accessinfo,%access_in_dom);
4379: ($roles_by_num,$description,$accessref,$accessinfo) = &get_all_adhocroles($cdom);
4380: if (ref($roles_by_num) eq 'ARRAY') {
4381: if (@{$roles_by_num}) {
4382: my %settings;
4383: if ($env{'request.course.id'} eq $cid) {
4384: foreach my $envkey (keys(%env)) {
4385: if ($envkey =~ /^\Qcourse.$cid.\E(internal\.adhoc.+)$/) {
4386: $settings{$1} = $env{$envkey};
4387: }
4388: }
4389: } else {
4390: %settings = &dump('environment',$cdom,$cnum,'internal\.adhoc');
4391: }
4392: my %setincrs;
4393: if ($settings{'internal.adhocaccess'}) {
4394: map { $setincrs{$_} = 1; } split(/,/,$settings{'internal.adhocaccess'});
4395: }
4396: my @statuses;
4397: if ($env{'environment.inststatus'}) {
4398: @statuses = split(/,/,$env{'environment.inststatus'});
4399: }
4400: my $user = $env{'user.name'}.':'.$env{'user.domain'};
4401: if (ref($accessref) eq 'HASH') {
4402: %access_in_dom = %{$accessref};
4403: }
4404: foreach my $role (@{$roles_by_num}) {
4405: my ($curraccess,@okstatus,@personnel);
4406: if ($setincrs{$role}) {
4407: ($curraccess,my $rest) = split(/=/,$settings{'internal.adhoc.'.$role});
4408: if ($curraccess eq 'status') {
4409: @okstatus = split(/\&/,$rest);
4410: } elsif (($curraccess eq 'exc') || ($curraccess eq 'inc')) {
4411: @personnel = split(/\&/,$rest);
4412: }
4413: } else {
4414: $curraccess = $access_in_dom{$role};
4415: if (ref($accessinfo) eq 'HASH') {
4416: if ($curraccess eq 'status') {
4417: if (ref($accessinfo->{$role}) eq 'ARRAY') {
4418: @okstatus = @{$accessinfo->{$role}};
4419: }
4420: } elsif (($curraccess eq 'exc') || ($curraccess eq 'inc')) {
4421: if (ref($accessinfo->{$role}) eq 'ARRAY') {
4422: @personnel = @{$accessinfo->{$role}};
4423: }
4424: }
4425: }
4426: }
4427: if ($curraccess eq 'none') {
4428: next;
4429: } elsif ($curraccess eq 'all') {
4430: push(@possroles,$role);
4431: } elsif ($curraccess eq 'dh') {
4432: if (grep(/^dh$/,@liveroles)) {
4433: push(@possroles,$role);
4434: } else {
4435: next;
4436: }
4437: } elsif ($curraccess eq 'da') {
4438: if (grep(/^da$/,@liveroles)) {
4439: push(@possroles,$role);
4440: } else {
4441: next;
4442: }
4443: } elsif ($curraccess eq 'status') {
4444: if (@okstatus) {
4445: if (!@statuses) {
4446: if (grep(/^default$/,@okstatus)) {
4447: push(@possroles,$role);
4448: }
4449: } else {
4450: foreach my $status (@okstatus) {
4451: if (grep(/^\Q$status\E$/,@statuses)) {
4452: push(@possroles,$role);
4453: last;
4454: }
4455: }
4456: }
4457: }
4458: } elsif (($curraccess eq 'exc') || ($curraccess eq 'inc')) {
4459: if (grep(/^\Q$user\E$/,@personnel)) {
4460: if ($curraccess eq 'exc') {
4461: push(@possroles,$role);
4462: }
4463: } elsif ($curraccess eq 'inc') {
4464: push(@possroles,$role);
4465: }
4466: }
4467: }
4468: }
4469: }
4470: }
4471: }
4472: }
4473: }
4474: unless (ref($description) eq 'HASH') {
4475: if (ref($roles_by_num) eq 'ARRAY') {
4476: my %desc;
4477: map { $desc{$_} = $_; } (@{$roles_by_num});
4478: $description = \%desc;
4479: } else {
4480: $description = {};
4481: }
4482: }
4483: return (\@possroles,$description);
4484: }
4485:
4486: # ----------------------------------------------------- Frontpage Announcements
4487: #
4488: #
4489:
4490: sub postannounce {
4491: my ($server,$text)=@_;
4492: unless (&allowed('psa',&host_domain($server))) { return 'refused'; }
4493: unless ($text=~/\w/) { $text=''; }
4494: return &reply('setannounce:'.&escape($text),$server);
4495: }
4496:
4497: sub getannounce {
4498:
4499: if (open(my $fh,$perlvar{'lonDocRoot'}.'/announcement.txt')) {
4500: my $announcement='';
4501: while (my $line = <$fh>) { $announcement .= $line; }
4502: close($fh);
4503: if ($announcement=~/\w/) {
4504: return
4505: '<table bgcolor="#FF5555" cellpadding="5" cellspacing="3">'.
4506: '<tr><td bgcolor="#FFFFFF"><tt>'.$announcement.'</tt></td></tr></table>';
4507: } else {
4508: return '';
4509: }
4510: } else {
4511: return '';
4512: }
4513: }
4514:
4515: # ---------------------------------------------------------- Course ID routines
4516: # Deal with domain's nohist_courseid.db files
4517: #
4518:
4519: sub courseidput {
4520: my ($domain,$storehash,$coursehome,$caller) = @_;
4521: return unless (ref($storehash) eq 'HASH');
4522: my $outcome;
4523: if ($caller eq 'timeonly') {
4524: my $cids = '';
4525: foreach my $item (keys(%$storehash)) {
4526: $cids.=&escape($item).'&';
4527: }
4528: $cids=~s/\&$//;
4529: $outcome = &reply('courseidputhash:'.$domain.':'.$caller.':'.$cids,
4530: $coursehome);
4531: } else {
4532: my $items = '';
4533: foreach my $item (keys(%$storehash)) {
4534: $items.= &escape($item).'='.
4535: &freeze_escape($$storehash{$item}).'&';
4536: }
4537: $items=~s/\&$//;
4538: $outcome = &reply('courseidputhash:'.$domain.':'.$caller.':'.$items,
4539: $coursehome);
4540: }
4541: if ($outcome eq 'unknown_cmd') {
4542: my $what;
4543: foreach my $cid (keys(%$storehash)) {
4544: $what .= &escape($cid).'=';
4545: foreach my $item ('description','inst_code','owner','type') {
4546: $what .= &escape($storehash->{$cid}{$item}).':';
4547: }
4548: $what =~ s/\:$/&/;
4549: }
4550: $what =~ s/\&$//;
4551: return &reply('courseidput:'.$domain.':'.$what,$coursehome);
4552: } else {
4553: return $outcome;
4554: }
4555: }
4556:
4557: sub courseiddump {
4558: my ($domfilter,$descfilter,$sincefilter,$instcodefilter,$ownerfilter,
4559: $coursefilter,$hostidflag,$hostidref,$typefilter,$regexp_ok,
4560: $selfenrollonly,$catfilter,$showhidden,$caller,$cloner,$cc_clone,
4561: $cloneonly,$createdbefore,$createdafter,$creationcontext,$domcloner,
4562: $hasuniquecode,$reqcrsdom,$reqinstcode)=@_;
4563: my $as_hash = 1;
4564: my %returnhash;
4565: if (!$domfilter) { $domfilter=''; }
4566: my %libserv = &all_library();
4567: foreach my $tryserver (keys(%libserv)) {
4568: if ( ( $hostidflag == 1
4569: && grep(/^\Q$tryserver\E$/,@{$hostidref}) )
4570: || (!defined($hostidflag)) ) {
4571:
4572: if (($domfilter eq '') ||
4573: (&host_domain($tryserver) eq $domfilter)) {
4574: my $rep;
4575: if (grep { $_ eq $tryserver } ¤t_machine_ids()) {
4576: $rep = &LONCAPA::Lond::dump_course_id_handler(
4577: join(":", (&host_domain($tryserver), $sincefilter,
4578: &escape($descfilter), &escape($instcodefilter),
4579: &escape($ownerfilter), &escape($coursefilter),
4580: &escape($typefilter), &escape($regexp_ok),
4581: $as_hash, &escape($selfenrollonly),
4582: &escape($catfilter), $showhidden, $caller,
4583: &escape($cloner), &escape($cc_clone), $cloneonly,
4584: &escape($createdbefore), &escape($createdafter),
4585: &escape($creationcontext),$domcloner,$hasuniquecode,
4586: $reqcrsdom,&escape($reqinstcode))));
4587: } else {
4588: $rep = &reply('courseiddump:'.&host_domain($tryserver).':'.
4589: $sincefilter.':'.&escape($descfilter).':'.
4590: &escape($instcodefilter).':'.&escape($ownerfilter).
4591: ':'.&escape($coursefilter).':'.&escape($typefilter).
4592: ':'.&escape($regexp_ok).':'.$as_hash.':'.
4593: &escape($selfenrollonly).':'.&escape($catfilter).':'.
4594: $showhidden.':'.$caller.':'.&escape($cloner).':'.
4595: &escape($cc_clone).':'.$cloneonly.':'.
4596: &escape($createdbefore).':'.&escape($createdafter).':'.
4597: &escape($creationcontext).':'.$domcloner.':'.$hasuniquecode.
4598: ':'.$reqcrsdom.':'.&escape($reqinstcode),$tryserver);
4599: }
4600:
4601: my @pairs=split(/\&/,$rep);
4602: foreach my $item (@pairs) {
4603: my ($key,$value)=split(/\=/,$item,2);
4604: $key = &unescape($key);
4605: next if ($key =~ /^error: 2 /);
4606: my $result = &thaw_unescape($value);
4607: if (ref($result) eq 'HASH') {
4608: $returnhash{$key}=$result;
4609: } else {
4610: my @responses = split(/:/,$value);
4611: my @items = ('description','inst_code','owner','type');
4612: for (my $i=0; $i<@responses; $i++) {
4613: $returnhash{$key}{$items[$i]} = &unescape($responses[$i]);
4614: }
4615: }
4616: }
4617: }
4618: }
4619: }
4620: return %returnhash;
4621: }
4622:
4623: sub courselastaccess {
4624: my ($cdom,$cnum,$hostidref) = @_;
4625: my %returnhash;
4626: if ($cdom && $cnum) {
4627: my $chome = &homeserver($cnum,$cdom);
4628: if ($chome ne 'no_host') {
4629: my $rep = &reply('courselastaccess:'.$cdom.':'.$cnum,$chome);
4630: &extract_lastaccess(\%returnhash,$rep);
4631: }
4632: } else {
4633: if (!$cdom) { $cdom=''; }
4634: my %libserv = &all_library();
4635: foreach my $tryserver (keys(%libserv)) {
4636: if (ref($hostidref) eq 'ARRAY') {
4637: next unless (grep(/^\Q$tryserver\E$/,@{$hostidref}));
4638: }
4639: if (($cdom eq '') || (&host_domain($tryserver) eq $cdom)) {
4640: my $rep = &reply('courselastaccess:'.&host_domain($tryserver).':',$tryserver);
4641: &extract_lastaccess(\%returnhash,$rep);
4642: }
4643: }
4644: }
4645: return %returnhash;
4646: }
4647:
4648: sub extract_lastaccess {
4649: my ($returnhash,$rep) = @_;
4650: if (ref($returnhash) eq 'HASH') {
4651: unless ($rep eq 'unknown_command' || $rep eq 'no_such_host' ||
4652: $rep eq 'con_lost' || $rep eq 'rejected' || $rep eq 'refused' ||
4653: $rep eq '') {
4654: my @pairs=split(/\&/,$rep);
4655: foreach my $item (@pairs) {
4656: my ($key,$value)=split(/\=/,$item,2);
4657: $key = &unescape($key);
4658: next if ($key =~ /^error: 2 /);
4659: $returnhash->{$key} = &thaw_unescape($value);
4660: }
4661: }
4662: }
4663: return;
4664: }
4665:
4666: # ---------------------------------------------------------- DC e-mail
4667:
4668: sub dcmailput {
4669: my ($domain,$msgid,$message,$server)=@_;
4670: my $status = &Apache::lonnet::critical(
4671: 'dcmailput:'.$domain.':'.&escape($msgid).'='.
4672: &escape($message),$server);
4673: return $status;
4674: }
4675:
4676: sub dcmaildump {
4677: my ($dom,$startdate,$enddate,$senders) = @_;
4678: my %returnhash=();
4679:
4680: if (defined(&domain($dom,'primary'))) {
4681: my $cmd='dcmaildump:'.$dom.':'.&escape($startdate).':'.
4682: &escape($enddate).':';
4683: my @esc_senders=map { &escape($_)} @$senders;
4684: $cmd.=&escape(join('&',@esc_senders));
4685: foreach my $line (split(/\&/,&reply($cmd,&domain($dom,'primary')))) {
4686: my ($key,$value) = split(/\=/,$line,2);
4687: if (($key) && ($value)) {
4688: $returnhash{&unescape($key)} = &unescape($value);
4689: }
4690: }
4691: }
4692: return %returnhash;
4693: }
4694: # ---------------------------------------------------------- Domain roles
4695:
4696: sub get_domain_roles {
4697: my ($dom,$roles,$startdate,$enddate)=@_;
4698: if ((!defined($startdate)) || ($startdate eq '')) {
4699: $startdate = '.';
4700: }
4701: if ((!defined($enddate)) || ($enddate eq '')) {
4702: $enddate = '.';
4703: }
4704: my $rolelist;
4705: if (ref($roles) eq 'ARRAY') {
4706: $rolelist = join('&',@{$roles});
4707: }
4708: my %personnel = ();
4709:
4710: my %servers = &get_servers($dom,'library');
4711: foreach my $tryserver (keys(%servers)) {
4712: %{$personnel{$tryserver}}=();
4713: foreach my $line (split(/\&/,&reply('domrolesdump:'.$dom.':'.
4714: &escape($startdate).':'.
4715: &escape($enddate).':'.
4716: &escape($rolelist), $tryserver))) {
4717: my ($key,$value) = split(/\=/,$line,2);
4718: if (($key) && ($value)) {
4719: $personnel{$tryserver}{&unescape($key)} = &unescape($value);
4720: }
4721: }
4722: }
4723: return %personnel;
4724: }
4725:
4726: sub get_active_domroles {
4727: my ($dom,$roles) = @_;
4728: return () unless (ref($roles) eq 'ARRAY');
4729: my $now = time;
4730: my %dompersonnel = &get_domain_roles($dom,$roles,$now,$now);
4731: my %domroles;
4732: foreach my $server (keys(%dompersonnel)) {
4733: foreach my $user (sort(keys(%{$dompersonnel{$server}}))) {
4734: my ($trole,$uname,$udom,$runame,$rudom,$rsec) = split(/:/,$user);
4735: $domroles{$uname.':'.$udom} = $dompersonnel{$server}{$user};
4736: }
4737: }
4738: return %domroles;
4739: }
4740:
4741: # ----------------------------------------------------------- Interval timing
4742:
4743: {
4744: # Caches needed for speedup of navmaps
4745: # We don't want to cache this for very long at all (5 seconds at most)
4746: #
4747: # The user for whom we cache
4748: my $cachedkey='';
4749: # The cached times for this user
4750: my %cachedtimes=();
4751: # When this was last done
4752: my $cachedtime='';
4753:
4754: sub load_all_first_access {
4755: my ($uname,$udom)=@_;
4756: if (($cachedkey eq $uname.':'.$udom) &&
4757: (abs($cachedtime-time)<5) && (!$env{'form.markaccess'})) {
4758: return;
4759: }
4760: $cachedtime=time;
4761: $cachedkey=$uname.':'.$udom;
4762: %cachedtimes=&dump('firstaccesstimes',$udom,$uname);
4763: }
4764:
4765: sub get_first_access {
4766: my ($type,$argsymb,$argmap)=@_;
4767: my ($symb,$courseid,$udom,$uname)=&whichuser();
4768: if ($argsymb) { $symb=$argsymb; }
4769: my ($map,$id,$res)=&decode_symb($symb);
4770: if ($argmap) { $map = $argmap; }
4771: if ($type eq 'course') {
4772: $res='course';
4773: } elsif ($type eq 'map') {
4774: $res=&symbread($map);
4775: } else {
4776: $res=$symb;
4777: }
4778: &load_all_first_access($uname,$udom);
4779: return $cachedtimes{"$courseid\0$res"};
4780: }
4781:
4782: sub set_first_access {
4783: my ($type,$interval)=@_;
4784: my ($symb,$courseid,$udom,$uname)=&whichuser();
4785: my ($map,$id,$res)=&decode_symb($symb);
4786: if ($type eq 'course') {
4787: $res='course';
4788: } elsif ($type eq 'map') {
4789: $res=&symbread($map);
4790: } else {
4791: $res=$symb;
4792: }
4793: $cachedkey='';
4794: my $firstaccess=&get_first_access($type,$symb,$map);
4795: if (!$firstaccess) {
4796: my $start = time;
4797: my $putres = &put('firstaccesstimes',{"$courseid\0$res"=>$start},
4798: $udom,$uname);
4799: if ($putres eq 'ok') {
4800: &put('timerinterval',{"$courseid\0$res"=>$interval},
4801: $udom,$uname);
4802: &appenv(
4803: {
4804: 'course.'.$courseid.'.firstaccess.'.$res => $start,
4805: 'course.'.$courseid.'.timerinterval.'.$res => $interval,
4806: }
4807: );
4808: }
4809: return $putres;
4810: }
4811: return 'already_set';
4812: }
4813: }
4814:
4815: sub checkout {
4816: my ($symb,$tuname,$tudom,$tcrsid)=@_;
4817: my $now=time;
4818: my $lonhost=$perlvar{'lonHostID'};
4819: my $infostr=&escape(
4820: 'CHECKOUTTOKEN&'.
4821: $tuname.'&'.
4822: $tudom.'&'.
4823: $tcrsid.'&'.
4824: $symb.'&'.
4825: $now.'&'.$ENV{'REMOTE_ADDR'});
4826: my $token=&reply('tmpput:'.$infostr,$lonhost);
4827: if ($token=~/^error\:/) {
4828: &logthis("<font color=\"blue\">WARNING: ".
4829: "Checkout tmpput failed ".$tudom.' - '.$tuname.' - '.$symb.
4830: "</font>");
4831: return '';
4832: }
4833:
4834: $token=~s/^(\d+)\_.*\_(\d+)$/$1\*$2\*$lonhost/;
4835: $token=~tr/a-z/A-Z/;
4836:
4837: my %infohash=('resource.0.outtoken' => $token,
4838: 'resource.0.checkouttime' => $now,
4839: 'resource.0.outremote' => $ENV{'REMOTE_ADDR'});
4840:
4841: unless (&cstore(\%infohash,$symb,$tcrsid,$tudom,$tuname) eq 'ok') {
4842: return '';
4843: } else {
4844: &logthis("<font color=\"blue\">WARNING: ".
4845: "Checkout cstore failed ".$tudom.' - '.$tuname.' - '.$symb.
4846: "</font>");
4847: }
4848:
4849: if (&log($tudom,$tuname,&homeserver($tuname,$tudom),
4850: &escape('Checkout '.$infostr.' - '.
4851: $token)) ne 'ok') {
4852: return '';
4853: } else {
4854: &logthis("<font color=\"blue\">WARNING: ".
4855: "Checkout log failed ".$tudom.' - '.$tuname.' - '.$symb.
4856: "</font>");
4857: }
4858: return $token;
4859: }
4860:
4861: # ------------------------------------------------------------ Check in an item
4862:
4863: sub checkin {
4864: my $token=shift;
4865: my $now=time;
4866: my ($ta,$tb,$lonhost)=split(/\*/,$token);
4867: $lonhost=~tr/A-Z/a-z/;
4868: my $dtoken=$ta.'_'.&hostname($lonhost).'_'.$tb;
4869: $dtoken=~s/\W/\_/g;
4870: my ($dummy,$tuname,$tudom,$tcrsid,$symb,$chtim,$rmaddr)=
4871: split(/\&/,&unescape(&reply('tmpget:'.$dtoken,$lonhost)));
4872:
4873: unless (($tuname) && ($tudom)) {
4874: &logthis('Check in '.$token.' ('.$dtoken.') failed');
4875: return '';
4876: }
4877:
4878: unless (&allowed('mgr',$tcrsid)) {
4879: &logthis('Check in '.$token.' ('.$dtoken.') unauthorized: '.
4880: $env{'user.name'}.' - '.$env{'user.domain'});
4881: return '';
4882: }
4883:
4884: my %infohash=('resource.0.intoken' => $token,
4885: 'resource.0.checkintime' => $now,
4886: 'resource.0.inremote' => $ENV{'REMOTE_ADDR'});
4887:
4888: unless (&cstore(\%infohash,$symb,$tcrsid,$tudom,$tuname) eq 'ok') {
4889: return '';
4890: }
4891:
4892: if (&log($tudom,$tuname,&homeserver($tuname,$tudom),
4893: &escape('Checkin - '.$token)) ne 'ok') {
4894: return '';
4895: }
4896:
4897: return ($symb,$tuname,$tudom,$tcrsid);
4898: }
4899:
4900: # --------------------------------------------- Set Expire Date for Spreadsheet
4901:
4902: sub expirespread {
4903: my ($uname,$udom,$stype,$usymb)=@_;
4904: my $cid=$env{'request.course.id'};
4905: if ($cid) {
4906: my $now=time;
4907: my $key=$uname.':'.$udom.':'.$stype.':'.$usymb;
4908: return &reply('put:'.$env{'course.'.$cid.'.domain'}.':'.
4909: $env{'course.'.$cid.'.num'}.
4910: ':nohist_expirationdates:'.
4911: &escape($key).'='.$now,
4912: $env{'course.'.$cid.'.home'})
4913: }
4914: return 'ok';
4915: }
4916:
4917: # ----------------------------------------------------- Devalidate Spreadsheets
4918:
4919: sub devalidate {
4920: my ($symb,$uname,$udom)=@_;
4921: my $cid=$env{'request.course.id'};
4922: if ($cid) {
4923: # delete the stored spreadsheets for
4924: # - the student level sheet of this user in course's homespace
4925: # - the assessment level sheet for this resource
4926: # for this user in user's homespace
4927: # - current conditional state info
4928: my $key=$uname.':'.$udom.':';
4929: my $status=
4930: &del('nohist_calculatedsheets',
4931: [$key.'studentcalc:'],
4932: $env{'course.'.$cid.'.domain'},
4933: $env{'course.'.$cid.'.num'})
4934: .' '.
4935: &del('nohist_calculatedsheets_'.$cid,
4936: [$key.'assesscalc:'.$symb],$udom,$uname);
4937: unless ($status eq 'ok ok') {
4938: &logthis('Could not devalidate spreadsheet '.
4939: $uname.' at '.$udom.' for '.
4940: $symb.': '.$status);
4941: }
4942: &delenv('user.state.'.$cid);
4943: }
4944: }
4945:
4946: sub get_scalar {
4947: my ($string,$end) = @_;
4948: my $value;
4949: if ($$string =~ s/^([^&]*?)($end)/$2/) {
4950: $value = $1;
4951: } elsif ($$string =~ s/^([^&]*?)&//) {
4952: $value = $1;
4953: }
4954: return &unescape($value);
4955: }
4956:
4957: sub array2str {
4958: my (@array) = @_;
4959: my $result=&arrayref2str(\@array);
4960: $result=~s/^__ARRAY_REF__//;
4961: $result=~s/__END_ARRAY_REF__$//;
4962: return $result;
4963: }
4964:
4965: sub arrayref2str {
4966: my ($arrayref) = @_;
4967: my $result='__ARRAY_REF__';
4968: foreach my $elem (@$arrayref) {
4969: if(ref($elem) eq 'ARRAY') {
4970: $result.=&arrayref2str($elem).'&';
4971: } elsif(ref($elem) eq 'HASH') {
4972: $result.=&hashref2str($elem).'&';
4973: } elsif(ref($elem)) {
4974: #print("Got a ref of ".(ref($elem))." skipping.");
4975: } else {
4976: $result.=&escape($elem).'&';
4977: }
4978: }
4979: $result=~s/\&$//;
4980: $result .= '__END_ARRAY_REF__';
4981: return $result;
4982: }
4983:
4984: sub hash2str {
4985: my (%hash) = @_;
4986: my $result=&hashref2str(\%hash);
4987: $result=~s/^__HASH_REF__//;
4988: $result=~s/__END_HASH_REF__$//;
4989: return $result;
4990: }
4991:
4992: sub hashref2str {
4993: my ($hashref)=@_;
4994: my $result='__HASH_REF__';
4995: foreach my $key (sort(keys(%$hashref))) {
4996: if (ref($key) eq 'ARRAY') {
4997: $result.=&arrayref2str($key).'=';
4998: } elsif (ref($key) eq 'HASH') {
4999: $result.=&hashref2str($key).'=';
5000: } elsif (ref($key)) {
5001: $result.='=';
5002: #print("Got a ref of ".(ref($key))." skipping.");
5003: } else {
5004: if (defined($key)) {$result.=&escape($key).'=';} else { last; }
5005: }
5006:
5007: if(ref($hashref->{$key}) eq 'ARRAY') {
5008: $result.=&arrayref2str($hashref->{$key}).'&';
5009: } elsif(ref($hashref->{$key}) eq 'HASH') {
5010: $result.=&hashref2str($hashref->{$key}).'&';
5011: } elsif(ref($hashref->{$key})) {
5012: $result.='&';
5013: #print("Got a ref of ".(ref($hashref->{$key}))." skipping.");
5014: } else {
5015: $result.=&escape($hashref->{$key}).'&';
5016: }
5017: }
5018: $result=~s/\&$//;
5019: $result .= '__END_HASH_REF__';
5020: return $result;
5021: }
5022:
5023: sub str2hash {
5024: my ($string)=@_;
5025: my ($hash)=&str2hashref('__HASH_REF__'.$string.'__END_HASH_REF__');
5026: return %$hash;
5027: }
5028:
5029: sub str2hashref {
5030: my ($string) = @_;
5031:
5032: my %hash;
5033:
5034: if($string !~ /^__HASH_REF__/) {
5035: if (! ($string eq '' || !defined($string))) {
5036: $hash{'error'}='Not hash reference';
5037: }
5038: return (\%hash, $string);
5039: }
5040:
5041: $string =~ s/^__HASH_REF__//;
5042:
5043: while($string !~ /^__END_HASH_REF__/) {
5044: #key
5045: my $key='';
5046: if($string =~ /^__HASH_REF__/) {
5047: ($key, $string)=&str2hashref($string);
5048: if(defined($key->{'error'})) {
5049: $hash{'error'}='Bad data';
5050: return (\%hash, $string);
5051: }
5052: } elsif($string =~ /^__ARRAY_REF__/) {
5053: ($key, $string)=&str2arrayref($string);
5054: if($key->[0] eq 'Array reference error') {
5055: $hash{'error'}='Bad data';
5056: return (\%hash, $string);
5057: }
5058: } else {
5059: $string =~ s/^(.*?)=//;
5060: $key=&unescape($1);
5061: }
5062: $string =~ s/^=//;
5063:
5064: #value
5065: my $value='';
5066: if($string =~ /^__HASH_REF__/) {
5067: ($value, $string)=&str2hashref($string);
5068: if(defined($value->{'error'})) {
5069: $hash{'error'}='Bad data';
5070: return (\%hash, $string);
5071: }
5072: } elsif($string =~ /^__ARRAY_REF__/) {
5073: ($value, $string)=&str2arrayref($string);
5074: if($value->[0] eq 'Array reference error') {
5075: $hash{'error'}='Bad data';
5076: return (\%hash, $string);
5077: }
5078: } else {
5079: $value=&get_scalar(\$string,'__END_HASH_REF__');
5080: }
5081: $string =~ s/^&//;
5082:
5083: $hash{$key}=$value;
5084: }
5085:
5086: $string =~ s/^__END_HASH_REF__//;
5087:
5088: return (\%hash, $string);
5089: }
5090:
5091: sub str2array {
5092: my ($string)=@_;
5093: my ($array)=&str2arrayref('__ARRAY_REF__'.$string.'__END_ARRAY_REF__');
5094: return @$array;
5095: }
5096:
5097: sub str2arrayref {
5098: my ($string) = @_;
5099: my @array;
5100:
5101: if($string !~ /^__ARRAY_REF__/) {
5102: if (! ($string eq '' || !defined($string))) {
5103: $array[0]='Array reference error';
5104: }
5105: return (\@array, $string);
5106: }
5107:
5108: $string =~ s/^__ARRAY_REF__//;
5109:
5110: while($string !~ /^__END_ARRAY_REF__/) {
5111: my $value='';
5112: if($string =~ /^__HASH_REF__/) {
5113: ($value, $string)=&str2hashref($string);
5114: if(defined($value->{'error'})) {
5115: $array[0] ='Array reference error';
5116: return (\@array, $string);
5117: }
5118: } elsif($string =~ /^__ARRAY_REF__/) {
5119: ($value, $string)=&str2arrayref($string);
5120: if($value->[0] eq 'Array reference error') {
5121: $array[0] ='Array reference error';
5122: return (\@array, $string);
5123: }
5124: } else {
5125: $value=&get_scalar(\$string,'__END_ARRAY_REF__');
5126: }
5127: $string =~ s/^&//;
5128:
5129: push(@array, $value);
5130: }
5131:
5132: $string =~ s/^__END_ARRAY_REF__//;
5133:
5134: return (\@array, $string);
5135: }
5136:
5137: # -------------------------------------------------------------------Temp Store
5138:
5139: sub tmpreset {
5140: my ($symb,$namespace,$domain,$stuname) = @_;
5141: if (!$symb) {
5142: $symb=&symbread();
5143: if (!$symb) { $symb= $env{'request.url'}; }
5144: }
5145: $symb=escape($symb);
5146:
5147: if (!$namespace) { $namespace=$env{'request.state'}; }
5148: $namespace=~s/\//\_/g;
5149: $namespace=~s/\W//g;
5150:
5151: if (!$domain) { $domain=$env{'user.domain'}; }
5152: if (!$stuname) { $stuname=$env{'user.name'}; }
5153: if ($domain eq 'public' && $stuname eq 'public') {
5154: $stuname=$ENV{'REMOTE_ADDR'};
5155: }
5156: my $path=LONCAPA::tempdir();
5157: my %hash;
5158: if (tie(%hash,'GDBM_File',
5159: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
5160: &GDBM_WRCREAT(),0640)) {
5161: foreach my $key (keys(%hash)) {
5162: if ($key=~ /:$symb/) {
5163: delete($hash{$key});
5164: }
5165: }
5166: }
5167: }
5168:
5169: sub tmpstore {
5170: my ($storehash,$symb,$namespace,$domain,$stuname) = @_;
5171:
5172: if (!$symb) {
5173: $symb=&symbread();
5174: if (!$symb) { $symb= $env{'request.url'}; }
5175: }
5176: $symb=escape($symb);
5177:
5178: if (!$namespace) {
5179: # I don't think we would ever want to store this for a course.
5180: # it seems this will only be used if we don't have a course.
5181: #$namespace=$env{'request.course.id'};
5182: #if (!$namespace) {
5183: $namespace=$env{'request.state'};
5184: #}
5185: }
5186: $namespace=~s/\//\_/g;
5187: $namespace=~s/\W//g;
5188: if (!$domain) { $domain=$env{'user.domain'}; }
5189: if (!$stuname) { $stuname=$env{'user.name'}; }
5190: if ($domain eq 'public' && $stuname eq 'public') {
5191: $stuname=$ENV{'REMOTE_ADDR'};
5192: }
5193: my $now=time;
5194: my %hash;
5195: my $path=LONCAPA::tempdir();
5196: if (tie(%hash,'GDBM_File',
5197: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
5198: &GDBM_WRCREAT(),0640)) {
5199: $hash{"version:$symb"}++;
5200: my $version=$hash{"version:$symb"};
5201: my $allkeys='';
5202: foreach my $key (keys(%$storehash)) {
5203: $allkeys.=$key.':';
5204: $hash{"$version:$symb:$key"}=&freeze_escape($$storehash{$key});
5205: }
5206: $hash{"$version:$symb:timestamp"}=$now;
5207: $allkeys.='timestamp';
5208: $hash{"$version:keys:$symb"}=$allkeys;
5209: if (untie(%hash)) {
5210: return 'ok';
5211: } else {
5212: return "error:$!";
5213: }
5214: } else {
5215: return "error:$!";
5216: }
5217: }
5218:
5219: # -----------------------------------------------------------------Temp Restore
5220:
5221: sub tmprestore {
5222: my ($symb,$namespace,$domain,$stuname) = @_;
5223:
5224: if (!$symb) {
5225: $symb=&symbread();
5226: if (!$symb) { $symb= $env{'request.url'}; }
5227: }
5228: $symb=escape($symb);
5229:
5230: if (!$namespace) { $namespace=$env{'request.state'}; }
5231:
5232: if (!$domain) { $domain=$env{'user.domain'}; }
5233: if (!$stuname) { $stuname=$env{'user.name'}; }
5234: if ($domain eq 'public' && $stuname eq 'public') {
5235: $stuname=$ENV{'REMOTE_ADDR'};
5236: }
5237: my %returnhash;
5238: $namespace=~s/\//\_/g;
5239: $namespace=~s/\W//g;
5240: my %hash;
5241: my $path=LONCAPA::tempdir();
5242: if (tie(%hash,'GDBM_File',
5243: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
5244: &GDBM_READER(),0640)) {
5245: my $version=$hash{"version:$symb"};
5246: $returnhash{'version'}=$version;
5247: my $scope;
5248: for ($scope=1;$scope<=$version;$scope++) {
5249: my $vkeys=$hash{"$scope:keys:$symb"};
5250: my @keys=split(/:/,$vkeys);
5251: my $key;
5252: $returnhash{"$scope:keys"}=$vkeys;
5253: foreach $key (@keys) {
5254: $returnhash{"$scope:$key"}=&thaw_unescape($hash{"$scope:$symb:$key"});
5255: $returnhash{"$key"}=&thaw_unescape($hash{"$scope:$symb:$key"});
5256: }
5257: }
5258: if (!(untie(%hash))) {
5259: return "error:$!";
5260: }
5261: } else {
5262: return "error:$!";
5263: }
5264: return %returnhash;
5265: }
5266:
5267: # ----------------------------------------------------------------------- Store
5268:
5269: sub store {
5270: my ($storehash,$symb,$namespace,$domain,$stuname,$laststore) = @_;
5271: my $home='';
5272:
5273: if ($stuname) { $home=&homeserver($stuname,$domain); }
5274:
5275: $symb=&symbclean($symb);
5276: if (!$symb) { unless ($symb=&symbread()) { return ''; } }
5277:
5278: if (!$domain) { $domain=$env{'user.domain'}; }
5279: if (!$stuname) { $stuname=$env{'user.name'}; }
5280:
5281: &devalidate($symb,$stuname,$domain);
5282:
5283: $symb=escape($symb);
5284: if (!$namespace) {
5285: unless ($namespace=$env{'request.course.id'}) {
5286: return '';
5287: }
5288: }
5289: if (!$home) { $home=$env{'user.home'}; }
5290:
5291: $$storehash{'ip'}=$ENV{'REMOTE_ADDR'};
5292: $$storehash{'host'}=$perlvar{'lonHostID'};
5293:
5294: my $namevalue='';
5295: foreach my $key (keys(%$storehash)) {
5296: $namevalue.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
5297: }
5298: $namevalue=~s/\&$//;
5299: &courselog($symb.':'.$stuname.':'.$domain.':STORE:'.$namevalue);
5300: return reply("store:$domain:$stuname:$namespace:$symb:$namevalue:$laststore","$home");
5301: }
5302:
5303: # -------------------------------------------------------------- Critical Store
5304:
5305: sub cstore {
5306: my ($storehash,$symb,$namespace,$domain,$stuname,$laststore) = @_;
5307: my $home='';
5308:
5309: if ($stuname) { $home=&homeserver($stuname,$domain); }
5310:
5311: $symb=&symbclean($symb);
5312: if (!$symb) { unless ($symb=&symbread()) { return ''; } }
5313:
5314: if (!$domain) { $domain=$env{'user.domain'}; }
5315: if (!$stuname) { $stuname=$env{'user.name'}; }
5316:
5317: &devalidate($symb,$stuname,$domain);
5318:
5319: $symb=escape($symb);
5320: if (!$namespace) {
5321: unless ($namespace=$env{'request.course.id'}) {
5322: return '';
5323: }
5324: }
5325: if (!$home) { $home=$env{'user.home'}; }
5326:
5327: $$storehash{'ip'}=$ENV{'REMOTE_ADDR'};
5328: $$storehash{'host'}=$perlvar{'lonHostID'};
5329:
5330: my $namevalue='';
5331: foreach my $key (keys(%$storehash)) {
5332: $namevalue.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
5333: }
5334: $namevalue=~s/\&$//;
5335: &courselog($symb.':'.$stuname.':'.$domain.':CSTORE:'.$namevalue);
5336: return critical
5337: ("store:$domain:$stuname:$namespace:$symb:$namevalue:$laststore","$home");
5338: }
5339:
5340: # --------------------------------------------------------------------- Restore
5341:
5342: sub restore {
5343: my ($symb,$namespace,$domain,$stuname) = @_;
5344: my $home='';
5345:
5346: if ($stuname) { $home=&homeserver($stuname,$domain); }
5347:
5348: if (!$symb) {
5349: return if ($namespace eq 'courserequests');
5350: unless ($symb=escape(&symbread())) { return ''; }
5351: } else {
5352: unless ($namespace eq 'courserequests') {
5353: $symb=&escape(&symbclean($symb));
5354: }
5355: }
5356: if (!$namespace) {
5357: unless ($namespace=$env{'request.course.id'}) {
5358: return '';
5359: }
5360: }
5361: if (!$domain) { $domain=$env{'user.domain'}; }
5362: if (!$stuname) { $stuname=$env{'user.name'}; }
5363: if (!$home) { $home=$env{'user.home'}; }
5364: my $answer=&reply("restore:$domain:$stuname:$namespace:$symb","$home");
5365:
5366: my %returnhash=();
5367: foreach my $line (split(/\&/,$answer)) {
5368: my ($name,$value)=split(/\=/,$line);
5369: $returnhash{&unescape($name)}=&thaw_unescape($value);
5370: }
5371: my $version;
5372: for ($version=1;$version<=$returnhash{'version'};$version++) {
5373: foreach my $item (split(/\:/,$returnhash{$version.':keys'})) {
5374: $returnhash{$item}=$returnhash{$version.':'.$item};
5375: }
5376: }
5377: return %returnhash;
5378: }
5379:
5380: # ---------------------------------------------------------- Course Description
5381: #
5382: #
5383:
5384: sub coursedescription {
5385: my ($courseid,$args)=@_;
5386: $courseid=~s/^\///;
5387: $courseid=~s/\_/\//g;
5388: my ($cdomain,$cnum)=split(/\//,$courseid);
5389: my $chome=&homeserver($cnum,$cdomain);
5390: my $normalid=$cdomain.'_'.$cnum;
5391: # need to always cache even if we get errors otherwise we keep
5392: # trying and trying and trying to get the course description.
5393: my %envhash=();
5394: my %returnhash=();
5395:
5396: my $expiretime=600;
5397: if ($env{'request.course.id'} eq $normalid) {
5398: $expiretime=120;
5399: }
5400:
5401: my $prefix='course.'.$cdomain.'_'.$cnum.'.';
5402: if (!$args->{'freshen_cache'}
5403: && ((time-$env{$prefix.'last_cache'}) < $expiretime) ) {
5404: foreach my $key (keys(%env)) {
5405: next if ($key !~ /^\Q$prefix\E(.*)/);
5406: my ($setting) = $1;
5407: $returnhash{$setting} = $env{$key};
5408: }
5409: return %returnhash;
5410: }
5411:
5412: # get the data again
5413:
5414: if (!$args->{'one_time'}) {
5415: $envhash{'course.'.$normalid.'.last_cache'}=time;
5416: }
5417:
5418: if ($chome ne 'no_host') {
5419: %returnhash=&dump('environment',$cdomain,$cnum);
5420: if (!exists($returnhash{'con_lost'})) {
5421: my $username = $env{'user.name'}; # Defult username
5422: if(defined $args->{'user'}) {
5423: $username = $args->{'user'};
5424: }
5425: $returnhash{'home'}= $chome;
5426: $returnhash{'domain'} = $cdomain;
5427: $returnhash{'num'} = $cnum;
5428: if (!defined($returnhash{'type'})) {
5429: $returnhash{'type'} = 'Course';
5430: }
5431: while (my ($name,$value) = each %returnhash) {
5432: $envhash{'course.'.$normalid.'.'.$name}=$value;
5433: }
5434: $returnhash{'url'}=&clutter($returnhash{'url'});
5435: $returnhash{'fn'}=LONCAPA::tempdir() .
5436: $username.'_'.$cdomain.'_'.$cnum;
5437: $envhash{'course.'.$normalid.'.home'}=$chome;
5438: $envhash{'course.'.$normalid.'.domain'}=$cdomain;
5439: $envhash{'course.'.$normalid.'.num'}=$cnum;
5440: }
5441: }
5442: if (!$args->{'one_time'}) {
5443: &appenv(\%envhash);
5444: }
5445: return %returnhash;
5446: }
5447:
5448: sub update_released_required {
5449: my ($needsrelease,$cdom,$cnum,$chome,$cid) = @_;
5450: if ($cdom eq '' || $cnum eq '' || $chome eq '' || $cid eq '') {
5451: $cid = $env{'request.course.id'};
5452: $cdom = $env{'course.'.$cid.'.domain'};
5453: $cnum = $env{'course.'.$cid.'.num'};
5454: $chome = $env{'course.'.$cid.'.home'};
5455: }
5456: if ($needsrelease) {
5457: my %curr_reqd_hash = &userenvironment($cdom,$cnum,'internal.releaserequired');
5458: my $needsupdate;
5459: if ($curr_reqd_hash{'internal.releaserequired'} eq '') {
5460: $needsupdate = 1;
5461: } else {
5462: my ($currmajor,$currminor) = split(/\./,$curr_reqd_hash{'internal.releaserequired'});
5463: my ($needsmajor,$needsminor) = split(/\./,$needsrelease);
5464: if (($currmajor < $needsmajor) || ($currmajor == $needsmajor && $currminor < $needsminor)) {
5465: $needsupdate = 1;
5466: }
5467: }
5468: if ($needsupdate) {
5469: my %needshash = (
5470: 'internal.releaserequired' => $needsrelease,
5471: );
5472: my $putresult = &put('environment',\%needshash,$cdom,$cnum);
5473: if ($putresult eq 'ok') {
5474: &appenv({'course.'.$cid.'.internal.releaserequired' => $needsrelease});
5475: my %crsinfo = &courseiddump($cdom,'.',1,'.','.',$cnum,undef,undef,'.');
5476: if (ref($crsinfo{$cid}) eq 'HASH') {
5477: $crsinfo{$cid}{'releaserequired'} = $needsrelease;
5478: &courseidput($cdom,\%crsinfo,$chome,'notime');
5479: }
5480: }
5481: }
5482: }
5483: return;
5484: }
5485:
5486: # -------------------------------------------------See if a user is privileged
5487:
5488: sub privileged {
5489: my ($username,$domain,$possdomains,$possroles)=@_;
5490: my $now = time;
5491: my $roles;
5492: if (ref($possroles) eq 'ARRAY') {
5493: $roles = $possroles;
5494: } else {
5495: $roles = ['dc','su'];
5496: }
5497: if (ref($possdomains) eq 'ARRAY') {
5498: my %privileged = &privileged_by_domain($possdomains,$roles);
5499: foreach my $dom (@{$possdomains}) {
5500: if (($username =~ /^$match_username$/) && ($domain =~ /^$match_domain$/) &&
5501: (ref($privileged{$dom}) eq 'HASH')) {
5502: foreach my $role (@{$roles}) {
5503: if (ref($privileged{$dom}{$role}) eq 'HASH') {
5504: if (exists($privileged{$dom}{$role}{$username.':'.$domain})) {
5505: my ($end,$start) = split(/:/,$privileged{$dom}{$role}{$username.':'.$domain});
5506: return 1 unless (($end && $end < $now) ||
5507: ($start && $start > $now));
5508: }
5509: }
5510: }
5511: }
5512: }
5513: } else {
5514: my %rolesdump = &dump("roles", $domain, $username) or return 0;
5515: my $now = time;
5516:
5517: for my $role (@rolesdump{grep { ! /^rolesdef_/ } keys(%rolesdump)}) {
5518: my ($trole, $tend, $tstart) = split(/_/, $role);
5519: if (grep(/^\Q$trole\E$/,@{$roles})) {
5520: return 1 unless ($tend && $tend < $now)
5521: or ($tstart && $tstart > $now);
5522: }
5523: }
5524: }
5525: return 0;
5526: }
5527:
5528: sub privileged_by_domain {
5529: my ($domains,$roles) = @_;
5530: my %privileged = ();
5531: my $cachetime = 60*60*24;
5532: my $now = time;
5533: unless ((ref($domains) eq 'ARRAY') && (ref($roles) eq 'ARRAY')) {
5534: return %privileged;
5535: }
5536: foreach my $dom (@{$domains}) {
5537: next if (ref($privileged{$dom}) eq 'HASH');
5538: my $needroles;
5539: foreach my $role (@{$roles}) {
5540: my ($result,$cached)=&is_cached_new('priv_'.$role,$dom);
5541: if (defined($cached)) {
5542: if (ref($result) eq 'HASH') {
5543: $privileged{$dom}{$role} = $result;
5544: }
5545: } else {
5546: $needroles = 1;
5547: }
5548: }
5549: if ($needroles) {
5550: my %dompersonnel = &get_domain_roles($dom,$roles);
5551: $privileged{$dom} = {};
5552: foreach my $server (keys(%dompersonnel)) {
5553: if (ref($dompersonnel{$server}) eq 'HASH') {
5554: foreach my $item (keys(%{$dompersonnel{$server}})) {
5555: my ($trole,$uname,$udom,$rest) = split(/:/,$item,4);
5556: my ($end,$start) = split(/:/,$dompersonnel{$server}{$item});
5557: next if ($end && $end < $now);
5558: $privileged{$dom}{$trole}{$uname.':'.$udom} =
5559: $dompersonnel{$server}{$item};
5560: }
5561: }
5562: }
5563: if (ref($privileged{$dom}) eq 'HASH') {
5564: foreach my $role (@{$roles}) {
5565: if (ref($privileged{$dom}{$role}) eq 'HASH') {
5566: &do_cache_new('priv_'.$role,$dom,$privileged{$dom}{$role},$cachetime);
5567: } else {
5568: my %hash = ();
5569: &do_cache_new('priv_'.$role,$dom,\%hash,$cachetime);
5570: }
5571: }
5572: }
5573: }
5574: }
5575: return %privileged;
5576: }
5577:
5578: # -------------------------------------------------------- Get user privileges
5579:
5580: sub rolesinit {
5581: my ($domain, $username) = @_;
5582: my %userroles = ('user.login.time' => time);
5583: my %rolesdump = &dump("roles", $domain, $username) or return \%userroles;
5584:
5585: # firstaccess and timerinterval are related to timed maps/resources.
5586: # also, blocking can be triggered by an activating timer
5587: # it's saved in the user's %env.
5588: my %firstaccess = &dump('firstaccesstimes', $domain, $username);
5589: my %timerinterval = &dump('timerinterval', $domain, $username);
5590: my (%coursetimerstarts, %firstaccchk, %firstaccenv, %coursetimerintervals,
5591: %timerintchk, %timerintenv);
5592:
5593: foreach my $key (keys(%firstaccess)) {
5594: my ($cid, $rest) = split(/\0/, $key);
5595: $coursetimerstarts{$cid}{$rest} = $firstaccess{$key};
5596: }
5597:
5598: foreach my $key (keys(%timerinterval)) {
5599: my ($cid,$rest) = split(/\0/,$key);
5600: $coursetimerintervals{$cid}{$rest} = $timerinterval{$key};
5601: }
5602:
5603: my %allroles=();
5604: my %allgroups=();
5605:
5606: for my $area (grep { ! /^rolesdef_/ } keys(%rolesdump)) {
5607: my $role = $rolesdump{$area};
5608: $area =~ s/\_\w\w$//;
5609:
5610: my ($trole, $tend, $tstart, $group_privs);
5611:
5612: if ($role =~ /^cr/) {
5613: # Custom role, defined by a user
5614: # e.g., user.role.cr/msu/smith/mynewrole
5615: if ($role =~ m|^(cr/$match_domain/$match_username/[a-zA-Z0-9]+)_(.*)$|) {
5616: $trole = $1;
5617: ($tend, $tstart) = split('_', $2);
5618: } else {
5619: $trole = $role;
5620: }
5621: } elsif ($role =~ m|^gr/|) {
5622: # Role of member in a group, defined within a course/community
5623: # e.g., user.role.gr/msu/04935610a19ee4a5fmsul1/leopards
5624: ($trole, $tend, $tstart) = split(/_/, $role);
5625: next if $tstart eq '-1';
5626: ($trole, $group_privs) = split(/\//, $trole);
5627: $group_privs = &unescape($group_privs);
5628: } else {
5629: # Just a normal role, defined in roles.tab
5630: ($trole, $tend, $tstart) = split(/_/,$role);
5631: }
5632:
5633: my %new_role = &set_arearole($trole,$area,$tstart,$tend,$domain,
5634: $username);
5635: @userroles{keys(%new_role)} = @new_role{keys(%new_role)};
5636:
5637: # role expired or not available yet?
5638: $trole = '' if ($tend != 0 && $tend < $userroles{'user.login.time'}) or
5639: ($tstart != 0 && $tstart > $userroles{'user.login.time'});
5640:
5641: next if $area eq '' or $trole eq '';
5642:
5643: my $spec = "$trole.$area";
5644: my ($tdummy, $tdomain, $trest) = split(/\//, $area);
5645:
5646: if ($trole =~ /^cr\//) {
5647: # Custom role, defined by a user
5648: &custom_roleprivs(\%allroles,$trole,$tdomain,$trest,$spec,$area);
5649: } elsif ($trole eq 'gr') {
5650: # Role of a member in a group, defined within a course/community
5651: &group_roleprivs(\%allgroups,$area,$group_privs,$tend,$tstart);
5652: next;
5653: } else {
5654: # Normal role, defined in roles.tab
5655: &standard_roleprivs(\%allroles,$trole,$tdomain,$spec,$trest,$area);
5656: }
5657:
5658: my $cid = $tdomain.'_'.$trest;
5659: unless ($firstaccchk{$cid}) {
5660: if (ref($coursetimerstarts{$cid}) eq 'HASH') {
5661: foreach my $item (keys(%{$coursetimerstarts{$cid}})) {
5662: $firstaccenv{'course.'.$cid.'.firstaccess.'.$item} =
5663: $coursetimerstarts{$cid}{$item};
5664: }
5665: }
5666: $firstaccchk{$cid} = 1;
5667: }
5668: unless ($timerintchk{$cid}) {
5669: if (ref($coursetimerintervals{$cid}) eq 'HASH') {
5670: foreach my $item (keys(%{$coursetimerintervals{$cid}})) {
5671: $timerintenv{'course.'.$cid.'.timerinterval.'.$item} =
5672: $coursetimerintervals{$cid}{$item};
5673: }
5674: }
5675: $timerintchk{$cid} = 1;
5676: }
5677: }
5678:
5679: @userroles{'user.author','user.adv','user.rar'} = &set_userprivs(\%userroles,
5680: \%allroles, \%allgroups);
5681: $env{'user.adv'} = $userroles{'user.adv'};
5682: $env{'user.rar'} = $userroles{'user.rar'};
5683:
5684: return (\%userroles,\%firstaccenv,\%timerintenv);
5685: }
5686:
5687: sub set_arearole {
5688: my ($trole,$area,$tstart,$tend,$domain,$username,$nolog) = @_;
5689: unless ($nolog) {
5690: # log the associated role with the area
5691: &userrolelog($trole,$username,$domain,$area,$tstart,$tend);
5692: }
5693: return ('user.role.'.$trole.'.'.$area => $tstart.'.'.$tend);
5694: }
5695:
5696: sub custom_roleprivs {
5697: my ($allroles,$trole,$tdomain,$trest,$spec,$area) = @_;
5698: my ($rdummy,$rdomain,$rauthor,$rrole)=split(/\//,$trole);
5699: my $homsvr = &homeserver($rauthor,$rdomain);
5700: if (&hostname($homsvr) ne '') {
5701: my ($rdummy,$roledef)=
5702: &get('roles',["rolesdef_$rrole"],$rdomain,$rauthor);
5703: if (($rdummy ne 'con_lost') && ($roledef ne '')) {
5704: my ($syspriv,$dompriv,$coursepriv)=split(/\_/,$roledef);
5705: if (defined($syspriv)) {
5706: if ($trest =~ /^$match_community$/) {
5707: $syspriv =~ s/bre\&S//;
5708: }
5709: $$allroles{'cm./'}.=':'.$syspriv;
5710: $$allroles{$spec.'./'}.=':'.$syspriv;
5711: }
5712: if ($tdomain ne '') {
5713: if (defined($dompriv)) {
5714: $$allroles{'cm./'.$tdomain.'/'}.=':'.$dompriv;
5715: $$allroles{$spec.'./'.$tdomain.'/'}.=':'.$dompriv;
5716: }
5717: if (($trest ne '') && (defined($coursepriv))) {
5718: if ($trole =~ m{^cr/$tdomain/$tdomain\Q-domainconfig\E/([^/]+)$}) {
5719: my $rolename = $1;
5720: $coursepriv = &course_adhocrole_privs($rolename,$tdomain,$trest,$coursepriv);
5721: }
5722: $$allroles{'cm.'.$area}.=':'.$coursepriv;
5723: $$allroles{$spec.'.'.$area}.=':'.$coursepriv;
5724: }
5725: }
5726: }
5727: }
5728: }
5729:
5730: sub course_adhocrole_privs {
5731: my ($rolename,$cdom,$cnum,$coursepriv) = @_;
5732: my %overrides = &get('environment',["internal.adhocpriv.$rolename"],$cdom,$cnum);
5733: if ($overrides{"internal.adhocpriv.$rolename"}) {
5734: my (%currprivs,%storeprivs);
5735: foreach my $item (split(/:/,$coursepriv)) {
5736: my ($priv,$restrict) = split(/\&/,$item);
5737: $currprivs{$priv} = $restrict;
5738: }
5739: my (%possadd,%possremove,%full);
5740: foreach my $item (split(/\:/,$Apache::lonnet::pr{'cr:c'})) {
5741: my ($priv,$restrict)=split(/\&/,$item);
5742: $full{$priv} = $restrict;
5743: }
5744: foreach my $item (split(/,/,$overrides{"internal.adhocpriv.$rolename"})) {
5745: next if ($item eq '');
5746: my ($rule,$rest) = split(/=/,$item);
5747: next unless (($rule eq 'off') || ($rule eq 'on'));
5748: foreach my $priv (split(/:/,$rest)) {
5749: if ($priv ne '') {
5750: if ($rule eq 'off') {
5751: $possremove{$priv} = 1;
5752: } else {
5753: $possadd{$priv} = 1;
5754: }
5755: }
5756: }
5757: }
5758: foreach my $priv (sort(keys(%full))) {
5759: if (exists($currprivs{$priv})) {
5760: unless (exists($possremove{$priv})) {
5761: $storeprivs{$priv} = $currprivs{$priv};
5762: }
5763: } elsif (exists($possadd{$priv})) {
5764: $storeprivs{$priv} = $full{$priv};
5765: }
5766: }
5767: $coursepriv = ':'.join(':',map { $_.'&'.$storeprivs{$_}; } sort(keys(%storeprivs)));
5768: }
5769: return $coursepriv;
5770: }
5771:
5772: sub group_roleprivs {
5773: my ($allgroups,$area,$group_privs,$tend,$tstart) = @_;
5774: my $access = 1;
5775: my $now = time;
5776: if (($tend!=0) && ($tend<$now)) { $access = 0; }
5777: if (($tstart!=0) && ($tstart>$now)) { $access=0; }
5778: if ($access) {
5779: my ($course,$group) = ($area =~ m|(/$match_domain/$match_courseid)/([^/]+)$|);
5780: $$allgroups{$course}{$group} .=':'.$group_privs;
5781: }
5782: }
5783:
5784: sub standard_roleprivs {
5785: my ($allroles,$trole,$tdomain,$spec,$trest,$area) = @_;
5786: if (defined($pr{$trole.':s'})) {
5787: $$allroles{'cm./'}.=':'.$pr{$trole.':s'};
5788: $$allroles{$spec.'./'}.=':'.$pr{$trole.':s'};
5789: }
5790: if ($tdomain ne '') {
5791: if (defined($pr{$trole.':d'})) {
5792: $$allroles{'cm./'.$tdomain.'/'}.=':'.$pr{$trole.':d'};
5793: $$allroles{$spec.'./'.$tdomain.'/'}.=':'.$pr{$trole.':d'};
5794: }
5795: if (($trest ne '') && (defined($pr{$trole.':c'}))) {
5796: $$allroles{'cm.'.$area}.=':'.$pr{$trole.':c'};
5797: $$allroles{$spec.'.'.$area}.=':'.$pr{$trole.':c'};
5798: }
5799: }
5800: }
5801:
5802: sub set_userprivs {
5803: my ($userroles,$allroles,$allgroups,$groups_roles) = @_;
5804: my $author=0;
5805: my $adv=0;
5806: my $rar=0;
5807: my %grouproles = ();
5808: if (keys(%{$allgroups}) > 0) {
5809: my @groupkeys;
5810: foreach my $role (keys(%{$allroles})) {
5811: push(@groupkeys,$role);
5812: }
5813: if (ref($groups_roles) eq 'HASH') {
5814: foreach my $key (keys(%{$groups_roles})) {
5815: unless (grep(/^\Q$key\E$/,@groupkeys)) {
5816: push(@groupkeys,$key);
5817: }
5818: }
5819: }
5820: if (@groupkeys > 0) {
5821: foreach my $role (@groupkeys) {
5822: my ($trole,$area,$sec,$extendedarea);
5823: if ($role =~ m-^(\w+|cr/$match_domain/$match_username/\w+)\.(/$match_domain/$match_courseid)(/?\w*)\.-) {
5824: $trole = $1;
5825: $area = $2;
5826: $sec = $3;
5827: $extendedarea = $area.$sec;
5828: if (exists($$allgroups{$area})) {
5829: foreach my $group (keys(%{$$allgroups{$area}})) {
5830: my $spec = $trole.'.'.$extendedarea;
5831: $grouproles{$spec.'.'.$area.'/'.$group} =
5832: $$allgroups{$area}{$group};
5833: }
5834: }
5835: }
5836: }
5837: }
5838: }
5839: foreach my $group (keys(%grouproles)) {
5840: $$allroles{$group} = $grouproles{$group};
5841: }
5842: foreach my $role (keys(%{$allroles})) {
5843: my %thesepriv;
5844: if (($role=~/^au/) || ($role=~/^ca/) || ($role=~/^aa/)) { $author=1; }
5845: foreach my $item (split(/:/,$$allroles{$role})) {
5846: if ($item ne '') {
5847: my ($privilege,$restrictions)=split(/&/,$item);
5848: if ($restrictions eq '') {
5849: $thesepriv{$privilege}='F';
5850: } elsif ($thesepriv{$privilege} ne 'F') {
5851: $thesepriv{$privilege}.=$restrictions;
5852: }
5853: if ($thesepriv{'adv'} eq 'F') { $adv=1; }
5854: if ($thesepriv{'rar'} eq 'F') { $rar=1; }
5855: }
5856: }
5857: my $thesestr='';
5858: foreach my $priv (sort(keys(%thesepriv))) {
5859: $thesestr.=':'.$priv.'&'.$thesepriv{$priv};
5860: }
5861: $userroles->{'user.priv.'.$role} = $thesestr;
5862: }
5863: return ($author,$adv,$rar);
5864: }
5865:
5866: sub role_status {
5867: my ($rolekey,$update,$refresh,$now,$role,$where,$trolecode,$tstatus,$tstart,$tend) = @_;
5868: if (exists($env{$rolekey}) && $env{$rolekey} ne '') {
5869: my ($one,$two) = split(m{\./},$rolekey,2);
5870: (undef,undef,$$role) = split(/\./,$one,3);
5871: unless (!defined($$role) || $$role eq '') {
5872: $$where = '/'.$two;
5873: $$trolecode=$$role.'.'.$$where;
5874: ($$tstart,$$tend)=split(/\./,$env{$rolekey});
5875: $$tstatus='is';
5876: if ($$tstart && $$tstart>$update) {
5877: $$tstatus='future';
5878: if ($$tstart<$now) {
5879: if ($$tstart && $$tstart>$refresh) {
5880: if (($$where ne '') && ($$role ne '')) {
5881: my (%allroles,%allgroups,$group_privs,
5882: %groups_roles,@rolecodes);
5883: my %userroles = (
5884: 'user.role.'.$$role.'.'.$$where => $$tstart.'.'.$$tend
5885: );
5886: @rolecodes = ('cm');
5887: my $spec=$$role.'.'.$$where;
5888: my ($tdummy,$tdomain,$trest)=split(/\//,$$where);
5889: if ($$role =~ /^cr\//) {
5890: &custom_roleprivs(\%allroles,$$role,$tdomain,$trest,$spec,$$where);
5891: push(@rolecodes,'cr');
5892: } elsif ($$role eq 'gr') {
5893: push(@rolecodes,$$role);
5894: my %rolehash = &get('roles',[$$where.'_'.$$role],$env{'user.domain'},
5895: $env{'user.name'});
5896: my ($trole) = split('_',$rolehash{$$where.'_'.$$role},2);
5897: (undef,my $group_privs) = split(/\//,$trole);
5898: $group_privs = &unescape($group_privs);
5899: &group_roleprivs(\%allgroups,$$where,$group_privs,$$tend,$$tstart);
5900: my %course_roles = &get_my_roles($env{'user.name'},$env{'user.domain'},'userroles',['active'],['cc','co','in','ta','ep','ad','st','cr'],[$tdomain],1);
5901: &get_groups_roles($tdomain,$trest,
5902: \%course_roles,\@rolecodes,
5903: \%groups_roles);
5904: } else {
5905: push(@rolecodes,$$role);
5906: &standard_roleprivs(\%allroles,$$role,$tdomain,$spec,$trest,$$where);
5907: }
5908: my ($author,$adv,$rar)= &set_userprivs(\%userroles,\%allroles,\%allgroups,
5909: \%groups_roles);
5910: &appenv(\%userroles,\@rolecodes);
5911: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},"Role ".$spec);
5912: }
5913: }
5914: $$tstatus = 'is';
5915: }
5916: }
5917: if ($$tend) {
5918: if ($$tend<$update) {
5919: $$tstatus='expired';
5920: } elsif ($$tend<$now) {
5921: $$tstatus='will_not';
5922: }
5923: }
5924: }
5925: }
5926: }
5927:
5928: sub get_groups_roles {
5929: my ($cdom,$rest,$cdom_courseroles,$rolecodes,$groups_roles) = @_;
5930: return unless((ref($cdom_courseroles) eq 'HASH') &&
5931: (ref($rolecodes) eq 'ARRAY') &&
5932: (ref($groups_roles) eq 'HASH'));
5933: if (keys(%{$cdom_courseroles}) > 0) {
5934: my ($cnum) = ($rest =~ /^($match_courseid)/);
5935: if ($cdom ne '' && $cnum ne '') {
5936: foreach my $key (keys(%{$cdom_courseroles})) {
5937: if ($key =~ /^\Q$cnum\E:\Q$cdom\E:([^:]+):?([^:]*)/) {
5938: my $crsrole = $1;
5939: my $crssec = $2;
5940: if ($crsrole =~ /^cr/) {
5941: unless (grep(/^cr$/,@{$rolecodes})) {
5942: push(@{$rolecodes},'cr');
5943: }
5944: } else {
5945: unless(grep(/^\Q$crsrole\E$/,@{$rolecodes})) {
5946: push(@{$rolecodes},$crsrole);
5947: }
5948: }
5949: my $rolekey = "$crsrole./$cdom/$cnum";
5950: if ($crssec ne '') {
5951: $rolekey .= "/$crssec";
5952: }
5953: $rolekey .= './';
5954: $groups_roles->{$rolekey} = $rolecodes;
5955: }
5956: }
5957: }
5958: }
5959: return;
5960: }
5961:
5962: sub delete_env_groupprivs {
5963: my ($where,$courseroles,$possroles) = @_;
5964: return unless((ref($courseroles) eq 'HASH') && (ref($possroles) eq 'ARRAY'));
5965: my ($dummy,$udom,$uname,$group) = split(/\//,$where);
5966: unless (ref($courseroles->{$udom}) eq 'HASH') {
5967: %{$courseroles->{$udom}} =
5968: &get_my_roles('','','userroles',['active'],
5969: $possroles,[$udom],1);
5970: }
5971: if (ref($courseroles->{$udom}) eq 'HASH') {
5972: foreach my $item (keys(%{$courseroles->{$udom}})) {
5973: my ($cnum,$cdom,$crsrole,$crssec) = split(/:/,$item);
5974: my $area = '/'.$cdom.'/'.$cnum;
5975: my $privkey = "user.priv.$crsrole.$area";
5976: if ($crssec ne '') {
5977: $privkey .= '/'.$crssec;
5978: }
5979: $privkey .= ".$area/$group";
5980: &Apache::lonnet::delenv($privkey,undef,[$crsrole]);
5981: }
5982: }
5983: return;
5984: }
5985:
5986: sub check_adhoc_privs {
5987: my ($cdom,$cnum,$update,$refresh,$now,$checkrole,$caller,$sec) = @_;
5988: my $cckey = 'user.role.'.$checkrole.'./'.$cdom.'/'.$cnum;
5989: if ($sec) {
5990: $cckey .= '/'.$sec;
5991: }
5992: my $setprivs;
5993: if ($env{$cckey}) {
5994: my ($role,$where,$trolecode,$tstart,$tend,$tremark,$tstatus,$tpstart,$tpend);
5995: &role_status($cckey,$update,$refresh,$now,\$role,\$where,\$trolecode,\$tstatus,\$tstart,\$tend);
5996: unless (($tstatus eq 'is') || ($tstatus eq 'will_not')) {
5997: &set_adhoc_privileges($cdom,$cnum,$checkrole,$caller,$sec);
5998: $setprivs = 1;
5999: }
6000: } else {
6001: &set_adhoc_privileges($cdom,$cnum,$checkrole,$caller,$sec);
6002: $setprivs = 1;
6003: }
6004: return $setprivs;
6005: }
6006:
6007: sub set_adhoc_privileges {
6008: # role can be cc, ca, or cr/<dom>/<dom>-domainconfig/role
6009: my ($dcdom,$pickedcourse,$role,$caller,$sec) = @_;
6010: my $area = '/'.$dcdom.'/'.$pickedcourse;
6011: if ($sec ne '') {
6012: $area .= '/'.$sec;
6013: }
6014: my $spec = $role.'.'.$area;
6015: my %userroles = &set_arearole($role,$area,'','',$env{'user.domain'},
6016: $env{'user.name'},1);
6017: my %rolehash = ();
6018: if ($role =~ m{^\Qcr/$dcdom/$dcdom\E\-domainconfig/(\w+)$}) {
6019: my $rolename = $1;
6020: &custom_roleprivs(\%rolehash,$role,$dcdom,$pickedcourse,$spec,$area);
6021: my %domdef = &get_domain_defaults($dcdom);
6022: if (ref($domdef{'adhocroles'}) eq 'HASH') {
6023: if (ref($domdef{'adhocroles'}{$rolename}) eq 'HASH') {
6024: &appenv({'request.role.desc' => $domdef{'adhocroles'}{$rolename}{'desc'},});
6025: }
6026: }
6027: } else {
6028: &standard_roleprivs(\%rolehash,$role,$dcdom,$spec,$pickedcourse,$area);
6029: }
6030: my ($author,$adv,$rar)= &set_userprivs(\%userroles,\%rolehash);
6031: &appenv(\%userroles,[$role,'cm']);
6032: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},"Role ".$spec);
6033: unless ($caller eq 'constructaccess' && $env{'request.course.id'}) {
6034: &appenv( {'request.role' => $spec,
6035: 'request.role.domain' => $dcdom,
6036: 'request.course.sec' => $sec,
6037: }
6038: );
6039: my $tadv=0;
6040: if (&allowed('adv') eq 'F') { $tadv=1; }
6041: &appenv({'request.role.adv' => $tadv});
6042: }
6043: }
6044:
6045: # --------------------------------------------------------------- get interface
6046:
6047: sub get {
6048: my ($namespace,$storearr,$udomain,$uname)=@_;
6049: my $items='';
6050: foreach my $item (@$storearr) {
6051: $items.=&escape($item).'&';
6052: }
6053: $items=~s/\&$//;
6054: if (!$udomain) { $udomain=$env{'user.domain'}; }
6055: if (!$uname) { $uname=$env{'user.name'}; }
6056: my $uhome=&homeserver($uname,$udomain);
6057:
6058: my $rep=&reply("get:$udomain:$uname:$namespace:$items",$uhome);
6059: my @pairs=split(/\&/,$rep);
6060: if ( $#pairs==0 && $pairs[0] =~ /^(con_lost|error|no_such_host)/i) {
6061: return @pairs;
6062: }
6063: my %returnhash=();
6064: my $i=0;
6065: foreach my $item (@$storearr) {
6066: $returnhash{$item}=&thaw_unescape($pairs[$i]);
6067: $i++;
6068: }
6069: return %returnhash;
6070: }
6071:
6072: # --------------------------------------------------------------- del interface
6073:
6074: sub del {
6075: my ($namespace,$storearr,$udomain,$uname)=@_;
6076: my $items='';
6077: foreach my $item (@$storearr) {
6078: $items.=&escape($item).'&';
6079: }
6080:
6081: $items=~s/\&$//;
6082: if (!$udomain) { $udomain=$env{'user.domain'}; }
6083: if (!$uname) { $uname=$env{'user.name'}; }
6084: my $uhome=&homeserver($uname,$udomain);
6085: return &reply("del:$udomain:$uname:$namespace:$items",$uhome);
6086: }
6087:
6088: # -------------------------------------------------------------- dump interface
6089:
6090: sub unserialize {
6091: my ($rep, $escapedkeys) = @_;
6092:
6093: return {} if $rep =~ /^error/;
6094:
6095: my %returnhash=();
6096: foreach my $item (split(/\&/,$rep)) {
6097: my ($key, $value) = split(/=/, $item, 2);
6098: $key = unescape($key) unless $escapedkeys;
6099: next if $key =~ /^error: 2 /;
6100: $returnhash{$key} = &thaw_unescape($value);
6101: }
6102: return \%returnhash;
6103: }
6104:
6105: # see Lond::dump_with_regexp
6106: # if $escapedkeys hash keys won't get unescaped.
6107: sub dump {
6108: my ($namespace,$udomain,$uname,$regexp,$range,$escapedkeys)=@_;
6109: if (!$udomain) { $udomain=$env{'user.domain'}; }
6110: if (!$uname) { $uname=$env{'user.name'}; }
6111: my $uhome=&homeserver($uname,$udomain);
6112:
6113: if ($regexp) {
6114: $regexp=&escape($regexp);
6115: } else {
6116: $regexp='.';
6117: }
6118: if (grep { $_ eq $uhome } ¤t_machine_ids()) {
6119: # user is hosted on this machine
6120: my $reply = LONCAPA::Lond::dump_with_regexp(join(':', ($udomain,
6121: $uname, $namespace, $regexp, $range)), $perlvar{'lonVersion'});
6122: return %{&unserialize($reply, $escapedkeys)};
6123: }
6124: my $rep=&reply("dump:$udomain:$uname:$namespace:$regexp:$range",$uhome);
6125: my @pairs=split(/\&/,$rep);
6126: my %returnhash=();
6127: if (!($rep =~ /^error/ )) {
6128: foreach my $item (@pairs) {
6129: my ($key,$value)=split(/=/,$item,2);
6130: $key = &unescape($key) unless ($escapedkeys);
6131: next if ($key =~ /^error: 2 /);
6132: $returnhash{$key}=&thaw_unescape($value);
6133: }
6134: }
6135: return %returnhash;
6136: }
6137:
6138:
6139: # --------------------------------------------------------- dumpstore interface
6140:
6141: sub dumpstore {
6142: my ($namespace,$udomain,$uname,$regexp,$range)=@_;
6143: # same as dump but keys must be escaped. They may contain colon separated
6144: # lists of values that may themself contain colons (e.g. symbs).
6145: return &dump($namespace, $udomain, $uname, $regexp, $range, 1);
6146: }
6147:
6148: # -------------------------------------------------------------- keys interface
6149:
6150: sub getkeys {
6151: my ($namespace,$udomain,$uname)=@_;
6152: if (!$udomain) { $udomain=$env{'user.domain'}; }
6153: if (!$uname) { $uname=$env{'user.name'}; }
6154: my $uhome=&homeserver($uname,$udomain);
6155: my $rep=reply("keys:$udomain:$uname:$namespace",$uhome);
6156: my @keyarray=();
6157: foreach my $key (split(/\&/,$rep)) {
6158: next if ($key =~ /^error: 2 /);
6159: push(@keyarray,&unescape($key));
6160: }
6161: return @keyarray;
6162: }
6163:
6164: # --------------------------------------------------------------- currentdump
6165: sub currentdump {
6166: my ($courseid,$sdom,$sname)=@_;
6167: $courseid = $env{'request.course.id'} if (! defined($courseid));
6168: $sdom = $env{'user.domain'} if (! defined($sdom));
6169: $sname = $env{'user.name'} if (! defined($sname));
6170: my $uhome = &homeserver($sname,$sdom);
6171: my $rep;
6172:
6173: if (grep { $_ eq $uhome } current_machine_ids()) {
6174: $rep = LONCAPA::Lond::dump_profile_database(join(":", ($sdom, $sname,
6175: $courseid)));
6176: } else {
6177: $rep = reply('currentdump:'.$sdom.':'.$sname.':'.$courseid,$uhome);
6178: }
6179:
6180: return if ($rep =~ /^(error:|no_such_host)/);
6181: #
6182: my %returnhash=();
6183: #
6184: if ($rep eq "unknown_cmd") {
6185: # an old lond will not know currentdump
6186: # Do a dump and make it look like a currentdump
6187: my @tmp = &dumpstore($courseid,$sdom,$sname,'.');
6188: return if ($tmp[0] =~ /^(error:|no_such_host)/);
6189: my %hash = @tmp;
6190: @tmp=();
6191: %returnhash = %{&convert_dump_to_currentdump(\%hash)};
6192: } else {
6193: my @pairs=split(/\&/,$rep);
6194: foreach my $pair (@pairs) {
6195: my ($key,$value)=split(/=/,$pair,2);
6196: my ($symb,$param) = split(/:/,$key);
6197: $returnhash{&unescape($symb)}->{&unescape($param)} =
6198: &thaw_unescape($value);
6199: }
6200: }
6201: return %returnhash;
6202: }
6203:
6204: sub convert_dump_to_currentdump{
6205: my %hash = %{shift()};
6206: my %returnhash;
6207: # Code ripped from lond, essentially. The only difference
6208: # here is the unescaping done by lonnet::dump(). Conceivably
6209: # we might run in to problems with parameter names =~ /^v\./
6210: while (my ($key,$value) = each(%hash)) {
6211: my ($v,$symb,$param) = split(/:/,$key);
6212: $symb = &unescape($symb);
6213: $param = &unescape($param);
6214: next if ($v eq 'version' || $symb eq 'keys');
6215: next if (exists($returnhash{$symb}) &&
6216: exists($returnhash{$symb}->{$param}) &&
6217: $returnhash{$symb}->{'v.'.$param} > $v);
6218: $returnhash{$symb}->{$param}=$value;
6219: $returnhash{$symb}->{'v.'.$param}=$v;
6220: }
6221: #
6222: # Remove all of the keys in the hashes which keep track of
6223: # the version of the parameter.
6224: while (my ($symb,$param_hash) = each(%returnhash)) {
6225: # use a foreach because we are going to delete from the hash.
6226: foreach my $key (keys(%$param_hash)) {
6227: delete($param_hash->{$key}) if ($key =~ /^v\./);
6228: }
6229: }
6230: return \%returnhash;
6231: }
6232:
6233: # ------------------------------------------------------ critical inc interface
6234:
6235: sub cinc {
6236: return &inc(@_,'critical');
6237: }
6238:
6239: # --------------------------------------------------------------- inc interface
6240:
6241: sub inc {
6242: my ($namespace,$store,$udomain,$uname,$critical) = @_;
6243: if (!$udomain) { $udomain=$env{'user.domain'}; }
6244: if (!$uname) { $uname=$env{'user.name'}; }
6245: my $uhome=&homeserver($uname,$udomain);
6246: my $items='';
6247: if (! ref($store)) {
6248: # got a single value, so use that instead
6249: $items = &escape($store).'=&';
6250: } elsif (ref($store) eq 'SCALAR') {
6251: $items = &escape($$store).'=&';
6252: } elsif (ref($store) eq 'ARRAY') {
6253: $items = join('=&',map {&escape($_);} @{$store});
6254: } elsif (ref($store) eq 'HASH') {
6255: while (my($key,$value) = each(%{$store})) {
6256: $items.= &escape($key).'='.&escape($value).'&';
6257: }
6258: }
6259: $items=~s/\&$//;
6260: if ($critical) {
6261: return &critical("inc:$udomain:$uname:$namespace:$items",$uhome);
6262: } else {
6263: return &reply("inc:$udomain:$uname:$namespace:$items",$uhome);
6264: }
6265: }
6266:
6267: # --------------------------------------------------------------- put interface
6268:
6269: sub put {
6270: my ($namespace,$storehash,$udomain,$uname)=@_;
6271: if (!$udomain) { $udomain=$env{'user.domain'}; }
6272: if (!$uname) { $uname=$env{'user.name'}; }
6273: my $uhome=&homeserver($uname,$udomain);
6274: my $items='';
6275: foreach my $item (keys(%$storehash)) {
6276: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
6277: }
6278: $items=~s/\&$//;
6279: return &reply("put:$udomain:$uname:$namespace:$items",$uhome);
6280: }
6281:
6282: # ------------------------------------------------------------ newput interface
6283:
6284: sub newput {
6285: my ($namespace,$storehash,$udomain,$uname)=@_;
6286: if (!$udomain) { $udomain=$env{'user.domain'}; }
6287: if (!$uname) { $uname=$env{'user.name'}; }
6288: my $uhome=&homeserver($uname,$udomain);
6289: my $items='';
6290: foreach my $key (keys(%$storehash)) {
6291: $items.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
6292: }
6293: $items=~s/\&$//;
6294: return &reply("newput:$udomain:$uname:$namespace:$items",$uhome);
6295: }
6296:
6297: # --------------------------------------------------------- putstore interface
6298:
6299: sub putstore {
6300: my ($namespace,$symb,$version,$storehash,$udomain,$uname,$tolog)=@_;
6301: if (!$udomain) { $udomain=$env{'user.domain'}; }
6302: if (!$uname) { $uname=$env{'user.name'}; }
6303: my $uhome=&homeserver($uname,$udomain);
6304: my $items='';
6305: foreach my $key (keys(%$storehash)) {
6306: $items.= &escape($key).'='.&freeze_escape($storehash->{$key}).'&';
6307: }
6308: $items=~s/\&$//;
6309: my $esc_symb=&escape($symb);
6310: my $esc_v=&escape($version);
6311: my $reply =
6312: &reply("putstore:$udomain:$uname:$namespace:$esc_symb:$esc_v:$items",
6313: $uhome);
6314: if (($tolog) && ($reply eq 'ok')) {
6315: my $namevalue='';
6316: foreach my $key (keys(%{$storehash})) {
6317: $namevalue.=&escape($key).'='.&freeze_escape($storehash->{$key}).'&';
6318: }
6319: $namevalue .= 'ip='.&escape($ENV{'REMOTE_ADDR'}).
6320: '&host='.&escape($perlvar{'lonHostID'}).
6321: '&version='.$esc_v.
6322: '&by='.&escape($env{'user.name'}.':'.$env{'user.domain'});
6323: &Apache::lonnet::courselog($symb.':'.$uname.':'.$udomain.':PUTSTORE:'.$namevalue);
6324: }
6325: if ($reply eq 'unknown_cmd') {
6326: # gfall back to way things use to be done
6327: return &old_putstore($namespace,$symb,$version,$storehash,$udomain,
6328: $uname);
6329: }
6330: return $reply;
6331: }
6332:
6333: sub old_putstore {
6334: my ($namespace,$symb,$version,$storehash,$udomain,$uname)=@_;
6335: if (!$udomain) { $udomain=$env{'user.domain'}; }
6336: if (!$uname) { $uname=$env{'user.name'}; }
6337: my $uhome=&homeserver($uname,$udomain);
6338: my %newstorehash;
6339: foreach my $item (keys(%$storehash)) {
6340: my $key = $version.':'.&escape($symb).':'.$item;
6341: $newstorehash{$key} = $storehash->{$item};
6342: }
6343: my $items='';
6344: my %allitems = ();
6345: foreach my $item (keys(%newstorehash)) {
6346: if ($item =~ m/^([^\:]+):([^\:]+):([^\:]+)$/) {
6347: my $key = $1.':keys:'.$2;
6348: $allitems{$key} .= $3.':';
6349: }
6350: $items.=$item.'='.&freeze_escape($newstorehash{$item}).'&';
6351: }
6352: foreach my $item (keys(%allitems)) {
6353: $allitems{$item} =~ s/\:$//;
6354: $items.= $item.'='.$allitems{$item}.'&';
6355: }
6356: $items=~s/\&$//;
6357: return &reply("put:$udomain:$uname:$namespace:$items",$uhome);
6358: }
6359:
6360: # ------------------------------------------------------ critical put interface
6361:
6362: sub cput {
6363: my ($namespace,$storehash,$udomain,$uname)=@_;
6364: if (!$udomain) { $udomain=$env{'user.domain'}; }
6365: if (!$uname) { $uname=$env{'user.name'}; }
6366: my $uhome=&homeserver($uname,$udomain);
6367: my $items='';
6368: foreach my $item (keys(%$storehash)) {
6369: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
6370: }
6371: $items=~s/\&$//;
6372: return &critical("put:$udomain:$uname:$namespace:$items",$uhome);
6373: }
6374:
6375: # -------------------------------------------------------------- eget interface
6376:
6377: sub eget {
6378: my ($namespace,$storearr,$udomain,$uname)=@_;
6379: my $items='';
6380: foreach my $item (@$storearr) {
6381: $items.=&escape($item).'&';
6382: }
6383: $items=~s/\&$//;
6384: if (!$udomain) { $udomain=$env{'user.domain'}; }
6385: if (!$uname) { $uname=$env{'user.name'}; }
6386: my $uhome=&homeserver($uname,$udomain);
6387: my $rep=&reply("eget:$udomain:$uname:$namespace:$items",$uhome);
6388: my @pairs=split(/\&/,$rep);
6389: my %returnhash=();
6390: my $i=0;
6391: foreach my $item (@$storearr) {
6392: $returnhash{$item}=&thaw_unescape($pairs[$i]);
6393: $i++;
6394: }
6395: return %returnhash;
6396: }
6397:
6398: # ------------------------------------------------------------ tmpput interface
6399: sub tmpput {
6400: my ($storehash,$server,$context)=@_;
6401: my $items='';
6402: foreach my $item (keys(%$storehash)) {
6403: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
6404: }
6405: $items=~s/\&$//;
6406: if (defined($context)) {
6407: $items .= ':'.&escape($context);
6408: }
6409: return &reply("tmpput:$items",$server);
6410: }
6411:
6412: # ------------------------------------------------------------ tmpget interface
6413: sub tmpget {
6414: my ($token,$server)=@_;
6415: if (!defined($server)) { $server = $perlvar{'lonHostID'}; }
6416: my $rep=&reply("tmpget:$token",$server);
6417: my %returnhash;
6418: if ($rep =~ /^(con_lost|error|no_such_host)/i) {
6419: return %returnhash;
6420: }
6421: foreach my $item (split(/\&/,$rep)) {
6422: my ($key,$value)=split(/=/,$item);
6423: $returnhash{&unescape($key)}=&thaw_unescape($value);
6424: }
6425: return %returnhash;
6426: }
6427:
6428: # ------------------------------------------------------------ tmpdel interface
6429: sub tmpdel {
6430: my ($token,$server)=@_;
6431: if (!defined($server)) { $server = $perlvar{'lonHostID'}; }
6432: return &reply("tmpdel:$token",$server);
6433: }
6434:
6435: # ------------------------------------------------------------ get_timebased_id
6436:
6437: sub get_timebased_id {
6438: my ($prefix,$keyid,$namespace,$cdom,$cnum,$idtype,$who,$locktries,
6439: $maxtries) = @_;
6440: my ($newid,$error,$dellock);
6441: unless (($prefix =~ /^\w+$/) && ($keyid =~ /^\w+$/) && ($namespace ne '')) {
6442: return ('','ok','invalid call to get suffix');
6443: }
6444:
6445: # set defaults for any optional args for which values were not supplied
6446: if ($who eq '') {
6447: $who = $env{'user.name'}.':'.$env{'user.domain'};
6448: }
6449: if (!$locktries) {
6450: $locktries = 3;
6451: }
6452: if (!$maxtries) {
6453: $maxtries = 10;
6454: }
6455:
6456: if (($cdom eq '') || ($cnum eq '')) {
6457: if ($env{'request.course.id'}) {
6458: $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
6459: $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
6460: }
6461: if (($cdom eq '') || ($cnum eq '')) {
6462: return ('','ok','call to get suffix not in course context');
6463: }
6464: }
6465:
6466: # construct locking item
6467: my $lockhash = {
6468: $prefix."\0".'locked_'.$keyid => $who,
6469: };
6470: my $tries = 0;
6471:
6472: # attempt to get lock on nohist_$namespace file
6473: my $gotlock = &Apache::lonnet::newput('nohist_'.$namespace,$lockhash,$cdom,$cnum);
6474: while (($gotlock ne 'ok') && $tries <$locktries) {
6475: $tries ++;
6476: sleep 1;
6477: $gotlock = &Apache::lonnet::newput('nohist_'.$namespace,$lockhash,$cdom,$cnum);
6478: }
6479:
6480: # attempt to get unique identifier, based on current timestamp
6481: if ($gotlock eq 'ok') {
6482: my %inuse = &Apache::lonnet::dump('nohist_'.$namespace,$cdom,$cnum,$prefix);
6483: my $id = time;
6484: $newid = $id;
6485: if ($idtype eq 'addcode') {
6486: $newid .= &sixnum_code();
6487: }
6488: my $idtries = 0;
6489: while (exists($inuse{$prefix."\0".$newid}) && $idtries < $maxtries) {
6490: if ($idtype eq 'concat') {
6491: $newid = $id.$idtries;
6492: } elsif ($idtype eq 'addcode') {
6493: $newid = $newid.&sixnum_code();
6494: } else {
6495: $newid ++;
6496: }
6497: $idtries ++;
6498: }
6499: if (!exists($inuse{$prefix."\0".$newid})) {
6500: my %new_item = (
6501: $prefix."\0".$newid => $who,
6502: );
6503: my $putresult = &Apache::lonnet::put('nohist_'.$namespace,\%new_item,
6504: $cdom,$cnum);
6505: if ($putresult ne 'ok') {
6506: undef($newid);
6507: $error = 'error saving new item: '.$putresult;
6508: }
6509: } else {
6510: undef($newid);
6511: $error = ('error: no unique suffix available for the new item ');
6512: }
6513: # remove lock
6514: my @del_lock = ($prefix."\0".'locked_'.$keyid);
6515: $dellock = &Apache::lonnet::del('nohist_'.$namespace,\@del_lock,$cdom,$cnum);
6516: } else {
6517: $error = "error: could not obtain lockfile\n";
6518: $dellock = 'ok';
6519: if (($prefix eq 'paste') && ($namespace eq 'courseeditor') && ($keyid eq 'num')) {
6520: $dellock = 'nolock';
6521: }
6522: }
6523: return ($newid,$dellock,$error);
6524: }
6525:
6526: sub sixnum_code {
6527: my $code;
6528: for (0..6) {
6529: $code .= int( rand(9) );
6530: }
6531: return $code;
6532: }
6533:
6534: # -------------------------------------------------- portfolio access checking
6535:
6536: sub portfolio_access {
6537: my ($requrl,$clientip) = @_;
6538: my (undef,$udom,$unum,$file_name,$group) = &parse_portfolio_url($requrl);
6539: my $result = &get_portfolio_access($udom,$unum,$file_name,$group,$clientip);
6540: if ($result) {
6541: my %setters;
6542: if ($env{'user.name'} eq 'public' && $env{'user.domain'} eq 'public') {
6543: my ($startblock,$endblock) =
6544: &Apache::loncommon::blockcheck(\%setters,'port',$unum,$udom);
6545: if ($startblock && $endblock) {
6546: return 'B';
6547: }
6548: } else {
6549: my ($startblock,$endblock) =
6550: &Apache::loncommon::blockcheck(\%setters,'port');
6551: if ($startblock && $endblock) {
6552: return 'B';
6553: }
6554: }
6555: }
6556: if ($result eq 'ok') {
6557: return 'F';
6558: } elsif ($result =~ /^[^:]+:guest_/) {
6559: return 'A';
6560: }
6561: return '';
6562: }
6563:
6564: sub get_portfolio_access {
6565: my ($udom,$unum,$file_name,$group,$clientip,$access_hash) = @_;
6566:
6567: if (!ref($access_hash)) {
6568: my $current_perms = &get_portfile_permissions($udom,$unum);
6569: my %access_controls = &get_access_controls($current_perms,$group,
6570: $file_name);
6571: $access_hash = $access_controls{$file_name};
6572: }
6573:
6574: my ($public,$guest,@domains,@users,@courses,@groups,@ips);
6575: my $now = time;
6576: if (ref($access_hash) eq 'HASH') {
6577: foreach my $key (keys(%{$access_hash})) {
6578: my ($num,$scope,$end,$start) = ($key =~ /^([^:]+):([a-z]+)_(\d*)_?(\d*)$/);
6579: if ($start > $now) {
6580: next;
6581: }
6582: if ($end && $end<$now) {
6583: next;
6584: }
6585: if ($scope eq 'public') {
6586: $public = $key;
6587: last;
6588: } elsif ($scope eq 'guest') {
6589: $guest = $key;
6590: } elsif ($scope eq 'domains') {
6591: push(@domains,$key);
6592: } elsif ($scope eq 'users') {
6593: push(@users,$key);
6594: } elsif ($scope eq 'course') {
6595: push(@courses,$key);
6596: } elsif ($scope eq 'group') {
6597: push(@groups,$key);
6598: } elsif ($scope eq 'ip') {
6599: push(@ips,$key);
6600: }
6601: }
6602: if ($public) {
6603: return 'ok';
6604: } elsif (@ips > 0) {
6605: my $allowed;
6606: foreach my $ipkey (@ips) {
6607: if (ref($access_hash->{$ipkey}{'ip'}) eq 'ARRAY') {
6608: if (&Apache::loncommon::check_ip_acc(join(',',@{$access_hash->{$ipkey}{'ip'}}),$clientip)) {
6609: $allowed = 1;
6610: last;
6611: }
6612: }
6613: }
6614: if ($allowed) {
6615: return 'ok';
6616: }
6617: }
6618: if ($env{'user.name'} eq 'public' && $env{'user.domain'} eq 'public') {
6619: if ($guest) {
6620: return $guest;
6621: }
6622: } else {
6623: if (@domains > 0) {
6624: foreach my $domkey (@domains) {
6625: if (ref($access_hash->{$domkey}{'dom'}) eq 'ARRAY') {
6626: if (grep(/^\Q$env{'user.domain'}\E$/,@{$access_hash->{$domkey}{'dom'}})) {
6627: return 'ok';
6628: }
6629: }
6630: }
6631: }
6632: if (@users > 0) {
6633: foreach my $userkey (@users) {
6634: if (ref($access_hash->{$userkey}{'users'}) eq 'ARRAY') {
6635: foreach my $item (@{$access_hash->{$userkey}{'users'}}) {
6636: if (ref($item) eq 'HASH') {
6637: if (($item->{'uname'} eq $env{'user.name'}) &&
6638: ($item->{'udom'} eq $env{'user.domain'})) {
6639: return 'ok';
6640: }
6641: }
6642: }
6643: }
6644: }
6645: }
6646: my %roleshash;
6647: my @courses_and_groups = @courses;
6648: push(@courses_and_groups,@groups);
6649: if (@courses_and_groups > 0) {
6650: my (%allgroups,%allroles);
6651: my ($start,$end,$role,$sec,$group);
6652: foreach my $envkey (%env) {
6653: if ($envkey =~ m-^user\.role\.(gr|cc|co|in|ta|ep|ad|st)\./($match_domain)/($match_courseid)/?([^/]*)$-) {
6654: my $cid = $2.'_'.$3;
6655: if ($1 eq 'gr') {
6656: $group = $4;
6657: $allgroups{$cid}{$group} = $env{$envkey};
6658: } else {
6659: if ($4 eq '') {
6660: $sec = 'none';
6661: } else {
6662: $sec = $4;
6663: }
6664: $allroles{$cid}{$1}{$sec} = $env{$envkey};
6665: }
6666: } elsif ($envkey =~ m-^user\.role\./cr/($match_domain/$match_username/\w*)./($match_domain)/($match_courseid)/?([^/]*)$-) {
6667: my $cid = $2.'_'.$3;
6668: if ($4 eq '') {
6669: $sec = 'none';
6670: } else {
6671: $sec = $4;
6672: }
6673: $allroles{$cid}{$1}{$sec} = $env{$envkey};
6674: }
6675: }
6676: if (keys(%allroles) == 0) {
6677: return;
6678: }
6679: foreach my $key (@courses_and_groups) {
6680: my %content = %{$$access_hash{$key}};
6681: my $cnum = $content{'number'};
6682: my $cdom = $content{'domain'};
6683: my $cid = $cdom.'_'.$cnum;
6684: if (!exists($allroles{$cid})) {
6685: next;
6686: }
6687: foreach my $role_id (keys(%{$content{'roles'}})) {
6688: my @sections = @{$content{'roles'}{$role_id}{'section'}};
6689: my @groups = @{$content{'roles'}{$role_id}{'group'}};
6690: my @status = @{$content{'roles'}{$role_id}{'access'}};
6691: my @roles = @{$content{'roles'}{$role_id}{'role'}};
6692: foreach my $role (keys(%{$allroles{$cid}})) {
6693: if ((grep/^all$/,@roles) || (grep/^\Q$role\E$/,@roles)) {
6694: foreach my $sec (keys(%{$allroles{$cid}{$role}})) {
6695: if (&course_group_datechecker($allroles{$cid}{$role}{$sec},$now,\@status) eq 'ok') {
6696: if (grep/^all$/,@sections) {
6697: return 'ok';
6698: } else {
6699: if (grep/^$sec$/,@sections) {
6700: return 'ok';
6701: }
6702: }
6703: }
6704: }
6705: if (keys(%{$allgroups{$cid}}) == 0) {
6706: if (grep/^none$/,@groups) {
6707: return 'ok';
6708: }
6709: } else {
6710: if (grep/^all$/,@groups) {
6711: return 'ok';
6712: }
6713: foreach my $group (keys(%{$allgroups{$cid}})) {
6714: if (grep/^$group$/,@groups) {
6715: return 'ok';
6716: }
6717: }
6718: }
6719: }
6720: }
6721: }
6722: }
6723: }
6724: if ($guest) {
6725: return $guest;
6726: }
6727: }
6728: }
6729: return;
6730: }
6731:
6732: sub course_group_datechecker {
6733: my ($dates,$now,$status) = @_;
6734: my ($start,$end) = split(/\./,$dates);
6735: if (!$start && !$end) {
6736: return 'ok';
6737: }
6738: if (grep/^active$/,@{$status}) {
6739: if (((!$start) || ($start && $start <= $now)) && ((!$end) || ($end && $end >= $now))) {
6740: return 'ok';
6741: }
6742: }
6743: if (grep/^previous$/,@{$status}) {
6744: if ($end > $now ) {
6745: return 'ok';
6746: }
6747: }
6748: if (grep/^future$/,@{$status}) {
6749: if ($start > $now) {
6750: return 'ok';
6751: }
6752: }
6753: return;
6754: }
6755:
6756: sub parse_portfolio_url {
6757: my ($url) = @_;
6758:
6759: my ($type,$udom,$unum,$group,$file_name);
6760:
6761: if ($url =~ m-^/*(?:uploaded|editupload)/($match_domain)/($match_username)/portfolio(/.+)$-) {
6762: $type = 1;
6763: $udom = $1;
6764: $unum = $2;
6765: $file_name = $3;
6766: } elsif ($url =~ m-^/*(?:uploaded|editupload)/($match_domain)/($match_courseid)/groups/([^/]+)/portfolio/(.+)$-) {
6767: $type = 2;
6768: $udom = $1;
6769: $unum = $2;
6770: $group = $3;
6771: $file_name = $3.'/'.$4;
6772: }
6773: if (wantarray) {
6774: return ($type,$udom,$unum,$file_name,$group);
6775: }
6776: return $type;
6777: }
6778:
6779: sub is_portfolio_url {
6780: my ($url) = @_;
6781: return scalar(&parse_portfolio_url($url));
6782: }
6783:
6784: sub is_portfolio_file {
6785: my ($file) = @_;
6786: if (($file =~ /^portfolio/) || ($file =~ /^groups\/\w+\/portfolio/)) {
6787: return 1;
6788: }
6789: return;
6790: }
6791:
6792: sub usertools_access {
6793: my ($uname,$udom,$tool,$action,$context,$userenvref,$domdefref,$is_advref)=@_;
6794: my ($access,%tools);
6795: if ($context eq '') {
6796: $context = 'tools';
6797: }
6798: if ($context eq 'requestcourses') {
6799: %tools = (
6800: official => 1,
6801: unofficial => 1,
6802: community => 1,
6803: textbook => 1,
6804: );
6805: } elsif ($context eq 'requestauthor') {
6806: %tools = (
6807: requestauthor => 1,
6808: );
6809: } else {
6810: %tools = (
6811: aboutme => 1,
6812: blog => 1,
6813: webdav => 1,
6814: portfolio => 1,
6815: );
6816: }
6817: return if (!defined($tools{$tool}));
6818:
6819: if (($udom eq '') || ($uname eq '')) {
6820: $udom = $env{'user.domain'};
6821: $uname = $env{'user.name'};
6822: }
6823:
6824: if (($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'})) {
6825: if ($action ne 'reload') {
6826: if ($context eq 'requestcourses') {
6827: return $env{'environment.canrequest.'.$tool};
6828: } elsif ($context eq 'requestauthor') {
6829: return $env{'environment.canrequest.author'};
6830: } else {
6831: return $env{'environment.availabletools.'.$tool};
6832: }
6833: }
6834: }
6835:
6836: my ($toolstatus,$inststatus,$envkey);
6837: if ($context eq 'requestauthor') {
6838: $envkey = $context;
6839: } else {
6840: $envkey = $context.'.'.$tool;
6841: }
6842:
6843: if (($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'}) &&
6844: ($action ne 'reload')) {
6845: $toolstatus = $env{'environment.'.$envkey};
6846: $inststatus = $env{'environment.inststatus'};
6847: } else {
6848: if (ref($userenvref) eq 'HASH') {
6849: $toolstatus = $userenvref->{$envkey};
6850: $inststatus = $userenvref->{'inststatus'};
6851: } else {
6852: my %userenv = &userenvironment($udom,$uname,$envkey,'inststatus');
6853: $toolstatus = $userenv{$envkey};
6854: $inststatus = $userenv{'inststatus'};
6855: }
6856: }
6857:
6858: if ($toolstatus ne '') {
6859: if ($toolstatus) {
6860: $access = 1;
6861: } else {
6862: $access = 0;
6863: }
6864: return $access;
6865: }
6866:
6867: my ($is_adv,%domdef);
6868: if (ref($is_advref) eq 'HASH') {
6869: $is_adv = $is_advref->{'is_adv'};
6870: } else {
6871: $is_adv = &is_advanced_user($udom,$uname);
6872: }
6873: if (ref($domdefref) eq 'HASH') {
6874: %domdef = %{$domdefref};
6875: } else {
6876: %domdef = &get_domain_defaults($udom);
6877: }
6878: if (ref($domdef{$tool}) eq 'HASH') {
6879: if ($is_adv) {
6880: if ($domdef{$tool}{'_LC_adv'} ne '') {
6881: if ($domdef{$tool}{'_LC_adv'}) {
6882: $access = 1;
6883: } else {
6884: $access = 0;
6885: }
6886: return $access;
6887: }
6888: }
6889: if ($inststatus ne '') {
6890: my ($hasaccess,$hasnoaccess);
6891: foreach my $affiliation (split(/:/,$inststatus)) {
6892: if ($domdef{$tool}{$affiliation} ne '') {
6893: if ($domdef{$tool}{$affiliation}) {
6894: $hasaccess = 1;
6895: } else {
6896: $hasnoaccess = 1;
6897: }
6898: }
6899: }
6900: if ($hasaccess || $hasnoaccess) {
6901: if ($hasaccess) {
6902: $access = 1;
6903: } elsif ($hasnoaccess) {
6904: $access = 0;
6905: }
6906: return $access;
6907: }
6908: } else {
6909: if ($domdef{$tool}{'default'} ne '') {
6910: if ($domdef{$tool}{'default'}) {
6911: $access = 1;
6912: } elsif ($domdef{$tool}{'default'} == 0) {
6913: $access = 0;
6914: }
6915: return $access;
6916: }
6917: }
6918: } else {
6919: if (($context eq 'tools') && ($tool ne 'webdav')) {
6920: $access = 1;
6921: } else {
6922: $access = 0;
6923: }
6924: return $access;
6925: }
6926: }
6927:
6928: sub is_course_owner {
6929: my ($cdom,$cnum,$udom,$uname) = @_;
6930: if (($udom eq '') || ($uname eq '')) {
6931: $udom = $env{'user.domain'};
6932: $uname = $env{'user.name'};
6933: }
6934: unless (($udom eq '') || ($uname eq '')) {
6935: if (exists($env{'course.'.$cdom.'_'.$cnum.'.internal.courseowner'})) {
6936: if ($env{'course.'.$cdom.'_'.$cnum.'.internal.courseowner'} eq $uname.':'.$udom) {
6937: return 1;
6938: } else {
6939: my %courseinfo = &Apache::lonnet::coursedescription($cdom.'/'.$cnum);
6940: if ($courseinfo{'internal.courseowner'} eq $uname.':'.$udom) {
6941: return 1;
6942: }
6943: }
6944: }
6945: }
6946: return;
6947: }
6948:
6949: sub is_advanced_user {
6950: my ($udom,$uname) = @_;
6951: if ($udom ne '' && $uname ne '') {
6952: if (($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'})) {
6953: if (wantarray) {
6954: return ($env{'user.adv'},$env{'user.author'});
6955: } else {
6956: return $env{'user.adv'};
6957: }
6958: }
6959: }
6960: my %roleshash = &get_my_roles($uname,$udom,'userroles',undef,undef,undef,1);
6961: my %allroles;
6962: my ($is_adv,$is_author);
6963: foreach my $role (keys(%roleshash)) {
6964: my ($trest,$tdomain,$trole,$sec) = split(/:/,$role);
6965: my $area = '/'.$tdomain.'/'.$trest;
6966: if ($sec ne '') {
6967: $area .= '/'.$sec;
6968: }
6969: if (($area ne '') && ($trole ne '')) {
6970: my $spec=$trole.'.'.$area;
6971: if ($trole =~ /^cr\//) {
6972: &custom_roleprivs(\%allroles,$trole,$tdomain,$trest,$spec,$area);
6973: } elsif ($trole ne 'gr') {
6974: &standard_roleprivs(\%allroles,$trole,$tdomain,$spec,$trest,$area);
6975: }
6976: if ($trole eq 'au') {
6977: $is_author = 1;
6978: }
6979: }
6980: }
6981: foreach my $role (keys(%allroles)) {
6982: last if ($is_adv);
6983: foreach my $item (split(/:/,$allroles{$role})) {
6984: if ($item ne '') {
6985: my ($privilege,$restrictions)=split(/&/,$item);
6986: if ($privilege eq 'adv') {
6987: $is_adv = 1;
6988: last;
6989: }
6990: }
6991: }
6992: }
6993: if (wantarray) {
6994: return ($is_adv,$is_author);
6995: }
6996: return $is_adv;
6997: }
6998:
6999: sub check_can_request {
7000: my ($dom,$can_request,$request_domains) = @_;
7001: my $canreq = 0;
7002: my ($types,$typename) = &Apache::loncommon::course_types();
7003: my @options = ('approval','validate','autolimit');
7004: my $optregex = join('|',@options);
7005: if ((ref($can_request) eq 'HASH') && (ref($types) eq 'ARRAY')) {
7006: foreach my $type (@{$types}) {
7007: if (&usertools_access($env{'user.name'},
7008: $env{'user.domain'},
7009: $type,undef,'requestcourses')) {
7010: $canreq ++;
7011: if (ref($request_domains) eq 'HASH') {
7012: push(@{$request_domains->{$type}},$env{'user.domain'});
7013: }
7014: if ($dom eq $env{'user.domain'}) {
7015: $can_request->{$type} = 1;
7016: }
7017: }
7018: if ($env{'environment.reqcrsotherdom.'.$type} ne '') {
7019: my @curr = split(',',$env{'environment.reqcrsotherdom.'.$type});
7020: if (@curr > 0) {
7021: foreach my $item (@curr) {
7022: if (ref($request_domains) eq 'HASH') {
7023: my ($otherdom) = ($item =~ /^($match_domain):($optregex)(=?\d*)$/);
7024: if ($otherdom ne '') {
7025: if (ref($request_domains->{$type}) eq 'ARRAY') {
7026: unless (grep(/^\Q$otherdom\E$/,@{$request_domains->{$type}})) {
7027: push(@{$request_domains->{$type}},$otherdom);
7028: }
7029: } else {
7030: push(@{$request_domains->{$type}},$otherdom);
7031: }
7032: }
7033: }
7034: }
7035: unless($dom eq $env{'user.domain'}) {
7036: $canreq ++;
7037: if (grep(/^\Q$dom\E:($optregex)(=?\d*)$/,@curr)) {
7038: $can_request->{$type} = 1;
7039: }
7040: }
7041: }
7042: }
7043: }
7044: }
7045: return $canreq;
7046: }
7047:
7048: # ---------------------------------------------- Custom access rule evaluation
7049:
7050: sub customaccess {
7051: my ($priv,$uri)=@_;
7052: my ($urole,$urealm)=split(/\./,$env{'request.role'},2);
7053: my (undef,$udom,$ucrs,$usec)=split(/\//,$urealm);
7054: $udom = &LONCAPA::clean_domain($udom);
7055: $ucrs = &LONCAPA::clean_username($ucrs);
7056: my $access=0;
7057: foreach my $right (split(/\s*\,\s*/,&metadata($uri,'rule_rights'))) {
7058: my ($effect,$realm,$role,$type)=split(/\:/,$right);
7059: if ($type eq 'user') {
7060: foreach my $scope (split(/\s*\,\s*/,$realm)) {
7061: my ($tdom,$tuname)=split(m{/},$scope);
7062: if ($tdom) {
7063: if ($tdom ne $env{'user.domain'}) { next; }
7064: }
7065: if ($tuname) {
7066: if ($tuname ne $env{'user.name'}) { next; }
7067: }
7068: $access=($effect eq 'allow');
7069: last;
7070: }
7071: } else {
7072: if ($role) {
7073: if ($role ne $urole) { next; }
7074: }
7075: foreach my $scope (split(/\s*\,\s*/,$realm)) {
7076: my ($tdom,$tcrs,$tsec)=split(/\_/,$scope);
7077: if ($tdom) {
7078: if ($tdom ne $udom) { next; }
7079: }
7080: if ($tcrs) {
7081: if ($tcrs ne $ucrs) { next; }
7082: }
7083: if ($tsec) {
7084: if ($tsec ne $usec) { next; }
7085: }
7086: $access=($effect eq 'allow');
7087: last;
7088: }
7089: if ($realm eq '' && $role eq '') {
7090: $access=($effect eq 'allow');
7091: }
7092: }
7093: }
7094: return $access;
7095: }
7096:
7097: # ------------------------------------------------- Check for a user privilege
7098:
7099: sub allowed {
7100: my ($priv,$uri,$symb,$role,$clientip,$noblockcheck)=@_;
7101: my $ver_orguri=$uri;
7102: $uri=&deversion($uri);
7103: my $orguri=$uri;
7104: $uri=&declutter($uri);
7105:
7106: if ($priv eq 'evb') {
7107: # Evade communication block restrictions for specified role in a course
7108: if ($env{'user.priv.'.$role} =~/evb\&([^\:]*)/) {
7109: return $1;
7110: } else {
7111: return;
7112: }
7113: }
7114:
7115: if (defined($env{'allowed.'.$priv})) { return $env{'allowed.'.$priv}; }
7116: # Free bre access to adm and meta resources
7117: if (((($uri=~/^adm\//) && ($uri !~ m{/(?:smppg|bulletinboard)$}))
7118: || (($uri=~/\.meta$/) && ($uri!~m|^uploaded/|) ))
7119: && ($priv eq 'bre')) {
7120: return 'F';
7121: }
7122:
7123: # Free bre access to user's own portfolio contents
7124: my ($space,$domain,$name,@dir)=split('/',$uri);
7125: if (($space=~/^(uploaded|editupload)$/) && ($env{'user.name'} eq $name) &&
7126: ($env{'user.domain'} eq $domain) && ('portfolio' eq $dir[0])) {
7127: my %setters;
7128: my ($startblock,$endblock) =
7129: &Apache::loncommon::blockcheck(\%setters,'port');
7130: if ($startblock && $endblock) {
7131: return 'B';
7132: } else {
7133: return 'F';
7134: }
7135: }
7136:
7137: # bre access to group portfolio for rgf priv in group, or mdg or vcg in course.
7138: if (($space=~/^(uploaded|editupload)$/) && ($dir[0] eq 'groups')
7139: && ($dir[2] eq 'portfolio') && ($priv eq 'bre')) {
7140: if (exists($env{'request.course.id'})) {
7141: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
7142: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
7143: if (($domain eq $cdom) && ($name eq $cnum)) {
7144: my $courseprivid=$env{'request.course.id'};
7145: $courseprivid=~s/\_/\//;
7146: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid
7147: .'/'.$dir[1]} =~/rgf\&([^\:]*)/) {
7148: return $1;
7149: } else {
7150: if ($env{'request.course.sec'}) {
7151: $courseprivid.='/'.$env{'request.course.sec'};
7152: }
7153: if ($env{'user.priv.'.$env{'request.role'}.'./'.
7154: $courseprivid} =~/(mdg|vcg)\&([^\:]*)/) {
7155: return $2;
7156: }
7157: }
7158: }
7159: }
7160: }
7161:
7162: # Free bre to public access
7163:
7164: if ($priv eq 'bre') {
7165: my $copyright=&metadata($uri,'copyright');
7166: if (($copyright eq 'public') && (!$env{'request.course.id'})) {
7167: return 'F';
7168: }
7169: if ($copyright eq 'priv') {
7170: $uri=~/([^\/]+)\/([^\/]+)\//;
7171: unless (($env{'user.name'} eq $2) && ($env{'user.domain'} eq $1)) {
7172: return '';
7173: }
7174: }
7175: if ($copyright eq 'domain') {
7176: $uri=~/([^\/]+)\/([^\/]+)\//;
7177: unless (($env{'user.domain'} eq $1) ||
7178: ($env{'course.'.$env{'request.course.id'}.'.domain'} eq $1)) {
7179: return '';
7180: }
7181: }
7182: if ($env{'request.role'}=~ /li\.\//) {
7183: # Library role, so allow browsing of resources in this domain.
7184: return 'F';
7185: }
7186: if ($copyright eq 'custom') {
7187: unless (&customaccess($priv,$uri)) { return ''; }
7188: }
7189: }
7190: # Domain coordinator is trying to create a course
7191: if (($priv eq 'ccc') && ($env{'request.role'} =~ /^dc\./)) {
7192: # uri is the requested domain in this case.
7193: # comparison to 'request.role.domain' shows if the user has selected
7194: # a role of dc for the domain in question.
7195: return 'F' if ($uri eq $env{'request.role.domain'});
7196: }
7197:
7198: my $thisallowed='';
7199: my $statecond=0;
7200: my $courseprivid='';
7201:
7202: my $ownaccess;
7203: # Community Coordinator or Assistant Co-author browsing resource space.
7204: if (($priv eq 'bro') && ($env{'user.author'})) {
7205: if ($uri eq '') {
7206: $ownaccess = 1;
7207: } else {
7208: if (($env{'user.domain'} ne '') && ($env{'user.name'} ne '')) {
7209: my $udom = $env{'user.domain'};
7210: my $uname = $env{'user.name'};
7211: if ($uri =~ m{^\Q$udom\E/?$}) {
7212: $ownaccess = 1;
7213: } elsif ($uri =~ m{^\Q$udom\E/\Q$uname\E/?}) {
7214: unless ($uri =~ m{\.\./}) {
7215: $ownaccess = 1;
7216: }
7217: } elsif (($udom ne 'public') && ($uname ne 'public')) {
7218: my $now = time;
7219: if ($uri =~ m{^([^/]+)/?$}) {
7220: my $adom = $1;
7221: foreach my $key (keys(%env)) {
7222: if ($key =~ m{^user\.role\.(ca|aa)/\Q$adom\E}) {
7223: my ($start,$end) = split('.',$env{$key});
7224: if (($now >= $start) && (!$end || $end < $now)) {
7225: $ownaccess = 1;
7226: last;
7227: }
7228: }
7229: }
7230: } elsif ($uri =~ m{^([^/]+)/([^/]+)/?}) {
7231: my $adom = $1;
7232: my $aname = $2;
7233: foreach my $role ('ca','aa') {
7234: if ($env{"user.role.$role./$adom/$aname"}) {
7235: my ($start,$end) =
7236: split('.',$env{"user.role.$role./$adom/$aname"});
7237: if (($now >= $start) && (!$end || $end < $now)) {
7238: $ownaccess = 1;
7239: last;
7240: }
7241: }
7242: }
7243: }
7244: }
7245: }
7246: }
7247: }
7248:
7249: # Course
7250:
7251: if ($env{'user.priv.'.$env{'request.role'}.'./'}=~/\Q$priv\E\&([^\:]*)/) {
7252: unless (($priv eq 'bro') && (!$ownaccess)) {
7253: $thisallowed.=$1;
7254: }
7255: }
7256:
7257: # Domain
7258:
7259: if ($env{'user.priv.'.$env{'request.role'}.'./'.(split(/\//,$uri))[0].'/'}
7260: =~/\Q$priv\E\&([^\:]*)/) {
7261: unless (($priv eq 'bro') && (!$ownaccess)) {
7262: $thisallowed.=$1;
7263: }
7264: }
7265:
7266: # User who is not author or co-author might still be able to edit
7267: # resource of an author in the domain (e.g., if Domain Coordinator).
7268: if (($priv eq 'eco') && ($thisallowed eq '') && ($env{'request.course.id'}) &&
7269: (&allowed('mdc',$env{'request.course.id'}))) {
7270: if ($env{"user.priv.cm./$uri/"}=~/\Q$priv\E\&([^\:]*)/) {
7271: $thisallowed.=$1;
7272: }
7273: }
7274:
7275: # Course: uri itself is a course
7276: my $courseuri=$uri;
7277: $courseuri=~s/\_(\d)/\/$1/;
7278: $courseuri=~s/^([^\/])/\/$1/;
7279:
7280: if ($env{'user.priv.'.$env{'request.role'}.'.'.$courseuri}
7281: =~/\Q$priv\E\&([^\:]*)/) {
7282: unless (($priv eq 'bro') && (!$ownaccess)) {
7283: $thisallowed.=$1;
7284: }
7285: }
7286:
7287: # URI is an uploaded document for this course, default permissions don't matter
7288: # not allowing 'edit' access (editupload) to uploaded course docs
7289: if (($priv eq 'bre') && ($uri=~m|^uploaded/|)) {
7290: $thisallowed='';
7291: my ($match)=&is_on_map($uri);
7292: if ($match) {
7293: if ($env{'user.priv.'.$env{'request.role'}.'./'}
7294: =~/\Q$priv\E\&([^\:]*)/) {
7295: my $value = $1;
7296: if ($noblockcheck) {
7297: $thisallowed.=$value;
7298: } else {
7299: my @blockers = &has_comm_blocking($priv,$symb,$uri);
7300: if (@blockers > 0) {
7301: $thisallowed = 'B';
7302: } else {
7303: $thisallowed.=$value;
7304: }
7305: }
7306: }
7307: } else {
7308: my $refuri = $env{'httpref.'.$orguri} || $env{'httpref.'.$ver_orguri};
7309: if ($refuri) {
7310: if ($refuri =~ m|^/adm/|) {
7311: $thisallowed='F';
7312: } else {
7313: $refuri=&declutter($refuri);
7314: my ($match) = &is_on_map($refuri);
7315: if ($match) {
7316: if ($noblockcheck) {
7317: $thisallowed='F';
7318: } else {
7319: my @blockers = &has_comm_blocking($priv,$symb,$refuri);
7320: if (@blockers > 0) {
7321: $thisallowed = 'B';
7322: } else {
7323: $thisallowed='F';
7324: }
7325: }
7326: }
7327: }
7328: }
7329: }
7330: }
7331:
7332: if ($priv eq 'bre'
7333: && $thisallowed ne 'F'
7334: && $thisallowed ne '2'
7335: && &is_portfolio_url($uri)) {
7336: $thisallowed = &portfolio_access($uri,$clientip);
7337: }
7338:
7339: # Full access at system, domain or course-wide level? Exit.
7340: if ($thisallowed=~/F/) {
7341: return 'F';
7342: }
7343:
7344: # If this is generating or modifying users, exit with special codes
7345:
7346: if (':csu:cdc:ccc:cin:cta:cep:ccr:cst:cad:cli:cau:cdg:cca:caa:'=~/\:\Q$priv\E\:/) {
7347: if (($priv eq 'cca') || ($priv eq 'caa')) {
7348: my ($audom,$auname)=split('/',$uri);
7349: # no author name given, so this just checks on the general right to make a co-author in this domain
7350: unless ($auname) { return $thisallowed; }
7351: # an author name is given, so we are about to actually make a co-author for a certain account
7352: if (($auname ne $env{'user.name'} && $env{'request.role'} !~ /^dc\./) ||
7353: (($audom ne $env{'user.domain'} && $env{'request.role'} !~ /^dc\./) &&
7354: ($audom ne $env{'request.role.domain'}))) { return ''; }
7355: }
7356: return $thisallowed;
7357: }
7358: #
7359: # Gathered so far: system, domain and course wide privileges
7360: #
7361: # Course: See if uri or referer is an individual resource that is part of
7362: # the course
7363:
7364: if ($env{'request.course.id'}) {
7365:
7366: $courseprivid=$env{'request.course.id'};
7367: if ($env{'request.course.sec'}) {
7368: $courseprivid.='/'.$env{'request.course.sec'};
7369: }
7370: $courseprivid=~s/\_/\//;
7371: my $checkreferer=1;
7372: my ($match,$cond)=&is_on_map($uri);
7373: if ($match) {
7374: $statecond=$cond;
7375: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid}
7376: =~/\Q$priv\E\&([^\:]*)/) {
7377: my $value = $1;
7378: if ($priv eq 'bre') {
7379: if ($noblockcheck) {
7380: $thisallowed.=$value;
7381: } else {
7382: my @blockers = &has_comm_blocking($priv,$symb,$uri);
7383: if (@blockers > 0) {
7384: $thisallowed = 'B';
7385: } else {
7386: $thisallowed.=$value;
7387: }
7388: }
7389: } else {
7390: $thisallowed.=$value;
7391: }
7392: $checkreferer=0;
7393: }
7394: }
7395:
7396: if ($checkreferer) {
7397: my $refuri=$env{'httpref.'.$orguri};
7398: unless ($refuri) {
7399: foreach my $key (keys(%env)) {
7400: if ($key=~/^httpref\..*\*/) {
7401: my $pattern=$key;
7402: $pattern=~s/^httpref\.\/res\///;
7403: $pattern=~s/\*/\[\^\/\]\+/g;
7404: $pattern=~s/\//\\\//g;
7405: if ($orguri=~/$pattern/) {
7406: $refuri=$env{$key};
7407: }
7408: }
7409: }
7410: }
7411:
7412: if ($refuri) {
7413: $refuri=&declutter($refuri);
7414: my ($match,$cond)=&is_on_map($refuri);
7415: if ($match) {
7416: my $refstatecond=$cond;
7417: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid}
7418: =~/\Q$priv\E\&([^\:]*)/) {
7419: my $value = $1;
7420: if ($priv eq 'bre') {
7421: if ($noblockcheck) {
7422: $thisallowed.=$value;
7423: } else {
7424: my @blockers = &has_comm_blocking($priv,$symb,$refuri);
7425: if (@blockers > 0) {
7426: $thisallowed = 'B';
7427: } else {
7428: $thisallowed.=$value;
7429: }
7430: }
7431: } else {
7432: $thisallowed.=$value;
7433: }
7434: $uri=$refuri;
7435: $statecond=$refstatecond;
7436: }
7437: }
7438: }
7439: }
7440: }
7441:
7442: #
7443: # Gathered now: all privileges that could apply, and condition number
7444: #
7445: #
7446: # Full or no access?
7447: #
7448:
7449: if ($thisallowed=~/F/) {
7450: return 'F';
7451: }
7452:
7453: unless ($thisallowed) {
7454: return '';
7455: }
7456:
7457: # Restrictions exist, deal with them
7458: #
7459: # C:according to course preferences
7460: # R:according to resource settings
7461: # L:unless locked
7462: # X:according to user session state
7463: #
7464:
7465: # Possibly locked functionality, check all courses
7466: # Locks might take effect only after 10 minutes cache expiration for other
7467: # courses, and 2 minutes for current course
7468:
7469: my $envkey;
7470: if ($thisallowed=~/L/) {
7471: foreach $envkey (keys(%env)) {
7472: if ($envkey=~/^user\.role\.(st|ta)\.([^\.]*)/) {
7473: my $courseid=$2;
7474: my $roleid=$1.'.'.$2;
7475: $courseid=~s/^\///;
7476: my $expiretime=600;
7477: if ($env{'request.role'} eq $roleid) {
7478: $expiretime=120;
7479: }
7480: my ($cdom,$cnum,$csec)=split(/\//,$courseid);
7481: my $prefix='course.'.$cdom.'_'.$cnum.'.';
7482: if ((time-$env{$prefix.'last_cache'})>$expiretime) {
7483: &coursedescription($courseid,{'freshen_cache' => 1});
7484: }
7485: if (($env{$prefix.'res.'.$uri.'.lock.sections'}=~/\,\Q$csec\E\,/)
7486: || ($env{$prefix.'res.'.$uri.'.lock.sections'} eq 'all')) {
7487: if ($env{$prefix.'res.'.$uri.'.lock.expire'}>time) {
7488: &log($env{'user.domain'},$env{'user.name'},
7489: $env{'user.home'},
7490: 'Locked by res: '.$priv.' for '.$uri.' due to '.
7491: $cdom.'/'.$cnum.'/'.$csec.' expire '.
7492: $env{$prefix.'priv.'.$priv.'.lock.expire'});
7493: return '';
7494: }
7495: }
7496: if (($env{$prefix.'priv.'.$priv.'.lock.sections'}=~/\,\Q$csec\E\,/)
7497: || ($env{$prefix.'priv.'.$priv.'.lock.sections'} eq 'all')) {
7498: if ($env{'priv.'.$priv.'.lock.expire'}>time) {
7499: &log($env{'user.domain'},$env{'user.name'},
7500: $env{'user.home'},
7501: 'Locked by priv: '.$priv.' for '.$uri.' due to '.
7502: $cdom.'/'.$cnum.'/'.$csec.' expire '.
7503: $env{$prefix.'priv.'.$priv.'.lock.expire'});
7504: return '';
7505: }
7506: }
7507: }
7508: }
7509: }
7510:
7511: #
7512: # Rest of the restrictions depend on selected course
7513: #
7514:
7515: unless ($env{'request.course.id'}) {
7516: if ($thisallowed eq 'A') {
7517: return 'A';
7518: } elsif ($thisallowed eq 'B') {
7519: return 'B';
7520: } else {
7521: return '1';
7522: }
7523: }
7524:
7525: #
7526: # Now user is definitely in a course
7527: #
7528:
7529:
7530: # Course preferences
7531:
7532: if ($thisallowed=~/C/) {
7533: my $rolecode=(split(/\./,$env{'request.role'}))[0];
7534: my $unamedom=$env{'user.name'}.':'.$env{'user.domain'};
7535: if ($env{'course.'.$env{'request.course.id'}.'.'.$priv.'.roles.denied'}
7536: =~/\Q$rolecode\E/) {
7537: if (($priv ne 'pch') && ($priv ne 'plc')) {
7538: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.':'.
7539: 'Denied by role: '.$priv.' for '.$uri.' as '.$rolecode.' in '.
7540: $env{'request.course.id'});
7541: }
7542: return '';
7543: }
7544:
7545: if ($env{'course.'.$env{'request.course.id'}.'.'.$priv.'.users.denied'}
7546: =~/\Q$unamedom\E/) {
7547: if (($priv ne 'pch') && ($priv ne 'plc')) {
7548: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.
7549: 'Denied by user: '.$priv.' for '.$uri.' as '.$unamedom.' in '.
7550: $env{'request.course.id'});
7551: }
7552: return '';
7553: }
7554: }
7555:
7556: # Resource preferences
7557:
7558: if ($thisallowed=~/R/) {
7559: my $rolecode=(split(/\./,$env{'request.role'}))[0];
7560: if (&metadata($uri,'roledeny')=~/\Q$rolecode\E/) {
7561: if (($priv ne 'pch') && ($priv ne 'plc')) {
7562: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.':'.
7563: 'Denied by role: '.$priv.' for '.$uri.' as '.$rolecode);
7564: }
7565: return '';
7566: }
7567: }
7568:
7569: # Restricted by state or randomout?
7570:
7571: if ($thisallowed=~/X/) {
7572: if ($env{'acc.randomout'}) {
7573: if (!$symb) { $symb=&symbread($uri,1); }
7574: if (($symb) && ($env{'acc.randomout'}=~/\&\Q$symb\E\&/)) {
7575: return '';
7576: }
7577: }
7578: if (&condval($statecond)) {
7579: return '2';
7580: } else {
7581: return '';
7582: }
7583: }
7584:
7585: if ($thisallowed eq 'A') {
7586: return 'A';
7587: } elsif ($thisallowed eq 'B') {
7588: return 'B';
7589: }
7590: return 'F';
7591: }
7592:
7593: # ------------------------------------------- Check construction space access
7594:
7595: sub constructaccess {
7596: my ($url,$setpriv)=@_;
7597:
7598: # We do not allow editing of previous versions of files
7599: if ($url=~/\.(\d+)\.(\w+)$/) { return ''; }
7600:
7601: # Get username and domain from URL
7602: my ($ownername,$ownerdomain,$ownerhome);
7603:
7604: ($ownerdomain,$ownername) =
7605: ($url=~ m{^(?:\Q$perlvar{'lonDocRoot'}\E|)/priv/($match_domain)/($match_username)(?:/|$)});
7606:
7607: # The URL does not really point to any authorspace, forget it
7608: unless (($ownername) && ($ownerdomain)) { return ''; }
7609:
7610: # Now we need to see if the user has access to the authorspace of
7611: # $ownername at $ownerdomain
7612:
7613: if (($ownername eq $env{'user.name'}) && ($ownerdomain eq $env{'user.domain'})) {
7614: # Real author for this?
7615: $ownerhome = $env{'user.home'};
7616: if (exists($env{'user.priv.au./'.$ownerdomain.'/./'})) {
7617: return ($ownername,$ownerdomain,$ownerhome);
7618: }
7619: } else {
7620: # Co-author for this?
7621: if (exists($env{'user.priv.ca./'.$ownerdomain.'/'.$ownername.'./'}) ||
7622: exists($env{'user.priv.aa./'.$ownerdomain.'/'.$ownername.'./'}) ) {
7623: $ownerhome = &homeserver($ownername,$ownerdomain);
7624: return ($ownername,$ownerdomain,$ownerhome);
7625: }
7626: }
7627:
7628: # We don't have any access right now. If we are not possibly going to do anything about this,
7629: # we might as well leave
7630: unless ($setpriv) { return ''; }
7631:
7632: # Backdoor access?
7633: my $allowed=&allowed('eco',$ownerdomain);
7634: # Nope
7635: unless ($allowed) { return ''; }
7636: # Looks like we may have access, but could be locked by the owner of the construction space
7637: if ($allowed eq 'U') {
7638: my %blocked=&get('environment',['domcoord.author'],
7639: $ownerdomain,$ownername);
7640: # Is blocked by owner
7641: if ($blocked{'domcoord.author'} eq 'blocked') { return ''; }
7642: }
7643: if (($allowed eq 'F') || ($allowed eq 'U')) {
7644: # Grant temporary access
7645: my $then=$env{'user.login.time'};
7646: my $update=$env{'user.update.time'};
7647: if (!$update) { $update = $then; }
7648: my $refresh=$env{'user.refresh.time'};
7649: if (!$refresh) { $refresh = $update; }
7650: my $now = time;
7651: &check_adhoc_privs($ownerdomain,$ownername,$update,$refresh,
7652: $now,'ca','constructaccess');
7653: $ownerhome = &homeserver($ownername,$ownerdomain);
7654: return($ownername,$ownerdomain,$ownerhome);
7655: }
7656: # No business here
7657: return '';
7658: }
7659:
7660: # ----------------------------------------------------------- Content Blocking
7661:
7662: {
7663: # Caches for faster Course Contents display where content blocking
7664: # is in operation (i.e., interval param set) for timed quiz.
7665: #
7666: # User for whom data are being temporarily cached.
7667: my $cacheduser='';
7668: # Cached blockers for this user (a hash of blocking items).
7669: my %cachedblockers=();
7670: # When the data were last cached.
7671: my $cachedlast='';
7672:
7673: sub load_all_blockers {
7674: my ($uname,$udom,$blocks)=@_;
7675: if (($uname ne '') && ($udom ne '')) {
7676: if (($cacheduser eq $uname.':'.$udom) &&
7677: (abs($cachedlast-time)<5)) {
7678: return;
7679: }
7680: }
7681: $cachedlast=time;
7682: $cacheduser=$uname.':'.$udom;
7683: %cachedblockers = &get_commblock_resources($blocks);
7684: }
7685:
7686: sub get_comm_blocks {
7687: my ($cdom,$cnum) = @_;
7688: if ($cdom eq '' || $cnum eq '') {
7689: return unless ($env{'request.course.id'});
7690: $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
7691: $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
7692: }
7693: my %commblocks;
7694: my $hashid=$cdom.'_'.$cnum;
7695: my ($blocksref,$cached)=&is_cached_new('comm_block',$hashid);
7696: if ((defined($cached)) && (ref($blocksref) eq 'HASH')) {
7697: %commblocks = %{$blocksref};
7698: } else {
7699: %commblocks = &Apache::lonnet::dump('comm_block',$cdom,$cnum);
7700: my $cachetime = 600;
7701: &do_cache_new('comm_block',$hashid,\%commblocks,$cachetime);
7702: }
7703: return %commblocks;
7704: }
7705:
7706: sub get_commblock_resources {
7707: my ($blocks) = @_;
7708: my %blockers = ();
7709: return %blockers unless ($env{'request.course.id'});
7710: return %blockers if ($env{'user.priv.'.$env{'request.role'}} =~/evb\&([^\:]*)/);
7711: my %commblocks;
7712: if (ref($blocks) eq 'HASH') {
7713: %commblocks = %{$blocks};
7714: } else {
7715: %commblocks = &get_comm_blocks();
7716: }
7717: return %blockers unless (keys(%commblocks) > 0);
7718: my $navmap = Apache::lonnavmaps::navmap->new();
7719: return %blockers unless (ref($navmap));
7720: my $now = time;
7721: foreach my $block (keys(%commblocks)) {
7722: if ($block =~ /^(\d+)____(\d+)$/) {
7723: my ($start,$end) = ($1,$2);
7724: if ($start <= $now && $end >= $now) {
7725: if (ref($commblocks{$block}{'blocks'}) eq 'HASH') {
7726: if (ref($commblocks{$block}{'blocks'}{'docs'}) eq 'HASH') {
7727: if (ref($commblocks{$block}{'blocks'}{'docs'}{'maps'}) eq 'HASH') {
7728: if (keys(%{$commblocks{$block}{'blocks'}{'docs'}{'maps'}})) {
7729: $blockers{$block}{maps} = $commblocks{$block}{'blocks'}{'docs'}{'maps'};
7730: }
7731: }
7732: if (ref($commblocks{$block}{'blocks'}{'docs'}{'resources'}) eq 'HASH') {
7733: if (keys(%{$commblocks{$block}{'blocks'}{'docs'}{'resources'}})) {
7734: $blockers{$block}{'resources'} = $commblocks{$block}{'blocks'}{'docs'}{'resources'};
7735: }
7736: }
7737: }
7738: }
7739: }
7740: } elsif ($block =~ /^firstaccess____(.+)$/) {
7741: my $item = $1;
7742: my @to_test;
7743: if (ref($commblocks{$block}{'blocks'}) eq 'HASH') {
7744: if (ref($commblocks{$block}{'blocks'}{'docs'}) eq 'HASH') {
7745: my @interval;
7746: my $type = 'map';
7747: if ($item eq 'course') {
7748: $type = 'course';
7749: @interval=&EXT("resource.0.interval");
7750: } else {
7751: if ($item =~ /___\d+___/) {
7752: $type = 'resource';
7753: @interval=&EXT("resource.0.interval",$item);
7754: if (ref($navmap)) {
7755: my $res = $navmap->getBySymb($item);
7756: push(@to_test,$res);
7757: }
7758: } else {
7759: my $mapsymb = &symbread($item,1);
7760: if ($mapsymb) {
7761: if (ref($navmap)) {
7762: my $mapres = $navmap->getBySymb($mapsymb);
7763: @to_test = $mapres->retrieveResources($mapres,undef,0,0,0,1);
7764: foreach my $res (@to_test) {
7765: my $symb = $res->symb();
7766: next if ($symb eq $mapsymb);
7767: if ($symb ne '') {
7768: @interval=&EXT("resource.0.interval",$symb);
7769: if ($interval[1] eq 'map') {
7770: last;
7771: }
7772: }
7773: }
7774: }
7775: }
7776: }
7777: }
7778: if ($interval[0] =~ /^\d+$/) {
7779: my $first_access;
7780: if ($type eq 'resource') {
7781: $first_access=&get_first_access($interval[1],$item);
7782: } elsif ($type eq 'map') {
7783: $first_access=&get_first_access($interval[1],undef,$item);
7784: } else {
7785: $first_access=&get_first_access($interval[1]);
7786: }
7787: if ($first_access) {
7788: my $timesup = $first_access+$interval[0];
7789: if ($timesup > $now) {
7790: my $activeblock;
7791: foreach my $res (@to_test) {
7792: if ($res->answerable()) {
7793: $activeblock = 1;
7794: last;
7795: }
7796: }
7797: if ($activeblock) {
7798: if (ref($commblocks{$block}{'blocks'}{'docs'}{'maps'}) eq 'HASH') {
7799: if (keys(%{$commblocks{$block}{'blocks'}{'docs'}{'maps'}})) {
7800: $blockers{$block}{'maps'} = $commblocks{$block}{'blocks'}{'docs'}{'maps'};
7801: }
7802: }
7803: if (ref($commblocks{$block}{'blocks'}{'docs'}{'resources'}) eq 'HASH') {
7804: if (keys(%{$commblocks{$block}{'blocks'}{'docs'}{'resources'}})) {
7805: $blockers{$block}{'resources'} = $commblocks{$block}{'blocks'}{'docs'}{'resources'};
7806: }
7807: }
7808: }
7809: }
7810: }
7811: }
7812: }
7813: }
7814: }
7815: }
7816: return %blockers;
7817: }
7818:
7819: sub has_comm_blocking {
7820: my ($priv,$symb,$uri,$blocks) = @_;
7821: my @blockers;
7822: return unless ($env{'request.course.id'});
7823: return unless ($priv eq 'bre');
7824: return if ($env{'user.priv.'.$env{'request.role'}} =~/evb\&([^\:]*)/);
7825: return if ($env{'request.state'} eq 'construct');
7826: &load_all_blockers($env{'user.name'},$env{'user.domain'},$blocks);
7827: return unless (keys(%cachedblockers) > 0);
7828: my (%possibles,@symbs);
7829: if (!$symb) {
7830: $symb = &symbread($uri,1,1,1,\%possibles);
7831: }
7832: if ($symb) {
7833: @symbs = ($symb);
7834: } elsif (keys(%possibles)) {
7835: @symbs = keys(%possibles);
7836: }
7837: my $noblock;
7838: foreach my $symb (@symbs) {
7839: last if ($noblock);
7840: my ($map,$resid,$resurl)=&decode_symb($symb);
7841: foreach my $block (keys(%cachedblockers)) {
7842: if ($block =~ /^firstaccess____(.+)$/) {
7843: my $item = $1;
7844: if (($item eq $map) || ($item eq $symb)) {
7845: $noblock = 1;
7846: last;
7847: }
7848: }
7849: if (ref($cachedblockers{$block}) eq 'HASH') {
7850: if (ref($cachedblockers{$block}{'resources'}) eq 'HASH') {
7851: if ($cachedblockers{$block}{'resources'}{$symb}) {
7852: unless (grep(/^\Q$block\E$/,@blockers)) {
7853: push(@blockers,$block);
7854: }
7855: }
7856: }
7857: }
7858: if (ref($cachedblockers{$block}{'maps'}) eq 'HASH') {
7859: if ($cachedblockers{$block}{'maps'}{$map}) {
7860: unless (grep(/^\Q$block\E$/,@blockers)) {
7861: push(@blockers,$block);
7862: }
7863: }
7864: }
7865: }
7866: }
7867: return if ($noblock);
7868: return @blockers;
7869: }
7870: }
7871:
7872: # -------------------------------- Deversion and split uri into path an filename
7873:
7874: #
7875: # Removes the version from a URI and
7876: # splits it in to its filename and path to the filename.
7877: # Seems like File::Basename could have done this more clearly.
7878: # Parameters:
7879: # $uri - input URI
7880: # Returns:
7881: # Two element list consisting of
7882: # $pathname - the URI up to and excluding the trailing /
7883: # $filename - The part of the URI following the last /
7884: # NOTE:
7885: # Another realization of this is simply:
7886: # use File::Basename;
7887: # ...
7888: # $uri = shift;
7889: # $filename = basename($uri);
7890: # $path = dirname($uri);
7891: # return ($filename, $path);
7892: #
7893: # The implementation below is probably faster however.
7894: #
7895: sub split_uri_for_cond {
7896: my $uri=&deversion(&declutter(shift));
7897: my @uriparts=split(/\//,$uri);
7898: my $filename=pop(@uriparts);
7899: my $pathname=join('/',@uriparts);
7900: return ($pathname,$filename);
7901: }
7902: # --------------------------------------------------- Is a resource on the map?
7903:
7904: sub is_on_map {
7905: my ($pathname,$filename) = &split_uri_for_cond(shift);
7906: #Trying to find the conditional for the file
7907: my $match=($env{'acc.res.'.$env{'request.course.id'}.'.'.$pathname}=~
7908: /\&\Q$filename\E\:([\d\|]+)\&/);
7909: if ($match) {
7910: return (1,$1);
7911: } else {
7912: return (0,0);
7913: }
7914: }
7915:
7916: # --------------------------------------------------------- Get symb from alias
7917:
7918: sub get_symb_from_alias {
7919: my $symb=shift;
7920: my ($map,$resid,$url)=&decode_symb($symb);
7921: # Already is a symb
7922: if ($url) { return $symb; }
7923: # Must be an alias
7924: my $aliassymb='';
7925: my %bighash;
7926: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
7927: &GDBM_READER(),0640)) {
7928: my $rid=$bighash{'mapalias_'.$symb};
7929: if ($rid) {
7930: my ($mapid,$resid)=split(/\./,$rid);
7931: $aliassymb=&encode_symb($bighash{'map_id_'.$mapid},
7932: $resid,$bighash{'src_'.$rid});
7933: }
7934: untie %bighash;
7935: }
7936: return $aliassymb;
7937: }
7938:
7939: # ----------------------------------------------------------------- Define Role
7940:
7941: sub definerole {
7942: if (allowed('mcr','/')) {
7943: my ($rolename,$sysrole,$domrole,$courole,$uname,$udom)=@_;
7944: foreach my $role (split(':',$sysrole)) {
7945: my ($crole,$cqual)=split(/\&/,$role);
7946: if ($pr{'cr:s'}!~/\Q$crole\E/) { return "refused:s:$crole"; }
7947: if ($pr{'cr:s'}=~/\Q$crole\E\&/) {
7948: if ($pr{'cr:s'}!~/\Q$crole\E\&\w*\Q$cqual\E/) {
7949: return "refused:s:$crole&$cqual";
7950: }
7951: }
7952: }
7953: foreach my $role (split(':',$domrole)) {
7954: my ($crole,$cqual)=split(/\&/,$role);
7955: if ($pr{'cr:d'}!~/\Q$crole\E/) { return "refused:d:$crole"; }
7956: if ($pr{'cr:d'}=~/\Q$crole\E\&/) {
7957: if ($pr{'cr:d'}!~/\Q$crole\W\&\w*\Q$cqual\E/) {
7958: return "refused:d:$crole&$cqual";
7959: }
7960: }
7961: }
7962: foreach my $role (split(':',$courole)) {
7963: my ($crole,$cqual)=split(/\&/,$role);
7964: if ($pr{'cr:c'}!~/\Q$crole\E/) { return "refused:c:$crole"; }
7965: if ($pr{'cr:c'}=~/\Q$crole\E\&/) {
7966: if ($pr{'cr:c'}!~/\Q$crole\E\&\w*\Q$cqual\E/) {
7967: return "refused:c:$crole&$cqual";
7968: }
7969: }
7970: }
7971: my $uhome;
7972: if (($uname ne '') && ($udom ne '')) {
7973: $uhome = &homeserver($uname,$udom);
7974: return $uhome if ($uhome eq 'no_host');
7975: } else {
7976: $uname = $env{'user.name'};
7977: $udom = $env{'user.domain'};
7978: $uhome = $env{'user.home'};
7979: }
7980: my $command="encrypt:rolesput:$env{'user.domain'}:$env{'user.name'}:".
7981: "$udom:$uname:rolesdef_$rolename=".
7982: escape($sysrole.'_'.$domrole.'_'.$courole);
7983: return reply($command,$uhome);
7984: } else {
7985: return 'refused';
7986: }
7987: }
7988:
7989: # ---------------- Make a metadata query against the network of library servers
7990:
7991: sub metadata_query {
7992: my ($query,$custom,$customshow,$server_array,$domains_hash)=@_;
7993: my %rhash;
7994: my %libserv = &all_library();
7995: my @server_list = (defined($server_array) ? @$server_array
7996: : keys(%libserv) );
7997: for my $server (@server_list) {
7998: my $domains = '';
7999: if (ref($domains_hash) eq 'HASH') {
8000: $domains = $domains_hash->{$server};
8001: }
8002: unless ($custom or $customshow) {
8003: my $reply=&reply("querysend:".&escape($query).':::'.&escape($domains),$server);
8004: $rhash{$server}=$reply;
8005: }
8006: else {
8007: my $reply=&reply("querysend:".&escape($query).':'.
8008: &escape($custom).':'.&escape($customshow).':'.&escape($domains),
8009: $server);
8010: $rhash{$server}=$reply;
8011: }
8012: }
8013: return \%rhash;
8014: }
8015:
8016: # ----------------------------------------- Send log queries and wait for reply
8017:
8018: sub log_query {
8019: my ($uname,$udom,$query,%filters)=@_;
8020: my $uhome=&homeserver($uname,$udom);
8021: if ($uhome eq 'no_host') { return 'error: no_host'; }
8022: my $uhost=&hostname($uhome);
8023: my $command=&escape(join(':',map{$_.'='.$filters{$_}} keys(%filters)));
8024: my $queryid=&reply("querysend:".$query.':'.$udom.':'.$uname.':'.$command,
8025: $uhome);
8026: unless ($queryid=~/^\Q$uhost\E\_/) { return 'error: '.$queryid; }
8027: return get_query_reply($queryid);
8028: }
8029:
8030: # -------------------------- Update MySQL table for portfolio file
8031:
8032: sub update_portfolio_table {
8033: my ($uname,$udom,$file_name,$query,$group,$action) = @_;
8034: if ($group ne '') {
8035: $file_name =~s /^\Q$group\E//;
8036: }
8037: my $homeserver = &homeserver($uname,$udom);
8038: my $queryid=
8039: &reply("querysend:".$query.':'.&escape($uname.':'.$udom.':'.$group).
8040: ':'.&escape($file_name).':'.$action,$homeserver);
8041: my $reply = &get_query_reply($queryid);
8042: return $reply;
8043: }
8044:
8045: # -------------------------- Update MySQL allusers table
8046:
8047: sub update_allusers_table {
8048: my ($uname,$udom,$names) = @_;
8049: my $homeserver = &homeserver($uname,$udom);
8050: my $queryid=
8051: &reply('querysend:allusers:'.&escape($uname).':'.&escape($udom).':'.
8052: 'lastname='.&escape($names->{'lastname'}).'%%'.
8053: 'firstname='.&escape($names->{'firstname'}).'%%'.
8054: 'middlename='.&escape($names->{'middlename'}).'%%'.
8055: 'generation='.&escape($names->{'generation'}).'%%'.
8056: 'permanentemail='.&escape($names->{'permanentemail'}).'%%'.
8057: 'id='.&escape($names->{'id'}),$homeserver);
8058: return;
8059: }
8060:
8061: # ------- Request retrieval of institutional classlists for course(s)
8062:
8063: sub fetch_enrollment_query {
8064: my ($context,$affiliatesref,$replyref,$dom,$cnum) = @_;
8065: my ($homeserver,$sleep,$loopmax);
8066: my $maxtries = 1;
8067: if ($context eq 'automated') {
8068: $homeserver = $perlvar{'lonHostID'};
8069: $sleep = 2;
8070: $loopmax = 100;
8071: $maxtries = 10; # will wait for up to 2000s for retrieval of classlist data before timeout
8072: } else {
8073: $homeserver = &homeserver($cnum,$dom);
8074: }
8075: my $host=&hostname($homeserver);
8076: my $cmd = '';
8077: foreach my $affiliate (keys(%{$affiliatesref})) {
8078: $cmd .= $affiliate.'='.join(",",@{$$affiliatesref{$affiliate}}).'%%';
8079: }
8080: $cmd =~ s/%%$//;
8081: $cmd = &escape($cmd);
8082: my $query = 'fetchenrollment';
8083: my $queryid=&reply("querysend:".$query.':'.$dom.':'.$env{'user.name'}.':'.$cmd,$homeserver);
8084: unless ($queryid=~/^\Q$host\E\_/) {
8085: &logthis('fetch_enrollment_query: invalid queryid: '.$queryid.' for host: '.$host.' and homeserver: '.$homeserver.' context: '.$context.' '.$cnum);
8086: return 'error: '.$queryid;
8087: }
8088: my $reply = &get_query_reply($queryid,$sleep,$loopmax);
8089: my $tries = 1;
8090: while (($reply=~/^timeout/) && ($tries < $maxtries)) {
8091: $reply = &get_query_reply($queryid,$sleep,$loopmax);
8092: $tries ++;
8093: }
8094: if ( ($reply =~/^timeout/) || ($reply =~/^error/) ) {
8095: &logthis('fetch_enrollment_query error: '.$reply.' for '.$dom.' '.$env{'user.name'}.' for '.$queryid.' context: '.$context.' '.$cnum.' maxtries: '.$maxtries.' tries: '.$tries);
8096: } else {
8097: my @responses = split(/:/,$reply);
8098: if (grep { $_ eq $homeserver } ¤t_machine_ids()) {
8099: foreach my $line (@responses) {
8100: my ($key,$value) = split(/=/,$line,2);
8101: $$replyref{$key} = $value;
8102: }
8103: } else {
8104: my $pathname = LONCAPA::tempdir();
8105: foreach my $line (@responses) {
8106: my ($key,$value) = split(/=/,$line);
8107: $$replyref{$key} = $value;
8108: if ($value > 0) {
8109: foreach my $item (@{$$affiliatesref{$key}}) {
8110: my $filename = $dom.'_'.$key.'_'.$item.'_classlist.xml';
8111: my $destname = $pathname.'/'.$filename;
8112: my $xml_classlist = &reply("autoretrieve:".$filename,$homeserver);
8113: if ($xml_classlist =~ /^error/) {
8114: &logthis('fetch_enrollment_query - autoretrieve error: '.$xml_classlist.' for '.$filename.' from server: '.$homeserver.' '.$context.' '.$cnum);
8115: } else {
8116: if ( open(FILE,">$destname") ) {
8117: print FILE &unescape($xml_classlist);
8118: close(FILE);
8119: } else {
8120: &logthis('fetch_enrollment_query - error opening classlist file '.$destname.' '.$context.' '.$cnum);
8121: }
8122: }
8123: }
8124: }
8125: }
8126: }
8127: return 'ok';
8128: }
8129: return 'error';
8130: }
8131:
8132: sub get_query_reply {
8133: my ($queryid,$sleep,$loopmax) = @_;
8134: if (($sleep eq '') || ($sleep !~ /^\d+\.?\d*$/)) {
8135: $sleep = 0.2;
8136: }
8137: if (($loopmax eq '') || ($loopmax =~ /\D/)) {
8138: $loopmax = 100;
8139: }
8140: my $replyfile=LONCAPA::tempdir().$queryid;
8141: my $reply='';
8142: for (1..$loopmax) {
8143: sleep($sleep);
8144: if (-e $replyfile.'.end') {
8145: if (open(my $fh,$replyfile)) {
8146: $reply = join('',<$fh>);
8147: close($fh);
8148: } else { return 'error: reply_file_error'; }
8149: return &unescape($reply);
8150: }
8151: }
8152: return 'timeout:'.$queryid;
8153: }
8154:
8155: sub courselog_query {
8156: #
8157: # possible filters:
8158: # url: url or symb
8159: # username
8160: # domain
8161: # action: view, submit, grade
8162: # start: timestamp
8163: # end: timestamp
8164: #
8165: my (%filters)=@_;
8166: unless ($env{'request.course.id'}) { return 'no_course'; }
8167: if ($filters{'url'}) {
8168: $filters{'url'}=&symbclean(&declutter($filters{'url'}));
8169: $filters{'url'}=~s/\.(\w+)$/(\\.\\d+)*\\.$1/;
8170: $filters{'url'}=~s/\.(\w+)\_\_\_/(\\.\\d+)*\\.$1/;
8171: }
8172: my $cname=$env{'course.'.$env{'request.course.id'}.'.num'};
8173: my $cdom=$env{'course.'.$env{'request.course.id'}.'.domain'};
8174: return &log_query($cname,$cdom,'courselog',%filters);
8175: }
8176:
8177: sub userlog_query {
8178: #
8179: # possible filters:
8180: # action: log check role
8181: # start: timestamp
8182: # end: timestamp
8183: #
8184: my ($uname,$udom,%filters)=@_;
8185: return &log_query($uname,$udom,'userlog',%filters);
8186: }
8187:
8188: #--------- Call auto-enrollment subs in localenroll.pm for homeserver for course
8189:
8190: sub auto_run {
8191: my ($cnum,$cdom) = @_;
8192: my $response = 0;
8193: my $settings;
8194: my %domconfig = &get_dom('configuration',['autoenroll'],$cdom);
8195: if (ref($domconfig{'autoenroll'}) eq 'HASH') {
8196: $settings = $domconfig{'autoenroll'};
8197: if ($settings->{'run'} eq '1') {
8198: $response = 1;
8199: }
8200: } else {
8201: my $homeserver;
8202: if (&is_course($cdom,$cnum)) {
8203: $homeserver = &homeserver($cnum,$cdom);
8204: } else {
8205: $homeserver = &domain($cdom,'primary');
8206: }
8207: if ($homeserver ne 'no_host') {
8208: $response = &reply('autorun:'.$cdom,$homeserver);
8209: }
8210: }
8211: return $response;
8212: }
8213:
8214: sub auto_get_sections {
8215: my ($cnum,$cdom,$inst_coursecode) = @_;
8216: my $homeserver;
8217: if (($cdom =~ /^$match_domain$/) && ($cnum =~ /^$match_courseid$/)) {
8218: $homeserver = &homeserver($cnum,$cdom);
8219: }
8220: if (!defined($homeserver)) {
8221: if ($cdom =~ /^$match_domain$/) {
8222: $homeserver = &domain($cdom,'primary');
8223: }
8224: }
8225: my @secs;
8226: if (defined($homeserver)) {
8227: my $response=&unescape(&reply('autogetsections:'.$inst_coursecode.':'.$cdom,$homeserver));
8228: unless ($response eq 'refused') {
8229: @secs = split(/:/,$response);
8230: }
8231: }
8232: return @secs;
8233: }
8234:
8235: sub auto_new_course {
8236: my ($cnum,$cdom,$inst_course_id,$owner,$coowners) = @_;
8237: my $homeserver = &homeserver($cnum,$cdom);
8238: my $response=&unescape(&reply('autonewcourse:'.$inst_course_id.':'.&escape($owner).':'.$cdom.':'.&escape($coowners),$homeserver));
8239: return $response;
8240: }
8241:
8242: sub auto_validate_courseID {
8243: my ($cnum,$cdom,$inst_course_id) = @_;
8244: my $homeserver = &homeserver($cnum,$cdom);
8245: my $response=&unescape(&reply('autovalidatecourse:'.$inst_course_id.':'.$cdom,$homeserver));
8246: return $response;
8247: }
8248:
8249: sub auto_validate_instcode {
8250: my ($cnum,$cdom,$instcode,$owner) = @_;
8251: my ($homeserver,$response);
8252: if (($cdom =~ /^$match_domain$/) && ($cnum =~ /^$match_courseid$/)) {
8253: $homeserver = &homeserver($cnum,$cdom);
8254: }
8255: if (!defined($homeserver)) {
8256: if ($cdom =~ /^$match_domain$/) {
8257: $homeserver = &domain($cdom,'primary');
8258: }
8259: }
8260: $response=&unescape(&reply('autovalidateinstcode:'.$cdom.':'.
8261: &escape($instcode).':'.&escape($owner),$homeserver));
8262: my ($outcome,$description,$defaultcredits) = map { &unescape($_); } split('&',$response,3);
8263: return ($outcome,$description,$defaultcredits);
8264: }
8265:
8266: sub auto_create_password {
8267: my ($cnum,$cdom,$authparam,$udom) = @_;
8268: my ($homeserver,$response);
8269: my $create_passwd = 0;
8270: my $authchk = '';
8271: if ($udom =~ /^$match_domain$/) {
8272: $homeserver = &domain($udom,'primary');
8273: }
8274: if ($homeserver eq '') {
8275: if (($cdom =~ /^$match_domain$/) && ($cnum =~ /^$match_courseid$/)) {
8276: $homeserver = &homeserver($cnum,$cdom);
8277: }
8278: }
8279: if ($homeserver eq '') {
8280: $authchk = 'nodomain';
8281: } else {
8282: $response=&unescape(&reply('autocreatepassword:'.$authparam.':'.$cdom,$homeserver));
8283: if ($response eq 'refused') {
8284: $authchk = 'refused';
8285: } else {
8286: ($authparam,$create_passwd,$authchk) = split(/:/,$response);
8287: }
8288: }
8289: return ($authparam,$create_passwd,$authchk);
8290: }
8291:
8292: sub auto_photo_permission {
8293: my ($cnum,$cdom,$students) = @_;
8294: my $homeserver = &homeserver($cnum,$cdom);
8295: my ($outcome,$perm_reqd,$conditions) =
8296: split(/:/,&unescape(&reply('autophotopermission:'.$cdom,$homeserver)),3);
8297: if ($outcome =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
8298: return (undef,undef);
8299: }
8300: return ($outcome,$perm_reqd,$conditions);
8301: }
8302:
8303: sub auto_checkphotos {
8304: my ($uname,$udom,$pid) = @_;
8305: my $homeserver = &homeserver($uname,$udom);
8306: my ($result,$resulttype);
8307: my $outcome = &unescape(&reply('autophotocheck:'.&escape($udom).':'.
8308: &escape($uname).':'.&escape($pid),
8309: $homeserver));
8310: if ($outcome =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
8311: return (undef,undef);
8312: }
8313: if ($outcome) {
8314: ($result,$resulttype) = split(/:/,$outcome);
8315: }
8316: return ($result,$resulttype);
8317: }
8318:
8319: sub auto_photochoice {
8320: my ($cnum,$cdom) = @_;
8321: my $homeserver = &homeserver($cnum,$cdom);
8322: my ($update,$comment) = split(/:/,&unescape(&reply('autophotochoice:'.
8323: &escape($cdom),
8324: $homeserver)));
8325: if ($update =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
8326: return (undef,undef);
8327: }
8328: return ($update,$comment);
8329: }
8330:
8331: sub auto_photoupdate {
8332: my ($affiliatesref,$dom,$cnum,$photo) = @_;
8333: my $homeserver = &homeserver($cnum,$dom);
8334: my $host=&hostname($homeserver);
8335: my $cmd = '';
8336: my $maxtries = 1;
8337: foreach my $affiliate (keys(%{$affiliatesref})) {
8338: $cmd .= $affiliate.'='.join(",",@{$$affiliatesref{$affiliate}}).'%%';
8339: }
8340: $cmd =~ s/%%$//;
8341: $cmd = &escape($cmd);
8342: my $query = 'institutionalphotos';
8343: my $queryid=&reply("querysend:".$query.':'.$dom.':'.$cnum.':'.$cmd,$homeserver);
8344: unless ($queryid=~/^\Q$host\E\_/) {
8345: &logthis('institutionalphotos: invalid queryid: '.$queryid.' for host: '.$host.' and homeserver: '.$homeserver.' and course: '.$cnum);
8346: return 'error: '.$queryid;
8347: }
8348: my $reply = &get_query_reply($queryid);
8349: my $tries = 1;
8350: while (($reply=~/^timeout/) && ($tries < $maxtries)) {
8351: $reply = &get_query_reply($queryid);
8352: $tries ++;
8353: }
8354: if ( ($reply =~/^timeout/) || ($reply =~/^error/) ) {
8355: &logthis('institutionalphotos error: '.$reply.' for '.$dom.' '.$env{'user.name'}.' for '.$queryid.' course: '.$cnum.' maxtries: '.$maxtries.' tries: '.$tries);
8356: } else {
8357: my @responses = split(/:/,$reply);
8358: my $outcome = shift(@responses);
8359: foreach my $item (@responses) {
8360: my ($key,$value) = split(/=/,$item);
8361: $$photo{$key} = $value;
8362: }
8363: return $outcome;
8364: }
8365: return 'error';
8366: }
8367:
8368: sub auto_instcode_format {
8369: my ($caller,$codedom,$instcodes,$codes,$codetitles,$cat_titles,
8370: $cat_order) = @_;
8371: my $courses = '';
8372: my @homeservers;
8373: if ($caller eq 'global') {
8374: my %servers = &get_servers($codedom,'library');
8375: foreach my $tryserver (keys(%servers)) {
8376: if (!grep(/^\Q$tryserver\E$/,@homeservers)) {
8377: push(@homeservers,$tryserver);
8378: }
8379: }
8380: } elsif ($caller eq 'requests') {
8381: if ($codedom =~ /^$match_domain$/) {
8382: my $chome = &domain($codedom,'primary');
8383: unless ($chome eq 'no_host') {
8384: push(@homeservers,$chome);
8385: }
8386: }
8387: } else {
8388: push(@homeservers,&homeserver($caller,$codedom));
8389: }
8390: foreach my $code (keys(%{$instcodes})) {
8391: $courses .= &escape($code).'='.&escape($$instcodes{$code}).'&';
8392: }
8393: chop($courses);
8394: my $ok_response = 0;
8395: my $response;
8396: while (@homeservers > 0 && $ok_response == 0) {
8397: my $server = shift(@homeservers);
8398: $response=&reply('autoinstcodeformat:'.$codedom.':'.$courses,$server);
8399: if ($response !~ /(con_lost|error|no_such_host|refused)/) {
8400: my ($codes_str,$codetitles_str,$cat_titles_str,$cat_order_str) =
8401: split(/:/,$response);
8402: %{$codes} = (%{$codes},&str2hash($codes_str));
8403: push(@{$codetitles},&str2array($codetitles_str));
8404: %{$cat_titles} = (%{$cat_titles},&str2hash($cat_titles_str));
8405: %{$cat_order} = (%{$cat_order},&str2hash($cat_order_str));
8406: $ok_response = 1;
8407: }
8408: }
8409: if ($ok_response) {
8410: return 'ok';
8411: } else {
8412: return $response;
8413: }
8414: }
8415:
8416: sub auto_instcode_defaults {
8417: my ($domain,$returnhash,$code_order) = @_;
8418: my @homeservers;
8419:
8420: my %servers = &get_servers($domain,'library');
8421: foreach my $tryserver (keys(%servers)) {
8422: if (!grep(/^\Q$tryserver\E$/,@homeservers)) {
8423: push(@homeservers,$tryserver);
8424: }
8425: }
8426:
8427: my $response;
8428: foreach my $server (@homeservers) {
8429: $response=&reply('autoinstcodedefaults:'.$domain,$server);
8430: next if ($response =~ /(con_lost|error|no_such_host|refused)/);
8431:
8432: foreach my $pair (split(/\&/,$response)) {
8433: my ($name,$value)=split(/\=/,$pair);
8434: if ($name eq 'code_order') {
8435: @{$code_order} = split(/\&/,&unescape($value));
8436: } else {
8437: $returnhash->{&unescape($name)}=&unescape($value);
8438: }
8439: }
8440: return 'ok';
8441: }
8442:
8443: return $response;
8444: }
8445:
8446: sub auto_possible_instcodes {
8447: my ($domain,$codetitles,$cat_titles,$cat_orders,$code_order) = @_;
8448: unless ((ref($codetitles) eq 'ARRAY') && (ref($cat_titles) eq 'HASH') &&
8449: (ref($cat_orders) eq 'HASH') && (ref($code_order) eq 'ARRAY')) {
8450: return;
8451: }
8452: my (@homeservers,$uhome);
8453: if (defined(&domain($domain,'primary'))) {
8454: $uhome=&domain($domain,'primary');
8455: push(@homeservers,&domain($domain,'primary'));
8456: } else {
8457: my %servers = &get_servers($domain,'library');
8458: foreach my $tryserver (keys(%servers)) {
8459: if (!grep(/^\Q$tryserver\E$/,@homeservers)) {
8460: push(@homeservers,$tryserver);
8461: }
8462: }
8463: }
8464: my $response;
8465: foreach my $server (@homeservers) {
8466: $response=&reply('autopossibleinstcodes:'.$domain,$server);
8467: next if ($response =~ /(con_lost|error|no_such_host|refused)/);
8468: my ($codetitlestr,$codeorderstr,$cat_title,$cat_order) =
8469: split(':',$response);
8470: @{$codetitles} = map { &unescape($_); } (split('&',$codetitlestr));
8471: @{$code_order} = map { &unescape($_); } (split('&',$codeorderstr));
8472: foreach my $item (split('&',$cat_title)) {
8473: my ($name,$value)=split('=',$item);
8474: $cat_titles->{&unescape($name)}=&thaw_unescape($value);
8475: }
8476: foreach my $item (split('&',$cat_order)) {
8477: my ($name,$value)=split('=',$item);
8478: $cat_orders->{&unescape($name)}=&thaw_unescape($value);
8479: }
8480: return 'ok';
8481: }
8482: return $response;
8483: }
8484:
8485: sub auto_courserequest_checks {
8486: my ($dom) = @_;
8487: my ($homeserver,%validations);
8488: if ($dom =~ /^$match_domain$/) {
8489: $homeserver = &domain($dom,'primary');
8490: }
8491: unless ($homeserver eq 'no_host') {
8492: my $response=&reply('autocrsreqchecks:'.$dom,$homeserver);
8493: unless ($response =~ /(con_lost|error|no_such_host|refused)/) {
8494: my @items = split(/&/,$response);
8495: foreach my $item (@items) {
8496: my ($key,$value) = split('=',$item);
8497: $validations{&unescape($key)} = &thaw_unescape($value);
8498: }
8499: }
8500: }
8501: return %validations;
8502: }
8503:
8504: sub auto_courserequest_validation {
8505: my ($dom,$owner,$crstype,$inststatuslist,$instcode,$instseclist,$custominfo) = @_;
8506: my ($homeserver,$response);
8507: if ($dom =~ /^$match_domain$/) {
8508: $homeserver = &domain($dom,'primary');
8509: }
8510: unless ($homeserver eq 'no_host') {
8511: my $customdata;
8512: if (ref($custominfo) eq 'HASH') {
8513: $customdata = &freeze_escape($custominfo);
8514: }
8515: $response=&unescape(&reply('autocrsreqvalidation:'.$dom.':'.&escape($owner).
8516: ':'.&escape($crstype).':'.&escape($inststatuslist).
8517: ':'.&escape($instcode).':'.&escape($instseclist).':'.
8518: $customdata,$homeserver));
8519: }
8520: return $response;
8521: }
8522:
8523: sub auto_validate_class_sec {
8524: my ($cdom,$cnum,$owners,$inst_class) = @_;
8525: my $homeserver = &homeserver($cnum,$cdom);
8526: my $ownerlist;
8527: if (ref($owners) eq 'ARRAY') {
8528: $ownerlist = join(',',@{$owners});
8529: } else {
8530: $ownerlist = $owners;
8531: }
8532: my $response=&reply('autovalidateclass_sec:'.$inst_class.':'.
8533: &escape($ownerlist).':'.$cdom,$homeserver);
8534: return $response;
8535: }
8536:
8537: sub auto_crsreq_update {
8538: my ($cdom,$cnum,$crstype,$action,$ownername,$ownerdomain,$fullname,$title,
8539: $code,$accessstart,$accessend,$inbound) = @_;
8540: my ($homeserver,%crsreqresponse);
8541: if ($cdom =~ /^$match_domain$/) {
8542: $homeserver = &domain($cdom,'primary');
8543: }
8544: unless (($homeserver eq 'no_host') || ($homeserver eq '')) {
8545: my $info;
8546: if (ref($inbound) eq 'HASH') {
8547: $info = &freeze_escape($inbound);
8548: }
8549: my $response=&reply('autocrsrequpdate:'.$cdom.':'.$cnum.':'.&escape($crstype).
8550: ':'.&escape($action).':'.&escape($ownername).':'.
8551: &escape($ownerdomain).':'.&escape($fullname).':'.
8552: &escape($title).':'.&escape($code).':'.
8553: &escape($accessstart).':'.&escape($accessend).':'.$info,$homeserver);
8554: unless ($response =~ /(con_lost|error|no_such_host|refused)/) {
8555: my @items = split(/&/,$response);
8556: foreach my $item (@items) {
8557: my ($key,$value) = split('=',$item);
8558: $crsreqresponse{&unescape($key)} = &thaw_unescape($value);
8559: }
8560: }
8561: }
8562: return \%crsreqresponse;
8563: }
8564:
8565: sub auto_export_grades {
8566: my ($cdom,$cnum,$inforef,$gradesref) = @_;
8567: my ($homeserver,%exportresponse);
8568: if ($cdom =~ /^$match_domain$/) {
8569: $homeserver = &domain($cdom,'primary');
8570: }
8571: unless (($homeserver eq 'no_host') || ($homeserver eq '')) {
8572: my $info;
8573: if (ref($inforef) eq 'HASH') {
8574: $info = &freeze_escape($inforef);
8575: }
8576: if (ref($gradesref) eq 'HASH') {
8577: my $grades = &freeze_escape($gradesref);
8578: my $response=&reply('encrypt:autoexportgrades:'.$cdom.':'.$cnum.':'.
8579: $info.':'.$grades,$homeserver);
8580: unless ($response =~ /(con_lost|error|no_such_host|refused|unknown_command)/) {
8581: my @items = split(/&/,$response);
8582: foreach my $item (@items) {
8583: my ($key,$value) = split('=',$item);
8584: $exportresponse{&unescape($key)} = &thaw_unescape($value);
8585: }
8586: }
8587: }
8588: }
8589: return \%exportresponse;
8590: }
8591:
8592: sub check_instcode_cloning {
8593: my ($codedefaults,$code_order,$cloner,$clonefromcode,$clonetocode) = @_;
8594: unless ((ref($codedefaults) eq 'HASH') && (ref($code_order) eq 'ARRAY')) {
8595: return;
8596: }
8597: my $canclone;
8598: if (@{$code_order} > 0) {
8599: my $instcoderegexp ='^';
8600: my @clonecodes = split(/\&/,$cloner);
8601: foreach my $item (@{$code_order}) {
8602: if (grep(/^\Q$item\E=/,@clonecodes)) {
8603: foreach my $pair (@clonecodes) {
8604: my ($key,$val) = split(/\=/,$pair,2);
8605: $val = &unescape($val);
8606: if ($key eq $item) {
8607: $instcoderegexp .= '('.$val.')';
8608: last;
8609: }
8610: }
8611: } else {
8612: $instcoderegexp .= $codedefaults->{$item};
8613: }
8614: }
8615: $instcoderegexp .= '$';
8616: my (@from,@to);
8617: eval {
8618: (@from) = ($clonefromcode =~ /$instcoderegexp/);
8619: (@to) = ($clonetocode =~ /$instcoderegexp/);
8620: };
8621: if ((@from > 0) && (@to > 0)) {
8622: my @diffs = &Apache::loncommon::compare_arrays(\@from,\@to);
8623: if (!@diffs) {
8624: $canclone = 1;
8625: }
8626: }
8627: }
8628: return $canclone;
8629: }
8630:
8631: sub default_instcode_cloning {
8632: my ($clonedom,$domdefclone,$clonefromcode,$clonetocode,$codedefaultsref,$codeorderref) = @_;
8633: my (%codedefaults,@code_order,$canclone);
8634: if ((ref($codedefaultsref) eq 'HASH') && (ref($codeorderref) eq 'ARRAY')) {
8635: %codedefaults = %{$codedefaultsref};
8636: @code_order = @{$codeorderref};
8637: } elsif ($clonedom) {
8638: &auto_instcode_defaults($clonedom,\%codedefaults,\@code_order);
8639: }
8640: if (($domdefclone) && (@code_order)) {
8641: my @clonecodes = split(/\+/,$domdefclone);
8642: my $instcoderegexp ='^';
8643: foreach my $item (@code_order) {
8644: if (grep(/^\Q$item\E$/,@clonecodes)) {
8645: $instcoderegexp .= '('.$codedefaults{$item}.')';
8646: } else {
8647: $instcoderegexp .= $codedefaults{$item};
8648: }
8649: }
8650: $instcoderegexp .= '$';
8651: my (@from,@to);
8652: eval {
8653: (@from) = ($clonefromcode =~ /$instcoderegexp/);
8654: (@to) = ($clonetocode =~ /$instcoderegexp/);
8655: };
8656: if ((@from > 0) && (@to > 0)) {
8657: my @diffs = &Apache::loncommon::compare_arrays(\@from,\@to);
8658: if (!@diffs) {
8659: $canclone = 1;
8660: }
8661: }
8662: }
8663: return $canclone;
8664: }
8665:
8666: # ------------------------------------------------------- Course Group routines
8667:
8668: sub get_coursegroups {
8669: my ($cdom,$cnum,$group,$namespace) = @_;
8670: return(&dump($namespace,$cdom,$cnum,$group));
8671: }
8672:
8673: sub modify_coursegroup {
8674: my ($cdom,$cnum,$groupsettings) = @_;
8675: return(&put('coursegroups',$groupsettings,$cdom,$cnum));
8676: }
8677:
8678: sub toggle_coursegroup_status {
8679: my ($cdom,$cnum,$group,$action) = @_;
8680: my ($from_namespace,$to_namespace);
8681: if ($action eq 'delete') {
8682: $from_namespace = 'coursegroups';
8683: $to_namespace = 'deleted_groups';
8684: } else {
8685: $from_namespace = 'deleted_groups';
8686: $to_namespace = 'coursegroups';
8687: }
8688: my %curr_group = &get_coursegroups($cdom,$cnum,$group,$from_namespace);
8689: if (my $tmp = &error(%curr_group)) {
8690: &Apache::lonnet::logthis('Error retrieving group: '.$tmp.' in '.$cnum.':'.$cdom);
8691: return ('read error',$tmp);
8692: } else {
8693: my %savedsettings = %curr_group;
8694: my $result = &put($to_namespace,\%savedsettings,$cdom,$cnum);
8695: my $deloutcome;
8696: if ($result eq 'ok') {
8697: $deloutcome = &del($from_namespace,[$group],$cdom,$cnum);
8698: } else {
8699: return ('write error',$result);
8700: }
8701: if ($deloutcome eq 'ok') {
8702: return 'ok';
8703: } else {
8704: return ('delete error',$deloutcome);
8705: }
8706: }
8707: }
8708:
8709: sub modify_group_roles {
8710: my ($cdom,$cnum,$group_id,$user,$end,$start,$userprivs,$selfenroll,$context) = @_;
8711: my $url = '/'.$cdom.'/'.$cnum.'/'.$group_id;
8712: my $role = 'gr/'.&escape($userprivs);
8713: my ($uname,$udom) = split(/:/,$user);
8714: my $result = &assignrole($udom,$uname,$url,$role,$end,$start,'',$selfenroll,$context);
8715: if ($result eq 'ok') {
8716: &devalidate_getgroups_cache($udom,$uname,$cdom,$cnum);
8717: }
8718: return $result;
8719: }
8720:
8721: sub modify_coursegroup_membership {
8722: my ($cdom,$cnum,$membership) = @_;
8723: my $result = &put('groupmembership',$membership,$cdom,$cnum);
8724: return $result;
8725: }
8726:
8727: sub get_active_groups {
8728: my ($udom,$uname,$cdom,$cnum) = @_;
8729: my $now = time;
8730: my %groups = ();
8731: foreach my $key (keys(%env)) {
8732: if ($key =~ m-user\.role\.gr\./($match_domain)/($match_courseid)/(\w+)$-) {
8733: my ($start,$end) = split(/\./,$env{$key});
8734: if (($end!=0) && ($end<$now)) { next; }
8735: if (($start!=0) && ($start>$now)) { next; }
8736: if ($1 eq $cdom && $2 eq $cnum) {
8737: $groups{$3} = $env{$key} ;
8738: }
8739: }
8740: }
8741: return %groups;
8742: }
8743:
8744: sub get_group_membership {
8745: my ($cdom,$cnum,$group) = @_;
8746: return(&dump('groupmembership',$cdom,$cnum,$group));
8747: }
8748:
8749: sub get_users_groups {
8750: my ($udom,$uname,$courseid) = @_;
8751: my @usersgroups;
8752: my $cachetime=1800;
8753:
8754: my $hashid="$udom:$uname:$courseid";
8755: my ($grouplist,$cached)=&is_cached_new('getgroups',$hashid);
8756: if (defined($cached)) {
8757: @usersgroups = split(/:/,$grouplist);
8758: } else {
8759: $grouplist = '';
8760: my $courseurl = &courseid_to_courseurl($courseid);
8761: my %roleshash = &dump('roles',$udom,$uname,$courseurl);
8762: my $access_end = $env{'course.'.$courseid.
8763: '.default_enrollment_end_date'};
8764: my $now = time;
8765: foreach my $key (keys(%roleshash)) {
8766: if ($key =~ /^\Q$courseurl\E\/(\w+)\_gr$/) {
8767: my $group = $1;
8768: if ($roleshash{$key} =~ /_(\d+)_(\d+)$/) {
8769: my $start = $2;
8770: my $end = $1;
8771: if ($start == -1) { next; } # deleted from group
8772: if (($start!=0) && ($start>$now)) { next; }
8773: if (($end!=0) && ($end<$now)) {
8774: if ($access_end && $access_end < $now) {
8775: if ($access_end - $end < 86400) {
8776: push(@usersgroups,$group);
8777: }
8778: }
8779: next;
8780: }
8781: push(@usersgroups,$group);
8782: }
8783: }
8784: }
8785: @usersgroups = &sort_course_groups($courseid,@usersgroups);
8786: $grouplist = join(':',@usersgroups);
8787: &do_cache_new('getgroups',$hashid,$grouplist,$cachetime);
8788: }
8789: return @usersgroups;
8790: }
8791:
8792: sub devalidate_getgroups_cache {
8793: my ($udom,$uname,$cdom,$cnum)=@_;
8794: my $courseid = $cdom.'_'.$cnum;
8795:
8796: my $hashid="$udom:$uname:$courseid";
8797: &devalidate_cache_new('getgroups',$hashid);
8798: }
8799:
8800: # ------------------------------------------------------------------ Plain Text
8801:
8802: sub plaintext {
8803: my ($short,$type,$cid,$forcedefault) = @_;
8804: if ($short =~ m{^cr/}) {
8805: return (split('/',$short))[-1];
8806: }
8807: if (!defined($cid)) {
8808: $cid = $env{'request.course.id'};
8809: }
8810: my %rolenames = (
8811: Course => 'std',
8812: Community => 'alt1',
8813: );
8814: if ($cid ne '') {
8815: if ($env{'course.'.$cid.'.'.$short.'.plaintext'} ne '') {
8816: unless ($forcedefault) {
8817: my $roletext = $env{'course.'.$cid.'.'.$short.'.plaintext'};
8818: &Apache::lonlocal::mt_escape(\$roletext);
8819: return &Apache::lonlocal::mt($roletext);
8820: }
8821: }
8822: }
8823: if ((defined($type)) && (defined($rolenames{$type})) &&
8824: (defined($rolenames{$type})) &&
8825: (defined($prp{$short}{$rolenames{$type}}))) {
8826: return &Apache::lonlocal::mt($prp{$short}{$rolenames{$type}});
8827: } elsif ($cid ne '') {
8828: my $crstype = $env{'course.'.$cid.'.type'};
8829: if (($crstype ne '') && (defined($rolenames{$crstype})) &&
8830: (defined($prp{$short}{$rolenames{$crstype}}))) {
8831: return &Apache::lonlocal::mt($prp{$short}{$rolenames{$crstype}});
8832: }
8833: }
8834: return &Apache::lonlocal::mt($prp{$short}{'std'});
8835: }
8836:
8837: # ----------------------------------------------------------------- Assign Role
8838:
8839: sub assignrole {
8840: my ($udom,$uname,$url,$role,$end,$start,$deleteflag,$selfenroll,
8841: $context)=@_;
8842: my $mrole;
8843: if ($role =~ /^cr\//) {
8844: my $cwosec=$url;
8845: $cwosec=~s/^\/($match_domain)\/($match_courseid)\/.*/$1\/$2/;
8846: unless (&allowed('ccr',$cwosec)) {
8847: my $refused = 1;
8848: if ($context eq 'requestcourses') {
8849: if (($env{'user.name'} ne '') && ($env{'user.domain'} ne '')) {
8850: if ($role =~ m{^cr/($match_domain)/($match_username)/([^/]+)$}) {
8851: if (($1 eq $env{'user.domain'}) && ($2 eq $env{'user.name'})) {
8852: my ($cdom,$cnum) = ($cwosec =~ m{^/?($match_domain)/($match_courseid)$});
8853: my %crsenv = &userenvironment($cdom,$cnum,('internal.courseowner'));
8854: if ($crsenv{'internal.courseowner'} eq
8855: $env{'user.name'}.':'.$env{'user.domain'}) {
8856: $refused = '';
8857: }
8858: }
8859: }
8860: }
8861: }
8862: if ($refused) {
8863: &logthis('Refused custom assignrole: '.
8864: $udom.' '.$uname.' '.$url.' '.$role.' '.$end.' '.$start.
8865: ' by '.$env{'user.name'}.' at '.$env{'user.domain'});
8866: return 'refused';
8867: }
8868: }
8869: $mrole='cr';
8870: } elsif ($role =~ /^gr\//) {
8871: my $cwogrp=$url;
8872: $cwogrp=~s{^/($match_domain)/($match_courseid)/.*}{$1/$2};
8873: unless (&allowed('mdg',$cwogrp)) {
8874: &logthis('Refused group assignrole: '.
8875: $udom.' '.$uname.' '.$url.' '.$role.' '.$end.' '.$start.' by '.
8876: $env{'user.name'}.' at '.$env{'user.domain'});
8877: return 'refused';
8878: }
8879: $mrole='gr';
8880: } else {
8881: my $cwosec=$url;
8882: $cwosec=~s/^\/($match_domain)\/($match_courseid)\/.*/$1\/$2/;
8883: if (!(&allowed('c'.$role,$cwosec)) && !(&allowed('c'.$role,$udom))) {
8884: my $refused;
8885: if (($env{'request.course.sec'} ne '') && ($role eq 'st')) {
8886: if (!(&allowed('c'.$role,$url))) {
8887: $refused = 1;
8888: }
8889: } else {
8890: $refused = 1;
8891: }
8892: if ($refused) {
8893: my ($cdom,$cnum) = ($cwosec =~ m{^/?($match_domain)/($match_courseid)$});
8894: if (!$selfenroll && $context eq 'course') {
8895: my %crsenv;
8896: if ($role eq 'cc' || $role eq 'co') {
8897: %crsenv = &userenvironment($cdom,$cnum,('internal.courseowner'));
8898: if (($role eq 'cc') && ($cnum !~ /^$match_community$/)) {
8899: if ($env{'request.role'} eq 'cc./'.$cdom.'/'.$cnum) {
8900: if ($crsenv{'internal.courseowner'} eq
8901: $env{'user.name'}.':'.$env{'user.domain'}) {
8902: $refused = '';
8903: }
8904: }
8905: } elsif (($role eq 'co') && ($cnum =~ /^$match_community$/)) {
8906: if ($env{'request.role'} eq 'co./'.$cdom.'/'.$cnum) {
8907: if ($crsenv{'internal.courseowner'} eq
8908: $env{'user.name'}.':'.$env{'user.domain'}) {
8909: $refused = '';
8910: }
8911: }
8912: }
8913: }
8914: } elsif (($selfenroll == 1) && ($role eq 'st') && ($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'})) {
8915: $refused = '';
8916: } elsif ($context eq 'requestcourses') {
8917: my @possroles = ('st','ta','ep','in','cc','co');
8918: if ((grep(/^\Q$role\E$/,@possroles)) && ($env{'user.name'} ne '' && $env{'user.domain'} ne '')) {
8919: my $wrongcc;
8920: if ($cnum =~ /^$match_community$/) {
8921: $wrongcc = 1 if ($role eq 'cc');
8922: } else {
8923: $wrongcc = 1 if ($role eq 'co');
8924: }
8925: unless ($wrongcc) {
8926: my %crsenv = &userenvironment($cdom,$cnum,('internal.courseowner'));
8927: if ($crsenv{'internal.courseowner'} eq
8928: $env{'user.name'}.':'.$env{'user.domain'}) {
8929: $refused = '';
8930: }
8931: }
8932: }
8933: } elsif ($context eq 'requestauthor') {
8934: if (($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'}) &&
8935: ($url eq '/'.$udom.'/') && ($role eq 'au')) {
8936: if ($env{'environment.requestauthor'} eq 'automatic') {
8937: $refused = '';
8938: } else {
8939: my %domdefaults = &get_domain_defaults($udom);
8940: if (ref($domdefaults{'requestauthor'}) eq 'HASH') {
8941: my $checkbystatus;
8942: if ($env{'user.adv'}) {
8943: my $disposition = $domdefaults{'requestauthor'}{'_LC_adv'};
8944: if ($disposition eq 'automatic') {
8945: $refused = '';
8946: } elsif ($disposition eq '') {
8947: $checkbystatus = 1;
8948: }
8949: } else {
8950: $checkbystatus = 1;
8951: }
8952: if ($checkbystatus) {
8953: if ($env{'environment.inststatus'}) {
8954: my @inststatuses = split(/,/,$env{'environment.inststatus'});
8955: foreach my $type (@inststatuses) {
8956: if (($type ne '') &&
8957: ($domdefaults{'requestauthor'}{$type} eq 'automatic')) {
8958: $refused = '';
8959: }
8960: }
8961: } elsif ($domdefaults{'requestauthor'}{'default'} eq 'automatic') {
8962: $refused = '';
8963: }
8964: }
8965: }
8966: }
8967: }
8968: }
8969: if ($refused) {
8970: &logthis('Refused assignrole: '.$udom.' '.$uname.' '.$url.
8971: ' '.$role.' '.$end.' '.$start.' by '.
8972: $env{'user.name'}.' at '.$env{'user.domain'});
8973: return 'refused';
8974: }
8975: }
8976: } elsif ($role eq 'au') {
8977: if ($url ne '/'.$udom.'/') {
8978: &logthis('Attempt by '.$env{'user.name'}.':'.$env{'user.domain'}.
8979: ' to assign author role for '.$uname.':'.$udom.
8980: ' in domain: '.$url.' refused (wrong domain).');
8981: return 'refused';
8982: }
8983: }
8984: $mrole=$role;
8985: }
8986: my $command="encrypt:rolesput:$env{'user.domain'}:$env{'user.name'}:".
8987: "$udom:$uname:$url".'_'."$mrole=$role";
8988: if ($end) { $command.='_'.$end; }
8989: if ($start) {
8990: if ($end) {
8991: $command.='_'.$start;
8992: } else {
8993: $command.='_0_'.$start;
8994: }
8995: }
8996: my $origstart = $start;
8997: my $origend = $end;
8998: my $delflag;
8999: # actually delete
9000: if ($deleteflag) {
9001: if ((&allowed('dro',$udom)) || (&allowed('dro',$url))) {
9002: # modify command to delete the role
9003: $command="encrypt:rolesdel:$env{'user.domain'}:$env{'user.name'}:".
9004: "$udom:$uname:$url".'_'."$mrole";
9005: &logthis("$env{'user.name'} at $env{'user.domain'} deletes $mrole in $url for $uname at $udom");
9006: # set start and finish to negative values for userrolelog
9007: $start=-1;
9008: $end=-1;
9009: $delflag = 1;
9010: }
9011: }
9012: # send command
9013: my $answer=&reply($command,&homeserver($uname,$udom));
9014: # log new user role if status is ok
9015: if ($answer eq 'ok') {
9016: &userrolelog($role,$uname,$udom,$url,$start,$end);
9017: if (($role eq 'cc') || ($role eq 'in') ||
9018: ($role eq 'ep') || ($role eq 'ad') ||
9019: ($role eq 'ta') || ($role eq 'st') ||
9020: ($role=~/^cr/) || ($role eq 'gr') ||
9021: ($role eq 'co')) {
9022: # for course roles, perform group memberships changes triggered by role change.
9023: unless ($role =~ /^gr/) {
9024: &Apache::longroup::group_changes($udom,$uname,$url,$role,$origend,
9025: $origstart,$selfenroll,$context);
9026: }
9027: &courserolelog($role,$uname,$udom,$url,$origstart,$origend,$delflag,
9028: $selfenroll,$context);
9029: } elsif (($role eq 'li') || ($role eq 'dg') || ($role eq 'sc') ||
9030: ($role eq 'au') || ($role eq 'dc') || ($role eq 'dh') ||
9031: ($role eq 'da')) {
9032: &domainrolelog($role,$uname,$udom,$url,$origstart,$origend,$delflag,
9033: $context);
9034: } elsif (($role eq 'ca') || ($role eq 'aa')) {
9035: &coauthorrolelog($role,$uname,$udom,$url,$origstart,$origend,$delflag,
9036: $context);
9037: }
9038: if ($role eq 'cc') {
9039: &autoupdate_coowners($url,$end,$start,$uname,$udom);
9040: }
9041: }
9042: return $answer;
9043: }
9044:
9045: sub autoupdate_coowners {
9046: my ($url,$end,$start,$uname,$udom) = @_;
9047: my ($cdom,$cnum) = ($url =~ m{^/($match_domain)/($match_courseid)});
9048: if (($cdom ne '') && ($cnum ne '')) {
9049: my $now = time;
9050: my %domdesign = &Apache::loncommon::get_domainconf($cdom);
9051: if ($domdesign{$cdom.'.autoassign.co-owners'}) {
9052: my %coursehash = &coursedescription($cdom.'_'.$cnum);
9053: my $instcode = $coursehash{'internal.coursecode'};
9054: if ($instcode ne '') {
9055: if (($start && $start <= $now) && ($end == 0) || ($end > $now)) {
9056: unless ($coursehash{'internal.courseowner'} eq $uname.':'.$udom) {
9057: my ($delcoowners,@newcoowners,$putresult,$delresult,$coowners);
9058: my ($result,$desc) = &auto_validate_instcode($cnum,$cdom,$instcode,$uname.':'.$udom);
9059: if ($result eq 'valid') {
9060: if ($coursehash{'internal.co-owners'}) {
9061: foreach my $coowner (split(',',$coursehash{'internal.co-owners'})) {
9062: push(@newcoowners,$coowner);
9063: }
9064: unless (grep(/^\Q$uname\E:\Q$udom\E$/,@newcoowners)) {
9065: push(@newcoowners,$uname.':'.$udom);
9066: }
9067: @newcoowners = sort(@newcoowners);
9068: } else {
9069: push(@newcoowners,$uname.':'.$udom);
9070: }
9071: } else {
9072: if ($coursehash{'internal.co-owners'}) {
9073: foreach my $coowner (split(',',$coursehash{'internal.co-owners'})) {
9074: unless ($coowner eq $uname.':'.$udom) {
9075: push(@newcoowners,$coowner);
9076: }
9077: }
9078: unless (@newcoowners > 0) {
9079: $delcoowners = 1;
9080: $coowners = '';
9081: }
9082: }
9083: }
9084: if (@newcoowners || $delcoowners) {
9085: &store_coowners($cdom,$cnum,$coursehash{'home'},
9086: $delcoowners,@newcoowners);
9087: }
9088: }
9089: }
9090: }
9091: }
9092: }
9093: }
9094:
9095: sub store_coowners {
9096: my ($cdom,$cnum,$chome,$delcoowners,@newcoowners) = @_;
9097: my $cid = $cdom.'_'.$cnum;
9098: my ($coowners,$delresult,$putresult);
9099: if (@newcoowners) {
9100: $coowners = join(',',@newcoowners);
9101: my %coownershash = (
9102: 'internal.co-owners' => $coowners,
9103: );
9104: $putresult = &put('environment',\%coownershash,$cdom,$cnum);
9105: if ($putresult eq 'ok') {
9106: if ($env{'course.'.$cid.'.num'} eq $cnum) {
9107: &appenv({'course.'.$cid.'.internal.co-owners' => $coowners});
9108: }
9109: }
9110: }
9111: if ($delcoowners) {
9112: $delresult = &Apache::lonnet::del('environment',['internal.co-owners'],$cdom,$cnum);
9113: if ($delresult eq 'ok') {
9114: if ($env{'course.'.$cid.'.internal.co-owners'}) {
9115: &Apache::lonnet::delenv('course.'.$cid.'.internal.co-owners');
9116: }
9117: }
9118: }
9119: if (($putresult eq 'ok') || ($delresult eq 'ok')) {
9120: my %crsinfo =
9121: &Apache::lonnet::courseiddump($cdom,'.',1,'.','.',$cnum,undef,undef,'.');
9122: if (ref($crsinfo{$cid}) eq 'HASH') {
9123: $crsinfo{$cid}{'co-owners'} = \@newcoowners;
9124: my $cidput = &Apache::lonnet::courseidput($cdom,\%crsinfo,$chome,'notime');
9125: }
9126: }
9127: }
9128:
9129: # -------------------------------------------------- Modify user authentication
9130: # Overrides without validation
9131:
9132: sub modifyuserauth {
9133: my ($udom,$uname,$umode,$upass)=@_;
9134: my $uhome=&homeserver($uname,$udom);
9135: unless (&allowed('mau',$udom)) { return 'refused'; }
9136: &logthis('Call to modify user authentication '.$udom.', '.$uname.', '.
9137: $umode.' by '.$env{'user.name'}.' at '.$env{'user.domain'}.
9138: ' in domain '.$env{'request.role.domain'});
9139: my $reply=&reply('encrypt:changeuserauth:'.$udom.':'.$uname.':'.$umode.':'.
9140: &escape($upass),$uhome);
9141: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},
9142: 'Authentication changed for '.$udom.', '.$uname.', '.$umode.
9143: '(Remote '.$ENV{'REMOTE_ADDR'}.'): '.$reply);
9144: &log($udom,,$uname,$uhome,
9145: 'Authentication changed by '.$env{'user.domain'}.', '.
9146: $env{'user.name'}.', '.$umode.
9147: '(Remote '.$ENV{'REMOTE_ADDR'}.'): '.$reply);
9148: unless ($reply eq 'ok') {
9149: &logthis('Authentication mode error: '.$reply);
9150: return 'error: '.$reply;
9151: }
9152: return 'ok';
9153: }
9154:
9155: # --------------------------------------------------------------- Modify a user
9156:
9157: sub modifyuser {
9158: my ($udom, $uname, $uid,
9159: $umode, $upass, $first,
9160: $middle, $last, $gene,
9161: $forceid, $desiredhome, $email, $inststatus, $candelete)=@_;
9162: $udom= &LONCAPA::clean_domain($udom);
9163: $uname=&LONCAPA::clean_username($uname);
9164: my $showcandelete = 'none';
9165: if (ref($candelete) eq 'ARRAY') {
9166: if (@{$candelete} > 0) {
9167: $showcandelete = join(', ',@{$candelete});
9168: }
9169: }
9170: &logthis('Call to modify user '.$udom.', '.$uname.', '.$uid.', '.
9171: $umode.', '.$first.', '.$middle.', '.
9172: $last.', '.$gene.'(forceid: '.$forceid.'; candelete: '.$showcandelete.')'.
9173: (defined($desiredhome) ? ' desiredhome = '.$desiredhome :
9174: ' desiredhome not specified').
9175: ' by '.$env{'user.name'}.' at '.$env{'user.domain'}.
9176: ' in domain '.$env{'request.role.domain'});
9177: my $uhome=&homeserver($uname,$udom,'true');
9178: my $newuser;
9179: if ($uhome eq 'no_host') {
9180: $newuser = 1;
9181: }
9182: # ----------------------------------------------------------------- Create User
9183: if (($uhome eq 'no_host') &&
9184: (($umode && $upass) || ($umode eq 'localauth'))) {
9185: my $unhome='';
9186: if (defined($desiredhome) && &host_domain($desiredhome) eq $udom) {
9187: $unhome = $desiredhome;
9188: } elsif($env{'course.'.$env{'request.course.id'}.'.domain'} eq $udom) {
9189: $unhome=$env{'course.'.$env{'request.course.id'}.'.home'};
9190: } else { # load balancing routine for determining $unhome
9191: my $loadm=10000000;
9192: my %servers = &get_servers($udom,'library');
9193: foreach my $tryserver (keys(%servers)) {
9194: my $answer=reply('load',$tryserver);
9195: if (($answer=~/\d+/) && ($answer<$loadm)) {
9196: $loadm=$answer;
9197: $unhome=$tryserver;
9198: }
9199: }
9200: }
9201: if (($unhome eq '') || ($unhome eq 'no_host')) {
9202: return 'error: unable to find a home server for '.$uname.
9203: ' in domain '.$udom;
9204: }
9205: my $reply=&reply('encrypt:makeuser:'.$udom.':'.$uname.':'.$umode.':'.
9206: &escape($upass),$unhome);
9207: unless ($reply eq 'ok') {
9208: return 'error: '.$reply;
9209: }
9210: $uhome=&homeserver($uname,$udom,'true');
9211: if (($uhome eq '') || ($uhome eq 'no_host') || ($uhome ne $unhome)) {
9212: return 'error: unable verify users home machine.';
9213: }
9214: } # End of creation of new user
9215: # ---------------------------------------------------------------------- Add ID
9216: if ($uid) {
9217: $uid=~tr/A-Z/a-z/;
9218: my %uidhash=&idrget($udom,$uname);
9219: if (($uidhash{$uname}) && ($uidhash{$uname}!~/error\:/)
9220: && (!$forceid)) {
9221: unless ($uid eq $uidhash{$uname}) {
9222: return 'error: user id "'.$uid.'" does not match '.
9223: 'current user id "'.$uidhash{$uname}.'".';
9224: }
9225: } else {
9226: &idput($udom,($uname => $uid));
9227: }
9228: }
9229: # -------------------------------------------------------------- Add names, etc
9230: my @tmp=&get('environment',
9231: ['firstname','middlename','lastname','generation','id',
9232: 'permanentemail','inststatus'],
9233: $udom,$uname);
9234: my (%names,%oldnames);
9235: if ($tmp[0] =~ m/^error:.*/) {
9236: %names=();
9237: } else {
9238: %names = @tmp;
9239: %oldnames = %names;
9240: }
9241: #
9242: # If name, email and/or uid are blank (e.g., because an uploaded file
9243: # of users did not contain them), do not overwrite existing values
9244: # unless field is in $candelete array ref.
9245: #
9246:
9247: my @fields = ('firstname','middlename','lastname','generation',
9248: 'permanentemail','id');
9249: my %newvalues;
9250: if (ref($candelete) eq 'ARRAY') {
9251: foreach my $field (@fields) {
9252: if (grep(/^\Q$field\E$/,@{$candelete})) {
9253: if ($field eq 'firstname') {
9254: $names{$field} = $first;
9255: } elsif ($field eq 'middlename') {
9256: $names{$field} = $middle;
9257: } elsif ($field eq 'lastname') {
9258: $names{$field} = $last;
9259: } elsif ($field eq 'generation') {
9260: $names{$field} = $gene;
9261: } elsif ($field eq 'permanentemail') {
9262: $names{$field} = $email;
9263: } elsif ($field eq 'id') {
9264: $names{$field} = $uid;
9265: }
9266: }
9267: }
9268: }
9269: if ($first) { $names{'firstname'} = $first; }
9270: if (defined($middle)) { $names{'middlename'} = $middle; }
9271: if ($last) { $names{'lastname'} = $last; }
9272: if (defined($gene)) { $names{'generation'} = $gene; }
9273: if ($email) {
9274: $email=~s/[^\w\@\.\-\,]//gs;
9275: if ($email=~/\@/) { $names{'permanentemail'} = $email; }
9276: }
9277: if ($uid) { $names{'id'} = $uid; }
9278: if (defined($inststatus)) {
9279: $names{'inststatus'} = '';
9280: my ($usertypes,$typesorder) = &retrieve_inst_usertypes($udom);
9281: if (ref($usertypes) eq 'HASH') {
9282: my @okstatuses;
9283: foreach my $item (split(/:/,$inststatus)) {
9284: if (defined($usertypes->{$item})) {
9285: push(@okstatuses,$item);
9286: }
9287: }
9288: if (@okstatuses) {
9289: $names{'inststatus'} = join(':', map { &escape($_); } @okstatuses);
9290: }
9291: }
9292: }
9293: my $logmsg = $udom.', '.$uname.', '.$uid.', '.
9294: $umode.', '.$first.', '.$middle.', '.
9295: $last.', '.$gene.', '.$email.', '.$inststatus;
9296: if ($env{'user.name'} ne '' && $env{'user.domain'}) {
9297: $logmsg .= ' by '.$env{'user.name'}.' at '.$env{'user.domain'};
9298: } else {
9299: $logmsg .= ' during self creation';
9300: }
9301: my $changed;
9302: if ($newuser) {
9303: $changed = 1;
9304: } else {
9305: foreach my $field (@fields) {
9306: if ($names{$field} ne $oldnames{$field}) {
9307: $changed = 1;
9308: last;
9309: }
9310: }
9311: }
9312: unless ($changed) {
9313: $logmsg = 'No changes in user information needed for: '.$logmsg;
9314: &logthis($logmsg);
9315: return 'ok';
9316: }
9317: my $reply = &put('environment', \%names, $udom,$uname);
9318: if ($reply ne 'ok') {
9319: return 'error: '.$reply;
9320: }
9321: if ($names{'permanentemail'} ne $oldnames{'permanentemail'}) {
9322: &Apache::lonnet::devalidate_cache_new('emailscache',$uname.':'.$udom);
9323: }
9324: my $sqlresult = &update_allusers_table($uname,$udom,\%names);
9325: &devalidate_cache_new('namescache',$uname.':'.$udom);
9326: $logmsg = 'Success modifying user '.$logmsg;
9327: &logthis($logmsg);
9328: return 'ok';
9329: }
9330:
9331: # -------------------------------------------------------------- Modify student
9332:
9333: sub modifystudent {
9334: my ($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene,$usec,
9335: $end,$start,$forceid,$desiredhome,$email,$type,$locktype,$cid,
9336: $selfenroll,$context,$inststatus,$credits,$instsec)=@_;
9337: if (!$cid) {
9338: unless ($cid=$env{'request.course.id'}) {
9339: return 'not_in_class';
9340: }
9341: }
9342: # --------------------------------------------------------------- Make the user
9343: my $reply=&modifyuser
9344: ($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene,$forceid,
9345: $desiredhome,$email,$inststatus);
9346: unless ($reply eq 'ok') { return $reply; }
9347: # This will cause &modify_student_enrollment to get the uid from the
9348: # student's environment
9349: $uid = undef if (!$forceid);
9350: $reply = &modify_student_enrollment($udom,$uname,$uid,$first,$middle,$last,
9351: $gene,$usec,$end,$start,$type,$locktype,
9352: $cid,$selfenroll,$context,$credits,$instsec);
9353: return $reply;
9354: }
9355:
9356: sub modify_student_enrollment {
9357: my ($udom,$uname,$uid,$first,$middle,$last,$gene,$usec,$end,$start,$type,
9358: $locktype,$cid,$selfenroll,$context,$credits,$instsec) = @_;
9359: my ($cdom,$cnum,$chome);
9360: if (!$cid) {
9361: unless ($cid=$env{'request.course.id'}) {
9362: return 'not_in_class';
9363: }
9364: $cdom=$env{'course.'.$cid.'.domain'};
9365: $cnum=$env{'course.'.$cid.'.num'};
9366: } else {
9367: ($cdom,$cnum)=split(/_/,$cid);
9368: }
9369: $chome=$env{'course.'.$cid.'.home'};
9370: if (!$chome) {
9371: $chome=&homeserver($cnum,$cdom);
9372: }
9373: if (!$chome) { return 'unknown_course'; }
9374: # Make sure the user exists
9375: my $uhome=&homeserver($uname,$udom);
9376: if (($uhome eq '') || ($uhome eq 'no_host')) {
9377: return 'error: no such user';
9378: }
9379: # Get student data if we were not given enough information
9380: if (!defined($first) || $first eq '' ||
9381: !defined($last) || $last eq '' ||
9382: !defined($uid) || $uid eq '' ||
9383: !defined($middle) || $middle eq '' ||
9384: !defined($gene) || $gene eq '') {
9385: # They did not supply us with enough data to enroll the student, so
9386: # we need to pick up more information.
9387: my %tmp = &get('environment',
9388: ['firstname','middlename','lastname', 'generation','id']
9389: ,$udom,$uname);
9390:
9391: #foreach my $key (keys(%tmp)) {
9392: # &logthis("key $key = ".$tmp{$key});
9393: #}
9394: $first = $tmp{'firstname'} if (!defined($first) || $first eq '');
9395: $middle = $tmp{'middlename'} if (!defined($middle) || $middle eq '');
9396: $last = $tmp{'lastname'} if (!defined($last) || $last eq '');
9397: $gene = $tmp{'generation'} if (!defined($gene) || $gene eq '');
9398: $uid = $tmp{'id'} if (!defined($uid) || $uid eq '');
9399: }
9400: my $fullname = &format_name($first,$middle,$last,$gene,'lastname');
9401: my $user = "$uname:$udom";
9402: my %old_entry = &Apache::lonnet::get('classlist',[$user],$cdom,$cnum);
9403: my $reply=cput('classlist',
9404: {$user =>
9405: join(':',$end,$start,$uid,$usec,$fullname,$type,$locktype,$credits,$instsec) },
9406: $cdom,$cnum);
9407: if (($reply eq 'ok') || ($reply eq 'delayed')) {
9408: &devalidate_getsection_cache($udom,$uname,$cid);
9409: } else {
9410: return 'error: '.$reply;
9411: }
9412: # Add student role to user
9413: my $uurl='/'.$cid;
9414: $uurl=~s/\_/\//g;
9415: if ($usec) {
9416: $uurl.='/'.$usec;
9417: }
9418: my $result = &assignrole($udom,$uname,$uurl,'st',$end,$start,undef,
9419: $selfenroll,$context);
9420: if ($result ne 'ok') {
9421: if ($old_entry{$user} ne '') {
9422: $reply = &cput('classlist',\%old_entry,$cdom,$cnum);
9423: } else {
9424: $reply = &del('classlist',[$user],$cdom,$cnum);
9425: }
9426: }
9427: return $result;
9428: }
9429:
9430: sub format_name {
9431: my ($firstname,$middlename,$lastname,$generation,$first)=@_;
9432: my $name;
9433: if ($first ne 'lastname') {
9434: $name=$firstname.' '.$middlename.' '.$lastname.' '.$generation;
9435: } else {
9436: if ($lastname=~/\S/) {
9437: $name.= $lastname.' '.$generation.', '.$firstname.' '.$middlename;
9438: $name=~s/\s+,/,/;
9439: } else {
9440: $name.= $firstname.' '.$middlename.' '.$generation;
9441: }
9442: }
9443: $name=~s/^\s+//;
9444: $name=~s/\s+$//;
9445: $name=~s/\s+/ /g;
9446: return $name;
9447: }
9448:
9449: # ------------------------------------------------- Write to course preferences
9450:
9451: sub writecoursepref {
9452: my ($courseid,%prefs)=@_;
9453: $courseid=~s/^\///;
9454: $courseid=~s/\_/\//g;
9455: my ($cdomain,$cnum)=split(/\//,$courseid);
9456: my $chome=homeserver($cnum,$cdomain);
9457: if (($chome eq '') || ($chome eq 'no_host')) {
9458: return 'error: no such course';
9459: }
9460: my $cstring='';
9461: foreach my $pref (keys(%prefs)) {
9462: $cstring.=&escape($pref).'='.&escape($prefs{$pref}).'&';
9463: }
9464: $cstring=~s/\&$//;
9465: return reply('put:'.$cdomain.':'.$cnum.':environment:'.$cstring,$chome);
9466: }
9467:
9468: # ---------------------------------------------------------- Make/modify course
9469:
9470: sub createcourse {
9471: my ($udom,$description,$url,$course_server,$nonstandard,$inst_code,
9472: $course_owner,$crstype,$cnum,$context,$category)=@_;
9473: $url=&declutter($url);
9474: my $cid='';
9475: if ($context eq 'requestcourses') {
9476: my $can_create = 0;
9477: my ($ownername,$ownerdom) = split(':',$course_owner);
9478: if ($udom eq $ownerdom) {
9479: if (&usertools_access($ownername,$ownerdom,$category,undef,
9480: $context)) {
9481: $can_create = 1;
9482: }
9483: } else {
9484: my %userenv = &userenvironment($ownerdom,$ownername,'reqcrsotherdom.'.
9485: $category);
9486: if ($userenv{'reqcrsotherdom.'.$category} ne '') {
9487: my @curr = split(',',$userenv{'reqcrsotherdom.'.$category});
9488: if (@curr > 0) {
9489: my @options = qw(approval validate autolimit);
9490: my $optregex = join('|',@options);
9491: if (grep(/^\Q$udom\E:($optregex)(=?\d*)$/,@curr)) {
9492: $can_create = 1;
9493: }
9494: }
9495: }
9496: }
9497: if ($can_create) {
9498: unless ($ownername eq $env{'user.name'} && $ownerdom eq $env{'user.domain'}) {
9499: unless (&allowed('ccc',$udom)) {
9500: return 'refused';
9501: }
9502: }
9503: } else {
9504: return 'refused';
9505: }
9506: } elsif (!&allowed('ccc',$udom)) {
9507: return 'refused';
9508: }
9509: # --------------------------------------------------------------- Get Unique ID
9510: my $uname;
9511: if ($cnum =~ /^$match_courseid$/) {
9512: my $chome=&homeserver($cnum,$udom,'true');
9513: if (($chome eq '') || ($chome eq 'no_host')) {
9514: $uname = $cnum;
9515: } else {
9516: $uname = &generate_coursenum($udom,$crstype);
9517: }
9518: } else {
9519: $uname = &generate_coursenum($udom,$crstype);
9520: }
9521: return $uname if ($uname =~ /^error/);
9522: # -------------------------------------------------- Check supplied server name
9523: if (!defined($course_server)) {
9524: if (defined(&domain($udom,'primary'))) {
9525: $course_server = &domain($udom,'primary');
9526: } else {
9527: $course_server = $env{'user.home'};
9528: }
9529: }
9530: my %host_servers =
9531: &Apache::lonnet::get_servers($udom,'library');
9532: unless ($host_servers{$course_server}) {
9533: return 'error: invalid home server for course: '.$course_server;
9534: }
9535: # ------------------------------------------------------------- Make the course
9536: my $reply=&reply('encrypt:makeuser:'.$udom.':'.$uname.':none::',
9537: $course_server);
9538: unless ($reply eq 'ok') { return 'error: '.$reply; }
9539: my $uhome=&homeserver($uname,$udom,'true');
9540: if (($uhome eq '') || ($uhome eq 'no_host')) {
9541: return 'error: no such course';
9542: }
9543: # ----------------------------------------------------------------- Course made
9544: # log existence
9545: my $now = time;
9546: my $newcourse = {
9547: $udom.'_'.$uname => {
9548: description => $description,
9549: inst_code => $inst_code,
9550: owner => $course_owner,
9551: type => $crstype,
9552: creator => $env{'user.name'}.':'.
9553: $env{'user.domain'},
9554: created => $now,
9555: context => $context,
9556: },
9557: };
9558: &courseidput($udom,$newcourse,$uhome,'notime');
9559: # set toplevel url
9560: my $topurl=$url;
9561: unless ($nonstandard) {
9562: # ------------------------------------------ For standard courses, make top url
9563: my $mapurl=&clutter($url);
9564: if ($mapurl eq '/res/') { $mapurl=''; }
9565: $env{'form.initmap'}=(<<ENDINITMAP);
9566: <map>
9567: <resource id="1" type="start"></resource>
9568: <resource id="2" src="$mapurl"></resource>
9569: <resource id="3" type="finish"></resource>
9570: <link index="1" from="1" to="2"></link>
9571: <link index="2" from="2" to="3"></link>
9572: </map>
9573: ENDINITMAP
9574: $topurl=&declutter(
9575: &finishuserfileupload($uname,$udom,'initmap','default.sequence')
9576: );
9577: }
9578: # ----------------------------------------------------------- Write preferences
9579: &writecoursepref($udom.'_'.$uname,
9580: ('description' => $description,
9581: 'url' => $topurl,
9582: 'internal.creator' => $env{'user.name'}.':'.
9583: $env{'user.domain'},
9584: 'internal.created' => $now,
9585: 'internal.creationcontext' => $context)
9586: );
9587: return '/'.$udom.'/'.$uname;
9588: }
9589:
9590: # ------------------------------------------------------------------- Create ID
9591: sub generate_coursenum {
9592: my ($udom,$crstype) = @_;
9593: my $domdesc = &domain($udom);
9594: return 'error: invalid domain' if ($domdesc eq '');
9595: my $first;
9596: if ($crstype eq 'Community') {
9597: $first = '0';
9598: } else {
9599: $first = int(1+rand(9));
9600: }
9601: my $uname=$first.
9602: ('a'..'z','A'..'Z','0'..'9')[int(rand(62))].
9603: substr($$.time,0,5).unpack("H8",pack("I32",time)).
9604: unpack("H2",pack("I32",int(rand(255)))).$perlvar{'lonHostID'};
9605: # ----------------------------------------------- Make sure that does not exist
9606: my $uhome=&homeserver($uname,$udom,'true');
9607: unless (($uhome eq '') || ($uhome eq 'no_host')) {
9608: if ($crstype eq 'Community') {
9609: $first = '0';
9610: } else {
9611: $first = int(1+rand(9));
9612: }
9613: $uname=$first.
9614: ('a'..'z','A'..'Z','0'..'9')[int(rand(62))].
9615: substr($$.time,0,5).unpack("H8",pack("I32",time)).
9616: unpack("H2",pack("I32",int(rand(255)))).$perlvar{'lonHostID'};
9617: $uhome=&homeserver($uname,$udom,'true');
9618: unless (($uhome eq '') || ($uhome eq 'no_host')) {
9619: return 'error: unable to generate unique course-ID';
9620: }
9621: }
9622: return $uname;
9623: }
9624:
9625: sub is_course {
9626: my ($cdom, $cnum) = scalar(@_) == 1 ?
9627: ($_[0] =~ /^($match_domain)_($match_courseid)$/) : @_;
9628:
9629: return unless $cdom and $cnum;
9630:
9631: my %courses = &courseiddump($cdom, '.', 1, '.', '.', $cnum, undef, undef,
9632: '.');
9633:
9634: return unless(exists($courses{$cdom.'_'.$cnum}));
9635: return wantarray ? ($cdom, $cnum) : $cdom.'_'.$cnum;
9636: }
9637:
9638: sub store_userdata {
9639: my ($storehash,$datakey,$namespace,$udom,$uname) = @_;
9640: my $result;
9641: if ($datakey ne '') {
9642: if (ref($storehash) eq 'HASH') {
9643: if ($udom eq '' || $uname eq '') {
9644: $udom = $env{'user.domain'};
9645: $uname = $env{'user.name'};
9646: }
9647: my $uhome=&homeserver($uname,$udom);
9648: if (($uhome eq '') || ($uhome eq 'no_host')) {
9649: $result = 'error: no_host';
9650: } else {
9651: $storehash->{'ip'} = $ENV{'REMOTE_ADDR'};
9652: $storehash->{'host'} = $perlvar{'lonHostID'};
9653:
9654: my $namevalue='';
9655: foreach my $key (keys(%{$storehash})) {
9656: $namevalue.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
9657: }
9658: $namevalue=~s/\&$//;
9659: unless ($namespace eq 'courserequests') {
9660: $datakey = &escape($datakey);
9661: }
9662: $result = &reply("store:$udom:$uname:$namespace:$datakey:".
9663: $namevalue,$uhome);
9664: }
9665: } else {
9666: $result = 'error: data to store was not a hash reference';
9667: }
9668: } else {
9669: $result= 'error: invalid requestkey';
9670: }
9671: return $result;
9672: }
9673:
9674: # ---------------------------------------------------------- Assign Custom Role
9675:
9676: sub assigncustomrole {
9677: my ($udom,$uname,$url,$rdom,$rnam,$rolename,$end,$start,$deleteflag,$selfenroll,$context)=@_;
9678: return &assignrole($udom,$uname,$url,'cr/'.$rdom.'/'.$rnam.'/'.$rolename,
9679: $end,$start,$deleteflag,$selfenroll,$context);
9680: }
9681:
9682: # ----------------------------------------------------------------- Revoke Role
9683:
9684: sub revokerole {
9685: my ($udom,$uname,$url,$role,$deleteflag,$selfenroll,$context)=@_;
9686: my $now=time;
9687: return &assignrole($udom,$uname,$url,$role,$now,undef,$deleteflag,$selfenroll,$context);
9688: }
9689:
9690: # ---------------------------------------------------------- Revoke Custom Role
9691:
9692: sub revokecustomrole {
9693: my ($udom,$uname,$url,$rdom,$rnam,$rolename,$deleteflag,$selfenroll,$context)=@_;
9694: my $now=time;
9695: return &assigncustomrole($udom,$uname,$url,$rdom,$rnam,$rolename,$now,
9696: $deleteflag,$selfenroll,$context);
9697: }
9698:
9699: # ------------------------------------------------------------ Disk usage
9700: sub diskusage {
9701: my ($udom,$uname,$directorypath,$getpropath)=@_;
9702: $directorypath =~ s/\/$//;
9703: my $listing=&reply('du2:'.&escape($directorypath).':'
9704: .&escape($getpropath).':'.&escape($uname).':'
9705: .&escape($udom),homeserver($uname,$udom));
9706: if ($listing eq 'unknown_cmd') {
9707: if ($getpropath) {
9708: $directorypath = &propath($udom,$uname).'/'.$directorypath;
9709: }
9710: $listing = &reply('du:'.$directorypath,homeserver($uname,$udom));
9711: }
9712: return $listing;
9713: }
9714:
9715: sub is_locked {
9716: my ($file_name, $domain, $user, $which) = @_;
9717: my @check;
9718: my $is_locked;
9719: push (@check,$file_name);
9720: my %locked = &get('file_permissions',\@check,
9721: $env{'user.domain'},$env{'user.name'});
9722: my ($tmp)=keys(%locked);
9723: if ($tmp=~/^error:/) { undef(%locked); }
9724:
9725: if (ref($locked{$file_name}) eq 'ARRAY') {
9726: $is_locked = 'false';
9727: foreach my $entry (@{$locked{$file_name}}) {
9728: if (ref($entry) eq 'ARRAY') {
9729: $is_locked = 'true';
9730: if (ref($which) eq 'ARRAY') {
9731: push(@{$which},$entry);
9732: } else {
9733: last;
9734: }
9735: }
9736: }
9737: } else {
9738: $is_locked = 'false';
9739: }
9740: return $is_locked;
9741: }
9742:
9743: sub declutter_portfile {
9744: my ($file) = @_;
9745: $file =~ s{^(/portfolio/|portfolio/)}{/};
9746: return $file;
9747: }
9748:
9749: # ------------------------------------------------------------- Mark as Read Only
9750:
9751: sub mark_as_readonly {
9752: my ($domain,$user,$files,$what) = @_;
9753: my %current_permissions = &dump('file_permissions',$domain,$user);
9754: my ($tmp)=keys(%current_permissions);
9755: if ($tmp=~/^error:/) { undef(%current_permissions); }
9756: foreach my $file (@{$files}) {
9757: $file = &declutter_portfile($file);
9758: push(@{$current_permissions{$file}},$what);
9759: }
9760: &put('file_permissions',\%current_permissions,$domain,$user);
9761: return;
9762: }
9763:
9764: # ------------------------------------------------------------Save Selected Files
9765:
9766: sub save_selected_files {
9767: my ($user, $path, @files) = @_;
9768: my $filename = $user."savedfiles";
9769: my @other_files = &files_not_in_path($user, $path);
9770: open (OUT, '>'.$tmpdir.$filename);
9771: foreach my $file (@files) {
9772: print (OUT $env{'form.currentpath'}.$file."\n");
9773: }
9774: foreach my $file (@other_files) {
9775: print (OUT $file."\n");
9776: }
9777: close (OUT);
9778: return 'ok';
9779: }
9780:
9781: sub clear_selected_files {
9782: my ($user) = @_;
9783: my $filename = $user."savedfiles";
9784: open (OUT, '>'.LONCAPA::tempdir().$filename);
9785: print (OUT undef);
9786: close (OUT);
9787: return ("ok");
9788: }
9789:
9790: sub files_in_path {
9791: my ($user, $path) = @_;
9792: my $filename = $user."savedfiles";
9793: my %return_files;
9794: open (IN, '<'.LONCAPA::tempdir().$filename);
9795: while (my $line_in = <IN>) {
9796: chomp ($line_in);
9797: my @paths_and_file = split (m!/!, $line_in);
9798: my $file_part = pop (@paths_and_file);
9799: my $path_part = join ('/', @paths_and_file);
9800: $path_part.='/';
9801: my $path_and_file = $path_part.$file_part;
9802: if ($path_part eq $path) {
9803: $return_files{$file_part}= 'selected';
9804: }
9805: }
9806: close (IN);
9807: return (\%return_files);
9808: }
9809:
9810: # called in portfolio select mode, to show files selected NOT in current directory
9811: sub files_not_in_path {
9812: my ($user, $path) = @_;
9813: my $filename = $user."savedfiles";
9814: my @return_files;
9815: my $path_part;
9816: open(IN, '<'.LONCAPA::.$filename);
9817: while (my $line = <IN>) {
9818: #ok, I know it's clunky, but I want it to work
9819: my @paths_and_file = split(m|/|, $line);
9820: my $file_part = pop(@paths_and_file);
9821: chomp($file_part);
9822: my $path_part = join('/', @paths_and_file);
9823: $path_part .= '/';
9824: my $path_and_file = $path_part.$file_part;
9825: if ($path_part ne $path) {
9826: push(@return_files, ($path_and_file));
9827: }
9828: }
9829: close(OUT);
9830: return (@return_files);
9831: }
9832:
9833: #----------------------------------------------Get portfolio file permissions
9834:
9835: sub get_portfile_permissions {
9836: my ($domain,$user) = @_;
9837: my %current_permissions = &dump('file_permissions',$domain,$user);
9838: my ($tmp)=keys(%current_permissions);
9839: if ($tmp=~/^error:/) { undef(%current_permissions); }
9840: return \%current_permissions;
9841: }
9842:
9843: #---------------------------------------------Get portfolio file access controls
9844:
9845: sub get_access_controls {
9846: my ($current_permissions,$group,$file) = @_;
9847: my %access;
9848: my $real_file = $file;
9849: $file =~ s/\.meta$//;
9850: if (defined($file)) {
9851: if (ref($$current_permissions{$file."\0".'accesscontrol'}) eq 'HASH') {
9852: foreach my $control (keys(%{$$current_permissions{$file."\0".'accesscontrol'}})) {
9853: $access{$real_file}{$control} = $$current_permissions{$file."\0".$control};
9854: }
9855: }
9856: } else {
9857: foreach my $key (keys(%{$current_permissions})) {
9858: if ($key =~ /\0accesscontrol$/) {
9859: if (defined($group)) {
9860: if ($key !~ m-^\Q$group\E/-) {
9861: next;
9862: }
9863: }
9864: my ($fullpath) = split(/\0/,$key);
9865: if (ref($$current_permissions{$key}) eq 'HASH') {
9866: foreach my $control (keys(%{$$current_permissions{$key}})) {
9867: $access{$fullpath}{$control}=$$current_permissions{$fullpath."\0".$control};
9868: }
9869: }
9870: }
9871: }
9872: }
9873: return %access;
9874: }
9875:
9876: sub modify_access_controls {
9877: my ($file_name,$changes,$domain,$user)=@_;
9878: my ($outcome,$deloutcome);
9879: my %store_permissions;
9880: my %new_values;
9881: my %new_control;
9882: my %translation;
9883: my @deletions = ();
9884: my $now = time;
9885: if (exists($$changes{'activate'})) {
9886: if (ref($$changes{'activate'}) eq 'HASH') {
9887: my @newitems = sort(keys(%{$$changes{'activate'}}));
9888: my $numnew = scalar(@newitems);
9889: for (my $i=0; $i<$numnew; $i++) {
9890: my $newkey = $newitems[$i];
9891: my $newid = &Apache::loncommon::get_cgi_id();
9892: if ($newkey =~ /^\d+:/) {
9893: $newkey =~ s/^(\d+)/$newid/;
9894: $translation{$1} = $newid;
9895: } elsif ($newkey =~ /^\d+_\d+_\d+:/) {
9896: $newkey =~ s/^(\d+_\d+_\d+)/$newid/;
9897: $translation{$1} = $newid;
9898: }
9899: $new_values{$file_name."\0".$newkey} =
9900: $$changes{'activate'}{$newitems[$i]};
9901: $new_control{$newkey} = $now;
9902: }
9903: }
9904: }
9905: my %todelete;
9906: my %changed_items;
9907: foreach my $action ('delete','update') {
9908: if (exists($$changes{$action})) {
9909: if (ref($$changes{$action}) eq 'HASH') {
9910: foreach my $key (keys(%{$$changes{$action}})) {
9911: my ($itemnum) = ($key =~ /^([^:]+):/);
9912: if ($action eq 'delete') {
9913: $todelete{$itemnum} = 1;
9914: } else {
9915: $changed_items{$itemnum} = $key;
9916: }
9917: }
9918: }
9919: }
9920: }
9921: # get lock on access controls for file.
9922: my $lockhash = {
9923: $file_name."\0".'locked_access_records' => $env{'user.name'}.
9924: ':'.$env{'user.domain'},
9925: };
9926: my $tries = 0;
9927: my $gotlock = &newput('file_permissions',$lockhash,$domain,$user);
9928:
9929: while (($gotlock ne 'ok') && $tries < 10) {
9930: $tries ++;
9931: sleep(0.1);
9932: $gotlock = &newput('file_permissions',$lockhash,$domain,$user);
9933: }
9934: if ($gotlock eq 'ok') {
9935: my %curr_permissions = &dump('file_permissions',$domain,$user,$file_name);
9936: my ($tmp)=keys(%curr_permissions);
9937: if ($tmp=~/^error:/) { undef(%curr_permissions); }
9938: if (exists($curr_permissions{$file_name."\0".'accesscontrol'})) {
9939: my $curr_controls = $curr_permissions{$file_name."\0".'accesscontrol'};
9940: if (ref($curr_controls) eq 'HASH') {
9941: foreach my $control_item (keys(%{$curr_controls})) {
9942: my ($itemnum) = ($control_item =~ /^([^:]+):/);
9943: if (defined($todelete{$itemnum})) {
9944: push(@deletions,$file_name."\0".$control_item);
9945: } else {
9946: if (defined($changed_items{$itemnum})) {
9947: $new_control{$changed_items{$itemnum}} = $now;
9948: push(@deletions,$file_name."\0".$control_item);
9949: $new_values{$file_name."\0".$changed_items{$itemnum}} = $$changes{'update'}{$changed_items{$itemnum}};
9950: } else {
9951: $new_control{$control_item} = $$curr_controls{$control_item};
9952: }
9953: }
9954: }
9955: }
9956: }
9957: my ($group);
9958: if (&is_course($domain,$user)) {
9959: ($group,my $file) = split(/\//,$file_name,2);
9960: }
9961: $deloutcome = &del('file_permissions',\@deletions,$domain,$user);
9962: $new_values{$file_name."\0".'accesscontrol'} = \%new_control;
9963: $outcome = &put('file_permissions',\%new_values,$domain,$user);
9964: # remove lock
9965: my @del_lock = ($file_name."\0".'locked_access_records');
9966: my $dellockoutcome = &del('file_permissions',\@del_lock,$domain,$user);
9967: my $sqlresult =
9968: &update_portfolio_table($user,$domain,$file_name,'portfolio_access',
9969: $group);
9970: } else {
9971: $outcome = "error: could not obtain lockfile\n";
9972: }
9973: return ($outcome,$deloutcome,\%new_values,\%translation);
9974: }
9975:
9976: sub make_public_indefinitely {
9977: my ($requrl) = @_;
9978: my $now = time;
9979: my $action = 'activate';
9980: my $aclnum = 0;
9981: if (&is_portfolio_url($requrl)) {
9982: my (undef,$udom,$unum,$file_name,$group) =
9983: &parse_portfolio_url($requrl);
9984: my $current_perms = &get_portfile_permissions($udom,$unum);
9985: my %access_controls = &get_access_controls($current_perms,
9986: $group,$file_name);
9987: foreach my $key (keys(%{$access_controls{$file_name}})) {
9988: my ($num,$scope,$end,$start) =
9989: ($key =~ /^([^:]+):([a-z]+)_(\d*)_?(\d*)$/);
9990: if ($scope eq 'public') {
9991: if ($start <= $now && $end == 0) {
9992: $action = 'none';
9993: } else {
9994: $action = 'update';
9995: $aclnum = $num;
9996: }
9997: last;
9998: }
9999: }
10000: if ($action eq 'none') {
10001: return 'ok';
10002: } else {
10003: my %changes;
10004: my $newend = 0;
10005: my $newstart = $now;
10006: my $newkey = $aclnum.':public_'.$newend.'_'.$newstart;
10007: $changes{$action}{$newkey} = {
10008: type => 'public',
10009: time => {
10010: start => $newstart,
10011: end => $newend,
10012: },
10013: };
10014: my ($outcome,$deloutcome,$new_values,$translation) =
10015: &modify_access_controls($file_name,\%changes,$udom,$unum);
10016: return $outcome;
10017: }
10018: } else {
10019: return 'invalid';
10020: }
10021: }
10022:
10023: #------------------------------------------------------Get Marked as Read Only
10024:
10025: sub get_marked_as_readonly {
10026: my ($domain,$user,$what,$group) = @_;
10027: my $current_permissions = &get_portfile_permissions($domain,$user);
10028: my @readonly_files;
10029: my $cmp1=$what;
10030: if (ref($what)) { $cmp1=join('',@{$what}) };
10031: while (my ($file_name,$value) = each(%{$current_permissions})) {
10032: if (defined($group)) {
10033: if ($file_name !~ m-^\Q$group\E/-) {
10034: next;
10035: }
10036: }
10037: if (ref($value) eq "ARRAY"){
10038: foreach my $stored_what (@{$value}) {
10039: my $cmp2=$stored_what;
10040: if (ref($stored_what) eq 'ARRAY') {
10041: $cmp2=join('',@{$stored_what});
10042: }
10043: if ($cmp1 eq $cmp2) {
10044: push(@readonly_files, $file_name);
10045: last;
10046: } elsif (!defined($what)) {
10047: push(@readonly_files, $file_name);
10048: last;
10049: }
10050: }
10051: }
10052: }
10053: return @readonly_files;
10054: }
10055: #-----------------------------------------------------------Get Marked as Read Only Hash
10056:
10057: sub get_marked_as_readonly_hash {
10058: my ($current_permissions,$group,$what) = @_;
10059: my %readonly_files;
10060: while (my ($file_name,$value) = each(%{$current_permissions})) {
10061: if (defined($group)) {
10062: if ($file_name !~ m-^\Q$group\E/-) {
10063: next;
10064: }
10065: }
10066: if (ref($value) eq "ARRAY"){
10067: foreach my $stored_what (@{$value}) {
10068: if (ref($stored_what) eq 'ARRAY') {
10069: foreach my $lock_descriptor(@{$stored_what}) {
10070: if ($lock_descriptor eq 'graded') {
10071: $readonly_files{$file_name} = 'graded';
10072: } elsif ($lock_descriptor eq 'handback') {
10073: $readonly_files{$file_name} = 'handback';
10074: } else {
10075: if (!exists($readonly_files{$file_name})) {
10076: $readonly_files{$file_name} = 'locked';
10077: }
10078: }
10079: }
10080: }
10081: }
10082: }
10083: }
10084: return %readonly_files;
10085: }
10086: # ------------------------------------------------------------ Unmark as Read Only
10087:
10088: sub unmark_as_readonly {
10089: # unmarks $file_name (if $file_name is defined), or all files locked by $what
10090: # for portfolio submissions, $what contains [$symb,$crsid]
10091: my ($domain,$user,$what,$file_name,$group) = @_;
10092: $file_name = &declutter_portfile($file_name);
10093: my $symb_crs = $what;
10094: if (ref($what)) { $symb_crs=join('',@$what); }
10095: my %current_permissions = &dump('file_permissions',$domain,$user,$group);
10096: my ($tmp)=keys(%current_permissions);
10097: if ($tmp=~/^error:/) { undef(%current_permissions); }
10098: my @readonly_files = &get_marked_as_readonly($domain,$user,$what,$group);
10099: foreach my $file (@readonly_files) {
10100: my $clean_file = &declutter_portfile($file);
10101: if (defined($file_name) && ($file_name ne $clean_file)) { next; }
10102: my $current_locks = $current_permissions{$file};
10103: my @new_locks;
10104: my @del_keys;
10105: if (ref($current_locks) eq "ARRAY"){
10106: foreach my $locker (@{$current_locks}) {
10107: my $compare=$locker;
10108: if (ref($locker) eq 'ARRAY') {
10109: $compare=join('',@{$locker});
10110: if ($compare ne $symb_crs) {
10111: push(@new_locks, $locker);
10112: }
10113: }
10114: }
10115: if (scalar(@new_locks) > 0) {
10116: $current_permissions{$file} = \@new_locks;
10117: } else {
10118: push(@del_keys, $file);
10119: &del('file_permissions',\@del_keys, $domain, $user);
10120: delete($current_permissions{$file});
10121: }
10122: }
10123: }
10124: &put('file_permissions',\%current_permissions,$domain,$user);
10125: return;
10126: }
10127:
10128: # ------------------------------------------------------------ Directory lister
10129:
10130: sub dirlist {
10131: my ($uri,$userdomain,$username,$getpropath,$getuserdir,$alternateRoot)=@_;
10132: $uri=~s/^\///;
10133: $uri=~s/\/$//;
10134: my ($udom, $uname);
10135: if ($getuserdir) {
10136: $udom = $userdomain;
10137: $uname = $username;
10138: } else {
10139: (undef,$udom,$uname)=split(/\//,$uri);
10140: if(defined($userdomain)) {
10141: $udom = $userdomain;
10142: }
10143: if(defined($username)) {
10144: $uname = $username;
10145: }
10146: }
10147: my ($dirRoot,$listing,@listing_results);
10148:
10149: $dirRoot = $perlvar{'lonDocRoot'};
10150: if (defined($getpropath)) {
10151: $dirRoot = &propath($udom,$uname);
10152: $dirRoot =~ s/\/$//;
10153: } elsif (defined($getuserdir)) {
10154: my $subdir=$uname.'__';
10155: $subdir =~ s/(.)(.)(.).*/$1\/$2\/$3/;
10156: $dirRoot = $Apache::lonnet::perlvar{'lonUsersDir'}
10157: ."/$udom/$subdir/$uname";
10158: } elsif (defined($alternateRoot)) {
10159: $dirRoot = $alternateRoot;
10160: }
10161:
10162: if($udom) {
10163: if($uname) {
10164: my $uhome = &homeserver($uname,$udom);
10165: if ($uhome eq 'no_host') {
10166: return ([],'no_host');
10167: }
10168: $listing = &reply('ls3:'.&escape('/'.$uri).':'.$getpropath.':'
10169: .$getuserdir.':'.&escape($dirRoot)
10170: .':'.&escape($uname).':'.&escape($udom),$uhome);
10171: if ($listing eq 'unknown_cmd') {
10172: $listing = &reply('ls2:'.$dirRoot.'/'.$uri,$uhome);
10173: } else {
10174: @listing_results = map { &unescape($_); } split(/:/,$listing);
10175: }
10176: if ($listing eq 'unknown_cmd') {
10177: $listing = &reply('ls:'.$dirRoot.'/'.$uri,$uhome);
10178: @listing_results = split(/:/,$listing);
10179: } else {
10180: @listing_results = map { &unescape($_); } split(/:/,$listing);
10181: }
10182: if (($listing eq 'no_such_host') || ($listing eq 'con_lost') ||
10183: ($listing eq 'rejected') || ($listing eq 'refused') ||
10184: ($listing eq 'no_such_dir') || ($listing eq 'empty')) {
10185: return ([],$listing);
10186: } else {
10187: return (\@listing_results);
10188: }
10189: } elsif(!$alternateRoot) {
10190: my (%allusers,%listerror);
10191: my %servers = &get_servers($udom,'library');
10192: foreach my $tryserver (keys(%servers)) {
10193: $listing = &reply('ls3:'.&escape("/res/$udom").':::::'.
10194: &escape($udom),$tryserver);
10195: if ($listing eq 'unknown_cmd') {
10196: $listing = &reply('ls2:'.$perlvar{'lonDocRoot'}.'/res/'.
10197: $udom, $tryserver);
10198: } else {
10199: @listing_results = map { &unescape($_); } split(/:/,$listing);
10200: }
10201: if ($listing eq 'unknown_cmd') {
10202: $listing = &reply('ls:'.$perlvar{'lonDocRoot'}.'/res/'.
10203: $udom, $tryserver);
10204: @listing_results = split(/:/,$listing);
10205: } else {
10206: @listing_results =
10207: map { &unescape($_); } split(/:/,$listing);
10208: }
10209: if (($listing eq 'no_such_host') || ($listing eq 'con_lost') ||
10210: ($listing eq 'rejected') || ($listing eq 'refused') ||
10211: ($listing eq 'no_such_dir') || ($listing eq 'empty')) {
10212: $listerror{$tryserver} = $listing;
10213: } else {
10214: foreach my $line (@listing_results) {
10215: my ($entry) = split(/&/,$line,2);
10216: $allusers{$entry} = 1;
10217: }
10218: }
10219: }
10220: my @alluserslist=();
10221: foreach my $user (sort(keys(%allusers))) {
10222: push(@alluserslist,$user.'&user');
10223: }
10224: if (!%listerror) {
10225: # no errors
10226: return (\@alluserslist);
10227: } elsif (scalar(keys(%servers)) == 1) {
10228: # one library server, one error
10229: my ($key) = keys(%listerror);
10230: return (\@alluserslist, $listerror{$key});
10231: } elsif ( grep { $_ eq 'con_lost' } values(%listerror) ) {
10232: # con_lost indicates that we might miss data from at least one
10233: # library server
10234: return (\@alluserslist, 'con_lost');
10235: } else {
10236: # multiple library servers and no con_lost -> data should be
10237: # complete.
10238: return (\@alluserslist);
10239: }
10240:
10241: } else {
10242: return ([],'missing username');
10243: }
10244: } elsif(!defined($getpropath)) {
10245: my $path = $perlvar{'lonDocRoot'}.'/res/';
10246: my @all_domains = map { $path.$_.'/&domain'; } (sort(&all_domains()));
10247: return (\@all_domains);
10248: } else {
10249: return ([],'missing domain');
10250: }
10251: }
10252:
10253: # --------------------------------------------- GetFileTimestamp
10254: # This function utilizes dirlist and returns the date stamp for
10255: # when it was last modified. It will also return an error of -1
10256: # if an error occurs
10257:
10258: sub GetFileTimestamp {
10259: my ($studentDomain,$studentName,$filename,$getuserdir)=@_;
10260: $studentDomain = &LONCAPA::clean_domain($studentDomain);
10261: $studentName = &LONCAPA::clean_username($studentName);
10262: my ($fileref,$error) = &dirlist($filename,$studentDomain,$studentName,
10263: undef,$getuserdir);
10264: if (($error eq 'empty') || ($error eq 'no_such_dir')) {
10265: return -1;
10266: }
10267: if (ref($fileref) eq 'ARRAY') {
10268: my @stats = split('&',$fileref->[0]);
10269: # @stats contains first the filename, then the stat output
10270: return $stats[10]; # so this is 10 instead of 9.
10271: } else {
10272: return -1;
10273: }
10274: }
10275:
10276: sub stat_file {
10277: my ($uri) = @_;
10278: $uri = &clutter_with_no_wrapper($uri);
10279:
10280: my ($udom,$uname,$file);
10281: if ($uri =~ m-^/(uploaded|editupload)/-) {
10282: ($udom,$uname,$file) =
10283: ($uri =~ m-/(?:uploaded|editupload)/?($match_domain)/?($match_name)/?(.*)-);
10284: $file = 'userfiles/'.$file;
10285: }
10286: if ($uri =~ m-^/res/-) {
10287: ($udom,$uname) =
10288: ($uri =~ m-/(?:res)/?($match_domain)/?($match_username)/-);
10289: $file = $uri;
10290: }
10291:
10292: if (!$udom || !$uname || !$file) {
10293: # unable to handle the uri
10294: return ();
10295: }
10296: my $getpropath;
10297: if ($file =~ /^userfiles\//) {
10298: $getpropath = 1;
10299: }
10300: my ($listref,$error) = &dirlist($file,$udom,$uname,$getpropath);
10301: if (($error eq 'empty') || ($error eq 'no_such_dir')) {
10302: return ();
10303: } else {
10304: if (ref($listref) eq 'ARRAY') {
10305: my @stats = split('&',$listref->[0]);
10306: shift(@stats); #filename is first
10307: return @stats;
10308: }
10309: }
10310: return ();
10311: }
10312:
10313: # -------------------------------------------------------- Value of a Condition
10314:
10315: # gets the value of a specific preevaluated condition
10316: # stored in the string $env{user.state.<cid>}
10317: # or looks up a condition reference in the bighash and if if hasn't
10318: # already been evaluated recurses into docondval to get the value of
10319: # the condition, then memoizing it to
10320: # $env{user.state.<cid>.<condition>}
10321: sub directcondval {
10322: my $number=shift;
10323: if (!defined($env{'user.state.'.$env{'request.course.id'}})) {
10324: &Apache::lonuserstate::evalstate();
10325: }
10326: if (exists($env{'user.state.'.$env{'request.course.id'}.".$number"})) {
10327: return $env{'user.state.'.$env{'request.course.id'}.".$number"};
10328: } elsif ($number =~ /^_/) {
10329: my $sub_condition;
10330: if (tie(my %bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
10331: &GDBM_READER(),0640)) {
10332: $sub_condition=$bighash{'conditions'.$number};
10333: untie(%bighash);
10334: }
10335: my $value = &docondval($sub_condition);
10336: &appenv({'user.state.'.$env{'request.course.id'}.".$number" => $value});
10337: return $value;
10338: }
10339: if ($env{'user.state.'.$env{'request.course.id'}}) {
10340: return substr($env{'user.state.'.$env{'request.course.id'}},$number,1);
10341: } else {
10342: return 2;
10343: }
10344: }
10345:
10346: # get the collection of conditions for this resource
10347: sub condval {
10348: my $condidx=shift;
10349: my $allpathcond='';
10350: foreach my $cond (split(/\|/,$condidx)) {
10351: if (defined($env{'acc.cond.'.$env{'request.course.id'}.'.'.$cond})) {
10352: $allpathcond.=
10353: '('.$env{'acc.cond.'.$env{'request.course.id'}.'.'.$cond}.')|';
10354: }
10355: }
10356: $allpathcond=~s/\|$//;
10357: return &docondval($allpathcond);
10358: }
10359:
10360: #evaluates an expression of conditions
10361: sub docondval {
10362: my ($allpathcond) = @_;
10363: my $result=0;
10364: if ($env{'request.course.id'}
10365: && defined($allpathcond)) {
10366: my $operand='|';
10367: my @stack;
10368: foreach my $chunk ($allpathcond=~/(\d+|_\d+\.\d+|\(|\)|\&|\|)/g) {
10369: if ($chunk eq '(') {
10370: push @stack,($operand,$result);
10371: } elsif ($chunk eq ')') {
10372: my $before=pop @stack;
10373: if (pop @stack eq '&') {
10374: $result=$result>$before?$before:$result;
10375: } else {
10376: $result=$result>$before?$result:$before;
10377: }
10378: } elsif (($chunk eq '&') || ($chunk eq '|')) {
10379: $operand=$chunk;
10380: } else {
10381: my $new=directcondval($chunk);
10382: if ($operand eq '&') {
10383: $result=$result>$new?$new:$result;
10384: } else {
10385: $result=$result>$new?$result:$new;
10386: }
10387: }
10388: }
10389: }
10390: return $result;
10391: }
10392:
10393: # ---------------------------------------------------- Devalidate courseresdata
10394:
10395: sub devalidatecourseresdata {
10396: my ($coursenum,$coursedomain)=@_;
10397: my $hashid=$coursenum.':'.$coursedomain;
10398: &devalidate_cache_new('courseres',$hashid);
10399: }
10400:
10401:
10402: # --------------------------------------------------- Course Resourcedata Query
10403: #
10404: # Parameters:
10405: # $coursenum - Number of the course.
10406: # $coursedomain - Domain at which the course was created.
10407: # Returns:
10408: # A hash of the course parameters along (I think) with timestamps
10409: # and version info.
10410:
10411: sub get_courseresdata {
10412: my ($coursenum,$coursedomain)=@_;
10413: my $coursehom=&homeserver($coursenum,$coursedomain);
10414: my $hashid=$coursenum.':'.$coursedomain;
10415: my ($result,$cached)=&is_cached_new('courseres',$hashid);
10416: my %dumpreply;
10417: unless (defined($cached)) {
10418: %dumpreply=&dump('resourcedata',$coursedomain,$coursenum);
10419: $result=\%dumpreply;
10420: my ($tmp) = keys(%dumpreply);
10421: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
10422: &do_cache_new('courseres',$hashid,$result,600);
10423: } elsif ($tmp =~ /^(con_lost|no_such_host)/) {
10424: return $tmp;
10425: } elsif ($tmp =~ /^(error)/) {
10426: $result=undef;
10427: &do_cache_new('courseres',$hashid,$result,600);
10428: }
10429: }
10430: return $result;
10431: }
10432:
10433: sub devalidateuserresdata {
10434: my ($uname,$udom)=@_;
10435: my $hashid="$udom:$uname";
10436: &devalidate_cache_new('userres',$hashid);
10437: }
10438:
10439: sub get_userresdata {
10440: my ($uname,$udom)=@_;
10441: #most student don\'t have any data set, check if there is some data
10442: if (&EXT_cache_status($udom,$uname)) { return undef; }
10443:
10444: my $hashid="$udom:$uname";
10445: my ($result,$cached)=&is_cached_new('userres',$hashid);
10446: if (!defined($cached)) {
10447: my %resourcedata=&dump('resourcedata',$udom,$uname);
10448: $result=\%resourcedata;
10449: &do_cache_new('userres',$hashid,$result,600);
10450: }
10451: my ($tmp)=keys(%$result);
10452: if (($tmp!~/^error\:/) && ($tmp!~/^con_lost/)) {
10453: return $result;
10454: }
10455: #error 2 occurs when the .db doesn't exist
10456: if ($tmp!~/error: 2 /) {
10457: if ((!defined($cached)) || ($tmp ne 'con_lost')) {
10458: &logthis("<font color=\"blue\">WARNING:".
10459: " Trying to get resource data for ".
10460: $uname." at ".$udom.": ".
10461: $tmp."</font>");
10462: }
10463: } elsif ($tmp=~/error: 2 /) {
10464: #&EXT_cache_set($udom,$uname);
10465: &do_cache_new('userres',$hashid,undef,600);
10466: undef($tmp); # not really an error so don't send it back
10467: }
10468: return $tmp;
10469: }
10470: #----------------------------------------------- resdata - return resource data
10471: # Purpose:
10472: # Return resource data for either users or for a course.
10473: # Parameters:
10474: # $name - Course/user name.
10475: # $domain - Name of the domain the user/course is registered on.
10476: # $type - Type of thing $name is (must be 'course' or 'user'
10477: # @which - Array of names of resources desired.
10478: # Returns:
10479: # The value of the first reasource in @which that is found in the
10480: # resource hash.
10481: # Exceptional Conditions:
10482: # If the $type passed in is not valid (not the string 'course' or
10483: # 'user', an undefined reference is returned.
10484: # If none of the resources are found, an undef is returned
10485: sub resdata {
10486: my ($name,$domain,$type,@which)=@_;
10487: my $result;
10488: if ($type eq 'course') {
10489: $result=&get_courseresdata($name,$domain);
10490: } elsif ($type eq 'user') {
10491: $result=&get_userresdata($name,$domain);
10492: }
10493: if (!ref($result)) { return $result; }
10494: foreach my $item (@which) {
10495: if (defined($result->{$item->[0]})) {
10496: return [$result->{$item->[0]},$item->[1]];
10497: }
10498: }
10499: return undef;
10500: }
10501:
10502: sub get_numsuppfiles {
10503: my ($cnum,$cdom,$ignorecache)=@_;
10504: my $hashid=$cnum.':'.$cdom;
10505: my ($suppcount,$cached);
10506: unless ($ignorecache) {
10507: ($suppcount,$cached) = &is_cached_new('suppcount',$hashid);
10508: }
10509: unless (defined($cached)) {
10510: my $chome=&homeserver($cnum,$cdom);
10511: unless ($chome eq 'no_host') {
10512: ($suppcount,my $errors) = (0,0);
10513: my $suppmap = 'supplemental.sequence';
10514: ($suppcount,$errors) =
10515: &Apache::loncommon::recurse_supplemental($cnum,$cdom,$suppmap,$suppcount,$errors);
10516: }
10517: &do_cache_new('suppcount',$hashid,$suppcount,600);
10518: }
10519: return $suppcount;
10520: }
10521:
10522: #
10523: # EXT resource caching routines
10524: #
10525:
10526: sub clear_EXT_cache_status {
10527: &delenv('cache.EXT.');
10528: }
10529:
10530: sub EXT_cache_status {
10531: my ($target_domain,$target_user) = @_;
10532: my $cachename = 'cache.EXT.'.$target_user.'.'.$target_domain;
10533: if (exists($env{$cachename}) && ($env{$cachename}+600) > time) {
10534: # We know already the user has no data
10535: return 1;
10536: } else {
10537: return 0;
10538: }
10539: }
10540:
10541: sub EXT_cache_set {
10542: my ($target_domain,$target_user) = @_;
10543: my $cachename = 'cache.EXT.'.$target_user.'.'.$target_domain;
10544: #&appenv({$cachename => time});
10545: }
10546:
10547: # --------------------------------------------------------- Value of a Variable
10548: sub EXT {
10549:
10550: my ($varname,$symbparm,$udom,$uname,$usection,$recurse,$cid)=@_;
10551: unless ($varname) { return ''; }
10552: #get real user name/domain, courseid and symb
10553: my $courseid;
10554: my $publicuser;
10555: if ($symbparm) {
10556: $symbparm=&get_symb_from_alias($symbparm);
10557: }
10558: if (!($uname && $udom)) {
10559: (my $cursymb,$courseid,$udom,$uname,$publicuser)= &whichuser($symbparm);
10560: if (!$symbparm) { $symbparm=$cursymb; }
10561: } else {
10562: $courseid=$env{'request.course.id'};
10563: }
10564: my ($realm,$space,$qualifier,@therest)=split(/\./,$varname);
10565: my $rest;
10566: if (defined($therest[0])) {
10567: $rest=join('.',@therest);
10568: } else {
10569: $rest='';
10570: }
10571:
10572: my $qualifierrest=$qualifier;
10573: if ($rest) { $qualifierrest.='.'.$rest; }
10574: my $spacequalifierrest=$space;
10575: if ($qualifierrest) { $spacequalifierrest.='.'.$qualifierrest; }
10576: if ($realm eq 'user') {
10577: # --------------------------------------------------------------- user.resource
10578: if ($space eq 'resource') {
10579: if ( (defined($Apache::lonhomework::parsing_a_problem)
10580: || defined($Apache::lonhomework::parsing_a_task))
10581: &&
10582: ($symbparm eq &symbread()) ) {
10583: # if we are in the middle of processing the resource the
10584: # get the value we are planning on committing
10585: if (defined($Apache::lonhomework::results{$qualifierrest})) {
10586: return $Apache::lonhomework::results{$qualifierrest};
10587: } else {
10588: return $Apache::lonhomework::history{$qualifierrest};
10589: }
10590: } else {
10591: my %restored;
10592: if ($publicuser || $env{'request.state'} eq 'construct') {
10593: %restored=&tmprestore($symbparm,$courseid,$udom,$uname);
10594: } else {
10595: %restored=&restore($symbparm,$courseid,$udom,$uname);
10596: }
10597: return $restored{$qualifierrest};
10598: }
10599: # ----------------------------------------------------------------- user.access
10600: } elsif ($space eq 'access') {
10601: # FIXME - not supporting calls for a specific user
10602: return &allowed($qualifier,$rest);
10603: # ------------------------------------------ user.preferences, user.environment
10604: } elsif (($space eq 'preferences') || ($space eq 'environment')) {
10605: if (($uname eq $env{'user.name'}) &&
10606: ($udom eq $env{'user.domain'})) {
10607: return $env{join('.',('environment',$qualifierrest))};
10608: } else {
10609: my %returnhash;
10610: if (!$publicuser) {
10611: %returnhash=&userenvironment($udom,$uname,
10612: $qualifierrest);
10613: }
10614: return $returnhash{$qualifierrest};
10615: }
10616: # ----------------------------------------------------------------- user.course
10617: } elsif ($space eq 'course') {
10618: # FIXME - not supporting calls for a specific user
10619: return $env{join('.',('request.course',$qualifier))};
10620: # ------------------------------------------------------------------- user.role
10621: } elsif ($space eq 'role') {
10622: # FIXME - not supporting calls for a specific user
10623: my ($role,$where)=split(/\./,$env{'request.role'});
10624: if ($qualifier eq 'value') {
10625: return $role;
10626: } elsif ($qualifier eq 'extent') {
10627: return $where;
10628: }
10629: # ----------------------------------------------------------------- user.domain
10630: } elsif ($space eq 'domain') {
10631: return $udom;
10632: # ------------------------------------------------------------------- user.name
10633: } elsif ($space eq 'name') {
10634: return $uname;
10635: # ---------------------------------------------------- Any other user namespace
10636: } else {
10637: my %reply;
10638: if (!$publicuser) {
10639: %reply=&get($space,[$qualifierrest],$udom,$uname);
10640: }
10641: return $reply{$qualifierrest};
10642: }
10643: } elsif ($realm eq 'query') {
10644: # ---------------------------------------------- pull stuff out of query string
10645: &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},
10646: [$spacequalifierrest]);
10647: return $env{'form.'.$spacequalifierrest};
10648: } elsif ($realm eq 'request') {
10649: # ------------------------------------------------------------- request.browser
10650: if ($space eq 'browser') {
10651: return $env{'browser.'.$qualifier};
10652: # ------------------------------------------------------------ request.filename
10653: } else {
10654: return $env{'request.'.$spacequalifierrest};
10655: }
10656: } elsif ($realm eq 'course') {
10657: # ---------------------------------------------------------- course.description
10658: return $env{'course.'.$courseid.'.'.$spacequalifierrest};
10659: } elsif ($realm eq 'resource') {
10660:
10661: if (defined($courseid) && $courseid eq $env{'request.course.id'}) {
10662: if (!$symbparm) { $symbparm=&symbread(); }
10663: }
10664:
10665: if ($qualifier eq '') {
10666: if ($space eq 'title') {
10667: if (!$symbparm) { $symbparm = $env{'request.filename'}; }
10668: return &gettitle($symbparm);
10669: }
10670:
10671: if ($space eq 'map') {
10672: my ($map) = &decode_symb($symbparm);
10673: return &symbread($map);
10674: }
10675: if ($space eq 'maptitle') {
10676: my ($map) = &decode_symb($symbparm);
10677: return &gettitle($map);
10678: }
10679: if ($space eq 'filename') {
10680: if ($symbparm) {
10681: return &clutter((&decode_symb($symbparm))[2]);
10682: }
10683: return &hreflocation('',$env{'request.filename'});
10684: }
10685:
10686: if ((defined($courseid)) && ($courseid eq $env{'request.course.id'}) && $symbparm) {
10687: if ($space eq 'visibleparts') {
10688: my $navmap = Apache::lonnavmaps::navmap->new();
10689: my $item;
10690: if (ref($navmap)) {
10691: my $res = $navmap->getBySymb($symbparm);
10692: my $parts = $res->parts();
10693: if (ref($parts) eq 'ARRAY') {
10694: $item = join(',',@{$parts});
10695: }
10696: undef($navmap);
10697: }
10698: return $item;
10699: }
10700: }
10701: }
10702:
10703: my ($section, $group, @groups);
10704: my ($courselevelm,$courselevel);
10705: if (($courseid eq '') && ($cid)) {
10706: $courseid = $cid;
10707: }
10708: if (($symbparm && $courseid) &&
10709: (($courseid eq $env{'request.course.id'}) || ($courseid eq $cid))) {
10710:
10711: #print '<br>'.$space.' - '.$qualifier.' - '.$spacequalifierrest;
10712:
10713: # ----------------------------------------------------- Cascading lookup scheme
10714: my $symbp=$symbparm;
10715: my $mapp=&deversion((&decode_symb($symbp))[0]);
10716:
10717: my $symbparm=$symbp.'.'.$spacequalifierrest;
10718: my $mapparm=$mapp.'___(all).'.$spacequalifierrest;
10719:
10720: if (($env{'user.name'} eq $uname) &&
10721: ($env{'user.domain'} eq $udom)) {
10722: $section=$env{'request.course.sec'};
10723: @groups = split(/:/,$env{'request.course.groups'});
10724: @groups=&sort_course_groups($courseid,@groups);
10725: } else {
10726: if (! defined($usection)) {
10727: $section=&getsection($udom,$uname,$courseid);
10728: } else {
10729: $section = $usection;
10730: }
10731: @groups = &get_users_groups($udom,$uname,$courseid);
10732: }
10733:
10734: my $seclevel=$courseid.'.['.$section.'].'.$spacequalifierrest;
10735: my $seclevelr=$courseid.'.['.$section.'].'.$symbparm;
10736: my $seclevelm=$courseid.'.['.$section.'].'.$mapparm;
10737:
10738: $courselevel=$courseid.'.'.$spacequalifierrest;
10739: my $courselevelr=$courseid.'.'.$symbparm;
10740: $courselevelm=$courseid.'.'.$mapparm;
10741:
10742: # ----------------------------------------------------------- first, check user
10743:
10744: my $userreply=&resdata($uname,$udom,'user',
10745: ([$courselevelr,'resource'],
10746: [$courselevelm,'map' ],
10747: [$courselevel, 'course' ]));
10748: if (defined($userreply)) { return &get_reply($userreply); }
10749:
10750: # ------------------------------------------------ second, check some of course
10751: my $coursereply;
10752: if (@groups > 0) {
10753: $coursereply = &check_group_parms($courseid,\@groups,$symbparm,
10754: $mapparm,$spacequalifierrest);
10755: if (defined($coursereply)) { return &get_reply($coursereply); }
10756: }
10757:
10758: $coursereply=&resdata($env{'course.'.$courseid.'.num'},
10759: $env{'course.'.$courseid.'.domain'},
10760: 'course',
10761: ([$seclevelr, 'resource'],
10762: [$seclevelm, 'map' ],
10763: [$seclevel, 'course' ],
10764: [$courselevelr,'resource']));
10765: if (defined($coursereply)) { return &get_reply($coursereply); }
10766:
10767: # ------------------------------------------------------ third, check map parms
10768: my %parmhash=();
10769: my $thisparm='';
10770: if (tie(%parmhash,'GDBM_File',
10771: $env{'request.course.fn'}.'_parms.db',
10772: &GDBM_READER(),0640)) {
10773: $thisparm=$parmhash{$symbparm};
10774: untie(%parmhash);
10775: }
10776: if ($thisparm) { return &get_reply([$thisparm,'resource']); }
10777: }
10778: # ------------------------------------------ fourth, look in resource metadata
10779:
10780: $spacequalifierrest=~s/\./\_/;
10781: my $filename;
10782: if (!$symbparm) { $symbparm=&symbread(); }
10783: if ($symbparm) {
10784: $filename=(&decode_symb($symbparm))[2];
10785: } else {
10786: $filename=$env{'request.filename'};
10787: }
10788: my $metadata=&metadata($filename,$spacequalifierrest);
10789: if (defined($metadata)) { return &get_reply([$metadata,'resource']); }
10790: $metadata=&metadata($filename,'parameter_'.$spacequalifierrest);
10791: if (defined($metadata)) { return &get_reply([$metadata,'resource']); }
10792:
10793: # ---------------------------------------------- fourth, look in rest of course
10794: if ($symbparm && defined($courseid) &&
10795: $courseid eq $env{'request.course.id'}) {
10796: my $coursereply=&resdata($env{'course.'.$courseid.'.num'},
10797: $env{'course.'.$courseid.'.domain'},
10798: 'course',
10799: ([$courselevelm,'map' ],
10800: [$courselevel, 'course']));
10801: if (defined($coursereply)) { return &get_reply($coursereply); }
10802: }
10803: # ------------------------------------------------------------------ Cascade up
10804: unless ($space eq '0') {
10805: my @parts=split(/_/,$space);
10806: my $id=pop(@parts);
10807: my $part=join('_',@parts);
10808: if ($part eq '') { $part='0'; }
10809: my @partgeneral=&EXT('resource.'.$part.'.'.$qualifierrest,
10810: $symbparm,$udom,$uname,$section,1);
10811: if (defined($partgeneral[0])) { return &get_reply(\@partgeneral); }
10812: }
10813: if ($recurse) { return undef; }
10814: my $pack_def=&packages_tab_default($filename,$varname);
10815: if (defined($pack_def)) { return &get_reply([$pack_def,'resource']); }
10816: # ---------------------------------------------------- Any other user namespace
10817: } elsif ($realm eq 'environment') {
10818: # ----------------------------------------------------------------- environment
10819: if (($uname eq $env{'user.name'})&&($udom eq $env{'user.domain'})) {
10820: return $env{'environment.'.$spacequalifierrest};
10821: } else {
10822: if ($uname eq 'anonymous' && $udom eq '') {
10823: return '';
10824: }
10825: my %returnhash=&userenvironment($udom,$uname,
10826: $spacequalifierrest);
10827: return $returnhash{$spacequalifierrest};
10828: }
10829: } elsif ($realm eq 'system') {
10830: # ----------------------------------------------------------------- system.time
10831: if ($space eq 'time') {
10832: return time;
10833: }
10834: } elsif ($realm eq 'server') {
10835: # ----------------------------------------------------------------- system.time
10836: if ($space eq 'name') {
10837: return $ENV{'SERVER_NAME'};
10838: }
10839: }
10840: return '';
10841: }
10842:
10843: sub get_reply {
10844: my ($reply_value) = @_;
10845: if (ref($reply_value) eq 'ARRAY') {
10846: if (wantarray) {
10847: return @$reply_value;
10848: }
10849: return $reply_value->[0];
10850: } else {
10851: return $reply_value;
10852: }
10853: }
10854:
10855: sub check_group_parms {
10856: my ($courseid,$groups,$symbparm,$mapparm,$what) = @_;
10857: my @groupitems = ();
10858: my $resultitem;
10859: my @levels = ([$symbparm,'resource'],[$mapparm,'map'],[$what,'course']);
10860: foreach my $group (@{$groups}) {
10861: foreach my $level (@levels) {
10862: my $item = $courseid.'.['.$group.'].'.$level->[0];
10863: push(@groupitems,[$item,$level->[1]]);
10864: }
10865: }
10866: my $coursereply = &resdata($env{'course.'.$courseid.'.num'},
10867: $env{'course.'.$courseid.'.domain'},
10868: 'course',@groupitems);
10869: return $coursereply;
10870: }
10871:
10872: sub sort_course_groups { # Sort groups based on defined rankings. Default is sort().
10873: my ($courseid,@groups) = @_;
10874: @groups = sort(@groups);
10875: return @groups;
10876: }
10877:
10878: sub packages_tab_default {
10879: my ($uri,$varname)=@_;
10880: my (undef,$part,$name)=split(/\./,$varname);
10881:
10882: my (@extension,@specifics,$do_default);
10883: foreach my $package (split(/,/,&metadata($uri,'packages'))) {
10884: my ($pack_type,$pack_part)=split(/_/,$package,2);
10885: if ($pack_type eq 'default') {
10886: $do_default=1;
10887: } elsif ($pack_type eq 'extension') {
10888: push(@extension,[$package,$pack_type,$pack_part]);
10889: } elsif ($pack_part eq $part || $pack_type eq 'part') {
10890: # only look at packages defaults for packages that this id is
10891: push(@specifics,[$package,$pack_type,$pack_part]);
10892: }
10893: }
10894: # first look for a package that matches the requested part id
10895: foreach my $package (@specifics) {
10896: my (undef,$pack_type,$pack_part)=@{$package};
10897: next if ($pack_part ne $part);
10898: if (defined($packagetab{"$pack_type&$name&default"})) {
10899: return $packagetab{"$pack_type&$name&default"};
10900: }
10901: }
10902: # look for any possible matching non extension_ package
10903: foreach my $package (@specifics) {
10904: my (undef,$pack_type,$pack_part)=@{$package};
10905: if (defined($packagetab{"$pack_type&$name&default"})) {
10906: return $packagetab{"$pack_type&$name&default"};
10907: }
10908: if ($pack_type eq 'part') { $pack_part='0'; }
10909: if (defined($packagetab{$pack_type."_".$pack_part."&$name&default"})) {
10910: return $packagetab{$pack_type."_".$pack_part."&$name&default"};
10911: }
10912: }
10913: # look for any posible extension_ match
10914: foreach my $package (@extension) {
10915: my ($package,$pack_type)=@{$package};
10916: if (defined($packagetab{"$pack_type&$name&default"})) {
10917: return $packagetab{"$pack_type&$name&default"};
10918: }
10919: if (defined($packagetab{$package."&$name&default"})) {
10920: return $packagetab{$package."&$name&default"};
10921: }
10922: }
10923: # look for a global default setting
10924: if ($do_default && defined($packagetab{"default&$name&default"})) {
10925: return $packagetab{"default&$name&default"};
10926: }
10927: return undef;
10928: }
10929:
10930: sub add_prefix_and_part {
10931: my ($prefix,$part)=@_;
10932: my $keyroot;
10933: if (defined($prefix) && $prefix !~ /^__/) {
10934: # prefix that has a part already
10935: $keyroot=$prefix;
10936: } elsif (defined($prefix)) {
10937: # prefix that is missing a part
10938: if (defined($part)) { $keyroot='_'.$part.substr($prefix,1); }
10939: } else {
10940: # no prefix at all
10941: if (defined($part)) { $keyroot='_'.$part; }
10942: }
10943: return $keyroot;
10944: }
10945:
10946: # ---------------------------------------------------------------- Get metadata
10947:
10948: my %metaentry;
10949: my %importedpartids;
10950: sub metadata {
10951: my ($uri,$what,$liburi,$prefix,$depthcount)=@_;
10952: $uri=&declutter($uri);
10953: # if it is a non metadata possible uri return quickly
10954: if (($uri eq '') ||
10955: (($uri =~ m|^/*adm/|) &&
10956: ($uri !~ m|^adm/includes|) && ($uri !~ m{/(smppg|bulletinboard)$})) ||
10957: ($uri =~ m|/$|) || ($uri =~ m|/.meta$|) || ($uri =~ m{^/*uploaded/.+\.sequence$})) {
10958: return undef;
10959: }
10960: if (($uri =~ /^priv/ || $uri=~m{^home/httpd/html/priv})
10961: && &Apache::lonxml::get_state('target') =~ /^(|meta)$/) {
10962: return undef;
10963: }
10964: my $filename=$uri;
10965: $uri=~s/\.meta$//;
10966: #
10967: # Is the metadata already cached?
10968: # Look at timestamp of caching
10969: # Everything is cached by the main uri, libraries are never directly cached
10970: #
10971: if (!defined($liburi)) {
10972: my ($result,$cached)=&is_cached_new('meta',$uri);
10973: if (defined($cached)) { return $result->{':'.$what}; }
10974: }
10975: {
10976: # Imported parts would go here
10977: my %importedids=();
10978: my @origfileimportpartids=();
10979: my $importedparts=0;
10980: #
10981: # Is this a recursive call for a library?
10982: #
10983: # if (! exists($metacache{$uri})) {
10984: # $metacache{$uri}={};
10985: # }
10986: my $cachetime = 60*60;
10987: if ($liburi) {
10988: $liburi=&declutter($liburi);
10989: $filename=$liburi;
10990: } else {
10991: &devalidate_cache_new('meta',$uri);
10992: undef(%metaentry);
10993: }
10994: my %metathesekeys=();
10995: unless ($filename=~/\.meta$/) { $filename.='.meta'; }
10996: my $metastring;
10997: if ($uri =~ /^priv/ || $uri=~/home\/httpd\/html\/priv/) {
10998: my $which = &hreflocation('','/'.($liburi || $uri));
10999: $metastring =
11000: &Apache::lonnet::ssi_body($which,
11001: ('grade_target' => 'meta'));
11002: $cachetime = 1; # only want this cached in the child not long term
11003: } elsif (($uri !~ m -^(editupload)/-) &&
11004: ($uri !~ m{^/*uploaded/$match_domain/$match_courseid/docs/})) {
11005: my $file=&filelocation('',&clutter($filename));
11006: #push(@{$metaentry{$uri.'.file'}},$file);
11007: $metastring=&getfile($file);
11008: }
11009: my $parser=HTML::LCParser->new(\$metastring);
11010: my $token;
11011: undef %metathesekeys;
11012: while ($token=$parser->get_token) {
11013: if ($token->[0] eq 'S') {
11014: if (defined($token->[2]->{'package'})) {
11015: #
11016: # This is a package - get package info
11017: #
11018: my $package=$token->[2]->{'package'};
11019: my $keyroot=&add_prefix_and_part($prefix,$token->[2]->{'part'});
11020: if (defined($token->[2]->{'id'})) {
11021: $keyroot.='_'.$token->[2]->{'id'};
11022: }
11023: if ($metaentry{':packages'}) {
11024: $metaentry{':packages'}.=','.$package.$keyroot;
11025: } else {
11026: $metaentry{':packages'}=$package.$keyroot;
11027: }
11028: foreach my $pack_entry (keys(%packagetab)) {
11029: my $part=$keyroot;
11030: $part=~s/^\_//;
11031: if ($pack_entry=~/^\Q$package\E\&/ ||
11032: $pack_entry=~/^\Q$package\E_0\&/) {
11033: my ($pack,$name,$subp)=split(/\&/,$pack_entry);
11034: # ignore package.tab specified default values
11035: # here &package_tab_default() will fetch those
11036: if ($subp eq 'default') { next; }
11037: my $value=$packagetab{$pack_entry};
11038: my $unikey;
11039: if ($pack =~ /_0$/) {
11040: $unikey='parameter_0_'.$name;
11041: $part=0;
11042: } else {
11043: $unikey='parameter'.$keyroot.'_'.$name;
11044: }
11045: if ($subp eq 'display') {
11046: $value.=' [Part: '.$part.']';
11047: }
11048: $metaentry{':'.$unikey.'.part'}=$part;
11049: $metathesekeys{$unikey}=1;
11050: unless (defined($metaentry{':'.$unikey.'.'.$subp})) {
11051: $metaentry{':'.$unikey.'.'.$subp}=$value;
11052: }
11053: if (defined($metaentry{':'.$unikey.'.default'})) {
11054: $metaentry{':'.$unikey}=
11055: $metaentry{':'.$unikey.'.default'};
11056: }
11057: }
11058: }
11059: } else {
11060: #
11061: # This is not a package - some other kind of start tag
11062: #
11063: my $entry=$token->[1];
11064: my $unikey='';
11065:
11066: if ($entry eq 'import') {
11067: #
11068: # Importing a library here
11069: #
11070: my $location=$parser->get_text('/import');
11071: my $dir=$filename;
11072: $dir=~s|[^/]*$||;
11073: $location=&filelocation($dir,$location);
11074:
11075: my $importmode=$token->[2]->{'importmode'};
11076: if ($importmode eq 'problem') {
11077: # Import as problem/response
11078: $unikey=&add_prefix_and_part($prefix,$token->[2]->{'part'});
11079: } elsif ($importmode eq 'part') {
11080: # Import as part(s)
11081: $importedparts=1;
11082: # We need to get the original file and the imported file to get the part order correct
11083: # Good news: we do not need to worry about nested libraries, since parts cannot be nested
11084: # Load and inspect original file
11085: if ($#origfileimportpartids<0) {
11086: undef(%importedpartids);
11087: my $origfilelocation=$perlvar{'lonDocRoot'}.&clutter($uri);
11088: my $origfile=&getfile($origfilelocation);
11089: @origfileimportpartids=($origfile=~/<(part|import)[^>]*id\s*=\s*[\"\']([^\"\']+)[\"\'][^>]*>/gs);
11090: }
11091:
11092: # Load and inspect imported file
11093: my $impfile=&getfile($location);
11094: my @impfilepartids=($impfile=~/<part[^>]*id\s*=\s*[\"\']([^\"\']+)[\"\'][^>]*>/gs);
11095: if ($#impfilepartids>=0) {
11096: # This problem had parts
11097: $importedpartids{$token->[2]->{'id'}}=join(',',@impfilepartids);
11098: } else {
11099: # Importing by turning a single problem into a problem part
11100: # It gets the import-tags ID as part-ID
11101: $unikey=&add_prefix_and_part($prefix,$token->[2]->{'id'});
11102: $importedpartids{$token->[2]->{'id'}}=$token->[2]->{'id'};
11103: }
11104: } else {
11105: # Normal import
11106: $unikey=&add_prefix_and_part($prefix,$token->[2]->{'part'});
11107: if (defined($token->[2]->{'id'})) {
11108: $unikey.='_'.$token->[2]->{'id'};
11109: }
11110: }
11111:
11112: if ($depthcount<20) {
11113: my $metadata =
11114: &metadata($uri,'keys', $location,$unikey,
11115: $depthcount+1);
11116: foreach my $meta (split(',',$metadata)) {
11117: $metaentry{':'.$meta}=$metaentry{':'.$meta};
11118: $metathesekeys{$meta}=1;
11119: }
11120:
11121: }
11122: } else {
11123: #
11124: # Not importing, some other kind of non-package, non-library start tag
11125: #
11126: $unikey=$entry.&add_prefix_and_part($prefix,$token->[2]->{'part'});
11127: if (defined($token->[2]->{'id'})) {
11128: $unikey.='_'.$token->[2]->{'id'};
11129: }
11130: if (defined($token->[2]->{'name'})) {
11131: $unikey.='_'.$token->[2]->{'name'};
11132: }
11133: $metathesekeys{$unikey}=1;
11134: foreach my $param (@{$token->[3]}) {
11135: $metaentry{':'.$unikey.'.'.$param} =
11136: $token->[2]->{$param};
11137: }
11138: my $internaltext=&HTML::Entities::decode($parser->get_text('/'.$entry));
11139: my $default=$metaentry{':'.$unikey.'.default'};
11140: if ( $internaltext =~ /^\s*$/ && $default !~ /^\s*$/) {
11141: # only ws inside the tag, and not in default, so use default
11142: # as value
11143: $metaentry{':'.$unikey}=$default;
11144: } elsif ( $internaltext =~ /\S/ ) {
11145: # something interesting inside the tag
11146: $metaentry{':'.$unikey}=$internaltext;
11147: } else {
11148: # no interesting values, don't set a default
11149: }
11150: # end of not-a-package not-a-library import
11151: }
11152: # end of not-a-package start tag
11153: }
11154: # the next is the end of "start tag"
11155: }
11156: }
11157: my ($extension) = ($uri =~ /\.(\w+)$/);
11158: $extension = lc($extension);
11159: if ($extension eq 'htm') { $extension='html'; }
11160:
11161: foreach my $key (keys(%packagetab)) {
11162: #no specific packages #how's our extension
11163: if ($key!~/^extension_\Q$extension\E&/) { next; }
11164: &metadata_create_package_def($uri,$key,'extension_'.$extension,
11165: \%metathesekeys);
11166: }
11167:
11168: if (!exists($metaentry{':packages'})
11169: || $packagetab{"import_defaults&extension_$extension"}) {
11170: foreach my $key (keys(%packagetab)) {
11171: #no specific packages well let's get default then
11172: if ($key!~/^default&/) { next; }
11173: &metadata_create_package_def($uri,$key,'default',
11174: \%metathesekeys);
11175: }
11176: }
11177: # are there custom rights to evaluate
11178: if ($metaentry{':copyright'} eq 'custom') {
11179:
11180: #
11181: # Importing a rights file here
11182: #
11183: unless ($depthcount) {
11184: my $location=$metaentry{':customdistributionfile'};
11185: my $dir=$filename;
11186: $dir=~s|[^/]*$||;
11187: $location=&filelocation($dir,$location);
11188: my $rights_metadata =
11189: &metadata($uri,'keys',$location,'_rights',
11190: $depthcount+1);
11191: foreach my $rights (split(',',$rights_metadata)) {
11192: #$metaentry{':'.$rights}=$metacache{$uri}->{':'.$rights};
11193: $metathesekeys{$rights}=1;
11194: }
11195: }
11196: }
11197: # uniqifiy package listing
11198: my %seen;
11199: my @uniq_packages =
11200: grep { ! $seen{$_} ++ } (split(',',$metaentry{':packages'}));
11201: $metaentry{':packages'} = join(',',@uniq_packages);
11202:
11203: if ($importedparts) {
11204: # We had imported parts and need to rebuild partorder
11205: $metaentry{':partorder'}='';
11206: $metathesekeys{'partorder'}=1;
11207: for (my $index=0;$index<$#origfileimportpartids;$index+=2) {
11208: if ($origfileimportpartids[$index] eq 'part') {
11209: # original part, part of the problem
11210: $metaentry{':partorder'}.=','.$origfileimportpartids[$index+1];
11211: } else {
11212: # we have imported parts at this position
11213: $metaentry{':partorder'}.=','.$importedpartids{$origfileimportpartids[$index+1]};
11214: }
11215: }
11216: $metaentry{':partorder'}=~s/^\,//;
11217: }
11218:
11219: $metaentry{':keys'} = join(',',keys(%metathesekeys));
11220: &metadata_generate_part0(\%metathesekeys,\%metaentry,$uri);
11221: $metaentry{':allpossiblekeys'}=join(',',keys(%metathesekeys));
11222: &do_cache_new('meta',$uri,\%metaentry,$cachetime);
11223: # this is the end of "was not already recently cached
11224: }
11225: return $metaentry{':'.$what};
11226: }
11227:
11228: sub metadata_create_package_def {
11229: my ($uri,$key,$package,$metathesekeys)=@_;
11230: my ($pack,$name,$subp)=split(/\&/,$key);
11231: if ($subp eq 'default') { next; }
11232:
11233: if (defined($metaentry{':packages'})) {
11234: $metaentry{':packages'}.=','.$package;
11235: } else {
11236: $metaentry{':packages'}=$package;
11237: }
11238: my $value=$packagetab{$key};
11239: my $unikey;
11240: $unikey='parameter_0_'.$name;
11241: $metaentry{':'.$unikey.'.part'}=0;
11242: $$metathesekeys{$unikey}=1;
11243: unless (defined($metaentry{':'.$unikey.'.'.$subp})) {
11244: $metaentry{':'.$unikey.'.'.$subp}=$value;
11245: }
11246: if (defined($metaentry{':'.$unikey.'.default'})) {
11247: $metaentry{':'.$unikey}=
11248: $metaentry{':'.$unikey.'.default'};
11249: }
11250: }
11251:
11252: sub metadata_generate_part0 {
11253: my ($metadata,$metacache,$uri) = @_;
11254: my %allnames;
11255: foreach my $metakey (keys(%$metadata)) {
11256: if ($metakey=~/^parameter\_(.*)/) {
11257: my $part=$$metacache{':'.$metakey.'.part'};
11258: my $name=$$metacache{':'.$metakey.'.name'};
11259: if (! exists($$metadata{'parameter_0_'.$name.'.name'})) {
11260: $allnames{$name}=$part;
11261: }
11262: }
11263: }
11264: foreach my $name (keys(%allnames)) {
11265: $$metadata{"parameter_0_$name"}=1;
11266: my $key=":parameter_0_$name";
11267: $$metacache{"$key.part"}='0';
11268: $$metacache{"$key.name"}=$name;
11269: $$metacache{"$key.type"}=$$metacache{':parameter_'.
11270: $allnames{$name}.'_'.$name.
11271: '.type'};
11272: my $olddis=$$metacache{':parameter_'.$allnames{$name}.'_'.$name.
11273: '.display'};
11274: my $expr='[Part: '.$allnames{$name}.']';
11275: $olddis=~s/\Q$expr\E/\[Part: 0\]/;
11276: $$metacache{"$key.display"}=$olddis;
11277: }
11278: }
11279:
11280: # ------------------------------------------------------ Devalidate title cache
11281:
11282: sub devalidate_title_cache {
11283: my ($url)=@_;
11284: if (!$env{'request.course.id'}) { return; }
11285: my $symb=&symbread($url);
11286: if (!$symb) { return; }
11287: my $key=$env{'request.course.id'}."\0".$symb;
11288: &devalidate_cache_new('title',$key);
11289: }
11290:
11291: # ------------------------------------------------- Get the title of a course
11292:
11293: sub current_course_title {
11294: return $env{ 'course.' . $env{'request.course.id'} . '.description' };
11295: }
11296: # ------------------------------------------------- Get the title of a resource
11297:
11298: sub gettitle {
11299: my $urlsymb=shift;
11300: my $symb=&symbread($urlsymb);
11301: if ($symb) {
11302: my $key=$env{'request.course.id'}."\0".$symb;
11303: my ($result,$cached)=&is_cached_new('title',$key);
11304: if (defined($cached)) {
11305: return $result;
11306: }
11307: my ($map,$resid,$url)=&decode_symb($symb);
11308: my $title='';
11309: if (!$map && $resid == 0 && $url =~/default\.sequence$/) {
11310: $title = $env{'course.'.$env{'request.course.id'}.'.description'};
11311: } else {
11312: if (tie(my %bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
11313: &GDBM_READER(),0640)) {
11314: my $mapid=$bighash{'map_pc_'.&clutter($map)};
11315: $title=$bighash{'title_'.$mapid.'.'.$resid};
11316: untie(%bighash);
11317: }
11318: }
11319: $title=~s/\&colon\;/\:/gs;
11320: if ($title) {
11321: # Remember both $symb and $title for dynamic metadata
11322: $accesshash{$symb.'___crstitle'}=$title;
11323: $accesshash{&declutter($map).'___'.&declutter($url).'___usage'}=time;
11324: # Cache this title and then return it
11325: return &do_cache_new('title',$key,$title,600);
11326: }
11327: $urlsymb=$url;
11328: }
11329: my $title=&metadata($urlsymb,'title');
11330: if (!$title) { $title=(split('/',$urlsymb))[-1]; }
11331: return $title;
11332: }
11333:
11334: sub get_slot {
11335: my ($which,$cnum,$cdom)=@_;
11336: if (!$cnum || !$cdom) {
11337: (undef,my $courseid)=&whichuser();
11338: $cdom=$env{'course.'.$courseid.'.domain'};
11339: $cnum=$env{'course.'.$courseid.'.num'};
11340: }
11341: my $key=join("\0",'slots',$cdom,$cnum,$which);
11342: my %slotinfo;
11343: if (exists($remembered{$key})) {
11344: $slotinfo{$which} = $remembered{$key};
11345: } else {
11346: %slotinfo=&get('slots',[$which],$cdom,$cnum);
11347: &Apache::lonhomework::showhash(%slotinfo);
11348: my ($tmp)=keys(%slotinfo);
11349: if ($tmp=~/^error:/) { return (); }
11350: $remembered{$key} = $slotinfo{$which};
11351: }
11352: if (ref($slotinfo{$which}) eq 'HASH') {
11353: return %{$slotinfo{$which}};
11354: }
11355: return $slotinfo{$which};
11356: }
11357:
11358: sub get_reservable_slots {
11359: my ($cnum,$cdom,$uname,$udom) = @_;
11360: my $now = time;
11361: my $reservable_info;
11362: my $key=join("\0",'reservableslots',$cdom,$cnum,$uname,$udom);
11363: if (exists($remembered{$key})) {
11364: $reservable_info = $remembered{$key};
11365: } else {
11366: my %resv;
11367: ($resv{'now_order'},$resv{'now'},$resv{'future_order'},$resv{'future'}) =
11368: &Apache::loncommon::get_future_slots($cnum,$cdom,$now);
11369: $reservable_info = \%resv;
11370: $remembered{$key} = $reservable_info;
11371: }
11372: return $reservable_info;
11373: }
11374:
11375: sub get_course_slots {
11376: my ($cnum,$cdom) = @_;
11377: my $hashid=$cnum.':'.$cdom;
11378: my ($result,$cached) = &Apache::lonnet::is_cached_new('allslots',$hashid);
11379: if (defined($cached)) {
11380: if (ref($result) eq 'HASH') {
11381: return %{$result};
11382: }
11383: } else {
11384: my %slots=&Apache::lonnet::dump('slots',$cdom,$cnum);
11385: my ($tmp) = keys(%slots);
11386: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
11387: &do_cache_new('allslots',$hashid,\%slots,600);
11388: return %slots;
11389: }
11390: }
11391: return;
11392: }
11393:
11394: sub devalidate_slots_cache {
11395: my ($cnum,$cdom)=@_;
11396: my $hashid=$cnum.':'.$cdom;
11397: &devalidate_cache_new('allslots',$hashid);
11398: }
11399:
11400: sub get_coursechange {
11401: my ($cdom,$cnum) = @_;
11402: if ($cdom eq '' || $cnum eq '') {
11403: return unless ($env{'request.course.id'});
11404: $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
11405: $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
11406: }
11407: my $hashid=$cdom.'_'.$cnum;
11408: my ($change,$cached)=&is_cached_new('crschange',$hashid);
11409: if ((defined($cached)) && ($change ne '')) {
11410: return $change;
11411: } else {
11412: my %crshash;
11413: %crshash = &get('environment',['internal.contentchange'],$cdom,$cnum);
11414: if ($crshash{'internal.contentchange'} eq '') {
11415: $change = $env{'course.'.$cdom.'_'.$cnum.'.internal.created'};
11416: if ($change eq '') {
11417: %crshash = &get('environment',['internal.created'],$cdom,$cnum);
11418: $change = $crshash{'internal.created'};
11419: }
11420: } else {
11421: $change = $crshash{'internal.contentchange'};
11422: }
11423: my $cachetime = 600;
11424: &do_cache_new('crschange',$hashid,$change,$cachetime);
11425: }
11426: return $change;
11427: }
11428:
11429: sub devalidate_coursechange_cache {
11430: my ($cnum,$cdom)=@_;
11431: my $hashid=$cnum.':'.$cdom;
11432: &devalidate_cache_new('crschange',$hashid);
11433: }
11434:
11435: # ------------------------------------------------- Update symbolic store links
11436:
11437: sub symblist {
11438: my ($mapname,%newhash)=@_;
11439: $mapname=&deversion(&declutter($mapname));
11440: my %hash;
11441: if (($env{'request.course.fn'}) && (%newhash)) {
11442: if (tie(%hash,'GDBM_File',$env{'request.course.fn'}.'_symb.db',
11443: &GDBM_WRCREAT(),0640)) {
11444: foreach my $url (keys(%newhash)) {
11445: next if ($url eq 'last_known'
11446: && $env{'form.no_update_last_known'});
11447: $hash{declutter($url)}=&encode_symb($mapname,
11448: $newhash{$url}->[1],
11449: $newhash{$url}->[0]);
11450: }
11451: if (untie(%hash)) {
11452: return 'ok';
11453: }
11454: }
11455: }
11456: return 'error';
11457: }
11458:
11459: # --------------------------------------------------------------- Verify a symb
11460:
11461: sub symbverify {
11462: my ($symb,$thisurl,$encstate)=@_;
11463: my $thisfn=$thisurl;
11464: $thisfn=&declutter($thisfn);
11465: # direct jump to resource in page or to a sequence - will construct own symbs
11466: if ($thisfn=~/\.(page|sequence)$/) { return 1; }
11467: # check URL part
11468: my ($map,$resid,$url)=&decode_symb($symb);
11469:
11470: unless ($url eq $thisfn) { return 0; }
11471:
11472: $symb=&symbclean($symb);
11473: $thisurl=&deversion($thisurl);
11474: $thisfn=&deversion($thisfn);
11475:
11476: my %bighash;
11477: my $okay=0;
11478:
11479: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
11480: &GDBM_READER(),0640)) {
11481: my $noclutter;
11482: if (($thisurl =~ m{^/adm/wrapper/ext/}) || ($thisurl =~ m{^ext/})) {
11483: $thisurl =~ s/\?.+$//;
11484: if ($map =~ m{^uploaded/.+\.page$}) {
11485: $thisurl =~ s{^(/adm/wrapper|)/ext/}{http://};
11486: $thisurl =~ s{^\Qhttp://https://\E}{https://};
11487: $noclutter = 1;
11488: }
11489: }
11490: my $ids;
11491: if ($noclutter) {
11492: $ids=$bighash{'ids_'.$thisurl};
11493: } else {
11494: $ids=$bighash{'ids_'.&clutter($thisurl)};
11495: }
11496: unless ($ids) {
11497: my $idkey = 'ids_'.($thisurl =~ m{^/}? '' : '/').$thisurl;
11498: $ids=$bighash{$idkey};
11499: }
11500: if ($ids) {
11501: # ------------------------------------------------------------------- Has ID(s)
11502: if ($thisfn =~ m{^/adm/wrapper/ext/}) {
11503: $symb =~ s/\?.+$//;
11504: }
11505: foreach my $id (split(/\,/,$ids)) {
11506: my ($mapid,$resid)=split(/\./,$id);
11507: if (
11508: &symbclean(&declutter($bighash{'map_id_'.$mapid}).'___'.$resid.'___'.$thisfn)
11509: eq $symb) {
11510: if (ref($encstate)) {
11511: $$encstate = $bighash{'encrypted_'.$id};
11512: }
11513: if (($env{'request.role.adv'}) ||
11514: ($bighash{'encrypted_'.$id} eq $env{'request.enc'}) ||
11515: ($thisurl eq '/adm/navmaps')) {
11516: $okay=1;
11517: last;
11518: }
11519: }
11520: }
11521: }
11522: untie(%bighash);
11523: }
11524: return $okay;
11525: }
11526:
11527: # --------------------------------------------------------------- Clean-up symb
11528:
11529: sub symbclean {
11530: my $symb=shift;
11531: if ($symb=~m|^/enc/|) { $symb=&Apache::lonenc::unencrypted($symb); }
11532: # remove version from map
11533: $symb=~s/\.(\d+)\.(\w+)\_\_\_/\.$2\_\_\_/;
11534:
11535: # remove version from URL
11536: $symb=~s/\.(\d+)\.(\w+)$/\.$2/;
11537:
11538: # remove wrapper
11539:
11540: $symb=~s/(\_\_\_\d+\_\_\_)adm\/wrapper\/(res\/)*/$1/;
11541: $symb=~s/(\_\_\_\d+\_\_\_)adm\/coursedocs\/showdoc\/(res\/)*/$1/;
11542: return $symb;
11543: }
11544:
11545: # ---------------------------------------------- Split symb to find map and url
11546:
11547: sub encode_symb {
11548: my ($map,$resid,$url)=@_;
11549: return &symbclean(&declutter($map).'___'.$resid.'___'.&declutter($url));
11550: }
11551:
11552: sub decode_symb {
11553: my $symb=shift;
11554: if ($symb=~m|^/enc/|) { $symb=&Apache::lonenc::unencrypted($symb); }
11555: my ($map,$resid,$url)=split(/___/,$symb);
11556: return (&fixversion($map),$resid,&fixversion($url));
11557: }
11558:
11559: sub fixversion {
11560: my $fn=shift;
11561: if ($fn=~/^(adm|uploaded|editupload|public)/) { return $fn; }
11562: my %bighash;
11563: my $uri=&clutter($fn);
11564: my $key=$env{'request.course.id'}.'_'.$uri;
11565: # is this cached?
11566: my ($result,$cached)=&is_cached_new('courseresversion',$key);
11567: if (defined($cached)) { return $result; }
11568: # unfortunately not cached, or expired
11569: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
11570: &GDBM_READER(),0640)) {
11571: if ($bighash{'version_'.$uri}) {
11572: my $version=$bighash{'version_'.$uri};
11573: unless (($version eq 'mostrecent') ||
11574: ($version==&getversion($uri))) {
11575: $uri=~s/\.(\w+)$/\.$version\.$1/;
11576: }
11577: }
11578: untie %bighash;
11579: }
11580: return &do_cache_new('courseresversion',$key,&declutter($uri),600);
11581: }
11582:
11583: sub deversion {
11584: my $url=shift;
11585: $url=~s/\.\d+\.(\w+)$/\.$1/;
11586: return $url;
11587: }
11588:
11589: # ------------------------------------------------------ Return symb list entry
11590:
11591: sub symbread {
11592: my ($thisfn,$donotrecurse,$ignorecachednull,$checkforblock,$possibles)=@_;
11593: my $cache_str='request.symbread.cached.'.$thisfn;
11594: if (defined($env{$cache_str})) {
11595: if ($ignorecachednull) {
11596: return $env{$cache_str} unless ($env{$cache_str} eq '');
11597: } else {
11598: return $env{$cache_str};
11599: }
11600: }
11601: # no filename provided? try from environment
11602: unless ($thisfn) {
11603: if ($env{'request.symb'}) {
11604: return $env{$cache_str}=&symbclean($env{'request.symb'});
11605: }
11606: $thisfn=$env{'request.filename'};
11607: }
11608: if ($thisfn=~m|^/enc/|) { $thisfn=&Apache::lonenc::unencrypted($thisfn); }
11609: # is that filename actually a symb? Verify, clean, and return
11610: if ($thisfn=~/\_\_\_\d+\_\_\_(.*)$/) {
11611: if (&symbverify($thisfn,$1)) {
11612: return $env{$cache_str}=&symbclean($thisfn);
11613: }
11614: }
11615: $thisfn=declutter($thisfn);
11616: my %hash;
11617: my %bighash;
11618: my $syval='';
11619: if (($env{'request.course.fn'}) && ($thisfn)) {
11620: my $targetfn = $thisfn;
11621: if ( ($thisfn =~ m/^(uploaded|editupload)\//) && ($thisfn !~ m/\.(page|sequence)$/) ) {
11622: $targetfn = 'adm/wrapper/'.$thisfn;
11623: }
11624: if ($targetfn =~ m|^adm/wrapper/(ext/.*)|) {
11625: $targetfn=$1;
11626: }
11627: if (tie(%hash,'GDBM_File',$env{'request.course.fn'}.'_symb.db',
11628: &GDBM_READER(),0640)) {
11629: $syval=$hash{$targetfn};
11630: untie(%hash);
11631: }
11632: # ---------------------------------------------------------- There was an entry
11633: if ($syval) {
11634: #unless ($syval=~/\_\d+$/) {
11635: #unless ($env{'form.request.prefix'}=~/\.(\d+)\_$/) {
11636: #&appenv({'request.ambiguous' => $thisfn});
11637: #return $env{$cache_str}='';
11638: #}
11639: #$syval.=$1;
11640: #}
11641: } else {
11642: # ------------------------------------------------------- Was not in symb table
11643: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
11644: &GDBM_READER(),0640)) {
11645: # ---------------------------------------------- Get ID(s) for current resource
11646: my $ids=$bighash{'ids_'.&clutter($thisfn)};
11647: unless ($ids) {
11648: $ids=$bighash{'ids_/'.$thisfn};
11649: }
11650: unless ($ids) {
11651: # alias?
11652: $ids=$bighash{'mapalias_'.$thisfn};
11653: }
11654: if ($ids) {
11655: # ------------------------------------------------------------------- Has ID(s)
11656: my @possibilities=split(/\,/,$ids);
11657: if ($#possibilities==0) {
11658: # ----------------------------------------------- There is only one possibility
11659: my ($mapid,$resid)=split(/\./,$ids);
11660: $syval=&encode_symb($bighash{'map_id_'.$mapid},
11661: $resid,$thisfn);
11662: if (ref($possibles) eq 'HASH') {
11663: $possibles->{$syval} = 1;
11664: }
11665: if ($checkforblock) {
11666: my @blockers = &has_comm_blocking('bre',$syval,$bighash{'src_'.$ids});
11667: if (@blockers) {
11668: $syval = '';
11669: return;
11670: }
11671: }
11672: } elsif ((!$donotrecurse) || ($checkforblock) || (ref($possibles) eq 'HASH')) {
11673: # ------------------------------------------ There is more than one possibility
11674: my $realpossible=0;
11675: foreach my $id (@possibilities) {
11676: my $file=$bighash{'src_'.$id};
11677: my $canaccess;
11678: if (($donotrecurse) || ($checkforblock) || (ref($possibles) eq 'HASH')) {
11679: $canaccess = 1;
11680: } else {
11681: $canaccess = &allowed('bre',$file);
11682: }
11683: if ($canaccess) {
11684: my ($mapid,$resid)=split(/\./,$id);
11685: if ($bighash{'map_type_'.$mapid} ne 'page') {
11686: my $poss_syval=&encode_symb($bighash{'map_id_'.$mapid},
11687: $resid,$thisfn);
11688: if (ref($possibles) eq 'HASH') {
11689: $possibles->{$syval} = 1;
11690: }
11691: if ($checkforblock) {
11692: my @blockers = &has_comm_blocking('bre',$poss_syval,$file);
11693: unless (@blockers > 0) {
11694: $syval = $poss_syval;
11695: $realpossible++;
11696: }
11697: } else {
11698: $syval = $poss_syval;
11699: $realpossible++;
11700: }
11701: }
11702: }
11703: }
11704: if ($realpossible!=1) { $syval=''; }
11705: } else {
11706: $syval='';
11707: }
11708: }
11709: untie(%bighash);
11710: }
11711: }
11712: if ($syval) {
11713: return $env{$cache_str}=$syval;
11714: }
11715: }
11716: &appenv({'request.ambiguous' => $thisfn});
11717: return $env{$cache_str}='';
11718: }
11719:
11720: # ---------------------------------------------------------- Return random seed
11721:
11722: sub numval {
11723: my $txt=shift;
11724: $txt=~tr/A-J/0-9/;
11725: $txt=~tr/a-j/0-9/;
11726: $txt=~tr/K-T/0-9/;
11727: $txt=~tr/k-t/0-9/;
11728: $txt=~tr/U-Z/0-5/;
11729: $txt=~tr/u-z/0-5/;
11730: $txt=~s/\D//g;
11731: if ($_64bit) { if ($txt > 2**32) { return -1; } }
11732: return int($txt);
11733: }
11734:
11735: sub numval2 {
11736: my $txt=shift;
11737: $txt=~tr/A-J/0-9/;
11738: $txt=~tr/a-j/0-9/;
11739: $txt=~tr/K-T/0-9/;
11740: $txt=~tr/k-t/0-9/;
11741: $txt=~tr/U-Z/0-5/;
11742: $txt=~tr/u-z/0-5/;
11743: $txt=~s/\D//g;
11744: my @txts=split(/(\d\d\d\d\d\d\d\d\d)/,$txt);
11745: my $total;
11746: foreach my $val (@txts) { $total+=$val; }
11747: if ($_64bit) { if ($total > 2**32) { return -1; } }
11748: return int($total);
11749: }
11750:
11751: sub numval3 {
11752: use integer;
11753: my $txt=shift;
11754: $txt=~tr/A-J/0-9/;
11755: $txt=~tr/a-j/0-9/;
11756: $txt=~tr/K-T/0-9/;
11757: $txt=~tr/k-t/0-9/;
11758: $txt=~tr/U-Z/0-5/;
11759: $txt=~tr/u-z/0-5/;
11760: $txt=~s/\D//g;
11761: my @txts=split(/(\d\d\d\d\d\d\d\d\d)/,$txt);
11762: my $total;
11763: foreach my $val (@txts) { $total+=$val; }
11764: if ($_64bit) { $total=(($total<<32)>>32); }
11765: return $total;
11766: }
11767:
11768: sub digest {
11769: my ($data)=@_;
11770: my $digest=&Digest::MD5::md5($data);
11771: my ($a,$b,$c,$d)=unpack("iiii",$digest);
11772: my ($e,$f);
11773: {
11774: use integer;
11775: $e=($a+$b);
11776: $f=($c+$d);
11777: if ($_64bit) {
11778: $e=(($e<<32)>>32);
11779: $f=(($f<<32)>>32);
11780: }
11781: }
11782: if (wantarray) {
11783: return ($e,$f);
11784: } else {
11785: my $g;
11786: {
11787: use integer;
11788: $g=($e+$f);
11789: if ($_64bit) {
11790: $g=(($g<<32)>>32);
11791: }
11792: }
11793: return $g;
11794: }
11795: }
11796:
11797: sub latest_rnd_algorithm_id {
11798: return '64bit5';
11799: }
11800:
11801: sub get_rand_alg {
11802: my ($courseid)=@_;
11803: if (!$courseid) { $courseid=(&whichuser())[1]; }
11804: if ($courseid) {
11805: return $env{"course.$courseid.rndseed"};
11806: }
11807: return &latest_rnd_algorithm_id();
11808: }
11809:
11810: sub validCODE {
11811: my ($CODE)=@_;
11812: if (defined($CODE) && $CODE ne '' && $CODE =~ /^\w+$/) { return 1; }
11813: return 0;
11814: }
11815:
11816: sub getCODE {
11817: if (&validCODE($env{'form.CODE'})) { return $env{'form.CODE'}; }
11818: if ( (defined($Apache::lonhomework::parsing_a_problem) ||
11819: defined($Apache::lonhomework::parsing_a_task) ) &&
11820: &validCODE($Apache::lonhomework::history{'resource.CODE'})) {
11821: return $Apache::lonhomework::history{'resource.CODE'};
11822: }
11823: return undef;
11824: }
11825: #
11826: # Determines the random seed for a specific context:
11827: #
11828: # parameters:
11829: # symb - in course context the symb for the seed.
11830: # course_id - The course id of the form domain_coursenum.
11831: # domain - Domain for the user.
11832: # course - Course for the user.
11833: # cenv - environment of the course.
11834: #
11835: # NOTE:
11836: # All parameters are picked out of the environment if missing
11837: # or not defined.
11838: # If a symb cannot be determined the current time is used instead.
11839: #
11840: # For a given well defined symb, courside, domain, username,
11841: # and course environment, the seed is reproducible.
11842: #
11843: sub rndseed {
11844: my ($symb,$courseid,$domain,$username, $cenv)=@_;
11845: my ($wsymb,$wcourseid,$wdomain,$wusername)=&whichuser();
11846: if (!defined($symb)) {
11847: unless ($symb=$wsymb) { return time; }
11848: }
11849: if (!defined $courseid) {
11850: $courseid=$wcourseid;
11851: }
11852: if (!defined $domain) { $domain=$wdomain; }
11853: if (!defined $username) { $username=$wusername }
11854:
11855: my $which;
11856: if (defined($cenv->{'rndseed'})) {
11857: $which = $cenv->{'rndseed'};
11858: } else {
11859: $which =&get_rand_alg($courseid);
11860: }
11861: if (defined(&getCODE())) {
11862: if ($which eq '64bit5') {
11863: return &rndseed_CODE_64bit5($symb,$courseid,$domain,$username);
11864: } elsif ($which eq '64bit4') {
11865: return &rndseed_CODE_64bit4($symb,$courseid,$domain,$username);
11866: } else {
11867: return &rndseed_CODE_64bit($symb,$courseid,$domain,$username);
11868: }
11869: } elsif ($which eq '64bit5') {
11870: return &rndseed_64bit5($symb,$courseid,$domain,$username);
11871: } elsif ($which eq '64bit4') {
11872: return &rndseed_64bit4($symb,$courseid,$domain,$username);
11873: } elsif ($which eq '64bit3') {
11874: return &rndseed_64bit3($symb,$courseid,$domain,$username);
11875: } elsif ($which eq '64bit2') {
11876: return &rndseed_64bit2($symb,$courseid,$domain,$username);
11877: } elsif ($which eq '64bit') {
11878: return &rndseed_64bit($symb,$courseid,$domain,$username);
11879: }
11880: return &rndseed_32bit($symb,$courseid,$domain,$username);
11881: }
11882:
11883: sub rndseed_32bit {
11884: my ($symb,$courseid,$domain,$username)=@_;
11885: {
11886: use integer;
11887: my $symbchck=unpack("%32C*",$symb) << 27;
11888: my $symbseed=numval($symb) << 22;
11889: my $namechck=unpack("%32C*",$username) << 17;
11890: my $nameseed=numval($username) << 12;
11891: my $domainseed=unpack("%32C*",$domain) << 7;
11892: my $courseseed=unpack("%32C*",$courseid);
11893: my $num=$symbseed+$nameseed+$domainseed+$courseseed+$namechck+$symbchck;
11894: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
11895: #&logthis("rndseed :$num:$symb");
11896: if ($_64bit) { $num=(($num<<32)>>32); }
11897: return $num;
11898: }
11899: }
11900:
11901: sub rndseed_64bit {
11902: my ($symb,$courseid,$domain,$username)=@_;
11903: {
11904: use integer;
11905: my $symbchck=unpack("%32S*",$symb) << 21;
11906: my $symbseed=numval($symb) << 10;
11907: my $namechck=unpack("%32S*",$username);
11908:
11909: my $nameseed=numval($username) << 21;
11910: my $domainseed=unpack("%32S*",$domain) << 10;
11911: my $courseseed=unpack("%32S*",$courseid);
11912:
11913: my $num1=$symbchck+$symbseed+$namechck;
11914: my $num2=$nameseed+$domainseed+$courseseed;
11915: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
11916: #&logthis("rndseed :$num:$symb");
11917: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
11918: return "$num1,$num2";
11919: }
11920: }
11921:
11922: sub rndseed_64bit2 {
11923: my ($symb,$courseid,$domain,$username)=@_;
11924: {
11925: use integer;
11926: # strings need to be an even # of cahracters long, it it is odd the
11927: # last characters gets thrown away
11928: my $symbchck=unpack("%32S*",$symb.' ') << 21;
11929: my $symbseed=numval($symb) << 10;
11930: my $namechck=unpack("%32S*",$username.' ');
11931:
11932: my $nameseed=numval($username) << 21;
11933: my $domainseed=unpack("%32S*",$domain.' ') << 10;
11934: my $courseseed=unpack("%32S*",$courseid.' ');
11935:
11936: my $num1=$symbchck+$symbseed+$namechck;
11937: my $num2=$nameseed+$domainseed+$courseseed;
11938: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
11939: #&logthis("rndseed :$num:$symb");
11940: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
11941: return "$num1,$num2";
11942: }
11943: }
11944:
11945: sub rndseed_64bit3 {
11946: my ($symb,$courseid,$domain,$username)=@_;
11947: {
11948: use integer;
11949: # strings need to be an even # of cahracters long, it it is odd the
11950: # last characters gets thrown away
11951: my $symbchck=unpack("%32S*",$symb.' ') << 21;
11952: my $symbseed=numval2($symb) << 10;
11953: my $namechck=unpack("%32S*",$username.' ');
11954:
11955: my $nameseed=numval2($username) << 21;
11956: my $domainseed=unpack("%32S*",$domain.' ') << 10;
11957: my $courseseed=unpack("%32S*",$courseid.' ');
11958:
11959: my $num1=$symbchck+$symbseed+$namechck;
11960: my $num2=$nameseed+$domainseed+$courseseed;
11961: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
11962: #&logthis("rndseed :$num1:$num2:$_64bit");
11963: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
11964:
11965: return "$num1:$num2";
11966: }
11967: }
11968:
11969: sub rndseed_64bit4 {
11970: my ($symb,$courseid,$domain,$username)=@_;
11971: {
11972: use integer;
11973: # strings need to be an even # of cahracters long, it it is odd the
11974: # last characters gets thrown away
11975: my $symbchck=unpack("%32S*",$symb.' ') << 21;
11976: my $symbseed=numval3($symb) << 10;
11977: my $namechck=unpack("%32S*",$username.' ');
11978:
11979: my $nameseed=numval3($username) << 21;
11980: my $domainseed=unpack("%32S*",$domain.' ') << 10;
11981: my $courseseed=unpack("%32S*",$courseid.' ');
11982:
11983: my $num1=$symbchck+$symbseed+$namechck;
11984: my $num2=$nameseed+$domainseed+$courseseed;
11985: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
11986: #&logthis("rndseed :$num1:$num2:$_64bit");
11987: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
11988:
11989: return "$num1:$num2";
11990: }
11991: }
11992:
11993: sub rndseed_64bit5 {
11994: my ($symb,$courseid,$domain,$username)=@_;
11995: my ($num1,$num2)=&digest("$symb,$courseid,$domain,$username");
11996: return "$num1:$num2";
11997: }
11998:
11999: sub rndseed_CODE_64bit {
12000: my ($symb,$courseid,$domain,$username)=@_;
12001: {
12002: use integer;
12003: my $symbchck=unpack("%32S*",$symb.' ') << 16;
12004: my $symbseed=numval2($symb);
12005: my $CODEchck=unpack("%32S*",&getCODE().' ') << 16;
12006: my $CODEseed=numval(&getCODE());
12007: my $courseseed=unpack("%32S*",$courseid.' ');
12008: my $num1=$symbseed+$CODEchck;
12009: my $num2=$CODEseed+$courseseed+$symbchck;
12010: #&logthis("$symbseed:$CODEchck|$CODEseed:$courseseed:$symbchck");
12011: #&logthis("rndseed :$num1:$num2:$symb");
12012: if ($_64bit) { $num1=(($num1<<32)>>32); }
12013: if ($_64bit) { $num2=(($num2<<32)>>32); }
12014: return "$num1:$num2";
12015: }
12016: }
12017:
12018: sub rndseed_CODE_64bit4 {
12019: my ($symb,$courseid,$domain,$username)=@_;
12020: {
12021: use integer;
12022: my $symbchck=unpack("%32S*",$symb.' ') << 16;
12023: my $symbseed=numval3($symb);
12024: my $CODEchck=unpack("%32S*",&getCODE().' ') << 16;
12025: my $CODEseed=numval3(&getCODE());
12026: my $courseseed=unpack("%32S*",$courseid.' ');
12027: my $num1=$symbseed+$CODEchck;
12028: my $num2=$CODEseed+$courseseed+$symbchck;
12029: #&logthis("$symbseed:$CODEchck|$CODEseed:$courseseed:$symbchck");
12030: #&logthis("rndseed :$num1:$num2:$symb");
12031: if ($_64bit) { $num1=(($num1<<32)>>32); }
12032: if ($_64bit) { $num2=(($num2<<32)>>32); }
12033: return "$num1:$num2";
12034: }
12035: }
12036:
12037: sub rndseed_CODE_64bit5 {
12038: my ($symb,$courseid,$domain,$username)=@_;
12039: my $code = &getCODE();
12040: my ($num1,$num2)=&digest("$symb,$courseid,$code");
12041: return "$num1:$num2";
12042: }
12043:
12044: sub setup_random_from_rndseed {
12045: my ($rndseed)=@_;
12046: if ($rndseed =~/([,:])/) {
12047: my ($num1,$num2) = map { abs($_); } (split(/[,:]/,$rndseed));
12048: if ((!$num1) || (!$num2) || ($num1 > 2147483562) || ($num2 > 2147483398)) {
12049: &Math::Random::random_set_seed_from_phrase($rndseed);
12050: } else {
12051: &Math::Random::random_set_seed($num1,$num2);
12052: }
12053: } else {
12054: &Math::Random::random_set_seed_from_phrase($rndseed);
12055: }
12056: }
12057:
12058: sub latest_receipt_algorithm_id {
12059: return 'receipt3';
12060: }
12061:
12062: sub recunique {
12063: my $fucourseid=shift;
12064: my $unique;
12065: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2' ||
12066: $env{"course.$fucourseid.receiptalg"} eq 'receipt3' ) {
12067: $unique=$env{"course.$fucourseid.internal.encseed"};
12068: } else {
12069: $unique=$perlvar{'lonReceipt'};
12070: }
12071: return unpack("%32C*",$unique);
12072: }
12073:
12074: sub recprefix {
12075: my $fucourseid=shift;
12076: my $prefix;
12077: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2'||
12078: $env{"course.$fucourseid.receiptalg"} eq 'receipt3' ) {
12079: $prefix=$env{"course.$fucourseid.internal.encpref"};
12080: } else {
12081: $prefix=$perlvar{'lonHostID'};
12082: }
12083: return unpack("%32C*",$prefix);
12084: }
12085:
12086: sub ireceipt {
12087: my ($funame,$fudom,$fucourseid,$fusymb,$part)=@_;
12088:
12089: my $return =&recprefix($fucourseid).'-';
12090:
12091: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt3' ||
12092: $env{'request.state'} eq 'construct') {
12093: $return .= (&digest("$funame,$fudom,$fucourseid,$fusymb,$part")%10000);
12094: return $return;
12095: }
12096:
12097: my $cuname=unpack("%32C*",$funame);
12098: my $cudom=unpack("%32C*",$fudom);
12099: my $cucourseid=unpack("%32C*",$fucourseid);
12100: my $cusymb=unpack("%32C*",$fusymb);
12101: my $cunique=&recunique($fucourseid);
12102: my $cpart=unpack("%32S*",$part);
12103: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2') {
12104:
12105: #&logthis("doing receipt2 using parts $cpart, uname $cuname and udom $cudom gets ".($cpart%$cuname)." and ".($cpart%$cudom));
12106:
12107: $return.= ($cunique%$cuname+
12108: $cunique%$cudom+
12109: $cusymb%$cuname+
12110: $cusymb%$cudom+
12111: $cucourseid%$cuname+
12112: $cucourseid%$cudom+
12113: $cpart%$cuname+
12114: $cpart%$cudom);
12115: } else {
12116: $return.= ($cunique%$cuname+
12117: $cunique%$cudom+
12118: $cusymb%$cuname+
12119: $cusymb%$cudom+
12120: $cucourseid%$cuname+
12121: $cucourseid%$cudom);
12122: }
12123: return $return;
12124: }
12125:
12126: sub receipt {
12127: my ($part)=@_;
12128: my ($symb,$courseid,$domain,$name) = &whichuser();
12129: return &ireceipt($name,$domain,$courseid,$symb,$part);
12130: }
12131:
12132: sub whichuser {
12133: my ($passedsymb)=@_;
12134: my ($symb,$courseid,$domain,$name,$publicuser);
12135: if (defined($env{'form.grade_symb'})) {
12136: my ($tmp_courseid)=&get_env_multiple('form.grade_courseid');
12137: my $allowed=&allowed('vgr',$tmp_courseid);
12138: if (!$allowed &&
12139: exists($env{'request.course.sec'}) &&
12140: $env{'request.course.sec'} !~ /^\s*$/) {
12141: $allowed=&allowed('vgr',$tmp_courseid.
12142: '/'.$env{'request.course.sec'});
12143: }
12144: if ($allowed) {
12145: ($symb)=&get_env_multiple('form.grade_symb');
12146: $courseid=$tmp_courseid;
12147: ($domain)=&get_env_multiple('form.grade_domain');
12148: ($name)=&get_env_multiple('form.grade_username');
12149: return ($symb,$courseid,$domain,$name,$publicuser);
12150: }
12151: }
12152: if (!$passedsymb) {
12153: $symb=&symbread();
12154: } else {
12155: $symb=$passedsymb;
12156: }
12157: $courseid=$env{'request.course.id'};
12158: $domain=$env{'user.domain'};
12159: $name=$env{'user.name'};
12160: if ($name eq 'public' && $domain eq 'public') {
12161: if (!defined($env{'form.username'})) {
12162: $env{'form.username'}.=time.rand(10000000);
12163: }
12164: $name.=$env{'form.username'};
12165: }
12166: return ($symb,$courseid,$domain,$name,$publicuser);
12167:
12168: }
12169:
12170: # ------------------------------------------------------------ Serves up a file
12171: # returns either the contents of the file or
12172: # -1 if the file doesn't exist
12173: #
12174: # if the target is a file that was uploaded via DOCS,
12175: # a check will be made to see if a current copy exists on the local server,
12176: # if it does this will be served, otherwise a copy will be retrieved from
12177: # the home server for the course and stored in /home/httpd/html/userfiles on
12178: # the local server.
12179:
12180: sub getfile {
12181: my ($file) = @_;
12182: if ($file =~ m -^/*(uploaded|editupload)/-) { $file=&filelocation("",$file); }
12183: &repcopy($file);
12184: return &readfile($file);
12185: }
12186:
12187: sub repcopy_userfile {
12188: my ($file)=@_;
12189: my $londocroot = $perlvar{'lonDocRoot'};
12190: if ($file =~ m{^/*(uploaded|editupload)/}) { $file=&filelocation("",$file); }
12191: if ($file =~ m{^\Q/home/httpd/lonUsers/\E}) { return 'ok'; }
12192: my ($cdom,$cnum,$filename) =
12193: ($file=~m|^\Q$perlvar{'lonDocRoot'}\E/+userfiles/+($match_domain)/+($match_name)/+(.*)|);
12194: my $uri="/uploaded/$cdom/$cnum/$filename";
12195: if (-e "$file") {
12196: # we already have a local copy, check it out
12197: my @fileinfo = stat($file);
12198: my $rtncode;
12199: my $info;
12200: my $lwpresp = &getuploaded('HEAD',$uri,$cdom,$cnum,\$info,\$rtncode);
12201: if ($lwpresp ne 'ok') {
12202: # there is no such file anymore, even though we had a local copy
12203: if ($rtncode eq '404') {
12204: unlink($file);
12205: }
12206: return -1;
12207: }
12208: if ($info < $fileinfo[9]) {
12209: # nice, the file we have is up-to-date, just say okay
12210: return 'ok';
12211: } else {
12212: # the file is outdated, get rid of it
12213: unlink($file);
12214: }
12215: }
12216: # one way or the other, at this point, we don't have the file
12217: # construct the correct path for the file
12218: my @parts = ($cdom,$cnum);
12219: if ($filename =~ m|^(.+)/[^/]+$|) {
12220: push @parts, split(/\//,$1);
12221: }
12222: my $path = $perlvar{'lonDocRoot'}.'/userfiles';
12223: foreach my $part (@parts) {
12224: $path .= '/'.$part;
12225: if (!-e $path) {
12226: mkdir($path,0770);
12227: }
12228: }
12229: # now the path exists for sure
12230: # get a user agent
12231: my $ua=new LWP::UserAgent;
12232: my $transferfile=$file.'.in.transfer';
12233: # FIXME: this should flock
12234: if (-e $transferfile) { return 'ok'; }
12235: my $request;
12236: $uri=~s/^\///;
12237: my $homeserver = &homeserver($cnum,$cdom);
12238: my $protocol = $protocol{$homeserver};
12239: $protocol = 'http' if ($protocol ne 'https');
12240: $request=new HTTP::Request('GET',$protocol.'://'.&hostname($homeserver).'/raw/'.$uri);
12241: my $response=$ua->request($request,$transferfile);
12242: # did it work?
12243: if ($response->is_error()) {
12244: unlink($transferfile);
12245: &logthis("Userfile repcopy failed for $uri");
12246: return -1;
12247: }
12248: # worked, rename the transfer file
12249: rename($transferfile,$file);
12250: return 'ok';
12251: }
12252:
12253: sub tokenwrapper {
12254: my $uri=shift;
12255: $uri=~s|^https?\://([^/]+)||;
12256: $uri=~s|^/||;
12257: $env{'user.environment'}=~/\/([^\/]+)\.id/;
12258: my $token=$1;
12259: my (undef,$udom,$uname,$file)=split('/',$uri,4);
12260: if ($udom && $uname && $file) {
12261: $file=~s|(\?\.*)*$||;
12262: &appenv({"userfile.$udom/$uname/$file" => $env{'request.course.id'}});
12263: my $homeserver = &homeserver($uname,$udom);
12264: my $protocol = $protocol{$homeserver};
12265: $protocol = 'http' if ($protocol ne 'https');
12266: return $protocol.'://'.&hostname($homeserver).'/'.$uri.
12267: (($uri=~/\?/)?'&':'?').'token='.$token.
12268: '&tokenissued='.$perlvar{'lonHostID'};
12269: } else {
12270: return '/adm/notfound.html';
12271: }
12272: }
12273:
12274: # call with reqtype HEAD: get last modification time
12275: # call with reqtype GET: get the file contents
12276: # Do not call this with reqtype GET for large files! It loads everything into memory
12277: #
12278: sub getuploaded {
12279: my ($reqtype,$uri,$cdom,$cnum,$info,$rtncode) = @_;
12280: $uri=~s/^\///;
12281: my $homeserver = &homeserver($cnum,$cdom);
12282: my $protocol = $protocol{$homeserver};
12283: $protocol = 'http' if ($protocol ne 'https');
12284: $uri = $protocol.'://'.&hostname($homeserver).'/raw/'.$uri;
12285: my $ua=new LWP::UserAgent;
12286: my $request=new HTTP::Request($reqtype,$uri);
12287: my $response=$ua->request($request);
12288: $$rtncode = $response->code;
12289: if (! $response->is_success()) {
12290: return 'failed';
12291: }
12292: if ($reqtype eq 'HEAD') {
12293: $$info = &HTTP::Date::str2time( $response->header('Last-modified') );
12294: } elsif ($reqtype eq 'GET') {
12295: $$info = $response->content;
12296: }
12297: return 'ok';
12298: }
12299:
12300: sub readfile {
12301: my $file = shift;
12302: if ( (! -e $file ) || ($file eq '') ) { return -1; };
12303: my $fh;
12304: open($fh,"<$file");
12305: my $a='';
12306: while (my $line = <$fh>) { $a .= $line; }
12307: return $a;
12308: }
12309:
12310: sub filelocation {
12311: my ($dir,$file) = @_;
12312: my $location;
12313: $file=~ s/^\s*(\S+)\s*$/$1/; ## strip off leading and trailing spaces
12314:
12315: if ($file =~ m-^/adm/-) {
12316: $file=~s-^/adm/wrapper/-/-;
12317: $file=~s-^/adm/coursedocs/showdoc/-/-;
12318: }
12319:
12320: if ($file =~ m-^\Q$Apache::lonnet::perlvar{'lonTabDir'}\E/-) {
12321: $location = $file;
12322: } elsif ($file=~/^\/*(uploaded|editupload)/) { # is an uploaded file
12323: my ($udom,$uname,$filename)=
12324: ($file=~m -^/+(?:uploaded|editupload)/+($match_domain)/+($match_name)/+(.*)$-);
12325: my $home=&homeserver($uname,$udom);
12326: my $is_me=0;
12327: my @ids=¤t_machine_ids();
12328: foreach my $id (@ids) { if ($id eq $home) { $is_me=1; } }
12329: if ($is_me) {
12330: $location=propath($udom,$uname).'/userfiles/'.$filename;
12331: } else {
12332: $location=$Apache::lonnet::perlvar{'lonDocRoot'}.'/userfiles/'.
12333: $udom.'/'.$uname.'/'.$filename;
12334: }
12335: } elsif ($file =~ m-^/adm/-) {
12336: $location = $perlvar{'lonDocRoot'}.'/'.$file;
12337: } else {
12338: $file=~s/^\Q$perlvar{'lonDocRoot'}\E//;
12339: $file=~s:^/(res|priv)/:/:;
12340: my $space=$1;
12341: if ( !( $file =~ m:^/:) ) {
12342: $location = $dir. '/'.$file;
12343: } else {
12344: $location = $perlvar{'lonDocRoot'}.'/'.$space.$file;
12345: }
12346: }
12347: $location=~s://+:/:g; # remove duplicate /
12348: while ($location=~m{/\.\./}) {
12349: if ($location =~ m{/[^/]+/\.\./}) {
12350: $location=~ s{/[^/]+/\.\./}{/}g;
12351: } else {
12352: $location=~ s{/\.\./}{/}g;
12353: }
12354: } #remove dir/..
12355: while ($location=~m:/\./:) {$location=~ s:/\./:/:g;} #remove /./
12356: return $location;
12357: }
12358:
12359: sub hreflocation {
12360: my ($dir,$file)=@_;
12361: unless (($file=~m-^https?\://-i) || ($file=~m-^/-)) {
12362: $file=filelocation($dir,$file);
12363: } elsif ($file=~m-^/adm/-) {
12364: $file=~s-^/adm/wrapper/-/-;
12365: $file=~s-^/adm/coursedocs/showdoc/-/-;
12366: }
12367: if ($file=~m-^\Q$perlvar{'lonDocRoot'}\E-) {
12368: $file=~s-^\Q$perlvar{'lonDocRoot'}\E--;
12369: } elsif ($file=~m-^\Q$perlvar{'lonUsersDir'}\E-) {
12370: $file=~s{^/home/httpd/lonUsers/($match_domain)/./././($match_name)/userfiles/}
12371: {/uploaded/$1/$2/}x;
12372: }
12373: if ($file=~ m{^/userfiles/}) {
12374: $file =~ s{^/userfiles/}{/uploaded/};
12375: }
12376: return $file;
12377: }
12378:
12379:
12380:
12381:
12382:
12383: sub current_machine_domains {
12384: return &machine_domains(&hostname($perlvar{'lonHostID'}));
12385: }
12386:
12387: sub machine_domains {
12388: my ($hostname) = @_;
12389: my @domains;
12390: my %hostname = &all_hostnames();
12391: while( my($id, $name) = each(%hostname)) {
12392: # &logthis("-$id-$name-$hostname-");
12393: if ($hostname eq $name) {
12394: push(@domains,&host_domain($id));
12395: }
12396: }
12397: return @domains;
12398: }
12399:
12400: sub current_machine_ids {
12401: return &machine_ids(&hostname($perlvar{'lonHostID'}));
12402: }
12403:
12404: sub machine_ids {
12405: my ($hostname) = @_;
12406: $hostname ||= &hostname($perlvar{'lonHostID'});
12407: my @ids;
12408: my %name_to_host = &all_names();
12409: if (ref($name_to_host{$hostname}) eq 'ARRAY') {
12410: return @{ $name_to_host{$hostname} };
12411: }
12412: return;
12413: }
12414:
12415: sub additional_machine_domains {
12416: my @domains;
12417: open(my $fh,"<$perlvar{'lonTabDir'}/expected_domains.tab");
12418: while( my $line = <$fh>) {
12419: $line =~ s/\s//g;
12420: push(@domains,$line);
12421: }
12422: return @domains;
12423: }
12424:
12425: sub default_login_domain {
12426: my $domain = $perlvar{'lonDefDomain'};
12427: my $testdomain=(split(/\./,$ENV{'HTTP_HOST'}))[0];
12428: foreach my $posdom (¤t_machine_domains(),
12429: &additional_machine_domains()) {
12430: if (lc($posdom) eq lc($testdomain)) {
12431: $domain=$posdom;
12432: last;
12433: }
12434: }
12435: return $domain;
12436: }
12437:
12438: # ------------------------------------------------------------- Declutters URLs
12439:
12440: sub declutter {
12441: my $thisfn=shift;
12442: if ($thisfn=~m|^/enc/|) { $thisfn=&Apache::lonenc::unencrypted($thisfn); }
12443: unless ($thisfn=~m{^/home/httpd/html/priv/}) {
12444: $thisfn=~s{^/home/httpd/html}{};
12445: }
12446: $thisfn=~s/^\///;
12447: $thisfn=~s|^adm/wrapper/||;
12448: $thisfn=~s|^adm/coursedocs/showdoc/||;
12449: $thisfn=~s/^res\///;
12450: $thisfn=~s/^priv\///;
12451: unless (($thisfn =~ /^ext/) || ($thisfn =~ /\.(page|sequence)___\d+___ext/)) {
12452: $thisfn=~s/\?.+$//;
12453: }
12454: return $thisfn;
12455: }
12456:
12457: # ------------------------------------------------------------- Clutter up URLs
12458:
12459: sub clutter {
12460: my $thisfn='/'.&declutter(shift);
12461: if ($thisfn !~ m{^/(uploaded|editupload|adm|userfiles|ext|raw|priv|public)/}
12462: || $thisfn =~ m{^/adm/(includes|pages)} ) {
12463: $thisfn='/res'.$thisfn;
12464: }
12465: if ($thisfn !~m|^/adm|) {
12466: if ($thisfn =~ m|^/ext/|) {
12467: $thisfn='/adm/wrapper'.$thisfn;
12468: } else {
12469: my ($ext) = ($thisfn =~ /\.(\w+)$/);
12470: my $embstyle=&Apache::loncommon::fileembstyle($ext);
12471: if ($embstyle eq 'ssi'
12472: || ($embstyle eq 'hdn')
12473: || ($embstyle eq 'rat')
12474: || ($embstyle eq 'prv')
12475: || ($embstyle eq 'ign')) {
12476: #do nothing with these
12477: } elsif (($embstyle eq 'img')
12478: || ($embstyle eq 'emb')
12479: || ($embstyle eq 'wrp')) {
12480: $thisfn='/adm/wrapper'.$thisfn;
12481: } elsif ($embstyle eq 'unk'
12482: && $thisfn!~/\.(sequence|page)$/) {
12483: $thisfn='/adm/coursedocs/showdoc'.$thisfn;
12484: } else {
12485: # &logthis("Got a blank emb style");
12486: }
12487: }
12488: }
12489: return $thisfn;
12490: }
12491:
12492: sub clutter_with_no_wrapper {
12493: my $uri = &clutter(shift);
12494: if ($uri =~ m-^/adm/-) {
12495: $uri =~ s-^/adm/wrapper/-/-;
12496: $uri =~ s-^/adm/coursedocs/showdoc/-/-;
12497: }
12498: return $uri;
12499: }
12500:
12501: sub freeze_escape {
12502: my ($value)=@_;
12503: if (ref($value)) {
12504: $value=&nfreeze($value);
12505: return '__FROZEN__'.&escape($value);
12506: }
12507: return &escape($value);
12508: }
12509:
12510:
12511: sub thaw_unescape {
12512: my ($value)=@_;
12513: if ($value =~ /^__FROZEN__/) {
12514: substr($value,0,10,undef);
12515: $value=&unescape($value);
12516: return &thaw($value);
12517: }
12518: return &unescape($value);
12519: }
12520:
12521: sub correct_line_ends {
12522: my ($result)=@_;
12523: $$result =~s/\r\n/\n/mg;
12524: $$result =~s/\r/\n/mg;
12525: }
12526: # ================================================================ Main Program
12527:
12528: sub goodbye {
12529: &logthis("Starting Shut down");
12530: #not converted to using infrastruture and probably shouldn't be
12531: &logthis(sprintf("%-20s is %s",'%badServerCache',length(&nfreeze(\%badServerCache))));
12532: #converted
12533: # &logthis(sprintf("%-20s is %s",'%metacache',scalar(%metacache)));
12534: &logthis(sprintf("%-20s is %s",'%homecache',length(&nfreeze(\%homecache))));
12535: # &logthis(sprintf("%-20s is %s",'%titlecache',length(&nfreeze(\%titlecache))));
12536: # &logthis(sprintf("%-20s is %s",'%courseresdatacache',length(&nfreeze(\%courseresdatacache))));
12537: #1.1 only
12538: # &logthis(sprintf("%-20s is %s",'%userresdatacache',length(&nfreeze(\%userresdatacache))));
12539: # &logthis(sprintf("%-20s is %s",'%getsectioncache',length(&nfreeze(\%getsectioncache))));
12540: # &logthis(sprintf("%-20s is %s",'%courseresversioncache',length(&nfreeze(\%courseresversioncache))));
12541: # &logthis(sprintf("%-20s is %s",'%resversioncache',length(&nfreeze(\%resversioncache))));
12542: &logthis(sprintf("%-20s is %s",'%remembered',length(&nfreeze(\%remembered))));
12543: &logthis(sprintf("%-20s is %s",'kicks',$kicks));
12544: &logthis(sprintf("%-20s is %s",'hits',$hits));
12545: &flushcourselogs();
12546: &logthis("Shutting down");
12547: }
12548:
12549: sub get_dns {
12550: my ($url,$func,$ignore_cache,$nocache,$hashref) = @_;
12551: if (!$ignore_cache) {
12552: my ($content,$cached)=
12553: &Apache::lonnet::is_cached_new('dns',$url);
12554: if ($cached) {
12555: &$func($content,$hashref);
12556: return;
12557: }
12558: }
12559:
12560: my %alldns;
12561: open(my $config,"<$perlvar{'lonTabDir'}/hosts.tab");
12562: foreach my $dns (<$config>) {
12563: next if ($dns !~ /^\^(\S*)/x);
12564: my $line = $1;
12565: my ($host,$protocol) = split(/:/,$line);
12566: if ($protocol ne 'https') {
12567: $protocol = 'http';
12568: }
12569: $alldns{$host} = $protocol;
12570: }
12571: while (%alldns) {
12572: my ($dns) = sort { $b cmp $a } keys(%alldns);
12573: my $ua=new LWP::UserAgent;
12574: $ua->timeout(30);
12575: my $request=new HTTP::Request('GET',"$alldns{$dns}://$dns$url");
12576: my $response=$ua->request($request);
12577: delete($alldns{$dns});
12578: next if ($response->is_error());
12579: my @content = split("\n",$response->content);
12580: unless ($nocache) {
12581: &do_cache_new('dns',$url,\@content,30*24*60*60);
12582: }
12583: &$func(\@content,$hashref);
12584: return;
12585: }
12586: close($config);
12587: my $which = (split('/',$url))[3];
12588: &logthis("unable to contact DNS defaulting to on disk file dns_$which.tab\n");
12589: open($config,"<$perlvar{'lonTabDir'}/dns_$which.tab");
12590: my @content = <$config>;
12591: &$func(\@content,$hashref);
12592: return;
12593: }
12594:
12595: # ------------------------------------------------------Get DNS checksums file
12596: sub parse_dns_checksums_tab {
12597: my ($lines,$hashref) = @_;
12598: my $lonhost = $perlvar{'lonHostID'};
12599: my $machine_dom = &Apache::lonnet::host_domain($lonhost);
12600: my $loncaparev = &get_server_loncaparev($machine_dom);
12601: my $distro = (split(/\:/,&get_server_distarch($lonhost)))[0];
12602: my $webconfdir = '/etc/httpd/conf';
12603: if ($distro =~ /^(ubuntu|debian)(\d+)$/) {
12604: $webconfdir = '/etc/apache2';
12605: } elsif ($distro =~ /^sles(\d+)$/) {
12606: if ($1 >= 10) {
12607: $webconfdir = '/etc/apache2';
12608: }
12609: } elsif ($distro =~ /^suse(\d+\.\d+)$/) {
12610: if ($1 >= 10.0) {
12611: $webconfdir = '/etc/apache2';
12612: }
12613: }
12614: my ($release,$timestamp) = split(/\-/,$loncaparev);
12615: my (%chksum,%revnum);
12616: if (ref($lines) eq 'ARRAY') {
12617: chomp(@{$lines});
12618: my $version = shift(@{$lines});
12619: if ($version eq $release) {
12620: foreach my $line (@{$lines}) {
12621: my ($file,$version,$shasum) = split(/,/,$line);
12622: if ($file =~ m{^/etc/httpd/conf}) {
12623: if ($webconfdir eq '/etc/apache2') {
12624: $file =~ s{^\Q/etc/httpd/conf/\E}{$webconfdir/};
12625: }
12626: }
12627: $chksum{$file} = $shasum;
12628: $revnum{$file} = $version;
12629: }
12630: if (ref($hashref) eq 'HASH') {
12631: %{$hashref} = (
12632: sums => \%chksum,
12633: versions => \%revnum,
12634: );
12635: }
12636: }
12637: }
12638: return;
12639: }
12640:
12641: sub fetch_dns_checksums {
12642: my %checksums;
12643: my $machine_dom = &Apache::lonnet::host_domain($perlvar{'lonHostID'});
12644: my $loncaparev = &get_server_loncaparev($machine_dom,$perlvar{'lonHostID'});
12645: my ($release,$timestamp) = split(/\-/,$loncaparev);
12646: &get_dns("/adm/dns/checksums/$release",\&parse_dns_checksums_tab,1,1,
12647: \%checksums);
12648: return \%checksums;
12649: }
12650:
12651: # ------------------------------------------------------------ Read domain file
12652: {
12653: my $loaded;
12654: my %domain;
12655:
12656: sub parse_domain_tab {
12657: my ($lines) = @_;
12658: foreach my $line (@$lines) {
12659: next if ($line =~ /^(\#|\s*$ )/x);
12660:
12661: chomp($line);
12662: my ($name,@elements) = split(/:/,$line,9);
12663: my %this_domain;
12664: foreach my $field ('description', 'auth_def', 'auth_arg_def',
12665: 'lang_def', 'city', 'longi', 'lati',
12666: 'primary') {
12667: $this_domain{$field} = shift(@elements);
12668: }
12669: $domain{$name} = \%this_domain;
12670: }
12671: }
12672:
12673: sub reset_domain_info {
12674: undef($loaded);
12675: undef(%domain);
12676: }
12677:
12678: sub load_domain_tab {
12679: my ($ignore_cache,$nocache) = @_;
12680: &get_dns('/adm/dns/domain',\&parse_domain_tab,$ignore_cache,$nocache);
12681: my $fh;
12682: if (open($fh,"<".$perlvar{'lonTabDir'}.'/domain.tab')) {
12683: my @lines = <$fh>;
12684: &parse_domain_tab(\@lines);
12685: }
12686: close($fh);
12687: $loaded = 1;
12688: }
12689:
12690: sub domain {
12691: &load_domain_tab() if (!$loaded);
12692:
12693: my ($name,$what) = @_;
12694: return if ( !exists($domain{$name}) );
12695:
12696: if (!$what) {
12697: return $domain{$name}{'description'};
12698: }
12699: return $domain{$name}{$what};
12700: }
12701:
12702: sub domain_info {
12703: &load_domain_tab() if (!$loaded);
12704: return %domain;
12705: }
12706:
12707: }
12708:
12709:
12710: # ------------------------------------------------------------- Read hosts file
12711: {
12712: my %hostname;
12713: my %hostdom;
12714: my %libserv;
12715: my $loaded;
12716: my %name_to_host;
12717: my %internetdom;
12718: my %LC_dns_serv;
12719:
12720: sub parse_hosts_tab {
12721: my ($file) = @_;
12722: foreach my $configline (@$file) {
12723: next if ($configline =~ /^(\#|\s*$ )/x);
12724: chomp($configline);
12725: if ($configline =~ /^\^/) {
12726: if ($configline =~ /^\^([\w.\-]+)/) {
12727: $LC_dns_serv{$1} = 1;
12728: }
12729: next;
12730: }
12731: my ($id,$domain,$role,$name,$protocol,$intdom)=split(/:/,$configline);
12732: $name=~s/\s//g;
12733: if ($id && $domain && $role && $name) {
12734: $hostname{$id}=$name;
12735: push(@{$name_to_host{$name}}, $id);
12736: $hostdom{$id}=$domain;
12737: if ($role eq 'library') { $libserv{$id}=$name; }
12738: if (defined($protocol)) {
12739: if ($protocol eq 'https') {
12740: $protocol{$id} = $protocol;
12741: } else {
12742: $protocol{$id} = 'http';
12743: }
12744: } else {
12745: $protocol{$id} = 'http';
12746: }
12747: if (defined($intdom)) {
12748: $internetdom{$id} = $intdom;
12749: }
12750: }
12751: }
12752: }
12753:
12754: sub reset_hosts_info {
12755: &purge_remembered();
12756: &reset_domain_info();
12757: &reset_hosts_ip_info();
12758: undef(%name_to_host);
12759: undef(%hostname);
12760: undef(%hostdom);
12761: undef(%libserv);
12762: undef($loaded);
12763: }
12764:
12765: sub load_hosts_tab {
12766: my ($ignore_cache,$nocache) = @_;
12767: &get_dns('/adm/dns/hosts',\&parse_hosts_tab,$ignore_cache,$nocache);
12768: open(my $config,"<$perlvar{'lonTabDir'}/hosts.tab");
12769: my @config = <$config>;
12770: &parse_hosts_tab(\@config);
12771: close($config);
12772: $loaded=1;
12773: }
12774:
12775: sub hostname {
12776: &load_hosts_tab() if (!$loaded);
12777:
12778: my ($lonid) = @_;
12779: return $hostname{$lonid};
12780: }
12781:
12782: sub all_hostnames {
12783: &load_hosts_tab() if (!$loaded);
12784:
12785: return %hostname;
12786: }
12787:
12788: sub all_names {
12789: my ($ignore_cache,$nocache) = @_;
12790: &load_hosts_tab($ignore_cache,$nocache) if (!$loaded);
12791:
12792: return %name_to_host;
12793: }
12794:
12795: sub all_host_domain {
12796: &load_hosts_tab() if (!$loaded);
12797: return %hostdom;
12798: }
12799:
12800: sub is_library {
12801: &load_hosts_tab() if (!$loaded);
12802:
12803: return exists($libserv{$_[0]});
12804: }
12805:
12806: sub all_library {
12807: &load_hosts_tab() if (!$loaded);
12808:
12809: return %libserv;
12810: }
12811:
12812: sub unique_library {
12813: #2x reverse removes all hostnames that appear more than once
12814: my %unique = reverse &all_library();
12815: return reverse %unique;
12816: }
12817:
12818: sub get_servers {
12819: &load_hosts_tab() if (!$loaded);
12820:
12821: my ($domain,$type) = @_;
12822: my %possible_hosts = ($type eq 'library') ? %libserv
12823: : %hostname;
12824: my %result;
12825: if (ref($domain) eq 'ARRAY') {
12826: while ( my ($host,$hostname) = each(%possible_hosts)) {
12827: if (grep(/^\Q$hostdom{$host}\E$/,@$domain)) {
12828: $result{$host} = $hostname;
12829: }
12830: }
12831: } else {
12832: while ( my ($host,$hostname) = each(%possible_hosts)) {
12833: if ($hostdom{$host} eq $domain) {
12834: $result{$host} = $hostname;
12835: }
12836: }
12837: }
12838: return %result;
12839: }
12840:
12841: sub get_unique_servers {
12842: my %unique = reverse &get_servers(@_);
12843: return reverse %unique;
12844: }
12845:
12846: sub host_domain {
12847: &load_hosts_tab() if (!$loaded);
12848:
12849: my ($lonid) = @_;
12850: return $hostdom{$lonid};
12851: }
12852:
12853: sub all_domains {
12854: &load_hosts_tab() if (!$loaded);
12855:
12856: my %seen;
12857: my @uniq = grep(!$seen{$_}++, values(%hostdom));
12858: return @uniq;
12859: }
12860:
12861: sub internet_dom {
12862: &load_hosts_tab() if (!$loaded);
12863:
12864: my ($lonid) = @_;
12865: return $internetdom{$lonid};
12866: }
12867:
12868: sub is_LC_dns {
12869: &load_hosts_tab() if (!$loaded);
12870:
12871: my ($hostname) = @_;
12872: return exists($LC_dns_serv{$hostname});
12873: }
12874:
12875: }
12876:
12877: {
12878: my %iphost;
12879: my %name_to_ip;
12880: my %lonid_to_ip;
12881:
12882: sub get_hosts_from_ip {
12883: my ($ip) = @_;
12884: my %iphosts = &get_iphost();
12885: if (ref($iphosts{$ip})) {
12886: return @{$iphosts{$ip}};
12887: }
12888: return;
12889: }
12890:
12891: sub reset_hosts_ip_info {
12892: undef(%iphost);
12893: undef(%name_to_ip);
12894: undef(%lonid_to_ip);
12895: }
12896:
12897: sub get_host_ip {
12898: my ($lonid) = @_;
12899: if (exists($lonid_to_ip{$lonid})) {
12900: return $lonid_to_ip{$lonid};
12901: }
12902: my $name=&hostname($lonid);
12903: my $ip = gethostbyname($name);
12904: return if (!$ip || length($ip) ne 4);
12905: $ip=inet_ntoa($ip);
12906: $name_to_ip{$name} = $ip;
12907: $lonid_to_ip{$lonid} = $ip;
12908: return $ip;
12909: }
12910:
12911: sub get_iphost {
12912: my ($ignore_cache,$nocache) = @_;
12913:
12914: if (!$ignore_cache) {
12915: if (%iphost) {
12916: return %iphost;
12917: }
12918: my ($ip_info,$cached)=
12919: &Apache::lonnet::is_cached_new('iphost','iphost');
12920: if ($cached) {
12921: %iphost = %{$ip_info->[0]};
12922: %name_to_ip = %{$ip_info->[1]};
12923: %lonid_to_ip = %{$ip_info->[2]};
12924: return %iphost;
12925: }
12926: }
12927:
12928: # get yesterday's info for fallback
12929: my %old_name_to_ip;
12930: my ($ip_info,$cached)=
12931: &Apache::lonnet::is_cached_new('iphost','iphost');
12932: if ($cached) {
12933: %old_name_to_ip = %{$ip_info->[1]};
12934: }
12935:
12936: my %name_to_host = &all_names($ignore_cache,$nocache);
12937: foreach my $name (keys(%name_to_host)) {
12938: my $ip;
12939: if (!exists($name_to_ip{$name})) {
12940: $ip = gethostbyname($name);
12941: if (!$ip || length($ip) ne 4) {
12942: if (defined($old_name_to_ip{$name})) {
12943: $ip = $old_name_to_ip{$name};
12944: &logthis("Can't find $name defaulting to old $ip");
12945: } else {
12946: &logthis("Name $name no IP found");
12947: next;
12948: }
12949: } else {
12950: $ip=inet_ntoa($ip);
12951: }
12952: $name_to_ip{$name} = $ip;
12953: } else {
12954: $ip = $name_to_ip{$name};
12955: }
12956: foreach my $id (@{ $name_to_host{$name} }) {
12957: $lonid_to_ip{$id} = $ip;
12958: }
12959: push(@{$iphost{$ip}},@{$name_to_host{$name}});
12960: }
12961: unless ($nocache) {
12962: &do_cache_new('iphost','iphost',
12963: [\%iphost,\%name_to_ip,\%lonid_to_ip],
12964: 48*60*60);
12965: }
12966:
12967: return %iphost;
12968: }
12969:
12970: #
12971: # Given a DNS returns the loncapa host name for that DNS
12972: #
12973: sub host_from_dns {
12974: my ($dns) = @_;
12975: my @hosts;
12976: my $ip;
12977:
12978: if (exists($name_to_ip{$dns})) {
12979: $ip = $name_to_ip{$dns};
12980: }
12981: if (!$ip) {
12982: $ip = gethostbyname($dns); # Initial translation to IP is in net order.
12983: if (length($ip) == 4) {
12984: $ip = &IO::Socket::inet_ntoa($ip);
12985: }
12986: }
12987: if ($ip) {
12988: @hosts = get_hosts_from_ip($ip);
12989: return $hosts[0];
12990: }
12991: return undef;
12992: }
12993:
12994: sub get_internet_names {
12995: my ($lonid) = @_;
12996: return if ($lonid eq '');
12997: my ($idnref,$cached)=
12998: &Apache::lonnet::is_cached_new('internetnames',$lonid);
12999: if ($cached) {
13000: return $idnref;
13001: }
13002: my $ip = &get_host_ip($lonid);
13003: my @hosts = &get_hosts_from_ip($ip);
13004: my %iphost = &get_iphost();
13005: my (@idns,%seen);
13006: foreach my $id (@hosts) {
13007: my $dom = &host_domain($id);
13008: my $prim_id = &domain($dom,'primary');
13009: my $prim_ip = &get_host_ip($prim_id);
13010: next if ($seen{$prim_ip});
13011: if (ref($iphost{$prim_ip}) eq 'ARRAY') {
13012: foreach my $id (@{$iphost{$prim_ip}}) {
13013: my $intdom = &internet_dom($id);
13014: unless (grep(/^\Q$intdom\E$/,@idns)) {
13015: push(@idns,$intdom);
13016: }
13017: }
13018: }
13019: $seen{$prim_ip} = 1;
13020: }
13021: return &do_cache_new('internetnames',$lonid,\@idns,12*60*60);
13022: }
13023:
13024: }
13025:
13026: sub all_loncaparevs {
13027: 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);
13028: }
13029:
13030: # ------------------------------------------------------- Read loncaparev table
13031: {
13032: sub load_loncaparevs {
13033: if (-e "$perlvar{'lonTabDir'}/loncaparevs.tab") {
13034: if (open(my $config,"<$perlvar{'lonTabDir'}/loncaparevs.tab")) {
13035: while (my $configline=<$config>) {
13036: chomp($configline);
13037: my ($hostid,$loncaparev)=split(/:/,$configline);
13038: $loncaparevs{$hostid}=$loncaparev;
13039: }
13040: close($config);
13041: }
13042: }
13043: }
13044: }
13045:
13046: # ----------------------------------------------------- Read serverhostID table
13047: {
13048: sub load_serverhomeIDs {
13049: if (-e "$perlvar{'lonTabDir'}/serverhomeIDs.tab") {
13050: if (open(my $config,"<$perlvar{'lonTabDir'}/serverhomeIDs.tab")) {
13051: while (my $configline=<$config>) {
13052: chomp($configline);
13053: my ($name,$id)=split(/:/,$configline);
13054: $serverhomeIDs{$name}=$id;
13055: }
13056: close($config);
13057: }
13058: }
13059: }
13060: }
13061:
13062:
13063: BEGIN {
13064:
13065: # ----------------------------------- Read loncapa.conf and loncapa_apache.conf
13066: unless ($readit) {
13067: {
13068: my $configvars = LONCAPA::Configuration::read_conf('loncapa.conf');
13069: %perlvar = (%perlvar,%{$configvars});
13070: }
13071:
13072:
13073: # ------------------------------------------------------ Read spare server file
13074: {
13075: open(my $config,"<$perlvar{'lonTabDir'}/spare.tab");
13076:
13077: while (my $configline=<$config>) {
13078: chomp($configline);
13079: if ($configline) {
13080: my ($host,$type) = split(':',$configline,2);
13081: if (!defined($type) || $type eq '') { $type = 'default' };
13082: push(@{ $spareid{$type} }, $host);
13083: }
13084: }
13085: close($config);
13086: }
13087: # ------------------------------------------------------------ Read permissions
13088: {
13089: open(my $config,"<$perlvar{'lonTabDir'}/roles.tab");
13090:
13091: while (my $configline=<$config>) {
13092: chomp($configline);
13093: if ($configline) {
13094: my ($role,$perm)=split(/ /,$configline);
13095: if ($perm ne '') { $pr{$role}=$perm; }
13096: }
13097: }
13098: close($config);
13099: }
13100:
13101: # -------------------------------------------- Read plain texts for permissions
13102: {
13103: open(my $config,"<$perlvar{'lonTabDir'}/rolesplain.tab");
13104:
13105: while (my $configline=<$config>) {
13106: chomp($configline);
13107: if ($configline) {
13108: my ($short,@plain)=split(/:/,$configline);
13109: %{$prp{$short}} = ();
13110: if (@plain > 0) {
13111: $prp{$short}{'std'} = $plain[0];
13112: for (my $i=1; $i<@plain; $i++) {
13113: $prp{$short}{'alt'.$i} = $plain[$i];
13114: }
13115: }
13116: }
13117: }
13118: close($config);
13119: }
13120:
13121: # ---------------------------------------------------------- Read package table
13122: {
13123: open(my $config,"<$perlvar{'lonTabDir'}/packages.tab");
13124:
13125: while (my $configline=<$config>) {
13126: if ($configline !~ /\S/ || $configline=~/^#/) { next; }
13127: chomp($configline);
13128: my ($short,$plain)=split(/:/,$configline);
13129: my ($pack,$name)=split(/\&/,$short);
13130: if ($plain ne '') {
13131: $packagetab{$pack.'&'.$name.'&name'}=$name;
13132: $packagetab{$short}=$plain;
13133: }
13134: }
13135: close($config);
13136: }
13137:
13138: # --------------------------------------------------------- Read loncaparev table
13139:
13140: &load_loncaparevs();
13141:
13142: # ------------------------------------------------------- Read serverhostID table
13143:
13144: &load_serverhomeIDs();
13145:
13146: # ---------------------------------------------------------- Read releaseslist XML
13147: {
13148: my $file = $Apache::lonnet::perlvar{'lonTabDir'}.'/releaseslist.xml';
13149: if (-e $file) {
13150: my $parser = HTML::LCParser->new($file);
13151: while (my $token = $parser->get_token()) {
13152: if ($token->[0] eq 'S') {
13153: my $item = $token->[1];
13154: my $name = $token->[2]{'name'};
13155: my $value = $token->[2]{'value'};
13156: if ($item ne '' && $name ne '' && $value ne '') {
13157: my $release = $parser->get_text();
13158: $release =~ s/(^\s*|\s*$ )//gx;
13159: $needsrelease{$item.':'.$name.':'.$value} = $release;
13160: }
13161: }
13162: }
13163: }
13164: }
13165:
13166: # ---------------------------------------------------------- Read managers table
13167: {
13168: if (-e "$perlvar{'lonTabDir'}/managers.tab") {
13169: if (open(my $config,"<$perlvar{'lonTabDir'}/managers.tab")) {
13170: while (my $configline=<$config>) {
13171: chomp($configline);
13172: next if ($configline =~ /^\#/);
13173: if (($configline =~ /^[\w\-]+$/) || ($configline =~ /^[\w\-]+\:[\w\-]+$/)) {
13174: $managerstab{$configline} = 1;
13175: }
13176: }
13177: close($config);
13178: }
13179: }
13180: }
13181:
13182: # ------------- set up temporary directory
13183: {
13184: $tmpdir = LONCAPA::tempdir();
13185:
13186: }
13187:
13188: $memcache=new Cache::Memcached({'servers' => ['127.0.0.1:11211'],
13189: 'compress_threshold'=> 20_000,
13190: });
13191:
13192: $processmarker='_'.time.'_'.$perlvar{'lonHostID'};
13193: $dumpcount=0;
13194: $locknum=0;
13195:
13196: &logtouch();
13197: &logthis('<font color="yellow">INFO: Read configuration</font>');
13198: $readit=1;
13199: {
13200: use integer;
13201: my $test=(2**32)+1;
13202: if ($test != 0) { $_64bit=1; } else { $_64bit=0; }
13203: &logthis(" Detected 64bit platform ($_64bit)");
13204: }
13205: }
13206: }
13207:
13208: 1;
13209: __END__
13210:
13211: =pod
13212:
13213: =head1 NAME
13214:
13215: Apache::lonnet - Subroutines to ask questions about things in the network.
13216:
13217: =head1 SYNOPSIS
13218:
13219: Invoked by other LON-CAPA modules, when they need to talk to or about objects in the network.
13220:
13221: &Apache::lonnet::SUBROUTINENAME(ARGUMENTS);
13222:
13223: Common parameters:
13224:
13225: =over 4
13226:
13227: =item *
13228:
13229: $uname : an internal username (if $cname expecting a course Id specifically)
13230:
13231: =item *
13232:
13233: $udom : a domain (if $cdom expecting a course's domain specifically)
13234:
13235: =item *
13236:
13237: $symb : a resource instance identifier
13238:
13239: =item *
13240:
13241: $namespace : the name of a .db file that contains the data needed or
13242: being set.
13243:
13244: =back
13245:
13246: =head1 OVERVIEW
13247:
13248: lonnet provides subroutines which interact with the
13249: lonc/lond (TCP) network layer of LON-CAPA. They can be used to ask
13250: about classes, users, and resources.
13251:
13252: For many of these objects you can also use this to store data about
13253: them or modify them in various ways.
13254:
13255: =head2 Symbs
13256:
13257: To identify a specific instance of a resource, LON-CAPA uses symbols
13258: or "symbs"X<symb>. These identifiers are built from the URL of the
13259: map, the resource number of the resource in the map, and the URL of
13260: the resource itself. The latter is somewhat redundant, but might help
13261: if maps change.
13262:
13263: An example is
13264:
13265: msu/korte/parts/part1.sequence___19___msu/korte/tests/part12.problem
13266:
13267: The respective map entry is
13268:
13269: <resource id="19" src="/res/msu/korte/tests/part12.problem"
13270: title="Problem 2">
13271: </resource>
13272:
13273: Symbs are used by the random number generator, as well as to store and
13274: restore data specific to a certain instance of for example a problem.
13275:
13276: =head2 Storing And Retrieving Data
13277:
13278: X<store()>X<cstore()>X<restore()>Three of the most important functions
13279: in C<lonnet.pm> are C<&Apache::lonnet::cstore()>,
13280: C<&Apache::lonnet:restore()>, and C<&Apache::lonnet::store()>, which
13281: is is the non-critical message twin of cstore. These functions are for
13282: handlers to store a perl hash to a user's permanent data space in an
13283: easy manner, and to retrieve it again on another call. It is expected
13284: that a handler would use this once at the beginning to retrieve data,
13285: and then again once at the end to send only the new data back.
13286:
13287: The data is stored in the user's data directory on the user's
13288: homeserver under the ID of the course.
13289:
13290: The hash that is returned by restore will have all of the previous
13291: value for all of the elements of the hash.
13292:
13293: Example:
13294:
13295: #creating a hash
13296: my %hash;
13297: $hash{'foo'}='bar';
13298:
13299: #storing it
13300: &Apache::lonnet::cstore(\%hash);
13301:
13302: #changing a value
13303: $hash{'foo'}='notbar';
13304:
13305: #adding a new value
13306: $hash{'bar'}='foo';
13307: &Apache::lonnet::cstore(\%hash);
13308:
13309: #retrieving the hash
13310: my %history=&Apache::lonnet::restore();
13311:
13312: #print the hash
13313: foreach my $key (sort(keys(%history))) {
13314: print("\%history{$key} = $history{$key}");
13315: }
13316:
13317: Will print out:
13318:
13319: %history{1:foo} = bar
13320: %history{1:keys} = foo:timestamp
13321: %history{1:timestamp} = 990455579
13322: %history{2:bar} = foo
13323: %history{2:foo} = notbar
13324: %history{2:keys} = foo:bar:timestamp
13325: %history{2:timestamp} = 990455580
13326: %history{bar} = foo
13327: %history{foo} = notbar
13328: %history{timestamp} = 990455580
13329: %history{version} = 2
13330:
13331: Note that the special hash entries C<keys>, C<version> and
13332: C<timestamp> were added to the hash. C<version> will be equal to the
13333: total number of versions of the data that have been stored. The
13334: C<timestamp> attribute will be the UNIX time the hash was
13335: stored. C<keys> is available in every historical section to list which
13336: keys were added or changed at a specific historical revision of a
13337: hash.
13338:
13339: B<Warning>: do not store the hash that restore returns directly. This
13340: will cause a mess since it will restore the historical keys as if the
13341: were new keys. I.E. 1:foo will become 1:1:foo etc.
13342:
13343: Calling convention:
13344:
13345: my %record=&Apache::lonnet::restore($symb,$courseid,$domain,$uname);
13346: &Apache::lonnet::cstore(\%newrecord,$symb,$courseid,$domain,$uname,$laststore);
13347:
13348: For more detailed information, see lonnet specific documentation.
13349:
13350: =head1 RETURN MESSAGES
13351:
13352: =over 4
13353:
13354: =item * B<con_lost>: unable to contact remote host
13355:
13356: =item * B<con_delayed>: unable to contact remote host, message will be delivered
13357: when the connection is brought back up
13358:
13359: =item * B<con_failed>: unable to contact remote host and unable to save message
13360: for later delivery
13361:
13362: =item * B<error:>: an error a occurred, a description of the error follows the :
13363:
13364: =item * B<no_such_host>: unable to fund a host associated with the user/domain
13365: that was requested
13366:
13367: =back
13368:
13369: =head1 PUBLIC SUBROUTINES
13370:
13371: =head2 Session Environment Functions
13372:
13373: =over 4
13374:
13375: =item *
13376: X<appenv()>
13377: B<appenv($hashref,$rolesarrayref)>: the value of %{$hashref} is written to
13378: the user envirnoment file, and will be restored for each access this
13379: user makes during this session, also modifies the %env for the current
13380: process. Optional rolesarrayref - if defined contains a reference to an array
13381: of roles which are exempt from the restriction on modifying user.role entries
13382: in the user's environment.db and in %env.
13383:
13384: =item *
13385: X<delenv()>
13386: B<delenv($delthis,$regexp)>: removes all items from the session
13387: environment file that begin with $delthis. If the
13388: optional second arg - $regexp - is true, $delthis is treated as a
13389: regular expression, otherwise \Q$delthis\E is used.
13390: The values are also deleted from the current processes %env.
13391:
13392: =item * get_env_multiple($name)
13393:
13394: gets $name from the %env hash, it seemlessly handles the cases where multiple
13395: values may be defined and end up as an array ref.
13396:
13397: returns an array of values
13398:
13399: =back
13400:
13401: =head2 User Information
13402:
13403: =over 4
13404:
13405: =item *
13406: X<queryauthenticate()>
13407: B<queryauthenticate($uname,$udom)>: try to determine user's current
13408: authentication scheme
13409:
13410: =item *
13411: X<authenticate()>
13412: B<authenticate($uname,$upass,$udom,$checkdefauth,$clientcancheckhost)>: try to
13413: authenticate user from domain's lib servers (first use the current
13414: one). C<$upass> should be the users password.
13415: $checkdefauth is optional (value is 1 if a check should be made to
13416: authenticate user using default authentication method, and allow
13417: account creation if username does not have account in the domain).
13418: $clientcancheckhost is optional (value is 1 if checking whether the
13419: server can host will occur on the client side in lonauth.pm).
13420:
13421: =item *
13422: X<homeserver()>
13423: B<homeserver($uname,$udom)>: find the server which has
13424: the user's directory and files (there must be only one), this caches
13425: the answer, and also caches if there is a borken connection.
13426:
13427: =item *
13428: X<idget()>
13429: B<idget($udom,@ids)>: find the usernames behind a list of IDs
13430: (IDs are a unique resource in a domain, there must be only 1 ID per
13431: username, and only 1 username per ID in a specific domain) (returns
13432: hash: id=>name,id=>name)
13433:
13434: =item *
13435: X<idrget()>
13436: B<idrget($udom,@unames)>: find the IDs behind a list of
13437: usernames (returns hash: name=>id,name=>id)
13438:
13439: =item *
13440: X<idput()>
13441: B<idput($udom,%ids)>: store away a list of names and associated IDs
13442:
13443: =item *
13444: X<rolesinit()>
13445: B<rolesinit($udom,$username)>: get user privileges.
13446: returns user role, first access and timer interval hashes
13447:
13448: =item *
13449: X<privileged()>
13450: B<privileged($username,$domain)>: returns a true if user has a
13451: privileged and active role (i.e. su or dc), false otherwise.
13452:
13453: =item *
13454: X<getsection()>
13455: B<getsection($udom,$uname,$cname)>: finds the section of student in the
13456: course $cname, return section name/number or '' for "not in course"
13457: and '-1' for "no section"
13458:
13459: =item *
13460: X<userenvironment()>
13461: B<userenvironment($udom,$uname,@what)>: gets the values of the keys
13462: passed in @what from the requested user's environment, returns a hash
13463:
13464: =item *
13465: X<userlog_query()>
13466: B<userlog_query($uname,$udom,%filters)>: retrieves data from a user's
13467: activity.log file. %filters defines filters applied when parsing the
13468: log file. These can be start or end timestamps, or the type of action
13469: - log to look for Login or Logout events, check for Checkin or
13470: Checkout, role for role selection. The response is in the form
13471: timestamp1:hostid1:event1×tamp2:hostid2:event2 where events are
13472: escaped strings of the action recorded in the activity.log file.
13473:
13474: =back
13475:
13476: =head2 User Roles
13477:
13478: =over 4
13479:
13480: =item *
13481:
13482: allowed($priv,$uri,$symb,$role,$clientip,$noblockcheck) : check for a user privilege;
13483: returns codes for allowed actions.
13484:
13485: The first argument is required, all others are optional.
13486:
13487: $priv is the privilege being checked.
13488: $uri contains additional information about what is being checked for access (e.g.,
13489: URL, course ID etc.).
13490: $symb is the unique resource instance identifier in a course; if needed,
13491: but not provided, it will be retrieved via a call to &symbread().
13492: $role is the role for which a priv is being checked (only used if priv is evb).
13493: $clientip is the user's IP address (only used when checking for access to portfolio
13494: files).
13495: $noblockcheck, if true, skips calls to &has_comm_blocking() for the bre priv. This
13496: prevents recursive calls to &allowed.
13497:
13498: F: full access
13499: U,I,K: authentication modes (cxx only)
13500: '': forbidden
13501: 1: user needs to choose course
13502: 2: browse allowed
13503: A: passphrase authentication needed
13504: B: access temporarily blocked because of a blocking event in a course.
13505:
13506: =item *
13507:
13508: constructaccess($url,$setpriv) : check for access to construction space URL
13509:
13510: See if the owner domain and name in the URL match those in the
13511: expected environment. If so, return three element list
13512: ($ownername,$ownerdomain,$ownerhome).
13513:
13514: Otherwise return the null string.
13515:
13516: If second argument 'setpriv' is true, it assigns the privileges,
13517: and returns the same three element list, unless the owner has
13518: blocked "ad hoc" Domain Coordinator access to the Author Space,
13519: in which case the null string is returned.
13520:
13521: =item *
13522:
13523: definerole($rolename,$sysrole,$domrole,$courole,$uname,$udom) : define role;
13524: define a custom role rolename set privileges in format of lonTabs/roles.tab
13525: for system, domain, and course level. $uname and $udom are optional (current
13526: user's username and domain will be used when either of $uname or $udom are absent.
13527:
13528: =item *
13529:
13530: plaintext($short,$type,$cid,$forcedefault) : return value in %prp hash
13531: (rolesplain.tab); plain text explanation of a user role term.
13532: $type is Course (default) or Community.
13533: If $forcedefault evaluates to true, text returned will be default
13534: text for $type. Otherwise, if this is a course, the text returned
13535: will be a custom name for the role (if defined in the course's
13536: environment). If no custom name is defined the default is returned.
13537:
13538: =item *
13539:
13540: get_my_roles($uname,$udom,$context,$types,$roles,$roledoms,$withsec,$hidepriv) :
13541: All arguments are optional. Returns a hash of a roles, either for
13542: co-author/assistant author roles for a user's Construction Space
13543: (default), or if $context is 'userroles', roles for the user himself,
13544: In the hash, keys are set to colon-separated $uname,$udom,$role, and
13545: (optionally) if $withsec is true, a fourth colon-separated item - $section.
13546: For each key, value is set to colon-separated start and end times for
13547: the role. If no username and domain are specified, will default to
13548: current user/domain. Types, roles, and roledoms are references to arrays
13549: of role statuses (active, future or previous), roles
13550: (e.g., cc,in, st etc.) and domains of the roles which can be used
13551: to restrict the list of roles reported. If no array ref is
13552: provided for types, will default to return only active roles.
13553:
13554: =item *
13555:
13556: in_course($udom,$uname,$cdom,$cnum,$type,$hideprivileged) : determine if
13557: user: $uname:$udom has a role in the course: $cdom_$cnum.
13558:
13559: Additional optional arguments are: $type (if role checking is to be restricted
13560: to certain user status types -- previous (expired roles), active (currently
13561: available roles) or future (roles available in the future), and
13562: $hideprivileged -- if true will not report course roles for users who
13563: have active Domain Coordinator role in course's domain or in additional
13564: domains (specified in 'Domains to check for privileged users' in course
13565: environment -- set via: Course Settings -> Classlists and staff listing).
13566:
13567: =item *
13568:
13569: privileged($username,$domain,$possdomains,$possroles) : returns 1 if user
13570: $username:$domain is a privileged user (e.g., Domain Coordinator or Super User)
13571: $possdomains and $possroles are optional array refs -- to domains to check and
13572: roles to check. If $possdomains is not specified, a dump will be done of the
13573: users' roles.db to check for a dc or su role in any domain. This can be
13574: time consuming if &privileged is called repeatedly (e.g., when displaying a
13575: classlist), so in such cases, supplying a $possdomains array is preferred, as
13576: this then allows &privileged_by_domain() to be used, which caches the identity
13577: of privileged users, eliminating the need for repeated calls to &dump().
13578:
13579: =item *
13580:
13581: privileged_by_domain($possdomains,$roles) : returns a hash of a hash of a hash,
13582: where the outer hash keys are domains specified in the $possdomains array ref,
13583: next inner hash keys are privileged roles specified in the $roles array ref,
13584: and the innermost hash contains key = value pairs for username:domain = end:start
13585: for active or future "privileged" users with that role in that domain. To avoid
13586: repeated dumps of domain roles -- via &get_domain_roles() -- contents of the
13587: innerhash are cached using priv_$role and $dom as the identifiers.
13588:
13589: =back
13590:
13591: =head2 User Modification
13592:
13593: =over 4
13594:
13595: =item *
13596:
13597: assignrole($udom,$uname,$url,$role,$end,$start,$deleteflag,$selfenroll,$context) : assign role; give a role to a
13598: user for the level given by URL. Optional start and end dates (leave empty
13599: string or zero for "no date")
13600:
13601: =item *
13602:
13603: changepass($uname,$udom,$currentpass,$newpass,$server) : attempts to
13604: change a users, password, possible return values are: ok,
13605: pwchange_failure, non_authorized, auth_mode_error, unknown_user,
13606: refused
13607:
13608: =item *
13609:
13610: modifyuserauth($udom,$uname,$umode,$upass) : modify user authentication
13611:
13612: =item *
13613:
13614: modifyuser($udom,$uname,$uid,$umode,$upass,$first,$middle,$last, $gene,
13615: $forceid,$desiredhome,$email,$inststatus,$candelete) :
13616:
13617: will update user information (firstname,middlename,lastname,generation,
13618: permanentemail), and if forceid is true, student/employee ID also.
13619: A user's institutional affiliation(s) can also be updated.
13620: User information fields will not be overwritten with empty entries
13621: unless the field is included in the $candelete array reference.
13622: This array is included when a single user is modified via "Manage Users",
13623: or when Autoupdate.pl is run by cron in a domain.
13624:
13625: =item *
13626:
13627: modifystudent
13628:
13629: modify a student's enrollment and identification information.
13630: The course id is resolved based on the current user's environment.
13631: This means the invoking user must be a course coordinator or otherwise
13632: associated with a course.
13633:
13634: This call is essentially a wrapper for lonnet::modifyuser and
13635: lonnet::modify_student_enrollment
13636:
13637: Inputs:
13638:
13639: =over 4
13640:
13641: =item B<$udom> Student's loncapa domain
13642:
13643: =item B<$uname> Student's loncapa login name
13644:
13645: =item B<$uid> Student/Employee ID
13646:
13647: =item B<$umode> Student's authentication mode
13648:
13649: =item B<$upass> Student's password
13650:
13651: =item B<$first> Student's first name
13652:
13653: =item B<$middle> Student's middle name
13654:
13655: =item B<$last> Student's last name
13656:
13657: =item B<$gene> Student's generation
13658:
13659: =item B<$usec> Student's section in course
13660:
13661: =item B<$end> Unix time of the roles expiration
13662:
13663: =item B<$start> Unix time of the roles start date
13664:
13665: =item B<$forceid> If defined, allow $uid to be changed
13666:
13667: =item B<$desiredhome> server to use as home server for student
13668:
13669: =item B<$email> Student's permanent e-mail address
13670:
13671: =item B<$type> Type of enrollment (auto or manual)
13672:
13673: =item B<$locktype> boolean - enrollment type locked to prevent Autoenroll.pl changing manual to auto
13674:
13675: =item B<$cid> courseID - needed if a course role is assigned by a user whose current role is DC
13676:
13677: =item B<$selfenroll> boolean - 1 if user role change occurred via self-enrollment
13678:
13679: =item B<$context> role change context (shown in User Management Logs display in a course)
13680:
13681: =item B<$inststatus> institutional status of user - : separated string of escaped status types
13682:
13683: =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.
13684:
13685: =back
13686:
13687: =item *
13688:
13689: modify_student_enrollment
13690:
13691: Change a student's enrollment status in a class. The environment variable
13692: 'role.request.course' must be defined for this function to proceed.
13693:
13694: Inputs:
13695:
13696: =over 4
13697:
13698: =item $udom, student's domain
13699:
13700: =item $uname, student's name
13701:
13702: =item $uid, student's user id
13703:
13704: =item $first, student's first name
13705:
13706: =item $middle
13707:
13708: =item $last
13709:
13710: =item $gene
13711:
13712: =item $usec
13713:
13714: =item $end
13715:
13716: =item $start
13717:
13718: =item $type
13719:
13720: =item $locktype
13721:
13722: =item $cid
13723:
13724: =item $selfenroll
13725:
13726: =item $context
13727:
13728: =item $credits, number of credits student will earn from this class
13729:
13730: =item $instsec, institutional course section code for student
13731:
13732: =back
13733:
13734:
13735: =item *
13736:
13737: assigncustomrole($udom,$uname,$url,$rdom,$rnam,$rolename,$end,$start) : assign
13738: custom role; give a custom role to a user for the level given by URL. Specify
13739: name and domain of role author, and role name
13740:
13741: =item *
13742:
13743: revokerole($udom,$uname,$url,$role) : revoke a role for url
13744:
13745: =item *
13746:
13747: revokecustomrole($udom,$uname,$url,$role) : revoke a custom role
13748:
13749: =back
13750:
13751: =head2 Course Infomation
13752:
13753: =over 4
13754:
13755: =item *
13756:
13757: coursedescription($courseid,$options) : returns a hash of information about the
13758: specified course id, including all environment settings for the
13759: course, the description of the course will be in the hash under the
13760: key 'description'
13761:
13762: $options is an optional parameter that if supplied is a hash reference that controls
13763: what how this function works. It has the following key/values:
13764:
13765: =over 4
13766:
13767: =item freshen_cache
13768:
13769: If defined, and the environment cache for the course is valid, it is
13770: returned in the returned hash.
13771:
13772: =item one_time
13773:
13774: If defined, the last cache time is set to _now_
13775:
13776: =item user
13777:
13778: If defined, the supplied username is used instead of the current user.
13779:
13780:
13781: =back
13782:
13783: =item *
13784:
13785: resdata($name,$domain,$type,@which) : request for current parameter
13786: setting for a specific $type, where $type is either 'course' or 'user',
13787: @what should be a list of parameters to ask about. This routine caches
13788: answers for 10 minutes.
13789:
13790: =item *
13791:
13792: get_courseresdata($courseid, $domain) : dump the entire course resource
13793: data base, returning a hash that is keyed by the resource name and has
13794: values that are the resource value. I believe that the timestamps and
13795: versions are also returned.
13796:
13797: get_numsuppfiles($cnum,$cdom) : retrieve number of files in a course's
13798: supplemental content area. This routine caches the number of files for
13799: 10 minutes.
13800:
13801: =back
13802:
13803: =head2 Course Modification
13804:
13805: =over 4
13806:
13807: =item *
13808:
13809: writecoursepref($courseid,%prefs) : write preferences (environment
13810: database) for a course
13811:
13812: =item *
13813:
13814: createcourse($udom,$description,$url,$course_server,$nonstandard,$inst_code,$course_owner,$crstype,$cnum) : make course
13815:
13816: =item *
13817:
13818: generate_coursenum($udom,$crstype) : get a unique (unused) course number in domain $udom for course type $crstype (Course or Community).
13819:
13820: =item *
13821:
13822: is_course($courseid), is_course($cdom, $cnum)
13823:
13824: Accepts either a combined $courseid (in the form of domain_courseid) or the
13825: two component version $cdom, $cnum. It checks if the specified course exists.
13826:
13827: Returns:
13828: undef if the course doesn't exist, otherwise
13829: in scalar context the combined courseid.
13830: in list context the two components of the course identifier, domain and
13831: courseid.
13832:
13833: =back
13834:
13835: =head2 Resource Subroutines
13836:
13837: =over 4
13838:
13839: =item *
13840:
13841: subscribe($fname) : subscribe to a resource, returns URL if possible (probably should use repcopy instead)
13842:
13843: =item *
13844:
13845: repcopy($filename) : subscribes to the requested file, and attempts to
13846: replicate from the owning library server, Might return
13847: 'unavailable', 'not_found', 'forbidden', 'ok', or
13848: 'bad_request', also attempts to grab the metadata for the
13849: resource. Expects the local filesystem pathname
13850: (/home/httpd/html/res/....)
13851:
13852: =back
13853:
13854: =head2 Resource Information
13855:
13856: =over 4
13857:
13858: =item *
13859:
13860: EXT($varname,$symb,$udom,$uname,$usection,$recurse,$cid) : evaluates
13861: and returns the value of a variety of different possible values,
13862: $varname should be a request string, and the other parameters can be
13863: used to specify who and what one is asking about. Ordinarily, $cid
13864: does not need to be specified, as it is retrived from
13865: $env{'request.course.id'}, but &Apache::lonnet::EXT() is called
13866: within lonuserstate::loadmap() when initializing a course, before
13867: $env{'request.course.id'} has been set, so it needs to be provided
13868: in that one case.
13869:
13870: Possible values for $varname are environment.lastname (or other item
13871: from the envirnment hash), user.name (or someother aspect about the
13872: user), resource.0.maxtries (or some other part and parameter of a
13873: resource)
13874:
13875: =item *
13876:
13877: directcondval($number) : get current value of a condition; reads from a state
13878: string
13879:
13880: =item *
13881:
13882: condval($condidx) : value of condition index based on state
13883:
13884: =item *
13885:
13886: metadata($uri,$what,$liburi,$prefix,$depthcount) : request a
13887: resource's metadata, $what should be either a specific key, or either
13888: 'keys' (to get a list of possible keys) or 'packages' to get a list of
13889: packages that this resource currently uses, the last 3 arguments are only used internally for recursive metadata.
13890:
13891: this function automatically caches all requests
13892:
13893: =item *
13894:
13895: metadata_query($query,$custom,$customshow) : make a metadata query against the
13896: network of library servers; returns file handle of where SQL and regex results
13897: will be stored for query
13898:
13899: =item *
13900:
13901: symbread($filename,$donotrecurse,$ignorecachednull,$checkforblock,$possibles) :
13902: return symbolic list entry (all arguments optional).
13903:
13904: Args: filename is the filename (including path) for the file for which a symb
13905: is required; donotrecurse, if true will prevent calls to allowed() being made
13906: to check access status if more than one resource was found in the bighash
13907: (see rev. 1.249) to avoid an infinite loop if an ambiguous resource is part of
13908: a randompick); ignorecachednull, if true will prevent a symb of '' being
13909: returned if $env{$cache_str} is defined as ''; checkforblock if true will
13910: cause possible symbs to be checked to determine if they are subject to content
13911: blocking, if so they will not be included as possible symbs; possibles is a
13912: ref to a hash, which, as a side effect, will be populated with all possible
13913: symbs (content blocking not tested).
13914:
13915: returns the data handle
13916:
13917: =item *
13918:
13919: symbverify($symb,$thisfn,$encstate) : verifies that $symb actually exists
13920: and is a possible symb for the URL in $thisfn, and if is an encrypted
13921: resource that the user accessed using /enc/ returns a 1 on success, 0
13922: on failure, user must be in a course, as it assumes the existence of
13923: the course initial hash, and uses $env('request.course.id'}. The third
13924: arg is an optional reference to a scalar. If this arg is passed in the
13925: call to symbverify, it will be set to 1 if the symb has been set to be
13926: encrypted; otherwise it will be null.
13927:
13928: =item *
13929:
13930: symbclean($symb) : removes versions numbers from a symb, returns the
13931: cleaned symb
13932:
13933: =item *
13934:
13935: is_on_map($uri) : checks if the $uri is somewhere on the current
13936: course map, user must be in a course for it to work.
13937:
13938: =item *
13939:
13940: numval($salt) : return random seed value (addend for rndseed)
13941:
13942: =item *
13943:
13944: rndseed($symb,$courseid,$udom,$uname) : create a random sum; returns
13945: a random seed, all arguments are optional, if they aren't sent it uses the
13946: environment to derive them. Note: if symb isn't sent and it can't get one
13947: from &symbread it will use the current time as its return value
13948:
13949: =item *
13950:
13951: ireceipt($funame,$fudom,$fucourseid,$fusymb) : return unique,
13952: unfakeable, receipt
13953:
13954: =item *
13955:
13956: receipt() : API to ireceipt working off of env values; given out to users
13957:
13958: =item *
13959:
13960: countacc($url) : count the number of accesses to a given URL
13961:
13962: =item *
13963:
13964: 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
13965:
13966: =item *
13967:
13968: 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)
13969:
13970: =item *
13971:
13972: expirespread($uname,$udom,$stype,$usymb) : set expire date for spreadsheet
13973:
13974: =item *
13975:
13976: devalidate($symb) : devalidate temporary spreadsheet calculations,
13977: forcing spreadsheet to reevaluate the resource scores next time.
13978:
13979: =item *
13980:
13981: can_edit_resource($file,$cnum,$cdom,$resurl,$symb,$group) : determine if current user can edit a particular resource,
13982: when viewing in course context.
13983:
13984: input: six args -- filename (decluttered), course number, course domain,
13985: url, symb (if registered) and group (if this is a
13986: group item -- e.g., bulletin board, group page etc.).
13987:
13988: output: array of five scalars --
13989: $cfile -- url for file editing if editable on current server
13990: $home -- homeserver of resource (i.e., for author if published,
13991: or course if uploaded.).
13992: $switchserver -- 1 if server switch will be needed.
13993: $forceedit -- 1 if icon/link should be to go to edit mode
13994: $forceview -- 1 if icon/link should be to go to view mode
13995:
13996: =item *
13997:
13998: is_course_upload($file,$cnum,$cdom)
13999:
14000: Used in course context to determine if current file was uploaded to
14001: the course (i.e., would be found in /userfiles/docs on the course's
14002: homeserver.
14003:
14004: input: 3 args -- filename (decluttered), course number and course domain.
14005: output: boolean -- 1 if file was uploaded.
14006:
14007: =back
14008:
14009: =head2 Storing/Retreiving Data
14010:
14011: =over 4
14012:
14013: =item *
14014:
14015: store($storehash,$symb,$namespace,$udom,$uname,$laststore) : stores hash
14016: permanently for this url; hashref needs to be given and should be a \%hashname;
14017: the remaining args aren't required and if they aren't passed or are '' they will
14018: be derived from the env (with the exception of $laststore, which is an
14019: optional arg used when a user's submission is stored in grading).
14020: $laststore is $version=$timestamp, where $version is the most recent version
14021: number retrieved for the corresponding $symb in the $namespace db file, and
14022: $timestamp is the timestamp for that transaction (UNIX time).
14023: $laststore is currently only passed when cstore() is called by
14024: structuretags::finalize_storage().
14025:
14026: =item *
14027:
14028: cstore($storehash,$symb,$namespace,$udom,$uname,$laststore) : same as store
14029: but uses critical subroutine
14030:
14031: =item *
14032:
14033: restore($symb,$namespace,$udom,$uname) : returns hash for this symb;
14034: all args are optional
14035:
14036: =item *
14037:
14038: dumpstore($namespace,$udom,$uname,$regexp,$range) :
14039: dumps the complete (or key matching regexp) namespace into a hash
14040: ($udom, $uname, $regexp, $range are optional) for a namespace that is
14041: normally &store()ed into
14042:
14043: $range should be either an integer '100' (give me the first 100
14044: matching records)
14045: or be two integers sperated by a - with no spaces
14046: '30-50' (give me the 30th through the 50th matching
14047: records)
14048:
14049:
14050: =item *
14051:
14052: putstore($namespace,$symb,$version,$storehash,$udomain,$uname,$tolog) :
14053: replaces a &store() version of data with a replacement set of data
14054: for a particular resource in a namespace passed in the $storehash hash
14055: reference. If $tolog is true, the transaction is logged in the courselog
14056: with an action=PUTSTORE.
14057:
14058: =item *
14059:
14060: tmpstore($storehash,$symb,$namespace,$udom,$uname) : storage that
14061: works very similar to store/cstore, but all data is stored in a
14062: temporary location and can be reset using tmpreset, $storehash should
14063: be a hash reference, returns nothing on success
14064:
14065: =item *
14066:
14067: tmprestore($symb,$namespace,$udom,$uname) : storage that works very
14068: similar to restore, but all data is stored in a temporary location and
14069: can be reset using tmpreset. Returns a hash of values on success,
14070: error string otherwise.
14071:
14072: =item *
14073:
14074: tmpreset($symb,$namespace,$udom,$uname) : temporary storage reset,
14075: deltes all keys for $symb form the temporary storage hash.
14076:
14077: =item *
14078:
14079: get($namespace,$storearr,$udom,$uname) : returns hash with keys from array
14080: reference filled in from namesp ($udom and $uname are optional)
14081:
14082: =item *
14083:
14084: del($namespace,$storearr,$udom,$uname) : deletes keys out of array from
14085: namesp ($udom and $uname are optional)
14086:
14087: =item *
14088:
14089: dump($namespace,$udom,$uname,$regexp,$range) :
14090: dumps the complete (or key matching regexp) namespace into a hash
14091: ($udom, $uname, $regexp, $range are optional)
14092:
14093: $range should be either an integer '100' (give me the first 100
14094: matching records)
14095: or be two integers sperated by a - with no spaces
14096: '30-50' (give me the 30th through the 50th matching
14097: records)
14098: =item *
14099:
14100: inc($namespace,$store,$udom,$uname) : increments $store in $namespace.
14101: $store can be a scalar, an array reference, or if the amount to be
14102: incremented is > 1, a hash reference.
14103:
14104: ($udom and $uname are optional)
14105:
14106: =item *
14107:
14108: put($namespace,$storehash,$udom,$uname) : stores hash in namesp
14109: ($udom and $uname are optional)
14110:
14111: =item *
14112:
14113: cput($namespace,$storehash,$udom,$uname) : critical put
14114: ($udom and $uname are optional)
14115:
14116: =item *
14117:
14118: newput($namespace,$storehash,$udom,$uname) :
14119:
14120: Attempts to store the items in the $storehash, but only if they don't
14121: currently exist, if this succeeds you can be certain that you have
14122: successfully created a new key value pair in the $namespace db.
14123:
14124:
14125: Args:
14126: $namespace: name of database to store values to
14127: $storehash: hashref to store to the db
14128: $udom: (optional) domain of user containing the db
14129: $uname: (optional) name of user caontaining the db
14130:
14131: Returns:
14132: 'ok' -> succeeded in storing all keys of $storehash
14133: 'key_exists: <key>' -> failed to anything out of $storehash, as at
14134: least <key> already existed in the db (other
14135: requested keys may also already exist)
14136: 'error: <msg>' -> unable to tie the DB or other error occurred
14137: 'con_lost' -> unable to contact request server
14138: 'refused' -> action was not allowed by remote machine
14139:
14140:
14141: =item *
14142:
14143: eget($namespace,$storearr,$udom,$uname) : returns hash with keys from array
14144: reference filled in from namesp (encrypts the return communication)
14145: ($udom and $uname are optional)
14146:
14147: =item *
14148:
14149: log($udom,$name,$home,$message) : write to permanent log for user; use
14150: critical subroutine
14151:
14152: =item *
14153:
14154: get_dom($namespace,$storearr,$udom,$uhome) : returns hash with keys from
14155: array reference filled in from namespace found in domain level on either
14156: specified domain server ($uhome) or primary domain server ($udom and $uhome are optional).
14157:
14158: =item *
14159:
14160: put_dom($namespace,$storehash,$udom,$uhome) : stores hash in namespace at
14161: domain level either on specified domain server ($uhome) or primary domain
14162: server ($udom and $uhome are optional)
14163:
14164: =item *
14165:
14166: get_domain_defaults($target_domain,$ignore_cache) : returns hash with defaults
14167: for: authentication, language, quotas, timezone, date locale, and portal URL in
14168: the target domain.
14169:
14170: May also include additional key => value pairs for the following groups:
14171:
14172: =over
14173:
14174: =item
14175: disk quotas (MB allocated by default to portfolios and authoring spaces).
14176:
14177: =over
14178:
14179: =item defaultquota, authorquota
14180:
14181: =back
14182:
14183: =item
14184: tools (availability of aboutme page, blog, webDAV access for authoring spaces,
14185: portfolio for users).
14186:
14187: =over
14188:
14189: =item
14190: aboutme, blog, webdav, portfolio
14191:
14192: =back
14193:
14194: =item
14195: requestcourses: ability to request courses, and how requests are processed.
14196:
14197: =over
14198:
14199: =item
14200: official, unofficial, community, textbook
14201:
14202: =back
14203:
14204: =item
14205: inststatus: types of institutional affiliation, and order in which they are displayed.
14206:
14207: =over
14208:
14209: =item
14210: inststatustypes, inststatusorder, inststatusguest
14211:
14212: =back
14213:
14214: =item
14215: coursedefaults: can PDF forms can be created, default credits for courses, default quotas (MB)
14216: for course's uploaded content.
14217:
14218: =over
14219:
14220: =item
14221: canuse_pdfforms, officialcredits, unofficialcredits, textbookcredits, officialquota, unofficialquota,
14222: communityquota, textbookquota
14223:
14224: =back
14225:
14226: =item
14227: usersessions: set options for hosting of your users in other domains, and hosting of users from other domains
14228: on your servers.
14229:
14230: =over
14231:
14232: =item
14233: remotesessions, hostedsessions
14234:
14235: =back
14236:
14237: =back
14238:
14239: In cases where a domain coordinator has never used the "Set Domain Configuration"
14240: utility to create a configuration.db file on a domain's primary library server
14241: only the following domain defaults: auth_def, auth_arg_def, lang_def
14242: -- corresponding values are authentication type (internal, krb4, krb5,
14243: or localauth), initial password or a kerberos realm, language (e.g., en-us) --
14244: will be available. Values are retrieved from cache (if current), unless the
14245: optional $ignore_cache arg is true, or from domain's configuration.db (if available),
14246: or lastly from values in lonTabs/dns_domain,tab, or lonTabs/domain.tab.
14247:
14248: Typical usage:
14249:
14250: %domdefaults = &get_domain_defaults($target_domain);
14251:
14252: =back
14253:
14254: =head2 Network Status Functions
14255:
14256: =over 4
14257:
14258: =item *
14259:
14260: dirlist() : return directory list based on URI (first arg).
14261:
14262: Inputs: 1 required, 5 optional.
14263:
14264: =over
14265:
14266: =item
14267: $uri - path to file in filesystem (starts: /res or /userfiles/). Required.
14268:
14269: =item
14270: $userdomain - domain of user/course to be listed. Extracted from $uri if absent.
14271:
14272: =item
14273: $username - username of user/course to be listed. Extracted from $uri if absent.
14274:
14275: =item
14276: $getpropath - boolean: 1 if prepend path using &propath().
14277:
14278: =item
14279: $getuserdir - boolean: 1 if prepend path for "userfiles".
14280:
14281: =item
14282: $alternateRoot - path to prepend in place of path from $uri.
14283:
14284: =back
14285:
14286: Returns: Array of up to two items.
14287:
14288: =over
14289:
14290: a reference to an array of files/subdirectories
14291:
14292: =over
14293:
14294: Each element in the array of files/subdirectories is a & separated list of
14295: item name and the result of running stat on the item. If dirlist was requested
14296: for a file instead of a directory, the item name will be ''. For a directory
14297: listing, if the item is a metadata file, the element will end &N&M
14298: (where N amd M are either 0 or 1, corresponding to obsolete set (1), or
14299: default copyright set (1).
14300:
14301: =back
14302:
14303: a scalar containing error condition (if encountered).
14304:
14305: =over
14306:
14307: =item
14308: no_host (no homeserver identified for $username:$domain).
14309:
14310: =item
14311: no_such_host (server contacted for listing not identified as valid host).
14312:
14313: =item
14314: con_lost (connection to remote server failed).
14315:
14316: =item
14317: refused (invalid $username:$domain received on lond side).
14318:
14319: =item
14320: no_such_dir (directory at specified path on lond side does not exist).
14321:
14322: =item
14323: empty (directory at specified path on lond side is empty).
14324:
14325: =over
14326:
14327: This is currently not encountered because the &ls3, &ls2,
14328: &ls (_handler) routines on the lond side do not filter out
14329: . and .. from a directory listing.
14330:
14331: =back
14332:
14333: =back
14334:
14335: =back
14336:
14337: =item *
14338:
14339: spareserver() : find server with least workload from spare.tab
14340:
14341:
14342: =item *
14343:
14344: host_from_dns($dns) : Returns the loncapa hostname corresponding to a DNS name or undef
14345: if there is no corresponding loncapa host.
14346:
14347: =back
14348:
14349:
14350: =head2 Apache Request
14351:
14352: =over 4
14353:
14354: =item *
14355:
14356: ssi($url,%hash) : server side include, does a complete request cycle on url to
14357: localhost, posts hash
14358:
14359: =back
14360:
14361: =head2 Data to String to Data
14362:
14363: =over 4
14364:
14365: =item *
14366:
14367: hash2str(%hash) : convert a hash into a string complete with escaping and '='
14368: and '&' separators, supports elements that are arrayrefs and hashrefs
14369:
14370: =item *
14371:
14372: hashref2str($hashref) : convert a hashref into a string complete with
14373: escaping and '=' and '&' separators, supports elements that are
14374: arrayrefs and hashrefs
14375:
14376: =item *
14377:
14378: arrayref2str($arrayref) : convert an arrayref into a string complete
14379: with escaping and '&' separators, supports elements that are arrayrefs
14380: and hashrefs
14381:
14382: =item *
14383:
14384: str2hash($string) : convert string to hash using unescaping and
14385: splitting on '=' and '&', supports elements that are arrayrefs and
14386: hashrefs
14387:
14388: =item *
14389:
14390: str2array($string) : convert string to hash using unescaping and
14391: splitting on '&', supports elements that are arrayrefs and hashrefs
14392:
14393: =back
14394:
14395: =head2 Logging Routines
14396:
14397:
14398: These routines allow one to make log messages in the lonnet.log and
14399: lonnet.perm logfiles.
14400:
14401: =over 4
14402:
14403: =item *
14404:
14405: logtouch() : make sure the logfile, lonnet.log, exists
14406:
14407: =item *
14408:
14409: logthis() : append message to the normal lonnet.log file, it gets
14410: preiodically rolled over and deleted.
14411:
14412: =item *
14413:
14414: logperm() : append a permanent message to lonnet.perm.log, this log
14415: file never gets deleted by any automated portion of the system, only
14416: messages of critical importance should go in here.
14417:
14418:
14419: =back
14420:
14421: =head2 General File Helper Routines
14422:
14423: =over 4
14424:
14425: =item *
14426:
14427: getfile($file,$caller) : two cases - requests for files in /res or in /uploaded.
14428: (a) files in /uploaded
14429: (i) If a local copy of the file exists -
14430: compares modification date of local copy with last-modified date for
14431: definitive version stored on home server for course. If local copy is
14432: stale, requests a new version from the home server and stores it.
14433: If the original has been removed from the home server, then local copy
14434: is unlinked.
14435: (ii) If local copy does not exist -
14436: requests the file from the home server and stores it.
14437:
14438: If $caller is 'uploadrep':
14439: This indicates a call from lonuploadrep.pm (PerlHeaderParserHandler phase)
14440: for request for files originally uploaded via DOCS.
14441: - returns 'ok' if fresh local copy now available, -1 otherwise.
14442:
14443: Otherwise:
14444: This indicates a call from the content generation phase of the request.
14445: - returns the entire contents of the file or -1.
14446:
14447: (b) files in /res
14448: - returns the entire contents of a file or -1;
14449: it properly subscribes to and replicates the file if neccessary.
14450:
14451:
14452: =item *
14453:
14454: stat_file($url) : $url is expected to be a /res/ or /uploaded/ style file
14455: reference
14456:
14457: returns either a stat() list of data about the file or an empty list
14458: if the file doesn't exist or couldn't find out about it (connection
14459: problems or user unknown)
14460:
14461: =item *
14462:
14463: filelocation($dir,$file) : returns file system location of a file
14464: based on URI; meant to be "fairly clean" absolute reference, $dir is a
14465: directory that relative $file lookups are to looked in ($dir of /a/dir
14466: and a file of ../bob will become /a/bob)
14467:
14468: =item *
14469:
14470: hreflocation($dir,$file) : returns file system location or a URL; same as
14471: filelocation except for hrefs
14472:
14473: =item *
14474:
14475: declutter() : declutters URLs -- remove beginning slashes, 'res' etc.
14476: also removes beginning /home/httpd/html unless /priv/ follows it.
14477:
14478: =back
14479:
14480: =head2 Usererfile file routines (/uploaded*)
14481:
14482: =over 4
14483:
14484: =item *
14485:
14486: userfileupload(): main rotine for putting a file in a user or course's
14487: filespace, arguments are,
14488:
14489: formname - required - this is the name of the element in $env where the
14490: filename, and the contents of the file to create/modifed exist
14491: the filename is in $env{'form.'.$formname.'.filename'} and the
14492: contents of the file is located in $env{'form.'.$formname}
14493: context - if coursedoc, store the file in the course of the active role
14494: of the current user;
14495: if 'existingfile': store in 'overwrites' in /home/httpd/perl/tmp
14496: if 'canceloverwrite': delete file in tmp/overwrites directory
14497: subdir - required - subdirectory to put the file in under ../userfiles/
14498: if undefined, it will be placed in "unknown"
14499:
14500: (This routine calls clean_filename() to remove any dangerous
14501: characters from the filename, and then calls finuserfileupload() to
14502: complete the transaction)
14503:
14504: returns either the url of the uploaded file (/uploaded/....) if successful
14505: and /adm/notfound.html if unsuccessful
14506:
14507: =item *
14508:
14509: clean_filename(): routine for cleaing a filename up for storage in
14510: userfile space, argument is:
14511:
14512: filename - proposed filename
14513:
14514: returns: the new clean filename
14515:
14516: =item *
14517:
14518: finishuserfileupload(): routine that creates and sends the file to
14519: userspace, probably shouldn't be called directly
14520:
14521: docuname: username or courseid of destination for the file
14522: docudom: domain of user/course of destination for the file
14523: formname: same as for userfileupload()
14524: fname: filename (including subdirectories) for the file
14525: parser: if 'parse', will parse (html) file to extract references to objects, links etc.
14526: allfiles: reference to hash used to store objects found by parser
14527: codebase: reference to hash used for codebases of java objects found by parser
14528: thumbwidth: width (pixels) of thumbnail to be created for uploaded image
14529: thumbheight: height (pixels) of thumbnail to be created for uploaded image
14530: resizewidth: width to be used to resize image using resizeImage from ImageMagick
14531: resizeheight: height to be used to resize image using resizeImage from ImageMagick
14532: context: if 'overwrite', will move the uploaded file from its temporary location to
14533: userfiles to facilitate overwriting a previously uploaded file with same name.
14534: mimetype: reference to scalar to accommodate mime type determined
14535: from File::MMagic if $parser = parse.
14536:
14537: returns either the url of the uploaded file (/uploaded/....) if successful
14538: and /adm/notfound.html if unsuccessful (or an error message if context
14539: was 'overwrite').
14540:
14541:
14542: =item *
14543:
14544: renameuserfile(): renames an existing userfile to a new name
14545:
14546: Args:
14547: docuname: username or courseid of destination for the file
14548: docudom: domain of user/course of destination for the file
14549: old: current file name (including any subdirs under userfiles)
14550: new: desired file name (including any subdirs under userfiles)
14551:
14552: =item *
14553:
14554: mkdiruserfile(): creates a directory is a userfiles dir
14555:
14556: Args:
14557: docuname: username or courseid of destination for the file
14558: docudom: domain of user/course of destination for the file
14559: dir: dir to create (including any subdirs under userfiles)
14560:
14561: =item *
14562:
14563: removeuserfile(): removes a file that exists in userfiles
14564:
14565: Args:
14566: docuname: username or courseid of destination for the file
14567: docudom: domain of user/course of destination for the file
14568: fname: filname to delete (including any subdirs under userfiles)
14569:
14570: =item *
14571:
14572: removeuploadedurl(): convience function for removeuserfile()
14573:
14574: Args:
14575: url: a full /uploaded/... url to delete
14576:
14577: =item *
14578:
14579: get_portfile_permissions():
14580: Args:
14581: domain: domain of user or course contain the portfolio files
14582: user: name of user or num of course contain the portfolio files
14583: Returns:
14584: hashref of a dump of the proper file_permissions.db
14585:
14586:
14587: =item *
14588:
14589: get_access_controls():
14590:
14591: Args:
14592: current_permissions: the hash ref returned from get_portfile_permissions()
14593: group: (optional) the group you want the files associated with
14594: file: (optional) the file you want access info on
14595:
14596: Returns:
14597: a hash (keys are file names) of hashes containing
14598: keys are: path to file/file_name\0uniqueID:scope_end_start (see below)
14599: values are XML containing access control settings (see below)
14600:
14601: Internal notes:
14602:
14603: access controls are stored in file_permissions.db as key=value pairs.
14604: key -> path to file/file_name\0uniqueID:scope_end_start
14605: where scope -> public,guest,course,group,domains or users.
14606: end -> UNIX time for end of access (0 -> no end date)
14607: start -> UNIX time for start of access
14608:
14609: value -> XML description of access control
14610: <scope type=""> (type =1 of: public,guest,course,group,domains,users">
14611: <start></start>
14612: <end></end>
14613:
14614: <password></password> for scope type = guest
14615:
14616: <domain></domain> for scope type = course or group
14617: <number></number>
14618: <roles id="">
14619: <role></role>
14620: <access></access>
14621: <section></section>
14622: <group></group>
14623: </roles>
14624:
14625: <dom></dom> for scope type = domains
14626:
14627: <users> for scope type = users
14628: <user>
14629: <uname></uname>
14630: <udom></udom>
14631: </user>
14632: </users>
14633: </scope>
14634:
14635: Access data is also aggregated for each file in an additional key=value pair:
14636: key -> path to file/file_name\0accesscontrol
14637: value -> reference to hash
14638: hash contains key = value pairs
14639: where key = uniqueID:scope_end_start
14640: value = UNIX time record was last updated
14641:
14642: Used to improve speed of look-ups of access controls for each file.
14643:
14644: Locks on files (resulting from submission of portfolio file to a homework problem stored in array of arrays.
14645:
14646: =item *
14647:
14648: modify_access_controls():
14649:
14650: Modifies access controls for a portfolio file
14651: Args
14652: 1. file name
14653: 2. reference to hash of required changes,
14654: 3. domain
14655: 4. username
14656: where domain,username are the domain of the portfolio owner
14657: (either a user or a course)
14658:
14659: Returns:
14660: 1. result of additions or updates ('ok' or 'error', with error message).
14661: 2. result of deletions ('ok' or 'error', with error message).
14662: 3. reference to hash of any new or updated access controls.
14663: 4. reference to hash used to map incoming IDs to uniqueIDs assigned to control.
14664: key = integer (inbound ID)
14665: value = uniqueID
14666:
14667: =item *
14668:
14669: get_timebased_id():
14670:
14671: Attempts to get a unique timestamp-based suffix for use with items added to a
14672: course via the Course Editor (e.g., folders, composite pages,
14673: group bulletin boards).
14674:
14675: Args: (first three required; six others optional)
14676:
14677: 1. prefix (alphanumeric): of keys in hash, e.g., suppsequence, docspage,
14678: docssequence, or name of group
14679:
14680: 2. keyid (alphanumeric): name of temporary locking key in hash,
14681: e.g., num, boardids
14682:
14683: 3. namespace: name of gdbm file used to store suffixes already assigned;
14684: file will be named nohist_namespace.db
14685:
14686: 4. cdom: domain of course; default is current course domain from %env
14687:
14688: 5. cnum: course number; default is current course number from %env
14689:
14690: 6. idtype: set to concat if an additional digit is to be appended to the
14691: unix timestamp to form the suffix, if the plain timestamp is already
14692: in use. Default is to not do this, but simply increment the unix
14693: timestamp by 1 until a unique key is obtained.
14694:
14695: 7. who: holder of locking key; defaults to user:domain for user.
14696:
14697: 8. locktries: number of attempts to obtain a lock (sleep of 1s before
14698: retrying); default is 3.
14699:
14700: 9. maxtries: number of attempts to obtain a unique suffix; default is 20.
14701:
14702: Returns:
14703:
14704: 1. suffix obtained (numeric)
14705:
14706: 2. result of deleting locking key (ok if deleted, or lock never obtained)
14707:
14708: 3. error: contains (localized) error message if an error occurred.
14709:
14710:
14711: =back
14712:
14713: =head2 HTTP Helper Routines
14714:
14715: =over 4
14716:
14717: =item *
14718:
14719: escape() : unpack non-word characters into CGI-compatible hex codes
14720:
14721: =item *
14722:
14723: unescape() : pack CGI-compatible hex codes into actual non-word ASCII character
14724:
14725: =back
14726:
14727: =head1 PRIVATE SUBROUTINES
14728:
14729: =head2 Underlying communication routines (Shouldn't call)
14730:
14731: =over 4
14732:
14733: =item *
14734:
14735: subreply() : tries to pass a message to lonc, returns con_lost if incapable
14736:
14737: =item *
14738:
14739: reply() : uses subreply to send a message to remote machine, logs all failures
14740:
14741: =item *
14742:
14743: critical() : passes a critical message to another server; if cannot
14744: get through then place message in connection buffer directory and
14745: returns con_delayed, if incapable of saving message, returns
14746: con_failed
14747:
14748: =item *
14749:
14750: reconlonc() : tries to reconnect lonc client processes.
14751:
14752: =back
14753:
14754: =head2 Resource Access Logging
14755:
14756: =over 4
14757:
14758: =item *
14759:
14760: flushcourselogs() : flush (save) buffer logs and access logs
14761:
14762: =item *
14763:
14764: courselog($what) : save message for course in hash
14765:
14766: =item *
14767:
14768: courseacclog($what) : save message for course using &courselog(). Perform
14769: special processing for specific resource types (problems, exams, quizzes, etc).
14770:
14771: =item *
14772:
14773: goodbye() : flush course logs and log shutting down; it is called in srm.conf
14774: as a PerlChildExitHandler
14775:
14776: =back
14777:
14778: =head2 Other
14779:
14780: =over 4
14781:
14782: =item *
14783:
14784: symblist($mapname,%newhash) : update symbolic storage links
14785:
14786: =back
14787:
14788: =cut
14789:
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