1: # The LearningOnline Network
2: # TCP networking package
3: #
4: # $Id: lonnet.pm,v 1.1191 2012/09/25 19:54:38 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:
79: use Encode;
80:
81: use vars qw(%perlvar %spareid %pr %prp $memcache %packagetab $tmpdir
82: $_64bit %env %protocol %loncaparevs %serverhomeIDs %needsrelease
83: %managerstab);
84:
85: my (%badServerCache, $memcache, %courselogs, %accesshash, %domainrolehash,
86: %userrolehash, $processmarker, $dumpcount, %coursedombuf,
87: %coursenumbuf, %coursehombuf, %coursedescrbuf, %courseinstcodebuf,
88: %courseownerbuf, %coursetypebuf,$locknum);
89:
90: use IO::Socket;
91: use GDBM_File;
92: use HTML::LCParser;
93: use Fcntl qw(:flock);
94: use Storable qw(thaw nfreeze);
95: use Time::HiRes qw( gettimeofday tv_interval );
96: use Cache::Memcached;
97: use Digest::MD5;
98: use Math::Random;
99: use File::MMagic;
100: use LONCAPA qw(:DEFAULT :match);
101: use LONCAPA::Configuration;
102: use LONCAPA::lonmetadata;
103: use LONCAPA::Lond;
104:
105: use File::Copy;
106:
107: my $readit;
108: my $max_connection_retries = 10; # Or some such value.
109:
110: require Exporter;
111:
112: our @ISA = qw (Exporter);
113: our @EXPORT = qw(%env);
114:
115:
116: # ------------------------------------ Logging (parameters, docs, slots, roles)
117: {
118: my $logid;
119: sub write_log {
120: my ($context,$hash_name,$storehash,$delflag,$uname,$udom,$cnum,$cdom)=@_;
121: if ($context eq 'course') {
122: if (($cnum eq '') || ($cdom eq '')) {
123: $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
124: $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
125: }
126: }
127: $logid ++;
128: my $now = time();
129: my $id=$now.'00000'.$$.'00000'.$logid;
130: my $logentry = {
131: $id => {
132: 'exe_uname' => $env{'user.name'},
133: 'exe_udom' => $env{'user.domain'},
134: 'exe_time' => $now,
135: 'exe_ip' => $ENV{'REMOTE_ADDR'},
136: 'delflag' => $delflag,
137: 'logentry' => $storehash,
138: 'uname' => $uname,
139: 'udom' => $udom,
140: }
141: };
142: return &put('nohist_'.$hash_name,$logentry,$cdom,$cnum);
143: }
144: }
145:
146: sub logtouch {
147: my $execdir=$perlvar{'lonDaemons'};
148: unless (-e "$execdir/logs/lonnet.log") {
149: open(my $fh,">>$execdir/logs/lonnet.log");
150: close $fh;
151: }
152: my ($wwwuid,$wwwgid)=(getpwnam('www'))[2,3];
153: chown($wwwuid,$wwwgid,$execdir.'/logs/lonnet.log');
154: }
155:
156: sub logthis {
157: my $message=shift;
158: my $execdir=$perlvar{'lonDaemons'};
159: my $now=time;
160: my $local=localtime($now);
161: if (open(my $fh,">>$execdir/logs/lonnet.log")) {
162: my $logstring = $local. " ($$): ".$message."\n"; # Keep any \'s in string.
163: print $fh $logstring;
164: close($fh);
165: }
166: return 1;
167: }
168:
169: sub logperm {
170: my $message=shift;
171: my $execdir=$perlvar{'lonDaemons'};
172: my $now=time;
173: my $local=localtime($now);
174: if (open(my $fh,">>$execdir/logs/lonnet.perm.log")) {
175: print $fh "$now:$message:$local\n";
176: close($fh);
177: }
178: return 1;
179: }
180:
181: sub create_connection {
182: my ($hostname,$lonid) = @_;
183: my $client=IO::Socket::UNIX->new(Peer => $perlvar{'lonSockCreate'},
184: Type => SOCK_STREAM,
185: Timeout => 10);
186: return 0 if (!$client);
187: print $client (join(':',$hostname,$lonid,&machine_ids($hostname))."\n");
188: my $result = <$client>;
189: chomp($result);
190: return 1 if ($result eq 'done');
191: return 0;
192: }
193:
194: sub get_server_timezone {
195: my ($cnum,$cdom) = @_;
196: my $home=&homeserver($cnum,$cdom);
197: if ($home ne 'no_host') {
198: my $cachetime = 24*3600;
199: my ($timezone,$cached)=&is_cached_new('servertimezone',$home);
200: if (defined($cached)) {
201: return $timezone;
202: } else {
203: my $timezone = &reply('servertimezone',$home);
204: return &do_cache_new('servertimezone',$home,$timezone,$cachetime);
205: }
206: }
207: }
208:
209: sub get_server_distarch {
210: my ($lonhost,$ignore_cache) = @_;
211: if (defined($lonhost)) {
212: if (!defined(&hostname($lonhost))) {
213: return;
214: }
215: my $cachetime = 12*3600;
216: if (!$ignore_cache) {
217: my ($distarch,$cached)=&is_cached_new('serverdistarch',$lonhost);
218: if (defined($cached)) {
219: return $distarch;
220: }
221: }
222: my $rep = &reply('serverdistarch',$lonhost);
223: unless ($rep eq 'unknown_command' || $rep eq 'no_such_host' ||
224: $rep eq 'con_lost' || $rep eq 'rejected' || $rep eq 'refused' ||
225: $rep eq '') {
226: return &do_cache_new('serverdistarch',$lonhost,$rep,$cachetime);
227: }
228: }
229: return;
230: }
231:
232: sub get_server_loncaparev {
233: my ($dom,$lonhost,$ignore_cache,$caller) = @_;
234: if (defined($lonhost)) {
235: if (!defined(&hostname($lonhost))) {
236: undef($lonhost);
237: }
238: }
239: if (!defined($lonhost)) {
240: if (defined(&domain($dom,'primary'))) {
241: $lonhost=&domain($dom,'primary');
242: if ($lonhost eq 'no_host') {
243: undef($lonhost);
244: }
245: }
246: }
247: if (defined($lonhost)) {
248: my $cachetime = 12*3600;
249: if (!$ignore_cache) {
250: my ($loncaparev,$cached)=&is_cached_new('serverloncaparev',$lonhost);
251: if (defined($cached)) {
252: return $loncaparev;
253: }
254: }
255: my ($answer,$loncaparev);
256: my @ids=¤t_machine_ids();
257: if (grep(/^\Q$lonhost\E$/,@ids)) {
258: $answer = $perlvar{'lonVersion'};
259: if ($answer =~ /^[\'\"]?([\w.\-]+)[\'\"]?$/) {
260: $loncaparev = $1;
261: }
262: } else {
263: $answer = &reply('serverloncaparev',$lonhost);
264: if (($answer eq 'unknown_cmd') || ($answer eq 'con_lost')) {
265: if ($caller eq 'loncron') {
266: my $ua=new LWP::UserAgent;
267: $ua->timeout(4);
268: my $protocol = $protocol{$lonhost};
269: $protocol = 'http' if ($protocol ne 'https');
270: my $url = $protocol.'://'.&hostname($lonhost).'/adm/about.html';
271: my $request=new HTTP::Request('GET',$url);
272: my $response=$ua->request($request);
273: unless ($response->is_error()) {
274: my $content = $response->content;
275: if ($content =~ /<p>VERSION\:\s*([\w.\-]+)<\/p>/) {
276: $loncaparev = $1;
277: }
278: }
279: } else {
280: $loncaparev = $loncaparevs{$lonhost};
281: }
282: } elsif ($answer =~ /^[\'\"]?([\w.\-]+)[\'\"]?$/) {
283: $loncaparev = $1;
284: }
285: }
286: return &do_cache_new('serverloncaparev',$lonhost,$loncaparev,$cachetime);
287: }
288: }
289:
290: sub get_server_homeID {
291: my ($hostname,$ignore_cache,$caller) = @_;
292: unless ($ignore_cache) {
293: my ($serverhomeID,$cached)=&is_cached_new('serverhomeID',$hostname);
294: if (defined($cached)) {
295: return $serverhomeID;
296: }
297: }
298: my $cachetime = 12*3600;
299: my $serverhomeID;
300: if ($caller eq 'loncron') {
301: my @machine_ids = &machine_ids($hostname);
302: foreach my $id (@machine_ids) {
303: my $response = &reply('serverhomeID',$id);
304: unless (($response eq 'unknown_cmd') || ($response eq 'con_lost')) {
305: $serverhomeID = $response;
306: last;
307: }
308: }
309: if ($serverhomeID eq '') {
310: $serverhomeID = $machine_ids[-1];
311: }
312: } else {
313: $serverhomeID = $serverhomeIDs{$hostname};
314: }
315: return &do_cache_new('serverhomeID',$hostname,$serverhomeID,$cachetime);
316: }
317:
318: sub get_remote_globals {
319: my ($lonhost,$whathash,$ignore_cache) = @_;
320: my ($result,%returnhash,%whatneeded);
321: if (ref($whathash) eq 'HASH') {
322: foreach my $what (sort(keys(%{$whathash}))) {
323: my $hashid = $lonhost.'-'.$what;
324: my ($response,$cached);
325: unless ($ignore_cache) {
326: ($response,$cached)=&is_cached_new('lonnetglobal',$hashid);
327: }
328: if (defined($cached)) {
329: $returnhash{$what} = $response;
330: } else {
331: $whatneeded{$what} = 1;
332: }
333: }
334: if (keys(%whatneeded) == 0) {
335: $result = 'ok';
336: } else {
337: my $requested = &freeze_escape(\%whatneeded);
338: my $rep=&reply('readlonnetglobal:'.$requested,$lonhost);
339: if (($rep=~/^(refused|rejected|error)/) || ($rep eq 'con_lost') ||
340: ($rep eq 'unknown_cmd')) {
341: $result = $rep;
342: } else {
343: $result = 'ok';
344: my @pairs=split(/\&/,$rep);
345: foreach my $item (@pairs) {
346: my ($key,$value)=split(/=/,$item,2);
347: my $what = &unescape($key);
348: my $hashid = $lonhost.'-'.$what;
349: $returnhash{$what}=&thaw_unescape($value);
350: &do_cache_new('lonnetglobal',$hashid,$returnhash{$what},600);
351: }
352: }
353: }
354: }
355: return ($result,\%returnhash);
356: }
357:
358: sub remote_devalidate_cache {
359: my ($lonhost,$name,$id) = @_;
360: my $response = &reply('devalidatecache:'.&escape($name).':'.&escape($id),$lonhost);
361: return $response;
362: }
363:
364: # -------------------------------------------------- Non-critical communication
365: sub subreply {
366: my ($cmd,$server)=@_;
367: my $peerfile="$perlvar{'lonSockDir'}/".&hostname($server);
368: #
369: # With loncnew process trimming, there's a timing hole between lonc server
370: # process exit and the master server picking up the listen on the AF_UNIX
371: # socket. In that time interval, a lock file will exist:
372:
373: my $lockfile=$peerfile.".lock";
374: while (-e $lockfile) { # Need to wait for the lockfile to disappear.
375: sleep(1);
376: }
377: # At this point, either a loncnew parent is listening or an old lonc
378: # or loncnew child is listening so we can connect or everything's dead.
379: #
380: # We'll give the connection a few tries before abandoning it. If
381: # connection is not possible, we'll con_lost back to the client.
382: #
383: my $client;
384: for (my $retries = 0; $retries < $max_connection_retries; $retries++) {
385: $client=IO::Socket::UNIX->new(Peer =>"$peerfile",
386: Type => SOCK_STREAM,
387: Timeout => 10);
388: if ($client) {
389: last; # Connected!
390: } else {
391: &create_connection(&hostname($server),$server);
392: }
393: sleep(1); # Try again later if failed connection.
394: }
395: my $answer;
396: if ($client) {
397: print $client "sethost:$server:$cmd\n";
398: $answer=<$client>;
399: if (!$answer) { $answer="con_lost"; }
400: chomp($answer);
401: } else {
402: $answer = 'con_lost'; # Failed connection.
403: }
404: return $answer;
405: }
406:
407: sub reply {
408: my ($cmd,$server)=@_;
409: unless (defined(&hostname($server))) { return 'no_such_host'; }
410: my $answer=subreply($cmd,$server);
411: if (($answer=~/^refused/) || ($answer=~/^rejected/)) {
412: &logthis("<font color=\"blue\">WARNING:".
413: " $cmd to $server returned $answer</font>");
414: }
415: return $answer;
416: }
417:
418: # ----------------------------------------------------------- Send USR1 to lonc
419:
420: sub reconlonc {
421: my ($lonid) = @_;
422: my $hostname = &hostname($lonid);
423: if ($lonid) {
424: my $peerfile="$perlvar{'lonSockDir'}/$hostname";
425: if ($hostname && -e $peerfile) {
426: &logthis("Trying to reconnect lonc for $lonid ($hostname)");
427: my $client=IO::Socket::UNIX->new(Peer => $peerfile,
428: Type => SOCK_STREAM,
429: Timeout => 10);
430: if ($client) {
431: print $client ("reset_retries\n");
432: my $answer=<$client>;
433: #reset just this one.
434: }
435: }
436: return;
437: }
438:
439: &logthis("Trying to reconnect lonc");
440: my $loncfile="$perlvar{'lonDaemons'}/logs/lonc.pid";
441: if (open(my $fh,"<$loncfile")) {
442: my $loncpid=<$fh>;
443: chomp($loncpid);
444: if (kill 0 => $loncpid) {
445: &logthis("lonc at pid $loncpid responding, sending USR1");
446: kill USR1 => $loncpid;
447: sleep 1;
448: } else {
449: &logthis(
450: "<font color=\"blue\">WARNING:".
451: " lonc at pid $loncpid not responding, giving up</font>");
452: }
453: } else {
454: &logthis('<font color="blue">WARNING: lonc not running, giving up</font>');
455: }
456: }
457:
458: # ------------------------------------------------------ Critical communication
459:
460: sub critical {
461: my ($cmd,$server)=@_;
462: unless (&hostname($server)) {
463: &logthis("<font color=\"blue\">WARNING:".
464: " Critical message to unknown server ($server)</font>");
465: return 'no_such_host';
466: }
467: my $answer=reply($cmd,$server);
468: if ($answer eq 'con_lost') {
469: &reconlonc("$perlvar{'lonSockDir'}/$server");
470: my $answer=reply($cmd,$server);
471: if ($answer eq 'con_lost') {
472: my $now=time;
473: my $middlename=$cmd;
474: $middlename=substr($middlename,0,16);
475: $middlename=~s/\W//g;
476: my $dfilename=
477: "$perlvar{'lonSockDir'}/delayed/$now.$dumpcount.$$.$middlename.$server";
478: $dumpcount++;
479: {
480: my $dfh;
481: if (open($dfh,">$dfilename")) {
482: print $dfh "$cmd\n";
483: close($dfh);
484: }
485: }
486: sleep 2;
487: my $wcmd='';
488: {
489: my $dfh;
490: if (open($dfh,"<$dfilename")) {
491: $wcmd=<$dfh>;
492: close($dfh);
493: }
494: }
495: chomp($wcmd);
496: if ($wcmd eq $cmd) {
497: &logthis("<font color=\"blue\">WARNING: ".
498: "Connection buffer $dfilename: $cmd</font>");
499: &logperm("D:$server:$cmd");
500: return 'con_delayed';
501: } else {
502: &logthis("<font color=\"red\">CRITICAL:"
503: ." Critical connection failed: $server $cmd</font>");
504: &logperm("F:$server:$cmd");
505: return 'con_failed';
506: }
507: }
508: }
509: return $answer;
510: }
511:
512: # ------------------------------------------- check if return value is an error
513:
514: sub error {
515: my ($result) = @_;
516: if ($result =~ /^(con_lost|no_such_host|error: (\d+) (.*))/) {
517: if ($2 == 2) { return undef; }
518: return $1;
519: }
520: return undef;
521: }
522:
523: sub convert_and_load_session_env {
524: my ($lonidsdir,$handle)=@_;
525: my @profile;
526: {
527: my $opened = open(my $idf,'+<',"$lonidsdir/$handle.id");
528: if (!$opened) {
529: return 0;
530: }
531: flock($idf,LOCK_SH);
532: @profile=<$idf>;
533: close($idf);
534: }
535: my %temp_env;
536: foreach my $line (@profile) {
537: if ($line !~ m/=/) {
538: return 0;
539: }
540: chomp($line);
541: my ($envname,$envvalue)=split(/=/,$line,2);
542: $temp_env{&unescape($envname)} = &unescape($envvalue);
543: }
544: unlink("$lonidsdir/$handle.id");
545: if (tie(my %disk_env,'GDBM_File',"$lonidsdir/$handle.id",&GDBM_WRCREAT(),
546: 0640)) {
547: %disk_env = %temp_env;
548: @env{keys(%temp_env)} = @disk_env{keys(%temp_env)};
549: untie(%disk_env);
550: }
551: return 1;
552: }
553:
554: # ------------------------------------------- Transfer profile into environment
555: my $env_loaded;
556: sub transfer_profile_to_env {
557: my ($lonidsdir,$handle,$force_transfer) = @_;
558: if (!$force_transfer && $env_loaded) { return; }
559:
560: if (!defined($lonidsdir)) {
561: $lonidsdir = $perlvar{'lonIDsDir'};
562: }
563: if (!defined($handle)) {
564: ($handle) = ($env{'user.environment'} =~m|/([^/]+)\.id$| );
565: }
566:
567: my $convert;
568: {
569: my $opened = open(my $idf,'+<',"$lonidsdir/$handle.id");
570: if (!$opened) {
571: return;
572: }
573: flock($idf,LOCK_SH);
574: if (tie(my %disk_env,'GDBM_File',"$lonidsdir/$handle.id",
575: &GDBM_READER(),0640)) {
576: @env{keys(%disk_env)} = @disk_env{keys(%disk_env)};
577: untie(%disk_env);
578: } else {
579: $convert = 1;
580: }
581: }
582: if ($convert) {
583: if (!&convert_and_load_session_env($lonidsdir,$handle)) {
584: &logthis("Failed to load session, or convert session.");
585: }
586: }
587:
588: my %remove;
589: while ( my $envname = each(%env) ) {
590: if (my ($key,$time) = ($envname =~ /^(cgi\.(\d+)_\d+\.)/)) {
591: if ($time < time-300) {
592: $remove{$key}++;
593: }
594: }
595: }
596:
597: $env{'user.environment'} = "$lonidsdir/$handle.id";
598: $env_loaded=1;
599: foreach my $expired_key (keys(%remove)) {
600: &delenv($expired_key);
601: }
602: }
603:
604: # ---------------------------------------------------- Check for valid session
605: sub check_for_valid_session {
606: my ($r,$name) = @_;
607: my %cookies=CGI::Cookie->parse($r->header_in('Cookie'));
608: if ($name eq '') {
609: $name = 'lonID';
610: }
611: my $lonid=$cookies{$name};
612: return undef if (!$lonid);
613:
614: my $handle=&LONCAPA::clean_handle($lonid->value);
615: my $lonidsdir;
616: if ($name eq 'lonDAV') {
617: $lonidsdir=$r->dir_config('lonDAVsessDir');
618: } else {
619: $lonidsdir=$r->dir_config('lonIDsDir');
620: }
621: return undef if (!-e "$lonidsdir/$handle.id");
622:
623: my $opened = open(my $idf,'+<',"$lonidsdir/$handle.id");
624: return undef if (!$opened);
625:
626: flock($idf,LOCK_SH);
627: my %disk_env;
628: if (!tie(%disk_env,'GDBM_File',"$lonidsdir/$handle.id",
629: &GDBM_READER(),0640)) {
630: return undef;
631: }
632:
633: if (!defined($disk_env{'user.name'})
634: || !defined($disk_env{'user.domain'})) {
635: return undef;
636: }
637: return $handle;
638: }
639:
640: sub timed_flock {
641: my ($file,$lock_type) = @_;
642: my $failed=0;
643: eval {
644: local $SIG{__DIE__}='DEFAULT';
645: local $SIG{ALRM}=sub {
646: $failed=1;
647: die("failed lock");
648: };
649: alarm(13);
650: flock($file,$lock_type);
651: alarm(0);
652: };
653: if ($failed) {
654: return undef;
655: } else {
656: return 1;
657: }
658: }
659:
660: # ---------------------------------------------------------- Append Environment
661:
662: sub appenv {
663: my ($newenv,$roles) = @_;
664: if (ref($newenv) eq 'HASH') {
665: foreach my $key (keys(%{$newenv})) {
666: my $refused = 0;
667: if (($key =~ /^user\.role/) || ($key =~ /^user\.priv/)) {
668: $refused = 1;
669: if (ref($roles) eq 'ARRAY') {
670: my ($type,$role) = ($key =~ /^user\.(role|priv)\.([^.]+)\./);
671: if (grep(/^\Q$role\E$/,@{$roles})) {
672: $refused = 0;
673: }
674: }
675: }
676: if ($refused) {
677: &logthis("<font color=\"blue\">WARNING: ".
678: "Attempt to modify environment ".$key." to ".$newenv->{$key}
679: .'</font>');
680: delete($newenv->{$key});
681: } else {
682: $env{$key}=$newenv->{$key};
683: }
684: }
685: my $opened = open(my $env_file,'+<',$env{'user.environment'});
686: if ($opened
687: && &timed_flock($env_file,LOCK_EX)
688: &&
689: tie(my %disk_env,'GDBM_File',$env{'user.environment'},
690: (&GDBM_WRITER()|&GDBM_NOLOCK()),0640)) {
691: while (my ($key,$value) = each(%{$newenv})) {
692: $disk_env{$key} = $value;
693: }
694: untie(%disk_env);
695: }
696: }
697: return 'ok';
698: }
699: # ----------------------------------------------------- Delete from Environment
700:
701: sub delenv {
702: my ($delthis,$regexp,$roles) = @_;
703: if (($delthis=~/^user\.role/) || ($delthis=~/^user\.priv/)) {
704: my $refused = 1;
705: if (ref($roles) eq 'ARRAY') {
706: my ($type,$role) = ($delthis =~ /^user\.(role|priv)\.([^.]+)\./);
707: if (grep(/^\Q$role\E$/,@{$roles})) {
708: $refused = 0;
709: }
710: }
711: if ($refused) {
712: &logthis("<font color=\"blue\">WARNING: ".
713: "Attempt to delete from environment ".$delthis);
714: return 'error';
715: }
716: }
717: my $opened = open(my $env_file,'+<',$env{'user.environment'});
718: if ($opened
719: && &timed_flock($env_file,LOCK_EX)
720: &&
721: tie(my %disk_env,'GDBM_File',$env{'user.environment'},
722: (&GDBM_WRITER()|&GDBM_NOLOCK()),0640)) {
723: foreach my $key (keys(%disk_env)) {
724: if ($regexp) {
725: if ($key=~/^$delthis/) {
726: delete($env{$key});
727: delete($disk_env{$key});
728: }
729: } else {
730: if ($key=~/^\Q$delthis\E/) {
731: delete($env{$key});
732: delete($disk_env{$key});
733: }
734: }
735: }
736: untie(%disk_env);
737: }
738: return 'ok';
739: }
740:
741: sub get_env_multiple {
742: my ($name) = @_;
743: my @values;
744: if (defined($env{$name})) {
745: # exists is it an array
746: if (ref($env{$name})) {
747: @values=@{ $env{$name} };
748: } else {
749: $values[0]=$env{$name};
750: }
751: }
752: return(@values);
753: }
754:
755: # ------------------------------------------------------------------- Locking
756:
757: sub set_lock {
758: my ($text)=@_;
759: $locknum++;
760: my $id=$$.'-'.$locknum;
761: &appenv({'session.locks' => $env{'session.locks'}.','.$id,
762: 'session.lock.'.$id => $text});
763: return $id;
764: }
765:
766: sub get_locks {
767: my $num=0;
768: my %texts=();
769: foreach my $lock (split(/\,/,$env{'session.locks'})) {
770: if ($lock=~/\w/) {
771: $num++;
772: $texts{$lock}=$env{'session.lock.'.$lock};
773: }
774: }
775: return ($num,%texts);
776: }
777:
778: sub remove_lock {
779: my ($id)=@_;
780: my $newlocks='';
781: foreach my $lock (split(/\,/,$env{'session.locks'})) {
782: if (($lock=~/\w/) && ($lock ne $id)) {
783: $newlocks.=','.$lock;
784: }
785: }
786: &appenv({'session.locks' => $newlocks});
787: &delenv('session.lock.'.$id);
788: }
789:
790: sub remove_all_locks {
791: my $activelocks=$env{'session.locks'};
792: foreach my $lock (split(/\,/,$env{'session.locks'})) {
793: if ($lock=~/\w/) {
794: &remove_lock($lock);
795: }
796: }
797: }
798:
799:
800: # ------------------------------------------ Find out current server userload
801: sub userload {
802: my $numusers=0;
803: {
804: opendir(LONIDS,$perlvar{'lonIDsDir'});
805: my $filename;
806: my $curtime=time;
807: while ($filename=readdir(LONIDS)) {
808: next if ($filename eq '.' || $filename eq '..');
809: next if ($filename =~ /publicuser_\d+\.id/);
810: my ($mtime)=(stat($perlvar{'lonIDsDir'}.'/'.$filename))[9];
811: if ($curtime-$mtime < 1800) { $numusers++; }
812: }
813: closedir(LONIDS);
814: }
815: my $userloadpercent=0;
816: my $maxuserload=$perlvar{'lonUserLoadLim'};
817: if ($maxuserload) {
818: $userloadpercent=100*$numusers/$maxuserload;
819: }
820: $userloadpercent=sprintf("%.2f",$userloadpercent);
821: return $userloadpercent;
822: }
823:
824: # ------------------------------ Find server with least workload from spare.tab
825:
826: sub spareserver {
827: my ($loadpercent,$userloadpercent,$want_server_name,$udom) = @_;
828: my $spare_server;
829: if ($userloadpercent !~ /\d/) { $userloadpercent=0; }
830: my $lowest_load=($loadpercent > $userloadpercent) ? $loadpercent
831: : $userloadpercent;
832: my ($uint_dom,$remotesessions);
833: if (($udom ne '') && (&domain($udom) ne '')) {
834: my $uprimary_id = &Apache::lonnet::domain($udom,'primary');
835: $uint_dom = &Apache::lonnet::internet_dom($uprimary_id);
836: my %udomdefaults = &Apache::lonnet::get_domain_defaults($udom);
837: $remotesessions = $udomdefaults{'remotesessions'};
838: }
839: my $spareshash = &this_host_spares($udom);
840: if (ref($spareshash) eq 'HASH') {
841: if (ref($spareshash->{'primary'}) eq 'ARRAY') {
842: foreach my $try_server (@{ $spareshash->{'primary'} }) {
843: if ($uint_dom) {
844: next unless (&spare_can_host($udom,$uint_dom,$remotesessions,
845: $try_server));
846: }
847: ($spare_server, $lowest_load) =
848: &compare_server_load($try_server, $spare_server, $lowest_load);
849: }
850: }
851:
852: my $found_server = ($spare_server ne '' && $lowest_load < 100);
853:
854: if (!$found_server) {
855: if (ref($spareshash->{'default'}) eq 'ARRAY') {
856: foreach my $try_server (@{ $spareshash->{'default'} }) {
857: if ($uint_dom) {
858: next unless (&spare_can_host($udom,$uint_dom,
859: $remotesessions,$try_server));
860: }
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) = @_;
885:
886: my $loadans = &reply('load', $try_server);
887: my $userloadans = &reply('userload',$try_server);
888:
889: if ($loadans !~ /\d/ && $userloadans !~ /\d/) {
890: return ($spare_server, $lowest_load); #didn't get a number from the server
891: }
892:
893: my $load;
894: if ($loadans =~ /\d/) {
895: if ($userloadans =~ /\d/) {
896: #both are numbers, pick the bigger one
897: $load = ($loadans > $userloadans) ? $loadans
898: : $userloadans;
899: } else {
900: $load = $loadans;
901: }
902: } else {
903: $load = $userloadans;
904: }
905:
906: if (($load =~ /\d/) && ($load < $lowest_load)) {
907: $spare_server = $try_server;
908: $lowest_load = $load;
909: }
910: return ($spare_server,$lowest_load);
911: }
912:
913: # --------------------------- ask offload servers if user already has a session
914: sub find_existing_session {
915: my ($udom,$uname) = @_;
916: my $spareshash = &this_host_spares($udom);
917: if (ref($spareshash) eq 'HASH') {
918: if (ref($spareshash->{'primary'}) eq 'ARRAY') {
919: foreach my $try_server (@{ $spareshash->{'primary'} }) {
920: return $try_server if (&has_user_session($try_server, $udom, $uname));
921: }
922: }
923: if (ref($spareshash->{'default'}) eq 'ARRAY') {
924: foreach my $try_server (@{ $spareshash->{'default'} }) {
925: return $try_server if (&has_user_session($try_server, $udom, $uname));
926: }
927: }
928: }
929: return;
930: }
931:
932: # -------------------------------- ask if server already has a session for user
933: sub has_user_session {
934: my ($lonid,$udom,$uname) = @_;
935: my $result = &reply(join(':','userhassession',
936: map {&escape($_)} ($udom,$uname)),$lonid);
937: return 1 if ($result eq 'ok');
938:
939: return 0;
940: }
941:
942: # --------- determine least loaded server in a user's domain which allows login
943:
944: sub choose_server {
945: my ($udom,$checkloginvia) = @_;
946: my %domconfhash = &Apache::loncommon::get_domainconf($udom);
947: my %servers = &get_servers($udom);
948: my $lowest_load = 30000;
949: my ($login_host,$hostname,$portal_path,$isredirect);
950: foreach my $lonhost (keys(%servers)) {
951: my $loginvia;
952: if ($checkloginvia) {
953: $loginvia = $domconfhash{$udom.'.login.loginvia_'.$lonhost};
954: if ($loginvia) {
955: my ($server,$path) = split(/:/,$loginvia);
956: ($login_host, $lowest_load) =
957: &compare_server_load($server, $login_host, $lowest_load);
958: if ($login_host eq $server) {
959: $portal_path = $path;
960: $isredirect = 1;
961: }
962: } else {
963: ($login_host, $lowest_load) =
964: &compare_server_load($lonhost, $login_host, $lowest_load);
965: if ($login_host eq $lonhost) {
966: $portal_path = '';
967: $isredirect = '';
968: }
969: }
970: } else {
971: ($login_host, $lowest_load) =
972: &compare_server_load($lonhost, $login_host, $lowest_load);
973: }
974: }
975: if ($login_host ne '') {
976: $hostname = &hostname($login_host);
977: }
978: return ($login_host,$hostname,$portal_path,$isredirect);
979: }
980:
981: # --------------------------------------------- Try to change a user's password
982:
983: sub changepass {
984: my ($uname,$udom,$currentpass,$newpass,$server,$context)=@_;
985: $currentpass = &escape($currentpass);
986: $newpass = &escape($newpass);
987: my $lonhost = $perlvar{'lonHostID'};
988: my $answer = reply("encrypt:passwd:$udom:$uname:$currentpass:$newpass:$context:$lonhost",
989: $server);
990: if (! $answer) {
991: &logthis("No reply on password change request to $server ".
992: "by $uname in domain $udom.");
993: } elsif ($answer =~ "^ok") {
994: &logthis("$uname in $udom successfully changed their password ".
995: "on $server.");
996: } elsif ($answer =~ "^pwchange_failure") {
997: &logthis("$uname in $udom was unable to change their password ".
998: "on $server. The action was blocked by either lcpasswd ".
999: "or pwchange");
1000: } elsif ($answer =~ "^non_authorized") {
1001: &logthis("$uname in $udom did not get their password correct when ".
1002: "attempting to change it on $server.");
1003: } elsif ($answer =~ "^auth_mode_error") {
1004: &logthis("$uname in $udom attempted to change their password despite ".
1005: "not being locally or internally authenticated on $server.");
1006: } elsif ($answer =~ "^unknown_user") {
1007: &logthis("$uname in $udom attempted to change their password ".
1008: "on $server but were unable to because $server is not ".
1009: "their home server.");
1010: } elsif ($answer =~ "^refused") {
1011: &logthis("$server refused to change $uname in $udom password because ".
1012: "it was sent an unencrypted request to change the password.");
1013: } elsif ($answer =~ "invalid_client") {
1014: &logthis("$server refused to change $uname in $udom password because ".
1015: "it was a reset by e-mail originating from an invalid server.");
1016: }
1017: return $answer;
1018: }
1019:
1020: # ----------------------- Try to determine user's current authentication scheme
1021:
1022: sub queryauthenticate {
1023: my ($uname,$udom)=@_;
1024: my $uhome=&homeserver($uname,$udom);
1025: if (!$uhome) {
1026: &logthis("User $uname at $udom is unknown when looking for authentication mechanism");
1027: return 'no_host';
1028: }
1029: my $answer=reply("encrypt:currentauth:$udom:$uname",$uhome);
1030: if ($answer =~ /^(unknown_user|refused|con_lost)/) {
1031: &logthis("User $uname at $udom threw error $answer when checking authentication mechanism");
1032: }
1033: return $answer;
1034: }
1035:
1036: # --------- Try to authenticate user from domain's lib servers (first this one)
1037:
1038: sub authenticate {
1039: my ($uname,$upass,$udom,$checkdefauth,$clientcancheckhost)=@_;
1040: $upass=&escape($upass);
1041: $uname= &LONCAPA::clean_username($uname);
1042: my $uhome=&homeserver($uname,$udom,1);
1043: my $newhome;
1044: if ((!$uhome) || ($uhome eq 'no_host')) {
1045: # Maybe the machine was offline and only re-appeared again recently?
1046: &reconlonc();
1047: # One more
1048: $uhome=&homeserver($uname,$udom,1);
1049: if (($uhome eq 'no_host') && $checkdefauth) {
1050: if (defined(&domain($udom,'primary'))) {
1051: $newhome=&domain($udom,'primary');
1052: }
1053: if ($newhome ne '') {
1054: $uhome = $newhome;
1055: }
1056: }
1057: if ((!$uhome) || ($uhome eq 'no_host')) {
1058: &logthis("User $uname at $udom is unknown in authenticate");
1059: return 'no_host';
1060: }
1061: }
1062: my $answer=reply("encrypt:auth:$udom:$uname:$upass:$checkdefauth:$clientcancheckhost",$uhome);
1063: if ($answer eq 'authorized') {
1064: if ($newhome) {
1065: &logthis("User $uname at $udom authorized by $uhome, but needs account");
1066: return 'no_account_on_host';
1067: } else {
1068: &logthis("User $uname at $udom authorized by $uhome");
1069: return $uhome;
1070: }
1071: }
1072: if ($answer eq 'non_authorized') {
1073: &logthis("User $uname at $udom rejected by $uhome");
1074: return 'no_host';
1075: }
1076: &logthis("User $uname at $udom threw error $answer when checking authentication mechanism");
1077: return 'no_host';
1078: }
1079:
1080: sub can_host_session {
1081: my ($udom,$lonhost,$remoterev,$remotesessions,$hostedsessions) = @_;
1082: my $canhost = 1;
1083: my $host_idn = &Apache::lonnet::internet_dom($lonhost);
1084: if (ref($remotesessions) eq 'HASH') {
1085: if (ref($remotesessions->{'excludedomain'}) eq 'ARRAY') {
1086: if (grep(/^\Q$host_idn\E$/,@{$remotesessions->{'excludedomain'}})) {
1087: $canhost = 0;
1088: } else {
1089: $canhost = 1;
1090: }
1091: }
1092: if (ref($remotesessions->{'includedomain'}) eq 'ARRAY') {
1093: if (grep(/^\Q$host_idn\E$/,@{$remotesessions->{'includedomain'}})) {
1094: $canhost = 1;
1095: } else {
1096: $canhost = 0;
1097: }
1098: }
1099: if ($canhost) {
1100: if ($remotesessions->{'version'} ne '') {
1101: my ($reqmajor,$reqminor) = ($remotesessions->{'version'} =~ /^(\d+)\.(\d+)$/);
1102: if ($reqmajor ne '' && $reqminor ne '') {
1103: if ($remoterev =~ /^\'?(\d+)\.(\d+)/) {
1104: my $major = $1;
1105: my $minor = $2;
1106: if (($major < $reqmajor ) ||
1107: (($major == $reqmajor) && ($minor < $reqminor))) {
1108: $canhost = 0;
1109: }
1110: } else {
1111: $canhost = 0;
1112: }
1113: }
1114: }
1115: }
1116: }
1117: if ($canhost) {
1118: if (ref($hostedsessions) eq 'HASH') {
1119: my $uprimary_id = &Apache::lonnet::domain($udom,'primary');
1120: my $uint_dom = &Apache::lonnet::internet_dom($uprimary_id);
1121: if (ref($hostedsessions->{'excludedomain'}) eq 'ARRAY') {
1122: if (($uint_dom ne '') &&
1123: (grep(/^\Q$uint_dom\E$/,@{$hostedsessions->{'excludedomain'}}))) {
1124: $canhost = 0;
1125: } else {
1126: $canhost = 1;
1127: }
1128: }
1129: if (ref($hostedsessions->{'includedomain'}) eq 'ARRAY') {
1130: if (($uint_dom ne '') &&
1131: (grep(/^\Q$uint_dom\E$/,@{$hostedsessions->{'includedomain'}}))) {
1132: $canhost = 1;
1133: } else {
1134: $canhost = 0;
1135: }
1136: }
1137: }
1138: }
1139: return $canhost;
1140: }
1141:
1142: sub spare_can_host {
1143: my ($udom,$uint_dom,$remotesessions,$try_server)=@_;
1144: my $canhost=1;
1145: my @intdoms;
1146: my $internet_names = &Apache::lonnet::get_internet_names($try_server);
1147: if (ref($internet_names) eq 'ARRAY') {
1148: @intdoms = @{$internet_names};
1149: }
1150: unless (grep(/^\Q$uint_dom\E$/,@intdoms)) {
1151: my $serverhomeID = &Apache::lonnet::get_server_homeID($try_server);
1152: my $serverhomedom = &Apache::lonnet::host_domain($serverhomeID);
1153: my %defdomdefaults = &Apache::lonnet::get_domain_defaults($serverhomedom);
1154: my $remoterev = &Apache::lonnet::get_server_loncaparev(undef,$try_server);
1155: $canhost = &can_host_session($udom,$try_server,$remoterev,
1156: $remotesessions,
1157: $defdomdefaults{'hostedsessions'});
1158: }
1159: return $canhost;
1160: }
1161:
1162: sub this_host_spares {
1163: my ($dom) = @_;
1164: my ($dom_in_use,$lonhost_in_use,$result);
1165: my @hosts = ¤t_machine_ids();
1166: foreach my $lonhost (@hosts) {
1167: if (&host_domain($lonhost) eq $dom) {
1168: $dom_in_use = $dom;
1169: $lonhost_in_use = $lonhost;
1170: last;
1171: }
1172: }
1173: if ($dom_in_use ne '') {
1174: $result = &spares_for_offload($dom_in_use,$lonhost_in_use);
1175: }
1176: if (ref($result) ne 'HASH') {
1177: $lonhost_in_use = $perlvar{'lonHostID'};
1178: $dom_in_use = &host_domain($lonhost_in_use);
1179: $result = &spares_for_offload($dom_in_use,$lonhost_in_use);
1180: if (ref($result) ne 'HASH') {
1181: $result = \%spareid;
1182: }
1183: }
1184: return $result;
1185: }
1186:
1187: sub spares_for_offload {
1188: my ($dom_in_use,$lonhost_in_use) = @_;
1189: my ($result,$cached)=&is_cached_new('spares',$dom_in_use);
1190: if (defined($cached)) {
1191: return $result;
1192: } else {
1193: my $cachetime = 60*60*24;
1194: my %domconfig =
1195: &Apache::lonnet::get_dom('configuration',['usersessions'],$dom_in_use);
1196: if (ref($domconfig{'usersessions'}) eq 'HASH') {
1197: if (ref($domconfig{'usersessions'}{'spares'}) eq 'HASH') {
1198: if (ref($domconfig{'usersessions'}{'spares'}{$lonhost_in_use}) eq 'HASH') {
1199: return &do_cache_new('spares',$dom_in_use,$domconfig{'usersessions'}{'spares'}{$lonhost_in_use},$cachetime);
1200: }
1201: }
1202: }
1203: }
1204: return;
1205: }
1206:
1207: sub get_lonbalancer_config {
1208: my ($servers) = @_;
1209: my ($currbalancer,$currtargets);
1210: if (ref($servers) eq 'HASH') {
1211: foreach my $server (keys(%{$servers})) {
1212: my %what = (
1213: spareid => 1,
1214: perlvar => 1,
1215: );
1216: my ($result,$returnhash) = &get_remote_globals($server,\%what);
1217: if ($result eq 'ok') {
1218: if (ref($returnhash) eq 'HASH') {
1219: if (ref($returnhash->{'perlvar'}) eq 'HASH') {
1220: if ($returnhash->{'perlvar'}->{'lonBalancer'} eq 'yes') {
1221: $currbalancer = $server;
1222: $currtargets = {};
1223: if (ref($returnhash->{'spareid'}) eq 'HASH') {
1224: if (ref($returnhash->{'spareid'}->{'primary'}) eq 'ARRAY') {
1225: $currtargets->{'primary'} = $returnhash->{'spareid'}->{'primary'};
1226: }
1227: if (ref($returnhash->{'spareid'}->{'default'}) eq 'ARRAY') {
1228: $currtargets->{'default'} = $returnhash->{'spareid'}->{'default'};
1229: }
1230: }
1231: last;
1232: }
1233: }
1234: }
1235: }
1236: }
1237: }
1238: return ($currbalancer,$currtargets);
1239: }
1240:
1241: sub check_loadbalancing {
1242: my ($uname,$udom) = @_;
1243: my ($is_balancer,$currtargets,$currrules,$dom_in_use,$homeintdom,
1244: $rule_in_effect,$offloadto,$otherserver);
1245: my $lonhost = $perlvar{'lonHostID'};
1246: my @hosts = ¤t_machine_ids();
1247: my $uprimary_id = &Apache::lonnet::domain($udom,'primary');
1248: my $uintdom = &Apache::lonnet::internet_dom($uprimary_id);
1249: my $intdom = &Apache::lonnet::internet_dom($lonhost);
1250: my $serverhomedom = &host_domain($lonhost);
1251:
1252: my $cachetime = 60*60*24;
1253:
1254: if (($uintdom ne '') && ($uintdom eq $intdom)) {
1255: $dom_in_use = $udom;
1256: $homeintdom = 1;
1257: } else {
1258: $dom_in_use = $serverhomedom;
1259: }
1260: my ($result,$cached)=&is_cached_new('loadbalancing',$dom_in_use);
1261: unless (defined($cached)) {
1262: my %domconfig =
1263: &Apache::lonnet::get_dom('configuration',['loadbalancing'],$dom_in_use);
1264: if (ref($domconfig{'loadbalancing'}) eq 'HASH') {
1265: $result = &do_cache_new('loadbalancing',$dom_in_use,$domconfig{'loadbalancing'},$cachetime);
1266: }
1267: }
1268: if (ref($result) eq 'HASH') {
1269: ($is_balancer,$currtargets,$currrules) =
1270: &check_balancer_result($result,@hosts);
1271: if ($is_balancer) {
1272: if (ref($currrules) eq 'HASH') {
1273: if ($homeintdom) {
1274: if ($uname ne '') {
1275: if (($currrules->{'_LC_adv'} ne '') || ($currrules->{'_LC_author'} ne '')) {
1276: my ($is_adv,$is_author) = &is_advanced_user($udom,$uname);
1277: if (($currrules->{'_LC_author'} ne '') && ($is_author)) {
1278: $rule_in_effect = $currrules->{'_LC_author'};
1279: } elsif (($currrules->{'_LC_adv'} ne '') && ($is_adv)) {
1280: $rule_in_effect = $currrules->{'_LC_adv'}
1281: }
1282: }
1283: if ($rule_in_effect eq '') {
1284: my %userenv = &userenvironment($udom,$uname,'inststatus');
1285: if ($userenv{'inststatus'} ne '') {
1286: my @statuses = map { &unescape($_); } split(/:/,$userenv{'inststatus'});
1287: my ($othertitle,$usertypes,$types) =
1288: &Apache::loncommon::sorted_inst_types($udom);
1289: if (ref($types) eq 'ARRAY') {
1290: foreach my $type (@{$types}) {
1291: if (grep(/^\Q$type\E$/,@statuses)) {
1292: if (exists($currrules->{$type})) {
1293: $rule_in_effect = $currrules->{$type};
1294: }
1295: }
1296: }
1297: }
1298: } else {
1299: if (exists($currrules->{'default'})) {
1300: $rule_in_effect = $currrules->{'default'};
1301: }
1302: }
1303: }
1304: } else {
1305: if (exists($currrules->{'default'})) {
1306: $rule_in_effect = $currrules->{'default'};
1307: }
1308: }
1309: } else {
1310: if ($currrules->{'_LC_external'} ne '') {
1311: $rule_in_effect = $currrules->{'_LC_external'};
1312: }
1313: }
1314: $offloadto = &get_loadbalancer_targets($rule_in_effect,$currtargets,
1315: $uname,$udom);
1316: }
1317: }
1318: } elsif (($homeintdom) && ($udom ne $serverhomedom)) {
1319: my ($result,$cached)=&is_cached_new('loadbalancing',$serverhomedom);
1320: unless (defined($cached)) {
1321: my %domconfig =
1322: &Apache::lonnet::get_dom('configuration',['loadbalancing'],$serverhomedom);
1323: if (ref($domconfig{'loadbalancing'}) eq 'HASH') {
1324: $result = &do_cache_new('loadbalancing',$dom_in_use,$domconfig{'loadbalancing'},$cachetime);
1325: }
1326: }
1327: if (ref($result) eq 'HASH') {
1328: ($is_balancer,$currtargets,$currrules) =
1329: &check_balancer_result($result,@hosts);
1330: if ($is_balancer) {
1331: if (ref($currrules) eq 'HASH') {
1332: if ($currrules->{'_LC_internetdom'} ne '') {
1333: $rule_in_effect = $currrules->{'_LC_internetdom'};
1334: }
1335: }
1336: $offloadto = &get_loadbalancer_targets($rule_in_effect,$currtargets,
1337: $uname,$udom);
1338: }
1339: } else {
1340: if ($perlvar{'lonBalancer'} eq 'yes') {
1341: $is_balancer = 1;
1342: $offloadto = &this_host_spares($dom_in_use);
1343: }
1344: }
1345: } else {
1346: if ($perlvar{'lonBalancer'} eq 'yes') {
1347: $is_balancer = 1;
1348: $offloadto = &this_host_spares($dom_in_use);
1349: }
1350: }
1351: if ($is_balancer) {
1352: my $lowest_load = 30000;
1353: if (ref($offloadto) eq 'HASH') {
1354: if (ref($offloadto->{'primary'}) eq 'ARRAY') {
1355: foreach my $try_server (@{$offloadto->{'primary'}}) {
1356: ($otherserver,$lowest_load) =
1357: &compare_server_load($try_server,$otherserver,$lowest_load);
1358: }
1359: }
1360: my $found_server = ($otherserver ne '' && $lowest_load < 100);
1361:
1362: if (!$found_server) {
1363: if (ref($offloadto->{'default'}) eq 'ARRAY') {
1364: foreach my $try_server (@{$offloadto->{'default'}}) {
1365: ($otherserver,$lowest_load) =
1366: &compare_server_load($try_server,$otherserver,$lowest_load);
1367: }
1368: }
1369: }
1370: } elsif (ref($offloadto) eq 'ARRAY') {
1371: if (@{$offloadto} == 1) {
1372: $otherserver = $offloadto->[0];
1373: } elsif (@{$offloadto} > 1) {
1374: foreach my $try_server (@{$offloadto}) {
1375: ($otherserver,$lowest_load) =
1376: &compare_server_load($try_server,$otherserver,$lowest_load);
1377: }
1378: }
1379: }
1380: if (($otherserver ne '') && (grep(/^\Q$otherserver\E$/,@hosts))) {
1381: $is_balancer = 0;
1382: if ($uname ne '' && $udom ne '') {
1383: if (($env{'user.name'} eq $uname) && ($env{'user.domain'} eq $udom)) {
1384:
1385: &appenv({'user.loadbalexempt' => $lonhost,
1386: 'user.loadbalcheck.time' => time});
1387: }
1388: }
1389: }
1390: }
1391: return ($is_balancer,$otherserver);
1392: }
1393:
1394: sub check_balancer_result {
1395: my ($result,@hosts) = @_;
1396: my ($is_balancer,$currtargets,$currrules);
1397: if (ref($result) eq 'HASH') {
1398: if ($result->{'lonhost'} ne '') {
1399: my $currbalancer = $result->{'lonhost'};
1400: if (grep(/^\Q$currbalancer\E$/,@hosts)) {
1401: $is_balancer = 1;
1402: $currtargets = $result->{'targets'};
1403: $currrules = $result->{'rules'};
1404: }
1405: } else {
1406: foreach my $key (keys(%{$result})) {
1407: if (($key ne '') && (grep(/^\Q$key\E$/,@hosts)) &&
1408: (ref($result->{$key}) eq 'HASH')) {
1409: $is_balancer = 1;
1410: $currrules = $result->{$key}{'rules'};
1411: $currtargets = $result->{$key}{'targets'};
1412: last;
1413: }
1414: }
1415: }
1416: }
1417: return ($is_balancer,$currtargets,$currrules);
1418: }
1419:
1420: sub get_loadbalancer_targets {
1421: my ($rule_in_effect,$currtargets,$uname,$udom) = @_;
1422: my $offloadto;
1423: if ($rule_in_effect eq 'none') {
1424: return [$perlvar{'lonHostID'}];
1425: } elsif ($rule_in_effect eq '') {
1426: $offloadto = $currtargets;
1427: } else {
1428: if ($rule_in_effect eq 'homeserver') {
1429: my $homeserver = &homeserver($uname,$udom);
1430: if ($homeserver ne 'no_host') {
1431: $offloadto = [$homeserver];
1432: }
1433: } elsif ($rule_in_effect eq 'externalbalancer') {
1434: my %domconfig =
1435: &Apache::lonnet::get_dom('configuration',['loadbalancing'],$udom);
1436: if (ref($domconfig{'loadbalancing'}) eq 'HASH') {
1437: if ($domconfig{'loadbalancing'}{'lonhost'} ne '') {
1438: if (&hostname($domconfig{'loadbalancing'}{'lonhost'}) ne '') {
1439: $offloadto = [$domconfig{'loadbalancing'}{'lonhost'}];
1440: }
1441: }
1442: } else {
1443: my %servers = &internet_dom_servers($udom);
1444: my ($remotebalancer,$remotetargets) = &get_lonbalancer_config(\%servers);
1445: if (&hostname($remotebalancer) ne '') {
1446: $offloadto = [$remotebalancer];
1447: }
1448: }
1449: } elsif (&hostname($rule_in_effect) ne '') {
1450: $offloadto = [$rule_in_effect];
1451: }
1452: }
1453: return $offloadto;
1454: }
1455:
1456: sub internet_dom_servers {
1457: my ($dom) = @_;
1458: my (%uniqservers,%servers);
1459: my $primaryserver = &hostname(&domain($dom,'primary'));
1460: my @machinedoms = &machine_domains($primaryserver);
1461: foreach my $mdom (@machinedoms) {
1462: my %currservers = %servers;
1463: my %server = &get_servers($mdom);
1464: %servers = (%currservers,%server);
1465: }
1466: my %by_hostname;
1467: foreach my $id (keys(%servers)) {
1468: push(@{$by_hostname{$servers{$id}}},$id);
1469: }
1470: foreach my $hostname (sort(keys(%by_hostname))) {
1471: if (@{$by_hostname{$hostname}} > 1) {
1472: my $match = 0;
1473: foreach my $id (@{$by_hostname{$hostname}}) {
1474: if (&host_domain($id) eq $dom) {
1475: $uniqservers{$id} = $hostname;
1476: $match = 1;
1477: }
1478: }
1479: unless ($match) {
1480: $uniqservers{$by_hostname{$hostname}[0]} = $hostname;
1481: }
1482: } else {
1483: $uniqservers{$by_hostname{$hostname}[0]} = $hostname;
1484: }
1485: }
1486: return %uniqservers;
1487: }
1488:
1489: # ---------------------- Find the homebase for a user from domain's lib servers
1490:
1491: my %homecache;
1492: sub homeserver {
1493: my ($uname,$udom,$ignoreBadCache)=@_;
1494: my $index="$uname:$udom";
1495:
1496: if (exists($homecache{$index})) { return $homecache{$index}; }
1497:
1498: my %servers = &get_servers($udom,'library');
1499: foreach my $tryserver (keys(%servers)) {
1500: next if ($ignoreBadCache ne 'true' &&
1501: exists($badServerCache{$tryserver}));
1502:
1503: my $answer=reply("home:$udom:$uname",$tryserver);
1504: if ($answer eq 'found') {
1505: delete($badServerCache{$tryserver});
1506: return $homecache{$index}=$tryserver;
1507: } elsif ($answer eq 'no_host') {
1508: $badServerCache{$tryserver}=1;
1509: }
1510: }
1511: return 'no_host';
1512: }
1513:
1514: # ------------------------------------- Find the usernames behind a list of IDs
1515:
1516: sub idget {
1517: my ($udom,@ids)=@_;
1518: my %returnhash=();
1519:
1520: my %servers = &get_servers($udom,'library');
1521: foreach my $tryserver (keys(%servers)) {
1522: my $idlist=join('&',@ids);
1523: $idlist=~tr/A-Z/a-z/;
1524: my $reply=&reply("idget:$udom:".$idlist,$tryserver);
1525: my @answer=();
1526: if (($reply ne 'con_lost') && ($reply!~/^error\:/)) {
1527: @answer=split(/\&/,$reply);
1528: } ;
1529: my $i;
1530: for ($i=0;$i<=$#ids;$i++) {
1531: if ($answer[$i]) {
1532: $returnhash{$ids[$i]}=$answer[$i];
1533: }
1534: }
1535: }
1536: return %returnhash;
1537: }
1538:
1539: # ------------------------------------- Find the IDs behind a list of usernames
1540:
1541: sub idrget {
1542: my ($udom,@unames)=@_;
1543: my %returnhash=();
1544: foreach my $uname (@unames) {
1545: $returnhash{$uname}=(&userenvironment($udom,$uname,'id'))[1];
1546: }
1547: return %returnhash;
1548: }
1549:
1550: # ------------------------------- Store away a list of names and associated IDs
1551:
1552: sub idput {
1553: my ($udom,%ids)=@_;
1554: my %servers=();
1555: foreach my $uname (keys(%ids)) {
1556: &cput('environment',{'id'=>$ids{$uname}},$udom,$uname);
1557: my $uhom=&homeserver($uname,$udom);
1558: if ($uhom ne 'no_host') {
1559: my $id=&escape($ids{$uname});
1560: $id=~tr/A-Z/a-z/;
1561: my $esc_unam=&escape($uname);
1562: if ($servers{$uhom}) {
1563: $servers{$uhom}.='&'.$id.'='.$esc_unam;
1564: } else {
1565: $servers{$uhom}=$id.'='.$esc_unam;
1566: }
1567: }
1568: }
1569: foreach my $server (keys(%servers)) {
1570: &critical('idput:'.$udom.':'.$servers{$server},$server);
1571: }
1572: }
1573:
1574: # ------------------------------dump from db file owned by domainconfig user
1575: sub dump_dom {
1576: my ($namespace, $udom, $regexp) = @_;
1577:
1578: $udom ||= $env{'user.domain'};
1579:
1580: return () unless $udom;
1581:
1582: return &dump($namespace, $udom, &get_domainconfiguser($udom), $regexp);
1583: }
1584:
1585: # ------------------------------------------ get items from domain db files
1586:
1587: sub get_dom {
1588: my ($namespace,$storearr,$udom,$uhome)=@_;
1589: my $items='';
1590: foreach my $item (@$storearr) {
1591: $items.=&escape($item).'&';
1592: }
1593: $items=~s/\&$//;
1594: if (!$udom) {
1595: $udom=$env{'user.domain'};
1596: if (defined(&domain($udom,'primary'))) {
1597: $uhome=&domain($udom,'primary');
1598: } else {
1599: undef($uhome);
1600: }
1601: } else {
1602: if (!$uhome) {
1603: if (defined(&domain($udom,'primary'))) {
1604: $uhome=&domain($udom,'primary');
1605: }
1606: }
1607: }
1608: if ($udom && $uhome && ($uhome ne 'no_host')) {
1609: my $rep=&reply("getdom:$udom:$namespace:$items",$uhome);
1610: my %returnhash;
1611: if ($rep eq '' || $rep =~ /^error: 2 /) {
1612: return %returnhash;
1613: }
1614: my @pairs=split(/\&/,$rep);
1615: if ( $#pairs==0 && $pairs[0] =~ /^(con_lost|error|no_such_host)/i) {
1616: return @pairs;
1617: }
1618: my $i=0;
1619: foreach my $item (@$storearr) {
1620: $returnhash{$item}=&thaw_unescape($pairs[$i]);
1621: $i++;
1622: }
1623: return %returnhash;
1624: } else {
1625: &logthis("get_dom failed - no homeserver and/or domain ($udom) ($uhome)");
1626: }
1627: }
1628:
1629: # -------------------------------------------- put items in domain db files
1630:
1631: sub put_dom {
1632: my ($namespace,$storehash,$udom,$uhome)=@_;
1633: if (!$udom) {
1634: $udom=$env{'user.domain'};
1635: if (defined(&domain($udom,'primary'))) {
1636: $uhome=&domain($udom,'primary');
1637: } else {
1638: undef($uhome);
1639: }
1640: } else {
1641: if (!$uhome) {
1642: if (defined(&domain($udom,'primary'))) {
1643: $uhome=&domain($udom,'primary');
1644: }
1645: }
1646: }
1647: if ($udom && $uhome && ($uhome ne 'no_host')) {
1648: my $items='';
1649: foreach my $item (keys(%$storehash)) {
1650: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
1651: }
1652: $items=~s/\&$//;
1653: return &reply("putdom:$udom:$namespace:$items",$uhome);
1654: } else {
1655: &logthis("put_dom failed - no homeserver and/or domain");
1656: }
1657: }
1658:
1659: # --------------------- newput for items in db file owned by domainconfig user
1660: sub newput_dom {
1661: my ($namespace,$storehash,$udom) = @_;
1662: my $result;
1663: if (!$udom) {
1664: $udom=$env{'user.domain'};
1665: }
1666: if ($udom) {
1667: my $uname = &get_domainconfiguser($udom);
1668: $result = &newput($namespace,$storehash,$udom,$uname);
1669: }
1670: return $result;
1671: }
1672:
1673: # --------------------- delete for items in db file owned by domainconfig user
1674: sub del_dom {
1675: my ($namespace,$storearr,$udom)=@_;
1676: if (ref($storearr) eq 'ARRAY') {
1677: if (!$udom) {
1678: $udom=$env{'user.domain'};
1679: }
1680: if ($udom) {
1681: my $uname = &get_domainconfiguser($udom);
1682: return &del($namespace,$storearr,$udom,$uname);
1683: }
1684: }
1685: }
1686:
1687: # ----------------------------------construct domainconfig user for a domain
1688: sub get_domainconfiguser {
1689: my ($udom) = @_;
1690: return $udom.'-domainconfig';
1691: }
1692:
1693: sub retrieve_inst_usertypes {
1694: my ($udom) = @_;
1695: my (%returnhash,@order);
1696: my %domdefs = &Apache::lonnet::get_domain_defaults($udom);
1697: if ((ref($domdefs{'inststatustypes'}) eq 'HASH') &&
1698: (ref($domdefs{'inststatusorder'}) eq 'ARRAY')) {
1699: %returnhash = %{$domdefs{'inststatustypes'}};
1700: @order = @{$domdefs{'inststatusorder'}};
1701: } else {
1702: if (defined(&domain($udom,'primary'))) {
1703: my $uhome=&domain($udom,'primary');
1704: my $rep=&reply("inst_usertypes:$udom",$uhome);
1705: if ($rep =~ /^(con_lost|error|no_such_host|refused)/) {
1706: &logthis("get_dom failed - $rep returned from $uhome in domain: $udom");
1707: return (\%returnhash,\@order);
1708: }
1709: my ($hashitems,$orderitems) = split(/:/,$rep);
1710: my @pairs=split(/\&/,$hashitems);
1711: foreach my $item (@pairs) {
1712: my ($key,$value)=split(/=/,$item,2);
1713: $key = &unescape($key);
1714: next if ($key =~ /^error: 2 /);
1715: $returnhash{$key}=&thaw_unescape($value);
1716: }
1717: my @esc_order = split(/\&/,$orderitems);
1718: foreach my $item (@esc_order) {
1719: push(@order,&unescape($item));
1720: }
1721: } else {
1722: &logthis("get_dom failed - no primary domain server for $udom");
1723: }
1724: }
1725: return (\%returnhash,\@order);
1726: }
1727:
1728: sub is_domainimage {
1729: my ($url) = @_;
1730: if ($url=~m-^/+res/+($match_domain)/+\1\-domainconfig/+(img|logo|domlogo)/+-) {
1731: if (&domain($1) ne '') {
1732: return '1';
1733: }
1734: }
1735: return;
1736: }
1737:
1738: sub inst_directory_query {
1739: my ($srch) = @_;
1740: my $udom = $srch->{'srchdomain'};
1741: my %results;
1742: my $homeserver = &domain($udom,'primary');
1743: my $outcome;
1744: if ($homeserver ne '') {
1745: my $queryid=&reply("querysend:instdirsearch:".
1746: &escape($srch->{'srchby'}).':'.
1747: &escape($srch->{'srchterm'}).':'.
1748: &escape($srch->{'srchtype'}),$homeserver);
1749: my $host=&hostname($homeserver);
1750: if ($queryid !~/^\Q$host\E\_/) {
1751: &logthis('instituional directory search invalid queryid: '.$queryid.' for host: '.$homeserver.'in domain '.$udom);
1752: return;
1753: }
1754: my $response = &get_query_reply($queryid);
1755: my $maxtries = 5;
1756: my $tries = 1;
1757: while (($response=~/^timeout/) && ($tries < $maxtries)) {
1758: $response = &get_query_reply($queryid);
1759: $tries ++;
1760: }
1761:
1762: if (!&error($response) && $response ne 'refused') {
1763: if ($response eq 'unavailable') {
1764: $outcome = $response;
1765: } else {
1766: $outcome = 'ok';
1767: my @matches = split(/\n/,$response);
1768: foreach my $match (@matches) {
1769: my ($key,$value) = split(/=/,$match);
1770: $results{&unescape($key).':'.$udom} = &thaw_unescape($value);
1771: }
1772: }
1773: }
1774: }
1775: return ($outcome,%results);
1776: }
1777:
1778: sub usersearch {
1779: my ($srch) = @_;
1780: my $dom = $srch->{'srchdomain'};
1781: my %results;
1782: my %libserv = &all_library();
1783: my $query = 'usersearch';
1784: foreach my $tryserver (keys(%libserv)) {
1785: if (&host_domain($tryserver) eq $dom) {
1786: my $host=&hostname($tryserver);
1787: my $queryid=
1788: &reply("querysend:".&escape($query).':'.
1789: &escape($srch->{'srchby'}).':'.
1790: &escape($srch->{'srchtype'}).':'.
1791: &escape($srch->{'srchterm'}),$tryserver);
1792: if ($queryid !~/^\Q$host\E\_/) {
1793: &logthis('usersearch: invalid queryid: '.$queryid.' for host: '.$host.'in domain '.$dom.' and server: '.$tryserver);
1794: next;
1795: }
1796: my $reply = &get_query_reply($queryid);
1797: my $maxtries = 1;
1798: my $tries = 1;
1799: while (($reply=~/^timeout/) && ($tries < $maxtries)) {
1800: $reply = &get_query_reply($queryid);
1801: $tries ++;
1802: }
1803: if ( ($reply =~/^timeout/) || ($reply =~/^error/) ) {
1804: &logthis('usersrch error: '.$reply.' for '.$dom.' - searching for : '.$srch->{'srchterm'}.' by '.$srch->{'srchby'}.' ('.$srch->{'srchtype'}.') - maxtries: '.$maxtries.' tries: '.$tries);
1805: } else {
1806: my @matches;
1807: if ($reply =~ /\n/) {
1808: @matches = split(/\n/,$reply);
1809: } else {
1810: @matches = split(/\&/,$reply);
1811: }
1812: foreach my $match (@matches) {
1813: my ($uname,$udom,%userhash);
1814: foreach my $entry (split(/:/,$match)) {
1815: my ($key,$value) =
1816: map {&unescape($_);} split(/=/,$entry);
1817: $userhash{$key} = $value;
1818: if ($key eq 'username') {
1819: $uname = $value;
1820: } elsif ($key eq 'domain') {
1821: $udom = $value;
1822: }
1823: }
1824: $results{$uname.':'.$udom} = \%userhash;
1825: }
1826: }
1827: }
1828: }
1829: return %results;
1830: }
1831:
1832: sub get_instuser {
1833: my ($udom,$uname,$id) = @_;
1834: my $homeserver = &domain($udom,'primary');
1835: my ($outcome,%results);
1836: if ($homeserver ne '') {
1837: my $queryid=&reply("querysend:getinstuser:".&escape($uname).':'.
1838: &escape($id).':'.&escape($udom),$homeserver);
1839: my $host=&hostname($homeserver);
1840: if ($queryid !~/^\Q$host\E\_/) {
1841: &logthis('get_instuser invalid queryid: '.$queryid.' for host: '.$homeserver.'in domain '.$udom);
1842: return;
1843: }
1844: my $response = &get_query_reply($queryid);
1845: my $maxtries = 5;
1846: my $tries = 1;
1847: while (($response=~/^timeout/) && ($tries < $maxtries)) {
1848: $response = &get_query_reply($queryid);
1849: $tries ++;
1850: }
1851: if (!&error($response) && $response ne 'refused') {
1852: if ($response eq 'unavailable') {
1853: $outcome = $response;
1854: } else {
1855: $outcome = 'ok';
1856: my @matches = split(/\n/,$response);
1857: foreach my $match (@matches) {
1858: my ($key,$value) = split(/=/,$match);
1859: $results{&unescape($key)} = &thaw_unescape($value);
1860: }
1861: }
1862: }
1863: }
1864: my %userinfo;
1865: if (ref($results{$uname}) eq 'HASH') {
1866: %userinfo = %{$results{$uname}};
1867: }
1868: return ($outcome,%userinfo);
1869: }
1870:
1871: sub inst_rulecheck {
1872: my ($udom,$uname,$id,$item,$rules) = @_;
1873: my %returnhash;
1874: if ($udom ne '') {
1875: if (ref($rules) eq 'ARRAY') {
1876: @{$rules} = map {&escape($_);} (@{$rules});
1877: my $rulestr = join(':',@{$rules});
1878: my $homeserver=&domain($udom,'primary');
1879: if (($homeserver ne '') && ($homeserver ne 'no_host')) {
1880: my $response;
1881: if ($item eq 'username') {
1882: $response=&unescape(&reply('instrulecheck:'.&escape($udom).
1883: ':'.&escape($uname).':'.$rulestr,
1884: $homeserver));
1885: } elsif ($item eq 'id') {
1886: $response=&unescape(&reply('instidrulecheck:'.&escape($udom).
1887: ':'.&escape($id).':'.$rulestr,
1888: $homeserver));
1889: } elsif ($item eq 'selfcreate') {
1890: $response=&unescape(&reply('instselfcreatecheck:'.
1891: &escape($udom).':'.&escape($uname).
1892: ':'.$rulestr,$homeserver));
1893: }
1894: if ($response ne 'refused') {
1895: my @pairs=split(/\&/,$response);
1896: foreach my $item (@pairs) {
1897: my ($key,$value)=split(/=/,$item,2);
1898: $key = &unescape($key);
1899: next if ($key =~ /^error: 2 /);
1900: $returnhash{$key}=&thaw_unescape($value);
1901: }
1902: }
1903: }
1904: }
1905: }
1906: return %returnhash;
1907: }
1908:
1909: sub inst_userrules {
1910: my ($udom,$check) = @_;
1911: my (%ruleshash,@ruleorder);
1912: if ($udom ne '') {
1913: my $homeserver=&domain($udom,'primary');
1914: if (($homeserver ne '') && ($homeserver ne 'no_host')) {
1915: my $response;
1916: if ($check eq 'id') {
1917: $response=&reply('instidrules:'.&escape($udom),
1918: $homeserver);
1919: } elsif ($check eq 'email') {
1920: $response=&reply('instemailrules:'.&escape($udom),
1921: $homeserver);
1922: } else {
1923: $response=&reply('instuserrules:'.&escape($udom),
1924: $homeserver);
1925: }
1926: if (($response ne 'refused') && ($response ne 'error') &&
1927: ($response ne 'unknown_cmd') &&
1928: ($response ne 'no_such_host')) {
1929: my ($hashitems,$orderitems) = split(/:/,$response);
1930: my @pairs=split(/\&/,$hashitems);
1931: foreach my $item (@pairs) {
1932: my ($key,$value)=split(/=/,$item,2);
1933: $key = &unescape($key);
1934: next if ($key =~ /^error: 2 /);
1935: $ruleshash{$key}=&thaw_unescape($value);
1936: }
1937: my @esc_order = split(/\&/,$orderitems);
1938: foreach my $item (@esc_order) {
1939: push(@ruleorder,&unescape($item));
1940: }
1941: }
1942: }
1943: }
1944: return (\%ruleshash,\@ruleorder);
1945: }
1946:
1947: # ------------- Get Authentication, Language and User Tools Defaults for Domain
1948:
1949: sub get_domain_defaults {
1950: my ($domain) = @_;
1951: my $cachetime = 60*60*24;
1952: my ($result,$cached)=&is_cached_new('domdefaults',$domain);
1953: if (defined($cached)) {
1954: if (ref($result) eq 'HASH') {
1955: return %{$result};
1956: }
1957: }
1958: my %domdefaults;
1959: my %domconfig =
1960: &Apache::lonnet::get_dom('configuration',['defaults','quotas',
1961: 'requestcourses','inststatus',
1962: 'coursedefaults','usersessions',
1963: 'requestauthor'],$domain);
1964: if (ref($domconfig{'defaults'}) eq 'HASH') {
1965: $domdefaults{'lang_def'} = $domconfig{'defaults'}{'lang_def'};
1966: $domdefaults{'auth_def'} = $domconfig{'defaults'}{'auth_def'};
1967: $domdefaults{'auth_arg_def'} = $domconfig{'defaults'}{'auth_arg_def'};
1968: $domdefaults{'timezone_def'} = $domconfig{'defaults'}{'timezone_def'};
1969: $domdefaults{'datelocale_def'} = $domconfig{'defaults'}{'datelocale_def'};
1970: $domdefaults{'portal_def'} = $domconfig{'defaults'}{'portal_def'};
1971: } else {
1972: $domdefaults{'lang_def'} = &domain($domain,'lang_def');
1973: $domdefaults{'auth_def'} = &domain($domain,'auth_def');
1974: $domdefaults{'auth_arg_def'} = &domain($domain,'auth_arg_def');
1975: }
1976: if (ref($domconfig{'quotas'}) eq 'HASH') {
1977: if (ref($domconfig{'quotas'}{'defaultquota'}) eq 'HASH') {
1978: $domdefaults{'defaultquota'} = $domconfig{'quotas'}{'defaultquota'};
1979: } else {
1980: $domdefaults{'defaultquota'} = $domconfig{'quotas'};
1981: }
1982: my @usertools = ('aboutme','blog','webdav','portfolio');
1983: foreach my $item (@usertools) {
1984: if (ref($domconfig{'quotas'}{$item}) eq 'HASH') {
1985: $domdefaults{$item} = $domconfig{'quotas'}{$item};
1986: }
1987: }
1988: }
1989: if (ref($domconfig{'requestcourses'}) eq 'HASH') {
1990: foreach my $item ('official','unofficial','community') {
1991: $domdefaults{$item} = $domconfig{'requestcourses'}{$item};
1992: }
1993: }
1994: if (ref($domconfig{'requestauthor'}) eq 'HASH') {
1995: $domdefaults{'requestauthor'} = $domconfig{'requestauthor'};
1996: }
1997: if (ref($domconfig{'inststatus'}) eq 'HASH') {
1998: foreach my $item ('inststatustypes','inststatusorder') {
1999: $domdefaults{$item} = $domconfig{'inststatus'}{$item};
2000: }
2001: }
2002: if (ref($domconfig{'coursedefaults'}) eq 'HASH') {
2003: foreach my $item ('canuse_pdfforms') {
2004: $domdefaults{$item} = $domconfig{'coursedefaults'}{$item};
2005: }
2006: }
2007: if (ref($domconfig{'usersessions'}) eq 'HASH') {
2008: if (ref($domconfig{'usersessions'}{'remote'}) eq 'HASH') {
2009: $domdefaults{'remotesessions'} = $domconfig{'usersessions'}{'remote'};
2010: }
2011: if (ref($domconfig{'usersessions'}{'hosted'}) eq 'HASH') {
2012: $domdefaults{'hostedsessions'} = $domconfig{'usersessions'}{'hosted'};
2013: }
2014: }
2015: &Apache::lonnet::do_cache_new('domdefaults',$domain,\%domdefaults,
2016: $cachetime);
2017: return %domdefaults;
2018: }
2019:
2020: # --------------------------------------------------- Assign a key to a student
2021:
2022: sub assign_access_key {
2023: #
2024: # a valid key looks like uname:udom#comments
2025: # comments are being appended
2026: #
2027: my ($ckey,$kdom,$knum,$cdom,$cnum,$udom,$uname,$logentry)=@_;
2028: $kdom=
2029: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($kdom));
2030: $knum=
2031: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($knum));
2032: $cdom=
2033: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
2034: $cnum=
2035: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
2036: $udom=$env{'user.name'} unless (defined($udom));
2037: $uname=$env{'user.domain'} unless (defined($uname));
2038: my %existing=&get('accesskeys',[$ckey],$kdom,$knum);
2039: if (($existing{$ckey}=~/^\#(.*)$/) || # - new key
2040: ($existing{$ckey}=~/^\Q$uname\E\:\Q$udom\E\#(.*)$/)) {
2041: # assigned to this person
2042: # - this should not happen,
2043: # unless something went wrong
2044: # the first time around
2045: # ready to assign
2046: $logentry=$1.'; '.$logentry;
2047: if (&put('accesskeys',{$ckey=>$uname.':'.$udom.'#'.$logentry},
2048: $kdom,$knum) eq 'ok') {
2049: # key now belongs to user
2050: my $envkey='key.'.$cdom.'_'.$cnum;
2051: if (&put('environment',{$envkey => $ckey}) eq 'ok') {
2052: &appenv({'environment.'.$envkey => $ckey});
2053: return 'ok';
2054: } else {
2055: return
2056: 'error: Count not permanently assign key, will need to be re-entered later.';
2057: }
2058: } else {
2059: return 'error: Could not assign key, try again later.';
2060: }
2061: } elsif (!$existing{$ckey}) {
2062: # the key does not exist
2063: return 'error: The key does not exist';
2064: } else {
2065: # the key is somebody else's
2066: return 'error: The key is already in use';
2067: }
2068: }
2069:
2070: # ------------------------------------------ put an additional comment on a key
2071:
2072: sub comment_access_key {
2073: #
2074: # a valid key looks like uname:udom#comments
2075: # comments are being appended
2076: #
2077: my ($ckey,$cdom,$cnum,$logentry)=@_;
2078: $cdom=
2079: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
2080: $cnum=
2081: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
2082: my %existing=&get('accesskeys',[$ckey],$cdom,$cnum);
2083: if ($existing{$ckey}) {
2084: $existing{$ckey}.='; '.$logentry;
2085: # ready to assign
2086: if (&put('accesskeys',{$ckey=>$existing{$ckey}},
2087: $cdom,$cnum) eq 'ok') {
2088: return 'ok';
2089: } else {
2090: return 'error: Count not store comment.';
2091: }
2092: } else {
2093: # the key does not exist
2094: return 'error: The key does not exist';
2095: }
2096: }
2097:
2098: # ------------------------------------------------------ Generate a set of keys
2099:
2100: sub generate_access_keys {
2101: my ($number,$cdom,$cnum,$logentry)=@_;
2102: $cdom=
2103: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
2104: $cnum=
2105: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
2106: unless (&allowed('mky',$cdom)) { return 0; }
2107: unless (($cdom) && ($cnum)) { return 0; }
2108: if ($number>10000) { return 0; }
2109: sleep(2); # make sure don't get same seed twice
2110: srand(time()^($$+($$<<15))); # from "Programming Perl"
2111: my $total=0;
2112: for (my $i=1;$i<=$number;$i++) {
2113: my $newkey=sprintf("%lx",int(100000*rand)).'-'.
2114: sprintf("%lx",int(100000*rand)).'-'.
2115: sprintf("%lx",int(100000*rand));
2116: $newkey=~s/1/g/g; # folks mix up 1 and l
2117: $newkey=~s/0/h/g; # and also 0 and O
2118: my %existing=&get('accesskeys',[$newkey],$cdom,$cnum);
2119: if ($existing{$newkey}) {
2120: $i--;
2121: } else {
2122: if (&put('accesskeys',
2123: { $newkey => '# generated '.localtime().
2124: ' by '.$env{'user.name'}.'@'.$env{'user.domain'}.
2125: '; '.$logentry },
2126: $cdom,$cnum) eq 'ok') {
2127: $total++;
2128: }
2129: }
2130: }
2131: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},
2132: 'Generated '.$total.' keys for '.$cnum.' at '.$cdom);
2133: return $total;
2134: }
2135:
2136: # ------------------------------------------------------- Validate an accesskey
2137:
2138: sub validate_access_key {
2139: my ($ckey,$cdom,$cnum,$udom,$uname)=@_;
2140: $cdom=
2141: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
2142: $cnum=
2143: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
2144: $udom=$env{'user.domain'} unless (defined($udom));
2145: $uname=$env{'user.name'} unless (defined($uname));
2146: my %existing=&get('accesskeys',[$ckey],$cdom,$cnum);
2147: return ($existing{$ckey}=~/^\Q$uname\E\:\Q$udom\E\#/);
2148: }
2149:
2150: # ------------------------------------- Find the section of student in a course
2151: sub devalidate_getsection_cache {
2152: my ($udom,$unam,$courseid)=@_;
2153: my $hashid="$udom:$unam:$courseid";
2154: &devalidate_cache_new('getsection',$hashid);
2155: }
2156:
2157: sub courseid_to_courseurl {
2158: my ($courseid) = @_;
2159: #already url style courseid
2160: return $courseid if ($courseid =~ m{^/});
2161:
2162: if (exists($env{'course.'.$courseid.'.num'})) {
2163: my $cnum = $env{'course.'.$courseid.'.num'};
2164: my $cdom = $env{'course.'.$courseid.'.domain'};
2165: return "/$cdom/$cnum";
2166: }
2167:
2168: my %courseinfo=&Apache::lonnet::coursedescription($courseid);
2169: if (exists($courseinfo{'num'})) {
2170: return "/$courseinfo{'domain'}/$courseinfo{'num'}";
2171: }
2172:
2173: return undef;
2174: }
2175:
2176: sub getsection {
2177: my ($udom,$unam,$courseid)=@_;
2178: my $cachetime=1800;
2179:
2180: my $hashid="$udom:$unam:$courseid";
2181: my ($result,$cached)=&is_cached_new('getsection',$hashid);
2182: if (defined($cached)) { return $result; }
2183:
2184: my %Pending;
2185: my %Expired;
2186: #
2187: # Each role can either have not started yet (pending), be active,
2188: # or have expired.
2189: #
2190: # If there is an active role, we are done.
2191: #
2192: # If there is more than one role which has not started yet,
2193: # choose the one which will start sooner
2194: # If there is one role which has not started yet, return it.
2195: #
2196: # If there is more than one expired role, choose the one which ended last.
2197: # If there is a role which has expired, return it.
2198: #
2199: $courseid = &courseid_to_courseurl($courseid);
2200: my %roleshash = &dump('roles',$udom,$unam,$courseid);
2201: foreach my $key (keys(%roleshash)) {
2202: next if ($key !~/^\Q$courseid\E(?:\/)*(\w+)*\_st$/);
2203: my $section=$1;
2204: if ($key eq $courseid.'_st') { $section=''; }
2205: my ($dummy,$end,$start)=split(/\_/,&unescape($roleshash{$key}));
2206: my $now=time;
2207: if (defined($end) && $end && ($now > $end)) {
2208: $Expired{$end}=$section;
2209: next;
2210: }
2211: if (defined($start) && $start && ($now < $start)) {
2212: $Pending{$start}=$section;
2213: next;
2214: }
2215: return &do_cache_new('getsection',$hashid,$section,$cachetime);
2216: }
2217: #
2218: # Presumedly there will be few matching roles from the above
2219: # loop and the sorting time will be negligible.
2220: if (scalar(keys(%Pending))) {
2221: my ($time) = sort {$a <=> $b} keys(%Pending);
2222: return &do_cache_new('getsection',$hashid,$Pending{$time},$cachetime);
2223: }
2224: if (scalar(keys(%Expired))) {
2225: my @sorted = sort {$a <=> $b} keys(%Expired);
2226: my $time = pop(@sorted);
2227: return &do_cache_new('getsection',$hashid,$Expired{$time},$cachetime);
2228: }
2229: return &do_cache_new('getsection',$hashid,'-1',$cachetime);
2230: }
2231:
2232: sub save_cache {
2233: &purge_remembered();
2234: #&Apache::loncommon::validate_page();
2235: undef(%env);
2236: undef($env_loaded);
2237: }
2238:
2239: my $to_remember=-1;
2240: my %remembered;
2241: my %accessed;
2242: my $kicks=0;
2243: my $hits=0;
2244: sub make_key {
2245: my ($name,$id) = @_;
2246: if (length($id) > 65
2247: && length(&escape($id)) > 200) {
2248: $id=length($id).':'.&Digest::MD5::md5_hex($id);
2249: }
2250: return &escape($name.':'.$id);
2251: }
2252:
2253: sub devalidate_cache_new {
2254: my ($name,$id,$debug) = @_;
2255: if ($debug) { &Apache::lonnet::logthis("deleting $name:$id"); }
2256: $id=&make_key($name,$id);
2257: $memcache->delete($id);
2258: delete($remembered{$id});
2259: delete($accessed{$id});
2260: }
2261:
2262: sub is_cached_new {
2263: my ($name,$id,$debug) = @_;
2264: $id=&make_key($name,$id);
2265: if (exists($remembered{$id})) {
2266: if ($debug) { &Apache::lonnet::logthis("Early return $id of $remembered{$id} "); }
2267: $accessed{$id}=[&gettimeofday()];
2268: $hits++;
2269: return ($remembered{$id},1);
2270: }
2271: my $value = $memcache->get($id);
2272: if (!(defined($value))) {
2273: if ($debug) { &Apache::lonnet::logthis("getting $id is not defined"); }
2274: return (undef,undef);
2275: }
2276: if ($value eq '__undef__') {
2277: if ($debug) { &Apache::lonnet::logthis("getting $id is __undef__"); }
2278: $value=undef;
2279: }
2280: &make_room($id,$value,$debug);
2281: if ($debug) { &Apache::lonnet::logthis("getting $id is $value"); }
2282: return ($value,1);
2283: }
2284:
2285: sub do_cache_new {
2286: my ($name,$id,$value,$time,$debug) = @_;
2287: $id=&make_key($name,$id);
2288: my $setvalue=$value;
2289: if (!defined($setvalue)) {
2290: $setvalue='__undef__';
2291: }
2292: if (!defined($time) ) {
2293: $time=600;
2294: }
2295: if ($debug) { &Apache::lonnet::logthis("Setting $id to $value"); }
2296: my $result = $memcache->set($id,$setvalue,$time);
2297: if (! $result) {
2298: &logthis("caching of id -> $id failed");
2299: $memcache->disconnect_all();
2300: }
2301: # need to make a copy of $value
2302: &make_room($id,$value,$debug);
2303: return $value;
2304: }
2305:
2306: sub make_room {
2307: my ($id,$value,$debug)=@_;
2308:
2309: $remembered{$id}= (ref($value)) ? &Storable::dclone($value)
2310: : $value;
2311: if ($to_remember<0) { return; }
2312: $accessed{$id}=[&gettimeofday()];
2313: if (scalar(keys(%remembered)) <= $to_remember) { return; }
2314: my $to_kick;
2315: my $max_time=0;
2316: foreach my $other (keys(%accessed)) {
2317: if (&tv_interval($accessed{$other}) > $max_time) {
2318: $to_kick=$other;
2319: $max_time=&tv_interval($accessed{$other});
2320: }
2321: }
2322: delete($remembered{$to_kick});
2323: delete($accessed{$to_kick});
2324: $kicks++;
2325: if ($debug) { &logthis("kicking $to_kick $max_time $kicks\n"); }
2326: return;
2327: }
2328:
2329: sub purge_remembered {
2330: #&logthis("Tossing ".scalar(keys(%remembered)));
2331: #&logthis(sprintf("%-20s is %s",'%remembered',length(&freeze(\%remembered))));
2332: undef(%remembered);
2333: undef(%accessed);
2334: }
2335: # ------------------------------------- Read an entry from a user's environment
2336:
2337: sub userenvironment {
2338: my ($udom,$unam,@what)=@_;
2339: my $items;
2340: foreach my $item (@what) {
2341: $items.=&escape($item).'&';
2342: }
2343: $items=~s/\&$//;
2344: my %returnhash=();
2345: my $uhome = &homeserver($unam,$udom);
2346: unless ($uhome eq 'no_host') {
2347: my @answer=split(/\&/,
2348: &reply('get:'.$udom.':'.$unam.':environment:'.$items,$uhome));
2349: if ($#answer==0 && $answer[0] =~ /^(con_lost|error:|no_such_host)/i) {
2350: return %returnhash;
2351: }
2352: my $i;
2353: for ($i=0;$i<=$#what;$i++) {
2354: $returnhash{$what[$i]}=&unescape($answer[$i]);
2355: }
2356: }
2357: return %returnhash;
2358: }
2359:
2360: # ---------------------------------------------------------- Get a studentphoto
2361: sub studentphoto {
2362: my ($udom,$unam,$ext) = @_;
2363: my $home=&Apache::lonnet::homeserver($unam,$udom);
2364: if (defined($env{'request.course.id'})) {
2365: if ($env{'course.'.$env{'request.course.id'}.'.internal.showphoto'}) {
2366: if ($udom eq $env{'course.'.$env{'request.course.id'}.'.domain'}) {
2367: return(&retrievestudentphoto($udom,$unam,$ext));
2368: } else {
2369: my ($result,$perm_reqd)=
2370: &Apache::lonnet::auto_photo_permission($unam,$udom);
2371: if ($result eq 'ok') {
2372: if (!($perm_reqd eq 'yes')) {
2373: return(&retrievestudentphoto($udom,$unam,$ext));
2374: }
2375: }
2376: }
2377: }
2378: } else {
2379: my ($result,$perm_reqd) =
2380: &Apache::lonnet::auto_photo_permission($unam,$udom);
2381: if ($result eq 'ok') {
2382: if (!($perm_reqd eq 'yes')) {
2383: return(&retrievestudentphoto($udom,$unam,$ext));
2384: }
2385: }
2386: }
2387: return '/adm/lonKaputt/lonlogo_broken.gif';
2388: }
2389:
2390: sub retrievestudentphoto {
2391: my ($udom,$unam,$ext,$type) = @_;
2392: my $home=&Apache::lonnet::homeserver($unam,$udom);
2393: my $ret=&Apache::lonnet::reply("studentphoto:$udom:$unam:$ext:$type",$home);
2394: if ($ret eq 'ok') {
2395: my $url="/uploaded/$udom/$unam/internal/studentphoto.$ext";
2396: if ($type eq 'thumbnail') {
2397: $url="/uploaded/$udom/$unam/internal/studentphoto_tn.$ext";
2398: }
2399: my $tokenurl=&Apache::lonnet::tokenwrapper($url);
2400: return $tokenurl;
2401: } else {
2402: if ($type eq 'thumbnail') {
2403: return '/adm/lonKaputt/genericstudent_tn.gif';
2404: } else {
2405: return '/adm/lonKaputt/lonlogo_broken.gif';
2406: }
2407: }
2408: }
2409:
2410: # -------------------------------------------------------------------- New chat
2411:
2412: sub chatsend {
2413: my ($newentry,$anon,$group)=@_;
2414: my $cnum=$env{'course.'.$env{'request.course.id'}.'.num'};
2415: my $cdom=$env{'course.'.$env{'request.course.id'}.'.domain'};
2416: my $chome=$env{'course.'.$env{'request.course.id'}.'.home'};
2417: &reply('chatsend:'.$cdom.':'.$cnum.':'.
2418: &escape($env{'user.domain'}.':'.$env{'user.name'}.':'.$anon.':'.
2419: &escape($newentry)).':'.$group,$chome);
2420: }
2421:
2422: # ------------------------------------------ Find current version of a resource
2423:
2424: sub getversion {
2425: my $fname=&clutter(shift);
2426: unless ($fname=~m{^(/adm/wrapper|)/res/}) { return -1; }
2427: return ¤tversion(&filelocation('',$fname));
2428: }
2429:
2430: sub currentversion {
2431: my $fname=shift;
2432: my $author=$fname;
2433: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
2434: my ($udom,$uname)=split(/\//,$author);
2435: my $home=&homeserver($uname,$udom);
2436: if ($home eq 'no_host') {
2437: return -1;
2438: }
2439: my $answer=&reply("currentversion:$fname",$home);
2440: if (($answer eq 'con_lost') || ($answer eq 'rejected')) {
2441: return -1;
2442: }
2443: return $answer;
2444: }
2445:
2446: #
2447: # Return special version number of resource if set by override, empty otherwise
2448: #
2449: sub usedversion {
2450: my $fname=shift;
2451: unless ($fname) { $fname=$env{'request.uri'}; }
2452: my ($urlversion)=($fname=~/\.(\d+)\.\w+$/);
2453: if ($urlversion) { return $urlversion; }
2454: return '';
2455: }
2456:
2457: # ----------------------------- Subscribe to a resource, return URL if possible
2458:
2459: sub subscribe {
2460: my $fname=shift;
2461: if ($fname=~/\/(aboutme|syllabus|bulletinboard|smppg)$/) { return ''; }
2462: $fname=~s/[\n\r]//g;
2463: my $author=$fname;
2464: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
2465: my ($udom,$uname)=split(/\//,$author);
2466: my $home=homeserver($uname,$udom);
2467: if ($home eq 'no_host') {
2468: return 'not_found';
2469: }
2470: my $answer=reply("sub:$fname",$home);
2471: if (($answer eq 'con_lost') || ($answer eq 'rejected')) {
2472: $answer.=' by '.$home;
2473: }
2474: return $answer;
2475: }
2476:
2477: # -------------------------------------------------------------- Replicate file
2478:
2479: sub repcopy {
2480: my $filename=shift;
2481: $filename=~s/\/+/\//g;
2482: my $londocroot = $perlvar{'lonDocRoot'};
2483: if ($filename=~m{^\Q$londocroot/adm/\E}) { return 'ok'; }
2484: if ($filename=~m{^\Q/home/httpd/lonUsers/\E}) { return 'ok'; }
2485: if ($filename=~m{^\Q$londocroot/userfiles/\E} or
2486: $filename=~m{^/*(uploaded|editupload)/}) {
2487: return &repcopy_userfile($filename);
2488: }
2489: $filename=~s/[\n\r]//g;
2490: my $transname="$filename.in.transfer";
2491: # FIXME: this should flock
2492: if ((-e $filename) || (-e $transname)) { return 'ok'; }
2493: my $remoteurl=subscribe($filename);
2494: if ($remoteurl =~ /^con_lost by/) {
2495: &logthis("Subscribe returned $remoteurl: $filename");
2496: return 'unavailable';
2497: } elsif ($remoteurl eq 'not_found') {
2498: #&logthis("Subscribe returned not_found: $filename");
2499: return 'not_found';
2500: } elsif ($remoteurl =~ /^rejected by/) {
2501: &logthis("Subscribe returned $remoteurl: $filename");
2502: return 'forbidden';
2503: } elsif ($remoteurl eq 'directory') {
2504: return 'ok';
2505: } else {
2506: my $author=$filename;
2507: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
2508: my ($udom,$uname)=split(/\//,$author);
2509: my $home=homeserver($uname,$udom);
2510: unless ($home eq $perlvar{'lonHostID'}) {
2511: my @parts=split(/\//,$filename);
2512: my $path="/$parts[1]/$parts[2]/$parts[3]/$parts[4]";
2513: if ($path ne "$londocroot/res") {
2514: &logthis("Malconfiguration for replication: $filename");
2515: return 'bad_request';
2516: }
2517: my $count;
2518: for ($count=5;$count<$#parts;$count++) {
2519: $path.="/$parts[$count]";
2520: if ((-e $path)!=1) {
2521: mkdir($path,0777);
2522: }
2523: }
2524: my $ua=new LWP::UserAgent;
2525: my $request=new HTTP::Request('GET',"$remoteurl");
2526: my $response=$ua->request($request,$transname);
2527: if ($response->is_error()) {
2528: unlink($transname);
2529: my $message=$response->status_line;
2530: &logthis("<font color=\"blue\">WARNING:"
2531: ." LWP get: $message: $filename</font>");
2532: return 'unavailable';
2533: } else {
2534: if ($remoteurl!~/\.meta$/) {
2535: my $mrequest=new HTTP::Request('GET',$remoteurl.'.meta');
2536: my $mresponse=$ua->request($mrequest,$filename.'.meta');
2537: if ($mresponse->is_error()) {
2538: unlink($filename.'.meta');
2539: &logthis(
2540: "<font color=\"yellow\">INFO: No metadata: $filename</font>");
2541: }
2542: }
2543: rename($transname,$filename);
2544: return 'ok';
2545: }
2546: }
2547: }
2548: }
2549:
2550: # ------------------------------------------------ Get server side include body
2551: sub ssi_body {
2552: my ($filelink,%form)=@_;
2553: if (! exists($form{'LONCAPA_INTERNAL_no_discussion'})) {
2554: $form{'LONCAPA_INTERNAL_no_discussion'}='true';
2555: }
2556: my $output='';
2557: my $response;
2558: if ($filelink=~/^https?\:/) {
2559: ($output,$response)=&externalssi($filelink);
2560: } else {
2561: $filelink .= $filelink=~/\?/ ? '&' : '?';
2562: $filelink .= 'inhibitmenu=yes';
2563: ($output,$response)=&ssi($filelink,%form);
2564: }
2565: $output=~s|//(\s*<!--)? BEGIN LON-CAPA Internal.+?// END LON-CAPA Internal\s*(-->)?\s||gs;
2566: $output=~s/^.*?\<body[^\>]*\>//si;
2567: $output=~s/\<\/body\s*\>.*?$//si;
2568: if (wantarray) {
2569: return ($output, $response);
2570: } else {
2571: return $output;
2572: }
2573: }
2574:
2575: # --------------------------------------------------------- Server Side Include
2576:
2577: sub absolute_url {
2578: my ($host_name) = @_;
2579: my $protocol = ($ENV{'SERVER_PORT'} == 443?'https://':'http://');
2580: if ($host_name eq '') {
2581: $host_name = $ENV{'SERVER_NAME'};
2582: }
2583: return $protocol.$host_name;
2584: }
2585:
2586: #
2587: # Server side include.
2588: # Parameters:
2589: # fn Possibly encrypted resource name/id.
2590: # form Hash that describes how the rendering should be done
2591: # and other things.
2592: # Returns:
2593: # Scalar context: The content of the response.
2594: # Array context: 2 element list of the content and the full response object.
2595: #
2596: sub ssi {
2597:
2598: my ($fn,%form)=@_;
2599: my $ua=new LWP::UserAgent;
2600: my $request;
2601:
2602: $form{'no_update_last_known'}=1;
2603: &Apache::lonenc::check_encrypt(\$fn);
2604: if (%form) {
2605: $request=new HTTP::Request('POST',&absolute_url().$fn);
2606: $request->content(join('&',map { &escape($_).'='.&escape($form{$_}) } keys(%form)));
2607: } else {
2608: $request=new HTTP::Request('GET',&absolute_url().$fn);
2609: }
2610:
2611: $request->header(Cookie => $ENV{'HTTP_COOKIE'});
2612: my $response= $ua->request($request);
2613: my $content = $response->content;
2614:
2615:
2616: if (wantarray) {
2617: return ($content, $response);
2618: } else {
2619: return $content;
2620: }
2621: }
2622:
2623: sub externalssi {
2624: my ($url)=@_;
2625: my $ua=new LWP::UserAgent;
2626: my $request=new HTTP::Request('GET',$url);
2627: my $response=$ua->request($request);
2628: if (wantarray) {
2629: return ($response->content, $response);
2630: } else {
2631: return $response->content;
2632: }
2633: }
2634:
2635: # -------------------------------- Allow a /uploaded/ URI to be vouched for
2636:
2637: sub allowuploaded {
2638: my ($srcurl,$url)=@_;
2639: $url=&clutter(&declutter($url));
2640: my $dir=$url;
2641: $dir=~s/\/[^\/]+$//;
2642: my %httpref=();
2643: my $httpurl=&hreflocation('',$url);
2644: $httpref{'httpref.'.$httpurl}=$srcurl;
2645: &Apache::lonnet::appenv(\%httpref);
2646: }
2647:
2648: # --------- File operations in /home/httpd/html/userfiles/$domain/1/2/3/$course
2649: # input: action, courseID, current domain, intended
2650: # path to file, source of file, instruction to parse file for objects,
2651: # ref to hash for embedded objects,
2652: # ref to hash for codebase of java objects.
2653: # reference to scalar to accommodate mime type determined
2654: # from File::MMagic if $parser = parse.
2655: #
2656: # output: url to file (if action was uploaddoc),
2657: # ok if successful, or diagnostic message otherwise (if action was propagate or copy)
2658: #
2659: # Allows directory structure to be used within lonUsers/../userfiles/ for a
2660: # course.
2661: #
2662: # action = propagate - /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
2663: # will be copied to /home/httpd/lonUsers/1/2/3/$course/userfiles in
2664: # course's home server.
2665: #
2666: # action = copy - /home/httpd/html/userfiles/$domain/1/2/3/$course/$file will
2667: # be copied from $source (current location) to
2668: # /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
2669: # and will then be copied to
2670: # /home/httpd/lonUsers/$domain/1/2/3/$course/userfiles/$file in
2671: # course's home server.
2672: #
2673: # action = uploaddoc - /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
2674: # will be retrived from $env{form.uploaddoc} (from DOCS interface) to
2675: # /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
2676: # and will then be copied to /home/httpd/lonUsers/1/2/3/$course/userfiles/$file
2677: # in course's home server.
2678: #
2679:
2680: sub process_coursefile {
2681: my ($action,$docuname,$docudom,$file,$source,$parser,$allfiles,$codebase,
2682: $mimetype)=@_;
2683: my $fetchresult;
2684: my $home=&homeserver($docuname,$docudom);
2685: if ($action eq 'propagate') {
2686: $fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
2687: $home);
2688: } else {
2689: my $fpath = '';
2690: my $fname = $file;
2691: ($fpath,$fname) = ($file =~ m|^(.*)/([^/]+)$|);
2692: $fpath=$docudom.'/'.$docuname.'/'.$fpath;
2693: my $filepath = &build_filepath($fpath);
2694: if ($action eq 'copy') {
2695: if ($source eq '') {
2696: $fetchresult = 'no source file';
2697: return $fetchresult;
2698: } else {
2699: my $destination = $filepath.'/'.$fname;
2700: rename($source,$destination);
2701: $fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
2702: $home);
2703: }
2704: } elsif ($action eq 'uploaddoc') {
2705: open(my $fh,'>'.$filepath.'/'.$fname);
2706: print $fh $env{'form.'.$source};
2707: close($fh);
2708: if ($parser eq 'parse') {
2709: my $mm = new File::MMagic;
2710: my $type = $mm->checktype_filename($filepath.'/'.$fname);
2711: if ($type eq 'text/html') {
2712: my $parse_result = &extract_embedded_items($filepath.'/'.$fname,$allfiles,$codebase);
2713: unless ($parse_result eq 'ok') {
2714: &logthis('Failed to parse '.$filepath.'/'.$fname.' for embedded media: '.$parse_result);
2715: }
2716: }
2717: if (ref($mimetype)) {
2718: $$mimetype = $type;
2719: }
2720: }
2721: $fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
2722: $home);
2723: if ($fetchresult eq 'ok') {
2724: return '/uploaded/'.$fpath.'/'.$fname;
2725: } else {
2726: &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$file.
2727: ' to host '.$home.': '.$fetchresult);
2728: return '/adm/notfound.html';
2729: }
2730: }
2731: }
2732: unless ( $fetchresult eq 'ok') {
2733: &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$file.
2734: ' to host '.$home.': '.$fetchresult);
2735: }
2736: return $fetchresult;
2737: }
2738:
2739: sub build_filepath {
2740: my ($fpath) = @_;
2741: my $filepath=$perlvar{'lonDocRoot'}.'/userfiles';
2742: unless ($fpath eq '') {
2743: my @parts=split('/',$fpath);
2744: foreach my $part (@parts) {
2745: $filepath.= '/'.$part;
2746: if ((-e $filepath)!=1) {
2747: mkdir($filepath,0777);
2748: }
2749: }
2750: }
2751: return $filepath;
2752: }
2753:
2754: sub store_edited_file {
2755: my ($primary_url,$content,$docudom,$docuname,$fetchresult) = @_;
2756: my $file = $primary_url;
2757: $file =~ s#^/uploaded/$docudom/$docuname/##;
2758: my $fpath = '';
2759: my $fname = $file;
2760: ($fpath,$fname) = ($file =~ m|^(.*)/([^/]+)$|);
2761: $fpath=$docudom.'/'.$docuname.'/'.$fpath;
2762: my $filepath = &build_filepath($fpath);
2763: open(my $fh,'>'.$filepath.'/'.$fname);
2764: print $fh $content;
2765: close($fh);
2766: my $home=&homeserver($docuname,$docudom);
2767: $$fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
2768: $home);
2769: if ($$fetchresult eq 'ok') {
2770: return '/uploaded/'.$fpath.'/'.$fname;
2771: } else {
2772: &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$file.
2773: ' to host '.$home.': '.$$fetchresult);
2774: return '/adm/notfound.html';
2775: }
2776: }
2777:
2778: sub clean_filename {
2779: my ($fname,$args)=@_;
2780: # Replace Windows backslashes by forward slashes
2781: $fname=~s/\\/\//g;
2782: if (!$args->{'keep_path'}) {
2783: # Get rid of everything but the actual filename
2784: $fname=~s/^.*\/([^\/]+)$/$1/;
2785: }
2786: # Replace spaces by underscores
2787: $fname=~s/\s+/\_/g;
2788: # Replace all other weird characters by nothing
2789: $fname=~s{[^/\w\.\-]}{}g;
2790: # Replace all .\d. sequences with _\d. so they no longer look like version
2791: # numbers
2792: $fname=~s/\.(\d+)(?=\.)/_$1/g;
2793: return $fname;
2794: }
2795: # This Function checks if an Image's dimensions exceed either $resizewidth (width)
2796: # or $resizeheight (height) - both pixels. If so, the image is scaled to produce an
2797: # image with the same aspect ratio as the original, but with dimensions which do
2798: # not exceed $resizewidth and $resizeheight.
2799:
2800: sub resizeImage {
2801: my ($img_path,$resizewidth,$resizeheight) = @_;
2802: my $ima = Image::Magick->new;
2803: my $resized;
2804: if (-e $img_path) {
2805: $ima->Read($img_path);
2806: if (($resizewidth =~ /^\d+$/) && ($resizeheight > 0)) {
2807: my $width = $ima->Get('width');
2808: my $height = $ima->Get('height');
2809: if ($width > $resizewidth) {
2810: my $factor = $width/$resizewidth;
2811: my $newheight = $height/$factor;
2812: $ima->Scale(width=>$resizewidth,height=>$newheight);
2813: $resized = 1;
2814: }
2815: }
2816: if (($resizeheight =~ /^\d+$/) && ($resizeheight > 0)) {
2817: my $width = $ima->Get('width');
2818: my $height = $ima->Get('height');
2819: if ($height > $resizeheight) {
2820: my $factor = $height/$resizeheight;
2821: my $newwidth = $width/$factor;
2822: $ima->Scale(width=>$newwidth,height=>$resizeheight);
2823: $resized = 1;
2824: }
2825: }
2826: if ($resized) {
2827: $ima->Write($img_path);
2828: }
2829: }
2830: return;
2831: }
2832:
2833: # --------------- Take an uploaded file and put it into the userfiles directory
2834: # input: $formname - the contents of the file are in $env{"form.$formname"}
2835: # the desired filename is in $env{"form.$formname.filename"}
2836: # $context - possible values: coursedoc, existingfile, overwrite,
2837: # canceloverwrite, or ''.
2838: # if 'coursedoc': upload to the current course
2839: # if 'existingfile': write file to tmp/overwrites directory
2840: # if 'canceloverwrite': delete file written to tmp/overwrites directory
2841: # $context is passed as argument to &finishuserfileupload
2842: # $subdir - directory in userfile to store the file into
2843: # $parser - instruction to parse file for objects ($parser = parse)
2844: # $allfiles - reference to hash for embedded objects
2845: # $codebase - reference to hash for codebase of java objects
2846: # $desuname - username for permanent storage of uploaded file
2847: # $dsetudom - domain for permanaent storage of uploaded file
2848: # $thumbwidth - width (pixels) of thumbnail to make for uploaded image
2849: # $thumbheight - height (pixels) of thumbnail to make for uploaded image
2850: # $resizewidth - width (pixels) to which to resize uploaded image
2851: # $resizeheight - height (pixels) to which to resize uploaded image
2852: # $mimetype - reference to scalar to accommodate mime type determined
2853: # from File::MMagic.
2854: #
2855: # output: url of file in userspace, or error: <message>
2856: # or /adm/notfound.html if failure to upload occurse
2857:
2858: sub userfileupload {
2859: my ($formname,$context,$subdir,$parser,$allfiles,$codebase,$destuname,
2860: $destudom,$thumbwidth,$thumbheight,$resizewidth,$resizeheight,$mimetype)=@_;
2861: if (!defined($subdir)) { $subdir='unknown'; }
2862: my $fname=$env{'form.'.$formname.'.filename'};
2863: $fname=&clean_filename($fname);
2864: # See if there is anything left
2865: unless ($fname) { return 'error: no uploaded file'; }
2866: # Files uploaded to help request form, or uploaded to "create course" page are handled differently
2867: if ((($formname eq 'screenshot') && ($subdir eq 'helprequests')) ||
2868: (($formname eq 'coursecreatorxml') && ($subdir eq 'batchupload')) ||
2869: ($context eq 'existingfile') || ($context eq 'canceloverwrite')) {
2870: my $now = time;
2871: my $filepath;
2872: if (($formname eq 'screenshot') && ($subdir eq 'helprequests')) {
2873: $filepath = 'tmp/helprequests/'.$now;
2874: } elsif (($formname eq 'coursecreatorxml') && ($subdir eq 'batchupload')) {
2875: $filepath = 'tmp/addcourse/'.$destudom.'/web/'.$env{'user.name'}.
2876: '_'.$env{'user.domain'}.'/pending';
2877: } elsif (($context eq 'existingfile') || ($context eq 'canceloverwrite')) {
2878: my ($docuname,$docudom);
2879: if ($destudom) {
2880: $docudom = $destudom;
2881: } else {
2882: $docudom = $env{'user.domain'};
2883: }
2884: if ($destuname) {
2885: $docuname = $destuname;
2886: } else {
2887: $docuname = $env{'user.name'};
2888: }
2889: if (exists($env{'form.group'})) {
2890: $docuname=$env{'course.'.$env{'request.course.id'}.'.num'};
2891: $docudom=$env{'course.'.$env{'request.course.id'}.'.domain'};
2892: }
2893: $filepath = 'tmp/overwrites/'.$docudom.'/'.$docuname.'/'.$subdir;
2894: if ($context eq 'canceloverwrite') {
2895: my $tempfile = $perlvar{'lonDaemons'}.'/'.$filepath.'/'.$fname;
2896: if (-e $tempfile) {
2897: my @info = stat($tempfile);
2898: if ($info[9] eq $env{'form.timestamp'}) {
2899: unlink($tempfile);
2900: }
2901: }
2902: return;
2903: }
2904: }
2905: # Create the directory if not present
2906: my @parts=split(/\//,$filepath);
2907: my $fullpath = $perlvar{'lonDaemons'};
2908: for (my $i=0;$i<@parts;$i++) {
2909: $fullpath .= '/'.$parts[$i];
2910: if ((-e $fullpath)!=1) {
2911: mkdir($fullpath,0777);
2912: }
2913: }
2914: open(my $fh,'>'.$fullpath.'/'.$fname);
2915: print $fh $env{'form.'.$formname};
2916: close($fh);
2917: if ($context eq 'existingfile') {
2918: my @info = stat($fullpath.'/'.$fname);
2919: return ($fullpath.'/'.$fname,$info[9]);
2920: } else {
2921: return $fullpath.'/'.$fname;
2922: }
2923: }
2924: if ($subdir eq 'scantron') {
2925: $fname = 'scantron_orig_'.$fname;
2926: } else {
2927: $fname="$subdir/$fname";
2928: }
2929: if ($context eq 'coursedoc') {
2930: my $docuname=$env{'course.'.$env{'request.course.id'}.'.num'};
2931: my $docudom=$env{'course.'.$env{'request.course.id'}.'.domain'};
2932: if ($env{'form.folder'} =~ m/^(default|supplemental)/) {
2933: return &finishuserfileupload($docuname,$docudom,
2934: $formname,$fname,$parser,$allfiles,
2935: $codebase,$thumbwidth,$thumbheight,
2936: $resizewidth,$resizeheight,$context,$mimetype);
2937: } else {
2938: $fname=$env{'form.folder'}.'/'.$fname;
2939: return &process_coursefile('uploaddoc',$docuname,$docudom,
2940: $fname,$formname,$parser,
2941: $allfiles,$codebase,$mimetype);
2942: }
2943: } elsif (defined($destuname)) {
2944: my $docuname=$destuname;
2945: my $docudom=$destudom;
2946: return &finishuserfileupload($docuname,$docudom,$formname,$fname,
2947: $parser,$allfiles,$codebase,
2948: $thumbwidth,$thumbheight,
2949: $resizewidth,$resizeheight,$context,$mimetype);
2950: } else {
2951: my $docuname=$env{'user.name'};
2952: my $docudom=$env{'user.domain'};
2953: if (exists($env{'form.group'})) {
2954: $docuname=$env{'course.'.$env{'request.course.id'}.'.num'};
2955: $docudom=$env{'course.'.$env{'request.course.id'}.'.domain'};
2956: }
2957: return &finishuserfileupload($docuname,$docudom,$formname,$fname,
2958: $parser,$allfiles,$codebase,
2959: $thumbwidth,$thumbheight,
2960: $resizewidth,$resizeheight,$context,$mimetype);
2961: }
2962: }
2963:
2964: sub finishuserfileupload {
2965: my ($docuname,$docudom,$formname,$fname,$parser,$allfiles,$codebase,
2966: $thumbwidth,$thumbheight,$resizewidth,$resizeheight,$context,$mimetype) = @_;
2967: my $path=$docudom.'/'.$docuname.'/';
2968: my $filepath=$perlvar{'lonDocRoot'};
2969:
2970: my ($fnamepath,$file,$fetchthumb);
2971: $file=$fname;
2972: if ($fname=~m|/|) {
2973: ($fnamepath,$file) = ($fname =~ m|^(.*)/([^/]+)$|);
2974: $path.=$fnamepath.'/';
2975: }
2976: my @parts=split(/\//,$filepath.'/userfiles/'.$path);
2977: my $count;
2978: for ($count=4;$count<=$#parts;$count++) {
2979: $filepath.="/$parts[$count]";
2980: if ((-e $filepath)!=1) {
2981: mkdir($filepath,0777);
2982: }
2983: }
2984:
2985: # Save the file
2986: {
2987: if (!open(FH,'>'.$filepath.'/'.$file)) {
2988: &logthis('Failed to create '.$filepath.'/'.$file);
2989: print STDERR ('Failed to create '.$filepath.'/'.$file."\n");
2990: return '/adm/notfound.html';
2991: }
2992: if ($context eq 'overwrite') {
2993: my $source = LONCAPA::tempdir().'/overwrites/'.$docudom.'/'.$docuname.'/'.$fname;
2994: my $target = $filepath.'/'.$file;
2995: if (-e $source) {
2996: my @info = stat($source);
2997: if ($info[9] eq $env{'form.timestamp'}) {
2998: unless (&File::Copy::move($source,$target)) {
2999: &logthis('Failed to overwrite '.$filepath.'/'.$file);
3000: return "Moving from $source failed";
3001: }
3002: } else {
3003: return "Temporary file: $source had unexpected date/time for last modification";
3004: }
3005: } else {
3006: return "Temporary file: $source missing";
3007: }
3008: } elsif (!print FH ($env{'form.'.$formname})) {
3009: &logthis('Failed to write to '.$filepath.'/'.$file);
3010: print STDERR ('Failed to write to '.$filepath.'/'.$file."\n");
3011: return '/adm/notfound.html';
3012: }
3013: close(FH);
3014: if ($resizewidth && $resizeheight) {
3015: my $mm = new File::MMagic;
3016: my $mime_type = $mm->checktype_filename($filepath.'/'.$file);
3017: if ($mime_type =~ m{^image/}) {
3018: &resizeImage($filepath.'/'.$file,$resizewidth,$resizeheight);
3019: }
3020: }
3021: }
3022: if (($context eq 'coursedoc') || ($parser eq 'parse')) {
3023: if (ref($mimetype)) {
3024: if ($$mimetype eq '') {
3025: my $mm = new File::MMagic;
3026: my $type = $mm->checktype_filename($filepath.'/'.$file);
3027: $$mimetype = $type;
3028: }
3029: }
3030: }
3031: if ($parser eq 'parse') {
3032: if ((ref($mimetype)) && ($$mimetype eq 'text/html')) {
3033: my $parse_result = &extract_embedded_items($filepath.'/'.$file,
3034: $allfiles,$codebase);
3035: unless ($parse_result eq 'ok') {
3036: &logthis('Failed to parse '.$filepath.$file.
3037: ' for embedded media: '.$parse_result);
3038: }
3039: }
3040: }
3041: if (($thumbwidth =~ /^\d+$/) && ($thumbheight =~ /^\d+$/)) {
3042: my $input = $filepath.'/'.$file;
3043: my $output = $filepath.'/'.'tn-'.$file;
3044: my $thumbsize = $thumbwidth.'x'.$thumbheight;
3045: system("convert -sample $thumbsize $input $output");
3046: if (-e $filepath.'/'.'tn-'.$file) {
3047: $fetchthumb = 1;
3048: }
3049: }
3050:
3051: # Notify homeserver to grep it
3052: #
3053: my $docuhome=&homeserver($docuname,$docudom);
3054: my $fetchresult= &reply('fetchuserfile:'.$path.$file,$docuhome);
3055: if ($fetchresult eq 'ok') {
3056: if ($fetchthumb) {
3057: my $thumbresult= &reply('fetchuserfile:'.$path.'tn-'.$file,$docuhome);
3058: if ($thumbresult ne 'ok') {
3059: &logthis('Failed to transfer '.$path.'tn-'.$file.' to host '.
3060: $docuhome.': '.$thumbresult);
3061: }
3062: }
3063: #
3064: # Return the URL to it
3065: return '/uploaded/'.$path.$file;
3066: } else {
3067: &logthis('Failed to transfer '.$path.$file.' to host '.$docuhome.
3068: ': '.$fetchresult);
3069: return '/adm/notfound.html';
3070: }
3071: }
3072:
3073: sub extract_embedded_items {
3074: my ($fullpath,$allfiles,$codebase,$content) = @_;
3075: my @state = ();
3076: my (%lastids,%related,%shockwave,%flashvars);
3077: my %javafiles = (
3078: codebase => '',
3079: code => '',
3080: archive => ''
3081: );
3082: my %mediafiles = (
3083: src => '',
3084: movie => '',
3085: );
3086: my $p;
3087: if ($content) {
3088: $p = HTML::LCParser->new($content);
3089: } else {
3090: $p = HTML::LCParser->new($fullpath);
3091: }
3092: while (my $t=$p->get_token()) {
3093: if ($t->[0] eq 'S') {
3094: my ($tagname, $attr) = ($t->[1],$t->[2]);
3095: push(@state, $tagname);
3096: if (lc($tagname) eq 'allow') {
3097: &add_filetype($allfiles,$attr->{'src'},'src');
3098: }
3099: if (lc($tagname) eq 'img') {
3100: &add_filetype($allfiles,$attr->{'src'},'src');
3101: }
3102: if (lc($tagname) eq 'a') {
3103: &add_filetype($allfiles,$attr->{'href'},'href');
3104: }
3105: if (lc($tagname) eq 'script') {
3106: my $src;
3107: if ($attr->{'archive'} =~ /\.jar$/i) {
3108: &add_filetype($allfiles,$attr->{'archive'},'archive');
3109: } else {
3110: if ($attr->{'src'} ne '') {
3111: $src = $attr->{'src'};
3112: &add_filetype($allfiles,$src,'src');
3113: }
3114: }
3115: my $text = $p->get_trimmed_text();
3116: if ($text =~ /\Qswfobject.registerObject(\E([^\)]+)\)/) {
3117: my @swfargs = split(/,/,$1);
3118: foreach my $item (@swfargs) {
3119: $item =~ s/["']//g;
3120: $item =~ s/^\s+//;
3121: $item =~ s/\s+$//;
3122: }
3123: if (($swfargs[0] ne'') && ($swfargs[2] ne '')) {
3124: if (ref($related{$swfargs[0]}) eq 'ARRAY') {
3125: push(@{$related{$swfargs[0]}},$swfargs[2]);
3126: } else {
3127: $related{$swfargs[0]} = [$swfargs[2]];
3128: }
3129: }
3130: }
3131: }
3132: if (lc($tagname) eq 'link') {
3133: if (lc($attr->{'rel'}) eq 'stylesheet') {
3134: &add_filetype($allfiles,$attr->{'href'},'href');
3135: }
3136: }
3137: if (lc($tagname) eq 'object' ||
3138: (lc($tagname) eq 'embed' && lc($state[-2]) ne 'object')) {
3139: foreach my $item (keys(%javafiles)) {
3140: $javafiles{$item} = '';
3141: }
3142: if ((lc($tagname) eq 'object') && (lc($state[-2]) ne 'object')) {
3143: $lastids{lc($tagname)} = $attr->{'id'};
3144: }
3145: }
3146: if (lc($state[-2]) eq 'object' && lc($tagname) eq 'param') {
3147: my $name = lc($attr->{'name'});
3148: foreach my $item (keys(%javafiles)) {
3149: if ($name eq $item) {
3150: $javafiles{$item} = $attr->{'value'};
3151: last;
3152: }
3153: }
3154: my $pathfrom;
3155: foreach my $item (keys(%mediafiles)) {
3156: if ($name eq $item) {
3157: $pathfrom = $attr->{'value'};
3158: $shockwave{$lastids{lc($state[-2])}} = $pathfrom;
3159: &add_filetype($allfiles,$pathfrom,$name);
3160: last;
3161: }
3162: }
3163: if ($name eq 'flashvars') {
3164: $flashvars{$lastids{lc($state[-2])}} = $attr->{'value'};
3165: }
3166: if ($pathfrom ne '') {
3167: &embedded_dependency($allfiles,\%related,$lastids{lc($state[-2])},
3168: $pathfrom);
3169: }
3170: }
3171: if (lc($tagname) eq 'embed' || lc($tagname) eq 'applet') {
3172: foreach my $item (keys(%javafiles)) {
3173: if ($attr->{$item}) {
3174: $javafiles{$item} = $attr->{$item};
3175: last;
3176: }
3177: }
3178: foreach my $item (keys(%mediafiles)) {
3179: if ($attr->{$item}) {
3180: &add_filetype($allfiles,$attr->{$item},$item);
3181: last;
3182: }
3183: }
3184: if (lc($tagname) eq 'embed') {
3185: if (($attr->{'name'} ne '') && ($attr->{'src'} ne '')) {
3186: &embedded_dependency($allfiles,\%related,$attr->{'name'},
3187: $attr->{'src'});
3188: }
3189: }
3190: }
3191: if ($t->[4] =~ m{/>$}) {
3192: pop(@state);
3193: }
3194: } elsif ($t->[0] eq 'E') {
3195: my ($tagname) = ($t->[1]);
3196: if ($javafiles{'codebase'} ne '') {
3197: $javafiles{'codebase'} .= '/';
3198: }
3199: if (lc($tagname) eq 'applet' ||
3200: lc($tagname) eq 'object' ||
3201: (lc($tagname) eq 'embed' && lc($state[-2]) ne 'object')
3202: ) {
3203: foreach my $item (keys(%javafiles)) {
3204: if ($item ne 'codebase' && $javafiles{$item} ne '') {
3205: my $file=$javafiles{'codebase'}.$javafiles{$item};
3206: &add_filetype($allfiles,$file,$item);
3207: }
3208: }
3209: }
3210: pop @state;
3211: }
3212: }
3213: foreach my $id (sort(keys(%flashvars))) {
3214: if ($shockwave{$id} ne '') {
3215: my @pairs = split(/\&/,$flashvars{$id});
3216: foreach my $pair (@pairs) {
3217: my ($key,$value) = split(/\=/,$pair);
3218: if ($key eq 'thumb') {
3219: &add_filetype($allfiles,$value,$key);
3220: } elsif ($key eq 'content') {
3221: my ($path) = ($shockwave{$id} =~ m{^(.+/)[^/]+$});
3222: my ($ext) = ($value =~ /\.([^.]+)$/);
3223: if ($ext ne '') {
3224: &add_filetype($allfiles,$path.$value,$ext);
3225: }
3226: }
3227: }
3228: }
3229: }
3230: return 'ok';
3231: }
3232:
3233: sub add_filetype {
3234: my ($allfiles,$file,$type)=@_;
3235: if (exists($allfiles->{$file})) {
3236: unless (grep/^\Q$type\E$/, @{$allfiles->{$file}}) {
3237: push(@{$allfiles->{$file}}, &escape($type));
3238: }
3239: } else {
3240: @{$allfiles->{$file}} = (&escape($type));
3241: }
3242: }
3243:
3244: sub embedded_dependency {
3245: my ($allfiles,$related,$identifier,$pathfrom) = @_;
3246: if ((ref($allfiles) eq 'HASH') && (ref($related) eq 'HASH')) {
3247: if (($identifier ne '') &&
3248: (ref($related->{$identifier}) eq 'ARRAY') &&
3249: ($pathfrom ne '')) {
3250: my ($path) = ($pathfrom =~ m{^(.+/)[^/]+$});
3251: foreach my $dep (@{$related->{$identifier}}) {
3252: &add_filetype($allfiles,$path.$dep,'object');
3253: }
3254: }
3255: }
3256: return;
3257: }
3258:
3259: sub removeuploadedurl {
3260: my ($url)=@_;
3261: my (undef,undef,$udom,$uname,$fname)=split('/',$url,5);
3262: return &removeuserfile($uname,$udom,$fname);
3263: }
3264:
3265: sub removeuserfile {
3266: my ($docuname,$docudom,$fname)=@_;
3267: my $home=&homeserver($docuname,$docudom);
3268: my $result = &reply("removeuserfile:$docudom/$docuname/$fname",$home);
3269: if ($result eq 'ok') {
3270: if (($fname !~ /\.meta$/) && (&is_portfolio_file($fname))) {
3271: my $metafile = $fname.'.meta';
3272: my $metaresult = &removeuserfile($docuname,$docudom,$metafile);
3273: my $url = "/uploaded/$docudom/$docuname/$fname";
3274: my ($file,$group) = (&parse_portfolio_url($url))[3,4];
3275: my $sqlresult =
3276: &update_portfolio_table($docuname,$docudom,$file,
3277: 'portfolio_metadata',$group,
3278: 'delete');
3279: }
3280: }
3281: return $result;
3282: }
3283:
3284: sub mkdiruserfile {
3285: my ($docuname,$docudom,$dir)=@_;
3286: my $home=&homeserver($docuname,$docudom);
3287: return &reply("mkdiruserfile:".&escape("$docudom/$docuname/$dir"),$home);
3288: }
3289:
3290: sub renameuserfile {
3291: my ($docuname,$docudom,$old,$new)=@_;
3292: my $home=&homeserver($docuname,$docudom);
3293: my $result = &reply("renameuserfile:$docudom:$docuname:".
3294: &escape("$old").':'.&escape("$new"),$home);
3295: if ($result eq 'ok') {
3296: if (($old !~ /\.meta$/) && (&is_portfolio_file($old))) {
3297: my $oldmeta = $old.'.meta';
3298: my $newmeta = $new.'.meta';
3299: my $metaresult =
3300: &renameuserfile($docuname,$docudom,$oldmeta,$newmeta);
3301: my $url = "/uploaded/$docudom/$docuname/$old";
3302: my ($file,$group) = (&parse_portfolio_url($url))[3,4];
3303: my $sqlresult =
3304: &update_portfolio_table($docuname,$docudom,$file,
3305: 'portfolio_metadata',$group,
3306: 'delete');
3307: }
3308: }
3309: return $result;
3310: }
3311:
3312: # ------------------------------------------------------------------------- Log
3313:
3314: sub log {
3315: my ($dom,$nam,$hom,$what)=@_;
3316: return critical("log:$dom:$nam:$what",$hom);
3317: }
3318:
3319: # ------------------------------------------------------------------ Course Log
3320: #
3321: # This routine flushes several buffers of non-mission-critical nature
3322: #
3323:
3324: sub flushcourselogs {
3325: &logthis('Flushing log buffers');
3326: #
3327: # course logs
3328: # This is a log of all transactions in a course, which can be used
3329: # for data mining purposes
3330: #
3331: # It also collects the courseid database, which lists last transaction
3332: # times and course titles for all courseids
3333: #
3334: my %courseidbuffer=();
3335: foreach my $crsid (keys(%courselogs)) {
3336: if (&reply('log:'.$coursedombuf{$crsid}.':'.$coursenumbuf{$crsid}.':'.
3337: &escape($courselogs{$crsid}),
3338: $coursehombuf{$crsid}) eq 'ok') {
3339: delete $courselogs{$crsid};
3340: } else {
3341: &logthis('Failed to flush log buffer for '.$crsid);
3342: if (length($courselogs{$crsid})>40000) {
3343: &logthis("<font color=\"blue\">WARNING: Buffer for ".$crsid.
3344: " exceeded maximum size, deleting.</font>");
3345: delete $courselogs{$crsid};
3346: }
3347: }
3348: $courseidbuffer{$coursehombuf{$crsid}}{$crsid} = {
3349: 'description' => $coursedescrbuf{$crsid},
3350: 'inst_code' => $courseinstcodebuf{$crsid},
3351: 'type' => $coursetypebuf{$crsid},
3352: 'owner' => $courseownerbuf{$crsid},
3353: };
3354: }
3355: #
3356: # Write course id database (reverse lookup) to homeserver of courses
3357: # Is used in pickcourse
3358: #
3359: foreach my $crs_home (keys(%courseidbuffer)) {
3360: my $response = &courseidput(&host_domain($crs_home),
3361: $courseidbuffer{$crs_home},
3362: $crs_home,'timeonly');
3363: }
3364: #
3365: # File accesses
3366: # Writes to the dynamic metadata of resources to get hit counts, etc.
3367: #
3368: foreach my $entry (keys(%accesshash)) {
3369: if ($entry =~ /___count$/) {
3370: my ($dom,$name);
3371: ($dom,$name,undef)=
3372: ($entry=~m{___($match_domain)/($match_name)/(.*)___count$});
3373: if (! defined($dom) || $dom eq '' ||
3374: ! defined($name) || $name eq '') {
3375: my $cid = $env{'request.course.id'};
3376: $dom = $env{'request.'.$cid.'.domain'};
3377: $name = $env{'request.'.$cid.'.num'};
3378: }
3379: my $value = $accesshash{$entry};
3380: my (undef,$url,undef) = ($entry =~ /^(.*)___(.*)___count$/);
3381: my %temphash=($url => $value);
3382: my $result = &inc('nohist_accesscount',\%temphash,$dom,$name);
3383: if ($result eq 'ok') {
3384: delete $accesshash{$entry};
3385: }
3386: } else {
3387: my ($dom,$name) = ($entry=~m{___($match_domain)/($match_name)/(.*)___(\w+)$});
3388: if (($dom eq 'uploaded') || ($dom eq 'adm')) { next; }
3389: my %temphash=($entry => $accesshash{$entry});
3390: if (&put('nohist_resevaldata',\%temphash,$dom,$name) eq 'ok') {
3391: delete $accesshash{$entry};
3392: }
3393: }
3394: }
3395: #
3396: # Roles
3397: # Reverse lookup of user roles for course faculty/staff and co-authorship
3398: #
3399: foreach my $entry (keys(%userrolehash)) {
3400: my ($role,$uname,$udom,$runame,$rudom,$rsec)=
3401: split(/\:/,$entry);
3402: if (&Apache::lonnet::put('nohist_userroles',
3403: { $role.':'.$uname.':'.$udom.':'.$rsec => $userrolehash{$entry} },
3404: $rudom,$runame) eq 'ok') {
3405: delete $userrolehash{$entry};
3406: }
3407: }
3408: #
3409: # Reverse lookup of domain roles (dc, ad, li, sc, au)
3410: #
3411: my %domrolebuffer = ();
3412: foreach my $entry (keys(%domainrolehash)) {
3413: my ($role,$uname,$udom,$runame,$rudom,$rsec)=split(/:/,$entry);
3414: if ($domrolebuffer{$rudom}) {
3415: $domrolebuffer{$rudom}.='&'.&escape($entry).
3416: '='.&escape($domainrolehash{$entry});
3417: } else {
3418: $domrolebuffer{$rudom}.=&escape($entry).
3419: '='.&escape($domainrolehash{$entry});
3420: }
3421: delete $domainrolehash{$entry};
3422: }
3423: foreach my $dom (keys(%domrolebuffer)) {
3424: my %servers = &get_servers($dom,'library');
3425: foreach my $tryserver (keys(%servers)) {
3426: unless (&reply('domroleput:'.$dom.':'.
3427: $domrolebuffer{$dom},$tryserver) eq 'ok') {
3428: &logthis('Put of domain roles failed for '.$dom.' and '.$tryserver);
3429: }
3430: }
3431: }
3432: $dumpcount++;
3433: }
3434:
3435: sub courselog {
3436: my $what=shift;
3437: $what=time.':'.$what;
3438: unless ($env{'request.course.id'}) { return ''; }
3439: $coursedombuf{$env{'request.course.id'}}=
3440: $env{'course.'.$env{'request.course.id'}.'.domain'};
3441: $coursenumbuf{$env{'request.course.id'}}=
3442: $env{'course.'.$env{'request.course.id'}.'.num'};
3443: $coursehombuf{$env{'request.course.id'}}=
3444: $env{'course.'.$env{'request.course.id'}.'.home'};
3445: $coursedescrbuf{$env{'request.course.id'}}=
3446: $env{'course.'.$env{'request.course.id'}.'.description'};
3447: $courseinstcodebuf{$env{'request.course.id'}}=
3448: $env{'course.'.$env{'request.course.id'}.'.internal.coursecode'};
3449: $courseownerbuf{$env{'request.course.id'}}=
3450: $env{'course.'.$env{'request.course.id'}.'.internal.courseowner'};
3451: $coursetypebuf{$env{'request.course.id'}}=
3452: $env{'course.'.$env{'request.course.id'}.'.type'};
3453: if (defined $courselogs{$env{'request.course.id'}}) {
3454: $courselogs{$env{'request.course.id'}}.='&'.$what;
3455: } else {
3456: $courselogs{$env{'request.course.id'}}.=$what;
3457: }
3458: if (length($courselogs{$env{'request.course.id'}})>4048) {
3459: &flushcourselogs();
3460: }
3461: }
3462:
3463: sub courseacclog {
3464: my $fnsymb=shift;
3465: unless ($env{'request.course.id'}) { return ''; }
3466: my $what=$fnsymb.':'.$env{'user.name'}.':'.$env{'user.domain'};
3467: if ($fnsymb=~/$LONCAPA::assess_re/) {
3468: $what.=':POST';
3469: # FIXME: Probably ought to escape things....
3470: foreach my $key (keys(%env)) {
3471: if ($key=~/^form\.(.*)/) {
3472: my $formitem = $1;
3473: if ($formitem =~ /^HWFILE(?:SIZE|TOOBIG)/) {
3474: $what.=':'.$formitem.'='.$env{$key};
3475: } elsif ($formitem !~ /^HWFILE(?:[^.]+)$/) {
3476: $what.=':'.$formitem.'='.$env{$key};
3477: }
3478: }
3479: }
3480: } elsif ($fnsymb =~ m:^/adm/searchcat:) {
3481: # FIXME: We should not be depending on a form parameter that someone
3482: # editing lonsearchcat.pm might change in the future.
3483: if ($env{'form.phase'} eq 'course_search') {
3484: $what.= ':POST';
3485: # FIXME: Probably ought to escape things....
3486: foreach my $element ('courseexp','crsfulltext','crsrelated',
3487: 'crsdiscuss') {
3488: $what.=':'.$element.'='.$env{'form.'.$element};
3489: }
3490: }
3491: }
3492: &courselog($what);
3493: }
3494:
3495: sub countacc {
3496: my $url=&declutter(shift);
3497: return if (! defined($url) || $url eq '');
3498: unless ($env{'request.course.id'}) { return ''; }
3499: #
3500: # Mark that this url was used in this course
3501: #
3502: $accesshash{$env{'request.course.id'}.'___'.$url.'___course'}=1;
3503: #
3504: # Increase the access count for this resource in this child process
3505: #
3506: my $key=$$.$processmarker.'_'.$dumpcount.'___'.$url.'___count';
3507: $accesshash{$key}++;
3508: }
3509:
3510: sub linklog {
3511: my ($from,$to)=@_;
3512: $from=&declutter($from);
3513: $to=&declutter($to);
3514: $accesshash{$from.'___'.$to.'___comefrom'}=1;
3515: $accesshash{$to.'___'.$from.'___goto'}=1;
3516: }
3517:
3518: sub statslog {
3519: my ($symb,$part,$users,$av_attempts,$degdiff)=@_;
3520: if ($users<2) { return; }
3521: my %dynstore=&LONCAPA::lonmetadata::dynamic_metadata_storage({
3522: 'course' => $env{'request.course.id'},
3523: 'sections' => '"all"',
3524: 'num_students' => $users,
3525: 'part' => $part,
3526: 'symb' => $symb,
3527: 'mean_tries' => $av_attempts,
3528: 'deg_of_diff' => $degdiff});
3529: foreach my $key (keys(%dynstore)) {
3530: $accesshash{$key}=$dynstore{$key};
3531: }
3532: }
3533:
3534: sub userrolelog {
3535: my ($trole,$username,$domain,$area,$tstart,$tend)=@_;
3536: if ( $trole =~ /^(ca|aa|in|cc|ep|cr|ta|co)/ ) {
3537: my (undef,$rudom,$runame,$rsec)=split(/\//,$area);
3538: $userrolehash
3539: {$trole.':'.$username.':'.$domain.':'.$runame.':'.$rudom.':'.$rsec}
3540: =$tend.':'.$tstart;
3541: }
3542: if ($env{'request.role'} =~ /dc\./ && $trole =~ /^(au|in|cc|ep|cr|ta|co)/) {
3543: $userrolehash
3544: {$trole.':'.$username.':'.$domain.':'.$env{'user.name'}.':'.$env{'user.domain'}.':'}
3545: =$tend.':'.$tstart;
3546: }
3547: if ($trole =~ /^(dc|ad|li|au|dg|sc)/ ) {
3548: my (undef,$rudom,$runame,$rsec)=split(/\//,$area);
3549: $domainrolehash
3550: {$trole.':'.$username.':'.$domain.':'.$runame.':'.$rudom.':'.$rsec}
3551: = $tend.':'.$tstart;
3552: }
3553: }
3554:
3555: sub courserolelog {
3556: my ($trole,$username,$domain,$area,$tstart,$tend,$delflag,$selfenroll,$context)=@_;
3557: if ($area =~ m-^/($match_domain)/($match_courseid)/?([^/]*)-) {
3558: my $cdom = $1;
3559: my $cnum = $2;
3560: my $sec = $3;
3561: my $namespace = 'rolelog';
3562: my %storehash = (
3563: role => $trole,
3564: start => $tstart,
3565: end => $tend,
3566: selfenroll => $selfenroll,
3567: context => $context,
3568: );
3569: if ($trole eq 'gr') {
3570: $namespace = 'groupslog';
3571: $storehash{'group'} = $sec;
3572: } else {
3573: $storehash{'section'} = $sec;
3574: }
3575: &write_log('course',$namespace,\%storehash,$delflag,$username,
3576: $domain,$cnum,$cdom);
3577: if (($trole ne 'st') || ($sec ne '')) {
3578: &devalidate_cache_new('getcourseroles',$cdom.'_'.$cnum);
3579: }
3580: }
3581: return;
3582: }
3583:
3584: sub domainrolelog {
3585: my ($trole,$username,$domain,$area,$tstart,$tend,$delflag,$context)=@_;
3586: if ($area =~ m{^/($match_domain)/$}) {
3587: my $cdom = $1;
3588: my $domconfiguser = &Apache::lonnet::get_domainconfiguser($cdom);
3589: my $namespace = 'rolelog';
3590: my %storehash = (
3591: role => $trole,
3592: start => $tstart,
3593: end => $tend,
3594: context => $context,
3595: );
3596: &write_log('domain',$namespace,\%storehash,$delflag,$username,
3597: $domain,$domconfiguser,$cdom);
3598: }
3599: return;
3600:
3601: }
3602:
3603: sub coauthorrolelog {
3604: my ($trole,$username,$domain,$area,$tstart,$tend,$delflag,$context)=@_;
3605: if ($area =~ m{^/($match_domain)/($match_username)$}) {
3606: my $audom = $1;
3607: my $auname = $2;
3608: my $namespace = 'rolelog';
3609: my %storehash = (
3610: role => $trole,
3611: start => $tstart,
3612: end => $tend,
3613: context => $context,
3614: );
3615: &write_log('author',$namespace,\%storehash,$delflag,$username,
3616: $domain,$auname,$audom);
3617: }
3618: return;
3619: }
3620:
3621: sub get_course_adv_roles {
3622: my ($cid,$codes) = @_;
3623: $cid=$env{'request.course.id'} unless (defined($cid));
3624: my %coursehash=&coursedescription($cid);
3625: my $crstype = &Apache::loncommon::course_type($cid);
3626: my %nothide=();
3627: foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
3628: if ($user !~ /:/) {
3629: $nothide{join(':',split(/[\@]/,$user))}=1;
3630: } else {
3631: $nothide{$user}=1;
3632: }
3633: }
3634: my %returnhash=();
3635: my %dumphash=
3636: &dump('nohist_userroles',$coursehash{'domain'},$coursehash{'num'});
3637: my $now=time;
3638: my %privileged;
3639: foreach my $entry (keys(%dumphash)) {
3640: my ($tend,$tstart)=split(/\:/,$dumphash{$entry});
3641: if (($tstart) && ($tstart<0)) { next; }
3642: if (($tend) && ($tend<$now)) { next; }
3643: if (($tstart) && ($now<$tstart)) { next; }
3644: my ($role,$username,$domain,$section)=split(/\:/,$entry);
3645: if ($username eq '' || $domain eq '') { next; }
3646: unless (ref($privileged{$domain}) eq 'HASH') {
3647: my %dompersonnel =
3648: &Apache::lonnet::get_domain_roles($domain,['dc'],$now,$now);
3649: $privileged{$domain} = {};
3650: foreach my $server (keys(%dompersonnel)) {
3651: if (ref($dompersonnel{$server}) eq 'HASH') {
3652: foreach my $user (keys(%{$dompersonnel{$server}})) {
3653: my ($trole,$uname,$udom) = split(/:/,$user);
3654: $privileged{$udom}{$uname} = 1;
3655: }
3656: }
3657: }
3658: }
3659: if ((exists($privileged{$domain}{$username})) &&
3660: (!$nothide{$username.':'.$domain})) { next; }
3661: if ($role eq 'cr') { next; }
3662: if ($codes) {
3663: if ($section) { $role .= ':'.$section; }
3664: if ($returnhash{$role}) {
3665: $returnhash{$role}.=','.$username.':'.$domain;
3666: } else {
3667: $returnhash{$role}=$username.':'.$domain;
3668: }
3669: } else {
3670: my $key=&plaintext($role,$crstype);
3671: if ($section) { $key.=' ('.&Apache::lonlocal::mt('Section [_1]',$section).')'; }
3672: if ($returnhash{$key}) {
3673: $returnhash{$key}.=','.$username.':'.$domain;
3674: } else {
3675: $returnhash{$key}=$username.':'.$domain;
3676: }
3677: }
3678: }
3679: return %returnhash;
3680: }
3681:
3682: sub get_my_roles {
3683: my ($uname,$udom,$context,$types,$roles,$roledoms,$withsec,$hidepriv)=@_;
3684: unless (defined($uname)) { $uname=$env{'user.name'}; }
3685: unless (defined($udom)) { $udom=$env{'user.domain'}; }
3686: my (%dumphash,%nothide);
3687: if ($context eq 'userroles') {
3688: %dumphash = &dump('roles',$udom,$uname);
3689: } else {
3690: %dumphash=
3691: &dump('nohist_userroles',$udom,$uname);
3692: if ($hidepriv) {
3693: my %coursehash=&coursedescription($udom.'_'.$uname);
3694: foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
3695: if ($user !~ /:/) {
3696: $nothide{join(':',split(/[\@]/,$user))} = 1;
3697: } else {
3698: $nothide{$user} = 1;
3699: }
3700: }
3701: }
3702: }
3703: my %returnhash=();
3704: my $now=time;
3705: my %privileged;
3706: foreach my $entry (keys(%dumphash)) {
3707: my ($role,$tend,$tstart);
3708: if ($context eq 'userroles') {
3709: next if ($entry =~ /^rolesdef/);
3710: ($role,$tend,$tstart)=split(/_/,$dumphash{$entry});
3711: } else {
3712: ($tend,$tstart)=split(/\:/,$dumphash{$entry});
3713: }
3714: if (($tstart) && ($tstart<0)) { next; }
3715: my $status = 'active';
3716: if (($tend) && ($tend<=$now)) {
3717: $status = 'previous';
3718: }
3719: if (($tstart) && ($now<$tstart)) {
3720: $status = 'future';
3721: }
3722: if (ref($types) eq 'ARRAY') {
3723: if (!grep(/^\Q$status\E$/,@{$types})) {
3724: next;
3725: }
3726: } else {
3727: if ($status ne 'active') {
3728: next;
3729: }
3730: }
3731: my ($rolecode,$username,$domain,$section,$area);
3732: if ($context eq 'userroles') {
3733: ($area,$rolecode) = ($entry =~ /^(.+)_([^_]+)$/);
3734: (undef,$domain,$username,$section) = split(/\//,$area);
3735: } else {
3736: ($role,$username,$domain,$section) = split(/\:/,$entry);
3737: }
3738: if (ref($roledoms) eq 'ARRAY') {
3739: if (!grep(/^\Q$domain\E$/,@{$roledoms})) {
3740: next;
3741: }
3742: }
3743: if (ref($roles) eq 'ARRAY') {
3744: if (!grep(/^\Q$role\E$/,@{$roles})) {
3745: if ($role =~ /^cr\//) {
3746: if (!grep(/^cr$/,@{$roles})) {
3747: next;
3748: }
3749: } elsif ($role =~ /^gr\//) {
3750: if (!grep(/^gr$/,@{$roles})) {
3751: next;
3752: }
3753: } else {
3754: next;
3755: }
3756: }
3757: }
3758: if ($hidepriv) {
3759: if ($context eq 'userroles') {
3760: if ((&privileged($username,$domain)) &&
3761: (!$nothide{$username.':'.$domain})) {
3762: next;
3763: }
3764: } else {
3765: unless (ref($privileged{$domain}) eq 'HASH') {
3766: my %dompersonnel =
3767: &Apache::lonnet::get_domain_roles($domain,['dc'],$now,$now);
3768: $privileged{$domain} = {};
3769: if (keys(%dompersonnel)) {
3770: foreach my $server (keys(%dompersonnel)) {
3771: if (ref($dompersonnel{$server}) eq 'HASH') {
3772: foreach my $user (keys(%{$dompersonnel{$server}})) {
3773: my ($trole,$uname,$udom) = split(/:/,$user);
3774: $privileged{$udom}{$uname} = $trole;
3775: }
3776: }
3777: }
3778: }
3779: }
3780: if (exists($privileged{$domain}{$username})) {
3781: if (!$nothide{$username.':'.$domain}) {
3782: next;
3783: }
3784: }
3785: }
3786: }
3787: if ($withsec) {
3788: $returnhash{$username.':'.$domain.':'.$role.':'.$section} =
3789: $tstart.':'.$tend;
3790: } else {
3791: $returnhash{$username.':'.$domain.':'.$role}=$tstart.':'.$tend;
3792: }
3793: }
3794: return %returnhash;
3795: }
3796:
3797: # ----------------------------------------------------- Frontpage Announcements
3798: #
3799: #
3800:
3801: sub postannounce {
3802: my ($server,$text)=@_;
3803: unless (&allowed('psa',&host_domain($server))) { return 'refused'; }
3804: unless ($text=~/\w/) { $text=''; }
3805: return &reply('setannounce:'.&escape($text),$server);
3806: }
3807:
3808: sub getannounce {
3809:
3810: if (open(my $fh,$perlvar{'lonDocRoot'}.'/announcement.txt')) {
3811: my $announcement='';
3812: while (my $line = <$fh>) { $announcement .= $line; }
3813: close($fh);
3814: if ($announcement=~/\w/) {
3815: return
3816: '<table bgcolor="#FF5555" cellpadding="5" cellspacing="3">'.
3817: '<tr><td bgcolor="#FFFFFF"><tt>'.$announcement.'</tt></td></tr></table>';
3818: } else {
3819: return '';
3820: }
3821: } else {
3822: return '';
3823: }
3824: }
3825:
3826: # ---------------------------------------------------------- Course ID routines
3827: # Deal with domain's nohist_courseid.db files
3828: #
3829:
3830: sub courseidput {
3831: my ($domain,$storehash,$coursehome,$caller) = @_;
3832: return unless (ref($storehash) eq 'HASH');
3833: my $outcome;
3834: if ($caller eq 'timeonly') {
3835: my $cids = '';
3836: foreach my $item (keys(%$storehash)) {
3837: $cids.=&escape($item).'&';
3838: }
3839: $cids=~s/\&$//;
3840: $outcome = &reply('courseidputhash:'.$domain.':'.$caller.':'.$cids,
3841: $coursehome);
3842: } else {
3843: my $items = '';
3844: foreach my $item (keys(%$storehash)) {
3845: $items.= &escape($item).'='.
3846: &freeze_escape($$storehash{$item}).'&';
3847: }
3848: $items=~s/\&$//;
3849: $outcome = &reply('courseidputhash:'.$domain.':'.$caller.':'.$items,
3850: $coursehome);
3851: }
3852: if ($outcome eq 'unknown_cmd') {
3853: my $what;
3854: foreach my $cid (keys(%$storehash)) {
3855: $what .= &escape($cid).'=';
3856: foreach my $item ('description','inst_code','owner','type') {
3857: $what .= &escape($storehash->{$cid}{$item}).':';
3858: }
3859: $what =~ s/\:$/&/;
3860: }
3861: $what =~ s/\&$//;
3862: return &reply('courseidput:'.$domain.':'.$what,$coursehome);
3863: } else {
3864: return $outcome;
3865: }
3866: }
3867:
3868: sub courseiddump {
3869: my ($domfilter,$descfilter,$sincefilter,$instcodefilter,$ownerfilter,
3870: $coursefilter,$hostidflag,$hostidref,$typefilter,$regexp_ok,
3871: $selfenrollonly,$catfilter,$showhidden,$caller,$cloner,$cc_clone,
3872: $cloneonly,$createdbefore,$createdafter,$creationcontext,$domcloner)=@_;
3873: my $as_hash = 1;
3874: my %returnhash;
3875: if (!$domfilter) { $domfilter=''; }
3876: my %libserv = &all_library();
3877: foreach my $tryserver (keys(%libserv)) {
3878: if ( ( $hostidflag == 1
3879: && grep(/^\Q$tryserver\E$/,@{$hostidref}) )
3880: || (!defined($hostidflag)) ) {
3881:
3882: if (($domfilter eq '') ||
3883: (&host_domain($tryserver) eq $domfilter)) {
3884: my $rep;
3885: if (grep { $_ eq $tryserver } current_machine_ids()) {
3886: $rep = LONCAPA::Lond::dump_course_id_handler(
3887: join(":", (&host_domain($tryserver), $sincefilter,
3888: &escape($descfilter), &escape($instcodefilter),
3889: &escape($ownerfilter), &escape($coursefilter),
3890: &escape($typefilter), &escape($regexp_ok),
3891: $as_hash, &escape($selfenrollonly),
3892: &escape($catfilter), $showhidden, $caller,
3893: &escape($cloner), &escape($cc_clone), $cloneonly,
3894: &escape($createdbefore), &escape($createdafter),
3895: &escape($creationcontext), $domcloner)));
3896: } else {
3897: $rep = &reply('courseiddump:'.&host_domain($tryserver).':'.
3898: $sincefilter.':'.&escape($descfilter).':'.
3899: &escape($instcodefilter).':'.&escape($ownerfilter).
3900: ':'.&escape($coursefilter).':'.&escape($typefilter).
3901: ':'.&escape($regexp_ok).':'.$as_hash.':'.
3902: &escape($selfenrollonly).':'.&escape($catfilter).':'.
3903: $showhidden.':'.$caller.':'.&escape($cloner).':'.
3904: &escape($cc_clone).':'.$cloneonly.':'.
3905: &escape($createdbefore).':'.&escape($createdafter).':'.
3906: &escape($creationcontext).':'.$domcloner,
3907: $tryserver);
3908: }
3909:
3910: my @pairs=split(/\&/,$rep);
3911: foreach my $item (@pairs) {
3912: my ($key,$value)=split(/\=/,$item,2);
3913: $key = &unescape($key);
3914: next if ($key =~ /^error: 2 /);
3915: my $result = &thaw_unescape($value);
3916: if (ref($result) eq 'HASH') {
3917: $returnhash{$key}=$result;
3918: } else {
3919: my @responses = split(/:/,$value);
3920: my @items = ('description','inst_code','owner','type');
3921: for (my $i=0; $i<@responses; $i++) {
3922: $returnhash{$key}{$items[$i]} = &unescape($responses[$i]);
3923: }
3924: }
3925: }
3926: }
3927: }
3928: }
3929: return %returnhash;
3930: }
3931:
3932: sub courselastaccess {
3933: my ($cdom,$cnum,$hostidref) = @_;
3934: my %returnhash;
3935: if ($cdom && $cnum) {
3936: my $chome = &homeserver($cnum,$cdom);
3937: if ($chome ne 'no_host') {
3938: my $rep = &reply('courselastaccess:'.$cdom.':'.$cnum,$chome);
3939: &extract_lastaccess(\%returnhash,$rep);
3940: }
3941: } else {
3942: if (!$cdom) { $cdom=''; }
3943: my %libserv = &all_library();
3944: foreach my $tryserver (keys(%libserv)) {
3945: if (ref($hostidref) eq 'ARRAY') {
3946: next unless (grep(/^\Q$tryserver\E$/,@{$hostidref}));
3947: }
3948: if (($cdom eq '') || (&host_domain($tryserver) eq $cdom)) {
3949: my $rep = &reply('courselastaccess:'.&host_domain($tryserver).':',$tryserver);
3950: &extract_lastaccess(\%returnhash,$rep);
3951: }
3952: }
3953: }
3954: return %returnhash;
3955: }
3956:
3957: sub extract_lastaccess {
3958: my ($returnhash,$rep) = @_;
3959: if (ref($returnhash) eq 'HASH') {
3960: unless ($rep eq 'unknown_command' || $rep eq 'no_such_host' ||
3961: $rep eq 'con_lost' || $rep eq 'rejected' || $rep eq 'refused' ||
3962: $rep eq '') {
3963: my @pairs=split(/\&/,$rep);
3964: foreach my $item (@pairs) {
3965: my ($key,$value)=split(/\=/,$item,2);
3966: $key = &unescape($key);
3967: next if ($key =~ /^error: 2 /);
3968: $returnhash->{$key} = &thaw_unescape($value);
3969: }
3970: }
3971: }
3972: return;
3973: }
3974:
3975: # ---------------------------------------------------------- DC e-mail
3976:
3977: sub dcmailput {
3978: my ($domain,$msgid,$message,$server)=@_;
3979: my $status = &Apache::lonnet::critical(
3980: 'dcmailput:'.$domain.':'.&escape($msgid).'='.
3981: &escape($message),$server);
3982: return $status;
3983: }
3984:
3985: sub dcmaildump {
3986: my ($dom,$startdate,$enddate,$senders) = @_;
3987: my %returnhash=();
3988:
3989: if (defined(&domain($dom,'primary'))) {
3990: my $cmd='dcmaildump:'.$dom.':'.&escape($startdate).':'.
3991: &escape($enddate).':';
3992: my @esc_senders=map { &escape($_)} @$senders;
3993: $cmd.=&escape(join('&',@esc_senders));
3994: foreach my $line (split(/\&/,&reply($cmd,&domain($dom,'primary')))) {
3995: my ($key,$value) = split(/\=/,$line,2);
3996: if (($key) && ($value)) {
3997: $returnhash{&unescape($key)} = &unescape($value);
3998: }
3999: }
4000: }
4001: return %returnhash;
4002: }
4003: # ---------------------------------------------------------- Domain roles
4004:
4005: sub get_domain_roles {
4006: my ($dom,$roles,$startdate,$enddate)=@_;
4007: if ((!defined($startdate)) || ($startdate eq '')) {
4008: $startdate = '.';
4009: }
4010: if ((!defined($enddate)) || ($enddate eq '')) {
4011: $enddate = '.';
4012: }
4013: my $rolelist;
4014: if (ref($roles) eq 'ARRAY') {
4015: $rolelist = join(':',@{$roles});
4016: }
4017: my %personnel = ();
4018:
4019: my %servers = &get_servers($dom,'library');
4020: foreach my $tryserver (keys(%servers)) {
4021: %{$personnel{$tryserver}}=();
4022: foreach my $line (split(/\&/,&reply('domrolesdump:'.$dom.':'.
4023: &escape($startdate).':'.
4024: &escape($enddate).':'.
4025: &escape($rolelist), $tryserver))) {
4026: my ($key,$value) = split(/\=/,$line,2);
4027: if (($key) && ($value)) {
4028: $personnel{$tryserver}{&unescape($key)} = &unescape($value);
4029: }
4030: }
4031: }
4032: return %personnel;
4033: }
4034:
4035: # ----------------------------------------------------------- Interval timing
4036:
4037: {
4038: # Caches needed for speedup of navmaps
4039: # We don't want to cache this for very long at all (5 seconds at most)
4040: #
4041: # The user for whom we cache
4042: my $cachedkey='';
4043: # The cached times for this user
4044: my %cachedtimes=();
4045: # When this was last done
4046: my $cachedtime=();
4047:
4048: sub load_all_first_access {
4049: my ($uname,$udom)=@_;
4050: if (($cachedkey eq $uname.':'.$udom) &&
4051: (abs($cachedtime-time)<5) && (!$env{'form.markaccess'})) {
4052: return;
4053: }
4054: $cachedtime=time;
4055: $cachedkey=$uname.':'.$udom;
4056: %cachedtimes=&dump('firstaccesstimes',$udom,$uname);
4057: }
4058:
4059: sub get_first_access {
4060: my ($type,$argsymb,$argmap)=@_;
4061: my ($symb,$courseid,$udom,$uname)=&whichuser();
4062: if ($argsymb) { $symb=$argsymb; }
4063: my ($map,$id,$res)=&decode_symb($symb);
4064: if ($argmap) { $map = $argmap; }
4065: if ($type eq 'course') {
4066: $res='course';
4067: } elsif ($type eq 'map') {
4068: $res=&symbread($map);
4069: } else {
4070: $res=$symb;
4071: }
4072: &load_all_first_access($uname,$udom);
4073: return $cachedtimes{"$courseid\0$res"};
4074: }
4075:
4076: sub set_first_access {
4077: my ($type,$interval)=@_;
4078: my ($symb,$courseid,$udom,$uname)=&whichuser();
4079: my ($map,$id,$res)=&decode_symb($symb);
4080: if ($type eq 'course') {
4081: $res='course';
4082: } elsif ($type eq 'map') {
4083: $res=&symbread($map);
4084: } else {
4085: $res=$symb;
4086: }
4087: $cachedkey='';
4088: my $firstaccess=&get_first_access($type,$symb,$map);
4089: if (!$firstaccess) {
4090: my $start = time;
4091: my $putres = &put('firstaccesstimes',{"$courseid\0$res"=>$start},
4092: $udom,$uname);
4093: if ($putres eq 'ok') {
4094: &put('timerinterval',{"$courseid\0$res"=>$interval},
4095: $udom,$uname);
4096: &appenv(
4097: {
4098: 'course.'.$courseid.'.firstaccess.'.$res => $start,
4099: 'course.'.$courseid.'.timerinterval.'.$res => $interval,
4100: }
4101: );
4102: }
4103: return $putres;
4104: }
4105: return 'already_set';
4106: }
4107: }
4108: # --------------------------------------------- Set Expire Date for Spreadsheet
4109:
4110: sub expirespread {
4111: my ($uname,$udom,$stype,$usymb)=@_;
4112: my $cid=$env{'request.course.id'};
4113: if ($cid) {
4114: my $now=time;
4115: my $key=$uname.':'.$udom.':'.$stype.':'.$usymb;
4116: return &reply('put:'.$env{'course.'.$cid.'.domain'}.':'.
4117: $env{'course.'.$cid.'.num'}.
4118: ':nohist_expirationdates:'.
4119: &escape($key).'='.$now,
4120: $env{'course.'.$cid.'.home'})
4121: }
4122: return 'ok';
4123: }
4124:
4125: # ----------------------------------------------------- Devalidate Spreadsheets
4126:
4127: sub devalidate {
4128: my ($symb,$uname,$udom)=@_;
4129: my $cid=$env{'request.course.id'};
4130: if ($cid) {
4131: # delete the stored spreadsheets for
4132: # - the student level sheet of this user in course's homespace
4133: # - the assessment level sheet for this resource
4134: # for this user in user's homespace
4135: # - current conditional state info
4136: my $key=$uname.':'.$udom.':';
4137: my $status=
4138: &del('nohist_calculatedsheets',
4139: [$key.'studentcalc:'],
4140: $env{'course.'.$cid.'.domain'},
4141: $env{'course.'.$cid.'.num'})
4142: .' '.
4143: &del('nohist_calculatedsheets_'.$cid,
4144: [$key.'assesscalc:'.$symb],$udom,$uname);
4145: unless ($status eq 'ok ok') {
4146: &logthis('Could not devalidate spreadsheet '.
4147: $uname.' at '.$udom.' for '.
4148: $symb.': '.$status);
4149: }
4150: &delenv('user.state.'.$cid);
4151: }
4152: }
4153:
4154: sub get_scalar {
4155: my ($string,$end) = @_;
4156: my $value;
4157: if ($$string =~ s/^([^&]*?)($end)/$2/) {
4158: $value = $1;
4159: } elsif ($$string =~ s/^([^&]*?)&//) {
4160: $value = $1;
4161: }
4162: return &unescape($value);
4163: }
4164:
4165: sub array2str {
4166: my (@array) = @_;
4167: my $result=&arrayref2str(\@array);
4168: $result=~s/^__ARRAY_REF__//;
4169: $result=~s/__END_ARRAY_REF__$//;
4170: return $result;
4171: }
4172:
4173: sub arrayref2str {
4174: my ($arrayref) = @_;
4175: my $result='__ARRAY_REF__';
4176: foreach my $elem (@$arrayref) {
4177: if(ref($elem) eq 'ARRAY') {
4178: $result.=&arrayref2str($elem).'&';
4179: } elsif(ref($elem) eq 'HASH') {
4180: $result.=&hashref2str($elem).'&';
4181: } elsif(ref($elem)) {
4182: #print("Got a ref of ".(ref($elem))." skipping.");
4183: } else {
4184: $result.=&escape($elem).'&';
4185: }
4186: }
4187: $result=~s/\&$//;
4188: $result .= '__END_ARRAY_REF__';
4189: return $result;
4190: }
4191:
4192: sub hash2str {
4193: my (%hash) = @_;
4194: my $result=&hashref2str(\%hash);
4195: $result=~s/^__HASH_REF__//;
4196: $result=~s/__END_HASH_REF__$//;
4197: return $result;
4198: }
4199:
4200: sub hashref2str {
4201: my ($hashref)=@_;
4202: my $result='__HASH_REF__';
4203: foreach my $key (sort(keys(%$hashref))) {
4204: if (ref($key) eq 'ARRAY') {
4205: $result.=&arrayref2str($key).'=';
4206: } elsif (ref($key) eq 'HASH') {
4207: $result.=&hashref2str($key).'=';
4208: } elsif (ref($key)) {
4209: $result.='=';
4210: #print("Got a ref of ".(ref($key))." skipping.");
4211: } else {
4212: if (defined($key)) {$result.=&escape($key).'=';} else { last; }
4213: }
4214:
4215: if(ref($hashref->{$key}) eq 'ARRAY') {
4216: $result.=&arrayref2str($hashref->{$key}).'&';
4217: } elsif(ref($hashref->{$key}) eq 'HASH') {
4218: $result.=&hashref2str($hashref->{$key}).'&';
4219: } elsif(ref($hashref->{$key})) {
4220: $result.='&';
4221: #print("Got a ref of ".(ref($hashref->{$key}))." skipping.");
4222: } else {
4223: $result.=&escape($hashref->{$key}).'&';
4224: }
4225: }
4226: $result=~s/\&$//;
4227: $result .= '__END_HASH_REF__';
4228: return $result;
4229: }
4230:
4231: sub str2hash {
4232: my ($string)=@_;
4233: my ($hash)=&str2hashref('__HASH_REF__'.$string.'__END_HASH_REF__');
4234: return %$hash;
4235: }
4236:
4237: sub str2hashref {
4238: my ($string) = @_;
4239:
4240: my %hash;
4241:
4242: if($string !~ /^__HASH_REF__/) {
4243: if (! ($string eq '' || !defined($string))) {
4244: $hash{'error'}='Not hash reference';
4245: }
4246: return (\%hash, $string);
4247: }
4248:
4249: $string =~ s/^__HASH_REF__//;
4250:
4251: while($string !~ /^__END_HASH_REF__/) {
4252: #key
4253: my $key='';
4254: if($string =~ /^__HASH_REF__/) {
4255: ($key, $string)=&str2hashref($string);
4256: if(defined($key->{'error'})) {
4257: $hash{'error'}='Bad data';
4258: return (\%hash, $string);
4259: }
4260: } elsif($string =~ /^__ARRAY_REF__/) {
4261: ($key, $string)=&str2arrayref($string);
4262: if($key->[0] eq 'Array reference error') {
4263: $hash{'error'}='Bad data';
4264: return (\%hash, $string);
4265: }
4266: } else {
4267: $string =~ s/^(.*?)=//;
4268: $key=&unescape($1);
4269: }
4270: $string =~ s/^=//;
4271:
4272: #value
4273: my $value='';
4274: if($string =~ /^__HASH_REF__/) {
4275: ($value, $string)=&str2hashref($string);
4276: if(defined($value->{'error'})) {
4277: $hash{'error'}='Bad data';
4278: return (\%hash, $string);
4279: }
4280: } elsif($string =~ /^__ARRAY_REF__/) {
4281: ($value, $string)=&str2arrayref($string);
4282: if($value->[0] eq 'Array reference error') {
4283: $hash{'error'}='Bad data';
4284: return (\%hash, $string);
4285: }
4286: } else {
4287: $value=&get_scalar(\$string,'__END_HASH_REF__');
4288: }
4289: $string =~ s/^&//;
4290:
4291: $hash{$key}=$value;
4292: }
4293:
4294: $string =~ s/^__END_HASH_REF__//;
4295:
4296: return (\%hash, $string);
4297: }
4298:
4299: sub str2array {
4300: my ($string)=@_;
4301: my ($array)=&str2arrayref('__ARRAY_REF__'.$string.'__END_ARRAY_REF__');
4302: return @$array;
4303: }
4304:
4305: sub str2arrayref {
4306: my ($string) = @_;
4307: my @array;
4308:
4309: if($string !~ /^__ARRAY_REF__/) {
4310: if (! ($string eq '' || !defined($string))) {
4311: $array[0]='Array reference error';
4312: }
4313: return (\@array, $string);
4314: }
4315:
4316: $string =~ s/^__ARRAY_REF__//;
4317:
4318: while($string !~ /^__END_ARRAY_REF__/) {
4319: my $value='';
4320: if($string =~ /^__HASH_REF__/) {
4321: ($value, $string)=&str2hashref($string);
4322: if(defined($value->{'error'})) {
4323: $array[0] ='Array reference error';
4324: return (\@array, $string);
4325: }
4326: } elsif($string =~ /^__ARRAY_REF__/) {
4327: ($value, $string)=&str2arrayref($string);
4328: if($value->[0] eq 'Array reference error') {
4329: $array[0] ='Array reference error';
4330: return (\@array, $string);
4331: }
4332: } else {
4333: $value=&get_scalar(\$string,'__END_ARRAY_REF__');
4334: }
4335: $string =~ s/^&//;
4336:
4337: push(@array, $value);
4338: }
4339:
4340: $string =~ s/^__END_ARRAY_REF__//;
4341:
4342: return (\@array, $string);
4343: }
4344:
4345: # -------------------------------------------------------------------Temp Store
4346:
4347: sub tmpreset {
4348: my ($symb,$namespace,$domain,$stuname) = @_;
4349: if (!$symb) {
4350: $symb=&symbread();
4351: if (!$symb) { $symb= $env{'request.url'}; }
4352: }
4353: $symb=escape($symb);
4354:
4355: if (!$namespace) { $namespace=$env{'request.state'}; }
4356: $namespace=~s/\//\_/g;
4357: $namespace=~s/\W//g;
4358:
4359: if (!$domain) { $domain=$env{'user.domain'}; }
4360: if (!$stuname) { $stuname=$env{'user.name'}; }
4361: if ($domain eq 'public' && $stuname eq 'public') {
4362: $stuname=$ENV{'REMOTE_ADDR'};
4363: }
4364: my $path=LONCAPA::tempdir();
4365: my %hash;
4366: if (tie(%hash,'GDBM_File',
4367: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
4368: &GDBM_WRCREAT(),0640)) {
4369: foreach my $key (keys(%hash)) {
4370: if ($key=~ /:$symb/) {
4371: delete($hash{$key});
4372: }
4373: }
4374: }
4375: }
4376:
4377: sub tmpstore {
4378: my ($storehash,$symb,$namespace,$domain,$stuname) = @_;
4379:
4380: if (!$symb) {
4381: $symb=&symbread();
4382: if (!$symb) { $symb= $env{'request.url'}; }
4383: }
4384: $symb=escape($symb);
4385:
4386: if (!$namespace) {
4387: # I don't think we would ever want to store this for a course.
4388: # it seems this will only be used if we don't have a course.
4389: #$namespace=$env{'request.course.id'};
4390: #if (!$namespace) {
4391: $namespace=$env{'request.state'};
4392: #}
4393: }
4394: $namespace=~s/\//\_/g;
4395: $namespace=~s/\W//g;
4396: if (!$domain) { $domain=$env{'user.domain'}; }
4397: if (!$stuname) { $stuname=$env{'user.name'}; }
4398: if ($domain eq 'public' && $stuname eq 'public') {
4399: $stuname=$ENV{'REMOTE_ADDR'};
4400: }
4401: my $now=time;
4402: my %hash;
4403: my $path=LONCAPA::tempdir();
4404: if (tie(%hash,'GDBM_File',
4405: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
4406: &GDBM_WRCREAT(),0640)) {
4407: $hash{"version:$symb"}++;
4408: my $version=$hash{"version:$symb"};
4409: my $allkeys='';
4410: foreach my $key (keys(%$storehash)) {
4411: $allkeys.=$key.':';
4412: $hash{"$version:$symb:$key"}=&freeze_escape($$storehash{$key});
4413: }
4414: $hash{"$version:$symb:timestamp"}=$now;
4415: $allkeys.='timestamp';
4416: $hash{"$version:keys:$symb"}=$allkeys;
4417: if (untie(%hash)) {
4418: return 'ok';
4419: } else {
4420: return "error:$!";
4421: }
4422: } else {
4423: return "error:$!";
4424: }
4425: }
4426:
4427: # -----------------------------------------------------------------Temp Restore
4428:
4429: sub tmprestore {
4430: my ($symb,$namespace,$domain,$stuname) = @_;
4431:
4432: if (!$symb) {
4433: $symb=&symbread();
4434: if (!$symb) { $symb= $env{'request.url'}; }
4435: }
4436: $symb=escape($symb);
4437:
4438: if (!$namespace) { $namespace=$env{'request.state'}; }
4439:
4440: if (!$domain) { $domain=$env{'user.domain'}; }
4441: if (!$stuname) { $stuname=$env{'user.name'}; }
4442: if ($domain eq 'public' && $stuname eq 'public') {
4443: $stuname=$ENV{'REMOTE_ADDR'};
4444: }
4445: my %returnhash;
4446: $namespace=~s/\//\_/g;
4447: $namespace=~s/\W//g;
4448: my %hash;
4449: my $path=LONCAPA::tempdir();
4450: if (tie(%hash,'GDBM_File',
4451: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
4452: &GDBM_READER(),0640)) {
4453: my $version=$hash{"version:$symb"};
4454: $returnhash{'version'}=$version;
4455: my $scope;
4456: for ($scope=1;$scope<=$version;$scope++) {
4457: my $vkeys=$hash{"$scope:keys:$symb"};
4458: my @keys=split(/:/,$vkeys);
4459: my $key;
4460: $returnhash{"$scope:keys"}=$vkeys;
4461: foreach $key (@keys) {
4462: $returnhash{"$scope:$key"}=&thaw_unescape($hash{"$scope:$symb:$key"});
4463: $returnhash{"$key"}=&thaw_unescape($hash{"$scope:$symb:$key"});
4464: }
4465: }
4466: if (!(untie(%hash))) {
4467: return "error:$!";
4468: }
4469: } else {
4470: return "error:$!";
4471: }
4472: return %returnhash;
4473: }
4474:
4475: # ----------------------------------------------------------------------- Store
4476:
4477: sub store {
4478: my ($storehash,$symb,$namespace,$domain,$stuname) = @_;
4479: my $home='';
4480:
4481: if ($stuname) { $home=&homeserver($stuname,$domain); }
4482:
4483: $symb=&symbclean($symb);
4484: if (!$symb) { unless ($symb=&symbread()) { return ''; } }
4485:
4486: if (!$domain) { $domain=$env{'user.domain'}; }
4487: if (!$stuname) { $stuname=$env{'user.name'}; }
4488:
4489: &devalidate($symb,$stuname,$domain);
4490:
4491: $symb=escape($symb);
4492: if (!$namespace) {
4493: unless ($namespace=$env{'request.course.id'}) {
4494: return '';
4495: }
4496: }
4497: if (!$home) { $home=$env{'user.home'}; }
4498:
4499: $$storehash{'ip'}=$ENV{'REMOTE_ADDR'};
4500: $$storehash{'host'}=$perlvar{'lonHostID'};
4501:
4502: my $namevalue='';
4503: foreach my $key (keys(%$storehash)) {
4504: $namevalue.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
4505: }
4506: $namevalue=~s/\&$//;
4507: &courselog($symb.':'.$stuname.':'.$domain.':STORE:'.$namevalue);
4508: return reply("store:$domain:$stuname:$namespace:$symb:$namevalue","$home");
4509: }
4510:
4511: # -------------------------------------------------------------- Critical Store
4512:
4513: sub cstore {
4514: my ($storehash,$symb,$namespace,$domain,$stuname) = @_;
4515: my $home='';
4516:
4517: if ($stuname) { $home=&homeserver($stuname,$domain); }
4518:
4519: $symb=&symbclean($symb);
4520: if (!$symb) { unless ($symb=&symbread()) { return ''; } }
4521:
4522: if (!$domain) { $domain=$env{'user.domain'}; }
4523: if (!$stuname) { $stuname=$env{'user.name'}; }
4524:
4525: &devalidate($symb,$stuname,$domain);
4526:
4527: $symb=escape($symb);
4528: if (!$namespace) {
4529: unless ($namespace=$env{'request.course.id'}) {
4530: return '';
4531: }
4532: }
4533: if (!$home) { $home=$env{'user.home'}; }
4534:
4535: $$storehash{'ip'}=$ENV{'REMOTE_ADDR'};
4536: $$storehash{'host'}=$perlvar{'lonHostID'};
4537:
4538: my $namevalue='';
4539: foreach my $key (keys(%$storehash)) {
4540: $namevalue.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
4541: }
4542: $namevalue=~s/\&$//;
4543: &courselog($symb.':'.$stuname.':'.$domain.':CSTORE:'.$namevalue);
4544: return critical
4545: ("store:$domain:$stuname:$namespace:$symb:$namevalue","$home");
4546: }
4547:
4548: # --------------------------------------------------------------------- Restore
4549:
4550: sub restore {
4551: my ($symb,$namespace,$domain,$stuname) = @_;
4552: my $home='';
4553:
4554: if ($stuname) { $home=&homeserver($stuname,$domain); }
4555:
4556: if (!$symb) {
4557: unless ($symb=escape(&symbread())) { return ''; }
4558: } else {
4559: $symb=&escape(&symbclean($symb));
4560: }
4561: if (!$namespace) {
4562: unless ($namespace=$env{'request.course.id'}) {
4563: return '';
4564: }
4565: }
4566: if (!$domain) { $domain=$env{'user.domain'}; }
4567: if (!$stuname) { $stuname=$env{'user.name'}; }
4568: if (!$home) { $home=$env{'user.home'}; }
4569: my $answer=&reply("restore:$domain:$stuname:$namespace:$symb","$home");
4570:
4571: my %returnhash=();
4572: foreach my $line (split(/\&/,$answer)) {
4573: my ($name,$value)=split(/\=/,$line);
4574: $returnhash{&unescape($name)}=&thaw_unescape($value);
4575: }
4576: my $version;
4577: for ($version=1;$version<=$returnhash{'version'};$version++) {
4578: foreach my $item (split(/\:/,$returnhash{$version.':keys'})) {
4579: $returnhash{$item}=$returnhash{$version.':'.$item};
4580: }
4581: }
4582: return %returnhash;
4583: }
4584:
4585: # ---------------------------------------------------------- Course Description
4586: #
4587: #
4588:
4589: sub coursedescription {
4590: my ($courseid,$args)=@_;
4591: $courseid=~s/^\///;
4592: $courseid=~s/\_/\//g;
4593: my ($cdomain,$cnum)=split(/\//,$courseid);
4594: my $chome=&homeserver($cnum,$cdomain);
4595: my $normalid=$cdomain.'_'.$cnum;
4596: # need to always cache even if we get errors otherwise we keep
4597: # trying and trying and trying to get the course description.
4598: my %envhash=();
4599: my %returnhash=();
4600:
4601: my $expiretime=600;
4602: if ($env{'request.course.id'} eq $normalid) {
4603: $expiretime=120;
4604: }
4605:
4606: my $prefix='course.'.$cdomain.'_'.$cnum.'.';
4607: if (!$args->{'freshen_cache'}
4608: && ((time-$env{$prefix.'last_cache'}) < $expiretime) ) {
4609: foreach my $key (keys(%env)) {
4610: next if ($key !~ /^\Q$prefix\E(.*)/);
4611: my ($setting) = $1;
4612: $returnhash{$setting} = $env{$key};
4613: }
4614: return %returnhash;
4615: }
4616:
4617: # get the data again
4618:
4619: if (!$args->{'one_time'}) {
4620: $envhash{'course.'.$normalid.'.last_cache'}=time;
4621: }
4622:
4623: if ($chome ne 'no_host') {
4624: %returnhash=&dump('environment',$cdomain,$cnum);
4625: if (!exists($returnhash{'con_lost'})) {
4626: my $username = $env{'user.name'}; # Defult username
4627: if(defined $args->{'user'}) {
4628: $username = $args->{'user'};
4629: }
4630: $returnhash{'home'}= $chome;
4631: $returnhash{'domain'} = $cdomain;
4632: $returnhash{'num'} = $cnum;
4633: if (!defined($returnhash{'type'})) {
4634: $returnhash{'type'} = 'Course';
4635: }
4636: while (my ($name,$value) = each %returnhash) {
4637: $envhash{'course.'.$normalid.'.'.$name}=$value;
4638: }
4639: $returnhash{'url'}=&clutter($returnhash{'url'});
4640: $returnhash{'fn'}=LONCAPA::tempdir() .
4641: $username.'_'.$cdomain.'_'.$cnum;
4642: $envhash{'course.'.$normalid.'.home'}=$chome;
4643: $envhash{'course.'.$normalid.'.domain'}=$cdomain;
4644: $envhash{'course.'.$normalid.'.num'}=$cnum;
4645: }
4646: }
4647: if (!$args->{'one_time'}) {
4648: &appenv(\%envhash);
4649: }
4650: return %returnhash;
4651: }
4652:
4653: sub update_released_required {
4654: my ($needsrelease,$cdom,$cnum,$chome,$cid) = @_;
4655: if ($cdom eq '' || $cnum eq '' || $chome eq '' || $cid eq '') {
4656: $cid = $env{'request.course.id'};
4657: $cdom = $env{'course.'.$cid.'.domain'};
4658: $cnum = $env{'course.'.$cid.'.num'};
4659: $chome = $env{'course.'.$cid.'.home'};
4660: }
4661: if ($needsrelease) {
4662: my %curr_reqd_hash = &userenvironment($cdom,$cnum,'internal.releaserequired');
4663: my $needsupdate;
4664: if ($curr_reqd_hash{'internal.releaserequired'} eq '') {
4665: $needsupdate = 1;
4666: } else {
4667: my ($currmajor,$currminor) = split(/\./,$curr_reqd_hash{'internal.releaserequired'});
4668: my ($needsmajor,$needsminor) = split(/\./,$needsrelease);
4669: if (($currmajor < $needsmajor) || ($currmajor == $needsmajor && $currminor < $needsminor)) {
4670: $needsupdate = 1;
4671: }
4672: }
4673: if ($needsupdate) {
4674: my %needshash = (
4675: 'internal.releaserequired' => $needsrelease,
4676: );
4677: my $putresult = &put('environment',\%needshash,$cdom,$cnum);
4678: if ($putresult eq 'ok') {
4679: &appenv({'course.'.$cid.'.internal.releaserequired' => $needsrelease});
4680: my %crsinfo = &courseiddump($cdom,'.',1,'.','.',$cnum,undef,undef,'.');
4681: if (ref($crsinfo{$cid}) eq 'HASH') {
4682: $crsinfo{$cid}{'releaserequired'} = $needsrelease;
4683: &courseidput($cdom,\%crsinfo,$chome,'notime');
4684: }
4685: }
4686: }
4687: }
4688: return;
4689: }
4690:
4691: # -------------------------------------------------See if a user is privileged
4692:
4693: sub privileged {
4694: my ($username,$domain)=@_;
4695:
4696: my %rolesdump = &dump("roles", $domain, $username) or return 0;
4697: my $now = time;
4698:
4699: for my $role (@rolesdump{grep { ! /^rolesdef_/ } keys %rolesdump}) {
4700: my ($trole, $tend, $tstart) = split(/_/, $role);
4701: if (($trole eq 'dc') || ($trole eq 'su')) {
4702: return 1 unless ($tend && $tend < $now)
4703: or ($tstart && $tstart > $now);
4704: }
4705: }
4706:
4707: return 0;
4708: }
4709:
4710: # -------------------------------------------------------- Get user privileges
4711:
4712: sub rolesinit {
4713: my ($domain, $username) = @_;
4714: my %userroles = ('user.login.time' => time);
4715: my %rolesdump = &dump("roles", $domain, $username) or return \%userroles;
4716:
4717: # firstaccess and timerinterval are related to timed maps/resources.
4718: # also, blocking can be triggered by an activating timer
4719: # it's saved in the user's %env.
4720: my %firstaccess = &dump('firstaccesstimes', $domain, $username);
4721: my %timerinterval = &dump('timerinterval', $domain, $username);
4722: my (%coursetimerstarts, %firstaccchk, %firstaccenv, %coursetimerintervals,
4723: %timerintchk, %timerintenv);
4724:
4725: foreach my $key (keys(%firstaccess)) {
4726: my ($cid, $rest) = split(/\0/, $key);
4727: $coursetimerstarts{$cid}{$rest} = $firstaccess{$key};
4728: }
4729:
4730: foreach my $key (keys(%timerinterval)) {
4731: my ($cid,$rest) = split(/\0/,$key);
4732: $coursetimerintervals{$cid}{$rest} = $timerinterval{$key};
4733: }
4734:
4735: my %allroles=();
4736: my %allgroups=();
4737:
4738: for my $area (grep { ! /^rolesdef_/ } keys %rolesdump) {
4739: my $role = $rolesdump{$area};
4740: $area =~ s/\_\w\w$//;
4741:
4742: my ($trole, $tend, $tstart, $group_privs);
4743:
4744: if ($role =~ /^cr/) {
4745: # Custom role, defined by a user
4746: # e.g., user.role.cr/msu/smith/mynewrole
4747: if ($role =~ m|^(cr/$match_domain/$match_username/[a-zA-Z0-9]+)_(.*)$|) {
4748: $trole = $1;
4749: ($tend, $tstart) = split('_', $2);
4750: } else {
4751: $trole = $role;
4752: }
4753: } elsif ($role =~ m|^gr/|) {
4754: # Role of member in a group, defined within a course/community
4755: # e.g., user.role.gr/msu/04935610a19ee4a5fmsul1/leopards
4756: ($trole, $tend, $tstart) = split(/_/, $role);
4757: next if $tstart eq '-1';
4758: ($trole, $group_privs) = split(/\//, $trole);
4759: $group_privs = &unescape($group_privs);
4760: } else {
4761: # Just a normal role, defined in roles.tab
4762: ($trole, $tend, $tstart) = split(/_/,$role);
4763: }
4764:
4765: my %new_role = &set_arearole($trole,$area,$tstart,$tend,$domain,
4766: $username);
4767: @userroles{keys(%new_role)} = @new_role{keys(%new_role)};
4768:
4769: # role expired or not available yet?
4770: $trole = '' if ($tend != 0 && $tend < $userroles{'user.login.time'}) or
4771: ($tstart != 0 && $tstart > $userroles{'user.login.time'});
4772:
4773: next if $area eq '' or $trole eq '';
4774:
4775: my $spec = "$trole.$area";
4776: my ($tdummy, $tdomain, $trest) = split(/\//, $area);
4777:
4778: if ($trole =~ /^cr\//) {
4779: # Custom role, defined by a user
4780: &custom_roleprivs(\%allroles,$trole,$tdomain,$trest,$spec,$area);
4781: } elsif ($trole eq 'gr') {
4782: # Role of a member in a group, defined within a course/community
4783: &group_roleprivs(\%allgroups,$area,$group_privs,$tend,$tstart);
4784: next;
4785: } else {
4786: # Normal role, defined in roles.tab
4787: &standard_roleprivs(\%allroles,$trole,$tdomain,$spec,$trest,$area);
4788: }
4789:
4790: my $cid = $tdomain.'_'.$trest;
4791: unless ($firstaccchk{$cid}) {
4792: if (ref($coursetimerstarts{$cid}) eq 'HASH') {
4793: foreach my $item (keys(%{$coursetimerstarts{$cid}})) {
4794: $firstaccenv{'course.'.$cid.'.firstaccess.'.$item} =
4795: $coursetimerstarts{$cid}{$item};
4796: }
4797: }
4798: $firstaccchk{$cid} = 1;
4799: }
4800: unless ($timerintchk{$cid}) {
4801: if (ref($coursetimerintervals{$cid}) eq 'HASH') {
4802: foreach my $item (keys(%{$coursetimerintervals{$cid}})) {
4803: $timerintenv{'course.'.$cid.'.timerinterval.'.$item} =
4804: $coursetimerintervals{$cid}{$item};
4805: }
4806: }
4807: $timerintchk{$cid} = 1;
4808: }
4809: }
4810:
4811: @userroles{'user.author', 'user.adv'} = &set_userprivs(\%userroles,
4812: \%allroles, \%allgroups);
4813: $env{'user.adv'} = $userroles{'user.adv'};
4814:
4815: return (\%userroles,\%firstaccenv,\%timerintenv);
4816: }
4817:
4818: sub set_arearole {
4819: my ($trole,$area,$tstart,$tend,$domain,$username) = @_;
4820: # log the associated role with the area
4821: &userrolelog($trole,$username,$domain,$area,$tstart,$tend);
4822: return ('user.role.'.$trole.'.'.$area => $tstart.'.'.$tend);
4823: }
4824:
4825: sub custom_roleprivs {
4826: my ($allroles,$trole,$tdomain,$trest,$spec,$area) = @_;
4827: my ($rdummy,$rdomain,$rauthor,$rrole)=split(/\//,$trole);
4828: my $homsvr=homeserver($rauthor,$rdomain);
4829: if (&hostname($homsvr) ne '') {
4830: my ($rdummy,$roledef)=
4831: &get('roles',["rolesdef_$rrole"],$rdomain,$rauthor);
4832: if (($rdummy ne 'con_lost') && ($roledef ne '')) {
4833: my ($syspriv,$dompriv,$coursepriv)=split(/\_/,$roledef);
4834: if (defined($syspriv)) {
4835: if ($trest =~ /^$match_community$/) {
4836: $syspriv =~ s/bre\&S//;
4837: }
4838: $$allroles{'cm./'}.=':'.$syspriv;
4839: $$allroles{$spec.'./'}.=':'.$syspriv;
4840: }
4841: if ($tdomain ne '') {
4842: if (defined($dompriv)) {
4843: $$allroles{'cm./'.$tdomain.'/'}.=':'.$dompriv;
4844: $$allroles{$spec.'./'.$tdomain.'/'}.=':'.$dompriv;
4845: }
4846: if (($trest ne '') && (defined($coursepriv))) {
4847: $$allroles{'cm.'.$area}.=':'.$coursepriv;
4848: $$allroles{$spec.'.'.$area}.=':'.$coursepriv;
4849: }
4850: }
4851: }
4852: }
4853: }
4854:
4855: sub group_roleprivs {
4856: my ($allgroups,$area,$group_privs,$tend,$tstart) = @_;
4857: my $access = 1;
4858: my $now = time;
4859: if (($tend!=0) && ($tend<$now)) { $access = 0; }
4860: if (($tstart!=0) && ($tstart>$now)) { $access=0; }
4861: if ($access) {
4862: my ($course,$group) = ($area =~ m|(/$match_domain/$match_courseid)/([^/]+)$|);
4863: $$allgroups{$course}{$group} .=':'.$group_privs;
4864: }
4865: }
4866:
4867: sub standard_roleprivs {
4868: my ($allroles,$trole,$tdomain,$spec,$trest,$area) = @_;
4869: if (defined($pr{$trole.':s'})) {
4870: $$allroles{'cm./'}.=':'.$pr{$trole.':s'};
4871: $$allroles{$spec.'./'}.=':'.$pr{$trole.':s'};
4872: }
4873: if ($tdomain ne '') {
4874: if (defined($pr{$trole.':d'})) {
4875: $$allroles{'cm./'.$tdomain.'/'}.=':'.$pr{$trole.':d'};
4876: $$allroles{$spec.'./'.$tdomain.'/'}.=':'.$pr{$trole.':d'};
4877: }
4878: if (($trest ne '') && (defined($pr{$trole.':c'}))) {
4879: $$allroles{'cm.'.$area}.=':'.$pr{$trole.':c'};
4880: $$allroles{$spec.'.'.$area}.=':'.$pr{$trole.':c'};
4881: }
4882: }
4883: }
4884:
4885: sub set_userprivs {
4886: my ($userroles,$allroles,$allgroups,$groups_roles) = @_;
4887: my $author=0;
4888: my $adv=0;
4889: my %grouproles = ();
4890: if (keys(%{$allgroups}) > 0) {
4891: my @groupkeys;
4892: foreach my $role (keys(%{$allroles})) {
4893: push(@groupkeys,$role);
4894: }
4895: if (ref($groups_roles) eq 'HASH') {
4896: foreach my $key (keys(%{$groups_roles})) {
4897: unless (grep(/^\Q$key\E$/,@groupkeys)) {
4898: push(@groupkeys,$key);
4899: }
4900: }
4901: }
4902: if (@groupkeys > 0) {
4903: foreach my $role (@groupkeys) {
4904: my ($trole,$area,$sec,$extendedarea);
4905: if ($role =~ m-^(\w+|cr/$match_domain/$match_username/\w+)\.(/$match_domain/$match_courseid)(/?\w*)\.-) {
4906: $trole = $1;
4907: $area = $2;
4908: $sec = $3;
4909: $extendedarea = $area.$sec;
4910: if (exists($$allgroups{$area})) {
4911: foreach my $group (keys(%{$$allgroups{$area}})) {
4912: my $spec = $trole.'.'.$extendedarea;
4913: $grouproles{$spec.'.'.$area.'/'.$group} =
4914: $$allgroups{$area}{$group};
4915: }
4916: }
4917: }
4918: }
4919: }
4920: }
4921: foreach my $group (keys(%grouproles)) {
4922: $$allroles{$group} = $grouproles{$group};
4923: }
4924: foreach my $role (keys(%{$allroles})) {
4925: my %thesepriv;
4926: if (($role=~/^au/) || ($role=~/^ca/) || ($role=~/^aa/)) { $author=1; }
4927: foreach my $item (split(/:/,$$allroles{$role})) {
4928: if ($item ne '') {
4929: my ($privilege,$restrictions)=split(/&/,$item);
4930: if ($restrictions eq '') {
4931: $thesepriv{$privilege}='F';
4932: } elsif ($thesepriv{$privilege} ne 'F') {
4933: $thesepriv{$privilege}.=$restrictions;
4934: }
4935: if ($thesepriv{'adv'} eq 'F') { $adv=1; }
4936: }
4937: }
4938: my $thesestr='';
4939: foreach my $priv (sort(keys(%thesepriv))) {
4940: $thesestr.=':'.$priv.'&'.$thesepriv{$priv};
4941: }
4942: $userroles->{'user.priv.'.$role} = $thesestr;
4943: }
4944: return ($author,$adv);
4945: }
4946:
4947: sub role_status {
4948: my ($rolekey,$update,$refresh,$now,$role,$where,$trolecode,$tstatus,$tstart,$tend) = @_;
4949: my @pwhere = ();
4950: if (exists($env{$rolekey}) && $env{$rolekey} ne '') {
4951: (undef,undef,$$role,@pwhere)=split(/\./,$rolekey);
4952: unless (!defined($$role) || $$role eq '') {
4953: $$where=join('.',@pwhere);
4954: $$trolecode=$$role.'.'.$$where;
4955: ($$tstart,$$tend)=split(/\./,$env{$rolekey});
4956: $$tstatus='is';
4957: if ($$tstart && $$tstart>$update) {
4958: $$tstatus='future';
4959: if ($$tstart<$now) {
4960: if ($$tstart && $$tstart>$refresh) {
4961: if (($$where ne '') && ($$role ne '')) {
4962: my (%allroles,%allgroups,$group_privs,
4963: %groups_roles,@rolecodes);
4964: my %userroles = (
4965: 'user.role.'.$$role.'.'.$$where => $$tstart.'.'.$$tend
4966: );
4967: @rolecodes = ('cm');
4968: my $spec=$$role.'.'.$$where;
4969: my ($tdummy,$tdomain,$trest)=split(/\//,$$where);
4970: if ($$role =~ /^cr\//) {
4971: &custom_roleprivs(\%allroles,$$role,$tdomain,$trest,$spec,$$where);
4972: push(@rolecodes,'cr');
4973: } elsif ($$role eq 'gr') {
4974: push(@rolecodes,$$role);
4975: my %rolehash = &get('roles',[$$where.'_'.$$role],$env{'user.domain'},
4976: $env{'user.name'});
4977: my ($trole) = split('_',$rolehash{$$where.'_'.$$role},2);
4978: (undef,my $group_privs) = split(/\//,$trole);
4979: $group_privs = &unescape($group_privs);
4980: &group_roleprivs(\%allgroups,$$where,$group_privs,$$tend,$$tstart);
4981: my %course_roles = &get_my_roles($env{'user.name'},$env{'user.domain'},'userroles',['active'],['cc','co','in','ta','ep','ad','st','cr'],[$tdomain],1);
4982: &get_groups_roles($tdomain,$trest,
4983: \%course_roles,\@rolecodes,
4984: \%groups_roles);
4985: } else {
4986: push(@rolecodes,$$role);
4987: &standard_roleprivs(\%allroles,$$role,$tdomain,$spec,$trest,$$where);
4988: }
4989: my ($author,$adv)= &set_userprivs(\%userroles,\%allroles,\%allgroups,\%groups_roles);
4990: &appenv(\%userroles,\@rolecodes);
4991: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},"Role ".$role);
4992: }
4993: }
4994: $$tstatus = 'is';
4995: }
4996: }
4997: if ($$tend) {
4998: if ($$tend<$update) {
4999: $$tstatus='expired';
5000: } elsif ($$tend<$now) {
5001: $$tstatus='will_not';
5002: }
5003: }
5004: }
5005: }
5006: }
5007:
5008: sub get_groups_roles {
5009: my ($cdom,$rest,$cdom_courseroles,$rolecodes,$groups_roles) = @_;
5010: return unless((ref($cdom_courseroles) eq 'HASH') &&
5011: (ref($rolecodes) eq 'ARRAY') &&
5012: (ref($groups_roles) eq 'HASH'));
5013: if (keys(%{$cdom_courseroles}) > 0) {
5014: my ($cnum) = ($rest =~ /^($match_courseid)/);
5015: if ($cdom ne '' && $cnum ne '') {
5016: foreach my $key (keys(%{$cdom_courseroles})) {
5017: if ($key =~ /^\Q$cnum\E:\Q$cdom\E:([^:]+):?([^:]*)/) {
5018: my $crsrole = $1;
5019: my $crssec = $2;
5020: if ($crsrole =~ /^cr/) {
5021: unless (grep(/^cr$/,@{$rolecodes})) {
5022: push(@{$rolecodes},'cr');
5023: }
5024: } else {
5025: unless(grep(/^\Q$crsrole\E$/,@{$rolecodes})) {
5026: push(@{$rolecodes},$crsrole);
5027: }
5028: }
5029: my $rolekey = "$crsrole./$cdom/$cnum";
5030: if ($crssec ne '') {
5031: $rolekey .= "/$crssec";
5032: }
5033: $rolekey .= './';
5034: $groups_roles->{$rolekey} = $rolecodes;
5035: }
5036: }
5037: }
5038: }
5039: return;
5040: }
5041:
5042: sub delete_env_groupprivs {
5043: my ($where,$courseroles,$possroles) = @_;
5044: return unless((ref($courseroles) eq 'HASH') && (ref($possroles) eq 'ARRAY'));
5045: my ($dummy,$udom,$uname,$group) = split(/\//,$where);
5046: unless (ref($courseroles->{$udom}) eq 'HASH') {
5047: %{$courseroles->{$udom}} =
5048: &get_my_roles('','','userroles',['active'],
5049: $possroles,[$udom],1);
5050: }
5051: if (ref($courseroles->{$udom}) eq 'HASH') {
5052: foreach my $item (keys(%{$courseroles->{$udom}})) {
5053: my ($cnum,$cdom,$crsrole,$crssec) = split(/:/,$item);
5054: my $area = '/'.$cdom.'/'.$cnum;
5055: my $privkey = "user.priv.$crsrole.$area";
5056: if ($crssec ne '') {
5057: $privkey .= '/'.$crssec;
5058: }
5059: $privkey .= ".$area/$group";
5060: &Apache::lonnet::delenv($privkey,undef,[$crsrole]);
5061: }
5062: }
5063: return;
5064: }
5065:
5066: sub check_adhoc_privs {
5067: my ($cdom,$cnum,$update,$refresh,$now,$checkrole,$caller) = @_;
5068: my $cckey = 'user.role.'.$checkrole.'./'.$cdom.'/'.$cnum;
5069: my $setprivs;
5070: if ($env{$cckey}) {
5071: my ($role,$where,$trolecode,$tstart,$tend,$tremark,$tstatus,$tpstart,$tpend);
5072: &role_status($cckey,$update,$refresh,$now,\$role,\$where,\$trolecode,\$tstatus,\$tstart,\$tend);
5073: unless (($tstatus eq 'is') || ($tstatus eq 'will_not')) {
5074: &set_adhoc_privileges($cdom,$cnum,$checkrole,$caller);
5075: $setprivs = 1;
5076: }
5077: } else {
5078: &set_adhoc_privileges($cdom,$cnum,$checkrole,$caller);
5079: $setprivs = 1;
5080: }
5081: return $setprivs;
5082: }
5083:
5084: sub set_adhoc_privileges {
5085: # role can be cc or ca
5086: my ($dcdom,$pickedcourse,$role,$caller) = @_;
5087: my $area = '/'.$dcdom.'/'.$pickedcourse;
5088: my $spec = $role.'.'.$area;
5089: my %userroles = &set_arearole($role,$area,'','',$env{'user.domain'},
5090: $env{'user.name'});
5091: my %ccrole = ();
5092: &standard_roleprivs(\%ccrole,$role,$dcdom,$spec,$pickedcourse,$area);
5093: my ($author,$adv)= &set_userprivs(\%userroles,\%ccrole);
5094: &appenv(\%userroles,[$role,'cm']);
5095: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},"Role ".$role);
5096: unless ($caller eq 'constructaccess' && $env{'request.course.id'}) {
5097: &appenv( {'request.role' => $spec,
5098: 'request.role.domain' => $dcdom,
5099: 'request.course.sec' => ''
5100: }
5101: );
5102: my $tadv=0;
5103: if (&allowed('adv') eq 'F') { $tadv=1; }
5104: &appenv({'request.role.adv' => $tadv});
5105: }
5106: }
5107:
5108: # --------------------------------------------------------------- get interface
5109:
5110: sub get {
5111: my ($namespace,$storearr,$udomain,$uname)=@_;
5112: my $items='';
5113: foreach my $item (@$storearr) {
5114: $items.=&escape($item).'&';
5115: }
5116: $items=~s/\&$//;
5117: if (!$udomain) { $udomain=$env{'user.domain'}; }
5118: if (!$uname) { $uname=$env{'user.name'}; }
5119: my $uhome=&homeserver($uname,$udomain);
5120:
5121: my $rep=&reply("get:$udomain:$uname:$namespace:$items",$uhome);
5122: my @pairs=split(/\&/,$rep);
5123: if ( $#pairs==0 && $pairs[0] =~ /^(con_lost|error|no_such_host)/i) {
5124: return @pairs;
5125: }
5126: my %returnhash=();
5127: my $i=0;
5128: foreach my $item (@$storearr) {
5129: $returnhash{$item}=&thaw_unescape($pairs[$i]);
5130: $i++;
5131: }
5132: return %returnhash;
5133: }
5134:
5135: # --------------------------------------------------------------- del interface
5136:
5137: sub del {
5138: my ($namespace,$storearr,$udomain,$uname)=@_;
5139: my $items='';
5140: foreach my $item (@$storearr) {
5141: $items.=&escape($item).'&';
5142: }
5143:
5144: $items=~s/\&$//;
5145: if (!$udomain) { $udomain=$env{'user.domain'}; }
5146: if (!$uname) { $uname=$env{'user.name'}; }
5147: my $uhome=&homeserver($uname,$udomain);
5148: return &reply("del:$udomain:$uname:$namespace:$items",$uhome);
5149: }
5150:
5151: # -------------------------------------------------------------- dump interface
5152:
5153: sub unserialize {
5154: my ($rep, $escapedkeys) = @_;
5155:
5156: return {} if $rep =~ /^error/;
5157:
5158: my %returnhash=();
5159: foreach my $item (split /\&/, $rep) {
5160: my ($key, $value) = split(/=/, $item, 2);
5161: $key = unescape($key) unless $escapedkeys;
5162: next if $key =~ /^error: 2 /;
5163: $returnhash{$key} = Apache::lonnet::thaw_unescape($value);
5164: }
5165: #return %returnhash;
5166: return \%returnhash;
5167: }
5168:
5169: # see Lond::dump_with_regexp
5170: # if $escapedkeys hash keys won't get unescaped.
5171: sub dump {
5172: my ($namespace,$udomain,$uname,$regexp,$range,$escapedkeys)=@_;
5173: if (!$udomain) { $udomain=$env{'user.domain'}; }
5174: if (!$uname) { $uname=$env{'user.name'}; }
5175: my $uhome=&homeserver($uname,$udomain);
5176:
5177: my $reply;
5178: if (grep { $_ eq $uhome } current_machine_ids()) {
5179: # user is hosted on this machine
5180: $reply = LONCAPA::Lond::dump_with_regexp(join(":", ($udomain,
5181: $uname, $namespace, $regexp, $range)), $loncaparevs{$uhome});
5182: return %{unserialize($reply, $escapedkeys)};
5183: }
5184: if ($regexp) {
5185: $regexp=&escape($regexp);
5186: } else {
5187: $regexp='.';
5188: }
5189: my $rep=&reply("dump:$udomain:$uname:$namespace:$regexp:$range",$uhome);
5190: my @pairs=split(/\&/,$rep);
5191: my %returnhash=();
5192: if (!($rep =~ /^error/ )) {
5193: foreach my $item (@pairs) {
5194: my ($key,$value)=split(/=/,$item,2);
5195: $key = unescape($key) unless $escapedkeys;
5196: #$key = &unescape($key);
5197: next if ($key =~ /^error: 2 /);
5198: $returnhash{$key}=&thaw_unescape($value);
5199: }
5200: }
5201: return %returnhash;
5202: }
5203:
5204:
5205: # --------------------------------------------------------- dumpstore interface
5206:
5207: sub dumpstore {
5208: my ($namespace,$udomain,$uname,$regexp,$range)=@_;
5209: # same as dump but keys must be escaped. They may contain colon separated
5210: # lists of values that may themself contain colons (e.g. symbs).
5211: return &dump($namespace, $udomain, $uname, $regexp, $range, 1);
5212: }
5213:
5214: # -------------------------------------------------------------- keys interface
5215:
5216: sub getkeys {
5217: my ($namespace,$udomain,$uname)=@_;
5218: if (!$udomain) { $udomain=$env{'user.domain'}; }
5219: if (!$uname) { $uname=$env{'user.name'}; }
5220: my $uhome=&homeserver($uname,$udomain);
5221: my $rep=reply("keys:$udomain:$uname:$namespace",$uhome);
5222: my @keyarray=();
5223: foreach my $key (split(/\&/,$rep)) {
5224: next if ($key =~ /^error: 2 /);
5225: push(@keyarray,&unescape($key));
5226: }
5227: return @keyarray;
5228: }
5229:
5230: # --------------------------------------------------------------- currentdump
5231: sub currentdump {
5232: my ($courseid,$sdom,$sname)=@_;
5233: $courseid = $env{'request.course.id'} if (! defined($courseid));
5234: $sdom = $env{'user.domain'} if (! defined($sdom));
5235: $sname = $env{'user.name'} if (! defined($sname));
5236: my $uhome = &homeserver($sname,$sdom);
5237: my $rep;
5238:
5239: if (grep { $_ eq $uhome } current_machine_ids()) {
5240: $rep = LONCAPA::Lond::dump_profile_database(join(":", ($sdom, $sname,
5241: $courseid)));
5242: } else {
5243: $rep = reply('currentdump:'.$sdom.':'.$sname.':'.$courseid,$uhome);
5244: }
5245:
5246: return if ($rep =~ /^(error:|no_such_host)/);
5247: #
5248: my %returnhash=();
5249: #
5250: if ($rep eq "unknown_cmd") {
5251: # an old lond will not know currentdump
5252: # Do a dump and make it look like a currentdump
5253: my @tmp = &dumpstore($courseid,$sdom,$sname,'.');
5254: return if ($tmp[0] =~ /^(error:|no_such_host)/);
5255: my %hash = @tmp;
5256: @tmp=();
5257: %returnhash = %{&convert_dump_to_currentdump(\%hash)};
5258: } else {
5259: my @pairs=split(/\&/,$rep);
5260: foreach my $pair (@pairs) {
5261: my ($key,$value)=split(/=/,$pair,2);
5262: my ($symb,$param) = split(/:/,$key);
5263: $returnhash{&unescape($symb)}->{&unescape($param)} =
5264: &thaw_unescape($value);
5265: }
5266: }
5267: return %returnhash;
5268: }
5269:
5270: sub convert_dump_to_currentdump{
5271: my %hash = %{shift()};
5272: my %returnhash;
5273: # Code ripped from lond, essentially. The only difference
5274: # here is the unescaping done by lonnet::dump(). Conceivably
5275: # we might run in to problems with parameter names =~ /^v\./
5276: while (my ($key,$value) = each(%hash)) {
5277: my ($v,$symb,$param) = split(/:/,$key);
5278: $symb = &unescape($symb);
5279: $param = &unescape($param);
5280: next if ($v eq 'version' || $symb eq 'keys');
5281: next if (exists($returnhash{$symb}) &&
5282: exists($returnhash{$symb}->{$param}) &&
5283: $returnhash{$symb}->{'v.'.$param} > $v);
5284: $returnhash{$symb}->{$param}=$value;
5285: $returnhash{$symb}->{'v.'.$param}=$v;
5286: }
5287: #
5288: # Remove all of the keys in the hashes which keep track of
5289: # the version of the parameter.
5290: while (my ($symb,$param_hash) = each(%returnhash)) {
5291: # use a foreach because we are going to delete from the hash.
5292: foreach my $key (keys(%$param_hash)) {
5293: delete($param_hash->{$key}) if ($key =~ /^v\./);
5294: }
5295: }
5296: return \%returnhash;
5297: }
5298:
5299: # ------------------------------------------------------ critical inc interface
5300:
5301: sub cinc {
5302: return &inc(@_,'critical');
5303: }
5304:
5305: # --------------------------------------------------------------- inc interface
5306:
5307: sub inc {
5308: my ($namespace,$store,$udomain,$uname,$critical) = @_;
5309: if (!$udomain) { $udomain=$env{'user.domain'}; }
5310: if (!$uname) { $uname=$env{'user.name'}; }
5311: my $uhome=&homeserver($uname,$udomain);
5312: my $items='';
5313: if (! ref($store)) {
5314: # got a single value, so use that instead
5315: $items = &escape($store).'=&';
5316: } elsif (ref($store) eq 'SCALAR') {
5317: $items = &escape($$store).'=&';
5318: } elsif (ref($store) eq 'ARRAY') {
5319: $items = join('=&',map {&escape($_);} @{$store});
5320: } elsif (ref($store) eq 'HASH') {
5321: while (my($key,$value) = each(%{$store})) {
5322: $items.= &escape($key).'='.&escape($value).'&';
5323: }
5324: }
5325: $items=~s/\&$//;
5326: if ($critical) {
5327: return &critical("inc:$udomain:$uname:$namespace:$items",$uhome);
5328: } else {
5329: return &reply("inc:$udomain:$uname:$namespace:$items",$uhome);
5330: }
5331: }
5332:
5333: # --------------------------------------------------------------- put interface
5334:
5335: sub put {
5336: my ($namespace,$storehash,$udomain,$uname)=@_;
5337: if (!$udomain) { $udomain=$env{'user.domain'}; }
5338: if (!$uname) { $uname=$env{'user.name'}; }
5339: my $uhome=&homeserver($uname,$udomain);
5340: my $items='';
5341: foreach my $item (keys(%$storehash)) {
5342: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
5343: }
5344: $items=~s/\&$//;
5345: return &reply("put:$udomain:$uname:$namespace:$items",$uhome);
5346: }
5347:
5348: # ------------------------------------------------------------ newput interface
5349:
5350: sub newput {
5351: my ($namespace,$storehash,$udomain,$uname)=@_;
5352: if (!$udomain) { $udomain=$env{'user.domain'}; }
5353: if (!$uname) { $uname=$env{'user.name'}; }
5354: my $uhome=&homeserver($uname,$udomain);
5355: my $items='';
5356: foreach my $key (keys(%$storehash)) {
5357: $items.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
5358: }
5359: $items=~s/\&$//;
5360: return &reply("newput:$udomain:$uname:$namespace:$items",$uhome);
5361: }
5362:
5363: # --------------------------------------------------------- putstore interface
5364:
5365: sub putstore {
5366: my ($namespace,$symb,$version,$storehash,$udomain,$uname)=@_;
5367: if (!$udomain) { $udomain=$env{'user.domain'}; }
5368: if (!$uname) { $uname=$env{'user.name'}; }
5369: my $uhome=&homeserver($uname,$udomain);
5370: my $items='';
5371: foreach my $key (keys(%$storehash)) {
5372: $items.= &escape($key).'='.&freeze_escape($storehash->{$key}).'&';
5373: }
5374: $items=~s/\&$//;
5375: my $esc_symb=&escape($symb);
5376: my $esc_v=&escape($version);
5377: my $reply =
5378: &reply("putstore:$udomain:$uname:$namespace:$esc_symb:$esc_v:$items",
5379: $uhome);
5380: if ($reply eq 'unknown_cmd') {
5381: # gfall back to way things use to be done
5382: return &old_putstore($namespace,$symb,$version,$storehash,$udomain,
5383: $uname);
5384: }
5385: return $reply;
5386: }
5387:
5388: sub old_putstore {
5389: my ($namespace,$symb,$version,$storehash,$udomain,$uname)=@_;
5390: if (!$udomain) { $udomain=$env{'user.domain'}; }
5391: if (!$uname) { $uname=$env{'user.name'}; }
5392: my $uhome=&homeserver($uname,$udomain);
5393: my %newstorehash;
5394: foreach my $item (keys(%$storehash)) {
5395: my $key = $version.':'.&escape($symb).':'.$item;
5396: $newstorehash{$key} = $storehash->{$item};
5397: }
5398: my $items='';
5399: my %allitems = ();
5400: foreach my $item (keys(%newstorehash)) {
5401: if ($item =~ m/^([^\:]+):([^\:]+):([^\:]+)$/) {
5402: my $key = $1.':keys:'.$2;
5403: $allitems{$key} .= $3.':';
5404: }
5405: $items.=$item.'='.&freeze_escape($newstorehash{$item}).'&';
5406: }
5407: foreach my $item (keys(%allitems)) {
5408: $allitems{$item} =~ s/\:$//;
5409: $items.= $item.'='.$allitems{$item}.'&';
5410: }
5411: $items=~s/\&$//;
5412: return &reply("put:$udomain:$uname:$namespace:$items",$uhome);
5413: }
5414:
5415: # ------------------------------------------------------ critical put interface
5416:
5417: sub cput {
5418: my ($namespace,$storehash,$udomain,$uname)=@_;
5419: if (!$udomain) { $udomain=$env{'user.domain'}; }
5420: if (!$uname) { $uname=$env{'user.name'}; }
5421: my $uhome=&homeserver($uname,$udomain);
5422: my $items='';
5423: foreach my $item (keys(%$storehash)) {
5424: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
5425: }
5426: $items=~s/\&$//;
5427: return &critical("put:$udomain:$uname:$namespace:$items",$uhome);
5428: }
5429:
5430: # -------------------------------------------------------------- eget interface
5431:
5432: sub eget {
5433: my ($namespace,$storearr,$udomain,$uname)=@_;
5434: my $items='';
5435: foreach my $item (@$storearr) {
5436: $items.=&escape($item).'&';
5437: }
5438: $items=~s/\&$//;
5439: if (!$udomain) { $udomain=$env{'user.domain'}; }
5440: if (!$uname) { $uname=$env{'user.name'}; }
5441: my $uhome=&homeserver($uname,$udomain);
5442: my $rep=&reply("eget:$udomain:$uname:$namespace:$items",$uhome);
5443: my @pairs=split(/\&/,$rep);
5444: my %returnhash=();
5445: my $i=0;
5446: foreach my $item (@$storearr) {
5447: $returnhash{$item}=&thaw_unescape($pairs[$i]);
5448: $i++;
5449: }
5450: return %returnhash;
5451: }
5452:
5453: # ------------------------------------------------------------ tmpput interface
5454: sub tmpput {
5455: my ($storehash,$server,$context)=@_;
5456: my $items='';
5457: foreach my $item (keys(%$storehash)) {
5458: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
5459: }
5460: $items=~s/\&$//;
5461: if (defined($context)) {
5462: $items .= ':'.&escape($context);
5463: }
5464: return &reply("tmpput:$items",$server);
5465: }
5466:
5467: # ------------------------------------------------------------ tmpget interface
5468: sub tmpget {
5469: my ($token,$server)=@_;
5470: if (!defined($server)) { $server = $perlvar{'lonHostID'}; }
5471: my $rep=&reply("tmpget:$token",$server);
5472: my %returnhash;
5473: foreach my $item (split(/\&/,$rep)) {
5474: my ($key,$value)=split(/=/,$item);
5475: next if ($key =~ /^error: 2 /);
5476: $returnhash{&unescape($key)}=&thaw_unescape($value);
5477: }
5478: return %returnhash;
5479: }
5480:
5481: # ------------------------------------------------------------ tmpdel interface
5482: sub tmpdel {
5483: my ($token,$server)=@_;
5484: if (!defined($server)) { $server = $perlvar{'lonHostID'}; }
5485: return &reply("tmpdel:$token",$server);
5486: }
5487:
5488: # -------------------------------------------------- portfolio access checking
5489:
5490: sub portfolio_access {
5491: my ($requrl) = @_;
5492: my (undef,$udom,$unum,$file_name,$group) = &parse_portfolio_url($requrl);
5493: my $result = &get_portfolio_access($udom,$unum,$file_name,$group);
5494: if ($result) {
5495: my %setters;
5496: if ($env{'user.name'} eq 'public' && $env{'user.domain'} eq 'public') {
5497: my ($startblock,$endblock) =
5498: &Apache::loncommon::blockcheck(\%setters,'port',$unum,$udom);
5499: if ($startblock && $endblock) {
5500: return 'B';
5501: }
5502: } else {
5503: my ($startblock,$endblock) =
5504: &Apache::loncommon::blockcheck(\%setters,'port');
5505: if ($startblock && $endblock) {
5506: return 'B';
5507: }
5508: }
5509: }
5510: if ($result eq 'ok') {
5511: return 'F';
5512: } elsif ($result =~ /^[^:]+:guest_/) {
5513: return 'A';
5514: }
5515: return '';
5516: }
5517:
5518: sub get_portfolio_access {
5519: my ($udom,$unum,$file_name,$group,$access_hash) = @_;
5520:
5521: if (!ref($access_hash)) {
5522: my $current_perms = &get_portfile_permissions($udom,$unum);
5523: my %access_controls = &get_access_controls($current_perms,$group,
5524: $file_name);
5525: $access_hash = $access_controls{$file_name};
5526: }
5527:
5528: my ($public,$guest,@domains,@users,@courses,@groups);
5529: my $now = time;
5530: if (ref($access_hash) eq 'HASH') {
5531: foreach my $key (keys(%{$access_hash})) {
5532: my ($num,$scope,$end,$start) = ($key =~ /^([^:]+):([a-z]+)_(\d*)_?(\d*)$/);
5533: if ($start > $now) {
5534: next;
5535: }
5536: if ($end && $end<$now) {
5537: next;
5538: }
5539: if ($scope eq 'public') {
5540: $public = $key;
5541: last;
5542: } elsif ($scope eq 'guest') {
5543: $guest = $key;
5544: } elsif ($scope eq 'domains') {
5545: push(@domains,$key);
5546: } elsif ($scope eq 'users') {
5547: push(@users,$key);
5548: } elsif ($scope eq 'course') {
5549: push(@courses,$key);
5550: } elsif ($scope eq 'group') {
5551: push(@groups,$key);
5552: }
5553: }
5554: if ($public) {
5555: return 'ok';
5556: }
5557: if ($env{'user.name'} eq 'public' && $env{'user.domain'} eq 'public') {
5558: if ($guest) {
5559: return $guest;
5560: }
5561: } else {
5562: if (@domains > 0) {
5563: foreach my $domkey (@domains) {
5564: if (ref($access_hash->{$domkey}{'dom'}) eq 'ARRAY') {
5565: if (grep(/^\Q$env{'user.domain'}\E$/,@{$access_hash->{$domkey}{'dom'}})) {
5566: return 'ok';
5567: }
5568: }
5569: }
5570: }
5571: if (@users > 0) {
5572: foreach my $userkey (@users) {
5573: if (ref($access_hash->{$userkey}{'users'}) eq 'ARRAY') {
5574: foreach my $item (@{$access_hash->{$userkey}{'users'}}) {
5575: if (ref($item) eq 'HASH') {
5576: if (($item->{'uname'} eq $env{'user.name'}) &&
5577: ($item->{'udom'} eq $env{'user.domain'})) {
5578: return 'ok';
5579: }
5580: }
5581: }
5582: }
5583: }
5584: }
5585: my %roleshash;
5586: my @courses_and_groups = @courses;
5587: push(@courses_and_groups,@groups);
5588: if (@courses_and_groups > 0) {
5589: my (%allgroups,%allroles);
5590: my ($start,$end,$role,$sec,$group);
5591: foreach my $envkey (%env) {
5592: if ($envkey =~ m-^user\.role\.(gr|cc|co|in|ta|ep|ad|st)\./($match_domain)/($match_courseid)/?([^/]*)$-) {
5593: my $cid = $2.'_'.$3;
5594: if ($1 eq 'gr') {
5595: $group = $4;
5596: $allgroups{$cid}{$group} = $env{$envkey};
5597: } else {
5598: if ($4 eq '') {
5599: $sec = 'none';
5600: } else {
5601: $sec = $4;
5602: }
5603: $allroles{$cid}{$1}{$sec} = $env{$envkey};
5604: }
5605: } elsif ($envkey =~ m-^user\.role\./cr/($match_domain/$match_username/\w*)./($match_domain)/($match_courseid)/?([^/]*)$-) {
5606: my $cid = $2.'_'.$3;
5607: if ($4 eq '') {
5608: $sec = 'none';
5609: } else {
5610: $sec = $4;
5611: }
5612: $allroles{$cid}{$1}{$sec} = $env{$envkey};
5613: }
5614: }
5615: if (keys(%allroles) == 0) {
5616: return;
5617: }
5618: foreach my $key (@courses_and_groups) {
5619: my %content = %{$$access_hash{$key}};
5620: my $cnum = $content{'number'};
5621: my $cdom = $content{'domain'};
5622: my $cid = $cdom.'_'.$cnum;
5623: if (!exists($allroles{$cid})) {
5624: next;
5625: }
5626: foreach my $role_id (keys(%{$content{'roles'}})) {
5627: my @sections = @{$content{'roles'}{$role_id}{'section'}};
5628: my @groups = @{$content{'roles'}{$role_id}{'group'}};
5629: my @status = @{$content{'roles'}{$role_id}{'access'}};
5630: my @roles = @{$content{'roles'}{$role_id}{'role'}};
5631: foreach my $role (keys(%{$allroles{$cid}})) {
5632: if ((grep/^all$/,@roles) || (grep/^\Q$role\E$/,@roles)) {
5633: foreach my $sec (keys(%{$allroles{$cid}{$role}})) {
5634: if (&course_group_datechecker($allroles{$cid}{$role}{$sec},$now,\@status) eq 'ok') {
5635: if (grep/^all$/,@sections) {
5636: return 'ok';
5637: } else {
5638: if (grep/^$sec$/,@sections) {
5639: return 'ok';
5640: }
5641: }
5642: }
5643: }
5644: if (keys(%{$allgroups{$cid}}) == 0) {
5645: if (grep/^none$/,@groups) {
5646: return 'ok';
5647: }
5648: } else {
5649: if (grep/^all$/,@groups) {
5650: return 'ok';
5651: }
5652: foreach my $group (keys(%{$allgroups{$cid}})) {
5653: if (grep/^$group$/,@groups) {
5654: return 'ok';
5655: }
5656: }
5657: }
5658: }
5659: }
5660: }
5661: }
5662: }
5663: if ($guest) {
5664: return $guest;
5665: }
5666: }
5667: }
5668: return;
5669: }
5670:
5671: sub course_group_datechecker {
5672: my ($dates,$now,$status) = @_;
5673: my ($start,$end) = split(/\./,$dates);
5674: if (!$start && !$end) {
5675: return 'ok';
5676: }
5677: if (grep/^active$/,@{$status}) {
5678: if (((!$start) || ($start && $start <= $now)) && ((!$end) || ($end && $end >= $now))) {
5679: return 'ok';
5680: }
5681: }
5682: if (grep/^previous$/,@{$status}) {
5683: if ($end > $now ) {
5684: return 'ok';
5685: }
5686: }
5687: if (grep/^future$/,@{$status}) {
5688: if ($start > $now) {
5689: return 'ok';
5690: }
5691: }
5692: return;
5693: }
5694:
5695: sub parse_portfolio_url {
5696: my ($url) = @_;
5697:
5698: my ($type,$udom,$unum,$group,$file_name);
5699:
5700: if ($url =~ m-^/*(?:uploaded|editupload)/($match_domain)/($match_username)/portfolio(/.+)$-) {
5701: $type = 1;
5702: $udom = $1;
5703: $unum = $2;
5704: $file_name = $3;
5705: } elsif ($url =~ m-^/*(?:uploaded|editupload)/($match_domain)/($match_courseid)/groups/([^/]+)/portfolio/(.+)$-) {
5706: $type = 2;
5707: $udom = $1;
5708: $unum = $2;
5709: $group = $3;
5710: $file_name = $3.'/'.$4;
5711: }
5712: if (wantarray) {
5713: return ($type,$udom,$unum,$file_name,$group);
5714: }
5715: return $type;
5716: }
5717:
5718: sub is_portfolio_url {
5719: my ($url) = @_;
5720: return scalar(&parse_portfolio_url($url));
5721: }
5722:
5723: sub is_portfolio_file {
5724: my ($file) = @_;
5725: if (($file =~ /^portfolio/) || ($file =~ /^groups\/\w+\/portfolio/)) {
5726: return 1;
5727: }
5728: return;
5729: }
5730:
5731: sub usertools_access {
5732: my ($uname,$udom,$tool,$action,$context,$userenvref,$domdefref,$is_advref)=@_;
5733: my ($access,%tools);
5734: if ($context eq '') {
5735: $context = 'tools';
5736: }
5737: if ($context eq 'requestcourses') {
5738: %tools = (
5739: official => 1,
5740: unofficial => 1,
5741: community => 1,
5742: );
5743: } elsif ($context eq 'requestauthor') {
5744: %tools = (
5745: requestauthor => 1,
5746: );
5747: } else {
5748: %tools = (
5749: aboutme => 1,
5750: blog => 1,
5751: webdav => 1,
5752: portfolio => 1,
5753: );
5754: }
5755: return if (!defined($tools{$tool}));
5756:
5757: if ((!defined($udom)) || (!defined($uname))) {
5758: $udom = $env{'user.domain'};
5759: $uname = $env{'user.name'};
5760: }
5761:
5762: if (($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'})) {
5763: if ($action ne 'reload') {
5764: if ($context eq 'requestcourses') {
5765: return $env{'environment.canrequest.'.$tool};
5766: } elsif ($context eq 'requestauthor') {
5767: return $env{'environment.canrequest.author'};
5768: } else {
5769: return $env{'environment.availabletools.'.$tool};
5770: }
5771: }
5772: }
5773:
5774: my ($toolstatus,$inststatus,$envkey);
5775: if ($context eq 'requestauthor') {
5776: $envkey = $context;
5777: } else {
5778: $envkey = $context.'.'.$tool;
5779: }
5780:
5781: if (($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'}) &&
5782: ($action ne 'reload')) {
5783: $toolstatus = $env{'environment.'.$envkey};
5784: $inststatus = $env{'environment.inststatus'};
5785: } else {
5786: if (ref($userenvref) eq 'HASH') {
5787: $toolstatus = $userenvref->{$envkey};
5788: $inststatus = $userenvref->{'inststatus'};
5789: } else {
5790: my %userenv = &userenvironment($udom,$uname,$envkey,'inststatus');
5791: $toolstatus = $userenv{$envkey};
5792: $inststatus = $userenv{'inststatus'};
5793: }
5794: }
5795:
5796: if ($toolstatus ne '') {
5797: if ($toolstatus) {
5798: $access = 1;
5799: } else {
5800: $access = 0;
5801: }
5802: return $access;
5803: }
5804:
5805: my ($is_adv,%domdef);
5806: if (ref($is_advref) eq 'HASH') {
5807: $is_adv = $is_advref->{'is_adv'};
5808: } else {
5809: $is_adv = &is_advanced_user($udom,$uname);
5810: }
5811: if (ref($domdefref) eq 'HASH') {
5812: %domdef = %{$domdefref};
5813: } else {
5814: %domdef = &get_domain_defaults($udom);
5815: }
5816: if (ref($domdef{$tool}) eq 'HASH') {
5817: if ($is_adv) {
5818: if ($domdef{$tool}{'_LC_adv'} ne '') {
5819: if ($domdef{$tool}{'_LC_adv'}) {
5820: $access = 1;
5821: } else {
5822: $access = 0;
5823: }
5824: return $access;
5825: }
5826: }
5827: if ($inststatus ne '') {
5828: my ($hasaccess,$hasnoaccess);
5829: foreach my $affiliation (split(/:/,$inststatus)) {
5830: if ($domdef{$tool}{$affiliation} ne '') {
5831: if ($domdef{$tool}{$affiliation}) {
5832: $hasaccess = 1;
5833: } else {
5834: $hasnoaccess = 1;
5835: }
5836: }
5837: }
5838: if ($hasaccess || $hasnoaccess) {
5839: if ($hasaccess) {
5840: $access = 1;
5841: } elsif ($hasnoaccess) {
5842: $access = 0;
5843: }
5844: return $access;
5845: }
5846: } else {
5847: if ($domdef{$tool}{'default'} ne '') {
5848: if ($domdef{$tool}{'default'}) {
5849: $access = 1;
5850: } elsif ($domdef{$tool}{'default'} == 0) {
5851: $access = 0;
5852: }
5853: return $access;
5854: }
5855: }
5856: } else {
5857: if (($context eq 'tools') && ($tool ne 'webdav')) {
5858: $access = 1;
5859: } else {
5860: $access = 0;
5861: }
5862: return $access;
5863: }
5864: }
5865:
5866: sub is_course_owner {
5867: my ($cdom,$cnum,$udom,$uname) = @_;
5868: if (($udom eq '') || ($uname eq '')) {
5869: $udom = $env{'user.domain'};
5870: $uname = $env{'user.name'};
5871: }
5872: unless (($udom eq '') || ($uname eq '')) {
5873: if (exists($env{'course.'.$cdom.'_'.$cnum.'.internal.courseowner'})) {
5874: if ($env{'course.'.$cdom.'_'.$cnum.'.internal.courseowner'} eq $uname.':'.$udom) {
5875: return 1;
5876: } else {
5877: my %courseinfo = &Apache::lonnet::coursedescription($cdom.'/'.$cnum);
5878: if ($courseinfo{'internal.courseowner'} eq $uname.':'.$udom) {
5879: return 1;
5880: }
5881: }
5882: }
5883: }
5884: return;
5885: }
5886:
5887: sub is_advanced_user {
5888: my ($udom,$uname) = @_;
5889: if ($udom ne '' && $uname ne '') {
5890: if (($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'})) {
5891: if (wantarray) {
5892: return ($env{'user.adv'},$env{'user.author'});
5893: } else {
5894: return $env{'user.adv'};
5895: }
5896: }
5897: }
5898: my %roleshash = &get_my_roles($uname,$udom,'userroles',undef,undef,undef,1);
5899: my %allroles;
5900: my ($is_adv,$is_author);
5901: foreach my $role (keys(%roleshash)) {
5902: my ($trest,$tdomain,$trole,$sec) = split(/:/,$role);
5903: my $area = '/'.$tdomain.'/'.$trest;
5904: if ($sec ne '') {
5905: $area .= '/'.$sec;
5906: }
5907: if (($area ne '') && ($trole ne '')) {
5908: my $spec=$trole.'.'.$area;
5909: if ($trole =~ /^cr\//) {
5910: &custom_roleprivs(\%allroles,$trole,$tdomain,$trest,$spec,$area);
5911: } elsif ($trole ne 'gr') {
5912: &standard_roleprivs(\%allroles,$trole,$tdomain,$spec,$trest,$area);
5913: }
5914: if ($trole eq 'au') {
5915: $is_author = 1;
5916: }
5917: }
5918: }
5919: foreach my $role (keys(%allroles)) {
5920: last if ($is_adv);
5921: foreach my $item (split(/:/,$allroles{$role})) {
5922: if ($item ne '') {
5923: my ($privilege,$restrictions)=split(/&/,$item);
5924: if ($privilege eq 'adv') {
5925: $is_adv = 1;
5926: last;
5927: }
5928: }
5929: }
5930: }
5931: if (wantarray) {
5932: return ($is_adv,$is_author);
5933: }
5934: return $is_adv;
5935: }
5936:
5937: sub check_can_request {
5938: my ($dom,$can_request,$request_domains) = @_;
5939: my $canreq = 0;
5940: my ($types,$typename) = &Apache::loncommon::course_types();
5941: my @options = ('approval','validate','autolimit');
5942: my $optregex = join('|',@options);
5943: if ((ref($can_request) eq 'HASH') && (ref($types) eq 'ARRAY')) {
5944: foreach my $type (@{$types}) {
5945: if (&usertools_access($env{'user.name'},
5946: $env{'user.domain'},
5947: $type,undef,'requestcourses')) {
5948: $canreq ++;
5949: if (ref($request_domains) eq 'HASH') {
5950: push(@{$request_domains->{$type}},$env{'user.domain'});
5951: }
5952: if ($dom eq $env{'user.domain'}) {
5953: $can_request->{$type} = 1;
5954: }
5955: }
5956: if ($env{'environment.reqcrsotherdom.'.$type} ne '') {
5957: my @curr = split(',',$env{'environment.reqcrsotherdom.'.$type});
5958: if (@curr > 0) {
5959: foreach my $item (@curr) {
5960: if (ref($request_domains) eq 'HASH') {
5961: my ($otherdom) = ($item =~ /^($match_domain):($optregex)(=?\d*)$/);
5962: if ($otherdom ne '') {
5963: if (ref($request_domains->{$type}) eq 'ARRAY') {
5964: unless (grep(/^\Q$otherdom\E$/,@{$request_domains->{$type}})) {
5965: push(@{$request_domains->{$type}},$otherdom);
5966: }
5967: } else {
5968: push(@{$request_domains->{$type}},$otherdom);
5969: }
5970: }
5971: }
5972: }
5973: unless($dom eq $env{'user.domain'}) {
5974: $canreq ++;
5975: if (grep(/^\Q$dom\E:($optregex)(=?\d*)$/,@curr)) {
5976: $can_request->{$type} = 1;
5977: }
5978: }
5979: }
5980: }
5981: }
5982: }
5983: return $canreq;
5984: }
5985:
5986: # ---------------------------------------------- Custom access rule evaluation
5987:
5988: sub customaccess {
5989: my ($priv,$uri)=@_;
5990: my ($urole,$urealm)=split(/\./,$env{'request.role'},2);
5991: my (undef,$udom,$ucrs,$usec)=split(/\//,$urealm);
5992: $udom = &LONCAPA::clean_domain($udom);
5993: $ucrs = &LONCAPA::clean_username($ucrs);
5994: my $access=0;
5995: foreach my $right (split(/\s*\,\s*/,&metadata($uri,'rule_rights'))) {
5996: my ($effect,$realm,$role,$type)=split(/\:/,$right);
5997: if ($type eq 'user') {
5998: foreach my $scope (split(/\s*\,\s*/,$realm)) {
5999: my ($tdom,$tuname)=split(m{/},$scope);
6000: if ($tdom) {
6001: if ($tdom ne $env{'user.domain'}) { next; }
6002: }
6003: if ($tuname) {
6004: if ($tuname ne $env{'user.name'}) { next; }
6005: }
6006: $access=($effect eq 'allow');
6007: last;
6008: }
6009: } else {
6010: if ($role) {
6011: if ($role ne $urole) { next; }
6012: }
6013: foreach my $scope (split(/\s*\,\s*/,$realm)) {
6014: my ($tdom,$tcrs,$tsec)=split(/\_/,$scope);
6015: if ($tdom) {
6016: if ($tdom ne $udom) { next; }
6017: }
6018: if ($tcrs) {
6019: if ($tcrs ne $ucrs) { next; }
6020: }
6021: if ($tsec) {
6022: if ($tsec ne $usec) { next; }
6023: }
6024: $access=($effect eq 'allow');
6025: last;
6026: }
6027: if ($realm eq '' && $role eq '') {
6028: $access=($effect eq 'allow');
6029: }
6030: }
6031: }
6032: return $access;
6033: }
6034:
6035: # ------------------------------------------------- Check for a user privilege
6036:
6037: sub allowed {
6038: my ($priv,$uri,$symb,$role)=@_;
6039: my $ver_orguri=$uri;
6040: $uri=&deversion($uri);
6041: my $orguri=$uri;
6042: $uri=&declutter($uri);
6043:
6044: if ($priv eq 'evb') {
6045: # Evade communication block restrictions for specified role in a course
6046: if ($env{'user.priv.'.$role} =~/evb\&([^\:]*)/) {
6047: return $1;
6048: } else {
6049: return;
6050: }
6051: }
6052:
6053: if (defined($env{'allowed.'.$priv})) { return $env{'allowed.'.$priv}; }
6054: # Free bre access to adm and meta resources
6055: if (((($uri=~/^adm\//) && ($uri !~ m{/(?:smppg|bulletinboard)$}))
6056: || (($uri=~/\.meta$/) && ($uri!~m|^uploaded/|) ))
6057: && ($priv eq 'bre')) {
6058: return 'F';
6059: }
6060:
6061: # Free bre access to user's own portfolio contents
6062: my ($space,$domain,$name,@dir)=split('/',$uri);
6063: if (($space=~/^(uploaded|editupload)$/) && ($env{'user.name'} eq $name) &&
6064: ($env{'user.domain'} eq $domain) && ('portfolio' eq $dir[0])) {
6065: my %setters;
6066: my ($startblock,$endblock) =
6067: &Apache::loncommon::blockcheck(\%setters,'port');
6068: if ($startblock && $endblock) {
6069: return 'B';
6070: } else {
6071: return 'F';
6072: }
6073: }
6074:
6075: # bre access to group portfolio for rgf priv in group, or mdg or vcg in course.
6076: if (($space=~/^(uploaded|editupload)$/) && ($dir[0] eq 'groups')
6077: && ($dir[2] eq 'portfolio') && ($priv eq 'bre')) {
6078: if (exists($env{'request.course.id'})) {
6079: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
6080: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
6081: if (($domain eq $cdom) && ($name eq $cnum)) {
6082: my $courseprivid=$env{'request.course.id'};
6083: $courseprivid=~s/\_/\//;
6084: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid
6085: .'/'.$dir[1]} =~/rgf\&([^\:]*)/) {
6086: return $1;
6087: } else {
6088: if ($env{'request.course.sec'}) {
6089: $courseprivid.='/'.$env{'request.course.sec'};
6090: }
6091: if ($env{'user.priv.'.$env{'request.role'}.'./'.
6092: $courseprivid} =~/(mdg|vcg)\&([^\:]*)/) {
6093: return $2;
6094: }
6095: }
6096: }
6097: }
6098: }
6099:
6100: # Free bre to public access
6101:
6102: if ($priv eq 'bre') {
6103: my $copyright=&metadata($uri,'copyright');
6104: if (($copyright eq 'public') && (!$env{'request.course.id'})) {
6105: return 'F';
6106: }
6107: if ($copyright eq 'priv') {
6108: $uri=~/([^\/]+)\/([^\/]+)\//;
6109: unless (($env{'user.name'} eq $2) && ($env{'user.domain'} eq $1)) {
6110: return '';
6111: }
6112: }
6113: if ($copyright eq 'domain') {
6114: $uri=~/([^\/]+)\/([^\/]+)\//;
6115: unless (($env{'user.domain'} eq $1) ||
6116: ($env{'course.'.$env{'request.course.id'}.'.domain'} eq $1)) {
6117: return '';
6118: }
6119: }
6120: if ($env{'request.role'}=~ /li\.\//) {
6121: # Library role, so allow browsing of resources in this domain.
6122: return 'F';
6123: }
6124: if ($copyright eq 'custom') {
6125: unless (&customaccess($priv,$uri)) { return ''; }
6126: }
6127: }
6128: # Domain coordinator is trying to create a course
6129: if (($priv eq 'ccc') && ($env{'request.role'} =~ /^dc\./)) {
6130: # uri is the requested domain in this case.
6131: # comparison to 'request.role.domain' shows if the user has selected
6132: # a role of dc for the domain in question.
6133: return 'F' if ($uri eq $env{'request.role.domain'});
6134: }
6135:
6136: my $thisallowed='';
6137: my $statecond=0;
6138: my $courseprivid='';
6139:
6140: my $ownaccess;
6141: # Community Coordinator or Assistant Co-author browsing resource space.
6142: if (($priv eq 'bro') && ($env{'user.author'})) {
6143: if ($uri eq '') {
6144: $ownaccess = 1;
6145: } else {
6146: if (($env{'user.domain'} ne '') && ($env{'user.name'} ne '')) {
6147: my $udom = $env{'user.domain'};
6148: my $uname = $env{'user.name'};
6149: if ($uri =~ m{^\Q$udom\E/?$}) {
6150: $ownaccess = 1;
6151: } elsif ($uri =~ m{^\Q$udom\E/\Q$uname\E/?}) {
6152: unless ($uri =~ m{\.\./}) {
6153: $ownaccess = 1;
6154: }
6155: } elsif (($udom ne 'public') && ($uname ne 'public')) {
6156: my $now = time;
6157: if ($uri =~ m{^([^/]+)/?$}) {
6158: my $adom = $1;
6159: foreach my $key (keys(%env)) {
6160: if ($key =~ m{^user\.role\.(ca|aa)/\Q$adom\E}) {
6161: my ($start,$end) = split('.',$env{$key});
6162: if (($now >= $start) && (!$end || $end < $now)) {
6163: $ownaccess = 1;
6164: last;
6165: }
6166: }
6167: }
6168: } elsif ($uri =~ m{^([^/]+)/([^/]+)/?}) {
6169: my $adom = $1;
6170: my $aname = $2;
6171: foreach my $role ('ca','aa') {
6172: if ($env{"user.role.$role./$adom/$aname"}) {
6173: my ($start,$end) =
6174: split('.',$env{"user.role.$role./$adom/$aname"});
6175: if (($now >= $start) && (!$end || $end < $now)) {
6176: $ownaccess = 1;
6177: last;
6178: }
6179: }
6180: }
6181: }
6182: }
6183: }
6184: }
6185: }
6186:
6187: # Course
6188:
6189: if ($env{'user.priv.'.$env{'request.role'}.'./'}=~/\Q$priv\E\&([^\:]*)/) {
6190: unless (($priv eq 'bro') && (!$ownaccess)) {
6191: $thisallowed.=$1;
6192: }
6193: }
6194:
6195: # Domain
6196:
6197: if ($env{'user.priv.'.$env{'request.role'}.'./'.(split(/\//,$uri))[0].'/'}
6198: =~/\Q$priv\E\&([^\:]*)/) {
6199: unless (($priv eq 'bro') && (!$ownaccess)) {
6200: $thisallowed.=$1;
6201: }
6202: }
6203:
6204: # User who is not author or co-author might still be able to edit
6205: # resource of an author in the domain (e.g., if Domain Coordinator).
6206: if (($priv eq 'eco') && ($thisallowed eq '') && ($env{'request.course.id'}) &&
6207: (&allowed('mdc',$env{'request.course.id'}))) {
6208: if ($env{"user.priv.cm./$uri/"}=~/\Q$priv\E\&([^\:]*)/) {
6209: $thisallowed.=$1;
6210: }
6211: }
6212:
6213: # Course: uri itself is a course
6214: my $courseuri=$uri;
6215: $courseuri=~s/\_(\d)/\/$1/;
6216: $courseuri=~s/^([^\/])/\/$1/;
6217:
6218: if ($env{'user.priv.'.$env{'request.role'}.'.'.$courseuri}
6219: =~/\Q$priv\E\&([^\:]*)/) {
6220: unless (($priv eq 'bro') && (!$ownaccess)) {
6221: $thisallowed.=$1;
6222: }
6223: }
6224:
6225: # URI is an uploaded document for this course, default permissions don't matter
6226: # not allowing 'edit' access (editupload) to uploaded course docs
6227: if (($priv eq 'bre') && ($uri=~m|^uploaded/|)) {
6228: $thisallowed='';
6229: my ($match)=&is_on_map($uri);
6230: if ($match) {
6231: if ($env{'user.priv.'.$env{'request.role'}.'./'}
6232: =~/\Q$priv\E\&([^\:]*)/) {
6233: my @blockers = &has_comm_blocking($priv,$symb,$uri);
6234: if (@blockers > 0) {
6235: $thisallowed = 'B';
6236: } else {
6237: $thisallowed.=$1;
6238: }
6239: }
6240: } else {
6241: my $refuri = $env{'httpref.'.$orguri} || $env{'httpref.'.$ver_orguri};
6242: if ($refuri) {
6243: if ($refuri =~ m|^/adm/|) {
6244: $thisallowed='F';
6245: } else {
6246: $refuri=&declutter($refuri);
6247: my ($match) = &is_on_map($refuri);
6248: if ($match) {
6249: my @blockers = &has_comm_blocking($priv,$symb,$refuri);
6250: if (@blockers > 0) {
6251: $thisallowed = 'B';
6252: } else {
6253: $thisallowed='F';
6254: }
6255: }
6256: }
6257: }
6258: }
6259: }
6260:
6261: if ($priv eq 'bre'
6262: && $thisallowed ne 'F'
6263: && $thisallowed ne '2'
6264: && &is_portfolio_url($uri)) {
6265: $thisallowed = &portfolio_access($uri);
6266: }
6267:
6268: # Full access at system, domain or course-wide level? Exit.
6269: if ($thisallowed=~/F/) {
6270: return 'F';
6271: }
6272:
6273: # If this is generating or modifying users, exit with special codes
6274:
6275: if (':csu:cdc:ccc:cin:cta:cep:ccr:cst:cad:cli:cau:cdg:cca:caa:'=~/\:\Q$priv\E\:/) {
6276: if (($priv eq 'cca') || ($priv eq 'caa')) {
6277: my ($audom,$auname)=split('/',$uri);
6278: # no author name given, so this just checks on the general right to make a co-author in this domain
6279: unless ($auname) { return $thisallowed; }
6280: # an author name is given, so we are about to actually make a co-author for a certain account
6281: if (($auname ne $env{'user.name'} && $env{'request.role'} !~ /^dc\./) ||
6282: (($audom ne $env{'user.domain'} && $env{'request.role'} !~ /^dc\./) &&
6283: ($audom ne $env{'request.role.domain'}))) { return ''; }
6284: }
6285: return $thisallowed;
6286: }
6287: #
6288: # Gathered so far: system, domain and course wide privileges
6289: #
6290: # Course: See if uri or referer is an individual resource that is part of
6291: # the course
6292:
6293: if ($env{'request.course.id'}) {
6294:
6295: $courseprivid=$env{'request.course.id'};
6296: if ($env{'request.course.sec'}) {
6297: $courseprivid.='/'.$env{'request.course.sec'};
6298: }
6299: $courseprivid=~s/\_/\//;
6300: my $checkreferer=1;
6301: my ($match,$cond)=&is_on_map($uri);
6302: if ($match) {
6303: $statecond=$cond;
6304: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid}
6305: =~/\Q$priv\E\&([^\:]*)/) {
6306: my $value = $1;
6307: if ($priv eq 'bre') {
6308: my @blockers = &has_comm_blocking($priv,$symb,$uri);
6309: if (@blockers > 0) {
6310: $thisallowed = 'B';
6311: } else {
6312: $thisallowed.=$value;
6313: }
6314: } else {
6315: $thisallowed.=$value;
6316: }
6317: $checkreferer=0;
6318: }
6319: }
6320:
6321: if ($checkreferer) {
6322: my $refuri=$env{'httpref.'.$orguri};
6323: unless ($refuri) {
6324: foreach my $key (keys(%env)) {
6325: if ($key=~/^httpref\..*\*/) {
6326: my $pattern=$key;
6327: $pattern=~s/^httpref\.\/res\///;
6328: $pattern=~s/\*/\[\^\/\]\+/g;
6329: $pattern=~s/\//\\\//g;
6330: if ($orguri=~/$pattern/) {
6331: $refuri=$env{$key};
6332: }
6333: }
6334: }
6335: }
6336:
6337: if ($refuri) {
6338: $refuri=&declutter($refuri);
6339: my ($match,$cond)=&is_on_map($refuri);
6340: if ($match) {
6341: my $refstatecond=$cond;
6342: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid}
6343: =~/\Q$priv\E\&([^\:]*)/) {
6344: my $value = $1;
6345: if ($priv eq 'bre') {
6346: my @blockers = &has_comm_blocking($priv,$symb,$refuri);
6347: if (@blockers > 0) {
6348: $thisallowed = 'B';
6349: } else {
6350: $thisallowed.=$value;
6351: }
6352: } else {
6353: $thisallowed.=$value;
6354: }
6355: $uri=$refuri;
6356: $statecond=$refstatecond;
6357: }
6358: }
6359: }
6360: }
6361: }
6362:
6363: #
6364: # Gathered now: all privileges that could apply, and condition number
6365: #
6366: #
6367: # Full or no access?
6368: #
6369:
6370: if ($thisallowed=~/F/) {
6371: return 'F';
6372: }
6373:
6374: unless ($thisallowed) {
6375: return '';
6376: }
6377:
6378: # Restrictions exist, deal with them
6379: #
6380: # C:according to course preferences
6381: # R:according to resource settings
6382: # L:unless locked
6383: # X:according to user session state
6384: #
6385:
6386: # Possibly locked functionality, check all courses
6387: # Locks might take effect only after 10 minutes cache expiration for other
6388: # courses, and 2 minutes for current course
6389:
6390: my $envkey;
6391: if ($thisallowed=~/L/) {
6392: foreach $envkey (keys(%env)) {
6393: if ($envkey=~/^user\.role\.(st|ta)\.([^\.]*)/) {
6394: my $courseid=$2;
6395: my $roleid=$1.'.'.$2;
6396: $courseid=~s/^\///;
6397: my $expiretime=600;
6398: if ($env{'request.role'} eq $roleid) {
6399: $expiretime=120;
6400: }
6401: my ($cdom,$cnum,$csec)=split(/\//,$courseid);
6402: my $prefix='course.'.$cdom.'_'.$cnum.'.';
6403: if ((time-$env{$prefix.'last_cache'})>$expiretime) {
6404: &coursedescription($courseid,{'freshen_cache' => 1});
6405: }
6406: if (($env{$prefix.'res.'.$uri.'.lock.sections'}=~/\,\Q$csec\E\,/)
6407: || ($env{$prefix.'res.'.$uri.'.lock.sections'} eq 'all')) {
6408: if ($env{$prefix.'res.'.$uri.'.lock.expire'}>time) {
6409: &log($env{'user.domain'},$env{'user.name'},
6410: $env{'user.home'},
6411: 'Locked by res: '.$priv.' for '.$uri.' due to '.
6412: $cdom.'/'.$cnum.'/'.$csec.' expire '.
6413: $env{$prefix.'priv.'.$priv.'.lock.expire'});
6414: return '';
6415: }
6416: }
6417: if (($env{$prefix.'priv.'.$priv.'.lock.sections'}=~/\,\Q$csec\E\,/)
6418: || ($env{$prefix.'priv.'.$priv.'.lock.sections'} eq 'all')) {
6419: if ($env{'priv.'.$priv.'.lock.expire'}>time) {
6420: &log($env{'user.domain'},$env{'user.name'},
6421: $env{'user.home'},
6422: 'Locked by priv: '.$priv.' for '.$uri.' due to '.
6423: $cdom.'/'.$cnum.'/'.$csec.' expire '.
6424: $env{$prefix.'priv.'.$priv.'.lock.expire'});
6425: return '';
6426: }
6427: }
6428: }
6429: }
6430: }
6431:
6432: #
6433: # Rest of the restrictions depend on selected course
6434: #
6435:
6436: unless ($env{'request.course.id'}) {
6437: if ($thisallowed eq 'A') {
6438: return 'A';
6439: } elsif ($thisallowed eq 'B') {
6440: return 'B';
6441: } else {
6442: return '1';
6443: }
6444: }
6445:
6446: #
6447: # Now user is definitely in a course
6448: #
6449:
6450:
6451: # Course preferences
6452:
6453: if ($thisallowed=~/C/) {
6454: my $rolecode=(split(/\./,$env{'request.role'}))[0];
6455: my $unamedom=$env{'user.name'}.':'.$env{'user.domain'};
6456: if ($env{'course.'.$env{'request.course.id'}.'.'.$priv.'.roles.denied'}
6457: =~/\Q$rolecode\E/) {
6458: if (($priv ne 'pch') && ($priv ne 'plc')) {
6459: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.':'.
6460: 'Denied by role: '.$priv.' for '.$uri.' as '.$rolecode.' in '.
6461: $env{'request.course.id'});
6462: }
6463: return '';
6464: }
6465:
6466: if ($env{'course.'.$env{'request.course.id'}.'.'.$priv.'.users.denied'}
6467: =~/\Q$unamedom\E/) {
6468: if (($priv ne 'pch') && ($priv ne 'plc')) {
6469: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.
6470: 'Denied by user: '.$priv.' for '.$uri.' as '.$unamedom.' in '.
6471: $env{'request.course.id'});
6472: }
6473: return '';
6474: }
6475: }
6476:
6477: # Resource preferences
6478:
6479: if ($thisallowed=~/R/) {
6480: my $rolecode=(split(/\./,$env{'request.role'}))[0];
6481: if (&metadata($uri,'roledeny')=~/\Q$rolecode\E/) {
6482: if (($priv ne 'pch') && ($priv ne 'plc')) {
6483: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.':'.
6484: 'Denied by role: '.$priv.' for '.$uri.' as '.$rolecode);
6485: }
6486: return '';
6487: }
6488: }
6489:
6490: # Restricted by state or randomout?
6491:
6492: if ($thisallowed=~/X/) {
6493: if ($env{'acc.randomout'}) {
6494: if (!$symb) { $symb=&symbread($uri,1); }
6495: if (($symb) && ($env{'acc.randomout'}=~/\&\Q$symb\E\&/)) {
6496: return '';
6497: }
6498: }
6499: if (&condval($statecond)) {
6500: return '2';
6501: } else {
6502: return '';
6503: }
6504: }
6505:
6506: if ($thisallowed eq 'A') {
6507: return 'A';
6508: } elsif ($thisallowed eq 'B') {
6509: return 'B';
6510: }
6511: return 'F';
6512: }
6513:
6514: sub get_comm_blocks {
6515: my ($cdom,$cnum) = @_;
6516: if ($cdom eq '' || $cnum eq '') {
6517: return unless ($env{'request.course.id'});
6518: $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
6519: $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
6520: }
6521: my %commblocks;
6522: my $hashid=$cdom.'_'.$cnum;
6523: my ($blocksref,$cached)=&is_cached_new('comm_block',$hashid);
6524: if ((defined($cached)) && (ref($blocksref) eq 'HASH')) {
6525: %commblocks = %{$blocksref};
6526: } else {
6527: %commblocks = &Apache::lonnet::dump('comm_block',$cdom,$cnum);
6528: my $cachetime = 600;
6529: &do_cache_new('comm_block',$hashid,\%commblocks,$cachetime);
6530: }
6531: return %commblocks;
6532: }
6533:
6534: sub has_comm_blocking {
6535: my ($priv,$symb,$uri,$blocks) = @_;
6536: return unless ($env{'request.course.id'});
6537: return unless ($priv eq 'bre');
6538: return if ($env{'user.priv.'.$env{'request.role'}} =~/evb\&([^\:]*)/);
6539: my %commblocks;
6540: if (ref($blocks) eq 'HASH') {
6541: %commblocks = %{$blocks};
6542: } else {
6543: %commblocks = &get_comm_blocks();
6544: }
6545: return unless (keys(%commblocks) > 0);
6546: if (!$symb) { $symb=&symbread($uri,1); }
6547: my ($map,$resid,undef)=&decode_symb($symb);
6548: my %tocheck = (
6549: maps => $map,
6550: resources => $symb,
6551: );
6552: my @blockers;
6553: my $now = time;
6554: my $navmap = Apache::lonnavmaps::navmap->new();
6555: foreach my $block (keys(%commblocks)) {
6556: if ($block =~ /^(\d+)____(\d+)$/) {
6557: my ($start,$end) = ($1,$2);
6558: if ($start <= $now && $end >= $now) {
6559: if (ref($commblocks{$block}{'blocks'}) eq 'HASH') {
6560: if (ref($commblocks{$block}{'blocks'}{'docs'}) eq 'HASH') {
6561: if (ref($commblocks{$block}{'blocks'}{'docs'}{'maps'}) eq 'HASH') {
6562: if ($commblocks{$block}{'blocks'}{'docs'}{'maps'}{$map}) {
6563: unless (grep(/^\Q$block\E$/,@blockers)) {
6564: push(@blockers,$block);
6565: }
6566: }
6567: }
6568: if (ref($commblocks{$block}{'blocks'}{'docs'}{'resources'}) eq 'HASH') {
6569: if ($commblocks{$block}{'blocks'}{'docs'}{'resources'}{$symb}) {
6570: unless (grep(/^\Q$block\E$/,@blockers)) {
6571: push(@blockers,$block);
6572: }
6573: }
6574: }
6575: }
6576: }
6577: }
6578: } elsif ($block =~ /^firstaccess____(.+)$/) {
6579: my $item = $1;
6580: my @to_test;
6581: if (ref($commblocks{$block}{'blocks'}) eq 'HASH') {
6582: if (ref($commblocks{$block}{'blocks'}{'docs'}) eq 'HASH') {
6583: my $check_interval;
6584: if (&check_docs_block($commblocks{$block}{'blocks'}{'docs'},\%tocheck)) {
6585: my @interval;
6586: my $type = 'map';
6587: if ($item eq 'course') {
6588: $type = 'course';
6589: @interval=&EXT("resource.0.interval");
6590: } else {
6591: if ($item =~ /___\d+___/) {
6592: $type = 'resource';
6593: @interval=&EXT("resource.0.interval",$item);
6594: if (ref($navmap)) {
6595: my $res = $navmap->getBySymb($item);
6596: push(@to_test,$res);
6597: }
6598: } else {
6599: my $mapsymb = &symbread($item,1);
6600: if ($mapsymb) {
6601: if (ref($navmap)) {
6602: my $mapres = $navmap->getBySymb($mapsymb);
6603: @to_test = $mapres->retrieveResources($mapres,undef,0,1);
6604: foreach my $res (@to_test) {
6605: my $symb = $res->symb();
6606: next if ($symb eq $mapsymb);
6607: if ($symb ne '') {
6608: @interval=&EXT("resource.0.interval",$symb);
6609: last;
6610: }
6611: }
6612: }
6613: }
6614: }
6615: }
6616: if ($interval[0] =~ /\d+/) {
6617: my $first_access;
6618: if ($type eq 'resource') {
6619: $first_access=&get_first_access($interval[1],$item);
6620: } elsif ($type eq 'map') {
6621: $first_access=&get_first_access($interval[1],undef,$item);
6622: } else {
6623: $first_access=&get_first_access($interval[1]);
6624: }
6625: if ($first_access) {
6626: my $timesup = $first_access+$interval[0];
6627: if ($timesup > $now) {
6628: foreach my $res (@to_test) {
6629: if ($res->is_problem()) {
6630: if ($res->completable()) {
6631: unless (grep(/^\Q$block\E$/,@blockers)) {
6632: push(@blockers,$block);
6633: }
6634: last;
6635: }
6636: }
6637: }
6638: }
6639: }
6640: }
6641: }
6642: }
6643: }
6644: }
6645: }
6646: return @blockers;
6647: }
6648:
6649: sub check_docs_block {
6650: my ($docsblock,$tocheck) =@_;
6651: if ((ref($docsblock) ne 'HASH') || (ref($tocheck) ne 'HASH')) {
6652: return;
6653: }
6654: if (ref($docsblock->{'maps'}) eq 'HASH') {
6655: if ($tocheck->{'maps'}) {
6656: if ($docsblock->{'maps'}{$tocheck->{'maps'}}) {
6657: return 1;
6658: }
6659: }
6660: }
6661: if (ref($docsblock->{'resources'}) eq 'HASH') {
6662: if ($tocheck->{'resources'}) {
6663: if ($docsblock->{'resources'}{$tocheck->{'resources'}}) {
6664: return 1;
6665: }
6666: }
6667: }
6668: return;
6669: }
6670:
6671: #
6672: # Removes the versino from a URI and
6673: # splits it in to its filename and path to the filename.
6674: # Seems like File::Basename could have done this more clearly.
6675: # Parameters:
6676: # $uri - input URI
6677: # Returns:
6678: # Two element list consisting of
6679: # $pathname - the URI up to and excluding the trailing /
6680: # $filename - The part of the URI following the last /
6681: # NOTE:
6682: # Another realization of this is simply:
6683: # use File::Basename;
6684: # ...
6685: # $uri = shift;
6686: # $filename = basename($uri);
6687: # $path = dirname($uri);
6688: # return ($filename, $path);
6689: #
6690: # The implementation below is probably faster however.
6691: #
6692: sub split_uri_for_cond {
6693: my $uri=&deversion(&declutter(shift));
6694: my @uriparts=split(/\//,$uri);
6695: my $filename=pop(@uriparts);
6696: my $pathname=join('/',@uriparts);
6697: return ($pathname,$filename);
6698: }
6699: # --------------------------------------------------- Is a resource on the map?
6700:
6701: sub is_on_map {
6702: my ($pathname,$filename) = &split_uri_for_cond(shift);
6703: #Trying to find the conditional for the file
6704: my $match=($env{'acc.res.'.$env{'request.course.id'}.'.'.$pathname}=~
6705: /\&\Q$filename\E\:([\d\|]+)\&/);
6706: if ($match) {
6707: return (1,$1);
6708: } else {
6709: return (0,0);
6710: }
6711: }
6712:
6713: # --------------------------------------------------------- Get symb from alias
6714:
6715: sub get_symb_from_alias {
6716: my $symb=shift;
6717: my ($map,$resid,$url)=&decode_symb($symb);
6718: # Already is a symb
6719: if ($url) { return $symb; }
6720: # Must be an alias
6721: my $aliassymb='';
6722: my %bighash;
6723: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
6724: &GDBM_READER(),0640)) {
6725: my $rid=$bighash{'mapalias_'.$symb};
6726: if ($rid) {
6727: my ($mapid,$resid)=split(/\./,$rid);
6728: $aliassymb=&encode_symb($bighash{'map_id_'.$mapid},
6729: $resid,$bighash{'src_'.$rid});
6730: }
6731: untie %bighash;
6732: }
6733: return $aliassymb;
6734: }
6735:
6736: # ----------------------------------------------------------------- Define Role
6737:
6738: sub definerole {
6739: if (allowed('mcr','/')) {
6740: my ($rolename,$sysrole,$domrole,$courole)=@_;
6741: foreach my $role (split(':',$sysrole)) {
6742: my ($crole,$cqual)=split(/\&/,$role);
6743: if ($pr{'cr:s'}!~/\Q$crole\E/) { return "refused:s:$crole"; }
6744: if ($pr{'cr:s'}=~/\Q$crole\E\&/) {
6745: if ($pr{'cr:s'}!~/\Q$crole\E\&\w*\Q$cqual\E/) {
6746: return "refused:s:$crole&$cqual";
6747: }
6748: }
6749: }
6750: foreach my $role (split(':',$domrole)) {
6751: my ($crole,$cqual)=split(/\&/,$role);
6752: if ($pr{'cr:d'}!~/\Q$crole\E/) { return "refused:d:$crole"; }
6753: if ($pr{'cr:d'}=~/\Q$crole\E\&/) {
6754: if ($pr{'cr:d'}!~/\Q$crole\W\&\w*\Q$cqual\E/) {
6755: return "refused:d:$crole&$cqual";
6756: }
6757: }
6758: }
6759: foreach my $role (split(':',$courole)) {
6760: my ($crole,$cqual)=split(/\&/,$role);
6761: if ($pr{'cr:c'}!~/\Q$crole\E/) { return "refused:c:$crole"; }
6762: if ($pr{'cr:c'}=~/\Q$crole\E\&/) {
6763: if ($pr{'cr:c'}!~/\Q$crole\E\&\w*\Q$cqual\E/) {
6764: return "refused:c:$crole&$cqual";
6765: }
6766: }
6767: }
6768: my $command="encrypt:rolesput:$env{'user.domain'}:$env{'user.name'}:".
6769: "$env{'user.domain'}:$env{'user.name'}:".
6770: "rolesdef_$rolename=".
6771: escape($sysrole.'_'.$domrole.'_'.$courole);
6772: return reply($command,$env{'user.home'});
6773: } else {
6774: return 'refused';
6775: }
6776: }
6777:
6778: # ---------------- Make a metadata query against the network of library servers
6779:
6780: sub metadata_query {
6781: my ($query,$custom,$customshow,$server_array)=@_;
6782: my %rhash;
6783: my %libserv = &all_library();
6784: my @server_list = (defined($server_array) ? @$server_array
6785: : keys(%libserv) );
6786: for my $server (@server_list) {
6787: unless ($custom or $customshow) {
6788: my $reply=&reply("querysend:".&escape($query),$server);
6789: $rhash{$server}=$reply;
6790: }
6791: else {
6792: my $reply=&reply("querysend:".&escape($query).':'.
6793: &escape($custom).':'.&escape($customshow),
6794: $server);
6795: $rhash{$server}=$reply;
6796: }
6797: }
6798: return \%rhash;
6799: }
6800:
6801: # ----------------------------------------- Send log queries and wait for reply
6802:
6803: sub log_query {
6804: my ($uname,$udom,$query,%filters)=@_;
6805: my $uhome=&homeserver($uname,$udom);
6806: if ($uhome eq 'no_host') { return 'error: no_host'; }
6807: my $uhost=&hostname($uhome);
6808: my $command=&escape(join(':',map{$_.'='.$filters{$_}} keys(%filters)));
6809: my $queryid=&reply("querysend:".$query.':'.$udom.':'.$uname.':'.$command,
6810: $uhome);
6811: unless ($queryid=~/^\Q$uhost\E\_/) { return 'error: '.$queryid; }
6812: return get_query_reply($queryid);
6813: }
6814:
6815: # -------------------------- Update MySQL table for portfolio file
6816:
6817: sub update_portfolio_table {
6818: my ($uname,$udom,$file_name,$query,$group,$action) = @_;
6819: if ($group ne '') {
6820: $file_name =~s /^\Q$group\E//;
6821: }
6822: my $homeserver = &homeserver($uname,$udom);
6823: my $queryid=
6824: &reply("querysend:".$query.':'.&escape($uname.':'.$udom.':'.$group).
6825: ':'.&escape($file_name).':'.$action,$homeserver);
6826: my $reply = &get_query_reply($queryid);
6827: return $reply;
6828: }
6829:
6830: # -------------------------- Update MySQL allusers table
6831:
6832: sub update_allusers_table {
6833: my ($uname,$udom,$names) = @_;
6834: my $homeserver = &homeserver($uname,$udom);
6835: my $queryid=
6836: &reply('querysend:allusers:'.&escape($uname).':'.&escape($udom).':'.
6837: 'lastname='.&escape($names->{'lastname'}).'%%'.
6838: 'firstname='.&escape($names->{'firstname'}).'%%'.
6839: 'middlename='.&escape($names->{'middlename'}).'%%'.
6840: 'generation='.&escape($names->{'generation'}).'%%'.
6841: 'permanentemail='.&escape($names->{'permanentemail'}).'%%'.
6842: 'id='.&escape($names->{'id'}),$homeserver);
6843: return;
6844: }
6845:
6846: # ------- Request retrieval of institutional classlists for course(s)
6847:
6848: sub fetch_enrollment_query {
6849: my ($context,$affiliatesref,$replyref,$dom,$cnum) = @_;
6850: my $homeserver;
6851: my $maxtries = 1;
6852: if ($context eq 'automated') {
6853: $homeserver = $perlvar{'lonHostID'};
6854: $maxtries = 10; # will wait for up to 2000s for retrieval of classlist data before timeout
6855: } else {
6856: $homeserver = &homeserver($cnum,$dom);
6857: }
6858: my $host=&hostname($homeserver);
6859: my $cmd = '';
6860: foreach my $affiliate (keys(%{$affiliatesref})) {
6861: $cmd .= $affiliate.'='.join(",",@{$$affiliatesref{$affiliate}}).'%%';
6862: }
6863: $cmd =~ s/%%$//;
6864: $cmd = &escape($cmd);
6865: my $query = 'fetchenrollment';
6866: my $queryid=&reply("querysend:".$query.':'.$dom.':'.$env{'user.name'}.':'.$cmd,$homeserver);
6867: unless ($queryid=~/^\Q$host\E\_/) {
6868: &logthis('fetch_enrollment_query: invalid queryid: '.$queryid.' for host: '.$host.' and homeserver: '.$homeserver.' context: '.$context.' '.$cnum);
6869: return 'error: '.$queryid;
6870: }
6871: my $reply = &get_query_reply($queryid);
6872: my $tries = 1;
6873: while (($reply=~/^timeout/) && ($tries < $maxtries)) {
6874: $reply = &get_query_reply($queryid);
6875: $tries ++;
6876: }
6877: if ( ($reply =~/^timeout/) || ($reply =~/^error/) ) {
6878: &logthis('fetch_enrollment_query error: '.$reply.' for '.$dom.' '.$env{'user.name'}.' for '.$queryid.' context: '.$context.' '.$cnum.' maxtries: '.$maxtries.' tries: '.$tries);
6879: } else {
6880: my @responses = split(/:/,$reply);
6881: if ($homeserver eq $perlvar{'lonHostID'}) {
6882: foreach my $line (@responses) {
6883: my ($key,$value) = split(/=/,$line,2);
6884: $$replyref{$key} = $value;
6885: }
6886: } else {
6887: my $pathname = LONCAPA::tempdir();
6888: foreach my $line (@responses) {
6889: my ($key,$value) = split(/=/,$line);
6890: $$replyref{$key} = $value;
6891: if ($value > 0) {
6892: foreach my $item (@{$$affiliatesref{$key}}) {
6893: my $filename = $dom.'_'.$key.'_'.$item.'_classlist.xml';
6894: my $destname = $pathname.'/'.$filename;
6895: my $xml_classlist = &reply("autoretrieve:".$filename,$homeserver);
6896: if ($xml_classlist =~ /^error/) {
6897: &logthis('fetch_enrollment_query - autoretrieve error: '.$xml_classlist.' for '.$filename.' from server: '.$homeserver.' '.$context.' '.$cnum);
6898: } else {
6899: if ( open(FILE,">$destname") ) {
6900: print FILE &unescape($xml_classlist);
6901: close(FILE);
6902: } else {
6903: &logthis('fetch_enrollment_query - error opening classlist file '.$destname.' '.$context.' '.$cnum);
6904: }
6905: }
6906: }
6907: }
6908: }
6909: }
6910: return 'ok';
6911: }
6912: return 'error';
6913: }
6914:
6915: sub get_query_reply {
6916: my $queryid=shift;
6917: my $replyfile=LONCAPA::tempdir().$queryid;
6918: my $reply='';
6919: for (1..100) {
6920: sleep 2;
6921: if (-e $replyfile.'.end') {
6922: if (open(my $fh,$replyfile)) {
6923: $reply = join('',<$fh>);
6924: close($fh);
6925: } else { return 'error: reply_file_error'; }
6926: return &unescape($reply);
6927: }
6928: }
6929: return 'timeout:'.$queryid;
6930: }
6931:
6932: sub courselog_query {
6933: #
6934: # possible filters:
6935: # url: url or symb
6936: # username
6937: # domain
6938: # action: view, submit, grade
6939: # start: timestamp
6940: # end: timestamp
6941: #
6942: my (%filters)=@_;
6943: unless ($env{'request.course.id'}) { return 'no_course'; }
6944: if ($filters{'url'}) {
6945: $filters{'url'}=&symbclean(&declutter($filters{'url'}));
6946: $filters{'url'}=~s/\.(\w+)$/(\\.\\d+)*\\.$1/;
6947: $filters{'url'}=~s/\.(\w+)\_\_\_/(\\.\\d+)*\\.$1/;
6948: }
6949: my $cname=$env{'course.'.$env{'request.course.id'}.'.num'};
6950: my $cdom=$env{'course.'.$env{'request.course.id'}.'.domain'};
6951: return &log_query($cname,$cdom,'courselog',%filters);
6952: }
6953:
6954: sub userlog_query {
6955: #
6956: # possible filters:
6957: # action: log check role
6958: # start: timestamp
6959: # end: timestamp
6960: #
6961: my ($uname,$udom,%filters)=@_;
6962: return &log_query($uname,$udom,'userlog',%filters);
6963: }
6964:
6965: #--------- Call auto-enrollment subs in localenroll.pm for homeserver for course
6966:
6967: sub auto_run {
6968: my ($cnum,$cdom) = @_;
6969: my $response = 0;
6970: my $settings;
6971: my %domconfig = &get_dom('configuration',['autoenroll'],$cdom);
6972: if (ref($domconfig{'autoenroll'}) eq 'HASH') {
6973: $settings = $domconfig{'autoenroll'};
6974: if ($settings->{'run'} eq '1') {
6975: $response = 1;
6976: }
6977: } else {
6978: my $homeserver;
6979: if (&is_course($cdom,$cnum)) {
6980: $homeserver = &homeserver($cnum,$cdom);
6981: } else {
6982: $homeserver = &domain($cdom,'primary');
6983: }
6984: if ($homeserver ne 'no_host') {
6985: $response = &reply('autorun:'.$cdom,$homeserver);
6986: }
6987: }
6988: return $response;
6989: }
6990:
6991: sub auto_get_sections {
6992: my ($cnum,$cdom,$inst_coursecode) = @_;
6993: my $homeserver;
6994: if (($cdom =~ /^$match_domain$/) && ($cnum =~ /^$match_courseid$/)) {
6995: $homeserver = &homeserver($cnum,$cdom);
6996: }
6997: if (!defined($homeserver)) {
6998: if ($cdom =~ /^$match_domain$/) {
6999: $homeserver = &domain($cdom,'primary');
7000: }
7001: }
7002: my @secs;
7003: if (defined($homeserver)) {
7004: my $response=&unescape(&reply('autogetsections:'.$inst_coursecode.':'.$cdom,$homeserver));
7005: unless ($response eq 'refused') {
7006: @secs = split(/:/,$response);
7007: }
7008: }
7009: return @secs;
7010: }
7011:
7012: sub auto_new_course {
7013: my ($cnum,$cdom,$inst_course_id,$owner,$coowners) = @_;
7014: my $homeserver = &homeserver($cnum,$cdom);
7015: my $response=&unescape(&reply('autonewcourse:'.$inst_course_id.':'.&escape($owner).':'.$cdom.':'.&escape($coowners),$homeserver));
7016: return $response;
7017: }
7018:
7019: sub auto_validate_courseID {
7020: my ($cnum,$cdom,$inst_course_id) = @_;
7021: my $homeserver = &homeserver($cnum,$cdom);
7022: my $response=&unescape(&reply('autovalidatecourse:'.$inst_course_id.':'.$cdom,$homeserver));
7023: return $response;
7024: }
7025:
7026: sub auto_validate_instcode {
7027: my ($cnum,$cdom,$instcode,$owner) = @_;
7028: my ($homeserver,$response);
7029: if (($cdom =~ /^$match_domain$/) && ($cnum =~ /^$match_courseid$/)) {
7030: $homeserver = &homeserver($cnum,$cdom);
7031: }
7032: if (!defined($homeserver)) {
7033: if ($cdom =~ /^$match_domain$/) {
7034: $homeserver = &domain($cdom,'primary');
7035: }
7036: }
7037: $response=&unescape(&reply('autovalidateinstcode:'.$cdom.':'.
7038: &escape($instcode).':'.&escape($owner),$homeserver));
7039: my ($outcome,$description) = map { &unescape($_); } split('&',$response,2);
7040: return ($outcome,$description);
7041: }
7042:
7043: sub auto_create_password {
7044: my ($cnum,$cdom,$authparam,$udom) = @_;
7045: my ($homeserver,$response);
7046: my $create_passwd = 0;
7047: my $authchk = '';
7048: if ($udom =~ /^$match_domain$/) {
7049: $homeserver = &domain($udom,'primary');
7050: }
7051: if ($homeserver eq '') {
7052: if (($cdom =~ /^$match_domain$/) && ($cnum =~ /^$match_courseid$/)) {
7053: $homeserver = &homeserver($cnum,$cdom);
7054: }
7055: }
7056: if ($homeserver eq '') {
7057: $authchk = 'nodomain';
7058: } else {
7059: $response=&unescape(&reply('autocreatepassword:'.$authparam.':'.$cdom,$homeserver));
7060: if ($response eq 'refused') {
7061: $authchk = 'refused';
7062: } else {
7063: ($authparam,$create_passwd,$authchk) = split(/:/,$response);
7064: }
7065: }
7066: return ($authparam,$create_passwd,$authchk);
7067: }
7068:
7069: sub auto_photo_permission {
7070: my ($cnum,$cdom,$students) = @_;
7071: my $homeserver = &homeserver($cnum,$cdom);
7072: my ($outcome,$perm_reqd,$conditions) =
7073: split(/:/,&unescape(&reply('autophotopermission:'.$cdom,$homeserver)),3);
7074: if ($outcome =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
7075: return (undef,undef);
7076: }
7077: return ($outcome,$perm_reqd,$conditions);
7078: }
7079:
7080: sub auto_checkphotos {
7081: my ($uname,$udom,$pid) = @_;
7082: my $homeserver = &homeserver($uname,$udom);
7083: my ($result,$resulttype);
7084: my $outcome = &unescape(&reply('autophotocheck:'.&escape($udom).':'.
7085: &escape($uname).':'.&escape($pid),
7086: $homeserver));
7087: if ($outcome =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
7088: return (undef,undef);
7089: }
7090: if ($outcome) {
7091: ($result,$resulttype) = split(/:/,$outcome);
7092: }
7093: return ($result,$resulttype);
7094: }
7095:
7096: sub auto_photochoice {
7097: my ($cnum,$cdom) = @_;
7098: my $homeserver = &homeserver($cnum,$cdom);
7099: my ($update,$comment) = split(/:/,&unescape(&reply('autophotochoice:'.
7100: &escape($cdom),
7101: $homeserver)));
7102: if ($update =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
7103: return (undef,undef);
7104: }
7105: return ($update,$comment);
7106: }
7107:
7108: sub auto_photoupdate {
7109: my ($affiliatesref,$dom,$cnum,$photo) = @_;
7110: my $homeserver = &homeserver($cnum,$dom);
7111: my $host=&hostname($homeserver);
7112: my $cmd = '';
7113: my $maxtries = 1;
7114: foreach my $affiliate (keys(%{$affiliatesref})) {
7115: $cmd .= $affiliate.'='.join(",",@{$$affiliatesref{$affiliate}}).'%%';
7116: }
7117: $cmd =~ s/%%$//;
7118: $cmd = &escape($cmd);
7119: my $query = 'institutionalphotos';
7120: my $queryid=&reply("querysend:".$query.':'.$dom.':'.$cnum.':'.$cmd,$homeserver);
7121: unless ($queryid=~/^\Q$host\E\_/) {
7122: &logthis('institutionalphotos: invalid queryid: '.$queryid.' for host: '.$host.' and homeserver: '.$homeserver.' and course: '.$cnum);
7123: return 'error: '.$queryid;
7124: }
7125: my $reply = &get_query_reply($queryid);
7126: my $tries = 1;
7127: while (($reply=~/^timeout/) && ($tries < $maxtries)) {
7128: $reply = &get_query_reply($queryid);
7129: $tries ++;
7130: }
7131: if ( ($reply =~/^timeout/) || ($reply =~/^error/) ) {
7132: &logthis('institutionalphotos error: '.$reply.' for '.$dom.' '.$env{'user.name'}.' for '.$queryid.' course: '.$cnum.' maxtries: '.$maxtries.' tries: '.$tries);
7133: } else {
7134: my @responses = split(/:/,$reply);
7135: my $outcome = shift(@responses);
7136: foreach my $item (@responses) {
7137: my ($key,$value) = split(/=/,$item);
7138: $$photo{$key} = $value;
7139: }
7140: return $outcome;
7141: }
7142: return 'error';
7143: }
7144:
7145: sub auto_instcode_format {
7146: my ($caller,$codedom,$instcodes,$codes,$codetitles,$cat_titles,
7147: $cat_order) = @_;
7148: my $courses = '';
7149: my @homeservers;
7150: if ($caller eq 'global') {
7151: my %servers = &get_servers($codedom,'library');
7152: foreach my $tryserver (keys(%servers)) {
7153: if (!grep(/^\Q$tryserver\E$/,@homeservers)) {
7154: push(@homeservers,$tryserver);
7155: }
7156: }
7157: } elsif ($caller eq 'requests') {
7158: if ($codedom =~ /^$match_domain$/) {
7159: my $chome = &domain($codedom,'primary');
7160: unless ($chome eq 'no_host') {
7161: push(@homeservers,$chome);
7162: }
7163: }
7164: } else {
7165: push(@homeservers,&homeserver($caller,$codedom));
7166: }
7167: foreach my $code (keys(%{$instcodes})) {
7168: $courses .= &escape($code).'='.&escape($$instcodes{$code}).'&';
7169: }
7170: chop($courses);
7171: my $ok_response = 0;
7172: my $response;
7173: while (@homeservers > 0 && $ok_response == 0) {
7174: my $server = shift(@homeservers);
7175: $response=&reply('autoinstcodeformat:'.$codedom.':'.$courses,$server);
7176: if ($response !~ /(con_lost|error|no_such_host|refused)/) {
7177: my ($codes_str,$codetitles_str,$cat_titles_str,$cat_order_str) =
7178: split(/:/,$response);
7179: %{$codes} = (%{$codes},&str2hash($codes_str));
7180: push(@{$codetitles},&str2array($codetitles_str));
7181: %{$cat_titles} = (%{$cat_titles},&str2hash($cat_titles_str));
7182: %{$cat_order} = (%{$cat_order},&str2hash($cat_order_str));
7183: $ok_response = 1;
7184: }
7185: }
7186: if ($ok_response) {
7187: return 'ok';
7188: } else {
7189: return $response;
7190: }
7191: }
7192:
7193: sub auto_instcode_defaults {
7194: my ($domain,$returnhash,$code_order) = @_;
7195: my @homeservers;
7196:
7197: my %servers = &get_servers($domain,'library');
7198: foreach my $tryserver (keys(%servers)) {
7199: if (!grep(/^\Q$tryserver\E$/,@homeservers)) {
7200: push(@homeservers,$tryserver);
7201: }
7202: }
7203:
7204: my $response;
7205: foreach my $server (@homeservers) {
7206: $response=&reply('autoinstcodedefaults:'.$domain,$server);
7207: next if ($response =~ /(con_lost|error|no_such_host|refused)/);
7208:
7209: foreach my $pair (split(/\&/,$response)) {
7210: my ($name,$value)=split(/\=/,$pair);
7211: if ($name eq 'code_order') {
7212: @{$code_order} = split(/\&/,&unescape($value));
7213: } else {
7214: $returnhash->{&unescape($name)}=&unescape($value);
7215: }
7216: }
7217: return 'ok';
7218: }
7219:
7220: return $response;
7221: }
7222:
7223: sub auto_possible_instcodes {
7224: my ($domain,$codetitles,$cat_titles,$cat_orders,$code_order) = @_;
7225: unless ((ref($codetitles) eq 'ARRAY') && (ref($cat_titles) eq 'HASH') &&
7226: (ref($cat_orders) eq 'HASH') && (ref($code_order) eq 'ARRAY')) {
7227: return;
7228: }
7229: my (@homeservers,$uhome);
7230: if (defined(&domain($domain,'primary'))) {
7231: $uhome=&domain($domain,'primary');
7232: push(@homeservers,&domain($domain,'primary'));
7233: } else {
7234: my %servers = &get_servers($domain,'library');
7235: foreach my $tryserver (keys(%servers)) {
7236: if (!grep(/^\Q$tryserver\E$/,@homeservers)) {
7237: push(@homeservers,$tryserver);
7238: }
7239: }
7240: }
7241: my $response;
7242: foreach my $server (@homeservers) {
7243: $response=&reply('autopossibleinstcodes:'.$domain,$server);
7244: next if ($response =~ /(con_lost|error|no_such_host|refused)/);
7245: my ($codetitlestr,$codeorderstr,$cat_title,$cat_order) =
7246: split(':',$response);
7247: @{$codetitles} = map { &unescape($_); } (split('&',$codetitlestr));
7248: @{$code_order} = map { &unescape($_); } (split('&',$codeorderstr));
7249: foreach my $item (split('&',$cat_title)) {
7250: my ($name,$value)=split('=',$item);
7251: $cat_titles->{&unescape($name)}=&thaw_unescape($value);
7252: }
7253: foreach my $item (split('&',$cat_order)) {
7254: my ($name,$value)=split('=',$item);
7255: $cat_orders->{&unescape($name)}=&thaw_unescape($value);
7256: }
7257: return 'ok';
7258: }
7259: return $response;
7260: }
7261:
7262: sub auto_courserequest_checks {
7263: my ($dom) = @_;
7264: my ($homeserver,%validations);
7265: if ($dom =~ /^$match_domain$/) {
7266: $homeserver = &domain($dom,'primary');
7267: }
7268: unless ($homeserver eq 'no_host') {
7269: my $response=&reply('autocrsreqchecks:'.$dom,$homeserver);
7270: unless ($response =~ /(con_lost|error|no_such_host|refused)/) {
7271: my @items = split(/&/,$response);
7272: foreach my $item (@items) {
7273: my ($key,$value) = split('=',$item);
7274: $validations{&unescape($key)} = &thaw_unescape($value);
7275: }
7276: }
7277: }
7278: return %validations;
7279: }
7280:
7281: sub auto_courserequest_validation {
7282: my ($dom,$owner,$crstype,$inststatuslist,$instcode,$instseclist) = @_;
7283: my ($homeserver,$response);
7284: if ($dom =~ /^$match_domain$/) {
7285: $homeserver = &domain($dom,'primary');
7286: }
7287: unless ($homeserver eq 'no_host') {
7288:
7289: $response=&unescape(&reply('autocrsreqvalidation:'.$dom.':'.&escape($owner).
7290: ':'.&escape($crstype).':'.&escape($inststatuslist).
7291: ':'.&escape($instcode).':'.&escape($instseclist),
7292: $homeserver));
7293: }
7294: return $response;
7295: }
7296:
7297: sub auto_validate_class_sec {
7298: my ($cdom,$cnum,$owners,$inst_class) = @_;
7299: my $homeserver = &homeserver($cnum,$cdom);
7300: my $ownerlist;
7301: if (ref($owners) eq 'ARRAY') {
7302: $ownerlist = join(',',@{$owners});
7303: } else {
7304: $ownerlist = $owners;
7305: }
7306: my $response=&reply('autovalidateclass_sec:'.$inst_class.':'.
7307: &escape($ownerlist).':'.$cdom,$homeserver);
7308: return $response;
7309: }
7310:
7311: # ------------------------------------------------------- Course Group routines
7312:
7313: sub get_coursegroups {
7314: my ($cdom,$cnum,$group,$namespace) = @_;
7315: return(&dump($namespace,$cdom,$cnum,$group));
7316: }
7317:
7318: sub modify_coursegroup {
7319: my ($cdom,$cnum,$groupsettings) = @_;
7320: return(&put('coursegroups',$groupsettings,$cdom,$cnum));
7321: }
7322:
7323: sub toggle_coursegroup_status {
7324: my ($cdom,$cnum,$group,$action) = @_;
7325: my ($from_namespace,$to_namespace);
7326: if ($action eq 'delete') {
7327: $from_namespace = 'coursegroups';
7328: $to_namespace = 'deleted_groups';
7329: } else {
7330: $from_namespace = 'deleted_groups';
7331: $to_namespace = 'coursegroups';
7332: }
7333: my %curr_group = &get_coursegroups($cdom,$cnum,$group,$from_namespace);
7334: if (my $tmp = &error(%curr_group)) {
7335: &Apache::lonnet::logthis('Error retrieving group: '.$tmp.' in '.$cnum.':'.$cdom);
7336: return ('read error',$tmp);
7337: } else {
7338: my %savedsettings = %curr_group;
7339: my $result = &put($to_namespace,\%savedsettings,$cdom,$cnum);
7340: my $deloutcome;
7341: if ($result eq 'ok') {
7342: $deloutcome = &del($from_namespace,[$group],$cdom,$cnum);
7343: } else {
7344: return ('write error',$result);
7345: }
7346: if ($deloutcome eq 'ok') {
7347: return 'ok';
7348: } else {
7349: return ('delete error',$deloutcome);
7350: }
7351: }
7352: }
7353:
7354: sub modify_group_roles {
7355: my ($cdom,$cnum,$group_id,$user,$end,$start,$userprivs,$selfenroll,$context) = @_;
7356: my $url = '/'.$cdom.'/'.$cnum.'/'.$group_id;
7357: my $role = 'gr/'.&escape($userprivs);
7358: my ($uname,$udom) = split(/:/,$user);
7359: my $result = &assignrole($udom,$uname,$url,$role,$end,$start,'',$selfenroll,$context);
7360: if ($result eq 'ok') {
7361: &devalidate_getgroups_cache($udom,$uname,$cdom,$cnum);
7362: }
7363: return $result;
7364: }
7365:
7366: sub modify_coursegroup_membership {
7367: my ($cdom,$cnum,$membership) = @_;
7368: my $result = &put('groupmembership',$membership,$cdom,$cnum);
7369: return $result;
7370: }
7371:
7372: sub get_active_groups {
7373: my ($udom,$uname,$cdom,$cnum) = @_;
7374: my $now = time;
7375: my %groups = ();
7376: foreach my $key (keys(%env)) {
7377: if ($key =~ m-user\.role\.gr\./($match_domain)/($match_courseid)/(\w+)$-) {
7378: my ($start,$end) = split(/\./,$env{$key});
7379: if (($end!=0) && ($end<$now)) { next; }
7380: if (($start!=0) && ($start>$now)) { next; }
7381: if ($1 eq $cdom && $2 eq $cnum) {
7382: $groups{$3} = $env{$key} ;
7383: }
7384: }
7385: }
7386: return %groups;
7387: }
7388:
7389: sub get_group_membership {
7390: my ($cdom,$cnum,$group) = @_;
7391: return(&dump('groupmembership',$cdom,$cnum,$group));
7392: }
7393:
7394: sub get_users_groups {
7395: my ($udom,$uname,$courseid) = @_;
7396: my @usersgroups;
7397: my $cachetime=1800;
7398:
7399: my $hashid="$udom:$uname:$courseid";
7400: my ($grouplist,$cached)=&is_cached_new('getgroups',$hashid);
7401: if (defined($cached)) {
7402: @usersgroups = split(/:/,$grouplist);
7403: } else {
7404: $grouplist = '';
7405: my $courseurl = &courseid_to_courseurl($courseid);
7406: my %roleshash = &dump('roles',$udom,$uname,$courseurl);
7407: my $access_end = $env{'course.'.$courseid.
7408: '.default_enrollment_end_date'};
7409: my $now = time;
7410: foreach my $key (keys(%roleshash)) {
7411: if ($key =~ /^\Q$courseurl\E\/(\w+)\_gr$/) {
7412: my $group = $1;
7413: if ($roleshash{$key} =~ /_(\d+)_(\d+)$/) {
7414: my $start = $2;
7415: my $end = $1;
7416: if ($start == -1) { next; } # deleted from group
7417: if (($start!=0) && ($start>$now)) { next; }
7418: if (($end!=0) && ($end<$now)) {
7419: if ($access_end && $access_end < $now) {
7420: if ($access_end - $end < 86400) {
7421: push(@usersgroups,$group);
7422: }
7423: }
7424: next;
7425: }
7426: push(@usersgroups,$group);
7427: }
7428: }
7429: }
7430: @usersgroups = &sort_course_groups($courseid,@usersgroups);
7431: $grouplist = join(':',@usersgroups);
7432: &do_cache_new('getgroups',$hashid,$grouplist,$cachetime);
7433: }
7434: return @usersgroups;
7435: }
7436:
7437: sub devalidate_getgroups_cache {
7438: my ($udom,$uname,$cdom,$cnum)=@_;
7439: my $courseid = $cdom.'_'.$cnum;
7440:
7441: my $hashid="$udom:$uname:$courseid";
7442: &devalidate_cache_new('getgroups',$hashid);
7443: }
7444:
7445: # ------------------------------------------------------------------ Plain Text
7446:
7447: sub plaintext {
7448: my ($short,$type,$cid,$forcedefault) = @_;
7449: if ($short =~ m{^cr/}) {
7450: return (split('/',$short))[-1];
7451: }
7452: if (!defined($cid)) {
7453: $cid = $env{'request.course.id'};
7454: }
7455: my %rolenames = (
7456: Course => 'std',
7457: Community => 'alt1',
7458: );
7459: if ($cid ne '') {
7460: if ($env{'course.'.$cid.'.'.$short.'.plaintext'} ne '') {
7461: unless ($forcedefault) {
7462: my $roletext = $env{'course.'.$cid.'.'.$short.'.plaintext'};
7463: &Apache::lonlocal::mt_escape(\$roletext);
7464: return &Apache::lonlocal::mt($roletext);
7465: }
7466: }
7467: }
7468: if ((defined($type)) && (defined($rolenames{$type})) &&
7469: (defined($rolenames{$type})) &&
7470: (defined($prp{$short}{$rolenames{$type}}))) {
7471: return &Apache::lonlocal::mt($prp{$short}{$rolenames{$type}});
7472: } elsif ($cid ne '') {
7473: my $crstype = $env{'course.'.$cid.'.type'};
7474: if (($crstype ne '') && (defined($rolenames{$crstype})) &&
7475: (defined($prp{$short}{$rolenames{$crstype}}))) {
7476: return &Apache::lonlocal::mt($prp{$short}{$rolenames{$crstype}});
7477: }
7478: }
7479: return &Apache::lonlocal::mt($prp{$short}{'std'});
7480: }
7481:
7482: # ----------------------------------------------------------------- Assign Role
7483:
7484: sub assignrole {
7485: my ($udom,$uname,$url,$role,$end,$start,$deleteflag,$selfenroll,
7486: $context)=@_;
7487: my $mrole;
7488: if ($role =~ /^cr\//) {
7489: my $cwosec=$url;
7490: $cwosec=~s/^\/($match_domain)\/($match_courseid)\/.*/$1\/$2/;
7491: unless (&allowed('ccr',$cwosec)) {
7492: my $refused = 1;
7493: if ($context eq 'requestcourses') {
7494: if (($env{'user.name'} ne '') && ($env{'user.domain'} ne '')) {
7495: if ($role =~ m{^cr/($match_domain)/($match_username)/([^/]+)$}) {
7496: if (($1 eq $env{'user.domain'}) && ($2 eq $env{'user.name'})) {
7497: my ($cdom,$cnum) = ($cwosec =~ m{^/?($match_domain)/($match_courseid)$});
7498: my %crsenv = &userenvironment($cdom,$cnum,('internal.courseowner'));
7499: if ($crsenv{'internal.courseowner'} eq
7500: $env{'user.name'}.':'.$env{'user.domain'}) {
7501: $refused = '';
7502: }
7503: }
7504: }
7505: }
7506: }
7507: if ($refused) {
7508: &logthis('Refused custom assignrole: '.
7509: $udom.' '.$uname.' '.$url.' '.$role.' '.$end.' '.$start.
7510: ' by '.$env{'user.name'}.' at '.$env{'user.domain'});
7511: return 'refused';
7512: }
7513: }
7514: $mrole='cr';
7515: } elsif ($role =~ /^gr\//) {
7516: my $cwogrp=$url;
7517: $cwogrp=~s{^/($match_domain)/($match_courseid)/.*}{$1/$2};
7518: unless (&allowed('mdg',$cwogrp)) {
7519: &logthis('Refused group assignrole: '.
7520: $udom.' '.$uname.' '.$url.' '.$role.' '.$end.' '.$start.' by '.
7521: $env{'user.name'}.' at '.$env{'user.domain'});
7522: return 'refused';
7523: }
7524: $mrole='gr';
7525: } else {
7526: my $cwosec=$url;
7527: $cwosec=~s/^\/($match_domain)\/($match_courseid)\/.*/$1\/$2/;
7528: if (!(&allowed('c'.$role,$cwosec)) && !(&allowed('c'.$role,$udom))) {
7529: my $refused;
7530: if (($env{'request.course.sec'} ne '') && ($role eq 'st')) {
7531: if (!(&allowed('c'.$role,$url))) {
7532: $refused = 1;
7533: }
7534: } else {
7535: $refused = 1;
7536: }
7537: if ($refused) {
7538: my ($cdom,$cnum) = ($cwosec =~ m{^/?($match_domain)/($match_courseid)$});
7539: if (!$selfenroll && $context eq 'course') {
7540: my %crsenv;
7541: if ($role eq 'cc' || $role eq 'co') {
7542: %crsenv = &userenvironment($cdom,$cnum,('internal.courseowner'));
7543: if (($role eq 'cc') && ($cnum !~ /^$match_community$/)) {
7544: if ($env{'request.role'} eq 'cc./'.$cdom.'/'.$cnum) {
7545: if ($crsenv{'internal.courseowner'} eq
7546: $env{'user.name'}.':'.$env{'user.domain'}) {
7547: $refused = '';
7548: }
7549: }
7550: } elsif (($role eq 'co') && ($cnum =~ /^$match_community$/)) {
7551: if ($env{'request.role'} eq 'co./'.$cdom.'/'.$cnum) {
7552: if ($crsenv{'internal.courseowner'} eq
7553: $env{'user.name'}.':'.$env{'user.domain'}) {
7554: $refused = '';
7555: }
7556: }
7557: }
7558: }
7559: } elsif (($selfenroll == 1) && ($role eq 'st') && ($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'})) {
7560: $refused = '';
7561: } elsif ($context eq 'requestcourses') {
7562: my @possroles = ('st','ta','ep','in','cc','co');
7563: if ((grep(/^\Q$role\E$/,@possroles)) && ($env{'user.name'} ne '' && $env{'user.domain'} ne '')) {
7564: my $wrongcc;
7565: if ($cnum =~ /^$match_community$/) {
7566: $wrongcc = 1 if ($role eq 'cc');
7567: } else {
7568: $wrongcc = 1 if ($role eq 'co');
7569: }
7570: unless ($wrongcc) {
7571: my %crsenv = &userenvironment($cdom,$cnum,('internal.courseowner'));
7572: if ($crsenv{'internal.courseowner'} eq
7573: $env{'user.name'}.':'.$env{'user.domain'}) {
7574: $refused = '';
7575: }
7576: }
7577: }
7578: } elsif ($context eq 'requestauthor') {
7579: if (($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'}) &&
7580: ($url eq '/'.$udom.'/') && ($role eq 'au')) {
7581: if ($env{'environment.requestauthor'} eq 'automatic') {
7582: $refused = '';
7583: } else {
7584: my %domdefaults = &get_domain_defaults($udom);
7585: if (ref($domdefaults{'requestauthor'}) eq 'HASH') {
7586: my $checkbystatus;
7587: if ($env{'user.adv'}) {
7588: my $disposition = $domdefaults{'requestauthor'}{'_LC_adv'};
7589: if ($disposition eq 'automatic') {
7590: $refused = '';
7591: } elsif ($disposition eq '') {
7592: $checkbystatus = 1;
7593: }
7594: } else {
7595: $checkbystatus = 1;
7596: }
7597: if ($checkbystatus) {
7598: if ($env{'environment.inststatus'}) {
7599: my @inststatuses = split(/,/,$env{'environment.inststatus'});
7600: foreach my $type (@inststatuses) {
7601: if (($type ne '') &&
7602: ($domdefaults{'requestauthor'}{$type} eq 'automatic')) {
7603: $refused = '';
7604: }
7605: }
7606: } elsif ($domdefaults{'requestauthor'}{'default'} eq 'automatic') {
7607: $refused = '';
7608: }
7609: }
7610: }
7611: }
7612: }
7613: }
7614: if ($refused) {
7615: &logthis('Refused assignrole: '.$udom.' '.$uname.' '.$url.
7616: ' '.$role.' '.$end.' '.$start.' by '.
7617: $env{'user.name'}.' at '.$env{'user.domain'});
7618: return 'refused';
7619: }
7620: }
7621: } elsif ($role eq 'au') {
7622: if ($url ne '/'.$udom.'/') {
7623: &logthis('Attempt by '.$env{'user.name'}.':'.$env{'user.domain'}.
7624: ' to assign author role for '.$uname.':'.$udom.
7625: ' in domain: '.$url.' refused (wrong domain).');
7626: return 'refused';
7627: }
7628: }
7629: $mrole=$role;
7630: }
7631: my $command="encrypt:rolesput:$env{'user.domain'}:$env{'user.name'}:".
7632: "$udom:$uname:$url".'_'."$mrole=$role";
7633: if ($end) { $command.='_'.$end; }
7634: if ($start) {
7635: if ($end) {
7636: $command.='_'.$start;
7637: } else {
7638: $command.='_0_'.$start;
7639: }
7640: }
7641: my $origstart = $start;
7642: my $origend = $end;
7643: my $delflag;
7644: # actually delete
7645: if ($deleteflag) {
7646: if ((&allowed('dro',$udom)) || (&allowed('dro',$url))) {
7647: # modify command to delete the role
7648: $command="encrypt:rolesdel:$env{'user.domain'}:$env{'user.name'}:".
7649: "$udom:$uname:$url".'_'."$mrole";
7650: &logthis("$env{'user.name'} at $env{'user.domain'} deletes $mrole in $url for $uname at $udom");
7651: # set start and finish to negative values for userrolelog
7652: $start=-1;
7653: $end=-1;
7654: $delflag = 1;
7655: }
7656: }
7657: # send command
7658: my $answer=&reply($command,&homeserver($uname,$udom));
7659: # log new user role if status is ok
7660: if ($answer eq 'ok') {
7661: &userrolelog($role,$uname,$udom,$url,$start,$end);
7662: # for course roles, perform group memberships changes triggered by role change.
7663: unless ($role =~ /^gr/) {
7664: &Apache::longroup::group_changes($udom,$uname,$url,$role,$origend,
7665: $origstart,$selfenroll,$context);
7666: }
7667: if (($role eq 'cc') || ($role eq 'in') ||
7668: ($role eq 'ep') || ($role eq 'ad') ||
7669: ($role eq 'ta') || ($role eq 'st') ||
7670: ($role=~/^cr/) || ($role eq 'gr') ||
7671: ($role eq 'co')) {
7672: &courserolelog($role,$uname,$udom,$url,$origstart,$origend,$delflag,
7673: $selfenroll,$context);
7674: } elsif (($role eq 'li') || ($role eq 'dg') || ($role eq 'sc') ||
7675: ($role eq 'au') || ($role eq 'dc')) {
7676: &domainrolelog($role,$uname,$udom,$url,$origstart,$origend,$delflag,
7677: $context);
7678: } elsif (($role eq 'ca') || ($role eq 'aa')) {
7679: &coauthorrolelog($role,$uname,$udom,$url,$origstart,$origend,$delflag,
7680: $context);
7681: }
7682: if ($role eq 'cc') {
7683: &autoupdate_coowners($url,$end,$start,$uname,$udom);
7684: }
7685: }
7686: return $answer;
7687: }
7688:
7689: sub autoupdate_coowners {
7690: my ($url,$end,$start,$uname,$udom) = @_;
7691: my ($cdom,$cnum) = ($url =~ m{^/($match_domain)/($match_courseid)});
7692: if (($cdom ne '') && ($cnum ne '')) {
7693: my $now = time;
7694: my %domdesign = &Apache::loncommon::get_domainconf($cdom);
7695: if ($domdesign{$cdom.'.autoassign.co-owners'}) {
7696: my %coursehash = &coursedescription($cdom.'_'.$cnum);
7697: my $instcode = $coursehash{'internal.coursecode'};
7698: if ($instcode ne '') {
7699: if (($start && $start <= $now) && ($end == 0) || ($end > $now)) {
7700: unless ($coursehash{'internal.courseowner'} eq $uname.':'.$udom) {
7701: my ($delcoowners,@newcoowners,$putresult,$delresult,$coowners);
7702: my ($result,$desc) = &auto_validate_instcode($cnum,$cdom,$instcode,$uname.':'.$udom);
7703: if ($result eq 'valid') {
7704: if ($coursehash{'internal.co-owners'}) {
7705: foreach my $coowner (split(',',$coursehash{'internal.co-owners'})) {
7706: push(@newcoowners,$coowner);
7707: }
7708: unless (grep(/^\Q$uname\E:\Q$udom\E$/,@newcoowners)) {
7709: push(@newcoowners,$uname.':'.$udom);
7710: }
7711: @newcoowners = sort(@newcoowners);
7712: } else {
7713: push(@newcoowners,$uname.':'.$udom);
7714: }
7715: } else {
7716: if ($coursehash{'internal.co-owners'}) {
7717: foreach my $coowner (split(',',$coursehash{'internal.co-owners'})) {
7718: unless ($coowner eq $uname.':'.$udom) {
7719: push(@newcoowners,$coowner);
7720: }
7721: }
7722: unless (@newcoowners > 0) {
7723: $delcoowners = 1;
7724: $coowners = '';
7725: }
7726: }
7727: }
7728: if (@newcoowners || $delcoowners) {
7729: &store_coowners($cdom,$cnum,$coursehash{'home'},
7730: $delcoowners,@newcoowners);
7731: }
7732: }
7733: }
7734: }
7735: }
7736: }
7737: }
7738:
7739: sub store_coowners {
7740: my ($cdom,$cnum,$chome,$delcoowners,@newcoowners) = @_;
7741: my $cid = $cdom.'_'.$cnum;
7742: my ($coowners,$delresult,$putresult);
7743: if (@newcoowners) {
7744: $coowners = join(',',@newcoowners);
7745: my %coownershash = (
7746: 'internal.co-owners' => $coowners,
7747: );
7748: $putresult = &put('environment',\%coownershash,$cdom,$cnum);
7749: if ($putresult eq 'ok') {
7750: if ($env{'course.'.$cid.'.num'} eq $cnum) {
7751: &appenv({'course.'.$cid.'.internal.co-owners' => $coowners});
7752: }
7753: }
7754: }
7755: if ($delcoowners) {
7756: $delresult = &Apache::lonnet::del('environment',['internal.co-owners'],$cdom,$cnum);
7757: if ($delresult eq 'ok') {
7758: if ($env{'course.'.$cid.'.internal.co-owners'}) {
7759: &Apache::lonnet::delenv('course.'.$cid.'.internal.co-owners');
7760: }
7761: }
7762: }
7763: if (($putresult eq 'ok') || ($delresult eq 'ok')) {
7764: my %crsinfo =
7765: &Apache::lonnet::courseiddump($cdom,'.',1,'.','.',$cnum,undef,undef,'.');
7766: if (ref($crsinfo{$cid}) eq 'HASH') {
7767: $crsinfo{$cid}{'co-owners'} = \@newcoowners;
7768: my $cidput = &Apache::lonnet::courseidput($cdom,\%crsinfo,$chome,'notime');
7769: }
7770: }
7771: }
7772:
7773: # -------------------------------------------------- Modify user authentication
7774: # Overrides without validation
7775:
7776: sub modifyuserauth {
7777: my ($udom,$uname,$umode,$upass)=@_;
7778: my $uhome=&homeserver($uname,$udom);
7779: unless (&allowed('mau',$udom)) { return 'refused'; }
7780: &logthis('Call to modify user authentication '.$udom.', '.$uname.', '.
7781: $umode.' by '.$env{'user.name'}.' at '.$env{'user.domain'}.
7782: ' in domain '.$env{'request.role.domain'});
7783: my $reply=&reply('encrypt:changeuserauth:'.$udom.':'.$uname.':'.$umode.':'.
7784: &escape($upass),$uhome);
7785: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},
7786: 'Authentication changed for '.$udom.', '.$uname.', '.$umode.
7787: '(Remote '.$ENV{'REMOTE_ADDR'}.'): '.$reply);
7788: &log($udom,,$uname,$uhome,
7789: 'Authentication changed by '.$env{'user.domain'}.', '.
7790: $env{'user.name'}.', '.$umode.
7791: '(Remote '.$ENV{'REMOTE_ADDR'}.'): '.$reply);
7792: unless ($reply eq 'ok') {
7793: &logthis('Authentication mode error: '.$reply);
7794: return 'error: '.$reply;
7795: }
7796: return 'ok';
7797: }
7798:
7799: # --------------------------------------------------------------- Modify a user
7800:
7801: sub modifyuser {
7802: my ($udom, $uname, $uid,
7803: $umode, $upass, $first,
7804: $middle, $last, $gene,
7805: $forceid, $desiredhome, $email, $inststatus, $candelete)=@_;
7806: $udom= &LONCAPA::clean_domain($udom);
7807: $uname=&LONCAPA::clean_username($uname);
7808: my $showcandelete = 'none';
7809: if (ref($candelete) eq 'ARRAY') {
7810: if (@{$candelete} > 0) {
7811: $showcandelete = join(', ',@{$candelete});
7812: }
7813: }
7814: &logthis('Call to modify user '.$udom.', '.$uname.', '.$uid.', '.
7815: $umode.', '.$first.', '.$middle.', '.
7816: $last.', '.$gene.'(forceid: '.$forceid.'; candelete: '.$showcandelete.')'.
7817: (defined($desiredhome) ? ' desiredhome = '.$desiredhome :
7818: ' desiredhome not specified').
7819: ' by '.$env{'user.name'}.' at '.$env{'user.domain'}.
7820: ' in domain '.$env{'request.role.domain'});
7821: my $uhome=&homeserver($uname,$udom,'true');
7822: my $newuser;
7823: if ($uhome eq 'no_host') {
7824: $newuser = 1;
7825: }
7826: # ----------------------------------------------------------------- Create User
7827: if (($uhome eq 'no_host') &&
7828: (($umode && $upass) || ($umode eq 'localauth'))) {
7829: my $unhome='';
7830: if (defined($desiredhome) && &host_domain($desiredhome) eq $udom) {
7831: $unhome = $desiredhome;
7832: } elsif($env{'course.'.$env{'request.course.id'}.'.domain'} eq $udom) {
7833: $unhome=$env{'course.'.$env{'request.course.id'}.'.home'};
7834: } else { # load balancing routine for determining $unhome
7835: my $loadm=10000000;
7836: my %servers = &get_servers($udom,'library');
7837: foreach my $tryserver (keys(%servers)) {
7838: my $answer=reply('load',$tryserver);
7839: if (($answer=~/\d+/) && ($answer<$loadm)) {
7840: $loadm=$answer;
7841: $unhome=$tryserver;
7842: }
7843: }
7844: }
7845: if (($unhome eq '') || ($unhome eq 'no_host')) {
7846: return 'error: unable to find a home server for '.$uname.
7847: ' in domain '.$udom;
7848: }
7849: my $reply=&reply('encrypt:makeuser:'.$udom.':'.$uname.':'.$umode.':'.
7850: &escape($upass),$unhome);
7851: unless ($reply eq 'ok') {
7852: return 'error: '.$reply;
7853: }
7854: $uhome=&homeserver($uname,$udom,'true');
7855: if (($uhome eq '') || ($uhome eq 'no_host') || ($uhome ne $unhome)) {
7856: return 'error: unable verify users home machine.';
7857: }
7858: } # End of creation of new user
7859: # ---------------------------------------------------------------------- Add ID
7860: if ($uid) {
7861: $uid=~tr/A-Z/a-z/;
7862: my %uidhash=&idrget($udom,$uname);
7863: if (($uidhash{$uname}) && ($uidhash{$uname}!~/error\:/)
7864: && (!$forceid)) {
7865: unless ($uid eq $uidhash{$uname}) {
7866: return 'error: user id "'.$uid.'" does not match '.
7867: 'current user id "'.$uidhash{$uname}.'".';
7868: }
7869: } else {
7870: &idput($udom,($uname => $uid));
7871: }
7872: }
7873: # -------------------------------------------------------------- Add names, etc
7874: my @tmp=&get('environment',
7875: ['firstname','middlename','lastname','generation','id',
7876: 'permanentemail','inststatus'],
7877: $udom,$uname);
7878: my (%names,%oldnames);
7879: if ($tmp[0] =~ m/^error:.*/) {
7880: %names=();
7881: } else {
7882: %names = @tmp;
7883: %oldnames = %names;
7884: }
7885: #
7886: # If name, email and/or uid are blank (e.g., because an uploaded file
7887: # of users did not contain them), do not overwrite existing values
7888: # unless field is in $candelete array ref.
7889: #
7890:
7891: my @fields = ('firstname','middlename','lastname','generation',
7892: 'permanentemail','id');
7893: my %newvalues;
7894: if (ref($candelete) eq 'ARRAY') {
7895: foreach my $field (@fields) {
7896: if (grep(/^\Q$field\E$/,@{$candelete})) {
7897: if ($field eq 'firstname') {
7898: $names{$field} = $first;
7899: } elsif ($field eq 'middlename') {
7900: $names{$field} = $middle;
7901: } elsif ($field eq 'lastname') {
7902: $names{$field} = $last;
7903: } elsif ($field eq 'generation') {
7904: $names{$field} = $gene;
7905: } elsif ($field eq 'permanentemail') {
7906: $names{$field} = $email;
7907: } elsif ($field eq 'id') {
7908: $names{$field} = $uid;
7909: }
7910: }
7911: }
7912: }
7913: if ($first) { $names{'firstname'} = $first; }
7914: if (defined($middle)) { $names{'middlename'} = $middle; }
7915: if ($last) { $names{'lastname'} = $last; }
7916: if (defined($gene)) { $names{'generation'} = $gene; }
7917: if ($email) {
7918: $email=~s/[^\w\@\.\-\,]//gs;
7919: if ($email=~/\@/) { $names{'permanentemail'} = $email; }
7920: }
7921: if ($uid) { $names{'id'} = $uid; }
7922: if (defined($inststatus)) {
7923: $names{'inststatus'} = '';
7924: my ($usertypes,$typesorder) = &retrieve_inst_usertypes($udom);
7925: if (ref($usertypes) eq 'HASH') {
7926: my @okstatuses;
7927: foreach my $item (split(/:/,$inststatus)) {
7928: if (defined($usertypes->{$item})) {
7929: push(@okstatuses,$item);
7930: }
7931: }
7932: if (@okstatuses) {
7933: $names{'inststatus'} = join(':', map { &escape($_); } @okstatuses);
7934: }
7935: }
7936: }
7937: my $logmsg = $udom.', '.$uname.', '.$uid.', '.
7938: $umode.', '.$first.', '.$middle.', '.
7939: $last.', '.$gene.', '.$email.', '.$inststatus;
7940: if ($env{'user.name'} ne '' && $env{'user.domain'}) {
7941: $logmsg .= ' by '.$env{'user.name'}.' at '.$env{'user.domain'};
7942: } else {
7943: $logmsg .= ' during self creation';
7944: }
7945: my $changed;
7946: if ($newuser) {
7947: $changed = 1;
7948: } else {
7949: foreach my $field (@fields) {
7950: if ($names{$field} ne $oldnames{$field}) {
7951: $changed = 1;
7952: last;
7953: }
7954: }
7955: }
7956: unless ($changed) {
7957: $logmsg = 'No changes in user information needed for: '.$logmsg;
7958: &logthis($logmsg);
7959: return 'ok';
7960: }
7961: my $reply = &put('environment', \%names, $udom,$uname);
7962: if ($reply ne 'ok') {
7963: return 'error: '.$reply;
7964: }
7965: if ($names{'permanentemail'} ne $oldnames{'permanentemail'}) {
7966: &Apache::lonnet::devalidate_cache_new('emailscache',$uname.':'.$udom);
7967: }
7968: my $sqlresult = &update_allusers_table($uname,$udom,\%names);
7969: &devalidate_cache_new('namescache',$uname.':'.$udom);
7970: $logmsg = 'Success modifying user '.$logmsg;
7971: &logthis($logmsg);
7972: return 'ok';
7973: }
7974:
7975: # -------------------------------------------------------------- Modify student
7976:
7977: sub modifystudent {
7978: my ($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene,$usec,
7979: $end,$start,$forceid,$desiredhome,$email,$type,$locktype,$cid,
7980: $selfenroll,$context,$inststatus)=@_;
7981: if (!$cid) {
7982: unless ($cid=$env{'request.course.id'}) {
7983: return 'not_in_class';
7984: }
7985: }
7986: # --------------------------------------------------------------- Make the user
7987: my $reply=&modifyuser
7988: ($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene,$forceid,
7989: $desiredhome,$email,$inststatus);
7990: unless ($reply eq 'ok') { return $reply; }
7991: # This will cause &modify_student_enrollment to get the uid from the
7992: # students environment
7993: $uid = undef if (!$forceid);
7994: $reply = &modify_student_enrollment($udom,$uname,$uid,$first,$middle,$last,
7995: $gene,$usec,$end,$start,$type,$locktype,$cid,$selfenroll,$context);
7996: return $reply;
7997: }
7998:
7999: sub modify_student_enrollment {
8000: my ($udom,$uname,$uid,$first,$middle,$last,$gene,$usec,$end,$start,$type,$locktype,$cid,$selfenroll,$context) = @_;
8001: my ($cdom,$cnum,$chome);
8002: if (!$cid) {
8003: unless ($cid=$env{'request.course.id'}) {
8004: return 'not_in_class';
8005: }
8006: $cdom=$env{'course.'.$cid.'.domain'};
8007: $cnum=$env{'course.'.$cid.'.num'};
8008: } else {
8009: ($cdom,$cnum)=split(/_/,$cid);
8010: }
8011: $chome=$env{'course.'.$cid.'.home'};
8012: if (!$chome) {
8013: $chome=&homeserver($cnum,$cdom);
8014: }
8015: if (!$chome) { return 'unknown_course'; }
8016: # Make sure the user exists
8017: my $uhome=&homeserver($uname,$udom);
8018: if (($uhome eq '') || ($uhome eq 'no_host')) {
8019: return 'error: no such user';
8020: }
8021: # Get student data if we were not given enough information
8022: if (!defined($first) || $first eq '' ||
8023: !defined($last) || $last eq '' ||
8024: !defined($uid) || $uid eq '' ||
8025: !defined($middle) || $middle eq '' ||
8026: !defined($gene) || $gene eq '') {
8027: # They did not supply us with enough data to enroll the student, so
8028: # we need to pick up more information.
8029: my %tmp = &get('environment',
8030: ['firstname','middlename','lastname', 'generation','id']
8031: ,$udom,$uname);
8032:
8033: #foreach my $key (keys(%tmp)) {
8034: # &logthis("key $key = ".$tmp{$key});
8035: #}
8036: $first = $tmp{'firstname'} if (!defined($first) || $first eq '');
8037: $middle = $tmp{'middlename'} if (!defined($middle) || $middle eq '');
8038: $last = $tmp{'lastname'} if (!defined($last) || $last eq '');
8039: $gene = $tmp{'generation'} if (!defined($gene) || $gene eq '');
8040: $uid = $tmp{'id'} if (!defined($uid) || $uid eq '');
8041: }
8042: my $fullname = &format_name($first,$middle,$last,$gene,'lastname');
8043: my $user = "$uname:$udom";
8044: my %old_entry = &Apache::lonnet::get('classlist',[$user],$cdom,$cnum);
8045: my $reply=cput('classlist',
8046: {$user =>
8047: join(':',$end,$start,$uid,$usec,$fullname,$type,$locktype) },
8048: $cdom,$cnum);
8049: if (($reply eq 'ok') || ($reply eq 'delayed')) {
8050: &devalidate_getsection_cache($udom,$uname,$cid);
8051: } else {
8052: return 'error: '.$reply;
8053: }
8054: # Add student role to user
8055: my $uurl='/'.$cid;
8056: $uurl=~s/\_/\//g;
8057: if ($usec) {
8058: $uurl.='/'.$usec;
8059: }
8060: my $result = &assignrole($udom,$uname,$uurl,'st',$end,$start,undef,
8061: $selfenroll,$context);
8062: if ($result ne 'ok') {
8063: if ($old_entry{$user} ne '') {
8064: $reply = &cput('classlist',\%old_entry,$cdom,$cnum);
8065: } else {
8066: $reply = &del('classlist',[$user],$cdom,$cnum);
8067: }
8068: }
8069: return $result;
8070: }
8071:
8072: sub format_name {
8073: my ($firstname,$middlename,$lastname,$generation,$first)=@_;
8074: my $name;
8075: if ($first ne 'lastname') {
8076: $name=$firstname.' '.$middlename.' '.$lastname.' '.$generation;
8077: } else {
8078: if ($lastname=~/\S/) {
8079: $name.= $lastname.' '.$generation.', '.$firstname.' '.$middlename;
8080: $name=~s/\s+,/,/;
8081: } else {
8082: $name.= $firstname.' '.$middlename.' '.$generation;
8083: }
8084: }
8085: $name=~s/^\s+//;
8086: $name=~s/\s+$//;
8087: $name=~s/\s+/ /g;
8088: return $name;
8089: }
8090:
8091: # ------------------------------------------------- Write to course preferences
8092:
8093: sub writecoursepref {
8094: my ($courseid,%prefs)=@_;
8095: $courseid=~s/^\///;
8096: $courseid=~s/\_/\//g;
8097: my ($cdomain,$cnum)=split(/\//,$courseid);
8098: my $chome=homeserver($cnum,$cdomain);
8099: if (($chome eq '') || ($chome eq 'no_host')) {
8100: return 'error: no such course';
8101: }
8102: my $cstring='';
8103: foreach my $pref (keys(%prefs)) {
8104: $cstring.=&escape($pref).'='.&escape($prefs{$pref}).'&';
8105: }
8106: $cstring=~s/\&$//;
8107: return reply('put:'.$cdomain.':'.$cnum.':environment:'.$cstring,$chome);
8108: }
8109:
8110: # ---------------------------------------------------------- Make/modify course
8111:
8112: sub createcourse {
8113: my ($udom,$description,$url,$course_server,$nonstandard,$inst_code,
8114: $course_owner,$crstype,$cnum,$context,$category)=@_;
8115: $url=&declutter($url);
8116: my $cid='';
8117: if ($context eq 'requestcourses') {
8118: my $can_create = 0;
8119: my ($ownername,$ownerdom) = split(':',$course_owner);
8120: if ($udom eq $ownerdom) {
8121: if (&usertools_access($ownername,$ownerdom,$category,undef,
8122: $context)) {
8123: $can_create = 1;
8124: }
8125: } else {
8126: my %userenv = &userenvironment($ownerdom,$ownername,'reqcrsotherdom.'.
8127: $category);
8128: if ($userenv{'reqcrsotherdom.'.$category} ne '') {
8129: my @curr = split(',',$userenv{'reqcrsotherdom.'.$category});
8130: if (@curr > 0) {
8131: my @options = qw(approval validate autolimit);
8132: my $optregex = join('|',@options);
8133: if (grep(/^\Q$udom\E:($optregex)(=?\d*)$/,@curr)) {
8134: $can_create = 1;
8135: }
8136: }
8137: }
8138: }
8139: if ($can_create) {
8140: unless ($ownername eq $env{'user.name'} && $ownerdom eq $env{'user.domain'}) {
8141: unless (&allowed('ccc',$udom)) {
8142: return 'refused';
8143: }
8144: }
8145: } else {
8146: return 'refused';
8147: }
8148: } elsif (!&allowed('ccc',$udom)) {
8149: return 'refused';
8150: }
8151: # --------------------------------------------------------------- Get Unique ID
8152: my $uname;
8153: if ($cnum =~ /^$match_courseid$/) {
8154: my $chome=&homeserver($cnum,$udom,'true');
8155: if (($chome eq '') || ($chome eq 'no_host')) {
8156: $uname = $cnum;
8157: } else {
8158: $uname = &generate_coursenum($udom,$crstype);
8159: }
8160: } else {
8161: $uname = &generate_coursenum($udom,$crstype);
8162: }
8163: return $uname if ($uname =~ /^error/);
8164: # -------------------------------------------------- Check supplied server name
8165: if (!defined($course_server)) {
8166: if (defined(&domain($udom,'primary'))) {
8167: $course_server = &domain($udom,'primary');
8168: } else {
8169: $course_server = $env{'user.home'};
8170: }
8171: }
8172: my %host_servers =
8173: &Apache::lonnet::get_servers($udom,'library');
8174: unless ($host_servers{$course_server}) {
8175: return 'error: invalid home server for course: '.$course_server;
8176: }
8177: # ------------------------------------------------------------- Make the course
8178: my $reply=&reply('encrypt:makeuser:'.$udom.':'.$uname.':none::',
8179: $course_server);
8180: unless ($reply eq 'ok') { return 'error: '.$reply; }
8181: my $uhome=&homeserver($uname,$udom,'true');
8182: if (($uhome eq '') || ($uhome eq 'no_host')) {
8183: return 'error: no such course';
8184: }
8185: # ----------------------------------------------------------------- Course made
8186: # log existence
8187: my $now = time;
8188: my $newcourse = {
8189: $udom.'_'.$uname => {
8190: description => $description,
8191: inst_code => $inst_code,
8192: owner => $course_owner,
8193: type => $crstype,
8194: creator => $env{'user.name'}.':'.
8195: $env{'user.domain'},
8196: created => $now,
8197: context => $context,
8198: },
8199: };
8200: &courseidput($udom,$newcourse,$uhome,'notime');
8201: # set toplevel url
8202: my $topurl=$url;
8203: unless ($nonstandard) {
8204: # ------------------------------------------ For standard courses, make top url
8205: my $mapurl=&clutter($url);
8206: if ($mapurl eq '/res/') { $mapurl=''; }
8207: $env{'form.initmap'}=(<<ENDINITMAP);
8208: <map>
8209: <resource id="1" type="start"></resource>
8210: <resource id="2" src="$mapurl"></resource>
8211: <resource id="3" type="finish"></resource>
8212: <link index="1" from="1" to="2"></link>
8213: <link index="2" from="2" to="3"></link>
8214: </map>
8215: ENDINITMAP
8216: $topurl=&declutter(
8217: &finishuserfileupload($uname,$udom,'initmap','default.sequence')
8218: );
8219: }
8220: # ----------------------------------------------------------- Write preferences
8221: &writecoursepref($udom.'_'.$uname,
8222: ('description' => $description,
8223: 'url' => $topurl,
8224: 'internal.creator' => $env{'user.name'}.':'.
8225: $env{'user.domain'},
8226: 'internal.created' => $now,
8227: 'internal.creationcontext' => $context)
8228: );
8229: return '/'.$udom.'/'.$uname;
8230: }
8231:
8232: # ------------------------------------------------------------------- Create ID
8233: sub generate_coursenum {
8234: my ($udom,$crstype) = @_;
8235: my $domdesc = &domain($udom);
8236: return 'error: invalid domain' if ($domdesc eq '');
8237: my $first;
8238: if ($crstype eq 'Community') {
8239: $first = '0';
8240: } else {
8241: $first = int(1+rand(9));
8242: }
8243: my $uname=$first.
8244: ('a'..'z','A'..'Z','0'..'9')[int(rand(62))].
8245: substr($$.time,0,5).unpack("H8",pack("I32",time)).
8246: unpack("H2",pack("I32",int(rand(255)))).$perlvar{'lonHostID'};
8247: # ----------------------------------------------- Make sure that does not exist
8248: my $uhome=&homeserver($uname,$udom,'true');
8249: unless (($uhome eq '') || ($uhome eq 'no_host')) {
8250: if ($crstype eq 'Community') {
8251: $first = '0';
8252: } else {
8253: $first = int(1+rand(9));
8254: }
8255: $uname=$first.
8256: ('a'..'z','A'..'Z','0'..'9')[int(rand(62))].
8257: substr($$.time,0,5).unpack("H8",pack("I32",time)).
8258: unpack("H2",pack("I32",int(rand(255)))).$perlvar{'lonHostID'};
8259: $uhome=&homeserver($uname,$udom,'true');
8260: unless (($uhome eq '') || ($uhome eq 'no_host')) {
8261: return 'error: unable to generate unique course-ID';
8262: }
8263: }
8264: return $uname;
8265: }
8266:
8267: sub is_course {
8268: my ($cdom, $cnum) = scalar(@_) == 1 ?
8269: ($_[0] =~ /^($match_domain)_($match_courseid)$/) : @_;
8270:
8271: return unless $cdom and $cnum;
8272:
8273: my %courses = &courseiddump($cdom, '.', 1, '.', '.', $cnum, undef, undef,
8274: '.');
8275:
8276: return unless exists($courses{$cdom.'_'.$cnum});
8277: return wantarray ? ($cdom, $cnum) : $cdom.'_'.$cnum;
8278: }
8279:
8280: sub store_userdata {
8281: my ($storehash,$datakey,$namespace,$udom,$uname) = @_;
8282: my $result;
8283: if ($datakey ne '') {
8284: if (ref($storehash) eq 'HASH') {
8285: if ($udom eq '' || $uname eq '') {
8286: $udom = $env{'user.domain'};
8287: $uname = $env{'user.name'};
8288: }
8289: my $uhome=&homeserver($uname,$udom);
8290: if (($uhome eq '') || ($uhome eq 'no_host')) {
8291: $result = 'error: no_host';
8292: } else {
8293: $storehash->{'ip'} = $ENV{'REMOTE_ADDR'};
8294: $storehash->{'host'} = $perlvar{'lonHostID'};
8295:
8296: my $namevalue='';
8297: foreach my $key (keys(%{$storehash})) {
8298: $namevalue.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
8299: }
8300: $namevalue=~s/\&$//;
8301: $result = &reply("store:$udom:$uname:$namespace:$datakey:".
8302: $namevalue,$uhome);
8303: }
8304: } else {
8305: $result = 'error: data to store was not a hash reference';
8306: }
8307: } else {
8308: $result= 'error: invalid requestkey';
8309: }
8310: return $result;
8311: }
8312:
8313: # ---------------------------------------------------------- Assign Custom Role
8314:
8315: sub assigncustomrole {
8316: my ($udom,$uname,$url,$rdom,$rnam,$rolename,$end,$start,$deleteflag,$selfenroll,$context)=@_;
8317: return &assignrole($udom,$uname,$url,'cr/'.$rdom.'/'.$rnam.'/'.$rolename,
8318: $end,$start,$deleteflag,$selfenroll,$context);
8319: }
8320:
8321: # ----------------------------------------------------------------- Revoke Role
8322:
8323: sub revokerole {
8324: my ($udom,$uname,$url,$role,$deleteflag,$selfenroll,$context)=@_;
8325: my $now=time;
8326: return &assignrole($udom,$uname,$url,$role,$now,undef,$deleteflag,$selfenroll,$context);
8327: }
8328:
8329: # ---------------------------------------------------------- Revoke Custom Role
8330:
8331: sub revokecustomrole {
8332: my ($udom,$uname,$url,$rdom,$rnam,$rolename,$deleteflag,$selfenroll,$context)=@_;
8333: my $now=time;
8334: return &assigncustomrole($udom,$uname,$url,$rdom,$rnam,$rolename,$now,
8335: $deleteflag,$selfenroll,$context);
8336: }
8337:
8338: # ------------------------------------------------------------ Disk usage
8339: sub diskusage {
8340: my ($udom,$uname,$directorypath,$getpropath)=@_;
8341: $directorypath =~ s/\/$//;
8342: my $listing=&reply('du2:'.&escape($directorypath).':'
8343: .&escape($getpropath).':'.&escape($uname).':'
8344: .&escape($udom),homeserver($uname,$udom));
8345: if ($listing eq 'unknown_cmd') {
8346: if ($getpropath) {
8347: $directorypath = &propath($udom,$uname).'/'.$directorypath;
8348: }
8349: $listing = &reply('du:'.$directorypath,homeserver($uname,$udom));
8350: }
8351: return $listing;
8352: }
8353:
8354: sub is_locked {
8355: my ($file_name, $domain, $user, $which) = @_;
8356: my @check;
8357: my $is_locked;
8358: push (@check,$file_name);
8359: my %locked = &get('file_permissions',\@check,
8360: $env{'user.domain'},$env{'user.name'});
8361: my ($tmp)=keys(%locked);
8362: if ($tmp=~/^error:/) { undef(%locked); }
8363:
8364: if (ref($locked{$file_name}) eq 'ARRAY') {
8365: $is_locked = 'false';
8366: foreach my $entry (@{$locked{$file_name}}) {
8367: if (ref($entry) eq 'ARRAY') {
8368: $is_locked = 'true';
8369: if (ref($which) eq 'ARRAY') {
8370: push(@{$which},$entry);
8371: } else {
8372: last;
8373: }
8374: }
8375: }
8376: } else {
8377: $is_locked = 'false';
8378: }
8379: return $is_locked;
8380: }
8381:
8382: sub declutter_portfile {
8383: my ($file) = @_;
8384: $file =~ s{^(/portfolio/|portfolio/)}{/};
8385: return $file;
8386: }
8387:
8388: # ------------------------------------------------------------- Mark as Read Only
8389:
8390: sub mark_as_readonly {
8391: my ($domain,$user,$files,$what) = @_;
8392: my %current_permissions = &dump('file_permissions',$domain,$user);
8393: my ($tmp)=keys(%current_permissions);
8394: if ($tmp=~/^error:/) { undef(%current_permissions); }
8395: foreach my $file (@{$files}) {
8396: $file = &declutter_portfile($file);
8397: push(@{$current_permissions{$file}},$what);
8398: }
8399: &put('file_permissions',\%current_permissions,$domain,$user);
8400: return;
8401: }
8402:
8403: # ------------------------------------------------------------Save Selected Files
8404:
8405: sub save_selected_files {
8406: my ($user, $path, @files) = @_;
8407: my $filename = $user."savedfiles";
8408: my @other_files = &files_not_in_path($user, $path);
8409: open (OUT, '>'.$tmpdir.$filename);
8410: foreach my $file (@files) {
8411: print (OUT $env{'form.currentpath'}.$file."\n");
8412: }
8413: foreach my $file (@other_files) {
8414: print (OUT $file."\n");
8415: }
8416: close (OUT);
8417: return 'ok';
8418: }
8419:
8420: sub clear_selected_files {
8421: my ($user) = @_;
8422: my $filename = $user."savedfiles";
8423: open (OUT, '>'.LONCAPA::tempdir().$filename);
8424: print (OUT undef);
8425: close (OUT);
8426: return ("ok");
8427: }
8428:
8429: sub files_in_path {
8430: my ($user, $path) = @_;
8431: my $filename = $user."savedfiles";
8432: my %return_files;
8433: open (IN, '<'.LONCAPA::tempdir().$filename);
8434: while (my $line_in = <IN>) {
8435: chomp ($line_in);
8436: my @paths_and_file = split (m!/!, $line_in);
8437: my $file_part = pop (@paths_and_file);
8438: my $path_part = join ('/', @paths_and_file);
8439: $path_part.='/';
8440: my $path_and_file = $path_part.$file_part;
8441: if ($path_part eq $path) {
8442: $return_files{$file_part}= 'selected';
8443: }
8444: }
8445: close (IN);
8446: return (\%return_files);
8447: }
8448:
8449: # called in portfolio select mode, to show files selected NOT in current directory
8450: sub files_not_in_path {
8451: my ($user, $path) = @_;
8452: my $filename = $user."savedfiles";
8453: my @return_files;
8454: my $path_part;
8455: open(IN, '<'.LONCAPA::.$filename);
8456: while (my $line = <IN>) {
8457: #ok, I know it's clunky, but I want it to work
8458: my @paths_and_file = split(m|/|, $line);
8459: my $file_part = pop(@paths_and_file);
8460: chomp($file_part);
8461: my $path_part = join('/', @paths_and_file);
8462: $path_part .= '/';
8463: my $path_and_file = $path_part.$file_part;
8464: if ($path_part ne $path) {
8465: push(@return_files, ($path_and_file));
8466: }
8467: }
8468: close(OUT);
8469: return (@return_files);
8470: }
8471:
8472: #----------------------------------------------Get portfolio file permissions
8473:
8474: sub get_portfile_permissions {
8475: my ($domain,$user) = @_;
8476: my %current_permissions = &dump('file_permissions',$domain,$user);
8477: my ($tmp)=keys(%current_permissions);
8478: if ($tmp=~/^error:/) { undef(%current_permissions); }
8479: return \%current_permissions;
8480: }
8481:
8482: #---------------------------------------------Get portfolio file access controls
8483:
8484: sub get_access_controls {
8485: my ($current_permissions,$group,$file) = @_;
8486: my %access;
8487: my $real_file = $file;
8488: $file =~ s/\.meta$//;
8489: if (defined($file)) {
8490: if (ref($$current_permissions{$file."\0".'accesscontrol'}) eq 'HASH') {
8491: foreach my $control (keys(%{$$current_permissions{$file."\0".'accesscontrol'}})) {
8492: $access{$real_file}{$control} = $$current_permissions{$file."\0".$control};
8493: }
8494: }
8495: } else {
8496: foreach my $key (keys(%{$current_permissions})) {
8497: if ($key =~ /\0accesscontrol$/) {
8498: if (defined($group)) {
8499: if ($key !~ m-^\Q$group\E/-) {
8500: next;
8501: }
8502: }
8503: my ($fullpath) = split(/\0/,$key);
8504: if (ref($$current_permissions{$key}) eq 'HASH') {
8505: foreach my $control (keys(%{$$current_permissions{$key}})) {
8506: $access{$fullpath}{$control}=$$current_permissions{$fullpath."\0".$control};
8507: }
8508: }
8509: }
8510: }
8511: }
8512: return %access;
8513: }
8514:
8515: sub modify_access_controls {
8516: my ($file_name,$changes,$domain,$user)=@_;
8517: my ($outcome,$deloutcome);
8518: my %store_permissions;
8519: my %new_values;
8520: my %new_control;
8521: my %translation;
8522: my @deletions = ();
8523: my $now = time;
8524: if (exists($$changes{'activate'})) {
8525: if (ref($$changes{'activate'}) eq 'HASH') {
8526: my @newitems = sort(keys(%{$$changes{'activate'}}));
8527: my $numnew = scalar(@newitems);
8528: for (my $i=0; $i<$numnew; $i++) {
8529: my $newkey = $newitems[$i];
8530: my $newid = &Apache::loncommon::get_cgi_id();
8531: if ($newkey =~ /^\d+:/) {
8532: $newkey =~ s/^(\d+)/$newid/;
8533: $translation{$1} = $newid;
8534: } elsif ($newkey =~ /^\d+_\d+_\d+:/) {
8535: $newkey =~ s/^(\d+_\d+_\d+)/$newid/;
8536: $translation{$1} = $newid;
8537: }
8538: $new_values{$file_name."\0".$newkey} =
8539: $$changes{'activate'}{$newitems[$i]};
8540: $new_control{$newkey} = $now;
8541: }
8542: }
8543: }
8544: my %todelete;
8545: my %changed_items;
8546: foreach my $action ('delete','update') {
8547: if (exists($$changes{$action})) {
8548: if (ref($$changes{$action}) eq 'HASH') {
8549: foreach my $key (keys(%{$$changes{$action}})) {
8550: my ($itemnum) = ($key =~ /^([^:]+):/);
8551: if ($action eq 'delete') {
8552: $todelete{$itemnum} = 1;
8553: } else {
8554: $changed_items{$itemnum} = $key;
8555: }
8556: }
8557: }
8558: }
8559: }
8560: # get lock on access controls for file.
8561: my $lockhash = {
8562: $file_name."\0".'locked_access_records' => $env{'user.name'}.
8563: ':'.$env{'user.domain'},
8564: };
8565: my $tries = 0;
8566: my $gotlock = &newput('file_permissions',$lockhash,$domain,$user);
8567:
8568: while (($gotlock ne 'ok') && $tries <3) {
8569: $tries ++;
8570: sleep 1;
8571: $gotlock = &newput('file_permissions',$lockhash,$domain,$user);
8572: }
8573: if ($gotlock eq 'ok') {
8574: my %curr_permissions = &dump('file_permissions',$domain,$user,$file_name);
8575: my ($tmp)=keys(%curr_permissions);
8576: if ($tmp=~/^error:/) { undef(%curr_permissions); }
8577: if (exists($curr_permissions{$file_name."\0".'accesscontrol'})) {
8578: my $curr_controls = $curr_permissions{$file_name."\0".'accesscontrol'};
8579: if (ref($curr_controls) eq 'HASH') {
8580: foreach my $control_item (keys(%{$curr_controls})) {
8581: my ($itemnum) = ($control_item =~ /^([^:]+):/);
8582: if (defined($todelete{$itemnum})) {
8583: push(@deletions,$file_name."\0".$control_item);
8584: } else {
8585: if (defined($changed_items{$itemnum})) {
8586: $new_control{$changed_items{$itemnum}} = $now;
8587: push(@deletions,$file_name."\0".$control_item);
8588: $new_values{$file_name."\0".$changed_items{$itemnum}} = $$changes{'update'}{$changed_items{$itemnum}};
8589: } else {
8590: $new_control{$control_item} = $$curr_controls{$control_item};
8591: }
8592: }
8593: }
8594: }
8595: }
8596: my ($group);
8597: if (&is_course($domain,$user)) {
8598: ($group,my $file) = split(/\//,$file_name,2);
8599: }
8600: $deloutcome = &del('file_permissions',\@deletions,$domain,$user);
8601: $new_values{$file_name."\0".'accesscontrol'} = \%new_control;
8602: $outcome = &put('file_permissions',\%new_values,$domain,$user);
8603: # remove lock
8604: my @del_lock = ($file_name."\0".'locked_access_records');
8605: my $dellockoutcome = &del('file_permissions',\@del_lock,$domain,$user);
8606: my $sqlresult =
8607: &update_portfolio_table($user,$domain,$file_name,'portfolio_access',
8608: $group);
8609: } else {
8610: $outcome = "error: could not obtain lockfile\n";
8611: }
8612: return ($outcome,$deloutcome,\%new_values,\%translation);
8613: }
8614:
8615: sub make_public_indefinitely {
8616: my ($requrl) = @_;
8617: my $now = time;
8618: my $action = 'activate';
8619: my $aclnum = 0;
8620: if (&is_portfolio_url($requrl)) {
8621: my (undef,$udom,$unum,$file_name,$group) =
8622: &parse_portfolio_url($requrl);
8623: my $current_perms = &get_portfile_permissions($udom,$unum);
8624: my %access_controls = &get_access_controls($current_perms,
8625: $group,$file_name);
8626: foreach my $key (keys(%{$access_controls{$file_name}})) {
8627: my ($num,$scope,$end,$start) =
8628: ($key =~ /^([^:]+):([a-z]+)_(\d*)_?(\d*)$/);
8629: if ($scope eq 'public') {
8630: if ($start <= $now && $end == 0) {
8631: $action = 'none';
8632: } else {
8633: $action = 'update';
8634: $aclnum = $num;
8635: }
8636: last;
8637: }
8638: }
8639: if ($action eq 'none') {
8640: return 'ok';
8641: } else {
8642: my %changes;
8643: my $newend = 0;
8644: my $newstart = $now;
8645: my $newkey = $aclnum.':public_'.$newend.'_'.$newstart;
8646: $changes{$action}{$newkey} = {
8647: type => 'public',
8648: time => {
8649: start => $newstart,
8650: end => $newend,
8651: },
8652: };
8653: my ($outcome,$deloutcome,$new_values,$translation) =
8654: &modify_access_controls($file_name,\%changes,$udom,$unum);
8655: return $outcome;
8656: }
8657: } else {
8658: return 'invalid';
8659: }
8660: }
8661:
8662: #------------------------------------------------------Get Marked as Read Only
8663:
8664: sub get_marked_as_readonly {
8665: my ($domain,$user,$what,$group) = @_;
8666: my $current_permissions = &get_portfile_permissions($domain,$user);
8667: my @readonly_files;
8668: my $cmp1=$what;
8669: if (ref($what)) { $cmp1=join('',@{$what}) };
8670: while (my ($file_name,$value) = each(%{$current_permissions})) {
8671: if (defined($group)) {
8672: if ($file_name !~ m-^\Q$group\E/-) {
8673: next;
8674: }
8675: }
8676: if (ref($value) eq "ARRAY"){
8677: foreach my $stored_what (@{$value}) {
8678: my $cmp2=$stored_what;
8679: if (ref($stored_what) eq 'ARRAY') {
8680: $cmp2=join('',@{$stored_what});
8681: }
8682: if ($cmp1 eq $cmp2) {
8683: push(@readonly_files, $file_name);
8684: last;
8685: } elsif (!defined($what)) {
8686: push(@readonly_files, $file_name);
8687: last;
8688: }
8689: }
8690: }
8691: }
8692: return @readonly_files;
8693: }
8694: #-----------------------------------------------------------Get Marked as Read Only Hash
8695:
8696: sub get_marked_as_readonly_hash {
8697: my ($current_permissions,$group,$what) = @_;
8698: my %readonly_files;
8699: while (my ($file_name,$value) = each(%{$current_permissions})) {
8700: if (defined($group)) {
8701: if ($file_name !~ m-^\Q$group\E/-) {
8702: next;
8703: }
8704: }
8705: if (ref($value) eq "ARRAY"){
8706: foreach my $stored_what (@{$value}) {
8707: if (ref($stored_what) eq 'ARRAY') {
8708: foreach my $lock_descriptor(@{$stored_what}) {
8709: if ($lock_descriptor eq 'graded') {
8710: $readonly_files{$file_name} = 'graded';
8711: } elsif ($lock_descriptor eq 'handback') {
8712: $readonly_files{$file_name} = 'handback';
8713: } else {
8714: if (!exists($readonly_files{$file_name})) {
8715: $readonly_files{$file_name} = 'locked';
8716: }
8717: }
8718: }
8719: }
8720: }
8721: }
8722: }
8723: return %readonly_files;
8724: }
8725: # ------------------------------------------------------------ Unmark as Read Only
8726:
8727: sub unmark_as_readonly {
8728: # unmarks $file_name (if $file_name is defined), or all files locked by $what
8729: # for portfolio submissions, $what contains [$symb,$crsid]
8730: my ($domain,$user,$what,$file_name,$group) = @_;
8731: $file_name = &declutter_portfile($file_name);
8732: my $symb_crs = $what;
8733: if (ref($what)) { $symb_crs=join('',@$what); }
8734: my %current_permissions = &dump('file_permissions',$domain,$user,$group);
8735: my ($tmp)=keys(%current_permissions);
8736: if ($tmp=~/^error:/) { undef(%current_permissions); }
8737: my @readonly_files = &get_marked_as_readonly($domain,$user,$what,$group);
8738: foreach my $file (@readonly_files) {
8739: my $clean_file = &declutter_portfile($file);
8740: if (defined($file_name) && ($file_name ne $clean_file)) { next; }
8741: my $current_locks = $current_permissions{$file};
8742: my @new_locks;
8743: my @del_keys;
8744: if (ref($current_locks) eq "ARRAY"){
8745: foreach my $locker (@{$current_locks}) {
8746: my $compare=$locker;
8747: if (ref($locker) eq 'ARRAY') {
8748: $compare=join('',@{$locker});
8749: if ($compare ne $symb_crs) {
8750: push(@new_locks, $locker);
8751: }
8752: }
8753: }
8754: if (scalar(@new_locks) > 0) {
8755: $current_permissions{$file} = \@new_locks;
8756: } else {
8757: push(@del_keys, $file);
8758: &del('file_permissions',\@del_keys, $domain, $user);
8759: delete($current_permissions{$file});
8760: }
8761: }
8762: }
8763: &put('file_permissions',\%current_permissions,$domain,$user);
8764: return;
8765: }
8766:
8767: # ------------------------------------------------------------ Directory lister
8768:
8769: sub dirlist {
8770: my ($uri,$userdomain,$username,$getpropath,$getuserdir,$alternateRoot)=@_;
8771: $uri=~s/^\///;
8772: $uri=~s/\/$//;
8773: my ($udom, $uname);
8774: if ($getuserdir) {
8775: $udom = $userdomain;
8776: $uname = $username;
8777: } else {
8778: (undef,$udom,$uname)=split(/\//,$uri);
8779: if(defined($userdomain)) {
8780: $udom = $userdomain;
8781: }
8782: if(defined($username)) {
8783: $uname = $username;
8784: }
8785: }
8786: my ($dirRoot,$listing,@listing_results);
8787:
8788: $dirRoot = $perlvar{'lonDocRoot'};
8789: if (defined($getpropath)) {
8790: $dirRoot = &propath($udom,$uname);
8791: $dirRoot =~ s/\/$//;
8792: } elsif (defined($getuserdir)) {
8793: my $subdir=$uname.'__';
8794: $subdir =~ s/(.)(.)(.).*/$1\/$2\/$3/;
8795: $dirRoot = $Apache::lonnet::perlvar{'lonUsersDir'}
8796: ."/$udom/$subdir/$uname";
8797: } elsif (defined($alternateRoot)) {
8798: $dirRoot = $alternateRoot;
8799: }
8800:
8801: if($udom) {
8802: if($uname) {
8803: my $uhome = &homeserver($uname,$udom);
8804: if ($uhome eq 'no_host') {
8805: return ([],'no_host');
8806: }
8807: $listing = &reply('ls3:'.&escape('/'.$uri).':'.$getpropath.':'
8808: .$getuserdir.':'.&escape($dirRoot)
8809: .':'.&escape($uname).':'.&escape($udom),$uhome);
8810: if ($listing eq 'unknown_cmd') {
8811: $listing = &reply('ls2:'.$dirRoot.'/'.$uri,$uhome);
8812: } else {
8813: @listing_results = map { &unescape($_); } split(/:/,$listing);
8814: }
8815: if ($listing eq 'unknown_cmd') {
8816: $listing = &reply('ls:'.$dirRoot.'/'.$uri,$uhome);
8817: @listing_results = split(/:/,$listing);
8818: } else {
8819: @listing_results = map { &unescape($_); } split(/:/,$listing);
8820: }
8821: if (($listing eq 'no_such_host') || ($listing eq 'con_lost') ||
8822: ($listing eq 'rejected') || ($listing eq 'refused') ||
8823: ($listing eq 'no_such_dir') || ($listing eq 'empty')) {
8824: return ([],$listing);
8825: } else {
8826: return (\@listing_results);
8827: }
8828: } elsif(!$alternateRoot) {
8829: my (%allusers,%listerror);
8830: my %servers = &get_servers($udom,'library');
8831: foreach my $tryserver (keys(%servers)) {
8832: $listing = &reply('ls3:'.&escape("/res/$udom").':::::'.
8833: &escape($udom),$tryserver);
8834: if ($listing eq 'unknown_cmd') {
8835: $listing = &reply('ls2:'.$perlvar{'lonDocRoot'}.'/res/'.
8836: $udom, $tryserver);
8837: } else {
8838: @listing_results = map { &unescape($_); } split(/:/,$listing);
8839: }
8840: if ($listing eq 'unknown_cmd') {
8841: $listing = &reply('ls:'.$perlvar{'lonDocRoot'}.'/res/'.
8842: $udom, $tryserver);
8843: @listing_results = split(/:/,$listing);
8844: } else {
8845: @listing_results =
8846: map { &unescape($_); } split(/:/,$listing);
8847: }
8848: if (($listing eq 'no_such_host') || ($listing eq 'con_lost') ||
8849: ($listing eq 'rejected') || ($listing eq 'refused') ||
8850: ($listing eq 'no_such_dir') || ($listing eq 'empty')) {
8851: $listerror{$tryserver} = $listing;
8852: } else {
8853: foreach my $line (@listing_results) {
8854: my ($entry) = split(/&/,$line,2);
8855: $allusers{$entry} = 1;
8856: }
8857: }
8858: }
8859: my @alluserslist=();
8860: foreach my $user (sort(keys(%allusers))) {
8861: push(@alluserslist,$user.'&user');
8862: }
8863: return (\@alluserslist);
8864: } else {
8865: return ([],'missing username');
8866: }
8867: } elsif(!defined($getpropath)) {
8868: my $path = $perlvar{'lonDocRoot'}.'/res/';
8869: my @all_domains = map { $path.$_.'/&domain'; } (sort(&all_domains()));
8870: return (\@all_domains);
8871: } else {
8872: return ([],'missing domain');
8873: }
8874: }
8875:
8876: # --------------------------------------------- GetFileTimestamp
8877: # This function utilizes dirlist and returns the date stamp for
8878: # when it was last modified. It will also return an error of -1
8879: # if an error occurs
8880:
8881: sub GetFileTimestamp {
8882: my ($studentDomain,$studentName,$filename,$getuserdir)=@_;
8883: $studentDomain = &LONCAPA::clean_domain($studentDomain);
8884: $studentName = &LONCAPA::clean_username($studentName);
8885: my ($fileref,$error) = &dirlist($filename,$studentDomain,$studentName,
8886: undef,$getuserdir);
8887: if (($error eq 'empty') || ($error eq 'no_such_dir')) {
8888: return -1;
8889: }
8890: if (ref($fileref) eq 'ARRAY') {
8891: my @stats = split('&',$fileref->[0]);
8892: # @stats contains first the filename, then the stat output
8893: return $stats[10]; # so this is 10 instead of 9.
8894: } else {
8895: return -1;
8896: }
8897: }
8898:
8899: sub stat_file {
8900: my ($uri) = @_;
8901: $uri = &clutter_with_no_wrapper($uri);
8902:
8903: my ($udom,$uname,$file);
8904: if ($uri =~ m-^/(uploaded|editupload)/-) {
8905: ($udom,$uname,$file) =
8906: ($uri =~ m-/(?:uploaded|editupload)/?($match_domain)/?($match_name)/?(.*)-);
8907: $file = 'userfiles/'.$file;
8908: }
8909: if ($uri =~ m-^/res/-) {
8910: ($udom,$uname) =
8911: ($uri =~ m-/(?:res)/?($match_domain)/?($match_username)/-);
8912: $file = $uri;
8913: }
8914:
8915: if (!$udom || !$uname || !$file) {
8916: # unable to handle the uri
8917: return ();
8918: }
8919: my $getpropath;
8920: if ($file =~ /^userfiles\//) {
8921: $getpropath = 1;
8922: }
8923: my ($listref,$error) = &dirlist($file,$udom,$uname,$getpropath);
8924: if (($error eq 'empty') || ($error eq 'no_such_dir')) {
8925: return ();
8926: } else {
8927: if (ref($listref) eq 'ARRAY') {
8928: my @stats = split('&',$listref->[0]);
8929: shift(@stats); #filename is first
8930: return @stats;
8931: }
8932: }
8933: return ();
8934: }
8935:
8936: # -------------------------------------------------------- Value of a Condition
8937:
8938: # gets the value of a specific preevaluated condition
8939: # stored in the string $env{user.state.<cid>}
8940: # or looks up a condition reference in the bighash and if if hasn't
8941: # already been evaluated recurses into docondval to get the value of
8942: # the condition, then memoizing it to
8943: # $env{user.state.<cid>.<condition>}
8944: sub directcondval {
8945: my $number=shift;
8946: if (!defined($env{'user.state.'.$env{'request.course.id'}})) {
8947: &Apache::lonuserstate::evalstate();
8948: }
8949: if (exists($env{'user.state.'.$env{'request.course.id'}.".$number"})) {
8950: return $env{'user.state.'.$env{'request.course.id'}.".$number"};
8951: } elsif ($number =~ /^_/) {
8952: my $sub_condition;
8953: if (tie(my %bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
8954: &GDBM_READER(),0640)) {
8955: $sub_condition=$bighash{'conditions'.$number};
8956: untie(%bighash);
8957: }
8958: my $value = &docondval($sub_condition);
8959: &appenv({'user.state.'.$env{'request.course.id'}.".$number" => $value});
8960: return $value;
8961: }
8962: if ($env{'user.state.'.$env{'request.course.id'}}) {
8963: return substr($env{'user.state.'.$env{'request.course.id'}},$number,1);
8964: } else {
8965: return 2;
8966: }
8967: }
8968:
8969: # get the collection of conditions for this resource
8970: sub condval {
8971: my $condidx=shift;
8972: my $allpathcond='';
8973: foreach my $cond (split(/\|/,$condidx)) {
8974: if (defined($env{'acc.cond.'.$env{'request.course.id'}.'.'.$cond})) {
8975: $allpathcond.=
8976: '('.$env{'acc.cond.'.$env{'request.course.id'}.'.'.$cond}.')|';
8977: }
8978: }
8979: $allpathcond=~s/\|$//;
8980: return &docondval($allpathcond);
8981: }
8982:
8983: #evaluates an expression of conditions
8984: sub docondval {
8985: my ($allpathcond) = @_;
8986: my $result=0;
8987: if ($env{'request.course.id'}
8988: && defined($allpathcond)) {
8989: my $operand='|';
8990: my @stack;
8991: foreach my $chunk ($allpathcond=~/(\d+|_\d+\.\d+|\(|\)|\&|\|)/g) {
8992: if ($chunk eq '(') {
8993: push @stack,($operand,$result);
8994: } elsif ($chunk eq ')') {
8995: my $before=pop @stack;
8996: if (pop @stack eq '&') {
8997: $result=$result>$before?$before:$result;
8998: } else {
8999: $result=$result>$before?$result:$before;
9000: }
9001: } elsif (($chunk eq '&') || ($chunk eq '|')) {
9002: $operand=$chunk;
9003: } else {
9004: my $new=directcondval($chunk);
9005: if ($operand eq '&') {
9006: $result=$result>$new?$new:$result;
9007: } else {
9008: $result=$result>$new?$result:$new;
9009: }
9010: }
9011: }
9012: }
9013: return $result;
9014: }
9015:
9016: # ---------------------------------------------------- Devalidate courseresdata
9017:
9018: sub devalidatecourseresdata {
9019: my ($coursenum,$coursedomain)=@_;
9020: my $hashid=$coursenum.':'.$coursedomain;
9021: &devalidate_cache_new('courseres',$hashid);
9022: }
9023:
9024:
9025: # --------------------------------------------------- Course Resourcedata Query
9026: #
9027: # Parameters:
9028: # $coursenum - Number of the course.
9029: # $coursedomain - Domain at which the course was created.
9030: # Returns:
9031: # A hash of the course parameters along (I think) with timestamps
9032: # and version info.
9033:
9034: sub get_courseresdata {
9035: my ($coursenum,$coursedomain)=@_;
9036: my $coursehom=&homeserver($coursenum,$coursedomain);
9037: my $hashid=$coursenum.':'.$coursedomain;
9038: my ($result,$cached)=&is_cached_new('courseres',$hashid);
9039: my %dumpreply;
9040: unless (defined($cached)) {
9041: %dumpreply=&dump('resourcedata',$coursedomain,$coursenum);
9042: $result=\%dumpreply;
9043: my ($tmp) = keys(%dumpreply);
9044: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
9045: &do_cache_new('courseres',$hashid,$result,600);
9046: } elsif ($tmp =~ /^(con_lost|no_such_host)/) {
9047: return $tmp;
9048: } elsif ($tmp =~ /^(error)/) {
9049: $result=undef;
9050: &do_cache_new('courseres',$hashid,$result,600);
9051: }
9052: }
9053: return $result;
9054: }
9055:
9056: sub devalidateuserresdata {
9057: my ($uname,$udom)=@_;
9058: my $hashid="$udom:$uname";
9059: &devalidate_cache_new('userres',$hashid);
9060: }
9061:
9062: sub get_userresdata {
9063: my ($uname,$udom)=@_;
9064: #most student don\'t have any data set, check if there is some data
9065: if (&EXT_cache_status($udom,$uname)) { return undef; }
9066:
9067: my $hashid="$udom:$uname";
9068: my ($result,$cached)=&is_cached_new('userres',$hashid);
9069: if (!defined($cached)) {
9070: my %resourcedata=&dump('resourcedata',$udom,$uname);
9071: $result=\%resourcedata;
9072: &do_cache_new('userres',$hashid,$result,600);
9073: }
9074: my ($tmp)=keys(%$result);
9075: if (($tmp!~/^error\:/) && ($tmp!~/^con_lost/)) {
9076: return $result;
9077: }
9078: #error 2 occurs when the .db doesn't exist
9079: if ($tmp!~/error: 2 /) {
9080: &logthis("<font color=\"blue\">WARNING:".
9081: " Trying to get resource data for ".
9082: $uname." at ".$udom.": ".
9083: $tmp."</font>");
9084: } elsif ($tmp=~/error: 2 /) {
9085: #&EXT_cache_set($udom,$uname);
9086: &do_cache_new('userres',$hashid,undef,600);
9087: undef($tmp); # not really an error so don't send it back
9088: }
9089: return $tmp;
9090: }
9091: #----------------------------------------------- resdata - return resource data
9092: # Purpose:
9093: # Return resource data for either users or for a course.
9094: # Parameters:
9095: # $name - Course/user name.
9096: # $domain - Name of the domain the user/course is registered on.
9097: # $type - Type of thing $name is (must be 'course' or 'user'
9098: # @which - Array of names of resources desired.
9099: # Returns:
9100: # The value of the first reasource in @which that is found in the
9101: # resource hash.
9102: # Exceptional Conditions:
9103: # If the $type passed in is not valid (not the string 'course' or
9104: # 'user', an undefined reference is returned.
9105: # If none of the resources are found, an undef is returned
9106: sub resdata {
9107: my ($name,$domain,$type,@which)=@_;
9108: my $result;
9109: if ($type eq 'course') {
9110: $result=&get_courseresdata($name,$domain);
9111: } elsif ($type eq 'user') {
9112: $result=&get_userresdata($name,$domain);
9113: }
9114: if (!ref($result)) { return $result; }
9115: foreach my $item (@which) {
9116: if (defined($result->{$item->[0]})) {
9117: return [$result->{$item->[0]},$item->[1]];
9118: }
9119: }
9120: return undef;
9121: }
9122:
9123: #
9124: # EXT resource caching routines
9125: #
9126:
9127: sub clear_EXT_cache_status {
9128: &delenv('cache.EXT.');
9129: }
9130:
9131: sub EXT_cache_status {
9132: my ($target_domain,$target_user) = @_;
9133: my $cachename = 'cache.EXT.'.$target_user.'.'.$target_domain;
9134: if (exists($env{$cachename}) && ($env{$cachename}+600) > time) {
9135: # We know already the user has no data
9136: return 1;
9137: } else {
9138: return 0;
9139: }
9140: }
9141:
9142: sub EXT_cache_set {
9143: my ($target_domain,$target_user) = @_;
9144: my $cachename = 'cache.EXT.'.$target_user.'.'.$target_domain;
9145: #&appenv({$cachename => time});
9146: }
9147:
9148: # --------------------------------------------------------- Value of a Variable
9149: sub EXT {
9150:
9151: my ($varname,$symbparm,$udom,$uname,$usection,$recurse)=@_;
9152: unless ($varname) { return ''; }
9153: #get real user name/domain, courseid and symb
9154: my $courseid;
9155: my $publicuser;
9156: if ($symbparm) {
9157: $symbparm=&get_symb_from_alias($symbparm);
9158: }
9159: if (!($uname && $udom)) {
9160: (my $cursymb,$courseid,$udom,$uname,$publicuser)= &whichuser($symbparm);
9161: if (!$symbparm) { $symbparm=$cursymb; }
9162: } else {
9163: $courseid=$env{'request.course.id'};
9164: }
9165: my ($realm,$space,$qualifier,@therest)=split(/\./,$varname);
9166: my $rest;
9167: if (defined($therest[0])) {
9168: $rest=join('.',@therest);
9169: } else {
9170: $rest='';
9171: }
9172:
9173: my $qualifierrest=$qualifier;
9174: if ($rest) { $qualifierrest.='.'.$rest; }
9175: my $spacequalifierrest=$space;
9176: if ($qualifierrest) { $spacequalifierrest.='.'.$qualifierrest; }
9177: if ($realm eq 'user') {
9178: # --------------------------------------------------------------- user.resource
9179: if ($space eq 'resource') {
9180: if ( (defined($Apache::lonhomework::parsing_a_problem)
9181: || defined($Apache::lonhomework::parsing_a_task))
9182: &&
9183: ($symbparm eq &symbread()) ) {
9184: # if we are in the middle of processing the resource the
9185: # get the value we are planning on committing
9186: if (defined($Apache::lonhomework::results{$qualifierrest})) {
9187: return $Apache::lonhomework::results{$qualifierrest};
9188: } else {
9189: return $Apache::lonhomework::history{$qualifierrest};
9190: }
9191: } else {
9192: my %restored;
9193: if ($publicuser || $env{'request.state'} eq 'construct') {
9194: %restored=&tmprestore($symbparm,$courseid,$udom,$uname);
9195: } else {
9196: %restored=&restore($symbparm,$courseid,$udom,$uname);
9197: }
9198: return $restored{$qualifierrest};
9199: }
9200: # ----------------------------------------------------------------- user.access
9201: } elsif ($space eq 'access') {
9202: # FIXME - not supporting calls for a specific user
9203: return &allowed($qualifier,$rest);
9204: # ------------------------------------------ user.preferences, user.environment
9205: } elsif (($space eq 'preferences') || ($space eq 'environment')) {
9206: if (($uname eq $env{'user.name'}) &&
9207: ($udom eq $env{'user.domain'})) {
9208: return $env{join('.',('environment',$qualifierrest))};
9209: } else {
9210: my %returnhash;
9211: if (!$publicuser) {
9212: %returnhash=&userenvironment($udom,$uname,
9213: $qualifierrest);
9214: }
9215: return $returnhash{$qualifierrest};
9216: }
9217: # ----------------------------------------------------------------- user.course
9218: } elsif ($space eq 'course') {
9219: # FIXME - not supporting calls for a specific user
9220: return $env{join('.',('request.course',$qualifier))};
9221: # ------------------------------------------------------------------- user.role
9222: } elsif ($space eq 'role') {
9223: # FIXME - not supporting calls for a specific user
9224: my ($role,$where)=split(/\./,$env{'request.role'});
9225: if ($qualifier eq 'value') {
9226: return $role;
9227: } elsif ($qualifier eq 'extent') {
9228: return $where;
9229: }
9230: # ----------------------------------------------------------------- user.domain
9231: } elsif ($space eq 'domain') {
9232: return $udom;
9233: # ------------------------------------------------------------------- user.name
9234: } elsif ($space eq 'name') {
9235: return $uname;
9236: # ---------------------------------------------------- Any other user namespace
9237: } else {
9238: my %reply;
9239: if (!$publicuser) {
9240: %reply=&get($space,[$qualifierrest],$udom,$uname);
9241: }
9242: return $reply{$qualifierrest};
9243: }
9244: } elsif ($realm eq 'query') {
9245: # ---------------------------------------------- pull stuff out of query string
9246: &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},
9247: [$spacequalifierrest]);
9248: return $env{'form.'.$spacequalifierrest};
9249: } elsif ($realm eq 'request') {
9250: # ------------------------------------------------------------- request.browser
9251: if ($space eq 'browser') {
9252: return $env{'browser.'.$qualifier};
9253: # ------------------------------------------------------------ request.filename
9254: } else {
9255: return $env{'request.'.$spacequalifierrest};
9256: }
9257: } elsif ($realm eq 'course') {
9258: # ---------------------------------------------------------- course.description
9259: return $env{'course.'.$courseid.'.'.$spacequalifierrest};
9260: } elsif ($realm eq 'resource') {
9261:
9262: if (defined($courseid) && $courseid eq $env{'request.course.id'}) {
9263: if (!$symbparm) { $symbparm=&symbread(); }
9264: }
9265:
9266: if ($space eq 'title') {
9267: if (!$symbparm) { $symbparm = $env{'request.filename'}; }
9268: return &gettitle($symbparm);
9269: }
9270:
9271: if ($space eq 'map') {
9272: my ($map) = &decode_symb($symbparm);
9273: return &symbread($map);
9274: }
9275: if ($space eq 'filename') {
9276: if ($symbparm) {
9277: return &clutter((&decode_symb($symbparm))[2]);
9278: }
9279: return &hreflocation('',$env{'request.filename'});
9280: }
9281:
9282: my ($section, $group, @groups);
9283: my ($courselevelm,$courselevel);
9284: if ($symbparm && defined($courseid) &&
9285: $courseid eq $env{'request.course.id'}) {
9286:
9287: #print '<br>'.$space.' - '.$qualifier.' - '.$spacequalifierrest;
9288:
9289: # ----------------------------------------------------- Cascading lookup scheme
9290: my $symbp=$symbparm;
9291: my $mapp=&deversion((&decode_symb($symbp))[0]);
9292:
9293: my $symbparm=$symbp.'.'.$spacequalifierrest;
9294: my $mapparm=$mapp.'___(all).'.$spacequalifierrest;
9295:
9296: if (($env{'user.name'} eq $uname) &&
9297: ($env{'user.domain'} eq $udom)) {
9298: $section=$env{'request.course.sec'};
9299: @groups = split(/:/,$env{'request.course.groups'});
9300: @groups=&sort_course_groups($courseid,@groups);
9301: } else {
9302: if (! defined($usection)) {
9303: $section=&getsection($udom,$uname,$courseid);
9304: } else {
9305: $section = $usection;
9306: }
9307: @groups = &get_users_groups($udom,$uname,$courseid);
9308: }
9309:
9310: my $seclevel=$courseid.'.['.$section.'].'.$spacequalifierrest;
9311: my $seclevelr=$courseid.'.['.$section.'].'.$symbparm;
9312: my $seclevelm=$courseid.'.['.$section.'].'.$mapparm;
9313:
9314: $courselevel=$courseid.'.'.$spacequalifierrest;
9315: my $courselevelr=$courseid.'.'.$symbparm;
9316: $courselevelm=$courseid.'.'.$mapparm;
9317:
9318: # ----------------------------------------------------------- first, check user
9319:
9320: my $userreply=&resdata($uname,$udom,'user',
9321: ([$courselevelr,'resource'],
9322: [$courselevelm,'map' ],
9323: [$courselevel, 'course' ]));
9324: if (defined($userreply)) { return &get_reply($userreply); }
9325:
9326: # ------------------------------------------------ second, check some of course
9327: my $coursereply;
9328: if (@groups > 0) {
9329: $coursereply = &check_group_parms($courseid,\@groups,$symbparm,
9330: $mapparm,$spacequalifierrest);
9331: if (defined($coursereply)) { return &get_reply($coursereply); }
9332: }
9333:
9334: $coursereply=&resdata($env{'course.'.$courseid.'.num'},
9335: $env{'course.'.$courseid.'.domain'},
9336: 'course',
9337: ([$seclevelr, 'resource'],
9338: [$seclevelm, 'map' ],
9339: [$seclevel, 'course' ],
9340: [$courselevelr,'resource']));
9341: if (defined($coursereply)) { return &get_reply($coursereply); }
9342:
9343: # ------------------------------------------------------ third, check map parms
9344: my %parmhash=();
9345: my $thisparm='';
9346: if (tie(%parmhash,'GDBM_File',
9347: $env{'request.course.fn'}.'_parms.db',
9348: &GDBM_READER(),0640)) {
9349: $thisparm=$parmhash{$symbparm};
9350: untie(%parmhash);
9351: }
9352: if ($thisparm) { return &get_reply([$thisparm,'resource']); }
9353: }
9354: # ------------------------------------------ fourth, look in resource metadata
9355:
9356: $spacequalifierrest=~s/\./\_/;
9357: my $filename;
9358: if (!$symbparm) { $symbparm=&symbread(); }
9359: if ($symbparm) {
9360: $filename=(&decode_symb($symbparm))[2];
9361: } else {
9362: $filename=$env{'request.filename'};
9363: }
9364: my $metadata=&metadata($filename,$spacequalifierrest);
9365: if (defined($metadata)) { return &get_reply([$metadata,'resource']); }
9366: $metadata=&metadata($filename,'parameter_'.$spacequalifierrest);
9367: if (defined($metadata)) { return &get_reply([$metadata,'resource']); }
9368:
9369: # ---------------------------------------------- fourth, look in rest of course
9370: if ($symbparm && defined($courseid) &&
9371: $courseid eq $env{'request.course.id'}) {
9372: my $coursereply=&resdata($env{'course.'.$courseid.'.num'},
9373: $env{'course.'.$courseid.'.domain'},
9374: 'course',
9375: ([$courselevelm,'map' ],
9376: [$courselevel, 'course']));
9377: if (defined($coursereply)) { return &get_reply($coursereply); }
9378: }
9379: # ------------------------------------------------------------------ Cascade up
9380: unless ($space eq '0') {
9381: my @parts=split(/_/,$space);
9382: my $id=pop(@parts);
9383: my $part=join('_',@parts);
9384: if ($part eq '') { $part='0'; }
9385: my @partgeneral=&EXT('resource.'.$part.'.'.$qualifierrest,
9386: $symbparm,$udom,$uname,$section,1);
9387: if (defined($partgeneral[0])) { return &get_reply(\@partgeneral); }
9388: }
9389: if ($recurse) { return undef; }
9390: my $pack_def=&packages_tab_default($filename,$varname);
9391: if (defined($pack_def)) { return &get_reply([$pack_def,'resource']); }
9392: # ---------------------------------------------------- Any other user namespace
9393: } elsif ($realm eq 'environment') {
9394: # ----------------------------------------------------------------- environment
9395: if (($uname eq $env{'user.name'})&&($udom eq $env{'user.domain'})) {
9396: return $env{'environment.'.$spacequalifierrest};
9397: } else {
9398: if ($uname eq 'anonymous' && $udom eq '') {
9399: return '';
9400: }
9401: my %returnhash=&userenvironment($udom,$uname,
9402: $spacequalifierrest);
9403: return $returnhash{$spacequalifierrest};
9404: }
9405: } elsif ($realm eq 'system') {
9406: # ----------------------------------------------------------------- system.time
9407: if ($space eq 'time') {
9408: return time;
9409: }
9410: } elsif ($realm eq 'server') {
9411: # ----------------------------------------------------------------- system.time
9412: if ($space eq 'name') {
9413: return $ENV{'SERVER_NAME'};
9414: }
9415: }
9416: return '';
9417: }
9418:
9419: sub get_reply {
9420: my ($reply_value) = @_;
9421: if (ref($reply_value) eq 'ARRAY') {
9422: if (wantarray) {
9423: return @$reply_value;
9424: }
9425: return $reply_value->[0];
9426: } else {
9427: return $reply_value;
9428: }
9429: }
9430:
9431: sub check_group_parms {
9432: my ($courseid,$groups,$symbparm,$mapparm,$what) = @_;
9433: my @groupitems = ();
9434: my $resultitem;
9435: my @levels = ([$symbparm,'resource'],[$mapparm,'map'],[$what,'course']);
9436: foreach my $group (@{$groups}) {
9437: foreach my $level (@levels) {
9438: my $item = $courseid.'.['.$group.'].'.$level->[0];
9439: push(@groupitems,[$item,$level->[1]]);
9440: }
9441: }
9442: my $coursereply = &resdata($env{'course.'.$courseid.'.num'},
9443: $env{'course.'.$courseid.'.domain'},
9444: 'course',@groupitems);
9445: return $coursereply;
9446: }
9447:
9448: sub sort_course_groups { # Sort groups based on defined rankings. Default is sort().
9449: my ($courseid,@groups) = @_;
9450: @groups = sort(@groups);
9451: return @groups;
9452: }
9453:
9454: sub packages_tab_default {
9455: my ($uri,$varname)=@_;
9456: my (undef,$part,$name)=split(/\./,$varname);
9457:
9458: my (@extension,@specifics,$do_default);
9459: foreach my $package (split(/,/,&metadata($uri,'packages'))) {
9460: my ($pack_type,$pack_part)=split(/_/,$package,2);
9461: if ($pack_type eq 'default') {
9462: $do_default=1;
9463: } elsif ($pack_type eq 'extension') {
9464: push(@extension,[$package,$pack_type,$pack_part]);
9465: } elsif ($pack_part eq $part || $pack_type eq 'part') {
9466: # only look at packages defaults for packages that this id is
9467: push(@specifics,[$package,$pack_type,$pack_part]);
9468: }
9469: }
9470: # first look for a package that matches the requested part id
9471: foreach my $package (@specifics) {
9472: my (undef,$pack_type,$pack_part)=@{$package};
9473: next if ($pack_part ne $part);
9474: if (defined($packagetab{"$pack_type&$name&default"})) {
9475: return $packagetab{"$pack_type&$name&default"};
9476: }
9477: }
9478: # look for any possible matching non extension_ package
9479: foreach my $package (@specifics) {
9480: my (undef,$pack_type,$pack_part)=@{$package};
9481: if (defined($packagetab{"$pack_type&$name&default"})) {
9482: return $packagetab{"$pack_type&$name&default"};
9483: }
9484: if ($pack_type eq 'part') { $pack_part='0'; }
9485: if (defined($packagetab{$pack_type."_".$pack_part."&$name&default"})) {
9486: return $packagetab{$pack_type."_".$pack_part."&$name&default"};
9487: }
9488: }
9489: # look for any posible extension_ match
9490: foreach my $package (@extension) {
9491: my ($package,$pack_type)=@{$package};
9492: if (defined($packagetab{"$pack_type&$name&default"})) {
9493: return $packagetab{"$pack_type&$name&default"};
9494: }
9495: if (defined($packagetab{$package."&$name&default"})) {
9496: return $packagetab{$package."&$name&default"};
9497: }
9498: }
9499: # look for a global default setting
9500: if ($do_default && defined($packagetab{"default&$name&default"})) {
9501: return $packagetab{"default&$name&default"};
9502: }
9503: return undef;
9504: }
9505:
9506: sub add_prefix_and_part {
9507: my ($prefix,$part)=@_;
9508: my $keyroot;
9509: if (defined($prefix) && $prefix !~ /^__/) {
9510: # prefix that has a part already
9511: $keyroot=$prefix;
9512: } elsif (defined($prefix)) {
9513: # prefix that is missing a part
9514: if (defined($part)) { $keyroot='_'.$part.substr($prefix,1); }
9515: } else {
9516: # no prefix at all
9517: if (defined($part)) { $keyroot='_'.$part; }
9518: }
9519: return $keyroot;
9520: }
9521:
9522: # ---------------------------------------------------------------- Get metadata
9523:
9524: my %metaentry;
9525: my %importedpartids;
9526: sub metadata {
9527: my ($uri,$what,$liburi,$prefix,$depthcount)=@_;
9528: $uri=&declutter($uri);
9529: # if it is a non metadata possible uri return quickly
9530: if (($uri eq '') ||
9531: (($uri =~ m|^/*adm/|) &&
9532: ($uri !~ m|^adm/includes|) && ($uri !~ m|/bulletinboard$|)) ||
9533: ($uri =~ m|/$|) || ($uri =~ m|/.meta$|) || ($uri =~ m{^/*uploaded/.+\.sequence$})) {
9534: return undef;
9535: }
9536: if (($uri =~ /^priv/ || $uri=~/home\/httpd\/html\/priv/)
9537: && &Apache::lonxml::get_state('target') =~ /^(|meta)$/) {
9538: return undef;
9539: }
9540: my $filename=$uri;
9541: $uri=~s/\.meta$//;
9542: #
9543: # Is the metadata already cached?
9544: # Look at timestamp of caching
9545: # Everything is cached by the main uri, libraries are never directly cached
9546: #
9547: if (!defined($liburi)) {
9548: my ($result,$cached)=&is_cached_new('meta',$uri);
9549: if (defined($cached)) { return $result->{':'.$what}; }
9550: }
9551: {
9552: # Imported parts would go here
9553: my %importedids=();
9554: my @origfileimportpartids=();
9555: my $importedparts=0;
9556: #
9557: # Is this a recursive call for a library?
9558: #
9559: # if (! exists($metacache{$uri})) {
9560: # $metacache{$uri}={};
9561: # }
9562: my $cachetime = 60*60;
9563: if ($liburi) {
9564: $liburi=&declutter($liburi);
9565: $filename=$liburi;
9566: } else {
9567: &devalidate_cache_new('meta',$uri);
9568: undef(%metaentry);
9569: }
9570: my %metathesekeys=();
9571: unless ($filename=~/\.meta$/) { $filename.='.meta'; }
9572: my $metastring;
9573: if ($uri =~ /^priv/ || $uri=~/home\/httpd\/html\/priv/) {
9574: my $which = &hreflocation('','/'.($liburi || $uri));
9575: $metastring =
9576: &Apache::lonnet::ssi_body($which,
9577: ('grade_target' => 'meta'));
9578: $cachetime = 1; # only want this cached in the child not long term
9579: } elsif (($uri !~ m -^(editupload)/-) &&
9580: ($uri !~ m{^/*uploaded/$match_domain/$match_courseid/docs/})) {
9581: my $file=&filelocation('',&clutter($filename));
9582: #push(@{$metaentry{$uri.'.file'}},$file);
9583: $metastring=&getfile($file);
9584: }
9585: my $parser=HTML::LCParser->new(\$metastring);
9586: my $token;
9587: undef %metathesekeys;
9588: while ($token=$parser->get_token) {
9589: if ($token->[0] eq 'S') {
9590: if (defined($token->[2]->{'package'})) {
9591: #
9592: # This is a package - get package info
9593: #
9594: my $package=$token->[2]->{'package'};
9595: my $keyroot=&add_prefix_and_part($prefix,$token->[2]->{'part'});
9596: if (defined($token->[2]->{'id'})) {
9597: $keyroot.='_'.$token->[2]->{'id'};
9598: }
9599: if ($metaentry{':packages'}) {
9600: $metaentry{':packages'}.=','.$package.$keyroot;
9601: } else {
9602: $metaentry{':packages'}=$package.$keyroot;
9603: }
9604: foreach my $pack_entry (keys(%packagetab)) {
9605: my $part=$keyroot;
9606: $part=~s/^\_//;
9607: if ($pack_entry=~/^\Q$package\E\&/ ||
9608: $pack_entry=~/^\Q$package\E_0\&/) {
9609: my ($pack,$name,$subp)=split(/\&/,$pack_entry);
9610: # ignore package.tab specified default values
9611: # here &package_tab_default() will fetch those
9612: if ($subp eq 'default') { next; }
9613: my $value=$packagetab{$pack_entry};
9614: my $unikey;
9615: if ($pack =~ /_0$/) {
9616: $unikey='parameter_0_'.$name;
9617: $part=0;
9618: } else {
9619: $unikey='parameter'.$keyroot.'_'.$name;
9620: }
9621: if ($subp eq 'display') {
9622: $value.=' [Part: '.$part.']';
9623: }
9624: $metaentry{':'.$unikey.'.part'}=$part;
9625: $metathesekeys{$unikey}=1;
9626: unless (defined($metaentry{':'.$unikey.'.'.$subp})) {
9627: $metaentry{':'.$unikey.'.'.$subp}=$value;
9628: }
9629: if (defined($metaentry{':'.$unikey.'.default'})) {
9630: $metaentry{':'.$unikey}=
9631: $metaentry{':'.$unikey.'.default'};
9632: }
9633: }
9634: }
9635: } else {
9636: #
9637: # This is not a package - some other kind of start tag
9638: #
9639: my $entry=$token->[1];
9640: my $unikey='';
9641:
9642: if ($entry eq 'import') {
9643: #
9644: # Importing a library here
9645: #
9646: my $location=$parser->get_text('/import');
9647: my $dir=$filename;
9648: $dir=~s|[^/]*$||;
9649: $location=&filelocation($dir,$location);
9650:
9651: my $importmode=$token->[2]->{'importmode'};
9652: if ($importmode eq 'problem') {
9653: # Import as problem/response
9654: $unikey=&add_prefix_and_part($prefix,$token->[2]->{'part'});
9655: } elsif ($importmode eq 'part') {
9656: # Import as part(s)
9657: $importedparts=1;
9658: # We need to get the original file and the imported file to get the part order correct
9659: # Good news: we do not need to worry about nested libraries, since parts cannot be nested
9660: # Load and inspect original file
9661: if ($#origfileimportpartids<0) {
9662: undef(%importedpartids);
9663: my $origfilelocation=$perlvar{'lonDocRoot'}.&clutter($uri);
9664: my $origfile=&getfile($origfilelocation);
9665: @origfileimportpartids=($origfile=~/<(part|import)[^>]*id\s*=\s*[\"\']([^\"\']+)[\"\'][^>]*>/gs);
9666: }
9667:
9668: # Load and inspect imported file
9669: my $impfile=&getfile($location);
9670: my @impfilepartids=($impfile=~/<part[^>]*id\s*=\s*[\"\']([^\"\']+)[\"\'][^>]*>/gs);
9671: if ($#impfilepartids>=0) {
9672: # This problem had parts
9673: $importedpartids{$token->[2]->{'id'}}=join(',',@impfilepartids);
9674: } else {
9675: # Importing by turning a single problem into a problem part
9676: # It gets the import-tags ID as part-ID
9677: $unikey=&add_prefix_and_part($prefix,$token->[2]->{'id'});
9678: $importedpartids{$token->[2]->{'id'}}=$token->[2]->{'id'};
9679: }
9680: } else {
9681: # Normal import
9682: $unikey=&add_prefix_and_part($prefix,$token->[2]->{'part'});
9683: if (defined($token->[2]->{'id'})) {
9684: $unikey.='_'.$token->[2]->{'id'};
9685: }
9686: }
9687:
9688: if ($depthcount<20) {
9689: my $metadata =
9690: &metadata($uri,'keys', $location,$unikey,
9691: $depthcount+1);
9692: foreach my $meta (split(',',$metadata)) {
9693: $metaentry{':'.$meta}=$metaentry{':'.$meta};
9694: $metathesekeys{$meta}=1;
9695: }
9696:
9697: }
9698: } else {
9699: #
9700: # Not importing, some other kind of non-package, non-library start tag
9701: #
9702: $unikey=$entry.&add_prefix_and_part($prefix,$token->[2]->{'part'});
9703: if (defined($token->[2]->{'id'})) {
9704: $unikey.='_'.$token->[2]->{'id'};
9705: }
9706: if (defined($token->[2]->{'name'})) {
9707: $unikey.='_'.$token->[2]->{'name'};
9708: }
9709: $metathesekeys{$unikey}=1;
9710: foreach my $param (@{$token->[3]}) {
9711: $metaentry{':'.$unikey.'.'.$param} =
9712: $token->[2]->{$param};
9713: }
9714: my $internaltext=&HTML::Entities::decode($parser->get_text('/'.$entry));
9715: my $default=$metaentry{':'.$unikey.'.default'};
9716: if ( $internaltext =~ /^\s*$/ && $default !~ /^\s*$/) {
9717: # only ws inside the tag, and not in default, so use default
9718: # as value
9719: $metaentry{':'.$unikey}=$default;
9720: } elsif ( $internaltext =~ /\S/ ) {
9721: # something interesting inside the tag
9722: $metaentry{':'.$unikey}=$internaltext;
9723: } else {
9724: # no interesting values, don't set a default
9725: }
9726: # end of not-a-package not-a-library import
9727: }
9728: # end of not-a-package start tag
9729: }
9730: # the next is the end of "start tag"
9731: }
9732: }
9733: my ($extension) = ($uri =~ /\.(\w+)$/);
9734: $extension = lc($extension);
9735: if ($extension eq 'htm') { $extension='html'; }
9736:
9737: foreach my $key (keys(%packagetab)) {
9738: #no specific packages #how's our extension
9739: if ($key!~/^extension_\Q$extension\E&/) { next; }
9740: &metadata_create_package_def($uri,$key,'extension_'.$extension,
9741: \%metathesekeys);
9742: }
9743:
9744: if (!exists($metaentry{':packages'})
9745: || $packagetab{"import_defaults&extension_$extension"}) {
9746: foreach my $key (keys(%packagetab)) {
9747: #no specific packages well let's get default then
9748: if ($key!~/^default&/) { next; }
9749: &metadata_create_package_def($uri,$key,'default',
9750: \%metathesekeys);
9751: }
9752: }
9753: # are there custom rights to evaluate
9754: if ($metaentry{':copyright'} eq 'custom') {
9755:
9756: #
9757: # Importing a rights file here
9758: #
9759: unless ($depthcount) {
9760: my $location=$metaentry{':customdistributionfile'};
9761: my $dir=$filename;
9762: $dir=~s|[^/]*$||;
9763: $location=&filelocation($dir,$location);
9764: my $rights_metadata =
9765: &metadata($uri,'keys',$location,'_rights',
9766: $depthcount+1);
9767: foreach my $rights (split(',',$rights_metadata)) {
9768: #$metaentry{':'.$rights}=$metacache{$uri}->{':'.$rights};
9769: $metathesekeys{$rights}=1;
9770: }
9771: }
9772: }
9773: # uniqifiy package listing
9774: my %seen;
9775: my @uniq_packages =
9776: grep { ! $seen{$_} ++ } (split(',',$metaentry{':packages'}));
9777: $metaentry{':packages'} = join(',',@uniq_packages);
9778:
9779: if ($importedparts) {
9780: # We had imported parts and need to rebuild partorder
9781: $metaentry{':partorder'}='';
9782: $metathesekeys{'partorder'}=1;
9783: for (my $index=0;$index<$#origfileimportpartids;$index+=2) {
9784: if ($origfileimportpartids[$index] eq 'part') {
9785: # original part, part of the problem
9786: $metaentry{':partorder'}.=','.$origfileimportpartids[$index+1];
9787: } else {
9788: # we have imported parts at this position
9789: $metaentry{':partorder'}.=','.$importedpartids{$origfileimportpartids[$index+1]};
9790: }
9791: }
9792: $metaentry{':partorder'}=~s/^\,//;
9793: }
9794:
9795: $metaentry{':keys'} = join(',',keys(%metathesekeys));
9796: &metadata_generate_part0(\%metathesekeys,\%metaentry,$uri);
9797: $metaentry{':allpossiblekeys'}=join(',',keys %metathesekeys);
9798: &do_cache_new('meta',$uri,\%metaentry,$cachetime);
9799: # this is the end of "was not already recently cached
9800: }
9801: return $metaentry{':'.$what};
9802: }
9803:
9804: sub metadata_create_package_def {
9805: my ($uri,$key,$package,$metathesekeys)=@_;
9806: my ($pack,$name,$subp)=split(/\&/,$key);
9807: if ($subp eq 'default') { next; }
9808:
9809: if (defined($metaentry{':packages'})) {
9810: $metaentry{':packages'}.=','.$package;
9811: } else {
9812: $metaentry{':packages'}=$package;
9813: }
9814: my $value=$packagetab{$key};
9815: my $unikey;
9816: $unikey='parameter_0_'.$name;
9817: $metaentry{':'.$unikey.'.part'}=0;
9818: $$metathesekeys{$unikey}=1;
9819: unless (defined($metaentry{':'.$unikey.'.'.$subp})) {
9820: $metaentry{':'.$unikey.'.'.$subp}=$value;
9821: }
9822: if (defined($metaentry{':'.$unikey.'.default'})) {
9823: $metaentry{':'.$unikey}=
9824: $metaentry{':'.$unikey.'.default'};
9825: }
9826: }
9827:
9828: sub metadata_generate_part0 {
9829: my ($metadata,$metacache,$uri) = @_;
9830: my %allnames;
9831: foreach my $metakey (keys(%$metadata)) {
9832: if ($metakey=~/^parameter\_(.*)/) {
9833: my $part=$$metacache{':'.$metakey.'.part'};
9834: my $name=$$metacache{':'.$metakey.'.name'};
9835: if (! exists($$metadata{'parameter_0_'.$name.'.name'})) {
9836: $allnames{$name}=$part;
9837: }
9838: }
9839: }
9840: foreach my $name (keys(%allnames)) {
9841: $$metadata{"parameter_0_$name"}=1;
9842: my $key=":parameter_0_$name";
9843: $$metacache{"$key.part"}='0';
9844: $$metacache{"$key.name"}=$name;
9845: $$metacache{"$key.type"}=$$metacache{':parameter_'.
9846: $allnames{$name}.'_'.$name.
9847: '.type'};
9848: my $olddis=$$metacache{':parameter_'.$allnames{$name}.'_'.$name.
9849: '.display'};
9850: my $expr='[Part: '.$allnames{$name}.']';
9851: $olddis=~s/\Q$expr\E/\[Part: 0\]/;
9852: $$metacache{"$key.display"}=$olddis;
9853: }
9854: }
9855:
9856: # ------------------------------------------------------ Devalidate title cache
9857:
9858: sub devalidate_title_cache {
9859: my ($url)=@_;
9860: if (!$env{'request.course.id'}) { return; }
9861: my $symb=&symbread($url);
9862: if (!$symb) { return; }
9863: my $key=$env{'request.course.id'}."\0".$symb;
9864: &devalidate_cache_new('title',$key);
9865: }
9866:
9867: # ------------------------------------------------- Get the title of a course
9868:
9869: sub current_course_title {
9870: return $env{ 'course.' . $env{'request.course.id'} . '.description' };
9871: }
9872: # ------------------------------------------------- Get the title of a resource
9873:
9874: sub gettitle {
9875: my $urlsymb=shift;
9876: my $symb=&symbread($urlsymb);
9877: if ($symb) {
9878: my $key=$env{'request.course.id'}."\0".$symb;
9879: my ($result,$cached)=&is_cached_new('title',$key);
9880: if (defined($cached)) {
9881: return $result;
9882: }
9883: my ($map,$resid,$url)=&decode_symb($symb);
9884: my $title='';
9885: if (!$map && $resid == 0 && $url =~/default\.sequence$/) {
9886: $title = $env{'course.'.$env{'request.course.id'}.'.description'};
9887: } else {
9888: if (tie(my %bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
9889: &GDBM_READER(),0640)) {
9890: my $mapid=$bighash{'map_pc_'.&clutter($map)};
9891: $title=$bighash{'title_'.$mapid.'.'.$resid};
9892: untie(%bighash);
9893: }
9894: }
9895: $title=~s/\&colon\;/\:/gs;
9896: if ($title) {
9897: # Remember both $symb and $title for dynamic metadata
9898: $accesshash{$symb.'___crstitle'}=$title;
9899: $accesshash{&declutter($map).'___'.&declutter($url).'___usage'}=time;
9900: # Cache this title and then return it
9901: return &do_cache_new('title',$key,$title,600);
9902: }
9903: $urlsymb=$url;
9904: }
9905: my $title=&metadata($urlsymb,'title');
9906: if (!$title) { $title=(split('/',$urlsymb))[-1]; }
9907: return $title;
9908: }
9909:
9910: sub get_slot {
9911: my ($which,$cnum,$cdom)=@_;
9912: if (!$cnum || !$cdom) {
9913: (undef,my $courseid)=&whichuser();
9914: $cdom=$env{'course.'.$courseid.'.domain'};
9915: $cnum=$env{'course.'.$courseid.'.num'};
9916: }
9917: my $key=join("\0",'slots',$cdom,$cnum,$which);
9918: my %slotinfo;
9919: if (exists($remembered{$key})) {
9920: $slotinfo{$which} = $remembered{$key};
9921: } else {
9922: %slotinfo=&get('slots',[$which],$cdom,$cnum);
9923: &Apache::lonhomework::showhash(%slotinfo);
9924: my ($tmp)=keys(%slotinfo);
9925: if ($tmp=~/^error:/) { return (); }
9926: $remembered{$key} = $slotinfo{$which};
9927: }
9928: if (ref($slotinfo{$which}) eq 'HASH') {
9929: return %{$slotinfo{$which}};
9930: }
9931: return $slotinfo{$which};
9932: }
9933:
9934: sub get_reservable_slots {
9935: my ($cnum,$cdom,$uname,$udom) = @_;
9936: my $now = time;
9937: my $reservable_info;
9938: my $key=join("\0",'reservableslots',$cdom,$cnum,$uname,$udom);
9939: if (exists($remembered{$key})) {
9940: $reservable_info = $remembered{$key};
9941: } else {
9942: my %resv;
9943: ($resv{'now_order'},$resv{'now'},$resv{'future_order'},$resv{'future'}) =
9944: &Apache::loncommon::get_future_slots($cnum,$cdom,$now);
9945: $reservable_info = \%resv;
9946: $remembered{$key} = $reservable_info;
9947: }
9948: return $reservable_info;
9949: }
9950:
9951: sub get_course_slots {
9952: my ($cnum,$cdom) = @_;
9953: my $hashid=$cnum.':'.$cdom;
9954: my ($result,$cached) = &Apache::lonnet::is_cached_new('allslots',$hashid);
9955: if (defined($cached)) {
9956: if (ref($result) eq 'HASH') {
9957: return %{$result};
9958: }
9959: } else {
9960: my %slots=&Apache::lonnet::dump('slots',$cdom,$cnum);
9961: my ($tmp) = keys(%slots);
9962: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
9963: &Apache::lonnet::do_cache_new('allslots',$hashid,\%slots,600);
9964: return %slots;
9965: }
9966: }
9967: return;
9968: }
9969:
9970: sub devalidate_slots_cache {
9971: my ($cnum,$cdom)=@_;
9972: my $hashid=$cnum.':'.$cdom;
9973: &devalidate_cache_new('allslots',$hashid);
9974: }
9975:
9976: sub get_coursechange {
9977: my ($cdom,$cnum) = @_;
9978: if ($cdom eq '' || $cnum eq '') {
9979: return unless ($env{'request.course.id'});
9980: $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
9981: $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
9982: }
9983: my $hashid=$cdom.'_'.$cnum;
9984: my ($change,$cached)=&is_cached_new('crschange',$hashid);
9985: if ((defined($cached)) && ($change ne '')) {
9986: return $change;
9987: } else {
9988: my %crshash;
9989: %crshash = &get('environment',['internal.contentchange'],$cdom,$cnum);
9990: if ($crshash{'internal.contentchange'} eq '') {
9991: $change = $env{'course.'.$cdom.'_'.$cnum.'.internal.created'};
9992: if ($change eq '') {
9993: %crshash = &get('environment',['internal.created'],$cdom,$cnum);
9994: $change = $crshash{'internal.created'};
9995: }
9996: } else {
9997: $change = $crshash{'internal.contentchange'};
9998: }
9999: my $cachetime = 600;
10000: &do_cache_new('crschange',$hashid,$change,$cachetime);
10001: }
10002: return $change;
10003: }
10004:
10005: sub devalidate_coursechange_cache {
10006: my ($cnum,$cdom)=@_;
10007: my $hashid=$cnum.':'.$cdom;
10008: &devalidate_cache_new('crschange',$hashid);
10009: }
10010:
10011: # ------------------------------------------------- Update symbolic store links
10012:
10013: sub symblist {
10014: my ($mapname,%newhash)=@_;
10015: $mapname=&deversion(&declutter($mapname));
10016: my %hash;
10017: if (($env{'request.course.fn'}) && (%newhash)) {
10018: if (tie(%hash,'GDBM_File',$env{'request.course.fn'}.'_symb.db',
10019: &GDBM_WRCREAT(),0640)) {
10020: foreach my $url (keys(%newhash)) {
10021: next if ($url eq 'last_known'
10022: && $env{'form.no_update_last_known'});
10023: $hash{declutter($url)}=&encode_symb($mapname,
10024: $newhash{$url}->[1],
10025: $newhash{$url}->[0]);
10026: }
10027: if (untie(%hash)) {
10028: return 'ok';
10029: }
10030: }
10031: }
10032: return 'error';
10033: }
10034:
10035: # --------------------------------------------------------------- Verify a symb
10036:
10037: sub symbverify {
10038: my ($symb,$thisurl,$encstate)=@_;
10039: my $thisfn=$thisurl;
10040: $thisfn=&declutter($thisfn);
10041: # direct jump to resource in page or to a sequence - will construct own symbs
10042: if ($thisfn=~/\.(page|sequence)$/) { return 1; }
10043: # check URL part
10044: my ($map,$resid,$url)=&decode_symb($symb);
10045:
10046: unless ($url eq $thisfn) { return 0; }
10047:
10048: $symb=&symbclean($symb);
10049: $thisurl=&deversion($thisurl);
10050: $thisfn=&deversion($thisfn);
10051:
10052: my %bighash;
10053: my $okay=0;
10054:
10055: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
10056: &GDBM_READER(),0640)) {
10057: if (($thisurl =~ m{^/adm/wrapper/ext/}) || ($thisurl =~ m{^ext/})) {
10058: $thisurl =~ s/\?.+$//;
10059: }
10060: my $ids=$bighash{'ids_'.&clutter($thisurl)};
10061: unless ($ids) {
10062: my $idkey = 'ids_'.($thisurl =~ m{^/}? '' : '/').$thisurl;
10063: $ids=$bighash{$idkey};
10064: }
10065: if ($ids) {
10066: # ------------------------------------------------------------------- Has ID(s)
10067: foreach my $id (split(/\,/,$ids)) {
10068: my ($mapid,$resid)=split(/\./,$id);
10069: if ($thisfn =~ m{^/adm/wrapper/ext/}) {
10070: $symb =~ s/\?.+$//;
10071: }
10072: if (
10073: &symbclean(&declutter($bighash{'map_id_'.$mapid}).'___'.$resid.'___'.$thisfn)
10074: eq $symb) {
10075: if (ref($encstate)) {
10076: $$encstate = $bighash{'encrypted_'.$id};
10077: }
10078: if (($env{'request.role.adv'}) ||
10079: ($bighash{'encrypted_'.$id} eq $env{'request.enc'}) ||
10080: ($thisurl eq '/adm/navmaps')) {
10081: $okay=1;
10082: }
10083: }
10084: }
10085: }
10086: untie(%bighash);
10087: }
10088: return $okay;
10089: }
10090:
10091: # --------------------------------------------------------------- Clean-up symb
10092:
10093: sub symbclean {
10094: my $symb=shift;
10095: if ($symb=~m|^/enc/|) { $symb=&Apache::lonenc::unencrypted($symb); }
10096: # remove version from map
10097: $symb=~s/\.(\d+)\.(\w+)\_\_\_/\.$2\_\_\_/;
10098:
10099: # remove version from URL
10100: $symb=~s/\.(\d+)\.(\w+)$/\.$2/;
10101:
10102: # remove wrapper
10103:
10104: $symb=~s/(\_\_\_\d+\_\_\_)adm\/wrapper\/(res\/)*/$1/;
10105: $symb=~s/(\_\_\_\d+\_\_\_)adm\/coursedocs\/showdoc\/(res\/)*/$1/;
10106: return $symb;
10107: }
10108:
10109: # ---------------------------------------------- Split symb to find map and url
10110:
10111: sub encode_symb {
10112: my ($map,$resid,$url)=@_;
10113: return &symbclean(&declutter($map).'___'.$resid.'___'.&declutter($url));
10114: }
10115:
10116: sub decode_symb {
10117: my $symb=shift;
10118: if ($symb=~m|^/enc/|) { $symb=&Apache::lonenc::unencrypted($symb); }
10119: my ($map,$resid,$url)=split(/___/,$symb);
10120: return (&fixversion($map),$resid,&fixversion($url));
10121: }
10122:
10123: sub fixversion {
10124: my $fn=shift;
10125: if ($fn=~/^(adm|uploaded|editupload|public)/) { return $fn; }
10126: my %bighash;
10127: my $uri=&clutter($fn);
10128: my $key=$env{'request.course.id'}.'_'.$uri;
10129: # is this cached?
10130: my ($result,$cached)=&is_cached_new('courseresversion',$key);
10131: if (defined($cached)) { return $result; }
10132: # unfortunately not cached, or expired
10133: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
10134: &GDBM_READER(),0640)) {
10135: if ($bighash{'version_'.$uri}) {
10136: my $version=$bighash{'version_'.$uri};
10137: unless (($version eq 'mostrecent') ||
10138: ($version==&getversion($uri))) {
10139: $uri=~s/\.(\w+)$/\.$version\.$1/;
10140: }
10141: }
10142: untie %bighash;
10143: }
10144: return &do_cache_new('courseresversion',$key,&declutter($uri),600);
10145: }
10146:
10147: sub deversion {
10148: my $url=shift;
10149: $url=~s/\.\d+\.(\w+)$/\.$1/;
10150: return $url;
10151: }
10152:
10153: # ------------------------------------------------------ Return symb list entry
10154:
10155: sub symbread {
10156: my ($thisfn,$donotrecurse)=@_;
10157: my $cache_str='request.symbread.cached.'.$thisfn;
10158: if (defined($env{$cache_str})) {
10159: if (($thisfn) || ($env{$cache_str} ne '')) {
10160: return $env{$cache_str};
10161: }
10162: }
10163: # no filename provided? try from environment
10164: unless ($thisfn) {
10165: if ($env{'request.symb'}) {
10166: return $env{$cache_str}=&symbclean($env{'request.symb'});
10167: }
10168: $thisfn=$env{'request.filename'};
10169: }
10170: if ($thisfn=~m|^/enc/|) { $thisfn=&Apache::lonenc::unencrypted($thisfn); }
10171: # is that filename actually a symb? Verify, clean, and return
10172: if ($thisfn=~/\_\_\_\d+\_\_\_(.*)$/) {
10173: if (&symbverify($thisfn,$1)) {
10174: return $env{$cache_str}=&symbclean($thisfn);
10175: }
10176: }
10177: $thisfn=declutter($thisfn);
10178: my %hash;
10179: my %bighash;
10180: my $syval='';
10181: if (($env{'request.course.fn'}) && ($thisfn)) {
10182: my $targetfn = $thisfn;
10183: if ( ($thisfn =~ m/^(uploaded|editupload)\//) && ($thisfn !~ m/\.(page|sequence)$/) ) {
10184: $targetfn = 'adm/wrapper/'.$thisfn;
10185: }
10186: if ($targetfn =~ m|^adm/wrapper/(ext/.*)|) {
10187: $targetfn=$1;
10188: }
10189: if (tie(%hash,'GDBM_File',$env{'request.course.fn'}.'_symb.db',
10190: &GDBM_READER(),0640)) {
10191: $syval=$hash{$targetfn};
10192: untie(%hash);
10193: }
10194: # ---------------------------------------------------------- There was an entry
10195: if ($syval) {
10196: #unless ($syval=~/\_\d+$/) {
10197: #unless ($env{'form.request.prefix'}=~/\.(\d+)\_$/) {
10198: #&appenv({'request.ambiguous' => $thisfn});
10199: #return $env{$cache_str}='';
10200: #}
10201: #$syval.=$1;
10202: #}
10203: } else {
10204: # ------------------------------------------------------- Was not in symb table
10205: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
10206: &GDBM_READER(),0640)) {
10207: # ---------------------------------------------- Get ID(s) for current resource
10208: my $ids=$bighash{'ids_'.&clutter($thisfn)};
10209: unless ($ids) {
10210: $ids=$bighash{'ids_/'.$thisfn};
10211: }
10212: unless ($ids) {
10213: # alias?
10214: $ids=$bighash{'mapalias_'.$thisfn};
10215: }
10216: if ($ids) {
10217: # ------------------------------------------------------------------- Has ID(s)
10218: my @possibilities=split(/\,/,$ids);
10219: if ($#possibilities==0) {
10220: # ----------------------------------------------- There is only one possibility
10221: my ($mapid,$resid)=split(/\./,$ids);
10222: $syval=&encode_symb($bighash{'map_id_'.$mapid},
10223: $resid,$thisfn);
10224: } elsif (!$donotrecurse) {
10225: # ------------------------------------------ There is more than one possibility
10226: my $realpossible=0;
10227: foreach my $id (@possibilities) {
10228: my $file=$bighash{'src_'.$id};
10229: if (&allowed('bre',$file)) {
10230: my ($mapid,$resid)=split(/\./,$id);
10231: if ($bighash{'map_type_'.$mapid} ne 'page') {
10232: $realpossible++;
10233: $syval=&encode_symb($bighash{'map_id_'.$mapid},
10234: $resid,$thisfn);
10235: }
10236: }
10237: }
10238: if ($realpossible!=1) { $syval=''; }
10239: } else {
10240: $syval='';
10241: }
10242: }
10243: untie(%bighash)
10244: }
10245: }
10246: if ($syval) {
10247: return $env{$cache_str}=$syval;
10248: }
10249: }
10250: &appenv({'request.ambiguous' => $thisfn});
10251: return $env{$cache_str}='';
10252: }
10253:
10254: # ---------------------------------------------------------- Return random seed
10255:
10256: sub numval {
10257: my $txt=shift;
10258: $txt=~tr/A-J/0-9/;
10259: $txt=~tr/a-j/0-9/;
10260: $txt=~tr/K-T/0-9/;
10261: $txt=~tr/k-t/0-9/;
10262: $txt=~tr/U-Z/0-5/;
10263: $txt=~tr/u-z/0-5/;
10264: $txt=~s/\D//g;
10265: if ($_64bit) { if ($txt > 2**32) { return -1; } }
10266: return int($txt);
10267: }
10268:
10269: sub numval2 {
10270: my $txt=shift;
10271: $txt=~tr/A-J/0-9/;
10272: $txt=~tr/a-j/0-9/;
10273: $txt=~tr/K-T/0-9/;
10274: $txt=~tr/k-t/0-9/;
10275: $txt=~tr/U-Z/0-5/;
10276: $txt=~tr/u-z/0-5/;
10277: $txt=~s/\D//g;
10278: my @txts=split(/(\d\d\d\d\d\d\d\d\d)/,$txt);
10279: my $total;
10280: foreach my $val (@txts) { $total+=$val; }
10281: if ($_64bit) { if ($total > 2**32) { return -1; } }
10282: return int($total);
10283: }
10284:
10285: sub numval3 {
10286: use integer;
10287: my $txt=shift;
10288: $txt=~tr/A-J/0-9/;
10289: $txt=~tr/a-j/0-9/;
10290: $txt=~tr/K-T/0-9/;
10291: $txt=~tr/k-t/0-9/;
10292: $txt=~tr/U-Z/0-5/;
10293: $txt=~tr/u-z/0-5/;
10294: $txt=~s/\D//g;
10295: my @txts=split(/(\d\d\d\d\d\d\d\d\d)/,$txt);
10296: my $total;
10297: foreach my $val (@txts) { $total+=$val; }
10298: if ($_64bit) { $total=(($total<<32)>>32); }
10299: return $total;
10300: }
10301:
10302: sub digest {
10303: my ($data)=@_;
10304: my $digest=&Digest::MD5::md5($data);
10305: my ($a,$b,$c,$d)=unpack("iiii",$digest);
10306: my ($e,$f);
10307: {
10308: use integer;
10309: $e=($a+$b);
10310: $f=($c+$d);
10311: if ($_64bit) {
10312: $e=(($e<<32)>>32);
10313: $f=(($f<<32)>>32);
10314: }
10315: }
10316: if (wantarray) {
10317: return ($e,$f);
10318: } else {
10319: my $g;
10320: {
10321: use integer;
10322: $g=($e+$f);
10323: if ($_64bit) {
10324: $g=(($g<<32)>>32);
10325: }
10326: }
10327: return $g;
10328: }
10329: }
10330:
10331: sub latest_rnd_algorithm_id {
10332: return '64bit5';
10333: }
10334:
10335: sub get_rand_alg {
10336: my ($courseid)=@_;
10337: if (!$courseid) { $courseid=(&whichuser())[1]; }
10338: if ($courseid) {
10339: return $env{"course.$courseid.rndseed"};
10340: }
10341: return &latest_rnd_algorithm_id();
10342: }
10343:
10344: sub validCODE {
10345: my ($CODE)=@_;
10346: if (defined($CODE) && $CODE ne '' && $CODE =~ /^\w+$/) { return 1; }
10347: return 0;
10348: }
10349:
10350: sub getCODE {
10351: if (&validCODE($env{'form.CODE'})) { return $env{'form.CODE'}; }
10352: if ( (defined($Apache::lonhomework::parsing_a_problem) ||
10353: defined($Apache::lonhomework::parsing_a_task) ) &&
10354: &validCODE($Apache::lonhomework::history{'resource.CODE'})) {
10355: return $Apache::lonhomework::history{'resource.CODE'};
10356: }
10357: return undef;
10358: }
10359: #
10360: # Determines the random seed for a specific context:
10361: #
10362: # parameters:
10363: # symb - in course context the symb for the seed.
10364: # course_id - The course id of the form domain_coursenum.
10365: # domain - Domain for the user.
10366: # course - Course for the user.
10367: # cenv - environment of the course.
10368: #
10369: # NOTE:
10370: # All parameters are picked out of the environment if missing
10371: # or not defined.
10372: # If a symb cannot be determined the current time is used instead.
10373: #
10374: # For a given well defined symb, courside, domain, username,
10375: # and course environment, the seed is reproducible.
10376: #
10377: sub rndseed {
10378: my ($symb,$courseid,$domain,$username, $cenv)=@_;
10379: my ($wsymb,$wcourseid,$wdomain,$wusername)=&whichuser();
10380: if (!defined($symb)) {
10381: unless ($symb=$wsymb) { return time; }
10382: }
10383: if (!defined $courseid) {
10384: $courseid=$wcourseid;
10385: }
10386: if (!defined $domain) { $domain=$wdomain; }
10387: if (!defined $username) { $username=$wusername }
10388:
10389: my $which;
10390: if (defined($cenv->{'rndseed'})) {
10391: $which = $cenv->{'rndseed'};
10392: } else {
10393: $which =&get_rand_alg($courseid);
10394: }
10395: if (defined(&getCODE())) {
10396:
10397: if ($which eq '64bit5') {
10398: return &rndseed_CODE_64bit5($symb,$courseid,$domain,$username);
10399: } elsif ($which eq '64bit4') {
10400: return &rndseed_CODE_64bit4($symb,$courseid,$domain,$username);
10401: } else {
10402: return &rndseed_CODE_64bit($symb,$courseid,$domain,$username);
10403: }
10404: } elsif ($which eq '64bit5') {
10405: return &rndseed_64bit5($symb,$courseid,$domain,$username);
10406: } elsif ($which eq '64bit4') {
10407: return &rndseed_64bit4($symb,$courseid,$domain,$username);
10408: } elsif ($which eq '64bit3') {
10409: return &rndseed_64bit3($symb,$courseid,$domain,$username);
10410: } elsif ($which eq '64bit2') {
10411: return &rndseed_64bit2($symb,$courseid,$domain,$username);
10412: } elsif ($which eq '64bit') {
10413: return &rndseed_64bit($symb,$courseid,$domain,$username);
10414: }
10415: return &rndseed_32bit($symb,$courseid,$domain,$username);
10416: }
10417:
10418: sub rndseed_32bit {
10419: my ($symb,$courseid,$domain,$username)=@_;
10420: {
10421: use integer;
10422: my $symbchck=unpack("%32C*",$symb) << 27;
10423: my $symbseed=numval($symb) << 22;
10424: my $namechck=unpack("%32C*",$username) << 17;
10425: my $nameseed=numval($username) << 12;
10426: my $domainseed=unpack("%32C*",$domain) << 7;
10427: my $courseseed=unpack("%32C*",$courseid);
10428: my $num=$symbseed+$nameseed+$domainseed+$courseseed+$namechck+$symbchck;
10429: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
10430: #&logthis("rndseed :$num:$symb");
10431: if ($_64bit) { $num=(($num<<32)>>32); }
10432: return $num;
10433: }
10434: }
10435:
10436: sub rndseed_64bit {
10437: my ($symb,$courseid,$domain,$username)=@_;
10438: {
10439: use integer;
10440: my $symbchck=unpack("%32S*",$symb) << 21;
10441: my $symbseed=numval($symb) << 10;
10442: my $namechck=unpack("%32S*",$username);
10443:
10444: my $nameseed=numval($username) << 21;
10445: my $domainseed=unpack("%32S*",$domain) << 10;
10446: my $courseseed=unpack("%32S*",$courseid);
10447:
10448: my $num1=$symbchck+$symbseed+$namechck;
10449: my $num2=$nameseed+$domainseed+$courseseed;
10450: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
10451: #&logthis("rndseed :$num:$symb");
10452: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
10453: return "$num1,$num2";
10454: }
10455: }
10456:
10457: sub rndseed_64bit2 {
10458: my ($symb,$courseid,$domain,$username)=@_;
10459: {
10460: use integer;
10461: # strings need to be an even # of cahracters long, it it is odd the
10462: # last characters gets thrown away
10463: my $symbchck=unpack("%32S*",$symb.' ') << 21;
10464: my $symbseed=numval($symb) << 10;
10465: my $namechck=unpack("%32S*",$username.' ');
10466:
10467: my $nameseed=numval($username) << 21;
10468: my $domainseed=unpack("%32S*",$domain.' ') << 10;
10469: my $courseseed=unpack("%32S*",$courseid.' ');
10470:
10471: my $num1=$symbchck+$symbseed+$namechck;
10472: my $num2=$nameseed+$domainseed+$courseseed;
10473: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
10474: #&logthis("rndseed :$num:$symb");
10475: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
10476: return "$num1,$num2";
10477: }
10478: }
10479:
10480: sub rndseed_64bit3 {
10481: my ($symb,$courseid,$domain,$username)=@_;
10482: {
10483: use integer;
10484: # strings need to be an even # of cahracters long, it it is odd the
10485: # last characters gets thrown away
10486: my $symbchck=unpack("%32S*",$symb.' ') << 21;
10487: my $symbseed=numval2($symb) << 10;
10488: my $namechck=unpack("%32S*",$username.' ');
10489:
10490: my $nameseed=numval2($username) << 21;
10491: my $domainseed=unpack("%32S*",$domain.' ') << 10;
10492: my $courseseed=unpack("%32S*",$courseid.' ');
10493:
10494: my $num1=$symbchck+$symbseed+$namechck;
10495: my $num2=$nameseed+$domainseed+$courseseed;
10496: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
10497: #&logthis("rndseed :$num1:$num2:$_64bit");
10498: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
10499:
10500: return "$num1:$num2";
10501: }
10502: }
10503:
10504: sub rndseed_64bit4 {
10505: my ($symb,$courseid,$domain,$username)=@_;
10506: {
10507: use integer;
10508: # strings need to be an even # of cahracters long, it it is odd the
10509: # last characters gets thrown away
10510: my $symbchck=unpack("%32S*",$symb.' ') << 21;
10511: my $symbseed=numval3($symb) << 10;
10512: my $namechck=unpack("%32S*",$username.' ');
10513:
10514: my $nameseed=numval3($username) << 21;
10515: my $domainseed=unpack("%32S*",$domain.' ') << 10;
10516: my $courseseed=unpack("%32S*",$courseid.' ');
10517:
10518: my $num1=$symbchck+$symbseed+$namechck;
10519: my $num2=$nameseed+$domainseed+$courseseed;
10520: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
10521: #&logthis("rndseed :$num1:$num2:$_64bit");
10522: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
10523:
10524: return "$num1:$num2";
10525: }
10526: }
10527:
10528: sub rndseed_64bit5 {
10529: my ($symb,$courseid,$domain,$username)=@_;
10530: my ($num1,$num2)=&digest("$symb,$courseid,$domain,$username");
10531: return "$num1:$num2";
10532: }
10533:
10534: sub rndseed_CODE_64bit {
10535: my ($symb,$courseid,$domain,$username)=@_;
10536: {
10537: use integer;
10538: my $symbchck=unpack("%32S*",$symb.' ') << 16;
10539: my $symbseed=numval2($symb);
10540: my $CODEchck=unpack("%32S*",&getCODE().' ') << 16;
10541: my $CODEseed=numval(&getCODE());
10542: my $courseseed=unpack("%32S*",$courseid.' ');
10543: my $num1=$symbseed+$CODEchck;
10544: my $num2=$CODEseed+$courseseed+$symbchck;
10545: #&logthis("$symbseed:$CODEchck|$CODEseed:$courseseed:$symbchck");
10546: #&logthis("rndseed :$num1:$num2:$symb");
10547: if ($_64bit) { $num1=(($num1<<32)>>32); }
10548: if ($_64bit) { $num2=(($num2<<32)>>32); }
10549: return "$num1:$num2";
10550: }
10551: }
10552:
10553: sub rndseed_CODE_64bit4 {
10554: my ($symb,$courseid,$domain,$username)=@_;
10555: {
10556: use integer;
10557: my $symbchck=unpack("%32S*",$symb.' ') << 16;
10558: my $symbseed=numval3($symb);
10559: my $CODEchck=unpack("%32S*",&getCODE().' ') << 16;
10560: my $CODEseed=numval3(&getCODE());
10561: my $courseseed=unpack("%32S*",$courseid.' ');
10562: my $num1=$symbseed+$CODEchck;
10563: my $num2=$CODEseed+$courseseed+$symbchck;
10564: #&logthis("$symbseed:$CODEchck|$CODEseed:$courseseed:$symbchck");
10565: #&logthis("rndseed :$num1:$num2:$symb");
10566: if ($_64bit) { $num1=(($num1<<32)>>32); }
10567: if ($_64bit) { $num2=(($num2<<32)>>32); }
10568: return "$num1:$num2";
10569: }
10570: }
10571:
10572: sub rndseed_CODE_64bit5 {
10573: my ($symb,$courseid,$domain,$username)=@_;
10574: my $code = &getCODE();
10575: my ($num1,$num2)=&digest("$symb,$courseid,$code");
10576: return "$num1:$num2";
10577: }
10578:
10579: sub setup_random_from_rndseed {
10580: my ($rndseed)=@_;
10581: if ($rndseed =~/([,:])/) {
10582: my ($num1,$num2)=split(/[,:]/,$rndseed);
10583: &Math::Random::random_set_seed(abs($num1),abs($num2));
10584: } else {
10585: &Math::Random::random_set_seed_from_phrase($rndseed);
10586: }
10587: }
10588:
10589: sub latest_receipt_algorithm_id {
10590: return 'receipt3';
10591: }
10592:
10593: sub recunique {
10594: my $fucourseid=shift;
10595: my $unique;
10596: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2' ||
10597: $env{"course.$fucourseid.receiptalg"} eq 'receipt3' ) {
10598: $unique=$env{"course.$fucourseid.internal.encseed"};
10599: } else {
10600: $unique=$perlvar{'lonReceipt'};
10601: }
10602: return unpack("%32C*",$unique);
10603: }
10604:
10605: sub recprefix {
10606: my $fucourseid=shift;
10607: my $prefix;
10608: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2'||
10609: $env{"course.$fucourseid.receiptalg"} eq 'receipt3' ) {
10610: $prefix=$env{"course.$fucourseid.internal.encpref"};
10611: } else {
10612: $prefix=$perlvar{'lonHostID'};
10613: }
10614: return unpack("%32C*",$prefix);
10615: }
10616:
10617: sub ireceipt {
10618: my ($funame,$fudom,$fucourseid,$fusymb,$part)=@_;
10619:
10620: my $return =&recprefix($fucourseid).'-';
10621:
10622: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt3' ||
10623: $env{'request.state'} eq 'construct') {
10624: $return .= (&digest("$funame,$fudom,$fucourseid,$fusymb,$part")%10000);
10625: return $return;
10626: }
10627:
10628: my $cuname=unpack("%32C*",$funame);
10629: my $cudom=unpack("%32C*",$fudom);
10630: my $cucourseid=unpack("%32C*",$fucourseid);
10631: my $cusymb=unpack("%32C*",$fusymb);
10632: my $cunique=&recunique($fucourseid);
10633: my $cpart=unpack("%32S*",$part);
10634: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2') {
10635:
10636: #&logthis("doing receipt2 using parts $cpart, uname $cuname and udom $cudom gets ".($cpart%$cuname)." and ".($cpart%$cudom));
10637:
10638: $return.= ($cunique%$cuname+
10639: $cunique%$cudom+
10640: $cusymb%$cuname+
10641: $cusymb%$cudom+
10642: $cucourseid%$cuname+
10643: $cucourseid%$cudom+
10644: $cpart%$cuname+
10645: $cpart%$cudom);
10646: } else {
10647: $return.= ($cunique%$cuname+
10648: $cunique%$cudom+
10649: $cusymb%$cuname+
10650: $cusymb%$cudom+
10651: $cucourseid%$cuname+
10652: $cucourseid%$cudom);
10653: }
10654: return $return;
10655: }
10656:
10657: sub receipt {
10658: my ($part)=@_;
10659: my ($symb,$courseid,$domain,$name) = &whichuser();
10660: return &ireceipt($name,$domain,$courseid,$symb,$part);
10661: }
10662:
10663: sub whichuser {
10664: my ($passedsymb)=@_;
10665: my ($symb,$courseid,$domain,$name,$publicuser);
10666: if (defined($env{'form.grade_symb'})) {
10667: my ($tmp_courseid)=&get_env_multiple('form.grade_courseid');
10668: my $allowed=&allowed('vgr',$tmp_courseid);
10669: if (!$allowed &&
10670: exists($env{'request.course.sec'}) &&
10671: $env{'request.course.sec'} !~ /^\s*$/) {
10672: $allowed=&allowed('vgr',$tmp_courseid.
10673: '/'.$env{'request.course.sec'});
10674: }
10675: if ($allowed) {
10676: ($symb)=&get_env_multiple('form.grade_symb');
10677: $courseid=$tmp_courseid;
10678: ($domain)=&get_env_multiple('form.grade_domain');
10679: ($name)=&get_env_multiple('form.grade_username');
10680: return ($symb,$courseid,$domain,$name,$publicuser);
10681: }
10682: }
10683: if (!$passedsymb) {
10684: $symb=&symbread();
10685: } else {
10686: $symb=$passedsymb;
10687: }
10688: $courseid=$env{'request.course.id'};
10689: $domain=$env{'user.domain'};
10690: $name=$env{'user.name'};
10691: if ($name eq 'public' && $domain eq 'public') {
10692: if (!defined($env{'form.username'})) {
10693: $env{'form.username'}.=time.rand(10000000);
10694: }
10695: $name.=$env{'form.username'};
10696: }
10697: return ($symb,$courseid,$domain,$name,$publicuser);
10698:
10699: }
10700:
10701: # ------------------------------------------------------------ Serves up a file
10702: # returns either the contents of the file or
10703: # -1 if the file doesn't exist
10704: #
10705: # if the target is a file that was uploaded via DOCS,
10706: # a check will be made to see if a current copy exists on the local server,
10707: # if it does this will be served, otherwise a copy will be retrieved from
10708: # the home server for the course and stored in /home/httpd/html/userfiles on
10709: # the local server.
10710:
10711: sub getfile {
10712: my ($file) = @_;
10713: if ($file =~ m -^/*(uploaded|editupload)/-) { $file=&filelocation("",$file); }
10714: &repcopy($file);
10715: return &readfile($file);
10716: }
10717:
10718: sub repcopy_userfile {
10719: my ($file)=@_;
10720: my $londocroot = $perlvar{'lonDocRoot'};
10721: if ($file =~ m{^/*(uploaded|editupload)/}) { $file=&filelocation("",$file); }
10722: if ($file =~ m{^\Q/home/httpd/lonUsers/\E}) { return 'ok'; }
10723: my ($cdom,$cnum,$filename) =
10724: ($file=~m|^\Q$perlvar{'lonDocRoot'}\E/+userfiles/+($match_domain)/+($match_name)/+(.*)|);
10725: my $uri="/uploaded/$cdom/$cnum/$filename";
10726: if (-e "$file") {
10727: # we already have a local copy, check it out
10728: my @fileinfo = stat($file);
10729: my $rtncode;
10730: my $info;
10731: my $lwpresp = &getuploaded('HEAD',$uri,$cdom,$cnum,\$info,\$rtncode);
10732: if ($lwpresp ne 'ok') {
10733: # there is no such file anymore, even though we had a local copy
10734: if ($rtncode eq '404') {
10735: unlink($file);
10736: }
10737: return -1;
10738: }
10739: if ($info < $fileinfo[9]) {
10740: # nice, the file we have is up-to-date, just say okay
10741: return 'ok';
10742: } else {
10743: # the file is outdated, get rid of it
10744: unlink($file);
10745: }
10746: }
10747: # one way or the other, at this point, we don't have the file
10748: # construct the correct path for the file
10749: my @parts = ($cdom,$cnum);
10750: if ($filename =~ m|^(.+)/[^/]+$|) {
10751: push @parts, split(/\//,$1);
10752: }
10753: my $path = $perlvar{'lonDocRoot'}.'/userfiles';
10754: foreach my $part (@parts) {
10755: $path .= '/'.$part;
10756: if (!-e $path) {
10757: mkdir($path,0770);
10758: }
10759: }
10760: # now the path exists for sure
10761: # get a user agent
10762: my $ua=new LWP::UserAgent;
10763: my $transferfile=$file.'.in.transfer';
10764: # FIXME: this should flock
10765: if (-e $transferfile) { return 'ok'; }
10766: my $request;
10767: $uri=~s/^\///;
10768: my $homeserver = &homeserver($cnum,$cdom);
10769: my $protocol = $protocol{$homeserver};
10770: $protocol = 'http' if ($protocol ne 'https');
10771: $request=new HTTP::Request('GET',$protocol.'://'.&hostname($homeserver).'/raw/'.$uri);
10772: my $response=$ua->request($request,$transferfile);
10773: # did it work?
10774: if ($response->is_error()) {
10775: unlink($transferfile);
10776: &logthis("Userfile repcopy failed for $uri");
10777: return -1;
10778: }
10779: # worked, rename the transfer file
10780: rename($transferfile,$file);
10781: return 'ok';
10782: }
10783:
10784: sub tokenwrapper {
10785: my $uri=shift;
10786: $uri=~s|^https?\://([^/]+)||;
10787: $uri=~s|^/||;
10788: $env{'user.environment'}=~/\/([^\/]+)\.id/;
10789: my $token=$1;
10790: my (undef,$udom,$uname,$file)=split('/',$uri,4);
10791: if ($udom && $uname && $file) {
10792: $file=~s|(\?\.*)*$||;
10793: &appenv({"userfile.$udom/$uname/$file" => $env{'request.course.id'}});
10794: my $homeserver = &homeserver($uname,$udom);
10795: my $protocol = $protocol{$homeserver};
10796: $protocol = 'http' if ($protocol ne 'https');
10797: return $protocol.'://'.&hostname($homeserver).'/'.$uri.
10798: (($uri=~/\?/)?'&':'?').'token='.$token.
10799: '&tokenissued='.$perlvar{'lonHostID'};
10800: } else {
10801: return '/adm/notfound.html';
10802: }
10803: }
10804:
10805: # call with reqtype HEAD: get last modification time
10806: # call with reqtype GET: get the file contents
10807: # Do not call this with reqtype GET for large files! It loads everything into memory
10808: #
10809: sub getuploaded {
10810: my ($reqtype,$uri,$cdom,$cnum,$info,$rtncode) = @_;
10811: $uri=~s/^\///;
10812: my $homeserver = &homeserver($cnum,$cdom);
10813: my $protocol = $protocol{$homeserver};
10814: $protocol = 'http' if ($protocol ne 'https');
10815: $uri = $protocol.'://'.&hostname($homeserver).'/raw/'.$uri;
10816: my $ua=new LWP::UserAgent;
10817: my $request=new HTTP::Request($reqtype,$uri);
10818: my $response=$ua->request($request);
10819: $$rtncode = $response->code;
10820: if (! $response->is_success()) {
10821: return 'failed';
10822: }
10823: if ($reqtype eq 'HEAD') {
10824: $$info = &HTTP::Date::str2time( $response->header('Last-modified') );
10825: } elsif ($reqtype eq 'GET') {
10826: $$info = $response->content;
10827: }
10828: return 'ok';
10829: }
10830:
10831: sub readfile {
10832: my $file = shift;
10833: if ( (! -e $file ) || ($file eq '') ) { return -1; };
10834: my $fh;
10835: open($fh,"<$file");
10836: my $a='';
10837: while (my $line = <$fh>) { $a .= $line; }
10838: return $a;
10839: }
10840:
10841: sub filelocation {
10842: my ($dir,$file) = @_;
10843: my $location;
10844: $file=~ s/^\s*(\S+)\s*$/$1/; ## strip off leading and trailing spaces
10845:
10846: if ($file =~ m-^/adm/-) {
10847: $file=~s-^/adm/wrapper/-/-;
10848: $file=~s-^/adm/coursedocs/showdoc/-/-;
10849: }
10850:
10851: if ($file =~ m-^\Q$Apache::lonnet::perlvar{'lonTabDir'}\E/-) {
10852: $location = $file;
10853: } elsif ($file=~/^\/*(uploaded|editupload)/) { # is an uploaded file
10854: my ($udom,$uname,$filename)=
10855: ($file=~m -^/+(?:uploaded|editupload)/+($match_domain)/+($match_name)/+(.*)$-);
10856: my $home=&homeserver($uname,$udom);
10857: my $is_me=0;
10858: my @ids=¤t_machine_ids();
10859: foreach my $id (@ids) { if ($id eq $home) { $is_me=1; } }
10860: if ($is_me) {
10861: $location=propath($udom,$uname).'/userfiles/'.$filename;
10862: } else {
10863: $location=$Apache::lonnet::perlvar{'lonDocRoot'}.'/userfiles/'.
10864: $udom.'/'.$uname.'/'.$filename;
10865: }
10866: } elsif ($file =~ m-^/adm/-) {
10867: $location = $perlvar{'lonDocRoot'}.'/'.$file;
10868: } else {
10869: $file=~s/^\Q$perlvar{'lonDocRoot'}\E//;
10870: $file=~s:^/(res|priv)/:/:;
10871: my $space=$1;
10872: if ( !( $file =~ m:^/:) ) {
10873: $location = $dir. '/'.$file;
10874: } else {
10875: $location = $perlvar{'lonDocRoot'}.'/'.$space.$file;
10876: }
10877: }
10878: $location=~s://+:/:g; # remove duplicate /
10879: while ($location=~m{/\.\./}) {
10880: if ($location =~ m{/[^/]+/\.\./}) {
10881: $location=~ s{/[^/]+/\.\./}{/}g;
10882: } else {
10883: $location=~ s{/\.\./}{/}g;
10884: }
10885: } #remove dir/..
10886: while ($location=~m:/\./:) {$location=~ s:/\./:/:g;} #remove /./
10887: return $location;
10888: }
10889:
10890: sub hreflocation {
10891: my ($dir,$file)=@_;
10892: unless (($file=~m-^https?\://-i) || ($file=~m-^/-)) {
10893: $file=filelocation($dir,$file);
10894: } elsif ($file=~m-^/adm/-) {
10895: $file=~s-^/adm/wrapper/-/-;
10896: $file=~s-^/adm/coursedocs/showdoc/-/-;
10897: }
10898: if ($file=~m-^\Q$perlvar{'lonDocRoot'}\E-) {
10899: $file=~s-^\Q$perlvar{'lonDocRoot'}\E--;
10900: } elsif ($file=~m-^\Q$perlvar{'lonUsersDir'}\E-) {
10901: $file=~s{^/home/httpd/lonUsers/($match_domain)/./././($match_name)/userfiles/}
10902: {/uploaded/$1/$2/}x;
10903: }
10904: if ($file=~ m{^/userfiles/}) {
10905: $file =~ s{^/userfiles/}{/uploaded/};
10906: }
10907: return $file;
10908: }
10909:
10910:
10911:
10912:
10913:
10914: sub current_machine_domains {
10915: return &machine_domains(&hostname($perlvar{'lonHostID'}));
10916: }
10917:
10918: sub machine_domains {
10919: my ($hostname) = @_;
10920: my @domains;
10921: my %hostname = &all_hostnames();
10922: while( my($id, $name) = each(%hostname)) {
10923: # &logthis("-$id-$name-$hostname-");
10924: if ($hostname eq $name) {
10925: push(@domains,&host_domain($id));
10926: }
10927: }
10928: return @domains;
10929: }
10930:
10931: sub current_machine_ids {
10932: return &machine_ids(&hostname($perlvar{'lonHostID'}));
10933: }
10934:
10935: sub machine_ids {
10936: my ($hostname) = @_;
10937: $hostname ||= &hostname($perlvar{'lonHostID'});
10938: my @ids;
10939: my %name_to_host = &all_names();
10940: if (ref($name_to_host{$hostname}) eq 'ARRAY') {
10941: return @{ $name_to_host{$hostname} };
10942: }
10943: return;
10944: }
10945:
10946: sub additional_machine_domains {
10947: my @domains;
10948: open(my $fh,"<$perlvar{'lonTabDir'}/expected_domains.tab");
10949: while( my $line = <$fh>) {
10950: $line =~ s/\s//g;
10951: push(@domains,$line);
10952: }
10953: return @domains;
10954: }
10955:
10956: sub default_login_domain {
10957: my $domain = $perlvar{'lonDefDomain'};
10958: my $testdomain=(split(/\./,$ENV{'HTTP_HOST'}))[0];
10959: foreach my $posdom (¤t_machine_domains(),
10960: &additional_machine_domains()) {
10961: if (lc($posdom) eq lc($testdomain)) {
10962: $domain=$posdom;
10963: last;
10964: }
10965: }
10966: return $domain;
10967: }
10968:
10969: # ------------------------------------------------------------- Declutters URLs
10970:
10971: sub declutter {
10972: my $thisfn=shift;
10973: if ($thisfn=~m|^/enc/|) { $thisfn=&Apache::lonenc::unencrypted($thisfn); }
10974: $thisfn=~s/^\Q$perlvar{'lonDocRoot'}\E//;
10975: $thisfn=~s/^\///;
10976: $thisfn=~s|^adm/wrapper/||;
10977: $thisfn=~s|^adm/coursedocs/showdoc/||;
10978: $thisfn=~s/^res\///;
10979: $thisfn=~s/^priv\///;
10980: unless (($thisfn =~ /^ext/) || ($thisfn =~ /\.(page|sequence)___\d+___ext/)) {
10981: $thisfn=~s/\?.+$//;
10982: }
10983: return $thisfn;
10984: }
10985:
10986: # ------------------------------------------------------------- Clutter up URLs
10987:
10988: sub clutter {
10989: my $thisfn='/'.&declutter(shift);
10990: if ($thisfn !~ m{^/(uploaded|editupload|adm|userfiles|ext|raw|priv|public)/}
10991: || $thisfn =~ m{^/adm/(includes|pages)} ) {
10992: $thisfn='/res'.$thisfn;
10993: }
10994: if ($thisfn !~m|^/adm|) {
10995: if ($thisfn =~ m|^/ext/|) {
10996: $thisfn='/adm/wrapper'.$thisfn;
10997: } else {
10998: my ($ext) = ($thisfn =~ /\.(\w+)$/);
10999: my $embstyle=&Apache::loncommon::fileembstyle($ext);
11000: if ($embstyle eq 'ssi'
11001: || ($embstyle eq 'hdn')
11002: || ($embstyle eq 'rat')
11003: || ($embstyle eq 'prv')
11004: || ($embstyle eq 'ign')) {
11005: #do nothing with these
11006: } elsif (($embstyle eq 'img')
11007: || ($embstyle eq 'emb')
11008: || ($embstyle eq 'wrp')) {
11009: $thisfn='/adm/wrapper'.$thisfn;
11010: } elsif ($embstyle eq 'unk'
11011: && $thisfn!~/\.(sequence|page)$/) {
11012: $thisfn='/adm/coursedocs/showdoc'.$thisfn;
11013: } else {
11014: # &logthis("Got a blank emb style");
11015: }
11016: }
11017: }
11018: return $thisfn;
11019: }
11020:
11021: sub clutter_with_no_wrapper {
11022: my $uri = &clutter(shift);
11023: if ($uri =~ m-^/adm/-) {
11024: $uri =~ s-^/adm/wrapper/-/-;
11025: $uri =~ s-^/adm/coursedocs/showdoc/-/-;
11026: }
11027: return $uri;
11028: }
11029:
11030: sub freeze_escape {
11031: my ($value)=@_;
11032: if (ref($value)) {
11033: $value=&nfreeze($value);
11034: return '__FROZEN__'.&escape($value);
11035: }
11036: return &escape($value);
11037: }
11038:
11039:
11040: sub thaw_unescape {
11041: my ($value)=@_;
11042: if ($value =~ /^__FROZEN__/) {
11043: substr($value,0,10,undef);
11044: $value=&unescape($value);
11045: return &thaw($value);
11046: }
11047: return &unescape($value);
11048: }
11049:
11050: sub correct_line_ends {
11051: my ($result)=@_;
11052: $$result =~s/\r\n/\n/mg;
11053: $$result =~s/\r/\n/mg;
11054: }
11055: # ================================================================ Main Program
11056:
11057: sub goodbye {
11058: &logthis("Starting Shut down");
11059: #not converted to using infrastruture and probably shouldn't be
11060: &logthis(sprintf("%-20s is %s",'%badServerCache',length(&nfreeze(\%badServerCache))));
11061: #converted
11062: # &logthis(sprintf("%-20s is %s",'%metacache',scalar(%metacache)));
11063: &logthis(sprintf("%-20s is %s",'%homecache',length(&nfreeze(\%homecache))));
11064: # &logthis(sprintf("%-20s is %s",'%titlecache',length(&nfreeze(\%titlecache))));
11065: # &logthis(sprintf("%-20s is %s",'%courseresdatacache',length(&nfreeze(\%courseresdatacache))));
11066: #1.1 only
11067: # &logthis(sprintf("%-20s is %s",'%userresdatacache',length(&nfreeze(\%userresdatacache))));
11068: # &logthis(sprintf("%-20s is %s",'%getsectioncache',length(&nfreeze(\%getsectioncache))));
11069: # &logthis(sprintf("%-20s is %s",'%courseresversioncache',length(&nfreeze(\%courseresversioncache))));
11070: # &logthis(sprintf("%-20s is %s",'%resversioncache',length(&nfreeze(\%resversioncache))));
11071: &logthis(sprintf("%-20s is %s",'%remembered',length(&nfreeze(\%remembered))));
11072: &logthis(sprintf("%-20s is %s",'kicks',$kicks));
11073: &logthis(sprintf("%-20s is %s",'hits',$hits));
11074: &flushcourselogs();
11075: &logthis("Shutting down");
11076: }
11077:
11078: sub get_dns {
11079: my ($url,$func,$ignore_cache) = @_;
11080: if (!$ignore_cache) {
11081: my ($content,$cached)=
11082: &Apache::lonnet::is_cached_new('dns',$url);
11083: if ($cached) {
11084: &$func($content);
11085: return;
11086: }
11087: }
11088:
11089: my %alldns;
11090: open(my $config,"<$perlvar{'lonTabDir'}/hosts.tab");
11091: foreach my $dns (<$config>) {
11092: next if ($dns !~ /^\^(\S*)/x);
11093: my $line = $1;
11094: my ($host,$protocol) = split(/:/,$line);
11095: if ($protocol ne 'https') {
11096: $protocol = 'http';
11097: }
11098: $alldns{$host} = $protocol;
11099: }
11100: while (%alldns) {
11101: my ($dns) = keys(%alldns);
11102: my $ua=new LWP::UserAgent;
11103: $ua->timeout(30);
11104: my $request=new HTTP::Request('GET',"$alldns{$dns}://$dns$url");
11105: my $response=$ua->request($request);
11106: delete($alldns{$dns});
11107: next if ($response->is_error());
11108: my @content = split("\n",$response->content);
11109: &Apache::lonnet::do_cache_new('dns',$url,\@content,30*24*60*60);
11110: &$func(\@content);
11111: return;
11112: }
11113: close($config);
11114: my $which = (split('/',$url))[3];
11115: &logthis("unable to contact DNS defaulting to on disk file dns_$which.tab\n");
11116: open($config,"<$perlvar{'lonTabDir'}/dns_$which.tab");
11117: my @content = <$config>;
11118: &$func(\@content);
11119: return;
11120: }
11121: # ------------------------------------------------------------ Read domain file
11122: {
11123: my $loaded;
11124: my %domain;
11125:
11126: sub parse_domain_tab {
11127: my ($lines) = @_;
11128: foreach my $line (@$lines) {
11129: next if ($line =~ /^(\#|\s*$ )/x);
11130:
11131: chomp($line);
11132: my ($name,@elements) = split(/:/,$line,9);
11133: my %this_domain;
11134: foreach my $field ('description', 'auth_def', 'auth_arg_def',
11135: 'lang_def', 'city', 'longi', 'lati',
11136: 'primary') {
11137: $this_domain{$field} = shift(@elements);
11138: }
11139: $domain{$name} = \%this_domain;
11140: }
11141: }
11142:
11143: sub reset_domain_info {
11144: undef($loaded);
11145: undef(%domain);
11146: }
11147:
11148: sub load_domain_tab {
11149: my ($ignore_cache) = @_;
11150: &get_dns('/adm/dns/domain',\&parse_domain_tab,$ignore_cache);
11151: my $fh;
11152: if (open($fh,"<".$perlvar{'lonTabDir'}.'/domain.tab')) {
11153: my @lines = <$fh>;
11154: &parse_domain_tab(\@lines);
11155: }
11156: close($fh);
11157: $loaded = 1;
11158: }
11159:
11160: sub domain {
11161: &load_domain_tab() if (!$loaded);
11162:
11163: my ($name,$what) = @_;
11164: return if ( !exists($domain{$name}) );
11165:
11166: if (!$what) {
11167: return $domain{$name}{'description'};
11168: }
11169: return $domain{$name}{$what};
11170: }
11171:
11172: sub domain_info {
11173: &load_domain_tab() if (!$loaded);
11174: return %domain;
11175: }
11176:
11177: }
11178:
11179:
11180: # ------------------------------------------------------------- Read hosts file
11181: {
11182: my %hostname;
11183: my %hostdom;
11184: my %libserv;
11185: my $loaded;
11186: my %name_to_host;
11187: my %internetdom;
11188: my %LC_dns_serv;
11189:
11190: sub parse_hosts_tab {
11191: my ($file) = @_;
11192: foreach my $configline (@$file) {
11193: next if ($configline =~ /^(\#|\s*$ )/x);
11194: chomp($configline);
11195: if ($configline =~ /^\^/) {
11196: if ($configline =~ /^\^([\w.\-]+)/) {
11197: $LC_dns_serv{$1} = 1;
11198: }
11199: next;
11200: }
11201: my ($id,$domain,$role,$name,$protocol,$intdom)=split(/:/,$configline);
11202: $name=~s/\s//g;
11203: if ($id && $domain && $role && $name) {
11204: $hostname{$id}=$name;
11205: push(@{$name_to_host{$name}}, $id);
11206: $hostdom{$id}=$domain;
11207: if ($role eq 'library') { $libserv{$id}=$name; }
11208: if (defined($protocol)) {
11209: if ($protocol eq 'https') {
11210: $protocol{$id} = $protocol;
11211: } else {
11212: $protocol{$id} = 'http';
11213: }
11214: } else {
11215: $protocol{$id} = 'http';
11216: }
11217: if (defined($intdom)) {
11218: $internetdom{$id} = $intdom;
11219: }
11220: }
11221: }
11222: }
11223:
11224: sub reset_hosts_info {
11225: &purge_remembered();
11226: &reset_domain_info();
11227: &reset_hosts_ip_info();
11228: undef(%name_to_host);
11229: undef(%hostname);
11230: undef(%hostdom);
11231: undef(%libserv);
11232: undef($loaded);
11233: }
11234:
11235: sub load_hosts_tab {
11236: my ($ignore_cache) = @_;
11237: &get_dns('/adm/dns/hosts',\&parse_hosts_tab,$ignore_cache);
11238: open(my $config,"<$perlvar{'lonTabDir'}/hosts.tab");
11239: my @config = <$config>;
11240: &parse_hosts_tab(\@config);
11241: close($config);
11242: $loaded=1;
11243: }
11244:
11245: sub hostname {
11246: &load_hosts_tab() if (!$loaded);
11247:
11248: my ($lonid) = @_;
11249: return $hostname{$lonid};
11250: }
11251:
11252: sub all_hostnames {
11253: &load_hosts_tab() if (!$loaded);
11254:
11255: return %hostname;
11256: }
11257:
11258: sub all_names {
11259: &load_hosts_tab() if (!$loaded);
11260:
11261: return %name_to_host;
11262: }
11263:
11264: sub all_host_domain {
11265: &load_hosts_tab() if (!$loaded);
11266: return %hostdom;
11267: }
11268:
11269: sub is_library {
11270: &load_hosts_tab() if (!$loaded);
11271:
11272: return exists($libserv{$_[0]});
11273: }
11274:
11275: sub all_library {
11276: &load_hosts_tab() if (!$loaded);
11277:
11278: return %libserv;
11279: }
11280:
11281: sub unique_library {
11282: #2x reverse removes all hostnames that appear more than once
11283: my %unique = reverse &all_library();
11284: return reverse %unique;
11285: }
11286:
11287: sub get_servers {
11288: &load_hosts_tab() if (!$loaded);
11289:
11290: my ($domain,$type) = @_;
11291: my %possible_hosts = ($type eq 'library') ? %libserv
11292: : %hostname;
11293: my %result;
11294: if (ref($domain) eq 'ARRAY') {
11295: while ( my ($host,$hostname) = each(%possible_hosts)) {
11296: if (grep(/^\Q$hostdom{$host}\E$/,@$domain)) {
11297: $result{$host} = $hostname;
11298: }
11299: }
11300: } else {
11301: while ( my ($host,$hostname) = each(%possible_hosts)) {
11302: if ($hostdom{$host} eq $domain) {
11303: $result{$host} = $hostname;
11304: }
11305: }
11306: }
11307: return %result;
11308: }
11309:
11310: sub get_unique_servers {
11311: my %unique = reverse &get_servers(@_);
11312: return reverse %unique;
11313: }
11314:
11315: sub host_domain {
11316: &load_hosts_tab() if (!$loaded);
11317:
11318: my ($lonid) = @_;
11319: return $hostdom{$lonid};
11320: }
11321:
11322: sub all_domains {
11323: &load_hosts_tab() if (!$loaded);
11324:
11325: my %seen;
11326: my @uniq = grep(!$seen{$_}++, values(%hostdom));
11327: return @uniq;
11328: }
11329:
11330: sub internet_dom {
11331: &load_hosts_tab() if (!$loaded);
11332:
11333: my ($lonid) = @_;
11334: return $internetdom{$lonid};
11335: }
11336:
11337: sub is_LC_dns {
11338: &load_hosts_tab() if (!$loaded);
11339:
11340: my ($hostname) = @_;
11341: return exists($LC_dns_serv{$hostname});
11342: }
11343:
11344: }
11345:
11346: {
11347: my %iphost;
11348: my %name_to_ip;
11349: my %lonid_to_ip;
11350:
11351: sub get_hosts_from_ip {
11352: my ($ip) = @_;
11353: my %iphosts = &get_iphost();
11354: if (ref($iphosts{$ip})) {
11355: return @{$iphosts{$ip}};
11356: }
11357: return;
11358: }
11359:
11360: sub reset_hosts_ip_info {
11361: undef(%iphost);
11362: undef(%name_to_ip);
11363: undef(%lonid_to_ip);
11364: }
11365:
11366: sub get_host_ip {
11367: my ($lonid) = @_;
11368: if (exists($lonid_to_ip{$lonid})) {
11369: return $lonid_to_ip{$lonid};
11370: }
11371: my $name=&hostname($lonid);
11372: my $ip = gethostbyname($name);
11373: return if (!$ip || length($ip) ne 4);
11374: $ip=inet_ntoa($ip);
11375: $name_to_ip{$name} = $ip;
11376: $lonid_to_ip{$lonid} = $ip;
11377: return $ip;
11378: }
11379:
11380: sub get_iphost {
11381: my ($ignore_cache) = @_;
11382:
11383: if (!$ignore_cache) {
11384: if (%iphost) {
11385: return %iphost;
11386: }
11387: my ($ip_info,$cached)=
11388: &Apache::lonnet::is_cached_new('iphost','iphost');
11389: if ($cached) {
11390: %iphost = %{$ip_info->[0]};
11391: %name_to_ip = %{$ip_info->[1]};
11392: %lonid_to_ip = %{$ip_info->[2]};
11393: return %iphost;
11394: }
11395: }
11396:
11397: # get yesterday's info for fallback
11398: my %old_name_to_ip;
11399: my ($ip_info,$cached)=
11400: &Apache::lonnet::is_cached_new('iphost','iphost');
11401: if ($cached) {
11402: %old_name_to_ip = %{$ip_info->[1]};
11403: }
11404:
11405: my %name_to_host = &all_names();
11406: foreach my $name (keys(%name_to_host)) {
11407: my $ip;
11408: if (!exists($name_to_ip{$name})) {
11409: $ip = gethostbyname($name);
11410: if (!$ip || length($ip) ne 4) {
11411: if (defined($old_name_to_ip{$name})) {
11412: $ip = $old_name_to_ip{$name};
11413: &logthis("Can't find $name defaulting to old $ip");
11414: } else {
11415: &logthis("Name $name no IP found");
11416: next;
11417: }
11418: } else {
11419: $ip=inet_ntoa($ip);
11420: }
11421: $name_to_ip{$name} = $ip;
11422: } else {
11423: $ip = $name_to_ip{$name};
11424: }
11425: foreach my $id (@{ $name_to_host{$name} }) {
11426: $lonid_to_ip{$id} = $ip;
11427: }
11428: push(@{$iphost{$ip}},@{$name_to_host{$name}});
11429: }
11430: &Apache::lonnet::do_cache_new('iphost','iphost',
11431: [\%iphost,\%name_to_ip,\%lonid_to_ip],
11432: 48*60*60);
11433:
11434: return %iphost;
11435: }
11436:
11437: #
11438: # Given a DNS returns the loncapa host name for that DNS
11439: #
11440: sub host_from_dns {
11441: my ($dns) = @_;
11442: my @hosts;
11443: my $ip;
11444:
11445: if (exists($name_to_ip{$dns})) {
11446: $ip = $name_to_ip{$dns};
11447: }
11448: if (!$ip) {
11449: $ip = gethostbyname($dns); # Initial translation to IP is in net order.
11450: if (length($ip) == 4) {
11451: $ip = &IO::Socket::inet_ntoa($ip);
11452: }
11453: }
11454: if ($ip) {
11455: @hosts = get_hosts_from_ip($ip);
11456: return $hosts[0];
11457: }
11458: return undef;
11459: }
11460:
11461: sub get_internet_names {
11462: my ($lonid) = @_;
11463: return if ($lonid eq '');
11464: my ($idnref,$cached)=
11465: &Apache::lonnet::is_cached_new('internetnames',$lonid);
11466: if ($cached) {
11467: return $idnref;
11468: }
11469: my $ip = &get_host_ip($lonid);
11470: my @hosts = &get_hosts_from_ip($ip);
11471: my %iphost = &get_iphost();
11472: my (@idns,%seen);
11473: foreach my $id (@hosts) {
11474: my $dom = &host_domain($id);
11475: my $prim_id = &domain($dom,'primary');
11476: my $prim_ip = &get_host_ip($prim_id);
11477: next if ($seen{$prim_ip});
11478: if (ref($iphost{$prim_ip}) eq 'ARRAY') {
11479: foreach my $id (@{$iphost{$prim_ip}}) {
11480: my $intdom = &internet_dom($id);
11481: unless (grep(/^\Q$intdom\E$/,@idns)) {
11482: push(@idns,$intdom);
11483: }
11484: }
11485: }
11486: $seen{$prim_ip} = 1;
11487: }
11488: return &Apache::lonnet::do_cache_new('internetnames',$lonid,\@idns,12*60*60);
11489: }
11490:
11491: }
11492:
11493: sub all_loncaparevs {
11494: 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);
11495: }
11496:
11497: BEGIN {
11498:
11499: # ----------------------------------- Read loncapa.conf and loncapa_apache.conf
11500: unless ($readit) {
11501: {
11502: my $configvars = LONCAPA::Configuration::read_conf('loncapa.conf');
11503: %perlvar = (%perlvar,%{$configvars});
11504: }
11505:
11506:
11507: # ------------------------------------------------------ Read spare server file
11508: {
11509: open(my $config,"<$perlvar{'lonTabDir'}/spare.tab");
11510:
11511: while (my $configline=<$config>) {
11512: chomp($configline);
11513: if ($configline) {
11514: my ($host,$type) = split(':',$configline,2);
11515: if (!defined($type) || $type eq '') { $type = 'default' };
11516: push(@{ $spareid{$type} }, $host);
11517: }
11518: }
11519: close($config);
11520: }
11521: # ------------------------------------------------------------ Read permissions
11522: {
11523: open(my $config,"<$perlvar{'lonTabDir'}/roles.tab");
11524:
11525: while (my $configline=<$config>) {
11526: chomp($configline);
11527: if ($configline) {
11528: my ($role,$perm)=split(/ /,$configline);
11529: if ($perm ne '') { $pr{$role}=$perm; }
11530: }
11531: }
11532: close($config);
11533: }
11534:
11535: # -------------------------------------------- Read plain texts for permissions
11536: {
11537: open(my $config,"<$perlvar{'lonTabDir'}/rolesplain.tab");
11538:
11539: while (my $configline=<$config>) {
11540: chomp($configline);
11541: if ($configline) {
11542: my ($short,@plain)=split(/:/,$configline);
11543: %{$prp{$short}} = ();
11544: if (@plain > 0) {
11545: $prp{$short}{'std'} = $plain[0];
11546: for (my $i=1; $i<@plain; $i++) {
11547: $prp{$short}{'alt'.$i} = $plain[$i];
11548: }
11549: }
11550: }
11551: }
11552: close($config);
11553: }
11554:
11555: # ---------------------------------------------------------- Read package table
11556: {
11557: open(my $config,"<$perlvar{'lonTabDir'}/packages.tab");
11558:
11559: while (my $configline=<$config>) {
11560: if ($configline !~ /\S/ || $configline=~/^#/) { next; }
11561: chomp($configline);
11562: my ($short,$plain)=split(/:/,$configline);
11563: my ($pack,$name)=split(/\&/,$short);
11564: if ($plain ne '') {
11565: $packagetab{$pack.'&'.$name.'&name'}=$name;
11566: $packagetab{$short}=$plain;
11567: }
11568: }
11569: close($config);
11570: }
11571:
11572: # ---------------------------------------------------------- Read loncaparev table
11573: {
11574: if (-e "$perlvar{'lonTabDir'}/loncaparevs.tab") {
11575: if (open(my $config,"<$perlvar{'lonTabDir'}/loncaparevs.tab")) {
11576: while (my $configline=<$config>) {
11577: chomp($configline);
11578: my ($hostid,$loncaparev)=split(/:/,$configline);
11579: $loncaparevs{$hostid}=$loncaparev;
11580: }
11581: close($config);
11582: }
11583: }
11584: }
11585:
11586: # ---------------------------------------------------------- Read serverhostID table
11587: {
11588: if (-e "$perlvar{'lonTabDir'}/serverhomeIDs.tab") {
11589: if (open(my $config,"<$perlvar{'lonTabDir'}/serverhomeIDs.tab")) {
11590: while (my $configline=<$config>) {
11591: chomp($configline);
11592: my ($name,$id)=split(/:/,$configline);
11593: $serverhomeIDs{$name}=$id;
11594: }
11595: close($config);
11596: }
11597: }
11598: }
11599:
11600: {
11601: my $file = $Apache::lonnet::perlvar{'lonTabDir'}.'/releaseslist.xml';
11602: if (-e $file) {
11603: my $parser = HTML::LCParser->new($file);
11604: while (my $token = $parser->get_token()) {
11605: if ($token->[0] eq 'S') {
11606: my $item = $token->[1];
11607: my $name = $token->[2]{'name'};
11608: my $value = $token->[2]{'value'};
11609: if ($item ne '' && $name ne '' && $value ne '') {
11610: my $release = $parser->get_text();
11611: $release =~ s/(^\s*|\s*$ )//gx;
11612: $needsrelease{$item.':'.$name.':'.$value} = $release;
11613: }
11614: }
11615: }
11616: }
11617: }
11618:
11619: # ---------------------------------------------------------- Read managers table
11620: {
11621: if (-e "$perlvar{'lonTabDir'}/managers.tab") {
11622: if (open(my $config,"<$perlvar{'lonTabDir'}/managers.tab")) {
11623: while (my $configline=<$config>) {
11624: chomp($configline);
11625: next if ($configline =~ /^\#/);
11626: if (($configline =~ /^[\w\-]+$/) || ($configline =~ /^[\w\-]+\:[\w\-]+$/)) {
11627: $managerstab{$configline} = 1;
11628: }
11629: }
11630: close($config);
11631: }
11632: }
11633: }
11634:
11635: # ------------- set up temporary directory
11636: {
11637: $tmpdir = LONCAPA::tempdir();
11638:
11639: }
11640:
11641: $memcache=new Cache::Memcached({'servers' => ['127.0.0.1:11211'],
11642: 'compress_threshold'=> 20_000,
11643: });
11644:
11645: $processmarker='_'.time.'_'.$perlvar{'lonHostID'};
11646: $dumpcount=0;
11647: $locknum=0;
11648:
11649: &logtouch();
11650: &logthis('<font color="yellow">INFO: Read configuration</font>');
11651: $readit=1;
11652: {
11653: use integer;
11654: my $test=(2**32)+1;
11655: if ($test != 0) { $_64bit=1; } else { $_64bit=0; }
11656: &logthis(" Detected 64bit platform ($_64bit)");
11657: }
11658: }
11659: }
11660:
11661: 1;
11662: __END__
11663:
11664: =pod
11665:
11666: =head1 NAME
11667:
11668: Apache::lonnet - Subroutines to ask questions about things in the network.
11669:
11670: =head1 SYNOPSIS
11671:
11672: Invoked by other LON-CAPA modules, when they need to talk to or about objects in the network.
11673:
11674: &Apache::lonnet::SUBROUTINENAME(ARGUMENTS);
11675:
11676: Common parameters:
11677:
11678: =over 4
11679:
11680: =item *
11681:
11682: $uname : an internal username (if $cname expecting a course Id specifically)
11683:
11684: =item *
11685:
11686: $udom : a domain (if $cdom expecting a course's domain specifically)
11687:
11688: =item *
11689:
11690: $symb : a resource instance identifier
11691:
11692: =item *
11693:
11694: $namespace : the name of a .db file that contains the data needed or
11695: being set.
11696:
11697: =back
11698:
11699: =head1 OVERVIEW
11700:
11701: lonnet provides subroutines which interact with the
11702: lonc/lond (TCP) network layer of LON-CAPA. They can be used to ask
11703: about classes, users, and resources.
11704:
11705: For many of these objects you can also use this to store data about
11706: them or modify them in various ways.
11707:
11708: =head2 Symbs
11709:
11710: To identify a specific instance of a resource, LON-CAPA uses symbols
11711: or "symbs"X<symb>. These identifiers are built from the URL of the
11712: map, the resource number of the resource in the map, and the URL of
11713: the resource itself. The latter is somewhat redundant, but might help
11714: if maps change.
11715:
11716: An example is
11717:
11718: msu/korte/parts/part1.sequence___19___msu/korte/tests/part12.problem
11719:
11720: The respective map entry is
11721:
11722: <resource id="19" src="/res/msu/korte/tests/part12.problem"
11723: title="Problem 2">
11724: </resource>
11725:
11726: Symbs are used by the random number generator, as well as to store and
11727: restore data specific to a certain instance of for example a problem.
11728:
11729: =head2 Storing And Retrieving Data
11730:
11731: X<store()>X<cstore()>X<restore()>Three of the most important functions
11732: in C<lonnet.pm> are C<&Apache::lonnet::cstore()>,
11733: C<&Apache::lonnet:restore()>, and C<&Apache::lonnet::store()>, which
11734: is is the non-critical message twin of cstore. These functions are for
11735: handlers to store a perl hash to a user's permanent data space in an
11736: easy manner, and to retrieve it again on another call. It is expected
11737: that a handler would use this once at the beginning to retrieve data,
11738: and then again once at the end to send only the new data back.
11739:
11740: The data is stored in the user's data directory on the user's
11741: homeserver under the ID of the course.
11742:
11743: The hash that is returned by restore will have all of the previous
11744: value for all of the elements of the hash.
11745:
11746: Example:
11747:
11748: #creating a hash
11749: my %hash;
11750: $hash{'foo'}='bar';
11751:
11752: #storing it
11753: &Apache::lonnet::cstore(\%hash);
11754:
11755: #changing a value
11756: $hash{'foo'}='notbar';
11757:
11758: #adding a new value
11759: $hash{'bar'}='foo';
11760: &Apache::lonnet::cstore(\%hash);
11761:
11762: #retrieving the hash
11763: my %history=&Apache::lonnet::restore();
11764:
11765: #print the hash
11766: foreach my $key (sort(keys(%history))) {
11767: print("\%history{$key} = $history{$key}");
11768: }
11769:
11770: Will print out:
11771:
11772: %history{1:foo} = bar
11773: %history{1:keys} = foo:timestamp
11774: %history{1:timestamp} = 990455579
11775: %history{2:bar} = foo
11776: %history{2:foo} = notbar
11777: %history{2:keys} = foo:bar:timestamp
11778: %history{2:timestamp} = 990455580
11779: %history{bar} = foo
11780: %history{foo} = notbar
11781: %history{timestamp} = 990455580
11782: %history{version} = 2
11783:
11784: Note that the special hash entries C<keys>, C<version> and
11785: C<timestamp> were added to the hash. C<version> will be equal to the
11786: total number of versions of the data that have been stored. The
11787: C<timestamp> attribute will be the UNIX time the hash was
11788: stored. C<keys> is available in every historical section to list which
11789: keys were added or changed at a specific historical revision of a
11790: hash.
11791:
11792: B<Warning>: do not store the hash that restore returns directly. This
11793: will cause a mess since it will restore the historical keys as if the
11794: were new keys. I.E. 1:foo will become 1:1:foo etc.
11795:
11796: Calling convention:
11797:
11798: my %record=&Apache::lonnet::restore($symb,$courseid,$domain,$uname,$home);
11799: &Apache::lonnet::cstore(\%newrecord,$symb,$courseid,$domain,$uname,$home);
11800:
11801: For more detailed information, see lonnet specific documentation.
11802:
11803: =head1 RETURN MESSAGES
11804:
11805: =over 4
11806:
11807: =item * B<con_lost>: unable to contact remote host
11808:
11809: =item * B<con_delayed>: unable to contact remote host, message will be delivered
11810: when the connection is brought back up
11811:
11812: =item * B<con_failed>: unable to contact remote host and unable to save message
11813: for later delivery
11814:
11815: =item * B<error:>: an error a occurred, a description of the error follows the :
11816:
11817: =item * B<no_such_host>: unable to fund a host associated with the user/domain
11818: that was requested
11819:
11820: =back
11821:
11822: =head1 PUBLIC SUBROUTINES
11823:
11824: =head2 Session Environment Functions
11825:
11826: =over 4
11827:
11828: =item *
11829: X<appenv()>
11830: B<appenv($hashref,$rolesarrayref)>: the value of %{$hashref} is written to
11831: the user envirnoment file, and will be restored for each access this
11832: user makes during this session, also modifies the %env for the current
11833: process. Optional rolesarrayref - if defined contains a reference to an array
11834: of roles which are exempt from the restriction on modifying user.role entries
11835: in the user's environment.db and in %env.
11836:
11837: =item *
11838: X<delenv()>
11839: B<delenv($delthis,$regexp)>: removes all items from the session
11840: environment file that begin with $delthis. If the
11841: optional second arg - $regexp - is true, $delthis is treated as a
11842: regular expression, otherwise \Q$delthis\E is used.
11843: The values are also deleted from the current processes %env.
11844:
11845: =item * get_env_multiple($name)
11846:
11847: gets $name from the %env hash, it seemlessly handles the cases where multiple
11848: values may be defined and end up as an array ref.
11849:
11850: returns an array of values
11851:
11852: =back
11853:
11854: =head2 User Information
11855:
11856: =over 4
11857:
11858: =item *
11859: X<queryauthenticate()>
11860: B<queryauthenticate($uname,$udom)>: try to determine user's current
11861: authentication scheme
11862:
11863: =item *
11864: X<authenticate()>
11865: B<authenticate($uname,$upass,$udom,$checkdefauth,$clientcancheckhost)>: try to
11866: authenticate user from domain's lib servers (first use the current
11867: one). C<$upass> should be the users password.
11868: $checkdefauth is optional (value is 1 if a check should be made to
11869: authenticate user using default authentication method, and allow
11870: account creation if username does not have account in the domain).
11871: $clientcancheckhost is optional (value is 1 if checking whether the
11872: server can host will occur on the client side in lonauth.pm).
11873:
11874: =item *
11875: X<homeserver()>
11876: B<homeserver($uname,$udom)>: find the server which has
11877: the user's directory and files (there must be only one), this caches
11878: the answer, and also caches if there is a borken connection.
11879:
11880: =item *
11881: X<idget()>
11882: B<idget($udom,@ids)>: find the usernames behind a list of IDs
11883: (IDs are a unique resource in a domain, there must be only 1 ID per
11884: username, and only 1 username per ID in a specific domain) (returns
11885: hash: id=>name,id=>name)
11886:
11887: =item *
11888: X<idrget()>
11889: B<idrget($udom,@unames)>: find the IDs behind a list of
11890: usernames (returns hash: name=>id,name=>id)
11891:
11892: =item *
11893: X<idput()>
11894: B<idput($udom,%ids)>: store away a list of names and associated IDs
11895:
11896: =item *
11897: X<rolesinit()>
11898: B<rolesinit($udom,$username)>: get user privileges.
11899: returns user role, first access and timer interval hashes
11900:
11901: =item *
11902: X<privileged()>
11903: B<privileged($username,$domain)>: returns a true if user has a
11904: privileged and active role (i.e. su or dc), false otherwise.
11905:
11906: =item *
11907: X<getsection()>
11908: B<getsection($udom,$uname,$cname)>: finds the section of student in the
11909: course $cname, return section name/number or '' for "not in course"
11910: and '-1' for "no section"
11911:
11912: =item *
11913: X<userenvironment()>
11914: B<userenvironment($udom,$uname,@what)>: gets the values of the keys
11915: passed in @what from the requested user's environment, returns a hash
11916:
11917: =item *
11918: X<userlog_query()>
11919: B<userlog_query($uname,$udom,%filters)>: retrieves data from a user's
11920: activity.log file. %filters defines filters applied when parsing the
11921: log file. These can be start or end timestamps, or the type of action
11922: - log to look for Login or Logout events, check for Checkin or
11923: Checkout, role for role selection. The response is in the form
11924: timestamp1:hostid1:event1×tamp2:hostid2:event2 where events are
11925: escaped strings of the action recorded in the activity.log file.
11926:
11927: =back
11928:
11929: =head2 User Roles
11930:
11931: =over 4
11932:
11933: =item *
11934:
11935: allowed($priv,$uri,$symb,$role) : check for a user privilege; returns codes for allowed actions
11936: F: full access
11937: U,I,K: authentication modes (cxx only)
11938: '': forbidden
11939: 1: user needs to choose course
11940: 2: browse allowed
11941: A: passphrase authentication needed
11942:
11943: =item *
11944:
11945: definerole($rolename,$sysrole,$domrole,$courole) : define role; define a custom
11946: role rolename set privileges in format of lonTabs/roles.tab for system, domain,
11947: and course level
11948:
11949: =item *
11950:
11951: plaintext($short,$type,$cid,$forcedefault) : return value in %prp hash
11952: (rolesplain.tab); plain text explanation of a user role term.
11953: $type is Course (default) or Community.
11954: If $forcedefault evaluates to true, text returned will be default
11955: text for $type. Otherwise, if this is a course, the text returned
11956: will be a custom name for the role (if defined in the course's
11957: environment). If no custom name is defined the default is returned.
11958:
11959: =item *
11960:
11961: get_my_roles($uname,$udom,$context,$types,$roles,$roledoms,$withsec) :
11962: All arguments are optional. Returns a hash of a roles, either for
11963: co-author/assistant author roles for a user's Construction Space
11964: (default), or if $context is 'userroles', roles for the user himself,
11965: In the hash, keys are set to colon-separated $uname,$udom,$role, and
11966: (optionally) if $withsec is true, a fourth colon-separated item - $section.
11967: For each key, value is set to colon-separated start and end times for
11968: the role. If no username and domain are specified, will default to
11969: current user/domain. Types, roles, and roledoms are references to arrays
11970: of role statuses (active, future or previous), roles
11971: (e.g., cc,in, st etc.) and domains of the roles which can be used
11972: to restrict the list of roles reported. If no array ref is
11973: provided for types, will default to return only active roles.
11974:
11975: =back
11976:
11977: =head2 User Modification
11978:
11979: =over 4
11980:
11981: =item *
11982:
11983: assignrole($udom,$uname,$url,$role,$end,$start,$deleteflag,$selfenroll,$context) : assign role; give a role to a
11984: user for the level given by URL. Optional start and end dates (leave empty
11985: string or zero for "no date")
11986:
11987: =item *
11988:
11989: changepass($uname,$udom,$currentpass,$newpass,$server) : attempts to
11990: change a users, password, possible return values are: ok,
11991: pwchange_failure, non_authorized, auth_mode_error, unknown_user,
11992: refused
11993:
11994: =item *
11995:
11996: modifyuserauth($udom,$uname,$umode,$upass) : modify user authentication
11997:
11998: =item *
11999:
12000: modifyuser($udom,$uname,$uid,$umode,$upass,$first,$middle,$last, $gene,
12001: $forceid,$desiredhome,$email,$inststatus,$candelete) :
12002:
12003: will update user information (firstname,middlename,lastname,generation,
12004: permanentemail), and if forceid is true, student/employee ID also.
12005: A user's institutional affiliation(s) can also be updated.
12006: User information fields will not be overwritten with empty entries
12007: unless the field is included in the $candelete array reference.
12008: This array is included when a single user is modified via "Manage Users",
12009: or when Autoupdate.pl is run by cron in a domain.
12010:
12011: =item *
12012:
12013: modifystudent
12014:
12015: modify a student's enrollment and identification information.
12016: The course id is resolved based on the current users environment.
12017: This means the envoking user must be a course coordinator or otherwise
12018: associated with a course.
12019:
12020: This call is essentially a wrapper for lonnet::modifyuser and
12021: lonnet::modify_student_enrollment
12022:
12023: Inputs:
12024:
12025: =over 4
12026:
12027: =item B<$udom> Student's loncapa domain
12028:
12029: =item B<$uname> Student's loncapa login name
12030:
12031: =item B<$uid> Student/Employee ID
12032:
12033: =item B<$umode> Student's authentication mode
12034:
12035: =item B<$upass> Student's password
12036:
12037: =item B<$first> Student's first name
12038:
12039: =item B<$middle> Student's middle name
12040:
12041: =item B<$last> Student's last name
12042:
12043: =item B<$gene> Student's generation
12044:
12045: =item B<$usec> Student's section in course
12046:
12047: =item B<$end> Unix time of the roles expiration
12048:
12049: =item B<$start> Unix time of the roles start date
12050:
12051: =item B<$forceid> If defined, allow $uid to be changed
12052:
12053: =item B<$desiredhome> server to use as home server for student
12054:
12055: =item B<$email> Student's permanent e-mail address
12056:
12057: =item B<$type> Type of enrollment (auto or manual)
12058:
12059: =item B<$locktype> boolean - enrollment type locked to prevent Autoenroll.pl changing manual to auto
12060:
12061: =item B<$cid> courseID - needed if a course role is assigned by a user whose current role is DC
12062:
12063: =item B<$selfenroll> boolean - 1 if user role change occurred via self-enrollment
12064:
12065: =item B<$context> role change context (shown in User Management Logs display in a course)
12066:
12067: =item B<$inststatus> institutional status of user - : separated string of escaped status types
12068:
12069: =back
12070:
12071: =item *
12072:
12073: modify_student_enrollment
12074:
12075: Change a students enrollment status in a class. The environment variable
12076: 'role.request.course' must be defined for this function to proceed.
12077:
12078: Inputs:
12079:
12080: =over 4
12081:
12082: =item $udom, students domain
12083:
12084: =item $uname, students name
12085:
12086: =item $uid, students user id
12087:
12088: =item $first, students first name
12089:
12090: =item $middle
12091:
12092: =item $last
12093:
12094: =item $gene
12095:
12096: =item $usec
12097:
12098: =item $end
12099:
12100: =item $start
12101:
12102: =item $type
12103:
12104: =item $locktype
12105:
12106: =item $cid
12107:
12108: =item $selfenroll
12109:
12110: =item $context
12111:
12112: =back
12113:
12114:
12115: =item *
12116:
12117: assigncustomrole($udom,$uname,$url,$rdom,$rnam,$rolename,$end,$start) : assign
12118: custom role; give a custom role to a user for the level given by URL. Specify
12119: name and domain of role author, and role name
12120:
12121: =item *
12122:
12123: revokerole($udom,$uname,$url,$role) : revoke a role for url
12124:
12125: =item *
12126:
12127: revokecustomrole($udom,$uname,$url,$role) : revoke a custom role
12128:
12129: =back
12130:
12131: =head2 Course Infomation
12132:
12133: =over 4
12134:
12135: =item *
12136:
12137: coursedescription($courseid,$options) : returns a hash of information about the
12138: specified course id, including all environment settings for the
12139: course, the description of the course will be in the hash under the
12140: key 'description'
12141:
12142: $options is an optional parameter that if supplied is a hash reference that controls
12143: what how this function works. It has the following key/values:
12144:
12145: =over 4
12146:
12147: =item freshen_cache
12148:
12149: If defined, and the environment cache for the course is valid, it is
12150: returned in the returned hash.
12151:
12152: =item one_time
12153:
12154: If defined, the last cache time is set to _now_
12155:
12156: =item user
12157:
12158: If defined, the supplied username is used instead of the current user.
12159:
12160:
12161: =back
12162:
12163: =item *
12164:
12165: resdata($name,$domain,$type,@which) : request for current parameter
12166: setting for a specific $type, where $type is either 'course' or 'user',
12167: @what should be a list of parameters to ask about. This routine caches
12168: answers for 5 minutes.
12169:
12170: =item *
12171:
12172: get_courseresdata($courseid, $domain) : dump the entire course resource
12173: data base, returning a hash that is keyed by the resource name and has
12174: values that are the resource value. I believe that the timestamps and
12175: versions are also returned.
12176:
12177:
12178: =back
12179:
12180: =head2 Course Modification
12181:
12182: =over 4
12183:
12184: =item *
12185:
12186: writecoursepref($courseid,%prefs) : write preferences (environment
12187: database) for a course
12188:
12189: =item *
12190:
12191: createcourse($udom,$description,$url,$course_server,$nonstandard,$inst_code,$course_owner,$crstype,$cnum) : make course
12192:
12193: =item *
12194:
12195: generate_coursenum($udom,$crstype) : get a unique (unused) course number in domain $udom for course type $crstype (Course or Community).
12196:
12197: =item *
12198:
12199: is_course($courseid), is_course($cdom, $cnum)
12200:
12201: Accepts either a combined $courseid (in the form of domain_courseid) or the
12202: two component version $cdom, $cnum. It checks if the specified course exists.
12203:
12204: Returns:
12205: undef if the course doesn't exist, otherwise
12206: in scalar context the combined courseid.
12207: in list context the two components of the course identifier, domain and
12208: courseid.
12209:
12210: =back
12211:
12212: =head2 Resource Subroutines
12213:
12214: =over 4
12215:
12216: =item *
12217:
12218: subscribe($fname) : subscribe to a resource, returns URL if possible (probably should use repcopy instead)
12219:
12220: =item *
12221:
12222: repcopy($filename) : subscribes to the requested file, and attempts to
12223: replicate from the owning library server, Might return
12224: 'unavailable', 'not_found', 'forbidden', 'ok', or
12225: 'bad_request', also attempts to grab the metadata for the
12226: resource. Expects the local filesystem pathname
12227: (/home/httpd/html/res/....)
12228:
12229: =back
12230:
12231: =head2 Resource Information
12232:
12233: =over 4
12234:
12235: =item *
12236:
12237: EXT($varname,$symb,$udom,$uname) : evaluates and returns the value of
12238: a vairety of different possible values, $varname should be a request
12239: string, and the other parameters can be used to specify who and what
12240: one is asking about.
12241:
12242: Possible values for $varname are environment.lastname (or other item
12243: from the envirnment hash), user.name (or someother aspect about the
12244: user), resource.0.maxtries (or some other part and parameter of a
12245: resource)
12246:
12247: =item *
12248:
12249: directcondval($number) : get current value of a condition; reads from a state
12250: string
12251:
12252: =item *
12253:
12254: condval($condidx) : value of condition index based on state
12255:
12256: =item *
12257:
12258: metadata($uri,$what,$liburi,$prefix,$depthcount) : request a
12259: resource's metadata, $what should be either a specific key, or either
12260: 'keys' (to get a list of possible keys) or 'packages' to get a list of
12261: packages that this resource currently uses, the last 3 arguments are only used internally for recursive metadata.
12262:
12263: this function automatically caches all requests
12264:
12265: =item *
12266:
12267: metadata_query($query,$custom,$customshow) : make a metadata query against the
12268: network of library servers; returns file handle of where SQL and regex results
12269: will be stored for query
12270:
12271: =item *
12272:
12273: symbread($filename) : return symbolic list entry (filename argument optional);
12274: returns the data handle
12275:
12276: =item *
12277:
12278: symbverify($symb,$thisfn,$encstate) : verifies that $symb actually exists
12279: and is a possible symb for the URL in $thisfn, and if is an encrypted
12280: resource that the user accessed using /enc/ returns a 1 on success, 0
12281: on failure, user must be in a course, as it assumes the existence of
12282: the course initial hash, and uses $env('request.course.id'}. The third
12283: arg is an optional reference to a scalar. If this arg is passed in the
12284: call to symbverify, it will be set to 1 if the symb has been set to be
12285: encrypted; otherwise it will be null.
12286:
12287: =item *
12288:
12289: symbclean($symb) : removes versions numbers from a symb, returns the
12290: cleaned symb
12291:
12292: =item *
12293:
12294: is_on_map($uri) : checks if the $uri is somewhere on the current
12295: course map, user must be in a course for it to work.
12296:
12297: =item *
12298:
12299: numval($salt) : return random seed value (addend for rndseed)
12300:
12301: =item *
12302:
12303: rndseed($symb,$courseid,$udom,$uname) : create a random sum; returns
12304: a random seed, all arguments are optional, if they aren't sent it uses the
12305: environment to derive them. Note: if symb isn't sent and it can't get one
12306: from &symbread it will use the current time as its return value
12307:
12308: =item *
12309:
12310: ireceipt($funame,$fudom,$fucourseid,$fusymb) : return unique,
12311: unfakeable, receipt
12312:
12313: =item *
12314:
12315: receipt() : API to ireceipt working off of env values; given out to users
12316:
12317: =item *
12318:
12319: countacc($url) : count the number of accesses to a given URL
12320:
12321: =item *
12322:
12323: 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
12324:
12325: =item *
12326:
12327: 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)
12328:
12329: =item *
12330:
12331: expirespread($uname,$udom,$stype,$usymb) : set expire date for spreadsheet
12332:
12333: =item *
12334:
12335: devalidate($symb) : devalidate temporary spreadsheet calculations,
12336: forcing spreadsheet to reevaluate the resource scores next time.
12337:
12338: =back
12339:
12340: =head2 Storing/Retreiving Data
12341:
12342: =over 4
12343:
12344: =item *
12345:
12346: store($storehash,$symb,$namespace,$udom,$uname) : stores hash permanently
12347: for this url; hashref needs to be given and should be a \%hashname; the
12348: remaining args aren't required and if they aren't passed or are '' they will
12349: be derived from the env
12350:
12351: =item *
12352:
12353: cstore($storehash,$symb,$namespace,$udom,$uname) : same as store but
12354: uses critical subroutine
12355:
12356: =item *
12357:
12358: restore($symb,$namespace,$udom,$uname) : returns hash for this symb;
12359: all args are optional
12360:
12361: =item *
12362:
12363: dumpstore($namespace,$udom,$uname,$regexp,$range) :
12364: dumps the complete (or key matching regexp) namespace into a hash
12365: ($udom, $uname, $regexp, $range are optional) for a namespace that is
12366: normally &store()ed into
12367:
12368: $range should be either an integer '100' (give me the first 100
12369: matching records)
12370: or be two integers sperated by a - with no spaces
12371: '30-50' (give me the 30th through the 50th matching
12372: records)
12373:
12374:
12375: =item *
12376:
12377: putstore($namespace,$symb,$version,$storehash,$udomain,$uname) :
12378: replaces a &store() version of data with a replacement set of data
12379: for a particular resource in a namespace passed in the $storehash hash
12380: reference
12381:
12382: =item *
12383:
12384: tmpstore($storehash,$symb,$namespace,$udom,$uname) : storage that
12385: works very similar to store/cstore, but all data is stored in a
12386: temporary location and can be reset using tmpreset, $storehash should
12387: be a hash reference, returns nothing on success
12388:
12389: =item *
12390:
12391: tmprestore($symb,$namespace,$udom,$uname) : storage that works very
12392: similar to restore, but all data is stored in a temporary location and
12393: can be reset using tmpreset. Returns a hash of values on success,
12394: error string otherwise.
12395:
12396: =item *
12397:
12398: tmpreset($symb,$namespace,$udom,$uname) : temporary storage reset,
12399: deltes all keys for $symb form the temporary storage hash.
12400:
12401: =item *
12402:
12403: get($namespace,$storearr,$udom,$uname) : returns hash with keys from array
12404: reference filled in from namesp ($udom and $uname are optional)
12405:
12406: =item *
12407:
12408: del($namespace,$storearr,$udom,$uname) : deletes keys out of array from
12409: namesp ($udom and $uname are optional)
12410:
12411: =item *
12412:
12413: dump($namespace,$udom,$uname,$regexp,$range) :
12414: dumps the complete (or key matching regexp) namespace into a hash
12415: ($udom, $uname, $regexp, $range are optional)
12416:
12417: $range should be either an integer '100' (give me the first 100
12418: matching records)
12419: or be two integers sperated by a - with no spaces
12420: '30-50' (give me the 30th through the 50th matching
12421: records)
12422: =item *
12423:
12424: inc($namespace,$store,$udom,$uname) : increments $store in $namespace.
12425: $store can be a scalar, an array reference, or if the amount to be
12426: incremented is > 1, a hash reference.
12427:
12428: ($udom and $uname are optional)
12429:
12430: =item *
12431:
12432: put($namespace,$storehash,$udom,$uname) : stores hash in namesp
12433: ($udom and $uname are optional)
12434:
12435: =item *
12436:
12437: cput($namespace,$storehash,$udom,$uname) : critical put
12438: ($udom and $uname are optional)
12439:
12440: =item *
12441:
12442: newput($namespace,$storehash,$udom,$uname) :
12443:
12444: Attempts to store the items in the $storehash, but only if they don't
12445: currently exist, if this succeeds you can be certain that you have
12446: successfully created a new key value pair in the $namespace db.
12447:
12448:
12449: Args:
12450: $namespace: name of database to store values to
12451: $storehash: hashref to store to the db
12452: $udom: (optional) domain of user containing the db
12453: $uname: (optional) name of user caontaining the db
12454:
12455: Returns:
12456: 'ok' -> succeeded in storing all keys of $storehash
12457: 'key_exists: <key>' -> failed to anything out of $storehash, as at
12458: least <key> already existed in the db (other
12459: requested keys may also already exist)
12460: 'error: <msg>' -> unable to tie the DB or other error occurred
12461: 'con_lost' -> unable to contact request server
12462: 'refused' -> action was not allowed by remote machine
12463:
12464:
12465: =item *
12466:
12467: eget($namespace,$storearr,$udom,$uname) : returns hash with keys from array
12468: reference filled in from namesp (encrypts the return communication)
12469: ($udom and $uname are optional)
12470:
12471: =item *
12472:
12473: log($udom,$name,$home,$message) : write to permanent log for user; use
12474: critical subroutine
12475:
12476: =item *
12477:
12478: get_dom($namespace,$storearr,$udom,$uhome) : returns hash with keys from
12479: array reference filled in from namespace found in domain level on either
12480: specified domain server ($uhome) or primary domain server ($udom and $uhome are optional).
12481:
12482: =item *
12483:
12484: put_dom($namespace,$storehash,$udom,$uhome) : stores hash in namespace at
12485: domain level either on specified domain server ($uhome) or primary domain
12486: server ($udom and $uhome are optional)
12487:
12488: =item *
12489:
12490: get_domain_defaults($target_domain) : returns hash with defaults for
12491: authentication and language in the domain. Keys are: auth_def, auth_arg_def,
12492: lang_def; corresponsing values are authentication type (internal, krb4, krb5,
12493: or localauth), initial password or a kerberos realm, language (e.g., en-us).
12494: Values are retrieved from cache (if current), or from domain's configuration.db
12495: (if available), or lastly from values in lonTabs/dns_domain,tab,
12496: or lonTabs/domain.tab.
12497:
12498: %domdefaults = &get_auth_defaults($target_domain);
12499:
12500: =back
12501:
12502: =head2 Network Status Functions
12503:
12504: =over 4
12505:
12506: =item *
12507:
12508: dirlist() : return directory list based on URI (first arg).
12509:
12510: Inputs: 1 required, 5 optional.
12511:
12512: =over
12513:
12514: =item
12515: $uri - path to file in filesystem (starts: /res or /userfiles/). Required.
12516:
12517: =item
12518: $userdomain - domain of user/course to be listed. Extracted from $uri if absent.
12519:
12520: =item
12521: $username - username of user/course to be listed. Extracted from $uri if absent.
12522:
12523: =item
12524: $getpropath - boolean: 1 if prepend path using &propath().
12525:
12526: =item
12527: $getuserdir - boolean: 1 if prepend path for "userfiles".
12528:
12529: =item
12530: $alternateRoot - path to prepend in place of path from $uri.
12531:
12532: =back
12533:
12534: Returns: Array of up to two items.
12535:
12536: =over
12537:
12538: a reference to an array of files/subdirectories
12539:
12540: =over
12541:
12542: Each element in the array of files/subdirectories is a & separated list of
12543: item name and the result of running stat on the item. If dirlist was requested
12544: for a file instead of a directory, the item name will be ''. For a directory
12545: listing, if the item is a metadata file, the element will end &N&M
12546: (where N amd M are either 0 or 1, corresponding to obsolete set (1), or
12547: default copyright set (1).
12548:
12549: =back
12550:
12551: a scalar containing error condition (if encountered).
12552:
12553: =over
12554:
12555: =item
12556: no_host (no homeserver identified for $username:$domain).
12557:
12558: =item
12559: no_such_host (server contacted for listing not identified as valid host).
12560:
12561: =item
12562: con_lost (connection to remote server failed).
12563:
12564: =item
12565: refused (invalid $username:$domain received on lond side).
12566:
12567: =item
12568: no_such_dir (directory at specified path on lond side does not exist).
12569:
12570: =item
12571: empty (directory at specified path on lond side is empty).
12572:
12573: =over
12574:
12575: This is currently not encountered because the &ls3, &ls2,
12576: &ls (_handler) routines on the lond side do not filter out
12577: . and .. from a directory listing.
12578:
12579: =back
12580:
12581: =back
12582:
12583: =back
12584:
12585: =item *
12586:
12587: spareserver() : find server with least workload from spare.tab
12588:
12589:
12590: =item *
12591:
12592: host_from_dns($dns) : Returns the loncapa hostname corresponding to a DNS name or undef
12593: if there is no corresponding loncapa host.
12594:
12595: =back
12596:
12597:
12598: =head2 Apache Request
12599:
12600: =over 4
12601:
12602: =item *
12603:
12604: ssi($url,%hash) : server side include, does a complete request cycle on url to
12605: localhost, posts hash
12606:
12607: =back
12608:
12609: =head2 Data to String to Data
12610:
12611: =over 4
12612:
12613: =item *
12614:
12615: hash2str(%hash) : convert a hash into a string complete with escaping and '='
12616: and '&' separators, supports elements that are arrayrefs and hashrefs
12617:
12618: =item *
12619:
12620: hashref2str($hashref) : convert a hashref into a string complete with
12621: escaping and '=' and '&' separators, supports elements that are
12622: arrayrefs and hashrefs
12623:
12624: =item *
12625:
12626: arrayref2str($arrayref) : convert an arrayref into a string complete
12627: with escaping and '&' separators, supports elements that are arrayrefs
12628: and hashrefs
12629:
12630: =item *
12631:
12632: str2hash($string) : convert string to hash using unescaping and
12633: splitting on '=' and '&', supports elements that are arrayrefs and
12634: hashrefs
12635:
12636: =item *
12637:
12638: str2array($string) : convert string to hash using unescaping and
12639: splitting on '&', supports elements that are arrayrefs and hashrefs
12640:
12641: =back
12642:
12643: =head2 Logging Routines
12644:
12645:
12646: These routines allow one to make log messages in the lonnet.log and
12647: lonnet.perm logfiles.
12648:
12649: =over 4
12650:
12651: =item *
12652:
12653: logtouch() : make sure the logfile, lonnet.log, exists
12654:
12655: =item *
12656:
12657: logthis() : append message to the normal lonnet.log file, it gets
12658: preiodically rolled over and deleted.
12659:
12660: =item *
12661:
12662: logperm() : append a permanent message to lonnet.perm.log, this log
12663: file never gets deleted by any automated portion of the system, only
12664: messages of critical importance should go in here.
12665:
12666:
12667: =back
12668:
12669: =head2 General File Helper Routines
12670:
12671: =over 4
12672:
12673: =item *
12674:
12675: getfile($file,$caller) : two cases - requests for files in /res or in /uploaded.
12676: (a) files in /uploaded
12677: (i) If a local copy of the file exists -
12678: compares modification date of local copy with last-modified date for
12679: definitive version stored on home server for course. If local copy is
12680: stale, requests a new version from the home server and stores it.
12681: If the original has been removed from the home server, then local copy
12682: is unlinked.
12683: (ii) If local copy does not exist -
12684: requests the file from the home server and stores it.
12685:
12686: If $caller is 'uploadrep':
12687: This indicates a call from lonuploadrep.pm (PerlHeaderParserHandler phase)
12688: for request for files originally uploaded via DOCS.
12689: - returns 'ok' if fresh local copy now available, -1 otherwise.
12690:
12691: Otherwise:
12692: This indicates a call from the content generation phase of the request.
12693: - returns the entire contents of the file or -1.
12694:
12695: (b) files in /res
12696: - returns the entire contents of a file or -1;
12697: it properly subscribes to and replicates the file if neccessary.
12698:
12699:
12700: =item *
12701:
12702: stat_file($url) : $url is expected to be a /res/ or /uploaded/ style file
12703: reference
12704:
12705: returns either a stat() list of data about the file or an empty list
12706: if the file doesn't exist or couldn't find out about it (connection
12707: problems or user unknown)
12708:
12709: =item *
12710:
12711: filelocation($dir,$file) : returns file system location of a file
12712: based on URI; meant to be "fairly clean" absolute reference, $dir is a
12713: directory that relative $file lookups are to looked in ($dir of /a/dir
12714: and a file of ../bob will become /a/bob)
12715:
12716: =item *
12717:
12718: hreflocation($dir,$file) : returns file system location or a URL; same as
12719: filelocation except for hrefs
12720:
12721: =item *
12722:
12723: declutter() : declutters URLs (remove docroot, beginning slashes, 'res' etc)
12724:
12725: =back
12726:
12727: =head2 Usererfile file routines (/uploaded*)
12728:
12729: =over 4
12730:
12731: =item *
12732:
12733: userfileupload(): main rotine for putting a file in a user or course's
12734: filespace, arguments are,
12735:
12736: formname - required - this is the name of the element in $env where the
12737: filename, and the contents of the file to create/modifed exist
12738: the filename is in $env{'form.'.$formname.'.filename'} and the
12739: contents of the file is located in $env{'form.'.$formname}
12740: context - if coursedoc, store the file in the course of the active role
12741: of the current user;
12742: if 'existingfile': store in 'overwrites' in /home/httpd/perl/tmp
12743: if 'canceloverwrite': delete file in tmp/overwrites directory
12744: subdir - required - subdirectory to put the file in under ../userfiles/
12745: if undefined, it will be placed in "unknown"
12746:
12747: (This routine calls clean_filename() to remove any dangerous
12748: characters from the filename, and then calls finuserfileupload() to
12749: complete the transaction)
12750:
12751: returns either the url of the uploaded file (/uploaded/....) if successful
12752: and /adm/notfound.html if unsuccessful
12753:
12754: =item *
12755:
12756: clean_filename(): routine for cleaing a filename up for storage in
12757: userfile space, argument is:
12758:
12759: filename - proposed filename
12760:
12761: returns: the new clean filename
12762:
12763: =item *
12764:
12765: finishuserfileupload(): routine that creates and sends the file to
12766: userspace, probably shouldn't be called directly
12767:
12768: docuname: username or courseid of destination for the file
12769: docudom: domain of user/course of destination for the file
12770: formname: same as for userfileupload()
12771: fname: filename (including subdirectories) for the file
12772: parser: if 'parse', will parse (html) file to extract references to objects, links etc.
12773: allfiles: reference to hash used to store objects found by parser
12774: codebase: reference to hash used for codebases of java objects found by parser
12775: thumbwidth: width (pixels) of thumbnail to be created for uploaded image
12776: thumbheight: height (pixels) of thumbnail to be created for uploaded image
12777: resizewidth: width to be used to resize image using resizeImage from ImageMagick
12778: resizeheight: height to be used to resize image using resizeImage from ImageMagick
12779: context: if 'overwrite', will move the uploaded file from its temporary location to
12780: userfiles to facilitate overwriting a previously uploaded file with same name.
12781: mimetype: reference to scalar to accommodate mime type determined
12782: from File::MMagic if $parser = parse.
12783:
12784: returns either the url of the uploaded file (/uploaded/....) if successful
12785: and /adm/notfound.html if unsuccessful (or an error message if context
12786: was 'overwrite').
12787:
12788:
12789: =item *
12790:
12791: renameuserfile(): renames an existing userfile to a new name
12792:
12793: Args:
12794: docuname: username or courseid of destination for the file
12795: docudom: domain of user/course of destination for the file
12796: old: current file name (including any subdirs under userfiles)
12797: new: desired file name (including any subdirs under userfiles)
12798:
12799: =item *
12800:
12801: mkdiruserfile(): creates a directory is a userfiles dir
12802:
12803: Args:
12804: docuname: username or courseid of destination for the file
12805: docudom: domain of user/course of destination for the file
12806: dir: dir to create (including any subdirs under userfiles)
12807:
12808: =item *
12809:
12810: removeuserfile(): removes a file that exists in userfiles
12811:
12812: Args:
12813: docuname: username or courseid of destination for the file
12814: docudom: domain of user/course of destination for the file
12815: fname: filname to delete (including any subdirs under userfiles)
12816:
12817: =item *
12818:
12819: removeuploadedurl(): convience function for removeuserfile()
12820:
12821: Args:
12822: url: a full /uploaded/... url to delete
12823:
12824: =item *
12825:
12826: get_portfile_permissions():
12827: Args:
12828: domain: domain of user or course contain the portfolio files
12829: user: name of user or num of course contain the portfolio files
12830: Returns:
12831: hashref of a dump of the proper file_permissions.db
12832:
12833:
12834: =item *
12835:
12836: get_access_controls():
12837:
12838: Args:
12839: current_permissions: the hash ref returned from get_portfile_permissions()
12840: group: (optional) the group you want the files associated with
12841: file: (optional) the file you want access info on
12842:
12843: Returns:
12844: a hash (keys are file names) of hashes containing
12845: keys are: path to file/file_name\0uniqueID:scope_end_start (see below)
12846: values are XML containing access control settings (see below)
12847:
12848: Internal notes:
12849:
12850: access controls are stored in file_permissions.db as key=value pairs.
12851: key -> path to file/file_name\0uniqueID:scope_end_start
12852: where scope -> public,guest,course,group,domains or users.
12853: end -> UNIX time for end of access (0 -> no end date)
12854: start -> UNIX time for start of access
12855:
12856: value -> XML description of access control
12857: <scope type=""> (type =1 of: public,guest,course,group,domains,users">
12858: <start></start>
12859: <end></end>
12860:
12861: <password></password> for scope type = guest
12862:
12863: <domain></domain> for scope type = course or group
12864: <number></number>
12865: <roles id="">
12866: <role></role>
12867: <access></access>
12868: <section></section>
12869: <group></group>
12870: </roles>
12871:
12872: <dom></dom> for scope type = domains
12873:
12874: <users> for scope type = users
12875: <user>
12876: <uname></uname>
12877: <udom></udom>
12878: </user>
12879: </users>
12880: </scope>
12881:
12882: Access data is also aggregated for each file in an additional key=value pair:
12883: key -> path to file/file_name\0accesscontrol
12884: value -> reference to hash
12885: hash contains key = value pairs
12886: where key = uniqueID:scope_end_start
12887: value = UNIX time record was last updated
12888:
12889: Used to improve speed of look-ups of access controls for each file.
12890:
12891: Locks on files (resulting from submission of portfolio file to a homework problem stored in array of arrays.
12892:
12893: modify_access_controls():
12894:
12895: Modifies access controls for a portfolio file
12896: Args
12897: 1. file name
12898: 2. reference to hash of required changes,
12899: 3. domain
12900: 4. username
12901: where domain,username are the domain of the portfolio owner
12902: (either a user or a course)
12903:
12904: Returns:
12905: 1. result of additions or updates ('ok' or 'error', with error message).
12906: 2. result of deletions ('ok' or 'error', with error message).
12907: 3. reference to hash of any new or updated access controls.
12908: 4. reference to hash used to map incoming IDs to uniqueIDs assigned to control.
12909: key = integer (inbound ID)
12910: value = uniqueID
12911:
12912: =back
12913:
12914: =head2 HTTP Helper Routines
12915:
12916: =over 4
12917:
12918: =item *
12919:
12920: escape() : unpack non-word characters into CGI-compatible hex codes
12921:
12922: =item *
12923:
12924: unescape() : pack CGI-compatible hex codes into actual non-word ASCII character
12925:
12926: =back
12927:
12928: =head1 PRIVATE SUBROUTINES
12929:
12930: =head2 Underlying communication routines (Shouldn't call)
12931:
12932: =over 4
12933:
12934: =item *
12935:
12936: subreply() : tries to pass a message to lonc, returns con_lost if incapable
12937:
12938: =item *
12939:
12940: reply() : uses subreply to send a message to remote machine, logs all failures
12941:
12942: =item *
12943:
12944: critical() : passes a critical message to another server; if cannot
12945: get through then place message in connection buffer directory and
12946: returns con_delayed, if incapable of saving message, returns
12947: con_failed
12948:
12949: =item *
12950:
12951: reconlonc() : tries to reconnect lonc client processes.
12952:
12953: =back
12954:
12955: =head2 Resource Access Logging
12956:
12957: =over 4
12958:
12959: =item *
12960:
12961: flushcourselogs() : flush (save) buffer logs and access logs
12962:
12963: =item *
12964:
12965: courselog($what) : save message for course in hash
12966:
12967: =item *
12968:
12969: courseacclog($what) : save message for course using &courselog(). Perform
12970: special processing for specific resource types (problems, exams, quizzes, etc).
12971:
12972: =item *
12973:
12974: goodbye() : flush course logs and log shutting down; it is called in srm.conf
12975: as a PerlChildExitHandler
12976:
12977: =back
12978:
12979: =head2 Other
12980:
12981: =over 4
12982:
12983: =item *
12984:
12985: symblist($mapname,%newhash) : update symbolic storage links
12986:
12987: =back
12988:
12989: =cut
12990:
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