1: # The LearningOnline Network
2: # TCP networking package
3: #
4: # $Id: lonnet.pm,v 1.1318 2016/08/25 08:09:34 droeschl 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_servercerts_info {
233: my ($lonhost,$context) = @_;
234: my ($rep,$uselocal);
235: if (grep { $_ eq $lonhost } ¤t_machine_ids()) {
236: $uselocal = 1;
237: }
238: if (($context ne 'cgi') && ($uselocal)) {
239: my $distro = (split(/\:/,&get_server_distarch($lonhost)))[0];
240: if ($distro =~ /^(?:centos|redhat|scientific)(\d+)$/) {
241: if ($1 < 6) {
242: $uselocal = 0;
243: }
244: }
245: }
246: if ($uselocal) {
247: $rep = LONCAPA::Lond::server_certs(\%perlvar);
248: } else {
249: $rep=&reply('servercerts',$lonhost);
250: }
251: my ($result,%returnhash);
252: if (defined($lonhost)) {
253: if (!defined(&hostname($lonhost))) {
254: return;
255: }
256: }
257: if (($rep=~/^(refused|rejected|error)/) || ($rep eq 'con_lost') ||
258: ($rep eq 'unknown_cmd')) {
259: $result = $rep;
260: } else {
261: $result = 'ok';
262: my @pairs=split(/\&/,$rep);
263: foreach my $item (@pairs) {
264: my ($key,$value)=split(/=/,$item,2);
265: my $what = &unescape($key);
266: $returnhash{$what}=&thaw_unescape($value);
267: }
268: }
269: return ($result,\%returnhash);
270: }
271:
272: sub get_server_loncaparev {
273: my ($dom,$lonhost,$ignore_cache,$caller) = @_;
274: if (defined($lonhost)) {
275: if (!defined(&hostname($lonhost))) {
276: undef($lonhost);
277: }
278: }
279: if (!defined($lonhost)) {
280: if (defined(&domain($dom,'primary'))) {
281: $lonhost=&domain($dom,'primary');
282: if ($lonhost eq 'no_host') {
283: undef($lonhost);
284: }
285: }
286: }
287: if (defined($lonhost)) {
288: my $cachetime = 12*3600;
289: if (!$ignore_cache) {
290: my ($loncaparev,$cached)=&is_cached_new('serverloncaparev',$lonhost);
291: if (defined($cached)) {
292: return $loncaparev;
293: }
294: }
295: my ($answer,$loncaparev);
296: my @ids=¤t_machine_ids();
297: if (grep(/^\Q$lonhost\E$/,@ids)) {
298: $answer = $perlvar{'lonVersion'};
299: if ($answer =~ /^[\'\"]?([\w.\-]+)[\'\"]?$/) {
300: $loncaparev = $1;
301: }
302: } else {
303: $answer = &reply('serverloncaparev',$lonhost);
304: if (($answer eq 'unknown_cmd') || ($answer eq 'con_lost')) {
305: if ($caller eq 'loncron') {
306: my $ua=new LWP::UserAgent;
307: $ua->timeout(4);
308: my $protocol = $protocol{$lonhost};
309: $protocol = 'http' if ($protocol ne 'https');
310: my $url = $protocol.'://'.&hostname($lonhost).'/adm/about.html';
311: my $request=new HTTP::Request('GET',$url);
312: my $response=$ua->request($request);
313: unless ($response->is_error()) {
314: my $content = $response->content;
315: if ($content =~ /<p>VERSION\:\s*([\w.\-]+)<\/p>/) {
316: $loncaparev = $1;
317: }
318: }
319: } else {
320: $loncaparev = $loncaparevs{$lonhost};
321: }
322: } elsif ($answer =~ /^[\'\"]?([\w.\-]+)[\'\"]?$/) {
323: $loncaparev = $1;
324: }
325: }
326: return &do_cache_new('serverloncaparev',$lonhost,$loncaparev,$cachetime);
327: }
328: }
329:
330: sub get_server_homeID {
331: my ($hostname,$ignore_cache,$caller) = @_;
332: unless ($ignore_cache) {
333: my ($serverhomeID,$cached)=&is_cached_new('serverhomeID',$hostname);
334: if (defined($cached)) {
335: return $serverhomeID;
336: }
337: }
338: my $cachetime = 12*3600;
339: my $serverhomeID;
340: if ($caller eq 'loncron') {
341: my @machine_ids = &machine_ids($hostname);
342: foreach my $id (@machine_ids) {
343: my $response = &reply('serverhomeID',$id);
344: unless (($response eq 'unknown_cmd') || ($response eq 'con_lost')) {
345: $serverhomeID = $response;
346: last;
347: }
348: }
349: if ($serverhomeID eq '') {
350: $serverhomeID = $machine_ids[-1];
351: }
352: } else {
353: $serverhomeID = $serverhomeIDs{$hostname};
354: }
355: return &do_cache_new('serverhomeID',$hostname,$serverhomeID,$cachetime);
356: }
357:
358: sub get_remote_globals {
359: my ($lonhost,$whathash,$ignore_cache) = @_;
360: my ($result,%returnhash,%whatneeded);
361: if (ref($whathash) eq 'HASH') {
362: foreach my $what (sort(keys(%{$whathash}))) {
363: my $hashid = $lonhost.'-'.$what;
364: my ($response,$cached);
365: unless ($ignore_cache) {
366: ($response,$cached)=&is_cached_new('lonnetglobal',$hashid);
367: }
368: if (defined($cached)) {
369: $returnhash{$what} = $response;
370: } else {
371: $whatneeded{$what} = 1;
372: }
373: }
374: if (keys(%whatneeded) == 0) {
375: $result = 'ok';
376: } else {
377: my $requested = &freeze_escape(\%whatneeded);
378: my $rep=&reply('readlonnetglobal:'.$requested,$lonhost);
379: if (($rep=~/^(refused|rejected|error)/) || ($rep eq 'con_lost') ||
380: ($rep eq 'unknown_cmd')) {
381: $result = $rep;
382: } else {
383: $result = 'ok';
384: my @pairs=split(/\&/,$rep);
385: foreach my $item (@pairs) {
386: my ($key,$value)=split(/=/,$item,2);
387: my $what = &unescape($key);
388: my $hashid = $lonhost.'-'.$what;
389: $returnhash{$what}=&thaw_unescape($value);
390: &do_cache_new('lonnetglobal',$hashid,$returnhash{$what},600);
391: }
392: }
393: }
394: }
395: return ($result,\%returnhash);
396: }
397:
398: sub remote_devalidate_cache {
399: my ($lonhost,$cachekeys) = @_;
400: my $items;
401: return unless (ref($cachekeys) eq 'ARRAY');
402: my $cachestr = join('&',@{$cachekeys});
403: my $response = &reply('devalidatecache:'.&escape($cachestr),$lonhost);
404: return $response;
405: }
406:
407: # -------------------------------------------------- Non-critical communication
408: sub subreply {
409: my ($cmd,$server)=@_;
410: my $peerfile="$perlvar{'lonSockDir'}/".&hostname($server);
411: #
412: # With loncnew process trimming, there's a timing hole between lonc server
413: # process exit and the master server picking up the listen on the AF_UNIX
414: # socket. In that time interval, a lock file will exist:
415:
416: my $lockfile=$peerfile.".lock";
417: while (-e $lockfile) { # Need to wait for the lockfile to disappear.
418: sleep(0.1);
419: }
420: # At this point, either a loncnew parent is listening or an old lonc
421: # or loncnew child is listening so we can connect or everything's dead.
422: #
423: # We'll give the connection a few tries before abandoning it. If
424: # connection is not possible, we'll con_lost back to the client.
425: #
426: my $client;
427: for (my $retries = 0; $retries < $max_connection_retries; $retries++) {
428: $client=IO::Socket::UNIX->new(Peer =>"$peerfile",
429: Type => SOCK_STREAM,
430: Timeout => 10);
431: if ($client) {
432: last; # Connected!
433: } else {
434: &create_connection(&hostname($server),$server);
435: }
436: sleep(0.1); # Try again later if failed connection.
437: }
438: my $answer;
439: if ($client) {
440: print $client "sethost:$server:$cmd\n";
441: $answer=<$client>;
442: if (!$answer) { $answer="con_lost"; }
443: chomp($answer);
444: } else {
445: $answer = 'con_lost'; # Failed connection.
446: }
447: return $answer;
448: }
449:
450: sub reply {
451: my ($cmd,$server)=@_;
452: unless (defined(&hostname($server))) { return 'no_such_host'; }
453: my $answer=subreply($cmd,$server);
454: if (($answer=~/^refused/) || ($answer=~/^rejected/)) {
455: &logthis("<font color=\"blue\">WARNING:".
456: " $cmd to $server returned $answer</font>");
457: }
458: return $answer;
459: }
460:
461: # ----------------------------------------------------------- Send USR1 to lonc
462:
463: sub reconlonc {
464: my ($lonid) = @_;
465: if ($lonid) {
466: my $hostname = &hostname($lonid);
467: my $peerfile="$perlvar{'lonSockDir'}/$hostname";
468: if ($hostname && -e $peerfile) {
469: &logthis("Trying to reconnect lonc for $lonid ($hostname)");
470: my $client=IO::Socket::UNIX->new(Peer => $peerfile,
471: Type => SOCK_STREAM,
472: Timeout => 10);
473: if ($client) {
474: print $client ("reset_retries\n");
475: my $answer=<$client>;
476: #reset just this one.
477: }
478: }
479: return;
480: }
481:
482: &logthis("Trying to reconnect lonc");
483: my $loncfile="$perlvar{'lonDaemons'}/logs/lonc.pid";
484: if (open(my $fh,"<$loncfile")) {
485: my $loncpid=<$fh>;
486: chomp($loncpid);
487: if (kill 0 => $loncpid) {
488: &logthis("lonc at pid $loncpid responding, sending USR1");
489: kill USR1 => $loncpid;
490: sleep 1;
491: } else {
492: &logthis(
493: "<font color=\"blue\">WARNING:".
494: " lonc at pid $loncpid not responding, giving up</font>");
495: }
496: } else {
497: &logthis('<font color="blue">WARNING: lonc not running, giving up</font>');
498: }
499: }
500:
501: # ------------------------------------------------------ Critical communication
502:
503: sub critical {
504: my ($cmd,$server)=@_;
505: unless (&hostname($server)) {
506: &logthis("<font color=\"blue\">WARNING:".
507: " Critical message to unknown server ($server)</font>");
508: return 'no_such_host';
509: }
510: my $answer=reply($cmd,$server);
511: if ($answer eq 'con_lost') {
512: &reconlonc($server);
513: my $answer=reply($cmd,$server);
514: if ($answer eq 'con_lost') {
515: my $now=time;
516: my $middlename=$cmd;
517: $middlename=substr($middlename,0,16);
518: $middlename=~s/\W//g;
519: my $dfilename=
520: "$perlvar{'lonSockDir'}/delayed/$now.$dumpcount.$$.$middlename.$server";
521: $dumpcount++;
522: {
523: my $dfh;
524: if (open($dfh,">$dfilename")) {
525: print $dfh "$cmd\n";
526: close($dfh);
527: }
528: }
529: sleep 1;
530: my $wcmd='';
531: {
532: my $dfh;
533: if (open($dfh,"<$dfilename")) {
534: $wcmd=<$dfh>;
535: close($dfh);
536: }
537: }
538: chomp($wcmd);
539: if ($wcmd eq $cmd) {
540: &logthis("<font color=\"blue\">WARNING: ".
541: "Connection buffer $dfilename: $cmd</font>");
542: &logperm("D:$server:$cmd");
543: return 'con_delayed';
544: } else {
545: &logthis("<font color=\"red\">CRITICAL:"
546: ." Critical connection failed: $server $cmd</font>");
547: &logperm("F:$server:$cmd");
548: return 'con_failed';
549: }
550: }
551: }
552: return $answer;
553: }
554:
555: # ------------------------------------------- check if return value is an error
556:
557: sub error {
558: my ($result) = @_;
559: if ($result =~ /^(con_lost|no_such_host|error: (\d+) (.*))/) {
560: if ($2 == 2) { return undef; }
561: return $1;
562: }
563: return undef;
564: }
565:
566: sub convert_and_load_session_env {
567: my ($lonidsdir,$handle)=@_;
568: my @profile;
569: {
570: my $opened = open(my $idf,'+<',"$lonidsdir/$handle.id");
571: if (!$opened) {
572: return 0;
573: }
574: flock($idf,LOCK_SH);
575: @profile=<$idf>;
576: close($idf);
577: }
578: my %temp_env;
579: foreach my $line (@profile) {
580: if ($line !~ m/=/) {
581: return 0;
582: }
583: chomp($line);
584: my ($envname,$envvalue)=split(/=/,$line,2);
585: $temp_env{&unescape($envname)} = &unescape($envvalue);
586: }
587: unlink("$lonidsdir/$handle.id");
588: if (tie(my %disk_env,'GDBM_File',"$lonidsdir/$handle.id",&GDBM_WRCREAT(),
589: 0640)) {
590: %disk_env = %temp_env;
591: @env{keys(%temp_env)} = @disk_env{keys(%temp_env)};
592: untie(%disk_env);
593: }
594: return 1;
595: }
596:
597: # ------------------------------------------- Transfer profile into environment
598: my $env_loaded;
599: sub transfer_profile_to_env {
600: my ($lonidsdir,$handle,$force_transfer) = @_;
601: if (!$force_transfer && $env_loaded) { return; }
602:
603: if (!defined($lonidsdir)) {
604: $lonidsdir = $perlvar{'lonIDsDir'};
605: }
606: if (!defined($handle)) {
607: ($handle) = ($env{'user.environment'} =~m|/([^/]+)\.id$| );
608: }
609:
610: my $convert;
611: {
612: my $opened = open(my $idf,'+<',"$lonidsdir/$handle.id");
613: if (!$opened) {
614: return;
615: }
616: flock($idf,LOCK_SH);
617: if (tie(my %disk_env,'GDBM_File',"$lonidsdir/$handle.id",
618: &GDBM_READER(),0640)) {
619: @env{keys(%disk_env)} = @disk_env{keys(%disk_env)};
620: untie(%disk_env);
621: } else {
622: $convert = 1;
623: }
624: }
625: if ($convert) {
626: if (!&convert_and_load_session_env($lonidsdir,$handle)) {
627: &logthis("Failed to load session, or convert session.");
628: }
629: }
630:
631: my %remove;
632: while ( my $envname = each(%env) ) {
633: if (my ($key,$time) = ($envname =~ /^(cgi\.(\d+)_\d+\.)/)) {
634: if ($time < time-300) {
635: $remove{$key}++;
636: }
637: }
638: }
639:
640: $env{'user.environment'} = "$lonidsdir/$handle.id";
641: $env_loaded=1;
642: foreach my $expired_key (keys(%remove)) {
643: &delenv($expired_key);
644: }
645: }
646:
647: # ---------------------------------------------------- Check for valid session
648: sub check_for_valid_session {
649: my ($r,$name,$userhashref) = @_;
650: my %cookies=CGI::Cookie->parse($r->header_in('Cookie'));
651: if ($name eq '') {
652: $name = 'lonID';
653: }
654: my $lonid=$cookies{$name};
655: return undef if (!$lonid);
656:
657: my $handle=&LONCAPA::clean_handle($lonid->value);
658: my $lonidsdir;
659: if ($name eq 'lonDAV') {
660: $lonidsdir=$r->dir_config('lonDAVsessDir');
661: } else {
662: $lonidsdir=$r->dir_config('lonIDsDir');
663: }
664: return undef if (!-e "$lonidsdir/$handle.id");
665:
666: my $opened = open(my $idf,'+<',"$lonidsdir/$handle.id");
667: return undef if (!$opened);
668:
669: flock($idf,LOCK_SH);
670: my %disk_env;
671: if (!tie(%disk_env,'GDBM_File',"$lonidsdir/$handle.id",
672: &GDBM_READER(),0640)) {
673: return undef;
674: }
675:
676: if (!defined($disk_env{'user.name'})
677: || !defined($disk_env{'user.domain'})) {
678: return undef;
679: }
680:
681: if (ref($userhashref) eq 'HASH') {
682: $userhashref->{'name'} = $disk_env{'user.name'};
683: $userhashref->{'domain'} = $disk_env{'user.domain'};
684: }
685:
686: return $handle;
687: }
688:
689: sub timed_flock {
690: my ($file,$lock_type) = @_;
691: my $failed=0;
692: eval {
693: local $SIG{__DIE__}='DEFAULT';
694: local $SIG{ALRM}=sub {
695: $failed=1;
696: die("failed lock");
697: };
698: alarm(13);
699: flock($file,$lock_type);
700: alarm(0);
701: };
702: if ($failed) {
703: return undef;
704: } else {
705: return 1;
706: }
707: }
708:
709: # ---------------------------------------------------------- Append Environment
710:
711: sub appenv {
712: my ($newenv,$roles) = @_;
713: if (ref($newenv) eq 'HASH') {
714: foreach my $key (keys(%{$newenv})) {
715: my $refused = 0;
716: if (($key =~ /^user\.role/) || ($key =~ /^user\.priv/)) {
717: $refused = 1;
718: if (ref($roles) eq 'ARRAY') {
719: my ($type,$role) = ($key =~ m{^user\.(role|priv)\.(.+?)\./});
720: if (grep(/^\Q$role\E$/,@{$roles})) {
721: $refused = 0;
722: }
723: }
724: }
725: if ($refused) {
726: &logthis("<font color=\"blue\">WARNING: ".
727: "Attempt to modify environment ".$key." to ".$newenv->{$key}
728: .'</font>');
729: delete($newenv->{$key});
730: } else {
731: $env{$key}=$newenv->{$key};
732: }
733: }
734: my $opened = open(my $env_file,'+<',$env{'user.environment'});
735: if ($opened
736: && &timed_flock($env_file,LOCK_EX)
737: &&
738: tie(my %disk_env,'GDBM_File',$env{'user.environment'},
739: (&GDBM_WRITER()|&GDBM_NOLOCK()),0640)) {
740: while (my ($key,$value) = each(%{$newenv})) {
741: $disk_env{$key} = $value;
742: }
743: untie(%disk_env);
744: }
745: }
746: return 'ok';
747: }
748: # ----------------------------------------------------- Delete from Environment
749:
750: sub delenv {
751: my ($delthis,$regexp,$roles) = @_;
752: if (($delthis=~/^user\.role/) || ($delthis=~/^user\.priv/)) {
753: my $refused = 1;
754: if (ref($roles) eq 'ARRAY') {
755: my ($type,$role) = ($delthis =~ /^user\.(role|priv)\.([^.]+)\./);
756: if (grep(/^\Q$role\E$/,@{$roles})) {
757: $refused = 0;
758: }
759: }
760: if ($refused) {
761: &logthis("<font color=\"blue\">WARNING: ".
762: "Attempt to delete from environment ".$delthis);
763: return 'error';
764: }
765: }
766: my $opened = open(my $env_file,'+<',$env{'user.environment'});
767: if ($opened
768: && &timed_flock($env_file,LOCK_EX)
769: &&
770: tie(my %disk_env,'GDBM_File',$env{'user.environment'},
771: (&GDBM_WRITER()|&GDBM_NOLOCK()),0640)) {
772: foreach my $key (keys(%disk_env)) {
773: if ($regexp) {
774: if ($key=~/^$delthis/) {
775: delete($env{$key});
776: delete($disk_env{$key});
777: }
778: } else {
779: if ($key=~/^\Q$delthis\E/) {
780: delete($env{$key});
781: delete($disk_env{$key});
782: }
783: }
784: }
785: untie(%disk_env);
786: }
787: return 'ok';
788: }
789:
790: sub get_env_multiple {
791: my ($name) = @_;
792: my @values;
793: if (defined($env{$name})) {
794: # exists is it an array
795: if (ref($env{$name})) {
796: @values=@{ $env{$name} };
797: } else {
798: $values[0]=$env{$name};
799: }
800: }
801: return(@values);
802: }
803:
804: # ------------------------------------------------------------------- Locking
805:
806: sub set_lock {
807: my ($text)=@_;
808: $locknum++;
809: my $id=$$.'-'.$locknum;
810: &appenv({'session.locks' => $env{'session.locks'}.','.$id,
811: 'session.lock.'.$id => $text});
812: return $id;
813: }
814:
815: sub get_locks {
816: my $num=0;
817: my %texts=();
818: foreach my $lock (split(/\,/,$env{'session.locks'})) {
819: if ($lock=~/\w/) {
820: $num++;
821: $texts{$lock}=$env{'session.lock.'.$lock};
822: }
823: }
824: return ($num,%texts);
825: }
826:
827: sub remove_lock {
828: my ($id)=@_;
829: my $newlocks='';
830: foreach my $lock (split(/\,/,$env{'session.locks'})) {
831: if (($lock=~/\w/) && ($lock ne $id)) {
832: $newlocks.=','.$lock;
833: }
834: }
835: &appenv({'session.locks' => $newlocks});
836: &delenv('session.lock.'.$id);
837: }
838:
839: sub remove_all_locks {
840: my $activelocks=$env{'session.locks'};
841: foreach my $lock (split(/\,/,$env{'session.locks'})) {
842: if ($lock=~/\w/) {
843: &remove_lock($lock);
844: }
845: }
846: }
847:
848:
849: # ------------------------------------------ Find out current server userload
850: sub userload {
851: my $numusers=0;
852: {
853: opendir(LONIDS,$perlvar{'lonIDsDir'});
854: my $filename;
855: my $curtime=time;
856: while ($filename=readdir(LONIDS)) {
857: next if ($filename eq '.' || $filename eq '..');
858: next if ($filename =~ /publicuser_\d+\.id/);
859: my ($mtime)=(stat($perlvar{'lonIDsDir'}.'/'.$filename))[9];
860: if ($curtime-$mtime < 1800) { $numusers++; }
861: }
862: closedir(LONIDS);
863: }
864: my $userloadpercent=0;
865: my $maxuserload=$perlvar{'lonUserLoadLim'};
866: if ($maxuserload) {
867: $userloadpercent=100*$numusers/$maxuserload;
868: }
869: $userloadpercent=sprintf("%.2f",$userloadpercent);
870: return $userloadpercent;
871: }
872:
873: # ------------------------------ Find server with least workload from spare.tab
874:
875: sub spareserver {
876: my ($loadpercent,$userloadpercent,$want_server_name,$udom) = @_;
877: my $spare_server;
878: if ($userloadpercent !~ /\d/) { $userloadpercent=0; }
879: my $lowest_load=($loadpercent > $userloadpercent) ? $loadpercent
880: : $userloadpercent;
881: my ($uint_dom,$remotesessions);
882: if (($udom ne '') && (&domain($udom) ne '')) {
883: my $uprimary_id = &Apache::lonnet::domain($udom,'primary');
884: $uint_dom = &Apache::lonnet::internet_dom($uprimary_id);
885: my %udomdefaults = &Apache::lonnet::get_domain_defaults($udom);
886: $remotesessions = $udomdefaults{'remotesessions'};
887: }
888: my $spareshash = &this_host_spares($udom);
889: if (ref($spareshash) eq 'HASH') {
890: if (ref($spareshash->{'primary'}) eq 'ARRAY') {
891: foreach my $try_server (@{ $spareshash->{'primary'} }) {
892: next unless (&spare_can_host($udom,$uint_dom,$remotesessions,
893: $try_server));
894: ($spare_server, $lowest_load) =
895: &compare_server_load($try_server, $spare_server, $lowest_load);
896: }
897: }
898:
899: my $found_server = ($spare_server ne '' && $lowest_load < 100);
900:
901: if (!$found_server) {
902: if (ref($spareshash->{'default'}) eq 'ARRAY') {
903: foreach my $try_server (@{ $spareshash->{'default'} }) {
904: next unless (&spare_can_host($udom,$uint_dom,
905: $remotesessions,$try_server));
906: ($spare_server, $lowest_load) =
907: &compare_server_load($try_server, $spare_server, $lowest_load);
908: }
909: }
910: }
911: }
912:
913: if (!$want_server_name) {
914: my $protocol = 'http';
915: if ($protocol{$spare_server} eq 'https') {
916: $protocol = $protocol{$spare_server};
917: }
918: if (defined($spare_server)) {
919: my $hostname = &hostname($spare_server);
920: if (defined($hostname)) {
921: $spare_server = $protocol.'://'.$hostname;
922: }
923: }
924: }
925: return $spare_server;
926: }
927:
928: sub compare_server_load {
929: my ($try_server, $spare_server, $lowest_load, $required) = @_;
930:
931: if ($required) {
932: my ($reqdmajor,$reqdminor) = ($required =~ /^(\d+)\.(\d+)$/);
933: my $remoterev = &get_server_loncaparev(undef,$try_server);
934: my ($major,$minor) = ($remoterev =~ /^\'?(\d+)\.(\d+)\.[\w.\-]+\'?$/);
935: if (($major eq '' && $minor eq '') ||
936: (($reqdmajor > $major) || (($reqdmajor == $major) && ($reqdminor > $minor)))) {
937: return ($spare_server,$lowest_load);
938: }
939: }
940:
941: my $loadans = &reply('load', $try_server);
942: my $userloadans = &reply('userload',$try_server);
943:
944: if ($loadans !~ /\d/ && $userloadans !~ /\d/) {
945: return ($spare_server, $lowest_load); #didn't get a number from the server
946: }
947:
948: my $load;
949: if ($loadans =~ /\d/) {
950: if ($userloadans =~ /\d/) {
951: #both are numbers, pick the bigger one
952: $load = ($loadans > $userloadans) ? $loadans
953: : $userloadans;
954: } else {
955: $load = $loadans;
956: }
957: } else {
958: $load = $userloadans;
959: }
960:
961: if (($load =~ /\d/) && ($load < $lowest_load)) {
962: $spare_server = $try_server;
963: $lowest_load = $load;
964: }
965: return ($spare_server,$lowest_load);
966: }
967:
968: # --------------------------- ask offload servers if user already has a session
969: sub find_existing_session {
970: my ($udom,$uname) = @_;
971: my $spareshash = &this_host_spares($udom);
972: if (ref($spareshash) eq 'HASH') {
973: if (ref($spareshash->{'primary'}) eq 'ARRAY') {
974: foreach my $try_server (@{ $spareshash->{'primary'} }) {
975: return $try_server if (&has_user_session($try_server, $udom, $uname));
976: }
977: }
978: if (ref($spareshash->{'default'}) eq 'ARRAY') {
979: foreach my $try_server (@{ $spareshash->{'default'} }) {
980: return $try_server if (&has_user_session($try_server, $udom, $uname));
981: }
982: }
983: }
984: return;
985: }
986:
987: # -------------------------------- ask if server already has a session for user
988: sub has_user_session {
989: my ($lonid,$udom,$uname) = @_;
990: my $result = &reply(join(':','userhassession',
991: map {&escape($_)} ($udom,$uname)),$lonid);
992: return 1 if ($result eq 'ok');
993:
994: return 0;
995: }
996:
997: # --------- determine least loaded server in a user's domain which allows login
998:
999: sub choose_server {
1000: my ($udom,$checkloginvia,$required,$skiploadbal) = @_;
1001: my %domconfhash = &Apache::loncommon::get_domainconf($udom);
1002: my %servers = &get_servers($udom);
1003: my $lowest_load = 30000;
1004: my ($login_host,$hostname,$portal_path,$isredirect,$balancers);
1005: if ($skiploadbal) {
1006: ($balancers,my $cached)=&is_cached_new('loadbalancing',$udom);
1007: unless (defined($cached)) {
1008: my $cachetime = 60*60*24;
1009: my %domconfig =
1010: &Apache::lonnet::get_dom('configuration',['loadbalancing'],$udom);
1011: if (ref($domconfig{'loadbalancing'}) eq 'HASH') {
1012: $balancers = &do_cache_new('loadbalancing',$udom,$domconfig{'loadbalancing'},
1013: $cachetime);
1014: }
1015: }
1016: }
1017: foreach my $lonhost (keys(%servers)) {
1018: if ($skiploadbal) {
1019: if (ref($balancers) eq 'HASH') {
1020: next if (exists($balancers->{$lonhost}));
1021: }
1022: }
1023: my $loginvia;
1024: if ($checkloginvia) {
1025: $loginvia = $domconfhash{$udom.'.login.loginvia_'.$lonhost};
1026: if ($loginvia) {
1027: my ($server,$path) = split(/:/,$loginvia);
1028: ($login_host, $lowest_load) =
1029: &compare_server_load($server, $login_host, $lowest_load, $required);
1030: if ($login_host eq $server) {
1031: $portal_path = $path;
1032: $isredirect = 1;
1033: }
1034: } else {
1035: ($login_host, $lowest_load) =
1036: &compare_server_load($lonhost, $login_host, $lowest_load, $required);
1037: if ($login_host eq $lonhost) {
1038: $portal_path = '';
1039: $isredirect = '';
1040: }
1041: }
1042: } else {
1043: ($login_host, $lowest_load) =
1044: &compare_server_load($lonhost, $login_host, $lowest_load, $required);
1045: }
1046: }
1047: if ($login_host ne '') {
1048: $hostname = &hostname($login_host);
1049: }
1050: return ($login_host,$hostname,$portal_path,$isredirect);
1051: }
1052:
1053: # --------------------------------------------- Try to change a user's password
1054:
1055: sub changepass {
1056: my ($uname,$udom,$currentpass,$newpass,$server,$context)=@_;
1057: $currentpass = &escape($currentpass);
1058: $newpass = &escape($newpass);
1059: my $lonhost = $perlvar{'lonHostID'};
1060: my $answer = reply("encrypt:passwd:$udom:$uname:$currentpass:$newpass:$context:$lonhost",
1061: $server);
1062: if (! $answer) {
1063: &logthis("No reply on password change request to $server ".
1064: "by $uname in domain $udom.");
1065: } elsif ($answer =~ "^ok") {
1066: &logthis("$uname in $udom successfully changed their password ".
1067: "on $server.");
1068: } elsif ($answer =~ "^pwchange_failure") {
1069: &logthis("$uname in $udom was unable to change their password ".
1070: "on $server. The action was blocked by either lcpasswd ".
1071: "or pwchange");
1072: } elsif ($answer =~ "^non_authorized") {
1073: &logthis("$uname in $udom did not get their password correct when ".
1074: "attempting to change it on $server.");
1075: } elsif ($answer =~ "^auth_mode_error") {
1076: &logthis("$uname in $udom attempted to change their password despite ".
1077: "not being locally or internally authenticated on $server.");
1078: } elsif ($answer =~ "^unknown_user") {
1079: &logthis("$uname in $udom attempted to change their password ".
1080: "on $server but were unable to because $server is not ".
1081: "their home server.");
1082: } elsif ($answer =~ "^refused") {
1083: &logthis("$server refused to change $uname in $udom password because ".
1084: "it was sent an unencrypted request to change the password.");
1085: } elsif ($answer =~ "invalid_client") {
1086: &logthis("$server refused to change $uname in $udom password because ".
1087: "it was a reset by e-mail originating from an invalid server.");
1088: }
1089: return $answer;
1090: }
1091:
1092: # ----------------------- Try to determine user's current authentication scheme
1093:
1094: sub queryauthenticate {
1095: my ($uname,$udom)=@_;
1096: my $uhome=&homeserver($uname,$udom);
1097: if (!$uhome) {
1098: &logthis("User $uname at $udom is unknown when looking for authentication mechanism");
1099: return 'no_host';
1100: }
1101: my $answer=reply("encrypt:currentauth:$udom:$uname",$uhome);
1102: if ($answer =~ /^(unknown_user|refused|con_lost)/) {
1103: &logthis("User $uname at $udom threw error $answer when checking authentication mechanism");
1104: }
1105: return $answer;
1106: }
1107:
1108: # --------- Try to authenticate user from domain's lib servers (first this one)
1109:
1110: sub authenticate {
1111: my ($uname,$upass,$udom,$checkdefauth,$clientcancheckhost)=@_;
1112: $upass=&escape($upass);
1113: $uname= &LONCAPA::clean_username($uname);
1114: my $uhome=&homeserver($uname,$udom,1);
1115: my $newhome;
1116: if ((!$uhome) || ($uhome eq 'no_host')) {
1117: # Maybe the machine was offline and only re-appeared again recently?
1118: &reconlonc();
1119: # One more
1120: $uhome=&homeserver($uname,$udom,1);
1121: if (($uhome eq 'no_host') && $checkdefauth) {
1122: if (defined(&domain($udom,'primary'))) {
1123: $newhome=&domain($udom,'primary');
1124: }
1125: if ($newhome ne '') {
1126: $uhome = $newhome;
1127: }
1128: }
1129: if ((!$uhome) || ($uhome eq 'no_host')) {
1130: &logthis("User $uname at $udom is unknown in authenticate");
1131: return 'no_host';
1132: }
1133: }
1134: my $answer=reply("encrypt:auth:$udom:$uname:$upass:$checkdefauth:$clientcancheckhost",$uhome);
1135: if ($answer eq 'authorized') {
1136: if ($newhome) {
1137: &logthis("User $uname at $udom authorized by $uhome, but needs account");
1138: return 'no_account_on_host';
1139: } else {
1140: &logthis("User $uname at $udom authorized by $uhome");
1141: return $uhome;
1142: }
1143: }
1144: if ($answer eq 'non_authorized') {
1145: &logthis("User $uname at $udom rejected by $uhome");
1146: return 'no_host';
1147: }
1148: &logthis("User $uname at $udom threw error $answer when checking authentication mechanism");
1149: return 'no_host';
1150: }
1151:
1152: sub can_host_session {
1153: my ($udom,$lonhost,$remoterev,$remotesessions,$hostedsessions) = @_;
1154: my $canhost = 1;
1155: my $host_idn = &Apache::lonnet::internet_dom($lonhost);
1156: if (ref($remotesessions) eq 'HASH') {
1157: if (ref($remotesessions->{'excludedomain'}) eq 'ARRAY') {
1158: if (grep(/^\Q$host_idn\E$/,@{$remotesessions->{'excludedomain'}})) {
1159: $canhost = 0;
1160: } else {
1161: $canhost = 1;
1162: }
1163: }
1164: if (ref($remotesessions->{'includedomain'}) eq 'ARRAY') {
1165: if (grep(/^\Q$host_idn\E$/,@{$remotesessions->{'includedomain'}})) {
1166: $canhost = 1;
1167: } else {
1168: $canhost = 0;
1169: }
1170: }
1171: if ($canhost) {
1172: if ($remotesessions->{'version'} ne '') {
1173: my ($reqmajor,$reqminor) = ($remotesessions->{'version'} =~ /^(\d+)\.(\d+)$/);
1174: if ($reqmajor ne '' && $reqminor ne '') {
1175: if ($remoterev =~ /^\'?(\d+)\.(\d+)/) {
1176: my $major = $1;
1177: my $minor = $2;
1178: if (($major < $reqmajor ) ||
1179: (($major == $reqmajor) && ($minor < $reqminor))) {
1180: $canhost = 0;
1181: }
1182: } else {
1183: $canhost = 0;
1184: }
1185: }
1186: }
1187: }
1188: }
1189: if ($canhost) {
1190: if (ref($hostedsessions) eq 'HASH') {
1191: my $uprimary_id = &Apache::lonnet::domain($udom,'primary');
1192: my $uint_dom = &Apache::lonnet::internet_dom($uprimary_id);
1193: if (ref($hostedsessions->{'excludedomain'}) eq 'ARRAY') {
1194: if (($uint_dom ne '') &&
1195: (grep(/^\Q$uint_dom\E$/,@{$hostedsessions->{'excludedomain'}}))) {
1196: $canhost = 0;
1197: } else {
1198: $canhost = 1;
1199: }
1200: }
1201: if (ref($hostedsessions->{'includedomain'}) eq 'ARRAY') {
1202: if (($uint_dom ne '') &&
1203: (grep(/^\Q$uint_dom\E$/,@{$hostedsessions->{'includedomain'}}))) {
1204: $canhost = 1;
1205: } else {
1206: $canhost = 0;
1207: }
1208: }
1209: }
1210: }
1211: return $canhost;
1212: }
1213:
1214: sub spare_can_host {
1215: my ($udom,$uint_dom,$remotesessions,$try_server)=@_;
1216: my $canhost=1;
1217: my $try_server_hostname = &hostname($try_server);
1218: my $serverhomeID = &get_server_homeID($try_server_hostname);
1219: my $serverhomedom = &host_domain($serverhomeID);
1220: my %defdomdefaults = &get_domain_defaults($serverhomedom);
1221: if (ref($defdomdefaults{'offloadnow'}) eq 'HASH') {
1222: if ($defdomdefaults{'offloadnow'}{$try_server}) {
1223: $canhost = 0;
1224: }
1225: }
1226: if (($canhost) && ($uint_dom)) {
1227: my @intdoms;
1228: my $internet_names = &get_internet_names($try_server);
1229: if (ref($internet_names) eq 'ARRAY') {
1230: @intdoms = @{$internet_names};
1231: }
1232: unless (grep(/^\Q$uint_dom\E$/,@intdoms)) {
1233: my $remoterev = &get_server_loncaparev(undef,$try_server);
1234: $canhost = &can_host_session($udom,$try_server,$remoterev,
1235: $remotesessions,
1236: $defdomdefaults{'hostedsessions'});
1237: }
1238: }
1239: return $canhost;
1240: }
1241:
1242: sub this_host_spares {
1243: my ($dom) = @_;
1244: my ($dom_in_use,$lonhost_in_use,$result);
1245: my @hosts = ¤t_machine_ids();
1246: foreach my $lonhost (@hosts) {
1247: if (&host_domain($lonhost) eq $dom) {
1248: $dom_in_use = $dom;
1249: $lonhost_in_use = $lonhost;
1250: last;
1251: }
1252: }
1253: if ($dom_in_use ne '') {
1254: $result = &spares_for_offload($dom_in_use,$lonhost_in_use);
1255: }
1256: if (ref($result) ne 'HASH') {
1257: $lonhost_in_use = $perlvar{'lonHostID'};
1258: $dom_in_use = &host_domain($lonhost_in_use);
1259: $result = &spares_for_offload($dom_in_use,$lonhost_in_use);
1260: if (ref($result) ne 'HASH') {
1261: $result = \%spareid;
1262: }
1263: }
1264: return $result;
1265: }
1266:
1267: sub spares_for_offload {
1268: my ($dom_in_use,$lonhost_in_use) = @_;
1269: my ($result,$cached)=&is_cached_new('spares',$dom_in_use);
1270: if (defined($cached)) {
1271: return $result;
1272: } else {
1273: my $cachetime = 60*60*24;
1274: my %domconfig =
1275: &Apache::lonnet::get_dom('configuration',['usersessions'],$dom_in_use);
1276: if (ref($domconfig{'usersessions'}) eq 'HASH') {
1277: if (ref($domconfig{'usersessions'}{'spares'}) eq 'HASH') {
1278: if (ref($domconfig{'usersessions'}{'spares'}{$lonhost_in_use}) eq 'HASH') {
1279: return &do_cache_new('spares',$dom_in_use,$domconfig{'usersessions'}{'spares'}{$lonhost_in_use},$cachetime);
1280: }
1281: }
1282: }
1283: }
1284: return;
1285: }
1286:
1287: sub get_lonbalancer_config {
1288: my ($servers) = @_;
1289: my ($currbalancer,$currtargets);
1290: if (ref($servers) eq 'HASH') {
1291: foreach my $server (keys(%{$servers})) {
1292: my %what = (
1293: spareid => 1,
1294: perlvar => 1,
1295: );
1296: my ($result,$returnhash) = &get_remote_globals($server,\%what);
1297: if ($result eq 'ok') {
1298: if (ref($returnhash) eq 'HASH') {
1299: if (ref($returnhash->{'perlvar'}) eq 'HASH') {
1300: if ($returnhash->{'perlvar'}->{'lonBalancer'} eq 'yes') {
1301: $currbalancer = $server;
1302: $currtargets = {};
1303: if (ref($returnhash->{'spareid'}) eq 'HASH') {
1304: if (ref($returnhash->{'spareid'}->{'primary'}) eq 'ARRAY') {
1305: $currtargets->{'primary'} = $returnhash->{'spareid'}->{'primary'};
1306: }
1307: if (ref($returnhash->{'spareid'}->{'default'}) eq 'ARRAY') {
1308: $currtargets->{'default'} = $returnhash->{'spareid'}->{'default'};
1309: }
1310: }
1311: last;
1312: }
1313: }
1314: }
1315: }
1316: }
1317: }
1318: return ($currbalancer,$currtargets);
1319: }
1320:
1321: sub check_loadbalancing {
1322: my ($uname,$udom) = @_;
1323: my ($is_balancer,$currtargets,$currrules,$dom_in_use,$homeintdom,
1324: $rule_in_effect,$offloadto,$otherserver);
1325: my $lonhost = $perlvar{'lonHostID'};
1326: my @hosts = ¤t_machine_ids();
1327: my $uprimary_id = &Apache::lonnet::domain($udom,'primary');
1328: my $uintdom = &Apache::lonnet::internet_dom($uprimary_id);
1329: my $intdom = &Apache::lonnet::internet_dom($lonhost);
1330: my $serverhomedom = &host_domain($lonhost);
1331: my $domneedscache;
1332: my $cachetime = 60*60*24;
1333:
1334: if (($uintdom ne '') && ($uintdom eq $intdom)) {
1335: $dom_in_use = $udom;
1336: $homeintdom = 1;
1337: } else {
1338: $dom_in_use = $serverhomedom;
1339: }
1340: my ($result,$cached)=&is_cached_new('loadbalancing',$dom_in_use);
1341: unless (defined($cached)) {
1342: my %domconfig =
1343: &Apache::lonnet::get_dom('configuration',['loadbalancing'],$dom_in_use);
1344: if (ref($domconfig{'loadbalancing'}) eq 'HASH') {
1345: $result = &do_cache_new('loadbalancing',$dom_in_use,$domconfig{'loadbalancing'},$cachetime);
1346: } else {
1347: $domneedscache = $dom_in_use;
1348: }
1349: }
1350: if (ref($result) eq 'HASH') {
1351: ($is_balancer,$currtargets,$currrules) =
1352: &check_balancer_result($result,@hosts);
1353: if ($is_balancer) {
1354: if (ref($currrules) eq 'HASH') {
1355: if ($homeintdom) {
1356: if ($uname ne '') {
1357: if (($currrules->{'_LC_adv'} ne '') || ($currrules->{'_LC_author'} ne '')) {
1358: my ($is_adv,$is_author) = &is_advanced_user($udom,$uname);
1359: if (($currrules->{'_LC_author'} ne '') && ($is_author)) {
1360: $rule_in_effect = $currrules->{'_LC_author'};
1361: } elsif (($currrules->{'_LC_adv'} ne '') && ($is_adv)) {
1362: $rule_in_effect = $currrules->{'_LC_adv'}
1363: }
1364: }
1365: if ($rule_in_effect eq '') {
1366: my %userenv = &userenvironment($udom,$uname,'inststatus');
1367: if ($userenv{'inststatus'} ne '') {
1368: my @statuses = map { &unescape($_); } split(/:/,$userenv{'inststatus'});
1369: my ($othertitle,$usertypes,$types) =
1370: &Apache::loncommon::sorted_inst_types($udom);
1371: if (ref($types) eq 'ARRAY') {
1372: foreach my $type (@{$types}) {
1373: if (grep(/^\Q$type\E$/,@statuses)) {
1374: if (exists($currrules->{$type})) {
1375: $rule_in_effect = $currrules->{$type};
1376: }
1377: }
1378: }
1379: }
1380: } else {
1381: if (exists($currrules->{'default'})) {
1382: $rule_in_effect = $currrules->{'default'};
1383: }
1384: }
1385: }
1386: } else {
1387: if (exists($currrules->{'default'})) {
1388: $rule_in_effect = $currrules->{'default'};
1389: }
1390: }
1391: } else {
1392: if ($currrules->{'_LC_external'} ne '') {
1393: $rule_in_effect = $currrules->{'_LC_external'};
1394: }
1395: }
1396: $offloadto = &get_loadbalancer_targets($rule_in_effect,$currtargets,
1397: $uname,$udom);
1398: }
1399: }
1400: } elsif (($homeintdom) && ($udom ne $serverhomedom)) {
1401: ($result,$cached)=&is_cached_new('loadbalancing',$serverhomedom);
1402: unless (defined($cached)) {
1403: my %domconfig =
1404: &Apache::lonnet::get_dom('configuration',['loadbalancing'],$serverhomedom);
1405: if (ref($domconfig{'loadbalancing'}) eq 'HASH') {
1406: $result = &do_cache_new('loadbalancing',$serverhomedom,$domconfig{'loadbalancing'},$cachetime);
1407: } else {
1408: $domneedscache = $serverhomedom;
1409: }
1410: }
1411: if (ref($result) eq 'HASH') {
1412: ($is_balancer,$currtargets,$currrules) =
1413: &check_balancer_result($result,@hosts);
1414: if ($is_balancer) {
1415: if (ref($currrules) eq 'HASH') {
1416: if ($currrules->{'_LC_internetdom'} ne '') {
1417: $rule_in_effect = $currrules->{'_LC_internetdom'};
1418: }
1419: }
1420: $offloadto = &get_loadbalancer_targets($rule_in_effect,$currtargets,
1421: $uname,$udom);
1422: }
1423: } else {
1424: if ($perlvar{'lonBalancer'} eq 'yes') {
1425: $is_balancer = 1;
1426: $offloadto = &this_host_spares($dom_in_use);
1427: }
1428: unless (defined($cached)) {
1429: $domneedscache = $serverhomedom;
1430: }
1431: }
1432: } else {
1433: if ($perlvar{'lonBalancer'} eq 'yes') {
1434: $is_balancer = 1;
1435: $offloadto = &this_host_spares($dom_in_use);
1436: }
1437: unless (defined($cached)) {
1438: $domneedscache = $serverhomedom;
1439: }
1440: }
1441: if ($domneedscache) {
1442: &do_cache_new('loadbalancing',$domneedscache,$is_balancer,$cachetime);
1443: }
1444: if ($is_balancer) {
1445: my $lowest_load = 30000;
1446: if (ref($offloadto) eq 'HASH') {
1447: if (ref($offloadto->{'primary'}) eq 'ARRAY') {
1448: foreach my $try_server (@{$offloadto->{'primary'}}) {
1449: ($otherserver,$lowest_load) =
1450: &compare_server_load($try_server,$otherserver,$lowest_load);
1451: }
1452: }
1453: my $found_server = ($otherserver ne '' && $lowest_load < 100);
1454:
1455: if (!$found_server) {
1456: if (ref($offloadto->{'default'}) eq 'ARRAY') {
1457: foreach my $try_server (@{$offloadto->{'default'}}) {
1458: ($otherserver,$lowest_load) =
1459: &compare_server_load($try_server,$otherserver,$lowest_load);
1460: }
1461: }
1462: }
1463: } elsif (ref($offloadto) eq 'ARRAY') {
1464: if (@{$offloadto} == 1) {
1465: $otherserver = $offloadto->[0];
1466: } elsif (@{$offloadto} > 1) {
1467: foreach my $try_server (@{$offloadto}) {
1468: ($otherserver,$lowest_load) =
1469: &compare_server_load($try_server,$otherserver,$lowest_load);
1470: }
1471: }
1472: }
1473: if (($otherserver ne '') && (grep(/^\Q$otherserver\E$/,@hosts))) {
1474: $is_balancer = 0;
1475: if ($uname ne '' && $udom ne '') {
1476: if (($env{'user.name'} eq $uname) && ($env{'user.domain'} eq $udom)) {
1477:
1478: &appenv({'user.loadbalexempt' => $lonhost,
1479: 'user.loadbalcheck.time' => time});
1480: }
1481: }
1482: }
1483: }
1484: return ($is_balancer,$otherserver);
1485: }
1486:
1487: sub check_balancer_result {
1488: my ($result,@hosts) = @_;
1489: my ($is_balancer,$currtargets,$currrules);
1490: if (ref($result) eq 'HASH') {
1491: if ($result->{'lonhost'} ne '') {
1492: my $currbalancer = $result->{'lonhost'};
1493: if (grep(/^\Q$currbalancer\E$/,@hosts)) {
1494: $is_balancer = 1;
1495: $currtargets = $result->{'targets'};
1496: $currrules = $result->{'rules'};
1497: }
1498: } else {
1499: foreach my $key (keys(%{$result})) {
1500: if (($key ne '') && (grep(/^\Q$key\E$/,@hosts)) &&
1501: (ref($result->{$key}) eq 'HASH')) {
1502: $is_balancer = 1;
1503: $currrules = $result->{$key}{'rules'};
1504: $currtargets = $result->{$key}{'targets'};
1505: last;
1506: }
1507: }
1508: }
1509: }
1510: return ($is_balancer,$currtargets,$currrules);
1511: }
1512:
1513: sub get_loadbalancer_targets {
1514: my ($rule_in_effect,$currtargets,$uname,$udom) = @_;
1515: my $offloadto;
1516: if ($rule_in_effect eq 'none') {
1517: return [$perlvar{'lonHostID'}];
1518: } elsif ($rule_in_effect eq '') {
1519: $offloadto = $currtargets;
1520: } else {
1521: if ($rule_in_effect eq 'homeserver') {
1522: my $homeserver = &homeserver($uname,$udom);
1523: if ($homeserver ne 'no_host') {
1524: $offloadto = [$homeserver];
1525: }
1526: } elsif ($rule_in_effect eq 'externalbalancer') {
1527: my %domconfig =
1528: &Apache::lonnet::get_dom('configuration',['loadbalancing'],$udom);
1529: if (ref($domconfig{'loadbalancing'}) eq 'HASH') {
1530: if ($domconfig{'loadbalancing'}{'lonhost'} ne '') {
1531: if (&hostname($domconfig{'loadbalancing'}{'lonhost'}) ne '') {
1532: $offloadto = [$domconfig{'loadbalancing'}{'lonhost'}];
1533: }
1534: }
1535: } else {
1536: my %servers = &internet_dom_servers($udom);
1537: my ($remotebalancer,$remotetargets) = &get_lonbalancer_config(\%servers);
1538: if (&hostname($remotebalancer) ne '') {
1539: $offloadto = [$remotebalancer];
1540: }
1541: }
1542: } elsif (&hostname($rule_in_effect) ne '') {
1543: $offloadto = [$rule_in_effect];
1544: }
1545: }
1546: return $offloadto;
1547: }
1548:
1549: sub internet_dom_servers {
1550: my ($dom) = @_;
1551: my (%uniqservers,%servers);
1552: my $primaryserver = &hostname(&domain($dom,'primary'));
1553: my @machinedoms = &machine_domains($primaryserver);
1554: foreach my $mdom (@machinedoms) {
1555: my %currservers = %servers;
1556: my %server = &get_servers($mdom);
1557: %servers = (%currservers,%server);
1558: }
1559: my %by_hostname;
1560: foreach my $id (keys(%servers)) {
1561: push(@{$by_hostname{$servers{$id}}},$id);
1562: }
1563: foreach my $hostname (sort(keys(%by_hostname))) {
1564: if (@{$by_hostname{$hostname}} > 1) {
1565: my $match = 0;
1566: foreach my $id (@{$by_hostname{$hostname}}) {
1567: if (&host_domain($id) eq $dom) {
1568: $uniqservers{$id} = $hostname;
1569: $match = 1;
1570: }
1571: }
1572: unless ($match) {
1573: $uniqservers{$by_hostname{$hostname}[0]} = $hostname;
1574: }
1575: } else {
1576: $uniqservers{$by_hostname{$hostname}[0]} = $hostname;
1577: }
1578: }
1579: return %uniqservers;
1580: }
1581:
1582: # ---------------------- Find the homebase for a user from domain's lib servers
1583:
1584: my %homecache;
1585: sub homeserver {
1586: my ($uname,$udom,$ignoreBadCache)=@_;
1587: my $index="$uname:$udom";
1588:
1589: if (exists($homecache{$index})) { return $homecache{$index}; }
1590:
1591: my %servers = &get_servers($udom,'library');
1592: foreach my $tryserver (keys(%servers)) {
1593: next if ($ignoreBadCache ne 'true' &&
1594: exists($badServerCache{$tryserver}));
1595:
1596: my $answer=reply("home:$udom:$uname",$tryserver);
1597: if ($answer eq 'found') {
1598: delete($badServerCache{$tryserver});
1599: return $homecache{$index}=$tryserver;
1600: } elsif ($answer eq 'no_host') {
1601: $badServerCache{$tryserver}=1;
1602: }
1603: }
1604: return 'no_host';
1605: }
1606:
1607: # ----- Find the usernames behind a list of student/employee IDs or clicker IDs
1608:
1609: sub idget {
1610: my ($udom,$idsref,$namespace)=@_;
1611: my %returnhash=();
1612: my @ids=();
1613: if (ref($idsref) eq 'ARRAY') {
1614: @ids = @{$idsref};
1615: } else {
1616: return %returnhash;
1617: }
1618: if ($namespace eq '') {
1619: $namespace = 'ids';
1620: }
1621:
1622: my %servers = &get_servers($udom,'library');
1623: foreach my $tryserver (keys(%servers)) {
1624: my $idlist=join('&', map { &escape($_); } @ids);
1625: if ($namespace eq 'ids') {
1626: $idlist=~tr/A-Z/a-z/;
1627: }
1628: my $reply;
1629: if ($namespace eq 'ids') {
1630: $reply=&reply("idget:$udom:".$idlist,$tryserver);
1631: } else {
1632: $reply=&reply("getdom:$udom:$namespace:$idlist",$tryserver);
1633: }
1634: my @answer=();
1635: if (($reply ne 'con_lost') && ($reply!~/^error\:/)) {
1636: @answer=split(/\&/,$reply);
1637: } ;
1638: my $i;
1639: for ($i=0;$i<=$#ids;$i++) {
1640: if ($answer[$i]) {
1641: $returnhash{$ids[$i]}=&unescape($answer[$i]);
1642: }
1643: }
1644: }
1645: return %returnhash;
1646: }
1647:
1648: # ------------------------------------- Find the IDs behind a list of usernames
1649:
1650: sub idrget {
1651: my ($udom,@unames)=@_;
1652: my %returnhash=();
1653: foreach my $uname (@unames) {
1654: $returnhash{$uname}=(&userenvironment($udom,$uname,'id'))[1];
1655: }
1656: return %returnhash;
1657: }
1658:
1659: # Store away a list of names and associated student/employee IDs or clicker IDs
1660:
1661: sub idput {
1662: my ($udom,$idsref,$uhom,$namespace)=@_;
1663: my %servers=();
1664: my %ids=();
1665: my %byid = ();
1666: if (ref($idsref) eq 'HASH') {
1667: %ids=%{$idsref};
1668: }
1669: if ($namespace eq '') {
1670: $namespace = 'ids';
1671: }
1672: foreach my $uname (keys(%ids)) {
1673: &cput('environment',{'id'=>$ids{$uname}},$udom,$uname);
1674: if ($uhom eq '') {
1675: $uhom=&homeserver($uname,$udom);
1676: }
1677: if ($uhom ne 'no_host') {
1678: my $esc_unam=&escape($uname);
1679: if ($namespace eq 'ids') {
1680: my $id=&escape($ids{$uname});
1681: $id=~tr/A-Z/a-z/;
1682: my $esc_unam=&escape($uname);
1683: $servers{$uhom}.=$id.'='.$esc_unam.'&';
1684: } else {
1685: my @currids = split(/,/,$ids{$uname});
1686: foreach my $id (@currids) {
1687: $byid{$uhom}{$id} .= $uname.',';
1688: }
1689: }
1690: }
1691: }
1692: if ($namespace eq 'clickers') {
1693: foreach my $server (keys(%byid)) {
1694: if (ref($byid{$server}) eq 'HASH') {
1695: foreach my $id (keys(%{$byid{$server}})) {
1696: $byid{$server} =~ s/,$//;
1697: $servers{$uhom}.=&escape($id).'='.&escape($byid{$server}).'&';
1698: }
1699: }
1700: }
1701: }
1702: foreach my $server (keys(%servers)) {
1703: $servers{$server} =~ s/\&$//;
1704: if ($namespace eq 'ids') {
1705: &critical('idput:'.$udom.':'.$servers{$server},$server);
1706: } else {
1707: &critical('updateclickers:'.$udom.':add:'.$servers{$server},$server);
1708: }
1709: }
1710: }
1711:
1712: # ------------- Delete unwanted student/employee IDs or clicker IDs from domain
1713:
1714: sub iddel {
1715: my ($udom,$idshashref,$uhome,$namespace)=@_;
1716: my %result=();
1717: my %ids=();
1718: my %byid = ();
1719: if (ref($idshashref) eq 'HASH') {
1720: %ids=%{$idshashref};
1721: } else {
1722: return %result;
1723: }
1724: if ($namespace eq '') {
1725: $namespace = 'ids';
1726: }
1727: my %servers=();
1728: while (my ($id,$unamestr) = each(%ids)) {
1729: if ($namespace eq 'ids') {
1730: my $uhom = $uhome;
1731: if ($uhom eq '') {
1732: $uhom=&homeserver($unamestr,$udom);
1733: }
1734: if ($uhom ne 'no_host') {
1735: $servers{$uhom}.='&'.&escape($id);
1736: }
1737: } else {
1738: my @curritems = split(/,/,$ids{$id});
1739: foreach my $uname (@curritems) {
1740: my $uhom = $uhome;
1741: if ($uhom eq '') {
1742: $uhom=&homeserver($uname,$udom);
1743: }
1744: if ($uhom ne 'no_host') {
1745: $byid{$uhom}{$id} .= $uname.',';
1746: }
1747: }
1748: }
1749: }
1750: if ($namespace eq 'clickers') {
1751: foreach my $server (keys(%byid)) {
1752: if (ref($byid{$server}) eq 'HASH') {
1753: foreach my $id (keys(%{$byid{$server}})) {
1754: $byid{$server}{$id} =~ s/,$//;
1755: $servers{$server}.=&escape($id).'='.&escape($byid{$server}{$id}).'&';
1756: }
1757: }
1758: }
1759: }
1760: foreach my $server (keys(%servers)) {
1761: $servers{$server} =~ s/\&$//;
1762: if ($namespace eq 'ids') {
1763: $result{$server} = &critical('iddel:'.$udom.':'.$servers{$server},$uhome);
1764: } elsif ($namespace eq 'clickers') {
1765: $result{$server} = &critical('updateclickers:'.$udom.':del:'.$servers{$server},$server);
1766: }
1767: }
1768: return %result;
1769: }
1770:
1771: # ----- Update clicker ID-to-username look-ups in clickers.db on library server
1772:
1773: sub updateclickers {
1774: my ($udom,$action,$idshashref,$uhome,$critical) = @_;
1775: my %clickers;
1776: if (ref($idshashref) eq 'HASH') {
1777: %clickers=%{$idshashref};
1778: } else {
1779: return;
1780: }
1781: my $items='';
1782: foreach my $item (keys(%clickers)) {
1783: $items.=&escape($item).'='.&escape($clickers{$item}).'&';
1784: }
1785: $items=~s/\&$//;
1786: my $request = "updateclickers:$udom:$action:$items";
1787: if ($critical) {
1788: return &critical($request,$uhome);
1789: } else {
1790: return &reply($request,$uhome);
1791: }
1792: }
1793:
1794: # ------------------------------dump from db file owned by domainconfig user
1795: sub dump_dom {
1796: my ($namespace, $udom, $regexp) = @_;
1797:
1798: $udom ||= $env{'user.domain'};
1799:
1800: return () unless $udom;
1801:
1802: return &dump($namespace, $udom, &get_domainconfiguser($udom), $regexp);
1803: }
1804:
1805: # ------------------------------------------ get items from domain db files
1806:
1807: sub get_dom {
1808: my ($namespace,$storearr,$udom,$uhome)=@_;
1809: return if ($udom eq 'public');
1810: my $items='';
1811: foreach my $item (@$storearr) {
1812: $items.=&escape($item).'&';
1813: }
1814: $items=~s/\&$//;
1815: if (!$udom) {
1816: $udom=$env{'user.domain'};
1817: return if ($udom eq 'public');
1818: if (defined(&domain($udom,'primary'))) {
1819: $uhome=&domain($udom,'primary');
1820: } else {
1821: undef($uhome);
1822: }
1823: } else {
1824: if (!$uhome) {
1825: if (defined(&domain($udom,'primary'))) {
1826: $uhome=&domain($udom,'primary');
1827: }
1828: }
1829: }
1830: if ($udom && $uhome && ($uhome ne 'no_host')) {
1831: my $rep=&reply("getdom:$udom:$namespace:$items",$uhome);
1832: my %returnhash;
1833: if ($rep eq '' || $rep =~ /^error: 2 /) {
1834: return %returnhash;
1835: }
1836: my @pairs=split(/\&/,$rep);
1837: if ( $#pairs==0 && $pairs[0] =~ /^(con_lost|error|no_such_host)/i) {
1838: return @pairs;
1839: }
1840: my $i=0;
1841: foreach my $item (@$storearr) {
1842: $returnhash{$item}=&thaw_unescape($pairs[$i]);
1843: $i++;
1844: }
1845: return %returnhash;
1846: } else {
1847: &logthis("get_dom failed - no homeserver and/or domain ($udom) ($uhome)");
1848: }
1849: }
1850:
1851: # -------------------------------------------- put items in domain db files
1852:
1853: sub put_dom {
1854: my ($namespace,$storehash,$udom,$uhome)=@_;
1855: if (!$udom) {
1856: $udom=$env{'user.domain'};
1857: if (defined(&domain($udom,'primary'))) {
1858: $uhome=&domain($udom,'primary');
1859: } else {
1860: undef($uhome);
1861: }
1862: } else {
1863: if (!$uhome) {
1864: if (defined(&domain($udom,'primary'))) {
1865: $uhome=&domain($udom,'primary');
1866: }
1867: }
1868: }
1869: if ($udom && $uhome && ($uhome ne 'no_host')) {
1870: my $items='';
1871: foreach my $item (keys(%$storehash)) {
1872: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
1873: }
1874: $items=~s/\&$//;
1875: return &reply("putdom:$udom:$namespace:$items",$uhome);
1876: } else {
1877: &logthis("put_dom failed - no homeserver and/or domain");
1878: }
1879: }
1880:
1881: # --------------------- newput for items in db file owned by domainconfig user
1882: sub newput_dom {
1883: my ($namespace,$storehash,$udom) = @_;
1884: my $result;
1885: if (!$udom) {
1886: $udom=$env{'user.domain'};
1887: }
1888: if ($udom) {
1889: my $uname = &get_domainconfiguser($udom);
1890: $result = &newput($namespace,$storehash,$udom,$uname);
1891: }
1892: return $result;
1893: }
1894:
1895: # --------------------- delete for items in db file owned by domainconfig user
1896: sub del_dom {
1897: my ($namespace,$storearr,$udom)=@_;
1898: if (ref($storearr) eq 'ARRAY') {
1899: if (!$udom) {
1900: $udom=$env{'user.domain'};
1901: }
1902: if ($udom) {
1903: my $uname = &get_domainconfiguser($udom);
1904: return &del($namespace,$storearr,$udom,$uname);
1905: }
1906: }
1907: }
1908:
1909: # ----------------------------------construct domainconfig user for a domain
1910: sub get_domainconfiguser {
1911: my ($udom) = @_;
1912: return $udom.'-domainconfig';
1913: }
1914:
1915: sub retrieve_inst_usertypes {
1916: my ($udom) = @_;
1917: my (%returnhash,@order);
1918: my %domdefs = &Apache::lonnet::get_domain_defaults($udom);
1919: if ((ref($domdefs{'inststatustypes'}) eq 'HASH') &&
1920: (ref($domdefs{'inststatusorder'}) eq 'ARRAY')) {
1921: return ($domdefs{'inststatustypes'},$domdefs{'inststatusorder'});
1922: } else {
1923: if (defined(&domain($udom,'primary'))) {
1924: my $uhome=&domain($udom,'primary');
1925: my $rep=&reply("inst_usertypes:$udom",$uhome);
1926: if ($rep =~ /^(con_lost|error|no_such_host|refused)/) {
1927: &logthis("retrieve_inst_usertypes failed - $rep returned from $uhome in domain: $udom");
1928: return (\%returnhash,\@order);
1929: }
1930: my ($hashitems,$orderitems) = split(/:/,$rep);
1931: my @pairs=split(/\&/,$hashitems);
1932: foreach my $item (@pairs) {
1933: my ($key,$value)=split(/=/,$item,2);
1934: $key = &unescape($key);
1935: next if ($key =~ /^error: 2 /);
1936: $returnhash{$key}=&thaw_unescape($value);
1937: }
1938: my @esc_order = split(/\&/,$orderitems);
1939: foreach my $item (@esc_order) {
1940: push(@order,&unescape($item));
1941: }
1942: } else {
1943: &logthis("retrieve_inst_usertypes failed - no primary domain server for $udom");
1944: }
1945: return (\%returnhash,\@order);
1946: }
1947: }
1948:
1949: sub is_domainimage {
1950: my ($url) = @_;
1951: if ($url=~m-^/+res/+($match_domain)/+\1\-domainconfig/+(img|logo|domlogo)/+[^/]-) {
1952: if (&domain($1) ne '') {
1953: return '1';
1954: }
1955: }
1956: return;
1957: }
1958:
1959: sub inst_directory_query {
1960: my ($srch) = @_;
1961: my $udom = $srch->{'srchdomain'};
1962: my %results;
1963: my $homeserver = &domain($udom,'primary');
1964: my $outcome;
1965: if ($homeserver ne '') {
1966: my $queryid=&reply("querysend:instdirsearch:".
1967: &escape($srch->{'srchby'}).':'.
1968: &escape($srch->{'srchterm'}).':'.
1969: &escape($srch->{'srchtype'}),$homeserver);
1970: my $host=&hostname($homeserver);
1971: if ($queryid !~/^\Q$host\E\_/) {
1972: &logthis('instituional directory search invalid queryid: '.$queryid.' for host: '.$homeserver.'in domain '.$udom);
1973: return;
1974: }
1975: my $response = &get_query_reply($queryid);
1976: my $maxtries = 5;
1977: my $tries = 1;
1978: while (($response=~/^timeout/) && ($tries < $maxtries)) {
1979: $response = &get_query_reply($queryid);
1980: $tries ++;
1981: }
1982:
1983: if (!&error($response) && $response ne 'refused') {
1984: if ($response eq 'unavailable') {
1985: $outcome = $response;
1986: } else {
1987: $outcome = 'ok';
1988: my @matches = split(/\n/,$response);
1989: foreach my $match (@matches) {
1990: my ($key,$value) = split(/=/,$match);
1991: $results{&unescape($key).':'.$udom} = &thaw_unescape($value);
1992: }
1993: }
1994: }
1995: }
1996: return ($outcome,%results);
1997: }
1998:
1999: sub usersearch {
2000: my ($srch) = @_;
2001: my $dom = $srch->{'srchdomain'};
2002: my %results;
2003: my %libserv = &all_library();
2004: my $query = 'usersearch';
2005: foreach my $tryserver (keys(%libserv)) {
2006: if (&host_domain($tryserver) eq $dom) {
2007: my $host=&hostname($tryserver);
2008: my $queryid=
2009: &reply("querysend:".&escape($query).':'.
2010: &escape($srch->{'srchby'}).':'.
2011: &escape($srch->{'srchtype'}).':'.
2012: &escape($srch->{'srchterm'}),$tryserver);
2013: if ($queryid !~/^\Q$host\E\_/) {
2014: &logthis('usersearch: invalid queryid: '.$queryid.' for host: '.$host.'in domain '.$dom.' and server: '.$tryserver);
2015: next;
2016: }
2017: my $reply = &get_query_reply($queryid);
2018: my $maxtries = 1;
2019: my $tries = 1;
2020: while (($reply=~/^timeout/) && ($tries < $maxtries)) {
2021: $reply = &get_query_reply($queryid);
2022: $tries ++;
2023: }
2024: if ( ($reply =~/^timeout/) || ($reply =~/^error/) ) {
2025: &logthis('usersrch error: '.$reply.' for '.$dom.' - searching for : '.$srch->{'srchterm'}.' by '.$srch->{'srchby'}.' ('.$srch->{'srchtype'}.') - maxtries: '.$maxtries.' tries: '.$tries);
2026: } else {
2027: my @matches;
2028: if ($reply =~ /\n/) {
2029: @matches = split(/\n/,$reply);
2030: } else {
2031: @matches = split(/\&/,$reply);
2032: }
2033: foreach my $match (@matches) {
2034: my ($uname,$udom,%userhash);
2035: foreach my $entry (split(/:/,$match)) {
2036: my ($key,$value) =
2037: map {&unescape($_);} split(/=/,$entry);
2038: $userhash{$key} = $value;
2039: if ($key eq 'username') {
2040: $uname = $value;
2041: } elsif ($key eq 'domain') {
2042: $udom = $value;
2043: }
2044: }
2045: $results{$uname.':'.$udom} = \%userhash;
2046: }
2047: }
2048: }
2049: }
2050: return %results;
2051: }
2052:
2053: sub get_instuser {
2054: my ($udom,$uname,$id) = @_;
2055: my $homeserver = &domain($udom,'primary');
2056: my ($outcome,%results);
2057: if ($homeserver ne '') {
2058: my $queryid=&reply("querysend:getinstuser:".&escape($uname).':'.
2059: &escape($id).':'.&escape($udom),$homeserver);
2060: my $host=&hostname($homeserver);
2061: if ($queryid !~/^\Q$host\E\_/) {
2062: &logthis('get_instuser invalid queryid: '.$queryid.' for host: '.$homeserver.'in domain '.$udom);
2063: return;
2064: }
2065: my $response = &get_query_reply($queryid);
2066: my $maxtries = 5;
2067: my $tries = 1;
2068: while (($response=~/^timeout/) && ($tries < $maxtries)) {
2069: $response = &get_query_reply($queryid);
2070: $tries ++;
2071: }
2072: if (!&error($response) && $response ne 'refused') {
2073: if ($response eq 'unavailable') {
2074: $outcome = $response;
2075: } else {
2076: $outcome = 'ok';
2077: my @matches = split(/\n/,$response);
2078: foreach my $match (@matches) {
2079: my ($key,$value) = split(/=/,$match);
2080: $results{&unescape($key)} = &thaw_unescape($value);
2081: }
2082: }
2083: }
2084: }
2085: my %userinfo;
2086: if (ref($results{$uname}) eq 'HASH') {
2087: %userinfo = %{$results{$uname}};
2088: }
2089: return ($outcome,%userinfo);
2090: }
2091:
2092: sub get_multiple_instusers {
2093: my ($udom,$users,$caller) = @_;
2094: my ($outcome,$results);
2095: if (ref($users) eq 'HASH') {
2096: my $count = keys(%{$users});
2097: my $requested = &freeze_escape($users);
2098: my $homeserver = &domain($udom,'primary');
2099: if ($homeserver ne '') {
2100: my $queryid=&reply('querysend:getmultinstusers:::'.$caller.'='.$requested,$homeserver);
2101: my $host=&hostname($homeserver);
2102: if ($queryid !~/^\Q$host\E\_/) {
2103: &logthis('get_multiple_instusers invalid queryid: '.$queryid.
2104: ' for host: '.$homeserver.'in domain '.$udom);
2105: return ($outcome,$results);
2106: }
2107: my $response = &get_query_reply($queryid);
2108: my $maxtries = 5;
2109: if ($count > 100) {
2110: $maxtries = 1+int($count/20);
2111: }
2112: my $tries = 1;
2113: while (($response=~/^timeout/) && ($tries <= $maxtries)) {
2114: $response = &get_query_reply($queryid);
2115: $tries ++;
2116: }
2117: if ($response eq '') {
2118: $results = {};
2119: foreach my $key (keys(%{$users})) {
2120: my ($uname,$id);
2121: if ($caller eq 'id') {
2122: $id = $key;
2123: } else {
2124: $uname = $key;
2125: }
2126: my ($resp,%info) = &get_instuser($udom,$uname,$id);
2127: $outcome = $resp;
2128: if ($resp eq 'ok') {
2129: %{$results} = (%{$results}, %info);
2130: } else {
2131: last;
2132: }
2133: }
2134: } elsif(!&error($response) && ($response ne 'refused')) {
2135: if (($response eq 'unavailable') || ($response eq 'invalid') || ($response eq 'timeout')) {
2136: $outcome = $response;
2137: } else {
2138: ($outcome,my $userdata) = split(/=/,$response,2);
2139: if ($outcome eq 'ok') {
2140: $results = &thaw_unescape($userdata);
2141: }
2142: }
2143: }
2144: }
2145: }
2146: return ($outcome,$results);
2147: }
2148:
2149: sub inst_rulecheck {
2150: my ($udom,$uname,$id,$item,$rules) = @_;
2151: my %returnhash;
2152: if ($udom ne '') {
2153: if (ref($rules) eq 'ARRAY') {
2154: @{$rules} = map {&escape($_);} (@{$rules});
2155: my $rulestr = join(':',@{$rules});
2156: my $homeserver=&domain($udom,'primary');
2157: if (($homeserver ne '') && ($homeserver ne 'no_host')) {
2158: my $response;
2159: if ($item eq 'username') {
2160: $response=&unescape(&reply('instrulecheck:'.&escape($udom).
2161: ':'.&escape($uname).':'.$rulestr,
2162: $homeserver));
2163: } elsif ($item eq 'id') {
2164: $response=&unescape(&reply('instidrulecheck:'.&escape($udom).
2165: ':'.&escape($id).':'.$rulestr,
2166: $homeserver));
2167: } elsif ($item eq 'selfcreate') {
2168: $response=&unescape(&reply('instselfcreatecheck:'.
2169: &escape($udom).':'.&escape($uname).
2170: ':'.$rulestr,$homeserver));
2171: }
2172: if ($response ne 'refused') {
2173: my @pairs=split(/\&/,$response);
2174: foreach my $item (@pairs) {
2175: my ($key,$value)=split(/=/,$item,2);
2176: $key = &unescape($key);
2177: next if ($key =~ /^error: 2 /);
2178: $returnhash{$key}=&thaw_unescape($value);
2179: }
2180: }
2181: }
2182: }
2183: }
2184: return %returnhash;
2185: }
2186:
2187: sub inst_userrules {
2188: my ($udom,$check) = @_;
2189: my (%ruleshash,@ruleorder);
2190: if ($udom ne '') {
2191: my $homeserver=&domain($udom,'primary');
2192: if (($homeserver ne '') && ($homeserver ne 'no_host')) {
2193: my $response;
2194: if ($check eq 'id') {
2195: $response=&reply('instidrules:'.&escape($udom),
2196: $homeserver);
2197: } elsif ($check eq 'email') {
2198: $response=&reply('instemailrules:'.&escape($udom),
2199: $homeserver);
2200: } else {
2201: $response=&reply('instuserrules:'.&escape($udom),
2202: $homeserver);
2203: }
2204: if (($response ne 'refused') && ($response ne 'error') &&
2205: ($response ne 'unknown_cmd') &&
2206: ($response ne 'no_such_host')) {
2207: my ($hashitems,$orderitems) = split(/:/,$response);
2208: my @pairs=split(/\&/,$hashitems);
2209: foreach my $item (@pairs) {
2210: my ($key,$value)=split(/=/,$item,2);
2211: $key = &unescape($key);
2212: next if ($key =~ /^error: 2 /);
2213: $ruleshash{$key}=&thaw_unescape($value);
2214: }
2215: my @esc_order = split(/\&/,$orderitems);
2216: foreach my $item (@esc_order) {
2217: push(@ruleorder,&unescape($item));
2218: }
2219: }
2220: }
2221: }
2222: return (\%ruleshash,\@ruleorder);
2223: }
2224:
2225: # ------------- Get Authentication, Language and User Tools Defaults for Domain
2226:
2227: sub get_domain_defaults {
2228: my ($domain,$ignore_cache) = @_;
2229: return if (($domain eq '') || ($domain eq 'public'));
2230: my $cachetime = 60*60*24;
2231: unless ($ignore_cache) {
2232: my ($result,$cached)=&is_cached_new('domdefaults',$domain);
2233: if (defined($cached)) {
2234: if (ref($result) eq 'HASH') {
2235: return %{$result};
2236: }
2237: }
2238: }
2239: my %domdefaults;
2240: my %domconfig =
2241: &Apache::lonnet::get_dom('configuration',['defaults','quotas',
2242: 'requestcourses','inststatus',
2243: 'coursedefaults','usersessions',
2244: 'requestauthor','selfenrollment',
2245: 'coursecategories','ssl','autoenroll'],$domain);
2246: my @coursetypes = ('official','unofficial','community','textbook','placement');
2247: if (ref($domconfig{'defaults'}) eq 'HASH') {
2248: $domdefaults{'lang_def'} = $domconfig{'defaults'}{'lang_def'};
2249: $domdefaults{'auth_def'} = $domconfig{'defaults'}{'auth_def'};
2250: $domdefaults{'auth_arg_def'} = $domconfig{'defaults'}{'auth_arg_def'};
2251: $domdefaults{'timezone_def'} = $domconfig{'defaults'}{'timezone_def'};
2252: $domdefaults{'datelocale_def'} = $domconfig{'defaults'}{'datelocale_def'};
2253: $domdefaults{'portal_def'} = $domconfig{'defaults'}{'portal_def'};
2254: } else {
2255: $domdefaults{'lang_def'} = &domain($domain,'lang_def');
2256: $domdefaults{'auth_def'} = &domain($domain,'auth_def');
2257: $domdefaults{'auth_arg_def'} = &domain($domain,'auth_arg_def');
2258: }
2259: if (ref($domconfig{'quotas'}) eq 'HASH') {
2260: if (ref($domconfig{'quotas'}{'defaultquota'}) eq 'HASH') {
2261: $domdefaults{'defaultquota'} = $domconfig{'quotas'}{'defaultquota'};
2262: } else {
2263: $domdefaults{'defaultquota'} = $domconfig{'quotas'};
2264: }
2265: my @usertools = ('aboutme','blog','webdav','portfolio');
2266: foreach my $item (@usertools) {
2267: if (ref($domconfig{'quotas'}{$item}) eq 'HASH') {
2268: $domdefaults{$item} = $domconfig{'quotas'}{$item};
2269: }
2270: }
2271: if (ref($domconfig{'quotas'}{'authorquota'}) eq 'HASH') {
2272: $domdefaults{'authorquota'} = $domconfig{'quotas'}{'authorquota'};
2273: }
2274: }
2275: if (ref($domconfig{'requestcourses'}) eq 'HASH') {
2276: foreach my $item ('official','unofficial','community','textbook','placement') {
2277: $domdefaults{$item} = $domconfig{'requestcourses'}{$item};
2278: }
2279: }
2280: if (ref($domconfig{'requestauthor'}) eq 'HASH') {
2281: $domdefaults{'requestauthor'} = $domconfig{'requestauthor'};
2282: }
2283: if (ref($domconfig{'inststatus'}) eq 'HASH') {
2284: foreach my $item ('inststatustypes','inststatusorder','inststatusguest') {
2285: $domdefaults{$item} = $domconfig{'inststatus'}{$item};
2286: }
2287: }
2288: if (ref($domconfig{'coursedefaults'}) eq 'HASH') {
2289: $domdefaults{'canuse_pdfforms'} = $domconfig{'coursedefaults'}{'canuse_pdfforms'};
2290: $domdefaults{'usejsme'} = $domconfig{'coursedefaults'}{'usejsme'};
2291: $domdefaults{'uselcmath'} = $domconfig{'coursedefaults'}{'uselcmath'};
2292: if (ref($domconfig{'coursedefaults'}{'postsubmit'}) eq 'HASH') {
2293: $domdefaults{'postsubmit'} = $domconfig{'coursedefaults'}{'postsubmit'}{'client'};
2294: }
2295: foreach my $type (@coursetypes) {
2296: if (ref($domconfig{'coursedefaults'}{'coursecredits'}) eq 'HASH') {
2297: unless ($type eq 'community') {
2298: $domdefaults{$type.'credits'} = $domconfig{'coursedefaults'}{'coursecredits'}{$type};
2299: }
2300: }
2301: if (ref($domconfig{'coursedefaults'}{'uploadquota'}) eq 'HASH') {
2302: $domdefaults{$type.'quota'} = $domconfig{'coursedefaults'}{'uploadquota'}{$type};
2303: }
2304: if ($domdefaults{'postsubmit'} eq 'on') {
2305: if (ref($domconfig{'coursedefaults'}{'postsubmit'}{'timeout'}) eq 'HASH') {
2306: $domdefaults{$type.'postsubtimeout'} =
2307: $domconfig{'coursedefaults'}{'postsubmit'}{'timeout'}{$type};
2308: }
2309: }
2310: }
2311: if (ref($domconfig{'coursedefaults'}{'canclone'}) eq 'HASH') {
2312: if (ref($domconfig{'coursedefaults'}{'canclone'}{'instcode'}) eq 'ARRAY') {
2313: my @clonecodes = @{$domconfig{'coursedefaults'}{'canclone'}{'instcode'}};
2314: if (@clonecodes) {
2315: $domdefaults{'canclone'} = join('+',@clonecodes);
2316: }
2317: }
2318: } elsif ($domconfig{'coursedefaults'}{'canclone'}) {
2319: $domdefaults{'canclone'}=$domconfig{'coursedefaults'}{'canclone'};
2320: }
2321: }
2322: if (ref($domconfig{'usersessions'}) eq 'HASH') {
2323: if (ref($domconfig{'usersessions'}{'remote'}) eq 'HASH') {
2324: $domdefaults{'remotesessions'} = $domconfig{'usersessions'}{'remote'};
2325: }
2326: if (ref($domconfig{'usersessions'}{'hosted'}) eq 'HASH') {
2327: $domdefaults{'hostedsessions'} = $domconfig{'usersessions'}{'hosted'};
2328: }
2329: if (ref($domconfig{'usersessions'}{'offloadnow'}) eq 'HASH') {
2330: $domdefaults{'offloadnow'} = $domconfig{'usersessions'}{'offloadnow'};
2331: }
2332: }
2333: if (ref($domconfig{'selfenrollment'}) eq 'HASH') {
2334: if (ref($domconfig{'selfenrollment'}{'admin'}) eq 'HASH') {
2335: my @settings = ('types','registered','enroll_dates','access_dates','section',
2336: 'approval','limit');
2337: foreach my $type (@coursetypes) {
2338: if (ref($domconfig{'selfenrollment'}{'admin'}{$type}) eq 'HASH') {
2339: my @mgrdc = ();
2340: foreach my $item (@settings) {
2341: if ($domconfig{'selfenrollment'}{'admin'}{$type}{$item} eq '0') {
2342: push(@mgrdc,$item);
2343: }
2344: }
2345: if (@mgrdc) {
2346: $domdefaults{$type.'selfenrolladmdc'} = join(',',@mgrdc);
2347: }
2348: }
2349: }
2350: }
2351: if (ref($domconfig{'selfenrollment'}{'default'}) eq 'HASH') {
2352: foreach my $type (@coursetypes) {
2353: if (ref($domconfig{'selfenrollment'}{'default'}{$type}) eq 'HASH') {
2354: foreach my $item (keys(%{$domconfig{'selfenrollment'}{'default'}{$type}})) {
2355: $domdefaults{$type.'selfenroll'.$item} = $domconfig{'selfenrollment'}{'default'}{$type}{$item};
2356: }
2357: }
2358: }
2359: }
2360: }
2361: if (ref($domconfig{'coursecategories'}) eq 'HASH') {
2362: $domdefaults{'catauth'} = 'std';
2363: $domdefaults{'catunauth'} = 'std';
2364: if ($domconfig{'coursecategories'}{'auth'}) {
2365: $domdefaults{'catauth'} = $domconfig{'coursecategories'}{'auth'};
2366: }
2367: if ($domconfig{'coursecategories'}{'unauth'}) {
2368: $domdefaults{'catunauth'} = $domconfig{'coursecategories'}{'unauth'};
2369: }
2370: }
2371: if (ref($domconfig{'ssl'}) eq 'HASH') {
2372: if (ref($domconfig{'ssl'}{'replication'}) eq 'HASH') {
2373: $domdefaults{'replication'} = $domconfig{'ssl'}{'replication'};
2374: }
2375: if (ref($domconfig{'ssl'}{'connect'}) eq 'HASH') {
2376: $domdefaults{'connect'} = $domconfig{'ssl'}{'connect'};
2377: }
2378: }
2379: if (ref($domconfig{'autoenroll'}) eq 'HASH') {
2380: $domdefaults{'autofailsafe'} = $domconfig{'autoenroll'}{'autofailsafe'};
2381: }
2382: &do_cache_new('domdefaults',$domain,\%domdefaults,$cachetime);
2383: return %domdefaults;
2384: }
2385:
2386: sub course_portal_url {
2387: my ($cnum,$cdom) = @_;
2388: my $chome = &homeserver($cnum,$cdom);
2389: my $hostname = &hostname($chome);
2390: my $protocol = $protocol{$chome};
2391: $protocol = 'http' if ($protocol ne 'https');
2392: my %domdefaults = &get_domain_defaults($cdom);
2393: my $firsturl;
2394: if ($domdefaults{'portal_def'}) {
2395: $firsturl = $domdefaults{'portal_def'};
2396: } else {
2397: $firsturl = $protocol.'://'.$hostname;
2398: }
2399: return $firsturl;
2400: }
2401:
2402: # --------------------------------------------------- Assign a key to a student
2403:
2404: sub assign_access_key {
2405: #
2406: # a valid key looks like uname:udom#comments
2407: # comments are being appended
2408: #
2409: my ($ckey,$kdom,$knum,$cdom,$cnum,$udom,$uname,$logentry)=@_;
2410: $kdom=
2411: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($kdom));
2412: $knum=
2413: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($knum));
2414: $cdom=
2415: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
2416: $cnum=
2417: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
2418: $udom=$env{'user.name'} unless (defined($udom));
2419: $uname=$env{'user.domain'} unless (defined($uname));
2420: my %existing=&get('accesskeys',[$ckey],$kdom,$knum);
2421: if (($existing{$ckey}=~/^\#(.*)$/) || # - new key
2422: ($existing{$ckey}=~/^\Q$uname\E\:\Q$udom\E\#(.*)$/)) {
2423: # assigned to this person
2424: # - this should not happen,
2425: # unless something went wrong
2426: # the first time around
2427: # ready to assign
2428: $logentry=$1.'; '.$logentry;
2429: if (&put('accesskeys',{$ckey=>$uname.':'.$udom.'#'.$logentry},
2430: $kdom,$knum) eq 'ok') {
2431: # key now belongs to user
2432: my $envkey='key.'.$cdom.'_'.$cnum;
2433: if (&put('environment',{$envkey => $ckey}) eq 'ok') {
2434: &appenv({'environment.'.$envkey => $ckey});
2435: return 'ok';
2436: } else {
2437: return
2438: 'error: Count not permanently assign key, will need to be re-entered later.';
2439: }
2440: } else {
2441: return 'error: Could not assign key, try again later.';
2442: }
2443: } elsif (!$existing{$ckey}) {
2444: # the key does not exist
2445: return 'error: The key does not exist';
2446: } else {
2447: # the key is somebody else's
2448: return 'error: The key is already in use';
2449: }
2450: }
2451:
2452: # ------------------------------------------ put an additional comment on a key
2453:
2454: sub comment_access_key {
2455: #
2456: # a valid key looks like uname:udom#comments
2457: # comments are being appended
2458: #
2459: my ($ckey,$cdom,$cnum,$logentry)=@_;
2460: $cdom=
2461: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
2462: $cnum=
2463: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
2464: my %existing=&get('accesskeys',[$ckey],$cdom,$cnum);
2465: if ($existing{$ckey}) {
2466: $existing{$ckey}.='; '.$logentry;
2467: # ready to assign
2468: if (&put('accesskeys',{$ckey=>$existing{$ckey}},
2469: $cdom,$cnum) eq 'ok') {
2470: return 'ok';
2471: } else {
2472: return 'error: Count not store comment.';
2473: }
2474: } else {
2475: # the key does not exist
2476: return 'error: The key does not exist';
2477: }
2478: }
2479:
2480: # ------------------------------------------------------ Generate a set of keys
2481:
2482: sub generate_access_keys {
2483: my ($number,$cdom,$cnum,$logentry)=@_;
2484: $cdom=
2485: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
2486: $cnum=
2487: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
2488: unless (&allowed('mky',$cdom)) { return 0; }
2489: unless (($cdom) && ($cnum)) { return 0; }
2490: if ($number>10000) { return 0; }
2491: sleep(2); # make sure don't get same seed twice
2492: srand(time()^($$+($$<<15))); # from "Programming Perl"
2493: my $total=0;
2494: for (my $i=1;$i<=$number;$i++) {
2495: my $newkey=sprintf("%lx",int(100000*rand)).'-'.
2496: sprintf("%lx",int(100000*rand)).'-'.
2497: sprintf("%lx",int(100000*rand));
2498: $newkey=~s/1/g/g; # folks mix up 1 and l
2499: $newkey=~s/0/h/g; # and also 0 and O
2500: my %existing=&get('accesskeys',[$newkey],$cdom,$cnum);
2501: if ($existing{$newkey}) {
2502: $i--;
2503: } else {
2504: if (&put('accesskeys',
2505: { $newkey => '# generated '.localtime().
2506: ' by '.$env{'user.name'}.'@'.$env{'user.domain'}.
2507: '; '.$logentry },
2508: $cdom,$cnum) eq 'ok') {
2509: $total++;
2510: }
2511: }
2512: }
2513: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},
2514: 'Generated '.$total.' keys for '.$cnum.' at '.$cdom);
2515: return $total;
2516: }
2517:
2518: # ------------------------------------------------------- Validate an accesskey
2519:
2520: sub validate_access_key {
2521: my ($ckey,$cdom,$cnum,$udom,$uname)=@_;
2522: $cdom=
2523: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
2524: $cnum=
2525: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
2526: $udom=$env{'user.domain'} unless (defined($udom));
2527: $uname=$env{'user.name'} unless (defined($uname));
2528: my %existing=&get('accesskeys',[$ckey],$cdom,$cnum);
2529: return ($existing{$ckey}=~/^\Q$uname\E\:\Q$udom\E\#/);
2530: }
2531:
2532: # ------------------------------------- Find the section of student in a course
2533: sub devalidate_getsection_cache {
2534: my ($udom,$unam,$courseid)=@_;
2535: my $hashid="$udom:$unam:$courseid";
2536: &devalidate_cache_new('getsection',$hashid);
2537: }
2538:
2539: sub courseid_to_courseurl {
2540: my ($courseid) = @_;
2541: #already url style courseid
2542: return $courseid if ($courseid =~ m{^/});
2543:
2544: if (exists($env{'course.'.$courseid.'.num'})) {
2545: my $cnum = $env{'course.'.$courseid.'.num'};
2546: my $cdom = $env{'course.'.$courseid.'.domain'};
2547: return "/$cdom/$cnum";
2548: }
2549:
2550: my %courseinfo=&Apache::lonnet::coursedescription($courseid);
2551: if (exists($courseinfo{'num'})) {
2552: return "/$courseinfo{'domain'}/$courseinfo{'num'}";
2553: }
2554:
2555: return undef;
2556: }
2557:
2558: sub getsection {
2559: my ($udom,$unam,$courseid)=@_;
2560: my $cachetime=1800;
2561:
2562: my $hashid="$udom:$unam:$courseid";
2563: my ($result,$cached)=&is_cached_new('getsection',$hashid);
2564: if (defined($cached)) { return $result; }
2565:
2566: my %Pending;
2567: my %Expired;
2568: #
2569: # Each role can either have not started yet (pending), be active,
2570: # or have expired.
2571: #
2572: # If there is an active role, we are done.
2573: #
2574: # If there is more than one role which has not started yet,
2575: # choose the one which will start sooner
2576: # If there is one role which has not started yet, return it.
2577: #
2578: # If there is more than one expired role, choose the one which ended last.
2579: # If there is a role which has expired, return it.
2580: #
2581: $courseid = &courseid_to_courseurl($courseid);
2582: my %roleshash = &dump('roles',$udom,$unam,$courseid);
2583: foreach my $key (keys(%roleshash)) {
2584: next if ($key !~/^\Q$courseid\E(?:\/)*(\w+)*\_st$/);
2585: my $section=$1;
2586: if ($key eq $courseid.'_st') { $section=''; }
2587: my ($dummy,$end,$start)=split(/\_/,&unescape($roleshash{$key}));
2588: my $now=time;
2589: if (defined($end) && $end && ($now > $end)) {
2590: $Expired{$end}=$section;
2591: next;
2592: }
2593: if (defined($start) && $start && ($now < $start)) {
2594: $Pending{$start}=$section;
2595: next;
2596: }
2597: return &do_cache_new('getsection',$hashid,$section,$cachetime);
2598: }
2599: #
2600: # Presumedly there will be few matching roles from the above
2601: # loop and the sorting time will be negligible.
2602: if (scalar(keys(%Pending))) {
2603: my ($time) = sort {$a <=> $b} keys(%Pending);
2604: return &do_cache_new('getsection',$hashid,$Pending{$time},$cachetime);
2605: }
2606: if (scalar(keys(%Expired))) {
2607: my @sorted = sort {$a <=> $b} keys(%Expired);
2608: my $time = pop(@sorted);
2609: return &do_cache_new('getsection',$hashid,$Expired{$time},$cachetime);
2610: }
2611: return &do_cache_new('getsection',$hashid,'-1',$cachetime);
2612: }
2613:
2614: sub save_cache {
2615: &purge_remembered();
2616: #&Apache::loncommon::validate_page();
2617: undef(%env);
2618: undef($env_loaded);
2619: }
2620:
2621: my $to_remember=-1;
2622: my %remembered;
2623: my %accessed;
2624: my $kicks=0;
2625: my $hits=0;
2626: sub make_key {
2627: my ($name,$id) = @_;
2628: if (length($id) > 65
2629: && length(&escape($id)) > 200) {
2630: $id=length($id).':'.&Digest::MD5::md5_hex($id);
2631: }
2632: return &escape($name.':'.$id);
2633: }
2634:
2635: sub devalidate_cache_new {
2636: my ($name,$id,$debug) = @_;
2637: if ($debug) { &Apache::lonnet::logthis("deleting $name:$id"); }
2638: $id=&make_key($name,$id);
2639: $memcache->delete($id);
2640: delete($remembered{$id});
2641: delete($accessed{$id});
2642: }
2643:
2644: sub is_cached_new {
2645: my ($name,$id,$debug) = @_;
2646: $id=&make_key($name,$id);
2647: if (exists($remembered{$id})) {
2648: if ($debug) { &Apache::lonnet::logthis("Early return $id of $remembered{$id} "); }
2649: $accessed{$id}=[&gettimeofday()];
2650: $hits++;
2651: return ($remembered{$id},1);
2652: }
2653: my $value = $memcache->get($id);
2654: if (!(defined($value))) {
2655: if ($debug) { &Apache::lonnet::logthis("getting $id is not defined"); }
2656: return (undef,undef);
2657: }
2658: if ($value eq '__undef__') {
2659: if ($debug) { &Apache::lonnet::logthis("getting $id is __undef__"); }
2660: $value=undef;
2661: }
2662: &make_room($id,$value,$debug);
2663: if ($debug) { &Apache::lonnet::logthis("getting $id is $value"); }
2664: return ($value,1);
2665: }
2666:
2667: sub do_cache_new {
2668: my ($name,$id,$value,$time,$debug) = @_;
2669: $id=&make_key($name,$id);
2670: my $setvalue=$value;
2671: if (!defined($setvalue)) {
2672: $setvalue='__undef__';
2673: }
2674: if (!defined($time) ) {
2675: $time=600;
2676: }
2677: if ($debug) { &Apache::lonnet::logthis("Setting $id to $value"); }
2678: my $result = $memcache->set($id,$setvalue,$time);
2679: if (! $result) {
2680: &logthis("caching of id -> $id failed");
2681: $memcache->disconnect_all();
2682: }
2683: # need to make a copy of $value
2684: &make_room($id,$value,$debug);
2685: return $value;
2686: }
2687:
2688: sub make_room {
2689: my ($id,$value,$debug)=@_;
2690:
2691: $remembered{$id}= (ref($value)) ? &Storable::dclone($value)
2692: : $value;
2693: if ($to_remember<0) { return; }
2694: $accessed{$id}=[&gettimeofday()];
2695: if (scalar(keys(%remembered)) <= $to_remember) { return; }
2696: my $to_kick;
2697: my $max_time=0;
2698: foreach my $other (keys(%accessed)) {
2699: if (&tv_interval($accessed{$other}) > $max_time) {
2700: $to_kick=$other;
2701: $max_time=&tv_interval($accessed{$other});
2702: }
2703: }
2704: delete($remembered{$to_kick});
2705: delete($accessed{$to_kick});
2706: $kicks++;
2707: if ($debug) { &logthis("kicking $to_kick $max_time $kicks\n"); }
2708: return;
2709: }
2710:
2711: sub purge_remembered {
2712: #&logthis("Tossing ".scalar(keys(%remembered)));
2713: #&logthis(sprintf("%-20s is %s",'%remembered',length(&freeze(\%remembered))));
2714: undef(%remembered);
2715: undef(%accessed);
2716: }
2717: # ------------------------------------- Read an entry from a user's environment
2718:
2719: sub userenvironment {
2720: my ($udom,$unam,@what)=@_;
2721: my $items;
2722: foreach my $item (@what) {
2723: $items.=&escape($item).'&';
2724: }
2725: $items=~s/\&$//;
2726: my %returnhash=();
2727: my $uhome = &homeserver($unam,$udom);
2728: unless ($uhome eq 'no_host') {
2729: my @answer=split(/\&/,
2730: &reply('get:'.$udom.':'.$unam.':environment:'.$items,$uhome));
2731: if ($#answer==0 && $answer[0] =~ /^(con_lost|error:|no_such_host)/i) {
2732: return %returnhash;
2733: }
2734: my $i;
2735: for ($i=0;$i<=$#what;$i++) {
2736: $returnhash{$what[$i]}=&unescape($answer[$i]);
2737: }
2738: }
2739: return %returnhash;
2740: }
2741:
2742: # ---------------------------------------------------------- Get a studentphoto
2743: sub studentphoto {
2744: my ($udom,$unam,$ext) = @_;
2745: my $home=&Apache::lonnet::homeserver($unam,$udom);
2746: if (defined($env{'request.course.id'})) {
2747: if ($env{'course.'.$env{'request.course.id'}.'.internal.showphoto'}) {
2748: if ($udom eq $env{'course.'.$env{'request.course.id'}.'.domain'}) {
2749: return(&retrievestudentphoto($udom,$unam,$ext));
2750: } else {
2751: my ($result,$perm_reqd)=
2752: &Apache::lonnet::auto_photo_permission($unam,$udom);
2753: if ($result eq 'ok') {
2754: if (!($perm_reqd eq 'yes')) {
2755: return(&retrievestudentphoto($udom,$unam,$ext));
2756: }
2757: }
2758: }
2759: }
2760: } else {
2761: my ($result,$perm_reqd) =
2762: &Apache::lonnet::auto_photo_permission($unam,$udom);
2763: if ($result eq 'ok') {
2764: if (!($perm_reqd eq 'yes')) {
2765: return(&retrievestudentphoto($udom,$unam,$ext));
2766: }
2767: }
2768: }
2769: return '/adm/lonKaputt/lonlogo_broken.gif';
2770: }
2771:
2772: sub retrievestudentphoto {
2773: my ($udom,$unam,$ext,$type) = @_;
2774: my $home=&Apache::lonnet::homeserver($unam,$udom);
2775: my $ret=&Apache::lonnet::reply("studentphoto:$udom:$unam:$ext:$type",$home);
2776: if ($ret eq 'ok') {
2777: my $url="/uploaded/$udom/$unam/internal/studentphoto.$ext";
2778: if ($type eq 'thumbnail') {
2779: $url="/uploaded/$udom/$unam/internal/studentphoto_tn.$ext";
2780: }
2781: my $tokenurl=&Apache::lonnet::tokenwrapper($url);
2782: return $tokenurl;
2783: } else {
2784: if ($type eq 'thumbnail') {
2785: return '/adm/lonKaputt/genericstudent_tn.gif';
2786: } else {
2787: return '/adm/lonKaputt/lonlogo_broken.gif';
2788: }
2789: }
2790: }
2791:
2792: # -------------------------------------------------------------------- New chat
2793:
2794: sub chatsend {
2795: my ($newentry,$anon,$group)=@_;
2796: my $cnum=$env{'course.'.$env{'request.course.id'}.'.num'};
2797: my $cdom=$env{'course.'.$env{'request.course.id'}.'.domain'};
2798: my $chome=$env{'course.'.$env{'request.course.id'}.'.home'};
2799: &reply('chatsend:'.$cdom.':'.$cnum.':'.
2800: &escape($env{'user.domain'}.':'.$env{'user.name'}.':'.$anon.':'.
2801: &escape($newentry)).':'.$group,$chome);
2802: }
2803:
2804: # ------------------------------------------ Find current version of a resource
2805:
2806: sub getversion {
2807: my $fname=&clutter(shift);
2808: unless ($fname=~m{^(/adm/wrapper|)/res/}) { return -1; }
2809: return ¤tversion(&filelocation('',$fname));
2810: }
2811:
2812: sub currentversion {
2813: my $fname=shift;
2814: my $author=$fname;
2815: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
2816: my ($udom,$uname)=split(/\//,$author);
2817: my $home=&homeserver($uname,$udom);
2818: if ($home eq 'no_host') {
2819: return -1;
2820: }
2821: my $answer=&reply("currentversion:$fname",$home);
2822: if (($answer eq 'con_lost') || ($answer eq 'rejected')) {
2823: return -1;
2824: }
2825: return $answer;
2826: }
2827:
2828: #
2829: # Return special version number of resource if set by override, empty otherwise
2830: #
2831: sub usedversion {
2832: my $fname=shift;
2833: unless ($fname) { $fname=$env{'request.uri'}; }
2834: my ($urlversion)=($fname=~/\.(\d+)\.\w+$/);
2835: if ($urlversion) { return $urlversion; }
2836: return '';
2837: }
2838:
2839: # ----------------------------- Subscribe to a resource, return URL if possible
2840:
2841: sub subscribe {
2842: my $fname=shift;
2843: if ($fname=~/\/(aboutme|syllabus|bulletinboard|smppg)$/) { return ''; }
2844: $fname=~s/[\n\r]//g;
2845: my $author=$fname;
2846: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
2847: my ($udom,$uname)=split(/\//,$author);
2848: my $home=homeserver($uname,$udom);
2849: if ($home eq 'no_host') {
2850: return 'not_found';
2851: }
2852: my $answer=reply("sub:$fname",$home);
2853: if (($answer eq 'con_lost') || ($answer eq 'rejected')) {
2854: $answer.=' by '.$home;
2855: }
2856: return $answer;
2857: }
2858:
2859: # -------------------------------------------------------------- Replicate file
2860:
2861: sub repcopy {
2862: my $filename=shift;
2863: $filename=~s/\/+/\//g;
2864: my $londocroot = $perlvar{'lonDocRoot'};
2865: if ($filename=~m{^\Q$londocroot/adm/\E}) { return 'ok'; }
2866: if ($filename=~m{^\Q/home/httpd/lonUsers/\E}) { return 'ok'; }
2867: if ($filename=~m{^\Q$londocroot/userfiles/\E} or
2868: $filename=~m{^/*(uploaded|editupload)/}) {
2869: return &repcopy_userfile($filename);
2870: }
2871: $filename=~s/[\n\r]//g;
2872: my $transname="$filename.in.transfer";
2873: # FIXME: this should flock
2874: if ((-e $filename) || (-e $transname)) { return 'ok'; }
2875: my $remoteurl=subscribe($filename);
2876: if ($remoteurl =~ /^con_lost by/) {
2877: &logthis("Subscribe returned $remoteurl: $filename");
2878: return 'unavailable';
2879: } elsif ($remoteurl eq 'not_found') {
2880: #&logthis("Subscribe returned not_found: $filename");
2881: return 'not_found';
2882: } elsif ($remoteurl =~ /^rejected by/) {
2883: &logthis("Subscribe returned $remoteurl: $filename");
2884: return 'forbidden';
2885: } elsif ($remoteurl eq 'directory') {
2886: return 'ok';
2887: } else {
2888: my $author=$filename;
2889: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
2890: my ($udom,$uname)=split(/\//,$author);
2891: my $home=homeserver($uname,$udom);
2892: unless ($home eq $perlvar{'lonHostID'}) {
2893: my @parts=split(/\//,$filename);
2894: my $path="/$parts[1]/$parts[2]/$parts[3]/$parts[4]";
2895: if ($path ne "$londocroot/res") {
2896: &logthis("Malconfiguration for replication: $filename");
2897: return 'bad_request';
2898: }
2899: my $count;
2900: for ($count=5;$count<$#parts;$count++) {
2901: $path.="/$parts[$count]";
2902: if ((-e $path)!=1) {
2903: mkdir($path,0777);
2904: }
2905: }
2906: my $ua=new LWP::UserAgent;
2907: my $request=new HTTP::Request('GET',"$remoteurl");
2908: my $response=$ua->request($request,$transname);
2909: if ($response->is_error()) {
2910: unlink($transname);
2911: my $message=$response->status_line;
2912: &logthis("<font color=\"blue\">WARNING:"
2913: ." LWP get: $message: $filename</font>");
2914: return 'unavailable';
2915: } else {
2916: if ($remoteurl!~/\.meta$/) {
2917: my $mrequest=new HTTP::Request('GET',$remoteurl.'.meta');
2918: my $mresponse=$ua->request($mrequest,$filename.'.meta');
2919: if ($mresponse->is_error()) {
2920: unlink($filename.'.meta');
2921: &logthis(
2922: "<font color=\"yellow\">INFO: No metadata: $filename</font>");
2923: }
2924: }
2925: rename($transname,$filename);
2926: return 'ok';
2927: }
2928: }
2929: }
2930: }
2931:
2932: # ------------------------------------------------ Get server side include body
2933: sub ssi_body {
2934: my ($filelink,%form)=@_;
2935: if (! exists($form{'LONCAPA_INTERNAL_no_discussion'})) {
2936: $form{'LONCAPA_INTERNAL_no_discussion'}='true';
2937: }
2938: my $output='';
2939: my $response;
2940: if ($filelink=~/^https?\:/) {
2941: ($output,$response)=&externalssi($filelink);
2942: } else {
2943: $filelink .= $filelink=~/\?/ ? '&' : '?';
2944: $filelink .= 'inhibitmenu=yes';
2945: ($output,$response)=&ssi($filelink,%form);
2946: }
2947: $output=~s|//(\s*<!--)? BEGIN LON-CAPA Internal.+?// END LON-CAPA Internal\s*(-->)?\s||gs;
2948: $output=~s/^.*?\<body[^\>]*\>//si;
2949: $output=~s/\<\/body\s*\>.*?$//si;
2950: if (wantarray) {
2951: return ($output, $response);
2952: } else {
2953: return $output;
2954: }
2955: }
2956:
2957: # --------------------------------------------------------- Server Side Include
2958:
2959: sub absolute_url {
2960: my ($host_name) = @_;
2961: my $protocol = ($ENV{'SERVER_PORT'} == 443?'https://':'http://');
2962: if ($host_name eq '') {
2963: $host_name = $ENV{'SERVER_NAME'};
2964: }
2965: return $protocol.$host_name;
2966: }
2967:
2968: #
2969: # Server side include.
2970: # Parameters:
2971: # fn Possibly encrypted resource name/id.
2972: # form Hash that describes how the rendering should be done
2973: # and other things.
2974: # Returns:
2975: # Scalar context: The content of the response.
2976: # Array context: 2 element list of the content and the full response object.
2977: #
2978: sub ssi {
2979:
2980: my ($fn,%form)=@_;
2981: my $ua=new LWP::UserAgent;
2982: my $request;
2983:
2984: $form{'no_update_last_known'}=1;
2985: &Apache::lonenc::check_encrypt(\$fn);
2986: if (%form) {
2987: $request=new HTTP::Request('POST',&absolute_url().$fn);
2988: $request->content(join('&',map {
2989: my $name = escape($_);
2990: "$name=" . ( ref($form{$_}) eq 'ARRAY'
2991: ? join("&$name=", map {escape($_) } @{$form{$_}})
2992: : &escape($form{$_}) );
2993: } keys(%form)));
2994: } else {
2995: $request=new HTTP::Request('GET',&absolute_url().$fn);
2996: }
2997:
2998: $request->header(Cookie => $ENV{'HTTP_COOKIE'});
2999: my $response= $ua->request($request);
3000: my $content = $response->content;
3001:
3002:
3003: if (wantarray) {
3004: return ($content, $response);
3005: } else {
3006: return $content;
3007: }
3008: }
3009:
3010: sub externalssi {
3011: my ($url)=@_;
3012: my $ua=new LWP::UserAgent;
3013: my $request=new HTTP::Request('GET',$url);
3014: my $response=$ua->request($request);
3015: if (wantarray) {
3016: return ($response->content, $response);
3017: } else {
3018: return $response->content;
3019: }
3020: }
3021:
3022: # -------------------------------- Allow a /uploaded/ URI to be vouched for
3023:
3024: sub allowuploaded {
3025: my ($srcurl,$url)=@_;
3026: $url=&clutter(&declutter($url));
3027: my $dir=$url;
3028: $dir=~s/\/[^\/]+$//;
3029: my %httpref=();
3030: my $httpurl=&hreflocation('',$url);
3031: $httpref{'httpref.'.$httpurl}=$srcurl;
3032: &Apache::lonnet::appenv(\%httpref);
3033: }
3034:
3035: #
3036: # Determine if the current user should be able to edit a particular resource,
3037: # when viewing in course context.
3038: # (a) When viewing resource used to determine if "Edit" item is included in
3039: # Functions.
3040: # (b) When displaying folder contents in course editor, used to determine if
3041: # "Edit" link will be displayed alongside resource.
3042: #
3043: # input: six args -- filename (decluttered), course number, course domain,
3044: # url, symb (if registered) and group (if this is a group
3045: # item -- e.g., bulletin board, group page etc.).
3046: # output: array of five scalars --
3047: # $cfile -- url for file editing if editable on current server
3048: # $home -- homeserver of resource (i.e., for author if published,
3049: # or course if uploaded.).
3050: # $switchserver -- 1 if server switch will be needed.
3051: # $forceedit -- 1 if icon/link should be to go to edit mode
3052: # $forceview -- 1 if icon/link should be to go to view mode
3053: #
3054:
3055: sub can_edit_resource {
3056: my ($file,$cnum,$cdom,$resurl,$symb,$group) = @_;
3057: my ($cfile,$home,$switchserver,$forceedit,$forceview,$uploaded,$incourse);
3058: #
3059: # For aboutme pages user can only edit his/her own.
3060: #
3061: if ($resurl =~ m{^/?adm/($match_domain)/($match_username)/aboutme$}) {
3062: my ($sdom,$sname) = ($1,$2);
3063: if (($sdom eq $env{'user.domain'}) && ($sname eq $env{'user.name'})) {
3064: $home = $env{'user.home'};
3065: $cfile = $resurl;
3066: if ($env{'form.forceedit'}) {
3067: $forceview = 1;
3068: } else {
3069: $forceedit = 1;
3070: }
3071: return ($cfile,$home,$switchserver,$forceedit,$forceview);
3072: } else {
3073: return;
3074: }
3075: }
3076:
3077: if ($env{'request.course.id'}) {
3078: my $crsedit = &Apache::lonnet::allowed('mdc',$env{'request.course.id'});
3079: if ($group ne '') {
3080: # if this is a group homepage or group bulletin board, check group privs
3081: my $allowed = 0;
3082: if ($resurl =~ m{^/?adm/$cdom/$cnum/$group/smppg$}) {
3083: if ((&allowed('mdg',$env{'request.course.id'}.
3084: ($env{'request.course.sec'}?'/'.$env{'request.course.sec'}:''))) ||
3085: (&allowed('mgh',$env{'request.course.id'}.'/'.$group)) || $crsedit) {
3086: $allowed = 1;
3087: }
3088: } elsif ($resurl =~ m{^/?adm/$cdom/$cnum/\d+/bulletinboard$}) {
3089: if ((&allowed('mdg',$env{'request.course.id'}.($env{'request.course.sec'}?'/'.$env{'request.course.sec'}:''))) ||
3090: (&allowed('cgb',$env{'request.course.id'}.'/'.$group)) || $crsedit) {
3091: $allowed = 1;
3092: }
3093: }
3094: if ($allowed) {
3095: $home=&homeserver($cnum,$cdom);
3096: if ($env{'form.forceedit'}) {
3097: $forceview = 1;
3098: } else {
3099: $forceedit = 1;
3100: }
3101: $cfile = $resurl;
3102: } else {
3103: return;
3104: }
3105: } else {
3106: if ($resurl =~ m{^/?adm/viewclasslist$}) {
3107: unless (&Apache::lonnet::allowed('opa',$env{'request.course.id'})) {
3108: return;
3109: }
3110: } elsif (!$crsedit) {
3111: #
3112: # No edit allowed where CC has switched to student role.
3113: #
3114: return;
3115: }
3116: }
3117: }
3118:
3119: if ($file ne '') {
3120: if (($cnum =~ /$match_courseid/) && ($cdom =~ /$match_domain/)) {
3121: if (&is_course_upload($file,$cnum,$cdom)) {
3122: $uploaded = 1;
3123: $incourse = 1;
3124: if ($file =~/\.(htm|html|css|js|txt)$/) {
3125: $cfile = &hreflocation('',$file);
3126: if ($env{'form.forceedit'}) {
3127: $forceview = 1;
3128: } else {
3129: $forceedit = 1;
3130: }
3131: }
3132: } elsif ($resurl =~ m{^/public/$cdom/$cnum/syllabus}) {
3133: $incourse = 1;
3134: if ($env{'form.forceedit'}) {
3135: $forceview = 1;
3136: } else {
3137: $forceedit = 1;
3138: }
3139: $cfile = $resurl;
3140: } elsif (($resurl ne '') && (&is_on_map($resurl))) {
3141: if ($resurl =~ m{^/adm/$match_domain/$match_username/\d+/smppg|bulletinboard$}) {
3142: $incourse = 1;
3143: if ($env{'form.forceedit'}) {
3144: $forceview = 1;
3145: } else {
3146: $forceedit = 1;
3147: }
3148: $cfile = $resurl;
3149: } elsif ($resurl eq '/res/lib/templates/simpleproblem.problem') {
3150: $incourse = 1;
3151: $cfile = $resurl.'/smpedit';
3152: } elsif ($resurl =~ m{^/adm/wrapper/ext/}) {
3153: $incourse = 1;
3154: if ($env{'form.forceedit'}) {
3155: $forceview = 1;
3156: } else {
3157: $forceedit = 1;
3158: }
3159: $cfile = $resurl;
3160: } elsif ($resurl =~ m{^/adm/wrapper/adm/$cdom/$cnum/\d+/exttools?$}) {
3161: $incourse = 1;
3162: if ($env{'form.forceedit'}) {
3163: $forceview = 1;
3164: } else {
3165: $forceedit = 1;
3166: }
3167: $cfile = $resurl;
3168: } elsif ($resurl =~ m{^/?adm/viewclasslist$}) {
3169: $incourse = 1;
3170: if ($env{'form.forceedit'}) {
3171: $forceview = 1;
3172: } else {
3173: $forceedit = 1;
3174: }
3175: $cfile = ($resurl =~ m{^/} ? $resurl : "/$resurl");
3176: }
3177: } elsif ($resurl eq '/res/lib/templates/simpleproblem.problem/smpedit') {
3178: my $template = '/res/lib/templates/simpleproblem.problem';
3179: if (&is_on_map($template)) {
3180: $incourse = 1;
3181: $forceview = 1;
3182: $cfile = $template;
3183: }
3184: } elsif (($resurl =~ m{^/adm/wrapper/ext/}) && ($env{'form.folderpath'} =~ /^supplemental/)) {
3185: $incourse = 1;
3186: if ($env{'form.forceedit'}) {
3187: $forceview = 1;
3188: } else {
3189: $forceedit = 1;
3190: }
3191: $cfile = $resurl;
3192: } elsif (($resurl =~ m{^/adm/wrapper/adm/$cdom/$cnum/\d+/exttools?$}) && ($env{'form.folderpath'} =~ /^supplemental/)) {
3193: $incourse = 1;
3194: if ($env{'form.forceedit'}) {
3195: $forceview = 1;
3196: } else {
3197: $forceedit = 1;
3198: }
3199: $cfile = $resurl;
3200: } elsif (($resurl eq '/adm/extresedit') && ($symb || $env{'form.folderpath'})) {
3201: $incourse = 1;
3202: $forceview = 1;
3203: if ($symb) {
3204: my ($map,$id,$res)=&decode_symb($symb);
3205: $env{'request.symb'} = $symb;
3206: $cfile = &clutter($res);
3207: } else {
3208: $cfile = $env{'form.suppurl'};
3209: my $escfile = &unescape($cfile);
3210: if ($escfile =~ m{^/adm/$cdom/$cnum/\d+/exttools?$}) {
3211: $cfile = '/adm/wrapper'.$escfile;
3212: } else {
3213: $escfile =~ s{^http://}{};
3214: $cfile = &escape("/adm/wrapper/ext/$escfile");
3215: }
3216: }
3217: } elsif ($resurl =~ m{^/?adm/viewclasslist$}) {
3218: if ($env{'form.forceedit'}) {
3219: $forceview = 1;
3220: } else {
3221: $forceedit = 1;
3222: }
3223: $cfile = ($resurl =~ m{^/} ? $resurl : "/$resurl");
3224: }
3225: }
3226: if ($uploaded || $incourse) {
3227: $home=&homeserver($cnum,$cdom);
3228: } elsif ($file !~ m{/$}) {
3229: $file=~s{^(priv/$match_domain/$match_username)}{/$1};
3230: $file=~s{^($match_domain/$match_username)}{/priv/$1};
3231: # Check that the user has permission to edit this resource
3232: my $setpriv = 1;
3233: my ($cfuname,$cfudom)=&constructaccess($file,$setpriv);
3234: if (defined($cfudom)) {
3235: $home=&homeserver($cfuname,$cfudom);
3236: $cfile=$file;
3237: }
3238: }
3239: if (($cfile ne '') && (!$incourse || $uploaded) &&
3240: (($home ne '') && ($home ne 'no_host'))) {
3241: my @ids=¤t_machine_ids();
3242: unless (grep(/^\Q$home\E$/,@ids)) {
3243: $switchserver=1;
3244: }
3245: }
3246: }
3247: return ($cfile,$home,$switchserver,$forceedit,$forceview);
3248: }
3249:
3250: sub is_course_upload {
3251: my ($file,$cnum,$cdom) = @_;
3252: my $uploadpath = &LONCAPA::propath($cdom,$cnum);
3253: $uploadpath =~ s{^\/}{};
3254: if (($file =~ m{^\Q$uploadpath\E/userfiles/(docs|supplemental)/}) ||
3255: ($file =~ m{^userfiles/\Q$cdom\E/\Q$cnum\E/(docs|supplemental)/})) {
3256: return 1;
3257: }
3258: return;
3259: }
3260:
3261: sub in_course {
3262: my ($udom,$uname,$cdom,$cnum,$type,$hideprivileged) = @_;
3263: if ($hideprivileged) {
3264: my $skipuser;
3265: my %coursehash = &coursedescription($cdom.'_'.$cnum);
3266: my @possdoms = ($cdom);
3267: if ($coursehash{'checkforpriv'}) {
3268: push(@possdoms,split(/,/,$coursehash{'checkforpriv'}));
3269: }
3270: if (&privileged($uname,$udom,\@possdoms)) {
3271: $skipuser = 1;
3272: if ($coursehash{'nothideprivileged'}) {
3273: foreach my $item (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
3274: my $user;
3275: if ($item =~ /:/) {
3276: $user = $item;
3277: } else {
3278: $user = join(':',split(/[\@]/,$item));
3279: }
3280: if ($user eq $uname.':'.$udom) {
3281: undef($skipuser);
3282: last;
3283: }
3284: }
3285: }
3286: if ($skipuser) {
3287: return 0;
3288: }
3289: }
3290: }
3291: $type ||= 'any';
3292: if (!defined($cdom) || !defined($cnum)) {
3293: my $cid = $env{'request.course.id'};
3294: $cdom = $env{'course.'.$cid.'.domain'};
3295: $cnum = $env{'course.'.$cid.'.num'};
3296: }
3297: my $typesref;
3298: if (($type eq 'any') || ($type eq 'all')) {
3299: $typesref = ['active','previous','future'];
3300: } elsif ($type eq 'previous' || $type eq 'future') {
3301: $typesref = [$type];
3302: }
3303: my %roles = &get_my_roles($uname,$udom,'userroles',
3304: $typesref,undef,[$cdom]);
3305: my ($tmp) = keys(%roles);
3306: return 0 if ($tmp =~ /^(con_lost|error|no_such_host)/i);
3307: my @course_roles = grep(/^\Q$cnum\E:\Q$cdom\E:/, keys(%roles));
3308: if (@course_roles > 0) {
3309: return 1;
3310: }
3311: return 0;
3312: }
3313:
3314: # --------- File operations in /home/httpd/html/userfiles/$domain/1/2/3/$course
3315: # input: action, courseID, current domain, intended
3316: # path to file, source of file, instruction to parse file for objects,
3317: # ref to hash for embedded objects,
3318: # ref to hash for codebase of java objects.
3319: # reference to scalar to accommodate mime type determined
3320: # from File::MMagic if $parser = parse.
3321: #
3322: # output: url to file (if action was uploaddoc),
3323: # ok if successful, or diagnostic message otherwise (if action was propagate or copy)
3324: #
3325: # Allows directory structure to be used within lonUsers/../userfiles/ for a
3326: # course.
3327: #
3328: # action = propagate - /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
3329: # will be copied to /home/httpd/lonUsers/1/2/3/$course/userfiles in
3330: # course's home server.
3331: #
3332: # action = copy - /home/httpd/html/userfiles/$domain/1/2/3/$course/$file will
3333: # be copied from $source (current location) to
3334: # /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
3335: # and will then be copied to
3336: # /home/httpd/lonUsers/$domain/1/2/3/$course/userfiles/$file in
3337: # course's home server.
3338: #
3339: # action = uploaddoc - /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
3340: # will be retrived from $env{form.uploaddoc} (from DOCS interface) to
3341: # /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
3342: # and will then be copied to /home/httpd/lonUsers/1/2/3/$course/userfiles/$file
3343: # in course's home server.
3344: #
3345:
3346: sub process_coursefile {
3347: my ($action,$docuname,$docudom,$file,$source,$parser,$allfiles,$codebase,
3348: $mimetype)=@_;
3349: my $fetchresult;
3350: my $home=&homeserver($docuname,$docudom);
3351: if ($action eq 'propagate') {
3352: $fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
3353: $home);
3354: } else {
3355: my $fpath = '';
3356: my $fname = $file;
3357: ($fpath,$fname) = ($file =~ m|^(.*)/([^/]+)$|);
3358: $fpath=$docudom.'/'.$docuname.'/'.$fpath;
3359: my $filepath = &build_filepath($fpath);
3360: if ($action eq 'copy') {
3361: if ($source eq '') {
3362: $fetchresult = 'no source file';
3363: return $fetchresult;
3364: } else {
3365: my $destination = $filepath.'/'.$fname;
3366: rename($source,$destination);
3367: $fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
3368: $home);
3369: }
3370: } elsif ($action eq 'uploaddoc') {
3371: open(my $fh,'>'.$filepath.'/'.$fname);
3372: print $fh $env{'form.'.$source};
3373: close($fh);
3374: if ($parser eq 'parse') {
3375: my $mm = new File::MMagic;
3376: my $type = $mm->checktype_filename($filepath.'/'.$fname);
3377: if ($type eq 'text/html') {
3378: my $parse_result = &extract_embedded_items($filepath.'/'.$fname,$allfiles,$codebase);
3379: unless ($parse_result eq 'ok') {
3380: &logthis('Failed to parse '.$filepath.'/'.$fname.' for embedded media: '.$parse_result);
3381: }
3382: }
3383: if (ref($mimetype)) {
3384: $$mimetype = $type;
3385: }
3386: }
3387: $fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
3388: $home);
3389: if ($fetchresult eq 'ok') {
3390: return '/uploaded/'.$fpath.'/'.$fname;
3391: } else {
3392: &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$file.
3393: ' to host '.$home.': '.$fetchresult);
3394: return '/adm/notfound.html';
3395: }
3396: }
3397: }
3398: unless ( $fetchresult eq 'ok') {
3399: &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$file.
3400: ' to host '.$home.': '.$fetchresult);
3401: }
3402: return $fetchresult;
3403: }
3404:
3405: sub build_filepath {
3406: my ($fpath) = @_;
3407: my $filepath=$perlvar{'lonDocRoot'}.'/userfiles';
3408: unless ($fpath eq '') {
3409: my @parts=split('/',$fpath);
3410: foreach my $part (@parts) {
3411: $filepath.= '/'.$part;
3412: if ((-e $filepath)!=1) {
3413: mkdir($filepath,0777);
3414: }
3415: }
3416: }
3417: return $filepath;
3418: }
3419:
3420: sub store_edited_file {
3421: my ($primary_url,$content,$docudom,$docuname,$fetchresult) = @_;
3422: my $file = $primary_url;
3423: $file =~ s#^/uploaded/$docudom/$docuname/##;
3424: my $fpath = '';
3425: my $fname = $file;
3426: ($fpath,$fname) = ($file =~ m|^(.*)/([^/]+)$|);
3427: $fpath=$docudom.'/'.$docuname.'/'.$fpath;
3428: my $filepath = &build_filepath($fpath);
3429: open(my $fh,'>'.$filepath.'/'.$fname);
3430: print $fh $content;
3431: close($fh);
3432: my $home=&homeserver($docuname,$docudom);
3433: $$fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
3434: $home);
3435: if ($$fetchresult eq 'ok') {
3436: return '/uploaded/'.$fpath.'/'.$fname;
3437: } else {
3438: &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$file.
3439: ' to host '.$home.': '.$$fetchresult);
3440: return '/adm/notfound.html';
3441: }
3442: }
3443:
3444: sub clean_filename {
3445: my ($fname,$args)=@_;
3446: # Replace Windows backslashes by forward slashes
3447: $fname=~s/\\/\//g;
3448: if (!$args->{'keep_path'}) {
3449: # Get rid of everything but the actual filename
3450: $fname=~s/^.*\/([^\/]+)$/$1/;
3451: }
3452: # Replace spaces by underscores
3453: $fname=~s/\s+/\_/g;
3454: # Replace all other weird characters by nothing
3455: $fname=~s{[^/\w\.\-]}{}g;
3456: # Replace all .\d. sequences with _\d. so they no longer look like version
3457: # numbers
3458: $fname=~s/\.(\d+)(?=\.)/_$1/g;
3459: return $fname;
3460: }
3461: # This Function checks if an Image's dimensions exceed either $resizewidth (width)
3462: # or $resizeheight (height) - both pixels. If so, the image is scaled to produce an
3463: # image with the same aspect ratio as the original, but with dimensions which do
3464: # not exceed $resizewidth and $resizeheight.
3465:
3466: sub resizeImage {
3467: my ($img_path,$resizewidth,$resizeheight) = @_;
3468: my $ima = Image::Magick->new;
3469: my $resized;
3470: if (-e $img_path) {
3471: $ima->Read($img_path);
3472: if (($resizewidth =~ /^\d+$/) && ($resizeheight > 0)) {
3473: my $width = $ima->Get('width');
3474: my $height = $ima->Get('height');
3475: if ($width > $resizewidth) {
3476: my $factor = $width/$resizewidth;
3477: my $newheight = $height/$factor;
3478: $ima->Scale(width=>$resizewidth,height=>$newheight);
3479: $resized = 1;
3480: }
3481: }
3482: if (($resizeheight =~ /^\d+$/) && ($resizeheight > 0)) {
3483: my $width = $ima->Get('width');
3484: my $height = $ima->Get('height');
3485: if ($height > $resizeheight) {
3486: my $factor = $height/$resizeheight;
3487: my $newwidth = $width/$factor;
3488: $ima->Scale(width=>$newwidth,height=>$resizeheight);
3489: $resized = 1;
3490: }
3491: }
3492: if ($resized) {
3493: $ima->Write($img_path);
3494: }
3495: }
3496: return;
3497: }
3498:
3499: # --------------- Take an uploaded file and put it into the userfiles directory
3500: # input: $formname - the contents of the file are in $env{"form.$formname"}
3501: # the desired filename is in $env{"form.$formname.filename"}
3502: # $context - possible values: coursedoc, existingfile, overwrite,
3503: # canceloverwrite, or ''.
3504: # if 'coursedoc': upload to the current course
3505: # if 'existingfile': write file to tmp/overwrites directory
3506: # if 'canceloverwrite': delete file written to tmp/overwrites directory
3507: # $context is passed as argument to &finishuserfileupload
3508: # $subdir - directory in userfile to store the file into
3509: # $parser - instruction to parse file for objects ($parser = parse)
3510: # $allfiles - reference to hash for embedded objects
3511: # $codebase - reference to hash for codebase of java objects
3512: # $desuname - username for permanent storage of uploaded file
3513: # $dsetudom - domain for permanaent storage of uploaded file
3514: # $thumbwidth - width (pixels) of thumbnail to make for uploaded image
3515: # $thumbheight - height (pixels) of thumbnail to make for uploaded image
3516: # $resizewidth - width (pixels) to which to resize uploaded image
3517: # $resizeheight - height (pixels) to which to resize uploaded image
3518: # $mimetype - reference to scalar to accommodate mime type determined
3519: # from File::MMagic.
3520: #
3521: # output: url of file in userspace, or error: <message>
3522: # or /adm/notfound.html if failure to upload occurse
3523:
3524: sub userfileupload {
3525: my ($formname,$context,$subdir,$parser,$allfiles,$codebase,$destuname,
3526: $destudom,$thumbwidth,$thumbheight,$resizewidth,$resizeheight,$mimetype)=@_;
3527: if (!defined($subdir)) { $subdir='unknown'; }
3528: my $fname=$env{'form.'.$formname.'.filename'};
3529: $fname=&clean_filename($fname);
3530: # See if there is anything left
3531: unless ($fname) { return 'error: no uploaded file'; }
3532: # Files uploaded to help request form, or uploaded to "create course" page are handled differently
3533: if ((($formname eq 'screenshot') && ($subdir eq 'helprequests')) ||
3534: (($formname eq 'coursecreatorxml') && ($subdir eq 'batchupload')) ||
3535: ($context eq 'existingfile') || ($context eq 'canceloverwrite')) {
3536: my $now = time;
3537: my $filepath;
3538: if (($formname eq 'screenshot') && ($subdir eq 'helprequests')) {
3539: $filepath = 'tmp/helprequests/'.$now;
3540: } elsif (($formname eq 'coursecreatorxml') && ($subdir eq 'batchupload')) {
3541: $filepath = 'tmp/addcourse/'.$destudom.'/web/'.$env{'user.name'}.
3542: '_'.$env{'user.domain'}.'/pending';
3543: } elsif (($context eq 'existingfile') || ($context eq 'canceloverwrite')) {
3544: my ($docuname,$docudom);
3545: if ($destudom) {
3546: $docudom = $destudom;
3547: } else {
3548: $docudom = $env{'user.domain'};
3549: }
3550: if ($destuname) {
3551: $docuname = $destuname;
3552: } else {
3553: $docuname = $env{'user.name'};
3554: }
3555: if (exists($env{'form.group'})) {
3556: $docuname=$env{'course.'.$env{'request.course.id'}.'.num'};
3557: $docudom=$env{'course.'.$env{'request.course.id'}.'.domain'};
3558: }
3559: $filepath = 'tmp/overwrites/'.$docudom.'/'.$docuname.'/'.$subdir;
3560: if ($context eq 'canceloverwrite') {
3561: my $tempfile = $perlvar{'lonDaemons'}.'/'.$filepath.'/'.$fname;
3562: if (-e $tempfile) {
3563: my @info = stat($tempfile);
3564: if ($info[9] eq $env{'form.timestamp'}) {
3565: unlink($tempfile);
3566: }
3567: }
3568: return;
3569: }
3570: }
3571: # Create the directory if not present
3572: my @parts=split(/\//,$filepath);
3573: my $fullpath = $perlvar{'lonDaemons'};
3574: for (my $i=0;$i<@parts;$i++) {
3575: $fullpath .= '/'.$parts[$i];
3576: if ((-e $fullpath)!=1) {
3577: mkdir($fullpath,0777);
3578: }
3579: }
3580: open(my $fh,'>'.$fullpath.'/'.$fname);
3581: print $fh $env{'form.'.$formname};
3582: close($fh);
3583: if ($context eq 'existingfile') {
3584: my @info = stat($fullpath.'/'.$fname);
3585: return ($fullpath.'/'.$fname,$info[9]);
3586: } else {
3587: return $fullpath.'/'.$fname;
3588: }
3589: }
3590: if ($subdir eq 'scantron') {
3591: $fname = 'scantron_orig_'.$fname;
3592: } else {
3593: $fname="$subdir/$fname";
3594: }
3595: if ($context eq 'coursedoc') {
3596: my $docuname=$env{'course.'.$env{'request.course.id'}.'.num'};
3597: my $docudom=$env{'course.'.$env{'request.course.id'}.'.domain'};
3598: if ($env{'form.folder'} =~ m/^(default|supplemental)/) {
3599: return &finishuserfileupload($docuname,$docudom,
3600: $formname,$fname,$parser,$allfiles,
3601: $codebase,$thumbwidth,$thumbheight,
3602: $resizewidth,$resizeheight,$context,$mimetype);
3603: } else {
3604: if ($env{'form.folder'}) {
3605: $fname=$env{'form.folder'}.'/'.$fname;
3606: }
3607: return &process_coursefile('uploaddoc',$docuname,$docudom,
3608: $fname,$formname,$parser,
3609: $allfiles,$codebase,$mimetype);
3610: }
3611: } elsif (defined($destuname)) {
3612: my $docuname=$destuname;
3613: my $docudom=$destudom;
3614: return &finishuserfileupload($docuname,$docudom,$formname,$fname,
3615: $parser,$allfiles,$codebase,
3616: $thumbwidth,$thumbheight,
3617: $resizewidth,$resizeheight,$context,$mimetype);
3618: } else {
3619: my $docuname=$env{'user.name'};
3620: my $docudom=$env{'user.domain'};
3621: if ((exists($env{'form.group'})) || ($context eq 'syllabus')) {
3622: $docuname=$env{'course.'.$env{'request.course.id'}.'.num'};
3623: $docudom=$env{'course.'.$env{'request.course.id'}.'.domain'};
3624: }
3625: return &finishuserfileupload($docuname,$docudom,$formname,$fname,
3626: $parser,$allfiles,$codebase,
3627: $thumbwidth,$thumbheight,
3628: $resizewidth,$resizeheight,$context,$mimetype);
3629: }
3630: }
3631:
3632: sub finishuserfileupload {
3633: my ($docuname,$docudom,$formname,$fname,$parser,$allfiles,$codebase,
3634: $thumbwidth,$thumbheight,$resizewidth,$resizeheight,$context,$mimetype) = @_;
3635: my $path=$docudom.'/'.$docuname.'/';
3636: my $filepath=$perlvar{'lonDocRoot'};
3637:
3638: my ($fnamepath,$file,$fetchthumb);
3639: $file=$fname;
3640: if ($fname=~m|/|) {
3641: ($fnamepath,$file) = ($fname =~ m|^(.*)/([^/]+)$|);
3642: $path.=$fnamepath.'/';
3643: }
3644: my @parts=split(/\//,$filepath.'/userfiles/'.$path);
3645: my $count;
3646: for ($count=4;$count<=$#parts;$count++) {
3647: $filepath.="/$parts[$count]";
3648: if ((-e $filepath)!=1) {
3649: mkdir($filepath,0777);
3650: }
3651: }
3652:
3653: # Save the file
3654: {
3655: if (!open(FH,'>'.$filepath.'/'.$file)) {
3656: &logthis('Failed to create '.$filepath.'/'.$file);
3657: print STDERR ('Failed to create '.$filepath.'/'.$file."\n");
3658: return '/adm/notfound.html';
3659: }
3660: if ($context eq 'overwrite') {
3661: my $source = LONCAPA::tempdir().'/overwrites/'.$docudom.'/'.$docuname.'/'.$fname;
3662: my $target = $filepath.'/'.$file;
3663: if (-e $source) {
3664: my @info = stat($source);
3665: if ($info[9] eq $env{'form.timestamp'}) {
3666: unless (&File::Copy::move($source,$target)) {
3667: &logthis('Failed to overwrite '.$filepath.'/'.$file);
3668: return "Moving from $source failed";
3669: }
3670: } else {
3671: return "Temporary file: $source had unexpected date/time for last modification";
3672: }
3673: } else {
3674: return "Temporary file: $source missing";
3675: }
3676: } elsif (!print FH ($env{'form.'.$formname})) {
3677: &logthis('Failed to write to '.$filepath.'/'.$file);
3678: print STDERR ('Failed to write to '.$filepath.'/'.$file."\n");
3679: return '/adm/notfound.html';
3680: }
3681: close(FH);
3682: if ($resizewidth && $resizeheight) {
3683: my $mm = new File::MMagic;
3684: my $mime_type = $mm->checktype_filename($filepath.'/'.$file);
3685: if ($mime_type =~ m{^image/}) {
3686: &resizeImage($filepath.'/'.$file,$resizewidth,$resizeheight);
3687: }
3688: }
3689: }
3690: if (($context eq 'coursedoc') || ($parser eq 'parse')) {
3691: if (ref($mimetype)) {
3692: if ($$mimetype eq '') {
3693: my $mm = new File::MMagic;
3694: my $type = $mm->checktype_filename($filepath.'/'.$file);
3695: $$mimetype = $type;
3696: }
3697: }
3698: }
3699: if ($parser eq 'parse') {
3700: if ((ref($mimetype)) && ($$mimetype eq 'text/html')) {
3701: my $parse_result = &extract_embedded_items($filepath.'/'.$file,
3702: $allfiles,$codebase);
3703: unless ($parse_result eq 'ok') {
3704: &logthis('Failed to parse '.$filepath.$file.
3705: ' for embedded media: '.$parse_result);
3706: }
3707: }
3708: }
3709: if (($thumbwidth =~ /^\d+$/) && ($thumbheight =~ /^\d+$/)) {
3710: my $input = $filepath.'/'.$file;
3711: my $output = $filepath.'/'.'tn-'.$file;
3712: my $thumbsize = $thumbwidth.'x'.$thumbheight;
3713: system("convert -sample $thumbsize $input $output");
3714: if (-e $filepath.'/'.'tn-'.$file) {
3715: $fetchthumb = 1;
3716: }
3717: }
3718:
3719: # Notify homeserver to grep it
3720: #
3721: my $docuhome=&homeserver($docuname,$docudom);
3722: my $fetchresult= &reply('fetchuserfile:'.$path.$file,$docuhome);
3723: if ($fetchresult eq 'ok') {
3724: if ($fetchthumb) {
3725: my $thumbresult= &reply('fetchuserfile:'.$path.'tn-'.$file,$docuhome);
3726: if ($thumbresult ne 'ok') {
3727: &logthis('Failed to transfer '.$path.'tn-'.$file.' to host '.
3728: $docuhome.': '.$thumbresult);
3729: }
3730: }
3731: #
3732: # Return the URL to it
3733: return '/uploaded/'.$path.$file;
3734: } else {
3735: &logthis('Failed to transfer '.$path.$file.' to host '.$docuhome.
3736: ': '.$fetchresult);
3737: return '/adm/notfound.html';
3738: }
3739: }
3740:
3741: sub extract_embedded_items {
3742: my ($fullpath,$allfiles,$codebase,$content) = @_;
3743: my @state = ();
3744: my (%lastids,%related,%shockwave,%flashvars);
3745: my %javafiles = (
3746: codebase => '',
3747: code => '',
3748: archive => ''
3749: );
3750: my %mediafiles = (
3751: src => '',
3752: movie => '',
3753: );
3754: my $p;
3755: if ($content) {
3756: $p = HTML::LCParser->new($content);
3757: } else {
3758: $p = HTML::LCParser->new($fullpath);
3759: }
3760: while (my $t=$p->get_token()) {
3761: if ($t->[0] eq 'S') {
3762: my ($tagname, $attr) = ($t->[1],$t->[2]);
3763: push(@state, $tagname);
3764: if (lc($tagname) eq 'allow') {
3765: &add_filetype($allfiles,$attr->{'src'},'src');
3766: }
3767: if (lc($tagname) eq 'img') {
3768: &add_filetype($allfiles,$attr->{'src'},'src');
3769: }
3770: if (lc($tagname) eq 'a') {
3771: unless (($attr->{'href'} =~ /^#/) || ($attr->{'href'} eq '')) {
3772: &add_filetype($allfiles,$attr->{'href'},'href');
3773: }
3774: }
3775: if (lc($tagname) eq 'script') {
3776: my $src;
3777: if ($attr->{'archive'} =~ /\.jar$/i) {
3778: &add_filetype($allfiles,$attr->{'archive'},'archive');
3779: } else {
3780: if ($attr->{'src'} ne '') {
3781: $src = $attr->{'src'};
3782: &add_filetype($allfiles,$src,'src');
3783: }
3784: }
3785: my $text = $p->get_trimmed_text();
3786: if ($text =~ /\Qswfobject.registerObject(\E([^\)]+)\)/) {
3787: my @swfargs = split(/,/,$1);
3788: foreach my $item (@swfargs) {
3789: $item =~ s/["']//g;
3790: $item =~ s/^\s+//;
3791: $item =~ s/\s+$//;
3792: }
3793: if (($swfargs[0] ne'') && ($swfargs[2] ne '')) {
3794: if (ref($related{$swfargs[0]}) eq 'ARRAY') {
3795: push(@{$related{$swfargs[0]}},$swfargs[2]);
3796: } else {
3797: $related{$swfargs[0]} = [$swfargs[2]];
3798: }
3799: }
3800: }
3801: }
3802: if (lc($tagname) eq 'link') {
3803: if (lc($attr->{'rel'}) eq 'stylesheet') {
3804: &add_filetype($allfiles,$attr->{'href'},'href');
3805: }
3806: }
3807: if (lc($tagname) eq 'object' ||
3808: (lc($tagname) eq 'embed' && lc($state[-2]) ne 'object')) {
3809: foreach my $item (keys(%javafiles)) {
3810: $javafiles{$item} = '';
3811: }
3812: if ((lc($tagname) eq 'object') && (lc($state[-2]) ne 'object')) {
3813: $lastids{lc($tagname)} = $attr->{'id'};
3814: }
3815: }
3816: if (lc($state[-2]) eq 'object' && lc($tagname) eq 'param') {
3817: my $name = lc($attr->{'name'});
3818: foreach my $item (keys(%javafiles)) {
3819: if ($name eq $item) {
3820: $javafiles{$item} = $attr->{'value'};
3821: last;
3822: }
3823: }
3824: my $pathfrom;
3825: foreach my $item (keys(%mediafiles)) {
3826: if ($name eq $item) {
3827: $pathfrom = $attr->{'value'};
3828: $shockwave{$lastids{lc($state[-2])}} = $pathfrom;
3829: &add_filetype($allfiles,$pathfrom,$name);
3830: last;
3831: }
3832: }
3833: if ($name eq 'flashvars') {
3834: $flashvars{$lastids{lc($state[-2])}} = $attr->{'value'};
3835: }
3836: if ($pathfrom ne '') {
3837: &embedded_dependency($allfiles,\%related,$lastids{lc($state[-2])},
3838: $pathfrom);
3839: }
3840: }
3841: if (lc($tagname) eq 'embed' || lc($tagname) eq 'applet') {
3842: foreach my $item (keys(%javafiles)) {
3843: if ($attr->{$item}) {
3844: $javafiles{$item} = $attr->{$item};
3845: last;
3846: }
3847: }
3848: foreach my $item (keys(%mediafiles)) {
3849: if ($attr->{$item}) {
3850: &add_filetype($allfiles,$attr->{$item},$item);
3851: last;
3852: }
3853: }
3854: if (lc($tagname) eq 'embed') {
3855: if (($attr->{'name'} ne '') && ($attr->{'src'} ne '')) {
3856: &embedded_dependency($allfiles,\%related,$attr->{'name'},
3857: $attr->{'src'});
3858: }
3859: }
3860: }
3861: if (lc($tagname) eq 'iframe') {
3862: my $src = $attr->{'src'} ;
3863: if (($src ne '') && ($src !~ m{^(/|https?://)})) {
3864: &add_filetype($allfiles,$src,'src');
3865: } elsif ($src =~ m{^/}) {
3866: if ($env{'request.course.id'}) {
3867: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
3868: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
3869: my $url = &hreflocation('',$fullpath);
3870: if ($url =~ m{^/uploaded/$cdom/$cnum/docs/(\w+/\d+)/}) {
3871: my $relpath = $1;
3872: if ($src =~ m{^/uploaded/$cdom/$cnum/docs/\Q$relpath\E/(.+)$}) {
3873: &add_filetype($allfiles,$1,'src');
3874: }
3875: }
3876: }
3877: }
3878: }
3879: if ($t->[4] =~ m{/>$}) {
3880: pop(@state);
3881: }
3882: } elsif ($t->[0] eq 'E') {
3883: my ($tagname) = ($t->[1]);
3884: if ($javafiles{'codebase'} ne '') {
3885: $javafiles{'codebase'} .= '/';
3886: }
3887: if (lc($tagname) eq 'applet' ||
3888: lc($tagname) eq 'object' ||
3889: (lc($tagname) eq 'embed' && lc($state[-2]) ne 'object')
3890: ) {
3891: foreach my $item (keys(%javafiles)) {
3892: if ($item ne 'codebase' && $javafiles{$item} ne '') {
3893: my $file=$javafiles{'codebase'}.$javafiles{$item};
3894: &add_filetype($allfiles,$file,$item);
3895: }
3896: }
3897: }
3898: pop @state;
3899: }
3900: }
3901: foreach my $id (sort(keys(%flashvars))) {
3902: if ($shockwave{$id} ne '') {
3903: my @pairs = split(/\&/,$flashvars{$id});
3904: foreach my $pair (@pairs) {
3905: my ($key,$value) = split(/\=/,$pair);
3906: if ($key eq 'thumb') {
3907: &add_filetype($allfiles,$value,$key);
3908: } elsif ($key eq 'content') {
3909: my ($path) = ($shockwave{$id} =~ m{^(.+/)[^/]+$});
3910: my ($ext) = ($value =~ /\.([^.]+)$/);
3911: if ($ext ne '') {
3912: &add_filetype($allfiles,$path.$value,$ext);
3913: }
3914: }
3915: }
3916: }
3917: }
3918: return 'ok';
3919: }
3920:
3921: sub add_filetype {
3922: my ($allfiles,$file,$type)=@_;
3923: if (exists($allfiles->{$file})) {
3924: unless (grep/^\Q$type\E$/, @{$allfiles->{$file}}) {
3925: push(@{$allfiles->{$file}}, &escape($type));
3926: }
3927: } else {
3928: @{$allfiles->{$file}} = (&escape($type));
3929: }
3930: }
3931:
3932: sub embedded_dependency {
3933: my ($allfiles,$related,$identifier,$pathfrom) = @_;
3934: if ((ref($allfiles) eq 'HASH') && (ref($related) eq 'HASH')) {
3935: if (($identifier ne '') &&
3936: (ref($related->{$identifier}) eq 'ARRAY') &&
3937: ($pathfrom ne '')) {
3938: my ($path) = ($pathfrom =~ m{^(.+/)[^/]+$});
3939: foreach my $dep (@{$related->{$identifier}}) {
3940: &add_filetype($allfiles,$path.$dep,'object');
3941: }
3942: }
3943: }
3944: return;
3945: }
3946:
3947: sub removeuploadedurl {
3948: my ($url)=@_;
3949: my (undef,undef,$udom,$uname,$fname)=split('/',$url,5);
3950: return &removeuserfile($uname,$udom,$fname);
3951: }
3952:
3953: sub removeuserfile {
3954: my ($docuname,$docudom,$fname)=@_;
3955: my $home=&homeserver($docuname,$docudom);
3956: my $result = &reply("removeuserfile:$docudom/$docuname/$fname",$home);
3957: if ($result eq 'ok') {
3958: if (($fname !~ /\.meta$/) && (&is_portfolio_file($fname))) {
3959: my $metafile = $fname.'.meta';
3960: my $metaresult = &removeuserfile($docuname,$docudom,$metafile);
3961: my $url = "/uploaded/$docudom/$docuname/$fname";
3962: my ($file,$group) = (&parse_portfolio_url($url))[3,4];
3963: my $sqlresult =
3964: &update_portfolio_table($docuname,$docudom,$file,
3965: 'portfolio_metadata',$group,
3966: 'delete');
3967: }
3968: }
3969: return $result;
3970: }
3971:
3972: sub mkdiruserfile {
3973: my ($docuname,$docudom,$dir)=@_;
3974: my $home=&homeserver($docuname,$docudom);
3975: return &reply("mkdiruserfile:".&escape("$docudom/$docuname/$dir"),$home);
3976: }
3977:
3978: sub renameuserfile {
3979: my ($docuname,$docudom,$old,$new)=@_;
3980: my $home=&homeserver($docuname,$docudom);
3981: my $result = &reply("renameuserfile:$docudom:$docuname:".
3982: &escape("$old").':'.&escape("$new"),$home);
3983: if ($result eq 'ok') {
3984: if (($old !~ /\.meta$/) && (&is_portfolio_file($old))) {
3985: my $oldmeta = $old.'.meta';
3986: my $newmeta = $new.'.meta';
3987: my $metaresult =
3988: &renameuserfile($docuname,$docudom,$oldmeta,$newmeta);
3989: my $url = "/uploaded/$docudom/$docuname/$old";
3990: my ($file,$group) = (&parse_portfolio_url($url))[3,4];
3991: my $sqlresult =
3992: &update_portfolio_table($docuname,$docudom,$file,
3993: 'portfolio_metadata',$group,
3994: 'delete');
3995: }
3996: }
3997: return $result;
3998: }
3999:
4000: # ------------------------------------------------------------------------- Log
4001:
4002: sub log {
4003: my ($dom,$nam,$hom,$what)=@_;
4004: return critical("log:$dom:$nam:$what",$hom);
4005: }
4006:
4007: # ------------------------------------------------------------------ Course Log
4008: #
4009: # This routine flushes several buffers of non-mission-critical nature
4010: #
4011:
4012: sub flushcourselogs {
4013: &logthis('Flushing log buffers');
4014: #
4015: # course logs
4016: # This is a log of all transactions in a course, which can be used
4017: # for data mining purposes
4018: #
4019: # It also collects the courseid database, which lists last transaction
4020: # times and course titles for all courseids
4021: #
4022: my %courseidbuffer=();
4023: foreach my $crsid (keys(%courselogs)) {
4024: if (&reply('log:'.$coursedombuf{$crsid}.':'.$coursenumbuf{$crsid}.':'.
4025: &escape($courselogs{$crsid}),
4026: $coursehombuf{$crsid}) eq 'ok') {
4027: delete $courselogs{$crsid};
4028: } else {
4029: &logthis('Failed to flush log buffer for '.$crsid);
4030: if (length($courselogs{$crsid})>40000) {
4031: &logthis("<font color=\"blue\">WARNING: Buffer for ".$crsid.
4032: " exceeded maximum size, deleting.</font>");
4033: delete $courselogs{$crsid};
4034: }
4035: }
4036: $courseidbuffer{$coursehombuf{$crsid}}{$crsid} = {
4037: 'description' => $coursedescrbuf{$crsid},
4038: 'inst_code' => $courseinstcodebuf{$crsid},
4039: 'type' => $coursetypebuf{$crsid},
4040: 'owner' => $courseownerbuf{$crsid},
4041: };
4042: }
4043: #
4044: # Write course id database (reverse lookup) to homeserver of courses
4045: # Is used in pickcourse
4046: #
4047: foreach my $crs_home (keys(%courseidbuffer)) {
4048: my $response = &courseidput(&host_domain($crs_home),
4049: $courseidbuffer{$crs_home},
4050: $crs_home,'timeonly');
4051: }
4052: #
4053: # File accesses
4054: # Writes to the dynamic metadata of resources to get hit counts, etc.
4055: #
4056: foreach my $entry (keys(%accesshash)) {
4057: if ($entry =~ /___count$/) {
4058: my ($dom,$name);
4059: ($dom,$name,undef)=
4060: ($entry=~m{___($match_domain)/($match_name)/(.*)___count$});
4061: if (! defined($dom) || $dom eq '' ||
4062: ! defined($name) || $name eq '') {
4063: my $cid = $env{'request.course.id'};
4064: $dom = $env{'request.'.$cid.'.domain'};
4065: $name = $env{'request.'.$cid.'.num'};
4066: }
4067: my $value = $accesshash{$entry};
4068: my (undef,$url,undef) = ($entry =~ /^(.*)___(.*)___count$/);
4069: my %temphash=($url => $value);
4070: my $result = &inc('nohist_accesscount',\%temphash,$dom,$name);
4071: if ($result eq 'ok') {
4072: delete $accesshash{$entry};
4073: }
4074: } else {
4075: my ($dom,$name) = ($entry=~m{___($match_domain)/($match_name)/(.*)___(\w+)$});
4076: if (($dom eq 'uploaded') || ($dom eq 'adm')) { next; }
4077: my %temphash=($entry => $accesshash{$entry});
4078: if (&put('nohist_resevaldata',\%temphash,$dom,$name) eq 'ok') {
4079: delete $accesshash{$entry};
4080: }
4081: }
4082: }
4083: #
4084: # Roles
4085: # Reverse lookup of user roles for course faculty/staff and co-authorship
4086: #
4087: foreach my $entry (keys(%userrolehash)) {
4088: my ($role,$uname,$udom,$runame,$rudom,$rsec)=
4089: split(/\:/,$entry);
4090: if (&Apache::lonnet::put('nohist_userroles',
4091: { $role.':'.$uname.':'.$udom.':'.$rsec => $userrolehash{$entry} },
4092: $rudom,$runame) eq 'ok') {
4093: delete $userrolehash{$entry};
4094: }
4095: }
4096: #
4097: # Reverse lookup of domain roles (dc, ad, li, sc, au)
4098: #
4099: my %domrolebuffer = ();
4100: foreach my $entry (keys(%domainrolehash)) {
4101: my ($role,$uname,$udom,$runame,$rudom,$rsec)=split(/:/,$entry);
4102: if ($domrolebuffer{$rudom}) {
4103: $domrolebuffer{$rudom}.='&'.&escape($entry).
4104: '='.&escape($domainrolehash{$entry});
4105: } else {
4106: $domrolebuffer{$rudom}.=&escape($entry).
4107: '='.&escape($domainrolehash{$entry});
4108: }
4109: delete $domainrolehash{$entry};
4110: }
4111: foreach my $dom (keys(%domrolebuffer)) {
4112: my %servers = &get_servers($dom,'library');
4113: foreach my $tryserver (keys(%servers)) {
4114: unless (&reply('domroleput:'.$dom.':'.
4115: $domrolebuffer{$dom},$tryserver) eq 'ok') {
4116: &logthis('Put of domain roles failed for '.$dom.' and '.$tryserver);
4117: }
4118: }
4119: }
4120: $dumpcount++;
4121: }
4122:
4123: sub courselog {
4124: my $what=shift;
4125: $what=time.':'.$what;
4126: unless ($env{'request.course.id'}) { return ''; }
4127: $coursedombuf{$env{'request.course.id'}}=
4128: $env{'course.'.$env{'request.course.id'}.'.domain'};
4129: $coursenumbuf{$env{'request.course.id'}}=
4130: $env{'course.'.$env{'request.course.id'}.'.num'};
4131: $coursehombuf{$env{'request.course.id'}}=
4132: $env{'course.'.$env{'request.course.id'}.'.home'};
4133: $coursedescrbuf{$env{'request.course.id'}}=
4134: $env{'course.'.$env{'request.course.id'}.'.description'};
4135: $courseinstcodebuf{$env{'request.course.id'}}=
4136: $env{'course.'.$env{'request.course.id'}.'.internal.coursecode'};
4137: $courseownerbuf{$env{'request.course.id'}}=
4138: $env{'course.'.$env{'request.course.id'}.'.internal.courseowner'};
4139: $coursetypebuf{$env{'request.course.id'}}=
4140: $env{'course.'.$env{'request.course.id'}.'.type'};
4141: if (defined $courselogs{$env{'request.course.id'}}) {
4142: $courselogs{$env{'request.course.id'}}.='&'.$what;
4143: } else {
4144: $courselogs{$env{'request.course.id'}}.=$what;
4145: }
4146: if (length($courselogs{$env{'request.course.id'}})>4048) {
4147: &flushcourselogs();
4148: }
4149: }
4150:
4151: sub courseacclog {
4152: my $fnsymb=shift;
4153: unless ($env{'request.course.id'}) { return ''; }
4154: my $what=$fnsymb.':'.$env{'user.name'}.':'.$env{'user.domain'};
4155: if ($fnsymb=~/$LONCAPA::assess_re/) {
4156: $what.=':POST';
4157: # FIXME: Probably ought to escape things....
4158: foreach my $key (keys(%env)) {
4159: if ($key=~/^form\.(.*)/) {
4160: my $formitem = $1;
4161: if ($formitem =~ /^HWFILE(?:SIZE|TOOBIG)/) {
4162: $what.=':'.$formitem.'='.$env{$key};
4163: } elsif ($formitem !~ /^HWFILE(?:[^.]+)$/) {
4164: $what.=':'.$formitem.'='.$env{$key};
4165: }
4166: }
4167: }
4168: } elsif ($fnsymb =~ m:^/adm/searchcat:) {
4169: # FIXME: We should not be depending on a form parameter that someone
4170: # editing lonsearchcat.pm might change in the future.
4171: if ($env{'form.phase'} eq 'course_search') {
4172: $what.= ':POST';
4173: # FIXME: Probably ought to escape things....
4174: foreach my $element ('courseexp','crsfulltext','crsrelated',
4175: 'crsdiscuss') {
4176: $what.=':'.$element.'='.$env{'form.'.$element};
4177: }
4178: }
4179: }
4180: &courselog($what);
4181: }
4182:
4183: sub countacc {
4184: my $url=&declutter(shift);
4185: return if (! defined($url) || $url eq '');
4186: unless ($env{'request.course.id'}) { return ''; }
4187: #
4188: # Mark that this url was used in this course
4189: #
4190: $accesshash{$env{'request.course.id'}.'___'.$url.'___course'}=1;
4191: #
4192: # Increase the access count for this resource in this child process
4193: #
4194: my $key=$$.$processmarker.'_'.$dumpcount.'___'.$url.'___count';
4195: $accesshash{$key}++;
4196: }
4197:
4198: sub linklog {
4199: my ($from,$to)=@_;
4200: $from=&declutter($from);
4201: $to=&declutter($to);
4202: $accesshash{$from.'___'.$to.'___comefrom'}=1;
4203: $accesshash{$to.'___'.$from.'___goto'}=1;
4204: }
4205:
4206: sub statslog {
4207: my ($symb,$part,$users,$av_attempts,$degdiff)=@_;
4208: if ($users<2) { return; }
4209: my %dynstore=&LONCAPA::lonmetadata::dynamic_metadata_storage({
4210: 'course' => $env{'request.course.id'},
4211: 'sections' => '"all"',
4212: 'num_students' => $users,
4213: 'part' => $part,
4214: 'symb' => $symb,
4215: 'mean_tries' => $av_attempts,
4216: 'deg_of_diff' => $degdiff});
4217: foreach my $key (keys(%dynstore)) {
4218: $accesshash{$key}=$dynstore{$key};
4219: }
4220: }
4221:
4222: sub userrolelog {
4223: my ($trole,$username,$domain,$area,$tstart,$tend)=@_;
4224: if ( $trole =~ /^(ca|aa|in|cc|ep|cr|ta|co)/ ) {
4225: my (undef,$rudom,$runame,$rsec)=split(/\//,$area);
4226: $userrolehash
4227: {$trole.':'.$username.':'.$domain.':'.$runame.':'.$rudom.':'.$rsec}
4228: =$tend.':'.$tstart;
4229: }
4230: if ($env{'request.role'} =~ /dc\./ && $trole =~ /^(au|in|cc|ep|cr|ta|co)/) {
4231: $userrolehash
4232: {$trole.':'.$username.':'.$domain.':'.$env{'user.name'}.':'.$env{'user.domain'}.':'}
4233: =$tend.':'.$tstart;
4234: }
4235: if ($trole =~ /^(dc|ad|li|au|dg|sc)/ ) {
4236: my (undef,$rudom,$runame,$rsec)=split(/\//,$area);
4237: $domainrolehash
4238: {$trole.':'.$username.':'.$domain.':'.$runame.':'.$rudom.':'.$rsec}
4239: = $tend.':'.$tstart;
4240: }
4241: }
4242:
4243: sub courserolelog {
4244: my ($trole,$username,$domain,$area,$tstart,$tend,$delflag,$selfenroll,$context)=@_;
4245: if ($area =~ m-^/($match_domain)/($match_courseid)/?([^/]*)-) {
4246: my $cdom = $1;
4247: my $cnum = $2;
4248: my $sec = $3;
4249: my $namespace = 'rolelog';
4250: my %storehash = (
4251: role => $trole,
4252: start => $tstart,
4253: end => $tend,
4254: selfenroll => $selfenroll,
4255: context => $context,
4256: );
4257: if ($trole eq 'gr') {
4258: $namespace = 'groupslog';
4259: $storehash{'group'} = $sec;
4260: } else {
4261: $storehash{'section'} = $sec;
4262: }
4263: &write_log('course',$namespace,\%storehash,$delflag,$username,
4264: $domain,$cnum,$cdom);
4265: if (($trole ne 'st') || ($sec ne '')) {
4266: &devalidate_cache_new('getcourseroles',$cdom.'_'.$cnum);
4267: }
4268: }
4269: return;
4270: }
4271:
4272: sub domainrolelog {
4273: my ($trole,$username,$domain,$area,$tstart,$tend,$delflag,$context)=@_;
4274: if ($area =~ m{^/($match_domain)/$}) {
4275: my $cdom = $1;
4276: my $domconfiguser = &Apache::lonnet::get_domainconfiguser($cdom);
4277: my $namespace = 'rolelog';
4278: my %storehash = (
4279: role => $trole,
4280: start => $tstart,
4281: end => $tend,
4282: context => $context,
4283: );
4284: &write_log('domain',$namespace,\%storehash,$delflag,$username,
4285: $domain,$domconfiguser,$cdom);
4286: }
4287: return;
4288:
4289: }
4290:
4291: sub coauthorrolelog {
4292: my ($trole,$username,$domain,$area,$tstart,$tend,$delflag,$context)=@_;
4293: if ($area =~ m{^/($match_domain)/($match_username)$}) {
4294: my $audom = $1;
4295: my $auname = $2;
4296: my $namespace = 'rolelog';
4297: my %storehash = (
4298: role => $trole,
4299: start => $tstart,
4300: end => $tend,
4301: context => $context,
4302: );
4303: &write_log('author',$namespace,\%storehash,$delflag,$username,
4304: $domain,$auname,$audom);
4305: }
4306: return;
4307: }
4308:
4309: sub get_course_adv_roles {
4310: my ($cid,$codes) = @_;
4311: $cid=$env{'request.course.id'} unless (defined($cid));
4312: my %coursehash=&coursedescription($cid);
4313: my $crstype = &Apache::loncommon::course_type($cid);
4314: my %nothide=();
4315: foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
4316: if ($user !~ /:/) {
4317: $nothide{join(':',split(/[\@]/,$user))}=1;
4318: } else {
4319: $nothide{$user}=1;
4320: }
4321: }
4322: my @possdoms = ($coursehash{'domain'});
4323: if ($coursehash{'checkforpriv'}) {
4324: push(@possdoms,split(/,/,$coursehash{'checkforpriv'}));
4325: }
4326: my %returnhash=();
4327: my %dumphash=
4328: &dump('nohist_userroles',$coursehash{'domain'},$coursehash{'num'});
4329: my $now=time;
4330: my %privileged;
4331: foreach my $entry (keys(%dumphash)) {
4332: my ($tend,$tstart)=split(/\:/,$dumphash{$entry});
4333: if (($tstart) && ($tstart<0)) { next; }
4334: if (($tend) && ($tend<$now)) { next; }
4335: if (($tstart) && ($now<$tstart)) { next; }
4336: my ($role,$username,$domain,$section)=split(/\:/,$entry);
4337: if ($username eq '' || $domain eq '') { next; }
4338: if ((&privileged($username,$domain,\@possdoms)) &&
4339: (!$nothide{$username.':'.$domain})) { next; }
4340: if ($role eq 'cr') { next; }
4341: if ($codes) {
4342: if ($section) { $role .= ':'.$section; }
4343: if ($returnhash{$role}) {
4344: $returnhash{$role}.=','.$username.':'.$domain;
4345: } else {
4346: $returnhash{$role}=$username.':'.$domain;
4347: }
4348: } else {
4349: my $key=&plaintext($role,$crstype);
4350: if ($section) { $key.=' ('.&Apache::lonlocal::mt('Section [_1]',$section).')'; }
4351: if ($returnhash{$key}) {
4352: $returnhash{$key}.=','.$username.':'.$domain;
4353: } else {
4354: $returnhash{$key}=$username.':'.$domain;
4355: }
4356: }
4357: }
4358: return %returnhash;
4359: }
4360:
4361: sub get_my_roles {
4362: my ($uname,$udom,$context,$types,$roles,$roledoms,$withsec,$hidepriv)=@_;
4363: unless (defined($uname)) { $uname=$env{'user.name'}; }
4364: unless (defined($udom)) { $udom=$env{'user.domain'}; }
4365: my (%dumphash,%nothide);
4366: if ($context eq 'userroles') {
4367: %dumphash = &dump('roles',$udom,$uname);
4368: } else {
4369: %dumphash = &dump('nohist_userroles',$udom,$uname);
4370: if ($hidepriv) {
4371: my %coursehash=&coursedescription($udom.'_'.$uname);
4372: foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
4373: if ($user !~ /:/) {
4374: $nothide{join(':',split(/[\@]/,$user))} = 1;
4375: } else {
4376: $nothide{$user} = 1;
4377: }
4378: }
4379: }
4380: }
4381: my %returnhash=();
4382: my $now=time;
4383: my %privileged;
4384: foreach my $entry (keys(%dumphash)) {
4385: my ($role,$tend,$tstart);
4386: if ($context eq 'userroles') {
4387: next if ($entry =~ /^rolesdef/);
4388: ($role,$tend,$tstart)=split(/_/,$dumphash{$entry});
4389: } else {
4390: ($tend,$tstart)=split(/\:/,$dumphash{$entry});
4391: }
4392: if (($tstart) && ($tstart<0)) { next; }
4393: my $status = 'active';
4394: if (($tend) && ($tend<=$now)) {
4395: $status = 'previous';
4396: }
4397: if (($tstart) && ($now<$tstart)) {
4398: $status = 'future';
4399: }
4400: if (ref($types) eq 'ARRAY') {
4401: if (!grep(/^\Q$status\E$/,@{$types})) {
4402: next;
4403: }
4404: } else {
4405: if ($status ne 'active') {
4406: next;
4407: }
4408: }
4409: my ($rolecode,$username,$domain,$section,$area);
4410: if ($context eq 'userroles') {
4411: ($area,$rolecode) = ($entry =~ /^(.+)_([^_]+)$/);
4412: (undef,$domain,$username,$section) = split(/\//,$area);
4413: } else {
4414: ($role,$username,$domain,$section) = split(/\:/,$entry);
4415: }
4416: if (ref($roledoms) eq 'ARRAY') {
4417: if (!grep(/^\Q$domain\E$/,@{$roledoms})) {
4418: next;
4419: }
4420: }
4421: if (ref($roles) eq 'ARRAY') {
4422: if (!grep(/^\Q$role\E$/,@{$roles})) {
4423: if ($role =~ /^cr\//) {
4424: if (!grep(/^cr$/,@{$roles})) {
4425: next;
4426: }
4427: } elsif ($role =~ /^gr\//) {
4428: if (!grep(/^gr$/,@{$roles})) {
4429: next;
4430: }
4431: } else {
4432: next;
4433: }
4434: }
4435: }
4436: if ($hidepriv) {
4437: my @privroles = ('dc','su');
4438: if ($context eq 'userroles') {
4439: next if (grep(/^\Q$role\E$/,@privroles));
4440: } else {
4441: my $possdoms = [$domain];
4442: if (ref($roledoms) eq 'ARRAY') {
4443: push(@{$possdoms},@{$roledoms});
4444: }
4445: if (&privileged($username,$domain,$possdoms,\@privroles)) {
4446: if (!$nothide{$username.':'.$domain}) {
4447: next;
4448: }
4449: }
4450: }
4451: }
4452: if ($withsec) {
4453: $returnhash{$username.':'.$domain.':'.$role.':'.$section} =
4454: $tstart.':'.$tend;
4455: } else {
4456: $returnhash{$username.':'.$domain.':'.$role}=$tstart.':'.$tend;
4457: }
4458: }
4459: return %returnhash;
4460: }
4461:
4462: # ----------------------------------------------------- Frontpage Announcements
4463: #
4464: #
4465:
4466: sub postannounce {
4467: my ($server,$text)=@_;
4468: unless (&allowed('psa',&host_domain($server))) { return 'refused'; }
4469: unless ($text=~/\w/) { $text=''; }
4470: return &reply('setannounce:'.&escape($text),$server);
4471: }
4472:
4473: sub getannounce {
4474:
4475: if (open(my $fh,$perlvar{'lonDocRoot'}.'/announcement.txt')) {
4476: my $announcement='';
4477: while (my $line = <$fh>) { $announcement .= $line; }
4478: close($fh);
4479: if ($announcement=~/\w/) {
4480: return
4481: '<table bgcolor="#FF5555" cellpadding="5" cellspacing="3">'.
4482: '<tr><td bgcolor="#FFFFFF"><tt>'.$announcement.'</tt></td></tr></table>';
4483: } else {
4484: return '';
4485: }
4486: } else {
4487: return '';
4488: }
4489: }
4490:
4491: # ---------------------------------------------------------- Course ID routines
4492: # Deal with domain's nohist_courseid.db files
4493: #
4494:
4495: sub courseidput {
4496: my ($domain,$storehash,$coursehome,$caller) = @_;
4497: return unless (ref($storehash) eq 'HASH');
4498: my $outcome;
4499: if ($caller eq 'timeonly') {
4500: my $cids = '';
4501: foreach my $item (keys(%$storehash)) {
4502: $cids.=&escape($item).'&';
4503: }
4504: $cids=~s/\&$//;
4505: $outcome = &reply('courseidputhash:'.$domain.':'.$caller.':'.$cids,
4506: $coursehome);
4507: } else {
4508: my $items = '';
4509: foreach my $item (keys(%$storehash)) {
4510: $items.= &escape($item).'='.
4511: &freeze_escape($$storehash{$item}).'&';
4512: }
4513: $items=~s/\&$//;
4514: $outcome = &reply('courseidputhash:'.$domain.':'.$caller.':'.$items,
4515: $coursehome);
4516: }
4517: if ($outcome eq 'unknown_cmd') {
4518: my $what;
4519: foreach my $cid (keys(%$storehash)) {
4520: $what .= &escape($cid).'=';
4521: foreach my $item ('description','inst_code','owner','type') {
4522: $what .= &escape($storehash->{$cid}{$item}).':';
4523: }
4524: $what =~ s/\:$/&/;
4525: }
4526: $what =~ s/\&$//;
4527: return &reply('courseidput:'.$domain.':'.$what,$coursehome);
4528: } else {
4529: return $outcome;
4530: }
4531: }
4532:
4533: sub courseiddump {
4534: my ($domfilter,$descfilter,$sincefilter,$instcodefilter,$ownerfilter,
4535: $coursefilter,$hostidflag,$hostidref,$typefilter,$regexp_ok,
4536: $selfenrollonly,$catfilter,$showhidden,$caller,$cloner,$cc_clone,
4537: $cloneonly,$createdbefore,$createdafter,$creationcontext,$domcloner,
4538: $hasuniquecode,$reqcrsdom,$reqinstcode)=@_;
4539: my $as_hash = 1;
4540: my %returnhash;
4541: if (!$domfilter) { $domfilter=''; }
4542: my %libserv = &all_library();
4543: foreach my $tryserver (keys(%libserv)) {
4544: if ( ( $hostidflag == 1
4545: && grep(/^\Q$tryserver\E$/,@{$hostidref}) )
4546: || (!defined($hostidflag)) ) {
4547:
4548: if (($domfilter eq '') ||
4549: (&host_domain($tryserver) eq $domfilter)) {
4550: my $rep;
4551: if (grep { $_ eq $tryserver } current_machine_ids()) {
4552: $rep = LONCAPA::Lond::dump_course_id_handler(
4553: join(":", (&host_domain($tryserver), $sincefilter,
4554: &escape($descfilter), &escape($instcodefilter),
4555: &escape($ownerfilter), &escape($coursefilter),
4556: &escape($typefilter), &escape($regexp_ok),
4557: $as_hash, &escape($selfenrollonly),
4558: &escape($catfilter), $showhidden, $caller,
4559: &escape($cloner), &escape($cc_clone), $cloneonly,
4560: &escape($createdbefore), &escape($createdafter),
4561: &escape($creationcontext),$domcloner,$hasuniquecode,
4562: $reqcrsdom,&escape($reqinstcode))));
4563: } else {
4564: $rep = &reply('courseiddump:'.&host_domain($tryserver).':'.
4565: $sincefilter.':'.&escape($descfilter).':'.
4566: &escape($instcodefilter).':'.&escape($ownerfilter).
4567: ':'.&escape($coursefilter).':'.&escape($typefilter).
4568: ':'.&escape($regexp_ok).':'.$as_hash.':'.
4569: &escape($selfenrollonly).':'.&escape($catfilter).':'.
4570: $showhidden.':'.$caller.':'.&escape($cloner).':'.
4571: &escape($cc_clone).':'.$cloneonly.':'.
4572: &escape($createdbefore).':'.&escape($createdafter).':'.
4573: &escape($creationcontext).':'.$domcloner.':'.$hasuniquecode.
4574: ':'.$reqcrsdom.':'.&escape($reqinstcode),$tryserver);
4575: }
4576:
4577: my @pairs=split(/\&/,$rep);
4578: foreach my $item (@pairs) {
4579: my ($key,$value)=split(/\=/,$item,2);
4580: $key = &unescape($key);
4581: next if ($key =~ /^error: 2 /);
4582: my $result = &thaw_unescape($value);
4583: if (ref($result) eq 'HASH') {
4584: $returnhash{$key}=$result;
4585: } else {
4586: my @responses = split(/:/,$value);
4587: my @items = ('description','inst_code','owner','type');
4588: for (my $i=0; $i<@responses; $i++) {
4589: $returnhash{$key}{$items[$i]} = &unescape($responses[$i]);
4590: }
4591: }
4592: }
4593: }
4594: }
4595: }
4596: return %returnhash;
4597: }
4598:
4599: sub courselastaccess {
4600: my ($cdom,$cnum,$hostidref) = @_;
4601: my %returnhash;
4602: if ($cdom && $cnum) {
4603: my $chome = &homeserver($cnum,$cdom);
4604: if ($chome ne 'no_host') {
4605: my $rep = &reply('courselastaccess:'.$cdom.':'.$cnum,$chome);
4606: &extract_lastaccess(\%returnhash,$rep);
4607: }
4608: } else {
4609: if (!$cdom) { $cdom=''; }
4610: my %libserv = &all_library();
4611: foreach my $tryserver (keys(%libserv)) {
4612: if (ref($hostidref) eq 'ARRAY') {
4613: next unless (grep(/^\Q$tryserver\E$/,@{$hostidref}));
4614: }
4615: if (($cdom eq '') || (&host_domain($tryserver) eq $cdom)) {
4616: my $rep = &reply('courselastaccess:'.&host_domain($tryserver).':',$tryserver);
4617: &extract_lastaccess(\%returnhash,$rep);
4618: }
4619: }
4620: }
4621: return %returnhash;
4622: }
4623:
4624: sub extract_lastaccess {
4625: my ($returnhash,$rep) = @_;
4626: if (ref($returnhash) eq 'HASH') {
4627: unless ($rep eq 'unknown_command' || $rep eq 'no_such_host' ||
4628: $rep eq 'con_lost' || $rep eq 'rejected' || $rep eq 'refused' ||
4629: $rep eq '') {
4630: my @pairs=split(/\&/,$rep);
4631: foreach my $item (@pairs) {
4632: my ($key,$value)=split(/\=/,$item,2);
4633: $key = &unescape($key);
4634: next if ($key =~ /^error: 2 /);
4635: $returnhash->{$key} = &thaw_unescape($value);
4636: }
4637: }
4638: }
4639: return;
4640: }
4641:
4642: # ---------------------------------------------------------- DC e-mail
4643:
4644: sub dcmailput {
4645: my ($domain,$msgid,$message,$server)=@_;
4646: my $status = &Apache::lonnet::critical(
4647: 'dcmailput:'.$domain.':'.&escape($msgid).'='.
4648: &escape($message),$server);
4649: return $status;
4650: }
4651:
4652: sub dcmaildump {
4653: my ($dom,$startdate,$enddate,$senders) = @_;
4654: my %returnhash=();
4655:
4656: if (defined(&domain($dom,'primary'))) {
4657: my $cmd='dcmaildump:'.$dom.':'.&escape($startdate).':'.
4658: &escape($enddate).':';
4659: my @esc_senders=map { &escape($_)} @$senders;
4660: $cmd.=&escape(join('&',@esc_senders));
4661: foreach my $line (split(/\&/,&reply($cmd,&domain($dom,'primary')))) {
4662: my ($key,$value) = split(/\=/,$line,2);
4663: if (($key) && ($value)) {
4664: $returnhash{&unescape($key)} = &unescape($value);
4665: }
4666: }
4667: }
4668: return %returnhash;
4669: }
4670: # ---------------------------------------------------------- Domain roles
4671:
4672: sub get_domain_roles {
4673: my ($dom,$roles,$startdate,$enddate)=@_;
4674: if ((!defined($startdate)) || ($startdate eq '')) {
4675: $startdate = '.';
4676: }
4677: if ((!defined($enddate)) || ($enddate eq '')) {
4678: $enddate = '.';
4679: }
4680: my $rolelist;
4681: if (ref($roles) eq 'ARRAY') {
4682: $rolelist = join('&',@{$roles});
4683: }
4684: my %personnel = ();
4685:
4686: my %servers = &get_servers($dom,'library');
4687: foreach my $tryserver (keys(%servers)) {
4688: %{$personnel{$tryserver}}=();
4689: foreach my $line (split(/\&/,&reply('domrolesdump:'.$dom.':'.
4690: &escape($startdate).':'.
4691: &escape($enddate).':'.
4692: &escape($rolelist), $tryserver))) {
4693: my ($key,$value) = split(/\=/,$line,2);
4694: if (($key) && ($value)) {
4695: $personnel{$tryserver}{&unescape($key)} = &unescape($value);
4696: }
4697: }
4698: }
4699: return %personnel;
4700: }
4701:
4702: # ----------------------------------------------------------- Interval timing
4703:
4704: {
4705: # Caches needed for speedup of navmaps
4706: # We don't want to cache this for very long at all (5 seconds at most)
4707: #
4708: # The user for whom we cache
4709: my $cachedkey='';
4710: # The cached times for this user
4711: my %cachedtimes=();
4712: # When this was last done
4713: my $cachedtime='';
4714:
4715: sub load_all_first_access {
4716: my ($uname,$udom,$ignorecache)=@_;
4717: if (($cachedkey eq $uname.':'.$udom) &&
4718: (abs($cachedtime-time)<5) && (!$env{'form.markaccess'}) &&
4719: (!$ignorecache)) {
4720: return;
4721: }
4722: $cachedtime=time;
4723: $cachedkey=$uname.':'.$udom;
4724: %cachedtimes=&dump('firstaccesstimes',$udom,$uname);
4725: }
4726:
4727: sub get_first_access {
4728: my ($type,$argsymb,$argmap,$ignorecache)=@_;
4729: my ($symb,$courseid,$udom,$uname)=&whichuser();
4730: if ($argsymb) { $symb=$argsymb; }
4731: my ($map,$id,$res)=&decode_symb($symb);
4732: if ($argmap) { $map = $argmap; }
4733: if ($type eq 'course') {
4734: $res='course';
4735: } elsif ($type eq 'map') {
4736: $res=&symbread($map);
4737: } else {
4738: $res=$symb;
4739: }
4740: &load_all_first_access($uname,$udom,$ignorecache);
4741: return $cachedtimes{"$courseid\0$res"};
4742: }
4743:
4744: sub set_first_access {
4745: my ($type,$interval)=@_;
4746: my ($symb,$courseid,$udom,$uname)=&whichuser();
4747: my ($map,$id,$res)=&decode_symb($symb);
4748: if ($type eq 'course') {
4749: $res='course';
4750: } elsif ($type eq 'map') {
4751: $res=&symbread($map);
4752: } else {
4753: $res=$symb;
4754: }
4755: $cachedkey='';
4756: my $firstaccess=&get_first_access($type,$symb,$map);
4757: if (!$firstaccess) {
4758: my $start = time;
4759: my $putres = &put('firstaccesstimes',{"$courseid\0$res"=>$start},
4760: $udom,$uname);
4761: if ($putres eq 'ok') {
4762: &put('timerinterval',{"$courseid\0$res"=>$interval},
4763: $udom,$uname);
4764: &appenv(
4765: {
4766: 'course.'.$courseid.'.firstaccess.'.$res => $start,
4767: 'course.'.$courseid.'.timerinterval.'.$res => $interval,
4768: }
4769: );
4770: }
4771: return $putres;
4772: }
4773: return 'already_set';
4774: }
4775: }
4776:
4777: # --------------------------------------------- Set Expire Date for Spreadsheet
4778:
4779: sub expirespread {
4780: my ($uname,$udom,$stype,$usymb)=@_;
4781: my $cid=$env{'request.course.id'};
4782: if ($cid) {
4783: my $now=time;
4784: my $key=$uname.':'.$udom.':'.$stype.':'.$usymb;
4785: return &reply('put:'.$env{'course.'.$cid.'.domain'}.':'.
4786: $env{'course.'.$cid.'.num'}.
4787: ':nohist_expirationdates:'.
4788: &escape($key).'='.$now,
4789: $env{'course.'.$cid.'.home'})
4790: }
4791: return 'ok';
4792: }
4793:
4794: # ----------------------------------------------------- Devalidate Spreadsheets
4795:
4796: sub devalidate {
4797: my ($symb,$uname,$udom)=@_;
4798: my $cid=$env{'request.course.id'};
4799: if ($cid) {
4800: # delete the stored spreadsheets for
4801: # - the student level sheet of this user in course's homespace
4802: # - the assessment level sheet for this resource
4803: # for this user in user's homespace
4804: # - current conditional state info
4805: my $key=$uname.':'.$udom.':';
4806: my $status=
4807: &del('nohist_calculatedsheets',
4808: [$key.'studentcalc:'],
4809: $env{'course.'.$cid.'.domain'},
4810: $env{'course.'.$cid.'.num'})
4811: .' '.
4812: &del('nohist_calculatedsheets_'.$cid,
4813: [$key.'assesscalc:'.$symb],$udom,$uname);
4814: unless ($status eq 'ok ok') {
4815: &logthis('Could not devalidate spreadsheet '.
4816: $uname.' at '.$udom.' for '.
4817: $symb.': '.$status);
4818: }
4819: &delenv('user.state.'.$cid);
4820: }
4821: }
4822:
4823: sub get_scalar {
4824: my ($string,$end) = @_;
4825: my $value;
4826: if ($$string =~ s/^([^&]*?)($end)/$2/) {
4827: $value = $1;
4828: } elsif ($$string =~ s/^([^&]*?)&//) {
4829: $value = $1;
4830: }
4831: return &unescape($value);
4832: }
4833:
4834: sub array2str {
4835: my (@array) = @_;
4836: my $result=&arrayref2str(\@array);
4837: $result=~s/^__ARRAY_REF__//;
4838: $result=~s/__END_ARRAY_REF__$//;
4839: return $result;
4840: }
4841:
4842: sub arrayref2str {
4843: my ($arrayref) = @_;
4844: my $result='__ARRAY_REF__';
4845: foreach my $elem (@$arrayref) {
4846: if(ref($elem) eq 'ARRAY') {
4847: $result.=&arrayref2str($elem).'&';
4848: } elsif(ref($elem) eq 'HASH') {
4849: $result.=&hashref2str($elem).'&';
4850: } elsif(ref($elem)) {
4851: #print("Got a ref of ".(ref($elem))." skipping.");
4852: } else {
4853: $result.=&escape($elem).'&';
4854: }
4855: }
4856: $result=~s/\&$//;
4857: $result .= '__END_ARRAY_REF__';
4858: return $result;
4859: }
4860:
4861: sub hash2str {
4862: my (%hash) = @_;
4863: my $result=&hashref2str(\%hash);
4864: $result=~s/^__HASH_REF__//;
4865: $result=~s/__END_HASH_REF__$//;
4866: return $result;
4867: }
4868:
4869: sub hashref2str {
4870: my ($hashref)=@_;
4871: my $result='__HASH_REF__';
4872: foreach my $key (sort(keys(%$hashref))) {
4873: if (ref($key) eq 'ARRAY') {
4874: $result.=&arrayref2str($key).'=';
4875: } elsif (ref($key) eq 'HASH') {
4876: $result.=&hashref2str($key).'=';
4877: } elsif (ref($key)) {
4878: $result.='=';
4879: #print("Got a ref of ".(ref($key))." skipping.");
4880: } else {
4881: if (defined($key)) {$result.=&escape($key).'=';} else { last; }
4882: }
4883:
4884: if(ref($hashref->{$key}) eq 'ARRAY') {
4885: $result.=&arrayref2str($hashref->{$key}).'&';
4886: } elsif(ref($hashref->{$key}) eq 'HASH') {
4887: $result.=&hashref2str($hashref->{$key}).'&';
4888: } elsif(ref($hashref->{$key})) {
4889: $result.='&';
4890: #print("Got a ref of ".(ref($hashref->{$key}))." skipping.");
4891: } else {
4892: $result.=&escape($hashref->{$key}).'&';
4893: }
4894: }
4895: $result=~s/\&$//;
4896: $result .= '__END_HASH_REF__';
4897: return $result;
4898: }
4899:
4900: sub str2hash {
4901: my ($string)=@_;
4902: my ($hash)=&str2hashref('__HASH_REF__'.$string.'__END_HASH_REF__');
4903: return %$hash;
4904: }
4905:
4906: sub str2hashref {
4907: my ($string) = @_;
4908:
4909: my %hash;
4910:
4911: if($string !~ /^__HASH_REF__/) {
4912: if (! ($string eq '' || !defined($string))) {
4913: $hash{'error'}='Not hash reference';
4914: }
4915: return (\%hash, $string);
4916: }
4917:
4918: $string =~ s/^__HASH_REF__//;
4919:
4920: while($string !~ /^__END_HASH_REF__/) {
4921: #key
4922: my $key='';
4923: if($string =~ /^__HASH_REF__/) {
4924: ($key, $string)=&str2hashref($string);
4925: if(defined($key->{'error'})) {
4926: $hash{'error'}='Bad data';
4927: return (\%hash, $string);
4928: }
4929: } elsif($string =~ /^__ARRAY_REF__/) {
4930: ($key, $string)=&str2arrayref($string);
4931: if($key->[0] eq 'Array reference error') {
4932: $hash{'error'}='Bad data';
4933: return (\%hash, $string);
4934: }
4935: } else {
4936: $string =~ s/^(.*?)=//;
4937: $key=&unescape($1);
4938: }
4939: $string =~ s/^=//;
4940:
4941: #value
4942: my $value='';
4943: if($string =~ /^__HASH_REF__/) {
4944: ($value, $string)=&str2hashref($string);
4945: if(defined($value->{'error'})) {
4946: $hash{'error'}='Bad data';
4947: return (\%hash, $string);
4948: }
4949: } elsif($string =~ /^__ARRAY_REF__/) {
4950: ($value, $string)=&str2arrayref($string);
4951: if($value->[0] eq 'Array reference error') {
4952: $hash{'error'}='Bad data';
4953: return (\%hash, $string);
4954: }
4955: } else {
4956: $value=&get_scalar(\$string,'__END_HASH_REF__');
4957: }
4958: $string =~ s/^&//;
4959:
4960: $hash{$key}=$value;
4961: }
4962:
4963: $string =~ s/^__END_HASH_REF__//;
4964:
4965: return (\%hash, $string);
4966: }
4967:
4968: sub str2array {
4969: my ($string)=@_;
4970: my ($array)=&str2arrayref('__ARRAY_REF__'.$string.'__END_ARRAY_REF__');
4971: return @$array;
4972: }
4973:
4974: sub str2arrayref {
4975: my ($string) = @_;
4976: my @array;
4977:
4978: if($string !~ /^__ARRAY_REF__/) {
4979: if (! ($string eq '' || !defined($string))) {
4980: $array[0]='Array reference error';
4981: }
4982: return (\@array, $string);
4983: }
4984:
4985: $string =~ s/^__ARRAY_REF__//;
4986:
4987: while($string !~ /^__END_ARRAY_REF__/) {
4988: my $value='';
4989: if($string =~ /^__HASH_REF__/) {
4990: ($value, $string)=&str2hashref($string);
4991: if(defined($value->{'error'})) {
4992: $array[0] ='Array reference error';
4993: return (\@array, $string);
4994: }
4995: } elsif($string =~ /^__ARRAY_REF__/) {
4996: ($value, $string)=&str2arrayref($string);
4997: if($value->[0] eq 'Array reference error') {
4998: $array[0] ='Array reference error';
4999: return (\@array, $string);
5000: }
5001: } else {
5002: $value=&get_scalar(\$string,'__END_ARRAY_REF__');
5003: }
5004: $string =~ s/^&//;
5005:
5006: push(@array, $value);
5007: }
5008:
5009: $string =~ s/^__END_ARRAY_REF__//;
5010:
5011: return (\@array, $string);
5012: }
5013:
5014: # -------------------------------------------------------------------Temp Store
5015:
5016: sub tmpreset {
5017: my ($symb,$namespace,$domain,$stuname) = @_;
5018: if (!$symb) {
5019: $symb=&symbread();
5020: if (!$symb) { $symb= $env{'request.url'}; }
5021: }
5022: $symb=escape($symb);
5023:
5024: if (!$namespace) { $namespace=$env{'request.state'}; }
5025: $namespace=~s/\//\_/g;
5026: $namespace=~s/\W//g;
5027:
5028: if (!$domain) { $domain=$env{'user.domain'}; }
5029: if (!$stuname) { $stuname=$env{'user.name'}; }
5030: if ($domain eq 'public' && $stuname eq 'public') {
5031: $stuname=$ENV{'REMOTE_ADDR'};
5032: }
5033: my $path=LONCAPA::tempdir();
5034: my %hash;
5035: if (tie(%hash,'GDBM_File',
5036: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
5037: &GDBM_WRCREAT(),0640)) {
5038: foreach my $key (keys(%hash)) {
5039: if ($key=~ /:$symb/) {
5040: delete($hash{$key});
5041: }
5042: }
5043: }
5044: }
5045:
5046: sub tmpstore {
5047: my ($storehash,$symb,$namespace,$domain,$stuname) = @_;
5048:
5049: if (!$symb) {
5050: $symb=&symbread();
5051: if (!$symb) { $symb= $env{'request.url'}; }
5052: }
5053: $symb=escape($symb);
5054:
5055: if (!$namespace) {
5056: # I don't think we would ever want to store this for a course.
5057: # it seems this will only be used if we don't have a course.
5058: #$namespace=$env{'request.course.id'};
5059: #if (!$namespace) {
5060: $namespace=$env{'request.state'};
5061: #}
5062: }
5063: $namespace=~s/\//\_/g;
5064: $namespace=~s/\W//g;
5065: if (!$domain) { $domain=$env{'user.domain'}; }
5066: if (!$stuname) { $stuname=$env{'user.name'}; }
5067: if ($domain eq 'public' && $stuname eq 'public') {
5068: $stuname=$ENV{'REMOTE_ADDR'};
5069: }
5070: my $now=time;
5071: my %hash;
5072: my $path=LONCAPA::tempdir();
5073: if (tie(%hash,'GDBM_File',
5074: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
5075: &GDBM_WRCREAT(),0640)) {
5076: $hash{"version:$symb"}++;
5077: my $version=$hash{"version:$symb"};
5078: my $allkeys='';
5079: foreach my $key (keys(%$storehash)) {
5080: $allkeys.=$key.':';
5081: $hash{"$version:$symb:$key"}=&freeze_escape($$storehash{$key});
5082: }
5083: $hash{"$version:$symb:timestamp"}=$now;
5084: $allkeys.='timestamp';
5085: $hash{"$version:keys:$symb"}=$allkeys;
5086: if (untie(%hash)) {
5087: return 'ok';
5088: } else {
5089: return "error:$!";
5090: }
5091: } else {
5092: return "error:$!";
5093: }
5094: }
5095:
5096: # -----------------------------------------------------------------Temp Restore
5097:
5098: sub tmprestore {
5099: my ($symb,$namespace,$domain,$stuname) = @_;
5100:
5101: if (!$symb) {
5102: $symb=&symbread();
5103: if (!$symb) { $symb= $env{'request.url'}; }
5104: }
5105: $symb=escape($symb);
5106:
5107: if (!$namespace) { $namespace=$env{'request.state'}; }
5108:
5109: if (!$domain) { $domain=$env{'user.domain'}; }
5110: if (!$stuname) { $stuname=$env{'user.name'}; }
5111: if ($domain eq 'public' && $stuname eq 'public') {
5112: $stuname=$ENV{'REMOTE_ADDR'};
5113: }
5114: my %returnhash;
5115: $namespace=~s/\//\_/g;
5116: $namespace=~s/\W//g;
5117: my %hash;
5118: my $path=LONCAPA::tempdir();
5119: if (tie(%hash,'GDBM_File',
5120: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
5121: &GDBM_READER(),0640)) {
5122: my $version=$hash{"version:$symb"};
5123: $returnhash{'version'}=$version;
5124: my $scope;
5125: for ($scope=1;$scope<=$version;$scope++) {
5126: my $vkeys=$hash{"$scope:keys:$symb"};
5127: my @keys=split(/:/,$vkeys);
5128: my $key;
5129: $returnhash{"$scope:keys"}=$vkeys;
5130: foreach $key (@keys) {
5131: $returnhash{"$scope:$key"}=&thaw_unescape($hash{"$scope:$symb:$key"});
5132: $returnhash{"$key"}=&thaw_unescape($hash{"$scope:$symb:$key"});
5133: }
5134: }
5135: if (!(untie(%hash))) {
5136: return "error:$!";
5137: }
5138: } else {
5139: return "error:$!";
5140: }
5141: return %returnhash;
5142: }
5143:
5144: # ----------------------------------------------------------------------- Store
5145:
5146: sub store {
5147: my ($storehash,$symb,$namespace,$domain,$stuname,$laststore) = @_;
5148: my $home='';
5149:
5150: if ($stuname) { $home=&homeserver($stuname,$domain); }
5151:
5152: $symb=&symbclean($symb);
5153: if (!$symb) { unless ($symb=&symbread()) { return ''; } }
5154:
5155: if (!$domain) { $domain=$env{'user.domain'}; }
5156: if (!$stuname) { $stuname=$env{'user.name'}; }
5157:
5158: &devalidate($symb,$stuname,$domain);
5159:
5160: $symb=escape($symb);
5161: if (!$namespace) {
5162: unless ($namespace=$env{'request.course.id'}) {
5163: return '';
5164: }
5165: }
5166: if (!$home) { $home=$env{'user.home'}; }
5167:
5168: $$storehash{'ip'}=$ENV{'REMOTE_ADDR'};
5169: $$storehash{'host'}=$perlvar{'lonHostID'};
5170:
5171: my $namevalue='';
5172: foreach my $key (keys(%$storehash)) {
5173: $namevalue.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
5174: }
5175: $namevalue=~s/\&$//;
5176: &courselog($symb.':'.$stuname.':'.$domain.':STORE:'.$namevalue);
5177: return reply("store:$domain:$stuname:$namespace:$symb:$namevalue:$laststore","$home");
5178: }
5179:
5180: # -------------------------------------------------------------- Critical Store
5181:
5182: sub cstore {
5183: my ($storehash,$symb,$namespace,$domain,$stuname,$laststore) = @_;
5184: my $home='';
5185:
5186: if ($stuname) { $home=&homeserver($stuname,$domain); }
5187:
5188: $symb=&symbclean($symb);
5189: if (!$symb) { unless ($symb=&symbread()) { return ''; } }
5190:
5191: if (!$domain) { $domain=$env{'user.domain'}; }
5192: if (!$stuname) { $stuname=$env{'user.name'}; }
5193:
5194: &devalidate($symb,$stuname,$domain);
5195:
5196: $symb=escape($symb);
5197: if (!$namespace) {
5198: unless ($namespace=$env{'request.course.id'}) {
5199: return '';
5200: }
5201: }
5202: if (!$home) { $home=$env{'user.home'}; }
5203:
5204: $$storehash{'ip'}=$ENV{'REMOTE_ADDR'};
5205: $$storehash{'host'}=$perlvar{'lonHostID'};
5206:
5207: my $namevalue='';
5208: foreach my $key (keys(%$storehash)) {
5209: $namevalue.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
5210: }
5211: $namevalue=~s/\&$//;
5212: &courselog($symb.':'.$stuname.':'.$domain.':CSTORE:'.$namevalue);
5213: return critical
5214: ("store:$domain:$stuname:$namespace:$symb:$namevalue:$laststore","$home");
5215: }
5216:
5217: # --------------------------------------------------------------------- Restore
5218:
5219: sub restore {
5220: my ($symb,$namespace,$domain,$stuname) = @_;
5221: my $home='';
5222:
5223: if ($stuname) { $home=&homeserver($stuname,$domain); }
5224:
5225: if (!$symb) {
5226: return if ($namespace eq 'courserequests');
5227: unless ($symb=escape(&symbread())) { return ''; }
5228: } else {
5229: unless ($namespace eq 'courserequests') {
5230: $symb=&escape(&symbclean($symb));
5231: }
5232: }
5233: if (!$namespace) {
5234: unless ($namespace=$env{'request.course.id'}) {
5235: return '';
5236: }
5237: }
5238: if (!$domain) { $domain=$env{'user.domain'}; }
5239: if (!$stuname) { $stuname=$env{'user.name'}; }
5240: if (!$home) { $home=$env{'user.home'}; }
5241: my $answer=&reply("restore:$domain:$stuname:$namespace:$symb","$home");
5242:
5243: my %returnhash=();
5244: foreach my $line (split(/\&/,$answer)) {
5245: my ($name,$value)=split(/\=/,$line);
5246: $returnhash{&unescape($name)}=&thaw_unescape($value);
5247: }
5248: my $version;
5249: for ($version=1;$version<=$returnhash{'version'};$version++) {
5250: foreach my $item (split(/\:/,$returnhash{$version.':keys'})) {
5251: $returnhash{$item}=$returnhash{$version.':'.$item};
5252: }
5253: }
5254: return %returnhash;
5255: }
5256:
5257: # ---------------------------------------------------------- Course Description
5258: #
5259: #
5260:
5261: sub coursedescription {
5262: my ($courseid,$args)=@_;
5263: $courseid=~s/^\///;
5264: $courseid=~s/\_/\//g;
5265: my ($cdomain,$cnum)=split(/\//,$courseid);
5266: my $chome=&homeserver($cnum,$cdomain);
5267: my $normalid=$cdomain.'_'.$cnum;
5268: # need to always cache even if we get errors otherwise we keep
5269: # trying and trying and trying to get the course description.
5270: my %envhash=();
5271: my %returnhash=();
5272:
5273: my $expiretime=600;
5274: if ($env{'request.course.id'} eq $normalid) {
5275: $expiretime=120;
5276: }
5277:
5278: my $prefix='course.'.$cdomain.'_'.$cnum.'.';
5279: if (!$args->{'freshen_cache'}
5280: && ((time-$env{$prefix.'last_cache'}) < $expiretime) ) {
5281: foreach my $key (keys(%env)) {
5282: next if ($key !~ /^\Q$prefix\E(.*)/);
5283: my ($setting) = $1;
5284: $returnhash{$setting} = $env{$key};
5285: }
5286: return %returnhash;
5287: }
5288:
5289: # get the data again
5290:
5291: if (!$args->{'one_time'}) {
5292: $envhash{'course.'.$normalid.'.last_cache'}=time;
5293: }
5294:
5295: if ($chome ne 'no_host') {
5296: %returnhash=&dump('environment',$cdomain,$cnum);
5297: if (!exists($returnhash{'con_lost'})) {
5298: my $username = $env{'user.name'}; # Defult username
5299: if(defined $args->{'user'}) {
5300: $username = $args->{'user'};
5301: }
5302: $returnhash{'home'}= $chome;
5303: $returnhash{'domain'} = $cdomain;
5304: $returnhash{'num'} = $cnum;
5305: if (!defined($returnhash{'type'})) {
5306: $returnhash{'type'} = 'Course';
5307: }
5308: while (my ($name,$value) = each %returnhash) {
5309: $envhash{'course.'.$normalid.'.'.$name}=$value;
5310: }
5311: $returnhash{'url'}=&clutter($returnhash{'url'});
5312: $returnhash{'fn'}=LONCAPA::tempdir() .
5313: $username.'_'.$cdomain.'_'.$cnum;
5314: $envhash{'course.'.$normalid.'.home'}=$chome;
5315: $envhash{'course.'.$normalid.'.domain'}=$cdomain;
5316: $envhash{'course.'.$normalid.'.num'}=$cnum;
5317: }
5318: }
5319: if (!$args->{'one_time'}) {
5320: &appenv(\%envhash);
5321: }
5322: return %returnhash;
5323: }
5324:
5325: sub update_released_required {
5326: my ($needsrelease,$cdom,$cnum,$chome,$cid) = @_;
5327: if ($cdom eq '' || $cnum eq '' || $chome eq '' || $cid eq '') {
5328: $cid = $env{'request.course.id'};
5329: $cdom = $env{'course.'.$cid.'.domain'};
5330: $cnum = $env{'course.'.$cid.'.num'};
5331: $chome = $env{'course.'.$cid.'.home'};
5332: }
5333: if ($needsrelease) {
5334: my %curr_reqd_hash = &userenvironment($cdom,$cnum,'internal.releaserequired');
5335: my $needsupdate;
5336: if ($curr_reqd_hash{'internal.releaserequired'} eq '') {
5337: $needsupdate = 1;
5338: } else {
5339: my ($currmajor,$currminor) = split(/\./,$curr_reqd_hash{'internal.releaserequired'});
5340: my ($needsmajor,$needsminor) = split(/\./,$needsrelease);
5341: if (($currmajor < $needsmajor) || ($currmajor == $needsmajor && $currminor < $needsminor)) {
5342: $needsupdate = 1;
5343: }
5344: }
5345: if ($needsupdate) {
5346: my %needshash = (
5347: 'internal.releaserequired' => $needsrelease,
5348: );
5349: my $putresult = &put('environment',\%needshash,$cdom,$cnum);
5350: if ($putresult eq 'ok') {
5351: &appenv({'course.'.$cid.'.internal.releaserequired' => $needsrelease});
5352: my %crsinfo = &courseiddump($cdom,'.',1,'.','.',$cnum,undef,undef,'.');
5353: if (ref($crsinfo{$cid}) eq 'HASH') {
5354: $crsinfo{$cid}{'releaserequired'} = $needsrelease;
5355: &courseidput($cdom,\%crsinfo,$chome,'notime');
5356: }
5357: }
5358: }
5359: }
5360: return;
5361: }
5362:
5363: # -------------------------------------------------See if a user is privileged
5364:
5365: sub privileged {
5366: my ($username,$domain,$possdomains,$possroles)=@_;
5367: my $now = time;
5368: my $roles;
5369: if (ref($possroles) eq 'ARRAY') {
5370: $roles = $possroles;
5371: } else {
5372: $roles = ['dc','su'];
5373: }
5374: if (ref($possdomains) eq 'ARRAY') {
5375: my %privileged = &privileged_by_domain($possdomains,$roles);
5376: foreach my $dom (@{$possdomains}) {
5377: if (($username =~ /^$match_username$/) && ($domain =~ /^$match_domain$/) &&
5378: (ref($privileged{$dom}) eq 'HASH')) {
5379: foreach my $role (@{$roles}) {
5380: if (ref($privileged{$dom}{$role}) eq 'HASH') {
5381: if (exists($privileged{$dom}{$role}{$username.':'.$domain})) {
5382: my ($end,$start) = split(/:/,$privileged{$dom}{$role}{$username.':'.$domain});
5383: return 1 unless (($end && $end < $now) ||
5384: ($start && $start > $now));
5385: }
5386: }
5387: }
5388: }
5389: }
5390: } else {
5391: my %rolesdump = &dump("roles", $domain, $username) or return 0;
5392: my $now = time;
5393:
5394: for my $role (@rolesdump{grep { ! /^rolesdef_/ } keys(%rolesdump)}) {
5395: my ($trole, $tend, $tstart) = split(/_/, $role);
5396: if (grep(/^\Q$trole\E$/,@{$roles})) {
5397: return 1 unless ($tend && $tend < $now)
5398: or ($tstart && $tstart > $now);
5399: }
5400: }
5401: }
5402: return 0;
5403: }
5404:
5405: sub privileged_by_domain {
5406: my ($domains,$roles) = @_;
5407: my %privileged = ();
5408: my $cachetime = 60*60*24;
5409: my $now = time;
5410: unless ((ref($domains) eq 'ARRAY') && (ref($roles) eq 'ARRAY')) {
5411: return %privileged;
5412: }
5413: foreach my $dom (@{$domains}) {
5414: next if (ref($privileged{$dom}) eq 'HASH');
5415: my $needroles;
5416: foreach my $role (@{$roles}) {
5417: my ($result,$cached)=&is_cached_new('priv_'.$role,$dom);
5418: if (defined($cached)) {
5419: if (ref($result) eq 'HASH') {
5420: $privileged{$dom}{$role} = $result;
5421: }
5422: } else {
5423: $needroles = 1;
5424: }
5425: }
5426: if ($needroles) {
5427: my %dompersonnel = &get_domain_roles($dom,$roles);
5428: $privileged{$dom} = {};
5429: foreach my $server (keys(%dompersonnel)) {
5430: if (ref($dompersonnel{$server}) eq 'HASH') {
5431: foreach my $item (keys(%{$dompersonnel{$server}})) {
5432: my ($trole,$uname,$udom,$rest) = split(/:/,$item,4);
5433: my ($end,$start) = split(/:/,$dompersonnel{$server}{$item});
5434: next if ($end && $end < $now);
5435: $privileged{$dom}{$trole}{$uname.':'.$udom} =
5436: $dompersonnel{$server}{$item};
5437: }
5438: }
5439: }
5440: if (ref($privileged{$dom}) eq 'HASH') {
5441: foreach my $role (@{$roles}) {
5442: if (ref($privileged{$dom}{$role}) eq 'HASH') {
5443: &do_cache_new('priv_'.$role,$dom,$privileged{$dom}{$role},$cachetime);
5444: } else {
5445: my %hash = ();
5446: &do_cache_new('priv_'.$role,$dom,\%hash,$cachetime);
5447: }
5448: }
5449: }
5450: }
5451: }
5452: return %privileged;
5453: }
5454:
5455: # -------------------------------------------------------- Get user privileges
5456:
5457: sub rolesinit {
5458: my ($domain, $username) = @_;
5459: my %userroles = ('user.login.time' => time);
5460: my %rolesdump = &dump("roles", $domain, $username) or return \%userroles;
5461:
5462: # firstaccess and timerinterval are related to timed maps/resources.
5463: # also, blocking can be triggered by an activating timer
5464: # it's saved in the user's %env.
5465: my %firstaccess = &dump('firstaccesstimes', $domain, $username);
5466: my %timerinterval = &dump('timerinterval', $domain, $username);
5467: my (%coursetimerstarts, %firstaccchk, %firstaccenv, %coursetimerintervals,
5468: %timerintchk, %timerintenv);
5469:
5470: foreach my $key (keys(%firstaccess)) {
5471: my ($cid, $rest) = split(/\0/, $key);
5472: $coursetimerstarts{$cid}{$rest} = $firstaccess{$key};
5473: }
5474:
5475: foreach my $key (keys(%timerinterval)) {
5476: my ($cid,$rest) = split(/\0/,$key);
5477: $coursetimerintervals{$cid}{$rest} = $timerinterval{$key};
5478: }
5479:
5480: my %allroles=();
5481: my %allgroups=();
5482:
5483: for my $area (grep { ! /^rolesdef_/ } keys(%rolesdump)) {
5484: my $role = $rolesdump{$area};
5485: $area =~ s/\_\w\w$//;
5486:
5487: my ($trole, $tend, $tstart, $group_privs);
5488:
5489: if ($role =~ /^cr/) {
5490: # Custom role, defined by a user
5491: # e.g., user.role.cr/msu/smith/mynewrole
5492: if ($role =~ m|^(cr/$match_domain/$match_username/[a-zA-Z0-9]+)_(.*)$|) {
5493: $trole = $1;
5494: ($tend, $tstart) = split('_', $2);
5495: } else {
5496: $trole = $role;
5497: }
5498: } elsif ($role =~ m|^gr/|) {
5499: # Role of member in a group, defined within a course/community
5500: # e.g., user.role.gr/msu/04935610a19ee4a5fmsul1/leopards
5501: ($trole, $tend, $tstart) = split(/_/, $role);
5502: next if $tstart eq '-1';
5503: ($trole, $group_privs) = split(/\//, $trole);
5504: $group_privs = &unescape($group_privs);
5505: } else {
5506: # Just a normal role, defined in roles.tab
5507: ($trole, $tend, $tstart) = split(/_/,$role);
5508: }
5509:
5510: my %new_role = &set_arearole($trole,$area,$tstart,$tend,$domain,
5511: $username);
5512: @userroles{keys(%new_role)} = @new_role{keys(%new_role)};
5513:
5514: # role expired or not available yet?
5515: $trole = '' if ($tend != 0 && $tend < $userroles{'user.login.time'}) or
5516: ($tstart != 0 && $tstart > $userroles{'user.login.time'});
5517:
5518: next if $area eq '' or $trole eq '';
5519:
5520: my $spec = "$trole.$area";
5521: my ($tdummy, $tdomain, $trest) = split(/\//, $area);
5522:
5523: if ($trole =~ /^cr\//) {
5524: # Custom role, defined by a user
5525: &custom_roleprivs(\%allroles,$trole,$tdomain,$trest,$spec,$area);
5526: } elsif ($trole eq 'gr') {
5527: # Role of a member in a group, defined within a course/community
5528: &group_roleprivs(\%allgroups,$area,$group_privs,$tend,$tstart);
5529: next;
5530: } else {
5531: # Normal role, defined in roles.tab
5532: &standard_roleprivs(\%allroles,$trole,$tdomain,$spec,$trest,$area);
5533: }
5534:
5535: my $cid = $tdomain.'_'.$trest;
5536: unless ($firstaccchk{$cid}) {
5537: if (ref($coursetimerstarts{$cid}) eq 'HASH') {
5538: foreach my $item (keys(%{$coursetimerstarts{$cid}})) {
5539: $firstaccenv{'course.'.$cid.'.firstaccess.'.$item} =
5540: $coursetimerstarts{$cid}{$item};
5541: }
5542: }
5543: $firstaccchk{$cid} = 1;
5544: }
5545: unless ($timerintchk{$cid}) {
5546: if (ref($coursetimerintervals{$cid}) eq 'HASH') {
5547: foreach my $item (keys(%{$coursetimerintervals{$cid}})) {
5548: $timerintenv{'course.'.$cid.'.timerinterval.'.$item} =
5549: $coursetimerintervals{$cid}{$item};
5550: }
5551: }
5552: $timerintchk{$cid} = 1;
5553: }
5554: }
5555:
5556: @userroles{'user.author', 'user.adv'} = &set_userprivs(\%userroles,
5557: \%allroles, \%allgroups);
5558: $env{'user.adv'} = $userroles{'user.adv'};
5559:
5560: return (\%userroles,\%firstaccenv,\%timerintenv);
5561: }
5562:
5563: sub set_arearole {
5564: my ($trole,$area,$tstart,$tend,$domain,$username,$nolog) = @_;
5565: unless ($nolog) {
5566: # log the associated role with the area
5567: &userrolelog($trole,$username,$domain,$area,$tstart,$tend);
5568: }
5569: return ('user.role.'.$trole.'.'.$area => $tstart.'.'.$tend);
5570: }
5571:
5572: sub custom_roleprivs {
5573: my ($allroles,$trole,$tdomain,$trest,$spec,$area) = @_;
5574: my ($rdummy,$rdomain,$rauthor,$rrole)=split(/\//,$trole);
5575: my $homsvr = &homeserver($rauthor,$rdomain);
5576: if (&hostname($homsvr) ne '') {
5577: my ($rdummy,$roledef)=
5578: &get('roles',["rolesdef_$rrole"],$rdomain,$rauthor);
5579: if (($rdummy ne 'con_lost') && ($roledef ne '')) {
5580: my ($syspriv,$dompriv,$coursepriv)=split(/\_/,$roledef);
5581: if (defined($syspriv)) {
5582: if ($trest =~ /^$match_community$/) {
5583: $syspriv =~ s/bre\&S//;
5584: }
5585: $$allroles{'cm./'}.=':'.$syspriv;
5586: $$allroles{$spec.'./'}.=':'.$syspriv;
5587: }
5588: if ($tdomain ne '') {
5589: if (defined($dompriv)) {
5590: $$allroles{'cm./'.$tdomain.'/'}.=':'.$dompriv;
5591: $$allroles{$spec.'./'.$tdomain.'/'}.=':'.$dompriv;
5592: }
5593: if (($trest ne '') && (defined($coursepriv))) {
5594: $$allroles{'cm.'.$area}.=':'.$coursepriv;
5595: $$allroles{$spec.'.'.$area}.=':'.$coursepriv;
5596: }
5597: }
5598: }
5599: }
5600: }
5601:
5602: sub group_roleprivs {
5603: my ($allgroups,$area,$group_privs,$tend,$tstart) = @_;
5604: my $access = 1;
5605: my $now = time;
5606: if (($tend!=0) && ($tend<$now)) { $access = 0; }
5607: if (($tstart!=0) && ($tstart>$now)) { $access=0; }
5608: if ($access) {
5609: my ($course,$group) = ($area =~ m|(/$match_domain/$match_courseid)/([^/]+)$|);
5610: $$allgroups{$course}{$group} .=':'.$group_privs;
5611: }
5612: }
5613:
5614: sub standard_roleprivs {
5615: my ($allroles,$trole,$tdomain,$spec,$trest,$area) = @_;
5616: if (defined($pr{$trole.':s'})) {
5617: $$allroles{'cm./'}.=':'.$pr{$trole.':s'};
5618: $$allroles{$spec.'./'}.=':'.$pr{$trole.':s'};
5619: }
5620: if ($tdomain ne '') {
5621: if (defined($pr{$trole.':d'})) {
5622: $$allroles{'cm./'.$tdomain.'/'}.=':'.$pr{$trole.':d'};
5623: $$allroles{$spec.'./'.$tdomain.'/'}.=':'.$pr{$trole.':d'};
5624: }
5625: if (($trest ne '') && (defined($pr{$trole.':c'}))) {
5626: $$allroles{'cm.'.$area}.=':'.$pr{$trole.':c'};
5627: $$allroles{$spec.'.'.$area}.=':'.$pr{$trole.':c'};
5628: }
5629: }
5630: }
5631:
5632: sub set_userprivs {
5633: my ($userroles,$allroles,$allgroups,$groups_roles) = @_;
5634: my $author=0;
5635: my $adv=0;
5636: my %grouproles = ();
5637: if (keys(%{$allgroups}) > 0) {
5638: my @groupkeys;
5639: foreach my $role (keys(%{$allroles})) {
5640: push(@groupkeys,$role);
5641: }
5642: if (ref($groups_roles) eq 'HASH') {
5643: foreach my $key (keys(%{$groups_roles})) {
5644: unless (grep(/^\Q$key\E$/,@groupkeys)) {
5645: push(@groupkeys,$key);
5646: }
5647: }
5648: }
5649: if (@groupkeys > 0) {
5650: foreach my $role (@groupkeys) {
5651: my ($trole,$area,$sec,$extendedarea);
5652: if ($role =~ m-^(\w+|cr/$match_domain/$match_username/\w+)\.(/$match_domain/$match_courseid)(/?\w*)\.-) {
5653: $trole = $1;
5654: $area = $2;
5655: $sec = $3;
5656: $extendedarea = $area.$sec;
5657: if (exists($$allgroups{$area})) {
5658: foreach my $group (keys(%{$$allgroups{$area}})) {
5659: my $spec = $trole.'.'.$extendedarea;
5660: $grouproles{$spec.'.'.$area.'/'.$group} =
5661: $$allgroups{$area}{$group};
5662: }
5663: }
5664: }
5665: }
5666: }
5667: }
5668: foreach my $group (keys(%grouproles)) {
5669: $$allroles{$group} = $grouproles{$group};
5670: }
5671: foreach my $role (keys(%{$allroles})) {
5672: my %thesepriv;
5673: if (($role=~/^au/) || ($role=~/^ca/) || ($role=~/^aa/)) { $author=1; }
5674: foreach my $item (split(/:/,$$allroles{$role})) {
5675: if ($item ne '') {
5676: my ($privilege,$restrictions)=split(/&/,$item);
5677: if ($restrictions eq '') {
5678: $thesepriv{$privilege}='F';
5679: } elsif ($thesepriv{$privilege} ne 'F') {
5680: $thesepriv{$privilege}.=$restrictions;
5681: }
5682: if ($thesepriv{'adv'} eq 'F') { $adv=1; }
5683: }
5684: }
5685: my $thesestr='';
5686: foreach my $priv (sort(keys(%thesepriv))) {
5687: $thesestr.=':'.$priv.'&'.$thesepriv{$priv};
5688: }
5689: $userroles->{'user.priv.'.$role} = $thesestr;
5690: }
5691: return ($author,$adv);
5692: }
5693:
5694: sub role_status {
5695: my ($rolekey,$update,$refresh,$now,$role,$where,$trolecode,$tstatus,$tstart,$tend) = @_;
5696: if (exists($env{$rolekey}) && $env{$rolekey} ne '') {
5697: my ($one,$two) = split(m{\./},$rolekey,2);
5698: (undef,undef,$$role) = split(/\./,$one,3);
5699: unless (!defined($$role) || $$role eq '') {
5700: $$where = '/'.$two;
5701: $$trolecode=$$role.'.'.$$where;
5702: ($$tstart,$$tend)=split(/\./,$env{$rolekey});
5703: $$tstatus='is';
5704: if ($$tstart && $$tstart>$update) {
5705: $$tstatus='future';
5706: if ($$tstart<$now) {
5707: if ($$tstart && $$tstart>$refresh) {
5708: if (($$where ne '') && ($$role ne '')) {
5709: my (%allroles,%allgroups,$group_privs,
5710: %groups_roles,@rolecodes);
5711: my %userroles = (
5712: 'user.role.'.$$role.'.'.$$where => $$tstart.'.'.$$tend
5713: );
5714: @rolecodes = ('cm');
5715: my $spec=$$role.'.'.$$where;
5716: my ($tdummy,$tdomain,$trest)=split(/\//,$$where);
5717: if ($$role =~ /^cr\//) {
5718: &custom_roleprivs(\%allroles,$$role,$tdomain,$trest,$spec,$$where);
5719: push(@rolecodes,'cr');
5720: } elsif ($$role eq 'gr') {
5721: push(@rolecodes,$$role);
5722: my %rolehash = &get('roles',[$$where.'_'.$$role],$env{'user.domain'},
5723: $env{'user.name'});
5724: my ($trole) = split('_',$rolehash{$$where.'_'.$$role},2);
5725: (undef,my $group_privs) = split(/\//,$trole);
5726: $group_privs = &unescape($group_privs);
5727: &group_roleprivs(\%allgroups,$$where,$group_privs,$$tend,$$tstart);
5728: my %course_roles = &get_my_roles($env{'user.name'},$env{'user.domain'},'userroles',['active'],['cc','co','in','ta','ep','ad','st','cr'],[$tdomain],1);
5729: &get_groups_roles($tdomain,$trest,
5730: \%course_roles,\@rolecodes,
5731: \%groups_roles);
5732: } else {
5733: push(@rolecodes,$$role);
5734: &standard_roleprivs(\%allroles,$$role,$tdomain,$spec,$trest,$$where);
5735: }
5736: my ($author,$adv)= &set_userprivs(\%userroles,\%allroles,\%allgroups,\%groups_roles);
5737: &appenv(\%userroles,\@rolecodes);
5738: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},"Role ".$role);
5739: }
5740: }
5741: $$tstatus = 'is';
5742: }
5743: }
5744: if ($$tend) {
5745: if ($$tend<$update) {
5746: $$tstatus='expired';
5747: } elsif ($$tend<$now) {
5748: $$tstatus='will_not';
5749: }
5750: }
5751: }
5752: }
5753: }
5754:
5755: sub get_groups_roles {
5756: my ($cdom,$rest,$cdom_courseroles,$rolecodes,$groups_roles) = @_;
5757: return unless((ref($cdom_courseroles) eq 'HASH') &&
5758: (ref($rolecodes) eq 'ARRAY') &&
5759: (ref($groups_roles) eq 'HASH'));
5760: if (keys(%{$cdom_courseroles}) > 0) {
5761: my ($cnum) = ($rest =~ /^($match_courseid)/);
5762: if ($cdom ne '' && $cnum ne '') {
5763: foreach my $key (keys(%{$cdom_courseroles})) {
5764: if ($key =~ /^\Q$cnum\E:\Q$cdom\E:([^:]+):?([^:]*)/) {
5765: my $crsrole = $1;
5766: my $crssec = $2;
5767: if ($crsrole =~ /^cr/) {
5768: unless (grep(/^cr$/,@{$rolecodes})) {
5769: push(@{$rolecodes},'cr');
5770: }
5771: } else {
5772: unless(grep(/^\Q$crsrole\E$/,@{$rolecodes})) {
5773: push(@{$rolecodes},$crsrole);
5774: }
5775: }
5776: my $rolekey = "$crsrole./$cdom/$cnum";
5777: if ($crssec ne '') {
5778: $rolekey .= "/$crssec";
5779: }
5780: $rolekey .= './';
5781: $groups_roles->{$rolekey} = $rolecodes;
5782: }
5783: }
5784: }
5785: }
5786: return;
5787: }
5788:
5789: sub delete_env_groupprivs {
5790: my ($where,$courseroles,$possroles) = @_;
5791: return unless((ref($courseroles) eq 'HASH') && (ref($possroles) eq 'ARRAY'));
5792: my ($dummy,$udom,$uname,$group) = split(/\//,$where);
5793: unless (ref($courseroles->{$udom}) eq 'HASH') {
5794: %{$courseroles->{$udom}} =
5795: &get_my_roles('','','userroles',['active'],
5796: $possroles,[$udom],1);
5797: }
5798: if (ref($courseroles->{$udom}) eq 'HASH') {
5799: foreach my $item (keys(%{$courseroles->{$udom}})) {
5800: my ($cnum,$cdom,$crsrole,$crssec) = split(/:/,$item);
5801: my $area = '/'.$cdom.'/'.$cnum;
5802: my $privkey = "user.priv.$crsrole.$area";
5803: if ($crssec ne '') {
5804: $privkey .= '/'.$crssec;
5805: }
5806: $privkey .= ".$area/$group";
5807: &Apache::lonnet::delenv($privkey,undef,[$crsrole]);
5808: }
5809: }
5810: return;
5811: }
5812:
5813: sub check_adhoc_privs {
5814: my ($cdom,$cnum,$update,$refresh,$now,$checkrole,$caller) = @_;
5815: my $cckey = 'user.role.'.$checkrole.'./'.$cdom.'/'.$cnum;
5816: my $setprivs;
5817: if ($env{$cckey}) {
5818: my ($role,$where,$trolecode,$tstart,$tend,$tremark,$tstatus,$tpstart,$tpend);
5819: &role_status($cckey,$update,$refresh,$now,\$role,\$where,\$trolecode,\$tstatus,\$tstart,\$tend);
5820: unless (($tstatus eq 'is') || ($tstatus eq 'will_not')) {
5821: &set_adhoc_privileges($cdom,$cnum,$checkrole,$caller);
5822: $setprivs = 1;
5823: }
5824: } else {
5825: &set_adhoc_privileges($cdom,$cnum,$checkrole,$caller);
5826: $setprivs = 1;
5827: }
5828: return $setprivs;
5829: }
5830:
5831: sub set_adhoc_privileges {
5832: # role can be cc or ca
5833: my ($dcdom,$pickedcourse,$role,$caller) = @_;
5834: my $area = '/'.$dcdom.'/'.$pickedcourse;
5835: my $spec = $role.'.'.$area;
5836: my %userroles = &set_arearole($role,$area,'','',$env{'user.domain'},
5837: $env{'user.name'},1);
5838: my %ccrole = ();
5839: &standard_roleprivs(\%ccrole,$role,$dcdom,$spec,$pickedcourse,$area);
5840: my ($author,$adv)= &set_userprivs(\%userroles,\%ccrole);
5841: &appenv(\%userroles,[$role,'cm']);
5842: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},"Role ".$role);
5843: unless ($caller eq 'constructaccess' && $env{'request.course.id'}) {
5844: &appenv( {'request.role' => $spec,
5845: 'request.role.domain' => $dcdom,
5846: 'request.course.sec' => ''
5847: }
5848: );
5849: my $tadv=0;
5850: if (&allowed('adv') eq 'F') { $tadv=1; }
5851: &appenv({'request.role.adv' => $tadv});
5852: }
5853: }
5854:
5855: # --------------------------------------------------------------- get interface
5856:
5857: sub get {
5858: my ($namespace,$storearr,$udomain,$uname)=@_;
5859: my $items='';
5860: foreach my $item (@$storearr) {
5861: $items.=&escape($item).'&';
5862: }
5863: $items=~s/\&$//;
5864: if (!$udomain) { $udomain=$env{'user.domain'}; }
5865: if (!$uname) { $uname=$env{'user.name'}; }
5866: my $uhome=&homeserver($uname,$udomain);
5867:
5868: my $rep=&reply("get:$udomain:$uname:$namespace:$items",$uhome);
5869: my @pairs=split(/\&/,$rep);
5870: if ( $#pairs==0 && $pairs[0] =~ /^(con_lost|error|no_such_host)/i) {
5871: return @pairs;
5872: }
5873: my %returnhash=();
5874: my $i=0;
5875: foreach my $item (@$storearr) {
5876: $returnhash{$item}=&thaw_unescape($pairs[$i]);
5877: $i++;
5878: }
5879: return %returnhash;
5880: }
5881:
5882: # --------------------------------------------------------------- del interface
5883:
5884: sub del {
5885: my ($namespace,$storearr,$udomain,$uname)=@_;
5886: my $items='';
5887: foreach my $item (@$storearr) {
5888: $items.=&escape($item).'&';
5889: }
5890:
5891: $items=~s/\&$//;
5892: if (!$udomain) { $udomain=$env{'user.domain'}; }
5893: if (!$uname) { $uname=$env{'user.name'}; }
5894: my $uhome=&homeserver($uname,$udomain);
5895: return &reply("del:$udomain:$uname:$namespace:$items",$uhome);
5896: }
5897:
5898: # -------------------------------------------------------------- dump interface
5899:
5900: sub unserialize {
5901: my ($rep, $escapedkeys) = @_;
5902:
5903: return {} if $rep =~ /^error/;
5904:
5905: my %returnhash=();
5906: foreach my $item (split(/\&/,$rep)) {
5907: my ($key, $value) = split(/=/, $item, 2);
5908: $key = unescape($key) unless $escapedkeys;
5909: next if $key =~ /^error: 2 /;
5910: $returnhash{$key} = &thaw_unescape($value);
5911: }
5912: #return %returnhash;
5913: return \%returnhash;
5914: }
5915:
5916: # see Lond::dump_with_regexp
5917: # if $escapedkeys hash keys won't get unescaped.
5918: sub dump {
5919: my ($namespace,$udomain,$uname,$regexp,$range,$escapedkeys)=@_;
5920: if (!$udomain) { $udomain=$env{'user.domain'}; }
5921: if (!$uname) { $uname=$env{'user.name'}; }
5922: my $uhome=&homeserver($uname,$udomain);
5923:
5924: if ($regexp) {
5925: $regexp=&escape($regexp);
5926: } else {
5927: $regexp='.';
5928: }
5929: if (grep { $_ eq $uhome } current_machine_ids()) {
5930: # user is hosted on this machine
5931: my $reply = LONCAPA::Lond::dump_with_regexp(join(":", ($udomain,
5932: $uname, $namespace, $regexp, $range)), $perlvar{'lonVersion'});
5933: return %{unserialize($reply, $escapedkeys)};
5934: }
5935: my $rep=&reply("dump:$udomain:$uname:$namespace:$regexp:$range",$uhome);
5936: my @pairs=split(/\&/,$rep);
5937: my %returnhash=();
5938: if (!($rep =~ /^error/ )) {
5939: foreach my $item (@pairs) {
5940: my ($key,$value)=split(/=/,$item,2);
5941: $key = unescape($key) unless $escapedkeys;
5942: #$key = &unescape($key);
5943: next if ($key =~ /^error: 2 /);
5944: $returnhash{$key}=&thaw_unescape($value);
5945: }
5946: }
5947: return %returnhash;
5948: }
5949:
5950:
5951: # --------------------------------------------------------- dumpstore interface
5952:
5953: sub dumpstore {
5954: my ($namespace,$udomain,$uname,$regexp,$range)=@_;
5955: # same as dump but keys must be escaped. They may contain colon separated
5956: # lists of values that may themself contain colons (e.g. symbs).
5957: return &dump($namespace, $udomain, $uname, $regexp, $range, 1);
5958: }
5959:
5960: # -------------------------------------------------------------- keys interface
5961:
5962: sub getkeys {
5963: my ($namespace,$udomain,$uname)=@_;
5964: if (!$udomain) { $udomain=$env{'user.domain'}; }
5965: if (!$uname) { $uname=$env{'user.name'}; }
5966: my $uhome=&homeserver($uname,$udomain);
5967: my $rep=reply("keys:$udomain:$uname:$namespace",$uhome);
5968: my @keyarray=();
5969: foreach my $key (split(/\&/,$rep)) {
5970: next if ($key =~ /^error: 2 /);
5971: push(@keyarray,&unescape($key));
5972: }
5973: return @keyarray;
5974: }
5975:
5976: # --------------------------------------------------------------- currentdump
5977: sub currentdump {
5978: my ($courseid,$sdom,$sname)=@_;
5979: $courseid = $env{'request.course.id'} if (! defined($courseid));
5980: $sdom = $env{'user.domain'} if (! defined($sdom));
5981: $sname = $env{'user.name'} if (! defined($sname));
5982: my $uhome = &homeserver($sname,$sdom);
5983: my $rep;
5984:
5985: if (grep { $_ eq $uhome } current_machine_ids()) {
5986: $rep = LONCAPA::Lond::dump_profile_database(join(":", ($sdom, $sname,
5987: $courseid)));
5988: } else {
5989: $rep = reply('currentdump:'.$sdom.':'.$sname.':'.$courseid,$uhome);
5990: }
5991:
5992: return if ($rep =~ /^(error:|no_such_host)/);
5993: #
5994: my %returnhash=();
5995: #
5996: if ($rep eq "unknown_cmd") {
5997: # an old lond will not know currentdump
5998: # Do a dump and make it look like a currentdump
5999: my @tmp = &dumpstore($courseid,$sdom,$sname,'.');
6000: return if ($tmp[0] =~ /^(error:|no_such_host)/);
6001: my %hash = @tmp;
6002: @tmp=();
6003: %returnhash = %{&convert_dump_to_currentdump(\%hash)};
6004: } else {
6005: my @pairs=split(/\&/,$rep);
6006: foreach my $pair (@pairs) {
6007: my ($key,$value)=split(/=/,$pair,2);
6008: my ($symb,$param) = split(/:/,$key);
6009: $returnhash{&unescape($symb)}->{&unescape($param)} =
6010: &thaw_unescape($value);
6011: }
6012: }
6013: return %returnhash;
6014: }
6015:
6016: sub convert_dump_to_currentdump{
6017: my %hash = %{shift()};
6018: my %returnhash;
6019: # Code ripped from lond, essentially. The only difference
6020: # here is the unescaping done by lonnet::dump(). Conceivably
6021: # we might run in to problems with parameter names =~ /^v\./
6022: while (my ($key,$value) = each(%hash)) {
6023: my ($v,$symb,$param) = split(/:/,$key);
6024: $symb = &unescape($symb);
6025: $param = &unescape($param);
6026: next if ($v eq 'version' || $symb eq 'keys');
6027: next if (exists($returnhash{$symb}) &&
6028: exists($returnhash{$symb}->{$param}) &&
6029: $returnhash{$symb}->{'v.'.$param} > $v);
6030: $returnhash{$symb}->{$param}=$value;
6031: $returnhash{$symb}->{'v.'.$param}=$v;
6032: }
6033: #
6034: # Remove all of the keys in the hashes which keep track of
6035: # the version of the parameter.
6036: while (my ($symb,$param_hash) = each(%returnhash)) {
6037: # use a foreach because we are going to delete from the hash.
6038: foreach my $key (keys(%$param_hash)) {
6039: delete($param_hash->{$key}) if ($key =~ /^v\./);
6040: }
6041: }
6042: return \%returnhash;
6043: }
6044:
6045: # ------------------------------------------------------ critical inc interface
6046:
6047: sub cinc {
6048: return &inc(@_,'critical');
6049: }
6050:
6051: # --------------------------------------------------------------- inc interface
6052:
6053: sub inc {
6054: my ($namespace,$store,$udomain,$uname,$critical) = @_;
6055: if (!$udomain) { $udomain=$env{'user.domain'}; }
6056: if (!$uname) { $uname=$env{'user.name'}; }
6057: my $uhome=&homeserver($uname,$udomain);
6058: my $items='';
6059: if (! ref($store)) {
6060: # got a single value, so use that instead
6061: $items = &escape($store).'=&';
6062: } elsif (ref($store) eq 'SCALAR') {
6063: $items = &escape($$store).'=&';
6064: } elsif (ref($store) eq 'ARRAY') {
6065: $items = join('=&',map {&escape($_);} @{$store});
6066: } elsif (ref($store) eq 'HASH') {
6067: while (my($key,$value) = each(%{$store})) {
6068: $items.= &escape($key).'='.&escape($value).'&';
6069: }
6070: }
6071: $items=~s/\&$//;
6072: if ($critical) {
6073: return &critical("inc:$udomain:$uname:$namespace:$items",$uhome);
6074: } else {
6075: return &reply("inc:$udomain:$uname:$namespace:$items",$uhome);
6076: }
6077: }
6078:
6079: # --------------------------------------------------------------- put interface
6080:
6081: sub put {
6082: my ($namespace,$storehash,$udomain,$uname)=@_;
6083: if (!$udomain) { $udomain=$env{'user.domain'}; }
6084: if (!$uname) { $uname=$env{'user.name'}; }
6085: my $uhome=&homeserver($uname,$udomain);
6086: my $items='';
6087: foreach my $item (keys(%$storehash)) {
6088: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
6089: }
6090: $items=~s/\&$//;
6091: return &reply("put:$udomain:$uname:$namespace:$items",$uhome);
6092: }
6093:
6094: # ------------------------------------------------------------ newput interface
6095:
6096: sub newput {
6097: my ($namespace,$storehash,$udomain,$uname)=@_;
6098: if (!$udomain) { $udomain=$env{'user.domain'}; }
6099: if (!$uname) { $uname=$env{'user.name'}; }
6100: my $uhome=&homeserver($uname,$udomain);
6101: my $items='';
6102: foreach my $key (keys(%$storehash)) {
6103: $items.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
6104: }
6105: $items=~s/\&$//;
6106: return &reply("newput:$udomain:$uname:$namespace:$items",$uhome);
6107: }
6108:
6109: # --------------------------------------------------------- putstore interface
6110:
6111: sub putstore {
6112: my ($namespace,$symb,$version,$storehash,$udomain,$uname,$tolog)=@_;
6113: if (!$udomain) { $udomain=$env{'user.domain'}; }
6114: if (!$uname) { $uname=$env{'user.name'}; }
6115: my $uhome=&homeserver($uname,$udomain);
6116: my $items='';
6117: foreach my $key (keys(%$storehash)) {
6118: $items.= &escape($key).'='.&freeze_escape($storehash->{$key}).'&';
6119: }
6120: $items=~s/\&$//;
6121: my $esc_symb=&escape($symb);
6122: my $esc_v=&escape($version);
6123: my $reply =
6124: &reply("putstore:$udomain:$uname:$namespace:$esc_symb:$esc_v:$items",
6125: $uhome);
6126: if (($tolog) && ($reply eq 'ok')) {
6127: my $namevalue='';
6128: foreach my $key (keys(%{$storehash})) {
6129: $namevalue.=&escape($key).'='.&freeze_escape($storehash->{$key}).'&';
6130: }
6131: $namevalue .= 'ip='.&escape($ENV{'REMOTE_ADDR'}).
6132: '&host='.&escape($perlvar{'lonHostID'}).
6133: '&version='.$esc_v.
6134: '&by='.&escape($env{'user.name'}.':'.$env{'user.domain'});
6135: &Apache::lonnet::courselog($symb.':'.$uname.':'.$udomain.':PUTSTORE:'.$namevalue);
6136: }
6137: if ($reply eq 'unknown_cmd') {
6138: # gfall back to way things use to be done
6139: return &old_putstore($namespace,$symb,$version,$storehash,$udomain,
6140: $uname);
6141: }
6142: return $reply;
6143: }
6144:
6145: sub old_putstore {
6146: my ($namespace,$symb,$version,$storehash,$udomain,$uname)=@_;
6147: if (!$udomain) { $udomain=$env{'user.domain'}; }
6148: if (!$uname) { $uname=$env{'user.name'}; }
6149: my $uhome=&homeserver($uname,$udomain);
6150: my %newstorehash;
6151: foreach my $item (keys(%$storehash)) {
6152: my $key = $version.':'.&escape($symb).':'.$item;
6153: $newstorehash{$key} = $storehash->{$item};
6154: }
6155: my $items='';
6156: my %allitems = ();
6157: foreach my $item (keys(%newstorehash)) {
6158: if ($item =~ m/^([^\:]+):([^\:]+):([^\:]+)$/) {
6159: my $key = $1.':keys:'.$2;
6160: $allitems{$key} .= $3.':';
6161: }
6162: $items.=$item.'='.&freeze_escape($newstorehash{$item}).'&';
6163: }
6164: foreach my $item (keys(%allitems)) {
6165: $allitems{$item} =~ s/\:$//;
6166: $items.= $item.'='.$allitems{$item}.'&';
6167: }
6168: $items=~s/\&$//;
6169: return &reply("put:$udomain:$uname:$namespace:$items",$uhome);
6170: }
6171:
6172: # ------------------------------------------------------ critical put interface
6173:
6174: sub cput {
6175: my ($namespace,$storehash,$udomain,$uname)=@_;
6176: if (!$udomain) { $udomain=$env{'user.domain'}; }
6177: if (!$uname) { $uname=$env{'user.name'}; }
6178: my $uhome=&homeserver($uname,$udomain);
6179: my $items='';
6180: foreach my $item (keys(%$storehash)) {
6181: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
6182: }
6183: $items=~s/\&$//;
6184: return &critical("put:$udomain:$uname:$namespace:$items",$uhome);
6185: }
6186:
6187: # -------------------------------------------------------------- eget interface
6188:
6189: sub eget {
6190: my ($namespace,$storearr,$udomain,$uname)=@_;
6191: my $items='';
6192: foreach my $item (@$storearr) {
6193: $items.=&escape($item).'&';
6194: }
6195: $items=~s/\&$//;
6196: if (!$udomain) { $udomain=$env{'user.domain'}; }
6197: if (!$uname) { $uname=$env{'user.name'}; }
6198: my $uhome=&homeserver($uname,$udomain);
6199: my $rep=&reply("eget:$udomain:$uname:$namespace:$items",$uhome);
6200: my @pairs=split(/\&/,$rep);
6201: my %returnhash=();
6202: my $i=0;
6203: foreach my $item (@$storearr) {
6204: $returnhash{$item}=&thaw_unescape($pairs[$i]);
6205: $i++;
6206: }
6207: return %returnhash;
6208: }
6209:
6210: # ------------------------------------------------------------ tmpput interface
6211: sub tmpput {
6212: my ($storehash,$server,$context)=@_;
6213: my $items='';
6214: foreach my $item (keys(%$storehash)) {
6215: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
6216: }
6217: $items=~s/\&$//;
6218: if (defined($context)) {
6219: $items .= ':'.&escape($context);
6220: }
6221: return &reply("tmpput:$items",$server);
6222: }
6223:
6224: # ------------------------------------------------------------ tmpget interface
6225: sub tmpget {
6226: my ($token,$server)=@_;
6227: if (!defined($server)) { $server = $perlvar{'lonHostID'}; }
6228: my $rep=&reply("tmpget:$token",$server);
6229: my %returnhash;
6230: foreach my $item (split(/\&/,$rep)) {
6231: my ($key,$value)=split(/=/,$item);
6232: next if ($key =~ /^error: 2 /);
6233: $returnhash{&unescape($key)}=&thaw_unescape($value);
6234: }
6235: return %returnhash;
6236: }
6237:
6238: # ------------------------------------------------------------ tmpdel interface
6239: sub tmpdel {
6240: my ($token,$server)=@_;
6241: if (!defined($server)) { $server = $perlvar{'lonHostID'}; }
6242: return &reply("tmpdel:$token",$server);
6243: }
6244:
6245: # ------------------------------------------------------------ get_timebased_id
6246:
6247: sub get_timebased_id {
6248: my ($prefix,$keyid,$namespace,$cdom,$cnum,$idtype,$who,$locktries,
6249: $maxtries) = @_;
6250: my ($newid,$error,$dellock);
6251: unless (($prefix =~ /^\w+$/) && ($keyid =~ /^\w+$/) && ($namespace ne '')) {
6252: return ('','ok','invalid call to get suffix');
6253: }
6254:
6255: # set defaults for any optional args for which values were not supplied
6256: if ($who eq '') {
6257: $who = $env{'user.name'}.':'.$env{'user.domain'};
6258: }
6259: if (!$locktries) {
6260: $locktries = 3;
6261: }
6262: if (!$maxtries) {
6263: $maxtries = 10;
6264: }
6265:
6266: if (($cdom eq '') || ($cnum eq '')) {
6267: if ($env{'request.course.id'}) {
6268: $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
6269: $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
6270: }
6271: if (($cdom eq '') || ($cnum eq '')) {
6272: return ('','ok','call to get suffix not in course context');
6273: }
6274: }
6275:
6276: # construct locking item
6277: my $lockhash = {
6278: $prefix."\0".'locked_'.$keyid => $who,
6279: };
6280: my $tries = 0;
6281:
6282: # attempt to get lock on nohist_$namespace file
6283: my $gotlock = &Apache::lonnet::newput('nohist_'.$namespace,$lockhash,$cdom,$cnum);
6284: while (($gotlock ne 'ok') && $tries <$locktries) {
6285: $tries ++;
6286: sleep 1;
6287: $gotlock = &Apache::lonnet::newput('nohist_'.$namespace,$lockhash,$cdom,$cnum);
6288: }
6289:
6290: # attempt to get unique identifier, based on current timestamp
6291: if ($gotlock eq 'ok') {
6292: my %inuse = &Apache::lonnet::dump('nohist_'.$namespace,$cdom,$cnum,$prefix);
6293: my $id = time;
6294: $newid = $id;
6295: if ($idtype eq 'addcode') {
6296: $newid .= &sixnum_code();
6297: }
6298: my $idtries = 0;
6299: while (exists($inuse{$prefix."\0".$newid}) && $idtries < $maxtries) {
6300: if ($idtype eq 'concat') {
6301: $newid = $id.$idtries;
6302: } elsif ($idtype eq 'addcode') {
6303: $newid = $newid.&sixnum_code();
6304: } else {
6305: $newid ++;
6306: }
6307: $idtries ++;
6308: }
6309: if (!exists($inuse{$prefix."\0".$newid})) {
6310: my %new_item = (
6311: $prefix."\0".$newid => $who,
6312: );
6313: my $putresult = &Apache::lonnet::put('nohist_'.$namespace,\%new_item,
6314: $cdom,$cnum);
6315: if ($putresult ne 'ok') {
6316: undef($newid);
6317: $error = 'error saving new item: '.$putresult;
6318: }
6319: } else {
6320: undef($newid);
6321: $error = ('error: no unique suffix available for the new item ');
6322: }
6323: # remove lock
6324: my @del_lock = ($prefix."\0".'locked_'.$keyid);
6325: $dellock = &Apache::lonnet::del('nohist_'.$namespace,\@del_lock,$cdom,$cnum);
6326: } else {
6327: $error = "error: could not obtain lockfile\n";
6328: $dellock = 'ok';
6329: if (($prefix eq 'paste') && ($namespace eq 'courseeditor') && ($keyid eq 'num')) {
6330: $dellock = 'nolock';
6331: }
6332: }
6333: return ($newid,$dellock,$error);
6334: }
6335:
6336: sub sixnum_code {
6337: my $code;
6338: for (0..6) {
6339: $code .= int( rand(9) );
6340: }
6341: return $code;
6342: }
6343:
6344: # -------------------------------------------------- portfolio access checking
6345:
6346: sub portfolio_access {
6347: my ($requrl,$clientip) = @_;
6348: my (undef,$udom,$unum,$file_name,$group) = &parse_portfolio_url($requrl);
6349: my $result = &get_portfolio_access($udom,$unum,$file_name,$group,$clientip);
6350: if ($result) {
6351: my %setters;
6352: if ($env{'user.name'} eq 'public' && $env{'user.domain'} eq 'public') {
6353: my ($startblock,$endblock) =
6354: &Apache::loncommon::blockcheck(\%setters,'port',$unum,$udom);
6355: if ($startblock && $endblock) {
6356: return 'B';
6357: }
6358: } else {
6359: my ($startblock,$endblock) =
6360: &Apache::loncommon::blockcheck(\%setters,'port');
6361: if ($startblock && $endblock) {
6362: return 'B';
6363: }
6364: }
6365: }
6366: if ($result eq 'ok') {
6367: return 'F';
6368: } elsif ($result =~ /^[^:]+:guest_/) {
6369: return 'A';
6370: }
6371: return '';
6372: }
6373:
6374: sub get_portfolio_access {
6375: my ($udom,$unum,$file_name,$group,$clientip,$access_hash) = @_;
6376:
6377: if (!ref($access_hash)) {
6378: my $current_perms = &get_portfile_permissions($udom,$unum);
6379: my %access_controls = &get_access_controls($current_perms,$group,
6380: $file_name);
6381: $access_hash = $access_controls{$file_name};
6382: }
6383:
6384: my ($public,$guest,@domains,@users,@courses,@groups,@ips);
6385: my $now = time;
6386: if (ref($access_hash) eq 'HASH') {
6387: foreach my $key (keys(%{$access_hash})) {
6388: my ($num,$scope,$end,$start) = ($key =~ /^([^:]+):([a-z]+)_(\d*)_?(\d*)$/);
6389: if ($start > $now) {
6390: next;
6391: }
6392: if ($end && $end<$now) {
6393: next;
6394: }
6395: if ($scope eq 'public') {
6396: $public = $key;
6397: last;
6398: } elsif ($scope eq 'guest') {
6399: $guest = $key;
6400: } elsif ($scope eq 'domains') {
6401: push(@domains,$key);
6402: } elsif ($scope eq 'users') {
6403: push(@users,$key);
6404: } elsif ($scope eq 'course') {
6405: push(@courses,$key);
6406: } elsif ($scope eq 'group') {
6407: push(@groups,$key);
6408: } elsif ($scope eq 'ip') {
6409: push(@ips,$key);
6410: }
6411: }
6412: if ($public) {
6413: return 'ok';
6414: } elsif (@ips > 0) {
6415: my $allowed;
6416: foreach my $ipkey (@ips) {
6417: if (ref($access_hash->{$ipkey}{'ip'}) eq 'ARRAY') {
6418: if (&Apache::loncommon::check_ip_acc(join(',',@{$access_hash->{$ipkey}{'ip'}}),$clientip)) {
6419: $allowed = 1;
6420: last;
6421: }
6422: }
6423: }
6424: if ($allowed) {
6425: return 'ok';
6426: }
6427: }
6428: if ($env{'user.name'} eq 'public' && $env{'user.domain'} eq 'public') {
6429: if ($guest) {
6430: return $guest;
6431: }
6432: } else {
6433: if (@domains > 0) {
6434: foreach my $domkey (@domains) {
6435: if (ref($access_hash->{$domkey}{'dom'}) eq 'ARRAY') {
6436: if (grep(/^\Q$env{'user.domain'}\E$/,@{$access_hash->{$domkey}{'dom'}})) {
6437: return 'ok';
6438: }
6439: }
6440: }
6441: }
6442: if (@users > 0) {
6443: foreach my $userkey (@users) {
6444: if (ref($access_hash->{$userkey}{'users'}) eq 'ARRAY') {
6445: foreach my $item (@{$access_hash->{$userkey}{'users'}}) {
6446: if (ref($item) eq 'HASH') {
6447: if (($item->{'uname'} eq $env{'user.name'}) &&
6448: ($item->{'udom'} eq $env{'user.domain'})) {
6449: return 'ok';
6450: }
6451: }
6452: }
6453: }
6454: }
6455: }
6456: my %roleshash;
6457: my @courses_and_groups = @courses;
6458: push(@courses_and_groups,@groups);
6459: if (@courses_and_groups > 0) {
6460: my (%allgroups,%allroles);
6461: my ($start,$end,$role,$sec,$group);
6462: foreach my $envkey (%env) {
6463: if ($envkey =~ m-^user\.role\.(gr|cc|co|in|ta|ep|ad|st)\./($match_domain)/($match_courseid)/?([^/]*)$-) {
6464: my $cid = $2.'_'.$3;
6465: if ($1 eq 'gr') {
6466: $group = $4;
6467: $allgroups{$cid}{$group} = $env{$envkey};
6468: } else {
6469: if ($4 eq '') {
6470: $sec = 'none';
6471: } else {
6472: $sec = $4;
6473: }
6474: $allroles{$cid}{$1}{$sec} = $env{$envkey};
6475: }
6476: } elsif ($envkey =~ m-^user\.role\./cr/($match_domain/$match_username/\w*)./($match_domain)/($match_courseid)/?([^/]*)$-) {
6477: my $cid = $2.'_'.$3;
6478: if ($4 eq '') {
6479: $sec = 'none';
6480: } else {
6481: $sec = $4;
6482: }
6483: $allroles{$cid}{$1}{$sec} = $env{$envkey};
6484: }
6485: }
6486: if (keys(%allroles) == 0) {
6487: return;
6488: }
6489: foreach my $key (@courses_and_groups) {
6490: my %content = %{$$access_hash{$key}};
6491: my $cnum = $content{'number'};
6492: my $cdom = $content{'domain'};
6493: my $cid = $cdom.'_'.$cnum;
6494: if (!exists($allroles{$cid})) {
6495: next;
6496: }
6497: foreach my $role_id (keys(%{$content{'roles'}})) {
6498: my @sections = @{$content{'roles'}{$role_id}{'section'}};
6499: my @groups = @{$content{'roles'}{$role_id}{'group'}};
6500: my @status = @{$content{'roles'}{$role_id}{'access'}};
6501: my @roles = @{$content{'roles'}{$role_id}{'role'}};
6502: foreach my $role (keys(%{$allroles{$cid}})) {
6503: if ((grep/^all$/,@roles) || (grep/^\Q$role\E$/,@roles)) {
6504: foreach my $sec (keys(%{$allroles{$cid}{$role}})) {
6505: if (&course_group_datechecker($allroles{$cid}{$role}{$sec},$now,\@status) eq 'ok') {
6506: if (grep/^all$/,@sections) {
6507: return 'ok';
6508: } else {
6509: if (grep/^$sec$/,@sections) {
6510: return 'ok';
6511: }
6512: }
6513: }
6514: }
6515: if (keys(%{$allgroups{$cid}}) == 0) {
6516: if (grep/^none$/,@groups) {
6517: return 'ok';
6518: }
6519: } else {
6520: if (grep/^all$/,@groups) {
6521: return 'ok';
6522: }
6523: foreach my $group (keys(%{$allgroups{$cid}})) {
6524: if (grep/^$group$/,@groups) {
6525: return 'ok';
6526: }
6527: }
6528: }
6529: }
6530: }
6531: }
6532: }
6533: }
6534: if ($guest) {
6535: return $guest;
6536: }
6537: }
6538: }
6539: return;
6540: }
6541:
6542: sub course_group_datechecker {
6543: my ($dates,$now,$status) = @_;
6544: my ($start,$end) = split(/\./,$dates);
6545: if (!$start && !$end) {
6546: return 'ok';
6547: }
6548: if (grep/^active$/,@{$status}) {
6549: if (((!$start) || ($start && $start <= $now)) && ((!$end) || ($end && $end >= $now))) {
6550: return 'ok';
6551: }
6552: }
6553: if (grep/^previous$/,@{$status}) {
6554: if ($end > $now ) {
6555: return 'ok';
6556: }
6557: }
6558: if (grep/^future$/,@{$status}) {
6559: if ($start > $now) {
6560: return 'ok';
6561: }
6562: }
6563: return;
6564: }
6565:
6566: sub parse_portfolio_url {
6567: my ($url) = @_;
6568:
6569: my ($type,$udom,$unum,$group,$file_name);
6570:
6571: if ($url =~ m-^/*(?:uploaded|editupload)/($match_domain)/($match_username)/portfolio(/.+)$-) {
6572: $type = 1;
6573: $udom = $1;
6574: $unum = $2;
6575: $file_name = $3;
6576: } elsif ($url =~ m-^/*(?:uploaded|editupload)/($match_domain)/($match_courseid)/groups/([^/]+)/portfolio/(.+)$-) {
6577: $type = 2;
6578: $udom = $1;
6579: $unum = $2;
6580: $group = $3;
6581: $file_name = $3.'/'.$4;
6582: }
6583: if (wantarray) {
6584: return ($type,$udom,$unum,$file_name,$group);
6585: }
6586: return $type;
6587: }
6588:
6589: sub is_portfolio_url {
6590: my ($url) = @_;
6591: return scalar(&parse_portfolio_url($url));
6592: }
6593:
6594: sub is_portfolio_file {
6595: my ($file) = @_;
6596: if (($file =~ /^portfolio/) || ($file =~ /^groups\/\w+\/portfolio/)) {
6597: return 1;
6598: }
6599: return;
6600: }
6601:
6602: sub usertools_access {
6603: my ($uname,$udom,$tool,$action,$context,$userenvref,$domdefref,$is_advref)=@_;
6604: my ($access,%tools);
6605: if ($context eq '') {
6606: $context = 'tools';
6607: }
6608: if ($context eq 'requestcourses') {
6609: %tools = (
6610: official => 1,
6611: unofficial => 1,
6612: community => 1,
6613: textbook => 1,
6614: placement => 1,
6615: );
6616: } elsif ($context eq 'requestauthor') {
6617: %tools = (
6618: requestauthor => 1,
6619: );
6620: } else {
6621: %tools = (
6622: aboutme => 1,
6623: blog => 1,
6624: webdav => 1,
6625: portfolio => 1,
6626: );
6627: }
6628: return if (!defined($tools{$tool}));
6629:
6630: if (($udom eq '') || ($uname eq '')) {
6631: $udom = $env{'user.domain'};
6632: $uname = $env{'user.name'};
6633: }
6634:
6635: if (($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'})) {
6636: if ($action ne 'reload') {
6637: if ($context eq 'requestcourses') {
6638: return $env{'environment.canrequest.'.$tool};
6639: } elsif ($context eq 'requestauthor') {
6640: return $env{'environment.canrequest.author'};
6641: } else {
6642: return $env{'environment.availabletools.'.$tool};
6643: }
6644: }
6645: }
6646:
6647: my ($toolstatus,$inststatus,$envkey);
6648: if ($context eq 'requestauthor') {
6649: $envkey = $context;
6650: } else {
6651: $envkey = $context.'.'.$tool;
6652: }
6653:
6654: if (($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'}) &&
6655: ($action ne 'reload')) {
6656: $toolstatus = $env{'environment.'.$envkey};
6657: $inststatus = $env{'environment.inststatus'};
6658: } else {
6659: if (ref($userenvref) eq 'HASH') {
6660: $toolstatus = $userenvref->{$envkey};
6661: $inststatus = $userenvref->{'inststatus'};
6662: } else {
6663: my %userenv = &userenvironment($udom,$uname,$envkey,'inststatus');
6664: $toolstatus = $userenv{$envkey};
6665: $inststatus = $userenv{'inststatus'};
6666: }
6667: }
6668:
6669: if ($toolstatus ne '') {
6670: if ($toolstatus) {
6671: $access = 1;
6672: } else {
6673: $access = 0;
6674: }
6675: return $access;
6676: }
6677:
6678: my ($is_adv,%domdef);
6679: if (ref($is_advref) eq 'HASH') {
6680: $is_adv = $is_advref->{'is_adv'};
6681: } else {
6682: $is_adv = &is_advanced_user($udom,$uname);
6683: }
6684: if (ref($domdefref) eq 'HASH') {
6685: %domdef = %{$domdefref};
6686: } else {
6687: %domdef = &get_domain_defaults($udom);
6688: }
6689: if (ref($domdef{$tool}) eq 'HASH') {
6690: if ($is_adv) {
6691: if ($domdef{$tool}{'_LC_adv'} ne '') {
6692: if ($domdef{$tool}{'_LC_adv'}) {
6693: $access = 1;
6694: } else {
6695: $access = 0;
6696: }
6697: return $access;
6698: }
6699: }
6700: if ($inststatus ne '') {
6701: my ($hasaccess,$hasnoaccess);
6702: foreach my $affiliation (split(/:/,$inststatus)) {
6703: if ($domdef{$tool}{$affiliation} ne '') {
6704: if ($domdef{$tool}{$affiliation}) {
6705: $hasaccess = 1;
6706: } else {
6707: $hasnoaccess = 1;
6708: }
6709: }
6710: }
6711: if ($hasaccess || $hasnoaccess) {
6712: if ($hasaccess) {
6713: $access = 1;
6714: } elsif ($hasnoaccess) {
6715: $access = 0;
6716: }
6717: return $access;
6718: }
6719: } else {
6720: if ($domdef{$tool}{'default'} ne '') {
6721: if ($domdef{$tool}{'default'}) {
6722: $access = 1;
6723: } elsif ($domdef{$tool}{'default'} == 0) {
6724: $access = 0;
6725: }
6726: return $access;
6727: }
6728: }
6729: } else {
6730: if (($context eq 'tools') && ($tool ne 'webdav')) {
6731: $access = 1;
6732: } else {
6733: $access = 0;
6734: }
6735: return $access;
6736: }
6737: }
6738:
6739: sub is_course_owner {
6740: my ($cdom,$cnum,$udom,$uname) = @_;
6741: if (($udom eq '') || ($uname eq '')) {
6742: $udom = $env{'user.domain'};
6743: $uname = $env{'user.name'};
6744: }
6745: unless (($udom eq '') || ($uname eq '')) {
6746: if (exists($env{'course.'.$cdom.'_'.$cnum.'.internal.courseowner'})) {
6747: if ($env{'course.'.$cdom.'_'.$cnum.'.internal.courseowner'} eq $uname.':'.$udom) {
6748: return 1;
6749: } else {
6750: my %courseinfo = &Apache::lonnet::coursedescription($cdom.'/'.$cnum);
6751: if ($courseinfo{'internal.courseowner'} eq $uname.':'.$udom) {
6752: return 1;
6753: }
6754: }
6755: }
6756: }
6757: return;
6758: }
6759:
6760: sub is_advanced_user {
6761: my ($udom,$uname) = @_;
6762: if ($udom ne '' && $uname ne '') {
6763: if (($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'})) {
6764: if (wantarray) {
6765: return ($env{'user.adv'},$env{'user.author'});
6766: } else {
6767: return $env{'user.adv'};
6768: }
6769: }
6770: }
6771: my %roleshash = &get_my_roles($uname,$udom,'userroles',undef,undef,undef,1);
6772: my %allroles;
6773: my ($is_adv,$is_author);
6774: foreach my $role (keys(%roleshash)) {
6775: my ($trest,$tdomain,$trole,$sec) = split(/:/,$role);
6776: my $area = '/'.$tdomain.'/'.$trest;
6777: if ($sec ne '') {
6778: $area .= '/'.$sec;
6779: }
6780: if (($area ne '') && ($trole ne '')) {
6781: my $spec=$trole.'.'.$area;
6782: if ($trole =~ /^cr\//) {
6783: &custom_roleprivs(\%allroles,$trole,$tdomain,$trest,$spec,$area);
6784: } elsif ($trole ne 'gr') {
6785: &standard_roleprivs(\%allroles,$trole,$tdomain,$spec,$trest,$area);
6786: }
6787: if ($trole eq 'au') {
6788: $is_author = 1;
6789: }
6790: }
6791: }
6792: foreach my $role (keys(%allroles)) {
6793: last if ($is_adv);
6794: foreach my $item (split(/:/,$allroles{$role})) {
6795: if ($item ne '') {
6796: my ($privilege,$restrictions)=split(/&/,$item);
6797: if ($privilege eq 'adv') {
6798: $is_adv = 1;
6799: last;
6800: }
6801: }
6802: }
6803: }
6804: if (wantarray) {
6805: return ($is_adv,$is_author);
6806: }
6807: return $is_adv;
6808: }
6809:
6810: sub check_can_request {
6811: my ($dom,$can_request,$request_domains) = @_;
6812: my $canreq = 0;
6813: my ($types,$typename) = &Apache::loncommon::course_types();
6814: my @options = ('approval','validate','autolimit');
6815: my $optregex = join('|',@options);
6816: if ((ref($can_request) eq 'HASH') && (ref($types) eq 'ARRAY')) {
6817: foreach my $type (@{$types}) {
6818: if (&usertools_access($env{'user.name'},
6819: $env{'user.domain'},
6820: $type,undef,'requestcourses')) {
6821: $canreq ++;
6822: if (ref($request_domains) eq 'HASH') {
6823: push(@{$request_domains->{$type}},$env{'user.domain'});
6824: }
6825: if ($dom eq $env{'user.domain'}) {
6826: $can_request->{$type} = 1;
6827: }
6828: }
6829: if ($env{'environment.reqcrsotherdom.'.$type} ne '') {
6830: my @curr = split(',',$env{'environment.reqcrsotherdom.'.$type});
6831: if (@curr > 0) {
6832: foreach my $item (@curr) {
6833: if (ref($request_domains) eq 'HASH') {
6834: my ($otherdom) = ($item =~ /^($match_domain):($optregex)(=?\d*)$/);
6835: if ($otherdom ne '') {
6836: if (ref($request_domains->{$type}) eq 'ARRAY') {
6837: unless (grep(/^\Q$otherdom\E$/,@{$request_domains->{$type}})) {
6838: push(@{$request_domains->{$type}},$otherdom);
6839: }
6840: } else {
6841: push(@{$request_domains->{$type}},$otherdom);
6842: }
6843: }
6844: }
6845: }
6846: unless($dom eq $env{'user.domain'}) {
6847: $canreq ++;
6848: if (grep(/^\Q$dom\E:($optregex)(=?\d*)$/,@curr)) {
6849: $can_request->{$type} = 1;
6850: }
6851: }
6852: }
6853: }
6854: }
6855: }
6856: return $canreq;
6857: }
6858:
6859: # ---------------------------------------------- Custom access rule evaluation
6860:
6861: sub customaccess {
6862: my ($priv,$uri)=@_;
6863: my ($urole,$urealm)=split(/\./,$env{'request.role'},2);
6864: my (undef,$udom,$ucrs,$usec)=split(/\//,$urealm);
6865: $udom = &LONCAPA::clean_domain($udom);
6866: $ucrs = &LONCAPA::clean_username($ucrs);
6867: my $access=0;
6868: foreach my $right (split(/\s*\,\s*/,&metadata($uri,'rule_rights'))) {
6869: my ($effect,$realm,$role,$type)=split(/\:/,$right);
6870: if ($type eq 'user') {
6871: foreach my $scope (split(/\s*\,\s*/,$realm)) {
6872: my ($tdom,$tuname)=split(m{/},$scope);
6873: if ($tdom) {
6874: if ($tdom ne $env{'user.domain'}) { next; }
6875: }
6876: if ($tuname) {
6877: if ($tuname ne $env{'user.name'}) { next; }
6878: }
6879: $access=($effect eq 'allow');
6880: last;
6881: }
6882: } else {
6883: if ($role) {
6884: if ($role ne $urole) { next; }
6885: }
6886: foreach my $scope (split(/\s*\,\s*/,$realm)) {
6887: my ($tdom,$tcrs,$tsec)=split(/\_/,$scope);
6888: if ($tdom) {
6889: if ($tdom ne $udom) { next; }
6890: }
6891: if ($tcrs) {
6892: if ($tcrs ne $ucrs) { next; }
6893: }
6894: if ($tsec) {
6895: if ($tsec ne $usec) { next; }
6896: }
6897: $access=($effect eq 'allow');
6898: last;
6899: }
6900: if ($realm eq '' && $role eq '') {
6901: $access=($effect eq 'allow');
6902: }
6903: }
6904: }
6905: return $access;
6906: }
6907:
6908: # ------------------------------------------------- Check for a user privilege
6909:
6910: sub allowed {
6911: my ($priv,$uri,$symb,$role,$clientip,$noblockcheck)=@_;
6912: my $ver_orguri=$uri;
6913: $uri=&deversion($uri);
6914: my $orguri=$uri;
6915: $uri=&declutter($uri);
6916:
6917: if ($priv eq 'evb') {
6918: # Evade communication block restrictions for specified role in a course
6919: if ($env{'user.priv.'.$role} =~/evb\&([^\:]*)/) {
6920: return $1;
6921: } else {
6922: return;
6923: }
6924: }
6925:
6926: if (defined($env{'allowed.'.$priv})) { return $env{'allowed.'.$priv}; }
6927: # Free bre access to adm and meta resources
6928: if (((($uri=~/^adm\//) && ($uri !~ m{/(?:smppg|bulletinboard)$}))
6929: || (($uri=~/\.meta$/) && ($uri!~m|^uploaded/|) ))
6930: && ($priv eq 'bre')) {
6931: return 'F';
6932: }
6933:
6934: # Free bre access to user's own portfolio contents
6935: my ($space,$domain,$name,@dir)=split('/',$uri);
6936: if (($space=~/^(uploaded|editupload)$/) && ($env{'user.name'} eq $name) &&
6937: ($env{'user.domain'} eq $domain) && ('portfolio' eq $dir[0])) {
6938: my %setters;
6939: my ($startblock,$endblock) =
6940: &Apache::loncommon::blockcheck(\%setters,'port');
6941: if ($startblock && $endblock) {
6942: return 'B';
6943: } else {
6944: return 'F';
6945: }
6946: }
6947:
6948: # bre access to group portfolio for rgf priv in group, or mdg or vcg in course.
6949: if (($space=~/^(uploaded|editupload)$/) && ($dir[0] eq 'groups')
6950: && ($dir[2] eq 'portfolio') && ($priv eq 'bre')) {
6951: if (exists($env{'request.course.id'})) {
6952: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
6953: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
6954: if (($domain eq $cdom) && ($name eq $cnum)) {
6955: my $courseprivid=$env{'request.course.id'};
6956: $courseprivid=~s/\_/\//;
6957: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid
6958: .'/'.$dir[1]} =~/rgf\&([^\:]*)/) {
6959: return $1;
6960: } else {
6961: if ($env{'request.course.sec'}) {
6962: $courseprivid.='/'.$env{'request.course.sec'};
6963: }
6964: if ($env{'user.priv.'.$env{'request.role'}.'./'.
6965: $courseprivid} =~/(mdg|vcg)\&([^\:]*)/) {
6966: return $2;
6967: }
6968: }
6969: }
6970: }
6971: }
6972:
6973: # Free bre to public access
6974:
6975: if ($priv eq 'bre') {
6976: my $copyright=&metadata($uri,'copyright');
6977: if (($copyright eq 'public') && (!$env{'request.course.id'})) {
6978: return 'F';
6979: }
6980: if ($copyright eq 'priv') {
6981: $uri=~/([^\/]+)\/([^\/]+)\//;
6982: unless (($env{'user.name'} eq $2) && ($env{'user.domain'} eq $1)) {
6983: return '';
6984: }
6985: }
6986: if ($copyright eq 'domain') {
6987: $uri=~/([^\/]+)\/([^\/]+)\//;
6988: unless (($env{'user.domain'} eq $1) ||
6989: ($env{'course.'.$env{'request.course.id'}.'.domain'} eq $1)) {
6990: return '';
6991: }
6992: }
6993: if ($env{'request.role'}=~ /li\.\//) {
6994: # Library role, so allow browsing of resources in this domain.
6995: return 'F';
6996: }
6997: if ($copyright eq 'custom') {
6998: unless (&customaccess($priv,$uri)) { return ''; }
6999: }
7000: }
7001: # Domain coordinator is trying to create a course
7002: if (($priv eq 'ccc') && ($env{'request.role'} =~ /^dc\./)) {
7003: # uri is the requested domain in this case.
7004: # comparison to 'request.role.domain' shows if the user has selected
7005: # a role of dc for the domain in question.
7006: return 'F' if ($uri eq $env{'request.role.domain'});
7007: }
7008:
7009: my $thisallowed='';
7010: my $statecond=0;
7011: my $courseprivid='';
7012:
7013: my $ownaccess;
7014: # Community Coordinator or Assistant Co-author browsing resource space.
7015: if (($priv eq 'bro') && ($env{'user.author'})) {
7016: if ($uri eq '') {
7017: $ownaccess = 1;
7018: } else {
7019: if (($env{'user.domain'} ne '') && ($env{'user.name'} ne '')) {
7020: my $udom = $env{'user.domain'};
7021: my $uname = $env{'user.name'};
7022: if ($uri =~ m{^\Q$udom\E/?$}) {
7023: $ownaccess = 1;
7024: } elsif ($uri =~ m{^\Q$udom\E/\Q$uname\E/?}) {
7025: unless ($uri =~ m{\.\./}) {
7026: $ownaccess = 1;
7027: }
7028: } elsif (($udom ne 'public') && ($uname ne 'public')) {
7029: my $now = time;
7030: if ($uri =~ m{^([^/]+)/?$}) {
7031: my $adom = $1;
7032: foreach my $key (keys(%env)) {
7033: if ($key =~ m{^user\.role\.(ca|aa)/\Q$adom\E}) {
7034: my ($start,$end) = split('.',$env{$key});
7035: if (($now >= $start) && (!$end || $end < $now)) {
7036: $ownaccess = 1;
7037: last;
7038: }
7039: }
7040: }
7041: } elsif ($uri =~ m{^([^/]+)/([^/]+)/?}) {
7042: my $adom = $1;
7043: my $aname = $2;
7044: foreach my $role ('ca','aa') {
7045: if ($env{"user.role.$role./$adom/$aname"}) {
7046: my ($start,$end) =
7047: split('.',$env{"user.role.$role./$adom/$aname"});
7048: if (($now >= $start) && (!$end || $end < $now)) {
7049: $ownaccess = 1;
7050: last;
7051: }
7052: }
7053: }
7054: }
7055: }
7056: }
7057: }
7058: }
7059:
7060: # Course
7061:
7062: if ($env{'user.priv.'.$env{'request.role'}.'./'}=~/\Q$priv\E\&([^\:]*)/) {
7063: unless (($priv eq 'bro') && (!$ownaccess)) {
7064: $thisallowed.=$1;
7065: }
7066: }
7067:
7068: # Domain
7069:
7070: if ($env{'user.priv.'.$env{'request.role'}.'./'.(split(/\//,$uri))[0].'/'}
7071: =~/\Q$priv\E\&([^\:]*)/) {
7072: unless (($priv eq 'bro') && (!$ownaccess)) {
7073: $thisallowed.=$1;
7074: }
7075: }
7076:
7077: # User who is not author or co-author might still be able to edit
7078: # resource of an author in the domain (e.g., if Domain Coordinator).
7079: if (($priv eq 'eco') && ($thisallowed eq '') && ($env{'request.course.id'}) &&
7080: (&allowed('mdc',$env{'request.course.id'}))) {
7081: if ($env{"user.priv.cm./$uri/"}=~/\Q$priv\E\&([^\:]*)/) {
7082: $thisallowed.=$1;
7083: }
7084: }
7085:
7086: # Course: uri itself is a course
7087: my $courseuri=$uri;
7088: $courseuri=~s/\_(\d)/\/$1/;
7089: $courseuri=~s/^([^\/])/\/$1/;
7090:
7091: if ($env{'user.priv.'.$env{'request.role'}.'.'.$courseuri}
7092: =~/\Q$priv\E\&([^\:]*)/) {
7093: unless (($priv eq 'bro') && (!$ownaccess)) {
7094: $thisallowed.=$1;
7095: }
7096: }
7097:
7098: # URI is an uploaded document for this course, default permissions don't matter
7099: # not allowing 'edit' access (editupload) to uploaded course docs
7100: if (($priv eq 'bre') && ($uri=~m|^uploaded/|)) {
7101: $thisallowed='';
7102: my ($match)=&is_on_map($uri);
7103: if ($match) {
7104: if ($env{'user.priv.'.$env{'request.role'}.'./'}
7105: =~/\Q$priv\E\&([^\:]*)/) {
7106: my $value = $1;
7107: if ($noblockcheck) {
7108: $thisallowed.=$value;
7109: } else {
7110: my @blockers = &has_comm_blocking($priv,$symb,$uri);
7111: if (@blockers > 0) {
7112: $thisallowed = 'B';
7113: } else {
7114: $thisallowed.=$value;
7115: }
7116: }
7117: }
7118: } else {
7119: my $refuri = $env{'httpref.'.$orguri} || $env{'httpref.'.$ver_orguri};
7120: if ($refuri) {
7121: if ($refuri =~ m|^/adm/|) {
7122: $thisallowed='F';
7123: } else {
7124: $refuri=&declutter($refuri);
7125: my ($match) = &is_on_map($refuri);
7126: if ($match) {
7127: if ($noblockcheck) {
7128: $thisallowed='F';
7129: } else {
7130: my @blockers = &has_comm_blocking($priv,$symb,$refuri);
7131: if (@blockers > 0) {
7132: $thisallowed = 'B';
7133: } else {
7134: $thisallowed='F';
7135: }
7136: }
7137: }
7138: }
7139: }
7140: }
7141: }
7142:
7143: if ($priv eq 'bre'
7144: && $thisallowed ne 'F'
7145: && $thisallowed ne '2'
7146: && &is_portfolio_url($uri)) {
7147: $thisallowed = &portfolio_access($uri,$clientip);
7148: }
7149:
7150: # Full access at system, domain or course-wide level? Exit.
7151: if ($thisallowed=~/F/) {
7152: return 'F';
7153: }
7154:
7155: # If this is generating or modifying users, exit with special codes
7156:
7157: if (':csu:cdc:ccc:cin:cta:cep:ccr:cst:cad:cli:cau:cdg:cca:caa:'=~/\:\Q$priv\E\:/) {
7158: if (($priv eq 'cca') || ($priv eq 'caa')) {
7159: my ($audom,$auname)=split('/',$uri);
7160: # no author name given, so this just checks on the general right to make a co-author in this domain
7161: unless ($auname) { return $thisallowed; }
7162: # an author name is given, so we are about to actually make a co-author for a certain account
7163: if (($auname ne $env{'user.name'} && $env{'request.role'} !~ /^dc\./) ||
7164: (($audom ne $env{'user.domain'} && $env{'request.role'} !~ /^dc\./) &&
7165: ($audom ne $env{'request.role.domain'}))) { return ''; }
7166: }
7167: return $thisallowed;
7168: }
7169: #
7170: # Gathered so far: system, domain and course wide privileges
7171: #
7172: # Course: See if uri or referer is an individual resource that is part of
7173: # the course
7174:
7175: if ($env{'request.course.id'}) {
7176:
7177: $courseprivid=$env{'request.course.id'};
7178: if ($env{'request.course.sec'}) {
7179: $courseprivid.='/'.$env{'request.course.sec'};
7180: }
7181: $courseprivid=~s/\_/\//;
7182: my $checkreferer=1;
7183: my ($match,$cond)=&is_on_map($uri);
7184: if ($match) {
7185: $statecond=$cond;
7186: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid}
7187: =~/\Q$priv\E\&([^\:]*)/) {
7188: my $value = $1;
7189: if ($priv eq 'bre') {
7190: if ($noblockcheck) {
7191: $thisallowed.=$value;
7192: } else {
7193: my @blockers = &has_comm_blocking($priv,$symb,$uri);
7194: if (@blockers > 0) {
7195: $thisallowed = 'B';
7196: } else {
7197: $thisallowed.=$value;
7198: }
7199: }
7200: } else {
7201: $thisallowed.=$value;
7202: }
7203: $checkreferer=0;
7204: }
7205: }
7206:
7207: if ($checkreferer) {
7208: my $refuri=$env{'httpref.'.$orguri};
7209: unless ($refuri) {
7210: foreach my $key (keys(%env)) {
7211: if ($key=~/^httpref\..*\*/) {
7212: my $pattern=$key;
7213: $pattern=~s/^httpref\.\/res\///;
7214: $pattern=~s/\*/\[\^\/\]\+/g;
7215: $pattern=~s/\//\\\//g;
7216: if ($orguri=~/$pattern/) {
7217: $refuri=$env{$key};
7218: }
7219: }
7220: }
7221: }
7222:
7223: if ($refuri) {
7224: $refuri=&declutter($refuri);
7225: my ($match,$cond)=&is_on_map($refuri);
7226: if ($match) {
7227: my $refstatecond=$cond;
7228: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid}
7229: =~/\Q$priv\E\&([^\:]*)/) {
7230: my $value = $1;
7231: if ($priv eq 'bre') {
7232: if ($noblockcheck) {
7233: $thisallowed.=$value;
7234: } else {
7235: my @blockers = &has_comm_blocking($priv,$symb,$refuri);
7236: if (@blockers > 0) {
7237: $thisallowed = 'B';
7238: } else {
7239: $thisallowed.=$value;
7240: }
7241: }
7242: } else {
7243: $thisallowed.=$value;
7244: }
7245: $uri=$refuri;
7246: $statecond=$refstatecond;
7247: }
7248: }
7249: }
7250: }
7251: }
7252:
7253: #
7254: # Gathered now: all privileges that could apply, and condition number
7255: #
7256: #
7257: # Full or no access?
7258: #
7259:
7260: if ($thisallowed=~/F/) {
7261: return 'F';
7262: }
7263:
7264: unless ($thisallowed) {
7265: return '';
7266: }
7267:
7268: # Restrictions exist, deal with them
7269: #
7270: # C:according to course preferences
7271: # R:according to resource settings
7272: # L:unless locked
7273: # X:according to user session state
7274: #
7275:
7276: # Possibly locked functionality, check all courses
7277: # Locks might take effect only after 10 minutes cache expiration for other
7278: # courses, and 2 minutes for current course
7279:
7280: my $envkey;
7281: if ($thisallowed=~/L/) {
7282: foreach $envkey (keys(%env)) {
7283: if ($envkey=~/^user\.role\.(st|ta)\.([^\.]*)/) {
7284: my $courseid=$2;
7285: my $roleid=$1.'.'.$2;
7286: $courseid=~s/^\///;
7287: my $expiretime=600;
7288: if ($env{'request.role'} eq $roleid) {
7289: $expiretime=120;
7290: }
7291: my ($cdom,$cnum,$csec)=split(/\//,$courseid);
7292: my $prefix='course.'.$cdom.'_'.$cnum.'.';
7293: if ((time-$env{$prefix.'last_cache'})>$expiretime) {
7294: &coursedescription($courseid,{'freshen_cache' => 1});
7295: }
7296: if (($env{$prefix.'res.'.$uri.'.lock.sections'}=~/\,\Q$csec\E\,/)
7297: || ($env{$prefix.'res.'.$uri.'.lock.sections'} eq 'all')) {
7298: if ($env{$prefix.'res.'.$uri.'.lock.expire'}>time) {
7299: &log($env{'user.domain'},$env{'user.name'},
7300: $env{'user.home'},
7301: 'Locked by res: '.$priv.' for '.$uri.' due to '.
7302: $cdom.'/'.$cnum.'/'.$csec.' expire '.
7303: $env{$prefix.'priv.'.$priv.'.lock.expire'});
7304: return '';
7305: }
7306: }
7307: if (($env{$prefix.'priv.'.$priv.'.lock.sections'}=~/\,\Q$csec\E\,/)
7308: || ($env{$prefix.'priv.'.$priv.'.lock.sections'} eq 'all')) {
7309: if ($env{'priv.'.$priv.'.lock.expire'}>time) {
7310: &log($env{'user.domain'},$env{'user.name'},
7311: $env{'user.home'},
7312: 'Locked by priv: '.$priv.' for '.$uri.' due to '.
7313: $cdom.'/'.$cnum.'/'.$csec.' expire '.
7314: $env{$prefix.'priv.'.$priv.'.lock.expire'});
7315: return '';
7316: }
7317: }
7318: }
7319: }
7320: }
7321:
7322: #
7323: # Rest of the restrictions depend on selected course
7324: #
7325:
7326: unless ($env{'request.course.id'}) {
7327: if ($thisallowed eq 'A') {
7328: return 'A';
7329: } elsif ($thisallowed eq 'B') {
7330: return 'B';
7331: } else {
7332: return '1';
7333: }
7334: }
7335:
7336: #
7337: # Now user is definitely in a course
7338: #
7339:
7340:
7341: # Course preferences
7342:
7343: if ($thisallowed=~/C/) {
7344: my $rolecode=(split(/\./,$env{'request.role'}))[0];
7345: my $unamedom=$env{'user.name'}.':'.$env{'user.domain'};
7346: if ($env{'course.'.$env{'request.course.id'}.'.'.$priv.'.roles.denied'}
7347: =~/\Q$rolecode\E/) {
7348: if (($priv ne 'pch') && ($priv ne 'plc') && ($priv ne 'pac')) {
7349: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.':'.
7350: 'Denied by role: '.$priv.' for '.$uri.' as '.$rolecode.' in '.
7351: $env{'request.course.id'});
7352: }
7353: return '';
7354: }
7355:
7356: if ($env{'course.'.$env{'request.course.id'}.'.'.$priv.'.users.denied'}
7357: =~/\Q$unamedom\E/) {
7358: if (($priv ne 'pch') && ($priv ne 'plc') && ($priv ne 'pac')) {
7359: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.
7360: 'Denied by user: '.$priv.' for '.$uri.' as '.$unamedom.' in '.
7361: $env{'request.course.id'});
7362: }
7363: return '';
7364: }
7365: }
7366:
7367: # Resource preferences
7368:
7369: if ($thisallowed=~/R/) {
7370: my $rolecode=(split(/\./,$env{'request.role'}))[0];
7371: if (&metadata($uri,'roledeny')=~/\Q$rolecode\E/) {
7372: if (($priv ne 'pch') && ($priv ne 'plc')) {
7373: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.':'.
7374: 'Denied by role: '.$priv.' for '.$uri.' as '.$rolecode);
7375: }
7376: return '';
7377: }
7378: }
7379:
7380: # Restricted by state or randomout?
7381:
7382: if ($thisallowed=~/X/) {
7383: if ($env{'acc.randomout'}) {
7384: if (!$symb) { $symb=&symbread($uri,1); }
7385: if (($symb) && ($env{'acc.randomout'}=~/\&\Q$symb\E\&/)) {
7386: return '';
7387: }
7388: }
7389: if (&condval($statecond)) {
7390: return '2';
7391: } else {
7392: return '';
7393: }
7394: }
7395:
7396: if ($thisallowed eq 'A') {
7397: return 'A';
7398: } elsif ($thisallowed eq 'B') {
7399: return 'B';
7400: }
7401: return 'F';
7402: }
7403:
7404: # ------------------------------------------- Check construction space access
7405:
7406: sub constructaccess {
7407: my ($url,$setpriv)=@_;
7408:
7409: # We do not allow editing of previous versions of files
7410: if ($url=~/\.(\d+)\.(\w+)$/) { return ''; }
7411:
7412: # Get username and domain from URL
7413: my ($ownername,$ownerdomain,$ownerhome);
7414:
7415: ($ownerdomain,$ownername) =
7416: ($url=~ m{^(?:\Q$perlvar{'lonDocRoot'}\E|)(?:/daxepage|/daxeopen)?/priv/($match_domain)/($match_username)/});
7417:
7418: # The URL does not really point to any authorspace, forget it
7419: unless (($ownername) && ($ownerdomain)) { return ''; }
7420:
7421: # Now we need to see if the user has access to the authorspace of
7422: # $ownername at $ownerdomain
7423:
7424: if (($ownername eq $env{'user.name'}) && ($ownerdomain eq $env{'user.domain'})) {
7425: # Real author for this?
7426: $ownerhome = $env{'user.home'};
7427: if (exists($env{'user.priv.au./'.$ownerdomain.'/./'})) {
7428: return ($ownername,$ownerdomain,$ownerhome);
7429: }
7430: } else {
7431: # Co-author for this?
7432: if (exists($env{'user.priv.ca./'.$ownerdomain.'/'.$ownername.'./'}) ||
7433: exists($env{'user.priv.aa./'.$ownerdomain.'/'.$ownername.'./'}) ) {
7434: $ownerhome = &homeserver($ownername,$ownerdomain);
7435: return ($ownername,$ownerdomain,$ownerhome);
7436: }
7437: if ($env{'request.course.id'}) {
7438: if (($ownername eq $env{'course.'.$env{'request.course.id'}.'.num'}) &&
7439: ($ownerdomain eq $env{'course.'.$env{'request.course.id'}.'.domain'})) {
7440: if (&allowed('mdc',$env{'request.course.id'})) {
7441: $ownerhome = $env{'course.'.$env{'request.course.id'}.'.home'};
7442: return ($ownername,$ownerdomain,$ownerhome);
7443: }
7444: }
7445: }
7446: }
7447:
7448: # We don't have any access right now. If we are not possibly going to do anything about this,
7449: # we might as well leave
7450: unless ($setpriv) { return ''; }
7451:
7452: # Backdoor access?
7453: my $allowed=&allowed('eco',$ownerdomain);
7454: # Nope
7455: unless ($allowed) { return ''; }
7456: # Looks like we may have access, but could be locked by the owner of the construction space
7457: if ($allowed eq 'U') {
7458: my %blocked=&get('environment',['domcoord.author'],
7459: $ownerdomain,$ownername);
7460: # Is blocked by owner
7461: if ($blocked{'domcoord.author'} eq 'blocked') { return ''; }
7462: }
7463: if (($allowed eq 'F') || ($allowed eq 'U')) {
7464: # Grant temporary access
7465: my $then=$env{'user.login.time'};
7466: my $update=$env{'user.update.time'};
7467: if (!$update) { $update = $then; }
7468: my $refresh=$env{'user.refresh.time'};
7469: if (!$refresh) { $refresh = $update; }
7470: my $now = time;
7471: &check_adhoc_privs($ownerdomain,$ownername,$update,$refresh,
7472: $now,'ca','constructaccess');
7473: $ownerhome = &homeserver($ownername,$ownerdomain);
7474: return($ownername,$ownerdomain,$ownerhome);
7475: }
7476: # No business here
7477: return '';
7478: }
7479:
7480: # ----------------------------------------------------------- Content Blocking
7481:
7482: {
7483: # Caches for faster Course Contents display where content blocking
7484: # is in operation (i.e., interval param set) for timed quiz.
7485: #
7486: # User for whom data are being temporarily cached.
7487: my $cacheduser='';
7488: # Cached blockers for this user (a hash of blocking items).
7489: my %cachedblockers=();
7490: # When the data were last cached.
7491: my $cachedlast='';
7492:
7493: sub load_all_blockers {
7494: my ($uname,$udom,$blocks)=@_;
7495: if (($uname ne '') && ($udom ne '')) {
7496: if (($cacheduser eq $uname.':'.$udom) &&
7497: (abs($cachedlast-time)<5)) {
7498: return;
7499: }
7500: }
7501: $cachedlast=time;
7502: $cacheduser=$uname.':'.$udom;
7503: %cachedblockers = &get_commblock_resources($blocks);
7504: }
7505:
7506: sub get_comm_blocks {
7507: my ($cdom,$cnum) = @_;
7508: if ($cdom eq '' || $cnum eq '') {
7509: return unless ($env{'request.course.id'});
7510: $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
7511: $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
7512: }
7513: my %commblocks;
7514: my $hashid=$cdom.'_'.$cnum;
7515: my ($blocksref,$cached)=&is_cached_new('comm_block',$hashid);
7516: if ((defined($cached)) && (ref($blocksref) eq 'HASH')) {
7517: %commblocks = %{$blocksref};
7518: } else {
7519: %commblocks = &Apache::lonnet::dump('comm_block',$cdom,$cnum);
7520: my $cachetime = 600;
7521: &do_cache_new('comm_block',$hashid,\%commblocks,$cachetime);
7522: }
7523: return %commblocks;
7524: }
7525:
7526: sub get_commblock_resources {
7527: my ($blocks) = @_;
7528: my %blockers = ();
7529: return %blockers unless ($env{'request.course.id'});
7530: return %blockers if ($env{'user.priv.'.$env{'request.role'}} =~/evb\&([^\:]*)/);
7531: my %commblocks;
7532: if (ref($blocks) eq 'HASH') {
7533: %commblocks = %{$blocks};
7534: } else {
7535: %commblocks = &get_comm_blocks();
7536: }
7537: return %blockers unless (keys(%commblocks) > 0);
7538: my $navmap = Apache::lonnavmaps::navmap->new();
7539: return %blockers unless (ref($navmap));
7540: my $now = time;
7541: foreach my $block (keys(%commblocks)) {
7542: if ($block =~ /^(\d+)____(\d+)$/) {
7543: my ($start,$end) = ($1,$2);
7544: if ($start <= $now && $end >= $now) {
7545: if (ref($commblocks{$block}{'blocks'}) eq 'HASH') {
7546: if (ref($commblocks{$block}{'blocks'}{'docs'}) eq 'HASH') {
7547: if (ref($commblocks{$block}{'blocks'}{'docs'}{'maps'}) eq 'HASH') {
7548: if (keys(%{$commblocks{$block}{'blocks'}{'docs'}{'maps'}})) {
7549: $blockers{$block}{maps} = $commblocks{$block}{'blocks'}{'docs'}{'maps'};
7550: }
7551: }
7552: if (ref($commblocks{$block}{'blocks'}{'docs'}{'resources'}) eq 'HASH') {
7553: if (keys(%{$commblocks{$block}{'blocks'}{'docs'}{'resources'}})) {
7554: $blockers{$block}{'resources'} = $commblocks{$block}{'blocks'}{'docs'}{'resources'};
7555: }
7556: }
7557: }
7558: }
7559: }
7560: } elsif ($block =~ /^firstaccess____(.+)$/) {
7561: my $item = $1;
7562: my @to_test;
7563: if (ref($commblocks{$block}{'blocks'}) eq 'HASH') {
7564: if (ref($commblocks{$block}{'blocks'}{'docs'}) eq 'HASH') {
7565: my @interval;
7566: my $type = 'map';
7567: if ($item eq 'course') {
7568: $type = 'course';
7569: @interval=&EXT("resource.0.interval");
7570: } else {
7571: if ($item =~ /___\d+___/) {
7572: $type = 'resource';
7573: @interval=&EXT("resource.0.interval",$item);
7574: if (ref($navmap)) {
7575: my $res = $navmap->getBySymb($item);
7576: push(@to_test,$res);
7577: }
7578: } else {
7579: my $mapsymb = &symbread($item,1);
7580: if ($mapsymb) {
7581: if (ref($navmap)) {
7582: my $mapres = $navmap->getBySymb($mapsymb);
7583: @to_test = $mapres->retrieveResources($mapres,undef,0,0,0,1);
7584: foreach my $res (@to_test) {
7585: my $symb = $res->symb();
7586: next if ($symb eq $mapsymb);
7587: if ($symb ne '') {
7588: @interval=&EXT("resource.0.interval",$symb);
7589: if ($interval[1] eq 'map') {
7590: last;
7591: }
7592: }
7593: }
7594: }
7595: }
7596: }
7597: }
7598: if ($interval[0] =~ /^(\d+)/) {
7599: my $timelimit = $1;
7600: my $first_access;
7601: if ($type eq 'resource') {
7602: $first_access=&get_first_access($interval[1],$item);
7603: } elsif ($type eq 'map') {
7604: $first_access=&get_first_access($interval[1],undef,$item);
7605: } else {
7606: $first_access=&get_first_access($interval[1]);
7607: }
7608: if ($first_access) {
7609: my $timesup = $first_access+$timelimit;
7610: if ($timesup > $now) {
7611: my $activeblock;
7612: foreach my $res (@to_test) {
7613: if ($res->answerable()) {
7614: $activeblock = 1;
7615: last;
7616: }
7617: }
7618: if ($activeblock) {
7619: if (ref($commblocks{$block}{'blocks'}{'docs'}{'maps'}) eq 'HASH') {
7620: if (keys(%{$commblocks{$block}{'blocks'}{'docs'}{'maps'}})) {
7621: $blockers{$block}{'maps'} = $commblocks{$block}{'blocks'}{'docs'}{'maps'};
7622: }
7623: }
7624: if (ref($commblocks{$block}{'blocks'}{'docs'}{'resources'}) eq 'HASH') {
7625: if (keys(%{$commblocks{$block}{'blocks'}{'docs'}{'resources'}})) {
7626: $blockers{$block}{'resources'} = $commblocks{$block}{'blocks'}{'docs'}{'resources'};
7627: }
7628: }
7629: }
7630: }
7631: }
7632: }
7633: }
7634: }
7635: }
7636: }
7637: return %blockers;
7638: }
7639:
7640: sub has_comm_blocking {
7641: my ($priv,$symb,$uri,$blocks) = @_;
7642: my @blockers;
7643: return unless ($env{'request.course.id'});
7644: return unless ($priv eq 'bre');
7645: return if ($env{'user.priv.'.$env{'request.role'}} =~/evb\&([^\:]*)/);
7646: return if ($env{'request.state'} eq 'construct');
7647: &load_all_blockers($env{'user.name'},$env{'user.domain'},$blocks);
7648: return unless (keys(%cachedblockers) > 0);
7649: my (%possibles,@symbs);
7650: if (!$symb) {
7651: $symb = &symbread($uri,1,1,1,\%possibles);
7652: }
7653: if ($symb) {
7654: @symbs = ($symb);
7655: } elsif (keys(%possibles)) {
7656: @symbs = keys(%possibles);
7657: }
7658: my $noblock;
7659: foreach my $symb (@symbs) {
7660: last if ($noblock);
7661: my ($map,$resid,$resurl)=&decode_symb($symb);
7662: foreach my $block (keys(%cachedblockers)) {
7663: if ($block =~ /^firstaccess____(.+)$/) {
7664: my $item = $1;
7665: if (($item eq $map) || ($item eq $symb)) {
7666: $noblock = 1;
7667: last;
7668: }
7669: }
7670: if (ref($cachedblockers{$block}) eq 'HASH') {
7671: if (ref($cachedblockers{$block}{'resources'}) eq 'HASH') {
7672: if ($cachedblockers{$block}{'resources'}{$symb}) {
7673: unless (grep(/^\Q$block\E$/,@blockers)) {
7674: push(@blockers,$block);
7675: }
7676: }
7677: }
7678: }
7679: if (ref($cachedblockers{$block}{'maps'}) eq 'HASH') {
7680: if ($cachedblockers{$block}{'maps'}{$map}) {
7681: unless (grep(/^\Q$block\E$/,@blockers)) {
7682: push(@blockers,$block);
7683: }
7684: }
7685: }
7686: }
7687: }
7688: return if ($noblock);
7689: return @blockers;
7690: }
7691: }
7692:
7693: # -------------------------------- Deversion and split uri into path an filename
7694:
7695: #
7696: # Removes the version from a URI and
7697: # splits it in to its filename and path to the filename.
7698: # Seems like File::Basename could have done this more clearly.
7699: # Parameters:
7700: # $uri - input URI
7701: # Returns:
7702: # Two element list consisting of
7703: # $pathname - the URI up to and excluding the trailing /
7704: # $filename - The part of the URI following the last /
7705: # NOTE:
7706: # Another realization of this is simply:
7707: # use File::Basename;
7708: # ...
7709: # $uri = shift;
7710: # $filename = basename($uri);
7711: # $path = dirname($uri);
7712: # return ($filename, $path);
7713: #
7714: # The implementation below is probably faster however.
7715: #
7716: sub split_uri_for_cond {
7717: my $uri=&deversion(&declutter(shift));
7718: my @uriparts=split(/\//,$uri);
7719: my $filename=pop(@uriparts);
7720: my $pathname=join('/',@uriparts);
7721: return ($pathname,$filename);
7722: }
7723: # --------------------------------------------------- Is a resource on the map?
7724:
7725: sub is_on_map {
7726: my ($pathname,$filename) = &split_uri_for_cond(shift);
7727: #Trying to find the conditional for the file
7728: my $match=($env{'acc.res.'.$env{'request.course.id'}.'.'.$pathname}=~
7729: /\&\Q$filename\E\:([\d\|]+)\&/);
7730: if ($match) {
7731: return (1,$1);
7732: } else {
7733: return (0,0);
7734: }
7735: }
7736:
7737: # --------------------------------------------------------- Get symb from alias
7738:
7739: sub get_symb_from_alias {
7740: my $symb=shift;
7741: my ($map,$resid,$url)=&decode_symb($symb);
7742: # Already is a symb
7743: if ($url) { return $symb; }
7744: # Must be an alias
7745: my $aliassymb='';
7746: my %bighash;
7747: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
7748: &GDBM_READER(),0640)) {
7749: my $rid=$bighash{'mapalias_'.$symb};
7750: if ($rid) {
7751: my ($mapid,$resid)=split(/\./,$rid);
7752: $aliassymb=&encode_symb($bighash{'map_id_'.$mapid},
7753: $resid,$bighash{'src_'.$rid});
7754: }
7755: untie %bighash;
7756: }
7757: return $aliassymb;
7758: }
7759:
7760: # ----------------------------------------------------------------- Define Role
7761:
7762: sub definerole {
7763: if (allowed('mcr','/')) {
7764: my ($rolename,$sysrole,$domrole,$courole)=@_;
7765: foreach my $role (split(':',$sysrole)) {
7766: my ($crole,$cqual)=split(/\&/,$role);
7767: if ($pr{'cr:s'}!~/\Q$crole\E/) { return "refused:s:$crole"; }
7768: if ($pr{'cr:s'}=~/\Q$crole\E\&/) {
7769: if ($pr{'cr:s'}!~/\Q$crole\E\&\w*\Q$cqual\E/) {
7770: return "refused:s:$crole&$cqual";
7771: }
7772: }
7773: }
7774: foreach my $role (split(':',$domrole)) {
7775: my ($crole,$cqual)=split(/\&/,$role);
7776: if ($pr{'cr:d'}!~/\Q$crole\E/) { return "refused:d:$crole"; }
7777: if ($pr{'cr:d'}=~/\Q$crole\E\&/) {
7778: if ($pr{'cr:d'}!~/\Q$crole\W\&\w*\Q$cqual\E/) {
7779: return "refused:d:$crole&$cqual";
7780: }
7781: }
7782: }
7783: foreach my $role (split(':',$courole)) {
7784: my ($crole,$cqual)=split(/\&/,$role);
7785: if ($pr{'cr:c'}!~/\Q$crole\E/) { return "refused:c:$crole"; }
7786: if ($pr{'cr:c'}=~/\Q$crole\E\&/) {
7787: if ($pr{'cr:c'}!~/\Q$crole\E\&\w*\Q$cqual\E/) {
7788: return "refused:c:$crole&$cqual";
7789: }
7790: }
7791: }
7792: my $command="encrypt:rolesput:$env{'user.domain'}:$env{'user.name'}:".
7793: "$env{'user.domain'}:$env{'user.name'}:".
7794: "rolesdef_$rolename=".
7795: escape($sysrole.'_'.$domrole.'_'.$courole);
7796: return reply($command,$env{'user.home'});
7797: } else {
7798: return 'refused';
7799: }
7800: }
7801:
7802: # ---------------- Make a metadata query against the network of library servers
7803:
7804: sub metadata_query {
7805: my ($query,$custom,$customshow,$server_array,$domains_hash)=@_;
7806: my %rhash;
7807: my %libserv = &all_library();
7808: my @server_list = (defined($server_array) ? @$server_array
7809: : keys(%libserv) );
7810: for my $server (@server_list) {
7811: my $domains = '';
7812: if (ref($domains_hash) eq 'HASH') {
7813: $domains = $domains_hash->{$server};
7814: }
7815: unless ($custom or $customshow) {
7816: my $reply=&reply("querysend:".&escape($query).':::'.&escape($domains),$server);
7817: $rhash{$server}=$reply;
7818: }
7819: else {
7820: my $reply=&reply("querysend:".&escape($query).':'.
7821: &escape($custom).':'.&escape($customshow).':'.&escape($domains),
7822: $server);
7823: $rhash{$server}=$reply;
7824: }
7825: }
7826: return \%rhash;
7827: }
7828:
7829: # ----------------------------------------- Send log queries and wait for reply
7830:
7831: sub log_query {
7832: my ($uname,$udom,$query,%filters)=@_;
7833: my $uhome=&homeserver($uname,$udom);
7834: if ($uhome eq 'no_host') { return 'error: no_host'; }
7835: my $uhost=&hostname($uhome);
7836: my $command=&escape(join(':',map{$_.'='.$filters{$_}} keys(%filters)));
7837: my $queryid=&reply("querysend:".$query.':'.$udom.':'.$uname.':'.$command,
7838: $uhome);
7839: unless ($queryid=~/^\Q$uhost\E\_/) { return 'error: '.$queryid; }
7840: return get_query_reply($queryid);
7841: }
7842:
7843: # -------------------------- Update MySQL table for portfolio file
7844:
7845: sub update_portfolio_table {
7846: my ($uname,$udom,$file_name,$query,$group,$action) = @_;
7847: if ($group ne '') {
7848: $file_name =~s /^\Q$group\E//;
7849: }
7850: my $homeserver = &homeserver($uname,$udom);
7851: my $queryid=
7852: &reply("querysend:".$query.':'.&escape($uname.':'.$udom.':'.$group).
7853: ':'.&escape($file_name).':'.$action,$homeserver);
7854: my $reply = &get_query_reply($queryid);
7855: return $reply;
7856: }
7857:
7858: # -------------------------- Update MySQL allusers table
7859:
7860: sub update_allusers_table {
7861: my ($uname,$udom,$names) = @_;
7862: my $homeserver = &homeserver($uname,$udom);
7863: my $queryid=
7864: &reply('querysend:allusers:'.&escape($uname).':'.&escape($udom).':'.
7865: 'lastname='.&escape($names->{'lastname'}).'%%'.
7866: 'firstname='.&escape($names->{'firstname'}).'%%'.
7867: 'middlename='.&escape($names->{'middlename'}).'%%'.
7868: 'generation='.&escape($names->{'generation'}).'%%'.
7869: 'permanentemail='.&escape($names->{'permanentemail'}).'%%'.
7870: 'id='.&escape($names->{'id'}),$homeserver);
7871: return;
7872: }
7873:
7874: # ------- Request retrieval of institutional classlists for course(s)
7875:
7876: sub fetch_enrollment_query {
7877: my ($context,$affiliatesref,$replyref,$dom,$cnum) = @_;
7878: my ($homeserver,$sleep,$loopmax);
7879: my $maxtries = 1;
7880: if ($context eq 'automated') {
7881: $homeserver = $perlvar{'lonHostID'};
7882: $sleep = 2;
7883: $loopmax = 100;
7884: $maxtries = 10; # will wait for up to 2000s for retrieval of classlist data before timeout
7885: } else {
7886: $homeserver = &homeserver($cnum,$dom);
7887: }
7888: my $host=&hostname($homeserver);
7889: my $cmd = '';
7890: foreach my $affiliate (keys(%{$affiliatesref})) {
7891: $cmd .= $affiliate.'='.join(",",@{$$affiliatesref{$affiliate}}).'%%';
7892: }
7893: $cmd =~ s/%%$//;
7894: $cmd = &escape($cmd);
7895: my $query = 'fetchenrollment';
7896: my $queryid=&reply("querysend:".$query.':'.$dom.':'.$env{'user.name'}.':'.$cmd,$homeserver);
7897: unless ($queryid=~/^\Q$host\E\_/) {
7898: &logthis('fetch_enrollment_query: invalid queryid: '.$queryid.' for host: '.$host.' and homeserver: '.$homeserver.' context: '.$context.' '.$cnum);
7899: return 'error: '.$queryid;
7900: }
7901: my $reply = &get_query_reply($queryid,$sleep,$loopmax);
7902: my $tries = 1;
7903: while (($reply=~/^timeout/) && ($tries < $maxtries)) {
7904: $reply = &get_query_reply($queryid,$sleep,$loopmax);
7905: $tries ++;
7906: }
7907: if ( ($reply =~/^timeout/) || ($reply =~/^error/) ) {
7908: &logthis('fetch_enrollment_query error: '.$reply.' for '.$dom.' '.$env{'user.name'}.' for '.$queryid.' context: '.$context.' '.$cnum.' maxtries: '.$maxtries.' tries: '.$tries);
7909: } else {
7910: my @responses = split(/:/,$reply);
7911: if ($homeserver eq $perlvar{'lonHostID'}) {
7912: foreach my $line (@responses) {
7913: my ($key,$value) = split(/=/,$line,2);
7914: $$replyref{$key} = $value;
7915: }
7916: } else {
7917: my $pathname = LONCAPA::tempdir();
7918: foreach my $line (@responses) {
7919: my ($key,$value) = split(/=/,$line);
7920: $$replyref{$key} = $value;
7921: if ($value > 0) {
7922: foreach my $item (@{$$affiliatesref{$key}}) {
7923: my $filename = $dom.'_'.$key.'_'.$item.'_classlist.xml';
7924: my $destname = $pathname.'/'.$filename;
7925: my $xml_classlist = &reply("autoretrieve:".$filename,$homeserver);
7926: if ($xml_classlist =~ /^error/) {
7927: &logthis('fetch_enrollment_query - autoretrieve error: '.$xml_classlist.' for '.$filename.' from server: '.$homeserver.' '.$context.' '.$cnum);
7928: } else {
7929: if ( open(FILE,">$destname") ) {
7930: print FILE &unescape($xml_classlist);
7931: close(FILE);
7932: } else {
7933: &logthis('fetch_enrollment_query - error opening classlist file '.$destname.' '.$context.' '.$cnum);
7934: }
7935: }
7936: }
7937: }
7938: }
7939: }
7940: return 'ok';
7941: }
7942: return 'error';
7943: }
7944:
7945: sub get_query_reply {
7946: my ($queryid,$sleep,$loopmax) = @_;;
7947: if (($sleep eq '') || ($sleep !~ /^\d+\.?\d*$/)) {
7948: $sleep = 0.2;
7949: }
7950: if (($loopmax eq '') || ($loopmax =~ /\D/)) {
7951: $loopmax = 100;
7952: }
7953: my $replyfile=LONCAPA::tempdir().$queryid;
7954: my $reply='';
7955: for (1..$loopmax) {
7956: sleep($sleep);
7957: if (-e $replyfile.'.end') {
7958: if (open(my $fh,$replyfile)) {
7959: $reply = join('',<$fh>);
7960: close($fh);
7961: } else { return 'error: reply_file_error'; }
7962: return &unescape($reply);
7963: }
7964: }
7965: return 'timeout:'.$queryid;
7966: }
7967:
7968: sub courselog_query {
7969: #
7970: # possible filters:
7971: # url: url or symb
7972: # username
7973: # domain
7974: # action: view, submit, grade
7975: # start: timestamp
7976: # end: timestamp
7977: #
7978: my (%filters)=@_;
7979: unless ($env{'request.course.id'}) { return 'no_course'; }
7980: if ($filters{'url'}) {
7981: $filters{'url'}=&symbclean(&declutter($filters{'url'}));
7982: $filters{'url'}=~s/\.(\w+)$/(\\.\\d+)*\\.$1/;
7983: $filters{'url'}=~s/\.(\w+)\_\_\_/(\\.\\d+)*\\.$1/;
7984: }
7985: my $cname=$env{'course.'.$env{'request.course.id'}.'.num'};
7986: my $cdom=$env{'course.'.$env{'request.course.id'}.'.domain'};
7987: return &log_query($cname,$cdom,'courselog',%filters);
7988: }
7989:
7990: sub userlog_query {
7991: #
7992: # possible filters:
7993: # action: log check role
7994: # start: timestamp
7995: # end: timestamp
7996: #
7997: my ($uname,$udom,%filters)=@_;
7998: return &log_query($uname,$udom,'userlog',%filters);
7999: }
8000:
8001: #--------- Call auto-enrollment subs in localenroll.pm for homeserver for course
8002:
8003: sub auto_run {
8004: my ($cnum,$cdom) = @_;
8005: my $response = 0;
8006: my $settings;
8007: my %domconfig = &get_dom('configuration',['autoenroll'],$cdom);
8008: if (ref($domconfig{'autoenroll'}) eq 'HASH') {
8009: $settings = $domconfig{'autoenroll'};
8010: if ($settings->{'run'} eq '1') {
8011: $response = 1;
8012: }
8013: } else {
8014: my $homeserver;
8015: if (&is_course($cdom,$cnum)) {
8016: $homeserver = &homeserver($cnum,$cdom);
8017: } else {
8018: $homeserver = &domain($cdom,'primary');
8019: }
8020: if ($homeserver ne 'no_host') {
8021: $response = &reply('autorun:'.$cdom,$homeserver);
8022: }
8023: }
8024: return $response;
8025: }
8026:
8027: sub auto_get_sections {
8028: my ($cnum,$cdom,$inst_coursecode) = @_;
8029: my $homeserver;
8030: if (($cdom =~ /^$match_domain$/) && ($cnum =~ /^$match_courseid$/)) {
8031: $homeserver = &homeserver($cnum,$cdom);
8032: }
8033: if (!defined($homeserver)) {
8034: if ($cdom =~ /^$match_domain$/) {
8035: $homeserver = &domain($cdom,'primary');
8036: }
8037: }
8038: my @secs;
8039: if (defined($homeserver)) {
8040: my $response=&unescape(&reply('autogetsections:'.$inst_coursecode.':'.$cdom,$homeserver));
8041: unless ($response eq 'refused') {
8042: @secs = split(/:/,$response);
8043: }
8044: }
8045: return @secs;
8046: }
8047:
8048: sub auto_new_course {
8049: my ($cnum,$cdom,$inst_course_id,$owner,$coowners) = @_;
8050: my $homeserver = &homeserver($cnum,$cdom);
8051: my $response=&unescape(&reply('autonewcourse:'.$inst_course_id.':'.&escape($owner).':'.$cdom.':'.&escape($coowners),$homeserver));
8052: return $response;
8053: }
8054:
8055: sub auto_validate_courseID {
8056: my ($cnum,$cdom,$inst_course_id) = @_;
8057: my $homeserver = &homeserver($cnum,$cdom);
8058: my $response=&unescape(&reply('autovalidatecourse:'.$inst_course_id.':'.$cdom,$homeserver));
8059: return $response;
8060: }
8061:
8062: sub auto_validate_instcode {
8063: my ($cnum,$cdom,$instcode,$owner) = @_;
8064: my ($homeserver,$response);
8065: if (($cdom =~ /^$match_domain$/) && ($cnum =~ /^$match_courseid$/)) {
8066: $homeserver = &homeserver($cnum,$cdom);
8067: }
8068: if (!defined($homeserver)) {
8069: if ($cdom =~ /^$match_domain$/) {
8070: $homeserver = &domain($cdom,'primary');
8071: }
8072: }
8073: $response=&unescape(&reply('autovalidateinstcode:'.$cdom.':'.
8074: &escape($instcode).':'.&escape($owner),$homeserver));
8075: my ($outcome,$description,$defaultcredits) = map { &unescape($_); } split('&',$response,3);
8076: return ($outcome,$description,$defaultcredits);
8077: }
8078:
8079: sub auto_create_password {
8080: my ($cnum,$cdom,$authparam,$udom) = @_;
8081: my ($homeserver,$response);
8082: my $create_passwd = 0;
8083: my $authchk = '';
8084: if ($udom =~ /^$match_domain$/) {
8085: $homeserver = &domain($udom,'primary');
8086: }
8087: if ($homeserver eq '') {
8088: if (($cdom =~ /^$match_domain$/) && ($cnum =~ /^$match_courseid$/)) {
8089: $homeserver = &homeserver($cnum,$cdom);
8090: }
8091: }
8092: if ($homeserver eq '') {
8093: $authchk = 'nodomain';
8094: } else {
8095: $response=&unescape(&reply('autocreatepassword:'.$authparam.':'.$cdom,$homeserver));
8096: if ($response eq 'refused') {
8097: $authchk = 'refused';
8098: } else {
8099: ($authparam,$create_passwd,$authchk) = split(/:/,$response);
8100: }
8101: }
8102: return ($authparam,$create_passwd,$authchk);
8103: }
8104:
8105: sub auto_photo_permission {
8106: my ($cnum,$cdom,$students) = @_;
8107: my $homeserver = &homeserver($cnum,$cdom);
8108: my ($outcome,$perm_reqd,$conditions) =
8109: split(/:/,&unescape(&reply('autophotopermission:'.$cdom,$homeserver)),3);
8110: if ($outcome =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
8111: return (undef,undef);
8112: }
8113: return ($outcome,$perm_reqd,$conditions);
8114: }
8115:
8116: sub auto_checkphotos {
8117: my ($uname,$udom,$pid) = @_;
8118: my $homeserver = &homeserver($uname,$udom);
8119: my ($result,$resulttype);
8120: my $outcome = &unescape(&reply('autophotocheck:'.&escape($udom).':'.
8121: &escape($uname).':'.&escape($pid),
8122: $homeserver));
8123: if ($outcome =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
8124: return (undef,undef);
8125: }
8126: if ($outcome) {
8127: ($result,$resulttype) = split(/:/,$outcome);
8128: }
8129: return ($result,$resulttype);
8130: }
8131:
8132: sub auto_photochoice {
8133: my ($cnum,$cdom) = @_;
8134: my $homeserver = &homeserver($cnum,$cdom);
8135: my ($update,$comment) = split(/:/,&unescape(&reply('autophotochoice:'.
8136: &escape($cdom),
8137: $homeserver)));
8138: if ($update =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
8139: return (undef,undef);
8140: }
8141: return ($update,$comment);
8142: }
8143:
8144: sub auto_photoupdate {
8145: my ($affiliatesref,$dom,$cnum,$photo) = @_;
8146: my $homeserver = &homeserver($cnum,$dom);
8147: my $host=&hostname($homeserver);
8148: my $cmd = '';
8149: my $maxtries = 1;
8150: foreach my $affiliate (keys(%{$affiliatesref})) {
8151: $cmd .= $affiliate.'='.join(",",@{$$affiliatesref{$affiliate}}).'%%';
8152: }
8153: $cmd =~ s/%%$//;
8154: $cmd = &escape($cmd);
8155: my $query = 'institutionalphotos';
8156: my $queryid=&reply("querysend:".$query.':'.$dom.':'.$cnum.':'.$cmd,$homeserver);
8157: unless ($queryid=~/^\Q$host\E\_/) {
8158: &logthis('institutionalphotos: invalid queryid: '.$queryid.' for host: '.$host.' and homeserver: '.$homeserver.' and course: '.$cnum);
8159: return 'error: '.$queryid;
8160: }
8161: my $reply = &get_query_reply($queryid);
8162: my $tries = 1;
8163: while (($reply=~/^timeout/) && ($tries < $maxtries)) {
8164: $reply = &get_query_reply($queryid);
8165: $tries ++;
8166: }
8167: if ( ($reply =~/^timeout/) || ($reply =~/^error/) ) {
8168: &logthis('institutionalphotos error: '.$reply.' for '.$dom.' '.$env{'user.name'}.' for '.$queryid.' course: '.$cnum.' maxtries: '.$maxtries.' tries: '.$tries);
8169: } else {
8170: my @responses = split(/:/,$reply);
8171: my $outcome = shift(@responses);
8172: foreach my $item (@responses) {
8173: my ($key,$value) = split(/=/,$item);
8174: $$photo{$key} = $value;
8175: }
8176: return $outcome;
8177: }
8178: return 'error';
8179: }
8180:
8181: sub auto_instcode_format {
8182: my ($caller,$codedom,$instcodes,$codes,$codetitles,$cat_titles,
8183: $cat_order) = @_;
8184: my $courses = '';
8185: my @homeservers;
8186: if ($caller eq 'global') {
8187: my %servers = &get_servers($codedom,'library');
8188: foreach my $tryserver (keys(%servers)) {
8189: if (!grep(/^\Q$tryserver\E$/,@homeservers)) {
8190: push(@homeservers,$tryserver);
8191: }
8192: }
8193: } elsif ($caller eq 'requests') {
8194: if ($codedom =~ /^$match_domain$/) {
8195: my $chome = &domain($codedom,'primary');
8196: unless ($chome eq 'no_host') {
8197: push(@homeservers,$chome);
8198: }
8199: }
8200: } else {
8201: push(@homeservers,&homeserver($caller,$codedom));
8202: }
8203: foreach my $code (keys(%{$instcodes})) {
8204: $courses .= &escape($code).'='.&escape($$instcodes{$code}).'&';
8205: }
8206: chop($courses);
8207: my $ok_response = 0;
8208: my $response;
8209: while (@homeservers > 0 && $ok_response == 0) {
8210: my $server = shift(@homeservers);
8211: $response=&reply('autoinstcodeformat:'.$codedom.':'.$courses,$server);
8212: if ($response !~ /(con_lost|error|no_such_host|refused)/) {
8213: my ($codes_str,$codetitles_str,$cat_titles_str,$cat_order_str) =
8214: split(/:/,$response);
8215: %{$codes} = (%{$codes},&str2hash($codes_str));
8216: push(@{$codetitles},&str2array($codetitles_str));
8217: %{$cat_titles} = (%{$cat_titles},&str2hash($cat_titles_str));
8218: %{$cat_order} = (%{$cat_order},&str2hash($cat_order_str));
8219: $ok_response = 1;
8220: }
8221: }
8222: if ($ok_response) {
8223: return 'ok';
8224: } else {
8225: return $response;
8226: }
8227: }
8228:
8229: sub auto_instcode_defaults {
8230: my ($domain,$returnhash,$code_order) = @_;
8231: my @homeservers;
8232:
8233: my %servers = &get_servers($domain,'library');
8234: foreach my $tryserver (keys(%servers)) {
8235: if (!grep(/^\Q$tryserver\E$/,@homeservers)) {
8236: push(@homeservers,$tryserver);
8237: }
8238: }
8239:
8240: my $response;
8241: foreach my $server (@homeservers) {
8242: $response=&reply('autoinstcodedefaults:'.$domain,$server);
8243: next if ($response =~ /(con_lost|error|no_such_host|refused)/);
8244:
8245: foreach my $pair (split(/\&/,$response)) {
8246: my ($name,$value)=split(/\=/,$pair);
8247: if ($name eq 'code_order') {
8248: @{$code_order} = split(/\&/,&unescape($value));
8249: } else {
8250: $returnhash->{&unescape($name)}=&unescape($value);
8251: }
8252: }
8253: return 'ok';
8254: }
8255:
8256: return $response;
8257: }
8258:
8259: sub auto_possible_instcodes {
8260: my ($domain,$codetitles,$cat_titles,$cat_orders,$code_order) = @_;
8261: unless ((ref($codetitles) eq 'ARRAY') && (ref($cat_titles) eq 'HASH') &&
8262: (ref($cat_orders) eq 'HASH') && (ref($code_order) eq 'ARRAY')) {
8263: return;
8264: }
8265: my (@homeservers,$uhome);
8266: if (defined(&domain($domain,'primary'))) {
8267: $uhome=&domain($domain,'primary');
8268: push(@homeservers,&domain($domain,'primary'));
8269: } else {
8270: my %servers = &get_servers($domain,'library');
8271: foreach my $tryserver (keys(%servers)) {
8272: if (!grep(/^\Q$tryserver\E$/,@homeservers)) {
8273: push(@homeservers,$tryserver);
8274: }
8275: }
8276: }
8277: my $response;
8278: foreach my $server (@homeservers) {
8279: $response=&reply('autopossibleinstcodes:'.$domain,$server);
8280: next if ($response =~ /(con_lost|error|no_such_host|refused)/);
8281: my ($codetitlestr,$codeorderstr,$cat_title,$cat_order) =
8282: split(':',$response);
8283: @{$codetitles} = map { &unescape($_); } (split('&',$codetitlestr));
8284: @{$code_order} = map { &unescape($_); } (split('&',$codeorderstr));
8285: foreach my $item (split('&',$cat_title)) {
8286: my ($name,$value)=split('=',$item);
8287: $cat_titles->{&unescape($name)}=&thaw_unescape($value);
8288: }
8289: foreach my $item (split('&',$cat_order)) {
8290: my ($name,$value)=split('=',$item);
8291: $cat_orders->{&unescape($name)}=&thaw_unescape($value);
8292: }
8293: return 'ok';
8294: }
8295: return $response;
8296: }
8297:
8298: sub auto_courserequest_checks {
8299: my ($dom) = @_;
8300: my ($homeserver,%validations);
8301: if ($dom =~ /^$match_domain$/) {
8302: $homeserver = &domain($dom,'primary');
8303: }
8304: unless ($homeserver eq 'no_host') {
8305: my $response=&reply('autocrsreqchecks:'.$dom,$homeserver);
8306: unless ($response =~ /(con_lost|error|no_such_host|refused)/) {
8307: my @items = split(/&/,$response);
8308: foreach my $item (@items) {
8309: my ($key,$value) = split('=',$item);
8310: $validations{&unescape($key)} = &thaw_unescape($value);
8311: }
8312: }
8313: }
8314: return %validations;
8315: }
8316:
8317: sub auto_courserequest_validation {
8318: my ($dom,$owner,$crstype,$inststatuslist,$instcode,$instseclist,$custominfo) = @_;
8319: my ($homeserver,$response);
8320: if ($dom =~ /^$match_domain$/) {
8321: $homeserver = &domain($dom,'primary');
8322: }
8323: unless ($homeserver eq 'no_host') {
8324: my $customdata;
8325: if (ref($custominfo) eq 'HASH') {
8326: $customdata = &freeze_escape($custominfo);
8327: }
8328: $response=&unescape(&reply('autocrsreqvalidation:'.$dom.':'.&escape($owner).
8329: ':'.&escape($crstype).':'.&escape($inststatuslist).
8330: ':'.&escape($instcode).':'.&escape($instseclist).':'.
8331: $customdata,$homeserver));
8332: }
8333: return $response;
8334: }
8335:
8336: sub auto_validate_class_sec {
8337: my ($cdom,$cnum,$owners,$inst_class) = @_;
8338: my $homeserver = &homeserver($cnum,$cdom);
8339: my $ownerlist;
8340: if (ref($owners) eq 'ARRAY') {
8341: $ownerlist = join(',',@{$owners});
8342: } else {
8343: $ownerlist = $owners;
8344: }
8345: my $response=&reply('autovalidateclass_sec:'.$inst_class.':'.
8346: &escape($ownerlist).':'.$cdom,$homeserver);
8347: return $response;
8348: }
8349:
8350: sub auto_crsreq_update {
8351: my ($cdom,$cnum,$crstype,$action,$ownername,$ownerdomain,$fullname,$title,
8352: $code,$accessstart,$accessend,$inbound) = @_;
8353: my ($homeserver,%crsreqresponse);
8354: if ($cdom =~ /^$match_domain$/) {
8355: $homeserver = &domain($cdom,'primary');
8356: }
8357: unless (($homeserver eq 'no_host') || ($homeserver eq '')) {
8358: my $info;
8359: if (ref($inbound) eq 'HASH') {
8360: $info = &freeze_escape($inbound);
8361: }
8362: my $response=&reply('autocrsrequpdate:'.$cdom.':'.$cnum.':'.&escape($crstype).
8363: ':'.&escape($action).':'.&escape($ownername).':'.
8364: &escape($ownerdomain).':'.&escape($fullname).':'.
8365: &escape($title).':'.&escape($code).':'.
8366: &escape($accessstart).':'.&escape($accessend).':'.$info,
8367: $homeserver);
8368: unless ($response =~ /(con_lost|error|no_such_host|refused)/) {
8369: my @items = split(/&/,$response);
8370: foreach my $item (@items) {
8371: my ($key,$value) = split('=',$item);
8372: $crsreqresponse{&unescape($key)} = &thaw_unescape($value);
8373: }
8374: }
8375: }
8376: return \%crsreqresponse;
8377: }
8378:
8379: sub auto_export_grades {
8380: my ($cdom,$cnum,$inforef,$gradesref) = @_;
8381: my ($homeserver,%exportresponse);
8382: if ($cdom =~ /^$match_domain$/) {
8383: $homeserver = &domain($cdom,'primary');
8384: }
8385: unless (($homeserver eq 'no_host') || ($homeserver eq '')) {
8386: my $info;
8387: if (ref($inforef) eq 'HASH') {
8388: $info = &freeze_escape($inforef);
8389: }
8390: if (ref($gradesref) eq 'HASH') {
8391: my $grades = &freeze_escape($gradesref);
8392: my $response=&reply('encrypt:autoexportgrades:'.$cdom.':'.$cnum.':'.
8393: $info.':'.$grades,$homeserver);
8394: unless ($response =~ /(con_lost|error|no_such_host|refused|unknown_command)/) {
8395: my @items = split(/&/,$response);
8396: foreach my $item (@items) {
8397: my ($key,$value) = split('=',$item);
8398: $exportresponse{&unescape($key)} = &thaw_unescape($value);
8399: }
8400: }
8401: }
8402: }
8403: return \%exportresponse;
8404: }
8405:
8406: sub check_instcode_cloning {
8407: my ($codedefaults,$code_order,$cloner,$clonefromcode,$clonetocode) = @_;
8408: unless ((ref($codedefaults) eq 'HASH') && (ref($code_order) eq 'ARRAY')) {
8409: return;
8410: }
8411: my $canclone;
8412: if (@{$code_order} > 0) {
8413: my $instcoderegexp ='^';
8414: my @clonecodes = split(/\&/,$cloner);
8415: foreach my $item (@{$code_order}) {
8416: if (grep(/^\Q$item\E=/,@clonecodes)) {
8417: foreach my $pair (@clonecodes) {
8418: my ($key,$val) = split(/\=/,$pair,2);
8419: $val = &unescape($val);
8420: if ($key eq $item) {
8421: $instcoderegexp .= '('.$val.')';
8422: last;
8423: }
8424: }
8425: } else {
8426: $instcoderegexp .= $codedefaults->{$item};
8427: }
8428: }
8429: $instcoderegexp .= '$';
8430: my (@from,@to);
8431: eval {
8432: (@from) = ($clonefromcode =~ /$instcoderegexp/);
8433: (@to) = ($clonetocode =~ /$instcoderegexp/);
8434: };
8435: if ((@from > 0) && (@to > 0)) {
8436: my @diffs = &Apache::loncommon::compare_arrays(\@from,\@to);
8437: if (!@diffs) {
8438: $canclone = 1;
8439: }
8440: }
8441: }
8442: return $canclone;
8443: }
8444:
8445: sub default_instcode_cloning {
8446: my ($clonedom,$domdefclone,$clonefromcode,$clonetocode,$codedefaultsref,$codeorderref) = @_;
8447: my (%codedefaults,@code_order,$canclone);
8448: if ((ref($codedefaultsref) eq 'HASH') && (ref($codeorderref) eq 'ARRAY')) {
8449: %codedefaults = %{$codedefaultsref};
8450: @code_order = @{$codeorderref};
8451: } elsif ($clonedom) {
8452: &auto_instcode_defaults($clonedom,\%codedefaults,\@code_order);
8453: }
8454: if (($domdefclone) && (@code_order)) {
8455: my @clonecodes = split(/\+/,$domdefclone);
8456: my $instcoderegexp ='^';
8457: foreach my $item (@code_order) {
8458: if (grep(/^\Q$item\E$/,@clonecodes)) {
8459: $instcoderegexp .= '('.$codedefaults{$item}.')';
8460: } else {
8461: $instcoderegexp .= $codedefaults{$item};
8462: }
8463: }
8464: $instcoderegexp .= '$';
8465: my (@from,@to);
8466: eval {
8467: (@from) = ($clonefromcode =~ /$instcoderegexp/);
8468: (@to) = ($clonetocode =~ /$instcoderegexp/);
8469: };
8470: if ((@from > 0) && (@to > 0)) {
8471: my @diffs = &Apache::loncommon::compare_arrays(\@from,\@to);
8472: if (!@diffs) {
8473: $canclone = 1;
8474: }
8475: }
8476: }
8477: return $canclone;
8478: }
8479:
8480: # ------------------------------------------------------- Course Group routines
8481:
8482: sub get_coursegroups {
8483: my ($cdom,$cnum,$group,$namespace) = @_;
8484: return(&dump($namespace,$cdom,$cnum,$group));
8485: }
8486:
8487: sub modify_coursegroup {
8488: my ($cdom,$cnum,$groupsettings) = @_;
8489: return(&put('coursegroups',$groupsettings,$cdom,$cnum));
8490: }
8491:
8492: sub toggle_coursegroup_status {
8493: my ($cdom,$cnum,$group,$action) = @_;
8494: my ($from_namespace,$to_namespace);
8495: if ($action eq 'delete') {
8496: $from_namespace = 'coursegroups';
8497: $to_namespace = 'deleted_groups';
8498: } else {
8499: $from_namespace = 'deleted_groups';
8500: $to_namespace = 'coursegroups';
8501: }
8502: my %curr_group = &get_coursegroups($cdom,$cnum,$group,$from_namespace);
8503: if (my $tmp = &error(%curr_group)) {
8504: &Apache::lonnet::logthis('Error retrieving group: '.$tmp.' in '.$cnum.':'.$cdom);
8505: return ('read error',$tmp);
8506: } else {
8507: my %savedsettings = %curr_group;
8508: my $result = &put($to_namespace,\%savedsettings,$cdom,$cnum);
8509: my $deloutcome;
8510: if ($result eq 'ok') {
8511: $deloutcome = &del($from_namespace,[$group],$cdom,$cnum);
8512: } else {
8513: return ('write error',$result);
8514: }
8515: if ($deloutcome eq 'ok') {
8516: return 'ok';
8517: } else {
8518: return ('delete error',$deloutcome);
8519: }
8520: }
8521: }
8522:
8523: sub modify_group_roles {
8524: my ($cdom,$cnum,$group_id,$user,$end,$start,$userprivs,$selfenroll,$context) = @_;
8525: my $url = '/'.$cdom.'/'.$cnum.'/'.$group_id;
8526: my $role = 'gr/'.&escape($userprivs);
8527: my ($uname,$udom) = split(/:/,$user);
8528: my $result = &assignrole($udom,$uname,$url,$role,$end,$start,'',$selfenroll,$context);
8529: if ($result eq 'ok') {
8530: &devalidate_getgroups_cache($udom,$uname,$cdom,$cnum);
8531: }
8532: return $result;
8533: }
8534:
8535: sub modify_coursegroup_membership {
8536: my ($cdom,$cnum,$membership) = @_;
8537: my $result = &put('groupmembership',$membership,$cdom,$cnum);
8538: return $result;
8539: }
8540:
8541: sub get_active_groups {
8542: my ($udom,$uname,$cdom,$cnum) = @_;
8543: my $now = time;
8544: my %groups = ();
8545: foreach my $key (keys(%env)) {
8546: if ($key =~ m-user\.role\.gr\./($match_domain)/($match_courseid)/(\w+)$-) {
8547: my ($start,$end) = split(/\./,$env{$key});
8548: if (($end!=0) && ($end<$now)) { next; }
8549: if (($start!=0) && ($start>$now)) { next; }
8550: if ($1 eq $cdom && $2 eq $cnum) {
8551: $groups{$3} = $env{$key} ;
8552: }
8553: }
8554: }
8555: return %groups;
8556: }
8557:
8558: sub get_group_membership {
8559: my ($cdom,$cnum,$group) = @_;
8560: return(&dump('groupmembership',$cdom,$cnum,$group));
8561: }
8562:
8563: sub get_users_groups {
8564: my ($udom,$uname,$courseid) = @_;
8565: my @usersgroups;
8566: my $cachetime=1800;
8567:
8568: my $hashid="$udom:$uname:$courseid";
8569: my ($grouplist,$cached)=&is_cached_new('getgroups',$hashid);
8570: if (defined($cached)) {
8571: @usersgroups = split(/:/,$grouplist);
8572: } else {
8573: $grouplist = '';
8574: my $courseurl = &courseid_to_courseurl($courseid);
8575: my %roleshash = &dump('roles',$udom,$uname,$courseurl);
8576: my $access_end = $env{'course.'.$courseid.
8577: '.default_enrollment_end_date'};
8578: my $now = time;
8579: foreach my $key (keys(%roleshash)) {
8580: if ($key =~ /^\Q$courseurl\E\/(\w+)\_gr$/) {
8581: my $group = $1;
8582: if ($roleshash{$key} =~ /_(\d+)_(\d+)$/) {
8583: my $start = $2;
8584: my $end = $1;
8585: if ($start == -1) { next; } # deleted from group
8586: if (($start!=0) && ($start>$now)) { next; }
8587: if (($end!=0) && ($end<$now)) {
8588: if ($access_end && $access_end < $now) {
8589: if ($access_end - $end < 86400) {
8590: push(@usersgroups,$group);
8591: }
8592: }
8593: next;
8594: }
8595: push(@usersgroups,$group);
8596: }
8597: }
8598: }
8599: @usersgroups = &sort_course_groups($courseid,@usersgroups);
8600: $grouplist = join(':',@usersgroups);
8601: &do_cache_new('getgroups',$hashid,$grouplist,$cachetime);
8602: }
8603: return @usersgroups;
8604: }
8605:
8606: sub devalidate_getgroups_cache {
8607: my ($udom,$uname,$cdom,$cnum)=@_;
8608: my $courseid = $cdom.'_'.$cnum;
8609:
8610: my $hashid="$udom:$uname:$courseid";
8611: &devalidate_cache_new('getgroups',$hashid);
8612: }
8613:
8614: # ------------------------------------------------------------------ Plain Text
8615:
8616: sub plaintext {
8617: my ($short,$type,$cid,$forcedefault) = @_;
8618: if ($short =~ m{^cr/}) {
8619: return (split('/',$short))[-1];
8620: }
8621: if (!defined($cid)) {
8622: $cid = $env{'request.course.id'};
8623: }
8624: my %rolenames = (
8625: Course => 'std',
8626: Community => 'alt1',
8627: Placement => 'std',
8628: );
8629: if ($cid ne '') {
8630: if ($env{'course.'.$cid.'.'.$short.'.plaintext'} ne '') {
8631: unless ($forcedefault) {
8632: my $roletext = $env{'course.'.$cid.'.'.$short.'.plaintext'};
8633: &Apache::lonlocal::mt_escape(\$roletext);
8634: return &Apache::lonlocal::mt($roletext);
8635: }
8636: }
8637: }
8638: if ((defined($type)) && (defined($rolenames{$type})) &&
8639: (defined($rolenames{$type})) &&
8640: (defined($prp{$short}{$rolenames{$type}}))) {
8641: return &Apache::lonlocal::mt($prp{$short}{$rolenames{$type}});
8642: } elsif ($cid ne '') {
8643: my $crstype = $env{'course.'.$cid.'.type'};
8644: if (($crstype ne '') && (defined($rolenames{$crstype})) &&
8645: (defined($prp{$short}{$rolenames{$crstype}}))) {
8646: return &Apache::lonlocal::mt($prp{$short}{$rolenames{$crstype}});
8647: }
8648: }
8649: return &Apache::lonlocal::mt($prp{$short}{'std'});
8650: }
8651:
8652: # ----------------------------------------------------------------- Assign Role
8653:
8654: sub assignrole {
8655: my ($udom,$uname,$url,$role,$end,$start,$deleteflag,$selfenroll,
8656: $context)=@_;
8657: my $mrole;
8658: if ($role =~ /^cr\//) {
8659: my $cwosec=$url;
8660: $cwosec=~s/^\/($match_domain)\/($match_courseid)\/.*/$1\/$2/;
8661: unless (&allowed('ccr',$cwosec)) {
8662: my $refused = 1;
8663: if ($context eq 'requestcourses') {
8664: if (($env{'user.name'} ne '') && ($env{'user.domain'} ne '')) {
8665: if ($role =~ m{^cr/($match_domain)/($match_username)/([^/]+)$}) {
8666: if (($1 eq $env{'user.domain'}) && ($2 eq $env{'user.name'})) {
8667: my ($cdom,$cnum) = ($cwosec =~ m{^/?($match_domain)/($match_courseid)$});
8668: my %crsenv = &userenvironment($cdom,$cnum,('internal.courseowner'));
8669: if ($crsenv{'internal.courseowner'} eq
8670: $env{'user.name'}.':'.$env{'user.domain'}) {
8671: $refused = '';
8672: }
8673: }
8674: }
8675: }
8676: }
8677: if ($refused) {
8678: &logthis('Refused custom assignrole: '.
8679: $udom.' '.$uname.' '.$url.' '.$role.' '.$end.' '.$start.
8680: ' by '.$env{'user.name'}.' at '.$env{'user.domain'});
8681: return 'refused';
8682: }
8683: }
8684: $mrole='cr';
8685: } elsif ($role =~ /^gr\//) {
8686: my $cwogrp=$url;
8687: $cwogrp=~s{^/($match_domain)/($match_courseid)/.*}{$1/$2};
8688: unless (&allowed('mdg',$cwogrp)) {
8689: &logthis('Refused group assignrole: '.
8690: $udom.' '.$uname.' '.$url.' '.$role.' '.$end.' '.$start.' by '.
8691: $env{'user.name'}.' at '.$env{'user.domain'});
8692: return 'refused';
8693: }
8694: $mrole='gr';
8695: } else {
8696: my $cwosec=$url;
8697: $cwosec=~s/^\/($match_domain)\/($match_courseid)\/.*/$1\/$2/;
8698: if (!(&allowed('c'.$role,$cwosec)) && !(&allowed('c'.$role,$udom))) {
8699: my $refused;
8700: if (($env{'request.course.sec'} ne '') && ($role eq 'st')) {
8701: if (!(&allowed('c'.$role,$url))) {
8702: $refused = 1;
8703: }
8704: } else {
8705: $refused = 1;
8706: }
8707: if ($refused) {
8708: my ($cdom,$cnum) = ($cwosec =~ m{^/?($match_domain)/($match_courseid)$});
8709: if (!$selfenroll && $context eq 'course') {
8710: my %crsenv;
8711: if ($role eq 'cc' || $role eq 'co') {
8712: %crsenv = &userenvironment($cdom,$cnum,('internal.courseowner'));
8713: if (($role eq 'cc') && ($cnum !~ /^$match_community$/)) {
8714: if ($env{'request.role'} eq 'cc./'.$cdom.'/'.$cnum) {
8715: if ($crsenv{'internal.courseowner'} eq
8716: $env{'user.name'}.':'.$env{'user.domain'}) {
8717: $refused = '';
8718: }
8719: }
8720: } elsif (($role eq 'co') && ($cnum =~ /^$match_community$/)) {
8721: if ($env{'request.role'} eq 'co./'.$cdom.'/'.$cnum) {
8722: if ($crsenv{'internal.courseowner'} eq
8723: $env{'user.name'}.':'.$env{'user.domain'}) {
8724: $refused = '';
8725: }
8726: }
8727: }
8728: }
8729: } elsif (($selfenroll == 1) && ($role eq 'st') && ($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'})) {
8730: $refused = '';
8731: } elsif ($context eq 'requestcourses') {
8732: my @possroles = ('st','ta','ep','in','cc','co');
8733: if ((grep(/^\Q$role\E$/,@possroles)) && ($env{'user.name'} ne '' && $env{'user.domain'} ne '')) {
8734: my $wrongcc;
8735: if ($cnum =~ /^$match_community$/) {
8736: $wrongcc = 1 if ($role eq 'cc');
8737: } else {
8738: $wrongcc = 1 if ($role eq 'co');
8739: }
8740: unless ($wrongcc) {
8741: my %crsenv = &userenvironment($cdom,$cnum,('internal.courseowner'));
8742: if ($crsenv{'internal.courseowner'} eq
8743: $env{'user.name'}.':'.$env{'user.domain'}) {
8744: $refused = '';
8745: }
8746: }
8747: }
8748: } elsif ($context eq 'requestauthor') {
8749: if (($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'}) &&
8750: ($url eq '/'.$udom.'/') && ($role eq 'au')) {
8751: if ($env{'environment.requestauthor'} eq 'automatic') {
8752: $refused = '';
8753: } else {
8754: my %domdefaults = &get_domain_defaults($udom);
8755: if (ref($domdefaults{'requestauthor'}) eq 'HASH') {
8756: my $checkbystatus;
8757: if ($env{'user.adv'}) {
8758: my $disposition = $domdefaults{'requestauthor'}{'_LC_adv'};
8759: if ($disposition eq 'automatic') {
8760: $refused = '';
8761: } elsif ($disposition eq '') {
8762: $checkbystatus = 1;
8763: }
8764: } else {
8765: $checkbystatus = 1;
8766: }
8767: if ($checkbystatus) {
8768: if ($env{'environment.inststatus'}) {
8769: my @inststatuses = split(/,/,$env{'environment.inststatus'});
8770: foreach my $type (@inststatuses) {
8771: if (($type ne '') &&
8772: ($domdefaults{'requestauthor'}{$type} eq 'automatic')) {
8773: $refused = '';
8774: }
8775: }
8776: } elsif ($domdefaults{'requestauthor'}{'default'} eq 'automatic') {
8777: $refused = '';
8778: }
8779: }
8780: }
8781: }
8782: }
8783: }
8784: if ($refused) {
8785: &logthis('Refused assignrole: '.$udom.' '.$uname.' '.$url.
8786: ' '.$role.' '.$end.' '.$start.' by '.
8787: $env{'user.name'}.' at '.$env{'user.domain'});
8788: return 'refused';
8789: }
8790: }
8791: } elsif ($role eq 'au') {
8792: if ($url ne '/'.$udom.'/') {
8793: &logthis('Attempt by '.$env{'user.name'}.':'.$env{'user.domain'}.
8794: ' to assign author role for '.$uname.':'.$udom.
8795: ' in domain: '.$url.' refused (wrong domain).');
8796: return 'refused';
8797: }
8798: }
8799: $mrole=$role;
8800: }
8801: my $command="encrypt:rolesput:$env{'user.domain'}:$env{'user.name'}:".
8802: "$udom:$uname:$url".'_'."$mrole=$role";
8803: if ($end) { $command.='_'.$end; }
8804: if ($start) {
8805: if ($end) {
8806: $command.='_'.$start;
8807: } else {
8808: $command.='_0_'.$start;
8809: }
8810: }
8811: my $origstart = $start;
8812: my $origend = $end;
8813: my $delflag;
8814: # actually delete
8815: if ($deleteflag) {
8816: if ((&allowed('dro',$udom)) || (&allowed('dro',$url))) {
8817: # modify command to delete the role
8818: $command="encrypt:rolesdel:$env{'user.domain'}:$env{'user.name'}:".
8819: "$udom:$uname:$url".'_'."$mrole";
8820: &logthis("$env{'user.name'} at $env{'user.domain'} deletes $mrole in $url for $uname at $udom");
8821: # set start and finish to negative values for userrolelog
8822: $start=-1;
8823: $end=-1;
8824: $delflag = 1;
8825: }
8826: }
8827: # send command
8828: my $answer=&reply($command,&homeserver($uname,$udom));
8829: # log new user role if status is ok
8830: if ($answer eq 'ok') {
8831: &userrolelog($role,$uname,$udom,$url,$start,$end);
8832: if (($role eq 'cc') || ($role eq 'in') ||
8833: ($role eq 'ep') || ($role eq 'ad') ||
8834: ($role eq 'ta') || ($role eq 'st') ||
8835: ($role=~/^cr/) || ($role eq 'gr') ||
8836: ($role eq 'co')) {
8837: # for course roles, perform group memberships changes triggered by role change.
8838: unless ($role =~ /^gr/) {
8839: &Apache::longroup::group_changes($udom,$uname,$url,$role,$origend,
8840: $origstart,$selfenroll,$context);
8841: }
8842: &courserolelog($role,$uname,$udom,$url,$origstart,$origend,$delflag,
8843: $selfenroll,$context);
8844: } elsif (($role eq 'li') || ($role eq 'dg') || ($role eq 'sc') ||
8845: ($role eq 'au') || ($role eq 'dc')) {
8846: &domainrolelog($role,$uname,$udom,$url,$origstart,$origend,$delflag,
8847: $context);
8848: } elsif (($role eq 'ca') || ($role eq 'aa')) {
8849: &coauthorrolelog($role,$uname,$udom,$url,$origstart,$origend,$delflag,
8850: $context);
8851: }
8852: if ($role eq 'cc') {
8853: &autoupdate_coowners($url,$end,$start,$uname,$udom);
8854: }
8855: }
8856: return $answer;
8857: }
8858:
8859: sub autoupdate_coowners {
8860: my ($url,$end,$start,$uname,$udom) = @_;
8861: my ($cdom,$cnum) = ($url =~ m{^/($match_domain)/($match_courseid)});
8862: if (($cdom ne '') && ($cnum ne '')) {
8863: my $now = time;
8864: my %domdesign = &Apache::loncommon::get_domainconf($cdom);
8865: if ($domdesign{$cdom.'.autoassign.co-owners'}) {
8866: my %coursehash = &coursedescription($cdom.'_'.$cnum);
8867: my $instcode = $coursehash{'internal.coursecode'};
8868: if ($instcode ne '') {
8869: if (($start && $start <= $now) && ($end == 0) || ($end > $now)) {
8870: unless ($coursehash{'internal.courseowner'} eq $uname.':'.$udom) {
8871: my ($delcoowners,@newcoowners,$putresult,$delresult,$coowners);
8872: my ($result,$desc) = &auto_validate_instcode($cnum,$cdom,$instcode,$uname.':'.$udom);
8873: if ($result eq 'valid') {
8874: if ($coursehash{'internal.co-owners'}) {
8875: foreach my $coowner (split(',',$coursehash{'internal.co-owners'})) {
8876: push(@newcoowners,$coowner);
8877: }
8878: unless (grep(/^\Q$uname\E:\Q$udom\E$/,@newcoowners)) {
8879: push(@newcoowners,$uname.':'.$udom);
8880: }
8881: @newcoowners = sort(@newcoowners);
8882: } else {
8883: push(@newcoowners,$uname.':'.$udom);
8884: }
8885: } else {
8886: if ($coursehash{'internal.co-owners'}) {
8887: foreach my $coowner (split(',',$coursehash{'internal.co-owners'})) {
8888: unless ($coowner eq $uname.':'.$udom) {
8889: push(@newcoowners,$coowner);
8890: }
8891: }
8892: unless (@newcoowners > 0) {
8893: $delcoowners = 1;
8894: $coowners = '';
8895: }
8896: }
8897: }
8898: if (@newcoowners || $delcoowners) {
8899: &store_coowners($cdom,$cnum,$coursehash{'home'},
8900: $delcoowners,@newcoowners);
8901: }
8902: }
8903: }
8904: }
8905: }
8906: }
8907: }
8908:
8909: sub store_coowners {
8910: my ($cdom,$cnum,$chome,$delcoowners,@newcoowners) = @_;
8911: my $cid = $cdom.'_'.$cnum;
8912: my ($coowners,$delresult,$putresult);
8913: if (@newcoowners) {
8914: $coowners = join(',',@newcoowners);
8915: my %coownershash = (
8916: 'internal.co-owners' => $coowners,
8917: );
8918: $putresult = &put('environment',\%coownershash,$cdom,$cnum);
8919: if ($putresult eq 'ok') {
8920: if ($env{'course.'.$cid.'.num'} eq $cnum) {
8921: &appenv({'course.'.$cid.'.internal.co-owners' => $coowners});
8922: }
8923: }
8924: }
8925: if ($delcoowners) {
8926: $delresult = &Apache::lonnet::del('environment',['internal.co-owners'],$cdom,$cnum);
8927: if ($delresult eq 'ok') {
8928: if ($env{'course.'.$cid.'.internal.co-owners'}) {
8929: &Apache::lonnet::delenv('course.'.$cid.'.internal.co-owners');
8930: }
8931: }
8932: }
8933: if (($putresult eq 'ok') || ($delresult eq 'ok')) {
8934: my %crsinfo =
8935: &Apache::lonnet::courseiddump($cdom,'.',1,'.','.',$cnum,undef,undef,'.');
8936: if (ref($crsinfo{$cid}) eq 'HASH') {
8937: $crsinfo{$cid}{'co-owners'} = \@newcoowners;
8938: my $cidput = &Apache::lonnet::courseidput($cdom,\%crsinfo,$chome,'notime');
8939: }
8940: }
8941: }
8942:
8943: # -------------------------------------------------- Modify user authentication
8944: # Overrides without validation
8945:
8946: sub modifyuserauth {
8947: my ($udom,$uname,$umode,$upass)=@_;
8948: my $uhome=&homeserver($uname,$udom);
8949: unless (&allowed('mau',$udom)) { return 'refused'; }
8950: &logthis('Call to modify user authentication '.$udom.', '.$uname.', '.
8951: $umode.' by '.$env{'user.name'}.' at '.$env{'user.domain'}.
8952: ' in domain '.$env{'request.role.domain'});
8953: my $reply=&reply('encrypt:changeuserauth:'.$udom.':'.$uname.':'.$umode.':'.
8954: &escape($upass),$uhome);
8955: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},
8956: 'Authentication changed for '.$udom.', '.$uname.', '.$umode.
8957: '(Remote '.$ENV{'REMOTE_ADDR'}.'): '.$reply);
8958: &log($udom,,$uname,$uhome,
8959: 'Authentication changed by '.$env{'user.domain'}.', '.
8960: $env{'user.name'}.', '.$umode.
8961: '(Remote '.$ENV{'REMOTE_ADDR'}.'): '.$reply);
8962: unless ($reply eq 'ok') {
8963: &logthis('Authentication mode error: '.$reply);
8964: return 'error: '.$reply;
8965: }
8966: return 'ok';
8967: }
8968:
8969: # --------------------------------------------------------------- Modify a user
8970:
8971: sub modifyuser {
8972: my ($udom, $uname, $uid,
8973: $umode, $upass, $first,
8974: $middle, $last, $gene,
8975: $forceid, $desiredhome, $email, $inststatus, $candelete)=@_;
8976: $udom= &LONCAPA::clean_domain($udom);
8977: $uname=&LONCAPA::clean_username($uname);
8978: my $showcandelete = 'none';
8979: if (ref($candelete) eq 'ARRAY') {
8980: if (@{$candelete} > 0) {
8981: $showcandelete = join(', ',@{$candelete});
8982: }
8983: }
8984: &logthis('Call to modify user '.$udom.', '.$uname.', '.$uid.', '.
8985: $umode.', '.$first.', '.$middle.', '.
8986: $last.', '.$gene.'(forceid: '.$forceid.'; candelete: '.$showcandelete.')'.
8987: (defined($desiredhome) ? ' desiredhome = '.$desiredhome :
8988: ' desiredhome not specified').
8989: ' by '.$env{'user.name'}.' at '.$env{'user.domain'}.
8990: ' in domain '.$env{'request.role.domain'});
8991: my $uhome=&homeserver($uname,$udom,'true');
8992: my $newuser;
8993: if ($uhome eq 'no_host') {
8994: $newuser = 1;
8995: }
8996: # ----------------------------------------------------------------- Create User
8997: if (($uhome eq 'no_host') &&
8998: (($umode && $upass) || ($umode eq 'localauth'))) {
8999: my $unhome='';
9000: if (defined($desiredhome) && &host_domain($desiredhome) eq $udom) {
9001: $unhome = $desiredhome;
9002: } elsif($env{'course.'.$env{'request.course.id'}.'.domain'} eq $udom) {
9003: $unhome=$env{'course.'.$env{'request.course.id'}.'.home'};
9004: } else { # load balancing routine for determining $unhome
9005: my $loadm=10000000;
9006: my %servers = &get_servers($udom,'library');
9007: foreach my $tryserver (keys(%servers)) {
9008: my $answer=reply('load',$tryserver);
9009: if (($answer=~/\d+/) && ($answer<$loadm)) {
9010: $loadm=$answer;
9011: $unhome=$tryserver;
9012: }
9013: }
9014: }
9015: if (($unhome eq '') || ($unhome eq 'no_host')) {
9016: return 'error: unable to find a home server for '.$uname.
9017: ' in domain '.$udom;
9018: }
9019: my $reply=&reply('encrypt:makeuser:'.$udom.':'.$uname.':'.$umode.':'.
9020: &escape($upass),$unhome);
9021: unless ($reply eq 'ok') {
9022: return 'error: '.$reply;
9023: }
9024: $uhome=&homeserver($uname,$udom,'true');
9025: if (($uhome eq '') || ($uhome eq 'no_host') || ($uhome ne $unhome)) {
9026: return 'error: unable verify users home machine.';
9027: }
9028: } # End of creation of new user
9029: # ---------------------------------------------------------------------- Add ID
9030: if ($uid) {
9031: $uid=~tr/A-Z/a-z/;
9032: my %uidhash=&idrget($udom,$uname);
9033: if (($uidhash{$uname}) && ($uidhash{$uname}!~/error\:/)
9034: && (!$forceid)) {
9035: unless ($uid eq $uidhash{$uname}) {
9036: return 'error: user id "'.$uid.'" does not match '.
9037: 'current user id "'.$uidhash{$uname}.'".';
9038: }
9039: } else {
9040: &idput($udom,{$uname => $uid},$uhome,'ids');
9041: }
9042: }
9043: # -------------------------------------------------------------- Add names, etc
9044: my @tmp=&get('environment',
9045: ['firstname','middlename','lastname','generation','id',
9046: 'permanentemail','inststatus'],
9047: $udom,$uname);
9048: my (%names,%oldnames);
9049: if ($tmp[0] =~ m/^error:.*/) {
9050: %names=();
9051: } else {
9052: %names = @tmp;
9053: %oldnames = %names;
9054: }
9055: #
9056: # If name, email and/or uid are blank (e.g., because an uploaded file
9057: # of users did not contain them), do not overwrite existing values
9058: # unless field is in $candelete array ref.
9059: #
9060:
9061: my @fields = ('firstname','middlename','lastname','generation',
9062: 'permanentemail','id');
9063: my %newvalues;
9064: if (ref($candelete) eq 'ARRAY') {
9065: foreach my $field (@fields) {
9066: if (grep(/^\Q$field\E$/,@{$candelete})) {
9067: if ($field eq 'firstname') {
9068: $names{$field} = $first;
9069: } elsif ($field eq 'middlename') {
9070: $names{$field} = $middle;
9071: } elsif ($field eq 'lastname') {
9072: $names{$field} = $last;
9073: } elsif ($field eq 'generation') {
9074: $names{$field} = $gene;
9075: } elsif ($field eq 'permanentemail') {
9076: $names{$field} = $email;
9077: } elsif ($field eq 'id') {
9078: $names{$field} = $uid;
9079: }
9080: }
9081: }
9082: }
9083: if ($first) { $names{'firstname'} = $first; }
9084: if (defined($middle)) { $names{'middlename'} = $middle; }
9085: if ($last) { $names{'lastname'} = $last; }
9086: if (defined($gene)) { $names{'generation'} = $gene; }
9087: if ($email) {
9088: $email=~s/[^\w\@\.\-\,]//gs;
9089: if ($email=~/\@/) { $names{'permanentemail'} = $email; }
9090: }
9091: if ($uid) { $names{'id'} = $uid; }
9092: if (defined($inststatus)) {
9093: $names{'inststatus'} = '';
9094: my ($usertypes,$typesorder) = &retrieve_inst_usertypes($udom);
9095: if (ref($usertypes) eq 'HASH') {
9096: my @okstatuses;
9097: foreach my $item (split(/:/,$inststatus)) {
9098: if (defined($usertypes->{$item})) {
9099: push(@okstatuses,$item);
9100: }
9101: }
9102: if (@okstatuses) {
9103: $names{'inststatus'} = join(':', map { &escape($_); } @okstatuses);
9104: }
9105: }
9106: }
9107: my $logmsg = $udom.', '.$uname.', '.$uid.', '.
9108: $umode.', '.$first.', '.$middle.', '.
9109: $last.', '.$gene.', '.$email.', '.$inststatus;
9110: if ($env{'user.name'} ne '' && $env{'user.domain'}) {
9111: $logmsg .= ' by '.$env{'user.name'}.' at '.$env{'user.domain'};
9112: } else {
9113: $logmsg .= ' during self creation';
9114: }
9115: my $changed;
9116: if ($newuser) {
9117: $changed = 1;
9118: } else {
9119: foreach my $field (@fields) {
9120: if ($names{$field} ne $oldnames{$field}) {
9121: $changed = 1;
9122: last;
9123: }
9124: }
9125: }
9126: unless ($changed) {
9127: $logmsg = 'No changes in user information needed for: '.$logmsg;
9128: &logthis($logmsg);
9129: return 'ok';
9130: }
9131: my $reply = &put('environment', \%names, $udom,$uname);
9132: if ($reply ne 'ok') {
9133: return 'error: '.$reply;
9134: }
9135: if ($names{'permanentemail'} ne $oldnames{'permanentemail'}) {
9136: &Apache::lonnet::devalidate_cache_new('emailscache',$uname.':'.$udom);
9137: }
9138: my $sqlresult = &update_allusers_table($uname,$udom,\%names);
9139: &devalidate_cache_new('namescache',$uname.':'.$udom);
9140: $logmsg = 'Success modifying user '.$logmsg;
9141: &logthis($logmsg);
9142: return 'ok';
9143: }
9144:
9145: # -------------------------------------------------------------- Modify student
9146:
9147: sub modifystudent {
9148: my ($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene,$usec,
9149: $end,$start,$forceid,$desiredhome,$email,$type,$locktype,$cid,
9150: $selfenroll,$context,$inststatus,$credits,$instsec)=@_;
9151: if (!$cid) {
9152: unless ($cid=$env{'request.course.id'}) {
9153: return 'not_in_class';
9154: }
9155: }
9156: # --------------------------------------------------------------- Make the user
9157: my $reply=&modifyuser
9158: ($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene,$forceid,
9159: $desiredhome,$email,$inststatus);
9160: unless ($reply eq 'ok') { return $reply; }
9161: # This will cause &modify_student_enrollment to get the uid from the
9162: # student's environment
9163: $uid = undef if (!$forceid);
9164: $reply = &modify_student_enrollment($udom,$uname,$uid,$first,$middle,$last,
9165: $gene,$usec,$end,$start,$type,$locktype,
9166: $cid,$selfenroll,$context,$credits,$instsec);
9167: return $reply;
9168: }
9169:
9170: sub modify_student_enrollment {
9171: my ($udom,$uname,$uid,$first,$middle,$last,$gene,$usec,$end,$start,$type,
9172: $locktype,$cid,$selfenroll,$context,$credits,$instsec) = @_;
9173: my ($cdom,$cnum,$chome);
9174: if (!$cid) {
9175: unless ($cid=$env{'request.course.id'}) {
9176: return 'not_in_class';
9177: }
9178: $cdom=$env{'course.'.$cid.'.domain'};
9179: $cnum=$env{'course.'.$cid.'.num'};
9180: } else {
9181: ($cdom,$cnum)=split(/_/,$cid);
9182: }
9183: $chome=$env{'course.'.$cid.'.home'};
9184: if (!$chome) {
9185: $chome=&homeserver($cnum,$cdom);
9186: }
9187: if (!$chome) { return 'unknown_course'; }
9188: # Make sure the user exists
9189: my $uhome=&homeserver($uname,$udom);
9190: if (($uhome eq '') || ($uhome eq 'no_host')) {
9191: return 'error: no such user';
9192: }
9193: # Get student data if we were not given enough information
9194: if (!defined($first) || $first eq '' ||
9195: !defined($last) || $last eq '' ||
9196: !defined($uid) || $uid eq '' ||
9197: !defined($middle) || $middle eq '' ||
9198: !defined($gene) || $gene eq '') {
9199: # They did not supply us with enough data to enroll the student, so
9200: # we need to pick up more information.
9201: my %tmp = &get('environment',
9202: ['firstname','middlename','lastname', 'generation','id']
9203: ,$udom,$uname);
9204:
9205: #foreach my $key (keys(%tmp)) {
9206: # &logthis("key $key = ".$tmp{$key});
9207: #}
9208: $first = $tmp{'firstname'} if (!defined($first) || $first eq '');
9209: $middle = $tmp{'middlename'} if (!defined($middle) || $middle eq '');
9210: $last = $tmp{'lastname'} if (!defined($last) || $last eq '');
9211: $gene = $tmp{'generation'} if (!defined($gene) || $gene eq '');
9212: $uid = $tmp{'id'} if (!defined($uid) || $uid eq '');
9213: }
9214: my $fullname = &format_name($first,$middle,$last,$gene,'lastname');
9215: my $user = "$uname:$udom";
9216: my %old_entry = &Apache::lonnet::get('classlist',[$user],$cdom,$cnum);
9217: my $reply=cput('classlist',
9218: {$user =>
9219: join(':',$end,$start,$uid,$usec,$fullname,$type,$locktype,$credits,$instsec) },
9220: $cdom,$cnum);
9221: if (($reply eq 'ok') || ($reply eq 'delayed')) {
9222: &devalidate_getsection_cache($udom,$uname,$cid);
9223: } else {
9224: return 'error: '.$reply;
9225: }
9226: # Add student role to user
9227: my $uurl='/'.$cid;
9228: $uurl=~s/\_/\//g;
9229: if ($usec) {
9230: $uurl.='/'.$usec;
9231: }
9232: my $result = &assignrole($udom,$uname,$uurl,'st',$end,$start,undef,
9233: $selfenroll,$context);
9234: if ($result ne 'ok') {
9235: if ($old_entry{$user} ne '') {
9236: $reply = &cput('classlist',\%old_entry,$cdom,$cnum);
9237: } else {
9238: $reply = &del('classlist',[$user],$cdom,$cnum);
9239: }
9240: }
9241: return $result;
9242: }
9243:
9244: sub format_name {
9245: my ($firstname,$middlename,$lastname,$generation,$first)=@_;
9246: my $name;
9247: if ($first ne 'lastname') {
9248: $name=$firstname.' '.$middlename.' '.$lastname.' '.$generation;
9249: } else {
9250: if ($lastname=~/\S/) {
9251: $name.= $lastname.' '.$generation.', '.$firstname.' '.$middlename;
9252: $name=~s/\s+,/,/;
9253: } else {
9254: $name.= $firstname.' '.$middlename.' '.$generation;
9255: }
9256: }
9257: $name=~s/^\s+//;
9258: $name=~s/\s+$//;
9259: $name=~s/\s+/ /g;
9260: return $name;
9261: }
9262:
9263: # ------------------------------------------------- Write to course preferences
9264:
9265: sub writecoursepref {
9266: my ($courseid,%prefs)=@_;
9267: $courseid=~s/^\///;
9268: $courseid=~s/\_/\//g;
9269: my ($cdomain,$cnum)=split(/\//,$courseid);
9270: my $chome=homeserver($cnum,$cdomain);
9271: if (($chome eq '') || ($chome eq 'no_host')) {
9272: return 'error: no such course';
9273: }
9274: my $cstring='';
9275: foreach my $pref (keys(%prefs)) {
9276: $cstring.=&escape($pref).'='.&escape($prefs{$pref}).'&';
9277: }
9278: $cstring=~s/\&$//;
9279: return reply('put:'.$cdomain.':'.$cnum.':environment:'.$cstring,$chome);
9280: }
9281:
9282: # ---------------------------------------------------------- Make/modify course
9283:
9284: sub createcourse {
9285: my ($udom,$description,$url,$course_server,$nonstandard,$inst_code,
9286: $course_owner,$crstype,$cnum,$context,$category)=@_;
9287: $url=&declutter($url);
9288: my $cid='';
9289: if ($context eq 'requestcourses') {
9290: my $can_create = 0;
9291: my ($ownername,$ownerdom) = split(':',$course_owner);
9292: if ($udom eq $ownerdom) {
9293: if (&usertools_access($ownername,$ownerdom,$category,undef,
9294: $context)) {
9295: $can_create = 1;
9296: }
9297: } else {
9298: my %userenv = &userenvironment($ownerdom,$ownername,'reqcrsotherdom.'.
9299: $category);
9300: if ($userenv{'reqcrsotherdom.'.$category} ne '') {
9301: my @curr = split(',',$userenv{'reqcrsotherdom.'.$category});
9302: if (@curr > 0) {
9303: my @options = qw(approval validate autolimit);
9304: my $optregex = join('|',@options);
9305: if (grep(/^\Q$udom\E:($optregex)(=?\d*)$/,@curr)) {
9306: $can_create = 1;
9307: }
9308: }
9309: }
9310: }
9311: if ($can_create) {
9312: unless ($ownername eq $env{'user.name'} && $ownerdom eq $env{'user.domain'}) {
9313: unless (&allowed('ccc',$udom)) {
9314: return 'refused';
9315: }
9316: }
9317: } else {
9318: return 'refused';
9319: }
9320: } elsif (!&allowed('ccc',$udom)) {
9321: return 'refused';
9322: }
9323: # --------------------------------------------------------------- Get Unique ID
9324: my $uname;
9325: if ($cnum =~ /^$match_courseid$/) {
9326: my $chome=&homeserver($cnum,$udom,'true');
9327: if (($chome eq '') || ($chome eq 'no_host')) {
9328: $uname = $cnum;
9329: } else {
9330: $uname = &generate_coursenum($udom,$crstype);
9331: }
9332: } else {
9333: $uname = &generate_coursenum($udom,$crstype);
9334: }
9335: return $uname if ($uname =~ /^error/);
9336: # -------------------------------------------------- Check supplied server name
9337: if (!defined($course_server)) {
9338: if (defined(&domain($udom,'primary'))) {
9339: $course_server = &domain($udom,'primary');
9340: } else {
9341: $course_server = $env{'user.home'};
9342: }
9343: }
9344: my %host_servers =
9345: &Apache::lonnet::get_servers($udom,'library');
9346: unless ($host_servers{$course_server}) {
9347: return 'error: invalid home server for course: '.$course_server;
9348: }
9349: # ------------------------------------------------------------- Make the course
9350: my $reply=&reply('encrypt:makeuser:'.$udom.':'.$uname.':none::',
9351: $course_server);
9352: unless ($reply eq 'ok') { return 'error: '.$reply; }
9353: my $uhome=&homeserver($uname,$udom,'true');
9354: if (($uhome eq '') || ($uhome eq 'no_host')) {
9355: return 'error: no such course';
9356: }
9357: # ----------------------------------------------------------------- Course made
9358: # log existence
9359: my $now = time;
9360: my $newcourse = {
9361: $udom.'_'.$uname => {
9362: description => $description,
9363: inst_code => $inst_code,
9364: owner => $course_owner,
9365: type => $crstype,
9366: creator => $env{'user.name'}.':'.
9367: $env{'user.domain'},
9368: created => $now,
9369: context => $context,
9370: },
9371: };
9372: &courseidput($udom,$newcourse,$uhome,'notime');
9373: # set toplevel url
9374: my $topurl=$url;
9375: unless ($nonstandard) {
9376: # ------------------------------------------ For standard courses, make top url
9377: my $mapurl=&clutter($url);
9378: if ($mapurl eq '/res/') { $mapurl=''; }
9379: $env{'form.initmap'}=(<<ENDINITMAP);
9380: <map>
9381: <resource id="1" type="start"></resource>
9382: <resource id="2" src="$mapurl"></resource>
9383: <resource id="3" type="finish"></resource>
9384: <link index="1" from="1" to="2"></link>
9385: <link index="2" from="2" to="3"></link>
9386: </map>
9387: ENDINITMAP
9388: $topurl=&declutter(
9389: &finishuserfileupload($uname,$udom,'initmap','default.sequence')
9390: );
9391: }
9392: # ----------------------------------------------------------- Write preferences
9393: &writecoursepref($udom.'_'.$uname,
9394: ('description' => $description,
9395: 'url' => $topurl,
9396: 'internal.creator' => $env{'user.name'}.':'.
9397: $env{'user.domain'},
9398: 'internal.created' => $now,
9399: 'internal.creationcontext' => $context)
9400: );
9401: return '/'.$udom.'/'.$uname;
9402: }
9403:
9404: # ------------------------------------------------------------------- Create ID
9405: sub generate_coursenum {
9406: my ($udom,$crstype) = @_;
9407: my $domdesc = &domain($udom);
9408: return 'error: invalid domain' if ($domdesc eq '');
9409: my $first;
9410: if ($crstype eq 'Community') {
9411: $first = '0';
9412: } else {
9413: $first = int(1+rand(9));
9414: }
9415: my $uname=$first.
9416: ('a'..'z','A'..'Z','0'..'9')[int(rand(62))].
9417: substr($$.time,0,5).unpack("H8",pack("I32",time)).
9418: unpack("H2",pack("I32",int(rand(255)))).$perlvar{'lonHostID'};
9419: # ----------------------------------------------- Make sure that does not exist
9420: my $uhome=&homeserver($uname,$udom,'true');
9421: unless (($uhome eq '') || ($uhome eq 'no_host')) {
9422: if ($crstype eq 'Community') {
9423: $first = '0';
9424: } else {
9425: $first = int(1+rand(9));
9426: }
9427: $uname=$first.
9428: ('a'..'z','A'..'Z','0'..'9')[int(rand(62))].
9429: substr($$.time,0,5).unpack("H8",pack("I32",time)).
9430: unpack("H2",pack("I32",int(rand(255)))).$perlvar{'lonHostID'};
9431: $uhome=&homeserver($uname,$udom,'true');
9432: unless (($uhome eq '') || ($uhome eq 'no_host')) {
9433: return 'error: unable to generate unique course-ID';
9434: }
9435: }
9436: return $uname;
9437: }
9438:
9439: sub is_course {
9440: my ($cdom, $cnum) = scalar(@_) == 1 ?
9441: ($_[0] =~ /^($match_domain)_($match_courseid)$/) : @_;
9442:
9443: return unless $cdom and $cnum;
9444:
9445: my %courses = &courseiddump($cdom, '.', 1, '.', '.', $cnum, undef, undef,
9446: '.');
9447:
9448: return unless(exists($courses{$cdom.'_'.$cnum}));
9449: return wantarray ? ($cdom, $cnum) : $cdom.'_'.$cnum;
9450: }
9451:
9452: sub store_userdata {
9453: my ($storehash,$datakey,$namespace,$udom,$uname) = @_;
9454: my $result;
9455: if ($datakey ne '') {
9456: if (ref($storehash) eq 'HASH') {
9457: if ($udom eq '' || $uname eq '') {
9458: $udom = $env{'user.domain'};
9459: $uname = $env{'user.name'};
9460: }
9461: my $uhome=&homeserver($uname,$udom);
9462: if (($uhome eq '') || ($uhome eq 'no_host')) {
9463: $result = 'error: no_host';
9464: } else {
9465: $storehash->{'ip'} = $ENV{'REMOTE_ADDR'};
9466: $storehash->{'host'} = $perlvar{'lonHostID'};
9467:
9468: my $namevalue='';
9469: foreach my $key (keys(%{$storehash})) {
9470: $namevalue.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
9471: }
9472: $namevalue=~s/\&$//;
9473: unless ($namespace eq 'courserequests') {
9474: $datakey = &escape($datakey);
9475: }
9476: $result = &reply("store:$udom:$uname:$namespace:$datakey:".
9477: $namevalue,$uhome);
9478: }
9479: } else {
9480: $result = 'error: data to store was not a hash reference';
9481: }
9482: } else {
9483: $result= 'error: invalid requestkey';
9484: }
9485: return $result;
9486: }
9487:
9488: # ---------------------------------------------------------- Assign Custom Role
9489:
9490: sub assigncustomrole {
9491: my ($udom,$uname,$url,$rdom,$rnam,$rolename,$end,$start,$deleteflag,$selfenroll,$context)=@_;
9492: return &assignrole($udom,$uname,$url,'cr/'.$rdom.'/'.$rnam.'/'.$rolename,
9493: $end,$start,$deleteflag,$selfenroll,$context);
9494: }
9495:
9496: # ----------------------------------------------------------------- Revoke Role
9497:
9498: sub revokerole {
9499: my ($udom,$uname,$url,$role,$deleteflag,$selfenroll,$context)=@_;
9500: my $now=time;
9501: return &assignrole($udom,$uname,$url,$role,$now,undef,$deleteflag,$selfenroll,$context);
9502: }
9503:
9504: # ---------------------------------------------------------- Revoke Custom Role
9505:
9506: sub revokecustomrole {
9507: my ($udom,$uname,$url,$rdom,$rnam,$rolename,$deleteflag,$selfenroll,$context)=@_;
9508: my $now=time;
9509: return &assigncustomrole($udom,$uname,$url,$rdom,$rnam,$rolename,$now,
9510: $deleteflag,$selfenroll,$context);
9511: }
9512:
9513: # ------------------------------------------------------------ Disk usage
9514: sub diskusage {
9515: my ($udom,$uname,$directorypath,$getpropath)=@_;
9516: $directorypath =~ s/\/$//;
9517: my $listing=&reply('du2:'.&escape($directorypath).':'
9518: .&escape($getpropath).':'.&escape($uname).':'
9519: .&escape($udom),homeserver($uname,$udom));
9520: if ($listing eq 'unknown_cmd') {
9521: if ($getpropath) {
9522: $directorypath = &propath($udom,$uname).'/'.$directorypath;
9523: }
9524: $listing = &reply('du:'.$directorypath,homeserver($uname,$udom));
9525: }
9526: return $listing;
9527: }
9528:
9529: sub is_locked {
9530: my ($file_name, $domain, $user, $which) = @_;
9531: my @check;
9532: my $is_locked;
9533: push (@check,$file_name);
9534: my %locked = &get('file_permissions',\@check,
9535: $env{'user.domain'},$env{'user.name'});
9536: my ($tmp)=keys(%locked);
9537: if ($tmp=~/^error:/) { undef(%locked); }
9538:
9539: if (ref($locked{$file_name}) eq 'ARRAY') {
9540: $is_locked = 'false';
9541: foreach my $entry (@{$locked{$file_name}}) {
9542: if (ref($entry) eq 'ARRAY') {
9543: $is_locked = 'true';
9544: if (ref($which) eq 'ARRAY') {
9545: push(@{$which},$entry);
9546: } else {
9547: last;
9548: }
9549: }
9550: }
9551: } else {
9552: $is_locked = 'false';
9553: }
9554: return $is_locked;
9555: }
9556:
9557: sub declutter_portfile {
9558: my ($file) = @_;
9559: $file =~ s{^(/portfolio/|portfolio/)}{/};
9560: return $file;
9561: }
9562:
9563: # ------------------------------------------------------------- Mark as Read Only
9564:
9565: sub mark_as_readonly {
9566: my ($domain,$user,$files,$what) = @_;
9567: my %current_permissions = &dump('file_permissions',$domain,$user);
9568: my ($tmp)=keys(%current_permissions);
9569: if ($tmp=~/^error:/) { undef(%current_permissions); }
9570: foreach my $file (@{$files}) {
9571: $file = &declutter_portfile($file);
9572: push(@{$current_permissions{$file}},$what);
9573: }
9574: &put('file_permissions',\%current_permissions,$domain,$user);
9575: return;
9576: }
9577:
9578: # ------------------------------------------------------------Save Selected Files
9579:
9580: sub save_selected_files {
9581: my ($user, $path, @files) = @_;
9582: my $filename = $user."savedfiles";
9583: my @other_files = &files_not_in_path($user, $path);
9584: open (OUT, '>'.$tmpdir.$filename);
9585: foreach my $file (@files) {
9586: print (OUT $env{'form.currentpath'}.$file."\n");
9587: }
9588: foreach my $file (@other_files) {
9589: print (OUT $file."\n");
9590: }
9591: close (OUT);
9592: return 'ok';
9593: }
9594:
9595: sub clear_selected_files {
9596: my ($user) = @_;
9597: my $filename = $user."savedfiles";
9598: open (OUT, '>'.LONCAPA::tempdir().$filename);
9599: print (OUT undef);
9600: close (OUT);
9601: return ("ok");
9602: }
9603:
9604: sub files_in_path {
9605: my ($user, $path) = @_;
9606: my $filename = $user."savedfiles";
9607: my %return_files;
9608: open (IN, '<'.LONCAPA::tempdir().$filename);
9609: while (my $line_in = <IN>) {
9610: chomp ($line_in);
9611: my @paths_and_file = split (m!/!, $line_in);
9612: my $file_part = pop (@paths_and_file);
9613: my $path_part = join ('/', @paths_and_file);
9614: $path_part.='/';
9615: my $path_and_file = $path_part.$file_part;
9616: if ($path_part eq $path) {
9617: $return_files{$file_part}= 'selected';
9618: }
9619: }
9620: close (IN);
9621: return (\%return_files);
9622: }
9623:
9624: # called in portfolio select mode, to show files selected NOT in current directory
9625: sub files_not_in_path {
9626: my ($user, $path) = @_;
9627: my $filename = $user."savedfiles";
9628: my @return_files;
9629: my $path_part;
9630: open(IN, '<'.LONCAPA::.$filename);
9631: while (my $line = <IN>) {
9632: #ok, I know it's clunky, but I want it to work
9633: my @paths_and_file = split(m|/|, $line);
9634: my $file_part = pop(@paths_and_file);
9635: chomp($file_part);
9636: my $path_part = join('/', @paths_and_file);
9637: $path_part .= '/';
9638: my $path_and_file = $path_part.$file_part;
9639: if ($path_part ne $path) {
9640: push(@return_files, ($path_and_file));
9641: }
9642: }
9643: close(OUT);
9644: return (@return_files);
9645: }
9646:
9647: #------------------------------Submitted/Handedback Portfolio Files Versioning
9648:
9649: sub portfiles_versioning {
9650: my ($symb,$domain,$stu_name,$portfiles,$versioned_portfiles) = @_;
9651: my $portfolio_root = '/userfiles/portfolio';
9652: return unless ((ref($portfiles) eq 'ARRAY') && (ref($versioned_portfiles) eq 'ARRAY'));
9653: foreach my $file (@{$portfiles}) {
9654: &unmark_as_readonly($domain,$stu_name,[$symb,$env{'request.course.id'}],$file);
9655: my ($directory,$answer_file) =($file =~ /^(.*?)([^\/]*)$/);
9656: my ($answer_name,$answer_ver,$answer_ext) = &file_name_version_ext($answer_file);
9657: my $getpropath = 1;
9658: my ($dir_list,$listerror) = &dirlist($portfolio_root.$directory,$domain,
9659: $stu_name,$getpropath);
9660: my $version = &get_next_version($answer_name,$answer_ext,$dir_list);
9661: my $new_answer =
9662: &version_selected_portfile($domain,$stu_name,$directory,$answer_file,$version);
9663: if ($new_answer ne 'problem getting file') {
9664: push(@{$versioned_portfiles}, $directory.$new_answer);
9665: &mark_as_readonly($domain,$stu_name,[$directory.$new_answer],
9666: [$symb,$env{'request.course.id'},'graded']);
9667: }
9668: }
9669: }
9670:
9671: sub get_next_version {
9672: my ($answer_name, $answer_ext, $dir_list) = @_;
9673: my $version;
9674: if (ref($dir_list) eq 'ARRAY') {
9675: foreach my $row (@{$dir_list}) {
9676: my ($file) = split(/\&/,$row,2);
9677: my ($file_name,$file_version,$file_ext) =
9678: &file_name_version_ext($file);
9679: if (($file_name eq $answer_name) &&
9680: ($file_ext eq $answer_ext)) {
9681: # gets here if filename and extension match,
9682: # regardless of version
9683: if ($file_version ne '') {
9684: # a versioned file is found so save it for later
9685: if ($file_version > $version) {
9686: $version = $file_version;
9687: }
9688: }
9689: }
9690: }
9691: }
9692: $version ++;
9693: return($version);
9694: }
9695:
9696: sub version_selected_portfile {
9697: my ($domain,$stu_name,$directory,$file_name,$version) = @_;
9698: my ($answer_name,$answer_ver,$answer_ext) =
9699: &file_name_version_ext($file_name);
9700: my $new_answer;
9701: $env{'form.copy'} =
9702: &getfile("/uploaded/$domain/$stu_name/portfolio$directory$file_name");
9703: if($env{'form.copy'} eq '-1') {
9704: $new_answer = 'problem getting file';
9705: } else {
9706: $new_answer = $answer_name.'.'.$version.'.'.$answer_ext;
9707: my $copy_result =
9708: &finishuserfileupload($stu_name,$domain,'copy',
9709: '/portfolio'.$directory.$new_answer);
9710: }
9711: undef($env{'form.copy'});
9712: return ($new_answer);
9713: }
9714:
9715: sub file_name_version_ext {
9716: my ($file)=@_;
9717: my @file_parts = split(/\./, $file);
9718: my ($name,$version,$ext);
9719: if (@file_parts > 1) {
9720: $ext=pop(@file_parts);
9721: if (@file_parts > 1 && $file_parts[-1] =~ /^\d+$/) {
9722: $version=pop(@file_parts);
9723: }
9724: $name=join('.',@file_parts);
9725: } else {
9726: $name=join('.',@file_parts);
9727: }
9728: return($name,$version,$ext);
9729: }
9730:
9731: #----------------------------------------------Get portfolio file permissions
9732:
9733: sub get_portfile_permissions {
9734: my ($domain,$user) = @_;
9735: my %current_permissions = &dump('file_permissions',$domain,$user);
9736: my ($tmp)=keys(%current_permissions);
9737: if ($tmp=~/^error:/) { undef(%current_permissions); }
9738: return \%current_permissions;
9739: }
9740:
9741: #---------------------------------------------Get portfolio file access controls
9742:
9743: sub get_access_controls {
9744: my ($current_permissions,$group,$file) = @_;
9745: my %access;
9746: my $real_file = $file;
9747: $file =~ s/\.meta$//;
9748: if (defined($file)) {
9749: if (ref($$current_permissions{$file."\0".'accesscontrol'}) eq 'HASH') {
9750: foreach my $control (keys(%{$$current_permissions{$file."\0".'accesscontrol'}})) {
9751: $access{$real_file}{$control} = $$current_permissions{$file."\0".$control};
9752: }
9753: }
9754: } else {
9755: foreach my $key (keys(%{$current_permissions})) {
9756: if ($key =~ /\0accesscontrol$/) {
9757: if (defined($group)) {
9758: if ($key !~ m-^\Q$group\E/-) {
9759: next;
9760: }
9761: }
9762: my ($fullpath) = split(/\0/,$key);
9763: if (ref($$current_permissions{$key}) eq 'HASH') {
9764: foreach my $control (keys(%{$$current_permissions{$key}})) {
9765: $access{$fullpath}{$control}=$$current_permissions{$fullpath."\0".$control};
9766: }
9767: }
9768: }
9769: }
9770: }
9771: return %access;
9772: }
9773:
9774: sub modify_access_controls {
9775: my ($file_name,$changes,$domain,$user)=@_;
9776: my ($outcome,$deloutcome);
9777: my %store_permissions;
9778: my %new_values;
9779: my %new_control;
9780: my %translation;
9781: my @deletions = ();
9782: my $now = time;
9783: if (exists($$changes{'activate'})) {
9784: if (ref($$changes{'activate'}) eq 'HASH') {
9785: my @newitems = sort(keys(%{$$changes{'activate'}}));
9786: my $numnew = scalar(@newitems);
9787: for (my $i=0; $i<$numnew; $i++) {
9788: my $newkey = $newitems[$i];
9789: my $newid = &Apache::loncommon::get_cgi_id();
9790: if ($newkey =~ /^\d+:/) {
9791: $newkey =~ s/^(\d+)/$newid/;
9792: $translation{$1} = $newid;
9793: } elsif ($newkey =~ /^\d+_\d+_\d+:/) {
9794: $newkey =~ s/^(\d+_\d+_\d+)/$newid/;
9795: $translation{$1} = $newid;
9796: }
9797: $new_values{$file_name."\0".$newkey} =
9798: $$changes{'activate'}{$newitems[$i]};
9799: $new_control{$newkey} = $now;
9800: }
9801: }
9802: }
9803: my %todelete;
9804: my %changed_items;
9805: foreach my $action ('delete','update') {
9806: if (exists($$changes{$action})) {
9807: if (ref($$changes{$action}) eq 'HASH') {
9808: foreach my $key (keys(%{$$changes{$action}})) {
9809: my ($itemnum) = ($key =~ /^([^:]+):/);
9810: if ($action eq 'delete') {
9811: $todelete{$itemnum} = 1;
9812: } else {
9813: $changed_items{$itemnum} = $key;
9814: }
9815: }
9816: }
9817: }
9818: }
9819: # get lock on access controls for file.
9820: my $lockhash = {
9821: $file_name."\0".'locked_access_records' => $env{'user.name'}.
9822: ':'.$env{'user.domain'},
9823: };
9824: my $tries = 0;
9825: my $gotlock = &newput('file_permissions',$lockhash,$domain,$user);
9826:
9827: while (($gotlock ne 'ok') && $tries < 10) {
9828: $tries ++;
9829: sleep(0.1);
9830: $gotlock = &newput('file_permissions',$lockhash,$domain,$user);
9831: }
9832: if ($gotlock eq 'ok') {
9833: my %curr_permissions = &dump('file_permissions',$domain,$user,$file_name);
9834: my ($tmp)=keys(%curr_permissions);
9835: if ($tmp=~/^error:/) { undef(%curr_permissions); }
9836: if (exists($curr_permissions{$file_name."\0".'accesscontrol'})) {
9837: my $curr_controls = $curr_permissions{$file_name."\0".'accesscontrol'};
9838: if (ref($curr_controls) eq 'HASH') {
9839: foreach my $control_item (keys(%{$curr_controls})) {
9840: my ($itemnum) = ($control_item =~ /^([^:]+):/);
9841: if (defined($todelete{$itemnum})) {
9842: push(@deletions,$file_name."\0".$control_item);
9843: } else {
9844: if (defined($changed_items{$itemnum})) {
9845: $new_control{$changed_items{$itemnum}} = $now;
9846: push(@deletions,$file_name."\0".$control_item);
9847: $new_values{$file_name."\0".$changed_items{$itemnum}} = $$changes{'update'}{$changed_items{$itemnum}};
9848: } else {
9849: $new_control{$control_item} = $$curr_controls{$control_item};
9850: }
9851: }
9852: }
9853: }
9854: }
9855: my ($group);
9856: if (&is_course($domain,$user)) {
9857: ($group,my $file) = split(/\//,$file_name,2);
9858: }
9859: $deloutcome = &del('file_permissions',\@deletions,$domain,$user);
9860: $new_values{$file_name."\0".'accesscontrol'} = \%new_control;
9861: $outcome = &put('file_permissions',\%new_values,$domain,$user);
9862: # remove lock
9863: my @del_lock = ($file_name."\0".'locked_access_records');
9864: my $dellockoutcome = &del('file_permissions',\@del_lock,$domain,$user);
9865: my $sqlresult =
9866: &update_portfolio_table($user,$domain,$file_name,'portfolio_access',
9867: $group);
9868: } else {
9869: $outcome = "error: could not obtain lockfile\n";
9870: }
9871: return ($outcome,$deloutcome,\%new_values,\%translation);
9872: }
9873:
9874: sub make_public_indefinitely {
9875: my (@requrl) = @_;
9876: return &automated_portfile_access('public',\@requrl);
9877: }
9878:
9879: sub automated_portfile_access {
9880: my ($accesstype,$addsref,$delsref,$info) = @_;
9881: unless (($accesstype eq 'public') || ($accesstype eq 'ip')) {
9882: return 'invalid';
9883: }
9884: my %urls;
9885: if (ref($addsref) eq 'ARRAY') {
9886: foreach my $requrl (@{$addsref}) {
9887: if (&is_portfolio_url($requrl)) {
9888: unless (exists($urls{$requrl})) {
9889: $urls{$requrl} = 'add';
9890: }
9891: }
9892: }
9893: }
9894: if (ref($delsref) eq 'ARRAY') {
9895: foreach my $requrl (@{$delsref}) {
9896: if (&is_portfolio_url($requrl)) {
9897: unless (exists($urls{$requrl})) {
9898: $urls{$requrl} = 'delete';
9899: }
9900: }
9901: }
9902: }
9903: unless (keys(%urls)) {
9904: return 'invalid';
9905: }
9906: my $ip;
9907: if ($accesstype eq 'ip') {
9908: if (ref($info) eq 'HASH') {
9909: if ($info->{'ip'} ne '') {
9910: $ip = $info->{'ip'};
9911: }
9912: }
9913: if ($ip eq '') {
9914: return 'invalid';
9915: }
9916: }
9917: my $errors;
9918: my $now = time;
9919: my %current_perms;
9920: foreach my $requrl (sort(keys(%urls))) {
9921: my $action;
9922: if ($urls{$requrl} eq 'add') {
9923: $action = 'activate';
9924: } else {
9925: $action = 'none';
9926: }
9927: my $aclnum = 0;
9928: my (undef,$udom,$unum,$file_name,$group) =
9929: &parse_portfolio_url($requrl);
9930: unless (exists($current_perms{$unum.':'.$udom})) {
9931: $current_perms{$unum.':'.$udom} = &get_portfile_permissions($udom,$unum);
9932: }
9933: my %access_controls = &get_access_controls($current_perms{$unum.':'.$udom},
9934: $group,$file_name);
9935: foreach my $key (keys(%{$access_controls{$file_name}})) {
9936: my ($num,$scope,$end,$start) =
9937: ($key =~ /^([^:]+):([a-z]+)_(\d*)_?(\d*)$/);
9938: if ($scope eq $accesstype) {
9939: if (($start <= $now) && ($end == 0)) {
9940: if ($accesstype eq 'ip') {
9941: if (ref($access_controls{$file_name}{$key}) eq 'HASH') {
9942: if (ref($access_controls{$file_name}{$key}{'ip'}) eq 'ARRAY') {
9943: if (grep(/^\Q$ip\E$/,@{$access_controls{$file_name}{$key}{'ip'}})) {
9944: if ($urls{$requrl} eq 'add') {
9945: $action = 'none';
9946: last;
9947: } else {
9948: $action = 'delete';
9949: $aclnum = $num;
9950: last;
9951: }
9952: }
9953: }
9954: }
9955: } elsif ($accesstype eq 'public') {
9956: if ($urls{$requrl} eq 'add') {
9957: $action = 'none';
9958: last;
9959: } else {
9960: $action = 'delete';
9961: $aclnum = $num;
9962: last;
9963: }
9964: }
9965: } elsif ($accesstype eq 'public') {
9966: $action = 'update';
9967: $aclnum = $num;
9968: last;
9969: }
9970: }
9971: }
9972: if ($action eq 'none') {
9973: next;
9974: } else {
9975: my %changes;
9976: my $newend = 0;
9977: my $newstart = $now;
9978: my $newkey = $aclnum.':'.$accesstype.'_'.$newend.'_'.$newstart;
9979: $changes{$action}{$newkey} = {
9980: type => $accesstype,
9981: time => {
9982: start => $newstart,
9983: end => $newend,
9984: },
9985: };
9986: if ($accesstype eq 'ip') {
9987: $changes{$action}{$newkey}{'ip'} = [$ip];
9988: }
9989: my ($outcome,$deloutcome,$new_values,$translation) =
9990: &modify_access_controls($file_name,\%changes,$udom,$unum);
9991: unless ($outcome eq 'ok') {
9992: $errors .= $outcome.' ';
9993: }
9994: }
9995: }
9996: if ($errors) {
9997: $errors =~ s/\s$//;
9998: return $errors;
9999: } else {
10000: return 'ok';
10001: }
10002: }
10003:
10004: #------------------------------------------------------Get Marked as Read Only
10005:
10006: sub get_marked_as_readonly {
10007: my ($domain,$user,$what,$group) = @_;
10008: my $current_permissions = &get_portfile_permissions($domain,$user);
10009: my @readonly_files;
10010: my $cmp1=$what;
10011: if (ref($what)) { $cmp1=join('',@{$what}) };
10012: while (my ($file_name,$value) = each(%{$current_permissions})) {
10013: if (defined($group)) {
10014: if ($file_name !~ m-^\Q$group\E/-) {
10015: next;
10016: }
10017: }
10018: if (ref($value) eq "ARRAY"){
10019: foreach my $stored_what (@{$value}) {
10020: my $cmp2=$stored_what;
10021: if (ref($stored_what) eq 'ARRAY') {
10022: $cmp2=join('',@{$stored_what});
10023: }
10024: if ($cmp1 eq $cmp2) {
10025: push(@readonly_files, $file_name);
10026: last;
10027: } elsif (!defined($what)) {
10028: push(@readonly_files, $file_name);
10029: last;
10030: }
10031: }
10032: }
10033: }
10034: return @readonly_files;
10035: }
10036: #-----------------------------------------------------------Get Marked as Read Only Hash
10037:
10038: sub get_marked_as_readonly_hash {
10039: my ($current_permissions,$group,$what) = @_;
10040: my %readonly_files;
10041: while (my ($file_name,$value) = each(%{$current_permissions})) {
10042: if (defined($group)) {
10043: if ($file_name !~ m-^\Q$group\E/-) {
10044: next;
10045: }
10046: }
10047: if (ref($value) eq "ARRAY"){
10048: foreach my $stored_what (@{$value}) {
10049: if (ref($stored_what) eq 'ARRAY') {
10050: foreach my $lock_descriptor(@{$stored_what}) {
10051: if ($lock_descriptor eq 'graded') {
10052: $readonly_files{$file_name} = 'graded';
10053: } elsif ($lock_descriptor eq 'handback') {
10054: $readonly_files{$file_name} = 'handback';
10055: } else {
10056: if (!exists($readonly_files{$file_name})) {
10057: $readonly_files{$file_name} = 'locked';
10058: }
10059: }
10060: }
10061: }
10062: }
10063: }
10064: }
10065: return %readonly_files;
10066: }
10067: # ------------------------------------------------------------ Unmark as Read Only
10068:
10069: sub unmark_as_readonly {
10070: # unmarks $file_name (if $file_name is defined), or all files locked by $what
10071: # for portfolio submissions, $what contains [$symb,$crsid]
10072: my ($domain,$user,$what,$file_name,$group) = @_;
10073: $file_name = &declutter_portfile($file_name);
10074: my $symb_crs = $what;
10075: if (ref($what)) { $symb_crs=join('',@$what); }
10076: my %current_permissions = &dump('file_permissions',$domain,$user,$group);
10077: my ($tmp)=keys(%current_permissions);
10078: if ($tmp=~/^error:/) { undef(%current_permissions); }
10079: my @readonly_files = &get_marked_as_readonly($domain,$user,$what,$group);
10080: foreach my $file (@readonly_files) {
10081: my $clean_file = &declutter_portfile($file);
10082: if (defined($file_name) && ($file_name ne $clean_file)) { next; }
10083: my $current_locks = $current_permissions{$file};
10084: my @new_locks;
10085: my @del_keys;
10086: if (ref($current_locks) eq "ARRAY"){
10087: foreach my $locker (@{$current_locks}) {
10088: my $compare=$locker;
10089: if (ref($locker) eq 'ARRAY') {
10090: $compare=join('',@{$locker});
10091: if ($compare ne $symb_crs) {
10092: push(@new_locks, $locker);
10093: }
10094: }
10095: }
10096: if (scalar(@new_locks) > 0) {
10097: $current_permissions{$file} = \@new_locks;
10098: } else {
10099: push(@del_keys, $file);
10100: &del('file_permissions',\@del_keys, $domain, $user);
10101: delete($current_permissions{$file});
10102: }
10103: }
10104: }
10105: &put('file_permissions',\%current_permissions,$domain,$user);
10106: return;
10107: }
10108:
10109: # ------------------------------------------------------------ Directory lister
10110:
10111: sub dirlist {
10112: my ($uri,$userdomain,$username,$getpropath,$getuserdir,$alternateRoot)=@_;
10113: $uri=~s/^\///;
10114: $uri=~s/\/$//;
10115: my ($udom, $uname);
10116: if ($getuserdir) {
10117: $udom = $userdomain;
10118: $uname = $username;
10119: } else {
10120: (undef,$udom,$uname)=split(/\//,$uri);
10121: if(defined($userdomain)) {
10122: $udom = $userdomain;
10123: }
10124: if(defined($username)) {
10125: $uname = $username;
10126: }
10127: }
10128: my ($dirRoot,$listing,@listing_results);
10129:
10130: $dirRoot = $perlvar{'lonDocRoot'};
10131: if (defined($getpropath)) {
10132: $dirRoot = &propath($udom,$uname);
10133: $dirRoot =~ s/\/$//;
10134: } elsif (defined($getuserdir)) {
10135: my $subdir=$uname.'__';
10136: $subdir =~ s/(.)(.)(.).*/$1\/$2\/$3/;
10137: $dirRoot = $Apache::lonnet::perlvar{'lonUsersDir'}
10138: ."/$udom/$subdir/$uname";
10139: } elsif (defined($alternateRoot)) {
10140: $dirRoot = $alternateRoot;
10141: }
10142:
10143: if($udom) {
10144: if($uname) {
10145: my $uhome = &homeserver($uname,$udom);
10146: if ($uhome eq 'no_host') {
10147: return ([],'no_host');
10148: }
10149: $listing = &reply('ls3:'.&escape('/'.$uri).':'.$getpropath.':'
10150: .$getuserdir.':'.&escape($dirRoot)
10151: .':'.&escape($uname).':'.&escape($udom),$uhome);
10152: if ($listing eq 'unknown_cmd') {
10153: $listing = &reply('ls2:'.$dirRoot.'/'.$uri,$uhome);
10154: } else {
10155: @listing_results = map { &unescape($_); } split(/:/,$listing);
10156: }
10157: if ($listing eq 'unknown_cmd') {
10158: $listing = &reply('ls:'.$dirRoot.'/'.$uri,$uhome);
10159: @listing_results = split(/:/,$listing);
10160: } else {
10161: @listing_results = map { &unescape($_); } split(/:/,$listing);
10162: }
10163: if (($listing eq 'no_such_host') || ($listing eq 'con_lost') ||
10164: ($listing eq 'rejected') || ($listing eq 'refused') ||
10165: ($listing eq 'no_such_dir') || ($listing eq 'empty')) {
10166: return ([],$listing);
10167: } else {
10168: return (\@listing_results);
10169: }
10170: } elsif(!$alternateRoot) {
10171: my (%allusers,%listerror);
10172: my %servers = &get_servers($udom,'library');
10173: foreach my $tryserver (keys(%servers)) {
10174: $listing = &reply('ls3:'.&escape("/res/$udom").':::::'.
10175: &escape($udom),$tryserver);
10176: if ($listing eq 'unknown_cmd') {
10177: $listing = &reply('ls2:'.$perlvar{'lonDocRoot'}.'/res/'.
10178: $udom, $tryserver);
10179: } else {
10180: @listing_results = map { &unescape($_); } split(/:/,$listing);
10181: }
10182: if ($listing eq 'unknown_cmd') {
10183: $listing = &reply('ls:'.$perlvar{'lonDocRoot'}.'/res/'.
10184: $udom, $tryserver);
10185: @listing_results = split(/:/,$listing);
10186: } else {
10187: @listing_results =
10188: map { &unescape($_); } split(/:/,$listing);
10189: }
10190: if (($listing eq 'no_such_host') || ($listing eq 'con_lost') ||
10191: ($listing eq 'rejected') || ($listing eq 'refused') ||
10192: ($listing eq 'no_such_dir') || ($listing eq 'empty')) {
10193: $listerror{$tryserver} = $listing;
10194: } else {
10195: foreach my $line (@listing_results) {
10196: my ($entry) = split(/&/,$line,2);
10197: $allusers{$entry} = 1;
10198: }
10199: }
10200: }
10201: my @alluserslist=();
10202: foreach my $user (sort(keys(%allusers))) {
10203: push(@alluserslist,$user.'&user');
10204: }
10205:
10206: if (!%listerror) {
10207: # no errors
10208: return (\@alluserslist);
10209: } elsif (scalar(keys(%servers)) == 1) {
10210: # one library server, one error
10211: my ($key) = keys(%listerror);
10212: return (\@alluserslist, $listerror{$key});
10213: } elsif ( grep { $_ eq 'con_lost' } values(%listerror) ) {
10214: # con_lost indicates that we might miss data from at least one
10215: # library server
10216: return (\@alluserslist, 'con_lost');
10217: } else {
10218: # multiple library servers and no con_lost -> data should be
10219: # complete.
10220: return (\@alluserslist);
10221: }
10222:
10223: } else {
10224: return ([],'missing username');
10225: }
10226: } elsif(!defined($getpropath)) {
10227: my $path = $perlvar{'lonDocRoot'}.'/res/';
10228: my @all_domains = map { $path.$_.'/&domain'; } (sort(&all_domains()));
10229: return (\@all_domains);
10230: } else {
10231: return ([],'missing domain');
10232: }
10233: }
10234:
10235: # --------------------------------------------- GetFileTimestamp
10236: # This function utilizes dirlist and returns the date stamp for
10237: # when it was last modified. It will also return an error of -1
10238: # if an error occurs
10239:
10240: sub GetFileTimestamp {
10241: my ($studentDomain,$studentName,$filename,$getuserdir)=@_;
10242: $studentDomain = &LONCAPA::clean_domain($studentDomain);
10243: $studentName = &LONCAPA::clean_username($studentName);
10244: my ($fileref,$error) = &dirlist($filename,$studentDomain,$studentName,
10245: undef,$getuserdir);
10246: if (($error eq 'empty') || ($error eq 'no_such_dir')) {
10247: return -1;
10248: }
10249: if (ref($fileref) eq 'ARRAY') {
10250: my @stats = split('&',$fileref->[0]);
10251: # @stats contains first the filename, then the stat output
10252: return $stats[10]; # so this is 10 instead of 9.
10253: } else {
10254: return -1;
10255: }
10256: }
10257:
10258: sub stat_file {
10259: my ($uri) = @_;
10260: $uri = &clutter_with_no_wrapper($uri);
10261:
10262: my ($udom,$uname,$file);
10263: if ($uri =~ m-^/(uploaded|editupload)/-) {
10264: ($udom,$uname,$file) =
10265: ($uri =~ m-/(?:uploaded|editupload)/?($match_domain)/?($match_name)/?(.*)-);
10266: $file = 'userfiles/'.$file;
10267: }
10268: if ($uri =~ m-^/res/-) {
10269: ($udom,$uname) =
10270: ($uri =~ m-/(?:res)/?($match_domain)/?($match_username)/-);
10271: $file = $uri;
10272: }
10273:
10274: if (!$udom || !$uname || !$file) {
10275: # unable to handle the uri
10276: return ();
10277: }
10278: my $getpropath;
10279: if ($file =~ /^userfiles\//) {
10280: $getpropath = 1;
10281: }
10282: my ($listref,$error) = &dirlist($file,$udom,$uname,$getpropath);
10283: if (($error eq 'empty') || ($error eq 'no_such_dir')) {
10284: return ();
10285: } else {
10286: if (ref($listref) eq 'ARRAY') {
10287: my @stats = split('&',$listref->[0]);
10288: shift(@stats); #filename is first
10289: return @stats;
10290: }
10291: }
10292: return ();
10293: }
10294:
10295: # --------------------------------------------------------- recursedirs
10296: # Recursive function to traverse either a specific user's Authoring Space
10297: # or corresponding Published Resource Space, and populate the hash ref:
10298: # $dirhashref with URLs of all directories, and if $filehashref hash
10299: # ref arg is provided, the URLs of any files, excluding versioned, .meta,
10300: # or .rights files in resource space, and .meta, .save, .log, and .bak
10301: # files in Authoring Space.
10302: #
10303: # Inputs:
10304: #
10305: # $is_home - true if current server is home server for user's space
10306: # $context - either: priv, or res respectively for Authoring or Resource Space.
10307: # $docroot - Document root (i.e., /home/httpd/html
10308: # $toppath - Top level directory (i.e., /res/$dom/$uname or /priv/$dom/$uname
10309: # $relpath - Current path (relative to top level).
10310: # $dirhashref - reference to hash to populate with URLs of directories (Required)
10311: # $filehashref - reference to hash to populate with URLs of files (Optional)
10312: #
10313: # Returns: nothing
10314: #
10315: # Side Effects: populates $dirhashref, and $filehashref (if provided).
10316: #
10317: # Currently used by interface/londocs.pm to create linked select boxes for
10318: # directory and filename to import a Course "Author" resource into a course, and
10319: # also to create linked select boxes for Authoring Space and Directory to choose
10320: # save location for creation of a new "standard" problem from the Course Editor.
10321: #
10322:
10323: sub recursedirs {
10324: my ($is_home,$context,$docroot,$toppath,$relpath,$dirhashref,$filehashref) = @_;
10325: return unless (ref($dirhashref) eq 'HASH');
10326: my $currpath = $docroot.$toppath;
10327: if ($relpath) {
10328: $currpath .= "/$relpath";
10329: }
10330: my $savefile;
10331: if (ref($filehashref)) {
10332: $savefile = 1;
10333: }
10334: if ($is_home) {
10335: if (opendir(my $dirh,$currpath)) {
10336: foreach my $item (sort { lc($a) cmp lc($b) } grep(!/^\.+$/,readdir($dirh))) {
10337: next if ($item eq '');
10338: if (-d "$currpath/$item") {
10339: my $newpath;
10340: if ($relpath) {
10341: $newpath = "$relpath/$item";
10342: } else {
10343: $newpath = $item;
10344: }
10345: $dirhashref->{&Apache::lonlocal::js_escape($newpath)} = 1;
10346: &recursedirs($is_home,$context,$docroot,$toppath,$newpath,$dirhashref,$filehashref);
10347: } elsif ($savefile) {
10348: if ($context eq 'priv') {
10349: unless ($item =~ /\.(meta|save|log|bak|DS_Store)$/) {
10350: $filehashref->{&Apache::lonlocal::js_escape($relpath)}{$item} = 1;
10351: }
10352: } else {
10353: unless (($item =~ /\.meta$/) || ($item =~ /\.\d+\.\w+$/) || ($item =~ /\.rights$/)) {
10354: $filehashref->{&Apache::lonlocal::js_escape($relpath)}{$item} = 1;
10355: }
10356: }
10357: }
10358: }
10359: closedir($dirh);
10360: }
10361: } else {
10362: my ($dirlistref,$listerror) =
10363: &dirlist($toppath.$relpath);
10364: my @dir_lines;
10365: my $dirptr=16384;
10366: if (ref($dirlistref) eq 'ARRAY') {
10367: foreach my $dir_line (sort
10368: {
10369: my ($afile)=split('&',$a,2);
10370: my ($bfile)=split('&',$b,2);
10371: return (lc($afile) cmp lc($bfile));
10372: } (@{$dirlistref})) {
10373: my ($item,$dom,undef,$testdir,undef,undef,undef,undef,$size,undef,$mtime,undef,undef,undef,$obs,undef) =
10374: split(/\&/,$dir_line,16);
10375: $item =~ s/\s+$//;
10376: next if (($item =~ /^\.\.?$/) || ($obs));
10377: if ($dirptr&$testdir) {
10378: my $newpath;
10379: if ($relpath) {
10380: $newpath = "$relpath/$item";
10381: } else {
10382: $relpath = '/';
10383: $newpath = $item;
10384: }
10385: $dirhashref->{&Apache::lonlocal::js_escape($newpath)} = 1;
10386: &recursedirs($is_home,$context,$docroot,$toppath,$newpath,$dirhashref,$filehashref);
10387: } elsif ($savefile) {
10388: if ($context eq 'priv') {
10389: unless ($item =~ /\.(meta|save|log|bak|DS_Store)$/) {
10390: $filehashref->{$relpath}{$item} = 1;
10391: }
10392: } else {
10393: unless (($item =~ /\.meta$/) || ($item =~ /\.\d+\.\w+$/)) {
10394: $filehashref->{$relpath}{$item} = 1;
10395: }
10396: }
10397: }
10398: }
10399: }
10400: }
10401: return;
10402: }
10403:
10404: # -------------------------------------------------------- Value of a Condition
10405:
10406: # gets the value of a specific preevaluated condition
10407: # stored in the string $env{user.state.<cid>}
10408: # or looks up a condition reference in the bighash and if if hasn't
10409: # already been evaluated recurses into docondval to get the value of
10410: # the condition, then memoizing it to
10411: # $env{user.state.<cid>.<condition>}
10412: sub directcondval {
10413: my $number=shift;
10414: if (!defined($env{'user.state.'.$env{'request.course.id'}})) {
10415: &Apache::lonuserstate::evalstate();
10416: }
10417: if (exists($env{'user.state.'.$env{'request.course.id'}.".$number"})) {
10418: return $env{'user.state.'.$env{'request.course.id'}.".$number"};
10419: } elsif ($number =~ /^_/) {
10420: my $sub_condition;
10421: if (tie(my %bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
10422: &GDBM_READER(),0640)) {
10423: $sub_condition=$bighash{'conditions'.$number};
10424: untie(%bighash);
10425: }
10426: my $value = &docondval($sub_condition);
10427: &appenv({'user.state.'.$env{'request.course.id'}.".$number" => $value});
10428: return $value;
10429: }
10430: if ($env{'user.state.'.$env{'request.course.id'}}) {
10431: return substr($env{'user.state.'.$env{'request.course.id'}},$number,1);
10432: } else {
10433: return 2;
10434: }
10435: }
10436:
10437: # get the collection of conditions for this resource
10438: sub condval {
10439: my $condidx=shift;
10440: my $allpathcond='';
10441: foreach my $cond (split(/\|/,$condidx)) {
10442: if (defined($env{'acc.cond.'.$env{'request.course.id'}.'.'.$cond})) {
10443: $allpathcond.=
10444: '('.$env{'acc.cond.'.$env{'request.course.id'}.'.'.$cond}.')|';
10445: }
10446: }
10447: $allpathcond=~s/\|$//;
10448: return &docondval($allpathcond);
10449: }
10450:
10451: #evaluates an expression of conditions
10452: sub docondval {
10453: my ($allpathcond) = @_;
10454: my $result=0;
10455: if ($env{'request.course.id'}
10456: && defined($allpathcond)) {
10457: my $operand='|';
10458: my @stack;
10459: foreach my $chunk ($allpathcond=~/(\d+|_\d+\.\d+|\(|\)|\&|\|)/g) {
10460: if ($chunk eq '(') {
10461: push @stack,($operand,$result);
10462: } elsif ($chunk eq ')') {
10463: my $before=pop @stack;
10464: if (pop @stack eq '&') {
10465: $result=$result>$before?$before:$result;
10466: } else {
10467: $result=$result>$before?$result:$before;
10468: }
10469: } elsif (($chunk eq '&') || ($chunk eq '|')) {
10470: $operand=$chunk;
10471: } else {
10472: my $new=directcondval($chunk);
10473: if ($operand eq '&') {
10474: $result=$result>$new?$new:$result;
10475: } else {
10476: $result=$result>$new?$result:$new;
10477: }
10478: }
10479: }
10480: }
10481: return $result;
10482: }
10483:
10484: # ---------------------------------------------------- Devalidate courseresdata
10485:
10486: sub devalidatecourseresdata {
10487: my ($coursenum,$coursedomain)=@_;
10488: my $hashid=$coursenum.':'.$coursedomain;
10489: &devalidate_cache_new('courseres',$hashid);
10490: }
10491:
10492:
10493: # --------------------------------------------------- Course Resourcedata Query
10494: #
10495: # Parameters:
10496: # $coursenum - Number of the course.
10497: # $coursedomain - Domain at which the course was created.
10498: # Returns:
10499: # A hash of the course parameters along (I think) with timestamps
10500: # and version info.
10501:
10502: sub get_courseresdata {
10503: my ($coursenum,$coursedomain)=@_;
10504: my $coursehom=&homeserver($coursenum,$coursedomain);
10505: my $hashid=$coursenum.':'.$coursedomain;
10506: my ($result,$cached)=&is_cached_new('courseres',$hashid);
10507: my %dumpreply;
10508: unless (defined($cached)) {
10509: %dumpreply=&dump('resourcedata',$coursedomain,$coursenum);
10510: $result=\%dumpreply;
10511: my ($tmp) = keys(%dumpreply);
10512: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
10513: &do_cache_new('courseres',$hashid,$result,600);
10514: } elsif ($tmp =~ /^(con_lost|no_such_host)/) {
10515: return $tmp;
10516: } elsif ($tmp =~ /^(error)/) {
10517: $result=undef;
10518: &do_cache_new('courseres',$hashid,$result,600);
10519: }
10520: }
10521: return $result;
10522: }
10523:
10524: sub devalidateuserresdata {
10525: my ($uname,$udom)=@_;
10526: my $hashid="$udom:$uname";
10527: &devalidate_cache_new('userres',$hashid);
10528: }
10529:
10530: sub get_userresdata {
10531: my ($uname,$udom)=@_;
10532: #most student don\'t have any data set, check if there is some data
10533: if (&EXT_cache_status($udom,$uname)) { return undef; }
10534:
10535: my $hashid="$udom:$uname";
10536: my ($result,$cached)=&is_cached_new('userres',$hashid);
10537: if (!defined($cached)) {
10538: my %resourcedata=&dump('resourcedata',$udom,$uname);
10539: $result=\%resourcedata;
10540: &do_cache_new('userres',$hashid,$result,600);
10541: }
10542: my ($tmp)=keys(%$result);
10543: if (($tmp!~/^error\:/) && ($tmp!~/^con_lost/)) {
10544: return $result;
10545: }
10546: #error 2 occurs when the .db doesn't exist
10547: if ($tmp!~/error: 2 /) {
10548: if ((!defined($cached)) || ($tmp ne 'con_lost')) {
10549: &logthis("<font color=\"blue\">WARNING:".
10550: " Trying to get resource data for ".
10551: $uname." at ".$udom.": ".
10552: $tmp."</font>");
10553: }
10554: } elsif ($tmp=~/error: 2 /) {
10555: #&EXT_cache_set($udom,$uname);
10556: &do_cache_new('userres',$hashid,undef,600);
10557: undef($tmp); # not really an error so don't send it back
10558: }
10559: return $tmp;
10560: }
10561: #----------------------------------------------- resdata - return resource data
10562: # Purpose:
10563: # Return resource data for either users or for a course.
10564: # Parameters:
10565: # $name - Course/user name.
10566: # $domain - Name of the domain the user/course is registered on.
10567: # $type - Type of thing $name is (must be 'course' or 'user')
10568: # $mapp - decluttered URL of enclosing map
10569: # $recursed - Ref to scalar -- set to 1, if nested maps have been recursed.
10570: # $recurseup - Ref to array of map URLs, starting with map containing
10571: # $mapp up through hierarchy of nested maps to top level map.
10572: # $courseid - CourseID (first part of param identifier).
10573: # $modifier - Middle part of param identifier.
10574: # $what - Last part of param identifier.
10575: # @which - Array of names of resources desired.
10576: # Returns:
10577: # The value of the first reasource in @which that is found in the
10578: # resource hash.
10579: # Exceptional Conditions:
10580: # If the $type passed in is not valid (not the string 'course' or
10581: # 'user', an undefined reference is returned.
10582: # If none of the resources are found, an undef is returned
10583: sub resdata {
10584: my ($name,$domain,$type,$mapp,$recursed,$recurseup,$courseid,
10585: $modifier,$what,@which)=@_;
10586: my $result;
10587: if ($type eq 'course') {
10588: $result=&get_courseresdata($name,$domain);
10589: } elsif ($type eq 'user') {
10590: $result=&get_userresdata($name,$domain);
10591: }
10592: if (!ref($result)) { return $result; }
10593: foreach my $item (@which) {
10594: if ($item->[1] eq 'course') {
10595: if ((ref($recurseup) eq 'ARRAY') && (ref($recursed) eq 'SCALAR')) {
10596: unless ($$recursed) {
10597: @{$recurseup} = &get_map_hierarchy($mapp,$courseid);
10598: $$recursed = 1;
10599: }
10600: foreach my $item (@${recurseup}) {
10601: my $norecursechk=$courseid.$modifier.$item.'___(all).'.$what;
10602: last if (defined($result->{$norecursechk}));
10603: my $recursechk=$courseid.$modifier.$item.'___(rec).'.$what;
10604: if (defined($result->{$recursechk})) { return [$result->{$recursechk},'map']; }
10605: }
10606: }
10607: }
10608: if (defined($result->{$item->[0]})) {
10609: return [$result->{$item->[0]},$item->[1]];
10610: }
10611: }
10612: return undef;
10613: }
10614:
10615: sub get_domain_ltitools {
10616: my ($cdom) = @_;
10617: my %ltitools;
10618: my ($result,$cached)=&is_cached_new('ltitools',$cdom);
10619: if (defined($cached)) {
10620: if (ref($result) eq 'HASH') {
10621: %ltitools = %{$result};
10622: }
10623: } else {
10624: my %domconfig = &get_dom('configuration',['ltitools'],$cdom);
10625: if (ref($domconfig{'ltitools'}) eq 'HASH') {
10626: %ltitools = %{$domconfig{'ltitools'}};
10627: }
10628: my $cachetime = 24*60*60;
10629: &do_cache_new('ltitools',$cdom,\%ltitools,$cachetime);
10630: }
10631: return %ltitools;
10632: }
10633:
10634: sub get_numsuppfiles {
10635: my ($cnum,$cdom,$ignorecache)=@_;
10636: my $hashid=$cnum.':'.$cdom;
10637: my ($suppcount,$cached);
10638: unless ($ignorecache) {
10639: ($suppcount,$cached) = &is_cached_new('suppcount',$hashid);
10640: }
10641: unless (defined($cached)) {
10642: my $chome=&homeserver($cnum,$cdom);
10643: unless ($chome eq 'no_host') {
10644: ($suppcount,my $errors) = (0,0);
10645: my $suppmap = 'supplemental.sequence';
10646: ($suppcount,$errors) =
10647: &Apache::loncommon::recurse_supplemental($cnum,$cdom,$suppmap,$suppcount,$errors);
10648: }
10649: &do_cache_new('suppcount',$hashid,$suppcount,600);
10650: }
10651: return $suppcount;
10652: }
10653:
10654: #
10655: # EXT resource caching routines
10656: #
10657:
10658: {
10659: # Cache (5 seconds) of map hierarchy for speedup of navmaps display
10660: #
10661: # The course for which we cache
10662: my $cachedmapkey='';
10663: # The cached recursive maps for this course
10664: my %cachedmaps=();
10665: # When this was last done
10666: my $cachedmaptime='';
10667:
10668: sub clear_EXT_cache_status {
10669: &delenv('cache.EXT.');
10670: }
10671:
10672: sub EXT_cache_status {
10673: my ($target_domain,$target_user) = @_;
10674: my $cachename = 'cache.EXT.'.$target_user.'.'.$target_domain;
10675: if (exists($env{$cachename}) && ($env{$cachename}+600) > time) {
10676: # We know already the user has no data
10677: return 1;
10678: } else {
10679: return 0;
10680: }
10681: }
10682:
10683: sub EXT_cache_set {
10684: my ($target_domain,$target_user) = @_;
10685: my $cachename = 'cache.EXT.'.$target_user.'.'.$target_domain;
10686: #&appenv({$cachename => time});
10687: }
10688:
10689: # --------------------------------------------------------- Value of a Variable
10690: sub EXT {
10691:
10692: my ($varname,$symbparm,$udom,$uname,$usection,$recurse,$cid)=@_;
10693: unless ($varname) { return ''; }
10694: #get real user name/domain, courseid and symb
10695: my $courseid;
10696: my $publicuser;
10697: if ($symbparm) {
10698: $symbparm=&get_symb_from_alias($symbparm);
10699: }
10700: if (!($uname && $udom)) {
10701: (my $cursymb,$courseid,$udom,$uname,$publicuser)= &whichuser($symbparm);
10702: if (!$symbparm) { $symbparm=$cursymb; }
10703: } else {
10704: $courseid=$env{'request.course.id'};
10705: }
10706: my ($realm,$space,$qualifier,@therest)=split(/\./,$varname);
10707: my $rest;
10708: if (defined($therest[0])) {
10709: $rest=join('.',@therest);
10710: } else {
10711: $rest='';
10712: }
10713:
10714: my $qualifierrest=$qualifier;
10715: if ($rest) { $qualifierrest.='.'.$rest; }
10716: my $spacequalifierrest=$space;
10717: if ($qualifierrest) { $spacequalifierrest.='.'.$qualifierrest; }
10718: if ($realm eq 'user') {
10719: # --------------------------------------------------------------- user.resource
10720: if ($space eq 'resource') {
10721: if ( (defined($Apache::lonhomework::parsing_a_problem)
10722: || defined($Apache::lonhomework::parsing_a_task))
10723: &&
10724: ($symbparm eq &symbread()) ) {
10725: # if we are in the middle of processing the resource the
10726: # get the value we are planning on committing
10727: if (defined($Apache::lonhomework::results{$qualifierrest})) {
10728: return $Apache::lonhomework::results{$qualifierrest};
10729: } else {
10730: return $Apache::lonhomework::history{$qualifierrest};
10731: }
10732: } else {
10733: my %restored;
10734: if ($publicuser || $env{'request.state'} eq 'construct') {
10735: %restored=&tmprestore($symbparm,$courseid,$udom,$uname);
10736: } else {
10737: %restored=&restore($symbparm,$courseid,$udom,$uname);
10738: }
10739: return $restored{$qualifierrest};
10740: }
10741: # ----------------------------------------------------------------- user.access
10742: } elsif ($space eq 'access') {
10743: # FIXME - not supporting calls for a specific user
10744: return &allowed($qualifier,$rest);
10745: # ------------------------------------------ user.preferences, user.environment
10746: } elsif (($space eq 'preferences') || ($space eq 'environment')) {
10747: if (($uname eq $env{'user.name'}) &&
10748: ($udom eq $env{'user.domain'})) {
10749: return $env{join('.',('environment',$qualifierrest))};
10750: } else {
10751: my %returnhash;
10752: if (!$publicuser) {
10753: %returnhash=&userenvironment($udom,$uname,
10754: $qualifierrest);
10755: }
10756: return $returnhash{$qualifierrest};
10757: }
10758: # ----------------------------------------------------------------- user.course
10759: } elsif ($space eq 'course') {
10760: # FIXME - not supporting calls for a specific user
10761: return $env{join('.',('request.course',$qualifier))};
10762: # ------------------------------------------------------------------- user.role
10763: } elsif ($space eq 'role') {
10764: # FIXME - not supporting calls for a specific user
10765: my ($role,$where)=split(/\./,$env{'request.role'});
10766: if ($qualifier eq 'value') {
10767: return $role;
10768: } elsif ($qualifier eq 'extent') {
10769: return $where;
10770: }
10771: # ----------------------------------------------------------------- user.domain
10772: } elsif ($space eq 'domain') {
10773: return $udom;
10774: # ------------------------------------------------------------------- user.name
10775: } elsif ($space eq 'name') {
10776: return $uname;
10777: # ---------------------------------------------------- Any other user namespace
10778: } else {
10779: my %reply;
10780: if (!$publicuser) {
10781: %reply=&get($space,[$qualifierrest],$udom,$uname);
10782: }
10783: return $reply{$qualifierrest};
10784: }
10785: } elsif ($realm eq 'query') {
10786: # ---------------------------------------------- pull stuff out of query string
10787: &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},
10788: [$spacequalifierrest]);
10789: return $env{'form.'.$spacequalifierrest};
10790: } elsif ($realm eq 'request') {
10791: # ------------------------------------------------------------- request.browser
10792: if ($space eq 'browser') {
10793: return $env{'browser.'.$qualifier};
10794: # ------------------------------------------------------------ request.filename
10795: } else {
10796: return $env{'request.'.$spacequalifierrest};
10797: }
10798: } elsif ($realm eq 'course') {
10799: # ---------------------------------------------------------- course.description
10800: return $env{'course.'.$courseid.'.'.$spacequalifierrest};
10801: } elsif ($realm eq 'resource') {
10802:
10803: if (defined($courseid) && $courseid eq $env{'request.course.id'}) {
10804: if (!$symbparm) { $symbparm=&symbread(); }
10805: }
10806:
10807: if ($qualifier eq '') {
10808: if ($space eq 'title') {
10809: if (!$symbparm) { $symbparm = $env{'request.filename'}; }
10810: return &gettitle($symbparm);
10811: }
10812:
10813: if ($space eq 'map') {
10814: my ($map) = &decode_symb($symbparm);
10815: return &symbread($map);
10816: }
10817: if ($space eq 'maptitle') {
10818: my ($map) = &decode_symb($symbparm);
10819: return &gettitle($map);
10820: }
10821: if ($space eq 'filename') {
10822: if ($symbparm) {
10823: return &clutter((&decode_symb($symbparm))[2]);
10824: }
10825: return &hreflocation('',$env{'request.filename'});
10826: }
10827:
10828: if ((defined($courseid)) && ($courseid eq $env{'request.course.id'}) && $symbparm) {
10829: if ($space eq 'visibleparts') {
10830: my $navmap = Apache::lonnavmaps::navmap->new();
10831: my $item;
10832: if (ref($navmap)) {
10833: my $res = $navmap->getBySymb($symbparm);
10834: my $parts = $res->parts();
10835: if (ref($parts) eq 'ARRAY') {
10836: $item = join(',',@{$parts});
10837: }
10838: undef($navmap);
10839: }
10840: return $item;
10841: }
10842: }
10843: }
10844:
10845: my ($section, $group, @groups, @recurseup, $recursed);
10846: my ($courselevelm,$courseleveli,$courselevel,$mapp);
10847: if (($courseid eq '') && ($cid)) {
10848: $courseid = $cid;
10849: }
10850: if (($symbparm && $courseid) &&
10851: (($courseid eq $env{'request.course.id'}) || ($courseid eq $cid))) {
10852:
10853: #print '<br>'.$space.' - '.$qualifier.' - '.$spacequalifierrest;
10854:
10855: # ----------------------------------------------------- Cascading lookup scheme
10856: my $symbp=$symbparm;
10857: $mapp=&deversion((&decode_symb($symbp))[0]);
10858: my $symbparm=$symbp.'.'.$spacequalifierrest;
10859: my $recurseparm=$mapp.'___(rec).'.$spacequalifierrest;
10860: my $mapparm=$mapp.'___(all).'.$spacequalifierrest;
10861: if (($env{'user.name'} eq $uname) &&
10862: ($env{'user.domain'} eq $udom)) {
10863: $section=$env{'request.course.sec'};
10864: @groups = split(/:/,$env{'request.course.groups'});
10865: @groups=&sort_course_groups($courseid,@groups);
10866: } else {
10867: if (! defined($usection)) {
10868: $section=&getsection($udom,$uname,$courseid);
10869: } else {
10870: $section = $usection;
10871: }
10872: @groups = &get_users_groups($udom,$uname,$courseid);
10873: }
10874:
10875: my $seclevel=$courseid.'.['.$section.'].'.$spacequalifierrest;
10876: my $seclevelr=$courseid.'.['.$section.'].'.$symbparm;
10877: my $secleveli=$courseid.'.['.$section.'].'.$recurseparm;
10878: my $seclevelm=$courseid.'.['.$section.'].'.$mapparm;
10879:
10880: $courselevel=$courseid.'.'.$spacequalifierrest;
10881: my $courselevelr=$courseid.'.'.$symbparm;
10882: $courseleveli=$courseid.'.'.$recurseparm;
10883: $courselevelm=$courseid.'.'.$mapparm;
10884:
10885: # ----------------------------------------------------------- first, check user
10886:
10887: my $userreply=&resdata($uname,$udom,'user',$mapp,\$recursed,
10888: \@recurseup,$courseid,'.',$spacequalifierrest,
10889: ([$courselevelr,'resource'],
10890: [$courselevelm,'map' ],
10891: [$courseleveli,'map' ],
10892: [$courselevel, 'course' ]));
10893: if (defined($userreply)) { return &get_reply($userreply); }
10894:
10895: # ------------------------------------------------ second, check some of course
10896: my $coursereply;
10897: if (@groups > 0) {
10898: $coursereply = &check_group_parms($courseid,\@groups,$symbparm,
10899: $recurseparm,$mapparm,$spacequalifierrest,
10900: $mapp,\$recursed,\@recurseup);
10901: if (defined($coursereply)) { return &get_reply($coursereply); }
10902: }
10903:
10904: $coursereply=&resdata($env{'course.'.$courseid.'.num'},
10905: $env{'course.'.$courseid.'.domain'},
10906: 'course',$mapp,\$recursed,\@recurseup,
10907: $courseid,'.['.$section.'].',$spacequalifierrest,
10908: ([$seclevelr, 'resource'],
10909: [$seclevelm, 'map' ],
10910: [$secleveli, 'map' ],
10911: [$seclevel, 'course' ],
10912: [$courselevelr,'resource']));
10913: if (defined($coursereply)) { return &get_reply($coursereply); }
10914:
10915: # ------------------------------------------------------ third, check map parms
10916: my %parmhash=();
10917: my $thisparm='';
10918: if (tie(%parmhash,'GDBM_File',
10919: $env{'request.course.fn'}.'_parms.db',
10920: &GDBM_READER(),0640)) {
10921: $thisparm=$parmhash{$symbparm};
10922: untie(%parmhash);
10923: }
10924: if ($thisparm) { return &get_reply([$thisparm,'resource']); }
10925: }
10926: # ------------------------------------------ fourth, look in resource metadata
10927:
10928: my $what = $spacequalifierrest;
10929: $what=~s/\./\_/;
10930: my $filename;
10931: if (!$symbparm) { $symbparm=&symbread(); }
10932: if ($symbparm) {
10933: $filename=(&decode_symb($symbparm))[2];
10934: } else {
10935: $filename=$env{'request.filename'};
10936: }
10937: my $metadata=&metadata($filename,$what);
10938: if (defined($metadata)) { return &get_reply([$metadata,'resource']); }
10939: $metadata=&metadata($filename,'parameter_'.$what);
10940: if (defined($metadata)) { return &get_reply([$metadata,'resource']); }
10941:
10942: # ----------------------------------------------- fifth, look in rest of course
10943: if ($symbparm && defined($courseid) &&
10944: $courseid eq $env{'request.course.id'}) {
10945: my $coursereply=&resdata($env{'course.'.$courseid.'.num'},
10946: $env{'course.'.$courseid.'.domain'},
10947: 'course',$mapp,\$recursed,\@recurseup,
10948: $courseid,'.',$spacequalifierrest,
10949: ([$courselevelm,'map' ],
10950: [$courseleveli,'map' ],
10951: [$courselevel, 'course']));
10952: if (defined($coursereply)) { return &get_reply($coursereply); }
10953: }
10954: # ------------------------------------------------------------------ Cascade up
10955: unless ($space eq '0') {
10956: my @parts=split(/_/,$space);
10957: my $id=pop(@parts);
10958: my $part=join('_',@parts);
10959: if ($part eq '') { $part='0'; }
10960: my @partgeneral=&EXT('resource.'.$part.'.'.$qualifierrest,
10961: $symbparm,$udom,$uname,$section,1);
10962: if (defined($partgeneral[0])) { return &get_reply(\@partgeneral); }
10963: }
10964: if ($recurse) { return undef; }
10965: my $pack_def=&packages_tab_default($filename,$varname);
10966: if (defined($pack_def)) { return &get_reply([$pack_def,'resource']); }
10967: # ---------------------------------------------------- Any other user namespace
10968: } elsif ($realm eq 'environment') {
10969: # ----------------------------------------------------------------- environment
10970: if (($uname eq $env{'user.name'})&&($udom eq $env{'user.domain'})) {
10971: return $env{'environment.'.$spacequalifierrest};
10972: } else {
10973: if ($uname eq 'anonymous' && $udom eq '') {
10974: return '';
10975: }
10976: my %returnhash=&userenvironment($udom,$uname,
10977: $spacequalifierrest);
10978: return $returnhash{$spacequalifierrest};
10979: }
10980: } elsif ($realm eq 'system') {
10981: # ----------------------------------------------------------------- system.time
10982: if ($space eq 'time') {
10983: return time;
10984: }
10985: } elsif ($realm eq 'server') {
10986: # ----------------------------------------------------------------- system.time
10987: if ($space eq 'name') {
10988: return $ENV{'SERVER_NAME'};
10989: }
10990: }
10991: return '';
10992: }
10993:
10994: sub get_reply {
10995: my ($reply_value) = @_;
10996: if (ref($reply_value) eq 'ARRAY') {
10997: if (wantarray) {
10998: return @$reply_value;
10999: }
11000: return $reply_value->[0];
11001: } else {
11002: return $reply_value;
11003: }
11004: }
11005:
11006: sub check_group_parms {
11007: my ($courseid,$groups,$symbparm,$recurseparm,$mapparm,$what,$mapp,
11008: $recursed,$recurseupref) = @_;
11009: my @levels = ([$symbparm,'resource'],[$mapparm,'map'],[$recurseparm,'map'],
11010: [$what,'course']);
11011: my $coursereply;
11012: foreach my $group (@{$groups}) {
11013: my @groupitems = ();
11014: foreach my $level (@levels) {
11015: my $item = $courseid.'.['.$group.'].'.$level->[0];
11016: push(@groupitems,[$item,$level->[1]]);
11017: }
11018: my $coursereply = &resdata($env{'course.'.$courseid.'.num'},
11019: $env{'course.'.$courseid.'.domain'},
11020: 'course',$mapp,$recursed,$recurseupref,
11021: $courseid,'.['.$group.'].',$what,
11022: @groupitems);
11023: last if (defined($coursereply));
11024: }
11025: return $coursereply;
11026: }
11027:
11028: sub get_map_hierarchy {
11029: my ($mapname,$courseid) = @_;
11030: my @recurseup = ();
11031: if ($mapname) {
11032: if (($cachedmapkey eq $courseid) &&
11033: (abs($cachedmaptime-time)<5)) {
11034: if (ref($cachedmaps{$mapname}) eq 'ARRAY') {
11035: return @{$cachedmaps{$mapname}};
11036: }
11037: }
11038: my $navmap = Apache::lonnavmaps::navmap->new();
11039: if (ref($navmap)) {
11040: @recurseup = $navmap->recurseup_maps($mapname);
11041: undef($navmap);
11042: $cachedmaps{$mapname} = \@recurseup;
11043: $cachedmaptime=time;
11044: $cachedmapkey=$courseid;
11045: }
11046: }
11047: return @recurseup;
11048: }
11049:
11050: }
11051:
11052: sub sort_course_groups { # Sort groups based on defined rankings. Default is sort().
11053: my ($courseid,@groups) = @_;
11054: @groups = sort(@groups);
11055: return @groups;
11056: }
11057:
11058: sub packages_tab_default {
11059: my ($uri,$varname)=@_;
11060: my (undef,$part,$name)=split(/\./,$varname);
11061:
11062: my (@extension,@specifics,$do_default);
11063: foreach my $package (split(/,/,&metadata($uri,'packages'))) {
11064: my ($pack_type,$pack_part)=split(/_/,$package,2);
11065: if ($pack_type eq 'default') {
11066: $do_default=1;
11067: } elsif ($pack_type eq 'extension') {
11068: push(@extension,[$package,$pack_type,$pack_part]);
11069: } elsif ($pack_part eq $part || $pack_type eq 'part') {
11070: # only look at packages defaults for packages that this id is
11071: push(@specifics,[$package,$pack_type,$pack_part]);
11072: }
11073: }
11074: # first look for a package that matches the requested part id
11075: foreach my $package (@specifics) {
11076: my (undef,$pack_type,$pack_part)=@{$package};
11077: next if ($pack_part ne $part);
11078: if (defined($packagetab{"$pack_type&$name&default"})) {
11079: return $packagetab{"$pack_type&$name&default"};
11080: }
11081: }
11082: # look for any possible matching non extension_ package
11083: foreach my $package (@specifics) {
11084: my (undef,$pack_type,$pack_part)=@{$package};
11085: if (defined($packagetab{"$pack_type&$name&default"})) {
11086: return $packagetab{"$pack_type&$name&default"};
11087: }
11088: if ($pack_type eq 'part') { $pack_part='0'; }
11089: if (defined($packagetab{$pack_type."_".$pack_part."&$name&default"})) {
11090: return $packagetab{$pack_type."_".$pack_part."&$name&default"};
11091: }
11092: }
11093: # look for any posible extension_ match
11094: foreach my $package (@extension) {
11095: my ($package,$pack_type)=@{$package};
11096: if (defined($packagetab{"$pack_type&$name&default"})) {
11097: return $packagetab{"$pack_type&$name&default"};
11098: }
11099: if (defined($packagetab{$package."&$name&default"})) {
11100: return $packagetab{$package."&$name&default"};
11101: }
11102: }
11103: # look for a global default setting
11104: if ($do_default && defined($packagetab{"default&$name&default"})) {
11105: return $packagetab{"default&$name&default"};
11106: }
11107: return undef;
11108: }
11109:
11110: sub add_prefix_and_part {
11111: my ($prefix,$part)=@_;
11112: my $keyroot;
11113: if (defined($prefix) && $prefix !~ /^__/) {
11114: # prefix that has a part already
11115: $keyroot=$prefix;
11116: } elsif (defined($prefix)) {
11117: # prefix that is missing a part
11118: if (defined($part)) { $keyroot='_'.$part.substr($prefix,1); }
11119: } else {
11120: # no prefix at all
11121: if (defined($part)) { $keyroot='_'.$part; }
11122: }
11123: return $keyroot;
11124: }
11125:
11126: # ---------------------------------------------------------------- Get metadata
11127:
11128: my %metaentry;
11129: my %importedpartids;
11130: sub metadata {
11131: my ($uri,$what,$liburi,$prefix,$depthcount)=@_;
11132: $uri=&declutter($uri);
11133: # if it is a non metadata possible uri return quickly
11134: if (($uri eq '') ||
11135: (($uri =~ m|^/*adm/|) &&
11136: ($uri !~ m|^adm/includes|) && ($uri !~ m{/(smppg|bulletinboard|exttools?)$})) ||
11137: ($uri =~ m|/$|) || ($uri =~ m|/.meta$|) || ($uri =~ m{^/*uploaded/.+\.sequence$})) {
11138: return undef;
11139: }
11140: if (($uri =~ /^priv/ || $uri=~m{^home/httpd/html/priv})
11141: && &Apache::lonxml::get_state('target') =~ /^(|meta)$/) {
11142: return undef;
11143: }
11144: my $filename=$uri;
11145: $uri=~s/\.meta$//;
11146: #
11147: # Is the metadata already cached?
11148: # Look at timestamp of caching
11149: # Everything is cached by the main uri, libraries are never directly cached
11150: #
11151: if (!defined($liburi)) {
11152: my ($result,$cached)=&is_cached_new('meta',$uri);
11153: if (defined($cached)) { return $result->{':'.$what}; }
11154: }
11155: {
11156: # Imported parts would go here
11157: my %importedids=();
11158: my @origfileimportpartids=();
11159: my $importedparts=0;
11160: #
11161: # Is this a recursive call for a library?
11162: #
11163: # if (! exists($metacache{$uri})) {
11164: # $metacache{$uri}={};
11165: # }
11166: my $cachetime = 60*60;
11167: if ($liburi) {
11168: $liburi=&declutter($liburi);
11169: $filename=$liburi;
11170: } else {
11171: &devalidate_cache_new('meta',$uri);
11172: undef(%metaentry);
11173: }
11174: my %metathesekeys=();
11175: unless ($filename=~/\.meta$/) { $filename.='.meta'; }
11176: my $metastring;
11177: if ($uri =~ /^priv/ || $uri=~/home\/httpd\/html\/priv/) {
11178: my $which = &hreflocation('','/'.($liburi || $uri));
11179: $metastring =
11180: &Apache::lonnet::ssi_body($which,
11181: ('grade_target' => 'meta'));
11182: $cachetime = 1; # only want this cached in the child not long term
11183: } elsif (($uri !~ m -^(editupload)/-) &&
11184: ($uri !~ m{^/*uploaded/$match_domain/$match_courseid/docs/})) {
11185: my $file=&filelocation('',&clutter($filename));
11186: #push(@{$metaentry{$uri.'.file'}},$file);
11187: $metastring=&getfile($file);
11188: }
11189: my $parser=HTML::LCParser->new(\$metastring);
11190: my $token;
11191: undef %metathesekeys;
11192: while ($token=$parser->get_token) {
11193: if ($token->[0] eq 'S') {
11194: if (defined($token->[2]->{'package'})) {
11195: #
11196: # This is a package - get package info
11197: #
11198: my $package=$token->[2]->{'package'};
11199: my $keyroot=&add_prefix_and_part($prefix,$token->[2]->{'part'});
11200: if (defined($token->[2]->{'id'})) {
11201: $keyroot.='_'.$token->[2]->{'id'};
11202: }
11203: if ($metaentry{':packages'}) {
11204: $metaentry{':packages'}.=','.$package.$keyroot;
11205: } else {
11206: $metaentry{':packages'}=$package.$keyroot;
11207: }
11208: foreach my $pack_entry (keys(%packagetab)) {
11209: my $part=$keyroot;
11210: $part=~s/^\_//;
11211: if ($pack_entry=~/^\Q$package\E\&/ ||
11212: $pack_entry=~/^\Q$package\E_0\&/) {
11213: my ($pack,$name,$subp)=split(/\&/,$pack_entry);
11214: # ignore package.tab specified default values
11215: # here &package_tab_default() will fetch those
11216: if ($subp eq 'default') { next; }
11217: my $value=$packagetab{$pack_entry};
11218: my $unikey;
11219: if ($pack =~ /_0$/) {
11220: $unikey='parameter_0_'.$name;
11221: $part=0;
11222: } else {
11223: $unikey='parameter'.$keyroot.'_'.$name;
11224: }
11225: if ($subp eq 'display') {
11226: $value.=' [Part: '.$part.']';
11227: }
11228: $metaentry{':'.$unikey.'.part'}=$part;
11229: $metathesekeys{$unikey}=1;
11230: unless (defined($metaentry{':'.$unikey.'.'.$subp})) {
11231: $metaentry{':'.$unikey.'.'.$subp}=$value;
11232: }
11233: if (defined($metaentry{':'.$unikey.'.default'})) {
11234: $metaentry{':'.$unikey}=
11235: $metaentry{':'.$unikey.'.default'};
11236: }
11237: }
11238: }
11239: } else {
11240: #
11241: # This is not a package - some other kind of start tag
11242: #
11243: my $entry=$token->[1];
11244: my $unikey='';
11245:
11246: if ($entry eq 'import') {
11247: #
11248: # Importing a library here
11249: #
11250: my $location=$parser->get_text('/import');
11251: my $dir=$filename;
11252: $dir=~s|[^/]*$||;
11253: $location=&filelocation($dir,$location);
11254:
11255: my $importmode=$token->[2]->{'importmode'};
11256: if ($importmode eq 'problem') {
11257: # Import as problem/response
11258: $unikey=&add_prefix_and_part($prefix,$token->[2]->{'part'});
11259: } elsif ($importmode eq 'part') {
11260: # Import as part(s)
11261: $importedparts=1;
11262: # We need to get the original file and the imported file to get the part order correct
11263: # Good news: we do not need to worry about nested libraries, since parts cannot be nested
11264: # Load and inspect original file
11265: if ($#origfileimportpartids<0) {
11266: undef(%importedpartids);
11267: my $origfilelocation=$perlvar{'lonDocRoot'}.&clutter($uri);
11268: my $origfile=&getfile($origfilelocation);
11269: @origfileimportpartids=($origfile=~/<(part|import)[^>]*id\s*=\s*[\"\']([^\"\']+)[\"\'][^>]*>/gs);
11270: }
11271:
11272: # Load and inspect imported file
11273: my $impfile=&getfile($location);
11274: my @impfilepartids=($impfile=~/<part[^>]*id\s*=\s*[\"\']([^\"\']+)[\"\'][^>]*>/gs);
11275: if ($#impfilepartids>=0) {
11276: # This problem had parts
11277: $importedpartids{$token->[2]->{'id'}}=join(',',@impfilepartids);
11278: } else {
11279: # Importing by turning a single problem into a problem part
11280: # It gets the import-tags ID as part-ID
11281: $unikey=&add_prefix_and_part($prefix,$token->[2]->{'id'});
11282: $importedpartids{$token->[2]->{'id'}}=$token->[2]->{'id'};
11283: }
11284: } else {
11285: # Normal import
11286: $unikey=&add_prefix_and_part($prefix,$token->[2]->{'part'});
11287: if (defined($token->[2]->{'id'})) {
11288: $unikey.='_'.$token->[2]->{'id'};
11289: }
11290: }
11291:
11292: if ($depthcount<20) {
11293: my $metadata =
11294: &metadata($uri,'keys', $location,$unikey,
11295: $depthcount+1);
11296: foreach my $meta (split(',',$metadata)) {
11297: $metaentry{':'.$meta}=$metaentry{':'.$meta};
11298: $metathesekeys{$meta}=1;
11299: }
11300:
11301: }
11302: } else {
11303: #
11304: # Not importing, some other kind of non-package, non-library start tag
11305: #
11306: $unikey=$entry.&add_prefix_and_part($prefix,$token->[2]->{'part'});
11307: if (defined($token->[2]->{'id'})) {
11308: $unikey.='_'.$token->[2]->{'id'};
11309: }
11310: if (defined($token->[2]->{'name'})) {
11311: $unikey.='_'.$token->[2]->{'name'};
11312: }
11313: $metathesekeys{$unikey}=1;
11314: foreach my $param (@{$token->[3]}) {
11315: $metaentry{':'.$unikey.'.'.$param} =
11316: $token->[2]->{$param};
11317: }
11318: my $internaltext=&HTML::Entities::decode($parser->get_text('/'.$entry));
11319: my $default=$metaentry{':'.$unikey.'.default'};
11320: if ( $internaltext =~ /^\s*$/ && $default !~ /^\s*$/) {
11321: # only ws inside the tag, and not in default, so use default
11322: # as value
11323: $metaentry{':'.$unikey}=$default;
11324: } elsif ( $internaltext =~ /\S/ ) {
11325: # something interesting inside the tag
11326: $metaentry{':'.$unikey}=$internaltext;
11327: } else {
11328: # no interesting values, don't set a default
11329: }
11330: # end of not-a-package not-a-library import
11331: }
11332: # end of not-a-package start tag
11333: }
11334: # the next is the end of "start tag"
11335: }
11336: }
11337: my ($extension) = ($uri =~ /\.(\w+)$/);
11338: $extension = lc($extension);
11339: if ($extension eq 'htm') { $extension='html'; }
11340:
11341: foreach my $key (keys(%packagetab)) {
11342: #no specific packages #how's our extension
11343: if ($key!~/^extension_\Q$extension\E&/) { next; }
11344: &metadata_create_package_def($uri,$key,'extension_'.$extension,
11345: \%metathesekeys);
11346: }
11347:
11348: if (!exists($metaentry{':packages'})
11349: || $packagetab{"import_defaults&extension_$extension"}) {
11350: foreach my $key (keys(%packagetab)) {
11351: #no specific packages well let's get default then
11352: if ($key!~/^default&/) { next; }
11353: &metadata_create_package_def($uri,$key,'default',
11354: \%metathesekeys);
11355: }
11356: }
11357: # are there custom rights to evaluate
11358: if ($metaentry{':copyright'} eq 'custom') {
11359:
11360: #
11361: # Importing a rights file here
11362: #
11363: unless ($depthcount) {
11364: my $location=$metaentry{':customdistributionfile'};
11365: my $dir=$filename;
11366: $dir=~s|[^/]*$||;
11367: $location=&filelocation($dir,$location);
11368: my $rights_metadata =
11369: &metadata($uri,'keys',$location,'_rights',
11370: $depthcount+1);
11371: foreach my $rights (split(',',$rights_metadata)) {
11372: #$metaentry{':'.$rights}=$metacache{$uri}->{':'.$rights};
11373: $metathesekeys{$rights}=1;
11374: }
11375: }
11376: }
11377: # uniqifiy package listing
11378: my %seen;
11379: my @uniq_packages =
11380: grep { ! $seen{$_} ++ } (split(',',$metaentry{':packages'}));
11381: $metaentry{':packages'} = join(',',@uniq_packages);
11382:
11383: if ($importedparts) {
11384: # We had imported parts and need to rebuild partorder
11385: $metaentry{':partorder'}='';
11386: $metathesekeys{'partorder'}=1;
11387: for (my $index=0;$index<$#origfileimportpartids;$index+=2) {
11388: if ($origfileimportpartids[$index] eq 'part') {
11389: # original part, part of the problem
11390: $metaentry{':partorder'}.=','.$origfileimportpartids[$index+1];
11391: } else {
11392: # we have imported parts at this position
11393: $metaentry{':partorder'}.=','.$importedpartids{$origfileimportpartids[$index+1]};
11394: }
11395: }
11396: $metaentry{':partorder'}=~s/^\,//;
11397: }
11398:
11399: $metaentry{':keys'} = join(',',keys(%metathesekeys));
11400: &metadata_generate_part0(\%metathesekeys,\%metaentry,$uri);
11401: $metaentry{':allpossiblekeys'}=join(',',keys(%metathesekeys));
11402: &do_cache_new('meta',$uri,\%metaentry,$cachetime);
11403: # this is the end of "was not already recently cached
11404: }
11405: return $metaentry{':'.$what};
11406: }
11407:
11408: sub metadata_create_package_def {
11409: my ($uri,$key,$package,$metathesekeys)=@_;
11410: my ($pack,$name,$subp)=split(/\&/,$key);
11411: if ($subp eq 'default') { next; }
11412:
11413: if (defined($metaentry{':packages'})) {
11414: $metaentry{':packages'}.=','.$package;
11415: } else {
11416: $metaentry{':packages'}=$package;
11417: }
11418: my $value=$packagetab{$key};
11419: my $unikey;
11420: $unikey='parameter_0_'.$name;
11421: $metaentry{':'.$unikey.'.part'}=0;
11422: $$metathesekeys{$unikey}=1;
11423: unless (defined($metaentry{':'.$unikey.'.'.$subp})) {
11424: $metaentry{':'.$unikey.'.'.$subp}=$value;
11425: }
11426: if (defined($metaentry{':'.$unikey.'.default'})) {
11427: $metaentry{':'.$unikey}=
11428: $metaentry{':'.$unikey.'.default'};
11429: }
11430: }
11431:
11432: sub metadata_generate_part0 {
11433: my ($metadata,$metacache,$uri) = @_;
11434: my %allnames;
11435: foreach my $metakey (keys(%$metadata)) {
11436: if ($metakey=~/^parameter\_(.*)/) {
11437: my $part=$$metacache{':'.$metakey.'.part'};
11438: my $name=$$metacache{':'.$metakey.'.name'};
11439: if (! exists($$metadata{'parameter_0_'.$name.'.name'})) {
11440: $allnames{$name}=$part;
11441: }
11442: }
11443: }
11444: foreach my $name (keys(%allnames)) {
11445: $$metadata{"parameter_0_$name"}=1;
11446: my $key=":parameter_0_$name";
11447: $$metacache{"$key.part"}='0';
11448: $$metacache{"$key.name"}=$name;
11449: $$metacache{"$key.type"}=$$metacache{':parameter_'.
11450: $allnames{$name}.'_'.$name.
11451: '.type'};
11452: my $olddis=$$metacache{':parameter_'.$allnames{$name}.'_'.$name.
11453: '.display'};
11454: my $expr='[Part: '.$allnames{$name}.']';
11455: $olddis=~s/\Q$expr\E/\[Part: 0\]/;
11456: $$metacache{"$key.display"}=$olddis;
11457: }
11458: }
11459:
11460: # ------------------------------------------------------ Devalidate title cache
11461:
11462: sub devalidate_title_cache {
11463: my ($url)=@_;
11464: if (!$env{'request.course.id'}) { return; }
11465: my $symb=&symbread($url);
11466: if (!$symb) { return; }
11467: my $key=$env{'request.course.id'}."\0".$symb;
11468: &devalidate_cache_new('title',$key);
11469: }
11470:
11471: # ------------------------------------------------- Get the title of a course
11472:
11473: sub current_course_title {
11474: return $env{ 'course.' . $env{'request.course.id'} . '.description' };
11475: }
11476: # ------------------------------------------------- Get the title of a resource
11477:
11478: sub gettitle {
11479: my $urlsymb=shift;
11480: my $symb=&symbread($urlsymb);
11481: if ($symb) {
11482: my $key=$env{'request.course.id'}."\0".$symb;
11483: my ($result,$cached)=&is_cached_new('title',$key);
11484: if (defined($cached)) {
11485: return $result;
11486: }
11487: my ($map,$resid,$url)=&decode_symb($symb);
11488: my $title='';
11489: if (!$map && $resid == 0 && $url =~/default\.sequence$/) {
11490: $title = $env{'course.'.$env{'request.course.id'}.'.description'};
11491: } else {
11492: if (tie(my %bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
11493: &GDBM_READER(),0640)) {
11494: my $mapid=$bighash{'map_pc_'.&clutter($map)};
11495: $title=$bighash{'title_'.$mapid.'.'.$resid};
11496: untie(%bighash);
11497: }
11498: }
11499: $title=~s/\&colon\;/\:/gs;
11500: if ($title) {
11501: # Remember both $symb and $title for dynamic metadata
11502: $accesshash{$symb.'___crstitle'}=$title;
11503: $accesshash{&declutter($map).'___'.&declutter($url).'___usage'}=time;
11504: # Cache this title and then return it
11505: return &do_cache_new('title',$key,$title,600);
11506: }
11507: $urlsymb=$url;
11508: }
11509: my $title=&metadata($urlsymb,'title');
11510: if (!$title) { $title=(split('/',$urlsymb))[-1]; }
11511: return $title;
11512: }
11513:
11514: sub get_slot {
11515: my ($which,$cnum,$cdom)=@_;
11516: if (!$cnum || !$cdom) {
11517: (undef,my $courseid)=&whichuser();
11518: $cdom=$env{'course.'.$courseid.'.domain'};
11519: $cnum=$env{'course.'.$courseid.'.num'};
11520: }
11521: my $key=join("\0",'slots',$cdom,$cnum,$which);
11522: my %slotinfo;
11523: if (exists($remembered{$key})) {
11524: $slotinfo{$which} = $remembered{$key};
11525: } else {
11526: %slotinfo=&get('slots',[$which],$cdom,$cnum);
11527: &Apache::lonhomework::showhash(%slotinfo);
11528: my ($tmp)=keys(%slotinfo);
11529: if ($tmp=~/^error:/) { return (); }
11530: $remembered{$key} = $slotinfo{$which};
11531: }
11532: if (ref($slotinfo{$which}) eq 'HASH') {
11533: return %{$slotinfo{$which}};
11534: }
11535: return $slotinfo{$which};
11536: }
11537:
11538: sub get_reservable_slots {
11539: my ($cnum,$cdom,$uname,$udom) = @_;
11540: my $now = time;
11541: my $reservable_info;
11542: my $key=join("\0",'reservableslots',$cdom,$cnum,$uname,$udom);
11543: if (exists($remembered{$key})) {
11544: $reservable_info = $remembered{$key};
11545: } else {
11546: my %resv;
11547: ($resv{'now_order'},$resv{'now'},$resv{'future_order'},$resv{'future'}) =
11548: &Apache::loncommon::get_future_slots($cnum,$cdom,$now);
11549: $reservable_info = \%resv;
11550: $remembered{$key} = $reservable_info;
11551: }
11552: return $reservable_info;
11553: }
11554:
11555: sub get_course_slots {
11556: my ($cnum,$cdom) = @_;
11557: my $hashid=$cnum.':'.$cdom;
11558: my ($result,$cached) = &Apache::lonnet::is_cached_new('allslots',$hashid);
11559: if (defined($cached)) {
11560: if (ref($result) eq 'HASH') {
11561: return %{$result};
11562: }
11563: } else {
11564: my %slots=&Apache::lonnet::dump('slots',$cdom,$cnum);
11565: my ($tmp) = keys(%slots);
11566: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
11567: &do_cache_new('allslots',$hashid,\%slots,600);
11568: return %slots;
11569: }
11570: }
11571: return;
11572: }
11573:
11574: sub devalidate_slots_cache {
11575: my ($cnum,$cdom)=@_;
11576: my $hashid=$cnum.':'.$cdom;
11577: &devalidate_cache_new('allslots',$hashid);
11578: }
11579:
11580: sub get_coursechange {
11581: my ($cdom,$cnum) = @_;
11582: if ($cdom eq '' || $cnum eq '') {
11583: return unless ($env{'request.course.id'});
11584: $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
11585: $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
11586: }
11587: my $hashid=$cdom.'_'.$cnum;
11588: my ($change,$cached)=&is_cached_new('crschange',$hashid);
11589: if ((defined($cached)) && ($change ne '')) {
11590: return $change;
11591: } else {
11592: my %crshash;
11593: %crshash = &get('environment',['internal.contentchange'],$cdom,$cnum);
11594: if ($crshash{'internal.contentchange'} eq '') {
11595: $change = $env{'course.'.$cdom.'_'.$cnum.'.internal.created'};
11596: if ($change eq '') {
11597: %crshash = &get('environment',['internal.created'],$cdom,$cnum);
11598: $change = $crshash{'internal.created'};
11599: }
11600: } else {
11601: $change = $crshash{'internal.contentchange'};
11602: }
11603: my $cachetime = 600;
11604: &do_cache_new('crschange',$hashid,$change,$cachetime);
11605: }
11606: return $change;
11607: }
11608:
11609: sub devalidate_coursechange_cache {
11610: my ($cnum,$cdom)=@_;
11611: my $hashid=$cnum.':'.$cdom;
11612: &devalidate_cache_new('crschange',$hashid);
11613: }
11614:
11615: # ------------------------------------------------- Update symbolic store links
11616:
11617: sub symblist {
11618: my ($mapname,%newhash)=@_;
11619: $mapname=&deversion(&declutter($mapname));
11620: my %hash;
11621: if (($env{'request.course.fn'}) && (%newhash)) {
11622: if (tie(%hash,'GDBM_File',$env{'request.course.fn'}.'_symb.db',
11623: &GDBM_WRCREAT(),0640)) {
11624: foreach my $url (keys(%newhash)) {
11625: next if ($url eq 'last_known'
11626: && $env{'form.no_update_last_known'});
11627: $hash{declutter($url)}=&encode_symb($mapname,
11628: $newhash{$url}->[1],
11629: $newhash{$url}->[0]);
11630: }
11631: if (untie(%hash)) {
11632: return 'ok';
11633: }
11634: }
11635: }
11636: return 'error';
11637: }
11638:
11639: # --------------------------------------------------------------- Verify a symb
11640:
11641: sub symbverify {
11642: my ($symb,$thisurl,$encstate)=@_;
11643: my $thisfn=$thisurl;
11644: $thisfn=&declutter($thisfn);
11645: # direct jump to resource in page or to a sequence - will construct own symbs
11646: if ($thisfn=~/\.(page|sequence)$/) { return 1; }
11647: # check URL part
11648: my ($map,$resid,$url)=&decode_symb($symb);
11649:
11650: unless ($url eq $thisfn) { return 0; }
11651:
11652: $symb=&symbclean($symb);
11653: $thisurl=&deversion($thisurl);
11654: $thisfn=&deversion($thisfn);
11655:
11656: my %bighash;
11657: my $okay=0;
11658:
11659: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
11660: &GDBM_READER(),0640)) {
11661: my $noclutter;
11662: if (($thisurl =~ m{^/adm/wrapper/ext/}) || ($thisurl =~ m{^ext/})) {
11663: $thisurl =~ s/\?.+$//;
11664: if ($map =~ m{^uploaded/.+\.page$}) {
11665: $thisurl =~ s{^(/adm/wrapper|)/ext/}{http://};
11666: $thisurl =~ s{^\Qhttp://https://\E}{https://};
11667: $noclutter = 1;
11668: }
11669: }
11670: my $ids;
11671: if ($noclutter) {
11672: $ids=$bighash{'ids_'.$thisurl};
11673: } else {
11674: $ids=$bighash{'ids_'.&clutter($thisurl)};
11675: }
11676: unless ($ids) {
11677: my $idkey = 'ids_'.($thisurl =~ m{^/}? '' : '/').$thisurl;
11678: $ids=$bighash{$idkey};
11679: }
11680: if ($ids) {
11681: # ------------------------------------------------------------------- Has ID(s)
11682: if ($thisfn =~ m{^/adm/wrapper/ext/}) {
11683: $symb =~ s/\?.+$//;
11684: }
11685: foreach my $id (split(/\,/,$ids)) {
11686: my ($mapid,$resid)=split(/\./,$id);
11687: if (
11688: &symbclean(&declutter($bighash{'map_id_'.$mapid}).'___'.$resid.'___'.$thisfn)
11689: eq $symb) {
11690: if (ref($encstate)) {
11691: $$encstate = $bighash{'encrypted_'.$id};
11692: }
11693: if (($env{'request.role.adv'}) ||
11694: ($bighash{'encrypted_'.$id} eq $env{'request.enc'}) ||
11695: ($thisurl eq '/adm/navmaps')) {
11696: $okay=1;
11697: last;
11698: }
11699: }
11700: }
11701: }
11702: untie(%bighash);
11703: }
11704: return $okay;
11705: }
11706:
11707: # --------------------------------------------------------------- Clean-up symb
11708:
11709: sub symbclean {
11710: my $symb=shift;
11711: if ($symb=~m|^/enc/|) { $symb=&Apache::lonenc::unencrypted($symb); }
11712: # remove version from map
11713: $symb=~s/\.(\d+)\.(\w+)\_\_\_/\.$2\_\_\_/;
11714:
11715: # remove version from URL
11716: $symb=~s/\.(\d+)\.(\w+)$/\.$2/;
11717:
11718: # remove wrapper
11719:
11720: $symb=~s/(\_\_\_\d+\_\_\_)adm\/wrapper\/(res\/)*/$1/;
11721: $symb=~s/(\_\_\_\d+\_\_\_)adm\/coursedocs\/showdoc\/(res\/)*/$1/;
11722: return $symb;
11723: }
11724:
11725: # ---------------------------------------------- Split symb to find map and url
11726:
11727: sub encode_symb {
11728: my ($map,$resid,$url)=@_;
11729: return &symbclean(&declutter($map).'___'.$resid.'___'.&declutter($url));
11730: }
11731:
11732: sub decode_symb {
11733: my $symb=shift;
11734: if ($symb=~m|^/enc/|) { $symb=&Apache::lonenc::unencrypted($symb); }
11735: my ($map,$resid,$url)=split(/___/,$symb);
11736: return (&fixversion($map),$resid,&fixversion($url));
11737: }
11738:
11739: sub fixversion {
11740: my $fn=shift;
11741: if ($fn=~/^(adm|uploaded|editupload|public)/) { return $fn; }
11742: my %bighash;
11743: my $uri=&clutter($fn);
11744: my $key=$env{'request.course.id'}.'_'.$uri;
11745: # is this cached?
11746: my ($result,$cached)=&is_cached_new('courseresversion',$key);
11747: if (defined($cached)) { return $result; }
11748: # unfortunately not cached, or expired
11749: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
11750: &GDBM_READER(),0640)) {
11751: if ($bighash{'version_'.$uri}) {
11752: my $version=$bighash{'version_'.$uri};
11753: unless (($version eq 'mostrecent') ||
11754: ($version==&getversion($uri))) {
11755: $uri=~s/\.(\w+)$/\.$version\.$1/;
11756: }
11757: }
11758: untie %bighash;
11759: }
11760: return &do_cache_new('courseresversion',$key,&declutter($uri),600);
11761: }
11762:
11763: sub deversion {
11764: my $url=shift;
11765: $url=~s/\.\d+\.(\w+)$/\.$1/;
11766: return $url;
11767: }
11768:
11769: # ------------------------------------------------------ Return symb list entry
11770:
11771: sub symbread {
11772: my ($thisfn,$donotrecurse,$ignorecachednull,$checkforblock,$possibles)=@_;
11773: my $cache_str='request.symbread.cached.'.$thisfn;
11774: if (defined($env{$cache_str})) {
11775: if ($ignorecachednull) {
11776: return $env{$cache_str} unless ($env{$cache_str} eq '');
11777: } else {
11778: return $env{$cache_str};
11779: }
11780: }
11781: # no filename provided? try from environment
11782: unless ($thisfn) {
11783: if ($env{'request.symb'}) {
11784: return $env{$cache_str}=&symbclean($env{'request.symb'});
11785: }
11786: $thisfn=$env{'request.filename'};
11787: }
11788: if ($thisfn=~m|^/enc/|) { $thisfn=&Apache::lonenc::unencrypted($thisfn); }
11789: # is that filename actually a symb? Verify, clean, and return
11790: if ($thisfn=~/\_\_\_\d+\_\_\_(.*)$/) {
11791: if (&symbverify($thisfn,$1)) {
11792: return $env{$cache_str}=&symbclean($thisfn);
11793: }
11794: }
11795: $thisfn=declutter($thisfn);
11796: my %hash;
11797: my %bighash;
11798: my $syval='';
11799: if (($env{'request.course.fn'}) && ($thisfn)) {
11800: my $targetfn = $thisfn;
11801: if ( ($thisfn =~ m/^(uploaded|editupload)\//) && ($thisfn !~ m/\.(page|sequence)$/) ) {
11802: $targetfn = 'adm/wrapper/'.$thisfn;
11803: }
11804: if ($targetfn =~ m|^adm/wrapper/(ext/.*)|) {
11805: $targetfn=$1;
11806: }
11807: if (tie(%hash,'GDBM_File',$env{'request.course.fn'}.'_symb.db',
11808: &GDBM_READER(),0640)) {
11809: $syval=$hash{$targetfn};
11810: untie(%hash);
11811: }
11812: # ---------------------------------------------------------- There was an entry
11813: if ($syval) {
11814: #unless ($syval=~/\_\d+$/) {
11815: #unless ($env{'form.request.prefix'}=~/\.(\d+)\_$/) {
11816: #&appenv({'request.ambiguous' => $thisfn});
11817: #return $env{$cache_str}='';
11818: #}
11819: #$syval.=$1;
11820: #}
11821: } else {
11822: # ------------------------------------------------------- Was not in symb table
11823: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
11824: &GDBM_READER(),0640)) {
11825: # ---------------------------------------------- Get ID(s) for current resource
11826: my $ids=$bighash{'ids_'.&clutter($thisfn)};
11827: unless ($ids) {
11828: $ids=$bighash{'ids_/'.$thisfn};
11829: }
11830: unless ($ids) {
11831: # alias?
11832: $ids=$bighash{'mapalias_'.$thisfn};
11833: }
11834: if ($ids) {
11835: # ------------------------------------------------------------------- Has ID(s)
11836: my @possibilities=split(/\,/,$ids);
11837: if ($#possibilities==0) {
11838: # ----------------------------------------------- There is only one possibility
11839: my ($mapid,$resid)=split(/\./,$ids);
11840: $syval=&encode_symb($bighash{'map_id_'.$mapid},
11841: $resid,$thisfn);
11842: if (ref($possibles) eq 'HASH') {
11843: $possibles->{$syval} = 1;
11844: }
11845: if ($checkforblock) {
11846: my @blockers = &has_comm_blocking('bre',$syval,$bighash{'src_'.$ids});
11847: if (@blockers) {
11848: $syval = '';
11849: return;
11850: }
11851: }
11852: } elsif ((!$donotrecurse) || ($checkforblock) || (ref($possibles) eq 'HASH')) {
11853: # ------------------------------------------ There is more than one possibility
11854: my $realpossible=0;
11855: foreach my $id (@possibilities) {
11856: my $file=$bighash{'src_'.$id};
11857: my $canaccess;
11858: if (($donotrecurse) || ($checkforblock) || (ref($possibles) eq 'HASH')) {
11859: $canaccess = 1;
11860: } else {
11861: $canaccess = &allowed('bre',$file);
11862: }
11863: if ($canaccess) {
11864: my ($mapid,$resid)=split(/\./,$id);
11865: if ($bighash{'map_type_'.$mapid} ne 'page') {
11866: my $poss_syval=&encode_symb($bighash{'map_id_'.$mapid},
11867: $resid,$thisfn);
11868: if (ref($possibles) eq 'HASH') {
11869: $possibles->{$syval} = 1;
11870: }
11871: if ($checkforblock) {
11872: my @blockers = &has_comm_blocking('bre',$poss_syval,$file);
11873: unless (@blockers > 0) {
11874: $syval = $poss_syval;
11875: $realpossible++;
11876: }
11877: } else {
11878: $syval = $poss_syval;
11879: $realpossible++;
11880: }
11881: }
11882: }
11883: }
11884: if ($realpossible!=1) { $syval=''; }
11885: } else {
11886: $syval='';
11887: }
11888: }
11889: untie(%bighash);
11890: }
11891: }
11892: if ($syval) {
11893: return $env{$cache_str}=$syval;
11894: }
11895: }
11896: &appenv({'request.ambiguous' => $thisfn});
11897: return $env{$cache_str}='';
11898: }
11899:
11900: # ---------------------------------------------------------- Return random seed
11901:
11902: sub numval {
11903: my $txt=shift;
11904: $txt=~tr/A-J/0-9/;
11905: $txt=~tr/a-j/0-9/;
11906: $txt=~tr/K-T/0-9/;
11907: $txt=~tr/k-t/0-9/;
11908: $txt=~tr/U-Z/0-5/;
11909: $txt=~tr/u-z/0-5/;
11910: $txt=~s/\D//g;
11911: if ($_64bit) { if ($txt > 2**32) { return -1; } }
11912: return int($txt);
11913: }
11914:
11915: sub numval2 {
11916: my $txt=shift;
11917: $txt=~tr/A-J/0-9/;
11918: $txt=~tr/a-j/0-9/;
11919: $txt=~tr/K-T/0-9/;
11920: $txt=~tr/k-t/0-9/;
11921: $txt=~tr/U-Z/0-5/;
11922: $txt=~tr/u-z/0-5/;
11923: $txt=~s/\D//g;
11924: my @txts=split(/(\d\d\d\d\d\d\d\d\d)/,$txt);
11925: my $total;
11926: foreach my $val (@txts) { $total+=$val; }
11927: if ($_64bit) { if ($total > 2**32) { return -1; } }
11928: return int($total);
11929: }
11930:
11931: sub numval3 {
11932: use integer;
11933: my $txt=shift;
11934: $txt=~tr/A-J/0-9/;
11935: $txt=~tr/a-j/0-9/;
11936: $txt=~tr/K-T/0-9/;
11937: $txt=~tr/k-t/0-9/;
11938: $txt=~tr/U-Z/0-5/;
11939: $txt=~tr/u-z/0-5/;
11940: $txt=~s/\D//g;
11941: my @txts=split(/(\d\d\d\d\d\d\d\d\d)/,$txt);
11942: my $total;
11943: foreach my $val (@txts) { $total+=$val; }
11944: if ($_64bit) { $total=(($total<<32)>>32); }
11945: return $total;
11946: }
11947:
11948: sub digest {
11949: my ($data)=@_;
11950: my $digest=&Digest::MD5::md5($data);
11951: my ($a,$b,$c,$d)=unpack("iiii",$digest);
11952: my ($e,$f);
11953: {
11954: use integer;
11955: $e=($a+$b);
11956: $f=($c+$d);
11957: if ($_64bit) {
11958: $e=(($e<<32)>>32);
11959: $f=(($f<<32)>>32);
11960: }
11961: }
11962: if (wantarray) {
11963: return ($e,$f);
11964: } else {
11965: my $g;
11966: {
11967: use integer;
11968: $g=($e+$f);
11969: if ($_64bit) {
11970: $g=(($g<<32)>>32);
11971: }
11972: }
11973: return $g;
11974: }
11975: }
11976:
11977: sub latest_rnd_algorithm_id {
11978: return '64bit5';
11979: }
11980:
11981: sub get_rand_alg {
11982: my ($courseid)=@_;
11983: if (!$courseid) { $courseid=(&whichuser())[1]; }
11984: if ($courseid) {
11985: return $env{"course.$courseid.rndseed"};
11986: }
11987: return &latest_rnd_algorithm_id();
11988: }
11989:
11990: sub validCODE {
11991: my ($CODE)=@_;
11992: if (defined($CODE) && $CODE ne '' && $CODE =~ /^\w+$/) { return 1; }
11993: return 0;
11994: }
11995:
11996: sub getCODE {
11997: if (&validCODE($env{'form.CODE'})) { return $env{'form.CODE'}; }
11998: if ( (defined($Apache::lonhomework::parsing_a_problem) ||
11999: defined($Apache::lonhomework::parsing_a_task) ) &&
12000: &validCODE($Apache::lonhomework::history{'resource.CODE'})) {
12001: return $Apache::lonhomework::history{'resource.CODE'};
12002: }
12003: return undef;
12004: }
12005: #
12006: # Determines the random seed for a specific context:
12007: #
12008: # parameters:
12009: # symb - in course context the symb for the seed.
12010: # course_id - The course id of the form domain_coursenum.
12011: # domain - Domain for the user.
12012: # course - Course for the user.
12013: # cenv - environment of the course.
12014: #
12015: # NOTE:
12016: # All parameters are picked out of the environment if missing
12017: # or not defined.
12018: # If a symb cannot be determined the current time is used instead.
12019: #
12020: # For a given well defined symb, courside, domain, username,
12021: # and course environment, the seed is reproducible.
12022: #
12023: sub rndseed {
12024: my ($symb,$courseid,$domain,$username, $cenv)=@_;
12025: my ($wsymb,$wcourseid,$wdomain,$wusername)=&whichuser();
12026: if (!defined($symb)) {
12027: unless ($symb=$wsymb) { return time; }
12028: }
12029: if (!defined $courseid) {
12030: $courseid=$wcourseid;
12031: }
12032: if (!defined $domain) { $domain=$wdomain; }
12033: if (!defined $username) { $username=$wusername }
12034:
12035: my $which;
12036: if (defined($cenv->{'rndseed'})) {
12037: $which = $cenv->{'rndseed'};
12038: } else {
12039: $which =&get_rand_alg($courseid);
12040: }
12041: if (defined(&getCODE())) {
12042:
12043: if ($which eq '64bit5') {
12044: return &rndseed_CODE_64bit5($symb,$courseid,$domain,$username);
12045: } elsif ($which eq '64bit4') {
12046: return &rndseed_CODE_64bit4($symb,$courseid,$domain,$username);
12047: } else {
12048: return &rndseed_CODE_64bit($symb,$courseid,$domain,$username);
12049: }
12050: } elsif ($which eq '64bit5') {
12051: return &rndseed_64bit5($symb,$courseid,$domain,$username);
12052: } elsif ($which eq '64bit4') {
12053: return &rndseed_64bit4($symb,$courseid,$domain,$username);
12054: } elsif ($which eq '64bit3') {
12055: return &rndseed_64bit3($symb,$courseid,$domain,$username);
12056: } elsif ($which eq '64bit2') {
12057: return &rndseed_64bit2($symb,$courseid,$domain,$username);
12058: } elsif ($which eq '64bit') {
12059: return &rndseed_64bit($symb,$courseid,$domain,$username);
12060: }
12061: return &rndseed_32bit($symb,$courseid,$domain,$username);
12062: }
12063:
12064: sub rndseed_32bit {
12065: my ($symb,$courseid,$domain,$username)=@_;
12066: {
12067: use integer;
12068: my $symbchck=unpack("%32C*",$symb) << 27;
12069: my $symbseed=numval($symb) << 22;
12070: my $namechck=unpack("%32C*",$username) << 17;
12071: my $nameseed=numval($username) << 12;
12072: my $domainseed=unpack("%32C*",$domain) << 7;
12073: my $courseseed=unpack("%32C*",$courseid);
12074: my $num=$symbseed+$nameseed+$domainseed+$courseseed+$namechck+$symbchck;
12075: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
12076: #&logthis("rndseed :$num:$symb");
12077: if ($_64bit) { $num=(($num<<32)>>32); }
12078: return $num;
12079: }
12080: }
12081:
12082: sub rndseed_64bit {
12083: my ($symb,$courseid,$domain,$username)=@_;
12084: {
12085: use integer;
12086: my $symbchck=unpack("%32S*",$symb) << 21;
12087: my $symbseed=numval($symb) << 10;
12088: my $namechck=unpack("%32S*",$username);
12089:
12090: my $nameseed=numval($username) << 21;
12091: my $domainseed=unpack("%32S*",$domain) << 10;
12092: my $courseseed=unpack("%32S*",$courseid);
12093:
12094: my $num1=$symbchck+$symbseed+$namechck;
12095: my $num2=$nameseed+$domainseed+$courseseed;
12096: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
12097: #&logthis("rndseed :$num:$symb");
12098: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
12099: return "$num1,$num2";
12100: }
12101: }
12102:
12103: sub rndseed_64bit2 {
12104: my ($symb,$courseid,$domain,$username)=@_;
12105: {
12106: use integer;
12107: # strings need to be an even # of cahracters long, it it is odd the
12108: # last characters gets thrown away
12109: my $symbchck=unpack("%32S*",$symb.' ') << 21;
12110: my $symbseed=numval($symb) << 10;
12111: my $namechck=unpack("%32S*",$username.' ');
12112:
12113: my $nameseed=numval($username) << 21;
12114: my $domainseed=unpack("%32S*",$domain.' ') << 10;
12115: my $courseseed=unpack("%32S*",$courseid.' ');
12116:
12117: my $num1=$symbchck+$symbseed+$namechck;
12118: my $num2=$nameseed+$domainseed+$courseseed;
12119: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
12120: #&logthis("rndseed :$num:$symb");
12121: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
12122: return "$num1,$num2";
12123: }
12124: }
12125:
12126: sub rndseed_64bit3 {
12127: my ($symb,$courseid,$domain,$username)=@_;
12128: {
12129: use integer;
12130: # strings need to be an even # of cahracters long, it it is odd the
12131: # last characters gets thrown away
12132: my $symbchck=unpack("%32S*",$symb.' ') << 21;
12133: my $symbseed=numval2($symb) << 10;
12134: my $namechck=unpack("%32S*",$username.' ');
12135:
12136: my $nameseed=numval2($username) << 21;
12137: my $domainseed=unpack("%32S*",$domain.' ') << 10;
12138: my $courseseed=unpack("%32S*",$courseid.' ');
12139:
12140: my $num1=$symbchck+$symbseed+$namechck;
12141: my $num2=$nameseed+$domainseed+$courseseed;
12142: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
12143: #&logthis("rndseed :$num1:$num2:$_64bit");
12144: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
12145:
12146: return "$num1:$num2";
12147: }
12148: }
12149:
12150: sub rndseed_64bit4 {
12151: my ($symb,$courseid,$domain,$username)=@_;
12152: {
12153: use integer;
12154: # strings need to be an even # of cahracters long, it it is odd the
12155: # last characters gets thrown away
12156: my $symbchck=unpack("%32S*",$symb.' ') << 21;
12157: my $symbseed=numval3($symb) << 10;
12158: my $namechck=unpack("%32S*",$username.' ');
12159:
12160: my $nameseed=numval3($username) << 21;
12161: my $domainseed=unpack("%32S*",$domain.' ') << 10;
12162: my $courseseed=unpack("%32S*",$courseid.' ');
12163:
12164: my $num1=$symbchck+$symbseed+$namechck;
12165: my $num2=$nameseed+$domainseed+$courseseed;
12166: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
12167: #&logthis("rndseed :$num1:$num2:$_64bit");
12168: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
12169:
12170: return "$num1:$num2";
12171: }
12172: }
12173:
12174: sub rndseed_64bit5 {
12175: my ($symb,$courseid,$domain,$username)=@_;
12176: my ($num1,$num2)=&digest("$symb,$courseid,$domain,$username");
12177: return "$num1:$num2";
12178: }
12179:
12180: sub rndseed_CODE_64bit {
12181: my ($symb,$courseid,$domain,$username)=@_;
12182: {
12183: use integer;
12184: my $symbchck=unpack("%32S*",$symb.' ') << 16;
12185: my $symbseed=numval2($symb);
12186: my $CODEchck=unpack("%32S*",&getCODE().' ') << 16;
12187: my $CODEseed=numval(&getCODE());
12188: my $courseseed=unpack("%32S*",$courseid.' ');
12189: my $num1=$symbseed+$CODEchck;
12190: my $num2=$CODEseed+$courseseed+$symbchck;
12191: #&logthis("$symbseed:$CODEchck|$CODEseed:$courseseed:$symbchck");
12192: #&logthis("rndseed :$num1:$num2:$symb");
12193: if ($_64bit) { $num1=(($num1<<32)>>32); }
12194: if ($_64bit) { $num2=(($num2<<32)>>32); }
12195: return "$num1:$num2";
12196: }
12197: }
12198:
12199: sub rndseed_CODE_64bit4 {
12200: my ($symb,$courseid,$domain,$username)=@_;
12201: {
12202: use integer;
12203: my $symbchck=unpack("%32S*",$symb.' ') << 16;
12204: my $symbseed=numval3($symb);
12205: my $CODEchck=unpack("%32S*",&getCODE().' ') << 16;
12206: my $CODEseed=numval3(&getCODE());
12207: my $courseseed=unpack("%32S*",$courseid.' ');
12208: my $num1=$symbseed+$CODEchck;
12209: my $num2=$CODEseed+$courseseed+$symbchck;
12210: #&logthis("$symbseed:$CODEchck|$CODEseed:$courseseed:$symbchck");
12211: #&logthis("rndseed :$num1:$num2:$symb");
12212: if ($_64bit) { $num1=(($num1<<32)>>32); }
12213: if ($_64bit) { $num2=(($num2<<32)>>32); }
12214: return "$num1:$num2";
12215: }
12216: }
12217:
12218: sub rndseed_CODE_64bit5 {
12219: my ($symb,$courseid,$domain,$username)=@_;
12220: my $code = &getCODE();
12221: my ($num1,$num2)=&digest("$symb,$courseid,$code");
12222: return "$num1:$num2";
12223: }
12224:
12225: sub setup_random_from_rndseed {
12226: my ($rndseed)=@_;
12227: if ($rndseed =~/([,:])/) {
12228: my ($num1,$num2) = map { abs($_); } (split(/[,:]/,$rndseed));
12229: if ((!$num1) || (!$num2) || ($num1 > 2147483562) || ($num2 > 2147483398)) {
12230: &Math::Random::random_set_seed_from_phrase($rndseed);
12231: } else {
12232: &Math::Random::random_set_seed($num1,$num2);
12233: }
12234: } else {
12235: &Math::Random::random_set_seed_from_phrase($rndseed);
12236: }
12237: }
12238:
12239: sub latest_receipt_algorithm_id {
12240: return 'receipt3';
12241: }
12242:
12243: sub recunique {
12244: my $fucourseid=shift;
12245: my $unique;
12246: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2' ||
12247: $env{"course.$fucourseid.receiptalg"} eq 'receipt3' ) {
12248: $unique=$env{"course.$fucourseid.internal.encseed"};
12249: } else {
12250: $unique=$perlvar{'lonReceipt'};
12251: }
12252: return unpack("%32C*",$unique);
12253: }
12254:
12255: sub recprefix {
12256: my $fucourseid=shift;
12257: my $prefix;
12258: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2'||
12259: $env{"course.$fucourseid.receiptalg"} eq 'receipt3' ) {
12260: $prefix=$env{"course.$fucourseid.internal.encpref"};
12261: } else {
12262: $prefix=$perlvar{'lonHostID'};
12263: }
12264: return unpack("%32C*",$prefix);
12265: }
12266:
12267: sub ireceipt {
12268: my ($funame,$fudom,$fucourseid,$fusymb,$part)=@_;
12269:
12270: my $return =&recprefix($fucourseid).'-';
12271:
12272: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt3' ||
12273: $env{'request.state'} eq 'construct') {
12274: $return .= (&digest("$funame,$fudom,$fucourseid,$fusymb,$part")%10000);
12275: return $return;
12276: }
12277:
12278: my $cuname=unpack("%32C*",$funame);
12279: my $cudom=unpack("%32C*",$fudom);
12280: my $cucourseid=unpack("%32C*",$fucourseid);
12281: my $cusymb=unpack("%32C*",$fusymb);
12282: my $cunique=&recunique($fucourseid);
12283: my $cpart=unpack("%32S*",$part);
12284: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2') {
12285:
12286: #&logthis("doing receipt2 using parts $cpart, uname $cuname and udom $cudom gets ".($cpart%$cuname)." and ".($cpart%$cudom));
12287:
12288: $return.= ($cunique%$cuname+
12289: $cunique%$cudom+
12290: $cusymb%$cuname+
12291: $cusymb%$cudom+
12292: $cucourseid%$cuname+
12293: $cucourseid%$cudom+
12294: $cpart%$cuname+
12295: $cpart%$cudom);
12296: } else {
12297: $return.= ($cunique%$cuname+
12298: $cunique%$cudom+
12299: $cusymb%$cuname+
12300: $cusymb%$cudom+
12301: $cucourseid%$cuname+
12302: $cucourseid%$cudom);
12303: }
12304: return $return;
12305: }
12306:
12307: sub receipt {
12308: my ($part)=@_;
12309: my ($symb,$courseid,$domain,$name) = &whichuser();
12310: return &ireceipt($name,$domain,$courseid,$symb,$part);
12311: }
12312:
12313: sub whichuser {
12314: my ($passedsymb)=@_;
12315: my ($symb,$courseid,$domain,$name,$publicuser);
12316: if (defined($env{'form.grade_symb'})) {
12317: my ($tmp_courseid)=&get_env_multiple('form.grade_courseid');
12318: my $allowed=&allowed('vgr',$tmp_courseid);
12319: if (!$allowed &&
12320: exists($env{'request.course.sec'}) &&
12321: $env{'request.course.sec'} !~ /^\s*$/) {
12322: $allowed=&allowed('vgr',$tmp_courseid.
12323: '/'.$env{'request.course.sec'});
12324: }
12325: if ($allowed) {
12326: ($symb)=&get_env_multiple('form.grade_symb');
12327: $courseid=$tmp_courseid;
12328: ($domain)=&get_env_multiple('form.grade_domain');
12329: ($name)=&get_env_multiple('form.grade_username');
12330: return ($symb,$courseid,$domain,$name,$publicuser);
12331: }
12332: }
12333: if (!$passedsymb) {
12334: $symb=&symbread();
12335: } else {
12336: $symb=$passedsymb;
12337: }
12338: $courseid=$env{'request.course.id'};
12339: $domain=$env{'user.domain'};
12340: $name=$env{'user.name'};
12341: if ($name eq 'public' && $domain eq 'public') {
12342: if (!defined($env{'form.username'})) {
12343: $env{'form.username'}.=time.rand(10000000);
12344: }
12345: $name.=$env{'form.username'};
12346: }
12347: return ($symb,$courseid,$domain,$name,$publicuser);
12348:
12349: }
12350:
12351: # ------------------------------------------------------------ Serves up a file
12352: # returns either the contents of the file or
12353: # -1 if the file doesn't exist
12354: #
12355: # if the target is a file that was uploaded via DOCS,
12356: # a check will be made to see if a current copy exists on the local server,
12357: # if it does this will be served, otherwise a copy will be retrieved from
12358: # the home server for the course and stored in /home/httpd/html/userfiles on
12359: # the local server.
12360:
12361: sub getfile {
12362: my ($file) = @_;
12363: if ($file =~ m -^/*(uploaded|editupload)/-) { $file=&filelocation("",$file); }
12364: &repcopy($file);
12365: return &readfile($file);
12366: }
12367:
12368: sub repcopy_userfile {
12369: my ($file)=@_;
12370: my $londocroot = $perlvar{'lonDocRoot'};
12371: if ($file =~ m{^/*(uploaded|editupload)/}) { $file=&filelocation("",$file); }
12372: if ($file =~ m{^\Q/home/httpd/lonUsers/\E}) { return 'ok'; }
12373: my ($cdom,$cnum,$filename) =
12374: ($file=~m|^\Q$perlvar{'lonDocRoot'}\E/+userfiles/+($match_domain)/+($match_name)/+(.*)|);
12375: my $uri="/uploaded/$cdom/$cnum/$filename";
12376: if (-e "$file") {
12377: # we already have a local copy, check it out
12378: my @fileinfo = stat($file);
12379: my $rtncode;
12380: my $info;
12381: my $lwpresp = &getuploaded('HEAD',$uri,$cdom,$cnum,\$info,\$rtncode);
12382: if ($lwpresp ne 'ok') {
12383: # there is no such file anymore, even though we had a local copy
12384: if ($rtncode eq '404') {
12385: unlink($file);
12386: }
12387: return -1;
12388: }
12389: if ($info < $fileinfo[9]) {
12390: # nice, the file we have is up-to-date, just say okay
12391: return 'ok';
12392: } else {
12393: # the file is outdated, get rid of it
12394: unlink($file);
12395: }
12396: }
12397: # one way or the other, at this point, we don't have the file
12398: # construct the correct path for the file
12399: my @parts = ($cdom,$cnum);
12400: if ($filename =~ m|^(.+)/[^/]+$|) {
12401: push @parts, split(/\//,$1);
12402: }
12403: my $path = $perlvar{'lonDocRoot'}.'/userfiles';
12404: foreach my $part (@parts) {
12405: $path .= '/'.$part;
12406: if (!-e $path) {
12407: mkdir($path,0770);
12408: }
12409: }
12410: # now the path exists for sure
12411: # get a user agent
12412: my $ua=new LWP::UserAgent;
12413: my $transferfile=$file.'.in.transfer';
12414: # FIXME: this should flock
12415: if (-e $transferfile) { return 'ok'; }
12416: my $request;
12417: $uri=~s/^\///;
12418: my $homeserver = &homeserver($cnum,$cdom);
12419: my $protocol = $protocol{$homeserver};
12420: $protocol = 'http' if ($protocol ne 'https');
12421: $request=new HTTP::Request('GET',$protocol.'://'.&hostname($homeserver).'/raw/'.$uri);
12422: my $response=$ua->request($request,$transferfile);
12423: # did it work?
12424: if ($response->is_error()) {
12425: unlink($transferfile);
12426: &logthis("Userfile repcopy failed for $uri");
12427: return -1;
12428: }
12429: # worked, rename the transfer file
12430: rename($transferfile,$file);
12431: return 'ok';
12432: }
12433:
12434: sub tokenwrapper {
12435: my $uri=shift;
12436: $uri=~s|^https?\://([^/]+)||;
12437: $uri=~s|^/||;
12438: $env{'user.environment'}=~/\/([^\/]+)\.id/;
12439: my $token=$1;
12440: my (undef,$udom,$uname,$file)=split('/',$uri,4);
12441: if ($udom && $uname && $file) {
12442: $file=~s|(\?\.*)*$||;
12443: &appenv({"userfile.$udom/$uname/$file" => $env{'request.course.id'}});
12444: my $homeserver = &homeserver($uname,$udom);
12445: my $protocol = $protocol{$homeserver};
12446: $protocol = 'http' if ($protocol ne 'https');
12447: return $protocol.'://'.&hostname($homeserver).'/'.$uri.
12448: (($uri=~/\?/)?'&':'?').'token='.$token.
12449: '&tokenissued='.$perlvar{'lonHostID'};
12450: } else {
12451: return '/adm/notfound.html';
12452: }
12453: }
12454:
12455: # call with reqtype HEAD: get last modification time
12456: # call with reqtype GET: get the file contents
12457: # Do not call this with reqtype GET for large files! It loads everything into memory
12458: #
12459: sub getuploaded {
12460: my ($reqtype,$uri,$cdom,$cnum,$info,$rtncode) = @_;
12461: $uri=~s/^\///;
12462: my $homeserver = &homeserver($cnum,$cdom);
12463: my $protocol = $protocol{$homeserver};
12464: $protocol = 'http' if ($protocol ne 'https');
12465: $uri = $protocol.'://'.&hostname($homeserver).'/raw/'.$uri;
12466: my $ua=new LWP::UserAgent;
12467: my $request=new HTTP::Request($reqtype,$uri);
12468: my $response=$ua->request($request);
12469: $$rtncode = $response->code;
12470: if (! $response->is_success()) {
12471: return 'failed';
12472: }
12473: if ($reqtype eq 'HEAD') {
12474: $$info = &HTTP::Date::str2time( $response->header('Last-modified') );
12475: } elsif ($reqtype eq 'GET') {
12476: $$info = $response->content;
12477: }
12478: return 'ok';
12479: }
12480:
12481: sub readfile {
12482: my $file = shift;
12483: if ( (! -e $file ) || ($file eq '') ) { return -1; };
12484: my $fh;
12485: open($fh,"<$file");
12486: my $a='';
12487: while (my $line = <$fh>) { $a .= $line; }
12488: return $a;
12489: }
12490:
12491: sub filelocation {
12492: my ($dir,$file) = @_;
12493: my $location;
12494: $file=~ s/^\s*(\S+)\s*$/$1/; ## strip off leading and trailing spaces
12495:
12496: if ($file =~ m-^/adm/-) {
12497: $file=~s-^/adm/wrapper/-/-;
12498: $file=~s-^/adm/coursedocs/showdoc/-/-;
12499: }
12500:
12501: if ($file =~ m-^\Q$Apache::lonnet::perlvar{'lonTabDir'}\E/-) {
12502: $location = $file;
12503: } elsif ($file=~/^\/*(uploaded|editupload)/) { # is an uploaded file
12504: my ($udom,$uname,$filename)=
12505: ($file=~m -^/+(?:uploaded|editupload)/+($match_domain)/+($match_name)/+(.*)$-);
12506: my $home=&homeserver($uname,$udom);
12507: my $is_me=0;
12508: my @ids=¤t_machine_ids();
12509: foreach my $id (@ids) { if ($id eq $home) { $is_me=1; } }
12510: if ($is_me) {
12511: $location=propath($udom,$uname).'/userfiles/'.$filename;
12512: } else {
12513: $location=$Apache::lonnet::perlvar{'lonDocRoot'}.'/userfiles/'.
12514: $udom.'/'.$uname.'/'.$filename;
12515: }
12516: } elsif ($file =~ m-^/adm/-) {
12517: $location = $perlvar{'lonDocRoot'}.'/'.$file;
12518: } else {
12519: $file=~s/^\Q$perlvar{'lonDocRoot'}\E//;
12520: $file=~s:^/(res|priv)/:/:;
12521: my $space=$1;
12522: if ( !( $file =~ m:^/:) ) {
12523: $location = $dir. '/'.$file;
12524: } else {
12525: $location = $perlvar{'lonDocRoot'}.'/'.$space.$file;
12526: }
12527: }
12528: $location=~s://+:/:g; # remove duplicate /
12529: while ($location=~m{/\.\./}) {
12530: if ($location =~ m{/[^/]+/\.\./}) {
12531: $location=~ s{/[^/]+/\.\./}{/}g;
12532: } else {
12533: $location=~ s{/\.\./}{/}g;
12534: }
12535: } #remove dir/..
12536: while ($location=~m:/\./:) {$location=~ s:/\./:/:g;} #remove /./
12537: return $location;
12538: }
12539:
12540: sub hreflocation {
12541: my ($dir,$file)=@_;
12542: unless (($file=~m-^https?\://-i) || ($file=~m-^/-)) {
12543: $file=filelocation($dir,$file);
12544: } elsif ($file=~m-^/adm/-) {
12545: $file=~s-^/adm/wrapper/-/-;
12546: $file=~s-^/adm/coursedocs/showdoc/-/-;
12547: }
12548: if ($file=~m-^\Q$perlvar{'lonDocRoot'}\E-) {
12549: $file=~s-^\Q$perlvar{'lonDocRoot'}\E--;
12550: } elsif ($file=~m-^\Q$perlvar{'lonUsersDir'}\E-) {
12551: $file=~s{^/home/httpd/lonUsers/($match_domain)/./././($match_name)/userfiles/}
12552: {/uploaded/$1/$2/}x;
12553: }
12554: if ($file=~ m{^/userfiles/}) {
12555: $file =~ s{^/userfiles/}{/uploaded/};
12556: }
12557: return $file;
12558: }
12559:
12560:
12561:
12562:
12563:
12564: sub current_machine_domains {
12565: return &machine_domains(&hostname($perlvar{'lonHostID'}));
12566: }
12567:
12568: sub machine_domains {
12569: my ($hostname) = @_;
12570: my @domains;
12571: my %hostname = &all_hostnames();
12572: while( my($id, $name) = each(%hostname)) {
12573: # &logthis("-$id-$name-$hostname-");
12574: if ($hostname eq $name) {
12575: push(@domains,&host_domain($id));
12576: }
12577: }
12578: return @domains;
12579: }
12580:
12581: sub current_machine_ids {
12582: return &machine_ids(&hostname($perlvar{'lonHostID'}));
12583: }
12584:
12585: sub machine_ids {
12586: my ($hostname) = @_;
12587: $hostname ||= &hostname($perlvar{'lonHostID'});
12588: my @ids;
12589: my %name_to_host = &all_names();
12590: if (ref($name_to_host{$hostname}) eq 'ARRAY') {
12591: return @{ $name_to_host{$hostname} };
12592: }
12593: return;
12594: }
12595:
12596: sub additional_machine_domains {
12597: my @domains;
12598: open(my $fh,"<$perlvar{'lonTabDir'}/expected_domains.tab");
12599: while( my $line = <$fh>) {
12600: $line =~ s/\s//g;
12601: push(@domains,$line);
12602: }
12603: return @domains;
12604: }
12605:
12606: sub default_login_domain {
12607: my $domain = $perlvar{'lonDefDomain'};
12608: my $testdomain=(split(/\./,$ENV{'HTTP_HOST'}))[0];
12609: foreach my $posdom (¤t_machine_domains(),
12610: &additional_machine_domains()) {
12611: if (lc($posdom) eq lc($testdomain)) {
12612: $domain=$posdom;
12613: last;
12614: }
12615: }
12616: return $domain;
12617: }
12618:
12619: # ------------------------------------------------------------- Declutters URLs
12620:
12621: sub declutter {
12622: my $thisfn=shift;
12623: if ($thisfn=~m|^/enc/|) { $thisfn=&Apache::lonenc::unencrypted($thisfn); }
12624: unless ($thisfn=~m{^/home/httpd/html/priv/}) {
12625: $thisfn=~s{^/home/httpd/html}{};
12626: }
12627: $thisfn=~s/^\///;
12628: $thisfn=~s|^adm/wrapper/||;
12629: $thisfn=~s|^adm/coursedocs/showdoc/||;
12630: $thisfn=~s/^res\///;
12631: $thisfn=~s/^priv\///;
12632: unless (($thisfn =~ /^ext/) || ($thisfn =~ /\.(page|sequence)___\d+___ext/)) {
12633: $thisfn=~s/\?.+$//;
12634: }
12635: return $thisfn;
12636: }
12637:
12638: # ------------------------------------------------------------- Clutter up URLs
12639:
12640: sub clutter {
12641: my $thisfn='/'.&declutter(shift);
12642: if ($thisfn !~ m{^/(uploaded|editupload|adm|userfiles|ext|raw|priv|public)/}
12643: || $thisfn =~ m{^/adm/(includes|pages)} ) {
12644: $thisfn='/res'.$thisfn;
12645: }
12646: if ($thisfn !~m|^/adm|) {
12647: if ($thisfn =~ m|^/ext/|) {
12648: $thisfn='/adm/wrapper'.$thisfn;
12649: } else {
12650: my ($ext) = ($thisfn =~ /\.(\w+)$/);
12651: my $embstyle=&Apache::loncommon::fileembstyle($ext);
12652: if ($embstyle eq 'ssi'
12653: || ($embstyle eq 'hdn')
12654: || ($embstyle eq 'rat')
12655: || ($embstyle eq 'prv')
12656: || ($embstyle eq 'ign')) {
12657: #do nothing with these
12658: } elsif (($embstyle eq 'img')
12659: || ($embstyle eq 'emb')
12660: || ($embstyle eq 'wrp')) {
12661: $thisfn='/adm/wrapper'.$thisfn;
12662: } elsif ($embstyle eq 'unk'
12663: && $thisfn!~/\.(sequence|page)$/) {
12664: $thisfn='/adm/coursedocs/showdoc'.$thisfn;
12665: } else {
12666: # &logthis("Got a blank emb style");
12667: }
12668: }
12669: } elsif ($thisfn =~ m{^/adm/$match_domain/$match_courseid/\d+/exttools?$}) {
12670: $thisfn='/adm/wrapper'.$thisfn;
12671: }
12672: return $thisfn;
12673: }
12674:
12675: sub clutter_with_no_wrapper {
12676: my $uri = &clutter(shift);
12677: if ($uri =~ m-^/adm/-) {
12678: $uri =~ s-^/adm/wrapper/-/-;
12679: $uri =~ s-^/adm/coursedocs/showdoc/-/-;
12680: }
12681: return $uri;
12682: }
12683:
12684: sub freeze_escape {
12685: my ($value)=@_;
12686: if (ref($value)) {
12687: $value=&nfreeze($value);
12688: return '__FROZEN__'.&escape($value);
12689: }
12690: return &escape($value);
12691: }
12692:
12693:
12694: sub thaw_unescape {
12695: my ($value)=@_;
12696: if ($value =~ /^__FROZEN__/) {
12697: substr($value,0,10,undef);
12698: $value=&unescape($value);
12699: return &thaw($value);
12700: }
12701: return &unescape($value);
12702: }
12703:
12704: sub correct_line_ends {
12705: my ($result)=@_;
12706: $$result =~s/\r\n/\n/mg;
12707: $$result =~s/\r/\n/mg;
12708: }
12709: # ================================================================ Main Program
12710:
12711: sub goodbye {
12712: &logthis("Starting Shut down");
12713: #not converted to using infrastruture and probably shouldn't be
12714: &logthis(sprintf("%-20s is %s",'%badServerCache',length(&nfreeze(\%badServerCache))));
12715: #converted
12716: # &logthis(sprintf("%-20s is %s",'%metacache',scalar(%metacache)));
12717: &logthis(sprintf("%-20s is %s",'%homecache',length(&nfreeze(\%homecache))));
12718: # &logthis(sprintf("%-20s is %s",'%titlecache',length(&nfreeze(\%titlecache))));
12719: # &logthis(sprintf("%-20s is %s",'%courseresdatacache',length(&nfreeze(\%courseresdatacache))));
12720: #1.1 only
12721: # &logthis(sprintf("%-20s is %s",'%userresdatacache',length(&nfreeze(\%userresdatacache))));
12722: # &logthis(sprintf("%-20s is %s",'%getsectioncache',length(&nfreeze(\%getsectioncache))));
12723: # &logthis(sprintf("%-20s is %s",'%courseresversioncache',length(&nfreeze(\%courseresversioncache))));
12724: # &logthis(sprintf("%-20s is %s",'%resversioncache',length(&nfreeze(\%resversioncache))));
12725: &logthis(sprintf("%-20s is %s",'%remembered',length(&nfreeze(\%remembered))));
12726: &logthis(sprintf("%-20s is %s",'kicks',$kicks));
12727: &logthis(sprintf("%-20s is %s",'hits',$hits));
12728: &flushcourselogs();
12729: &logthis("Shutting down");
12730: }
12731:
12732: sub get_dns {
12733: my ($url,$func,$ignore_cache,$nocache,$hashref) = @_;
12734: if (!$ignore_cache) {
12735: my ($content,$cached)=
12736: &Apache::lonnet::is_cached_new('dns',$url);
12737: if ($cached) {
12738: &$func($content,$hashref);
12739: return;
12740: }
12741: }
12742:
12743: my %alldns;
12744: open(my $config,"<$perlvar{'lonTabDir'}/hosts.tab");
12745: foreach my $dns (<$config>) {
12746: next if ($dns !~ /^\^(\S*)/x);
12747: my $line = $1;
12748: my ($host,$protocol) = split(/:/,$line);
12749: if ($protocol ne 'https') {
12750: $protocol = 'http';
12751: }
12752: $alldns{$host} = $protocol;
12753: }
12754: while (%alldns) {
12755: my ($dns) = sort { $b cmp $a } keys(%alldns);
12756: my $ua=new LWP::UserAgent;
12757: $ua->timeout(30);
12758: my $request=new HTTP::Request('GET',"$alldns{$dns}://$dns$url");
12759: my $response=$ua->request($request);
12760: delete($alldns{$dns});
12761: next if ($response->is_error());
12762: my @content = split("\n",$response->content);
12763: unless ($nocache) {
12764: &do_cache_new('dns',$url,\@content,30*24*60*60);
12765: }
12766: &$func(\@content,$hashref);
12767: return;
12768: }
12769: close($config);
12770: my $which = (split('/',$url))[3];
12771: &logthis("unable to contact DNS defaulting to on disk file dns_$which.tab\n");
12772: open($config,"<$perlvar{'lonTabDir'}/dns_$which.tab");
12773: my @content = <$config>;
12774: &$func(\@content,$hashref);
12775: return;
12776: }
12777:
12778: # ------------------------------------------------------Get DNS checksums file
12779: sub parse_dns_checksums_tab {
12780: my ($lines,$hashref) = @_;
12781: my $lonhost = $perlvar{'lonHostID'};
12782: my $machine_dom = &Apache::lonnet::host_domain($lonhost);
12783: my $loncaparev = &get_server_loncaparev($machine_dom);
12784: my $distro = (split(/\:/,&get_server_distarch($lonhost)))[0];
12785: my $webconfdir = '/etc/httpd/conf';
12786: if ($distro =~ /^(ubuntu|debian)(\d+)$/) {
12787: $webconfdir = '/etc/apache2';
12788: } elsif ($distro =~ /^sles(\d+)$/) {
12789: if ($1 >= 10) {
12790: $webconfdir = '/etc/apache2';
12791: }
12792: } elsif ($distro =~ /^suse(\d+\.\d+)$/) {
12793: if ($1 >= 10.0) {
12794: $webconfdir = '/etc/apache2';
12795: }
12796: }
12797: my ($release,$timestamp) = split(/\-/,$loncaparev);
12798: my (%chksum,%revnum);
12799: if (ref($lines) eq 'ARRAY') {
12800: chomp(@{$lines});
12801: my $version = shift(@{$lines});
12802: if ($version eq $release) {
12803: foreach my $line (@{$lines}) {
12804: my ($file,$version,$shasum) = split(/,/,$line);
12805: if ($file =~ m{^/etc/httpd/conf}) {
12806: if ($webconfdir eq '/etc/apache2') {
12807: $file =~ s{^\Q/etc/httpd/conf/\E}{$webconfdir/};
12808: }
12809: }
12810: $chksum{$file} = $shasum;
12811: $revnum{$file} = $version;
12812: }
12813: if (ref($hashref) eq 'HASH') {
12814: %{$hashref} = (
12815: sums => \%chksum,
12816: versions => \%revnum,
12817: );
12818: }
12819: }
12820: }
12821: return;
12822: }
12823:
12824: sub fetch_dns_checksums {
12825: my %checksums;
12826: my $machine_dom = &Apache::lonnet::host_domain($perlvar{'lonHostID'});
12827: my $loncaparev = &get_server_loncaparev($machine_dom,$perlvar{'lonHostID'});
12828: my ($release,$timestamp) = split(/\-/,$loncaparev);
12829: &get_dns("/adm/dns/checksums/$release",\&parse_dns_checksums_tab,1,1,
12830: \%checksums);
12831: return \%checksums;
12832: }
12833:
12834: # ------------------------------------------------------------ Read domain file
12835: {
12836: my $loaded;
12837: my %domain;
12838:
12839: sub parse_domain_tab {
12840: my ($lines) = @_;
12841: foreach my $line (@$lines) {
12842: next if ($line =~ /^(\#|\s*$ )/x);
12843:
12844: chomp($line);
12845: my ($name,@elements) = split(/:/,$line,9);
12846: my %this_domain;
12847: foreach my $field ('description', 'auth_def', 'auth_arg_def',
12848: 'lang_def', 'city', 'longi', 'lati',
12849: 'primary') {
12850: $this_domain{$field} = shift(@elements);
12851: }
12852: $domain{$name} = \%this_domain;
12853: }
12854: }
12855:
12856: sub reset_domain_info {
12857: undef($loaded);
12858: undef(%domain);
12859: }
12860:
12861: sub load_domain_tab {
12862: my ($ignore_cache,$nocache) = @_;
12863: &get_dns('/adm/dns/domain',\&parse_domain_tab,$ignore_cache,$nocache);
12864: my $fh;
12865: if (open($fh,"<".$perlvar{'lonTabDir'}.'/domain.tab')) {
12866: my @lines = <$fh>;
12867: &parse_domain_tab(\@lines);
12868: }
12869: close($fh);
12870: $loaded = 1;
12871: }
12872:
12873: sub domain {
12874: &load_domain_tab() if (!$loaded);
12875:
12876: my ($name,$what) = @_;
12877: return if ( !exists($domain{$name}) );
12878:
12879: if (!$what) {
12880: return $domain{$name}{'description'};
12881: }
12882: return $domain{$name}{$what};
12883: }
12884:
12885: sub domain_info {
12886: &load_domain_tab() if (!$loaded);
12887: return %domain;
12888: }
12889:
12890: }
12891:
12892:
12893: # ------------------------------------------------------------- Read hosts file
12894: {
12895: my %hostname;
12896: my %hostdom;
12897: my %libserv;
12898: my $loaded;
12899: my %name_to_host;
12900: my %internetdom;
12901: my %LC_dns_serv;
12902:
12903: sub parse_hosts_tab {
12904: my ($file) = @_;
12905: foreach my $configline (@$file) {
12906: next if ($configline =~ /^(\#|\s*$ )/x);
12907: chomp($configline);
12908: if ($configline =~ /^\^/) {
12909: if ($configline =~ /^\^([\w.\-]+)/) {
12910: $LC_dns_serv{$1} = 1;
12911: }
12912: next;
12913: }
12914: my ($id,$domain,$role,$name,$protocol,$intdom)=split(/:/,$configline);
12915: $name=~s/\s//g;
12916: if ($id && $domain && $role && $name) {
12917: $hostname{$id}=$name;
12918: push(@{$name_to_host{$name}}, $id);
12919: $hostdom{$id}=$domain;
12920: if ($role eq 'library') { $libserv{$id}=$name; }
12921: if (defined($protocol)) {
12922: if ($protocol eq 'https') {
12923: $protocol{$id} = $protocol;
12924: } else {
12925: $protocol{$id} = 'http';
12926: }
12927: } else {
12928: $protocol{$id} = 'http';
12929: }
12930: if (defined($intdom)) {
12931: $internetdom{$id} = $intdom;
12932: }
12933: }
12934: }
12935: }
12936:
12937: sub reset_hosts_info {
12938: &purge_remembered();
12939: &reset_domain_info();
12940: &reset_hosts_ip_info();
12941: undef(%name_to_host);
12942: undef(%hostname);
12943: undef(%hostdom);
12944: undef(%libserv);
12945: undef($loaded);
12946: }
12947:
12948: sub load_hosts_tab {
12949: my ($ignore_cache,$nocache) = @_;
12950: &get_dns('/adm/dns/hosts',\&parse_hosts_tab,$ignore_cache,$nocache);
12951: open(my $config,"<$perlvar{'lonTabDir'}/hosts.tab");
12952: my @config = <$config>;
12953: &parse_hosts_tab(\@config);
12954: close($config);
12955: $loaded=1;
12956: }
12957:
12958: sub hostname {
12959: &load_hosts_tab() if (!$loaded);
12960:
12961: my ($lonid) = @_;
12962: return $hostname{$lonid};
12963: }
12964:
12965: sub all_hostnames {
12966: &load_hosts_tab() if (!$loaded);
12967:
12968: return %hostname;
12969: }
12970:
12971: sub all_names {
12972: my ($ignore_cache,$nocache) = @_;
12973: &load_hosts_tab($ignore_cache,$nocache) if (!$loaded);
12974:
12975: return %name_to_host;
12976: }
12977:
12978: sub all_host_domain {
12979: &load_hosts_tab() if (!$loaded);
12980: return %hostdom;
12981: }
12982:
12983: sub is_library {
12984: &load_hosts_tab() if (!$loaded);
12985:
12986: return exists($libserv{$_[0]});
12987: }
12988:
12989: sub all_library {
12990: &load_hosts_tab() if (!$loaded);
12991:
12992: return %libserv;
12993: }
12994:
12995: sub unique_library {
12996: #2x reverse removes all hostnames that appear more than once
12997: my %unique = reverse &all_library();
12998: return reverse %unique;
12999: }
13000:
13001: sub get_servers {
13002: &load_hosts_tab() if (!$loaded);
13003:
13004: my ($domain,$type) = @_;
13005: my %possible_hosts = ($type eq 'library') ? %libserv
13006: : %hostname;
13007: my %result;
13008: if (ref($domain) eq 'ARRAY') {
13009: while ( my ($host,$hostname) = each(%possible_hosts)) {
13010: if (grep(/^\Q$hostdom{$host}\E$/,@$domain)) {
13011: $result{$host} = $hostname;
13012: }
13013: }
13014: } else {
13015: while ( my ($host,$hostname) = each(%possible_hosts)) {
13016: if ($hostdom{$host} eq $domain) {
13017: $result{$host} = $hostname;
13018: }
13019: }
13020: }
13021: return %result;
13022: }
13023:
13024: sub get_unique_servers {
13025: my %unique = reverse &get_servers(@_);
13026: return reverse %unique;
13027: }
13028:
13029: sub host_domain {
13030: &load_hosts_tab() if (!$loaded);
13031:
13032: my ($lonid) = @_;
13033: return $hostdom{$lonid};
13034: }
13035:
13036: sub all_domains {
13037: &load_hosts_tab() if (!$loaded);
13038:
13039: my %seen;
13040: my @uniq = grep(!$seen{$_}++, values(%hostdom));
13041: return @uniq;
13042: }
13043:
13044: sub internet_dom {
13045: &load_hosts_tab() if (!$loaded);
13046:
13047: my ($lonid) = @_;
13048: return $internetdom{$lonid};
13049: }
13050:
13051: sub is_LC_dns {
13052: &load_hosts_tab() if (!$loaded);
13053:
13054: my ($hostname) = @_;
13055: return exists($LC_dns_serv{$hostname});
13056: }
13057:
13058: }
13059:
13060: {
13061: my %iphost;
13062: my %name_to_ip;
13063: my %lonid_to_ip;
13064:
13065: sub get_hosts_from_ip {
13066: my ($ip) = @_;
13067: my %iphosts = &get_iphost();
13068: if (ref($iphosts{$ip})) {
13069: return @{$iphosts{$ip}};
13070: }
13071: return;
13072: }
13073:
13074: sub reset_hosts_ip_info {
13075: undef(%iphost);
13076: undef(%name_to_ip);
13077: undef(%lonid_to_ip);
13078: }
13079:
13080: sub get_host_ip {
13081: my ($lonid) = @_;
13082: if (exists($lonid_to_ip{$lonid})) {
13083: return $lonid_to_ip{$lonid};
13084: }
13085: my $name=&hostname($lonid);
13086: my $ip = gethostbyname($name);
13087: return if (!$ip || length($ip) ne 4);
13088: $ip=inet_ntoa($ip);
13089: $name_to_ip{$name} = $ip;
13090: $lonid_to_ip{$lonid} = $ip;
13091: return $ip;
13092: }
13093:
13094: sub get_iphost {
13095: my ($ignore_cache,$nocache) = @_;
13096:
13097: if (!$ignore_cache) {
13098: if (%iphost) {
13099: return %iphost;
13100: }
13101: my ($ip_info,$cached)=
13102: &Apache::lonnet::is_cached_new('iphost','iphost');
13103: if ($cached) {
13104: %iphost = %{$ip_info->[0]};
13105: %name_to_ip = %{$ip_info->[1]};
13106: %lonid_to_ip = %{$ip_info->[2]};
13107: return %iphost;
13108: }
13109: }
13110:
13111: # get yesterday's info for fallback
13112: my %old_name_to_ip;
13113: my ($ip_info,$cached)=
13114: &Apache::lonnet::is_cached_new('iphost','iphost');
13115: if ($cached) {
13116: %old_name_to_ip = %{$ip_info->[1]};
13117: }
13118:
13119: my %name_to_host = &all_names($ignore_cache,$nocache);
13120: foreach my $name (keys(%name_to_host)) {
13121: my $ip;
13122: if (!exists($name_to_ip{$name})) {
13123: $ip = gethostbyname($name);
13124: if (!$ip || length($ip) ne 4) {
13125: if (defined($old_name_to_ip{$name})) {
13126: $ip = $old_name_to_ip{$name};
13127: &logthis("Can't find $name defaulting to old $ip");
13128: } else {
13129: &logthis("Name $name no IP found");
13130: next;
13131: }
13132: } else {
13133: $ip=inet_ntoa($ip);
13134: }
13135: $name_to_ip{$name} = $ip;
13136: } else {
13137: $ip = $name_to_ip{$name};
13138: }
13139: foreach my $id (@{ $name_to_host{$name} }) {
13140: $lonid_to_ip{$id} = $ip;
13141: }
13142: push(@{$iphost{$ip}},@{$name_to_host{$name}});
13143: }
13144: unless ($nocache) {
13145: &do_cache_new('iphost','iphost',
13146: [\%iphost,\%name_to_ip,\%lonid_to_ip],
13147: 48*60*60);
13148: }
13149:
13150: return %iphost;
13151: }
13152:
13153: #
13154: # Given a DNS returns the loncapa host name for that DNS
13155: #
13156: sub host_from_dns {
13157: my ($dns) = @_;
13158: my @hosts;
13159: my $ip;
13160:
13161: if (exists($name_to_ip{$dns})) {
13162: $ip = $name_to_ip{$dns};
13163: }
13164: if (!$ip) {
13165: $ip = gethostbyname($dns); # Initial translation to IP is in net order.
13166: if (length($ip) == 4) {
13167: $ip = &IO::Socket::inet_ntoa($ip);
13168: }
13169: }
13170: if ($ip) {
13171: @hosts = get_hosts_from_ip($ip);
13172: return $hosts[0];
13173: }
13174: return undef;
13175: }
13176:
13177: sub get_internet_names {
13178: my ($lonid) = @_;
13179: return if ($lonid eq '');
13180: my ($idnref,$cached)=
13181: &Apache::lonnet::is_cached_new('internetnames',$lonid);
13182: if ($cached) {
13183: return $idnref;
13184: }
13185: my $ip = &get_host_ip($lonid);
13186: my @hosts = &get_hosts_from_ip($ip);
13187: my %iphost = &get_iphost();
13188: my (@idns,%seen);
13189: foreach my $id (@hosts) {
13190: my $dom = &host_domain($id);
13191: my $prim_id = &domain($dom,'primary');
13192: my $prim_ip = &get_host_ip($prim_id);
13193: next if ($seen{$prim_ip});
13194: if (ref($iphost{$prim_ip}) eq 'ARRAY') {
13195: foreach my $id (@{$iphost{$prim_ip}}) {
13196: my $intdom = &internet_dom($id);
13197: unless (grep(/^\Q$intdom\E$/,@idns)) {
13198: push(@idns,$intdom);
13199: }
13200: }
13201: }
13202: $seen{$prim_ip} = 1;
13203: }
13204: return &do_cache_new('internetnames',$lonid,\@idns,12*60*60);
13205: }
13206:
13207: }
13208:
13209: sub all_loncaparevs {
13210: 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);
13211: }
13212:
13213: # ---------------------------------------------------------- Read loncaparev table
13214: {
13215: sub load_loncaparevs {
13216: if (-e "$perlvar{'lonTabDir'}/loncaparevs.tab") {
13217: if (open(my $config,"<$perlvar{'lonTabDir'}/loncaparevs.tab")) {
13218: while (my $configline=<$config>) {
13219: chomp($configline);
13220: my ($hostid,$loncaparev)=split(/:/,$configline);
13221: $loncaparevs{$hostid}=$loncaparev;
13222: }
13223: close($config);
13224: }
13225: }
13226: }
13227: }
13228:
13229: # ---------------------------------------------------------- Read serverhostID table
13230: {
13231: sub load_serverhomeIDs {
13232: if (-e "$perlvar{'lonTabDir'}/serverhomeIDs.tab") {
13233: if (open(my $config,"<$perlvar{'lonTabDir'}/serverhomeIDs.tab")) {
13234: while (my $configline=<$config>) {
13235: chomp($configline);
13236: my ($name,$id)=split(/:/,$configline);
13237: $serverhomeIDs{$name}=$id;
13238: }
13239: close($config);
13240: }
13241: }
13242: }
13243: }
13244:
13245:
13246: BEGIN {
13247:
13248: # ----------------------------------- Read loncapa.conf and loncapa_apache.conf
13249: unless ($readit) {
13250: {
13251: my $configvars = LONCAPA::Configuration::read_conf('loncapa.conf');
13252: %perlvar = (%perlvar,%{$configvars});
13253: }
13254:
13255:
13256: # ------------------------------------------------------ Read spare server file
13257: {
13258: open(my $config,"<$perlvar{'lonTabDir'}/spare.tab");
13259:
13260: while (my $configline=<$config>) {
13261: chomp($configline);
13262: if ($configline) {
13263: my ($host,$type) = split(':',$configline,2);
13264: if (!defined($type) || $type eq '') { $type = 'default' };
13265: push(@{ $spareid{$type} }, $host);
13266: }
13267: }
13268: close($config);
13269: }
13270: # ------------------------------------------------------------ Read permissions
13271: {
13272: open(my $config,"<$perlvar{'lonTabDir'}/roles.tab");
13273:
13274: while (my $configline=<$config>) {
13275: chomp($configline);
13276: if ($configline) {
13277: my ($role,$perm)=split(/ /,$configline);
13278: if ($perm ne '') { $pr{$role}=$perm; }
13279: }
13280: }
13281: close($config);
13282: }
13283:
13284: # -------------------------------------------- Read plain texts for permissions
13285: {
13286: open(my $config,"<$perlvar{'lonTabDir'}/rolesplain.tab");
13287:
13288: while (my $configline=<$config>) {
13289: chomp($configline);
13290: if ($configline) {
13291: my ($short,@plain)=split(/:/,$configline);
13292: %{$prp{$short}} = ();
13293: if (@plain > 0) {
13294: $prp{$short}{'std'} = $plain[0];
13295: for (my $i=1; $i<@plain; $i++) {
13296: $prp{$short}{'alt'.$i} = $plain[$i];
13297: }
13298: }
13299: }
13300: }
13301: close($config);
13302: }
13303:
13304: # ---------------------------------------------------------- Read package table
13305: {
13306: open(my $config,"<$perlvar{'lonTabDir'}/packages.tab");
13307:
13308: while (my $configline=<$config>) {
13309: if ($configline !~ /\S/ || $configline=~/^#/) { next; }
13310: chomp($configline);
13311: my ($short,$plain)=split(/:/,$configline);
13312: my ($pack,$name)=split(/\&/,$short);
13313: if ($plain ne '') {
13314: $packagetab{$pack.'&'.$name.'&name'}=$name;
13315: $packagetab{$short}=$plain;
13316: }
13317: }
13318: close($config);
13319: }
13320:
13321: # ---------------------------------------------------------- Read loncaparev table
13322:
13323: &load_loncaparevs();
13324:
13325: # ---------------------------------------------------------- Read serverhostID table
13326:
13327: &load_serverhomeIDs();
13328:
13329: # ---------------------------------------------------------- Read releaseslist XML
13330: {
13331: my $file = $Apache::lonnet::perlvar{'lonTabDir'}.'/releaseslist.xml';
13332: if (-e $file) {
13333: my $parser = HTML::LCParser->new($file);
13334: while (my $token = $parser->get_token()) {
13335: if ($token->[0] eq 'S') {
13336: my $item = $token->[1];
13337: my $name = $token->[2]{'name'};
13338: my $value = $token->[2]{'value'};
13339: my $valuematch = $token->[2]{'valuematch'};
13340: my $namematch = $token->[2]{'namematch'};
13341: if ($item eq 'parameter') {
13342: if (($namematch ne '') || (($name ne '') && ($value ne '' || $valuematch ne ''))) {
13343: my $release = $parser->get_text();
13344: $release =~ s/(^\s*|\s*$ )//gx;
13345: $needsrelease{$item.':'.$name.':'.$value.':'.$valuematch.':'.$namematch} = $release;
13346: }
13347: } elsif ($item ne '' && $name ne '') {
13348: my $release = $parser->get_text();
13349: $release =~ s/(^\s*|\s*$ )//gx;
13350: $needsrelease{$item.':'.$name.':'.$value} = $release;
13351: }
13352: }
13353: }
13354: }
13355: }
13356:
13357: # ---------------------------------------------------------- Read managers table
13358: {
13359: if (-e "$perlvar{'lonTabDir'}/managers.tab") {
13360: if (open(my $config,"<$perlvar{'lonTabDir'}/managers.tab")) {
13361: while (my $configline=<$config>) {
13362: chomp($configline);
13363: next if ($configline =~ /^\#/);
13364: if (($configline =~ /^[\w\-]+$/) || ($configline =~ /^[\w\-]+\:[\w\-]+$/)) {
13365: $managerstab{$configline} = 1;
13366: }
13367: }
13368: close($config);
13369: }
13370: }
13371: }
13372:
13373: # ------------- set up temporary directory
13374: {
13375: $tmpdir = LONCAPA::tempdir();
13376:
13377: }
13378:
13379: $memcache=new Cache::Memcached({'servers' => ['127.0.0.1:11211'],
13380: 'compress_threshold'=> 20_000,
13381: });
13382:
13383: $processmarker='_'.time.'_'.$perlvar{'lonHostID'};
13384: $dumpcount=0;
13385: $locknum=0;
13386:
13387: &logtouch();
13388: &logthis('<font color="yellow">INFO: Read configuration</font>');
13389: $readit=1;
13390: {
13391: use integer;
13392: my $test=(2**32)+1;
13393: if ($test != 0) { $_64bit=1; } else { $_64bit=0; }
13394: &logthis(" Detected 64bit platform ($_64bit)");
13395: }
13396: }
13397: }
13398:
13399: 1;
13400: __END__
13401:
13402: =pod
13403:
13404: =head1 NAME
13405:
13406: Apache::lonnet - Subroutines to ask questions about things in the network.
13407:
13408: =head1 SYNOPSIS
13409:
13410: Invoked by other LON-CAPA modules, when they need to talk to or about objects in the network.
13411:
13412: &Apache::lonnet::SUBROUTINENAME(ARGUMENTS);
13413:
13414: Common parameters:
13415:
13416: =over 4
13417:
13418: =item *
13419:
13420: $uname : an internal username (if $cname expecting a course Id specifically)
13421:
13422: =item *
13423:
13424: $udom : a domain (if $cdom expecting a course's domain specifically)
13425:
13426: =item *
13427:
13428: $symb : a resource instance identifier
13429:
13430: =item *
13431:
13432: $namespace : the name of a .db file that contains the data needed or
13433: being set.
13434:
13435: =back
13436:
13437: =head1 OVERVIEW
13438:
13439: lonnet provides subroutines which interact with the
13440: lonc/lond (TCP) network layer of LON-CAPA. They can be used to ask
13441: about classes, users, and resources.
13442:
13443: For many of these objects you can also use this to store data about
13444: them or modify them in various ways.
13445:
13446: =head2 Symbs
13447:
13448: To identify a specific instance of a resource, LON-CAPA uses symbols
13449: or "symbs"X<symb>. These identifiers are built from the URL of the
13450: map, the resource number of the resource in the map, and the URL of
13451: the resource itself. The latter is somewhat redundant, but might help
13452: if maps change.
13453:
13454: An example is
13455:
13456: msu/korte/parts/part1.sequence___19___msu/korte/tests/part12.problem
13457:
13458: The respective map entry is
13459:
13460: <resource id="19" src="/res/msu/korte/tests/part12.problem"
13461: title="Problem 2">
13462: </resource>
13463:
13464: Symbs are used by the random number generator, as well as to store and
13465: restore data specific to a certain instance of for example a problem.
13466:
13467: =head2 Storing And Retrieving Data
13468:
13469: X<store()>X<cstore()>X<restore()>Three of the most important functions
13470: in C<lonnet.pm> are C<&Apache::lonnet::cstore()>,
13471: C<&Apache::lonnet:restore()>, and C<&Apache::lonnet::store()>, which
13472: is is the non-critical message twin of cstore. These functions are for
13473: handlers to store a perl hash to a user's permanent data space in an
13474: easy manner, and to retrieve it again on another call. It is expected
13475: that a handler would use this once at the beginning to retrieve data,
13476: and then again once at the end to send only the new data back.
13477:
13478: The data is stored in the user's data directory on the user's
13479: homeserver under the ID of the course.
13480:
13481: The hash that is returned by restore will have all of the previous
13482: value for all of the elements of the hash.
13483:
13484: Example:
13485:
13486: #creating a hash
13487: my %hash;
13488: $hash{'foo'}='bar';
13489:
13490: #storing it
13491: &Apache::lonnet::cstore(\%hash);
13492:
13493: #changing a value
13494: $hash{'foo'}='notbar';
13495:
13496: #adding a new value
13497: $hash{'bar'}='foo';
13498: &Apache::lonnet::cstore(\%hash);
13499:
13500: #retrieving the hash
13501: my %history=&Apache::lonnet::restore();
13502:
13503: #print the hash
13504: foreach my $key (sort(keys(%history))) {
13505: print("\%history{$key} = $history{$key}");
13506: }
13507:
13508: Will print out:
13509:
13510: %history{1:foo} = bar
13511: %history{1:keys} = foo:timestamp
13512: %history{1:timestamp} = 990455579
13513: %history{2:bar} = foo
13514: %history{2:foo} = notbar
13515: %history{2:keys} = foo:bar:timestamp
13516: %history{2:timestamp} = 990455580
13517: %history{bar} = foo
13518: %history{foo} = notbar
13519: %history{timestamp} = 990455580
13520: %history{version} = 2
13521:
13522: Note that the special hash entries C<keys>, C<version> and
13523: C<timestamp> were added to the hash. C<version> will be equal to the
13524: total number of versions of the data that have been stored. The
13525: C<timestamp> attribute will be the UNIX time the hash was
13526: stored. C<keys> is available in every historical section to list which
13527: keys were added or changed at a specific historical revision of a
13528: hash.
13529:
13530: B<Warning>: do not store the hash that restore returns directly. This
13531: will cause a mess since it will restore the historical keys as if the
13532: were new keys. I.E. 1:foo will become 1:1:foo etc.
13533:
13534: Calling convention:
13535:
13536: my %record=&Apache::lonnet::restore($symb,$courseid,$domain,$uname);
13537: &Apache::lonnet::cstore(\%newrecord,$symb,$courseid,$domain,$uname,$laststore);
13538:
13539: For more detailed information, see lonnet specific documentation.
13540:
13541: =head1 RETURN MESSAGES
13542:
13543: =over 4
13544:
13545: =item * B<con_lost>: unable to contact remote host
13546:
13547: =item * B<con_delayed>: unable to contact remote host, message will be delivered
13548: when the connection is brought back up
13549:
13550: =item * B<con_failed>: unable to contact remote host and unable to save message
13551: for later delivery
13552:
13553: =item * B<error:>: an error a occurred, a description of the error follows the :
13554:
13555: =item * B<no_such_host>: unable to fund a host associated with the user/domain
13556: that was requested
13557:
13558: =back
13559:
13560: =head1 PUBLIC SUBROUTINES
13561:
13562: =head2 Session Environment Functions
13563:
13564: =over 4
13565:
13566: =item *
13567: X<appenv()>
13568: B<appenv($hashref,$rolesarrayref)>: the value of %{$hashref} is written to
13569: the user envirnoment file, and will be restored for each access this
13570: user makes during this session, also modifies the %env for the current
13571: process. Optional rolesarrayref - if defined contains a reference to an array
13572: of roles which are exempt from the restriction on modifying user.role entries
13573: in the user's environment.db and in %env.
13574:
13575: =item *
13576: X<delenv()>
13577: B<delenv($delthis,$regexp)>: removes all items from the session
13578: environment file that begin with $delthis. If the
13579: optional second arg - $regexp - is true, $delthis is treated as a
13580: regular expression, otherwise \Q$delthis\E is used.
13581: The values are also deleted from the current processes %env.
13582:
13583: =item * get_env_multiple($name)
13584:
13585: gets $name from the %env hash, it seemlessly handles the cases where multiple
13586: values may be defined and end up as an array ref.
13587:
13588: returns an array of values
13589:
13590: =back
13591:
13592: =head2 User Information
13593:
13594: =over 4
13595:
13596: =item *
13597: X<queryauthenticate()>
13598: B<queryauthenticate($uname,$udom)>: try to determine user's current
13599: authentication scheme
13600:
13601: =item *
13602: X<authenticate()>
13603: B<authenticate($uname,$upass,$udom,$checkdefauth,$clientcancheckhost)>: try to
13604: authenticate user from domain's lib servers (first use the current
13605: one). C<$upass> should be the users password.
13606: $checkdefauth is optional (value is 1 if a check should be made to
13607: authenticate user using default authentication method, and allow
13608: account creation if username does not have account in the domain).
13609: $clientcancheckhost is optional (value is 1 if checking whether the
13610: server can host will occur on the client side in lonauth.pm).
13611:
13612: =item *
13613: X<homeserver()>
13614: B<homeserver($uname,$udom)>: find the server which has
13615: the user's directory and files (there must be only one), this caches
13616: the answer, and also caches if there is a borken connection.
13617:
13618: =item *
13619: X<idget()>
13620: B<idget($udom,$idsref,$namespace)>: find the usernames behind either
13621: a list of student/employee IDs or clicker IDs
13622: (student/employee IDs are a unique resource in a domain, there must be
13623: only 1 ID per username, and only 1 username per ID in a specific domain).
13624: clickerIDs are not necessarily unique, as students might share clickers.
13625: (returns hash: id=>name,id=>name)
13626:
13627: =item *
13628: X<idrget()>
13629: B<idrget($udom,@unames)>: find the IDs behind a list of
13630: usernames (returns hash: name=>id,name=>id)
13631:
13632: =item *
13633: X<idput()>
13634: B<idput($udom,$idsref,$uhome,$namespace)>: store away a list of
13635: names and associated student/employee IDs or clicker IDs.
13636:
13637: =item *
13638: X<iddel()>
13639: B<iddel($udom,$idshashref,$uhome,$namespace)>: delete unwanted
13640: student/employee ID or clicker ID username look-ups from domain.
13641: The homeserver ($uhome) and namespace ($namespace) are optional.
13642: If no $uhome is provided, it will be determined usig &homeserver()
13643: for each user. If no $namespace is provided, the default is ids.
13644:
13645: =item *
13646: X<updateclickers()>
13647: B<updateclickers($udom,$action,$idshashref,$uhome,$critical)>: update
13648: clicker ID-to-username look-ups in clickers.db on library server.
13649: Permitted actions are add or del (i.e., add or delete). The
13650: clickers.db contains clickerID as keys (escaped), and each corresponding
13651: value is an escaped comma-separated list of usernames (for whom the
13652: library server is the homeserver), who registered that particular ID.
13653: If $critical is true, the update will be sent via &critical, otherwise
13654: &reply() will be used.
13655:
13656: =item *
13657: X<rolesinit()>
13658: B<rolesinit($udom,$username)>: get user privileges.
13659: returns user role, first access and timer interval hashes
13660:
13661: =item *
13662: X<privileged()>
13663: B<privileged($username,$domain)>: returns a true if user has a
13664: privileged and active role (i.e. su or dc), false otherwise.
13665:
13666: =item *
13667: X<getsection()>
13668: B<getsection($udom,$uname,$cname)>: finds the section of student in the
13669: course $cname, return section name/number or '' for "not in course"
13670: and '-1' for "no section"
13671:
13672: =item *
13673: X<userenvironment()>
13674: B<userenvironment($udom,$uname,@what)>: gets the values of the keys
13675: passed in @what from the requested user's environment, returns a hash
13676:
13677: =item *
13678: X<userlog_query()>
13679: B<userlog_query($uname,$udom,%filters)>: retrieves data from a user's
13680: activity.log file. %filters defines filters applied when parsing the
13681: log file. These can be start or end timestamps, or the type of action
13682: - log to look for Login or Logout events, check for Checkin or
13683: Checkout, role for role selection. The response is in the form
13684: timestamp1:hostid1:event1×tamp2:hostid2:event2 where events are
13685: escaped strings of the action recorded in the activity.log file.
13686:
13687: =back
13688:
13689: =head2 User Roles
13690:
13691: =over 4
13692:
13693: =item *
13694:
13695: allowed($priv,$uri,$symb,$role,$clientip,$noblockcheck) : check for a user privilege;
13696: returns codes for allowed actions.
13697:
13698: The first argument is required, all others are optional.
13699:
13700: $priv is the privilege being checked.
13701: $uri contains additional information about what is being checked for access (e.g.,
13702: URL, course ID etc.).
13703: $symb is the unique resource instance identifier in a course; if needed,
13704: but not provided, it will be retrieved via a call to &symbread().
13705: $role is the role for which a priv is being checked (only used if priv is evb).
13706: $clientip is the user's IP address (only used when checking for access to portfolio
13707: files).
13708: $noblockcheck, if true, skips calls to &has_comm_blocking() for the bre priv. This
13709: prevents recursive calls to &allowed.
13710:
13711: F: full access
13712: U,I,K: authentication modes (cxx only)
13713: '': forbidden
13714: 1: user needs to choose course
13715: 2: browse allowed
13716: A: passphrase authentication needed
13717: B: access temporarily blocked because of a blocking event in a course.
13718:
13719: =item *
13720:
13721: constructaccess($url,$setpriv) : check for access to construction space URL
13722:
13723: See if the owner domain and name in the URL match those in the
13724: expected environment. If so, return three element list
13725: ($ownername,$ownerdomain,$ownerhome).
13726:
13727: Otherwise return the null string.
13728:
13729: If second argument 'setpriv' is true, it assigns the privileges,
13730: and returns the same three element list, unless the owner has
13731: blocked "ad hoc" Domain Coordinator access to the Author Space,
13732: in which case the null string is returned.
13733:
13734: =item *
13735:
13736: definerole($rolename,$sysrole,$domrole,$courole) : define role; define a custom
13737: role rolename set privileges in format of lonTabs/roles.tab for system, domain,
13738: and course level
13739:
13740: =item *
13741:
13742: plaintext($short,$type,$cid,$forcedefault) : return value in %prp hash
13743: (rolesplain.tab); plain text explanation of a user role term.
13744: $type is Course (default) or Community.
13745: If $forcedefault evaluates to true, text returned will be default
13746: text for $type. Otherwise, if this is a course, the text returned
13747: will be a custom name for the role (if defined in the course's
13748: environment). If no custom name is defined the default is returned.
13749:
13750: =item *
13751:
13752: get_my_roles($uname,$udom,$context,$types,$roles,$roledoms,$withsec,$hidepriv) :
13753: All arguments are optional. Returns a hash of a roles, either for
13754: co-author/assistant author roles for a user's Construction Space
13755: (default), or if $context is 'userroles', roles for the user himself,
13756: In the hash, keys are set to colon-separated $uname,$udom,$role, and
13757: (optionally) if $withsec is true, a fourth colon-separated item - $section.
13758: For each key, value is set to colon-separated start and end times for
13759: the role. If no username and domain are specified, will default to
13760: current user/domain. Types, roles, and roledoms are references to arrays
13761: of role statuses (active, future or previous), roles
13762: (e.g., cc,in, st etc.) and domains of the roles which can be used
13763: to restrict the list of roles reported. If no array ref is
13764: provided for types, will default to return only active roles.
13765:
13766: =item *
13767:
13768: in_course($udom,$uname,$cdom,$cnum,$type,$hideprivileged) : determine if
13769: user: $uname:$udom has a role in the course: $cdom_$cnum.
13770:
13771: Additional optional arguments are: $type (if role checking is to be restricted
13772: to certain user status types -- previous (expired roles), active (currently
13773: available roles) or future (roles available in the future), and
13774: $hideprivileged -- if true will not report course roles for users who
13775: have active Domain Coordinator role in course's domain or in additional
13776: domains (specified in 'Domains to check for privileged users' in course
13777: environment -- set via: Course Settings -> Classlists and staff listing).
13778:
13779: =item *
13780:
13781: privileged($username,$domain,$possdomains,$possroles) : returns 1 if user
13782: $username:$domain is a privileged user (e.g., Domain Coordinator or Super User)
13783: $possdomains and $possroles are optional array refs -- to domains to check and
13784: roles to check. If $possdomains is not specified, a dump will be done of the
13785: users' roles.db to check for a dc or su role in any domain. This can be
13786: time consuming if &privileged is called repeatedly (e.g., when displaying a
13787: classlist), so in such cases, supplying a $possdomains array is preferred, as
13788: this then allows &privileged_by_domain() to be used, which caches the identity
13789: of privileged users, eliminating the need for repeated calls to &dump().
13790:
13791: =item *
13792:
13793: privileged_by_domain($possdomains,$roles) : returns a hash of a hash of a hash,
13794: where the outer hash keys are domains specified in the $possdomains array ref,
13795: next inner hash keys are privileged roles specified in the $roles array ref,
13796: and the innermost hash contains key = value pairs for username:domain = end:start
13797: for active or future "privileged" users with that role in that domain. To avoid
13798: repeated dumps of domain roles -- via &get_domain_roles() -- contents of the
13799: innerhash are cached using priv_$role and $dom as the identifiers.
13800:
13801: =back
13802:
13803: =head2 User Modification
13804:
13805: =over 4
13806:
13807: =item *
13808:
13809: assignrole($udom,$uname,$url,$role,$end,$start,$deleteflag,$selfenroll,$context) : assign role; give a role to a
13810: user for the level given by URL. Optional start and end dates (leave empty
13811: string or zero for "no date")
13812:
13813: =item *
13814:
13815: changepass($uname,$udom,$currentpass,$newpass,$server) : attempts to
13816: change a users, password, possible return values are: ok,
13817: pwchange_failure, non_authorized, auth_mode_error, unknown_user,
13818: refused
13819:
13820: =item *
13821:
13822: modifyuserauth($udom,$uname,$umode,$upass) : modify user authentication
13823:
13824: =item *
13825:
13826: modifyuser($udom,$uname,$uid,$umode,$upass,$first,$middle,$last, $gene,
13827: $forceid,$desiredhome,$email,$inststatus,$candelete) :
13828:
13829: will update user information (firstname,middlename,lastname,generation,
13830: permanentemail), and if forceid is true, student/employee ID also.
13831: A user's institutional affiliation(s) can also be updated.
13832: User information fields will not be overwritten with empty entries
13833: unless the field is included in the $candelete array reference.
13834: This array is included when a single user is modified via "Manage Users",
13835: or when Autoupdate.pl is run by cron in a domain.
13836:
13837: =item *
13838:
13839: modifystudent
13840:
13841: modify a student's enrollment and identification information.
13842: The course id is resolved based on the current user's environment.
13843: This means the invoking user must be a course coordinator or otherwise
13844: associated with a course.
13845:
13846: This call is essentially a wrapper for lonnet::modifyuser and
13847: lonnet::modify_student_enrollment
13848:
13849: Inputs:
13850:
13851: =over 4
13852:
13853: =item B<$udom> Student's loncapa domain
13854:
13855: =item B<$uname> Student's loncapa login name
13856:
13857: =item B<$uid> Student/Employee ID
13858:
13859: =item B<$umode> Student's authentication mode
13860:
13861: =item B<$upass> Student's password
13862:
13863: =item B<$first> Student's first name
13864:
13865: =item B<$middle> Student's middle name
13866:
13867: =item B<$last> Student's last name
13868:
13869: =item B<$gene> Student's generation
13870:
13871: =item B<$usec> Student's section in course
13872:
13873: =item B<$end> Unix time of the roles expiration
13874:
13875: =item B<$start> Unix time of the roles start date
13876:
13877: =item B<$forceid> If defined, allow $uid to be changed
13878:
13879: =item B<$desiredhome> server to use as home server for student
13880:
13881: =item B<$email> Student's permanent e-mail address
13882:
13883: =item B<$type> Type of enrollment (auto or manual)
13884:
13885: =item B<$locktype> boolean - enrollment type locked to prevent Autoenroll.pl changing manual to auto
13886:
13887: =item B<$cid> courseID - needed if a course role is assigned by a user whose current role is DC
13888:
13889: =item B<$selfenroll> boolean - 1 if user role change occurred via self-enrollment
13890:
13891: =item B<$context> role change context (shown in User Management Logs display in a course)
13892:
13893: =item B<$inststatus> institutional status of user - : separated string of escaped status types
13894:
13895: =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.
13896:
13897: =back
13898:
13899: =item *
13900:
13901: modify_student_enrollment
13902:
13903: Change a student's enrollment status in a class. The environment variable
13904: 'role.request.course' must be defined for this function to proceed.
13905:
13906: Inputs:
13907:
13908: =over 4
13909:
13910: =item $udom, student's domain
13911:
13912: =item $uname, student's name
13913:
13914: =item $uid, student's user id
13915:
13916: =item $first, student's first name
13917:
13918: =item $middle
13919:
13920: =item $last
13921:
13922: =item $gene
13923:
13924: =item $usec
13925:
13926: =item $end
13927:
13928: =item $start
13929:
13930: =item $type
13931:
13932: =item $locktype
13933:
13934: =item $cid
13935:
13936: =item $selfenroll
13937:
13938: =item $context
13939:
13940: =item $credits, number of credits student will earn from this class
13941:
13942: =item $instsec, institutional course section code for student
13943:
13944: =back
13945:
13946:
13947: =item *
13948:
13949: assigncustomrole($udom,$uname,$url,$rdom,$rnam,$rolename,$end,$start) : assign
13950: custom role; give a custom role to a user for the level given by URL. Specify
13951: name and domain of role author, and role name
13952:
13953: =item *
13954:
13955: revokerole($udom,$uname,$url,$role) : revoke a role for url
13956:
13957: =item *
13958:
13959: revokecustomrole($udom,$uname,$url,$role) : revoke a custom role
13960:
13961: =back
13962:
13963: =head2 Course Infomation
13964:
13965: =over 4
13966:
13967: =item *
13968:
13969: coursedescription($courseid,$options) : returns a hash of information about the
13970: specified course id, including all environment settings for the
13971: course, the description of the course will be in the hash under the
13972: key 'description'
13973:
13974: $options is an optional parameter that if supplied is a hash reference that controls
13975: what how this function works. It has the following key/values:
13976:
13977: =over 4
13978:
13979: =item freshen_cache
13980:
13981: If defined, and the environment cache for the course is valid, it is
13982: returned in the returned hash.
13983:
13984: =item one_time
13985:
13986: If defined, the last cache time is set to _now_
13987:
13988: =item user
13989:
13990: If defined, the supplied username is used instead of the current user.
13991:
13992:
13993: =back
13994:
13995: =item *
13996:
13997: resdata($name,$domain,$type,@which) : request for current parameter
13998: setting for a specific $type, where $type is either 'course' or 'user',
13999: @what should be a list of parameters to ask about. This routine caches
14000: answers for 10 minutes.
14001:
14002: =item *
14003:
14004: get_courseresdata($courseid, $domain) : dump the entire course resource
14005: data base, returning a hash that is keyed by the resource name and has
14006: values that are the resource value. I believe that the timestamps and
14007: versions are also returned.
14008:
14009: get_numsuppfiles($cnum,$cdom) : retrieve number of files in a course's
14010: supplemental content area. This routine caches the number of files for
14011: 10 minutes.
14012:
14013: =back
14014:
14015: =head2 Course Modification
14016:
14017: =over 4
14018:
14019: =item *
14020:
14021: writecoursepref($courseid,%prefs) : write preferences (environment
14022: database) for a course
14023:
14024: =item *
14025:
14026: createcourse($udom,$description,$url,$course_server,$nonstandard,$inst_code,$course_owner,$crstype,$cnum) : make course
14027:
14028: =item *
14029:
14030: generate_coursenum($udom,$crstype) : get a unique (unused) course number in domain $udom for course type $crstype (Course or Community).
14031:
14032: =item *
14033:
14034: is_course($courseid), is_course($cdom, $cnum)
14035:
14036: Accepts either a combined $courseid (in the form of domain_courseid) or the
14037: two component version $cdom, $cnum. It checks if the specified course exists.
14038:
14039: Returns:
14040: undef if the course doesn't exist, otherwise
14041: in scalar context the combined courseid.
14042: in list context the two components of the course identifier, domain and
14043: courseid.
14044:
14045: =back
14046:
14047: =head2 Resource Subroutines
14048:
14049: =over 4
14050:
14051: =item *
14052:
14053: subscribe($fname) : subscribe to a resource, returns URL if possible (probably should use repcopy instead)
14054:
14055: =item *
14056:
14057: repcopy($filename) : subscribes to the requested file, and attempts to
14058: replicate from the owning library server, Might return
14059: 'unavailable', 'not_found', 'forbidden', 'ok', or
14060: 'bad_request', also attempts to grab the metadata for the
14061: resource. Expects the local filesystem pathname
14062: (/home/httpd/html/res/....)
14063:
14064: =back
14065:
14066: =head2 Resource Information
14067:
14068: =over 4
14069:
14070: =item *
14071:
14072: EXT($varname,$symb,$udom,$uname,$usection,$recurse,$cid) : evaluates
14073: and returns the value of a variety of different possible values,
14074: $varname should be a request string, and the other parameters can be
14075: used to specify who and what one is asking about. Ordinarily, $cid
14076: does not need to be specified, as it is retrived from
14077: $env{'request.course.id'}, but &Apache::lonnet::EXT() is called
14078: within lonuserstate::loadmap() when initializing a course, before
14079: $env{'request.course.id'} has been set, so it needs to be provided
14080: in that one case.
14081:
14082: Possible values for $varname are environment.lastname (or other item
14083: from the envirnment hash), user.name (or someother aspect about the
14084: user), resource.0.maxtries (or some other part and parameter of a
14085: resource)
14086:
14087: =item *
14088:
14089: directcondval($number) : get current value of a condition; reads from a state
14090: string
14091:
14092: =item *
14093:
14094: condval($condidx) : value of condition index based on state
14095:
14096: =item *
14097:
14098: metadata($uri,$what,$liburi,$prefix,$depthcount) : request a
14099: resource's metadata, $what should be either a specific key, or either
14100: 'keys' (to get a list of possible keys) or 'packages' to get a list of
14101: packages that this resource currently uses, the last 3 arguments are only used internally for recursive metadata.
14102:
14103: this function automatically caches all requests
14104:
14105: =item *
14106:
14107: metadata_query($query,$custom,$customshow) : make a metadata query against the
14108: network of library servers; returns file handle of where SQL and regex results
14109: will be stored for query
14110:
14111: =item *
14112:
14113: symbread($filename,$donotrecurse,$ignorecachednull,$checkforblock,$possibles) :
14114: return symbolic list entry (all arguments optional).
14115:
14116: Args: filename is the filename (including path) for the file for which a symb
14117: is required; donotrecurse, if true will prevent calls to allowed() being made
14118: to check access status if more than one resource was found in the bighash
14119: (see rev. 1.249) to avoid an infinite loop if an ambiguous resource is part of
14120: a randompick); ignorecachednull, if true will prevent a symb of '' being
14121: returned if $env{$cache_str} is defined as ''; checkforblock if true will
14122: cause possible symbs to be checked to determine if they are subject to content
14123: blocking, if so they will not be included as possible symbs; possibles is a
14124: ref to a hash, which, as a side effect, will be populated with all possible
14125: symbs (content blocking not tested).
14126:
14127: returns the data handle
14128:
14129: =item *
14130:
14131: symbverify($symb,$thisfn,$encstate) : verifies that $symb actually exists
14132: and is a possible symb for the URL in $thisfn, and if is an encrypted
14133: resource that the user accessed using /enc/ returns a 1 on success, 0
14134: on failure, user must be in a course, as it assumes the existence of
14135: the course initial hash, and uses $env('request.course.id'}. The third
14136: arg is an optional reference to a scalar. If this arg is passed in the
14137: call to symbverify, it will be set to 1 if the symb has been set to be
14138: encrypted; otherwise it will be null.
14139:
14140: =item *
14141:
14142: symbclean($symb) : removes versions numbers from a symb, returns the
14143: cleaned symb
14144:
14145: =item *
14146:
14147: is_on_map($uri) : checks if the $uri is somewhere on the current
14148: course map, user must be in a course for it to work.
14149:
14150: =item *
14151:
14152: numval($salt) : return random seed value (addend for rndseed)
14153:
14154: =item *
14155:
14156: rndseed($symb,$courseid,$udom,$uname) : create a random sum; returns
14157: a random seed, all arguments are optional, if they aren't sent it uses the
14158: environment to derive them. Note: if symb isn't sent and it can't get one
14159: from &symbread it will use the current time as its return value
14160:
14161: =item *
14162:
14163: ireceipt($funame,$fudom,$fucourseid,$fusymb) : return unique,
14164: unfakeable, receipt
14165:
14166: =item *
14167:
14168: receipt() : API to ireceipt working off of env values; given out to users
14169:
14170: =item *
14171:
14172: countacc($url) : count the number of accesses to a given URL
14173:
14174: =item *
14175:
14176: 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
14177:
14178: =item *
14179:
14180: 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)
14181:
14182: =item *
14183:
14184: expirespread($uname,$udom,$stype,$usymb) : set expire date for spreadsheet
14185:
14186: =item *
14187:
14188: devalidate($symb) : devalidate temporary spreadsheet calculations,
14189: forcing spreadsheet to reevaluate the resource scores next time.
14190:
14191: =item *
14192:
14193: can_edit_resource($file,$cnum,$cdom,$resurl,$symb,$group) : determine if current user can edit a particular resource,
14194: when viewing in course context.
14195:
14196: input: six args -- filename (decluttered), course number, course domain,
14197: url, symb (if registered) and group (if this is a
14198: group item -- e.g., bulletin board, group page etc.).
14199:
14200: output: array of five scalars --
14201: $cfile -- url for file editing if editable on current server
14202: $home -- homeserver of resource (i.e., for author if published,
14203: or course if uploaded.).
14204: $switchserver -- 1 if server switch will be needed.
14205: $forceedit -- 1 if icon/link should be to go to edit mode
14206: $forceview -- 1 if icon/link should be to go to view mode
14207:
14208: =item *
14209:
14210: is_course_upload($file,$cnum,$cdom)
14211:
14212: Used in course context to determine if current file was uploaded to
14213: the course (i.e., would be found in /userfiles/docs on the course's
14214: homeserver.
14215:
14216: input: 3 args -- filename (decluttered), course number and course domain.
14217: output: boolean -- 1 if file was uploaded.
14218:
14219: =back
14220:
14221: =head2 Storing/Retreiving Data
14222:
14223: =over 4
14224:
14225: =item *
14226:
14227: store($storehash,$symb,$namespace,$udom,$uname,$laststore) : stores hash
14228: permanently for this url; hashref needs to be given and should be a \%hashname;
14229: the remaining args aren't required and if they aren't passed or are '' they will
14230: be derived from the env (with the exception of $laststore, which is an
14231: optional arg used when a user's submission is stored in grading).
14232: $laststore is $version=$timestamp, where $version is the most recent version
14233: number retrieved for the corresponding $symb in the $namespace db file, and
14234: $timestamp is the timestamp for that transaction (UNIX time).
14235: $laststore is currently only passed when cstore() is called by
14236: structuretags::finalize_storage().
14237:
14238: =item *
14239:
14240: cstore($storehash,$symb,$namespace,$udom,$uname,$laststore) : same as store
14241: but uses critical subroutine
14242:
14243: =item *
14244:
14245: restore($symb,$namespace,$udom,$uname) : returns hash for this symb;
14246: all args are optional
14247:
14248: =item *
14249:
14250: dumpstore($namespace,$udom,$uname,$regexp,$range) :
14251: dumps the complete (or key matching regexp) namespace into a hash
14252: ($udom, $uname, $regexp, $range are optional) for a namespace that is
14253: normally &store()ed into
14254:
14255: $range should be either an integer '100' (give me the first 100
14256: matching records)
14257: or be two integers sperated by a - with no spaces
14258: '30-50' (give me the 30th through the 50th matching
14259: records)
14260:
14261:
14262: =item *
14263:
14264: putstore($namespace,$symb,$version,$storehash,$udomain,$uname,$tolog) :
14265: replaces a &store() version of data with a replacement set of data
14266: for a particular resource in a namespace passed in the $storehash hash
14267: reference. If $tolog is true, the transaction is logged in the courselog
14268: with an action=PUTSTORE.
14269:
14270: =item *
14271:
14272: tmpstore($storehash,$symb,$namespace,$udom,$uname) : storage that
14273: works very similar to store/cstore, but all data is stored in a
14274: temporary location and can be reset using tmpreset, $storehash should
14275: be a hash reference, returns nothing on success
14276:
14277: =item *
14278:
14279: tmprestore($symb,$namespace,$udom,$uname) : storage that works very
14280: similar to restore, but all data is stored in a temporary location and
14281: can be reset using tmpreset. Returns a hash of values on success,
14282: error string otherwise.
14283:
14284: =item *
14285:
14286: tmpreset($symb,$namespace,$udom,$uname) : temporary storage reset,
14287: deltes all keys for $symb form the temporary storage hash.
14288:
14289: =item *
14290:
14291: get($namespace,$storearr,$udom,$uname) : returns hash with keys from array
14292: reference filled in from namesp ($udom and $uname are optional)
14293:
14294: =item *
14295:
14296: del($namespace,$storearr,$udom,$uname) : deletes keys out of array from
14297: namesp ($udom and $uname are optional)
14298:
14299: =item *
14300:
14301: dump($namespace,$udom,$uname,$regexp,$range) :
14302: dumps the complete (or key matching regexp) namespace into a hash
14303: ($udom, $uname, $regexp, $range are optional)
14304:
14305: $range should be either an integer '100' (give me the first 100
14306: matching records)
14307: or be two integers sperated by a - with no spaces
14308: '30-50' (give me the 30th through the 50th matching
14309: records)
14310: =item *
14311:
14312: inc($namespace,$store,$udom,$uname) : increments $store in $namespace.
14313: $store can be a scalar, an array reference, or if the amount to be
14314: incremented is > 1, a hash reference.
14315:
14316: ($udom and $uname are optional)
14317:
14318: =item *
14319:
14320: put($namespace,$storehash,$udom,$uname) : stores hash in namesp
14321: ($udom and $uname are optional)
14322:
14323: =item *
14324:
14325: cput($namespace,$storehash,$udom,$uname) : critical put
14326: ($udom and $uname are optional)
14327:
14328: =item *
14329:
14330: newput($namespace,$storehash,$udom,$uname) :
14331:
14332: Attempts to store the items in the $storehash, but only if they don't
14333: currently exist, if this succeeds you can be certain that you have
14334: successfully created a new key value pair in the $namespace db.
14335:
14336:
14337: Args:
14338: $namespace: name of database to store values to
14339: $storehash: hashref to store to the db
14340: $udom: (optional) domain of user containing the db
14341: $uname: (optional) name of user caontaining the db
14342:
14343: Returns:
14344: 'ok' -> succeeded in storing all keys of $storehash
14345: 'key_exists: <key>' -> failed to anything out of $storehash, as at
14346: least <key> already existed in the db (other
14347: requested keys may also already exist)
14348: 'error: <msg>' -> unable to tie the DB or other error occurred
14349: 'con_lost' -> unable to contact request server
14350: 'refused' -> action was not allowed by remote machine
14351:
14352:
14353: =item *
14354:
14355: eget($namespace,$storearr,$udom,$uname) : returns hash with keys from array
14356: reference filled in from namesp (encrypts the return communication)
14357: ($udom and $uname are optional)
14358:
14359: =item *
14360:
14361: log($udom,$name,$home,$message) : write to permanent log for user; use
14362: critical subroutine
14363:
14364: =item *
14365:
14366: get_dom($namespace,$storearr,$udom,$uhome) : returns hash with keys from
14367: array reference filled in from namespace found in domain level on either
14368: specified domain server ($uhome) or primary domain server ($udom and $uhome are optional).
14369:
14370: =item *
14371:
14372: put_dom($namespace,$storehash,$udom,$uhome) : stores hash in namespace at
14373: domain level either on specified domain server ($uhome) or primary domain
14374: server ($udom and $uhome are optional)
14375:
14376: =item *
14377:
14378: get_domain_defaults($target_domain,$ignore_cache) : returns hash with defaults
14379: for: authentication, language, quotas, timezone, date locale, and portal URL in
14380: the target domain.
14381:
14382: May also include additional key => value pairs for the following groups:
14383:
14384: =over
14385:
14386: =item
14387: disk quotas (MB allocated by default to portfolios and authoring spaces).
14388:
14389: =over
14390:
14391: =item defaultquota, authorquota
14392:
14393: =back
14394:
14395: =item
14396: tools (availability of aboutme page, blog, webDAV access for authoring spaces,
14397: portfolio for users).
14398:
14399: =over
14400:
14401: =item
14402: aboutme, blog, webdav, portfolio
14403:
14404: =back
14405:
14406: =item
14407: requestcourses: ability to request courses, and how requests are processed.
14408:
14409: =over
14410:
14411: =item
14412: official, unofficial, community, textbook, placement
14413:
14414: =back
14415:
14416: =item
14417: inststatus: types of institutional affiliation, and order in which they are displayed.
14418:
14419: =over
14420:
14421: =item
14422: inststatustypes, inststatusorder, inststatusguest
14423:
14424: =back
14425:
14426: =item
14427: coursedefaults: can PDF forms can be created, default credits for courses, default quotas (MB)
14428: for course's uploaded content.
14429:
14430: =over
14431:
14432: =item
14433: canuse_pdfforms, officialcredits, unofficialcredits, textbookcredits, officialquota, unofficialquota,
14434: communityquota, textbookquota, placementquota
14435:
14436: =back
14437:
14438: =item
14439: usersessions: set options for hosting of your users in other domains, and hosting of users from other domains
14440: on your servers.
14441:
14442: =over
14443:
14444: =item
14445: remotesessions, hostedsessions
14446:
14447: =back
14448:
14449: =back
14450:
14451: In cases where a domain coordinator has never used the "Set Domain Configuration"
14452: utility to create a configuration.db file on a domain's primary library server
14453: only the following domain defaults: auth_def, auth_arg_def, lang_def
14454: -- corresponding values are authentication type (internal, krb4, krb5,
14455: or localauth), initial password or a kerberos realm, language (e.g., en-us) --
14456: will be available. Values are retrieved from cache (if current), unless the
14457: optional $ignore_cache arg is true, or from domain's configuration.db (if available),
14458: or lastly from values in lonTabs/dns_domain,tab, or lonTabs/domain.tab.
14459:
14460: Typical usage:
14461:
14462: %domdefaults = &get_domain_defaults($target_domain);
14463:
14464: =back
14465:
14466: =head2 Network Status Functions
14467:
14468: =over 4
14469:
14470: =item *
14471:
14472: dirlist() : return directory list based on URI (first arg).
14473:
14474: Inputs: 1 required, 5 optional.
14475:
14476: =over
14477:
14478: =item
14479: $uri - path to file in filesystem (starts: /res or /userfiles/). Required.
14480:
14481: =item
14482: $userdomain - domain of user/course to be listed. Extracted from $uri if absent.
14483:
14484: =item
14485: $username - username of user/course to be listed. Extracted from $uri if absent.
14486:
14487: =item
14488: $getpropath - boolean: 1 if prepend path using &propath().
14489:
14490: =item
14491: $getuserdir - boolean: 1 if prepend path for "userfiles".
14492:
14493: =item
14494: $alternateRoot - path to prepend in place of path from $uri.
14495:
14496: =back
14497:
14498: Returns: Array of up to two items.
14499:
14500: =over
14501:
14502: a reference to an array of files/subdirectories
14503:
14504: =over
14505:
14506: Each element in the array of files/subdirectories is a & separated list of
14507: item name and the result of running stat on the item. If dirlist was requested
14508: for a file instead of a directory, the item name will be ''. For a directory
14509: listing, if the item is a metadata file, the element will end &N&M
14510: (where N amd M are either 0 or 1, corresponding to obsolete set (1), or
14511: default copyright set (1).
14512:
14513: =back
14514:
14515: a scalar containing error condition (if encountered).
14516:
14517: =over
14518:
14519: =item
14520: no_host (no homeserver identified for $username:$domain).
14521:
14522: =item
14523: no_such_host (server contacted for listing not identified as valid host).
14524:
14525: =item
14526: con_lost (connection to remote server failed).
14527:
14528: =item
14529: refused (invalid $username:$domain received on lond side).
14530:
14531: =item
14532: no_such_dir (directory at specified path on lond side does not exist).
14533:
14534: =item
14535: empty (directory at specified path on lond side is empty).
14536:
14537: =over
14538:
14539: This is currently not encountered because the &ls3, &ls2,
14540: &ls (_handler) routines on the lond side do not filter out
14541: . and .. from a directory listing.
14542:
14543: =back
14544:
14545: =back
14546:
14547: =back
14548:
14549: =item *
14550:
14551: spareserver() : find server with least workload from spare.tab
14552:
14553:
14554: =item *
14555:
14556: host_from_dns($dns) : Returns the loncapa hostname corresponding to a DNS name or undef
14557: if there is no corresponding loncapa host.
14558:
14559: =back
14560:
14561:
14562: =head2 Apache Request
14563:
14564: =over 4
14565:
14566: =item *
14567:
14568: ssi($url,%hash) : server side include, does a complete request cycle on url to
14569: localhost, posts hash
14570:
14571: =back
14572:
14573: =head2 Data to String to Data
14574:
14575: =over 4
14576:
14577: =item *
14578:
14579: hash2str(%hash) : convert a hash into a string complete with escaping and '='
14580: and '&' separators, supports elements that are arrayrefs and hashrefs
14581:
14582: =item *
14583:
14584: hashref2str($hashref) : convert a hashref into a string complete with
14585: escaping and '=' and '&' separators, supports elements that are
14586: arrayrefs and hashrefs
14587:
14588: =item *
14589:
14590: arrayref2str($arrayref) : convert an arrayref into a string complete
14591: with escaping and '&' separators, supports elements that are arrayrefs
14592: and hashrefs
14593:
14594: =item *
14595:
14596: str2hash($string) : convert string to hash using unescaping and
14597: splitting on '=' and '&', supports elements that are arrayrefs and
14598: hashrefs
14599:
14600: =item *
14601:
14602: str2array($string) : convert string to hash using unescaping and
14603: splitting on '&', supports elements that are arrayrefs and hashrefs
14604:
14605: =back
14606:
14607: =head2 Logging Routines
14608:
14609:
14610: These routines allow one to make log messages in the lonnet.log and
14611: lonnet.perm logfiles.
14612:
14613: =over 4
14614:
14615: =item *
14616:
14617: logtouch() : make sure the logfile, lonnet.log, exists
14618:
14619: =item *
14620:
14621: logthis() : append message to the normal lonnet.log file, it gets
14622: preiodically rolled over and deleted.
14623:
14624: =item *
14625:
14626: logperm() : append a permanent message to lonnet.perm.log, this log
14627: file never gets deleted by any automated portion of the system, only
14628: messages of critical importance should go in here.
14629:
14630:
14631: =back
14632:
14633: =head2 General File Helper Routines
14634:
14635: =over 4
14636:
14637: =item *
14638:
14639: getfile($file,$caller) : two cases - requests for files in /res or in /uploaded.
14640: (a) files in /uploaded
14641: (i) If a local copy of the file exists -
14642: compares modification date of local copy with last-modified date for
14643: definitive version stored on home server for course. If local copy is
14644: stale, requests a new version from the home server and stores it.
14645: If the original has been removed from the home server, then local copy
14646: is unlinked.
14647: (ii) If local copy does not exist -
14648: requests the file from the home server and stores it.
14649:
14650: If $caller is 'uploadrep':
14651: This indicates a call from lonuploadrep.pm (PerlHeaderParserHandler phase)
14652: for request for files originally uploaded via DOCS.
14653: - returns 'ok' if fresh local copy now available, -1 otherwise.
14654:
14655: Otherwise:
14656: This indicates a call from the content generation phase of the request.
14657: - returns the entire contents of the file or -1.
14658:
14659: (b) files in /res
14660: - returns the entire contents of a file or -1;
14661: it properly subscribes to and replicates the file if neccessary.
14662:
14663:
14664: =item *
14665:
14666: stat_file($url) : $url is expected to be a /res/ or /uploaded/ style file
14667: reference
14668:
14669: returns either a stat() list of data about the file or an empty list
14670: if the file doesn't exist or couldn't find out about it (connection
14671: problems or user unknown)
14672:
14673: =item *
14674:
14675: filelocation($dir,$file) : returns file system location of a file
14676: based on URI; meant to be "fairly clean" absolute reference, $dir is a
14677: directory that relative $file lookups are to looked in ($dir of /a/dir
14678: and a file of ../bob will become /a/bob)
14679:
14680: =item *
14681:
14682: hreflocation($dir,$file) : returns file system location or a URL; same as
14683: filelocation except for hrefs
14684:
14685: =item *
14686:
14687: declutter() : declutters URLs -- remove beginning slashes, 'res' etc.
14688: also removes beginning /home/httpd/html unless /priv/ follows it.
14689:
14690: =back
14691:
14692: =head2 Usererfile file routines (/uploaded*)
14693:
14694: =over 4
14695:
14696: =item *
14697:
14698: userfileupload(): main rotine for putting a file in a user or course's
14699: filespace, arguments are,
14700:
14701: formname - required - this is the name of the element in $env where the
14702: filename, and the contents of the file to create/modifed exist
14703: the filename is in $env{'form.'.$formname.'.filename'} and the
14704: contents of the file is located in $env{'form.'.$formname}
14705: context - if coursedoc, store the file in the course of the active role
14706: of the current user;
14707: if 'existingfile': store in 'overwrites' in /home/httpd/perl/tmp
14708: if 'canceloverwrite': delete file in tmp/overwrites directory
14709: subdir - required - subdirectory to put the file in under ../userfiles/
14710: if undefined, it will be placed in "unknown"
14711:
14712: (This routine calls clean_filename() to remove any dangerous
14713: characters from the filename, and then calls finuserfileupload() to
14714: complete the transaction)
14715:
14716: returns either the url of the uploaded file (/uploaded/....) if successful
14717: and /adm/notfound.html if unsuccessful
14718:
14719: =item *
14720:
14721: clean_filename(): routine for cleaing a filename up for storage in
14722: userfile space, argument is:
14723:
14724: filename - proposed filename
14725:
14726: returns: the new clean filename
14727:
14728: =item *
14729:
14730: finishuserfileupload(): routine that creates and sends the file to
14731: userspace, probably shouldn't be called directly
14732:
14733: docuname: username or courseid of destination for the file
14734: docudom: domain of user/course of destination for the file
14735: formname: same as for userfileupload()
14736: fname: filename (including subdirectories) for the file
14737: parser: if 'parse', will parse (html) file to extract references to objects, links etc.
14738: allfiles: reference to hash used to store objects found by parser
14739: codebase: reference to hash used for codebases of java objects found by parser
14740: thumbwidth: width (pixels) of thumbnail to be created for uploaded image
14741: thumbheight: height (pixels) of thumbnail to be created for uploaded image
14742: resizewidth: width to be used to resize image using resizeImage from ImageMagick
14743: resizeheight: height to be used to resize image using resizeImage from ImageMagick
14744: context: if 'overwrite', will move the uploaded file from its temporary location to
14745: userfiles to facilitate overwriting a previously uploaded file with same name.
14746: mimetype: reference to scalar to accommodate mime type determined
14747: from File::MMagic if $parser = parse.
14748:
14749: returns either the url of the uploaded file (/uploaded/....) if successful
14750: and /adm/notfound.html if unsuccessful (or an error message if context
14751: was 'overwrite').
14752:
14753:
14754: =item *
14755:
14756: renameuserfile(): renames an existing userfile to a new name
14757:
14758: Args:
14759: docuname: username or courseid of destination for the file
14760: docudom: domain of user/course of destination for the file
14761: old: current file name (including any subdirs under userfiles)
14762: new: desired file name (including any subdirs under userfiles)
14763:
14764: =item *
14765:
14766: mkdiruserfile(): creates a directory is a userfiles dir
14767:
14768: Args:
14769: docuname: username or courseid of destination for the file
14770: docudom: domain of user/course of destination for the file
14771: dir: dir to create (including any subdirs under userfiles)
14772:
14773: =item *
14774:
14775: removeuserfile(): removes a file that exists in userfiles
14776:
14777: Args:
14778: docuname: username or courseid of destination for the file
14779: docudom: domain of user/course of destination for the file
14780: fname: filname to delete (including any subdirs under userfiles)
14781:
14782: =item *
14783:
14784: removeuploadedurl(): convience function for removeuserfile()
14785:
14786: Args:
14787: url: a full /uploaded/... url to delete
14788:
14789: =item *
14790:
14791: get_portfile_permissions():
14792: Args:
14793: domain: domain of user or course contain the portfolio files
14794: user: name of user or num of course contain the portfolio files
14795: Returns:
14796: hashref of a dump of the proper file_permissions.db
14797:
14798:
14799: =item *
14800:
14801: get_access_controls():
14802:
14803: Args:
14804: current_permissions: the hash ref returned from get_portfile_permissions()
14805: group: (optional) the group you want the files associated with
14806: file: (optional) the file you want access info on
14807:
14808: Returns:
14809: a hash (keys are file names) of hashes containing
14810: keys are: path to file/file_name\0uniqueID:scope_end_start (see below)
14811: values are XML containing access control settings (see below)
14812:
14813: Internal notes:
14814:
14815: access controls are stored in file_permissions.db as key=value pairs.
14816: key -> path to file/file_name\0uniqueID:scope_end_start
14817: where scope -> public,guest,course,group,domains or users.
14818: end -> UNIX time for end of access (0 -> no end date)
14819: start -> UNIX time for start of access
14820:
14821: value -> XML description of access control
14822: <scope type=""> (type =1 of: public,guest,course,group,domains,users">
14823: <start></start>
14824: <end></end>
14825:
14826: <password></password> for scope type = guest
14827:
14828: <domain></domain> for scope type = course or group
14829: <number></number>
14830: <roles id="">
14831: <role></role>
14832: <access></access>
14833: <section></section>
14834: <group></group>
14835: </roles>
14836:
14837: <dom></dom> for scope type = domains
14838:
14839: <users> for scope type = users
14840: <user>
14841: <uname></uname>
14842: <udom></udom>
14843: </user>
14844: </users>
14845: </scope>
14846:
14847: Access data is also aggregated for each file in an additional key=value pair:
14848: key -> path to file/file_name\0accesscontrol
14849: value -> reference to hash
14850: hash contains key = value pairs
14851: where key = uniqueID:scope_end_start
14852: value = UNIX time record was last updated
14853:
14854: Used to improve speed of look-ups of access controls for each file.
14855:
14856: Locks on files (resulting from submission of portfolio file to a homework problem stored in array of arrays.
14857:
14858: =item *
14859:
14860: modify_access_controls():
14861:
14862: Modifies access controls for a portfolio file
14863: Args
14864: 1. file name
14865: 2. reference to hash of required changes,
14866: 3. domain
14867: 4. username
14868: where domain,username are the domain of the portfolio owner
14869: (either a user or a course)
14870:
14871: Returns:
14872: 1. result of additions or updates ('ok' or 'error', with error message).
14873: 2. result of deletions ('ok' or 'error', with error message).
14874: 3. reference to hash of any new or updated access controls.
14875: 4. reference to hash used to map incoming IDs to uniqueIDs assigned to control.
14876: key = integer (inbound ID)
14877: value = uniqueID
14878:
14879: =item *
14880:
14881: get_timebased_id():
14882:
14883: Attempts to get a unique timestamp-based suffix for use with items added to a
14884: course via the Course Editor (e.g., folders, composite pages,
14885: group bulletin boards).
14886:
14887: Args: (first three required; six others optional)
14888:
14889: 1. prefix (alphanumeric): of keys in hash, e.g., suppsequence, docspage,
14890: docssequence, or name of group
14891:
14892: 2. keyid (alphanumeric): name of temporary locking key in hash,
14893: e.g., num, boardids
14894:
14895: 3. namespace: name of gdbm file used to store suffixes already assigned;
14896: file will be named nohist_namespace.db
14897:
14898: 4. cdom: domain of course; default is current course domain from %env
14899:
14900: 5. cnum: course number; default is current course number from %env
14901:
14902: 6. idtype: set to concat if an additional digit is to be appended to the
14903: unix timestamp to form the suffix, if the plain timestamp is already
14904: in use. Default is to not do this, but simply increment the unix
14905: timestamp by 1 until a unique key is obtained.
14906:
14907: 7. who: holder of locking key; defaults to user:domain for user.
14908:
14909: 8. locktries: number of attempts to obtain a lock (sleep of 1s before
14910: retrying); default is 3.
14911:
14912: 9. maxtries: number of attempts to obtain a unique suffix; default is 20.
14913:
14914: Returns:
14915:
14916: 1. suffix obtained (numeric)
14917:
14918: 2. result of deleting locking key (ok if deleted, or lock never obtained)
14919:
14920: 3. error: contains (localized) error message if an error occurred.
14921:
14922:
14923: =back
14924:
14925: =head2 HTTP Helper Routines
14926:
14927: =over 4
14928:
14929: =item *
14930:
14931: escape() : unpack non-word characters into CGI-compatible hex codes
14932:
14933: =item *
14934:
14935: unescape() : pack CGI-compatible hex codes into actual non-word ASCII character
14936:
14937: =back
14938:
14939: =head1 PRIVATE SUBROUTINES
14940:
14941: =head2 Underlying communication routines (Shouldn't call)
14942:
14943: =over 4
14944:
14945: =item *
14946:
14947: subreply() : tries to pass a message to lonc, returns con_lost if incapable
14948:
14949: =item *
14950:
14951: reply() : uses subreply to send a message to remote machine, logs all failures
14952:
14953: =item *
14954:
14955: critical() : passes a critical message to another server; if cannot
14956: get through then place message in connection buffer directory and
14957: returns con_delayed, if incapable of saving message, returns
14958: con_failed
14959:
14960: =item *
14961:
14962: reconlonc() : tries to reconnect lonc client processes.
14963:
14964: =back
14965:
14966: =head2 Resource Access Logging
14967:
14968: =over 4
14969:
14970: =item *
14971:
14972: flushcourselogs() : flush (save) buffer logs and access logs
14973:
14974: =item *
14975:
14976: courselog($what) : save message for course in hash
14977:
14978: =item *
14979:
14980: courseacclog($what) : save message for course using &courselog(). Perform
14981: special processing for specific resource types (problems, exams, quizzes, etc).
14982:
14983: =item *
14984:
14985: goodbye() : flush course logs and log shutting down; it is called in srm.conf
14986: as a PerlChildExitHandler
14987:
14988: =back
14989:
14990: =head2 Other
14991:
14992: =over 4
14993:
14994: =item *
14995:
14996: symblist($mapname,%newhash) : update symbolic storage links
14997:
14998: =back
14999:
15000: =cut
15001:
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