1: # The LearningOnline Network
2: # TCP networking package
3: #
4: # $Id: lonnet.pm,v 1.1154 2012/02/16 19:31:14 raeburn Exp $
5: #
6: # Copyright Michigan State University Board of Trustees
7: #
8: # This file is part of the LearningOnline Network with CAPA (LON-CAPA).
9: #
10: # LON-CAPA is free software; you can redistribute it and/or modify
11: # it under the terms of the GNU General Public License as published by
12: # the Free Software Foundation; either version 2 of the License, or
13: # (at your option) any later version.
14: #
15: # LON-CAPA is distributed in the hope that it will be useful,
16: # but WITHOUT ANY WARRANTY; without even the implied warranty of
17: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18: # GNU General Public License for more details.
19: #
20: # You should have received a copy of the GNU General Public License
21: # along with LON-CAPA; if not, write to the Free Software
22: # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
23: #
24: # /home/httpd/html/adm/gpl.txt
25: #
26: # http://www.lon-capa.org/
27: #
28: ###
29:
30: =pod
31:
32: =head1 NAME
33:
34: Apache::lonnet.pm
35:
36: =head1 SYNOPSIS
37:
38: This file is an interface to the lonc processes of
39: the LON-CAPA network as well as set of elaborated functions for handling information
40: necessary for navigating through a given cluster of LON-CAPA machines within a
41: domain. There are over 40 specialized functions in this module which handle the
42: reading and transmission of metadata, user information (ids, names, environments, roles,
43: logs), file information (storage, reading, directories, extensions, replication, embedded
44: styles and descriptors), educational resources (course descriptions, section names and
45: numbers), url hashing (to assign roles on a url basis), and translating abbreviated symbols to
46: and from more descriptive phrases or explanations.
47:
48: This is part of the LearningOnline Network with CAPA project
49: described at http://www.lon-capa.org.
50:
51: =head1 Package Variables
52:
53: These are largely undocumented, so if you decipher one please note it here.
54:
55: =over 4
56:
57: =item $processmarker
58:
59: Contains the time this process was started and this servers host id.
60:
61: =item $dumpcount
62:
63: Counts the number of times a message log flush has been attempted (regardless
64: of success) by this process. Used as part of the filename when messages are
65: delayed.
66:
67: =back
68:
69: =cut
70:
71: package Apache::lonnet;
72:
73: use strict;
74: use LWP::UserAgent();
75: use HTTP::Date;
76: use Image::Magick;
77:
78: use vars qw(%perlvar %spareid %pr %prp $memcache %packagetab $tmpdir
79: $_64bit %env %protocol %loncaparevs %serverhomeIDs %needsrelease
80: %managerstab);
81:
82: my (%badServerCache, $memcache, %courselogs, %accesshash, %domainrolehash,
83: %userrolehash, $processmarker, $dumpcount, %coursedombuf,
84: %coursenumbuf, %coursehombuf, %coursedescrbuf, %courseinstcodebuf,
85: %courseownerbuf, %coursetypebuf,$locknum);
86:
87: use IO::Socket;
88: use GDBM_File;
89: use HTML::LCParser;
90: use Fcntl qw(:flock);
91: use Storable qw(thaw nfreeze);
92: use Time::HiRes qw( 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) = @_;
599: my %cookies=CGI::Cookie->parse($r->header_in('Cookie'));
600: my $lonid=$cookies{'lonID'};
601: return undef if (!$lonid);
602:
603: my $handle=&LONCAPA::clean_handle($lonid->value);
604: my $lonidsdir=$r->dir_config('lonIDsDir');
605: return undef if (!-e "$lonidsdir/$handle.id");
606:
607: my $opened = open(my $idf,'+<',"$lonidsdir/$handle.id");
608: return undef if (!$opened);
609:
610: flock($idf,LOCK_SH);
611: my %disk_env;
612: if (!tie(%disk_env,'GDBM_File',"$lonidsdir/$handle.id",
613: &GDBM_READER(),0640)) {
614: return undef;
615: }
616:
617: if (!defined($disk_env{'user.name'})
618: || !defined($disk_env{'user.domain'})) {
619: return undef;
620: }
621: return $handle;
622: }
623:
624: sub timed_flock {
625: my ($file,$lock_type) = @_;
626: my $failed=0;
627: eval {
628: local $SIG{__DIE__}='DEFAULT';
629: local $SIG{ALRM}=sub {
630: $failed=1;
631: die("failed lock");
632: };
633: alarm(13);
634: flock($file,$lock_type);
635: alarm(0);
636: };
637: if ($failed) {
638: return undef;
639: } else {
640: return 1;
641: }
642: }
643:
644: # ---------------------------------------------------------- Append Environment
645:
646: sub appenv {
647: my ($newenv,$roles) = @_;
648: if (ref($newenv) eq 'HASH') {
649: foreach my $key (keys(%{$newenv})) {
650: my $refused = 0;
651: if (($key =~ /^user\.role/) || ($key =~ /^user\.priv/)) {
652: $refused = 1;
653: if (ref($roles) eq 'ARRAY') {
654: my ($type,$role) = ($key =~ /^user\.(role|priv)\.([^.]+)\./);
655: if (grep(/^\Q$role\E$/,@{$roles})) {
656: $refused = 0;
657: }
658: }
659: }
660: if ($refused) {
661: &logthis("<font color=\"blue\">WARNING: ".
662: "Attempt to modify environment ".$key." to ".$newenv->{$key}
663: .'</font>');
664: delete($newenv->{$key});
665: } else {
666: $env{$key}=$newenv->{$key};
667: }
668: }
669: my $opened = open(my $env_file,'+<',$env{'user.environment'});
670: if ($opened
671: && &timed_flock($env_file,LOCK_EX)
672: &&
673: tie(my %disk_env,'GDBM_File',$env{'user.environment'},
674: (&GDBM_WRITER()|&GDBM_NOLOCK()),0640)) {
675: while (my ($key,$value) = each(%{$newenv})) {
676: $disk_env{$key} = $value;
677: }
678: untie(%disk_env);
679: }
680: }
681: return 'ok';
682: }
683: # ----------------------------------------------------- Delete from Environment
684:
685: sub delenv {
686: my ($delthis,$regexp,$roles) = @_;
687: if (($delthis=~/^user\.role/) || ($delthis=~/^user\.priv/)) {
688: my $refused = 1;
689: if (ref($roles) eq 'ARRAY') {
690: my ($type,$role) = ($delthis =~ /^user\.(role|priv)\.([^.]+)\./);
691: if (grep(/^\Q$role\E$/,@{$roles})) {
692: $refused = 0;
693: }
694: }
695: if ($refused) {
696: &logthis("<font color=\"blue\">WARNING: ".
697: "Attempt to delete from environment ".$delthis);
698: return 'error';
699: }
700: }
701: my $opened = open(my $env_file,'+<',$env{'user.environment'});
702: if ($opened
703: && &timed_flock($env_file,LOCK_EX)
704: &&
705: tie(my %disk_env,'GDBM_File',$env{'user.environment'},
706: (&GDBM_WRITER()|&GDBM_NOLOCK()),0640)) {
707: foreach my $key (keys(%disk_env)) {
708: if ($regexp) {
709: if ($key=~/^$delthis/) {
710: delete($env{$key});
711: delete($disk_env{$key});
712: }
713: } else {
714: if ($key=~/^\Q$delthis\E/) {
715: delete($env{$key});
716: delete($disk_env{$key});
717: }
718: }
719: }
720: untie(%disk_env);
721: }
722: return 'ok';
723: }
724:
725: sub get_env_multiple {
726: my ($name) = @_;
727: my @values;
728: if (defined($env{$name})) {
729: # exists is it an array
730: if (ref($env{$name})) {
731: @values=@{ $env{$name} };
732: } else {
733: $values[0]=$env{$name};
734: }
735: }
736: return(@values);
737: }
738:
739: # ------------------------------------------------------------------- Locking
740:
741: sub set_lock {
742: my ($text)=@_;
743: $locknum++;
744: my $id=$$.'-'.$locknum;
745: &appenv({'session.locks' => $env{'session.locks'}.','.$id,
746: 'session.lock.'.$id => $text});
747: return $id;
748: }
749:
750: sub get_locks {
751: my $num=0;
752: my %texts=();
753: foreach my $lock (split(/\,/,$env{'session.locks'})) {
754: if ($lock=~/\w/) {
755: $num++;
756: $texts{$lock}=$env{'session.lock.'.$lock};
757: }
758: }
759: return ($num,%texts);
760: }
761:
762: sub remove_lock {
763: my ($id)=@_;
764: my $newlocks='';
765: foreach my $lock (split(/\,/,$env{'session.locks'})) {
766: if (($lock=~/\w/) && ($lock ne $id)) {
767: $newlocks.=','.$lock;
768: }
769: }
770: &appenv({'session.locks' => $newlocks});
771: &delenv('session.lock.'.$id);
772: }
773:
774: sub remove_all_locks {
775: my $activelocks=$env{'session.locks'};
776: foreach my $lock (split(/\,/,$env{'session.locks'})) {
777: if ($lock=~/\w/) {
778: &remove_lock($lock);
779: }
780: }
781: }
782:
783:
784: # ------------------------------------------ Find out current server userload
785: sub userload {
786: my $numusers=0;
787: {
788: opendir(LONIDS,$perlvar{'lonIDsDir'});
789: my $filename;
790: my $curtime=time;
791: while ($filename=readdir(LONIDS)) {
792: next if ($filename eq '.' || $filename eq '..');
793: next if ($filename =~ /publicuser_\d+\.id/);
794: my ($mtime)=(stat($perlvar{'lonIDsDir'}.'/'.$filename))[9];
795: if ($curtime-$mtime < 1800) { $numusers++; }
796: }
797: closedir(LONIDS);
798: }
799: my $userloadpercent=0;
800: my $maxuserload=$perlvar{'lonUserLoadLim'};
801: if ($maxuserload) {
802: $userloadpercent=100*$numusers/$maxuserload;
803: }
804: $userloadpercent=sprintf("%.2f",$userloadpercent);
805: return $userloadpercent;
806: }
807:
808: # ------------------------------ Find server with least workload from spare.tab
809:
810: sub spareserver {
811: my ($loadpercent,$userloadpercent,$want_server_name,$udom) = @_;
812: my $spare_server;
813: if ($userloadpercent !~ /\d/) { $userloadpercent=0; }
814: my $lowest_load=($loadpercent > $userloadpercent) ? $loadpercent
815: : $userloadpercent;
816: my ($uint_dom,$remotesessions);
817: if (($udom ne '') && (&domain($udom) ne '')) {
818: my $uprimary_id = &Apache::lonnet::domain($udom,'primary');
819: $uint_dom = &Apache::lonnet::internet_dom($uprimary_id);
820: my %udomdefaults = &Apache::lonnet::get_domain_defaults($udom);
821: $remotesessions = $udomdefaults{'remotesessions'};
822: }
823: my $spareshash = &this_host_spares($udom);
824: if (ref($spareshash) eq 'HASH') {
825: if (ref($spareshash->{'primary'}) eq 'ARRAY') {
826: foreach my $try_server (@{ $spareshash->{'primary'} }) {
827: if ($uint_dom) {
828: next unless (&spare_can_host($udom,$uint_dom,$remotesessions,
829: $try_server));
830: }
831: ($spare_server, $lowest_load) =
832: &compare_server_load($try_server, $spare_server, $lowest_load);
833: }
834: }
835:
836: my $found_server = ($spare_server ne '' && $lowest_load < 100);
837:
838: if (!$found_server) {
839: if (ref($spareshash->{'default'}) eq 'ARRAY') {
840: foreach my $try_server (@{ $spareshash->{'default'} }) {
841: if ($uint_dom) {
842: next unless (&spare_can_host($udom,$uint_dom,
843: $remotesessions,$try_server));
844: }
845: ($spare_server, $lowest_load) =
846: &compare_server_load($try_server, $spare_server, $lowest_load);
847: }
848: }
849: }
850: }
851:
852: if (!$want_server_name) {
853: my $protocol = 'http';
854: if ($protocol{$spare_server} eq 'https') {
855: $protocol = $protocol{$spare_server};
856: }
857: if (defined($spare_server)) {
858: my $hostname = &hostname($spare_server);
859: if (defined($hostname)) {
860: $spare_server = $protocol.'://'.$hostname;
861: }
862: }
863: }
864: return $spare_server;
865: }
866:
867: sub compare_server_load {
868: my ($try_server, $spare_server, $lowest_load) = @_;
869:
870: my $loadans = &reply('load', $try_server);
871: my $userloadans = &reply('userload',$try_server);
872:
873: if ($loadans !~ /\d/ && $userloadans !~ /\d/) {
874: return ($spare_server, $lowest_load); #didn't get a number from the server
875: }
876:
877: my $load;
878: if ($loadans =~ /\d/) {
879: if ($userloadans =~ /\d/) {
880: #both are numbers, pick the bigger one
881: $load = ($loadans > $userloadans) ? $loadans
882: : $userloadans;
883: } else {
884: $load = $loadans;
885: }
886: } else {
887: $load = $userloadans;
888: }
889:
890: if (($load =~ /\d/) && ($load < $lowest_load)) {
891: $spare_server = $try_server;
892: $lowest_load = $load;
893: }
894: return ($spare_server,$lowest_load);
895: }
896:
897: # --------------------------- ask offload servers if user already has a session
898: sub find_existing_session {
899: my ($udom,$uname) = @_;
900: my $spareshash = &this_host_spares($udom);
901: if (ref($spareshash) eq 'HASH') {
902: if (ref($spareshash->{'primary'}) eq 'ARRAY') {
903: foreach my $try_server (@{ $spareshash->{'primary'} }) {
904: return $try_server if (&has_user_session($try_server, $udom, $uname));
905: }
906: }
907: if (ref($spareshash->{'default'}) eq 'ARRAY') {
908: foreach my $try_server (@{ $spareshash->{'default'} }) {
909: return $try_server if (&has_user_session($try_server, $udom, $uname));
910: }
911: }
912: }
913: return;
914: }
915:
916: # -------------------------------- ask if server already has a session for user
917: sub has_user_session {
918: my ($lonid,$udom,$uname) = @_;
919: my $result = &reply(join(':','userhassession',
920: map {&escape($_)} ($udom,$uname)),$lonid);
921: return 1 if ($result eq 'ok');
922:
923: return 0;
924: }
925:
926: # --------- determine least loaded server in a user's domain which allows login
927:
928: sub choose_server {
929: my ($udom,$checkloginvia) = @_;
930: my %domconfhash = &Apache::loncommon::get_domainconf($udom);
931: my %servers = &get_servers($udom);
932: my $lowest_load = 30000;
933: my ($login_host,$hostname,$portal_path,$isredirect);
934: foreach my $lonhost (keys(%servers)) {
935: my $loginvia;
936: if ($checkloginvia) {
937: $loginvia = $domconfhash{$udom.'.login.loginvia_'.$lonhost};
938: if ($loginvia) {
939: my ($server,$path) = split(/:/,$loginvia);
940: ($login_host, $lowest_load) =
941: &compare_server_load($server, $login_host, $lowest_load);
942: if ($login_host eq $server) {
943: $portal_path = $path;
944: $isredirect = 1;
945: }
946: } else {
947: ($login_host, $lowest_load) =
948: &compare_server_load($lonhost, $login_host, $lowest_load);
949: if ($login_host eq $lonhost) {
950: $portal_path = '';
951: $isredirect = '';
952: }
953: }
954: } else {
955: ($login_host, $lowest_load) =
956: &compare_server_load($lonhost, $login_host, $lowest_load);
957: }
958: }
959: if ($login_host ne '') {
960: $hostname = &hostname($login_host);
961: }
962: return ($login_host,$hostname,$portal_path,$isredirect);
963: }
964:
965: # --------------------------------------------- Try to change a user's password
966:
967: sub changepass {
968: my ($uname,$udom,$currentpass,$newpass,$server,$context)=@_;
969: $currentpass = &escape($currentpass);
970: $newpass = &escape($newpass);
971: my $lonhost = $perlvar{'lonHostID'};
972: my $answer = reply("encrypt:passwd:$udom:$uname:$currentpass:$newpass:$context:$lonhost",
973: $server);
974: if (! $answer) {
975: &logthis("No reply on password change request to $server ".
976: "by $uname in domain $udom.");
977: } elsif ($answer =~ "^ok") {
978: &logthis("$uname in $udom successfully changed their password ".
979: "on $server.");
980: } elsif ($answer =~ "^pwchange_failure") {
981: &logthis("$uname in $udom was unable to change their password ".
982: "on $server. The action was blocked by either lcpasswd ".
983: "or pwchange");
984: } elsif ($answer =~ "^non_authorized") {
985: &logthis("$uname in $udom did not get their password correct when ".
986: "attempting to change it on $server.");
987: } elsif ($answer =~ "^auth_mode_error") {
988: &logthis("$uname in $udom attempted to change their password despite ".
989: "not being locally or internally authenticated on $server.");
990: } elsif ($answer =~ "^unknown_user") {
991: &logthis("$uname in $udom attempted to change their password ".
992: "on $server but were unable to because $server is not ".
993: "their home server.");
994: } elsif ($answer =~ "^refused") {
995: &logthis("$server refused to change $uname in $udom password because ".
996: "it was sent an unencrypted request to change the password.");
997: } elsif ($answer =~ "invalid_client") {
998: &logthis("$server refused to change $uname in $udom password because ".
999: "it was a reset by e-mail originating from an invalid server.");
1000: }
1001: return $answer;
1002: }
1003:
1004: # ----------------------- Try to determine user's current authentication scheme
1005:
1006: sub queryauthenticate {
1007: my ($uname,$udom)=@_;
1008: my $uhome=&homeserver($uname,$udom);
1009: if (!$uhome) {
1010: &logthis("User $uname at $udom is unknown when looking for authentication mechanism");
1011: return 'no_host';
1012: }
1013: my $answer=reply("encrypt:currentauth:$udom:$uname",$uhome);
1014: if ($answer =~ /^(unknown_user|refused|con_lost)/) {
1015: &logthis("User $uname at $udom threw error $answer when checking authentication mechanism");
1016: }
1017: return $answer;
1018: }
1019:
1020: # --------- Try to authenticate user from domain's lib servers (first this one)
1021:
1022: sub authenticate {
1023: my ($uname,$upass,$udom,$checkdefauth,$clientcancheckhost)=@_;
1024: $upass=&escape($upass);
1025: $uname= &LONCAPA::clean_username($uname);
1026: my $uhome=&homeserver($uname,$udom,1);
1027: my $newhome;
1028: if ((!$uhome) || ($uhome eq 'no_host')) {
1029: # Maybe the machine was offline and only re-appeared again recently?
1030: &reconlonc();
1031: # One more
1032: $uhome=&homeserver($uname,$udom,1);
1033: if (($uhome eq 'no_host') && $checkdefauth) {
1034: if (defined(&domain($udom,'primary'))) {
1035: $newhome=&domain($udom,'primary');
1036: }
1037: if ($newhome ne '') {
1038: $uhome = $newhome;
1039: }
1040: }
1041: if ((!$uhome) || ($uhome eq 'no_host')) {
1042: &logthis("User $uname at $udom is unknown in authenticate");
1043: return 'no_host';
1044: }
1045: }
1046: my $answer=reply("encrypt:auth:$udom:$uname:$upass:$checkdefauth:$clientcancheckhost",$uhome);
1047: if ($answer eq 'authorized') {
1048: if ($newhome) {
1049: &logthis("User $uname at $udom authorized by $uhome, but needs account");
1050: return 'no_account_on_host';
1051: } else {
1052: &logthis("User $uname at $udom authorized by $uhome");
1053: return $uhome;
1054: }
1055: }
1056: if ($answer eq 'non_authorized') {
1057: &logthis("User $uname at $udom rejected by $uhome");
1058: return 'no_host';
1059: }
1060: &logthis("User $uname at $udom threw error $answer when checking authentication mechanism");
1061: return 'no_host';
1062: }
1063:
1064: sub can_host_session {
1065: my ($udom,$lonhost,$remoterev,$remotesessions,$hostedsessions) = @_;
1066: my $canhost = 1;
1067: my $host_idn = &Apache::lonnet::internet_dom($lonhost);
1068: if (ref($remotesessions) eq 'HASH') {
1069: if (ref($remotesessions->{'excludedomain'}) eq 'ARRAY') {
1070: if (grep(/^\Q$host_idn\E$/,@{$remotesessions->{'excludedomain'}})) {
1071: $canhost = 0;
1072: } else {
1073: $canhost = 1;
1074: }
1075: }
1076: if (ref($remotesessions->{'includedomain'}) eq 'ARRAY') {
1077: if (grep(/^\Q$host_idn\E$/,@{$remotesessions->{'includedomain'}})) {
1078: $canhost = 1;
1079: } else {
1080: $canhost = 0;
1081: }
1082: }
1083: if ($canhost) {
1084: if ($remotesessions->{'version'} ne '') {
1085: my ($reqmajor,$reqminor) = ($remotesessions->{'version'} =~ /^(\d+)\.(\d+)$/);
1086: if ($reqmajor ne '' && $reqminor ne '') {
1087: if ($remoterev =~ /^\'?(\d+)\.(\d+)/) {
1088: my $major = $1;
1089: my $minor = $2;
1090: if (($major < $reqmajor ) ||
1091: (($major == $reqmajor) && ($minor < $reqminor))) {
1092: $canhost = 0;
1093: }
1094: } else {
1095: $canhost = 0;
1096: }
1097: }
1098: }
1099: }
1100: }
1101: if ($canhost) {
1102: if (ref($hostedsessions) eq 'HASH') {
1103: my $uprimary_id = &Apache::lonnet::domain($udom,'primary');
1104: my $uint_dom = &Apache::lonnet::internet_dom($uprimary_id);
1105: if (ref($hostedsessions->{'excludedomain'}) eq 'ARRAY') {
1106: if (($uint_dom ne '') &&
1107: (grep(/^\Q$uint_dom\E$/,@{$hostedsessions->{'excludedomain'}}))) {
1108: $canhost = 0;
1109: } else {
1110: $canhost = 1;
1111: }
1112: }
1113: if (ref($hostedsessions->{'includedomain'}) eq 'ARRAY') {
1114: if (($uint_dom ne '') &&
1115: (grep(/^\Q$uint_dom\E$/,@{$hostedsessions->{'includedomain'}}))) {
1116: $canhost = 1;
1117: } else {
1118: $canhost = 0;
1119: }
1120: }
1121: }
1122: }
1123: return $canhost;
1124: }
1125:
1126: sub spare_can_host {
1127: my ($udom,$uint_dom,$remotesessions,$try_server)=@_;
1128: my $canhost=1;
1129: my @intdoms;
1130: my $internet_names = &Apache::lonnet::get_internet_names($try_server);
1131: if (ref($internet_names) eq 'ARRAY') {
1132: @intdoms = @{$internet_names};
1133: }
1134: unless (grep(/^\Q$uint_dom\E$/,@intdoms)) {
1135: my $serverhomeID = &Apache::lonnet::get_server_homeID($try_server);
1136: my $serverhomedom = &Apache::lonnet::host_domain($serverhomeID);
1137: my %defdomdefaults = &Apache::lonnet::get_domain_defaults($serverhomedom);
1138: my $remoterev = &Apache::lonnet::get_server_loncaparev(undef,$try_server);
1139: $canhost = &can_host_session($udom,$try_server,$remoterev,
1140: $remotesessions,
1141: $defdomdefaults{'hostedsessions'});
1142: }
1143: return $canhost;
1144: }
1145:
1146: sub this_host_spares {
1147: my ($dom) = @_;
1148: my ($dom_in_use,$lonhost_in_use,$result);
1149: my @hosts = ¤t_machine_ids();
1150: foreach my $lonhost (@hosts) {
1151: if (&host_domain($lonhost) eq $dom) {
1152: $dom_in_use = $dom;
1153: $lonhost_in_use = $lonhost;
1154: last;
1155: }
1156: }
1157: if ($dom_in_use ne '') {
1158: $result = &spares_for_offload($dom_in_use,$lonhost_in_use);
1159: }
1160: if (ref($result) ne 'HASH') {
1161: $lonhost_in_use = $perlvar{'lonHostID'};
1162: $dom_in_use = &host_domain($lonhost_in_use);
1163: $result = &spares_for_offload($dom_in_use,$lonhost_in_use);
1164: if (ref($result) ne 'HASH') {
1165: $result = \%spareid;
1166: }
1167: }
1168: return $result;
1169: }
1170:
1171: sub spares_for_offload {
1172: my ($dom_in_use,$lonhost_in_use) = @_;
1173: my ($result,$cached)=&is_cached_new('spares',$dom_in_use);
1174: if (defined($cached)) {
1175: return $result;
1176: } else {
1177: my $cachetime = 60*60*24;
1178: my %domconfig =
1179: &Apache::lonnet::get_dom('configuration',['usersessions'],$dom_in_use);
1180: if (ref($domconfig{'usersessions'}) eq 'HASH') {
1181: if (ref($domconfig{'usersessions'}{'spares'}) eq 'HASH') {
1182: if (ref($domconfig{'usersessions'}{'spares'}{$lonhost_in_use}) eq 'HASH') {
1183: return &do_cache_new('spares',$dom_in_use,$domconfig{'usersessions'}{'spares'}{$lonhost_in_use},$cachetime);
1184: }
1185: }
1186: }
1187: }
1188: return;
1189: }
1190:
1191: sub get_lonbalancer_config {
1192: my ($servers) = @_;
1193: my ($currbalancer,$currtargets);
1194: if (ref($servers) eq 'HASH') {
1195: foreach my $server (keys(%{$servers})) {
1196: my %what = (
1197: spareid => 1,
1198: perlvar => 1,
1199: );
1200: my ($result,$returnhash) = &get_remote_globals($server,\%what);
1201: if ($result eq 'ok') {
1202: if (ref($returnhash) eq 'HASH') {
1203: if (ref($returnhash->{'perlvar'}) eq 'HASH') {
1204: if ($returnhash->{'perlvar'}->{'lonBalancer'} eq 'yes') {
1205: $currbalancer = $server;
1206: $currtargets = {};
1207: if (ref($returnhash->{'spareid'}) eq 'HASH') {
1208: if (ref($returnhash->{'spareid'}->{'primary'}) eq 'ARRAY') {
1209: $currtargets->{'primary'} = $returnhash->{'spareid'}->{'primary'};
1210: }
1211: if (ref($returnhash->{'spareid'}->{'default'}) eq 'ARRAY') {
1212: $currtargets->{'default'} = $returnhash->{'spareid'}->{'default'};
1213: }
1214: }
1215: last;
1216: }
1217: }
1218: }
1219: }
1220: }
1221: }
1222: return ($currbalancer,$currtargets);
1223: }
1224:
1225: sub check_loadbalancing {
1226: my ($uname,$udom) = @_;
1227: my ($is_balancer,$dom_in_use,$homeintdom,$rule_in_effect,
1228: $offloadto,$otherserver);
1229: my $lonhost = $perlvar{'lonHostID'};
1230: my $uprimary_id = &Apache::lonnet::domain($udom,'primary');
1231: my $uintdom = &Apache::lonnet::internet_dom($uprimary_id);
1232: my $intdom = &Apache::lonnet::internet_dom($lonhost);
1233: my $serverhomedom = &host_domain($lonhost);
1234:
1235: my $cachetime = 60*60*24;
1236:
1237: if (($uintdom ne '') && ($uintdom eq $intdom)) {
1238: $dom_in_use = $udom;
1239: $homeintdom = 1;
1240: } else {
1241: $dom_in_use = $serverhomedom;
1242: }
1243: my ($result,$cached)=&is_cached_new('loadbalancing',$dom_in_use);
1244: unless (defined($cached)) {
1245: my %domconfig =
1246: &Apache::lonnet::get_dom('configuration',['loadbalancing'],$dom_in_use);
1247: if (ref($domconfig{'loadbalancing'}) eq 'HASH') {
1248: $result = &do_cache_new('loadbalancing',$dom_in_use,$domconfig{'loadbalancing'},$cachetime);
1249: }
1250: }
1251: if (ref($result) eq 'HASH') {
1252: my $currbalancer = $result->{'lonhost'};
1253: my $currtargets = $result->{'targets'};
1254: my $currrules = $result->{'rules'};
1255: if ($currbalancer ne '') {
1256: my @hosts = ¤t_machine_ids();
1257: if (grep(/^\Q$currbalancer\E$/,@hosts)) {
1258: $is_balancer = 1;
1259: }
1260: }
1261: if ($is_balancer) {
1262: if (ref($currrules) eq 'HASH') {
1263: if ($homeintdom) {
1264: if ($uname ne '') {
1265: if (($currrules->{'_LC_adv'} ne '') || ($currrules->{'_LC_author'} ne '')) {
1266: my ($is_adv,$is_author) = &is_advanced_user($udom,$uname);
1267: if (($currrules->{'_LC_author'} ne '') && ($is_author)) {
1268: $rule_in_effect = $currrules->{'_LC_author'};
1269: } elsif (($currrules->{'_LC_adv'} ne '') && ($is_adv)) {
1270: $rule_in_effect = $currrules->{'_LC_adv'}
1271: }
1272: }
1273: if ($rule_in_effect eq '') {
1274: my %userenv = &userenvironment($udom,$uname,'inststatus');
1275: if ($userenv{'inststatus'} ne '') {
1276: my @statuses = map { &unescape($_); } split(/:/,$userenv{'inststatus'});
1277: my ($othertitle,$usertypes,$types) =
1278: &Apache::loncommon::sorted_inst_types($udom);
1279: if (ref($types) eq 'ARRAY') {
1280: foreach my $type (@{$types}) {
1281: if (grep(/^\Q$type\E$/,@statuses)) {
1282: if (exists($currrules->{$type})) {
1283: $rule_in_effect = $currrules->{$type};
1284: }
1285: }
1286: }
1287: }
1288: } else {
1289: if (exists($currrules->{'default'})) {
1290: $rule_in_effect = $currrules->{'default'};
1291: }
1292: }
1293: }
1294: } else {
1295: if (exists($currrules->{'default'})) {
1296: $rule_in_effect = $currrules->{'default'};
1297: }
1298: }
1299: } else {
1300: if ($currrules->{'_LC_external'} ne '') {
1301: $rule_in_effect = $currrules->{'_LC_external'};
1302: }
1303: }
1304: $offloadto = &get_loadbalancer_targets($rule_in_effect,$currtargets,
1305: $uname,$udom);
1306: }
1307: }
1308: } elsif (($homeintdom) && ($udom ne $serverhomedom)) {
1309: my ($result,$cached)=&is_cached_new('loadbalancing',$serverhomedom);
1310: unless (defined($cached)) {
1311: my %domconfig =
1312: &Apache::lonnet::get_dom('configuration',['loadbalancing'],$serverhomedom);
1313: if (ref($domconfig{'loadbalancing'}) eq 'HASH') {
1314: $result = &do_cache_new('loadbalancing',$dom_in_use,$domconfig{'loadbalancing'},$cachetime);
1315: }
1316: }
1317: if (ref($result) eq 'HASH') {
1318: my $currbalancer = $result->{'lonhost'};
1319: my $currtargets = $result->{'targets'};
1320: my $currrules = $result->{'rules'};
1321:
1322: if ($currbalancer eq $lonhost) {
1323: $is_balancer = 1;
1324: if (ref($currrules) eq 'HASH') {
1325: if ($currrules->{'_LC_internetdom'} ne '') {
1326: $rule_in_effect = $currrules->{'_LC_internetdom'};
1327: }
1328: }
1329: $offloadto = &get_loadbalancer_targets($rule_in_effect,$currtargets,
1330: $uname,$udom);
1331: }
1332: } else {
1333: if ($perlvar{'lonBalancer'} eq 'yes') {
1334: $is_balancer = 1;
1335: $offloadto = &this_host_spares($dom_in_use);
1336: }
1337: }
1338: } else {
1339: if ($perlvar{'lonBalancer'} eq 'yes') {
1340: $is_balancer = 1;
1341: $offloadto = &this_host_spares($dom_in_use);
1342: }
1343: }
1344: my $lowest_load = 30000;
1345: if (ref($offloadto) eq 'HASH') {
1346: if (ref($offloadto->{'primary'}) eq 'ARRAY') {
1347: foreach my $try_server (@{$offloadto->{'primary'}}) {
1348: ($otherserver,$lowest_load) =
1349: &compare_server_load($try_server,$otherserver,$lowest_load);
1350: }
1351: }
1352: my $found_server = ($otherserver ne '' && $lowest_load < 100);
1353:
1354: if (!$found_server) {
1355: if (ref($offloadto->{'default'}) eq 'ARRAY') {
1356: foreach my $try_server (@{$offloadto->{'default'}}) {
1357: ($otherserver,$lowest_load) =
1358: &compare_server_load($try_server,$otherserver,$lowest_load);
1359: }
1360: }
1361: }
1362: } elsif (ref($offloadto) eq 'ARRAY') {
1363: if (@{$offloadto} == 1) {
1364: $otherserver = $offloadto->[0];
1365: } elsif (@{$offloadto} > 1) {
1366: foreach my $try_server (@{$offloadto}) {
1367: ($otherserver,$lowest_load) =
1368: &compare_server_load($try_server,$otherserver,$lowest_load);
1369: }
1370: }
1371: }
1372: return ($is_balancer,$otherserver);
1373: }
1374:
1375: sub get_loadbalancer_targets {
1376: my ($rule_in_effect,$currtargets,$uname,$udom) = @_;
1377: my $offloadto;
1378: if ($rule_in_effect eq '') {
1379: $offloadto = $currtargets;
1380: } else {
1381: if ($rule_in_effect eq 'homeserver') {
1382: my $homeserver = &homeserver($uname,$udom);
1383: if ($homeserver ne 'no_host') {
1384: $offloadto = [$homeserver];
1385: }
1386: } elsif ($rule_in_effect eq 'externalbalancer') {
1387: my %domconfig =
1388: &Apache::lonnet::get_dom('configuration',['loadbalancing'],$udom);
1389: if (ref($domconfig{'loadbalancing'}) eq 'HASH') {
1390: if ($domconfig{'loadbalancing'}{'lonhost'} ne '') {
1391: if (&hostname($domconfig{'loadbalancing'}{'lonhost'}) ne '') {
1392: $offloadto = [$domconfig{'loadbalancing'}{'lonhost'}];
1393: }
1394: }
1395: } else {
1396: my %servers = &dom_servers($udom);
1397: my ($remotebalancer,$remotetargets) = &get_lonbalancer_config(\%servers);
1398: if (&hostname($remotebalancer) ne '') {
1399: $offloadto = [$remotebalancer];
1400: }
1401: }
1402: } elsif (&hostname($rule_in_effect) ne '') {
1403: $offloadto = [$rule_in_effect];
1404: }
1405: }
1406: return $offloadto;
1407: }
1408:
1409: sub internet_dom_servers {
1410: my ($dom) = @_;
1411: my (%uniqservers,%servers);
1412: my $primaryserver = &hostname(&domain($dom,'primary'));
1413: my @machinedoms = &machine_domains($primaryserver);
1414: foreach my $mdom (@machinedoms) {
1415: my %currservers = %servers;
1416: my %server = &get_servers($mdom);
1417: %servers = (%currservers,%server);
1418: }
1419: my %by_hostname;
1420: foreach my $id (keys(%servers)) {
1421: push(@{$by_hostname{$servers{$id}}},$id);
1422: }
1423: foreach my $hostname (sort(keys(%by_hostname))) {
1424: if (@{$by_hostname{$hostname}} > 1) {
1425: my $match = 0;
1426: foreach my $id (@{$by_hostname{$hostname}}) {
1427: if (&host_domain($id) eq $dom) {
1428: $uniqservers{$id} = $hostname;
1429: $match = 1;
1430: }
1431: }
1432: unless ($match) {
1433: $uniqservers{$by_hostname{$hostname}[0]} = $hostname;
1434: }
1435: } else {
1436: $uniqservers{$by_hostname{$hostname}[0]} = $hostname;
1437: }
1438: }
1439: return %uniqservers;
1440: }
1441:
1442: # ---------------------- Find the homebase for a user from domain's lib servers
1443:
1444: my %homecache;
1445: sub homeserver {
1446: my ($uname,$udom,$ignoreBadCache)=@_;
1447: my $index="$uname:$udom";
1448:
1449: if (exists($homecache{$index})) { return $homecache{$index}; }
1450:
1451: my %servers = &get_servers($udom,'library');
1452: foreach my $tryserver (keys(%servers)) {
1453: next if ($ignoreBadCache ne 'true' &&
1454: exists($badServerCache{$tryserver}));
1455:
1456: my $answer=reply("home:$udom:$uname",$tryserver);
1457: if ($answer eq 'found') {
1458: delete($badServerCache{$tryserver});
1459: return $homecache{$index}=$tryserver;
1460: } elsif ($answer eq 'no_host') {
1461: $badServerCache{$tryserver}=1;
1462: }
1463: }
1464: return 'no_host';
1465: }
1466:
1467: # ------------------------------------- Find the usernames behind a list of IDs
1468:
1469: sub idget {
1470: my ($udom,@ids)=@_;
1471: my %returnhash=();
1472:
1473: my %servers = &get_servers($udom,'library');
1474: foreach my $tryserver (keys(%servers)) {
1475: my $idlist=join('&',@ids);
1476: $idlist=~tr/A-Z/a-z/;
1477: my $reply=&reply("idget:$udom:".$idlist,$tryserver);
1478: my @answer=();
1479: if (($reply ne 'con_lost') && ($reply!~/^error\:/)) {
1480: @answer=split(/\&/,$reply);
1481: } ;
1482: my $i;
1483: for ($i=0;$i<=$#ids;$i++) {
1484: if ($answer[$i]) {
1485: $returnhash{$ids[$i]}=$answer[$i];
1486: }
1487: }
1488: }
1489: return %returnhash;
1490: }
1491:
1492: # ------------------------------------- Find the IDs behind a list of usernames
1493:
1494: sub idrget {
1495: my ($udom,@unames)=@_;
1496: my %returnhash=();
1497: foreach my $uname (@unames) {
1498: $returnhash{$uname}=(&userenvironment($udom,$uname,'id'))[1];
1499: }
1500: return %returnhash;
1501: }
1502:
1503: # ------------------------------- Store away a list of names and associated IDs
1504:
1505: sub idput {
1506: my ($udom,%ids)=@_;
1507: my %servers=();
1508: foreach my $uname (keys(%ids)) {
1509: &cput('environment',{'id'=>$ids{$uname}},$udom,$uname);
1510: my $uhom=&homeserver($uname,$udom);
1511: if ($uhom ne 'no_host') {
1512: my $id=&escape($ids{$uname});
1513: $id=~tr/A-Z/a-z/;
1514: my $esc_unam=&escape($uname);
1515: if ($servers{$uhom}) {
1516: $servers{$uhom}.='&'.$id.'='.$esc_unam;
1517: } else {
1518: $servers{$uhom}=$id.'='.$esc_unam;
1519: }
1520: }
1521: }
1522: foreach my $server (keys(%servers)) {
1523: &critical('idput:'.$udom.':'.$servers{$server},$server);
1524: }
1525: }
1526:
1527: # ------------------------------dump from db file owned by domainconfig user
1528: sub dump_dom {
1529: my ($namespace,$udom,$regexp,$range)=@_;
1530: if (!$udom) {
1531: $udom=$env{'user.domain'};
1532: }
1533: my %returnhash;
1534: if ($udom) {
1535: my $uname = &get_domainconfiguser($udom);
1536: %returnhash = &dump($namespace,$udom,$uname,$regexp,$range);
1537: }
1538: return %returnhash;
1539: }
1540:
1541: # ------------------------------------------ get items from domain db files
1542:
1543: sub get_dom {
1544: my ($namespace,$storearr,$udom,$uhome)=@_;
1545: my $items='';
1546: foreach my $item (@$storearr) {
1547: $items.=&escape($item).'&';
1548: }
1549: $items=~s/\&$//;
1550: if (!$udom) {
1551: $udom=$env{'user.domain'};
1552: if (defined(&domain($udom,'primary'))) {
1553: $uhome=&domain($udom,'primary');
1554: } else {
1555: undef($uhome);
1556: }
1557: } else {
1558: if (!$uhome) {
1559: if (defined(&domain($udom,'primary'))) {
1560: $uhome=&domain($udom,'primary');
1561: }
1562: }
1563: }
1564: if ($udom && $uhome && ($uhome ne 'no_host')) {
1565: my $rep=&reply("getdom:$udom:$namespace:$items",$uhome);
1566: my %returnhash;
1567: if ($rep eq '' || $rep =~ /^error: 2 /) {
1568: return %returnhash;
1569: }
1570: my @pairs=split(/\&/,$rep);
1571: if ( $#pairs==0 && $pairs[0] =~ /^(con_lost|error|no_such_host)/i) {
1572: return @pairs;
1573: }
1574: my $i=0;
1575: foreach my $item (@$storearr) {
1576: $returnhash{$item}=&thaw_unescape($pairs[$i]);
1577: $i++;
1578: }
1579: return %returnhash;
1580: } else {
1581: &logthis("get_dom failed - no homeserver and/or domain ($udom) ($uhome)");
1582: }
1583: }
1584:
1585: # -------------------------------------------- put items in domain db files
1586:
1587: sub put_dom {
1588: my ($namespace,$storehash,$udom,$uhome)=@_;
1589: if (!$udom) {
1590: $udom=$env{'user.domain'};
1591: if (defined(&domain($udom,'primary'))) {
1592: $uhome=&domain($udom,'primary');
1593: } else {
1594: undef($uhome);
1595: }
1596: } else {
1597: if (!$uhome) {
1598: if (defined(&domain($udom,'primary'))) {
1599: $uhome=&domain($udom,'primary');
1600: }
1601: }
1602: }
1603: if ($udom && $uhome && ($uhome ne 'no_host')) {
1604: my $items='';
1605: foreach my $item (keys(%$storehash)) {
1606: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
1607: }
1608: $items=~s/\&$//;
1609: return &reply("putdom:$udom:$namespace:$items",$uhome);
1610: } else {
1611: &logthis("put_dom failed - no homeserver and/or domain");
1612: }
1613: }
1614:
1615: # --------------------- newput for items in db file owned by domainconfig user
1616: sub newput_dom {
1617: my ($namespace,$storehash,$udom) = @_;
1618: my $result;
1619: if (!$udom) {
1620: $udom=$env{'user.domain'};
1621: }
1622: if ($udom) {
1623: my $uname = &get_domainconfiguser($udom);
1624: $result = &newput($namespace,$storehash,$udom,$uname);
1625: }
1626: return $result;
1627: }
1628:
1629: # --------------------- delete for items in db file owned by domainconfig user
1630: sub del_dom {
1631: my ($namespace,$storearr,$udom)=@_;
1632: if (ref($storearr) eq 'ARRAY') {
1633: if (!$udom) {
1634: $udom=$env{'user.domain'};
1635: }
1636: if ($udom) {
1637: my $uname = &get_domainconfiguser($udom);
1638: return &del($namespace,$storearr,$udom,$uname);
1639: }
1640: }
1641: }
1642:
1643: # ----------------------------------construct domainconfig user for a domain
1644: sub get_domainconfiguser {
1645: my ($udom) = @_;
1646: return $udom.'-domainconfig';
1647: }
1648:
1649: sub retrieve_inst_usertypes {
1650: my ($udom) = @_;
1651: my (%returnhash,@order);
1652: my %domdefs = &Apache::lonnet::get_domain_defaults($udom);
1653: if ((ref($domdefs{'inststatustypes'}) eq 'HASH') &&
1654: (ref($domdefs{'inststatusorder'}) eq 'ARRAY')) {
1655: %returnhash = %{$domdefs{'inststatustypes'}};
1656: @order = @{$domdefs{'inststatusorder'}};
1657: } else {
1658: if (defined(&domain($udom,'primary'))) {
1659: my $uhome=&domain($udom,'primary');
1660: my $rep=&reply("inst_usertypes:$udom",$uhome);
1661: if ($rep =~ /^(con_lost|error|no_such_host|refused)/) {
1662: &logthis("get_dom failed - $rep returned from $uhome in domain: $udom");
1663: return (\%returnhash,\@order);
1664: }
1665: my ($hashitems,$orderitems) = split(/:/,$rep);
1666: my @pairs=split(/\&/,$hashitems);
1667: foreach my $item (@pairs) {
1668: my ($key,$value)=split(/=/,$item,2);
1669: $key = &unescape($key);
1670: next if ($key =~ /^error: 2 /);
1671: $returnhash{$key}=&thaw_unescape($value);
1672: }
1673: my @esc_order = split(/\&/,$orderitems);
1674: foreach my $item (@esc_order) {
1675: push(@order,&unescape($item));
1676: }
1677: } else {
1678: &logthis("get_dom failed - no primary domain server for $udom");
1679: }
1680: }
1681: return (\%returnhash,\@order);
1682: }
1683:
1684: sub is_domainimage {
1685: my ($url) = @_;
1686: if ($url=~m-^/+res/+($match_domain)/+\1\-domainconfig/+(img|logo|domlogo)/+-) {
1687: if (&domain($1) ne '') {
1688: return '1';
1689: }
1690: }
1691: return;
1692: }
1693:
1694: sub inst_directory_query {
1695: my ($srch) = @_;
1696: my $udom = $srch->{'srchdomain'};
1697: my %results;
1698: my $homeserver = &domain($udom,'primary');
1699: my $outcome;
1700: if ($homeserver ne '') {
1701: my $queryid=&reply("querysend:instdirsearch:".
1702: &escape($srch->{'srchby'}).':'.
1703: &escape($srch->{'srchterm'}).':'.
1704: &escape($srch->{'srchtype'}),$homeserver);
1705: my $host=&hostname($homeserver);
1706: if ($queryid !~/^\Q$host\E\_/) {
1707: &logthis('instituional directory search invalid queryid: '.$queryid.' for host: '.$homeserver.'in domain '.$udom);
1708: return;
1709: }
1710: my $response = &get_query_reply($queryid);
1711: my $maxtries = 5;
1712: my $tries = 1;
1713: while (($response=~/^timeout/) && ($tries < $maxtries)) {
1714: $response = &get_query_reply($queryid);
1715: $tries ++;
1716: }
1717:
1718: if (!&error($response) && $response ne 'refused') {
1719: if ($response eq 'unavailable') {
1720: $outcome = $response;
1721: } else {
1722: $outcome = 'ok';
1723: my @matches = split(/\n/,$response);
1724: foreach my $match (@matches) {
1725: my ($key,$value) = split(/=/,$match);
1726: $results{&unescape($key).':'.$udom} = &thaw_unescape($value);
1727: }
1728: }
1729: }
1730: }
1731: return ($outcome,%results);
1732: }
1733:
1734: sub usersearch {
1735: my ($srch) = @_;
1736: my $dom = $srch->{'srchdomain'};
1737: my %results;
1738: my %libserv = &all_library();
1739: my $query = 'usersearch';
1740: foreach my $tryserver (keys(%libserv)) {
1741: if (&host_domain($tryserver) eq $dom) {
1742: my $host=&hostname($tryserver);
1743: my $queryid=
1744: &reply("querysend:".&escape($query).':'.
1745: &escape($srch->{'srchby'}).':'.
1746: &escape($srch->{'srchtype'}).':'.
1747: &escape($srch->{'srchterm'}),$tryserver);
1748: if ($queryid !~/^\Q$host\E\_/) {
1749: &logthis('usersearch: invalid queryid: '.$queryid.' for host: '.$host.'in domain '.$dom.' and server: '.$tryserver);
1750: next;
1751: }
1752: my $reply = &get_query_reply($queryid);
1753: my $maxtries = 1;
1754: my $tries = 1;
1755: while (($reply=~/^timeout/) && ($tries < $maxtries)) {
1756: $reply = &get_query_reply($queryid);
1757: $tries ++;
1758: }
1759: if ( ($reply =~/^timeout/) || ($reply =~/^error/) ) {
1760: &logthis('usersrch error: '.$reply.' for '.$dom.' - searching for : '.$srch->{'srchterm'}.' by '.$srch->{'srchby'}.' ('.$srch->{'srchtype'}.') - maxtries: '.$maxtries.' tries: '.$tries);
1761: } else {
1762: my @matches;
1763: if ($reply =~ /\n/) {
1764: @matches = split(/\n/,$reply);
1765: } else {
1766: @matches = split(/\&/,$reply);
1767: }
1768: foreach my $match (@matches) {
1769: my ($uname,$udom,%userhash);
1770: foreach my $entry (split(/:/,$match)) {
1771: my ($key,$value) =
1772: map {&unescape($_);} split(/=/,$entry);
1773: $userhash{$key} = $value;
1774: if ($key eq 'username') {
1775: $uname = $value;
1776: } elsif ($key eq 'domain') {
1777: $udom = $value;
1778: }
1779: }
1780: $results{$uname.':'.$udom} = \%userhash;
1781: }
1782: }
1783: }
1784: }
1785: return %results;
1786: }
1787:
1788: sub get_instuser {
1789: my ($udom,$uname,$id) = @_;
1790: my $homeserver = &domain($udom,'primary');
1791: my ($outcome,%results);
1792: if ($homeserver ne '') {
1793: my $queryid=&reply("querysend:getinstuser:".&escape($uname).':'.
1794: &escape($id).':'.&escape($udom),$homeserver);
1795: my $host=&hostname($homeserver);
1796: if ($queryid !~/^\Q$host\E\_/) {
1797: &logthis('get_instuser invalid queryid: '.$queryid.' for host: '.$homeserver.'in domain '.$udom);
1798: return;
1799: }
1800: my $response = &get_query_reply($queryid);
1801: my $maxtries = 5;
1802: my $tries = 1;
1803: while (($response=~/^timeout/) && ($tries < $maxtries)) {
1804: $response = &get_query_reply($queryid);
1805: $tries ++;
1806: }
1807: if (!&error($response) && $response ne 'refused') {
1808: if ($response eq 'unavailable') {
1809: $outcome = $response;
1810: } else {
1811: $outcome = 'ok';
1812: my @matches = split(/\n/,$response);
1813: foreach my $match (@matches) {
1814: my ($key,$value) = split(/=/,$match);
1815: $results{&unescape($key)} = &thaw_unescape($value);
1816: }
1817: }
1818: }
1819: }
1820: my %userinfo;
1821: if (ref($results{$uname}) eq 'HASH') {
1822: %userinfo = %{$results{$uname}};
1823: }
1824: return ($outcome,%userinfo);
1825: }
1826:
1827: sub inst_rulecheck {
1828: my ($udom,$uname,$id,$item,$rules) = @_;
1829: my %returnhash;
1830: if ($udom ne '') {
1831: if (ref($rules) eq 'ARRAY') {
1832: @{$rules} = map {&escape($_);} (@{$rules});
1833: my $rulestr = join(':',@{$rules});
1834: my $homeserver=&domain($udom,'primary');
1835: if (($homeserver ne '') && ($homeserver ne 'no_host')) {
1836: my $response;
1837: if ($item eq 'username') {
1838: $response=&unescape(&reply('instrulecheck:'.&escape($udom).
1839: ':'.&escape($uname).':'.$rulestr,
1840: $homeserver));
1841: } elsif ($item eq 'id') {
1842: $response=&unescape(&reply('instidrulecheck:'.&escape($udom).
1843: ':'.&escape($id).':'.$rulestr,
1844: $homeserver));
1845: } elsif ($item eq 'selfcreate') {
1846: $response=&unescape(&reply('instselfcreatecheck:'.
1847: &escape($udom).':'.&escape($uname).
1848: ':'.$rulestr,$homeserver));
1849: }
1850: if ($response ne 'refused') {
1851: my @pairs=split(/\&/,$response);
1852: foreach my $item (@pairs) {
1853: my ($key,$value)=split(/=/,$item,2);
1854: $key = &unescape($key);
1855: next if ($key =~ /^error: 2 /);
1856: $returnhash{$key}=&thaw_unescape($value);
1857: }
1858: }
1859: }
1860: }
1861: }
1862: return %returnhash;
1863: }
1864:
1865: sub inst_userrules {
1866: my ($udom,$check) = @_;
1867: my (%ruleshash,@ruleorder);
1868: if ($udom ne '') {
1869: my $homeserver=&domain($udom,'primary');
1870: if (($homeserver ne '') && ($homeserver ne 'no_host')) {
1871: my $response;
1872: if ($check eq 'id') {
1873: $response=&reply('instidrules:'.&escape($udom),
1874: $homeserver);
1875: } elsif ($check eq 'email') {
1876: $response=&reply('instemailrules:'.&escape($udom),
1877: $homeserver);
1878: } else {
1879: $response=&reply('instuserrules:'.&escape($udom),
1880: $homeserver);
1881: }
1882: if (($response ne 'refused') && ($response ne 'error') &&
1883: ($response ne 'unknown_cmd') &&
1884: ($response ne 'no_such_host')) {
1885: my ($hashitems,$orderitems) = split(/:/,$response);
1886: my @pairs=split(/\&/,$hashitems);
1887: foreach my $item (@pairs) {
1888: my ($key,$value)=split(/=/,$item,2);
1889: $key = &unescape($key);
1890: next if ($key =~ /^error: 2 /);
1891: $ruleshash{$key}=&thaw_unescape($value);
1892: }
1893: my @esc_order = split(/\&/,$orderitems);
1894: foreach my $item (@esc_order) {
1895: push(@ruleorder,&unescape($item));
1896: }
1897: }
1898: }
1899: }
1900: return (\%ruleshash,\@ruleorder);
1901: }
1902:
1903: # ------------- Get Authentication, Language and User Tools Defaults for Domain
1904:
1905: sub get_domain_defaults {
1906: my ($domain) = @_;
1907: my $cachetime = 60*60*24;
1908: my ($result,$cached)=&is_cached_new('domdefaults',$domain);
1909: if (defined($cached)) {
1910: if (ref($result) eq 'HASH') {
1911: return %{$result};
1912: }
1913: }
1914: my %domdefaults;
1915: my %domconfig =
1916: &Apache::lonnet::get_dom('configuration',['defaults','quotas',
1917: 'requestcourses','inststatus',
1918: 'coursedefaults','usersessions'],$domain);
1919: if (ref($domconfig{'defaults'}) eq 'HASH') {
1920: $domdefaults{'lang_def'} = $domconfig{'defaults'}{'lang_def'};
1921: $domdefaults{'auth_def'} = $domconfig{'defaults'}{'auth_def'};
1922: $domdefaults{'auth_arg_def'} = $domconfig{'defaults'}{'auth_arg_def'};
1923: $domdefaults{'timezone_def'} = $domconfig{'defaults'}{'timezone_def'};
1924: $domdefaults{'datelocale_def'} = $domconfig{'defaults'}{'datelocale_def'};
1925: $domdefaults{'portal_def'} = $domconfig{'defaults'}{'portal_def'};
1926: } else {
1927: $domdefaults{'lang_def'} = &domain($domain,'lang_def');
1928: $domdefaults{'auth_def'} = &domain($domain,'auth_def');
1929: $domdefaults{'auth_arg_def'} = &domain($domain,'auth_arg_def');
1930: }
1931: if (ref($domconfig{'quotas'}) eq 'HASH') {
1932: if (ref($domconfig{'quotas'}{'defaultquota'}) eq 'HASH') {
1933: $domdefaults{'defaultquota'} = $domconfig{'quotas'}{'defaultquota'};
1934: } else {
1935: $domdefaults{'defaultquota'} = $domconfig{'quotas'};
1936: }
1937: my @usertools = ('aboutme','blog','portfolio');
1938: foreach my $item (@usertools) {
1939: if (ref($domconfig{'quotas'}{$item}) eq 'HASH') {
1940: $domdefaults{$item} = $domconfig{'quotas'}{$item};
1941: }
1942: }
1943: }
1944: if (ref($domconfig{'requestcourses'}) eq 'HASH') {
1945: foreach my $item ('official','unofficial','community') {
1946: $domdefaults{$item} = $domconfig{'requestcourses'}{$item};
1947: }
1948: }
1949: if (ref($domconfig{'inststatus'}) eq 'HASH') {
1950: foreach my $item ('inststatustypes','inststatusorder') {
1951: $domdefaults{$item} = $domconfig{'inststatus'}{$item};
1952: }
1953: }
1954: if (ref($domconfig{'coursedefaults'}) eq 'HASH') {
1955: foreach my $item ('canuse_pdfforms') {
1956: $domdefaults{$item} = $domconfig{'coursedefaults'}{$item};
1957: }
1958: }
1959: if (ref($domconfig{'usersessions'}) eq 'HASH') {
1960: if (ref($domconfig{'usersessions'}{'remote'}) eq 'HASH') {
1961: $domdefaults{'remotesessions'} = $domconfig{'usersessions'}{'remote'};
1962: }
1963: if (ref($domconfig{'usersessions'}{'hosted'}) eq 'HASH') {
1964: $domdefaults{'hostedsessions'} = $domconfig{'usersessions'}{'hosted'};
1965: }
1966: }
1967: &Apache::lonnet::do_cache_new('domdefaults',$domain,\%domdefaults,
1968: $cachetime);
1969: return %domdefaults;
1970: }
1971:
1972: # --------------------------------------------------- Assign a key to a student
1973:
1974: sub assign_access_key {
1975: #
1976: # a valid key looks like uname:udom#comments
1977: # comments are being appended
1978: #
1979: my ($ckey,$kdom,$knum,$cdom,$cnum,$udom,$uname,$logentry)=@_;
1980: $kdom=
1981: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($kdom));
1982: $knum=
1983: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($knum));
1984: $cdom=
1985: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
1986: $cnum=
1987: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
1988: $udom=$env{'user.name'} unless (defined($udom));
1989: $uname=$env{'user.domain'} unless (defined($uname));
1990: my %existing=&get('accesskeys',[$ckey],$kdom,$knum);
1991: if (($existing{$ckey}=~/^\#(.*)$/) || # - new key
1992: ($existing{$ckey}=~/^\Q$uname\E\:\Q$udom\E\#(.*)$/)) {
1993: # assigned to this person
1994: # - this should not happen,
1995: # unless something went wrong
1996: # the first time around
1997: # ready to assign
1998: $logentry=$1.'; '.$logentry;
1999: if (&put('accesskeys',{$ckey=>$uname.':'.$udom.'#'.$logentry},
2000: $kdom,$knum) eq 'ok') {
2001: # key now belongs to user
2002: my $envkey='key.'.$cdom.'_'.$cnum;
2003: if (&put('environment',{$envkey => $ckey}) eq 'ok') {
2004: &appenv({'environment.'.$envkey => $ckey});
2005: return 'ok';
2006: } else {
2007: return
2008: 'error: Count not permanently assign key, will need to be re-entered later.';
2009: }
2010: } else {
2011: return 'error: Could not assign key, try again later.';
2012: }
2013: } elsif (!$existing{$ckey}) {
2014: # the key does not exist
2015: return 'error: The key does not exist';
2016: } else {
2017: # the key is somebody else's
2018: return 'error: The key is already in use';
2019: }
2020: }
2021:
2022: # ------------------------------------------ put an additional comment on a key
2023:
2024: sub comment_access_key {
2025: #
2026: # a valid key looks like uname:udom#comments
2027: # comments are being appended
2028: #
2029: my ($ckey,$cdom,$cnum,$logentry)=@_;
2030: $cdom=
2031: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
2032: $cnum=
2033: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
2034: my %existing=&get('accesskeys',[$ckey],$cdom,$cnum);
2035: if ($existing{$ckey}) {
2036: $existing{$ckey}.='; '.$logentry;
2037: # ready to assign
2038: if (&put('accesskeys',{$ckey=>$existing{$ckey}},
2039: $cdom,$cnum) eq 'ok') {
2040: return 'ok';
2041: } else {
2042: return 'error: Count not store comment.';
2043: }
2044: } else {
2045: # the key does not exist
2046: return 'error: The key does not exist';
2047: }
2048: }
2049:
2050: # ------------------------------------------------------ Generate a set of keys
2051:
2052: sub generate_access_keys {
2053: my ($number,$cdom,$cnum,$logentry)=@_;
2054: $cdom=
2055: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
2056: $cnum=
2057: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
2058: unless (&allowed('mky',$cdom)) { return 0; }
2059: unless (($cdom) && ($cnum)) { return 0; }
2060: if ($number>10000) { return 0; }
2061: sleep(2); # make sure don't get same seed twice
2062: srand(time()^($$+($$<<15))); # from "Programming Perl"
2063: my $total=0;
2064: for (my $i=1;$i<=$number;$i++) {
2065: my $newkey=sprintf("%lx",int(100000*rand)).'-'.
2066: sprintf("%lx",int(100000*rand)).'-'.
2067: sprintf("%lx",int(100000*rand));
2068: $newkey=~s/1/g/g; # folks mix up 1 and l
2069: $newkey=~s/0/h/g; # and also 0 and O
2070: my %existing=&get('accesskeys',[$newkey],$cdom,$cnum);
2071: if ($existing{$newkey}) {
2072: $i--;
2073: } else {
2074: if (&put('accesskeys',
2075: { $newkey => '# generated '.localtime().
2076: ' by '.$env{'user.name'}.'@'.$env{'user.domain'}.
2077: '; '.$logentry },
2078: $cdom,$cnum) eq 'ok') {
2079: $total++;
2080: }
2081: }
2082: }
2083: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},
2084: 'Generated '.$total.' keys for '.$cnum.' at '.$cdom);
2085: return $total;
2086: }
2087:
2088: # ------------------------------------------------------- Validate an accesskey
2089:
2090: sub validate_access_key {
2091: my ($ckey,$cdom,$cnum,$udom,$uname)=@_;
2092: $cdom=
2093: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
2094: $cnum=
2095: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
2096: $udom=$env{'user.domain'} unless (defined($udom));
2097: $uname=$env{'user.name'} unless (defined($uname));
2098: my %existing=&get('accesskeys',[$ckey],$cdom,$cnum);
2099: return ($existing{$ckey}=~/^\Q$uname\E\:\Q$udom\E\#/);
2100: }
2101:
2102: # ------------------------------------- Find the section of student in a course
2103: sub devalidate_getsection_cache {
2104: my ($udom,$unam,$courseid)=@_;
2105: my $hashid="$udom:$unam:$courseid";
2106: &devalidate_cache_new('getsection',$hashid);
2107: }
2108:
2109: sub courseid_to_courseurl {
2110: my ($courseid) = @_;
2111: #already url style courseid
2112: return $courseid if ($courseid =~ m{^/});
2113:
2114: if (exists($env{'course.'.$courseid.'.num'})) {
2115: my $cnum = $env{'course.'.$courseid.'.num'};
2116: my $cdom = $env{'course.'.$courseid.'.domain'};
2117: return "/$cdom/$cnum";
2118: }
2119:
2120: my %courseinfo=&Apache::lonnet::coursedescription($courseid);
2121: if (exists($courseinfo{'num'})) {
2122: return "/$courseinfo{'domain'}/$courseinfo{'num'}";
2123: }
2124:
2125: return undef;
2126: }
2127:
2128: sub getsection {
2129: my ($udom,$unam,$courseid)=@_;
2130: my $cachetime=1800;
2131:
2132: my $hashid="$udom:$unam:$courseid";
2133: my ($result,$cached)=&is_cached_new('getsection',$hashid);
2134: if (defined($cached)) { return $result; }
2135:
2136: my %Pending;
2137: my %Expired;
2138: #
2139: # Each role can either have not started yet (pending), be active,
2140: # or have expired.
2141: #
2142: # If there is an active role, we are done.
2143: #
2144: # If there is more than one role which has not started yet,
2145: # choose the one which will start sooner
2146: # If there is one role which has not started yet, return it.
2147: #
2148: # If there is more than one expired role, choose the one which ended last.
2149: # If there is a role which has expired, return it.
2150: #
2151: $courseid = &courseid_to_courseurl($courseid);
2152: my $extra = &freeze_escape({'skipcheck' => 1});
2153: my %roleshash = &dump('roles',$udom,$unam,$courseid,undef,$extra);
2154: foreach my $key (keys(%roleshash)) {
2155: next if ($key !~/^\Q$courseid\E(?:\/)*(\w+)*\_st$/);
2156: my $section=$1;
2157: if ($key eq $courseid.'_st') { $section=''; }
2158: my ($dummy,$end,$start)=split(/\_/,&unescape($roleshash{$key}));
2159: my $now=time;
2160: if (defined($end) && $end && ($now > $end)) {
2161: $Expired{$end}=$section;
2162: next;
2163: }
2164: if (defined($start) && $start && ($now < $start)) {
2165: $Pending{$start}=$section;
2166: next;
2167: }
2168: return &do_cache_new('getsection',$hashid,$section,$cachetime);
2169: }
2170: #
2171: # Presumedly there will be few matching roles from the above
2172: # loop and the sorting time will be negligible.
2173: if (scalar(keys(%Pending))) {
2174: my ($time) = sort {$a <=> $b} keys(%Pending);
2175: return &do_cache_new('getsection',$hashid,$Pending{$time},$cachetime);
2176: }
2177: if (scalar(keys(%Expired))) {
2178: my @sorted = sort {$a <=> $b} keys(%Expired);
2179: my $time = pop(@sorted);
2180: return &do_cache_new('getsection',$hashid,$Expired{$time},$cachetime);
2181: }
2182: return &do_cache_new('getsection',$hashid,'-1',$cachetime);
2183: }
2184:
2185: sub save_cache {
2186: &purge_remembered();
2187: #&Apache::loncommon::validate_page();
2188: undef(%env);
2189: undef($env_loaded);
2190: }
2191:
2192: my $to_remember=-1;
2193: my %remembered;
2194: my %accessed;
2195: my $kicks=0;
2196: my $hits=0;
2197: sub make_key {
2198: my ($name,$id) = @_;
2199: if (length($id) > 65
2200: && length(&escape($id)) > 200) {
2201: $id=length($id).':'.&Digest::MD5::md5_hex($id);
2202: }
2203: return &escape($name.':'.$id);
2204: }
2205:
2206: sub devalidate_cache_new {
2207: my ($name,$id,$debug) = @_;
2208: if ($debug) { &Apache::lonnet::logthis("deleting $name:$id"); }
2209: $id=&make_key($name,$id);
2210: $memcache->delete($id);
2211: delete($remembered{$id});
2212: delete($accessed{$id});
2213: }
2214:
2215: sub is_cached_new {
2216: my ($name,$id,$debug) = @_;
2217: $id=&make_key($name,$id);
2218: if (exists($remembered{$id})) {
2219: if ($debug) { &Apache::lonnet::logthis("Early return $id of $remembered{$id} "); }
2220: $accessed{$id}=[&gettimeofday()];
2221: $hits++;
2222: return ($remembered{$id},1);
2223: }
2224: my $value = $memcache->get($id);
2225: if (!(defined($value))) {
2226: if ($debug) { &Apache::lonnet::logthis("getting $id is not defined"); }
2227: return (undef,undef);
2228: }
2229: if ($value eq '__undef__') {
2230: if ($debug) { &Apache::lonnet::logthis("getting $id is __undef__"); }
2231: $value=undef;
2232: }
2233: &make_room($id,$value,$debug);
2234: if ($debug) { &Apache::lonnet::logthis("getting $id is $value"); }
2235: return ($value,1);
2236: }
2237:
2238: sub do_cache_new {
2239: my ($name,$id,$value,$time,$debug) = @_;
2240: $id=&make_key($name,$id);
2241: my $setvalue=$value;
2242: if (!defined($setvalue)) {
2243: $setvalue='__undef__';
2244: }
2245: if (!defined($time) ) {
2246: $time=600;
2247: }
2248: if ($debug) { &Apache::lonnet::logthis("Setting $id to $value"); }
2249: my $result = $memcache->set($id,$setvalue,$time);
2250: if (! $result) {
2251: &logthis("caching of id -> $id failed");
2252: $memcache->disconnect_all();
2253: }
2254: # need to make a copy of $value
2255: &make_room($id,$value,$debug);
2256: return $value;
2257: }
2258:
2259: sub make_room {
2260: my ($id,$value,$debug)=@_;
2261:
2262: $remembered{$id}= (ref($value)) ? &Storable::dclone($value)
2263: : $value;
2264: if ($to_remember<0) { return; }
2265: $accessed{$id}=[&gettimeofday()];
2266: if (scalar(keys(%remembered)) <= $to_remember) { return; }
2267: my $to_kick;
2268: my $max_time=0;
2269: foreach my $other (keys(%accessed)) {
2270: if (&tv_interval($accessed{$other}) > $max_time) {
2271: $to_kick=$other;
2272: $max_time=&tv_interval($accessed{$other});
2273: }
2274: }
2275: delete($remembered{$to_kick});
2276: delete($accessed{$to_kick});
2277: $kicks++;
2278: if ($debug) { &logthis("kicking $to_kick $max_time $kicks\n"); }
2279: return;
2280: }
2281:
2282: sub purge_remembered {
2283: #&logthis("Tossing ".scalar(keys(%remembered)));
2284: #&logthis(sprintf("%-20s is %s",'%remembered',length(&freeze(\%remembered))));
2285: undef(%remembered);
2286: undef(%accessed);
2287: }
2288: # ------------------------------------- Read an entry from a user's environment
2289:
2290: sub userenvironment {
2291: my ($udom,$unam,@what)=@_;
2292: my $items;
2293: foreach my $item (@what) {
2294: $items.=&escape($item).'&';
2295: }
2296: $items=~s/\&$//;
2297: my %returnhash=();
2298: my $uhome = &homeserver($unam,$udom);
2299: unless ($uhome eq 'no_host') {
2300: my @answer=split(/\&/,
2301: &reply('get:'.$udom.':'.$unam.':environment:'.$items,$uhome));
2302: if ($#answer==0 && $answer[0] =~ /^(con_lost|error:|no_such_host)/i) {
2303: return %returnhash;
2304: }
2305: my $i;
2306: for ($i=0;$i<=$#what;$i++) {
2307: $returnhash{$what[$i]}=&unescape($answer[$i]);
2308: }
2309: }
2310: return %returnhash;
2311: }
2312:
2313: # ---------------------------------------------------------- Get a studentphoto
2314: sub studentphoto {
2315: my ($udom,$unam,$ext) = @_;
2316: my $home=&Apache::lonnet::homeserver($unam,$udom);
2317: if (defined($env{'request.course.id'})) {
2318: if ($env{'course.'.$env{'request.course.id'}.'.internal.showphoto'}) {
2319: if ($udom eq $env{'course.'.$env{'request.course.id'}.'.domain'}) {
2320: return(&retrievestudentphoto($udom,$unam,$ext));
2321: } else {
2322: my ($result,$perm_reqd)=
2323: &Apache::lonnet::auto_photo_permission($unam,$udom);
2324: if ($result eq 'ok') {
2325: if (!($perm_reqd eq 'yes')) {
2326: return(&retrievestudentphoto($udom,$unam,$ext));
2327: }
2328: }
2329: }
2330: }
2331: } else {
2332: my ($result,$perm_reqd) =
2333: &Apache::lonnet::auto_photo_permission($unam,$udom);
2334: if ($result eq 'ok') {
2335: if (!($perm_reqd eq 'yes')) {
2336: return(&retrievestudentphoto($udom,$unam,$ext));
2337: }
2338: }
2339: }
2340: return '/adm/lonKaputt/lonlogo_broken.gif';
2341: }
2342:
2343: sub retrievestudentphoto {
2344: my ($udom,$unam,$ext,$type) = @_;
2345: my $home=&Apache::lonnet::homeserver($unam,$udom);
2346: my $ret=&Apache::lonnet::reply("studentphoto:$udom:$unam:$ext:$type",$home);
2347: if ($ret eq 'ok') {
2348: my $url="/uploaded/$udom/$unam/internal/studentphoto.$ext";
2349: if ($type eq 'thumbnail') {
2350: $url="/uploaded/$udom/$unam/internal/studentphoto_tn.$ext";
2351: }
2352: my $tokenurl=&Apache::lonnet::tokenwrapper($url);
2353: return $tokenurl;
2354: } else {
2355: if ($type eq 'thumbnail') {
2356: return '/adm/lonKaputt/genericstudent_tn.gif';
2357: } else {
2358: return '/adm/lonKaputt/lonlogo_broken.gif';
2359: }
2360: }
2361: }
2362:
2363: # -------------------------------------------------------------------- New chat
2364:
2365: sub chatsend {
2366: my ($newentry,$anon,$group)=@_;
2367: my $cnum=$env{'course.'.$env{'request.course.id'}.'.num'};
2368: my $cdom=$env{'course.'.$env{'request.course.id'}.'.domain'};
2369: my $chome=$env{'course.'.$env{'request.course.id'}.'.home'};
2370: &reply('chatsend:'.$cdom.':'.$cnum.':'.
2371: &escape($env{'user.domain'}.':'.$env{'user.name'}.':'.$anon.':'.
2372: &escape($newentry)).':'.$group,$chome);
2373: }
2374:
2375: # ------------------------------------------ Find current version of a resource
2376:
2377: sub getversion {
2378: my $fname=&clutter(shift);
2379: unless ($fname=~/^\/res\//) { return -1; }
2380: return ¤tversion(&filelocation('',$fname));
2381: }
2382:
2383: sub currentversion {
2384: my $fname=shift;
2385: my $author=$fname;
2386: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
2387: my ($udom,$uname)=split(/\//,$author);
2388: my $home=&homeserver($uname,$udom);
2389: if ($home eq 'no_host') {
2390: return -1;
2391: }
2392: my $answer=&reply("currentversion:$fname",$home);
2393: if (($answer eq 'con_lost') || ($answer eq 'rejected')) {
2394: return -1;
2395: }
2396: return $answer;
2397: }
2398:
2399: #
2400: # Return special version number of resource if set by override, empty otherwise
2401: #
2402: sub usedversion {
2403: my $fname=shift;
2404: unless ($fname) { $fname=$env{'request.uri'}; }
2405: my ($urlversion)=($fname=~/\.(\d+)\.\w+$/);
2406: if ($urlversion) { return $urlversion; }
2407: return '';
2408: }
2409:
2410: # ----------------------------- Subscribe to a resource, return URL if possible
2411:
2412: sub subscribe {
2413: my $fname=shift;
2414: if ($fname=~/\/(aboutme|syllabus|bulletinboard|smppg)$/) { return ''; }
2415: $fname=~s/[\n\r]//g;
2416: my $author=$fname;
2417: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
2418: my ($udom,$uname)=split(/\//,$author);
2419: my $home=homeserver($uname,$udom);
2420: if ($home eq 'no_host') {
2421: return 'not_found';
2422: }
2423: my $answer=reply("sub:$fname",$home);
2424: if (($answer eq 'con_lost') || ($answer eq 'rejected')) {
2425: $answer.=' by '.$home;
2426: }
2427: return $answer;
2428: }
2429:
2430: # -------------------------------------------------------------- Replicate file
2431:
2432: sub repcopy {
2433: my $filename=shift;
2434: $filename=~s/\/+/\//g;
2435: my $londocroot = $perlvar{'lonDocRoot'};
2436: if ($filename=~m{^\Q$londocroot/adm/\E}) { return 'ok'; }
2437: if ($filename=~m{^\Q$londocroot/lonUsers/\E}) { return 'ok'; }
2438: if ($filename=~m{^\Q$londocroot/userfiles/\E} or
2439: $filename=~m{^/*(uploaded|editupload)/}) {
2440: return &repcopy_userfile($filename);
2441: }
2442: $filename=~s/[\n\r]//g;
2443: my $transname="$filename.in.transfer";
2444: # FIXME: this should flock
2445: if ((-e $filename) || (-e $transname)) { return 'ok'; }
2446: my $remoteurl=subscribe($filename);
2447: if ($remoteurl =~ /^con_lost by/) {
2448: &logthis("Subscribe returned $remoteurl: $filename");
2449: return 'unavailable';
2450: } elsif ($remoteurl eq 'not_found') {
2451: #&logthis("Subscribe returned not_found: $filename");
2452: return 'not_found';
2453: } elsif ($remoteurl =~ /^rejected by/) {
2454: &logthis("Subscribe returned $remoteurl: $filename");
2455: return 'forbidden';
2456: } elsif ($remoteurl eq 'directory') {
2457: return 'ok';
2458: } else {
2459: my $author=$filename;
2460: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
2461: my ($udom,$uname)=split(/\//,$author);
2462: my $home=homeserver($uname,$udom);
2463: unless ($home eq $perlvar{'lonHostID'}) {
2464: my @parts=split(/\//,$filename);
2465: my $path="/$parts[1]/$parts[2]/$parts[3]/$parts[4]";
2466: if ($path ne "$londocroot/res") {
2467: &logthis("Malconfiguration for replication: $filename");
2468: return 'bad_request';
2469: }
2470: my $count;
2471: for ($count=5;$count<$#parts;$count++) {
2472: $path.="/$parts[$count]";
2473: if ((-e $path)!=1) {
2474: mkdir($path,0777);
2475: }
2476: }
2477: my $ua=new LWP::UserAgent;
2478: my $request=new HTTP::Request('GET',"$remoteurl");
2479: my $response=$ua->request($request,$transname);
2480: if ($response->is_error()) {
2481: unlink($transname);
2482: my $message=$response->status_line;
2483: &logthis("<font color=\"blue\">WARNING:"
2484: ." LWP get: $message: $filename</font>");
2485: return 'unavailable';
2486: } else {
2487: if ($remoteurl!~/\.meta$/) {
2488: my $mrequest=new HTTP::Request('GET',$remoteurl.'.meta');
2489: my $mresponse=$ua->request($mrequest,$filename.'.meta');
2490: if ($mresponse->is_error()) {
2491: unlink($filename.'.meta');
2492: &logthis(
2493: "<font color=\"yellow\">INFO: No metadata: $filename</font>");
2494: }
2495: }
2496: rename($transname,$filename);
2497: return 'ok';
2498: }
2499: }
2500: }
2501: }
2502:
2503: # ------------------------------------------------ Get server side include body
2504: sub ssi_body {
2505: my ($filelink,%form)=@_;
2506: if (! exists($form{'LONCAPA_INTERNAL_no_discussion'})) {
2507: $form{'LONCAPA_INTERNAL_no_discussion'}='true';
2508: }
2509: my $output='';
2510: my $response;
2511: if ($filelink=~/^https?\:/) {
2512: ($output,$response)=&externalssi($filelink);
2513: } else {
2514: $filelink .= $filelink=~/\?/ ? '&' : '?';
2515: $filelink .= 'inhibitmenu=yes';
2516: ($output,$response)=&ssi($filelink,%form);
2517: }
2518: $output=~s|//(\s*<!--)? BEGIN LON-CAPA Internal.+?// END LON-CAPA Internal\s*(-->)?\s||gs;
2519: $output=~s/^.*?\<body[^\>]*\>//si;
2520: $output=~s/\<\/body\s*\>.*?$//si;
2521: if (wantarray) {
2522: return ($output, $response);
2523: } else {
2524: return $output;
2525: }
2526: }
2527:
2528: # --------------------------------------------------------- Server Side Include
2529:
2530: sub absolute_url {
2531: my ($host_name) = @_;
2532: my $protocol = ($ENV{'SERVER_PORT'} == 443?'https://':'http://');
2533: if ($host_name eq '') {
2534: $host_name = $ENV{'SERVER_NAME'};
2535: }
2536: return $protocol.$host_name;
2537: }
2538:
2539: #
2540: # Server side include.
2541: # Parameters:
2542: # fn Possibly encrypted resource name/id.
2543: # form Hash that describes how the rendering should be done
2544: # and other things.
2545: # Returns:
2546: # Scalar context: The content of the response.
2547: # Array context: 2 element list of the content and the full response object.
2548: #
2549: sub ssi {
2550:
2551: my ($fn,%form)=@_;
2552: my $ua=new LWP::UserAgent;
2553: my $request;
2554:
2555: $form{'no_update_last_known'}=1;
2556: &Apache::lonenc::check_encrypt(\$fn);
2557: if (%form) {
2558: $request=new HTTP::Request('POST',&absolute_url().$fn);
2559: $request->content(join('&',map { &escape($_).'='.&escape($form{$_}) } keys(%form)));
2560: } else {
2561: $request=new HTTP::Request('GET',&absolute_url().$fn);
2562: }
2563:
2564: $request->header(Cookie => $ENV{'HTTP_COOKIE'});
2565: my $response=$ua->request($request);
2566:
2567: if (wantarray) {
2568: return ($response->content, $response);
2569: } else {
2570: return $response->content;
2571: }
2572: }
2573:
2574: sub externalssi {
2575: my ($url)=@_;
2576: my $ua=new LWP::UserAgent;
2577: my $request=new HTTP::Request('GET',$url);
2578: my $response=$ua->request($request);
2579: if (wantarray) {
2580: return ($response->content, $response);
2581: } else {
2582: return $response->content;
2583: }
2584: }
2585:
2586: # -------------------------------- Allow a /uploaded/ URI to be vouched for
2587:
2588: sub allowuploaded {
2589: my ($srcurl,$url)=@_;
2590: $url=&clutter(&declutter($url));
2591: my $dir=$url;
2592: $dir=~s/\/[^\/]+$//;
2593: my %httpref=();
2594: my $httpurl=&hreflocation('',$url);
2595: $httpref{'httpref.'.$httpurl}=$srcurl;
2596: &Apache::lonnet::appenv(\%httpref);
2597: }
2598:
2599: # --------- File operations in /home/httpd/html/userfiles/$domain/1/2/3/$course
2600: # input: action, courseID, current domain, intended
2601: # path to file, source of file, instruction to parse file for objects,
2602: # ref to hash for embedded objects,
2603: # ref to hash for codebase of java objects.
2604: # reference to scalar to accommodate mime type determined
2605: # from File::MMagic if $parser = parse.
2606: #
2607: # output: url to file (if action was uploaddoc),
2608: # ok if successful, or diagnostic message otherwise (if action was propagate or copy)
2609: #
2610: # Allows directory structure to be used within lonUsers/../userfiles/ for a
2611: # course.
2612: #
2613: # action = propagate - /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
2614: # will be copied to /home/httpd/lonUsers/1/2/3/$course/userfiles in
2615: # course's home server.
2616: #
2617: # action = copy - /home/httpd/html/userfiles/$domain/1/2/3/$course/$file will
2618: # be copied from $source (current location) to
2619: # /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
2620: # and will then be copied to
2621: # /home/httpd/lonUsers/$domain/1/2/3/$course/userfiles/$file in
2622: # course's home server.
2623: #
2624: # action = uploaddoc - /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
2625: # will be retrived from $env{form.uploaddoc} (from DOCS interface) to
2626: # /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
2627: # and will then be copied to /home/httpd/lonUsers/1/2/3/$course/userfiles/$file
2628: # in course's home server.
2629: #
2630:
2631: sub process_coursefile {
2632: my ($action,$docuname,$docudom,$file,$source,$parser,$allfiles,$codebase,
2633: $mimetype)=@_;
2634: my $fetchresult;
2635: my $home=&homeserver($docuname,$docudom);
2636: if ($action eq 'propagate') {
2637: $fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
2638: $home);
2639: } else {
2640: my $fpath = '';
2641: my $fname = $file;
2642: ($fpath,$fname) = ($file =~ m|^(.*)/([^/]+)$|);
2643: $fpath=$docudom.'/'.$docuname.'/'.$fpath;
2644: my $filepath = &build_filepath($fpath);
2645: if ($action eq 'copy') {
2646: if ($source eq '') {
2647: $fetchresult = 'no source file';
2648: return $fetchresult;
2649: } else {
2650: my $destination = $filepath.'/'.$fname;
2651: rename($source,$destination);
2652: $fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
2653: $home);
2654: }
2655: } elsif ($action eq 'uploaddoc') {
2656: open(my $fh,'>'.$filepath.'/'.$fname);
2657: print $fh $env{'form.'.$source};
2658: close($fh);
2659: if ($parser eq 'parse') {
2660: my $mm = new File::MMagic;
2661: my $type = $mm->checktype_filename($filepath.'/'.$fname);
2662: if ($type eq 'text/html') {
2663: my $parse_result = &extract_embedded_items($filepath.'/'.$fname,$allfiles,$codebase);
2664: unless ($parse_result eq 'ok') {
2665: &logthis('Failed to parse '.$filepath.'/'.$fname.' for embedded media: '.$parse_result);
2666: }
2667: }
2668: if (ref($mimetype)) {
2669: $$mimetype = $type;
2670: }
2671: }
2672: $fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
2673: $home);
2674: if ($fetchresult eq 'ok') {
2675: return '/uploaded/'.$fpath.'/'.$fname;
2676: } else {
2677: &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$file.
2678: ' to host '.$home.': '.$fetchresult);
2679: return '/adm/notfound.html';
2680: }
2681: }
2682: }
2683: unless ( $fetchresult eq 'ok') {
2684: &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$file.
2685: ' to host '.$home.': '.$fetchresult);
2686: }
2687: return $fetchresult;
2688: }
2689:
2690: sub build_filepath {
2691: my ($fpath) = @_;
2692: my $filepath=$perlvar{'lonDocRoot'}.'/userfiles';
2693: unless ($fpath eq '') {
2694: my @parts=split('/',$fpath);
2695: foreach my $part (@parts) {
2696: $filepath.= '/'.$part;
2697: if ((-e $filepath)!=1) {
2698: mkdir($filepath,0777);
2699: }
2700: }
2701: }
2702: return $filepath;
2703: }
2704:
2705: sub store_edited_file {
2706: my ($primary_url,$content,$docudom,$docuname,$fetchresult) = @_;
2707: my $file = $primary_url;
2708: $file =~ s#^/uploaded/$docudom/$docuname/##;
2709: my $fpath = '';
2710: my $fname = $file;
2711: ($fpath,$fname) = ($file =~ m|^(.*)/([^/]+)$|);
2712: $fpath=$docudom.'/'.$docuname.'/'.$fpath;
2713: my $filepath = &build_filepath($fpath);
2714: open(my $fh,'>'.$filepath.'/'.$fname);
2715: print $fh $content;
2716: close($fh);
2717: my $home=&homeserver($docuname,$docudom);
2718: $$fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
2719: $home);
2720: if ($$fetchresult eq 'ok') {
2721: return '/uploaded/'.$fpath.'/'.$fname;
2722: } else {
2723: &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$file.
2724: ' to host '.$home.': '.$$fetchresult);
2725: return '/adm/notfound.html';
2726: }
2727: }
2728:
2729: sub clean_filename {
2730: my ($fname,$args)=@_;
2731: # Replace Windows backslashes by forward slashes
2732: $fname=~s/\\/\//g;
2733: if (!$args->{'keep_path'}) {
2734: # Get rid of everything but the actual filename
2735: $fname=~s/^.*\/([^\/]+)$/$1/;
2736: }
2737: # Replace spaces by underscores
2738: $fname=~s/\s+/\_/g;
2739: # Replace all other weird characters by nothing
2740: $fname=~s{[^/\w\.\-]}{}g;
2741: # Replace all .\d. sequences with _\d. so they no longer look like version
2742: # numbers
2743: $fname=~s/\.(\d+)(?=\.)/_$1/g;
2744: return $fname;
2745: }
2746: # This Function checks if an Image's dimensions exceed either $resizewidth (width)
2747: # or $resizeheight (height) - both pixels. If so, the image is scaled to produce an
2748: # image with the same aspect ratio as the original, but with dimensions which do
2749: # not exceed $resizewidth and $resizeheight.
2750:
2751: sub resizeImage {
2752: my ($img_path,$resizewidth,$resizeheight) = @_;
2753: my $ima = Image::Magick->new;
2754: my $resized;
2755: if (-e $img_path) {
2756: $ima->Read($img_path);
2757: if (($resizewidth =~ /^\d+$/) && ($resizeheight > 0)) {
2758: my $width = $ima->Get('width');
2759: my $height = $ima->Get('height');
2760: if ($width > $resizewidth) {
2761: my $factor = $width/$resizewidth;
2762: my $newheight = $height/$factor;
2763: $ima->Scale(width=>$resizewidth,height=>$newheight);
2764: $resized = 1;
2765: }
2766: }
2767: if (($resizeheight =~ /^\d+$/) && ($resizeheight > 0)) {
2768: my $width = $ima->Get('width');
2769: my $height = $ima->Get('height');
2770: if ($height > $resizeheight) {
2771: my $factor = $height/$resizeheight;
2772: my $newwidth = $width/$factor;
2773: $ima->Scale(width=>$newwidth,height=>$resizeheight);
2774: $resized = 1;
2775: }
2776: }
2777: if ($resized) {
2778: $ima->Write($img_path);
2779: }
2780: }
2781: return;
2782: }
2783:
2784: # --------------- Take an uploaded file and put it into the userfiles directory
2785: # input: $formname - the contents of the file are in $env{"form.$formname"}
2786: # the desired filename is in $env{"form.$formname.filename"}
2787: # $context - possible values: coursedoc, existingfile, overwrite,
2788: # canceloverwrite, or ''.
2789: # if 'coursedoc': upload to the current course
2790: # if 'existingfile': write file to tmp/overwrites directory
2791: # if 'canceloverwrite': delete file written to tmp/overwrites directory
2792: # $context is passed as argument to &finishuserfileupload
2793: # $subdir - directory in userfile to store the file into
2794: # $parser - instruction to parse file for objects ($parser = parse)
2795: # $allfiles - reference to hash for embedded objects
2796: # $codebase - reference to hash for codebase of java objects
2797: # $desuname - username for permanent storage of uploaded file
2798: # $dsetudom - domain for permanaent storage of uploaded file
2799: # $thumbwidth - width (pixels) of thumbnail to make for uploaded image
2800: # $thumbheight - height (pixels) of thumbnail to make for uploaded image
2801: # $resizewidth - width (pixels) to which to resize uploaded image
2802: # $resizeheight - height (pixels) to which to resize uploaded image
2803: # $mimetype - reference to scalar to accommodate mime type determined
2804: # from File::MMagic.
2805: #
2806: # output: url of file in userspace, or error: <message>
2807: # or /adm/notfound.html if failure to upload occurse
2808:
2809: sub userfileupload {
2810: my ($formname,$context,$subdir,$parser,$allfiles,$codebase,$destuname,
2811: $destudom,$thumbwidth,$thumbheight,$resizewidth,$resizeheight,$mimetype)=@_;
2812: if (!defined($subdir)) { $subdir='unknown'; }
2813: my $fname=$env{'form.'.$formname.'.filename'};
2814: $fname=&clean_filename($fname);
2815: # See if there is anything left
2816: unless ($fname) { return 'error: no uploaded file'; }
2817: # Files uploaded to help request form, or uploaded to "create course" page are handled differently
2818: if ((($formname eq 'screenshot') && ($subdir eq 'helprequests')) ||
2819: (($formname eq 'coursecreatorxml') && ($subdir eq 'batchupload')) ||
2820: ($context eq 'existingfile') || ($context eq 'canceloverwrite')) {
2821: my $now = time;
2822: my $filepath;
2823: if (($formname eq 'screenshot') && ($subdir eq 'helprequests')) {
2824: $filepath = 'tmp/helprequests/'.$now;
2825: } elsif (($formname eq 'coursecreatorxml') && ($subdir eq 'batchupload')) {
2826: $filepath = 'tmp/addcourse/'.$destudom.'/web/'.$env{'user.name'}.
2827: '_'.$env{'user.domain'}.'/pending';
2828: } elsif (($context eq 'existingfile') || ($context eq 'canceloverwrite')) {
2829: my ($docuname,$docudom);
2830: if ($destudom) {
2831: $docudom = $destudom;
2832: } else {
2833: $docudom = $env{'user.domain'};
2834: }
2835: if ($destuname) {
2836: $docuname = $destuname;
2837: } else {
2838: $docuname = $env{'user.name'};
2839: }
2840: if (exists($env{'form.group'})) {
2841: $docuname=$env{'course.'.$env{'request.course.id'}.'.num'};
2842: $docudom=$env{'course.'.$env{'request.course.id'}.'.domain'};
2843: }
2844: $filepath = 'tmp/overwrites/'.$docudom.'/'.$docuname.'/'.$subdir;
2845: if ($context eq 'canceloverwrite') {
2846: my $tempfile = $perlvar{'lonDaemons'}.'/'.$filepath.'/'.$fname;
2847: if (-e $tempfile) {
2848: my @info = stat($tempfile);
2849: if ($info[9] eq $env{'form.timestamp'}) {
2850: unlink($tempfile);
2851: }
2852: }
2853: return;
2854: }
2855: }
2856: # Create the directory if not present
2857: my @parts=split(/\//,$filepath);
2858: my $fullpath = $perlvar{'lonDaemons'};
2859: for (my $i=0;$i<@parts;$i++) {
2860: $fullpath .= '/'.$parts[$i];
2861: if ((-e $fullpath)!=1) {
2862: mkdir($fullpath,0777);
2863: }
2864: }
2865: open(my $fh,'>'.$fullpath.'/'.$fname);
2866: print $fh $env{'form.'.$formname};
2867: close($fh);
2868: if ($context eq 'existingfile') {
2869: my @info = stat($fullpath.'/'.$fname);
2870: return ($fullpath.'/'.$fname,$info[9]);
2871: } else {
2872: return $fullpath.'/'.$fname;
2873: }
2874: }
2875: if ($subdir eq 'scantron') {
2876: $fname = 'scantron_orig_'.$fname;
2877: } else {
2878: $fname="$subdir/$fname";
2879: }
2880: if ($context eq 'coursedoc') {
2881: my $docuname=$env{'course.'.$env{'request.course.id'}.'.num'};
2882: my $docudom=$env{'course.'.$env{'request.course.id'}.'.domain'};
2883: if ($env{'form.folder'} =~ m/^(default|supplemental)/) {
2884: return &finishuserfileupload($docuname,$docudom,
2885: $formname,$fname,$parser,$allfiles,
2886: $codebase,$thumbwidth,$thumbheight,
2887: $resizewidth,$resizeheight,$context,$mimetype);
2888: } else {
2889: $fname=$env{'form.folder'}.'/'.$fname;
2890: return &process_coursefile('uploaddoc',$docuname,$docudom,
2891: $fname,$formname,$parser,
2892: $allfiles,$codebase,$mimetype);
2893: }
2894: } elsif (defined($destuname)) {
2895: my $docuname=$destuname;
2896: my $docudom=$destudom;
2897: return &finishuserfileupload($docuname,$docudom,$formname,$fname,
2898: $parser,$allfiles,$codebase,
2899: $thumbwidth,$thumbheight,
2900: $resizewidth,$resizeheight,$context,$mimetype);
2901: } else {
2902: my $docuname=$env{'user.name'};
2903: my $docudom=$env{'user.domain'};
2904: if (exists($env{'form.group'})) {
2905: $docuname=$env{'course.'.$env{'request.course.id'}.'.num'};
2906: $docudom=$env{'course.'.$env{'request.course.id'}.'.domain'};
2907: }
2908: return &finishuserfileupload($docuname,$docudom,$formname,$fname,
2909: $parser,$allfiles,$codebase,
2910: $thumbwidth,$thumbheight,
2911: $resizewidth,$resizeheight,$context,$mimetype);
2912: }
2913: }
2914:
2915: sub finishuserfileupload {
2916: my ($docuname,$docudom,$formname,$fname,$parser,$allfiles,$codebase,
2917: $thumbwidth,$thumbheight,$resizewidth,$resizeheight,$context,$mimetype) = @_;
2918: my $path=$docudom.'/'.$docuname.'/';
2919: my $filepath=$perlvar{'lonDocRoot'};
2920:
2921: my ($fnamepath,$file,$fetchthumb);
2922: $file=$fname;
2923: if ($fname=~m|/|) {
2924: ($fnamepath,$file) = ($fname =~ m|^(.*)/([^/]+)$|);
2925: $path.=$fnamepath.'/';
2926: }
2927: my @parts=split(/\//,$filepath.'/userfiles/'.$path);
2928: my $count;
2929: for ($count=4;$count<=$#parts;$count++) {
2930: $filepath.="/$parts[$count]";
2931: if ((-e $filepath)!=1) {
2932: mkdir($filepath,0777);
2933: }
2934: }
2935:
2936: # Save the file
2937: {
2938: if (!open(FH,'>'.$filepath.'/'.$file)) {
2939: &logthis('Failed to create '.$filepath.'/'.$file);
2940: print STDERR ('Failed to create '.$filepath.'/'.$file."\n");
2941: return '/adm/notfound.html';
2942: }
2943: if ($context eq 'overwrite') {
2944: my $source = LONCAPA::tempdir().'/overwrites/'.$docudom.'/'.$docuname.'/'.$fname;
2945: my $target = $filepath.'/'.$file;
2946: if (-e $source) {
2947: my @info = stat($source);
2948: if ($info[9] eq $env{'form.timestamp'}) {
2949: unless (&File::Copy::move($source,$target)) {
2950: &logthis('Failed to overwrite '.$filepath.'/'.$file);
2951: return "Moving from $source failed";
2952: }
2953: } else {
2954: return "Temporary file: $source had unexpected date/time for last modification";
2955: }
2956: } else {
2957: return "Temporary file: $source missing";
2958: }
2959: } elsif (!print FH ($env{'form.'.$formname})) {
2960: &logthis('Failed to write to '.$filepath.'/'.$file);
2961: print STDERR ('Failed to write to '.$filepath.'/'.$file."\n");
2962: return '/adm/notfound.html';
2963: }
2964: close(FH);
2965: if ($resizewidth && $resizeheight) {
2966: my $mm = new File::MMagic;
2967: my $mime_type = $mm->checktype_filename($filepath.'/'.$file);
2968: if ($mime_type =~ m{^image/}) {
2969: &resizeImage($filepath.'/'.$file,$resizewidth,$resizeheight);
2970: }
2971: }
2972: }
2973: if (($context eq 'coursedoc') || ($parser eq 'parse')) {
2974: if (ref($mimetype)) {
2975: if ($$mimetype eq '') {
2976: my $mm = new File::MMagic;
2977: my $type = $mm->checktype_filename($filepath.'/'.$file);
2978: $$mimetype = $type;
2979: }
2980: }
2981: }
2982: if ($parser eq 'parse') {
2983: if ((ref($mimetype)) && ($$mimetype eq 'text/html')) {
2984: my $parse_result = &extract_embedded_items($filepath.'/'.$file,
2985: $allfiles,$codebase);
2986: unless ($parse_result eq 'ok') {
2987: &logthis('Failed to parse '.$filepath.$file.
2988: ' for embedded media: '.$parse_result);
2989: }
2990: }
2991: }
2992: if (($thumbwidth =~ /^\d+$/) && ($thumbheight =~ /^\d+$/)) {
2993: my $input = $filepath.'/'.$file;
2994: my $output = $filepath.'/'.'tn-'.$file;
2995: my $thumbsize = $thumbwidth.'x'.$thumbheight;
2996: system("convert -sample $thumbsize $input $output");
2997: if (-e $filepath.'/'.'tn-'.$file) {
2998: $fetchthumb = 1;
2999: }
3000: }
3001:
3002: # Notify homeserver to grep it
3003: #
3004: my $docuhome=&homeserver($docuname,$docudom);
3005: my $fetchresult= &reply('fetchuserfile:'.$path.$file,$docuhome);
3006: if ($fetchresult eq 'ok') {
3007: if ($fetchthumb) {
3008: my $thumbresult= &reply('fetchuserfile:'.$path.'tn-'.$file,$docuhome);
3009: if ($thumbresult ne 'ok') {
3010: &logthis('Failed to transfer '.$path.'tn-'.$file.' to host '.
3011: $docuhome.': '.$thumbresult);
3012: }
3013: }
3014: #
3015: # Return the URL to it
3016: return '/uploaded/'.$path.$file;
3017: } else {
3018: &logthis('Failed to transfer '.$path.$file.' to host '.$docuhome.
3019: ': '.$fetchresult);
3020: return '/adm/notfound.html';
3021: }
3022: }
3023:
3024: sub extract_embedded_items {
3025: my ($fullpath,$allfiles,$codebase,$content) = @_;
3026: my @state = ();
3027: my %javafiles = (
3028: codebase => '',
3029: code => '',
3030: archive => ''
3031: );
3032: my %mediafiles = (
3033: src => '',
3034: movie => '',
3035: );
3036: my $p;
3037: if ($content) {
3038: $p = HTML::LCParser->new($content);
3039: } else {
3040: $p = HTML::LCParser->new($fullpath);
3041: }
3042: while (my $t=$p->get_token()) {
3043: if ($t->[0] eq 'S') {
3044: my ($tagname, $attr) = ($t->[1],$t->[2]);
3045: push(@state, $tagname);
3046: if (lc($tagname) eq 'allow') {
3047: &add_filetype($allfiles,$attr->{'src'},'src');
3048: }
3049: if (lc($tagname) eq 'img') {
3050: &add_filetype($allfiles,$attr->{'src'},'src');
3051: }
3052: if (lc($tagname) eq 'a') {
3053: &add_filetype($allfiles,$attr->{'href'},'href');
3054: }
3055: if (lc($tagname) eq 'script') {
3056: if ($attr->{'archive'} =~ /\.jar$/i) {
3057: &add_filetype($allfiles,$attr->{'archive'},'archive');
3058: } else {
3059: &add_filetype($allfiles,$attr->{'src'},'src');
3060: }
3061: }
3062: if (lc($tagname) eq 'link') {
3063: if (lc($attr->{'rel'}) eq 'stylesheet') {
3064: &add_filetype($allfiles,$attr->{'href'},'href');
3065: }
3066: }
3067: if (lc($tagname) eq 'object' ||
3068: (lc($tagname) eq 'embed' && lc($state[-2]) ne 'object')) {
3069: foreach my $item (keys(%javafiles)) {
3070: $javafiles{$item} = '';
3071: }
3072: }
3073: if (lc($state[-2]) eq 'object' && lc($tagname) eq 'param') {
3074: my $name = lc($attr->{'name'});
3075: foreach my $item (keys(%javafiles)) {
3076: if ($name eq $item) {
3077: $javafiles{$item} = $attr->{'value'};
3078: last;
3079: }
3080: }
3081: foreach my $item (keys(%mediafiles)) {
3082: if ($name eq $item) {
3083: &add_filetype($allfiles, $attr->{'value'}, 'value');
3084: last;
3085: }
3086: }
3087: }
3088: if (lc($tagname) eq 'embed' || lc($tagname) eq 'applet') {
3089: foreach my $item (keys(%javafiles)) {
3090: if ($attr->{$item}) {
3091: $javafiles{$item} = $attr->{$item};
3092: last;
3093: }
3094: }
3095: foreach my $item (keys(%mediafiles)) {
3096: if ($attr->{$item}) {
3097: &add_filetype($allfiles,$attr->{$item},$item);
3098: last;
3099: }
3100: }
3101: }
3102: } elsif ($t->[0] eq 'E') {
3103: my ($tagname) = ($t->[1]);
3104: if ($javafiles{'codebase'} ne '') {
3105: $javafiles{'codebase'} .= '/';
3106: }
3107: if (lc($tagname) eq 'applet' ||
3108: lc($tagname) eq 'object' ||
3109: (lc($tagname) eq 'embed' && lc($state[-2]) ne 'object')
3110: ) {
3111: foreach my $item (keys(%javafiles)) {
3112: if ($item ne 'codebase' && $javafiles{$item} ne '') {
3113: my $file=$javafiles{'codebase'}.$javafiles{$item};
3114: &add_filetype($allfiles,$file,$item);
3115: }
3116: }
3117: }
3118: pop @state;
3119: }
3120: }
3121: return 'ok';
3122: }
3123:
3124: sub add_filetype {
3125: my ($allfiles,$file,$type)=@_;
3126: if (exists($allfiles->{$file})) {
3127: unless (grep/^\Q$type\E$/, @{$allfiles->{$file}}) {
3128: push(@{$allfiles->{$file}}, &escape($type));
3129: }
3130: } else {
3131: @{$allfiles->{$file}} = (&escape($type));
3132: }
3133: }
3134:
3135: sub removeuploadedurl {
3136: my ($url)=@_;
3137: my (undef,undef,$udom,$uname,$fname)=split('/',$url,5);
3138: return &removeuserfile($uname,$udom,$fname);
3139: }
3140:
3141: sub removeuserfile {
3142: my ($docuname,$docudom,$fname)=@_;
3143: my $home=&homeserver($docuname,$docudom);
3144: my $result = &reply("removeuserfile:$docudom/$docuname/$fname",$home);
3145: if ($result eq 'ok') {
3146: if (($fname !~ /\.meta$/) && (&is_portfolio_file($fname))) {
3147: my $metafile = $fname.'.meta';
3148: my $metaresult = &removeuserfile($docuname,$docudom,$metafile);
3149: my $url = "/uploaded/$docudom/$docuname/$fname";
3150: my ($file,$group) = (&parse_portfolio_url($url))[3,4];
3151: my $sqlresult =
3152: &update_portfolio_table($docuname,$docudom,$file,
3153: 'portfolio_metadata',$group,
3154: 'delete');
3155: }
3156: }
3157: return $result;
3158: }
3159:
3160: sub mkdiruserfile {
3161: my ($docuname,$docudom,$dir)=@_;
3162: my $home=&homeserver($docuname,$docudom);
3163: return &reply("mkdiruserfile:".&escape("$docudom/$docuname/$dir"),$home);
3164: }
3165:
3166: sub renameuserfile {
3167: my ($docuname,$docudom,$old,$new)=@_;
3168: my $home=&homeserver($docuname,$docudom);
3169: my $result = &reply("renameuserfile:$docudom:$docuname:".
3170: &escape("$old").':'.&escape("$new"),$home);
3171: if ($result eq 'ok') {
3172: if (($old !~ /\.meta$/) && (&is_portfolio_file($old))) {
3173: my $oldmeta = $old.'.meta';
3174: my $newmeta = $new.'.meta';
3175: my $metaresult =
3176: &renameuserfile($docuname,$docudom,$oldmeta,$newmeta);
3177: my $url = "/uploaded/$docudom/$docuname/$old";
3178: my ($file,$group) = (&parse_portfolio_url($url))[3,4];
3179: my $sqlresult =
3180: &update_portfolio_table($docuname,$docudom,$file,
3181: 'portfolio_metadata',$group,
3182: 'delete');
3183: }
3184: }
3185: return $result;
3186: }
3187:
3188: # ------------------------------------------------------------------------- Log
3189:
3190: sub log {
3191: my ($dom,$nam,$hom,$what)=@_;
3192: return critical("log:$dom:$nam:$what",$hom);
3193: }
3194:
3195: # ------------------------------------------------------------------ Course Log
3196: #
3197: # This routine flushes several buffers of non-mission-critical nature
3198: #
3199:
3200: sub flushcourselogs {
3201: &logthis('Flushing log buffers');
3202: #
3203: # course logs
3204: # This is a log of all transactions in a course, which can be used
3205: # for data mining purposes
3206: #
3207: # It also collects the courseid database, which lists last transaction
3208: # times and course titles for all courseids
3209: #
3210: my %courseidbuffer=();
3211: foreach my $crsid (keys(%courselogs)) {
3212: if (&reply('log:'.$coursedombuf{$crsid}.':'.$coursenumbuf{$crsid}.':'.
3213: &escape($courselogs{$crsid}),
3214: $coursehombuf{$crsid}) eq 'ok') {
3215: delete $courselogs{$crsid};
3216: } else {
3217: &logthis('Failed to flush log buffer for '.$crsid);
3218: if (length($courselogs{$crsid})>40000) {
3219: &logthis("<font color=\"blue\">WARNING: Buffer for ".$crsid.
3220: " exceeded maximum size, deleting.</font>");
3221: delete $courselogs{$crsid};
3222: }
3223: }
3224: $courseidbuffer{$coursehombuf{$crsid}}{$crsid} = {
3225: 'description' => $coursedescrbuf{$crsid},
3226: 'inst_code' => $courseinstcodebuf{$crsid},
3227: 'type' => $coursetypebuf{$crsid},
3228: 'owner' => $courseownerbuf{$crsid},
3229: };
3230: }
3231: #
3232: # Write course id database (reverse lookup) to homeserver of courses
3233: # Is used in pickcourse
3234: #
3235: foreach my $crs_home (keys(%courseidbuffer)) {
3236: my $response = &courseidput(&host_domain($crs_home),
3237: $courseidbuffer{$crs_home},
3238: $crs_home,'timeonly');
3239: }
3240: #
3241: # File accesses
3242: # Writes to the dynamic metadata of resources to get hit counts, etc.
3243: #
3244: foreach my $entry (keys(%accesshash)) {
3245: if ($entry =~ /___count$/) {
3246: my ($dom,$name);
3247: ($dom,$name,undef)=
3248: ($entry=~m{___($match_domain)/($match_name)/(.*)___count$});
3249: if (! defined($dom) || $dom eq '' ||
3250: ! defined($name) || $name eq '') {
3251: my $cid = $env{'request.course.id'};
3252: $dom = $env{'request.'.$cid.'.domain'};
3253: $name = $env{'request.'.$cid.'.num'};
3254: }
3255: my $value = $accesshash{$entry};
3256: my (undef,$url,undef) = ($entry =~ /^(.*)___(.*)___count$/);
3257: my %temphash=($url => $value);
3258: my $result = &inc('nohist_accesscount',\%temphash,$dom,$name);
3259: if ($result eq 'ok') {
3260: delete $accesshash{$entry};
3261: } elsif ($result eq 'unknown_cmd') {
3262: # Target server has old code running on it.
3263: my %temphash=($entry => $value);
3264: if (&put('nohist_resevaldata',\%temphash,$dom,$name) eq 'ok') {
3265: delete $accesshash{$entry};
3266: }
3267: }
3268: } else {
3269: my ($dom,$name) = ($entry=~m{___($match_domain)/($match_name)/(.*)___(\w+)$});
3270: my %temphash=($entry => $accesshash{$entry});
3271: if (&put('nohist_resevaldata',\%temphash,$dom,$name) eq 'ok') {
3272: delete $accesshash{$entry};
3273: }
3274: }
3275: }
3276: #
3277: # Roles
3278: # Reverse lookup of user roles for course faculty/staff and co-authorship
3279: #
3280: foreach my $entry (keys(%userrolehash)) {
3281: my ($role,$uname,$udom,$runame,$rudom,$rsec)=
3282: split(/\:/,$entry);
3283: if (&Apache::lonnet::put('nohist_userroles',
3284: { $role.':'.$uname.':'.$udom.':'.$rsec => $userrolehash{$entry} },
3285: $rudom,$runame) eq 'ok') {
3286: delete $userrolehash{$entry};
3287: }
3288: }
3289: #
3290: # Reverse lookup of domain roles (dc, ad, li, sc, au)
3291: #
3292: my %domrolebuffer = ();
3293: foreach my $entry (keys(%domainrolehash)) {
3294: my ($role,$uname,$udom,$runame,$rudom,$rsec)=split(/:/,$entry);
3295: if ($domrolebuffer{$rudom}) {
3296: $domrolebuffer{$rudom}.='&'.&escape($entry).
3297: '='.&escape($domainrolehash{$entry});
3298: } else {
3299: $domrolebuffer{$rudom}.=&escape($entry).
3300: '='.&escape($domainrolehash{$entry});
3301: }
3302: delete $domainrolehash{$entry};
3303: }
3304: foreach my $dom (keys(%domrolebuffer)) {
3305: my %servers = &get_servers($dom,'library');
3306: foreach my $tryserver (keys(%servers)) {
3307: unless (&reply('domroleput:'.$dom.':'.
3308: $domrolebuffer{$dom},$tryserver) eq 'ok') {
3309: &logthis('Put of domain roles failed for '.$dom.' and '.$tryserver);
3310: }
3311: }
3312: }
3313: $dumpcount++;
3314: }
3315:
3316: sub courselog {
3317: my $what=shift;
3318: $what=time.':'.$what;
3319: unless ($env{'request.course.id'}) { return ''; }
3320: $coursedombuf{$env{'request.course.id'}}=
3321: $env{'course.'.$env{'request.course.id'}.'.domain'};
3322: $coursenumbuf{$env{'request.course.id'}}=
3323: $env{'course.'.$env{'request.course.id'}.'.num'};
3324: $coursehombuf{$env{'request.course.id'}}=
3325: $env{'course.'.$env{'request.course.id'}.'.home'};
3326: $coursedescrbuf{$env{'request.course.id'}}=
3327: $env{'course.'.$env{'request.course.id'}.'.description'};
3328: $courseinstcodebuf{$env{'request.course.id'}}=
3329: $env{'course.'.$env{'request.course.id'}.'.internal.coursecode'};
3330: $courseownerbuf{$env{'request.course.id'}}=
3331: $env{'course.'.$env{'request.course.id'}.'.internal.courseowner'};
3332: $coursetypebuf{$env{'request.course.id'}}=
3333: $env{'course.'.$env{'request.course.id'}.'.type'};
3334: if (defined $courselogs{$env{'request.course.id'}}) {
3335: $courselogs{$env{'request.course.id'}}.='&'.$what;
3336: } else {
3337: $courselogs{$env{'request.course.id'}}.=$what;
3338: }
3339: if (length($courselogs{$env{'request.course.id'}})>4048) {
3340: &flushcourselogs();
3341: }
3342: }
3343:
3344: sub courseacclog {
3345: my $fnsymb=shift;
3346: unless ($env{'request.course.id'}) { return ''; }
3347: my $what=$fnsymb.':'.$env{'user.name'}.':'.$env{'user.domain'};
3348: if ($fnsymb=~/$LONCAPA::assess_re/) {
3349: $what.=':POST';
3350: # FIXME: Probably ought to escape things....
3351: foreach my $key (keys(%env)) {
3352: if ($key=~/^form\.(.*)/) {
3353: my $formitem = $1;
3354: if ($formitem =~ /^HWFILE(?:SIZE|TOOBIG)/) {
3355: $what.=':'.$formitem.'='.$env{$key};
3356: } elsif ($formitem !~ /^HWFILE(?:[^.]+)$/) {
3357: $what.=':'.$formitem.'='.$env{$key};
3358: }
3359: }
3360: }
3361: } elsif ($fnsymb =~ m:^/adm/searchcat:) {
3362: # FIXME: We should not be depending on a form parameter that someone
3363: # editing lonsearchcat.pm might change in the future.
3364: if ($env{'form.phase'} eq 'course_search') {
3365: $what.= ':POST';
3366: # FIXME: Probably ought to escape things....
3367: foreach my $element ('courseexp','crsfulltext','crsrelated',
3368: 'crsdiscuss') {
3369: $what.=':'.$element.'='.$env{'form.'.$element};
3370: }
3371: }
3372: }
3373: &courselog($what);
3374: }
3375:
3376: sub countacc {
3377: my $url=&declutter(shift);
3378: return if (! defined($url) || $url eq '');
3379: unless ($env{'request.course.id'}) { return ''; }
3380: $accesshash{$env{'request.course.id'}.'___'.$url.'___course'}=1;
3381: my $key=$$.$processmarker.'_'.$dumpcount.'___'.$url.'___count';
3382: $accesshash{$key}++;
3383: }
3384:
3385: sub linklog {
3386: my ($from,$to)=@_;
3387: $from=&declutter($from);
3388: $to=&declutter($to);
3389: $accesshash{$from.'___'.$to.'___comefrom'}=1;
3390: $accesshash{$to.'___'.$from.'___goto'}=1;
3391: }
3392:
3393: sub userrolelog {
3394: my ($trole,$username,$domain,$area,$tstart,$tend)=@_;
3395: if (($trole=~/^ca/) || ($trole=~/^aa/) ||
3396: ($trole=~/^in/) || ($trole=~/^cc/) ||
3397: ($trole=~/^ep/) || ($trole=~/^cr/) ||
3398: ($trole=~/^ta/) || ($trole=~/^co/)) {
3399: my (undef,$rudom,$runame,$rsec)=split(/\//,$area);
3400: $userrolehash
3401: {$trole.':'.$username.':'.$domain.':'.$runame.':'.$rudom.':'.$rsec}
3402: =$tend.':'.$tstart;
3403: }
3404: if (($env{'request.role'} =~ /dc\./) &&
3405: (($trole=~/^au/) || ($trole=~/^in/) ||
3406: ($trole=~/^cc/) || ($trole=~/^ep/) ||
3407: ($trole=~/^cr/) || ($trole=~/^ta/) ||
3408: ($trole=~/^co/))) {
3409: $userrolehash
3410: {$trole.':'.$username.':'.$domain.':'.$env{'user.name'}.':'.$env{'user.domain'}.':'}
3411: =$tend.':'.$tstart;
3412: }
3413: if (($trole=~/^dc/) || ($trole=~/^ad/) ||
3414: ($trole=~/^li/) || ($trole=~/^li/) ||
3415: ($trole=~/^au/) || ($trole=~/^dg/) ||
3416: ($trole=~/^sc/)) {
3417: my (undef,$rudom,$runame,$rsec)=split(/\//,$area);
3418: $domainrolehash
3419: {$trole.':'.$username.':'.$domain.':'.$runame.':'.$rudom.':'.$rsec}
3420: = $tend.':'.$tstart;
3421: }
3422: }
3423:
3424: sub courserolelog {
3425: my ($trole,$username,$domain,$area,$tstart,$tend,$delflag,$selfenroll,$context)=@_;
3426: if (($trole eq 'cc') || ($trole eq 'in') ||
3427: ($trole eq 'ep') || ($trole eq 'ad') ||
3428: ($trole eq 'ta') || ($trole eq 'st') ||
3429: ($trole=~/^cr/) || ($trole eq 'gr') ||
3430: ($trole eq 'co')) {
3431: if ($area =~ m-^/($match_domain)/($match_courseid)/?([^/]*)-) {
3432: my $cdom = $1;
3433: my $cnum = $2;
3434: my $sec = $3;
3435: my $namespace = 'rolelog';
3436: my %storehash = (
3437: role => $trole,
3438: start => $tstart,
3439: end => $tend,
3440: selfenroll => $selfenroll,
3441: context => $context,
3442: );
3443: if ($trole eq 'gr') {
3444: $namespace = 'groupslog';
3445: $storehash{'group'} = $sec;
3446: } else {
3447: $storehash{'section'} = $sec;
3448: }
3449: &instructor_log($namespace,\%storehash,$delflag,$username,$domain,$cnum,$cdom);
3450: if (($trole ne 'st') || ($sec ne '')) {
3451: &devalidate_cache_new('getcourseroles',$cdom.'_'.$cnum);
3452: }
3453: }
3454: }
3455: return;
3456: }
3457:
3458: sub get_course_adv_roles {
3459: my ($cid,$codes) = @_;
3460: $cid=$env{'request.course.id'} unless (defined($cid));
3461: my %coursehash=&coursedescription($cid);
3462: my $crstype = &Apache::loncommon::course_type($cid);
3463: my %nothide=();
3464: foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
3465: if ($user !~ /:/) {
3466: $nothide{join(':',split(/[\@]/,$user))}=1;
3467: } else {
3468: $nothide{$user}=1;
3469: }
3470: }
3471: my %returnhash=();
3472: my %dumphash=
3473: &dump('nohist_userroles',$coursehash{'domain'},$coursehash{'num'});
3474: my $now=time;
3475: my %privileged;
3476: foreach my $entry (keys(%dumphash)) {
3477: my ($tend,$tstart)=split(/\:/,$dumphash{$entry});
3478: if (($tstart) && ($tstart<0)) { next; }
3479: if (($tend) && ($tend<$now)) { next; }
3480: if (($tstart) && ($now<$tstart)) { next; }
3481: my ($role,$username,$domain,$section)=split(/\:/,$entry);
3482: if ($username eq '' || $domain eq '') { next; }
3483: unless (ref($privileged{$domain}) eq 'HASH') {
3484: my %dompersonnel =
3485: &Apache::lonnet::get_domain_roles($domain,['dc'],$now,$now);
3486: $privileged{$domain} = {};
3487: foreach my $server (keys(%dompersonnel)) {
3488: if (ref($dompersonnel{$server}) eq 'HASH') {
3489: foreach my $user (keys(%{$dompersonnel{$server}})) {
3490: my ($trole,$uname,$udom) = split(/:/,$user);
3491: $privileged{$udom}{$uname} = 1;
3492: }
3493: }
3494: }
3495: }
3496: if ((exists($privileged{$domain}{$username})) &&
3497: (!$nothide{$username.':'.$domain})) { next; }
3498: if ($role eq 'cr') { next; }
3499: if ($codes) {
3500: if ($section) { $role .= ':'.$section; }
3501: if ($returnhash{$role}) {
3502: $returnhash{$role}.=','.$username.':'.$domain;
3503: } else {
3504: $returnhash{$role}=$username.':'.$domain;
3505: }
3506: } else {
3507: my $key=&plaintext($role,$crstype);
3508: if ($section) { $key.=' ('.&Apache::lonlocal::mt('Section [_1]',$section).')'; }
3509: if ($returnhash{$key}) {
3510: $returnhash{$key}.=','.$username.':'.$domain;
3511: } else {
3512: $returnhash{$key}=$username.':'.$domain;
3513: }
3514: }
3515: }
3516: return %returnhash;
3517: }
3518:
3519: sub get_my_roles {
3520: my ($uname,$udom,$context,$types,$roles,$roledoms,$withsec,$hidepriv)=@_;
3521: unless (defined($uname)) { $uname=$env{'user.name'}; }
3522: unless (defined($udom)) { $udom=$env{'user.domain'}; }
3523: my (%dumphash,%nothide);
3524: if ($context eq 'userroles') {
3525: my $extra = &freeze_escape({'skipcheck' => 1});
3526: %dumphash = &dump('roles',$udom,$uname,'.',undef,$extra);
3527: } else {
3528: %dumphash=
3529: &dump('nohist_userroles',$udom,$uname);
3530: if ($hidepriv) {
3531: my %coursehash=&coursedescription($udom.'_'.$uname);
3532: foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
3533: if ($user !~ /:/) {
3534: $nothide{join(':',split(/[\@]/,$user))} = 1;
3535: } else {
3536: $nothide{$user} = 1;
3537: }
3538: }
3539: }
3540: }
3541: my %returnhash=();
3542: my $now=time;
3543: my %privileged;
3544: foreach my $entry (keys(%dumphash)) {
3545: my ($role,$tend,$tstart);
3546: if ($context eq 'userroles') {
3547: next if ($entry =~ /^rolesdef/);
3548: ($role,$tend,$tstart)=split(/_/,$dumphash{$entry});
3549: } else {
3550: ($tend,$tstart)=split(/\:/,$dumphash{$entry});
3551: }
3552: if (($tstart) && ($tstart<0)) { next; }
3553: my $status = 'active';
3554: if (($tend) && ($tend<=$now)) {
3555: $status = 'previous';
3556: }
3557: if (($tstart) && ($now<$tstart)) {
3558: $status = 'future';
3559: }
3560: if (ref($types) eq 'ARRAY') {
3561: if (!grep(/^\Q$status\E$/,@{$types})) {
3562: next;
3563: }
3564: } else {
3565: if ($status ne 'active') {
3566: next;
3567: }
3568: }
3569: my ($rolecode,$username,$domain,$section,$area);
3570: if ($context eq 'userroles') {
3571: ($area,$rolecode) = split(/_/,$entry);
3572: (undef,$domain,$username,$section) = split(/\//,$area);
3573: } else {
3574: ($role,$username,$domain,$section) = split(/\:/,$entry);
3575: }
3576: if (ref($roledoms) eq 'ARRAY') {
3577: if (!grep(/^\Q$domain\E$/,@{$roledoms})) {
3578: next;
3579: }
3580: }
3581: if (ref($roles) eq 'ARRAY') {
3582: if (!grep(/^\Q$role\E$/,@{$roles})) {
3583: if ($role =~ /^cr\//) {
3584: if (!grep(/^cr$/,@{$roles})) {
3585: next;
3586: }
3587: } elsif ($role =~ /^gr\//) {
3588: if (!grep(/^gr$/,@{$roles})) {
3589: next;
3590: }
3591: } else {
3592: next;
3593: }
3594: }
3595: }
3596: if ($hidepriv) {
3597: if ($context eq 'userroles') {
3598: if ((&privileged($username,$domain)) &&
3599: (!$nothide{$username.':'.$domain})) {
3600: next;
3601: }
3602: } else {
3603: unless (ref($privileged{$domain}) eq 'HASH') {
3604: my %dompersonnel =
3605: &Apache::lonnet::get_domain_roles($domain,['dc'],$now,$now);
3606: $privileged{$domain} = {};
3607: if (keys(%dompersonnel)) {
3608: foreach my $server (keys(%dompersonnel)) {
3609: if (ref($dompersonnel{$server}) eq 'HASH') {
3610: foreach my $user (keys(%{$dompersonnel{$server}})) {
3611: my ($trole,$uname,$udom) = split(/:/,$user);
3612: $privileged{$udom}{$uname} = $trole;
3613: }
3614: }
3615: }
3616: }
3617: }
3618: if (exists($privileged{$domain}{$username})) {
3619: if (!$nothide{$username.':'.$domain}) {
3620: next;
3621: }
3622: }
3623: }
3624: }
3625: if ($withsec) {
3626: $returnhash{$username.':'.$domain.':'.$role.':'.$section} =
3627: $tstart.':'.$tend;
3628: } else {
3629: $returnhash{$username.':'.$domain.':'.$role}=$tstart.':'.$tend;
3630: }
3631: }
3632: return %returnhash;
3633: }
3634:
3635: # ----------------------------------------------------- Frontpage Announcements
3636: #
3637: #
3638:
3639: sub postannounce {
3640: my ($server,$text)=@_;
3641: unless (&allowed('psa',&host_domain($server))) { return 'refused'; }
3642: unless ($text=~/\w/) { $text=''; }
3643: return &reply('setannounce:'.&escape($text),$server);
3644: }
3645:
3646: sub getannounce {
3647:
3648: if (open(my $fh,$perlvar{'lonDocRoot'}.'/announcement.txt')) {
3649: my $announcement='';
3650: while (my $line = <$fh>) { $announcement .= $line; }
3651: close($fh);
3652: if ($announcement=~/\w/) {
3653: return
3654: '<table bgcolor="#FF5555" cellpadding="5" cellspacing="3">'.
3655: '<tr><td bgcolor="#FFFFFF"><tt>'.$announcement.'</tt></td></tr></table>';
3656: } else {
3657: return '';
3658: }
3659: } else {
3660: return '';
3661: }
3662: }
3663:
3664: # ---------------------------------------------------------- Course ID routines
3665: # Deal with domain's nohist_courseid.db files
3666: #
3667:
3668: sub courseidput {
3669: my ($domain,$storehash,$coursehome,$caller) = @_;
3670: return unless (ref($storehash) eq 'HASH');
3671: my $outcome;
3672: if ($caller eq 'timeonly') {
3673: my $cids = '';
3674: foreach my $item (keys(%$storehash)) {
3675: $cids.=&escape($item).'&';
3676: }
3677: $cids=~s/\&$//;
3678: $outcome = &reply('courseidputhash:'.$domain.':'.$caller.':'.$cids,
3679: $coursehome);
3680: } else {
3681: my $items = '';
3682: foreach my $item (keys(%$storehash)) {
3683: $items.= &escape($item).'='.
3684: &freeze_escape($$storehash{$item}).'&';
3685: }
3686: $items=~s/\&$//;
3687: $outcome = &reply('courseidputhash:'.$domain.':'.$caller.':'.$items,
3688: $coursehome);
3689: }
3690: if ($outcome eq 'unknown_cmd') {
3691: my $what;
3692: foreach my $cid (keys(%$storehash)) {
3693: $what .= &escape($cid).'=';
3694: foreach my $item ('description','inst_code','owner','type') {
3695: $what .= &escape($storehash->{$cid}{$item}).':';
3696: }
3697: $what =~ s/\:$/&/;
3698: }
3699: $what =~ s/\&$//;
3700: return &reply('courseidput:'.$domain.':'.$what,$coursehome);
3701: } else {
3702: return $outcome;
3703: }
3704: }
3705:
3706: sub courseiddump {
3707: my ($domfilter,$descfilter,$sincefilter,$instcodefilter,$ownerfilter,
3708: $coursefilter,$hostidflag,$hostidref,$typefilter,$regexp_ok,
3709: $selfenrollonly,$catfilter,$showhidden,$caller,$cloner,$cc_clone,
3710: $cloneonly,$createdbefore,$createdafter,$creationcontext,$domcloner)=@_;
3711: my $as_hash = 1;
3712: my %returnhash;
3713: if (!$domfilter) { $domfilter=''; }
3714: my %libserv = &all_library();
3715: foreach my $tryserver (keys(%libserv)) {
3716: if ( ( $hostidflag == 1
3717: && grep(/^\Q$tryserver\E$/,@{$hostidref}) )
3718: || (!defined($hostidflag)) ) {
3719:
3720: if (($domfilter eq '') ||
3721: (&host_domain($tryserver) eq $domfilter)) {
3722: my $rep =
3723: &reply('courseiddump:'.&host_domain($tryserver).':'.
3724: $sincefilter.':'.&escape($descfilter).':'.
3725: &escape($instcodefilter).':'.&escape($ownerfilter).
3726: ':'.&escape($coursefilter).':'.&escape($typefilter).
3727: ':'.&escape($regexp_ok).':'.$as_hash.':'.
3728: &escape($selfenrollonly).':'.&escape($catfilter).':'.
3729: $showhidden.':'.$caller.':'.&escape($cloner).':'.
3730: &escape($cc_clone).':'.$cloneonly.':'.
3731: &escape($createdbefore).':'.&escape($createdafter).':'.
3732: &escape($creationcontext).':'.$domcloner,
3733: $tryserver);
3734: my @pairs=split(/\&/,$rep);
3735: foreach my $item (@pairs) {
3736: my ($key,$value)=split(/\=/,$item,2);
3737: $key = &unescape($key);
3738: next if ($key =~ /^error: 2 /);
3739: my $result = &thaw_unescape($value);
3740: if (ref($result) eq 'HASH') {
3741: $returnhash{$key}=$result;
3742: } else {
3743: my @responses = split(/:/,$value);
3744: my @items = ('description','inst_code','owner','type');
3745: for (my $i=0; $i<@responses; $i++) {
3746: $returnhash{$key}{$items[$i]} = &unescape($responses[$i]);
3747: }
3748: }
3749: }
3750: }
3751: }
3752: }
3753: return %returnhash;
3754: }
3755:
3756: sub courselastaccess {
3757: my ($cdom,$cnum,$hostidref) = @_;
3758: my %returnhash;
3759: if ($cdom && $cnum) {
3760: my $chome = &homeserver($cnum,$cdom);
3761: if ($chome ne 'no_host') {
3762: my $rep = &reply('courselastaccess:'.$cdom.':'.$cnum,$chome);
3763: &extract_lastaccess(\%returnhash,$rep);
3764: }
3765: } else {
3766: if (!$cdom) { $cdom=''; }
3767: my %libserv = &all_library();
3768: foreach my $tryserver (keys(%libserv)) {
3769: if (ref($hostidref) eq 'ARRAY') {
3770: next unless (grep(/^\Q$tryserver\E$/,@{$hostidref}));
3771: }
3772: if (($cdom eq '') || (&host_domain($tryserver) eq $cdom)) {
3773: my $rep = &reply('courselastaccess:'.&host_domain($tryserver).':',$tryserver);
3774: &extract_lastaccess(\%returnhash,$rep);
3775: }
3776: }
3777: }
3778: return %returnhash;
3779: }
3780:
3781: sub extract_lastaccess {
3782: my ($returnhash,$rep) = @_;
3783: if (ref($returnhash) eq 'HASH') {
3784: unless ($rep eq 'unknown_command' || $rep eq 'no_such_host' ||
3785: $rep eq 'con_lost' || $rep eq 'rejected' || $rep eq 'refused' ||
3786: $rep eq '') {
3787: my @pairs=split(/\&/,$rep);
3788: foreach my $item (@pairs) {
3789: my ($key,$value)=split(/\=/,$item,2);
3790: $key = &unescape($key);
3791: next if ($key =~ /^error: 2 /);
3792: $returnhash->{$key} = &thaw_unescape($value);
3793: }
3794: }
3795: }
3796: return;
3797: }
3798:
3799: # ---------------------------------------------------------- DC e-mail
3800:
3801: sub dcmailput {
3802: my ($domain,$msgid,$message,$server)=@_;
3803: my $status = &Apache::lonnet::critical(
3804: 'dcmailput:'.$domain.':'.&escape($msgid).'='.
3805: &escape($message),$server);
3806: return $status;
3807: }
3808:
3809: sub dcmaildump {
3810: my ($dom,$startdate,$enddate,$senders) = @_;
3811: my %returnhash=();
3812:
3813: if (defined(&domain($dom,'primary'))) {
3814: my $cmd='dcmaildump:'.$dom.':'.&escape($startdate).':'.
3815: &escape($enddate).':';
3816: my @esc_senders=map { &escape($_)} @$senders;
3817: $cmd.=&escape(join('&',@esc_senders));
3818: foreach my $line (split(/\&/,&reply($cmd,&domain($dom,'primary')))) {
3819: my ($key,$value) = split(/\=/,$line,2);
3820: if (($key) && ($value)) {
3821: $returnhash{&unescape($key)} = &unescape($value);
3822: }
3823: }
3824: }
3825: return %returnhash;
3826: }
3827: # ---------------------------------------------------------- Domain roles
3828:
3829: sub get_domain_roles {
3830: my ($dom,$roles,$startdate,$enddate)=@_;
3831: if ((!defined($startdate)) || ($startdate eq '')) {
3832: $startdate = '.';
3833: }
3834: if ((!defined($enddate)) || ($enddate eq '')) {
3835: $enddate = '.';
3836: }
3837: my $rolelist;
3838: if (ref($roles) eq 'ARRAY') {
3839: $rolelist = join(':',@{$roles});
3840: }
3841: my %personnel = ();
3842:
3843: my %servers = &get_servers($dom,'library');
3844: foreach my $tryserver (keys(%servers)) {
3845: %{$personnel{$tryserver}}=();
3846: foreach my $line (split(/\&/,&reply('domrolesdump:'.$dom.':'.
3847: &escape($startdate).':'.
3848: &escape($enddate).':'.
3849: &escape($rolelist), $tryserver))) {
3850: my ($key,$value) = split(/\=/,$line,2);
3851: if (($key) && ($value)) {
3852: $personnel{$tryserver}{&unescape($key)} = &unescape($value);
3853: }
3854: }
3855: }
3856: return %personnel;
3857: }
3858:
3859: # ----------------------------------------------------------- Interval timing
3860:
3861: {
3862: # Caches needed for speedup of navmaps
3863: # We don't want to cache this for very long at all (5 seconds at most)
3864: #
3865: # The user for whom we cache
3866: my $cachedkey='';
3867: # The cached times for this user
3868: my %cachedtimes=();
3869: # When this was last done
3870: my $cachedtime=();
3871:
3872: sub load_all_first_access {
3873: my ($uname,$udom)=@_;
3874: if (($cachedkey eq $uname.':'.$udom.':'.$courseid) &&
3875: (abs($cachedtime-time)<5)) {
3876: return;
3877: }
3878: $cachedtime=time;
3879: $cachedkey=$uname.':'.$udom;
3880: %cachedtimes=&dump('firstaccesstimes',$udom,$uname);
3881: }
3882:
3883: sub get_first_access {
3884: my ($type,$argsymb)=@_;
3885: my ($symb,$courseid,$udom,$uname)=&whichuser();
3886: if ($argsymb) { $symb=$argsymb; }
3887: my ($map,$id,$res)=&decode_symb($symb);
3888: if ($type eq 'course') {
3889: $res='course';
3890: } elsif ($type eq 'map') {
3891: $res=&symbread($map);
3892: } else {
3893: $res=$symb;
3894: }
3895: &load_all_first_access($uname,$udom);
3896: return $cachedtimes{"$courseid\0$res"};
3897: }
3898:
3899: sub set_first_access {
3900: my ($type)=@_;
3901: my ($symb,$courseid,$udom,$uname)=&whichuser();
3902: my ($map,$id,$res)=&decode_symb($symb);
3903: if ($type eq 'course') {
3904: $res='course';
3905: } elsif ($type eq 'map') {
3906: $res=&symbread($map);
3907: } else {
3908: $res=$symb;
3909: }
3910: $cachedkey='';
3911: my $firstaccess=&get_first_access($type,$symb);
3912: if (!$firstaccess) {
3913: return &put('firstaccesstimes',{"$courseid\0$res"=>time},$udom,$uname);
3914: }
3915: return 'already_set';
3916: }
3917: }
3918: # --------------------------------------------- Set Expire Date for Spreadsheet
3919:
3920: sub expirespread {
3921: my ($uname,$udom,$stype,$usymb)=@_;
3922: my $cid=$env{'request.course.id'};
3923: if ($cid) {
3924: my $now=time;
3925: my $key=$uname.':'.$udom.':'.$stype.':'.$usymb;
3926: return &reply('put:'.$env{'course.'.$cid.'.domain'}.':'.
3927: $env{'course.'.$cid.'.num'}.
3928: ':nohist_expirationdates:'.
3929: &escape($key).'='.$now,
3930: $env{'course.'.$cid.'.home'})
3931: }
3932: return 'ok';
3933: }
3934:
3935: # ----------------------------------------------------- Devalidate Spreadsheets
3936:
3937: sub devalidate {
3938: my ($symb,$uname,$udom)=@_;
3939: my $cid=$env{'request.course.id'};
3940: if ($cid) {
3941: # delete the stored spreadsheets for
3942: # - the student level sheet of this user in course's homespace
3943: # - the assessment level sheet for this resource
3944: # for this user in user's homespace
3945: # - current conditional state info
3946: my $key=$uname.':'.$udom.':';
3947: my $status=
3948: &del('nohist_calculatedsheets',
3949: [$key.'studentcalc:'],
3950: $env{'course.'.$cid.'.domain'},
3951: $env{'course.'.$cid.'.num'})
3952: .' '.
3953: &del('nohist_calculatedsheets_'.$cid,
3954: [$key.'assesscalc:'.$symb],$udom,$uname);
3955: unless ($status eq 'ok ok') {
3956: &logthis('Could not devalidate spreadsheet '.
3957: $uname.' at '.$udom.' for '.
3958: $symb.': '.$status);
3959: }
3960: &delenv('user.state.'.$cid);
3961: }
3962: }
3963:
3964: sub get_scalar {
3965: my ($string,$end) = @_;
3966: my $value;
3967: if ($$string =~ s/^([^&]*?)($end)/$2/) {
3968: $value = $1;
3969: } elsif ($$string =~ s/^([^&]*?)&//) {
3970: $value = $1;
3971: }
3972: return &unescape($value);
3973: }
3974:
3975: sub array2str {
3976: my (@array) = @_;
3977: my $result=&arrayref2str(\@array);
3978: $result=~s/^__ARRAY_REF__//;
3979: $result=~s/__END_ARRAY_REF__$//;
3980: return $result;
3981: }
3982:
3983: sub arrayref2str {
3984: my ($arrayref) = @_;
3985: my $result='__ARRAY_REF__';
3986: foreach my $elem (@$arrayref) {
3987: if(ref($elem) eq 'ARRAY') {
3988: $result.=&arrayref2str($elem).'&';
3989: } elsif(ref($elem) eq 'HASH') {
3990: $result.=&hashref2str($elem).'&';
3991: } elsif(ref($elem)) {
3992: #print("Got a ref of ".(ref($elem))." skipping.");
3993: } else {
3994: $result.=&escape($elem).'&';
3995: }
3996: }
3997: $result=~s/\&$//;
3998: $result .= '__END_ARRAY_REF__';
3999: return $result;
4000: }
4001:
4002: sub hash2str {
4003: my (%hash) = @_;
4004: my $result=&hashref2str(\%hash);
4005: $result=~s/^__HASH_REF__//;
4006: $result=~s/__END_HASH_REF__$//;
4007: return $result;
4008: }
4009:
4010: sub hashref2str {
4011: my ($hashref)=@_;
4012: my $result='__HASH_REF__';
4013: foreach my $key (sort(keys(%$hashref))) {
4014: if (ref($key) eq 'ARRAY') {
4015: $result.=&arrayref2str($key).'=';
4016: } elsif (ref($key) eq 'HASH') {
4017: $result.=&hashref2str($key).'=';
4018: } elsif (ref($key)) {
4019: $result.='=';
4020: #print("Got a ref of ".(ref($key))." skipping.");
4021: } else {
4022: if (defined($key)) {$result.=&escape($key).'=';} else { last; }
4023: }
4024:
4025: if(ref($hashref->{$key}) eq 'ARRAY') {
4026: $result.=&arrayref2str($hashref->{$key}).'&';
4027: } elsif(ref($hashref->{$key}) eq 'HASH') {
4028: $result.=&hashref2str($hashref->{$key}).'&';
4029: } elsif(ref($hashref->{$key})) {
4030: $result.='&';
4031: #print("Got a ref of ".(ref($hashref->{$key}))." skipping.");
4032: } else {
4033: $result.=&escape($hashref->{$key}).'&';
4034: }
4035: }
4036: $result=~s/\&$//;
4037: $result .= '__END_HASH_REF__';
4038: return $result;
4039: }
4040:
4041: sub str2hash {
4042: my ($string)=@_;
4043: my ($hash)=&str2hashref('__HASH_REF__'.$string.'__END_HASH_REF__');
4044: return %$hash;
4045: }
4046:
4047: sub str2hashref {
4048: my ($string) = @_;
4049:
4050: my %hash;
4051:
4052: if($string !~ /^__HASH_REF__/) {
4053: if (! ($string eq '' || !defined($string))) {
4054: $hash{'error'}='Not hash reference';
4055: }
4056: return (\%hash, $string);
4057: }
4058:
4059: $string =~ s/^__HASH_REF__//;
4060:
4061: while($string !~ /^__END_HASH_REF__/) {
4062: #key
4063: my $key='';
4064: if($string =~ /^__HASH_REF__/) {
4065: ($key, $string)=&str2hashref($string);
4066: if(defined($key->{'error'})) {
4067: $hash{'error'}='Bad data';
4068: return (\%hash, $string);
4069: }
4070: } elsif($string =~ /^__ARRAY_REF__/) {
4071: ($key, $string)=&str2arrayref($string);
4072: if($key->[0] eq 'Array reference error') {
4073: $hash{'error'}='Bad data';
4074: return (\%hash, $string);
4075: }
4076: } else {
4077: $string =~ s/^(.*?)=//;
4078: $key=&unescape($1);
4079: }
4080: $string =~ s/^=//;
4081:
4082: #value
4083: my $value='';
4084: if($string =~ /^__HASH_REF__/) {
4085: ($value, $string)=&str2hashref($string);
4086: if(defined($value->{'error'})) {
4087: $hash{'error'}='Bad data';
4088: return (\%hash, $string);
4089: }
4090: } elsif($string =~ /^__ARRAY_REF__/) {
4091: ($value, $string)=&str2arrayref($string);
4092: if($value->[0] eq 'Array reference error') {
4093: $hash{'error'}='Bad data';
4094: return (\%hash, $string);
4095: }
4096: } else {
4097: $value=&get_scalar(\$string,'__END_HASH_REF__');
4098: }
4099: $string =~ s/^&//;
4100:
4101: $hash{$key}=$value;
4102: }
4103:
4104: $string =~ s/^__END_HASH_REF__//;
4105:
4106: return (\%hash, $string);
4107: }
4108:
4109: sub str2array {
4110: my ($string)=@_;
4111: my ($array)=&str2arrayref('__ARRAY_REF__'.$string.'__END_ARRAY_REF__');
4112: return @$array;
4113: }
4114:
4115: sub str2arrayref {
4116: my ($string) = @_;
4117: my @array;
4118:
4119: if($string !~ /^__ARRAY_REF__/) {
4120: if (! ($string eq '' || !defined($string))) {
4121: $array[0]='Array reference error';
4122: }
4123: return (\@array, $string);
4124: }
4125:
4126: $string =~ s/^__ARRAY_REF__//;
4127:
4128: while($string !~ /^__END_ARRAY_REF__/) {
4129: my $value='';
4130: if($string =~ /^__HASH_REF__/) {
4131: ($value, $string)=&str2hashref($string);
4132: if(defined($value->{'error'})) {
4133: $array[0] ='Array reference error';
4134: return (\@array, $string);
4135: }
4136: } elsif($string =~ /^__ARRAY_REF__/) {
4137: ($value, $string)=&str2arrayref($string);
4138: if($value->[0] eq 'Array reference error') {
4139: $array[0] ='Array reference error';
4140: return (\@array, $string);
4141: }
4142: } else {
4143: $value=&get_scalar(\$string,'__END_ARRAY_REF__');
4144: }
4145: $string =~ s/^&//;
4146:
4147: push(@array, $value);
4148: }
4149:
4150: $string =~ s/^__END_ARRAY_REF__//;
4151:
4152: return (\@array, $string);
4153: }
4154:
4155: # -------------------------------------------------------------------Temp Store
4156:
4157: sub tmpreset {
4158: my ($symb,$namespace,$domain,$stuname) = @_;
4159: if (!$symb) {
4160: $symb=&symbread();
4161: if (!$symb) { $symb= $env{'request.url'}; }
4162: }
4163: $symb=escape($symb);
4164:
4165: if (!$namespace) { $namespace=$env{'request.state'}; }
4166: $namespace=~s/\//\_/g;
4167: $namespace=~s/\W//g;
4168:
4169: if (!$domain) { $domain=$env{'user.domain'}; }
4170: if (!$stuname) { $stuname=$env{'user.name'}; }
4171: if ($domain eq 'public' && $stuname eq 'public') {
4172: $stuname=$ENV{'REMOTE_ADDR'};
4173: }
4174: my $path=LONCAPA::tempdir();
4175: my %hash;
4176: if (tie(%hash,'GDBM_File',
4177: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
4178: &GDBM_WRCREAT(),0640)) {
4179: foreach my $key (keys(%hash)) {
4180: if ($key=~ /:$symb/) {
4181: delete($hash{$key});
4182: }
4183: }
4184: }
4185: }
4186:
4187: sub tmpstore {
4188: my ($storehash,$symb,$namespace,$domain,$stuname) = @_;
4189:
4190: if (!$symb) {
4191: $symb=&symbread();
4192: if (!$symb) { $symb= $env{'request.url'}; }
4193: }
4194: $symb=escape($symb);
4195:
4196: if (!$namespace) {
4197: # I don't think we would ever want to store this for a course.
4198: # it seems this will only be used if we don't have a course.
4199: #$namespace=$env{'request.course.id'};
4200: #if (!$namespace) {
4201: $namespace=$env{'request.state'};
4202: #}
4203: }
4204: $namespace=~s/\//\_/g;
4205: $namespace=~s/\W//g;
4206: if (!$domain) { $domain=$env{'user.domain'}; }
4207: if (!$stuname) { $stuname=$env{'user.name'}; }
4208: if ($domain eq 'public' && $stuname eq 'public') {
4209: $stuname=$ENV{'REMOTE_ADDR'};
4210: }
4211: my $now=time;
4212: my %hash;
4213: my $path=LONCAPA::tempdir();
4214: if (tie(%hash,'GDBM_File',
4215: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
4216: &GDBM_WRCREAT(),0640)) {
4217: $hash{"version:$symb"}++;
4218: my $version=$hash{"version:$symb"};
4219: my $allkeys='';
4220: foreach my $key (keys(%$storehash)) {
4221: $allkeys.=$key.':';
4222: $hash{"$version:$symb:$key"}=&freeze_escape($$storehash{$key});
4223: }
4224: $hash{"$version:$symb:timestamp"}=$now;
4225: $allkeys.='timestamp';
4226: $hash{"$version:keys:$symb"}=$allkeys;
4227: if (untie(%hash)) {
4228: return 'ok';
4229: } else {
4230: return "error:$!";
4231: }
4232: } else {
4233: return "error:$!";
4234: }
4235: }
4236:
4237: # -----------------------------------------------------------------Temp Restore
4238:
4239: sub tmprestore {
4240: my ($symb,$namespace,$domain,$stuname) = @_;
4241:
4242: if (!$symb) {
4243: $symb=&symbread();
4244: if (!$symb) { $symb= $env{'request.url'}; }
4245: }
4246: $symb=escape($symb);
4247:
4248: if (!$namespace) { $namespace=$env{'request.state'}; }
4249:
4250: if (!$domain) { $domain=$env{'user.domain'}; }
4251: if (!$stuname) { $stuname=$env{'user.name'}; }
4252: if ($domain eq 'public' && $stuname eq 'public') {
4253: $stuname=$ENV{'REMOTE_ADDR'};
4254: }
4255: my %returnhash;
4256: $namespace=~s/\//\_/g;
4257: $namespace=~s/\W//g;
4258: my %hash;
4259: my $path=LONCAPA::tempdir();
4260: if (tie(%hash,'GDBM_File',
4261: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
4262: &GDBM_READER(),0640)) {
4263: my $version=$hash{"version:$symb"};
4264: $returnhash{'version'}=$version;
4265: my $scope;
4266: for ($scope=1;$scope<=$version;$scope++) {
4267: my $vkeys=$hash{"$scope:keys:$symb"};
4268: my @keys=split(/:/,$vkeys);
4269: my $key;
4270: $returnhash{"$scope:keys"}=$vkeys;
4271: foreach $key (@keys) {
4272: $returnhash{"$scope:$key"}=&thaw_unescape($hash{"$scope:$symb:$key"});
4273: $returnhash{"$key"}=&thaw_unescape($hash{"$scope:$symb:$key"});
4274: }
4275: }
4276: if (!(untie(%hash))) {
4277: return "error:$!";
4278: }
4279: } else {
4280: return "error:$!";
4281: }
4282: return %returnhash;
4283: }
4284:
4285: # ----------------------------------------------------------------------- Store
4286:
4287: sub store {
4288: my ($storehash,$symb,$namespace,$domain,$stuname) = @_;
4289: my $home='';
4290:
4291: if ($stuname) { $home=&homeserver($stuname,$domain); }
4292:
4293: $symb=&symbclean($symb);
4294: if (!$symb) { unless ($symb=&symbread()) { return ''; } }
4295:
4296: if (!$domain) { $domain=$env{'user.domain'}; }
4297: if (!$stuname) { $stuname=$env{'user.name'}; }
4298:
4299: &devalidate($symb,$stuname,$domain);
4300:
4301: $symb=escape($symb);
4302: if (!$namespace) {
4303: unless ($namespace=$env{'request.course.id'}) {
4304: return '';
4305: }
4306: }
4307: if (!$home) { $home=$env{'user.home'}; }
4308:
4309: $$storehash{'ip'}=$ENV{'REMOTE_ADDR'};
4310: $$storehash{'host'}=$perlvar{'lonHostID'};
4311:
4312: my $namevalue='';
4313: foreach my $key (keys(%$storehash)) {
4314: $namevalue.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
4315: }
4316: $namevalue=~s/\&$//;
4317: &courselog($symb.':'.$stuname.':'.$domain.':STORE:'.$namevalue);
4318: return reply("store:$domain:$stuname:$namespace:$symb:$namevalue","$home");
4319: }
4320:
4321: # -------------------------------------------------------------- Critical Store
4322:
4323: sub cstore {
4324: my ($storehash,$symb,$namespace,$domain,$stuname) = @_;
4325: my $home='';
4326:
4327: if ($stuname) { $home=&homeserver($stuname,$domain); }
4328:
4329: $symb=&symbclean($symb);
4330: if (!$symb) { unless ($symb=&symbread()) { return ''; } }
4331:
4332: if (!$domain) { $domain=$env{'user.domain'}; }
4333: if (!$stuname) { $stuname=$env{'user.name'}; }
4334:
4335: &devalidate($symb,$stuname,$domain);
4336:
4337: $symb=escape($symb);
4338: if (!$namespace) {
4339: unless ($namespace=$env{'request.course.id'}) {
4340: return '';
4341: }
4342: }
4343: if (!$home) { $home=$env{'user.home'}; }
4344:
4345: $$storehash{'ip'}=$ENV{'REMOTE_ADDR'};
4346: $$storehash{'host'}=$perlvar{'lonHostID'};
4347:
4348: my $namevalue='';
4349: foreach my $key (keys(%$storehash)) {
4350: $namevalue.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
4351: }
4352: $namevalue=~s/\&$//;
4353: &courselog($symb.':'.$stuname.':'.$domain.':CSTORE:'.$namevalue);
4354: return critical
4355: ("store:$domain:$stuname:$namespace:$symb:$namevalue","$home");
4356: }
4357:
4358: # --------------------------------------------------------------------- Restore
4359:
4360: sub restore {
4361: my ($symb,$namespace,$domain,$stuname) = @_;
4362: my $home='';
4363:
4364: if ($stuname) { $home=&homeserver($stuname,$domain); }
4365:
4366: if (!$symb) {
4367: unless ($symb=escape(&symbread())) { return ''; }
4368: } else {
4369: $symb=&escape(&symbclean($symb));
4370: }
4371: if (!$namespace) {
4372: unless ($namespace=$env{'request.course.id'}) {
4373: return '';
4374: }
4375: }
4376: if (!$domain) { $domain=$env{'user.domain'}; }
4377: if (!$stuname) { $stuname=$env{'user.name'}; }
4378: if (!$home) { $home=$env{'user.home'}; }
4379: my $answer=&reply("restore:$domain:$stuname:$namespace:$symb","$home");
4380:
4381: my %returnhash=();
4382: foreach my $line (split(/\&/,$answer)) {
4383: my ($name,$value)=split(/\=/,$line);
4384: $returnhash{&unescape($name)}=&thaw_unescape($value);
4385: }
4386: my $version;
4387: for ($version=1;$version<=$returnhash{'version'};$version++) {
4388: foreach my $item (split(/\:/,$returnhash{$version.':keys'})) {
4389: $returnhash{$item}=$returnhash{$version.':'.$item};
4390: }
4391: }
4392: return %returnhash;
4393: }
4394:
4395: # ---------------------------------------------------------- Course Description
4396: #
4397: #
4398:
4399: sub coursedescription {
4400: my ($courseid,$args)=@_;
4401: $courseid=~s/^\///;
4402: $courseid=~s/\_/\//g;
4403: my ($cdomain,$cnum)=split(/\//,$courseid);
4404: my $chome=&homeserver($cnum,$cdomain);
4405: my $normalid=$cdomain.'_'.$cnum;
4406: # need to always cache even if we get errors otherwise we keep
4407: # trying and trying and trying to get the course description.
4408: my %envhash=();
4409: my %returnhash=();
4410:
4411: my $expiretime=600;
4412: if ($env{'request.course.id'} eq $normalid) {
4413: $expiretime=120;
4414: }
4415:
4416: my $prefix='course.'.$cdomain.'_'.$cnum.'.';
4417: if (!$args->{'freshen_cache'}
4418: && ((time-$env{$prefix.'last_cache'}) < $expiretime) ) {
4419: foreach my $key (keys(%env)) {
4420: next if ($key !~ /^\Q$prefix\E(.*)/);
4421: my ($setting) = $1;
4422: $returnhash{$setting} = $env{$key};
4423: }
4424: return %returnhash;
4425: }
4426:
4427: # get the data again
4428:
4429: if (!$args->{'one_time'}) {
4430: $envhash{'course.'.$normalid.'.last_cache'}=time;
4431: }
4432:
4433: if ($chome ne 'no_host') {
4434: %returnhash=&dump('environment',$cdomain,$cnum);
4435: if (!exists($returnhash{'con_lost'})) {
4436: my $username = $env{'user.name'}; # Defult username
4437: if(defined $args->{'user'}) {
4438: $username = $args->{'user'};
4439: }
4440: $returnhash{'home'}= $chome;
4441: $returnhash{'domain'} = $cdomain;
4442: $returnhash{'num'} = $cnum;
4443: if (!defined($returnhash{'type'})) {
4444: $returnhash{'type'} = 'Course';
4445: }
4446: while (my ($name,$value) = each %returnhash) {
4447: $envhash{'course.'.$normalid.'.'.$name}=$value;
4448: }
4449: $returnhash{'url'}=&clutter($returnhash{'url'});
4450: $returnhash{'fn'}=LONCAPA::tempdir() .
4451: $username.'_'.$cdomain.'_'.$cnum;
4452: $envhash{'course.'.$normalid.'.home'}=$chome;
4453: $envhash{'course.'.$normalid.'.domain'}=$cdomain;
4454: $envhash{'course.'.$normalid.'.num'}=$cnum;
4455: }
4456: }
4457: if (!$args->{'one_time'}) {
4458: &appenv(\%envhash);
4459: }
4460: return %returnhash;
4461: }
4462:
4463: sub update_released_required {
4464: my ($needsrelease,$cdom,$cnum,$chome,$cid) = @_;
4465: if ($cdom eq '' || $cnum eq '' || $chome eq '' || $cid eq '') {
4466: $cid = $env{'request.course.id'};
4467: $cdom = $env{'course.'.$cid.'.domain'};
4468: $cnum = $env{'course.'.$cid.'.num'};
4469: $chome = $env{'course.'.$cid.'.home'};
4470: }
4471: if ($needsrelease) {
4472: my %curr_reqd_hash = &userenvironment($cdom,$cnum,'internal.releaserequired');
4473: my $needsupdate;
4474: if ($curr_reqd_hash{'internal.releaserequired'} eq '') {
4475: $needsupdate = 1;
4476: } else {
4477: my ($currmajor,$currminor) = split(/\./,$curr_reqd_hash{'internal.releaserequired'});
4478: my ($needsmajor,$needsminor) = split(/\./,$needsrelease);
4479: if (($currmajor < $needsmajor) || ($currmajor == $needsmajor && $currminor < $needsminor)) {
4480: $needsupdate = 1;
4481: }
4482: }
4483: if ($needsupdate) {
4484: my %needshash = (
4485: 'internal.releaserequired' => $needsrelease,
4486: );
4487: my $putresult = &put('environment',\%needshash,$cdom,$cnum);
4488: if ($putresult eq 'ok') {
4489: &appenv({'course.'.$cid.'.internal.releaserequired' => $needsrelease});
4490: my %crsinfo = &courseiddump($cdom,'.',1,'.','.',$cnum,undef,undef,'.');
4491: if (ref($crsinfo{$cid}) eq 'HASH') {
4492: $crsinfo{$cid}{'releaserequired'} = $needsrelease;
4493: &courseidput($cdom,\%crsinfo,$chome,'notime');
4494: }
4495: }
4496: }
4497: }
4498: return;
4499: }
4500:
4501: # -------------------------------------------------See if a user is privileged
4502:
4503: sub privileged {
4504: my ($username,$domain)=@_;
4505: my $rolesdump=&reply("dump:$domain:$username:roles",
4506: &homeserver($username,$domain));
4507: if (($rolesdump eq 'con_lost') || ($rolesdump eq '') ||
4508: ($rolesdump =~ /^error:/)) {
4509: return 0;
4510: }
4511: my $now=time;
4512: if ($rolesdump ne '') {
4513: foreach my $entry (split(/&/,$rolesdump)) {
4514: if ($entry!~/^rolesdef_/) {
4515: my ($area,$role)=split(/=/,$entry);
4516: $area=~s/\_\w\w$//;
4517: my ($trole,$tend,$tstart)=split(/_/,$role);
4518: if (($trole eq 'dc') || ($trole eq 'su')) {
4519: my $active=1;
4520: if ($tend) {
4521: if ($tend<$now) { $active=0; }
4522: }
4523: if ($tstart) {
4524: if ($tstart>$now) { $active=0; }
4525: }
4526: if ($active) { return 1; }
4527: }
4528: }
4529: }
4530: }
4531: return 0;
4532: }
4533:
4534: # -------------------------------------------------------- Get user privileges
4535:
4536: sub rolesinit {
4537: my ($domain,$username,$authhost)=@_;
4538: my $now=time;
4539: my %userroles = ('user.login.time' => $now);
4540: my $extra = &freeze_escape({'skipcheck' => 1});
4541: my $rolesdump=reply("dump:$domain:$username:roles:.::$extra",$authhost);
4542: if (($rolesdump eq 'con_lost') || ($rolesdump eq '') ||
4543: ($rolesdump =~ /^error:/)) {
4544: return \%userroles;
4545: }
4546: my %allroles=();
4547: my %allgroups=();
4548:
4549: if ($rolesdump ne '') {
4550: foreach my $entry (split(/&/,$rolesdump)) {
4551: if ($entry!~/^rolesdef_/) {
4552: my ($area,$role)=split(/=/,$entry);
4553: $area=~s/\_\w\w$//;
4554: my ($trole,$tend,$tstart,$group_privs);
4555: if ($role=~/^cr/) {
4556: if ($role=~m|^(cr/$match_domain/$match_username/[a-zA-Z0-9]+)_(.*)$|) {
4557: ($trole,my $trest)=($role=~m|^(cr/$match_domain/$match_username/[a-zA-Z0-9]+)_(.*)$|);
4558: ($tend,$tstart)=split('_',$trest);
4559: } else {
4560: $trole=$role;
4561: }
4562: } elsif ($role =~ m|^gr/|) {
4563: ($trole,$tend,$tstart) = split(/_/,$role);
4564: next if ($tstart eq '-1');
4565: ($trole,$group_privs) = split(/\//,$trole);
4566: $group_privs = &unescape($group_privs);
4567: } else {
4568: ($trole,$tend,$tstart)=split(/_/,$role);
4569: }
4570: my %new_role = &set_arearole($trole,$area,$tstart,$tend,$domain,
4571: $username);
4572: @userroles{keys(%new_role)} = @new_role{keys(%new_role)};
4573: if (($tend!=0) && ($tend<$now)) { $trole=''; }
4574: if (($tstart!=0) && ($tstart>$now)) { $trole=''; }
4575: if (($area ne '') && ($trole ne '')) {
4576: my $spec=$trole.'.'.$area;
4577: my ($tdummy,$tdomain,$trest)=split(/\//,$area);
4578: if ($trole =~ /^cr\//) {
4579: &custom_roleprivs(\%allroles,$trole,$tdomain,$trest,$spec,$area);
4580: } elsif ($trole eq 'gr') {
4581: &group_roleprivs(\%allgroups,$area,$group_privs,$tend,$tstart);
4582: } else {
4583: &standard_roleprivs(\%allroles,$trole,$tdomain,$spec,$trest,$area);
4584: }
4585: }
4586: }
4587: }
4588: my ($author,$adv) = &set_userprivs(\%userroles,\%allroles,\%allgroups);
4589: $userroles{'user.adv'} = $adv;
4590: $userroles{'user.author'} = $author;
4591: $env{'user.adv'}=$adv;
4592: }
4593: return \%userroles;
4594: }
4595:
4596: sub set_arearole {
4597: my ($trole,$area,$tstart,$tend,$domain,$username) = @_;
4598: # log the associated role with the area
4599: &userrolelog($trole,$username,$domain,$area,$tstart,$tend);
4600: return ('user.role.'.$trole.'.'.$area => $tstart.'.'.$tend);
4601: }
4602:
4603: sub custom_roleprivs {
4604: my ($allroles,$trole,$tdomain,$trest,$spec,$area) = @_;
4605: my ($rdummy,$rdomain,$rauthor,$rrole)=split(/\//,$trole);
4606: my $homsvr=homeserver($rauthor,$rdomain);
4607: if (&hostname($homsvr) ne '') {
4608: my ($rdummy,$roledef)=
4609: &get('roles',["rolesdef_$rrole"],$rdomain,$rauthor);
4610: if (($rdummy ne 'con_lost') && ($roledef ne '')) {
4611: my ($syspriv,$dompriv,$coursepriv)=split(/\_/,$roledef);
4612: if (defined($syspriv)) {
4613: if ($trest =~ /^$match_community$/) {
4614: $syspriv =~ s/bre\&S//;
4615: }
4616: $$allroles{'cm./'}.=':'.$syspriv;
4617: $$allroles{$spec.'./'}.=':'.$syspriv;
4618: }
4619: if ($tdomain ne '') {
4620: if (defined($dompriv)) {
4621: $$allroles{'cm./'.$tdomain.'/'}.=':'.$dompriv;
4622: $$allroles{$spec.'./'.$tdomain.'/'}.=':'.$dompriv;
4623: }
4624: if (($trest ne '') && (defined($coursepriv))) {
4625: $$allroles{'cm.'.$area}.=':'.$coursepriv;
4626: $$allroles{$spec.'.'.$area}.=':'.$coursepriv;
4627: }
4628: }
4629: }
4630: }
4631: }
4632:
4633: sub group_roleprivs {
4634: my ($allgroups,$area,$group_privs,$tend,$tstart) = @_;
4635: my $access = 1;
4636: my $now = time;
4637: if (($tend!=0) && ($tend<$now)) { $access = 0; }
4638: if (($tstart!=0) && ($tstart>$now)) { $access=0; }
4639: if ($access) {
4640: my ($course,$group) = ($area =~ m|(/$match_domain/$match_courseid)/([^/]+)$|);
4641: $$allgroups{$course}{$group} .=':'.$group_privs;
4642: }
4643: }
4644:
4645: sub standard_roleprivs {
4646: my ($allroles,$trole,$tdomain,$spec,$trest,$area) = @_;
4647: if (defined($pr{$trole.':s'})) {
4648: $$allroles{'cm./'}.=':'.$pr{$trole.':s'};
4649: $$allroles{$spec.'./'}.=':'.$pr{$trole.':s'};
4650: }
4651: if ($tdomain ne '') {
4652: if (defined($pr{$trole.':d'})) {
4653: $$allroles{'cm./'.$tdomain.'/'}.=':'.$pr{$trole.':d'};
4654: $$allroles{$spec.'./'.$tdomain.'/'}.=':'.$pr{$trole.':d'};
4655: }
4656: if (($trest ne '') && (defined($pr{$trole.':c'}))) {
4657: $$allroles{'cm.'.$area}.=':'.$pr{$trole.':c'};
4658: $$allroles{$spec.'.'.$area}.=':'.$pr{$trole.':c'};
4659: }
4660: }
4661: }
4662:
4663: sub set_userprivs {
4664: my ($userroles,$allroles,$allgroups,$groups_roles) = @_;
4665: my $author=0;
4666: my $adv=0;
4667: my %grouproles = ();
4668: if (keys(%{$allgroups}) > 0) {
4669: my @groupkeys;
4670: foreach my $role (keys(%{$allroles})) {
4671: push(@groupkeys,$role);
4672: }
4673: if (ref($groups_roles) eq 'HASH') {
4674: foreach my $key (keys(%{$groups_roles})) {
4675: unless (grep(/^\Q$key\E$/,@groupkeys)) {
4676: push(@groupkeys,$key);
4677: }
4678: }
4679: }
4680: if (@groupkeys > 0) {
4681: foreach my $role (@groupkeys) {
4682: my ($trole,$area,$sec,$extendedarea);
4683: if ($role =~ m-^(\w+|cr/$match_domain/$match_username/\w+)\.(/$match_domain/$match_courseid)(/?\w*)\.-) {
4684: $trole = $1;
4685: $area = $2;
4686: $sec = $3;
4687: $extendedarea = $area.$sec;
4688: if (exists($$allgroups{$area})) {
4689: foreach my $group (keys(%{$$allgroups{$area}})) {
4690: my $spec = $trole.'.'.$extendedarea;
4691: $grouproles{$spec.'.'.$area.'/'.$group} =
4692: $$allgroups{$area}{$group};
4693: }
4694: }
4695: }
4696: }
4697: }
4698: }
4699: foreach my $group (keys(%grouproles)) {
4700: $$allroles{$group} = $grouproles{$group};
4701: }
4702: foreach my $role (keys(%{$allroles})) {
4703: my %thesepriv;
4704: if (($role=~/^au/) || ($role=~/^ca/) || ($role=~/^aa/)) { $author=1; }
4705: foreach my $item (split(/:/,$$allroles{$role})) {
4706: if ($item ne '') {
4707: my ($privilege,$restrictions)=split(/&/,$item);
4708: if ($restrictions eq '') {
4709: $thesepriv{$privilege}='F';
4710: } elsif ($thesepriv{$privilege} ne 'F') {
4711: $thesepriv{$privilege}.=$restrictions;
4712: }
4713: if ($thesepriv{'adv'} eq 'F') { $adv=1; }
4714: }
4715: }
4716: my $thesestr='';
4717: foreach my $priv (sort(keys(%thesepriv))) {
4718: $thesestr.=':'.$priv.'&'.$thesepriv{$priv};
4719: }
4720: $userroles->{'user.priv.'.$role} = $thesestr;
4721: }
4722: return ($author,$adv);
4723: }
4724:
4725: sub role_status {
4726: my ($rolekey,$update,$refresh,$now,$role,$where,$trolecode,$tstatus,$tstart,$tend) = @_;
4727: my @pwhere = ();
4728: if (exists($env{$rolekey}) && $env{$rolekey} ne '') {
4729: (undef,undef,$$role,@pwhere)=split(/\./,$rolekey);
4730: unless (!defined($$role) || $$role eq '') {
4731: $$where=join('.',@pwhere);
4732: $$trolecode=$$role.'.'.$$where;
4733: ($$tstart,$$tend)=split(/\./,$env{$rolekey});
4734: $$tstatus='is';
4735: if ($$tstart && $$tstart>$update) {
4736: $$tstatus='future';
4737: if ($$tstart<$now) {
4738: if ($$tstart && $$tstart>$refresh) {
4739: if (($$where ne '') && ($$role ne '')) {
4740: my (%allroles,%allgroups,$group_privs,
4741: %groups_roles,@rolecodes);
4742: my %userroles = (
4743: 'user.role.'.$$role.'.'.$$where => $$tstart.'.'.$$tend
4744: );
4745: @rolecodes = ('cm');
4746: my $spec=$$role.'.'.$$where;
4747: my ($tdummy,$tdomain,$trest)=split(/\//,$$where);
4748: if ($$role =~ /^cr\//) {
4749: &custom_roleprivs(\%allroles,$$role,$tdomain,$trest,$spec,$$where);
4750: push(@rolecodes,'cr');
4751: } elsif ($$role eq 'gr') {
4752: push(@rolecodes,$$role);
4753: my %rolehash = &get('roles',[$$where.'_'.$$role],$env{'user.domain'},
4754: $env{'user.name'});
4755: my ($trole) = split('_',$rolehash{$$where.'_'.$$role},2);
4756: (undef,my $group_privs) = split(/\//,$trole);
4757: $group_privs = &unescape($group_privs);
4758: &group_roleprivs(\%allgroups,$$where,$group_privs,$$tend,$$tstart);
4759: my %course_roles = &get_my_roles($env{'user.name'},$env{'user.domain'},'userroles',['active'],['cc','co','in','ta','ep','ad','st','cr'],[$tdomain],1);
4760: &get_groups_roles($tdomain,$trest,
4761: \%course_roles,\@rolecodes,
4762: \%groups_roles);
4763: } else {
4764: push(@rolecodes,$$role);
4765: &standard_roleprivs(\%allroles,$$role,$tdomain,$spec,$trest,$$where);
4766: }
4767: my ($author,$adv)= &set_userprivs(\%userroles,\%allroles,\%allgroups,\%groups_roles);
4768: &appenv(\%userroles,\@rolecodes);
4769: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},"Role ".$role);
4770: }
4771: }
4772: $$tstatus = 'is';
4773: }
4774: }
4775: if ($$tend) {
4776: if ($$tend<$update) {
4777: $$tstatus='expired';
4778: } elsif ($$tend<$now) {
4779: $$tstatus='will_not';
4780: }
4781: }
4782: }
4783: }
4784: }
4785:
4786: sub get_groups_roles {
4787: my ($cdom,$rest,$cdom_courseroles,$rolecodes,$groups_roles) = @_;
4788: return unless((ref($cdom_courseroles) eq 'HASH') &&
4789: (ref($rolecodes) eq 'ARRAY') &&
4790: (ref($groups_roles) eq 'HASH'));
4791: if (keys(%{$cdom_courseroles}) > 0) {
4792: my ($cnum) = ($rest =~ /^($match_courseid)/);
4793: if ($cdom ne '' && $cnum ne '') {
4794: foreach my $key (keys(%{$cdom_courseroles})) {
4795: if ($key =~ /^\Q$cnum\E:\Q$cdom\E:([^:]+):?([^:]*)/) {
4796: my $crsrole = $1;
4797: my $crssec = $2;
4798: if ($crsrole =~ /^cr/) {
4799: unless (grep(/^cr$/,@{$rolecodes})) {
4800: push(@{$rolecodes},'cr');
4801: }
4802: } else {
4803: unless(grep(/^\Q$crsrole\E$/,@{$rolecodes})) {
4804: push(@{$rolecodes},$crsrole);
4805: }
4806: }
4807: my $rolekey = "$crsrole./$cdom/$cnum";
4808: if ($crssec ne '') {
4809: $rolekey .= "/$crssec";
4810: }
4811: $rolekey .= './';
4812: $groups_roles->{$rolekey} = $rolecodes;
4813: }
4814: }
4815: }
4816: }
4817: return;
4818: }
4819:
4820: sub delete_env_groupprivs {
4821: my ($where,$courseroles,$possroles) = @_;
4822: return unless((ref($courseroles) eq 'HASH') && (ref($possroles) eq 'ARRAY'));
4823: my ($dummy,$udom,$uname,$group) = split(/\//,$where);
4824: unless (ref($courseroles->{$udom}) eq 'HASH') {
4825: %{$courseroles->{$udom}} =
4826: &get_my_roles('','','userroles',['active'],
4827: $possroles,[$udom],1);
4828: }
4829: if (ref($courseroles->{$udom}) eq 'HASH') {
4830: foreach my $item (keys(%{$courseroles->{$udom}})) {
4831: my ($cnum,$cdom,$crsrole,$crssec) = split(/:/,$item);
4832: my $area = '/'.$cdom.'/'.$cnum;
4833: my $privkey = "user.priv.$crsrole.$area";
4834: if ($crssec ne '') {
4835: $privkey .= '/'.$crssec;
4836: }
4837: $privkey .= ".$area/$group";
4838: &Apache::lonnet::delenv($privkey,undef,[$crsrole]);
4839: }
4840: }
4841: return;
4842: }
4843:
4844: sub check_adhoc_privs {
4845: my ($cdom,$cnum,$update,$refresh,$now,$checkrole,$caller) = @_;
4846: my $cckey = 'user.role.'.$checkrole.'./'.$cdom.'/'.$cnum;
4847: if ($env{$cckey}) {
4848: my ($role,$where,$trolecode,$tstart,$tend,$tremark,$tstatus,$tpstart,$tpend);
4849: &role_status($cckey,$update,$refresh,$now,\$role,\$where,\$trolecode,\$tstatus,\$tstart,\$tend);
4850: unless (($tstatus eq 'is') || ($tstatus eq 'will_not')) {
4851: &set_adhoc_privileges($cdom,$cnum,$checkrole,$caller);
4852: }
4853: } else {
4854: &set_adhoc_privileges($cdom,$cnum,$checkrole,$caller);
4855: }
4856: }
4857:
4858: sub set_adhoc_privileges {
4859: # role can be cc or ca
4860: my ($dcdom,$pickedcourse,$role,$caller) = @_;
4861: my $area = '/'.$dcdom.'/'.$pickedcourse;
4862: my $spec = $role.'.'.$area;
4863: my %userroles = &set_arearole($role,$area,'','',$env{'user.domain'},
4864: $env{'user.name'});
4865: my %ccrole = ();
4866: &standard_roleprivs(\%ccrole,$role,$dcdom,$spec,$pickedcourse,$area);
4867: my ($author,$adv)= &set_userprivs(\%userroles,\%ccrole);
4868: &appenv(\%userroles,[$role,'cm']);
4869: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},"Role ".$role);
4870: unless ($caller eq 'constructaccess' && $env{'request.course.id'}) {
4871: &appenv( {'request.role' => $spec,
4872: 'request.role.domain' => $dcdom,
4873: 'request.course.sec' => ''
4874: }
4875: );
4876: my $tadv=0;
4877: if (&allowed('adv') eq 'F') { $tadv=1; }
4878: &appenv({'request.role.adv' => $tadv});
4879: }
4880: }
4881:
4882: # --------------------------------------------------------------- get interface
4883:
4884: sub get {
4885: my ($namespace,$storearr,$udomain,$uname)=@_;
4886: my $items='';
4887: foreach my $item (@$storearr) {
4888: $items.=&escape($item).'&';
4889: }
4890: $items=~s/\&$//;
4891: if (!$udomain) { $udomain=$env{'user.domain'}; }
4892: if (!$uname) { $uname=$env{'user.name'}; }
4893: my $uhome=&homeserver($uname,$udomain);
4894:
4895: my $rep=&reply("get:$udomain:$uname:$namespace:$items",$uhome);
4896: my @pairs=split(/\&/,$rep);
4897: if ( $#pairs==0 && $pairs[0] =~ /^(con_lost|error|no_such_host)/i) {
4898: return @pairs;
4899: }
4900: my %returnhash=();
4901: my $i=0;
4902: foreach my $item (@$storearr) {
4903: $returnhash{$item}=&thaw_unescape($pairs[$i]);
4904: $i++;
4905: }
4906: return %returnhash;
4907: }
4908:
4909: # --------------------------------------------------------------- del interface
4910:
4911: sub del {
4912: my ($namespace,$storearr,$udomain,$uname)=@_;
4913: my $items='';
4914: foreach my $item (@$storearr) {
4915: $items.=&escape($item).'&';
4916: }
4917:
4918: $items=~s/\&$//;
4919: if (!$udomain) { $udomain=$env{'user.domain'}; }
4920: if (!$uname) { $uname=$env{'user.name'}; }
4921: my $uhome=&homeserver($uname,$udomain);
4922: return &reply("del:$udomain:$uname:$namespace:$items",$uhome);
4923: }
4924:
4925: # -------------------------------------------------------------- dump interface
4926:
4927: sub dump {
4928: my ($namespace,$udomain,$uname,$regexp,$range,$extra)=@_;
4929: if (!$udomain) { $udomain=$env{'user.domain'}; }
4930: if (!$uname) { $uname=$env{'user.name'}; }
4931: my $uhome=&homeserver($uname,$udomain);
4932: if ($regexp) {
4933: $regexp=&escape($regexp);
4934: } else {
4935: $regexp='.';
4936: }
4937: my $rep=&reply("dump:$udomain:$uname:$namespace:$regexp:$range:$extra",$uhome);
4938: my @pairs=split(/\&/,$rep);
4939: my %returnhash=();
4940: if (!($rep =~ /^error/ )) {
4941: foreach my $item (@pairs) {
4942: my ($key,$value)=split(/=/,$item,2);
4943: $key = &unescape($key);
4944: next if ($key =~ /^error: 2 /);
4945: $returnhash{$key}=&thaw_unescape($value);
4946: }
4947: }
4948: return %returnhash;
4949: }
4950:
4951:
4952: # --------------------------------------------------------- dumpstore interface
4953:
4954: sub dumpstore {
4955: my ($namespace,$udomain,$uname,$regexp,$range)=@_;
4956: if (!$udomain) { $udomain=$env{'user.domain'}; }
4957: if (!$uname) { $uname=$env{'user.name'}; }
4958: my $uhome=&homeserver($uname,$udomain);
4959: if ($regexp) {
4960: $regexp=&escape($regexp);
4961: } else {
4962: $regexp='.';
4963: }
4964: my $rep=&reply("dump:$udomain:$uname:$namespace:$regexp:$range",$uhome);
4965: my @pairs=split(/\&/,$rep);
4966: my %returnhash=();
4967: foreach my $item (@pairs) {
4968: my ($key,$value)=split(/=/,$item,2);
4969: next if ($key =~ /^error: 2 /);
4970: $returnhash{$key}=&thaw_unescape($value);
4971: }
4972: return %returnhash;
4973: }
4974:
4975: # -------------------------------------------------------------- keys interface
4976:
4977: sub getkeys {
4978: my ($namespace,$udomain,$uname)=@_;
4979: if (!$udomain) { $udomain=$env{'user.domain'}; }
4980: if (!$uname) { $uname=$env{'user.name'}; }
4981: my $uhome=&homeserver($uname,$udomain);
4982: my $rep=reply("keys:$udomain:$uname:$namespace",$uhome);
4983: my @keyarray=();
4984: foreach my $key (split(/\&/,$rep)) {
4985: next if ($key =~ /^error: 2 /);
4986: push(@keyarray,&unescape($key));
4987: }
4988: return @keyarray;
4989: }
4990:
4991: # --------------------------------------------------------------- currentdump
4992: sub currentdump {
4993: my ($courseid,$sdom,$sname)=@_;
4994: $courseid = $env{'request.course.id'} if (! defined($courseid));
4995: $sdom = $env{'user.domain'} if (! defined($sdom));
4996: $sname = $env{'user.name'} if (! defined($sname));
4997: my $uhome = &homeserver($sname,$sdom);
4998: my $rep=reply('currentdump:'.$sdom.':'.$sname.':'.$courseid,$uhome);
4999: return if ($rep =~ /^(error:|no_such_host)/);
5000: #
5001: my %returnhash=();
5002: #
5003: if ($rep eq "unknown_cmd") {
5004: # an old lond will not know currentdump
5005: # Do a dump and make it look like a currentdump
5006: my @tmp = &dumpstore($courseid,$sdom,$sname,'.');
5007: return if ($tmp[0] =~ /^(error:|no_such_host)/);
5008: my %hash = @tmp;
5009: @tmp=();
5010: %returnhash = %{&convert_dump_to_currentdump(\%hash)};
5011: } else {
5012: my @pairs=split(/\&/,$rep);
5013: foreach my $pair (@pairs) {
5014: my ($key,$value)=split(/=/,$pair,2);
5015: my ($symb,$param) = split(/:/,$key);
5016: $returnhash{&unescape($symb)}->{&unescape($param)} =
5017: &thaw_unescape($value);
5018: }
5019: }
5020: return %returnhash;
5021: }
5022:
5023: sub convert_dump_to_currentdump{
5024: my %hash = %{shift()};
5025: my %returnhash;
5026: # Code ripped from lond, essentially. The only difference
5027: # here is the unescaping done by lonnet::dump(). Conceivably
5028: # we might run in to problems with parameter names =~ /^v\./
5029: while (my ($key,$value) = each(%hash)) {
5030: my ($v,$symb,$param) = split(/:/,$key);
5031: $symb = &unescape($symb);
5032: $param = &unescape($param);
5033: next if ($v eq 'version' || $symb eq 'keys');
5034: next if (exists($returnhash{$symb}) &&
5035: exists($returnhash{$symb}->{$param}) &&
5036: $returnhash{$symb}->{'v.'.$param} > $v);
5037: $returnhash{$symb}->{$param}=$value;
5038: $returnhash{$symb}->{'v.'.$param}=$v;
5039: }
5040: #
5041: # Remove all of the keys in the hashes which keep track of
5042: # the version of the parameter.
5043: while (my ($symb,$param_hash) = each(%returnhash)) {
5044: # use a foreach because we are going to delete from the hash.
5045: foreach my $key (keys(%$param_hash)) {
5046: delete($param_hash->{$key}) if ($key =~ /^v\./);
5047: }
5048: }
5049: return \%returnhash;
5050: }
5051:
5052: # ------------------------------------------------------ critical inc interface
5053:
5054: sub cinc {
5055: return &inc(@_,'critical');
5056: }
5057:
5058: # --------------------------------------------------------------- inc interface
5059:
5060: sub inc {
5061: my ($namespace,$store,$udomain,$uname,$critical) = @_;
5062: if (!$udomain) { $udomain=$env{'user.domain'}; }
5063: if (!$uname) { $uname=$env{'user.name'}; }
5064: my $uhome=&homeserver($uname,$udomain);
5065: my $items='';
5066: if (! ref($store)) {
5067: # got a single value, so use that instead
5068: $items = &escape($store).'=&';
5069: } elsif (ref($store) eq 'SCALAR') {
5070: $items = &escape($$store).'=&';
5071: } elsif (ref($store) eq 'ARRAY') {
5072: $items = join('=&',map {&escape($_);} @{$store});
5073: } elsif (ref($store) eq 'HASH') {
5074: while (my($key,$value) = each(%{$store})) {
5075: $items.= &escape($key).'='.&escape($value).'&';
5076: }
5077: }
5078: $items=~s/\&$//;
5079: if ($critical) {
5080: return &critical("inc:$udomain:$uname:$namespace:$items",$uhome);
5081: } else {
5082: return &reply("inc:$udomain:$uname:$namespace:$items",$uhome);
5083: }
5084: }
5085:
5086: # --------------------------------------------------------------- put interface
5087:
5088: sub put {
5089: my ($namespace,$storehash,$udomain,$uname)=@_;
5090: if (!$udomain) { $udomain=$env{'user.domain'}; }
5091: if (!$uname) { $uname=$env{'user.name'}; }
5092: my $uhome=&homeserver($uname,$udomain);
5093: my $items='';
5094: foreach my $item (keys(%$storehash)) {
5095: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
5096: }
5097: $items=~s/\&$//;
5098: return &reply("put:$udomain:$uname:$namespace:$items",$uhome);
5099: }
5100:
5101: # ------------------------------------------------------------ newput interface
5102:
5103: sub newput {
5104: my ($namespace,$storehash,$udomain,$uname)=@_;
5105: if (!$udomain) { $udomain=$env{'user.domain'}; }
5106: if (!$uname) { $uname=$env{'user.name'}; }
5107: my $uhome=&homeserver($uname,$udomain);
5108: my $items='';
5109: foreach my $key (keys(%$storehash)) {
5110: $items.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
5111: }
5112: $items=~s/\&$//;
5113: return &reply("newput:$udomain:$uname:$namespace:$items",$uhome);
5114: }
5115:
5116: # --------------------------------------------------------- putstore interface
5117:
5118: sub putstore {
5119: my ($namespace,$symb,$version,$storehash,$udomain,$uname)=@_;
5120: if (!$udomain) { $udomain=$env{'user.domain'}; }
5121: if (!$uname) { $uname=$env{'user.name'}; }
5122: my $uhome=&homeserver($uname,$udomain);
5123: my $items='';
5124: foreach my $key (keys(%$storehash)) {
5125: $items.= &escape($key).'='.&freeze_escape($storehash->{$key}).'&';
5126: }
5127: $items=~s/\&$//;
5128: my $esc_symb=&escape($symb);
5129: my $esc_v=&escape($version);
5130: my $reply =
5131: &reply("putstore:$udomain:$uname:$namespace:$esc_symb:$esc_v:$items",
5132: $uhome);
5133: if ($reply eq 'unknown_cmd') {
5134: # gfall back to way things use to be done
5135: return &old_putstore($namespace,$symb,$version,$storehash,$udomain,
5136: $uname);
5137: }
5138: return $reply;
5139: }
5140:
5141: sub old_putstore {
5142: my ($namespace,$symb,$version,$storehash,$udomain,$uname)=@_;
5143: if (!$udomain) { $udomain=$env{'user.domain'}; }
5144: if (!$uname) { $uname=$env{'user.name'}; }
5145: my $uhome=&homeserver($uname,$udomain);
5146: my %newstorehash;
5147: foreach my $item (keys(%$storehash)) {
5148: my $key = $version.':'.&escape($symb).':'.$item;
5149: $newstorehash{$key} = $storehash->{$item};
5150: }
5151: my $items='';
5152: my %allitems = ();
5153: foreach my $item (keys(%newstorehash)) {
5154: if ($item =~ m/^([^\:]+):([^\:]+):([^\:]+)$/) {
5155: my $key = $1.':keys:'.$2;
5156: $allitems{$key} .= $3.':';
5157: }
5158: $items.=$item.'='.&freeze_escape($newstorehash{$item}).'&';
5159: }
5160: foreach my $item (keys(%allitems)) {
5161: $allitems{$item} =~ s/\:$//;
5162: $items.= $item.'='.$allitems{$item}.'&';
5163: }
5164: $items=~s/\&$//;
5165: return &reply("put:$udomain:$uname:$namespace:$items",$uhome);
5166: }
5167:
5168: # ------------------------------------------------------ critical put interface
5169:
5170: sub cput {
5171: my ($namespace,$storehash,$udomain,$uname)=@_;
5172: if (!$udomain) { $udomain=$env{'user.domain'}; }
5173: if (!$uname) { $uname=$env{'user.name'}; }
5174: my $uhome=&homeserver($uname,$udomain);
5175: my $items='';
5176: foreach my $item (keys(%$storehash)) {
5177: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
5178: }
5179: $items=~s/\&$//;
5180: return &critical("put:$udomain:$uname:$namespace:$items",$uhome);
5181: }
5182:
5183: # -------------------------------------------------------------- eget interface
5184:
5185: sub eget {
5186: my ($namespace,$storearr,$udomain,$uname)=@_;
5187: my $items='';
5188: foreach my $item (@$storearr) {
5189: $items.=&escape($item).'&';
5190: }
5191: $items=~s/\&$//;
5192: if (!$udomain) { $udomain=$env{'user.domain'}; }
5193: if (!$uname) { $uname=$env{'user.name'}; }
5194: my $uhome=&homeserver($uname,$udomain);
5195: my $rep=&reply("eget:$udomain:$uname:$namespace:$items",$uhome);
5196: my @pairs=split(/\&/,$rep);
5197: my %returnhash=();
5198: my $i=0;
5199: foreach my $item (@$storearr) {
5200: $returnhash{$item}=&thaw_unescape($pairs[$i]);
5201: $i++;
5202: }
5203: return %returnhash;
5204: }
5205:
5206: # ------------------------------------------------------------ tmpput interface
5207: sub tmpput {
5208: my ($storehash,$server,$context)=@_;
5209: my $items='';
5210: foreach my $item (keys(%$storehash)) {
5211: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
5212: }
5213: $items=~s/\&$//;
5214: if (defined($context)) {
5215: $items .= ':'.&escape($context);
5216: }
5217: return &reply("tmpput:$items",$server);
5218: }
5219:
5220: # ------------------------------------------------------------ tmpget interface
5221: sub tmpget {
5222: my ($token,$server)=@_;
5223: if (!defined($server)) { $server = $perlvar{'lonHostID'}; }
5224: my $rep=&reply("tmpget:$token",$server);
5225: my %returnhash;
5226: foreach my $item (split(/\&/,$rep)) {
5227: my ($key,$value)=split(/=/,$item);
5228: next if ($key =~ /^error: 2 /);
5229: $returnhash{&unescape($key)}=&thaw_unescape($value);
5230: }
5231: return %returnhash;
5232: }
5233:
5234: # ------------------------------------------------------------ tmpdel interface
5235: sub tmpdel {
5236: my ($token,$server)=@_;
5237: if (!defined($server)) { $server = $perlvar{'lonHostID'}; }
5238: return &reply("tmpdel:$token",$server);
5239: }
5240:
5241: # -------------------------------------------------- portfolio access checking
5242:
5243: sub portfolio_access {
5244: my ($requrl) = @_;
5245: my (undef,$udom,$unum,$file_name,$group) = &parse_portfolio_url($requrl);
5246: my $result = &get_portfolio_access($udom,$unum,$file_name,$group);
5247: if ($result) {
5248: my %setters;
5249: if ($env{'user.name'} eq 'public' && $env{'user.domain'} eq 'public') {
5250: my ($startblock,$endblock) =
5251: &Apache::loncommon::blockcheck(\%setters,'port',$unum,$udom);
5252: if ($startblock && $endblock) {
5253: return 'B';
5254: }
5255: } else {
5256: my ($startblock,$endblock) =
5257: &Apache::loncommon::blockcheck(\%setters,'port');
5258: if ($startblock && $endblock) {
5259: return 'B';
5260: }
5261: }
5262: }
5263: if ($result eq 'ok') {
5264: return 'F';
5265: } elsif ($result =~ /^[^:]+:guest_/) {
5266: return 'A';
5267: }
5268: return '';
5269: }
5270:
5271: sub get_portfolio_access {
5272: my ($udom,$unum,$file_name,$group,$access_hash) = @_;
5273:
5274: if (!ref($access_hash)) {
5275: my $current_perms = &get_portfile_permissions($udom,$unum);
5276: my %access_controls = &get_access_controls($current_perms,$group,
5277: $file_name);
5278: $access_hash = $access_controls{$file_name};
5279: }
5280:
5281: my ($public,$guest,@domains,@users,@courses,@groups);
5282: my $now = time;
5283: if (ref($access_hash) eq 'HASH') {
5284: foreach my $key (keys(%{$access_hash})) {
5285: my ($num,$scope,$end,$start) = ($key =~ /^([^:]+):([a-z]+)_(\d*)_?(\d*)$/);
5286: if ($start > $now) {
5287: next;
5288: }
5289: if ($end && $end<$now) {
5290: next;
5291: }
5292: if ($scope eq 'public') {
5293: $public = $key;
5294: last;
5295: } elsif ($scope eq 'guest') {
5296: $guest = $key;
5297: } elsif ($scope eq 'domains') {
5298: push(@domains,$key);
5299: } elsif ($scope eq 'users') {
5300: push(@users,$key);
5301: } elsif ($scope eq 'course') {
5302: push(@courses,$key);
5303: } elsif ($scope eq 'group') {
5304: push(@groups,$key);
5305: }
5306: }
5307: if ($public) {
5308: return 'ok';
5309: }
5310: if ($env{'user.name'} eq 'public' && $env{'user.domain'} eq 'public') {
5311: if ($guest) {
5312: return $guest;
5313: }
5314: } else {
5315: if (@domains > 0) {
5316: foreach my $domkey (@domains) {
5317: if (ref($access_hash->{$domkey}{'dom'}) eq 'ARRAY') {
5318: if (grep(/^\Q$env{'user.domain'}\E$/,@{$access_hash->{$domkey}{'dom'}})) {
5319: return 'ok';
5320: }
5321: }
5322: }
5323: }
5324: if (@users > 0) {
5325: foreach my $userkey (@users) {
5326: if (ref($access_hash->{$userkey}{'users'}) eq 'ARRAY') {
5327: foreach my $item (@{$access_hash->{$userkey}{'users'}}) {
5328: if (ref($item) eq 'HASH') {
5329: if (($item->{'uname'} eq $env{'user.name'}) &&
5330: ($item->{'udom'} eq $env{'user.domain'})) {
5331: return 'ok';
5332: }
5333: }
5334: }
5335: }
5336: }
5337: }
5338: my %roleshash;
5339: my @courses_and_groups = @courses;
5340: push(@courses_and_groups,@groups);
5341: if (@courses_and_groups > 0) {
5342: my (%allgroups,%allroles);
5343: my ($start,$end,$role,$sec,$group);
5344: foreach my $envkey (%env) {
5345: if ($envkey =~ m-^user\.role\.(gr|cc|co|in|ta|ep|ad|st)\./($match_domain)/($match_courseid)/?([^/]*)$-) {
5346: my $cid = $2.'_'.$3;
5347: if ($1 eq 'gr') {
5348: $group = $4;
5349: $allgroups{$cid}{$group} = $env{$envkey};
5350: } else {
5351: if ($4 eq '') {
5352: $sec = 'none';
5353: } else {
5354: $sec = $4;
5355: }
5356: $allroles{$cid}{$1}{$sec} = $env{$envkey};
5357: }
5358: } elsif ($envkey =~ m-^user\.role\./cr/($match_domain/$match_username/\w*)./($match_domain)/($match_courseid)/?([^/]*)$-) {
5359: my $cid = $2.'_'.$3;
5360: if ($4 eq '') {
5361: $sec = 'none';
5362: } else {
5363: $sec = $4;
5364: }
5365: $allroles{$cid}{$1}{$sec} = $env{$envkey};
5366: }
5367: }
5368: if (keys(%allroles) == 0) {
5369: return;
5370: }
5371: foreach my $key (@courses_and_groups) {
5372: my %content = %{$$access_hash{$key}};
5373: my $cnum = $content{'number'};
5374: my $cdom = $content{'domain'};
5375: my $cid = $cdom.'_'.$cnum;
5376: if (!exists($allroles{$cid})) {
5377: next;
5378: }
5379: foreach my $role_id (keys(%{$content{'roles'}})) {
5380: my @sections = @{$content{'roles'}{$role_id}{'section'}};
5381: my @groups = @{$content{'roles'}{$role_id}{'group'}};
5382: my @status = @{$content{'roles'}{$role_id}{'access'}};
5383: my @roles = @{$content{'roles'}{$role_id}{'role'}};
5384: foreach my $role (keys(%{$allroles{$cid}})) {
5385: if ((grep/^all$/,@roles) || (grep/^\Q$role\E$/,@roles)) {
5386: foreach my $sec (keys(%{$allroles{$cid}{$role}})) {
5387: if (&course_group_datechecker($allroles{$cid}{$role}{$sec},$now,\@status) eq 'ok') {
5388: if (grep/^all$/,@sections) {
5389: return 'ok';
5390: } else {
5391: if (grep/^$sec$/,@sections) {
5392: return 'ok';
5393: }
5394: }
5395: }
5396: }
5397: if (keys(%{$allgroups{$cid}}) == 0) {
5398: if (grep/^none$/,@groups) {
5399: return 'ok';
5400: }
5401: } else {
5402: if (grep/^all$/,@groups) {
5403: return 'ok';
5404: }
5405: foreach my $group (keys(%{$allgroups{$cid}})) {
5406: if (grep/^$group$/,@groups) {
5407: return 'ok';
5408: }
5409: }
5410: }
5411: }
5412: }
5413: }
5414: }
5415: }
5416: if ($guest) {
5417: return $guest;
5418: }
5419: }
5420: }
5421: return;
5422: }
5423:
5424: sub course_group_datechecker {
5425: my ($dates,$now,$status) = @_;
5426: my ($start,$end) = split(/\./,$dates);
5427: if (!$start && !$end) {
5428: return 'ok';
5429: }
5430: if (grep/^active$/,@{$status}) {
5431: if (((!$start) || ($start && $start <= $now)) && ((!$end) || ($end && $end >= $now))) {
5432: return 'ok';
5433: }
5434: }
5435: if (grep/^previous$/,@{$status}) {
5436: if ($end > $now ) {
5437: return 'ok';
5438: }
5439: }
5440: if (grep/^future$/,@{$status}) {
5441: if ($start > $now) {
5442: return 'ok';
5443: }
5444: }
5445: return;
5446: }
5447:
5448: sub parse_portfolio_url {
5449: my ($url) = @_;
5450:
5451: my ($type,$udom,$unum,$group,$file_name);
5452:
5453: if ($url =~ m-^/*(?:uploaded|editupload)/($match_domain)/($match_username)/portfolio(/.+)$-) {
5454: $type = 1;
5455: $udom = $1;
5456: $unum = $2;
5457: $file_name = $3;
5458: } elsif ($url =~ m-^/*(?:uploaded|editupload)/($match_domain)/($match_courseid)/groups/([^/]+)/portfolio/(.+)$-) {
5459: $type = 2;
5460: $udom = $1;
5461: $unum = $2;
5462: $group = $3;
5463: $file_name = $3.'/'.$4;
5464: }
5465: if (wantarray) {
5466: return ($type,$udom,$unum,$file_name,$group);
5467: }
5468: return $type;
5469: }
5470:
5471: sub is_portfolio_url {
5472: my ($url) = @_;
5473: return scalar(&parse_portfolio_url($url));
5474: }
5475:
5476: sub is_portfolio_file {
5477: my ($file) = @_;
5478: if (($file =~ /^portfolio/) || ($file =~ /^groups\/\w+\/portfolio/)) {
5479: return 1;
5480: }
5481: return;
5482: }
5483:
5484: sub usertools_access {
5485: my ($uname,$udom,$tool,$action,$context,$userenvref,$domdefref,$is_advref)=@_;
5486: my ($access,%tools);
5487: if ($context eq '') {
5488: $context = 'tools';
5489: }
5490: if ($context eq 'requestcourses') {
5491: %tools = (
5492: official => 1,
5493: unofficial => 1,
5494: community => 1,
5495: );
5496: } else {
5497: %tools = (
5498: aboutme => 1,
5499: blog => 1,
5500: portfolio => 1,
5501: );
5502: }
5503: return if (!defined($tools{$tool}));
5504:
5505: if ((!defined($udom)) || (!defined($uname))) {
5506: $udom = $env{'user.domain'};
5507: $uname = $env{'user.name'};
5508: }
5509:
5510: if (($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'})) {
5511: if ($action ne 'reload') {
5512: if ($context eq 'requestcourses') {
5513: return $env{'environment.canrequest.'.$tool};
5514: } else {
5515: return $env{'environment.availabletools.'.$tool};
5516: }
5517: }
5518: }
5519:
5520: my ($toolstatus,$inststatus);
5521:
5522: if (($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'}) &&
5523: ($action ne 'reload')) {
5524: $toolstatus = $env{'environment.'.$context.'.'.$tool};
5525: $inststatus = $env{'environment.inststatus'};
5526: } else {
5527: if (ref($userenvref) eq 'HASH') {
5528: $toolstatus = $userenvref->{$context.'.'.$tool};
5529: $inststatus = $userenvref->{'inststatus'};
5530: } else {
5531: my %userenv = &userenvironment($udom,$uname,$context.'.'.$tool,'inststatus');
5532: $toolstatus = $userenv{$context.'.'.$tool};
5533: $inststatus = $userenv{'inststatus'};
5534: }
5535: }
5536:
5537: if ($toolstatus ne '') {
5538: if ($toolstatus) {
5539: $access = 1;
5540: } else {
5541: $access = 0;
5542: }
5543: return $access;
5544: }
5545:
5546: my ($is_adv,%domdef);
5547: if (ref($is_advref) eq 'HASH') {
5548: $is_adv = $is_advref->{'is_adv'};
5549: } else {
5550: $is_adv = &is_advanced_user($udom,$uname);
5551: }
5552: if (ref($domdefref) eq 'HASH') {
5553: %domdef = %{$domdefref};
5554: } else {
5555: %domdef = &get_domain_defaults($udom);
5556: }
5557: if (ref($domdef{$tool}) eq 'HASH') {
5558: if ($is_adv) {
5559: if ($domdef{$tool}{'_LC_adv'} ne '') {
5560: if ($domdef{$tool}{'_LC_adv'}) {
5561: $access = 1;
5562: } else {
5563: $access = 0;
5564: }
5565: return $access;
5566: }
5567: }
5568: if ($inststatus ne '') {
5569: my ($hasaccess,$hasnoaccess);
5570: foreach my $affiliation (split(/:/,$inststatus)) {
5571: if ($domdef{$tool}{$affiliation} ne '') {
5572: if ($domdef{$tool}{$affiliation}) {
5573: $hasaccess = 1;
5574: } else {
5575: $hasnoaccess = 1;
5576: }
5577: }
5578: }
5579: if ($hasaccess || $hasnoaccess) {
5580: if ($hasaccess) {
5581: $access = 1;
5582: } elsif ($hasnoaccess) {
5583: $access = 0;
5584: }
5585: return $access;
5586: }
5587: } else {
5588: if ($domdef{$tool}{'default'} ne '') {
5589: if ($domdef{$tool}{'default'}) {
5590: $access = 1;
5591: } elsif ($domdef{$tool}{'default'} == 0) {
5592: $access = 0;
5593: }
5594: return $access;
5595: }
5596: }
5597: } else {
5598: if ($context eq 'tools') {
5599: $access = 1;
5600: } else {
5601: $access = 0;
5602: }
5603: return $access;
5604: }
5605: }
5606:
5607: sub is_course_owner {
5608: my ($cdom,$cnum,$udom,$uname) = @_;
5609: if (($udom eq '') || ($uname eq '')) {
5610: $udom = $env{'user.domain'};
5611: $uname = $env{'user.name'};
5612: }
5613: unless (($udom eq '') || ($uname eq '')) {
5614: if (exists($env{'course.'.$cdom.'_'.$cnum.'.internal.courseowner'})) {
5615: if ($env{'course.'.$cdom.'_'.$cnum.'.internal.courseowner'} eq $uname.':'.$udom) {
5616: return 1;
5617: } else {
5618: my %courseinfo = &Apache::lonnet::coursedescription($cdom.'/'.$cnum);
5619: if ($courseinfo{'internal.courseowner'} eq $uname.':'.$udom) {
5620: return 1;
5621: }
5622: }
5623: }
5624: }
5625: return;
5626: }
5627:
5628: sub is_advanced_user {
5629: my ($udom,$uname) = @_;
5630: if ($udom ne '' && $uname ne '') {
5631: if (($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'})) {
5632: if (wantarray) {
5633: return ($env{'user.adv'},$env{'user.author'});
5634: } else {
5635: return $env{'user.adv'};
5636: }
5637: }
5638: }
5639: my %roleshash = &get_my_roles($uname,$udom,'userroles',undef,undef,undef,1);
5640: my %allroles;
5641: my ($is_adv,$is_author);
5642: foreach my $role (keys(%roleshash)) {
5643: my ($trest,$tdomain,$trole,$sec) = split(/:/,$role);
5644: my $area = '/'.$tdomain.'/'.$trest;
5645: if ($sec ne '') {
5646: $area .= '/'.$sec;
5647: }
5648: if (($area ne '') && ($trole ne '')) {
5649: my $spec=$trole.'.'.$area;
5650: if ($trole =~ /^cr\//) {
5651: &custom_roleprivs(\%allroles,$trole,$tdomain,$trest,$spec,$area);
5652: } elsif ($trole ne 'gr') {
5653: &standard_roleprivs(\%allroles,$trole,$tdomain,$spec,$trest,$area);
5654: }
5655: if ($trole eq 'au') {
5656: $is_author = 1;
5657: }
5658: }
5659: }
5660: foreach my $role (keys(%allroles)) {
5661: last if ($is_adv);
5662: foreach my $item (split(/:/,$allroles{$role})) {
5663: if ($item ne '') {
5664: my ($privilege,$restrictions)=split(/&/,$item);
5665: if ($privilege eq 'adv') {
5666: $is_adv = 1;
5667: last;
5668: }
5669: }
5670: }
5671: }
5672: if (wantarray) {
5673: return ($is_adv,$is_author);
5674: }
5675: return $is_adv;
5676: }
5677:
5678: sub check_can_request {
5679: my ($dom,$can_request,$request_domains) = @_;
5680: my $canreq = 0;
5681: my ($types,$typename) = &Apache::loncommon::course_types();
5682: my @options = ('approval','validate','autolimit');
5683: my $optregex = join('|',@options);
5684: if ((ref($can_request) eq 'HASH') && (ref($types) eq 'ARRAY')) {
5685: foreach my $type (@{$types}) {
5686: if (&usertools_access($env{'user.name'},
5687: $env{'user.domain'},
5688: $type,undef,'requestcourses')) {
5689: $canreq ++;
5690: if (ref($request_domains) eq 'HASH') {
5691: push(@{$request_domains->{$type}},$env{'user.domain'});
5692: }
5693: if ($dom eq $env{'user.domain'}) {
5694: $can_request->{$type} = 1;
5695: }
5696: }
5697: if ($env{'environment.reqcrsotherdom.'.$type} ne '') {
5698: my @curr = split(',',$env{'environment.reqcrsotherdom.'.$type});
5699: if (@curr > 0) {
5700: foreach my $item (@curr) {
5701: if (ref($request_domains) eq 'HASH') {
5702: my ($otherdom) = ($item =~ /^($match_domain):($optregex)(=?\d*)$/);
5703: if ($otherdom ne '') {
5704: if (ref($request_domains->{$type}) eq 'ARRAY') {
5705: unless (grep(/^\Q$otherdom\E$/,@{$request_domains->{$type}})) {
5706: push(@{$request_domains->{$type}},$otherdom);
5707: }
5708: } else {
5709: push(@{$request_domains->{$type}},$otherdom);
5710: }
5711: }
5712: }
5713: }
5714: unless($dom eq $env{'user.domain'}) {
5715: $canreq ++;
5716: if (grep(/^\Q$dom\E:($optregex)(=?\d*)$/,@curr)) {
5717: $can_request->{$type} = 1;
5718: }
5719: }
5720: }
5721: }
5722: }
5723: }
5724: return $canreq;
5725: }
5726:
5727: # ---------------------------------------------- Custom access rule evaluation
5728:
5729: sub customaccess {
5730: my ($priv,$uri)=@_;
5731: my ($urole,$urealm)=split(/\./,$env{'request.role'},2);
5732: my (undef,$udom,$ucrs,$usec)=split(/\//,$urealm);
5733: $udom = &LONCAPA::clean_domain($udom);
5734: $ucrs = &LONCAPA::clean_username($ucrs);
5735: my $access=0;
5736: foreach my $right (split(/\s*\,\s*/,&metadata($uri,'rule_rights'))) {
5737: my ($effect,$realm,$role,$type)=split(/\:/,$right);
5738: if ($type eq 'user') {
5739: foreach my $scope (split(/\s*\,\s*/,$realm)) {
5740: my ($tdom,$tuname)=split(m{/},$scope);
5741: if ($tdom) {
5742: if ($tdom ne $env{'user.domain'}) { next; }
5743: }
5744: if ($tuname) {
5745: if ($tuname ne $env{'user.name'}) { next; }
5746: }
5747: $access=($effect eq 'allow');
5748: last;
5749: }
5750: } else {
5751: if ($role) {
5752: if ($role ne $urole) { next; }
5753: }
5754: foreach my $scope (split(/\s*\,\s*/,$realm)) {
5755: my ($tdom,$tcrs,$tsec)=split(/\_/,$scope);
5756: if ($tdom) {
5757: if ($tdom ne $udom) { next; }
5758: }
5759: if ($tcrs) {
5760: if ($tcrs ne $ucrs) { next; }
5761: }
5762: if ($tsec) {
5763: if ($tsec ne $usec) { next; }
5764: }
5765: $access=($effect eq 'allow');
5766: last;
5767: }
5768: if ($realm eq '' && $role eq '') {
5769: $access=($effect eq 'allow');
5770: }
5771: }
5772: }
5773: return $access;
5774: }
5775:
5776: # ------------------------------------------------- Check for a user privilege
5777:
5778: sub allowed {
5779: my ($priv,$uri,$symb,$role)=@_;
5780: my $ver_orguri=$uri;
5781: $uri=&deversion($uri);
5782: my $orguri=$uri;
5783: $uri=&declutter($uri);
5784:
5785: if ($priv eq 'evb') {
5786: # Evade communication block restrictions for specified role in a course
5787: if ($env{'user.priv.'.$role} =~/evb\&([^\:]*)/) {
5788: return $1;
5789: } else {
5790: return;
5791: }
5792: }
5793:
5794: if (defined($env{'allowed.'.$priv})) { return $env{'allowed.'.$priv}; }
5795: # Free bre access to adm and meta resources
5796: if (((($uri=~/^adm\//) && ($uri !~ m{/(?:smppg|bulletinboard)$}))
5797: || (($uri=~/\.meta$/) && ($uri!~m|^uploaded/|) ))
5798: && ($priv eq 'bre')) {
5799: return 'F';
5800: }
5801:
5802: # Free bre access to user's own portfolio contents
5803: my ($space,$domain,$name,@dir)=split('/',$uri);
5804: if (($space=~/^(uploaded|editupload)$/) && ($env{'user.name'} eq $name) &&
5805: ($env{'user.domain'} eq $domain) && ('portfolio' eq $dir[0])) {
5806: my %setters;
5807: my ($startblock,$endblock) =
5808: &Apache::loncommon::blockcheck(\%setters,'port');
5809: if ($startblock && $endblock) {
5810: return 'B';
5811: } else {
5812: return 'F';
5813: }
5814: }
5815:
5816: # bre access to group portfolio for rgf priv in group, or mdg or vcg in course.
5817: if (($space=~/^(uploaded|editupload)$/) && ($dir[0] eq 'groups')
5818: && ($dir[2] eq 'portfolio') && ($priv eq 'bre')) {
5819: if (exists($env{'request.course.id'})) {
5820: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
5821: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
5822: if (($domain eq $cdom) && ($name eq $cnum)) {
5823: my $courseprivid=$env{'request.course.id'};
5824: $courseprivid=~s/\_/\//;
5825: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid
5826: .'/'.$dir[1]} =~/rgf\&([^\:]*)/) {
5827: return $1;
5828: } else {
5829: if ($env{'request.course.sec'}) {
5830: $courseprivid.='/'.$env{'request.course.sec'};
5831: }
5832: if ($env{'user.priv.'.$env{'request.role'}.'./'.
5833: $courseprivid} =~/(mdg|vcg)\&([^\:]*)/) {
5834: return $2;
5835: }
5836: }
5837: }
5838: }
5839: }
5840:
5841: # Free bre to public access
5842:
5843: if ($priv eq 'bre') {
5844: my $copyright=&metadata($uri,'copyright');
5845: if (($copyright eq 'public') && (!$env{'request.course.id'})) {
5846: return 'F';
5847: }
5848: if ($copyright eq 'priv') {
5849: $uri=~/([^\/]+)\/([^\/]+)\//;
5850: unless (($env{'user.name'} eq $2) && ($env{'user.domain'} eq $1)) {
5851: return '';
5852: }
5853: }
5854: if ($copyright eq 'domain') {
5855: $uri=~/([^\/]+)\/([^\/]+)\//;
5856: unless (($env{'user.domain'} eq $1) ||
5857: ($env{'course.'.$env{'request.course.id'}.'.domain'} eq $1)) {
5858: return '';
5859: }
5860: }
5861: if ($env{'request.role'}=~ /li\.\//) {
5862: # Library role, so allow browsing of resources in this domain.
5863: return 'F';
5864: }
5865: if ($copyright eq 'custom') {
5866: unless (&customaccess($priv,$uri)) { return ''; }
5867: }
5868: }
5869: # Domain coordinator is trying to create a course
5870: if (($priv eq 'ccc') && ($env{'request.role'} =~ /^dc\./)) {
5871: # uri is the requested domain in this case.
5872: # comparison to 'request.role.domain' shows if the user has selected
5873: # a role of dc for the domain in question.
5874: return 'F' if ($uri eq $env{'request.role.domain'});
5875: }
5876:
5877: my $thisallowed='';
5878: my $statecond=0;
5879: my $courseprivid='';
5880:
5881: my $ownaccess;
5882: # Community Coordinator or Assistant Co-author browsing resource space.
5883: if (($priv eq 'bro') && ($env{'user.author'})) {
5884: if ($uri eq '') {
5885: $ownaccess = 1;
5886: } else {
5887: if (($env{'user.domain'} ne '') && ($env{'user.name'} ne '')) {
5888: my $udom = $env{'user.domain'};
5889: my $uname = $env{'user.name'};
5890: if ($uri =~ m{^\Q$udom\E/?$}) {
5891: $ownaccess = 1;
5892: } elsif ($uri =~ m{^\Q$udom\E/\Q$uname\E/?}) {
5893: unless ($uri =~ m{\.\./}) {
5894: $ownaccess = 1;
5895: }
5896: } elsif (($udom ne 'public') && ($uname ne 'public')) {
5897: my $now = time;
5898: if ($uri =~ m{^([^/]+)/?$}) {
5899: my $adom = $1;
5900: foreach my $key (keys(%env)) {
5901: if ($key =~ m{^user\.role\.(ca|aa)/\Q$adom\E}) {
5902: my ($start,$end) = split('.',$env{$key});
5903: if (($now >= $start) && (!$end || $end < $now)) {
5904: $ownaccess = 1;
5905: last;
5906: }
5907: }
5908: }
5909: } elsif ($uri =~ m{^([^/]+)/([^/]+)/?}) {
5910: my $adom = $1;
5911: my $aname = $2;
5912: foreach my $role ('ca','aa') {
5913: if ($env{"user.role.$role./$adom/$aname"}) {
5914: my ($start,$end) =
5915: split('.',$env{"user.role.$role./$adom/$aname"});
5916: if (($now >= $start) && (!$end || $end < $now)) {
5917: $ownaccess = 1;
5918: last;
5919: }
5920: }
5921: }
5922: }
5923: }
5924: }
5925: }
5926: }
5927:
5928: # Course
5929:
5930: if ($env{'user.priv.'.$env{'request.role'}.'./'}=~/\Q$priv\E\&([^\:]*)/) {
5931: unless (($priv eq 'bro') && (!$ownaccess)) {
5932: $thisallowed.=$1;
5933: }
5934: }
5935:
5936: # Domain
5937:
5938: if ($env{'user.priv.'.$env{'request.role'}.'./'.(split(/\//,$uri))[0].'/'}
5939: =~/\Q$priv\E\&([^\:]*)/) {
5940: unless (($priv eq 'bro') && (!$ownaccess)) {
5941: $thisallowed.=$1;
5942: }
5943: }
5944:
5945: # User who is not author or co-author might still be able to edit
5946: # resource of an author in the domain (e.g., if Domain Coordinator).
5947: if (($priv eq 'eco') && ($thisallowed eq '') && ($env{'request.course.id'}) &&
5948: (&allowed('mdc',$env{'request.course.id'}))) {
5949: if ($env{"user.priv.cm./$uri/"}=~/\Q$priv\E\&([^\:]*)/) {
5950: $thisallowed.=$1;
5951: }
5952: }
5953:
5954: # Course: uri itself is a course
5955: my $courseuri=$uri;
5956: $courseuri=~s/\_(\d)/\/$1/;
5957: $courseuri=~s/^([^\/])/\/$1/;
5958:
5959: if ($env{'user.priv.'.$env{'request.role'}.'.'.$courseuri}
5960: =~/\Q$priv\E\&([^\:]*)/) {
5961: unless (($priv eq 'bro') && (!$ownaccess)) {
5962: $thisallowed.=$1;
5963: }
5964: }
5965:
5966: # URI is an uploaded document for this course, default permissions don't matter
5967: # not allowing 'edit' access (editupload) to uploaded course docs
5968: if (($priv eq 'bre') && ($uri=~m|^uploaded/|)) {
5969: $thisallowed='';
5970: my ($match)=&is_on_map($uri);
5971: if ($match) {
5972: if ($env{'user.priv.'.$env{'request.role'}.'./'}
5973: =~/\Q$priv\E\&([^\:]*)/) {
5974: $thisallowed.=$1;
5975: }
5976: } else {
5977: my $refuri = $env{'httpref.'.$orguri} || $env{'httpref.'.$ver_orguri};
5978: if ($refuri) {
5979: if ($refuri =~ m|^/adm/|) {
5980: $thisallowed='F';
5981: } else {
5982: $refuri=&declutter($refuri);
5983: my ($match) = &is_on_map($refuri);
5984: if ($match) {
5985: $thisallowed='F';
5986: }
5987: }
5988: }
5989: }
5990: }
5991:
5992: if ($priv eq 'bre'
5993: && $thisallowed ne 'F'
5994: && $thisallowed ne '2'
5995: && &is_portfolio_url($uri)) {
5996: $thisallowed = &portfolio_access($uri);
5997: }
5998:
5999: # Full access at system, domain or course-wide level? Exit.
6000: if ($thisallowed=~/F/) {
6001: return 'F';
6002: }
6003:
6004: # If this is generating or modifying users, exit with special codes
6005:
6006: if (':csu:cdc:ccc:cin:cta:cep:ccr:cst:cad:cli:cau:cdg:cca:caa:'=~/\:\Q$priv\E\:/) {
6007: if (($priv eq 'cca') || ($priv eq 'caa')) {
6008: my ($audom,$auname)=split('/',$uri);
6009: # no author name given, so this just checks on the general right to make a co-author in this domain
6010: unless ($auname) { return $thisallowed; }
6011: # an author name is given, so we are about to actually make a co-author for a certain account
6012: if (($auname ne $env{'user.name'} && $env{'request.role'} !~ /^dc\./) ||
6013: (($audom ne $env{'user.domain'} && $env{'request.role'} !~ /^dc\./) &&
6014: ($audom ne $env{'request.role.domain'}))) { return ''; }
6015: }
6016: return $thisallowed;
6017: }
6018: #
6019: # Gathered so far: system, domain and course wide privileges
6020: #
6021: # Course: See if uri or referer is an individual resource that is part of
6022: # the course
6023:
6024: if ($env{'request.course.id'}) {
6025:
6026: $courseprivid=$env{'request.course.id'};
6027: if ($env{'request.course.sec'}) {
6028: $courseprivid.='/'.$env{'request.course.sec'};
6029: }
6030: $courseprivid=~s/\_/\//;
6031: my $checkreferer=1;
6032: my ($match,$cond)=&is_on_map($uri);
6033: if ($match) {
6034: $statecond=$cond;
6035: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid}
6036: =~/\Q$priv\E\&([^\:]*)/) {
6037: $thisallowed.=$1;
6038: $checkreferer=0;
6039: }
6040: }
6041:
6042: if ($checkreferer) {
6043: my $refuri=$env{'httpref.'.$orguri};
6044: unless ($refuri) {
6045: foreach my $key (keys(%env)) {
6046: if ($key=~/^httpref\..*\*/) {
6047: my $pattern=$key;
6048: $pattern=~s/^httpref\.\/res\///;
6049: $pattern=~s/\*/\[\^\/\]\+/g;
6050: $pattern=~s/\//\\\//g;
6051: if ($orguri=~/$pattern/) {
6052: $refuri=$env{$key};
6053: }
6054: }
6055: }
6056: }
6057:
6058: if ($refuri) {
6059: $refuri=&declutter($refuri);
6060: my ($match,$cond)=&is_on_map($refuri);
6061: if ($match) {
6062: my $refstatecond=$cond;
6063: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid}
6064: =~/\Q$priv\E\&([^\:]*)/) {
6065: $thisallowed.=$1;
6066: $uri=$refuri;
6067: $statecond=$refstatecond;
6068: }
6069: }
6070: }
6071: }
6072: }
6073:
6074: #
6075: # Gathered now: all privileges that could apply, and condition number
6076: #
6077: #
6078: # Full or no access?
6079: #
6080:
6081: if ($thisallowed=~/F/) {
6082: return 'F';
6083: }
6084:
6085: unless ($thisallowed) {
6086: return '';
6087: }
6088:
6089: # Restrictions exist, deal with them
6090: #
6091: # C:according to course preferences
6092: # R:according to resource settings
6093: # L:unless locked
6094: # X:according to user session state
6095: #
6096:
6097: # Possibly locked functionality, check all courses
6098: # Locks might take effect only after 10 minutes cache expiration for other
6099: # courses, and 2 minutes for current course
6100:
6101: my $envkey;
6102: if ($thisallowed=~/L/) {
6103: foreach $envkey (keys(%env)) {
6104: if ($envkey=~/^user\.role\.(st|ta)\.([^\.]*)/) {
6105: my $courseid=$2;
6106: my $roleid=$1.'.'.$2;
6107: $courseid=~s/^\///;
6108: my $expiretime=600;
6109: if ($env{'request.role'} eq $roleid) {
6110: $expiretime=120;
6111: }
6112: my ($cdom,$cnum,$csec)=split(/\//,$courseid);
6113: my $prefix='course.'.$cdom.'_'.$cnum.'.';
6114: if ((time-$env{$prefix.'last_cache'})>$expiretime) {
6115: &coursedescription($courseid,{'freshen_cache' => 1});
6116: }
6117: if (($env{$prefix.'res.'.$uri.'.lock.sections'}=~/\,\Q$csec\E\,/)
6118: || ($env{$prefix.'res.'.$uri.'.lock.sections'} eq 'all')) {
6119: if ($env{$prefix.'res.'.$uri.'.lock.expire'}>time) {
6120: &log($env{'user.domain'},$env{'user.name'},
6121: $env{'user.home'},
6122: 'Locked by res: '.$priv.' for '.$uri.' due to '.
6123: $cdom.'/'.$cnum.'/'.$csec.' expire '.
6124: $env{$prefix.'priv.'.$priv.'.lock.expire'});
6125: return '';
6126: }
6127: }
6128: if (($env{$prefix.'priv.'.$priv.'.lock.sections'}=~/\,\Q$csec\E\,/)
6129: || ($env{$prefix.'priv.'.$priv.'.lock.sections'} eq 'all')) {
6130: if ($env{'priv.'.$priv.'.lock.expire'}>time) {
6131: &log($env{'user.domain'},$env{'user.name'},
6132: $env{'user.home'},
6133: 'Locked by priv: '.$priv.' for '.$uri.' due to '.
6134: $cdom.'/'.$cnum.'/'.$csec.' expire '.
6135: $env{$prefix.'priv.'.$priv.'.lock.expire'});
6136: return '';
6137: }
6138: }
6139: }
6140: }
6141: }
6142:
6143: #
6144: # Rest of the restrictions depend on selected course
6145: #
6146:
6147: unless ($env{'request.course.id'}) {
6148: if ($thisallowed eq 'A') {
6149: return 'A';
6150: } elsif ($thisallowed eq 'B') {
6151: return 'B';
6152: } else {
6153: return '1';
6154: }
6155: }
6156:
6157: #
6158: # Now user is definitely in a course
6159: #
6160:
6161:
6162: # Course preferences
6163:
6164: if ($thisallowed=~/C/) {
6165: my $rolecode=(split(/\./,$env{'request.role'}))[0];
6166: my $unamedom=$env{'user.name'}.':'.$env{'user.domain'};
6167: if ($env{'course.'.$env{'request.course.id'}.'.'.$priv.'.roles.denied'}
6168: =~/\Q$rolecode\E/) {
6169: if (($priv ne 'pch') && ($priv ne 'plc')) {
6170: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.':'.
6171: 'Denied by role: '.$priv.' for '.$uri.' as '.$rolecode.' in '.
6172: $env{'request.course.id'});
6173: }
6174: return '';
6175: }
6176:
6177: if ($env{'course.'.$env{'request.course.id'}.'.'.$priv.'.users.denied'}
6178: =~/\Q$unamedom\E/) {
6179: if (($priv ne 'pch') && ($priv ne 'plc')) {
6180: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.
6181: 'Denied by user: '.$priv.' for '.$uri.' as '.$unamedom.' in '.
6182: $env{'request.course.id'});
6183: }
6184: return '';
6185: }
6186: }
6187:
6188: # Resource preferences
6189:
6190: if ($thisallowed=~/R/) {
6191: my $rolecode=(split(/\./,$env{'request.role'}))[0];
6192: if (&metadata($uri,'roledeny')=~/\Q$rolecode\E/) {
6193: if (($priv ne 'pch') && ($priv ne 'plc')) {
6194: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.':'.
6195: 'Denied by role: '.$priv.' for '.$uri.' as '.$rolecode);
6196: }
6197: return '';
6198: }
6199: }
6200:
6201: # Restricted by state or randomout?
6202:
6203: if ($thisallowed=~/X/) {
6204: if ($env{'acc.randomout'}) {
6205: if (!$symb) { $symb=&symbread($uri,1); }
6206: if (($symb) && ($env{'acc.randomout'}=~/\&\Q$symb\E\&/)) {
6207: return '';
6208: }
6209: }
6210: if (&condval($statecond)) {
6211: return '2';
6212: } else {
6213: return '';
6214: }
6215: }
6216:
6217: if ($thisallowed eq 'A') {
6218: return 'A';
6219: } elsif ($thisallowed eq 'B') {
6220: return 'B';
6221: }
6222: return 'F';
6223: }
6224: #
6225: # Removes the versino from a URI and
6226: # splits it in to its filename and path to the filename.
6227: # Seems like File::Basename could have done this more clearly.
6228: # Parameters:
6229: # $uri - input URI
6230: # Returns:
6231: # Two element list consisting of
6232: # $pathname - the URI up to and excluding the trailing /
6233: # $filename - The part of the URI following the last /
6234: # NOTE:
6235: # Another realization of this is simply:
6236: # use File::Basename;
6237: # ...
6238: # $uri = shift;
6239: # $filename = basename($uri);
6240: # $path = dirname($uri);
6241: # return ($filename, $path);
6242: #
6243: # The implementation below is probably faster however.
6244: #
6245: sub split_uri_for_cond {
6246: my $uri=&deversion(&declutter(shift));
6247: my @uriparts=split(/\//,$uri);
6248: my $filename=pop(@uriparts);
6249: my $pathname=join('/',@uriparts);
6250: return ($pathname,$filename);
6251: }
6252: # --------------------------------------------------- Is a resource on the map?
6253:
6254: sub is_on_map {
6255: my ($pathname,$filename) = &split_uri_for_cond(shift);
6256: #Trying to find the conditional for the file
6257: my $match=($env{'acc.res.'.$env{'request.course.id'}.'.'.$pathname}=~
6258: /\&\Q$filename\E\:([\d\|]+)\&/);
6259: if ($match) {
6260: return (1,$1);
6261: } else {
6262: return (0,0);
6263: }
6264: }
6265:
6266: # --------------------------------------------------------- Get symb from alias
6267:
6268: sub get_symb_from_alias {
6269: my $symb=shift;
6270: my ($map,$resid,$url)=&decode_symb($symb);
6271: # Already is a symb
6272: if ($url) { return $symb; }
6273: # Must be an alias
6274: my $aliassymb='';
6275: my %bighash;
6276: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
6277: &GDBM_READER(),0640)) {
6278: my $rid=$bighash{'mapalias_'.$symb};
6279: if ($rid) {
6280: my ($mapid,$resid)=split(/\./,$rid);
6281: $aliassymb=&encode_symb($bighash{'map_id_'.$mapid},
6282: $resid,$bighash{'src_'.$rid});
6283: }
6284: untie %bighash;
6285: }
6286: return $aliassymb;
6287: }
6288:
6289: # ----------------------------------------------------------------- Define Role
6290:
6291: sub definerole {
6292: if (allowed('mcr','/')) {
6293: my ($rolename,$sysrole,$domrole,$courole)=@_;
6294: foreach my $role (split(':',$sysrole)) {
6295: my ($crole,$cqual)=split(/\&/,$role);
6296: if ($pr{'cr:s'}!~/\Q$crole\E/) { return "refused:s:$crole"; }
6297: if ($pr{'cr:s'}=~/\Q$crole\E\&/) {
6298: if ($pr{'cr:s'}!~/\Q$crole\E\&\w*\Q$cqual\E/) {
6299: return "refused:s:$crole&$cqual";
6300: }
6301: }
6302: }
6303: foreach my $role (split(':',$domrole)) {
6304: my ($crole,$cqual)=split(/\&/,$role);
6305: if ($pr{'cr:d'}!~/\Q$crole\E/) { return "refused:d:$crole"; }
6306: if ($pr{'cr:d'}=~/\Q$crole\E\&/) {
6307: if ($pr{'cr:d'}!~/\Q$crole\W\&\w*\Q$cqual\E/) {
6308: return "refused:d:$crole&$cqual";
6309: }
6310: }
6311: }
6312: foreach my $role (split(':',$courole)) {
6313: my ($crole,$cqual)=split(/\&/,$role);
6314: if ($pr{'cr:c'}!~/\Q$crole\E/) { return "refused:c:$crole"; }
6315: if ($pr{'cr:c'}=~/\Q$crole\E\&/) {
6316: if ($pr{'cr:c'}!~/\Q$crole\E\&\w*\Q$cqual\E/) {
6317: return "refused:c:$crole&$cqual";
6318: }
6319: }
6320: }
6321: my $command="encrypt:rolesput:$env{'user.domain'}:$env{'user.name'}:".
6322: "$env{'user.domain'}:$env{'user.name'}:".
6323: "rolesdef_$rolename=".
6324: escape($sysrole.'_'.$domrole.'_'.$courole);
6325: return reply($command,$env{'user.home'});
6326: } else {
6327: return 'refused';
6328: }
6329: }
6330:
6331: # ---------------- Make a metadata query against the network of library servers
6332:
6333: sub metadata_query {
6334: my ($query,$custom,$customshow,$server_array)=@_;
6335: my %rhash;
6336: my %libserv = &all_library();
6337: my @server_list = (defined($server_array) ? @$server_array
6338: : keys(%libserv) );
6339: for my $server (@server_list) {
6340: unless ($custom or $customshow) {
6341: my $reply=&reply("querysend:".&escape($query),$server);
6342: $rhash{$server}=$reply;
6343: }
6344: else {
6345: my $reply=&reply("querysend:".&escape($query).':'.
6346: &escape($custom).':'.&escape($customshow),
6347: $server);
6348: $rhash{$server}=$reply;
6349: }
6350: }
6351: return \%rhash;
6352: }
6353:
6354: # ----------------------------------------- Send log queries and wait for reply
6355:
6356: sub log_query {
6357: my ($uname,$udom,$query,%filters)=@_;
6358: my $uhome=&homeserver($uname,$udom);
6359: if ($uhome eq 'no_host') { return 'error: no_host'; }
6360: my $uhost=&hostname($uhome);
6361: my $command=&escape(join(':',map{$_.'='.$filters{$_}} keys(%filters)));
6362: my $queryid=&reply("querysend:".$query.':'.$udom.':'.$uname.':'.$command,
6363: $uhome);
6364: unless ($queryid=~/^\Q$uhost\E\_/) { return 'error: '.$queryid; }
6365: return get_query_reply($queryid);
6366: }
6367:
6368: # -------------------------- Update MySQL table for portfolio file
6369:
6370: sub update_portfolio_table {
6371: my ($uname,$udom,$file_name,$query,$group,$action) = @_;
6372: if ($group ne '') {
6373: $file_name =~s /^\Q$group\E//;
6374: }
6375: my $homeserver = &homeserver($uname,$udom);
6376: my $queryid=
6377: &reply("querysend:".$query.':'.&escape($uname.':'.$udom.':'.$group).
6378: ':'.&escape($file_name).':'.$action,$homeserver);
6379: my $reply = &get_query_reply($queryid);
6380: return $reply;
6381: }
6382:
6383: # -------------------------- Update MySQL allusers table
6384:
6385: sub update_allusers_table {
6386: my ($uname,$udom,$names) = @_;
6387: my $homeserver = &homeserver($uname,$udom);
6388: my $queryid=
6389: &reply('querysend:allusers:'.&escape($uname).':'.&escape($udom).':'.
6390: 'lastname='.&escape($names->{'lastname'}).'%%'.
6391: 'firstname='.&escape($names->{'firstname'}).'%%'.
6392: 'middlename='.&escape($names->{'middlename'}).'%%'.
6393: 'generation='.&escape($names->{'generation'}).'%%'.
6394: 'permanentemail='.&escape($names->{'permanentemail'}).'%%'.
6395: 'id='.&escape($names->{'id'}),$homeserver);
6396: return;
6397: }
6398:
6399: # ------- Request retrieval of institutional classlists for course(s)
6400:
6401: sub fetch_enrollment_query {
6402: my ($context,$affiliatesref,$replyref,$dom,$cnum) = @_;
6403: my $homeserver;
6404: my $maxtries = 1;
6405: if ($context eq 'automated') {
6406: $homeserver = $perlvar{'lonHostID'};
6407: $maxtries = 10; # will wait for up to 2000s for retrieval of classlist data before timeout
6408: } else {
6409: $homeserver = &homeserver($cnum,$dom);
6410: }
6411: my $host=&hostname($homeserver);
6412: my $cmd = '';
6413: foreach my $affiliate (keys(%{$affiliatesref})) {
6414: $cmd .= $affiliate.'='.join(",",@{$$affiliatesref{$affiliate}}).'%%';
6415: }
6416: $cmd =~ s/%%$//;
6417: $cmd = &escape($cmd);
6418: my $query = 'fetchenrollment';
6419: my $queryid=&reply("querysend:".$query.':'.$dom.':'.$env{'user.name'}.':'.$cmd,$homeserver);
6420: unless ($queryid=~/^\Q$host\E\_/) {
6421: &logthis('fetch_enrollment_query: invalid queryid: '.$queryid.' for host: '.$host.' and homeserver: '.$homeserver.' context: '.$context.' '.$cnum);
6422: return 'error: '.$queryid;
6423: }
6424: my $reply = &get_query_reply($queryid);
6425: my $tries = 1;
6426: while (($reply=~/^timeout/) && ($tries < $maxtries)) {
6427: $reply = &get_query_reply($queryid);
6428: $tries ++;
6429: }
6430: if ( ($reply =~/^timeout/) || ($reply =~/^error/) ) {
6431: &logthis('fetch_enrollment_query error: '.$reply.' for '.$dom.' '.$env{'user.name'}.' for '.$queryid.' context: '.$context.' '.$cnum.' maxtries: '.$maxtries.' tries: '.$tries);
6432: } else {
6433: my @responses = split(/:/,$reply);
6434: if ($homeserver eq $perlvar{'lonHostID'}) {
6435: foreach my $line (@responses) {
6436: my ($key,$value) = split(/=/,$line,2);
6437: $$replyref{$key} = $value;
6438: }
6439: } else {
6440: my $pathname = LONCAPA::tempdir();
6441: foreach my $line (@responses) {
6442: my ($key,$value) = split(/=/,$line);
6443: $$replyref{$key} = $value;
6444: if ($value > 0) {
6445: foreach my $item (@{$$affiliatesref{$key}}) {
6446: my $filename = $dom.'_'.$key.'_'.$item.'_classlist.xml';
6447: my $destname = $pathname.'/'.$filename;
6448: my $xml_classlist = &reply("autoretrieve:".$filename,$homeserver);
6449: if ($xml_classlist =~ /^error/) {
6450: &logthis('fetch_enrollment_query - autoretrieve error: '.$xml_classlist.' for '.$filename.' from server: '.$homeserver.' '.$context.' '.$cnum);
6451: } else {
6452: if ( open(FILE,">$destname") ) {
6453: print FILE &unescape($xml_classlist);
6454: close(FILE);
6455: } else {
6456: &logthis('fetch_enrollment_query - error opening classlist file '.$destname.' '.$context.' '.$cnum);
6457: }
6458: }
6459: }
6460: }
6461: }
6462: }
6463: return 'ok';
6464: }
6465: return 'error';
6466: }
6467:
6468: sub get_query_reply {
6469: my $queryid=shift;
6470: my $replyfile=LONCAPA::tempdir().$queryid;
6471: my $reply='';
6472: for (1..100) {
6473: sleep 2;
6474: if (-e $replyfile.'.end') {
6475: if (open(my $fh,$replyfile)) {
6476: $reply = join('',<$fh>);
6477: close($fh);
6478: } else { return 'error: reply_file_error'; }
6479: return &unescape($reply);
6480: }
6481: }
6482: return 'timeout:'.$queryid;
6483: }
6484:
6485: sub courselog_query {
6486: #
6487: # possible filters:
6488: # url: url or symb
6489: # username
6490: # domain
6491: # action: view, submit, grade
6492: # start: timestamp
6493: # end: timestamp
6494: #
6495: my (%filters)=@_;
6496: unless ($env{'request.course.id'}) { return 'no_course'; }
6497: if ($filters{'url'}) {
6498: $filters{'url'}=&symbclean(&declutter($filters{'url'}));
6499: $filters{'url'}=~s/\.(\w+)$/(\\.\\d+)*\\.$1/;
6500: $filters{'url'}=~s/\.(\w+)\_\_\_/(\\.\\d+)*\\.$1/;
6501: }
6502: my $cname=$env{'course.'.$env{'request.course.id'}.'.num'};
6503: my $cdom=$env{'course.'.$env{'request.course.id'}.'.domain'};
6504: return &log_query($cname,$cdom,'courselog',%filters);
6505: }
6506:
6507: sub userlog_query {
6508: #
6509: # possible filters:
6510: # action: log check role
6511: # start: timestamp
6512: # end: timestamp
6513: #
6514: my ($uname,$udom,%filters)=@_;
6515: return &log_query($uname,$udom,'userlog',%filters);
6516: }
6517:
6518: #--------- Call auto-enrollment subs in localenroll.pm for homeserver for course
6519:
6520: sub auto_run {
6521: my ($cnum,$cdom) = @_;
6522: my $response = 0;
6523: my $settings;
6524: my %domconfig = &get_dom('configuration',['autoenroll'],$cdom);
6525: if (ref($domconfig{'autoenroll'}) eq 'HASH') {
6526: $settings = $domconfig{'autoenroll'};
6527: if ($settings->{'run'} eq '1') {
6528: $response = 1;
6529: }
6530: } else {
6531: my $homeserver;
6532: if (&is_course($cdom,$cnum)) {
6533: $homeserver = &homeserver($cnum,$cdom);
6534: } else {
6535: $homeserver = &domain($cdom,'primary');
6536: }
6537: if ($homeserver ne 'no_host') {
6538: $response = &reply('autorun:'.$cdom,$homeserver);
6539: }
6540: }
6541: return $response;
6542: }
6543:
6544: sub auto_get_sections {
6545: my ($cnum,$cdom,$inst_coursecode) = @_;
6546: my $homeserver;
6547: if (($cdom =~ /^$match_domain$/) && ($cnum =~ /^$match_courseid$/)) {
6548: $homeserver = &homeserver($cnum,$cdom);
6549: }
6550: if (!defined($homeserver)) {
6551: if ($cdom =~ /^$match_domain$/) {
6552: $homeserver = &domain($cdom,'primary');
6553: }
6554: }
6555: my @secs;
6556: if (defined($homeserver)) {
6557: my $response=&unescape(&reply('autogetsections:'.$inst_coursecode.':'.$cdom,$homeserver));
6558: unless ($response eq 'refused') {
6559: @secs = split(/:/,$response);
6560: }
6561: }
6562: return @secs;
6563: }
6564:
6565: sub auto_new_course {
6566: my ($cnum,$cdom,$inst_course_id,$owner,$coowners) = @_;
6567: my $homeserver = &homeserver($cnum,$cdom);
6568: my $response=&unescape(&reply('autonewcourse:'.$inst_course_id.':'.&escape($owner).':'.$cdom.':'.&escape($coowners),$homeserver));
6569: return $response;
6570: }
6571:
6572: sub auto_validate_courseID {
6573: my ($cnum,$cdom,$inst_course_id) = @_;
6574: my $homeserver = &homeserver($cnum,$cdom);
6575: my $response=&unescape(&reply('autovalidatecourse:'.$inst_course_id.':'.$cdom,$homeserver));
6576: return $response;
6577: }
6578:
6579: sub auto_validate_instcode {
6580: my ($cnum,$cdom,$instcode,$owner) = @_;
6581: my ($homeserver,$response);
6582: if (($cdom =~ /^$match_domain$/) && ($cnum =~ /^$match_courseid$/)) {
6583: $homeserver = &homeserver($cnum,$cdom);
6584: }
6585: if (!defined($homeserver)) {
6586: if ($cdom =~ /^$match_domain$/) {
6587: $homeserver = &domain($cdom,'primary');
6588: }
6589: }
6590: $response=&unescape(&reply('autovalidateinstcode:'.$cdom.':'.
6591: &escape($instcode).':'.&escape($owner),$homeserver));
6592: my ($outcome,$description) = map { &unescape($_); } split('&',$response,2);
6593: return ($outcome,$description);
6594: }
6595:
6596: sub auto_create_password {
6597: my ($cnum,$cdom,$authparam,$udom) = @_;
6598: my ($homeserver,$response);
6599: my $create_passwd = 0;
6600: my $authchk = '';
6601: if ($udom =~ /^$match_domain$/) {
6602: $homeserver = &domain($udom,'primary');
6603: }
6604: if ($homeserver eq '') {
6605: if (($cdom =~ /^$match_domain$/) && ($cnum =~ /^$match_courseid$/)) {
6606: $homeserver = &homeserver($cnum,$cdom);
6607: }
6608: }
6609: if ($homeserver eq '') {
6610: $authchk = 'nodomain';
6611: } else {
6612: $response=&unescape(&reply('autocreatepassword:'.$authparam.':'.$cdom,$homeserver));
6613: if ($response eq 'refused') {
6614: $authchk = 'refused';
6615: } else {
6616: ($authparam,$create_passwd,$authchk) = split(/:/,$response);
6617: }
6618: }
6619: return ($authparam,$create_passwd,$authchk);
6620: }
6621:
6622: sub auto_photo_permission {
6623: my ($cnum,$cdom,$students) = @_;
6624: my $homeserver = &homeserver($cnum,$cdom);
6625: my ($outcome,$perm_reqd,$conditions) =
6626: split(/:/,&unescape(&reply('autophotopermission:'.$cdom,$homeserver)),3);
6627: if ($outcome =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
6628: return (undef,undef);
6629: }
6630: return ($outcome,$perm_reqd,$conditions);
6631: }
6632:
6633: sub auto_checkphotos {
6634: my ($uname,$udom,$pid) = @_;
6635: my $homeserver = &homeserver($uname,$udom);
6636: my ($result,$resulttype);
6637: my $outcome = &unescape(&reply('autophotocheck:'.&escape($udom).':'.
6638: &escape($uname).':'.&escape($pid),
6639: $homeserver));
6640: if ($outcome =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
6641: return (undef,undef);
6642: }
6643: if ($outcome) {
6644: ($result,$resulttype) = split(/:/,$outcome);
6645: }
6646: return ($result,$resulttype);
6647: }
6648:
6649: sub auto_photochoice {
6650: my ($cnum,$cdom) = @_;
6651: my $homeserver = &homeserver($cnum,$cdom);
6652: my ($update,$comment) = split(/:/,&unescape(&reply('autophotochoice:'.
6653: &escape($cdom),
6654: $homeserver)));
6655: if ($update =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
6656: return (undef,undef);
6657: }
6658: return ($update,$comment);
6659: }
6660:
6661: sub auto_photoupdate {
6662: my ($affiliatesref,$dom,$cnum,$photo) = @_;
6663: my $homeserver = &homeserver($cnum,$dom);
6664: my $host=&hostname($homeserver);
6665: my $cmd = '';
6666: my $maxtries = 1;
6667: foreach my $affiliate (keys(%{$affiliatesref})) {
6668: $cmd .= $affiliate.'='.join(",",@{$$affiliatesref{$affiliate}}).'%%';
6669: }
6670: $cmd =~ s/%%$//;
6671: $cmd = &escape($cmd);
6672: my $query = 'institutionalphotos';
6673: my $queryid=&reply("querysend:".$query.':'.$dom.':'.$cnum.':'.$cmd,$homeserver);
6674: unless ($queryid=~/^\Q$host\E\_/) {
6675: &logthis('institutionalphotos: invalid queryid: '.$queryid.' for host: '.$host.' and homeserver: '.$homeserver.' and course: '.$cnum);
6676: return 'error: '.$queryid;
6677: }
6678: my $reply = &get_query_reply($queryid);
6679: my $tries = 1;
6680: while (($reply=~/^timeout/) && ($tries < $maxtries)) {
6681: $reply = &get_query_reply($queryid);
6682: $tries ++;
6683: }
6684: if ( ($reply =~/^timeout/) || ($reply =~/^error/) ) {
6685: &logthis('institutionalphotos error: '.$reply.' for '.$dom.' '.$env{'user.name'}.' for '.$queryid.' course: '.$cnum.' maxtries: '.$maxtries.' tries: '.$tries);
6686: } else {
6687: my @responses = split(/:/,$reply);
6688: my $outcome = shift(@responses);
6689: foreach my $item (@responses) {
6690: my ($key,$value) = split(/=/,$item);
6691: $$photo{$key} = $value;
6692: }
6693: return $outcome;
6694: }
6695: return 'error';
6696: }
6697:
6698: sub auto_instcode_format {
6699: my ($caller,$codedom,$instcodes,$codes,$codetitles,$cat_titles,
6700: $cat_order) = @_;
6701: my $courses = '';
6702: my @homeservers;
6703: if ($caller eq 'global') {
6704: my %servers = &get_servers($codedom,'library');
6705: foreach my $tryserver (keys(%servers)) {
6706: if (!grep(/^\Q$tryserver\E$/,@homeservers)) {
6707: push(@homeservers,$tryserver);
6708: }
6709: }
6710: } elsif ($caller eq 'requests') {
6711: if ($codedom =~ /^$match_domain$/) {
6712: my $chome = &domain($codedom,'primary');
6713: unless ($chome eq 'no_host') {
6714: push(@homeservers,$chome);
6715: }
6716: }
6717: } else {
6718: push(@homeservers,&homeserver($caller,$codedom));
6719: }
6720: foreach my $code (keys(%{$instcodes})) {
6721: $courses .= &escape($code).'='.&escape($$instcodes{$code}).'&';
6722: }
6723: chop($courses);
6724: my $ok_response = 0;
6725: my $response;
6726: while (@homeservers > 0 && $ok_response == 0) {
6727: my $server = shift(@homeservers);
6728: $response=&reply('autoinstcodeformat:'.$codedom.':'.$courses,$server);
6729: if ($response !~ /(con_lost|error|no_such_host|refused)/) {
6730: my ($codes_str,$codetitles_str,$cat_titles_str,$cat_order_str) =
6731: split(/:/,$response);
6732: %{$codes} = (%{$codes},&str2hash($codes_str));
6733: push(@{$codetitles},&str2array($codetitles_str));
6734: %{$cat_titles} = (%{$cat_titles},&str2hash($cat_titles_str));
6735: %{$cat_order} = (%{$cat_order},&str2hash($cat_order_str));
6736: $ok_response = 1;
6737: }
6738: }
6739: if ($ok_response) {
6740: return 'ok';
6741: } else {
6742: return $response;
6743: }
6744: }
6745:
6746: sub auto_instcode_defaults {
6747: my ($domain,$returnhash,$code_order) = @_;
6748: my @homeservers;
6749:
6750: my %servers = &get_servers($domain,'library');
6751: foreach my $tryserver (keys(%servers)) {
6752: if (!grep(/^\Q$tryserver\E$/,@homeservers)) {
6753: push(@homeservers,$tryserver);
6754: }
6755: }
6756:
6757: my $response;
6758: foreach my $server (@homeservers) {
6759: $response=&reply('autoinstcodedefaults:'.$domain,$server);
6760: next if ($response =~ /(con_lost|error|no_such_host|refused)/);
6761:
6762: foreach my $pair (split(/\&/,$response)) {
6763: my ($name,$value)=split(/\=/,$pair);
6764: if ($name eq 'code_order') {
6765: @{$code_order} = split(/\&/,&unescape($value));
6766: } else {
6767: $returnhash->{&unescape($name)}=&unescape($value);
6768: }
6769: }
6770: return 'ok';
6771: }
6772:
6773: return $response;
6774: }
6775:
6776: sub auto_possible_instcodes {
6777: my ($domain,$codetitles,$cat_titles,$cat_orders,$code_order) = @_;
6778: unless ((ref($codetitles) eq 'ARRAY') && (ref($cat_titles) eq 'HASH') &&
6779: (ref($cat_orders) eq 'HASH') && (ref($code_order) eq 'ARRAY')) {
6780: return;
6781: }
6782: my (@homeservers,$uhome);
6783: if (defined(&domain($domain,'primary'))) {
6784: $uhome=&domain($domain,'primary');
6785: push(@homeservers,&domain($domain,'primary'));
6786: } else {
6787: my %servers = &get_servers($domain,'library');
6788: foreach my $tryserver (keys(%servers)) {
6789: if (!grep(/^\Q$tryserver\E$/,@homeservers)) {
6790: push(@homeservers,$tryserver);
6791: }
6792: }
6793: }
6794: my $response;
6795: foreach my $server (@homeservers) {
6796: $response=&reply('autopossibleinstcodes:'.$domain,$server);
6797: next if ($response =~ /(con_lost|error|no_such_host|refused)/);
6798: my ($codetitlestr,$codeorderstr,$cat_title,$cat_order) =
6799: split(':',$response);
6800: @{$codetitles} = map { &unescape($_); } (split('&',$codetitlestr));
6801: @{$code_order} = map { &unescape($_); } (split('&',$codeorderstr));
6802: foreach my $item (split('&',$cat_title)) {
6803: my ($name,$value)=split('=',$item);
6804: $cat_titles->{&unescape($name)}=&thaw_unescape($value);
6805: }
6806: foreach my $item (split('&',$cat_order)) {
6807: my ($name,$value)=split('=',$item);
6808: $cat_orders->{&unescape($name)}=&thaw_unescape($value);
6809: }
6810: return 'ok';
6811: }
6812: return $response;
6813: }
6814:
6815: sub auto_courserequest_checks {
6816: my ($dom) = @_;
6817: my ($homeserver,%validations);
6818: if ($dom =~ /^$match_domain$/) {
6819: $homeserver = &domain($dom,'primary');
6820: }
6821: unless ($homeserver eq 'no_host') {
6822: my $response=&reply('autocrsreqchecks:'.$dom,$homeserver);
6823: unless ($response =~ /(con_lost|error|no_such_host|refused)/) {
6824: my @items = split(/&/,$response);
6825: foreach my $item (@items) {
6826: my ($key,$value) = split('=',$item);
6827: $validations{&unescape($key)} = &thaw_unescape($value);
6828: }
6829: }
6830: }
6831: return %validations;
6832: }
6833:
6834: sub auto_courserequest_validation {
6835: my ($dom,$owner,$crstype,$inststatuslist,$instcode,$instseclist) = @_;
6836: my ($homeserver,$response);
6837: if ($dom =~ /^$match_domain$/) {
6838: $homeserver = &domain($dom,'primary');
6839: }
6840: unless ($homeserver eq 'no_host') {
6841:
6842: $response=&unescape(&reply('autocrsreqvalidation:'.$dom.':'.&escape($owner).
6843: ':'.&escape($crstype).':'.&escape($inststatuslist).
6844: ':'.&escape($instcode).':'.&escape($instseclist),
6845: $homeserver));
6846: }
6847: return $response;
6848: }
6849:
6850: sub auto_validate_class_sec {
6851: my ($cdom,$cnum,$owners,$inst_class) = @_;
6852: my $homeserver = &homeserver($cnum,$cdom);
6853: my $ownerlist;
6854: if (ref($owners) eq 'ARRAY') {
6855: $ownerlist = join(',',@{$owners});
6856: } else {
6857: $ownerlist = $owners;
6858: }
6859: my $response=&reply('autovalidateclass_sec:'.$inst_class.':'.
6860: &escape($ownerlist).':'.$cdom,$homeserver);
6861: return $response;
6862: }
6863:
6864: # ------------------------------------------------------- Course Group routines
6865:
6866: sub get_coursegroups {
6867: my ($cdom,$cnum,$group,$namespace) = @_;
6868: return(&dump($namespace,$cdom,$cnum,$group));
6869: }
6870:
6871: sub modify_coursegroup {
6872: my ($cdom,$cnum,$groupsettings) = @_;
6873: return(&put('coursegroups',$groupsettings,$cdom,$cnum));
6874: }
6875:
6876: sub toggle_coursegroup_status {
6877: my ($cdom,$cnum,$group,$action) = @_;
6878: my ($from_namespace,$to_namespace);
6879: if ($action eq 'delete') {
6880: $from_namespace = 'coursegroups';
6881: $to_namespace = 'deleted_groups';
6882: } else {
6883: $from_namespace = 'deleted_groups';
6884: $to_namespace = 'coursegroups';
6885: }
6886: my %curr_group = &get_coursegroups($cdom,$cnum,$group,$from_namespace);
6887: if (my $tmp = &error(%curr_group)) {
6888: &Apache::lonnet::logthis('Error retrieving group: '.$tmp.' in '.$cnum.':'.$cdom);
6889: return ('read error',$tmp);
6890: } else {
6891: my %savedsettings = %curr_group;
6892: my $result = &put($to_namespace,\%savedsettings,$cdom,$cnum);
6893: my $deloutcome;
6894: if ($result eq 'ok') {
6895: $deloutcome = &del($from_namespace,[$group],$cdom,$cnum);
6896: } else {
6897: return ('write error',$result);
6898: }
6899: if ($deloutcome eq 'ok') {
6900: return 'ok';
6901: } else {
6902: return ('delete error',$deloutcome);
6903: }
6904: }
6905: }
6906:
6907: sub modify_group_roles {
6908: my ($cdom,$cnum,$group_id,$user,$end,$start,$userprivs,$selfenroll,$context) = @_;
6909: my $url = '/'.$cdom.'/'.$cnum.'/'.$group_id;
6910: my $role = 'gr/'.&escape($userprivs);
6911: my ($uname,$udom) = split(/:/,$user);
6912: my $result = &assignrole($udom,$uname,$url,$role,$end,$start,'',$selfenroll,$context);
6913: if ($result eq 'ok') {
6914: &devalidate_getgroups_cache($udom,$uname,$cdom,$cnum);
6915: }
6916: return $result;
6917: }
6918:
6919: sub modify_coursegroup_membership {
6920: my ($cdom,$cnum,$membership) = @_;
6921: my $result = &put('groupmembership',$membership,$cdom,$cnum);
6922: return $result;
6923: }
6924:
6925: sub get_active_groups {
6926: my ($udom,$uname,$cdom,$cnum) = @_;
6927: my $now = time;
6928: my %groups = ();
6929: foreach my $key (keys(%env)) {
6930: if ($key =~ m-user\.role\.gr\./($match_domain)/($match_courseid)/(\w+)$-) {
6931: my ($start,$end) = split(/\./,$env{$key});
6932: if (($end!=0) && ($end<$now)) { next; }
6933: if (($start!=0) && ($start>$now)) { next; }
6934: if ($1 eq $cdom && $2 eq $cnum) {
6935: $groups{$3} = $env{$key} ;
6936: }
6937: }
6938: }
6939: return %groups;
6940: }
6941:
6942: sub get_group_membership {
6943: my ($cdom,$cnum,$group) = @_;
6944: return(&dump('groupmembership',$cdom,$cnum,$group));
6945: }
6946:
6947: sub get_users_groups {
6948: my ($udom,$uname,$courseid) = @_;
6949: my @usersgroups;
6950: my $cachetime=1800;
6951:
6952: my $hashid="$udom:$uname:$courseid";
6953: my ($grouplist,$cached)=&is_cached_new('getgroups',$hashid);
6954: if (defined($cached)) {
6955: @usersgroups = split(/:/,$grouplist);
6956: } else {
6957: $grouplist = '';
6958: my $courseurl = &courseid_to_courseurl($courseid);
6959: my $extra = &freeze_escape({'skipcheck' => 1});
6960: my %roleshash = &dump('roles',$udom,$uname,$courseurl,undef,$extra);
6961: my $access_end = $env{'course.'.$courseid.
6962: '.default_enrollment_end_date'};
6963: my $now = time;
6964: foreach my $key (keys(%roleshash)) {
6965: if ($key =~ /^\Q$courseurl\E\/(\w+)\_gr$/) {
6966: my $group = $1;
6967: if ($roleshash{$key} =~ /_(\d+)_(\d+)$/) {
6968: my $start = $2;
6969: my $end = $1;
6970: if ($start == -1) { next; } # deleted from group
6971: if (($start!=0) && ($start>$now)) { next; }
6972: if (($end!=0) && ($end<$now)) {
6973: if ($access_end && $access_end < $now) {
6974: if ($access_end - $end < 86400) {
6975: push(@usersgroups,$group);
6976: }
6977: }
6978: next;
6979: }
6980: push(@usersgroups,$group);
6981: }
6982: }
6983: }
6984: @usersgroups = &sort_course_groups($courseid,@usersgroups);
6985: $grouplist = join(':',@usersgroups);
6986: &do_cache_new('getgroups',$hashid,$grouplist,$cachetime);
6987: }
6988: return @usersgroups;
6989: }
6990:
6991: sub devalidate_getgroups_cache {
6992: my ($udom,$uname,$cdom,$cnum)=@_;
6993: my $courseid = $cdom.'_'.$cnum;
6994:
6995: my $hashid="$udom:$uname:$courseid";
6996: &devalidate_cache_new('getgroups',$hashid);
6997: }
6998:
6999: # ------------------------------------------------------------------ Plain Text
7000:
7001: sub plaintext {
7002: my ($short,$type,$cid,$forcedefault) = @_;
7003: if ($short =~ m{^cr/}) {
7004: return (split('/',$short))[-1];
7005: }
7006: if (!defined($cid)) {
7007: $cid = $env{'request.course.id'};
7008: }
7009: my %rolenames = (
7010: Course => 'std',
7011: Community => 'alt1',
7012: );
7013: if ($cid ne '') {
7014: if ($env{'course.'.$cid.'.'.$short.'.plaintext'} ne '') {
7015: unless ($forcedefault) {
7016: my $roletext = $env{'course.'.$cid.'.'.$short.'.plaintext'};
7017: &Apache::lonlocal::mt_escape(\$roletext);
7018: return &Apache::lonlocal::mt($roletext);
7019: }
7020: }
7021: }
7022: if ((defined($type)) && (defined($rolenames{$type})) &&
7023: (defined($rolenames{$type})) &&
7024: (defined($prp{$short}{$rolenames{$type}}))) {
7025: return &Apache::lonlocal::mt($prp{$short}{$rolenames{$type}});
7026: } elsif ($cid ne '') {
7027: my $crstype = $env{'course.'.$cid.'.type'};
7028: if (($crstype ne '') && (defined($rolenames{$crstype})) &&
7029: (defined($prp{$short}{$rolenames{$crstype}}))) {
7030: return &Apache::lonlocal::mt($prp{$short}{$rolenames{$crstype}});
7031: }
7032: }
7033: return &Apache::lonlocal::mt($prp{$short}{'std'});
7034: }
7035:
7036: # ----------------------------------------------------------------- Assign Role
7037:
7038: sub assignrole {
7039: my ($udom,$uname,$url,$role,$end,$start,$deleteflag,$selfenroll,
7040: $context)=@_;
7041: my $mrole;
7042: if ($role =~ /^cr\//) {
7043: my $cwosec=$url;
7044: $cwosec=~s/^\/($match_domain)\/($match_courseid)\/.*/$1\/$2/;
7045: unless (&allowed('ccr',$cwosec)) {
7046: my $refused = 1;
7047: if ($context eq 'requestcourses') {
7048: if (($env{'user.name'} ne '') && ($env{'user.domain'} ne '')) {
7049: if ($role =~ m{^cr/($match_domain)/($match_username)/([^/]+)$}) {
7050: if (($1 eq $env{'user.domain'}) && ($2 eq $env{'user.name'})) {
7051: my ($cdom,$cnum) = ($cwosec =~ m{^/?($match_domain)/($match_courseid)$});
7052: my %crsenv = &userenvironment($cdom,$cnum,('internal.courseowner'));
7053: if ($crsenv{'internal.courseowner'} eq
7054: $env{'user.name'}.':'.$env{'user.domain'}) {
7055: $refused = '';
7056: }
7057: }
7058: }
7059: }
7060: }
7061: if ($refused) {
7062: &logthis('Refused custom assignrole: '.
7063: $udom.' '.$uname.' '.$url.' '.$role.' '.$end.' '.$start.
7064: ' by '.$env{'user.name'}.' at '.$env{'user.domain'});
7065: return 'refused';
7066: }
7067: }
7068: $mrole='cr';
7069: } elsif ($role =~ /^gr\//) {
7070: my $cwogrp=$url;
7071: $cwogrp=~s{^/($match_domain)/($match_courseid)/.*}{$1/$2};
7072: unless (&allowed('mdg',$cwogrp)) {
7073: &logthis('Refused group assignrole: '.
7074: $udom.' '.$uname.' '.$url.' '.$role.' '.$end.' '.$start.' by '.
7075: $env{'user.name'}.' at '.$env{'user.domain'});
7076: return 'refused';
7077: }
7078: $mrole='gr';
7079: } else {
7080: my $cwosec=$url;
7081: $cwosec=~s/^\/($match_domain)\/($match_courseid)\/.*/$1\/$2/;
7082: if (!(&allowed('c'.$role,$cwosec)) && !(&allowed('c'.$role,$udom))) {
7083: my $refused;
7084: if (($env{'request.course.sec'} ne '') && ($role eq 'st')) {
7085: if (!(&allowed('c'.$role,$url))) {
7086: $refused = 1;
7087: }
7088: } else {
7089: $refused = 1;
7090: }
7091: if ($refused) {
7092: my ($cdom,$cnum) = ($cwosec =~ m{^/?($match_domain)/($match_courseid)$});
7093: if (!$selfenroll && $context eq 'course') {
7094: my %crsenv;
7095: if ($role eq 'cc' || $role eq 'co') {
7096: %crsenv = &userenvironment($cdom,$cnum,('internal.courseowner'));
7097: if (($role eq 'cc') && ($cnum !~ /^$match_community$/)) {
7098: if ($env{'request.role'} eq 'cc./'.$cdom.'/'.$cnum) {
7099: if ($crsenv{'internal.courseowner'} eq
7100: $env{'user.name'}.':'.$env{'user.domain'}) {
7101: $refused = '';
7102: }
7103: }
7104: } elsif (($role eq 'co') && ($cnum =~ /^$match_community$/)) {
7105: if ($env{'request.role'} eq 'co./'.$cdom.'/'.$cnum) {
7106: if ($crsenv{'internal.courseowner'} eq
7107: $env{'user.name'}.':'.$env{'user.domain'}) {
7108: $refused = '';
7109: }
7110: }
7111: }
7112: }
7113: } elsif (($selfenroll == 1) && ($role eq 'st') && ($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'})) {
7114: $refused = '';
7115: } elsif ($context eq 'requestcourses') {
7116: my @possroles = ('st','ta','ep','in','cc','co');
7117: if ((grep(/^\Q$role\E$/,@possroles)) && ($env{'user.name'} ne '' && $env{'user.domain'} ne '')) {
7118: my $wrongcc;
7119: if ($cnum =~ /^$match_community$/) {
7120: $wrongcc = 1 if ($role eq 'cc');
7121: } else {
7122: $wrongcc = 1 if ($role eq 'co');
7123: }
7124: unless ($wrongcc) {
7125: my %crsenv = &userenvironment($cdom,$cnum,('internal.courseowner'));
7126: if ($crsenv{'internal.courseowner'} eq
7127: $env{'user.name'}.':'.$env{'user.domain'}) {
7128: $refused = '';
7129: }
7130: }
7131: }
7132: }
7133: if ($refused) {
7134: &logthis('Refused assignrole: '.$udom.' '.$uname.' '.$url.
7135: ' '.$role.' '.$end.' '.$start.' by '.
7136: $env{'user.name'}.' at '.$env{'user.domain'});
7137: return 'refused';
7138: }
7139: }
7140: } elsif ($role eq 'au') {
7141: if ($url ne '/'.$udom.'/') {
7142: &logthis('Attempt by '.$env{'user.name'}.':'.$env{'user.domain'}.
7143: ' to assign author role for '.$uname.':'.$udom.
7144: ' in domain: '.$url.' refused (wrong domain).');
7145: return 'refused';
7146: }
7147: }
7148: $mrole=$role;
7149: }
7150: my $command="encrypt:rolesput:$env{'user.domain'}:$env{'user.name'}:".
7151: "$udom:$uname:$url".'_'."$mrole=$role";
7152: if ($end) { $command.='_'.$end; }
7153: if ($start) {
7154: if ($end) {
7155: $command.='_'.$start;
7156: } else {
7157: $command.='_0_'.$start;
7158: }
7159: }
7160: my $origstart = $start;
7161: my $origend = $end;
7162: my $delflag;
7163: # actually delete
7164: if ($deleteflag) {
7165: if ((&allowed('dro',$udom)) || (&allowed('dro',$url))) {
7166: # modify command to delete the role
7167: $command="encrypt:rolesdel:$env{'user.domain'}:$env{'user.name'}:".
7168: "$udom:$uname:$url".'_'."$mrole";
7169: &logthis("$env{'user.name'} at $env{'user.domain'} deletes $mrole in $url for $uname at $udom");
7170: # set start and finish to negative values for userrolelog
7171: $start=-1;
7172: $end=-1;
7173: $delflag = 1;
7174: }
7175: }
7176: # send command
7177: my $answer=&reply($command,&homeserver($uname,$udom));
7178: # log new user role if status is ok
7179: if ($answer eq 'ok') {
7180: &userrolelog($role,$uname,$udom,$url,$start,$end);
7181: # for course roles, perform group memberships changes triggered by role change.
7182: &courserolelog($role,$uname,$udom,$url,$origstart,$origend,$delflag,$selfenroll,$context);
7183: unless ($role =~ /^gr/) {
7184: &Apache::longroup::group_changes($udom,$uname,$url,$role,$origend,
7185: $origstart,$selfenroll,$context);
7186: }
7187: if ($role eq 'cc') {
7188: &autoupdate_coowners($url,$end,$start,$uname,$udom);
7189: }
7190: }
7191: return $answer;
7192: }
7193:
7194: sub autoupdate_coowners {
7195: my ($url,$end,$start,$uname,$udom) = @_;
7196: my ($cdom,$cnum) = ($url =~ m{^/($match_domain)/($match_courseid)});
7197: if (($cdom ne '') && ($cnum ne '')) {
7198: my $now = time;
7199: my %domdesign = &Apache::loncommon::get_domainconf($cdom);
7200: if ($domdesign{$cdom.'.autoassign.co-owners'}) {
7201: my %coursehash = &coursedescription($cdom.'_'.$cnum);
7202: my $instcode = $coursehash{'internal.coursecode'};
7203: if ($instcode ne '') {
7204: if (($start && $start <= $now) && ($end == 0) || ($end > $now)) {
7205: unless ($coursehash{'internal.courseowner'} eq $uname.':'.$udom) {
7206: my ($delcoowners,@newcoowners,$putresult,$delresult,$coowners);
7207: my ($result,$desc) = &auto_validate_instcode($cnum,$cdom,$instcode,$uname.':'.$udom);
7208: if ($result eq 'valid') {
7209: if ($coursehash{'internal.co-owners'}) {
7210: foreach my $coowner (split(',',$coursehash{'internal.co-owners'})) {
7211: push(@newcoowners,$coowner);
7212: }
7213: unless (grep(/^\Q$uname\E:\Q$udom\E$/,@newcoowners)) {
7214: push(@newcoowners,$uname.':'.$udom);
7215: }
7216: @newcoowners = sort(@newcoowners);
7217: } else {
7218: push(@newcoowners,$uname.':'.$udom);
7219: }
7220: } else {
7221: if ($coursehash{'internal.co-owners'}) {
7222: foreach my $coowner (split(',',$coursehash{'internal.co-owners'})) {
7223: unless ($coowner eq $uname.':'.$udom) {
7224: push(@newcoowners,$coowner);
7225: }
7226: }
7227: unless (@newcoowners > 0) {
7228: $delcoowners = 1;
7229: $coowners = '';
7230: }
7231: }
7232: }
7233: if (@newcoowners || $delcoowners) {
7234: &store_coowners($cdom,$cnum,$coursehash{'home'},
7235: $delcoowners,@newcoowners);
7236: }
7237: }
7238: }
7239: }
7240: }
7241: }
7242: }
7243:
7244: sub store_coowners {
7245: my ($cdom,$cnum,$chome,$delcoowners,@newcoowners) = @_;
7246: my $cid = $cdom.'_'.$cnum;
7247: my ($coowners,$delresult,$putresult);
7248: if (@newcoowners) {
7249: $coowners = join(',',@newcoowners);
7250: my %coownershash = (
7251: 'internal.co-owners' => $coowners,
7252: );
7253: $putresult = &put('environment',\%coownershash,$cdom,$cnum);
7254: if ($putresult eq 'ok') {
7255: if ($env{'course.'.$cid.'.num'} eq $cnum) {
7256: &appenv({'course.'.$cid.'.internal.co-owners' => $coowners});
7257: }
7258: }
7259: }
7260: if ($delcoowners) {
7261: $delresult = &Apache::lonnet::del('environment',['internal.co-owners'],$cdom,$cnum);
7262: if ($delresult eq 'ok') {
7263: if ($env{'course.'.$cid.'.internal.co-owners'}) {
7264: &Apache::lonnet::delenv('course.'.$cid.'.internal.co-owners');
7265: }
7266: }
7267: }
7268: if (($putresult eq 'ok') || ($delresult eq 'ok')) {
7269: my %crsinfo =
7270: &Apache::lonnet::courseiddump($cdom,'.',1,'.','.',$cnum,undef,undef,'.');
7271: if (ref($crsinfo{$cid}) eq 'HASH') {
7272: $crsinfo{$cid}{'co-owners'} = \@newcoowners;
7273: my $cidput = &Apache::lonnet::courseidput($cdom,\%crsinfo,$chome,'notime');
7274: }
7275: }
7276: }
7277:
7278: # -------------------------------------------------- Modify user authentication
7279: # Overrides without validation
7280:
7281: sub modifyuserauth {
7282: my ($udom,$uname,$umode,$upass)=@_;
7283: my $uhome=&homeserver($uname,$udom);
7284: unless (&allowed('mau',$udom)) { return 'refused'; }
7285: &logthis('Call to modify user authentication '.$udom.', '.$uname.', '.
7286: $umode.' by '.$env{'user.name'}.' at '.$env{'user.domain'}.
7287: ' in domain '.$env{'request.role.domain'});
7288: my $reply=&reply('encrypt:changeuserauth:'.$udom.':'.$uname.':'.$umode.':'.
7289: &escape($upass),$uhome);
7290: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},
7291: 'Authentication changed for '.$udom.', '.$uname.', '.$umode.
7292: '(Remote '.$ENV{'REMOTE_ADDR'}.'): '.$reply);
7293: &log($udom,,$uname,$uhome,
7294: 'Authentication changed by '.$env{'user.domain'}.', '.
7295: $env{'user.name'}.', '.$umode.
7296: '(Remote '.$ENV{'REMOTE_ADDR'}.'): '.$reply);
7297: unless ($reply eq 'ok') {
7298: &logthis('Authentication mode error: '.$reply);
7299: return 'error: '.$reply;
7300: }
7301: return 'ok';
7302: }
7303:
7304: # --------------------------------------------------------------- Modify a user
7305:
7306: sub modifyuser {
7307: my ($udom, $uname, $uid,
7308: $umode, $upass, $first,
7309: $middle, $last, $gene,
7310: $forceid, $desiredhome, $email, $inststatus, $candelete)=@_;
7311: $udom= &LONCAPA::clean_domain($udom);
7312: $uname=&LONCAPA::clean_username($uname);
7313: my $showcandelete = 'none';
7314: if (ref($candelete) eq 'ARRAY') {
7315: if (@{$candelete} > 0) {
7316: $showcandelete = join(', ',@{$candelete});
7317: }
7318: }
7319: &logthis('Call to modify user '.$udom.', '.$uname.', '.$uid.', '.
7320: $umode.', '.$first.', '.$middle.', '.
7321: $last.', '.$gene.'(forceid: '.$forceid.'; candelete: '.$showcandelete.')'.
7322: (defined($desiredhome) ? ' desiredhome = '.$desiredhome :
7323: ' desiredhome not specified').
7324: ' by '.$env{'user.name'}.' at '.$env{'user.domain'}.
7325: ' in domain '.$env{'request.role.domain'});
7326: my $uhome=&homeserver($uname,$udom,'true');
7327: my $newuser;
7328: if ($uhome eq 'no_host') {
7329: $newuser = 1;
7330: }
7331: # ----------------------------------------------------------------- Create User
7332: if (($uhome eq 'no_host') &&
7333: (($umode && $upass) || ($umode eq 'localauth'))) {
7334: my $unhome='';
7335: if (defined($desiredhome) && &host_domain($desiredhome) eq $udom) {
7336: $unhome = $desiredhome;
7337: } elsif($env{'course.'.$env{'request.course.id'}.'.domain'} eq $udom) {
7338: $unhome=$env{'course.'.$env{'request.course.id'}.'.home'};
7339: } else { # load balancing routine for determining $unhome
7340: my $loadm=10000000;
7341: my %servers = &get_servers($udom,'library');
7342: foreach my $tryserver (keys(%servers)) {
7343: my $answer=reply('load',$tryserver);
7344: if (($answer=~/\d+/) && ($answer<$loadm)) {
7345: $loadm=$answer;
7346: $unhome=$tryserver;
7347: }
7348: }
7349: }
7350: if (($unhome eq '') || ($unhome eq 'no_host')) {
7351: return 'error: unable to find a home server for '.$uname.
7352: ' in domain '.$udom;
7353: }
7354: my $reply=&reply('encrypt:makeuser:'.$udom.':'.$uname.':'.$umode.':'.
7355: &escape($upass),$unhome);
7356: unless ($reply eq 'ok') {
7357: return 'error: '.$reply;
7358: }
7359: $uhome=&homeserver($uname,$udom,'true');
7360: if (($uhome eq '') || ($uhome eq 'no_host') || ($uhome ne $unhome)) {
7361: return 'error: unable verify users home machine.';
7362: }
7363: } # End of creation of new user
7364: # ---------------------------------------------------------------------- Add ID
7365: if ($uid) {
7366: $uid=~tr/A-Z/a-z/;
7367: my %uidhash=&idrget($udom,$uname);
7368: if (($uidhash{$uname}) && ($uidhash{$uname}!~/error\:/)
7369: && (!$forceid)) {
7370: unless ($uid eq $uidhash{$uname}) {
7371: return 'error: user id "'.$uid.'" does not match '.
7372: 'current user id "'.$uidhash{$uname}.'".';
7373: }
7374: } else {
7375: &idput($udom,($uname => $uid));
7376: }
7377: }
7378: # -------------------------------------------------------------- Add names, etc
7379: my @tmp=&get('environment',
7380: ['firstname','middlename','lastname','generation','id',
7381: 'permanentemail','inststatus'],
7382: $udom,$uname);
7383: my (%names,%oldnames);
7384: if ($tmp[0] =~ m/^error:.*/) {
7385: %names=();
7386: } else {
7387: %names = @tmp;
7388: %oldnames = %names;
7389: }
7390: #
7391: # If name, email and/or uid are blank (e.g., because an uploaded file
7392: # of users did not contain them), do not overwrite existing values
7393: # unless field is in $candelete array ref.
7394: #
7395:
7396: my @fields = ('firstname','middlename','lastname','generation',
7397: 'permanentemail','id');
7398: my %newvalues;
7399: if (ref($candelete) eq 'ARRAY') {
7400: foreach my $field (@fields) {
7401: if (grep(/^\Q$field\E$/,@{$candelete})) {
7402: if ($field eq 'firstname') {
7403: $names{$field} = $first;
7404: } elsif ($field eq 'middlename') {
7405: $names{$field} = $middle;
7406: } elsif ($field eq 'lastname') {
7407: $names{$field} = $last;
7408: } elsif ($field eq 'generation') {
7409: $names{$field} = $gene;
7410: } elsif ($field eq 'permanentemail') {
7411: $names{$field} = $email;
7412: } elsif ($field eq 'id') {
7413: $names{$field} = $uid;
7414: }
7415: }
7416: }
7417: }
7418: if ($first) { $names{'firstname'} = $first; }
7419: if (defined($middle)) { $names{'middlename'} = $middle; }
7420: if ($last) { $names{'lastname'} = $last; }
7421: if (defined($gene)) { $names{'generation'} = $gene; }
7422: if ($email) {
7423: $email=~s/[^\w\@\.\-\,]//gs;
7424: if ($email=~/\@/) { $names{'permanentemail'} = $email; }
7425: }
7426: if ($uid) { $names{'id'} = $uid; }
7427: if (defined($inststatus)) {
7428: $names{'inststatus'} = '';
7429: my ($usertypes,$typesorder) = &retrieve_inst_usertypes($udom);
7430: if (ref($usertypes) eq 'HASH') {
7431: my @okstatuses;
7432: foreach my $item (split(/:/,$inststatus)) {
7433: if (defined($usertypes->{$item})) {
7434: push(@okstatuses,$item);
7435: }
7436: }
7437: if (@okstatuses) {
7438: $names{'inststatus'} = join(':', map { &escape($_); } @okstatuses);
7439: }
7440: }
7441: }
7442: my $logmsg = $udom.', '.$uname.', '.$uid.', '.
7443: $umode.', '.$first.', '.$middle.', '.
7444: $last.', '.$gene.', '.$email.', '.$inststatus;
7445: if ($env{'user.name'} ne '' && $env{'user.domain'}) {
7446: $logmsg .= ' by '.$env{'user.name'}.' at '.$env{'user.domain'};
7447: } else {
7448: $logmsg .= ' during self creation';
7449: }
7450: my $changed;
7451: if ($newuser) {
7452: $changed = 1;
7453: } else {
7454: foreach my $field (@fields) {
7455: if ($names{$field} ne $oldnames{$field}) {
7456: $changed = 1;
7457: last;
7458: }
7459: }
7460: }
7461: unless ($changed) {
7462: $logmsg = 'No changes in user information needed for: '.$logmsg;
7463: &logthis($logmsg);
7464: return 'ok';
7465: }
7466: my $reply = &put('environment', \%names, $udom,$uname);
7467: if ($reply ne 'ok') {
7468: return 'error: '.$reply;
7469: }
7470: if ($names{'permanentemail'} ne $oldnames{'permanentemail'}) {
7471: &Apache::lonnet::devalidate_cache_new('emailscache',$uname.':'.$udom);
7472: }
7473: my $sqlresult = &update_allusers_table($uname,$udom,\%names);
7474: &devalidate_cache_new('namescache',$uname.':'.$udom);
7475: $logmsg = 'Success modifying user '.$logmsg;
7476: &logthis($logmsg);
7477: return 'ok';
7478: }
7479:
7480: # -------------------------------------------------------------- Modify student
7481:
7482: sub modifystudent {
7483: my ($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene,$usec,
7484: $end,$start,$forceid,$desiredhome,$email,$type,$locktype,$cid,
7485: $selfenroll,$context,$inststatus)=@_;
7486: if (!$cid) {
7487: unless ($cid=$env{'request.course.id'}) {
7488: return 'not_in_class';
7489: }
7490: }
7491: # --------------------------------------------------------------- Make the user
7492: my $reply=&modifyuser
7493: ($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene,$forceid,
7494: $desiredhome,$email,$inststatus);
7495: unless ($reply eq 'ok') { return $reply; }
7496: # This will cause &modify_student_enrollment to get the uid from the
7497: # students environment
7498: $uid = undef if (!$forceid);
7499: $reply = &modify_student_enrollment($udom,$uname,$uid,$first,$middle,$last,
7500: $gene,$usec,$end,$start,$type,$locktype,$cid,$selfenroll,$context);
7501: return $reply;
7502: }
7503:
7504: sub modify_student_enrollment {
7505: my ($udom,$uname,$uid,$first,$middle,$last,$gene,$usec,$end,$start,$type,$locktype,$cid,$selfenroll,$context) = @_;
7506: my ($cdom,$cnum,$chome);
7507: if (!$cid) {
7508: unless ($cid=$env{'request.course.id'}) {
7509: return 'not_in_class';
7510: }
7511: $cdom=$env{'course.'.$cid.'.domain'};
7512: $cnum=$env{'course.'.$cid.'.num'};
7513: } else {
7514: ($cdom,$cnum)=split(/_/,$cid);
7515: }
7516: $chome=$env{'course.'.$cid.'.home'};
7517: if (!$chome) {
7518: $chome=&homeserver($cnum,$cdom);
7519: }
7520: if (!$chome) { return 'unknown_course'; }
7521: # Make sure the user exists
7522: my $uhome=&homeserver($uname,$udom);
7523: if (($uhome eq '') || ($uhome eq 'no_host')) {
7524: return 'error: no such user';
7525: }
7526: # Get student data if we were not given enough information
7527: if (!defined($first) || $first eq '' ||
7528: !defined($last) || $last eq '' ||
7529: !defined($uid) || $uid eq '' ||
7530: !defined($middle) || $middle eq '' ||
7531: !defined($gene) || $gene eq '') {
7532: # They did not supply us with enough data to enroll the student, so
7533: # we need to pick up more information.
7534: my %tmp = &get('environment',
7535: ['firstname','middlename','lastname', 'generation','id']
7536: ,$udom,$uname);
7537:
7538: #foreach my $key (keys(%tmp)) {
7539: # &logthis("key $key = ".$tmp{$key});
7540: #}
7541: $first = $tmp{'firstname'} if (!defined($first) || $first eq '');
7542: $middle = $tmp{'middlename'} if (!defined($middle) || $middle eq '');
7543: $last = $tmp{'lastname'} if (!defined($last) || $last eq '');
7544: $gene = $tmp{'generation'} if (!defined($gene) || $gene eq '');
7545: $uid = $tmp{'id'} if (!defined($uid) || $uid eq '');
7546: }
7547: my $fullname = &format_name($first,$middle,$last,$gene,'lastname');
7548: my $user = "$uname:$udom";
7549: my %old_entry = &Apache::lonnet::get('classlist',[$user],$cdom,$cnum);
7550: my $reply=cput('classlist',
7551: {$user =>
7552: join(':',$end,$start,$uid,$usec,$fullname,$type,$locktype) },
7553: $cdom,$cnum);
7554: if (($reply eq 'ok') || ($reply eq 'delayed')) {
7555: &devalidate_getsection_cache($udom,$uname,$cid);
7556: } else {
7557: return 'error: '.$reply;
7558: }
7559: # Add student role to user
7560: my $uurl='/'.$cid;
7561: $uurl=~s/\_/\//g;
7562: if ($usec) {
7563: $uurl.='/'.$usec;
7564: }
7565: my $result = &assignrole($udom,$uname,$uurl,'st',$end,$start,undef,
7566: $selfenroll,$context);
7567: if ($result ne 'ok') {
7568: if ($old_entry{$user} ne '') {
7569: $reply = &cput('classlist',\%old_entry,$cdom,$cnum);
7570: } else {
7571: $reply = &del('classlist',[$user],$cdom,$cnum);
7572: }
7573: }
7574: return $result;
7575: }
7576:
7577: sub format_name {
7578: my ($firstname,$middlename,$lastname,$generation,$first)=@_;
7579: my $name;
7580: if ($first ne 'lastname') {
7581: $name=$firstname.' '.$middlename.' '.$lastname.' '.$generation;
7582: } else {
7583: if ($lastname=~/\S/) {
7584: $name.= $lastname.' '.$generation.', '.$firstname.' '.$middlename;
7585: $name=~s/\s+,/,/;
7586: } else {
7587: $name.= $firstname.' '.$middlename.' '.$generation;
7588: }
7589: }
7590: $name=~s/^\s+//;
7591: $name=~s/\s+$//;
7592: $name=~s/\s+/ /g;
7593: return $name;
7594: }
7595:
7596: # ------------------------------------------------- Write to course preferences
7597:
7598: sub writecoursepref {
7599: my ($courseid,%prefs)=@_;
7600: $courseid=~s/^\///;
7601: $courseid=~s/\_/\//g;
7602: my ($cdomain,$cnum)=split(/\//,$courseid);
7603: my $chome=homeserver($cnum,$cdomain);
7604: if (($chome eq '') || ($chome eq 'no_host')) {
7605: return 'error: no such course';
7606: }
7607: my $cstring='';
7608: foreach my $pref (keys(%prefs)) {
7609: $cstring.=&escape($pref).'='.&escape($prefs{$pref}).'&';
7610: }
7611: $cstring=~s/\&$//;
7612: return reply('put:'.$cdomain.':'.$cnum.':environment:'.$cstring,$chome);
7613: }
7614:
7615: # ---------------------------------------------------------- Make/modify course
7616:
7617: sub createcourse {
7618: my ($udom,$description,$url,$course_server,$nonstandard,$inst_code,
7619: $course_owner,$crstype,$cnum,$context,$category)=@_;
7620: $url=&declutter($url);
7621: my $cid='';
7622: if ($context eq 'requestcourses') {
7623: my $can_create = 0;
7624: my ($ownername,$ownerdom) = split(':',$course_owner);
7625: if ($udom eq $ownerdom) {
7626: if (&usertools_access($ownername,$ownerdom,$category,undef,
7627: $context)) {
7628: $can_create = 1;
7629: }
7630: } else {
7631: my %userenv = &userenvironment($ownerdom,$ownername,'reqcrsotherdom.'.
7632: $category);
7633: if ($userenv{'reqcrsotherdom.'.$category} ne '') {
7634: my @curr = split(',',$userenv{'reqcrsotherdom.'.$category});
7635: if (@curr > 0) {
7636: my @options = qw(approval validate autolimit);
7637: my $optregex = join('|',@options);
7638: if (grep(/^\Q$udom\E:($optregex)(=?\d*)$/,@curr)) {
7639: $can_create = 1;
7640: }
7641: }
7642: }
7643: }
7644: if ($can_create) {
7645: unless ($ownername eq $env{'user.name'} && $ownerdom eq $env{'user.domain'}) {
7646: unless (&allowed('ccc',$udom)) {
7647: return 'refused';
7648: }
7649: }
7650: } else {
7651: return 'refused';
7652: }
7653: } elsif (!&allowed('ccc',$udom)) {
7654: return 'refused';
7655: }
7656: # --------------------------------------------------------------- Get Unique ID
7657: my $uname;
7658: if ($cnum =~ /^$match_courseid$/) {
7659: my $chome=&homeserver($cnum,$udom,'true');
7660: if (($chome eq '') || ($chome eq 'no_host')) {
7661: $uname = $cnum;
7662: } else {
7663: $uname = &generate_coursenum($udom,$crstype);
7664: }
7665: } else {
7666: $uname = &generate_coursenum($udom,$crstype);
7667: }
7668: return $uname if ($uname =~ /^error/);
7669: # -------------------------------------------------- Check supplied server name
7670: if (!defined($course_server)) {
7671: if (defined(&domain($udom,'primary'))) {
7672: $course_server = &domain($udom,'primary');
7673: } else {
7674: $course_server = $env{'user.home'};
7675: }
7676: }
7677: my %host_servers =
7678: &Apache::lonnet::get_servers($udom,'library');
7679: unless ($host_servers{$course_server}) {
7680: return 'error: invalid home server for course: '.$course_server;
7681: }
7682: # ------------------------------------------------------------- Make the course
7683: my $reply=&reply('encrypt:makeuser:'.$udom.':'.$uname.':none::',
7684: $course_server);
7685: unless ($reply eq 'ok') { return 'error: '.$reply; }
7686: my $uhome=&homeserver($uname,$udom,'true');
7687: if (($uhome eq '') || ($uhome eq 'no_host')) {
7688: return 'error: no such course';
7689: }
7690: # ----------------------------------------------------------------- Course made
7691: # log existence
7692: my $now = time;
7693: my $newcourse = {
7694: $udom.'_'.$uname => {
7695: description => $description,
7696: inst_code => $inst_code,
7697: owner => $course_owner,
7698: type => $crstype,
7699: creator => $env{'user.name'}.':'.
7700: $env{'user.domain'},
7701: created => $now,
7702: context => $context,
7703: },
7704: };
7705: &courseidput($udom,$newcourse,$uhome,'notime');
7706: # set toplevel url
7707: my $topurl=$url;
7708: unless ($nonstandard) {
7709: # ------------------------------------------ For standard courses, make top url
7710: my $mapurl=&clutter($url);
7711: if ($mapurl eq '/res/') { $mapurl=''; }
7712: $env{'form.initmap'}=(<<ENDINITMAP);
7713: <map>
7714: <resource id="1" type="start"></resource>
7715: <resource id="2" src="$mapurl"></resource>
7716: <resource id="3" type="finish"></resource>
7717: <link index="1" from="1" to="2"></link>
7718: <link index="2" from="2" to="3"></link>
7719: </map>
7720: ENDINITMAP
7721: $topurl=&declutter(
7722: &finishuserfileupload($uname,$udom,'initmap','default.sequence')
7723: );
7724: }
7725: # ----------------------------------------------------------- Write preferences
7726: &writecoursepref($udom.'_'.$uname,
7727: ('description' => $description,
7728: 'url' => $topurl,
7729: 'internal.creator' => $env{'user.name'}.':'.
7730: $env{'user.domain'},
7731: 'internal.created' => $now,
7732: 'internal.creationcontext' => $context)
7733: );
7734: return '/'.$udom.'/'.$uname;
7735: }
7736:
7737: # ------------------------------------------------------------------- Create ID
7738: sub generate_coursenum {
7739: my ($udom,$crstype) = @_;
7740: my $domdesc = &domain($udom);
7741: return 'error: invalid domain' if ($domdesc eq '');
7742: my $first;
7743: if ($crstype eq 'Community') {
7744: $first = '0';
7745: } else {
7746: $first = int(1+rand(9));
7747: }
7748: my $uname=$first.
7749: ('a'..'z','A'..'Z','0'..'9')[int(rand(62))].
7750: substr($$.time,0,5).unpack("H8",pack("I32",time)).
7751: unpack("H2",pack("I32",int(rand(255)))).$perlvar{'lonHostID'};
7752: # ----------------------------------------------- Make sure that does not exist
7753: my $uhome=&homeserver($uname,$udom,'true');
7754: unless (($uhome eq '') || ($uhome eq 'no_host')) {
7755: if ($crstype eq 'Community') {
7756: $first = '0';
7757: } else {
7758: $first = int(1+rand(9));
7759: }
7760: $uname=$first.
7761: ('a'..'z','A'..'Z','0'..'9')[int(rand(62))].
7762: substr($$.time,0,5).unpack("H8",pack("I32",time)).
7763: unpack("H2",pack("I32",int(rand(255)))).$perlvar{'lonHostID'};
7764: $uhome=&homeserver($uname,$udom,'true');
7765: unless (($uhome eq '') || ($uhome eq 'no_host')) {
7766: return 'error: unable to generate unique course-ID';
7767: }
7768: }
7769: return $uname;
7770: }
7771:
7772: sub is_course {
7773: my ($cdom,$cnum) = @_;
7774: my %courses = &courseiddump($cdom,'.',1,'.','.',$cnum,undef,
7775: undef,'.');
7776: if (exists($courses{$cdom.'_'.$cnum})) {
7777: return 1;
7778: }
7779: return 0;
7780: }
7781:
7782: sub store_userdata {
7783: my ($storehash,$datakey,$namespace,$udom,$uname) = @_;
7784: my $result;
7785: if ($datakey ne '') {
7786: if (ref($storehash) eq 'HASH') {
7787: if ($udom eq '' || $uname eq '') {
7788: $udom = $env{'user.domain'};
7789: $uname = $env{'user.name'};
7790: }
7791: my $uhome=&homeserver($uname,$udom);
7792: if (($uhome eq '') || ($uhome eq 'no_host')) {
7793: $result = 'error: no_host';
7794: } else {
7795: $storehash->{'ip'} = $ENV{'REMOTE_ADDR'};
7796: $storehash->{'host'} = $perlvar{'lonHostID'};
7797:
7798: my $namevalue='';
7799: foreach my $key (keys(%{$storehash})) {
7800: $namevalue.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
7801: }
7802: $namevalue=~s/\&$//;
7803: $result = &reply("store:$udom:$uname:$namespace:$datakey:".
7804: $namevalue,$uhome);
7805: }
7806: } else {
7807: $result = 'error: data to store was not a hash reference';
7808: }
7809: } else {
7810: $result= 'error: invalid requestkey';
7811: }
7812: return $result;
7813: }
7814:
7815: # ---------------------------------------------------------- Assign Custom Role
7816:
7817: sub assigncustomrole {
7818: my ($udom,$uname,$url,$rdom,$rnam,$rolename,$end,$start,$deleteflag,$selfenroll,$context)=@_;
7819: return &assignrole($udom,$uname,$url,'cr/'.$rdom.'/'.$rnam.'/'.$rolename,
7820: $end,$start,$deleteflag,$selfenroll,$context);
7821: }
7822:
7823: # ----------------------------------------------------------------- Revoke Role
7824:
7825: sub revokerole {
7826: my ($udom,$uname,$url,$role,$deleteflag,$selfenroll,$context)=@_;
7827: my $now=time;
7828: return &assignrole($udom,$uname,$url,$role,$now,undef,$deleteflag,$selfenroll,$context);
7829: }
7830:
7831: # ---------------------------------------------------------- Revoke Custom Role
7832:
7833: sub revokecustomrole {
7834: my ($udom,$uname,$url,$rdom,$rnam,$rolename,$deleteflag,$selfenroll,$context)=@_;
7835: my $now=time;
7836: return &assigncustomrole($udom,$uname,$url,$rdom,$rnam,$rolename,$now,
7837: $deleteflag,$selfenroll,$context);
7838: }
7839:
7840: # ------------------------------------------------------------ Disk usage
7841: sub diskusage {
7842: my ($udom,$uname,$directorypath,$getpropath)=@_;
7843: $directorypath =~ s/\/$//;
7844: my $listing=&reply('du2:'.&escape($directorypath).':'
7845: .&escape($getpropath).':'.&escape($uname).':'
7846: .&escape($udom),homeserver($uname,$udom));
7847: if ($listing eq 'unknown_cmd') {
7848: if ($getpropath) {
7849: $directorypath = &propath($udom,$uname).'/'.$directorypath;
7850: }
7851: $listing = &reply('du:'.$directorypath,homeserver($uname,$udom));
7852: }
7853: return $listing;
7854: }
7855:
7856: sub is_locked {
7857: my ($file_name, $domain, $user, $which) = @_;
7858: my @check;
7859: my $is_locked;
7860: push (@check,$file_name);
7861: my %locked = &get('file_permissions',\@check,
7862: $env{'user.domain'},$env{'user.name'});
7863: my ($tmp)=keys(%locked);
7864: if ($tmp=~/^error:/) { undef(%locked); }
7865:
7866: if (ref($locked{$file_name}) eq 'ARRAY') {
7867: $is_locked = 'false';
7868: foreach my $entry (@{$locked{$file_name}}) {
7869: if (ref($entry) eq 'ARRAY') {
7870: $is_locked = 'true';
7871: if (ref($which) eq 'ARRAY') {
7872: push(@{$which},$entry);
7873: } else {
7874: last;
7875: }
7876: }
7877: }
7878: } else {
7879: $is_locked = 'false';
7880: }
7881: return $is_locked;
7882: }
7883:
7884: sub declutter_portfile {
7885: my ($file) = @_;
7886: $file =~ s{^(/portfolio/|portfolio/)}{/};
7887: return $file;
7888: }
7889:
7890: # ------------------------------------------------------------- Mark as Read Only
7891:
7892: sub mark_as_readonly {
7893: my ($domain,$user,$files,$what) = @_;
7894: my %current_permissions = &dump('file_permissions',$domain,$user);
7895: my ($tmp)=keys(%current_permissions);
7896: if ($tmp=~/^error:/) { undef(%current_permissions); }
7897: foreach my $file (@{$files}) {
7898: $file = &declutter_portfile($file);
7899: push(@{$current_permissions{$file}},$what);
7900: }
7901: &put('file_permissions',\%current_permissions,$domain,$user);
7902: return;
7903: }
7904:
7905: # ------------------------------------------------------------Save Selected Files
7906:
7907: sub save_selected_files {
7908: my ($user, $path, @files) = @_;
7909: my $filename = $user."savedfiles";
7910: my @other_files = &files_not_in_path($user, $path);
7911: open (OUT, '>'.$tmpdir.$filename);
7912: foreach my $file (@files) {
7913: print (OUT $env{'form.currentpath'}.$file."\n");
7914: }
7915: foreach my $file (@other_files) {
7916: print (OUT $file."\n");
7917: }
7918: close (OUT);
7919: return 'ok';
7920: }
7921:
7922: sub clear_selected_files {
7923: my ($user) = @_;
7924: my $filename = $user."savedfiles";
7925: open (OUT, '>'.LONCAPA::tempdir().$filename);
7926: print (OUT undef);
7927: close (OUT);
7928: return ("ok");
7929: }
7930:
7931: sub files_in_path {
7932: my ($user, $path) = @_;
7933: my $filename = $user."savedfiles";
7934: my %return_files;
7935: open (IN, '<'.LONCAPA::tempdir().$filename);
7936: while (my $line_in = <IN>) {
7937: chomp ($line_in);
7938: my @paths_and_file = split (m!/!, $line_in);
7939: my $file_part = pop (@paths_and_file);
7940: my $path_part = join ('/', @paths_and_file);
7941: $path_part.='/';
7942: my $path_and_file = $path_part.$file_part;
7943: if ($path_part eq $path) {
7944: $return_files{$file_part}= 'selected';
7945: }
7946: }
7947: close (IN);
7948: return (\%return_files);
7949: }
7950:
7951: # called in portfolio select mode, to show files selected NOT in current directory
7952: sub files_not_in_path {
7953: my ($user, $path) = @_;
7954: my $filename = $user."savedfiles";
7955: my @return_files;
7956: my $path_part;
7957: open(IN, '<'.LONCAPA::.$filename);
7958: while (my $line = <IN>) {
7959: #ok, I know it's clunky, but I want it to work
7960: my @paths_and_file = split(m|/|, $line);
7961: my $file_part = pop(@paths_and_file);
7962: chomp($file_part);
7963: my $path_part = join('/', @paths_and_file);
7964: $path_part .= '/';
7965: my $path_and_file = $path_part.$file_part;
7966: if ($path_part ne $path) {
7967: push(@return_files, ($path_and_file));
7968: }
7969: }
7970: close(OUT);
7971: return (@return_files);
7972: }
7973:
7974: #----------------------------------------------Get portfolio file permissions
7975:
7976: sub get_portfile_permissions {
7977: my ($domain,$user) = @_;
7978: my %current_permissions = &dump('file_permissions',$domain,$user);
7979: my ($tmp)=keys(%current_permissions);
7980: if ($tmp=~/^error:/) { undef(%current_permissions); }
7981: return \%current_permissions;
7982: }
7983:
7984: #---------------------------------------------Get portfolio file access controls
7985:
7986: sub get_access_controls {
7987: my ($current_permissions,$group,$file) = @_;
7988: my %access;
7989: my $real_file = $file;
7990: $file =~ s/\.meta$//;
7991: if (defined($file)) {
7992: if (ref($$current_permissions{$file."\0".'accesscontrol'}) eq 'HASH') {
7993: foreach my $control (keys(%{$$current_permissions{$file."\0".'accesscontrol'}})) {
7994: $access{$real_file}{$control} = $$current_permissions{$file."\0".$control};
7995: }
7996: }
7997: } else {
7998: foreach my $key (keys(%{$current_permissions})) {
7999: if ($key =~ /\0accesscontrol$/) {
8000: if (defined($group)) {
8001: if ($key !~ m-^\Q$group\E/-) {
8002: next;
8003: }
8004: }
8005: my ($fullpath) = split(/\0/,$key);
8006: if (ref($$current_permissions{$key}) eq 'HASH') {
8007: foreach my $control (keys(%{$$current_permissions{$key}})) {
8008: $access{$fullpath}{$control}=$$current_permissions{$fullpath."\0".$control};
8009: }
8010: }
8011: }
8012: }
8013: }
8014: return %access;
8015: }
8016:
8017: sub modify_access_controls {
8018: my ($file_name,$changes,$domain,$user)=@_;
8019: my ($outcome,$deloutcome);
8020: my %store_permissions;
8021: my %new_values;
8022: my %new_control;
8023: my %translation;
8024: my @deletions = ();
8025: my $now = time;
8026: if (exists($$changes{'activate'})) {
8027: if (ref($$changes{'activate'}) eq 'HASH') {
8028: my @newitems = sort(keys(%{$$changes{'activate'}}));
8029: my $numnew = scalar(@newitems);
8030: for (my $i=0; $i<$numnew; $i++) {
8031: my $newkey = $newitems[$i];
8032: my $newid = &Apache::loncommon::get_cgi_id();
8033: if ($newkey =~ /^\d+:/) {
8034: $newkey =~ s/^(\d+)/$newid/;
8035: $translation{$1} = $newid;
8036: } elsif ($newkey =~ /^\d+_\d+_\d+:/) {
8037: $newkey =~ s/^(\d+_\d+_\d+)/$newid/;
8038: $translation{$1} = $newid;
8039: }
8040: $new_values{$file_name."\0".$newkey} =
8041: $$changes{'activate'}{$newitems[$i]};
8042: $new_control{$newkey} = $now;
8043: }
8044: }
8045: }
8046: my %todelete;
8047: my %changed_items;
8048: foreach my $action ('delete','update') {
8049: if (exists($$changes{$action})) {
8050: if (ref($$changes{$action}) eq 'HASH') {
8051: foreach my $key (keys(%{$$changes{$action}})) {
8052: my ($itemnum) = ($key =~ /^([^:]+):/);
8053: if ($action eq 'delete') {
8054: $todelete{$itemnum} = 1;
8055: } else {
8056: $changed_items{$itemnum} = $key;
8057: }
8058: }
8059: }
8060: }
8061: }
8062: # get lock on access controls for file.
8063: my $lockhash = {
8064: $file_name."\0".'locked_access_records' => $env{'user.name'}.
8065: ':'.$env{'user.domain'},
8066: };
8067: my $tries = 0;
8068: my $gotlock = &newput('file_permissions',$lockhash,$domain,$user);
8069:
8070: while (($gotlock ne 'ok') && $tries <3) {
8071: $tries ++;
8072: sleep 1;
8073: $gotlock = &newput('file_permissions',$lockhash,$domain,$user);
8074: }
8075: if ($gotlock eq 'ok') {
8076: my %curr_permissions = &dump('file_permissions',$domain,$user,$file_name);
8077: my ($tmp)=keys(%curr_permissions);
8078: if ($tmp=~/^error:/) { undef(%curr_permissions); }
8079: if (exists($curr_permissions{$file_name."\0".'accesscontrol'})) {
8080: my $curr_controls = $curr_permissions{$file_name."\0".'accesscontrol'};
8081: if (ref($curr_controls) eq 'HASH') {
8082: foreach my $control_item (keys(%{$curr_controls})) {
8083: my ($itemnum) = ($control_item =~ /^([^:]+):/);
8084: if (defined($todelete{$itemnum})) {
8085: push(@deletions,$file_name."\0".$control_item);
8086: } else {
8087: if (defined($changed_items{$itemnum})) {
8088: $new_control{$changed_items{$itemnum}} = $now;
8089: push(@deletions,$file_name."\0".$control_item);
8090: $new_values{$file_name."\0".$changed_items{$itemnum}} = $$changes{'update'}{$changed_items{$itemnum}};
8091: } else {
8092: $new_control{$control_item} = $$curr_controls{$control_item};
8093: }
8094: }
8095: }
8096: }
8097: }
8098: my ($group);
8099: if (&is_course($domain,$user)) {
8100: ($group,my $file) = split(/\//,$file_name,2);
8101: }
8102: $deloutcome = &del('file_permissions',\@deletions,$domain,$user);
8103: $new_values{$file_name."\0".'accesscontrol'} = \%new_control;
8104: $outcome = &put('file_permissions',\%new_values,$domain,$user);
8105: # remove lock
8106: my @del_lock = ($file_name."\0".'locked_access_records');
8107: my $dellockoutcome = &del('file_permissions',\@del_lock,$domain,$user);
8108: my $sqlresult =
8109: &update_portfolio_table($user,$domain,$file_name,'portfolio_access',
8110: $group);
8111: } else {
8112: $outcome = "error: could not obtain lockfile\n";
8113: }
8114: return ($outcome,$deloutcome,\%new_values,\%translation);
8115: }
8116:
8117: sub make_public_indefinitely {
8118: my ($requrl) = @_;
8119: my $now = time;
8120: my $action = 'activate';
8121: my $aclnum = 0;
8122: if (&is_portfolio_url($requrl)) {
8123: my (undef,$udom,$unum,$file_name,$group) =
8124: &parse_portfolio_url($requrl);
8125: my $current_perms = &get_portfile_permissions($udom,$unum);
8126: my %access_controls = &get_access_controls($current_perms,
8127: $group,$file_name);
8128: foreach my $key (keys(%{$access_controls{$file_name}})) {
8129: my ($num,$scope,$end,$start) =
8130: ($key =~ /^([^:]+):([a-z]+)_(\d*)_?(\d*)$/);
8131: if ($scope eq 'public') {
8132: if ($start <= $now && $end == 0) {
8133: $action = 'none';
8134: } else {
8135: $action = 'update';
8136: $aclnum = $num;
8137: }
8138: last;
8139: }
8140: }
8141: if ($action eq 'none') {
8142: return 'ok';
8143: } else {
8144: my %changes;
8145: my $newend = 0;
8146: my $newstart = $now;
8147: my $newkey = $aclnum.':public_'.$newend.'_'.$newstart;
8148: $changes{$action}{$newkey} = {
8149: type => 'public',
8150: time => {
8151: start => $newstart,
8152: end => $newend,
8153: },
8154: };
8155: my ($outcome,$deloutcome,$new_values,$translation) =
8156: &modify_access_controls($file_name,\%changes,$udom,$unum);
8157: return $outcome;
8158: }
8159: } else {
8160: return 'invalid';
8161: }
8162: }
8163:
8164: #------------------------------------------------------Get Marked as Read Only
8165:
8166: sub get_marked_as_readonly {
8167: my ($domain,$user,$what,$group) = @_;
8168: my $current_permissions = &get_portfile_permissions($domain,$user);
8169: my @readonly_files;
8170: my $cmp1=$what;
8171: if (ref($what)) { $cmp1=join('',@{$what}) };
8172: while (my ($file_name,$value) = each(%{$current_permissions})) {
8173: if (defined($group)) {
8174: if ($file_name !~ m-^\Q$group\E/-) {
8175: next;
8176: }
8177: }
8178: if (ref($value) eq "ARRAY"){
8179: foreach my $stored_what (@{$value}) {
8180: my $cmp2=$stored_what;
8181: if (ref($stored_what) eq 'ARRAY') {
8182: $cmp2=join('',@{$stored_what});
8183: }
8184: if ($cmp1 eq $cmp2) {
8185: push(@readonly_files, $file_name);
8186: last;
8187: } elsif (!defined($what)) {
8188: push(@readonly_files, $file_name);
8189: last;
8190: }
8191: }
8192: }
8193: }
8194: return @readonly_files;
8195: }
8196: #-----------------------------------------------------------Get Marked as Read Only Hash
8197:
8198: sub get_marked_as_readonly_hash {
8199: my ($current_permissions,$group,$what) = @_;
8200: my %readonly_files;
8201: while (my ($file_name,$value) = each(%{$current_permissions})) {
8202: if (defined($group)) {
8203: if ($file_name !~ m-^\Q$group\E/-) {
8204: next;
8205: }
8206: }
8207: if (ref($value) eq "ARRAY"){
8208: foreach my $stored_what (@{$value}) {
8209: if (ref($stored_what) eq 'ARRAY') {
8210: foreach my $lock_descriptor(@{$stored_what}) {
8211: if ($lock_descriptor eq 'graded') {
8212: $readonly_files{$file_name} = 'graded';
8213: } elsif ($lock_descriptor eq 'handback') {
8214: $readonly_files{$file_name} = 'handback';
8215: } else {
8216: if (!exists($readonly_files{$file_name})) {
8217: $readonly_files{$file_name} = 'locked';
8218: }
8219: }
8220: }
8221: }
8222: }
8223: }
8224: }
8225: return %readonly_files;
8226: }
8227: # ------------------------------------------------------------ Unmark as Read Only
8228:
8229: sub unmark_as_readonly {
8230: # unmarks $file_name (if $file_name is defined), or all files locked by $what
8231: # for portfolio submissions, $what contains [$symb,$crsid]
8232: my ($domain,$user,$what,$file_name,$group) = @_;
8233: $file_name = &declutter_portfile($file_name);
8234: my $symb_crs = $what;
8235: if (ref($what)) { $symb_crs=join('',@$what); }
8236: my %current_permissions = &dump('file_permissions',$domain,$user,$group);
8237: my ($tmp)=keys(%current_permissions);
8238: if ($tmp=~/^error:/) { undef(%current_permissions); }
8239: my @readonly_files = &get_marked_as_readonly($domain,$user,$what,$group);
8240: foreach my $file (@readonly_files) {
8241: my $clean_file = &declutter_portfile($file);
8242: if (defined($file_name) && ($file_name ne $clean_file)) { next; }
8243: my $current_locks = $current_permissions{$file};
8244: my @new_locks;
8245: my @del_keys;
8246: if (ref($current_locks) eq "ARRAY"){
8247: foreach my $locker (@{$current_locks}) {
8248: my $compare=$locker;
8249: if (ref($locker) eq 'ARRAY') {
8250: $compare=join('',@{$locker});
8251: if ($compare ne $symb_crs) {
8252: push(@new_locks, $locker);
8253: }
8254: }
8255: }
8256: if (scalar(@new_locks) > 0) {
8257: $current_permissions{$file} = \@new_locks;
8258: } else {
8259: push(@del_keys, $file);
8260: &del('file_permissions',\@del_keys, $domain, $user);
8261: delete($current_permissions{$file});
8262: }
8263: }
8264: }
8265: &put('file_permissions',\%current_permissions,$domain,$user);
8266: return;
8267: }
8268:
8269: # ------------------------------------------------------------ Directory lister
8270:
8271: sub dirlist {
8272: my ($uri,$userdomain,$username,$getpropath,$getuserdir,$alternateRoot)=@_;
8273: $uri=~s/^\///;
8274: $uri=~s/\/$//;
8275: my ($udom, $uname);
8276: if ($getuserdir) {
8277: $udom = $userdomain;
8278: $uname = $username;
8279: } else {
8280: (undef,$udom,$uname)=split(/\//,$uri);
8281: if(defined($userdomain)) {
8282: $udom = $userdomain;
8283: }
8284: if(defined($username)) {
8285: $uname = $username;
8286: }
8287: }
8288: my ($dirRoot,$listing,@listing_results);
8289:
8290: $dirRoot = $perlvar{'lonDocRoot'};
8291: if (defined($getpropath)) {
8292: $dirRoot = &propath($udom,$uname);
8293: $dirRoot =~ s/\/$//;
8294: } elsif (defined($getuserdir)) {
8295: my $subdir=$uname.'__';
8296: $subdir =~ s/(.)(.)(.).*/$1\/$2\/$3/;
8297: $dirRoot = $Apache::lonnet::perlvar{'lonUsersDir'}
8298: ."/$udom/$subdir/$uname";
8299: } elsif (defined($alternateRoot)) {
8300: $dirRoot = $alternateRoot;
8301: }
8302:
8303: if($udom) {
8304: if($uname) {
8305: my $uhome = &homeserver($uname,$udom);
8306: if ($uhome eq 'no_host') {
8307: return ([],'no_host');
8308: }
8309: $listing = &reply('ls3:'.&escape('/'.$uri).':'.$getpropath.':'
8310: .$getuserdir.':'.&escape($dirRoot)
8311: .':'.&escape($uname).':'.&escape($udom),$uhome);
8312: if ($listing eq 'unknown_cmd') {
8313: $listing = &reply('ls2:'.$dirRoot.'/'.$uri,$uhome);
8314: } else {
8315: @listing_results = map { &unescape($_); } split(/:/,$listing);
8316: }
8317: if ($listing eq 'unknown_cmd') {
8318: $listing = &reply('ls:'.$dirRoot.'/'.$uri,$uhome);
8319: @listing_results = split(/:/,$listing);
8320: } else {
8321: @listing_results = map { &unescape($_); } split(/:/,$listing);
8322: }
8323: if (($listing eq 'no_such_host') || ($listing eq 'con_lost') ||
8324: ($listing eq 'rejected') || ($listing eq 'refused') ||
8325: ($listing eq 'no_such_dir') || ($listing eq 'empty')) {
8326: return ([],$listing);
8327: } else {
8328: return (\@listing_results);
8329: }
8330: } elsif(!$alternateRoot) {
8331: my (%allusers,%listerror);
8332: my %servers = &get_servers($udom,'library');
8333: foreach my $tryserver (keys(%servers)) {
8334: $listing = &reply('ls3:'.&escape("/res/$udom").':::::'.
8335: &escape($udom),$tryserver);
8336: if ($listing eq 'unknown_cmd') {
8337: $listing = &reply('ls2:'.$perlvar{'lonDocRoot'}.'/res/'.
8338: $udom, $tryserver);
8339: } else {
8340: @listing_results = map { &unescape($_); } split(/:/,$listing);
8341: }
8342: if ($listing eq 'unknown_cmd') {
8343: $listing = &reply('ls:'.$perlvar{'lonDocRoot'}.'/res/'.
8344: $udom, $tryserver);
8345: @listing_results = split(/:/,$listing);
8346: } else {
8347: @listing_results =
8348: map { &unescape($_); } split(/:/,$listing);
8349: }
8350: if (($listing eq 'no_such_host') || ($listing eq 'con_lost') ||
8351: ($listing eq 'rejected') || ($listing eq 'refused') ||
8352: ($listing eq 'no_such_dir') || ($listing eq 'empty')) {
8353: $listerror{$tryserver} = $listing;
8354: } else {
8355: foreach my $line (@listing_results) {
8356: my ($entry) = split(/&/,$line,2);
8357: $allusers{$entry} = 1;
8358: }
8359: }
8360: }
8361: my @alluserslist=();
8362: foreach my $user (sort(keys(%allusers))) {
8363: push(@alluserslist,$user.'&user');
8364: }
8365: return (\@alluserslist);
8366: } else {
8367: return ([],'missing username');
8368: }
8369: } elsif(!defined($getpropath)) {
8370: my $path = $perlvar{'lonDocRoot'}.'/res/';
8371: my @all_domains = map { $path.$_.'/&domain'; } (sort(&all_domains()));
8372: return (\@all_domains);
8373: } else {
8374: return ([],'missing domain');
8375: }
8376: }
8377:
8378: # --------------------------------------------- GetFileTimestamp
8379: # This function utilizes dirlist and returns the date stamp for
8380: # when it was last modified. It will also return an error of -1
8381: # if an error occurs
8382:
8383: sub GetFileTimestamp {
8384: my ($studentDomain,$studentName,$filename,$getuserdir)=@_;
8385: $studentDomain = &LONCAPA::clean_domain($studentDomain);
8386: $studentName = &LONCAPA::clean_username($studentName);
8387: my ($fileref,$error) = &dirlist($filename,$studentDomain,$studentName,
8388: undef,$getuserdir);
8389: if (($error eq 'empty') || ($error eq 'no_such_dir')) {
8390: return -1;
8391: }
8392: if (ref($fileref) eq 'ARRAY') {
8393: my @stats = split('&',$fileref->[0]);
8394: # @stats contains first the filename, then the stat output
8395: return $stats[10]; # so this is 10 instead of 9.
8396: } else {
8397: return -1;
8398: }
8399: }
8400:
8401: sub stat_file {
8402: my ($uri) = @_;
8403: $uri = &clutter_with_no_wrapper($uri);
8404:
8405: my ($udom,$uname,$file);
8406: if ($uri =~ m-^/(uploaded|editupload)/-) {
8407: ($udom,$uname,$file) =
8408: ($uri =~ m-/(?:uploaded|editupload)/?($match_domain)/?($match_name)/?(.*)-);
8409: $file = 'userfiles/'.$file;
8410: }
8411: if ($uri =~ m-^/res/-) {
8412: ($udom,$uname) =
8413: ($uri =~ m-/(?:res)/?($match_domain)/?($match_username)/-);
8414: $file = $uri;
8415: }
8416:
8417: if (!$udom || !$uname || !$file) {
8418: # unable to handle the uri
8419: return ();
8420: }
8421: my $getpropath;
8422: if ($file =~ /^userfiles\//) {
8423: $getpropath = 1;
8424: }
8425: my ($listref,$error) = &dirlist($file,$udom,$uname,$getpropath);
8426: if (($error eq 'empty') || ($error eq 'no_such_dir')) {
8427: return ();
8428: } else {
8429: if (ref($listref) eq 'ARRAY') {
8430: my @stats = split('&',$listref->[0]);
8431: shift(@stats); #filename is first
8432: return @stats;
8433: }
8434: }
8435: return ();
8436: }
8437:
8438: # -------------------------------------------------------- Value of a Condition
8439:
8440: # gets the value of a specific preevaluated condition
8441: # stored in the string $env{user.state.<cid>}
8442: # or looks up a condition reference in the bighash and if if hasn't
8443: # already been evaluated recurses into docondval to get the value of
8444: # the condition, then memoizing it to
8445: # $env{user.state.<cid>.<condition>}
8446: sub directcondval {
8447: my $number=shift;
8448: if (!defined($env{'user.state.'.$env{'request.course.id'}})) {
8449: &Apache::lonuserstate::evalstate();
8450: }
8451: if (exists($env{'user.state.'.$env{'request.course.id'}.".$number"})) {
8452: return $env{'user.state.'.$env{'request.course.id'}.".$number"};
8453: } elsif ($number =~ /^_/) {
8454: my $sub_condition;
8455: if (tie(my %bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
8456: &GDBM_READER(),0640)) {
8457: $sub_condition=$bighash{'conditions'.$number};
8458: untie(%bighash);
8459: }
8460: my $value = &docondval($sub_condition);
8461: &appenv({'user.state.'.$env{'request.course.id'}.".$number" => $value});
8462: return $value;
8463: }
8464: if ($env{'user.state.'.$env{'request.course.id'}}) {
8465: return substr($env{'user.state.'.$env{'request.course.id'}},$number,1);
8466: } else {
8467: return 2;
8468: }
8469: }
8470:
8471: # get the collection of conditions for this resource
8472: sub condval {
8473: my $condidx=shift;
8474: my $allpathcond='';
8475: foreach my $cond (split(/\|/,$condidx)) {
8476: if (defined($env{'acc.cond.'.$env{'request.course.id'}.'.'.$cond})) {
8477: $allpathcond.=
8478: '('.$env{'acc.cond.'.$env{'request.course.id'}.'.'.$cond}.')|';
8479: }
8480: }
8481: $allpathcond=~s/\|$//;
8482: return &docondval($allpathcond);
8483: }
8484:
8485: #evaluates an expression of conditions
8486: sub docondval {
8487: my ($allpathcond) = @_;
8488: my $result=0;
8489: if ($env{'request.course.id'}
8490: && defined($allpathcond)) {
8491: my $operand='|';
8492: my @stack;
8493: foreach my $chunk ($allpathcond=~/(\d+|_\d+\.\d+|\(|\)|\&|\|)/g) {
8494: if ($chunk eq '(') {
8495: push @stack,($operand,$result);
8496: } elsif ($chunk eq ')') {
8497: my $before=pop @stack;
8498: if (pop @stack eq '&') {
8499: $result=$result>$before?$before:$result;
8500: } else {
8501: $result=$result>$before?$result:$before;
8502: }
8503: } elsif (($chunk eq '&') || ($chunk eq '|')) {
8504: $operand=$chunk;
8505: } else {
8506: my $new=directcondval($chunk);
8507: if ($operand eq '&') {
8508: $result=$result>$new?$new:$result;
8509: } else {
8510: $result=$result>$new?$result:$new;
8511: }
8512: }
8513: }
8514: }
8515: return $result;
8516: }
8517:
8518: # ---------------------------------------------------- Devalidate courseresdata
8519:
8520: sub devalidatecourseresdata {
8521: my ($coursenum,$coursedomain)=@_;
8522: my $hashid=$coursenum.':'.$coursedomain;
8523: &devalidate_cache_new('courseres',$hashid);
8524: }
8525:
8526:
8527: # --------------------------------------------------- Course Resourcedata Query
8528: #
8529: # Parameters:
8530: # $coursenum - Number of the course.
8531: # $coursedomain - Domain at which the course was created.
8532: # Returns:
8533: # A hash of the course parameters along (I think) with timestamps
8534: # and version info.
8535:
8536: sub get_courseresdata {
8537: my ($coursenum,$coursedomain)=@_;
8538: my $coursehom=&homeserver($coursenum,$coursedomain);
8539: my $hashid=$coursenum.':'.$coursedomain;
8540: my ($result,$cached)=&is_cached_new('courseres',$hashid);
8541: my %dumpreply;
8542: unless (defined($cached)) {
8543: %dumpreply=&dump('resourcedata',$coursedomain,$coursenum);
8544: $result=\%dumpreply;
8545: my ($tmp) = keys(%dumpreply);
8546: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
8547: &do_cache_new('courseres',$hashid,$result,600);
8548: } elsif ($tmp =~ /^(con_lost|no_such_host)/) {
8549: return $tmp;
8550: } elsif ($tmp =~ /^(error)/) {
8551: $result=undef;
8552: &do_cache_new('courseres',$hashid,$result,600);
8553: }
8554: }
8555: return $result;
8556: }
8557:
8558: sub devalidateuserresdata {
8559: my ($uname,$udom)=@_;
8560: my $hashid="$udom:$uname";
8561: &devalidate_cache_new('userres',$hashid);
8562: }
8563:
8564: sub get_userresdata {
8565: my ($uname,$udom)=@_;
8566: #most student don\'t have any data set, check if there is some data
8567: if (&EXT_cache_status($udom,$uname)) { return undef; }
8568:
8569: my $hashid="$udom:$uname";
8570: my ($result,$cached)=&is_cached_new('userres',$hashid);
8571: if (!defined($cached)) {
8572: my %resourcedata=&dump('resourcedata',$udom,$uname);
8573: $result=\%resourcedata;
8574: &do_cache_new('userres',$hashid,$result,600);
8575: }
8576: my ($tmp)=keys(%$result);
8577: if (($tmp!~/^error\:/) && ($tmp!~/^con_lost/)) {
8578: return $result;
8579: }
8580: #error 2 occurs when the .db doesn't exist
8581: if ($tmp!~/error: 2 /) {
8582: &logthis("<font color=\"blue\">WARNING:".
8583: " Trying to get resource data for ".
8584: $uname." at ".$udom.": ".
8585: $tmp."</font>");
8586: } elsif ($tmp=~/error: 2 /) {
8587: #&EXT_cache_set($udom,$uname);
8588: &do_cache_new('userres',$hashid,undef,600);
8589: undef($tmp); # not really an error so don't send it back
8590: }
8591: return $tmp;
8592: }
8593: #----------------------------------------------- resdata - return resource data
8594: # Purpose:
8595: # Return resource data for either users or for a course.
8596: # Parameters:
8597: # $name - Course/user name.
8598: # $domain - Name of the domain the user/course is registered on.
8599: # $type - Type of thing $name is (must be 'course' or 'user'
8600: # @which - Array of names of resources desired.
8601: # Returns:
8602: # The value of the first reasource in @which that is found in the
8603: # resource hash.
8604: # Exceptional Conditions:
8605: # If the $type passed in is not valid (not the string 'course' or
8606: # 'user', an undefined reference is returned.
8607: # If none of the resources are found, an undef is returned
8608: sub resdata {
8609: my ($name,$domain,$type,@which)=@_;
8610: my $result;
8611: if ($type eq 'course') {
8612: $result=&get_courseresdata($name,$domain);
8613: } elsif ($type eq 'user') {
8614: $result=&get_userresdata($name,$domain);
8615: }
8616: if (!ref($result)) { return $result; }
8617: foreach my $item (@which) {
8618: if (defined($result->{$item->[0]})) {
8619: return [$result->{$item->[0]},$item->[1]];
8620: }
8621: }
8622: return undef;
8623: }
8624:
8625: #
8626: # EXT resource caching routines
8627: #
8628:
8629: sub clear_EXT_cache_status {
8630: &delenv('cache.EXT.');
8631: }
8632:
8633: sub EXT_cache_status {
8634: my ($target_domain,$target_user) = @_;
8635: my $cachename = 'cache.EXT.'.$target_user.'.'.$target_domain;
8636: if (exists($env{$cachename}) && ($env{$cachename}+600) > time) {
8637: # We know already the user has no data
8638: return 1;
8639: } else {
8640: return 0;
8641: }
8642: }
8643:
8644: sub EXT_cache_set {
8645: my ($target_domain,$target_user) = @_;
8646: my $cachename = 'cache.EXT.'.$target_user.'.'.$target_domain;
8647: #&appenv({$cachename => time});
8648: }
8649:
8650: # --------------------------------------------------------- Value of a Variable
8651: sub EXT {
8652:
8653: my ($varname,$symbparm,$udom,$uname,$usection,$recurse)=@_;
8654: unless ($varname) { return ''; }
8655: #get real user name/domain, courseid and symb
8656: my $courseid;
8657: my $publicuser;
8658: if ($symbparm) {
8659: $symbparm=&get_symb_from_alias($symbparm);
8660: }
8661: if (!($uname && $udom)) {
8662: (my $cursymb,$courseid,$udom,$uname,$publicuser)= &whichuser($symbparm);
8663: if (!$symbparm) { $symbparm=$cursymb; }
8664: } else {
8665: $courseid=$env{'request.course.id'};
8666: }
8667: my ($realm,$space,$qualifier,@therest)=split(/\./,$varname);
8668: my $rest;
8669: if (defined($therest[0])) {
8670: $rest=join('.',@therest);
8671: } else {
8672: $rest='';
8673: }
8674:
8675: my $qualifierrest=$qualifier;
8676: if ($rest) { $qualifierrest.='.'.$rest; }
8677: my $spacequalifierrest=$space;
8678: if ($qualifierrest) { $spacequalifierrest.='.'.$qualifierrest; }
8679: if ($realm eq 'user') {
8680: # --------------------------------------------------------------- user.resource
8681: if ($space eq 'resource') {
8682: if ( (defined($Apache::lonhomework::parsing_a_problem)
8683: || defined($Apache::lonhomework::parsing_a_task))
8684: &&
8685: ($symbparm eq &symbread()) ) {
8686: # if we are in the middle of processing the resource the
8687: # get the value we are planning on committing
8688: if (defined($Apache::lonhomework::results{$qualifierrest})) {
8689: return $Apache::lonhomework::results{$qualifierrest};
8690: } else {
8691: return $Apache::lonhomework::history{$qualifierrest};
8692: }
8693: } else {
8694: my %restored;
8695: if ($publicuser || $env{'request.state'} eq 'construct') {
8696: %restored=&tmprestore($symbparm,$courseid,$udom,$uname);
8697: } else {
8698: %restored=&restore($symbparm,$courseid,$udom,$uname);
8699: }
8700: return $restored{$qualifierrest};
8701: }
8702: # ----------------------------------------------------------------- user.access
8703: } elsif ($space eq 'access') {
8704: # FIXME - not supporting calls for a specific user
8705: return &allowed($qualifier,$rest);
8706: # ------------------------------------------ user.preferences, user.environment
8707: } elsif (($space eq 'preferences') || ($space eq 'environment')) {
8708: if (($uname eq $env{'user.name'}) &&
8709: ($udom eq $env{'user.domain'})) {
8710: return $env{join('.',('environment',$qualifierrest))};
8711: } else {
8712: my %returnhash;
8713: if (!$publicuser) {
8714: %returnhash=&userenvironment($udom,$uname,
8715: $qualifierrest);
8716: }
8717: return $returnhash{$qualifierrest};
8718: }
8719: # ----------------------------------------------------------------- user.course
8720: } elsif ($space eq 'course') {
8721: # FIXME - not supporting calls for a specific user
8722: return $env{join('.',('request.course',$qualifier))};
8723: # ------------------------------------------------------------------- user.role
8724: } elsif ($space eq 'role') {
8725: # FIXME - not supporting calls for a specific user
8726: my ($role,$where)=split(/\./,$env{'request.role'});
8727: if ($qualifier eq 'value') {
8728: return $role;
8729: } elsif ($qualifier eq 'extent') {
8730: return $where;
8731: }
8732: # ----------------------------------------------------------------- user.domain
8733: } elsif ($space eq 'domain') {
8734: return $udom;
8735: # ------------------------------------------------------------------- user.name
8736: } elsif ($space eq 'name') {
8737: return $uname;
8738: # ---------------------------------------------------- Any other user namespace
8739: } else {
8740: my %reply;
8741: if (!$publicuser) {
8742: %reply=&get($space,[$qualifierrest],$udom,$uname);
8743: }
8744: return $reply{$qualifierrest};
8745: }
8746: } elsif ($realm eq 'query') {
8747: # ---------------------------------------------- pull stuff out of query string
8748: &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},
8749: [$spacequalifierrest]);
8750: return $env{'form.'.$spacequalifierrest};
8751: } elsif ($realm eq 'request') {
8752: # ------------------------------------------------------------- request.browser
8753: if ($space eq 'browser') {
8754: return $env{'browser.'.$qualifier};
8755: # ------------------------------------------------------------ request.filename
8756: } else {
8757: return $env{'request.'.$spacequalifierrest};
8758: }
8759: } elsif ($realm eq 'course') {
8760: # ---------------------------------------------------------- course.description
8761: return $env{'course.'.$courseid.'.'.$spacequalifierrest};
8762: } elsif ($realm eq 'resource') {
8763:
8764: if (defined($courseid) && $courseid eq $env{'request.course.id'}) {
8765: if (!$symbparm) { $symbparm=&symbread(); }
8766: }
8767:
8768: if ($space eq 'title') {
8769: if (!$symbparm) { $symbparm = $env{'request.filename'}; }
8770: return &gettitle($symbparm);
8771: }
8772:
8773: if ($space eq 'map') {
8774: my ($map) = &decode_symb($symbparm);
8775: return &symbread($map);
8776: }
8777: if ($space eq 'filename') {
8778: if ($symbparm) {
8779: return &clutter((&decode_symb($symbparm))[2]);
8780: }
8781: return &hreflocation('',$env{'request.filename'});
8782: }
8783:
8784: my ($section, $group, @groups);
8785: my ($courselevelm,$courselevel);
8786: if ($symbparm && defined($courseid) &&
8787: $courseid eq $env{'request.course.id'}) {
8788:
8789: #print '<br>'.$space.' - '.$qualifier.' - '.$spacequalifierrest;
8790:
8791: # ----------------------------------------------------- Cascading lookup scheme
8792: my $symbp=$symbparm;
8793: my $mapp=&deversion((&decode_symb($symbp))[0]);
8794:
8795: my $symbparm=$symbp.'.'.$spacequalifierrest;
8796: my $mapparm=$mapp.'___(all).'.$spacequalifierrest;
8797:
8798: if (($env{'user.name'} eq $uname) &&
8799: ($env{'user.domain'} eq $udom)) {
8800: $section=$env{'request.course.sec'};
8801: @groups = split(/:/,$env{'request.course.groups'});
8802: @groups=&sort_course_groups($courseid,@groups);
8803: } else {
8804: if (! defined($usection)) {
8805: $section=&getsection($udom,$uname,$courseid);
8806: } else {
8807: $section = $usection;
8808: }
8809: @groups = &get_users_groups($udom,$uname,$courseid);
8810: }
8811:
8812: my $seclevel=$courseid.'.['.$section.'].'.$spacequalifierrest;
8813: my $seclevelr=$courseid.'.['.$section.'].'.$symbparm;
8814: my $seclevelm=$courseid.'.['.$section.'].'.$mapparm;
8815:
8816: $courselevel=$courseid.'.'.$spacequalifierrest;
8817: my $courselevelr=$courseid.'.'.$symbparm;
8818: $courselevelm=$courseid.'.'.$mapparm;
8819:
8820: # ----------------------------------------------------------- first, check user
8821:
8822: my $userreply=&resdata($uname,$udom,'user',
8823: ([$courselevelr,'resource'],
8824: [$courselevelm,'map' ],
8825: [$courselevel, 'course' ]));
8826: if (defined($userreply)) { return &get_reply($userreply); }
8827:
8828: # ------------------------------------------------ second, check some of course
8829: my $coursereply;
8830: if (@groups > 0) {
8831: $coursereply = &check_group_parms($courseid,\@groups,$symbparm,
8832: $mapparm,$spacequalifierrest);
8833: if (defined($coursereply)) { return &get_reply($coursereply); }
8834: }
8835:
8836: $coursereply=&resdata($env{'course.'.$courseid.'.num'},
8837: $env{'course.'.$courseid.'.domain'},
8838: 'course',
8839: ([$seclevelr, 'resource'],
8840: [$seclevelm, 'map' ],
8841: [$seclevel, 'course' ],
8842: [$courselevelr,'resource']));
8843: if (defined($coursereply)) { return &get_reply($coursereply); }
8844:
8845: # ------------------------------------------------------ third, check map parms
8846: my %parmhash=();
8847: my $thisparm='';
8848: if (tie(%parmhash,'GDBM_File',
8849: $env{'request.course.fn'}.'_parms.db',
8850: &GDBM_READER(),0640)) {
8851: $thisparm=$parmhash{$symbparm};
8852: untie(%parmhash);
8853: }
8854: if ($thisparm) { return &get_reply([$thisparm,'resource']); }
8855: }
8856: # ------------------------------------------ fourth, look in resource metadata
8857:
8858: $spacequalifierrest=~s/\./\_/;
8859: my $filename;
8860: if (!$symbparm) { $symbparm=&symbread(); }
8861: if ($symbparm) {
8862: $filename=(&decode_symb($symbparm))[2];
8863: } else {
8864: $filename=$env{'request.filename'};
8865: }
8866: my $metadata=&metadata($filename,$spacequalifierrest);
8867: if (defined($metadata)) { return &get_reply([$metadata,'resource']); }
8868: $metadata=&metadata($filename,'parameter_'.$spacequalifierrest);
8869: if (defined($metadata)) { return &get_reply([$metadata,'resource']); }
8870:
8871: # ---------------------------------------------- fourth, look in rest of course
8872: if ($symbparm && defined($courseid) &&
8873: $courseid eq $env{'request.course.id'}) {
8874: my $coursereply=&resdata($env{'course.'.$courseid.'.num'},
8875: $env{'course.'.$courseid.'.domain'},
8876: 'course',
8877: ([$courselevelm,'map' ],
8878: [$courselevel, 'course']));
8879: if (defined($coursereply)) { return &get_reply($coursereply); }
8880: }
8881: # ------------------------------------------------------------------ Cascade up
8882: unless ($space eq '0') {
8883: my @parts=split(/_/,$space);
8884: my $id=pop(@parts);
8885: my $part=join('_',@parts);
8886: if ($part eq '') { $part='0'; }
8887: my @partgeneral=&EXT('resource.'.$part.'.'.$qualifierrest,
8888: $symbparm,$udom,$uname,$section,1);
8889: if (defined($partgeneral[0])) { return &get_reply(\@partgeneral); }
8890: }
8891: if ($recurse) { return undef; }
8892: my $pack_def=&packages_tab_default($filename,$varname);
8893: if (defined($pack_def)) { return &get_reply([$pack_def,'resource']); }
8894: # ---------------------------------------------------- Any other user namespace
8895: } elsif ($realm eq 'environment') {
8896: # ----------------------------------------------------------------- environment
8897: if (($uname eq $env{'user.name'})&&($udom eq $env{'user.domain'})) {
8898: return $env{'environment.'.$spacequalifierrest};
8899: } else {
8900: if ($uname eq 'anonymous' && $udom eq '') {
8901: return '';
8902: }
8903: my %returnhash=&userenvironment($udom,$uname,
8904: $spacequalifierrest);
8905: return $returnhash{$spacequalifierrest};
8906: }
8907: } elsif ($realm eq 'system') {
8908: # ----------------------------------------------------------------- system.time
8909: if ($space eq 'time') {
8910: return time;
8911: }
8912: } elsif ($realm eq 'server') {
8913: # ----------------------------------------------------------------- system.time
8914: if ($space eq 'name') {
8915: return $ENV{'SERVER_NAME'};
8916: }
8917: }
8918: return '';
8919: }
8920:
8921: sub get_reply {
8922: my ($reply_value) = @_;
8923: if (ref($reply_value) eq 'ARRAY') {
8924: if (wantarray) {
8925: return @$reply_value;
8926: }
8927: return $reply_value->[0];
8928: } else {
8929: return $reply_value;
8930: }
8931: }
8932:
8933: sub check_group_parms {
8934: my ($courseid,$groups,$symbparm,$mapparm,$what) = @_;
8935: my @groupitems = ();
8936: my $resultitem;
8937: my @levels = ([$symbparm,'resource'],[$mapparm,'map'],[$what,'course']);
8938: foreach my $group (@{$groups}) {
8939: foreach my $level (@levels) {
8940: my $item = $courseid.'.['.$group.'].'.$level->[0];
8941: push(@groupitems,[$item,$level->[1]]);
8942: }
8943: }
8944: my $coursereply = &resdata($env{'course.'.$courseid.'.num'},
8945: $env{'course.'.$courseid.'.domain'},
8946: 'course',@groupitems);
8947: return $coursereply;
8948: }
8949:
8950: sub sort_course_groups { # Sort groups based on defined rankings. Default is sort().
8951: my ($courseid,@groups) = @_;
8952: @groups = sort(@groups);
8953: return @groups;
8954: }
8955:
8956: sub packages_tab_default {
8957: my ($uri,$varname)=@_;
8958: my (undef,$part,$name)=split(/\./,$varname);
8959:
8960: my (@extension,@specifics,$do_default);
8961: foreach my $package (split(/,/,&metadata($uri,'packages'))) {
8962: my ($pack_type,$pack_part)=split(/_/,$package,2);
8963: if ($pack_type eq 'default') {
8964: $do_default=1;
8965: } elsif ($pack_type eq 'extension') {
8966: push(@extension,[$package,$pack_type,$pack_part]);
8967: } elsif ($pack_part eq $part || $pack_type eq 'part') {
8968: # only look at packages defaults for packages that this id is
8969: push(@specifics,[$package,$pack_type,$pack_part]);
8970: }
8971: }
8972: # first look for a package that matches the requested part id
8973: foreach my $package (@specifics) {
8974: my (undef,$pack_type,$pack_part)=@{$package};
8975: next if ($pack_part ne $part);
8976: if (defined($packagetab{"$pack_type&$name&default"})) {
8977: return $packagetab{"$pack_type&$name&default"};
8978: }
8979: }
8980: # look for any possible matching non extension_ package
8981: foreach my $package (@specifics) {
8982: my (undef,$pack_type,$pack_part)=@{$package};
8983: if (defined($packagetab{"$pack_type&$name&default"})) {
8984: return $packagetab{"$pack_type&$name&default"};
8985: }
8986: if ($pack_type eq 'part') { $pack_part='0'; }
8987: if (defined($packagetab{$pack_type."_".$pack_part."&$name&default"})) {
8988: return $packagetab{$pack_type."_".$pack_part."&$name&default"};
8989: }
8990: }
8991: # look for any posible extension_ match
8992: foreach my $package (@extension) {
8993: my ($package,$pack_type)=@{$package};
8994: if (defined($packagetab{"$pack_type&$name&default"})) {
8995: return $packagetab{"$pack_type&$name&default"};
8996: }
8997: if (defined($packagetab{$package."&$name&default"})) {
8998: return $packagetab{$package."&$name&default"};
8999: }
9000: }
9001: # look for a global default setting
9002: if ($do_default && defined($packagetab{"default&$name&default"})) {
9003: return $packagetab{"default&$name&default"};
9004: }
9005: return undef;
9006: }
9007:
9008: sub add_prefix_and_part {
9009: my ($prefix,$part)=@_;
9010: my $keyroot;
9011: if (defined($prefix) && $prefix !~ /^__/) {
9012: # prefix that has a part already
9013: $keyroot=$prefix;
9014: } elsif (defined($prefix)) {
9015: # prefix that is missing a part
9016: if (defined($part)) { $keyroot='_'.$part.substr($prefix,1); }
9017: } else {
9018: # no prefix at all
9019: if (defined($part)) { $keyroot='_'.$part; }
9020: }
9021: return $keyroot;
9022: }
9023:
9024: # ---------------------------------------------------------------- Get metadata
9025:
9026: my %metaentry;
9027: my %importedpartids;
9028: sub metadata {
9029: my ($uri,$what,$liburi,$prefix,$depthcount)=@_;
9030: $uri=&declutter($uri);
9031: # if it is a non metadata possible uri return quickly
9032: if (($uri eq '') ||
9033: (($uri =~ m|^/*adm/|) &&
9034: ($uri !~ m|^adm/includes|) && ($uri !~ m|/bulletinboard$|)) ||
9035: ($uri =~ m|/$|) || ($uri =~ m|/.meta$|) || ($uri =~ m{^/*uploaded/.+\.sequence$})) {
9036: return undef;
9037: }
9038: if (($uri =~ /^priv/ || $uri=~/home\/httpd\/html\/priv/)
9039: && &Apache::lonxml::get_state('target') =~ /^(|meta)$/) {
9040: return undef;
9041: }
9042: my $filename=$uri;
9043: $uri=~s/\.meta$//;
9044: #
9045: # Is the metadata already cached?
9046: # Look at timestamp of caching
9047: # Everything is cached by the main uri, libraries are never directly cached
9048: #
9049: if (!defined($liburi)) {
9050: my ($result,$cached)=&is_cached_new('meta',$uri);
9051: if (defined($cached)) { return $result->{':'.$what}; }
9052: }
9053: {
9054: # Imported parts would go here
9055: my %importedids=();
9056: my @origfileimportpartids=();
9057: my $importedparts=0;
9058: #
9059: # Is this a recursive call for a library?
9060: #
9061: # if (! exists($metacache{$uri})) {
9062: # $metacache{$uri}={};
9063: # }
9064: my $cachetime = 60*60;
9065: if ($liburi) {
9066: $liburi=&declutter($liburi);
9067: $filename=$liburi;
9068: } else {
9069: &devalidate_cache_new('meta',$uri);
9070: undef(%metaentry);
9071: }
9072: my %metathesekeys=();
9073: unless ($filename=~/\.meta$/) { $filename.='.meta'; }
9074: my $metastring;
9075: if ($uri =~ /^priv/ || $uri=~/home\/httpd\/html\/priv/) {
9076: my $which = &hreflocation('','/'.($liburi || $uri));
9077: $metastring =
9078: &Apache::lonnet::ssi_body($which,
9079: ('grade_target' => 'meta'));
9080: $cachetime = 1; # only want this cached in the child not long term
9081: } elsif (($uri !~ m -^(editupload)/-) &&
9082: ($uri !~ m{^/*uploaded/$match_domain/$match_courseid/docs/})) {
9083: my $file=&filelocation('',&clutter($filename));
9084: #push(@{$metaentry{$uri.'.file'}},$file);
9085: $metastring=&getfile($file);
9086: }
9087: my $parser=HTML::LCParser->new(\$metastring);
9088: my $token;
9089: undef %metathesekeys;
9090: while ($token=$parser->get_token) {
9091: if ($token->[0] eq 'S') {
9092: if (defined($token->[2]->{'package'})) {
9093: #
9094: # This is a package - get package info
9095: #
9096: my $package=$token->[2]->{'package'};
9097: my $keyroot=&add_prefix_and_part($prefix,$token->[2]->{'part'});
9098: if (defined($token->[2]->{'id'})) {
9099: $keyroot.='_'.$token->[2]->{'id'};
9100: }
9101: if ($metaentry{':packages'}) {
9102: $metaentry{':packages'}.=','.$package.$keyroot;
9103: } else {
9104: $metaentry{':packages'}=$package.$keyroot;
9105: }
9106: foreach my $pack_entry (keys(%packagetab)) {
9107: my $part=$keyroot;
9108: $part=~s/^\_//;
9109: if ($pack_entry=~/^\Q$package\E\&/ ||
9110: $pack_entry=~/^\Q$package\E_0\&/) {
9111: my ($pack,$name,$subp)=split(/\&/,$pack_entry);
9112: # ignore package.tab specified default values
9113: # here &package_tab_default() will fetch those
9114: if ($subp eq 'default') { next; }
9115: my $value=$packagetab{$pack_entry};
9116: my $unikey;
9117: if ($pack =~ /_0$/) {
9118: $unikey='parameter_0_'.$name;
9119: $part=0;
9120: } else {
9121: $unikey='parameter'.$keyroot.'_'.$name;
9122: }
9123: if ($subp eq 'display') {
9124: $value.=' [Part: '.$part.']';
9125: }
9126: $metaentry{':'.$unikey.'.part'}=$part;
9127: $metathesekeys{$unikey}=1;
9128: unless (defined($metaentry{':'.$unikey.'.'.$subp})) {
9129: $metaentry{':'.$unikey.'.'.$subp}=$value;
9130: }
9131: if (defined($metaentry{':'.$unikey.'.default'})) {
9132: $metaentry{':'.$unikey}=
9133: $metaentry{':'.$unikey.'.default'};
9134: }
9135: }
9136: }
9137: } else {
9138: #
9139: # This is not a package - some other kind of start tag
9140: #
9141: my $entry=$token->[1];
9142: my $unikey='';
9143:
9144: if ($entry eq 'import') {
9145: #
9146: # Importing a library here
9147: #
9148: my $location=$parser->get_text('/import');
9149: my $dir=$filename;
9150: $dir=~s|[^/]*$||;
9151: $location=&filelocation($dir,$location);
9152:
9153: my $importmode=$token->[2]->{'importmode'};
9154: if ($importmode eq 'problem') {
9155: # Import as problem/response
9156: $unikey=&add_prefix_and_part($prefix,$token->[2]->{'part'});
9157: } elsif ($importmode eq 'part') {
9158: # Import as part(s)
9159: $importedparts=1;
9160: # We need to get the original file and the imported file to get the part order correct
9161: # Good news: we do not need to worry about nested libraries, since parts cannot be nested
9162: # Load and inspect original file
9163: if ($#origfileimportpartids<0) {
9164: undef(%importedpartids);
9165: my $origfilelocation=$perlvar{'lonDocRoot'}.&clutter($uri);
9166: my $origfile=&getfile($origfilelocation);
9167: @origfileimportpartids=($origfile=~/<(part|import)[^>]*id\s*=\s*[\"\']([^\"\']+)[\"\'][^>]*>/gs);
9168: }
9169:
9170: # Load and inspect imported file
9171: my $impfile=&getfile($location);
9172: my @impfilepartids=($impfile=~/<part[^>]*id\s*=\s*[\"\']([^\"\']+)[\"\'][^>]*>/gs);
9173: if ($#impfilepartids>=0) {
9174: # This problem had parts
9175: $importedpartids{$token->[2]->{'id'}}=join(',',@impfilepartids);
9176: } else {
9177: # Importing by turning a single problem into a problem part
9178: # It gets the import-tags ID as part-ID
9179: $unikey=&add_prefix_and_part($prefix,$token->[2]->{'id'});
9180: $importedpartids{$token->[2]->{'id'}}=$token->[2]->{'id'};
9181: }
9182: } else {
9183: # Normal import
9184: $unikey=&add_prefix_and_part($prefix,$token->[2]->{'part'});
9185: if (defined($token->[2]->{'id'})) {
9186: $unikey.='_'.$token->[2]->{'id'};
9187: }
9188: }
9189:
9190: if ($depthcount<20) {
9191: my $metadata =
9192: &metadata($uri,'keys', $location,$unikey,
9193: $depthcount+1);
9194: foreach my $meta (split(',',$metadata)) {
9195: $metaentry{':'.$meta}=$metaentry{':'.$meta};
9196: $metathesekeys{$meta}=1;
9197: }
9198:
9199: }
9200: } else {
9201: #
9202: # Not importing, some other kind of non-package, non-library start tag
9203: #
9204: $unikey=$entry.&add_prefix_and_part($prefix,$token->[2]->{'part'});
9205: if (defined($token->[2]->{'id'})) {
9206: $unikey.='_'.$token->[2]->{'id'};
9207: }
9208: if (defined($token->[2]->{'name'})) {
9209: $unikey.='_'.$token->[2]->{'name'};
9210: }
9211: $metathesekeys{$unikey}=1;
9212: foreach my $param (@{$token->[3]}) {
9213: $metaentry{':'.$unikey.'.'.$param} =
9214: $token->[2]->{$param};
9215: }
9216: my $internaltext=&HTML::Entities::decode($parser->get_text('/'.$entry));
9217: my $default=$metaentry{':'.$unikey.'.default'};
9218: if ( $internaltext =~ /^\s*$/ && $default !~ /^\s*$/) {
9219: # only ws inside the tag, and not in default, so use default
9220: # as value
9221: $metaentry{':'.$unikey}=$default;
9222: } elsif ( $internaltext =~ /\S/ ) {
9223: # something interesting inside the tag
9224: $metaentry{':'.$unikey}=$internaltext;
9225: } else {
9226: # no interesting values, don't set a default
9227: }
9228: # end of not-a-package not-a-library import
9229: }
9230: # end of not-a-package start tag
9231: }
9232: # the next is the end of "start tag"
9233: }
9234: }
9235: my ($extension) = ($uri =~ /\.(\w+)$/);
9236: $extension = lc($extension);
9237: if ($extension eq 'htm') { $extension='html'; }
9238:
9239: foreach my $key (keys(%packagetab)) {
9240: #no specific packages #how's our extension
9241: if ($key!~/^extension_\Q$extension\E&/) { next; }
9242: &metadata_create_package_def($uri,$key,'extension_'.$extension,
9243: \%metathesekeys);
9244: }
9245:
9246: if (!exists($metaentry{':packages'})
9247: || $packagetab{"import_defaults&extension_$extension"}) {
9248: foreach my $key (keys(%packagetab)) {
9249: #no specific packages well let's get default then
9250: if ($key!~/^default&/) { next; }
9251: &metadata_create_package_def($uri,$key,'default',
9252: \%metathesekeys);
9253: }
9254: }
9255: # are there custom rights to evaluate
9256: if ($metaentry{':copyright'} eq 'custom') {
9257:
9258: #
9259: # Importing a rights file here
9260: #
9261: unless ($depthcount) {
9262: my $location=$metaentry{':customdistributionfile'};
9263: my $dir=$filename;
9264: $dir=~s|[^/]*$||;
9265: $location=&filelocation($dir,$location);
9266: my $rights_metadata =
9267: &metadata($uri,'keys',$location,'_rights',
9268: $depthcount+1);
9269: foreach my $rights (split(',',$rights_metadata)) {
9270: #$metaentry{':'.$rights}=$metacache{$uri}->{':'.$rights};
9271: $metathesekeys{$rights}=1;
9272: }
9273: }
9274: }
9275: # uniqifiy package listing
9276: my %seen;
9277: my @uniq_packages =
9278: grep { ! $seen{$_} ++ } (split(',',$metaentry{':packages'}));
9279: $metaentry{':packages'} = join(',',@uniq_packages);
9280:
9281: if ($importedparts) {
9282: # We had imported parts and need to rebuild partorder
9283: $metaentry{':partorder'}='';
9284: $metathesekeys{'partorder'}=1;
9285: for (my $index=0;$index<$#origfileimportpartids;$index+=2) {
9286: if ($origfileimportpartids[$index] eq 'part') {
9287: # original part, part of the problem
9288: $metaentry{':partorder'}.=','.$origfileimportpartids[$index+1];
9289: } else {
9290: # we have imported parts at this position
9291: $metaentry{':partorder'}.=','.$importedpartids{$origfileimportpartids[$index+1]};
9292: }
9293: }
9294: $metaentry{':partorder'}=~s/^\,//;
9295: }
9296:
9297: $metaentry{':keys'} = join(',',keys(%metathesekeys));
9298: &metadata_generate_part0(\%metathesekeys,\%metaentry,$uri);
9299: $metaentry{':allpossiblekeys'}=join(',',keys %metathesekeys);
9300: &do_cache_new('meta',$uri,\%metaentry,$cachetime);
9301: # this is the end of "was not already recently cached
9302: }
9303: return $metaentry{':'.$what};
9304: }
9305:
9306: sub metadata_create_package_def {
9307: my ($uri,$key,$package,$metathesekeys)=@_;
9308: my ($pack,$name,$subp)=split(/\&/,$key);
9309: if ($subp eq 'default') { next; }
9310:
9311: if (defined($metaentry{':packages'})) {
9312: $metaentry{':packages'}.=','.$package;
9313: } else {
9314: $metaentry{':packages'}=$package;
9315: }
9316: my $value=$packagetab{$key};
9317: my $unikey;
9318: $unikey='parameter_0_'.$name;
9319: $metaentry{':'.$unikey.'.part'}=0;
9320: $$metathesekeys{$unikey}=1;
9321: unless (defined($metaentry{':'.$unikey.'.'.$subp})) {
9322: $metaentry{':'.$unikey.'.'.$subp}=$value;
9323: }
9324: if (defined($metaentry{':'.$unikey.'.default'})) {
9325: $metaentry{':'.$unikey}=
9326: $metaentry{':'.$unikey.'.default'};
9327: }
9328: }
9329:
9330: sub metadata_generate_part0 {
9331: my ($metadata,$metacache,$uri) = @_;
9332: my %allnames;
9333: foreach my $metakey (keys(%$metadata)) {
9334: if ($metakey=~/^parameter\_(.*)/) {
9335: my $part=$$metacache{':'.$metakey.'.part'};
9336: my $name=$$metacache{':'.$metakey.'.name'};
9337: if (! exists($$metadata{'parameter_0_'.$name.'.name'})) {
9338: $allnames{$name}=$part;
9339: }
9340: }
9341: }
9342: foreach my $name (keys(%allnames)) {
9343: $$metadata{"parameter_0_$name"}=1;
9344: my $key=":parameter_0_$name";
9345: $$metacache{"$key.part"}='0';
9346: $$metacache{"$key.name"}=$name;
9347: $$metacache{"$key.type"}=$$metacache{':parameter_'.
9348: $allnames{$name}.'_'.$name.
9349: '.type'};
9350: my $olddis=$$metacache{':parameter_'.$allnames{$name}.'_'.$name.
9351: '.display'};
9352: my $expr='[Part: '.$allnames{$name}.']';
9353: $olddis=~s/\Q$expr\E/\[Part: 0\]/;
9354: $$metacache{"$key.display"}=$olddis;
9355: }
9356: }
9357:
9358: # ------------------------------------------------------ Devalidate title cache
9359:
9360: sub devalidate_title_cache {
9361: my ($url)=@_;
9362: if (!$env{'request.course.id'}) { return; }
9363: my $symb=&symbread($url);
9364: if (!$symb) { return; }
9365: my $key=$env{'request.course.id'}."\0".$symb;
9366: &devalidate_cache_new('title',$key);
9367: }
9368:
9369: # ------------------------------------------------- Get the title of a course
9370:
9371: sub current_course_title {
9372: return $env{ 'course.' . $env{'request.course.id'} . '.description' };
9373: }
9374: # ------------------------------------------------- Get the title of a resource
9375:
9376: sub gettitle {
9377: my $urlsymb=shift;
9378: my $symb=&symbread($urlsymb);
9379: if ($symb) {
9380: my $key=$env{'request.course.id'}."\0".$symb;
9381: my ($result,$cached)=&is_cached_new('title',$key);
9382: if (defined($cached)) {
9383: return $result;
9384: }
9385: my ($map,$resid,$url)=&decode_symb($symb);
9386: my $title='';
9387: if (!$map && $resid == 0 && $url =~/default\.sequence$/) {
9388: $title = $env{'course.'.$env{'request.course.id'}.'.description'};
9389: } else {
9390: if (tie(my %bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
9391: &GDBM_READER(),0640)) {
9392: my $mapid=$bighash{'map_pc_'.&clutter($map)};
9393: $title=$bighash{'title_'.$mapid.'.'.$resid};
9394: untie(%bighash);
9395: }
9396: }
9397: $title=~s/\&colon\;/\:/gs;
9398: if ($title) {
9399: return &do_cache_new('title',$key,$title,600);
9400: }
9401: $urlsymb=$url;
9402: }
9403: my $title=&metadata($urlsymb,'title');
9404: if (!$title) { $title=(split('/',$urlsymb))[-1]; }
9405: return $title;
9406: }
9407:
9408: sub get_slot {
9409: my ($which,$cnum,$cdom)=@_;
9410: if (!$cnum || !$cdom) {
9411: (undef,my $courseid)=&whichuser();
9412: $cdom=$env{'course.'.$courseid.'.domain'};
9413: $cnum=$env{'course.'.$courseid.'.num'};
9414: }
9415: my $key=join("\0",'slots',$cdom,$cnum,$which);
9416: my %slotinfo;
9417: if (exists($remembered{$key})) {
9418: $slotinfo{$which} = $remembered{$key};
9419: } else {
9420: %slotinfo=&get('slots',[$which],$cdom,$cnum);
9421: &Apache::lonhomework::showhash(%slotinfo);
9422: my ($tmp)=keys(%slotinfo);
9423: if ($tmp=~/^error:/) { return (); }
9424: $remembered{$key} = $slotinfo{$which};
9425: }
9426: if (ref($slotinfo{$which}) eq 'HASH') {
9427: return %{$slotinfo{$which}};
9428: }
9429: return $slotinfo{$which};
9430: }
9431:
9432: sub get_reservable_slots {
9433: my ($cnum,$cdom,$uname,$udom) = @_;
9434: my $now = time;
9435: my $reservable_info;
9436: my $key=join("\0",'reservableslots',$cdom,$cnum,$uname,$udom);
9437: if (exists($remembered{$key})) {
9438: $reservable_info = $remembered{$key};
9439: } else {
9440: my %resv;
9441: ($resv{'now_order'},$resv{'now'},$resv{'future_order'},$resv{'future'}) =
9442: &Apache::loncommon::get_future_slots($cnum,$cdom,$now);
9443: $reservable_info = \%resv;
9444: $remembered{$key} = $reservable_info;
9445: }
9446: return $reservable_info;
9447: }
9448:
9449: sub get_course_slots {
9450: my ($cnum,$cdom) = @_;
9451: my $hashid=$cnum.':'.$cdom;
9452: my ($result,$cached) = &Apache::lonnet::is_cached_new('allslots',$hashid);
9453: if (defined($cached)) {
9454: if (ref($result) eq 'HASH') {
9455: return %{$result};
9456: }
9457: } else {
9458: my %slots=&Apache::lonnet::dump('slots',$cdom,$cnum);
9459: my ($tmp) = keys(%slots);
9460: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
9461: &Apache::lonnet::do_cache_new('allslots',$hashid,\%slots,600);
9462: return %slots;
9463: }
9464: }
9465: return;
9466: }
9467:
9468: sub devalidate_slots_cache {
9469: my ($cnum,$cdom)=@_;
9470: my $hashid=$cnum.':'.$cdom;
9471: &devalidate_cache_new('allslots',$hashid);
9472: }
9473:
9474: # ------------------------------------------------- Update symbolic store links
9475:
9476: sub symblist {
9477: my ($mapname,%newhash)=@_;
9478: $mapname=&deversion(&declutter($mapname));
9479: my %hash;
9480: if (($env{'request.course.fn'}) && (%newhash)) {
9481: if (tie(%hash,'GDBM_File',$env{'request.course.fn'}.'_symb.db',
9482: &GDBM_WRCREAT(),0640)) {
9483: foreach my $url (keys(%newhash)) {
9484: next if ($url eq 'last_known'
9485: && $env{'form.no_update_last_known'});
9486: $hash{declutter($url)}=&encode_symb($mapname,
9487: $newhash{$url}->[1],
9488: $newhash{$url}->[0]);
9489: }
9490: if (untie(%hash)) {
9491: return 'ok';
9492: }
9493: }
9494: }
9495: return 'error';
9496: }
9497:
9498: # --------------------------------------------------------------- Verify a symb
9499:
9500: sub symbverify {
9501: my ($symb,$thisurl)=@_;
9502: my $thisfn=$thisurl;
9503: $thisfn=&declutter($thisfn);
9504: # direct jump to resource in page or to a sequence - will construct own symbs
9505: if ($thisfn=~/\.(page|sequence)$/) { return 1; }
9506: # check URL part
9507: my ($map,$resid,$url)=&decode_symb($symb);
9508:
9509: unless ($url eq $thisfn) { return 0; }
9510:
9511: $symb=&symbclean($symb);
9512: $thisurl=&deversion($thisurl);
9513: $thisfn=&deversion($thisfn);
9514:
9515: my %bighash;
9516: my $okay=0;
9517:
9518: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
9519: &GDBM_READER(),0640)) {
9520: if (($thisurl =~ m{^/adm/wrapper/ext/}) || ($thisurl =~ m{^ext/})) {
9521: $thisurl =~ s/\?.+$//;
9522: }
9523: my $ids=$bighash{'ids_'.&clutter($thisurl)};
9524: unless ($ids) {
9525: my $idkey = 'ids_'.($thisurl =~ m{^/}? '' : '/').$thisurl;
9526: $ids=$bighash{$idkey};
9527: }
9528: if ($ids) {
9529: # ------------------------------------------------------------------- Has ID(s)
9530: foreach my $id (split(/\,/,$ids)) {
9531: my ($mapid,$resid)=split(/\./,$id);
9532: if ($thisfn =~ m{^/adm/wrapper/ext/}) {
9533: $symb =~ s/\?.+$//;
9534: }
9535: if (
9536: &symbclean(&declutter($bighash{'map_id_'.$mapid}).'___'.$resid.'___'.$thisfn)
9537: eq $symb) {
9538: if (($env{'request.role.adv'}) ||
9539: ($bighash{'encrypted_'.$id} eq $env{'request.enc'}) ||
9540: ($thisurl eq '/adm/navmaps')) {
9541: $okay=1;
9542: }
9543: }
9544: }
9545: }
9546: untie(%bighash);
9547: }
9548: return $okay;
9549: }
9550:
9551: # --------------------------------------------------------------- Clean-up symb
9552:
9553: sub symbclean {
9554: my $symb=shift;
9555: if ($symb=~m|^/enc/|) { $symb=&Apache::lonenc::unencrypted($symb); }
9556: # remove version from map
9557: $symb=~s/\.(\d+)\.(\w+)\_\_\_/\.$2\_\_\_/;
9558:
9559: # remove version from URL
9560: $symb=~s/\.(\d+)\.(\w+)$/\.$2/;
9561:
9562: # remove wrapper
9563:
9564: $symb=~s/(\_\_\_\d+\_\_\_)adm\/wrapper\/(res\/)*/$1/;
9565: $symb=~s/(\_\_\_\d+\_\_\_)adm\/coursedocs\/showdoc\/(res\/)*/$1/;
9566: return $symb;
9567: }
9568:
9569: # ---------------------------------------------- Split symb to find map and url
9570:
9571: sub encode_symb {
9572: my ($map,$resid,$url)=@_;
9573: return &symbclean(&declutter($map).'___'.$resid.'___'.&declutter($url));
9574: }
9575:
9576: sub decode_symb {
9577: my $symb=shift;
9578: if ($symb=~m|^/enc/|) { $symb=&Apache::lonenc::unencrypted($symb); }
9579: my ($map,$resid,$url)=split(/___/,$symb);
9580: return (&fixversion($map),$resid,&fixversion($url));
9581: }
9582:
9583: sub fixversion {
9584: my $fn=shift;
9585: if ($fn=~/^(adm|uploaded|editupload|public)/) { return $fn; }
9586: my %bighash;
9587: my $uri=&clutter($fn);
9588: my $key=$env{'request.course.id'}.'_'.$uri;
9589: # is this cached?
9590: my ($result,$cached)=&is_cached_new('courseresversion',$key);
9591: if (defined($cached)) { return $result; }
9592: # unfortunately not cached, or expired
9593: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
9594: &GDBM_READER(),0640)) {
9595: if ($bighash{'version_'.$uri}) {
9596: my $version=$bighash{'version_'.$uri};
9597: unless (($version eq 'mostrecent') ||
9598: ($version==&getversion($uri))) {
9599: $uri=~s/\.(\w+)$/\.$version\.$1/;
9600: }
9601: }
9602: untie %bighash;
9603: }
9604: return &do_cache_new('courseresversion',$key,&declutter($uri),600);
9605: }
9606:
9607: sub deversion {
9608: my $url=shift;
9609: $url=~s/\.\d+\.(\w+)$/\.$1/;
9610: return $url;
9611: }
9612:
9613: # ------------------------------------------------------ Return symb list entry
9614:
9615: sub symbread {
9616: my ($thisfn,$donotrecurse)=@_;
9617: my $cache_str='request.symbread.cached.'.$thisfn;
9618: if (defined($env{$cache_str})) { return $env{$cache_str}; }
9619: # no filename provided? try from environment
9620: unless ($thisfn) {
9621: if ($env{'request.symb'}) {
9622: return $env{$cache_str}=&symbclean($env{'request.symb'});
9623: }
9624: $thisfn=$env{'request.filename'};
9625: }
9626: if ($thisfn=~m|^/enc/|) { $thisfn=&Apache::lonenc::unencrypted($thisfn); }
9627: # is that filename actually a symb? Verify, clean, and return
9628: if ($thisfn=~/\_\_\_\d+\_\_\_(.*)$/) {
9629: if (&symbverify($thisfn,$1)) {
9630: return $env{$cache_str}=&symbclean($thisfn);
9631: }
9632: }
9633: $thisfn=declutter($thisfn);
9634: my %hash;
9635: my %bighash;
9636: my $syval='';
9637: if (($env{'request.course.fn'}) && ($thisfn)) {
9638: my $targetfn = $thisfn;
9639: if ( ($thisfn =~ m/^(uploaded|editupload)\//) && ($thisfn !~ m/\.(page|sequence)$/) ) {
9640: $targetfn = 'adm/wrapper/'.$thisfn;
9641: }
9642: if ($targetfn =~ m|^adm/wrapper/(ext/.*)|) {
9643: $targetfn=$1;
9644: }
9645: if (tie(%hash,'GDBM_File',$env{'request.course.fn'}.'_symb.db',
9646: &GDBM_READER(),0640)) {
9647: $syval=$hash{$targetfn};
9648: untie(%hash);
9649: }
9650: # ---------------------------------------------------------- There was an entry
9651: if ($syval) {
9652: #unless ($syval=~/\_\d+$/) {
9653: #unless ($env{'form.request.prefix'}=~/\.(\d+)\_$/) {
9654: #&appenv({'request.ambiguous' => $thisfn});
9655: #return $env{$cache_str}='';
9656: #}
9657: #$syval.=$1;
9658: #}
9659: } else {
9660: # ------------------------------------------------------- Was not in symb table
9661: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
9662: &GDBM_READER(),0640)) {
9663: # ---------------------------------------------- Get ID(s) for current resource
9664: my $ids=$bighash{'ids_'.&clutter($thisfn)};
9665: unless ($ids) {
9666: $ids=$bighash{'ids_/'.$thisfn};
9667: }
9668: unless ($ids) {
9669: # alias?
9670: $ids=$bighash{'mapalias_'.$thisfn};
9671: }
9672: if ($ids) {
9673: # ------------------------------------------------------------------- Has ID(s)
9674: my @possibilities=split(/\,/,$ids);
9675: if ($#possibilities==0) {
9676: # ----------------------------------------------- There is only one possibility
9677: my ($mapid,$resid)=split(/\./,$ids);
9678: $syval=&encode_symb($bighash{'map_id_'.$mapid},
9679: $resid,$thisfn);
9680: } elsif (!$donotrecurse) {
9681: # ------------------------------------------ There is more than one possibility
9682: my $realpossible=0;
9683: foreach my $id (@possibilities) {
9684: my $file=$bighash{'src_'.$id};
9685: if (&allowed('bre',$file)) {
9686: my ($mapid,$resid)=split(/\./,$id);
9687: if ($bighash{'map_type_'.$mapid} ne 'page') {
9688: $realpossible++;
9689: $syval=&encode_symb($bighash{'map_id_'.$mapid},
9690: $resid,$thisfn);
9691: }
9692: }
9693: }
9694: if ($realpossible!=1) { $syval=''; }
9695: } else {
9696: $syval='';
9697: }
9698: }
9699: untie(%bighash)
9700: }
9701: }
9702: if ($syval) {
9703: return $env{$cache_str}=$syval;
9704: }
9705: }
9706: &appenv({'request.ambiguous' => $thisfn});
9707: return $env{$cache_str}='';
9708: }
9709:
9710: # ---------------------------------------------------------- Return random seed
9711:
9712: sub numval {
9713: my $txt=shift;
9714: $txt=~tr/A-J/0-9/;
9715: $txt=~tr/a-j/0-9/;
9716: $txt=~tr/K-T/0-9/;
9717: $txt=~tr/k-t/0-9/;
9718: $txt=~tr/U-Z/0-5/;
9719: $txt=~tr/u-z/0-5/;
9720: $txt=~s/\D//g;
9721: if ($_64bit) { if ($txt > 2**32) { return -1; } }
9722: return int($txt);
9723: }
9724:
9725: sub numval2 {
9726: my $txt=shift;
9727: $txt=~tr/A-J/0-9/;
9728: $txt=~tr/a-j/0-9/;
9729: $txt=~tr/K-T/0-9/;
9730: $txt=~tr/k-t/0-9/;
9731: $txt=~tr/U-Z/0-5/;
9732: $txt=~tr/u-z/0-5/;
9733: $txt=~s/\D//g;
9734: my @txts=split(/(\d\d\d\d\d\d\d\d\d)/,$txt);
9735: my $total;
9736: foreach my $val (@txts) { $total+=$val; }
9737: if ($_64bit) { if ($total > 2**32) { return -1; } }
9738: return int($total);
9739: }
9740:
9741: sub numval3 {
9742: use integer;
9743: my $txt=shift;
9744: $txt=~tr/A-J/0-9/;
9745: $txt=~tr/a-j/0-9/;
9746: $txt=~tr/K-T/0-9/;
9747: $txt=~tr/k-t/0-9/;
9748: $txt=~tr/U-Z/0-5/;
9749: $txt=~tr/u-z/0-5/;
9750: $txt=~s/\D//g;
9751: my @txts=split(/(\d\d\d\d\d\d\d\d\d)/,$txt);
9752: my $total;
9753: foreach my $val (@txts) { $total+=$val; }
9754: if ($_64bit) { $total=(($total<<32)>>32); }
9755: return $total;
9756: }
9757:
9758: sub digest {
9759: my ($data)=@_;
9760: my $digest=&Digest::MD5::md5($data);
9761: my ($a,$b,$c,$d)=unpack("iiii",$digest);
9762: my ($e,$f);
9763: {
9764: use integer;
9765: $e=($a+$b);
9766: $f=($c+$d);
9767: if ($_64bit) {
9768: $e=(($e<<32)>>32);
9769: $f=(($f<<32)>>32);
9770: }
9771: }
9772: if (wantarray) {
9773: return ($e,$f);
9774: } else {
9775: my $g;
9776: {
9777: use integer;
9778: $g=($e+$f);
9779: if ($_64bit) {
9780: $g=(($g<<32)>>32);
9781: }
9782: }
9783: return $g;
9784: }
9785: }
9786:
9787: sub latest_rnd_algorithm_id {
9788: return '64bit5';
9789: }
9790:
9791: sub get_rand_alg {
9792: my ($courseid)=@_;
9793: if (!$courseid) { $courseid=(&whichuser())[1]; }
9794: if ($courseid) {
9795: return $env{"course.$courseid.rndseed"};
9796: }
9797: return &latest_rnd_algorithm_id();
9798: }
9799:
9800: sub validCODE {
9801: my ($CODE)=@_;
9802: if (defined($CODE) && $CODE ne '' && $CODE =~ /^\w+$/) { return 1; }
9803: return 0;
9804: }
9805:
9806: sub getCODE {
9807: if (&validCODE($env{'form.CODE'})) { return $env{'form.CODE'}; }
9808: if ( (defined($Apache::lonhomework::parsing_a_problem) ||
9809: defined($Apache::lonhomework::parsing_a_task) ) &&
9810: &validCODE($Apache::lonhomework::history{'resource.CODE'})) {
9811: return $Apache::lonhomework::history{'resource.CODE'};
9812: }
9813: return undef;
9814: }
9815: #
9816: # Determines the random seed for a specific context:
9817: #
9818: # parameters:
9819: # symb - in course context the symb for the seed.
9820: # course_id - The course id of the form domain_coursenum.
9821: # domain - Domain for the user.
9822: # course - Course for the user.
9823: # cenv - environment of the course.
9824: #
9825: # NOTE:
9826: # All parameters are picked out of the environment if missing
9827: # or not defined.
9828: # If a symb cannot be determined the current time is used instead.
9829: #
9830: # For a given well defined symb, courside, domain, username,
9831: # and course environment, the seed is reproducible.
9832: #
9833: sub rndseed {
9834: my ($symb,$courseid,$domain,$username, $cenv)=@_;
9835: my ($wsymb,$wcourseid,$wdomain,$wusername)=&whichuser();
9836: if (!defined($symb)) {
9837: unless ($symb=$wsymb) { return time; }
9838: }
9839: if (!defined $courseid) {
9840: $courseid=$wcourseid;
9841: }
9842: if (!defined $domain) { $domain=$wdomain; }
9843: if (!defined $username) { $username=$wusername }
9844:
9845: my $which;
9846: if (defined($cenv->{'rndseed'})) {
9847: $which = $cenv->{'rndseed'};
9848: } else {
9849: $which =&get_rand_alg($courseid);
9850: }
9851: if (defined(&getCODE())) {
9852:
9853: if ($which eq '64bit5') {
9854: return &rndseed_CODE_64bit5($symb,$courseid,$domain,$username);
9855: } elsif ($which eq '64bit4') {
9856: return &rndseed_CODE_64bit4($symb,$courseid,$domain,$username);
9857: } else {
9858: return &rndseed_CODE_64bit($symb,$courseid,$domain,$username);
9859: }
9860: } elsif ($which eq '64bit5') {
9861: return &rndseed_64bit5($symb,$courseid,$domain,$username);
9862: } elsif ($which eq '64bit4') {
9863: return &rndseed_64bit4($symb,$courseid,$domain,$username);
9864: } elsif ($which eq '64bit3') {
9865: return &rndseed_64bit3($symb,$courseid,$domain,$username);
9866: } elsif ($which eq '64bit2') {
9867: return &rndseed_64bit2($symb,$courseid,$domain,$username);
9868: } elsif ($which eq '64bit') {
9869: return &rndseed_64bit($symb,$courseid,$domain,$username);
9870: }
9871: return &rndseed_32bit($symb,$courseid,$domain,$username);
9872: }
9873:
9874: sub rndseed_32bit {
9875: my ($symb,$courseid,$domain,$username)=@_;
9876: {
9877: use integer;
9878: my $symbchck=unpack("%32C*",$symb) << 27;
9879: my $symbseed=numval($symb) << 22;
9880: my $namechck=unpack("%32C*",$username) << 17;
9881: my $nameseed=numval($username) << 12;
9882: my $domainseed=unpack("%32C*",$domain) << 7;
9883: my $courseseed=unpack("%32C*",$courseid);
9884: my $num=$symbseed+$nameseed+$domainseed+$courseseed+$namechck+$symbchck;
9885: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
9886: #&logthis("rndseed :$num:$symb");
9887: if ($_64bit) { $num=(($num<<32)>>32); }
9888: return $num;
9889: }
9890: }
9891:
9892: sub rndseed_64bit {
9893: my ($symb,$courseid,$domain,$username)=@_;
9894: {
9895: use integer;
9896: my $symbchck=unpack("%32S*",$symb) << 21;
9897: my $symbseed=numval($symb) << 10;
9898: my $namechck=unpack("%32S*",$username);
9899:
9900: my $nameseed=numval($username) << 21;
9901: my $domainseed=unpack("%32S*",$domain) << 10;
9902: my $courseseed=unpack("%32S*",$courseid);
9903:
9904: my $num1=$symbchck+$symbseed+$namechck;
9905: my $num2=$nameseed+$domainseed+$courseseed;
9906: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
9907: #&logthis("rndseed :$num:$symb");
9908: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
9909: return "$num1,$num2";
9910: }
9911: }
9912:
9913: sub rndseed_64bit2 {
9914: my ($symb,$courseid,$domain,$username)=@_;
9915: {
9916: use integer;
9917: # strings need to be an even # of cahracters long, it it is odd the
9918: # last characters gets thrown away
9919: my $symbchck=unpack("%32S*",$symb.' ') << 21;
9920: my $symbseed=numval($symb) << 10;
9921: my $namechck=unpack("%32S*",$username.' ');
9922:
9923: my $nameseed=numval($username) << 21;
9924: my $domainseed=unpack("%32S*",$domain.' ') << 10;
9925: my $courseseed=unpack("%32S*",$courseid.' ');
9926:
9927: my $num1=$symbchck+$symbseed+$namechck;
9928: my $num2=$nameseed+$domainseed+$courseseed;
9929: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
9930: #&logthis("rndseed :$num:$symb");
9931: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
9932: return "$num1,$num2";
9933: }
9934: }
9935:
9936: sub rndseed_64bit3 {
9937: my ($symb,$courseid,$domain,$username)=@_;
9938: {
9939: use integer;
9940: # strings need to be an even # of cahracters long, it it is odd the
9941: # last characters gets thrown away
9942: my $symbchck=unpack("%32S*",$symb.' ') << 21;
9943: my $symbseed=numval2($symb) << 10;
9944: my $namechck=unpack("%32S*",$username.' ');
9945:
9946: my $nameseed=numval2($username) << 21;
9947: my $domainseed=unpack("%32S*",$domain.' ') << 10;
9948: my $courseseed=unpack("%32S*",$courseid.' ');
9949:
9950: my $num1=$symbchck+$symbseed+$namechck;
9951: my $num2=$nameseed+$domainseed+$courseseed;
9952: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
9953: #&logthis("rndseed :$num1:$num2:$_64bit");
9954: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
9955:
9956: return "$num1:$num2";
9957: }
9958: }
9959:
9960: sub rndseed_64bit4 {
9961: my ($symb,$courseid,$domain,$username)=@_;
9962: {
9963: use integer;
9964: # strings need to be an even # of cahracters long, it it is odd the
9965: # last characters gets thrown away
9966: my $symbchck=unpack("%32S*",$symb.' ') << 21;
9967: my $symbseed=numval3($symb) << 10;
9968: my $namechck=unpack("%32S*",$username.' ');
9969:
9970: my $nameseed=numval3($username) << 21;
9971: my $domainseed=unpack("%32S*",$domain.' ') << 10;
9972: my $courseseed=unpack("%32S*",$courseid.' ');
9973:
9974: my $num1=$symbchck+$symbseed+$namechck;
9975: my $num2=$nameseed+$domainseed+$courseseed;
9976: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
9977: #&logthis("rndseed :$num1:$num2:$_64bit");
9978: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
9979:
9980: return "$num1:$num2";
9981: }
9982: }
9983:
9984: sub rndseed_64bit5 {
9985: my ($symb,$courseid,$domain,$username)=@_;
9986: my ($num1,$num2)=&digest("$symb,$courseid,$domain,$username");
9987: return "$num1:$num2";
9988: }
9989:
9990: sub rndseed_CODE_64bit {
9991: my ($symb,$courseid,$domain,$username)=@_;
9992: {
9993: use integer;
9994: my $symbchck=unpack("%32S*",$symb.' ') << 16;
9995: my $symbseed=numval2($symb);
9996: my $CODEchck=unpack("%32S*",&getCODE().' ') << 16;
9997: my $CODEseed=numval(&getCODE());
9998: my $courseseed=unpack("%32S*",$courseid.' ');
9999: my $num1=$symbseed+$CODEchck;
10000: my $num2=$CODEseed+$courseseed+$symbchck;
10001: #&logthis("$symbseed:$CODEchck|$CODEseed:$courseseed:$symbchck");
10002: #&logthis("rndseed :$num1:$num2:$symb");
10003: if ($_64bit) { $num1=(($num1<<32)>>32); }
10004: if ($_64bit) { $num2=(($num2<<32)>>32); }
10005: return "$num1:$num2";
10006: }
10007: }
10008:
10009: sub rndseed_CODE_64bit4 {
10010: my ($symb,$courseid,$domain,$username)=@_;
10011: {
10012: use integer;
10013: my $symbchck=unpack("%32S*",$symb.' ') << 16;
10014: my $symbseed=numval3($symb);
10015: my $CODEchck=unpack("%32S*",&getCODE().' ') << 16;
10016: my $CODEseed=numval3(&getCODE());
10017: my $courseseed=unpack("%32S*",$courseid.' ');
10018: my $num1=$symbseed+$CODEchck;
10019: my $num2=$CODEseed+$courseseed+$symbchck;
10020: #&logthis("$symbseed:$CODEchck|$CODEseed:$courseseed:$symbchck");
10021: #&logthis("rndseed :$num1:$num2:$symb");
10022: if ($_64bit) { $num1=(($num1<<32)>>32); }
10023: if ($_64bit) { $num2=(($num2<<32)>>32); }
10024: return "$num1:$num2";
10025: }
10026: }
10027:
10028: sub rndseed_CODE_64bit5 {
10029: my ($symb,$courseid,$domain,$username)=@_;
10030: my $code = &getCODE();
10031: my ($num1,$num2)=&digest("$symb,$courseid,$code");
10032: return "$num1:$num2";
10033: }
10034:
10035: sub setup_random_from_rndseed {
10036: my ($rndseed)=@_;
10037: if ($rndseed =~/([,:])/) {
10038: my ($num1,$num2)=split(/[,:]/,$rndseed);
10039: &Math::Random::random_set_seed(abs($num1),abs($num2));
10040: } else {
10041: &Math::Random::random_set_seed_from_phrase($rndseed);
10042: }
10043: }
10044:
10045: sub latest_receipt_algorithm_id {
10046: return 'receipt3';
10047: }
10048:
10049: sub recunique {
10050: my $fucourseid=shift;
10051: my $unique;
10052: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2' ||
10053: $env{"course.$fucourseid.receiptalg"} eq 'receipt3' ) {
10054: $unique=$env{"course.$fucourseid.internal.encseed"};
10055: } else {
10056: $unique=$perlvar{'lonReceipt'};
10057: }
10058: return unpack("%32C*",$unique);
10059: }
10060:
10061: sub recprefix {
10062: my $fucourseid=shift;
10063: my $prefix;
10064: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2'||
10065: $env{"course.$fucourseid.receiptalg"} eq 'receipt3' ) {
10066: $prefix=$env{"course.$fucourseid.internal.encpref"};
10067: } else {
10068: $prefix=$perlvar{'lonHostID'};
10069: }
10070: return unpack("%32C*",$prefix);
10071: }
10072:
10073: sub ireceipt {
10074: my ($funame,$fudom,$fucourseid,$fusymb,$part)=@_;
10075:
10076: my $return =&recprefix($fucourseid).'-';
10077:
10078: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt3' ||
10079: $env{'request.state'} eq 'construct') {
10080: $return .= (&digest("$funame,$fudom,$fucourseid,$fusymb,$part")%10000);
10081: return $return;
10082: }
10083:
10084: my $cuname=unpack("%32C*",$funame);
10085: my $cudom=unpack("%32C*",$fudom);
10086: my $cucourseid=unpack("%32C*",$fucourseid);
10087: my $cusymb=unpack("%32C*",$fusymb);
10088: my $cunique=&recunique($fucourseid);
10089: my $cpart=unpack("%32S*",$part);
10090: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2') {
10091:
10092: #&logthis("doing receipt2 using parts $cpart, uname $cuname and udom $cudom gets ".($cpart%$cuname)." and ".($cpart%$cudom));
10093:
10094: $return.= ($cunique%$cuname+
10095: $cunique%$cudom+
10096: $cusymb%$cuname+
10097: $cusymb%$cudom+
10098: $cucourseid%$cuname+
10099: $cucourseid%$cudom+
10100: $cpart%$cuname+
10101: $cpart%$cudom);
10102: } else {
10103: $return.= ($cunique%$cuname+
10104: $cunique%$cudom+
10105: $cusymb%$cuname+
10106: $cusymb%$cudom+
10107: $cucourseid%$cuname+
10108: $cucourseid%$cudom);
10109: }
10110: return $return;
10111: }
10112:
10113: sub receipt {
10114: my ($part)=@_;
10115: my ($symb,$courseid,$domain,$name) = &whichuser();
10116: return &ireceipt($name,$domain,$courseid,$symb,$part);
10117: }
10118:
10119: sub whichuser {
10120: my ($passedsymb)=@_;
10121: my ($symb,$courseid,$domain,$name,$publicuser);
10122: if (defined($env{'form.grade_symb'})) {
10123: my ($tmp_courseid)=&get_env_multiple('form.grade_courseid');
10124: my $allowed=&allowed('vgr',$tmp_courseid);
10125: if (!$allowed &&
10126: exists($env{'request.course.sec'}) &&
10127: $env{'request.course.sec'} !~ /^\s*$/) {
10128: $allowed=&allowed('vgr',$tmp_courseid.
10129: '/'.$env{'request.course.sec'});
10130: }
10131: if ($allowed) {
10132: ($symb)=&get_env_multiple('form.grade_symb');
10133: $courseid=$tmp_courseid;
10134: ($domain)=&get_env_multiple('form.grade_domain');
10135: ($name)=&get_env_multiple('form.grade_username');
10136: return ($symb,$courseid,$domain,$name,$publicuser);
10137: }
10138: }
10139: if (!$passedsymb) {
10140: $symb=&symbread();
10141: } else {
10142: $symb=$passedsymb;
10143: }
10144: $courseid=$env{'request.course.id'};
10145: $domain=$env{'user.domain'};
10146: $name=$env{'user.name'};
10147: if ($name eq 'public' && $domain eq 'public') {
10148: if (!defined($env{'form.username'})) {
10149: $env{'form.username'}.=time.rand(10000000);
10150: }
10151: $name.=$env{'form.username'};
10152: }
10153: return ($symb,$courseid,$domain,$name,$publicuser);
10154:
10155: }
10156:
10157: # ------------------------------------------------------------ Serves up a file
10158: # returns either the contents of the file or
10159: # -1 if the file doesn't exist
10160: #
10161: # if the target is a file that was uploaded via DOCS,
10162: # a check will be made to see if a current copy exists on the local server,
10163: # if it does this will be served, otherwise a copy will be retrieved from
10164: # the home server for the course and stored in /home/httpd/html/userfiles on
10165: # the local server.
10166:
10167: sub getfile {
10168: my ($file) = @_;
10169: if ($file =~ m -^/*(uploaded|editupload)/-) { $file=&filelocation("",$file); }
10170: &repcopy($file);
10171: return &readfile($file);
10172: }
10173:
10174: sub repcopy_userfile {
10175: my ($file)=@_;
10176: my $londocroot = $perlvar{'lonDocRoot'};
10177: if ($file =~ m{^/*(uploaded|editupload)/}) { $file=&filelocation("",$file); }
10178: if ($file =~ m{^\Q$londocroot/lonUsers/\E}) { return 'ok'; }
10179: my ($cdom,$cnum,$filename) =
10180: ($file=~m|^\Q$perlvar{'lonDocRoot'}\E/+userfiles/+($match_domain)/+($match_name)/+(.*)|);
10181: my $uri="/uploaded/$cdom/$cnum/$filename";
10182: if (-e "$file") {
10183: # we already have a local copy, check it out
10184: my @fileinfo = stat($file);
10185: my $rtncode;
10186: my $info;
10187: my $lwpresp = &getuploaded('HEAD',$uri,$cdom,$cnum,\$info,\$rtncode);
10188: if ($lwpresp ne 'ok') {
10189: # there is no such file anymore, even though we had a local copy
10190: if ($rtncode eq '404') {
10191: unlink($file);
10192: }
10193: return -1;
10194: }
10195: if ($info < $fileinfo[9]) {
10196: # nice, the file we have is up-to-date, just say okay
10197: return 'ok';
10198: } else {
10199: # the file is outdated, get rid of it
10200: unlink($file);
10201: }
10202: }
10203: # one way or the other, at this point, we don't have the file
10204: # construct the correct path for the file
10205: my @parts = ($cdom,$cnum);
10206: if ($filename =~ m|^(.+)/[^/]+$|) {
10207: push @parts, split(/\//,$1);
10208: }
10209: my $path = $perlvar{'lonDocRoot'}.'/userfiles';
10210: foreach my $part (@parts) {
10211: $path .= '/'.$part;
10212: if (!-e $path) {
10213: mkdir($path,0770);
10214: }
10215: }
10216: # now the path exists for sure
10217: # get a user agent
10218: my $ua=new LWP::UserAgent;
10219: my $transferfile=$file.'.in.transfer';
10220: # FIXME: this should flock
10221: if (-e $transferfile) { return 'ok'; }
10222: my $request;
10223: $uri=~s/^\///;
10224: my $homeserver = &homeserver($cnum,$cdom);
10225: my $protocol = $protocol{$homeserver};
10226: $protocol = 'http' if ($protocol ne 'https');
10227: $request=new HTTP::Request('GET',$protocol.'://'.&hostname($homeserver).'/raw/'.$uri);
10228: my $response=$ua->request($request,$transferfile);
10229: # did it work?
10230: if ($response->is_error()) {
10231: unlink($transferfile);
10232: &logthis("Userfile repcopy failed for $uri");
10233: return -1;
10234: }
10235: # worked, rename the transfer file
10236: rename($transferfile,$file);
10237: return 'ok';
10238: }
10239:
10240: sub tokenwrapper {
10241: my $uri=shift;
10242: $uri=~s|^https?\://([^/]+)||;
10243: $uri=~s|^/||;
10244: $env{'user.environment'}=~/\/([^\/]+)\.id/;
10245: my $token=$1;
10246: my (undef,$udom,$uname,$file)=split('/',$uri,4);
10247: if ($udom && $uname && $file) {
10248: $file=~s|(\?\.*)*$||;
10249: &appenv({"userfile.$udom/$uname/$file" => $env{'request.course.id'}});
10250: my $homeserver = &homeserver($uname,$udom);
10251: my $protocol = $protocol{$homeserver};
10252: $protocol = 'http' if ($protocol ne 'https');
10253: return $protocol.'://'.&hostname($homeserver).'/'.$uri.
10254: (($uri=~/\?/)?'&':'?').'token='.$token.
10255: '&tokenissued='.$perlvar{'lonHostID'};
10256: } else {
10257: return '/adm/notfound.html';
10258: }
10259: }
10260:
10261: # call with reqtype HEAD: get last modification time
10262: # call with reqtype GET: get the file contents
10263: # Do not call this with reqtype GET for large files! It loads everything into memory
10264: #
10265: sub getuploaded {
10266: my ($reqtype,$uri,$cdom,$cnum,$info,$rtncode) = @_;
10267: $uri=~s/^\///;
10268: my $homeserver = &homeserver($cnum,$cdom);
10269: my $protocol = $protocol{$homeserver};
10270: $protocol = 'http' if ($protocol ne 'https');
10271: $uri = $protocol.'://'.&hostname($homeserver).'/raw/'.$uri;
10272: my $ua=new LWP::UserAgent;
10273: my $request=new HTTP::Request($reqtype,$uri);
10274: my $response=$ua->request($request);
10275: $$rtncode = $response->code;
10276: if (! $response->is_success()) {
10277: return 'failed';
10278: }
10279: if ($reqtype eq 'HEAD') {
10280: $$info = &HTTP::Date::str2time( $response->header('Last-modified') );
10281: } elsif ($reqtype eq 'GET') {
10282: $$info = $response->content;
10283: }
10284: return 'ok';
10285: }
10286:
10287: sub readfile {
10288: my $file = shift;
10289: if ( (! -e $file ) || ($file eq '') ) { return -1; };
10290: my $fh;
10291: open($fh,"<$file");
10292: my $a='';
10293: while (my $line = <$fh>) { $a .= $line; }
10294: return $a;
10295: }
10296:
10297: sub filelocation {
10298: my ($dir,$file) = @_;
10299: my $location;
10300: $file=~ s/^\s*(\S+)\s*$/$1/; ## strip off leading and trailing spaces
10301:
10302: if ($file =~ m-^/adm/-) {
10303: $file=~s-^/adm/wrapper/-/-;
10304: $file=~s-^/adm/coursedocs/showdoc/-/-;
10305: }
10306:
10307: if ($file =~ m-^\Q$Apache::lonnet::perlvar{'lonTabDir'}\E/-) {
10308: $location = $file;
10309: } elsif ($file=~/^\/*(uploaded|editupload)/) { # is an uploaded file
10310: my ($udom,$uname,$filename)=
10311: ($file=~m -^/+(?:uploaded|editupload)/+($match_domain)/+($match_name)/+(.*)$-);
10312: my $home=&homeserver($uname,$udom);
10313: my $is_me=0;
10314: my @ids=¤t_machine_ids();
10315: foreach my $id (@ids) { if ($id eq $home) { $is_me=1; } }
10316: if ($is_me) {
10317: $location=propath($udom,$uname).'/userfiles/'.$filename;
10318: } else {
10319: $location=$Apache::lonnet::perlvar{'lonDocRoot'}.'/userfiles/'.
10320: $udom.'/'.$uname.'/'.$filename;
10321: }
10322: } elsif ($file =~ m-^/adm/-) {
10323: $location = $perlvar{'lonDocRoot'}.'/'.$file;
10324: } else {
10325: $file=~s/^\Q$perlvar{'lonDocRoot'}\E//;
10326: $file=~s:^/(res|priv)/:/:;
10327: my $space=$1;
10328: if ( !( $file =~ m:^/:) ) {
10329: $location = $dir. '/'.$file;
10330: } else {
10331: $location = $perlvar{'lonDocRoot'}.'/'.$space.$file;
10332: }
10333: }
10334: $location=~s://+:/:g; # remove duplicate /
10335: while ($location=~m{/\.\./}) {
10336: if ($location =~ m{/[^/]+/\.\./}) {
10337: $location=~ s{/[^/]+/\.\./}{/}g;
10338: } else {
10339: $location=~ s{/\.\./}{/}g;
10340: }
10341: } #remove dir/..
10342: while ($location=~m:/\./:) {$location=~ s:/\./:/:g;} #remove /./
10343: return $location;
10344: }
10345:
10346: sub hreflocation {
10347: my ($dir,$file)=@_;
10348: unless (($file=~m-^https?\://-i) || ($file=~m-^/-)) {
10349: $file=filelocation($dir,$file);
10350: } elsif ($file=~m-^/adm/-) {
10351: $file=~s-^/adm/wrapper/-/-;
10352: $file=~s-^/adm/coursedocs/showdoc/-/-;
10353: }
10354: if ($file=~m-^\Q$perlvar{'lonDocRoot'}\E-) {
10355: $file=~s-^\Q$perlvar{'lonDocRoot'}\E--;
10356: } elsif ($file=~m-^\Q$perlvar{'lonUsersDir'}\E-) {
10357: $file=~s{^/home/httpd/lonUsers/($match_domain)/./././($match_name)/userfiles/}
10358: {/uploaded/$1/$2/}x;
10359: }
10360: if ($file=~ m{^/userfiles/}) {
10361: $file =~ s{^/userfiles/}{/uploaded/};
10362: }
10363: return $file;
10364: }
10365:
10366:
10367:
10368:
10369:
10370: sub current_machine_domains {
10371: return &machine_domains(&hostname($perlvar{'lonHostID'}));
10372: }
10373:
10374: sub machine_domains {
10375: my ($hostname) = @_;
10376: my @domains;
10377: my %hostname = &all_hostnames();
10378: while( my($id, $name) = each(%hostname)) {
10379: # &logthis("-$id-$name-$hostname-");
10380: if ($hostname eq $name) {
10381: push(@domains,&host_domain($id));
10382: }
10383: }
10384: return @domains;
10385: }
10386:
10387: sub current_machine_ids {
10388: return &machine_ids(&hostname($perlvar{'lonHostID'}));
10389: }
10390:
10391: sub machine_ids {
10392: my ($hostname) = @_;
10393: $hostname ||= &hostname($perlvar{'lonHostID'});
10394: my @ids;
10395: my %name_to_host = &all_names();
10396: if (ref($name_to_host{$hostname}) eq 'ARRAY') {
10397: return @{ $name_to_host{$hostname} };
10398: }
10399: return;
10400: }
10401:
10402: sub additional_machine_domains {
10403: my @domains;
10404: open(my $fh,"<$perlvar{'lonTabDir'}/expected_domains.tab");
10405: while( my $line = <$fh>) {
10406: $line =~ s/\s//g;
10407: push(@domains,$line);
10408: }
10409: return @domains;
10410: }
10411:
10412: sub default_login_domain {
10413: my $domain = $perlvar{'lonDefDomain'};
10414: my $testdomain=(split(/\./,$ENV{'HTTP_HOST'}))[0];
10415: foreach my $posdom (¤t_machine_domains(),
10416: &additional_machine_domains()) {
10417: if (lc($posdom) eq lc($testdomain)) {
10418: $domain=$posdom;
10419: last;
10420: }
10421: }
10422: return $domain;
10423: }
10424:
10425: # ------------------------------------------------------------- Declutters URLs
10426:
10427: sub declutter {
10428: my $thisfn=shift;
10429: if ($thisfn=~m|^/enc/|) { $thisfn=&Apache::lonenc::unencrypted($thisfn); }
10430: $thisfn=~s/^\Q$perlvar{'lonDocRoot'}\E//;
10431: $thisfn=~s/^\///;
10432: $thisfn=~s|^adm/wrapper/||;
10433: $thisfn=~s|^adm/coursedocs/showdoc/||;
10434: $thisfn=~s/^res\///;
10435: unless (($thisfn =~ /^ext/) || ($thisfn =~ /\.(page|sequence)___\d+___ext/)) {
10436: $thisfn=~s/\?.+$//;
10437: }
10438: return $thisfn;
10439: }
10440:
10441: # ------------------------------------------------------------- Clutter up URLs
10442:
10443: sub clutter {
10444: my $thisfn='/'.&declutter(shift);
10445: if ($thisfn !~ m{^/(uploaded|editupload|adm|userfiles|ext|raw|priv|public)/}
10446: || $thisfn =~ m{^/adm/(includes|pages)} ) {
10447: $thisfn='/res'.$thisfn;
10448: }
10449: if ($thisfn !~m|^/adm|) {
10450: if ($thisfn =~ m|^/ext/|) {
10451: $thisfn='/adm/wrapper'.$thisfn;
10452: } else {
10453: my ($ext) = ($thisfn =~ /\.(\w+)$/);
10454: my $embstyle=&Apache::loncommon::fileembstyle($ext);
10455: if ($embstyle eq 'ssi'
10456: || ($embstyle eq 'hdn')
10457: || ($embstyle eq 'rat')
10458: || ($embstyle eq 'prv')
10459: || ($embstyle eq 'ign')) {
10460: #do nothing with these
10461: } elsif (($embstyle eq 'img')
10462: || ($embstyle eq 'emb')
10463: || ($embstyle eq 'wrp')) {
10464: $thisfn='/adm/wrapper'.$thisfn;
10465: } elsif ($embstyle eq 'unk'
10466: && $thisfn!~/\.(sequence|page)$/) {
10467: $thisfn='/adm/coursedocs/showdoc'.$thisfn;
10468: } else {
10469: # &logthis("Got a blank emb style");
10470: }
10471: }
10472: }
10473: return $thisfn;
10474: }
10475:
10476: sub clutter_with_no_wrapper {
10477: my $uri = &clutter(shift);
10478: if ($uri =~ m-^/adm/-) {
10479: $uri =~ s-^/adm/wrapper/-/-;
10480: $uri =~ s-^/adm/coursedocs/showdoc/-/-;
10481: }
10482: return $uri;
10483: }
10484:
10485: sub freeze_escape {
10486: my ($value)=@_;
10487: if (ref($value)) {
10488: $value=&nfreeze($value);
10489: return '__FROZEN__'.&escape($value);
10490: }
10491: return &escape($value);
10492: }
10493:
10494:
10495: sub thaw_unescape {
10496: my ($value)=@_;
10497: if ($value =~ /^__FROZEN__/) {
10498: substr($value,0,10,undef);
10499: $value=&unescape($value);
10500: return &thaw($value);
10501: }
10502: return &unescape($value);
10503: }
10504:
10505: sub correct_line_ends {
10506: my ($result)=@_;
10507: $$result =~s/\r\n/\n/mg;
10508: $$result =~s/\r/\n/mg;
10509: }
10510: # ================================================================ Main Program
10511:
10512: sub goodbye {
10513: &logthis("Starting Shut down");
10514: #not converted to using infrastruture and probably shouldn't be
10515: &logthis(sprintf("%-20s is %s",'%badServerCache',length(&nfreeze(\%badServerCache))));
10516: #converted
10517: # &logthis(sprintf("%-20s is %s",'%metacache',scalar(%metacache)));
10518: &logthis(sprintf("%-20s is %s",'%homecache',length(&nfreeze(\%homecache))));
10519: # &logthis(sprintf("%-20s is %s",'%titlecache',length(&nfreeze(\%titlecache))));
10520: # &logthis(sprintf("%-20s is %s",'%courseresdatacache',length(&nfreeze(\%courseresdatacache))));
10521: #1.1 only
10522: # &logthis(sprintf("%-20s is %s",'%userresdatacache',length(&nfreeze(\%userresdatacache))));
10523: # &logthis(sprintf("%-20s is %s",'%getsectioncache',length(&nfreeze(\%getsectioncache))));
10524: # &logthis(sprintf("%-20s is %s",'%courseresversioncache',length(&nfreeze(\%courseresversioncache))));
10525: # &logthis(sprintf("%-20s is %s",'%resversioncache',length(&nfreeze(\%resversioncache))));
10526: &logthis(sprintf("%-20s is %s",'%remembered',length(&nfreeze(\%remembered))));
10527: &logthis(sprintf("%-20s is %s",'kicks',$kicks));
10528: &logthis(sprintf("%-20s is %s",'hits',$hits));
10529: &flushcourselogs();
10530: &logthis("Shutting down");
10531: }
10532:
10533: sub get_dns {
10534: my ($url,$func,$ignore_cache) = @_;
10535: if (!$ignore_cache) {
10536: my ($content,$cached)=
10537: &Apache::lonnet::is_cached_new('dns',$url);
10538: if ($cached) {
10539: &$func($content);
10540: return;
10541: }
10542: }
10543:
10544: my %alldns;
10545: open(my $config,"<$perlvar{'lonTabDir'}/hosts.tab");
10546: foreach my $dns (<$config>) {
10547: next if ($dns !~ /^\^(\S*)/x);
10548: my $line = $1;
10549: my ($host,$protocol) = split(/:/,$line);
10550: if ($protocol ne 'https') {
10551: $protocol = 'http';
10552: }
10553: $alldns{$host} = $protocol;
10554: }
10555: while (%alldns) {
10556: my ($dns) = keys(%alldns);
10557: my $ua=new LWP::UserAgent;
10558: $ua->timeout(30);
10559: my $request=new HTTP::Request('GET',"$alldns{$dns}://$dns$url");
10560: my $response=$ua->request($request);
10561: delete($alldns{$dns});
10562: next if ($response->is_error());
10563: my @content = split("\n",$response->content);
10564: &Apache::lonnet::do_cache_new('dns',$url,\@content,30*24*60*60);
10565: &$func(\@content);
10566: return;
10567: }
10568: close($config);
10569: my $which = (split('/',$url))[3];
10570: &logthis("unable to contact DNS defaulting to on disk file dns_$which.tab\n");
10571: open($config,"<$perlvar{'lonTabDir'}/dns_$which.tab");
10572: my @content = <$config>;
10573: &$func(\@content);
10574: return;
10575: }
10576: # ------------------------------------------------------------ Read domain file
10577: {
10578: my $loaded;
10579: my %domain;
10580:
10581: sub parse_domain_tab {
10582: my ($lines) = @_;
10583: foreach my $line (@$lines) {
10584: next if ($line =~ /^(\#|\s*$ )/x);
10585:
10586: chomp($line);
10587: my ($name,@elements) = split(/:/,$line,9);
10588: my %this_domain;
10589: foreach my $field ('description', 'auth_def', 'auth_arg_def',
10590: 'lang_def', 'city', 'longi', 'lati',
10591: 'primary') {
10592: $this_domain{$field} = shift(@elements);
10593: }
10594: $domain{$name} = \%this_domain;
10595: }
10596: }
10597:
10598: sub reset_domain_info {
10599: undef($loaded);
10600: undef(%domain);
10601: }
10602:
10603: sub load_domain_tab {
10604: my ($ignore_cache) = @_;
10605: &get_dns('/adm/dns/domain',\&parse_domain_tab,$ignore_cache);
10606: my $fh;
10607: if (open($fh,"<".$perlvar{'lonTabDir'}.'/domain.tab')) {
10608: my @lines = <$fh>;
10609: &parse_domain_tab(\@lines);
10610: }
10611: close($fh);
10612: $loaded = 1;
10613: }
10614:
10615: sub domain {
10616: &load_domain_tab() if (!$loaded);
10617:
10618: my ($name,$what) = @_;
10619: return if ( !exists($domain{$name}) );
10620:
10621: if (!$what) {
10622: return $domain{$name}{'description'};
10623: }
10624: return $domain{$name}{$what};
10625: }
10626:
10627: sub domain_info {
10628: &load_domain_tab() if (!$loaded);
10629: return %domain;
10630: }
10631:
10632: }
10633:
10634:
10635: # ------------------------------------------------------------- Read hosts file
10636: {
10637: my %hostname;
10638: my %hostdom;
10639: my %libserv;
10640: my $loaded;
10641: my %name_to_host;
10642: my %internetdom;
10643: my %LC_dns_serv;
10644:
10645: sub parse_hosts_tab {
10646: my ($file) = @_;
10647: foreach my $configline (@$file) {
10648: next if ($configline =~ /^(\#|\s*$ )/x);
10649: chomp($configline);
10650: if ($configline =~ /^\^/) {
10651: if ($configline =~ /^\^([\w.\-]+)/) {
10652: $LC_dns_serv{$1} = 1;
10653: }
10654: next;
10655: }
10656: my ($id,$domain,$role,$name,$protocol,$intdom)=split(/:/,$configline);
10657: $name=~s/\s//g;
10658: if ($id && $domain && $role && $name) {
10659: $hostname{$id}=$name;
10660: push(@{$name_to_host{$name}}, $id);
10661: $hostdom{$id}=$domain;
10662: if ($role eq 'library') { $libserv{$id}=$name; }
10663: if (defined($protocol)) {
10664: if ($protocol eq 'https') {
10665: $protocol{$id} = $protocol;
10666: } else {
10667: $protocol{$id} = 'http';
10668: }
10669: } else {
10670: $protocol{$id} = 'http';
10671: }
10672: if (defined($intdom)) {
10673: $internetdom{$id} = $intdom;
10674: }
10675: }
10676: }
10677: }
10678:
10679: sub reset_hosts_info {
10680: &purge_remembered();
10681: &reset_domain_info();
10682: &reset_hosts_ip_info();
10683: undef(%name_to_host);
10684: undef(%hostname);
10685: undef(%hostdom);
10686: undef(%libserv);
10687: undef($loaded);
10688: }
10689:
10690: sub load_hosts_tab {
10691: my ($ignore_cache) = @_;
10692: &get_dns('/adm/dns/hosts',\&parse_hosts_tab,$ignore_cache);
10693: open(my $config,"<$perlvar{'lonTabDir'}/hosts.tab");
10694: my @config = <$config>;
10695: &parse_hosts_tab(\@config);
10696: close($config);
10697: $loaded=1;
10698: }
10699:
10700: sub hostname {
10701: &load_hosts_tab() if (!$loaded);
10702:
10703: my ($lonid) = @_;
10704: return $hostname{$lonid};
10705: }
10706:
10707: sub all_hostnames {
10708: &load_hosts_tab() if (!$loaded);
10709:
10710: return %hostname;
10711: }
10712:
10713: sub all_names {
10714: &load_hosts_tab() if (!$loaded);
10715:
10716: return %name_to_host;
10717: }
10718:
10719: sub all_host_domain {
10720: &load_hosts_tab() if (!$loaded);
10721: return %hostdom;
10722: }
10723:
10724: sub is_library {
10725: &load_hosts_tab() if (!$loaded);
10726:
10727: return exists($libserv{$_[0]});
10728: }
10729:
10730: sub all_library {
10731: &load_hosts_tab() if (!$loaded);
10732:
10733: return %libserv;
10734: }
10735:
10736: sub unique_library {
10737: #2x reverse removes all hostnames that appear more than once
10738: my %unique = reverse &all_library();
10739: return reverse %unique;
10740: }
10741:
10742: sub get_servers {
10743: &load_hosts_tab() if (!$loaded);
10744:
10745: my ($domain,$type) = @_;
10746: my %possible_hosts = ($type eq 'library') ? %libserv
10747: : %hostname;
10748: my %result;
10749: if (ref($domain) eq 'ARRAY') {
10750: while ( my ($host,$hostname) = each(%possible_hosts)) {
10751: if (grep(/^\Q$hostdom{$host}\E$/,@$domain)) {
10752: $result{$host} = $hostname;
10753: }
10754: }
10755: } else {
10756: while ( my ($host,$hostname) = each(%possible_hosts)) {
10757: if ($hostdom{$host} eq $domain) {
10758: $result{$host} = $hostname;
10759: }
10760: }
10761: }
10762: return %result;
10763: }
10764:
10765: sub get_unique_servers {
10766: my %unique = reverse &get_servers(@_);
10767: return reverse %unique;
10768: }
10769:
10770: sub host_domain {
10771: &load_hosts_tab() if (!$loaded);
10772:
10773: my ($lonid) = @_;
10774: return $hostdom{$lonid};
10775: }
10776:
10777: sub all_domains {
10778: &load_hosts_tab() if (!$loaded);
10779:
10780: my %seen;
10781: my @uniq = grep(!$seen{$_}++, values(%hostdom));
10782: return @uniq;
10783: }
10784:
10785: sub internet_dom {
10786: &load_hosts_tab() if (!$loaded);
10787:
10788: my ($lonid) = @_;
10789: return $internetdom{$lonid};
10790: }
10791:
10792: sub is_LC_dns {
10793: &load_hosts_tab() if (!$loaded);
10794:
10795: my ($hostname) = @_;
10796: return exists($LC_dns_serv{$hostname});
10797: }
10798:
10799: }
10800:
10801: {
10802: my %iphost;
10803: my %name_to_ip;
10804: my %lonid_to_ip;
10805:
10806: sub get_hosts_from_ip {
10807: my ($ip) = @_;
10808: my %iphosts = &get_iphost();
10809: if (ref($iphosts{$ip})) {
10810: return @{$iphosts{$ip}};
10811: }
10812: return;
10813: }
10814:
10815: sub reset_hosts_ip_info {
10816: undef(%iphost);
10817: undef(%name_to_ip);
10818: undef(%lonid_to_ip);
10819: }
10820:
10821: sub get_host_ip {
10822: my ($lonid) = @_;
10823: if (exists($lonid_to_ip{$lonid})) {
10824: return $lonid_to_ip{$lonid};
10825: }
10826: my $name=&hostname($lonid);
10827: my $ip = gethostbyname($name);
10828: return if (!$ip || length($ip) ne 4);
10829: $ip=inet_ntoa($ip);
10830: $name_to_ip{$name} = $ip;
10831: $lonid_to_ip{$lonid} = $ip;
10832: return $ip;
10833: }
10834:
10835: sub get_iphost {
10836: my ($ignore_cache) = @_;
10837:
10838: if (!$ignore_cache) {
10839: if (%iphost) {
10840: return %iphost;
10841: }
10842: my ($ip_info,$cached)=
10843: &Apache::lonnet::is_cached_new('iphost','iphost');
10844: if ($cached) {
10845: %iphost = %{$ip_info->[0]};
10846: %name_to_ip = %{$ip_info->[1]};
10847: %lonid_to_ip = %{$ip_info->[2]};
10848: return %iphost;
10849: }
10850: }
10851:
10852: # get yesterday's info for fallback
10853: my %old_name_to_ip;
10854: my ($ip_info,$cached)=
10855: &Apache::lonnet::is_cached_new('iphost','iphost');
10856: if ($cached) {
10857: %old_name_to_ip = %{$ip_info->[1]};
10858: }
10859:
10860: my %name_to_host = &all_names();
10861: foreach my $name (keys(%name_to_host)) {
10862: my $ip;
10863: if (!exists($name_to_ip{$name})) {
10864: $ip = gethostbyname($name);
10865: if (!$ip || length($ip) ne 4) {
10866: if (defined($old_name_to_ip{$name})) {
10867: $ip = $old_name_to_ip{$name};
10868: &logthis("Can't find $name defaulting to old $ip");
10869: } else {
10870: &logthis("Name $name no IP found");
10871: next;
10872: }
10873: } else {
10874: $ip=inet_ntoa($ip);
10875: }
10876: $name_to_ip{$name} = $ip;
10877: } else {
10878: $ip = $name_to_ip{$name};
10879: }
10880: foreach my $id (@{ $name_to_host{$name} }) {
10881: $lonid_to_ip{$id} = $ip;
10882: }
10883: push(@{$iphost{$ip}},@{$name_to_host{$name}});
10884: }
10885: &Apache::lonnet::do_cache_new('iphost','iphost',
10886: [\%iphost,\%name_to_ip,\%lonid_to_ip],
10887: 48*60*60);
10888:
10889: return %iphost;
10890: }
10891:
10892: #
10893: # Given a DNS returns the loncapa host name for that DNS
10894: #
10895: sub host_from_dns {
10896: my ($dns) = @_;
10897: my @hosts;
10898: my $ip;
10899:
10900: if (exists($name_to_ip{$dns})) {
10901: $ip = $name_to_ip{$dns};
10902: }
10903: if (!$ip) {
10904: $ip = gethostbyname($dns); # Initial translation to IP is in net order.
10905: if (length($ip) == 4) {
10906: $ip = &IO::Socket::inet_ntoa($ip);
10907: }
10908: }
10909: if ($ip) {
10910: @hosts = get_hosts_from_ip($ip);
10911: return $hosts[0];
10912: }
10913: return undef;
10914: }
10915:
10916: sub get_internet_names {
10917: my ($lonid) = @_;
10918: return if ($lonid eq '');
10919: my ($idnref,$cached)=
10920: &Apache::lonnet::is_cached_new('internetnames',$lonid);
10921: if ($cached) {
10922: return $idnref;
10923: }
10924: my $ip = &get_host_ip($lonid);
10925: my @hosts = &get_hosts_from_ip($ip);
10926: my %iphost = &get_iphost();
10927: my (@idns,%seen);
10928: foreach my $id (@hosts) {
10929: my $dom = &host_domain($id);
10930: my $prim_id = &domain($dom,'primary');
10931: my $prim_ip = &get_host_ip($prim_id);
10932: next if ($seen{$prim_ip});
10933: if (ref($iphost{$prim_ip}) eq 'ARRAY') {
10934: foreach my $id (@{$iphost{$prim_ip}}) {
10935: my $intdom = &internet_dom($id);
10936: unless (grep(/^\Q$intdom\E$/,@idns)) {
10937: push(@idns,$intdom);
10938: }
10939: }
10940: }
10941: $seen{$prim_ip} = 1;
10942: }
10943: return &Apache::lonnet::do_cache_new('internetnames',$lonid,\@idns,12*60*60);
10944: }
10945:
10946: }
10947:
10948: sub all_loncaparevs {
10949: 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);
10950: }
10951:
10952: BEGIN {
10953:
10954: # ----------------------------------- Read loncapa.conf and loncapa_apache.conf
10955: unless ($readit) {
10956: {
10957: my $configvars = LONCAPA::Configuration::read_conf('loncapa.conf');
10958: %perlvar = (%perlvar,%{$configvars});
10959: }
10960:
10961:
10962: # ------------------------------------------------------ Read spare server file
10963: {
10964: open(my $config,"<$perlvar{'lonTabDir'}/spare.tab");
10965:
10966: while (my $configline=<$config>) {
10967: chomp($configline);
10968: if ($configline) {
10969: my ($host,$type) = split(':',$configline,2);
10970: if (!defined($type) || $type eq '') { $type = 'default' };
10971: push(@{ $spareid{$type} }, $host);
10972: }
10973: }
10974: close($config);
10975: }
10976: # ------------------------------------------------------------ Read permissions
10977: {
10978: open(my $config,"<$perlvar{'lonTabDir'}/roles.tab");
10979:
10980: while (my $configline=<$config>) {
10981: chomp($configline);
10982: if ($configline) {
10983: my ($role,$perm)=split(/ /,$configline);
10984: if ($perm ne '') { $pr{$role}=$perm; }
10985: }
10986: }
10987: close($config);
10988: }
10989:
10990: # -------------------------------------------- Read plain texts for permissions
10991: {
10992: open(my $config,"<$perlvar{'lonTabDir'}/rolesplain.tab");
10993:
10994: while (my $configline=<$config>) {
10995: chomp($configline);
10996: if ($configline) {
10997: my ($short,@plain)=split(/:/,$configline);
10998: %{$prp{$short}} = ();
10999: if (@plain > 0) {
11000: $prp{$short}{'std'} = $plain[0];
11001: for (my $i=1; $i<@plain; $i++) {
11002: $prp{$short}{'alt'.$i} = $plain[$i];
11003: }
11004: }
11005: }
11006: }
11007: close($config);
11008: }
11009:
11010: # ---------------------------------------------------------- Read package table
11011: {
11012: open(my $config,"<$perlvar{'lonTabDir'}/packages.tab");
11013:
11014: while (my $configline=<$config>) {
11015: if ($configline !~ /\S/ || $configline=~/^#/) { next; }
11016: chomp($configline);
11017: my ($short,$plain)=split(/:/,$configline);
11018: my ($pack,$name)=split(/\&/,$short);
11019: if ($plain ne '') {
11020: $packagetab{$pack.'&'.$name.'&name'}=$name;
11021: $packagetab{$short}=$plain;
11022: }
11023: }
11024: close($config);
11025: }
11026:
11027: # ---------------------------------------------------------- Read loncaparev table
11028: {
11029: if (-e "$perlvar{'lonTabDir'}/loncaparevs.tab") {
11030: if (open(my $config,"<$perlvar{'lonTabDir'}/loncaparevs.tab")) {
11031: while (my $configline=<$config>) {
11032: chomp($configline);
11033: my ($hostid,$loncaparev)=split(/:/,$configline);
11034: $loncaparevs{$hostid}=$loncaparev;
11035: }
11036: close($config);
11037: }
11038: }
11039: }
11040:
11041: # ---------------------------------------------------------- Read serverhostID table
11042: {
11043: if (-e "$perlvar{'lonTabDir'}/serverhomeIDs.tab") {
11044: if (open(my $config,"<$perlvar{'lonTabDir'}/serverhomeIDs.tab")) {
11045: while (my $configline=<$config>) {
11046: chomp($configline);
11047: my ($name,$id)=split(/:/,$configline);
11048: $serverhomeIDs{$name}=$id;
11049: }
11050: close($config);
11051: }
11052: }
11053: }
11054:
11055: {
11056: my $file = $Apache::lonnet::perlvar{'lonTabDir'}.'/releaseslist.xml';
11057: if (-e $file) {
11058: my $parser = HTML::LCParser->new($file);
11059: while (my $token = $parser->get_token()) {
11060: if ($token->[0] eq 'S') {
11061: my $item = $token->[1];
11062: my $name = $token->[2]{'name'};
11063: my $value = $token->[2]{'value'};
11064: if ($item ne '' && $name ne '' && $value ne '') {
11065: my $release = $parser->get_text();
11066: $release =~ s/(^\s*|\s*$ )//gx;
11067: $needsrelease{$item.':'.$name.':'.$value} = $release;
11068: }
11069: }
11070: }
11071: }
11072: }
11073:
11074: # ---------------------------------------------------------- Read managers table
11075: {
11076: if (-e "$perlvar{'lonTabDir'}/managers.tab") {
11077: if (open(my $config,"<$perlvar{'lonTabDir'}/managers.tab")) {
11078: while (my $configline=<$config>) {
11079: chomp($configline);
11080: next if ($configline =~ /^\#/);
11081: if (($configline =~ /^[\w\-]+$/) || ($configline =~ /^[\w\-]+\:[\w\-]+$/)) {
11082: $managerstab{$configline} = 1;
11083: }
11084: }
11085: close($config);
11086: }
11087: }
11088: }
11089:
11090: # ------------- set up temporary directory
11091: {
11092: $tmpdir = LONCAPA::tempdir();
11093:
11094: }
11095:
11096: $memcache=new Cache::Memcached({'servers' => ['127.0.0.1:11211'],
11097: 'compress_threshold'=> 20_000,
11098: });
11099:
11100: $processmarker='_'.time.'_'.$perlvar{'lonHostID'};
11101: $dumpcount=0;
11102: $locknum=0;
11103:
11104: &logtouch();
11105: &logthis('<font color="yellow">INFO: Read configuration</font>');
11106: $readit=1;
11107: {
11108: use integer;
11109: my $test=(2**32)+1;
11110: if ($test != 0) { $_64bit=1; } else { $_64bit=0; }
11111: &logthis(" Detected 64bit platform ($_64bit)");
11112: }
11113: }
11114: }
11115:
11116: 1;
11117: __END__
11118:
11119: =pod
11120:
11121: =head1 NAME
11122:
11123: Apache::lonnet - Subroutines to ask questions about things in the network.
11124:
11125: =head1 SYNOPSIS
11126:
11127: Invoked by other LON-CAPA modules, when they need to talk to or about objects in the network.
11128:
11129: &Apache::lonnet::SUBROUTINENAME(ARGUMENTS);
11130:
11131: Common parameters:
11132:
11133: =over 4
11134:
11135: =item *
11136:
11137: $uname : an internal username (if $cname expecting a course Id specifically)
11138:
11139: =item *
11140:
11141: $udom : a domain (if $cdom expecting a course's domain specifically)
11142:
11143: =item *
11144:
11145: $symb : a resource instance identifier
11146:
11147: =item *
11148:
11149: $namespace : the name of a .db file that contains the data needed or
11150: being set.
11151:
11152: =back
11153:
11154: =head1 OVERVIEW
11155:
11156: lonnet provides subroutines which interact with the
11157: lonc/lond (TCP) network layer of LON-CAPA. They can be used to ask
11158: about classes, users, and resources.
11159:
11160: For many of these objects you can also use this to store data about
11161: them or modify them in various ways.
11162:
11163: =head2 Symbs
11164:
11165: To identify a specific instance of a resource, LON-CAPA uses symbols
11166: or "symbs"X<symb>. These identifiers are built from the URL of the
11167: map, the resource number of the resource in the map, and the URL of
11168: the resource itself. The latter is somewhat redundant, but might help
11169: if maps change.
11170:
11171: An example is
11172:
11173: msu/korte/parts/part1.sequence___19___msu/korte/tests/part12.problem
11174:
11175: The respective map entry is
11176:
11177: <resource id="19" src="/res/msu/korte/tests/part12.problem"
11178: title="Problem 2">
11179: </resource>
11180:
11181: Symbs are used by the random number generator, as well as to store and
11182: restore data specific to a certain instance of for example a problem.
11183:
11184: =head2 Storing And Retrieving Data
11185:
11186: X<store()>X<cstore()>X<restore()>Three of the most important functions
11187: in C<lonnet.pm> are C<&Apache::lonnet::cstore()>,
11188: C<&Apache::lonnet:restore()>, and C<&Apache::lonnet::store()>, which
11189: is is the non-critical message twin of cstore. These functions are for
11190: handlers to store a perl hash to a user's permanent data space in an
11191: easy manner, and to retrieve it again on another call. It is expected
11192: that a handler would use this once at the beginning to retrieve data,
11193: and then again once at the end to send only the new data back.
11194:
11195: The data is stored in the user's data directory on the user's
11196: homeserver under the ID of the course.
11197:
11198: The hash that is returned by restore will have all of the previous
11199: value for all of the elements of the hash.
11200:
11201: Example:
11202:
11203: #creating a hash
11204: my %hash;
11205: $hash{'foo'}='bar';
11206:
11207: #storing it
11208: &Apache::lonnet::cstore(\%hash);
11209:
11210: #changing a value
11211: $hash{'foo'}='notbar';
11212:
11213: #adding a new value
11214: $hash{'bar'}='foo';
11215: &Apache::lonnet::cstore(\%hash);
11216:
11217: #retrieving the hash
11218: my %history=&Apache::lonnet::restore();
11219:
11220: #print the hash
11221: foreach my $key (sort(keys(%history))) {
11222: print("\%history{$key} = $history{$key}");
11223: }
11224:
11225: Will print out:
11226:
11227: %history{1:foo} = bar
11228: %history{1:keys} = foo:timestamp
11229: %history{1:timestamp} = 990455579
11230: %history{2:bar} = foo
11231: %history{2:foo} = notbar
11232: %history{2:keys} = foo:bar:timestamp
11233: %history{2:timestamp} = 990455580
11234: %history{bar} = foo
11235: %history{foo} = notbar
11236: %history{timestamp} = 990455580
11237: %history{version} = 2
11238:
11239: Note that the special hash entries C<keys>, C<version> and
11240: C<timestamp> were added to the hash. C<version> will be equal to the
11241: total number of versions of the data that have been stored. The
11242: C<timestamp> attribute will be the UNIX time the hash was
11243: stored. C<keys> is available in every historical section to list which
11244: keys were added or changed at a specific historical revision of a
11245: hash.
11246:
11247: B<Warning>: do not store the hash that restore returns directly. This
11248: will cause a mess since it will restore the historical keys as if the
11249: were new keys. I.E. 1:foo will become 1:1:foo etc.
11250:
11251: Calling convention:
11252:
11253: my %record=&Apache::lonnet::restore($symb,$courseid,$domain,$uname,$home);
11254: &Apache::lonnet::cstore(\%newrecord,$symb,$courseid,$domain,$uname,$home);
11255:
11256: For more detailed information, see lonnet specific documentation.
11257:
11258: =head1 RETURN MESSAGES
11259:
11260: =over 4
11261:
11262: =item * B<con_lost>: unable to contact remote host
11263:
11264: =item * B<con_delayed>: unable to contact remote host, message will be delivered
11265: when the connection is brought back up
11266:
11267: =item * B<con_failed>: unable to contact remote host and unable to save message
11268: for later delivery
11269:
11270: =item * B<error:>: an error a occurred, a description of the error follows the :
11271:
11272: =item * B<no_such_host>: unable to fund a host associated with the user/domain
11273: that was requested
11274:
11275: =back
11276:
11277: =head1 PUBLIC SUBROUTINES
11278:
11279: =head2 Session Environment Functions
11280:
11281: =over 4
11282:
11283: =item *
11284: X<appenv()>
11285: B<appenv($hashref,$rolesarrayref)>: the value of %{$hashref} is written to
11286: the user envirnoment file, and will be restored for each access this
11287: user makes during this session, also modifies the %env for the current
11288: process. Optional rolesarrayref - if defined contains a reference to an array
11289: of roles which are exempt from the restriction on modifying user.role entries
11290: in the user's environment.db and in %env.
11291:
11292: =item *
11293: X<delenv()>
11294: B<delenv($delthis,$regexp)>: removes all items from the session
11295: environment file that begin with $delthis. If the
11296: optional second arg - $regexp - is true, $delthis is treated as a
11297: regular expression, otherwise \Q$delthis\E is used.
11298: The values are also deleted from the current processes %env.
11299:
11300: =item * get_env_multiple($name)
11301:
11302: gets $name from the %env hash, it seemlessly handles the cases where multiple
11303: values may be defined and end up as an array ref.
11304:
11305: returns an array of values
11306:
11307: =back
11308:
11309: =head2 User Information
11310:
11311: =over 4
11312:
11313: =item *
11314: X<queryauthenticate()>
11315: B<queryauthenticate($uname,$udom)>: try to determine user's current
11316: authentication scheme
11317:
11318: =item *
11319: X<authenticate()>
11320: B<authenticate($uname,$upass,$udom,$checkdefauth,$clientcancheckhost)>: try to
11321: authenticate user from domain's lib servers (first use the current
11322: one). C<$upass> should be the users password.
11323: $checkdefauth is optional (value is 1 if a check should be made to
11324: authenticate user using default authentication method, and allow
11325: account creation if username does not have account in the domain).
11326: $clientcancheckhost is optional (value is 1 if checking whether the
11327: server can host will occur on the client side in lonauth.pm).
11328:
11329: =item *
11330: X<homeserver()>
11331: B<homeserver($uname,$udom)>: find the server which has
11332: the user's directory and files (there must be only one), this caches
11333: the answer, and also caches if there is a borken connection.
11334:
11335: =item *
11336: X<idget()>
11337: B<idget($udom,@ids)>: find the usernames behind a list of IDs
11338: (IDs are a unique resource in a domain, there must be only 1 ID per
11339: username, and only 1 username per ID in a specific domain) (returns
11340: hash: id=>name,id=>name)
11341:
11342: =item *
11343: X<idrget()>
11344: B<idrget($udom,@unames)>: find the IDs behind a list of
11345: usernames (returns hash: name=>id,name=>id)
11346:
11347: =item *
11348: X<idput()>
11349: B<idput($udom,%ids)>: store away a list of names and associated IDs
11350:
11351: =item *
11352: X<rolesinit()>
11353: B<rolesinit($udom,$username,$authhost)>: get user privileges
11354:
11355: =item *
11356: X<getsection()>
11357: B<getsection($udom,$uname,$cname)>: finds the section of student in the
11358: course $cname, return section name/number or '' for "not in course"
11359: and '-1' for "no section"
11360:
11361: =item *
11362: X<userenvironment()>
11363: B<userenvironment($udom,$uname,@what)>: gets the values of the keys
11364: passed in @what from the requested user's environment, returns a hash
11365:
11366: =item *
11367: X<userlog_query()>
11368: B<userlog_query($uname,$udom,%filters)>: retrieves data from a user's
11369: activity.log file. %filters defines filters applied when parsing the
11370: log file. These can be start or end timestamps, or the type of action
11371: - log to look for Login or Logout events, check for Checkin or
11372: Checkout, role for role selection. The response is in the form
11373: timestamp1:hostid1:event1×tamp2:hostid2:event2 where events are
11374: escaped strings of the action recorded in the activity.log file.
11375:
11376: =back
11377:
11378: =head2 User Roles
11379:
11380: =over 4
11381:
11382: =item *
11383:
11384: allowed($priv,$uri,$symb,$role) : check for a user privilege; returns codes for allowed actions
11385: F: full access
11386: U,I,K: authentication modes (cxx only)
11387: '': forbidden
11388: 1: user needs to choose course
11389: 2: browse allowed
11390: A: passphrase authentication needed
11391:
11392: =item *
11393:
11394: definerole($rolename,$sysrole,$domrole,$courole) : define role; define a custom
11395: role rolename set privileges in format of lonTabs/roles.tab for system, domain,
11396: and course level
11397:
11398: =item *
11399:
11400: plaintext($short,$type,$cid,$forcedefault) : return value in %prp hash
11401: (rolesplain.tab); plain text explanation of a user role term.
11402: $type is Course (default) or Community.
11403: If $forcedefault evaluates to true, text returned will be default
11404: text for $type. Otherwise, if this is a course, the text returned
11405: will be a custom name for the role (if defined in the course's
11406: environment). If no custom name is defined the default is returned.
11407:
11408: =item *
11409:
11410: get_my_roles($uname,$udom,$context,$types,$roles,$roledoms,$withsec) :
11411: All arguments are optional. Returns a hash of a roles, either for
11412: co-author/assistant author roles for a user's Construction Space
11413: (default), or if $context is 'userroles', roles for the user himself,
11414: In the hash, keys are set to colon-separated $uname,$udom,$role, and
11415: (optionally) if $withsec is true, a fourth colon-separated item - $section.
11416: For each key, value is set to colon-separated start and end times for
11417: the role. If no username and domain are specified, will default to
11418: current user/domain. Types, roles, and roledoms are references to arrays
11419: of role statuses (active, future or previous), roles
11420: (e.g., cc,in, st etc.) and domains of the roles which can be used
11421: to restrict the list of roles reported. If no array ref is
11422: provided for types, will default to return only active roles.
11423:
11424: =back
11425:
11426: =head2 User Modification
11427:
11428: =over 4
11429:
11430: =item *
11431:
11432: assignrole($udom,$uname,$url,$role,$end,$start,$deleteflag,$selfenroll,$context) : assign role; give a role to a
11433: user for the level given by URL. Optional start and end dates (leave empty
11434: string or zero for "no date")
11435:
11436: =item *
11437:
11438: changepass($uname,$udom,$currentpass,$newpass,$server) : attempts to
11439: change a users, password, possible return values are: ok,
11440: pwchange_failure, non_authorized, auth_mode_error, unknown_user,
11441: refused
11442:
11443: =item *
11444:
11445: modifyuserauth($udom,$uname,$umode,$upass) : modify user authentication
11446:
11447: =item *
11448:
11449: modifyuser($udom,$uname,$uid,$umode,$upass,$first,$middle,$last, $gene,
11450: $forceid,$desiredhome,$email,$inststatus,$candelete) :
11451:
11452: will update user information (firstname,middlename,lastname,generation,
11453: permanentemail), and if forceid is true, student/employee ID also.
11454: A user's institutional affiliation(s) can also be updated.
11455: User information fields will not be overwritten with empty entries
11456: unless the field is included in the $candelete array reference.
11457: This array is included when a single user is modified via "Manage Users",
11458: or when Autoupdate.pl is run by cron in a domain.
11459:
11460: =item *
11461:
11462: modifystudent
11463:
11464: modify a student's enrollment and identification information.
11465: The course id is resolved based on the current users environment.
11466: This means the envoking user must be a course coordinator or otherwise
11467: associated with a course.
11468:
11469: This call is essentially a wrapper for lonnet::modifyuser and
11470: lonnet::modify_student_enrollment
11471:
11472: Inputs:
11473:
11474: =over 4
11475:
11476: =item B<$udom> Student's loncapa domain
11477:
11478: =item B<$uname> Student's loncapa login name
11479:
11480: =item B<$uid> Student/Employee ID
11481:
11482: =item B<$umode> Student's authentication mode
11483:
11484: =item B<$upass> Student's password
11485:
11486: =item B<$first> Student's first name
11487:
11488: =item B<$middle> Student's middle name
11489:
11490: =item B<$last> Student's last name
11491:
11492: =item B<$gene> Student's generation
11493:
11494: =item B<$usec> Student's section in course
11495:
11496: =item B<$end> Unix time of the roles expiration
11497:
11498: =item B<$start> Unix time of the roles start date
11499:
11500: =item B<$forceid> If defined, allow $uid to be changed
11501:
11502: =item B<$desiredhome> server to use as home server for student
11503:
11504: =item B<$email> Student's permanent e-mail address
11505:
11506: =item B<$type> Type of enrollment (auto or manual)
11507:
11508: =item B<$locktype> boolean - enrollment type locked to prevent Autoenroll.pl changing manual to auto
11509:
11510: =item B<$cid> courseID - needed if a course role is assigned by a user whose current role is DC
11511:
11512: =item B<$selfenroll> boolean - 1 if user role change occurred via self-enrollment
11513:
11514: =item B<$context> role change context (shown in User Management Logs display in a course)
11515:
11516: =item B<$inststatus> institutional status of user - : separated string of escaped status types
11517:
11518: =back
11519:
11520: =item *
11521:
11522: modify_student_enrollment
11523:
11524: Change a students enrollment status in a class. The environment variable
11525: 'role.request.course' must be defined for this function to proceed.
11526:
11527: Inputs:
11528:
11529: =over 4
11530:
11531: =item $udom, students domain
11532:
11533: =item $uname, students name
11534:
11535: =item $uid, students user id
11536:
11537: =item $first, students first name
11538:
11539: =item $middle
11540:
11541: =item $last
11542:
11543: =item $gene
11544:
11545: =item $usec
11546:
11547: =item $end
11548:
11549: =item $start
11550:
11551: =item $type
11552:
11553: =item $locktype
11554:
11555: =item $cid
11556:
11557: =item $selfenroll
11558:
11559: =item $context
11560:
11561: =back
11562:
11563:
11564: =item *
11565:
11566: assigncustomrole($udom,$uname,$url,$rdom,$rnam,$rolename,$end,$start) : assign
11567: custom role; give a custom role to a user for the level given by URL. Specify
11568: name and domain of role author, and role name
11569:
11570: =item *
11571:
11572: revokerole($udom,$uname,$url,$role) : revoke a role for url
11573:
11574: =item *
11575:
11576: revokecustomrole($udom,$uname,$url,$role) : revoke a custom role
11577:
11578: =back
11579:
11580: =head2 Course Infomation
11581:
11582: =over 4
11583:
11584: =item *
11585:
11586: coursedescription($courseid,$options) : returns a hash of information about the
11587: specified course id, including all environment settings for the
11588: course, the description of the course will be in the hash under the
11589: key 'description'
11590:
11591: $options is an optional parameter that if supplied is a hash reference that controls
11592: what how this function works. It has the following key/values:
11593:
11594: =over 4
11595:
11596: =item freshen_cache
11597:
11598: If defined, and the environment cache for the course is valid, it is
11599: returned in the returned hash.
11600:
11601: =item one_time
11602:
11603: If defined, the last cache time is set to _now_
11604:
11605: =item user
11606:
11607: If defined, the supplied username is used instead of the current user.
11608:
11609:
11610: =back
11611:
11612: =item *
11613:
11614: resdata($name,$domain,$type,@which) : request for current parameter
11615: setting for a specific $type, where $type is either 'course' or 'user',
11616: @what should be a list of parameters to ask about. This routine caches
11617: answers for 5 minutes.
11618:
11619: =item *
11620:
11621: get_courseresdata($courseid, $domain) : dump the entire course resource
11622: data base, returning a hash that is keyed by the resource name and has
11623: values that are the resource value. I believe that the timestamps and
11624: versions are also returned.
11625:
11626:
11627: =back
11628:
11629: =head2 Course Modification
11630:
11631: =over 4
11632:
11633: =item *
11634:
11635: writecoursepref($courseid,%prefs) : write preferences (environment
11636: database) for a course
11637:
11638: =item *
11639:
11640: createcourse($udom,$description,$url,$course_server,$nonstandard,$inst_code,$course_owner,$crstype,$cnum) : make course
11641:
11642: =item *
11643:
11644: generate_coursenum($udom,$crstype) : get a unique (unused) course number in domain $udom for course type $crstype (Course or Community).
11645:
11646: =back
11647:
11648: =head2 Resource Subroutines
11649:
11650: =over 4
11651:
11652: =item *
11653:
11654: subscribe($fname) : subscribe to a resource, returns URL if possible (probably should use repcopy instead)
11655:
11656: =item *
11657:
11658: repcopy($filename) : subscribes to the requested file, and attempts to
11659: replicate from the owning library server, Might return
11660: 'unavailable', 'not_found', 'forbidden', 'ok', or
11661: 'bad_request', also attempts to grab the metadata for the
11662: resource. Expects the local filesystem pathname
11663: (/home/httpd/html/res/....)
11664:
11665: =back
11666:
11667: =head2 Resource Information
11668:
11669: =over 4
11670:
11671: =item *
11672:
11673: EXT($varname,$symb,$udom,$uname) : evaluates and returns the value of
11674: a vairety of different possible values, $varname should be a request
11675: string, and the other parameters can be used to specify who and what
11676: one is asking about.
11677:
11678: Possible values for $varname are environment.lastname (or other item
11679: from the envirnment hash), user.name (or someother aspect about the
11680: user), resource.0.maxtries (or some other part and parameter of a
11681: resource)
11682:
11683: =item *
11684:
11685: directcondval($number) : get current value of a condition; reads from a state
11686: string
11687:
11688: =item *
11689:
11690: condval($condidx) : value of condition index based on state
11691:
11692: =item *
11693:
11694: metadata($uri,$what,$liburi,$prefix,$depthcount) : request a
11695: resource's metadata, $what should be either a specific key, or either
11696: 'keys' (to get a list of possible keys) or 'packages' to get a list of
11697: packages that this resource currently uses, the last 3 arguments are only used internally for recursive metadata.
11698:
11699: this function automatically caches all requests
11700:
11701: =item *
11702:
11703: metadata_query($query,$custom,$customshow) : make a metadata query against the
11704: network of library servers; returns file handle of where SQL and regex results
11705: will be stored for query
11706:
11707: =item *
11708:
11709: symbread($filename) : return symbolic list entry (filename argument optional);
11710: returns the data handle
11711:
11712: =item *
11713:
11714: symbverify($symb,$thisfn) : verifies that $symb actually exists and is
11715: a possible symb for the URL in $thisfn, and if is an encryypted
11716: resource that the user accessed using /enc/ returns a 1 on success, 0
11717: on failure, user must be in a course, as it assumes the existance of
11718: the course initial hash, and uses $env('request.course.id'}
11719:
11720:
11721: =item *
11722:
11723: symbclean($symb) : removes versions numbers from a symb, returns the
11724: cleaned symb
11725:
11726: =item *
11727:
11728: is_on_map($uri) : checks if the $uri is somewhere on the current
11729: course map, user must be in a course for it to work.
11730:
11731: =item *
11732:
11733: numval($salt) : return random seed value (addend for rndseed)
11734:
11735: =item *
11736:
11737: rndseed($symb,$courseid,$udom,$uname) : create a random sum; returns
11738: a random seed, all arguments are optional, if they aren't sent it uses the
11739: environment to derive them. Note: if symb isn't sent and it can't get one
11740: from &symbread it will use the current time as its return value
11741:
11742: =item *
11743:
11744: ireceipt($funame,$fudom,$fucourseid,$fusymb) : return unique,
11745: unfakeable, receipt
11746:
11747: =item *
11748:
11749: receipt() : API to ireceipt working off of env values; given out to users
11750:
11751: =item *
11752:
11753: countacc($url) : count the number of accesses to a given URL
11754:
11755: =item *
11756:
11757: 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
11758:
11759: =item *
11760:
11761: 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)
11762:
11763: =item *
11764:
11765: expirespread($uname,$udom,$stype,$usymb) : set expire date for spreadsheet
11766:
11767: =item *
11768:
11769: devalidate($symb) : devalidate temporary spreadsheet calculations,
11770: forcing spreadsheet to reevaluate the resource scores next time.
11771:
11772: =back
11773:
11774: =head2 Storing/Retreiving Data
11775:
11776: =over 4
11777:
11778: =item *
11779:
11780: store($storehash,$symb,$namespace,$udom,$uname) : stores hash permanently
11781: for this url; hashref needs to be given and should be a \%hashname; the
11782: remaining args aren't required and if they aren't passed or are '' they will
11783: be derived from the env
11784:
11785: =item *
11786:
11787: cstore($storehash,$symb,$namespace,$udom,$uname) : same as store but
11788: uses critical subroutine
11789:
11790: =item *
11791:
11792: restore($symb,$namespace,$udom,$uname) : returns hash for this symb;
11793: all args are optional
11794:
11795: =item *
11796:
11797: dumpstore($namespace,$udom,$uname,$regexp,$range) :
11798: dumps the complete (or key matching regexp) namespace into a hash
11799: ($udom, $uname, $regexp, $range are optional) for a namespace that is
11800: normally &store()ed into
11801:
11802: $range should be either an integer '100' (give me the first 100
11803: matching records)
11804: or be two integers sperated by a - with no spaces
11805: '30-50' (give me the 30th through the 50th matching
11806: records)
11807:
11808:
11809: =item *
11810:
11811: putstore($namespace,$symb,$version,$storehash,$udomain,$uname) :
11812: replaces a &store() version of data with a replacement set of data
11813: for a particular resource in a namespace passed in the $storehash hash
11814: reference
11815:
11816: =item *
11817:
11818: tmpstore($storehash,$symb,$namespace,$udom,$uname) : storage that
11819: works very similar to store/cstore, but all data is stored in a
11820: temporary location and can be reset using tmpreset, $storehash should
11821: be a hash reference, returns nothing on success
11822:
11823: =item *
11824:
11825: tmprestore($symb,$namespace,$udom,$uname) : storage that works very
11826: similar to restore, but all data is stored in a temporary location and
11827: can be reset using tmpreset. Returns a hash of values on success,
11828: error string otherwise.
11829:
11830: =item *
11831:
11832: tmpreset($symb,$namespace,$udom,$uname) : temporary storage reset,
11833: deltes all keys for $symb form the temporary storage hash.
11834:
11835: =item *
11836:
11837: get($namespace,$storearr,$udom,$uname) : returns hash with keys from array
11838: reference filled in from namesp ($udom and $uname are optional)
11839:
11840: =item *
11841:
11842: del($namespace,$storearr,$udom,$uname) : deletes keys out of array from
11843: namesp ($udom and $uname are optional)
11844:
11845: =item *
11846:
11847: dump($namespace,$udom,$uname,$regexp,$range) :
11848: dumps the complete (or key matching regexp) namespace into a hash
11849: ($udom, $uname, $regexp, $range are optional)
11850:
11851: $range should be either an integer '100' (give me the first 100
11852: matching records)
11853: or be two integers sperated by a - with no spaces
11854: '30-50' (give me the 30th through the 50th matching
11855: records)
11856: =item *
11857:
11858: inc($namespace,$store,$udom,$uname) : increments $store in $namespace.
11859: $store can be a scalar, an array reference, or if the amount to be
11860: incremented is > 1, a hash reference.
11861:
11862: ($udom and $uname are optional)
11863:
11864: =item *
11865:
11866: put($namespace,$storehash,$udom,$uname) : stores hash in namesp
11867: ($udom and $uname are optional)
11868:
11869: =item *
11870:
11871: cput($namespace,$storehash,$udom,$uname) : critical put
11872: ($udom and $uname are optional)
11873:
11874: =item *
11875:
11876: newput($namespace,$storehash,$udom,$uname) :
11877:
11878: Attempts to store the items in the $storehash, but only if they don't
11879: currently exist, if this succeeds you can be certain that you have
11880: successfully created a new key value pair in the $namespace db.
11881:
11882:
11883: Args:
11884: $namespace: name of database to store values to
11885: $storehash: hashref to store to the db
11886: $udom: (optional) domain of user containing the db
11887: $uname: (optional) name of user caontaining the db
11888:
11889: Returns:
11890: 'ok' -> succeeded in storing all keys of $storehash
11891: 'key_exists: <key>' -> failed to anything out of $storehash, as at
11892: least <key> already existed in the db (other
11893: requested keys may also already exist)
11894: 'error: <msg>' -> unable to tie the DB or other error occurred
11895: 'con_lost' -> unable to contact request server
11896: 'refused' -> action was not allowed by remote machine
11897:
11898:
11899: =item *
11900:
11901: eget($namespace,$storearr,$udom,$uname) : returns hash with keys from array
11902: reference filled in from namesp (encrypts the return communication)
11903: ($udom and $uname are optional)
11904:
11905: =item *
11906:
11907: log($udom,$name,$home,$message) : write to permanent log for user; use
11908: critical subroutine
11909:
11910: =item *
11911:
11912: get_dom($namespace,$storearr,$udom,$uhome) : returns hash with keys from
11913: array reference filled in from namespace found in domain level on either
11914: specified domain server ($uhome) or primary domain server ($udom and $uhome are optional).
11915:
11916: =item *
11917:
11918: put_dom($namespace,$storehash,$udom,$uhome) : stores hash in namespace at
11919: domain level either on specified domain server ($uhome) or primary domain
11920: server ($udom and $uhome are optional)
11921:
11922: =item *
11923:
11924: get_domain_defaults($target_domain) : returns hash with defaults for
11925: authentication and language in the domain. Keys are: auth_def, auth_arg_def,
11926: lang_def; corresponsing values are authentication type (internal, krb4, krb5,
11927: or localauth), initial password or a kerberos realm, language (e.g., en-us).
11928: Values are retrieved from cache (if current), or from domain's configuration.db
11929: (if available), or lastly from values in lonTabs/dns_domain,tab,
11930: or lonTabs/domain.tab.
11931:
11932: %domdefaults = &get_auth_defaults($target_domain);
11933:
11934: =back
11935:
11936: =head2 Network Status Functions
11937:
11938: =over 4
11939:
11940: =item *
11941:
11942: dirlist() : return directory list based on URI (first arg).
11943:
11944: Inputs: 1 required, 5 optional.
11945:
11946: =over
11947:
11948: =item
11949: $uri - path to file in filesystem (starts: /res or /userfiles/). Required.
11950:
11951: =item
11952: $userdomain - domain of user/course to be listed. Extracted from $uri if absent.
11953:
11954: =item
11955: $username - username of user/course to be listed. Extracted from $uri if absent.
11956:
11957: =item
11958: $getpropath - boolean: 1 if prepend path using &propath().
11959:
11960: =item
11961: $getuserdir - boolean: 1 if prepend path for "userfiles".
11962:
11963: =item
11964: $alternateRoot - path to prepend in place of path from $uri.
11965:
11966: =back
11967:
11968: Returns: Array of up to two items.
11969:
11970: =over
11971:
11972: a reference to an array of files/subdirectories
11973:
11974: =over
11975:
11976: Each element in the array of files/subdirectories is a & separated list of
11977: item name and the result of running stat on the item. If dirlist was requested
11978: for a file instead of a directory, the item name will be ''. For a directory
11979: listing, if the item is a metadata file, the element will end &N&M
11980: (where N amd M are either 0 or 1, corresponding to obsolete set (1), or
11981: default copyright set (1).
11982:
11983: =back
11984:
11985: a scalar containing error condition (if encountered).
11986:
11987: =over
11988:
11989: =item
11990: no_host (no homeserver identified for $username:$domain).
11991:
11992: =item
11993: no_such_host (server contacted for listing not identified as valid host).
11994:
11995: =item
11996: con_lost (connection to remote server failed).
11997:
11998: =item
11999: refused (invalid $username:$domain received on lond side).
12000:
12001: =item
12002: no_such_dir (directory at specified path on lond side does not exist).
12003:
12004: =item
12005: empty (directory at specified path on lond side is empty).
12006:
12007: =over
12008:
12009: This is currently not encountered because the &ls3, &ls2,
12010: &ls (_handler) routines on the lond side do not filter out
12011: . and .. from a directory listing.
12012:
12013: =back
12014:
12015: =back
12016:
12017: =back
12018:
12019: =item *
12020:
12021: spareserver() : find server with least workload from spare.tab
12022:
12023:
12024: =item *
12025:
12026: host_from_dns($dns) : Returns the loncapa hostname corresponding to a DNS name or undef
12027: if there is no corresponding loncapa host.
12028:
12029: =back
12030:
12031:
12032: =head2 Apache Request
12033:
12034: =over 4
12035:
12036: =item *
12037:
12038: ssi($url,%hash) : server side include, does a complete request cycle on url to
12039: localhost, posts hash
12040:
12041: =back
12042:
12043: =head2 Data to String to Data
12044:
12045: =over 4
12046:
12047: =item *
12048:
12049: hash2str(%hash) : convert a hash into a string complete with escaping and '='
12050: and '&' separators, supports elements that are arrayrefs and hashrefs
12051:
12052: =item *
12053:
12054: hashref2str($hashref) : convert a hashref into a string complete with
12055: escaping and '=' and '&' separators, supports elements that are
12056: arrayrefs and hashrefs
12057:
12058: =item *
12059:
12060: arrayref2str($arrayref) : convert an arrayref into a string complete
12061: with escaping and '&' separators, supports elements that are arrayrefs
12062: and hashrefs
12063:
12064: =item *
12065:
12066: str2hash($string) : convert string to hash using unescaping and
12067: splitting on '=' and '&', supports elements that are arrayrefs and
12068: hashrefs
12069:
12070: =item *
12071:
12072: str2array($string) : convert string to hash using unescaping and
12073: splitting on '&', supports elements that are arrayrefs and hashrefs
12074:
12075: =back
12076:
12077: =head2 Logging Routines
12078:
12079:
12080: These routines allow one to make log messages in the lonnet.log and
12081: lonnet.perm logfiles.
12082:
12083: =over 4
12084:
12085: =item *
12086:
12087: logtouch() : make sure the logfile, lonnet.log, exists
12088:
12089: =item *
12090:
12091: logthis() : append message to the normal lonnet.log file, it gets
12092: preiodically rolled over and deleted.
12093:
12094: =item *
12095:
12096: logperm() : append a permanent message to lonnet.perm.log, this log
12097: file never gets deleted by any automated portion of the system, only
12098: messages of critical importance should go in here.
12099:
12100:
12101: =back
12102:
12103: =head2 General File Helper Routines
12104:
12105: =over 4
12106:
12107: =item *
12108:
12109: getfile($file,$caller) : two cases - requests for files in /res or in /uploaded.
12110: (a) files in /uploaded
12111: (i) If a local copy of the file exists -
12112: compares modification date of local copy with last-modified date for
12113: definitive version stored on home server for course. If local copy is
12114: stale, requests a new version from the home server and stores it.
12115: If the original has been removed from the home server, then local copy
12116: is unlinked.
12117: (ii) If local copy does not exist -
12118: requests the file from the home server and stores it.
12119:
12120: If $caller is 'uploadrep':
12121: This indicates a call from lonuploadrep.pm (PerlHeaderParserHandler phase)
12122: for request for files originally uploaded via DOCS.
12123: - returns 'ok' if fresh local copy now available, -1 otherwise.
12124:
12125: Otherwise:
12126: This indicates a call from the content generation phase of the request.
12127: - returns the entire contents of the file or -1.
12128:
12129: (b) files in /res
12130: - returns the entire contents of a file or -1;
12131: it properly subscribes to and replicates the file if neccessary.
12132:
12133:
12134: =item *
12135:
12136: stat_file($url) : $url is expected to be a /res/ or /uploaded/ style file
12137: reference
12138:
12139: returns either a stat() list of data about the file or an empty list
12140: if the file doesn't exist or couldn't find out about it (connection
12141: problems or user unknown)
12142:
12143: =item *
12144:
12145: filelocation($dir,$file) : returns file system location of a file
12146: based on URI; meant to be "fairly clean" absolute reference, $dir is a
12147: directory that relative $file lookups are to looked in ($dir of /a/dir
12148: and a file of ../bob will become /a/bob)
12149:
12150: =item *
12151:
12152: hreflocation($dir,$file) : returns file system location or a URL; same as
12153: filelocation except for hrefs
12154:
12155: =item *
12156:
12157: declutter() : declutters URLs (remove docroot, beginning slashes, 'res' etc)
12158:
12159: =back
12160:
12161: =head2 Usererfile file routines (/uploaded*)
12162:
12163: =over 4
12164:
12165: =item *
12166:
12167: userfileupload(): main rotine for putting a file in a user or course's
12168: filespace, arguments are,
12169:
12170: formname - required - this is the name of the element in $env where the
12171: filename, and the contents of the file to create/modifed exist
12172: the filename is in $env{'form.'.$formname.'.filename'} and the
12173: contents of the file is located in $env{'form.'.$formname}
12174: context - if coursedoc, store the file in the course of the active role
12175: of the current user;
12176: if 'existingfile': store in 'overwrites' in /home/httpd/perl/tmp
12177: if 'canceloverwrite': delete file in tmp/overwrites directory
12178: subdir - required - subdirectory to put the file in under ../userfiles/
12179: if undefined, it will be placed in "unknown"
12180:
12181: (This routine calls clean_filename() to remove any dangerous
12182: characters from the filename, and then calls finuserfileupload() to
12183: complete the transaction)
12184:
12185: returns either the url of the uploaded file (/uploaded/....) if successful
12186: and /adm/notfound.html if unsuccessful
12187:
12188: =item *
12189:
12190: clean_filename(): routine for cleaing a filename up for storage in
12191: userfile space, argument is:
12192:
12193: filename - proposed filename
12194:
12195: returns: the new clean filename
12196:
12197: =item *
12198:
12199: finishuserfileupload(): routine that creates and sends the file to
12200: userspace, probably shouldn't be called directly
12201:
12202: docuname: username or courseid of destination for the file
12203: docudom: domain of user/course of destination for the file
12204: formname: same as for userfileupload()
12205: fname: filename (including subdirectories) for the file
12206: parser: if 'parse', will parse (html) file to extract references to objects, links etc.
12207: allfiles: reference to hash used to store objects found by parser
12208: codebase: reference to hash used for codebases of java objects found by parser
12209: thumbwidth: width (pixels) of thumbnail to be created for uploaded image
12210: thumbheight: height (pixels) of thumbnail to be created for uploaded image
12211: resizewidth: width to be used to resize image using resizeImage from ImageMagick
12212: resizeheight: height to be used to resize image using resizeImage from ImageMagick
12213: context: if 'overwrite', will move the uploaded file from its temporary location to
12214: userfiles to facilitate overwriting a previously uploaded file with same name.
12215: mimetype: reference to scalar to accommodate mime type determined
12216: from File::MMagic if $parser = parse.
12217:
12218: returns either the url of the uploaded file (/uploaded/....) if successful
12219: and /adm/notfound.html if unsuccessful (or an error message if context
12220: was 'overwrite').
12221:
12222:
12223: =item *
12224:
12225: renameuserfile(): renames an existing userfile to a new name
12226:
12227: Args:
12228: docuname: username or courseid of destination for the file
12229: docudom: domain of user/course of destination for the file
12230: old: current file name (including any subdirs under userfiles)
12231: new: desired file name (including any subdirs under userfiles)
12232:
12233: =item *
12234:
12235: mkdiruserfile(): creates a directory is a userfiles dir
12236:
12237: Args:
12238: docuname: username or courseid of destination for the file
12239: docudom: domain of user/course of destination for the file
12240: dir: dir to create (including any subdirs under userfiles)
12241:
12242: =item *
12243:
12244: removeuserfile(): removes a file that exists in userfiles
12245:
12246: Args:
12247: docuname: username or courseid of destination for the file
12248: docudom: domain of user/course of destination for the file
12249: fname: filname to delete (including any subdirs under userfiles)
12250:
12251: =item *
12252:
12253: removeuploadedurl(): convience function for removeuserfile()
12254:
12255: Args:
12256: url: a full /uploaded/... url to delete
12257:
12258: =item *
12259:
12260: get_portfile_permissions():
12261: Args:
12262: domain: domain of user or course contain the portfolio files
12263: user: name of user or num of course contain the portfolio files
12264: Returns:
12265: hashref of a dump of the proper file_permissions.db
12266:
12267:
12268: =item *
12269:
12270: get_access_controls():
12271:
12272: Args:
12273: current_permissions: the hash ref returned from get_portfile_permissions()
12274: group: (optional) the group you want the files associated with
12275: file: (optional) the file you want access info on
12276:
12277: Returns:
12278: a hash (keys are file names) of hashes containing
12279: keys are: path to file/file_name\0uniqueID:scope_end_start (see below)
12280: values are XML containing access control settings (see below)
12281:
12282: Internal notes:
12283:
12284: access controls are stored in file_permissions.db as key=value pairs.
12285: key -> path to file/file_name\0uniqueID:scope_end_start
12286: where scope -> public,guest,course,group,domains or users.
12287: end -> UNIX time for end of access (0 -> no end date)
12288: start -> UNIX time for start of access
12289:
12290: value -> XML description of access control
12291: <scope type=""> (type =1 of: public,guest,course,group,domains,users">
12292: <start></start>
12293: <end></end>
12294:
12295: <password></password> for scope type = guest
12296:
12297: <domain></domain> for scope type = course or group
12298: <number></number>
12299: <roles id="">
12300: <role></role>
12301: <access></access>
12302: <section></section>
12303: <group></group>
12304: </roles>
12305:
12306: <dom></dom> for scope type = domains
12307:
12308: <users> for scope type = users
12309: <user>
12310: <uname></uname>
12311: <udom></udom>
12312: </user>
12313: </users>
12314: </scope>
12315:
12316: Access data is also aggregated for each file in an additional key=value pair:
12317: key -> path to file/file_name\0accesscontrol
12318: value -> reference to hash
12319: hash contains key = value pairs
12320: where key = uniqueID:scope_end_start
12321: value = UNIX time record was last updated
12322:
12323: Used to improve speed of look-ups of access controls for each file.
12324:
12325: Locks on files (resulting from submission of portfolio file to a homework problem stored in array of arrays.
12326:
12327: modify_access_controls():
12328:
12329: Modifies access controls for a portfolio file
12330: Args
12331: 1. file name
12332: 2. reference to hash of required changes,
12333: 3. domain
12334: 4. username
12335: where domain,username are the domain of the portfolio owner
12336: (either a user or a course)
12337:
12338: Returns:
12339: 1. result of additions or updates ('ok' or 'error', with error message).
12340: 2. result of deletions ('ok' or 'error', with error message).
12341: 3. reference to hash of any new or updated access controls.
12342: 4. reference to hash used to map incoming IDs to uniqueIDs assigned to control.
12343: key = integer (inbound ID)
12344: value = uniqueID
12345:
12346: =back
12347:
12348: =head2 HTTP Helper Routines
12349:
12350: =over 4
12351:
12352: =item *
12353:
12354: escape() : unpack non-word characters into CGI-compatible hex codes
12355:
12356: =item *
12357:
12358: unescape() : pack CGI-compatible hex codes into actual non-word ASCII character
12359:
12360: =back
12361:
12362: =head1 PRIVATE SUBROUTINES
12363:
12364: =head2 Underlying communication routines (Shouldn't call)
12365:
12366: =over 4
12367:
12368: =item *
12369:
12370: subreply() : tries to pass a message to lonc, returns con_lost if incapable
12371:
12372: =item *
12373:
12374: reply() : uses subreply to send a message to remote machine, logs all failures
12375:
12376: =item *
12377:
12378: critical() : passes a critical message to another server; if cannot
12379: get through then place message in connection buffer directory and
12380: returns con_delayed, if incapable of saving message, returns
12381: con_failed
12382:
12383: =item *
12384:
12385: reconlonc() : tries to reconnect lonc client processes.
12386:
12387: =back
12388:
12389: =head2 Resource Access Logging
12390:
12391: =over 4
12392:
12393: =item *
12394:
12395: flushcourselogs() : flush (save) buffer logs and access logs
12396:
12397: =item *
12398:
12399: courselog($what) : save message for course in hash
12400:
12401: =item *
12402:
12403: courseacclog($what) : save message for course using &courselog(). Perform
12404: special processing for specific resource types (problems, exams, quizzes, etc).
12405:
12406: =item *
12407:
12408: goodbye() : flush course logs and log shutting down; it is called in srm.conf
12409: as a PerlChildExitHandler
12410:
12411: =back
12412:
12413: =head2 Other
12414:
12415: =over 4
12416:
12417: =item *
12418:
12419: symblist($mapname,%newhash) : update symbolic storage links
12420:
12421: =back
12422:
12423: =cut
12424:
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