1: # The LearningOnline Network
2: # TCP networking package
3: #
4: # $Id: lonnet.pm,v 1.1157 2012/03/09 16:36:00 www Exp $
5: #
6: # Copyright Michigan State University Board of Trustees
7: #
8: # This file is part of the LearningOnline Network with CAPA (LON-CAPA).
9: #
10: # LON-CAPA is free software; you can redistribute it and/or modify
11: # it under the terms of the GNU General Public License as published by
12: # the Free Software Foundation; either version 2 of the License, or
13: # (at your option) any later version.
14: #
15: # LON-CAPA is distributed in the hope that it will be useful,
16: # but WITHOUT ANY WARRANTY; without even the implied warranty of
17: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18: # GNU General Public License for more details.
19: #
20: # You should have received a copy of the GNU General Public License
21: # along with LON-CAPA; if not, write to the Free Software
22: # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
23: #
24: # /home/httpd/html/adm/gpl.txt
25: #
26: # http://www.lon-capa.org/
27: #
28: ###
29:
30: =pod
31:
32: =head1 NAME
33:
34: Apache::lonnet.pm
35:
36: =head1 SYNOPSIS
37:
38: This file is an interface to the lonc processes of
39: the LON-CAPA network as well as set of elaborated functions for handling information
40: necessary for navigating through a given cluster of LON-CAPA machines within a
41: domain. There are over 40 specialized functions in this module which handle the
42: reading and transmission of metadata, user information (ids, names, environments, roles,
43: logs), file information (storage, reading, directories, extensions, replication, embedded
44: styles and descriptors), educational resources (course descriptions, section names and
45: numbers), url hashing (to assign roles on a url basis), and translating abbreviated symbols to
46: and from more descriptive phrases or explanations.
47:
48: This is part of the LearningOnline Network with CAPA project
49: described at http://www.lon-capa.org.
50:
51: =head1 Package Variables
52:
53: These are largely undocumented, so if you decipher one please note it here.
54:
55: =over 4
56:
57: =item $processmarker
58:
59: Contains the time this process was started and this servers host id.
60:
61: =item $dumpcount
62:
63: Counts the number of times a message log flush has been attempted (regardless
64: of success) by this process. Used as part of the filename when messages are
65: delayed.
66:
67: =back
68:
69: =cut
70:
71: package Apache::lonnet;
72:
73: use strict;
74: use LWP::UserAgent();
75: use HTTP::Date;
76: use Image::Magick;
77:
78: use vars qw(%perlvar %spareid %pr %prp $memcache %packagetab $tmpdir
79: $_64bit %env %protocol %loncaparevs %serverhomeIDs %needsrelease
80: %managerstab);
81:
82: my (%badServerCache, $memcache, %courselogs, %accesshash, %domainrolehash,
83: %userrolehash, $processmarker, $dumpcount, %coursedombuf,
84: %coursenumbuf, %coursehombuf, %coursedescrbuf, %courseinstcodebuf,
85: %courseownerbuf, %coursetypebuf,$locknum);
86:
87: use IO::Socket;
88: use GDBM_File;
89: use HTML::LCParser;
90: use Fcntl qw(:flock);
91: use Storable qw(thaw nfreeze);
92: use Time::HiRes qw( gettimeofday tv_interval );
93: use Cache::Memcached;
94: use Digest::MD5;
95: use Math::Random;
96: use File::MMagic;
97: use LONCAPA qw(:DEFAULT :match);
98: use LONCAPA::Configuration;
99:
100: use File::Copy;
101:
102: my $readit;
103: my $max_connection_retries = 10; # Or some such value.
104:
105: require Exporter;
106:
107: our @ISA = qw (Exporter);
108: our @EXPORT = qw(%env);
109:
110:
111: # --------------------------------------------------------------------- Logging
112: {
113: my $logid;
114: sub instructor_log {
115: my ($hash_name,$storehash,$delflag,$uname,$udom,$cnum,$cdom)=@_;
116: if (($cnum eq '') || ($cdom eq '')) {
117: $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
118: $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
119: }
120: $logid++;
121: my $now = time();
122: my $id=$now.'00000'.$$.'00000'.$logid;
123: return &Apache::lonnet::put('nohist_'.$hash_name,
124: { $id => {
125: 'exe_uname' => $env{'user.name'},
126: 'exe_udom' => $env{'user.domain'},
127: 'exe_time' => $now,
128: 'exe_ip' => $ENV{'REMOTE_ADDR'},
129: 'delflag' => $delflag,
130: 'logentry' => $storehash,
131: 'uname' => $uname,
132: 'udom' => $udom,
133: }
134: },$cdom,$cnum);
135: }
136: }
137:
138: sub logtouch {
139: my $execdir=$perlvar{'lonDaemons'};
140: unless (-e "$execdir/logs/lonnet.log") {
141: open(my $fh,">>$execdir/logs/lonnet.log");
142: close $fh;
143: }
144: my ($wwwuid,$wwwgid)=(getpwnam('www'))[2,3];
145: chown($wwwuid,$wwwgid,$execdir.'/logs/lonnet.log');
146: }
147:
148: sub logthis {
149: my $message=shift;
150: my $execdir=$perlvar{'lonDaemons'};
151: my $now=time;
152: my $local=localtime($now);
153: if (open(my $fh,">>$execdir/logs/lonnet.log")) {
154: my $logstring = $local. " ($$): ".$message."\n"; # Keep any \'s in string.
155: print $fh $logstring;
156: close($fh);
157: }
158: return 1;
159: }
160:
161: sub logperm {
162: my $message=shift;
163: my $execdir=$perlvar{'lonDaemons'};
164: my $now=time;
165: my $local=localtime($now);
166: if (open(my $fh,">>$execdir/logs/lonnet.perm.log")) {
167: print $fh "$now:$message:$local\n";
168: close($fh);
169: }
170: return 1;
171: }
172:
173: sub create_connection {
174: my ($hostname,$lonid) = @_;
175: my $client=IO::Socket::UNIX->new(Peer => $perlvar{'lonSockCreate'},
176: Type => SOCK_STREAM,
177: Timeout => 10);
178: return 0 if (!$client);
179: print $client (join(':',$hostname,$lonid,&machine_ids($hostname))."\n");
180: my $result = <$client>;
181: chomp($result);
182: return 1 if ($result eq 'done');
183: return 0;
184: }
185:
186: sub get_server_timezone {
187: my ($cnum,$cdom) = @_;
188: my $home=&homeserver($cnum,$cdom);
189: if ($home ne 'no_host') {
190: my $cachetime = 24*3600;
191: my ($timezone,$cached)=&is_cached_new('servertimezone',$home);
192: if (defined($cached)) {
193: return $timezone;
194: } else {
195: my $timezone = &reply('servertimezone',$home);
196: return &do_cache_new('servertimezone',$home,$timezone,$cachetime);
197: }
198: }
199: }
200:
201: sub get_server_distarch {
202: my ($lonhost,$ignore_cache) = @_;
203: if (defined($lonhost)) {
204: if (!defined(&hostname($lonhost))) {
205: return;
206: }
207: my $cachetime = 12*3600;
208: if (!$ignore_cache) {
209: my ($distarch,$cached)=&is_cached_new('serverdistarch',$lonhost);
210: if (defined($cached)) {
211: return $distarch;
212: }
213: }
214: my $rep = &reply('serverdistarch',$lonhost);
215: unless ($rep eq 'unknown_command' || $rep eq 'no_such_host' ||
216: $rep eq 'con_lost' || $rep eq 'rejected' || $rep eq 'refused' ||
217: $rep eq '') {
218: return &do_cache_new('serverdistarch',$lonhost,$rep,$cachetime);
219: }
220: }
221: return;
222: }
223:
224: sub get_server_loncaparev {
225: my ($dom,$lonhost,$ignore_cache,$caller) = @_;
226: if (defined($lonhost)) {
227: if (!defined(&hostname($lonhost))) {
228: undef($lonhost);
229: }
230: }
231: if (!defined($lonhost)) {
232: if (defined(&domain($dom,'primary'))) {
233: $lonhost=&domain($dom,'primary');
234: if ($lonhost eq 'no_host') {
235: undef($lonhost);
236: }
237: }
238: }
239: if (defined($lonhost)) {
240: my $cachetime = 12*3600;
241: if (!$ignore_cache) {
242: my ($loncaparev,$cached)=&is_cached_new('serverloncaparev',$lonhost);
243: if (defined($cached)) {
244: return $loncaparev;
245: }
246: }
247: my ($answer,$loncaparev);
248: my @ids=¤t_machine_ids();
249: if (grep(/^\Q$lonhost\E$/,@ids)) {
250: $answer = $perlvar{'lonVersion'};
251: if ($answer =~ /^[\'\"]?([\w.\-]+)[\'\"]?$/) {
252: $loncaparev = $1;
253: }
254: } else {
255: $answer = &reply('serverloncaparev',$lonhost);
256: if (($answer eq 'unknown_cmd') || ($answer eq 'con_lost')) {
257: if ($caller eq 'loncron') {
258: my $ua=new LWP::UserAgent;
259: $ua->timeout(4);
260: my $protocol = $protocol{$lonhost};
261: $protocol = 'http' if ($protocol ne 'https');
262: my $url = $protocol.'://'.&hostname($lonhost).'/adm/about.html';
263: my $request=new HTTP::Request('GET',$url);
264: my $response=$ua->request($request);
265: unless ($response->is_error()) {
266: my $content = $response->content;
267: if ($content =~ /<p>VERSION\:\s*([\w.\-]+)<\/p>/) {
268: $loncaparev = $1;
269: }
270: }
271: } else {
272: $loncaparev = $loncaparevs{$lonhost};
273: }
274: } elsif ($answer =~ /^[\'\"]?([\w.\-]+)[\'\"]?$/) {
275: $loncaparev = $1;
276: }
277: }
278: return &do_cache_new('serverloncaparev',$lonhost,$loncaparev,$cachetime);
279: }
280: }
281:
282: sub get_server_homeID {
283: my ($hostname,$ignore_cache,$caller) = @_;
284: unless ($ignore_cache) {
285: my ($serverhomeID,$cached)=&is_cached_new('serverhomeID',$hostname);
286: if (defined($cached)) {
287: return $serverhomeID;
288: }
289: }
290: my $cachetime = 12*3600;
291: my $serverhomeID;
292: if ($caller eq 'loncron') {
293: my @machine_ids = &machine_ids($hostname);
294: foreach my $id (@machine_ids) {
295: my $response = &reply('serverhomeID',$id);
296: unless (($response eq 'unknown_cmd') || ($response eq 'con_lost')) {
297: $serverhomeID = $response;
298: last;
299: }
300: }
301: if ($serverhomeID eq '') {
302: $serverhomeID = $machine_ids[-1];
303: }
304: } else {
305: $serverhomeID = $serverhomeIDs{$hostname};
306: }
307: return &do_cache_new('serverhomeID',$hostname,$serverhomeID,$cachetime);
308: }
309:
310: sub get_remote_globals {
311: my ($lonhost,$whathash,$ignore_cache) = @_;
312: my ($result,%returnhash,%whatneeded);
313: if (ref($whathash) eq 'HASH') {
314: foreach my $what (sort(keys(%{$whathash}))) {
315: my $hashid = $lonhost.'-'.$what;
316: my ($response,$cached);
317: unless ($ignore_cache) {
318: ($response,$cached)=&is_cached_new('lonnetglobal',$hashid);
319: }
320: if (defined($cached)) {
321: $returnhash{$what} = $response;
322: } else {
323: $whatneeded{$what} = 1;
324: }
325: }
326: if (keys(%whatneeded) == 0) {
327: $result = 'ok';
328: } else {
329: my $requested = &freeze_escape(\%whatneeded);
330: my $rep=&reply('readlonnetglobal:'.$requested,$lonhost);
331: if (($rep=~/^(refused|rejected|error)/) || ($rep eq 'con_lost') ||
332: ($rep eq 'unknown_cmd')) {
333: $result = $rep;
334: } else {
335: $result = 'ok';
336: my @pairs=split(/\&/,$rep);
337: foreach my $item (@pairs) {
338: my ($key,$value)=split(/=/,$item,2);
339: my $what = &unescape($key);
340: my $hashid = $lonhost.'-'.$what;
341: $returnhash{$what}=&thaw_unescape($value);
342: &do_cache_new('lonnetglobal',$hashid,$returnhash{$what},600);
343: }
344: }
345: }
346: }
347: return ($result,\%returnhash);
348: }
349:
350: sub remote_devalidate_cache {
351: my ($lonhost,$name,$id) = @_;
352: my $response = &reply('devalidatecache:'.&escape($name).':'.&escape($id),$lonhost);
353: return $response;
354: }
355:
356: # -------------------------------------------------- Non-critical communication
357: sub subreply {
358: my ($cmd,$server)=@_;
359: my $peerfile="$perlvar{'lonSockDir'}/".&hostname($server);
360: #
361: # With loncnew process trimming, there's a timing hole between lonc server
362: # process exit and the master server picking up the listen on the AF_UNIX
363: # socket. In that time interval, a lock file will exist:
364:
365: my $lockfile=$peerfile.".lock";
366: while (-e $lockfile) { # Need to wait for the lockfile to disappear.
367: sleep(1);
368: }
369: # At this point, either a loncnew parent is listening or an old lonc
370: # or loncnew child is listening so we can connect or everything's dead.
371: #
372: # We'll give the connection a few tries before abandoning it. If
373: # connection is not possible, we'll con_lost back to the client.
374: #
375: my $client;
376: for (my $retries = 0; $retries < $max_connection_retries; $retries++) {
377: $client=IO::Socket::UNIX->new(Peer =>"$peerfile",
378: Type => SOCK_STREAM,
379: Timeout => 10);
380: if ($client) {
381: last; # Connected!
382: } else {
383: &create_connection(&hostname($server),$server);
384: }
385: sleep(1); # Try again later if failed connection.
386: }
387: my $answer;
388: if ($client) {
389: print $client "sethost:$server:$cmd\n";
390: $answer=<$client>;
391: if (!$answer) { $answer="con_lost"; }
392: chomp($answer);
393: } else {
394: $answer = 'con_lost'; # Failed connection.
395: }
396: return $answer;
397: }
398:
399: sub reply {
400: my ($cmd,$server)=@_;
401: unless (defined(&hostname($server))) { return 'no_such_host'; }
402: my $answer=subreply($cmd,$server);
403: if (($answer=~/^refused/) || ($answer=~/^rejected/)) {
404: &logthis("<font color=\"blue\">WARNING:".
405: " $cmd to $server returned $answer</font>");
406: }
407: return $answer;
408: }
409:
410: # ----------------------------------------------------------- Send USR1 to lonc
411:
412: sub reconlonc {
413: my ($lonid) = @_;
414: my $hostname = &hostname($lonid);
415: if ($lonid) {
416: my $peerfile="$perlvar{'lonSockDir'}/$hostname";
417: if ($hostname && -e $peerfile) {
418: &logthis("Trying to reconnect lonc for $lonid ($hostname)");
419: my $client=IO::Socket::UNIX->new(Peer => $peerfile,
420: Type => SOCK_STREAM,
421: Timeout => 10);
422: if ($client) {
423: print $client ("reset_retries\n");
424: my $answer=<$client>;
425: #reset just this one.
426: }
427: }
428: return;
429: }
430:
431: &logthis("Trying to reconnect lonc");
432: my $loncfile="$perlvar{'lonDaemons'}/logs/lonc.pid";
433: if (open(my $fh,"<$loncfile")) {
434: my $loncpid=<$fh>;
435: chomp($loncpid);
436: if (kill 0 => $loncpid) {
437: &logthis("lonc at pid $loncpid responding, sending USR1");
438: kill USR1 => $loncpid;
439: sleep 1;
440: } else {
441: &logthis(
442: "<font color=\"blue\">WARNING:".
443: " lonc at pid $loncpid not responding, giving up</font>");
444: }
445: } else {
446: &logthis('<font color="blue">WARNING: lonc not running, giving up</font>');
447: }
448: }
449:
450: # ------------------------------------------------------ Critical communication
451:
452: sub critical {
453: my ($cmd,$server)=@_;
454: unless (&hostname($server)) {
455: &logthis("<font color=\"blue\">WARNING:".
456: " Critical message to unknown server ($server)</font>");
457: return 'no_such_host';
458: }
459: my $answer=reply($cmd,$server);
460: if ($answer eq 'con_lost') {
461: &reconlonc("$perlvar{'lonSockDir'}/$server");
462: my $answer=reply($cmd,$server);
463: if ($answer eq 'con_lost') {
464: my $now=time;
465: my $middlename=$cmd;
466: $middlename=substr($middlename,0,16);
467: $middlename=~s/\W//g;
468: my $dfilename=
469: "$perlvar{'lonSockDir'}/delayed/$now.$dumpcount.$$.$middlename.$server";
470: $dumpcount++;
471: {
472: my $dfh;
473: if (open($dfh,">$dfilename")) {
474: print $dfh "$cmd\n";
475: close($dfh);
476: }
477: }
478: sleep 2;
479: my $wcmd='';
480: {
481: my $dfh;
482: if (open($dfh,"<$dfilename")) {
483: $wcmd=<$dfh>;
484: close($dfh);
485: }
486: }
487: chomp($wcmd);
488: if ($wcmd eq $cmd) {
489: &logthis("<font color=\"blue\">WARNING: ".
490: "Connection buffer $dfilename: $cmd</font>");
491: &logperm("D:$server:$cmd");
492: return 'con_delayed';
493: } else {
494: &logthis("<font color=\"red\">CRITICAL:"
495: ." Critical connection failed: $server $cmd</font>");
496: &logperm("F:$server:$cmd");
497: return 'con_failed';
498: }
499: }
500: }
501: return $answer;
502: }
503:
504: # ------------------------------------------- check if return value is an error
505:
506: sub error {
507: my ($result) = @_;
508: if ($result =~ /^(con_lost|no_such_host|error: (\d+) (.*))/) {
509: if ($2 == 2) { return undef; }
510: return $1;
511: }
512: return undef;
513: }
514:
515: sub convert_and_load_session_env {
516: my ($lonidsdir,$handle)=@_;
517: my @profile;
518: {
519: my $opened = open(my $idf,'+<',"$lonidsdir/$handle.id");
520: if (!$opened) {
521: return 0;
522: }
523: flock($idf,LOCK_SH);
524: @profile=<$idf>;
525: close($idf);
526: }
527: my %temp_env;
528: foreach my $line (@profile) {
529: if ($line !~ m/=/) {
530: return 0;
531: }
532: chomp($line);
533: my ($envname,$envvalue)=split(/=/,$line,2);
534: $temp_env{&unescape($envname)} = &unescape($envvalue);
535: }
536: unlink("$lonidsdir/$handle.id");
537: if (tie(my %disk_env,'GDBM_File',"$lonidsdir/$handle.id",&GDBM_WRCREAT(),
538: 0640)) {
539: %disk_env = %temp_env;
540: @env{keys(%temp_env)} = @disk_env{keys(%temp_env)};
541: untie(%disk_env);
542: }
543: return 1;
544: }
545:
546: # ------------------------------------------- Transfer profile into environment
547: my $env_loaded;
548: sub transfer_profile_to_env {
549: my ($lonidsdir,$handle,$force_transfer) = @_;
550: if (!$force_transfer && $env_loaded) { return; }
551:
552: if (!defined($lonidsdir)) {
553: $lonidsdir = $perlvar{'lonIDsDir'};
554: }
555: if (!defined($handle)) {
556: ($handle) = ($env{'user.environment'} =~m|/([^/]+)\.id$| );
557: }
558:
559: my $convert;
560: {
561: my $opened = open(my $idf,'+<',"$lonidsdir/$handle.id");
562: if (!$opened) {
563: return;
564: }
565: flock($idf,LOCK_SH);
566: if (tie(my %disk_env,'GDBM_File',"$lonidsdir/$handle.id",
567: &GDBM_READER(),0640)) {
568: @env{keys(%disk_env)} = @disk_env{keys(%disk_env)};
569: untie(%disk_env);
570: } else {
571: $convert = 1;
572: }
573: }
574: if ($convert) {
575: if (!&convert_and_load_session_env($lonidsdir,$handle)) {
576: &logthis("Failed to load session, or convert session.");
577: }
578: }
579:
580: my %remove;
581: while ( my $envname = each(%env) ) {
582: if (my ($key,$time) = ($envname =~ /^(cgi\.(\d+)_\d+\.)/)) {
583: if ($time < time-300) {
584: $remove{$key}++;
585: }
586: }
587: }
588:
589: $env{'user.environment'} = "$lonidsdir/$handle.id";
590: $env_loaded=1;
591: foreach my $expired_key (keys(%remove)) {
592: &delenv($expired_key);
593: }
594: }
595:
596: # ---------------------------------------------------- Check for valid session
597: sub check_for_valid_session {
598: my ($r,$name) = @_;
599: my %cookies=CGI::Cookie->parse($r->header_in('Cookie'));
600: if ($name eq '') {
601: $name = 'lonID';
602: }
603: my $lonid=$cookies{$name};
604: return undef if (!$lonid);
605:
606: my $handle=&LONCAPA::clean_handle($lonid->value);
607: my $lonidsdir;
608: if ($name eq 'lonDAV') {
609: $lonidsdir=$r->dir_config('lonDAVsessDir');
610: } else {
611: $lonidsdir=$r->dir_config('lonIDsDir');
612: }
613: return undef if (!-e "$lonidsdir/$handle.id");
614:
615: my $opened = open(my $idf,'+<',"$lonidsdir/$handle.id");
616: return undef if (!$opened);
617:
618: flock($idf,LOCK_SH);
619: my %disk_env;
620: if (!tie(%disk_env,'GDBM_File',"$lonidsdir/$handle.id",
621: &GDBM_READER(),0640)) {
622: return undef;
623: }
624:
625: if (!defined($disk_env{'user.name'})
626: || !defined($disk_env{'user.domain'})) {
627: return undef;
628: }
629: return $handle;
630: }
631:
632: sub timed_flock {
633: my ($file,$lock_type) = @_;
634: my $failed=0;
635: eval {
636: local $SIG{__DIE__}='DEFAULT';
637: local $SIG{ALRM}=sub {
638: $failed=1;
639: die("failed lock");
640: };
641: alarm(13);
642: flock($file,$lock_type);
643: alarm(0);
644: };
645: if ($failed) {
646: return undef;
647: } else {
648: return 1;
649: }
650: }
651:
652: # ---------------------------------------------------------- Append Environment
653:
654: sub appenv {
655: my ($newenv,$roles) = @_;
656: if (ref($newenv) eq 'HASH') {
657: foreach my $key (keys(%{$newenv})) {
658: my $refused = 0;
659: if (($key =~ /^user\.role/) || ($key =~ /^user\.priv/)) {
660: $refused = 1;
661: if (ref($roles) eq 'ARRAY') {
662: my ($type,$role) = ($key =~ /^user\.(role|priv)\.([^.]+)\./);
663: if (grep(/^\Q$role\E$/,@{$roles})) {
664: $refused = 0;
665: }
666: }
667: }
668: if ($refused) {
669: &logthis("<font color=\"blue\">WARNING: ".
670: "Attempt to modify environment ".$key." to ".$newenv->{$key}
671: .'</font>');
672: delete($newenv->{$key});
673: } else {
674: $env{$key}=$newenv->{$key};
675: }
676: }
677: my $opened = open(my $env_file,'+<',$env{'user.environment'});
678: if ($opened
679: && &timed_flock($env_file,LOCK_EX)
680: &&
681: tie(my %disk_env,'GDBM_File',$env{'user.environment'},
682: (&GDBM_WRITER()|&GDBM_NOLOCK()),0640)) {
683: while (my ($key,$value) = each(%{$newenv})) {
684: $disk_env{$key} = $value;
685: }
686: untie(%disk_env);
687: }
688: }
689: return 'ok';
690: }
691: # ----------------------------------------------------- Delete from Environment
692:
693: sub delenv {
694: my ($delthis,$regexp,$roles) = @_;
695: if (($delthis=~/^user\.role/) || ($delthis=~/^user\.priv/)) {
696: my $refused = 1;
697: if (ref($roles) eq 'ARRAY') {
698: my ($type,$role) = ($delthis =~ /^user\.(role|priv)\.([^.]+)\./);
699: if (grep(/^\Q$role\E$/,@{$roles})) {
700: $refused = 0;
701: }
702: }
703: if ($refused) {
704: &logthis("<font color=\"blue\">WARNING: ".
705: "Attempt to delete from environment ".$delthis);
706: return 'error';
707: }
708: }
709: my $opened = open(my $env_file,'+<',$env{'user.environment'});
710: if ($opened
711: && &timed_flock($env_file,LOCK_EX)
712: &&
713: tie(my %disk_env,'GDBM_File',$env{'user.environment'},
714: (&GDBM_WRITER()|&GDBM_NOLOCK()),0640)) {
715: foreach my $key (keys(%disk_env)) {
716: if ($regexp) {
717: if ($key=~/^$delthis/) {
718: delete($env{$key});
719: delete($disk_env{$key});
720: }
721: } else {
722: if ($key=~/^\Q$delthis\E/) {
723: delete($env{$key});
724: delete($disk_env{$key});
725: }
726: }
727: }
728: untie(%disk_env);
729: }
730: return 'ok';
731: }
732:
733: sub get_env_multiple {
734: my ($name) = @_;
735: my @values;
736: if (defined($env{$name})) {
737: # exists is it an array
738: if (ref($env{$name})) {
739: @values=@{ $env{$name} };
740: } else {
741: $values[0]=$env{$name};
742: }
743: }
744: return(@values);
745: }
746:
747: # ------------------------------------------------------------------- Locking
748:
749: sub set_lock {
750: my ($text)=@_;
751: $locknum++;
752: my $id=$$.'-'.$locknum;
753: &appenv({'session.locks' => $env{'session.locks'}.','.$id,
754: 'session.lock.'.$id => $text});
755: return $id;
756: }
757:
758: sub get_locks {
759: my $num=0;
760: my %texts=();
761: foreach my $lock (split(/\,/,$env{'session.locks'})) {
762: if ($lock=~/\w/) {
763: $num++;
764: $texts{$lock}=$env{'session.lock.'.$lock};
765: }
766: }
767: return ($num,%texts);
768: }
769:
770: sub remove_lock {
771: my ($id)=@_;
772: my $newlocks='';
773: foreach my $lock (split(/\,/,$env{'session.locks'})) {
774: if (($lock=~/\w/) && ($lock ne $id)) {
775: $newlocks.=','.$lock;
776: }
777: }
778: &appenv({'session.locks' => $newlocks});
779: &delenv('session.lock.'.$id);
780: }
781:
782: sub remove_all_locks {
783: my $activelocks=$env{'session.locks'};
784: foreach my $lock (split(/\,/,$env{'session.locks'})) {
785: if ($lock=~/\w/) {
786: &remove_lock($lock);
787: }
788: }
789: }
790:
791:
792: # ------------------------------------------ Find out current server userload
793: sub userload {
794: my $numusers=0;
795: {
796: opendir(LONIDS,$perlvar{'lonIDsDir'});
797: my $filename;
798: my $curtime=time;
799: while ($filename=readdir(LONIDS)) {
800: next if ($filename eq '.' || $filename eq '..');
801: next if ($filename =~ /publicuser_\d+\.id/);
802: my ($mtime)=(stat($perlvar{'lonIDsDir'}.'/'.$filename))[9];
803: if ($curtime-$mtime < 1800) { $numusers++; }
804: }
805: closedir(LONIDS);
806: }
807: my $userloadpercent=0;
808: my $maxuserload=$perlvar{'lonUserLoadLim'};
809: if ($maxuserload) {
810: $userloadpercent=100*$numusers/$maxuserload;
811: }
812: $userloadpercent=sprintf("%.2f",$userloadpercent);
813: return $userloadpercent;
814: }
815:
816: # ------------------------------ Find server with least workload from spare.tab
817:
818: sub spareserver {
819: my ($loadpercent,$userloadpercent,$want_server_name,$udom) = @_;
820: my $spare_server;
821: if ($userloadpercent !~ /\d/) { $userloadpercent=0; }
822: my $lowest_load=($loadpercent > $userloadpercent) ? $loadpercent
823: : $userloadpercent;
824: my ($uint_dom,$remotesessions);
825: if (($udom ne '') && (&domain($udom) ne '')) {
826: my $uprimary_id = &Apache::lonnet::domain($udom,'primary');
827: $uint_dom = &Apache::lonnet::internet_dom($uprimary_id);
828: my %udomdefaults = &Apache::lonnet::get_domain_defaults($udom);
829: $remotesessions = $udomdefaults{'remotesessions'};
830: }
831: my $spareshash = &this_host_spares($udom);
832: if (ref($spareshash) eq 'HASH') {
833: if (ref($spareshash->{'primary'}) eq 'ARRAY') {
834: foreach my $try_server (@{ $spareshash->{'primary'} }) {
835: if ($uint_dom) {
836: next unless (&spare_can_host($udom,$uint_dom,$remotesessions,
837: $try_server));
838: }
839: ($spare_server, $lowest_load) =
840: &compare_server_load($try_server, $spare_server, $lowest_load);
841: }
842: }
843:
844: my $found_server = ($spare_server ne '' && $lowest_load < 100);
845:
846: if (!$found_server) {
847: if (ref($spareshash->{'default'}) eq 'ARRAY') {
848: foreach my $try_server (@{ $spareshash->{'default'} }) {
849: if ($uint_dom) {
850: next unless (&spare_can_host($udom,$uint_dom,
851: $remotesessions,$try_server));
852: }
853: ($spare_server, $lowest_load) =
854: &compare_server_load($try_server, $spare_server, $lowest_load);
855: }
856: }
857: }
858: }
859:
860: if (!$want_server_name) {
861: my $protocol = 'http';
862: if ($protocol{$spare_server} eq 'https') {
863: $protocol = $protocol{$spare_server};
864: }
865: if (defined($spare_server)) {
866: my $hostname = &hostname($spare_server);
867: if (defined($hostname)) {
868: $spare_server = $protocol.'://'.$hostname;
869: }
870: }
871: }
872: return $spare_server;
873: }
874:
875: sub compare_server_load {
876: my ($try_server, $spare_server, $lowest_load) = @_;
877:
878: my $loadans = &reply('load', $try_server);
879: my $userloadans = &reply('userload',$try_server);
880:
881: if ($loadans !~ /\d/ && $userloadans !~ /\d/) {
882: return ($spare_server, $lowest_load); #didn't get a number from the server
883: }
884:
885: my $load;
886: if ($loadans =~ /\d/) {
887: if ($userloadans =~ /\d/) {
888: #both are numbers, pick the bigger one
889: $load = ($loadans > $userloadans) ? $loadans
890: : $userloadans;
891: } else {
892: $load = $loadans;
893: }
894: } else {
895: $load = $userloadans;
896: }
897:
898: if (($load =~ /\d/) && ($load < $lowest_load)) {
899: $spare_server = $try_server;
900: $lowest_load = $load;
901: }
902: return ($spare_server,$lowest_load);
903: }
904:
905: # --------------------------- ask offload servers if user already has a session
906: sub find_existing_session {
907: my ($udom,$uname) = @_;
908: my $spareshash = &this_host_spares($udom);
909: if (ref($spareshash) eq 'HASH') {
910: if (ref($spareshash->{'primary'}) eq 'ARRAY') {
911: foreach my $try_server (@{ $spareshash->{'primary'} }) {
912: return $try_server if (&has_user_session($try_server, $udom, $uname));
913: }
914: }
915: if (ref($spareshash->{'default'}) eq 'ARRAY') {
916: foreach my $try_server (@{ $spareshash->{'default'} }) {
917: return $try_server if (&has_user_session($try_server, $udom, $uname));
918: }
919: }
920: }
921: return;
922: }
923:
924: # -------------------------------- ask if server already has a session for user
925: sub has_user_session {
926: my ($lonid,$udom,$uname) = @_;
927: my $result = &reply(join(':','userhassession',
928: map {&escape($_)} ($udom,$uname)),$lonid);
929: return 1 if ($result eq 'ok');
930:
931: return 0;
932: }
933:
934: # --------- determine least loaded server in a user's domain which allows login
935:
936: sub choose_server {
937: my ($udom,$checkloginvia) = @_;
938: my %domconfhash = &Apache::loncommon::get_domainconf($udom);
939: my %servers = &get_servers($udom);
940: my $lowest_load = 30000;
941: my ($login_host,$hostname,$portal_path,$isredirect);
942: foreach my $lonhost (keys(%servers)) {
943: my $loginvia;
944: if ($checkloginvia) {
945: $loginvia = $domconfhash{$udom.'.login.loginvia_'.$lonhost};
946: if ($loginvia) {
947: my ($server,$path) = split(/:/,$loginvia);
948: ($login_host, $lowest_load) =
949: &compare_server_load($server, $login_host, $lowest_load);
950: if ($login_host eq $server) {
951: $portal_path = $path;
952: $isredirect = 1;
953: }
954: } else {
955: ($login_host, $lowest_load) =
956: &compare_server_load($lonhost, $login_host, $lowest_load);
957: if ($login_host eq $lonhost) {
958: $portal_path = '';
959: $isredirect = '';
960: }
961: }
962: } else {
963: ($login_host, $lowest_load) =
964: &compare_server_load($lonhost, $login_host, $lowest_load);
965: }
966: }
967: if ($login_host ne '') {
968: $hostname = &hostname($login_host);
969: }
970: return ($login_host,$hostname,$portal_path,$isredirect);
971: }
972:
973: # --------------------------------------------- Try to change a user's password
974:
975: sub changepass {
976: my ($uname,$udom,$currentpass,$newpass,$server,$context)=@_;
977: $currentpass = &escape($currentpass);
978: $newpass = &escape($newpass);
979: my $lonhost = $perlvar{'lonHostID'};
980: my $answer = reply("encrypt:passwd:$udom:$uname:$currentpass:$newpass:$context:$lonhost",
981: $server);
982: if (! $answer) {
983: &logthis("No reply on password change request to $server ".
984: "by $uname in domain $udom.");
985: } elsif ($answer =~ "^ok") {
986: &logthis("$uname in $udom successfully changed their password ".
987: "on $server.");
988: } elsif ($answer =~ "^pwchange_failure") {
989: &logthis("$uname in $udom was unable to change their password ".
990: "on $server. The action was blocked by either lcpasswd ".
991: "or pwchange");
992: } elsif ($answer =~ "^non_authorized") {
993: &logthis("$uname in $udom did not get their password correct when ".
994: "attempting to change it on $server.");
995: } elsif ($answer =~ "^auth_mode_error") {
996: &logthis("$uname in $udom attempted to change their password despite ".
997: "not being locally or internally authenticated on $server.");
998: } elsif ($answer =~ "^unknown_user") {
999: &logthis("$uname in $udom attempted to change their password ".
1000: "on $server but were unable to because $server is not ".
1001: "their home server.");
1002: } elsif ($answer =~ "^refused") {
1003: &logthis("$server refused to change $uname in $udom password because ".
1004: "it was sent an unencrypted request to change the password.");
1005: } elsif ($answer =~ "invalid_client") {
1006: &logthis("$server refused to change $uname in $udom password because ".
1007: "it was a reset by e-mail originating from an invalid server.");
1008: }
1009: return $answer;
1010: }
1011:
1012: # ----------------------- Try to determine user's current authentication scheme
1013:
1014: sub queryauthenticate {
1015: my ($uname,$udom)=@_;
1016: my $uhome=&homeserver($uname,$udom);
1017: if (!$uhome) {
1018: &logthis("User $uname at $udom is unknown when looking for authentication mechanism");
1019: return 'no_host';
1020: }
1021: my $answer=reply("encrypt:currentauth:$udom:$uname",$uhome);
1022: if ($answer =~ /^(unknown_user|refused|con_lost)/) {
1023: &logthis("User $uname at $udom threw error $answer when checking authentication mechanism");
1024: }
1025: return $answer;
1026: }
1027:
1028: # --------- Try to authenticate user from domain's lib servers (first this one)
1029:
1030: sub authenticate {
1031: my ($uname,$upass,$udom,$checkdefauth,$clientcancheckhost)=@_;
1032: $upass=&escape($upass);
1033: $uname= &LONCAPA::clean_username($uname);
1034: my $uhome=&homeserver($uname,$udom,1);
1035: my $newhome;
1036: if ((!$uhome) || ($uhome eq 'no_host')) {
1037: # Maybe the machine was offline and only re-appeared again recently?
1038: &reconlonc();
1039: # One more
1040: $uhome=&homeserver($uname,$udom,1);
1041: if (($uhome eq 'no_host') && $checkdefauth) {
1042: if (defined(&domain($udom,'primary'))) {
1043: $newhome=&domain($udom,'primary');
1044: }
1045: if ($newhome ne '') {
1046: $uhome = $newhome;
1047: }
1048: }
1049: if ((!$uhome) || ($uhome eq 'no_host')) {
1050: &logthis("User $uname at $udom is unknown in authenticate");
1051: return 'no_host';
1052: }
1053: }
1054: my $answer=reply("encrypt:auth:$udom:$uname:$upass:$checkdefauth:$clientcancheckhost",$uhome);
1055: if ($answer eq 'authorized') {
1056: if ($newhome) {
1057: &logthis("User $uname at $udom authorized by $uhome, but needs account");
1058: return 'no_account_on_host';
1059: } else {
1060: &logthis("User $uname at $udom authorized by $uhome");
1061: return $uhome;
1062: }
1063: }
1064: if ($answer eq 'non_authorized') {
1065: &logthis("User $uname at $udom rejected by $uhome");
1066: return 'no_host';
1067: }
1068: &logthis("User $uname at $udom threw error $answer when checking authentication mechanism");
1069: return 'no_host';
1070: }
1071:
1072: sub can_host_session {
1073: my ($udom,$lonhost,$remoterev,$remotesessions,$hostedsessions) = @_;
1074: my $canhost = 1;
1075: my $host_idn = &Apache::lonnet::internet_dom($lonhost);
1076: if (ref($remotesessions) eq 'HASH') {
1077: if (ref($remotesessions->{'excludedomain'}) eq 'ARRAY') {
1078: if (grep(/^\Q$host_idn\E$/,@{$remotesessions->{'excludedomain'}})) {
1079: $canhost = 0;
1080: } else {
1081: $canhost = 1;
1082: }
1083: }
1084: if (ref($remotesessions->{'includedomain'}) eq 'ARRAY') {
1085: if (grep(/^\Q$host_idn\E$/,@{$remotesessions->{'includedomain'}})) {
1086: $canhost = 1;
1087: } else {
1088: $canhost = 0;
1089: }
1090: }
1091: if ($canhost) {
1092: if ($remotesessions->{'version'} ne '') {
1093: my ($reqmajor,$reqminor) = ($remotesessions->{'version'} =~ /^(\d+)\.(\d+)$/);
1094: if ($reqmajor ne '' && $reqminor ne '') {
1095: if ($remoterev =~ /^\'?(\d+)\.(\d+)/) {
1096: my $major = $1;
1097: my $minor = $2;
1098: if (($major < $reqmajor ) ||
1099: (($major == $reqmajor) && ($minor < $reqminor))) {
1100: $canhost = 0;
1101: }
1102: } else {
1103: $canhost = 0;
1104: }
1105: }
1106: }
1107: }
1108: }
1109: if ($canhost) {
1110: if (ref($hostedsessions) eq 'HASH') {
1111: my $uprimary_id = &Apache::lonnet::domain($udom,'primary');
1112: my $uint_dom = &Apache::lonnet::internet_dom($uprimary_id);
1113: if (ref($hostedsessions->{'excludedomain'}) eq 'ARRAY') {
1114: if (($uint_dom ne '') &&
1115: (grep(/^\Q$uint_dom\E$/,@{$hostedsessions->{'excludedomain'}}))) {
1116: $canhost = 0;
1117: } else {
1118: $canhost = 1;
1119: }
1120: }
1121: if (ref($hostedsessions->{'includedomain'}) eq 'ARRAY') {
1122: if (($uint_dom ne '') &&
1123: (grep(/^\Q$uint_dom\E$/,@{$hostedsessions->{'includedomain'}}))) {
1124: $canhost = 1;
1125: } else {
1126: $canhost = 0;
1127: }
1128: }
1129: }
1130: }
1131: return $canhost;
1132: }
1133:
1134: sub spare_can_host {
1135: my ($udom,$uint_dom,$remotesessions,$try_server)=@_;
1136: my $canhost=1;
1137: my @intdoms;
1138: my $internet_names = &Apache::lonnet::get_internet_names($try_server);
1139: if (ref($internet_names) eq 'ARRAY') {
1140: @intdoms = @{$internet_names};
1141: }
1142: unless (grep(/^\Q$uint_dom\E$/,@intdoms)) {
1143: my $serverhomeID = &Apache::lonnet::get_server_homeID($try_server);
1144: my $serverhomedom = &Apache::lonnet::host_domain($serverhomeID);
1145: my %defdomdefaults = &Apache::lonnet::get_domain_defaults($serverhomedom);
1146: my $remoterev = &Apache::lonnet::get_server_loncaparev(undef,$try_server);
1147: $canhost = &can_host_session($udom,$try_server,$remoterev,
1148: $remotesessions,
1149: $defdomdefaults{'hostedsessions'});
1150: }
1151: return $canhost;
1152: }
1153:
1154: sub this_host_spares {
1155: my ($dom) = @_;
1156: my ($dom_in_use,$lonhost_in_use,$result);
1157: my @hosts = ¤t_machine_ids();
1158: foreach my $lonhost (@hosts) {
1159: if (&host_domain($lonhost) eq $dom) {
1160: $dom_in_use = $dom;
1161: $lonhost_in_use = $lonhost;
1162: last;
1163: }
1164: }
1165: if ($dom_in_use ne '') {
1166: $result = &spares_for_offload($dom_in_use,$lonhost_in_use);
1167: }
1168: if (ref($result) ne 'HASH') {
1169: $lonhost_in_use = $perlvar{'lonHostID'};
1170: $dom_in_use = &host_domain($lonhost_in_use);
1171: $result = &spares_for_offload($dom_in_use,$lonhost_in_use);
1172: if (ref($result) ne 'HASH') {
1173: $result = \%spareid;
1174: }
1175: }
1176: return $result;
1177: }
1178:
1179: sub spares_for_offload {
1180: my ($dom_in_use,$lonhost_in_use) = @_;
1181: my ($result,$cached)=&is_cached_new('spares',$dom_in_use);
1182: if (defined($cached)) {
1183: return $result;
1184: } else {
1185: my $cachetime = 60*60*24;
1186: my %domconfig =
1187: &Apache::lonnet::get_dom('configuration',['usersessions'],$dom_in_use);
1188: if (ref($domconfig{'usersessions'}) eq 'HASH') {
1189: if (ref($domconfig{'usersessions'}{'spares'}) eq 'HASH') {
1190: if (ref($domconfig{'usersessions'}{'spares'}{$lonhost_in_use}) eq 'HASH') {
1191: return &do_cache_new('spares',$dom_in_use,$domconfig{'usersessions'}{'spares'}{$lonhost_in_use},$cachetime);
1192: }
1193: }
1194: }
1195: }
1196: return;
1197: }
1198:
1199: sub get_lonbalancer_config {
1200: my ($servers) = @_;
1201: my ($currbalancer,$currtargets);
1202: if (ref($servers) eq 'HASH') {
1203: foreach my $server (keys(%{$servers})) {
1204: my %what = (
1205: spareid => 1,
1206: perlvar => 1,
1207: );
1208: my ($result,$returnhash) = &get_remote_globals($server,\%what);
1209: if ($result eq 'ok') {
1210: if (ref($returnhash) eq 'HASH') {
1211: if (ref($returnhash->{'perlvar'}) eq 'HASH') {
1212: if ($returnhash->{'perlvar'}->{'lonBalancer'} eq 'yes') {
1213: $currbalancer = $server;
1214: $currtargets = {};
1215: if (ref($returnhash->{'spareid'}) eq 'HASH') {
1216: if (ref($returnhash->{'spareid'}->{'primary'}) eq 'ARRAY') {
1217: $currtargets->{'primary'} = $returnhash->{'spareid'}->{'primary'};
1218: }
1219: if (ref($returnhash->{'spareid'}->{'default'}) eq 'ARRAY') {
1220: $currtargets->{'default'} = $returnhash->{'spareid'}->{'default'};
1221: }
1222: }
1223: last;
1224: }
1225: }
1226: }
1227: }
1228: }
1229: }
1230: return ($currbalancer,$currtargets);
1231: }
1232:
1233: sub check_loadbalancing {
1234: my ($uname,$udom) = @_;
1235: my ($is_balancer,$dom_in_use,$homeintdom,$rule_in_effect,
1236: $offloadto,$otherserver);
1237: my $lonhost = $perlvar{'lonHostID'};
1238: my $uprimary_id = &Apache::lonnet::domain($udom,'primary');
1239: my $uintdom = &Apache::lonnet::internet_dom($uprimary_id);
1240: my $intdom = &Apache::lonnet::internet_dom($lonhost);
1241: my $serverhomedom = &host_domain($lonhost);
1242:
1243: my $cachetime = 60*60*24;
1244:
1245: if (($uintdom ne '') && ($uintdom eq $intdom)) {
1246: $dom_in_use = $udom;
1247: $homeintdom = 1;
1248: } else {
1249: $dom_in_use = $serverhomedom;
1250: }
1251: my ($result,$cached)=&is_cached_new('loadbalancing',$dom_in_use);
1252: unless (defined($cached)) {
1253: my %domconfig =
1254: &Apache::lonnet::get_dom('configuration',['loadbalancing'],$dom_in_use);
1255: if (ref($domconfig{'loadbalancing'}) eq 'HASH') {
1256: $result = &do_cache_new('loadbalancing',$dom_in_use,$domconfig{'loadbalancing'},$cachetime);
1257: }
1258: }
1259: if (ref($result) eq 'HASH') {
1260: my $currbalancer = $result->{'lonhost'};
1261: my $currtargets = $result->{'targets'};
1262: my $currrules = $result->{'rules'};
1263: if ($currbalancer ne '') {
1264: my @hosts = ¤t_machine_ids();
1265: if (grep(/^\Q$currbalancer\E$/,@hosts)) {
1266: $is_balancer = 1;
1267: }
1268: }
1269: if ($is_balancer) {
1270: if (ref($currrules) eq 'HASH') {
1271: if ($homeintdom) {
1272: if ($uname ne '') {
1273: if (($currrules->{'_LC_adv'} ne '') || ($currrules->{'_LC_author'} ne '')) {
1274: my ($is_adv,$is_author) = &is_advanced_user($udom,$uname);
1275: if (($currrules->{'_LC_author'} ne '') && ($is_author)) {
1276: $rule_in_effect = $currrules->{'_LC_author'};
1277: } elsif (($currrules->{'_LC_adv'} ne '') && ($is_adv)) {
1278: $rule_in_effect = $currrules->{'_LC_adv'}
1279: }
1280: }
1281: if ($rule_in_effect eq '') {
1282: my %userenv = &userenvironment($udom,$uname,'inststatus');
1283: if ($userenv{'inststatus'} ne '') {
1284: my @statuses = map { &unescape($_); } split(/:/,$userenv{'inststatus'});
1285: my ($othertitle,$usertypes,$types) =
1286: &Apache::loncommon::sorted_inst_types($udom);
1287: if (ref($types) eq 'ARRAY') {
1288: foreach my $type (@{$types}) {
1289: if (grep(/^\Q$type\E$/,@statuses)) {
1290: if (exists($currrules->{$type})) {
1291: $rule_in_effect = $currrules->{$type};
1292: }
1293: }
1294: }
1295: }
1296: } else {
1297: if (exists($currrules->{'default'})) {
1298: $rule_in_effect = $currrules->{'default'};
1299: }
1300: }
1301: }
1302: } else {
1303: if (exists($currrules->{'default'})) {
1304: $rule_in_effect = $currrules->{'default'};
1305: }
1306: }
1307: } else {
1308: if ($currrules->{'_LC_external'} ne '') {
1309: $rule_in_effect = $currrules->{'_LC_external'};
1310: }
1311: }
1312: $offloadto = &get_loadbalancer_targets($rule_in_effect,$currtargets,
1313: $uname,$udom);
1314: }
1315: }
1316: } elsif (($homeintdom) && ($udom ne $serverhomedom)) {
1317: my ($result,$cached)=&is_cached_new('loadbalancing',$serverhomedom);
1318: unless (defined($cached)) {
1319: my %domconfig =
1320: &Apache::lonnet::get_dom('configuration',['loadbalancing'],$serverhomedom);
1321: if (ref($domconfig{'loadbalancing'}) eq 'HASH') {
1322: $result = &do_cache_new('loadbalancing',$dom_in_use,$domconfig{'loadbalancing'},$cachetime);
1323: }
1324: }
1325: if (ref($result) eq 'HASH') {
1326: my $currbalancer = $result->{'lonhost'};
1327: my $currtargets = $result->{'targets'};
1328: my $currrules = $result->{'rules'};
1329:
1330: if ($currbalancer eq $lonhost) {
1331: $is_balancer = 1;
1332: if (ref($currrules) eq 'HASH') {
1333: if ($currrules->{'_LC_internetdom'} ne '') {
1334: $rule_in_effect = $currrules->{'_LC_internetdom'};
1335: }
1336: }
1337: $offloadto = &get_loadbalancer_targets($rule_in_effect,$currtargets,
1338: $uname,$udom);
1339: }
1340: } else {
1341: if ($perlvar{'lonBalancer'} eq 'yes') {
1342: $is_balancer = 1;
1343: $offloadto = &this_host_spares($dom_in_use);
1344: }
1345: }
1346: } else {
1347: if ($perlvar{'lonBalancer'} eq 'yes') {
1348: $is_balancer = 1;
1349: $offloadto = &this_host_spares($dom_in_use);
1350: }
1351: }
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: return ($is_balancer,$otherserver);
1381: }
1382:
1383: sub get_loadbalancer_targets {
1384: my ($rule_in_effect,$currtargets,$uname,$udom) = @_;
1385: my $offloadto;
1386: if ($rule_in_effect eq '') {
1387: $offloadto = $currtargets;
1388: } else {
1389: if ($rule_in_effect eq 'homeserver') {
1390: my $homeserver = &homeserver($uname,$udom);
1391: if ($homeserver ne 'no_host') {
1392: $offloadto = [$homeserver];
1393: }
1394: } elsif ($rule_in_effect eq 'externalbalancer') {
1395: my %domconfig =
1396: &Apache::lonnet::get_dom('configuration',['loadbalancing'],$udom);
1397: if (ref($domconfig{'loadbalancing'}) eq 'HASH') {
1398: if ($domconfig{'loadbalancing'}{'lonhost'} ne '') {
1399: if (&hostname($domconfig{'loadbalancing'}{'lonhost'}) ne '') {
1400: $offloadto = [$domconfig{'loadbalancing'}{'lonhost'}];
1401: }
1402: }
1403: } else {
1404: my %servers = &dom_servers($udom);
1405: my ($remotebalancer,$remotetargets) = &get_lonbalancer_config(\%servers);
1406: if (&hostname($remotebalancer) ne '') {
1407: $offloadto = [$remotebalancer];
1408: }
1409: }
1410: } elsif (&hostname($rule_in_effect) ne '') {
1411: $offloadto = [$rule_in_effect];
1412: }
1413: }
1414: return $offloadto;
1415: }
1416:
1417: sub internet_dom_servers {
1418: my ($dom) = @_;
1419: my (%uniqservers,%servers);
1420: my $primaryserver = &hostname(&domain($dom,'primary'));
1421: my @machinedoms = &machine_domains($primaryserver);
1422: foreach my $mdom (@machinedoms) {
1423: my %currservers = %servers;
1424: my %server = &get_servers($mdom);
1425: %servers = (%currservers,%server);
1426: }
1427: my %by_hostname;
1428: foreach my $id (keys(%servers)) {
1429: push(@{$by_hostname{$servers{$id}}},$id);
1430: }
1431: foreach my $hostname (sort(keys(%by_hostname))) {
1432: if (@{$by_hostname{$hostname}} > 1) {
1433: my $match = 0;
1434: foreach my $id (@{$by_hostname{$hostname}}) {
1435: if (&host_domain($id) eq $dom) {
1436: $uniqservers{$id} = $hostname;
1437: $match = 1;
1438: }
1439: }
1440: unless ($match) {
1441: $uniqservers{$by_hostname{$hostname}[0]} = $hostname;
1442: }
1443: } else {
1444: $uniqservers{$by_hostname{$hostname}[0]} = $hostname;
1445: }
1446: }
1447: return %uniqservers;
1448: }
1449:
1450: # ---------------------- Find the homebase for a user from domain's lib servers
1451:
1452: my %homecache;
1453: sub homeserver {
1454: my ($uname,$udom,$ignoreBadCache)=@_;
1455: my $index="$uname:$udom";
1456:
1457: if (exists($homecache{$index})) { return $homecache{$index}; }
1458:
1459: my %servers = &get_servers($udom,'library');
1460: foreach my $tryserver (keys(%servers)) {
1461: next if ($ignoreBadCache ne 'true' &&
1462: exists($badServerCache{$tryserver}));
1463:
1464: my $answer=reply("home:$udom:$uname",$tryserver);
1465: if ($answer eq 'found') {
1466: delete($badServerCache{$tryserver});
1467: return $homecache{$index}=$tryserver;
1468: } elsif ($answer eq 'no_host') {
1469: $badServerCache{$tryserver}=1;
1470: }
1471: }
1472: return 'no_host';
1473: }
1474:
1475: # ------------------------------------- Find the usernames behind a list of IDs
1476:
1477: sub idget {
1478: my ($udom,@ids)=@_;
1479: my %returnhash=();
1480:
1481: my %servers = &get_servers($udom,'library');
1482: foreach my $tryserver (keys(%servers)) {
1483: my $idlist=join('&',@ids);
1484: $idlist=~tr/A-Z/a-z/;
1485: my $reply=&reply("idget:$udom:".$idlist,$tryserver);
1486: my @answer=();
1487: if (($reply ne 'con_lost') && ($reply!~/^error\:/)) {
1488: @answer=split(/\&/,$reply);
1489: } ;
1490: my $i;
1491: for ($i=0;$i<=$#ids;$i++) {
1492: if ($answer[$i]) {
1493: $returnhash{$ids[$i]}=$answer[$i];
1494: }
1495: }
1496: }
1497: return %returnhash;
1498: }
1499:
1500: # ------------------------------------- Find the IDs behind a list of usernames
1501:
1502: sub idrget {
1503: my ($udom,@unames)=@_;
1504: my %returnhash=();
1505: foreach my $uname (@unames) {
1506: $returnhash{$uname}=(&userenvironment($udom,$uname,'id'))[1];
1507: }
1508: return %returnhash;
1509: }
1510:
1511: # ------------------------------- Store away a list of names and associated IDs
1512:
1513: sub idput {
1514: my ($udom,%ids)=@_;
1515: my %servers=();
1516: foreach my $uname (keys(%ids)) {
1517: &cput('environment',{'id'=>$ids{$uname}},$udom,$uname);
1518: my $uhom=&homeserver($uname,$udom);
1519: if ($uhom ne 'no_host') {
1520: my $id=&escape($ids{$uname});
1521: $id=~tr/A-Z/a-z/;
1522: my $esc_unam=&escape($uname);
1523: if ($servers{$uhom}) {
1524: $servers{$uhom}.='&'.$id.'='.$esc_unam;
1525: } else {
1526: $servers{$uhom}=$id.'='.$esc_unam;
1527: }
1528: }
1529: }
1530: foreach my $server (keys(%servers)) {
1531: &critical('idput:'.$udom.':'.$servers{$server},$server);
1532: }
1533: }
1534:
1535: # ------------------------------dump from db file owned by domainconfig user
1536: sub dump_dom {
1537: my ($namespace,$udom,$regexp,$range)=@_;
1538: if (!$udom) {
1539: $udom=$env{'user.domain'};
1540: }
1541: my %returnhash;
1542: if ($udom) {
1543: my $uname = &get_domainconfiguser($udom);
1544: %returnhash = &dump($namespace,$udom,$uname,$regexp,$range);
1545: }
1546: return %returnhash;
1547: }
1548:
1549: # ------------------------------------------ get items from domain db files
1550:
1551: sub get_dom {
1552: my ($namespace,$storearr,$udom,$uhome)=@_;
1553: my $items='';
1554: foreach my $item (@$storearr) {
1555: $items.=&escape($item).'&';
1556: }
1557: $items=~s/\&$//;
1558: if (!$udom) {
1559: $udom=$env{'user.domain'};
1560: if (defined(&domain($udom,'primary'))) {
1561: $uhome=&domain($udom,'primary');
1562: } else {
1563: undef($uhome);
1564: }
1565: } else {
1566: if (!$uhome) {
1567: if (defined(&domain($udom,'primary'))) {
1568: $uhome=&domain($udom,'primary');
1569: }
1570: }
1571: }
1572: if ($udom && $uhome && ($uhome ne 'no_host')) {
1573: my $rep=&reply("getdom:$udom:$namespace:$items",$uhome);
1574: my %returnhash;
1575: if ($rep eq '' || $rep =~ /^error: 2 /) {
1576: return %returnhash;
1577: }
1578: my @pairs=split(/\&/,$rep);
1579: if ( $#pairs==0 && $pairs[0] =~ /^(con_lost|error|no_such_host)/i) {
1580: return @pairs;
1581: }
1582: my $i=0;
1583: foreach my $item (@$storearr) {
1584: $returnhash{$item}=&thaw_unescape($pairs[$i]);
1585: $i++;
1586: }
1587: return %returnhash;
1588: } else {
1589: &logthis("get_dom failed - no homeserver and/or domain ($udom) ($uhome)");
1590: }
1591: }
1592:
1593: # -------------------------------------------- put items in domain db files
1594:
1595: sub put_dom {
1596: my ($namespace,$storehash,$udom,$uhome)=@_;
1597: if (!$udom) {
1598: $udom=$env{'user.domain'};
1599: if (defined(&domain($udom,'primary'))) {
1600: $uhome=&domain($udom,'primary');
1601: } else {
1602: undef($uhome);
1603: }
1604: } else {
1605: if (!$uhome) {
1606: if (defined(&domain($udom,'primary'))) {
1607: $uhome=&domain($udom,'primary');
1608: }
1609: }
1610: }
1611: if ($udom && $uhome && ($uhome ne 'no_host')) {
1612: my $items='';
1613: foreach my $item (keys(%$storehash)) {
1614: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
1615: }
1616: $items=~s/\&$//;
1617: return &reply("putdom:$udom:$namespace:$items",$uhome);
1618: } else {
1619: &logthis("put_dom failed - no homeserver and/or domain");
1620: }
1621: }
1622:
1623: # --------------------- newput for items in db file owned by domainconfig user
1624: sub newput_dom {
1625: my ($namespace,$storehash,$udom) = @_;
1626: my $result;
1627: if (!$udom) {
1628: $udom=$env{'user.domain'};
1629: }
1630: if ($udom) {
1631: my $uname = &get_domainconfiguser($udom);
1632: $result = &newput($namespace,$storehash,$udom,$uname);
1633: }
1634: return $result;
1635: }
1636:
1637: # --------------------- delete for items in db file owned by domainconfig user
1638: sub del_dom {
1639: my ($namespace,$storearr,$udom)=@_;
1640: if (ref($storearr) eq 'ARRAY') {
1641: if (!$udom) {
1642: $udom=$env{'user.domain'};
1643: }
1644: if ($udom) {
1645: my $uname = &get_domainconfiguser($udom);
1646: return &del($namespace,$storearr,$udom,$uname);
1647: }
1648: }
1649: }
1650:
1651: # ----------------------------------construct domainconfig user for a domain
1652: sub get_domainconfiguser {
1653: my ($udom) = @_;
1654: return $udom.'-domainconfig';
1655: }
1656:
1657: sub retrieve_inst_usertypes {
1658: my ($udom) = @_;
1659: my (%returnhash,@order);
1660: my %domdefs = &Apache::lonnet::get_domain_defaults($udom);
1661: if ((ref($domdefs{'inststatustypes'}) eq 'HASH') &&
1662: (ref($domdefs{'inststatusorder'}) eq 'ARRAY')) {
1663: %returnhash = %{$domdefs{'inststatustypes'}};
1664: @order = @{$domdefs{'inststatusorder'}};
1665: } else {
1666: if (defined(&domain($udom,'primary'))) {
1667: my $uhome=&domain($udom,'primary');
1668: my $rep=&reply("inst_usertypes:$udom",$uhome);
1669: if ($rep =~ /^(con_lost|error|no_such_host|refused)/) {
1670: &logthis("get_dom failed - $rep returned from $uhome in domain: $udom");
1671: return (\%returnhash,\@order);
1672: }
1673: my ($hashitems,$orderitems) = split(/:/,$rep);
1674: my @pairs=split(/\&/,$hashitems);
1675: foreach my $item (@pairs) {
1676: my ($key,$value)=split(/=/,$item,2);
1677: $key = &unescape($key);
1678: next if ($key =~ /^error: 2 /);
1679: $returnhash{$key}=&thaw_unescape($value);
1680: }
1681: my @esc_order = split(/\&/,$orderitems);
1682: foreach my $item (@esc_order) {
1683: push(@order,&unescape($item));
1684: }
1685: } else {
1686: &logthis("get_dom failed - no primary domain server for $udom");
1687: }
1688: }
1689: return (\%returnhash,\@order);
1690: }
1691:
1692: sub is_domainimage {
1693: my ($url) = @_;
1694: if ($url=~m-^/+res/+($match_domain)/+\1\-domainconfig/+(img|logo|domlogo)/+-) {
1695: if (&domain($1) ne '') {
1696: return '1';
1697: }
1698: }
1699: return;
1700: }
1701:
1702: sub inst_directory_query {
1703: my ($srch) = @_;
1704: my $udom = $srch->{'srchdomain'};
1705: my %results;
1706: my $homeserver = &domain($udom,'primary');
1707: my $outcome;
1708: if ($homeserver ne '') {
1709: my $queryid=&reply("querysend:instdirsearch:".
1710: &escape($srch->{'srchby'}).':'.
1711: &escape($srch->{'srchterm'}).':'.
1712: &escape($srch->{'srchtype'}),$homeserver);
1713: my $host=&hostname($homeserver);
1714: if ($queryid !~/^\Q$host\E\_/) {
1715: &logthis('instituional directory search invalid queryid: '.$queryid.' for host: '.$homeserver.'in domain '.$udom);
1716: return;
1717: }
1718: my $response = &get_query_reply($queryid);
1719: my $maxtries = 5;
1720: my $tries = 1;
1721: while (($response=~/^timeout/) && ($tries < $maxtries)) {
1722: $response = &get_query_reply($queryid);
1723: $tries ++;
1724: }
1725:
1726: if (!&error($response) && $response ne 'refused') {
1727: if ($response eq 'unavailable') {
1728: $outcome = $response;
1729: } else {
1730: $outcome = 'ok';
1731: my @matches = split(/\n/,$response);
1732: foreach my $match (@matches) {
1733: my ($key,$value) = split(/=/,$match);
1734: $results{&unescape($key).':'.$udom} = &thaw_unescape($value);
1735: }
1736: }
1737: }
1738: }
1739: return ($outcome,%results);
1740: }
1741:
1742: sub usersearch {
1743: my ($srch) = @_;
1744: my $dom = $srch->{'srchdomain'};
1745: my %results;
1746: my %libserv = &all_library();
1747: my $query = 'usersearch';
1748: foreach my $tryserver (keys(%libserv)) {
1749: if (&host_domain($tryserver) eq $dom) {
1750: my $host=&hostname($tryserver);
1751: my $queryid=
1752: &reply("querysend:".&escape($query).':'.
1753: &escape($srch->{'srchby'}).':'.
1754: &escape($srch->{'srchtype'}).':'.
1755: &escape($srch->{'srchterm'}),$tryserver);
1756: if ($queryid !~/^\Q$host\E\_/) {
1757: &logthis('usersearch: invalid queryid: '.$queryid.' for host: '.$host.'in domain '.$dom.' and server: '.$tryserver);
1758: next;
1759: }
1760: my $reply = &get_query_reply($queryid);
1761: my $maxtries = 1;
1762: my $tries = 1;
1763: while (($reply=~/^timeout/) && ($tries < $maxtries)) {
1764: $reply = &get_query_reply($queryid);
1765: $tries ++;
1766: }
1767: if ( ($reply =~/^timeout/) || ($reply =~/^error/) ) {
1768: &logthis('usersrch error: '.$reply.' for '.$dom.' - searching for : '.$srch->{'srchterm'}.' by '.$srch->{'srchby'}.' ('.$srch->{'srchtype'}.') - maxtries: '.$maxtries.' tries: '.$tries);
1769: } else {
1770: my @matches;
1771: if ($reply =~ /\n/) {
1772: @matches = split(/\n/,$reply);
1773: } else {
1774: @matches = split(/\&/,$reply);
1775: }
1776: foreach my $match (@matches) {
1777: my ($uname,$udom,%userhash);
1778: foreach my $entry (split(/:/,$match)) {
1779: my ($key,$value) =
1780: map {&unescape($_);} split(/=/,$entry);
1781: $userhash{$key} = $value;
1782: if ($key eq 'username') {
1783: $uname = $value;
1784: } elsif ($key eq 'domain') {
1785: $udom = $value;
1786: }
1787: }
1788: $results{$uname.':'.$udom} = \%userhash;
1789: }
1790: }
1791: }
1792: }
1793: return %results;
1794: }
1795:
1796: sub get_instuser {
1797: my ($udom,$uname,$id) = @_;
1798: my $homeserver = &domain($udom,'primary');
1799: my ($outcome,%results);
1800: if ($homeserver ne '') {
1801: my $queryid=&reply("querysend:getinstuser:".&escape($uname).':'.
1802: &escape($id).':'.&escape($udom),$homeserver);
1803: my $host=&hostname($homeserver);
1804: if ($queryid !~/^\Q$host\E\_/) {
1805: &logthis('get_instuser invalid queryid: '.$queryid.' for host: '.$homeserver.'in domain '.$udom);
1806: return;
1807: }
1808: my $response = &get_query_reply($queryid);
1809: my $maxtries = 5;
1810: my $tries = 1;
1811: while (($response=~/^timeout/) && ($tries < $maxtries)) {
1812: $response = &get_query_reply($queryid);
1813: $tries ++;
1814: }
1815: if (!&error($response) && $response ne 'refused') {
1816: if ($response eq 'unavailable') {
1817: $outcome = $response;
1818: } else {
1819: $outcome = 'ok';
1820: my @matches = split(/\n/,$response);
1821: foreach my $match (@matches) {
1822: my ($key,$value) = split(/=/,$match);
1823: $results{&unescape($key)} = &thaw_unescape($value);
1824: }
1825: }
1826: }
1827: }
1828: my %userinfo;
1829: if (ref($results{$uname}) eq 'HASH') {
1830: %userinfo = %{$results{$uname}};
1831: }
1832: return ($outcome,%userinfo);
1833: }
1834:
1835: sub inst_rulecheck {
1836: my ($udom,$uname,$id,$item,$rules) = @_;
1837: my %returnhash;
1838: if ($udom ne '') {
1839: if (ref($rules) eq 'ARRAY') {
1840: @{$rules} = map {&escape($_);} (@{$rules});
1841: my $rulestr = join(':',@{$rules});
1842: my $homeserver=&domain($udom,'primary');
1843: if (($homeserver ne '') && ($homeserver ne 'no_host')) {
1844: my $response;
1845: if ($item eq 'username') {
1846: $response=&unescape(&reply('instrulecheck:'.&escape($udom).
1847: ':'.&escape($uname).':'.$rulestr,
1848: $homeserver));
1849: } elsif ($item eq 'id') {
1850: $response=&unescape(&reply('instidrulecheck:'.&escape($udom).
1851: ':'.&escape($id).':'.$rulestr,
1852: $homeserver));
1853: } elsif ($item eq 'selfcreate') {
1854: $response=&unescape(&reply('instselfcreatecheck:'.
1855: &escape($udom).':'.&escape($uname).
1856: ':'.$rulestr,$homeserver));
1857: }
1858: if ($response ne 'refused') {
1859: my @pairs=split(/\&/,$response);
1860: foreach my $item (@pairs) {
1861: my ($key,$value)=split(/=/,$item,2);
1862: $key = &unescape($key);
1863: next if ($key =~ /^error: 2 /);
1864: $returnhash{$key}=&thaw_unescape($value);
1865: }
1866: }
1867: }
1868: }
1869: }
1870: return %returnhash;
1871: }
1872:
1873: sub inst_userrules {
1874: my ($udom,$check) = @_;
1875: my (%ruleshash,@ruleorder);
1876: if ($udom ne '') {
1877: my $homeserver=&domain($udom,'primary');
1878: if (($homeserver ne '') && ($homeserver ne 'no_host')) {
1879: my $response;
1880: if ($check eq 'id') {
1881: $response=&reply('instidrules:'.&escape($udom),
1882: $homeserver);
1883: } elsif ($check eq 'email') {
1884: $response=&reply('instemailrules:'.&escape($udom),
1885: $homeserver);
1886: } else {
1887: $response=&reply('instuserrules:'.&escape($udom),
1888: $homeserver);
1889: }
1890: if (($response ne 'refused') && ($response ne 'error') &&
1891: ($response ne 'unknown_cmd') &&
1892: ($response ne 'no_such_host')) {
1893: my ($hashitems,$orderitems) = split(/:/,$response);
1894: my @pairs=split(/\&/,$hashitems);
1895: foreach my $item (@pairs) {
1896: my ($key,$value)=split(/=/,$item,2);
1897: $key = &unescape($key);
1898: next if ($key =~ /^error: 2 /);
1899: $ruleshash{$key}=&thaw_unescape($value);
1900: }
1901: my @esc_order = split(/\&/,$orderitems);
1902: foreach my $item (@esc_order) {
1903: push(@ruleorder,&unescape($item));
1904: }
1905: }
1906: }
1907: }
1908: return (\%ruleshash,\@ruleorder);
1909: }
1910:
1911: # ------------- Get Authentication, Language and User Tools Defaults for Domain
1912:
1913: sub get_domain_defaults {
1914: my ($domain) = @_;
1915: my $cachetime = 60*60*24;
1916: my ($result,$cached)=&is_cached_new('domdefaults',$domain);
1917: if (defined($cached)) {
1918: if (ref($result) eq 'HASH') {
1919: return %{$result};
1920: }
1921: }
1922: my %domdefaults;
1923: my %domconfig =
1924: &Apache::lonnet::get_dom('configuration',['defaults','quotas',
1925: 'requestcourses','inststatus',
1926: 'coursedefaults','usersessions'],$domain);
1927: if (ref($domconfig{'defaults'}) eq 'HASH') {
1928: $domdefaults{'lang_def'} = $domconfig{'defaults'}{'lang_def'};
1929: $domdefaults{'auth_def'} = $domconfig{'defaults'}{'auth_def'};
1930: $domdefaults{'auth_arg_def'} = $domconfig{'defaults'}{'auth_arg_def'};
1931: $domdefaults{'timezone_def'} = $domconfig{'defaults'}{'timezone_def'};
1932: $domdefaults{'datelocale_def'} = $domconfig{'defaults'}{'datelocale_def'};
1933: $domdefaults{'portal_def'} = $domconfig{'defaults'}{'portal_def'};
1934: } else {
1935: $domdefaults{'lang_def'} = &domain($domain,'lang_def');
1936: $domdefaults{'auth_def'} = &domain($domain,'auth_def');
1937: $domdefaults{'auth_arg_def'} = &domain($domain,'auth_arg_def');
1938: }
1939: if (ref($domconfig{'quotas'}) eq 'HASH') {
1940: if (ref($domconfig{'quotas'}{'defaultquota'}) eq 'HASH') {
1941: $domdefaults{'defaultquota'} = $domconfig{'quotas'}{'defaultquota'};
1942: } else {
1943: $domdefaults{'defaultquota'} = $domconfig{'quotas'};
1944: }
1945: my @usertools = ('aboutme','blog','portfolio');
1946: foreach my $item (@usertools) {
1947: if (ref($domconfig{'quotas'}{$item}) eq 'HASH') {
1948: $domdefaults{$item} = $domconfig{'quotas'}{$item};
1949: }
1950: }
1951: }
1952: if (ref($domconfig{'requestcourses'}) eq 'HASH') {
1953: foreach my $item ('official','unofficial','community') {
1954: $domdefaults{$item} = $domconfig{'requestcourses'}{$item};
1955: }
1956: }
1957: if (ref($domconfig{'inststatus'}) eq 'HASH') {
1958: foreach my $item ('inststatustypes','inststatusorder') {
1959: $domdefaults{$item} = $domconfig{'inststatus'}{$item};
1960: }
1961: }
1962: if (ref($domconfig{'coursedefaults'}) eq 'HASH') {
1963: foreach my $item ('canuse_pdfforms') {
1964: $domdefaults{$item} = $domconfig{'coursedefaults'}{$item};
1965: }
1966: }
1967: if (ref($domconfig{'usersessions'}) eq 'HASH') {
1968: if (ref($domconfig{'usersessions'}{'remote'}) eq 'HASH') {
1969: $domdefaults{'remotesessions'} = $domconfig{'usersessions'}{'remote'};
1970: }
1971: if (ref($domconfig{'usersessions'}{'hosted'}) eq 'HASH') {
1972: $domdefaults{'hostedsessions'} = $domconfig{'usersessions'}{'hosted'};
1973: }
1974: }
1975: &Apache::lonnet::do_cache_new('domdefaults',$domain,\%domdefaults,
1976: $cachetime);
1977: return %domdefaults;
1978: }
1979:
1980: # --------------------------------------------------- Assign a key to a student
1981:
1982: sub assign_access_key {
1983: #
1984: # a valid key looks like uname:udom#comments
1985: # comments are being appended
1986: #
1987: my ($ckey,$kdom,$knum,$cdom,$cnum,$udom,$uname,$logentry)=@_;
1988: $kdom=
1989: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($kdom));
1990: $knum=
1991: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($knum));
1992: $cdom=
1993: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
1994: $cnum=
1995: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
1996: $udom=$env{'user.name'} unless (defined($udom));
1997: $uname=$env{'user.domain'} unless (defined($uname));
1998: my %existing=&get('accesskeys',[$ckey],$kdom,$knum);
1999: if (($existing{$ckey}=~/^\#(.*)$/) || # - new key
2000: ($existing{$ckey}=~/^\Q$uname\E\:\Q$udom\E\#(.*)$/)) {
2001: # assigned to this person
2002: # - this should not happen,
2003: # unless something went wrong
2004: # the first time around
2005: # ready to assign
2006: $logentry=$1.'; '.$logentry;
2007: if (&put('accesskeys',{$ckey=>$uname.':'.$udom.'#'.$logentry},
2008: $kdom,$knum) eq 'ok') {
2009: # key now belongs to user
2010: my $envkey='key.'.$cdom.'_'.$cnum;
2011: if (&put('environment',{$envkey => $ckey}) eq 'ok') {
2012: &appenv({'environment.'.$envkey => $ckey});
2013: return 'ok';
2014: } else {
2015: return
2016: 'error: Count not permanently assign key, will need to be re-entered later.';
2017: }
2018: } else {
2019: return 'error: Could not assign key, try again later.';
2020: }
2021: } elsif (!$existing{$ckey}) {
2022: # the key does not exist
2023: return 'error: The key does not exist';
2024: } else {
2025: # the key is somebody else's
2026: return 'error: The key is already in use';
2027: }
2028: }
2029:
2030: # ------------------------------------------ put an additional comment on a key
2031:
2032: sub comment_access_key {
2033: #
2034: # a valid key looks like uname:udom#comments
2035: # comments are being appended
2036: #
2037: my ($ckey,$cdom,$cnum,$logentry)=@_;
2038: $cdom=
2039: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
2040: $cnum=
2041: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
2042: my %existing=&get('accesskeys',[$ckey],$cdom,$cnum);
2043: if ($existing{$ckey}) {
2044: $existing{$ckey}.='; '.$logentry;
2045: # ready to assign
2046: if (&put('accesskeys',{$ckey=>$existing{$ckey}},
2047: $cdom,$cnum) eq 'ok') {
2048: return 'ok';
2049: } else {
2050: return 'error: Count not store comment.';
2051: }
2052: } else {
2053: # the key does not exist
2054: return 'error: The key does not exist';
2055: }
2056: }
2057:
2058: # ------------------------------------------------------ Generate a set of keys
2059:
2060: sub generate_access_keys {
2061: my ($number,$cdom,$cnum,$logentry)=@_;
2062: $cdom=
2063: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
2064: $cnum=
2065: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
2066: unless (&allowed('mky',$cdom)) { return 0; }
2067: unless (($cdom) && ($cnum)) { return 0; }
2068: if ($number>10000) { return 0; }
2069: sleep(2); # make sure don't get same seed twice
2070: srand(time()^($$+($$<<15))); # from "Programming Perl"
2071: my $total=0;
2072: for (my $i=1;$i<=$number;$i++) {
2073: my $newkey=sprintf("%lx",int(100000*rand)).'-'.
2074: sprintf("%lx",int(100000*rand)).'-'.
2075: sprintf("%lx",int(100000*rand));
2076: $newkey=~s/1/g/g; # folks mix up 1 and l
2077: $newkey=~s/0/h/g; # and also 0 and O
2078: my %existing=&get('accesskeys',[$newkey],$cdom,$cnum);
2079: if ($existing{$newkey}) {
2080: $i--;
2081: } else {
2082: if (&put('accesskeys',
2083: { $newkey => '# generated '.localtime().
2084: ' by '.$env{'user.name'}.'@'.$env{'user.domain'}.
2085: '; '.$logentry },
2086: $cdom,$cnum) eq 'ok') {
2087: $total++;
2088: }
2089: }
2090: }
2091: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},
2092: 'Generated '.$total.' keys for '.$cnum.' at '.$cdom);
2093: return $total;
2094: }
2095:
2096: # ------------------------------------------------------- Validate an accesskey
2097:
2098: sub validate_access_key {
2099: my ($ckey,$cdom,$cnum,$udom,$uname)=@_;
2100: $cdom=
2101: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
2102: $cnum=
2103: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
2104: $udom=$env{'user.domain'} unless (defined($udom));
2105: $uname=$env{'user.name'} unless (defined($uname));
2106: my %existing=&get('accesskeys',[$ckey],$cdom,$cnum);
2107: return ($existing{$ckey}=~/^\Q$uname\E\:\Q$udom\E\#/);
2108: }
2109:
2110: # ------------------------------------- Find the section of student in a course
2111: sub devalidate_getsection_cache {
2112: my ($udom,$unam,$courseid)=@_;
2113: my $hashid="$udom:$unam:$courseid";
2114: &devalidate_cache_new('getsection',$hashid);
2115: }
2116:
2117: sub courseid_to_courseurl {
2118: my ($courseid) = @_;
2119: #already url style courseid
2120: return $courseid if ($courseid =~ m{^/});
2121:
2122: if (exists($env{'course.'.$courseid.'.num'})) {
2123: my $cnum = $env{'course.'.$courseid.'.num'};
2124: my $cdom = $env{'course.'.$courseid.'.domain'};
2125: return "/$cdom/$cnum";
2126: }
2127:
2128: my %courseinfo=&Apache::lonnet::coursedescription($courseid);
2129: if (exists($courseinfo{'num'})) {
2130: return "/$courseinfo{'domain'}/$courseinfo{'num'}";
2131: }
2132:
2133: return undef;
2134: }
2135:
2136: sub getsection {
2137: my ($udom,$unam,$courseid)=@_;
2138: my $cachetime=1800;
2139:
2140: my $hashid="$udom:$unam:$courseid";
2141: my ($result,$cached)=&is_cached_new('getsection',$hashid);
2142: if (defined($cached)) { return $result; }
2143:
2144: my %Pending;
2145: my %Expired;
2146: #
2147: # Each role can either have not started yet (pending), be active,
2148: # or have expired.
2149: #
2150: # If there is an active role, we are done.
2151: #
2152: # If there is more than one role which has not started yet,
2153: # choose the one which will start sooner
2154: # If there is one role which has not started yet, return it.
2155: #
2156: # If there is more than one expired role, choose the one which ended last.
2157: # If there is a role which has expired, return it.
2158: #
2159: $courseid = &courseid_to_courseurl($courseid);
2160: my $extra = &freeze_escape({'skipcheck' => 1});
2161: my %roleshash = &dump('roles',$udom,$unam,$courseid,undef,$extra);
2162: foreach my $key (keys(%roleshash)) {
2163: next if ($key !~/^\Q$courseid\E(?:\/)*(\w+)*\_st$/);
2164: my $section=$1;
2165: if ($key eq $courseid.'_st') { $section=''; }
2166: my ($dummy,$end,$start)=split(/\_/,&unescape($roleshash{$key}));
2167: my $now=time;
2168: if (defined($end) && $end && ($now > $end)) {
2169: $Expired{$end}=$section;
2170: next;
2171: }
2172: if (defined($start) && $start && ($now < $start)) {
2173: $Pending{$start}=$section;
2174: next;
2175: }
2176: return &do_cache_new('getsection',$hashid,$section,$cachetime);
2177: }
2178: #
2179: # Presumedly there will be few matching roles from the above
2180: # loop and the sorting time will be negligible.
2181: if (scalar(keys(%Pending))) {
2182: my ($time) = sort {$a <=> $b} keys(%Pending);
2183: return &do_cache_new('getsection',$hashid,$Pending{$time},$cachetime);
2184: }
2185: if (scalar(keys(%Expired))) {
2186: my @sorted = sort {$a <=> $b} keys(%Expired);
2187: my $time = pop(@sorted);
2188: return &do_cache_new('getsection',$hashid,$Expired{$time},$cachetime);
2189: }
2190: return &do_cache_new('getsection',$hashid,'-1',$cachetime);
2191: }
2192:
2193: sub save_cache {
2194: &purge_remembered();
2195: #&Apache::loncommon::validate_page();
2196: undef(%env);
2197: undef($env_loaded);
2198: }
2199:
2200: my $to_remember=-1;
2201: my %remembered;
2202: my %accessed;
2203: my $kicks=0;
2204: my $hits=0;
2205: sub make_key {
2206: my ($name,$id) = @_;
2207: if (length($id) > 65
2208: && length(&escape($id)) > 200) {
2209: $id=length($id).':'.&Digest::MD5::md5_hex($id);
2210: }
2211: return &escape($name.':'.$id);
2212: }
2213:
2214: sub devalidate_cache_new {
2215: my ($name,$id,$debug) = @_;
2216: if ($debug) { &Apache::lonnet::logthis("deleting $name:$id"); }
2217: $id=&make_key($name,$id);
2218: $memcache->delete($id);
2219: delete($remembered{$id});
2220: delete($accessed{$id});
2221: }
2222:
2223: sub is_cached_new {
2224: my ($name,$id,$debug) = @_;
2225: $id=&make_key($name,$id);
2226: if (exists($remembered{$id})) {
2227: if ($debug) { &Apache::lonnet::logthis("Early return $id of $remembered{$id} "); }
2228: $accessed{$id}=[&gettimeofday()];
2229: $hits++;
2230: return ($remembered{$id},1);
2231: }
2232: my $value = $memcache->get($id);
2233: if (!(defined($value))) {
2234: if ($debug) { &Apache::lonnet::logthis("getting $id is not defined"); }
2235: return (undef,undef);
2236: }
2237: if ($value eq '__undef__') {
2238: if ($debug) { &Apache::lonnet::logthis("getting $id is __undef__"); }
2239: $value=undef;
2240: }
2241: &make_room($id,$value,$debug);
2242: if ($debug) { &Apache::lonnet::logthis("getting $id is $value"); }
2243: return ($value,1);
2244: }
2245:
2246: sub do_cache_new {
2247: my ($name,$id,$value,$time,$debug) = @_;
2248: $id=&make_key($name,$id);
2249: my $setvalue=$value;
2250: if (!defined($setvalue)) {
2251: $setvalue='__undef__';
2252: }
2253: if (!defined($time) ) {
2254: $time=600;
2255: }
2256: if ($debug) { &Apache::lonnet::logthis("Setting $id to $value"); }
2257: my $result = $memcache->set($id,$setvalue,$time);
2258: if (! $result) {
2259: &logthis("caching of id -> $id failed");
2260: $memcache->disconnect_all();
2261: }
2262: # need to make a copy of $value
2263: &make_room($id,$value,$debug);
2264: return $value;
2265: }
2266:
2267: sub make_room {
2268: my ($id,$value,$debug)=@_;
2269:
2270: $remembered{$id}= (ref($value)) ? &Storable::dclone($value)
2271: : $value;
2272: if ($to_remember<0) { return; }
2273: $accessed{$id}=[&gettimeofday()];
2274: if (scalar(keys(%remembered)) <= $to_remember) { return; }
2275: my $to_kick;
2276: my $max_time=0;
2277: foreach my $other (keys(%accessed)) {
2278: if (&tv_interval($accessed{$other}) > $max_time) {
2279: $to_kick=$other;
2280: $max_time=&tv_interval($accessed{$other});
2281: }
2282: }
2283: delete($remembered{$to_kick});
2284: delete($accessed{$to_kick});
2285: $kicks++;
2286: if ($debug) { &logthis("kicking $to_kick $max_time $kicks\n"); }
2287: return;
2288: }
2289:
2290: sub purge_remembered {
2291: #&logthis("Tossing ".scalar(keys(%remembered)));
2292: #&logthis(sprintf("%-20s is %s",'%remembered',length(&freeze(\%remembered))));
2293: undef(%remembered);
2294: undef(%accessed);
2295: }
2296: # ------------------------------------- Read an entry from a user's environment
2297:
2298: sub userenvironment {
2299: my ($udom,$unam,@what)=@_;
2300: my $items;
2301: foreach my $item (@what) {
2302: $items.=&escape($item).'&';
2303: }
2304: $items=~s/\&$//;
2305: my %returnhash=();
2306: my $uhome = &homeserver($unam,$udom);
2307: unless ($uhome eq 'no_host') {
2308: my @answer=split(/\&/,
2309: &reply('get:'.$udom.':'.$unam.':environment:'.$items,$uhome));
2310: if ($#answer==0 && $answer[0] =~ /^(con_lost|error:|no_such_host)/i) {
2311: return %returnhash;
2312: }
2313: my $i;
2314: for ($i=0;$i<=$#what;$i++) {
2315: $returnhash{$what[$i]}=&unescape($answer[$i]);
2316: }
2317: }
2318: return %returnhash;
2319: }
2320:
2321: # ---------------------------------------------------------- Get a studentphoto
2322: sub studentphoto {
2323: my ($udom,$unam,$ext) = @_;
2324: my $home=&Apache::lonnet::homeserver($unam,$udom);
2325: if (defined($env{'request.course.id'})) {
2326: if ($env{'course.'.$env{'request.course.id'}.'.internal.showphoto'}) {
2327: if ($udom eq $env{'course.'.$env{'request.course.id'}.'.domain'}) {
2328: return(&retrievestudentphoto($udom,$unam,$ext));
2329: } else {
2330: my ($result,$perm_reqd)=
2331: &Apache::lonnet::auto_photo_permission($unam,$udom);
2332: if ($result eq 'ok') {
2333: if (!($perm_reqd eq 'yes')) {
2334: return(&retrievestudentphoto($udom,$unam,$ext));
2335: }
2336: }
2337: }
2338: }
2339: } else {
2340: my ($result,$perm_reqd) =
2341: &Apache::lonnet::auto_photo_permission($unam,$udom);
2342: if ($result eq 'ok') {
2343: if (!($perm_reqd eq 'yes')) {
2344: return(&retrievestudentphoto($udom,$unam,$ext));
2345: }
2346: }
2347: }
2348: return '/adm/lonKaputt/lonlogo_broken.gif';
2349: }
2350:
2351: sub retrievestudentphoto {
2352: my ($udom,$unam,$ext,$type) = @_;
2353: my $home=&Apache::lonnet::homeserver($unam,$udom);
2354: my $ret=&Apache::lonnet::reply("studentphoto:$udom:$unam:$ext:$type",$home);
2355: if ($ret eq 'ok') {
2356: my $url="/uploaded/$udom/$unam/internal/studentphoto.$ext";
2357: if ($type eq 'thumbnail') {
2358: $url="/uploaded/$udom/$unam/internal/studentphoto_tn.$ext";
2359: }
2360: my $tokenurl=&Apache::lonnet::tokenwrapper($url);
2361: return $tokenurl;
2362: } else {
2363: if ($type eq 'thumbnail') {
2364: return '/adm/lonKaputt/genericstudent_tn.gif';
2365: } else {
2366: return '/adm/lonKaputt/lonlogo_broken.gif';
2367: }
2368: }
2369: }
2370:
2371: # -------------------------------------------------------------------- New chat
2372:
2373: sub chatsend {
2374: my ($newentry,$anon,$group)=@_;
2375: my $cnum=$env{'course.'.$env{'request.course.id'}.'.num'};
2376: my $cdom=$env{'course.'.$env{'request.course.id'}.'.domain'};
2377: my $chome=$env{'course.'.$env{'request.course.id'}.'.home'};
2378: &reply('chatsend:'.$cdom.':'.$cnum.':'.
2379: &escape($env{'user.domain'}.':'.$env{'user.name'}.':'.$anon.':'.
2380: &escape($newentry)).':'.$group,$chome);
2381: }
2382:
2383: # ------------------------------------------ Find current version of a resource
2384:
2385: sub getversion {
2386: my $fname=&clutter(shift);
2387: unless ($fname=~/^\/res\//) { return -1; }
2388: return ¤tversion(&filelocation('',$fname));
2389: }
2390:
2391: sub currentversion {
2392: my $fname=shift;
2393: my $author=$fname;
2394: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
2395: my ($udom,$uname)=split(/\//,$author);
2396: my $home=&homeserver($uname,$udom);
2397: if ($home eq 'no_host') {
2398: return -1;
2399: }
2400: my $answer=&reply("currentversion:$fname",$home);
2401: if (($answer eq 'con_lost') || ($answer eq 'rejected')) {
2402: return -1;
2403: }
2404: return $answer;
2405: }
2406:
2407: #
2408: # Return special version number of resource if set by override, empty otherwise
2409: #
2410: sub usedversion {
2411: my $fname=shift;
2412: unless ($fname) { $fname=$env{'request.uri'}; }
2413: my ($urlversion)=($fname=~/\.(\d+)\.\w+$/);
2414: if ($urlversion) { return $urlversion; }
2415: return '';
2416: }
2417:
2418: # ----------------------------- Subscribe to a resource, return URL if possible
2419:
2420: sub subscribe {
2421: my $fname=shift;
2422: if ($fname=~/\/(aboutme|syllabus|bulletinboard|smppg)$/) { return ''; }
2423: $fname=~s/[\n\r]//g;
2424: my $author=$fname;
2425: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
2426: my ($udom,$uname)=split(/\//,$author);
2427: my $home=homeserver($uname,$udom);
2428: if ($home eq 'no_host') {
2429: return 'not_found';
2430: }
2431: my $answer=reply("sub:$fname",$home);
2432: if (($answer eq 'con_lost') || ($answer eq 'rejected')) {
2433: $answer.=' by '.$home;
2434: }
2435: return $answer;
2436: }
2437:
2438: # -------------------------------------------------------------- Replicate file
2439:
2440: sub repcopy {
2441: my $filename=shift;
2442: $filename=~s/\/+/\//g;
2443: my $londocroot = $perlvar{'lonDocRoot'};
2444: if ($filename=~m{^\Q$londocroot/adm/\E}) { return 'ok'; }
2445: if ($filename=~m{^\Q$londocroot/lonUsers/\E}) { return 'ok'; }
2446: if ($filename=~m{^\Q$londocroot/userfiles/\E} or
2447: $filename=~m{^/*(uploaded|editupload)/}) {
2448: return &repcopy_userfile($filename);
2449: }
2450: $filename=~s/[\n\r]//g;
2451: my $transname="$filename.in.transfer";
2452: # FIXME: this should flock
2453: if ((-e $filename) || (-e $transname)) { return 'ok'; }
2454: my $remoteurl=subscribe($filename);
2455: if ($remoteurl =~ /^con_lost by/) {
2456: &logthis("Subscribe returned $remoteurl: $filename");
2457: return 'unavailable';
2458: } elsif ($remoteurl eq 'not_found') {
2459: #&logthis("Subscribe returned not_found: $filename");
2460: return 'not_found';
2461: } elsif ($remoteurl =~ /^rejected by/) {
2462: &logthis("Subscribe returned $remoteurl: $filename");
2463: return 'forbidden';
2464: } elsif ($remoteurl eq 'directory') {
2465: return 'ok';
2466: } else {
2467: my $author=$filename;
2468: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
2469: my ($udom,$uname)=split(/\//,$author);
2470: my $home=homeserver($uname,$udom);
2471: unless ($home eq $perlvar{'lonHostID'}) {
2472: my @parts=split(/\//,$filename);
2473: my $path="/$parts[1]/$parts[2]/$parts[3]/$parts[4]";
2474: if ($path ne "$londocroot/res") {
2475: &logthis("Malconfiguration for replication: $filename");
2476: return 'bad_request';
2477: }
2478: my $count;
2479: for ($count=5;$count<$#parts;$count++) {
2480: $path.="/$parts[$count]";
2481: if ((-e $path)!=1) {
2482: mkdir($path,0777);
2483: }
2484: }
2485: my $ua=new LWP::UserAgent;
2486: my $request=new HTTP::Request('GET',"$remoteurl");
2487: my $response=$ua->request($request,$transname);
2488: if ($response->is_error()) {
2489: unlink($transname);
2490: my $message=$response->status_line;
2491: &logthis("<font color=\"blue\">WARNING:"
2492: ." LWP get: $message: $filename</font>");
2493: return 'unavailable';
2494: } else {
2495: if ($remoteurl!~/\.meta$/) {
2496: my $mrequest=new HTTP::Request('GET',$remoteurl.'.meta');
2497: my $mresponse=$ua->request($mrequest,$filename.'.meta');
2498: if ($mresponse->is_error()) {
2499: unlink($filename.'.meta');
2500: &logthis(
2501: "<font color=\"yellow\">INFO: No metadata: $filename</font>");
2502: }
2503: }
2504: rename($transname,$filename);
2505: return 'ok';
2506: }
2507: }
2508: }
2509: }
2510:
2511: # ------------------------------------------------ Get server side include body
2512: sub ssi_body {
2513: my ($filelink,%form)=@_;
2514: if (! exists($form{'LONCAPA_INTERNAL_no_discussion'})) {
2515: $form{'LONCAPA_INTERNAL_no_discussion'}='true';
2516: }
2517: my $output='';
2518: my $response;
2519: if ($filelink=~/^https?\:/) {
2520: ($output,$response)=&externalssi($filelink);
2521: } else {
2522: $filelink .= $filelink=~/\?/ ? '&' : '?';
2523: $filelink .= 'inhibitmenu=yes';
2524: ($output,$response)=&ssi($filelink,%form);
2525: }
2526: $output=~s|//(\s*<!--)? BEGIN LON-CAPA Internal.+?// END LON-CAPA Internal\s*(-->)?\s||gs;
2527: $output=~s/^.*?\<body[^\>]*\>//si;
2528: $output=~s/\<\/body\s*\>.*?$//si;
2529: if (wantarray) {
2530: return ($output, $response);
2531: } else {
2532: return $output;
2533: }
2534: }
2535:
2536: # --------------------------------------------------------- Server Side Include
2537:
2538: sub absolute_url {
2539: my ($host_name) = @_;
2540: my $protocol = ($ENV{'SERVER_PORT'} == 443?'https://':'http://');
2541: if ($host_name eq '') {
2542: $host_name = $ENV{'SERVER_NAME'};
2543: }
2544: return $protocol.$host_name;
2545: }
2546:
2547: #
2548: # Server side include.
2549: # Parameters:
2550: # fn Possibly encrypted resource name/id.
2551: # form Hash that describes how the rendering should be done
2552: # and other things.
2553: # Returns:
2554: # Scalar context: The content of the response.
2555: # Array context: 2 element list of the content and the full response object.
2556: #
2557: sub ssi {
2558:
2559: my ($fn,%form)=@_;
2560: my $ua=new LWP::UserAgent;
2561: my $request;
2562:
2563: $form{'no_update_last_known'}=1;
2564: &Apache::lonenc::check_encrypt(\$fn);
2565: if (%form) {
2566: $request=new HTTP::Request('POST',&absolute_url().$fn);
2567: $request->content(join('&',map { &escape($_).'='.&escape($form{$_}) } keys(%form)));
2568: } else {
2569: $request=new HTTP::Request('GET',&absolute_url().$fn);
2570: }
2571:
2572: $request->header(Cookie => $ENV{'HTTP_COOKIE'});
2573: my $response=$ua->request($request);
2574:
2575: if (wantarray) {
2576: return ($response->content, $response);
2577: } else {
2578: return $response->content;
2579: }
2580: }
2581:
2582: sub externalssi {
2583: my ($url)=@_;
2584: my $ua=new LWP::UserAgent;
2585: my $request=new HTTP::Request('GET',$url);
2586: my $response=$ua->request($request);
2587: if (wantarray) {
2588: return ($response->content, $response);
2589: } else {
2590: return $response->content;
2591: }
2592: }
2593:
2594: # -------------------------------- Allow a /uploaded/ URI to be vouched for
2595:
2596: sub allowuploaded {
2597: my ($srcurl,$url)=@_;
2598: $url=&clutter(&declutter($url));
2599: my $dir=$url;
2600: $dir=~s/\/[^\/]+$//;
2601: my %httpref=();
2602: my $httpurl=&hreflocation('',$url);
2603: $httpref{'httpref.'.$httpurl}=$srcurl;
2604: &Apache::lonnet::appenv(\%httpref);
2605: }
2606:
2607: # --------- File operations in /home/httpd/html/userfiles/$domain/1/2/3/$course
2608: # input: action, courseID, current domain, intended
2609: # path to file, source of file, instruction to parse file for objects,
2610: # ref to hash for embedded objects,
2611: # ref to hash for codebase of java objects.
2612: # reference to scalar to accommodate mime type determined
2613: # from File::MMagic if $parser = parse.
2614: #
2615: # output: url to file (if action was uploaddoc),
2616: # ok if successful, or diagnostic message otherwise (if action was propagate or copy)
2617: #
2618: # Allows directory structure to be used within lonUsers/../userfiles/ for a
2619: # course.
2620: #
2621: # action = propagate - /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
2622: # will be copied to /home/httpd/lonUsers/1/2/3/$course/userfiles in
2623: # course's home server.
2624: #
2625: # action = copy - /home/httpd/html/userfiles/$domain/1/2/3/$course/$file will
2626: # be copied from $source (current location) to
2627: # /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
2628: # and will then be copied to
2629: # /home/httpd/lonUsers/$domain/1/2/3/$course/userfiles/$file in
2630: # course's home server.
2631: #
2632: # action = uploaddoc - /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
2633: # will be retrived from $env{form.uploaddoc} (from DOCS interface) to
2634: # /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
2635: # and will then be copied to /home/httpd/lonUsers/1/2/3/$course/userfiles/$file
2636: # in course's home server.
2637: #
2638:
2639: sub process_coursefile {
2640: my ($action,$docuname,$docudom,$file,$source,$parser,$allfiles,$codebase,
2641: $mimetype)=@_;
2642: my $fetchresult;
2643: my $home=&homeserver($docuname,$docudom);
2644: if ($action eq 'propagate') {
2645: $fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
2646: $home);
2647: } else {
2648: my $fpath = '';
2649: my $fname = $file;
2650: ($fpath,$fname) = ($file =~ m|^(.*)/([^/]+)$|);
2651: $fpath=$docudom.'/'.$docuname.'/'.$fpath;
2652: my $filepath = &build_filepath($fpath);
2653: if ($action eq 'copy') {
2654: if ($source eq '') {
2655: $fetchresult = 'no source file';
2656: return $fetchresult;
2657: } else {
2658: my $destination = $filepath.'/'.$fname;
2659: rename($source,$destination);
2660: $fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
2661: $home);
2662: }
2663: } elsif ($action eq 'uploaddoc') {
2664: open(my $fh,'>'.$filepath.'/'.$fname);
2665: print $fh $env{'form.'.$source};
2666: close($fh);
2667: if ($parser eq 'parse') {
2668: my $mm = new File::MMagic;
2669: my $type = $mm->checktype_filename($filepath.'/'.$fname);
2670: if ($type eq 'text/html') {
2671: my $parse_result = &extract_embedded_items($filepath.'/'.$fname,$allfiles,$codebase);
2672: unless ($parse_result eq 'ok') {
2673: &logthis('Failed to parse '.$filepath.'/'.$fname.' for embedded media: '.$parse_result);
2674: }
2675: }
2676: if (ref($mimetype)) {
2677: $$mimetype = $type;
2678: }
2679: }
2680: $fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
2681: $home);
2682: if ($fetchresult eq 'ok') {
2683: return '/uploaded/'.$fpath.'/'.$fname;
2684: } else {
2685: &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$file.
2686: ' to host '.$home.': '.$fetchresult);
2687: return '/adm/notfound.html';
2688: }
2689: }
2690: }
2691: unless ( $fetchresult eq 'ok') {
2692: &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$file.
2693: ' to host '.$home.': '.$fetchresult);
2694: }
2695: return $fetchresult;
2696: }
2697:
2698: sub build_filepath {
2699: my ($fpath) = @_;
2700: my $filepath=$perlvar{'lonDocRoot'}.'/userfiles';
2701: unless ($fpath eq '') {
2702: my @parts=split('/',$fpath);
2703: foreach my $part (@parts) {
2704: $filepath.= '/'.$part;
2705: if ((-e $filepath)!=1) {
2706: mkdir($filepath,0777);
2707: }
2708: }
2709: }
2710: return $filepath;
2711: }
2712:
2713: sub store_edited_file {
2714: my ($primary_url,$content,$docudom,$docuname,$fetchresult) = @_;
2715: my $file = $primary_url;
2716: $file =~ s#^/uploaded/$docudom/$docuname/##;
2717: my $fpath = '';
2718: my $fname = $file;
2719: ($fpath,$fname) = ($file =~ m|^(.*)/([^/]+)$|);
2720: $fpath=$docudom.'/'.$docuname.'/'.$fpath;
2721: my $filepath = &build_filepath($fpath);
2722: open(my $fh,'>'.$filepath.'/'.$fname);
2723: print $fh $content;
2724: close($fh);
2725: my $home=&homeserver($docuname,$docudom);
2726: $$fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
2727: $home);
2728: if ($$fetchresult eq 'ok') {
2729: return '/uploaded/'.$fpath.'/'.$fname;
2730: } else {
2731: &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$file.
2732: ' to host '.$home.': '.$$fetchresult);
2733: return '/adm/notfound.html';
2734: }
2735: }
2736:
2737: sub clean_filename {
2738: my ($fname,$args)=@_;
2739: # Replace Windows backslashes by forward slashes
2740: $fname=~s/\\/\//g;
2741: if (!$args->{'keep_path'}) {
2742: # Get rid of everything but the actual filename
2743: $fname=~s/^.*\/([^\/]+)$/$1/;
2744: }
2745: # Replace spaces by underscores
2746: $fname=~s/\s+/\_/g;
2747: # Replace all other weird characters by nothing
2748: $fname=~s{[^/\w\.\-]}{}g;
2749: # Replace all .\d. sequences with _\d. so they no longer look like version
2750: # numbers
2751: $fname=~s/\.(\d+)(?=\.)/_$1/g;
2752: return $fname;
2753: }
2754: # This Function checks if an Image's dimensions exceed either $resizewidth (width)
2755: # or $resizeheight (height) - both pixels. If so, the image is scaled to produce an
2756: # image with the same aspect ratio as the original, but with dimensions which do
2757: # not exceed $resizewidth and $resizeheight.
2758:
2759: sub resizeImage {
2760: my ($img_path,$resizewidth,$resizeheight) = @_;
2761: my $ima = Image::Magick->new;
2762: my $resized;
2763: if (-e $img_path) {
2764: $ima->Read($img_path);
2765: if (($resizewidth =~ /^\d+$/) && ($resizeheight > 0)) {
2766: my $width = $ima->Get('width');
2767: my $height = $ima->Get('height');
2768: if ($width > $resizewidth) {
2769: my $factor = $width/$resizewidth;
2770: my $newheight = $height/$factor;
2771: $ima->Scale(width=>$resizewidth,height=>$newheight);
2772: $resized = 1;
2773: }
2774: }
2775: if (($resizeheight =~ /^\d+$/) && ($resizeheight > 0)) {
2776: my $width = $ima->Get('width');
2777: my $height = $ima->Get('height');
2778: if ($height > $resizeheight) {
2779: my $factor = $height/$resizeheight;
2780: my $newwidth = $width/$factor;
2781: $ima->Scale(width=>$newwidth,height=>$resizeheight);
2782: $resized = 1;
2783: }
2784: }
2785: if ($resized) {
2786: $ima->Write($img_path);
2787: }
2788: }
2789: return;
2790: }
2791:
2792: # --------------- Take an uploaded file and put it into the userfiles directory
2793: # input: $formname - the contents of the file are in $env{"form.$formname"}
2794: # the desired filename is in $env{"form.$formname.filename"}
2795: # $context - possible values: coursedoc, existingfile, overwrite,
2796: # canceloverwrite, or ''.
2797: # if 'coursedoc': upload to the current course
2798: # if 'existingfile': write file to tmp/overwrites directory
2799: # if 'canceloverwrite': delete file written to tmp/overwrites directory
2800: # $context is passed as argument to &finishuserfileupload
2801: # $subdir - directory in userfile to store the file into
2802: # $parser - instruction to parse file for objects ($parser = parse)
2803: # $allfiles - reference to hash for embedded objects
2804: # $codebase - reference to hash for codebase of java objects
2805: # $desuname - username for permanent storage of uploaded file
2806: # $dsetudom - domain for permanaent storage of uploaded file
2807: # $thumbwidth - width (pixels) of thumbnail to make for uploaded image
2808: # $thumbheight - height (pixels) of thumbnail to make for uploaded image
2809: # $resizewidth - width (pixels) to which to resize uploaded image
2810: # $resizeheight - height (pixels) to which to resize uploaded image
2811: # $mimetype - reference to scalar to accommodate mime type determined
2812: # from File::MMagic.
2813: #
2814: # output: url of file in userspace, or error: <message>
2815: # or /adm/notfound.html if failure to upload occurse
2816:
2817: sub userfileupload {
2818: my ($formname,$context,$subdir,$parser,$allfiles,$codebase,$destuname,
2819: $destudom,$thumbwidth,$thumbheight,$resizewidth,$resizeheight,$mimetype)=@_;
2820: if (!defined($subdir)) { $subdir='unknown'; }
2821: my $fname=$env{'form.'.$formname.'.filename'};
2822: $fname=&clean_filename($fname);
2823: # See if there is anything left
2824: unless ($fname) { return 'error: no uploaded file'; }
2825: # Files uploaded to help request form, or uploaded to "create course" page are handled differently
2826: if ((($formname eq 'screenshot') && ($subdir eq 'helprequests')) ||
2827: (($formname eq 'coursecreatorxml') && ($subdir eq 'batchupload')) ||
2828: ($context eq 'existingfile') || ($context eq 'canceloverwrite')) {
2829: my $now = time;
2830: my $filepath;
2831: if (($formname eq 'screenshot') && ($subdir eq 'helprequests')) {
2832: $filepath = 'tmp/helprequests/'.$now;
2833: } elsif (($formname eq 'coursecreatorxml') && ($subdir eq 'batchupload')) {
2834: $filepath = 'tmp/addcourse/'.$destudom.'/web/'.$env{'user.name'}.
2835: '_'.$env{'user.domain'}.'/pending';
2836: } elsif (($context eq 'existingfile') || ($context eq 'canceloverwrite')) {
2837: my ($docuname,$docudom);
2838: if ($destudom) {
2839: $docudom = $destudom;
2840: } else {
2841: $docudom = $env{'user.domain'};
2842: }
2843: if ($destuname) {
2844: $docuname = $destuname;
2845: } else {
2846: $docuname = $env{'user.name'};
2847: }
2848: if (exists($env{'form.group'})) {
2849: $docuname=$env{'course.'.$env{'request.course.id'}.'.num'};
2850: $docudom=$env{'course.'.$env{'request.course.id'}.'.domain'};
2851: }
2852: $filepath = 'tmp/overwrites/'.$docudom.'/'.$docuname.'/'.$subdir;
2853: if ($context eq 'canceloverwrite') {
2854: my $tempfile = $perlvar{'lonDaemons'}.'/'.$filepath.'/'.$fname;
2855: if (-e $tempfile) {
2856: my @info = stat($tempfile);
2857: if ($info[9] eq $env{'form.timestamp'}) {
2858: unlink($tempfile);
2859: }
2860: }
2861: return;
2862: }
2863: }
2864: # Create the directory if not present
2865: my @parts=split(/\//,$filepath);
2866: my $fullpath = $perlvar{'lonDaemons'};
2867: for (my $i=0;$i<@parts;$i++) {
2868: $fullpath .= '/'.$parts[$i];
2869: if ((-e $fullpath)!=1) {
2870: mkdir($fullpath,0777);
2871: }
2872: }
2873: open(my $fh,'>'.$fullpath.'/'.$fname);
2874: print $fh $env{'form.'.$formname};
2875: close($fh);
2876: if ($context eq 'existingfile') {
2877: my @info = stat($fullpath.'/'.$fname);
2878: return ($fullpath.'/'.$fname,$info[9]);
2879: } else {
2880: return $fullpath.'/'.$fname;
2881: }
2882: }
2883: if ($subdir eq 'scantron') {
2884: $fname = 'scantron_orig_'.$fname;
2885: } else {
2886: $fname="$subdir/$fname";
2887: }
2888: if ($context eq 'coursedoc') {
2889: my $docuname=$env{'course.'.$env{'request.course.id'}.'.num'};
2890: my $docudom=$env{'course.'.$env{'request.course.id'}.'.domain'};
2891: if ($env{'form.folder'} =~ m/^(default|supplemental)/) {
2892: return &finishuserfileupload($docuname,$docudom,
2893: $formname,$fname,$parser,$allfiles,
2894: $codebase,$thumbwidth,$thumbheight,
2895: $resizewidth,$resizeheight,$context,$mimetype);
2896: } else {
2897: $fname=$env{'form.folder'}.'/'.$fname;
2898: return &process_coursefile('uploaddoc',$docuname,$docudom,
2899: $fname,$formname,$parser,
2900: $allfiles,$codebase,$mimetype);
2901: }
2902: } elsif (defined($destuname)) {
2903: my $docuname=$destuname;
2904: my $docudom=$destudom;
2905: return &finishuserfileupload($docuname,$docudom,$formname,$fname,
2906: $parser,$allfiles,$codebase,
2907: $thumbwidth,$thumbheight,
2908: $resizewidth,$resizeheight,$context,$mimetype);
2909: } else {
2910: my $docuname=$env{'user.name'};
2911: my $docudom=$env{'user.domain'};
2912: if (exists($env{'form.group'})) {
2913: $docuname=$env{'course.'.$env{'request.course.id'}.'.num'};
2914: $docudom=$env{'course.'.$env{'request.course.id'}.'.domain'};
2915: }
2916: return &finishuserfileupload($docuname,$docudom,$formname,$fname,
2917: $parser,$allfiles,$codebase,
2918: $thumbwidth,$thumbheight,
2919: $resizewidth,$resizeheight,$context,$mimetype);
2920: }
2921: }
2922:
2923: sub finishuserfileupload {
2924: my ($docuname,$docudom,$formname,$fname,$parser,$allfiles,$codebase,
2925: $thumbwidth,$thumbheight,$resizewidth,$resizeheight,$context,$mimetype) = @_;
2926: my $path=$docudom.'/'.$docuname.'/';
2927: my $filepath=$perlvar{'lonDocRoot'};
2928:
2929: my ($fnamepath,$file,$fetchthumb);
2930: $file=$fname;
2931: if ($fname=~m|/|) {
2932: ($fnamepath,$file) = ($fname =~ m|^(.*)/([^/]+)$|);
2933: $path.=$fnamepath.'/';
2934: }
2935: my @parts=split(/\//,$filepath.'/userfiles/'.$path);
2936: my $count;
2937: for ($count=4;$count<=$#parts;$count++) {
2938: $filepath.="/$parts[$count]";
2939: if ((-e $filepath)!=1) {
2940: mkdir($filepath,0777);
2941: }
2942: }
2943:
2944: # Save the file
2945: {
2946: if (!open(FH,'>'.$filepath.'/'.$file)) {
2947: &logthis('Failed to create '.$filepath.'/'.$file);
2948: print STDERR ('Failed to create '.$filepath.'/'.$file."\n");
2949: return '/adm/notfound.html';
2950: }
2951: if ($context eq 'overwrite') {
2952: my $source = LONCAPA::tempdir().'/overwrites/'.$docudom.'/'.$docuname.'/'.$fname;
2953: my $target = $filepath.'/'.$file;
2954: if (-e $source) {
2955: my @info = stat($source);
2956: if ($info[9] eq $env{'form.timestamp'}) {
2957: unless (&File::Copy::move($source,$target)) {
2958: &logthis('Failed to overwrite '.$filepath.'/'.$file);
2959: return "Moving from $source failed";
2960: }
2961: } else {
2962: return "Temporary file: $source had unexpected date/time for last modification";
2963: }
2964: } else {
2965: return "Temporary file: $source missing";
2966: }
2967: } elsif (!print FH ($env{'form.'.$formname})) {
2968: &logthis('Failed to write to '.$filepath.'/'.$file);
2969: print STDERR ('Failed to write to '.$filepath.'/'.$file."\n");
2970: return '/adm/notfound.html';
2971: }
2972: close(FH);
2973: if ($resizewidth && $resizeheight) {
2974: my $mm = new File::MMagic;
2975: my $mime_type = $mm->checktype_filename($filepath.'/'.$file);
2976: if ($mime_type =~ m{^image/}) {
2977: &resizeImage($filepath.'/'.$file,$resizewidth,$resizeheight);
2978: }
2979: }
2980: }
2981: if (($context eq 'coursedoc') || ($parser eq 'parse')) {
2982: if (ref($mimetype)) {
2983: if ($$mimetype eq '') {
2984: my $mm = new File::MMagic;
2985: my $type = $mm->checktype_filename($filepath.'/'.$file);
2986: $$mimetype = $type;
2987: }
2988: }
2989: }
2990: if ($parser eq 'parse') {
2991: if ((ref($mimetype)) && ($$mimetype eq 'text/html')) {
2992: my $parse_result = &extract_embedded_items($filepath.'/'.$file,
2993: $allfiles,$codebase);
2994: unless ($parse_result eq 'ok') {
2995: &logthis('Failed to parse '.$filepath.$file.
2996: ' for embedded media: '.$parse_result);
2997: }
2998: }
2999: }
3000: if (($thumbwidth =~ /^\d+$/) && ($thumbheight =~ /^\d+$/)) {
3001: my $input = $filepath.'/'.$file;
3002: my $output = $filepath.'/'.'tn-'.$file;
3003: my $thumbsize = $thumbwidth.'x'.$thumbheight;
3004: system("convert -sample $thumbsize $input $output");
3005: if (-e $filepath.'/'.'tn-'.$file) {
3006: $fetchthumb = 1;
3007: }
3008: }
3009:
3010: # Notify homeserver to grep it
3011: #
3012: my $docuhome=&homeserver($docuname,$docudom);
3013: my $fetchresult= &reply('fetchuserfile:'.$path.$file,$docuhome);
3014: if ($fetchresult eq 'ok') {
3015: if ($fetchthumb) {
3016: my $thumbresult= &reply('fetchuserfile:'.$path.'tn-'.$file,$docuhome);
3017: if ($thumbresult ne 'ok') {
3018: &logthis('Failed to transfer '.$path.'tn-'.$file.' to host '.
3019: $docuhome.': '.$thumbresult);
3020: }
3021: }
3022: #
3023: # Return the URL to it
3024: return '/uploaded/'.$path.$file;
3025: } else {
3026: &logthis('Failed to transfer '.$path.$file.' to host '.$docuhome.
3027: ': '.$fetchresult);
3028: return '/adm/notfound.html';
3029: }
3030: }
3031:
3032: sub extract_embedded_items {
3033: my ($fullpath,$allfiles,$codebase,$content) = @_;
3034: my @state = ();
3035: my %javafiles = (
3036: codebase => '',
3037: code => '',
3038: archive => ''
3039: );
3040: my %mediafiles = (
3041: src => '',
3042: movie => '',
3043: );
3044: my $p;
3045: if ($content) {
3046: $p = HTML::LCParser->new($content);
3047: } else {
3048: $p = HTML::LCParser->new($fullpath);
3049: }
3050: while (my $t=$p->get_token()) {
3051: if ($t->[0] eq 'S') {
3052: my ($tagname, $attr) = ($t->[1],$t->[2]);
3053: push(@state, $tagname);
3054: if (lc($tagname) eq 'allow') {
3055: &add_filetype($allfiles,$attr->{'src'},'src');
3056: }
3057: if (lc($tagname) eq 'img') {
3058: &add_filetype($allfiles,$attr->{'src'},'src');
3059: }
3060: if (lc($tagname) eq 'a') {
3061: &add_filetype($allfiles,$attr->{'href'},'href');
3062: }
3063: if (lc($tagname) eq 'script') {
3064: if ($attr->{'archive'} =~ /\.jar$/i) {
3065: &add_filetype($allfiles,$attr->{'archive'},'archive');
3066: } else {
3067: &add_filetype($allfiles,$attr->{'src'},'src');
3068: }
3069: }
3070: if (lc($tagname) eq 'link') {
3071: if (lc($attr->{'rel'}) eq 'stylesheet') {
3072: &add_filetype($allfiles,$attr->{'href'},'href');
3073: }
3074: }
3075: if (lc($tagname) eq 'object' ||
3076: (lc($tagname) eq 'embed' && lc($state[-2]) ne 'object')) {
3077: foreach my $item (keys(%javafiles)) {
3078: $javafiles{$item} = '';
3079: }
3080: }
3081: if (lc($state[-2]) eq 'object' && lc($tagname) eq 'param') {
3082: my $name = lc($attr->{'name'});
3083: foreach my $item (keys(%javafiles)) {
3084: if ($name eq $item) {
3085: $javafiles{$item} = $attr->{'value'};
3086: last;
3087: }
3088: }
3089: foreach my $item (keys(%mediafiles)) {
3090: if ($name eq $item) {
3091: &add_filetype($allfiles, $attr->{'value'}, 'value');
3092: last;
3093: }
3094: }
3095: }
3096: if (lc($tagname) eq 'embed' || lc($tagname) eq 'applet') {
3097: foreach my $item (keys(%javafiles)) {
3098: if ($attr->{$item}) {
3099: $javafiles{$item} = $attr->{$item};
3100: last;
3101: }
3102: }
3103: foreach my $item (keys(%mediafiles)) {
3104: if ($attr->{$item}) {
3105: &add_filetype($allfiles,$attr->{$item},$item);
3106: last;
3107: }
3108: }
3109: }
3110: } elsif ($t->[0] eq 'E') {
3111: my ($tagname) = ($t->[1]);
3112: if ($javafiles{'codebase'} ne '') {
3113: $javafiles{'codebase'} .= '/';
3114: }
3115: if (lc($tagname) eq 'applet' ||
3116: lc($tagname) eq 'object' ||
3117: (lc($tagname) eq 'embed' && lc($state[-2]) ne 'object')
3118: ) {
3119: foreach my $item (keys(%javafiles)) {
3120: if ($item ne 'codebase' && $javafiles{$item} ne '') {
3121: my $file=$javafiles{'codebase'}.$javafiles{$item};
3122: &add_filetype($allfiles,$file,$item);
3123: }
3124: }
3125: }
3126: pop @state;
3127: }
3128: }
3129: return 'ok';
3130: }
3131:
3132: sub add_filetype {
3133: my ($allfiles,$file,$type)=@_;
3134: if (exists($allfiles->{$file})) {
3135: unless (grep/^\Q$type\E$/, @{$allfiles->{$file}}) {
3136: push(@{$allfiles->{$file}}, &escape($type));
3137: }
3138: } else {
3139: @{$allfiles->{$file}} = (&escape($type));
3140: }
3141: }
3142:
3143: sub removeuploadedurl {
3144: my ($url)=@_;
3145: my (undef,undef,$udom,$uname,$fname)=split('/',$url,5);
3146: return &removeuserfile($uname,$udom,$fname);
3147: }
3148:
3149: sub removeuserfile {
3150: my ($docuname,$docudom,$fname)=@_;
3151: my $home=&homeserver($docuname,$docudom);
3152: my $result = &reply("removeuserfile:$docudom/$docuname/$fname",$home);
3153: if ($result eq 'ok') {
3154: if (($fname !~ /\.meta$/) && (&is_portfolio_file($fname))) {
3155: my $metafile = $fname.'.meta';
3156: my $metaresult = &removeuserfile($docuname,$docudom,$metafile);
3157: my $url = "/uploaded/$docudom/$docuname/$fname";
3158: my ($file,$group) = (&parse_portfolio_url($url))[3,4];
3159: my $sqlresult =
3160: &update_portfolio_table($docuname,$docudom,$file,
3161: 'portfolio_metadata',$group,
3162: 'delete');
3163: }
3164: }
3165: return $result;
3166: }
3167:
3168: sub mkdiruserfile {
3169: my ($docuname,$docudom,$dir)=@_;
3170: my $home=&homeserver($docuname,$docudom);
3171: return &reply("mkdiruserfile:".&escape("$docudom/$docuname/$dir"),$home);
3172: }
3173:
3174: sub renameuserfile {
3175: my ($docuname,$docudom,$old,$new)=@_;
3176: my $home=&homeserver($docuname,$docudom);
3177: my $result = &reply("renameuserfile:$docudom:$docuname:".
3178: &escape("$old").':'.&escape("$new"),$home);
3179: if ($result eq 'ok') {
3180: if (($old !~ /\.meta$/) && (&is_portfolio_file($old))) {
3181: my $oldmeta = $old.'.meta';
3182: my $newmeta = $new.'.meta';
3183: my $metaresult =
3184: &renameuserfile($docuname,$docudom,$oldmeta,$newmeta);
3185: my $url = "/uploaded/$docudom/$docuname/$old";
3186: my ($file,$group) = (&parse_portfolio_url($url))[3,4];
3187: my $sqlresult =
3188: &update_portfolio_table($docuname,$docudom,$file,
3189: 'portfolio_metadata',$group,
3190: 'delete');
3191: }
3192: }
3193: return $result;
3194: }
3195:
3196: # ------------------------------------------------------------------------- Log
3197:
3198: sub log {
3199: my ($dom,$nam,$hom,$what)=@_;
3200: return critical("log:$dom:$nam:$what",$hom);
3201: }
3202:
3203: # ------------------------------------------------------------------ Course Log
3204: #
3205: # This routine flushes several buffers of non-mission-critical nature
3206: #
3207:
3208: sub flushcourselogs {
3209: &logthis('Flushing log buffers');
3210: #
3211: # course logs
3212: # This is a log of all transactions in a course, which can be used
3213: # for data mining purposes
3214: #
3215: # It also collects the courseid database, which lists last transaction
3216: # times and course titles for all courseids
3217: #
3218: my %courseidbuffer=();
3219: foreach my $crsid (keys(%courselogs)) {
3220: if (&reply('log:'.$coursedombuf{$crsid}.':'.$coursenumbuf{$crsid}.':'.
3221: &escape($courselogs{$crsid}),
3222: $coursehombuf{$crsid}) eq 'ok') {
3223: delete $courselogs{$crsid};
3224: } else {
3225: &logthis('Failed to flush log buffer for '.$crsid);
3226: if (length($courselogs{$crsid})>40000) {
3227: &logthis("<font color=\"blue\">WARNING: Buffer for ".$crsid.
3228: " exceeded maximum size, deleting.</font>");
3229: delete $courselogs{$crsid};
3230: }
3231: }
3232: $courseidbuffer{$coursehombuf{$crsid}}{$crsid} = {
3233: 'description' => $coursedescrbuf{$crsid},
3234: 'inst_code' => $courseinstcodebuf{$crsid},
3235: 'type' => $coursetypebuf{$crsid},
3236: 'owner' => $courseownerbuf{$crsid},
3237: };
3238: }
3239: #
3240: # Write course id database (reverse lookup) to homeserver of courses
3241: # Is used in pickcourse
3242: #
3243: foreach my $crs_home (keys(%courseidbuffer)) {
3244: my $response = &courseidput(&host_domain($crs_home),
3245: $courseidbuffer{$crs_home},
3246: $crs_home,'timeonly');
3247: }
3248: #
3249: # File accesses
3250: # Writes to the dynamic metadata of resources to get hit counts, etc.
3251: #
3252: foreach my $entry (keys(%accesshash)) {
3253: if ($entry =~ /___count$/) {
3254: my ($dom,$name);
3255: ($dom,$name,undef)=
3256: ($entry=~m{___($match_domain)/($match_name)/(.*)___count$});
3257: if (! defined($dom) || $dom eq '' ||
3258: ! defined($name) || $name eq '') {
3259: my $cid = $env{'request.course.id'};
3260: $dom = $env{'request.'.$cid.'.domain'};
3261: $name = $env{'request.'.$cid.'.num'};
3262: }
3263: my $value = $accesshash{$entry};
3264: my (undef,$url,undef) = ($entry =~ /^(.*)___(.*)___count$/);
3265: my %temphash=($url => $value);
3266: my $result = &inc('nohist_accesscount',\%temphash,$dom,$name);
3267: if ($result eq 'ok') {
3268: delete $accesshash{$entry};
3269: }
3270: } else {
3271: my ($dom,$name) = ($entry=~m{___($match_domain)/($match_name)/(.*)___(\w+)$});
3272: my %temphash=($entry => $accesshash{$entry});
3273: if (&put('nohist_resevaldata',\%temphash,$dom,$name) eq 'ok') {
3274: delete $accesshash{$entry};
3275: }
3276: }
3277: }
3278: #
3279: # Roles
3280: # Reverse lookup of user roles for course faculty/staff and co-authorship
3281: #
3282: foreach my $entry (keys(%userrolehash)) {
3283: my ($role,$uname,$udom,$runame,$rudom,$rsec)=
3284: split(/\:/,$entry);
3285: if (&Apache::lonnet::put('nohist_userroles',
3286: { $role.':'.$uname.':'.$udom.':'.$rsec => $userrolehash{$entry} },
3287: $rudom,$runame) eq 'ok') {
3288: delete $userrolehash{$entry};
3289: }
3290: }
3291: #
3292: # Reverse lookup of domain roles (dc, ad, li, sc, au)
3293: #
3294: my %domrolebuffer = ();
3295: foreach my $entry (keys(%domainrolehash)) {
3296: my ($role,$uname,$udom,$runame,$rudom,$rsec)=split(/:/,$entry);
3297: if ($domrolebuffer{$rudom}) {
3298: $domrolebuffer{$rudom}.='&'.&escape($entry).
3299: '='.&escape($domainrolehash{$entry});
3300: } else {
3301: $domrolebuffer{$rudom}.=&escape($entry).
3302: '='.&escape($domainrolehash{$entry});
3303: }
3304: delete $domainrolehash{$entry};
3305: }
3306: foreach my $dom (keys(%domrolebuffer)) {
3307: my %servers = &get_servers($dom,'library');
3308: foreach my $tryserver (keys(%servers)) {
3309: unless (&reply('domroleput:'.$dom.':'.
3310: $domrolebuffer{$dom},$tryserver) eq 'ok') {
3311: &logthis('Put of domain roles failed for '.$dom.' and '.$tryserver);
3312: }
3313: }
3314: }
3315: $dumpcount++;
3316: }
3317:
3318: sub courselog {
3319: my $what=shift;
3320: $what=time.':'.$what;
3321: unless ($env{'request.course.id'}) { return ''; }
3322: $coursedombuf{$env{'request.course.id'}}=
3323: $env{'course.'.$env{'request.course.id'}.'.domain'};
3324: $coursenumbuf{$env{'request.course.id'}}=
3325: $env{'course.'.$env{'request.course.id'}.'.num'};
3326: $coursehombuf{$env{'request.course.id'}}=
3327: $env{'course.'.$env{'request.course.id'}.'.home'};
3328: $coursedescrbuf{$env{'request.course.id'}}=
3329: $env{'course.'.$env{'request.course.id'}.'.description'};
3330: $courseinstcodebuf{$env{'request.course.id'}}=
3331: $env{'course.'.$env{'request.course.id'}.'.internal.coursecode'};
3332: $courseownerbuf{$env{'request.course.id'}}=
3333: $env{'course.'.$env{'request.course.id'}.'.internal.courseowner'};
3334: $coursetypebuf{$env{'request.course.id'}}=
3335: $env{'course.'.$env{'request.course.id'}.'.type'};
3336: if (defined $courselogs{$env{'request.course.id'}}) {
3337: $courselogs{$env{'request.course.id'}}.='&'.$what;
3338: } else {
3339: $courselogs{$env{'request.course.id'}}.=$what;
3340: }
3341: if (length($courselogs{$env{'request.course.id'}})>4048) {
3342: &flushcourselogs();
3343: }
3344: }
3345:
3346: sub courseacclog {
3347: my $fnsymb=shift;
3348: unless ($env{'request.course.id'}) { return ''; }
3349: my $what=$fnsymb.':'.$env{'user.name'}.':'.$env{'user.domain'};
3350: if ($fnsymb=~/$LONCAPA::assess_re/) {
3351: $what.=':POST';
3352: # FIXME: Probably ought to escape things....
3353: foreach my $key (keys(%env)) {
3354: if ($key=~/^form\.(.*)/) {
3355: my $formitem = $1;
3356: if ($formitem =~ /^HWFILE(?:SIZE|TOOBIG)/) {
3357: $what.=':'.$formitem.'='.$env{$key};
3358: } elsif ($formitem !~ /^HWFILE(?:[^.]+)$/) {
3359: $what.=':'.$formitem.'='.$env{$key};
3360: }
3361: }
3362: }
3363: } elsif ($fnsymb =~ m:^/adm/searchcat:) {
3364: # FIXME: We should not be depending on a form parameter that someone
3365: # editing lonsearchcat.pm might change in the future.
3366: if ($env{'form.phase'} eq 'course_search') {
3367: $what.= ':POST';
3368: # FIXME: Probably ought to escape things....
3369: foreach my $element ('courseexp','crsfulltext','crsrelated',
3370: 'crsdiscuss') {
3371: $what.=':'.$element.'='.$env{'form.'.$element};
3372: }
3373: }
3374: }
3375: &courselog($what);
3376: }
3377:
3378: sub countacc {
3379: my $url=&declutter(shift);
3380: return if (! defined($url) || $url eq '');
3381: unless ($env{'request.course.id'}) { return ''; }
3382: $accesshash{$env{'request.course.id'}.'___'.$url.'___course'}=1;
3383: my $key=$$.$processmarker.'_'.$dumpcount.'___'.$url.'___count';
3384: $accesshash{$key}++;
3385: }
3386:
3387: sub linklog {
3388: my ($from,$to)=@_;
3389: $from=&declutter($from);
3390: $to=&declutter($to);
3391: $accesshash{$from.'___'.$to.'___comefrom'}=1;
3392: $accesshash{$to.'___'.$from.'___goto'}=1;
3393: }
3394:
3395: sub userrolelog {
3396: my ($trole,$username,$domain,$area,$tstart,$tend)=@_;
3397: if (($trole=~/^ca/) || ($trole=~/^aa/) ||
3398: ($trole=~/^in/) || ($trole=~/^cc/) ||
3399: ($trole=~/^ep/) || ($trole=~/^cr/) ||
3400: ($trole=~/^ta/) || ($trole=~/^co/)) {
3401: my (undef,$rudom,$runame,$rsec)=split(/\//,$area);
3402: $userrolehash
3403: {$trole.':'.$username.':'.$domain.':'.$runame.':'.$rudom.':'.$rsec}
3404: =$tend.':'.$tstart;
3405: }
3406: if (($env{'request.role'} =~ /dc\./) &&
3407: (($trole=~/^au/) || ($trole=~/^in/) ||
3408: ($trole=~/^cc/) || ($trole=~/^ep/) ||
3409: ($trole=~/^cr/) || ($trole=~/^ta/) ||
3410: ($trole=~/^co/))) {
3411: $userrolehash
3412: {$trole.':'.$username.':'.$domain.':'.$env{'user.name'}.':'.$env{'user.domain'}.':'}
3413: =$tend.':'.$tstart;
3414: }
3415: if (($trole=~/^dc/) || ($trole=~/^ad/) ||
3416: ($trole=~/^li/) || ($trole=~/^li/) ||
3417: ($trole=~/^au/) || ($trole=~/^dg/) ||
3418: ($trole=~/^sc/)) {
3419: my (undef,$rudom,$runame,$rsec)=split(/\//,$area);
3420: $domainrolehash
3421: {$trole.':'.$username.':'.$domain.':'.$runame.':'.$rudom.':'.$rsec}
3422: = $tend.':'.$tstart;
3423: }
3424: }
3425:
3426: sub courserolelog {
3427: my ($trole,$username,$domain,$area,$tstart,$tend,$delflag,$selfenroll,$context)=@_;
3428: if (($trole eq 'cc') || ($trole eq 'in') ||
3429: ($trole eq 'ep') || ($trole eq 'ad') ||
3430: ($trole eq 'ta') || ($trole eq 'st') ||
3431: ($trole=~/^cr/) || ($trole eq 'gr') ||
3432: ($trole eq 'co')) {
3433: if ($area =~ m-^/($match_domain)/($match_courseid)/?([^/]*)-) {
3434: my $cdom = $1;
3435: my $cnum = $2;
3436: my $sec = $3;
3437: my $namespace = 'rolelog';
3438: my %storehash = (
3439: role => $trole,
3440: start => $tstart,
3441: end => $tend,
3442: selfenroll => $selfenroll,
3443: context => $context,
3444: );
3445: if ($trole eq 'gr') {
3446: $namespace = 'groupslog';
3447: $storehash{'group'} = $sec;
3448: } else {
3449: $storehash{'section'} = $sec;
3450: }
3451: &instructor_log($namespace,\%storehash,$delflag,$username,$domain,$cnum,$cdom);
3452: if (($trole ne 'st') || ($sec ne '')) {
3453: &devalidate_cache_new('getcourseroles',$cdom.'_'.$cnum);
3454: }
3455: }
3456: }
3457: return;
3458: }
3459:
3460: sub get_course_adv_roles {
3461: my ($cid,$codes) = @_;
3462: $cid=$env{'request.course.id'} unless (defined($cid));
3463: my %coursehash=&coursedescription($cid);
3464: my $crstype = &Apache::loncommon::course_type($cid);
3465: my %nothide=();
3466: foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
3467: if ($user !~ /:/) {
3468: $nothide{join(':',split(/[\@]/,$user))}=1;
3469: } else {
3470: $nothide{$user}=1;
3471: }
3472: }
3473: my %returnhash=();
3474: my %dumphash=
3475: &dump('nohist_userroles',$coursehash{'domain'},$coursehash{'num'});
3476: my $now=time;
3477: my %privileged;
3478: foreach my $entry (keys(%dumphash)) {
3479: my ($tend,$tstart)=split(/\:/,$dumphash{$entry});
3480: if (($tstart) && ($tstart<0)) { next; }
3481: if (($tend) && ($tend<$now)) { next; }
3482: if (($tstart) && ($now<$tstart)) { next; }
3483: my ($role,$username,$domain,$section)=split(/\:/,$entry);
3484: if ($username eq '' || $domain eq '') { next; }
3485: unless (ref($privileged{$domain}) eq 'HASH') {
3486: my %dompersonnel =
3487: &Apache::lonnet::get_domain_roles($domain,['dc'],$now,$now);
3488: $privileged{$domain} = {};
3489: foreach my $server (keys(%dompersonnel)) {
3490: if (ref($dompersonnel{$server}) eq 'HASH') {
3491: foreach my $user (keys(%{$dompersonnel{$server}})) {
3492: my ($trole,$uname,$udom) = split(/:/,$user);
3493: $privileged{$udom}{$uname} = 1;
3494: }
3495: }
3496: }
3497: }
3498: if ((exists($privileged{$domain}{$username})) &&
3499: (!$nothide{$username.':'.$domain})) { next; }
3500: if ($role eq 'cr') { next; }
3501: if ($codes) {
3502: if ($section) { $role .= ':'.$section; }
3503: if ($returnhash{$role}) {
3504: $returnhash{$role}.=','.$username.':'.$domain;
3505: } else {
3506: $returnhash{$role}=$username.':'.$domain;
3507: }
3508: } else {
3509: my $key=&plaintext($role,$crstype);
3510: if ($section) { $key.=' ('.&Apache::lonlocal::mt('Section [_1]',$section).')'; }
3511: if ($returnhash{$key}) {
3512: $returnhash{$key}.=','.$username.':'.$domain;
3513: } else {
3514: $returnhash{$key}=$username.':'.$domain;
3515: }
3516: }
3517: }
3518: return %returnhash;
3519: }
3520:
3521: sub get_my_roles {
3522: my ($uname,$udom,$context,$types,$roles,$roledoms,$withsec,$hidepriv)=@_;
3523: unless (defined($uname)) { $uname=$env{'user.name'}; }
3524: unless (defined($udom)) { $udom=$env{'user.domain'}; }
3525: my (%dumphash,%nothide);
3526: if ($context eq 'userroles') {
3527: my $extra = &freeze_escape({'skipcheck' => 1});
3528: %dumphash = &dump('roles',$udom,$uname,'.',undef,$extra);
3529: } else {
3530: %dumphash=
3531: &dump('nohist_userroles',$udom,$uname);
3532: if ($hidepriv) {
3533: my %coursehash=&coursedescription($udom.'_'.$uname);
3534: foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
3535: if ($user !~ /:/) {
3536: $nothide{join(':',split(/[\@]/,$user))} = 1;
3537: } else {
3538: $nothide{$user} = 1;
3539: }
3540: }
3541: }
3542: }
3543: my %returnhash=();
3544: my $now=time;
3545: my %privileged;
3546: foreach my $entry (keys(%dumphash)) {
3547: my ($role,$tend,$tstart);
3548: if ($context eq 'userroles') {
3549: next if ($entry =~ /^rolesdef/);
3550: ($role,$tend,$tstart)=split(/_/,$dumphash{$entry});
3551: } else {
3552: ($tend,$tstart)=split(/\:/,$dumphash{$entry});
3553: }
3554: if (($tstart) && ($tstart<0)) { next; }
3555: my $status = 'active';
3556: if (($tend) && ($tend<=$now)) {
3557: $status = 'previous';
3558: }
3559: if (($tstart) && ($now<$tstart)) {
3560: $status = 'future';
3561: }
3562: if (ref($types) eq 'ARRAY') {
3563: if (!grep(/^\Q$status\E$/,@{$types})) {
3564: next;
3565: }
3566: } else {
3567: if ($status ne 'active') {
3568: next;
3569: }
3570: }
3571: my ($rolecode,$username,$domain,$section,$area);
3572: if ($context eq 'userroles') {
3573: ($area,$rolecode) = split(/_/,$entry);
3574: (undef,$domain,$username,$section) = split(/\//,$area);
3575: } else {
3576: ($role,$username,$domain,$section) = split(/\:/,$entry);
3577: }
3578: if (ref($roledoms) eq 'ARRAY') {
3579: if (!grep(/^\Q$domain\E$/,@{$roledoms})) {
3580: next;
3581: }
3582: }
3583: if (ref($roles) eq 'ARRAY') {
3584: if (!grep(/^\Q$role\E$/,@{$roles})) {
3585: if ($role =~ /^cr\//) {
3586: if (!grep(/^cr$/,@{$roles})) {
3587: next;
3588: }
3589: } elsif ($role =~ /^gr\//) {
3590: if (!grep(/^gr$/,@{$roles})) {
3591: next;
3592: }
3593: } else {
3594: next;
3595: }
3596: }
3597: }
3598: if ($hidepriv) {
3599: if ($context eq 'userroles') {
3600: if ((&privileged($username,$domain)) &&
3601: (!$nothide{$username.':'.$domain})) {
3602: next;
3603: }
3604: } else {
3605: unless (ref($privileged{$domain}) eq 'HASH') {
3606: my %dompersonnel =
3607: &Apache::lonnet::get_domain_roles($domain,['dc'],$now,$now);
3608: $privileged{$domain} = {};
3609: if (keys(%dompersonnel)) {
3610: foreach my $server (keys(%dompersonnel)) {
3611: if (ref($dompersonnel{$server}) eq 'HASH') {
3612: foreach my $user (keys(%{$dompersonnel{$server}})) {
3613: my ($trole,$uname,$udom) = split(/:/,$user);
3614: $privileged{$udom}{$uname} = $trole;
3615: }
3616: }
3617: }
3618: }
3619: }
3620: if (exists($privileged{$domain}{$username})) {
3621: if (!$nothide{$username.':'.$domain}) {
3622: next;
3623: }
3624: }
3625: }
3626: }
3627: if ($withsec) {
3628: $returnhash{$username.':'.$domain.':'.$role.':'.$section} =
3629: $tstart.':'.$tend;
3630: } else {
3631: $returnhash{$username.':'.$domain.':'.$role}=$tstart.':'.$tend;
3632: }
3633: }
3634: return %returnhash;
3635: }
3636:
3637: # ----------------------------------------------------- Frontpage Announcements
3638: #
3639: #
3640:
3641: sub postannounce {
3642: my ($server,$text)=@_;
3643: unless (&allowed('psa',&host_domain($server))) { return 'refused'; }
3644: unless ($text=~/\w/) { $text=''; }
3645: return &reply('setannounce:'.&escape($text),$server);
3646: }
3647:
3648: sub getannounce {
3649:
3650: if (open(my $fh,$perlvar{'lonDocRoot'}.'/announcement.txt')) {
3651: my $announcement='';
3652: while (my $line = <$fh>) { $announcement .= $line; }
3653: close($fh);
3654: if ($announcement=~/\w/) {
3655: return
3656: '<table bgcolor="#FF5555" cellpadding="5" cellspacing="3">'.
3657: '<tr><td bgcolor="#FFFFFF"><tt>'.$announcement.'</tt></td></tr></table>';
3658: } else {
3659: return '';
3660: }
3661: } else {
3662: return '';
3663: }
3664: }
3665:
3666: # ---------------------------------------------------------- Course ID routines
3667: # Deal with domain's nohist_courseid.db files
3668: #
3669:
3670: sub courseidput {
3671: my ($domain,$storehash,$coursehome,$caller) = @_;
3672: return unless (ref($storehash) eq 'HASH');
3673: my $outcome;
3674: if ($caller eq 'timeonly') {
3675: my $cids = '';
3676: foreach my $item (keys(%$storehash)) {
3677: $cids.=&escape($item).'&';
3678: }
3679: $cids=~s/\&$//;
3680: $outcome = &reply('courseidputhash:'.$domain.':'.$caller.':'.$cids,
3681: $coursehome);
3682: } else {
3683: my $items = '';
3684: foreach my $item (keys(%$storehash)) {
3685: $items.= &escape($item).'='.
3686: &freeze_escape($$storehash{$item}).'&';
3687: }
3688: $items=~s/\&$//;
3689: $outcome = &reply('courseidputhash:'.$domain.':'.$caller.':'.$items,
3690: $coursehome);
3691: }
3692: if ($outcome eq 'unknown_cmd') {
3693: my $what;
3694: foreach my $cid (keys(%$storehash)) {
3695: $what .= &escape($cid).'=';
3696: foreach my $item ('description','inst_code','owner','type') {
3697: $what .= &escape($storehash->{$cid}{$item}).':';
3698: }
3699: $what =~ s/\:$/&/;
3700: }
3701: $what =~ s/\&$//;
3702: return &reply('courseidput:'.$domain.':'.$what,$coursehome);
3703: } else {
3704: return $outcome;
3705: }
3706: }
3707:
3708: sub courseiddump {
3709: my ($domfilter,$descfilter,$sincefilter,$instcodefilter,$ownerfilter,
3710: $coursefilter,$hostidflag,$hostidref,$typefilter,$regexp_ok,
3711: $selfenrollonly,$catfilter,$showhidden,$caller,$cloner,$cc_clone,
3712: $cloneonly,$createdbefore,$createdafter,$creationcontext,$domcloner)=@_;
3713: my $as_hash = 1;
3714: my %returnhash;
3715: if (!$domfilter) { $domfilter=''; }
3716: my %libserv = &all_library();
3717: foreach my $tryserver (keys(%libserv)) {
3718: if ( ( $hostidflag == 1
3719: && grep(/^\Q$tryserver\E$/,@{$hostidref}) )
3720: || (!defined($hostidflag)) ) {
3721:
3722: if (($domfilter eq '') ||
3723: (&host_domain($tryserver) eq $domfilter)) {
3724: my $rep =
3725: &reply('courseiddump:'.&host_domain($tryserver).':'.
3726: $sincefilter.':'.&escape($descfilter).':'.
3727: &escape($instcodefilter).':'.&escape($ownerfilter).
3728: ':'.&escape($coursefilter).':'.&escape($typefilter).
3729: ':'.&escape($regexp_ok).':'.$as_hash.':'.
3730: &escape($selfenrollonly).':'.&escape($catfilter).':'.
3731: $showhidden.':'.$caller.':'.&escape($cloner).':'.
3732: &escape($cc_clone).':'.$cloneonly.':'.
3733: &escape($createdbefore).':'.&escape($createdafter).':'.
3734: &escape($creationcontext).':'.$domcloner,
3735: $tryserver);
3736: my @pairs=split(/\&/,$rep);
3737: foreach my $item (@pairs) {
3738: my ($key,$value)=split(/\=/,$item,2);
3739: $key = &unescape($key);
3740: next if ($key =~ /^error: 2 /);
3741: my $result = &thaw_unescape($value);
3742: if (ref($result) eq 'HASH') {
3743: $returnhash{$key}=$result;
3744: } else {
3745: my @responses = split(/:/,$value);
3746: my @items = ('description','inst_code','owner','type');
3747: for (my $i=0; $i<@responses; $i++) {
3748: $returnhash{$key}{$items[$i]} = &unescape($responses[$i]);
3749: }
3750: }
3751: }
3752: }
3753: }
3754: }
3755: return %returnhash;
3756: }
3757:
3758: sub courselastaccess {
3759: my ($cdom,$cnum,$hostidref) = @_;
3760: my %returnhash;
3761: if ($cdom && $cnum) {
3762: my $chome = &homeserver($cnum,$cdom);
3763: if ($chome ne 'no_host') {
3764: my $rep = &reply('courselastaccess:'.$cdom.':'.$cnum,$chome);
3765: &extract_lastaccess(\%returnhash,$rep);
3766: }
3767: } else {
3768: if (!$cdom) { $cdom=''; }
3769: my %libserv = &all_library();
3770: foreach my $tryserver (keys(%libserv)) {
3771: if (ref($hostidref) eq 'ARRAY') {
3772: next unless (grep(/^\Q$tryserver\E$/,@{$hostidref}));
3773: }
3774: if (($cdom eq '') || (&host_domain($tryserver) eq $cdom)) {
3775: my $rep = &reply('courselastaccess:'.&host_domain($tryserver).':',$tryserver);
3776: &extract_lastaccess(\%returnhash,$rep);
3777: }
3778: }
3779: }
3780: return %returnhash;
3781: }
3782:
3783: sub extract_lastaccess {
3784: my ($returnhash,$rep) = @_;
3785: if (ref($returnhash) eq 'HASH') {
3786: unless ($rep eq 'unknown_command' || $rep eq 'no_such_host' ||
3787: $rep eq 'con_lost' || $rep eq 'rejected' || $rep eq 'refused' ||
3788: $rep eq '') {
3789: my @pairs=split(/\&/,$rep);
3790: foreach my $item (@pairs) {
3791: my ($key,$value)=split(/\=/,$item,2);
3792: $key = &unescape($key);
3793: next if ($key =~ /^error: 2 /);
3794: $returnhash->{$key} = &thaw_unescape($value);
3795: }
3796: }
3797: }
3798: return;
3799: }
3800:
3801: # ---------------------------------------------------------- DC e-mail
3802:
3803: sub dcmailput {
3804: my ($domain,$msgid,$message,$server)=@_;
3805: my $status = &Apache::lonnet::critical(
3806: 'dcmailput:'.$domain.':'.&escape($msgid).'='.
3807: &escape($message),$server);
3808: return $status;
3809: }
3810:
3811: sub dcmaildump {
3812: my ($dom,$startdate,$enddate,$senders) = @_;
3813: my %returnhash=();
3814:
3815: if (defined(&domain($dom,'primary'))) {
3816: my $cmd='dcmaildump:'.$dom.':'.&escape($startdate).':'.
3817: &escape($enddate).':';
3818: my @esc_senders=map { &escape($_)} @$senders;
3819: $cmd.=&escape(join('&',@esc_senders));
3820: foreach my $line (split(/\&/,&reply($cmd,&domain($dom,'primary')))) {
3821: my ($key,$value) = split(/\=/,$line,2);
3822: if (($key) && ($value)) {
3823: $returnhash{&unescape($key)} = &unescape($value);
3824: }
3825: }
3826: }
3827: return %returnhash;
3828: }
3829: # ---------------------------------------------------------- Domain roles
3830:
3831: sub get_domain_roles {
3832: my ($dom,$roles,$startdate,$enddate)=@_;
3833: if ((!defined($startdate)) || ($startdate eq '')) {
3834: $startdate = '.';
3835: }
3836: if ((!defined($enddate)) || ($enddate eq '')) {
3837: $enddate = '.';
3838: }
3839: my $rolelist;
3840: if (ref($roles) eq 'ARRAY') {
3841: $rolelist = join(':',@{$roles});
3842: }
3843: my %personnel = ();
3844:
3845: my %servers = &get_servers($dom,'library');
3846: foreach my $tryserver (keys(%servers)) {
3847: %{$personnel{$tryserver}}=();
3848: foreach my $line (split(/\&/,&reply('domrolesdump:'.$dom.':'.
3849: &escape($startdate).':'.
3850: &escape($enddate).':'.
3851: &escape($rolelist), $tryserver))) {
3852: my ($key,$value) = split(/\=/,$line,2);
3853: if (($key) && ($value)) {
3854: $personnel{$tryserver}{&unescape($key)} = &unescape($value);
3855: }
3856: }
3857: }
3858: return %personnel;
3859: }
3860:
3861: # ----------------------------------------------------------- Interval timing
3862:
3863: {
3864: # Caches needed for speedup of navmaps
3865: # We don't want to cache this for very long at all (5 seconds at most)
3866: #
3867: # The user for whom we cache
3868: my $cachedkey='';
3869: # The cached times for this user
3870: my %cachedtimes=();
3871: # When this was last done
3872: my $cachedtime=();
3873:
3874: sub load_all_first_access {
3875: my ($uname,$udom)=@_;
3876: if (($cachedkey eq $uname.':'.$udom) &&
3877: (abs($cachedtime-time)<5)) {
3878: return;
3879: }
3880: $cachedtime=time;
3881: $cachedkey=$uname.':'.$udom;
3882: %cachedtimes=&dump('firstaccesstimes',$udom,$uname);
3883: }
3884:
3885: sub get_first_access {
3886: my ($type,$argsymb)=@_;
3887: my ($symb,$courseid,$udom,$uname)=&whichuser();
3888: if ($argsymb) { $symb=$argsymb; }
3889: my ($map,$id,$res)=&decode_symb($symb);
3890: if ($type eq 'course') {
3891: $res='course';
3892: } elsif ($type eq 'map') {
3893: $res=&symbread($map);
3894: } else {
3895: $res=$symb;
3896: }
3897: &load_all_first_access($uname,$udom);
3898: return $cachedtimes{"$courseid\0$res"};
3899: }
3900:
3901: sub set_first_access {
3902: my ($type)=@_;
3903: my ($symb,$courseid,$udom,$uname)=&whichuser();
3904: my ($map,$id,$res)=&decode_symb($symb);
3905: if ($type eq 'course') {
3906: $res='course';
3907: } elsif ($type eq 'map') {
3908: $res=&symbread($map);
3909: } else {
3910: $res=$symb;
3911: }
3912: $cachedkey='';
3913: my $firstaccess=&get_first_access($type,$symb);
3914: if (!$firstaccess) {
3915: return &put('firstaccesstimes',{"$courseid\0$res"=>time},$udom,$uname);
3916: }
3917: return 'already_set';
3918: }
3919: }
3920: # --------------------------------------------- Set Expire Date for Spreadsheet
3921:
3922: sub expirespread {
3923: my ($uname,$udom,$stype,$usymb)=@_;
3924: my $cid=$env{'request.course.id'};
3925: if ($cid) {
3926: my $now=time;
3927: my $key=$uname.':'.$udom.':'.$stype.':'.$usymb;
3928: return &reply('put:'.$env{'course.'.$cid.'.domain'}.':'.
3929: $env{'course.'.$cid.'.num'}.
3930: ':nohist_expirationdates:'.
3931: &escape($key).'='.$now,
3932: $env{'course.'.$cid.'.home'})
3933: }
3934: return 'ok';
3935: }
3936:
3937: # ----------------------------------------------------- Devalidate Spreadsheets
3938:
3939: sub devalidate {
3940: my ($symb,$uname,$udom)=@_;
3941: my $cid=$env{'request.course.id'};
3942: if ($cid) {
3943: # delete the stored spreadsheets for
3944: # - the student level sheet of this user in course's homespace
3945: # - the assessment level sheet for this resource
3946: # for this user in user's homespace
3947: # - current conditional state info
3948: my $key=$uname.':'.$udom.':';
3949: my $status=
3950: &del('nohist_calculatedsheets',
3951: [$key.'studentcalc:'],
3952: $env{'course.'.$cid.'.domain'},
3953: $env{'course.'.$cid.'.num'})
3954: .' '.
3955: &del('nohist_calculatedsheets_'.$cid,
3956: [$key.'assesscalc:'.$symb],$udom,$uname);
3957: unless ($status eq 'ok ok') {
3958: &logthis('Could not devalidate spreadsheet '.
3959: $uname.' at '.$udom.' for '.
3960: $symb.': '.$status);
3961: }
3962: &delenv('user.state.'.$cid);
3963: }
3964: }
3965:
3966: sub get_scalar {
3967: my ($string,$end) = @_;
3968: my $value;
3969: if ($$string =~ s/^([^&]*?)($end)/$2/) {
3970: $value = $1;
3971: } elsif ($$string =~ s/^([^&]*?)&//) {
3972: $value = $1;
3973: }
3974: return &unescape($value);
3975: }
3976:
3977: sub array2str {
3978: my (@array) = @_;
3979: my $result=&arrayref2str(\@array);
3980: $result=~s/^__ARRAY_REF__//;
3981: $result=~s/__END_ARRAY_REF__$//;
3982: return $result;
3983: }
3984:
3985: sub arrayref2str {
3986: my ($arrayref) = @_;
3987: my $result='__ARRAY_REF__';
3988: foreach my $elem (@$arrayref) {
3989: if(ref($elem) eq 'ARRAY') {
3990: $result.=&arrayref2str($elem).'&';
3991: } elsif(ref($elem) eq 'HASH') {
3992: $result.=&hashref2str($elem).'&';
3993: } elsif(ref($elem)) {
3994: #print("Got a ref of ".(ref($elem))." skipping.");
3995: } else {
3996: $result.=&escape($elem).'&';
3997: }
3998: }
3999: $result=~s/\&$//;
4000: $result .= '__END_ARRAY_REF__';
4001: return $result;
4002: }
4003:
4004: sub hash2str {
4005: my (%hash) = @_;
4006: my $result=&hashref2str(\%hash);
4007: $result=~s/^__HASH_REF__//;
4008: $result=~s/__END_HASH_REF__$//;
4009: return $result;
4010: }
4011:
4012: sub hashref2str {
4013: my ($hashref)=@_;
4014: my $result='__HASH_REF__';
4015: foreach my $key (sort(keys(%$hashref))) {
4016: if (ref($key) eq 'ARRAY') {
4017: $result.=&arrayref2str($key).'=';
4018: } elsif (ref($key) eq 'HASH') {
4019: $result.=&hashref2str($key).'=';
4020: } elsif (ref($key)) {
4021: $result.='=';
4022: #print("Got a ref of ".(ref($key))." skipping.");
4023: } else {
4024: if (defined($key)) {$result.=&escape($key).'=';} else { last; }
4025: }
4026:
4027: if(ref($hashref->{$key}) eq 'ARRAY') {
4028: $result.=&arrayref2str($hashref->{$key}).'&';
4029: } elsif(ref($hashref->{$key}) eq 'HASH') {
4030: $result.=&hashref2str($hashref->{$key}).'&';
4031: } elsif(ref($hashref->{$key})) {
4032: $result.='&';
4033: #print("Got a ref of ".(ref($hashref->{$key}))." skipping.");
4034: } else {
4035: $result.=&escape($hashref->{$key}).'&';
4036: }
4037: }
4038: $result=~s/\&$//;
4039: $result .= '__END_HASH_REF__';
4040: return $result;
4041: }
4042:
4043: sub str2hash {
4044: my ($string)=@_;
4045: my ($hash)=&str2hashref('__HASH_REF__'.$string.'__END_HASH_REF__');
4046: return %$hash;
4047: }
4048:
4049: sub str2hashref {
4050: my ($string) = @_;
4051:
4052: my %hash;
4053:
4054: if($string !~ /^__HASH_REF__/) {
4055: if (! ($string eq '' || !defined($string))) {
4056: $hash{'error'}='Not hash reference';
4057: }
4058: return (\%hash, $string);
4059: }
4060:
4061: $string =~ s/^__HASH_REF__//;
4062:
4063: while($string !~ /^__END_HASH_REF__/) {
4064: #key
4065: my $key='';
4066: if($string =~ /^__HASH_REF__/) {
4067: ($key, $string)=&str2hashref($string);
4068: if(defined($key->{'error'})) {
4069: $hash{'error'}='Bad data';
4070: return (\%hash, $string);
4071: }
4072: } elsif($string =~ /^__ARRAY_REF__/) {
4073: ($key, $string)=&str2arrayref($string);
4074: if($key->[0] eq 'Array reference error') {
4075: $hash{'error'}='Bad data';
4076: return (\%hash, $string);
4077: }
4078: } else {
4079: $string =~ s/^(.*?)=//;
4080: $key=&unescape($1);
4081: }
4082: $string =~ s/^=//;
4083:
4084: #value
4085: my $value='';
4086: if($string =~ /^__HASH_REF__/) {
4087: ($value, $string)=&str2hashref($string);
4088: if(defined($value->{'error'})) {
4089: $hash{'error'}='Bad data';
4090: return (\%hash, $string);
4091: }
4092: } elsif($string =~ /^__ARRAY_REF__/) {
4093: ($value, $string)=&str2arrayref($string);
4094: if($value->[0] eq 'Array reference error') {
4095: $hash{'error'}='Bad data';
4096: return (\%hash, $string);
4097: }
4098: } else {
4099: $value=&get_scalar(\$string,'__END_HASH_REF__');
4100: }
4101: $string =~ s/^&//;
4102:
4103: $hash{$key}=$value;
4104: }
4105:
4106: $string =~ s/^__END_HASH_REF__//;
4107:
4108: return (\%hash, $string);
4109: }
4110:
4111: sub str2array {
4112: my ($string)=@_;
4113: my ($array)=&str2arrayref('__ARRAY_REF__'.$string.'__END_ARRAY_REF__');
4114: return @$array;
4115: }
4116:
4117: sub str2arrayref {
4118: my ($string) = @_;
4119: my @array;
4120:
4121: if($string !~ /^__ARRAY_REF__/) {
4122: if (! ($string eq '' || !defined($string))) {
4123: $array[0]='Array reference error';
4124: }
4125: return (\@array, $string);
4126: }
4127:
4128: $string =~ s/^__ARRAY_REF__//;
4129:
4130: while($string !~ /^__END_ARRAY_REF__/) {
4131: my $value='';
4132: if($string =~ /^__HASH_REF__/) {
4133: ($value, $string)=&str2hashref($string);
4134: if(defined($value->{'error'})) {
4135: $array[0] ='Array reference error';
4136: return (\@array, $string);
4137: }
4138: } elsif($string =~ /^__ARRAY_REF__/) {
4139: ($value, $string)=&str2arrayref($string);
4140: if($value->[0] eq 'Array reference error') {
4141: $array[0] ='Array reference error';
4142: return (\@array, $string);
4143: }
4144: } else {
4145: $value=&get_scalar(\$string,'__END_ARRAY_REF__');
4146: }
4147: $string =~ s/^&//;
4148:
4149: push(@array, $value);
4150: }
4151:
4152: $string =~ s/^__END_ARRAY_REF__//;
4153:
4154: return (\@array, $string);
4155: }
4156:
4157: # -------------------------------------------------------------------Temp Store
4158:
4159: sub tmpreset {
4160: my ($symb,$namespace,$domain,$stuname) = @_;
4161: if (!$symb) {
4162: $symb=&symbread();
4163: if (!$symb) { $symb= $env{'request.url'}; }
4164: }
4165: $symb=escape($symb);
4166:
4167: if (!$namespace) { $namespace=$env{'request.state'}; }
4168: $namespace=~s/\//\_/g;
4169: $namespace=~s/\W//g;
4170:
4171: if (!$domain) { $domain=$env{'user.domain'}; }
4172: if (!$stuname) { $stuname=$env{'user.name'}; }
4173: if ($domain eq 'public' && $stuname eq 'public') {
4174: $stuname=$ENV{'REMOTE_ADDR'};
4175: }
4176: my $path=LONCAPA::tempdir();
4177: my %hash;
4178: if (tie(%hash,'GDBM_File',
4179: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
4180: &GDBM_WRCREAT(),0640)) {
4181: foreach my $key (keys(%hash)) {
4182: if ($key=~ /:$symb/) {
4183: delete($hash{$key});
4184: }
4185: }
4186: }
4187: }
4188:
4189: sub tmpstore {
4190: my ($storehash,$symb,$namespace,$domain,$stuname) = @_;
4191:
4192: if (!$symb) {
4193: $symb=&symbread();
4194: if (!$symb) { $symb= $env{'request.url'}; }
4195: }
4196: $symb=escape($symb);
4197:
4198: if (!$namespace) {
4199: # I don't think we would ever want to store this for a course.
4200: # it seems this will only be used if we don't have a course.
4201: #$namespace=$env{'request.course.id'};
4202: #if (!$namespace) {
4203: $namespace=$env{'request.state'};
4204: #}
4205: }
4206: $namespace=~s/\//\_/g;
4207: $namespace=~s/\W//g;
4208: if (!$domain) { $domain=$env{'user.domain'}; }
4209: if (!$stuname) { $stuname=$env{'user.name'}; }
4210: if ($domain eq 'public' && $stuname eq 'public') {
4211: $stuname=$ENV{'REMOTE_ADDR'};
4212: }
4213: my $now=time;
4214: my %hash;
4215: my $path=LONCAPA::tempdir();
4216: if (tie(%hash,'GDBM_File',
4217: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
4218: &GDBM_WRCREAT(),0640)) {
4219: $hash{"version:$symb"}++;
4220: my $version=$hash{"version:$symb"};
4221: my $allkeys='';
4222: foreach my $key (keys(%$storehash)) {
4223: $allkeys.=$key.':';
4224: $hash{"$version:$symb:$key"}=&freeze_escape($$storehash{$key});
4225: }
4226: $hash{"$version:$symb:timestamp"}=$now;
4227: $allkeys.='timestamp';
4228: $hash{"$version:keys:$symb"}=$allkeys;
4229: if (untie(%hash)) {
4230: return 'ok';
4231: } else {
4232: return "error:$!";
4233: }
4234: } else {
4235: return "error:$!";
4236: }
4237: }
4238:
4239: # -----------------------------------------------------------------Temp Restore
4240:
4241: sub tmprestore {
4242: my ($symb,$namespace,$domain,$stuname) = @_;
4243:
4244: if (!$symb) {
4245: $symb=&symbread();
4246: if (!$symb) { $symb= $env{'request.url'}; }
4247: }
4248: $symb=escape($symb);
4249:
4250: if (!$namespace) { $namespace=$env{'request.state'}; }
4251:
4252: if (!$domain) { $domain=$env{'user.domain'}; }
4253: if (!$stuname) { $stuname=$env{'user.name'}; }
4254: if ($domain eq 'public' && $stuname eq 'public') {
4255: $stuname=$ENV{'REMOTE_ADDR'};
4256: }
4257: my %returnhash;
4258: $namespace=~s/\//\_/g;
4259: $namespace=~s/\W//g;
4260: my %hash;
4261: my $path=LONCAPA::tempdir();
4262: if (tie(%hash,'GDBM_File',
4263: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
4264: &GDBM_READER(),0640)) {
4265: my $version=$hash{"version:$symb"};
4266: $returnhash{'version'}=$version;
4267: my $scope;
4268: for ($scope=1;$scope<=$version;$scope++) {
4269: my $vkeys=$hash{"$scope:keys:$symb"};
4270: my @keys=split(/:/,$vkeys);
4271: my $key;
4272: $returnhash{"$scope:keys"}=$vkeys;
4273: foreach $key (@keys) {
4274: $returnhash{"$scope:$key"}=&thaw_unescape($hash{"$scope:$symb:$key"});
4275: $returnhash{"$key"}=&thaw_unescape($hash{"$scope:$symb:$key"});
4276: }
4277: }
4278: if (!(untie(%hash))) {
4279: return "error:$!";
4280: }
4281: } else {
4282: return "error:$!";
4283: }
4284: return %returnhash;
4285: }
4286:
4287: # ----------------------------------------------------------------------- Store
4288:
4289: sub store {
4290: my ($storehash,$symb,$namespace,$domain,$stuname) = @_;
4291: my $home='';
4292:
4293: if ($stuname) { $home=&homeserver($stuname,$domain); }
4294:
4295: $symb=&symbclean($symb);
4296: if (!$symb) { unless ($symb=&symbread()) { return ''; } }
4297:
4298: if (!$domain) { $domain=$env{'user.domain'}; }
4299: if (!$stuname) { $stuname=$env{'user.name'}; }
4300:
4301: &devalidate($symb,$stuname,$domain);
4302:
4303: $symb=escape($symb);
4304: if (!$namespace) {
4305: unless ($namespace=$env{'request.course.id'}) {
4306: return '';
4307: }
4308: }
4309: if (!$home) { $home=$env{'user.home'}; }
4310:
4311: $$storehash{'ip'}=$ENV{'REMOTE_ADDR'};
4312: $$storehash{'host'}=$perlvar{'lonHostID'};
4313:
4314: my $namevalue='';
4315: foreach my $key (keys(%$storehash)) {
4316: $namevalue.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
4317: }
4318: $namevalue=~s/\&$//;
4319: &courselog($symb.':'.$stuname.':'.$domain.':STORE:'.$namevalue);
4320: return reply("store:$domain:$stuname:$namespace:$symb:$namevalue","$home");
4321: }
4322:
4323: # -------------------------------------------------------------- Critical Store
4324:
4325: sub cstore {
4326: my ($storehash,$symb,$namespace,$domain,$stuname) = @_;
4327: my $home='';
4328:
4329: if ($stuname) { $home=&homeserver($stuname,$domain); }
4330:
4331: $symb=&symbclean($symb);
4332: if (!$symb) { unless ($symb=&symbread()) { return ''; } }
4333:
4334: if (!$domain) { $domain=$env{'user.domain'}; }
4335: if (!$stuname) { $stuname=$env{'user.name'}; }
4336:
4337: &devalidate($symb,$stuname,$domain);
4338:
4339: $symb=escape($symb);
4340: if (!$namespace) {
4341: unless ($namespace=$env{'request.course.id'}) {
4342: return '';
4343: }
4344: }
4345: if (!$home) { $home=$env{'user.home'}; }
4346:
4347: $$storehash{'ip'}=$ENV{'REMOTE_ADDR'};
4348: $$storehash{'host'}=$perlvar{'lonHostID'};
4349:
4350: my $namevalue='';
4351: foreach my $key (keys(%$storehash)) {
4352: $namevalue.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
4353: }
4354: $namevalue=~s/\&$//;
4355: &courselog($symb.':'.$stuname.':'.$domain.':CSTORE:'.$namevalue);
4356: return critical
4357: ("store:$domain:$stuname:$namespace:$symb:$namevalue","$home");
4358: }
4359:
4360: # --------------------------------------------------------------------- Restore
4361:
4362: sub restore {
4363: my ($symb,$namespace,$domain,$stuname) = @_;
4364: my $home='';
4365:
4366: if ($stuname) { $home=&homeserver($stuname,$domain); }
4367:
4368: if (!$symb) {
4369: unless ($symb=escape(&symbread())) { return ''; }
4370: } else {
4371: $symb=&escape(&symbclean($symb));
4372: }
4373: if (!$namespace) {
4374: unless ($namespace=$env{'request.course.id'}) {
4375: return '';
4376: }
4377: }
4378: if (!$domain) { $domain=$env{'user.domain'}; }
4379: if (!$stuname) { $stuname=$env{'user.name'}; }
4380: if (!$home) { $home=$env{'user.home'}; }
4381: my $answer=&reply("restore:$domain:$stuname:$namespace:$symb","$home");
4382:
4383: my %returnhash=();
4384: foreach my $line (split(/\&/,$answer)) {
4385: my ($name,$value)=split(/\=/,$line);
4386: $returnhash{&unescape($name)}=&thaw_unescape($value);
4387: }
4388: my $version;
4389: for ($version=1;$version<=$returnhash{'version'};$version++) {
4390: foreach my $item (split(/\:/,$returnhash{$version.':keys'})) {
4391: $returnhash{$item}=$returnhash{$version.':'.$item};
4392: }
4393: }
4394: return %returnhash;
4395: }
4396:
4397: # ---------------------------------------------------------- Course Description
4398: #
4399: #
4400:
4401: sub coursedescription {
4402: my ($courseid,$args)=@_;
4403: $courseid=~s/^\///;
4404: $courseid=~s/\_/\//g;
4405: my ($cdomain,$cnum)=split(/\//,$courseid);
4406: my $chome=&homeserver($cnum,$cdomain);
4407: my $normalid=$cdomain.'_'.$cnum;
4408: # need to always cache even if we get errors otherwise we keep
4409: # trying and trying and trying to get the course description.
4410: my %envhash=();
4411: my %returnhash=();
4412:
4413: my $expiretime=600;
4414: if ($env{'request.course.id'} eq $normalid) {
4415: $expiretime=120;
4416: }
4417:
4418: my $prefix='course.'.$cdomain.'_'.$cnum.'.';
4419: if (!$args->{'freshen_cache'}
4420: && ((time-$env{$prefix.'last_cache'}) < $expiretime) ) {
4421: foreach my $key (keys(%env)) {
4422: next if ($key !~ /^\Q$prefix\E(.*)/);
4423: my ($setting) = $1;
4424: $returnhash{$setting} = $env{$key};
4425: }
4426: return %returnhash;
4427: }
4428:
4429: # get the data again
4430:
4431: if (!$args->{'one_time'}) {
4432: $envhash{'course.'.$normalid.'.last_cache'}=time;
4433: }
4434:
4435: if ($chome ne 'no_host') {
4436: %returnhash=&dump('environment',$cdomain,$cnum);
4437: if (!exists($returnhash{'con_lost'})) {
4438: my $username = $env{'user.name'}; # Defult username
4439: if(defined $args->{'user'}) {
4440: $username = $args->{'user'};
4441: }
4442: $returnhash{'home'}= $chome;
4443: $returnhash{'domain'} = $cdomain;
4444: $returnhash{'num'} = $cnum;
4445: if (!defined($returnhash{'type'})) {
4446: $returnhash{'type'} = 'Course';
4447: }
4448: while (my ($name,$value) = each %returnhash) {
4449: $envhash{'course.'.$normalid.'.'.$name}=$value;
4450: }
4451: $returnhash{'url'}=&clutter($returnhash{'url'});
4452: $returnhash{'fn'}=LONCAPA::tempdir() .
4453: $username.'_'.$cdomain.'_'.$cnum;
4454: $envhash{'course.'.$normalid.'.home'}=$chome;
4455: $envhash{'course.'.$normalid.'.domain'}=$cdomain;
4456: $envhash{'course.'.$normalid.'.num'}=$cnum;
4457: }
4458: }
4459: if (!$args->{'one_time'}) {
4460: &appenv(\%envhash);
4461: }
4462: return %returnhash;
4463: }
4464:
4465: sub update_released_required {
4466: my ($needsrelease,$cdom,$cnum,$chome,$cid) = @_;
4467: if ($cdom eq '' || $cnum eq '' || $chome eq '' || $cid eq '') {
4468: $cid = $env{'request.course.id'};
4469: $cdom = $env{'course.'.$cid.'.domain'};
4470: $cnum = $env{'course.'.$cid.'.num'};
4471: $chome = $env{'course.'.$cid.'.home'};
4472: }
4473: if ($needsrelease) {
4474: my %curr_reqd_hash = &userenvironment($cdom,$cnum,'internal.releaserequired');
4475: my $needsupdate;
4476: if ($curr_reqd_hash{'internal.releaserequired'} eq '') {
4477: $needsupdate = 1;
4478: } else {
4479: my ($currmajor,$currminor) = split(/\./,$curr_reqd_hash{'internal.releaserequired'});
4480: my ($needsmajor,$needsminor) = split(/\./,$needsrelease);
4481: if (($currmajor < $needsmajor) || ($currmajor == $needsmajor && $currminor < $needsminor)) {
4482: $needsupdate = 1;
4483: }
4484: }
4485: if ($needsupdate) {
4486: my %needshash = (
4487: 'internal.releaserequired' => $needsrelease,
4488: );
4489: my $putresult = &put('environment',\%needshash,$cdom,$cnum);
4490: if ($putresult eq 'ok') {
4491: &appenv({'course.'.$cid.'.internal.releaserequired' => $needsrelease});
4492: my %crsinfo = &courseiddump($cdom,'.',1,'.','.',$cnum,undef,undef,'.');
4493: if (ref($crsinfo{$cid}) eq 'HASH') {
4494: $crsinfo{$cid}{'releaserequired'} = $needsrelease;
4495: &courseidput($cdom,\%crsinfo,$chome,'notime');
4496: }
4497: }
4498: }
4499: }
4500: return;
4501: }
4502:
4503: # -------------------------------------------------See if a user is privileged
4504:
4505: sub privileged {
4506: my ($username,$domain)=@_;
4507: my $rolesdump=&reply("dump:$domain:$username:roles",
4508: &homeserver($username,$domain));
4509: if (($rolesdump eq 'con_lost') || ($rolesdump eq '') ||
4510: ($rolesdump =~ /^error:/)) {
4511: return 0;
4512: }
4513: my $now=time;
4514: if ($rolesdump ne '') {
4515: foreach my $entry (split(/&/,$rolesdump)) {
4516: if ($entry!~/^rolesdef_/) {
4517: my ($area,$role)=split(/=/,$entry);
4518: $area=~s/\_\w\w$//;
4519: my ($trole,$tend,$tstart)=split(/_/,$role);
4520: if (($trole eq 'dc') || ($trole eq 'su')) {
4521: my $active=1;
4522: if ($tend) {
4523: if ($tend<$now) { $active=0; }
4524: }
4525: if ($tstart) {
4526: if ($tstart>$now) { $active=0; }
4527: }
4528: if ($active) { return 1; }
4529: }
4530: }
4531: }
4532: }
4533: return 0;
4534: }
4535:
4536: # -------------------------------------------------------- Get user privileges
4537:
4538: sub rolesinit {
4539: my ($domain,$username,$authhost)=@_;
4540: my $now=time;
4541: my %userroles = ('user.login.time' => $now);
4542: my $extra = &freeze_escape({'skipcheck' => 1});
4543: my $rolesdump=reply("dump:$domain:$username:roles:.::$extra",$authhost);
4544: if (($rolesdump eq 'con_lost') || ($rolesdump eq '') ||
4545: ($rolesdump =~ /^error:/)) {
4546: return \%userroles;
4547: }
4548: my %allroles=();
4549: my %allgroups=();
4550:
4551: if ($rolesdump ne '') {
4552: foreach my $entry (split(/&/,$rolesdump)) {
4553: if ($entry!~/^rolesdef_/) {
4554: my ($area,$role)=split(/=/,$entry);
4555: $area=~s/\_\w\w$//;
4556: my ($trole,$tend,$tstart,$group_privs);
4557: if ($role=~/^cr/) {
4558: if ($role=~m|^(cr/$match_domain/$match_username/[a-zA-Z0-9]+)_(.*)$|) {
4559: ($trole,my $trest)=($role=~m|^(cr/$match_domain/$match_username/[a-zA-Z0-9]+)_(.*)$|);
4560: ($tend,$tstart)=split('_',$trest);
4561: } else {
4562: $trole=$role;
4563: }
4564: } elsif ($role =~ m|^gr/|) {
4565: ($trole,$tend,$tstart) = split(/_/,$role);
4566: next if ($tstart eq '-1');
4567: ($trole,$group_privs) = split(/\//,$trole);
4568: $group_privs = &unescape($group_privs);
4569: } else {
4570: ($trole,$tend,$tstart)=split(/_/,$role);
4571: }
4572: my %new_role = &set_arearole($trole,$area,$tstart,$tend,$domain,
4573: $username);
4574: @userroles{keys(%new_role)} = @new_role{keys(%new_role)};
4575: if (($tend!=0) && ($tend<$now)) { $trole=''; }
4576: if (($tstart!=0) && ($tstart>$now)) { $trole=''; }
4577: if (($area ne '') && ($trole ne '')) {
4578: my $spec=$trole.'.'.$area;
4579: my ($tdummy,$tdomain,$trest)=split(/\//,$area);
4580: if ($trole =~ /^cr\//) {
4581: &custom_roleprivs(\%allroles,$trole,$tdomain,$trest,$spec,$area);
4582: } elsif ($trole eq 'gr') {
4583: &group_roleprivs(\%allgroups,$area,$group_privs,$tend,$tstart);
4584: } else {
4585: &standard_roleprivs(\%allroles,$trole,$tdomain,$spec,$trest,$area);
4586: }
4587: }
4588: }
4589: }
4590: my ($author,$adv) = &set_userprivs(\%userroles,\%allroles,\%allgroups);
4591: $userroles{'user.adv'} = $adv;
4592: $userroles{'user.author'} = $author;
4593: $env{'user.adv'}=$adv;
4594: }
4595: return \%userroles;
4596: }
4597:
4598: sub set_arearole {
4599: my ($trole,$area,$tstart,$tend,$domain,$username) = @_;
4600: # log the associated role with the area
4601: &userrolelog($trole,$username,$domain,$area,$tstart,$tend);
4602: return ('user.role.'.$trole.'.'.$area => $tstart.'.'.$tend);
4603: }
4604:
4605: sub custom_roleprivs {
4606: my ($allroles,$trole,$tdomain,$trest,$spec,$area) = @_;
4607: my ($rdummy,$rdomain,$rauthor,$rrole)=split(/\//,$trole);
4608: my $homsvr=homeserver($rauthor,$rdomain);
4609: if (&hostname($homsvr) ne '') {
4610: my ($rdummy,$roledef)=
4611: &get('roles',["rolesdef_$rrole"],$rdomain,$rauthor);
4612: if (($rdummy ne 'con_lost') && ($roledef ne '')) {
4613: my ($syspriv,$dompriv,$coursepriv)=split(/\_/,$roledef);
4614: if (defined($syspriv)) {
4615: if ($trest =~ /^$match_community$/) {
4616: $syspriv =~ s/bre\&S//;
4617: }
4618: $$allroles{'cm./'}.=':'.$syspriv;
4619: $$allroles{$spec.'./'}.=':'.$syspriv;
4620: }
4621: if ($tdomain ne '') {
4622: if (defined($dompriv)) {
4623: $$allroles{'cm./'.$tdomain.'/'}.=':'.$dompriv;
4624: $$allroles{$spec.'./'.$tdomain.'/'}.=':'.$dompriv;
4625: }
4626: if (($trest ne '') && (defined($coursepriv))) {
4627: $$allroles{'cm.'.$area}.=':'.$coursepriv;
4628: $$allroles{$spec.'.'.$area}.=':'.$coursepriv;
4629: }
4630: }
4631: }
4632: }
4633: }
4634:
4635: sub group_roleprivs {
4636: my ($allgroups,$area,$group_privs,$tend,$tstart) = @_;
4637: my $access = 1;
4638: my $now = time;
4639: if (($tend!=0) && ($tend<$now)) { $access = 0; }
4640: if (($tstart!=0) && ($tstart>$now)) { $access=0; }
4641: if ($access) {
4642: my ($course,$group) = ($area =~ m|(/$match_domain/$match_courseid)/([^/]+)$|);
4643: $$allgroups{$course}{$group} .=':'.$group_privs;
4644: }
4645: }
4646:
4647: sub standard_roleprivs {
4648: my ($allroles,$trole,$tdomain,$spec,$trest,$area) = @_;
4649: if (defined($pr{$trole.':s'})) {
4650: $$allroles{'cm./'}.=':'.$pr{$trole.':s'};
4651: $$allroles{$spec.'./'}.=':'.$pr{$trole.':s'};
4652: }
4653: if ($tdomain ne '') {
4654: if (defined($pr{$trole.':d'})) {
4655: $$allroles{'cm./'.$tdomain.'/'}.=':'.$pr{$trole.':d'};
4656: $$allroles{$spec.'./'.$tdomain.'/'}.=':'.$pr{$trole.':d'};
4657: }
4658: if (($trest ne '') && (defined($pr{$trole.':c'}))) {
4659: $$allroles{'cm.'.$area}.=':'.$pr{$trole.':c'};
4660: $$allroles{$spec.'.'.$area}.=':'.$pr{$trole.':c'};
4661: }
4662: }
4663: }
4664:
4665: sub set_userprivs {
4666: my ($userroles,$allroles,$allgroups,$groups_roles) = @_;
4667: my $author=0;
4668: my $adv=0;
4669: my %grouproles = ();
4670: if (keys(%{$allgroups}) > 0) {
4671: my @groupkeys;
4672: foreach my $role (keys(%{$allroles})) {
4673: push(@groupkeys,$role);
4674: }
4675: if (ref($groups_roles) eq 'HASH') {
4676: foreach my $key (keys(%{$groups_roles})) {
4677: unless (grep(/^\Q$key\E$/,@groupkeys)) {
4678: push(@groupkeys,$key);
4679: }
4680: }
4681: }
4682: if (@groupkeys > 0) {
4683: foreach my $role (@groupkeys) {
4684: my ($trole,$area,$sec,$extendedarea);
4685: if ($role =~ m-^(\w+|cr/$match_domain/$match_username/\w+)\.(/$match_domain/$match_courseid)(/?\w*)\.-) {
4686: $trole = $1;
4687: $area = $2;
4688: $sec = $3;
4689: $extendedarea = $area.$sec;
4690: if (exists($$allgroups{$area})) {
4691: foreach my $group (keys(%{$$allgroups{$area}})) {
4692: my $spec = $trole.'.'.$extendedarea;
4693: $grouproles{$spec.'.'.$area.'/'.$group} =
4694: $$allgroups{$area}{$group};
4695: }
4696: }
4697: }
4698: }
4699: }
4700: }
4701: foreach my $group (keys(%grouproles)) {
4702: $$allroles{$group} = $grouproles{$group};
4703: }
4704: foreach my $role (keys(%{$allroles})) {
4705: my %thesepriv;
4706: if (($role=~/^au/) || ($role=~/^ca/) || ($role=~/^aa/)) { $author=1; }
4707: foreach my $item (split(/:/,$$allroles{$role})) {
4708: if ($item ne '') {
4709: my ($privilege,$restrictions)=split(/&/,$item);
4710: if ($restrictions eq '') {
4711: $thesepriv{$privilege}='F';
4712: } elsif ($thesepriv{$privilege} ne 'F') {
4713: $thesepriv{$privilege}.=$restrictions;
4714: }
4715: if ($thesepriv{'adv'} eq 'F') { $adv=1; }
4716: }
4717: }
4718: my $thesestr='';
4719: foreach my $priv (sort(keys(%thesepriv))) {
4720: $thesestr.=':'.$priv.'&'.$thesepriv{$priv};
4721: }
4722: $userroles->{'user.priv.'.$role} = $thesestr;
4723: }
4724: return ($author,$adv);
4725: }
4726:
4727: sub role_status {
4728: my ($rolekey,$update,$refresh,$now,$role,$where,$trolecode,$tstatus,$tstart,$tend) = @_;
4729: my @pwhere = ();
4730: if (exists($env{$rolekey}) && $env{$rolekey} ne '') {
4731: (undef,undef,$$role,@pwhere)=split(/\./,$rolekey);
4732: unless (!defined($$role) || $$role eq '') {
4733: $$where=join('.',@pwhere);
4734: $$trolecode=$$role.'.'.$$where;
4735: ($$tstart,$$tend)=split(/\./,$env{$rolekey});
4736: $$tstatus='is';
4737: if ($$tstart && $$tstart>$update) {
4738: $$tstatus='future';
4739: if ($$tstart<$now) {
4740: if ($$tstart && $$tstart>$refresh) {
4741: if (($$where ne '') && ($$role ne '')) {
4742: my (%allroles,%allgroups,$group_privs,
4743: %groups_roles,@rolecodes);
4744: my %userroles = (
4745: 'user.role.'.$$role.'.'.$$where => $$tstart.'.'.$$tend
4746: );
4747: @rolecodes = ('cm');
4748: my $spec=$$role.'.'.$$where;
4749: my ($tdummy,$tdomain,$trest)=split(/\//,$$where);
4750: if ($$role =~ /^cr\//) {
4751: &custom_roleprivs(\%allroles,$$role,$tdomain,$trest,$spec,$$where);
4752: push(@rolecodes,'cr');
4753: } elsif ($$role eq 'gr') {
4754: push(@rolecodes,$$role);
4755: my %rolehash = &get('roles',[$$where.'_'.$$role],$env{'user.domain'},
4756: $env{'user.name'});
4757: my ($trole) = split('_',$rolehash{$$where.'_'.$$role},2);
4758: (undef,my $group_privs) = split(/\//,$trole);
4759: $group_privs = &unescape($group_privs);
4760: &group_roleprivs(\%allgroups,$$where,$group_privs,$$tend,$$tstart);
4761: my %course_roles = &get_my_roles($env{'user.name'},$env{'user.domain'},'userroles',['active'],['cc','co','in','ta','ep','ad','st','cr'],[$tdomain],1);
4762: &get_groups_roles($tdomain,$trest,
4763: \%course_roles,\@rolecodes,
4764: \%groups_roles);
4765: } else {
4766: push(@rolecodes,$$role);
4767: &standard_roleprivs(\%allroles,$$role,$tdomain,$spec,$trest,$$where);
4768: }
4769: my ($author,$adv)= &set_userprivs(\%userroles,\%allroles,\%allgroups,\%groups_roles);
4770: &appenv(\%userroles,\@rolecodes);
4771: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},"Role ".$role);
4772: }
4773: }
4774: $$tstatus = 'is';
4775: }
4776: }
4777: if ($$tend) {
4778: if ($$tend<$update) {
4779: $$tstatus='expired';
4780: } elsif ($$tend<$now) {
4781: $$tstatus='will_not';
4782: }
4783: }
4784: }
4785: }
4786: }
4787:
4788: sub get_groups_roles {
4789: my ($cdom,$rest,$cdom_courseroles,$rolecodes,$groups_roles) = @_;
4790: return unless((ref($cdom_courseroles) eq 'HASH') &&
4791: (ref($rolecodes) eq 'ARRAY') &&
4792: (ref($groups_roles) eq 'HASH'));
4793: if (keys(%{$cdom_courseroles}) > 0) {
4794: my ($cnum) = ($rest =~ /^($match_courseid)/);
4795: if ($cdom ne '' && $cnum ne '') {
4796: foreach my $key (keys(%{$cdom_courseroles})) {
4797: if ($key =~ /^\Q$cnum\E:\Q$cdom\E:([^:]+):?([^:]*)/) {
4798: my $crsrole = $1;
4799: my $crssec = $2;
4800: if ($crsrole =~ /^cr/) {
4801: unless (grep(/^cr$/,@{$rolecodes})) {
4802: push(@{$rolecodes},'cr');
4803: }
4804: } else {
4805: unless(grep(/^\Q$crsrole\E$/,@{$rolecodes})) {
4806: push(@{$rolecodes},$crsrole);
4807: }
4808: }
4809: my $rolekey = "$crsrole./$cdom/$cnum";
4810: if ($crssec ne '') {
4811: $rolekey .= "/$crssec";
4812: }
4813: $rolekey .= './';
4814: $groups_roles->{$rolekey} = $rolecodes;
4815: }
4816: }
4817: }
4818: }
4819: return;
4820: }
4821:
4822: sub delete_env_groupprivs {
4823: my ($where,$courseroles,$possroles) = @_;
4824: return unless((ref($courseroles) eq 'HASH') && (ref($possroles) eq 'ARRAY'));
4825: my ($dummy,$udom,$uname,$group) = split(/\//,$where);
4826: unless (ref($courseroles->{$udom}) eq 'HASH') {
4827: %{$courseroles->{$udom}} =
4828: &get_my_roles('','','userroles',['active'],
4829: $possroles,[$udom],1);
4830: }
4831: if (ref($courseroles->{$udom}) eq 'HASH') {
4832: foreach my $item (keys(%{$courseroles->{$udom}})) {
4833: my ($cnum,$cdom,$crsrole,$crssec) = split(/:/,$item);
4834: my $area = '/'.$cdom.'/'.$cnum;
4835: my $privkey = "user.priv.$crsrole.$area";
4836: if ($crssec ne '') {
4837: $privkey .= '/'.$crssec;
4838: }
4839: $privkey .= ".$area/$group";
4840: &Apache::lonnet::delenv($privkey,undef,[$crsrole]);
4841: }
4842: }
4843: return;
4844: }
4845:
4846: sub check_adhoc_privs {
4847: my ($cdom,$cnum,$update,$refresh,$now,$checkrole,$caller) = @_;
4848: my $cckey = 'user.role.'.$checkrole.'./'.$cdom.'/'.$cnum;
4849: if ($env{$cckey}) {
4850: my ($role,$where,$trolecode,$tstart,$tend,$tremark,$tstatus,$tpstart,$tpend);
4851: &role_status($cckey,$update,$refresh,$now,\$role,\$where,\$trolecode,\$tstatus,\$tstart,\$tend);
4852: unless (($tstatus eq 'is') || ($tstatus eq 'will_not')) {
4853: &set_adhoc_privileges($cdom,$cnum,$checkrole,$caller);
4854: }
4855: } else {
4856: &set_adhoc_privileges($cdom,$cnum,$checkrole,$caller);
4857: }
4858: }
4859:
4860: sub set_adhoc_privileges {
4861: # role can be cc or ca
4862: my ($dcdom,$pickedcourse,$role,$caller) = @_;
4863: my $area = '/'.$dcdom.'/'.$pickedcourse;
4864: my $spec = $role.'.'.$area;
4865: my %userroles = &set_arearole($role,$area,'','',$env{'user.domain'},
4866: $env{'user.name'});
4867: my %ccrole = ();
4868: &standard_roleprivs(\%ccrole,$role,$dcdom,$spec,$pickedcourse,$area);
4869: my ($author,$adv)= &set_userprivs(\%userroles,\%ccrole);
4870: &appenv(\%userroles,[$role,'cm']);
4871: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},"Role ".$role);
4872: unless ($caller eq 'constructaccess' && $env{'request.course.id'}) {
4873: &appenv( {'request.role' => $spec,
4874: 'request.role.domain' => $dcdom,
4875: 'request.course.sec' => ''
4876: }
4877: );
4878: my $tadv=0;
4879: if (&allowed('adv') eq 'F') { $tadv=1; }
4880: &appenv({'request.role.adv' => $tadv});
4881: }
4882: }
4883:
4884: # --------------------------------------------------------------- get interface
4885:
4886: sub get {
4887: my ($namespace,$storearr,$udomain,$uname)=@_;
4888: my $items='';
4889: foreach my $item (@$storearr) {
4890: $items.=&escape($item).'&';
4891: }
4892: $items=~s/\&$//;
4893: if (!$udomain) { $udomain=$env{'user.domain'}; }
4894: if (!$uname) { $uname=$env{'user.name'}; }
4895: my $uhome=&homeserver($uname,$udomain);
4896:
4897: my $rep=&reply("get:$udomain:$uname:$namespace:$items",$uhome);
4898: my @pairs=split(/\&/,$rep);
4899: if ( $#pairs==0 && $pairs[0] =~ /^(con_lost|error|no_such_host)/i) {
4900: return @pairs;
4901: }
4902: my %returnhash=();
4903: my $i=0;
4904: foreach my $item (@$storearr) {
4905: $returnhash{$item}=&thaw_unescape($pairs[$i]);
4906: $i++;
4907: }
4908: return %returnhash;
4909: }
4910:
4911: # --------------------------------------------------------------- del interface
4912:
4913: sub del {
4914: my ($namespace,$storearr,$udomain,$uname)=@_;
4915: my $items='';
4916: foreach my $item (@$storearr) {
4917: $items.=&escape($item).'&';
4918: }
4919:
4920: $items=~s/\&$//;
4921: if (!$udomain) { $udomain=$env{'user.domain'}; }
4922: if (!$uname) { $uname=$env{'user.name'}; }
4923: my $uhome=&homeserver($uname,$udomain);
4924: return &reply("del:$udomain:$uname:$namespace:$items",$uhome);
4925: }
4926:
4927: # -------------------------------------------------------------- dump interface
4928:
4929: sub dump {
4930: my ($namespace,$udomain,$uname,$regexp,$range,$extra)=@_;
4931: if (!$udomain) { $udomain=$env{'user.domain'}; }
4932: if (!$uname) { $uname=$env{'user.name'}; }
4933: my $uhome=&homeserver($uname,$udomain);
4934: if ($regexp) {
4935: $regexp=&escape($regexp);
4936: } else {
4937: $regexp='.';
4938: }
4939: my $rep=&reply("dump:$udomain:$uname:$namespace:$regexp:$range:$extra",$uhome);
4940: my @pairs=split(/\&/,$rep);
4941: my %returnhash=();
4942: if (!($rep =~ /^error/ )) {
4943: foreach my $item (@pairs) {
4944: my ($key,$value)=split(/=/,$item,2);
4945: $key = &unescape($key);
4946: next if ($key =~ /^error: 2 /);
4947: $returnhash{$key}=&thaw_unescape($value);
4948: }
4949: }
4950: return %returnhash;
4951: }
4952:
4953:
4954: # --------------------------------------------------------- dumpstore interface
4955:
4956: sub dumpstore {
4957: my ($namespace,$udomain,$uname,$regexp,$range)=@_;
4958: if (!$udomain) { $udomain=$env{'user.domain'}; }
4959: if (!$uname) { $uname=$env{'user.name'}; }
4960: my $uhome=&homeserver($uname,$udomain);
4961: if ($regexp) {
4962: $regexp=&escape($regexp);
4963: } else {
4964: $regexp='.';
4965: }
4966: my $rep=&reply("dump:$udomain:$uname:$namespace:$regexp:$range",$uhome);
4967: my @pairs=split(/\&/,$rep);
4968: my %returnhash=();
4969: foreach my $item (@pairs) {
4970: my ($key,$value)=split(/=/,$item,2);
4971: next if ($key =~ /^error: 2 /);
4972: $returnhash{$key}=&thaw_unescape($value);
4973: }
4974: return %returnhash;
4975: }
4976:
4977: # -------------------------------------------------------------- keys interface
4978:
4979: sub getkeys {
4980: my ($namespace,$udomain,$uname)=@_;
4981: if (!$udomain) { $udomain=$env{'user.domain'}; }
4982: if (!$uname) { $uname=$env{'user.name'}; }
4983: my $uhome=&homeserver($uname,$udomain);
4984: my $rep=reply("keys:$udomain:$uname:$namespace",$uhome);
4985: my @keyarray=();
4986: foreach my $key (split(/\&/,$rep)) {
4987: next if ($key =~ /^error: 2 /);
4988: push(@keyarray,&unescape($key));
4989: }
4990: return @keyarray;
4991: }
4992:
4993: # --------------------------------------------------------------- currentdump
4994: sub currentdump {
4995: my ($courseid,$sdom,$sname)=@_;
4996: $courseid = $env{'request.course.id'} if (! defined($courseid));
4997: $sdom = $env{'user.domain'} if (! defined($sdom));
4998: $sname = $env{'user.name'} if (! defined($sname));
4999: my $uhome = &homeserver($sname,$sdom);
5000: my $rep=reply('currentdump:'.$sdom.':'.$sname.':'.$courseid,$uhome);
5001: return if ($rep =~ /^(error:|no_such_host)/);
5002: #
5003: my %returnhash=();
5004: #
5005: if ($rep eq "unknown_cmd") {
5006: # an old lond will not know currentdump
5007: # Do a dump and make it look like a currentdump
5008: my @tmp = &dumpstore($courseid,$sdom,$sname,'.');
5009: return if ($tmp[0] =~ /^(error:|no_such_host)/);
5010: my %hash = @tmp;
5011: @tmp=();
5012: %returnhash = %{&convert_dump_to_currentdump(\%hash)};
5013: } else {
5014: my @pairs=split(/\&/,$rep);
5015: foreach my $pair (@pairs) {
5016: my ($key,$value)=split(/=/,$pair,2);
5017: my ($symb,$param) = split(/:/,$key);
5018: $returnhash{&unescape($symb)}->{&unescape($param)} =
5019: &thaw_unescape($value);
5020: }
5021: }
5022: return %returnhash;
5023: }
5024:
5025: sub convert_dump_to_currentdump{
5026: my %hash = %{shift()};
5027: my %returnhash;
5028: # Code ripped from lond, essentially. The only difference
5029: # here is the unescaping done by lonnet::dump(). Conceivably
5030: # we might run in to problems with parameter names =~ /^v\./
5031: while (my ($key,$value) = each(%hash)) {
5032: my ($v,$symb,$param) = split(/:/,$key);
5033: $symb = &unescape($symb);
5034: $param = &unescape($param);
5035: next if ($v eq 'version' || $symb eq 'keys');
5036: next if (exists($returnhash{$symb}) &&
5037: exists($returnhash{$symb}->{$param}) &&
5038: $returnhash{$symb}->{'v.'.$param} > $v);
5039: $returnhash{$symb}->{$param}=$value;
5040: $returnhash{$symb}->{'v.'.$param}=$v;
5041: }
5042: #
5043: # Remove all of the keys in the hashes which keep track of
5044: # the version of the parameter.
5045: while (my ($symb,$param_hash) = each(%returnhash)) {
5046: # use a foreach because we are going to delete from the hash.
5047: foreach my $key (keys(%$param_hash)) {
5048: delete($param_hash->{$key}) if ($key =~ /^v\./);
5049: }
5050: }
5051: return \%returnhash;
5052: }
5053:
5054: # ------------------------------------------------------ critical inc interface
5055:
5056: sub cinc {
5057: return &inc(@_,'critical');
5058: }
5059:
5060: # --------------------------------------------------------------- inc interface
5061:
5062: sub inc {
5063: my ($namespace,$store,$udomain,$uname,$critical) = @_;
5064: if (!$udomain) { $udomain=$env{'user.domain'}; }
5065: if (!$uname) { $uname=$env{'user.name'}; }
5066: my $uhome=&homeserver($uname,$udomain);
5067: my $items='';
5068: if (! ref($store)) {
5069: # got a single value, so use that instead
5070: $items = &escape($store).'=&';
5071: } elsif (ref($store) eq 'SCALAR') {
5072: $items = &escape($$store).'=&';
5073: } elsif (ref($store) eq 'ARRAY') {
5074: $items = join('=&',map {&escape($_);} @{$store});
5075: } elsif (ref($store) eq 'HASH') {
5076: while (my($key,$value) = each(%{$store})) {
5077: $items.= &escape($key).'='.&escape($value).'&';
5078: }
5079: }
5080: $items=~s/\&$//;
5081: if ($critical) {
5082: return &critical("inc:$udomain:$uname:$namespace:$items",$uhome);
5083: } else {
5084: return &reply("inc:$udomain:$uname:$namespace:$items",$uhome);
5085: }
5086: }
5087:
5088: # --------------------------------------------------------------- put interface
5089:
5090: sub put {
5091: my ($namespace,$storehash,$udomain,$uname)=@_;
5092: if (!$udomain) { $udomain=$env{'user.domain'}; }
5093: if (!$uname) { $uname=$env{'user.name'}; }
5094: my $uhome=&homeserver($uname,$udomain);
5095: my $items='';
5096: foreach my $item (keys(%$storehash)) {
5097: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
5098: }
5099: $items=~s/\&$//;
5100: return &reply("put:$udomain:$uname:$namespace:$items",$uhome);
5101: }
5102:
5103: # ------------------------------------------------------------ newput interface
5104:
5105: sub newput {
5106: my ($namespace,$storehash,$udomain,$uname)=@_;
5107: if (!$udomain) { $udomain=$env{'user.domain'}; }
5108: if (!$uname) { $uname=$env{'user.name'}; }
5109: my $uhome=&homeserver($uname,$udomain);
5110: my $items='';
5111: foreach my $key (keys(%$storehash)) {
5112: $items.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
5113: }
5114: $items=~s/\&$//;
5115: return &reply("newput:$udomain:$uname:$namespace:$items",$uhome);
5116: }
5117:
5118: # --------------------------------------------------------- putstore interface
5119:
5120: sub putstore {
5121: my ($namespace,$symb,$version,$storehash,$udomain,$uname)=@_;
5122: if (!$udomain) { $udomain=$env{'user.domain'}; }
5123: if (!$uname) { $uname=$env{'user.name'}; }
5124: my $uhome=&homeserver($uname,$udomain);
5125: my $items='';
5126: foreach my $key (keys(%$storehash)) {
5127: $items.= &escape($key).'='.&freeze_escape($storehash->{$key}).'&';
5128: }
5129: $items=~s/\&$//;
5130: my $esc_symb=&escape($symb);
5131: my $esc_v=&escape($version);
5132: my $reply =
5133: &reply("putstore:$udomain:$uname:$namespace:$esc_symb:$esc_v:$items",
5134: $uhome);
5135: if ($reply eq 'unknown_cmd') {
5136: # gfall back to way things use to be done
5137: return &old_putstore($namespace,$symb,$version,$storehash,$udomain,
5138: $uname);
5139: }
5140: return $reply;
5141: }
5142:
5143: sub old_putstore {
5144: my ($namespace,$symb,$version,$storehash,$udomain,$uname)=@_;
5145: if (!$udomain) { $udomain=$env{'user.domain'}; }
5146: if (!$uname) { $uname=$env{'user.name'}; }
5147: my $uhome=&homeserver($uname,$udomain);
5148: my %newstorehash;
5149: foreach my $item (keys(%$storehash)) {
5150: my $key = $version.':'.&escape($symb).':'.$item;
5151: $newstorehash{$key} = $storehash->{$item};
5152: }
5153: my $items='';
5154: my %allitems = ();
5155: foreach my $item (keys(%newstorehash)) {
5156: if ($item =~ m/^([^\:]+):([^\:]+):([^\:]+)$/) {
5157: my $key = $1.':keys:'.$2;
5158: $allitems{$key} .= $3.':';
5159: }
5160: $items.=$item.'='.&freeze_escape($newstorehash{$item}).'&';
5161: }
5162: foreach my $item (keys(%allitems)) {
5163: $allitems{$item} =~ s/\:$//;
5164: $items.= $item.'='.$allitems{$item}.'&';
5165: }
5166: $items=~s/\&$//;
5167: return &reply("put:$udomain:$uname:$namespace:$items",$uhome);
5168: }
5169:
5170: # ------------------------------------------------------ critical put interface
5171:
5172: sub cput {
5173: my ($namespace,$storehash,$udomain,$uname)=@_;
5174: if (!$udomain) { $udomain=$env{'user.domain'}; }
5175: if (!$uname) { $uname=$env{'user.name'}; }
5176: my $uhome=&homeserver($uname,$udomain);
5177: my $items='';
5178: foreach my $item (keys(%$storehash)) {
5179: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
5180: }
5181: $items=~s/\&$//;
5182: return &critical("put:$udomain:$uname:$namespace:$items",$uhome);
5183: }
5184:
5185: # -------------------------------------------------------------- eget interface
5186:
5187: sub eget {
5188: my ($namespace,$storearr,$udomain,$uname)=@_;
5189: my $items='';
5190: foreach my $item (@$storearr) {
5191: $items.=&escape($item).'&';
5192: }
5193: $items=~s/\&$//;
5194: if (!$udomain) { $udomain=$env{'user.domain'}; }
5195: if (!$uname) { $uname=$env{'user.name'}; }
5196: my $uhome=&homeserver($uname,$udomain);
5197: my $rep=&reply("eget:$udomain:$uname:$namespace:$items",$uhome);
5198: my @pairs=split(/\&/,$rep);
5199: my %returnhash=();
5200: my $i=0;
5201: foreach my $item (@$storearr) {
5202: $returnhash{$item}=&thaw_unescape($pairs[$i]);
5203: $i++;
5204: }
5205: return %returnhash;
5206: }
5207:
5208: # ------------------------------------------------------------ tmpput interface
5209: sub tmpput {
5210: my ($storehash,$server,$context)=@_;
5211: my $items='';
5212: foreach my $item (keys(%$storehash)) {
5213: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
5214: }
5215: $items=~s/\&$//;
5216: if (defined($context)) {
5217: $items .= ':'.&escape($context);
5218: }
5219: return &reply("tmpput:$items",$server);
5220: }
5221:
5222: # ------------------------------------------------------------ tmpget interface
5223: sub tmpget {
5224: my ($token,$server)=@_;
5225: if (!defined($server)) { $server = $perlvar{'lonHostID'}; }
5226: my $rep=&reply("tmpget:$token",$server);
5227: my %returnhash;
5228: foreach my $item (split(/\&/,$rep)) {
5229: my ($key,$value)=split(/=/,$item);
5230: next if ($key =~ /^error: 2 /);
5231: $returnhash{&unescape($key)}=&thaw_unescape($value);
5232: }
5233: return %returnhash;
5234: }
5235:
5236: # ------------------------------------------------------------ tmpdel interface
5237: sub tmpdel {
5238: my ($token,$server)=@_;
5239: if (!defined($server)) { $server = $perlvar{'lonHostID'}; }
5240: return &reply("tmpdel:$token",$server);
5241: }
5242:
5243: # -------------------------------------------------- portfolio access checking
5244:
5245: sub portfolio_access {
5246: my ($requrl) = @_;
5247: my (undef,$udom,$unum,$file_name,$group) = &parse_portfolio_url($requrl);
5248: my $result = &get_portfolio_access($udom,$unum,$file_name,$group);
5249: if ($result) {
5250: my %setters;
5251: if ($env{'user.name'} eq 'public' && $env{'user.domain'} eq 'public') {
5252: my ($startblock,$endblock) =
5253: &Apache::loncommon::blockcheck(\%setters,'port',$unum,$udom);
5254: if ($startblock && $endblock) {
5255: return 'B';
5256: }
5257: } else {
5258: my ($startblock,$endblock) =
5259: &Apache::loncommon::blockcheck(\%setters,'port');
5260: if ($startblock && $endblock) {
5261: return 'B';
5262: }
5263: }
5264: }
5265: if ($result eq 'ok') {
5266: return 'F';
5267: } elsif ($result =~ /^[^:]+:guest_/) {
5268: return 'A';
5269: }
5270: return '';
5271: }
5272:
5273: sub get_portfolio_access {
5274: my ($udom,$unum,$file_name,$group,$access_hash) = @_;
5275:
5276: if (!ref($access_hash)) {
5277: my $current_perms = &get_portfile_permissions($udom,$unum);
5278: my %access_controls = &get_access_controls($current_perms,$group,
5279: $file_name);
5280: $access_hash = $access_controls{$file_name};
5281: }
5282:
5283: my ($public,$guest,@domains,@users,@courses,@groups);
5284: my $now = time;
5285: if (ref($access_hash) eq 'HASH') {
5286: foreach my $key (keys(%{$access_hash})) {
5287: my ($num,$scope,$end,$start) = ($key =~ /^([^:]+):([a-z]+)_(\d*)_?(\d*)$/);
5288: if ($start > $now) {
5289: next;
5290: }
5291: if ($end && $end<$now) {
5292: next;
5293: }
5294: if ($scope eq 'public') {
5295: $public = $key;
5296: last;
5297: } elsif ($scope eq 'guest') {
5298: $guest = $key;
5299: } elsif ($scope eq 'domains') {
5300: push(@domains,$key);
5301: } elsif ($scope eq 'users') {
5302: push(@users,$key);
5303: } elsif ($scope eq 'course') {
5304: push(@courses,$key);
5305: } elsif ($scope eq 'group') {
5306: push(@groups,$key);
5307: }
5308: }
5309: if ($public) {
5310: return 'ok';
5311: }
5312: if ($env{'user.name'} eq 'public' && $env{'user.domain'} eq 'public') {
5313: if ($guest) {
5314: return $guest;
5315: }
5316: } else {
5317: if (@domains > 0) {
5318: foreach my $domkey (@domains) {
5319: if (ref($access_hash->{$domkey}{'dom'}) eq 'ARRAY') {
5320: if (grep(/^\Q$env{'user.domain'}\E$/,@{$access_hash->{$domkey}{'dom'}})) {
5321: return 'ok';
5322: }
5323: }
5324: }
5325: }
5326: if (@users > 0) {
5327: foreach my $userkey (@users) {
5328: if (ref($access_hash->{$userkey}{'users'}) eq 'ARRAY') {
5329: foreach my $item (@{$access_hash->{$userkey}{'users'}}) {
5330: if (ref($item) eq 'HASH') {
5331: if (($item->{'uname'} eq $env{'user.name'}) &&
5332: ($item->{'udom'} eq $env{'user.domain'})) {
5333: return 'ok';
5334: }
5335: }
5336: }
5337: }
5338: }
5339: }
5340: my %roleshash;
5341: my @courses_and_groups = @courses;
5342: push(@courses_and_groups,@groups);
5343: if (@courses_and_groups > 0) {
5344: my (%allgroups,%allroles);
5345: my ($start,$end,$role,$sec,$group);
5346: foreach my $envkey (%env) {
5347: if ($envkey =~ m-^user\.role\.(gr|cc|co|in|ta|ep|ad|st)\./($match_domain)/($match_courseid)/?([^/]*)$-) {
5348: my $cid = $2.'_'.$3;
5349: if ($1 eq 'gr') {
5350: $group = $4;
5351: $allgroups{$cid}{$group} = $env{$envkey};
5352: } else {
5353: if ($4 eq '') {
5354: $sec = 'none';
5355: } else {
5356: $sec = $4;
5357: }
5358: $allroles{$cid}{$1}{$sec} = $env{$envkey};
5359: }
5360: } elsif ($envkey =~ m-^user\.role\./cr/($match_domain/$match_username/\w*)./($match_domain)/($match_courseid)/?([^/]*)$-) {
5361: my $cid = $2.'_'.$3;
5362: if ($4 eq '') {
5363: $sec = 'none';
5364: } else {
5365: $sec = $4;
5366: }
5367: $allroles{$cid}{$1}{$sec} = $env{$envkey};
5368: }
5369: }
5370: if (keys(%allroles) == 0) {
5371: return;
5372: }
5373: foreach my $key (@courses_and_groups) {
5374: my %content = %{$$access_hash{$key}};
5375: my $cnum = $content{'number'};
5376: my $cdom = $content{'domain'};
5377: my $cid = $cdom.'_'.$cnum;
5378: if (!exists($allroles{$cid})) {
5379: next;
5380: }
5381: foreach my $role_id (keys(%{$content{'roles'}})) {
5382: my @sections = @{$content{'roles'}{$role_id}{'section'}};
5383: my @groups = @{$content{'roles'}{$role_id}{'group'}};
5384: my @status = @{$content{'roles'}{$role_id}{'access'}};
5385: my @roles = @{$content{'roles'}{$role_id}{'role'}};
5386: foreach my $role (keys(%{$allroles{$cid}})) {
5387: if ((grep/^all$/,@roles) || (grep/^\Q$role\E$/,@roles)) {
5388: foreach my $sec (keys(%{$allroles{$cid}{$role}})) {
5389: if (&course_group_datechecker($allroles{$cid}{$role}{$sec},$now,\@status) eq 'ok') {
5390: if (grep/^all$/,@sections) {
5391: return 'ok';
5392: } else {
5393: if (grep/^$sec$/,@sections) {
5394: return 'ok';
5395: }
5396: }
5397: }
5398: }
5399: if (keys(%{$allgroups{$cid}}) == 0) {
5400: if (grep/^none$/,@groups) {
5401: return 'ok';
5402: }
5403: } else {
5404: if (grep/^all$/,@groups) {
5405: return 'ok';
5406: }
5407: foreach my $group (keys(%{$allgroups{$cid}})) {
5408: if (grep/^$group$/,@groups) {
5409: return 'ok';
5410: }
5411: }
5412: }
5413: }
5414: }
5415: }
5416: }
5417: }
5418: if ($guest) {
5419: return $guest;
5420: }
5421: }
5422: }
5423: return;
5424: }
5425:
5426: sub course_group_datechecker {
5427: my ($dates,$now,$status) = @_;
5428: my ($start,$end) = split(/\./,$dates);
5429: if (!$start && !$end) {
5430: return 'ok';
5431: }
5432: if (grep/^active$/,@{$status}) {
5433: if (((!$start) || ($start && $start <= $now)) && ((!$end) || ($end && $end >= $now))) {
5434: return 'ok';
5435: }
5436: }
5437: if (grep/^previous$/,@{$status}) {
5438: if ($end > $now ) {
5439: return 'ok';
5440: }
5441: }
5442: if (grep/^future$/,@{$status}) {
5443: if ($start > $now) {
5444: return 'ok';
5445: }
5446: }
5447: return;
5448: }
5449:
5450: sub parse_portfolio_url {
5451: my ($url) = @_;
5452:
5453: my ($type,$udom,$unum,$group,$file_name);
5454:
5455: if ($url =~ m-^/*(?:uploaded|editupload)/($match_domain)/($match_username)/portfolio(/.+)$-) {
5456: $type = 1;
5457: $udom = $1;
5458: $unum = $2;
5459: $file_name = $3;
5460: } elsif ($url =~ m-^/*(?:uploaded|editupload)/($match_domain)/($match_courseid)/groups/([^/]+)/portfolio/(.+)$-) {
5461: $type = 2;
5462: $udom = $1;
5463: $unum = $2;
5464: $group = $3;
5465: $file_name = $3.'/'.$4;
5466: }
5467: if (wantarray) {
5468: return ($type,$udom,$unum,$file_name,$group);
5469: }
5470: return $type;
5471: }
5472:
5473: sub is_portfolio_url {
5474: my ($url) = @_;
5475: return scalar(&parse_portfolio_url($url));
5476: }
5477:
5478: sub is_portfolio_file {
5479: my ($file) = @_;
5480: if (($file =~ /^portfolio/) || ($file =~ /^groups\/\w+\/portfolio/)) {
5481: return 1;
5482: }
5483: return;
5484: }
5485:
5486: sub usertools_access {
5487: my ($uname,$udom,$tool,$action,$context,$userenvref,$domdefref,$is_advref)=@_;
5488: my ($access,%tools);
5489: if ($context eq '') {
5490: $context = 'tools';
5491: }
5492: if ($context eq 'requestcourses') {
5493: %tools = (
5494: official => 1,
5495: unofficial => 1,
5496: community => 1,
5497: );
5498: } else {
5499: %tools = (
5500: aboutme => 1,
5501: blog => 1,
5502: portfolio => 1,
5503: );
5504: }
5505: return if (!defined($tools{$tool}));
5506:
5507: if ((!defined($udom)) || (!defined($uname))) {
5508: $udom = $env{'user.domain'};
5509: $uname = $env{'user.name'};
5510: }
5511:
5512: if (($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'})) {
5513: if ($action ne 'reload') {
5514: if ($context eq 'requestcourses') {
5515: return $env{'environment.canrequest.'.$tool};
5516: } else {
5517: return $env{'environment.availabletools.'.$tool};
5518: }
5519: }
5520: }
5521:
5522: my ($toolstatus,$inststatus);
5523:
5524: if (($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'}) &&
5525: ($action ne 'reload')) {
5526: $toolstatus = $env{'environment.'.$context.'.'.$tool};
5527: $inststatus = $env{'environment.inststatus'};
5528: } else {
5529: if (ref($userenvref) eq 'HASH') {
5530: $toolstatus = $userenvref->{$context.'.'.$tool};
5531: $inststatus = $userenvref->{'inststatus'};
5532: } else {
5533: my %userenv = &userenvironment($udom,$uname,$context.'.'.$tool,'inststatus');
5534: $toolstatus = $userenv{$context.'.'.$tool};
5535: $inststatus = $userenv{'inststatus'};
5536: }
5537: }
5538:
5539: if ($toolstatus ne '') {
5540: if ($toolstatus) {
5541: $access = 1;
5542: } else {
5543: $access = 0;
5544: }
5545: return $access;
5546: }
5547:
5548: my ($is_adv,%domdef);
5549: if (ref($is_advref) eq 'HASH') {
5550: $is_adv = $is_advref->{'is_adv'};
5551: } else {
5552: $is_adv = &is_advanced_user($udom,$uname);
5553: }
5554: if (ref($domdefref) eq 'HASH') {
5555: %domdef = %{$domdefref};
5556: } else {
5557: %domdef = &get_domain_defaults($udom);
5558: }
5559: if (ref($domdef{$tool}) eq 'HASH') {
5560: if ($is_adv) {
5561: if ($domdef{$tool}{'_LC_adv'} ne '') {
5562: if ($domdef{$tool}{'_LC_adv'}) {
5563: $access = 1;
5564: } else {
5565: $access = 0;
5566: }
5567: return $access;
5568: }
5569: }
5570: if ($inststatus ne '') {
5571: my ($hasaccess,$hasnoaccess);
5572: foreach my $affiliation (split(/:/,$inststatus)) {
5573: if ($domdef{$tool}{$affiliation} ne '') {
5574: if ($domdef{$tool}{$affiliation}) {
5575: $hasaccess = 1;
5576: } else {
5577: $hasnoaccess = 1;
5578: }
5579: }
5580: }
5581: if ($hasaccess || $hasnoaccess) {
5582: if ($hasaccess) {
5583: $access = 1;
5584: } elsif ($hasnoaccess) {
5585: $access = 0;
5586: }
5587: return $access;
5588: }
5589: } else {
5590: if ($domdef{$tool}{'default'} ne '') {
5591: if ($domdef{$tool}{'default'}) {
5592: $access = 1;
5593: } elsif ($domdef{$tool}{'default'} == 0) {
5594: $access = 0;
5595: }
5596: return $access;
5597: }
5598: }
5599: } else {
5600: if ($context eq 'tools') {
5601: $access = 1;
5602: } else {
5603: $access = 0;
5604: }
5605: return $access;
5606: }
5607: }
5608:
5609: sub is_course_owner {
5610: my ($cdom,$cnum,$udom,$uname) = @_;
5611: if (($udom eq '') || ($uname eq '')) {
5612: $udom = $env{'user.domain'};
5613: $uname = $env{'user.name'};
5614: }
5615: unless (($udom eq '') || ($uname eq '')) {
5616: if (exists($env{'course.'.$cdom.'_'.$cnum.'.internal.courseowner'})) {
5617: if ($env{'course.'.$cdom.'_'.$cnum.'.internal.courseowner'} eq $uname.':'.$udom) {
5618: return 1;
5619: } else {
5620: my %courseinfo = &Apache::lonnet::coursedescription($cdom.'/'.$cnum);
5621: if ($courseinfo{'internal.courseowner'} eq $uname.':'.$udom) {
5622: return 1;
5623: }
5624: }
5625: }
5626: }
5627: return;
5628: }
5629:
5630: sub is_advanced_user {
5631: my ($udom,$uname) = @_;
5632: if ($udom ne '' && $uname ne '') {
5633: if (($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'})) {
5634: if (wantarray) {
5635: return ($env{'user.adv'},$env{'user.author'});
5636: } else {
5637: return $env{'user.adv'};
5638: }
5639: }
5640: }
5641: my %roleshash = &get_my_roles($uname,$udom,'userroles',undef,undef,undef,1);
5642: my %allroles;
5643: my ($is_adv,$is_author);
5644: foreach my $role (keys(%roleshash)) {
5645: my ($trest,$tdomain,$trole,$sec) = split(/:/,$role);
5646: my $area = '/'.$tdomain.'/'.$trest;
5647: if ($sec ne '') {
5648: $area .= '/'.$sec;
5649: }
5650: if (($area ne '') && ($trole ne '')) {
5651: my $spec=$trole.'.'.$area;
5652: if ($trole =~ /^cr\//) {
5653: &custom_roleprivs(\%allroles,$trole,$tdomain,$trest,$spec,$area);
5654: } elsif ($trole ne 'gr') {
5655: &standard_roleprivs(\%allroles,$trole,$tdomain,$spec,$trest,$area);
5656: }
5657: if ($trole eq 'au') {
5658: $is_author = 1;
5659: }
5660: }
5661: }
5662: foreach my $role (keys(%allroles)) {
5663: last if ($is_adv);
5664: foreach my $item (split(/:/,$allroles{$role})) {
5665: if ($item ne '') {
5666: my ($privilege,$restrictions)=split(/&/,$item);
5667: if ($privilege eq 'adv') {
5668: $is_adv = 1;
5669: last;
5670: }
5671: }
5672: }
5673: }
5674: if (wantarray) {
5675: return ($is_adv,$is_author);
5676: }
5677: return $is_adv;
5678: }
5679:
5680: sub check_can_request {
5681: my ($dom,$can_request,$request_domains) = @_;
5682: my $canreq = 0;
5683: my ($types,$typename) = &Apache::loncommon::course_types();
5684: my @options = ('approval','validate','autolimit');
5685: my $optregex = join('|',@options);
5686: if ((ref($can_request) eq 'HASH') && (ref($types) eq 'ARRAY')) {
5687: foreach my $type (@{$types}) {
5688: if (&usertools_access($env{'user.name'},
5689: $env{'user.domain'},
5690: $type,undef,'requestcourses')) {
5691: $canreq ++;
5692: if (ref($request_domains) eq 'HASH') {
5693: push(@{$request_domains->{$type}},$env{'user.domain'});
5694: }
5695: if ($dom eq $env{'user.domain'}) {
5696: $can_request->{$type} = 1;
5697: }
5698: }
5699: if ($env{'environment.reqcrsotherdom.'.$type} ne '') {
5700: my @curr = split(',',$env{'environment.reqcrsotherdom.'.$type});
5701: if (@curr > 0) {
5702: foreach my $item (@curr) {
5703: if (ref($request_domains) eq 'HASH') {
5704: my ($otherdom) = ($item =~ /^($match_domain):($optregex)(=?\d*)$/);
5705: if ($otherdom ne '') {
5706: if (ref($request_domains->{$type}) eq 'ARRAY') {
5707: unless (grep(/^\Q$otherdom\E$/,@{$request_domains->{$type}})) {
5708: push(@{$request_domains->{$type}},$otherdom);
5709: }
5710: } else {
5711: push(@{$request_domains->{$type}},$otherdom);
5712: }
5713: }
5714: }
5715: }
5716: unless($dom eq $env{'user.domain'}) {
5717: $canreq ++;
5718: if (grep(/^\Q$dom\E:($optregex)(=?\d*)$/,@curr)) {
5719: $can_request->{$type} = 1;
5720: }
5721: }
5722: }
5723: }
5724: }
5725: }
5726: return $canreq;
5727: }
5728:
5729: # ---------------------------------------------- Custom access rule evaluation
5730:
5731: sub customaccess {
5732: my ($priv,$uri)=@_;
5733: my ($urole,$urealm)=split(/\./,$env{'request.role'},2);
5734: my (undef,$udom,$ucrs,$usec)=split(/\//,$urealm);
5735: $udom = &LONCAPA::clean_domain($udom);
5736: $ucrs = &LONCAPA::clean_username($ucrs);
5737: my $access=0;
5738: foreach my $right (split(/\s*\,\s*/,&metadata($uri,'rule_rights'))) {
5739: my ($effect,$realm,$role,$type)=split(/\:/,$right);
5740: if ($type eq 'user') {
5741: foreach my $scope (split(/\s*\,\s*/,$realm)) {
5742: my ($tdom,$tuname)=split(m{/},$scope);
5743: if ($tdom) {
5744: if ($tdom ne $env{'user.domain'}) { next; }
5745: }
5746: if ($tuname) {
5747: if ($tuname ne $env{'user.name'}) { next; }
5748: }
5749: $access=($effect eq 'allow');
5750: last;
5751: }
5752: } else {
5753: if ($role) {
5754: if ($role ne $urole) { next; }
5755: }
5756: foreach my $scope (split(/\s*\,\s*/,$realm)) {
5757: my ($tdom,$tcrs,$tsec)=split(/\_/,$scope);
5758: if ($tdom) {
5759: if ($tdom ne $udom) { next; }
5760: }
5761: if ($tcrs) {
5762: if ($tcrs ne $ucrs) { next; }
5763: }
5764: if ($tsec) {
5765: if ($tsec ne $usec) { next; }
5766: }
5767: $access=($effect eq 'allow');
5768: last;
5769: }
5770: if ($realm eq '' && $role eq '') {
5771: $access=($effect eq 'allow');
5772: }
5773: }
5774: }
5775: return $access;
5776: }
5777:
5778: # ------------------------------------------------- Check for a user privilege
5779:
5780: sub allowed {
5781: my ($priv,$uri,$symb,$role)=@_;
5782: my $ver_orguri=$uri;
5783: $uri=&deversion($uri);
5784: my $orguri=$uri;
5785: $uri=&declutter($uri);
5786:
5787: if ($priv eq 'evb') {
5788: # Evade communication block restrictions for specified role in a course
5789: if ($env{'user.priv.'.$role} =~/evb\&([^\:]*)/) {
5790: return $1;
5791: } else {
5792: return;
5793: }
5794: }
5795:
5796: if (defined($env{'allowed.'.$priv})) { return $env{'allowed.'.$priv}; }
5797: # Free bre access to adm and meta resources
5798: if (((($uri=~/^adm\//) && ($uri !~ m{/(?:smppg|bulletinboard)$}))
5799: || (($uri=~/\.meta$/) && ($uri!~m|^uploaded/|) ))
5800: && ($priv eq 'bre')) {
5801: return 'F';
5802: }
5803:
5804: # Free bre access to user's own portfolio contents
5805: my ($space,$domain,$name,@dir)=split('/',$uri);
5806: if (($space=~/^(uploaded|editupload)$/) && ($env{'user.name'} eq $name) &&
5807: ($env{'user.domain'} eq $domain) && ('portfolio' eq $dir[0])) {
5808: my %setters;
5809: my ($startblock,$endblock) =
5810: &Apache::loncommon::blockcheck(\%setters,'port');
5811: if ($startblock && $endblock) {
5812: return 'B';
5813: } else {
5814: return 'F';
5815: }
5816: }
5817:
5818: # bre access to group portfolio for rgf priv in group, or mdg or vcg in course.
5819: if (($space=~/^(uploaded|editupload)$/) && ($dir[0] eq 'groups')
5820: && ($dir[2] eq 'portfolio') && ($priv eq 'bre')) {
5821: if (exists($env{'request.course.id'})) {
5822: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
5823: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
5824: if (($domain eq $cdom) && ($name eq $cnum)) {
5825: my $courseprivid=$env{'request.course.id'};
5826: $courseprivid=~s/\_/\//;
5827: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid
5828: .'/'.$dir[1]} =~/rgf\&([^\:]*)/) {
5829: return $1;
5830: } else {
5831: if ($env{'request.course.sec'}) {
5832: $courseprivid.='/'.$env{'request.course.sec'};
5833: }
5834: if ($env{'user.priv.'.$env{'request.role'}.'./'.
5835: $courseprivid} =~/(mdg|vcg)\&([^\:]*)/) {
5836: return $2;
5837: }
5838: }
5839: }
5840: }
5841: }
5842:
5843: # Free bre to public access
5844:
5845: if ($priv eq 'bre') {
5846: my $copyright=&metadata($uri,'copyright');
5847: if (($copyright eq 'public') && (!$env{'request.course.id'})) {
5848: return 'F';
5849: }
5850: if ($copyright eq 'priv') {
5851: $uri=~/([^\/]+)\/([^\/]+)\//;
5852: unless (($env{'user.name'} eq $2) && ($env{'user.domain'} eq $1)) {
5853: return '';
5854: }
5855: }
5856: if ($copyright eq 'domain') {
5857: $uri=~/([^\/]+)\/([^\/]+)\//;
5858: unless (($env{'user.domain'} eq $1) ||
5859: ($env{'course.'.$env{'request.course.id'}.'.domain'} eq $1)) {
5860: return '';
5861: }
5862: }
5863: if ($env{'request.role'}=~ /li\.\//) {
5864: # Library role, so allow browsing of resources in this domain.
5865: return 'F';
5866: }
5867: if ($copyright eq 'custom') {
5868: unless (&customaccess($priv,$uri)) { return ''; }
5869: }
5870: }
5871: # Domain coordinator is trying to create a course
5872: if (($priv eq 'ccc') && ($env{'request.role'} =~ /^dc\./)) {
5873: # uri is the requested domain in this case.
5874: # comparison to 'request.role.domain' shows if the user has selected
5875: # a role of dc for the domain in question.
5876: return 'F' if ($uri eq $env{'request.role.domain'});
5877: }
5878:
5879: my $thisallowed='';
5880: my $statecond=0;
5881: my $courseprivid='';
5882:
5883: my $ownaccess;
5884: # Community Coordinator or Assistant Co-author browsing resource space.
5885: if (($priv eq 'bro') && ($env{'user.author'})) {
5886: if ($uri eq '') {
5887: $ownaccess = 1;
5888: } else {
5889: if (($env{'user.domain'} ne '') && ($env{'user.name'} ne '')) {
5890: my $udom = $env{'user.domain'};
5891: my $uname = $env{'user.name'};
5892: if ($uri =~ m{^\Q$udom\E/?$}) {
5893: $ownaccess = 1;
5894: } elsif ($uri =~ m{^\Q$udom\E/\Q$uname\E/?}) {
5895: unless ($uri =~ m{\.\./}) {
5896: $ownaccess = 1;
5897: }
5898: } elsif (($udom ne 'public') && ($uname ne 'public')) {
5899: my $now = time;
5900: if ($uri =~ m{^([^/]+)/?$}) {
5901: my $adom = $1;
5902: foreach my $key (keys(%env)) {
5903: if ($key =~ m{^user\.role\.(ca|aa)/\Q$adom\E}) {
5904: my ($start,$end) = split('.',$env{$key});
5905: if (($now >= $start) && (!$end || $end < $now)) {
5906: $ownaccess = 1;
5907: last;
5908: }
5909: }
5910: }
5911: } elsif ($uri =~ m{^([^/]+)/([^/]+)/?}) {
5912: my $adom = $1;
5913: my $aname = $2;
5914: foreach my $role ('ca','aa') {
5915: if ($env{"user.role.$role./$adom/$aname"}) {
5916: my ($start,$end) =
5917: split('.',$env{"user.role.$role./$adom/$aname"});
5918: if (($now >= $start) && (!$end || $end < $now)) {
5919: $ownaccess = 1;
5920: last;
5921: }
5922: }
5923: }
5924: }
5925: }
5926: }
5927: }
5928: }
5929:
5930: # Course
5931:
5932: if ($env{'user.priv.'.$env{'request.role'}.'./'}=~/\Q$priv\E\&([^\:]*)/) {
5933: unless (($priv eq 'bro') && (!$ownaccess)) {
5934: $thisallowed.=$1;
5935: }
5936: }
5937:
5938: # Domain
5939:
5940: if ($env{'user.priv.'.$env{'request.role'}.'./'.(split(/\//,$uri))[0].'/'}
5941: =~/\Q$priv\E\&([^\:]*)/) {
5942: unless (($priv eq 'bro') && (!$ownaccess)) {
5943: $thisallowed.=$1;
5944: }
5945: }
5946:
5947: # User who is not author or co-author might still be able to edit
5948: # resource of an author in the domain (e.g., if Domain Coordinator).
5949: if (($priv eq 'eco') && ($thisallowed eq '') && ($env{'request.course.id'}) &&
5950: (&allowed('mdc',$env{'request.course.id'}))) {
5951: if ($env{"user.priv.cm./$uri/"}=~/\Q$priv\E\&([^\:]*)/) {
5952: $thisallowed.=$1;
5953: }
5954: }
5955:
5956: # Course: uri itself is a course
5957: my $courseuri=$uri;
5958: $courseuri=~s/\_(\d)/\/$1/;
5959: $courseuri=~s/^([^\/])/\/$1/;
5960:
5961: if ($env{'user.priv.'.$env{'request.role'}.'.'.$courseuri}
5962: =~/\Q$priv\E\&([^\:]*)/) {
5963: unless (($priv eq 'bro') && (!$ownaccess)) {
5964: $thisallowed.=$1;
5965: }
5966: }
5967:
5968: # URI is an uploaded document for this course, default permissions don't matter
5969: # not allowing 'edit' access (editupload) to uploaded course docs
5970: if (($priv eq 'bre') && ($uri=~m|^uploaded/|)) {
5971: $thisallowed='';
5972: my ($match)=&is_on_map($uri);
5973: if ($match) {
5974: if ($env{'user.priv.'.$env{'request.role'}.'./'}
5975: =~/\Q$priv\E\&([^\:]*)/) {
5976: $thisallowed.=$1;
5977: }
5978: } else {
5979: my $refuri = $env{'httpref.'.$orguri} || $env{'httpref.'.$ver_orguri};
5980: if ($refuri) {
5981: if ($refuri =~ m|^/adm/|) {
5982: $thisallowed='F';
5983: } else {
5984: $refuri=&declutter($refuri);
5985: my ($match) = &is_on_map($refuri);
5986: if ($match) {
5987: $thisallowed='F';
5988: }
5989: }
5990: }
5991: }
5992: }
5993:
5994: if ($priv eq 'bre'
5995: && $thisallowed ne 'F'
5996: && $thisallowed ne '2'
5997: && &is_portfolio_url($uri)) {
5998: $thisallowed = &portfolio_access($uri);
5999: }
6000:
6001: # Full access at system, domain or course-wide level? Exit.
6002: if ($thisallowed=~/F/) {
6003: return 'F';
6004: }
6005:
6006: # If this is generating or modifying users, exit with special codes
6007:
6008: if (':csu:cdc:ccc:cin:cta:cep:ccr:cst:cad:cli:cau:cdg:cca:caa:'=~/\:\Q$priv\E\:/) {
6009: if (($priv eq 'cca') || ($priv eq 'caa')) {
6010: my ($audom,$auname)=split('/',$uri);
6011: # no author name given, so this just checks on the general right to make a co-author in this domain
6012: unless ($auname) { return $thisallowed; }
6013: # an author name is given, so we are about to actually make a co-author for a certain account
6014: if (($auname ne $env{'user.name'} && $env{'request.role'} !~ /^dc\./) ||
6015: (($audom ne $env{'user.domain'} && $env{'request.role'} !~ /^dc\./) &&
6016: ($audom ne $env{'request.role.domain'}))) { return ''; }
6017: }
6018: return $thisallowed;
6019: }
6020: #
6021: # Gathered so far: system, domain and course wide privileges
6022: #
6023: # Course: See if uri or referer is an individual resource that is part of
6024: # the course
6025:
6026: if ($env{'request.course.id'}) {
6027:
6028: $courseprivid=$env{'request.course.id'};
6029: if ($env{'request.course.sec'}) {
6030: $courseprivid.='/'.$env{'request.course.sec'};
6031: }
6032: $courseprivid=~s/\_/\//;
6033: my $checkreferer=1;
6034: my ($match,$cond)=&is_on_map($uri);
6035: if ($match) {
6036: $statecond=$cond;
6037: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid}
6038: =~/\Q$priv\E\&([^\:]*)/) {
6039: $thisallowed.=$1;
6040: $checkreferer=0;
6041: }
6042: }
6043:
6044: if ($checkreferer) {
6045: my $refuri=$env{'httpref.'.$orguri};
6046: unless ($refuri) {
6047: foreach my $key (keys(%env)) {
6048: if ($key=~/^httpref\..*\*/) {
6049: my $pattern=$key;
6050: $pattern=~s/^httpref\.\/res\///;
6051: $pattern=~s/\*/\[\^\/\]\+/g;
6052: $pattern=~s/\//\\\//g;
6053: if ($orguri=~/$pattern/) {
6054: $refuri=$env{$key};
6055: }
6056: }
6057: }
6058: }
6059:
6060: if ($refuri) {
6061: $refuri=&declutter($refuri);
6062: my ($match,$cond)=&is_on_map($refuri);
6063: if ($match) {
6064: my $refstatecond=$cond;
6065: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid}
6066: =~/\Q$priv\E\&([^\:]*)/) {
6067: $thisallowed.=$1;
6068: $uri=$refuri;
6069: $statecond=$refstatecond;
6070: }
6071: }
6072: }
6073: }
6074: }
6075:
6076: #
6077: # Gathered now: all privileges that could apply, and condition number
6078: #
6079: #
6080: # Full or no access?
6081: #
6082:
6083: if ($thisallowed=~/F/) {
6084: return 'F';
6085: }
6086:
6087: unless ($thisallowed) {
6088: return '';
6089: }
6090:
6091: # Restrictions exist, deal with them
6092: #
6093: # C:according to course preferences
6094: # R:according to resource settings
6095: # L:unless locked
6096: # X:according to user session state
6097: #
6098:
6099: # Possibly locked functionality, check all courses
6100: # Locks might take effect only after 10 minutes cache expiration for other
6101: # courses, and 2 minutes for current course
6102:
6103: my $envkey;
6104: if ($thisallowed=~/L/) {
6105: foreach $envkey (keys(%env)) {
6106: if ($envkey=~/^user\.role\.(st|ta)\.([^\.]*)/) {
6107: my $courseid=$2;
6108: my $roleid=$1.'.'.$2;
6109: $courseid=~s/^\///;
6110: my $expiretime=600;
6111: if ($env{'request.role'} eq $roleid) {
6112: $expiretime=120;
6113: }
6114: my ($cdom,$cnum,$csec)=split(/\//,$courseid);
6115: my $prefix='course.'.$cdom.'_'.$cnum.'.';
6116: if ((time-$env{$prefix.'last_cache'})>$expiretime) {
6117: &coursedescription($courseid,{'freshen_cache' => 1});
6118: }
6119: if (($env{$prefix.'res.'.$uri.'.lock.sections'}=~/\,\Q$csec\E\,/)
6120: || ($env{$prefix.'res.'.$uri.'.lock.sections'} eq 'all')) {
6121: if ($env{$prefix.'res.'.$uri.'.lock.expire'}>time) {
6122: &log($env{'user.domain'},$env{'user.name'},
6123: $env{'user.home'},
6124: 'Locked by res: '.$priv.' for '.$uri.' due to '.
6125: $cdom.'/'.$cnum.'/'.$csec.' expire '.
6126: $env{$prefix.'priv.'.$priv.'.lock.expire'});
6127: return '';
6128: }
6129: }
6130: if (($env{$prefix.'priv.'.$priv.'.lock.sections'}=~/\,\Q$csec\E\,/)
6131: || ($env{$prefix.'priv.'.$priv.'.lock.sections'} eq 'all')) {
6132: if ($env{'priv.'.$priv.'.lock.expire'}>time) {
6133: &log($env{'user.domain'},$env{'user.name'},
6134: $env{'user.home'},
6135: 'Locked by priv: '.$priv.' for '.$uri.' due to '.
6136: $cdom.'/'.$cnum.'/'.$csec.' expire '.
6137: $env{$prefix.'priv.'.$priv.'.lock.expire'});
6138: return '';
6139: }
6140: }
6141: }
6142: }
6143: }
6144:
6145: #
6146: # Rest of the restrictions depend on selected course
6147: #
6148:
6149: unless ($env{'request.course.id'}) {
6150: if ($thisallowed eq 'A') {
6151: return 'A';
6152: } elsif ($thisallowed eq 'B') {
6153: return 'B';
6154: } else {
6155: return '1';
6156: }
6157: }
6158:
6159: #
6160: # Now user is definitely in a course
6161: #
6162:
6163:
6164: # Course preferences
6165:
6166: if ($thisallowed=~/C/) {
6167: my $rolecode=(split(/\./,$env{'request.role'}))[0];
6168: my $unamedom=$env{'user.name'}.':'.$env{'user.domain'};
6169: if ($env{'course.'.$env{'request.course.id'}.'.'.$priv.'.roles.denied'}
6170: =~/\Q$rolecode\E/) {
6171: if (($priv ne 'pch') && ($priv ne 'plc')) {
6172: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.':'.
6173: 'Denied by role: '.$priv.' for '.$uri.' as '.$rolecode.' in '.
6174: $env{'request.course.id'});
6175: }
6176: return '';
6177: }
6178:
6179: if ($env{'course.'.$env{'request.course.id'}.'.'.$priv.'.users.denied'}
6180: =~/\Q$unamedom\E/) {
6181: if (($priv ne 'pch') && ($priv ne 'plc')) {
6182: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.
6183: 'Denied by user: '.$priv.' for '.$uri.' as '.$unamedom.' in '.
6184: $env{'request.course.id'});
6185: }
6186: return '';
6187: }
6188: }
6189:
6190: # Resource preferences
6191:
6192: if ($thisallowed=~/R/) {
6193: my $rolecode=(split(/\./,$env{'request.role'}))[0];
6194: if (&metadata($uri,'roledeny')=~/\Q$rolecode\E/) {
6195: if (($priv ne 'pch') && ($priv ne 'plc')) {
6196: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.':'.
6197: 'Denied by role: '.$priv.' for '.$uri.' as '.$rolecode);
6198: }
6199: return '';
6200: }
6201: }
6202:
6203: # Restricted by state or randomout?
6204:
6205: if ($thisallowed=~/X/) {
6206: if ($env{'acc.randomout'}) {
6207: if (!$symb) { $symb=&symbread($uri,1); }
6208: if (($symb) && ($env{'acc.randomout'}=~/\&\Q$symb\E\&/)) {
6209: return '';
6210: }
6211: }
6212: if (&condval($statecond)) {
6213: return '2';
6214: } else {
6215: return '';
6216: }
6217: }
6218:
6219: if ($thisallowed eq 'A') {
6220: return 'A';
6221: } elsif ($thisallowed eq 'B') {
6222: return 'B';
6223: }
6224: return 'F';
6225: }
6226: #
6227: # Removes the versino from a URI and
6228: # splits it in to its filename and path to the filename.
6229: # Seems like File::Basename could have done this more clearly.
6230: # Parameters:
6231: # $uri - input URI
6232: # Returns:
6233: # Two element list consisting of
6234: # $pathname - the URI up to and excluding the trailing /
6235: # $filename - The part of the URI following the last /
6236: # NOTE:
6237: # Another realization of this is simply:
6238: # use File::Basename;
6239: # ...
6240: # $uri = shift;
6241: # $filename = basename($uri);
6242: # $path = dirname($uri);
6243: # return ($filename, $path);
6244: #
6245: # The implementation below is probably faster however.
6246: #
6247: sub split_uri_for_cond {
6248: my $uri=&deversion(&declutter(shift));
6249: my @uriparts=split(/\//,$uri);
6250: my $filename=pop(@uriparts);
6251: my $pathname=join('/',@uriparts);
6252: return ($pathname,$filename);
6253: }
6254: # --------------------------------------------------- Is a resource on the map?
6255:
6256: sub is_on_map {
6257: my ($pathname,$filename) = &split_uri_for_cond(shift);
6258: #Trying to find the conditional for the file
6259: my $match=($env{'acc.res.'.$env{'request.course.id'}.'.'.$pathname}=~
6260: /\&\Q$filename\E\:([\d\|]+)\&/);
6261: if ($match) {
6262: return (1,$1);
6263: } else {
6264: return (0,0);
6265: }
6266: }
6267:
6268: # --------------------------------------------------------- Get symb from alias
6269:
6270: sub get_symb_from_alias {
6271: my $symb=shift;
6272: my ($map,$resid,$url)=&decode_symb($symb);
6273: # Already is a symb
6274: if ($url) { return $symb; }
6275: # Must be an alias
6276: my $aliassymb='';
6277: my %bighash;
6278: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
6279: &GDBM_READER(),0640)) {
6280: my $rid=$bighash{'mapalias_'.$symb};
6281: if ($rid) {
6282: my ($mapid,$resid)=split(/\./,$rid);
6283: $aliassymb=&encode_symb($bighash{'map_id_'.$mapid},
6284: $resid,$bighash{'src_'.$rid});
6285: }
6286: untie %bighash;
6287: }
6288: return $aliassymb;
6289: }
6290:
6291: # ----------------------------------------------------------------- Define Role
6292:
6293: sub definerole {
6294: if (allowed('mcr','/')) {
6295: my ($rolename,$sysrole,$domrole,$courole)=@_;
6296: foreach my $role (split(':',$sysrole)) {
6297: my ($crole,$cqual)=split(/\&/,$role);
6298: if ($pr{'cr:s'}!~/\Q$crole\E/) { return "refused:s:$crole"; }
6299: if ($pr{'cr:s'}=~/\Q$crole\E\&/) {
6300: if ($pr{'cr:s'}!~/\Q$crole\E\&\w*\Q$cqual\E/) {
6301: return "refused:s:$crole&$cqual";
6302: }
6303: }
6304: }
6305: foreach my $role (split(':',$domrole)) {
6306: my ($crole,$cqual)=split(/\&/,$role);
6307: if ($pr{'cr:d'}!~/\Q$crole\E/) { return "refused:d:$crole"; }
6308: if ($pr{'cr:d'}=~/\Q$crole\E\&/) {
6309: if ($pr{'cr:d'}!~/\Q$crole\W\&\w*\Q$cqual\E/) {
6310: return "refused:d:$crole&$cqual";
6311: }
6312: }
6313: }
6314: foreach my $role (split(':',$courole)) {
6315: my ($crole,$cqual)=split(/\&/,$role);
6316: if ($pr{'cr:c'}!~/\Q$crole\E/) { return "refused:c:$crole"; }
6317: if ($pr{'cr:c'}=~/\Q$crole\E\&/) {
6318: if ($pr{'cr:c'}!~/\Q$crole\E\&\w*\Q$cqual\E/) {
6319: return "refused:c:$crole&$cqual";
6320: }
6321: }
6322: }
6323: my $command="encrypt:rolesput:$env{'user.domain'}:$env{'user.name'}:".
6324: "$env{'user.domain'}:$env{'user.name'}:".
6325: "rolesdef_$rolename=".
6326: escape($sysrole.'_'.$domrole.'_'.$courole);
6327: return reply($command,$env{'user.home'});
6328: } else {
6329: return 'refused';
6330: }
6331: }
6332:
6333: # ---------------- Make a metadata query against the network of library servers
6334:
6335: sub metadata_query {
6336: my ($query,$custom,$customshow,$server_array)=@_;
6337: my %rhash;
6338: my %libserv = &all_library();
6339: my @server_list = (defined($server_array) ? @$server_array
6340: : keys(%libserv) );
6341: for my $server (@server_list) {
6342: unless ($custom or $customshow) {
6343: my $reply=&reply("querysend:".&escape($query),$server);
6344: $rhash{$server}=$reply;
6345: }
6346: else {
6347: my $reply=&reply("querysend:".&escape($query).':'.
6348: &escape($custom).':'.&escape($customshow),
6349: $server);
6350: $rhash{$server}=$reply;
6351: }
6352: }
6353: return \%rhash;
6354: }
6355:
6356: # ----------------------------------------- Send log queries and wait for reply
6357:
6358: sub log_query {
6359: my ($uname,$udom,$query,%filters)=@_;
6360: my $uhome=&homeserver($uname,$udom);
6361: if ($uhome eq 'no_host') { return 'error: no_host'; }
6362: my $uhost=&hostname($uhome);
6363: my $command=&escape(join(':',map{$_.'='.$filters{$_}} keys(%filters)));
6364: my $queryid=&reply("querysend:".$query.':'.$udom.':'.$uname.':'.$command,
6365: $uhome);
6366: unless ($queryid=~/^\Q$uhost\E\_/) { return 'error: '.$queryid; }
6367: return get_query_reply($queryid);
6368: }
6369:
6370: # -------------------------- Update MySQL table for portfolio file
6371:
6372: sub update_portfolio_table {
6373: my ($uname,$udom,$file_name,$query,$group,$action) = @_;
6374: if ($group ne '') {
6375: $file_name =~s /^\Q$group\E//;
6376: }
6377: my $homeserver = &homeserver($uname,$udom);
6378: my $queryid=
6379: &reply("querysend:".$query.':'.&escape($uname.':'.$udom.':'.$group).
6380: ':'.&escape($file_name).':'.$action,$homeserver);
6381: my $reply = &get_query_reply($queryid);
6382: return $reply;
6383: }
6384:
6385: # -------------------------- Update MySQL allusers table
6386:
6387: sub update_allusers_table {
6388: my ($uname,$udom,$names) = @_;
6389: my $homeserver = &homeserver($uname,$udom);
6390: my $queryid=
6391: &reply('querysend:allusers:'.&escape($uname).':'.&escape($udom).':'.
6392: 'lastname='.&escape($names->{'lastname'}).'%%'.
6393: 'firstname='.&escape($names->{'firstname'}).'%%'.
6394: 'middlename='.&escape($names->{'middlename'}).'%%'.
6395: 'generation='.&escape($names->{'generation'}).'%%'.
6396: 'permanentemail='.&escape($names->{'permanentemail'}).'%%'.
6397: 'id='.&escape($names->{'id'}),$homeserver);
6398: return;
6399: }
6400:
6401: # ------- Request retrieval of institutional classlists for course(s)
6402:
6403: sub fetch_enrollment_query {
6404: my ($context,$affiliatesref,$replyref,$dom,$cnum) = @_;
6405: my $homeserver;
6406: my $maxtries = 1;
6407: if ($context eq 'automated') {
6408: $homeserver = $perlvar{'lonHostID'};
6409: $maxtries = 10; # will wait for up to 2000s for retrieval of classlist data before timeout
6410: } else {
6411: $homeserver = &homeserver($cnum,$dom);
6412: }
6413: my $host=&hostname($homeserver);
6414: my $cmd = '';
6415: foreach my $affiliate (keys(%{$affiliatesref})) {
6416: $cmd .= $affiliate.'='.join(",",@{$$affiliatesref{$affiliate}}).'%%';
6417: }
6418: $cmd =~ s/%%$//;
6419: $cmd = &escape($cmd);
6420: my $query = 'fetchenrollment';
6421: my $queryid=&reply("querysend:".$query.':'.$dom.':'.$env{'user.name'}.':'.$cmd,$homeserver);
6422: unless ($queryid=~/^\Q$host\E\_/) {
6423: &logthis('fetch_enrollment_query: invalid queryid: '.$queryid.' for host: '.$host.' and homeserver: '.$homeserver.' context: '.$context.' '.$cnum);
6424: return 'error: '.$queryid;
6425: }
6426: my $reply = &get_query_reply($queryid);
6427: my $tries = 1;
6428: while (($reply=~/^timeout/) && ($tries < $maxtries)) {
6429: $reply = &get_query_reply($queryid);
6430: $tries ++;
6431: }
6432: if ( ($reply =~/^timeout/) || ($reply =~/^error/) ) {
6433: &logthis('fetch_enrollment_query error: '.$reply.' for '.$dom.' '.$env{'user.name'}.' for '.$queryid.' context: '.$context.' '.$cnum.' maxtries: '.$maxtries.' tries: '.$tries);
6434: } else {
6435: my @responses = split(/:/,$reply);
6436: if ($homeserver eq $perlvar{'lonHostID'}) {
6437: foreach my $line (@responses) {
6438: my ($key,$value) = split(/=/,$line,2);
6439: $$replyref{$key} = $value;
6440: }
6441: } else {
6442: my $pathname = LONCAPA::tempdir();
6443: foreach my $line (@responses) {
6444: my ($key,$value) = split(/=/,$line);
6445: $$replyref{$key} = $value;
6446: if ($value > 0) {
6447: foreach my $item (@{$$affiliatesref{$key}}) {
6448: my $filename = $dom.'_'.$key.'_'.$item.'_classlist.xml';
6449: my $destname = $pathname.'/'.$filename;
6450: my $xml_classlist = &reply("autoretrieve:".$filename,$homeserver);
6451: if ($xml_classlist =~ /^error/) {
6452: &logthis('fetch_enrollment_query - autoretrieve error: '.$xml_classlist.' for '.$filename.' from server: '.$homeserver.' '.$context.' '.$cnum);
6453: } else {
6454: if ( open(FILE,">$destname") ) {
6455: print FILE &unescape($xml_classlist);
6456: close(FILE);
6457: } else {
6458: &logthis('fetch_enrollment_query - error opening classlist file '.$destname.' '.$context.' '.$cnum);
6459: }
6460: }
6461: }
6462: }
6463: }
6464: }
6465: return 'ok';
6466: }
6467: return 'error';
6468: }
6469:
6470: sub get_query_reply {
6471: my $queryid=shift;
6472: my $replyfile=LONCAPA::tempdir().$queryid;
6473: my $reply='';
6474: for (1..100) {
6475: sleep 2;
6476: if (-e $replyfile.'.end') {
6477: if (open(my $fh,$replyfile)) {
6478: $reply = join('',<$fh>);
6479: close($fh);
6480: } else { return 'error: reply_file_error'; }
6481: return &unescape($reply);
6482: }
6483: }
6484: return 'timeout:'.$queryid;
6485: }
6486:
6487: sub courselog_query {
6488: #
6489: # possible filters:
6490: # url: url or symb
6491: # username
6492: # domain
6493: # action: view, submit, grade
6494: # start: timestamp
6495: # end: timestamp
6496: #
6497: my (%filters)=@_;
6498: unless ($env{'request.course.id'}) { return 'no_course'; }
6499: if ($filters{'url'}) {
6500: $filters{'url'}=&symbclean(&declutter($filters{'url'}));
6501: $filters{'url'}=~s/\.(\w+)$/(\\.\\d+)*\\.$1/;
6502: $filters{'url'}=~s/\.(\w+)\_\_\_/(\\.\\d+)*\\.$1/;
6503: }
6504: my $cname=$env{'course.'.$env{'request.course.id'}.'.num'};
6505: my $cdom=$env{'course.'.$env{'request.course.id'}.'.domain'};
6506: return &log_query($cname,$cdom,'courselog',%filters);
6507: }
6508:
6509: sub userlog_query {
6510: #
6511: # possible filters:
6512: # action: log check role
6513: # start: timestamp
6514: # end: timestamp
6515: #
6516: my ($uname,$udom,%filters)=@_;
6517: return &log_query($uname,$udom,'userlog',%filters);
6518: }
6519:
6520: #--------- Call auto-enrollment subs in localenroll.pm for homeserver for course
6521:
6522: sub auto_run {
6523: my ($cnum,$cdom) = @_;
6524: my $response = 0;
6525: my $settings;
6526: my %domconfig = &get_dom('configuration',['autoenroll'],$cdom);
6527: if (ref($domconfig{'autoenroll'}) eq 'HASH') {
6528: $settings = $domconfig{'autoenroll'};
6529: if ($settings->{'run'} eq '1') {
6530: $response = 1;
6531: }
6532: } else {
6533: my $homeserver;
6534: if (&is_course($cdom,$cnum)) {
6535: $homeserver = &homeserver($cnum,$cdom);
6536: } else {
6537: $homeserver = &domain($cdom,'primary');
6538: }
6539: if ($homeserver ne 'no_host') {
6540: $response = &reply('autorun:'.$cdom,$homeserver);
6541: }
6542: }
6543: return $response;
6544: }
6545:
6546: sub auto_get_sections {
6547: my ($cnum,$cdom,$inst_coursecode) = @_;
6548: my $homeserver;
6549: if (($cdom =~ /^$match_domain$/) && ($cnum =~ /^$match_courseid$/)) {
6550: $homeserver = &homeserver($cnum,$cdom);
6551: }
6552: if (!defined($homeserver)) {
6553: if ($cdom =~ /^$match_domain$/) {
6554: $homeserver = &domain($cdom,'primary');
6555: }
6556: }
6557: my @secs;
6558: if (defined($homeserver)) {
6559: my $response=&unescape(&reply('autogetsections:'.$inst_coursecode.':'.$cdom,$homeserver));
6560: unless ($response eq 'refused') {
6561: @secs = split(/:/,$response);
6562: }
6563: }
6564: return @secs;
6565: }
6566:
6567: sub auto_new_course {
6568: my ($cnum,$cdom,$inst_course_id,$owner,$coowners) = @_;
6569: my $homeserver = &homeserver($cnum,$cdom);
6570: my $response=&unescape(&reply('autonewcourse:'.$inst_course_id.':'.&escape($owner).':'.$cdom.':'.&escape($coowners),$homeserver));
6571: return $response;
6572: }
6573:
6574: sub auto_validate_courseID {
6575: my ($cnum,$cdom,$inst_course_id) = @_;
6576: my $homeserver = &homeserver($cnum,$cdom);
6577: my $response=&unescape(&reply('autovalidatecourse:'.$inst_course_id.':'.$cdom,$homeserver));
6578: return $response;
6579: }
6580:
6581: sub auto_validate_instcode {
6582: my ($cnum,$cdom,$instcode,$owner) = @_;
6583: my ($homeserver,$response);
6584: if (($cdom =~ /^$match_domain$/) && ($cnum =~ /^$match_courseid$/)) {
6585: $homeserver = &homeserver($cnum,$cdom);
6586: }
6587: if (!defined($homeserver)) {
6588: if ($cdom =~ /^$match_domain$/) {
6589: $homeserver = &domain($cdom,'primary');
6590: }
6591: }
6592: $response=&unescape(&reply('autovalidateinstcode:'.$cdom.':'.
6593: &escape($instcode).':'.&escape($owner),$homeserver));
6594: my ($outcome,$description) = map { &unescape($_); } split('&',$response,2);
6595: return ($outcome,$description);
6596: }
6597:
6598: sub auto_create_password {
6599: my ($cnum,$cdom,$authparam,$udom) = @_;
6600: my ($homeserver,$response);
6601: my $create_passwd = 0;
6602: my $authchk = '';
6603: if ($udom =~ /^$match_domain$/) {
6604: $homeserver = &domain($udom,'primary');
6605: }
6606: if ($homeserver eq '') {
6607: if (($cdom =~ /^$match_domain$/) && ($cnum =~ /^$match_courseid$/)) {
6608: $homeserver = &homeserver($cnum,$cdom);
6609: }
6610: }
6611: if ($homeserver eq '') {
6612: $authchk = 'nodomain';
6613: } else {
6614: $response=&unescape(&reply('autocreatepassword:'.$authparam.':'.$cdom,$homeserver));
6615: if ($response eq 'refused') {
6616: $authchk = 'refused';
6617: } else {
6618: ($authparam,$create_passwd,$authchk) = split(/:/,$response);
6619: }
6620: }
6621: return ($authparam,$create_passwd,$authchk);
6622: }
6623:
6624: sub auto_photo_permission {
6625: my ($cnum,$cdom,$students) = @_;
6626: my $homeserver = &homeserver($cnum,$cdom);
6627: my ($outcome,$perm_reqd,$conditions) =
6628: split(/:/,&unescape(&reply('autophotopermission:'.$cdom,$homeserver)),3);
6629: if ($outcome =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
6630: return (undef,undef);
6631: }
6632: return ($outcome,$perm_reqd,$conditions);
6633: }
6634:
6635: sub auto_checkphotos {
6636: my ($uname,$udom,$pid) = @_;
6637: my $homeserver = &homeserver($uname,$udom);
6638: my ($result,$resulttype);
6639: my $outcome = &unescape(&reply('autophotocheck:'.&escape($udom).':'.
6640: &escape($uname).':'.&escape($pid),
6641: $homeserver));
6642: if ($outcome =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
6643: return (undef,undef);
6644: }
6645: if ($outcome) {
6646: ($result,$resulttype) = split(/:/,$outcome);
6647: }
6648: return ($result,$resulttype);
6649: }
6650:
6651: sub auto_photochoice {
6652: my ($cnum,$cdom) = @_;
6653: my $homeserver = &homeserver($cnum,$cdom);
6654: my ($update,$comment) = split(/:/,&unescape(&reply('autophotochoice:'.
6655: &escape($cdom),
6656: $homeserver)));
6657: if ($update =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
6658: return (undef,undef);
6659: }
6660: return ($update,$comment);
6661: }
6662:
6663: sub auto_photoupdate {
6664: my ($affiliatesref,$dom,$cnum,$photo) = @_;
6665: my $homeserver = &homeserver($cnum,$dom);
6666: my $host=&hostname($homeserver);
6667: my $cmd = '';
6668: my $maxtries = 1;
6669: foreach my $affiliate (keys(%{$affiliatesref})) {
6670: $cmd .= $affiliate.'='.join(",",@{$$affiliatesref{$affiliate}}).'%%';
6671: }
6672: $cmd =~ s/%%$//;
6673: $cmd = &escape($cmd);
6674: my $query = 'institutionalphotos';
6675: my $queryid=&reply("querysend:".$query.':'.$dom.':'.$cnum.':'.$cmd,$homeserver);
6676: unless ($queryid=~/^\Q$host\E\_/) {
6677: &logthis('institutionalphotos: invalid queryid: '.$queryid.' for host: '.$host.' and homeserver: '.$homeserver.' and course: '.$cnum);
6678: return 'error: '.$queryid;
6679: }
6680: my $reply = &get_query_reply($queryid);
6681: my $tries = 1;
6682: while (($reply=~/^timeout/) && ($tries < $maxtries)) {
6683: $reply = &get_query_reply($queryid);
6684: $tries ++;
6685: }
6686: if ( ($reply =~/^timeout/) || ($reply =~/^error/) ) {
6687: &logthis('institutionalphotos error: '.$reply.' for '.$dom.' '.$env{'user.name'}.' for '.$queryid.' course: '.$cnum.' maxtries: '.$maxtries.' tries: '.$tries);
6688: } else {
6689: my @responses = split(/:/,$reply);
6690: my $outcome = shift(@responses);
6691: foreach my $item (@responses) {
6692: my ($key,$value) = split(/=/,$item);
6693: $$photo{$key} = $value;
6694: }
6695: return $outcome;
6696: }
6697: return 'error';
6698: }
6699:
6700: sub auto_instcode_format {
6701: my ($caller,$codedom,$instcodes,$codes,$codetitles,$cat_titles,
6702: $cat_order) = @_;
6703: my $courses = '';
6704: my @homeservers;
6705: if ($caller eq 'global') {
6706: my %servers = &get_servers($codedom,'library');
6707: foreach my $tryserver (keys(%servers)) {
6708: if (!grep(/^\Q$tryserver\E$/,@homeservers)) {
6709: push(@homeservers,$tryserver);
6710: }
6711: }
6712: } elsif ($caller eq 'requests') {
6713: if ($codedom =~ /^$match_domain$/) {
6714: my $chome = &domain($codedom,'primary');
6715: unless ($chome eq 'no_host') {
6716: push(@homeservers,$chome);
6717: }
6718: }
6719: } else {
6720: push(@homeservers,&homeserver($caller,$codedom));
6721: }
6722: foreach my $code (keys(%{$instcodes})) {
6723: $courses .= &escape($code).'='.&escape($$instcodes{$code}).'&';
6724: }
6725: chop($courses);
6726: my $ok_response = 0;
6727: my $response;
6728: while (@homeservers > 0 && $ok_response == 0) {
6729: my $server = shift(@homeservers);
6730: $response=&reply('autoinstcodeformat:'.$codedom.':'.$courses,$server);
6731: if ($response !~ /(con_lost|error|no_such_host|refused)/) {
6732: my ($codes_str,$codetitles_str,$cat_titles_str,$cat_order_str) =
6733: split(/:/,$response);
6734: %{$codes} = (%{$codes},&str2hash($codes_str));
6735: push(@{$codetitles},&str2array($codetitles_str));
6736: %{$cat_titles} = (%{$cat_titles},&str2hash($cat_titles_str));
6737: %{$cat_order} = (%{$cat_order},&str2hash($cat_order_str));
6738: $ok_response = 1;
6739: }
6740: }
6741: if ($ok_response) {
6742: return 'ok';
6743: } else {
6744: return $response;
6745: }
6746: }
6747:
6748: sub auto_instcode_defaults {
6749: my ($domain,$returnhash,$code_order) = @_;
6750: my @homeservers;
6751:
6752: my %servers = &get_servers($domain,'library');
6753: foreach my $tryserver (keys(%servers)) {
6754: if (!grep(/^\Q$tryserver\E$/,@homeservers)) {
6755: push(@homeservers,$tryserver);
6756: }
6757: }
6758:
6759: my $response;
6760: foreach my $server (@homeservers) {
6761: $response=&reply('autoinstcodedefaults:'.$domain,$server);
6762: next if ($response =~ /(con_lost|error|no_such_host|refused)/);
6763:
6764: foreach my $pair (split(/\&/,$response)) {
6765: my ($name,$value)=split(/\=/,$pair);
6766: if ($name eq 'code_order') {
6767: @{$code_order} = split(/\&/,&unescape($value));
6768: } else {
6769: $returnhash->{&unescape($name)}=&unescape($value);
6770: }
6771: }
6772: return 'ok';
6773: }
6774:
6775: return $response;
6776: }
6777:
6778: sub auto_possible_instcodes {
6779: my ($domain,$codetitles,$cat_titles,$cat_orders,$code_order) = @_;
6780: unless ((ref($codetitles) eq 'ARRAY') && (ref($cat_titles) eq 'HASH') &&
6781: (ref($cat_orders) eq 'HASH') && (ref($code_order) eq 'ARRAY')) {
6782: return;
6783: }
6784: my (@homeservers,$uhome);
6785: if (defined(&domain($domain,'primary'))) {
6786: $uhome=&domain($domain,'primary');
6787: push(@homeservers,&domain($domain,'primary'));
6788: } else {
6789: my %servers = &get_servers($domain,'library');
6790: foreach my $tryserver (keys(%servers)) {
6791: if (!grep(/^\Q$tryserver\E$/,@homeservers)) {
6792: push(@homeservers,$tryserver);
6793: }
6794: }
6795: }
6796: my $response;
6797: foreach my $server (@homeservers) {
6798: $response=&reply('autopossibleinstcodes:'.$domain,$server);
6799: next if ($response =~ /(con_lost|error|no_such_host|refused)/);
6800: my ($codetitlestr,$codeorderstr,$cat_title,$cat_order) =
6801: split(':',$response);
6802: @{$codetitles} = map { &unescape($_); } (split('&',$codetitlestr));
6803: @{$code_order} = map { &unescape($_); } (split('&',$codeorderstr));
6804: foreach my $item (split('&',$cat_title)) {
6805: my ($name,$value)=split('=',$item);
6806: $cat_titles->{&unescape($name)}=&thaw_unescape($value);
6807: }
6808: foreach my $item (split('&',$cat_order)) {
6809: my ($name,$value)=split('=',$item);
6810: $cat_orders->{&unescape($name)}=&thaw_unescape($value);
6811: }
6812: return 'ok';
6813: }
6814: return $response;
6815: }
6816:
6817: sub auto_courserequest_checks {
6818: my ($dom) = @_;
6819: my ($homeserver,%validations);
6820: if ($dom =~ /^$match_domain$/) {
6821: $homeserver = &domain($dom,'primary');
6822: }
6823: unless ($homeserver eq 'no_host') {
6824: my $response=&reply('autocrsreqchecks:'.$dom,$homeserver);
6825: unless ($response =~ /(con_lost|error|no_such_host|refused)/) {
6826: my @items = split(/&/,$response);
6827: foreach my $item (@items) {
6828: my ($key,$value) = split('=',$item);
6829: $validations{&unescape($key)} = &thaw_unescape($value);
6830: }
6831: }
6832: }
6833: return %validations;
6834: }
6835:
6836: sub auto_courserequest_validation {
6837: my ($dom,$owner,$crstype,$inststatuslist,$instcode,$instseclist) = @_;
6838: my ($homeserver,$response);
6839: if ($dom =~ /^$match_domain$/) {
6840: $homeserver = &domain($dom,'primary');
6841: }
6842: unless ($homeserver eq 'no_host') {
6843:
6844: $response=&unescape(&reply('autocrsreqvalidation:'.$dom.':'.&escape($owner).
6845: ':'.&escape($crstype).':'.&escape($inststatuslist).
6846: ':'.&escape($instcode).':'.&escape($instseclist),
6847: $homeserver));
6848: }
6849: return $response;
6850: }
6851:
6852: sub auto_validate_class_sec {
6853: my ($cdom,$cnum,$owners,$inst_class) = @_;
6854: my $homeserver = &homeserver($cnum,$cdom);
6855: my $ownerlist;
6856: if (ref($owners) eq 'ARRAY') {
6857: $ownerlist = join(',',@{$owners});
6858: } else {
6859: $ownerlist = $owners;
6860: }
6861: my $response=&reply('autovalidateclass_sec:'.$inst_class.':'.
6862: &escape($ownerlist).':'.$cdom,$homeserver);
6863: return $response;
6864: }
6865:
6866: # ------------------------------------------------------- Course Group routines
6867:
6868: sub get_coursegroups {
6869: my ($cdom,$cnum,$group,$namespace) = @_;
6870: return(&dump($namespace,$cdom,$cnum,$group));
6871: }
6872:
6873: sub modify_coursegroup {
6874: my ($cdom,$cnum,$groupsettings) = @_;
6875: return(&put('coursegroups',$groupsettings,$cdom,$cnum));
6876: }
6877:
6878: sub toggle_coursegroup_status {
6879: my ($cdom,$cnum,$group,$action) = @_;
6880: my ($from_namespace,$to_namespace);
6881: if ($action eq 'delete') {
6882: $from_namespace = 'coursegroups';
6883: $to_namespace = 'deleted_groups';
6884: } else {
6885: $from_namespace = 'deleted_groups';
6886: $to_namespace = 'coursegroups';
6887: }
6888: my %curr_group = &get_coursegroups($cdom,$cnum,$group,$from_namespace);
6889: if (my $tmp = &error(%curr_group)) {
6890: &Apache::lonnet::logthis('Error retrieving group: '.$tmp.' in '.$cnum.':'.$cdom);
6891: return ('read error',$tmp);
6892: } else {
6893: my %savedsettings = %curr_group;
6894: my $result = &put($to_namespace,\%savedsettings,$cdom,$cnum);
6895: my $deloutcome;
6896: if ($result eq 'ok') {
6897: $deloutcome = &del($from_namespace,[$group],$cdom,$cnum);
6898: } else {
6899: return ('write error',$result);
6900: }
6901: if ($deloutcome eq 'ok') {
6902: return 'ok';
6903: } else {
6904: return ('delete error',$deloutcome);
6905: }
6906: }
6907: }
6908:
6909: sub modify_group_roles {
6910: my ($cdom,$cnum,$group_id,$user,$end,$start,$userprivs,$selfenroll,$context) = @_;
6911: my $url = '/'.$cdom.'/'.$cnum.'/'.$group_id;
6912: my $role = 'gr/'.&escape($userprivs);
6913: my ($uname,$udom) = split(/:/,$user);
6914: my $result = &assignrole($udom,$uname,$url,$role,$end,$start,'',$selfenroll,$context);
6915: if ($result eq 'ok') {
6916: &devalidate_getgroups_cache($udom,$uname,$cdom,$cnum);
6917: }
6918: return $result;
6919: }
6920:
6921: sub modify_coursegroup_membership {
6922: my ($cdom,$cnum,$membership) = @_;
6923: my $result = &put('groupmembership',$membership,$cdom,$cnum);
6924: return $result;
6925: }
6926:
6927: sub get_active_groups {
6928: my ($udom,$uname,$cdom,$cnum) = @_;
6929: my $now = time;
6930: my %groups = ();
6931: foreach my $key (keys(%env)) {
6932: if ($key =~ m-user\.role\.gr\./($match_domain)/($match_courseid)/(\w+)$-) {
6933: my ($start,$end) = split(/\./,$env{$key});
6934: if (($end!=0) && ($end<$now)) { next; }
6935: if (($start!=0) && ($start>$now)) { next; }
6936: if ($1 eq $cdom && $2 eq $cnum) {
6937: $groups{$3} = $env{$key} ;
6938: }
6939: }
6940: }
6941: return %groups;
6942: }
6943:
6944: sub get_group_membership {
6945: my ($cdom,$cnum,$group) = @_;
6946: return(&dump('groupmembership',$cdom,$cnum,$group));
6947: }
6948:
6949: sub get_users_groups {
6950: my ($udom,$uname,$courseid) = @_;
6951: my @usersgroups;
6952: my $cachetime=1800;
6953:
6954: my $hashid="$udom:$uname:$courseid";
6955: my ($grouplist,$cached)=&is_cached_new('getgroups',$hashid);
6956: if (defined($cached)) {
6957: @usersgroups = split(/:/,$grouplist);
6958: } else {
6959: $grouplist = '';
6960: my $courseurl = &courseid_to_courseurl($courseid);
6961: my $extra = &freeze_escape({'skipcheck' => 1});
6962: my %roleshash = &dump('roles',$udom,$uname,$courseurl,undef,$extra);
6963: my $access_end = $env{'course.'.$courseid.
6964: '.default_enrollment_end_date'};
6965: my $now = time;
6966: foreach my $key (keys(%roleshash)) {
6967: if ($key =~ /^\Q$courseurl\E\/(\w+)\_gr$/) {
6968: my $group = $1;
6969: if ($roleshash{$key} =~ /_(\d+)_(\d+)$/) {
6970: my $start = $2;
6971: my $end = $1;
6972: if ($start == -1) { next; } # deleted from group
6973: if (($start!=0) && ($start>$now)) { next; }
6974: if (($end!=0) && ($end<$now)) {
6975: if ($access_end && $access_end < $now) {
6976: if ($access_end - $end < 86400) {
6977: push(@usersgroups,$group);
6978: }
6979: }
6980: next;
6981: }
6982: push(@usersgroups,$group);
6983: }
6984: }
6985: }
6986: @usersgroups = &sort_course_groups($courseid,@usersgroups);
6987: $grouplist = join(':',@usersgroups);
6988: &do_cache_new('getgroups',$hashid,$grouplist,$cachetime);
6989: }
6990: return @usersgroups;
6991: }
6992:
6993: sub devalidate_getgroups_cache {
6994: my ($udom,$uname,$cdom,$cnum)=@_;
6995: my $courseid = $cdom.'_'.$cnum;
6996:
6997: my $hashid="$udom:$uname:$courseid";
6998: &devalidate_cache_new('getgroups',$hashid);
6999: }
7000:
7001: # ------------------------------------------------------------------ Plain Text
7002:
7003: sub plaintext {
7004: my ($short,$type,$cid,$forcedefault) = @_;
7005: if ($short =~ m{^cr/}) {
7006: return (split('/',$short))[-1];
7007: }
7008: if (!defined($cid)) {
7009: $cid = $env{'request.course.id'};
7010: }
7011: my %rolenames = (
7012: Course => 'std',
7013: Community => 'alt1',
7014: );
7015: if ($cid ne '') {
7016: if ($env{'course.'.$cid.'.'.$short.'.plaintext'} ne '') {
7017: unless ($forcedefault) {
7018: my $roletext = $env{'course.'.$cid.'.'.$short.'.plaintext'};
7019: &Apache::lonlocal::mt_escape(\$roletext);
7020: return &Apache::lonlocal::mt($roletext);
7021: }
7022: }
7023: }
7024: if ((defined($type)) && (defined($rolenames{$type})) &&
7025: (defined($rolenames{$type})) &&
7026: (defined($prp{$short}{$rolenames{$type}}))) {
7027: return &Apache::lonlocal::mt($prp{$short}{$rolenames{$type}});
7028: } elsif ($cid ne '') {
7029: my $crstype = $env{'course.'.$cid.'.type'};
7030: if (($crstype ne '') && (defined($rolenames{$crstype})) &&
7031: (defined($prp{$short}{$rolenames{$crstype}}))) {
7032: return &Apache::lonlocal::mt($prp{$short}{$rolenames{$crstype}});
7033: }
7034: }
7035: return &Apache::lonlocal::mt($prp{$short}{'std'});
7036: }
7037:
7038: # ----------------------------------------------------------------- Assign Role
7039:
7040: sub assignrole {
7041: my ($udom,$uname,$url,$role,$end,$start,$deleteflag,$selfenroll,
7042: $context)=@_;
7043: my $mrole;
7044: if ($role =~ /^cr\//) {
7045: my $cwosec=$url;
7046: $cwosec=~s/^\/($match_domain)\/($match_courseid)\/.*/$1\/$2/;
7047: unless (&allowed('ccr',$cwosec)) {
7048: my $refused = 1;
7049: if ($context eq 'requestcourses') {
7050: if (($env{'user.name'} ne '') && ($env{'user.domain'} ne '')) {
7051: if ($role =~ m{^cr/($match_domain)/($match_username)/([^/]+)$}) {
7052: if (($1 eq $env{'user.domain'}) && ($2 eq $env{'user.name'})) {
7053: my ($cdom,$cnum) = ($cwosec =~ m{^/?($match_domain)/($match_courseid)$});
7054: my %crsenv = &userenvironment($cdom,$cnum,('internal.courseowner'));
7055: if ($crsenv{'internal.courseowner'} eq
7056: $env{'user.name'}.':'.$env{'user.domain'}) {
7057: $refused = '';
7058: }
7059: }
7060: }
7061: }
7062: }
7063: if ($refused) {
7064: &logthis('Refused custom assignrole: '.
7065: $udom.' '.$uname.' '.$url.' '.$role.' '.$end.' '.$start.
7066: ' by '.$env{'user.name'}.' at '.$env{'user.domain'});
7067: return 'refused';
7068: }
7069: }
7070: $mrole='cr';
7071: } elsif ($role =~ /^gr\//) {
7072: my $cwogrp=$url;
7073: $cwogrp=~s{^/($match_domain)/($match_courseid)/.*}{$1/$2};
7074: unless (&allowed('mdg',$cwogrp)) {
7075: &logthis('Refused group assignrole: '.
7076: $udom.' '.$uname.' '.$url.' '.$role.' '.$end.' '.$start.' by '.
7077: $env{'user.name'}.' at '.$env{'user.domain'});
7078: return 'refused';
7079: }
7080: $mrole='gr';
7081: } else {
7082: my $cwosec=$url;
7083: $cwosec=~s/^\/($match_domain)\/($match_courseid)\/.*/$1\/$2/;
7084: if (!(&allowed('c'.$role,$cwosec)) && !(&allowed('c'.$role,$udom))) {
7085: my $refused;
7086: if (($env{'request.course.sec'} ne '') && ($role eq 'st')) {
7087: if (!(&allowed('c'.$role,$url))) {
7088: $refused = 1;
7089: }
7090: } else {
7091: $refused = 1;
7092: }
7093: if ($refused) {
7094: my ($cdom,$cnum) = ($cwosec =~ m{^/?($match_domain)/($match_courseid)$});
7095: if (!$selfenroll && $context eq 'course') {
7096: my %crsenv;
7097: if ($role eq 'cc' || $role eq 'co') {
7098: %crsenv = &userenvironment($cdom,$cnum,('internal.courseowner'));
7099: if (($role eq 'cc') && ($cnum !~ /^$match_community$/)) {
7100: if ($env{'request.role'} eq 'cc./'.$cdom.'/'.$cnum) {
7101: if ($crsenv{'internal.courseowner'} eq
7102: $env{'user.name'}.':'.$env{'user.domain'}) {
7103: $refused = '';
7104: }
7105: }
7106: } elsif (($role eq 'co') && ($cnum =~ /^$match_community$/)) {
7107: if ($env{'request.role'} eq 'co./'.$cdom.'/'.$cnum) {
7108: if ($crsenv{'internal.courseowner'} eq
7109: $env{'user.name'}.':'.$env{'user.domain'}) {
7110: $refused = '';
7111: }
7112: }
7113: }
7114: }
7115: } elsif (($selfenroll == 1) && ($role eq 'st') && ($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'})) {
7116: $refused = '';
7117: } elsif ($context eq 'requestcourses') {
7118: my @possroles = ('st','ta','ep','in','cc','co');
7119: if ((grep(/^\Q$role\E$/,@possroles)) && ($env{'user.name'} ne '' && $env{'user.domain'} ne '')) {
7120: my $wrongcc;
7121: if ($cnum =~ /^$match_community$/) {
7122: $wrongcc = 1 if ($role eq 'cc');
7123: } else {
7124: $wrongcc = 1 if ($role eq 'co');
7125: }
7126: unless ($wrongcc) {
7127: my %crsenv = &userenvironment($cdom,$cnum,('internal.courseowner'));
7128: if ($crsenv{'internal.courseowner'} eq
7129: $env{'user.name'}.':'.$env{'user.domain'}) {
7130: $refused = '';
7131: }
7132: }
7133: }
7134: }
7135: if ($refused) {
7136: &logthis('Refused assignrole: '.$udom.' '.$uname.' '.$url.
7137: ' '.$role.' '.$end.' '.$start.' by '.
7138: $env{'user.name'}.' at '.$env{'user.domain'});
7139: return 'refused';
7140: }
7141: }
7142: } elsif ($role eq 'au') {
7143: if ($url ne '/'.$udom.'/') {
7144: &logthis('Attempt by '.$env{'user.name'}.':'.$env{'user.domain'}.
7145: ' to assign author role for '.$uname.':'.$udom.
7146: ' in domain: '.$url.' refused (wrong domain).');
7147: return 'refused';
7148: }
7149: }
7150: $mrole=$role;
7151: }
7152: my $command="encrypt:rolesput:$env{'user.domain'}:$env{'user.name'}:".
7153: "$udom:$uname:$url".'_'."$mrole=$role";
7154: if ($end) { $command.='_'.$end; }
7155: if ($start) {
7156: if ($end) {
7157: $command.='_'.$start;
7158: } else {
7159: $command.='_0_'.$start;
7160: }
7161: }
7162: my $origstart = $start;
7163: my $origend = $end;
7164: my $delflag;
7165: # actually delete
7166: if ($deleteflag) {
7167: if ((&allowed('dro',$udom)) || (&allowed('dro',$url))) {
7168: # modify command to delete the role
7169: $command="encrypt:rolesdel:$env{'user.domain'}:$env{'user.name'}:".
7170: "$udom:$uname:$url".'_'."$mrole";
7171: &logthis("$env{'user.name'} at $env{'user.domain'} deletes $mrole in $url for $uname at $udom");
7172: # set start and finish to negative values for userrolelog
7173: $start=-1;
7174: $end=-1;
7175: $delflag = 1;
7176: }
7177: }
7178: # send command
7179: my $answer=&reply($command,&homeserver($uname,$udom));
7180: # log new user role if status is ok
7181: if ($answer eq 'ok') {
7182: &userrolelog($role,$uname,$udom,$url,$start,$end);
7183: # for course roles, perform group memberships changes triggered by role change.
7184: &courserolelog($role,$uname,$udom,$url,$origstart,$origend,$delflag,$selfenroll,$context);
7185: unless ($role =~ /^gr/) {
7186: &Apache::longroup::group_changes($udom,$uname,$url,$role,$origend,
7187: $origstart,$selfenroll,$context);
7188: }
7189: if ($role eq 'cc') {
7190: &autoupdate_coowners($url,$end,$start,$uname,$udom);
7191: }
7192: }
7193: return $answer;
7194: }
7195:
7196: sub autoupdate_coowners {
7197: my ($url,$end,$start,$uname,$udom) = @_;
7198: my ($cdom,$cnum) = ($url =~ m{^/($match_domain)/($match_courseid)});
7199: if (($cdom ne '') && ($cnum ne '')) {
7200: my $now = time;
7201: my %domdesign = &Apache::loncommon::get_domainconf($cdom);
7202: if ($domdesign{$cdom.'.autoassign.co-owners'}) {
7203: my %coursehash = &coursedescription($cdom.'_'.$cnum);
7204: my $instcode = $coursehash{'internal.coursecode'};
7205: if ($instcode ne '') {
7206: if (($start && $start <= $now) && ($end == 0) || ($end > $now)) {
7207: unless ($coursehash{'internal.courseowner'} eq $uname.':'.$udom) {
7208: my ($delcoowners,@newcoowners,$putresult,$delresult,$coowners);
7209: my ($result,$desc) = &auto_validate_instcode($cnum,$cdom,$instcode,$uname.':'.$udom);
7210: if ($result eq 'valid') {
7211: if ($coursehash{'internal.co-owners'}) {
7212: foreach my $coowner (split(',',$coursehash{'internal.co-owners'})) {
7213: push(@newcoowners,$coowner);
7214: }
7215: unless (grep(/^\Q$uname\E:\Q$udom\E$/,@newcoowners)) {
7216: push(@newcoowners,$uname.':'.$udom);
7217: }
7218: @newcoowners = sort(@newcoowners);
7219: } else {
7220: push(@newcoowners,$uname.':'.$udom);
7221: }
7222: } else {
7223: if ($coursehash{'internal.co-owners'}) {
7224: foreach my $coowner (split(',',$coursehash{'internal.co-owners'})) {
7225: unless ($coowner eq $uname.':'.$udom) {
7226: push(@newcoowners,$coowner);
7227: }
7228: }
7229: unless (@newcoowners > 0) {
7230: $delcoowners = 1;
7231: $coowners = '';
7232: }
7233: }
7234: }
7235: if (@newcoowners || $delcoowners) {
7236: &store_coowners($cdom,$cnum,$coursehash{'home'},
7237: $delcoowners,@newcoowners);
7238: }
7239: }
7240: }
7241: }
7242: }
7243: }
7244: }
7245:
7246: sub store_coowners {
7247: my ($cdom,$cnum,$chome,$delcoowners,@newcoowners) = @_;
7248: my $cid = $cdom.'_'.$cnum;
7249: my ($coowners,$delresult,$putresult);
7250: if (@newcoowners) {
7251: $coowners = join(',',@newcoowners);
7252: my %coownershash = (
7253: 'internal.co-owners' => $coowners,
7254: );
7255: $putresult = &put('environment',\%coownershash,$cdom,$cnum);
7256: if ($putresult eq 'ok') {
7257: if ($env{'course.'.$cid.'.num'} eq $cnum) {
7258: &appenv({'course.'.$cid.'.internal.co-owners' => $coowners});
7259: }
7260: }
7261: }
7262: if ($delcoowners) {
7263: $delresult = &Apache::lonnet::del('environment',['internal.co-owners'],$cdom,$cnum);
7264: if ($delresult eq 'ok') {
7265: if ($env{'course.'.$cid.'.internal.co-owners'}) {
7266: &Apache::lonnet::delenv('course.'.$cid.'.internal.co-owners');
7267: }
7268: }
7269: }
7270: if (($putresult eq 'ok') || ($delresult eq 'ok')) {
7271: my %crsinfo =
7272: &Apache::lonnet::courseiddump($cdom,'.',1,'.','.',$cnum,undef,undef,'.');
7273: if (ref($crsinfo{$cid}) eq 'HASH') {
7274: $crsinfo{$cid}{'co-owners'} = \@newcoowners;
7275: my $cidput = &Apache::lonnet::courseidput($cdom,\%crsinfo,$chome,'notime');
7276: }
7277: }
7278: }
7279:
7280: # -------------------------------------------------- Modify user authentication
7281: # Overrides without validation
7282:
7283: sub modifyuserauth {
7284: my ($udom,$uname,$umode,$upass)=@_;
7285: my $uhome=&homeserver($uname,$udom);
7286: unless (&allowed('mau',$udom)) { return 'refused'; }
7287: &logthis('Call to modify user authentication '.$udom.', '.$uname.', '.
7288: $umode.' by '.$env{'user.name'}.' at '.$env{'user.domain'}.
7289: ' in domain '.$env{'request.role.domain'});
7290: my $reply=&reply('encrypt:changeuserauth:'.$udom.':'.$uname.':'.$umode.':'.
7291: &escape($upass),$uhome);
7292: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},
7293: 'Authentication changed for '.$udom.', '.$uname.', '.$umode.
7294: '(Remote '.$ENV{'REMOTE_ADDR'}.'): '.$reply);
7295: &log($udom,,$uname,$uhome,
7296: 'Authentication changed by '.$env{'user.domain'}.', '.
7297: $env{'user.name'}.', '.$umode.
7298: '(Remote '.$ENV{'REMOTE_ADDR'}.'): '.$reply);
7299: unless ($reply eq 'ok') {
7300: &logthis('Authentication mode error: '.$reply);
7301: return 'error: '.$reply;
7302: }
7303: return 'ok';
7304: }
7305:
7306: # --------------------------------------------------------------- Modify a user
7307:
7308: sub modifyuser {
7309: my ($udom, $uname, $uid,
7310: $umode, $upass, $first,
7311: $middle, $last, $gene,
7312: $forceid, $desiredhome, $email, $inststatus, $candelete)=@_;
7313: $udom= &LONCAPA::clean_domain($udom);
7314: $uname=&LONCAPA::clean_username($uname);
7315: my $showcandelete = 'none';
7316: if (ref($candelete) eq 'ARRAY') {
7317: if (@{$candelete} > 0) {
7318: $showcandelete = join(', ',@{$candelete});
7319: }
7320: }
7321: &logthis('Call to modify user '.$udom.', '.$uname.', '.$uid.', '.
7322: $umode.', '.$first.', '.$middle.', '.
7323: $last.', '.$gene.'(forceid: '.$forceid.'; candelete: '.$showcandelete.')'.
7324: (defined($desiredhome) ? ' desiredhome = '.$desiredhome :
7325: ' desiredhome not specified').
7326: ' by '.$env{'user.name'}.' at '.$env{'user.domain'}.
7327: ' in domain '.$env{'request.role.domain'});
7328: my $uhome=&homeserver($uname,$udom,'true');
7329: my $newuser;
7330: if ($uhome eq 'no_host') {
7331: $newuser = 1;
7332: }
7333: # ----------------------------------------------------------------- Create User
7334: if (($uhome eq 'no_host') &&
7335: (($umode && $upass) || ($umode eq 'localauth'))) {
7336: my $unhome='';
7337: if (defined($desiredhome) && &host_domain($desiredhome) eq $udom) {
7338: $unhome = $desiredhome;
7339: } elsif($env{'course.'.$env{'request.course.id'}.'.domain'} eq $udom) {
7340: $unhome=$env{'course.'.$env{'request.course.id'}.'.home'};
7341: } else { # load balancing routine for determining $unhome
7342: my $loadm=10000000;
7343: my %servers = &get_servers($udom,'library');
7344: foreach my $tryserver (keys(%servers)) {
7345: my $answer=reply('load',$tryserver);
7346: if (($answer=~/\d+/) && ($answer<$loadm)) {
7347: $loadm=$answer;
7348: $unhome=$tryserver;
7349: }
7350: }
7351: }
7352: if (($unhome eq '') || ($unhome eq 'no_host')) {
7353: return 'error: unable to find a home server for '.$uname.
7354: ' in domain '.$udom;
7355: }
7356: my $reply=&reply('encrypt:makeuser:'.$udom.':'.$uname.':'.$umode.':'.
7357: &escape($upass),$unhome);
7358: unless ($reply eq 'ok') {
7359: return 'error: '.$reply;
7360: }
7361: $uhome=&homeserver($uname,$udom,'true');
7362: if (($uhome eq '') || ($uhome eq 'no_host') || ($uhome ne $unhome)) {
7363: return 'error: unable verify users home machine.';
7364: }
7365: } # End of creation of new user
7366: # ---------------------------------------------------------------------- Add ID
7367: if ($uid) {
7368: $uid=~tr/A-Z/a-z/;
7369: my %uidhash=&idrget($udom,$uname);
7370: if (($uidhash{$uname}) && ($uidhash{$uname}!~/error\:/)
7371: && (!$forceid)) {
7372: unless ($uid eq $uidhash{$uname}) {
7373: return 'error: user id "'.$uid.'" does not match '.
7374: 'current user id "'.$uidhash{$uname}.'".';
7375: }
7376: } else {
7377: &idput($udom,($uname => $uid));
7378: }
7379: }
7380: # -------------------------------------------------------------- Add names, etc
7381: my @tmp=&get('environment',
7382: ['firstname','middlename','lastname','generation','id',
7383: 'permanentemail','inststatus'],
7384: $udom,$uname);
7385: my (%names,%oldnames);
7386: if ($tmp[0] =~ m/^error:.*/) {
7387: %names=();
7388: } else {
7389: %names = @tmp;
7390: %oldnames = %names;
7391: }
7392: #
7393: # If name, email and/or uid are blank (e.g., because an uploaded file
7394: # of users did not contain them), do not overwrite existing values
7395: # unless field is in $candelete array ref.
7396: #
7397:
7398: my @fields = ('firstname','middlename','lastname','generation',
7399: 'permanentemail','id');
7400: my %newvalues;
7401: if (ref($candelete) eq 'ARRAY') {
7402: foreach my $field (@fields) {
7403: if (grep(/^\Q$field\E$/,@{$candelete})) {
7404: if ($field eq 'firstname') {
7405: $names{$field} = $first;
7406: } elsif ($field eq 'middlename') {
7407: $names{$field} = $middle;
7408: } elsif ($field eq 'lastname') {
7409: $names{$field} = $last;
7410: } elsif ($field eq 'generation') {
7411: $names{$field} = $gene;
7412: } elsif ($field eq 'permanentemail') {
7413: $names{$field} = $email;
7414: } elsif ($field eq 'id') {
7415: $names{$field} = $uid;
7416: }
7417: }
7418: }
7419: }
7420: if ($first) { $names{'firstname'} = $first; }
7421: if (defined($middle)) { $names{'middlename'} = $middle; }
7422: if ($last) { $names{'lastname'} = $last; }
7423: if (defined($gene)) { $names{'generation'} = $gene; }
7424: if ($email) {
7425: $email=~s/[^\w\@\.\-\,]//gs;
7426: if ($email=~/\@/) { $names{'permanentemail'} = $email; }
7427: }
7428: if ($uid) { $names{'id'} = $uid; }
7429: if (defined($inststatus)) {
7430: $names{'inststatus'} = '';
7431: my ($usertypes,$typesorder) = &retrieve_inst_usertypes($udom);
7432: if (ref($usertypes) eq 'HASH') {
7433: my @okstatuses;
7434: foreach my $item (split(/:/,$inststatus)) {
7435: if (defined($usertypes->{$item})) {
7436: push(@okstatuses,$item);
7437: }
7438: }
7439: if (@okstatuses) {
7440: $names{'inststatus'} = join(':', map { &escape($_); } @okstatuses);
7441: }
7442: }
7443: }
7444: my $logmsg = $udom.', '.$uname.', '.$uid.', '.
7445: $umode.', '.$first.', '.$middle.', '.
7446: $last.', '.$gene.', '.$email.', '.$inststatus;
7447: if ($env{'user.name'} ne '' && $env{'user.domain'}) {
7448: $logmsg .= ' by '.$env{'user.name'}.' at '.$env{'user.domain'};
7449: } else {
7450: $logmsg .= ' during self creation';
7451: }
7452: my $changed;
7453: if ($newuser) {
7454: $changed = 1;
7455: } else {
7456: foreach my $field (@fields) {
7457: if ($names{$field} ne $oldnames{$field}) {
7458: $changed = 1;
7459: last;
7460: }
7461: }
7462: }
7463: unless ($changed) {
7464: $logmsg = 'No changes in user information needed for: '.$logmsg;
7465: &logthis($logmsg);
7466: return 'ok';
7467: }
7468: my $reply = &put('environment', \%names, $udom,$uname);
7469: if ($reply ne 'ok') {
7470: return 'error: '.$reply;
7471: }
7472: if ($names{'permanentemail'} ne $oldnames{'permanentemail'}) {
7473: &Apache::lonnet::devalidate_cache_new('emailscache',$uname.':'.$udom);
7474: }
7475: my $sqlresult = &update_allusers_table($uname,$udom,\%names);
7476: &devalidate_cache_new('namescache',$uname.':'.$udom);
7477: $logmsg = 'Success modifying user '.$logmsg;
7478: &logthis($logmsg);
7479: return 'ok';
7480: }
7481:
7482: # -------------------------------------------------------------- Modify student
7483:
7484: sub modifystudent {
7485: my ($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene,$usec,
7486: $end,$start,$forceid,$desiredhome,$email,$type,$locktype,$cid,
7487: $selfenroll,$context,$inststatus)=@_;
7488: if (!$cid) {
7489: unless ($cid=$env{'request.course.id'}) {
7490: return 'not_in_class';
7491: }
7492: }
7493: # --------------------------------------------------------------- Make the user
7494: my $reply=&modifyuser
7495: ($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene,$forceid,
7496: $desiredhome,$email,$inststatus);
7497: unless ($reply eq 'ok') { return $reply; }
7498: # This will cause &modify_student_enrollment to get the uid from the
7499: # students environment
7500: $uid = undef if (!$forceid);
7501: $reply = &modify_student_enrollment($udom,$uname,$uid,$first,$middle,$last,
7502: $gene,$usec,$end,$start,$type,$locktype,$cid,$selfenroll,$context);
7503: return $reply;
7504: }
7505:
7506: sub modify_student_enrollment {
7507: my ($udom,$uname,$uid,$first,$middle,$last,$gene,$usec,$end,$start,$type,$locktype,$cid,$selfenroll,$context) = @_;
7508: my ($cdom,$cnum,$chome);
7509: if (!$cid) {
7510: unless ($cid=$env{'request.course.id'}) {
7511: return 'not_in_class';
7512: }
7513: $cdom=$env{'course.'.$cid.'.domain'};
7514: $cnum=$env{'course.'.$cid.'.num'};
7515: } else {
7516: ($cdom,$cnum)=split(/_/,$cid);
7517: }
7518: $chome=$env{'course.'.$cid.'.home'};
7519: if (!$chome) {
7520: $chome=&homeserver($cnum,$cdom);
7521: }
7522: if (!$chome) { return 'unknown_course'; }
7523: # Make sure the user exists
7524: my $uhome=&homeserver($uname,$udom);
7525: if (($uhome eq '') || ($uhome eq 'no_host')) {
7526: return 'error: no such user';
7527: }
7528: # Get student data if we were not given enough information
7529: if (!defined($first) || $first eq '' ||
7530: !defined($last) || $last eq '' ||
7531: !defined($uid) || $uid eq '' ||
7532: !defined($middle) || $middle eq '' ||
7533: !defined($gene) || $gene eq '') {
7534: # They did not supply us with enough data to enroll the student, so
7535: # we need to pick up more information.
7536: my %tmp = &get('environment',
7537: ['firstname','middlename','lastname', 'generation','id']
7538: ,$udom,$uname);
7539:
7540: #foreach my $key (keys(%tmp)) {
7541: # &logthis("key $key = ".$tmp{$key});
7542: #}
7543: $first = $tmp{'firstname'} if (!defined($first) || $first eq '');
7544: $middle = $tmp{'middlename'} if (!defined($middle) || $middle eq '');
7545: $last = $tmp{'lastname'} if (!defined($last) || $last eq '');
7546: $gene = $tmp{'generation'} if (!defined($gene) || $gene eq '');
7547: $uid = $tmp{'id'} if (!defined($uid) || $uid eq '');
7548: }
7549: my $fullname = &format_name($first,$middle,$last,$gene,'lastname');
7550: my $user = "$uname:$udom";
7551: my %old_entry = &Apache::lonnet::get('classlist',[$user],$cdom,$cnum);
7552: my $reply=cput('classlist',
7553: {$user =>
7554: join(':',$end,$start,$uid,$usec,$fullname,$type,$locktype) },
7555: $cdom,$cnum);
7556: if (($reply eq 'ok') || ($reply eq 'delayed')) {
7557: &devalidate_getsection_cache($udom,$uname,$cid);
7558: } else {
7559: return 'error: '.$reply;
7560: }
7561: # Add student role to user
7562: my $uurl='/'.$cid;
7563: $uurl=~s/\_/\//g;
7564: if ($usec) {
7565: $uurl.='/'.$usec;
7566: }
7567: my $result = &assignrole($udom,$uname,$uurl,'st',$end,$start,undef,
7568: $selfenroll,$context);
7569: if ($result ne 'ok') {
7570: if ($old_entry{$user} ne '') {
7571: $reply = &cput('classlist',\%old_entry,$cdom,$cnum);
7572: } else {
7573: $reply = &del('classlist',[$user],$cdom,$cnum);
7574: }
7575: }
7576: return $result;
7577: }
7578:
7579: sub format_name {
7580: my ($firstname,$middlename,$lastname,$generation,$first)=@_;
7581: my $name;
7582: if ($first ne 'lastname') {
7583: $name=$firstname.' '.$middlename.' '.$lastname.' '.$generation;
7584: } else {
7585: if ($lastname=~/\S/) {
7586: $name.= $lastname.' '.$generation.', '.$firstname.' '.$middlename;
7587: $name=~s/\s+,/,/;
7588: } else {
7589: $name.= $firstname.' '.$middlename.' '.$generation;
7590: }
7591: }
7592: $name=~s/^\s+//;
7593: $name=~s/\s+$//;
7594: $name=~s/\s+/ /g;
7595: return $name;
7596: }
7597:
7598: # ------------------------------------------------- Write to course preferences
7599:
7600: sub writecoursepref {
7601: my ($courseid,%prefs)=@_;
7602: $courseid=~s/^\///;
7603: $courseid=~s/\_/\//g;
7604: my ($cdomain,$cnum)=split(/\//,$courseid);
7605: my $chome=homeserver($cnum,$cdomain);
7606: if (($chome eq '') || ($chome eq 'no_host')) {
7607: return 'error: no such course';
7608: }
7609: my $cstring='';
7610: foreach my $pref (keys(%prefs)) {
7611: $cstring.=&escape($pref).'='.&escape($prefs{$pref}).'&';
7612: }
7613: $cstring=~s/\&$//;
7614: return reply('put:'.$cdomain.':'.$cnum.':environment:'.$cstring,$chome);
7615: }
7616:
7617: # ---------------------------------------------------------- Make/modify course
7618:
7619: sub createcourse {
7620: my ($udom,$description,$url,$course_server,$nonstandard,$inst_code,
7621: $course_owner,$crstype,$cnum,$context,$category)=@_;
7622: $url=&declutter($url);
7623: my $cid='';
7624: if ($context eq 'requestcourses') {
7625: my $can_create = 0;
7626: my ($ownername,$ownerdom) = split(':',$course_owner);
7627: if ($udom eq $ownerdom) {
7628: if (&usertools_access($ownername,$ownerdom,$category,undef,
7629: $context)) {
7630: $can_create = 1;
7631: }
7632: } else {
7633: my %userenv = &userenvironment($ownerdom,$ownername,'reqcrsotherdom.'.
7634: $category);
7635: if ($userenv{'reqcrsotherdom.'.$category} ne '') {
7636: my @curr = split(',',$userenv{'reqcrsotherdom.'.$category});
7637: if (@curr > 0) {
7638: my @options = qw(approval validate autolimit);
7639: my $optregex = join('|',@options);
7640: if (grep(/^\Q$udom\E:($optregex)(=?\d*)$/,@curr)) {
7641: $can_create = 1;
7642: }
7643: }
7644: }
7645: }
7646: if ($can_create) {
7647: unless ($ownername eq $env{'user.name'} && $ownerdom eq $env{'user.domain'}) {
7648: unless (&allowed('ccc',$udom)) {
7649: return 'refused';
7650: }
7651: }
7652: } else {
7653: return 'refused';
7654: }
7655: } elsif (!&allowed('ccc',$udom)) {
7656: return 'refused';
7657: }
7658: # --------------------------------------------------------------- Get Unique ID
7659: my $uname;
7660: if ($cnum =~ /^$match_courseid$/) {
7661: my $chome=&homeserver($cnum,$udom,'true');
7662: if (($chome eq '') || ($chome eq 'no_host')) {
7663: $uname = $cnum;
7664: } else {
7665: $uname = &generate_coursenum($udom,$crstype);
7666: }
7667: } else {
7668: $uname = &generate_coursenum($udom,$crstype);
7669: }
7670: return $uname if ($uname =~ /^error/);
7671: # -------------------------------------------------- Check supplied server name
7672: if (!defined($course_server)) {
7673: if (defined(&domain($udom,'primary'))) {
7674: $course_server = &domain($udom,'primary');
7675: } else {
7676: $course_server = $env{'user.home'};
7677: }
7678: }
7679: my %host_servers =
7680: &Apache::lonnet::get_servers($udom,'library');
7681: unless ($host_servers{$course_server}) {
7682: return 'error: invalid home server for course: '.$course_server;
7683: }
7684: # ------------------------------------------------------------- Make the course
7685: my $reply=&reply('encrypt:makeuser:'.$udom.':'.$uname.':none::',
7686: $course_server);
7687: unless ($reply eq 'ok') { return 'error: '.$reply; }
7688: my $uhome=&homeserver($uname,$udom,'true');
7689: if (($uhome eq '') || ($uhome eq 'no_host')) {
7690: return 'error: no such course';
7691: }
7692: # ----------------------------------------------------------------- Course made
7693: # log existence
7694: my $now = time;
7695: my $newcourse = {
7696: $udom.'_'.$uname => {
7697: description => $description,
7698: inst_code => $inst_code,
7699: owner => $course_owner,
7700: type => $crstype,
7701: creator => $env{'user.name'}.':'.
7702: $env{'user.domain'},
7703: created => $now,
7704: context => $context,
7705: },
7706: };
7707: &courseidput($udom,$newcourse,$uhome,'notime');
7708: # set toplevel url
7709: my $topurl=$url;
7710: unless ($nonstandard) {
7711: # ------------------------------------------ For standard courses, make top url
7712: my $mapurl=&clutter($url);
7713: if ($mapurl eq '/res/') { $mapurl=''; }
7714: $env{'form.initmap'}=(<<ENDINITMAP);
7715: <map>
7716: <resource id="1" type="start"></resource>
7717: <resource id="2" src="$mapurl"></resource>
7718: <resource id="3" type="finish"></resource>
7719: <link index="1" from="1" to="2"></link>
7720: <link index="2" from="2" to="3"></link>
7721: </map>
7722: ENDINITMAP
7723: $topurl=&declutter(
7724: &finishuserfileupload($uname,$udom,'initmap','default.sequence')
7725: );
7726: }
7727: # ----------------------------------------------------------- Write preferences
7728: &writecoursepref($udom.'_'.$uname,
7729: ('description' => $description,
7730: 'url' => $topurl,
7731: 'internal.creator' => $env{'user.name'}.':'.
7732: $env{'user.domain'},
7733: 'internal.created' => $now,
7734: 'internal.creationcontext' => $context)
7735: );
7736: return '/'.$udom.'/'.$uname;
7737: }
7738:
7739: # ------------------------------------------------------------------- Create ID
7740: sub generate_coursenum {
7741: my ($udom,$crstype) = @_;
7742: my $domdesc = &domain($udom);
7743: return 'error: invalid domain' if ($domdesc eq '');
7744: my $first;
7745: if ($crstype eq 'Community') {
7746: $first = '0';
7747: } else {
7748: $first = int(1+rand(9));
7749: }
7750: my $uname=$first.
7751: ('a'..'z','A'..'Z','0'..'9')[int(rand(62))].
7752: substr($$.time,0,5).unpack("H8",pack("I32",time)).
7753: unpack("H2",pack("I32",int(rand(255)))).$perlvar{'lonHostID'};
7754: # ----------------------------------------------- Make sure that does not exist
7755: my $uhome=&homeserver($uname,$udom,'true');
7756: unless (($uhome eq '') || ($uhome eq 'no_host')) {
7757: if ($crstype eq 'Community') {
7758: $first = '0';
7759: } else {
7760: $first = int(1+rand(9));
7761: }
7762: $uname=$first.
7763: ('a'..'z','A'..'Z','0'..'9')[int(rand(62))].
7764: substr($$.time,0,5).unpack("H8",pack("I32",time)).
7765: unpack("H2",pack("I32",int(rand(255)))).$perlvar{'lonHostID'};
7766: $uhome=&homeserver($uname,$udom,'true');
7767: unless (($uhome eq '') || ($uhome eq 'no_host')) {
7768: return 'error: unable to generate unique course-ID';
7769: }
7770: }
7771: return $uname;
7772: }
7773:
7774: sub is_course {
7775: my ($cdom,$cnum) = @_;
7776: my %courses = &courseiddump($cdom,'.',1,'.','.',$cnum,undef,
7777: undef,'.');
7778: if (exists($courses{$cdom.'_'.$cnum})) {
7779: return 1;
7780: }
7781: return 0;
7782: }
7783:
7784: sub store_userdata {
7785: my ($storehash,$datakey,$namespace,$udom,$uname) = @_;
7786: my $result;
7787: if ($datakey ne '') {
7788: if (ref($storehash) eq 'HASH') {
7789: if ($udom eq '' || $uname eq '') {
7790: $udom = $env{'user.domain'};
7791: $uname = $env{'user.name'};
7792: }
7793: my $uhome=&homeserver($uname,$udom);
7794: if (($uhome eq '') || ($uhome eq 'no_host')) {
7795: $result = 'error: no_host';
7796: } else {
7797: $storehash->{'ip'} = $ENV{'REMOTE_ADDR'};
7798: $storehash->{'host'} = $perlvar{'lonHostID'};
7799:
7800: my $namevalue='';
7801: foreach my $key (keys(%{$storehash})) {
7802: $namevalue.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
7803: }
7804: $namevalue=~s/\&$//;
7805: $result = &reply("store:$udom:$uname:$namespace:$datakey:".
7806: $namevalue,$uhome);
7807: }
7808: } else {
7809: $result = 'error: data to store was not a hash reference';
7810: }
7811: } else {
7812: $result= 'error: invalid requestkey';
7813: }
7814: return $result;
7815: }
7816:
7817: # ---------------------------------------------------------- Assign Custom Role
7818:
7819: sub assigncustomrole {
7820: my ($udom,$uname,$url,$rdom,$rnam,$rolename,$end,$start,$deleteflag,$selfenroll,$context)=@_;
7821: return &assignrole($udom,$uname,$url,'cr/'.$rdom.'/'.$rnam.'/'.$rolename,
7822: $end,$start,$deleteflag,$selfenroll,$context);
7823: }
7824:
7825: # ----------------------------------------------------------------- Revoke Role
7826:
7827: sub revokerole {
7828: my ($udom,$uname,$url,$role,$deleteflag,$selfenroll,$context)=@_;
7829: my $now=time;
7830: return &assignrole($udom,$uname,$url,$role,$now,undef,$deleteflag,$selfenroll,$context);
7831: }
7832:
7833: # ---------------------------------------------------------- Revoke Custom Role
7834:
7835: sub revokecustomrole {
7836: my ($udom,$uname,$url,$rdom,$rnam,$rolename,$deleteflag,$selfenroll,$context)=@_;
7837: my $now=time;
7838: return &assigncustomrole($udom,$uname,$url,$rdom,$rnam,$rolename,$now,
7839: $deleteflag,$selfenroll,$context);
7840: }
7841:
7842: # ------------------------------------------------------------ Disk usage
7843: sub diskusage {
7844: my ($udom,$uname,$directorypath,$getpropath)=@_;
7845: $directorypath =~ s/\/$//;
7846: my $listing=&reply('du2:'.&escape($directorypath).':'
7847: .&escape($getpropath).':'.&escape($uname).':'
7848: .&escape($udom),homeserver($uname,$udom));
7849: if ($listing eq 'unknown_cmd') {
7850: if ($getpropath) {
7851: $directorypath = &propath($udom,$uname).'/'.$directorypath;
7852: }
7853: $listing = &reply('du:'.$directorypath,homeserver($uname,$udom));
7854: }
7855: return $listing;
7856: }
7857:
7858: sub is_locked {
7859: my ($file_name, $domain, $user, $which) = @_;
7860: my @check;
7861: my $is_locked;
7862: push (@check,$file_name);
7863: my %locked = &get('file_permissions',\@check,
7864: $env{'user.domain'},$env{'user.name'});
7865: my ($tmp)=keys(%locked);
7866: if ($tmp=~/^error:/) { undef(%locked); }
7867:
7868: if (ref($locked{$file_name}) eq 'ARRAY') {
7869: $is_locked = 'false';
7870: foreach my $entry (@{$locked{$file_name}}) {
7871: if (ref($entry) eq 'ARRAY') {
7872: $is_locked = 'true';
7873: if (ref($which) eq 'ARRAY') {
7874: push(@{$which},$entry);
7875: } else {
7876: last;
7877: }
7878: }
7879: }
7880: } else {
7881: $is_locked = 'false';
7882: }
7883: return $is_locked;
7884: }
7885:
7886: sub declutter_portfile {
7887: my ($file) = @_;
7888: $file =~ s{^(/portfolio/|portfolio/)}{/};
7889: return $file;
7890: }
7891:
7892: # ------------------------------------------------------------- Mark as Read Only
7893:
7894: sub mark_as_readonly {
7895: my ($domain,$user,$files,$what) = @_;
7896: my %current_permissions = &dump('file_permissions',$domain,$user);
7897: my ($tmp)=keys(%current_permissions);
7898: if ($tmp=~/^error:/) { undef(%current_permissions); }
7899: foreach my $file (@{$files}) {
7900: $file = &declutter_portfile($file);
7901: push(@{$current_permissions{$file}},$what);
7902: }
7903: &put('file_permissions',\%current_permissions,$domain,$user);
7904: return;
7905: }
7906:
7907: # ------------------------------------------------------------Save Selected Files
7908:
7909: sub save_selected_files {
7910: my ($user, $path, @files) = @_;
7911: my $filename = $user."savedfiles";
7912: my @other_files = &files_not_in_path($user, $path);
7913: open (OUT, '>'.$tmpdir.$filename);
7914: foreach my $file (@files) {
7915: print (OUT $env{'form.currentpath'}.$file."\n");
7916: }
7917: foreach my $file (@other_files) {
7918: print (OUT $file."\n");
7919: }
7920: close (OUT);
7921: return 'ok';
7922: }
7923:
7924: sub clear_selected_files {
7925: my ($user) = @_;
7926: my $filename = $user."savedfiles";
7927: open (OUT, '>'.LONCAPA::tempdir().$filename);
7928: print (OUT undef);
7929: close (OUT);
7930: return ("ok");
7931: }
7932:
7933: sub files_in_path {
7934: my ($user, $path) = @_;
7935: my $filename = $user."savedfiles";
7936: my %return_files;
7937: open (IN, '<'.LONCAPA::tempdir().$filename);
7938: while (my $line_in = <IN>) {
7939: chomp ($line_in);
7940: my @paths_and_file = split (m!/!, $line_in);
7941: my $file_part = pop (@paths_and_file);
7942: my $path_part = join ('/', @paths_and_file);
7943: $path_part.='/';
7944: my $path_and_file = $path_part.$file_part;
7945: if ($path_part eq $path) {
7946: $return_files{$file_part}= 'selected';
7947: }
7948: }
7949: close (IN);
7950: return (\%return_files);
7951: }
7952:
7953: # called in portfolio select mode, to show files selected NOT in current directory
7954: sub files_not_in_path {
7955: my ($user, $path) = @_;
7956: my $filename = $user."savedfiles";
7957: my @return_files;
7958: my $path_part;
7959: open(IN, '<'.LONCAPA::.$filename);
7960: while (my $line = <IN>) {
7961: #ok, I know it's clunky, but I want it to work
7962: my @paths_and_file = split(m|/|, $line);
7963: my $file_part = pop(@paths_and_file);
7964: chomp($file_part);
7965: my $path_part = join('/', @paths_and_file);
7966: $path_part .= '/';
7967: my $path_and_file = $path_part.$file_part;
7968: if ($path_part ne $path) {
7969: push(@return_files, ($path_and_file));
7970: }
7971: }
7972: close(OUT);
7973: return (@return_files);
7974: }
7975:
7976: #----------------------------------------------Get portfolio file permissions
7977:
7978: sub get_portfile_permissions {
7979: my ($domain,$user) = @_;
7980: my %current_permissions = &dump('file_permissions',$domain,$user);
7981: my ($tmp)=keys(%current_permissions);
7982: if ($tmp=~/^error:/) { undef(%current_permissions); }
7983: return \%current_permissions;
7984: }
7985:
7986: #---------------------------------------------Get portfolio file access controls
7987:
7988: sub get_access_controls {
7989: my ($current_permissions,$group,$file) = @_;
7990: my %access;
7991: my $real_file = $file;
7992: $file =~ s/\.meta$//;
7993: if (defined($file)) {
7994: if (ref($$current_permissions{$file."\0".'accesscontrol'}) eq 'HASH') {
7995: foreach my $control (keys(%{$$current_permissions{$file."\0".'accesscontrol'}})) {
7996: $access{$real_file}{$control} = $$current_permissions{$file."\0".$control};
7997: }
7998: }
7999: } else {
8000: foreach my $key (keys(%{$current_permissions})) {
8001: if ($key =~ /\0accesscontrol$/) {
8002: if (defined($group)) {
8003: if ($key !~ m-^\Q$group\E/-) {
8004: next;
8005: }
8006: }
8007: my ($fullpath) = split(/\0/,$key);
8008: if (ref($$current_permissions{$key}) eq 'HASH') {
8009: foreach my $control (keys(%{$$current_permissions{$key}})) {
8010: $access{$fullpath}{$control}=$$current_permissions{$fullpath."\0".$control};
8011: }
8012: }
8013: }
8014: }
8015: }
8016: return %access;
8017: }
8018:
8019: sub modify_access_controls {
8020: my ($file_name,$changes,$domain,$user)=@_;
8021: my ($outcome,$deloutcome);
8022: my %store_permissions;
8023: my %new_values;
8024: my %new_control;
8025: my %translation;
8026: my @deletions = ();
8027: my $now = time;
8028: if (exists($$changes{'activate'})) {
8029: if (ref($$changes{'activate'}) eq 'HASH') {
8030: my @newitems = sort(keys(%{$$changes{'activate'}}));
8031: my $numnew = scalar(@newitems);
8032: for (my $i=0; $i<$numnew; $i++) {
8033: my $newkey = $newitems[$i];
8034: my $newid = &Apache::loncommon::get_cgi_id();
8035: if ($newkey =~ /^\d+:/) {
8036: $newkey =~ s/^(\d+)/$newid/;
8037: $translation{$1} = $newid;
8038: } elsif ($newkey =~ /^\d+_\d+_\d+:/) {
8039: $newkey =~ s/^(\d+_\d+_\d+)/$newid/;
8040: $translation{$1} = $newid;
8041: }
8042: $new_values{$file_name."\0".$newkey} =
8043: $$changes{'activate'}{$newitems[$i]};
8044: $new_control{$newkey} = $now;
8045: }
8046: }
8047: }
8048: my %todelete;
8049: my %changed_items;
8050: foreach my $action ('delete','update') {
8051: if (exists($$changes{$action})) {
8052: if (ref($$changes{$action}) eq 'HASH') {
8053: foreach my $key (keys(%{$$changes{$action}})) {
8054: my ($itemnum) = ($key =~ /^([^:]+):/);
8055: if ($action eq 'delete') {
8056: $todelete{$itemnum} = 1;
8057: } else {
8058: $changed_items{$itemnum} = $key;
8059: }
8060: }
8061: }
8062: }
8063: }
8064: # get lock on access controls for file.
8065: my $lockhash = {
8066: $file_name."\0".'locked_access_records' => $env{'user.name'}.
8067: ':'.$env{'user.domain'},
8068: };
8069: my $tries = 0;
8070: my $gotlock = &newput('file_permissions',$lockhash,$domain,$user);
8071:
8072: while (($gotlock ne 'ok') && $tries <3) {
8073: $tries ++;
8074: sleep 1;
8075: $gotlock = &newput('file_permissions',$lockhash,$domain,$user);
8076: }
8077: if ($gotlock eq 'ok') {
8078: my %curr_permissions = &dump('file_permissions',$domain,$user,$file_name);
8079: my ($tmp)=keys(%curr_permissions);
8080: if ($tmp=~/^error:/) { undef(%curr_permissions); }
8081: if (exists($curr_permissions{$file_name."\0".'accesscontrol'})) {
8082: my $curr_controls = $curr_permissions{$file_name."\0".'accesscontrol'};
8083: if (ref($curr_controls) eq 'HASH') {
8084: foreach my $control_item (keys(%{$curr_controls})) {
8085: my ($itemnum) = ($control_item =~ /^([^:]+):/);
8086: if (defined($todelete{$itemnum})) {
8087: push(@deletions,$file_name."\0".$control_item);
8088: } else {
8089: if (defined($changed_items{$itemnum})) {
8090: $new_control{$changed_items{$itemnum}} = $now;
8091: push(@deletions,$file_name."\0".$control_item);
8092: $new_values{$file_name."\0".$changed_items{$itemnum}} = $$changes{'update'}{$changed_items{$itemnum}};
8093: } else {
8094: $new_control{$control_item} = $$curr_controls{$control_item};
8095: }
8096: }
8097: }
8098: }
8099: }
8100: my ($group);
8101: if (&is_course($domain,$user)) {
8102: ($group,my $file) = split(/\//,$file_name,2);
8103: }
8104: $deloutcome = &del('file_permissions',\@deletions,$domain,$user);
8105: $new_values{$file_name."\0".'accesscontrol'} = \%new_control;
8106: $outcome = &put('file_permissions',\%new_values,$domain,$user);
8107: # remove lock
8108: my @del_lock = ($file_name."\0".'locked_access_records');
8109: my $dellockoutcome = &del('file_permissions',\@del_lock,$domain,$user);
8110: my $sqlresult =
8111: &update_portfolio_table($user,$domain,$file_name,'portfolio_access',
8112: $group);
8113: } else {
8114: $outcome = "error: could not obtain lockfile\n";
8115: }
8116: return ($outcome,$deloutcome,\%new_values,\%translation);
8117: }
8118:
8119: sub make_public_indefinitely {
8120: my ($requrl) = @_;
8121: my $now = time;
8122: my $action = 'activate';
8123: my $aclnum = 0;
8124: if (&is_portfolio_url($requrl)) {
8125: my (undef,$udom,$unum,$file_name,$group) =
8126: &parse_portfolio_url($requrl);
8127: my $current_perms = &get_portfile_permissions($udom,$unum);
8128: my %access_controls = &get_access_controls($current_perms,
8129: $group,$file_name);
8130: foreach my $key (keys(%{$access_controls{$file_name}})) {
8131: my ($num,$scope,$end,$start) =
8132: ($key =~ /^([^:]+):([a-z]+)_(\d*)_?(\d*)$/);
8133: if ($scope eq 'public') {
8134: if ($start <= $now && $end == 0) {
8135: $action = 'none';
8136: } else {
8137: $action = 'update';
8138: $aclnum = $num;
8139: }
8140: last;
8141: }
8142: }
8143: if ($action eq 'none') {
8144: return 'ok';
8145: } else {
8146: my %changes;
8147: my $newend = 0;
8148: my $newstart = $now;
8149: my $newkey = $aclnum.':public_'.$newend.'_'.$newstart;
8150: $changes{$action}{$newkey} = {
8151: type => 'public',
8152: time => {
8153: start => $newstart,
8154: end => $newend,
8155: },
8156: };
8157: my ($outcome,$deloutcome,$new_values,$translation) =
8158: &modify_access_controls($file_name,\%changes,$udom,$unum);
8159: return $outcome;
8160: }
8161: } else {
8162: return 'invalid';
8163: }
8164: }
8165:
8166: #------------------------------------------------------Get Marked as Read Only
8167:
8168: sub get_marked_as_readonly {
8169: my ($domain,$user,$what,$group) = @_;
8170: my $current_permissions = &get_portfile_permissions($domain,$user);
8171: my @readonly_files;
8172: my $cmp1=$what;
8173: if (ref($what)) { $cmp1=join('',@{$what}) };
8174: while (my ($file_name,$value) = each(%{$current_permissions})) {
8175: if (defined($group)) {
8176: if ($file_name !~ m-^\Q$group\E/-) {
8177: next;
8178: }
8179: }
8180: if (ref($value) eq "ARRAY"){
8181: foreach my $stored_what (@{$value}) {
8182: my $cmp2=$stored_what;
8183: if (ref($stored_what) eq 'ARRAY') {
8184: $cmp2=join('',@{$stored_what});
8185: }
8186: if ($cmp1 eq $cmp2) {
8187: push(@readonly_files, $file_name);
8188: last;
8189: } elsif (!defined($what)) {
8190: push(@readonly_files, $file_name);
8191: last;
8192: }
8193: }
8194: }
8195: }
8196: return @readonly_files;
8197: }
8198: #-----------------------------------------------------------Get Marked as Read Only Hash
8199:
8200: sub get_marked_as_readonly_hash {
8201: my ($current_permissions,$group,$what) = @_;
8202: my %readonly_files;
8203: while (my ($file_name,$value) = each(%{$current_permissions})) {
8204: if (defined($group)) {
8205: if ($file_name !~ m-^\Q$group\E/-) {
8206: next;
8207: }
8208: }
8209: if (ref($value) eq "ARRAY"){
8210: foreach my $stored_what (@{$value}) {
8211: if (ref($stored_what) eq 'ARRAY') {
8212: foreach my $lock_descriptor(@{$stored_what}) {
8213: if ($lock_descriptor eq 'graded') {
8214: $readonly_files{$file_name} = 'graded';
8215: } elsif ($lock_descriptor eq 'handback') {
8216: $readonly_files{$file_name} = 'handback';
8217: } else {
8218: if (!exists($readonly_files{$file_name})) {
8219: $readonly_files{$file_name} = 'locked';
8220: }
8221: }
8222: }
8223: }
8224: }
8225: }
8226: }
8227: return %readonly_files;
8228: }
8229: # ------------------------------------------------------------ Unmark as Read Only
8230:
8231: sub unmark_as_readonly {
8232: # unmarks $file_name (if $file_name is defined), or all files locked by $what
8233: # for portfolio submissions, $what contains [$symb,$crsid]
8234: my ($domain,$user,$what,$file_name,$group) = @_;
8235: $file_name = &declutter_portfile($file_name);
8236: my $symb_crs = $what;
8237: if (ref($what)) { $symb_crs=join('',@$what); }
8238: my %current_permissions = &dump('file_permissions',$domain,$user,$group);
8239: my ($tmp)=keys(%current_permissions);
8240: if ($tmp=~/^error:/) { undef(%current_permissions); }
8241: my @readonly_files = &get_marked_as_readonly($domain,$user,$what,$group);
8242: foreach my $file (@readonly_files) {
8243: my $clean_file = &declutter_portfile($file);
8244: if (defined($file_name) && ($file_name ne $clean_file)) { next; }
8245: my $current_locks = $current_permissions{$file};
8246: my @new_locks;
8247: my @del_keys;
8248: if (ref($current_locks) eq "ARRAY"){
8249: foreach my $locker (@{$current_locks}) {
8250: my $compare=$locker;
8251: if (ref($locker) eq 'ARRAY') {
8252: $compare=join('',@{$locker});
8253: if ($compare ne $symb_crs) {
8254: push(@new_locks, $locker);
8255: }
8256: }
8257: }
8258: if (scalar(@new_locks) > 0) {
8259: $current_permissions{$file} = \@new_locks;
8260: } else {
8261: push(@del_keys, $file);
8262: &del('file_permissions',\@del_keys, $domain, $user);
8263: delete($current_permissions{$file});
8264: }
8265: }
8266: }
8267: &put('file_permissions',\%current_permissions,$domain,$user);
8268: return;
8269: }
8270:
8271: # ------------------------------------------------------------ Directory lister
8272:
8273: sub dirlist {
8274: my ($uri,$userdomain,$username,$getpropath,$getuserdir,$alternateRoot)=@_;
8275: $uri=~s/^\///;
8276: $uri=~s/\/$//;
8277: my ($udom, $uname);
8278: if ($getuserdir) {
8279: $udom = $userdomain;
8280: $uname = $username;
8281: } else {
8282: (undef,$udom,$uname)=split(/\//,$uri);
8283: if(defined($userdomain)) {
8284: $udom = $userdomain;
8285: }
8286: if(defined($username)) {
8287: $uname = $username;
8288: }
8289: }
8290: my ($dirRoot,$listing,@listing_results);
8291:
8292: $dirRoot = $perlvar{'lonDocRoot'};
8293: if (defined($getpropath)) {
8294: $dirRoot = &propath($udom,$uname);
8295: $dirRoot =~ s/\/$//;
8296: } elsif (defined($getuserdir)) {
8297: my $subdir=$uname.'__';
8298: $subdir =~ s/(.)(.)(.).*/$1\/$2\/$3/;
8299: $dirRoot = $Apache::lonnet::perlvar{'lonUsersDir'}
8300: ."/$udom/$subdir/$uname";
8301: } elsif (defined($alternateRoot)) {
8302: $dirRoot = $alternateRoot;
8303: }
8304:
8305: if($udom) {
8306: if($uname) {
8307: my $uhome = &homeserver($uname,$udom);
8308: if ($uhome eq 'no_host') {
8309: return ([],'no_host');
8310: }
8311: $listing = &reply('ls3:'.&escape('/'.$uri).':'.$getpropath.':'
8312: .$getuserdir.':'.&escape($dirRoot)
8313: .':'.&escape($uname).':'.&escape($udom),$uhome);
8314: if ($listing eq 'unknown_cmd') {
8315: $listing = &reply('ls2:'.$dirRoot.'/'.$uri,$uhome);
8316: } else {
8317: @listing_results = map { &unescape($_); } split(/:/,$listing);
8318: }
8319: if ($listing eq 'unknown_cmd') {
8320: $listing = &reply('ls:'.$dirRoot.'/'.$uri,$uhome);
8321: @listing_results = split(/:/,$listing);
8322: } else {
8323: @listing_results = map { &unescape($_); } split(/:/,$listing);
8324: }
8325: if (($listing eq 'no_such_host') || ($listing eq 'con_lost') ||
8326: ($listing eq 'rejected') || ($listing eq 'refused') ||
8327: ($listing eq 'no_such_dir') || ($listing eq 'empty')) {
8328: return ([],$listing);
8329: } else {
8330: return (\@listing_results);
8331: }
8332: } elsif(!$alternateRoot) {
8333: my (%allusers,%listerror);
8334: my %servers = &get_servers($udom,'library');
8335: foreach my $tryserver (keys(%servers)) {
8336: $listing = &reply('ls3:'.&escape("/res/$udom").':::::'.
8337: &escape($udom),$tryserver);
8338: if ($listing eq 'unknown_cmd') {
8339: $listing = &reply('ls2:'.$perlvar{'lonDocRoot'}.'/res/'.
8340: $udom, $tryserver);
8341: } else {
8342: @listing_results = map { &unescape($_); } split(/:/,$listing);
8343: }
8344: if ($listing eq 'unknown_cmd') {
8345: $listing = &reply('ls:'.$perlvar{'lonDocRoot'}.'/res/'.
8346: $udom, $tryserver);
8347: @listing_results = split(/:/,$listing);
8348: } else {
8349: @listing_results =
8350: map { &unescape($_); } split(/:/,$listing);
8351: }
8352: if (($listing eq 'no_such_host') || ($listing eq 'con_lost') ||
8353: ($listing eq 'rejected') || ($listing eq 'refused') ||
8354: ($listing eq 'no_such_dir') || ($listing eq 'empty')) {
8355: $listerror{$tryserver} = $listing;
8356: } else {
8357: foreach my $line (@listing_results) {
8358: my ($entry) = split(/&/,$line,2);
8359: $allusers{$entry} = 1;
8360: }
8361: }
8362: }
8363: my @alluserslist=();
8364: foreach my $user (sort(keys(%allusers))) {
8365: push(@alluserslist,$user.'&user');
8366: }
8367: return (\@alluserslist);
8368: } else {
8369: return ([],'missing username');
8370: }
8371: } elsif(!defined($getpropath)) {
8372: my $path = $perlvar{'lonDocRoot'}.'/res/';
8373: my @all_domains = map { $path.$_.'/&domain'; } (sort(&all_domains()));
8374: return (\@all_domains);
8375: } else {
8376: return ([],'missing domain');
8377: }
8378: }
8379:
8380: # --------------------------------------------- GetFileTimestamp
8381: # This function utilizes dirlist and returns the date stamp for
8382: # when it was last modified. It will also return an error of -1
8383: # if an error occurs
8384:
8385: sub GetFileTimestamp {
8386: my ($studentDomain,$studentName,$filename,$getuserdir)=@_;
8387: $studentDomain = &LONCAPA::clean_domain($studentDomain);
8388: $studentName = &LONCAPA::clean_username($studentName);
8389: my ($fileref,$error) = &dirlist($filename,$studentDomain,$studentName,
8390: undef,$getuserdir);
8391: if (($error eq 'empty') || ($error eq 'no_such_dir')) {
8392: return -1;
8393: }
8394: if (ref($fileref) eq 'ARRAY') {
8395: my @stats = split('&',$fileref->[0]);
8396: # @stats contains first the filename, then the stat output
8397: return $stats[10]; # so this is 10 instead of 9.
8398: } else {
8399: return -1;
8400: }
8401: }
8402:
8403: sub stat_file {
8404: my ($uri) = @_;
8405: $uri = &clutter_with_no_wrapper($uri);
8406:
8407: my ($udom,$uname,$file);
8408: if ($uri =~ m-^/(uploaded|editupload)/-) {
8409: ($udom,$uname,$file) =
8410: ($uri =~ m-/(?:uploaded|editupload)/?($match_domain)/?($match_name)/?(.*)-);
8411: $file = 'userfiles/'.$file;
8412: }
8413: if ($uri =~ m-^/res/-) {
8414: ($udom,$uname) =
8415: ($uri =~ m-/(?:res)/?($match_domain)/?($match_username)/-);
8416: $file = $uri;
8417: }
8418:
8419: if (!$udom || !$uname || !$file) {
8420: # unable to handle the uri
8421: return ();
8422: }
8423: my $getpropath;
8424: if ($file =~ /^userfiles\//) {
8425: $getpropath = 1;
8426: }
8427: my ($listref,$error) = &dirlist($file,$udom,$uname,$getpropath);
8428: if (($error eq 'empty') || ($error eq 'no_such_dir')) {
8429: return ();
8430: } else {
8431: if (ref($listref) eq 'ARRAY') {
8432: my @stats = split('&',$listref->[0]);
8433: shift(@stats); #filename is first
8434: return @stats;
8435: }
8436: }
8437: return ();
8438: }
8439:
8440: # -------------------------------------------------------- Value of a Condition
8441:
8442: # gets the value of a specific preevaluated condition
8443: # stored in the string $env{user.state.<cid>}
8444: # or looks up a condition reference in the bighash and if if hasn't
8445: # already been evaluated recurses into docondval to get the value of
8446: # the condition, then memoizing it to
8447: # $env{user.state.<cid>.<condition>}
8448: sub directcondval {
8449: my $number=shift;
8450: if (!defined($env{'user.state.'.$env{'request.course.id'}})) {
8451: &Apache::lonuserstate::evalstate();
8452: }
8453: if (exists($env{'user.state.'.$env{'request.course.id'}.".$number"})) {
8454: return $env{'user.state.'.$env{'request.course.id'}.".$number"};
8455: } elsif ($number =~ /^_/) {
8456: my $sub_condition;
8457: if (tie(my %bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
8458: &GDBM_READER(),0640)) {
8459: $sub_condition=$bighash{'conditions'.$number};
8460: untie(%bighash);
8461: }
8462: my $value = &docondval($sub_condition);
8463: &appenv({'user.state.'.$env{'request.course.id'}.".$number" => $value});
8464: return $value;
8465: }
8466: if ($env{'user.state.'.$env{'request.course.id'}}) {
8467: return substr($env{'user.state.'.$env{'request.course.id'}},$number,1);
8468: } else {
8469: return 2;
8470: }
8471: }
8472:
8473: # get the collection of conditions for this resource
8474: sub condval {
8475: my $condidx=shift;
8476: my $allpathcond='';
8477: foreach my $cond (split(/\|/,$condidx)) {
8478: if (defined($env{'acc.cond.'.$env{'request.course.id'}.'.'.$cond})) {
8479: $allpathcond.=
8480: '('.$env{'acc.cond.'.$env{'request.course.id'}.'.'.$cond}.')|';
8481: }
8482: }
8483: $allpathcond=~s/\|$//;
8484: return &docondval($allpathcond);
8485: }
8486:
8487: #evaluates an expression of conditions
8488: sub docondval {
8489: my ($allpathcond) = @_;
8490: my $result=0;
8491: if ($env{'request.course.id'}
8492: && defined($allpathcond)) {
8493: my $operand='|';
8494: my @stack;
8495: foreach my $chunk ($allpathcond=~/(\d+|_\d+\.\d+|\(|\)|\&|\|)/g) {
8496: if ($chunk eq '(') {
8497: push @stack,($operand,$result);
8498: } elsif ($chunk eq ')') {
8499: my $before=pop @stack;
8500: if (pop @stack eq '&') {
8501: $result=$result>$before?$before:$result;
8502: } else {
8503: $result=$result>$before?$result:$before;
8504: }
8505: } elsif (($chunk eq '&') || ($chunk eq '|')) {
8506: $operand=$chunk;
8507: } else {
8508: my $new=directcondval($chunk);
8509: if ($operand eq '&') {
8510: $result=$result>$new?$new:$result;
8511: } else {
8512: $result=$result>$new?$result:$new;
8513: }
8514: }
8515: }
8516: }
8517: return $result;
8518: }
8519:
8520: # ---------------------------------------------------- Devalidate courseresdata
8521:
8522: sub devalidatecourseresdata {
8523: my ($coursenum,$coursedomain)=@_;
8524: my $hashid=$coursenum.':'.$coursedomain;
8525: &devalidate_cache_new('courseres',$hashid);
8526: }
8527:
8528:
8529: # --------------------------------------------------- Course Resourcedata Query
8530: #
8531: # Parameters:
8532: # $coursenum - Number of the course.
8533: # $coursedomain - Domain at which the course was created.
8534: # Returns:
8535: # A hash of the course parameters along (I think) with timestamps
8536: # and version info.
8537:
8538: sub get_courseresdata {
8539: my ($coursenum,$coursedomain)=@_;
8540: my $coursehom=&homeserver($coursenum,$coursedomain);
8541: my $hashid=$coursenum.':'.$coursedomain;
8542: my ($result,$cached)=&is_cached_new('courseres',$hashid);
8543: my %dumpreply;
8544: unless (defined($cached)) {
8545: %dumpreply=&dump('resourcedata',$coursedomain,$coursenum);
8546: $result=\%dumpreply;
8547: my ($tmp) = keys(%dumpreply);
8548: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
8549: &do_cache_new('courseres',$hashid,$result,600);
8550: } elsif ($tmp =~ /^(con_lost|no_such_host)/) {
8551: return $tmp;
8552: } elsif ($tmp =~ /^(error)/) {
8553: $result=undef;
8554: &do_cache_new('courseres',$hashid,$result,600);
8555: }
8556: }
8557: return $result;
8558: }
8559:
8560: sub devalidateuserresdata {
8561: my ($uname,$udom)=@_;
8562: my $hashid="$udom:$uname";
8563: &devalidate_cache_new('userres',$hashid);
8564: }
8565:
8566: sub get_userresdata {
8567: my ($uname,$udom)=@_;
8568: #most student don\'t have any data set, check if there is some data
8569: if (&EXT_cache_status($udom,$uname)) { return undef; }
8570:
8571: my $hashid="$udom:$uname";
8572: my ($result,$cached)=&is_cached_new('userres',$hashid);
8573: if (!defined($cached)) {
8574: my %resourcedata=&dump('resourcedata',$udom,$uname);
8575: $result=\%resourcedata;
8576: &do_cache_new('userres',$hashid,$result,600);
8577: }
8578: my ($tmp)=keys(%$result);
8579: if (($tmp!~/^error\:/) && ($tmp!~/^con_lost/)) {
8580: return $result;
8581: }
8582: #error 2 occurs when the .db doesn't exist
8583: if ($tmp!~/error: 2 /) {
8584: &logthis("<font color=\"blue\">WARNING:".
8585: " Trying to get resource data for ".
8586: $uname." at ".$udom.": ".
8587: $tmp."</font>");
8588: } elsif ($tmp=~/error: 2 /) {
8589: #&EXT_cache_set($udom,$uname);
8590: &do_cache_new('userres',$hashid,undef,600);
8591: undef($tmp); # not really an error so don't send it back
8592: }
8593: return $tmp;
8594: }
8595: #----------------------------------------------- resdata - return resource data
8596: # Purpose:
8597: # Return resource data for either users or for a course.
8598: # Parameters:
8599: # $name - Course/user name.
8600: # $domain - Name of the domain the user/course is registered on.
8601: # $type - Type of thing $name is (must be 'course' or 'user'
8602: # @which - Array of names of resources desired.
8603: # Returns:
8604: # The value of the first reasource in @which that is found in the
8605: # resource hash.
8606: # Exceptional Conditions:
8607: # If the $type passed in is not valid (not the string 'course' or
8608: # 'user', an undefined reference is returned.
8609: # If none of the resources are found, an undef is returned
8610: sub resdata {
8611: my ($name,$domain,$type,@which)=@_;
8612: my $result;
8613: if ($type eq 'course') {
8614: $result=&get_courseresdata($name,$domain);
8615: } elsif ($type eq 'user') {
8616: $result=&get_userresdata($name,$domain);
8617: }
8618: if (!ref($result)) { return $result; }
8619: foreach my $item (@which) {
8620: if (defined($result->{$item->[0]})) {
8621: return [$result->{$item->[0]},$item->[1]];
8622: }
8623: }
8624: return undef;
8625: }
8626:
8627: #
8628: # EXT resource caching routines
8629: #
8630:
8631: sub clear_EXT_cache_status {
8632: &delenv('cache.EXT.');
8633: }
8634:
8635: sub EXT_cache_status {
8636: my ($target_domain,$target_user) = @_;
8637: my $cachename = 'cache.EXT.'.$target_user.'.'.$target_domain;
8638: if (exists($env{$cachename}) && ($env{$cachename}+600) > time) {
8639: # We know already the user has no data
8640: return 1;
8641: } else {
8642: return 0;
8643: }
8644: }
8645:
8646: sub EXT_cache_set {
8647: my ($target_domain,$target_user) = @_;
8648: my $cachename = 'cache.EXT.'.$target_user.'.'.$target_domain;
8649: #&appenv({$cachename => time});
8650: }
8651:
8652: # --------------------------------------------------------- Value of a Variable
8653: sub EXT {
8654:
8655: my ($varname,$symbparm,$udom,$uname,$usection,$recurse)=@_;
8656: unless ($varname) { return ''; }
8657: #get real user name/domain, courseid and symb
8658: my $courseid;
8659: my $publicuser;
8660: if ($symbparm) {
8661: $symbparm=&get_symb_from_alias($symbparm);
8662: }
8663: if (!($uname && $udom)) {
8664: (my $cursymb,$courseid,$udom,$uname,$publicuser)= &whichuser($symbparm);
8665: if (!$symbparm) { $symbparm=$cursymb; }
8666: } else {
8667: $courseid=$env{'request.course.id'};
8668: }
8669: my ($realm,$space,$qualifier,@therest)=split(/\./,$varname);
8670: my $rest;
8671: if (defined($therest[0])) {
8672: $rest=join('.',@therest);
8673: } else {
8674: $rest='';
8675: }
8676:
8677: my $qualifierrest=$qualifier;
8678: if ($rest) { $qualifierrest.='.'.$rest; }
8679: my $spacequalifierrest=$space;
8680: if ($qualifierrest) { $spacequalifierrest.='.'.$qualifierrest; }
8681: if ($realm eq 'user') {
8682: # --------------------------------------------------------------- user.resource
8683: if ($space eq 'resource') {
8684: if ( (defined($Apache::lonhomework::parsing_a_problem)
8685: || defined($Apache::lonhomework::parsing_a_task))
8686: &&
8687: ($symbparm eq &symbread()) ) {
8688: # if we are in the middle of processing the resource the
8689: # get the value we are planning on committing
8690: if (defined($Apache::lonhomework::results{$qualifierrest})) {
8691: return $Apache::lonhomework::results{$qualifierrest};
8692: } else {
8693: return $Apache::lonhomework::history{$qualifierrest};
8694: }
8695: } else {
8696: my %restored;
8697: if ($publicuser || $env{'request.state'} eq 'construct') {
8698: %restored=&tmprestore($symbparm,$courseid,$udom,$uname);
8699: } else {
8700: %restored=&restore($symbparm,$courseid,$udom,$uname);
8701: }
8702: return $restored{$qualifierrest};
8703: }
8704: # ----------------------------------------------------------------- user.access
8705: } elsif ($space eq 'access') {
8706: # FIXME - not supporting calls for a specific user
8707: return &allowed($qualifier,$rest);
8708: # ------------------------------------------ user.preferences, user.environment
8709: } elsif (($space eq 'preferences') || ($space eq 'environment')) {
8710: if (($uname eq $env{'user.name'}) &&
8711: ($udom eq $env{'user.domain'})) {
8712: return $env{join('.',('environment',$qualifierrest))};
8713: } else {
8714: my %returnhash;
8715: if (!$publicuser) {
8716: %returnhash=&userenvironment($udom,$uname,
8717: $qualifierrest);
8718: }
8719: return $returnhash{$qualifierrest};
8720: }
8721: # ----------------------------------------------------------------- user.course
8722: } elsif ($space eq 'course') {
8723: # FIXME - not supporting calls for a specific user
8724: return $env{join('.',('request.course',$qualifier))};
8725: # ------------------------------------------------------------------- user.role
8726: } elsif ($space eq 'role') {
8727: # FIXME - not supporting calls for a specific user
8728: my ($role,$where)=split(/\./,$env{'request.role'});
8729: if ($qualifier eq 'value') {
8730: return $role;
8731: } elsif ($qualifier eq 'extent') {
8732: return $where;
8733: }
8734: # ----------------------------------------------------------------- user.domain
8735: } elsif ($space eq 'domain') {
8736: return $udom;
8737: # ------------------------------------------------------------------- user.name
8738: } elsif ($space eq 'name') {
8739: return $uname;
8740: # ---------------------------------------------------- Any other user namespace
8741: } else {
8742: my %reply;
8743: if (!$publicuser) {
8744: %reply=&get($space,[$qualifierrest],$udom,$uname);
8745: }
8746: return $reply{$qualifierrest};
8747: }
8748: } elsif ($realm eq 'query') {
8749: # ---------------------------------------------- pull stuff out of query string
8750: &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},
8751: [$spacequalifierrest]);
8752: return $env{'form.'.$spacequalifierrest};
8753: } elsif ($realm eq 'request') {
8754: # ------------------------------------------------------------- request.browser
8755: if ($space eq 'browser') {
8756: return $env{'browser.'.$qualifier};
8757: # ------------------------------------------------------------ request.filename
8758: } else {
8759: return $env{'request.'.$spacequalifierrest};
8760: }
8761: } elsif ($realm eq 'course') {
8762: # ---------------------------------------------------------- course.description
8763: return $env{'course.'.$courseid.'.'.$spacequalifierrest};
8764: } elsif ($realm eq 'resource') {
8765:
8766: if (defined($courseid) && $courseid eq $env{'request.course.id'}) {
8767: if (!$symbparm) { $symbparm=&symbread(); }
8768: }
8769:
8770: if ($space eq 'title') {
8771: if (!$symbparm) { $symbparm = $env{'request.filename'}; }
8772: return &gettitle($symbparm);
8773: }
8774:
8775: if ($space eq 'map') {
8776: my ($map) = &decode_symb($symbparm);
8777: return &symbread($map);
8778: }
8779: if ($space eq 'filename') {
8780: if ($symbparm) {
8781: return &clutter((&decode_symb($symbparm))[2]);
8782: }
8783: return &hreflocation('',$env{'request.filename'});
8784: }
8785:
8786: my ($section, $group, @groups);
8787: my ($courselevelm,$courselevel);
8788: if ($symbparm && defined($courseid) &&
8789: $courseid eq $env{'request.course.id'}) {
8790:
8791: #print '<br>'.$space.' - '.$qualifier.' - '.$spacequalifierrest;
8792:
8793: # ----------------------------------------------------- Cascading lookup scheme
8794: my $symbp=$symbparm;
8795: my $mapp=&deversion((&decode_symb($symbp))[0]);
8796:
8797: my $symbparm=$symbp.'.'.$spacequalifierrest;
8798: my $mapparm=$mapp.'___(all).'.$spacequalifierrest;
8799:
8800: if (($env{'user.name'} eq $uname) &&
8801: ($env{'user.domain'} eq $udom)) {
8802: $section=$env{'request.course.sec'};
8803: @groups = split(/:/,$env{'request.course.groups'});
8804: @groups=&sort_course_groups($courseid,@groups);
8805: } else {
8806: if (! defined($usection)) {
8807: $section=&getsection($udom,$uname,$courseid);
8808: } else {
8809: $section = $usection;
8810: }
8811: @groups = &get_users_groups($udom,$uname,$courseid);
8812: }
8813:
8814: my $seclevel=$courseid.'.['.$section.'].'.$spacequalifierrest;
8815: my $seclevelr=$courseid.'.['.$section.'].'.$symbparm;
8816: my $seclevelm=$courseid.'.['.$section.'].'.$mapparm;
8817:
8818: $courselevel=$courseid.'.'.$spacequalifierrest;
8819: my $courselevelr=$courseid.'.'.$symbparm;
8820: $courselevelm=$courseid.'.'.$mapparm;
8821:
8822: # ----------------------------------------------------------- first, check user
8823:
8824: my $userreply=&resdata($uname,$udom,'user',
8825: ([$courselevelr,'resource'],
8826: [$courselevelm,'map' ],
8827: [$courselevel, 'course' ]));
8828: if (defined($userreply)) { return &get_reply($userreply); }
8829:
8830: # ------------------------------------------------ second, check some of course
8831: my $coursereply;
8832: if (@groups > 0) {
8833: $coursereply = &check_group_parms($courseid,\@groups,$symbparm,
8834: $mapparm,$spacequalifierrest);
8835: if (defined($coursereply)) { return &get_reply($coursereply); }
8836: }
8837:
8838: $coursereply=&resdata($env{'course.'.$courseid.'.num'},
8839: $env{'course.'.$courseid.'.domain'},
8840: 'course',
8841: ([$seclevelr, 'resource'],
8842: [$seclevelm, 'map' ],
8843: [$seclevel, 'course' ],
8844: [$courselevelr,'resource']));
8845: if (defined($coursereply)) { return &get_reply($coursereply); }
8846:
8847: # ------------------------------------------------------ third, check map parms
8848: my %parmhash=();
8849: my $thisparm='';
8850: if (tie(%parmhash,'GDBM_File',
8851: $env{'request.course.fn'}.'_parms.db',
8852: &GDBM_READER(),0640)) {
8853: $thisparm=$parmhash{$symbparm};
8854: untie(%parmhash);
8855: }
8856: if ($thisparm) { return &get_reply([$thisparm,'resource']); }
8857: }
8858: # ------------------------------------------ fourth, look in resource metadata
8859:
8860: $spacequalifierrest=~s/\./\_/;
8861: my $filename;
8862: if (!$symbparm) { $symbparm=&symbread(); }
8863: if ($symbparm) {
8864: $filename=(&decode_symb($symbparm))[2];
8865: } else {
8866: $filename=$env{'request.filename'};
8867: }
8868: my $metadata=&metadata($filename,$spacequalifierrest);
8869: if (defined($metadata)) { return &get_reply([$metadata,'resource']); }
8870: $metadata=&metadata($filename,'parameter_'.$spacequalifierrest);
8871: if (defined($metadata)) { return &get_reply([$metadata,'resource']); }
8872:
8873: # ---------------------------------------------- fourth, look in rest of course
8874: if ($symbparm && defined($courseid) &&
8875: $courseid eq $env{'request.course.id'}) {
8876: my $coursereply=&resdata($env{'course.'.$courseid.'.num'},
8877: $env{'course.'.$courseid.'.domain'},
8878: 'course',
8879: ([$courselevelm,'map' ],
8880: [$courselevel, 'course']));
8881: if (defined($coursereply)) { return &get_reply($coursereply); }
8882: }
8883: # ------------------------------------------------------------------ Cascade up
8884: unless ($space eq '0') {
8885: my @parts=split(/_/,$space);
8886: my $id=pop(@parts);
8887: my $part=join('_',@parts);
8888: if ($part eq '') { $part='0'; }
8889: my @partgeneral=&EXT('resource.'.$part.'.'.$qualifierrest,
8890: $symbparm,$udom,$uname,$section,1);
8891: if (defined($partgeneral[0])) { return &get_reply(\@partgeneral); }
8892: }
8893: if ($recurse) { return undef; }
8894: my $pack_def=&packages_tab_default($filename,$varname);
8895: if (defined($pack_def)) { return &get_reply([$pack_def,'resource']); }
8896: # ---------------------------------------------------- Any other user namespace
8897: } elsif ($realm eq 'environment') {
8898: # ----------------------------------------------------------------- environment
8899: if (($uname eq $env{'user.name'})&&($udom eq $env{'user.domain'})) {
8900: return $env{'environment.'.$spacequalifierrest};
8901: } else {
8902: if ($uname eq 'anonymous' && $udom eq '') {
8903: return '';
8904: }
8905: my %returnhash=&userenvironment($udom,$uname,
8906: $spacequalifierrest);
8907: return $returnhash{$spacequalifierrest};
8908: }
8909: } elsif ($realm eq 'system') {
8910: # ----------------------------------------------------------------- system.time
8911: if ($space eq 'time') {
8912: return time;
8913: }
8914: } elsif ($realm eq 'server') {
8915: # ----------------------------------------------------------------- system.time
8916: if ($space eq 'name') {
8917: return $ENV{'SERVER_NAME'};
8918: }
8919: }
8920: return '';
8921: }
8922:
8923: sub get_reply {
8924: my ($reply_value) = @_;
8925: if (ref($reply_value) eq 'ARRAY') {
8926: if (wantarray) {
8927: return @$reply_value;
8928: }
8929: return $reply_value->[0];
8930: } else {
8931: return $reply_value;
8932: }
8933: }
8934:
8935: sub check_group_parms {
8936: my ($courseid,$groups,$symbparm,$mapparm,$what) = @_;
8937: my @groupitems = ();
8938: my $resultitem;
8939: my @levels = ([$symbparm,'resource'],[$mapparm,'map'],[$what,'course']);
8940: foreach my $group (@{$groups}) {
8941: foreach my $level (@levels) {
8942: my $item = $courseid.'.['.$group.'].'.$level->[0];
8943: push(@groupitems,[$item,$level->[1]]);
8944: }
8945: }
8946: my $coursereply = &resdata($env{'course.'.$courseid.'.num'},
8947: $env{'course.'.$courseid.'.domain'},
8948: 'course',@groupitems);
8949: return $coursereply;
8950: }
8951:
8952: sub sort_course_groups { # Sort groups based on defined rankings. Default is sort().
8953: my ($courseid,@groups) = @_;
8954: @groups = sort(@groups);
8955: return @groups;
8956: }
8957:
8958: sub packages_tab_default {
8959: my ($uri,$varname)=@_;
8960: my (undef,$part,$name)=split(/\./,$varname);
8961:
8962: my (@extension,@specifics,$do_default);
8963: foreach my $package (split(/,/,&metadata($uri,'packages'))) {
8964: my ($pack_type,$pack_part)=split(/_/,$package,2);
8965: if ($pack_type eq 'default') {
8966: $do_default=1;
8967: } elsif ($pack_type eq 'extension') {
8968: push(@extension,[$package,$pack_type,$pack_part]);
8969: } elsif ($pack_part eq $part || $pack_type eq 'part') {
8970: # only look at packages defaults for packages that this id is
8971: push(@specifics,[$package,$pack_type,$pack_part]);
8972: }
8973: }
8974: # first look for a package that matches the requested part id
8975: foreach my $package (@specifics) {
8976: my (undef,$pack_type,$pack_part)=@{$package};
8977: next if ($pack_part ne $part);
8978: if (defined($packagetab{"$pack_type&$name&default"})) {
8979: return $packagetab{"$pack_type&$name&default"};
8980: }
8981: }
8982: # look for any possible matching non extension_ package
8983: foreach my $package (@specifics) {
8984: my (undef,$pack_type,$pack_part)=@{$package};
8985: if (defined($packagetab{"$pack_type&$name&default"})) {
8986: return $packagetab{"$pack_type&$name&default"};
8987: }
8988: if ($pack_type eq 'part') { $pack_part='0'; }
8989: if (defined($packagetab{$pack_type."_".$pack_part."&$name&default"})) {
8990: return $packagetab{$pack_type."_".$pack_part."&$name&default"};
8991: }
8992: }
8993: # look for any posible extension_ match
8994: foreach my $package (@extension) {
8995: my ($package,$pack_type)=@{$package};
8996: if (defined($packagetab{"$pack_type&$name&default"})) {
8997: return $packagetab{"$pack_type&$name&default"};
8998: }
8999: if (defined($packagetab{$package."&$name&default"})) {
9000: return $packagetab{$package."&$name&default"};
9001: }
9002: }
9003: # look for a global default setting
9004: if ($do_default && defined($packagetab{"default&$name&default"})) {
9005: return $packagetab{"default&$name&default"};
9006: }
9007: return undef;
9008: }
9009:
9010: sub add_prefix_and_part {
9011: my ($prefix,$part)=@_;
9012: my $keyroot;
9013: if (defined($prefix) && $prefix !~ /^__/) {
9014: # prefix that has a part already
9015: $keyroot=$prefix;
9016: } elsif (defined($prefix)) {
9017: # prefix that is missing a part
9018: if (defined($part)) { $keyroot='_'.$part.substr($prefix,1); }
9019: } else {
9020: # no prefix at all
9021: if (defined($part)) { $keyroot='_'.$part; }
9022: }
9023: return $keyroot;
9024: }
9025:
9026: # ---------------------------------------------------------------- Get metadata
9027:
9028: my %metaentry;
9029: my %importedpartids;
9030: sub metadata {
9031: my ($uri,$what,$liburi,$prefix,$depthcount)=@_;
9032: $uri=&declutter($uri);
9033: # if it is a non metadata possible uri return quickly
9034: if (($uri eq '') ||
9035: (($uri =~ m|^/*adm/|) &&
9036: ($uri !~ m|^adm/includes|) && ($uri !~ m|/bulletinboard$|)) ||
9037: ($uri =~ m|/$|) || ($uri =~ m|/.meta$|) || ($uri =~ m{^/*uploaded/.+\.sequence$})) {
9038: return undef;
9039: }
9040: if (($uri =~ /^priv/ || $uri=~/home\/httpd\/html\/priv/)
9041: && &Apache::lonxml::get_state('target') =~ /^(|meta)$/) {
9042: return undef;
9043: }
9044: my $filename=$uri;
9045: $uri=~s/\.meta$//;
9046: #
9047: # Is the metadata already cached?
9048: # Look at timestamp of caching
9049: # Everything is cached by the main uri, libraries are never directly cached
9050: #
9051: if (!defined($liburi)) {
9052: my ($result,$cached)=&is_cached_new('meta',$uri);
9053: if (defined($cached)) { return $result->{':'.$what}; }
9054: }
9055: {
9056: # Imported parts would go here
9057: my %importedids=();
9058: my @origfileimportpartids=();
9059: my $importedparts=0;
9060: #
9061: # Is this a recursive call for a library?
9062: #
9063: # if (! exists($metacache{$uri})) {
9064: # $metacache{$uri}={};
9065: # }
9066: my $cachetime = 60*60;
9067: if ($liburi) {
9068: $liburi=&declutter($liburi);
9069: $filename=$liburi;
9070: } else {
9071: &devalidate_cache_new('meta',$uri);
9072: undef(%metaentry);
9073: }
9074: my %metathesekeys=();
9075: unless ($filename=~/\.meta$/) { $filename.='.meta'; }
9076: my $metastring;
9077: if ($uri =~ /^priv/ || $uri=~/home\/httpd\/html\/priv/) {
9078: my $which = &hreflocation('','/'.($liburi || $uri));
9079: $metastring =
9080: &Apache::lonnet::ssi_body($which,
9081: ('grade_target' => 'meta'));
9082: $cachetime = 1; # only want this cached in the child not long term
9083: } elsif (($uri !~ m -^(editupload)/-) &&
9084: ($uri !~ m{^/*uploaded/$match_domain/$match_courseid/docs/})) {
9085: my $file=&filelocation('',&clutter($filename));
9086: #push(@{$metaentry{$uri.'.file'}},$file);
9087: $metastring=&getfile($file);
9088: }
9089: my $parser=HTML::LCParser->new(\$metastring);
9090: my $token;
9091: undef %metathesekeys;
9092: while ($token=$parser->get_token) {
9093: if ($token->[0] eq 'S') {
9094: if (defined($token->[2]->{'package'})) {
9095: #
9096: # This is a package - get package info
9097: #
9098: my $package=$token->[2]->{'package'};
9099: my $keyroot=&add_prefix_and_part($prefix,$token->[2]->{'part'});
9100: if (defined($token->[2]->{'id'})) {
9101: $keyroot.='_'.$token->[2]->{'id'};
9102: }
9103: if ($metaentry{':packages'}) {
9104: $metaentry{':packages'}.=','.$package.$keyroot;
9105: } else {
9106: $metaentry{':packages'}=$package.$keyroot;
9107: }
9108: foreach my $pack_entry (keys(%packagetab)) {
9109: my $part=$keyroot;
9110: $part=~s/^\_//;
9111: if ($pack_entry=~/^\Q$package\E\&/ ||
9112: $pack_entry=~/^\Q$package\E_0\&/) {
9113: my ($pack,$name,$subp)=split(/\&/,$pack_entry);
9114: # ignore package.tab specified default values
9115: # here &package_tab_default() will fetch those
9116: if ($subp eq 'default') { next; }
9117: my $value=$packagetab{$pack_entry};
9118: my $unikey;
9119: if ($pack =~ /_0$/) {
9120: $unikey='parameter_0_'.$name;
9121: $part=0;
9122: } else {
9123: $unikey='parameter'.$keyroot.'_'.$name;
9124: }
9125: if ($subp eq 'display') {
9126: $value.=' [Part: '.$part.']';
9127: }
9128: $metaentry{':'.$unikey.'.part'}=$part;
9129: $metathesekeys{$unikey}=1;
9130: unless (defined($metaentry{':'.$unikey.'.'.$subp})) {
9131: $metaentry{':'.$unikey.'.'.$subp}=$value;
9132: }
9133: if (defined($metaentry{':'.$unikey.'.default'})) {
9134: $metaentry{':'.$unikey}=
9135: $metaentry{':'.$unikey.'.default'};
9136: }
9137: }
9138: }
9139: } else {
9140: #
9141: # This is not a package - some other kind of start tag
9142: #
9143: my $entry=$token->[1];
9144: my $unikey='';
9145:
9146: if ($entry eq 'import') {
9147: #
9148: # Importing a library here
9149: #
9150: my $location=$parser->get_text('/import');
9151: my $dir=$filename;
9152: $dir=~s|[^/]*$||;
9153: $location=&filelocation($dir,$location);
9154:
9155: my $importmode=$token->[2]->{'importmode'};
9156: if ($importmode eq 'problem') {
9157: # Import as problem/response
9158: $unikey=&add_prefix_and_part($prefix,$token->[2]->{'part'});
9159: } elsif ($importmode eq 'part') {
9160: # Import as part(s)
9161: $importedparts=1;
9162: # We need to get the original file and the imported file to get the part order correct
9163: # Good news: we do not need to worry about nested libraries, since parts cannot be nested
9164: # Load and inspect original file
9165: if ($#origfileimportpartids<0) {
9166: undef(%importedpartids);
9167: my $origfilelocation=$perlvar{'lonDocRoot'}.&clutter($uri);
9168: my $origfile=&getfile($origfilelocation);
9169: @origfileimportpartids=($origfile=~/<(part|import)[^>]*id\s*=\s*[\"\']([^\"\']+)[\"\'][^>]*>/gs);
9170: }
9171:
9172: # Load and inspect imported file
9173: my $impfile=&getfile($location);
9174: my @impfilepartids=($impfile=~/<part[^>]*id\s*=\s*[\"\']([^\"\']+)[\"\'][^>]*>/gs);
9175: if ($#impfilepartids>=0) {
9176: # This problem had parts
9177: $importedpartids{$token->[2]->{'id'}}=join(',',@impfilepartids);
9178: } else {
9179: # Importing by turning a single problem into a problem part
9180: # It gets the import-tags ID as part-ID
9181: $unikey=&add_prefix_and_part($prefix,$token->[2]->{'id'});
9182: $importedpartids{$token->[2]->{'id'}}=$token->[2]->{'id'};
9183: }
9184: } else {
9185: # Normal import
9186: $unikey=&add_prefix_and_part($prefix,$token->[2]->{'part'});
9187: if (defined($token->[2]->{'id'})) {
9188: $unikey.='_'.$token->[2]->{'id'};
9189: }
9190: }
9191:
9192: if ($depthcount<20) {
9193: my $metadata =
9194: &metadata($uri,'keys', $location,$unikey,
9195: $depthcount+1);
9196: foreach my $meta (split(',',$metadata)) {
9197: $metaentry{':'.$meta}=$metaentry{':'.$meta};
9198: $metathesekeys{$meta}=1;
9199: }
9200:
9201: }
9202: } else {
9203: #
9204: # Not importing, some other kind of non-package, non-library start tag
9205: #
9206: $unikey=$entry.&add_prefix_and_part($prefix,$token->[2]->{'part'});
9207: if (defined($token->[2]->{'id'})) {
9208: $unikey.='_'.$token->[2]->{'id'};
9209: }
9210: if (defined($token->[2]->{'name'})) {
9211: $unikey.='_'.$token->[2]->{'name'};
9212: }
9213: $metathesekeys{$unikey}=1;
9214: foreach my $param (@{$token->[3]}) {
9215: $metaentry{':'.$unikey.'.'.$param} =
9216: $token->[2]->{$param};
9217: }
9218: my $internaltext=&HTML::Entities::decode($parser->get_text('/'.$entry));
9219: my $default=$metaentry{':'.$unikey.'.default'};
9220: if ( $internaltext =~ /^\s*$/ && $default !~ /^\s*$/) {
9221: # only ws inside the tag, and not in default, so use default
9222: # as value
9223: $metaentry{':'.$unikey}=$default;
9224: } elsif ( $internaltext =~ /\S/ ) {
9225: # something interesting inside the tag
9226: $metaentry{':'.$unikey}=$internaltext;
9227: } else {
9228: # no interesting values, don't set a default
9229: }
9230: # end of not-a-package not-a-library import
9231: }
9232: # end of not-a-package start tag
9233: }
9234: # the next is the end of "start tag"
9235: }
9236: }
9237: my ($extension) = ($uri =~ /\.(\w+)$/);
9238: $extension = lc($extension);
9239: if ($extension eq 'htm') { $extension='html'; }
9240:
9241: foreach my $key (keys(%packagetab)) {
9242: #no specific packages #how's our extension
9243: if ($key!~/^extension_\Q$extension\E&/) { next; }
9244: &metadata_create_package_def($uri,$key,'extension_'.$extension,
9245: \%metathesekeys);
9246: }
9247:
9248: if (!exists($metaentry{':packages'})
9249: || $packagetab{"import_defaults&extension_$extension"}) {
9250: foreach my $key (keys(%packagetab)) {
9251: #no specific packages well let's get default then
9252: if ($key!~/^default&/) { next; }
9253: &metadata_create_package_def($uri,$key,'default',
9254: \%metathesekeys);
9255: }
9256: }
9257: # are there custom rights to evaluate
9258: if ($metaentry{':copyright'} eq 'custom') {
9259:
9260: #
9261: # Importing a rights file here
9262: #
9263: unless ($depthcount) {
9264: my $location=$metaentry{':customdistributionfile'};
9265: my $dir=$filename;
9266: $dir=~s|[^/]*$||;
9267: $location=&filelocation($dir,$location);
9268: my $rights_metadata =
9269: &metadata($uri,'keys',$location,'_rights',
9270: $depthcount+1);
9271: foreach my $rights (split(',',$rights_metadata)) {
9272: #$metaentry{':'.$rights}=$metacache{$uri}->{':'.$rights};
9273: $metathesekeys{$rights}=1;
9274: }
9275: }
9276: }
9277: # uniqifiy package listing
9278: my %seen;
9279: my @uniq_packages =
9280: grep { ! $seen{$_} ++ } (split(',',$metaentry{':packages'}));
9281: $metaentry{':packages'} = join(',',@uniq_packages);
9282:
9283: if ($importedparts) {
9284: # We had imported parts and need to rebuild partorder
9285: $metaentry{':partorder'}='';
9286: $metathesekeys{'partorder'}=1;
9287: for (my $index=0;$index<$#origfileimportpartids;$index+=2) {
9288: if ($origfileimportpartids[$index] eq 'part') {
9289: # original part, part of the problem
9290: $metaentry{':partorder'}.=','.$origfileimportpartids[$index+1];
9291: } else {
9292: # we have imported parts at this position
9293: $metaentry{':partorder'}.=','.$importedpartids{$origfileimportpartids[$index+1]};
9294: }
9295: }
9296: $metaentry{':partorder'}=~s/^\,//;
9297: }
9298:
9299: $metaentry{':keys'} = join(',',keys(%metathesekeys));
9300: &metadata_generate_part0(\%metathesekeys,\%metaentry,$uri);
9301: $metaentry{':allpossiblekeys'}=join(',',keys %metathesekeys);
9302: &do_cache_new('meta',$uri,\%metaentry,$cachetime);
9303: # this is the end of "was not already recently cached
9304: }
9305: return $metaentry{':'.$what};
9306: }
9307:
9308: sub metadata_create_package_def {
9309: my ($uri,$key,$package,$metathesekeys)=@_;
9310: my ($pack,$name,$subp)=split(/\&/,$key);
9311: if ($subp eq 'default') { next; }
9312:
9313: if (defined($metaentry{':packages'})) {
9314: $metaentry{':packages'}.=','.$package;
9315: } else {
9316: $metaentry{':packages'}=$package;
9317: }
9318: my $value=$packagetab{$key};
9319: my $unikey;
9320: $unikey='parameter_0_'.$name;
9321: $metaentry{':'.$unikey.'.part'}=0;
9322: $$metathesekeys{$unikey}=1;
9323: unless (defined($metaentry{':'.$unikey.'.'.$subp})) {
9324: $metaentry{':'.$unikey.'.'.$subp}=$value;
9325: }
9326: if (defined($metaentry{':'.$unikey.'.default'})) {
9327: $metaentry{':'.$unikey}=
9328: $metaentry{':'.$unikey.'.default'};
9329: }
9330: }
9331:
9332: sub metadata_generate_part0 {
9333: my ($metadata,$metacache,$uri) = @_;
9334: my %allnames;
9335: foreach my $metakey (keys(%$metadata)) {
9336: if ($metakey=~/^parameter\_(.*)/) {
9337: my $part=$$metacache{':'.$metakey.'.part'};
9338: my $name=$$metacache{':'.$metakey.'.name'};
9339: if (! exists($$metadata{'parameter_0_'.$name.'.name'})) {
9340: $allnames{$name}=$part;
9341: }
9342: }
9343: }
9344: foreach my $name (keys(%allnames)) {
9345: $$metadata{"parameter_0_$name"}=1;
9346: my $key=":parameter_0_$name";
9347: $$metacache{"$key.part"}='0';
9348: $$metacache{"$key.name"}=$name;
9349: $$metacache{"$key.type"}=$$metacache{':parameter_'.
9350: $allnames{$name}.'_'.$name.
9351: '.type'};
9352: my $olddis=$$metacache{':parameter_'.$allnames{$name}.'_'.$name.
9353: '.display'};
9354: my $expr='[Part: '.$allnames{$name}.']';
9355: $olddis=~s/\Q$expr\E/\[Part: 0\]/;
9356: $$metacache{"$key.display"}=$olddis;
9357: }
9358: }
9359:
9360: # ------------------------------------------------------ Devalidate title cache
9361:
9362: sub devalidate_title_cache {
9363: my ($url)=@_;
9364: if (!$env{'request.course.id'}) { return; }
9365: my $symb=&symbread($url);
9366: if (!$symb) { return; }
9367: my $key=$env{'request.course.id'}."\0".$symb;
9368: &devalidate_cache_new('title',$key);
9369: }
9370:
9371: # ------------------------------------------------- Get the title of a course
9372:
9373: sub current_course_title {
9374: return $env{ 'course.' . $env{'request.course.id'} . '.description' };
9375: }
9376: # ------------------------------------------------- Get the title of a resource
9377:
9378: sub gettitle {
9379: my $urlsymb=shift;
9380: my $symb=&symbread($urlsymb);
9381: if ($symb) {
9382: my $key=$env{'request.course.id'}."\0".$symb;
9383: my ($result,$cached)=&is_cached_new('title',$key);
9384: if (defined($cached)) {
9385: return $result;
9386: }
9387: my ($map,$resid,$url)=&decode_symb($symb);
9388: my $title='';
9389: if (!$map && $resid == 0 && $url =~/default\.sequence$/) {
9390: $title = $env{'course.'.$env{'request.course.id'}.'.description'};
9391: } else {
9392: if (tie(my %bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
9393: &GDBM_READER(),0640)) {
9394: my $mapid=$bighash{'map_pc_'.&clutter($map)};
9395: $title=$bighash{'title_'.$mapid.'.'.$resid};
9396: untie(%bighash);
9397: }
9398: }
9399: $title=~s/\&colon\;/\:/gs;
9400: if ($title) {
9401: return &do_cache_new('title',$key,$title,600);
9402: }
9403: $urlsymb=$url;
9404: }
9405: my $title=&metadata($urlsymb,'title');
9406: if (!$title) { $title=(split('/',$urlsymb))[-1]; }
9407: return $title;
9408: }
9409:
9410: sub get_slot {
9411: my ($which,$cnum,$cdom)=@_;
9412: if (!$cnum || !$cdom) {
9413: (undef,my $courseid)=&whichuser();
9414: $cdom=$env{'course.'.$courseid.'.domain'};
9415: $cnum=$env{'course.'.$courseid.'.num'};
9416: }
9417: my $key=join("\0",'slots',$cdom,$cnum,$which);
9418: my %slotinfo;
9419: if (exists($remembered{$key})) {
9420: $slotinfo{$which} = $remembered{$key};
9421: } else {
9422: %slotinfo=&get('slots',[$which],$cdom,$cnum);
9423: &Apache::lonhomework::showhash(%slotinfo);
9424: my ($tmp)=keys(%slotinfo);
9425: if ($tmp=~/^error:/) { return (); }
9426: $remembered{$key} = $slotinfo{$which};
9427: }
9428: if (ref($slotinfo{$which}) eq 'HASH') {
9429: return %{$slotinfo{$which}};
9430: }
9431: return $slotinfo{$which};
9432: }
9433:
9434: sub get_reservable_slots {
9435: my ($cnum,$cdom,$uname,$udom) = @_;
9436: my $now = time;
9437: my $reservable_info;
9438: my $key=join("\0",'reservableslots',$cdom,$cnum,$uname,$udom);
9439: if (exists($remembered{$key})) {
9440: $reservable_info = $remembered{$key};
9441: } else {
9442: my %resv;
9443: ($resv{'now_order'},$resv{'now'},$resv{'future_order'},$resv{'future'}) =
9444: &Apache::loncommon::get_future_slots($cnum,$cdom,$now);
9445: $reservable_info = \%resv;
9446: $remembered{$key} = $reservable_info;
9447: }
9448: return $reservable_info;
9449: }
9450:
9451: sub get_course_slots {
9452: my ($cnum,$cdom) = @_;
9453: my $hashid=$cnum.':'.$cdom;
9454: my ($result,$cached) = &Apache::lonnet::is_cached_new('allslots',$hashid);
9455: if (defined($cached)) {
9456: if (ref($result) eq 'HASH') {
9457: return %{$result};
9458: }
9459: } else {
9460: my %slots=&Apache::lonnet::dump('slots',$cdom,$cnum);
9461: my ($tmp) = keys(%slots);
9462: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
9463: &Apache::lonnet::do_cache_new('allslots',$hashid,\%slots,600);
9464: return %slots;
9465: }
9466: }
9467: return;
9468: }
9469:
9470: sub devalidate_slots_cache {
9471: my ($cnum,$cdom)=@_;
9472: my $hashid=$cnum.':'.$cdom;
9473: &devalidate_cache_new('allslots',$hashid);
9474: }
9475:
9476: # ------------------------------------------------- Update symbolic store links
9477:
9478: sub symblist {
9479: my ($mapname,%newhash)=@_;
9480: $mapname=&deversion(&declutter($mapname));
9481: my %hash;
9482: if (($env{'request.course.fn'}) && (%newhash)) {
9483: if (tie(%hash,'GDBM_File',$env{'request.course.fn'}.'_symb.db',
9484: &GDBM_WRCREAT(),0640)) {
9485: foreach my $url (keys(%newhash)) {
9486: next if ($url eq 'last_known'
9487: && $env{'form.no_update_last_known'});
9488: $hash{declutter($url)}=&encode_symb($mapname,
9489: $newhash{$url}->[1],
9490: $newhash{$url}->[0]);
9491: }
9492: if (untie(%hash)) {
9493: return 'ok';
9494: }
9495: }
9496: }
9497: return 'error';
9498: }
9499:
9500: # --------------------------------------------------------------- Verify a symb
9501:
9502: sub symbverify {
9503: my ($symb,$thisurl)=@_;
9504: my $thisfn=$thisurl;
9505: $thisfn=&declutter($thisfn);
9506: # direct jump to resource in page or to a sequence - will construct own symbs
9507: if ($thisfn=~/\.(page|sequence)$/) { return 1; }
9508: # check URL part
9509: my ($map,$resid,$url)=&decode_symb($symb);
9510:
9511: unless ($url eq $thisfn) { return 0; }
9512:
9513: $symb=&symbclean($symb);
9514: $thisurl=&deversion($thisurl);
9515: $thisfn=&deversion($thisfn);
9516:
9517: my %bighash;
9518: my $okay=0;
9519:
9520: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
9521: &GDBM_READER(),0640)) {
9522: if (($thisurl =~ m{^/adm/wrapper/ext/}) || ($thisurl =~ m{^ext/})) {
9523: $thisurl =~ s/\?.+$//;
9524: }
9525: my $ids=$bighash{'ids_'.&clutter($thisurl)};
9526: unless ($ids) {
9527: my $idkey = 'ids_'.($thisurl =~ m{^/}? '' : '/').$thisurl;
9528: $ids=$bighash{$idkey};
9529: }
9530: if ($ids) {
9531: # ------------------------------------------------------------------- Has ID(s)
9532: foreach my $id (split(/\,/,$ids)) {
9533: my ($mapid,$resid)=split(/\./,$id);
9534: if ($thisfn =~ m{^/adm/wrapper/ext/}) {
9535: $symb =~ s/\?.+$//;
9536: }
9537: if (
9538: &symbclean(&declutter($bighash{'map_id_'.$mapid}).'___'.$resid.'___'.$thisfn)
9539: eq $symb) {
9540: if (($env{'request.role.adv'}) ||
9541: ($bighash{'encrypted_'.$id} eq $env{'request.enc'}) ||
9542: ($thisurl eq '/adm/navmaps')) {
9543: $okay=1;
9544: }
9545: }
9546: }
9547: }
9548: untie(%bighash);
9549: }
9550: return $okay;
9551: }
9552:
9553: # --------------------------------------------------------------- Clean-up symb
9554:
9555: sub symbclean {
9556: my $symb=shift;
9557: if ($symb=~m|^/enc/|) { $symb=&Apache::lonenc::unencrypted($symb); }
9558: # remove version from map
9559: $symb=~s/\.(\d+)\.(\w+)\_\_\_/\.$2\_\_\_/;
9560:
9561: # remove version from URL
9562: $symb=~s/\.(\d+)\.(\w+)$/\.$2/;
9563:
9564: # remove wrapper
9565:
9566: $symb=~s/(\_\_\_\d+\_\_\_)adm\/wrapper\/(res\/)*/$1/;
9567: $symb=~s/(\_\_\_\d+\_\_\_)adm\/coursedocs\/showdoc\/(res\/)*/$1/;
9568: return $symb;
9569: }
9570:
9571: # ---------------------------------------------- Split symb to find map and url
9572:
9573: sub encode_symb {
9574: my ($map,$resid,$url)=@_;
9575: return &symbclean(&declutter($map).'___'.$resid.'___'.&declutter($url));
9576: }
9577:
9578: sub decode_symb {
9579: my $symb=shift;
9580: if ($symb=~m|^/enc/|) { $symb=&Apache::lonenc::unencrypted($symb); }
9581: my ($map,$resid,$url)=split(/___/,$symb);
9582: return (&fixversion($map),$resid,&fixversion($url));
9583: }
9584:
9585: sub fixversion {
9586: my $fn=shift;
9587: if ($fn=~/^(adm|uploaded|editupload|public)/) { return $fn; }
9588: my %bighash;
9589: my $uri=&clutter($fn);
9590: my $key=$env{'request.course.id'}.'_'.$uri;
9591: # is this cached?
9592: my ($result,$cached)=&is_cached_new('courseresversion',$key);
9593: if (defined($cached)) { return $result; }
9594: # unfortunately not cached, or expired
9595: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
9596: &GDBM_READER(),0640)) {
9597: if ($bighash{'version_'.$uri}) {
9598: my $version=$bighash{'version_'.$uri};
9599: unless (($version eq 'mostrecent') ||
9600: ($version==&getversion($uri))) {
9601: $uri=~s/\.(\w+)$/\.$version\.$1/;
9602: }
9603: }
9604: untie %bighash;
9605: }
9606: return &do_cache_new('courseresversion',$key,&declutter($uri),600);
9607: }
9608:
9609: sub deversion {
9610: my $url=shift;
9611: $url=~s/\.\d+\.(\w+)$/\.$1/;
9612: return $url;
9613: }
9614:
9615: # ------------------------------------------------------ Return symb list entry
9616:
9617: sub symbread {
9618: my ($thisfn,$donotrecurse)=@_;
9619: my $cache_str='request.symbread.cached.'.$thisfn;
9620: if (defined($env{$cache_str})) { return $env{$cache_str}; }
9621: # no filename provided? try from environment
9622: unless ($thisfn) {
9623: if ($env{'request.symb'}) {
9624: return $env{$cache_str}=&symbclean($env{'request.symb'});
9625: }
9626: $thisfn=$env{'request.filename'};
9627: }
9628: if ($thisfn=~m|^/enc/|) { $thisfn=&Apache::lonenc::unencrypted($thisfn); }
9629: # is that filename actually a symb? Verify, clean, and return
9630: if ($thisfn=~/\_\_\_\d+\_\_\_(.*)$/) {
9631: if (&symbverify($thisfn,$1)) {
9632: return $env{$cache_str}=&symbclean($thisfn);
9633: }
9634: }
9635: $thisfn=declutter($thisfn);
9636: my %hash;
9637: my %bighash;
9638: my $syval='';
9639: if (($env{'request.course.fn'}) && ($thisfn)) {
9640: my $targetfn = $thisfn;
9641: if ( ($thisfn =~ m/^(uploaded|editupload)\//) && ($thisfn !~ m/\.(page|sequence)$/) ) {
9642: $targetfn = 'adm/wrapper/'.$thisfn;
9643: }
9644: if ($targetfn =~ m|^adm/wrapper/(ext/.*)|) {
9645: $targetfn=$1;
9646: }
9647: if (tie(%hash,'GDBM_File',$env{'request.course.fn'}.'_symb.db',
9648: &GDBM_READER(),0640)) {
9649: $syval=$hash{$targetfn};
9650: untie(%hash);
9651: }
9652: # ---------------------------------------------------------- There was an entry
9653: if ($syval) {
9654: #unless ($syval=~/\_\d+$/) {
9655: #unless ($env{'form.request.prefix'}=~/\.(\d+)\_$/) {
9656: #&appenv({'request.ambiguous' => $thisfn});
9657: #return $env{$cache_str}='';
9658: #}
9659: #$syval.=$1;
9660: #}
9661: } else {
9662: # ------------------------------------------------------- Was not in symb table
9663: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
9664: &GDBM_READER(),0640)) {
9665: # ---------------------------------------------- Get ID(s) for current resource
9666: my $ids=$bighash{'ids_'.&clutter($thisfn)};
9667: unless ($ids) {
9668: $ids=$bighash{'ids_/'.$thisfn};
9669: }
9670: unless ($ids) {
9671: # alias?
9672: $ids=$bighash{'mapalias_'.$thisfn};
9673: }
9674: if ($ids) {
9675: # ------------------------------------------------------------------- Has ID(s)
9676: my @possibilities=split(/\,/,$ids);
9677: if ($#possibilities==0) {
9678: # ----------------------------------------------- There is only one possibility
9679: my ($mapid,$resid)=split(/\./,$ids);
9680: $syval=&encode_symb($bighash{'map_id_'.$mapid},
9681: $resid,$thisfn);
9682: } elsif (!$donotrecurse) {
9683: # ------------------------------------------ There is more than one possibility
9684: my $realpossible=0;
9685: foreach my $id (@possibilities) {
9686: my $file=$bighash{'src_'.$id};
9687: if (&allowed('bre',$file)) {
9688: my ($mapid,$resid)=split(/\./,$id);
9689: if ($bighash{'map_type_'.$mapid} ne 'page') {
9690: $realpossible++;
9691: $syval=&encode_symb($bighash{'map_id_'.$mapid},
9692: $resid,$thisfn);
9693: }
9694: }
9695: }
9696: if ($realpossible!=1) { $syval=''; }
9697: } else {
9698: $syval='';
9699: }
9700: }
9701: untie(%bighash)
9702: }
9703: }
9704: if ($syval) {
9705: return $env{$cache_str}=$syval;
9706: }
9707: }
9708: &appenv({'request.ambiguous' => $thisfn});
9709: return $env{$cache_str}='';
9710: }
9711:
9712: # ---------------------------------------------------------- Return random seed
9713:
9714: sub numval {
9715: my $txt=shift;
9716: $txt=~tr/A-J/0-9/;
9717: $txt=~tr/a-j/0-9/;
9718: $txt=~tr/K-T/0-9/;
9719: $txt=~tr/k-t/0-9/;
9720: $txt=~tr/U-Z/0-5/;
9721: $txt=~tr/u-z/0-5/;
9722: $txt=~s/\D//g;
9723: if ($_64bit) { if ($txt > 2**32) { return -1; } }
9724: return int($txt);
9725: }
9726:
9727: sub numval2 {
9728: my $txt=shift;
9729: $txt=~tr/A-J/0-9/;
9730: $txt=~tr/a-j/0-9/;
9731: $txt=~tr/K-T/0-9/;
9732: $txt=~tr/k-t/0-9/;
9733: $txt=~tr/U-Z/0-5/;
9734: $txt=~tr/u-z/0-5/;
9735: $txt=~s/\D//g;
9736: my @txts=split(/(\d\d\d\d\d\d\d\d\d)/,$txt);
9737: my $total;
9738: foreach my $val (@txts) { $total+=$val; }
9739: if ($_64bit) { if ($total > 2**32) { return -1; } }
9740: return int($total);
9741: }
9742:
9743: sub numval3 {
9744: use integer;
9745: my $txt=shift;
9746: $txt=~tr/A-J/0-9/;
9747: $txt=~tr/a-j/0-9/;
9748: $txt=~tr/K-T/0-9/;
9749: $txt=~tr/k-t/0-9/;
9750: $txt=~tr/U-Z/0-5/;
9751: $txt=~tr/u-z/0-5/;
9752: $txt=~s/\D//g;
9753: my @txts=split(/(\d\d\d\d\d\d\d\d\d)/,$txt);
9754: my $total;
9755: foreach my $val (@txts) { $total+=$val; }
9756: if ($_64bit) { $total=(($total<<32)>>32); }
9757: return $total;
9758: }
9759:
9760: sub digest {
9761: my ($data)=@_;
9762: my $digest=&Digest::MD5::md5($data);
9763: my ($a,$b,$c,$d)=unpack("iiii",$digest);
9764: my ($e,$f);
9765: {
9766: use integer;
9767: $e=($a+$b);
9768: $f=($c+$d);
9769: if ($_64bit) {
9770: $e=(($e<<32)>>32);
9771: $f=(($f<<32)>>32);
9772: }
9773: }
9774: if (wantarray) {
9775: return ($e,$f);
9776: } else {
9777: my $g;
9778: {
9779: use integer;
9780: $g=($e+$f);
9781: if ($_64bit) {
9782: $g=(($g<<32)>>32);
9783: }
9784: }
9785: return $g;
9786: }
9787: }
9788:
9789: sub latest_rnd_algorithm_id {
9790: return '64bit5';
9791: }
9792:
9793: sub get_rand_alg {
9794: my ($courseid)=@_;
9795: if (!$courseid) { $courseid=(&whichuser())[1]; }
9796: if ($courseid) {
9797: return $env{"course.$courseid.rndseed"};
9798: }
9799: return &latest_rnd_algorithm_id();
9800: }
9801:
9802: sub validCODE {
9803: my ($CODE)=@_;
9804: if (defined($CODE) && $CODE ne '' && $CODE =~ /^\w+$/) { return 1; }
9805: return 0;
9806: }
9807:
9808: sub getCODE {
9809: if (&validCODE($env{'form.CODE'})) { return $env{'form.CODE'}; }
9810: if ( (defined($Apache::lonhomework::parsing_a_problem) ||
9811: defined($Apache::lonhomework::parsing_a_task) ) &&
9812: &validCODE($Apache::lonhomework::history{'resource.CODE'})) {
9813: return $Apache::lonhomework::history{'resource.CODE'};
9814: }
9815: return undef;
9816: }
9817: #
9818: # Determines the random seed for a specific context:
9819: #
9820: # parameters:
9821: # symb - in course context the symb for the seed.
9822: # course_id - The course id of the form domain_coursenum.
9823: # domain - Domain for the user.
9824: # course - Course for the user.
9825: # cenv - environment of the course.
9826: #
9827: # NOTE:
9828: # All parameters are picked out of the environment if missing
9829: # or not defined.
9830: # If a symb cannot be determined the current time is used instead.
9831: #
9832: # For a given well defined symb, courside, domain, username,
9833: # and course environment, the seed is reproducible.
9834: #
9835: sub rndseed {
9836: my ($symb,$courseid,$domain,$username, $cenv)=@_;
9837: my ($wsymb,$wcourseid,$wdomain,$wusername)=&whichuser();
9838: if (!defined($symb)) {
9839: unless ($symb=$wsymb) { return time; }
9840: }
9841: if (!defined $courseid) {
9842: $courseid=$wcourseid;
9843: }
9844: if (!defined $domain) { $domain=$wdomain; }
9845: if (!defined $username) { $username=$wusername }
9846:
9847: my $which;
9848: if (defined($cenv->{'rndseed'})) {
9849: $which = $cenv->{'rndseed'};
9850: } else {
9851: $which =&get_rand_alg($courseid);
9852: }
9853: if (defined(&getCODE())) {
9854:
9855: if ($which eq '64bit5') {
9856: return &rndseed_CODE_64bit5($symb,$courseid,$domain,$username);
9857: } elsif ($which eq '64bit4') {
9858: return &rndseed_CODE_64bit4($symb,$courseid,$domain,$username);
9859: } else {
9860: return &rndseed_CODE_64bit($symb,$courseid,$domain,$username);
9861: }
9862: } elsif ($which eq '64bit5') {
9863: return &rndseed_64bit5($symb,$courseid,$domain,$username);
9864: } elsif ($which eq '64bit4') {
9865: return &rndseed_64bit4($symb,$courseid,$domain,$username);
9866: } elsif ($which eq '64bit3') {
9867: return &rndseed_64bit3($symb,$courseid,$domain,$username);
9868: } elsif ($which eq '64bit2') {
9869: return &rndseed_64bit2($symb,$courseid,$domain,$username);
9870: } elsif ($which eq '64bit') {
9871: return &rndseed_64bit($symb,$courseid,$domain,$username);
9872: }
9873: return &rndseed_32bit($symb,$courseid,$domain,$username);
9874: }
9875:
9876: sub rndseed_32bit {
9877: my ($symb,$courseid,$domain,$username)=@_;
9878: {
9879: use integer;
9880: my $symbchck=unpack("%32C*",$symb) << 27;
9881: my $symbseed=numval($symb) << 22;
9882: my $namechck=unpack("%32C*",$username) << 17;
9883: my $nameseed=numval($username) << 12;
9884: my $domainseed=unpack("%32C*",$domain) << 7;
9885: my $courseseed=unpack("%32C*",$courseid);
9886: my $num=$symbseed+$nameseed+$domainseed+$courseseed+$namechck+$symbchck;
9887: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
9888: #&logthis("rndseed :$num:$symb");
9889: if ($_64bit) { $num=(($num<<32)>>32); }
9890: return $num;
9891: }
9892: }
9893:
9894: sub rndseed_64bit {
9895: my ($symb,$courseid,$domain,$username)=@_;
9896: {
9897: use integer;
9898: my $symbchck=unpack("%32S*",$symb) << 21;
9899: my $symbseed=numval($symb) << 10;
9900: my $namechck=unpack("%32S*",$username);
9901:
9902: my $nameseed=numval($username) << 21;
9903: my $domainseed=unpack("%32S*",$domain) << 10;
9904: my $courseseed=unpack("%32S*",$courseid);
9905:
9906: my $num1=$symbchck+$symbseed+$namechck;
9907: my $num2=$nameseed+$domainseed+$courseseed;
9908: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
9909: #&logthis("rndseed :$num:$symb");
9910: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
9911: return "$num1,$num2";
9912: }
9913: }
9914:
9915: sub rndseed_64bit2 {
9916: my ($symb,$courseid,$domain,$username)=@_;
9917: {
9918: use integer;
9919: # strings need to be an even # of cahracters long, it it is odd the
9920: # last characters gets thrown away
9921: my $symbchck=unpack("%32S*",$symb.' ') << 21;
9922: my $symbseed=numval($symb) << 10;
9923: my $namechck=unpack("%32S*",$username.' ');
9924:
9925: my $nameseed=numval($username) << 21;
9926: my $domainseed=unpack("%32S*",$domain.' ') << 10;
9927: my $courseseed=unpack("%32S*",$courseid.' ');
9928:
9929: my $num1=$symbchck+$symbseed+$namechck;
9930: my $num2=$nameseed+$domainseed+$courseseed;
9931: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
9932: #&logthis("rndseed :$num:$symb");
9933: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
9934: return "$num1,$num2";
9935: }
9936: }
9937:
9938: sub rndseed_64bit3 {
9939: my ($symb,$courseid,$domain,$username)=@_;
9940: {
9941: use integer;
9942: # strings need to be an even # of cahracters long, it it is odd the
9943: # last characters gets thrown away
9944: my $symbchck=unpack("%32S*",$symb.' ') << 21;
9945: my $symbseed=numval2($symb) << 10;
9946: my $namechck=unpack("%32S*",$username.' ');
9947:
9948: my $nameseed=numval2($username) << 21;
9949: my $domainseed=unpack("%32S*",$domain.' ') << 10;
9950: my $courseseed=unpack("%32S*",$courseid.' ');
9951:
9952: my $num1=$symbchck+$symbseed+$namechck;
9953: my $num2=$nameseed+$domainseed+$courseseed;
9954: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
9955: #&logthis("rndseed :$num1:$num2:$_64bit");
9956: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
9957:
9958: return "$num1:$num2";
9959: }
9960: }
9961:
9962: sub rndseed_64bit4 {
9963: my ($symb,$courseid,$domain,$username)=@_;
9964: {
9965: use integer;
9966: # strings need to be an even # of cahracters long, it it is odd the
9967: # last characters gets thrown away
9968: my $symbchck=unpack("%32S*",$symb.' ') << 21;
9969: my $symbseed=numval3($symb) << 10;
9970: my $namechck=unpack("%32S*",$username.' ');
9971:
9972: my $nameseed=numval3($username) << 21;
9973: my $domainseed=unpack("%32S*",$domain.' ') << 10;
9974: my $courseseed=unpack("%32S*",$courseid.' ');
9975:
9976: my $num1=$symbchck+$symbseed+$namechck;
9977: my $num2=$nameseed+$domainseed+$courseseed;
9978: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
9979: #&logthis("rndseed :$num1:$num2:$_64bit");
9980: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
9981:
9982: return "$num1:$num2";
9983: }
9984: }
9985:
9986: sub rndseed_64bit5 {
9987: my ($symb,$courseid,$domain,$username)=@_;
9988: my ($num1,$num2)=&digest("$symb,$courseid,$domain,$username");
9989: return "$num1:$num2";
9990: }
9991:
9992: sub rndseed_CODE_64bit {
9993: my ($symb,$courseid,$domain,$username)=@_;
9994: {
9995: use integer;
9996: my $symbchck=unpack("%32S*",$symb.' ') << 16;
9997: my $symbseed=numval2($symb);
9998: my $CODEchck=unpack("%32S*",&getCODE().' ') << 16;
9999: my $CODEseed=numval(&getCODE());
10000: my $courseseed=unpack("%32S*",$courseid.' ');
10001: my $num1=$symbseed+$CODEchck;
10002: my $num2=$CODEseed+$courseseed+$symbchck;
10003: #&logthis("$symbseed:$CODEchck|$CODEseed:$courseseed:$symbchck");
10004: #&logthis("rndseed :$num1:$num2:$symb");
10005: if ($_64bit) { $num1=(($num1<<32)>>32); }
10006: if ($_64bit) { $num2=(($num2<<32)>>32); }
10007: return "$num1:$num2";
10008: }
10009: }
10010:
10011: sub rndseed_CODE_64bit4 {
10012: my ($symb,$courseid,$domain,$username)=@_;
10013: {
10014: use integer;
10015: my $symbchck=unpack("%32S*",$symb.' ') << 16;
10016: my $symbseed=numval3($symb);
10017: my $CODEchck=unpack("%32S*",&getCODE().' ') << 16;
10018: my $CODEseed=numval3(&getCODE());
10019: my $courseseed=unpack("%32S*",$courseid.' ');
10020: my $num1=$symbseed+$CODEchck;
10021: my $num2=$CODEseed+$courseseed+$symbchck;
10022: #&logthis("$symbseed:$CODEchck|$CODEseed:$courseseed:$symbchck");
10023: #&logthis("rndseed :$num1:$num2:$symb");
10024: if ($_64bit) { $num1=(($num1<<32)>>32); }
10025: if ($_64bit) { $num2=(($num2<<32)>>32); }
10026: return "$num1:$num2";
10027: }
10028: }
10029:
10030: sub rndseed_CODE_64bit5 {
10031: my ($symb,$courseid,$domain,$username)=@_;
10032: my $code = &getCODE();
10033: my ($num1,$num2)=&digest("$symb,$courseid,$code");
10034: return "$num1:$num2";
10035: }
10036:
10037: sub setup_random_from_rndseed {
10038: my ($rndseed)=@_;
10039: if ($rndseed =~/([,:])/) {
10040: my ($num1,$num2)=split(/[,:]/,$rndseed);
10041: &Math::Random::random_set_seed(abs($num1),abs($num2));
10042: } else {
10043: &Math::Random::random_set_seed_from_phrase($rndseed);
10044: }
10045: }
10046:
10047: sub latest_receipt_algorithm_id {
10048: return 'receipt3';
10049: }
10050:
10051: sub recunique {
10052: my $fucourseid=shift;
10053: my $unique;
10054: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2' ||
10055: $env{"course.$fucourseid.receiptalg"} eq 'receipt3' ) {
10056: $unique=$env{"course.$fucourseid.internal.encseed"};
10057: } else {
10058: $unique=$perlvar{'lonReceipt'};
10059: }
10060: return unpack("%32C*",$unique);
10061: }
10062:
10063: sub recprefix {
10064: my $fucourseid=shift;
10065: my $prefix;
10066: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2'||
10067: $env{"course.$fucourseid.receiptalg"} eq 'receipt3' ) {
10068: $prefix=$env{"course.$fucourseid.internal.encpref"};
10069: } else {
10070: $prefix=$perlvar{'lonHostID'};
10071: }
10072: return unpack("%32C*",$prefix);
10073: }
10074:
10075: sub ireceipt {
10076: my ($funame,$fudom,$fucourseid,$fusymb,$part)=@_;
10077:
10078: my $return =&recprefix($fucourseid).'-';
10079:
10080: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt3' ||
10081: $env{'request.state'} eq 'construct') {
10082: $return .= (&digest("$funame,$fudom,$fucourseid,$fusymb,$part")%10000);
10083: return $return;
10084: }
10085:
10086: my $cuname=unpack("%32C*",$funame);
10087: my $cudom=unpack("%32C*",$fudom);
10088: my $cucourseid=unpack("%32C*",$fucourseid);
10089: my $cusymb=unpack("%32C*",$fusymb);
10090: my $cunique=&recunique($fucourseid);
10091: my $cpart=unpack("%32S*",$part);
10092: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2') {
10093:
10094: #&logthis("doing receipt2 using parts $cpart, uname $cuname and udom $cudom gets ".($cpart%$cuname)." and ".($cpart%$cudom));
10095:
10096: $return.= ($cunique%$cuname+
10097: $cunique%$cudom+
10098: $cusymb%$cuname+
10099: $cusymb%$cudom+
10100: $cucourseid%$cuname+
10101: $cucourseid%$cudom+
10102: $cpart%$cuname+
10103: $cpart%$cudom);
10104: } else {
10105: $return.= ($cunique%$cuname+
10106: $cunique%$cudom+
10107: $cusymb%$cuname+
10108: $cusymb%$cudom+
10109: $cucourseid%$cuname+
10110: $cucourseid%$cudom);
10111: }
10112: return $return;
10113: }
10114:
10115: sub receipt {
10116: my ($part)=@_;
10117: my ($symb,$courseid,$domain,$name) = &whichuser();
10118: return &ireceipt($name,$domain,$courseid,$symb,$part);
10119: }
10120:
10121: sub whichuser {
10122: my ($passedsymb)=@_;
10123: my ($symb,$courseid,$domain,$name,$publicuser);
10124: if (defined($env{'form.grade_symb'})) {
10125: my ($tmp_courseid)=&get_env_multiple('form.grade_courseid');
10126: my $allowed=&allowed('vgr',$tmp_courseid);
10127: if (!$allowed &&
10128: exists($env{'request.course.sec'}) &&
10129: $env{'request.course.sec'} !~ /^\s*$/) {
10130: $allowed=&allowed('vgr',$tmp_courseid.
10131: '/'.$env{'request.course.sec'});
10132: }
10133: if ($allowed) {
10134: ($symb)=&get_env_multiple('form.grade_symb');
10135: $courseid=$tmp_courseid;
10136: ($domain)=&get_env_multiple('form.grade_domain');
10137: ($name)=&get_env_multiple('form.grade_username');
10138: return ($symb,$courseid,$domain,$name,$publicuser);
10139: }
10140: }
10141: if (!$passedsymb) {
10142: $symb=&symbread();
10143: } else {
10144: $symb=$passedsymb;
10145: }
10146: $courseid=$env{'request.course.id'};
10147: $domain=$env{'user.domain'};
10148: $name=$env{'user.name'};
10149: if ($name eq 'public' && $domain eq 'public') {
10150: if (!defined($env{'form.username'})) {
10151: $env{'form.username'}.=time.rand(10000000);
10152: }
10153: $name.=$env{'form.username'};
10154: }
10155: return ($symb,$courseid,$domain,$name,$publicuser);
10156:
10157: }
10158:
10159: # ------------------------------------------------------------ Serves up a file
10160: # returns either the contents of the file or
10161: # -1 if the file doesn't exist
10162: #
10163: # if the target is a file that was uploaded via DOCS,
10164: # a check will be made to see if a current copy exists on the local server,
10165: # if it does this will be served, otherwise a copy will be retrieved from
10166: # the home server for the course and stored in /home/httpd/html/userfiles on
10167: # the local server.
10168:
10169: sub getfile {
10170: my ($file) = @_;
10171: if ($file =~ m -^/*(uploaded|editupload)/-) { $file=&filelocation("",$file); }
10172: &repcopy($file);
10173: return &readfile($file);
10174: }
10175:
10176: sub repcopy_userfile {
10177: my ($file)=@_;
10178: my $londocroot = $perlvar{'lonDocRoot'};
10179: if ($file =~ m{^/*(uploaded|editupload)/}) { $file=&filelocation("",$file); }
10180: if ($file =~ m{^\Q$londocroot/lonUsers/\E}) { return 'ok'; }
10181: my ($cdom,$cnum,$filename) =
10182: ($file=~m|^\Q$perlvar{'lonDocRoot'}\E/+userfiles/+($match_domain)/+($match_name)/+(.*)|);
10183: my $uri="/uploaded/$cdom/$cnum/$filename";
10184: if (-e "$file") {
10185: # we already have a local copy, check it out
10186: my @fileinfo = stat($file);
10187: my $rtncode;
10188: my $info;
10189: my $lwpresp = &getuploaded('HEAD',$uri,$cdom,$cnum,\$info,\$rtncode);
10190: if ($lwpresp ne 'ok') {
10191: # there is no such file anymore, even though we had a local copy
10192: if ($rtncode eq '404') {
10193: unlink($file);
10194: }
10195: return -1;
10196: }
10197: if ($info < $fileinfo[9]) {
10198: # nice, the file we have is up-to-date, just say okay
10199: return 'ok';
10200: } else {
10201: # the file is outdated, get rid of it
10202: unlink($file);
10203: }
10204: }
10205: # one way or the other, at this point, we don't have the file
10206: # construct the correct path for the file
10207: my @parts = ($cdom,$cnum);
10208: if ($filename =~ m|^(.+)/[^/]+$|) {
10209: push @parts, split(/\//,$1);
10210: }
10211: my $path = $perlvar{'lonDocRoot'}.'/userfiles';
10212: foreach my $part (@parts) {
10213: $path .= '/'.$part;
10214: if (!-e $path) {
10215: mkdir($path,0770);
10216: }
10217: }
10218: # now the path exists for sure
10219: # get a user agent
10220: my $ua=new LWP::UserAgent;
10221: my $transferfile=$file.'.in.transfer';
10222: # FIXME: this should flock
10223: if (-e $transferfile) { return 'ok'; }
10224: my $request;
10225: $uri=~s/^\///;
10226: my $homeserver = &homeserver($cnum,$cdom);
10227: my $protocol = $protocol{$homeserver};
10228: $protocol = 'http' if ($protocol ne 'https');
10229: $request=new HTTP::Request('GET',$protocol.'://'.&hostname($homeserver).'/raw/'.$uri);
10230: my $response=$ua->request($request,$transferfile);
10231: # did it work?
10232: if ($response->is_error()) {
10233: unlink($transferfile);
10234: &logthis("Userfile repcopy failed for $uri");
10235: return -1;
10236: }
10237: # worked, rename the transfer file
10238: rename($transferfile,$file);
10239: return 'ok';
10240: }
10241:
10242: sub tokenwrapper {
10243: my $uri=shift;
10244: $uri=~s|^https?\://([^/]+)||;
10245: $uri=~s|^/||;
10246: $env{'user.environment'}=~/\/([^\/]+)\.id/;
10247: my $token=$1;
10248: my (undef,$udom,$uname,$file)=split('/',$uri,4);
10249: if ($udom && $uname && $file) {
10250: $file=~s|(\?\.*)*$||;
10251: &appenv({"userfile.$udom/$uname/$file" => $env{'request.course.id'}});
10252: my $homeserver = &homeserver($uname,$udom);
10253: my $protocol = $protocol{$homeserver};
10254: $protocol = 'http' if ($protocol ne 'https');
10255: return $protocol.'://'.&hostname($homeserver).'/'.$uri.
10256: (($uri=~/\?/)?'&':'?').'token='.$token.
10257: '&tokenissued='.$perlvar{'lonHostID'};
10258: } else {
10259: return '/adm/notfound.html';
10260: }
10261: }
10262:
10263: # call with reqtype HEAD: get last modification time
10264: # call with reqtype GET: get the file contents
10265: # Do not call this with reqtype GET for large files! It loads everything into memory
10266: #
10267: sub getuploaded {
10268: my ($reqtype,$uri,$cdom,$cnum,$info,$rtncode) = @_;
10269: $uri=~s/^\///;
10270: my $homeserver = &homeserver($cnum,$cdom);
10271: my $protocol = $protocol{$homeserver};
10272: $protocol = 'http' if ($protocol ne 'https');
10273: $uri = $protocol.'://'.&hostname($homeserver).'/raw/'.$uri;
10274: my $ua=new LWP::UserAgent;
10275: my $request=new HTTP::Request($reqtype,$uri);
10276: my $response=$ua->request($request);
10277: $$rtncode = $response->code;
10278: if (! $response->is_success()) {
10279: return 'failed';
10280: }
10281: if ($reqtype eq 'HEAD') {
10282: $$info = &HTTP::Date::str2time( $response->header('Last-modified') );
10283: } elsif ($reqtype eq 'GET') {
10284: $$info = $response->content;
10285: }
10286: return 'ok';
10287: }
10288:
10289: sub readfile {
10290: my $file = shift;
10291: if ( (! -e $file ) || ($file eq '') ) { return -1; };
10292: my $fh;
10293: open($fh,"<$file");
10294: my $a='';
10295: while (my $line = <$fh>) { $a .= $line; }
10296: return $a;
10297: }
10298:
10299: sub filelocation {
10300: my ($dir,$file) = @_;
10301: my $location;
10302: $file=~ s/^\s*(\S+)\s*$/$1/; ## strip off leading and trailing spaces
10303:
10304: if ($file =~ m-^/adm/-) {
10305: $file=~s-^/adm/wrapper/-/-;
10306: $file=~s-^/adm/coursedocs/showdoc/-/-;
10307: }
10308:
10309: if ($file =~ m-^\Q$Apache::lonnet::perlvar{'lonTabDir'}\E/-) {
10310: $location = $file;
10311: } elsif ($file=~/^\/*(uploaded|editupload)/) { # is an uploaded file
10312: my ($udom,$uname,$filename)=
10313: ($file=~m -^/+(?:uploaded|editupload)/+($match_domain)/+($match_name)/+(.*)$-);
10314: my $home=&homeserver($uname,$udom);
10315: my $is_me=0;
10316: my @ids=¤t_machine_ids();
10317: foreach my $id (@ids) { if ($id eq $home) { $is_me=1; } }
10318: if ($is_me) {
10319: $location=propath($udom,$uname).'/userfiles/'.$filename;
10320: } else {
10321: $location=$Apache::lonnet::perlvar{'lonDocRoot'}.'/userfiles/'.
10322: $udom.'/'.$uname.'/'.$filename;
10323: }
10324: } elsif ($file =~ m-^/adm/-) {
10325: $location = $perlvar{'lonDocRoot'}.'/'.$file;
10326: } else {
10327: $file=~s/^\Q$perlvar{'lonDocRoot'}\E//;
10328: $file=~s:^/(res|priv)/:/:;
10329: my $space=$1;
10330: if ( !( $file =~ m:^/:) ) {
10331: $location = $dir. '/'.$file;
10332: } else {
10333: $location = $perlvar{'lonDocRoot'}.'/'.$space.$file;
10334: }
10335: }
10336: $location=~s://+:/:g; # remove duplicate /
10337: while ($location=~m{/\.\./}) {
10338: if ($location =~ m{/[^/]+/\.\./}) {
10339: $location=~ s{/[^/]+/\.\./}{/}g;
10340: } else {
10341: $location=~ s{/\.\./}{/}g;
10342: }
10343: } #remove dir/..
10344: while ($location=~m:/\./:) {$location=~ s:/\./:/:g;} #remove /./
10345: return $location;
10346: }
10347:
10348: sub hreflocation {
10349: my ($dir,$file)=@_;
10350: unless (($file=~m-^https?\://-i) || ($file=~m-^/-)) {
10351: $file=filelocation($dir,$file);
10352: } elsif ($file=~m-^/adm/-) {
10353: $file=~s-^/adm/wrapper/-/-;
10354: $file=~s-^/adm/coursedocs/showdoc/-/-;
10355: }
10356: if ($file=~m-^\Q$perlvar{'lonDocRoot'}\E-) {
10357: $file=~s-^\Q$perlvar{'lonDocRoot'}\E--;
10358: } elsif ($file=~m-^\Q$perlvar{'lonUsersDir'}\E-) {
10359: $file=~s{^/home/httpd/lonUsers/($match_domain)/./././($match_name)/userfiles/}
10360: {/uploaded/$1/$2/}x;
10361: }
10362: if ($file=~ m{^/userfiles/}) {
10363: $file =~ s{^/userfiles/}{/uploaded/};
10364: }
10365: return $file;
10366: }
10367:
10368:
10369:
10370:
10371:
10372: sub current_machine_domains {
10373: return &machine_domains(&hostname($perlvar{'lonHostID'}));
10374: }
10375:
10376: sub machine_domains {
10377: my ($hostname) = @_;
10378: my @domains;
10379: my %hostname = &all_hostnames();
10380: while( my($id, $name) = each(%hostname)) {
10381: # &logthis("-$id-$name-$hostname-");
10382: if ($hostname eq $name) {
10383: push(@domains,&host_domain($id));
10384: }
10385: }
10386: return @domains;
10387: }
10388:
10389: sub current_machine_ids {
10390: return &machine_ids(&hostname($perlvar{'lonHostID'}));
10391: }
10392:
10393: sub machine_ids {
10394: my ($hostname) = @_;
10395: $hostname ||= &hostname($perlvar{'lonHostID'});
10396: my @ids;
10397: my %name_to_host = &all_names();
10398: if (ref($name_to_host{$hostname}) eq 'ARRAY') {
10399: return @{ $name_to_host{$hostname} };
10400: }
10401: return;
10402: }
10403:
10404: sub additional_machine_domains {
10405: my @domains;
10406: open(my $fh,"<$perlvar{'lonTabDir'}/expected_domains.tab");
10407: while( my $line = <$fh>) {
10408: $line =~ s/\s//g;
10409: push(@domains,$line);
10410: }
10411: return @domains;
10412: }
10413:
10414: sub default_login_domain {
10415: my $domain = $perlvar{'lonDefDomain'};
10416: my $testdomain=(split(/\./,$ENV{'HTTP_HOST'}))[0];
10417: foreach my $posdom (¤t_machine_domains(),
10418: &additional_machine_domains()) {
10419: if (lc($posdom) eq lc($testdomain)) {
10420: $domain=$posdom;
10421: last;
10422: }
10423: }
10424: return $domain;
10425: }
10426:
10427: # ------------------------------------------------------------- Declutters URLs
10428:
10429: sub declutter {
10430: my $thisfn=shift;
10431: if ($thisfn=~m|^/enc/|) { $thisfn=&Apache::lonenc::unencrypted($thisfn); }
10432: $thisfn=~s/^\Q$perlvar{'lonDocRoot'}\E//;
10433: $thisfn=~s/^\///;
10434: $thisfn=~s|^adm/wrapper/||;
10435: $thisfn=~s|^adm/coursedocs/showdoc/||;
10436: $thisfn=~s/^res\///;
10437: unless (($thisfn =~ /^ext/) || ($thisfn =~ /\.(page|sequence)___\d+___ext/)) {
10438: $thisfn=~s/\?.+$//;
10439: }
10440: return $thisfn;
10441: }
10442:
10443: # ------------------------------------------------------------- Clutter up URLs
10444:
10445: sub clutter {
10446: my $thisfn='/'.&declutter(shift);
10447: if ($thisfn !~ m{^/(uploaded|editupload|adm|userfiles|ext|raw|priv|public)/}
10448: || $thisfn =~ m{^/adm/(includes|pages)} ) {
10449: $thisfn='/res'.$thisfn;
10450: }
10451: if ($thisfn !~m|^/adm|) {
10452: if ($thisfn =~ m|^/ext/|) {
10453: $thisfn='/adm/wrapper'.$thisfn;
10454: } else {
10455: my ($ext) = ($thisfn =~ /\.(\w+)$/);
10456: my $embstyle=&Apache::loncommon::fileembstyle($ext);
10457: if ($embstyle eq 'ssi'
10458: || ($embstyle eq 'hdn')
10459: || ($embstyle eq 'rat')
10460: || ($embstyle eq 'prv')
10461: || ($embstyle eq 'ign')) {
10462: #do nothing with these
10463: } elsif (($embstyle eq 'img')
10464: || ($embstyle eq 'emb')
10465: || ($embstyle eq 'wrp')) {
10466: $thisfn='/adm/wrapper'.$thisfn;
10467: } elsif ($embstyle eq 'unk'
10468: && $thisfn!~/\.(sequence|page)$/) {
10469: $thisfn='/adm/coursedocs/showdoc'.$thisfn;
10470: } else {
10471: # &logthis("Got a blank emb style");
10472: }
10473: }
10474: }
10475: return $thisfn;
10476: }
10477:
10478: sub clutter_with_no_wrapper {
10479: my $uri = &clutter(shift);
10480: if ($uri =~ m-^/adm/-) {
10481: $uri =~ s-^/adm/wrapper/-/-;
10482: $uri =~ s-^/adm/coursedocs/showdoc/-/-;
10483: }
10484: return $uri;
10485: }
10486:
10487: sub freeze_escape {
10488: my ($value)=@_;
10489: if (ref($value)) {
10490: $value=&nfreeze($value);
10491: return '__FROZEN__'.&escape($value);
10492: }
10493: return &escape($value);
10494: }
10495:
10496:
10497: sub thaw_unescape {
10498: my ($value)=@_;
10499: if ($value =~ /^__FROZEN__/) {
10500: substr($value,0,10,undef);
10501: $value=&unescape($value);
10502: return &thaw($value);
10503: }
10504: return &unescape($value);
10505: }
10506:
10507: sub correct_line_ends {
10508: my ($result)=@_;
10509: $$result =~s/\r\n/\n/mg;
10510: $$result =~s/\r/\n/mg;
10511: }
10512: # ================================================================ Main Program
10513:
10514: sub goodbye {
10515: &logthis("Starting Shut down");
10516: #not converted to using infrastruture and probably shouldn't be
10517: &logthis(sprintf("%-20s is %s",'%badServerCache',length(&nfreeze(\%badServerCache))));
10518: #converted
10519: # &logthis(sprintf("%-20s is %s",'%metacache',scalar(%metacache)));
10520: &logthis(sprintf("%-20s is %s",'%homecache',length(&nfreeze(\%homecache))));
10521: # &logthis(sprintf("%-20s is %s",'%titlecache',length(&nfreeze(\%titlecache))));
10522: # &logthis(sprintf("%-20s is %s",'%courseresdatacache',length(&nfreeze(\%courseresdatacache))));
10523: #1.1 only
10524: # &logthis(sprintf("%-20s is %s",'%userresdatacache',length(&nfreeze(\%userresdatacache))));
10525: # &logthis(sprintf("%-20s is %s",'%getsectioncache',length(&nfreeze(\%getsectioncache))));
10526: # &logthis(sprintf("%-20s is %s",'%courseresversioncache',length(&nfreeze(\%courseresversioncache))));
10527: # &logthis(sprintf("%-20s is %s",'%resversioncache',length(&nfreeze(\%resversioncache))));
10528: &logthis(sprintf("%-20s is %s",'%remembered',length(&nfreeze(\%remembered))));
10529: &logthis(sprintf("%-20s is %s",'kicks',$kicks));
10530: &logthis(sprintf("%-20s is %s",'hits',$hits));
10531: &flushcourselogs();
10532: &logthis("Shutting down");
10533: }
10534:
10535: sub get_dns {
10536: my ($url,$func,$ignore_cache) = @_;
10537: if (!$ignore_cache) {
10538: my ($content,$cached)=
10539: &Apache::lonnet::is_cached_new('dns',$url);
10540: if ($cached) {
10541: &$func($content);
10542: return;
10543: }
10544: }
10545:
10546: my %alldns;
10547: open(my $config,"<$perlvar{'lonTabDir'}/hosts.tab");
10548: foreach my $dns (<$config>) {
10549: next if ($dns !~ /^\^(\S*)/x);
10550: my $line = $1;
10551: my ($host,$protocol) = split(/:/,$line);
10552: if ($protocol ne 'https') {
10553: $protocol = 'http';
10554: }
10555: $alldns{$host} = $protocol;
10556: }
10557: while (%alldns) {
10558: my ($dns) = keys(%alldns);
10559: my $ua=new LWP::UserAgent;
10560: $ua->timeout(30);
10561: my $request=new HTTP::Request('GET',"$alldns{$dns}://$dns$url");
10562: my $response=$ua->request($request);
10563: delete($alldns{$dns});
10564: next if ($response->is_error());
10565: my @content = split("\n",$response->content);
10566: &Apache::lonnet::do_cache_new('dns',$url,\@content,30*24*60*60);
10567: &$func(\@content);
10568: return;
10569: }
10570: close($config);
10571: my $which = (split('/',$url))[3];
10572: &logthis("unable to contact DNS defaulting to on disk file dns_$which.tab\n");
10573: open($config,"<$perlvar{'lonTabDir'}/dns_$which.tab");
10574: my @content = <$config>;
10575: &$func(\@content);
10576: return;
10577: }
10578: # ------------------------------------------------------------ Read domain file
10579: {
10580: my $loaded;
10581: my %domain;
10582:
10583: sub parse_domain_tab {
10584: my ($lines) = @_;
10585: foreach my $line (@$lines) {
10586: next if ($line =~ /^(\#|\s*$ )/x);
10587:
10588: chomp($line);
10589: my ($name,@elements) = split(/:/,$line,9);
10590: my %this_domain;
10591: foreach my $field ('description', 'auth_def', 'auth_arg_def',
10592: 'lang_def', 'city', 'longi', 'lati',
10593: 'primary') {
10594: $this_domain{$field} = shift(@elements);
10595: }
10596: $domain{$name} = \%this_domain;
10597: }
10598: }
10599:
10600: sub reset_domain_info {
10601: undef($loaded);
10602: undef(%domain);
10603: }
10604:
10605: sub load_domain_tab {
10606: my ($ignore_cache) = @_;
10607: &get_dns('/adm/dns/domain',\&parse_domain_tab,$ignore_cache);
10608: my $fh;
10609: if (open($fh,"<".$perlvar{'lonTabDir'}.'/domain.tab')) {
10610: my @lines = <$fh>;
10611: &parse_domain_tab(\@lines);
10612: }
10613: close($fh);
10614: $loaded = 1;
10615: }
10616:
10617: sub domain {
10618: &load_domain_tab() if (!$loaded);
10619:
10620: my ($name,$what) = @_;
10621: return if ( !exists($domain{$name}) );
10622:
10623: if (!$what) {
10624: return $domain{$name}{'description'};
10625: }
10626: return $domain{$name}{$what};
10627: }
10628:
10629: sub domain_info {
10630: &load_domain_tab() if (!$loaded);
10631: return %domain;
10632: }
10633:
10634: }
10635:
10636:
10637: # ------------------------------------------------------------- Read hosts file
10638: {
10639: my %hostname;
10640: my %hostdom;
10641: my %libserv;
10642: my $loaded;
10643: my %name_to_host;
10644: my %internetdom;
10645: my %LC_dns_serv;
10646:
10647: sub parse_hosts_tab {
10648: my ($file) = @_;
10649: foreach my $configline (@$file) {
10650: next if ($configline =~ /^(\#|\s*$ )/x);
10651: chomp($configline);
10652: if ($configline =~ /^\^/) {
10653: if ($configline =~ /^\^([\w.\-]+)/) {
10654: $LC_dns_serv{$1} = 1;
10655: }
10656: next;
10657: }
10658: my ($id,$domain,$role,$name,$protocol,$intdom)=split(/:/,$configline);
10659: $name=~s/\s//g;
10660: if ($id && $domain && $role && $name) {
10661: $hostname{$id}=$name;
10662: push(@{$name_to_host{$name}}, $id);
10663: $hostdom{$id}=$domain;
10664: if ($role eq 'library') { $libserv{$id}=$name; }
10665: if (defined($protocol)) {
10666: if ($protocol eq 'https') {
10667: $protocol{$id} = $protocol;
10668: } else {
10669: $protocol{$id} = 'http';
10670: }
10671: } else {
10672: $protocol{$id} = 'http';
10673: }
10674: if (defined($intdom)) {
10675: $internetdom{$id} = $intdom;
10676: }
10677: }
10678: }
10679: }
10680:
10681: sub reset_hosts_info {
10682: &purge_remembered();
10683: &reset_domain_info();
10684: &reset_hosts_ip_info();
10685: undef(%name_to_host);
10686: undef(%hostname);
10687: undef(%hostdom);
10688: undef(%libserv);
10689: undef($loaded);
10690: }
10691:
10692: sub load_hosts_tab {
10693: my ($ignore_cache) = @_;
10694: &get_dns('/adm/dns/hosts',\&parse_hosts_tab,$ignore_cache);
10695: open(my $config,"<$perlvar{'lonTabDir'}/hosts.tab");
10696: my @config = <$config>;
10697: &parse_hosts_tab(\@config);
10698: close($config);
10699: $loaded=1;
10700: }
10701:
10702: sub hostname {
10703: &load_hosts_tab() if (!$loaded);
10704:
10705: my ($lonid) = @_;
10706: return $hostname{$lonid};
10707: }
10708:
10709: sub all_hostnames {
10710: &load_hosts_tab() if (!$loaded);
10711:
10712: return %hostname;
10713: }
10714:
10715: sub all_names {
10716: &load_hosts_tab() if (!$loaded);
10717:
10718: return %name_to_host;
10719: }
10720:
10721: sub all_host_domain {
10722: &load_hosts_tab() if (!$loaded);
10723: return %hostdom;
10724: }
10725:
10726: sub is_library {
10727: &load_hosts_tab() if (!$loaded);
10728:
10729: return exists($libserv{$_[0]});
10730: }
10731:
10732: sub all_library {
10733: &load_hosts_tab() if (!$loaded);
10734:
10735: return %libserv;
10736: }
10737:
10738: sub unique_library {
10739: #2x reverse removes all hostnames that appear more than once
10740: my %unique = reverse &all_library();
10741: return reverse %unique;
10742: }
10743:
10744: sub get_servers {
10745: &load_hosts_tab() if (!$loaded);
10746:
10747: my ($domain,$type) = @_;
10748: my %possible_hosts = ($type eq 'library') ? %libserv
10749: : %hostname;
10750: my %result;
10751: if (ref($domain) eq 'ARRAY') {
10752: while ( my ($host,$hostname) = each(%possible_hosts)) {
10753: if (grep(/^\Q$hostdom{$host}\E$/,@$domain)) {
10754: $result{$host} = $hostname;
10755: }
10756: }
10757: } else {
10758: while ( my ($host,$hostname) = each(%possible_hosts)) {
10759: if ($hostdom{$host} eq $domain) {
10760: $result{$host} = $hostname;
10761: }
10762: }
10763: }
10764: return %result;
10765: }
10766:
10767: sub get_unique_servers {
10768: my %unique = reverse &get_servers(@_);
10769: return reverse %unique;
10770: }
10771:
10772: sub host_domain {
10773: &load_hosts_tab() if (!$loaded);
10774:
10775: my ($lonid) = @_;
10776: return $hostdom{$lonid};
10777: }
10778:
10779: sub all_domains {
10780: &load_hosts_tab() if (!$loaded);
10781:
10782: my %seen;
10783: my @uniq = grep(!$seen{$_}++, values(%hostdom));
10784: return @uniq;
10785: }
10786:
10787: sub internet_dom {
10788: &load_hosts_tab() if (!$loaded);
10789:
10790: my ($lonid) = @_;
10791: return $internetdom{$lonid};
10792: }
10793:
10794: sub is_LC_dns {
10795: &load_hosts_tab() if (!$loaded);
10796:
10797: my ($hostname) = @_;
10798: return exists($LC_dns_serv{$hostname});
10799: }
10800:
10801: }
10802:
10803: {
10804: my %iphost;
10805: my %name_to_ip;
10806: my %lonid_to_ip;
10807:
10808: sub get_hosts_from_ip {
10809: my ($ip) = @_;
10810: my %iphosts = &get_iphost();
10811: if (ref($iphosts{$ip})) {
10812: return @{$iphosts{$ip}};
10813: }
10814: return;
10815: }
10816:
10817: sub reset_hosts_ip_info {
10818: undef(%iphost);
10819: undef(%name_to_ip);
10820: undef(%lonid_to_ip);
10821: }
10822:
10823: sub get_host_ip {
10824: my ($lonid) = @_;
10825: if (exists($lonid_to_ip{$lonid})) {
10826: return $lonid_to_ip{$lonid};
10827: }
10828: my $name=&hostname($lonid);
10829: my $ip = gethostbyname($name);
10830: return if (!$ip || length($ip) ne 4);
10831: $ip=inet_ntoa($ip);
10832: $name_to_ip{$name} = $ip;
10833: $lonid_to_ip{$lonid} = $ip;
10834: return $ip;
10835: }
10836:
10837: sub get_iphost {
10838: my ($ignore_cache) = @_;
10839:
10840: if (!$ignore_cache) {
10841: if (%iphost) {
10842: return %iphost;
10843: }
10844: my ($ip_info,$cached)=
10845: &Apache::lonnet::is_cached_new('iphost','iphost');
10846: if ($cached) {
10847: %iphost = %{$ip_info->[0]};
10848: %name_to_ip = %{$ip_info->[1]};
10849: %lonid_to_ip = %{$ip_info->[2]};
10850: return %iphost;
10851: }
10852: }
10853:
10854: # get yesterday's info for fallback
10855: my %old_name_to_ip;
10856: my ($ip_info,$cached)=
10857: &Apache::lonnet::is_cached_new('iphost','iphost');
10858: if ($cached) {
10859: %old_name_to_ip = %{$ip_info->[1]};
10860: }
10861:
10862: my %name_to_host = &all_names();
10863: foreach my $name (keys(%name_to_host)) {
10864: my $ip;
10865: if (!exists($name_to_ip{$name})) {
10866: $ip = gethostbyname($name);
10867: if (!$ip || length($ip) ne 4) {
10868: if (defined($old_name_to_ip{$name})) {
10869: $ip = $old_name_to_ip{$name};
10870: &logthis("Can't find $name defaulting to old $ip");
10871: } else {
10872: &logthis("Name $name no IP found");
10873: next;
10874: }
10875: } else {
10876: $ip=inet_ntoa($ip);
10877: }
10878: $name_to_ip{$name} = $ip;
10879: } else {
10880: $ip = $name_to_ip{$name};
10881: }
10882: foreach my $id (@{ $name_to_host{$name} }) {
10883: $lonid_to_ip{$id} = $ip;
10884: }
10885: push(@{$iphost{$ip}},@{$name_to_host{$name}});
10886: }
10887: &Apache::lonnet::do_cache_new('iphost','iphost',
10888: [\%iphost,\%name_to_ip,\%lonid_to_ip],
10889: 48*60*60);
10890:
10891: return %iphost;
10892: }
10893:
10894: #
10895: # Given a DNS returns the loncapa host name for that DNS
10896: #
10897: sub host_from_dns {
10898: my ($dns) = @_;
10899: my @hosts;
10900: my $ip;
10901:
10902: if (exists($name_to_ip{$dns})) {
10903: $ip = $name_to_ip{$dns};
10904: }
10905: if (!$ip) {
10906: $ip = gethostbyname($dns); # Initial translation to IP is in net order.
10907: if (length($ip) == 4) {
10908: $ip = &IO::Socket::inet_ntoa($ip);
10909: }
10910: }
10911: if ($ip) {
10912: @hosts = get_hosts_from_ip($ip);
10913: return $hosts[0];
10914: }
10915: return undef;
10916: }
10917:
10918: sub get_internet_names {
10919: my ($lonid) = @_;
10920: return if ($lonid eq '');
10921: my ($idnref,$cached)=
10922: &Apache::lonnet::is_cached_new('internetnames',$lonid);
10923: if ($cached) {
10924: return $idnref;
10925: }
10926: my $ip = &get_host_ip($lonid);
10927: my @hosts = &get_hosts_from_ip($ip);
10928: my %iphost = &get_iphost();
10929: my (@idns,%seen);
10930: foreach my $id (@hosts) {
10931: my $dom = &host_domain($id);
10932: my $prim_id = &domain($dom,'primary');
10933: my $prim_ip = &get_host_ip($prim_id);
10934: next if ($seen{$prim_ip});
10935: if (ref($iphost{$prim_ip}) eq 'ARRAY') {
10936: foreach my $id (@{$iphost{$prim_ip}}) {
10937: my $intdom = &internet_dom($id);
10938: unless (grep(/^\Q$intdom\E$/,@idns)) {
10939: push(@idns,$intdom);
10940: }
10941: }
10942: }
10943: $seen{$prim_ip} = 1;
10944: }
10945: return &Apache::lonnet::do_cache_new('internetnames',$lonid,\@idns,12*60*60);
10946: }
10947:
10948: }
10949:
10950: sub all_loncaparevs {
10951: 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);
10952: }
10953:
10954: BEGIN {
10955:
10956: # ----------------------------------- Read loncapa.conf and loncapa_apache.conf
10957: unless ($readit) {
10958: {
10959: my $configvars = LONCAPA::Configuration::read_conf('loncapa.conf');
10960: %perlvar = (%perlvar,%{$configvars});
10961: }
10962:
10963:
10964: # ------------------------------------------------------ Read spare server file
10965: {
10966: open(my $config,"<$perlvar{'lonTabDir'}/spare.tab");
10967:
10968: while (my $configline=<$config>) {
10969: chomp($configline);
10970: if ($configline) {
10971: my ($host,$type) = split(':',$configline,2);
10972: if (!defined($type) || $type eq '') { $type = 'default' };
10973: push(@{ $spareid{$type} }, $host);
10974: }
10975: }
10976: close($config);
10977: }
10978: # ------------------------------------------------------------ Read permissions
10979: {
10980: open(my $config,"<$perlvar{'lonTabDir'}/roles.tab");
10981:
10982: while (my $configline=<$config>) {
10983: chomp($configline);
10984: if ($configline) {
10985: my ($role,$perm)=split(/ /,$configline);
10986: if ($perm ne '') { $pr{$role}=$perm; }
10987: }
10988: }
10989: close($config);
10990: }
10991:
10992: # -------------------------------------------- Read plain texts for permissions
10993: {
10994: open(my $config,"<$perlvar{'lonTabDir'}/rolesplain.tab");
10995:
10996: while (my $configline=<$config>) {
10997: chomp($configline);
10998: if ($configline) {
10999: my ($short,@plain)=split(/:/,$configline);
11000: %{$prp{$short}} = ();
11001: if (@plain > 0) {
11002: $prp{$short}{'std'} = $plain[0];
11003: for (my $i=1; $i<@plain; $i++) {
11004: $prp{$short}{'alt'.$i} = $plain[$i];
11005: }
11006: }
11007: }
11008: }
11009: close($config);
11010: }
11011:
11012: # ---------------------------------------------------------- Read package table
11013: {
11014: open(my $config,"<$perlvar{'lonTabDir'}/packages.tab");
11015:
11016: while (my $configline=<$config>) {
11017: if ($configline !~ /\S/ || $configline=~/^#/) { next; }
11018: chomp($configline);
11019: my ($short,$plain)=split(/:/,$configline);
11020: my ($pack,$name)=split(/\&/,$short);
11021: if ($plain ne '') {
11022: $packagetab{$pack.'&'.$name.'&name'}=$name;
11023: $packagetab{$short}=$plain;
11024: }
11025: }
11026: close($config);
11027: }
11028:
11029: # ---------------------------------------------------------- Read loncaparev table
11030: {
11031: if (-e "$perlvar{'lonTabDir'}/loncaparevs.tab") {
11032: if (open(my $config,"<$perlvar{'lonTabDir'}/loncaparevs.tab")) {
11033: while (my $configline=<$config>) {
11034: chomp($configline);
11035: my ($hostid,$loncaparev)=split(/:/,$configline);
11036: $loncaparevs{$hostid}=$loncaparev;
11037: }
11038: close($config);
11039: }
11040: }
11041: }
11042:
11043: # ---------------------------------------------------------- Read serverhostID table
11044: {
11045: if (-e "$perlvar{'lonTabDir'}/serverhomeIDs.tab") {
11046: if (open(my $config,"<$perlvar{'lonTabDir'}/serverhomeIDs.tab")) {
11047: while (my $configline=<$config>) {
11048: chomp($configline);
11049: my ($name,$id)=split(/:/,$configline);
11050: $serverhomeIDs{$name}=$id;
11051: }
11052: close($config);
11053: }
11054: }
11055: }
11056:
11057: {
11058: my $file = $Apache::lonnet::perlvar{'lonTabDir'}.'/releaseslist.xml';
11059: if (-e $file) {
11060: my $parser = HTML::LCParser->new($file);
11061: while (my $token = $parser->get_token()) {
11062: if ($token->[0] eq 'S') {
11063: my $item = $token->[1];
11064: my $name = $token->[2]{'name'};
11065: my $value = $token->[2]{'value'};
11066: if ($item ne '' && $name ne '' && $value ne '') {
11067: my $release = $parser->get_text();
11068: $release =~ s/(^\s*|\s*$ )//gx;
11069: $needsrelease{$item.':'.$name.':'.$value} = $release;
11070: }
11071: }
11072: }
11073: }
11074: }
11075:
11076: # ---------------------------------------------------------- Read managers table
11077: {
11078: if (-e "$perlvar{'lonTabDir'}/managers.tab") {
11079: if (open(my $config,"<$perlvar{'lonTabDir'}/managers.tab")) {
11080: while (my $configline=<$config>) {
11081: chomp($configline);
11082: next if ($configline =~ /^\#/);
11083: if (($configline =~ /^[\w\-]+$/) || ($configline =~ /^[\w\-]+\:[\w\-]+$/)) {
11084: $managerstab{$configline} = 1;
11085: }
11086: }
11087: close($config);
11088: }
11089: }
11090: }
11091:
11092: # ------------- set up temporary directory
11093: {
11094: $tmpdir = LONCAPA::tempdir();
11095:
11096: }
11097:
11098: $memcache=new Cache::Memcached({'servers' => ['127.0.0.1:11211'],
11099: 'compress_threshold'=> 20_000,
11100: });
11101:
11102: $processmarker='_'.time.'_'.$perlvar{'lonHostID'};
11103: $dumpcount=0;
11104: $locknum=0;
11105:
11106: &logtouch();
11107: &logthis('<font color="yellow">INFO: Read configuration</font>');
11108: $readit=1;
11109: {
11110: use integer;
11111: my $test=(2**32)+1;
11112: if ($test != 0) { $_64bit=1; } else { $_64bit=0; }
11113: &logthis(" Detected 64bit platform ($_64bit)");
11114: }
11115: }
11116: }
11117:
11118: 1;
11119: __END__
11120:
11121: =pod
11122:
11123: =head1 NAME
11124:
11125: Apache::lonnet - Subroutines to ask questions about things in the network.
11126:
11127: =head1 SYNOPSIS
11128:
11129: Invoked by other LON-CAPA modules, when they need to talk to or about objects in the network.
11130:
11131: &Apache::lonnet::SUBROUTINENAME(ARGUMENTS);
11132:
11133: Common parameters:
11134:
11135: =over 4
11136:
11137: =item *
11138:
11139: $uname : an internal username (if $cname expecting a course Id specifically)
11140:
11141: =item *
11142:
11143: $udom : a domain (if $cdom expecting a course's domain specifically)
11144:
11145: =item *
11146:
11147: $symb : a resource instance identifier
11148:
11149: =item *
11150:
11151: $namespace : the name of a .db file that contains the data needed or
11152: being set.
11153:
11154: =back
11155:
11156: =head1 OVERVIEW
11157:
11158: lonnet provides subroutines which interact with the
11159: lonc/lond (TCP) network layer of LON-CAPA. They can be used to ask
11160: about classes, users, and resources.
11161:
11162: For many of these objects you can also use this to store data about
11163: them or modify them in various ways.
11164:
11165: =head2 Symbs
11166:
11167: To identify a specific instance of a resource, LON-CAPA uses symbols
11168: or "symbs"X<symb>. These identifiers are built from the URL of the
11169: map, the resource number of the resource in the map, and the URL of
11170: the resource itself. The latter is somewhat redundant, but might help
11171: if maps change.
11172:
11173: An example is
11174:
11175: msu/korte/parts/part1.sequence___19___msu/korte/tests/part12.problem
11176:
11177: The respective map entry is
11178:
11179: <resource id="19" src="/res/msu/korte/tests/part12.problem"
11180: title="Problem 2">
11181: </resource>
11182:
11183: Symbs are used by the random number generator, as well as to store and
11184: restore data specific to a certain instance of for example a problem.
11185:
11186: =head2 Storing And Retrieving Data
11187:
11188: X<store()>X<cstore()>X<restore()>Three of the most important functions
11189: in C<lonnet.pm> are C<&Apache::lonnet::cstore()>,
11190: C<&Apache::lonnet:restore()>, and C<&Apache::lonnet::store()>, which
11191: is is the non-critical message twin of cstore. These functions are for
11192: handlers to store a perl hash to a user's permanent data space in an
11193: easy manner, and to retrieve it again on another call. It is expected
11194: that a handler would use this once at the beginning to retrieve data,
11195: and then again once at the end to send only the new data back.
11196:
11197: The data is stored in the user's data directory on the user's
11198: homeserver under the ID of the course.
11199:
11200: The hash that is returned by restore will have all of the previous
11201: value for all of the elements of the hash.
11202:
11203: Example:
11204:
11205: #creating a hash
11206: my %hash;
11207: $hash{'foo'}='bar';
11208:
11209: #storing it
11210: &Apache::lonnet::cstore(\%hash);
11211:
11212: #changing a value
11213: $hash{'foo'}='notbar';
11214:
11215: #adding a new value
11216: $hash{'bar'}='foo';
11217: &Apache::lonnet::cstore(\%hash);
11218:
11219: #retrieving the hash
11220: my %history=&Apache::lonnet::restore();
11221:
11222: #print the hash
11223: foreach my $key (sort(keys(%history))) {
11224: print("\%history{$key} = $history{$key}");
11225: }
11226:
11227: Will print out:
11228:
11229: %history{1:foo} = bar
11230: %history{1:keys} = foo:timestamp
11231: %history{1:timestamp} = 990455579
11232: %history{2:bar} = foo
11233: %history{2:foo} = notbar
11234: %history{2:keys} = foo:bar:timestamp
11235: %history{2:timestamp} = 990455580
11236: %history{bar} = foo
11237: %history{foo} = notbar
11238: %history{timestamp} = 990455580
11239: %history{version} = 2
11240:
11241: Note that the special hash entries C<keys>, C<version> and
11242: C<timestamp> were added to the hash. C<version> will be equal to the
11243: total number of versions of the data that have been stored. The
11244: C<timestamp> attribute will be the UNIX time the hash was
11245: stored. C<keys> is available in every historical section to list which
11246: keys were added or changed at a specific historical revision of a
11247: hash.
11248:
11249: B<Warning>: do not store the hash that restore returns directly. This
11250: will cause a mess since it will restore the historical keys as if the
11251: were new keys. I.E. 1:foo will become 1:1:foo etc.
11252:
11253: Calling convention:
11254:
11255: my %record=&Apache::lonnet::restore($symb,$courseid,$domain,$uname,$home);
11256: &Apache::lonnet::cstore(\%newrecord,$symb,$courseid,$domain,$uname,$home);
11257:
11258: For more detailed information, see lonnet specific documentation.
11259:
11260: =head1 RETURN MESSAGES
11261:
11262: =over 4
11263:
11264: =item * B<con_lost>: unable to contact remote host
11265:
11266: =item * B<con_delayed>: unable to contact remote host, message will be delivered
11267: when the connection is brought back up
11268:
11269: =item * B<con_failed>: unable to contact remote host and unable to save message
11270: for later delivery
11271:
11272: =item * B<error:>: an error a occurred, a description of the error follows the :
11273:
11274: =item * B<no_such_host>: unable to fund a host associated with the user/domain
11275: that was requested
11276:
11277: =back
11278:
11279: =head1 PUBLIC SUBROUTINES
11280:
11281: =head2 Session Environment Functions
11282:
11283: =over 4
11284:
11285: =item *
11286: X<appenv()>
11287: B<appenv($hashref,$rolesarrayref)>: the value of %{$hashref} is written to
11288: the user envirnoment file, and will be restored for each access this
11289: user makes during this session, also modifies the %env for the current
11290: process. Optional rolesarrayref - if defined contains a reference to an array
11291: of roles which are exempt from the restriction on modifying user.role entries
11292: in the user's environment.db and in %env.
11293:
11294: =item *
11295: X<delenv()>
11296: B<delenv($delthis,$regexp)>: removes all items from the session
11297: environment file that begin with $delthis. If the
11298: optional second arg - $regexp - is true, $delthis is treated as a
11299: regular expression, otherwise \Q$delthis\E is used.
11300: The values are also deleted from the current processes %env.
11301:
11302: =item * get_env_multiple($name)
11303:
11304: gets $name from the %env hash, it seemlessly handles the cases where multiple
11305: values may be defined and end up as an array ref.
11306:
11307: returns an array of values
11308:
11309: =back
11310:
11311: =head2 User Information
11312:
11313: =over 4
11314:
11315: =item *
11316: X<queryauthenticate()>
11317: B<queryauthenticate($uname,$udom)>: try to determine user's current
11318: authentication scheme
11319:
11320: =item *
11321: X<authenticate()>
11322: B<authenticate($uname,$upass,$udom,$checkdefauth,$clientcancheckhost)>: try to
11323: authenticate user from domain's lib servers (first use the current
11324: one). C<$upass> should be the users password.
11325: $checkdefauth is optional (value is 1 if a check should be made to
11326: authenticate user using default authentication method, and allow
11327: account creation if username does not have account in the domain).
11328: $clientcancheckhost is optional (value is 1 if checking whether the
11329: server can host will occur on the client side in lonauth.pm).
11330:
11331: =item *
11332: X<homeserver()>
11333: B<homeserver($uname,$udom)>: find the server which has
11334: the user's directory and files (there must be only one), this caches
11335: the answer, and also caches if there is a borken connection.
11336:
11337: =item *
11338: X<idget()>
11339: B<idget($udom,@ids)>: find the usernames behind a list of IDs
11340: (IDs are a unique resource in a domain, there must be only 1 ID per
11341: username, and only 1 username per ID in a specific domain) (returns
11342: hash: id=>name,id=>name)
11343:
11344: =item *
11345: X<idrget()>
11346: B<idrget($udom,@unames)>: find the IDs behind a list of
11347: usernames (returns hash: name=>id,name=>id)
11348:
11349: =item *
11350: X<idput()>
11351: B<idput($udom,%ids)>: store away a list of names and associated IDs
11352:
11353: =item *
11354: X<rolesinit()>
11355: B<rolesinit($udom,$username,$authhost)>: get user privileges
11356:
11357: =item *
11358: X<getsection()>
11359: B<getsection($udom,$uname,$cname)>: finds the section of student in the
11360: course $cname, return section name/number or '' for "not in course"
11361: and '-1' for "no section"
11362:
11363: =item *
11364: X<userenvironment()>
11365: B<userenvironment($udom,$uname,@what)>: gets the values of the keys
11366: passed in @what from the requested user's environment, returns a hash
11367:
11368: =item *
11369: X<userlog_query()>
11370: B<userlog_query($uname,$udom,%filters)>: retrieves data from a user's
11371: activity.log file. %filters defines filters applied when parsing the
11372: log file. These can be start or end timestamps, or the type of action
11373: - log to look for Login or Logout events, check for Checkin or
11374: Checkout, role for role selection. The response is in the form
11375: timestamp1:hostid1:event1×tamp2:hostid2:event2 where events are
11376: escaped strings of the action recorded in the activity.log file.
11377:
11378: =back
11379:
11380: =head2 User Roles
11381:
11382: =over 4
11383:
11384: =item *
11385:
11386: allowed($priv,$uri,$symb,$role) : check for a user privilege; returns codes for allowed actions
11387: F: full access
11388: U,I,K: authentication modes (cxx only)
11389: '': forbidden
11390: 1: user needs to choose course
11391: 2: browse allowed
11392: A: passphrase authentication needed
11393:
11394: =item *
11395:
11396: definerole($rolename,$sysrole,$domrole,$courole) : define role; define a custom
11397: role rolename set privileges in format of lonTabs/roles.tab for system, domain,
11398: and course level
11399:
11400: =item *
11401:
11402: plaintext($short,$type,$cid,$forcedefault) : return value in %prp hash
11403: (rolesplain.tab); plain text explanation of a user role term.
11404: $type is Course (default) or Community.
11405: If $forcedefault evaluates to true, text returned will be default
11406: text for $type. Otherwise, if this is a course, the text returned
11407: will be a custom name for the role (if defined in the course's
11408: environment). If no custom name is defined the default is returned.
11409:
11410: =item *
11411:
11412: get_my_roles($uname,$udom,$context,$types,$roles,$roledoms,$withsec) :
11413: All arguments are optional. Returns a hash of a roles, either for
11414: co-author/assistant author roles for a user's Construction Space
11415: (default), or if $context is 'userroles', roles for the user himself,
11416: In the hash, keys are set to colon-separated $uname,$udom,$role, and
11417: (optionally) if $withsec is true, a fourth colon-separated item - $section.
11418: For each key, value is set to colon-separated start and end times for
11419: the role. If no username and domain are specified, will default to
11420: current user/domain. Types, roles, and roledoms are references to arrays
11421: of role statuses (active, future or previous), roles
11422: (e.g., cc,in, st etc.) and domains of the roles which can be used
11423: to restrict the list of roles reported. If no array ref is
11424: provided for types, will default to return only active roles.
11425:
11426: =back
11427:
11428: =head2 User Modification
11429:
11430: =over 4
11431:
11432: =item *
11433:
11434: assignrole($udom,$uname,$url,$role,$end,$start,$deleteflag,$selfenroll,$context) : assign role; give a role to a
11435: user for the level given by URL. Optional start and end dates (leave empty
11436: string or zero for "no date")
11437:
11438: =item *
11439:
11440: changepass($uname,$udom,$currentpass,$newpass,$server) : attempts to
11441: change a users, password, possible return values are: ok,
11442: pwchange_failure, non_authorized, auth_mode_error, unknown_user,
11443: refused
11444:
11445: =item *
11446:
11447: modifyuserauth($udom,$uname,$umode,$upass) : modify user authentication
11448:
11449: =item *
11450:
11451: modifyuser($udom,$uname,$uid,$umode,$upass,$first,$middle,$last, $gene,
11452: $forceid,$desiredhome,$email,$inststatus,$candelete) :
11453:
11454: will update user information (firstname,middlename,lastname,generation,
11455: permanentemail), and if forceid is true, student/employee ID also.
11456: A user's institutional affiliation(s) can also be updated.
11457: User information fields will not be overwritten with empty entries
11458: unless the field is included in the $candelete array reference.
11459: This array is included when a single user is modified via "Manage Users",
11460: or when Autoupdate.pl is run by cron in a domain.
11461:
11462: =item *
11463:
11464: modifystudent
11465:
11466: modify a student's enrollment and identification information.
11467: The course id is resolved based on the current users environment.
11468: This means the envoking user must be a course coordinator or otherwise
11469: associated with a course.
11470:
11471: This call is essentially a wrapper for lonnet::modifyuser and
11472: lonnet::modify_student_enrollment
11473:
11474: Inputs:
11475:
11476: =over 4
11477:
11478: =item B<$udom> Student's loncapa domain
11479:
11480: =item B<$uname> Student's loncapa login name
11481:
11482: =item B<$uid> Student/Employee ID
11483:
11484: =item B<$umode> Student's authentication mode
11485:
11486: =item B<$upass> Student's password
11487:
11488: =item B<$first> Student's first name
11489:
11490: =item B<$middle> Student's middle name
11491:
11492: =item B<$last> Student's last name
11493:
11494: =item B<$gene> Student's generation
11495:
11496: =item B<$usec> Student's section in course
11497:
11498: =item B<$end> Unix time of the roles expiration
11499:
11500: =item B<$start> Unix time of the roles start date
11501:
11502: =item B<$forceid> If defined, allow $uid to be changed
11503:
11504: =item B<$desiredhome> server to use as home server for student
11505:
11506: =item B<$email> Student's permanent e-mail address
11507:
11508: =item B<$type> Type of enrollment (auto or manual)
11509:
11510: =item B<$locktype> boolean - enrollment type locked to prevent Autoenroll.pl changing manual to auto
11511:
11512: =item B<$cid> courseID - needed if a course role is assigned by a user whose current role is DC
11513:
11514: =item B<$selfenroll> boolean - 1 if user role change occurred via self-enrollment
11515:
11516: =item B<$context> role change context (shown in User Management Logs display in a course)
11517:
11518: =item B<$inststatus> institutional status of user - : separated string of escaped status types
11519:
11520: =back
11521:
11522: =item *
11523:
11524: modify_student_enrollment
11525:
11526: Change a students enrollment status in a class. The environment variable
11527: 'role.request.course' must be defined for this function to proceed.
11528:
11529: Inputs:
11530:
11531: =over 4
11532:
11533: =item $udom, students domain
11534:
11535: =item $uname, students name
11536:
11537: =item $uid, students user id
11538:
11539: =item $first, students first name
11540:
11541: =item $middle
11542:
11543: =item $last
11544:
11545: =item $gene
11546:
11547: =item $usec
11548:
11549: =item $end
11550:
11551: =item $start
11552:
11553: =item $type
11554:
11555: =item $locktype
11556:
11557: =item $cid
11558:
11559: =item $selfenroll
11560:
11561: =item $context
11562:
11563: =back
11564:
11565:
11566: =item *
11567:
11568: assigncustomrole($udom,$uname,$url,$rdom,$rnam,$rolename,$end,$start) : assign
11569: custom role; give a custom role to a user for the level given by URL. Specify
11570: name and domain of role author, and role name
11571:
11572: =item *
11573:
11574: revokerole($udom,$uname,$url,$role) : revoke a role for url
11575:
11576: =item *
11577:
11578: revokecustomrole($udom,$uname,$url,$role) : revoke a custom role
11579:
11580: =back
11581:
11582: =head2 Course Infomation
11583:
11584: =over 4
11585:
11586: =item *
11587:
11588: coursedescription($courseid,$options) : returns a hash of information about the
11589: specified course id, including all environment settings for the
11590: course, the description of the course will be in the hash under the
11591: key 'description'
11592:
11593: $options is an optional parameter that if supplied is a hash reference that controls
11594: what how this function works. It has the following key/values:
11595:
11596: =over 4
11597:
11598: =item freshen_cache
11599:
11600: If defined, and the environment cache for the course is valid, it is
11601: returned in the returned hash.
11602:
11603: =item one_time
11604:
11605: If defined, the last cache time is set to _now_
11606:
11607: =item user
11608:
11609: If defined, the supplied username is used instead of the current user.
11610:
11611:
11612: =back
11613:
11614: =item *
11615:
11616: resdata($name,$domain,$type,@which) : request for current parameter
11617: setting for a specific $type, where $type is either 'course' or 'user',
11618: @what should be a list of parameters to ask about. This routine caches
11619: answers for 5 minutes.
11620:
11621: =item *
11622:
11623: get_courseresdata($courseid, $domain) : dump the entire course resource
11624: data base, returning a hash that is keyed by the resource name and has
11625: values that are the resource value. I believe that the timestamps and
11626: versions are also returned.
11627:
11628:
11629: =back
11630:
11631: =head2 Course Modification
11632:
11633: =over 4
11634:
11635: =item *
11636:
11637: writecoursepref($courseid,%prefs) : write preferences (environment
11638: database) for a course
11639:
11640: =item *
11641:
11642: createcourse($udom,$description,$url,$course_server,$nonstandard,$inst_code,$course_owner,$crstype,$cnum) : make course
11643:
11644: =item *
11645:
11646: generate_coursenum($udom,$crstype) : get a unique (unused) course number in domain $udom for course type $crstype (Course or Community).
11647:
11648: =back
11649:
11650: =head2 Resource Subroutines
11651:
11652: =over 4
11653:
11654: =item *
11655:
11656: subscribe($fname) : subscribe to a resource, returns URL if possible (probably should use repcopy instead)
11657:
11658: =item *
11659:
11660: repcopy($filename) : subscribes to the requested file, and attempts to
11661: replicate from the owning library server, Might return
11662: 'unavailable', 'not_found', 'forbidden', 'ok', or
11663: 'bad_request', also attempts to grab the metadata for the
11664: resource. Expects the local filesystem pathname
11665: (/home/httpd/html/res/....)
11666:
11667: =back
11668:
11669: =head2 Resource Information
11670:
11671: =over 4
11672:
11673: =item *
11674:
11675: EXT($varname,$symb,$udom,$uname) : evaluates and returns the value of
11676: a vairety of different possible values, $varname should be a request
11677: string, and the other parameters can be used to specify who and what
11678: one is asking about.
11679:
11680: Possible values for $varname are environment.lastname (or other item
11681: from the envirnment hash), user.name (or someother aspect about the
11682: user), resource.0.maxtries (or some other part and parameter of a
11683: resource)
11684:
11685: =item *
11686:
11687: directcondval($number) : get current value of a condition; reads from a state
11688: string
11689:
11690: =item *
11691:
11692: condval($condidx) : value of condition index based on state
11693:
11694: =item *
11695:
11696: metadata($uri,$what,$liburi,$prefix,$depthcount) : request a
11697: resource's metadata, $what should be either a specific key, or either
11698: 'keys' (to get a list of possible keys) or 'packages' to get a list of
11699: packages that this resource currently uses, the last 3 arguments are only used internally for recursive metadata.
11700:
11701: this function automatically caches all requests
11702:
11703: =item *
11704:
11705: metadata_query($query,$custom,$customshow) : make a metadata query against the
11706: network of library servers; returns file handle of where SQL and regex results
11707: will be stored for query
11708:
11709: =item *
11710:
11711: symbread($filename) : return symbolic list entry (filename argument optional);
11712: returns the data handle
11713:
11714: =item *
11715:
11716: symbverify($symb,$thisfn) : verifies that $symb actually exists and is
11717: a possible symb for the URL in $thisfn, and if is an encryypted
11718: resource that the user accessed using /enc/ returns a 1 on success, 0
11719: on failure, user must be in a course, as it assumes the existance of
11720: the course initial hash, and uses $env('request.course.id'}
11721:
11722:
11723: =item *
11724:
11725: symbclean($symb) : removes versions numbers from a symb, returns the
11726: cleaned symb
11727:
11728: =item *
11729:
11730: is_on_map($uri) : checks if the $uri is somewhere on the current
11731: course map, user must be in a course for it to work.
11732:
11733: =item *
11734:
11735: numval($salt) : return random seed value (addend for rndseed)
11736:
11737: =item *
11738:
11739: rndseed($symb,$courseid,$udom,$uname) : create a random sum; returns
11740: a random seed, all arguments are optional, if they aren't sent it uses the
11741: environment to derive them. Note: if symb isn't sent and it can't get one
11742: from &symbread it will use the current time as its return value
11743:
11744: =item *
11745:
11746: ireceipt($funame,$fudom,$fucourseid,$fusymb) : return unique,
11747: unfakeable, receipt
11748:
11749: =item *
11750:
11751: receipt() : API to ireceipt working off of env values; given out to users
11752:
11753: =item *
11754:
11755: countacc($url) : count the number of accesses to a given URL
11756:
11757: =item *
11758:
11759: 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
11760:
11761: =item *
11762:
11763: 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)
11764:
11765: =item *
11766:
11767: expirespread($uname,$udom,$stype,$usymb) : set expire date for spreadsheet
11768:
11769: =item *
11770:
11771: devalidate($symb) : devalidate temporary spreadsheet calculations,
11772: forcing spreadsheet to reevaluate the resource scores next time.
11773:
11774: =back
11775:
11776: =head2 Storing/Retreiving Data
11777:
11778: =over 4
11779:
11780: =item *
11781:
11782: store($storehash,$symb,$namespace,$udom,$uname) : stores hash permanently
11783: for this url; hashref needs to be given and should be a \%hashname; the
11784: remaining args aren't required and if they aren't passed or are '' they will
11785: be derived from the env
11786:
11787: =item *
11788:
11789: cstore($storehash,$symb,$namespace,$udom,$uname) : same as store but
11790: uses critical subroutine
11791:
11792: =item *
11793:
11794: restore($symb,$namespace,$udom,$uname) : returns hash for this symb;
11795: all args are optional
11796:
11797: =item *
11798:
11799: dumpstore($namespace,$udom,$uname,$regexp,$range) :
11800: dumps the complete (or key matching regexp) namespace into a hash
11801: ($udom, $uname, $regexp, $range are optional) for a namespace that is
11802: normally &store()ed into
11803:
11804: $range should be either an integer '100' (give me the first 100
11805: matching records)
11806: or be two integers sperated by a - with no spaces
11807: '30-50' (give me the 30th through the 50th matching
11808: records)
11809:
11810:
11811: =item *
11812:
11813: putstore($namespace,$symb,$version,$storehash,$udomain,$uname) :
11814: replaces a &store() version of data with a replacement set of data
11815: for a particular resource in a namespace passed in the $storehash hash
11816: reference
11817:
11818: =item *
11819:
11820: tmpstore($storehash,$symb,$namespace,$udom,$uname) : storage that
11821: works very similar to store/cstore, but all data is stored in a
11822: temporary location and can be reset using tmpreset, $storehash should
11823: be a hash reference, returns nothing on success
11824:
11825: =item *
11826:
11827: tmprestore($symb,$namespace,$udom,$uname) : storage that works very
11828: similar to restore, but all data is stored in a temporary location and
11829: can be reset using tmpreset. Returns a hash of values on success,
11830: error string otherwise.
11831:
11832: =item *
11833:
11834: tmpreset($symb,$namespace,$udom,$uname) : temporary storage reset,
11835: deltes all keys for $symb form the temporary storage hash.
11836:
11837: =item *
11838:
11839: get($namespace,$storearr,$udom,$uname) : returns hash with keys from array
11840: reference filled in from namesp ($udom and $uname are optional)
11841:
11842: =item *
11843:
11844: del($namespace,$storearr,$udom,$uname) : deletes keys out of array from
11845: namesp ($udom and $uname are optional)
11846:
11847: =item *
11848:
11849: dump($namespace,$udom,$uname,$regexp,$range) :
11850: dumps the complete (or key matching regexp) namespace into a hash
11851: ($udom, $uname, $regexp, $range are optional)
11852:
11853: $range should be either an integer '100' (give me the first 100
11854: matching records)
11855: or be two integers sperated by a - with no spaces
11856: '30-50' (give me the 30th through the 50th matching
11857: records)
11858: =item *
11859:
11860: inc($namespace,$store,$udom,$uname) : increments $store in $namespace.
11861: $store can be a scalar, an array reference, or if the amount to be
11862: incremented is > 1, a hash reference.
11863:
11864: ($udom and $uname are optional)
11865:
11866: =item *
11867:
11868: put($namespace,$storehash,$udom,$uname) : stores hash in namesp
11869: ($udom and $uname are optional)
11870:
11871: =item *
11872:
11873: cput($namespace,$storehash,$udom,$uname) : critical put
11874: ($udom and $uname are optional)
11875:
11876: =item *
11877:
11878: newput($namespace,$storehash,$udom,$uname) :
11879:
11880: Attempts to store the items in the $storehash, but only if they don't
11881: currently exist, if this succeeds you can be certain that you have
11882: successfully created a new key value pair in the $namespace db.
11883:
11884:
11885: Args:
11886: $namespace: name of database to store values to
11887: $storehash: hashref to store to the db
11888: $udom: (optional) domain of user containing the db
11889: $uname: (optional) name of user caontaining the db
11890:
11891: Returns:
11892: 'ok' -> succeeded in storing all keys of $storehash
11893: 'key_exists: <key>' -> failed to anything out of $storehash, as at
11894: least <key> already existed in the db (other
11895: requested keys may also already exist)
11896: 'error: <msg>' -> unable to tie the DB or other error occurred
11897: 'con_lost' -> unable to contact request server
11898: 'refused' -> action was not allowed by remote machine
11899:
11900:
11901: =item *
11902:
11903: eget($namespace,$storearr,$udom,$uname) : returns hash with keys from array
11904: reference filled in from namesp (encrypts the return communication)
11905: ($udom and $uname are optional)
11906:
11907: =item *
11908:
11909: log($udom,$name,$home,$message) : write to permanent log for user; use
11910: critical subroutine
11911:
11912: =item *
11913:
11914: get_dom($namespace,$storearr,$udom,$uhome) : returns hash with keys from
11915: array reference filled in from namespace found in domain level on either
11916: specified domain server ($uhome) or primary domain server ($udom and $uhome are optional).
11917:
11918: =item *
11919:
11920: put_dom($namespace,$storehash,$udom,$uhome) : stores hash in namespace at
11921: domain level either on specified domain server ($uhome) or primary domain
11922: server ($udom and $uhome are optional)
11923:
11924: =item *
11925:
11926: get_domain_defaults($target_domain) : returns hash with defaults for
11927: authentication and language in the domain. Keys are: auth_def, auth_arg_def,
11928: lang_def; corresponsing values are authentication type (internal, krb4, krb5,
11929: or localauth), initial password or a kerberos realm, language (e.g., en-us).
11930: Values are retrieved from cache (if current), or from domain's configuration.db
11931: (if available), or lastly from values in lonTabs/dns_domain,tab,
11932: or lonTabs/domain.tab.
11933:
11934: %domdefaults = &get_auth_defaults($target_domain);
11935:
11936: =back
11937:
11938: =head2 Network Status Functions
11939:
11940: =over 4
11941:
11942: =item *
11943:
11944: dirlist() : return directory list based on URI (first arg).
11945:
11946: Inputs: 1 required, 5 optional.
11947:
11948: =over
11949:
11950: =item
11951: $uri - path to file in filesystem (starts: /res or /userfiles/). Required.
11952:
11953: =item
11954: $userdomain - domain of user/course to be listed. Extracted from $uri if absent.
11955:
11956: =item
11957: $username - username of user/course to be listed. Extracted from $uri if absent.
11958:
11959: =item
11960: $getpropath - boolean: 1 if prepend path using &propath().
11961:
11962: =item
11963: $getuserdir - boolean: 1 if prepend path for "userfiles".
11964:
11965: =item
11966: $alternateRoot - path to prepend in place of path from $uri.
11967:
11968: =back
11969:
11970: Returns: Array of up to two items.
11971:
11972: =over
11973:
11974: a reference to an array of files/subdirectories
11975:
11976: =over
11977:
11978: Each element in the array of files/subdirectories is a & separated list of
11979: item name and the result of running stat on the item. If dirlist was requested
11980: for a file instead of a directory, the item name will be ''. For a directory
11981: listing, if the item is a metadata file, the element will end &N&M
11982: (where N amd M are either 0 or 1, corresponding to obsolete set (1), or
11983: default copyright set (1).
11984:
11985: =back
11986:
11987: a scalar containing error condition (if encountered).
11988:
11989: =over
11990:
11991: =item
11992: no_host (no homeserver identified for $username:$domain).
11993:
11994: =item
11995: no_such_host (server contacted for listing not identified as valid host).
11996:
11997: =item
11998: con_lost (connection to remote server failed).
11999:
12000: =item
12001: refused (invalid $username:$domain received on lond side).
12002:
12003: =item
12004: no_such_dir (directory at specified path on lond side does not exist).
12005:
12006: =item
12007: empty (directory at specified path on lond side is empty).
12008:
12009: =over
12010:
12011: This is currently not encountered because the &ls3, &ls2,
12012: &ls (_handler) routines on the lond side do not filter out
12013: . and .. from a directory listing.
12014:
12015: =back
12016:
12017: =back
12018:
12019: =back
12020:
12021: =item *
12022:
12023: spareserver() : find server with least workload from spare.tab
12024:
12025:
12026: =item *
12027:
12028: host_from_dns($dns) : Returns the loncapa hostname corresponding to a DNS name or undef
12029: if there is no corresponding loncapa host.
12030:
12031: =back
12032:
12033:
12034: =head2 Apache Request
12035:
12036: =over 4
12037:
12038: =item *
12039:
12040: ssi($url,%hash) : server side include, does a complete request cycle on url to
12041: localhost, posts hash
12042:
12043: =back
12044:
12045: =head2 Data to String to Data
12046:
12047: =over 4
12048:
12049: =item *
12050:
12051: hash2str(%hash) : convert a hash into a string complete with escaping and '='
12052: and '&' separators, supports elements that are arrayrefs and hashrefs
12053:
12054: =item *
12055:
12056: hashref2str($hashref) : convert a hashref into a string complete with
12057: escaping and '=' and '&' separators, supports elements that are
12058: arrayrefs and hashrefs
12059:
12060: =item *
12061:
12062: arrayref2str($arrayref) : convert an arrayref into a string complete
12063: with escaping and '&' separators, supports elements that are arrayrefs
12064: and hashrefs
12065:
12066: =item *
12067:
12068: str2hash($string) : convert string to hash using unescaping and
12069: splitting on '=' and '&', supports elements that are arrayrefs and
12070: hashrefs
12071:
12072: =item *
12073:
12074: str2array($string) : convert string to hash using unescaping and
12075: splitting on '&', supports elements that are arrayrefs and hashrefs
12076:
12077: =back
12078:
12079: =head2 Logging Routines
12080:
12081:
12082: These routines allow one to make log messages in the lonnet.log and
12083: lonnet.perm logfiles.
12084:
12085: =over 4
12086:
12087: =item *
12088:
12089: logtouch() : make sure the logfile, lonnet.log, exists
12090:
12091: =item *
12092:
12093: logthis() : append message to the normal lonnet.log file, it gets
12094: preiodically rolled over and deleted.
12095:
12096: =item *
12097:
12098: logperm() : append a permanent message to lonnet.perm.log, this log
12099: file never gets deleted by any automated portion of the system, only
12100: messages of critical importance should go in here.
12101:
12102:
12103: =back
12104:
12105: =head2 General File Helper Routines
12106:
12107: =over 4
12108:
12109: =item *
12110:
12111: getfile($file,$caller) : two cases - requests for files in /res or in /uploaded.
12112: (a) files in /uploaded
12113: (i) If a local copy of the file exists -
12114: compares modification date of local copy with last-modified date for
12115: definitive version stored on home server for course. If local copy is
12116: stale, requests a new version from the home server and stores it.
12117: If the original has been removed from the home server, then local copy
12118: is unlinked.
12119: (ii) If local copy does not exist -
12120: requests the file from the home server and stores it.
12121:
12122: If $caller is 'uploadrep':
12123: This indicates a call from lonuploadrep.pm (PerlHeaderParserHandler phase)
12124: for request for files originally uploaded via DOCS.
12125: - returns 'ok' if fresh local copy now available, -1 otherwise.
12126:
12127: Otherwise:
12128: This indicates a call from the content generation phase of the request.
12129: - returns the entire contents of the file or -1.
12130:
12131: (b) files in /res
12132: - returns the entire contents of a file or -1;
12133: it properly subscribes to and replicates the file if neccessary.
12134:
12135:
12136: =item *
12137:
12138: stat_file($url) : $url is expected to be a /res/ or /uploaded/ style file
12139: reference
12140:
12141: returns either a stat() list of data about the file or an empty list
12142: if the file doesn't exist or couldn't find out about it (connection
12143: problems or user unknown)
12144:
12145: =item *
12146:
12147: filelocation($dir,$file) : returns file system location of a file
12148: based on URI; meant to be "fairly clean" absolute reference, $dir is a
12149: directory that relative $file lookups are to looked in ($dir of /a/dir
12150: and a file of ../bob will become /a/bob)
12151:
12152: =item *
12153:
12154: hreflocation($dir,$file) : returns file system location or a URL; same as
12155: filelocation except for hrefs
12156:
12157: =item *
12158:
12159: declutter() : declutters URLs (remove docroot, beginning slashes, 'res' etc)
12160:
12161: =back
12162:
12163: =head2 Usererfile file routines (/uploaded*)
12164:
12165: =over 4
12166:
12167: =item *
12168:
12169: userfileupload(): main rotine for putting a file in a user or course's
12170: filespace, arguments are,
12171:
12172: formname - required - this is the name of the element in $env where the
12173: filename, and the contents of the file to create/modifed exist
12174: the filename is in $env{'form.'.$formname.'.filename'} and the
12175: contents of the file is located in $env{'form.'.$formname}
12176: context - if coursedoc, store the file in the course of the active role
12177: of the current user;
12178: if 'existingfile': store in 'overwrites' in /home/httpd/perl/tmp
12179: if 'canceloverwrite': delete file in tmp/overwrites directory
12180: subdir - required - subdirectory to put the file in under ../userfiles/
12181: if undefined, it will be placed in "unknown"
12182:
12183: (This routine calls clean_filename() to remove any dangerous
12184: characters from the filename, and then calls finuserfileupload() to
12185: complete the transaction)
12186:
12187: returns either the url of the uploaded file (/uploaded/....) if successful
12188: and /adm/notfound.html if unsuccessful
12189:
12190: =item *
12191:
12192: clean_filename(): routine for cleaing a filename up for storage in
12193: userfile space, argument is:
12194:
12195: filename - proposed filename
12196:
12197: returns: the new clean filename
12198:
12199: =item *
12200:
12201: finishuserfileupload(): routine that creates and sends the file to
12202: userspace, probably shouldn't be called directly
12203:
12204: docuname: username or courseid of destination for the file
12205: docudom: domain of user/course of destination for the file
12206: formname: same as for userfileupload()
12207: fname: filename (including subdirectories) for the file
12208: parser: if 'parse', will parse (html) file to extract references to objects, links etc.
12209: allfiles: reference to hash used to store objects found by parser
12210: codebase: reference to hash used for codebases of java objects found by parser
12211: thumbwidth: width (pixels) of thumbnail to be created for uploaded image
12212: thumbheight: height (pixels) of thumbnail to be created for uploaded image
12213: resizewidth: width to be used to resize image using resizeImage from ImageMagick
12214: resizeheight: height to be used to resize image using resizeImage from ImageMagick
12215: context: if 'overwrite', will move the uploaded file from its temporary location to
12216: userfiles to facilitate overwriting a previously uploaded file with same name.
12217: mimetype: reference to scalar to accommodate mime type determined
12218: from File::MMagic if $parser = parse.
12219:
12220: returns either the url of the uploaded file (/uploaded/....) if successful
12221: and /adm/notfound.html if unsuccessful (or an error message if context
12222: was 'overwrite').
12223:
12224:
12225: =item *
12226:
12227: renameuserfile(): renames an existing userfile to a new name
12228:
12229: Args:
12230: docuname: username or courseid of destination for the file
12231: docudom: domain of user/course of destination for the file
12232: old: current file name (including any subdirs under userfiles)
12233: new: desired file name (including any subdirs under userfiles)
12234:
12235: =item *
12236:
12237: mkdiruserfile(): creates a directory is a userfiles dir
12238:
12239: Args:
12240: docuname: username or courseid of destination for the file
12241: docudom: domain of user/course of destination for the file
12242: dir: dir to create (including any subdirs under userfiles)
12243:
12244: =item *
12245:
12246: removeuserfile(): removes a file that exists in userfiles
12247:
12248: Args:
12249: docuname: username or courseid of destination for the file
12250: docudom: domain of user/course of destination for the file
12251: fname: filname to delete (including any subdirs under userfiles)
12252:
12253: =item *
12254:
12255: removeuploadedurl(): convience function for removeuserfile()
12256:
12257: Args:
12258: url: a full /uploaded/... url to delete
12259:
12260: =item *
12261:
12262: get_portfile_permissions():
12263: Args:
12264: domain: domain of user or course contain the portfolio files
12265: user: name of user or num of course contain the portfolio files
12266: Returns:
12267: hashref of a dump of the proper file_permissions.db
12268:
12269:
12270: =item *
12271:
12272: get_access_controls():
12273:
12274: Args:
12275: current_permissions: the hash ref returned from get_portfile_permissions()
12276: group: (optional) the group you want the files associated with
12277: file: (optional) the file you want access info on
12278:
12279: Returns:
12280: a hash (keys are file names) of hashes containing
12281: keys are: path to file/file_name\0uniqueID:scope_end_start (see below)
12282: values are XML containing access control settings (see below)
12283:
12284: Internal notes:
12285:
12286: access controls are stored in file_permissions.db as key=value pairs.
12287: key -> path to file/file_name\0uniqueID:scope_end_start
12288: where scope -> public,guest,course,group,domains or users.
12289: end -> UNIX time for end of access (0 -> no end date)
12290: start -> UNIX time for start of access
12291:
12292: value -> XML description of access control
12293: <scope type=""> (type =1 of: public,guest,course,group,domains,users">
12294: <start></start>
12295: <end></end>
12296:
12297: <password></password> for scope type = guest
12298:
12299: <domain></domain> for scope type = course or group
12300: <number></number>
12301: <roles id="">
12302: <role></role>
12303: <access></access>
12304: <section></section>
12305: <group></group>
12306: </roles>
12307:
12308: <dom></dom> for scope type = domains
12309:
12310: <users> for scope type = users
12311: <user>
12312: <uname></uname>
12313: <udom></udom>
12314: </user>
12315: </users>
12316: </scope>
12317:
12318: Access data is also aggregated for each file in an additional key=value pair:
12319: key -> path to file/file_name\0accesscontrol
12320: value -> reference to hash
12321: hash contains key = value pairs
12322: where key = uniqueID:scope_end_start
12323: value = UNIX time record was last updated
12324:
12325: Used to improve speed of look-ups of access controls for each file.
12326:
12327: Locks on files (resulting from submission of portfolio file to a homework problem stored in array of arrays.
12328:
12329: modify_access_controls():
12330:
12331: Modifies access controls for a portfolio file
12332: Args
12333: 1. file name
12334: 2. reference to hash of required changes,
12335: 3. domain
12336: 4. username
12337: where domain,username are the domain of the portfolio owner
12338: (either a user or a course)
12339:
12340: Returns:
12341: 1. result of additions or updates ('ok' or 'error', with error message).
12342: 2. result of deletions ('ok' or 'error', with error message).
12343: 3. reference to hash of any new or updated access controls.
12344: 4. reference to hash used to map incoming IDs to uniqueIDs assigned to control.
12345: key = integer (inbound ID)
12346: value = uniqueID
12347:
12348: =back
12349:
12350: =head2 HTTP Helper Routines
12351:
12352: =over 4
12353:
12354: =item *
12355:
12356: escape() : unpack non-word characters into CGI-compatible hex codes
12357:
12358: =item *
12359:
12360: unescape() : pack CGI-compatible hex codes into actual non-word ASCII character
12361:
12362: =back
12363:
12364: =head1 PRIVATE SUBROUTINES
12365:
12366: =head2 Underlying communication routines (Shouldn't call)
12367:
12368: =over 4
12369:
12370: =item *
12371:
12372: subreply() : tries to pass a message to lonc, returns con_lost if incapable
12373:
12374: =item *
12375:
12376: reply() : uses subreply to send a message to remote machine, logs all failures
12377:
12378: =item *
12379:
12380: critical() : passes a critical message to another server; if cannot
12381: get through then place message in connection buffer directory and
12382: returns con_delayed, if incapable of saving message, returns
12383: con_failed
12384:
12385: =item *
12386:
12387: reconlonc() : tries to reconnect lonc client processes.
12388:
12389: =back
12390:
12391: =head2 Resource Access Logging
12392:
12393: =over 4
12394:
12395: =item *
12396:
12397: flushcourselogs() : flush (save) buffer logs and access logs
12398:
12399: =item *
12400:
12401: courselog($what) : save message for course in hash
12402:
12403: =item *
12404:
12405: courseacclog($what) : save message for course using &courselog(). Perform
12406: special processing for specific resource types (problems, exams, quizzes, etc).
12407:
12408: =item *
12409:
12410: goodbye() : flush course logs and log shutting down; it is called in srm.conf
12411: as a PerlChildExitHandler
12412:
12413: =back
12414:
12415: =head2 Other
12416:
12417: =over 4
12418:
12419: =item *
12420:
12421: symblist($mapname,%newhash) : update symbolic storage links
12422:
12423: =back
12424:
12425: =cut
12426:
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