File:
[LON-CAPA] /
loncom /
lonnet /
perl /
lonnet.pm
Revision
1.1312:
download - view:
text,
annotated -
select for diffs
Sun Jun 19 04:28:19 2016 UTC (8 years ago) by
raeburn
Branches:
MAIN
CVS tags:
HEAD
- Course Editor has "Standard Problem" item (Grading tab) for creation
of new problem in user's Authoring Space, or in a Course "Authoring" Space.
- Course Editor has "Import from Course Resources" item (Import tab) to
import published content from Course "Authoring" Space.
- Course "Authoring" Space
- default.rights -- course-only access
- quota is shared with content uploaded directly to course
- content only browsable in course context
- metadata not included in searchable meatdata MySQL table
CVs: ----------------------------------------------------------------------
1: # The LearningOnline Network
2: # TCP networking package
3: #
4: # $Id: lonnet.pm,v 1.1312 2016/06/19 04:28:19 raeburn Exp $
5: #
6: # Copyright Michigan State University Board of Trustees
7: #
8: # This file is part of the LearningOnline Network with CAPA (LON-CAPA).
9: #
10: # LON-CAPA is free software; you can redistribute it and/or modify
11: # it under the terms of the GNU General Public License as published by
12: # the Free Software Foundation; either version 2 of the License, or
13: # (at your option) any later version.
14: #
15: # LON-CAPA is distributed in the hope that it will be useful,
16: # but WITHOUT ANY WARRANTY; without even the implied warranty of
17: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18: # GNU General Public License for more details.
19: #
20: # You should have received a copy of the GNU General Public License
21: # along with LON-CAPA; if not, write to the Free Software
22: # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
23: #
24: # /home/httpd/html/adm/gpl.txt
25: #
26: # http://www.lon-capa.org/
27: #
28: ###
29:
30: =pod
31:
32: =head1 NAME
33:
34: Apache::lonnet.pm
35:
36: =head1 SYNOPSIS
37:
38: This file is an interface to the lonc processes of
39: the LON-CAPA network as well as set of elaborated functions for handling information
40: necessary for navigating through a given cluster of LON-CAPA machines within a
41: domain. There are over 40 specialized functions in this module which handle the
42: reading and transmission of metadata, user information (ids, names, environments, roles,
43: logs), file information (storage, reading, directories, extensions, replication, embedded
44: styles and descriptors), educational resources (course descriptions, section names and
45: numbers), url hashing (to assign roles on a url basis), and translating abbreviated symbols to
46: and from more descriptive phrases or explanations.
47:
48: This is part of the LearningOnline Network with CAPA project
49: described at http://www.lon-capa.org.
50:
51: =head1 Package Variables
52:
53: These are largely undocumented, so if you decipher one please note it here.
54:
55: =over 4
56:
57: =item $processmarker
58:
59: Contains the time this process was started and this servers host id.
60:
61: =item $dumpcount
62:
63: Counts the number of times a message log flush has been attempted (regardless
64: of success) by this process. Used as part of the filename when messages are
65: delayed.
66:
67: =back
68:
69: =cut
70:
71: package Apache::lonnet;
72:
73: use strict;
74: use LWP::UserAgent();
75: use HTTP::Date;
76: use Image::Magick;
77:
78:
79: use Encode;
80:
81: use vars qw(%perlvar %spareid %pr %prp $memcache %packagetab $tmpdir
82: $_64bit %env %protocol %loncaparevs %serverhomeIDs %needsrelease
83: %managerstab);
84:
85: my (%badServerCache, $memcache, %courselogs, %accesshash, %domainrolehash,
86: %userrolehash, $processmarker, $dumpcount, %coursedombuf,
87: %coursenumbuf, %coursehombuf, %coursedescrbuf, %courseinstcodebuf,
88: %courseownerbuf, %coursetypebuf,$locknum);
89:
90: use IO::Socket;
91: use GDBM_File;
92: use HTML::LCParser;
93: use Fcntl qw(:flock);
94: use Storable qw(thaw nfreeze);
95: use Time::HiRes qw( sleep gettimeofday tv_interval );
96: use Cache::Memcached;
97: use Digest::MD5;
98: use Math::Random;
99: use File::MMagic;
100: use LONCAPA qw(:DEFAULT :match);
101: use LONCAPA::Configuration;
102: use LONCAPA::lonmetadata;
103: use LONCAPA::Lond;
104:
105: use File::Copy;
106:
107: my $readit;
108: my $max_connection_retries = 20; # Or some such value.
109:
110: require Exporter;
111:
112: our @ISA = qw (Exporter);
113: our @EXPORT = qw(%env);
114:
115:
116: # ------------------------------------ Logging (parameters, docs, slots, roles)
117: {
118: my $logid;
119: sub write_log {
120: my ($context,$hash_name,$storehash,$delflag,$uname,$udom,$cnum,$cdom)=@_;
121: if ($context eq 'course') {
122: if (($cnum eq '') || ($cdom eq '')) {
123: $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
124: $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
125: }
126: }
127: $logid ++;
128: my $now = time();
129: my $id=$now.'00000'.$$.'00000'.$logid;
130: my $logentry = {
131: $id => {
132: 'exe_uname' => $env{'user.name'},
133: 'exe_udom' => $env{'user.domain'},
134: 'exe_time' => $now,
135: 'exe_ip' => $ENV{'REMOTE_ADDR'},
136: 'delflag' => $delflag,
137: 'logentry' => $storehash,
138: 'uname' => $uname,
139: 'udom' => $udom,
140: }
141: };
142: return &put('nohist_'.$hash_name,$logentry,$cdom,$cnum);
143: }
144: }
145:
146: sub logtouch {
147: my $execdir=$perlvar{'lonDaemons'};
148: unless (-e "$execdir/logs/lonnet.log") {
149: open(my $fh,">>$execdir/logs/lonnet.log");
150: close $fh;
151: }
152: my ($wwwuid,$wwwgid)=(getpwnam('www'))[2,3];
153: chown($wwwuid,$wwwgid,$execdir.'/logs/lonnet.log');
154: }
155:
156: sub logthis {
157: my $message=shift;
158: my $execdir=$perlvar{'lonDaemons'};
159: my $now=time;
160: my $local=localtime($now);
161: if (open(my $fh,">>$execdir/logs/lonnet.log")) {
162: my $logstring = $local. " ($$): ".$message."\n"; # Keep any \'s in string.
163: print $fh $logstring;
164: close($fh);
165: }
166: return 1;
167: }
168:
169: sub logperm {
170: my $message=shift;
171: my $execdir=$perlvar{'lonDaemons'};
172: my $now=time;
173: my $local=localtime($now);
174: if (open(my $fh,">>$execdir/logs/lonnet.perm.log")) {
175: print $fh "$now:$message:$local\n";
176: close($fh);
177: }
178: return 1;
179: }
180:
181: sub create_connection {
182: my ($hostname,$lonid) = @_;
183: my $client=IO::Socket::UNIX->new(Peer => $perlvar{'lonSockCreate'},
184: Type => SOCK_STREAM,
185: Timeout => 10);
186: return 0 if (!$client);
187: print $client (join(':',$hostname,$lonid,&machine_ids($hostname))."\n");
188: my $result = <$client>;
189: chomp($result);
190: return 1 if ($result eq 'done');
191: return 0;
192: }
193:
194: sub get_server_timezone {
195: my ($cnum,$cdom) = @_;
196: my $home=&homeserver($cnum,$cdom);
197: if ($home ne 'no_host') {
198: my $cachetime = 24*3600;
199: my ($timezone,$cached)=&is_cached_new('servertimezone',$home);
200: if (defined($cached)) {
201: return $timezone;
202: } else {
203: my $timezone = &reply('servertimezone',$home);
204: return &do_cache_new('servertimezone',$home,$timezone,$cachetime);
205: }
206: }
207: }
208:
209: sub get_server_distarch {
210: my ($lonhost,$ignore_cache) = @_;
211: if (defined($lonhost)) {
212: if (!defined(&hostname($lonhost))) {
213: return;
214: }
215: my $cachetime = 12*3600;
216: if (!$ignore_cache) {
217: my ($distarch,$cached)=&is_cached_new('serverdistarch',$lonhost);
218: if (defined($cached)) {
219: return $distarch;
220: }
221: }
222: my $rep = &reply('serverdistarch',$lonhost);
223: unless ($rep eq 'unknown_command' || $rep eq 'no_such_host' ||
224: $rep eq 'con_lost' || $rep eq 'rejected' || $rep eq 'refused' ||
225: $rep eq '') {
226: return &do_cache_new('serverdistarch',$lonhost,$rep,$cachetime);
227: }
228: }
229: return;
230: }
231:
232: sub get_server_loncaparev {
233: my ($dom,$lonhost,$ignore_cache,$caller) = @_;
234: if (defined($lonhost)) {
235: if (!defined(&hostname($lonhost))) {
236: undef($lonhost);
237: }
238: }
239: if (!defined($lonhost)) {
240: if (defined(&domain($dom,'primary'))) {
241: $lonhost=&domain($dom,'primary');
242: if ($lonhost eq 'no_host') {
243: undef($lonhost);
244: }
245: }
246: }
247: if (defined($lonhost)) {
248: my $cachetime = 12*3600;
249: if (!$ignore_cache) {
250: my ($loncaparev,$cached)=&is_cached_new('serverloncaparev',$lonhost);
251: if (defined($cached)) {
252: return $loncaparev;
253: }
254: }
255: my ($answer,$loncaparev);
256: my @ids=¤t_machine_ids();
257: if (grep(/^\Q$lonhost\E$/,@ids)) {
258: $answer = $perlvar{'lonVersion'};
259: if ($answer =~ /^[\'\"]?([\w.\-]+)[\'\"]?$/) {
260: $loncaparev = $1;
261: }
262: } else {
263: $answer = &reply('serverloncaparev',$lonhost);
264: if (($answer eq 'unknown_cmd') || ($answer eq 'con_lost')) {
265: if ($caller eq 'loncron') {
266: my $ua=new LWP::UserAgent;
267: $ua->timeout(4);
268: my $protocol = $protocol{$lonhost};
269: $protocol = 'http' if ($protocol ne 'https');
270: my $url = $protocol.'://'.&hostname($lonhost).'/adm/about.html';
271: my $request=new HTTP::Request('GET',$url);
272: my $response=$ua->request($request);
273: unless ($response->is_error()) {
274: my $content = $response->content;
275: if ($content =~ /<p>VERSION\:\s*([\w.\-]+)<\/p>/) {
276: $loncaparev = $1;
277: }
278: }
279: } else {
280: $loncaparev = $loncaparevs{$lonhost};
281: }
282: } elsif ($answer =~ /^[\'\"]?([\w.\-]+)[\'\"]?$/) {
283: $loncaparev = $1;
284: }
285: }
286: return &do_cache_new('serverloncaparev',$lonhost,$loncaparev,$cachetime);
287: }
288: }
289:
290: sub get_server_homeID {
291: my ($hostname,$ignore_cache,$caller) = @_;
292: unless ($ignore_cache) {
293: my ($serverhomeID,$cached)=&is_cached_new('serverhomeID',$hostname);
294: if (defined($cached)) {
295: return $serverhomeID;
296: }
297: }
298: my $cachetime = 12*3600;
299: my $serverhomeID;
300: if ($caller eq 'loncron') {
301: my @machine_ids = &machine_ids($hostname);
302: foreach my $id (@machine_ids) {
303: my $response = &reply('serverhomeID',$id);
304: unless (($response eq 'unknown_cmd') || ($response eq 'con_lost')) {
305: $serverhomeID = $response;
306: last;
307: }
308: }
309: if ($serverhomeID eq '') {
310: $serverhomeID = $machine_ids[-1];
311: }
312: } else {
313: $serverhomeID = $serverhomeIDs{$hostname};
314: }
315: return &do_cache_new('serverhomeID',$hostname,$serverhomeID,$cachetime);
316: }
317:
318: sub get_remote_globals {
319: my ($lonhost,$whathash,$ignore_cache) = @_;
320: my ($result,%returnhash,%whatneeded);
321: if (ref($whathash) eq 'HASH') {
322: foreach my $what (sort(keys(%{$whathash}))) {
323: my $hashid = $lonhost.'-'.$what;
324: my ($response,$cached);
325: unless ($ignore_cache) {
326: ($response,$cached)=&is_cached_new('lonnetglobal',$hashid);
327: }
328: if (defined($cached)) {
329: $returnhash{$what} = $response;
330: } else {
331: $whatneeded{$what} = 1;
332: }
333: }
334: if (keys(%whatneeded) == 0) {
335: $result = 'ok';
336: } else {
337: my $requested = &freeze_escape(\%whatneeded);
338: my $rep=&reply('readlonnetglobal:'.$requested,$lonhost);
339: if (($rep=~/^(refused|rejected|error)/) || ($rep eq 'con_lost') ||
340: ($rep eq 'unknown_cmd')) {
341: $result = $rep;
342: } else {
343: $result = 'ok';
344: my @pairs=split(/\&/,$rep);
345: foreach my $item (@pairs) {
346: my ($key,$value)=split(/=/,$item,2);
347: my $what = &unescape($key);
348: my $hashid = $lonhost.'-'.$what;
349: $returnhash{$what}=&thaw_unescape($value);
350: &do_cache_new('lonnetglobal',$hashid,$returnhash{$what},600);
351: }
352: }
353: }
354: }
355: return ($result,\%returnhash);
356: }
357:
358: sub remote_devalidate_cache {
359: my ($lonhost,$cachekeys) = @_;
360: my $items;
361: return unless (ref($cachekeys) eq 'ARRAY');
362: my $cachestr = join('&',@{$cachekeys});
363: my $response = &reply('devalidatecache:'.&escape($cachestr),$lonhost);
364: return $response;
365: }
366:
367: # -------------------------------------------------- Non-critical communication
368: sub subreply {
369: my ($cmd,$server)=@_;
370: my $peerfile="$perlvar{'lonSockDir'}/".&hostname($server);
371: #
372: # With loncnew process trimming, there's a timing hole between lonc server
373: # process exit and the master server picking up the listen on the AF_UNIX
374: # socket. In that time interval, a lock file will exist:
375:
376: my $lockfile=$peerfile.".lock";
377: while (-e $lockfile) { # Need to wait for the lockfile to disappear.
378: sleep(0.1);
379: }
380: # At this point, either a loncnew parent is listening or an old lonc
381: # or loncnew child is listening so we can connect or everything's dead.
382: #
383: # We'll give the connection a few tries before abandoning it. If
384: # connection is not possible, we'll con_lost back to the client.
385: #
386: my $client;
387: for (my $retries = 0; $retries < $max_connection_retries; $retries++) {
388: $client=IO::Socket::UNIX->new(Peer =>"$peerfile",
389: Type => SOCK_STREAM,
390: Timeout => 10);
391: if ($client) {
392: last; # Connected!
393: } else {
394: &create_connection(&hostname($server),$server);
395: }
396: sleep(0.1); # Try again later if failed connection.
397: }
398: my $answer;
399: if ($client) {
400: print $client "sethost:$server:$cmd\n";
401: $answer=<$client>;
402: if (!$answer) { $answer="con_lost"; }
403: chomp($answer);
404: } else {
405: $answer = 'con_lost'; # Failed connection.
406: }
407: return $answer;
408: }
409:
410: sub reply {
411: my ($cmd,$server)=@_;
412: unless (defined(&hostname($server))) { return 'no_such_host'; }
413: my $answer=subreply($cmd,$server);
414: if (($answer=~/^refused/) || ($answer=~/^rejected/)) {
415: &logthis("<font color=\"blue\">WARNING:".
416: " $cmd to $server returned $answer</font>");
417: }
418: return $answer;
419: }
420:
421: # ----------------------------------------------------------- Send USR1 to lonc
422:
423: sub reconlonc {
424: my ($lonid) = @_;
425: if ($lonid) {
426: my $hostname = &hostname($lonid);
427: my $peerfile="$perlvar{'lonSockDir'}/$hostname";
428: if ($hostname && -e $peerfile) {
429: &logthis("Trying to reconnect lonc for $lonid ($hostname)");
430: my $client=IO::Socket::UNIX->new(Peer => $peerfile,
431: Type => SOCK_STREAM,
432: Timeout => 10);
433: if ($client) {
434: print $client ("reset_retries\n");
435: my $answer=<$client>;
436: #reset just this one.
437: }
438: }
439: return;
440: }
441:
442: &logthis("Trying to reconnect lonc");
443: my $loncfile="$perlvar{'lonDaemons'}/logs/lonc.pid";
444: if (open(my $fh,"<$loncfile")) {
445: my $loncpid=<$fh>;
446: chomp($loncpid);
447: if (kill 0 => $loncpid) {
448: &logthis("lonc at pid $loncpid responding, sending USR1");
449: kill USR1 => $loncpid;
450: sleep 1;
451: } else {
452: &logthis(
453: "<font color=\"blue\">WARNING:".
454: " lonc at pid $loncpid not responding, giving up</font>");
455: }
456: } else {
457: &logthis('<font color="blue">WARNING: lonc not running, giving up</font>');
458: }
459: }
460:
461: # ------------------------------------------------------ Critical communication
462:
463: sub critical {
464: my ($cmd,$server)=@_;
465: unless (&hostname($server)) {
466: &logthis("<font color=\"blue\">WARNING:".
467: " Critical message to unknown server ($server)</font>");
468: return 'no_such_host';
469: }
470: my $answer=reply($cmd,$server);
471: if ($answer eq 'con_lost') {
472: &reconlonc($server);
473: my $answer=reply($cmd,$server);
474: if ($answer eq 'con_lost') {
475: my $now=time;
476: my $middlename=$cmd;
477: $middlename=substr($middlename,0,16);
478: $middlename=~s/\W//g;
479: my $dfilename=
480: "$perlvar{'lonSockDir'}/delayed/$now.$dumpcount.$$.$middlename.$server";
481: $dumpcount++;
482: {
483: my $dfh;
484: if (open($dfh,">$dfilename")) {
485: print $dfh "$cmd\n";
486: close($dfh);
487: }
488: }
489: sleep 1;
490: my $wcmd='';
491: {
492: my $dfh;
493: if (open($dfh,"<$dfilename")) {
494: $wcmd=<$dfh>;
495: close($dfh);
496: }
497: }
498: chomp($wcmd);
499: if ($wcmd eq $cmd) {
500: &logthis("<font color=\"blue\">WARNING: ".
501: "Connection buffer $dfilename: $cmd</font>");
502: &logperm("D:$server:$cmd");
503: return 'con_delayed';
504: } else {
505: &logthis("<font color=\"red\">CRITICAL:"
506: ." Critical connection failed: $server $cmd</font>");
507: &logperm("F:$server:$cmd");
508: return 'con_failed';
509: }
510: }
511: }
512: return $answer;
513: }
514:
515: # ------------------------------------------- check if return value is an error
516:
517: sub error {
518: my ($result) = @_;
519: if ($result =~ /^(con_lost|no_such_host|error: (\d+) (.*))/) {
520: if ($2 == 2) { return undef; }
521: return $1;
522: }
523: return undef;
524: }
525:
526: sub convert_and_load_session_env {
527: my ($lonidsdir,$handle)=@_;
528: my @profile;
529: {
530: my $opened = open(my $idf,'+<',"$lonidsdir/$handle.id");
531: if (!$opened) {
532: return 0;
533: }
534: flock($idf,LOCK_SH);
535: @profile=<$idf>;
536: close($idf);
537: }
538: my %temp_env;
539: foreach my $line (@profile) {
540: if ($line !~ m/=/) {
541: return 0;
542: }
543: chomp($line);
544: my ($envname,$envvalue)=split(/=/,$line,2);
545: $temp_env{&unescape($envname)} = &unescape($envvalue);
546: }
547: unlink("$lonidsdir/$handle.id");
548: if (tie(my %disk_env,'GDBM_File',"$lonidsdir/$handle.id",&GDBM_WRCREAT(),
549: 0640)) {
550: %disk_env = %temp_env;
551: @env{keys(%temp_env)} = @disk_env{keys(%temp_env)};
552: untie(%disk_env);
553: }
554: return 1;
555: }
556:
557: # ------------------------------------------- Transfer profile into environment
558: my $env_loaded;
559: sub transfer_profile_to_env {
560: my ($lonidsdir,$handle,$force_transfer) = @_;
561: if (!$force_transfer && $env_loaded) { return; }
562:
563: if (!defined($lonidsdir)) {
564: $lonidsdir = $perlvar{'lonIDsDir'};
565: }
566: if (!defined($handle)) {
567: ($handle) = ($env{'user.environment'} =~m|/([^/]+)\.id$| );
568: }
569:
570: my $convert;
571: {
572: my $opened = open(my $idf,'+<',"$lonidsdir/$handle.id");
573: if (!$opened) {
574: return;
575: }
576: flock($idf,LOCK_SH);
577: if (tie(my %disk_env,'GDBM_File',"$lonidsdir/$handle.id",
578: &GDBM_READER(),0640)) {
579: @env{keys(%disk_env)} = @disk_env{keys(%disk_env)};
580: untie(%disk_env);
581: } else {
582: $convert = 1;
583: }
584: }
585: if ($convert) {
586: if (!&convert_and_load_session_env($lonidsdir,$handle)) {
587: &logthis("Failed to load session, or convert session.");
588: }
589: }
590:
591: my %remove;
592: while ( my $envname = each(%env) ) {
593: if (my ($key,$time) = ($envname =~ /^(cgi\.(\d+)_\d+\.)/)) {
594: if ($time < time-300) {
595: $remove{$key}++;
596: }
597: }
598: }
599:
600: $env{'user.environment'} = "$lonidsdir/$handle.id";
601: $env_loaded=1;
602: foreach my $expired_key (keys(%remove)) {
603: &delenv($expired_key);
604: }
605: }
606:
607: # ---------------------------------------------------- Check for valid session
608: sub check_for_valid_session {
609: my ($r,$name,$userhashref) = @_;
610: my %cookies=CGI::Cookie->parse($r->header_in('Cookie'));
611: if ($name eq '') {
612: $name = 'lonID';
613: }
614: my $lonid=$cookies{$name};
615: return undef if (!$lonid);
616:
617: my $handle=&LONCAPA::clean_handle($lonid->value);
618: my $lonidsdir;
619: if ($name eq 'lonDAV') {
620: $lonidsdir=$r->dir_config('lonDAVsessDir');
621: } else {
622: $lonidsdir=$r->dir_config('lonIDsDir');
623: }
624: return undef if (!-e "$lonidsdir/$handle.id");
625:
626: my $opened = open(my $idf,'+<',"$lonidsdir/$handle.id");
627: return undef if (!$opened);
628:
629: flock($idf,LOCK_SH);
630: my %disk_env;
631: if (!tie(%disk_env,'GDBM_File',"$lonidsdir/$handle.id",
632: &GDBM_READER(),0640)) {
633: return undef;
634: }
635:
636: if (!defined($disk_env{'user.name'})
637: || !defined($disk_env{'user.domain'})) {
638: return undef;
639: }
640:
641: if (ref($userhashref) eq 'HASH') {
642: $userhashref->{'name'} = $disk_env{'user.name'};
643: $userhashref->{'domain'} = $disk_env{'user.domain'};
644: }
645:
646: return $handle;
647: }
648:
649: sub timed_flock {
650: my ($file,$lock_type) = @_;
651: my $failed=0;
652: eval {
653: local $SIG{__DIE__}='DEFAULT';
654: local $SIG{ALRM}=sub {
655: $failed=1;
656: die("failed lock");
657: };
658: alarm(13);
659: flock($file,$lock_type);
660: alarm(0);
661: };
662: if ($failed) {
663: return undef;
664: } else {
665: return 1;
666: }
667: }
668:
669: # ---------------------------------------------------------- Append Environment
670:
671: sub appenv {
672: my ($newenv,$roles) = @_;
673: if (ref($newenv) eq 'HASH') {
674: foreach my $key (keys(%{$newenv})) {
675: my $refused = 0;
676: if (($key =~ /^user\.role/) || ($key =~ /^user\.priv/)) {
677: $refused = 1;
678: if (ref($roles) eq 'ARRAY') {
679: my ($type,$role) = ($key =~ m{^user\.(role|priv)\.(.+?)\./});
680: if (grep(/^\Q$role\E$/,@{$roles})) {
681: $refused = 0;
682: }
683: }
684: }
685: if ($refused) {
686: &logthis("<font color=\"blue\">WARNING: ".
687: "Attempt to modify environment ".$key." to ".$newenv->{$key}
688: .'</font>');
689: delete($newenv->{$key});
690: } else {
691: $env{$key}=$newenv->{$key};
692: }
693: }
694: my $opened = open(my $env_file,'+<',$env{'user.environment'});
695: if ($opened
696: && &timed_flock($env_file,LOCK_EX)
697: &&
698: tie(my %disk_env,'GDBM_File',$env{'user.environment'},
699: (&GDBM_WRITER()|&GDBM_NOLOCK()),0640)) {
700: while (my ($key,$value) = each(%{$newenv})) {
701: $disk_env{$key} = $value;
702: }
703: untie(%disk_env);
704: }
705: }
706: return 'ok';
707: }
708: # ----------------------------------------------------- Delete from Environment
709:
710: sub delenv {
711: my ($delthis,$regexp,$roles) = @_;
712: if (($delthis=~/^user\.role/) || ($delthis=~/^user\.priv/)) {
713: my $refused = 1;
714: if (ref($roles) eq 'ARRAY') {
715: my ($type,$role) = ($delthis =~ /^user\.(role|priv)\.([^.]+)\./);
716: if (grep(/^\Q$role\E$/,@{$roles})) {
717: $refused = 0;
718: }
719: }
720: if ($refused) {
721: &logthis("<font color=\"blue\">WARNING: ".
722: "Attempt to delete from environment ".$delthis);
723: return 'error';
724: }
725: }
726: my $opened = open(my $env_file,'+<',$env{'user.environment'});
727: if ($opened
728: && &timed_flock($env_file,LOCK_EX)
729: &&
730: tie(my %disk_env,'GDBM_File',$env{'user.environment'},
731: (&GDBM_WRITER()|&GDBM_NOLOCK()),0640)) {
732: foreach my $key (keys(%disk_env)) {
733: if ($regexp) {
734: if ($key=~/^$delthis/) {
735: delete($env{$key});
736: delete($disk_env{$key});
737: }
738: } else {
739: if ($key=~/^\Q$delthis\E/) {
740: delete($env{$key});
741: delete($disk_env{$key});
742: }
743: }
744: }
745: untie(%disk_env);
746: }
747: return 'ok';
748: }
749:
750: sub get_env_multiple {
751: my ($name) = @_;
752: my @values;
753: if (defined($env{$name})) {
754: # exists is it an array
755: if (ref($env{$name})) {
756: @values=@{ $env{$name} };
757: } else {
758: $values[0]=$env{$name};
759: }
760: }
761: return(@values);
762: }
763:
764: # ------------------------------------------------------------------- Locking
765:
766: sub set_lock {
767: my ($text)=@_;
768: $locknum++;
769: my $id=$$.'-'.$locknum;
770: &appenv({'session.locks' => $env{'session.locks'}.','.$id,
771: 'session.lock.'.$id => $text});
772: return $id;
773: }
774:
775: sub get_locks {
776: my $num=0;
777: my %texts=();
778: foreach my $lock (split(/\,/,$env{'session.locks'})) {
779: if ($lock=~/\w/) {
780: $num++;
781: $texts{$lock}=$env{'session.lock.'.$lock};
782: }
783: }
784: return ($num,%texts);
785: }
786:
787: sub remove_lock {
788: my ($id)=@_;
789: my $newlocks='';
790: foreach my $lock (split(/\,/,$env{'session.locks'})) {
791: if (($lock=~/\w/) && ($lock ne $id)) {
792: $newlocks.=','.$lock;
793: }
794: }
795: &appenv({'session.locks' => $newlocks});
796: &delenv('session.lock.'.$id);
797: }
798:
799: sub remove_all_locks {
800: my $activelocks=$env{'session.locks'};
801: foreach my $lock (split(/\,/,$env{'session.locks'})) {
802: if ($lock=~/\w/) {
803: &remove_lock($lock);
804: }
805: }
806: }
807:
808:
809: # ------------------------------------------ Find out current server userload
810: sub userload {
811: my $numusers=0;
812: {
813: opendir(LONIDS,$perlvar{'lonIDsDir'});
814: my $filename;
815: my $curtime=time;
816: while ($filename=readdir(LONIDS)) {
817: next if ($filename eq '.' || $filename eq '..');
818: next if ($filename =~ /publicuser_\d+\.id/);
819: my ($mtime)=(stat($perlvar{'lonIDsDir'}.'/'.$filename))[9];
820: if ($curtime-$mtime < 1800) { $numusers++; }
821: }
822: closedir(LONIDS);
823: }
824: my $userloadpercent=0;
825: my $maxuserload=$perlvar{'lonUserLoadLim'};
826: if ($maxuserload) {
827: $userloadpercent=100*$numusers/$maxuserload;
828: }
829: $userloadpercent=sprintf("%.2f",$userloadpercent);
830: return $userloadpercent;
831: }
832:
833: # ------------------------------ Find server with least workload from spare.tab
834:
835: sub spareserver {
836: my ($loadpercent,$userloadpercent,$want_server_name,$udom) = @_;
837: my $spare_server;
838: if ($userloadpercent !~ /\d/) { $userloadpercent=0; }
839: my $lowest_load=($loadpercent > $userloadpercent) ? $loadpercent
840: : $userloadpercent;
841: my ($uint_dom,$remotesessions);
842: if (($udom ne '') && (&domain($udom) ne '')) {
843: my $uprimary_id = &Apache::lonnet::domain($udom,'primary');
844: $uint_dom = &Apache::lonnet::internet_dom($uprimary_id);
845: my %udomdefaults = &Apache::lonnet::get_domain_defaults($udom);
846: $remotesessions = $udomdefaults{'remotesessions'};
847: }
848: my $spareshash = &this_host_spares($udom);
849: if (ref($spareshash) eq 'HASH') {
850: if (ref($spareshash->{'primary'}) eq 'ARRAY') {
851: foreach my $try_server (@{ $spareshash->{'primary'} }) {
852: next unless (&spare_can_host($udom,$uint_dom,$remotesessions,
853: $try_server));
854: ($spare_server, $lowest_load) =
855: &compare_server_load($try_server, $spare_server, $lowest_load);
856: }
857: }
858:
859: my $found_server = ($spare_server ne '' && $lowest_load < 100);
860:
861: if (!$found_server) {
862: if (ref($spareshash->{'default'}) eq 'ARRAY') {
863: foreach my $try_server (@{ $spareshash->{'default'} }) {
864: next unless (&spare_can_host($udom,$uint_dom,
865: $remotesessions,$try_server));
866: ($spare_server, $lowest_load) =
867: &compare_server_load($try_server, $spare_server, $lowest_load);
868: }
869: }
870: }
871: }
872:
873: if (!$want_server_name) {
874: my $protocol = 'http';
875: if ($protocol{$spare_server} eq 'https') {
876: $protocol = $protocol{$spare_server};
877: }
878: if (defined($spare_server)) {
879: my $hostname = &hostname($spare_server);
880: if (defined($hostname)) {
881: $spare_server = $protocol.'://'.$hostname;
882: }
883: }
884: }
885: return $spare_server;
886: }
887:
888: sub compare_server_load {
889: my ($try_server, $spare_server, $lowest_load, $required) = @_;
890:
891: if ($required) {
892: my ($reqdmajor,$reqdminor) = ($required =~ /^(\d+)\.(\d+)$/);
893: my $remoterev = &get_server_loncaparev(undef,$try_server);
894: my ($major,$minor) = ($remoterev =~ /^\'?(\d+)\.(\d+)\.[\w.\-]+\'?$/);
895: if (($major eq '' && $minor eq '') ||
896: (($reqdmajor > $major) || (($reqdmajor == $major) && ($reqdminor > $minor)))) {
897: return ($spare_server,$lowest_load);
898: }
899: }
900:
901: my $loadans = &reply('load', $try_server);
902: my $userloadans = &reply('userload',$try_server);
903:
904: if ($loadans !~ /\d/ && $userloadans !~ /\d/) {
905: return ($spare_server, $lowest_load); #didn't get a number from the server
906: }
907:
908: my $load;
909: if ($loadans =~ /\d/) {
910: if ($userloadans =~ /\d/) {
911: #both are numbers, pick the bigger one
912: $load = ($loadans > $userloadans) ? $loadans
913: : $userloadans;
914: } else {
915: $load = $loadans;
916: }
917: } else {
918: $load = $userloadans;
919: }
920:
921: if (($load =~ /\d/) && ($load < $lowest_load)) {
922: $spare_server = $try_server;
923: $lowest_load = $load;
924: }
925: return ($spare_server,$lowest_load);
926: }
927:
928: # --------------------------- ask offload servers if user already has a session
929: sub find_existing_session {
930: my ($udom,$uname) = @_;
931: my $spareshash = &this_host_spares($udom);
932: if (ref($spareshash) eq 'HASH') {
933: if (ref($spareshash->{'primary'}) eq 'ARRAY') {
934: foreach my $try_server (@{ $spareshash->{'primary'} }) {
935: return $try_server if (&has_user_session($try_server, $udom, $uname));
936: }
937: }
938: if (ref($spareshash->{'default'}) eq 'ARRAY') {
939: foreach my $try_server (@{ $spareshash->{'default'} }) {
940: return $try_server if (&has_user_session($try_server, $udom, $uname));
941: }
942: }
943: }
944: return;
945: }
946:
947: # -------------------------------- ask if server already has a session for user
948: sub has_user_session {
949: my ($lonid,$udom,$uname) = @_;
950: my $result = &reply(join(':','userhassession',
951: map {&escape($_)} ($udom,$uname)),$lonid);
952: return 1 if ($result eq 'ok');
953:
954: return 0;
955: }
956:
957: # --------- determine least loaded server in a user's domain which allows login
958:
959: sub choose_server {
960: my ($udom,$checkloginvia,$required,$skiploadbal) = @_;
961: my %domconfhash = &Apache::loncommon::get_domainconf($udom);
962: my %servers = &get_servers($udom);
963: my $lowest_load = 30000;
964: my ($login_host,$hostname,$portal_path,$isredirect,$balancers);
965: if ($skiploadbal) {
966: ($balancers,my $cached)=&is_cached_new('loadbalancing',$udom);
967: unless (defined($cached)) {
968: my $cachetime = 60*60*24;
969: my %domconfig =
970: &Apache::lonnet::get_dom('configuration',['loadbalancing'],$udom);
971: if (ref($domconfig{'loadbalancing'}) eq 'HASH') {
972: $balancers = &do_cache_new('loadbalancing',$udom,$domconfig{'loadbalancing'},
973: $cachetime);
974: }
975: }
976: }
977: foreach my $lonhost (keys(%servers)) {
978: if ($skiploadbal) {
979: if (ref($balancers) eq 'HASH') {
980: next if (exists($balancers->{$lonhost}));
981: }
982: }
983: my $loginvia;
984: if ($checkloginvia) {
985: $loginvia = $domconfhash{$udom.'.login.loginvia_'.$lonhost};
986: if ($loginvia) {
987: my ($server,$path) = split(/:/,$loginvia);
988: ($login_host, $lowest_load) =
989: &compare_server_load($server, $login_host, $lowest_load, $required);
990: if ($login_host eq $server) {
991: $portal_path = $path;
992: $isredirect = 1;
993: }
994: } else {
995: ($login_host, $lowest_load) =
996: &compare_server_load($lonhost, $login_host, $lowest_load, $required);
997: if ($login_host eq $lonhost) {
998: $portal_path = '';
999: $isredirect = '';
1000: }
1001: }
1002: } else {
1003: ($login_host, $lowest_load) =
1004: &compare_server_load($lonhost, $login_host, $lowest_load, $required);
1005: }
1006: }
1007: if ($login_host ne '') {
1008: $hostname = &hostname($login_host);
1009: }
1010: return ($login_host,$hostname,$portal_path,$isredirect);
1011: }
1012:
1013: # --------------------------------------------- Try to change a user's password
1014:
1015: sub changepass {
1016: my ($uname,$udom,$currentpass,$newpass,$server,$context)=@_;
1017: $currentpass = &escape($currentpass);
1018: $newpass = &escape($newpass);
1019: my $lonhost = $perlvar{'lonHostID'};
1020: my $answer = reply("encrypt:passwd:$udom:$uname:$currentpass:$newpass:$context:$lonhost",
1021: $server);
1022: if (! $answer) {
1023: &logthis("No reply on password change request to $server ".
1024: "by $uname in domain $udom.");
1025: } elsif ($answer =~ "^ok") {
1026: &logthis("$uname in $udom successfully changed their password ".
1027: "on $server.");
1028: } elsif ($answer =~ "^pwchange_failure") {
1029: &logthis("$uname in $udom was unable to change their password ".
1030: "on $server. The action was blocked by either lcpasswd ".
1031: "or pwchange");
1032: } elsif ($answer =~ "^non_authorized") {
1033: &logthis("$uname in $udom did not get their password correct when ".
1034: "attempting to change it on $server.");
1035: } elsif ($answer =~ "^auth_mode_error") {
1036: &logthis("$uname in $udom attempted to change their password despite ".
1037: "not being locally or internally authenticated on $server.");
1038: } elsif ($answer =~ "^unknown_user") {
1039: &logthis("$uname in $udom attempted to change their password ".
1040: "on $server but were unable to because $server is not ".
1041: "their home server.");
1042: } elsif ($answer =~ "^refused") {
1043: &logthis("$server refused to change $uname in $udom password because ".
1044: "it was sent an unencrypted request to change the password.");
1045: } elsif ($answer =~ "invalid_client") {
1046: &logthis("$server refused to change $uname in $udom password because ".
1047: "it was a reset by e-mail originating from an invalid server.");
1048: }
1049: return $answer;
1050: }
1051:
1052: # ----------------------- Try to determine user's current authentication scheme
1053:
1054: sub queryauthenticate {
1055: my ($uname,$udom)=@_;
1056: my $uhome=&homeserver($uname,$udom);
1057: if (!$uhome) {
1058: &logthis("User $uname at $udom is unknown when looking for authentication mechanism");
1059: return 'no_host';
1060: }
1061: my $answer=reply("encrypt:currentauth:$udom:$uname",$uhome);
1062: if ($answer =~ /^(unknown_user|refused|con_lost)/) {
1063: &logthis("User $uname at $udom threw error $answer when checking authentication mechanism");
1064: }
1065: return $answer;
1066: }
1067:
1068: # --------- Try to authenticate user from domain's lib servers (first this one)
1069:
1070: sub authenticate {
1071: my ($uname,$upass,$udom,$checkdefauth,$clientcancheckhost)=@_;
1072: $upass=&escape($upass);
1073: $uname= &LONCAPA::clean_username($uname);
1074: my $uhome=&homeserver($uname,$udom,1);
1075: my $newhome;
1076: if ((!$uhome) || ($uhome eq 'no_host')) {
1077: # Maybe the machine was offline and only re-appeared again recently?
1078: &reconlonc();
1079: # One more
1080: $uhome=&homeserver($uname,$udom,1);
1081: if (($uhome eq 'no_host') && $checkdefauth) {
1082: if (defined(&domain($udom,'primary'))) {
1083: $newhome=&domain($udom,'primary');
1084: }
1085: if ($newhome ne '') {
1086: $uhome = $newhome;
1087: }
1088: }
1089: if ((!$uhome) || ($uhome eq 'no_host')) {
1090: &logthis("User $uname at $udom is unknown in authenticate");
1091: return 'no_host';
1092: }
1093: }
1094: my $answer=reply("encrypt:auth:$udom:$uname:$upass:$checkdefauth:$clientcancheckhost",$uhome);
1095: if ($answer eq 'authorized') {
1096: if ($newhome) {
1097: &logthis("User $uname at $udom authorized by $uhome, but needs account");
1098: return 'no_account_on_host';
1099: } else {
1100: &logthis("User $uname at $udom authorized by $uhome");
1101: return $uhome;
1102: }
1103: }
1104: if ($answer eq 'non_authorized') {
1105: &logthis("User $uname at $udom rejected by $uhome");
1106: return 'no_host';
1107: }
1108: &logthis("User $uname at $udom threw error $answer when checking authentication mechanism");
1109: return 'no_host';
1110: }
1111:
1112: sub can_host_session {
1113: my ($udom,$lonhost,$remoterev,$remotesessions,$hostedsessions) = @_;
1114: my $canhost = 1;
1115: my $host_idn = &Apache::lonnet::internet_dom($lonhost);
1116: if (ref($remotesessions) eq 'HASH') {
1117: if (ref($remotesessions->{'excludedomain'}) eq 'ARRAY') {
1118: if (grep(/^\Q$host_idn\E$/,@{$remotesessions->{'excludedomain'}})) {
1119: $canhost = 0;
1120: } else {
1121: $canhost = 1;
1122: }
1123: }
1124: if (ref($remotesessions->{'includedomain'}) eq 'ARRAY') {
1125: if (grep(/^\Q$host_idn\E$/,@{$remotesessions->{'includedomain'}})) {
1126: $canhost = 1;
1127: } else {
1128: $canhost = 0;
1129: }
1130: }
1131: if ($canhost) {
1132: if ($remotesessions->{'version'} ne '') {
1133: my ($reqmajor,$reqminor) = ($remotesessions->{'version'} =~ /^(\d+)\.(\d+)$/);
1134: if ($reqmajor ne '' && $reqminor ne '') {
1135: if ($remoterev =~ /^\'?(\d+)\.(\d+)/) {
1136: my $major = $1;
1137: my $minor = $2;
1138: if (($major < $reqmajor ) ||
1139: (($major == $reqmajor) && ($minor < $reqminor))) {
1140: $canhost = 0;
1141: }
1142: } else {
1143: $canhost = 0;
1144: }
1145: }
1146: }
1147: }
1148: }
1149: if ($canhost) {
1150: if (ref($hostedsessions) eq 'HASH') {
1151: my $uprimary_id = &Apache::lonnet::domain($udom,'primary');
1152: my $uint_dom = &Apache::lonnet::internet_dom($uprimary_id);
1153: if (ref($hostedsessions->{'excludedomain'}) eq 'ARRAY') {
1154: if (($uint_dom ne '') &&
1155: (grep(/^\Q$uint_dom\E$/,@{$hostedsessions->{'excludedomain'}}))) {
1156: $canhost = 0;
1157: } else {
1158: $canhost = 1;
1159: }
1160: }
1161: if (ref($hostedsessions->{'includedomain'}) eq 'ARRAY') {
1162: if (($uint_dom ne '') &&
1163: (grep(/^\Q$uint_dom\E$/,@{$hostedsessions->{'includedomain'}}))) {
1164: $canhost = 1;
1165: } else {
1166: $canhost = 0;
1167: }
1168: }
1169: }
1170: }
1171: return $canhost;
1172: }
1173:
1174: sub spare_can_host {
1175: my ($udom,$uint_dom,$remotesessions,$try_server)=@_;
1176: my $canhost=1;
1177: my $try_server_hostname = &hostname($try_server);
1178: my $serverhomeID = &get_server_homeID($try_server_hostname);
1179: my $serverhomedom = &host_domain($serverhomeID);
1180: my %defdomdefaults = &get_domain_defaults($serverhomedom);
1181: if (ref($defdomdefaults{'offloadnow'}) eq 'HASH') {
1182: if ($defdomdefaults{'offloadnow'}{$try_server}) {
1183: $canhost = 0;
1184: }
1185: }
1186: if (($canhost) && ($uint_dom)) {
1187: my @intdoms;
1188: my $internet_names = &get_internet_names($try_server);
1189: if (ref($internet_names) eq 'ARRAY') {
1190: @intdoms = @{$internet_names};
1191: }
1192: unless (grep(/^\Q$uint_dom\E$/,@intdoms)) {
1193: my $remoterev = &get_server_loncaparev(undef,$try_server);
1194: $canhost = &can_host_session($udom,$try_server,$remoterev,
1195: $remotesessions,
1196: $defdomdefaults{'hostedsessions'});
1197: }
1198: }
1199: return $canhost;
1200: }
1201:
1202: sub this_host_spares {
1203: my ($dom) = @_;
1204: my ($dom_in_use,$lonhost_in_use,$result);
1205: my @hosts = ¤t_machine_ids();
1206: foreach my $lonhost (@hosts) {
1207: if (&host_domain($lonhost) eq $dom) {
1208: $dom_in_use = $dom;
1209: $lonhost_in_use = $lonhost;
1210: last;
1211: }
1212: }
1213: if ($dom_in_use ne '') {
1214: $result = &spares_for_offload($dom_in_use,$lonhost_in_use);
1215: }
1216: if (ref($result) ne 'HASH') {
1217: $lonhost_in_use = $perlvar{'lonHostID'};
1218: $dom_in_use = &host_domain($lonhost_in_use);
1219: $result = &spares_for_offload($dom_in_use,$lonhost_in_use);
1220: if (ref($result) ne 'HASH') {
1221: $result = \%spareid;
1222: }
1223: }
1224: return $result;
1225: }
1226:
1227: sub spares_for_offload {
1228: my ($dom_in_use,$lonhost_in_use) = @_;
1229: my ($result,$cached)=&is_cached_new('spares',$dom_in_use);
1230: if (defined($cached)) {
1231: return $result;
1232: } else {
1233: my $cachetime = 60*60*24;
1234: my %domconfig =
1235: &Apache::lonnet::get_dom('configuration',['usersessions'],$dom_in_use);
1236: if (ref($domconfig{'usersessions'}) eq 'HASH') {
1237: if (ref($domconfig{'usersessions'}{'spares'}) eq 'HASH') {
1238: if (ref($domconfig{'usersessions'}{'spares'}{$lonhost_in_use}) eq 'HASH') {
1239: return &do_cache_new('spares',$dom_in_use,$domconfig{'usersessions'}{'spares'}{$lonhost_in_use},$cachetime);
1240: }
1241: }
1242: }
1243: }
1244: return;
1245: }
1246:
1247: sub get_lonbalancer_config {
1248: my ($servers) = @_;
1249: my ($currbalancer,$currtargets);
1250: if (ref($servers) eq 'HASH') {
1251: foreach my $server (keys(%{$servers})) {
1252: my %what = (
1253: spareid => 1,
1254: perlvar => 1,
1255: );
1256: my ($result,$returnhash) = &get_remote_globals($server,\%what);
1257: if ($result eq 'ok') {
1258: if (ref($returnhash) eq 'HASH') {
1259: if (ref($returnhash->{'perlvar'}) eq 'HASH') {
1260: if ($returnhash->{'perlvar'}->{'lonBalancer'} eq 'yes') {
1261: $currbalancer = $server;
1262: $currtargets = {};
1263: if (ref($returnhash->{'spareid'}) eq 'HASH') {
1264: if (ref($returnhash->{'spareid'}->{'primary'}) eq 'ARRAY') {
1265: $currtargets->{'primary'} = $returnhash->{'spareid'}->{'primary'};
1266: }
1267: if (ref($returnhash->{'spareid'}->{'default'}) eq 'ARRAY') {
1268: $currtargets->{'default'} = $returnhash->{'spareid'}->{'default'};
1269: }
1270: }
1271: last;
1272: }
1273: }
1274: }
1275: }
1276: }
1277: }
1278: return ($currbalancer,$currtargets);
1279: }
1280:
1281: sub check_loadbalancing {
1282: my ($uname,$udom) = @_;
1283: my ($is_balancer,$currtargets,$currrules,$dom_in_use,$homeintdom,
1284: $rule_in_effect,$offloadto,$otherserver);
1285: my $lonhost = $perlvar{'lonHostID'};
1286: my @hosts = ¤t_machine_ids();
1287: my $uprimary_id = &Apache::lonnet::domain($udom,'primary');
1288: my $uintdom = &Apache::lonnet::internet_dom($uprimary_id);
1289: my $intdom = &Apache::lonnet::internet_dom($lonhost);
1290: my $serverhomedom = &host_domain($lonhost);
1291: my $domneedscache;
1292: my $cachetime = 60*60*24;
1293:
1294: if (($uintdom ne '') && ($uintdom eq $intdom)) {
1295: $dom_in_use = $udom;
1296: $homeintdom = 1;
1297: } else {
1298: $dom_in_use = $serverhomedom;
1299: }
1300: my ($result,$cached)=&is_cached_new('loadbalancing',$dom_in_use);
1301: unless (defined($cached)) {
1302: my %domconfig =
1303: &Apache::lonnet::get_dom('configuration',['loadbalancing'],$dom_in_use);
1304: if (ref($domconfig{'loadbalancing'}) eq 'HASH') {
1305: $result = &do_cache_new('loadbalancing',$dom_in_use,$domconfig{'loadbalancing'},$cachetime);
1306: } else {
1307: $domneedscache = $dom_in_use;
1308: }
1309: }
1310: if (ref($result) eq 'HASH') {
1311: ($is_balancer,$currtargets,$currrules) =
1312: &check_balancer_result($result,@hosts);
1313: if ($is_balancer) {
1314: if (ref($currrules) eq 'HASH') {
1315: if ($homeintdom) {
1316: if ($uname ne '') {
1317: if (($currrules->{'_LC_adv'} ne '') || ($currrules->{'_LC_author'} ne '')) {
1318: my ($is_adv,$is_author) = &is_advanced_user($udom,$uname);
1319: if (($currrules->{'_LC_author'} ne '') && ($is_author)) {
1320: $rule_in_effect = $currrules->{'_LC_author'};
1321: } elsif (($currrules->{'_LC_adv'} ne '') && ($is_adv)) {
1322: $rule_in_effect = $currrules->{'_LC_adv'}
1323: }
1324: }
1325: if ($rule_in_effect eq '') {
1326: my %userenv = &userenvironment($udom,$uname,'inststatus');
1327: if ($userenv{'inststatus'} ne '') {
1328: my @statuses = map { &unescape($_); } split(/:/,$userenv{'inststatus'});
1329: my ($othertitle,$usertypes,$types) =
1330: &Apache::loncommon::sorted_inst_types($udom);
1331: if (ref($types) eq 'ARRAY') {
1332: foreach my $type (@{$types}) {
1333: if (grep(/^\Q$type\E$/,@statuses)) {
1334: if (exists($currrules->{$type})) {
1335: $rule_in_effect = $currrules->{$type};
1336: }
1337: }
1338: }
1339: }
1340: } else {
1341: if (exists($currrules->{'default'})) {
1342: $rule_in_effect = $currrules->{'default'};
1343: }
1344: }
1345: }
1346: } else {
1347: if (exists($currrules->{'default'})) {
1348: $rule_in_effect = $currrules->{'default'};
1349: }
1350: }
1351: } else {
1352: if ($currrules->{'_LC_external'} ne '') {
1353: $rule_in_effect = $currrules->{'_LC_external'};
1354: }
1355: }
1356: $offloadto = &get_loadbalancer_targets($rule_in_effect,$currtargets,
1357: $uname,$udom);
1358: }
1359: }
1360: } elsif (($homeintdom) && ($udom ne $serverhomedom)) {
1361: ($result,$cached)=&is_cached_new('loadbalancing',$serverhomedom);
1362: unless (defined($cached)) {
1363: my %domconfig =
1364: &Apache::lonnet::get_dom('configuration',['loadbalancing'],$serverhomedom);
1365: if (ref($domconfig{'loadbalancing'}) eq 'HASH') {
1366: $result = &do_cache_new('loadbalancing',$serverhomedom,$domconfig{'loadbalancing'},$cachetime);
1367: } else {
1368: $domneedscache = $serverhomedom;
1369: }
1370: }
1371: if (ref($result) eq 'HASH') {
1372: ($is_balancer,$currtargets,$currrules) =
1373: &check_balancer_result($result,@hosts);
1374: if ($is_balancer) {
1375: if (ref($currrules) eq 'HASH') {
1376: if ($currrules->{'_LC_internetdom'} ne '') {
1377: $rule_in_effect = $currrules->{'_LC_internetdom'};
1378: }
1379: }
1380: $offloadto = &get_loadbalancer_targets($rule_in_effect,$currtargets,
1381: $uname,$udom);
1382: }
1383: } else {
1384: if ($perlvar{'lonBalancer'} eq 'yes') {
1385: $is_balancer = 1;
1386: $offloadto = &this_host_spares($dom_in_use);
1387: }
1388: unless (defined($cached)) {
1389: $domneedscache = $serverhomedom;
1390: }
1391: }
1392: } else {
1393: if ($perlvar{'lonBalancer'} eq 'yes') {
1394: $is_balancer = 1;
1395: $offloadto = &this_host_spares($dom_in_use);
1396: }
1397: unless (defined($cached)) {
1398: $domneedscache = $serverhomedom;
1399: }
1400: }
1401: if ($domneedscache) {
1402: &do_cache_new('loadbalancing',$domneedscache,$is_balancer,$cachetime);
1403: }
1404: if ($is_balancer) {
1405: my $lowest_load = 30000;
1406: if (ref($offloadto) eq 'HASH') {
1407: if (ref($offloadto->{'primary'}) eq 'ARRAY') {
1408: foreach my $try_server (@{$offloadto->{'primary'}}) {
1409: ($otherserver,$lowest_load) =
1410: &compare_server_load($try_server,$otherserver,$lowest_load);
1411: }
1412: }
1413: my $found_server = ($otherserver ne '' && $lowest_load < 100);
1414:
1415: if (!$found_server) {
1416: if (ref($offloadto->{'default'}) eq 'ARRAY') {
1417: foreach my $try_server (@{$offloadto->{'default'}}) {
1418: ($otherserver,$lowest_load) =
1419: &compare_server_load($try_server,$otherserver,$lowest_load);
1420: }
1421: }
1422: }
1423: } elsif (ref($offloadto) eq 'ARRAY') {
1424: if (@{$offloadto} == 1) {
1425: $otherserver = $offloadto->[0];
1426: } elsif (@{$offloadto} > 1) {
1427: foreach my $try_server (@{$offloadto}) {
1428: ($otherserver,$lowest_load) =
1429: &compare_server_load($try_server,$otherserver,$lowest_load);
1430: }
1431: }
1432: }
1433: if (($otherserver ne '') && (grep(/^\Q$otherserver\E$/,@hosts))) {
1434: $is_balancer = 0;
1435: if ($uname ne '' && $udom ne '') {
1436: if (($env{'user.name'} eq $uname) && ($env{'user.domain'} eq $udom)) {
1437:
1438: &appenv({'user.loadbalexempt' => $lonhost,
1439: 'user.loadbalcheck.time' => time});
1440: }
1441: }
1442: }
1443: }
1444: return ($is_balancer,$otherserver);
1445: }
1446:
1447: sub check_balancer_result {
1448: my ($result,@hosts) = @_;
1449: my ($is_balancer,$currtargets,$currrules);
1450: if (ref($result) eq 'HASH') {
1451: if ($result->{'lonhost'} ne '') {
1452: my $currbalancer = $result->{'lonhost'};
1453: if (grep(/^\Q$currbalancer\E$/,@hosts)) {
1454: $is_balancer = 1;
1455: $currtargets = $result->{'targets'};
1456: $currrules = $result->{'rules'};
1457: }
1458: } else {
1459: foreach my $key (keys(%{$result})) {
1460: if (($key ne '') && (grep(/^\Q$key\E$/,@hosts)) &&
1461: (ref($result->{$key}) eq 'HASH')) {
1462: $is_balancer = 1;
1463: $currrules = $result->{$key}{'rules'};
1464: $currtargets = $result->{$key}{'targets'};
1465: last;
1466: }
1467: }
1468: }
1469: }
1470: return ($is_balancer,$currtargets,$currrules);
1471: }
1472:
1473: sub get_loadbalancer_targets {
1474: my ($rule_in_effect,$currtargets,$uname,$udom) = @_;
1475: my $offloadto;
1476: if ($rule_in_effect eq 'none') {
1477: return [$perlvar{'lonHostID'}];
1478: } elsif ($rule_in_effect eq '') {
1479: $offloadto = $currtargets;
1480: } else {
1481: if ($rule_in_effect eq 'homeserver') {
1482: my $homeserver = &homeserver($uname,$udom);
1483: if ($homeserver ne 'no_host') {
1484: $offloadto = [$homeserver];
1485: }
1486: } elsif ($rule_in_effect eq 'externalbalancer') {
1487: my %domconfig =
1488: &Apache::lonnet::get_dom('configuration',['loadbalancing'],$udom);
1489: if (ref($domconfig{'loadbalancing'}) eq 'HASH') {
1490: if ($domconfig{'loadbalancing'}{'lonhost'} ne '') {
1491: if (&hostname($domconfig{'loadbalancing'}{'lonhost'}) ne '') {
1492: $offloadto = [$domconfig{'loadbalancing'}{'lonhost'}];
1493: }
1494: }
1495: } else {
1496: my %servers = &internet_dom_servers($udom);
1497: my ($remotebalancer,$remotetargets) = &get_lonbalancer_config(\%servers);
1498: if (&hostname($remotebalancer) ne '') {
1499: $offloadto = [$remotebalancer];
1500: }
1501: }
1502: } elsif (&hostname($rule_in_effect) ne '') {
1503: $offloadto = [$rule_in_effect];
1504: }
1505: }
1506: return $offloadto;
1507: }
1508:
1509: sub internet_dom_servers {
1510: my ($dom) = @_;
1511: my (%uniqservers,%servers);
1512: my $primaryserver = &hostname(&domain($dom,'primary'));
1513: my @machinedoms = &machine_domains($primaryserver);
1514: foreach my $mdom (@machinedoms) {
1515: my %currservers = %servers;
1516: my %server = &get_servers($mdom);
1517: %servers = (%currservers,%server);
1518: }
1519: my %by_hostname;
1520: foreach my $id (keys(%servers)) {
1521: push(@{$by_hostname{$servers{$id}}},$id);
1522: }
1523: foreach my $hostname (sort(keys(%by_hostname))) {
1524: if (@{$by_hostname{$hostname}} > 1) {
1525: my $match = 0;
1526: foreach my $id (@{$by_hostname{$hostname}}) {
1527: if (&host_domain($id) eq $dom) {
1528: $uniqservers{$id} = $hostname;
1529: $match = 1;
1530: }
1531: }
1532: unless ($match) {
1533: $uniqservers{$by_hostname{$hostname}[0]} = $hostname;
1534: }
1535: } else {
1536: $uniqservers{$by_hostname{$hostname}[0]} = $hostname;
1537: }
1538: }
1539: return %uniqservers;
1540: }
1541:
1542: # ---------------------- Find the homebase for a user from domain's lib servers
1543:
1544: my %homecache;
1545: sub homeserver {
1546: my ($uname,$udom,$ignoreBadCache)=@_;
1547: my $index="$uname:$udom";
1548:
1549: if (exists($homecache{$index})) { return $homecache{$index}; }
1550:
1551: my %servers = &get_servers($udom,'library');
1552: foreach my $tryserver (keys(%servers)) {
1553: next if ($ignoreBadCache ne 'true' &&
1554: exists($badServerCache{$tryserver}));
1555:
1556: my $answer=reply("home:$udom:$uname",$tryserver);
1557: if ($answer eq 'found') {
1558: delete($badServerCache{$tryserver});
1559: return $homecache{$index}=$tryserver;
1560: } elsif ($answer eq 'no_host') {
1561: $badServerCache{$tryserver}=1;
1562: }
1563: }
1564: return 'no_host';
1565: }
1566:
1567: # ----- Find the usernames behind a list of student/employee IDs or clicker IDs
1568:
1569: sub idget {
1570: my ($udom,$idsref,$namespace)=@_;
1571: my %returnhash=();
1572: my @ids=();
1573: if (ref($idsref) eq 'ARRAY') {
1574: @ids = @{$idsref};
1575: } else {
1576: return %returnhash;
1577: }
1578: if ($namespace eq '') {
1579: $namespace = 'ids';
1580: }
1581:
1582: my %servers = &get_servers($udom,'library');
1583: foreach my $tryserver (keys(%servers)) {
1584: my $idlist=join('&', map { &escape($_); } @ids);
1585: if ($namespace eq 'ids') {
1586: $idlist=~tr/A-Z/a-z/;
1587: }
1588: my $reply;
1589: if ($namespace eq 'ids') {
1590: $reply=&reply("idget:$udom:".$idlist,$tryserver);
1591: } else {
1592: $reply=&reply("getdom:$udom:$namespace:$idlist",$tryserver);
1593: }
1594: my @answer=();
1595: if (($reply ne 'con_lost') && ($reply!~/^error\:/)) {
1596: @answer=split(/\&/,$reply);
1597: } ;
1598: my $i;
1599: for ($i=0;$i<=$#ids;$i++) {
1600: if ($answer[$i]) {
1601: $returnhash{$ids[$i]}=&unescape($answer[$i]);
1602: }
1603: }
1604: }
1605: return %returnhash;
1606: }
1607:
1608: # ------------------------------------- Find the IDs behind a list of usernames
1609:
1610: sub idrget {
1611: my ($udom,@unames)=@_;
1612: my %returnhash=();
1613: foreach my $uname (@unames) {
1614: $returnhash{$uname}=(&userenvironment($udom,$uname,'id'))[1];
1615: }
1616: return %returnhash;
1617: }
1618:
1619: # Store away a list of names and associated student/employee IDs or clicker IDs
1620:
1621: sub idput {
1622: my ($udom,$idsref,$uhom,$namespace)=@_;
1623: my %servers=();
1624: my %ids=();
1625: my %byid = ();
1626: if (ref($idsref) eq 'HASH') {
1627: %ids=%{$idsref};
1628: }
1629: if ($namespace eq '') {
1630: $namespace = 'ids';
1631: }
1632: foreach my $uname (keys(%ids)) {
1633: &cput('environment',{'id'=>$ids{$uname}},$udom,$uname);
1634: if ($uhom eq '') {
1635: $uhom=&homeserver($uname,$udom);
1636: }
1637: if ($uhom ne 'no_host') {
1638: my $esc_unam=&escape($uname);
1639: if ($namespace eq 'ids') {
1640: my $id=&escape($ids{$uname});
1641: $id=~tr/A-Z/a-z/;
1642: my $esc_unam=&escape($uname);
1643: $servers{$uhom}.=$id.'='.$esc_unam.'&';
1644: } else {
1645: my @currids = split(/,/,$ids{$uname});
1646: foreach my $id (@currids) {
1647: $byid{$uhom}{$id} .= $uname.',';
1648: }
1649: }
1650: }
1651: }
1652: if ($namespace eq 'clickers') {
1653: foreach my $server (keys(%byid)) {
1654: if (ref($byid{$server}) eq 'HASH') {
1655: foreach my $id (keys(%{$byid{$server}})) {
1656: $byid{$server} =~ s/,$//;
1657: $servers{$uhom}.=&escape($id).'='.&escape($byid{$server}).'&';
1658: }
1659: }
1660: }
1661: }
1662: foreach my $server (keys(%servers)) {
1663: $servers{$server} =~ s/\&$//;
1664: if ($namespace eq 'ids') {
1665: &critical('idput:'.$udom.':'.$servers{$server},$server);
1666: } else {
1667: &critical('updateclickers:'.$udom.':add:'.$servers{$server},$server);
1668: }
1669: }
1670: }
1671:
1672: # ------------- Delete unwanted student/employee IDs or clicker IDs from domain
1673:
1674: sub iddel {
1675: my ($udom,$idshashref,$uhome,$namespace)=@_;
1676: my %result=();
1677: my %ids=();
1678: my %byid = ();
1679: if (ref($idshashref) eq 'HASH') {
1680: %ids=%{$idshashref};
1681: } else {
1682: return %result;
1683: }
1684: if ($namespace eq '') {
1685: $namespace = 'ids';
1686: }
1687: my %servers=();
1688: while (my ($id,$unamestr) = each(%ids)) {
1689: if ($namespace eq 'ids') {
1690: my $uhom = $uhome;
1691: if ($uhom eq '') {
1692: $uhom=&homeserver($unamestr,$udom);
1693: }
1694: if ($uhom ne 'no_host') {
1695: $servers{$uhom}.='&'.&escape($id);
1696: }
1697: } else {
1698: my @curritems = split(/,/,$ids{$id});
1699: foreach my $uname (@curritems) {
1700: my $uhom = $uhome;
1701: if ($uhom eq '') {
1702: $uhom=&homeserver($uname,$udom);
1703: }
1704: if ($uhom ne 'no_host') {
1705: $byid{$uhom}{$id} .= $uname.',';
1706: }
1707: }
1708: }
1709: }
1710: if ($namespace eq 'clickers') {
1711: foreach my $server (keys(%byid)) {
1712: if (ref($byid{$server}) eq 'HASH') {
1713: foreach my $id (keys(%{$byid{$server}})) {
1714: $byid{$server}{$id} =~ s/,$//;
1715: $servers{$server}.=&escape($id).'='.&escape($byid{$server}{$id}).'&';
1716: }
1717: }
1718: }
1719: }
1720: foreach my $server (keys(%servers)) {
1721: $servers{$server} =~ s/\&$//;
1722: if ($namespace eq 'ids') {
1723: $result{$server} = &critical('iddel:'.$udom.':'.$servers{$server},$uhome);
1724: } elsif ($namespace eq 'clickers') {
1725: $result{$server} = &critical('updateclickers:'.$udom.':del:'.$servers{$server},$server);
1726: }
1727: }
1728: return %result;
1729: }
1730:
1731: # ----- Update clicker ID-to-username look-ups in clickers.db on library server
1732:
1733: sub updateclickers {
1734: my ($udom,$action,$idshashref,$uhome,$critical) = @_;
1735: my %clickers;
1736: if (ref($idshashref) eq 'HASH') {
1737: %clickers=%{$idshashref};
1738: } else {
1739: return;
1740: }
1741: my $items='';
1742: foreach my $item (keys(%clickers)) {
1743: $items.=&escape($item).'='.&escape($clickers{$item}).'&';
1744: }
1745: $items=~s/\&$//;
1746: my $request = "updateclickers:$udom:$action:$items";
1747: if ($critical) {
1748: return &critical($request,$uhome);
1749: } else {
1750: return &reply($request,$uhome);
1751: }
1752: }
1753:
1754: # ------------------------------dump from db file owned by domainconfig user
1755: sub dump_dom {
1756: my ($namespace, $udom, $regexp) = @_;
1757:
1758: $udom ||= $env{'user.domain'};
1759:
1760: return () unless $udom;
1761:
1762: return &dump($namespace, $udom, &get_domainconfiguser($udom), $regexp);
1763: }
1764:
1765: # ------------------------------------------ get items from domain db files
1766:
1767: sub get_dom {
1768: my ($namespace,$storearr,$udom,$uhome)=@_;
1769: return if ($udom eq 'public');
1770: my $items='';
1771: foreach my $item (@$storearr) {
1772: $items.=&escape($item).'&';
1773: }
1774: $items=~s/\&$//;
1775: if (!$udom) {
1776: $udom=$env{'user.domain'};
1777: return if ($udom eq 'public');
1778: if (defined(&domain($udom,'primary'))) {
1779: $uhome=&domain($udom,'primary');
1780: } else {
1781: undef($uhome);
1782: }
1783: } else {
1784: if (!$uhome) {
1785: if (defined(&domain($udom,'primary'))) {
1786: $uhome=&domain($udom,'primary');
1787: }
1788: }
1789: }
1790: if ($udom && $uhome && ($uhome ne 'no_host')) {
1791: my $rep=&reply("getdom:$udom:$namespace:$items",$uhome);
1792: my %returnhash;
1793: if ($rep eq '' || $rep =~ /^error: 2 /) {
1794: return %returnhash;
1795: }
1796: my @pairs=split(/\&/,$rep);
1797: if ( $#pairs==0 && $pairs[0] =~ /^(con_lost|error|no_such_host)/i) {
1798: return @pairs;
1799: }
1800: my $i=0;
1801: foreach my $item (@$storearr) {
1802: $returnhash{$item}=&thaw_unescape($pairs[$i]);
1803: $i++;
1804: }
1805: return %returnhash;
1806: } else {
1807: &logthis("get_dom failed - no homeserver and/or domain ($udom) ($uhome)");
1808: }
1809: }
1810:
1811: # -------------------------------------------- put items in domain db files
1812:
1813: sub put_dom {
1814: my ($namespace,$storehash,$udom,$uhome)=@_;
1815: if (!$udom) {
1816: $udom=$env{'user.domain'};
1817: if (defined(&domain($udom,'primary'))) {
1818: $uhome=&domain($udom,'primary');
1819: } else {
1820: undef($uhome);
1821: }
1822: } else {
1823: if (!$uhome) {
1824: if (defined(&domain($udom,'primary'))) {
1825: $uhome=&domain($udom,'primary');
1826: }
1827: }
1828: }
1829: if ($udom && $uhome && ($uhome ne 'no_host')) {
1830: my $items='';
1831: foreach my $item (keys(%$storehash)) {
1832: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
1833: }
1834: $items=~s/\&$//;
1835: return &reply("putdom:$udom:$namespace:$items",$uhome);
1836: } else {
1837: &logthis("put_dom failed - no homeserver and/or domain");
1838: }
1839: }
1840:
1841: # --------------------- newput for items in db file owned by domainconfig user
1842: sub newput_dom {
1843: my ($namespace,$storehash,$udom) = @_;
1844: my $result;
1845: if (!$udom) {
1846: $udom=$env{'user.domain'};
1847: }
1848: if ($udom) {
1849: my $uname = &get_domainconfiguser($udom);
1850: $result = &newput($namespace,$storehash,$udom,$uname);
1851: }
1852: return $result;
1853: }
1854:
1855: # --------------------- delete for items in db file owned by domainconfig user
1856: sub del_dom {
1857: my ($namespace,$storearr,$udom)=@_;
1858: if (ref($storearr) eq 'ARRAY') {
1859: if (!$udom) {
1860: $udom=$env{'user.domain'};
1861: }
1862: if ($udom) {
1863: my $uname = &get_domainconfiguser($udom);
1864: return &del($namespace,$storearr,$udom,$uname);
1865: }
1866: }
1867: }
1868:
1869: # ----------------------------------construct domainconfig user for a domain
1870: sub get_domainconfiguser {
1871: my ($udom) = @_;
1872: return $udom.'-domainconfig';
1873: }
1874:
1875: sub retrieve_inst_usertypes {
1876: my ($udom) = @_;
1877: my (%returnhash,@order);
1878: my %domdefs = &Apache::lonnet::get_domain_defaults($udom);
1879: if ((ref($domdefs{'inststatustypes'}) eq 'HASH') &&
1880: (ref($domdefs{'inststatusorder'}) eq 'ARRAY')) {
1881: return ($domdefs{'inststatustypes'},$domdefs{'inststatusorder'});
1882: } else {
1883: if (defined(&domain($udom,'primary'))) {
1884: my $uhome=&domain($udom,'primary');
1885: my $rep=&reply("inst_usertypes:$udom",$uhome);
1886: if ($rep =~ /^(con_lost|error|no_such_host|refused)/) {
1887: &logthis("retrieve_inst_usertypes failed - $rep returned from $uhome in domain: $udom");
1888: return (\%returnhash,\@order);
1889: }
1890: my ($hashitems,$orderitems) = split(/:/,$rep);
1891: my @pairs=split(/\&/,$hashitems);
1892: foreach my $item (@pairs) {
1893: my ($key,$value)=split(/=/,$item,2);
1894: $key = &unescape($key);
1895: next if ($key =~ /^error: 2 /);
1896: $returnhash{$key}=&thaw_unescape($value);
1897: }
1898: my @esc_order = split(/\&/,$orderitems);
1899: foreach my $item (@esc_order) {
1900: push(@order,&unescape($item));
1901: }
1902: } else {
1903: &logthis("retrieve_inst_usertypes failed - no primary domain server for $udom");
1904: }
1905: return (\%returnhash,\@order);
1906: }
1907: }
1908:
1909: sub is_domainimage {
1910: my ($url) = @_;
1911: if ($url=~m-^/+res/+($match_domain)/+\1\-domainconfig/+(img|logo|domlogo)/+[^/]-) {
1912: if (&domain($1) ne '') {
1913: return '1';
1914: }
1915: }
1916: return;
1917: }
1918:
1919: sub inst_directory_query {
1920: my ($srch) = @_;
1921: my $udom = $srch->{'srchdomain'};
1922: my %results;
1923: my $homeserver = &domain($udom,'primary');
1924: my $outcome;
1925: if ($homeserver ne '') {
1926: my $queryid=&reply("querysend:instdirsearch:".
1927: &escape($srch->{'srchby'}).':'.
1928: &escape($srch->{'srchterm'}).':'.
1929: &escape($srch->{'srchtype'}),$homeserver);
1930: my $host=&hostname($homeserver);
1931: if ($queryid !~/^\Q$host\E\_/) {
1932: &logthis('instituional directory search invalid queryid: '.$queryid.' for host: '.$homeserver.'in domain '.$udom);
1933: return;
1934: }
1935: my $response = &get_query_reply($queryid);
1936: my $maxtries = 5;
1937: my $tries = 1;
1938: while (($response=~/^timeout/) && ($tries < $maxtries)) {
1939: $response = &get_query_reply($queryid);
1940: $tries ++;
1941: }
1942:
1943: if (!&error($response) && $response ne 'refused') {
1944: if ($response eq 'unavailable') {
1945: $outcome = $response;
1946: } else {
1947: $outcome = 'ok';
1948: my @matches = split(/\n/,$response);
1949: foreach my $match (@matches) {
1950: my ($key,$value) = split(/=/,$match);
1951: $results{&unescape($key).':'.$udom} = &thaw_unescape($value);
1952: }
1953: }
1954: }
1955: }
1956: return ($outcome,%results);
1957: }
1958:
1959: sub usersearch {
1960: my ($srch) = @_;
1961: my $dom = $srch->{'srchdomain'};
1962: my %results;
1963: my %libserv = &all_library();
1964: my $query = 'usersearch';
1965: foreach my $tryserver (keys(%libserv)) {
1966: if (&host_domain($tryserver) eq $dom) {
1967: my $host=&hostname($tryserver);
1968: my $queryid=
1969: &reply("querysend:".&escape($query).':'.
1970: &escape($srch->{'srchby'}).':'.
1971: &escape($srch->{'srchtype'}).':'.
1972: &escape($srch->{'srchterm'}),$tryserver);
1973: if ($queryid !~/^\Q$host\E\_/) {
1974: &logthis('usersearch: invalid queryid: '.$queryid.' for host: '.$host.'in domain '.$dom.' and server: '.$tryserver);
1975: next;
1976: }
1977: my $reply = &get_query_reply($queryid);
1978: my $maxtries = 1;
1979: my $tries = 1;
1980: while (($reply=~/^timeout/) && ($tries < $maxtries)) {
1981: $reply = &get_query_reply($queryid);
1982: $tries ++;
1983: }
1984: if ( ($reply =~/^timeout/) || ($reply =~/^error/) ) {
1985: &logthis('usersrch error: '.$reply.' for '.$dom.' - searching for : '.$srch->{'srchterm'}.' by '.$srch->{'srchby'}.' ('.$srch->{'srchtype'}.') - maxtries: '.$maxtries.' tries: '.$tries);
1986: } else {
1987: my @matches;
1988: if ($reply =~ /\n/) {
1989: @matches = split(/\n/,$reply);
1990: } else {
1991: @matches = split(/\&/,$reply);
1992: }
1993: foreach my $match (@matches) {
1994: my ($uname,$udom,%userhash);
1995: foreach my $entry (split(/:/,$match)) {
1996: my ($key,$value) =
1997: map {&unescape($_);} split(/=/,$entry);
1998: $userhash{$key} = $value;
1999: if ($key eq 'username') {
2000: $uname = $value;
2001: } elsif ($key eq 'domain') {
2002: $udom = $value;
2003: }
2004: }
2005: $results{$uname.':'.$udom} = \%userhash;
2006: }
2007: }
2008: }
2009: }
2010: return %results;
2011: }
2012:
2013: sub get_instuser {
2014: my ($udom,$uname,$id) = @_;
2015: my $homeserver = &domain($udom,'primary');
2016: my ($outcome,%results);
2017: if ($homeserver ne '') {
2018: my $queryid=&reply("querysend:getinstuser:".&escape($uname).':'.
2019: &escape($id).':'.&escape($udom),$homeserver);
2020: my $host=&hostname($homeserver);
2021: if ($queryid !~/^\Q$host\E\_/) {
2022: &logthis('get_instuser invalid queryid: '.$queryid.' for host: '.$homeserver.'in domain '.$udom);
2023: return;
2024: }
2025: my $response = &get_query_reply($queryid);
2026: my $maxtries = 5;
2027: my $tries = 1;
2028: while (($response=~/^timeout/) && ($tries < $maxtries)) {
2029: $response = &get_query_reply($queryid);
2030: $tries ++;
2031: }
2032: if (!&error($response) && $response ne 'refused') {
2033: if ($response eq 'unavailable') {
2034: $outcome = $response;
2035: } else {
2036: $outcome = 'ok';
2037: my @matches = split(/\n/,$response);
2038: foreach my $match (@matches) {
2039: my ($key,$value) = split(/=/,$match);
2040: $results{&unescape($key)} = &thaw_unescape($value);
2041: }
2042: }
2043: }
2044: }
2045: my %userinfo;
2046: if (ref($results{$uname}) eq 'HASH') {
2047: %userinfo = %{$results{$uname}};
2048: }
2049: return ($outcome,%userinfo);
2050: }
2051:
2052: sub get_multiple_instusers {
2053: my ($udom,$users,$caller) = @_;
2054: my ($outcome,$results);
2055: if (ref($users) eq 'HASH') {
2056: my $count = keys(%{$users});
2057: my $requested = &freeze_escape($users);
2058: my $homeserver = &domain($udom,'primary');
2059: if ($homeserver ne '') {
2060: my $queryid=&reply('querysend:getmultinstusers:::'.$caller.'='.$requested,$homeserver);
2061: my $host=&hostname($homeserver);
2062: if ($queryid !~/^\Q$host\E\_/) {
2063: &logthis('get_multiple_instusers invalid queryid: '.$queryid.
2064: ' for host: '.$homeserver.'in domain '.$udom);
2065: return ($outcome,$results);
2066: }
2067: my $response = &get_query_reply($queryid);
2068: my $maxtries = 5;
2069: if ($count > 100) {
2070: $maxtries = 1+int($count/20);
2071: }
2072: my $tries = 1;
2073: while (($response=~/^timeout/) && ($tries <= $maxtries)) {
2074: $response = &get_query_reply($queryid);
2075: $tries ++;
2076: }
2077: if ($response eq '') {
2078: $results = {};
2079: foreach my $key (keys(%{$users})) {
2080: my ($uname,$id);
2081: if ($caller eq 'id') {
2082: $id = $key;
2083: } else {
2084: $uname = $key;
2085: }
2086: my ($resp,%info) = &get_instuser($udom,$uname,$id);
2087: $outcome = $resp;
2088: if ($resp eq 'ok') {
2089: %{$results} = (%{$results}, %info);
2090: } else {
2091: last;
2092: }
2093: }
2094: } elsif(!&error($response) && ($response ne 'refused')) {
2095: if (($response eq 'unavailable') || ($response eq 'invalid') || ($response eq 'timeout')) {
2096: $outcome = $response;
2097: } else {
2098: ($outcome,my $userdata) = split(/=/,$response,2);
2099: if ($outcome eq 'ok') {
2100: $results = &thaw_unescape($userdata);
2101: }
2102: }
2103: }
2104: }
2105: }
2106: return ($outcome,$results);
2107: }
2108:
2109: sub inst_rulecheck {
2110: my ($udom,$uname,$id,$item,$rules) = @_;
2111: my %returnhash;
2112: if ($udom ne '') {
2113: if (ref($rules) eq 'ARRAY') {
2114: @{$rules} = map {&escape($_);} (@{$rules});
2115: my $rulestr = join(':',@{$rules});
2116: my $homeserver=&domain($udom,'primary');
2117: if (($homeserver ne '') && ($homeserver ne 'no_host')) {
2118: my $response;
2119: if ($item eq 'username') {
2120: $response=&unescape(&reply('instrulecheck:'.&escape($udom).
2121: ':'.&escape($uname).':'.$rulestr,
2122: $homeserver));
2123: } elsif ($item eq 'id') {
2124: $response=&unescape(&reply('instidrulecheck:'.&escape($udom).
2125: ':'.&escape($id).':'.$rulestr,
2126: $homeserver));
2127: } elsif ($item eq 'selfcreate') {
2128: $response=&unescape(&reply('instselfcreatecheck:'.
2129: &escape($udom).':'.&escape($uname).
2130: ':'.$rulestr,$homeserver));
2131: }
2132: if ($response ne 'refused') {
2133: my @pairs=split(/\&/,$response);
2134: foreach my $item (@pairs) {
2135: my ($key,$value)=split(/=/,$item,2);
2136: $key = &unescape($key);
2137: next if ($key =~ /^error: 2 /);
2138: $returnhash{$key}=&thaw_unescape($value);
2139: }
2140: }
2141: }
2142: }
2143: }
2144: return %returnhash;
2145: }
2146:
2147: sub inst_userrules {
2148: my ($udom,$check) = @_;
2149: my (%ruleshash,@ruleorder);
2150: if ($udom ne '') {
2151: my $homeserver=&domain($udom,'primary');
2152: if (($homeserver ne '') && ($homeserver ne 'no_host')) {
2153: my $response;
2154: if ($check eq 'id') {
2155: $response=&reply('instidrules:'.&escape($udom),
2156: $homeserver);
2157: } elsif ($check eq 'email') {
2158: $response=&reply('instemailrules:'.&escape($udom),
2159: $homeserver);
2160: } else {
2161: $response=&reply('instuserrules:'.&escape($udom),
2162: $homeserver);
2163: }
2164: if (($response ne 'refused') && ($response ne 'error') &&
2165: ($response ne 'unknown_cmd') &&
2166: ($response ne 'no_such_host')) {
2167: my ($hashitems,$orderitems) = split(/:/,$response);
2168: my @pairs=split(/\&/,$hashitems);
2169: foreach my $item (@pairs) {
2170: my ($key,$value)=split(/=/,$item,2);
2171: $key = &unescape($key);
2172: next if ($key =~ /^error: 2 /);
2173: $ruleshash{$key}=&thaw_unescape($value);
2174: }
2175: my @esc_order = split(/\&/,$orderitems);
2176: foreach my $item (@esc_order) {
2177: push(@ruleorder,&unescape($item));
2178: }
2179: }
2180: }
2181: }
2182: return (\%ruleshash,\@ruleorder);
2183: }
2184:
2185: # ------------- Get Authentication, Language and User Tools Defaults for Domain
2186:
2187: sub get_domain_defaults {
2188: my ($domain,$ignore_cache) = @_;
2189: return if (($domain eq '') || ($domain eq 'public'));
2190: my $cachetime = 60*60*24;
2191: unless ($ignore_cache) {
2192: my ($result,$cached)=&is_cached_new('domdefaults',$domain);
2193: if (defined($cached)) {
2194: if (ref($result) eq 'HASH') {
2195: return %{$result};
2196: }
2197: }
2198: }
2199: my %domdefaults;
2200: my %domconfig =
2201: &Apache::lonnet::get_dom('configuration',['defaults','quotas',
2202: 'requestcourses','inststatus',
2203: 'coursedefaults','usersessions',
2204: 'requestauthor','selfenrollment',
2205: 'coursecategories'],$domain);
2206: my @coursetypes = ('official','unofficial','community','textbook','placement');
2207: if (ref($domconfig{'defaults'}) eq 'HASH') {
2208: $domdefaults{'lang_def'} = $domconfig{'defaults'}{'lang_def'};
2209: $domdefaults{'auth_def'} = $domconfig{'defaults'}{'auth_def'};
2210: $domdefaults{'auth_arg_def'} = $domconfig{'defaults'}{'auth_arg_def'};
2211: $domdefaults{'timezone_def'} = $domconfig{'defaults'}{'timezone_def'};
2212: $domdefaults{'datelocale_def'} = $domconfig{'defaults'}{'datelocale_def'};
2213: $domdefaults{'portal_def'} = $domconfig{'defaults'}{'portal_def'};
2214: } else {
2215: $domdefaults{'lang_def'} = &domain($domain,'lang_def');
2216: $domdefaults{'auth_def'} = &domain($domain,'auth_def');
2217: $domdefaults{'auth_arg_def'} = &domain($domain,'auth_arg_def');
2218: }
2219: if (ref($domconfig{'quotas'}) eq 'HASH') {
2220: if (ref($domconfig{'quotas'}{'defaultquota'}) eq 'HASH') {
2221: $domdefaults{'defaultquota'} = $domconfig{'quotas'}{'defaultquota'};
2222: } else {
2223: $domdefaults{'defaultquota'} = $domconfig{'quotas'};
2224: }
2225: my @usertools = ('aboutme','blog','webdav','portfolio');
2226: foreach my $item (@usertools) {
2227: if (ref($domconfig{'quotas'}{$item}) eq 'HASH') {
2228: $domdefaults{$item} = $domconfig{'quotas'}{$item};
2229: }
2230: }
2231: if (ref($domconfig{'quotas'}{'authorquota'}) eq 'HASH') {
2232: $domdefaults{'authorquota'} = $domconfig{'quotas'}{'authorquota'};
2233: }
2234: }
2235: if (ref($domconfig{'requestcourses'}) eq 'HASH') {
2236: foreach my $item ('official','unofficial','community','textbook','placement') {
2237: $domdefaults{$item} = $domconfig{'requestcourses'}{$item};
2238: }
2239: }
2240: if (ref($domconfig{'requestauthor'}) eq 'HASH') {
2241: $domdefaults{'requestauthor'} = $domconfig{'requestauthor'};
2242: }
2243: if (ref($domconfig{'inststatus'}) eq 'HASH') {
2244: foreach my $item ('inststatustypes','inststatusorder','inststatusguest') {
2245: $domdefaults{$item} = $domconfig{'inststatus'}{$item};
2246: }
2247: }
2248: if (ref($domconfig{'coursedefaults'}) eq 'HASH') {
2249: $domdefaults{'canuse_pdfforms'} = $domconfig{'coursedefaults'}{'canuse_pdfforms'};
2250: $domdefaults{'usejsme'} = $domconfig{'coursedefaults'}{'usejsme'};
2251: $domdefaults{'uselcmath'} = $domconfig{'coursedefaults'}{'uselcmath'};
2252: if (ref($domconfig{'coursedefaults'}{'postsubmit'}) eq 'HASH') {
2253: $domdefaults{'postsubmit'} = $domconfig{'coursedefaults'}{'postsubmit'}{'client'};
2254: }
2255: foreach my $type (@coursetypes) {
2256: if (ref($domconfig{'coursedefaults'}{'coursecredits'}) eq 'HASH') {
2257: unless ($type eq 'community') {
2258: $domdefaults{$type.'credits'} = $domconfig{'coursedefaults'}{'coursecredits'}{$type};
2259: }
2260: }
2261: if (ref($domconfig{'coursedefaults'}{'uploadquota'}) eq 'HASH') {
2262: $domdefaults{$type.'quota'} = $domconfig{'coursedefaults'}{'uploadquota'}{$type};
2263: }
2264: if ($domdefaults{'postsubmit'} eq 'on') {
2265: if (ref($domconfig{'coursedefaults'}{'postsubmit'}{'timeout'}) eq 'HASH') {
2266: $domdefaults{$type.'postsubtimeout'} =
2267: $domconfig{'coursedefaults'}{'postsubmit'}{'timeout'}{$type};
2268: }
2269: }
2270: }
2271: if (ref($domconfig{'coursedefaults'}{'canclone'}) eq 'HASH') {
2272: if (ref($domconfig{'coursedefaults'}{'canclone'}{'instcode'}) eq 'ARRAY') {
2273: my @clonecodes = @{$domconfig{'coursedefaults'}{'canclone'}{'instcode'}};
2274: if (@clonecodes) {
2275: $domdefaults{'canclone'} = join('+',@clonecodes);
2276: }
2277: }
2278: } elsif ($domconfig{'coursedefaults'}{'canclone'}) {
2279: $domdefaults{'canclone'}=$domconfig{'coursedefaults'}{'canclone'};
2280: }
2281: }
2282: if (ref($domconfig{'usersessions'}) eq 'HASH') {
2283: if (ref($domconfig{'usersessions'}{'remote'}) eq 'HASH') {
2284: $domdefaults{'remotesessions'} = $domconfig{'usersessions'}{'remote'};
2285: }
2286: if (ref($domconfig{'usersessions'}{'hosted'}) eq 'HASH') {
2287: $domdefaults{'hostedsessions'} = $domconfig{'usersessions'}{'hosted'};
2288: }
2289: if (ref($domconfig{'usersessions'}{'offloadnow'}) eq 'HASH') {
2290: $domdefaults{'offloadnow'} = $domconfig{'usersessions'}{'offloadnow'};
2291: }
2292: }
2293: if (ref($domconfig{'selfenrollment'}) eq 'HASH') {
2294: if (ref($domconfig{'selfenrollment'}{'admin'}) eq 'HASH') {
2295: my @settings = ('types','registered','enroll_dates','access_dates','section',
2296: 'approval','limit');
2297: foreach my $type (@coursetypes) {
2298: if (ref($domconfig{'selfenrollment'}{'admin'}{$type}) eq 'HASH') {
2299: my @mgrdc = ();
2300: foreach my $item (@settings) {
2301: if ($domconfig{'selfenrollment'}{'admin'}{$type}{$item} eq '0') {
2302: push(@mgrdc,$item);
2303: }
2304: }
2305: if (@mgrdc) {
2306: $domdefaults{$type.'selfenrolladmdc'} = join(',',@mgrdc);
2307: }
2308: }
2309: }
2310: }
2311: if (ref($domconfig{'selfenrollment'}{'default'}) eq 'HASH') {
2312: foreach my $type (@coursetypes) {
2313: if (ref($domconfig{'selfenrollment'}{'default'}{$type}) eq 'HASH') {
2314: foreach my $item (keys(%{$domconfig{'selfenrollment'}{'default'}{$type}})) {
2315: $domdefaults{$type.'selfenroll'.$item} = $domconfig{'selfenrollment'}{'default'}{$type}{$item};
2316: }
2317: }
2318: }
2319: }
2320: }
2321: if (ref($domconfig{'coursecategories'}) eq 'HASH') {
2322: $domdefaults{'catauth'} = 'std';
2323: $domdefaults{'catunauth'} = 'std';
2324: if ($domconfig{'coursecategories'}{'auth'}) {
2325: $domdefaults{'catauth'} = $domconfig{'coursecategories'}{'auth'};
2326: }
2327: if ($domconfig{'coursecategories'}{'unauth'}) {
2328: $domdefaults{'catunauth'} = $domconfig{'coursecategories'}{'unauth'};
2329: }
2330: }
2331: &do_cache_new('domdefaults',$domain,\%domdefaults,$cachetime);
2332: return %domdefaults;
2333: }
2334:
2335: sub course_portal_url {
2336: my ($cnum,$cdom) = @_;
2337: my $chome = &homeserver($cnum,$cdom);
2338: my $hostname = &hostname($chome);
2339: my $protocol = $protocol{$chome};
2340: $protocol = 'http' if ($protocol ne 'https');
2341: my %domdefaults = &get_domain_defaults($cdom);
2342: my $firsturl;
2343: if ($domdefaults{'portal_def'}) {
2344: $firsturl = $domdefaults{'portal_def'};
2345: } else {
2346: $firsturl = $protocol.'://'.$hostname;
2347: }
2348: return $firsturl;
2349: }
2350:
2351: # --------------------------------------------------- Assign a key to a student
2352:
2353: sub assign_access_key {
2354: #
2355: # a valid key looks like uname:udom#comments
2356: # comments are being appended
2357: #
2358: my ($ckey,$kdom,$knum,$cdom,$cnum,$udom,$uname,$logentry)=@_;
2359: $kdom=
2360: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($kdom));
2361: $knum=
2362: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($knum));
2363: $cdom=
2364: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
2365: $cnum=
2366: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
2367: $udom=$env{'user.name'} unless (defined($udom));
2368: $uname=$env{'user.domain'} unless (defined($uname));
2369: my %existing=&get('accesskeys',[$ckey],$kdom,$knum);
2370: if (($existing{$ckey}=~/^\#(.*)$/) || # - new key
2371: ($existing{$ckey}=~/^\Q$uname\E\:\Q$udom\E\#(.*)$/)) {
2372: # assigned to this person
2373: # - this should not happen,
2374: # unless something went wrong
2375: # the first time around
2376: # ready to assign
2377: $logentry=$1.'; '.$logentry;
2378: if (&put('accesskeys',{$ckey=>$uname.':'.$udom.'#'.$logentry},
2379: $kdom,$knum) eq 'ok') {
2380: # key now belongs to user
2381: my $envkey='key.'.$cdom.'_'.$cnum;
2382: if (&put('environment',{$envkey => $ckey}) eq 'ok') {
2383: &appenv({'environment.'.$envkey => $ckey});
2384: return 'ok';
2385: } else {
2386: return
2387: 'error: Count not permanently assign key, will need to be re-entered later.';
2388: }
2389: } else {
2390: return 'error: Could not assign key, try again later.';
2391: }
2392: } elsif (!$existing{$ckey}) {
2393: # the key does not exist
2394: return 'error: The key does not exist';
2395: } else {
2396: # the key is somebody else's
2397: return 'error: The key is already in use';
2398: }
2399: }
2400:
2401: # ------------------------------------------ put an additional comment on a key
2402:
2403: sub comment_access_key {
2404: #
2405: # a valid key looks like uname:udom#comments
2406: # comments are being appended
2407: #
2408: my ($ckey,$cdom,$cnum,$logentry)=@_;
2409: $cdom=
2410: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
2411: $cnum=
2412: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
2413: my %existing=&get('accesskeys',[$ckey],$cdom,$cnum);
2414: if ($existing{$ckey}) {
2415: $existing{$ckey}.='; '.$logentry;
2416: # ready to assign
2417: if (&put('accesskeys',{$ckey=>$existing{$ckey}},
2418: $cdom,$cnum) eq 'ok') {
2419: return 'ok';
2420: } else {
2421: return 'error: Count not store comment.';
2422: }
2423: } else {
2424: # the key does not exist
2425: return 'error: The key does not exist';
2426: }
2427: }
2428:
2429: # ------------------------------------------------------ Generate a set of keys
2430:
2431: sub generate_access_keys {
2432: my ($number,$cdom,$cnum,$logentry)=@_;
2433: $cdom=
2434: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
2435: $cnum=
2436: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
2437: unless (&allowed('mky',$cdom)) { return 0; }
2438: unless (($cdom) && ($cnum)) { return 0; }
2439: if ($number>10000) { return 0; }
2440: sleep(2); # make sure don't get same seed twice
2441: srand(time()^($$+($$<<15))); # from "Programming Perl"
2442: my $total=0;
2443: for (my $i=1;$i<=$number;$i++) {
2444: my $newkey=sprintf("%lx",int(100000*rand)).'-'.
2445: sprintf("%lx",int(100000*rand)).'-'.
2446: sprintf("%lx",int(100000*rand));
2447: $newkey=~s/1/g/g; # folks mix up 1 and l
2448: $newkey=~s/0/h/g; # and also 0 and O
2449: my %existing=&get('accesskeys',[$newkey],$cdom,$cnum);
2450: if ($existing{$newkey}) {
2451: $i--;
2452: } else {
2453: if (&put('accesskeys',
2454: { $newkey => '# generated '.localtime().
2455: ' by '.$env{'user.name'}.'@'.$env{'user.domain'}.
2456: '; '.$logentry },
2457: $cdom,$cnum) eq 'ok') {
2458: $total++;
2459: }
2460: }
2461: }
2462: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},
2463: 'Generated '.$total.' keys for '.$cnum.' at '.$cdom);
2464: return $total;
2465: }
2466:
2467: # ------------------------------------------------------- Validate an accesskey
2468:
2469: sub validate_access_key {
2470: my ($ckey,$cdom,$cnum,$udom,$uname)=@_;
2471: $cdom=
2472: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
2473: $cnum=
2474: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
2475: $udom=$env{'user.domain'} unless (defined($udom));
2476: $uname=$env{'user.name'} unless (defined($uname));
2477: my %existing=&get('accesskeys',[$ckey],$cdom,$cnum);
2478: return ($existing{$ckey}=~/^\Q$uname\E\:\Q$udom\E\#/);
2479: }
2480:
2481: # ------------------------------------- Find the section of student in a course
2482: sub devalidate_getsection_cache {
2483: my ($udom,$unam,$courseid)=@_;
2484: my $hashid="$udom:$unam:$courseid";
2485: &devalidate_cache_new('getsection',$hashid);
2486: }
2487:
2488: sub courseid_to_courseurl {
2489: my ($courseid) = @_;
2490: #already url style courseid
2491: return $courseid if ($courseid =~ m{^/});
2492:
2493: if (exists($env{'course.'.$courseid.'.num'})) {
2494: my $cnum = $env{'course.'.$courseid.'.num'};
2495: my $cdom = $env{'course.'.$courseid.'.domain'};
2496: return "/$cdom/$cnum";
2497: }
2498:
2499: my %courseinfo=&Apache::lonnet::coursedescription($courseid);
2500: if (exists($courseinfo{'num'})) {
2501: return "/$courseinfo{'domain'}/$courseinfo{'num'}";
2502: }
2503:
2504: return undef;
2505: }
2506:
2507: sub getsection {
2508: my ($udom,$unam,$courseid)=@_;
2509: my $cachetime=1800;
2510:
2511: my $hashid="$udom:$unam:$courseid";
2512: my ($result,$cached)=&is_cached_new('getsection',$hashid);
2513: if (defined($cached)) { return $result; }
2514:
2515: my %Pending;
2516: my %Expired;
2517: #
2518: # Each role can either have not started yet (pending), be active,
2519: # or have expired.
2520: #
2521: # If there is an active role, we are done.
2522: #
2523: # If there is more than one role which has not started yet,
2524: # choose the one which will start sooner
2525: # If there is one role which has not started yet, return it.
2526: #
2527: # If there is more than one expired role, choose the one which ended last.
2528: # If there is a role which has expired, return it.
2529: #
2530: $courseid = &courseid_to_courseurl($courseid);
2531: my %roleshash = &dump('roles',$udom,$unam,$courseid);
2532: foreach my $key (keys(%roleshash)) {
2533: next if ($key !~/^\Q$courseid\E(?:\/)*(\w+)*\_st$/);
2534: my $section=$1;
2535: if ($key eq $courseid.'_st') { $section=''; }
2536: my ($dummy,$end,$start)=split(/\_/,&unescape($roleshash{$key}));
2537: my $now=time;
2538: if (defined($end) && $end && ($now > $end)) {
2539: $Expired{$end}=$section;
2540: next;
2541: }
2542: if (defined($start) && $start && ($now < $start)) {
2543: $Pending{$start}=$section;
2544: next;
2545: }
2546: return &do_cache_new('getsection',$hashid,$section,$cachetime);
2547: }
2548: #
2549: # Presumedly there will be few matching roles from the above
2550: # loop and the sorting time will be negligible.
2551: if (scalar(keys(%Pending))) {
2552: my ($time) = sort {$a <=> $b} keys(%Pending);
2553: return &do_cache_new('getsection',$hashid,$Pending{$time},$cachetime);
2554: }
2555: if (scalar(keys(%Expired))) {
2556: my @sorted = sort {$a <=> $b} keys(%Expired);
2557: my $time = pop(@sorted);
2558: return &do_cache_new('getsection',$hashid,$Expired{$time},$cachetime);
2559: }
2560: return &do_cache_new('getsection',$hashid,'-1',$cachetime);
2561: }
2562:
2563: sub save_cache {
2564: &purge_remembered();
2565: #&Apache::loncommon::validate_page();
2566: undef(%env);
2567: undef($env_loaded);
2568: }
2569:
2570: my $to_remember=-1;
2571: my %remembered;
2572: my %accessed;
2573: my $kicks=0;
2574: my $hits=0;
2575: sub make_key {
2576: my ($name,$id) = @_;
2577: if (length($id) > 65
2578: && length(&escape($id)) > 200) {
2579: $id=length($id).':'.&Digest::MD5::md5_hex($id);
2580: }
2581: return &escape($name.':'.$id);
2582: }
2583:
2584: sub devalidate_cache_new {
2585: my ($name,$id,$debug) = @_;
2586: if ($debug) { &Apache::lonnet::logthis("deleting $name:$id"); }
2587: $id=&make_key($name,$id);
2588: $memcache->delete($id);
2589: delete($remembered{$id});
2590: delete($accessed{$id});
2591: }
2592:
2593: sub is_cached_new {
2594: my ($name,$id,$debug) = @_;
2595: $id=&make_key($name,$id);
2596: if (exists($remembered{$id})) {
2597: if ($debug) { &Apache::lonnet::logthis("Early return $id of $remembered{$id} "); }
2598: $accessed{$id}=[&gettimeofday()];
2599: $hits++;
2600: return ($remembered{$id},1);
2601: }
2602: my $value = $memcache->get($id);
2603: if (!(defined($value))) {
2604: if ($debug) { &Apache::lonnet::logthis("getting $id is not defined"); }
2605: return (undef,undef);
2606: }
2607: if ($value eq '__undef__') {
2608: if ($debug) { &Apache::lonnet::logthis("getting $id is __undef__"); }
2609: $value=undef;
2610: }
2611: &make_room($id,$value,$debug);
2612: if ($debug) { &Apache::lonnet::logthis("getting $id is $value"); }
2613: return ($value,1);
2614: }
2615:
2616: sub do_cache_new {
2617: my ($name,$id,$value,$time,$debug) = @_;
2618: $id=&make_key($name,$id);
2619: my $setvalue=$value;
2620: if (!defined($setvalue)) {
2621: $setvalue='__undef__';
2622: }
2623: if (!defined($time) ) {
2624: $time=600;
2625: }
2626: if ($debug) { &Apache::lonnet::logthis("Setting $id to $value"); }
2627: my $result = $memcache->set($id,$setvalue,$time);
2628: if (! $result) {
2629: &logthis("caching of id -> $id failed");
2630: $memcache->disconnect_all();
2631: }
2632: # need to make a copy of $value
2633: &make_room($id,$value,$debug);
2634: return $value;
2635: }
2636:
2637: sub make_room {
2638: my ($id,$value,$debug)=@_;
2639:
2640: $remembered{$id}= (ref($value)) ? &Storable::dclone($value)
2641: : $value;
2642: if ($to_remember<0) { return; }
2643: $accessed{$id}=[&gettimeofday()];
2644: if (scalar(keys(%remembered)) <= $to_remember) { return; }
2645: my $to_kick;
2646: my $max_time=0;
2647: foreach my $other (keys(%accessed)) {
2648: if (&tv_interval($accessed{$other}) > $max_time) {
2649: $to_kick=$other;
2650: $max_time=&tv_interval($accessed{$other});
2651: }
2652: }
2653: delete($remembered{$to_kick});
2654: delete($accessed{$to_kick});
2655: $kicks++;
2656: if ($debug) { &logthis("kicking $to_kick $max_time $kicks\n"); }
2657: return;
2658: }
2659:
2660: sub purge_remembered {
2661: #&logthis("Tossing ".scalar(keys(%remembered)));
2662: #&logthis(sprintf("%-20s is %s",'%remembered',length(&freeze(\%remembered))));
2663: undef(%remembered);
2664: undef(%accessed);
2665: }
2666: # ------------------------------------- Read an entry from a user's environment
2667:
2668: sub userenvironment {
2669: my ($udom,$unam,@what)=@_;
2670: my $items;
2671: foreach my $item (@what) {
2672: $items.=&escape($item).'&';
2673: }
2674: $items=~s/\&$//;
2675: my %returnhash=();
2676: my $uhome = &homeserver($unam,$udom);
2677: unless ($uhome eq 'no_host') {
2678: my @answer=split(/\&/,
2679: &reply('get:'.$udom.':'.$unam.':environment:'.$items,$uhome));
2680: if ($#answer==0 && $answer[0] =~ /^(con_lost|error:|no_such_host)/i) {
2681: return %returnhash;
2682: }
2683: my $i;
2684: for ($i=0;$i<=$#what;$i++) {
2685: $returnhash{$what[$i]}=&unescape($answer[$i]);
2686: }
2687: }
2688: return %returnhash;
2689: }
2690:
2691: # ---------------------------------------------------------- Get a studentphoto
2692: sub studentphoto {
2693: my ($udom,$unam,$ext) = @_;
2694: my $home=&Apache::lonnet::homeserver($unam,$udom);
2695: if (defined($env{'request.course.id'})) {
2696: if ($env{'course.'.$env{'request.course.id'}.'.internal.showphoto'}) {
2697: if ($udom eq $env{'course.'.$env{'request.course.id'}.'.domain'}) {
2698: return(&retrievestudentphoto($udom,$unam,$ext));
2699: } else {
2700: my ($result,$perm_reqd)=
2701: &Apache::lonnet::auto_photo_permission($unam,$udom);
2702: if ($result eq 'ok') {
2703: if (!($perm_reqd eq 'yes')) {
2704: return(&retrievestudentphoto($udom,$unam,$ext));
2705: }
2706: }
2707: }
2708: }
2709: } else {
2710: my ($result,$perm_reqd) =
2711: &Apache::lonnet::auto_photo_permission($unam,$udom);
2712: if ($result eq 'ok') {
2713: if (!($perm_reqd eq 'yes')) {
2714: return(&retrievestudentphoto($udom,$unam,$ext));
2715: }
2716: }
2717: }
2718: return '/adm/lonKaputt/lonlogo_broken.gif';
2719: }
2720:
2721: sub retrievestudentphoto {
2722: my ($udom,$unam,$ext,$type) = @_;
2723: my $home=&Apache::lonnet::homeserver($unam,$udom);
2724: my $ret=&Apache::lonnet::reply("studentphoto:$udom:$unam:$ext:$type",$home);
2725: if ($ret eq 'ok') {
2726: my $url="/uploaded/$udom/$unam/internal/studentphoto.$ext";
2727: if ($type eq 'thumbnail') {
2728: $url="/uploaded/$udom/$unam/internal/studentphoto_tn.$ext";
2729: }
2730: my $tokenurl=&Apache::lonnet::tokenwrapper($url);
2731: return $tokenurl;
2732: } else {
2733: if ($type eq 'thumbnail') {
2734: return '/adm/lonKaputt/genericstudent_tn.gif';
2735: } else {
2736: return '/adm/lonKaputt/lonlogo_broken.gif';
2737: }
2738: }
2739: }
2740:
2741: # -------------------------------------------------------------------- New chat
2742:
2743: sub chatsend {
2744: my ($newentry,$anon,$group)=@_;
2745: my $cnum=$env{'course.'.$env{'request.course.id'}.'.num'};
2746: my $cdom=$env{'course.'.$env{'request.course.id'}.'.domain'};
2747: my $chome=$env{'course.'.$env{'request.course.id'}.'.home'};
2748: &reply('chatsend:'.$cdom.':'.$cnum.':'.
2749: &escape($env{'user.domain'}.':'.$env{'user.name'}.':'.$anon.':'.
2750: &escape($newentry)).':'.$group,$chome);
2751: }
2752:
2753: # ------------------------------------------ Find current version of a resource
2754:
2755: sub getversion {
2756: my $fname=&clutter(shift);
2757: unless ($fname=~m{^(/adm/wrapper|)/res/}) { return -1; }
2758: return ¤tversion(&filelocation('',$fname));
2759: }
2760:
2761: sub currentversion {
2762: my $fname=shift;
2763: my $author=$fname;
2764: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
2765: my ($udom,$uname)=split(/\//,$author);
2766: my $home=&homeserver($uname,$udom);
2767: if ($home eq 'no_host') {
2768: return -1;
2769: }
2770: my $answer=&reply("currentversion:$fname",$home);
2771: if (($answer eq 'con_lost') || ($answer eq 'rejected')) {
2772: return -1;
2773: }
2774: return $answer;
2775: }
2776:
2777: #
2778: # Return special version number of resource if set by override, empty otherwise
2779: #
2780: sub usedversion {
2781: my $fname=shift;
2782: unless ($fname) { $fname=$env{'request.uri'}; }
2783: my ($urlversion)=($fname=~/\.(\d+)\.\w+$/);
2784: if ($urlversion) { return $urlversion; }
2785: return '';
2786: }
2787:
2788: # ----------------------------- Subscribe to a resource, return URL if possible
2789:
2790: sub subscribe {
2791: my $fname=shift;
2792: if ($fname=~/\/(aboutme|syllabus|bulletinboard|smppg)$/) { return ''; }
2793: $fname=~s/[\n\r]//g;
2794: my $author=$fname;
2795: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
2796: my ($udom,$uname)=split(/\//,$author);
2797: my $home=homeserver($uname,$udom);
2798: if ($home eq 'no_host') {
2799: return 'not_found';
2800: }
2801: my $answer=reply("sub:$fname",$home);
2802: if (($answer eq 'con_lost') || ($answer eq 'rejected')) {
2803: $answer.=' by '.$home;
2804: }
2805: return $answer;
2806: }
2807:
2808: # -------------------------------------------------------------- Replicate file
2809:
2810: sub repcopy {
2811: my $filename=shift;
2812: $filename=~s/\/+/\//g;
2813: my $londocroot = $perlvar{'lonDocRoot'};
2814: if ($filename=~m{^\Q$londocroot/adm/\E}) { return 'ok'; }
2815: if ($filename=~m{^\Q/home/httpd/lonUsers/\E}) { return 'ok'; }
2816: if ($filename=~m{^\Q$londocroot/userfiles/\E} or
2817: $filename=~m{^/*(uploaded|editupload)/}) {
2818: return &repcopy_userfile($filename);
2819: }
2820: $filename=~s/[\n\r]//g;
2821: my $transname="$filename.in.transfer";
2822: # FIXME: this should flock
2823: if ((-e $filename) || (-e $transname)) { return 'ok'; }
2824: my $remoteurl=subscribe($filename);
2825: if ($remoteurl =~ /^con_lost by/) {
2826: &logthis("Subscribe returned $remoteurl: $filename");
2827: return 'unavailable';
2828: } elsif ($remoteurl eq 'not_found') {
2829: #&logthis("Subscribe returned not_found: $filename");
2830: return 'not_found';
2831: } elsif ($remoteurl =~ /^rejected by/) {
2832: &logthis("Subscribe returned $remoteurl: $filename");
2833: return 'forbidden';
2834: } elsif ($remoteurl eq 'directory') {
2835: return 'ok';
2836: } else {
2837: my $author=$filename;
2838: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
2839: my ($udom,$uname)=split(/\//,$author);
2840: my $home=homeserver($uname,$udom);
2841: unless ($home eq $perlvar{'lonHostID'}) {
2842: my @parts=split(/\//,$filename);
2843: my $path="/$parts[1]/$parts[2]/$parts[3]/$parts[4]";
2844: if ($path ne "$londocroot/res") {
2845: &logthis("Malconfiguration for replication: $filename");
2846: return 'bad_request';
2847: }
2848: my $count;
2849: for ($count=5;$count<$#parts;$count++) {
2850: $path.="/$parts[$count]";
2851: if ((-e $path)!=1) {
2852: mkdir($path,0777);
2853: }
2854: }
2855: my $ua=new LWP::UserAgent;
2856: my $request=new HTTP::Request('GET',"$remoteurl");
2857: my $response=$ua->request($request,$transname);
2858: if ($response->is_error()) {
2859: unlink($transname);
2860: my $message=$response->status_line;
2861: &logthis("<font color=\"blue\">WARNING:"
2862: ." LWP get: $message: $filename</font>");
2863: return 'unavailable';
2864: } else {
2865: if ($remoteurl!~/\.meta$/) {
2866: my $mrequest=new HTTP::Request('GET',$remoteurl.'.meta');
2867: my $mresponse=$ua->request($mrequest,$filename.'.meta');
2868: if ($mresponse->is_error()) {
2869: unlink($filename.'.meta');
2870: &logthis(
2871: "<font color=\"yellow\">INFO: No metadata: $filename</font>");
2872: }
2873: }
2874: rename($transname,$filename);
2875: return 'ok';
2876: }
2877: }
2878: }
2879: }
2880:
2881: # ------------------------------------------------ Get server side include body
2882: sub ssi_body {
2883: my ($filelink,%form)=@_;
2884: if (! exists($form{'LONCAPA_INTERNAL_no_discussion'})) {
2885: $form{'LONCAPA_INTERNAL_no_discussion'}='true';
2886: }
2887: my $output='';
2888: my $response;
2889: if ($filelink=~/^https?\:/) {
2890: ($output,$response)=&externalssi($filelink);
2891: } else {
2892: $filelink .= $filelink=~/\?/ ? '&' : '?';
2893: $filelink .= 'inhibitmenu=yes';
2894: ($output,$response)=&ssi($filelink,%form);
2895: }
2896: $output=~s|//(\s*<!--)? BEGIN LON-CAPA Internal.+?// END LON-CAPA Internal\s*(-->)?\s||gs;
2897: $output=~s/^.*?\<body[^\>]*\>//si;
2898: $output=~s/\<\/body\s*\>.*?$//si;
2899: if (wantarray) {
2900: return ($output, $response);
2901: } else {
2902: return $output;
2903: }
2904: }
2905:
2906: # --------------------------------------------------------- Server Side Include
2907:
2908: sub absolute_url {
2909: my ($host_name) = @_;
2910: my $protocol = ($ENV{'SERVER_PORT'} == 443?'https://':'http://');
2911: if ($host_name eq '') {
2912: $host_name = $ENV{'SERVER_NAME'};
2913: }
2914: return $protocol.$host_name;
2915: }
2916:
2917: #
2918: # Server side include.
2919: # Parameters:
2920: # fn Possibly encrypted resource name/id.
2921: # form Hash that describes how the rendering should be done
2922: # and other things.
2923: # Returns:
2924: # Scalar context: The content of the response.
2925: # Array context: 2 element list of the content and the full response object.
2926: #
2927: sub ssi {
2928:
2929: my ($fn,%form)=@_;
2930: my $ua=new LWP::UserAgent;
2931: my $request;
2932:
2933: $form{'no_update_last_known'}=1;
2934: &Apache::lonenc::check_encrypt(\$fn);
2935: if (%form) {
2936: $request=new HTTP::Request('POST',&absolute_url().$fn);
2937: $request->content(join('&',map {
2938: my $name = escape($_);
2939: "$name=" . ( ref($form{$_}) eq 'ARRAY'
2940: ? join("&$name=", map {escape($_) } @{$form{$_}})
2941: : &escape($form{$_}) );
2942: } keys(%form)));
2943: } else {
2944: $request=new HTTP::Request('GET',&absolute_url().$fn);
2945: }
2946:
2947: $request->header(Cookie => $ENV{'HTTP_COOKIE'});
2948: my $response= $ua->request($request);
2949: my $content = $response->content;
2950:
2951:
2952: if (wantarray) {
2953: return ($content, $response);
2954: } else {
2955: return $content;
2956: }
2957: }
2958:
2959: sub externalssi {
2960: my ($url)=@_;
2961: my $ua=new LWP::UserAgent;
2962: my $request=new HTTP::Request('GET',$url);
2963: my $response=$ua->request($request);
2964: if (wantarray) {
2965: return ($response->content, $response);
2966: } else {
2967: return $response->content;
2968: }
2969: }
2970:
2971: # -------------------------------- Allow a /uploaded/ URI to be vouched for
2972:
2973: sub allowuploaded {
2974: my ($srcurl,$url)=@_;
2975: $url=&clutter(&declutter($url));
2976: my $dir=$url;
2977: $dir=~s/\/[^\/]+$//;
2978: my %httpref=();
2979: my $httpurl=&hreflocation('',$url);
2980: $httpref{'httpref.'.$httpurl}=$srcurl;
2981: &Apache::lonnet::appenv(\%httpref);
2982: }
2983:
2984: #
2985: # Determine if the current user should be able to edit a particular resource,
2986: # when viewing in course context.
2987: # (a) When viewing resource used to determine if "Edit" item is included in
2988: # Functions.
2989: # (b) When displaying folder contents in course editor, used to determine if
2990: # "Edit" link will be displayed alongside resource.
2991: #
2992: # input: six args -- filename (decluttered), course number, course domain,
2993: # url, symb (if registered) and group (if this is a group
2994: # item -- e.g., bulletin board, group page etc.).
2995: # output: array of five scalars --
2996: # $cfile -- url for file editing if editable on current server
2997: # $home -- homeserver of resource (i.e., for author if published,
2998: # or course if uploaded.).
2999: # $switchserver -- 1 if server switch will be needed.
3000: # $forceedit -- 1 if icon/link should be to go to edit mode
3001: # $forceview -- 1 if icon/link should be to go to view mode
3002: #
3003:
3004: sub can_edit_resource {
3005: my ($file,$cnum,$cdom,$resurl,$symb,$group) = @_;
3006: my ($cfile,$home,$switchserver,$forceedit,$forceview,$uploaded,$incourse);
3007: #
3008: # For aboutme pages user can only edit his/her own.
3009: #
3010: if ($resurl =~ m{^/?adm/($match_domain)/($match_username)/aboutme$}) {
3011: my ($sdom,$sname) = ($1,$2);
3012: if (($sdom eq $env{'user.domain'}) && ($sname eq $env{'user.name'})) {
3013: $home = $env{'user.home'};
3014: $cfile = $resurl;
3015: if ($env{'form.forceedit'}) {
3016: $forceview = 1;
3017: } else {
3018: $forceedit = 1;
3019: }
3020: return ($cfile,$home,$switchserver,$forceedit,$forceview);
3021: } else {
3022: return;
3023: }
3024: }
3025:
3026: if ($env{'request.course.id'}) {
3027: my $crsedit = &Apache::lonnet::allowed('mdc',$env{'request.course.id'});
3028: if ($group ne '') {
3029: # if this is a group homepage or group bulletin board, check group privs
3030: my $allowed = 0;
3031: if ($resurl =~ m{^/?adm/$cdom/$cnum/$group/smppg$}) {
3032: if ((&allowed('mdg',$env{'request.course.id'}.
3033: ($env{'request.course.sec'}?'/'.$env{'request.course.sec'}:''))) ||
3034: (&allowed('mgh',$env{'request.course.id'}.'/'.$group)) || $crsedit) {
3035: $allowed = 1;
3036: }
3037: } elsif ($resurl =~ m{^/?adm/$cdom/$cnum/\d+/bulletinboard$}) {
3038: if ((&allowed('mdg',$env{'request.course.id'}.($env{'request.course.sec'}?'/'.$env{'request.course.sec'}:''))) ||
3039: (&allowed('cgb',$env{'request.course.id'}.'/'.$group)) || $crsedit) {
3040: $allowed = 1;
3041: }
3042: }
3043: if ($allowed) {
3044: $home=&homeserver($cnum,$cdom);
3045: if ($env{'form.forceedit'}) {
3046: $forceview = 1;
3047: } else {
3048: $forceedit = 1;
3049: }
3050: $cfile = $resurl;
3051: } else {
3052: return;
3053: }
3054: } else {
3055: if ($resurl =~ m{^/?adm/viewclasslist$}) {
3056: unless (&Apache::lonnet::allowed('opa',$env{'request.course.id'})) {
3057: return;
3058: }
3059: } elsif (!$crsedit) {
3060: #
3061: # No edit allowed where CC has switched to student role.
3062: #
3063: return;
3064: }
3065: }
3066: }
3067:
3068: if ($file ne '') {
3069: if (($cnum =~ /$match_courseid/) && ($cdom =~ /$match_domain/)) {
3070: if (&is_course_upload($file,$cnum,$cdom)) {
3071: $uploaded = 1;
3072: $incourse = 1;
3073: if ($file =~/\.(htm|html|css|js|txt)$/) {
3074: $cfile = &hreflocation('',$file);
3075: if ($env{'form.forceedit'}) {
3076: $forceview = 1;
3077: } else {
3078: $forceedit = 1;
3079: }
3080: }
3081: } elsif ($resurl =~ m{^/public/$cdom/$cnum/syllabus}) {
3082: $incourse = 1;
3083: if ($env{'form.forceedit'}) {
3084: $forceview = 1;
3085: } else {
3086: $forceedit = 1;
3087: }
3088: $cfile = $resurl;
3089: } elsif (($resurl ne '') && (&is_on_map($resurl))) {
3090: if ($resurl =~ m{^/adm/$match_domain/$match_username/\d+/smppg|bulletinboard$}) {
3091: $incourse = 1;
3092: if ($env{'form.forceedit'}) {
3093: $forceview = 1;
3094: } else {
3095: $forceedit = 1;
3096: }
3097: $cfile = $resurl;
3098: } elsif ($resurl eq '/res/lib/templates/simpleproblem.problem') {
3099: $incourse = 1;
3100: $cfile = $resurl.'/smpedit';
3101: } elsif ($resurl =~ m{^/adm/wrapper/ext/}) {
3102: $incourse = 1;
3103: if ($env{'form.forceedit'}) {
3104: $forceview = 1;
3105: } else {
3106: $forceedit = 1;
3107: }
3108: $cfile = $resurl;
3109: } elsif ($resurl =~ m{^/adm/wrapper/adm/$cdom/$cnum/\d+/exttools?$}) {
3110: $incourse = 1;
3111: if ($env{'form.forceedit'}) {
3112: $forceview = 1;
3113: } else {
3114: $forceedit = 1;
3115: }
3116: $cfile = $resurl;
3117: } elsif ($resurl =~ m{^/?adm/viewclasslist$}) {
3118: $incourse = 1;
3119: if ($env{'form.forceedit'}) {
3120: $forceview = 1;
3121: } else {
3122: $forceedit = 1;
3123: }
3124: $cfile = ($resurl =~ m{^/} ? $resurl : "/$resurl");
3125: }
3126: } elsif ($resurl eq '/res/lib/templates/simpleproblem.problem/smpedit') {
3127: my $template = '/res/lib/templates/simpleproblem.problem';
3128: if (&is_on_map($template)) {
3129: $incourse = 1;
3130: $forceview = 1;
3131: $cfile = $template;
3132: }
3133: } elsif (($resurl =~ m{^/adm/wrapper/ext/}) && ($env{'form.folderpath'} =~ /^supplemental/)) {
3134: $incourse = 1;
3135: if ($env{'form.forceedit'}) {
3136: $forceview = 1;
3137: } else {
3138: $forceedit = 1;
3139: }
3140: $cfile = $resurl;
3141: } elsif (($resurl =~ m{^/adm/wrapper/adm/$cdom/$cnum/\d+/exttools?$}) && ($env{'form.folderpath'} =~ /^supplemental/)) {
3142: $incourse = 1;
3143: if ($env{'form.forceedit'}) {
3144: $forceview = 1;
3145: } else {
3146: $forceedit = 1;
3147: }
3148: $cfile = $resurl;
3149: } elsif (($resurl eq '/adm/extresedit') && ($symb || $env{'form.folderpath'})) {
3150: $incourse = 1;
3151: $forceview = 1;
3152: if ($symb) {
3153: my ($map,$id,$res)=&decode_symb($symb);
3154: $env{'request.symb'} = $symb;
3155: $cfile = &clutter($res);
3156: } else {
3157: $cfile = $env{'form.suppurl'};
3158: my $escfile = &unescape($cfile);
3159: if ($escfile =~ m{^/adm/$cdom/$cnum/\d+/exttools?$}) {
3160: $cfile = '/adm/wrapper'.$escfile;
3161: } else {
3162: $escfile =~ s{^http://}{};
3163: $cfile = &escape("/adm/wrapper/ext/$escfile");
3164: }
3165: }
3166: } elsif ($resurl =~ m{^/?adm/viewclasslist$}) {
3167: if ($env{'form.forceedit'}) {
3168: $forceview = 1;
3169: } else {
3170: $forceedit = 1;
3171: }
3172: $cfile = ($resurl =~ m{^/} ? $resurl : "/$resurl");
3173: }
3174: }
3175: if ($uploaded || $incourse) {
3176: $home=&homeserver($cnum,$cdom);
3177: } elsif ($file !~ m{/$}) {
3178: $file=~s{^(priv/$match_domain/$match_username)}{/$1};
3179: $file=~s{^($match_domain/$match_username)}{/priv/$1};
3180: # Check that the user has permission to edit this resource
3181: my $setpriv = 1;
3182: my ($cfuname,$cfudom)=&constructaccess($file,$setpriv);
3183: if (defined($cfudom)) {
3184: $home=&homeserver($cfuname,$cfudom);
3185: $cfile=$file;
3186: }
3187: }
3188: if (($cfile ne '') && (!$incourse || $uploaded) &&
3189: (($home ne '') && ($home ne 'no_host'))) {
3190: my @ids=¤t_machine_ids();
3191: unless (grep(/^\Q$home\E$/,@ids)) {
3192: $switchserver=1;
3193: }
3194: }
3195: }
3196: return ($cfile,$home,$switchserver,$forceedit,$forceview);
3197: }
3198:
3199: sub is_course_upload {
3200: my ($file,$cnum,$cdom) = @_;
3201: my $uploadpath = &LONCAPA::propath($cdom,$cnum);
3202: $uploadpath =~ s{^\/}{};
3203: if (($file =~ m{^\Q$uploadpath\E/userfiles/(docs|supplemental)/}) ||
3204: ($file =~ m{^userfiles/\Q$cdom\E/\Q$cnum\E/(docs|supplemental)/})) {
3205: return 1;
3206: }
3207: return;
3208: }
3209:
3210: sub in_course {
3211: my ($udom,$uname,$cdom,$cnum,$type,$hideprivileged) = @_;
3212: if ($hideprivileged) {
3213: my $skipuser;
3214: my %coursehash = &coursedescription($cdom.'_'.$cnum);
3215: my @possdoms = ($cdom);
3216: if ($coursehash{'checkforpriv'}) {
3217: push(@possdoms,split(/,/,$coursehash{'checkforpriv'}));
3218: }
3219: if (&privileged($uname,$udom,\@possdoms)) {
3220: $skipuser = 1;
3221: if ($coursehash{'nothideprivileged'}) {
3222: foreach my $item (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
3223: my $user;
3224: if ($item =~ /:/) {
3225: $user = $item;
3226: } else {
3227: $user = join(':',split(/[\@]/,$item));
3228: }
3229: if ($user eq $uname.':'.$udom) {
3230: undef($skipuser);
3231: last;
3232: }
3233: }
3234: }
3235: if ($skipuser) {
3236: return 0;
3237: }
3238: }
3239: }
3240: $type ||= 'any';
3241: if (!defined($cdom) || !defined($cnum)) {
3242: my $cid = $env{'request.course.id'};
3243: $cdom = $env{'course.'.$cid.'.domain'};
3244: $cnum = $env{'course.'.$cid.'.num'};
3245: }
3246: my $typesref;
3247: if (($type eq 'any') || ($type eq 'all')) {
3248: $typesref = ['active','previous','future'];
3249: } elsif ($type eq 'previous' || $type eq 'future') {
3250: $typesref = [$type];
3251: }
3252: my %roles = &get_my_roles($uname,$udom,'userroles',
3253: $typesref,undef,[$cdom]);
3254: my ($tmp) = keys(%roles);
3255: return 0 if ($tmp =~ /^(con_lost|error|no_such_host)/i);
3256: my @course_roles = grep(/^\Q$cnum\E:\Q$cdom\E:/, keys(%roles));
3257: if (@course_roles > 0) {
3258: return 1;
3259: }
3260: return 0;
3261: }
3262:
3263: # --------- File operations in /home/httpd/html/userfiles/$domain/1/2/3/$course
3264: # input: action, courseID, current domain, intended
3265: # path to file, source of file, instruction to parse file for objects,
3266: # ref to hash for embedded objects,
3267: # ref to hash for codebase of java objects.
3268: # reference to scalar to accommodate mime type determined
3269: # from File::MMagic if $parser = parse.
3270: #
3271: # output: url to file (if action was uploaddoc),
3272: # ok if successful, or diagnostic message otherwise (if action was propagate or copy)
3273: #
3274: # Allows directory structure to be used within lonUsers/../userfiles/ for a
3275: # course.
3276: #
3277: # action = propagate - /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
3278: # will be copied to /home/httpd/lonUsers/1/2/3/$course/userfiles in
3279: # course's home server.
3280: #
3281: # action = copy - /home/httpd/html/userfiles/$domain/1/2/3/$course/$file will
3282: # be copied from $source (current location) to
3283: # /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
3284: # and will then be copied to
3285: # /home/httpd/lonUsers/$domain/1/2/3/$course/userfiles/$file in
3286: # course's home server.
3287: #
3288: # action = uploaddoc - /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
3289: # will be retrived from $env{form.uploaddoc} (from DOCS interface) to
3290: # /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
3291: # and will then be copied to /home/httpd/lonUsers/1/2/3/$course/userfiles/$file
3292: # in course's home server.
3293: #
3294:
3295: sub process_coursefile {
3296: my ($action,$docuname,$docudom,$file,$source,$parser,$allfiles,$codebase,
3297: $mimetype)=@_;
3298: my $fetchresult;
3299: my $home=&homeserver($docuname,$docudom);
3300: if ($action eq 'propagate') {
3301: $fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
3302: $home);
3303: } else {
3304: my $fpath = '';
3305: my $fname = $file;
3306: ($fpath,$fname) = ($file =~ m|^(.*)/([^/]+)$|);
3307: $fpath=$docudom.'/'.$docuname.'/'.$fpath;
3308: my $filepath = &build_filepath($fpath);
3309: if ($action eq 'copy') {
3310: if ($source eq '') {
3311: $fetchresult = 'no source file';
3312: return $fetchresult;
3313: } else {
3314: my $destination = $filepath.'/'.$fname;
3315: rename($source,$destination);
3316: $fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
3317: $home);
3318: }
3319: } elsif ($action eq 'uploaddoc') {
3320: open(my $fh,'>'.$filepath.'/'.$fname);
3321: print $fh $env{'form.'.$source};
3322: close($fh);
3323: if ($parser eq 'parse') {
3324: my $mm = new File::MMagic;
3325: my $type = $mm->checktype_filename($filepath.'/'.$fname);
3326: if ($type eq 'text/html') {
3327: my $parse_result = &extract_embedded_items($filepath.'/'.$fname,$allfiles,$codebase);
3328: unless ($parse_result eq 'ok') {
3329: &logthis('Failed to parse '.$filepath.'/'.$fname.' for embedded media: '.$parse_result);
3330: }
3331: }
3332: if (ref($mimetype)) {
3333: $$mimetype = $type;
3334: }
3335: }
3336: $fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
3337: $home);
3338: if ($fetchresult eq 'ok') {
3339: return '/uploaded/'.$fpath.'/'.$fname;
3340: } else {
3341: &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$file.
3342: ' to host '.$home.': '.$fetchresult);
3343: return '/adm/notfound.html';
3344: }
3345: }
3346: }
3347: unless ( $fetchresult eq 'ok') {
3348: &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$file.
3349: ' to host '.$home.': '.$fetchresult);
3350: }
3351: return $fetchresult;
3352: }
3353:
3354: sub build_filepath {
3355: my ($fpath) = @_;
3356: my $filepath=$perlvar{'lonDocRoot'}.'/userfiles';
3357: unless ($fpath eq '') {
3358: my @parts=split('/',$fpath);
3359: foreach my $part (@parts) {
3360: $filepath.= '/'.$part;
3361: if ((-e $filepath)!=1) {
3362: mkdir($filepath,0777);
3363: }
3364: }
3365: }
3366: return $filepath;
3367: }
3368:
3369: sub store_edited_file {
3370: my ($primary_url,$content,$docudom,$docuname,$fetchresult) = @_;
3371: my $file = $primary_url;
3372: $file =~ s#^/uploaded/$docudom/$docuname/##;
3373: my $fpath = '';
3374: my $fname = $file;
3375: ($fpath,$fname) = ($file =~ m|^(.*)/([^/]+)$|);
3376: $fpath=$docudom.'/'.$docuname.'/'.$fpath;
3377: my $filepath = &build_filepath($fpath);
3378: open(my $fh,'>'.$filepath.'/'.$fname);
3379: print $fh $content;
3380: close($fh);
3381: my $home=&homeserver($docuname,$docudom);
3382: $$fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
3383: $home);
3384: if ($$fetchresult eq 'ok') {
3385: return '/uploaded/'.$fpath.'/'.$fname;
3386: } else {
3387: &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$file.
3388: ' to host '.$home.': '.$$fetchresult);
3389: return '/adm/notfound.html';
3390: }
3391: }
3392:
3393: sub clean_filename {
3394: my ($fname,$args)=@_;
3395: # Replace Windows backslashes by forward slashes
3396: $fname=~s/\\/\//g;
3397: if (!$args->{'keep_path'}) {
3398: # Get rid of everything but the actual filename
3399: $fname=~s/^.*\/([^\/]+)$/$1/;
3400: }
3401: # Replace spaces by underscores
3402: $fname=~s/\s+/\_/g;
3403: # Replace all other weird characters by nothing
3404: $fname=~s{[^/\w\.\-]}{}g;
3405: # Replace all .\d. sequences with _\d. so they no longer look like version
3406: # numbers
3407: $fname=~s/\.(\d+)(?=\.)/_$1/g;
3408: return $fname;
3409: }
3410: # This Function checks if an Image's dimensions exceed either $resizewidth (width)
3411: # or $resizeheight (height) - both pixels. If so, the image is scaled to produce an
3412: # image with the same aspect ratio as the original, but with dimensions which do
3413: # not exceed $resizewidth and $resizeheight.
3414:
3415: sub resizeImage {
3416: my ($img_path,$resizewidth,$resizeheight) = @_;
3417: my $ima = Image::Magick->new;
3418: my $resized;
3419: if (-e $img_path) {
3420: $ima->Read($img_path);
3421: if (($resizewidth =~ /^\d+$/) && ($resizeheight > 0)) {
3422: my $width = $ima->Get('width');
3423: my $height = $ima->Get('height');
3424: if ($width > $resizewidth) {
3425: my $factor = $width/$resizewidth;
3426: my $newheight = $height/$factor;
3427: $ima->Scale(width=>$resizewidth,height=>$newheight);
3428: $resized = 1;
3429: }
3430: }
3431: if (($resizeheight =~ /^\d+$/) && ($resizeheight > 0)) {
3432: my $width = $ima->Get('width');
3433: my $height = $ima->Get('height');
3434: if ($height > $resizeheight) {
3435: my $factor = $height/$resizeheight;
3436: my $newwidth = $width/$factor;
3437: $ima->Scale(width=>$newwidth,height=>$resizeheight);
3438: $resized = 1;
3439: }
3440: }
3441: if ($resized) {
3442: $ima->Write($img_path);
3443: }
3444: }
3445: return;
3446: }
3447:
3448: # --------------- Take an uploaded file and put it into the userfiles directory
3449: # input: $formname - the contents of the file are in $env{"form.$formname"}
3450: # the desired filename is in $env{"form.$formname.filename"}
3451: # $context - possible values: coursedoc, existingfile, overwrite,
3452: # canceloverwrite, or ''.
3453: # if 'coursedoc': upload to the current course
3454: # if 'existingfile': write file to tmp/overwrites directory
3455: # if 'canceloverwrite': delete file written to tmp/overwrites directory
3456: # $context is passed as argument to &finishuserfileupload
3457: # $subdir - directory in userfile to store the file into
3458: # $parser - instruction to parse file for objects ($parser = parse)
3459: # $allfiles - reference to hash for embedded objects
3460: # $codebase - reference to hash for codebase of java objects
3461: # $desuname - username for permanent storage of uploaded file
3462: # $dsetudom - domain for permanaent storage of uploaded file
3463: # $thumbwidth - width (pixels) of thumbnail to make for uploaded image
3464: # $thumbheight - height (pixels) of thumbnail to make for uploaded image
3465: # $resizewidth - width (pixels) to which to resize uploaded image
3466: # $resizeheight - height (pixels) to which to resize uploaded image
3467: # $mimetype - reference to scalar to accommodate mime type determined
3468: # from File::MMagic.
3469: #
3470: # output: url of file in userspace, or error: <message>
3471: # or /adm/notfound.html if failure to upload occurse
3472:
3473: sub userfileupload {
3474: my ($formname,$context,$subdir,$parser,$allfiles,$codebase,$destuname,
3475: $destudom,$thumbwidth,$thumbheight,$resizewidth,$resizeheight,$mimetype)=@_;
3476: if (!defined($subdir)) { $subdir='unknown'; }
3477: my $fname=$env{'form.'.$formname.'.filename'};
3478: $fname=&clean_filename($fname);
3479: # See if there is anything left
3480: unless ($fname) { return 'error: no uploaded file'; }
3481: # Files uploaded to help request form, or uploaded to "create course" page are handled differently
3482: if ((($formname eq 'screenshot') && ($subdir eq 'helprequests')) ||
3483: (($formname eq 'coursecreatorxml') && ($subdir eq 'batchupload')) ||
3484: ($context eq 'existingfile') || ($context eq 'canceloverwrite')) {
3485: my $now = time;
3486: my $filepath;
3487: if (($formname eq 'screenshot') && ($subdir eq 'helprequests')) {
3488: $filepath = 'tmp/helprequests/'.$now;
3489: } elsif (($formname eq 'coursecreatorxml') && ($subdir eq 'batchupload')) {
3490: $filepath = 'tmp/addcourse/'.$destudom.'/web/'.$env{'user.name'}.
3491: '_'.$env{'user.domain'}.'/pending';
3492: } elsif (($context eq 'existingfile') || ($context eq 'canceloverwrite')) {
3493: my ($docuname,$docudom);
3494: if ($destudom) {
3495: $docudom = $destudom;
3496: } else {
3497: $docudom = $env{'user.domain'};
3498: }
3499: if ($destuname) {
3500: $docuname = $destuname;
3501: } else {
3502: $docuname = $env{'user.name'};
3503: }
3504: if (exists($env{'form.group'})) {
3505: $docuname=$env{'course.'.$env{'request.course.id'}.'.num'};
3506: $docudom=$env{'course.'.$env{'request.course.id'}.'.domain'};
3507: }
3508: $filepath = 'tmp/overwrites/'.$docudom.'/'.$docuname.'/'.$subdir;
3509: if ($context eq 'canceloverwrite') {
3510: my $tempfile = $perlvar{'lonDaemons'}.'/'.$filepath.'/'.$fname;
3511: if (-e $tempfile) {
3512: my @info = stat($tempfile);
3513: if ($info[9] eq $env{'form.timestamp'}) {
3514: unlink($tempfile);
3515: }
3516: }
3517: return;
3518: }
3519: }
3520: # Create the directory if not present
3521: my @parts=split(/\//,$filepath);
3522: my $fullpath = $perlvar{'lonDaemons'};
3523: for (my $i=0;$i<@parts;$i++) {
3524: $fullpath .= '/'.$parts[$i];
3525: if ((-e $fullpath)!=1) {
3526: mkdir($fullpath,0777);
3527: }
3528: }
3529: open(my $fh,'>'.$fullpath.'/'.$fname);
3530: print $fh $env{'form.'.$formname};
3531: close($fh);
3532: if ($context eq 'existingfile') {
3533: my @info = stat($fullpath.'/'.$fname);
3534: return ($fullpath.'/'.$fname,$info[9]);
3535: } else {
3536: return $fullpath.'/'.$fname;
3537: }
3538: }
3539: if ($subdir eq 'scantron') {
3540: $fname = 'scantron_orig_'.$fname;
3541: } else {
3542: $fname="$subdir/$fname";
3543: }
3544: if ($context eq 'coursedoc') {
3545: my $docuname=$env{'course.'.$env{'request.course.id'}.'.num'};
3546: my $docudom=$env{'course.'.$env{'request.course.id'}.'.domain'};
3547: if ($env{'form.folder'} =~ m/^(default|supplemental)/) {
3548: return &finishuserfileupload($docuname,$docudom,
3549: $formname,$fname,$parser,$allfiles,
3550: $codebase,$thumbwidth,$thumbheight,
3551: $resizewidth,$resizeheight,$context,$mimetype);
3552: } else {
3553: if ($env{'form.folder'}) {
3554: $fname=$env{'form.folder'}.'/'.$fname;
3555: }
3556: return &process_coursefile('uploaddoc',$docuname,$docudom,
3557: $fname,$formname,$parser,
3558: $allfiles,$codebase,$mimetype);
3559: }
3560: } elsif (defined($destuname)) {
3561: my $docuname=$destuname;
3562: my $docudom=$destudom;
3563: return &finishuserfileupload($docuname,$docudom,$formname,$fname,
3564: $parser,$allfiles,$codebase,
3565: $thumbwidth,$thumbheight,
3566: $resizewidth,$resizeheight,$context,$mimetype);
3567: } else {
3568: my $docuname=$env{'user.name'};
3569: my $docudom=$env{'user.domain'};
3570: if ((exists($env{'form.group'})) || ($context eq 'syllabus')) {
3571: $docuname=$env{'course.'.$env{'request.course.id'}.'.num'};
3572: $docudom=$env{'course.'.$env{'request.course.id'}.'.domain'};
3573: }
3574: return &finishuserfileupload($docuname,$docudom,$formname,$fname,
3575: $parser,$allfiles,$codebase,
3576: $thumbwidth,$thumbheight,
3577: $resizewidth,$resizeheight,$context,$mimetype);
3578: }
3579: }
3580:
3581: sub finishuserfileupload {
3582: my ($docuname,$docudom,$formname,$fname,$parser,$allfiles,$codebase,
3583: $thumbwidth,$thumbheight,$resizewidth,$resizeheight,$context,$mimetype) = @_;
3584: my $path=$docudom.'/'.$docuname.'/';
3585: my $filepath=$perlvar{'lonDocRoot'};
3586:
3587: my ($fnamepath,$file,$fetchthumb);
3588: $file=$fname;
3589: if ($fname=~m|/|) {
3590: ($fnamepath,$file) = ($fname =~ m|^(.*)/([^/]+)$|);
3591: $path.=$fnamepath.'/';
3592: }
3593: my @parts=split(/\//,$filepath.'/userfiles/'.$path);
3594: my $count;
3595: for ($count=4;$count<=$#parts;$count++) {
3596: $filepath.="/$parts[$count]";
3597: if ((-e $filepath)!=1) {
3598: mkdir($filepath,0777);
3599: }
3600: }
3601:
3602: # Save the file
3603: {
3604: if (!open(FH,'>'.$filepath.'/'.$file)) {
3605: &logthis('Failed to create '.$filepath.'/'.$file);
3606: print STDERR ('Failed to create '.$filepath.'/'.$file."\n");
3607: return '/adm/notfound.html';
3608: }
3609: if ($context eq 'overwrite') {
3610: my $source = LONCAPA::tempdir().'/overwrites/'.$docudom.'/'.$docuname.'/'.$fname;
3611: my $target = $filepath.'/'.$file;
3612: if (-e $source) {
3613: my @info = stat($source);
3614: if ($info[9] eq $env{'form.timestamp'}) {
3615: unless (&File::Copy::move($source,$target)) {
3616: &logthis('Failed to overwrite '.$filepath.'/'.$file);
3617: return "Moving from $source failed";
3618: }
3619: } else {
3620: return "Temporary file: $source had unexpected date/time for last modification";
3621: }
3622: } else {
3623: return "Temporary file: $source missing";
3624: }
3625: } elsif (!print FH ($env{'form.'.$formname})) {
3626: &logthis('Failed to write to '.$filepath.'/'.$file);
3627: print STDERR ('Failed to write to '.$filepath.'/'.$file."\n");
3628: return '/adm/notfound.html';
3629: }
3630: close(FH);
3631: if ($resizewidth && $resizeheight) {
3632: my $mm = new File::MMagic;
3633: my $mime_type = $mm->checktype_filename($filepath.'/'.$file);
3634: if ($mime_type =~ m{^image/}) {
3635: &resizeImage($filepath.'/'.$file,$resizewidth,$resizeheight);
3636: }
3637: }
3638: }
3639: if (($context eq 'coursedoc') || ($parser eq 'parse')) {
3640: if (ref($mimetype)) {
3641: if ($$mimetype eq '') {
3642: my $mm = new File::MMagic;
3643: my $type = $mm->checktype_filename($filepath.'/'.$file);
3644: $$mimetype = $type;
3645: }
3646: }
3647: }
3648: if ($parser eq 'parse') {
3649: if ((ref($mimetype)) && ($$mimetype eq 'text/html')) {
3650: my $parse_result = &extract_embedded_items($filepath.'/'.$file,
3651: $allfiles,$codebase);
3652: unless ($parse_result eq 'ok') {
3653: &logthis('Failed to parse '.$filepath.$file.
3654: ' for embedded media: '.$parse_result);
3655: }
3656: }
3657: }
3658: if (($thumbwidth =~ /^\d+$/) && ($thumbheight =~ /^\d+$/)) {
3659: my $input = $filepath.'/'.$file;
3660: my $output = $filepath.'/'.'tn-'.$file;
3661: my $thumbsize = $thumbwidth.'x'.$thumbheight;
3662: system("convert -sample $thumbsize $input $output");
3663: if (-e $filepath.'/'.'tn-'.$file) {
3664: $fetchthumb = 1;
3665: }
3666: }
3667:
3668: # Notify homeserver to grep it
3669: #
3670: my $docuhome=&homeserver($docuname,$docudom);
3671: my $fetchresult= &reply('fetchuserfile:'.$path.$file,$docuhome);
3672: if ($fetchresult eq 'ok') {
3673: if ($fetchthumb) {
3674: my $thumbresult= &reply('fetchuserfile:'.$path.'tn-'.$file,$docuhome);
3675: if ($thumbresult ne 'ok') {
3676: &logthis('Failed to transfer '.$path.'tn-'.$file.' to host '.
3677: $docuhome.': '.$thumbresult);
3678: }
3679: }
3680: #
3681: # Return the URL to it
3682: return '/uploaded/'.$path.$file;
3683: } else {
3684: &logthis('Failed to transfer '.$path.$file.' to host '.$docuhome.
3685: ': '.$fetchresult);
3686: return '/adm/notfound.html';
3687: }
3688: }
3689:
3690: sub extract_embedded_items {
3691: my ($fullpath,$allfiles,$codebase,$content) = @_;
3692: my @state = ();
3693: my (%lastids,%related,%shockwave,%flashvars);
3694: my %javafiles = (
3695: codebase => '',
3696: code => '',
3697: archive => ''
3698: );
3699: my %mediafiles = (
3700: src => '',
3701: movie => '',
3702: );
3703: my $p;
3704: if ($content) {
3705: $p = HTML::LCParser->new($content);
3706: } else {
3707: $p = HTML::LCParser->new($fullpath);
3708: }
3709: while (my $t=$p->get_token()) {
3710: if ($t->[0] eq 'S') {
3711: my ($tagname, $attr) = ($t->[1],$t->[2]);
3712: push(@state, $tagname);
3713: if (lc($tagname) eq 'allow') {
3714: &add_filetype($allfiles,$attr->{'src'},'src');
3715: }
3716: if (lc($tagname) eq 'img') {
3717: &add_filetype($allfiles,$attr->{'src'},'src');
3718: }
3719: if (lc($tagname) eq 'a') {
3720: unless (($attr->{'href'} =~ /^#/) || ($attr->{'href'} eq '')) {
3721: &add_filetype($allfiles,$attr->{'href'},'href');
3722: }
3723: }
3724: if (lc($tagname) eq 'script') {
3725: my $src;
3726: if ($attr->{'archive'} =~ /\.jar$/i) {
3727: &add_filetype($allfiles,$attr->{'archive'},'archive');
3728: } else {
3729: if ($attr->{'src'} ne '') {
3730: $src = $attr->{'src'};
3731: &add_filetype($allfiles,$src,'src');
3732: }
3733: }
3734: my $text = $p->get_trimmed_text();
3735: if ($text =~ /\Qswfobject.registerObject(\E([^\)]+)\)/) {
3736: my @swfargs = split(/,/,$1);
3737: foreach my $item (@swfargs) {
3738: $item =~ s/["']//g;
3739: $item =~ s/^\s+//;
3740: $item =~ s/\s+$//;
3741: }
3742: if (($swfargs[0] ne'') && ($swfargs[2] ne '')) {
3743: if (ref($related{$swfargs[0]}) eq 'ARRAY') {
3744: push(@{$related{$swfargs[0]}},$swfargs[2]);
3745: } else {
3746: $related{$swfargs[0]} = [$swfargs[2]];
3747: }
3748: }
3749: }
3750: }
3751: if (lc($tagname) eq 'link') {
3752: if (lc($attr->{'rel'}) eq 'stylesheet') {
3753: &add_filetype($allfiles,$attr->{'href'},'href');
3754: }
3755: }
3756: if (lc($tagname) eq 'object' ||
3757: (lc($tagname) eq 'embed' && lc($state[-2]) ne 'object')) {
3758: foreach my $item (keys(%javafiles)) {
3759: $javafiles{$item} = '';
3760: }
3761: if ((lc($tagname) eq 'object') && (lc($state[-2]) ne 'object')) {
3762: $lastids{lc($tagname)} = $attr->{'id'};
3763: }
3764: }
3765: if (lc($state[-2]) eq 'object' && lc($tagname) eq 'param') {
3766: my $name = lc($attr->{'name'});
3767: foreach my $item (keys(%javafiles)) {
3768: if ($name eq $item) {
3769: $javafiles{$item} = $attr->{'value'};
3770: last;
3771: }
3772: }
3773: my $pathfrom;
3774: foreach my $item (keys(%mediafiles)) {
3775: if ($name eq $item) {
3776: $pathfrom = $attr->{'value'};
3777: $shockwave{$lastids{lc($state[-2])}} = $pathfrom;
3778: &add_filetype($allfiles,$pathfrom,$name);
3779: last;
3780: }
3781: }
3782: if ($name eq 'flashvars') {
3783: $flashvars{$lastids{lc($state[-2])}} = $attr->{'value'};
3784: }
3785: if ($pathfrom ne '') {
3786: &embedded_dependency($allfiles,\%related,$lastids{lc($state[-2])},
3787: $pathfrom);
3788: }
3789: }
3790: if (lc($tagname) eq 'embed' || lc($tagname) eq 'applet') {
3791: foreach my $item (keys(%javafiles)) {
3792: if ($attr->{$item}) {
3793: $javafiles{$item} = $attr->{$item};
3794: last;
3795: }
3796: }
3797: foreach my $item (keys(%mediafiles)) {
3798: if ($attr->{$item}) {
3799: &add_filetype($allfiles,$attr->{$item},$item);
3800: last;
3801: }
3802: }
3803: if (lc($tagname) eq 'embed') {
3804: if (($attr->{'name'} ne '') && ($attr->{'src'} ne '')) {
3805: &embedded_dependency($allfiles,\%related,$attr->{'name'},
3806: $attr->{'src'});
3807: }
3808: }
3809: }
3810: if (lc($tagname) eq 'iframe') {
3811: my $src = $attr->{'src'} ;
3812: if (($src ne '') && ($src !~ m{^(/|https?://)})) {
3813: &add_filetype($allfiles,$src,'src');
3814: } elsif ($src =~ m{^/}) {
3815: if ($env{'request.course.id'}) {
3816: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
3817: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
3818: my $url = &hreflocation('',$fullpath);
3819: if ($url =~ m{^/uploaded/$cdom/$cnum/docs/(\w+/\d+)/}) {
3820: my $relpath = $1;
3821: if ($src =~ m{^/uploaded/$cdom/$cnum/docs/\Q$relpath\E/(.+)$}) {
3822: &add_filetype($allfiles,$1,'src');
3823: }
3824: }
3825: }
3826: }
3827: }
3828: if ($t->[4] =~ m{/>$}) {
3829: pop(@state);
3830: }
3831: } elsif ($t->[0] eq 'E') {
3832: my ($tagname) = ($t->[1]);
3833: if ($javafiles{'codebase'} ne '') {
3834: $javafiles{'codebase'} .= '/';
3835: }
3836: if (lc($tagname) eq 'applet' ||
3837: lc($tagname) eq 'object' ||
3838: (lc($tagname) eq 'embed' && lc($state[-2]) ne 'object')
3839: ) {
3840: foreach my $item (keys(%javafiles)) {
3841: if ($item ne 'codebase' && $javafiles{$item} ne '') {
3842: my $file=$javafiles{'codebase'}.$javafiles{$item};
3843: &add_filetype($allfiles,$file,$item);
3844: }
3845: }
3846: }
3847: pop @state;
3848: }
3849: }
3850: foreach my $id (sort(keys(%flashvars))) {
3851: if ($shockwave{$id} ne '') {
3852: my @pairs = split(/\&/,$flashvars{$id});
3853: foreach my $pair (@pairs) {
3854: my ($key,$value) = split(/\=/,$pair);
3855: if ($key eq 'thumb') {
3856: &add_filetype($allfiles,$value,$key);
3857: } elsif ($key eq 'content') {
3858: my ($path) = ($shockwave{$id} =~ m{^(.+/)[^/]+$});
3859: my ($ext) = ($value =~ /\.([^.]+)$/);
3860: if ($ext ne '') {
3861: &add_filetype($allfiles,$path.$value,$ext);
3862: }
3863: }
3864: }
3865: }
3866: }
3867: return 'ok';
3868: }
3869:
3870: sub add_filetype {
3871: my ($allfiles,$file,$type)=@_;
3872: if (exists($allfiles->{$file})) {
3873: unless (grep/^\Q$type\E$/, @{$allfiles->{$file}}) {
3874: push(@{$allfiles->{$file}}, &escape($type));
3875: }
3876: } else {
3877: @{$allfiles->{$file}} = (&escape($type));
3878: }
3879: }
3880:
3881: sub embedded_dependency {
3882: my ($allfiles,$related,$identifier,$pathfrom) = @_;
3883: if ((ref($allfiles) eq 'HASH') && (ref($related) eq 'HASH')) {
3884: if (($identifier ne '') &&
3885: (ref($related->{$identifier}) eq 'ARRAY') &&
3886: ($pathfrom ne '')) {
3887: my ($path) = ($pathfrom =~ m{^(.+/)[^/]+$});
3888: foreach my $dep (@{$related->{$identifier}}) {
3889: &add_filetype($allfiles,$path.$dep,'object');
3890: }
3891: }
3892: }
3893: return;
3894: }
3895:
3896: sub removeuploadedurl {
3897: my ($url)=@_;
3898: my (undef,undef,$udom,$uname,$fname)=split('/',$url,5);
3899: return &removeuserfile($uname,$udom,$fname);
3900: }
3901:
3902: sub removeuserfile {
3903: my ($docuname,$docudom,$fname)=@_;
3904: my $home=&homeserver($docuname,$docudom);
3905: my $result = &reply("removeuserfile:$docudom/$docuname/$fname",$home);
3906: if ($result eq 'ok') {
3907: if (($fname !~ /\.meta$/) && (&is_portfolio_file($fname))) {
3908: my $metafile = $fname.'.meta';
3909: my $metaresult = &removeuserfile($docuname,$docudom,$metafile);
3910: my $url = "/uploaded/$docudom/$docuname/$fname";
3911: my ($file,$group) = (&parse_portfolio_url($url))[3,4];
3912: my $sqlresult =
3913: &update_portfolio_table($docuname,$docudom,$file,
3914: 'portfolio_metadata',$group,
3915: 'delete');
3916: }
3917: }
3918: return $result;
3919: }
3920:
3921: sub mkdiruserfile {
3922: my ($docuname,$docudom,$dir)=@_;
3923: my $home=&homeserver($docuname,$docudom);
3924: return &reply("mkdiruserfile:".&escape("$docudom/$docuname/$dir"),$home);
3925: }
3926:
3927: sub renameuserfile {
3928: my ($docuname,$docudom,$old,$new)=@_;
3929: my $home=&homeserver($docuname,$docudom);
3930: my $result = &reply("renameuserfile:$docudom:$docuname:".
3931: &escape("$old").':'.&escape("$new"),$home);
3932: if ($result eq 'ok') {
3933: if (($old !~ /\.meta$/) && (&is_portfolio_file($old))) {
3934: my $oldmeta = $old.'.meta';
3935: my $newmeta = $new.'.meta';
3936: my $metaresult =
3937: &renameuserfile($docuname,$docudom,$oldmeta,$newmeta);
3938: my $url = "/uploaded/$docudom/$docuname/$old";
3939: my ($file,$group) = (&parse_portfolio_url($url))[3,4];
3940: my $sqlresult =
3941: &update_portfolio_table($docuname,$docudom,$file,
3942: 'portfolio_metadata',$group,
3943: 'delete');
3944: }
3945: }
3946: return $result;
3947: }
3948:
3949: # ------------------------------------------------------------------------- Log
3950:
3951: sub log {
3952: my ($dom,$nam,$hom,$what)=@_;
3953: return critical("log:$dom:$nam:$what",$hom);
3954: }
3955:
3956: # ------------------------------------------------------------------ Course Log
3957: #
3958: # This routine flushes several buffers of non-mission-critical nature
3959: #
3960:
3961: sub flushcourselogs {
3962: &logthis('Flushing log buffers');
3963: #
3964: # course logs
3965: # This is a log of all transactions in a course, which can be used
3966: # for data mining purposes
3967: #
3968: # It also collects the courseid database, which lists last transaction
3969: # times and course titles for all courseids
3970: #
3971: my %courseidbuffer=();
3972: foreach my $crsid (keys(%courselogs)) {
3973: if (&reply('log:'.$coursedombuf{$crsid}.':'.$coursenumbuf{$crsid}.':'.
3974: &escape($courselogs{$crsid}),
3975: $coursehombuf{$crsid}) eq 'ok') {
3976: delete $courselogs{$crsid};
3977: } else {
3978: &logthis('Failed to flush log buffer for '.$crsid);
3979: if (length($courselogs{$crsid})>40000) {
3980: &logthis("<font color=\"blue\">WARNING: Buffer for ".$crsid.
3981: " exceeded maximum size, deleting.</font>");
3982: delete $courselogs{$crsid};
3983: }
3984: }
3985: $courseidbuffer{$coursehombuf{$crsid}}{$crsid} = {
3986: 'description' => $coursedescrbuf{$crsid},
3987: 'inst_code' => $courseinstcodebuf{$crsid},
3988: 'type' => $coursetypebuf{$crsid},
3989: 'owner' => $courseownerbuf{$crsid},
3990: };
3991: }
3992: #
3993: # Write course id database (reverse lookup) to homeserver of courses
3994: # Is used in pickcourse
3995: #
3996: foreach my $crs_home (keys(%courseidbuffer)) {
3997: my $response = &courseidput(&host_domain($crs_home),
3998: $courseidbuffer{$crs_home},
3999: $crs_home,'timeonly');
4000: }
4001: #
4002: # File accesses
4003: # Writes to the dynamic metadata of resources to get hit counts, etc.
4004: #
4005: foreach my $entry (keys(%accesshash)) {
4006: if ($entry =~ /___count$/) {
4007: my ($dom,$name);
4008: ($dom,$name,undef)=
4009: ($entry=~m{___($match_domain)/($match_name)/(.*)___count$});
4010: if (! defined($dom) || $dom eq '' ||
4011: ! defined($name) || $name eq '') {
4012: my $cid = $env{'request.course.id'};
4013: $dom = $env{'request.'.$cid.'.domain'};
4014: $name = $env{'request.'.$cid.'.num'};
4015: }
4016: my $value = $accesshash{$entry};
4017: my (undef,$url,undef) = ($entry =~ /^(.*)___(.*)___count$/);
4018: my %temphash=($url => $value);
4019: my $result = &inc('nohist_accesscount',\%temphash,$dom,$name);
4020: if ($result eq 'ok') {
4021: delete $accesshash{$entry};
4022: }
4023: } else {
4024: my ($dom,$name) = ($entry=~m{___($match_domain)/($match_name)/(.*)___(\w+)$});
4025: if (($dom eq 'uploaded') || ($dom eq 'adm')) { next; }
4026: my %temphash=($entry => $accesshash{$entry});
4027: if (&put('nohist_resevaldata',\%temphash,$dom,$name) eq 'ok') {
4028: delete $accesshash{$entry};
4029: }
4030: }
4031: }
4032: #
4033: # Roles
4034: # Reverse lookup of user roles for course faculty/staff and co-authorship
4035: #
4036: foreach my $entry (keys(%userrolehash)) {
4037: my ($role,$uname,$udom,$runame,$rudom,$rsec)=
4038: split(/\:/,$entry);
4039: if (&Apache::lonnet::put('nohist_userroles',
4040: { $role.':'.$uname.':'.$udom.':'.$rsec => $userrolehash{$entry} },
4041: $rudom,$runame) eq 'ok') {
4042: delete $userrolehash{$entry};
4043: }
4044: }
4045: #
4046: # Reverse lookup of domain roles (dc, ad, li, sc, au)
4047: #
4048: my %domrolebuffer = ();
4049: foreach my $entry (keys(%domainrolehash)) {
4050: my ($role,$uname,$udom,$runame,$rudom,$rsec)=split(/:/,$entry);
4051: if ($domrolebuffer{$rudom}) {
4052: $domrolebuffer{$rudom}.='&'.&escape($entry).
4053: '='.&escape($domainrolehash{$entry});
4054: } else {
4055: $domrolebuffer{$rudom}.=&escape($entry).
4056: '='.&escape($domainrolehash{$entry});
4057: }
4058: delete $domainrolehash{$entry};
4059: }
4060: foreach my $dom (keys(%domrolebuffer)) {
4061: my %servers = &get_servers($dom,'library');
4062: foreach my $tryserver (keys(%servers)) {
4063: unless (&reply('domroleput:'.$dom.':'.
4064: $domrolebuffer{$dom},$tryserver) eq 'ok') {
4065: &logthis('Put of domain roles failed for '.$dom.' and '.$tryserver);
4066: }
4067: }
4068: }
4069: $dumpcount++;
4070: }
4071:
4072: sub courselog {
4073: my $what=shift;
4074: $what=time.':'.$what;
4075: unless ($env{'request.course.id'}) { return ''; }
4076: $coursedombuf{$env{'request.course.id'}}=
4077: $env{'course.'.$env{'request.course.id'}.'.domain'};
4078: $coursenumbuf{$env{'request.course.id'}}=
4079: $env{'course.'.$env{'request.course.id'}.'.num'};
4080: $coursehombuf{$env{'request.course.id'}}=
4081: $env{'course.'.$env{'request.course.id'}.'.home'};
4082: $coursedescrbuf{$env{'request.course.id'}}=
4083: $env{'course.'.$env{'request.course.id'}.'.description'};
4084: $courseinstcodebuf{$env{'request.course.id'}}=
4085: $env{'course.'.$env{'request.course.id'}.'.internal.coursecode'};
4086: $courseownerbuf{$env{'request.course.id'}}=
4087: $env{'course.'.$env{'request.course.id'}.'.internal.courseowner'};
4088: $coursetypebuf{$env{'request.course.id'}}=
4089: $env{'course.'.$env{'request.course.id'}.'.type'};
4090: if (defined $courselogs{$env{'request.course.id'}}) {
4091: $courselogs{$env{'request.course.id'}}.='&'.$what;
4092: } else {
4093: $courselogs{$env{'request.course.id'}}.=$what;
4094: }
4095: if (length($courselogs{$env{'request.course.id'}})>4048) {
4096: &flushcourselogs();
4097: }
4098: }
4099:
4100: sub courseacclog {
4101: my $fnsymb=shift;
4102: unless ($env{'request.course.id'}) { return ''; }
4103: my $what=$fnsymb.':'.$env{'user.name'}.':'.$env{'user.domain'};
4104: if ($fnsymb=~/$LONCAPA::assess_re/) {
4105: $what.=':POST';
4106: # FIXME: Probably ought to escape things....
4107: foreach my $key (keys(%env)) {
4108: if ($key=~/^form\.(.*)/) {
4109: my $formitem = $1;
4110: if ($formitem =~ /^HWFILE(?:SIZE|TOOBIG)/) {
4111: $what.=':'.$formitem.'='.$env{$key};
4112: } elsif ($formitem !~ /^HWFILE(?:[^.]+)$/) {
4113: $what.=':'.$formitem.'='.$env{$key};
4114: }
4115: }
4116: }
4117: } elsif ($fnsymb =~ m:^/adm/searchcat:) {
4118: # FIXME: We should not be depending on a form parameter that someone
4119: # editing lonsearchcat.pm might change in the future.
4120: if ($env{'form.phase'} eq 'course_search') {
4121: $what.= ':POST';
4122: # FIXME: Probably ought to escape things....
4123: foreach my $element ('courseexp','crsfulltext','crsrelated',
4124: 'crsdiscuss') {
4125: $what.=':'.$element.'='.$env{'form.'.$element};
4126: }
4127: }
4128: }
4129: &courselog($what);
4130: }
4131:
4132: sub countacc {
4133: my $url=&declutter(shift);
4134: return if (! defined($url) || $url eq '');
4135: unless ($env{'request.course.id'}) { return ''; }
4136: #
4137: # Mark that this url was used in this course
4138: #
4139: $accesshash{$env{'request.course.id'}.'___'.$url.'___course'}=1;
4140: #
4141: # Increase the access count for this resource in this child process
4142: #
4143: my $key=$$.$processmarker.'_'.$dumpcount.'___'.$url.'___count';
4144: $accesshash{$key}++;
4145: }
4146:
4147: sub linklog {
4148: my ($from,$to)=@_;
4149: $from=&declutter($from);
4150: $to=&declutter($to);
4151: $accesshash{$from.'___'.$to.'___comefrom'}=1;
4152: $accesshash{$to.'___'.$from.'___goto'}=1;
4153: }
4154:
4155: sub statslog {
4156: my ($symb,$part,$users,$av_attempts,$degdiff)=@_;
4157: if ($users<2) { return; }
4158: my %dynstore=&LONCAPA::lonmetadata::dynamic_metadata_storage({
4159: 'course' => $env{'request.course.id'},
4160: 'sections' => '"all"',
4161: 'num_students' => $users,
4162: 'part' => $part,
4163: 'symb' => $symb,
4164: 'mean_tries' => $av_attempts,
4165: 'deg_of_diff' => $degdiff});
4166: foreach my $key (keys(%dynstore)) {
4167: $accesshash{$key}=$dynstore{$key};
4168: }
4169: }
4170:
4171: sub userrolelog {
4172: my ($trole,$username,$domain,$area,$tstart,$tend)=@_;
4173: if ( $trole =~ /^(ca|aa|in|cc|ep|cr|ta|co)/ ) {
4174: my (undef,$rudom,$runame,$rsec)=split(/\//,$area);
4175: $userrolehash
4176: {$trole.':'.$username.':'.$domain.':'.$runame.':'.$rudom.':'.$rsec}
4177: =$tend.':'.$tstart;
4178: }
4179: if ($env{'request.role'} =~ /dc\./ && $trole =~ /^(au|in|cc|ep|cr|ta|co)/) {
4180: $userrolehash
4181: {$trole.':'.$username.':'.$domain.':'.$env{'user.name'}.':'.$env{'user.domain'}.':'}
4182: =$tend.':'.$tstart;
4183: }
4184: if ($trole =~ /^(dc|ad|li|au|dg|sc)/ ) {
4185: my (undef,$rudom,$runame,$rsec)=split(/\//,$area);
4186: $domainrolehash
4187: {$trole.':'.$username.':'.$domain.':'.$runame.':'.$rudom.':'.$rsec}
4188: = $tend.':'.$tstart;
4189: }
4190: }
4191:
4192: sub courserolelog {
4193: my ($trole,$username,$domain,$area,$tstart,$tend,$delflag,$selfenroll,$context)=@_;
4194: if ($area =~ m-^/($match_domain)/($match_courseid)/?([^/]*)-) {
4195: my $cdom = $1;
4196: my $cnum = $2;
4197: my $sec = $3;
4198: my $namespace = 'rolelog';
4199: my %storehash = (
4200: role => $trole,
4201: start => $tstart,
4202: end => $tend,
4203: selfenroll => $selfenroll,
4204: context => $context,
4205: );
4206: if ($trole eq 'gr') {
4207: $namespace = 'groupslog';
4208: $storehash{'group'} = $sec;
4209: } else {
4210: $storehash{'section'} = $sec;
4211: }
4212: &write_log('course',$namespace,\%storehash,$delflag,$username,
4213: $domain,$cnum,$cdom);
4214: if (($trole ne 'st') || ($sec ne '')) {
4215: &devalidate_cache_new('getcourseroles',$cdom.'_'.$cnum);
4216: }
4217: }
4218: return;
4219: }
4220:
4221: sub domainrolelog {
4222: my ($trole,$username,$domain,$area,$tstart,$tend,$delflag,$context)=@_;
4223: if ($area =~ m{^/($match_domain)/$}) {
4224: my $cdom = $1;
4225: my $domconfiguser = &Apache::lonnet::get_domainconfiguser($cdom);
4226: my $namespace = 'rolelog';
4227: my %storehash = (
4228: role => $trole,
4229: start => $tstart,
4230: end => $tend,
4231: context => $context,
4232: );
4233: &write_log('domain',$namespace,\%storehash,$delflag,$username,
4234: $domain,$domconfiguser,$cdom);
4235: }
4236: return;
4237:
4238: }
4239:
4240: sub coauthorrolelog {
4241: my ($trole,$username,$domain,$area,$tstart,$tend,$delflag,$context)=@_;
4242: if ($area =~ m{^/($match_domain)/($match_username)$}) {
4243: my $audom = $1;
4244: my $auname = $2;
4245: my $namespace = 'rolelog';
4246: my %storehash = (
4247: role => $trole,
4248: start => $tstart,
4249: end => $tend,
4250: context => $context,
4251: );
4252: &write_log('author',$namespace,\%storehash,$delflag,$username,
4253: $domain,$auname,$audom);
4254: }
4255: return;
4256: }
4257:
4258: sub get_course_adv_roles {
4259: my ($cid,$codes) = @_;
4260: $cid=$env{'request.course.id'} unless (defined($cid));
4261: my %coursehash=&coursedescription($cid);
4262: my $crstype = &Apache::loncommon::course_type($cid);
4263: my %nothide=();
4264: foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
4265: if ($user !~ /:/) {
4266: $nothide{join(':',split(/[\@]/,$user))}=1;
4267: } else {
4268: $nothide{$user}=1;
4269: }
4270: }
4271: my @possdoms = ($coursehash{'domain'});
4272: if ($coursehash{'checkforpriv'}) {
4273: push(@possdoms,split(/,/,$coursehash{'checkforpriv'}));
4274: }
4275: my %returnhash=();
4276: my %dumphash=
4277: &dump('nohist_userroles',$coursehash{'domain'},$coursehash{'num'});
4278: my $now=time;
4279: my %privileged;
4280: foreach my $entry (keys(%dumphash)) {
4281: my ($tend,$tstart)=split(/\:/,$dumphash{$entry});
4282: if (($tstart) && ($tstart<0)) { next; }
4283: if (($tend) && ($tend<$now)) { next; }
4284: if (($tstart) && ($now<$tstart)) { next; }
4285: my ($role,$username,$domain,$section)=split(/\:/,$entry);
4286: if ($username eq '' || $domain eq '') { next; }
4287: if ((&privileged($username,$domain,\@possdoms)) &&
4288: (!$nothide{$username.':'.$domain})) { next; }
4289: if ($role eq 'cr') { next; }
4290: if ($codes) {
4291: if ($section) { $role .= ':'.$section; }
4292: if ($returnhash{$role}) {
4293: $returnhash{$role}.=','.$username.':'.$domain;
4294: } else {
4295: $returnhash{$role}=$username.':'.$domain;
4296: }
4297: } else {
4298: my $key=&plaintext($role,$crstype);
4299: if ($section) { $key.=' ('.&Apache::lonlocal::mt('Section [_1]',$section).')'; }
4300: if ($returnhash{$key}) {
4301: $returnhash{$key}.=','.$username.':'.$domain;
4302: } else {
4303: $returnhash{$key}=$username.':'.$domain;
4304: }
4305: }
4306: }
4307: return %returnhash;
4308: }
4309:
4310: sub get_my_roles {
4311: my ($uname,$udom,$context,$types,$roles,$roledoms,$withsec,$hidepriv)=@_;
4312: unless (defined($uname)) { $uname=$env{'user.name'}; }
4313: unless (defined($udom)) { $udom=$env{'user.domain'}; }
4314: my (%dumphash,%nothide);
4315: if ($context eq 'userroles') {
4316: %dumphash = &dump('roles',$udom,$uname);
4317: } else {
4318: %dumphash = &dump('nohist_userroles',$udom,$uname);
4319: if ($hidepriv) {
4320: my %coursehash=&coursedescription($udom.'_'.$uname);
4321: foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
4322: if ($user !~ /:/) {
4323: $nothide{join(':',split(/[\@]/,$user))} = 1;
4324: } else {
4325: $nothide{$user} = 1;
4326: }
4327: }
4328: }
4329: }
4330: my %returnhash=();
4331: my $now=time;
4332: my %privileged;
4333: foreach my $entry (keys(%dumphash)) {
4334: my ($role,$tend,$tstart);
4335: if ($context eq 'userroles') {
4336: next if ($entry =~ /^rolesdef/);
4337: ($role,$tend,$tstart)=split(/_/,$dumphash{$entry});
4338: } else {
4339: ($tend,$tstart)=split(/\:/,$dumphash{$entry});
4340: }
4341: if (($tstart) && ($tstart<0)) { next; }
4342: my $status = 'active';
4343: if (($tend) && ($tend<=$now)) {
4344: $status = 'previous';
4345: }
4346: if (($tstart) && ($now<$tstart)) {
4347: $status = 'future';
4348: }
4349: if (ref($types) eq 'ARRAY') {
4350: if (!grep(/^\Q$status\E$/,@{$types})) {
4351: next;
4352: }
4353: } else {
4354: if ($status ne 'active') {
4355: next;
4356: }
4357: }
4358: my ($rolecode,$username,$domain,$section,$area);
4359: if ($context eq 'userroles') {
4360: ($area,$rolecode) = ($entry =~ /^(.+)_([^_]+)$/);
4361: (undef,$domain,$username,$section) = split(/\//,$area);
4362: } else {
4363: ($role,$username,$domain,$section) = split(/\:/,$entry);
4364: }
4365: if (ref($roledoms) eq 'ARRAY') {
4366: if (!grep(/^\Q$domain\E$/,@{$roledoms})) {
4367: next;
4368: }
4369: }
4370: if (ref($roles) eq 'ARRAY') {
4371: if (!grep(/^\Q$role\E$/,@{$roles})) {
4372: if ($role =~ /^cr\//) {
4373: if (!grep(/^cr$/,@{$roles})) {
4374: next;
4375: }
4376: } elsif ($role =~ /^gr\//) {
4377: if (!grep(/^gr$/,@{$roles})) {
4378: next;
4379: }
4380: } else {
4381: next;
4382: }
4383: }
4384: }
4385: if ($hidepriv) {
4386: my @privroles = ('dc','su');
4387: if ($context eq 'userroles') {
4388: next if (grep(/^\Q$role\E$/,@privroles));
4389: } else {
4390: my $possdoms = [$domain];
4391: if (ref($roledoms) eq 'ARRAY') {
4392: push(@{$possdoms},@{$roledoms});
4393: }
4394: if (&privileged($username,$domain,$possdoms,\@privroles)) {
4395: if (!$nothide{$username.':'.$domain}) {
4396: next;
4397: }
4398: }
4399: }
4400: }
4401: if ($withsec) {
4402: $returnhash{$username.':'.$domain.':'.$role.':'.$section} =
4403: $tstart.':'.$tend;
4404: } else {
4405: $returnhash{$username.':'.$domain.':'.$role}=$tstart.':'.$tend;
4406: }
4407: }
4408: return %returnhash;
4409: }
4410:
4411: # ----------------------------------------------------- Frontpage Announcements
4412: #
4413: #
4414:
4415: sub postannounce {
4416: my ($server,$text)=@_;
4417: unless (&allowed('psa',&host_domain($server))) { return 'refused'; }
4418: unless ($text=~/\w/) { $text=''; }
4419: return &reply('setannounce:'.&escape($text),$server);
4420: }
4421:
4422: sub getannounce {
4423:
4424: if (open(my $fh,$perlvar{'lonDocRoot'}.'/announcement.txt')) {
4425: my $announcement='';
4426: while (my $line = <$fh>) { $announcement .= $line; }
4427: close($fh);
4428: if ($announcement=~/\w/) {
4429: return
4430: '<table bgcolor="#FF5555" cellpadding="5" cellspacing="3">'.
4431: '<tr><td bgcolor="#FFFFFF"><tt>'.$announcement.'</tt></td></tr></table>';
4432: } else {
4433: return '';
4434: }
4435: } else {
4436: return '';
4437: }
4438: }
4439:
4440: # ---------------------------------------------------------- Course ID routines
4441: # Deal with domain's nohist_courseid.db files
4442: #
4443:
4444: sub courseidput {
4445: my ($domain,$storehash,$coursehome,$caller) = @_;
4446: return unless (ref($storehash) eq 'HASH');
4447: my $outcome;
4448: if ($caller eq 'timeonly') {
4449: my $cids = '';
4450: foreach my $item (keys(%$storehash)) {
4451: $cids.=&escape($item).'&';
4452: }
4453: $cids=~s/\&$//;
4454: $outcome = &reply('courseidputhash:'.$domain.':'.$caller.':'.$cids,
4455: $coursehome);
4456: } else {
4457: my $items = '';
4458: foreach my $item (keys(%$storehash)) {
4459: $items.= &escape($item).'='.
4460: &freeze_escape($$storehash{$item}).'&';
4461: }
4462: $items=~s/\&$//;
4463: $outcome = &reply('courseidputhash:'.$domain.':'.$caller.':'.$items,
4464: $coursehome);
4465: }
4466: if ($outcome eq 'unknown_cmd') {
4467: my $what;
4468: foreach my $cid (keys(%$storehash)) {
4469: $what .= &escape($cid).'=';
4470: foreach my $item ('description','inst_code','owner','type') {
4471: $what .= &escape($storehash->{$cid}{$item}).':';
4472: }
4473: $what =~ s/\:$/&/;
4474: }
4475: $what =~ s/\&$//;
4476: return &reply('courseidput:'.$domain.':'.$what,$coursehome);
4477: } else {
4478: return $outcome;
4479: }
4480: }
4481:
4482: sub courseiddump {
4483: my ($domfilter,$descfilter,$sincefilter,$instcodefilter,$ownerfilter,
4484: $coursefilter,$hostidflag,$hostidref,$typefilter,$regexp_ok,
4485: $selfenrollonly,$catfilter,$showhidden,$caller,$cloner,$cc_clone,
4486: $cloneonly,$createdbefore,$createdafter,$creationcontext,$domcloner,
4487: $hasuniquecode,$reqcrsdom,$reqinstcode)=@_;
4488: my $as_hash = 1;
4489: my %returnhash;
4490: if (!$domfilter) { $domfilter=''; }
4491: my %libserv = &all_library();
4492: foreach my $tryserver (keys(%libserv)) {
4493: if ( ( $hostidflag == 1
4494: && grep(/^\Q$tryserver\E$/,@{$hostidref}) )
4495: || (!defined($hostidflag)) ) {
4496:
4497: if (($domfilter eq '') ||
4498: (&host_domain($tryserver) eq $domfilter)) {
4499: my $rep;
4500: if (grep { $_ eq $tryserver } current_machine_ids()) {
4501: $rep = LONCAPA::Lond::dump_course_id_handler(
4502: join(":", (&host_domain($tryserver), $sincefilter,
4503: &escape($descfilter), &escape($instcodefilter),
4504: &escape($ownerfilter), &escape($coursefilter),
4505: &escape($typefilter), &escape($regexp_ok),
4506: $as_hash, &escape($selfenrollonly),
4507: &escape($catfilter), $showhidden, $caller,
4508: &escape($cloner), &escape($cc_clone), $cloneonly,
4509: &escape($createdbefore), &escape($createdafter),
4510: &escape($creationcontext),$domcloner,$hasuniquecode,
4511: $reqcrsdom,&escape($reqinstcode))));
4512: } else {
4513: $rep = &reply('courseiddump:'.&host_domain($tryserver).':'.
4514: $sincefilter.':'.&escape($descfilter).':'.
4515: &escape($instcodefilter).':'.&escape($ownerfilter).
4516: ':'.&escape($coursefilter).':'.&escape($typefilter).
4517: ':'.&escape($regexp_ok).':'.$as_hash.':'.
4518: &escape($selfenrollonly).':'.&escape($catfilter).':'.
4519: $showhidden.':'.$caller.':'.&escape($cloner).':'.
4520: &escape($cc_clone).':'.$cloneonly.':'.
4521: &escape($createdbefore).':'.&escape($createdafter).':'.
4522: &escape($creationcontext).':'.$domcloner.':'.$hasuniquecode.
4523: ':'.$reqcrsdom.':'.&escape($reqinstcode),$tryserver);
4524: }
4525:
4526: my @pairs=split(/\&/,$rep);
4527: foreach my $item (@pairs) {
4528: my ($key,$value)=split(/\=/,$item,2);
4529: $key = &unescape($key);
4530: next if ($key =~ /^error: 2 /);
4531: my $result = &thaw_unescape($value);
4532: if (ref($result) eq 'HASH') {
4533: $returnhash{$key}=$result;
4534: } else {
4535: my @responses = split(/:/,$value);
4536: my @items = ('description','inst_code','owner','type');
4537: for (my $i=0; $i<@responses; $i++) {
4538: $returnhash{$key}{$items[$i]} = &unescape($responses[$i]);
4539: }
4540: }
4541: }
4542: }
4543: }
4544: }
4545: return %returnhash;
4546: }
4547:
4548: sub courselastaccess {
4549: my ($cdom,$cnum,$hostidref) = @_;
4550: my %returnhash;
4551: if ($cdom && $cnum) {
4552: my $chome = &homeserver($cnum,$cdom);
4553: if ($chome ne 'no_host') {
4554: my $rep = &reply('courselastaccess:'.$cdom.':'.$cnum,$chome);
4555: &extract_lastaccess(\%returnhash,$rep);
4556: }
4557: } else {
4558: if (!$cdom) { $cdom=''; }
4559: my %libserv = &all_library();
4560: foreach my $tryserver (keys(%libserv)) {
4561: if (ref($hostidref) eq 'ARRAY') {
4562: next unless (grep(/^\Q$tryserver\E$/,@{$hostidref}));
4563: }
4564: if (($cdom eq '') || (&host_domain($tryserver) eq $cdom)) {
4565: my $rep = &reply('courselastaccess:'.&host_domain($tryserver).':',$tryserver);
4566: &extract_lastaccess(\%returnhash,$rep);
4567: }
4568: }
4569: }
4570: return %returnhash;
4571: }
4572:
4573: sub extract_lastaccess {
4574: my ($returnhash,$rep) = @_;
4575: if (ref($returnhash) eq 'HASH') {
4576: unless ($rep eq 'unknown_command' || $rep eq 'no_such_host' ||
4577: $rep eq 'con_lost' || $rep eq 'rejected' || $rep eq 'refused' ||
4578: $rep eq '') {
4579: my @pairs=split(/\&/,$rep);
4580: foreach my $item (@pairs) {
4581: my ($key,$value)=split(/\=/,$item,2);
4582: $key = &unescape($key);
4583: next if ($key =~ /^error: 2 /);
4584: $returnhash->{$key} = &thaw_unescape($value);
4585: }
4586: }
4587: }
4588: return;
4589: }
4590:
4591: # ---------------------------------------------------------- DC e-mail
4592:
4593: sub dcmailput {
4594: my ($domain,$msgid,$message,$server)=@_;
4595: my $status = &Apache::lonnet::critical(
4596: 'dcmailput:'.$domain.':'.&escape($msgid).'='.
4597: &escape($message),$server);
4598: return $status;
4599: }
4600:
4601: sub dcmaildump {
4602: my ($dom,$startdate,$enddate,$senders) = @_;
4603: my %returnhash=();
4604:
4605: if (defined(&domain($dom,'primary'))) {
4606: my $cmd='dcmaildump:'.$dom.':'.&escape($startdate).':'.
4607: &escape($enddate).':';
4608: my @esc_senders=map { &escape($_)} @$senders;
4609: $cmd.=&escape(join('&',@esc_senders));
4610: foreach my $line (split(/\&/,&reply($cmd,&domain($dom,'primary')))) {
4611: my ($key,$value) = split(/\=/,$line,2);
4612: if (($key) && ($value)) {
4613: $returnhash{&unescape($key)} = &unescape($value);
4614: }
4615: }
4616: }
4617: return %returnhash;
4618: }
4619: # ---------------------------------------------------------- Domain roles
4620:
4621: sub get_domain_roles {
4622: my ($dom,$roles,$startdate,$enddate)=@_;
4623: if ((!defined($startdate)) || ($startdate eq '')) {
4624: $startdate = '.';
4625: }
4626: if ((!defined($enddate)) || ($enddate eq '')) {
4627: $enddate = '.';
4628: }
4629: my $rolelist;
4630: if (ref($roles) eq 'ARRAY') {
4631: $rolelist = join('&',@{$roles});
4632: }
4633: my %personnel = ();
4634:
4635: my %servers = &get_servers($dom,'library');
4636: foreach my $tryserver (keys(%servers)) {
4637: %{$personnel{$tryserver}}=();
4638: foreach my $line (split(/\&/,&reply('domrolesdump:'.$dom.':'.
4639: &escape($startdate).':'.
4640: &escape($enddate).':'.
4641: &escape($rolelist), $tryserver))) {
4642: my ($key,$value) = split(/\=/,$line,2);
4643: if (($key) && ($value)) {
4644: $personnel{$tryserver}{&unescape($key)} = &unescape($value);
4645: }
4646: }
4647: }
4648: return %personnel;
4649: }
4650:
4651: # ----------------------------------------------------------- Interval timing
4652:
4653: {
4654: # Caches needed for speedup of navmaps
4655: # We don't want to cache this for very long at all (5 seconds at most)
4656: #
4657: # The user for whom we cache
4658: my $cachedkey='';
4659: # The cached times for this user
4660: my %cachedtimes=();
4661: # When this was last done
4662: my $cachedtime='';
4663:
4664: sub load_all_first_access {
4665: my ($uname,$udom,$ignorecache)=@_;
4666: if (($cachedkey eq $uname.':'.$udom) &&
4667: (abs($cachedtime-time)<5) && (!$env{'form.markaccess'}) &&
4668: (!$ignorecache)) {
4669: return;
4670: }
4671: $cachedtime=time;
4672: $cachedkey=$uname.':'.$udom;
4673: %cachedtimes=&dump('firstaccesstimes',$udom,$uname);
4674: }
4675:
4676: sub get_first_access {
4677: my ($type,$argsymb,$argmap,$ignorecache)=@_;
4678: my ($symb,$courseid,$udom,$uname)=&whichuser();
4679: if ($argsymb) { $symb=$argsymb; }
4680: my ($map,$id,$res)=&decode_symb($symb);
4681: if ($argmap) { $map = $argmap; }
4682: if ($type eq 'course') {
4683: $res='course';
4684: } elsif ($type eq 'map') {
4685: $res=&symbread($map);
4686: } else {
4687: $res=$symb;
4688: }
4689: &load_all_first_access($uname,$udom,$ignorecache);
4690: return $cachedtimes{"$courseid\0$res"};
4691: }
4692:
4693: sub set_first_access {
4694: my ($type,$interval)=@_;
4695: my ($symb,$courseid,$udom,$uname)=&whichuser();
4696: my ($map,$id,$res)=&decode_symb($symb);
4697: if ($type eq 'course') {
4698: $res='course';
4699: } elsif ($type eq 'map') {
4700: $res=&symbread($map);
4701: } else {
4702: $res=$symb;
4703: }
4704: $cachedkey='';
4705: my $firstaccess=&get_first_access($type,$symb,$map);
4706: if (!$firstaccess) {
4707: my $start = time;
4708: my $putres = &put('firstaccesstimes',{"$courseid\0$res"=>$start},
4709: $udom,$uname);
4710: if ($putres eq 'ok') {
4711: &put('timerinterval',{"$courseid\0$res"=>$interval},
4712: $udom,$uname);
4713: &appenv(
4714: {
4715: 'course.'.$courseid.'.firstaccess.'.$res => $start,
4716: 'course.'.$courseid.'.timerinterval.'.$res => $interval,
4717: }
4718: );
4719: }
4720: return $putres;
4721: }
4722: return 'already_set';
4723: }
4724: }
4725:
4726: # --------------------------------------------- Set Expire Date for Spreadsheet
4727:
4728: sub expirespread {
4729: my ($uname,$udom,$stype,$usymb)=@_;
4730: my $cid=$env{'request.course.id'};
4731: if ($cid) {
4732: my $now=time;
4733: my $key=$uname.':'.$udom.':'.$stype.':'.$usymb;
4734: return &reply('put:'.$env{'course.'.$cid.'.domain'}.':'.
4735: $env{'course.'.$cid.'.num'}.
4736: ':nohist_expirationdates:'.
4737: &escape($key).'='.$now,
4738: $env{'course.'.$cid.'.home'})
4739: }
4740: return 'ok';
4741: }
4742:
4743: # ----------------------------------------------------- Devalidate Spreadsheets
4744:
4745: sub devalidate {
4746: my ($symb,$uname,$udom)=@_;
4747: my $cid=$env{'request.course.id'};
4748: if ($cid) {
4749: # delete the stored spreadsheets for
4750: # - the student level sheet of this user in course's homespace
4751: # - the assessment level sheet for this resource
4752: # for this user in user's homespace
4753: # - current conditional state info
4754: my $key=$uname.':'.$udom.':';
4755: my $status=
4756: &del('nohist_calculatedsheets',
4757: [$key.'studentcalc:'],
4758: $env{'course.'.$cid.'.domain'},
4759: $env{'course.'.$cid.'.num'})
4760: .' '.
4761: &del('nohist_calculatedsheets_'.$cid,
4762: [$key.'assesscalc:'.$symb],$udom,$uname);
4763: unless ($status eq 'ok ok') {
4764: &logthis('Could not devalidate spreadsheet '.
4765: $uname.' at '.$udom.' for '.
4766: $symb.': '.$status);
4767: }
4768: &delenv('user.state.'.$cid);
4769: }
4770: }
4771:
4772: sub get_scalar {
4773: my ($string,$end) = @_;
4774: my $value;
4775: if ($$string =~ s/^([^&]*?)($end)/$2/) {
4776: $value = $1;
4777: } elsif ($$string =~ s/^([^&]*?)&//) {
4778: $value = $1;
4779: }
4780: return &unescape($value);
4781: }
4782:
4783: sub array2str {
4784: my (@array) = @_;
4785: my $result=&arrayref2str(\@array);
4786: $result=~s/^__ARRAY_REF__//;
4787: $result=~s/__END_ARRAY_REF__$//;
4788: return $result;
4789: }
4790:
4791: sub arrayref2str {
4792: my ($arrayref) = @_;
4793: my $result='__ARRAY_REF__';
4794: foreach my $elem (@$arrayref) {
4795: if(ref($elem) eq 'ARRAY') {
4796: $result.=&arrayref2str($elem).'&';
4797: } elsif(ref($elem) eq 'HASH') {
4798: $result.=&hashref2str($elem).'&';
4799: } elsif(ref($elem)) {
4800: #print("Got a ref of ".(ref($elem))." skipping.");
4801: } else {
4802: $result.=&escape($elem).'&';
4803: }
4804: }
4805: $result=~s/\&$//;
4806: $result .= '__END_ARRAY_REF__';
4807: return $result;
4808: }
4809:
4810: sub hash2str {
4811: my (%hash) = @_;
4812: my $result=&hashref2str(\%hash);
4813: $result=~s/^__HASH_REF__//;
4814: $result=~s/__END_HASH_REF__$//;
4815: return $result;
4816: }
4817:
4818: sub hashref2str {
4819: my ($hashref)=@_;
4820: my $result='__HASH_REF__';
4821: foreach my $key (sort(keys(%$hashref))) {
4822: if (ref($key) eq 'ARRAY') {
4823: $result.=&arrayref2str($key).'=';
4824: } elsif (ref($key) eq 'HASH') {
4825: $result.=&hashref2str($key).'=';
4826: } elsif (ref($key)) {
4827: $result.='=';
4828: #print("Got a ref of ".(ref($key))." skipping.");
4829: } else {
4830: if (defined($key)) {$result.=&escape($key).'=';} else { last; }
4831: }
4832:
4833: if(ref($hashref->{$key}) eq 'ARRAY') {
4834: $result.=&arrayref2str($hashref->{$key}).'&';
4835: } elsif(ref($hashref->{$key}) eq 'HASH') {
4836: $result.=&hashref2str($hashref->{$key}).'&';
4837: } elsif(ref($hashref->{$key})) {
4838: $result.='&';
4839: #print("Got a ref of ".(ref($hashref->{$key}))." skipping.");
4840: } else {
4841: $result.=&escape($hashref->{$key}).'&';
4842: }
4843: }
4844: $result=~s/\&$//;
4845: $result .= '__END_HASH_REF__';
4846: return $result;
4847: }
4848:
4849: sub str2hash {
4850: my ($string)=@_;
4851: my ($hash)=&str2hashref('__HASH_REF__'.$string.'__END_HASH_REF__');
4852: return %$hash;
4853: }
4854:
4855: sub str2hashref {
4856: my ($string) = @_;
4857:
4858: my %hash;
4859:
4860: if($string !~ /^__HASH_REF__/) {
4861: if (! ($string eq '' || !defined($string))) {
4862: $hash{'error'}='Not hash reference';
4863: }
4864: return (\%hash, $string);
4865: }
4866:
4867: $string =~ s/^__HASH_REF__//;
4868:
4869: while($string !~ /^__END_HASH_REF__/) {
4870: #key
4871: my $key='';
4872: if($string =~ /^__HASH_REF__/) {
4873: ($key, $string)=&str2hashref($string);
4874: if(defined($key->{'error'})) {
4875: $hash{'error'}='Bad data';
4876: return (\%hash, $string);
4877: }
4878: } elsif($string =~ /^__ARRAY_REF__/) {
4879: ($key, $string)=&str2arrayref($string);
4880: if($key->[0] eq 'Array reference error') {
4881: $hash{'error'}='Bad data';
4882: return (\%hash, $string);
4883: }
4884: } else {
4885: $string =~ s/^(.*?)=//;
4886: $key=&unescape($1);
4887: }
4888: $string =~ s/^=//;
4889:
4890: #value
4891: my $value='';
4892: if($string =~ /^__HASH_REF__/) {
4893: ($value, $string)=&str2hashref($string);
4894: if(defined($value->{'error'})) {
4895: $hash{'error'}='Bad data';
4896: return (\%hash, $string);
4897: }
4898: } elsif($string =~ /^__ARRAY_REF__/) {
4899: ($value, $string)=&str2arrayref($string);
4900: if($value->[0] eq 'Array reference error') {
4901: $hash{'error'}='Bad data';
4902: return (\%hash, $string);
4903: }
4904: } else {
4905: $value=&get_scalar(\$string,'__END_HASH_REF__');
4906: }
4907: $string =~ s/^&//;
4908:
4909: $hash{$key}=$value;
4910: }
4911:
4912: $string =~ s/^__END_HASH_REF__//;
4913:
4914: return (\%hash, $string);
4915: }
4916:
4917: sub str2array {
4918: my ($string)=@_;
4919: my ($array)=&str2arrayref('__ARRAY_REF__'.$string.'__END_ARRAY_REF__');
4920: return @$array;
4921: }
4922:
4923: sub str2arrayref {
4924: my ($string) = @_;
4925: my @array;
4926:
4927: if($string !~ /^__ARRAY_REF__/) {
4928: if (! ($string eq '' || !defined($string))) {
4929: $array[0]='Array reference error';
4930: }
4931: return (\@array, $string);
4932: }
4933:
4934: $string =~ s/^__ARRAY_REF__//;
4935:
4936: while($string !~ /^__END_ARRAY_REF__/) {
4937: my $value='';
4938: if($string =~ /^__HASH_REF__/) {
4939: ($value, $string)=&str2hashref($string);
4940: if(defined($value->{'error'})) {
4941: $array[0] ='Array reference error';
4942: return (\@array, $string);
4943: }
4944: } elsif($string =~ /^__ARRAY_REF__/) {
4945: ($value, $string)=&str2arrayref($string);
4946: if($value->[0] eq 'Array reference error') {
4947: $array[0] ='Array reference error';
4948: return (\@array, $string);
4949: }
4950: } else {
4951: $value=&get_scalar(\$string,'__END_ARRAY_REF__');
4952: }
4953: $string =~ s/^&//;
4954:
4955: push(@array, $value);
4956: }
4957:
4958: $string =~ s/^__END_ARRAY_REF__//;
4959:
4960: return (\@array, $string);
4961: }
4962:
4963: # -------------------------------------------------------------------Temp Store
4964:
4965: sub tmpreset {
4966: my ($symb,$namespace,$domain,$stuname) = @_;
4967: if (!$symb) {
4968: $symb=&symbread();
4969: if (!$symb) { $symb= $env{'request.url'}; }
4970: }
4971: $symb=escape($symb);
4972:
4973: if (!$namespace) { $namespace=$env{'request.state'}; }
4974: $namespace=~s/\//\_/g;
4975: $namespace=~s/\W//g;
4976:
4977: if (!$domain) { $domain=$env{'user.domain'}; }
4978: if (!$stuname) { $stuname=$env{'user.name'}; }
4979: if ($domain eq 'public' && $stuname eq 'public') {
4980: $stuname=$ENV{'REMOTE_ADDR'};
4981: }
4982: my $path=LONCAPA::tempdir();
4983: my %hash;
4984: if (tie(%hash,'GDBM_File',
4985: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
4986: &GDBM_WRCREAT(),0640)) {
4987: foreach my $key (keys(%hash)) {
4988: if ($key=~ /:$symb/) {
4989: delete($hash{$key});
4990: }
4991: }
4992: }
4993: }
4994:
4995: sub tmpstore {
4996: my ($storehash,$symb,$namespace,$domain,$stuname) = @_;
4997:
4998: if (!$symb) {
4999: $symb=&symbread();
5000: if (!$symb) { $symb= $env{'request.url'}; }
5001: }
5002: $symb=escape($symb);
5003:
5004: if (!$namespace) {
5005: # I don't think we would ever want to store this for a course.
5006: # it seems this will only be used if we don't have a course.
5007: #$namespace=$env{'request.course.id'};
5008: #if (!$namespace) {
5009: $namespace=$env{'request.state'};
5010: #}
5011: }
5012: $namespace=~s/\//\_/g;
5013: $namespace=~s/\W//g;
5014: if (!$domain) { $domain=$env{'user.domain'}; }
5015: if (!$stuname) { $stuname=$env{'user.name'}; }
5016: if ($domain eq 'public' && $stuname eq 'public') {
5017: $stuname=$ENV{'REMOTE_ADDR'};
5018: }
5019: my $now=time;
5020: my %hash;
5021: my $path=LONCAPA::tempdir();
5022: if (tie(%hash,'GDBM_File',
5023: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
5024: &GDBM_WRCREAT(),0640)) {
5025: $hash{"version:$symb"}++;
5026: my $version=$hash{"version:$symb"};
5027: my $allkeys='';
5028: foreach my $key (keys(%$storehash)) {
5029: $allkeys.=$key.':';
5030: $hash{"$version:$symb:$key"}=&freeze_escape($$storehash{$key});
5031: }
5032: $hash{"$version:$symb:timestamp"}=$now;
5033: $allkeys.='timestamp';
5034: $hash{"$version:keys:$symb"}=$allkeys;
5035: if (untie(%hash)) {
5036: return 'ok';
5037: } else {
5038: return "error:$!";
5039: }
5040: } else {
5041: return "error:$!";
5042: }
5043: }
5044:
5045: # -----------------------------------------------------------------Temp Restore
5046:
5047: sub tmprestore {
5048: my ($symb,$namespace,$domain,$stuname) = @_;
5049:
5050: if (!$symb) {
5051: $symb=&symbread();
5052: if (!$symb) { $symb= $env{'request.url'}; }
5053: }
5054: $symb=escape($symb);
5055:
5056: if (!$namespace) { $namespace=$env{'request.state'}; }
5057:
5058: if (!$domain) { $domain=$env{'user.domain'}; }
5059: if (!$stuname) { $stuname=$env{'user.name'}; }
5060: if ($domain eq 'public' && $stuname eq 'public') {
5061: $stuname=$ENV{'REMOTE_ADDR'};
5062: }
5063: my %returnhash;
5064: $namespace=~s/\//\_/g;
5065: $namespace=~s/\W//g;
5066: my %hash;
5067: my $path=LONCAPA::tempdir();
5068: if (tie(%hash,'GDBM_File',
5069: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
5070: &GDBM_READER(),0640)) {
5071: my $version=$hash{"version:$symb"};
5072: $returnhash{'version'}=$version;
5073: my $scope;
5074: for ($scope=1;$scope<=$version;$scope++) {
5075: my $vkeys=$hash{"$scope:keys:$symb"};
5076: my @keys=split(/:/,$vkeys);
5077: my $key;
5078: $returnhash{"$scope:keys"}=$vkeys;
5079: foreach $key (@keys) {
5080: $returnhash{"$scope:$key"}=&thaw_unescape($hash{"$scope:$symb:$key"});
5081: $returnhash{"$key"}=&thaw_unescape($hash{"$scope:$symb:$key"});
5082: }
5083: }
5084: if (!(untie(%hash))) {
5085: return "error:$!";
5086: }
5087: } else {
5088: return "error:$!";
5089: }
5090: return %returnhash;
5091: }
5092:
5093: # ----------------------------------------------------------------------- Store
5094:
5095: sub store {
5096: my ($storehash,$symb,$namespace,$domain,$stuname,$laststore) = @_;
5097: my $home='';
5098:
5099: if ($stuname) { $home=&homeserver($stuname,$domain); }
5100:
5101: $symb=&symbclean($symb);
5102: if (!$symb) { unless ($symb=&symbread()) { return ''; } }
5103:
5104: if (!$domain) { $domain=$env{'user.domain'}; }
5105: if (!$stuname) { $stuname=$env{'user.name'}; }
5106:
5107: &devalidate($symb,$stuname,$domain);
5108:
5109: $symb=escape($symb);
5110: if (!$namespace) {
5111: unless ($namespace=$env{'request.course.id'}) {
5112: return '';
5113: }
5114: }
5115: if (!$home) { $home=$env{'user.home'}; }
5116:
5117: $$storehash{'ip'}=$ENV{'REMOTE_ADDR'};
5118: $$storehash{'host'}=$perlvar{'lonHostID'};
5119:
5120: my $namevalue='';
5121: foreach my $key (keys(%$storehash)) {
5122: $namevalue.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
5123: }
5124: $namevalue=~s/\&$//;
5125: &courselog($symb.':'.$stuname.':'.$domain.':STORE:'.$namevalue);
5126: return reply("store:$domain:$stuname:$namespace:$symb:$namevalue:$laststore","$home");
5127: }
5128:
5129: # -------------------------------------------------------------- Critical Store
5130:
5131: sub cstore {
5132: my ($storehash,$symb,$namespace,$domain,$stuname,$laststore) = @_;
5133: my $home='';
5134:
5135: if ($stuname) { $home=&homeserver($stuname,$domain); }
5136:
5137: $symb=&symbclean($symb);
5138: if (!$symb) { unless ($symb=&symbread()) { return ''; } }
5139:
5140: if (!$domain) { $domain=$env{'user.domain'}; }
5141: if (!$stuname) { $stuname=$env{'user.name'}; }
5142:
5143: &devalidate($symb,$stuname,$domain);
5144:
5145: $symb=escape($symb);
5146: if (!$namespace) {
5147: unless ($namespace=$env{'request.course.id'}) {
5148: return '';
5149: }
5150: }
5151: if (!$home) { $home=$env{'user.home'}; }
5152:
5153: $$storehash{'ip'}=$ENV{'REMOTE_ADDR'};
5154: $$storehash{'host'}=$perlvar{'lonHostID'};
5155:
5156: my $namevalue='';
5157: foreach my $key (keys(%$storehash)) {
5158: $namevalue.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
5159: }
5160: $namevalue=~s/\&$//;
5161: &courselog($symb.':'.$stuname.':'.$domain.':CSTORE:'.$namevalue);
5162: return critical
5163: ("store:$domain:$stuname:$namespace:$symb:$namevalue:$laststore","$home");
5164: }
5165:
5166: # --------------------------------------------------------------------- Restore
5167:
5168: sub restore {
5169: my ($symb,$namespace,$domain,$stuname) = @_;
5170: my $home='';
5171:
5172: if ($stuname) { $home=&homeserver($stuname,$domain); }
5173:
5174: if (!$symb) {
5175: return if ($namespace eq 'courserequests');
5176: unless ($symb=escape(&symbread())) { return ''; }
5177: } else {
5178: unless ($namespace eq 'courserequests') {
5179: $symb=&escape(&symbclean($symb));
5180: }
5181: }
5182: if (!$namespace) {
5183: unless ($namespace=$env{'request.course.id'}) {
5184: return '';
5185: }
5186: }
5187: if (!$domain) { $domain=$env{'user.domain'}; }
5188: if (!$stuname) { $stuname=$env{'user.name'}; }
5189: if (!$home) { $home=$env{'user.home'}; }
5190: my $answer=&reply("restore:$domain:$stuname:$namespace:$symb","$home");
5191:
5192: my %returnhash=();
5193: foreach my $line (split(/\&/,$answer)) {
5194: my ($name,$value)=split(/\=/,$line);
5195: $returnhash{&unescape($name)}=&thaw_unescape($value);
5196: }
5197: my $version;
5198: for ($version=1;$version<=$returnhash{'version'};$version++) {
5199: foreach my $item (split(/\:/,$returnhash{$version.':keys'})) {
5200: $returnhash{$item}=$returnhash{$version.':'.$item};
5201: }
5202: }
5203: return %returnhash;
5204: }
5205:
5206: # ---------------------------------------------------------- Course Description
5207: #
5208: #
5209:
5210: sub coursedescription {
5211: my ($courseid,$args)=@_;
5212: $courseid=~s/^\///;
5213: $courseid=~s/\_/\//g;
5214: my ($cdomain,$cnum)=split(/\//,$courseid);
5215: my $chome=&homeserver($cnum,$cdomain);
5216: my $normalid=$cdomain.'_'.$cnum;
5217: # need to always cache even if we get errors otherwise we keep
5218: # trying and trying and trying to get the course description.
5219: my %envhash=();
5220: my %returnhash=();
5221:
5222: my $expiretime=600;
5223: if ($env{'request.course.id'} eq $normalid) {
5224: $expiretime=120;
5225: }
5226:
5227: my $prefix='course.'.$cdomain.'_'.$cnum.'.';
5228: if (!$args->{'freshen_cache'}
5229: && ((time-$env{$prefix.'last_cache'}) < $expiretime) ) {
5230: foreach my $key (keys(%env)) {
5231: next if ($key !~ /^\Q$prefix\E(.*)/);
5232: my ($setting) = $1;
5233: $returnhash{$setting} = $env{$key};
5234: }
5235: return %returnhash;
5236: }
5237:
5238: # get the data again
5239:
5240: if (!$args->{'one_time'}) {
5241: $envhash{'course.'.$normalid.'.last_cache'}=time;
5242: }
5243:
5244: if ($chome ne 'no_host') {
5245: %returnhash=&dump('environment',$cdomain,$cnum);
5246: if (!exists($returnhash{'con_lost'})) {
5247: my $username = $env{'user.name'}; # Defult username
5248: if(defined $args->{'user'}) {
5249: $username = $args->{'user'};
5250: }
5251: $returnhash{'home'}= $chome;
5252: $returnhash{'domain'} = $cdomain;
5253: $returnhash{'num'} = $cnum;
5254: if (!defined($returnhash{'type'})) {
5255: $returnhash{'type'} = 'Course';
5256: }
5257: while (my ($name,$value) = each %returnhash) {
5258: $envhash{'course.'.$normalid.'.'.$name}=$value;
5259: }
5260: $returnhash{'url'}=&clutter($returnhash{'url'});
5261: $returnhash{'fn'}=LONCAPA::tempdir() .
5262: $username.'_'.$cdomain.'_'.$cnum;
5263: $envhash{'course.'.$normalid.'.home'}=$chome;
5264: $envhash{'course.'.$normalid.'.domain'}=$cdomain;
5265: $envhash{'course.'.$normalid.'.num'}=$cnum;
5266: }
5267: }
5268: if (!$args->{'one_time'}) {
5269: &appenv(\%envhash);
5270: }
5271: return %returnhash;
5272: }
5273:
5274: sub update_released_required {
5275: my ($needsrelease,$cdom,$cnum,$chome,$cid) = @_;
5276: if ($cdom eq '' || $cnum eq '' || $chome eq '' || $cid eq '') {
5277: $cid = $env{'request.course.id'};
5278: $cdom = $env{'course.'.$cid.'.domain'};
5279: $cnum = $env{'course.'.$cid.'.num'};
5280: $chome = $env{'course.'.$cid.'.home'};
5281: }
5282: if ($needsrelease) {
5283: my %curr_reqd_hash = &userenvironment($cdom,$cnum,'internal.releaserequired');
5284: my $needsupdate;
5285: if ($curr_reqd_hash{'internal.releaserequired'} eq '') {
5286: $needsupdate = 1;
5287: } else {
5288: my ($currmajor,$currminor) = split(/\./,$curr_reqd_hash{'internal.releaserequired'});
5289: my ($needsmajor,$needsminor) = split(/\./,$needsrelease);
5290: if (($currmajor < $needsmajor) || ($currmajor == $needsmajor && $currminor < $needsminor)) {
5291: $needsupdate = 1;
5292: }
5293: }
5294: if ($needsupdate) {
5295: my %needshash = (
5296: 'internal.releaserequired' => $needsrelease,
5297: );
5298: my $putresult = &put('environment',\%needshash,$cdom,$cnum);
5299: if ($putresult eq 'ok') {
5300: &appenv({'course.'.$cid.'.internal.releaserequired' => $needsrelease});
5301: my %crsinfo = &courseiddump($cdom,'.',1,'.','.',$cnum,undef,undef,'.');
5302: if (ref($crsinfo{$cid}) eq 'HASH') {
5303: $crsinfo{$cid}{'releaserequired'} = $needsrelease;
5304: &courseidput($cdom,\%crsinfo,$chome,'notime');
5305: }
5306: }
5307: }
5308: }
5309: return;
5310: }
5311:
5312: # -------------------------------------------------See if a user is privileged
5313:
5314: sub privileged {
5315: my ($username,$domain,$possdomains,$possroles)=@_;
5316: my $now = time;
5317: my $roles;
5318: if (ref($possroles) eq 'ARRAY') {
5319: $roles = $possroles;
5320: } else {
5321: $roles = ['dc','su'];
5322: }
5323: if (ref($possdomains) eq 'ARRAY') {
5324: my %privileged = &privileged_by_domain($possdomains,$roles);
5325: foreach my $dom (@{$possdomains}) {
5326: if (($username =~ /^$match_username$/) && ($domain =~ /^$match_domain$/) &&
5327: (ref($privileged{$dom}) eq 'HASH')) {
5328: foreach my $role (@{$roles}) {
5329: if (ref($privileged{$dom}{$role}) eq 'HASH') {
5330: if (exists($privileged{$dom}{$role}{$username.':'.$domain})) {
5331: my ($end,$start) = split(/:/,$privileged{$dom}{$role}{$username.':'.$domain});
5332: return 1 unless (($end && $end < $now) ||
5333: ($start && $start > $now));
5334: }
5335: }
5336: }
5337: }
5338: }
5339: } else {
5340: my %rolesdump = &dump("roles", $domain, $username) or return 0;
5341: my $now = time;
5342:
5343: for my $role (@rolesdump{grep { ! /^rolesdef_/ } keys(%rolesdump)}) {
5344: my ($trole, $tend, $tstart) = split(/_/, $role);
5345: if (grep(/^\Q$trole\E$/,@{$roles})) {
5346: return 1 unless ($tend && $tend < $now)
5347: or ($tstart && $tstart > $now);
5348: }
5349: }
5350: }
5351: return 0;
5352: }
5353:
5354: sub privileged_by_domain {
5355: my ($domains,$roles) = @_;
5356: my %privileged = ();
5357: my $cachetime = 60*60*24;
5358: my $now = time;
5359: unless ((ref($domains) eq 'ARRAY') && (ref($roles) eq 'ARRAY')) {
5360: return %privileged;
5361: }
5362: foreach my $dom (@{$domains}) {
5363: next if (ref($privileged{$dom}) eq 'HASH');
5364: my $needroles;
5365: foreach my $role (@{$roles}) {
5366: my ($result,$cached)=&is_cached_new('priv_'.$role,$dom);
5367: if (defined($cached)) {
5368: if (ref($result) eq 'HASH') {
5369: $privileged{$dom}{$role} = $result;
5370: }
5371: } else {
5372: $needroles = 1;
5373: }
5374: }
5375: if ($needroles) {
5376: my %dompersonnel = &get_domain_roles($dom,$roles);
5377: $privileged{$dom} = {};
5378: foreach my $server (keys(%dompersonnel)) {
5379: if (ref($dompersonnel{$server}) eq 'HASH') {
5380: foreach my $item (keys(%{$dompersonnel{$server}})) {
5381: my ($trole,$uname,$udom,$rest) = split(/:/,$item,4);
5382: my ($end,$start) = split(/:/,$dompersonnel{$server}{$item});
5383: next if ($end && $end < $now);
5384: $privileged{$dom}{$trole}{$uname.':'.$udom} =
5385: $dompersonnel{$server}{$item};
5386: }
5387: }
5388: }
5389: if (ref($privileged{$dom}) eq 'HASH') {
5390: foreach my $role (@{$roles}) {
5391: if (ref($privileged{$dom}{$role}) eq 'HASH') {
5392: &do_cache_new('priv_'.$role,$dom,$privileged{$dom}{$role},$cachetime);
5393: } else {
5394: my %hash = ();
5395: &do_cache_new('priv_'.$role,$dom,\%hash,$cachetime);
5396: }
5397: }
5398: }
5399: }
5400: }
5401: return %privileged;
5402: }
5403:
5404: # -------------------------------------------------------- Get user privileges
5405:
5406: sub rolesinit {
5407: my ($domain, $username) = @_;
5408: my %userroles = ('user.login.time' => time);
5409: my %rolesdump = &dump("roles", $domain, $username) or return \%userroles;
5410:
5411: # firstaccess and timerinterval are related to timed maps/resources.
5412: # also, blocking can be triggered by an activating timer
5413: # it's saved in the user's %env.
5414: my %firstaccess = &dump('firstaccesstimes', $domain, $username);
5415: my %timerinterval = &dump('timerinterval', $domain, $username);
5416: my (%coursetimerstarts, %firstaccchk, %firstaccenv, %coursetimerintervals,
5417: %timerintchk, %timerintenv);
5418:
5419: foreach my $key (keys(%firstaccess)) {
5420: my ($cid, $rest) = split(/\0/, $key);
5421: $coursetimerstarts{$cid}{$rest} = $firstaccess{$key};
5422: }
5423:
5424: foreach my $key (keys(%timerinterval)) {
5425: my ($cid,$rest) = split(/\0/,$key);
5426: $coursetimerintervals{$cid}{$rest} = $timerinterval{$key};
5427: }
5428:
5429: my %allroles=();
5430: my %allgroups=();
5431:
5432: for my $area (grep { ! /^rolesdef_/ } keys(%rolesdump)) {
5433: my $role = $rolesdump{$area};
5434: $area =~ s/\_\w\w$//;
5435:
5436: my ($trole, $tend, $tstart, $group_privs);
5437:
5438: if ($role =~ /^cr/) {
5439: # Custom role, defined by a user
5440: # e.g., user.role.cr/msu/smith/mynewrole
5441: if ($role =~ m|^(cr/$match_domain/$match_username/[a-zA-Z0-9]+)_(.*)$|) {
5442: $trole = $1;
5443: ($tend, $tstart) = split('_', $2);
5444: } else {
5445: $trole = $role;
5446: }
5447: } elsif ($role =~ m|^gr/|) {
5448: # Role of member in a group, defined within a course/community
5449: # e.g., user.role.gr/msu/04935610a19ee4a5fmsul1/leopards
5450: ($trole, $tend, $tstart) = split(/_/, $role);
5451: next if $tstart eq '-1';
5452: ($trole, $group_privs) = split(/\//, $trole);
5453: $group_privs = &unescape($group_privs);
5454: } else {
5455: # Just a normal role, defined in roles.tab
5456: ($trole, $tend, $tstart) = split(/_/,$role);
5457: }
5458:
5459: my %new_role = &set_arearole($trole,$area,$tstart,$tend,$domain,
5460: $username);
5461: @userroles{keys(%new_role)} = @new_role{keys(%new_role)};
5462:
5463: # role expired or not available yet?
5464: $trole = '' if ($tend != 0 && $tend < $userroles{'user.login.time'}) or
5465: ($tstart != 0 && $tstart > $userroles{'user.login.time'});
5466:
5467: next if $area eq '' or $trole eq '';
5468:
5469: my $spec = "$trole.$area";
5470: my ($tdummy, $tdomain, $trest) = split(/\//, $area);
5471:
5472: if ($trole =~ /^cr\//) {
5473: # Custom role, defined by a user
5474: &custom_roleprivs(\%allroles,$trole,$tdomain,$trest,$spec,$area);
5475: } elsif ($trole eq 'gr') {
5476: # Role of a member in a group, defined within a course/community
5477: &group_roleprivs(\%allgroups,$area,$group_privs,$tend,$tstart);
5478: next;
5479: } else {
5480: # Normal role, defined in roles.tab
5481: &standard_roleprivs(\%allroles,$trole,$tdomain,$spec,$trest,$area);
5482: }
5483:
5484: my $cid = $tdomain.'_'.$trest;
5485: unless ($firstaccchk{$cid}) {
5486: if (ref($coursetimerstarts{$cid}) eq 'HASH') {
5487: foreach my $item (keys(%{$coursetimerstarts{$cid}})) {
5488: $firstaccenv{'course.'.$cid.'.firstaccess.'.$item} =
5489: $coursetimerstarts{$cid}{$item};
5490: }
5491: }
5492: $firstaccchk{$cid} = 1;
5493: }
5494: unless ($timerintchk{$cid}) {
5495: if (ref($coursetimerintervals{$cid}) eq 'HASH') {
5496: foreach my $item (keys(%{$coursetimerintervals{$cid}})) {
5497: $timerintenv{'course.'.$cid.'.timerinterval.'.$item} =
5498: $coursetimerintervals{$cid}{$item};
5499: }
5500: }
5501: $timerintchk{$cid} = 1;
5502: }
5503: }
5504:
5505: @userroles{'user.author', 'user.adv'} = &set_userprivs(\%userroles,
5506: \%allroles, \%allgroups);
5507: $env{'user.adv'} = $userroles{'user.adv'};
5508:
5509: return (\%userroles,\%firstaccenv,\%timerintenv);
5510: }
5511:
5512: sub set_arearole {
5513: my ($trole,$area,$tstart,$tend,$domain,$username,$nolog) = @_;
5514: unless ($nolog) {
5515: # log the associated role with the area
5516: &userrolelog($trole,$username,$domain,$area,$tstart,$tend);
5517: }
5518: return ('user.role.'.$trole.'.'.$area => $tstart.'.'.$tend);
5519: }
5520:
5521: sub custom_roleprivs {
5522: my ($allroles,$trole,$tdomain,$trest,$spec,$area) = @_;
5523: my ($rdummy,$rdomain,$rauthor,$rrole)=split(/\//,$trole);
5524: my $homsvr = &homeserver($rauthor,$rdomain);
5525: if (&hostname($homsvr) ne '') {
5526: my ($rdummy,$roledef)=
5527: &get('roles',["rolesdef_$rrole"],$rdomain,$rauthor);
5528: if (($rdummy ne 'con_lost') && ($roledef ne '')) {
5529: my ($syspriv,$dompriv,$coursepriv)=split(/\_/,$roledef);
5530: if (defined($syspriv)) {
5531: if ($trest =~ /^$match_community$/) {
5532: $syspriv =~ s/bre\&S//;
5533: }
5534: $$allroles{'cm./'}.=':'.$syspriv;
5535: $$allroles{$spec.'./'}.=':'.$syspriv;
5536: }
5537: if ($tdomain ne '') {
5538: if (defined($dompriv)) {
5539: $$allroles{'cm./'.$tdomain.'/'}.=':'.$dompriv;
5540: $$allroles{$spec.'./'.$tdomain.'/'}.=':'.$dompriv;
5541: }
5542: if (($trest ne '') && (defined($coursepriv))) {
5543: $$allroles{'cm.'.$area}.=':'.$coursepriv;
5544: $$allroles{$spec.'.'.$area}.=':'.$coursepriv;
5545: }
5546: }
5547: }
5548: }
5549: }
5550:
5551: sub group_roleprivs {
5552: my ($allgroups,$area,$group_privs,$tend,$tstart) = @_;
5553: my $access = 1;
5554: my $now = time;
5555: if (($tend!=0) && ($tend<$now)) { $access = 0; }
5556: if (($tstart!=0) && ($tstart>$now)) { $access=0; }
5557: if ($access) {
5558: my ($course,$group) = ($area =~ m|(/$match_domain/$match_courseid)/([^/]+)$|);
5559: $$allgroups{$course}{$group} .=':'.$group_privs;
5560: }
5561: }
5562:
5563: sub standard_roleprivs {
5564: my ($allroles,$trole,$tdomain,$spec,$trest,$area) = @_;
5565: if (defined($pr{$trole.':s'})) {
5566: $$allroles{'cm./'}.=':'.$pr{$trole.':s'};
5567: $$allroles{$spec.'./'}.=':'.$pr{$trole.':s'};
5568: }
5569: if ($tdomain ne '') {
5570: if (defined($pr{$trole.':d'})) {
5571: $$allroles{'cm./'.$tdomain.'/'}.=':'.$pr{$trole.':d'};
5572: $$allroles{$spec.'./'.$tdomain.'/'}.=':'.$pr{$trole.':d'};
5573: }
5574: if (($trest ne '') && (defined($pr{$trole.':c'}))) {
5575: $$allroles{'cm.'.$area}.=':'.$pr{$trole.':c'};
5576: $$allroles{$spec.'.'.$area}.=':'.$pr{$trole.':c'};
5577: }
5578: }
5579: }
5580:
5581: sub set_userprivs {
5582: my ($userroles,$allroles,$allgroups,$groups_roles) = @_;
5583: my $author=0;
5584: my $adv=0;
5585: my %grouproles = ();
5586: if (keys(%{$allgroups}) > 0) {
5587: my @groupkeys;
5588: foreach my $role (keys(%{$allroles})) {
5589: push(@groupkeys,$role);
5590: }
5591: if (ref($groups_roles) eq 'HASH') {
5592: foreach my $key (keys(%{$groups_roles})) {
5593: unless (grep(/^\Q$key\E$/,@groupkeys)) {
5594: push(@groupkeys,$key);
5595: }
5596: }
5597: }
5598: if (@groupkeys > 0) {
5599: foreach my $role (@groupkeys) {
5600: my ($trole,$area,$sec,$extendedarea);
5601: if ($role =~ m-^(\w+|cr/$match_domain/$match_username/\w+)\.(/$match_domain/$match_courseid)(/?\w*)\.-) {
5602: $trole = $1;
5603: $area = $2;
5604: $sec = $3;
5605: $extendedarea = $area.$sec;
5606: if (exists($$allgroups{$area})) {
5607: foreach my $group (keys(%{$$allgroups{$area}})) {
5608: my $spec = $trole.'.'.$extendedarea;
5609: $grouproles{$spec.'.'.$area.'/'.$group} =
5610: $$allgroups{$area}{$group};
5611: }
5612: }
5613: }
5614: }
5615: }
5616: }
5617: foreach my $group (keys(%grouproles)) {
5618: $$allroles{$group} = $grouproles{$group};
5619: }
5620: foreach my $role (keys(%{$allroles})) {
5621: my %thesepriv;
5622: if (($role=~/^au/) || ($role=~/^ca/) || ($role=~/^aa/)) { $author=1; }
5623: foreach my $item (split(/:/,$$allroles{$role})) {
5624: if ($item ne '') {
5625: my ($privilege,$restrictions)=split(/&/,$item);
5626: if ($restrictions eq '') {
5627: $thesepriv{$privilege}='F';
5628: } elsif ($thesepriv{$privilege} ne 'F') {
5629: $thesepriv{$privilege}.=$restrictions;
5630: }
5631: if ($thesepriv{'adv'} eq 'F') { $adv=1; }
5632: }
5633: }
5634: my $thesestr='';
5635: foreach my $priv (sort(keys(%thesepriv))) {
5636: $thesestr.=':'.$priv.'&'.$thesepriv{$priv};
5637: }
5638: $userroles->{'user.priv.'.$role} = $thesestr;
5639: }
5640: return ($author,$adv);
5641: }
5642:
5643: sub role_status {
5644: my ($rolekey,$update,$refresh,$now,$role,$where,$trolecode,$tstatus,$tstart,$tend) = @_;
5645: if (exists($env{$rolekey}) && $env{$rolekey} ne '') {
5646: my ($one,$two) = split(m{\./},$rolekey,2);
5647: (undef,undef,$$role) = split(/\./,$one,3);
5648: unless (!defined($$role) || $$role eq '') {
5649: $$where = '/'.$two;
5650: $$trolecode=$$role.'.'.$$where;
5651: ($$tstart,$$tend)=split(/\./,$env{$rolekey});
5652: $$tstatus='is';
5653: if ($$tstart && $$tstart>$update) {
5654: $$tstatus='future';
5655: if ($$tstart<$now) {
5656: if ($$tstart && $$tstart>$refresh) {
5657: if (($$where ne '') && ($$role ne '')) {
5658: my (%allroles,%allgroups,$group_privs,
5659: %groups_roles,@rolecodes);
5660: my %userroles = (
5661: 'user.role.'.$$role.'.'.$$where => $$tstart.'.'.$$tend
5662: );
5663: @rolecodes = ('cm');
5664: my $spec=$$role.'.'.$$where;
5665: my ($tdummy,$tdomain,$trest)=split(/\//,$$where);
5666: if ($$role =~ /^cr\//) {
5667: &custom_roleprivs(\%allroles,$$role,$tdomain,$trest,$spec,$$where);
5668: push(@rolecodes,'cr');
5669: } elsif ($$role eq 'gr') {
5670: push(@rolecodes,$$role);
5671: my %rolehash = &get('roles',[$$where.'_'.$$role],$env{'user.domain'},
5672: $env{'user.name'});
5673: my ($trole) = split('_',$rolehash{$$where.'_'.$$role},2);
5674: (undef,my $group_privs) = split(/\//,$trole);
5675: $group_privs = &unescape($group_privs);
5676: &group_roleprivs(\%allgroups,$$where,$group_privs,$$tend,$$tstart);
5677: my %course_roles = &get_my_roles($env{'user.name'},$env{'user.domain'},'userroles',['active'],['cc','co','in','ta','ep','ad','st','cr'],[$tdomain],1);
5678: &get_groups_roles($tdomain,$trest,
5679: \%course_roles,\@rolecodes,
5680: \%groups_roles);
5681: } else {
5682: push(@rolecodes,$$role);
5683: &standard_roleprivs(\%allroles,$$role,$tdomain,$spec,$trest,$$where);
5684: }
5685: my ($author,$adv)= &set_userprivs(\%userroles,\%allroles,\%allgroups,\%groups_roles);
5686: &appenv(\%userroles,\@rolecodes);
5687: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},"Role ".$role);
5688: }
5689: }
5690: $$tstatus = 'is';
5691: }
5692: }
5693: if ($$tend) {
5694: if ($$tend<$update) {
5695: $$tstatus='expired';
5696: } elsif ($$tend<$now) {
5697: $$tstatus='will_not';
5698: }
5699: }
5700: }
5701: }
5702: }
5703:
5704: sub get_groups_roles {
5705: my ($cdom,$rest,$cdom_courseroles,$rolecodes,$groups_roles) = @_;
5706: return unless((ref($cdom_courseroles) eq 'HASH') &&
5707: (ref($rolecodes) eq 'ARRAY') &&
5708: (ref($groups_roles) eq 'HASH'));
5709: if (keys(%{$cdom_courseroles}) > 0) {
5710: my ($cnum) = ($rest =~ /^($match_courseid)/);
5711: if ($cdom ne '' && $cnum ne '') {
5712: foreach my $key (keys(%{$cdom_courseroles})) {
5713: if ($key =~ /^\Q$cnum\E:\Q$cdom\E:([^:]+):?([^:]*)/) {
5714: my $crsrole = $1;
5715: my $crssec = $2;
5716: if ($crsrole =~ /^cr/) {
5717: unless (grep(/^cr$/,@{$rolecodes})) {
5718: push(@{$rolecodes},'cr');
5719: }
5720: } else {
5721: unless(grep(/^\Q$crsrole\E$/,@{$rolecodes})) {
5722: push(@{$rolecodes},$crsrole);
5723: }
5724: }
5725: my $rolekey = "$crsrole./$cdom/$cnum";
5726: if ($crssec ne '') {
5727: $rolekey .= "/$crssec";
5728: }
5729: $rolekey .= './';
5730: $groups_roles->{$rolekey} = $rolecodes;
5731: }
5732: }
5733: }
5734: }
5735: return;
5736: }
5737:
5738: sub delete_env_groupprivs {
5739: my ($where,$courseroles,$possroles) = @_;
5740: return unless((ref($courseroles) eq 'HASH') && (ref($possroles) eq 'ARRAY'));
5741: my ($dummy,$udom,$uname,$group) = split(/\//,$where);
5742: unless (ref($courseroles->{$udom}) eq 'HASH') {
5743: %{$courseroles->{$udom}} =
5744: &get_my_roles('','','userroles',['active'],
5745: $possroles,[$udom],1);
5746: }
5747: if (ref($courseroles->{$udom}) eq 'HASH') {
5748: foreach my $item (keys(%{$courseroles->{$udom}})) {
5749: my ($cnum,$cdom,$crsrole,$crssec) = split(/:/,$item);
5750: my $area = '/'.$cdom.'/'.$cnum;
5751: my $privkey = "user.priv.$crsrole.$area";
5752: if ($crssec ne '') {
5753: $privkey .= '/'.$crssec;
5754: }
5755: $privkey .= ".$area/$group";
5756: &Apache::lonnet::delenv($privkey,undef,[$crsrole]);
5757: }
5758: }
5759: return;
5760: }
5761:
5762: sub check_adhoc_privs {
5763: my ($cdom,$cnum,$update,$refresh,$now,$checkrole,$caller) = @_;
5764: my $cckey = 'user.role.'.$checkrole.'./'.$cdom.'/'.$cnum;
5765: my $setprivs;
5766: if ($env{$cckey}) {
5767: my ($role,$where,$trolecode,$tstart,$tend,$tremark,$tstatus,$tpstart,$tpend);
5768: &role_status($cckey,$update,$refresh,$now,\$role,\$where,\$trolecode,\$tstatus,\$tstart,\$tend);
5769: unless (($tstatus eq 'is') || ($tstatus eq 'will_not')) {
5770: &set_adhoc_privileges($cdom,$cnum,$checkrole,$caller);
5771: $setprivs = 1;
5772: }
5773: } else {
5774: &set_adhoc_privileges($cdom,$cnum,$checkrole,$caller);
5775: $setprivs = 1;
5776: }
5777: return $setprivs;
5778: }
5779:
5780: sub set_adhoc_privileges {
5781: # role can be cc or ca
5782: my ($dcdom,$pickedcourse,$role,$caller) = @_;
5783: my $area = '/'.$dcdom.'/'.$pickedcourse;
5784: my $spec = $role.'.'.$area;
5785: my %userroles = &set_arearole($role,$area,'','',$env{'user.domain'},
5786: $env{'user.name'},1);
5787: my %ccrole = ();
5788: &standard_roleprivs(\%ccrole,$role,$dcdom,$spec,$pickedcourse,$area);
5789: my ($author,$adv)= &set_userprivs(\%userroles,\%ccrole);
5790: &appenv(\%userroles,[$role,'cm']);
5791: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},"Role ".$role);
5792: unless ($caller eq 'constructaccess' && $env{'request.course.id'}) {
5793: &appenv( {'request.role' => $spec,
5794: 'request.role.domain' => $dcdom,
5795: 'request.course.sec' => ''
5796: }
5797: );
5798: my $tadv=0;
5799: if (&allowed('adv') eq 'F') { $tadv=1; }
5800: &appenv({'request.role.adv' => $tadv});
5801: }
5802: }
5803:
5804: # --------------------------------------------------------------- get interface
5805:
5806: sub get {
5807: my ($namespace,$storearr,$udomain,$uname)=@_;
5808: my $items='';
5809: foreach my $item (@$storearr) {
5810: $items.=&escape($item).'&';
5811: }
5812: $items=~s/\&$//;
5813: if (!$udomain) { $udomain=$env{'user.domain'}; }
5814: if (!$uname) { $uname=$env{'user.name'}; }
5815: my $uhome=&homeserver($uname,$udomain);
5816:
5817: my $rep=&reply("get:$udomain:$uname:$namespace:$items",$uhome);
5818: my @pairs=split(/\&/,$rep);
5819: if ( $#pairs==0 && $pairs[0] =~ /^(con_lost|error|no_such_host)/i) {
5820: return @pairs;
5821: }
5822: my %returnhash=();
5823: my $i=0;
5824: foreach my $item (@$storearr) {
5825: $returnhash{$item}=&thaw_unescape($pairs[$i]);
5826: $i++;
5827: }
5828: return %returnhash;
5829: }
5830:
5831: # --------------------------------------------------------------- del interface
5832:
5833: sub del {
5834: my ($namespace,$storearr,$udomain,$uname)=@_;
5835: my $items='';
5836: foreach my $item (@$storearr) {
5837: $items.=&escape($item).'&';
5838: }
5839:
5840: $items=~s/\&$//;
5841: if (!$udomain) { $udomain=$env{'user.domain'}; }
5842: if (!$uname) { $uname=$env{'user.name'}; }
5843: my $uhome=&homeserver($uname,$udomain);
5844: return &reply("del:$udomain:$uname:$namespace:$items",$uhome);
5845: }
5846:
5847: # -------------------------------------------------------------- dump interface
5848:
5849: sub unserialize {
5850: my ($rep, $escapedkeys) = @_;
5851:
5852: return {} if $rep =~ /^error/;
5853:
5854: my %returnhash=();
5855: foreach my $item (split(/\&/,$rep)) {
5856: my ($key, $value) = split(/=/, $item, 2);
5857: $key = unescape($key) unless $escapedkeys;
5858: next if $key =~ /^error: 2 /;
5859: $returnhash{$key} = &thaw_unescape($value);
5860: }
5861: #return %returnhash;
5862: return \%returnhash;
5863: }
5864:
5865: # see Lond::dump_with_regexp
5866: # if $escapedkeys hash keys won't get unescaped.
5867: sub dump {
5868: my ($namespace,$udomain,$uname,$regexp,$range,$escapedkeys)=@_;
5869: if (!$udomain) { $udomain=$env{'user.domain'}; }
5870: if (!$uname) { $uname=$env{'user.name'}; }
5871: my $uhome=&homeserver($uname,$udomain);
5872:
5873: if ($regexp) {
5874: $regexp=&escape($regexp);
5875: } else {
5876: $regexp='.';
5877: }
5878: if (grep { $_ eq $uhome } current_machine_ids()) {
5879: # user is hosted on this machine
5880: my $reply = LONCAPA::Lond::dump_with_regexp(join(":", ($udomain,
5881: $uname, $namespace, $regexp, $range)), $perlvar{'lonVersion'});
5882: return %{unserialize($reply, $escapedkeys)};
5883: }
5884: my $rep=&reply("dump:$udomain:$uname:$namespace:$regexp:$range",$uhome);
5885: my @pairs=split(/\&/,$rep);
5886: my %returnhash=();
5887: if (!($rep =~ /^error/ )) {
5888: foreach my $item (@pairs) {
5889: my ($key,$value)=split(/=/,$item,2);
5890: $key = unescape($key) unless $escapedkeys;
5891: #$key = &unescape($key);
5892: next if ($key =~ /^error: 2 /);
5893: $returnhash{$key}=&thaw_unescape($value);
5894: }
5895: }
5896: return %returnhash;
5897: }
5898:
5899:
5900: # --------------------------------------------------------- dumpstore interface
5901:
5902: sub dumpstore {
5903: my ($namespace,$udomain,$uname,$regexp,$range)=@_;
5904: # same as dump but keys must be escaped. They may contain colon separated
5905: # lists of values that may themself contain colons (e.g. symbs).
5906: return &dump($namespace, $udomain, $uname, $regexp, $range, 1);
5907: }
5908:
5909: # -------------------------------------------------------------- keys interface
5910:
5911: sub getkeys {
5912: my ($namespace,$udomain,$uname)=@_;
5913: if (!$udomain) { $udomain=$env{'user.domain'}; }
5914: if (!$uname) { $uname=$env{'user.name'}; }
5915: my $uhome=&homeserver($uname,$udomain);
5916: my $rep=reply("keys:$udomain:$uname:$namespace",$uhome);
5917: my @keyarray=();
5918: foreach my $key (split(/\&/,$rep)) {
5919: next if ($key =~ /^error: 2 /);
5920: push(@keyarray,&unescape($key));
5921: }
5922: return @keyarray;
5923: }
5924:
5925: # --------------------------------------------------------------- currentdump
5926: sub currentdump {
5927: my ($courseid,$sdom,$sname)=@_;
5928: $courseid = $env{'request.course.id'} if (! defined($courseid));
5929: $sdom = $env{'user.domain'} if (! defined($sdom));
5930: $sname = $env{'user.name'} if (! defined($sname));
5931: my $uhome = &homeserver($sname,$sdom);
5932: my $rep;
5933:
5934: if (grep { $_ eq $uhome } current_machine_ids()) {
5935: $rep = LONCAPA::Lond::dump_profile_database(join(":", ($sdom, $sname,
5936: $courseid)));
5937: } else {
5938: $rep = reply('currentdump:'.$sdom.':'.$sname.':'.$courseid,$uhome);
5939: }
5940:
5941: return if ($rep =~ /^(error:|no_such_host)/);
5942: #
5943: my %returnhash=();
5944: #
5945: if ($rep eq "unknown_cmd") {
5946: # an old lond will not know currentdump
5947: # Do a dump and make it look like a currentdump
5948: my @tmp = &dumpstore($courseid,$sdom,$sname,'.');
5949: return if ($tmp[0] =~ /^(error:|no_such_host)/);
5950: my %hash = @tmp;
5951: @tmp=();
5952: %returnhash = %{&convert_dump_to_currentdump(\%hash)};
5953: } else {
5954: my @pairs=split(/\&/,$rep);
5955: foreach my $pair (@pairs) {
5956: my ($key,$value)=split(/=/,$pair,2);
5957: my ($symb,$param) = split(/:/,$key);
5958: $returnhash{&unescape($symb)}->{&unescape($param)} =
5959: &thaw_unescape($value);
5960: }
5961: }
5962: return %returnhash;
5963: }
5964:
5965: sub convert_dump_to_currentdump{
5966: my %hash = %{shift()};
5967: my %returnhash;
5968: # Code ripped from lond, essentially. The only difference
5969: # here is the unescaping done by lonnet::dump(). Conceivably
5970: # we might run in to problems with parameter names =~ /^v\./
5971: while (my ($key,$value) = each(%hash)) {
5972: my ($v,$symb,$param) = split(/:/,$key);
5973: $symb = &unescape($symb);
5974: $param = &unescape($param);
5975: next if ($v eq 'version' || $symb eq 'keys');
5976: next if (exists($returnhash{$symb}) &&
5977: exists($returnhash{$symb}->{$param}) &&
5978: $returnhash{$symb}->{'v.'.$param} > $v);
5979: $returnhash{$symb}->{$param}=$value;
5980: $returnhash{$symb}->{'v.'.$param}=$v;
5981: }
5982: #
5983: # Remove all of the keys in the hashes which keep track of
5984: # the version of the parameter.
5985: while (my ($symb,$param_hash) = each(%returnhash)) {
5986: # use a foreach because we are going to delete from the hash.
5987: foreach my $key (keys(%$param_hash)) {
5988: delete($param_hash->{$key}) if ($key =~ /^v\./);
5989: }
5990: }
5991: return \%returnhash;
5992: }
5993:
5994: # ------------------------------------------------------ critical inc interface
5995:
5996: sub cinc {
5997: return &inc(@_,'critical');
5998: }
5999:
6000: # --------------------------------------------------------------- inc interface
6001:
6002: sub inc {
6003: my ($namespace,$store,$udomain,$uname,$critical) = @_;
6004: if (!$udomain) { $udomain=$env{'user.domain'}; }
6005: if (!$uname) { $uname=$env{'user.name'}; }
6006: my $uhome=&homeserver($uname,$udomain);
6007: my $items='';
6008: if (! ref($store)) {
6009: # got a single value, so use that instead
6010: $items = &escape($store).'=&';
6011: } elsif (ref($store) eq 'SCALAR') {
6012: $items = &escape($$store).'=&';
6013: } elsif (ref($store) eq 'ARRAY') {
6014: $items = join('=&',map {&escape($_);} @{$store});
6015: } elsif (ref($store) eq 'HASH') {
6016: while (my($key,$value) = each(%{$store})) {
6017: $items.= &escape($key).'='.&escape($value).'&';
6018: }
6019: }
6020: $items=~s/\&$//;
6021: if ($critical) {
6022: return &critical("inc:$udomain:$uname:$namespace:$items",$uhome);
6023: } else {
6024: return &reply("inc:$udomain:$uname:$namespace:$items",$uhome);
6025: }
6026: }
6027:
6028: # --------------------------------------------------------------- put interface
6029:
6030: sub put {
6031: my ($namespace,$storehash,$udomain,$uname)=@_;
6032: if (!$udomain) { $udomain=$env{'user.domain'}; }
6033: if (!$uname) { $uname=$env{'user.name'}; }
6034: my $uhome=&homeserver($uname,$udomain);
6035: my $items='';
6036: foreach my $item (keys(%$storehash)) {
6037: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
6038: }
6039: $items=~s/\&$//;
6040: return &reply("put:$udomain:$uname:$namespace:$items",$uhome);
6041: }
6042:
6043: # ------------------------------------------------------------ newput interface
6044:
6045: sub newput {
6046: my ($namespace,$storehash,$udomain,$uname)=@_;
6047: if (!$udomain) { $udomain=$env{'user.domain'}; }
6048: if (!$uname) { $uname=$env{'user.name'}; }
6049: my $uhome=&homeserver($uname,$udomain);
6050: my $items='';
6051: foreach my $key (keys(%$storehash)) {
6052: $items.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
6053: }
6054: $items=~s/\&$//;
6055: return &reply("newput:$udomain:$uname:$namespace:$items",$uhome);
6056: }
6057:
6058: # --------------------------------------------------------- putstore interface
6059:
6060: sub putstore {
6061: my ($namespace,$symb,$version,$storehash,$udomain,$uname,$tolog)=@_;
6062: if (!$udomain) { $udomain=$env{'user.domain'}; }
6063: if (!$uname) { $uname=$env{'user.name'}; }
6064: my $uhome=&homeserver($uname,$udomain);
6065: my $items='';
6066: foreach my $key (keys(%$storehash)) {
6067: $items.= &escape($key).'='.&freeze_escape($storehash->{$key}).'&';
6068: }
6069: $items=~s/\&$//;
6070: my $esc_symb=&escape($symb);
6071: my $esc_v=&escape($version);
6072: my $reply =
6073: &reply("putstore:$udomain:$uname:$namespace:$esc_symb:$esc_v:$items",
6074: $uhome);
6075: if (($tolog) && ($reply eq 'ok')) {
6076: my $namevalue='';
6077: foreach my $key (keys(%{$storehash})) {
6078: $namevalue.=&escape($key).'='.&freeze_escape($storehash->{$key}).'&';
6079: }
6080: $namevalue .= 'ip='.&escape($ENV{'REMOTE_ADDR'}).
6081: '&host='.&escape($perlvar{'lonHostID'}).
6082: '&version='.$esc_v.
6083: '&by='.&escape($env{'user.name'}.':'.$env{'user.domain'});
6084: &Apache::lonnet::courselog($symb.':'.$uname.':'.$udomain.':PUTSTORE:'.$namevalue);
6085: }
6086: if ($reply eq 'unknown_cmd') {
6087: # gfall back to way things use to be done
6088: return &old_putstore($namespace,$symb,$version,$storehash,$udomain,
6089: $uname);
6090: }
6091: return $reply;
6092: }
6093:
6094: sub old_putstore {
6095: my ($namespace,$symb,$version,$storehash,$udomain,$uname)=@_;
6096: if (!$udomain) { $udomain=$env{'user.domain'}; }
6097: if (!$uname) { $uname=$env{'user.name'}; }
6098: my $uhome=&homeserver($uname,$udomain);
6099: my %newstorehash;
6100: foreach my $item (keys(%$storehash)) {
6101: my $key = $version.':'.&escape($symb).':'.$item;
6102: $newstorehash{$key} = $storehash->{$item};
6103: }
6104: my $items='';
6105: my %allitems = ();
6106: foreach my $item (keys(%newstorehash)) {
6107: if ($item =~ m/^([^\:]+):([^\:]+):([^\:]+)$/) {
6108: my $key = $1.':keys:'.$2;
6109: $allitems{$key} .= $3.':';
6110: }
6111: $items.=$item.'='.&freeze_escape($newstorehash{$item}).'&';
6112: }
6113: foreach my $item (keys(%allitems)) {
6114: $allitems{$item} =~ s/\:$//;
6115: $items.= $item.'='.$allitems{$item}.'&';
6116: }
6117: $items=~s/\&$//;
6118: return &reply("put:$udomain:$uname:$namespace:$items",$uhome);
6119: }
6120:
6121: # ------------------------------------------------------ critical put interface
6122:
6123: sub cput {
6124: my ($namespace,$storehash,$udomain,$uname)=@_;
6125: if (!$udomain) { $udomain=$env{'user.domain'}; }
6126: if (!$uname) { $uname=$env{'user.name'}; }
6127: my $uhome=&homeserver($uname,$udomain);
6128: my $items='';
6129: foreach my $item (keys(%$storehash)) {
6130: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
6131: }
6132: $items=~s/\&$//;
6133: return &critical("put:$udomain:$uname:$namespace:$items",$uhome);
6134: }
6135:
6136: # -------------------------------------------------------------- eget interface
6137:
6138: sub eget {
6139: my ($namespace,$storearr,$udomain,$uname)=@_;
6140: my $items='';
6141: foreach my $item (@$storearr) {
6142: $items.=&escape($item).'&';
6143: }
6144: $items=~s/\&$//;
6145: if (!$udomain) { $udomain=$env{'user.domain'}; }
6146: if (!$uname) { $uname=$env{'user.name'}; }
6147: my $uhome=&homeserver($uname,$udomain);
6148: my $rep=&reply("eget:$udomain:$uname:$namespace:$items",$uhome);
6149: my @pairs=split(/\&/,$rep);
6150: my %returnhash=();
6151: my $i=0;
6152: foreach my $item (@$storearr) {
6153: $returnhash{$item}=&thaw_unescape($pairs[$i]);
6154: $i++;
6155: }
6156: return %returnhash;
6157: }
6158:
6159: # ------------------------------------------------------------ tmpput interface
6160: sub tmpput {
6161: my ($storehash,$server,$context)=@_;
6162: my $items='';
6163: foreach my $item (keys(%$storehash)) {
6164: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
6165: }
6166: $items=~s/\&$//;
6167: if (defined($context)) {
6168: $items .= ':'.&escape($context);
6169: }
6170: return &reply("tmpput:$items",$server);
6171: }
6172:
6173: # ------------------------------------------------------------ tmpget interface
6174: sub tmpget {
6175: my ($token,$server)=@_;
6176: if (!defined($server)) { $server = $perlvar{'lonHostID'}; }
6177: my $rep=&reply("tmpget:$token",$server);
6178: my %returnhash;
6179: foreach my $item (split(/\&/,$rep)) {
6180: my ($key,$value)=split(/=/,$item);
6181: next if ($key =~ /^error: 2 /);
6182: $returnhash{&unescape($key)}=&thaw_unescape($value);
6183: }
6184: return %returnhash;
6185: }
6186:
6187: # ------------------------------------------------------------ tmpdel interface
6188: sub tmpdel {
6189: my ($token,$server)=@_;
6190: if (!defined($server)) { $server = $perlvar{'lonHostID'}; }
6191: return &reply("tmpdel:$token",$server);
6192: }
6193:
6194: # ------------------------------------------------------------ get_timebased_id
6195:
6196: sub get_timebased_id {
6197: my ($prefix,$keyid,$namespace,$cdom,$cnum,$idtype,$who,$locktries,
6198: $maxtries) = @_;
6199: my ($newid,$error,$dellock);
6200: unless (($prefix =~ /^\w+$/) && ($keyid =~ /^\w+$/) && ($namespace ne '')) {
6201: return ('','ok','invalid call to get suffix');
6202: }
6203:
6204: # set defaults for any optional args for which values were not supplied
6205: if ($who eq '') {
6206: $who = $env{'user.name'}.':'.$env{'user.domain'};
6207: }
6208: if (!$locktries) {
6209: $locktries = 3;
6210: }
6211: if (!$maxtries) {
6212: $maxtries = 10;
6213: }
6214:
6215: if (($cdom eq '') || ($cnum eq '')) {
6216: if ($env{'request.course.id'}) {
6217: $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
6218: $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
6219: }
6220: if (($cdom eq '') || ($cnum eq '')) {
6221: return ('','ok','call to get suffix not in course context');
6222: }
6223: }
6224:
6225: # construct locking item
6226: my $lockhash = {
6227: $prefix."\0".'locked_'.$keyid => $who,
6228: };
6229: my $tries = 0;
6230:
6231: # attempt to get lock on nohist_$namespace file
6232: my $gotlock = &Apache::lonnet::newput('nohist_'.$namespace,$lockhash,$cdom,$cnum);
6233: while (($gotlock ne 'ok') && $tries <$locktries) {
6234: $tries ++;
6235: sleep 1;
6236: $gotlock = &Apache::lonnet::newput('nohist_'.$namespace,$lockhash,$cdom,$cnum);
6237: }
6238:
6239: # attempt to get unique identifier, based on current timestamp
6240: if ($gotlock eq 'ok') {
6241: my %inuse = &Apache::lonnet::dump('nohist_'.$namespace,$cdom,$cnum,$prefix);
6242: my $id = time;
6243: $newid = $id;
6244: if ($idtype eq 'addcode') {
6245: $newid .= &sixnum_code();
6246: }
6247: my $idtries = 0;
6248: while (exists($inuse{$prefix."\0".$newid}) && $idtries < $maxtries) {
6249: if ($idtype eq 'concat') {
6250: $newid = $id.$idtries;
6251: } elsif ($idtype eq 'addcode') {
6252: $newid = $newid.&sixnum_code();
6253: } else {
6254: $newid ++;
6255: }
6256: $idtries ++;
6257: }
6258: if (!exists($inuse{$prefix."\0".$newid})) {
6259: my %new_item = (
6260: $prefix."\0".$newid => $who,
6261: );
6262: my $putresult = &Apache::lonnet::put('nohist_'.$namespace,\%new_item,
6263: $cdom,$cnum);
6264: if ($putresult ne 'ok') {
6265: undef($newid);
6266: $error = 'error saving new item: '.$putresult;
6267: }
6268: } else {
6269: undef($newid);
6270: $error = ('error: no unique suffix available for the new item ');
6271: }
6272: # remove lock
6273: my @del_lock = ($prefix."\0".'locked_'.$keyid);
6274: $dellock = &Apache::lonnet::del('nohist_'.$namespace,\@del_lock,$cdom,$cnum);
6275: } else {
6276: $error = "error: could not obtain lockfile\n";
6277: $dellock = 'ok';
6278: if (($prefix eq 'paste') && ($namespace eq 'courseeditor') && ($keyid eq 'num')) {
6279: $dellock = 'nolock';
6280: }
6281: }
6282: return ($newid,$dellock,$error);
6283: }
6284:
6285: sub sixnum_code {
6286: my $code;
6287: for (0..6) {
6288: $code .= int( rand(9) );
6289: }
6290: return $code;
6291: }
6292:
6293: # -------------------------------------------------- portfolio access checking
6294:
6295: sub portfolio_access {
6296: my ($requrl,$clientip) = @_;
6297: my (undef,$udom,$unum,$file_name,$group) = &parse_portfolio_url($requrl);
6298: my $result = &get_portfolio_access($udom,$unum,$file_name,$group,$clientip);
6299: if ($result) {
6300: my %setters;
6301: if ($env{'user.name'} eq 'public' && $env{'user.domain'} eq 'public') {
6302: my ($startblock,$endblock) =
6303: &Apache::loncommon::blockcheck(\%setters,'port',$unum,$udom);
6304: if ($startblock && $endblock) {
6305: return 'B';
6306: }
6307: } else {
6308: my ($startblock,$endblock) =
6309: &Apache::loncommon::blockcheck(\%setters,'port');
6310: if ($startblock && $endblock) {
6311: return 'B';
6312: }
6313: }
6314: }
6315: if ($result eq 'ok') {
6316: return 'F';
6317: } elsif ($result =~ /^[^:]+:guest_/) {
6318: return 'A';
6319: }
6320: return '';
6321: }
6322:
6323: sub get_portfolio_access {
6324: my ($udom,$unum,$file_name,$group,$clientip,$access_hash) = @_;
6325:
6326: if (!ref($access_hash)) {
6327: my $current_perms = &get_portfile_permissions($udom,$unum);
6328: my %access_controls = &get_access_controls($current_perms,$group,
6329: $file_name);
6330: $access_hash = $access_controls{$file_name};
6331: }
6332:
6333: my ($public,$guest,@domains,@users,@courses,@groups,@ips);
6334: my $now = time;
6335: if (ref($access_hash) eq 'HASH') {
6336: foreach my $key (keys(%{$access_hash})) {
6337: my ($num,$scope,$end,$start) = ($key =~ /^([^:]+):([a-z]+)_(\d*)_?(\d*)$/);
6338: if ($start > $now) {
6339: next;
6340: }
6341: if ($end && $end<$now) {
6342: next;
6343: }
6344: if ($scope eq 'public') {
6345: $public = $key;
6346: last;
6347: } elsif ($scope eq 'guest') {
6348: $guest = $key;
6349: } elsif ($scope eq 'domains') {
6350: push(@domains,$key);
6351: } elsif ($scope eq 'users') {
6352: push(@users,$key);
6353: } elsif ($scope eq 'course') {
6354: push(@courses,$key);
6355: } elsif ($scope eq 'group') {
6356: push(@groups,$key);
6357: } elsif ($scope eq 'ip') {
6358: push(@ips,$key);
6359: }
6360: }
6361: if ($public) {
6362: return 'ok';
6363: } elsif (@ips > 0) {
6364: my $allowed;
6365: foreach my $ipkey (@ips) {
6366: if (ref($access_hash->{$ipkey}{'ip'}) eq 'ARRAY') {
6367: if (&Apache::loncommon::check_ip_acc(join(',',@{$access_hash->{$ipkey}{'ip'}}),$clientip)) {
6368: $allowed = 1;
6369: last;
6370: }
6371: }
6372: }
6373: if ($allowed) {
6374: return 'ok';
6375: }
6376: }
6377: if ($env{'user.name'} eq 'public' && $env{'user.domain'} eq 'public') {
6378: if ($guest) {
6379: return $guest;
6380: }
6381: } else {
6382: if (@domains > 0) {
6383: foreach my $domkey (@domains) {
6384: if (ref($access_hash->{$domkey}{'dom'}) eq 'ARRAY') {
6385: if (grep(/^\Q$env{'user.domain'}\E$/,@{$access_hash->{$domkey}{'dom'}})) {
6386: return 'ok';
6387: }
6388: }
6389: }
6390: }
6391: if (@users > 0) {
6392: foreach my $userkey (@users) {
6393: if (ref($access_hash->{$userkey}{'users'}) eq 'ARRAY') {
6394: foreach my $item (@{$access_hash->{$userkey}{'users'}}) {
6395: if (ref($item) eq 'HASH') {
6396: if (($item->{'uname'} eq $env{'user.name'}) &&
6397: ($item->{'udom'} eq $env{'user.domain'})) {
6398: return 'ok';
6399: }
6400: }
6401: }
6402: }
6403: }
6404: }
6405: my %roleshash;
6406: my @courses_and_groups = @courses;
6407: push(@courses_and_groups,@groups);
6408: if (@courses_and_groups > 0) {
6409: my (%allgroups,%allroles);
6410: my ($start,$end,$role,$sec,$group);
6411: foreach my $envkey (%env) {
6412: if ($envkey =~ m-^user\.role\.(gr|cc|co|in|ta|ep|ad|st)\./($match_domain)/($match_courseid)/?([^/]*)$-) {
6413: my $cid = $2.'_'.$3;
6414: if ($1 eq 'gr') {
6415: $group = $4;
6416: $allgroups{$cid}{$group} = $env{$envkey};
6417: } else {
6418: if ($4 eq '') {
6419: $sec = 'none';
6420: } else {
6421: $sec = $4;
6422: }
6423: $allroles{$cid}{$1}{$sec} = $env{$envkey};
6424: }
6425: } elsif ($envkey =~ m-^user\.role\./cr/($match_domain/$match_username/\w*)./($match_domain)/($match_courseid)/?([^/]*)$-) {
6426: my $cid = $2.'_'.$3;
6427: if ($4 eq '') {
6428: $sec = 'none';
6429: } else {
6430: $sec = $4;
6431: }
6432: $allroles{$cid}{$1}{$sec} = $env{$envkey};
6433: }
6434: }
6435: if (keys(%allroles) == 0) {
6436: return;
6437: }
6438: foreach my $key (@courses_and_groups) {
6439: my %content = %{$$access_hash{$key}};
6440: my $cnum = $content{'number'};
6441: my $cdom = $content{'domain'};
6442: my $cid = $cdom.'_'.$cnum;
6443: if (!exists($allroles{$cid})) {
6444: next;
6445: }
6446: foreach my $role_id (keys(%{$content{'roles'}})) {
6447: my @sections = @{$content{'roles'}{$role_id}{'section'}};
6448: my @groups = @{$content{'roles'}{$role_id}{'group'}};
6449: my @status = @{$content{'roles'}{$role_id}{'access'}};
6450: my @roles = @{$content{'roles'}{$role_id}{'role'}};
6451: foreach my $role (keys(%{$allroles{$cid}})) {
6452: if ((grep/^all$/,@roles) || (grep/^\Q$role\E$/,@roles)) {
6453: foreach my $sec (keys(%{$allroles{$cid}{$role}})) {
6454: if (&course_group_datechecker($allroles{$cid}{$role}{$sec},$now,\@status) eq 'ok') {
6455: if (grep/^all$/,@sections) {
6456: return 'ok';
6457: } else {
6458: if (grep/^$sec$/,@sections) {
6459: return 'ok';
6460: }
6461: }
6462: }
6463: }
6464: if (keys(%{$allgroups{$cid}}) == 0) {
6465: if (grep/^none$/,@groups) {
6466: return 'ok';
6467: }
6468: } else {
6469: if (grep/^all$/,@groups) {
6470: return 'ok';
6471: }
6472: foreach my $group (keys(%{$allgroups{$cid}})) {
6473: if (grep/^$group$/,@groups) {
6474: return 'ok';
6475: }
6476: }
6477: }
6478: }
6479: }
6480: }
6481: }
6482: }
6483: if ($guest) {
6484: return $guest;
6485: }
6486: }
6487: }
6488: return;
6489: }
6490:
6491: sub course_group_datechecker {
6492: my ($dates,$now,$status) = @_;
6493: my ($start,$end) = split(/\./,$dates);
6494: if (!$start && !$end) {
6495: return 'ok';
6496: }
6497: if (grep/^active$/,@{$status}) {
6498: if (((!$start) || ($start && $start <= $now)) && ((!$end) || ($end && $end >= $now))) {
6499: return 'ok';
6500: }
6501: }
6502: if (grep/^previous$/,@{$status}) {
6503: if ($end > $now ) {
6504: return 'ok';
6505: }
6506: }
6507: if (grep/^future$/,@{$status}) {
6508: if ($start > $now) {
6509: return 'ok';
6510: }
6511: }
6512: return;
6513: }
6514:
6515: sub parse_portfolio_url {
6516: my ($url) = @_;
6517:
6518: my ($type,$udom,$unum,$group,$file_name);
6519:
6520: if ($url =~ m-^/*(?:uploaded|editupload)/($match_domain)/($match_username)/portfolio(/.+)$-) {
6521: $type = 1;
6522: $udom = $1;
6523: $unum = $2;
6524: $file_name = $3;
6525: } elsif ($url =~ m-^/*(?:uploaded|editupload)/($match_domain)/($match_courseid)/groups/([^/]+)/portfolio/(.+)$-) {
6526: $type = 2;
6527: $udom = $1;
6528: $unum = $2;
6529: $group = $3;
6530: $file_name = $3.'/'.$4;
6531: }
6532: if (wantarray) {
6533: return ($type,$udom,$unum,$file_name,$group);
6534: }
6535: return $type;
6536: }
6537:
6538: sub is_portfolio_url {
6539: my ($url) = @_;
6540: return scalar(&parse_portfolio_url($url));
6541: }
6542:
6543: sub is_portfolio_file {
6544: my ($file) = @_;
6545: if (($file =~ /^portfolio/) || ($file =~ /^groups\/\w+\/portfolio/)) {
6546: return 1;
6547: }
6548: return;
6549: }
6550:
6551: sub usertools_access {
6552: my ($uname,$udom,$tool,$action,$context,$userenvref,$domdefref,$is_advref)=@_;
6553: my ($access,%tools);
6554: if ($context eq '') {
6555: $context = 'tools';
6556: }
6557: if ($context eq 'requestcourses') {
6558: %tools = (
6559: official => 1,
6560: unofficial => 1,
6561: community => 1,
6562: textbook => 1,
6563: placement => 1,
6564: );
6565: } elsif ($context eq 'requestauthor') {
6566: %tools = (
6567: requestauthor => 1,
6568: );
6569: } else {
6570: %tools = (
6571: aboutme => 1,
6572: blog => 1,
6573: webdav => 1,
6574: portfolio => 1,
6575: );
6576: }
6577: return if (!defined($tools{$tool}));
6578:
6579: if (($udom eq '') || ($uname eq '')) {
6580: $udom = $env{'user.domain'};
6581: $uname = $env{'user.name'};
6582: }
6583:
6584: if (($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'})) {
6585: if ($action ne 'reload') {
6586: if ($context eq 'requestcourses') {
6587: return $env{'environment.canrequest.'.$tool};
6588: } elsif ($context eq 'requestauthor') {
6589: return $env{'environment.canrequest.author'};
6590: } else {
6591: return $env{'environment.availabletools.'.$tool};
6592: }
6593: }
6594: }
6595:
6596: my ($toolstatus,$inststatus,$envkey);
6597: if ($context eq 'requestauthor') {
6598: $envkey = $context;
6599: } else {
6600: $envkey = $context.'.'.$tool;
6601: }
6602:
6603: if (($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'}) &&
6604: ($action ne 'reload')) {
6605: $toolstatus = $env{'environment.'.$envkey};
6606: $inststatus = $env{'environment.inststatus'};
6607: } else {
6608: if (ref($userenvref) eq 'HASH') {
6609: $toolstatus = $userenvref->{$envkey};
6610: $inststatus = $userenvref->{'inststatus'};
6611: } else {
6612: my %userenv = &userenvironment($udom,$uname,$envkey,'inststatus');
6613: $toolstatus = $userenv{$envkey};
6614: $inststatus = $userenv{'inststatus'};
6615: }
6616: }
6617:
6618: if ($toolstatus ne '') {
6619: if ($toolstatus) {
6620: $access = 1;
6621: } else {
6622: $access = 0;
6623: }
6624: return $access;
6625: }
6626:
6627: my ($is_adv,%domdef);
6628: if (ref($is_advref) eq 'HASH') {
6629: $is_adv = $is_advref->{'is_adv'};
6630: } else {
6631: $is_adv = &is_advanced_user($udom,$uname);
6632: }
6633: if (ref($domdefref) eq 'HASH') {
6634: %domdef = %{$domdefref};
6635: } else {
6636: %domdef = &get_domain_defaults($udom);
6637: }
6638: if (ref($domdef{$tool}) eq 'HASH') {
6639: if ($is_adv) {
6640: if ($domdef{$tool}{'_LC_adv'} ne '') {
6641: if ($domdef{$tool}{'_LC_adv'}) {
6642: $access = 1;
6643: } else {
6644: $access = 0;
6645: }
6646: return $access;
6647: }
6648: }
6649: if ($inststatus ne '') {
6650: my ($hasaccess,$hasnoaccess);
6651: foreach my $affiliation (split(/:/,$inststatus)) {
6652: if ($domdef{$tool}{$affiliation} ne '') {
6653: if ($domdef{$tool}{$affiliation}) {
6654: $hasaccess = 1;
6655: } else {
6656: $hasnoaccess = 1;
6657: }
6658: }
6659: }
6660: if ($hasaccess || $hasnoaccess) {
6661: if ($hasaccess) {
6662: $access = 1;
6663: } elsif ($hasnoaccess) {
6664: $access = 0;
6665: }
6666: return $access;
6667: }
6668: } else {
6669: if ($domdef{$tool}{'default'} ne '') {
6670: if ($domdef{$tool}{'default'}) {
6671: $access = 1;
6672: } elsif ($domdef{$tool}{'default'} == 0) {
6673: $access = 0;
6674: }
6675: return $access;
6676: }
6677: }
6678: } else {
6679: if (($context eq 'tools') && ($tool ne 'webdav')) {
6680: $access = 1;
6681: } else {
6682: $access = 0;
6683: }
6684: return $access;
6685: }
6686: }
6687:
6688: sub is_course_owner {
6689: my ($cdom,$cnum,$udom,$uname) = @_;
6690: if (($udom eq '') || ($uname eq '')) {
6691: $udom = $env{'user.domain'};
6692: $uname = $env{'user.name'};
6693: }
6694: unless (($udom eq '') || ($uname eq '')) {
6695: if (exists($env{'course.'.$cdom.'_'.$cnum.'.internal.courseowner'})) {
6696: if ($env{'course.'.$cdom.'_'.$cnum.'.internal.courseowner'} eq $uname.':'.$udom) {
6697: return 1;
6698: } else {
6699: my %courseinfo = &Apache::lonnet::coursedescription($cdom.'/'.$cnum);
6700: if ($courseinfo{'internal.courseowner'} eq $uname.':'.$udom) {
6701: return 1;
6702: }
6703: }
6704: }
6705: }
6706: return;
6707: }
6708:
6709: sub is_advanced_user {
6710: my ($udom,$uname) = @_;
6711: if ($udom ne '' && $uname ne '') {
6712: if (($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'})) {
6713: if (wantarray) {
6714: return ($env{'user.adv'},$env{'user.author'});
6715: } else {
6716: return $env{'user.adv'};
6717: }
6718: }
6719: }
6720: my %roleshash = &get_my_roles($uname,$udom,'userroles',undef,undef,undef,1);
6721: my %allroles;
6722: my ($is_adv,$is_author);
6723: foreach my $role (keys(%roleshash)) {
6724: my ($trest,$tdomain,$trole,$sec) = split(/:/,$role);
6725: my $area = '/'.$tdomain.'/'.$trest;
6726: if ($sec ne '') {
6727: $area .= '/'.$sec;
6728: }
6729: if (($area ne '') && ($trole ne '')) {
6730: my $spec=$trole.'.'.$area;
6731: if ($trole =~ /^cr\//) {
6732: &custom_roleprivs(\%allroles,$trole,$tdomain,$trest,$spec,$area);
6733: } elsif ($trole ne 'gr') {
6734: &standard_roleprivs(\%allroles,$trole,$tdomain,$spec,$trest,$area);
6735: }
6736: if ($trole eq 'au') {
6737: $is_author = 1;
6738: }
6739: }
6740: }
6741: foreach my $role (keys(%allroles)) {
6742: last if ($is_adv);
6743: foreach my $item (split(/:/,$allroles{$role})) {
6744: if ($item ne '') {
6745: my ($privilege,$restrictions)=split(/&/,$item);
6746: if ($privilege eq 'adv') {
6747: $is_adv = 1;
6748: last;
6749: }
6750: }
6751: }
6752: }
6753: if (wantarray) {
6754: return ($is_adv,$is_author);
6755: }
6756: return $is_adv;
6757: }
6758:
6759: sub check_can_request {
6760: my ($dom,$can_request,$request_domains) = @_;
6761: my $canreq = 0;
6762: my ($types,$typename) = &Apache::loncommon::course_types();
6763: my @options = ('approval','validate','autolimit');
6764: my $optregex = join('|',@options);
6765: if ((ref($can_request) eq 'HASH') && (ref($types) eq 'ARRAY')) {
6766: foreach my $type (@{$types}) {
6767: if (&usertools_access($env{'user.name'},
6768: $env{'user.domain'},
6769: $type,undef,'requestcourses')) {
6770: $canreq ++;
6771: if (ref($request_domains) eq 'HASH') {
6772: push(@{$request_domains->{$type}},$env{'user.domain'});
6773: }
6774: if ($dom eq $env{'user.domain'}) {
6775: $can_request->{$type} = 1;
6776: }
6777: }
6778: if ($env{'environment.reqcrsotherdom.'.$type} ne '') {
6779: my @curr = split(',',$env{'environment.reqcrsotherdom.'.$type});
6780: if (@curr > 0) {
6781: foreach my $item (@curr) {
6782: if (ref($request_domains) eq 'HASH') {
6783: my ($otherdom) = ($item =~ /^($match_domain):($optregex)(=?\d*)$/);
6784: if ($otherdom ne '') {
6785: if (ref($request_domains->{$type}) eq 'ARRAY') {
6786: unless (grep(/^\Q$otherdom\E$/,@{$request_domains->{$type}})) {
6787: push(@{$request_domains->{$type}},$otherdom);
6788: }
6789: } else {
6790: push(@{$request_domains->{$type}},$otherdom);
6791: }
6792: }
6793: }
6794: }
6795: unless($dom eq $env{'user.domain'}) {
6796: $canreq ++;
6797: if (grep(/^\Q$dom\E:($optregex)(=?\d*)$/,@curr)) {
6798: $can_request->{$type} = 1;
6799: }
6800: }
6801: }
6802: }
6803: }
6804: }
6805: return $canreq;
6806: }
6807:
6808: # ---------------------------------------------- Custom access rule evaluation
6809:
6810: sub customaccess {
6811: my ($priv,$uri)=@_;
6812: my ($urole,$urealm)=split(/\./,$env{'request.role'},2);
6813: my (undef,$udom,$ucrs,$usec)=split(/\//,$urealm);
6814: $udom = &LONCAPA::clean_domain($udom);
6815: $ucrs = &LONCAPA::clean_username($ucrs);
6816: my $access=0;
6817: foreach my $right (split(/\s*\,\s*/,&metadata($uri,'rule_rights'))) {
6818: my ($effect,$realm,$role,$type)=split(/\:/,$right);
6819: if ($type eq 'user') {
6820: foreach my $scope (split(/\s*\,\s*/,$realm)) {
6821: my ($tdom,$tuname)=split(m{/},$scope);
6822: if ($tdom) {
6823: if ($tdom ne $env{'user.domain'}) { next; }
6824: }
6825: if ($tuname) {
6826: if ($tuname ne $env{'user.name'}) { next; }
6827: }
6828: $access=($effect eq 'allow');
6829: last;
6830: }
6831: } else {
6832: if ($role) {
6833: if ($role ne $urole) { next; }
6834: }
6835: foreach my $scope (split(/\s*\,\s*/,$realm)) {
6836: my ($tdom,$tcrs,$tsec)=split(/\_/,$scope);
6837: if ($tdom) {
6838: if ($tdom ne $udom) { next; }
6839: }
6840: if ($tcrs) {
6841: if ($tcrs ne $ucrs) { next; }
6842: }
6843: if ($tsec) {
6844: if ($tsec ne $usec) { next; }
6845: }
6846: $access=($effect eq 'allow');
6847: last;
6848: }
6849: if ($realm eq '' && $role eq '') {
6850: $access=($effect eq 'allow');
6851: }
6852: }
6853: }
6854: return $access;
6855: }
6856:
6857: # ------------------------------------------------- Check for a user privilege
6858:
6859: sub allowed {
6860: my ($priv,$uri,$symb,$role,$clientip,$noblockcheck)=@_;
6861: my $ver_orguri=$uri;
6862: $uri=&deversion($uri);
6863: my $orguri=$uri;
6864: $uri=&declutter($uri);
6865:
6866: if ($priv eq 'evb') {
6867: # Evade communication block restrictions for specified role in a course
6868: if ($env{'user.priv.'.$role} =~/evb\&([^\:]*)/) {
6869: return $1;
6870: } else {
6871: return;
6872: }
6873: }
6874:
6875: if (defined($env{'allowed.'.$priv})) { return $env{'allowed.'.$priv}; }
6876: # Free bre access to adm and meta resources
6877: if (((($uri=~/^adm\//) && ($uri !~ m{/(?:smppg|bulletinboard)$}))
6878: || (($uri=~/\.meta$/) && ($uri!~m|^uploaded/|) ))
6879: && ($priv eq 'bre')) {
6880: return 'F';
6881: }
6882:
6883: # Free bre access to user's own portfolio contents
6884: my ($space,$domain,$name,@dir)=split('/',$uri);
6885: if (($space=~/^(uploaded|editupload)$/) && ($env{'user.name'} eq $name) &&
6886: ($env{'user.domain'} eq $domain) && ('portfolio' eq $dir[0])) {
6887: my %setters;
6888: my ($startblock,$endblock) =
6889: &Apache::loncommon::blockcheck(\%setters,'port');
6890: if ($startblock && $endblock) {
6891: return 'B';
6892: } else {
6893: return 'F';
6894: }
6895: }
6896:
6897: # bre access to group portfolio for rgf priv in group, or mdg or vcg in course.
6898: if (($space=~/^(uploaded|editupload)$/) && ($dir[0] eq 'groups')
6899: && ($dir[2] eq 'portfolio') && ($priv eq 'bre')) {
6900: if (exists($env{'request.course.id'})) {
6901: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
6902: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
6903: if (($domain eq $cdom) && ($name eq $cnum)) {
6904: my $courseprivid=$env{'request.course.id'};
6905: $courseprivid=~s/\_/\//;
6906: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid
6907: .'/'.$dir[1]} =~/rgf\&([^\:]*)/) {
6908: return $1;
6909: } else {
6910: if ($env{'request.course.sec'}) {
6911: $courseprivid.='/'.$env{'request.course.sec'};
6912: }
6913: if ($env{'user.priv.'.$env{'request.role'}.'./'.
6914: $courseprivid} =~/(mdg|vcg)\&([^\:]*)/) {
6915: return $2;
6916: }
6917: }
6918: }
6919: }
6920: }
6921:
6922: # Free bre to public access
6923:
6924: if ($priv eq 'bre') {
6925: my $copyright=&metadata($uri,'copyright');
6926: if (($copyright eq 'public') && (!$env{'request.course.id'})) {
6927: return 'F';
6928: }
6929: if ($copyright eq 'priv') {
6930: $uri=~/([^\/]+)\/([^\/]+)\//;
6931: unless (($env{'user.name'} eq $2) && ($env{'user.domain'} eq $1)) {
6932: return '';
6933: }
6934: }
6935: if ($copyright eq 'domain') {
6936: $uri=~/([^\/]+)\/([^\/]+)\//;
6937: unless (($env{'user.domain'} eq $1) ||
6938: ($env{'course.'.$env{'request.course.id'}.'.domain'} eq $1)) {
6939: return '';
6940: }
6941: }
6942: if ($env{'request.role'}=~ /li\.\//) {
6943: # Library role, so allow browsing of resources in this domain.
6944: return 'F';
6945: }
6946: if ($copyright eq 'custom') {
6947: unless (&customaccess($priv,$uri)) { return ''; }
6948: }
6949: }
6950: # Domain coordinator is trying to create a course
6951: if (($priv eq 'ccc') && ($env{'request.role'} =~ /^dc\./)) {
6952: # uri is the requested domain in this case.
6953: # comparison to 'request.role.domain' shows if the user has selected
6954: # a role of dc for the domain in question.
6955: return 'F' if ($uri eq $env{'request.role.domain'});
6956: }
6957:
6958: my $thisallowed='';
6959: my $statecond=0;
6960: my $courseprivid='';
6961:
6962: my $ownaccess;
6963: # Community Coordinator or Assistant Co-author browsing resource space.
6964: if (($priv eq 'bro') && ($env{'user.author'})) {
6965: if ($uri eq '') {
6966: $ownaccess = 1;
6967: } else {
6968: if (($env{'user.domain'} ne '') && ($env{'user.name'} ne '')) {
6969: my $udom = $env{'user.domain'};
6970: my $uname = $env{'user.name'};
6971: if ($uri =~ m{^\Q$udom\E/?$}) {
6972: $ownaccess = 1;
6973: } elsif ($uri =~ m{^\Q$udom\E/\Q$uname\E/?}) {
6974: unless ($uri =~ m{\.\./}) {
6975: $ownaccess = 1;
6976: }
6977: } elsif (($udom ne 'public') && ($uname ne 'public')) {
6978: my $now = time;
6979: if ($uri =~ m{^([^/]+)/?$}) {
6980: my $adom = $1;
6981: foreach my $key (keys(%env)) {
6982: if ($key =~ m{^user\.role\.(ca|aa)/\Q$adom\E}) {
6983: my ($start,$end) = split('.',$env{$key});
6984: if (($now >= $start) && (!$end || $end < $now)) {
6985: $ownaccess = 1;
6986: last;
6987: }
6988: }
6989: }
6990: } elsif ($uri =~ m{^([^/]+)/([^/]+)/?}) {
6991: my $adom = $1;
6992: my $aname = $2;
6993: foreach my $role ('ca','aa') {
6994: if ($env{"user.role.$role./$adom/$aname"}) {
6995: my ($start,$end) =
6996: split('.',$env{"user.role.$role./$adom/$aname"});
6997: if (($now >= $start) && (!$end || $end < $now)) {
6998: $ownaccess = 1;
6999: last;
7000: }
7001: }
7002: }
7003: }
7004: }
7005: }
7006: }
7007: }
7008:
7009: # Course
7010:
7011: if ($env{'user.priv.'.$env{'request.role'}.'./'}=~/\Q$priv\E\&([^\:]*)/) {
7012: unless (($priv eq 'bro') && (!$ownaccess)) {
7013: $thisallowed.=$1;
7014: }
7015: }
7016:
7017: # Domain
7018:
7019: if ($env{'user.priv.'.$env{'request.role'}.'./'.(split(/\//,$uri))[0].'/'}
7020: =~/\Q$priv\E\&([^\:]*)/) {
7021: unless (($priv eq 'bro') && (!$ownaccess)) {
7022: $thisallowed.=$1;
7023: }
7024: }
7025:
7026: # User who is not author or co-author might still be able to edit
7027: # resource of an author in the domain (e.g., if Domain Coordinator).
7028: if (($priv eq 'eco') && ($thisallowed eq '') && ($env{'request.course.id'}) &&
7029: (&allowed('mdc',$env{'request.course.id'}))) {
7030: if ($env{"user.priv.cm./$uri/"}=~/\Q$priv\E\&([^\:]*)/) {
7031: $thisallowed.=$1;
7032: }
7033: }
7034:
7035: # Course: uri itself is a course
7036: my $courseuri=$uri;
7037: $courseuri=~s/\_(\d)/\/$1/;
7038: $courseuri=~s/^([^\/])/\/$1/;
7039:
7040: if ($env{'user.priv.'.$env{'request.role'}.'.'.$courseuri}
7041: =~/\Q$priv\E\&([^\:]*)/) {
7042: unless (($priv eq 'bro') && (!$ownaccess)) {
7043: $thisallowed.=$1;
7044: }
7045: }
7046:
7047: # URI is an uploaded document for this course, default permissions don't matter
7048: # not allowing 'edit' access (editupload) to uploaded course docs
7049: if (($priv eq 'bre') && ($uri=~m|^uploaded/|)) {
7050: $thisallowed='';
7051: my ($match)=&is_on_map($uri);
7052: if ($match) {
7053: if ($env{'user.priv.'.$env{'request.role'}.'./'}
7054: =~/\Q$priv\E\&([^\:]*)/) {
7055: my $value = $1;
7056: if ($noblockcheck) {
7057: $thisallowed.=$value;
7058: } else {
7059: my @blockers = &has_comm_blocking($priv,$symb,$uri);
7060: if (@blockers > 0) {
7061: $thisallowed = 'B';
7062: } else {
7063: $thisallowed.=$value;
7064: }
7065: }
7066: }
7067: } else {
7068: my $refuri = $env{'httpref.'.$orguri} || $env{'httpref.'.$ver_orguri};
7069: if ($refuri) {
7070: if ($refuri =~ m|^/adm/|) {
7071: $thisallowed='F';
7072: } else {
7073: $refuri=&declutter($refuri);
7074: my ($match) = &is_on_map($refuri);
7075: if ($match) {
7076: if ($noblockcheck) {
7077: $thisallowed='F';
7078: } else {
7079: my @blockers = &has_comm_blocking($priv,$symb,$refuri);
7080: if (@blockers > 0) {
7081: $thisallowed = 'B';
7082: } else {
7083: $thisallowed='F';
7084: }
7085: }
7086: }
7087: }
7088: }
7089: }
7090: }
7091:
7092: if ($priv eq 'bre'
7093: && $thisallowed ne 'F'
7094: && $thisallowed ne '2'
7095: && &is_portfolio_url($uri)) {
7096: $thisallowed = &portfolio_access($uri,$clientip);
7097: }
7098:
7099: # Full access at system, domain or course-wide level? Exit.
7100: if ($thisallowed=~/F/) {
7101: return 'F';
7102: }
7103:
7104: # If this is generating or modifying users, exit with special codes
7105:
7106: if (':csu:cdc:ccc:cin:cta:cep:ccr:cst:cad:cli:cau:cdg:cca:caa:'=~/\:\Q$priv\E\:/) {
7107: if (($priv eq 'cca') || ($priv eq 'caa')) {
7108: my ($audom,$auname)=split('/',$uri);
7109: # no author name given, so this just checks on the general right to make a co-author in this domain
7110: unless ($auname) { return $thisallowed; }
7111: # an author name is given, so we are about to actually make a co-author for a certain account
7112: if (($auname ne $env{'user.name'} && $env{'request.role'} !~ /^dc\./) ||
7113: (($audom ne $env{'user.domain'} && $env{'request.role'} !~ /^dc\./) &&
7114: ($audom ne $env{'request.role.domain'}))) { return ''; }
7115: }
7116: return $thisallowed;
7117: }
7118: #
7119: # Gathered so far: system, domain and course wide privileges
7120: #
7121: # Course: See if uri or referer is an individual resource that is part of
7122: # the course
7123:
7124: if ($env{'request.course.id'}) {
7125:
7126: $courseprivid=$env{'request.course.id'};
7127: if ($env{'request.course.sec'}) {
7128: $courseprivid.='/'.$env{'request.course.sec'};
7129: }
7130: $courseprivid=~s/\_/\//;
7131: my $checkreferer=1;
7132: my ($match,$cond)=&is_on_map($uri);
7133: if ($match) {
7134: $statecond=$cond;
7135: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid}
7136: =~/\Q$priv\E\&([^\:]*)/) {
7137: my $value = $1;
7138: if ($priv eq 'bre') {
7139: if ($noblockcheck) {
7140: $thisallowed.=$value;
7141: } else {
7142: my @blockers = &has_comm_blocking($priv,$symb,$uri);
7143: if (@blockers > 0) {
7144: $thisallowed = 'B';
7145: } else {
7146: $thisallowed.=$value;
7147: }
7148: }
7149: } else {
7150: $thisallowed.=$value;
7151: }
7152: $checkreferer=0;
7153: }
7154: }
7155:
7156: if ($checkreferer) {
7157: my $refuri=$env{'httpref.'.$orguri};
7158: unless ($refuri) {
7159: foreach my $key (keys(%env)) {
7160: if ($key=~/^httpref\..*\*/) {
7161: my $pattern=$key;
7162: $pattern=~s/^httpref\.\/res\///;
7163: $pattern=~s/\*/\[\^\/\]\+/g;
7164: $pattern=~s/\//\\\//g;
7165: if ($orguri=~/$pattern/) {
7166: $refuri=$env{$key};
7167: }
7168: }
7169: }
7170: }
7171:
7172: if ($refuri) {
7173: $refuri=&declutter($refuri);
7174: my ($match,$cond)=&is_on_map($refuri);
7175: if ($match) {
7176: my $refstatecond=$cond;
7177: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid}
7178: =~/\Q$priv\E\&([^\:]*)/) {
7179: my $value = $1;
7180: if ($priv eq 'bre') {
7181: if ($noblockcheck) {
7182: $thisallowed.=$value;
7183: } else {
7184: my @blockers = &has_comm_blocking($priv,$symb,$refuri);
7185: if (@blockers > 0) {
7186: $thisallowed = 'B';
7187: } else {
7188: $thisallowed.=$value;
7189: }
7190: }
7191: } else {
7192: $thisallowed.=$value;
7193: }
7194: $uri=$refuri;
7195: $statecond=$refstatecond;
7196: }
7197: }
7198: }
7199: }
7200: }
7201:
7202: #
7203: # Gathered now: all privileges that could apply, and condition number
7204: #
7205: #
7206: # Full or no access?
7207: #
7208:
7209: if ($thisallowed=~/F/) {
7210: return 'F';
7211: }
7212:
7213: unless ($thisallowed) {
7214: return '';
7215: }
7216:
7217: # Restrictions exist, deal with them
7218: #
7219: # C:according to course preferences
7220: # R:according to resource settings
7221: # L:unless locked
7222: # X:according to user session state
7223: #
7224:
7225: # Possibly locked functionality, check all courses
7226: # Locks might take effect only after 10 minutes cache expiration for other
7227: # courses, and 2 minutes for current course
7228:
7229: my $envkey;
7230: if ($thisallowed=~/L/) {
7231: foreach $envkey (keys(%env)) {
7232: if ($envkey=~/^user\.role\.(st|ta)\.([^\.]*)/) {
7233: my $courseid=$2;
7234: my $roleid=$1.'.'.$2;
7235: $courseid=~s/^\///;
7236: my $expiretime=600;
7237: if ($env{'request.role'} eq $roleid) {
7238: $expiretime=120;
7239: }
7240: my ($cdom,$cnum,$csec)=split(/\//,$courseid);
7241: my $prefix='course.'.$cdom.'_'.$cnum.'.';
7242: if ((time-$env{$prefix.'last_cache'})>$expiretime) {
7243: &coursedescription($courseid,{'freshen_cache' => 1});
7244: }
7245: if (($env{$prefix.'res.'.$uri.'.lock.sections'}=~/\,\Q$csec\E\,/)
7246: || ($env{$prefix.'res.'.$uri.'.lock.sections'} eq 'all')) {
7247: if ($env{$prefix.'res.'.$uri.'.lock.expire'}>time) {
7248: &log($env{'user.domain'},$env{'user.name'},
7249: $env{'user.home'},
7250: 'Locked by res: '.$priv.' for '.$uri.' due to '.
7251: $cdom.'/'.$cnum.'/'.$csec.' expire '.
7252: $env{$prefix.'priv.'.$priv.'.lock.expire'});
7253: return '';
7254: }
7255: }
7256: if (($env{$prefix.'priv.'.$priv.'.lock.sections'}=~/\,\Q$csec\E\,/)
7257: || ($env{$prefix.'priv.'.$priv.'.lock.sections'} eq 'all')) {
7258: if ($env{'priv.'.$priv.'.lock.expire'}>time) {
7259: &log($env{'user.domain'},$env{'user.name'},
7260: $env{'user.home'},
7261: 'Locked by priv: '.$priv.' for '.$uri.' due to '.
7262: $cdom.'/'.$cnum.'/'.$csec.' expire '.
7263: $env{$prefix.'priv.'.$priv.'.lock.expire'});
7264: return '';
7265: }
7266: }
7267: }
7268: }
7269: }
7270:
7271: #
7272: # Rest of the restrictions depend on selected course
7273: #
7274:
7275: unless ($env{'request.course.id'}) {
7276: if ($thisallowed eq 'A') {
7277: return 'A';
7278: } elsif ($thisallowed eq 'B') {
7279: return 'B';
7280: } else {
7281: return '1';
7282: }
7283: }
7284:
7285: #
7286: # Now user is definitely in a course
7287: #
7288:
7289:
7290: # Course preferences
7291:
7292: if ($thisallowed=~/C/) {
7293: my $rolecode=(split(/\./,$env{'request.role'}))[0];
7294: my $unamedom=$env{'user.name'}.':'.$env{'user.domain'};
7295: if ($env{'course.'.$env{'request.course.id'}.'.'.$priv.'.roles.denied'}
7296: =~/\Q$rolecode\E/) {
7297: if (($priv ne 'pch') && ($priv ne 'plc') && ($priv ne 'pac')) {
7298: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.':'.
7299: 'Denied by role: '.$priv.' for '.$uri.' as '.$rolecode.' in '.
7300: $env{'request.course.id'});
7301: }
7302: return '';
7303: }
7304:
7305: if ($env{'course.'.$env{'request.course.id'}.'.'.$priv.'.users.denied'}
7306: =~/\Q$unamedom\E/) {
7307: if (($priv ne 'pch') && ($priv ne 'plc') && ($priv ne 'pac')) {
7308: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.
7309: 'Denied by user: '.$priv.' for '.$uri.' as '.$unamedom.' in '.
7310: $env{'request.course.id'});
7311: }
7312: return '';
7313: }
7314: }
7315:
7316: # Resource preferences
7317:
7318: if ($thisallowed=~/R/) {
7319: my $rolecode=(split(/\./,$env{'request.role'}))[0];
7320: if (&metadata($uri,'roledeny')=~/\Q$rolecode\E/) {
7321: if (($priv ne 'pch') && ($priv ne 'plc')) {
7322: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.':'.
7323: 'Denied by role: '.$priv.' for '.$uri.' as '.$rolecode);
7324: }
7325: return '';
7326: }
7327: }
7328:
7329: # Restricted by state or randomout?
7330:
7331: if ($thisallowed=~/X/) {
7332: if ($env{'acc.randomout'}) {
7333: if (!$symb) { $symb=&symbread($uri,1); }
7334: if (($symb) && ($env{'acc.randomout'}=~/\&\Q$symb\E\&/)) {
7335: return '';
7336: }
7337: }
7338: if (&condval($statecond)) {
7339: return '2';
7340: } else {
7341: return '';
7342: }
7343: }
7344:
7345: if ($thisallowed eq 'A') {
7346: return 'A';
7347: } elsif ($thisallowed eq 'B') {
7348: return 'B';
7349: }
7350: return 'F';
7351: }
7352:
7353: # ------------------------------------------- Check construction space access
7354:
7355: sub constructaccess {
7356: my ($url,$setpriv)=@_;
7357:
7358: # We do not allow editing of previous versions of files
7359: if ($url=~/\.(\d+)\.(\w+)$/) { return ''; }
7360:
7361: # Get username and domain from URL
7362: my ($ownername,$ownerdomain,$ownerhome);
7363:
7364: ($ownerdomain,$ownername) =
7365: ($url=~ m{^(?:\Q$perlvar{'lonDocRoot'}\E|)(?:/daxepage|/daxeopen)?/priv/($match_domain)/($match_username)/});
7366:
7367: # The URL does not really point to any authorspace, forget it
7368: unless (($ownername) && ($ownerdomain)) { return ''; }
7369:
7370: # Now we need to see if the user has access to the authorspace of
7371: # $ownername at $ownerdomain
7372:
7373: if (($ownername eq $env{'user.name'}) && ($ownerdomain eq $env{'user.domain'})) {
7374: # Real author for this?
7375: $ownerhome = $env{'user.home'};
7376: if (exists($env{'user.priv.au./'.$ownerdomain.'/./'})) {
7377: return ($ownername,$ownerdomain,$ownerhome);
7378: }
7379: } else {
7380: # Co-author for this?
7381: if (exists($env{'user.priv.ca./'.$ownerdomain.'/'.$ownername.'./'}) ||
7382: exists($env{'user.priv.aa./'.$ownerdomain.'/'.$ownername.'./'}) ) {
7383: $ownerhome = &homeserver($ownername,$ownerdomain);
7384: return ($ownername,$ownerdomain,$ownerhome);
7385: }
7386: if ($env{'request.course.id'}) {
7387: if (($ownername eq $env{'course.'.$env{'request.course.id'}.'.num'}) &&
7388: ($ownerdomain eq $env{'course.'.$env{'request.course.id'}.'.domain'})) {
7389: if (&allowed('mdc',$env{'request.course.id'})) {
7390: $ownerhome = $env{'course.'.$env{'request.course.id'}.'.home'};
7391: return ($ownername,$ownerdomain,$ownerhome);
7392: }
7393: }
7394: }
7395: }
7396:
7397: # We don't have any access right now. If we are not possibly going to do anything about this,
7398: # we might as well leave
7399: unless ($setpriv) { return ''; }
7400:
7401: # Backdoor access?
7402: my $allowed=&allowed('eco',$ownerdomain);
7403: # Nope
7404: unless ($allowed) { return ''; }
7405: # Looks like we may have access, but could be locked by the owner of the construction space
7406: if ($allowed eq 'U') {
7407: my %blocked=&get('environment',['domcoord.author'],
7408: $ownerdomain,$ownername);
7409: # Is blocked by owner
7410: if ($blocked{'domcoord.author'} eq 'blocked') { return ''; }
7411: }
7412: if (($allowed eq 'F') || ($allowed eq 'U')) {
7413: # Grant temporary access
7414: my $then=$env{'user.login.time'};
7415: my $update=$env{'user.update.time'};
7416: if (!$update) { $update = $then; }
7417: my $refresh=$env{'user.refresh.time'};
7418: if (!$refresh) { $refresh = $update; }
7419: my $now = time;
7420: &check_adhoc_privs($ownerdomain,$ownername,$update,$refresh,
7421: $now,'ca','constructaccess');
7422: $ownerhome = &homeserver($ownername,$ownerdomain);
7423: return($ownername,$ownerdomain,$ownerhome);
7424: }
7425: # No business here
7426: return '';
7427: }
7428:
7429: # ----------------------------------------------------------- Content Blocking
7430:
7431: {
7432: # Caches for faster Course Contents display where content blocking
7433: # is in operation (i.e., interval param set) for timed quiz.
7434: #
7435: # User for whom data are being temporarily cached.
7436: my $cacheduser='';
7437: # Cached blockers for this user (a hash of blocking items).
7438: my %cachedblockers=();
7439: # When the data were last cached.
7440: my $cachedlast='';
7441:
7442: sub load_all_blockers {
7443: my ($uname,$udom,$blocks)=@_;
7444: if (($uname ne '') && ($udom ne '')) {
7445: if (($cacheduser eq $uname.':'.$udom) &&
7446: (abs($cachedlast-time)<5)) {
7447: return;
7448: }
7449: }
7450: $cachedlast=time;
7451: $cacheduser=$uname.':'.$udom;
7452: %cachedblockers = &get_commblock_resources($blocks);
7453: }
7454:
7455: sub get_comm_blocks {
7456: my ($cdom,$cnum) = @_;
7457: if ($cdom eq '' || $cnum eq '') {
7458: return unless ($env{'request.course.id'});
7459: $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
7460: $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
7461: }
7462: my %commblocks;
7463: my $hashid=$cdom.'_'.$cnum;
7464: my ($blocksref,$cached)=&is_cached_new('comm_block',$hashid);
7465: if ((defined($cached)) && (ref($blocksref) eq 'HASH')) {
7466: %commblocks = %{$blocksref};
7467: } else {
7468: %commblocks = &Apache::lonnet::dump('comm_block',$cdom,$cnum);
7469: my $cachetime = 600;
7470: &do_cache_new('comm_block',$hashid,\%commblocks,$cachetime);
7471: }
7472: return %commblocks;
7473: }
7474:
7475: sub get_commblock_resources {
7476: my ($blocks) = @_;
7477: my %blockers = ();
7478: return %blockers unless ($env{'request.course.id'});
7479: return %blockers if ($env{'user.priv.'.$env{'request.role'}} =~/evb\&([^\:]*)/);
7480: my %commblocks;
7481: if (ref($blocks) eq 'HASH') {
7482: %commblocks = %{$blocks};
7483: } else {
7484: %commblocks = &get_comm_blocks();
7485: }
7486: return %blockers unless (keys(%commblocks) > 0);
7487: my $navmap = Apache::lonnavmaps::navmap->new();
7488: return %blockers unless (ref($navmap));
7489: my $now = time;
7490: foreach my $block (keys(%commblocks)) {
7491: if ($block =~ /^(\d+)____(\d+)$/) {
7492: my ($start,$end) = ($1,$2);
7493: if ($start <= $now && $end >= $now) {
7494: if (ref($commblocks{$block}{'blocks'}) eq 'HASH') {
7495: if (ref($commblocks{$block}{'blocks'}{'docs'}) eq 'HASH') {
7496: if (ref($commblocks{$block}{'blocks'}{'docs'}{'maps'}) eq 'HASH') {
7497: if (keys(%{$commblocks{$block}{'blocks'}{'docs'}{'maps'}})) {
7498: $blockers{$block}{maps} = $commblocks{$block}{'blocks'}{'docs'}{'maps'};
7499: }
7500: }
7501: if (ref($commblocks{$block}{'blocks'}{'docs'}{'resources'}) eq 'HASH') {
7502: if (keys(%{$commblocks{$block}{'blocks'}{'docs'}{'resources'}})) {
7503: $blockers{$block}{'resources'} = $commblocks{$block}{'blocks'}{'docs'}{'resources'};
7504: }
7505: }
7506: }
7507: }
7508: }
7509: } elsif ($block =~ /^firstaccess____(.+)$/) {
7510: my $item = $1;
7511: my @to_test;
7512: if (ref($commblocks{$block}{'blocks'}) eq 'HASH') {
7513: if (ref($commblocks{$block}{'blocks'}{'docs'}) eq 'HASH') {
7514: my @interval;
7515: my $type = 'map';
7516: if ($item eq 'course') {
7517: $type = 'course';
7518: @interval=&EXT("resource.0.interval");
7519: } else {
7520: if ($item =~ /___\d+___/) {
7521: $type = 'resource';
7522: @interval=&EXT("resource.0.interval",$item);
7523: if (ref($navmap)) {
7524: my $res = $navmap->getBySymb($item);
7525: push(@to_test,$res);
7526: }
7527: } else {
7528: my $mapsymb = &symbread($item,1);
7529: if ($mapsymb) {
7530: if (ref($navmap)) {
7531: my $mapres = $navmap->getBySymb($mapsymb);
7532: @to_test = $mapres->retrieveResources($mapres,undef,0,0,0,1);
7533: foreach my $res (@to_test) {
7534: my $symb = $res->symb();
7535: next if ($symb eq $mapsymb);
7536: if ($symb ne '') {
7537: @interval=&EXT("resource.0.interval",$symb);
7538: if ($interval[1] eq 'map') {
7539: last;
7540: }
7541: }
7542: }
7543: }
7544: }
7545: }
7546: }
7547: if ($interval[0] =~ /^(\d+)/) {
7548: my $timelimit = $1;
7549: my $first_access;
7550: if ($type eq 'resource') {
7551: $first_access=&get_first_access($interval[1],$item);
7552: } elsif ($type eq 'map') {
7553: $first_access=&get_first_access($interval[1],undef,$item);
7554: } else {
7555: $first_access=&get_first_access($interval[1]);
7556: }
7557: if ($first_access) {
7558: my $timesup = $first_access+$timelimit;
7559: if ($timesup > $now) {
7560: my $activeblock;
7561: foreach my $res (@to_test) {
7562: if ($res->answerable()) {
7563: $activeblock = 1;
7564: last;
7565: }
7566: }
7567: if ($activeblock) {
7568: if (ref($commblocks{$block}{'blocks'}{'docs'}{'maps'}) eq 'HASH') {
7569: if (keys(%{$commblocks{$block}{'blocks'}{'docs'}{'maps'}})) {
7570: $blockers{$block}{'maps'} = $commblocks{$block}{'blocks'}{'docs'}{'maps'};
7571: }
7572: }
7573: if (ref($commblocks{$block}{'blocks'}{'docs'}{'resources'}) eq 'HASH') {
7574: if (keys(%{$commblocks{$block}{'blocks'}{'docs'}{'resources'}})) {
7575: $blockers{$block}{'resources'} = $commblocks{$block}{'blocks'}{'docs'}{'resources'};
7576: }
7577: }
7578: }
7579: }
7580: }
7581: }
7582: }
7583: }
7584: }
7585: }
7586: return %blockers;
7587: }
7588:
7589: sub has_comm_blocking {
7590: my ($priv,$symb,$uri,$blocks) = @_;
7591: my @blockers;
7592: return unless ($env{'request.course.id'});
7593: return unless ($priv eq 'bre');
7594: return if ($env{'user.priv.'.$env{'request.role'}} =~/evb\&([^\:]*)/);
7595: return if ($env{'request.state'} eq 'construct');
7596: &load_all_blockers($env{'user.name'},$env{'user.domain'},$blocks);
7597: return unless (keys(%cachedblockers) > 0);
7598: my (%possibles,@symbs);
7599: if (!$symb) {
7600: $symb = &symbread($uri,1,1,1,\%possibles);
7601: }
7602: if ($symb) {
7603: @symbs = ($symb);
7604: } elsif (keys(%possibles)) {
7605: @symbs = keys(%possibles);
7606: }
7607: my $noblock;
7608: foreach my $symb (@symbs) {
7609: last if ($noblock);
7610: my ($map,$resid,$resurl)=&decode_symb($symb);
7611: foreach my $block (keys(%cachedblockers)) {
7612: if ($block =~ /^firstaccess____(.+)$/) {
7613: my $item = $1;
7614: if (($item eq $map) || ($item eq $symb)) {
7615: $noblock = 1;
7616: last;
7617: }
7618: }
7619: if (ref($cachedblockers{$block}) eq 'HASH') {
7620: if (ref($cachedblockers{$block}{'resources'}) eq 'HASH') {
7621: if ($cachedblockers{$block}{'resources'}{$symb}) {
7622: unless (grep(/^\Q$block\E$/,@blockers)) {
7623: push(@blockers,$block);
7624: }
7625: }
7626: }
7627: }
7628: if (ref($cachedblockers{$block}{'maps'}) eq 'HASH') {
7629: if ($cachedblockers{$block}{'maps'}{$map}) {
7630: unless (grep(/^\Q$block\E$/,@blockers)) {
7631: push(@blockers,$block);
7632: }
7633: }
7634: }
7635: }
7636: }
7637: return if ($noblock);
7638: return @blockers;
7639: }
7640: }
7641:
7642: # -------------------------------- Deversion and split uri into path an filename
7643:
7644: #
7645: # Removes the version from a URI and
7646: # splits it in to its filename and path to the filename.
7647: # Seems like File::Basename could have done this more clearly.
7648: # Parameters:
7649: # $uri - input URI
7650: # Returns:
7651: # Two element list consisting of
7652: # $pathname - the URI up to and excluding the trailing /
7653: # $filename - The part of the URI following the last /
7654: # NOTE:
7655: # Another realization of this is simply:
7656: # use File::Basename;
7657: # ...
7658: # $uri = shift;
7659: # $filename = basename($uri);
7660: # $path = dirname($uri);
7661: # return ($filename, $path);
7662: #
7663: # The implementation below is probably faster however.
7664: #
7665: sub split_uri_for_cond {
7666: my $uri=&deversion(&declutter(shift));
7667: my @uriparts=split(/\//,$uri);
7668: my $filename=pop(@uriparts);
7669: my $pathname=join('/',@uriparts);
7670: return ($pathname,$filename);
7671: }
7672: # --------------------------------------------------- Is a resource on the map?
7673:
7674: sub is_on_map {
7675: my ($pathname,$filename) = &split_uri_for_cond(shift);
7676: #Trying to find the conditional for the file
7677: my $match=($env{'acc.res.'.$env{'request.course.id'}.'.'.$pathname}=~
7678: /\&\Q$filename\E\:([\d\|]+)\&/);
7679: if ($match) {
7680: return (1,$1);
7681: } else {
7682: return (0,0);
7683: }
7684: }
7685:
7686: # --------------------------------------------------------- Get symb from alias
7687:
7688: sub get_symb_from_alias {
7689: my $symb=shift;
7690: my ($map,$resid,$url)=&decode_symb($symb);
7691: # Already is a symb
7692: if ($url) { return $symb; }
7693: # Must be an alias
7694: my $aliassymb='';
7695: my %bighash;
7696: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
7697: &GDBM_READER(),0640)) {
7698: my $rid=$bighash{'mapalias_'.$symb};
7699: if ($rid) {
7700: my ($mapid,$resid)=split(/\./,$rid);
7701: $aliassymb=&encode_symb($bighash{'map_id_'.$mapid},
7702: $resid,$bighash{'src_'.$rid});
7703: }
7704: untie %bighash;
7705: }
7706: return $aliassymb;
7707: }
7708:
7709: # ----------------------------------------------------------------- Define Role
7710:
7711: sub definerole {
7712: if (allowed('mcr','/')) {
7713: my ($rolename,$sysrole,$domrole,$courole)=@_;
7714: foreach my $role (split(':',$sysrole)) {
7715: my ($crole,$cqual)=split(/\&/,$role);
7716: if ($pr{'cr:s'}!~/\Q$crole\E/) { return "refused:s:$crole"; }
7717: if ($pr{'cr:s'}=~/\Q$crole\E\&/) {
7718: if ($pr{'cr:s'}!~/\Q$crole\E\&\w*\Q$cqual\E/) {
7719: return "refused:s:$crole&$cqual";
7720: }
7721: }
7722: }
7723: foreach my $role (split(':',$domrole)) {
7724: my ($crole,$cqual)=split(/\&/,$role);
7725: if ($pr{'cr:d'}!~/\Q$crole\E/) { return "refused:d:$crole"; }
7726: if ($pr{'cr:d'}=~/\Q$crole\E\&/) {
7727: if ($pr{'cr:d'}!~/\Q$crole\W\&\w*\Q$cqual\E/) {
7728: return "refused:d:$crole&$cqual";
7729: }
7730: }
7731: }
7732: foreach my $role (split(':',$courole)) {
7733: my ($crole,$cqual)=split(/\&/,$role);
7734: if ($pr{'cr:c'}!~/\Q$crole\E/) { return "refused:c:$crole"; }
7735: if ($pr{'cr:c'}=~/\Q$crole\E\&/) {
7736: if ($pr{'cr:c'}!~/\Q$crole\E\&\w*\Q$cqual\E/) {
7737: return "refused:c:$crole&$cqual";
7738: }
7739: }
7740: }
7741: my $command="encrypt:rolesput:$env{'user.domain'}:$env{'user.name'}:".
7742: "$env{'user.domain'}:$env{'user.name'}:".
7743: "rolesdef_$rolename=".
7744: escape($sysrole.'_'.$domrole.'_'.$courole);
7745: return reply($command,$env{'user.home'});
7746: } else {
7747: return 'refused';
7748: }
7749: }
7750:
7751: # ---------------- Make a metadata query against the network of library servers
7752:
7753: sub metadata_query {
7754: my ($query,$custom,$customshow,$server_array,$domains_hash)=@_;
7755: my %rhash;
7756: my %libserv = &all_library();
7757: my @server_list = (defined($server_array) ? @$server_array
7758: : keys(%libserv) );
7759: for my $server (@server_list) {
7760: my $domains = '';
7761: if (ref($domains_hash) eq 'HASH') {
7762: $domains = $domains_hash->{$server};
7763: }
7764: unless ($custom or $customshow) {
7765: my $reply=&reply("querysend:".&escape($query).':::'.&escape($domains),$server);
7766: $rhash{$server}=$reply;
7767: }
7768: else {
7769: my $reply=&reply("querysend:".&escape($query).':'.
7770: &escape($custom).':'.&escape($customshow).':'.&escape($domains),
7771: $server);
7772: $rhash{$server}=$reply;
7773: }
7774: }
7775: return \%rhash;
7776: }
7777:
7778: # ----------------------------------------- Send log queries and wait for reply
7779:
7780: sub log_query {
7781: my ($uname,$udom,$query,%filters)=@_;
7782: my $uhome=&homeserver($uname,$udom);
7783: if ($uhome eq 'no_host') { return 'error: no_host'; }
7784: my $uhost=&hostname($uhome);
7785: my $command=&escape(join(':',map{$_.'='.$filters{$_}} keys(%filters)));
7786: my $queryid=&reply("querysend:".$query.':'.$udom.':'.$uname.':'.$command,
7787: $uhome);
7788: unless ($queryid=~/^\Q$uhost\E\_/) { return 'error: '.$queryid; }
7789: return get_query_reply($queryid);
7790: }
7791:
7792: # -------------------------- Update MySQL table for portfolio file
7793:
7794: sub update_portfolio_table {
7795: my ($uname,$udom,$file_name,$query,$group,$action) = @_;
7796: if ($group ne '') {
7797: $file_name =~s /^\Q$group\E//;
7798: }
7799: my $homeserver = &homeserver($uname,$udom);
7800: my $queryid=
7801: &reply("querysend:".$query.':'.&escape($uname.':'.$udom.':'.$group).
7802: ':'.&escape($file_name).':'.$action,$homeserver);
7803: my $reply = &get_query_reply($queryid);
7804: return $reply;
7805: }
7806:
7807: # -------------------------- Update MySQL allusers table
7808:
7809: sub update_allusers_table {
7810: my ($uname,$udom,$names) = @_;
7811: my $homeserver = &homeserver($uname,$udom);
7812: my $queryid=
7813: &reply('querysend:allusers:'.&escape($uname).':'.&escape($udom).':'.
7814: 'lastname='.&escape($names->{'lastname'}).'%%'.
7815: 'firstname='.&escape($names->{'firstname'}).'%%'.
7816: 'middlename='.&escape($names->{'middlename'}).'%%'.
7817: 'generation='.&escape($names->{'generation'}).'%%'.
7818: 'permanentemail='.&escape($names->{'permanentemail'}).'%%'.
7819: 'id='.&escape($names->{'id'}),$homeserver);
7820: return;
7821: }
7822:
7823: # ------- Request retrieval of institutional classlists for course(s)
7824:
7825: sub fetch_enrollment_query {
7826: my ($context,$affiliatesref,$replyref,$dom,$cnum) = @_;
7827: my $homeserver;
7828: my $maxtries = 1;
7829: if ($context eq 'automated') {
7830: $homeserver = $perlvar{'lonHostID'};
7831: $maxtries = 10; # will wait for up to 2000s for retrieval of classlist data before timeout
7832: } else {
7833: $homeserver = &homeserver($cnum,$dom);
7834: }
7835: my $host=&hostname($homeserver);
7836: my $cmd = '';
7837: foreach my $affiliate (keys(%{$affiliatesref})) {
7838: $cmd .= $affiliate.'='.join(",",@{$$affiliatesref{$affiliate}}).'%%';
7839: }
7840: $cmd =~ s/%%$//;
7841: $cmd = &escape($cmd);
7842: my $query = 'fetchenrollment';
7843: my $queryid=&reply("querysend:".$query.':'.$dom.':'.$env{'user.name'}.':'.$cmd,$homeserver);
7844: unless ($queryid=~/^\Q$host\E\_/) {
7845: &logthis('fetch_enrollment_query: invalid queryid: '.$queryid.' for host: '.$host.' and homeserver: '.$homeserver.' context: '.$context.' '.$cnum);
7846: return 'error: '.$queryid;
7847: }
7848: my $reply = &get_query_reply($queryid);
7849: my $tries = 1;
7850: while (($reply=~/^timeout/) && ($tries < $maxtries)) {
7851: $reply = &get_query_reply($queryid);
7852: $tries ++;
7853: }
7854: if ( ($reply =~/^timeout/) || ($reply =~/^error/) ) {
7855: &logthis('fetch_enrollment_query error: '.$reply.' for '.$dom.' '.$env{'user.name'}.' for '.$queryid.' context: '.$context.' '.$cnum.' maxtries: '.$maxtries.' tries: '.$tries);
7856: } else {
7857: my @responses = split(/:/,$reply);
7858: if ($homeserver eq $perlvar{'lonHostID'}) {
7859: foreach my $line (@responses) {
7860: my ($key,$value) = split(/=/,$line,2);
7861: $$replyref{$key} = $value;
7862: }
7863: } else {
7864: my $pathname = LONCAPA::tempdir();
7865: foreach my $line (@responses) {
7866: my ($key,$value) = split(/=/,$line);
7867: $$replyref{$key} = $value;
7868: if ($value > 0) {
7869: foreach my $item (@{$$affiliatesref{$key}}) {
7870: my $filename = $dom.'_'.$key.'_'.$item.'_classlist.xml';
7871: my $destname = $pathname.'/'.$filename;
7872: my $xml_classlist = &reply("autoretrieve:".$filename,$homeserver);
7873: if ($xml_classlist =~ /^error/) {
7874: &logthis('fetch_enrollment_query - autoretrieve error: '.$xml_classlist.' for '.$filename.' from server: '.$homeserver.' '.$context.' '.$cnum);
7875: } else {
7876: if ( open(FILE,">$destname") ) {
7877: print FILE &unescape($xml_classlist);
7878: close(FILE);
7879: } else {
7880: &logthis('fetch_enrollment_query - error opening classlist file '.$destname.' '.$context.' '.$cnum);
7881: }
7882: }
7883: }
7884: }
7885: }
7886: }
7887: return 'ok';
7888: }
7889: return 'error';
7890: }
7891:
7892: sub get_query_reply {
7893: my $queryid=shift;
7894: my $replyfile=LONCAPA::tempdir().$queryid;
7895: my $reply='';
7896: for (1..100) {
7897: sleep(0.2);
7898: if (-e $replyfile.'.end') {
7899: if (open(my $fh,$replyfile)) {
7900: $reply = join('',<$fh>);
7901: close($fh);
7902: } else { return 'error: reply_file_error'; }
7903: return &unescape($reply);
7904: }
7905: }
7906: return 'timeout:'.$queryid;
7907: }
7908:
7909: sub courselog_query {
7910: #
7911: # possible filters:
7912: # url: url or symb
7913: # username
7914: # domain
7915: # action: view, submit, grade
7916: # start: timestamp
7917: # end: timestamp
7918: #
7919: my (%filters)=@_;
7920: unless ($env{'request.course.id'}) { return 'no_course'; }
7921: if ($filters{'url'}) {
7922: $filters{'url'}=&symbclean(&declutter($filters{'url'}));
7923: $filters{'url'}=~s/\.(\w+)$/(\\.\\d+)*\\.$1/;
7924: $filters{'url'}=~s/\.(\w+)\_\_\_/(\\.\\d+)*\\.$1/;
7925: }
7926: my $cname=$env{'course.'.$env{'request.course.id'}.'.num'};
7927: my $cdom=$env{'course.'.$env{'request.course.id'}.'.domain'};
7928: return &log_query($cname,$cdom,'courselog',%filters);
7929: }
7930:
7931: sub userlog_query {
7932: #
7933: # possible filters:
7934: # action: log check role
7935: # start: timestamp
7936: # end: timestamp
7937: #
7938: my ($uname,$udom,%filters)=@_;
7939: return &log_query($uname,$udom,'userlog',%filters);
7940: }
7941:
7942: #--------- Call auto-enrollment subs in localenroll.pm for homeserver for course
7943:
7944: sub auto_run {
7945: my ($cnum,$cdom) = @_;
7946: my $response = 0;
7947: my $settings;
7948: my %domconfig = &get_dom('configuration',['autoenroll'],$cdom);
7949: if (ref($domconfig{'autoenroll'}) eq 'HASH') {
7950: $settings = $domconfig{'autoenroll'};
7951: if ($settings->{'run'} eq '1') {
7952: $response = 1;
7953: }
7954: } else {
7955: my $homeserver;
7956: if (&is_course($cdom,$cnum)) {
7957: $homeserver = &homeserver($cnum,$cdom);
7958: } else {
7959: $homeserver = &domain($cdom,'primary');
7960: }
7961: if ($homeserver ne 'no_host') {
7962: $response = &reply('autorun:'.$cdom,$homeserver);
7963: }
7964: }
7965: return $response;
7966: }
7967:
7968: sub auto_get_sections {
7969: my ($cnum,$cdom,$inst_coursecode) = @_;
7970: my $homeserver;
7971: if (($cdom =~ /^$match_domain$/) && ($cnum =~ /^$match_courseid$/)) {
7972: $homeserver = &homeserver($cnum,$cdom);
7973: }
7974: if (!defined($homeserver)) {
7975: if ($cdom =~ /^$match_domain$/) {
7976: $homeserver = &domain($cdom,'primary');
7977: }
7978: }
7979: my @secs;
7980: if (defined($homeserver)) {
7981: my $response=&unescape(&reply('autogetsections:'.$inst_coursecode.':'.$cdom,$homeserver));
7982: unless ($response eq 'refused') {
7983: @secs = split(/:/,$response);
7984: }
7985: }
7986: return @secs;
7987: }
7988:
7989: sub auto_new_course {
7990: my ($cnum,$cdom,$inst_course_id,$owner,$coowners) = @_;
7991: my $homeserver = &homeserver($cnum,$cdom);
7992: my $response=&unescape(&reply('autonewcourse:'.$inst_course_id.':'.&escape($owner).':'.$cdom.':'.&escape($coowners),$homeserver));
7993: return $response;
7994: }
7995:
7996: sub auto_validate_courseID {
7997: my ($cnum,$cdom,$inst_course_id) = @_;
7998: my $homeserver = &homeserver($cnum,$cdom);
7999: my $response=&unescape(&reply('autovalidatecourse:'.$inst_course_id.':'.$cdom,$homeserver));
8000: return $response;
8001: }
8002:
8003: sub auto_validate_instcode {
8004: my ($cnum,$cdom,$instcode,$owner) = @_;
8005: my ($homeserver,$response);
8006: if (($cdom =~ /^$match_domain$/) && ($cnum =~ /^$match_courseid$/)) {
8007: $homeserver = &homeserver($cnum,$cdom);
8008: }
8009: if (!defined($homeserver)) {
8010: if ($cdom =~ /^$match_domain$/) {
8011: $homeserver = &domain($cdom,'primary');
8012: }
8013: }
8014: $response=&unescape(&reply('autovalidateinstcode:'.$cdom.':'.
8015: &escape($instcode).':'.&escape($owner),$homeserver));
8016: my ($outcome,$description,$defaultcredits) = map { &unescape($_); } split('&',$response,3);
8017: return ($outcome,$description,$defaultcredits);
8018: }
8019:
8020: sub auto_create_password {
8021: my ($cnum,$cdom,$authparam,$udom) = @_;
8022: my ($homeserver,$response);
8023: my $create_passwd = 0;
8024: my $authchk = '';
8025: if ($udom =~ /^$match_domain$/) {
8026: $homeserver = &domain($udom,'primary');
8027: }
8028: if ($homeserver eq '') {
8029: if (($cdom =~ /^$match_domain$/) && ($cnum =~ /^$match_courseid$/)) {
8030: $homeserver = &homeserver($cnum,$cdom);
8031: }
8032: }
8033: if ($homeserver eq '') {
8034: $authchk = 'nodomain';
8035: } else {
8036: $response=&unescape(&reply('autocreatepassword:'.$authparam.':'.$cdom,$homeserver));
8037: if ($response eq 'refused') {
8038: $authchk = 'refused';
8039: } else {
8040: ($authparam,$create_passwd,$authchk) = split(/:/,$response);
8041: }
8042: }
8043: return ($authparam,$create_passwd,$authchk);
8044: }
8045:
8046: sub auto_photo_permission {
8047: my ($cnum,$cdom,$students) = @_;
8048: my $homeserver = &homeserver($cnum,$cdom);
8049: my ($outcome,$perm_reqd,$conditions) =
8050: split(/:/,&unescape(&reply('autophotopermission:'.$cdom,$homeserver)),3);
8051: if ($outcome =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
8052: return (undef,undef);
8053: }
8054: return ($outcome,$perm_reqd,$conditions);
8055: }
8056:
8057: sub auto_checkphotos {
8058: my ($uname,$udom,$pid) = @_;
8059: my $homeserver = &homeserver($uname,$udom);
8060: my ($result,$resulttype);
8061: my $outcome = &unescape(&reply('autophotocheck:'.&escape($udom).':'.
8062: &escape($uname).':'.&escape($pid),
8063: $homeserver));
8064: if ($outcome =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
8065: return (undef,undef);
8066: }
8067: if ($outcome) {
8068: ($result,$resulttype) = split(/:/,$outcome);
8069: }
8070: return ($result,$resulttype);
8071: }
8072:
8073: sub auto_photochoice {
8074: my ($cnum,$cdom) = @_;
8075: my $homeserver = &homeserver($cnum,$cdom);
8076: my ($update,$comment) = split(/:/,&unescape(&reply('autophotochoice:'.
8077: &escape($cdom),
8078: $homeserver)));
8079: if ($update =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
8080: return (undef,undef);
8081: }
8082: return ($update,$comment);
8083: }
8084:
8085: sub auto_photoupdate {
8086: my ($affiliatesref,$dom,$cnum,$photo) = @_;
8087: my $homeserver = &homeserver($cnum,$dom);
8088: my $host=&hostname($homeserver);
8089: my $cmd = '';
8090: my $maxtries = 1;
8091: foreach my $affiliate (keys(%{$affiliatesref})) {
8092: $cmd .= $affiliate.'='.join(",",@{$$affiliatesref{$affiliate}}).'%%';
8093: }
8094: $cmd =~ s/%%$//;
8095: $cmd = &escape($cmd);
8096: my $query = 'institutionalphotos';
8097: my $queryid=&reply("querysend:".$query.':'.$dom.':'.$cnum.':'.$cmd,$homeserver);
8098: unless ($queryid=~/^\Q$host\E\_/) {
8099: &logthis('institutionalphotos: invalid queryid: '.$queryid.' for host: '.$host.' and homeserver: '.$homeserver.' and course: '.$cnum);
8100: return 'error: '.$queryid;
8101: }
8102: my $reply = &get_query_reply($queryid);
8103: my $tries = 1;
8104: while (($reply=~/^timeout/) && ($tries < $maxtries)) {
8105: $reply = &get_query_reply($queryid);
8106: $tries ++;
8107: }
8108: if ( ($reply =~/^timeout/) || ($reply =~/^error/) ) {
8109: &logthis('institutionalphotos error: '.$reply.' for '.$dom.' '.$env{'user.name'}.' for '.$queryid.' course: '.$cnum.' maxtries: '.$maxtries.' tries: '.$tries);
8110: } else {
8111: my @responses = split(/:/,$reply);
8112: my $outcome = shift(@responses);
8113: foreach my $item (@responses) {
8114: my ($key,$value) = split(/=/,$item);
8115: $$photo{$key} = $value;
8116: }
8117: return $outcome;
8118: }
8119: return 'error';
8120: }
8121:
8122: sub auto_instcode_format {
8123: my ($caller,$codedom,$instcodes,$codes,$codetitles,$cat_titles,
8124: $cat_order) = @_;
8125: my $courses = '';
8126: my @homeservers;
8127: if ($caller eq 'global') {
8128: my %servers = &get_servers($codedom,'library');
8129: foreach my $tryserver (keys(%servers)) {
8130: if (!grep(/^\Q$tryserver\E$/,@homeservers)) {
8131: push(@homeservers,$tryserver);
8132: }
8133: }
8134: } elsif ($caller eq 'requests') {
8135: if ($codedom =~ /^$match_domain$/) {
8136: my $chome = &domain($codedom,'primary');
8137: unless ($chome eq 'no_host') {
8138: push(@homeservers,$chome);
8139: }
8140: }
8141: } else {
8142: push(@homeservers,&homeserver($caller,$codedom));
8143: }
8144: foreach my $code (keys(%{$instcodes})) {
8145: $courses .= &escape($code).'='.&escape($$instcodes{$code}).'&';
8146: }
8147: chop($courses);
8148: my $ok_response = 0;
8149: my $response;
8150: while (@homeservers > 0 && $ok_response == 0) {
8151: my $server = shift(@homeservers);
8152: $response=&reply('autoinstcodeformat:'.$codedom.':'.$courses,$server);
8153: if ($response !~ /(con_lost|error|no_such_host|refused)/) {
8154: my ($codes_str,$codetitles_str,$cat_titles_str,$cat_order_str) =
8155: split(/:/,$response);
8156: %{$codes} = (%{$codes},&str2hash($codes_str));
8157: push(@{$codetitles},&str2array($codetitles_str));
8158: %{$cat_titles} = (%{$cat_titles},&str2hash($cat_titles_str));
8159: %{$cat_order} = (%{$cat_order},&str2hash($cat_order_str));
8160: $ok_response = 1;
8161: }
8162: }
8163: if ($ok_response) {
8164: return 'ok';
8165: } else {
8166: return $response;
8167: }
8168: }
8169:
8170: sub auto_instcode_defaults {
8171: my ($domain,$returnhash,$code_order) = @_;
8172: my @homeservers;
8173:
8174: my %servers = &get_servers($domain,'library');
8175: foreach my $tryserver (keys(%servers)) {
8176: if (!grep(/^\Q$tryserver\E$/,@homeservers)) {
8177: push(@homeservers,$tryserver);
8178: }
8179: }
8180:
8181: my $response;
8182: foreach my $server (@homeservers) {
8183: $response=&reply('autoinstcodedefaults:'.$domain,$server);
8184: next if ($response =~ /(con_lost|error|no_such_host|refused)/);
8185:
8186: foreach my $pair (split(/\&/,$response)) {
8187: my ($name,$value)=split(/\=/,$pair);
8188: if ($name eq 'code_order') {
8189: @{$code_order} = split(/\&/,&unescape($value));
8190: } else {
8191: $returnhash->{&unescape($name)}=&unescape($value);
8192: }
8193: }
8194: return 'ok';
8195: }
8196:
8197: return $response;
8198: }
8199:
8200: sub auto_possible_instcodes {
8201: my ($domain,$codetitles,$cat_titles,$cat_orders,$code_order) = @_;
8202: unless ((ref($codetitles) eq 'ARRAY') && (ref($cat_titles) eq 'HASH') &&
8203: (ref($cat_orders) eq 'HASH') && (ref($code_order) eq 'ARRAY')) {
8204: return;
8205: }
8206: my (@homeservers,$uhome);
8207: if (defined(&domain($domain,'primary'))) {
8208: $uhome=&domain($domain,'primary');
8209: push(@homeservers,&domain($domain,'primary'));
8210: } else {
8211: my %servers = &get_servers($domain,'library');
8212: foreach my $tryserver (keys(%servers)) {
8213: if (!grep(/^\Q$tryserver\E$/,@homeservers)) {
8214: push(@homeservers,$tryserver);
8215: }
8216: }
8217: }
8218: my $response;
8219: foreach my $server (@homeservers) {
8220: $response=&reply('autopossibleinstcodes:'.$domain,$server);
8221: next if ($response =~ /(con_lost|error|no_such_host|refused)/);
8222: my ($codetitlestr,$codeorderstr,$cat_title,$cat_order) =
8223: split(':',$response);
8224: @{$codetitles} = map { &unescape($_); } (split('&',$codetitlestr));
8225: @{$code_order} = map { &unescape($_); } (split('&',$codeorderstr));
8226: foreach my $item (split('&',$cat_title)) {
8227: my ($name,$value)=split('=',$item);
8228: $cat_titles->{&unescape($name)}=&thaw_unescape($value);
8229: }
8230: foreach my $item (split('&',$cat_order)) {
8231: my ($name,$value)=split('=',$item);
8232: $cat_orders->{&unescape($name)}=&thaw_unescape($value);
8233: }
8234: return 'ok';
8235: }
8236: return $response;
8237: }
8238:
8239: sub auto_courserequest_checks {
8240: my ($dom) = @_;
8241: my ($homeserver,%validations);
8242: if ($dom =~ /^$match_domain$/) {
8243: $homeserver = &domain($dom,'primary');
8244: }
8245: unless ($homeserver eq 'no_host') {
8246: my $response=&reply('autocrsreqchecks:'.$dom,$homeserver);
8247: unless ($response =~ /(con_lost|error|no_such_host|refused)/) {
8248: my @items = split(/&/,$response);
8249: foreach my $item (@items) {
8250: my ($key,$value) = split('=',$item);
8251: $validations{&unescape($key)} = &thaw_unescape($value);
8252: }
8253: }
8254: }
8255: return %validations;
8256: }
8257:
8258: sub auto_courserequest_validation {
8259: my ($dom,$owner,$crstype,$inststatuslist,$instcode,$instseclist,$custominfo) = @_;
8260: my ($homeserver,$response);
8261: if ($dom =~ /^$match_domain$/) {
8262: $homeserver = &domain($dom,'primary');
8263: }
8264: unless ($homeserver eq 'no_host') {
8265: my $customdata;
8266: if (ref($custominfo) eq 'HASH') {
8267: $customdata = &freeze_escape($custominfo);
8268: }
8269: $response=&unescape(&reply('autocrsreqvalidation:'.$dom.':'.&escape($owner).
8270: ':'.&escape($crstype).':'.&escape($inststatuslist).
8271: ':'.&escape($instcode).':'.&escape($instseclist).':'.
8272: $customdata,$homeserver));
8273: }
8274: return $response;
8275: }
8276:
8277: sub auto_validate_class_sec {
8278: my ($cdom,$cnum,$owners,$inst_class) = @_;
8279: my $homeserver = &homeserver($cnum,$cdom);
8280: my $ownerlist;
8281: if (ref($owners) eq 'ARRAY') {
8282: $ownerlist = join(',',@{$owners});
8283: } else {
8284: $ownerlist = $owners;
8285: }
8286: my $response=&reply('autovalidateclass_sec:'.$inst_class.':'.
8287: &escape($ownerlist).':'.$cdom,$homeserver);
8288: return $response;
8289: }
8290:
8291: sub auto_crsreq_update {
8292: my ($cdom,$cnum,$crstype,$action,$ownername,$ownerdomain,$fullname,$title,
8293: $code,$accessstart,$accessend,$inbound) = @_;
8294: my ($homeserver,%crsreqresponse);
8295: if ($cdom =~ /^$match_domain$/) {
8296: $homeserver = &domain($cdom,'primary');
8297: }
8298: unless (($homeserver eq 'no_host') || ($homeserver eq '')) {
8299: my $info;
8300: if (ref($inbound) eq 'HASH') {
8301: $info = &freeze_escape($inbound);
8302: }
8303: my $response=&reply('autocrsrequpdate:'.$cdom.':'.$cnum.':'.&escape($crstype).
8304: ':'.&escape($action).':'.&escape($ownername).':'.
8305: &escape($ownerdomain).':'.&escape($fullname).':'.
8306: &escape($title).':'.&escape($code).':'.
8307: &escape($accessstart).':'.&escape($accessend).':'.$info,
8308: $homeserver);
8309: unless ($response =~ /(con_lost|error|no_such_host|refused)/) {
8310: my @items = split(/&/,$response);
8311: foreach my $item (@items) {
8312: my ($key,$value) = split('=',$item);
8313: $crsreqresponse{&unescape($key)} = &thaw_unescape($value);
8314: }
8315: }
8316: }
8317: return \%crsreqresponse;
8318: }
8319:
8320: sub auto_export_grades {
8321: my ($cdom,$cnum,$inforef,$gradesref) = @_;
8322: my ($homeserver,%exportresponse);
8323: if ($cdom =~ /^$match_domain$/) {
8324: $homeserver = &domain($cdom,'primary');
8325: }
8326: unless (($homeserver eq 'no_host') || ($homeserver eq '')) {
8327: my $info;
8328: if (ref($inforef) eq 'HASH') {
8329: $info = &freeze_escape($inforef);
8330: }
8331: if (ref($gradesref) eq 'HASH') {
8332: my $grades = &freeze_escape($gradesref);
8333: my $response=&reply('encrypt:autoexportgrades:'.$cdom.':'.$cnum.':'.
8334: $info.':'.$grades,$homeserver);
8335: unless ($response =~ /(con_lost|error|no_such_host|refused|unknown_command)/) {
8336: my @items = split(/&/,$response);
8337: foreach my $item (@items) {
8338: my ($key,$value) = split('=',$item);
8339: $exportresponse{&unescape($key)} = &thaw_unescape($value);
8340: }
8341: }
8342: }
8343: }
8344: return \%exportresponse;
8345: }
8346:
8347: sub check_instcode_cloning {
8348: my ($codedefaults,$code_order,$cloner,$clonefromcode,$clonetocode) = @_;
8349: unless ((ref($codedefaults) eq 'HASH') && (ref($code_order) eq 'ARRAY')) {
8350: return;
8351: }
8352: my $canclone;
8353: if (@{$code_order} > 0) {
8354: my $instcoderegexp ='^';
8355: my @clonecodes = split(/\&/,$cloner);
8356: foreach my $item (@{$code_order}) {
8357: if (grep(/^\Q$item\E=/,@clonecodes)) {
8358: foreach my $pair (@clonecodes) {
8359: my ($key,$val) = split(/\=/,$pair,2);
8360: $val = &unescape($val);
8361: if ($key eq $item) {
8362: $instcoderegexp .= '('.$val.')';
8363: last;
8364: }
8365: }
8366: } else {
8367: $instcoderegexp .= $codedefaults->{$item};
8368: }
8369: }
8370: $instcoderegexp .= '$';
8371: my (@from,@to);
8372: eval {
8373: (@from) = ($clonefromcode =~ /$instcoderegexp/);
8374: (@to) = ($clonetocode =~ /$instcoderegexp/);
8375: };
8376: if ((@from > 0) && (@to > 0)) {
8377: my @diffs = &Apache::loncommon::compare_arrays(\@from,\@to);
8378: if (!@diffs) {
8379: $canclone = 1;
8380: }
8381: }
8382: }
8383: return $canclone;
8384: }
8385:
8386: sub default_instcode_cloning {
8387: my ($clonedom,$domdefclone,$clonefromcode,$clonetocode,$codedefaultsref,$codeorderref) = @_;
8388: my (%codedefaults,@code_order,$canclone);
8389: if ((ref($codedefaultsref) eq 'HASH') && (ref($codeorderref) eq 'ARRAY')) {
8390: %codedefaults = %{$codedefaultsref};
8391: @code_order = @{$codeorderref};
8392: } elsif ($clonedom) {
8393: &auto_instcode_defaults($clonedom,\%codedefaults,\@code_order);
8394: }
8395: if (($domdefclone) && (@code_order)) {
8396: my @clonecodes = split(/\+/,$domdefclone);
8397: my $instcoderegexp ='^';
8398: foreach my $item (@code_order) {
8399: if (grep(/^\Q$item\E$/,@clonecodes)) {
8400: $instcoderegexp .= '('.$codedefaults{$item}.')';
8401: } else {
8402: $instcoderegexp .= $codedefaults{$item};
8403: }
8404: }
8405: $instcoderegexp .= '$';
8406: my (@from,@to);
8407: eval {
8408: (@from) = ($clonefromcode =~ /$instcoderegexp/);
8409: (@to) = ($clonetocode =~ /$instcoderegexp/);
8410: };
8411: if ((@from > 0) && (@to > 0)) {
8412: my @diffs = &Apache::loncommon::compare_arrays(\@from,\@to);
8413: if (!@diffs) {
8414: $canclone = 1;
8415: }
8416: }
8417: }
8418: return $canclone;
8419: }
8420:
8421: # ------------------------------------------------------- Course Group routines
8422:
8423: sub get_coursegroups {
8424: my ($cdom,$cnum,$group,$namespace) = @_;
8425: return(&dump($namespace,$cdom,$cnum,$group));
8426: }
8427:
8428: sub modify_coursegroup {
8429: my ($cdom,$cnum,$groupsettings) = @_;
8430: return(&put('coursegroups',$groupsettings,$cdom,$cnum));
8431: }
8432:
8433: sub toggle_coursegroup_status {
8434: my ($cdom,$cnum,$group,$action) = @_;
8435: my ($from_namespace,$to_namespace);
8436: if ($action eq 'delete') {
8437: $from_namespace = 'coursegroups';
8438: $to_namespace = 'deleted_groups';
8439: } else {
8440: $from_namespace = 'deleted_groups';
8441: $to_namespace = 'coursegroups';
8442: }
8443: my %curr_group = &get_coursegroups($cdom,$cnum,$group,$from_namespace);
8444: if (my $tmp = &error(%curr_group)) {
8445: &Apache::lonnet::logthis('Error retrieving group: '.$tmp.' in '.$cnum.':'.$cdom);
8446: return ('read error',$tmp);
8447: } else {
8448: my %savedsettings = %curr_group;
8449: my $result = &put($to_namespace,\%savedsettings,$cdom,$cnum);
8450: my $deloutcome;
8451: if ($result eq 'ok') {
8452: $deloutcome = &del($from_namespace,[$group],$cdom,$cnum);
8453: } else {
8454: return ('write error',$result);
8455: }
8456: if ($deloutcome eq 'ok') {
8457: return 'ok';
8458: } else {
8459: return ('delete error',$deloutcome);
8460: }
8461: }
8462: }
8463:
8464: sub modify_group_roles {
8465: my ($cdom,$cnum,$group_id,$user,$end,$start,$userprivs,$selfenroll,$context) = @_;
8466: my $url = '/'.$cdom.'/'.$cnum.'/'.$group_id;
8467: my $role = 'gr/'.&escape($userprivs);
8468: my ($uname,$udom) = split(/:/,$user);
8469: my $result = &assignrole($udom,$uname,$url,$role,$end,$start,'',$selfenroll,$context);
8470: if ($result eq 'ok') {
8471: &devalidate_getgroups_cache($udom,$uname,$cdom,$cnum);
8472: }
8473: return $result;
8474: }
8475:
8476: sub modify_coursegroup_membership {
8477: my ($cdom,$cnum,$membership) = @_;
8478: my $result = &put('groupmembership',$membership,$cdom,$cnum);
8479: return $result;
8480: }
8481:
8482: sub get_active_groups {
8483: my ($udom,$uname,$cdom,$cnum) = @_;
8484: my $now = time;
8485: my %groups = ();
8486: foreach my $key (keys(%env)) {
8487: if ($key =~ m-user\.role\.gr\./($match_domain)/($match_courseid)/(\w+)$-) {
8488: my ($start,$end) = split(/\./,$env{$key});
8489: if (($end!=0) && ($end<$now)) { next; }
8490: if (($start!=0) && ($start>$now)) { next; }
8491: if ($1 eq $cdom && $2 eq $cnum) {
8492: $groups{$3} = $env{$key} ;
8493: }
8494: }
8495: }
8496: return %groups;
8497: }
8498:
8499: sub get_group_membership {
8500: my ($cdom,$cnum,$group) = @_;
8501: return(&dump('groupmembership',$cdom,$cnum,$group));
8502: }
8503:
8504: sub get_users_groups {
8505: my ($udom,$uname,$courseid) = @_;
8506: my @usersgroups;
8507: my $cachetime=1800;
8508:
8509: my $hashid="$udom:$uname:$courseid";
8510: my ($grouplist,$cached)=&is_cached_new('getgroups',$hashid);
8511: if (defined($cached)) {
8512: @usersgroups = split(/:/,$grouplist);
8513: } else {
8514: $grouplist = '';
8515: my $courseurl = &courseid_to_courseurl($courseid);
8516: my %roleshash = &dump('roles',$udom,$uname,$courseurl);
8517: my $access_end = $env{'course.'.$courseid.
8518: '.default_enrollment_end_date'};
8519: my $now = time;
8520: foreach my $key (keys(%roleshash)) {
8521: if ($key =~ /^\Q$courseurl\E\/(\w+)\_gr$/) {
8522: my $group = $1;
8523: if ($roleshash{$key} =~ /_(\d+)_(\d+)$/) {
8524: my $start = $2;
8525: my $end = $1;
8526: if ($start == -1) { next; } # deleted from group
8527: if (($start!=0) && ($start>$now)) { next; }
8528: if (($end!=0) && ($end<$now)) {
8529: if ($access_end && $access_end < $now) {
8530: if ($access_end - $end < 86400) {
8531: push(@usersgroups,$group);
8532: }
8533: }
8534: next;
8535: }
8536: push(@usersgroups,$group);
8537: }
8538: }
8539: }
8540: @usersgroups = &sort_course_groups($courseid,@usersgroups);
8541: $grouplist = join(':',@usersgroups);
8542: &do_cache_new('getgroups',$hashid,$grouplist,$cachetime);
8543: }
8544: return @usersgroups;
8545: }
8546:
8547: sub devalidate_getgroups_cache {
8548: my ($udom,$uname,$cdom,$cnum)=@_;
8549: my $courseid = $cdom.'_'.$cnum;
8550:
8551: my $hashid="$udom:$uname:$courseid";
8552: &devalidate_cache_new('getgroups',$hashid);
8553: }
8554:
8555: # ------------------------------------------------------------------ Plain Text
8556:
8557: sub plaintext {
8558: my ($short,$type,$cid,$forcedefault) = @_;
8559: if ($short =~ m{^cr/}) {
8560: return (split('/',$short))[-1];
8561: }
8562: if (!defined($cid)) {
8563: $cid = $env{'request.course.id'};
8564: }
8565: my %rolenames = (
8566: Course => 'std',
8567: Community => 'alt1',
8568: Placement => 'std',
8569: );
8570: if ($cid ne '') {
8571: if ($env{'course.'.$cid.'.'.$short.'.plaintext'} ne '') {
8572: unless ($forcedefault) {
8573: my $roletext = $env{'course.'.$cid.'.'.$short.'.plaintext'};
8574: &Apache::lonlocal::mt_escape(\$roletext);
8575: return &Apache::lonlocal::mt($roletext);
8576: }
8577: }
8578: }
8579: if ((defined($type)) && (defined($rolenames{$type})) &&
8580: (defined($rolenames{$type})) &&
8581: (defined($prp{$short}{$rolenames{$type}}))) {
8582: return &Apache::lonlocal::mt($prp{$short}{$rolenames{$type}});
8583: } elsif ($cid ne '') {
8584: my $crstype = $env{'course.'.$cid.'.type'};
8585: if (($crstype ne '') && (defined($rolenames{$crstype})) &&
8586: (defined($prp{$short}{$rolenames{$crstype}}))) {
8587: return &Apache::lonlocal::mt($prp{$short}{$rolenames{$crstype}});
8588: }
8589: }
8590: return &Apache::lonlocal::mt($prp{$short}{'std'});
8591: }
8592:
8593: # ----------------------------------------------------------------- Assign Role
8594:
8595: sub assignrole {
8596: my ($udom,$uname,$url,$role,$end,$start,$deleteflag,$selfenroll,
8597: $context)=@_;
8598: my $mrole;
8599: if ($role =~ /^cr\//) {
8600: my $cwosec=$url;
8601: $cwosec=~s/^\/($match_domain)\/($match_courseid)\/.*/$1\/$2/;
8602: unless (&allowed('ccr',$cwosec)) {
8603: my $refused = 1;
8604: if ($context eq 'requestcourses') {
8605: if (($env{'user.name'} ne '') && ($env{'user.domain'} ne '')) {
8606: if ($role =~ m{^cr/($match_domain)/($match_username)/([^/]+)$}) {
8607: if (($1 eq $env{'user.domain'}) && ($2 eq $env{'user.name'})) {
8608: my ($cdom,$cnum) = ($cwosec =~ m{^/?($match_domain)/($match_courseid)$});
8609: my %crsenv = &userenvironment($cdom,$cnum,('internal.courseowner'));
8610: if ($crsenv{'internal.courseowner'} eq
8611: $env{'user.name'}.':'.$env{'user.domain'}) {
8612: $refused = '';
8613: }
8614: }
8615: }
8616: }
8617: }
8618: if ($refused) {
8619: &logthis('Refused custom assignrole: '.
8620: $udom.' '.$uname.' '.$url.' '.$role.' '.$end.' '.$start.
8621: ' by '.$env{'user.name'}.' at '.$env{'user.domain'});
8622: return 'refused';
8623: }
8624: }
8625: $mrole='cr';
8626: } elsif ($role =~ /^gr\//) {
8627: my $cwogrp=$url;
8628: $cwogrp=~s{^/($match_domain)/($match_courseid)/.*}{$1/$2};
8629: unless (&allowed('mdg',$cwogrp)) {
8630: &logthis('Refused group assignrole: '.
8631: $udom.' '.$uname.' '.$url.' '.$role.' '.$end.' '.$start.' by '.
8632: $env{'user.name'}.' at '.$env{'user.domain'});
8633: return 'refused';
8634: }
8635: $mrole='gr';
8636: } else {
8637: my $cwosec=$url;
8638: $cwosec=~s/^\/($match_domain)\/($match_courseid)\/.*/$1\/$2/;
8639: if (!(&allowed('c'.$role,$cwosec)) && !(&allowed('c'.$role,$udom))) {
8640: my $refused;
8641: if (($env{'request.course.sec'} ne '') && ($role eq 'st')) {
8642: if (!(&allowed('c'.$role,$url))) {
8643: $refused = 1;
8644: }
8645: } else {
8646: $refused = 1;
8647: }
8648: if ($refused) {
8649: my ($cdom,$cnum) = ($cwosec =~ m{^/?($match_domain)/($match_courseid)$});
8650: if (!$selfenroll && $context eq 'course') {
8651: my %crsenv;
8652: if ($role eq 'cc' || $role eq 'co') {
8653: %crsenv = &userenvironment($cdom,$cnum,('internal.courseowner'));
8654: if (($role eq 'cc') && ($cnum !~ /^$match_community$/)) {
8655: if ($env{'request.role'} eq 'cc./'.$cdom.'/'.$cnum) {
8656: if ($crsenv{'internal.courseowner'} eq
8657: $env{'user.name'}.':'.$env{'user.domain'}) {
8658: $refused = '';
8659: }
8660: }
8661: } elsif (($role eq 'co') && ($cnum =~ /^$match_community$/)) {
8662: if ($env{'request.role'} eq 'co./'.$cdom.'/'.$cnum) {
8663: if ($crsenv{'internal.courseowner'} eq
8664: $env{'user.name'}.':'.$env{'user.domain'}) {
8665: $refused = '';
8666: }
8667: }
8668: }
8669: }
8670: } elsif (($selfenroll == 1) && ($role eq 'st') && ($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'})) {
8671: $refused = '';
8672: } elsif ($context eq 'requestcourses') {
8673: my @possroles = ('st','ta','ep','in','cc','co');
8674: if ((grep(/^\Q$role\E$/,@possroles)) && ($env{'user.name'} ne '' && $env{'user.domain'} ne '')) {
8675: my $wrongcc;
8676: if ($cnum =~ /^$match_community$/) {
8677: $wrongcc = 1 if ($role eq 'cc');
8678: } else {
8679: $wrongcc = 1 if ($role eq 'co');
8680: }
8681: unless ($wrongcc) {
8682: my %crsenv = &userenvironment($cdom,$cnum,('internal.courseowner'));
8683: if ($crsenv{'internal.courseowner'} eq
8684: $env{'user.name'}.':'.$env{'user.domain'}) {
8685: $refused = '';
8686: }
8687: }
8688: }
8689: } elsif ($context eq 'requestauthor') {
8690: if (($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'}) &&
8691: ($url eq '/'.$udom.'/') && ($role eq 'au')) {
8692: if ($env{'environment.requestauthor'} eq 'automatic') {
8693: $refused = '';
8694: } else {
8695: my %domdefaults = &get_domain_defaults($udom);
8696: if (ref($domdefaults{'requestauthor'}) eq 'HASH') {
8697: my $checkbystatus;
8698: if ($env{'user.adv'}) {
8699: my $disposition = $domdefaults{'requestauthor'}{'_LC_adv'};
8700: if ($disposition eq 'automatic') {
8701: $refused = '';
8702: } elsif ($disposition eq '') {
8703: $checkbystatus = 1;
8704: }
8705: } else {
8706: $checkbystatus = 1;
8707: }
8708: if ($checkbystatus) {
8709: if ($env{'environment.inststatus'}) {
8710: my @inststatuses = split(/,/,$env{'environment.inststatus'});
8711: foreach my $type (@inststatuses) {
8712: if (($type ne '') &&
8713: ($domdefaults{'requestauthor'}{$type} eq 'automatic')) {
8714: $refused = '';
8715: }
8716: }
8717: } elsif ($domdefaults{'requestauthor'}{'default'} eq 'automatic') {
8718: $refused = '';
8719: }
8720: }
8721: }
8722: }
8723: }
8724: }
8725: if ($refused) {
8726: &logthis('Refused assignrole: '.$udom.' '.$uname.' '.$url.
8727: ' '.$role.' '.$end.' '.$start.' by '.
8728: $env{'user.name'}.' at '.$env{'user.domain'});
8729: return 'refused';
8730: }
8731: }
8732: } elsif ($role eq 'au') {
8733: if ($url ne '/'.$udom.'/') {
8734: &logthis('Attempt by '.$env{'user.name'}.':'.$env{'user.domain'}.
8735: ' to assign author role for '.$uname.':'.$udom.
8736: ' in domain: '.$url.' refused (wrong domain).');
8737: return 'refused';
8738: }
8739: }
8740: $mrole=$role;
8741: }
8742: my $command="encrypt:rolesput:$env{'user.domain'}:$env{'user.name'}:".
8743: "$udom:$uname:$url".'_'."$mrole=$role";
8744: if ($end) { $command.='_'.$end; }
8745: if ($start) {
8746: if ($end) {
8747: $command.='_'.$start;
8748: } else {
8749: $command.='_0_'.$start;
8750: }
8751: }
8752: my $origstart = $start;
8753: my $origend = $end;
8754: my $delflag;
8755: # actually delete
8756: if ($deleteflag) {
8757: if ((&allowed('dro',$udom)) || (&allowed('dro',$url))) {
8758: # modify command to delete the role
8759: $command="encrypt:rolesdel:$env{'user.domain'}:$env{'user.name'}:".
8760: "$udom:$uname:$url".'_'."$mrole";
8761: &logthis("$env{'user.name'} at $env{'user.domain'} deletes $mrole in $url for $uname at $udom");
8762: # set start and finish to negative values for userrolelog
8763: $start=-1;
8764: $end=-1;
8765: $delflag = 1;
8766: }
8767: }
8768: # send command
8769: my $answer=&reply($command,&homeserver($uname,$udom));
8770: # log new user role if status is ok
8771: if ($answer eq 'ok') {
8772: &userrolelog($role,$uname,$udom,$url,$start,$end);
8773: if (($role eq 'cc') || ($role eq 'in') ||
8774: ($role eq 'ep') || ($role eq 'ad') ||
8775: ($role eq 'ta') || ($role eq 'st') ||
8776: ($role=~/^cr/) || ($role eq 'gr') ||
8777: ($role eq 'co')) {
8778: # for course roles, perform group memberships changes triggered by role change.
8779: unless ($role =~ /^gr/) {
8780: &Apache::longroup::group_changes($udom,$uname,$url,$role,$origend,
8781: $origstart,$selfenroll,$context);
8782: }
8783: &courserolelog($role,$uname,$udom,$url,$origstart,$origend,$delflag,
8784: $selfenroll,$context);
8785: } elsif (($role eq 'li') || ($role eq 'dg') || ($role eq 'sc') ||
8786: ($role eq 'au') || ($role eq 'dc')) {
8787: &domainrolelog($role,$uname,$udom,$url,$origstart,$origend,$delflag,
8788: $context);
8789: } elsif (($role eq 'ca') || ($role eq 'aa')) {
8790: &coauthorrolelog($role,$uname,$udom,$url,$origstart,$origend,$delflag,
8791: $context);
8792: }
8793: if ($role eq 'cc') {
8794: &autoupdate_coowners($url,$end,$start,$uname,$udom);
8795: }
8796: }
8797: return $answer;
8798: }
8799:
8800: sub autoupdate_coowners {
8801: my ($url,$end,$start,$uname,$udom) = @_;
8802: my ($cdom,$cnum) = ($url =~ m{^/($match_domain)/($match_courseid)});
8803: if (($cdom ne '') && ($cnum ne '')) {
8804: my $now = time;
8805: my %domdesign = &Apache::loncommon::get_domainconf($cdom);
8806: if ($domdesign{$cdom.'.autoassign.co-owners'}) {
8807: my %coursehash = &coursedescription($cdom.'_'.$cnum);
8808: my $instcode = $coursehash{'internal.coursecode'};
8809: if ($instcode ne '') {
8810: if (($start && $start <= $now) && ($end == 0) || ($end > $now)) {
8811: unless ($coursehash{'internal.courseowner'} eq $uname.':'.$udom) {
8812: my ($delcoowners,@newcoowners,$putresult,$delresult,$coowners);
8813: my ($result,$desc) = &auto_validate_instcode($cnum,$cdom,$instcode,$uname.':'.$udom);
8814: if ($result eq 'valid') {
8815: if ($coursehash{'internal.co-owners'}) {
8816: foreach my $coowner (split(',',$coursehash{'internal.co-owners'})) {
8817: push(@newcoowners,$coowner);
8818: }
8819: unless (grep(/^\Q$uname\E:\Q$udom\E$/,@newcoowners)) {
8820: push(@newcoowners,$uname.':'.$udom);
8821: }
8822: @newcoowners = sort(@newcoowners);
8823: } else {
8824: push(@newcoowners,$uname.':'.$udom);
8825: }
8826: } else {
8827: if ($coursehash{'internal.co-owners'}) {
8828: foreach my $coowner (split(',',$coursehash{'internal.co-owners'})) {
8829: unless ($coowner eq $uname.':'.$udom) {
8830: push(@newcoowners,$coowner);
8831: }
8832: }
8833: unless (@newcoowners > 0) {
8834: $delcoowners = 1;
8835: $coowners = '';
8836: }
8837: }
8838: }
8839: if (@newcoowners || $delcoowners) {
8840: &store_coowners($cdom,$cnum,$coursehash{'home'},
8841: $delcoowners,@newcoowners);
8842: }
8843: }
8844: }
8845: }
8846: }
8847: }
8848: }
8849:
8850: sub store_coowners {
8851: my ($cdom,$cnum,$chome,$delcoowners,@newcoowners) = @_;
8852: my $cid = $cdom.'_'.$cnum;
8853: my ($coowners,$delresult,$putresult);
8854: if (@newcoowners) {
8855: $coowners = join(',',@newcoowners);
8856: my %coownershash = (
8857: 'internal.co-owners' => $coowners,
8858: );
8859: $putresult = &put('environment',\%coownershash,$cdom,$cnum);
8860: if ($putresult eq 'ok') {
8861: if ($env{'course.'.$cid.'.num'} eq $cnum) {
8862: &appenv({'course.'.$cid.'.internal.co-owners' => $coowners});
8863: }
8864: }
8865: }
8866: if ($delcoowners) {
8867: $delresult = &Apache::lonnet::del('environment',['internal.co-owners'],$cdom,$cnum);
8868: if ($delresult eq 'ok') {
8869: if ($env{'course.'.$cid.'.internal.co-owners'}) {
8870: &Apache::lonnet::delenv('course.'.$cid.'.internal.co-owners');
8871: }
8872: }
8873: }
8874: if (($putresult eq 'ok') || ($delresult eq 'ok')) {
8875: my %crsinfo =
8876: &Apache::lonnet::courseiddump($cdom,'.',1,'.','.',$cnum,undef,undef,'.');
8877: if (ref($crsinfo{$cid}) eq 'HASH') {
8878: $crsinfo{$cid}{'co-owners'} = \@newcoowners;
8879: my $cidput = &Apache::lonnet::courseidput($cdom,\%crsinfo,$chome,'notime');
8880: }
8881: }
8882: }
8883:
8884: # -------------------------------------------------- Modify user authentication
8885: # Overrides without validation
8886:
8887: sub modifyuserauth {
8888: my ($udom,$uname,$umode,$upass)=@_;
8889: my $uhome=&homeserver($uname,$udom);
8890: unless (&allowed('mau',$udom)) { return 'refused'; }
8891: &logthis('Call to modify user authentication '.$udom.', '.$uname.', '.
8892: $umode.' by '.$env{'user.name'}.' at '.$env{'user.domain'}.
8893: ' in domain '.$env{'request.role.domain'});
8894: my $reply=&reply('encrypt:changeuserauth:'.$udom.':'.$uname.':'.$umode.':'.
8895: &escape($upass),$uhome);
8896: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},
8897: 'Authentication changed for '.$udom.', '.$uname.', '.$umode.
8898: '(Remote '.$ENV{'REMOTE_ADDR'}.'): '.$reply);
8899: &log($udom,,$uname,$uhome,
8900: 'Authentication changed by '.$env{'user.domain'}.', '.
8901: $env{'user.name'}.', '.$umode.
8902: '(Remote '.$ENV{'REMOTE_ADDR'}.'): '.$reply);
8903: unless ($reply eq 'ok') {
8904: &logthis('Authentication mode error: '.$reply);
8905: return 'error: '.$reply;
8906: }
8907: return 'ok';
8908: }
8909:
8910: # --------------------------------------------------------------- Modify a user
8911:
8912: sub modifyuser {
8913: my ($udom, $uname, $uid,
8914: $umode, $upass, $first,
8915: $middle, $last, $gene,
8916: $forceid, $desiredhome, $email, $inststatus, $candelete)=@_;
8917: $udom= &LONCAPA::clean_domain($udom);
8918: $uname=&LONCAPA::clean_username($uname);
8919: my $showcandelete = 'none';
8920: if (ref($candelete) eq 'ARRAY') {
8921: if (@{$candelete} > 0) {
8922: $showcandelete = join(', ',@{$candelete});
8923: }
8924: }
8925: &logthis('Call to modify user '.$udom.', '.$uname.', '.$uid.', '.
8926: $umode.', '.$first.', '.$middle.', '.
8927: $last.', '.$gene.'(forceid: '.$forceid.'; candelete: '.$showcandelete.')'.
8928: (defined($desiredhome) ? ' desiredhome = '.$desiredhome :
8929: ' desiredhome not specified').
8930: ' by '.$env{'user.name'}.' at '.$env{'user.domain'}.
8931: ' in domain '.$env{'request.role.domain'});
8932: my $uhome=&homeserver($uname,$udom,'true');
8933: my $newuser;
8934: if ($uhome eq 'no_host') {
8935: $newuser = 1;
8936: }
8937: # ----------------------------------------------------------------- Create User
8938: if (($uhome eq 'no_host') &&
8939: (($umode && $upass) || ($umode eq 'localauth'))) {
8940: my $unhome='';
8941: if (defined($desiredhome) && &host_domain($desiredhome) eq $udom) {
8942: $unhome = $desiredhome;
8943: } elsif($env{'course.'.$env{'request.course.id'}.'.domain'} eq $udom) {
8944: $unhome=$env{'course.'.$env{'request.course.id'}.'.home'};
8945: } else { # load balancing routine for determining $unhome
8946: my $loadm=10000000;
8947: my %servers = &get_servers($udom,'library');
8948: foreach my $tryserver (keys(%servers)) {
8949: my $answer=reply('load',$tryserver);
8950: if (($answer=~/\d+/) && ($answer<$loadm)) {
8951: $loadm=$answer;
8952: $unhome=$tryserver;
8953: }
8954: }
8955: }
8956: if (($unhome eq '') || ($unhome eq 'no_host')) {
8957: return 'error: unable to find a home server for '.$uname.
8958: ' in domain '.$udom;
8959: }
8960: my $reply=&reply('encrypt:makeuser:'.$udom.':'.$uname.':'.$umode.':'.
8961: &escape($upass),$unhome);
8962: unless ($reply eq 'ok') {
8963: return 'error: '.$reply;
8964: }
8965: $uhome=&homeserver($uname,$udom,'true');
8966: if (($uhome eq '') || ($uhome eq 'no_host') || ($uhome ne $unhome)) {
8967: return 'error: unable verify users home machine.';
8968: }
8969: } # End of creation of new user
8970: # ---------------------------------------------------------------------- Add ID
8971: if ($uid) {
8972: $uid=~tr/A-Z/a-z/;
8973: my %uidhash=&idrget($udom,$uname);
8974: if (($uidhash{$uname}) && ($uidhash{$uname}!~/error\:/)
8975: && (!$forceid)) {
8976: unless ($uid eq $uidhash{$uname}) {
8977: return 'error: user id "'.$uid.'" does not match '.
8978: 'current user id "'.$uidhash{$uname}.'".';
8979: }
8980: } else {
8981: &idput($udom,{$uname => $uid},$uhome,'ids');
8982: }
8983: }
8984: # -------------------------------------------------------------- Add names, etc
8985: my @tmp=&get('environment',
8986: ['firstname','middlename','lastname','generation','id',
8987: 'permanentemail','inststatus'],
8988: $udom,$uname);
8989: my (%names,%oldnames);
8990: if ($tmp[0] =~ m/^error:.*/) {
8991: %names=();
8992: } else {
8993: %names = @tmp;
8994: %oldnames = %names;
8995: }
8996: #
8997: # If name, email and/or uid are blank (e.g., because an uploaded file
8998: # of users did not contain them), do not overwrite existing values
8999: # unless field is in $candelete array ref.
9000: #
9001:
9002: my @fields = ('firstname','middlename','lastname','generation',
9003: 'permanentemail','id');
9004: my %newvalues;
9005: if (ref($candelete) eq 'ARRAY') {
9006: foreach my $field (@fields) {
9007: if (grep(/^\Q$field\E$/,@{$candelete})) {
9008: if ($field eq 'firstname') {
9009: $names{$field} = $first;
9010: } elsif ($field eq 'middlename') {
9011: $names{$field} = $middle;
9012: } elsif ($field eq 'lastname') {
9013: $names{$field} = $last;
9014: } elsif ($field eq 'generation') {
9015: $names{$field} = $gene;
9016: } elsif ($field eq 'permanentemail') {
9017: $names{$field} = $email;
9018: } elsif ($field eq 'id') {
9019: $names{$field} = $uid;
9020: }
9021: }
9022: }
9023: }
9024: if ($first) { $names{'firstname'} = $first; }
9025: if (defined($middle)) { $names{'middlename'} = $middle; }
9026: if ($last) { $names{'lastname'} = $last; }
9027: if (defined($gene)) { $names{'generation'} = $gene; }
9028: if ($email) {
9029: $email=~s/[^\w\@\.\-\,]//gs;
9030: if ($email=~/\@/) { $names{'permanentemail'} = $email; }
9031: }
9032: if ($uid) { $names{'id'} = $uid; }
9033: if (defined($inststatus)) {
9034: $names{'inststatus'} = '';
9035: my ($usertypes,$typesorder) = &retrieve_inst_usertypes($udom);
9036: if (ref($usertypes) eq 'HASH') {
9037: my @okstatuses;
9038: foreach my $item (split(/:/,$inststatus)) {
9039: if (defined($usertypes->{$item})) {
9040: push(@okstatuses,$item);
9041: }
9042: }
9043: if (@okstatuses) {
9044: $names{'inststatus'} = join(':', map { &escape($_); } @okstatuses);
9045: }
9046: }
9047: }
9048: my $logmsg = $udom.', '.$uname.', '.$uid.', '.
9049: $umode.', '.$first.', '.$middle.', '.
9050: $last.', '.$gene.', '.$email.', '.$inststatus;
9051: if ($env{'user.name'} ne '' && $env{'user.domain'}) {
9052: $logmsg .= ' by '.$env{'user.name'}.' at '.$env{'user.domain'};
9053: } else {
9054: $logmsg .= ' during self creation';
9055: }
9056: my $changed;
9057: if ($newuser) {
9058: $changed = 1;
9059: } else {
9060: foreach my $field (@fields) {
9061: if ($names{$field} ne $oldnames{$field}) {
9062: $changed = 1;
9063: last;
9064: }
9065: }
9066: }
9067: unless ($changed) {
9068: $logmsg = 'No changes in user information needed for: '.$logmsg;
9069: &logthis($logmsg);
9070: return 'ok';
9071: }
9072: my $reply = &put('environment', \%names, $udom,$uname);
9073: if ($reply ne 'ok') {
9074: return 'error: '.$reply;
9075: }
9076: if ($names{'permanentemail'} ne $oldnames{'permanentemail'}) {
9077: &Apache::lonnet::devalidate_cache_new('emailscache',$uname.':'.$udom);
9078: }
9079: my $sqlresult = &update_allusers_table($uname,$udom,\%names);
9080: &devalidate_cache_new('namescache',$uname.':'.$udom);
9081: $logmsg = 'Success modifying user '.$logmsg;
9082: &logthis($logmsg);
9083: return 'ok';
9084: }
9085:
9086: # -------------------------------------------------------------- Modify student
9087:
9088: sub modifystudent {
9089: my ($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene,$usec,
9090: $end,$start,$forceid,$desiredhome,$email,$type,$locktype,$cid,
9091: $selfenroll,$context,$inststatus,$credits)=@_;
9092: if (!$cid) {
9093: unless ($cid=$env{'request.course.id'}) {
9094: return 'not_in_class';
9095: }
9096: }
9097: # --------------------------------------------------------------- Make the user
9098: my $reply=&modifyuser
9099: ($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene,$forceid,
9100: $desiredhome,$email,$inststatus);
9101: unless ($reply eq 'ok') { return $reply; }
9102: # This will cause &modify_student_enrollment to get the uid from the
9103: # student's environment
9104: $uid = undef if (!$forceid);
9105: $reply = &modify_student_enrollment($udom,$uname,$uid,$first,$middle,$last,
9106: $gene,$usec,$end,$start,$type,$locktype,
9107: $cid,$selfenroll,$context,$credits);
9108: return $reply;
9109: }
9110:
9111: sub modify_student_enrollment {
9112: my ($udom,$uname,$uid,$first,$middle,$last,$gene,$usec,$end,$start,$type,
9113: $locktype,$cid,$selfenroll,$context,$credits) = @_;
9114: my ($cdom,$cnum,$chome);
9115: if (!$cid) {
9116: unless ($cid=$env{'request.course.id'}) {
9117: return 'not_in_class';
9118: }
9119: $cdom=$env{'course.'.$cid.'.domain'};
9120: $cnum=$env{'course.'.$cid.'.num'};
9121: } else {
9122: ($cdom,$cnum)=split(/_/,$cid);
9123: }
9124: $chome=$env{'course.'.$cid.'.home'};
9125: if (!$chome) {
9126: $chome=&homeserver($cnum,$cdom);
9127: }
9128: if (!$chome) { return 'unknown_course'; }
9129: # Make sure the user exists
9130: my $uhome=&homeserver($uname,$udom);
9131: if (($uhome eq '') || ($uhome eq 'no_host')) {
9132: return 'error: no such user';
9133: }
9134: # Get student data if we were not given enough information
9135: if (!defined($first) || $first eq '' ||
9136: !defined($last) || $last eq '' ||
9137: !defined($uid) || $uid eq '' ||
9138: !defined($middle) || $middle eq '' ||
9139: !defined($gene) || $gene eq '') {
9140: # They did not supply us with enough data to enroll the student, so
9141: # we need to pick up more information.
9142: my %tmp = &get('environment',
9143: ['firstname','middlename','lastname', 'generation','id']
9144: ,$udom,$uname);
9145:
9146: #foreach my $key (keys(%tmp)) {
9147: # &logthis("key $key = ".$tmp{$key});
9148: #}
9149: $first = $tmp{'firstname'} if (!defined($first) || $first eq '');
9150: $middle = $tmp{'middlename'} if (!defined($middle) || $middle eq '');
9151: $last = $tmp{'lastname'} if (!defined($last) || $last eq '');
9152: $gene = $tmp{'generation'} if (!defined($gene) || $gene eq '');
9153: $uid = $tmp{'id'} if (!defined($uid) || $uid eq '');
9154: }
9155: my $fullname = &format_name($first,$middle,$last,$gene,'lastname');
9156: my $user = "$uname:$udom";
9157: my %old_entry = &Apache::lonnet::get('classlist',[$user],$cdom,$cnum);
9158: my $reply=cput('classlist',
9159: {$user =>
9160: join(':',$end,$start,$uid,$usec,$fullname,$type,$locktype,$credits) },
9161: $cdom,$cnum);
9162: if (($reply eq 'ok') || ($reply eq 'delayed')) {
9163: &devalidate_getsection_cache($udom,$uname,$cid);
9164: } else {
9165: return 'error: '.$reply;
9166: }
9167: # Add student role to user
9168: my $uurl='/'.$cid;
9169: $uurl=~s/\_/\//g;
9170: if ($usec) {
9171: $uurl.='/'.$usec;
9172: }
9173: my $result = &assignrole($udom,$uname,$uurl,'st',$end,$start,undef,
9174: $selfenroll,$context);
9175: if ($result ne 'ok') {
9176: if ($old_entry{$user} ne '') {
9177: $reply = &cput('classlist',\%old_entry,$cdom,$cnum);
9178: } else {
9179: $reply = &del('classlist',[$user],$cdom,$cnum);
9180: }
9181: }
9182: return $result;
9183: }
9184:
9185: sub format_name {
9186: my ($firstname,$middlename,$lastname,$generation,$first)=@_;
9187: my $name;
9188: if ($first ne 'lastname') {
9189: $name=$firstname.' '.$middlename.' '.$lastname.' '.$generation;
9190: } else {
9191: if ($lastname=~/\S/) {
9192: $name.= $lastname.' '.$generation.', '.$firstname.' '.$middlename;
9193: $name=~s/\s+,/,/;
9194: } else {
9195: $name.= $firstname.' '.$middlename.' '.$generation;
9196: }
9197: }
9198: $name=~s/^\s+//;
9199: $name=~s/\s+$//;
9200: $name=~s/\s+/ /g;
9201: return $name;
9202: }
9203:
9204: # ------------------------------------------------- Write to course preferences
9205:
9206: sub writecoursepref {
9207: my ($courseid,%prefs)=@_;
9208: $courseid=~s/^\///;
9209: $courseid=~s/\_/\//g;
9210: my ($cdomain,$cnum)=split(/\//,$courseid);
9211: my $chome=homeserver($cnum,$cdomain);
9212: if (($chome eq '') || ($chome eq 'no_host')) {
9213: return 'error: no such course';
9214: }
9215: my $cstring='';
9216: foreach my $pref (keys(%prefs)) {
9217: $cstring.=&escape($pref).'='.&escape($prefs{$pref}).'&';
9218: }
9219: $cstring=~s/\&$//;
9220: return reply('put:'.$cdomain.':'.$cnum.':environment:'.$cstring,$chome);
9221: }
9222:
9223: # ---------------------------------------------------------- Make/modify course
9224:
9225: sub createcourse {
9226: my ($udom,$description,$url,$course_server,$nonstandard,$inst_code,
9227: $course_owner,$crstype,$cnum,$context,$category)=@_;
9228: $url=&declutter($url);
9229: my $cid='';
9230: if ($context eq 'requestcourses') {
9231: my $can_create = 0;
9232: my ($ownername,$ownerdom) = split(':',$course_owner);
9233: if ($udom eq $ownerdom) {
9234: if (&usertools_access($ownername,$ownerdom,$category,undef,
9235: $context)) {
9236: $can_create = 1;
9237: }
9238: } else {
9239: my %userenv = &userenvironment($ownerdom,$ownername,'reqcrsotherdom.'.
9240: $category);
9241: if ($userenv{'reqcrsotherdom.'.$category} ne '') {
9242: my @curr = split(',',$userenv{'reqcrsotherdom.'.$category});
9243: if (@curr > 0) {
9244: my @options = qw(approval validate autolimit);
9245: my $optregex = join('|',@options);
9246: if (grep(/^\Q$udom\E:($optregex)(=?\d*)$/,@curr)) {
9247: $can_create = 1;
9248: }
9249: }
9250: }
9251: }
9252: if ($can_create) {
9253: unless ($ownername eq $env{'user.name'} && $ownerdom eq $env{'user.domain'}) {
9254: unless (&allowed('ccc',$udom)) {
9255: return 'refused';
9256: }
9257: }
9258: } else {
9259: return 'refused';
9260: }
9261: } elsif (!&allowed('ccc',$udom)) {
9262: return 'refused';
9263: }
9264: # --------------------------------------------------------------- Get Unique ID
9265: my $uname;
9266: if ($cnum =~ /^$match_courseid$/) {
9267: my $chome=&homeserver($cnum,$udom,'true');
9268: if (($chome eq '') || ($chome eq 'no_host')) {
9269: $uname = $cnum;
9270: } else {
9271: $uname = &generate_coursenum($udom,$crstype);
9272: }
9273: } else {
9274: $uname = &generate_coursenum($udom,$crstype);
9275: }
9276: return $uname if ($uname =~ /^error/);
9277: # -------------------------------------------------- Check supplied server name
9278: if (!defined($course_server)) {
9279: if (defined(&domain($udom,'primary'))) {
9280: $course_server = &domain($udom,'primary');
9281: } else {
9282: $course_server = $env{'user.home'};
9283: }
9284: }
9285: my %host_servers =
9286: &Apache::lonnet::get_servers($udom,'library');
9287: unless ($host_servers{$course_server}) {
9288: return 'error: invalid home server for course: '.$course_server;
9289: }
9290: # ------------------------------------------------------------- Make the course
9291: my $reply=&reply('encrypt:makeuser:'.$udom.':'.$uname.':none::',
9292: $course_server);
9293: unless ($reply eq 'ok') { return 'error: '.$reply; }
9294: my $uhome=&homeserver($uname,$udom,'true');
9295: if (($uhome eq '') || ($uhome eq 'no_host')) {
9296: return 'error: no such course';
9297: }
9298: # ----------------------------------------------------------------- Course made
9299: # log existence
9300: my $now = time;
9301: my $newcourse = {
9302: $udom.'_'.$uname => {
9303: description => $description,
9304: inst_code => $inst_code,
9305: owner => $course_owner,
9306: type => $crstype,
9307: creator => $env{'user.name'}.':'.
9308: $env{'user.domain'},
9309: created => $now,
9310: context => $context,
9311: },
9312: };
9313: &courseidput($udom,$newcourse,$uhome,'notime');
9314: # set toplevel url
9315: my $topurl=$url;
9316: unless ($nonstandard) {
9317: # ------------------------------------------ For standard courses, make top url
9318: my $mapurl=&clutter($url);
9319: if ($mapurl eq '/res/') { $mapurl=''; }
9320: $env{'form.initmap'}=(<<ENDINITMAP);
9321: <map>
9322: <resource id="1" type="start"></resource>
9323: <resource id="2" src="$mapurl"></resource>
9324: <resource id="3" type="finish"></resource>
9325: <link index="1" from="1" to="2"></link>
9326: <link index="2" from="2" to="3"></link>
9327: </map>
9328: ENDINITMAP
9329: $topurl=&declutter(
9330: &finishuserfileupload($uname,$udom,'initmap','default.sequence')
9331: );
9332: }
9333: # ----------------------------------------------------------- Write preferences
9334: &writecoursepref($udom.'_'.$uname,
9335: ('description' => $description,
9336: 'url' => $topurl,
9337: 'internal.creator' => $env{'user.name'}.':'.
9338: $env{'user.domain'},
9339: 'internal.created' => $now,
9340: 'internal.creationcontext' => $context)
9341: );
9342: return '/'.$udom.'/'.$uname;
9343: }
9344:
9345: # ------------------------------------------------------------------- Create ID
9346: sub generate_coursenum {
9347: my ($udom,$crstype) = @_;
9348: my $domdesc = &domain($udom);
9349: return 'error: invalid domain' if ($domdesc eq '');
9350: my $first;
9351: if ($crstype eq 'Community') {
9352: $first = '0';
9353: } else {
9354: $first = int(1+rand(9));
9355: }
9356: my $uname=$first.
9357: ('a'..'z','A'..'Z','0'..'9')[int(rand(62))].
9358: substr($$.time,0,5).unpack("H8",pack("I32",time)).
9359: unpack("H2",pack("I32",int(rand(255)))).$perlvar{'lonHostID'};
9360: # ----------------------------------------------- Make sure that does not exist
9361: my $uhome=&homeserver($uname,$udom,'true');
9362: unless (($uhome eq '') || ($uhome eq 'no_host')) {
9363: if ($crstype eq 'Community') {
9364: $first = '0';
9365: } else {
9366: $first = int(1+rand(9));
9367: }
9368: $uname=$first.
9369: ('a'..'z','A'..'Z','0'..'9')[int(rand(62))].
9370: substr($$.time,0,5).unpack("H8",pack("I32",time)).
9371: unpack("H2",pack("I32",int(rand(255)))).$perlvar{'lonHostID'};
9372: $uhome=&homeserver($uname,$udom,'true');
9373: unless (($uhome eq '') || ($uhome eq 'no_host')) {
9374: return 'error: unable to generate unique course-ID';
9375: }
9376: }
9377: return $uname;
9378: }
9379:
9380: sub is_course {
9381: my ($cdom, $cnum) = scalar(@_) == 1 ?
9382: ($_[0] =~ /^($match_domain)_($match_courseid)$/) : @_;
9383:
9384: return unless $cdom and $cnum;
9385:
9386: my %courses = &courseiddump($cdom, '.', 1, '.', '.', $cnum, undef, undef,
9387: '.');
9388:
9389: return unless(exists($courses{$cdom.'_'.$cnum}));
9390: return wantarray ? ($cdom, $cnum) : $cdom.'_'.$cnum;
9391: }
9392:
9393: sub store_userdata {
9394: my ($storehash,$datakey,$namespace,$udom,$uname) = @_;
9395: my $result;
9396: if ($datakey ne '') {
9397: if (ref($storehash) eq 'HASH') {
9398: if ($udom eq '' || $uname eq '') {
9399: $udom = $env{'user.domain'};
9400: $uname = $env{'user.name'};
9401: }
9402: my $uhome=&homeserver($uname,$udom);
9403: if (($uhome eq '') || ($uhome eq 'no_host')) {
9404: $result = 'error: no_host';
9405: } else {
9406: $storehash->{'ip'} = $ENV{'REMOTE_ADDR'};
9407: $storehash->{'host'} = $perlvar{'lonHostID'};
9408:
9409: my $namevalue='';
9410: foreach my $key (keys(%{$storehash})) {
9411: $namevalue.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
9412: }
9413: $namevalue=~s/\&$//;
9414: unless ($namespace eq 'courserequests') {
9415: $datakey = &escape($datakey);
9416: }
9417: $result = &reply("store:$udom:$uname:$namespace:$datakey:".
9418: $namevalue,$uhome);
9419: }
9420: } else {
9421: $result = 'error: data to store was not a hash reference';
9422: }
9423: } else {
9424: $result= 'error: invalid requestkey';
9425: }
9426: return $result;
9427: }
9428:
9429: # ---------------------------------------------------------- Assign Custom Role
9430:
9431: sub assigncustomrole {
9432: my ($udom,$uname,$url,$rdom,$rnam,$rolename,$end,$start,$deleteflag,$selfenroll,$context)=@_;
9433: return &assignrole($udom,$uname,$url,'cr/'.$rdom.'/'.$rnam.'/'.$rolename,
9434: $end,$start,$deleteflag,$selfenroll,$context);
9435: }
9436:
9437: # ----------------------------------------------------------------- Revoke Role
9438:
9439: sub revokerole {
9440: my ($udom,$uname,$url,$role,$deleteflag,$selfenroll,$context)=@_;
9441: my $now=time;
9442: return &assignrole($udom,$uname,$url,$role,$now,undef,$deleteflag,$selfenroll,$context);
9443: }
9444:
9445: # ---------------------------------------------------------- Revoke Custom Role
9446:
9447: sub revokecustomrole {
9448: my ($udom,$uname,$url,$rdom,$rnam,$rolename,$deleteflag,$selfenroll,$context)=@_;
9449: my $now=time;
9450: return &assigncustomrole($udom,$uname,$url,$rdom,$rnam,$rolename,$now,
9451: $deleteflag,$selfenroll,$context);
9452: }
9453:
9454: # ------------------------------------------------------------ Disk usage
9455: sub diskusage {
9456: my ($udom,$uname,$directorypath,$getpropath)=@_;
9457: $directorypath =~ s/\/$//;
9458: my $listing=&reply('du2:'.&escape($directorypath).':'
9459: .&escape($getpropath).':'.&escape($uname).':'
9460: .&escape($udom),homeserver($uname,$udom));
9461: if ($listing eq 'unknown_cmd') {
9462: if ($getpropath) {
9463: $directorypath = &propath($udom,$uname).'/'.$directorypath;
9464: }
9465: $listing = &reply('du:'.$directorypath,homeserver($uname,$udom));
9466: }
9467: return $listing;
9468: }
9469:
9470: sub is_locked {
9471: my ($file_name, $domain, $user, $which) = @_;
9472: my @check;
9473: my $is_locked;
9474: push (@check,$file_name);
9475: my %locked = &get('file_permissions',\@check,
9476: $env{'user.domain'},$env{'user.name'});
9477: my ($tmp)=keys(%locked);
9478: if ($tmp=~/^error:/) { undef(%locked); }
9479:
9480: if (ref($locked{$file_name}) eq 'ARRAY') {
9481: $is_locked = 'false';
9482: foreach my $entry (@{$locked{$file_name}}) {
9483: if (ref($entry) eq 'ARRAY') {
9484: $is_locked = 'true';
9485: if (ref($which) eq 'ARRAY') {
9486: push(@{$which},$entry);
9487: } else {
9488: last;
9489: }
9490: }
9491: }
9492: } else {
9493: $is_locked = 'false';
9494: }
9495: return $is_locked;
9496: }
9497:
9498: sub declutter_portfile {
9499: my ($file) = @_;
9500: $file =~ s{^(/portfolio/|portfolio/)}{/};
9501: return $file;
9502: }
9503:
9504: # ------------------------------------------------------------- Mark as Read Only
9505:
9506: sub mark_as_readonly {
9507: my ($domain,$user,$files,$what) = @_;
9508: my %current_permissions = &dump('file_permissions',$domain,$user);
9509: my ($tmp)=keys(%current_permissions);
9510: if ($tmp=~/^error:/) { undef(%current_permissions); }
9511: foreach my $file (@{$files}) {
9512: $file = &declutter_portfile($file);
9513: push(@{$current_permissions{$file}},$what);
9514: }
9515: &put('file_permissions',\%current_permissions,$domain,$user);
9516: return;
9517: }
9518:
9519: # ------------------------------------------------------------Save Selected Files
9520:
9521: sub save_selected_files {
9522: my ($user, $path, @files) = @_;
9523: my $filename = $user."savedfiles";
9524: my @other_files = &files_not_in_path($user, $path);
9525: open (OUT, '>'.$tmpdir.$filename);
9526: foreach my $file (@files) {
9527: print (OUT $env{'form.currentpath'}.$file."\n");
9528: }
9529: foreach my $file (@other_files) {
9530: print (OUT $file."\n");
9531: }
9532: close (OUT);
9533: return 'ok';
9534: }
9535:
9536: sub clear_selected_files {
9537: my ($user) = @_;
9538: my $filename = $user."savedfiles";
9539: open (OUT, '>'.LONCAPA::tempdir().$filename);
9540: print (OUT undef);
9541: close (OUT);
9542: return ("ok");
9543: }
9544:
9545: sub files_in_path {
9546: my ($user, $path) = @_;
9547: my $filename = $user."savedfiles";
9548: my %return_files;
9549: open (IN, '<'.LONCAPA::tempdir().$filename);
9550: while (my $line_in = <IN>) {
9551: chomp ($line_in);
9552: my @paths_and_file = split (m!/!, $line_in);
9553: my $file_part = pop (@paths_and_file);
9554: my $path_part = join ('/', @paths_and_file);
9555: $path_part.='/';
9556: my $path_and_file = $path_part.$file_part;
9557: if ($path_part eq $path) {
9558: $return_files{$file_part}= 'selected';
9559: }
9560: }
9561: close (IN);
9562: return (\%return_files);
9563: }
9564:
9565: # called in portfolio select mode, to show files selected NOT in current directory
9566: sub files_not_in_path {
9567: my ($user, $path) = @_;
9568: my $filename = $user."savedfiles";
9569: my @return_files;
9570: my $path_part;
9571: open(IN, '<'.LONCAPA::.$filename);
9572: while (my $line = <IN>) {
9573: #ok, I know it's clunky, but I want it to work
9574: my @paths_and_file = split(m|/|, $line);
9575: my $file_part = pop(@paths_and_file);
9576: chomp($file_part);
9577: my $path_part = join('/', @paths_and_file);
9578: $path_part .= '/';
9579: my $path_and_file = $path_part.$file_part;
9580: if ($path_part ne $path) {
9581: push(@return_files, ($path_and_file));
9582: }
9583: }
9584: close(OUT);
9585: return (@return_files);
9586: }
9587:
9588: #------------------------------Submitted/Handedback Portfolio Files Versioning
9589:
9590: sub portfiles_versioning {
9591: my ($symb,$domain,$stu_name,$portfiles,$versioned_portfiles) = @_;
9592: my $portfolio_root = '/userfiles/portfolio';
9593: return unless ((ref($portfiles) eq 'ARRAY') && (ref($versioned_portfiles) eq 'ARRAY'));
9594: foreach my $file (@{$portfiles}) {
9595: &unmark_as_readonly($domain,$stu_name,[$symb,$env{'request.course.id'}],$file);
9596: my ($directory,$answer_file) =($file =~ /^(.*?)([^\/]*)$/);
9597: my ($answer_name,$answer_ver,$answer_ext) = &file_name_version_ext($answer_file);
9598: my $getpropath = 1;
9599: my ($dir_list,$listerror) = &dirlist($portfolio_root.$directory,$domain,
9600: $stu_name,$getpropath);
9601: my $version = &get_next_version($answer_name,$answer_ext,$dir_list);
9602: my $new_answer =
9603: &version_selected_portfile($domain,$stu_name,$directory,$answer_file,$version);
9604: if ($new_answer ne 'problem getting file') {
9605: push(@{$versioned_portfiles}, $directory.$new_answer);
9606: &mark_as_readonly($domain,$stu_name,[$directory.$new_answer],
9607: [$symb,$env{'request.course.id'},'graded']);
9608: }
9609: }
9610: }
9611:
9612: sub get_next_version {
9613: my ($answer_name, $answer_ext, $dir_list) = @_;
9614: my $version;
9615: if (ref($dir_list) eq 'ARRAY') {
9616: foreach my $row (@{$dir_list}) {
9617: my ($file) = split(/\&/,$row,2);
9618: my ($file_name,$file_version,$file_ext) =
9619: &file_name_version_ext($file);
9620: if (($file_name eq $answer_name) &&
9621: ($file_ext eq $answer_ext)) {
9622: # gets here if filename and extension match,
9623: # regardless of version
9624: if ($file_version ne '') {
9625: # a versioned file is found so save it for later
9626: if ($file_version > $version) {
9627: $version = $file_version;
9628: }
9629: }
9630: }
9631: }
9632: }
9633: $version ++;
9634: return($version);
9635: }
9636:
9637: sub version_selected_portfile {
9638: my ($domain,$stu_name,$directory,$file_name,$version) = @_;
9639: my ($answer_name,$answer_ver,$answer_ext) =
9640: &file_name_version_ext($file_name);
9641: my $new_answer;
9642: $env{'form.copy'} =
9643: &getfile("/uploaded/$domain/$stu_name/portfolio$directory$file_name");
9644: if($env{'form.copy'} eq '-1') {
9645: $new_answer = 'problem getting file';
9646: } else {
9647: $new_answer = $answer_name.'.'.$version.'.'.$answer_ext;
9648: my $copy_result =
9649: &finishuserfileupload($stu_name,$domain,'copy',
9650: '/portfolio'.$directory.$new_answer);
9651: }
9652: undef($env{'form.copy'});
9653: return ($new_answer);
9654: }
9655:
9656: sub file_name_version_ext {
9657: my ($file)=@_;
9658: my @file_parts = split(/\./, $file);
9659: my ($name,$version,$ext);
9660: if (@file_parts > 1) {
9661: $ext=pop(@file_parts);
9662: if (@file_parts > 1 && $file_parts[-1] =~ /^\d+$/) {
9663: $version=pop(@file_parts);
9664: }
9665: $name=join('.',@file_parts);
9666: } else {
9667: $name=join('.',@file_parts);
9668: }
9669: return($name,$version,$ext);
9670: }
9671:
9672: #----------------------------------------------Get portfolio file permissions
9673:
9674: sub get_portfile_permissions {
9675: my ($domain,$user) = @_;
9676: my %current_permissions = &dump('file_permissions',$domain,$user);
9677: my ($tmp)=keys(%current_permissions);
9678: if ($tmp=~/^error:/) { undef(%current_permissions); }
9679: return \%current_permissions;
9680: }
9681:
9682: #---------------------------------------------Get portfolio file access controls
9683:
9684: sub get_access_controls {
9685: my ($current_permissions,$group,$file) = @_;
9686: my %access;
9687: my $real_file = $file;
9688: $file =~ s/\.meta$//;
9689: if (defined($file)) {
9690: if (ref($$current_permissions{$file."\0".'accesscontrol'}) eq 'HASH') {
9691: foreach my $control (keys(%{$$current_permissions{$file."\0".'accesscontrol'}})) {
9692: $access{$real_file}{$control} = $$current_permissions{$file."\0".$control};
9693: }
9694: }
9695: } else {
9696: foreach my $key (keys(%{$current_permissions})) {
9697: if ($key =~ /\0accesscontrol$/) {
9698: if (defined($group)) {
9699: if ($key !~ m-^\Q$group\E/-) {
9700: next;
9701: }
9702: }
9703: my ($fullpath) = split(/\0/,$key);
9704: if (ref($$current_permissions{$key}) eq 'HASH') {
9705: foreach my $control (keys(%{$$current_permissions{$key}})) {
9706: $access{$fullpath}{$control}=$$current_permissions{$fullpath."\0".$control};
9707: }
9708: }
9709: }
9710: }
9711: }
9712: return %access;
9713: }
9714:
9715: sub modify_access_controls {
9716: my ($file_name,$changes,$domain,$user)=@_;
9717: my ($outcome,$deloutcome);
9718: my %store_permissions;
9719: my %new_values;
9720: my %new_control;
9721: my %translation;
9722: my @deletions = ();
9723: my $now = time;
9724: if (exists($$changes{'activate'})) {
9725: if (ref($$changes{'activate'}) eq 'HASH') {
9726: my @newitems = sort(keys(%{$$changes{'activate'}}));
9727: my $numnew = scalar(@newitems);
9728: for (my $i=0; $i<$numnew; $i++) {
9729: my $newkey = $newitems[$i];
9730: my $newid = &Apache::loncommon::get_cgi_id();
9731: if ($newkey =~ /^\d+:/) {
9732: $newkey =~ s/^(\d+)/$newid/;
9733: $translation{$1} = $newid;
9734: } elsif ($newkey =~ /^\d+_\d+_\d+:/) {
9735: $newkey =~ s/^(\d+_\d+_\d+)/$newid/;
9736: $translation{$1} = $newid;
9737: }
9738: $new_values{$file_name."\0".$newkey} =
9739: $$changes{'activate'}{$newitems[$i]};
9740: $new_control{$newkey} = $now;
9741: }
9742: }
9743: }
9744: my %todelete;
9745: my %changed_items;
9746: foreach my $action ('delete','update') {
9747: if (exists($$changes{$action})) {
9748: if (ref($$changes{$action}) eq 'HASH') {
9749: foreach my $key (keys(%{$$changes{$action}})) {
9750: my ($itemnum) = ($key =~ /^([^:]+):/);
9751: if ($action eq 'delete') {
9752: $todelete{$itemnum} = 1;
9753: } else {
9754: $changed_items{$itemnum} = $key;
9755: }
9756: }
9757: }
9758: }
9759: }
9760: # get lock on access controls for file.
9761: my $lockhash = {
9762: $file_name."\0".'locked_access_records' => $env{'user.name'}.
9763: ':'.$env{'user.domain'},
9764: };
9765: my $tries = 0;
9766: my $gotlock = &newput('file_permissions',$lockhash,$domain,$user);
9767:
9768: while (($gotlock ne 'ok') && $tries < 10) {
9769: $tries ++;
9770: sleep(0.1);
9771: $gotlock = &newput('file_permissions',$lockhash,$domain,$user);
9772: }
9773: if ($gotlock eq 'ok') {
9774: my %curr_permissions = &dump('file_permissions',$domain,$user,$file_name);
9775: my ($tmp)=keys(%curr_permissions);
9776: if ($tmp=~/^error:/) { undef(%curr_permissions); }
9777: if (exists($curr_permissions{$file_name."\0".'accesscontrol'})) {
9778: my $curr_controls = $curr_permissions{$file_name."\0".'accesscontrol'};
9779: if (ref($curr_controls) eq 'HASH') {
9780: foreach my $control_item (keys(%{$curr_controls})) {
9781: my ($itemnum) = ($control_item =~ /^([^:]+):/);
9782: if (defined($todelete{$itemnum})) {
9783: push(@deletions,$file_name."\0".$control_item);
9784: } else {
9785: if (defined($changed_items{$itemnum})) {
9786: $new_control{$changed_items{$itemnum}} = $now;
9787: push(@deletions,$file_name."\0".$control_item);
9788: $new_values{$file_name."\0".$changed_items{$itemnum}} = $$changes{'update'}{$changed_items{$itemnum}};
9789: } else {
9790: $new_control{$control_item} = $$curr_controls{$control_item};
9791: }
9792: }
9793: }
9794: }
9795: }
9796: my ($group);
9797: if (&is_course($domain,$user)) {
9798: ($group,my $file) = split(/\//,$file_name,2);
9799: }
9800: $deloutcome = &del('file_permissions',\@deletions,$domain,$user);
9801: $new_values{$file_name."\0".'accesscontrol'} = \%new_control;
9802: $outcome = &put('file_permissions',\%new_values,$domain,$user);
9803: # remove lock
9804: my @del_lock = ($file_name."\0".'locked_access_records');
9805: my $dellockoutcome = &del('file_permissions',\@del_lock,$domain,$user);
9806: my $sqlresult =
9807: &update_portfolio_table($user,$domain,$file_name,'portfolio_access',
9808: $group);
9809: } else {
9810: $outcome = "error: could not obtain lockfile\n";
9811: }
9812: return ($outcome,$deloutcome,\%new_values,\%translation);
9813: }
9814:
9815: sub make_public_indefinitely {
9816: my (@requrl) = @_;
9817: return &automated_portfile_access('public',\@requrl);
9818: }
9819:
9820: sub automated_portfile_access {
9821: my ($accesstype,$addsref,$delsref,$info) = @_;
9822: unless (($accesstype eq 'public') || ($accesstype eq 'ip')) {
9823: return 'invalid';
9824: }
9825: my %urls;
9826: if (ref($addsref) eq 'ARRAY') {
9827: foreach my $requrl (@{$addsref}) {
9828: if (&is_portfolio_url($requrl)) {
9829: unless (exists($urls{$requrl})) {
9830: $urls{$requrl} = 'add';
9831: }
9832: }
9833: }
9834: }
9835: if (ref($delsref) eq 'ARRAY') {
9836: foreach my $requrl (@{$delsref}) {
9837: if (&is_portfolio_url($requrl)) {
9838: unless (exists($urls{$requrl})) {
9839: $urls{$requrl} = 'delete';
9840: }
9841: }
9842: }
9843: }
9844: unless (keys(%urls)) {
9845: return 'invalid';
9846: }
9847: my $ip;
9848: if ($accesstype eq 'ip') {
9849: if (ref($info) eq 'HASH') {
9850: if ($info->{'ip'} ne '') {
9851: $ip = $info->{'ip'};
9852: }
9853: }
9854: if ($ip eq '') {
9855: return 'invalid';
9856: }
9857: }
9858: my $errors;
9859: my $now = time;
9860: my %current_perms;
9861: foreach my $requrl (sort(keys(%urls))) {
9862: my $action;
9863: if ($urls{$requrl} eq 'add') {
9864: $action = 'activate';
9865: } else {
9866: $action = 'none';
9867: }
9868: my $aclnum = 0;
9869: my (undef,$udom,$unum,$file_name,$group) =
9870: &parse_portfolio_url($requrl);
9871: unless (exists($current_perms{$unum.':'.$udom})) {
9872: $current_perms{$unum.':'.$udom} = &get_portfile_permissions($udom,$unum);
9873: }
9874: my %access_controls = &get_access_controls($current_perms{$unum.':'.$udom},
9875: $group,$file_name);
9876: foreach my $key (keys(%{$access_controls{$file_name}})) {
9877: my ($num,$scope,$end,$start) =
9878: ($key =~ /^([^:]+):([a-z]+)_(\d*)_?(\d*)$/);
9879: if ($scope eq $accesstype) {
9880: if (($start <= $now) && ($end == 0)) {
9881: if ($accesstype eq 'ip') {
9882: if (ref($access_controls{$file_name}{$key}) eq 'HASH') {
9883: if (ref($access_controls{$file_name}{$key}{'ip'}) eq 'ARRAY') {
9884: if (grep(/^\Q$ip\E$/,@{$access_controls{$file_name}{$key}{'ip'}})) {
9885: if ($urls{$requrl} eq 'add') {
9886: $action = 'none';
9887: last;
9888: } else {
9889: $action = 'delete';
9890: $aclnum = $num;
9891: last;
9892: }
9893: }
9894: }
9895: }
9896: } elsif ($accesstype eq 'public') {
9897: if ($urls{$requrl} eq 'add') {
9898: $action = 'none';
9899: last;
9900: } else {
9901: $action = 'delete';
9902: $aclnum = $num;
9903: last;
9904: }
9905: }
9906: } elsif ($accesstype eq 'public') {
9907: $action = 'update';
9908: $aclnum = $num;
9909: last;
9910: }
9911: }
9912: }
9913: if ($action eq 'none') {
9914: next;
9915: } else {
9916: my %changes;
9917: my $newend = 0;
9918: my $newstart = $now;
9919: my $newkey = $aclnum.':'.$accesstype.'_'.$newend.'_'.$newstart;
9920: $changes{$action}{$newkey} = {
9921: type => $accesstype,
9922: time => {
9923: start => $newstart,
9924: end => $newend,
9925: },
9926: };
9927: if ($accesstype eq 'ip') {
9928: $changes{$action}{$newkey}{'ip'} = [$ip];
9929: }
9930: my ($outcome,$deloutcome,$new_values,$translation) =
9931: &modify_access_controls($file_name,\%changes,$udom,$unum);
9932: unless ($outcome eq 'ok') {
9933: $errors .= $outcome.' ';
9934: }
9935: }
9936: }
9937: if ($errors) {
9938: $errors =~ s/\s$//;
9939: return $errors;
9940: } else {
9941: return 'ok';
9942: }
9943: }
9944:
9945: #------------------------------------------------------Get Marked as Read Only
9946:
9947: sub get_marked_as_readonly {
9948: my ($domain,$user,$what,$group) = @_;
9949: my $current_permissions = &get_portfile_permissions($domain,$user);
9950: my @readonly_files;
9951: my $cmp1=$what;
9952: if (ref($what)) { $cmp1=join('',@{$what}) };
9953: while (my ($file_name,$value) = each(%{$current_permissions})) {
9954: if (defined($group)) {
9955: if ($file_name !~ m-^\Q$group\E/-) {
9956: next;
9957: }
9958: }
9959: if (ref($value) eq "ARRAY"){
9960: foreach my $stored_what (@{$value}) {
9961: my $cmp2=$stored_what;
9962: if (ref($stored_what) eq 'ARRAY') {
9963: $cmp2=join('',@{$stored_what});
9964: }
9965: if ($cmp1 eq $cmp2) {
9966: push(@readonly_files, $file_name);
9967: last;
9968: } elsif (!defined($what)) {
9969: push(@readonly_files, $file_name);
9970: last;
9971: }
9972: }
9973: }
9974: }
9975: return @readonly_files;
9976: }
9977: #-----------------------------------------------------------Get Marked as Read Only Hash
9978:
9979: sub get_marked_as_readonly_hash {
9980: my ($current_permissions,$group,$what) = @_;
9981: my %readonly_files;
9982: while (my ($file_name,$value) = each(%{$current_permissions})) {
9983: if (defined($group)) {
9984: if ($file_name !~ m-^\Q$group\E/-) {
9985: next;
9986: }
9987: }
9988: if (ref($value) eq "ARRAY"){
9989: foreach my $stored_what (@{$value}) {
9990: if (ref($stored_what) eq 'ARRAY') {
9991: foreach my $lock_descriptor(@{$stored_what}) {
9992: if ($lock_descriptor eq 'graded') {
9993: $readonly_files{$file_name} = 'graded';
9994: } elsif ($lock_descriptor eq 'handback') {
9995: $readonly_files{$file_name} = 'handback';
9996: } else {
9997: if (!exists($readonly_files{$file_name})) {
9998: $readonly_files{$file_name} = 'locked';
9999: }
10000: }
10001: }
10002: }
10003: }
10004: }
10005: }
10006: return %readonly_files;
10007: }
10008: # ------------------------------------------------------------ Unmark as Read Only
10009:
10010: sub unmark_as_readonly {
10011: # unmarks $file_name (if $file_name is defined), or all files locked by $what
10012: # for portfolio submissions, $what contains [$symb,$crsid]
10013: my ($domain,$user,$what,$file_name,$group) = @_;
10014: $file_name = &declutter_portfile($file_name);
10015: my $symb_crs = $what;
10016: if (ref($what)) { $symb_crs=join('',@$what); }
10017: my %current_permissions = &dump('file_permissions',$domain,$user,$group);
10018: my ($tmp)=keys(%current_permissions);
10019: if ($tmp=~/^error:/) { undef(%current_permissions); }
10020: my @readonly_files = &get_marked_as_readonly($domain,$user,$what,$group);
10021: foreach my $file (@readonly_files) {
10022: my $clean_file = &declutter_portfile($file);
10023: if (defined($file_name) && ($file_name ne $clean_file)) { next; }
10024: my $current_locks = $current_permissions{$file};
10025: my @new_locks;
10026: my @del_keys;
10027: if (ref($current_locks) eq "ARRAY"){
10028: foreach my $locker (@{$current_locks}) {
10029: my $compare=$locker;
10030: if (ref($locker) eq 'ARRAY') {
10031: $compare=join('',@{$locker});
10032: if ($compare ne $symb_crs) {
10033: push(@new_locks, $locker);
10034: }
10035: }
10036: }
10037: if (scalar(@new_locks) > 0) {
10038: $current_permissions{$file} = \@new_locks;
10039: } else {
10040: push(@del_keys, $file);
10041: &del('file_permissions',\@del_keys, $domain, $user);
10042: delete($current_permissions{$file});
10043: }
10044: }
10045: }
10046: &put('file_permissions',\%current_permissions,$domain,$user);
10047: return;
10048: }
10049:
10050: # ------------------------------------------------------------ Directory lister
10051:
10052: sub dirlist {
10053: my ($uri,$userdomain,$username,$getpropath,$getuserdir,$alternateRoot)=@_;
10054: $uri=~s/^\///;
10055: $uri=~s/\/$//;
10056: my ($udom, $uname);
10057: if ($getuserdir) {
10058: $udom = $userdomain;
10059: $uname = $username;
10060: } else {
10061: (undef,$udom,$uname)=split(/\//,$uri);
10062: if(defined($userdomain)) {
10063: $udom = $userdomain;
10064: }
10065: if(defined($username)) {
10066: $uname = $username;
10067: }
10068: }
10069: my ($dirRoot,$listing,@listing_results);
10070:
10071: $dirRoot = $perlvar{'lonDocRoot'};
10072: if (defined($getpropath)) {
10073: $dirRoot = &propath($udom,$uname);
10074: $dirRoot =~ s/\/$//;
10075: } elsif (defined($getuserdir)) {
10076: my $subdir=$uname.'__';
10077: $subdir =~ s/(.)(.)(.).*/$1\/$2\/$3/;
10078: $dirRoot = $Apache::lonnet::perlvar{'lonUsersDir'}
10079: ."/$udom/$subdir/$uname";
10080: } elsif (defined($alternateRoot)) {
10081: $dirRoot = $alternateRoot;
10082: }
10083:
10084: if($udom) {
10085: if($uname) {
10086: my $uhome = &homeserver($uname,$udom);
10087: if ($uhome eq 'no_host') {
10088: return ([],'no_host');
10089: }
10090: $listing = &reply('ls3:'.&escape('/'.$uri).':'.$getpropath.':'
10091: .$getuserdir.':'.&escape($dirRoot)
10092: .':'.&escape($uname).':'.&escape($udom),$uhome);
10093: if ($listing eq 'unknown_cmd') {
10094: $listing = &reply('ls2:'.$dirRoot.'/'.$uri,$uhome);
10095: } else {
10096: @listing_results = map { &unescape($_); } split(/:/,$listing);
10097: }
10098: if ($listing eq 'unknown_cmd') {
10099: $listing = &reply('ls:'.$dirRoot.'/'.$uri,$uhome);
10100: @listing_results = split(/:/,$listing);
10101: } else {
10102: @listing_results = map { &unescape($_); } split(/:/,$listing);
10103: }
10104: if (($listing eq 'no_such_host') || ($listing eq 'con_lost') ||
10105: ($listing eq 'rejected') || ($listing eq 'refused') ||
10106: ($listing eq 'no_such_dir') || ($listing eq 'empty')) {
10107: return ([],$listing);
10108: } else {
10109: return (\@listing_results);
10110: }
10111: } elsif(!$alternateRoot) {
10112: my (%allusers,%listerror);
10113: my %servers = &get_servers($udom,'library');
10114: foreach my $tryserver (keys(%servers)) {
10115: $listing = &reply('ls3:'.&escape("/res/$udom").':::::'.
10116: &escape($udom),$tryserver);
10117: if ($listing eq 'unknown_cmd') {
10118: $listing = &reply('ls2:'.$perlvar{'lonDocRoot'}.'/res/'.
10119: $udom, $tryserver);
10120: } else {
10121: @listing_results = map { &unescape($_); } split(/:/,$listing);
10122: }
10123: if ($listing eq 'unknown_cmd') {
10124: $listing = &reply('ls:'.$perlvar{'lonDocRoot'}.'/res/'.
10125: $udom, $tryserver);
10126: @listing_results = split(/:/,$listing);
10127: } else {
10128: @listing_results =
10129: map { &unescape($_); } split(/:/,$listing);
10130: }
10131: if (($listing eq 'no_such_host') || ($listing eq 'con_lost') ||
10132: ($listing eq 'rejected') || ($listing eq 'refused') ||
10133: ($listing eq 'no_such_dir') || ($listing eq 'empty')) {
10134: $listerror{$tryserver} = $listing;
10135: } else {
10136: foreach my $line (@listing_results) {
10137: my ($entry) = split(/&/,$line,2);
10138: $allusers{$entry} = 1;
10139: }
10140: }
10141: }
10142: my @alluserslist=();
10143: foreach my $user (sort(keys(%allusers))) {
10144: push(@alluserslist,$user.'&user');
10145: }
10146: return (\@alluserslist);
10147: } else {
10148: return ([],'missing username');
10149: }
10150: } elsif(!defined($getpropath)) {
10151: my $path = $perlvar{'lonDocRoot'}.'/res/';
10152: my @all_domains = map { $path.$_.'/&domain'; } (sort(&all_domains()));
10153: return (\@all_domains);
10154: } else {
10155: return ([],'missing domain');
10156: }
10157: }
10158:
10159: # --------------------------------------------- GetFileTimestamp
10160: # This function utilizes dirlist and returns the date stamp for
10161: # when it was last modified. It will also return an error of -1
10162: # if an error occurs
10163:
10164: sub GetFileTimestamp {
10165: my ($studentDomain,$studentName,$filename,$getuserdir)=@_;
10166: $studentDomain = &LONCAPA::clean_domain($studentDomain);
10167: $studentName = &LONCAPA::clean_username($studentName);
10168: my ($fileref,$error) = &dirlist($filename,$studentDomain,$studentName,
10169: undef,$getuserdir);
10170: if (($error eq 'empty') || ($error eq 'no_such_dir')) {
10171: return -1;
10172: }
10173: if (ref($fileref) eq 'ARRAY') {
10174: my @stats = split('&',$fileref->[0]);
10175: # @stats contains first the filename, then the stat output
10176: return $stats[10]; # so this is 10 instead of 9.
10177: } else {
10178: return -1;
10179: }
10180: }
10181:
10182: sub stat_file {
10183: my ($uri) = @_;
10184: $uri = &clutter_with_no_wrapper($uri);
10185:
10186: my ($udom,$uname,$file);
10187: if ($uri =~ m-^/(uploaded|editupload)/-) {
10188: ($udom,$uname,$file) =
10189: ($uri =~ m-/(?:uploaded|editupload)/?($match_domain)/?($match_name)/?(.*)-);
10190: $file = 'userfiles/'.$file;
10191: }
10192: if ($uri =~ m-^/res/-) {
10193: ($udom,$uname) =
10194: ($uri =~ m-/(?:res)/?($match_domain)/?($match_username)/-);
10195: $file = $uri;
10196: }
10197:
10198: if (!$udom || !$uname || !$file) {
10199: # unable to handle the uri
10200: return ();
10201: }
10202: my $getpropath;
10203: if ($file =~ /^userfiles\//) {
10204: $getpropath = 1;
10205: }
10206: my ($listref,$error) = &dirlist($file,$udom,$uname,$getpropath);
10207: if (($error eq 'empty') || ($error eq 'no_such_dir')) {
10208: return ();
10209: } else {
10210: if (ref($listref) eq 'ARRAY') {
10211: my @stats = split('&',$listref->[0]);
10212: shift(@stats); #filename is first
10213: return @stats;
10214: }
10215: }
10216: return ();
10217: }
10218:
10219: # -------------------------------------------------------- Value of a Condition
10220:
10221: # gets the value of a specific preevaluated condition
10222: # stored in the string $env{user.state.<cid>}
10223: # or looks up a condition reference in the bighash and if if hasn't
10224: # already been evaluated recurses into docondval to get the value of
10225: # the condition, then memoizing it to
10226: # $env{user.state.<cid>.<condition>}
10227: sub directcondval {
10228: my $number=shift;
10229: if (!defined($env{'user.state.'.$env{'request.course.id'}})) {
10230: &Apache::lonuserstate::evalstate();
10231: }
10232: if (exists($env{'user.state.'.$env{'request.course.id'}.".$number"})) {
10233: return $env{'user.state.'.$env{'request.course.id'}.".$number"};
10234: } elsif ($number =~ /^_/) {
10235: my $sub_condition;
10236: if (tie(my %bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
10237: &GDBM_READER(),0640)) {
10238: $sub_condition=$bighash{'conditions'.$number};
10239: untie(%bighash);
10240: }
10241: my $value = &docondval($sub_condition);
10242: &appenv({'user.state.'.$env{'request.course.id'}.".$number" => $value});
10243: return $value;
10244: }
10245: if ($env{'user.state.'.$env{'request.course.id'}}) {
10246: return substr($env{'user.state.'.$env{'request.course.id'}},$number,1);
10247: } else {
10248: return 2;
10249: }
10250: }
10251:
10252: # get the collection of conditions for this resource
10253: sub condval {
10254: my $condidx=shift;
10255: my $allpathcond='';
10256: foreach my $cond (split(/\|/,$condidx)) {
10257: if (defined($env{'acc.cond.'.$env{'request.course.id'}.'.'.$cond})) {
10258: $allpathcond.=
10259: '('.$env{'acc.cond.'.$env{'request.course.id'}.'.'.$cond}.')|';
10260: }
10261: }
10262: $allpathcond=~s/\|$//;
10263: return &docondval($allpathcond);
10264: }
10265:
10266: #evaluates an expression of conditions
10267: sub docondval {
10268: my ($allpathcond) = @_;
10269: my $result=0;
10270: if ($env{'request.course.id'}
10271: && defined($allpathcond)) {
10272: my $operand='|';
10273: my @stack;
10274: foreach my $chunk ($allpathcond=~/(\d+|_\d+\.\d+|\(|\)|\&|\|)/g) {
10275: if ($chunk eq '(') {
10276: push @stack,($operand,$result);
10277: } elsif ($chunk eq ')') {
10278: my $before=pop @stack;
10279: if (pop @stack eq '&') {
10280: $result=$result>$before?$before:$result;
10281: } else {
10282: $result=$result>$before?$result:$before;
10283: }
10284: } elsif (($chunk eq '&') || ($chunk eq '|')) {
10285: $operand=$chunk;
10286: } else {
10287: my $new=directcondval($chunk);
10288: if ($operand eq '&') {
10289: $result=$result>$new?$new:$result;
10290: } else {
10291: $result=$result>$new?$result:$new;
10292: }
10293: }
10294: }
10295: }
10296: return $result;
10297: }
10298:
10299: # ---------------------------------------------------- Devalidate courseresdata
10300:
10301: sub devalidatecourseresdata {
10302: my ($coursenum,$coursedomain)=@_;
10303: my $hashid=$coursenum.':'.$coursedomain;
10304: &devalidate_cache_new('courseres',$hashid);
10305: }
10306:
10307:
10308: # --------------------------------------------------- Course Resourcedata Query
10309: #
10310: # Parameters:
10311: # $coursenum - Number of the course.
10312: # $coursedomain - Domain at which the course was created.
10313: # Returns:
10314: # A hash of the course parameters along (I think) with timestamps
10315: # and version info.
10316:
10317: sub get_courseresdata {
10318: my ($coursenum,$coursedomain)=@_;
10319: my $coursehom=&homeserver($coursenum,$coursedomain);
10320: my $hashid=$coursenum.':'.$coursedomain;
10321: my ($result,$cached)=&is_cached_new('courseres',$hashid);
10322: my %dumpreply;
10323: unless (defined($cached)) {
10324: %dumpreply=&dump('resourcedata',$coursedomain,$coursenum);
10325: $result=\%dumpreply;
10326: my ($tmp) = keys(%dumpreply);
10327: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
10328: &do_cache_new('courseres',$hashid,$result,600);
10329: } elsif ($tmp =~ /^(con_lost|no_such_host)/) {
10330: return $tmp;
10331: } elsif ($tmp =~ /^(error)/) {
10332: $result=undef;
10333: &do_cache_new('courseres',$hashid,$result,600);
10334: }
10335: }
10336: return $result;
10337: }
10338:
10339: sub devalidateuserresdata {
10340: my ($uname,$udom)=@_;
10341: my $hashid="$udom:$uname";
10342: &devalidate_cache_new('userres',$hashid);
10343: }
10344:
10345: sub get_userresdata {
10346: my ($uname,$udom)=@_;
10347: #most student don\'t have any data set, check if there is some data
10348: if (&EXT_cache_status($udom,$uname)) { return undef; }
10349:
10350: my $hashid="$udom:$uname";
10351: my ($result,$cached)=&is_cached_new('userres',$hashid);
10352: if (!defined($cached)) {
10353: my %resourcedata=&dump('resourcedata',$udom,$uname);
10354: $result=\%resourcedata;
10355: &do_cache_new('userres',$hashid,$result,600);
10356: }
10357: my ($tmp)=keys(%$result);
10358: if (($tmp!~/^error\:/) && ($tmp!~/^con_lost/)) {
10359: return $result;
10360: }
10361: #error 2 occurs when the .db doesn't exist
10362: if ($tmp!~/error: 2 /) {
10363: if ((!defined($cached)) || ($tmp ne 'con_lost')) {
10364: &logthis("<font color=\"blue\">WARNING:".
10365: " Trying to get resource data for ".
10366: $uname." at ".$udom.": ".
10367: $tmp."</font>");
10368: }
10369: } elsif ($tmp=~/error: 2 /) {
10370: #&EXT_cache_set($udom,$uname);
10371: &do_cache_new('userres',$hashid,undef,600);
10372: undef($tmp); # not really an error so don't send it back
10373: }
10374: return $tmp;
10375: }
10376: #----------------------------------------------- resdata - return resource data
10377: # Purpose:
10378: # Return resource data for either users or for a course.
10379: # Parameters:
10380: # $name - Course/user name.
10381: # $domain - Name of the domain the user/course is registered on.
10382: # $type - Type of thing $name is (must be 'course' or 'user')
10383: # $mapp - decluttered URL of enclosing map
10384: # $recursed - Ref to scalar -- set to 1, if nested maps have been recursed.
10385: # $recurseup - Ref to array of map URLs, starting with map containing
10386: # $mapp up through hierarchy of nested maps to top level map.
10387: # $courseid - CourseID (first part of param identifier).
10388: # $modifier - Middle part of param identifier.
10389: # $what - Last part of param identifier.
10390: # @which - Array of names of resources desired.
10391: # Returns:
10392: # The value of the first reasource in @which that is found in the
10393: # resource hash.
10394: # Exceptional Conditions:
10395: # If the $type passed in is not valid (not the string 'course' or
10396: # 'user', an undefined reference is returned.
10397: # If none of the resources are found, an undef is returned
10398: sub resdata {
10399: my ($name,$domain,$type,$mapp,$recursed,$recurseup,$courseid,
10400: $modifier,$what,@which)=@_;
10401: my $result;
10402: if ($type eq 'course') {
10403: $result=&get_courseresdata($name,$domain);
10404: } elsif ($type eq 'user') {
10405: $result=&get_userresdata($name,$domain);
10406: }
10407: if (!ref($result)) { return $result; }
10408: foreach my $item (@which) {
10409: if ($item->[1] eq 'course') {
10410: if ((ref($recurseup) eq 'ARRAY') && (ref($recursed) eq 'SCALAR')) {
10411: unless ($$recursed) {
10412: @{$recurseup} = &get_map_hierarchy($mapp,$courseid);
10413: $$recursed = 1;
10414: }
10415: foreach my $item (@${recurseup}) {
10416: my $norecursechk=$courseid.$modifier.$item.'___(all).'.$what;
10417: last if (defined($result->{$norecursechk}));
10418: my $recursechk=$courseid.$modifier.$item.'___(rec).'.$what;
10419: if (defined($result->{$recursechk})) { return [$result->{$recursechk},'map']; }
10420: }
10421: }
10422: }
10423: if (defined($result->{$item->[0]})) {
10424: return [$result->{$item->[0]},$item->[1]];
10425: }
10426: }
10427: return undef;
10428: }
10429:
10430: sub get_domain_ltitools {
10431: my ($cdom) = @_;
10432: my %ltitools;
10433: my ($result,$cached)=&is_cached_new('ltitools',$cdom);
10434: if (defined($cached)) {
10435: if (ref($result) eq 'HASH') {
10436: %ltitools = %{$result};
10437: }
10438: } else {
10439: my %domconfig = &get_dom('configuration',['ltitools'],$cdom);
10440: if (ref($domconfig{'ltitools'}) eq 'HASH') {
10441: %ltitools = %{$domconfig{'ltitools'}};
10442: }
10443: my $cachetime = 24*60*60;
10444: &do_cache_new('ltitools',$cdom,\%ltitools,$cachetime);
10445: }
10446: return %ltitools;
10447: }
10448:
10449: sub get_numsuppfiles {
10450: my ($cnum,$cdom,$ignorecache)=@_;
10451: my $hashid=$cnum.':'.$cdom;
10452: my ($suppcount,$cached);
10453: unless ($ignorecache) {
10454: ($suppcount,$cached) = &is_cached_new('suppcount',$hashid);
10455: }
10456: unless (defined($cached)) {
10457: my $chome=&homeserver($cnum,$cdom);
10458: unless ($chome eq 'no_host') {
10459: ($suppcount,my $errors) = (0,0);
10460: my $suppmap = 'supplemental.sequence';
10461: ($suppcount,$errors) =
10462: &Apache::loncommon::recurse_supplemental($cnum,$cdom,$suppmap,$suppcount,$errors);
10463: }
10464: &do_cache_new('suppcount',$hashid,$suppcount,600);
10465: }
10466: return $suppcount;
10467: }
10468:
10469: #
10470: # EXT resource caching routines
10471: #
10472:
10473: {
10474: # Cache (5 seconds) of map hierarchy for speedup of navmaps display
10475: #
10476: # The course for which we cache
10477: my $cachedmapkey='';
10478: # The cached recursive maps for this course
10479: my %cachedmaps=();
10480: # When this was last done
10481: my $cachedmaptime='';
10482:
10483: sub clear_EXT_cache_status {
10484: &delenv('cache.EXT.');
10485: }
10486:
10487: sub EXT_cache_status {
10488: my ($target_domain,$target_user) = @_;
10489: my $cachename = 'cache.EXT.'.$target_user.'.'.$target_domain;
10490: if (exists($env{$cachename}) && ($env{$cachename}+600) > time) {
10491: # We know already the user has no data
10492: return 1;
10493: } else {
10494: return 0;
10495: }
10496: }
10497:
10498: sub EXT_cache_set {
10499: my ($target_domain,$target_user) = @_;
10500: my $cachename = 'cache.EXT.'.$target_user.'.'.$target_domain;
10501: #&appenv({$cachename => time});
10502: }
10503:
10504: # --------------------------------------------------------- Value of a Variable
10505: sub EXT {
10506:
10507: my ($varname,$symbparm,$udom,$uname,$usection,$recurse,$cid)=@_;
10508: unless ($varname) { return ''; }
10509: #get real user name/domain, courseid and symb
10510: my $courseid;
10511: my $publicuser;
10512: if ($symbparm) {
10513: $symbparm=&get_symb_from_alias($symbparm);
10514: }
10515: if (!($uname && $udom)) {
10516: (my $cursymb,$courseid,$udom,$uname,$publicuser)= &whichuser($symbparm);
10517: if (!$symbparm) { $symbparm=$cursymb; }
10518: } else {
10519: $courseid=$env{'request.course.id'};
10520: }
10521: my ($realm,$space,$qualifier,@therest)=split(/\./,$varname);
10522: my $rest;
10523: if (defined($therest[0])) {
10524: $rest=join('.',@therest);
10525: } else {
10526: $rest='';
10527: }
10528:
10529: my $qualifierrest=$qualifier;
10530: if ($rest) { $qualifierrest.='.'.$rest; }
10531: my $spacequalifierrest=$space;
10532: if ($qualifierrest) { $spacequalifierrest.='.'.$qualifierrest; }
10533: if ($realm eq 'user') {
10534: # --------------------------------------------------------------- user.resource
10535: if ($space eq 'resource') {
10536: if ( (defined($Apache::lonhomework::parsing_a_problem)
10537: || defined($Apache::lonhomework::parsing_a_task))
10538: &&
10539: ($symbparm eq &symbread()) ) {
10540: # if we are in the middle of processing the resource the
10541: # get the value we are planning on committing
10542: if (defined($Apache::lonhomework::results{$qualifierrest})) {
10543: return $Apache::lonhomework::results{$qualifierrest};
10544: } else {
10545: return $Apache::lonhomework::history{$qualifierrest};
10546: }
10547: } else {
10548: my %restored;
10549: if ($publicuser || $env{'request.state'} eq 'construct') {
10550: %restored=&tmprestore($symbparm,$courseid,$udom,$uname);
10551: } else {
10552: %restored=&restore($symbparm,$courseid,$udom,$uname);
10553: }
10554: return $restored{$qualifierrest};
10555: }
10556: # ----------------------------------------------------------------- user.access
10557: } elsif ($space eq 'access') {
10558: # FIXME - not supporting calls for a specific user
10559: return &allowed($qualifier,$rest);
10560: # ------------------------------------------ user.preferences, user.environment
10561: } elsif (($space eq 'preferences') || ($space eq 'environment')) {
10562: if (($uname eq $env{'user.name'}) &&
10563: ($udom eq $env{'user.domain'})) {
10564: return $env{join('.',('environment',$qualifierrest))};
10565: } else {
10566: my %returnhash;
10567: if (!$publicuser) {
10568: %returnhash=&userenvironment($udom,$uname,
10569: $qualifierrest);
10570: }
10571: return $returnhash{$qualifierrest};
10572: }
10573: # ----------------------------------------------------------------- user.course
10574: } elsif ($space eq 'course') {
10575: # FIXME - not supporting calls for a specific user
10576: return $env{join('.',('request.course',$qualifier))};
10577: # ------------------------------------------------------------------- user.role
10578: } elsif ($space eq 'role') {
10579: # FIXME - not supporting calls for a specific user
10580: my ($role,$where)=split(/\./,$env{'request.role'});
10581: if ($qualifier eq 'value') {
10582: return $role;
10583: } elsif ($qualifier eq 'extent') {
10584: return $where;
10585: }
10586: # ----------------------------------------------------------------- user.domain
10587: } elsif ($space eq 'domain') {
10588: return $udom;
10589: # ------------------------------------------------------------------- user.name
10590: } elsif ($space eq 'name') {
10591: return $uname;
10592: # ---------------------------------------------------- Any other user namespace
10593: } else {
10594: my %reply;
10595: if (!$publicuser) {
10596: %reply=&get($space,[$qualifierrest],$udom,$uname);
10597: }
10598: return $reply{$qualifierrest};
10599: }
10600: } elsif ($realm eq 'query') {
10601: # ---------------------------------------------- pull stuff out of query string
10602: &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},
10603: [$spacequalifierrest]);
10604: return $env{'form.'.$spacequalifierrest};
10605: } elsif ($realm eq 'request') {
10606: # ------------------------------------------------------------- request.browser
10607: if ($space eq 'browser') {
10608: return $env{'browser.'.$qualifier};
10609: # ------------------------------------------------------------ request.filename
10610: } else {
10611: return $env{'request.'.$spacequalifierrest};
10612: }
10613: } elsif ($realm eq 'course') {
10614: # ---------------------------------------------------------- course.description
10615: return $env{'course.'.$courseid.'.'.$spacequalifierrest};
10616: } elsif ($realm eq 'resource') {
10617:
10618: if (defined($courseid) && $courseid eq $env{'request.course.id'}) {
10619: if (!$symbparm) { $symbparm=&symbread(); }
10620: }
10621:
10622: if ($qualifier eq '') {
10623: if ($space eq 'title') {
10624: if (!$symbparm) { $symbparm = $env{'request.filename'}; }
10625: return &gettitle($symbparm);
10626: }
10627:
10628: if ($space eq 'map') {
10629: my ($map) = &decode_symb($symbparm);
10630: return &symbread($map);
10631: }
10632: if ($space eq 'maptitle') {
10633: my ($map) = &decode_symb($symbparm);
10634: return &gettitle($map);
10635: }
10636: if ($space eq 'filename') {
10637: if ($symbparm) {
10638: return &clutter((&decode_symb($symbparm))[2]);
10639: }
10640: return &hreflocation('',$env{'request.filename'});
10641: }
10642:
10643: if ((defined($courseid)) && ($courseid eq $env{'request.course.id'}) && $symbparm) {
10644: if ($space eq 'visibleparts') {
10645: my $navmap = Apache::lonnavmaps::navmap->new();
10646: my $item;
10647: if (ref($navmap)) {
10648: my $res = $navmap->getBySymb($symbparm);
10649: my $parts = $res->parts();
10650: if (ref($parts) eq 'ARRAY') {
10651: $item = join(',',@{$parts});
10652: }
10653: undef($navmap);
10654: }
10655: return $item;
10656: }
10657: }
10658: }
10659:
10660: my ($section, $group, @groups, @recurseup, $recursed);
10661: my ($courselevelm,$courseleveli,$courselevel,$mapp);
10662: if (($courseid eq '') && ($cid)) {
10663: $courseid = $cid;
10664: }
10665: if (($symbparm && $courseid) &&
10666: (($courseid eq $env{'request.course.id'}) || ($courseid eq $cid))) {
10667:
10668: #print '<br>'.$space.' - '.$qualifier.' - '.$spacequalifierrest;
10669:
10670: # ----------------------------------------------------- Cascading lookup scheme
10671: my $symbp=$symbparm;
10672: $mapp=&deversion((&decode_symb($symbp))[0]);
10673: my $symbparm=$symbp.'.'.$spacequalifierrest;
10674: my $recurseparm=$mapp.'___(rec).'.$spacequalifierrest;
10675: my $mapparm=$mapp.'___(all).'.$spacequalifierrest;
10676: if (($env{'user.name'} eq $uname) &&
10677: ($env{'user.domain'} eq $udom)) {
10678: $section=$env{'request.course.sec'};
10679: @groups = split(/:/,$env{'request.course.groups'});
10680: @groups=&sort_course_groups($courseid,@groups);
10681: } else {
10682: if (! defined($usection)) {
10683: $section=&getsection($udom,$uname,$courseid);
10684: } else {
10685: $section = $usection;
10686: }
10687: @groups = &get_users_groups($udom,$uname,$courseid);
10688: }
10689:
10690: my $seclevel=$courseid.'.['.$section.'].'.$spacequalifierrest;
10691: my $seclevelr=$courseid.'.['.$section.'].'.$symbparm;
10692: my $secleveli=$courseid.'.['.$section.'].'.$recurseparm;
10693: my $seclevelm=$courseid.'.['.$section.'].'.$mapparm;
10694:
10695: $courselevel=$courseid.'.'.$spacequalifierrest;
10696: my $courselevelr=$courseid.'.'.$symbparm;
10697: $courseleveli=$courseid.'.'.$recurseparm;
10698: $courselevelm=$courseid.'.'.$mapparm;
10699:
10700: # ----------------------------------------------------------- first, check user
10701:
10702: my $userreply=&resdata($uname,$udom,'user',$mapp,\$recursed,
10703: \@recurseup,$courseid,'.',$spacequalifierrest,
10704: ([$courselevelr,'resource'],
10705: [$courselevelm,'map' ],
10706: [$courseleveli,'map' ],
10707: [$courselevel, 'course' ]));
10708: if (defined($userreply)) { return &get_reply($userreply); }
10709:
10710: # ------------------------------------------------ second, check some of course
10711: my $coursereply;
10712: if (@groups > 0) {
10713: $coursereply = &check_group_parms($courseid,\@groups,$symbparm,
10714: $recurseparm,$mapparm,$spacequalifierrest,
10715: $mapp,\$recursed,\@recurseup);
10716: if (defined($coursereply)) { return &get_reply($coursereply); }
10717: }
10718:
10719: $coursereply=&resdata($env{'course.'.$courseid.'.num'},
10720: $env{'course.'.$courseid.'.domain'},
10721: 'course',$mapp,\$recursed,\@recurseup,
10722: $courseid,'.['.$section.'].',$spacequalifierrest,
10723: ([$seclevelr, 'resource'],
10724: [$seclevelm, 'map' ],
10725: [$secleveli, 'map' ],
10726: [$seclevel, 'course' ],
10727: [$courselevelr,'resource']));
10728: if (defined($coursereply)) { return &get_reply($coursereply); }
10729:
10730: # ------------------------------------------------------ third, check map parms
10731: my %parmhash=();
10732: my $thisparm='';
10733: if (tie(%parmhash,'GDBM_File',
10734: $env{'request.course.fn'}.'_parms.db',
10735: &GDBM_READER(),0640)) {
10736: $thisparm=$parmhash{$symbparm};
10737: untie(%parmhash);
10738: }
10739: if ($thisparm) { return &get_reply([$thisparm,'resource']); }
10740: }
10741: # ------------------------------------------ fourth, look in resource metadata
10742:
10743: my $what = $spacequalifierrest;
10744: $what=~s/\./\_/;
10745: my $filename;
10746: if (!$symbparm) { $symbparm=&symbread(); }
10747: if ($symbparm) {
10748: $filename=(&decode_symb($symbparm))[2];
10749: } else {
10750: $filename=$env{'request.filename'};
10751: }
10752: my $metadata=&metadata($filename,$what);
10753: if (defined($metadata)) { return &get_reply([$metadata,'resource']); }
10754: $metadata=&metadata($filename,'parameter_'.$what);
10755: if (defined($metadata)) { return &get_reply([$metadata,'resource']); }
10756:
10757: # ----------------------------------------------- fifth, look in rest of course
10758: if ($symbparm && defined($courseid) &&
10759: $courseid eq $env{'request.course.id'}) {
10760: my $coursereply=&resdata($env{'course.'.$courseid.'.num'},
10761: $env{'course.'.$courseid.'.domain'},
10762: 'course',$mapp,\$recursed,\@recurseup,
10763: $courseid,'.',$spacequalifierrest,
10764: ([$courselevelm,'map' ],
10765: [$courseleveli,'map' ],
10766: [$courselevel, 'course']));
10767: if (defined($coursereply)) { return &get_reply($coursereply); }
10768: }
10769: # ------------------------------------------------------------------ Cascade up
10770: unless ($space eq '0') {
10771: my @parts=split(/_/,$space);
10772: my $id=pop(@parts);
10773: my $part=join('_',@parts);
10774: if ($part eq '') { $part='0'; }
10775: my @partgeneral=&EXT('resource.'.$part.'.'.$qualifierrest,
10776: $symbparm,$udom,$uname,$section,1);
10777: if (defined($partgeneral[0])) { return &get_reply(\@partgeneral); }
10778: }
10779: if ($recurse) { return undef; }
10780: my $pack_def=&packages_tab_default($filename,$varname);
10781: if (defined($pack_def)) { return &get_reply([$pack_def,'resource']); }
10782: # ---------------------------------------------------- Any other user namespace
10783: } elsif ($realm eq 'environment') {
10784: # ----------------------------------------------------------------- environment
10785: if (($uname eq $env{'user.name'})&&($udom eq $env{'user.domain'})) {
10786: return $env{'environment.'.$spacequalifierrest};
10787: } else {
10788: if ($uname eq 'anonymous' && $udom eq '') {
10789: return '';
10790: }
10791: my %returnhash=&userenvironment($udom,$uname,
10792: $spacequalifierrest);
10793: return $returnhash{$spacequalifierrest};
10794: }
10795: } elsif ($realm eq 'system') {
10796: # ----------------------------------------------------------------- system.time
10797: if ($space eq 'time') {
10798: return time;
10799: }
10800: } elsif ($realm eq 'server') {
10801: # ----------------------------------------------------------------- system.time
10802: if ($space eq 'name') {
10803: return $ENV{'SERVER_NAME'};
10804: }
10805: }
10806: return '';
10807: }
10808:
10809: sub get_reply {
10810: my ($reply_value) = @_;
10811: if (ref($reply_value) eq 'ARRAY') {
10812: if (wantarray) {
10813: return @$reply_value;
10814: }
10815: return $reply_value->[0];
10816: } else {
10817: return $reply_value;
10818: }
10819: }
10820:
10821: sub check_group_parms {
10822: my ($courseid,$groups,$symbparm,$recurseparm,$mapparm,$what,$mapp,
10823: $recursed,$recurseupref) = @_;
10824: my @levels = ([$symbparm,'resource'],[$mapparm,'map'],[$recurseparm,'map'],
10825: [$what,'course']);
10826: my $coursereply;
10827: foreach my $group (@{$groups}) {
10828: my @groupitems = ();
10829: foreach my $level (@levels) {
10830: my $item = $courseid.'.['.$group.'].'.$level->[0];
10831: push(@groupitems,[$item,$level->[1]]);
10832: }
10833: my $coursereply = &resdata($env{'course.'.$courseid.'.num'},
10834: $env{'course.'.$courseid.'.domain'},
10835: 'course',$mapp,$recursed,$recurseupref,
10836: $courseid,'.['.$group.'].',$what,
10837: @groupitems);
10838: last if (defined($coursereply));
10839: }
10840: return $coursereply;
10841: }
10842:
10843: sub get_map_hierarchy {
10844: my ($mapname,$courseid) = @_;
10845: my @recurseup = ();
10846: if ($mapname) {
10847: if (($cachedmapkey eq $courseid) &&
10848: (abs($cachedmaptime-time)<5)) {
10849: if (ref($cachedmaps{$mapname}) eq 'ARRAY') {
10850: return @{$cachedmaps{$mapname}};
10851: }
10852: }
10853: my $navmap = Apache::lonnavmaps::navmap->new();
10854: if (ref($navmap)) {
10855: @recurseup = $navmap->recurseup_maps($mapname);
10856: undef($navmap);
10857: $cachedmaps{$mapname} = \@recurseup;
10858: $cachedmaptime=time;
10859: $cachedmapkey=$courseid;
10860: }
10861: }
10862: return @recurseup;
10863: }
10864:
10865: }
10866:
10867: sub sort_course_groups { # Sort groups based on defined rankings. Default is sort().
10868: my ($courseid,@groups) = @_;
10869: @groups = sort(@groups);
10870: return @groups;
10871: }
10872:
10873: sub packages_tab_default {
10874: my ($uri,$varname)=@_;
10875: my (undef,$part,$name)=split(/\./,$varname);
10876:
10877: my (@extension,@specifics,$do_default);
10878: foreach my $package (split(/,/,&metadata($uri,'packages'))) {
10879: my ($pack_type,$pack_part)=split(/_/,$package,2);
10880: if ($pack_type eq 'default') {
10881: $do_default=1;
10882: } elsif ($pack_type eq 'extension') {
10883: push(@extension,[$package,$pack_type,$pack_part]);
10884: } elsif ($pack_part eq $part || $pack_type eq 'part') {
10885: # only look at packages defaults for packages that this id is
10886: push(@specifics,[$package,$pack_type,$pack_part]);
10887: }
10888: }
10889: # first look for a package that matches the requested part id
10890: foreach my $package (@specifics) {
10891: my (undef,$pack_type,$pack_part)=@{$package};
10892: next if ($pack_part ne $part);
10893: if (defined($packagetab{"$pack_type&$name&default"})) {
10894: return $packagetab{"$pack_type&$name&default"};
10895: }
10896: }
10897: # look for any possible matching non extension_ package
10898: foreach my $package (@specifics) {
10899: my (undef,$pack_type,$pack_part)=@{$package};
10900: if (defined($packagetab{"$pack_type&$name&default"})) {
10901: return $packagetab{"$pack_type&$name&default"};
10902: }
10903: if ($pack_type eq 'part') { $pack_part='0'; }
10904: if (defined($packagetab{$pack_type."_".$pack_part."&$name&default"})) {
10905: return $packagetab{$pack_type."_".$pack_part."&$name&default"};
10906: }
10907: }
10908: # look for any posible extension_ match
10909: foreach my $package (@extension) {
10910: my ($package,$pack_type)=@{$package};
10911: if (defined($packagetab{"$pack_type&$name&default"})) {
10912: return $packagetab{"$pack_type&$name&default"};
10913: }
10914: if (defined($packagetab{$package."&$name&default"})) {
10915: return $packagetab{$package."&$name&default"};
10916: }
10917: }
10918: # look for a global default setting
10919: if ($do_default && defined($packagetab{"default&$name&default"})) {
10920: return $packagetab{"default&$name&default"};
10921: }
10922: return undef;
10923: }
10924:
10925: sub add_prefix_and_part {
10926: my ($prefix,$part)=@_;
10927: my $keyroot;
10928: if (defined($prefix) && $prefix !~ /^__/) {
10929: # prefix that has a part already
10930: $keyroot=$prefix;
10931: } elsif (defined($prefix)) {
10932: # prefix that is missing a part
10933: if (defined($part)) { $keyroot='_'.$part.substr($prefix,1); }
10934: } else {
10935: # no prefix at all
10936: if (defined($part)) { $keyroot='_'.$part; }
10937: }
10938: return $keyroot;
10939: }
10940:
10941: # ---------------------------------------------------------------- Get metadata
10942:
10943: my %metaentry;
10944: my %importedpartids;
10945: sub metadata {
10946: my ($uri,$what,$liburi,$prefix,$depthcount)=@_;
10947: $uri=&declutter($uri);
10948: # if it is a non metadata possible uri return quickly
10949: if (($uri eq '') ||
10950: (($uri =~ m|^/*adm/|) &&
10951: ($uri !~ m|^adm/includes|) && ($uri !~ m{/(smppg|bulletinboard|exttools?)$})) ||
10952: ($uri =~ m|/$|) || ($uri =~ m|/.meta$|) || ($uri =~ m{^/*uploaded/.+\.sequence$})) {
10953: return undef;
10954: }
10955: if (($uri =~ /^priv/ || $uri=~m{^home/httpd/html/priv})
10956: && &Apache::lonxml::get_state('target') =~ /^(|meta)$/) {
10957: return undef;
10958: }
10959: my $filename=$uri;
10960: $uri=~s/\.meta$//;
10961: #
10962: # Is the metadata already cached?
10963: # Look at timestamp of caching
10964: # Everything is cached by the main uri, libraries are never directly cached
10965: #
10966: if (!defined($liburi)) {
10967: my ($result,$cached)=&is_cached_new('meta',$uri);
10968: if (defined($cached)) { return $result->{':'.$what}; }
10969: }
10970: {
10971: # Imported parts would go here
10972: my %importedids=();
10973: my @origfileimportpartids=();
10974: my $importedparts=0;
10975: #
10976: # Is this a recursive call for a library?
10977: #
10978: # if (! exists($metacache{$uri})) {
10979: # $metacache{$uri}={};
10980: # }
10981: my $cachetime = 60*60;
10982: if ($liburi) {
10983: $liburi=&declutter($liburi);
10984: $filename=$liburi;
10985: } else {
10986: &devalidate_cache_new('meta',$uri);
10987: undef(%metaentry);
10988: }
10989: my %metathesekeys=();
10990: unless ($filename=~/\.meta$/) { $filename.='.meta'; }
10991: my $metastring;
10992: if ($uri =~ /^priv/ || $uri=~/home\/httpd\/html\/priv/) {
10993: my $which = &hreflocation('','/'.($liburi || $uri));
10994: $metastring =
10995: &Apache::lonnet::ssi_body($which,
10996: ('grade_target' => 'meta'));
10997: $cachetime = 1; # only want this cached in the child not long term
10998: } elsif (($uri !~ m -^(editupload)/-) &&
10999: ($uri !~ m{^/*uploaded/$match_domain/$match_courseid/docs/})) {
11000: my $file=&filelocation('',&clutter($filename));
11001: #push(@{$metaentry{$uri.'.file'}},$file);
11002: $metastring=&getfile($file);
11003: }
11004: my $parser=HTML::LCParser->new(\$metastring);
11005: my $token;
11006: undef %metathesekeys;
11007: while ($token=$parser->get_token) {
11008: if ($token->[0] eq 'S') {
11009: if (defined($token->[2]->{'package'})) {
11010: #
11011: # This is a package - get package info
11012: #
11013: my $package=$token->[2]->{'package'};
11014: my $keyroot=&add_prefix_and_part($prefix,$token->[2]->{'part'});
11015: if (defined($token->[2]->{'id'})) {
11016: $keyroot.='_'.$token->[2]->{'id'};
11017: }
11018: if ($metaentry{':packages'}) {
11019: $metaentry{':packages'}.=','.$package.$keyroot;
11020: } else {
11021: $metaentry{':packages'}=$package.$keyroot;
11022: }
11023: foreach my $pack_entry (keys(%packagetab)) {
11024: my $part=$keyroot;
11025: $part=~s/^\_//;
11026: if ($pack_entry=~/^\Q$package\E\&/ ||
11027: $pack_entry=~/^\Q$package\E_0\&/) {
11028: my ($pack,$name,$subp)=split(/\&/,$pack_entry);
11029: # ignore package.tab specified default values
11030: # here &package_tab_default() will fetch those
11031: if ($subp eq 'default') { next; }
11032: my $value=$packagetab{$pack_entry};
11033: my $unikey;
11034: if ($pack =~ /_0$/) {
11035: $unikey='parameter_0_'.$name;
11036: $part=0;
11037: } else {
11038: $unikey='parameter'.$keyroot.'_'.$name;
11039: }
11040: if ($subp eq 'display') {
11041: $value.=' [Part: '.$part.']';
11042: }
11043: $metaentry{':'.$unikey.'.part'}=$part;
11044: $metathesekeys{$unikey}=1;
11045: unless (defined($metaentry{':'.$unikey.'.'.$subp})) {
11046: $metaentry{':'.$unikey.'.'.$subp}=$value;
11047: }
11048: if (defined($metaentry{':'.$unikey.'.default'})) {
11049: $metaentry{':'.$unikey}=
11050: $metaentry{':'.$unikey.'.default'};
11051: }
11052: }
11053: }
11054: } else {
11055: #
11056: # This is not a package - some other kind of start tag
11057: #
11058: my $entry=$token->[1];
11059: my $unikey='';
11060:
11061: if ($entry eq 'import') {
11062: #
11063: # Importing a library here
11064: #
11065: my $location=$parser->get_text('/import');
11066: my $dir=$filename;
11067: $dir=~s|[^/]*$||;
11068: $location=&filelocation($dir,$location);
11069:
11070: my $importmode=$token->[2]->{'importmode'};
11071: if ($importmode eq 'problem') {
11072: # Import as problem/response
11073: $unikey=&add_prefix_and_part($prefix,$token->[2]->{'part'});
11074: } elsif ($importmode eq 'part') {
11075: # Import as part(s)
11076: $importedparts=1;
11077: # We need to get the original file and the imported file to get the part order correct
11078: # Good news: we do not need to worry about nested libraries, since parts cannot be nested
11079: # Load and inspect original file
11080: if ($#origfileimportpartids<0) {
11081: undef(%importedpartids);
11082: my $origfilelocation=$perlvar{'lonDocRoot'}.&clutter($uri);
11083: my $origfile=&getfile($origfilelocation);
11084: @origfileimportpartids=($origfile=~/<(part|import)[^>]*id\s*=\s*[\"\']([^\"\']+)[\"\'][^>]*>/gs);
11085: }
11086:
11087: # Load and inspect imported file
11088: my $impfile=&getfile($location);
11089: my @impfilepartids=($impfile=~/<part[^>]*id\s*=\s*[\"\']([^\"\']+)[\"\'][^>]*>/gs);
11090: if ($#impfilepartids>=0) {
11091: # This problem had parts
11092: $importedpartids{$token->[2]->{'id'}}=join(',',@impfilepartids);
11093: } else {
11094: # Importing by turning a single problem into a problem part
11095: # It gets the import-tags ID as part-ID
11096: $unikey=&add_prefix_and_part($prefix,$token->[2]->{'id'});
11097: $importedpartids{$token->[2]->{'id'}}=$token->[2]->{'id'};
11098: }
11099: } else {
11100: # Normal import
11101: $unikey=&add_prefix_and_part($prefix,$token->[2]->{'part'});
11102: if (defined($token->[2]->{'id'})) {
11103: $unikey.='_'.$token->[2]->{'id'};
11104: }
11105: }
11106:
11107: if ($depthcount<20) {
11108: my $metadata =
11109: &metadata($uri,'keys', $location,$unikey,
11110: $depthcount+1);
11111: foreach my $meta (split(',',$metadata)) {
11112: $metaentry{':'.$meta}=$metaentry{':'.$meta};
11113: $metathesekeys{$meta}=1;
11114: }
11115:
11116: }
11117: } else {
11118: #
11119: # Not importing, some other kind of non-package, non-library start tag
11120: #
11121: $unikey=$entry.&add_prefix_and_part($prefix,$token->[2]->{'part'});
11122: if (defined($token->[2]->{'id'})) {
11123: $unikey.='_'.$token->[2]->{'id'};
11124: }
11125: if (defined($token->[2]->{'name'})) {
11126: $unikey.='_'.$token->[2]->{'name'};
11127: }
11128: $metathesekeys{$unikey}=1;
11129: foreach my $param (@{$token->[3]}) {
11130: $metaentry{':'.$unikey.'.'.$param} =
11131: $token->[2]->{$param};
11132: }
11133: my $internaltext=&HTML::Entities::decode($parser->get_text('/'.$entry));
11134: my $default=$metaentry{':'.$unikey.'.default'};
11135: if ( $internaltext =~ /^\s*$/ && $default !~ /^\s*$/) {
11136: # only ws inside the tag, and not in default, so use default
11137: # as value
11138: $metaentry{':'.$unikey}=$default;
11139: } elsif ( $internaltext =~ /\S/ ) {
11140: # something interesting inside the tag
11141: $metaentry{':'.$unikey}=$internaltext;
11142: } else {
11143: # no interesting values, don't set a default
11144: }
11145: # end of not-a-package not-a-library import
11146: }
11147: # end of not-a-package start tag
11148: }
11149: # the next is the end of "start tag"
11150: }
11151: }
11152: my ($extension) = ($uri =~ /\.(\w+)$/);
11153: $extension = lc($extension);
11154: if ($extension eq 'htm') { $extension='html'; }
11155:
11156: foreach my $key (keys(%packagetab)) {
11157: #no specific packages #how's our extension
11158: if ($key!~/^extension_\Q$extension\E&/) { next; }
11159: &metadata_create_package_def($uri,$key,'extension_'.$extension,
11160: \%metathesekeys);
11161: }
11162:
11163: if (!exists($metaentry{':packages'})
11164: || $packagetab{"import_defaults&extension_$extension"}) {
11165: foreach my $key (keys(%packagetab)) {
11166: #no specific packages well let's get default then
11167: if ($key!~/^default&/) { next; }
11168: &metadata_create_package_def($uri,$key,'default',
11169: \%metathesekeys);
11170: }
11171: }
11172: # are there custom rights to evaluate
11173: if ($metaentry{':copyright'} eq 'custom') {
11174:
11175: #
11176: # Importing a rights file here
11177: #
11178: unless ($depthcount) {
11179: my $location=$metaentry{':customdistributionfile'};
11180: my $dir=$filename;
11181: $dir=~s|[^/]*$||;
11182: $location=&filelocation($dir,$location);
11183: my $rights_metadata =
11184: &metadata($uri,'keys',$location,'_rights',
11185: $depthcount+1);
11186: foreach my $rights (split(',',$rights_metadata)) {
11187: #$metaentry{':'.$rights}=$metacache{$uri}->{':'.$rights};
11188: $metathesekeys{$rights}=1;
11189: }
11190: }
11191: }
11192: # uniqifiy package listing
11193: my %seen;
11194: my @uniq_packages =
11195: grep { ! $seen{$_} ++ } (split(',',$metaentry{':packages'}));
11196: $metaentry{':packages'} = join(',',@uniq_packages);
11197:
11198: if ($importedparts) {
11199: # We had imported parts and need to rebuild partorder
11200: $metaentry{':partorder'}='';
11201: $metathesekeys{'partorder'}=1;
11202: for (my $index=0;$index<$#origfileimportpartids;$index+=2) {
11203: if ($origfileimportpartids[$index] eq 'part') {
11204: # original part, part of the problem
11205: $metaentry{':partorder'}.=','.$origfileimportpartids[$index+1];
11206: } else {
11207: # we have imported parts at this position
11208: $metaentry{':partorder'}.=','.$importedpartids{$origfileimportpartids[$index+1]};
11209: }
11210: }
11211: $metaentry{':partorder'}=~s/^\,//;
11212: }
11213:
11214: $metaentry{':keys'} = join(',',keys(%metathesekeys));
11215: &metadata_generate_part0(\%metathesekeys,\%metaentry,$uri);
11216: $metaentry{':allpossiblekeys'}=join(',',keys(%metathesekeys));
11217: &do_cache_new('meta',$uri,\%metaentry,$cachetime);
11218: # this is the end of "was not already recently cached
11219: }
11220: return $metaentry{':'.$what};
11221: }
11222:
11223: sub metadata_create_package_def {
11224: my ($uri,$key,$package,$metathesekeys)=@_;
11225: my ($pack,$name,$subp)=split(/\&/,$key);
11226: if ($subp eq 'default') { next; }
11227:
11228: if (defined($metaentry{':packages'})) {
11229: $metaentry{':packages'}.=','.$package;
11230: } else {
11231: $metaentry{':packages'}=$package;
11232: }
11233: my $value=$packagetab{$key};
11234: my $unikey;
11235: $unikey='parameter_0_'.$name;
11236: $metaentry{':'.$unikey.'.part'}=0;
11237: $$metathesekeys{$unikey}=1;
11238: unless (defined($metaentry{':'.$unikey.'.'.$subp})) {
11239: $metaentry{':'.$unikey.'.'.$subp}=$value;
11240: }
11241: if (defined($metaentry{':'.$unikey.'.default'})) {
11242: $metaentry{':'.$unikey}=
11243: $metaentry{':'.$unikey.'.default'};
11244: }
11245: }
11246:
11247: sub metadata_generate_part0 {
11248: my ($metadata,$metacache,$uri) = @_;
11249: my %allnames;
11250: foreach my $metakey (keys(%$metadata)) {
11251: if ($metakey=~/^parameter\_(.*)/) {
11252: my $part=$$metacache{':'.$metakey.'.part'};
11253: my $name=$$metacache{':'.$metakey.'.name'};
11254: if (! exists($$metadata{'parameter_0_'.$name.'.name'})) {
11255: $allnames{$name}=$part;
11256: }
11257: }
11258: }
11259: foreach my $name (keys(%allnames)) {
11260: $$metadata{"parameter_0_$name"}=1;
11261: my $key=":parameter_0_$name";
11262: $$metacache{"$key.part"}='0';
11263: $$metacache{"$key.name"}=$name;
11264: $$metacache{"$key.type"}=$$metacache{':parameter_'.
11265: $allnames{$name}.'_'.$name.
11266: '.type'};
11267: my $olddis=$$metacache{':parameter_'.$allnames{$name}.'_'.$name.
11268: '.display'};
11269: my $expr='[Part: '.$allnames{$name}.']';
11270: $olddis=~s/\Q$expr\E/\[Part: 0\]/;
11271: $$metacache{"$key.display"}=$olddis;
11272: }
11273: }
11274:
11275: # ------------------------------------------------------ Devalidate title cache
11276:
11277: sub devalidate_title_cache {
11278: my ($url)=@_;
11279: if (!$env{'request.course.id'}) { return; }
11280: my $symb=&symbread($url);
11281: if (!$symb) { return; }
11282: my $key=$env{'request.course.id'}."\0".$symb;
11283: &devalidate_cache_new('title',$key);
11284: }
11285:
11286: # ------------------------------------------------- Get the title of a course
11287:
11288: sub current_course_title {
11289: return $env{ 'course.' . $env{'request.course.id'} . '.description' };
11290: }
11291: # ------------------------------------------------- Get the title of a resource
11292:
11293: sub gettitle {
11294: my $urlsymb=shift;
11295: my $symb=&symbread($urlsymb);
11296: if ($symb) {
11297: my $key=$env{'request.course.id'}."\0".$symb;
11298: my ($result,$cached)=&is_cached_new('title',$key);
11299: if (defined($cached)) {
11300: return $result;
11301: }
11302: my ($map,$resid,$url)=&decode_symb($symb);
11303: my $title='';
11304: if (!$map && $resid == 0 && $url =~/default\.sequence$/) {
11305: $title = $env{'course.'.$env{'request.course.id'}.'.description'};
11306: } else {
11307: if (tie(my %bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
11308: &GDBM_READER(),0640)) {
11309: my $mapid=$bighash{'map_pc_'.&clutter($map)};
11310: $title=$bighash{'title_'.$mapid.'.'.$resid};
11311: untie(%bighash);
11312: }
11313: }
11314: $title=~s/\&colon\;/\:/gs;
11315: if ($title) {
11316: # Remember both $symb and $title for dynamic metadata
11317: $accesshash{$symb.'___crstitle'}=$title;
11318: $accesshash{&declutter($map).'___'.&declutter($url).'___usage'}=time;
11319: # Cache this title and then return it
11320: return &do_cache_new('title',$key,$title,600);
11321: }
11322: $urlsymb=$url;
11323: }
11324: my $title=&metadata($urlsymb,'title');
11325: if (!$title) { $title=(split('/',$urlsymb))[-1]; }
11326: return $title;
11327: }
11328:
11329: sub get_slot {
11330: my ($which,$cnum,$cdom)=@_;
11331: if (!$cnum || !$cdom) {
11332: (undef,my $courseid)=&whichuser();
11333: $cdom=$env{'course.'.$courseid.'.domain'};
11334: $cnum=$env{'course.'.$courseid.'.num'};
11335: }
11336: my $key=join("\0",'slots',$cdom,$cnum,$which);
11337: my %slotinfo;
11338: if (exists($remembered{$key})) {
11339: $slotinfo{$which} = $remembered{$key};
11340: } else {
11341: %slotinfo=&get('slots',[$which],$cdom,$cnum);
11342: &Apache::lonhomework::showhash(%slotinfo);
11343: my ($tmp)=keys(%slotinfo);
11344: if ($tmp=~/^error:/) { return (); }
11345: $remembered{$key} = $slotinfo{$which};
11346: }
11347: if (ref($slotinfo{$which}) eq 'HASH') {
11348: return %{$slotinfo{$which}};
11349: }
11350: return $slotinfo{$which};
11351: }
11352:
11353: sub get_reservable_slots {
11354: my ($cnum,$cdom,$uname,$udom) = @_;
11355: my $now = time;
11356: my $reservable_info;
11357: my $key=join("\0",'reservableslots',$cdom,$cnum,$uname,$udom);
11358: if (exists($remembered{$key})) {
11359: $reservable_info = $remembered{$key};
11360: } else {
11361: my %resv;
11362: ($resv{'now_order'},$resv{'now'},$resv{'future_order'},$resv{'future'}) =
11363: &Apache::loncommon::get_future_slots($cnum,$cdom,$now);
11364: $reservable_info = \%resv;
11365: $remembered{$key} = $reservable_info;
11366: }
11367: return $reservable_info;
11368: }
11369:
11370: sub get_course_slots {
11371: my ($cnum,$cdom) = @_;
11372: my $hashid=$cnum.':'.$cdom;
11373: my ($result,$cached) = &Apache::lonnet::is_cached_new('allslots',$hashid);
11374: if (defined($cached)) {
11375: if (ref($result) eq 'HASH') {
11376: return %{$result};
11377: }
11378: } else {
11379: my %slots=&Apache::lonnet::dump('slots',$cdom,$cnum);
11380: my ($tmp) = keys(%slots);
11381: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
11382: &do_cache_new('allslots',$hashid,\%slots,600);
11383: return %slots;
11384: }
11385: }
11386: return;
11387: }
11388:
11389: sub devalidate_slots_cache {
11390: my ($cnum,$cdom)=@_;
11391: my $hashid=$cnum.':'.$cdom;
11392: &devalidate_cache_new('allslots',$hashid);
11393: }
11394:
11395: sub get_coursechange {
11396: my ($cdom,$cnum) = @_;
11397: if ($cdom eq '' || $cnum eq '') {
11398: return unless ($env{'request.course.id'});
11399: $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
11400: $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
11401: }
11402: my $hashid=$cdom.'_'.$cnum;
11403: my ($change,$cached)=&is_cached_new('crschange',$hashid);
11404: if ((defined($cached)) && ($change ne '')) {
11405: return $change;
11406: } else {
11407: my %crshash;
11408: %crshash = &get('environment',['internal.contentchange'],$cdom,$cnum);
11409: if ($crshash{'internal.contentchange'} eq '') {
11410: $change = $env{'course.'.$cdom.'_'.$cnum.'.internal.created'};
11411: if ($change eq '') {
11412: %crshash = &get('environment',['internal.created'],$cdom,$cnum);
11413: $change = $crshash{'internal.created'};
11414: }
11415: } else {
11416: $change = $crshash{'internal.contentchange'};
11417: }
11418: my $cachetime = 600;
11419: &do_cache_new('crschange',$hashid,$change,$cachetime);
11420: }
11421: return $change;
11422: }
11423:
11424: sub devalidate_coursechange_cache {
11425: my ($cnum,$cdom)=@_;
11426: my $hashid=$cnum.':'.$cdom;
11427: &devalidate_cache_new('crschange',$hashid);
11428: }
11429:
11430: # ------------------------------------------------- Update symbolic store links
11431:
11432: sub symblist {
11433: my ($mapname,%newhash)=@_;
11434: $mapname=&deversion(&declutter($mapname));
11435: my %hash;
11436: if (($env{'request.course.fn'}) && (%newhash)) {
11437: if (tie(%hash,'GDBM_File',$env{'request.course.fn'}.'_symb.db',
11438: &GDBM_WRCREAT(),0640)) {
11439: foreach my $url (keys(%newhash)) {
11440: next if ($url eq 'last_known'
11441: && $env{'form.no_update_last_known'});
11442: $hash{declutter($url)}=&encode_symb($mapname,
11443: $newhash{$url}->[1],
11444: $newhash{$url}->[0]);
11445: }
11446: if (untie(%hash)) {
11447: return 'ok';
11448: }
11449: }
11450: }
11451: return 'error';
11452: }
11453:
11454: # --------------------------------------------------------------- Verify a symb
11455:
11456: sub symbverify {
11457: my ($symb,$thisurl,$encstate)=@_;
11458: my $thisfn=$thisurl;
11459: $thisfn=&declutter($thisfn);
11460: # direct jump to resource in page or to a sequence - will construct own symbs
11461: if ($thisfn=~/\.(page|sequence)$/) { return 1; }
11462: # check URL part
11463: my ($map,$resid,$url)=&decode_symb($symb);
11464:
11465: unless ($url eq $thisfn) { return 0; }
11466:
11467: $symb=&symbclean($symb);
11468: $thisurl=&deversion($thisurl);
11469: $thisfn=&deversion($thisfn);
11470:
11471: my %bighash;
11472: my $okay=0;
11473:
11474: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
11475: &GDBM_READER(),0640)) {
11476: my $noclutter;
11477: if (($thisurl =~ m{^/adm/wrapper/ext/}) || ($thisurl =~ m{^ext/})) {
11478: $thisurl =~ s/\?.+$//;
11479: if ($map =~ m{^uploaded/.+\.page$}) {
11480: $thisurl =~ s{^(/adm/wrapper|)/ext/}{http://};
11481: $thisurl =~ s{^\Qhttp://https://\E}{https://};
11482: $noclutter = 1;
11483: }
11484: }
11485: my $ids;
11486: if ($noclutter) {
11487: $ids=$bighash{'ids_'.$thisurl};
11488: } else {
11489: $ids=$bighash{'ids_'.&clutter($thisurl)};
11490: }
11491: unless ($ids) {
11492: my $idkey = 'ids_'.($thisurl =~ m{^/}? '' : '/').$thisurl;
11493: $ids=$bighash{$idkey};
11494: }
11495: if ($ids) {
11496: # ------------------------------------------------------------------- Has ID(s)
11497: if ($thisfn =~ m{^/adm/wrapper/ext/}) {
11498: $symb =~ s/\?.+$//;
11499: }
11500: foreach my $id (split(/\,/,$ids)) {
11501: my ($mapid,$resid)=split(/\./,$id);
11502: if (
11503: &symbclean(&declutter($bighash{'map_id_'.$mapid}).'___'.$resid.'___'.$thisfn)
11504: eq $symb) {
11505: if (ref($encstate)) {
11506: $$encstate = $bighash{'encrypted_'.$id};
11507: }
11508: if (($env{'request.role.adv'}) ||
11509: ($bighash{'encrypted_'.$id} eq $env{'request.enc'}) ||
11510: ($thisurl eq '/adm/navmaps')) {
11511: $okay=1;
11512: last;
11513: }
11514: }
11515: }
11516: }
11517: untie(%bighash);
11518: }
11519: return $okay;
11520: }
11521:
11522: # --------------------------------------------------------------- Clean-up symb
11523:
11524: sub symbclean {
11525: my $symb=shift;
11526: if ($symb=~m|^/enc/|) { $symb=&Apache::lonenc::unencrypted($symb); }
11527: # remove version from map
11528: $symb=~s/\.(\d+)\.(\w+)\_\_\_/\.$2\_\_\_/;
11529:
11530: # remove version from URL
11531: $symb=~s/\.(\d+)\.(\w+)$/\.$2/;
11532:
11533: # remove wrapper
11534:
11535: $symb=~s/(\_\_\_\d+\_\_\_)adm\/wrapper\/(res\/)*/$1/;
11536: $symb=~s/(\_\_\_\d+\_\_\_)adm\/coursedocs\/showdoc\/(res\/)*/$1/;
11537: return $symb;
11538: }
11539:
11540: # ---------------------------------------------- Split symb to find map and url
11541:
11542: sub encode_symb {
11543: my ($map,$resid,$url)=@_;
11544: return &symbclean(&declutter($map).'___'.$resid.'___'.&declutter($url));
11545: }
11546:
11547: sub decode_symb {
11548: my $symb=shift;
11549: if ($symb=~m|^/enc/|) { $symb=&Apache::lonenc::unencrypted($symb); }
11550: my ($map,$resid,$url)=split(/___/,$symb);
11551: return (&fixversion($map),$resid,&fixversion($url));
11552: }
11553:
11554: sub fixversion {
11555: my $fn=shift;
11556: if ($fn=~/^(adm|uploaded|editupload|public)/) { return $fn; }
11557: my %bighash;
11558: my $uri=&clutter($fn);
11559: my $key=$env{'request.course.id'}.'_'.$uri;
11560: # is this cached?
11561: my ($result,$cached)=&is_cached_new('courseresversion',$key);
11562: if (defined($cached)) { return $result; }
11563: # unfortunately not cached, or expired
11564: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
11565: &GDBM_READER(),0640)) {
11566: if ($bighash{'version_'.$uri}) {
11567: my $version=$bighash{'version_'.$uri};
11568: unless (($version eq 'mostrecent') ||
11569: ($version==&getversion($uri))) {
11570: $uri=~s/\.(\w+)$/\.$version\.$1/;
11571: }
11572: }
11573: untie %bighash;
11574: }
11575: return &do_cache_new('courseresversion',$key,&declutter($uri),600);
11576: }
11577:
11578: sub deversion {
11579: my $url=shift;
11580: $url=~s/\.\d+\.(\w+)$/\.$1/;
11581: return $url;
11582: }
11583:
11584: # ------------------------------------------------------ Return symb list entry
11585:
11586: sub symbread {
11587: my ($thisfn,$donotrecurse,$ignorecachednull,$checkforblock,$possibles)=@_;
11588: my $cache_str='request.symbread.cached.'.$thisfn;
11589: if (defined($env{$cache_str})) {
11590: if ($ignorecachednull) {
11591: return $env{$cache_str} unless ($env{$cache_str} eq '');
11592: } else {
11593: return $env{$cache_str};
11594: }
11595: }
11596: # no filename provided? try from environment
11597: unless ($thisfn) {
11598: if ($env{'request.symb'}) {
11599: return $env{$cache_str}=&symbclean($env{'request.symb'});
11600: }
11601: $thisfn=$env{'request.filename'};
11602: }
11603: if ($thisfn=~m|^/enc/|) { $thisfn=&Apache::lonenc::unencrypted($thisfn); }
11604: # is that filename actually a symb? Verify, clean, and return
11605: if ($thisfn=~/\_\_\_\d+\_\_\_(.*)$/) {
11606: if (&symbverify($thisfn,$1)) {
11607: return $env{$cache_str}=&symbclean($thisfn);
11608: }
11609: }
11610: $thisfn=declutter($thisfn);
11611: my %hash;
11612: my %bighash;
11613: my $syval='';
11614: if (($env{'request.course.fn'}) && ($thisfn)) {
11615: my $targetfn = $thisfn;
11616: if ( ($thisfn =~ m/^(uploaded|editupload)\//) && ($thisfn !~ m/\.(page|sequence)$/) ) {
11617: $targetfn = 'adm/wrapper/'.$thisfn;
11618: }
11619: if ($targetfn =~ m|^adm/wrapper/(ext/.*)|) {
11620: $targetfn=$1;
11621: }
11622: if (tie(%hash,'GDBM_File',$env{'request.course.fn'}.'_symb.db',
11623: &GDBM_READER(),0640)) {
11624: $syval=$hash{$targetfn};
11625: untie(%hash);
11626: }
11627: # ---------------------------------------------------------- There was an entry
11628: if ($syval) {
11629: #unless ($syval=~/\_\d+$/) {
11630: #unless ($env{'form.request.prefix'}=~/\.(\d+)\_$/) {
11631: #&appenv({'request.ambiguous' => $thisfn});
11632: #return $env{$cache_str}='';
11633: #}
11634: #$syval.=$1;
11635: #}
11636: } else {
11637: # ------------------------------------------------------- Was not in symb table
11638: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
11639: &GDBM_READER(),0640)) {
11640: # ---------------------------------------------- Get ID(s) for current resource
11641: my $ids=$bighash{'ids_'.&clutter($thisfn)};
11642: unless ($ids) {
11643: $ids=$bighash{'ids_/'.$thisfn};
11644: }
11645: unless ($ids) {
11646: # alias?
11647: $ids=$bighash{'mapalias_'.$thisfn};
11648: }
11649: if ($ids) {
11650: # ------------------------------------------------------------------- Has ID(s)
11651: my @possibilities=split(/\,/,$ids);
11652: if ($#possibilities==0) {
11653: # ----------------------------------------------- There is only one possibility
11654: my ($mapid,$resid)=split(/\./,$ids);
11655: $syval=&encode_symb($bighash{'map_id_'.$mapid},
11656: $resid,$thisfn);
11657: if (ref($possibles) eq 'HASH') {
11658: $possibles->{$syval} = 1;
11659: }
11660: if ($checkforblock) {
11661: my @blockers = &has_comm_blocking('bre',$syval,$bighash{'src_'.$ids});
11662: if (@blockers) {
11663: $syval = '';
11664: return;
11665: }
11666: }
11667: } elsif ((!$donotrecurse) || ($checkforblock) || (ref($possibles) eq 'HASH')) {
11668: # ------------------------------------------ There is more than one possibility
11669: my $realpossible=0;
11670: foreach my $id (@possibilities) {
11671: my $file=$bighash{'src_'.$id};
11672: my $canaccess;
11673: if (($donotrecurse) || ($checkforblock) || (ref($possibles) eq 'HASH')) {
11674: $canaccess = 1;
11675: } else {
11676: $canaccess = &allowed('bre',$file);
11677: }
11678: if ($canaccess) {
11679: my ($mapid,$resid)=split(/\./,$id);
11680: if ($bighash{'map_type_'.$mapid} ne 'page') {
11681: my $poss_syval=&encode_symb($bighash{'map_id_'.$mapid},
11682: $resid,$thisfn);
11683: if (ref($possibles) eq 'HASH') {
11684: $possibles->{$syval} = 1;
11685: }
11686: if ($checkforblock) {
11687: my @blockers = &has_comm_blocking('bre',$poss_syval,$file);
11688: unless (@blockers > 0) {
11689: $syval = $poss_syval;
11690: $realpossible++;
11691: }
11692: } else {
11693: $syval = $poss_syval;
11694: $realpossible++;
11695: }
11696: }
11697: }
11698: }
11699: if ($realpossible!=1) { $syval=''; }
11700: } else {
11701: $syval='';
11702: }
11703: }
11704: untie(%bighash);
11705: }
11706: }
11707: if ($syval) {
11708: return $env{$cache_str}=$syval;
11709: }
11710: }
11711: &appenv({'request.ambiguous' => $thisfn});
11712: return $env{$cache_str}='';
11713: }
11714:
11715: # ---------------------------------------------------------- Return random seed
11716:
11717: sub numval {
11718: my $txt=shift;
11719: $txt=~tr/A-J/0-9/;
11720: $txt=~tr/a-j/0-9/;
11721: $txt=~tr/K-T/0-9/;
11722: $txt=~tr/k-t/0-9/;
11723: $txt=~tr/U-Z/0-5/;
11724: $txt=~tr/u-z/0-5/;
11725: $txt=~s/\D//g;
11726: if ($_64bit) { if ($txt > 2**32) { return -1; } }
11727: return int($txt);
11728: }
11729:
11730: sub numval2 {
11731: my $txt=shift;
11732: $txt=~tr/A-J/0-9/;
11733: $txt=~tr/a-j/0-9/;
11734: $txt=~tr/K-T/0-9/;
11735: $txt=~tr/k-t/0-9/;
11736: $txt=~tr/U-Z/0-5/;
11737: $txt=~tr/u-z/0-5/;
11738: $txt=~s/\D//g;
11739: my @txts=split(/(\d\d\d\d\d\d\d\d\d)/,$txt);
11740: my $total;
11741: foreach my $val (@txts) { $total+=$val; }
11742: if ($_64bit) { if ($total > 2**32) { return -1; } }
11743: return int($total);
11744: }
11745:
11746: sub numval3 {
11747: use integer;
11748: my $txt=shift;
11749: $txt=~tr/A-J/0-9/;
11750: $txt=~tr/a-j/0-9/;
11751: $txt=~tr/K-T/0-9/;
11752: $txt=~tr/k-t/0-9/;
11753: $txt=~tr/U-Z/0-5/;
11754: $txt=~tr/u-z/0-5/;
11755: $txt=~s/\D//g;
11756: my @txts=split(/(\d\d\d\d\d\d\d\d\d)/,$txt);
11757: my $total;
11758: foreach my $val (@txts) { $total+=$val; }
11759: if ($_64bit) { $total=(($total<<32)>>32); }
11760: return $total;
11761: }
11762:
11763: sub digest {
11764: my ($data)=@_;
11765: my $digest=&Digest::MD5::md5($data);
11766: my ($a,$b,$c,$d)=unpack("iiii",$digest);
11767: my ($e,$f);
11768: {
11769: use integer;
11770: $e=($a+$b);
11771: $f=($c+$d);
11772: if ($_64bit) {
11773: $e=(($e<<32)>>32);
11774: $f=(($f<<32)>>32);
11775: }
11776: }
11777: if (wantarray) {
11778: return ($e,$f);
11779: } else {
11780: my $g;
11781: {
11782: use integer;
11783: $g=($e+$f);
11784: if ($_64bit) {
11785: $g=(($g<<32)>>32);
11786: }
11787: }
11788: return $g;
11789: }
11790: }
11791:
11792: sub latest_rnd_algorithm_id {
11793: return '64bit5';
11794: }
11795:
11796: sub get_rand_alg {
11797: my ($courseid)=@_;
11798: if (!$courseid) { $courseid=(&whichuser())[1]; }
11799: if ($courseid) {
11800: return $env{"course.$courseid.rndseed"};
11801: }
11802: return &latest_rnd_algorithm_id();
11803: }
11804:
11805: sub validCODE {
11806: my ($CODE)=@_;
11807: if (defined($CODE) && $CODE ne '' && $CODE =~ /^\w+$/) { return 1; }
11808: return 0;
11809: }
11810:
11811: sub getCODE {
11812: if (&validCODE($env{'form.CODE'})) { return $env{'form.CODE'}; }
11813: if ( (defined($Apache::lonhomework::parsing_a_problem) ||
11814: defined($Apache::lonhomework::parsing_a_task) ) &&
11815: &validCODE($Apache::lonhomework::history{'resource.CODE'})) {
11816: return $Apache::lonhomework::history{'resource.CODE'};
11817: }
11818: return undef;
11819: }
11820: #
11821: # Determines the random seed for a specific context:
11822: #
11823: # parameters:
11824: # symb - in course context the symb for the seed.
11825: # course_id - The course id of the form domain_coursenum.
11826: # domain - Domain for the user.
11827: # course - Course for the user.
11828: # cenv - environment of the course.
11829: #
11830: # NOTE:
11831: # All parameters are picked out of the environment if missing
11832: # or not defined.
11833: # If a symb cannot be determined the current time is used instead.
11834: #
11835: # For a given well defined symb, courside, domain, username,
11836: # and course environment, the seed is reproducible.
11837: #
11838: sub rndseed {
11839: my ($symb,$courseid,$domain,$username, $cenv)=@_;
11840: my ($wsymb,$wcourseid,$wdomain,$wusername)=&whichuser();
11841: if (!defined($symb)) {
11842: unless ($symb=$wsymb) { return time; }
11843: }
11844: if (!defined $courseid) {
11845: $courseid=$wcourseid;
11846: }
11847: if (!defined $domain) { $domain=$wdomain; }
11848: if (!defined $username) { $username=$wusername }
11849:
11850: my $which;
11851: if (defined($cenv->{'rndseed'})) {
11852: $which = $cenv->{'rndseed'};
11853: } else {
11854: $which =&get_rand_alg($courseid);
11855: }
11856: if (defined(&getCODE())) {
11857:
11858: if ($which eq '64bit5') {
11859: return &rndseed_CODE_64bit5($symb,$courseid,$domain,$username);
11860: } elsif ($which eq '64bit4') {
11861: return &rndseed_CODE_64bit4($symb,$courseid,$domain,$username);
11862: } else {
11863: return &rndseed_CODE_64bit($symb,$courseid,$domain,$username);
11864: }
11865: } elsif ($which eq '64bit5') {
11866: return &rndseed_64bit5($symb,$courseid,$domain,$username);
11867: } elsif ($which eq '64bit4') {
11868: return &rndseed_64bit4($symb,$courseid,$domain,$username);
11869: } elsif ($which eq '64bit3') {
11870: return &rndseed_64bit3($symb,$courseid,$domain,$username);
11871: } elsif ($which eq '64bit2') {
11872: return &rndseed_64bit2($symb,$courseid,$domain,$username);
11873: } elsif ($which eq '64bit') {
11874: return &rndseed_64bit($symb,$courseid,$domain,$username);
11875: }
11876: return &rndseed_32bit($symb,$courseid,$domain,$username);
11877: }
11878:
11879: sub rndseed_32bit {
11880: my ($symb,$courseid,$domain,$username)=@_;
11881: {
11882: use integer;
11883: my $symbchck=unpack("%32C*",$symb) << 27;
11884: my $symbseed=numval($symb) << 22;
11885: my $namechck=unpack("%32C*",$username) << 17;
11886: my $nameseed=numval($username) << 12;
11887: my $domainseed=unpack("%32C*",$domain) << 7;
11888: my $courseseed=unpack("%32C*",$courseid);
11889: my $num=$symbseed+$nameseed+$domainseed+$courseseed+$namechck+$symbchck;
11890: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
11891: #&logthis("rndseed :$num:$symb");
11892: if ($_64bit) { $num=(($num<<32)>>32); }
11893: return $num;
11894: }
11895: }
11896:
11897: sub rndseed_64bit {
11898: my ($symb,$courseid,$domain,$username)=@_;
11899: {
11900: use integer;
11901: my $symbchck=unpack("%32S*",$symb) << 21;
11902: my $symbseed=numval($symb) << 10;
11903: my $namechck=unpack("%32S*",$username);
11904:
11905: my $nameseed=numval($username) << 21;
11906: my $domainseed=unpack("%32S*",$domain) << 10;
11907: my $courseseed=unpack("%32S*",$courseid);
11908:
11909: my $num1=$symbchck+$symbseed+$namechck;
11910: my $num2=$nameseed+$domainseed+$courseseed;
11911: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
11912: #&logthis("rndseed :$num:$symb");
11913: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
11914: return "$num1,$num2";
11915: }
11916: }
11917:
11918: sub rndseed_64bit2 {
11919: my ($symb,$courseid,$domain,$username)=@_;
11920: {
11921: use integer;
11922: # strings need to be an even # of cahracters long, it it is odd the
11923: # last characters gets thrown away
11924: my $symbchck=unpack("%32S*",$symb.' ') << 21;
11925: my $symbseed=numval($symb) << 10;
11926: my $namechck=unpack("%32S*",$username.' ');
11927:
11928: my $nameseed=numval($username) << 21;
11929: my $domainseed=unpack("%32S*",$domain.' ') << 10;
11930: my $courseseed=unpack("%32S*",$courseid.' ');
11931:
11932: my $num1=$symbchck+$symbseed+$namechck;
11933: my $num2=$nameseed+$domainseed+$courseseed;
11934: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
11935: #&logthis("rndseed :$num:$symb");
11936: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
11937: return "$num1,$num2";
11938: }
11939: }
11940:
11941: sub rndseed_64bit3 {
11942: my ($symb,$courseid,$domain,$username)=@_;
11943: {
11944: use integer;
11945: # strings need to be an even # of cahracters long, it it is odd the
11946: # last characters gets thrown away
11947: my $symbchck=unpack("%32S*",$symb.' ') << 21;
11948: my $symbseed=numval2($symb) << 10;
11949: my $namechck=unpack("%32S*",$username.' ');
11950:
11951: my $nameseed=numval2($username) << 21;
11952: my $domainseed=unpack("%32S*",$domain.' ') << 10;
11953: my $courseseed=unpack("%32S*",$courseid.' ');
11954:
11955: my $num1=$symbchck+$symbseed+$namechck;
11956: my $num2=$nameseed+$domainseed+$courseseed;
11957: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
11958: #&logthis("rndseed :$num1:$num2:$_64bit");
11959: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
11960:
11961: return "$num1:$num2";
11962: }
11963: }
11964:
11965: sub rndseed_64bit4 {
11966: my ($symb,$courseid,$domain,$username)=@_;
11967: {
11968: use integer;
11969: # strings need to be an even # of cahracters long, it it is odd the
11970: # last characters gets thrown away
11971: my $symbchck=unpack("%32S*",$symb.' ') << 21;
11972: my $symbseed=numval3($symb) << 10;
11973: my $namechck=unpack("%32S*",$username.' ');
11974:
11975: my $nameseed=numval3($username) << 21;
11976: my $domainseed=unpack("%32S*",$domain.' ') << 10;
11977: my $courseseed=unpack("%32S*",$courseid.' ');
11978:
11979: my $num1=$symbchck+$symbseed+$namechck;
11980: my $num2=$nameseed+$domainseed+$courseseed;
11981: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
11982: #&logthis("rndseed :$num1:$num2:$_64bit");
11983: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
11984:
11985: return "$num1:$num2";
11986: }
11987: }
11988:
11989: sub rndseed_64bit5 {
11990: my ($symb,$courseid,$domain,$username)=@_;
11991: my ($num1,$num2)=&digest("$symb,$courseid,$domain,$username");
11992: return "$num1:$num2";
11993: }
11994:
11995: sub rndseed_CODE_64bit {
11996: my ($symb,$courseid,$domain,$username)=@_;
11997: {
11998: use integer;
11999: my $symbchck=unpack("%32S*",$symb.' ') << 16;
12000: my $symbseed=numval2($symb);
12001: my $CODEchck=unpack("%32S*",&getCODE().' ') << 16;
12002: my $CODEseed=numval(&getCODE());
12003: my $courseseed=unpack("%32S*",$courseid.' ');
12004: my $num1=$symbseed+$CODEchck;
12005: my $num2=$CODEseed+$courseseed+$symbchck;
12006: #&logthis("$symbseed:$CODEchck|$CODEseed:$courseseed:$symbchck");
12007: #&logthis("rndseed :$num1:$num2:$symb");
12008: if ($_64bit) { $num1=(($num1<<32)>>32); }
12009: if ($_64bit) { $num2=(($num2<<32)>>32); }
12010: return "$num1:$num2";
12011: }
12012: }
12013:
12014: sub rndseed_CODE_64bit4 {
12015: my ($symb,$courseid,$domain,$username)=@_;
12016: {
12017: use integer;
12018: my $symbchck=unpack("%32S*",$symb.' ') << 16;
12019: my $symbseed=numval3($symb);
12020: my $CODEchck=unpack("%32S*",&getCODE().' ') << 16;
12021: my $CODEseed=numval3(&getCODE());
12022: my $courseseed=unpack("%32S*",$courseid.' ');
12023: my $num1=$symbseed+$CODEchck;
12024: my $num2=$CODEseed+$courseseed+$symbchck;
12025: #&logthis("$symbseed:$CODEchck|$CODEseed:$courseseed:$symbchck");
12026: #&logthis("rndseed :$num1:$num2:$symb");
12027: if ($_64bit) { $num1=(($num1<<32)>>32); }
12028: if ($_64bit) { $num2=(($num2<<32)>>32); }
12029: return "$num1:$num2";
12030: }
12031: }
12032:
12033: sub rndseed_CODE_64bit5 {
12034: my ($symb,$courseid,$domain,$username)=@_;
12035: my $code = &getCODE();
12036: my ($num1,$num2)=&digest("$symb,$courseid,$code");
12037: return "$num1:$num2";
12038: }
12039:
12040: sub setup_random_from_rndseed {
12041: my ($rndseed)=@_;
12042: if ($rndseed =~/([,:])/) {
12043: my ($num1,$num2) = map { abs($_); } (split(/[,:]/,$rndseed));
12044: if ((!$num1) || (!$num2) || ($num1 > 2147483562) || ($num2 > 2147483398)) {
12045: &Math::Random::random_set_seed_from_phrase($rndseed);
12046: } else {
12047: &Math::Random::random_set_seed($num1,$num2);
12048: }
12049: } else {
12050: &Math::Random::random_set_seed_from_phrase($rndseed);
12051: }
12052: }
12053:
12054: sub latest_receipt_algorithm_id {
12055: return 'receipt3';
12056: }
12057:
12058: sub recunique {
12059: my $fucourseid=shift;
12060: my $unique;
12061: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2' ||
12062: $env{"course.$fucourseid.receiptalg"} eq 'receipt3' ) {
12063: $unique=$env{"course.$fucourseid.internal.encseed"};
12064: } else {
12065: $unique=$perlvar{'lonReceipt'};
12066: }
12067: return unpack("%32C*",$unique);
12068: }
12069:
12070: sub recprefix {
12071: my $fucourseid=shift;
12072: my $prefix;
12073: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2'||
12074: $env{"course.$fucourseid.receiptalg"} eq 'receipt3' ) {
12075: $prefix=$env{"course.$fucourseid.internal.encpref"};
12076: } else {
12077: $prefix=$perlvar{'lonHostID'};
12078: }
12079: return unpack("%32C*",$prefix);
12080: }
12081:
12082: sub ireceipt {
12083: my ($funame,$fudom,$fucourseid,$fusymb,$part)=@_;
12084:
12085: my $return =&recprefix($fucourseid).'-';
12086:
12087: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt3' ||
12088: $env{'request.state'} eq 'construct') {
12089: $return .= (&digest("$funame,$fudom,$fucourseid,$fusymb,$part")%10000);
12090: return $return;
12091: }
12092:
12093: my $cuname=unpack("%32C*",$funame);
12094: my $cudom=unpack("%32C*",$fudom);
12095: my $cucourseid=unpack("%32C*",$fucourseid);
12096: my $cusymb=unpack("%32C*",$fusymb);
12097: my $cunique=&recunique($fucourseid);
12098: my $cpart=unpack("%32S*",$part);
12099: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2') {
12100:
12101: #&logthis("doing receipt2 using parts $cpart, uname $cuname and udom $cudom gets ".($cpart%$cuname)." and ".($cpart%$cudom));
12102:
12103: $return.= ($cunique%$cuname+
12104: $cunique%$cudom+
12105: $cusymb%$cuname+
12106: $cusymb%$cudom+
12107: $cucourseid%$cuname+
12108: $cucourseid%$cudom+
12109: $cpart%$cuname+
12110: $cpart%$cudom);
12111: } else {
12112: $return.= ($cunique%$cuname+
12113: $cunique%$cudom+
12114: $cusymb%$cuname+
12115: $cusymb%$cudom+
12116: $cucourseid%$cuname+
12117: $cucourseid%$cudom);
12118: }
12119: return $return;
12120: }
12121:
12122: sub receipt {
12123: my ($part)=@_;
12124: my ($symb,$courseid,$domain,$name) = &whichuser();
12125: return &ireceipt($name,$domain,$courseid,$symb,$part);
12126: }
12127:
12128: sub whichuser {
12129: my ($passedsymb)=@_;
12130: my ($symb,$courseid,$domain,$name,$publicuser);
12131: if (defined($env{'form.grade_symb'})) {
12132: my ($tmp_courseid)=&get_env_multiple('form.grade_courseid');
12133: my $allowed=&allowed('vgr',$tmp_courseid);
12134: if (!$allowed &&
12135: exists($env{'request.course.sec'}) &&
12136: $env{'request.course.sec'} !~ /^\s*$/) {
12137: $allowed=&allowed('vgr',$tmp_courseid.
12138: '/'.$env{'request.course.sec'});
12139: }
12140: if ($allowed) {
12141: ($symb)=&get_env_multiple('form.grade_symb');
12142: $courseid=$tmp_courseid;
12143: ($domain)=&get_env_multiple('form.grade_domain');
12144: ($name)=&get_env_multiple('form.grade_username');
12145: return ($symb,$courseid,$domain,$name,$publicuser);
12146: }
12147: }
12148: if (!$passedsymb) {
12149: $symb=&symbread();
12150: } else {
12151: $symb=$passedsymb;
12152: }
12153: $courseid=$env{'request.course.id'};
12154: $domain=$env{'user.domain'};
12155: $name=$env{'user.name'};
12156: if ($name eq 'public' && $domain eq 'public') {
12157: if (!defined($env{'form.username'})) {
12158: $env{'form.username'}.=time.rand(10000000);
12159: }
12160: $name.=$env{'form.username'};
12161: }
12162: return ($symb,$courseid,$domain,$name,$publicuser);
12163:
12164: }
12165:
12166: # ------------------------------------------------------------ Serves up a file
12167: # returns either the contents of the file or
12168: # -1 if the file doesn't exist
12169: #
12170: # if the target is a file that was uploaded via DOCS,
12171: # a check will be made to see if a current copy exists on the local server,
12172: # if it does this will be served, otherwise a copy will be retrieved from
12173: # the home server for the course and stored in /home/httpd/html/userfiles on
12174: # the local server.
12175:
12176: sub getfile {
12177: my ($file) = @_;
12178: if ($file =~ m -^/*(uploaded|editupload)/-) { $file=&filelocation("",$file); }
12179: &repcopy($file);
12180: return &readfile($file);
12181: }
12182:
12183: sub repcopy_userfile {
12184: my ($file)=@_;
12185: my $londocroot = $perlvar{'lonDocRoot'};
12186: if ($file =~ m{^/*(uploaded|editupload)/}) { $file=&filelocation("",$file); }
12187: if ($file =~ m{^\Q/home/httpd/lonUsers/\E}) { return 'ok'; }
12188: my ($cdom,$cnum,$filename) =
12189: ($file=~m|^\Q$perlvar{'lonDocRoot'}\E/+userfiles/+($match_domain)/+($match_name)/+(.*)|);
12190: my $uri="/uploaded/$cdom/$cnum/$filename";
12191: if (-e "$file") {
12192: # we already have a local copy, check it out
12193: my @fileinfo = stat($file);
12194: my $rtncode;
12195: my $info;
12196: my $lwpresp = &getuploaded('HEAD',$uri,$cdom,$cnum,\$info,\$rtncode);
12197: if ($lwpresp ne 'ok') {
12198: # there is no such file anymore, even though we had a local copy
12199: if ($rtncode eq '404') {
12200: unlink($file);
12201: }
12202: return -1;
12203: }
12204: if ($info < $fileinfo[9]) {
12205: # nice, the file we have is up-to-date, just say okay
12206: return 'ok';
12207: } else {
12208: # the file is outdated, get rid of it
12209: unlink($file);
12210: }
12211: }
12212: # one way or the other, at this point, we don't have the file
12213: # construct the correct path for the file
12214: my @parts = ($cdom,$cnum);
12215: if ($filename =~ m|^(.+)/[^/]+$|) {
12216: push @parts, split(/\//,$1);
12217: }
12218: my $path = $perlvar{'lonDocRoot'}.'/userfiles';
12219: foreach my $part (@parts) {
12220: $path .= '/'.$part;
12221: if (!-e $path) {
12222: mkdir($path,0770);
12223: }
12224: }
12225: # now the path exists for sure
12226: # get a user agent
12227: my $ua=new LWP::UserAgent;
12228: my $transferfile=$file.'.in.transfer';
12229: # FIXME: this should flock
12230: if (-e $transferfile) { return 'ok'; }
12231: my $request;
12232: $uri=~s/^\///;
12233: my $homeserver = &homeserver($cnum,$cdom);
12234: my $protocol = $protocol{$homeserver};
12235: $protocol = 'http' if ($protocol ne 'https');
12236: $request=new HTTP::Request('GET',$protocol.'://'.&hostname($homeserver).'/raw/'.$uri);
12237: my $response=$ua->request($request,$transferfile);
12238: # did it work?
12239: if ($response->is_error()) {
12240: unlink($transferfile);
12241: &logthis("Userfile repcopy failed for $uri");
12242: return -1;
12243: }
12244: # worked, rename the transfer file
12245: rename($transferfile,$file);
12246: return 'ok';
12247: }
12248:
12249: sub tokenwrapper {
12250: my $uri=shift;
12251: $uri=~s|^https?\://([^/]+)||;
12252: $uri=~s|^/||;
12253: $env{'user.environment'}=~/\/([^\/]+)\.id/;
12254: my $token=$1;
12255: my (undef,$udom,$uname,$file)=split('/',$uri,4);
12256: if ($udom && $uname && $file) {
12257: $file=~s|(\?\.*)*$||;
12258: &appenv({"userfile.$udom/$uname/$file" => $env{'request.course.id'}});
12259: my $homeserver = &homeserver($uname,$udom);
12260: my $protocol = $protocol{$homeserver};
12261: $protocol = 'http' if ($protocol ne 'https');
12262: return $protocol.'://'.&hostname($homeserver).'/'.$uri.
12263: (($uri=~/\?/)?'&':'?').'token='.$token.
12264: '&tokenissued='.$perlvar{'lonHostID'};
12265: } else {
12266: return '/adm/notfound.html';
12267: }
12268: }
12269:
12270: # call with reqtype HEAD: get last modification time
12271: # call with reqtype GET: get the file contents
12272: # Do not call this with reqtype GET for large files! It loads everything into memory
12273: #
12274: sub getuploaded {
12275: my ($reqtype,$uri,$cdom,$cnum,$info,$rtncode) = @_;
12276: $uri=~s/^\///;
12277: my $homeserver = &homeserver($cnum,$cdom);
12278: my $protocol = $protocol{$homeserver};
12279: $protocol = 'http' if ($protocol ne 'https');
12280: $uri = $protocol.'://'.&hostname($homeserver).'/raw/'.$uri;
12281: my $ua=new LWP::UserAgent;
12282: my $request=new HTTP::Request($reqtype,$uri);
12283: my $response=$ua->request($request);
12284: $$rtncode = $response->code;
12285: if (! $response->is_success()) {
12286: return 'failed';
12287: }
12288: if ($reqtype eq 'HEAD') {
12289: $$info = &HTTP::Date::str2time( $response->header('Last-modified') );
12290: } elsif ($reqtype eq 'GET') {
12291: $$info = $response->content;
12292: }
12293: return 'ok';
12294: }
12295:
12296: sub readfile {
12297: my $file = shift;
12298: if ( (! -e $file ) || ($file eq '') ) { return -1; };
12299: my $fh;
12300: open($fh,"<$file");
12301: my $a='';
12302: while (my $line = <$fh>) { $a .= $line; }
12303: return $a;
12304: }
12305:
12306: sub filelocation {
12307: my ($dir,$file) = @_;
12308: my $location;
12309: $file=~ s/^\s*(\S+)\s*$/$1/; ## strip off leading and trailing spaces
12310:
12311: if ($file =~ m-^/adm/-) {
12312: $file=~s-^/adm/wrapper/-/-;
12313: $file=~s-^/adm/coursedocs/showdoc/-/-;
12314: }
12315:
12316: if ($file =~ m-^\Q$Apache::lonnet::perlvar{'lonTabDir'}\E/-) {
12317: $location = $file;
12318: } elsif ($file=~/^\/*(uploaded|editupload)/) { # is an uploaded file
12319: my ($udom,$uname,$filename)=
12320: ($file=~m -^/+(?:uploaded|editupload)/+($match_domain)/+($match_name)/+(.*)$-);
12321: my $home=&homeserver($uname,$udom);
12322: my $is_me=0;
12323: my @ids=¤t_machine_ids();
12324: foreach my $id (@ids) { if ($id eq $home) { $is_me=1; } }
12325: if ($is_me) {
12326: $location=propath($udom,$uname).'/userfiles/'.$filename;
12327: } else {
12328: $location=$Apache::lonnet::perlvar{'lonDocRoot'}.'/userfiles/'.
12329: $udom.'/'.$uname.'/'.$filename;
12330: }
12331: } elsif ($file =~ m-^/adm/-) {
12332: $location = $perlvar{'lonDocRoot'}.'/'.$file;
12333: } else {
12334: $file=~s/^\Q$perlvar{'lonDocRoot'}\E//;
12335: $file=~s:^/(res|priv)/:/:;
12336: my $space=$1;
12337: if ( !( $file =~ m:^/:) ) {
12338: $location = $dir. '/'.$file;
12339: } else {
12340: $location = $perlvar{'lonDocRoot'}.'/'.$space.$file;
12341: }
12342: }
12343: $location=~s://+:/:g; # remove duplicate /
12344: while ($location=~m{/\.\./}) {
12345: if ($location =~ m{/[^/]+/\.\./}) {
12346: $location=~ s{/[^/]+/\.\./}{/}g;
12347: } else {
12348: $location=~ s{/\.\./}{/}g;
12349: }
12350: } #remove dir/..
12351: while ($location=~m:/\./:) {$location=~ s:/\./:/:g;} #remove /./
12352: return $location;
12353: }
12354:
12355: sub hreflocation {
12356: my ($dir,$file)=@_;
12357: unless (($file=~m-^https?\://-i) || ($file=~m-^/-)) {
12358: $file=filelocation($dir,$file);
12359: } elsif ($file=~m-^/adm/-) {
12360: $file=~s-^/adm/wrapper/-/-;
12361: $file=~s-^/adm/coursedocs/showdoc/-/-;
12362: }
12363: if ($file=~m-^\Q$perlvar{'lonDocRoot'}\E-) {
12364: $file=~s-^\Q$perlvar{'lonDocRoot'}\E--;
12365: } elsif ($file=~m-^\Q$perlvar{'lonUsersDir'}\E-) {
12366: $file=~s{^/home/httpd/lonUsers/($match_domain)/./././($match_name)/userfiles/}
12367: {/uploaded/$1/$2/}x;
12368: }
12369: if ($file=~ m{^/userfiles/}) {
12370: $file =~ s{^/userfiles/}{/uploaded/};
12371: }
12372: return $file;
12373: }
12374:
12375:
12376:
12377:
12378:
12379: sub current_machine_domains {
12380: return &machine_domains(&hostname($perlvar{'lonHostID'}));
12381: }
12382:
12383: sub machine_domains {
12384: my ($hostname) = @_;
12385: my @domains;
12386: my %hostname = &all_hostnames();
12387: while( my($id, $name) = each(%hostname)) {
12388: # &logthis("-$id-$name-$hostname-");
12389: if ($hostname eq $name) {
12390: push(@domains,&host_domain($id));
12391: }
12392: }
12393: return @domains;
12394: }
12395:
12396: sub current_machine_ids {
12397: return &machine_ids(&hostname($perlvar{'lonHostID'}));
12398: }
12399:
12400: sub machine_ids {
12401: my ($hostname) = @_;
12402: $hostname ||= &hostname($perlvar{'lonHostID'});
12403: my @ids;
12404: my %name_to_host = &all_names();
12405: if (ref($name_to_host{$hostname}) eq 'ARRAY') {
12406: return @{ $name_to_host{$hostname} };
12407: }
12408: return;
12409: }
12410:
12411: sub additional_machine_domains {
12412: my @domains;
12413: open(my $fh,"<$perlvar{'lonTabDir'}/expected_domains.tab");
12414: while( my $line = <$fh>) {
12415: $line =~ s/\s//g;
12416: push(@domains,$line);
12417: }
12418: return @domains;
12419: }
12420:
12421: sub default_login_domain {
12422: my $domain = $perlvar{'lonDefDomain'};
12423: my $testdomain=(split(/\./,$ENV{'HTTP_HOST'}))[0];
12424: foreach my $posdom (¤t_machine_domains(),
12425: &additional_machine_domains()) {
12426: if (lc($posdom) eq lc($testdomain)) {
12427: $domain=$posdom;
12428: last;
12429: }
12430: }
12431: return $domain;
12432: }
12433:
12434: # ------------------------------------------------------------- Declutters URLs
12435:
12436: sub declutter {
12437: my $thisfn=shift;
12438: if ($thisfn=~m|^/enc/|) { $thisfn=&Apache::lonenc::unencrypted($thisfn); }
12439: unless ($thisfn=~m{^/home/httpd/html/priv/}) {
12440: $thisfn=~s{^/home/httpd/html}{};
12441: }
12442: $thisfn=~s/^\///;
12443: $thisfn=~s|^adm/wrapper/||;
12444: $thisfn=~s|^adm/coursedocs/showdoc/||;
12445: $thisfn=~s/^res\///;
12446: $thisfn=~s/^priv\///;
12447: unless (($thisfn =~ /^ext/) || ($thisfn =~ /\.(page|sequence)___\d+___ext/)) {
12448: $thisfn=~s/\?.+$//;
12449: }
12450: return $thisfn;
12451: }
12452:
12453: # ------------------------------------------------------------- Clutter up URLs
12454:
12455: sub clutter {
12456: my $thisfn='/'.&declutter(shift);
12457: if ($thisfn !~ m{^/(uploaded|editupload|adm|userfiles|ext|raw|priv|public)/}
12458: || $thisfn =~ m{^/adm/(includes|pages)} ) {
12459: $thisfn='/res'.$thisfn;
12460: }
12461: if ($thisfn !~m|^/adm|) {
12462: if ($thisfn =~ m|^/ext/|) {
12463: $thisfn='/adm/wrapper'.$thisfn;
12464: } else {
12465: my ($ext) = ($thisfn =~ /\.(\w+)$/);
12466: my $embstyle=&Apache::loncommon::fileembstyle($ext);
12467: if ($embstyle eq 'ssi'
12468: || ($embstyle eq 'hdn')
12469: || ($embstyle eq 'rat')
12470: || ($embstyle eq 'prv')
12471: || ($embstyle eq 'ign')) {
12472: #do nothing with these
12473: } elsif (($embstyle eq 'img')
12474: || ($embstyle eq 'emb')
12475: || ($embstyle eq 'wrp')) {
12476: $thisfn='/adm/wrapper'.$thisfn;
12477: } elsif ($embstyle eq 'unk'
12478: && $thisfn!~/\.(sequence|page)$/) {
12479: $thisfn='/adm/coursedocs/showdoc'.$thisfn;
12480: } else {
12481: # &logthis("Got a blank emb style");
12482: }
12483: }
12484: } elsif ($thisfn =~ m{^/adm/$match_domain/$match_courseid/\d+/exttools?$}) {
12485: $thisfn='/adm/wrapper'.$thisfn;
12486: }
12487: return $thisfn;
12488: }
12489:
12490: sub clutter_with_no_wrapper {
12491: my $uri = &clutter(shift);
12492: if ($uri =~ m-^/adm/-) {
12493: $uri =~ s-^/adm/wrapper/-/-;
12494: $uri =~ s-^/adm/coursedocs/showdoc/-/-;
12495: }
12496: return $uri;
12497: }
12498:
12499: sub freeze_escape {
12500: my ($value)=@_;
12501: if (ref($value)) {
12502: $value=&nfreeze($value);
12503: return '__FROZEN__'.&escape($value);
12504: }
12505: return &escape($value);
12506: }
12507:
12508:
12509: sub thaw_unescape {
12510: my ($value)=@_;
12511: if ($value =~ /^__FROZEN__/) {
12512: substr($value,0,10,undef);
12513: $value=&unescape($value);
12514: return &thaw($value);
12515: }
12516: return &unescape($value);
12517: }
12518:
12519: sub correct_line_ends {
12520: my ($result)=@_;
12521: $$result =~s/\r\n/\n/mg;
12522: $$result =~s/\r/\n/mg;
12523: }
12524: # ================================================================ Main Program
12525:
12526: sub goodbye {
12527: &logthis("Starting Shut down");
12528: #not converted to using infrastruture and probably shouldn't be
12529: &logthis(sprintf("%-20s is %s",'%badServerCache',length(&nfreeze(\%badServerCache))));
12530: #converted
12531: # &logthis(sprintf("%-20s is %s",'%metacache',scalar(%metacache)));
12532: &logthis(sprintf("%-20s is %s",'%homecache',length(&nfreeze(\%homecache))));
12533: # &logthis(sprintf("%-20s is %s",'%titlecache',length(&nfreeze(\%titlecache))));
12534: # &logthis(sprintf("%-20s is %s",'%courseresdatacache',length(&nfreeze(\%courseresdatacache))));
12535: #1.1 only
12536: # &logthis(sprintf("%-20s is %s",'%userresdatacache',length(&nfreeze(\%userresdatacache))));
12537: # &logthis(sprintf("%-20s is %s",'%getsectioncache',length(&nfreeze(\%getsectioncache))));
12538: # &logthis(sprintf("%-20s is %s",'%courseresversioncache',length(&nfreeze(\%courseresversioncache))));
12539: # &logthis(sprintf("%-20s is %s",'%resversioncache',length(&nfreeze(\%resversioncache))));
12540: &logthis(sprintf("%-20s is %s",'%remembered',length(&nfreeze(\%remembered))));
12541: &logthis(sprintf("%-20s is %s",'kicks',$kicks));
12542: &logthis(sprintf("%-20s is %s",'hits',$hits));
12543: &flushcourselogs();
12544: &logthis("Shutting down");
12545: }
12546:
12547: sub get_dns {
12548: my ($url,$func,$ignore_cache,$nocache,$hashref) = @_;
12549: if (!$ignore_cache) {
12550: my ($content,$cached)=
12551: &Apache::lonnet::is_cached_new('dns',$url);
12552: if ($cached) {
12553: &$func($content,$hashref);
12554: return;
12555: }
12556: }
12557:
12558: my %alldns;
12559: open(my $config,"<$perlvar{'lonTabDir'}/hosts.tab");
12560: foreach my $dns (<$config>) {
12561: next if ($dns !~ /^\^(\S*)/x);
12562: my $line = $1;
12563: my ($host,$protocol) = split(/:/,$line);
12564: if ($protocol ne 'https') {
12565: $protocol = 'http';
12566: }
12567: $alldns{$host} = $protocol;
12568: }
12569: while (%alldns) {
12570: my ($dns) = sort { $b cmp $a } keys(%alldns);
12571: my $ua=new LWP::UserAgent;
12572: $ua->timeout(30);
12573: my $request=new HTTP::Request('GET',"$alldns{$dns}://$dns$url");
12574: my $response=$ua->request($request);
12575: delete($alldns{$dns});
12576: next if ($response->is_error());
12577: my @content = split("\n",$response->content);
12578: unless ($nocache) {
12579: &do_cache_new('dns',$url,\@content,30*24*60*60);
12580: }
12581: &$func(\@content,$hashref);
12582: return;
12583: }
12584: close($config);
12585: my $which = (split('/',$url))[3];
12586: &logthis("unable to contact DNS defaulting to on disk file dns_$which.tab\n");
12587: open($config,"<$perlvar{'lonTabDir'}/dns_$which.tab");
12588: my @content = <$config>;
12589: &$func(\@content,$hashref);
12590: return;
12591: }
12592:
12593: # ------------------------------------------------------Get DNS checksums file
12594: sub parse_dns_checksums_tab {
12595: my ($lines,$hashref) = @_;
12596: my $lonhost = $perlvar{'lonHostID'};
12597: my $machine_dom = &Apache::lonnet::host_domain($lonhost);
12598: my $loncaparev = &get_server_loncaparev($machine_dom);
12599: my $distro = (split(/\:/,&get_server_distarch($lonhost)))[0];
12600: my $webconfdir = '/etc/httpd/conf';
12601: if ($distro =~ /^(ubuntu|debian)(\d+)$/) {
12602: $webconfdir = '/etc/apache2';
12603: } elsif ($distro =~ /^sles(\d+)$/) {
12604: if ($1 >= 10) {
12605: $webconfdir = '/etc/apache2';
12606: }
12607: } elsif ($distro =~ /^suse(\d+\.\d+)$/) {
12608: if ($1 >= 10.0) {
12609: $webconfdir = '/etc/apache2';
12610: }
12611: }
12612: my ($release,$timestamp) = split(/\-/,$loncaparev);
12613: my (%chksum,%revnum);
12614: if (ref($lines) eq 'ARRAY') {
12615: chomp(@{$lines});
12616: my $version = shift(@{$lines});
12617: if ($version eq $release) {
12618: foreach my $line (@{$lines}) {
12619: my ($file,$version,$shasum) = split(/,/,$line);
12620: if ($file =~ m{^/etc/httpd/conf}) {
12621: if ($webconfdir eq '/etc/apache2') {
12622: $file =~ s{^\Q/etc/httpd/conf/\E}{$webconfdir/};
12623: }
12624: }
12625: $chksum{$file} = $shasum;
12626: $revnum{$file} = $version;
12627: }
12628: if (ref($hashref) eq 'HASH') {
12629: %{$hashref} = (
12630: sums => \%chksum,
12631: versions => \%revnum,
12632: );
12633: }
12634: }
12635: }
12636: return;
12637: }
12638:
12639: sub fetch_dns_checksums {
12640: my %checksums;
12641: my $machine_dom = &Apache::lonnet::host_domain($perlvar{'lonHostID'});
12642: my $loncaparev = &get_server_loncaparev($machine_dom,$perlvar{'lonHostID'});
12643: my ($release,$timestamp) = split(/\-/,$loncaparev);
12644: &get_dns("/adm/dns/checksums/$release",\&parse_dns_checksums_tab,1,1,
12645: \%checksums);
12646: return \%checksums;
12647: }
12648:
12649: # ------------------------------------------------------------ Read domain file
12650: {
12651: my $loaded;
12652: my %domain;
12653:
12654: sub parse_domain_tab {
12655: my ($lines) = @_;
12656: foreach my $line (@$lines) {
12657: next if ($line =~ /^(\#|\s*$ )/x);
12658:
12659: chomp($line);
12660: my ($name,@elements) = split(/:/,$line,9);
12661: my %this_domain;
12662: foreach my $field ('description', 'auth_def', 'auth_arg_def',
12663: 'lang_def', 'city', 'longi', 'lati',
12664: 'primary') {
12665: $this_domain{$field} = shift(@elements);
12666: }
12667: $domain{$name} = \%this_domain;
12668: }
12669: }
12670:
12671: sub reset_domain_info {
12672: undef($loaded);
12673: undef(%domain);
12674: }
12675:
12676: sub load_domain_tab {
12677: my ($ignore_cache,$nocache) = @_;
12678: &get_dns('/adm/dns/domain',\&parse_domain_tab,$ignore_cache,$nocache);
12679: my $fh;
12680: if (open($fh,"<".$perlvar{'lonTabDir'}.'/domain.tab')) {
12681: my @lines = <$fh>;
12682: &parse_domain_tab(\@lines);
12683: }
12684: close($fh);
12685: $loaded = 1;
12686: }
12687:
12688: sub domain {
12689: &load_domain_tab() if (!$loaded);
12690:
12691: my ($name,$what) = @_;
12692: return if ( !exists($domain{$name}) );
12693:
12694: if (!$what) {
12695: return $domain{$name}{'description'};
12696: }
12697: return $domain{$name}{$what};
12698: }
12699:
12700: sub domain_info {
12701: &load_domain_tab() if (!$loaded);
12702: return %domain;
12703: }
12704:
12705: }
12706:
12707:
12708: # ------------------------------------------------------------- Read hosts file
12709: {
12710: my %hostname;
12711: my %hostdom;
12712: my %libserv;
12713: my $loaded;
12714: my %name_to_host;
12715: my %internetdom;
12716: my %LC_dns_serv;
12717:
12718: sub parse_hosts_tab {
12719: my ($file) = @_;
12720: foreach my $configline (@$file) {
12721: next if ($configline =~ /^(\#|\s*$ )/x);
12722: chomp($configline);
12723: if ($configline =~ /^\^/) {
12724: if ($configline =~ /^\^([\w.\-]+)/) {
12725: $LC_dns_serv{$1} = 1;
12726: }
12727: next;
12728: }
12729: my ($id,$domain,$role,$name,$protocol,$intdom)=split(/:/,$configline);
12730: $name=~s/\s//g;
12731: if ($id && $domain && $role && $name) {
12732: $hostname{$id}=$name;
12733: push(@{$name_to_host{$name}}, $id);
12734: $hostdom{$id}=$domain;
12735: if ($role eq 'library') { $libserv{$id}=$name; }
12736: if (defined($protocol)) {
12737: if ($protocol eq 'https') {
12738: $protocol{$id} = $protocol;
12739: } else {
12740: $protocol{$id} = 'http';
12741: }
12742: } else {
12743: $protocol{$id} = 'http';
12744: }
12745: if (defined($intdom)) {
12746: $internetdom{$id} = $intdom;
12747: }
12748: }
12749: }
12750: }
12751:
12752: sub reset_hosts_info {
12753: &purge_remembered();
12754: &reset_domain_info();
12755: &reset_hosts_ip_info();
12756: undef(%name_to_host);
12757: undef(%hostname);
12758: undef(%hostdom);
12759: undef(%libserv);
12760: undef($loaded);
12761: }
12762:
12763: sub load_hosts_tab {
12764: my ($ignore_cache,$nocache) = @_;
12765: &get_dns('/adm/dns/hosts',\&parse_hosts_tab,$ignore_cache,$nocache);
12766: open(my $config,"<$perlvar{'lonTabDir'}/hosts.tab");
12767: my @config = <$config>;
12768: &parse_hosts_tab(\@config);
12769: close($config);
12770: $loaded=1;
12771: }
12772:
12773: sub hostname {
12774: &load_hosts_tab() if (!$loaded);
12775:
12776: my ($lonid) = @_;
12777: return $hostname{$lonid};
12778: }
12779:
12780: sub all_hostnames {
12781: &load_hosts_tab() if (!$loaded);
12782:
12783: return %hostname;
12784: }
12785:
12786: sub all_names {
12787: my ($ignore_cache,$nocache) = @_;
12788: &load_hosts_tab($ignore_cache,$nocache) if (!$loaded);
12789:
12790: return %name_to_host;
12791: }
12792:
12793: sub all_host_domain {
12794: &load_hosts_tab() if (!$loaded);
12795: return %hostdom;
12796: }
12797:
12798: sub is_library {
12799: &load_hosts_tab() if (!$loaded);
12800:
12801: return exists($libserv{$_[0]});
12802: }
12803:
12804: sub all_library {
12805: &load_hosts_tab() if (!$loaded);
12806:
12807: return %libserv;
12808: }
12809:
12810: sub unique_library {
12811: #2x reverse removes all hostnames that appear more than once
12812: my %unique = reverse &all_library();
12813: return reverse %unique;
12814: }
12815:
12816: sub get_servers {
12817: &load_hosts_tab() if (!$loaded);
12818:
12819: my ($domain,$type) = @_;
12820: my %possible_hosts = ($type eq 'library') ? %libserv
12821: : %hostname;
12822: my %result;
12823: if (ref($domain) eq 'ARRAY') {
12824: while ( my ($host,$hostname) = each(%possible_hosts)) {
12825: if (grep(/^\Q$hostdom{$host}\E$/,@$domain)) {
12826: $result{$host} = $hostname;
12827: }
12828: }
12829: } else {
12830: while ( my ($host,$hostname) = each(%possible_hosts)) {
12831: if ($hostdom{$host} eq $domain) {
12832: $result{$host} = $hostname;
12833: }
12834: }
12835: }
12836: return %result;
12837: }
12838:
12839: sub get_unique_servers {
12840: my %unique = reverse &get_servers(@_);
12841: return reverse %unique;
12842: }
12843:
12844: sub host_domain {
12845: &load_hosts_tab() if (!$loaded);
12846:
12847: my ($lonid) = @_;
12848: return $hostdom{$lonid};
12849: }
12850:
12851: sub all_domains {
12852: &load_hosts_tab() if (!$loaded);
12853:
12854: my %seen;
12855: my @uniq = grep(!$seen{$_}++, values(%hostdom));
12856: return @uniq;
12857: }
12858:
12859: sub internet_dom {
12860: &load_hosts_tab() if (!$loaded);
12861:
12862: my ($lonid) = @_;
12863: return $internetdom{$lonid};
12864: }
12865:
12866: sub is_LC_dns {
12867: &load_hosts_tab() if (!$loaded);
12868:
12869: my ($hostname) = @_;
12870: return exists($LC_dns_serv{$hostname});
12871: }
12872:
12873: }
12874:
12875: {
12876: my %iphost;
12877: my %name_to_ip;
12878: my %lonid_to_ip;
12879:
12880: sub get_hosts_from_ip {
12881: my ($ip) = @_;
12882: my %iphosts = &get_iphost();
12883: if (ref($iphosts{$ip})) {
12884: return @{$iphosts{$ip}};
12885: }
12886: return;
12887: }
12888:
12889: sub reset_hosts_ip_info {
12890: undef(%iphost);
12891: undef(%name_to_ip);
12892: undef(%lonid_to_ip);
12893: }
12894:
12895: sub get_host_ip {
12896: my ($lonid) = @_;
12897: if (exists($lonid_to_ip{$lonid})) {
12898: return $lonid_to_ip{$lonid};
12899: }
12900: my $name=&hostname($lonid);
12901: my $ip = gethostbyname($name);
12902: return if (!$ip || length($ip) ne 4);
12903: $ip=inet_ntoa($ip);
12904: $name_to_ip{$name} = $ip;
12905: $lonid_to_ip{$lonid} = $ip;
12906: return $ip;
12907: }
12908:
12909: sub get_iphost {
12910: my ($ignore_cache,$nocache) = @_;
12911:
12912: if (!$ignore_cache) {
12913: if (%iphost) {
12914: return %iphost;
12915: }
12916: my ($ip_info,$cached)=
12917: &Apache::lonnet::is_cached_new('iphost','iphost');
12918: if ($cached) {
12919: %iphost = %{$ip_info->[0]};
12920: %name_to_ip = %{$ip_info->[1]};
12921: %lonid_to_ip = %{$ip_info->[2]};
12922: return %iphost;
12923: }
12924: }
12925:
12926: # get yesterday's info for fallback
12927: my %old_name_to_ip;
12928: my ($ip_info,$cached)=
12929: &Apache::lonnet::is_cached_new('iphost','iphost');
12930: if ($cached) {
12931: %old_name_to_ip = %{$ip_info->[1]};
12932: }
12933:
12934: my %name_to_host = &all_names($ignore_cache,$nocache);
12935: foreach my $name (keys(%name_to_host)) {
12936: my $ip;
12937: if (!exists($name_to_ip{$name})) {
12938: $ip = gethostbyname($name);
12939: if (!$ip || length($ip) ne 4) {
12940: if (defined($old_name_to_ip{$name})) {
12941: $ip = $old_name_to_ip{$name};
12942: &logthis("Can't find $name defaulting to old $ip");
12943: } else {
12944: &logthis("Name $name no IP found");
12945: next;
12946: }
12947: } else {
12948: $ip=inet_ntoa($ip);
12949: }
12950: $name_to_ip{$name} = $ip;
12951: } else {
12952: $ip = $name_to_ip{$name};
12953: }
12954: foreach my $id (@{ $name_to_host{$name} }) {
12955: $lonid_to_ip{$id} = $ip;
12956: }
12957: push(@{$iphost{$ip}},@{$name_to_host{$name}});
12958: }
12959: unless ($nocache) {
12960: &do_cache_new('iphost','iphost',
12961: [\%iphost,\%name_to_ip,\%lonid_to_ip],
12962: 48*60*60);
12963: }
12964:
12965: return %iphost;
12966: }
12967:
12968: #
12969: # Given a DNS returns the loncapa host name for that DNS
12970: #
12971: sub host_from_dns {
12972: my ($dns) = @_;
12973: my @hosts;
12974: my $ip;
12975:
12976: if (exists($name_to_ip{$dns})) {
12977: $ip = $name_to_ip{$dns};
12978: }
12979: if (!$ip) {
12980: $ip = gethostbyname($dns); # Initial translation to IP is in net order.
12981: if (length($ip) == 4) {
12982: $ip = &IO::Socket::inet_ntoa($ip);
12983: }
12984: }
12985: if ($ip) {
12986: @hosts = get_hosts_from_ip($ip);
12987: return $hosts[0];
12988: }
12989: return undef;
12990: }
12991:
12992: sub get_internet_names {
12993: my ($lonid) = @_;
12994: return if ($lonid eq '');
12995: my ($idnref,$cached)=
12996: &Apache::lonnet::is_cached_new('internetnames',$lonid);
12997: if ($cached) {
12998: return $idnref;
12999: }
13000: my $ip = &get_host_ip($lonid);
13001: my @hosts = &get_hosts_from_ip($ip);
13002: my %iphost = &get_iphost();
13003: my (@idns,%seen);
13004: foreach my $id (@hosts) {
13005: my $dom = &host_domain($id);
13006: my $prim_id = &domain($dom,'primary');
13007: my $prim_ip = &get_host_ip($prim_id);
13008: next if ($seen{$prim_ip});
13009: if (ref($iphost{$prim_ip}) eq 'ARRAY') {
13010: foreach my $id (@{$iphost{$prim_ip}}) {
13011: my $intdom = &internet_dom($id);
13012: unless (grep(/^\Q$intdom\E$/,@idns)) {
13013: push(@idns,$intdom);
13014: }
13015: }
13016: }
13017: $seen{$prim_ip} = 1;
13018: }
13019: return &do_cache_new('internetnames',$lonid,\@idns,12*60*60);
13020: }
13021:
13022: }
13023:
13024: sub all_loncaparevs {
13025: return qw(1.1 1.2 1.3 2.0 2.1 2.2 2.3 2.4 2.5 2.6 2.7 2.8 2.9 2.10 2.11);
13026: }
13027:
13028: # ---------------------------------------------------------- Read loncaparev table
13029: {
13030: sub load_loncaparevs {
13031: if (-e "$perlvar{'lonTabDir'}/loncaparevs.tab") {
13032: if (open(my $config,"<$perlvar{'lonTabDir'}/loncaparevs.tab")) {
13033: while (my $configline=<$config>) {
13034: chomp($configline);
13035: my ($hostid,$loncaparev)=split(/:/,$configline);
13036: $loncaparevs{$hostid}=$loncaparev;
13037: }
13038: close($config);
13039: }
13040: }
13041: }
13042: }
13043:
13044: # ---------------------------------------------------------- Read serverhostID table
13045: {
13046: sub load_serverhomeIDs {
13047: if (-e "$perlvar{'lonTabDir'}/serverhomeIDs.tab") {
13048: if (open(my $config,"<$perlvar{'lonTabDir'}/serverhomeIDs.tab")) {
13049: while (my $configline=<$config>) {
13050: chomp($configline);
13051: my ($name,$id)=split(/:/,$configline);
13052: $serverhomeIDs{$name}=$id;
13053: }
13054: close($config);
13055: }
13056: }
13057: }
13058: }
13059:
13060:
13061: BEGIN {
13062:
13063: # ----------------------------------- Read loncapa.conf and loncapa_apache.conf
13064: unless ($readit) {
13065: {
13066: my $configvars = LONCAPA::Configuration::read_conf('loncapa.conf');
13067: %perlvar = (%perlvar,%{$configvars});
13068: }
13069:
13070:
13071: # ------------------------------------------------------ Read spare server file
13072: {
13073: open(my $config,"<$perlvar{'lonTabDir'}/spare.tab");
13074:
13075: while (my $configline=<$config>) {
13076: chomp($configline);
13077: if ($configline) {
13078: my ($host,$type) = split(':',$configline,2);
13079: if (!defined($type) || $type eq '') { $type = 'default' };
13080: push(@{ $spareid{$type} }, $host);
13081: }
13082: }
13083: close($config);
13084: }
13085: # ------------------------------------------------------------ Read permissions
13086: {
13087: open(my $config,"<$perlvar{'lonTabDir'}/roles.tab");
13088:
13089: while (my $configline=<$config>) {
13090: chomp($configline);
13091: if ($configline) {
13092: my ($role,$perm)=split(/ /,$configline);
13093: if ($perm ne '') { $pr{$role}=$perm; }
13094: }
13095: }
13096: close($config);
13097: }
13098:
13099: # -------------------------------------------- Read plain texts for permissions
13100: {
13101: open(my $config,"<$perlvar{'lonTabDir'}/rolesplain.tab");
13102:
13103: while (my $configline=<$config>) {
13104: chomp($configline);
13105: if ($configline) {
13106: my ($short,@plain)=split(/:/,$configline);
13107: %{$prp{$short}} = ();
13108: if (@plain > 0) {
13109: $prp{$short}{'std'} = $plain[0];
13110: for (my $i=1; $i<@plain; $i++) {
13111: $prp{$short}{'alt'.$i} = $plain[$i];
13112: }
13113: }
13114: }
13115: }
13116: close($config);
13117: }
13118:
13119: # ---------------------------------------------------------- Read package table
13120: {
13121: open(my $config,"<$perlvar{'lonTabDir'}/packages.tab");
13122:
13123: while (my $configline=<$config>) {
13124: if ($configline !~ /\S/ || $configline=~/^#/) { next; }
13125: chomp($configline);
13126: my ($short,$plain)=split(/:/,$configline);
13127: my ($pack,$name)=split(/\&/,$short);
13128: if ($plain ne '') {
13129: $packagetab{$pack.'&'.$name.'&name'}=$name;
13130: $packagetab{$short}=$plain;
13131: }
13132: }
13133: close($config);
13134: }
13135:
13136: # ---------------------------------------------------------- Read loncaparev table
13137:
13138: &load_loncaparevs();
13139:
13140: # ---------------------------------------------------------- Read serverhostID table
13141:
13142: &load_serverhomeIDs();
13143:
13144: # ---------------------------------------------------------- Read releaseslist XML
13145: {
13146: my $file = $Apache::lonnet::perlvar{'lonTabDir'}.'/releaseslist.xml';
13147: if (-e $file) {
13148: my $parser = HTML::LCParser->new($file);
13149: while (my $token = $parser->get_token()) {
13150: if ($token->[0] eq 'S') {
13151: my $item = $token->[1];
13152: my $name = $token->[2]{'name'};
13153: my $value = $token->[2]{'value'};
13154: my $valuematch = $token->[2]{'valuematch'};
13155: my $namematch = $token->[2]{'namematch'};
13156: if ($item eq 'parameter') {
13157: if (($namematch ne '') || (($name ne '') && ($value ne '' || $valuematch ne ''))) {
13158: my $release = $parser->get_text();
13159: $release =~ s/(^\s*|\s*$ )//gx;
13160: $needsrelease{$item.':'.$name.':'.$value.':'.$valuematch.':'.$namematch} = $release;
13161: }
13162: } elsif ($item ne '' && $name ne '') {
13163: my $release = $parser->get_text();
13164: $release =~ s/(^\s*|\s*$ )//gx;
13165: $needsrelease{$item.':'.$name.':'.$value} = $release;
13166: }
13167: }
13168: }
13169: }
13170: }
13171:
13172: # ---------------------------------------------------------- Read managers table
13173: {
13174: if (-e "$perlvar{'lonTabDir'}/managers.tab") {
13175: if (open(my $config,"<$perlvar{'lonTabDir'}/managers.tab")) {
13176: while (my $configline=<$config>) {
13177: chomp($configline);
13178: next if ($configline =~ /^\#/);
13179: if (($configline =~ /^[\w\-]+$/) || ($configline =~ /^[\w\-]+\:[\w\-]+$/)) {
13180: $managerstab{$configline} = 1;
13181: }
13182: }
13183: close($config);
13184: }
13185: }
13186: }
13187:
13188: # ------------- set up temporary directory
13189: {
13190: $tmpdir = LONCAPA::tempdir();
13191:
13192: }
13193:
13194: $memcache=new Cache::Memcached({'servers' => ['127.0.0.1:11211'],
13195: 'compress_threshold'=> 20_000,
13196: });
13197:
13198: $processmarker='_'.time.'_'.$perlvar{'lonHostID'};
13199: $dumpcount=0;
13200: $locknum=0;
13201:
13202: &logtouch();
13203: &logthis('<font color="yellow">INFO: Read configuration</font>');
13204: $readit=1;
13205: {
13206: use integer;
13207: my $test=(2**32)+1;
13208: if ($test != 0) { $_64bit=1; } else { $_64bit=0; }
13209: &logthis(" Detected 64bit platform ($_64bit)");
13210: }
13211: }
13212: }
13213:
13214: 1;
13215: __END__
13216:
13217: =pod
13218:
13219: =head1 NAME
13220:
13221: Apache::lonnet - Subroutines to ask questions about things in the network.
13222:
13223: =head1 SYNOPSIS
13224:
13225: Invoked by other LON-CAPA modules, when they need to talk to or about objects in the network.
13226:
13227: &Apache::lonnet::SUBROUTINENAME(ARGUMENTS);
13228:
13229: Common parameters:
13230:
13231: =over 4
13232:
13233: =item *
13234:
13235: $uname : an internal username (if $cname expecting a course Id specifically)
13236:
13237: =item *
13238:
13239: $udom : a domain (if $cdom expecting a course's domain specifically)
13240:
13241: =item *
13242:
13243: $symb : a resource instance identifier
13244:
13245: =item *
13246:
13247: $namespace : the name of a .db file that contains the data needed or
13248: being set.
13249:
13250: =back
13251:
13252: =head1 OVERVIEW
13253:
13254: lonnet provides subroutines which interact with the
13255: lonc/lond (TCP) network layer of LON-CAPA. They can be used to ask
13256: about classes, users, and resources.
13257:
13258: For many of these objects you can also use this to store data about
13259: them or modify them in various ways.
13260:
13261: =head2 Symbs
13262:
13263: To identify a specific instance of a resource, LON-CAPA uses symbols
13264: or "symbs"X<symb>. These identifiers are built from the URL of the
13265: map, the resource number of the resource in the map, and the URL of
13266: the resource itself. The latter is somewhat redundant, but might help
13267: if maps change.
13268:
13269: An example is
13270:
13271: msu/korte/parts/part1.sequence___19___msu/korte/tests/part12.problem
13272:
13273: The respective map entry is
13274:
13275: <resource id="19" src="/res/msu/korte/tests/part12.problem"
13276: title="Problem 2">
13277: </resource>
13278:
13279: Symbs are used by the random number generator, as well as to store and
13280: restore data specific to a certain instance of for example a problem.
13281:
13282: =head2 Storing And Retrieving Data
13283:
13284: X<store()>X<cstore()>X<restore()>Three of the most important functions
13285: in C<lonnet.pm> are C<&Apache::lonnet::cstore()>,
13286: C<&Apache::lonnet:restore()>, and C<&Apache::lonnet::store()>, which
13287: is is the non-critical message twin of cstore. These functions are for
13288: handlers to store a perl hash to a user's permanent data space in an
13289: easy manner, and to retrieve it again on another call. It is expected
13290: that a handler would use this once at the beginning to retrieve data,
13291: and then again once at the end to send only the new data back.
13292:
13293: The data is stored in the user's data directory on the user's
13294: homeserver under the ID of the course.
13295:
13296: The hash that is returned by restore will have all of the previous
13297: value for all of the elements of the hash.
13298:
13299: Example:
13300:
13301: #creating a hash
13302: my %hash;
13303: $hash{'foo'}='bar';
13304:
13305: #storing it
13306: &Apache::lonnet::cstore(\%hash);
13307:
13308: #changing a value
13309: $hash{'foo'}='notbar';
13310:
13311: #adding a new value
13312: $hash{'bar'}='foo';
13313: &Apache::lonnet::cstore(\%hash);
13314:
13315: #retrieving the hash
13316: my %history=&Apache::lonnet::restore();
13317:
13318: #print the hash
13319: foreach my $key (sort(keys(%history))) {
13320: print("\%history{$key} = $history{$key}");
13321: }
13322:
13323: Will print out:
13324:
13325: %history{1:foo} = bar
13326: %history{1:keys} = foo:timestamp
13327: %history{1:timestamp} = 990455579
13328: %history{2:bar} = foo
13329: %history{2:foo} = notbar
13330: %history{2:keys} = foo:bar:timestamp
13331: %history{2:timestamp} = 990455580
13332: %history{bar} = foo
13333: %history{foo} = notbar
13334: %history{timestamp} = 990455580
13335: %history{version} = 2
13336:
13337: Note that the special hash entries C<keys>, C<version> and
13338: C<timestamp> were added to the hash. C<version> will be equal to the
13339: total number of versions of the data that have been stored. The
13340: C<timestamp> attribute will be the UNIX time the hash was
13341: stored. C<keys> is available in every historical section to list which
13342: keys were added or changed at a specific historical revision of a
13343: hash.
13344:
13345: B<Warning>: do not store the hash that restore returns directly. This
13346: will cause a mess since it will restore the historical keys as if the
13347: were new keys. I.E. 1:foo will become 1:1:foo etc.
13348:
13349: Calling convention:
13350:
13351: my %record=&Apache::lonnet::restore($symb,$courseid,$domain,$uname);
13352: &Apache::lonnet::cstore(\%newrecord,$symb,$courseid,$domain,$uname,$laststore);
13353:
13354: For more detailed information, see lonnet specific documentation.
13355:
13356: =head1 RETURN MESSAGES
13357:
13358: =over 4
13359:
13360: =item * B<con_lost>: unable to contact remote host
13361:
13362: =item * B<con_delayed>: unable to contact remote host, message will be delivered
13363: when the connection is brought back up
13364:
13365: =item * B<con_failed>: unable to contact remote host and unable to save message
13366: for later delivery
13367:
13368: =item * B<error:>: an error a occurred, a description of the error follows the :
13369:
13370: =item * B<no_such_host>: unable to fund a host associated with the user/domain
13371: that was requested
13372:
13373: =back
13374:
13375: =head1 PUBLIC SUBROUTINES
13376:
13377: =head2 Session Environment Functions
13378:
13379: =over 4
13380:
13381: =item *
13382: X<appenv()>
13383: B<appenv($hashref,$rolesarrayref)>: the value of %{$hashref} is written to
13384: the user envirnoment file, and will be restored for each access this
13385: user makes during this session, also modifies the %env for the current
13386: process. Optional rolesarrayref - if defined contains a reference to an array
13387: of roles which are exempt from the restriction on modifying user.role entries
13388: in the user's environment.db and in %env.
13389:
13390: =item *
13391: X<delenv()>
13392: B<delenv($delthis,$regexp)>: removes all items from the session
13393: environment file that begin with $delthis. If the
13394: optional second arg - $regexp - is true, $delthis is treated as a
13395: regular expression, otherwise \Q$delthis\E is used.
13396: The values are also deleted from the current processes %env.
13397:
13398: =item * get_env_multiple($name)
13399:
13400: gets $name from the %env hash, it seemlessly handles the cases where multiple
13401: values may be defined and end up as an array ref.
13402:
13403: returns an array of values
13404:
13405: =back
13406:
13407: =head2 User Information
13408:
13409: =over 4
13410:
13411: =item *
13412: X<queryauthenticate()>
13413: B<queryauthenticate($uname,$udom)>: try to determine user's current
13414: authentication scheme
13415:
13416: =item *
13417: X<authenticate()>
13418: B<authenticate($uname,$upass,$udom,$checkdefauth,$clientcancheckhost)>: try to
13419: authenticate user from domain's lib servers (first use the current
13420: one). C<$upass> should be the users password.
13421: $checkdefauth is optional (value is 1 if a check should be made to
13422: authenticate user using default authentication method, and allow
13423: account creation if username does not have account in the domain).
13424: $clientcancheckhost is optional (value is 1 if checking whether the
13425: server can host will occur on the client side in lonauth.pm).
13426:
13427: =item *
13428: X<homeserver()>
13429: B<homeserver($uname,$udom)>: find the server which has
13430: the user's directory and files (there must be only one), this caches
13431: the answer, and also caches if there is a borken connection.
13432:
13433: =item *
13434: X<idget()>
13435: B<idget($udom,$idsref,$namespace)>: find the usernames behind either
13436: a list of student/employee IDs or clicker IDs
13437: (student/employee IDs are a unique resource in a domain, there must be
13438: only 1 ID per username, and only 1 username per ID in a specific domain).
13439: clickerIDs are not necessarily unique, as students might share clickers.
13440: (returns hash: id=>name,id=>name)
13441:
13442: =item *
13443: X<idrget()>
13444: B<idrget($udom,@unames)>: find the IDs behind a list of
13445: usernames (returns hash: name=>id,name=>id)
13446:
13447: =item *
13448: X<idput()>
13449: B<idput($udom,$idsref,$uhome,$namespace)>: store away a list of
13450: names and associated student/employee IDs or clicker IDs.
13451:
13452: =item *
13453: X<iddel()>
13454: B<iddel($udom,$idshashref,$uhome,$namespace)>: delete unwanted
13455: student/employee ID or clicker ID username look-ups from domain.
13456: The homeserver ($uhome) and namespace ($namespace) are optional.
13457: If no $uhome is provided, it will be determined usig &homeserver()
13458: for each user. If no $namespace is provided, the default is ids.
13459:
13460: =item *
13461: X<updateclickers()>
13462: B<updateclickers($udom,$action,$idshashref,$uhome,$critical)>: update
13463: clicker ID-to-username look-ups in clickers.db on library server.
13464: Permitted actions are add or del (i.e., add or delete). The
13465: clickers.db contains clickerID as keys (escaped), and each corresponding
13466: value is an escaped comma-separated list of usernames (for whom the
13467: library server is the homeserver), who registered that particular ID.
13468: If $critical is true, the update will be sent via &critical, otherwise
13469: &reply() will be used.
13470:
13471: =item *
13472: X<rolesinit()>
13473: B<rolesinit($udom,$username)>: get user privileges.
13474: returns user role, first access and timer interval hashes
13475:
13476: =item *
13477: X<privileged()>
13478: B<privileged($username,$domain)>: returns a true if user has a
13479: privileged and active role (i.e. su or dc), false otherwise.
13480:
13481: =item *
13482: X<getsection()>
13483: B<getsection($udom,$uname,$cname)>: finds the section of student in the
13484: course $cname, return section name/number or '' for "not in course"
13485: and '-1' for "no section"
13486:
13487: =item *
13488: X<userenvironment()>
13489: B<userenvironment($udom,$uname,@what)>: gets the values of the keys
13490: passed in @what from the requested user's environment, returns a hash
13491:
13492: =item *
13493: X<userlog_query()>
13494: B<userlog_query($uname,$udom,%filters)>: retrieves data from a user's
13495: activity.log file. %filters defines filters applied when parsing the
13496: log file. These can be start or end timestamps, or the type of action
13497: - log to look for Login or Logout events, check for Checkin or
13498: Checkout, role for role selection. The response is in the form
13499: timestamp1:hostid1:event1×tamp2:hostid2:event2 where events are
13500: escaped strings of the action recorded in the activity.log file.
13501:
13502: =back
13503:
13504: =head2 User Roles
13505:
13506: =over 4
13507:
13508: =item *
13509:
13510: allowed($priv,$uri,$symb,$role,$clientip,$noblockcheck) : check for a user privilege;
13511: returns codes for allowed actions.
13512:
13513: The first argument is required, all others are optional.
13514:
13515: $priv is the privilege being checked.
13516: $uri contains additional information about what is being checked for access (e.g.,
13517: URL, course ID etc.).
13518: $symb is the unique resource instance identifier in a course; if needed,
13519: but not provided, it will be retrieved via a call to &symbread().
13520: $role is the role for which a priv is being checked (only used if priv is evb).
13521: $clientip is the user's IP address (only used when checking for access to portfolio
13522: files).
13523: $noblockcheck, if true, skips calls to &has_comm_blocking() for the bre priv. This
13524: prevents recursive calls to &allowed.
13525:
13526: F: full access
13527: U,I,K: authentication modes (cxx only)
13528: '': forbidden
13529: 1: user needs to choose course
13530: 2: browse allowed
13531: A: passphrase authentication needed
13532: B: access temporarily blocked because of a blocking event in a course.
13533:
13534: =item *
13535:
13536: constructaccess($url,$setpriv) : check for access to construction space URL
13537:
13538: See if the owner domain and name in the URL match those in the
13539: expected environment. If so, return three element list
13540: ($ownername,$ownerdomain,$ownerhome).
13541:
13542: Otherwise return the null string.
13543:
13544: If second argument 'setpriv' is true, it assigns the privileges,
13545: and returns the same three element list, unless the owner has
13546: blocked "ad hoc" Domain Coordinator access to the Author Space,
13547: in which case the null string is returned.
13548:
13549: =item *
13550:
13551: definerole($rolename,$sysrole,$domrole,$courole) : define role; define a custom
13552: role rolename set privileges in format of lonTabs/roles.tab for system, domain,
13553: and course level
13554:
13555: =item *
13556:
13557: plaintext($short,$type,$cid,$forcedefault) : return value in %prp hash
13558: (rolesplain.tab); plain text explanation of a user role term.
13559: $type is Course (default) or Community.
13560: If $forcedefault evaluates to true, text returned will be default
13561: text for $type. Otherwise, if this is a course, the text returned
13562: will be a custom name for the role (if defined in the course's
13563: environment). If no custom name is defined the default is returned.
13564:
13565: =item *
13566:
13567: get_my_roles($uname,$udom,$context,$types,$roles,$roledoms,$withsec,$hidepriv) :
13568: All arguments are optional. Returns a hash of a roles, either for
13569: co-author/assistant author roles for a user's Construction Space
13570: (default), or if $context is 'userroles', roles for the user himself,
13571: In the hash, keys are set to colon-separated $uname,$udom,$role, and
13572: (optionally) if $withsec is true, a fourth colon-separated item - $section.
13573: For each key, value is set to colon-separated start and end times for
13574: the role. If no username and domain are specified, will default to
13575: current user/domain. Types, roles, and roledoms are references to arrays
13576: of role statuses (active, future or previous), roles
13577: (e.g., cc,in, st etc.) and domains of the roles which can be used
13578: to restrict the list of roles reported. If no array ref is
13579: provided for types, will default to return only active roles.
13580:
13581: =item *
13582:
13583: in_course($udom,$uname,$cdom,$cnum,$type,$hideprivileged) : determine if
13584: user: $uname:$udom has a role in the course: $cdom_$cnum.
13585:
13586: Additional optional arguments are: $type (if role checking is to be restricted
13587: to certain user status types -- previous (expired roles), active (currently
13588: available roles) or future (roles available in the future), and
13589: $hideprivileged -- if true will not report course roles for users who
13590: have active Domain Coordinator role in course's domain or in additional
13591: domains (specified in 'Domains to check for privileged users' in course
13592: environment -- set via: Course Settings -> Classlists and staff listing).
13593:
13594: =item *
13595:
13596: privileged($username,$domain,$possdomains,$possroles) : returns 1 if user
13597: $username:$domain is a privileged user (e.g., Domain Coordinator or Super User)
13598: $possdomains and $possroles are optional array refs -- to domains to check and
13599: roles to check. If $possdomains is not specified, a dump will be done of the
13600: users' roles.db to check for a dc or su role in any domain. This can be
13601: time consuming if &privileged is called repeatedly (e.g., when displaying a
13602: classlist), so in such cases, supplying a $possdomains array is preferred, as
13603: this then allows &privileged_by_domain() to be used, which caches the identity
13604: of privileged users, eliminating the need for repeated calls to &dump().
13605:
13606: =item *
13607:
13608: privileged_by_domain($possdomains,$roles) : returns a hash of a hash of a hash,
13609: where the outer hash keys are domains specified in the $possdomains array ref,
13610: next inner hash keys are privileged roles specified in the $roles array ref,
13611: and the innermost hash contains key = value pairs for username:domain = end:start
13612: for active or future "privileged" users with that role in that domain. To avoid
13613: repeated dumps of domain roles -- via &get_domain_roles() -- contents of the
13614: innerhash are cached using priv_$role and $dom as the identifiers.
13615:
13616: =back
13617:
13618: =head2 User Modification
13619:
13620: =over 4
13621:
13622: =item *
13623:
13624: assignrole($udom,$uname,$url,$role,$end,$start,$deleteflag,$selfenroll,$context) : assign role; give a role to a
13625: user for the level given by URL. Optional start and end dates (leave empty
13626: string or zero for "no date")
13627:
13628: =item *
13629:
13630: changepass($uname,$udom,$currentpass,$newpass,$server) : attempts to
13631: change a users, password, possible return values are: ok,
13632: pwchange_failure, non_authorized, auth_mode_error, unknown_user,
13633: refused
13634:
13635: =item *
13636:
13637: modifyuserauth($udom,$uname,$umode,$upass) : modify user authentication
13638:
13639: =item *
13640:
13641: modifyuser($udom,$uname,$uid,$umode,$upass,$first,$middle,$last, $gene,
13642: $forceid,$desiredhome,$email,$inststatus,$candelete) :
13643:
13644: will update user information (firstname,middlename,lastname,generation,
13645: permanentemail), and if forceid is true, student/employee ID also.
13646: A user's institutional affiliation(s) can also be updated.
13647: User information fields will not be overwritten with empty entries
13648: unless the field is included in the $candelete array reference.
13649: This array is included when a single user is modified via "Manage Users",
13650: or when Autoupdate.pl is run by cron in a domain.
13651:
13652: =item *
13653:
13654: modifystudent
13655:
13656: modify a student's enrollment and identification information.
13657: The course id is resolved based on the current user's environment.
13658: This means the invoking user must be a course coordinator or otherwise
13659: associated with a course.
13660:
13661: This call is essentially a wrapper for lonnet::modifyuser and
13662: lonnet::modify_student_enrollment
13663:
13664: Inputs:
13665:
13666: =over 4
13667:
13668: =item B<$udom> Student's loncapa domain
13669:
13670: =item B<$uname> Student's loncapa login name
13671:
13672: =item B<$uid> Student/Employee ID
13673:
13674: =item B<$umode> Student's authentication mode
13675:
13676: =item B<$upass> Student's password
13677:
13678: =item B<$first> Student's first name
13679:
13680: =item B<$middle> Student's middle name
13681:
13682: =item B<$last> Student's last name
13683:
13684: =item B<$gene> Student's generation
13685:
13686: =item B<$usec> Student's section in course
13687:
13688: =item B<$end> Unix time of the roles expiration
13689:
13690: =item B<$start> Unix time of the roles start date
13691:
13692: =item B<$forceid> If defined, allow $uid to be changed
13693:
13694: =item B<$desiredhome> server to use as home server for student
13695:
13696: =item B<$email> Student's permanent e-mail address
13697:
13698: =item B<$type> Type of enrollment (auto or manual)
13699:
13700: =item B<$locktype> boolean - enrollment type locked to prevent Autoenroll.pl changing manual to auto
13701:
13702: =item B<$cid> courseID - needed if a course role is assigned by a user whose current role is DC
13703:
13704: =item B<$selfenroll> boolean - 1 if user role change occurred via self-enrollment
13705:
13706: =item B<$context> role change context (shown in User Management Logs display in a course)
13707:
13708: =item B<$inststatus> institutional status of user - : separated string of escaped status types
13709:
13710: =item B<$credits> Number of credits student will earn from this class - only needs to be supplied if value needs to be different from default credits for class.
13711:
13712: =back
13713:
13714: =item *
13715:
13716: modify_student_enrollment
13717:
13718: Change a student's enrollment status in a class. The environment variable
13719: 'role.request.course' must be defined for this function to proceed.
13720:
13721: Inputs:
13722:
13723: =over 4
13724:
13725: =item $udom, student's domain
13726:
13727: =item $uname, student's name
13728:
13729: =item $uid, student's user id
13730:
13731: =item $first, student's first name
13732:
13733: =item $middle
13734:
13735: =item $last
13736:
13737: =item $gene
13738:
13739: =item $usec
13740:
13741: =item $end
13742:
13743: =item $start
13744:
13745: =item $type
13746:
13747: =item $locktype
13748:
13749: =item $cid
13750:
13751: =item $selfenroll
13752:
13753: =item $context
13754:
13755: =item $credits, number of credits student will earn from this class
13756:
13757: =back
13758:
13759:
13760: =item *
13761:
13762: assigncustomrole($udom,$uname,$url,$rdom,$rnam,$rolename,$end,$start) : assign
13763: custom role; give a custom role to a user for the level given by URL. Specify
13764: name and domain of role author, and role name
13765:
13766: =item *
13767:
13768: revokerole($udom,$uname,$url,$role) : revoke a role for url
13769:
13770: =item *
13771:
13772: revokecustomrole($udom,$uname,$url,$role) : revoke a custom role
13773:
13774: =back
13775:
13776: =head2 Course Infomation
13777:
13778: =over 4
13779:
13780: =item *
13781:
13782: coursedescription($courseid,$options) : returns a hash of information about the
13783: specified course id, including all environment settings for the
13784: course, the description of the course will be in the hash under the
13785: key 'description'
13786:
13787: $options is an optional parameter that if supplied is a hash reference that controls
13788: what how this function works. It has the following key/values:
13789:
13790: =over 4
13791:
13792: =item freshen_cache
13793:
13794: If defined, and the environment cache for the course is valid, it is
13795: returned in the returned hash.
13796:
13797: =item one_time
13798:
13799: If defined, the last cache time is set to _now_
13800:
13801: =item user
13802:
13803: If defined, the supplied username is used instead of the current user.
13804:
13805:
13806: =back
13807:
13808: =item *
13809:
13810: resdata($name,$domain,$type,@which) : request for current parameter
13811: setting for a specific $type, where $type is either 'course' or 'user',
13812: @what should be a list of parameters to ask about. This routine caches
13813: answers for 10 minutes.
13814:
13815: =item *
13816:
13817: get_courseresdata($courseid, $domain) : dump the entire course resource
13818: data base, returning a hash that is keyed by the resource name and has
13819: values that are the resource value. I believe that the timestamps and
13820: versions are also returned.
13821:
13822: get_numsuppfiles($cnum,$cdom) : retrieve number of files in a course's
13823: supplemental content area. This routine caches the number of files for
13824: 10 minutes.
13825:
13826: =back
13827:
13828: =head2 Course Modification
13829:
13830: =over 4
13831:
13832: =item *
13833:
13834: writecoursepref($courseid,%prefs) : write preferences (environment
13835: database) for a course
13836:
13837: =item *
13838:
13839: createcourse($udom,$description,$url,$course_server,$nonstandard,$inst_code,$course_owner,$crstype,$cnum) : make course
13840:
13841: =item *
13842:
13843: generate_coursenum($udom,$crstype) : get a unique (unused) course number in domain $udom for course type $crstype (Course or Community).
13844:
13845: =item *
13846:
13847: is_course($courseid), is_course($cdom, $cnum)
13848:
13849: Accepts either a combined $courseid (in the form of domain_courseid) or the
13850: two component version $cdom, $cnum. It checks if the specified course exists.
13851:
13852: Returns:
13853: undef if the course doesn't exist, otherwise
13854: in scalar context the combined courseid.
13855: in list context the two components of the course identifier, domain and
13856: courseid.
13857:
13858: =back
13859:
13860: =head2 Resource Subroutines
13861:
13862: =over 4
13863:
13864: =item *
13865:
13866: subscribe($fname) : subscribe to a resource, returns URL if possible (probably should use repcopy instead)
13867:
13868: =item *
13869:
13870: repcopy($filename) : subscribes to the requested file, and attempts to
13871: replicate from the owning library server, Might return
13872: 'unavailable', 'not_found', 'forbidden', 'ok', or
13873: 'bad_request', also attempts to grab the metadata for the
13874: resource. Expects the local filesystem pathname
13875: (/home/httpd/html/res/....)
13876:
13877: =back
13878:
13879: =head2 Resource Information
13880:
13881: =over 4
13882:
13883: =item *
13884:
13885: EXT($varname,$symb,$udom,$uname,$usection,$recurse,$cid) : evaluates
13886: and returns the value of a variety of different possible values,
13887: $varname should be a request string, and the other parameters can be
13888: used to specify who and what one is asking about. Ordinarily, $cid
13889: does not need to be specified, as it is retrived from
13890: $env{'request.course.id'}, but &Apache::lonnet::EXT() is called
13891: within lonuserstate::loadmap() when initializing a course, before
13892: $env{'request.course.id'} has been set, so it needs to be provided
13893: in that one case.
13894:
13895: Possible values for $varname are environment.lastname (or other item
13896: from the envirnment hash), user.name (or someother aspect about the
13897: user), resource.0.maxtries (or some other part and parameter of a
13898: resource)
13899:
13900: =item *
13901:
13902: directcondval($number) : get current value of a condition; reads from a state
13903: string
13904:
13905: =item *
13906:
13907: condval($condidx) : value of condition index based on state
13908:
13909: =item *
13910:
13911: metadata($uri,$what,$liburi,$prefix,$depthcount) : request a
13912: resource's metadata, $what should be either a specific key, or either
13913: 'keys' (to get a list of possible keys) or 'packages' to get a list of
13914: packages that this resource currently uses, the last 3 arguments are only used internally for recursive metadata.
13915:
13916: this function automatically caches all requests
13917:
13918: =item *
13919:
13920: metadata_query($query,$custom,$customshow) : make a metadata query against the
13921: network of library servers; returns file handle of where SQL and regex results
13922: will be stored for query
13923:
13924: =item *
13925:
13926: symbread($filename,$donotrecurse,$ignorecachednull,$checkforblock,$possibles) :
13927: return symbolic list entry (all arguments optional).
13928:
13929: Args: filename is the filename (including path) for the file for which a symb
13930: is required; donotrecurse, if true will prevent calls to allowed() being made
13931: to check access status if more than one resource was found in the bighash
13932: (see rev. 1.249) to avoid an infinite loop if an ambiguous resource is part of
13933: a randompick); ignorecachednull, if true will prevent a symb of '' being
13934: returned if $env{$cache_str} is defined as ''; checkforblock if true will
13935: cause possible symbs to be checked to determine if they are subject to content
13936: blocking, if so they will not be included as possible symbs; possibles is a
13937: ref to a hash, which, as a side effect, will be populated with all possible
13938: symbs (content blocking not tested).
13939:
13940: returns the data handle
13941:
13942: =item *
13943:
13944: symbverify($symb,$thisfn,$encstate) : verifies that $symb actually exists
13945: and is a possible symb for the URL in $thisfn, and if is an encrypted
13946: resource that the user accessed using /enc/ returns a 1 on success, 0
13947: on failure, user must be in a course, as it assumes the existence of
13948: the course initial hash, and uses $env('request.course.id'}. The third
13949: arg is an optional reference to a scalar. If this arg is passed in the
13950: call to symbverify, it will be set to 1 if the symb has been set to be
13951: encrypted; otherwise it will be null.
13952:
13953: =item *
13954:
13955: symbclean($symb) : removes versions numbers from a symb, returns the
13956: cleaned symb
13957:
13958: =item *
13959:
13960: is_on_map($uri) : checks if the $uri is somewhere on the current
13961: course map, user must be in a course for it to work.
13962:
13963: =item *
13964:
13965: numval($salt) : return random seed value (addend for rndseed)
13966:
13967: =item *
13968:
13969: rndseed($symb,$courseid,$udom,$uname) : create a random sum; returns
13970: a random seed, all arguments are optional, if they aren't sent it uses the
13971: environment to derive them. Note: if symb isn't sent and it can't get one
13972: from &symbread it will use the current time as its return value
13973:
13974: =item *
13975:
13976: ireceipt($funame,$fudom,$fucourseid,$fusymb) : return unique,
13977: unfakeable, receipt
13978:
13979: =item *
13980:
13981: receipt() : API to ireceipt working off of env values; given out to users
13982:
13983: =item *
13984:
13985: countacc($url) : count the number of accesses to a given URL
13986:
13987: =item *
13988:
13989: 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
13990:
13991: =item *
13992:
13993: 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)
13994:
13995: =item *
13996:
13997: expirespread($uname,$udom,$stype,$usymb) : set expire date for spreadsheet
13998:
13999: =item *
14000:
14001: devalidate($symb) : devalidate temporary spreadsheet calculations,
14002: forcing spreadsheet to reevaluate the resource scores next time.
14003:
14004: =item *
14005:
14006: can_edit_resource($file,$cnum,$cdom,$resurl,$symb,$group) : determine if current user can edit a particular resource,
14007: when viewing in course context.
14008:
14009: input: six args -- filename (decluttered), course number, course domain,
14010: url, symb (if registered) and group (if this is a
14011: group item -- e.g., bulletin board, group page etc.).
14012:
14013: output: array of five scalars --
14014: $cfile -- url for file editing if editable on current server
14015: $home -- homeserver of resource (i.e., for author if published,
14016: or course if uploaded.).
14017: $switchserver -- 1 if server switch will be needed.
14018: $forceedit -- 1 if icon/link should be to go to edit mode
14019: $forceview -- 1 if icon/link should be to go to view mode
14020:
14021: =item *
14022:
14023: is_course_upload($file,$cnum,$cdom)
14024:
14025: Used in course context to determine if current file was uploaded to
14026: the course (i.e., would be found in /userfiles/docs on the course's
14027: homeserver.
14028:
14029: input: 3 args -- filename (decluttered), course number and course domain.
14030: output: boolean -- 1 if file was uploaded.
14031:
14032: =back
14033:
14034: =head2 Storing/Retreiving Data
14035:
14036: =over 4
14037:
14038: =item *
14039:
14040: store($storehash,$symb,$namespace,$udom,$uname,$laststore) : stores hash
14041: permanently for this url; hashref needs to be given and should be a \%hashname;
14042: the remaining args aren't required and if they aren't passed or are '' they will
14043: be derived from the env (with the exception of $laststore, which is an
14044: optional arg used when a user's submission is stored in grading).
14045: $laststore is $version=$timestamp, where $version is the most recent version
14046: number retrieved for the corresponding $symb in the $namespace db file, and
14047: $timestamp is the timestamp for that transaction (UNIX time).
14048: $laststore is currently only passed when cstore() is called by
14049: structuretags::finalize_storage().
14050:
14051: =item *
14052:
14053: cstore($storehash,$symb,$namespace,$udom,$uname,$laststore) : same as store
14054: but uses critical subroutine
14055:
14056: =item *
14057:
14058: restore($symb,$namespace,$udom,$uname) : returns hash for this symb;
14059: all args are optional
14060:
14061: =item *
14062:
14063: dumpstore($namespace,$udom,$uname,$regexp,$range) :
14064: dumps the complete (or key matching regexp) namespace into a hash
14065: ($udom, $uname, $regexp, $range are optional) for a namespace that is
14066: normally &store()ed into
14067:
14068: $range should be either an integer '100' (give me the first 100
14069: matching records)
14070: or be two integers sperated by a - with no spaces
14071: '30-50' (give me the 30th through the 50th matching
14072: records)
14073:
14074:
14075: =item *
14076:
14077: putstore($namespace,$symb,$version,$storehash,$udomain,$uname,$tolog) :
14078: replaces a &store() version of data with a replacement set of data
14079: for a particular resource in a namespace passed in the $storehash hash
14080: reference. If $tolog is true, the transaction is logged in the courselog
14081: with an action=PUTSTORE.
14082:
14083: =item *
14084:
14085: tmpstore($storehash,$symb,$namespace,$udom,$uname) : storage that
14086: works very similar to store/cstore, but all data is stored in a
14087: temporary location and can be reset using tmpreset, $storehash should
14088: be a hash reference, returns nothing on success
14089:
14090: =item *
14091:
14092: tmprestore($symb,$namespace,$udom,$uname) : storage that works very
14093: similar to restore, but all data is stored in a temporary location and
14094: can be reset using tmpreset. Returns a hash of values on success,
14095: error string otherwise.
14096:
14097: =item *
14098:
14099: tmpreset($symb,$namespace,$udom,$uname) : temporary storage reset,
14100: deltes all keys for $symb form the temporary storage hash.
14101:
14102: =item *
14103:
14104: get($namespace,$storearr,$udom,$uname) : returns hash with keys from array
14105: reference filled in from namesp ($udom and $uname are optional)
14106:
14107: =item *
14108:
14109: del($namespace,$storearr,$udom,$uname) : deletes keys out of array from
14110: namesp ($udom and $uname are optional)
14111:
14112: =item *
14113:
14114: dump($namespace,$udom,$uname,$regexp,$range) :
14115: dumps the complete (or key matching regexp) namespace into a hash
14116: ($udom, $uname, $regexp, $range are optional)
14117:
14118: $range should be either an integer '100' (give me the first 100
14119: matching records)
14120: or be two integers sperated by a - with no spaces
14121: '30-50' (give me the 30th through the 50th matching
14122: records)
14123: =item *
14124:
14125: inc($namespace,$store,$udom,$uname) : increments $store in $namespace.
14126: $store can be a scalar, an array reference, or if the amount to be
14127: incremented is > 1, a hash reference.
14128:
14129: ($udom and $uname are optional)
14130:
14131: =item *
14132:
14133: put($namespace,$storehash,$udom,$uname) : stores hash in namesp
14134: ($udom and $uname are optional)
14135:
14136: =item *
14137:
14138: cput($namespace,$storehash,$udom,$uname) : critical put
14139: ($udom and $uname are optional)
14140:
14141: =item *
14142:
14143: newput($namespace,$storehash,$udom,$uname) :
14144:
14145: Attempts to store the items in the $storehash, but only if they don't
14146: currently exist, if this succeeds you can be certain that you have
14147: successfully created a new key value pair in the $namespace db.
14148:
14149:
14150: Args:
14151: $namespace: name of database to store values to
14152: $storehash: hashref to store to the db
14153: $udom: (optional) domain of user containing the db
14154: $uname: (optional) name of user caontaining the db
14155:
14156: Returns:
14157: 'ok' -> succeeded in storing all keys of $storehash
14158: 'key_exists: <key>' -> failed to anything out of $storehash, as at
14159: least <key> already existed in the db (other
14160: requested keys may also already exist)
14161: 'error: <msg>' -> unable to tie the DB or other error occurred
14162: 'con_lost' -> unable to contact request server
14163: 'refused' -> action was not allowed by remote machine
14164:
14165:
14166: =item *
14167:
14168: eget($namespace,$storearr,$udom,$uname) : returns hash with keys from array
14169: reference filled in from namesp (encrypts the return communication)
14170: ($udom and $uname are optional)
14171:
14172: =item *
14173:
14174: log($udom,$name,$home,$message) : write to permanent log for user; use
14175: critical subroutine
14176:
14177: =item *
14178:
14179: get_dom($namespace,$storearr,$udom,$uhome) : returns hash with keys from
14180: array reference filled in from namespace found in domain level on either
14181: specified domain server ($uhome) or primary domain server ($udom and $uhome are optional).
14182:
14183: =item *
14184:
14185: put_dom($namespace,$storehash,$udom,$uhome) : stores hash in namespace at
14186: domain level either on specified domain server ($uhome) or primary domain
14187: server ($udom and $uhome are optional)
14188:
14189: =item *
14190:
14191: get_domain_defaults($target_domain,$ignore_cache) : returns hash with defaults
14192: for: authentication, language, quotas, timezone, date locale, and portal URL in
14193: the target domain.
14194:
14195: May also include additional key => value pairs for the following groups:
14196:
14197: =over
14198:
14199: =item
14200: disk quotas (MB allocated by default to portfolios and authoring spaces).
14201:
14202: =over
14203:
14204: =item defaultquota, authorquota
14205:
14206: =back
14207:
14208: =item
14209: tools (availability of aboutme page, blog, webDAV access for authoring spaces,
14210: portfolio for users).
14211:
14212: =over
14213:
14214: =item
14215: aboutme, blog, webdav, portfolio
14216:
14217: =back
14218:
14219: =item
14220: requestcourses: ability to request courses, and how requests are processed.
14221:
14222: =over
14223:
14224: =item
14225: official, unofficial, community, textbook, placement
14226:
14227: =back
14228:
14229: =item
14230: inststatus: types of institutional affiliation, and order in which they are displayed.
14231:
14232: =over
14233:
14234: =item
14235: inststatustypes, inststatusorder, inststatusguest
14236:
14237: =back
14238:
14239: =item
14240: coursedefaults: can PDF forms can be created, default credits for courses, default quotas (MB)
14241: for course's uploaded content.
14242:
14243: =over
14244:
14245: =item
14246: canuse_pdfforms, officialcredits, unofficialcredits, textbookcredits, officialquota, unofficialquota,
14247: communityquota, textbookquota, placementquota
14248:
14249: =back
14250:
14251: =item
14252: usersessions: set options for hosting of your users in other domains, and hosting of users from other domains
14253: on your servers.
14254:
14255: =over
14256:
14257: =item
14258: remotesessions, hostedsessions
14259:
14260: =back
14261:
14262: =back
14263:
14264: In cases where a domain coordinator has never used the "Set Domain Configuration"
14265: utility to create a configuration.db file on a domain's primary library server
14266: only the following domain defaults: auth_def, auth_arg_def, lang_def
14267: -- corresponding values are authentication type (internal, krb4, krb5,
14268: or localauth), initial password or a kerberos realm, language (e.g., en-us) --
14269: will be available. Values are retrieved from cache (if current), unless the
14270: optional $ignore_cache arg is true, or from domain's configuration.db (if available),
14271: or lastly from values in lonTabs/dns_domain,tab, or lonTabs/domain.tab.
14272:
14273: Typical usage:
14274:
14275: %domdefaults = &get_domain_defaults($target_domain);
14276:
14277: =back
14278:
14279: =head2 Network Status Functions
14280:
14281: =over 4
14282:
14283: =item *
14284:
14285: dirlist() : return directory list based on URI (first arg).
14286:
14287: Inputs: 1 required, 5 optional.
14288:
14289: =over
14290:
14291: =item
14292: $uri - path to file in filesystem (starts: /res or /userfiles/). Required.
14293:
14294: =item
14295: $userdomain - domain of user/course to be listed. Extracted from $uri if absent.
14296:
14297: =item
14298: $username - username of user/course to be listed. Extracted from $uri if absent.
14299:
14300: =item
14301: $getpropath - boolean: 1 if prepend path using &propath().
14302:
14303: =item
14304: $getuserdir - boolean: 1 if prepend path for "userfiles".
14305:
14306: =item
14307: $alternateRoot - path to prepend in place of path from $uri.
14308:
14309: =back
14310:
14311: Returns: Array of up to two items.
14312:
14313: =over
14314:
14315: a reference to an array of files/subdirectories
14316:
14317: =over
14318:
14319: Each element in the array of files/subdirectories is a & separated list of
14320: item name and the result of running stat on the item. If dirlist was requested
14321: for a file instead of a directory, the item name will be ''. For a directory
14322: listing, if the item is a metadata file, the element will end &N&M
14323: (where N amd M are either 0 or 1, corresponding to obsolete set (1), or
14324: default copyright set (1).
14325:
14326: =back
14327:
14328: a scalar containing error condition (if encountered).
14329:
14330: =over
14331:
14332: =item
14333: no_host (no homeserver identified for $username:$domain).
14334:
14335: =item
14336: no_such_host (server contacted for listing not identified as valid host).
14337:
14338: =item
14339: con_lost (connection to remote server failed).
14340:
14341: =item
14342: refused (invalid $username:$domain received on lond side).
14343:
14344: =item
14345: no_such_dir (directory at specified path on lond side does not exist).
14346:
14347: =item
14348: empty (directory at specified path on lond side is empty).
14349:
14350: =over
14351:
14352: This is currently not encountered because the &ls3, &ls2,
14353: &ls (_handler) routines on the lond side do not filter out
14354: . and .. from a directory listing.
14355:
14356: =back
14357:
14358: =back
14359:
14360: =back
14361:
14362: =item *
14363:
14364: spareserver() : find server with least workload from spare.tab
14365:
14366:
14367: =item *
14368:
14369: host_from_dns($dns) : Returns the loncapa hostname corresponding to a DNS name or undef
14370: if there is no corresponding loncapa host.
14371:
14372: =back
14373:
14374:
14375: =head2 Apache Request
14376:
14377: =over 4
14378:
14379: =item *
14380:
14381: ssi($url,%hash) : server side include, does a complete request cycle on url to
14382: localhost, posts hash
14383:
14384: =back
14385:
14386: =head2 Data to String to Data
14387:
14388: =over 4
14389:
14390: =item *
14391:
14392: hash2str(%hash) : convert a hash into a string complete with escaping and '='
14393: and '&' separators, supports elements that are arrayrefs and hashrefs
14394:
14395: =item *
14396:
14397: hashref2str($hashref) : convert a hashref into a string complete with
14398: escaping and '=' and '&' separators, supports elements that are
14399: arrayrefs and hashrefs
14400:
14401: =item *
14402:
14403: arrayref2str($arrayref) : convert an arrayref into a string complete
14404: with escaping and '&' separators, supports elements that are arrayrefs
14405: and hashrefs
14406:
14407: =item *
14408:
14409: str2hash($string) : convert string to hash using unescaping and
14410: splitting on '=' and '&', supports elements that are arrayrefs and
14411: hashrefs
14412:
14413: =item *
14414:
14415: str2array($string) : convert string to hash using unescaping and
14416: splitting on '&', supports elements that are arrayrefs and hashrefs
14417:
14418: =back
14419:
14420: =head2 Logging Routines
14421:
14422:
14423: These routines allow one to make log messages in the lonnet.log and
14424: lonnet.perm logfiles.
14425:
14426: =over 4
14427:
14428: =item *
14429:
14430: logtouch() : make sure the logfile, lonnet.log, exists
14431:
14432: =item *
14433:
14434: logthis() : append message to the normal lonnet.log file, it gets
14435: preiodically rolled over and deleted.
14436:
14437: =item *
14438:
14439: logperm() : append a permanent message to lonnet.perm.log, this log
14440: file never gets deleted by any automated portion of the system, only
14441: messages of critical importance should go in here.
14442:
14443:
14444: =back
14445:
14446: =head2 General File Helper Routines
14447:
14448: =over 4
14449:
14450: =item *
14451:
14452: getfile($file,$caller) : two cases - requests for files in /res or in /uploaded.
14453: (a) files in /uploaded
14454: (i) If a local copy of the file exists -
14455: compares modification date of local copy with last-modified date for
14456: definitive version stored on home server for course. If local copy is
14457: stale, requests a new version from the home server and stores it.
14458: If the original has been removed from the home server, then local copy
14459: is unlinked.
14460: (ii) If local copy does not exist -
14461: requests the file from the home server and stores it.
14462:
14463: If $caller is 'uploadrep':
14464: This indicates a call from lonuploadrep.pm (PerlHeaderParserHandler phase)
14465: for request for files originally uploaded via DOCS.
14466: - returns 'ok' if fresh local copy now available, -1 otherwise.
14467:
14468: Otherwise:
14469: This indicates a call from the content generation phase of the request.
14470: - returns the entire contents of the file or -1.
14471:
14472: (b) files in /res
14473: - returns the entire contents of a file or -1;
14474: it properly subscribes to and replicates the file if neccessary.
14475:
14476:
14477: =item *
14478:
14479: stat_file($url) : $url is expected to be a /res/ or /uploaded/ style file
14480: reference
14481:
14482: returns either a stat() list of data about the file or an empty list
14483: if the file doesn't exist or couldn't find out about it (connection
14484: problems or user unknown)
14485:
14486: =item *
14487:
14488: filelocation($dir,$file) : returns file system location of a file
14489: based on URI; meant to be "fairly clean" absolute reference, $dir is a
14490: directory that relative $file lookups are to looked in ($dir of /a/dir
14491: and a file of ../bob will become /a/bob)
14492:
14493: =item *
14494:
14495: hreflocation($dir,$file) : returns file system location or a URL; same as
14496: filelocation except for hrefs
14497:
14498: =item *
14499:
14500: declutter() : declutters URLs -- remove beginning slashes, 'res' etc.
14501: also removes beginning /home/httpd/html unless /priv/ follows it.
14502:
14503: =back
14504:
14505: =head2 Usererfile file routines (/uploaded*)
14506:
14507: =over 4
14508:
14509: =item *
14510:
14511: userfileupload(): main rotine for putting a file in a user or course's
14512: filespace, arguments are,
14513:
14514: formname - required - this is the name of the element in $env where the
14515: filename, and the contents of the file to create/modifed exist
14516: the filename is in $env{'form.'.$formname.'.filename'} and the
14517: contents of the file is located in $env{'form.'.$formname}
14518: context - if coursedoc, store the file in the course of the active role
14519: of the current user;
14520: if 'existingfile': store in 'overwrites' in /home/httpd/perl/tmp
14521: if 'canceloverwrite': delete file in tmp/overwrites directory
14522: subdir - required - subdirectory to put the file in under ../userfiles/
14523: if undefined, it will be placed in "unknown"
14524:
14525: (This routine calls clean_filename() to remove any dangerous
14526: characters from the filename, and then calls finuserfileupload() to
14527: complete the transaction)
14528:
14529: returns either the url of the uploaded file (/uploaded/....) if successful
14530: and /adm/notfound.html if unsuccessful
14531:
14532: =item *
14533:
14534: clean_filename(): routine for cleaing a filename up for storage in
14535: userfile space, argument is:
14536:
14537: filename - proposed filename
14538:
14539: returns: the new clean filename
14540:
14541: =item *
14542:
14543: finishuserfileupload(): routine that creates and sends the file to
14544: userspace, probably shouldn't be called directly
14545:
14546: docuname: username or courseid of destination for the file
14547: docudom: domain of user/course of destination for the file
14548: formname: same as for userfileupload()
14549: fname: filename (including subdirectories) for the file
14550: parser: if 'parse', will parse (html) file to extract references to objects, links etc.
14551: allfiles: reference to hash used to store objects found by parser
14552: codebase: reference to hash used for codebases of java objects found by parser
14553: thumbwidth: width (pixels) of thumbnail to be created for uploaded image
14554: thumbheight: height (pixels) of thumbnail to be created for uploaded image
14555: resizewidth: width to be used to resize image using resizeImage from ImageMagick
14556: resizeheight: height to be used to resize image using resizeImage from ImageMagick
14557: context: if 'overwrite', will move the uploaded file from its temporary location to
14558: userfiles to facilitate overwriting a previously uploaded file with same name.
14559: mimetype: reference to scalar to accommodate mime type determined
14560: from File::MMagic if $parser = parse.
14561:
14562: returns either the url of the uploaded file (/uploaded/....) if successful
14563: and /adm/notfound.html if unsuccessful (or an error message if context
14564: was 'overwrite').
14565:
14566:
14567: =item *
14568:
14569: renameuserfile(): renames an existing userfile to a new name
14570:
14571: Args:
14572: docuname: username or courseid of destination for the file
14573: docudom: domain of user/course of destination for the file
14574: old: current file name (including any subdirs under userfiles)
14575: new: desired file name (including any subdirs under userfiles)
14576:
14577: =item *
14578:
14579: mkdiruserfile(): creates a directory is a userfiles dir
14580:
14581: Args:
14582: docuname: username or courseid of destination for the file
14583: docudom: domain of user/course of destination for the file
14584: dir: dir to create (including any subdirs under userfiles)
14585:
14586: =item *
14587:
14588: removeuserfile(): removes a file that exists in userfiles
14589:
14590: Args:
14591: docuname: username or courseid of destination for the file
14592: docudom: domain of user/course of destination for the file
14593: fname: filname to delete (including any subdirs under userfiles)
14594:
14595: =item *
14596:
14597: removeuploadedurl(): convience function for removeuserfile()
14598:
14599: Args:
14600: url: a full /uploaded/... url to delete
14601:
14602: =item *
14603:
14604: get_portfile_permissions():
14605: Args:
14606: domain: domain of user or course contain the portfolio files
14607: user: name of user or num of course contain the portfolio files
14608: Returns:
14609: hashref of a dump of the proper file_permissions.db
14610:
14611:
14612: =item *
14613:
14614: get_access_controls():
14615:
14616: Args:
14617: current_permissions: the hash ref returned from get_portfile_permissions()
14618: group: (optional) the group you want the files associated with
14619: file: (optional) the file you want access info on
14620:
14621: Returns:
14622: a hash (keys are file names) of hashes containing
14623: keys are: path to file/file_name\0uniqueID:scope_end_start (see below)
14624: values are XML containing access control settings (see below)
14625:
14626: Internal notes:
14627:
14628: access controls are stored in file_permissions.db as key=value pairs.
14629: key -> path to file/file_name\0uniqueID:scope_end_start
14630: where scope -> public,guest,course,group,domains or users.
14631: end -> UNIX time for end of access (0 -> no end date)
14632: start -> UNIX time for start of access
14633:
14634: value -> XML description of access control
14635: <scope type=""> (type =1 of: public,guest,course,group,domains,users">
14636: <start></start>
14637: <end></end>
14638:
14639: <password></password> for scope type = guest
14640:
14641: <domain></domain> for scope type = course or group
14642: <number></number>
14643: <roles id="">
14644: <role></role>
14645: <access></access>
14646: <section></section>
14647: <group></group>
14648: </roles>
14649:
14650: <dom></dom> for scope type = domains
14651:
14652: <users> for scope type = users
14653: <user>
14654: <uname></uname>
14655: <udom></udom>
14656: </user>
14657: </users>
14658: </scope>
14659:
14660: Access data is also aggregated for each file in an additional key=value pair:
14661: key -> path to file/file_name\0accesscontrol
14662: value -> reference to hash
14663: hash contains key = value pairs
14664: where key = uniqueID:scope_end_start
14665: value = UNIX time record was last updated
14666:
14667: Used to improve speed of look-ups of access controls for each file.
14668:
14669: Locks on files (resulting from submission of portfolio file to a homework problem stored in array of arrays.
14670:
14671: =item *
14672:
14673: modify_access_controls():
14674:
14675: Modifies access controls for a portfolio file
14676: Args
14677: 1. file name
14678: 2. reference to hash of required changes,
14679: 3. domain
14680: 4. username
14681: where domain,username are the domain of the portfolio owner
14682: (either a user or a course)
14683:
14684: Returns:
14685: 1. result of additions or updates ('ok' or 'error', with error message).
14686: 2. result of deletions ('ok' or 'error', with error message).
14687: 3. reference to hash of any new or updated access controls.
14688: 4. reference to hash used to map incoming IDs to uniqueIDs assigned to control.
14689: key = integer (inbound ID)
14690: value = uniqueID
14691:
14692: =item *
14693:
14694: get_timebased_id():
14695:
14696: Attempts to get a unique timestamp-based suffix for use with items added to a
14697: course via the Course Editor (e.g., folders, composite pages,
14698: group bulletin boards).
14699:
14700: Args: (first three required; six others optional)
14701:
14702: 1. prefix (alphanumeric): of keys in hash, e.g., suppsequence, docspage,
14703: docssequence, or name of group
14704:
14705: 2. keyid (alphanumeric): name of temporary locking key in hash,
14706: e.g., num, boardids
14707:
14708: 3. namespace: name of gdbm file used to store suffixes already assigned;
14709: file will be named nohist_namespace.db
14710:
14711: 4. cdom: domain of course; default is current course domain from %env
14712:
14713: 5. cnum: course number; default is current course number from %env
14714:
14715: 6. idtype: set to concat if an additional digit is to be appended to the
14716: unix timestamp to form the suffix, if the plain timestamp is already
14717: in use. Default is to not do this, but simply increment the unix
14718: timestamp by 1 until a unique key is obtained.
14719:
14720: 7. who: holder of locking key; defaults to user:domain for user.
14721:
14722: 8. locktries: number of attempts to obtain a lock (sleep of 1s before
14723: retrying); default is 3.
14724:
14725: 9. maxtries: number of attempts to obtain a unique suffix; default is 20.
14726:
14727: Returns:
14728:
14729: 1. suffix obtained (numeric)
14730:
14731: 2. result of deleting locking key (ok if deleted, or lock never obtained)
14732:
14733: 3. error: contains (localized) error message if an error occurred.
14734:
14735:
14736: =back
14737:
14738: =head2 HTTP Helper Routines
14739:
14740: =over 4
14741:
14742: =item *
14743:
14744: escape() : unpack non-word characters into CGI-compatible hex codes
14745:
14746: =item *
14747:
14748: unescape() : pack CGI-compatible hex codes into actual non-word ASCII character
14749:
14750: =back
14751:
14752: =head1 PRIVATE SUBROUTINES
14753:
14754: =head2 Underlying communication routines (Shouldn't call)
14755:
14756: =over 4
14757:
14758: =item *
14759:
14760: subreply() : tries to pass a message to lonc, returns con_lost if incapable
14761:
14762: =item *
14763:
14764: reply() : uses subreply to send a message to remote machine, logs all failures
14765:
14766: =item *
14767:
14768: critical() : passes a critical message to another server; if cannot
14769: get through then place message in connection buffer directory and
14770: returns con_delayed, if incapable of saving message, returns
14771: con_failed
14772:
14773: =item *
14774:
14775: reconlonc() : tries to reconnect lonc client processes.
14776:
14777: =back
14778:
14779: =head2 Resource Access Logging
14780:
14781: =over 4
14782:
14783: =item *
14784:
14785: flushcourselogs() : flush (save) buffer logs and access logs
14786:
14787: =item *
14788:
14789: courselog($what) : save message for course in hash
14790:
14791: =item *
14792:
14793: courseacclog($what) : save message for course using &courselog(). Perform
14794: special processing for specific resource types (problems, exams, quizzes, etc).
14795:
14796: =item *
14797:
14798: goodbye() : flush course logs and log shutting down; it is called in srm.conf
14799: as a PerlChildExitHandler
14800:
14801: =back
14802:
14803: =head2 Other
14804:
14805: =over 4
14806:
14807: =item *
14808:
14809: symblist($mapname,%newhash) : update symbolic storage links
14810:
14811: =back
14812:
14813: =cut
14814:
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