1: # The LearningOnline Network
2: # TCP networking package
3: #
4: # $Id: lonnet.pm,v 1.1405 2019/02/15 20:56:18 raeburn Exp $
5: #
6: # Copyright Michigan State University Board of Trustees
7: #
8: # This file is part of the LearningOnline Network with CAPA (LON-CAPA).
9: #
10: # LON-CAPA is free software; you can redistribute it and/or modify
11: # it under the terms of the GNU General Public License as published by
12: # the Free Software Foundation; either version 2 of the License, or
13: # (at your option) any later version.
14: #
15: # LON-CAPA is distributed in the hope that it will be useful,
16: # but WITHOUT ANY WARRANTY; without even the implied warranty of
17: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18: # GNU General Public License for more details.
19: #
20: # You should have received a copy of the GNU General Public License
21: # along with LON-CAPA; if not, write to the Free Software
22: # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
23: #
24: # /home/httpd/html/adm/gpl.txt
25: #
26: # http://www.lon-capa.org/
27: #
28: ###
29:
30: =pod
31:
32: =head1 NAME
33:
34: Apache::lonnet.pm
35:
36: =head1 SYNOPSIS
37:
38: This file is an interface to the lonc processes of
39: the LON-CAPA network as well as set of elaborated functions for handling information
40: necessary for navigating through a given cluster of LON-CAPA machines within a
41: domain. There are over 40 specialized functions in this module which handle the
42: reading and transmission of metadata, user information (ids, names, environments, roles,
43: logs), file information (storage, reading, directories, extensions, replication, embedded
44: styles and descriptors), educational resources (course descriptions, section names and
45: numbers), url hashing (to assign roles on a url basis), and translating abbreviated symbols to
46: and from more descriptive phrases or explanations.
47:
48: This is part of the LearningOnline Network with CAPA project
49: described at http://www.lon-capa.org.
50:
51: =head1 Package Variables
52:
53: These are largely undocumented, so if you decipher one please note it here.
54:
55: =over 4
56:
57: =item $processmarker
58:
59: Contains the time this process was started and this servers host id.
60:
61: =item $dumpcount
62:
63: Counts the number of times a message log flush has been attempted (regardless
64: of success) by this process. Used as part of the filename when messages are
65: delayed.
66:
67: =back
68:
69: =cut
70:
71: package Apache::lonnet;
72:
73: use strict;
74: use HTTP::Date;
75: use Image::Magick;
76: use CGI::Cookie;
77:
78: use Encode;
79:
80: use vars qw(%perlvar %spareid %pr %prp $memcache %packagetab $tmpdir $deftex
81: $_64bit %env %protocol %loncaparevs %serverhomeIDs %needsrelease
82: %managerstab);
83:
84: my (%badServerCache, $memcache, %courselogs, %accesshash, %domainrolehash,
85: %userrolehash, $processmarker, $dumpcount, %coursedombuf,
86: %coursenumbuf, %coursehombuf, %coursedescrbuf, %courseinstcodebuf,
87: %courseownerbuf, %coursetypebuf,$locknum);
88:
89: use IO::Socket;
90: use GDBM_File;
91: use HTML::LCParser;
92: use Fcntl qw(:flock);
93: use Storable qw(thaw nfreeze);
94: use Time::HiRes qw( sleep gettimeofday tv_interval );
95: use Cache::Memcached;
96: use Digest::MD5;
97: use Math::Random;
98: use File::MMagic;
99: use LONCAPA qw(:DEFAULT :match);
100: use LONCAPA::Configuration;
101: use LONCAPA::lonmetadata;
102: use LONCAPA::Lond;
103: use LONCAPA::LWPReq;
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),$loncaparevs{$lonid})."\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,$hostname,$context) = @_;
234: return if ($lonhost eq '');
235: if ($hostname eq '') {
236: $hostname = &hostname($lonhost);
237: }
238: return if ($hostname eq '');
239: my ($rep,$uselocal);
240: if ($context eq 'install') {
241: $uselocal = 1;
242: } elsif (grep { $_ eq $lonhost } ¤t_machine_ids()) {
243: $uselocal = 1;
244: }
245: if (($context ne 'cgi') && ($context ne 'install') && ($uselocal)) {
246: my $distro = (split(/\:/,&get_server_distarch($lonhost)))[0];
247: if ($distro eq '') {
248: $uselocal = 0;
249: } elsif ($distro =~ /^(?:centos|redhat|scientific)(\d+)$/) {
250: if ($1 < 6) {
251: $uselocal = 0;
252: }
253: } elsif ($distro =~ /^(?:sles)(\d+)$/) {
254: if ($1 < 12) {
255: $uselocal = 0;
256: }
257: }
258: }
259: if ($uselocal) {
260: $rep = LONCAPA::Lond::server_certs(\%perlvar,$lonhost,$hostname);
261: } else {
262: $rep=&reply('servercerts',$lonhost);
263: }
264: my ($result,%returnhash);
265: if (($rep=~/^(refused|rejected|error)/) || ($rep eq 'con_lost') ||
266: ($rep eq 'unknown_cmd')) {
267: $result = $rep;
268: } else {
269: $result = 'ok';
270: my @pairs=split(/\&/,$rep);
271: foreach my $item (@pairs) {
272: my ($key,$value)=split(/=/,$item,2);
273: my $what = &unescape($key);
274: $returnhash{$what}=&thaw_unescape($value);
275: }
276: }
277: return ($result,\%returnhash);
278: }
279:
280: sub get_server_loncaparev {
281: my ($dom,$lonhost,$ignore_cache,$caller) = @_;
282: if (defined($lonhost)) {
283: if (!defined(&hostname($lonhost))) {
284: undef($lonhost);
285: }
286: }
287: if (!defined($lonhost)) {
288: if (defined(&domain($dom,'primary'))) {
289: $lonhost=&domain($dom,'primary');
290: if ($lonhost eq 'no_host') {
291: undef($lonhost);
292: }
293: }
294: }
295: if (defined($lonhost)) {
296: my $cachetime = 12*3600;
297: if (!$ignore_cache) {
298: my ($loncaparev,$cached)=&is_cached_new('serverloncaparev',$lonhost);
299: if (defined($cached)) {
300: return $loncaparev;
301: }
302: }
303: my ($answer,$loncaparev);
304: my @ids=¤t_machine_ids();
305: if (grep(/^\Q$lonhost\E$/,@ids)) {
306: $answer = $perlvar{'lonVersion'};
307: if ($answer =~ /^[\'\"]?([\w.\-]+)[\'\"]?$/) {
308: $loncaparev = $1;
309: }
310: } else {
311: $answer = &reply('serverloncaparev',$lonhost);
312: if (($answer eq 'unknown_cmd') || ($answer eq 'con_lost')) {
313: if ($caller eq 'loncron') {
314: my $hostname = &hostname($lonhost);
315: my $protocol = $protocol{$lonhost};
316: $protocol = 'http' if ($protocol ne 'https');
317: my $url = $protocol.'://'.$hostname.'/adm/about.html';
318: my $request=new HTTP::Request('GET',$url);
319: my $response=&LONCAPA::LWPReq::makerequest($lonhost,$request,'',\%perlvar,4,1);
320: unless ($response->is_error()) {
321: my $content = $response->content;
322: if ($content =~ /<p>VERSION\:\s*([\w.\-]+)<\/p>/) {
323: $loncaparev = $1;
324: }
325: }
326: } else {
327: $loncaparev = $loncaparevs{$lonhost};
328: }
329: } elsif ($answer =~ /^[\'\"]?([\w.\-]+)[\'\"]?$/) {
330: $loncaparev = $1;
331: }
332: }
333: return &do_cache_new('serverloncaparev',$lonhost,$loncaparev,$cachetime);
334: }
335: }
336:
337: sub get_server_homeID {
338: my ($hostname,$ignore_cache,$caller) = @_;
339: unless ($ignore_cache) {
340: my ($serverhomeID,$cached)=&is_cached_new('serverhomeID',$hostname);
341: if (defined($cached)) {
342: return $serverhomeID;
343: }
344: }
345: my $cachetime = 12*3600;
346: my $serverhomeID;
347: if ($caller eq 'loncron') {
348: my @machine_ids = &machine_ids($hostname);
349: foreach my $id (@machine_ids) {
350: my $response = &reply('serverhomeID',$id);
351: unless (($response eq 'unknown_cmd') || ($response eq 'con_lost')) {
352: $serverhomeID = $response;
353: last;
354: }
355: }
356: if ($serverhomeID eq '') {
357: $serverhomeID = $machine_ids[-1];
358: }
359: } else {
360: $serverhomeID = $serverhomeIDs{$hostname};
361: }
362: return &do_cache_new('serverhomeID',$hostname,$serverhomeID,$cachetime);
363: }
364:
365: sub get_remote_globals {
366: my ($lonhost,$whathash,$ignore_cache) = @_;
367: my ($result,%returnhash,%whatneeded);
368: if (ref($whathash) eq 'HASH') {
369: foreach my $what (sort(keys(%{$whathash}))) {
370: my $hashid = $lonhost.'-'.$what;
371: my ($response,$cached);
372: unless ($ignore_cache) {
373: ($response,$cached)=&is_cached_new('lonnetglobal',$hashid);
374: }
375: if (defined($cached)) {
376: $returnhash{$what} = $response;
377: } else {
378: $whatneeded{$what} = 1;
379: }
380: }
381: if (keys(%whatneeded) == 0) {
382: $result = 'ok';
383: } else {
384: my $requested = &freeze_escape(\%whatneeded);
385: my $rep=&reply('readlonnetglobal:'.$requested,$lonhost);
386: if (($rep=~/^(refused|rejected|error)/) || ($rep eq 'con_lost') ||
387: ($rep eq 'unknown_cmd')) {
388: $result = $rep;
389: } else {
390: $result = 'ok';
391: my @pairs=split(/\&/,$rep);
392: foreach my $item (@pairs) {
393: my ($key,$value)=split(/=/,$item,2);
394: my $what = &unescape($key);
395: my $hashid = $lonhost.'-'.$what;
396: $returnhash{$what}=&thaw_unescape($value);
397: &do_cache_new('lonnetglobal',$hashid,$returnhash{$what},600);
398: }
399: }
400: }
401: }
402: return ($result,\%returnhash);
403: }
404:
405: sub remote_devalidate_cache {
406: my ($lonhost,$cachekeys) = @_;
407: my $items;
408: return unless (ref($cachekeys) eq 'ARRAY');
409: my $cachestr = join('&',@{$cachekeys});
410: my $response = &reply('devalidatecache:'.&escape($cachestr),$lonhost);
411: return $response;
412: }
413:
414: # -------------------------------------------------- Non-critical communication
415: sub subreply {
416: my ($cmd,$server)=@_;
417: my $peerfile="$perlvar{'lonSockDir'}/".&hostname($server);
418: #
419: # With loncnew process trimming, there's a timing hole between lonc server
420: # process exit and the master server picking up the listen on the AF_UNIX
421: # socket. In that time interval, a lock file will exist:
422:
423: my $lockfile=$peerfile.".lock";
424: while (-e $lockfile) { # Need to wait for the lockfile to disappear.
425: sleep(0.1);
426: }
427: # At this point, either a loncnew parent is listening or an old lonc
428: # or loncnew child is listening so we can connect or everything's dead.
429: #
430: # We'll give the connection a few tries before abandoning it. If
431: # connection is not possible, we'll con_lost back to the client.
432: #
433: my $client;
434: for (my $retries = 0; $retries < $max_connection_retries; $retries++) {
435: $client=IO::Socket::UNIX->new(Peer =>"$peerfile",
436: Type => SOCK_STREAM,
437: Timeout => 10);
438: if ($client) {
439: last; # Connected!
440: } else {
441: &create_connection(&hostname($server),$server);
442: }
443: sleep(0.1); # Try again later if failed connection.
444: }
445: my $answer;
446: if ($client) {
447: print $client "sethost:$server:$cmd\n";
448: $answer=<$client>;
449: if (!$answer) { $answer="con_lost"; }
450: chomp($answer);
451: } else {
452: $answer = 'con_lost'; # Failed connection.
453: }
454: return $answer;
455: }
456:
457: sub reply {
458: my ($cmd,$server)=@_;
459: unless (defined(&hostname($server))) { return 'no_such_host'; }
460: my $answer=subreply($cmd,$server);
461: if (($answer=~/^refused/) || ($answer=~/^rejected/)) {
462: my $logged = $cmd;
463: if ($cmd =~ /^encrypt:([^:]+):/) {
464: my $subcmd = $1;
465: if (($subcmd eq 'auth') || ($subcmd eq 'passwd') ||
466: ($subcmd eq 'changeuserauth') || ($subcmd eq 'makeuser') ||
467: ($subcmd eq 'putdom') || ($subcmd eq 'autoexportgrades')) {
468: (undef,undef,my @rest) = split(/:/,$cmd);
469: if (($subcmd eq 'auth') || ($subcmd eq 'putdom')) {
470: splice(@rest,2,1,'Hidden');
471: } elsif ($subcmd eq 'passwd') {
472: splice(@rest,2,2,('Hidden','Hidden'));
473: } elsif (($subcmd eq 'changeuserauth') || ($subcmd eq 'makeuser') ||
474: ($subcmd eq 'autoexportgrades')) {
475: splice(@rest,3,1,'Hidden');
476: }
477: $logged = join(':',('encrypt:'.$subcmd,@rest));
478: }
479: }
480: &logthis("<font color=\"blue\">WARNING:".
481: " $logged to $server returned $answer</font>");
482: }
483: return $answer;
484: }
485:
486: # ----------------------------------------------------------- Send USR1 to lonc
487:
488: sub reconlonc {
489: my ($lonid) = @_;
490: if ($lonid) {
491: my $hostname = &hostname($lonid);
492: my $peerfile="$perlvar{'lonSockDir'}/$hostname";
493: if ($hostname && -e $peerfile) {
494: &logthis("Trying to reconnect lonc for $lonid ($hostname)");
495: my $client=IO::Socket::UNIX->new(Peer => $peerfile,
496: Type => SOCK_STREAM,
497: Timeout => 10);
498: if ($client) {
499: print $client ("reset_retries\n");
500: my $answer=<$client>;
501: #reset just this one.
502: }
503: }
504: return;
505: }
506:
507: &logthis("Trying to reconnect lonc");
508: my $loncfile="$perlvar{'lonDaemons'}/logs/lonc.pid";
509: if (open(my $fh,"<",$loncfile)) {
510: my $loncpid=<$fh>;
511: chomp($loncpid);
512: if (kill 0 => $loncpid) {
513: &logthis("lonc at pid $loncpid responding, sending USR1");
514: kill USR1 => $loncpid;
515: sleep 1;
516: } else {
517: &logthis(
518: "<font color=\"blue\">WARNING:".
519: " lonc at pid $loncpid not responding, giving up</font>");
520: }
521: } else {
522: &logthis('<font color="blue">WARNING: lonc not running, giving up</font>');
523: }
524: }
525:
526: # ------------------------------------------------------ Critical communication
527:
528: sub critical {
529: my ($cmd,$server)=@_;
530: unless (&hostname($server)) {
531: &logthis("<font color=\"blue\">WARNING:".
532: " Critical message to unknown server ($server)</font>");
533: return 'no_such_host';
534: }
535: my $answer=reply($cmd,$server);
536: if ($answer eq 'con_lost') {
537: &reconlonc($server);
538: my $answer=reply($cmd,$server);
539: if ($answer eq 'con_lost') {
540: my $now=time;
541: my $middlename=$cmd;
542: $middlename=substr($middlename,0,16);
543: $middlename=~s/\W//g;
544: my $dfilename=
545: "$perlvar{'lonSockDir'}/delayed/$now.$dumpcount.$$.$middlename.$server";
546: $dumpcount++;
547: {
548: my $dfh;
549: if (open($dfh,">",$dfilename)) {
550: print $dfh "$cmd\n";
551: close($dfh);
552: }
553: }
554: sleep 1;
555: my $wcmd='';
556: {
557: my $dfh;
558: if (open($dfh,"<",$dfilename)) {
559: $wcmd=<$dfh>;
560: close($dfh);
561: }
562: }
563: chomp($wcmd);
564: if ($wcmd eq $cmd) {
565: &logthis("<font color=\"blue\">WARNING: ".
566: "Connection buffer $dfilename: $cmd</font>");
567: &logperm("D:$server:$cmd");
568: return 'con_delayed';
569: } else {
570: &logthis("<font color=\"red\">CRITICAL:"
571: ." Critical connection failed: $server $cmd</font>");
572: &logperm("F:$server:$cmd");
573: return 'con_failed';
574: }
575: }
576: }
577: return $answer;
578: }
579:
580: # ------------------------------------------- check if return value is an error
581:
582: sub error {
583: my ($result) = @_;
584: if ($result =~ /^(con_lost|no_such_host|error: (\d+) (.*))/) {
585: if ($2 == 2) { return undef; }
586: return $1;
587: }
588: return undef;
589: }
590:
591: sub convert_and_load_session_env {
592: my ($lonidsdir,$handle)=@_;
593: my @profile;
594: {
595: my $opened = open(my $idf,'+<',"$lonidsdir/$handle.id");
596: if (!$opened) {
597: return 0;
598: }
599: flock($idf,LOCK_SH);
600: @profile=<$idf>;
601: close($idf);
602: }
603: my %temp_env;
604: foreach my $line (@profile) {
605: if ($line !~ m/=/) {
606: return 0;
607: }
608: chomp($line);
609: my ($envname,$envvalue)=split(/=/,$line,2);
610: $temp_env{&unescape($envname)} = &unescape($envvalue);
611: }
612: unlink("$lonidsdir/$handle.id");
613: if (tie(my %disk_env,'GDBM_File',"$lonidsdir/$handle.id",&GDBM_WRCREAT(),
614: 0640)) {
615: %disk_env = %temp_env;
616: @env{keys(%temp_env)} = @disk_env{keys(%temp_env)};
617: untie(%disk_env);
618: }
619: return 1;
620: }
621:
622: # ------------------------------------------- Transfer profile into environment
623: my $env_loaded;
624: sub transfer_profile_to_env {
625: my ($lonidsdir,$handle,$force_transfer) = @_;
626: if (!$force_transfer && $env_loaded) { return; }
627:
628: if (!defined($lonidsdir)) {
629: $lonidsdir = $perlvar{'lonIDsDir'};
630: }
631: if (!defined($handle)) {
632: ($handle) = ($env{'user.environment'} =~m|/([^/]+)\.id$| );
633: }
634:
635: my $convert;
636: {
637: my $opened = open(my $idf,'+<',"$lonidsdir/$handle.id");
638: if (!$opened) {
639: return;
640: }
641: flock($idf,LOCK_SH);
642: if (tie(my %disk_env,'GDBM_File',"$lonidsdir/$handle.id",
643: &GDBM_READER(),0640)) {
644: @env{keys(%disk_env)} = @disk_env{keys(%disk_env)};
645: untie(%disk_env);
646: } else {
647: $convert = 1;
648: }
649: }
650: if ($convert) {
651: if (!&convert_and_load_session_env($lonidsdir,$handle)) {
652: &logthis("Failed to load session, or convert session.");
653: }
654: }
655:
656: my %remove;
657: while ( my $envname = each(%env) ) {
658: if (my ($key,$time) = ($envname =~ /^(cgi\.(\d+)_\d+\.)/)) {
659: if ($time < time-300) {
660: $remove{$key}++;
661: }
662: }
663: }
664:
665: $env{'user.environment'} = "$lonidsdir/$handle.id";
666: $env_loaded=1;
667: foreach my $expired_key (keys(%remove)) {
668: &delenv($expired_key);
669: }
670: }
671:
672: # ---------------------------------------------------- Check for valid session
673: sub check_for_valid_session {
674: my ($r,$name,$userhashref,$domref) = @_;
675: my %cookies=CGI::Cookie->parse($r->header_in('Cookie'));
676: my ($lonidsdir,$linkname,$pubname,$secure,$lonid);
677: if ($name eq 'lonDAV') {
678: $lonidsdir=$r->dir_config('lonDAVsessDir');
679: } else {
680: $lonidsdir=$r->dir_config('lonIDsDir');
681: if ($name eq '') {
682: $name = 'lonID';
683: }
684: }
685: if ($name eq 'lonID') {
686: $secure = 'lonSID';
687: $linkname = 'lonLinkID';
688: $pubname = 'lonPubID';
689: if (exists($cookies{$secure})) {
690: $lonid=$cookies{$secure};
691: } elsif (exists($cookies{$name})) {
692: $lonid=$cookies{$name};
693: } elsif ((exists($cookies{$linkname})) && ($ENV{'SERVER_PORT'} != 443)) {
694: $lonid=$cookies{$linkname};
695: } elsif (exists($cookies{$pubname})) {
696: $lonid=$cookies{$pubname};
697: }
698: } else {
699: $lonid=$cookies{$name};
700: }
701: return undef if (!$lonid);
702:
703: my $handle=&LONCAPA::clean_handle($lonid->value);
704: if (-l "$lonidsdir/$handle.id") {
705: my $link = readlink("$lonidsdir/$handle.id");
706: if ((-e $link) && ($link =~ m{^\Q$lonidsdir\E/(.+)\.id$})) {
707: $handle = $1;
708: }
709: }
710: if (!-e "$lonidsdir/$handle.id") {
711: if ((ref($domref)) && ($name eq 'lonID') &&
712: ($handle =~ /^($match_username)\_\d+\_($match_domain)\_(.+)$/)) {
713: my ($possuname,$possudom,$possuhome) = ($1,$2,$3);
714: if ((&domain($possudom) ne '') && (&homeserver($possuname,$possudom) eq $possuhome)) {
715: $$domref = $possudom;
716: }
717: }
718: return undef;
719: }
720:
721: my $opened = open(my $idf,'+<',"$lonidsdir/$handle.id");
722: return undef if (!$opened);
723:
724: flock($idf,LOCK_SH);
725: my %disk_env;
726: if (!tie(%disk_env,'GDBM_File',"$lonidsdir/$handle.id",
727: &GDBM_READER(),0640)) {
728: return undef;
729: }
730:
731: if (!defined($disk_env{'user.name'})
732: || !defined($disk_env{'user.domain'})) {
733: untie(%disk_env);
734: return undef;
735: }
736:
737: if (ref($userhashref) eq 'HASH') {
738: $userhashref->{'name'} = $disk_env{'user.name'};
739: $userhashref->{'domain'} = $disk_env{'user.domain'};
740: $userhashref->{'lti'} = $disk_env{'request.lti.login'};
741: if ($userhashref->{'lti'}) {
742: $userhashref->{'ltitarget'} = $disk_env{'request.lti.target'};
743: $userhashref->{'ltiuri'} = $disk_env{'request.lti.uri'};
744: }
745: }
746: untie(%disk_env);
747:
748: return $handle;
749: }
750:
751: sub timed_flock {
752: my ($file,$lock_type) = @_;
753: my $failed=0;
754: eval {
755: local $SIG{__DIE__}='DEFAULT';
756: local $SIG{ALRM}=sub {
757: $failed=1;
758: die("failed lock");
759: };
760: alarm(13);
761: flock($file,$lock_type);
762: alarm(0);
763: };
764: if ($failed) {
765: return undef;
766: } else {
767: return 1;
768: }
769: }
770:
771: sub get_sessionfile_vars {
772: my ($handle,$lonidsdir,$storearr) = @_;
773: my %returnhash;
774: unless (ref($storearr) eq 'ARRAY') {
775: return %returnhash;
776: }
777: if (-l "$lonidsdir/$handle.id") {
778: my $link = readlink("$lonidsdir/$handle.id");
779: if ((-e $link) && ($link =~ m{^\Q$lonidsdir\E/(.+)\.id$})) {
780: $handle = $1;
781: }
782: }
783: if ((-e "$lonidsdir/$handle.id") &&
784: ($handle =~ /^($match_username)\_\d+\_($match_domain)\_(.+)$/)) {
785: my ($possuname,$possudom,$possuhome) = ($1,$2,$3);
786: if ((&domain($possudom) ne '') && (&homeserver($possuname,$possudom) eq $possuhome)) {
787: if (open(my $idf,'+<',"$lonidsdir/$handle.id")) {
788: flock($idf,LOCK_SH);
789: if (tie(my %disk_env,'GDBM_File',"$lonidsdir/$handle.id",
790: &GDBM_READER(),0640)) {
791: foreach my $item (@{$storearr}) {
792: $returnhash{$item} = $disk_env{$item};
793: }
794: untie(%disk_env);
795: }
796: }
797: }
798: }
799: return %returnhash;
800: }
801:
802: # ---------------------------------------------------------- Append Environment
803:
804: sub appenv {
805: my ($newenv,$roles) = @_;
806: if (ref($newenv) eq 'HASH') {
807: foreach my $key (keys(%{$newenv})) {
808: my $refused = 0;
809: if (($key =~ /^user\.role/) || ($key =~ /^user\.priv/)) {
810: $refused = 1;
811: if (ref($roles) eq 'ARRAY') {
812: my ($type,$role) = ($key =~ m{^user\.(role|priv)\.(.+?)\./});
813: if (grep(/^\Q$role\E$/,@{$roles})) {
814: $refused = 0;
815: }
816: }
817: }
818: if ($refused) {
819: &logthis("<font color=\"blue\">WARNING: ".
820: "Attempt to modify environment ".$key." to ".$newenv->{$key}
821: .'</font>');
822: delete($newenv->{$key});
823: } else {
824: $env{$key}=$newenv->{$key};
825: }
826: }
827: my $lonids = $perlvar{'lonIDsDir'};
828: if ($env{'user.environment'} =~ m{^\Q$lonids/\E$match_username\_\d+\_$match_domain\_[\w\-.]+\.id$}) {
829: my $opened = open(my $env_file,'+<',$env{'user.environment'});
830: if ($opened
831: && &timed_flock($env_file,LOCK_EX)
832: &&
833: tie(my %disk_env,'GDBM_File',$env{'user.environment'},
834: (&GDBM_WRITER()|&GDBM_NOLOCK()),0640)) {
835: while (my ($key,$value) = each(%{$newenv})) {
836: $disk_env{$key} = $value;
837: }
838: untie(%disk_env);
839: }
840: }
841: }
842: return 'ok';
843: }
844: # ----------------------------------------------------- Delete from Environment
845:
846: sub delenv {
847: my ($delthis,$regexp,$roles) = @_;
848: if (($delthis=~/^user\.role/) || ($delthis=~/^user\.priv/)) {
849: my $refused = 1;
850: if (ref($roles) eq 'ARRAY') {
851: my ($type,$role) = ($delthis =~ /^user\.(role|priv)\.([^.]+)\./);
852: if (grep(/^\Q$role\E$/,@{$roles})) {
853: $refused = 0;
854: }
855: }
856: if ($refused) {
857: &logthis("<font color=\"blue\">WARNING: ".
858: "Attempt to delete from environment ".$delthis);
859: return 'error';
860: }
861: }
862: my $opened = open(my $env_file,'+<',$env{'user.environment'});
863: if ($opened
864: && &timed_flock($env_file,LOCK_EX)
865: &&
866: tie(my %disk_env,'GDBM_File',$env{'user.environment'},
867: (&GDBM_WRITER()|&GDBM_NOLOCK()),0640)) {
868: foreach my $key (keys(%disk_env)) {
869: if ($regexp) {
870: if ($key=~/^$delthis/) {
871: delete($env{$key});
872: delete($disk_env{$key});
873: }
874: } else {
875: if ($key=~/^\Q$delthis\E/) {
876: delete($env{$key});
877: delete($disk_env{$key});
878: }
879: }
880: }
881: untie(%disk_env);
882: }
883: return 'ok';
884: }
885:
886: sub get_env_multiple {
887: my ($name) = @_;
888: my @values;
889: if (defined($env{$name})) {
890: # exists is it an array
891: if (ref($env{$name})) {
892: @values=@{ $env{$name} };
893: } else {
894: $values[0]=$env{$name};
895: }
896: }
897: return(@values);
898: }
899:
900: # ------------------------------------------------------------------- Locking
901:
902: sub set_lock {
903: my ($text)=@_;
904: $locknum++;
905: my $id=$$.'-'.$locknum;
906: &appenv({'session.locks' => $env{'session.locks'}.','.$id,
907: 'session.lock.'.$id => $text});
908: return $id;
909: }
910:
911: sub get_locks {
912: my $num=0;
913: my %texts=();
914: foreach my $lock (split(/\,/,$env{'session.locks'})) {
915: if ($lock=~/\w/) {
916: $num++;
917: $texts{$lock}=$env{'session.lock.'.$lock};
918: }
919: }
920: return ($num,%texts);
921: }
922:
923: sub remove_lock {
924: my ($id)=@_;
925: my $newlocks='';
926: foreach my $lock (split(/\,/,$env{'session.locks'})) {
927: if (($lock=~/\w/) && ($lock ne $id)) {
928: $newlocks.=','.$lock;
929: }
930: }
931: &appenv({'session.locks' => $newlocks});
932: &delenv('session.lock.'.$id);
933: }
934:
935: sub remove_all_locks {
936: my $activelocks=$env{'session.locks'};
937: foreach my $lock (split(/\,/,$env{'session.locks'})) {
938: if ($lock=~/\w/) {
939: &remove_lock($lock);
940: }
941: }
942: }
943:
944:
945: # ------------------------------------------ Find out current server userload
946: sub userload {
947: my $numusers=0;
948: {
949: opendir(LONIDS,$perlvar{'lonIDsDir'});
950: my $filename;
951: my $curtime=time;
952: while ($filename=readdir(LONIDS)) {
953: next if ($filename eq '.' || $filename eq '..');
954: next if ($filename =~ /publicuser_\d+\.id/);
955: next if ($filename =~ /^[a-f0-9]+_linked\.id$/);
956: my ($mtime)=(stat($perlvar{'lonIDsDir'}.'/'.$filename))[9];
957: if ($curtime-$mtime < 1800) { $numusers++; }
958: }
959: closedir(LONIDS);
960: }
961: my $userloadpercent=0;
962: my $maxuserload=$perlvar{'lonUserLoadLim'};
963: if ($maxuserload) {
964: $userloadpercent=100*$numusers/$maxuserload;
965: }
966: $userloadpercent=sprintf("%.2f",$userloadpercent);
967: return $userloadpercent;
968: }
969:
970: # ------------------------------ Find server with least workload from spare.tab
971:
972: sub spareserver {
973: my ($loadpercent,$userloadpercent,$want_server_name,$udom) = @_;
974: my $spare_server;
975: if ($userloadpercent !~ /\d/) { $userloadpercent=0; }
976: my $lowest_load=($loadpercent > $userloadpercent) ? $loadpercent
977: : $userloadpercent;
978: my ($uint_dom,$remotesessions);
979: if (($udom ne '') && (&domain($udom) ne '')) {
980: my $uprimary_id = &Apache::lonnet::domain($udom,'primary');
981: $uint_dom = &Apache::lonnet::internet_dom($uprimary_id);
982: my %udomdefaults = &Apache::lonnet::get_domain_defaults($udom);
983: $remotesessions = $udomdefaults{'remotesessions'};
984: }
985: my $spareshash = &this_host_spares($udom);
986: if (ref($spareshash) eq 'HASH') {
987: if (ref($spareshash->{'primary'}) eq 'ARRAY') {
988: foreach my $try_server (@{ $spareshash->{'primary'} }) {
989: next unless (&spare_can_host($udom,$uint_dom,$remotesessions,
990: $try_server));
991: ($spare_server, $lowest_load) =
992: &compare_server_load($try_server, $spare_server, $lowest_load);
993: }
994: }
995:
996: my $found_server = ($spare_server ne '' && $lowest_load < 100);
997:
998: if (!$found_server) {
999: if (ref($spareshash->{'default'}) eq 'ARRAY') {
1000: foreach my $try_server (@{ $spareshash->{'default'} }) {
1001: next unless (&spare_can_host($udom,$uint_dom,
1002: $remotesessions,$try_server));
1003: ($spare_server, $lowest_load) =
1004: &compare_server_load($try_server, $spare_server, $lowest_load);
1005: }
1006: }
1007: }
1008: }
1009:
1010: if (!$want_server_name) {
1011: if (defined($spare_server)) {
1012: my $hostname = &hostname($spare_server);
1013: if (defined($hostname)) {
1014: my $protocol = 'http';
1015: if ($protocol{$spare_server} eq 'https') {
1016: $protocol = $protocol{$spare_server};
1017: }
1018: $spare_server = $protocol.'://'.$hostname;
1019: }
1020: }
1021: }
1022: return $spare_server;
1023: }
1024:
1025: sub compare_server_load {
1026: my ($try_server, $spare_server, $lowest_load, $required) = @_;
1027:
1028: if ($required) {
1029: my ($reqdmajor,$reqdminor) = ($required =~ /^(\d+)\.(\d+)$/);
1030: my $remoterev = &get_server_loncaparev(undef,$try_server);
1031: my ($major,$minor) = ($remoterev =~ /^\'?(\d+)\.(\d+)\.[\w.\-]+\'?$/);
1032: if (($major eq '' && $minor eq '') ||
1033: (($reqdmajor > $major) || (($reqdmajor == $major) && ($reqdminor > $minor)))) {
1034: return ($spare_server,$lowest_load);
1035: }
1036: }
1037:
1038: my $loadans = &reply('load', $try_server);
1039: my $userloadans = &reply('userload',$try_server);
1040:
1041: if ($loadans !~ /\d/ && $userloadans !~ /\d/) {
1042: return ($spare_server, $lowest_load); #didn't get a number from the server
1043: }
1044:
1045: my $load;
1046: if ($loadans =~ /\d/) {
1047: if ($userloadans =~ /\d/) {
1048: #both are numbers, pick the bigger one
1049: $load = ($loadans > $userloadans) ? $loadans
1050: : $userloadans;
1051: } else {
1052: $load = $loadans;
1053: }
1054: } else {
1055: $load = $userloadans;
1056: }
1057:
1058: if (($load =~ /\d/) && ($load < $lowest_load)) {
1059: $spare_server = $try_server;
1060: $lowest_load = $load;
1061: }
1062: return ($spare_server,$lowest_load);
1063: }
1064:
1065: # --------------------------- ask offload servers if user already has a session
1066: sub find_existing_session {
1067: my ($udom,$uname) = @_;
1068: my $spareshash = &this_host_spares($udom);
1069: if (ref($spareshash) eq 'HASH') {
1070: if (ref($spareshash->{'primary'}) eq 'ARRAY') {
1071: foreach my $try_server (@{ $spareshash->{'primary'} }) {
1072: return $try_server if (&has_user_session($try_server, $udom, $uname));
1073: }
1074: }
1075: if (ref($spareshash->{'default'}) eq 'ARRAY') {
1076: foreach my $try_server (@{ $spareshash->{'default'} }) {
1077: return $try_server if (&has_user_session($try_server, $udom, $uname));
1078: }
1079: }
1080: }
1081: return;
1082: }
1083:
1084: # check if user's browser sent load balancer cookie and server still has session
1085: # and is not overloaded.
1086: sub check_for_balancer_cookie {
1087: my ($r,$update_mtime) = @_;
1088: my ($otherserver,$cookie);
1089: my %cookies=CGI::Cookie->parse($r->header_in('Cookie'));
1090: if (exists($cookies{'balanceID'})) {
1091: my $balid = $cookies{'balanceID'};
1092: $cookie=&LONCAPA::clean_handle($balid->value);
1093: my $balancedir=$r->dir_config('lonBalanceDir');
1094: if ((-d $balancedir) && (-e "$balancedir/$cookie.id")) {
1095: if ($cookie =~ /^($match_domain)_($match_username)_[a-f0-9]+$/) {
1096: my ($possudom,$possuname) = ($1,$2);
1097: my $has_session = 0;
1098: if ((&domain($possudom) ne '') &&
1099: (&homeserver($possuname,$possudom) ne 'no_host')) {
1100: my $try_server;
1101: my $opened = open(my $idf,'+<',"$balancedir/$cookie.id");
1102: if ($opened) {
1103: flock($idf,LOCK_SH);
1104: while (my $line = <$idf>) {
1105: chomp($line);
1106: if (&hostname($line) ne '') {
1107: $try_server = $line;
1108: last;
1109: }
1110: }
1111: close($idf);
1112: if (($try_server) &&
1113: (&has_user_session($try_server,$possudom,$possuname))) {
1114: my $lowest_load = 30000;
1115: ($otherserver,$lowest_load) =
1116: &compare_server_load($try_server,undef,$lowest_load);
1117: if ($otherserver ne '' && $lowest_load < 100) {
1118: $has_session = 1;
1119: } else {
1120: undef($otherserver);
1121: }
1122: }
1123: }
1124: }
1125: if ($has_session) {
1126: if ($update_mtime) {
1127: my $atime = my $mtime = time;
1128: utime($atime,$mtime,"$balancedir/$cookie.id");
1129: }
1130: } else {
1131: unlink("$balancedir/$cookie.id");
1132: }
1133: }
1134: }
1135: }
1136: return ($otherserver,$cookie);
1137: }
1138:
1139: sub delbalcookie {
1140: my ($cookie,$balancer) =@_;
1141: if ($cookie =~ /^($match_domain)\_($match_username)\_[a-f0-9]{32}$/) {
1142: my ($udom,$uname) = ($1,$2);
1143: my $uprimary_id = &domain($udom,'primary');
1144: my $uintdom = &internet_dom($uprimary_id);
1145: my $intdom = &internet_dom($balancer);
1146: my $serverhomedom = &host_domain($balancer);
1147: if (($uintdom ne '') && ($uintdom eq $intdom)) {
1148: return &reply("delbalcookie:$cookie",$balancer);
1149: }
1150: }
1151: }
1152:
1153: # -------------------------------- ask if server already has a session for user
1154: sub has_user_session {
1155: my ($lonid,$udom,$uname) = @_;
1156: my $result = &reply(join(':','userhassession',
1157: map {&escape($_)} ($udom,$uname)),$lonid);
1158: return 1 if ($result eq 'ok');
1159:
1160: return 0;
1161: }
1162:
1163: # --------- determine least loaded server in a user's domain which allows login
1164:
1165: sub choose_server {
1166: my ($udom,$checkloginvia,$required,$skiploadbal) = @_;
1167: my %domconfhash = &Apache::loncommon::get_domainconf($udom);
1168: my %servers = &get_servers($udom);
1169: my $lowest_load = 30000;
1170: my ($login_host,$hostname,$portal_path,$isredirect,$balancers);
1171: if ($skiploadbal) {
1172: ($balancers,my $cached)=&is_cached_new('loadbalancing',$udom);
1173: unless (defined($cached)) {
1174: my $cachetime = 60*60*24;
1175: my %domconfig =
1176: &Apache::lonnet::get_dom('configuration',['loadbalancing'],$udom);
1177: if (ref($domconfig{'loadbalancing'}) eq 'HASH') {
1178: $balancers = &do_cache_new('loadbalancing',$udom,$domconfig{'loadbalancing'},
1179: $cachetime);
1180: }
1181: }
1182: }
1183: foreach my $lonhost (keys(%servers)) {
1184: if ($skiploadbal) {
1185: if (ref($balancers) eq 'HASH') {
1186: next if (exists($balancers->{$lonhost}));
1187: }
1188: }
1189: my $loginvia;
1190: if ($checkloginvia) {
1191: $loginvia = $domconfhash{$udom.'.login.loginvia_'.$lonhost};
1192: if ($loginvia) {
1193: my ($server,$path) = split(/:/,$loginvia);
1194: ($login_host, $lowest_load) =
1195: &compare_server_load($server, $login_host, $lowest_load, $required);
1196: if ($login_host eq $server) {
1197: $portal_path = $path;
1198: $isredirect = 1;
1199: }
1200: } else {
1201: ($login_host, $lowest_load) =
1202: &compare_server_load($lonhost, $login_host, $lowest_load, $required);
1203: if ($login_host eq $lonhost) {
1204: $portal_path = '';
1205: $isredirect = '';
1206: }
1207: }
1208: } else {
1209: ($login_host, $lowest_load) =
1210: &compare_server_load($lonhost, $login_host, $lowest_load, $required);
1211: }
1212: }
1213: if ($login_host ne '') {
1214: $hostname = &hostname($login_host);
1215: }
1216: return ($login_host,$hostname,$portal_path,$isredirect,$lowest_load);
1217: }
1218:
1219: # --------------------------------------------- Try to change a user's password
1220:
1221: sub changepass {
1222: my ($uname,$udom,$currentpass,$newpass,$server,$context)=@_;
1223: $currentpass = &escape($currentpass);
1224: $newpass = &escape($newpass);
1225: my $lonhost = $perlvar{'lonHostID'};
1226: my $answer = reply("encrypt:passwd:$udom:$uname:$currentpass:$newpass:$context:$lonhost",
1227: $server);
1228: if (! $answer) {
1229: &logthis("No reply on password change request to $server ".
1230: "by $uname in domain $udom.");
1231: } elsif ($answer =~ "^ok") {
1232: &logthis("$uname in $udom successfully changed their password ".
1233: "on $server.");
1234: } elsif ($answer =~ "^pwchange_failure") {
1235: &logthis("$uname in $udom was unable to change their password ".
1236: "on $server. The action was blocked by either lcpasswd ".
1237: "or pwchange");
1238: } elsif ($answer =~ "^non_authorized") {
1239: &logthis("$uname in $udom did not get their password correct when ".
1240: "attempting to change it on $server.");
1241: } elsif ($answer =~ "^auth_mode_error") {
1242: &logthis("$uname in $udom attempted to change their password despite ".
1243: "not being locally or internally authenticated on $server.");
1244: } elsif ($answer =~ "^unknown_user") {
1245: &logthis("$uname in $udom attempted to change their password ".
1246: "on $server but were unable to because $server is not ".
1247: "their home server.");
1248: } elsif ($answer =~ "^refused") {
1249: &logthis("$server refused to change $uname in $udom password because ".
1250: "it was sent an unencrypted request to change the password.");
1251: } elsif ($answer =~ "invalid_client") {
1252: &logthis("$server refused to change $uname in $udom password because ".
1253: "it was a reset by e-mail originating from an invalid server.");
1254: }
1255: return $answer;
1256: }
1257:
1258: # ----------------------- Try to determine user's current authentication scheme
1259:
1260: sub queryauthenticate {
1261: my ($uname,$udom)=@_;
1262: my $uhome=&homeserver($uname,$udom);
1263: if (!$uhome) {
1264: &logthis("User $uname at $udom is unknown when looking for authentication mechanism");
1265: return 'no_host';
1266: }
1267: my $answer=reply("encrypt:currentauth:$udom:$uname",$uhome);
1268: if ($answer =~ /^(unknown_user|refused|con_lost)/) {
1269: &logthis("User $uname at $udom threw error $answer when checking authentication mechanism");
1270: }
1271: return $answer;
1272: }
1273:
1274: # --------- Try to authenticate user from domain's lib servers (first this one)
1275:
1276: sub authenticate {
1277: my ($uname,$upass,$udom,$checkdefauth,$clientcancheckhost)=@_;
1278: $upass=&escape($upass);
1279: $uname= &LONCAPA::clean_username($uname);
1280: my $uhome=&homeserver($uname,$udom,1);
1281: my $newhome;
1282: if ((!$uhome) || ($uhome eq 'no_host')) {
1283: # Maybe the machine was offline and only re-appeared again recently?
1284: &reconlonc();
1285: # One more
1286: $uhome=&homeserver($uname,$udom,1);
1287: if (($uhome eq 'no_host') && $checkdefauth) {
1288: if (defined(&domain($udom,'primary'))) {
1289: $newhome=&domain($udom,'primary');
1290: }
1291: if ($newhome ne '') {
1292: $uhome = $newhome;
1293: }
1294: }
1295: if ((!$uhome) || ($uhome eq 'no_host')) {
1296: &logthis("User $uname at $udom is unknown in authenticate");
1297: return 'no_host';
1298: }
1299: }
1300: my $answer=reply("encrypt:auth:$udom:$uname:$upass:$checkdefauth:$clientcancheckhost",$uhome);
1301: if ($answer eq 'authorized') {
1302: if ($newhome) {
1303: &logthis("User $uname at $udom authorized by $uhome, but needs account");
1304: return 'no_account_on_host';
1305: } else {
1306: &logthis("User $uname at $udom authorized by $uhome");
1307: return $uhome;
1308: }
1309: }
1310: if ($answer eq 'non_authorized') {
1311: &logthis("User $uname at $udom rejected by $uhome");
1312: return 'no_host';
1313: }
1314: &logthis("User $uname at $udom threw error $answer when checking authentication mechanism");
1315: return 'no_host';
1316: }
1317:
1318: sub can_host_session {
1319: my ($udom,$lonhost,$remoterev,$remotesessions,$hostedsessions) = @_;
1320: my $canhost = 1;
1321: my $host_idn = &Apache::lonnet::internet_dom($lonhost);
1322: if (ref($remotesessions) eq 'HASH') {
1323: if (ref($remotesessions->{'excludedomain'}) eq 'ARRAY') {
1324: if (grep(/^\Q$host_idn\E$/,@{$remotesessions->{'excludedomain'}})) {
1325: $canhost = 0;
1326: } else {
1327: $canhost = 1;
1328: }
1329: }
1330: if (ref($remotesessions->{'includedomain'}) eq 'ARRAY') {
1331: if (grep(/^\Q$host_idn\E$/,@{$remotesessions->{'includedomain'}})) {
1332: $canhost = 1;
1333: } else {
1334: $canhost = 0;
1335: }
1336: }
1337: if ($canhost) {
1338: if ($remotesessions->{'version'} ne '') {
1339: my ($reqmajor,$reqminor) = ($remotesessions->{'version'} =~ /^(\d+)\.(\d+)$/);
1340: if ($reqmajor ne '' && $reqminor ne '') {
1341: if ($remoterev =~ /^\'?(\d+)\.(\d+)/) {
1342: my $major = $1;
1343: my $minor = $2;
1344: if (($major < $reqmajor ) ||
1345: (($major == $reqmajor) && ($minor < $reqminor))) {
1346: $canhost = 0;
1347: }
1348: } else {
1349: $canhost = 0;
1350: }
1351: }
1352: }
1353: }
1354: }
1355: if ($canhost) {
1356: if (ref($hostedsessions) eq 'HASH') {
1357: my $uprimary_id = &Apache::lonnet::domain($udom,'primary');
1358: my $uint_dom = &Apache::lonnet::internet_dom($uprimary_id);
1359: if (ref($hostedsessions->{'excludedomain'}) eq 'ARRAY') {
1360: if (($uint_dom ne '') &&
1361: (grep(/^\Q$uint_dom\E$/,@{$hostedsessions->{'excludedomain'}}))) {
1362: $canhost = 0;
1363: } else {
1364: $canhost = 1;
1365: }
1366: }
1367: if (ref($hostedsessions->{'includedomain'}) eq 'ARRAY') {
1368: if (($uint_dom ne '') &&
1369: (grep(/^\Q$uint_dom\E$/,@{$hostedsessions->{'includedomain'}}))) {
1370: $canhost = 1;
1371: } else {
1372: $canhost = 0;
1373: }
1374: }
1375: }
1376: }
1377: return $canhost;
1378: }
1379:
1380: sub spare_can_host {
1381: my ($udom,$uint_dom,$remotesessions,$try_server)=@_;
1382: my $canhost=1;
1383: my $try_server_hostname = &hostname($try_server);
1384: my $serverhomeID = &get_server_homeID($try_server_hostname);
1385: my $serverhomedom = &host_domain($serverhomeID);
1386: my %defdomdefaults = &get_domain_defaults($serverhomedom);
1387: if (ref($defdomdefaults{'offloadnow'}) eq 'HASH') {
1388: if ($defdomdefaults{'offloadnow'}{$try_server}) {
1389: $canhost = 0;
1390: }
1391: }
1392: if (($canhost) && ($uint_dom)) {
1393: my @intdoms;
1394: my $internet_names = &get_internet_names($try_server);
1395: if (ref($internet_names) eq 'ARRAY') {
1396: @intdoms = @{$internet_names};
1397: }
1398: unless (grep(/^\Q$uint_dom\E$/,@intdoms)) {
1399: my $remoterev = &get_server_loncaparev(undef,$try_server);
1400: $canhost = &can_host_session($udom,$try_server,$remoterev,
1401: $remotesessions,
1402: $defdomdefaults{'hostedsessions'});
1403: }
1404: }
1405: return $canhost;
1406: }
1407:
1408: sub this_host_spares {
1409: my ($dom) = @_;
1410: my ($dom_in_use,$lonhost_in_use,$result);
1411: my @hosts = ¤t_machine_ids();
1412: foreach my $lonhost (@hosts) {
1413: if (&host_domain($lonhost) eq $dom) {
1414: $dom_in_use = $dom;
1415: $lonhost_in_use = $lonhost;
1416: last;
1417: }
1418: }
1419: if ($dom_in_use ne '') {
1420: $result = &spares_for_offload($dom_in_use,$lonhost_in_use);
1421: }
1422: if (ref($result) ne 'HASH') {
1423: $lonhost_in_use = $perlvar{'lonHostID'};
1424: $dom_in_use = &host_domain($lonhost_in_use);
1425: $result = &spares_for_offload($dom_in_use,$lonhost_in_use);
1426: if (ref($result) ne 'HASH') {
1427: $result = \%spareid;
1428: }
1429: }
1430: return $result;
1431: }
1432:
1433: sub spares_for_offload {
1434: my ($dom_in_use,$lonhost_in_use) = @_;
1435: my ($result,$cached)=&is_cached_new('spares',$dom_in_use);
1436: if (defined($cached)) {
1437: return $result;
1438: } else {
1439: my $cachetime = 60*60*24;
1440: my %domconfig =
1441: &Apache::lonnet::get_dom('configuration',['usersessions'],$dom_in_use);
1442: if (ref($domconfig{'usersessions'}) eq 'HASH') {
1443: if (ref($domconfig{'usersessions'}{'spares'}) eq 'HASH') {
1444: if (ref($domconfig{'usersessions'}{'spares'}{$lonhost_in_use}) eq 'HASH') {
1445: return &do_cache_new('spares',$dom_in_use,$domconfig{'usersessions'}{'spares'}{$lonhost_in_use},$cachetime);
1446: }
1447: }
1448: }
1449: }
1450: return;
1451: }
1452:
1453: sub get_lonbalancer_config {
1454: my ($servers) = @_;
1455: my ($currbalancer,$currtargets);
1456: if (ref($servers) eq 'HASH') {
1457: foreach my $server (keys(%{$servers})) {
1458: my %what = (
1459: spareid => 1,
1460: perlvar => 1,
1461: );
1462: my ($result,$returnhash) = &get_remote_globals($server,\%what);
1463: if ($result eq 'ok') {
1464: if (ref($returnhash) eq 'HASH') {
1465: if (ref($returnhash->{'perlvar'}) eq 'HASH') {
1466: if ($returnhash->{'perlvar'}->{'lonBalancer'} eq 'yes') {
1467: $currbalancer = $server;
1468: $currtargets = {};
1469: if (ref($returnhash->{'spareid'}) eq 'HASH') {
1470: if (ref($returnhash->{'spareid'}->{'primary'}) eq 'ARRAY') {
1471: $currtargets->{'primary'} = $returnhash->{'spareid'}->{'primary'};
1472: }
1473: if (ref($returnhash->{'spareid'}->{'default'}) eq 'ARRAY') {
1474: $currtargets->{'default'} = $returnhash->{'spareid'}->{'default'};
1475: }
1476: }
1477: last;
1478: }
1479: }
1480: }
1481: }
1482: }
1483: }
1484: return ($currbalancer,$currtargets);
1485: }
1486:
1487: sub check_loadbalancing {
1488: my ($uname,$udom,$caller) = @_;
1489: my ($is_balancer,$currtargets,$currrules,$dom_in_use,$homeintdom,
1490: $rule_in_effect,$offloadto,$otherserver,$setcookie,$dom_balancers);
1491: my $lonhost = $perlvar{'lonHostID'};
1492: my @hosts = ¤t_machine_ids();
1493: my $uprimary_id = &Apache::lonnet::domain($udom,'primary');
1494: my $uintdom = &Apache::lonnet::internet_dom($uprimary_id);
1495: my $intdom = &Apache::lonnet::internet_dom($lonhost);
1496: my $serverhomedom = &host_domain($lonhost);
1497: my $domneedscache;
1498: my $cachetime = 60*60*24;
1499:
1500: if (($uintdom ne '') && ($uintdom eq $intdom)) {
1501: $dom_in_use = $udom;
1502: $homeintdom = 1;
1503: } else {
1504: $dom_in_use = $serverhomedom;
1505: }
1506: my ($result,$cached)=&is_cached_new('loadbalancing',$dom_in_use);
1507: unless (defined($cached)) {
1508: my %domconfig =
1509: &Apache::lonnet::get_dom('configuration',['loadbalancing'],$dom_in_use);
1510: if (ref($domconfig{'loadbalancing'}) eq 'HASH') {
1511: $result = &do_cache_new('loadbalancing',$dom_in_use,$domconfig{'loadbalancing'},$cachetime);
1512: } else {
1513: $domneedscache = $dom_in_use;
1514: }
1515: }
1516: if (ref($result) eq 'HASH') {
1517: ($is_balancer,$currtargets,$currrules,$setcookie,$dom_balancers) =
1518: &check_balancer_result($result,@hosts);
1519: if ($is_balancer) {
1520: if (ref($currrules) eq 'HASH') {
1521: if ($homeintdom) {
1522: if ($uname ne '') {
1523: if (($currrules->{'_LC_adv'} ne '') || ($currrules->{'_LC_author'} ne '')) {
1524: my ($is_adv,$is_author) = &is_advanced_user($udom,$uname);
1525: if (($currrules->{'_LC_author'} ne '') && ($is_author)) {
1526: $rule_in_effect = $currrules->{'_LC_author'};
1527: } elsif (($currrules->{'_LC_adv'} ne '') && ($is_adv)) {
1528: $rule_in_effect = $currrules->{'_LC_adv'}
1529: }
1530: }
1531: if ($rule_in_effect eq '') {
1532: my %userenv = &userenvironment($udom,$uname,'inststatus');
1533: if ($userenv{'inststatus'} ne '') {
1534: my @statuses = map { &unescape($_); } split(/:/,$userenv{'inststatus'});
1535: my ($othertitle,$usertypes,$types) =
1536: &Apache::loncommon::sorted_inst_types($udom);
1537: if (ref($types) eq 'ARRAY') {
1538: foreach my $type (@{$types}) {
1539: if (grep(/^\Q$type\E$/,@statuses)) {
1540: if (exists($currrules->{$type})) {
1541: $rule_in_effect = $currrules->{$type};
1542: }
1543: }
1544: }
1545: }
1546: } else {
1547: if (exists($currrules->{'default'})) {
1548: $rule_in_effect = $currrules->{'default'};
1549: }
1550: }
1551: }
1552: } else {
1553: if (exists($currrules->{'default'})) {
1554: $rule_in_effect = $currrules->{'default'};
1555: }
1556: }
1557: } else {
1558: if ($currrules->{'_LC_external'} ne '') {
1559: $rule_in_effect = $currrules->{'_LC_external'};
1560: }
1561: }
1562: $offloadto = &get_loadbalancer_targets($rule_in_effect,$currtargets,
1563: $uname,$udom);
1564: }
1565: }
1566: } elsif (($homeintdom) && ($udom ne $serverhomedom)) {
1567: ($result,$cached)=&is_cached_new('loadbalancing',$serverhomedom);
1568: unless (defined($cached)) {
1569: my %domconfig =
1570: &Apache::lonnet::get_dom('configuration',['loadbalancing'],$serverhomedom);
1571: if (ref($domconfig{'loadbalancing'}) eq 'HASH') {
1572: $result = &do_cache_new('loadbalancing',$serverhomedom,$domconfig{'loadbalancing'},$cachetime);
1573: } else {
1574: $domneedscache = $serverhomedom;
1575: }
1576: }
1577: if (ref($result) eq 'HASH') {
1578: ($is_balancer,$currtargets,$currrules,$setcookie,$dom_balancers) =
1579: &check_balancer_result($result,@hosts);
1580: if ($is_balancer) {
1581: if (ref($currrules) eq 'HASH') {
1582: if ($currrules->{'_LC_internetdom'} ne '') {
1583: $rule_in_effect = $currrules->{'_LC_internetdom'};
1584: }
1585: }
1586: $offloadto = &get_loadbalancer_targets($rule_in_effect,$currtargets,
1587: $uname,$udom);
1588: }
1589: } else {
1590: if ($perlvar{'lonBalancer'} eq 'yes') {
1591: $is_balancer = 1;
1592: $offloadto = &this_host_spares($dom_in_use);
1593: }
1594: unless (defined($cached)) {
1595: $domneedscache = $serverhomedom;
1596: }
1597: }
1598: } else {
1599: if ($perlvar{'lonBalancer'} eq 'yes') {
1600: $is_balancer = 1;
1601: $offloadto = &this_host_spares($dom_in_use);
1602: }
1603: unless (defined($cached)) {
1604: $domneedscache = $serverhomedom;
1605: }
1606: }
1607: if ($domneedscache) {
1608: &do_cache_new('loadbalancing',$domneedscache,$is_balancer,$cachetime);
1609: }
1610: if ($is_balancer) {
1611: my $lowest_load = 30000;
1612: if (ref($offloadto) eq 'HASH') {
1613: if (ref($offloadto->{'primary'}) eq 'ARRAY') {
1614: foreach my $try_server (@{$offloadto->{'primary'}}) {
1615: ($otherserver,$lowest_load) =
1616: &compare_server_load($try_server,$otherserver,$lowest_load);
1617: }
1618: }
1619: my $found_server = ($otherserver ne '' && $lowest_load < 100);
1620:
1621: if (!$found_server) {
1622: if (ref($offloadto->{'default'}) eq 'ARRAY') {
1623: foreach my $try_server (@{$offloadto->{'default'}}) {
1624: ($otherserver,$lowest_load) =
1625: &compare_server_load($try_server,$otherserver,$lowest_load);
1626: }
1627: }
1628: }
1629: } elsif (ref($offloadto) eq 'ARRAY') {
1630: if (@{$offloadto} == 1) {
1631: $otherserver = $offloadto->[0];
1632: } elsif (@{$offloadto} > 1) {
1633: foreach my $try_server (@{$offloadto}) {
1634: ($otherserver,$lowest_load) =
1635: &compare_server_load($try_server,$otherserver,$lowest_load);
1636: }
1637: }
1638: }
1639: unless ($caller eq 'login') {
1640: if (($otherserver ne '') && (grep(/^\Q$otherserver\E$/,@hosts))) {
1641: $is_balancer = 0;
1642: if ($uname ne '' && $udom ne '') {
1643: if (($env{'user.name'} eq $uname) && ($env{'user.domain'} eq $udom)) {
1644: &appenv({'user.loadbalexempt' => $lonhost,
1645: 'user.loadbalcheck.time' => time});
1646: }
1647: }
1648: }
1649: }
1650: unless ($homeintdom) {
1651: undef($setcookie);
1652: }
1653: }
1654: return ($is_balancer,$otherserver,$setcookie,$offloadto,$dom_balancers);
1655: }
1656:
1657: sub check_balancer_result {
1658: my ($result,@hosts) = @_;
1659: my ($is_balancer,$currtargets,$currrules,$setcookie,$dom_balancers);
1660: if (ref($result) eq 'HASH') {
1661: if ($result->{'lonhost'} ne '') {
1662: my $currbalancer = $result->{'lonhost'};
1663: if (grep(/^\Q$currbalancer\E$/,@hosts)) {
1664: $is_balancer = 1;
1665: $currtargets = $result->{'targets'};
1666: $currrules = $result->{'rules'};
1667: }
1668: $dom_balancers = $currbalancer;
1669: } else {
1670: if (keys(%{$result})) {
1671: foreach my $key (keys(%{$result})) {
1672: if (($key ne '') && (grep(/^\Q$key\E$/,@hosts)) &&
1673: (ref($result->{$key}) eq 'HASH')) {
1674: $is_balancer = 1;
1675: $currrules = $result->{$key}{'rules'};
1676: $currtargets = $result->{$key}{'targets'};
1677: $setcookie = $result->{$key}{'cookie'};
1678: last;
1679: }
1680: }
1681: $dom_balancers = join(',',sort(keys(%{$result})));
1682: }
1683: }
1684: }
1685: return ($is_balancer,$currtargets,$currrules,$setcookie,$dom_balancers);
1686: }
1687:
1688: sub get_loadbalancer_targets {
1689: my ($rule_in_effect,$currtargets,$uname,$udom) = @_;
1690: my $offloadto;
1691: if ($rule_in_effect eq 'none') {
1692: return [$perlvar{'lonHostID'}];
1693: } elsif ($rule_in_effect eq '') {
1694: $offloadto = $currtargets;
1695: } else {
1696: if ($rule_in_effect eq 'homeserver') {
1697: my $homeserver = &homeserver($uname,$udom);
1698: if ($homeserver ne 'no_host') {
1699: $offloadto = [$homeserver];
1700: }
1701: } elsif ($rule_in_effect eq 'externalbalancer') {
1702: my %domconfig =
1703: &Apache::lonnet::get_dom('configuration',['loadbalancing'],$udom);
1704: if (ref($domconfig{'loadbalancing'}) eq 'HASH') {
1705: if ($domconfig{'loadbalancing'}{'lonhost'} ne '') {
1706: if (&hostname($domconfig{'loadbalancing'}{'lonhost'}) ne '') {
1707: $offloadto = [$domconfig{'loadbalancing'}{'lonhost'}];
1708: }
1709: }
1710: } else {
1711: my %servers = &internet_dom_servers($udom);
1712: my ($remotebalancer,$remotetargets) = &get_lonbalancer_config(\%servers);
1713: if (&hostname($remotebalancer) ne '') {
1714: $offloadto = [$remotebalancer];
1715: }
1716: }
1717: } elsif (&hostname($rule_in_effect) ne '') {
1718: $offloadto = [$rule_in_effect];
1719: }
1720: }
1721: return $offloadto;
1722: }
1723:
1724: sub internet_dom_servers {
1725: my ($dom) = @_;
1726: my (%uniqservers,%servers);
1727: my $primaryserver = &hostname(&domain($dom,'primary'));
1728: my @machinedoms = &machine_domains($primaryserver);
1729: foreach my $mdom (@machinedoms) {
1730: my %currservers = %servers;
1731: my %server = &get_servers($mdom);
1732: %servers = (%currservers,%server);
1733: }
1734: my %by_hostname;
1735: foreach my $id (keys(%servers)) {
1736: push(@{$by_hostname{$servers{$id}}},$id);
1737: }
1738: foreach my $hostname (sort(keys(%by_hostname))) {
1739: if (@{$by_hostname{$hostname}} > 1) {
1740: my $match = 0;
1741: foreach my $id (@{$by_hostname{$hostname}}) {
1742: if (&host_domain($id) eq $dom) {
1743: $uniqservers{$id} = $hostname;
1744: $match = 1;
1745: }
1746: }
1747: unless ($match) {
1748: $uniqservers{$by_hostname{$hostname}[0]} = $hostname;
1749: }
1750: } else {
1751: $uniqservers{$by_hostname{$hostname}[0]} = $hostname;
1752: }
1753: }
1754: return %uniqservers;
1755: }
1756:
1757: sub trusted_domains {
1758: my ($cmdtype,$calldom) = @_;
1759: my ($trusted,$untrusted);
1760: if (&domain($calldom) eq '') {
1761: return ($trusted,$untrusted);
1762: }
1763: unless ($cmdtype =~ /^(content|shared|enroll|coaurem|othcoau|domroles|catalog|reqcrs|msg)$/) {
1764: return ($trusted,$untrusted);
1765: }
1766: my $callprimary = &domain($calldom,'primary');
1767: my $intcalldom = &Apache::lonnet::internet_dom($callprimary);
1768: if ($intcalldom eq '') {
1769: return ($trusted,$untrusted);
1770: }
1771:
1772: my ($trustconfig,$cached)=&Apache::lonnet::is_cached_new('trust',$calldom);
1773: unless (defined($cached)) {
1774: my %domconfig = &Apache::lonnet::get_dom('configuration',['trust'],$calldom);
1775: &Apache::lonnet::do_cache_new('trust',$calldom,$domconfig{'trust'},3600);
1776: $trustconfig = $domconfig{'trust'};
1777: }
1778: if (ref($trustconfig)) {
1779: my (%possexc,%possinc,@allexc,@allinc);
1780: if (ref($trustconfig->{$cmdtype}) eq 'HASH') {
1781: if (ref($trustconfig->{$cmdtype}->{'exc'}) eq 'ARRAY') {
1782: map { $possexc{$_} = 1; } @{$trustconfig->{$cmdtype}->{'exc'}};
1783: }
1784: if (ref($trustconfig->{$cmdtype}->{'inc'}) eq 'ARRAY') {
1785: $possinc{$intcalldom} = 1;
1786: map { $possinc{$_} = 1; } @{$trustconfig->{$cmdtype}->{'inc'}};
1787: }
1788: }
1789: if (keys(%possexc)) {
1790: if (keys(%possinc)) {
1791: foreach my $key (sort(keys(%possexc))) {
1792: next if ($key eq $intcalldom);
1793: unless ($possinc{$key}) {
1794: push(@allexc,$key);
1795: }
1796: }
1797: } else {
1798: @allexc = sort(keys(%possexc));
1799: }
1800: }
1801: if (keys(%possinc)) {
1802: $possinc{$intcalldom} = 1;
1803: @allinc = sort(keys(%possinc));
1804: }
1805: if ((@allexc > 0) || (@allinc > 0)) {
1806: my %doms_by_intdom;
1807: my %allintdoms = &all_host_intdom();
1808: my %alldoms = &all_host_domain();
1809: foreach my $key (%allintdoms) {
1810: if (ref($doms_by_intdom{$allintdoms{$key}}) eq 'ARRAY') {
1811: unless (grep(/^\Q$alldoms{$key}\E$/,@{$doms_by_intdom{$allintdoms{$key}}})) {
1812: push(@{$doms_by_intdom{$allintdoms{$key}}},$alldoms{$key});
1813: }
1814: } else {
1815: $doms_by_intdom{$allintdoms{$key}} = [$alldoms{$key}];
1816: }
1817: }
1818: foreach my $exc (@allexc) {
1819: if (ref($doms_by_intdom{$exc}) eq 'ARRAY') {
1820: push(@{$untrusted},@{$doms_by_intdom{$exc}});
1821: }
1822: }
1823: foreach my $inc (@allinc) {
1824: if (ref($doms_by_intdom{$inc}) eq 'ARRAY') {
1825: push(@{$trusted},@{$doms_by_intdom{$inc}});
1826: }
1827: }
1828: }
1829: }
1830: return ($trusted,$untrusted);
1831: }
1832:
1833: sub will_trust {
1834: my ($cmdtype,$domain,$possdom) = @_;
1835: return 1 if ($domain eq $possdom);
1836: my ($trustedref,$untrustedref) = &trusted_domains($cmdtype,$possdom);
1837: my $willtrust;
1838: if ((ref($trustedref) eq 'ARRAY') && (@{$trustedref} > 0)) {
1839: if (grep(/^\Q$domain\E$/,@{$trustedref})) {
1840: $willtrust = 1;
1841: }
1842: } elsif ((ref($untrustedref) eq 'ARRAY') && (@{$untrustedref} > 0)) {
1843: unless (grep(/^\Q$domain\E$/,@{$untrustedref})) {
1844: $willtrust = 1;
1845: }
1846: } else {
1847: $willtrust = 1;
1848: }
1849: return $willtrust;
1850: }
1851:
1852: # ---------------------- Find the homebase for a user from domain's lib servers
1853:
1854: my %homecache;
1855: sub homeserver {
1856: my ($uname,$udom,$ignoreBadCache)=@_;
1857: my $index="$uname:$udom";
1858:
1859: if (exists($homecache{$index})) { return $homecache{$index}; }
1860:
1861: my %servers = &get_servers($udom,'library');
1862: foreach my $tryserver (keys(%servers)) {
1863: next if ($ignoreBadCache ne 'true' &&
1864: exists($badServerCache{$tryserver}));
1865:
1866: my $answer=reply("home:$udom:$uname",$tryserver);
1867: if ($answer eq 'found') {
1868: delete($badServerCache{$tryserver});
1869: return $homecache{$index}=$tryserver;
1870: } elsif ($answer eq 'no_host') {
1871: $badServerCache{$tryserver}=1;
1872: }
1873: }
1874: return 'no_host';
1875: }
1876:
1877: # ----- Find the usernames behind a list of student/employee IDs or clicker IDs
1878:
1879: sub idget {
1880: my ($udom,$idsref,$namespace)=@_;
1881: my %returnhash=();
1882: my @ids=();
1883: if (ref($idsref) eq 'ARRAY') {
1884: @ids = @{$idsref};
1885: } else {
1886: return %returnhash;
1887: }
1888: if ($namespace eq '') {
1889: $namespace = 'ids';
1890: }
1891:
1892: my %servers = &get_servers($udom,'library');
1893: foreach my $tryserver (keys(%servers)) {
1894: my $idlist=join('&', map { &escape($_); } @ids);
1895: if ($namespace eq 'ids') {
1896: $idlist=~tr/A-Z/a-z/;
1897: }
1898: my $reply;
1899: if ($namespace eq 'ids') {
1900: $reply=&reply("idget:$udom:".$idlist,$tryserver);
1901: } else {
1902: $reply=&reply("getdom:$udom:$namespace:$idlist",$tryserver);
1903: }
1904: my @answer=();
1905: if (($reply ne 'con_lost') && ($reply!~/^error\:/)) {
1906: @answer=split(/\&/,$reply);
1907: } ;
1908: my $i;
1909: for ($i=0;$i<=$#ids;$i++) {
1910: if ($answer[$i]) {
1911: $returnhash{$ids[$i]}=&unescape($answer[$i]);
1912: }
1913: }
1914: }
1915: return %returnhash;
1916: }
1917:
1918: # ------------------------------------- Find the IDs behind a list of usernames
1919:
1920: sub idrget {
1921: my ($udom,@unames)=@_;
1922: my %returnhash=();
1923: foreach my $uname (@unames) {
1924: $returnhash{$uname}=(&userenvironment($udom,$uname,'id'))[1];
1925: }
1926: return %returnhash;
1927: }
1928:
1929: # Store away a list of names and associated student/employee IDs or clicker IDs
1930:
1931: sub idput {
1932: my ($udom,$idsref,$uhom,$namespace)=@_;
1933: my %servers=();
1934: my %ids=();
1935: my %byid = ();
1936: if (ref($idsref) eq 'HASH') {
1937: %ids=%{$idsref};
1938: }
1939: if ($namespace eq '') {
1940: $namespace = 'ids';
1941: }
1942: foreach my $uname (keys(%ids)) {
1943: &cput('environment',{'id'=>$ids{$uname}},$udom,$uname);
1944: if ($uhom eq '') {
1945: $uhom=&homeserver($uname,$udom);
1946: }
1947: if ($uhom ne 'no_host') {
1948: my $esc_unam=&escape($uname);
1949: if ($namespace eq 'ids') {
1950: my $id=&escape($ids{$uname});
1951: $id=~tr/A-Z/a-z/;
1952: my $esc_unam=&escape($uname);
1953: $servers{$uhom}.=$id.'='.$esc_unam.'&';
1954: } else {
1955: my @currids = split(/,/,$ids{$uname});
1956: foreach my $id (@currids) {
1957: $byid{$uhom}{$id} .= $uname.',';
1958: }
1959: }
1960: }
1961: }
1962: if ($namespace eq 'clickers') {
1963: foreach my $server (keys(%byid)) {
1964: if (ref($byid{$server}) eq 'HASH') {
1965: foreach my $id (keys(%{$byid{$server}})) {
1966: $byid{$server} =~ s/,$//;
1967: $servers{$uhom}.=&escape($id).'='.&escape($byid{$server}).'&';
1968: }
1969: }
1970: }
1971: }
1972: foreach my $server (keys(%servers)) {
1973: $servers{$server} =~ s/\&$//;
1974: if ($namespace eq 'ids') {
1975: &critical('idput:'.$udom.':'.$servers{$server},$server);
1976: } else {
1977: &critical('updateclickers:'.$udom.':add:'.$servers{$server},$server);
1978: }
1979: }
1980: }
1981:
1982: # ------------- Delete unwanted student/employee IDs or clicker IDs from domain
1983:
1984: sub iddel {
1985: my ($udom,$idshashref,$uhome,$namespace)=@_;
1986: my %result=();
1987: my %ids=();
1988: my %byid = ();
1989: if (ref($idshashref) eq 'HASH') {
1990: %ids=%{$idshashref};
1991: } else {
1992: return %result;
1993: }
1994: if ($namespace eq '') {
1995: $namespace = 'ids';
1996: }
1997: my %servers=();
1998: while (my ($id,$unamestr) = each(%ids)) {
1999: if ($namespace eq 'ids') {
2000: my $uhom = $uhome;
2001: if ($uhom eq '') {
2002: $uhom=&homeserver($unamestr,$udom);
2003: }
2004: if ($uhom ne 'no_host') {
2005: $servers{$uhom}.='&'.&escape($id);
2006: }
2007: } else {
2008: my @curritems = split(/,/,$ids{$id});
2009: foreach my $uname (@curritems) {
2010: my $uhom = $uhome;
2011: if ($uhom eq '') {
2012: $uhom=&homeserver($uname,$udom);
2013: }
2014: if ($uhom ne 'no_host') {
2015: $byid{$uhom}{$id} .= $uname.',';
2016: }
2017: }
2018: }
2019: }
2020: if ($namespace eq 'clickers') {
2021: foreach my $server (keys(%byid)) {
2022: if (ref($byid{$server}) eq 'HASH') {
2023: foreach my $id (keys(%{$byid{$server}})) {
2024: $byid{$server}{$id} =~ s/,$//;
2025: $servers{$server}.=&escape($id).'='.&escape($byid{$server}{$id}).'&';
2026: }
2027: }
2028: }
2029: }
2030: foreach my $server (keys(%servers)) {
2031: $servers{$server} =~ s/\&$//;
2032: if ($namespace eq 'ids') {
2033: $result{$server} = &critical('iddel:'.$udom.':'.$servers{$server},$uhome);
2034: } elsif ($namespace eq 'clickers') {
2035: $result{$server} = &critical('updateclickers:'.$udom.':del:'.$servers{$server},$server);
2036: }
2037: }
2038: return %result;
2039: }
2040:
2041: # ----- Update clicker ID-to-username look-ups in clickers.db on library server
2042:
2043: sub updateclickers {
2044: my ($udom,$action,$idshashref,$uhome,$critical) = @_;
2045: my %clickers;
2046: if (ref($idshashref) eq 'HASH') {
2047: %clickers=%{$idshashref};
2048: } else {
2049: return;
2050: }
2051: my $items='';
2052: foreach my $item (keys(%clickers)) {
2053: $items.=&escape($item).'='.&escape($clickers{$item}).'&';
2054: }
2055: $items=~s/\&$//;
2056: my $request = "updateclickers:$udom:$action:$items";
2057: if ($critical) {
2058: return &critical($request,$uhome);
2059: } else {
2060: return &reply($request,$uhome);
2061: }
2062: }
2063:
2064: # ------------------------------dump from db file owned by domainconfig user
2065: sub dump_dom {
2066: my ($namespace, $udom, $regexp) = @_;
2067:
2068: $udom ||= $env{'user.domain'};
2069:
2070: return () unless $udom;
2071:
2072: return &dump($namespace, $udom, &get_domainconfiguser($udom), $regexp);
2073: }
2074:
2075: # ------------------------------------------ get items from domain db files
2076:
2077: sub get_dom {
2078: my ($namespace,$storearr,$udom,$uhome)=@_;
2079: return if ($udom eq 'public');
2080: my $items='';
2081: foreach my $item (@$storearr) {
2082: $items.=&escape($item).'&';
2083: }
2084: $items=~s/\&$//;
2085: if (!$udom) {
2086: $udom=$env{'user.domain'};
2087: return if ($udom eq 'public');
2088: if (defined(&domain($udom,'primary'))) {
2089: $uhome=&domain($udom,'primary');
2090: } else {
2091: undef($uhome);
2092: }
2093: } else {
2094: if (!$uhome) {
2095: if (defined(&domain($udom,'primary'))) {
2096: $uhome=&domain($udom,'primary');
2097: }
2098: }
2099: }
2100: if ($udom && $uhome && ($uhome ne 'no_host')) {
2101: my $rep;
2102: if ($namespace =~ /^enc/) {
2103: $rep=&reply("encrypt:egetdom:$udom:$namespace:$items",$uhome);
2104: } else {
2105: $rep=&reply("getdom:$udom:$namespace:$items",$uhome);
2106: }
2107: my %returnhash;
2108: if ($rep eq '' || $rep =~ /^error: 2 /) {
2109: return %returnhash;
2110: }
2111: my @pairs=split(/\&/,$rep);
2112: if ( $#pairs==0 && $pairs[0] =~ /^(con_lost|error|no_such_host)/i) {
2113: return @pairs;
2114: }
2115: my $i=0;
2116: foreach my $item (@$storearr) {
2117: $returnhash{$item}=&thaw_unescape($pairs[$i]);
2118: $i++;
2119: }
2120: return %returnhash;
2121: } else {
2122: &logthis("get_dom failed - no homeserver and/or domain ($udom) ($uhome)");
2123: }
2124: }
2125:
2126: # -------------------------------------------- put items in domain db files
2127:
2128: sub put_dom {
2129: my ($namespace,$storehash,$udom,$uhome)=@_;
2130: if (!$udom) {
2131: $udom=$env{'user.domain'};
2132: if (defined(&domain($udom,'primary'))) {
2133: $uhome=&domain($udom,'primary');
2134: } else {
2135: undef($uhome);
2136: }
2137: } else {
2138: if (!$uhome) {
2139: if (defined(&domain($udom,'primary'))) {
2140: $uhome=&domain($udom,'primary');
2141: }
2142: }
2143: }
2144: if ($udom && $uhome && ($uhome ne 'no_host')) {
2145: my $items='';
2146: foreach my $item (keys(%$storehash)) {
2147: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
2148: }
2149: $items=~s/\&$//;
2150: if ($namespace =~ /^enc/) {
2151: return &reply("encrypt:putdom:$udom:$namespace:$items",$uhome);
2152: } else {
2153: return &reply("putdom:$udom:$namespace:$items",$uhome);
2154: }
2155: } else {
2156: &logthis("put_dom failed - no homeserver and/or domain");
2157: }
2158: }
2159:
2160: # --------------------- newput for items in db file owned by domainconfig user
2161: sub newput_dom {
2162: my ($namespace,$storehash,$udom) = @_;
2163: my $result;
2164: if (!$udom) {
2165: $udom=$env{'user.domain'};
2166: }
2167: if ($udom) {
2168: my $uname = &get_domainconfiguser($udom);
2169: $result = &newput($namespace,$storehash,$udom,$uname);
2170: }
2171: return $result;
2172: }
2173:
2174: # --------------------- delete for items in db file owned by domainconfig user
2175: sub del_dom {
2176: my ($namespace,$storearr,$udom)=@_;
2177: if (ref($storearr) eq 'ARRAY') {
2178: if (!$udom) {
2179: $udom=$env{'user.domain'};
2180: }
2181: if ($udom) {
2182: my $uname = &get_domainconfiguser($udom);
2183: return &del($namespace,$storearr,$udom,$uname);
2184: }
2185: }
2186: }
2187:
2188: # ----------------------------------construct domainconfig user for a domain
2189: sub get_domainconfiguser {
2190: my ($udom) = @_;
2191: return $udom.'-domainconfig';
2192: }
2193:
2194: sub retrieve_inst_usertypes {
2195: my ($udom) = @_;
2196: my (%returnhash,@order);
2197: my %domdefs = &Apache::lonnet::get_domain_defaults($udom);
2198: if ((ref($domdefs{'inststatustypes'}) eq 'HASH') &&
2199: (ref($domdefs{'inststatusorder'}) eq 'ARRAY')) {
2200: return ($domdefs{'inststatustypes'},$domdefs{'inststatusorder'});
2201: } else {
2202: if (defined(&domain($udom,'primary'))) {
2203: my $uhome=&domain($udom,'primary');
2204: my $rep=&reply("inst_usertypes:$udom",$uhome);
2205: if ($rep =~ /^(con_lost|error|no_such_host|refused)/) {
2206: &logthis("retrieve_inst_usertypes failed - $rep returned from $uhome in domain: $udom");
2207: return (\%returnhash,\@order);
2208: }
2209: my ($hashitems,$orderitems) = split(/:/,$rep);
2210: my @pairs=split(/\&/,$hashitems);
2211: foreach my $item (@pairs) {
2212: my ($key,$value)=split(/=/,$item,2);
2213: $key = &unescape($key);
2214: next if ($key =~ /^error: 2 /);
2215: $returnhash{$key}=&thaw_unescape($value);
2216: }
2217: my @esc_order = split(/\&/,$orderitems);
2218: foreach my $item (@esc_order) {
2219: push(@order,&unescape($item));
2220: }
2221: } else {
2222: &logthis("retrieve_inst_usertypes failed - no primary domain server for $udom");
2223: }
2224: return (\%returnhash,\@order);
2225: }
2226: }
2227:
2228: sub is_domainimage {
2229: my ($url) = @_;
2230: if ($url=~m-^/+res/+($match_domain)/+\1\-domainconfig/+(img|logo|domlogo)/+[^/]-) {
2231: if (&domain($1) ne '') {
2232: return '1';
2233: }
2234: }
2235: return;
2236: }
2237:
2238: sub inst_directory_query {
2239: my ($srch) = @_;
2240: my $udom = $srch->{'srchdomain'};
2241: my %results;
2242: my $homeserver = &domain($udom,'primary');
2243: my $outcome;
2244: if ($homeserver ne '') {
2245: unless ($homeserver eq $perlvar{'lonHostID'}) {
2246: if ($srch->{'srchby'} eq 'email') {
2247: my $lcrev = &get_server_loncaparev(undef,$homeserver);
2248: my ($major,$minor) = ($lcrev =~ /^\'?(\d+)\.(\d+)\.[\w.\-]+\'?$/);
2249: if (($major eq '' && $minor eq '') || ($major < 2) ||
2250: (($major == 2) && ($minor < 12))) {
2251: return;
2252: }
2253: }
2254: }
2255: my $queryid=&reply("querysend:instdirsearch:".
2256: &escape($srch->{'srchby'}).':'.
2257: &escape($srch->{'srchterm'}).':'.
2258: &escape($srch->{'srchtype'}),$homeserver);
2259: my $host=&hostname($homeserver);
2260: if ($queryid !~/^\Q$host\E\_/) {
2261: &logthis('institutional directory search invalid queryid: '.$queryid.' for host: '.$homeserver.' in domain '.$udom);
2262: return;
2263: }
2264: my $response = &get_query_reply($queryid);
2265: my $maxtries = 5;
2266: my $tries = 1;
2267: while (($response=~/^timeout/) && ($tries < $maxtries)) {
2268: $response = &get_query_reply($queryid);
2269: $tries ++;
2270: }
2271:
2272: if (!&error($response) && $response ne 'refused') {
2273: if ($response eq 'unavailable') {
2274: $outcome = $response;
2275: } else {
2276: $outcome = 'ok';
2277: my @matches = split(/\n/,$response);
2278: foreach my $match (@matches) {
2279: my ($key,$value) = split(/=/,$match);
2280: $results{&unescape($key).':'.$udom} = &thaw_unescape($value);
2281: }
2282: }
2283: }
2284: }
2285: return ($outcome,%results);
2286: }
2287:
2288: sub usersearch {
2289: my ($srch) = @_;
2290: my $dom = $srch->{'srchdomain'};
2291: my %results;
2292: my %libserv = &all_library();
2293: my $query = 'usersearch';
2294: foreach my $tryserver (keys(%libserv)) {
2295: if (&host_domain($tryserver) eq $dom) {
2296: unless ($tryserver eq $perlvar{'lonHostID'}) {
2297: if ($srch->{'srchby'} eq 'email') {
2298: my $lcrev = &get_server_loncaparev(undef,$tryserver);
2299: my ($major,$minor) = ($lcrev =~ /^\'?(\d+)\.(\d+)\.[\w.\-]+\'?$/);
2300: next if (($major eq '' && $minor eq '') || ($major < 2) ||
2301: (($major == 2) && ($minor < 12)));
2302: }
2303: }
2304: my $host=&hostname($tryserver);
2305: my $queryid=
2306: &reply("querysend:".&escape($query).':'.
2307: &escape($srch->{'srchby'}).':'.
2308: &escape($srch->{'srchtype'}).':'.
2309: &escape($srch->{'srchterm'}),$tryserver);
2310: if ($queryid !~/^\Q$host\E\_/) {
2311: &logthis('usersearch: invalid queryid: '.$queryid.' for host: '.$host.'in domain '.$dom.' and server: '.$tryserver);
2312: next;
2313: }
2314: my $reply = &get_query_reply($queryid);
2315: my $maxtries = 1;
2316: my $tries = 1;
2317: while (($reply=~/^timeout/) && ($tries < $maxtries)) {
2318: $reply = &get_query_reply($queryid);
2319: $tries ++;
2320: }
2321: if ( ($reply =~/^timeout/) || ($reply =~/^error/) ) {
2322: &logthis('usersrch error: '.$reply.' for '.$dom.' - searching for : '.$srch->{'srchterm'}.' by '.$srch->{'srchby'}.' ('.$srch->{'srchtype'}.') - maxtries: '.$maxtries.' tries: '.$tries);
2323: } else {
2324: my @matches;
2325: if ($reply =~ /\n/) {
2326: @matches = split(/\n/,$reply);
2327: } else {
2328: @matches = split(/\&/,$reply);
2329: }
2330: foreach my $match (@matches) {
2331: my ($uname,$udom,%userhash);
2332: foreach my $entry (split(/:/,$match)) {
2333: my ($key,$value) =
2334: map {&unescape($_);} split(/=/,$entry);
2335: $userhash{$key} = $value;
2336: if ($key eq 'username') {
2337: $uname = $value;
2338: } elsif ($key eq 'domain') {
2339: $udom = $value;
2340: }
2341: }
2342: $results{$uname.':'.$udom} = \%userhash;
2343: }
2344: }
2345: }
2346: }
2347: return %results;
2348: }
2349:
2350: sub get_instuser {
2351: my ($udom,$uname,$id) = @_;
2352: my $homeserver = &domain($udom,'primary');
2353: my ($outcome,%results);
2354: if ($homeserver ne '') {
2355: my $queryid=&reply("querysend:getinstuser:".&escape($uname).':'.
2356: &escape($id).':'.&escape($udom),$homeserver);
2357: my $host=&hostname($homeserver);
2358: if ($queryid !~/^\Q$host\E\_/) {
2359: &logthis('get_instuser invalid queryid: '.$queryid.' for host: '.$homeserver.'in domain '.$udom);
2360: return;
2361: }
2362: my $response = &get_query_reply($queryid);
2363: my $maxtries = 5;
2364: my $tries = 1;
2365: while (($response=~/^timeout/) && ($tries < $maxtries)) {
2366: $response = &get_query_reply($queryid);
2367: $tries ++;
2368: }
2369: if (!&error($response) && $response ne 'refused') {
2370: if ($response eq 'unavailable') {
2371: $outcome = $response;
2372: } else {
2373: $outcome = 'ok';
2374: my @matches = split(/\n/,$response);
2375: foreach my $match (@matches) {
2376: my ($key,$value) = split(/=/,$match);
2377: $results{&unescape($key)} = &thaw_unescape($value);
2378: }
2379: }
2380: }
2381: }
2382: my %userinfo;
2383: if (ref($results{$uname}) eq 'HASH') {
2384: %userinfo = %{$results{$uname}};
2385: }
2386: return ($outcome,%userinfo);
2387: }
2388:
2389: sub get_multiple_instusers {
2390: my ($udom,$users,$caller) = @_;
2391: my ($outcome,$results);
2392: if (ref($users) eq 'HASH') {
2393: my $count = keys(%{$users});
2394: my $requested = &freeze_escape($users);
2395: my $homeserver = &domain($udom,'primary');
2396: if ($homeserver ne '') {
2397: my $queryid=&reply('querysend:getmultinstusers:::'.$caller.'='.$requested,$homeserver);
2398: my $host=&hostname($homeserver);
2399: if ($queryid !~/^\Q$host\E\_/) {
2400: &logthis('get_multiple_instusers invalid queryid: '.$queryid.
2401: ' for host: '.$homeserver.'in domain '.$udom);
2402: return ($outcome,$results);
2403: }
2404: my $response = &get_query_reply($queryid);
2405: my $maxtries = 5;
2406: if ($count > 100) {
2407: $maxtries = 1+int($count/20);
2408: }
2409: my $tries = 1;
2410: while (($response=~/^timeout/) && ($tries <= $maxtries)) {
2411: $response = &get_query_reply($queryid);
2412: $tries ++;
2413: }
2414: if ($response eq '') {
2415: $results = {};
2416: foreach my $key (keys(%{$users})) {
2417: my ($uname,$id);
2418: if ($caller eq 'id') {
2419: $id = $key;
2420: } else {
2421: $uname = $key;
2422: }
2423: my ($resp,%info) = &get_instuser($udom,$uname,$id);
2424: $outcome = $resp;
2425: if ($resp eq 'ok') {
2426: %{$results} = (%{$results}, %info);
2427: } else {
2428: last;
2429: }
2430: }
2431: } elsif(!&error($response) && ($response ne 'refused')) {
2432: if (($response eq 'unavailable') || ($response eq 'invalid') || ($response eq 'timeout')) {
2433: $outcome = $response;
2434: } else {
2435: ($outcome,my $userdata) = split(/=/,$response,2);
2436: if ($outcome eq 'ok') {
2437: $results = &thaw_unescape($userdata);
2438: }
2439: }
2440: }
2441: }
2442: }
2443: return ($outcome,$results);
2444: }
2445:
2446: sub inst_rulecheck {
2447: my ($udom,$uname,$id,$item,$rules) = @_;
2448: my %returnhash;
2449: if ($udom ne '') {
2450: if (ref($rules) eq 'ARRAY') {
2451: @{$rules} = map {&escape($_);} (@{$rules});
2452: my $rulestr = join(':',@{$rules});
2453: my $homeserver=&domain($udom,'primary');
2454: if (($homeserver ne '') && ($homeserver ne 'no_host')) {
2455: my $response;
2456: if ($item eq 'username') {
2457: $response=&unescape(&reply('instrulecheck:'.&escape($udom).
2458: ':'.&escape($uname).':'.$rulestr,
2459: $homeserver));
2460: } elsif ($item eq 'id') {
2461: $response=&unescape(&reply('instidrulecheck:'.&escape($udom).
2462: ':'.&escape($id).':'.$rulestr,
2463: $homeserver));
2464: } elsif ($item eq 'selfcreate') {
2465: $response=&unescape(&reply('instselfcreatecheck:'.
2466: &escape($udom).':'.&escape($uname).
2467: ':'.$rulestr,$homeserver));
2468: }
2469: if ($response ne 'refused') {
2470: my @pairs=split(/\&/,$response);
2471: foreach my $item (@pairs) {
2472: my ($key,$value)=split(/=/,$item,2);
2473: $key = &unescape($key);
2474: next if ($key =~ /^error: 2 /);
2475: $returnhash{$key}=&thaw_unescape($value);
2476: }
2477: }
2478: }
2479: }
2480: }
2481: return %returnhash;
2482: }
2483:
2484: sub inst_userrules {
2485: my ($udom,$check) = @_;
2486: my (%ruleshash,@ruleorder);
2487: if ($udom ne '') {
2488: my $homeserver=&domain($udom,'primary');
2489: if (($homeserver ne '') && ($homeserver ne 'no_host')) {
2490: my $response;
2491: if ($check eq 'id') {
2492: $response=&reply('instidrules:'.&escape($udom),
2493: $homeserver);
2494: } elsif ($check eq 'email') {
2495: $response=&reply('instemailrules:'.&escape($udom),
2496: $homeserver);
2497: } else {
2498: $response=&reply('instuserrules:'.&escape($udom),
2499: $homeserver);
2500: }
2501: if (($response ne 'refused') && ($response ne 'error') &&
2502: ($response ne 'unknown_cmd') &&
2503: ($response ne 'no_such_host')) {
2504: my ($hashitems,$orderitems) = split(/:/,$response);
2505: my @pairs=split(/\&/,$hashitems);
2506: foreach my $item (@pairs) {
2507: my ($key,$value)=split(/=/,$item,2);
2508: $key = &unescape($key);
2509: next if ($key =~ /^error: 2 /);
2510: $ruleshash{$key}=&thaw_unescape($value);
2511: }
2512: my @esc_order = split(/\&/,$orderitems);
2513: foreach my $item (@esc_order) {
2514: push(@ruleorder,&unescape($item));
2515: }
2516: }
2517: }
2518: }
2519: return (\%ruleshash,\@ruleorder);
2520: }
2521:
2522: # ------------- Get Authentication, Language and User Tools Defaults for Domain
2523:
2524: sub get_domain_defaults {
2525: my ($domain,$ignore_cache) = @_;
2526: return if (($domain eq '') || ($domain eq 'public'));
2527: my $cachetime = 60*60*24;
2528: unless ($ignore_cache) {
2529: my ($result,$cached)=&is_cached_new('domdefaults',$domain);
2530: if (defined($cached)) {
2531: if (ref($result) eq 'HASH') {
2532: return %{$result};
2533: }
2534: }
2535: }
2536: my %domdefaults;
2537: my %domconfig =
2538: &Apache::lonnet::get_dom('configuration',['defaults','quotas',
2539: 'requestcourses','inststatus',
2540: 'coursedefaults','usersessions',
2541: 'requestauthor','selfenrollment',
2542: 'coursecategories','ssl','autoenroll',
2543: 'trust','helpsettings'],$domain);
2544: my @coursetypes = ('official','unofficial','community','textbook','placement');
2545: if (ref($domconfig{'defaults'}) eq 'HASH') {
2546: $domdefaults{'lang_def'} = $domconfig{'defaults'}{'lang_def'};
2547: $domdefaults{'auth_def'} = $domconfig{'defaults'}{'auth_def'};
2548: $domdefaults{'auth_arg_def'} = $domconfig{'defaults'}{'auth_arg_def'};
2549: $domdefaults{'timezone_def'} = $domconfig{'defaults'}{'timezone_def'};
2550: $domdefaults{'datelocale_def'} = $domconfig{'defaults'}{'datelocale_def'};
2551: $domdefaults{'portal_def'} = $domconfig{'defaults'}{'portal_def'};
2552: $domdefaults{'intauth_cost'} = $domconfig{'defaults'}{'intauth_cost'};
2553: $domdefaults{'intauth_switch'} = $domconfig{'defaults'}{'intauth_switch'};
2554: $domdefaults{'intauth_check'} = $domconfig{'defaults'}{'intauth_check'};
2555: } else {
2556: $domdefaults{'lang_def'} = &domain($domain,'lang_def');
2557: $domdefaults{'auth_def'} = &domain($domain,'auth_def');
2558: $domdefaults{'auth_arg_def'} = &domain($domain,'auth_arg_def');
2559: }
2560: if (ref($domconfig{'quotas'}) eq 'HASH') {
2561: if (ref($domconfig{'quotas'}{'defaultquota'}) eq 'HASH') {
2562: $domdefaults{'defaultquota'} = $domconfig{'quotas'}{'defaultquota'};
2563: } else {
2564: $domdefaults{'defaultquota'} = $domconfig{'quotas'};
2565: }
2566: my @usertools = ('aboutme','blog','webdav','portfolio');
2567: foreach my $item (@usertools) {
2568: if (ref($domconfig{'quotas'}{$item}) eq 'HASH') {
2569: $domdefaults{$item} = $domconfig{'quotas'}{$item};
2570: }
2571: }
2572: if (ref($domconfig{'quotas'}{'authorquota'}) eq 'HASH') {
2573: $domdefaults{'authorquota'} = $domconfig{'quotas'}{'authorquota'};
2574: }
2575: }
2576: if (ref($domconfig{'requestcourses'}) eq 'HASH') {
2577: foreach my $item ('official','unofficial','community','textbook','placement') {
2578: $domdefaults{$item} = $domconfig{'requestcourses'}{$item};
2579: }
2580: }
2581: if (ref($domconfig{'requestauthor'}) eq 'HASH') {
2582: $domdefaults{'requestauthor'} = $domconfig{'requestauthor'};
2583: }
2584: if (ref($domconfig{'inststatus'}) eq 'HASH') {
2585: foreach my $item ('inststatustypes','inststatusorder','inststatusguest') {
2586: $domdefaults{$item} = $domconfig{'inststatus'}{$item};
2587: }
2588: }
2589: if (ref($domconfig{'coursedefaults'}) eq 'HASH') {
2590: $domdefaults{'canuse_pdfforms'} = $domconfig{'coursedefaults'}{'canuse_pdfforms'};
2591: $domdefaults{'usejsme'} = $domconfig{'coursedefaults'}{'usejsme'};
2592: $domdefaults{'uselcmath'} = $domconfig{'coursedefaults'}{'uselcmath'};
2593: if (ref($domconfig{'coursedefaults'}{'postsubmit'}) eq 'HASH') {
2594: $domdefaults{'postsubmit'} = $domconfig{'coursedefaults'}{'postsubmit'}{'client'};
2595: }
2596: foreach my $type (@coursetypes) {
2597: if (ref($domconfig{'coursedefaults'}{'coursecredits'}) eq 'HASH') {
2598: unless ($type eq 'community') {
2599: $domdefaults{$type.'credits'} = $domconfig{'coursedefaults'}{'coursecredits'}{$type};
2600: }
2601: }
2602: if (ref($domconfig{'coursedefaults'}{'uploadquota'}) eq 'HASH') {
2603: $domdefaults{$type.'quota'} = $domconfig{'coursedefaults'}{'uploadquota'}{$type};
2604: }
2605: if ($domdefaults{'postsubmit'} eq 'on') {
2606: if (ref($domconfig{'coursedefaults'}{'postsubmit'}{'timeout'}) eq 'HASH') {
2607: $domdefaults{$type.'postsubtimeout'} =
2608: $domconfig{'coursedefaults'}{'postsubmit'}{'timeout'}{$type};
2609: }
2610: }
2611: }
2612: if (ref($domconfig{'coursedefaults'}{'canclone'}) eq 'HASH') {
2613: if (ref($domconfig{'coursedefaults'}{'canclone'}{'instcode'}) eq 'ARRAY') {
2614: my @clonecodes = @{$domconfig{'coursedefaults'}{'canclone'}{'instcode'}};
2615: if (@clonecodes) {
2616: $domdefaults{'canclone'} = join('+',@clonecodes);
2617: }
2618: }
2619: } elsif ($domconfig{'coursedefaults'}{'canclone'}) {
2620: $domdefaults{'canclone'}=$domconfig{'coursedefaults'}{'canclone'};
2621: }
2622: if ($domconfig{'coursedefaults'}{'texengine'}) {
2623: $domdefaults{'texengine'} = $domconfig{'coursedefaults'}{'texengine'};
2624: }
2625: }
2626: if (ref($domconfig{'usersessions'}) eq 'HASH') {
2627: if (ref($domconfig{'usersessions'}{'remote'}) eq 'HASH') {
2628: $domdefaults{'remotesessions'} = $domconfig{'usersessions'}{'remote'};
2629: }
2630: if (ref($domconfig{'usersessions'}{'hosted'}) eq 'HASH') {
2631: $domdefaults{'hostedsessions'} = $domconfig{'usersessions'}{'hosted'};
2632: }
2633: if (ref($domconfig{'usersessions'}{'offloadnow'}) eq 'HASH') {
2634: $domdefaults{'offloadnow'} = $domconfig{'usersessions'}{'offloadnow'};
2635: }
2636: }
2637: if (ref($domconfig{'selfenrollment'}) eq 'HASH') {
2638: if (ref($domconfig{'selfenrollment'}{'admin'}) eq 'HASH') {
2639: my @settings = ('types','registered','enroll_dates','access_dates','section',
2640: 'approval','limit');
2641: foreach my $type (@coursetypes) {
2642: if (ref($domconfig{'selfenrollment'}{'admin'}{$type}) eq 'HASH') {
2643: my @mgrdc = ();
2644: foreach my $item (@settings) {
2645: if ($domconfig{'selfenrollment'}{'admin'}{$type}{$item} eq '0') {
2646: push(@mgrdc,$item);
2647: }
2648: }
2649: if (@mgrdc) {
2650: $domdefaults{$type.'selfenrolladmdc'} = join(',',@mgrdc);
2651: }
2652: }
2653: }
2654: }
2655: if (ref($domconfig{'selfenrollment'}{'default'}) eq 'HASH') {
2656: foreach my $type (@coursetypes) {
2657: if (ref($domconfig{'selfenrollment'}{'default'}{$type}) eq 'HASH') {
2658: foreach my $item (keys(%{$domconfig{'selfenrollment'}{'default'}{$type}})) {
2659: $domdefaults{$type.'selfenroll'.$item} = $domconfig{'selfenrollment'}{'default'}{$type}{$item};
2660: }
2661: }
2662: }
2663: }
2664: }
2665: if (ref($domconfig{'coursecategories'}) eq 'HASH') {
2666: $domdefaults{'catauth'} = 'std';
2667: $domdefaults{'catunauth'} = 'std';
2668: if ($domconfig{'coursecategories'}{'auth'}) {
2669: $domdefaults{'catauth'} = $domconfig{'coursecategories'}{'auth'};
2670: }
2671: if ($domconfig{'coursecategories'}{'unauth'}) {
2672: $domdefaults{'catunauth'} = $domconfig{'coursecategories'}{'unauth'};
2673: }
2674: }
2675: if (ref($domconfig{'ssl'}) eq 'HASH') {
2676: if (ref($domconfig{'ssl'}{'replication'}) eq 'HASH') {
2677: $domdefaults{'replication'} = $domconfig{'ssl'}{'replication'};
2678: }
2679: if (ref($domconfig{'ssl'}{'connto'}) eq 'HASH') {
2680: $domdefaults{'connect'} = $domconfig{'ssl'}{'connto'};
2681: }
2682: if (ref($domconfig{'ssl'}{'connfrom'}) eq 'HASH') {
2683: $domdefaults{'connect'} = $domconfig{'ssl'}{'connfrom'};
2684: }
2685: }
2686: if (ref($domconfig{'trust'}) eq 'HASH') {
2687: my @prefixes = qw(content shared enroll othcoau coaurem domroles catalog reqcrs msg);
2688: foreach my $prefix (@prefixes) {
2689: if (ref($domconfig{'trust'}{$prefix}) eq 'HASH') {
2690: $domdefaults{'trust'.$prefix} = $domconfig{'trust'}{$prefix};
2691: }
2692: }
2693: }
2694: if (ref($domconfig{'autoenroll'}) eq 'HASH') {
2695: $domdefaults{'autofailsafe'} = $domconfig{'autoenroll'}{'autofailsafe'};
2696: }
2697: if (ref($domconfig{'helpsettings'}) eq 'HASH') {
2698: $domdefaults{'submitbugs'} = $domconfig{'helpsettings'}{'submitbugs'};
2699: if (ref($domconfig{'helpsettings'}{'adhoc'}) eq 'HASH') {
2700: $domdefaults{'adhocroles'} = $domconfig{'helpsettings'}{'adhoc'};
2701: }
2702: }
2703: &do_cache_new('domdefaults',$domain,\%domdefaults,$cachetime);
2704: return %domdefaults;
2705: }
2706:
2707: sub course_portal_url {
2708: my ($cnum,$cdom) = @_;
2709: my $chome = &homeserver($cnum,$cdom);
2710: my $hostname = &hostname($chome);
2711: my $protocol = $protocol{$chome};
2712: $protocol = 'http' if ($protocol ne 'https');
2713: my %domdefaults = &get_domain_defaults($cdom);
2714: my $firsturl;
2715: if ($domdefaults{'portal_def'}) {
2716: $firsturl = $domdefaults{'portal_def'};
2717: } else {
2718: $firsturl = $protocol.'://'.$hostname;
2719: }
2720: return $firsturl;
2721: }
2722:
2723: # --------------------------------------------------- Assign a key to a student
2724:
2725: sub assign_access_key {
2726: #
2727: # a valid key looks like uname:udom#comments
2728: # comments are being appended
2729: #
2730: my ($ckey,$kdom,$knum,$cdom,$cnum,$udom,$uname,$logentry)=@_;
2731: $kdom=
2732: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($kdom));
2733: $knum=
2734: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($knum));
2735: $cdom=
2736: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
2737: $cnum=
2738: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
2739: $udom=$env{'user.name'} unless (defined($udom));
2740: $uname=$env{'user.domain'} unless (defined($uname));
2741: my %existing=&get('accesskeys',[$ckey],$kdom,$knum);
2742: if (($existing{$ckey}=~/^\#(.*)$/) || # - new key
2743: ($existing{$ckey}=~/^\Q$uname\E\:\Q$udom\E\#(.*)$/)) {
2744: # assigned to this person
2745: # - this should not happen,
2746: # unless something went wrong
2747: # the first time around
2748: # ready to assign
2749: $logentry=$1.'; '.$logentry;
2750: if (&put('accesskeys',{$ckey=>$uname.':'.$udom.'#'.$logentry},
2751: $kdom,$knum) eq 'ok') {
2752: # key now belongs to user
2753: my $envkey='key.'.$cdom.'_'.$cnum;
2754: if (&put('environment',{$envkey => $ckey}) eq 'ok') {
2755: &appenv({'environment.'.$envkey => $ckey});
2756: return 'ok';
2757: } else {
2758: return
2759: 'error: Count not permanently assign key, will need to be re-entered later.';
2760: }
2761: } else {
2762: return 'error: Could not assign key, try again later.';
2763: }
2764: } elsif (!$existing{$ckey}) {
2765: # the key does not exist
2766: return 'error: The key does not exist';
2767: } else {
2768: # the key is somebody else's
2769: return 'error: The key is already in use';
2770: }
2771: }
2772:
2773: # ------------------------------------------ put an additional comment on a key
2774:
2775: sub comment_access_key {
2776: #
2777: # a valid key looks like uname:udom#comments
2778: # comments are being appended
2779: #
2780: my ($ckey,$cdom,$cnum,$logentry)=@_;
2781: $cdom=
2782: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
2783: $cnum=
2784: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
2785: my %existing=&get('accesskeys',[$ckey],$cdom,$cnum);
2786: if ($existing{$ckey}) {
2787: $existing{$ckey}.='; '.$logentry;
2788: # ready to assign
2789: if (&put('accesskeys',{$ckey=>$existing{$ckey}},
2790: $cdom,$cnum) eq 'ok') {
2791: return 'ok';
2792: } else {
2793: return 'error: Count not store comment.';
2794: }
2795: } else {
2796: # the key does not exist
2797: return 'error: The key does not exist';
2798: }
2799: }
2800:
2801: # ------------------------------------------------------ Generate a set of keys
2802:
2803: sub generate_access_keys {
2804: my ($number,$cdom,$cnum,$logentry)=@_;
2805: $cdom=
2806: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
2807: $cnum=
2808: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
2809: unless (&allowed('mky',$cdom)) { return 0; }
2810: unless (($cdom) && ($cnum)) { return 0; }
2811: if ($number>10000) { return 0; }
2812: sleep(2); # make sure don't get same seed twice
2813: srand(time()^($$+($$<<15))); # from "Programming Perl"
2814: my $total=0;
2815: for (my $i=1;$i<=$number;$i++) {
2816: my $newkey=sprintf("%lx",int(100000*rand)).'-'.
2817: sprintf("%lx",int(100000*rand)).'-'.
2818: sprintf("%lx",int(100000*rand));
2819: $newkey=~s/1/g/g; # folks mix up 1 and l
2820: $newkey=~s/0/h/g; # and also 0 and O
2821: my %existing=&get('accesskeys',[$newkey],$cdom,$cnum);
2822: if ($existing{$newkey}) {
2823: $i--;
2824: } else {
2825: if (&put('accesskeys',
2826: { $newkey => '# generated '.localtime().
2827: ' by '.$env{'user.name'}.'@'.$env{'user.domain'}.
2828: '; '.$logentry },
2829: $cdom,$cnum) eq 'ok') {
2830: $total++;
2831: }
2832: }
2833: }
2834: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},
2835: 'Generated '.$total.' keys for '.$cnum.' at '.$cdom);
2836: return $total;
2837: }
2838:
2839: # ------------------------------------------------------- Validate an accesskey
2840:
2841: sub validate_access_key {
2842: my ($ckey,$cdom,$cnum,$udom,$uname)=@_;
2843: $cdom=
2844: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
2845: $cnum=
2846: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
2847: $udom=$env{'user.domain'} unless (defined($udom));
2848: $uname=$env{'user.name'} unless (defined($uname));
2849: my %existing=&get('accesskeys',[$ckey],$cdom,$cnum);
2850: return ($existing{$ckey}=~/^\Q$uname\E\:\Q$udom\E\#/);
2851: }
2852:
2853: # ------------------------------------- Find the section of student in a course
2854: sub devalidate_getsection_cache {
2855: my ($udom,$unam,$courseid)=@_;
2856: my $hashid="$udom:$unam:$courseid";
2857: &devalidate_cache_new('getsection',$hashid);
2858: }
2859:
2860: sub courseid_to_courseurl {
2861: my ($courseid) = @_;
2862: #already url style courseid
2863: return $courseid if ($courseid =~ m{^/});
2864:
2865: if (exists($env{'course.'.$courseid.'.num'})) {
2866: my $cnum = $env{'course.'.$courseid.'.num'};
2867: my $cdom = $env{'course.'.$courseid.'.domain'};
2868: return "/$cdom/$cnum";
2869: }
2870:
2871: my %courseinfo=&Apache::lonnet::coursedescription($courseid);
2872: if (exists($courseinfo{'num'})) {
2873: return "/$courseinfo{'domain'}/$courseinfo{'num'}";
2874: }
2875:
2876: return undef;
2877: }
2878:
2879: sub getsection {
2880: my ($udom,$unam,$courseid)=@_;
2881: my $cachetime=1800;
2882:
2883: my $hashid="$udom:$unam:$courseid";
2884: my ($result,$cached)=&is_cached_new('getsection',$hashid);
2885: if (defined($cached)) { return $result; }
2886:
2887: my %Pending;
2888: my %Expired;
2889: #
2890: # Each role can either have not started yet (pending), be active,
2891: # or have expired.
2892: #
2893: # If there is an active role, we are done.
2894: #
2895: # If there is more than one role which has not started yet,
2896: # choose the one which will start sooner
2897: # If there is one role which has not started yet, return it.
2898: #
2899: # If there is more than one expired role, choose the one which ended last.
2900: # If there is a role which has expired, return it.
2901: #
2902: $courseid = &courseid_to_courseurl($courseid);
2903: my %roleshash = &dump('roles',$udom,$unam,$courseid);
2904: foreach my $key (keys(%roleshash)) {
2905: next if ($key !~/^\Q$courseid\E(?:\/)*(\w+)*\_st$/);
2906: my $section=$1;
2907: if ($key eq $courseid.'_st') { $section=''; }
2908: my ($dummy,$end,$start)=split(/\_/,&unescape($roleshash{$key}));
2909: my $now=time;
2910: if (defined($end) && $end && ($now > $end)) {
2911: $Expired{$end}=$section;
2912: next;
2913: }
2914: if (defined($start) && $start && ($now < $start)) {
2915: $Pending{$start}=$section;
2916: next;
2917: }
2918: return &do_cache_new('getsection',$hashid,$section,$cachetime);
2919: }
2920: #
2921: # Presumedly there will be few matching roles from the above
2922: # loop and the sorting time will be negligible.
2923: if (scalar(keys(%Pending))) {
2924: my ($time) = sort {$a <=> $b} keys(%Pending);
2925: return &do_cache_new('getsection',$hashid,$Pending{$time},$cachetime);
2926: }
2927: if (scalar(keys(%Expired))) {
2928: my @sorted = sort {$a <=> $b} keys(%Expired);
2929: my $time = pop(@sorted);
2930: return &do_cache_new('getsection',$hashid,$Expired{$time},$cachetime);
2931: }
2932: return &do_cache_new('getsection',$hashid,'-1',$cachetime);
2933: }
2934:
2935: sub save_cache {
2936: &purge_remembered();
2937: #&Apache::loncommon::validate_page();
2938: undef(%env);
2939: undef($env_loaded);
2940: }
2941:
2942: my $to_remember=-1;
2943: my %remembered;
2944: my %accessed;
2945: my $kicks=0;
2946: my $hits=0;
2947: sub make_key {
2948: my ($name,$id) = @_;
2949: if (length($id) > 65
2950: && length(&escape($id)) > 200) {
2951: $id=length($id).':'.&Digest::MD5::md5_hex($id);
2952: }
2953: return &escape($name.':'.$id);
2954: }
2955:
2956: sub devalidate_cache_new {
2957: my ($name,$id,$debug) = @_;
2958: if ($debug) { &Apache::lonnet::logthis("deleting $name:$id"); }
2959: my $remembered_id=$name.':'.$id;
2960: $id=&make_key($name,$id);
2961: $memcache->delete($id);
2962: delete($remembered{$remembered_id});
2963: delete($accessed{$remembered_id});
2964: }
2965:
2966: sub is_cached_new {
2967: my ($name,$id,$debug) = @_;
2968: my $remembered_id=$name.':'.$id; # this is to avoid make_key (which is slow) whenever possible
2969: if (exists($remembered{$remembered_id})) {
2970: if ($debug) { &Apache::lonnet::logthis("Early return $remembered_id of $remembered{$remembered_id} "); }
2971: $accessed{$remembered_id}=[&gettimeofday()];
2972: $hits++;
2973: return ($remembered{$remembered_id},1);
2974: }
2975: $id=&make_key($name,$id);
2976: my $value = $memcache->get($id);
2977: if (!(defined($value))) {
2978: if ($debug) { &Apache::lonnet::logthis("getting $id is not defined"); }
2979: return (undef,undef);
2980: }
2981: if ($value eq '__undef__') {
2982: if ($debug) { &Apache::lonnet::logthis("getting $id is __undef__"); }
2983: $value=undef;
2984: }
2985: &make_room($remembered_id,$value,$debug);
2986: if ($debug) { &Apache::lonnet::logthis("getting $id is $value"); }
2987: return ($value,1);
2988: }
2989:
2990: sub do_cache_new {
2991: my ($name,$id,$value,$time,$debug) = @_;
2992: my $remembered_id=$name.':'.$id;
2993: $id=&make_key($name,$id);
2994: my $setvalue=$value;
2995: if (!defined($setvalue)) {
2996: $setvalue='__undef__';
2997: }
2998: if (!defined($time) ) {
2999: $time=600;
3000: }
3001: if ($debug) { &Apache::lonnet::logthis("Setting $id to $value"); }
3002: my $result = $memcache->set($id,$setvalue,$time);
3003: if (! $result) {
3004: &logthis("caching of id -> $id failed");
3005: $memcache->disconnect_all();
3006: }
3007: # need to make a copy of $value
3008: &make_room($remembered_id,$value,$debug);
3009: return $value;
3010: }
3011:
3012: sub make_room {
3013: my ($remembered_id,$value,$debug)=@_;
3014:
3015: $remembered{$remembered_id}= (ref($value)) ? &Storable::dclone($value)
3016: : $value;
3017: if ($to_remember<0) { return; }
3018: $accessed{$remembered_id}=[&gettimeofday()];
3019: if (scalar(keys(%remembered)) <= $to_remember) { return; }
3020: my $to_kick;
3021: my $max_time=0;
3022: foreach my $other (keys(%accessed)) {
3023: if (&tv_interval($accessed{$other}) > $max_time) {
3024: $to_kick=$other;
3025: $max_time=&tv_interval($accessed{$other});
3026: }
3027: }
3028: delete($remembered{$to_kick});
3029: delete($accessed{$to_kick});
3030: $kicks++;
3031: if ($debug) { &logthis("kicking $to_kick $max_time $kicks\n"); }
3032: return;
3033: }
3034:
3035: sub purge_remembered {
3036: #&logthis("Tossing ".scalar(keys(%remembered)));
3037: #&logthis(sprintf("%-20s is %s",'%remembered',length(&freeze(\%remembered))));
3038: undef(%remembered);
3039: undef(%accessed);
3040: }
3041: # ------------------------------------- Read an entry from a user's environment
3042:
3043: sub userenvironment {
3044: my ($udom,$unam,@what)=@_;
3045: my $items;
3046: foreach my $item (@what) {
3047: $items.=&escape($item).'&';
3048: }
3049: $items=~s/\&$//;
3050: my %returnhash=();
3051: my $uhome = &homeserver($unam,$udom);
3052: unless ($uhome eq 'no_host') {
3053: my @answer=split(/\&/,
3054: &reply('get:'.$udom.':'.$unam.':environment:'.$items,$uhome));
3055: if ($#answer==0 && $answer[0] =~ /^(con_lost|error:|no_such_host)/i) {
3056: return %returnhash;
3057: }
3058: my $i;
3059: for ($i=0;$i<=$#what;$i++) {
3060: $returnhash{$what[$i]}=&unescape($answer[$i]);
3061: }
3062: }
3063: return %returnhash;
3064: }
3065:
3066: # ---------------------------------------------------------- Get a studentphoto
3067: sub studentphoto {
3068: my ($udom,$unam,$ext) = @_;
3069: my $home=&Apache::lonnet::homeserver($unam,$udom);
3070: if (defined($env{'request.course.id'})) {
3071: if ($env{'course.'.$env{'request.course.id'}.'.internal.showphoto'}) {
3072: if ($udom eq $env{'course.'.$env{'request.course.id'}.'.domain'}) {
3073: return(&retrievestudentphoto($udom,$unam,$ext));
3074: } else {
3075: my ($result,$perm_reqd)=
3076: &Apache::lonnet::auto_photo_permission($unam,$udom);
3077: if ($result eq 'ok') {
3078: if (!($perm_reqd eq 'yes')) {
3079: return(&retrievestudentphoto($udom,$unam,$ext));
3080: }
3081: }
3082: }
3083: }
3084: } else {
3085: my ($result,$perm_reqd) =
3086: &Apache::lonnet::auto_photo_permission($unam,$udom);
3087: if ($result eq 'ok') {
3088: if (!($perm_reqd eq 'yes')) {
3089: return(&retrievestudentphoto($udom,$unam,$ext));
3090: }
3091: }
3092: }
3093: return '/adm/lonKaputt/lonlogo_broken.gif';
3094: }
3095:
3096: sub retrievestudentphoto {
3097: my ($udom,$unam,$ext,$type) = @_;
3098: my $home=&Apache::lonnet::homeserver($unam,$udom);
3099: my $ret=&Apache::lonnet::reply("studentphoto:$udom:$unam:$ext:$type",$home);
3100: if ($ret eq 'ok') {
3101: my $url="/uploaded/$udom/$unam/internal/studentphoto.$ext";
3102: if ($type eq 'thumbnail') {
3103: $url="/uploaded/$udom/$unam/internal/studentphoto_tn.$ext";
3104: }
3105: my $tokenurl=&Apache::lonnet::tokenwrapper($url);
3106: return $tokenurl;
3107: } else {
3108: if ($type eq 'thumbnail') {
3109: return '/adm/lonKaputt/genericstudent_tn.gif';
3110: } else {
3111: return '/adm/lonKaputt/lonlogo_broken.gif';
3112: }
3113: }
3114: }
3115:
3116: # -------------------------------------------------------------------- New chat
3117:
3118: sub chatsend {
3119: my ($newentry,$anon,$group)=@_;
3120: my $cnum=$env{'course.'.$env{'request.course.id'}.'.num'};
3121: my $cdom=$env{'course.'.$env{'request.course.id'}.'.domain'};
3122: my $chome=$env{'course.'.$env{'request.course.id'}.'.home'};
3123: &reply('chatsend:'.$cdom.':'.$cnum.':'.
3124: &escape($env{'user.domain'}.':'.$env{'user.name'}.':'.$anon.':'.
3125: &escape($newentry)).':'.$group,$chome);
3126: }
3127:
3128: # ------------------------------------------ Find current version of a resource
3129:
3130: sub getversion {
3131: my $fname=&clutter(shift);
3132: unless ($fname=~m{^(/adm/wrapper|)/res/}) { return -1; }
3133: return ¤tversion(&filelocation('',$fname));
3134: }
3135:
3136: sub currentversion {
3137: my $fname=shift;
3138: my $author=$fname;
3139: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
3140: my ($udom,$uname)=split(/\//,$author);
3141: my $home=&homeserver($uname,$udom);
3142: if ($home eq 'no_host') {
3143: return -1;
3144: }
3145: my $answer=&reply("currentversion:$fname",$home);
3146: if (($answer eq 'con_lost') || ($answer eq 'rejected')) {
3147: return -1;
3148: }
3149: return $answer;
3150: }
3151:
3152: #
3153: # Return special version number of resource if set by override, empty otherwise
3154: #
3155: sub usedversion {
3156: my $fname=shift;
3157: unless ($fname) { $fname=$env{'request.uri'}; }
3158: my ($urlversion)=($fname=~/\.(\d+)\.\w+$/);
3159: if ($urlversion) { return $urlversion; }
3160: return '';
3161: }
3162:
3163: # ----------------------------- Subscribe to a resource, return URL if possible
3164:
3165: sub subscribe {
3166: my $fname=shift;
3167: if ($fname=~/\/(aboutme|syllabus|bulletinboard|smppg)$/) { return ''; }
3168: $fname=~s/[\n\r]//g;
3169: my $author=$fname;
3170: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
3171: my ($udom,$uname)=split(/\//,$author);
3172: my $home=homeserver($uname,$udom);
3173: if ($home eq 'no_host') {
3174: return 'not_found';
3175: }
3176: my $answer=reply("sub:$fname",$home);
3177: if (($answer eq 'con_lost') || ($answer eq 'rejected')) {
3178: $answer.=' by '.$home;
3179: }
3180: return $answer;
3181: }
3182:
3183: # -------------------------------------------------------------- Replicate file
3184:
3185: sub repcopy {
3186: my $filename=shift;
3187: $filename=~s/\/+/\//g;
3188: my $londocroot = $perlvar{'lonDocRoot'};
3189: if ($filename=~m{^\Q$londocroot/adm/\E}) { return 'ok'; }
3190: if ($filename=~m{^\Q/home/httpd/lonUsers/\E}) { return 'ok'; }
3191: if ($filename=~m{^\Q$londocroot/userfiles/\E} or
3192: $filename=~m{^/*(uploaded|editupload)/}) {
3193: return &repcopy_userfile($filename);
3194: }
3195: $filename=~s/[\n\r]//g;
3196: my $transname="$filename.in.transfer";
3197: # FIXME: this should flock
3198: if ((-e $filename) || (-e $transname)) { return 'ok'; }
3199: my $remoteurl=subscribe($filename);
3200: if ($remoteurl =~ /^con_lost by/) {
3201: &logthis("Subscribe returned $remoteurl: $filename");
3202: return 'unavailable';
3203: } elsif ($remoteurl eq 'not_found') {
3204: #&logthis("Subscribe returned not_found: $filename");
3205: return 'not_found';
3206: } elsif ($remoteurl =~ /^rejected by/) {
3207: &logthis("Subscribe returned $remoteurl: $filename");
3208: return 'forbidden';
3209: } elsif ($remoteurl eq 'directory') {
3210: return 'ok';
3211: } else {
3212: my $author=$filename;
3213: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
3214: my ($udom,$uname)=split(/\//,$author);
3215: my $home=homeserver($uname,$udom);
3216: unless ($home eq $perlvar{'lonHostID'}) {
3217: my @parts=split(/\//,$filename);
3218: my $path="/$parts[1]/$parts[2]/$parts[3]/$parts[4]";
3219: if ($path ne "$londocroot/res") {
3220: &logthis("Malconfiguration for replication: $filename");
3221: return 'bad_request';
3222: }
3223: my $count;
3224: for ($count=5;$count<$#parts;$count++) {
3225: $path.="/$parts[$count]";
3226: if ((-e $path)!=1) {
3227: mkdir($path,0777);
3228: }
3229: }
3230: my $request=new HTTP::Request('GET',"$remoteurl");
3231: my $response;
3232: if ($remoteurl =~ m{/raw/}) {
3233: $response=&LONCAPA::LWPReq::makerequest($home,$request,$transname,\%perlvar,'',0,1);
3234: } else {
3235: $response=&LONCAPA::LWPReq::makerequest($home,$request,$transname,\%perlvar,'',1);
3236: }
3237: if ($response->is_error()) {
3238: unlink($transname);
3239: my $message=$response->status_line;
3240: &logthis("<font color=\"blue\">WARNING:"
3241: ." LWP get: $message: $filename</font>");
3242: return 'unavailable';
3243: } else {
3244: if ($remoteurl!~/\.meta$/) {
3245: my $mrequest=new HTTP::Request('GET',$remoteurl.'.meta');
3246: my $mresponse;
3247: if ($remoteurl =~ m{/raw/}) {
3248: $mresponse = &LONCAPA::LWPReq::makerequest($home,$mrequest,$filename.'.meta',\%perlvar,'',0,1);
3249: } else {
3250: $mresponse = &LONCAPA::LWPReq::makerequest($home,$mrequest,$filename.'.meta',\%perlvar,'',1);
3251: }
3252: if ($mresponse->is_error()) {
3253: unlink($filename.'.meta');
3254: &logthis(
3255: "<font color=\"yellow\">INFO: No metadata: $filename</font>");
3256: }
3257: }
3258: rename($transname,$filename);
3259: return 'ok';
3260: }
3261: }
3262: }
3263: }
3264:
3265: # ------------------------------------------------ Get server side include body
3266: sub ssi_body {
3267: my ($filelink,%form)=@_;
3268: if (! exists($form{'LONCAPA_INTERNAL_no_discussion'})) {
3269: $form{'LONCAPA_INTERNAL_no_discussion'}='true';
3270: }
3271: my $output='';
3272: my $response;
3273: if ($filelink=~/^https?\:/) {
3274: ($output,$response)=&externalssi($filelink);
3275: } else {
3276: $filelink .= $filelink=~/\?/ ? '&' : '?';
3277: $filelink .= 'inhibitmenu=yes';
3278: ($output,$response)=&ssi($filelink,%form);
3279: }
3280: $output=~s|//(\s*<!--)? BEGIN LON-CAPA Internal.+?// END LON-CAPA Internal\s*(-->)?\s||gs;
3281: $output=~s/^.*?\<body[^\>]*\>//si;
3282: $output=~s/\<\/body\s*\>.*?$//si;
3283: if (wantarray) {
3284: return ($output, $response);
3285: } else {
3286: return $output;
3287: }
3288: }
3289:
3290: # --------------------------------------------------------- Server Side Include
3291:
3292: sub absolute_url {
3293: my ($host_name) = @_;
3294: my $protocol = ($ENV{'SERVER_PORT'} == 443?'https://':'http://');
3295: if ($host_name eq '') {
3296: $host_name = $ENV{'SERVER_NAME'};
3297: }
3298: return $protocol.$host_name;
3299: }
3300:
3301: #
3302: # Server side include.
3303: # Parameters:
3304: # fn Possibly encrypted resource name/id.
3305: # form Hash that describes how the rendering should be done
3306: # and other things.
3307: # Returns:
3308: # Scalar context: The content of the response.
3309: # Array context: 2 element list of the content and the full response object.
3310: #
3311: sub ssi {
3312:
3313: my ($fn,%form)=@_;
3314: my $request;
3315:
3316: $form{'no_update_last_known'}=1;
3317: &Apache::lonenc::check_encrypt(\$fn);
3318: if (%form) {
3319: $request=new HTTP::Request('POST',&absolute_url().$fn);
3320: $request->content(join('&',map {
3321: my $name = escape($_);
3322: "$name=" . ( ref($form{$_}) eq 'ARRAY'
3323: ? join("&$name=", map {escape($_) } @{$form{$_}})
3324: : &escape($form{$_}) );
3325: } keys(%form)));
3326: } else {
3327: $request=new HTTP::Request('GET',&absolute_url().$fn);
3328: }
3329:
3330: $request->header(Cookie => $ENV{'HTTP_COOKIE'});
3331: my $lonhost = $perlvar{'lonHostID'};
3332: my $islocal;
3333: if (($env{'request.course.id'}) &&
3334: ($form{'grade_courseid'} eq $env{'request.course.id'}) &&
3335: ($form{'grade_username'} ne '') && ($form{'grade_domain'} ne '') &&
3336: ($form{'grade_symb'} ne '') &&
3337: (&Apache::lonnet::allowed('mgr',$env{'request.course.id'}.
3338: ($env{'request.course.sec'}?'/'.$env{'request.course.sec'}:'')))) {
3339: $islocal = 1;
3340: }
3341: my $response= &LONCAPA::LWPReq::makerequest($lonhost,$request,'',\%perlvar,
3342: '','','',$islocal);
3343:
3344: if (wantarray) {
3345: return ($response->content, $response);
3346: } else {
3347: return $response->content;
3348: }
3349: }
3350:
3351: sub externalssi {
3352: my ($url)=@_;
3353: my $request=new HTTP::Request('GET',$url);
3354: my $response = &LONCAPA::LWPReq::makerequest('',$request,'',\%perlvar);
3355: if (wantarray) {
3356: return ($response->content, $response);
3357: } else {
3358: return $response->content;
3359: }
3360: }
3361:
3362:
3363: # If the local copy of a replicated resource is outdated, trigger a
3364: # connection from the homeserver to flush the delayed queue. If no update
3365: # happens, remove local copies of outdated resource (and corresponding
3366: # metadata file).
3367:
3368: sub remove_stale_resfile {
3369: my ($url) = @_;
3370: my $removed;
3371: if ($url=~m{^/res/($match_domain)/($match_username)/}) {
3372: my $audom = $1;
3373: my $auname = $2;
3374: unless (($url =~ /\.\d+\.\w+$/) || ($url =~ m{^/res/lib/templates/})) {
3375: my $homeserver = &homeserver($auname,$audom);
3376: unless (($homeserver eq 'no_host') ||
3377: (grep { $_ eq $homeserver } ¤t_machine_ids())) {
3378: my $fname = &filelocation('',$url);
3379: if (-e $fname) {
3380: my $hostname = &hostname($homeserver);
3381: if ($hostname) {
3382: my $protocol = $protocol{$homeserver};
3383: $protocol = 'http' if ($protocol ne 'https');
3384: my $uri = &declutter($url);
3385: my $request=new HTTP::Request('HEAD',$protocol.'://'.$hostname.'/raw/'.$uri);
3386: my $response = &LONCAPA::LWPReq::makerequest($homeserver,$request,'',\%perlvar,5,0,1);
3387: if ($response->is_success()) {
3388: my $remmodtime = &HTTP::Date::str2time( $response->header('Last-modified') );
3389: my $locmodtime = (stat($fname))[9];
3390: if ($locmodtime < $remmodtime) {
3391: my $stale;
3392: my $answer = &reply('pong',$homeserver);
3393: if ($answer eq $homeserver.':'.$perlvar{'lonHostID'}) {
3394: sleep(0.2);
3395: $locmodtime = (stat($fname))[9];
3396: if ($locmodtime < $remmodtime) {
3397: my $posstransfer = $fname.'.in.transfer';
3398: if ((-e $posstransfer) && ($remmodtime < (stat($posstransfer))[9])) {
3399: $removed = 1;
3400: } else {
3401: $stale = 1;
3402: }
3403: } else {
3404: $removed = 1;
3405: }
3406: } else {
3407: $stale = 1;
3408: }
3409: if ($stale) {
3410: unlink($fname);
3411: if ($uri!~/\.meta$/) {
3412: unlink($fname.'.meta');
3413: }
3414: &reply("unsub:$fname",$homeserver);
3415: $removed = 1;
3416: }
3417: }
3418: }
3419: }
3420: }
3421: }
3422: }
3423: }
3424: return $removed;
3425: }
3426:
3427: # -------------------------------- Allow a /uploaded/ URI to be vouched for
3428:
3429: sub allowuploaded {
3430: my ($srcurl,$url)=@_;
3431: $url=&clutter(&declutter($url));
3432: my $dir=$url;
3433: $dir=~s/\/[^\/]+$//;
3434: my %httpref=();
3435: my $httpurl=&hreflocation('',$url);
3436: $httpref{'httpref.'.$httpurl}=$srcurl;
3437: &Apache::lonnet::appenv(\%httpref);
3438: }
3439:
3440: #
3441: # Determine if the current user should be able to edit a particular resource,
3442: # when viewing in course context.
3443: # (a) When viewing resource used to determine if "Edit" item is included in
3444: # Functions.
3445: # (b) When displaying folder contents in course editor, used to determine if
3446: # "Edit" link will be displayed alongside resource.
3447: #
3448: # input: six args -- filename (decluttered), course number, course domain,
3449: # url, symb (if registered) and group (if this is a group
3450: # item -- e.g., bulletin board, group page etc.).
3451: # output: array of five scalars --
3452: # $cfile -- url for file editing if editable on current server
3453: # $home -- homeserver of resource (i.e., for author if published,
3454: # or course if uploaded.).
3455: # $switchserver -- 1 if server switch will be needed.
3456: # $forceedit -- 1 if icon/link should be to go to edit mode
3457: # $forceview -- 1 if icon/link should be to go to view mode
3458: #
3459:
3460: sub can_edit_resource {
3461: my ($file,$cnum,$cdom,$resurl,$symb,$group) = @_;
3462: my ($cfile,$home,$switchserver,$forceedit,$forceview,$uploaded,$incourse);
3463: #
3464: # For aboutme pages user can only edit his/her own.
3465: #
3466: if ($resurl =~ m{^/?adm/($match_domain)/($match_username)/aboutme$}) {
3467: my ($sdom,$sname) = ($1,$2);
3468: if (($sdom eq $env{'user.domain'}) && ($sname eq $env{'user.name'})) {
3469: $home = $env{'user.home'};
3470: $cfile = $resurl;
3471: if ($env{'form.forceedit'}) {
3472: $forceview = 1;
3473: } else {
3474: $forceedit = 1;
3475: }
3476: return ($cfile,$home,$switchserver,$forceedit,$forceview);
3477: } else {
3478: return;
3479: }
3480: }
3481:
3482: if ($env{'request.course.id'}) {
3483: my $crsedit = &Apache::lonnet::allowed('mdc',$env{'request.course.id'});
3484: if ($group ne '') {
3485: # if this is a group homepage or group bulletin board, check group privs
3486: my $allowed = 0;
3487: if ($resurl =~ m{^/?adm/$cdom/$cnum/$group/smppg$}) {
3488: if ((&allowed('mdg',$env{'request.course.id'}.
3489: ($env{'request.course.sec'}?'/'.$env{'request.course.sec'}:''))) ||
3490: (&allowed('mgh',$env{'request.course.id'}.'/'.$group)) || $crsedit) {
3491: $allowed = 1;
3492: }
3493: } elsif ($resurl =~ m{^/?adm/$cdom/$cnum/\d+/bulletinboard$}) {
3494: if ((&allowed('mdg',$env{'request.course.id'}.($env{'request.course.sec'}?'/'.$env{'request.course.sec'}:''))) ||
3495: (&allowed('cgb',$env{'request.course.id'}.'/'.$group)) || $crsedit) {
3496: $allowed = 1;
3497: }
3498: }
3499: if ($allowed) {
3500: $home=&homeserver($cnum,$cdom);
3501: if ($env{'form.forceedit'}) {
3502: $forceview = 1;
3503: } else {
3504: $forceedit = 1;
3505: }
3506: $cfile = $resurl;
3507: } else {
3508: return;
3509: }
3510: } else {
3511: if ($resurl =~ m{^/?adm/viewclasslist$}) {
3512: unless (&Apache::lonnet::allowed('opa',$env{'request.course.id'})) {
3513: return;
3514: }
3515: } elsif (!$crsedit) {
3516: #
3517: # No edit allowed where CC has switched to student role.
3518: #
3519: return;
3520: }
3521: }
3522: }
3523:
3524: if ($file ne '') {
3525: if (($cnum =~ /$match_courseid/) && ($cdom =~ /$match_domain/)) {
3526: if (&is_course_upload($file,$cnum,$cdom)) {
3527: $uploaded = 1;
3528: $incourse = 1;
3529: if ($file =~/\.(htm|html|css|js|txt)$/) {
3530: $cfile = &hreflocation('',$file);
3531: if ($env{'form.forceedit'}) {
3532: $forceview = 1;
3533: } else {
3534: $forceedit = 1;
3535: }
3536: }
3537: } elsif ($resurl =~ m{^/public/$cdom/$cnum/syllabus}) {
3538: $incourse = 1;
3539: if ($env{'form.forceedit'}) {
3540: $forceview = 1;
3541: } else {
3542: $forceedit = 1;
3543: }
3544: $cfile = $resurl;
3545: } elsif (($resurl ne '') && (&is_on_map($resurl))) {
3546: if ($resurl =~ m{^/adm/$match_domain/$match_username/\d+/smppg|bulletinboard$}) {
3547: $incourse = 1;
3548: if ($env{'form.forceedit'}) {
3549: $forceview = 1;
3550: } else {
3551: $forceedit = 1;
3552: }
3553: $cfile = $resurl;
3554: } elsif ($resurl eq '/res/lib/templates/simpleproblem.problem') {
3555: $incourse = 1;
3556: $cfile = $resurl.'/smpedit';
3557: } elsif ($resurl =~ m{^/adm/wrapper/ext/}) {
3558: $incourse = 1;
3559: if ($env{'form.forceedit'}) {
3560: $forceview = 1;
3561: } else {
3562: $forceedit = 1;
3563: }
3564: $cfile = $resurl;
3565: } elsif ($resurl =~ m{^/adm/wrapper/adm/$cdom/$cnum/\d+/ext\.tool$}) {
3566: $incourse = 1;
3567: if ($env{'form.forceedit'}) {
3568: $forceview = 1;
3569: } else {
3570: $forceedit = 1;
3571: }
3572: $cfile = $resurl;
3573: } elsif ($resurl =~ m{^/?adm/viewclasslist$}) {
3574: $incourse = 1;
3575: if ($env{'form.forceedit'}) {
3576: $forceview = 1;
3577: } else {
3578: $forceedit = 1;
3579: }
3580: $cfile = ($resurl =~ m{^/} ? $resurl : "/$resurl");
3581: }
3582: } elsif ($resurl eq '/res/lib/templates/simpleproblem.problem/smpedit') {
3583: my $template = '/res/lib/templates/simpleproblem.problem';
3584: if (&is_on_map($template)) {
3585: $incourse = 1;
3586: $forceview = 1;
3587: $cfile = $template;
3588: }
3589: } elsif (($resurl =~ m{^/adm/wrapper/ext/}) && ($env{'form.folderpath'} =~ /^supplemental/)) {
3590: $incourse = 1;
3591: if ($env{'form.forceedit'}) {
3592: $forceview = 1;
3593: } else {
3594: $forceedit = 1;
3595: }
3596: $cfile = $resurl;
3597: } elsif (($resurl =~ m{^/adm/wrapper/adm/$cdom/$cnum/\d+/ext\.tool$}) && ($env{'form.folderpath'} =~ /^supplemental/)) {
3598: $incourse = 1;
3599: if ($env{'form.forceedit'}) {
3600: $forceview = 1;
3601: } else {
3602: $forceedit = 1;
3603: }
3604: $cfile = $resurl;
3605: } elsif (($resurl eq '/adm/extresedit') && ($symb || $env{'form.folderpath'})) {
3606: $incourse = 1;
3607: $forceview = 1;
3608: if ($symb) {
3609: my ($map,$id,$res)=&decode_symb($symb);
3610: $env{'request.symb'} = $symb;
3611: $cfile = &clutter($res);
3612: } else {
3613: $cfile = $env{'form.suppurl'};
3614: my $escfile = &unescape($cfile);
3615: if ($escfile =~ m{^/adm/$cdom/$cnum/\d+/ext\.tool$}) {
3616: $cfile = '/adm/wrapper'.$escfile;
3617: } else {
3618: $escfile =~ s{^http://}{};
3619: $cfile = &escape("/adm/wrapper/ext/$escfile");
3620: }
3621: }
3622: } elsif ($resurl =~ m{^/?adm/viewclasslist$}) {
3623: if ($env{'form.forceedit'}) {
3624: $forceview = 1;
3625: } else {
3626: $forceedit = 1;
3627: }
3628: $cfile = ($resurl =~ m{^/} ? $resurl : "/$resurl");
3629: }
3630: }
3631: if ($uploaded || $incourse) {
3632: $home=&homeserver($cnum,$cdom);
3633: } elsif ($file !~ m{/$}) {
3634: $file=~s{^(priv/$match_domain/$match_username)}{/$1};
3635: $file=~s{^($match_domain/$match_username)}{/priv/$1};
3636: # Check that the user has permission to edit this resource
3637: my $setpriv = 1;
3638: my ($cfuname,$cfudom)=&constructaccess($file,$setpriv);
3639: if (defined($cfudom)) {
3640: $home=&homeserver($cfuname,$cfudom);
3641: $cfile=$file;
3642: }
3643: }
3644: if (($cfile ne '') && (!$incourse || $uploaded) &&
3645: (($home ne '') && ($home ne 'no_host'))) {
3646: my @ids=¤t_machine_ids();
3647: unless (grep(/^\Q$home\E$/,@ids)) {
3648: $switchserver=1;
3649: }
3650: }
3651: }
3652: return ($cfile,$home,$switchserver,$forceedit,$forceview);
3653: }
3654:
3655: sub is_course_upload {
3656: my ($file,$cnum,$cdom) = @_;
3657: my $uploadpath = &LONCAPA::propath($cdom,$cnum);
3658: $uploadpath =~ s{^\/}{};
3659: if (($file =~ m{^\Q$uploadpath\E/userfiles/(docs|supplemental)/}) ||
3660: ($file =~ m{^userfiles/\Q$cdom\E/\Q$cnum\E/(docs|supplemental)/})) {
3661: return 1;
3662: }
3663: return;
3664: }
3665:
3666: sub in_course {
3667: my ($udom,$uname,$cdom,$cnum,$type,$hideprivileged) = @_;
3668: if ($hideprivileged) {
3669: my $skipuser;
3670: my %coursehash = &coursedescription($cdom.'_'.$cnum);
3671: my @possdoms = ($cdom);
3672: if ($coursehash{'checkforpriv'}) {
3673: push(@possdoms,split(/,/,$coursehash{'checkforpriv'}));
3674: }
3675: if (&privileged($uname,$udom,\@possdoms)) {
3676: $skipuser = 1;
3677: if ($coursehash{'nothideprivileged'}) {
3678: foreach my $item (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
3679: my $user;
3680: if ($item =~ /:/) {
3681: $user = $item;
3682: } else {
3683: $user = join(':',split(/[\@]/,$item));
3684: }
3685: if ($user eq $uname.':'.$udom) {
3686: undef($skipuser);
3687: last;
3688: }
3689: }
3690: }
3691: if ($skipuser) {
3692: return 0;
3693: }
3694: }
3695: }
3696: $type ||= 'any';
3697: if (!defined($cdom) || !defined($cnum)) {
3698: my $cid = $env{'request.course.id'};
3699: $cdom = $env{'course.'.$cid.'.domain'};
3700: $cnum = $env{'course.'.$cid.'.num'};
3701: }
3702: my $typesref;
3703: if (($type eq 'any') || ($type eq 'all')) {
3704: $typesref = ['active','previous','future'];
3705: } elsif ($type eq 'previous' || $type eq 'future') {
3706: $typesref = [$type];
3707: }
3708: my %roles = &get_my_roles($uname,$udom,'userroles',
3709: $typesref,undef,[$cdom]);
3710: my ($tmp) = keys(%roles);
3711: return 0 if ($tmp =~ /^(con_lost|error|no_such_host)/i);
3712: my @course_roles = grep(/^\Q$cnum\E:\Q$cdom\E:/, keys(%roles));
3713: if (@course_roles > 0) {
3714: return 1;
3715: }
3716: return 0;
3717: }
3718:
3719: # --------- File operations in /home/httpd/html/userfiles/$domain/1/2/3/$course
3720: # input: action, courseID, current domain, intended
3721: # path to file, source of file, instruction to parse file for objects,
3722: # ref to hash for embedded objects,
3723: # ref to hash for codebase of java objects.
3724: # reference to scalar to accommodate mime type determined
3725: # from File::MMagic if $parser = parse.
3726: #
3727: # output: url to file (if action was uploaddoc),
3728: # ok if successful, or diagnostic message otherwise (if action was propagate or copy)
3729: #
3730: # Allows directory structure to be used within lonUsers/../userfiles/ for a
3731: # course.
3732: #
3733: # action = propagate - /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
3734: # will be copied to /home/httpd/lonUsers/1/2/3/$course/userfiles in
3735: # course's home server.
3736: #
3737: # action = copy - /home/httpd/html/userfiles/$domain/1/2/3/$course/$file will
3738: # be copied from $source (current location) to
3739: # /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
3740: # and will then be copied to
3741: # /home/httpd/lonUsers/$domain/1/2/3/$course/userfiles/$file in
3742: # course's home server.
3743: #
3744: # action = uploaddoc - /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
3745: # will be retrived from $env{form.uploaddoc} (from DOCS interface) to
3746: # /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
3747: # and will then be copied to /home/httpd/lonUsers/1/2/3/$course/userfiles/$file
3748: # in course's home server.
3749: #
3750:
3751: sub process_coursefile {
3752: my ($action,$docuname,$docudom,$file,$source,$parser,$allfiles,$codebase,
3753: $mimetype)=@_;
3754: my $fetchresult;
3755: my $home=&homeserver($docuname,$docudom);
3756: if ($action eq 'propagate') {
3757: $fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
3758: $home);
3759: } else {
3760: my $fpath = '';
3761: my $fname = $file;
3762: ($fpath,$fname) = ($file =~ m|^(.*)/([^/]+)$|);
3763: $fpath=$docudom.'/'.$docuname.'/'.$fpath;
3764: my $filepath = &build_filepath($fpath);
3765: if ($action eq 'copy') {
3766: if ($source eq '') {
3767: $fetchresult = 'no source file';
3768: return $fetchresult;
3769: } else {
3770: my $destination = $filepath.'/'.$fname;
3771: rename($source,$destination);
3772: $fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
3773: $home);
3774: }
3775: } elsif ($action eq 'uploaddoc') {
3776: open(my $fh,'>',$filepath.'/'.$fname);
3777: print $fh $env{'form.'.$source};
3778: close($fh);
3779: if ($parser eq 'parse') {
3780: my $mm = new File::MMagic;
3781: my $type = $mm->checktype_filename($filepath.'/'.$fname);
3782: if ($type eq 'text/html') {
3783: my $parse_result = &extract_embedded_items($filepath.'/'.$fname,$allfiles,$codebase);
3784: unless ($parse_result eq 'ok') {
3785: &logthis('Failed to parse '.$filepath.'/'.$fname.' for embedded media: '.$parse_result);
3786: }
3787: }
3788: if (ref($mimetype)) {
3789: $$mimetype = $type;
3790: }
3791: }
3792: $fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
3793: $home);
3794: if ($fetchresult eq 'ok') {
3795: return '/uploaded/'.$fpath.'/'.$fname;
3796: } else {
3797: &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$file.
3798: ' to host '.$home.': '.$fetchresult);
3799: return '/adm/notfound.html';
3800: }
3801: }
3802: }
3803: unless ( $fetchresult eq 'ok') {
3804: &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$file.
3805: ' to host '.$home.': '.$fetchresult);
3806: }
3807: return $fetchresult;
3808: }
3809:
3810: sub build_filepath {
3811: my ($fpath) = @_;
3812: my $filepath=$perlvar{'lonDocRoot'}.'/userfiles';
3813: unless ($fpath eq '') {
3814: my @parts=split('/',$fpath);
3815: foreach my $part (@parts) {
3816: $filepath.= '/'.$part;
3817: if ((-e $filepath)!=1) {
3818: mkdir($filepath,0777);
3819: }
3820: }
3821: }
3822: return $filepath;
3823: }
3824:
3825: sub store_edited_file {
3826: my ($primary_url,$content,$docudom,$docuname,$fetchresult) = @_;
3827: my $file = $primary_url;
3828: $file =~ s#^/uploaded/$docudom/$docuname/##;
3829: my $fpath = '';
3830: my $fname = $file;
3831: ($fpath,$fname) = ($file =~ m|^(.*)/([^/]+)$|);
3832: $fpath=$docudom.'/'.$docuname.'/'.$fpath;
3833: my $filepath = &build_filepath($fpath);
3834: open(my $fh,'>',$filepath.'/'.$fname);
3835: print $fh $content;
3836: close($fh);
3837: my $home=&homeserver($docuname,$docudom);
3838: $$fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
3839: $home);
3840: if ($$fetchresult eq 'ok') {
3841: return '/uploaded/'.$fpath.'/'.$fname;
3842: } else {
3843: &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$file.
3844: ' to host '.$home.': '.$$fetchresult);
3845: return '/adm/notfound.html';
3846: }
3847: }
3848:
3849: sub clean_filename {
3850: my ($fname,$args)=@_;
3851: # Replace Windows backslashes by forward slashes
3852: $fname=~s/\\/\//g;
3853: if (!$args->{'keep_path'}) {
3854: # Get rid of everything but the actual filename
3855: $fname=~s/^.*\/([^\/]+)$/$1/;
3856: }
3857: # Replace spaces by underscores
3858: $fname=~s/\s+/\_/g;
3859: # Replace all other weird characters by nothing
3860: $fname=~s{[^/\w\.\-]}{}g;
3861: # Replace all .\d. sequences with _\d. so they no longer look like version
3862: # numbers
3863: $fname=~s/\.(\d+)(?=\.)/_$1/g;
3864: return $fname;
3865: }
3866: # This Function checks if an Image's dimensions exceed either $resizewidth (width)
3867: # or $resizeheight (height) - both pixels. If so, the image is scaled to produce an
3868: # image with the same aspect ratio as the original, but with dimensions which do
3869: # not exceed $resizewidth and $resizeheight.
3870:
3871: sub resizeImage {
3872: my ($img_path,$resizewidth,$resizeheight) = @_;
3873: my $ima = Image::Magick->new;
3874: my $resized;
3875: if (-e $img_path) {
3876: $ima->Read($img_path);
3877: if (($resizewidth =~ /^\d+$/) && ($resizeheight > 0)) {
3878: my $width = $ima->Get('width');
3879: my $height = $ima->Get('height');
3880: if ($width > $resizewidth) {
3881: my $factor = $width/$resizewidth;
3882: my $newheight = $height/$factor;
3883: $ima->Scale(width=>$resizewidth,height=>$newheight);
3884: $resized = 1;
3885: }
3886: }
3887: if (($resizeheight =~ /^\d+$/) && ($resizeheight > 0)) {
3888: my $width = $ima->Get('width');
3889: my $height = $ima->Get('height');
3890: if ($height > $resizeheight) {
3891: my $factor = $height/$resizeheight;
3892: my $newwidth = $width/$factor;
3893: $ima->Scale(width=>$newwidth,height=>$resizeheight);
3894: $resized = 1;
3895: }
3896: }
3897: if ($resized) {
3898: $ima->Write($img_path);
3899: }
3900: }
3901: return;
3902: }
3903:
3904: # --------------- Take an uploaded file and put it into the userfiles directory
3905: # input: $formname - the contents of the file are in $env{"form.$formname"}
3906: # the desired filename is in $env{"form.$formname.filename"}
3907: # $context - possible values: coursedoc, existingfile, overwrite,
3908: # canceloverwrite, scantron or ''.
3909: # if 'coursedoc': upload to the current course
3910: # if 'existingfile': write file to tmp/overwrites directory
3911: # if 'canceloverwrite': delete file written to tmp/overwrites directory
3912: # $context is passed as argument to &finishuserfileupload
3913: # $subdir - directory in userfile to store the file into
3914: # $parser - instruction to parse file for objects ($parser = parse) or
3915: # if context is 'scantron', $parser is hashref of csv column mapping
3916: # (e.g.,{ PaperID => 0, LastName => 1, FirstName => 2, ID => 3,
3917: # Section => 4, CODE => 5, FirstQuestion => 9 }).
3918: # $allfiles - reference to hash for embedded objects
3919: # $codebase - reference to hash for codebase of java objects
3920: # $desuname - username for permanent storage of uploaded file
3921: # $dsetudom - domain for permanaent storage of uploaded file
3922: # $thumbwidth - width (pixels) of thumbnail to make for uploaded image
3923: # $thumbheight - height (pixels) of thumbnail to make for uploaded image
3924: # $resizewidth - width (pixels) to which to resize uploaded image
3925: # $resizeheight - height (pixels) to which to resize uploaded image
3926: # $mimetype - reference to scalar to accommodate mime type determined
3927: # from File::MMagic.
3928: #
3929: # output: url of file in userspace, or error: <message>
3930: # or /adm/notfound.html if failure to upload occurse
3931:
3932: sub userfileupload {
3933: my ($formname,$context,$subdir,$parser,$allfiles,$codebase,$destuname,
3934: $destudom,$thumbwidth,$thumbheight,$resizewidth,$resizeheight,$mimetype)=@_;
3935: if (!defined($subdir)) { $subdir='unknown'; }
3936: my $fname=$env{'form.'.$formname.'.filename'};
3937: $fname=&clean_filename($fname);
3938: # See if there is anything left
3939: unless ($fname) { return 'error: no uploaded file'; }
3940: # Files uploaded to help request form, or uploaded to "create course" page are handled differently
3941: if ((($formname eq 'screenshot') && ($subdir eq 'helprequests')) ||
3942: (($formname eq 'coursecreatorxml') && ($subdir eq 'batchupload')) ||
3943: ($context eq 'existingfile') || ($context eq 'canceloverwrite')) {
3944: my $now = time;
3945: my $filepath;
3946: if (($formname eq 'screenshot') && ($subdir eq 'helprequests')) {
3947: $filepath = 'tmp/helprequests/'.$now;
3948: } elsif (($formname eq 'coursecreatorxml') && ($subdir eq 'batchupload')) {
3949: $filepath = 'tmp/addcourse/'.$destudom.'/web/'.$env{'user.name'}.
3950: '_'.$env{'user.domain'}.'/pending';
3951: } elsif (($context eq 'existingfile') || ($context eq 'canceloverwrite')) {
3952: my ($docuname,$docudom);
3953: if ($destudom =~ /^$match_domain$/) {
3954: $docudom = $destudom;
3955: } else {
3956: $docudom = $env{'user.domain'};
3957: }
3958: if ($destuname =~ /^$match_username$/) {
3959: $docuname = $destuname;
3960: } else {
3961: $docuname = $env{'user.name'};
3962: }
3963: if (exists($env{'form.group'})) {
3964: $docuname=$env{'course.'.$env{'request.course.id'}.'.num'};
3965: $docudom=$env{'course.'.$env{'request.course.id'}.'.domain'};
3966: }
3967: $filepath = 'tmp/overwrites/'.$docudom.'/'.$docuname.'/'.$subdir;
3968: if ($context eq 'canceloverwrite') {
3969: my $tempfile = $perlvar{'lonDaemons'}.'/'.$filepath.'/'.$fname;
3970: if (-e $tempfile) {
3971: my @info = stat($tempfile);
3972: if ($info[9] eq $env{'form.timestamp'}) {
3973: unlink($tempfile);
3974: }
3975: }
3976: return;
3977: }
3978: }
3979: # Create the directory if not present
3980: my @parts=split(/\//,$filepath);
3981: my $fullpath = $perlvar{'lonDaemons'};
3982: for (my $i=0;$i<@parts;$i++) {
3983: $fullpath .= '/'.$parts[$i];
3984: if ((-e $fullpath)!=1) {
3985: mkdir($fullpath,0777);
3986: }
3987: }
3988: open(my $fh,'>',$fullpath.'/'.$fname);
3989: print $fh $env{'form.'.$formname};
3990: close($fh);
3991: if ($context eq 'existingfile') {
3992: my @info = stat($fullpath.'/'.$fname);
3993: return ($fullpath.'/'.$fname,$info[9]);
3994: } else {
3995: return $fullpath.'/'.$fname;
3996: }
3997: }
3998: if ($subdir eq 'scantron') {
3999: $fname = 'scantron_orig_'.$fname;
4000: } else {
4001: $fname="$subdir/$fname";
4002: }
4003: if ($context eq 'coursedoc') {
4004: my $docuname=$env{'course.'.$env{'request.course.id'}.'.num'};
4005: my $docudom=$env{'course.'.$env{'request.course.id'}.'.domain'};
4006: if ($env{'form.folder'} =~ m/^(default|supplemental)/) {
4007: return &finishuserfileupload($docuname,$docudom,
4008: $formname,$fname,$parser,$allfiles,
4009: $codebase,$thumbwidth,$thumbheight,
4010: $resizewidth,$resizeheight,$context,$mimetype);
4011: } else {
4012: if ($env{'form.folder'}) {
4013: $fname=$env{'form.folder'}.'/'.$fname;
4014: }
4015: return &process_coursefile('uploaddoc',$docuname,$docudom,
4016: $fname,$formname,$parser,
4017: $allfiles,$codebase,$mimetype);
4018: }
4019: } elsif (defined($destuname)) {
4020: my $docuname=$destuname;
4021: my $docudom=$destudom;
4022: return &finishuserfileupload($docuname,$docudom,$formname,$fname,
4023: $parser,$allfiles,$codebase,
4024: $thumbwidth,$thumbheight,
4025: $resizewidth,$resizeheight,$context,$mimetype);
4026: } else {
4027: my $docuname=$env{'user.name'};
4028: my $docudom=$env{'user.domain'};
4029: if ((exists($env{'form.group'})) || ($context eq 'syllabus')) {
4030: $docuname=$env{'course.'.$env{'request.course.id'}.'.num'};
4031: $docudom=$env{'course.'.$env{'request.course.id'}.'.domain'};
4032: }
4033: return &finishuserfileupload($docuname,$docudom,$formname,$fname,
4034: $parser,$allfiles,$codebase,
4035: $thumbwidth,$thumbheight,
4036: $resizewidth,$resizeheight,$context,$mimetype);
4037: }
4038: }
4039:
4040: sub finishuserfileupload {
4041: my ($docuname,$docudom,$formname,$fname,$parser,$allfiles,$codebase,
4042: $thumbwidth,$thumbheight,$resizewidth,$resizeheight,$context,$mimetype) = @_;
4043: my $path=$docudom.'/'.$docuname.'/';
4044: my $filepath=$perlvar{'lonDocRoot'};
4045:
4046: my ($fnamepath,$file,$fetchthumb);
4047: $file=$fname;
4048: if ($fname=~m|/|) {
4049: ($fnamepath,$file) = ($fname =~ m|^(.*)/([^/]+)$|);
4050: $path.=$fnamepath.'/';
4051: }
4052: my @parts=split(/\//,$filepath.'/userfiles/'.$path);
4053: my $count;
4054: for ($count=4;$count<=$#parts;$count++) {
4055: $filepath.="/$parts[$count]";
4056: if ((-e $filepath)!=1) {
4057: mkdir($filepath,0777);
4058: }
4059: }
4060:
4061: # Save the file
4062: {
4063: if (!open(FH,'>',$filepath.'/'.$file)) {
4064: &logthis('Failed to create '.$filepath.'/'.$file);
4065: print STDERR ('Failed to create '.$filepath.'/'.$file."\n");
4066: return '/adm/notfound.html';
4067: }
4068: if ($context eq 'overwrite') {
4069: my $source = LONCAPA::tempdir().'/overwrites/'.$docudom.'/'.$docuname.'/'.$fname;
4070: my $target = $filepath.'/'.$file;
4071: if (-e $source) {
4072: my @info = stat($source);
4073: if ($info[9] eq $env{'form.timestamp'}) {
4074: unless (&File::Copy::move($source,$target)) {
4075: &logthis('Failed to overwrite '.$filepath.'/'.$file);
4076: return "Moving from $source failed";
4077: }
4078: } else {
4079: return "Temporary file: $source had unexpected date/time for last modification";
4080: }
4081: } else {
4082: return "Temporary file: $source missing";
4083: }
4084: } elsif (!print FH ($env{'form.'.$formname})) {
4085: &logthis('Failed to write to '.$filepath.'/'.$file);
4086: print STDERR ('Failed to write to '.$filepath.'/'.$file."\n");
4087: return '/adm/notfound.html';
4088: }
4089: close(FH);
4090: if ($resizewidth && $resizeheight) {
4091: my $mm = new File::MMagic;
4092: my $mime_type = $mm->checktype_filename($filepath.'/'.$file);
4093: if ($mime_type =~ m{^image/}) {
4094: &resizeImage($filepath.'/'.$file,$resizewidth,$resizeheight);
4095: }
4096: }
4097: }
4098: if (($context eq 'coursedoc') || ($parser eq 'parse')) {
4099: if (ref($mimetype)) {
4100: if ($$mimetype eq '') {
4101: my $mm = new File::MMagic;
4102: my $type = $mm->checktype_filename($filepath.'/'.$file);
4103: $$mimetype = $type;
4104: }
4105: }
4106: }
4107: if (($context ne 'scantron') && ($parser eq 'parse')) {
4108: if ((ref($mimetype)) && ($$mimetype eq 'text/html')) {
4109: my $parse_result = &extract_embedded_items($filepath.'/'.$file,
4110: $allfiles,$codebase);
4111: unless ($parse_result eq 'ok') {
4112: &logthis('Failed to parse '.$filepath.$file.
4113: ' for embedded media: '.$parse_result);
4114: }
4115: }
4116: } elsif (($context eq 'scantron') && (ref($parser) eq 'HASH')) {
4117: my $format = $env{'form.scantron_format'};
4118: &bubblesheet_converter($docudom,$filepath.'/'.$file,$parser,$format);
4119: }
4120: if (($thumbwidth =~ /^\d+$/) && ($thumbheight =~ /^\d+$/)) {
4121: my $input = $filepath.'/'.$file;
4122: my $output = $filepath.'/'.'tn-'.$file;
4123: my $thumbsize = $thumbwidth.'x'.$thumbheight;
4124: my @args = ('convert','-sample',$thumbsize,$input,$output);
4125: system({$args[0]} @args);
4126: if (-e $filepath.'/'.'tn-'.$file) {
4127: $fetchthumb = 1;
4128: }
4129: }
4130:
4131: # Notify homeserver to grep it
4132: #
4133: my $docuhome=&homeserver($docuname,$docudom);
4134: my $fetchresult= &reply('fetchuserfile:'.$path.$file,$docuhome);
4135: if ($fetchresult eq 'ok') {
4136: if ($fetchthumb) {
4137: my $thumbresult= &reply('fetchuserfile:'.$path.'tn-'.$file,$docuhome);
4138: if ($thumbresult ne 'ok') {
4139: &logthis('Failed to transfer '.$path.'tn-'.$file.' to host '.
4140: $docuhome.': '.$thumbresult);
4141: }
4142: }
4143: #
4144: # Return the URL to it
4145: return '/uploaded/'.$path.$file;
4146: } else {
4147: &logthis('Failed to transfer '.$path.$file.' to host '.$docuhome.
4148: ': '.$fetchresult);
4149: return '/adm/notfound.html';
4150: }
4151: }
4152:
4153: sub extract_embedded_items {
4154: my ($fullpath,$allfiles,$codebase,$content) = @_;
4155: my @state = ();
4156: my (%lastids,%related,%shockwave,%flashvars);
4157: my %javafiles = (
4158: codebase => '',
4159: code => '',
4160: archive => ''
4161: );
4162: my %mediafiles = (
4163: src => '',
4164: movie => '',
4165: );
4166: my $p;
4167: if ($content) {
4168: $p = HTML::LCParser->new($content);
4169: } else {
4170: $p = HTML::LCParser->new($fullpath);
4171: }
4172: while (my $t=$p->get_token()) {
4173: if ($t->[0] eq 'S') {
4174: my ($tagname, $attr) = ($t->[1],$t->[2]);
4175: push(@state, $tagname);
4176: if (lc($tagname) eq 'allow') {
4177: &add_filetype($allfiles,$attr->{'src'},'src');
4178: }
4179: if (lc($tagname) eq 'img') {
4180: &add_filetype($allfiles,$attr->{'src'},'src');
4181: }
4182: if (lc($tagname) eq 'a') {
4183: unless (($attr->{'href'} =~ /^#/) || ($attr->{'href'} eq '')) {
4184: &add_filetype($allfiles,$attr->{'href'},'href');
4185: }
4186: }
4187: if (lc($tagname) eq 'script') {
4188: my $src;
4189: if ($attr->{'archive'} =~ /\.jar$/i) {
4190: &add_filetype($allfiles,$attr->{'archive'},'archive');
4191: } else {
4192: if ($attr->{'src'} ne '') {
4193: $src = $attr->{'src'};
4194: &add_filetype($allfiles,$src,'src');
4195: }
4196: }
4197: my $text = $p->get_trimmed_text();
4198: if ($text =~ /\Qswfobject.registerObject(\E([^\)]+)\)/) {
4199: my @swfargs = split(/,/,$1);
4200: foreach my $item (@swfargs) {
4201: $item =~ s/["']//g;
4202: $item =~ s/^\s+//;
4203: $item =~ s/\s+$//;
4204: }
4205: if (($swfargs[0] ne'') && ($swfargs[2] ne '')) {
4206: if (ref($related{$swfargs[0]}) eq 'ARRAY') {
4207: push(@{$related{$swfargs[0]}},$swfargs[2]);
4208: } else {
4209: $related{$swfargs[0]} = [$swfargs[2]];
4210: }
4211: }
4212: }
4213: }
4214: if (lc($tagname) eq 'link') {
4215: if (lc($attr->{'rel'}) eq 'stylesheet') {
4216: &add_filetype($allfiles,$attr->{'href'},'href');
4217: }
4218: }
4219: if (lc($tagname) eq 'object' ||
4220: (lc($tagname) eq 'embed' && lc($state[-2]) ne 'object')) {
4221: foreach my $item (keys(%javafiles)) {
4222: $javafiles{$item} = '';
4223: }
4224: if ((lc($tagname) eq 'object') && (lc($state[-2]) ne 'object')) {
4225: $lastids{lc($tagname)} = $attr->{'id'};
4226: }
4227: }
4228: if (lc($state[-2]) eq 'object' && lc($tagname) eq 'param') {
4229: my $name = lc($attr->{'name'});
4230: foreach my $item (keys(%javafiles)) {
4231: if ($name eq $item) {
4232: $javafiles{$item} = $attr->{'value'};
4233: last;
4234: }
4235: }
4236: my $pathfrom;
4237: foreach my $item (keys(%mediafiles)) {
4238: if ($name eq $item) {
4239: $pathfrom = $attr->{'value'};
4240: $shockwave{$lastids{lc($state[-2])}} = $pathfrom;
4241: &add_filetype($allfiles,$pathfrom,$name);
4242: last;
4243: }
4244: }
4245: if ($name eq 'flashvars') {
4246: $flashvars{$lastids{lc($state[-2])}} = $attr->{'value'};
4247: }
4248: if ($pathfrom ne '') {
4249: &embedded_dependency($allfiles,\%related,$lastids{lc($state[-2])},
4250: $pathfrom);
4251: }
4252: }
4253: if (lc($tagname) eq 'embed' || lc($tagname) eq 'applet') {
4254: foreach my $item (keys(%javafiles)) {
4255: if ($attr->{$item}) {
4256: $javafiles{$item} = $attr->{$item};
4257: last;
4258: }
4259: }
4260: foreach my $item (keys(%mediafiles)) {
4261: if ($attr->{$item}) {
4262: &add_filetype($allfiles,$attr->{$item},$item);
4263: last;
4264: }
4265: }
4266: if (lc($tagname) eq 'embed') {
4267: if (($attr->{'name'} ne '') && ($attr->{'src'} ne '')) {
4268: &embedded_dependency($allfiles,\%related,$attr->{'name'},
4269: $attr->{'src'});
4270: }
4271: }
4272: }
4273: if (lc($tagname) eq 'iframe') {
4274: my $src = $attr->{'src'} ;
4275: if (($src ne '') && ($src !~ m{^(/|https?://)})) {
4276: &add_filetype($allfiles,$src,'src');
4277: } elsif ($src =~ m{^/}) {
4278: if ($env{'request.course.id'}) {
4279: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
4280: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
4281: my $url = &hreflocation('',$fullpath);
4282: if ($url =~ m{^/uploaded/$cdom/$cnum/docs/(\w+/\d+)/}) {
4283: my $relpath = $1;
4284: if ($src =~ m{^/uploaded/$cdom/$cnum/docs/\Q$relpath\E/(.+)$}) {
4285: &add_filetype($allfiles,$1,'src');
4286: }
4287: }
4288: }
4289: }
4290: }
4291: if ($t->[4] =~ m{/>$}) {
4292: pop(@state);
4293: }
4294: } elsif ($t->[0] eq 'E') {
4295: my ($tagname) = ($t->[1]);
4296: if ($javafiles{'codebase'} ne '') {
4297: $javafiles{'codebase'} .= '/';
4298: }
4299: if (lc($tagname) eq 'applet' ||
4300: lc($tagname) eq 'object' ||
4301: (lc($tagname) eq 'embed' && lc($state[-2]) ne 'object')
4302: ) {
4303: foreach my $item (keys(%javafiles)) {
4304: if ($item ne 'codebase' && $javafiles{$item} ne '') {
4305: my $file=$javafiles{'codebase'}.$javafiles{$item};
4306: &add_filetype($allfiles,$file,$item);
4307: }
4308: }
4309: }
4310: pop @state;
4311: }
4312: }
4313: foreach my $id (sort(keys(%flashvars))) {
4314: if ($shockwave{$id} ne '') {
4315: my @pairs = split(/\&/,$flashvars{$id});
4316: foreach my $pair (@pairs) {
4317: my ($key,$value) = split(/\=/,$pair);
4318: if ($key eq 'thumb') {
4319: &add_filetype($allfiles,$value,$key);
4320: } elsif ($key eq 'content') {
4321: my ($path) = ($shockwave{$id} =~ m{^(.+/)[^/]+$});
4322: my ($ext) = ($value =~ /\.([^.]+)$/);
4323: if ($ext ne '') {
4324: &add_filetype($allfiles,$path.$value,$ext);
4325: }
4326: }
4327: }
4328: }
4329: }
4330: return 'ok';
4331: }
4332:
4333: sub add_filetype {
4334: my ($allfiles,$file,$type)=@_;
4335: if (exists($allfiles->{$file})) {
4336: unless (grep/^\Q$type\E$/, @{$allfiles->{$file}}) {
4337: push(@{$allfiles->{$file}}, &escape($type));
4338: }
4339: } else {
4340: @{$allfiles->{$file}} = (&escape($type));
4341: }
4342: }
4343:
4344: sub embedded_dependency {
4345: my ($allfiles,$related,$identifier,$pathfrom) = @_;
4346: if ((ref($allfiles) eq 'HASH') && (ref($related) eq 'HASH')) {
4347: if (($identifier ne '') &&
4348: (ref($related->{$identifier}) eq 'ARRAY') &&
4349: ($pathfrom ne '')) {
4350: my ($path) = ($pathfrom =~ m{^(.+/)[^/]+$});
4351: foreach my $dep (@{$related->{$identifier}}) {
4352: &add_filetype($allfiles,$path.$dep,'object');
4353: }
4354: }
4355: }
4356: return;
4357: }
4358:
4359: sub bubblesheet_converter {
4360: my ($cdom,$fullpath,$config,$format) = @_;
4361: if ((&domain($cdom) ne '') &&
4362: ($fullpath =~ m{^\Q$perlvar{'lonDocRoot'}/userfiles/$cdom/\E$match_courseid/scantron_orig}) &&
4363: (-e $fullpath) && (ref($config) eq 'HASH') && ($format ne '')) {
4364: my (%csvcols,%csvoptions);
4365: if (ref($config->{'fields'}) eq 'HASH') {
4366: %csvcols = %{$config->{'fields'}};
4367: }
4368: if (ref($config->{'options'}) eq 'HASH') {
4369: %csvoptions = %{$config->{'options'}};
4370: }
4371: my %csvbynum = reverse(%csvcols);
4372: my %scantronconf = &get_scantron_config($format,$cdom);
4373: if (keys(%scantronconf)) {
4374: my %bynum = (
4375: $scantronconf{CODEstart} => 'CODEstart',
4376: $scantronconf{IDstart} => 'IDstart',
4377: $scantronconf{PaperID} => 'PaperID',
4378: $scantronconf{FirstName} => 'FirstName',
4379: $scantronconf{LastName} => 'LastName',
4380: $scantronconf{Qstart} => 'Qstart',
4381: );
4382: my @ordered;
4383: foreach my $item (sort { $a <=> $b } keys(%bynum)) {
4384: push(@ordered,$bynum{$item});
4385: }
4386: my %mapstart = (
4387: CODEstart => 'CODE',
4388: IDstart => 'ID',
4389: PaperID => 'PaperID',
4390: FirstName => 'FirstName',
4391: LastName => 'LastName',
4392: Qstart => 'FirstQuestion',
4393: );
4394: my %maplength = (
4395: CODEstart => 'CODElength',
4396: IDstart => 'IDlength',
4397: PaperID => 'PaperIDlength',
4398: FirstName => 'FirstNamelength',
4399: LastName => 'LastNamelength',
4400: );
4401: if (open(my $fh,'<',$fullpath)) {
4402: my $output;
4403: my %lettdig = &letter_to_digits();
4404: my %diglett = reverse(%lettdig);
4405: my $numletts = scalar(keys(%lettdig));
4406: my $num = 0;
4407: while (my $line=<$fh>) {
4408: $num ++;
4409: next if (($num == 1) && ($csvoptions{'hdr'} == 1));
4410: $line =~ s{[\r\n]+$}{};
4411: my %found;
4412: my @values = split(/,/,$line);
4413: my ($qstart,$record);
4414: for (my $i=0; $i<@values; $i++) {
4415: if ((($qstart ne '') && ($i > $qstart)) ||
4416: ($csvbynum{$i} eq 'FirstQuestion')) {
4417: if ($values[$i] eq '') {
4418: $values[$i] = $scantronconf{'Qoff'};
4419: } elsif ($scantronconf{'Qon'} eq 'number') {
4420: if ($values[$i] =~ /^[A-Ja-j]$/) {
4421: $values[$i] = $lettdig{uc($values[$i])};
4422: }
4423: } elsif ($scantronconf{'Qon'} eq 'letter') {
4424: if ($values[$i] =~ /^[0-9]$/) {
4425: $values[$i] = $diglett{$values[$i]};
4426: }
4427: } else {
4428: if ($values[$i] =~ /^[0-9A-Ja-j]$/) {
4429: my $digit;
4430: if ($values[$i] =~ /^[A-Ja-j]$/) {
4431: $digit = $lettdig{uc($values[$i])}-1;
4432: if ($values[$i] eq 'J') {
4433: $digit += $numletts;
4434: }
4435: } elsif ($values[$i] =~ /^[0-9]$/) {
4436: $digit = $values[$i]-1;
4437: if ($values[$i] eq '0') {
4438: $digit += $numletts;
4439: }
4440: }
4441: my $qval='';
4442: for (my $j=0; $j<$scantronconf{'Qlength'}; $j++) {
4443: if ($j == $digit) {
4444: $qval .= $scantronconf{'Qon'};
4445: } else {
4446: $qval .= $scantronconf{'Qoff'};
4447: }
4448: }
4449: $values[$i] = $qval;
4450: }
4451: }
4452: if (length($values[$i]) > $scantronconf{'Qlength'}) {
4453: $values[$i] = substr($values[$i],0,$scantronconf{'Qlength'});
4454: }
4455: my $numblank = $scantronconf{'Qlength'} - length($values[$i]);
4456: if ($numblank > 0) {
4457: $values[$i] .= ($scantronconf{'Qoff'} x $numblank);
4458: }
4459: if ($csvbynum{$i} eq 'FirstQuestion') {
4460: $qstart = $i;
4461: $found{$csvbynum{$i}} = $values[$i];
4462: } else {
4463: $found{'FirstQuestion'} .= $values[$i];
4464: }
4465: } elsif (exists($csvbynum{$i})) {
4466: if ($csvoptions{'rem'}) {
4467: $values[$i] =~ s/^\s+//;
4468: }
4469: if (($csvbynum{$i} eq 'PaperID') && ($csvoptions{'pad'})) {
4470: while (length($values[$i]) < $scantronconf{$maplength{$csvbynum{$i}}}) {
4471: $values[$i] = '0'.$values[$i];
4472: }
4473: }
4474: $found{$csvbynum{$i}} = $values[$i];
4475: }
4476: }
4477: foreach my $item (@ordered) {
4478: my $currlength = 1+length($record);
4479: my $numspaces = $scantronconf{$item} - $currlength;
4480: if ($numspaces > 0) {
4481: $record .= (' ' x $numspaces);
4482: }
4483: if (($mapstart{$item} ne '') && (exists($found{$mapstart{$item}}))) {
4484: unless ($item eq 'Qstart') {
4485: if (length($found{$mapstart{$item}}) > $scantronconf{$maplength{$item}}) {
4486: $found{$mapstart{$item}} = substr($found{$mapstart{$item}},0,$scantronconf{$maplength{$item}});
4487: }
4488: }
4489: $record .= $found{$mapstart{$item}};
4490: }
4491: }
4492: $output .= "$record\n";
4493: }
4494: close($fh);
4495: if ($output) {
4496: if (open(my $fh,'>',$fullpath)) {
4497: print $fh $output;
4498: close($fh);
4499: }
4500: }
4501: }
4502: }
4503: return;
4504: }
4505: }
4506:
4507: sub letter_to_digits {
4508: my %lettdig = (
4509: A => 1,
4510: B => 2,
4511: C => 3,
4512: D => 4,
4513: E => 5,
4514: F => 6,
4515: G => 7,
4516: H => 8,
4517: I => 9,
4518: J => 0,
4519: );
4520: return %lettdig;
4521: }
4522:
4523: sub get_scantron_config {
4524: my ($which,$cdom) = @_;
4525: my @lines = &get_scantronformat_file($cdom);
4526: my %config;
4527: #FIXME probably should move to XML it has already gotten a bit much now
4528: foreach my $line (@lines) {
4529: my ($name,$descrip)=split(/:/,$line);
4530: if ($name ne $which ) { next; }
4531: chomp($line);
4532: my @config=split(/:/,$line);
4533: $config{'name'}=$config[0];
4534: $config{'description'}=$config[1];
4535: $config{'CODElocation'}=$config[2];
4536: $config{'CODEstart'}=$config[3];
4537: $config{'CODElength'}=$config[4];
4538: $config{'IDstart'}=$config[5];
4539: $config{'IDlength'}=$config[6];
4540: $config{'Qstart'}=$config[7];
4541: $config{'Qlength'}=$config[8];
4542: $config{'Qoff'}=$config[9];
4543: $config{'Qon'}=$config[10];
4544: $config{'PaperID'}=$config[11];
4545: $config{'PaperIDlength'}=$config[12];
4546: $config{'FirstName'}=$config[13];
4547: $config{'FirstNamelength'}=$config[14];
4548: $config{'LastName'}=$config[15];
4549: $config{'LastNamelength'}=$config[16];
4550: $config{'BubblesPerRow'}=$config[17];
4551: last;
4552: }
4553: return %config;
4554: }
4555:
4556: sub get_scantronformat_file {
4557: my ($cdom) = @_;
4558: if ($cdom eq '') {
4559: $cdom= $env{'course.'.$env{'request.course.id'}.'.domain'};
4560: }
4561: my %domconfig = &get_dom('configuration',['scantron'],$cdom);
4562: my $gottab = 0;
4563: my @lines;
4564: if (ref($domconfig{'scantron'}) eq 'HASH') {
4565: if ($domconfig{'scantron'}{'scantronformat'} ne '') {
4566: my $formatfile = &getfile($perlvar{'lonDocRoot'}.$domconfig{'scantron'}{'scantronformat'});
4567: if ($formatfile ne '-1') {
4568: @lines = split("\n",$formatfile,-1);
4569: $gottab = 1;
4570: }
4571: }
4572: }
4573: if (!$gottab) {
4574: my $confname = $cdom.'-domainconfig';
4575: my $default = $perlvar{'lonDocRoot'}.'/res/'.$cdom.'/'.$confname.'/default.tab';
4576: my $formatfile = &getfile($default);
4577: if ($formatfile ne '-1') {
4578: @lines = split("\n",$formatfile,-1);
4579: $gottab = 1;
4580: }
4581: }
4582: if (!$gottab) {
4583: my @domains = ¤t_machine_domains();
4584: if (grep(/^\Q$cdom\E$/,@domains)) {
4585: if (open(my $fh,'<',$perlvar{'lonTabDir'}.'/scantronformat.tab')) {
4586: @lines = <$fh>;
4587: close($fh);
4588: }
4589: } else {
4590: if (open(my $fh,'<',$perlvar{'lonTabDir'}.'/default_scantronformat.tab')) {
4591: @lines = <$fh>;
4592: close($fh);
4593: }
4594: }
4595: }
4596: return @lines;
4597: }
4598:
4599: sub removeuploadedurl {
4600: my ($url)=@_;
4601: my (undef,undef,$udom,$uname,$fname)=split('/',$url,5);
4602: return &removeuserfile($uname,$udom,$fname);
4603: }
4604:
4605: sub removeuserfile {
4606: my ($docuname,$docudom,$fname)=@_;
4607: my $home=&homeserver($docuname,$docudom);
4608: my $result = &reply("removeuserfile:$docudom/$docuname/$fname",$home);
4609: if ($result eq 'ok') {
4610: if (($fname !~ /\.meta$/) && (&is_portfolio_file($fname))) {
4611: my $metafile = $fname.'.meta';
4612: my $metaresult = &removeuserfile($docuname,$docudom,$metafile);
4613: my $url = "/uploaded/$docudom/$docuname/$fname";
4614: my ($file,$group) = (&parse_portfolio_url($url))[3,4];
4615: my $sqlresult =
4616: &update_portfolio_table($docuname,$docudom,$file,
4617: 'portfolio_metadata',$group,
4618: 'delete');
4619: }
4620: }
4621: return $result;
4622: }
4623:
4624: sub mkdiruserfile {
4625: my ($docuname,$docudom,$dir)=@_;
4626: my $home=&homeserver($docuname,$docudom);
4627: return &reply("mkdiruserfile:".&escape("$docudom/$docuname/$dir"),$home);
4628: }
4629:
4630: sub renameuserfile {
4631: my ($docuname,$docudom,$old,$new)=@_;
4632: my $home=&homeserver($docuname,$docudom);
4633: my $result = &reply("renameuserfile:$docudom:$docuname:".
4634: &escape("$old").':'.&escape("$new"),$home);
4635: if ($result eq 'ok') {
4636: if (($old !~ /\.meta$/) && (&is_portfolio_file($old))) {
4637: my $oldmeta = $old.'.meta';
4638: my $newmeta = $new.'.meta';
4639: my $metaresult =
4640: &renameuserfile($docuname,$docudom,$oldmeta,$newmeta);
4641: my $url = "/uploaded/$docudom/$docuname/$old";
4642: my ($file,$group) = (&parse_portfolio_url($url))[3,4];
4643: my $sqlresult =
4644: &update_portfolio_table($docuname,$docudom,$file,
4645: 'portfolio_metadata',$group,
4646: 'delete');
4647: }
4648: }
4649: return $result;
4650: }
4651:
4652: # ------------------------------------------------------------------------- Log
4653:
4654: sub log {
4655: my ($dom,$nam,$hom,$what)=@_;
4656: return critical("log:$dom:$nam:$what",$hom);
4657: }
4658:
4659: # ------------------------------------------------------------------ Course Log
4660: #
4661: # This routine flushes several buffers of non-mission-critical nature
4662: #
4663:
4664: sub flushcourselogs {
4665: &logthis('Flushing log buffers');
4666: #
4667: # course logs
4668: # This is a log of all transactions in a course, which can be used
4669: # for data mining purposes
4670: #
4671: # It also collects the courseid database, which lists last transaction
4672: # times and course titles for all courseids
4673: #
4674: my %courseidbuffer=();
4675: foreach my $crsid (keys(%courselogs)) {
4676: if (&reply('log:'.$coursedombuf{$crsid}.':'.$coursenumbuf{$crsid}.':'.
4677: &escape($courselogs{$crsid}),
4678: $coursehombuf{$crsid}) eq 'ok') {
4679: delete $courselogs{$crsid};
4680: } else {
4681: &logthis('Failed to flush log buffer for '.$crsid);
4682: if (length($courselogs{$crsid})>40000) {
4683: &logthis("<font color=\"blue\">WARNING: Buffer for ".$crsid.
4684: " exceeded maximum size, deleting.</font>");
4685: delete $courselogs{$crsid};
4686: }
4687: }
4688: $courseidbuffer{$coursehombuf{$crsid}}{$crsid} = {
4689: 'description' => $coursedescrbuf{$crsid},
4690: 'inst_code' => $courseinstcodebuf{$crsid},
4691: 'type' => $coursetypebuf{$crsid},
4692: 'owner' => $courseownerbuf{$crsid},
4693: };
4694: }
4695: #
4696: # Write course id database (reverse lookup) to homeserver of courses
4697: # Is used in pickcourse
4698: #
4699: foreach my $crs_home (keys(%courseidbuffer)) {
4700: my $response = &courseidput(&host_domain($crs_home),
4701: $courseidbuffer{$crs_home},
4702: $crs_home,'timeonly');
4703: }
4704: #
4705: # File accesses
4706: # Writes to the dynamic metadata of resources to get hit counts, etc.
4707: #
4708: foreach my $entry (keys(%accesshash)) {
4709: if ($entry =~ /___count$/) {
4710: my ($dom,$name);
4711: ($dom,$name,undef)=
4712: ($entry=~m{___($match_domain)/($match_name)/(.*)___count$});
4713: if (! defined($dom) || $dom eq '' ||
4714: ! defined($name) || $name eq '') {
4715: my $cid = $env{'request.course.id'};
4716: $dom = $env{'request.'.$cid.'.domain'};
4717: $name = $env{'request.'.$cid.'.num'};
4718: }
4719: my $value = $accesshash{$entry};
4720: my (undef,$url,undef) = ($entry =~ /^(.*)___(.*)___count$/);
4721: my %temphash=($url => $value);
4722: my $result = &inc('nohist_accesscount',\%temphash,$dom,$name);
4723: if ($result eq 'ok') {
4724: delete $accesshash{$entry};
4725: }
4726: } else {
4727: my ($dom,$name) = ($entry=~m{___($match_domain)/($match_name)/(.*)___(\w+)$});
4728: if (($dom eq 'uploaded') || ($dom eq 'adm')) { next; }
4729: my %temphash=($entry => $accesshash{$entry});
4730: if (&put('nohist_resevaldata',\%temphash,$dom,$name) eq 'ok') {
4731: delete $accesshash{$entry};
4732: }
4733: }
4734: }
4735: #
4736: # Roles
4737: # Reverse lookup of user roles for course faculty/staff and co-authorship
4738: #
4739: foreach my $entry (keys(%userrolehash)) {
4740: my ($role,$uname,$udom,$runame,$rudom,$rsec)=
4741: split(/\:/,$entry);
4742: if (&Apache::lonnet::put('nohist_userroles',
4743: { $role.':'.$uname.':'.$udom.':'.$rsec => $userrolehash{$entry} },
4744: $rudom,$runame) eq 'ok') {
4745: delete $userrolehash{$entry};
4746: }
4747: }
4748: #
4749: # Reverse lookup of domain roles (dc, ad, li, sc, dh, da, au)
4750: #
4751: my %domrolebuffer = ();
4752: foreach my $entry (keys(%domainrolehash)) {
4753: my ($role,$uname,$udom,$runame,$rudom,$rsec)=split(/:/,$entry);
4754: if ($domrolebuffer{$rudom}) {
4755: $domrolebuffer{$rudom}.='&'.&escape($entry).
4756: '='.&escape($domainrolehash{$entry});
4757: } else {
4758: $domrolebuffer{$rudom}.=&escape($entry).
4759: '='.&escape($domainrolehash{$entry});
4760: }
4761: delete $domainrolehash{$entry};
4762: }
4763: foreach my $dom (keys(%domrolebuffer)) {
4764: my %servers;
4765: if (defined(&domain($dom,'primary'))) {
4766: my $primary=&domain($dom,'primary');
4767: my $hostname=&hostname($primary);
4768: $servers{$primary} = $hostname;
4769: } else {
4770: %servers = &get_servers($dom,'library');
4771: }
4772: foreach my $tryserver (keys(%servers)) {
4773: if (&reply('domroleput:'.$dom.':'.
4774: $domrolebuffer{$dom},$tryserver) eq 'ok') {
4775: last;
4776: } else {
4777: &logthis('Put of domain roles failed for '.$dom.' and '.$tryserver);
4778: }
4779: }
4780: }
4781: $dumpcount++;
4782: }
4783:
4784: sub courselog {
4785: my $what=shift;
4786: $what=time.':'.$what;
4787: unless ($env{'request.course.id'}) { return ''; }
4788: $coursedombuf{$env{'request.course.id'}}=
4789: $env{'course.'.$env{'request.course.id'}.'.domain'};
4790: $coursenumbuf{$env{'request.course.id'}}=
4791: $env{'course.'.$env{'request.course.id'}.'.num'};
4792: $coursehombuf{$env{'request.course.id'}}=
4793: $env{'course.'.$env{'request.course.id'}.'.home'};
4794: $coursedescrbuf{$env{'request.course.id'}}=
4795: $env{'course.'.$env{'request.course.id'}.'.description'};
4796: $courseinstcodebuf{$env{'request.course.id'}}=
4797: $env{'course.'.$env{'request.course.id'}.'.internal.coursecode'};
4798: $courseownerbuf{$env{'request.course.id'}}=
4799: $env{'course.'.$env{'request.course.id'}.'.internal.courseowner'};
4800: $coursetypebuf{$env{'request.course.id'}}=
4801: $env{'course.'.$env{'request.course.id'}.'.type'};
4802: if (defined $courselogs{$env{'request.course.id'}}) {
4803: $courselogs{$env{'request.course.id'}}.='&'.$what;
4804: } else {
4805: $courselogs{$env{'request.course.id'}}.=$what;
4806: }
4807: if (length($courselogs{$env{'request.course.id'}})>4048) {
4808: &flushcourselogs();
4809: }
4810: }
4811:
4812: sub courseacclog {
4813: my $fnsymb=shift;
4814: unless ($env{'request.course.id'}) { return ''; }
4815: my $what=$fnsymb.':'.$env{'user.name'}.':'.$env{'user.domain'};
4816: if ($fnsymb=~/$LONCAPA::assess_re/) {
4817: $what.=':POST';
4818: # FIXME: Probably ought to escape things....
4819: foreach my $key (keys(%env)) {
4820: if ($key=~/^form\.(.*)/) {
4821: my $formitem = $1;
4822: if ($formitem =~ /^HWFILE(?:SIZE|TOOBIG)/) {
4823: $what.=':'.$formitem.'='.$env{$key};
4824: } elsif ($formitem !~ /^HWFILE(?:[^.]+)$/) {
4825: $what.=':'.$formitem.'='.$env{$key};
4826: }
4827: }
4828: }
4829: } elsif ($fnsymb =~ m:^/adm/searchcat:) {
4830: # FIXME: We should not be depending on a form parameter that someone
4831: # editing lonsearchcat.pm might change in the future.
4832: if ($env{'form.phase'} eq 'course_search') {
4833: $what.= ':POST';
4834: # FIXME: Probably ought to escape things....
4835: foreach my $element ('courseexp','crsfulltext','crsrelated',
4836: 'crsdiscuss') {
4837: $what.=':'.$element.'='.$env{'form.'.$element};
4838: }
4839: }
4840: }
4841: &courselog($what);
4842: }
4843:
4844: sub countacc {
4845: my $url=&declutter(shift);
4846: return if (! defined($url) || $url eq '');
4847: unless ($env{'request.course.id'}) { return ''; }
4848: #
4849: # Mark that this url was used in this course
4850: #
4851: $accesshash{$env{'request.course.id'}.'___'.$url.'___course'}=1;
4852: #
4853: # Increase the access count for this resource in this child process
4854: #
4855: my $key=$$.$processmarker.'_'.$dumpcount.'___'.$url.'___count';
4856: $accesshash{$key}++;
4857: }
4858:
4859: sub linklog {
4860: my ($from,$to)=@_;
4861: $from=&declutter($from);
4862: $to=&declutter($to);
4863: $accesshash{$from.'___'.$to.'___comefrom'}=1;
4864: $accesshash{$to.'___'.$from.'___goto'}=1;
4865: }
4866:
4867: sub statslog {
4868: my ($symb,$part,$users,$av_attempts,$degdiff)=@_;
4869: if ($users<2) { return; }
4870: my %dynstore=&LONCAPA::lonmetadata::dynamic_metadata_storage({
4871: 'course' => $env{'request.course.id'},
4872: 'sections' => '"all"',
4873: 'num_students' => $users,
4874: 'part' => $part,
4875: 'symb' => $symb,
4876: 'mean_tries' => $av_attempts,
4877: 'deg_of_diff' => $degdiff});
4878: foreach my $key (keys(%dynstore)) {
4879: $accesshash{$key}=$dynstore{$key};
4880: }
4881: }
4882:
4883: sub userrolelog {
4884: my ($trole,$username,$domain,$area,$tstart,$tend)=@_;
4885: if ( $trole =~ /^(ca|aa|in|cc|ep|cr|ta|co)/ ) {
4886: my (undef,$rudom,$runame,$rsec)=split(/\//,$area);
4887: $userrolehash
4888: {$trole.':'.$username.':'.$domain.':'.$runame.':'.$rudom.':'.$rsec}
4889: =$tend.':'.$tstart;
4890: }
4891: if ($env{'request.role'} =~ /dc\./ && $trole =~ /^(au|in|cc|ep|cr|ta|co)/) {
4892: $userrolehash
4893: {$trole.':'.$username.':'.$domain.':'.$env{'user.name'}.':'.$env{'user.domain'}.':'}
4894: =$tend.':'.$tstart;
4895: }
4896: if ($trole =~ /^(dc|ad|li|au|dg|sc|dh|da)/ ) {
4897: my (undef,$rudom,$runame,$rsec)=split(/\//,$area);
4898: $domainrolehash
4899: {$trole.':'.$username.':'.$domain.':'.$runame.':'.$rudom.':'.$rsec}
4900: = $tend.':'.$tstart;
4901: }
4902: }
4903:
4904: sub courserolelog {
4905: my ($trole,$username,$domain,$area,$tstart,$tend,$delflag,$selfenroll,$context)=@_;
4906: if ($area =~ m-^/($match_domain)/($match_courseid)/?([^/]*)-) {
4907: my $cdom = $1;
4908: my $cnum = $2;
4909: my $sec = $3;
4910: my $namespace = 'rolelog';
4911: my %storehash = (
4912: role => $trole,
4913: start => $tstart,
4914: end => $tend,
4915: selfenroll => $selfenroll,
4916: context => $context,
4917: );
4918: if ($trole eq 'gr') {
4919: $namespace = 'groupslog';
4920: $storehash{'group'} = $sec;
4921: } else {
4922: $storehash{'section'} = $sec;
4923: }
4924: &write_log('course',$namespace,\%storehash,$delflag,$username,
4925: $domain,$cnum,$cdom);
4926: if (($trole ne 'st') || ($sec ne '')) {
4927: &devalidate_cache_new('getcourseroles',$cdom.'_'.$cnum);
4928: }
4929: }
4930: return;
4931: }
4932:
4933: sub domainrolelog {
4934: my ($trole,$username,$domain,$area,$tstart,$tend,$delflag,$context)=@_;
4935: if ($area =~ m{^/($match_domain)/$}) {
4936: my $cdom = $1;
4937: my $domconfiguser = &Apache::lonnet::get_domainconfiguser($cdom);
4938: my $namespace = 'rolelog';
4939: my %storehash = (
4940: role => $trole,
4941: start => $tstart,
4942: end => $tend,
4943: context => $context,
4944: );
4945: &write_log('domain',$namespace,\%storehash,$delflag,$username,
4946: $domain,$domconfiguser,$cdom);
4947: }
4948: return;
4949:
4950: }
4951:
4952: sub coauthorrolelog {
4953: my ($trole,$username,$domain,$area,$tstart,$tend,$delflag,$context)=@_;
4954: if ($area =~ m{^/($match_domain)/($match_username)$}) {
4955: my $audom = $1;
4956: my $auname = $2;
4957: my $namespace = 'rolelog';
4958: my %storehash = (
4959: role => $trole,
4960: start => $tstart,
4961: end => $tend,
4962: context => $context,
4963: );
4964: &write_log('author',$namespace,\%storehash,$delflag,$username,
4965: $domain,$auname,$audom);
4966: }
4967: return;
4968: }
4969:
4970: sub get_course_adv_roles {
4971: my ($cid,$codes) = @_;
4972: $cid=$env{'request.course.id'} unless (defined($cid));
4973: my %coursehash=&coursedescription($cid);
4974: my $crstype = &Apache::loncommon::course_type($cid);
4975: my %nothide=();
4976: foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
4977: if ($user !~ /:/) {
4978: $nothide{join(':',split(/[\@]/,$user))}=1;
4979: } else {
4980: $nothide{$user}=1;
4981: }
4982: }
4983: my @possdoms = ($coursehash{'domain'});
4984: if ($coursehash{'checkforpriv'}) {
4985: push(@possdoms,split(/,/,$coursehash{'checkforpriv'}));
4986: }
4987: my %returnhash=();
4988: my %dumphash=
4989: &dump('nohist_userroles',$coursehash{'domain'},$coursehash{'num'});
4990: my $now=time;
4991: my %privileged;
4992: foreach my $entry (keys(%dumphash)) {
4993: my ($tend,$tstart)=split(/\:/,$dumphash{$entry});
4994: if (($tstart) && ($tstart<0)) { next; }
4995: if (($tend) && ($tend<$now)) { next; }
4996: if (($tstart) && ($now<$tstart)) { next; }
4997: my ($role,$username,$domain,$section)=split(/\:/,$entry);
4998: if ($username eq '' || $domain eq '') { next; }
4999: if ((&privileged($username,$domain,\@possdoms)) &&
5000: (!$nothide{$username.':'.$domain})) { next; }
5001: if ($role eq 'cr') { next; }
5002: if ($codes) {
5003: if ($section) { $role .= ':'.$section; }
5004: if ($returnhash{$role}) {
5005: $returnhash{$role}.=','.$username.':'.$domain;
5006: } else {
5007: $returnhash{$role}=$username.':'.$domain;
5008: }
5009: } else {
5010: my $key=&plaintext($role,$crstype);
5011: if ($section) { $key.=' ('.&Apache::lonlocal::mt('Section [_1]',$section).')'; }
5012: if ($returnhash{$key}) {
5013: $returnhash{$key}.=','.$username.':'.$domain;
5014: } else {
5015: $returnhash{$key}=$username.':'.$domain;
5016: }
5017: }
5018: }
5019: return %returnhash;
5020: }
5021:
5022: sub get_my_roles {
5023: my ($uname,$udom,$context,$types,$roles,$roledoms,$withsec,$hidepriv)=@_;
5024: unless (defined($uname)) { $uname=$env{'user.name'}; }
5025: unless (defined($udom)) { $udom=$env{'user.domain'}; }
5026: my (%dumphash,%nothide);
5027: if ($context eq 'userroles') {
5028: %dumphash = &dump('roles',$udom,$uname);
5029: } else {
5030: %dumphash = &dump('nohist_userroles',$udom,$uname);
5031: if ($hidepriv) {
5032: my %coursehash=&coursedescription($udom.'_'.$uname);
5033: foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
5034: if ($user !~ /:/) {
5035: $nothide{join(':',split(/[\@]/,$user))} = 1;
5036: } else {
5037: $nothide{$user} = 1;
5038: }
5039: }
5040: }
5041: }
5042: my %returnhash=();
5043: my $now=time;
5044: my %privileged;
5045: foreach my $entry (keys(%dumphash)) {
5046: my ($role,$tend,$tstart);
5047: if ($context eq 'userroles') {
5048: next if ($entry =~ /^rolesdef/);
5049: ($role,$tend,$tstart)=split(/_/,$dumphash{$entry});
5050: } else {
5051: ($tend,$tstart)=split(/\:/,$dumphash{$entry});
5052: }
5053: if (($tstart) && ($tstart<0)) { next; }
5054: my $status = 'active';
5055: if (($tend) && ($tend<=$now)) {
5056: $status = 'previous';
5057: }
5058: if (($tstart) && ($now<$tstart)) {
5059: $status = 'future';
5060: }
5061: if (ref($types) eq 'ARRAY') {
5062: if (!grep(/^\Q$status\E$/,@{$types})) {
5063: next;
5064: }
5065: } else {
5066: if ($status ne 'active') {
5067: next;
5068: }
5069: }
5070: my ($rolecode,$username,$domain,$section,$area);
5071: if ($context eq 'userroles') {
5072: ($area,$rolecode) = ($entry =~ /^(.+)_([^_]+)$/);
5073: (undef,$domain,$username,$section) = split(/\//,$area);
5074: } else {
5075: ($role,$username,$domain,$section) = split(/\:/,$entry);
5076: }
5077: if (ref($roledoms) eq 'ARRAY') {
5078: if (!grep(/^\Q$domain\E$/,@{$roledoms})) {
5079: next;
5080: }
5081: }
5082: if (ref($roles) eq 'ARRAY') {
5083: if (!grep(/^\Q$role\E$/,@{$roles})) {
5084: if ($role =~ /^cr\//) {
5085: if (!grep(/^cr$/,@{$roles})) {
5086: next;
5087: }
5088: } elsif ($role =~ /^gr\//) {
5089: if (!grep(/^gr$/,@{$roles})) {
5090: next;
5091: }
5092: } else {
5093: next;
5094: }
5095: }
5096: }
5097: if ($hidepriv) {
5098: my @privroles = ('dc','su');
5099: if ($context eq 'userroles') {
5100: next if (grep(/^\Q$role\E$/,@privroles));
5101: } else {
5102: my $possdoms = [$domain];
5103: if (ref($roledoms) eq 'ARRAY') {
5104: push(@{$possdoms},@{$roledoms});
5105: }
5106: if (&privileged($username,$domain,$possdoms,\@privroles)) {
5107: if (!$nothide{$username.':'.$domain}) {
5108: next;
5109: }
5110: }
5111: }
5112: }
5113: if ($withsec) {
5114: $returnhash{$username.':'.$domain.':'.$role.':'.$section} =
5115: $tstart.':'.$tend;
5116: } else {
5117: $returnhash{$username.':'.$domain.':'.$role}=$tstart.':'.$tend;
5118: }
5119: }
5120: return %returnhash;
5121: }
5122:
5123: sub get_all_adhocroles {
5124: my ($dom) = @_;
5125: my @roles_by_num = ();
5126: my %domdefaults = &get_domain_defaults($dom);
5127: my (%description,%access_in_dom,%access_info);
5128: if (ref($domdefaults{'adhocroles'}) eq 'HASH') {
5129: my $count = 0;
5130: my %domcurrent = %{$domdefaults{'adhocroles'}};
5131: my %ordered;
5132: foreach my $role (sort(keys(%domcurrent))) {
5133: my ($order,$desc,$access_in_dom);
5134: if (ref($domcurrent{$role}) eq 'HASH') {
5135: $order = $domcurrent{$role}{'order'};
5136: $desc = $domcurrent{$role}{'desc'};
5137: $access_in_dom{$role} = $domcurrent{$role}{'access'};
5138: $access_info{$role} = $domcurrent{$role}{$access_in_dom{$role}};
5139: }
5140: if ($order eq '') {
5141: $order = $count;
5142: }
5143: $ordered{$order} = $role;
5144: if ($desc ne '') {
5145: $description{$role} = $desc;
5146: } else {
5147: $description{$role}= $role;
5148: }
5149: $count++;
5150: }
5151: foreach my $item (sort {$a <=> $b } (keys(%ordered))) {
5152: push(@roles_by_num,$ordered{$item});
5153: }
5154: }
5155: return (\@roles_by_num,\%description,\%access_in_dom,\%access_info);
5156: }
5157:
5158: sub get_my_adhocroles {
5159: my ($cid,$checkreg) = @_;
5160: my ($cdom,$cnum,%info,@possroles,$description,$roles_by_num);
5161: if ($env{'request.course.id'} eq $cid) {
5162: $cdom = $env{'course.'.$cid.'.domain'};
5163: $cnum = $env{'course.'.$cid.'.num'};
5164: $info{'internal.coursecode'} = $env{'course.'.$cid.'.internal.coursecode'};
5165: } elsif ($cid =~ /^($match_domain)_($match_courseid)$/) {
5166: $cdom = $1;
5167: $cnum = $2;
5168: %info = &Apache::lonnet::get('environment',['internal.coursecode'],
5169: $cdom,$cnum);
5170: }
5171: if (($info{'internal.coursecode'} ne '') && ($checkreg)) {
5172: my $user = $env{'user.name'}.':'.$env{'user.domain'};
5173: my %rosterhash = &get('classlist',[$user],$cdom,$cnum);
5174: if ($rosterhash{$user} ne '') {
5175: my $type = (split(/:/,$rosterhash{$user}))[5];
5176: return ([],{}) if ($type eq 'auto');
5177: }
5178: }
5179: if (($cdom ne '') && ($cnum ne '')) {
5180: if (($env{"user.role.dh./$cdom/"}) || ($env{"user.role.da./$cdom/"})) {
5181: my $then=$env{'user.login.time'};
5182: my $update=$env{'user.update.time'};
5183: if (!$update) {
5184: $update = $then;
5185: }
5186: my @liveroles;
5187: foreach my $role ('dh','da') {
5188: if ($env{"user.role.$role./$cdom/"}) {
5189: my ($tstart,$tend)=split(/\./,$env{"user.role.$role./$cdom/"});
5190: my $limit = $update;
5191: if ($env{'request.role'} eq "$role./$cdom/") {
5192: $limit = $then;
5193: }
5194: my $activerole = 1;
5195: if ($tstart && $tstart>$limit) { $activerole = 0; }
5196: if ($tend && $tend <$limit) { $activerole = 0; }
5197: if ($activerole) {
5198: push(@liveroles,$role);
5199: }
5200: }
5201: }
5202: if (@liveroles) {
5203: if (&homeserver($cnum,$cdom) ne 'no_host') {
5204: my ($accessref,$accessinfo,%access_in_dom);
5205: ($roles_by_num,$description,$accessref,$accessinfo) = &get_all_adhocroles($cdom);
5206: if (ref($roles_by_num) eq 'ARRAY') {
5207: if (@{$roles_by_num}) {
5208: my %settings;
5209: if ($env{'request.course.id'} eq $cid) {
5210: foreach my $envkey (keys(%env)) {
5211: if ($envkey =~ /^\Qcourse.$cid.\E(internal\.adhoc.+)$/) {
5212: $settings{$1} = $env{$envkey};
5213: }
5214: }
5215: } else {
5216: %settings = &dump('environment',$cdom,$cnum,'internal\.adhoc');
5217: }
5218: my %setincrs;
5219: if ($settings{'internal.adhocaccess'}) {
5220: map { $setincrs{$_} = 1; } split(/,/,$settings{'internal.adhocaccess'});
5221: }
5222: my @statuses;
5223: if ($env{'environment.inststatus'}) {
5224: @statuses = split(/,/,$env{'environment.inststatus'});
5225: }
5226: my $user = $env{'user.name'}.':'.$env{'user.domain'};
5227: if (ref($accessref) eq 'HASH') {
5228: %access_in_dom = %{$accessref};
5229: }
5230: foreach my $role (@{$roles_by_num}) {
5231: my ($curraccess,@okstatus,@personnel);
5232: if ($setincrs{$role}) {
5233: ($curraccess,my $rest) = split(/=/,$settings{'internal.adhoc.'.$role});
5234: if ($curraccess eq 'status') {
5235: @okstatus = split(/\&/,$rest);
5236: } elsif (($curraccess eq 'exc') || ($curraccess eq 'inc')) {
5237: @personnel = split(/\&/,$rest);
5238: }
5239: } else {
5240: $curraccess = $access_in_dom{$role};
5241: if (ref($accessinfo) eq 'HASH') {
5242: if ($curraccess eq 'status') {
5243: if (ref($accessinfo->{$role}) eq 'ARRAY') {
5244: @okstatus = @{$accessinfo->{$role}};
5245: }
5246: } elsif (($curraccess eq 'exc') || ($curraccess eq 'inc')) {
5247: if (ref($accessinfo->{$role}) eq 'ARRAY') {
5248: @personnel = @{$accessinfo->{$role}};
5249: }
5250: }
5251: }
5252: }
5253: if ($curraccess eq 'none') {
5254: next;
5255: } elsif ($curraccess eq 'all') {
5256: push(@possroles,$role);
5257: } elsif ($curraccess eq 'dh') {
5258: if (grep(/^dh$/,@liveroles)) {
5259: push(@possroles,$role);
5260: } else {
5261: next;
5262: }
5263: } elsif ($curraccess eq 'da') {
5264: if (grep(/^da$/,@liveroles)) {
5265: push(@possroles,$role);
5266: } else {
5267: next;
5268: }
5269: } elsif ($curraccess eq 'status') {
5270: if (@okstatus) {
5271: if (!@statuses) {
5272: if (grep(/^default$/,@okstatus)) {
5273: push(@possroles,$role);
5274: }
5275: } else {
5276: foreach my $status (@okstatus) {
5277: if (grep(/^\Q$status\E$/,@statuses)) {
5278: push(@possroles,$role);
5279: last;
5280: }
5281: }
5282: }
5283: }
5284: } elsif (($curraccess eq 'exc') || ($curraccess eq 'inc')) {
5285: if (grep(/^\Q$user\E$/,@personnel)) {
5286: if ($curraccess eq 'exc') {
5287: push(@possroles,$role);
5288: }
5289: } elsif ($curraccess eq 'inc') {
5290: push(@possroles,$role);
5291: }
5292: }
5293: }
5294: }
5295: }
5296: }
5297: }
5298: }
5299: }
5300: unless (ref($description) eq 'HASH') {
5301: if (ref($roles_by_num) eq 'ARRAY') {
5302: my %desc;
5303: map { $desc{$_} = $_; } (@{$roles_by_num});
5304: $description = \%desc;
5305: } else {
5306: $description = {};
5307: }
5308: }
5309: return (\@possroles,$description);
5310: }
5311:
5312: # ----------------------------------------------------- Frontpage Announcements
5313: #
5314: #
5315:
5316: sub postannounce {
5317: my ($server,$text)=@_;
5318: unless (&allowed('psa',&host_domain($server))) { return 'refused'; }
5319: unless ($text=~/\w/) { $text=''; }
5320: return &reply('setannounce:'.&escape($text),$server);
5321: }
5322:
5323: sub getannounce {
5324:
5325: if (open(my $fh,"<",$perlvar{'lonDocRoot'}.'/announcement.txt')) {
5326: my $announcement='';
5327: while (my $line = <$fh>) { $announcement .= $line; }
5328: close($fh);
5329: if ($announcement=~/\w/) {
5330: return
5331: '<table bgcolor="#FF5555" cellpadding="5" cellspacing="3">'.
5332: '<tr><td bgcolor="#FFFFFF"><tt>'.$announcement.'</tt></td></tr></table>';
5333: } else {
5334: return '';
5335: }
5336: } else {
5337: return '';
5338: }
5339: }
5340:
5341: # ---------------------------------------------------------- Course ID routines
5342: # Deal with domain's nohist_courseid.db files
5343: #
5344:
5345: sub courseidput {
5346: my ($domain,$storehash,$coursehome,$caller) = @_;
5347: return unless (ref($storehash) eq 'HASH');
5348: my $outcome;
5349: if ($caller eq 'timeonly') {
5350: my $cids = '';
5351: foreach my $item (keys(%$storehash)) {
5352: $cids.=&escape($item).'&';
5353: }
5354: $cids=~s/\&$//;
5355: $outcome = &reply('courseidputhash:'.$domain.':'.$caller.':'.$cids,
5356: $coursehome);
5357: } else {
5358: my $items = '';
5359: foreach my $item (keys(%$storehash)) {
5360: $items.= &escape($item).'='.
5361: &freeze_escape($$storehash{$item}).'&';
5362: }
5363: $items=~s/\&$//;
5364: $outcome = &reply('courseidputhash:'.$domain.':'.$caller.':'.$items,
5365: $coursehome);
5366: }
5367: if ($outcome eq 'unknown_cmd') {
5368: my $what;
5369: foreach my $cid (keys(%$storehash)) {
5370: $what .= &escape($cid).'=';
5371: foreach my $item ('description','inst_code','owner','type') {
5372: $what .= &escape($storehash->{$cid}{$item}).':';
5373: }
5374: $what =~ s/\:$/&/;
5375: }
5376: $what =~ s/\&$//;
5377: return &reply('courseidput:'.$domain.':'.$what,$coursehome);
5378: } else {
5379: return $outcome;
5380: }
5381: }
5382:
5383: sub courseiddump {
5384: my ($domfilter,$descfilter,$sincefilter,$instcodefilter,$ownerfilter,
5385: $coursefilter,$hostidflag,$hostidref,$typefilter,$regexp_ok,
5386: $selfenrollonly,$catfilter,$showhidden,$caller,$cloner,$cc_clone,
5387: $cloneonly,$createdbefore,$createdafter,$creationcontext,$domcloner,
5388: $hasuniquecode,$reqcrsdom,$reqinstcode)=@_;
5389: my $as_hash = 1;
5390: my %returnhash;
5391: if (!$domfilter) { $domfilter=''; }
5392: my %libserv = &all_library();
5393: foreach my $tryserver (keys(%libserv)) {
5394: if ( ( $hostidflag == 1
5395: && grep(/^\Q$tryserver\E$/,@{$hostidref}) )
5396: || (!defined($hostidflag)) ) {
5397:
5398: if (($domfilter eq '') ||
5399: (&host_domain($tryserver) eq $domfilter)) {
5400: my $rep;
5401: if (grep { $_ eq $tryserver } current_machine_ids()) {
5402: $rep = LONCAPA::Lond::dump_course_id_handler(
5403: join(":", (&host_domain($tryserver), $sincefilter,
5404: &escape($descfilter), &escape($instcodefilter),
5405: &escape($ownerfilter), &escape($coursefilter),
5406: &escape($typefilter), &escape($regexp_ok),
5407: $as_hash, &escape($selfenrollonly),
5408: &escape($catfilter), $showhidden, $caller,
5409: &escape($cloner), &escape($cc_clone), $cloneonly,
5410: &escape($createdbefore), &escape($createdafter),
5411: &escape($creationcontext),$domcloner,$hasuniquecode,
5412: $reqcrsdom,&escape($reqinstcode))));
5413: } else {
5414: $rep = &reply('courseiddump:'.&host_domain($tryserver).':'.
5415: $sincefilter.':'.&escape($descfilter).':'.
5416: &escape($instcodefilter).':'.&escape($ownerfilter).
5417: ':'.&escape($coursefilter).':'.&escape($typefilter).
5418: ':'.&escape($regexp_ok).':'.$as_hash.':'.
5419: &escape($selfenrollonly).':'.&escape($catfilter).':'.
5420: $showhidden.':'.$caller.':'.&escape($cloner).':'.
5421: &escape($cc_clone).':'.$cloneonly.':'.
5422: &escape($createdbefore).':'.&escape($createdafter).':'.
5423: &escape($creationcontext).':'.$domcloner.':'.$hasuniquecode.
5424: ':'.$reqcrsdom.':'.&escape($reqinstcode),$tryserver);
5425: }
5426:
5427: my @pairs=split(/\&/,$rep);
5428: foreach my $item (@pairs) {
5429: my ($key,$value)=split(/\=/,$item,2);
5430: $key = &unescape($key);
5431: next if ($key =~ /^error: 2 /);
5432: my $result = &thaw_unescape($value);
5433: if (ref($result) eq 'HASH') {
5434: $returnhash{$key}=$result;
5435: } else {
5436: my @responses = split(/:/,$value);
5437: my @items = ('description','inst_code','owner','type');
5438: for (my $i=0; $i<@responses; $i++) {
5439: $returnhash{$key}{$items[$i]} = &unescape($responses[$i]);
5440: }
5441: }
5442: }
5443: }
5444: }
5445: }
5446: return %returnhash;
5447: }
5448:
5449: sub courselastaccess {
5450: my ($cdom,$cnum,$hostidref) = @_;
5451: my %returnhash;
5452: if ($cdom && $cnum) {
5453: my $chome = &homeserver($cnum,$cdom);
5454: if ($chome ne 'no_host') {
5455: my $rep = &reply('courselastaccess:'.$cdom.':'.$cnum,$chome);
5456: &extract_lastaccess(\%returnhash,$rep);
5457: }
5458: } else {
5459: if (!$cdom) { $cdom=''; }
5460: my %libserv = &all_library();
5461: foreach my $tryserver (keys(%libserv)) {
5462: if (ref($hostidref) eq 'ARRAY') {
5463: next unless (grep(/^\Q$tryserver\E$/,@{$hostidref}));
5464: }
5465: if (($cdom eq '') || (&host_domain($tryserver) eq $cdom)) {
5466: my $rep = &reply('courselastaccess:'.&host_domain($tryserver).':',$tryserver);
5467: &extract_lastaccess(\%returnhash,$rep);
5468: }
5469: }
5470: }
5471: return %returnhash;
5472: }
5473:
5474: sub extract_lastaccess {
5475: my ($returnhash,$rep) = @_;
5476: if (ref($returnhash) eq 'HASH') {
5477: unless ($rep eq 'unknown_command' || $rep eq 'no_such_host' ||
5478: $rep eq 'con_lost' || $rep eq 'rejected' || $rep eq 'refused' ||
5479: $rep eq '') {
5480: my @pairs=split(/\&/,$rep);
5481: foreach my $item (@pairs) {
5482: my ($key,$value)=split(/\=/,$item,2);
5483: $key = &unescape($key);
5484: next if ($key =~ /^error: 2 /);
5485: $returnhash->{$key} = &thaw_unescape($value);
5486: }
5487: }
5488: }
5489: return;
5490: }
5491:
5492: # ---------------------------------------------------------- DC e-mail
5493:
5494: sub dcmailput {
5495: my ($domain,$msgid,$message,$server)=@_;
5496: my $status = &Apache::lonnet::critical(
5497: 'dcmailput:'.$domain.':'.&escape($msgid).'='.
5498: &escape($message),$server);
5499: return $status;
5500: }
5501:
5502: sub dcmaildump {
5503: my ($dom,$startdate,$enddate,$senders) = @_;
5504: my %returnhash=();
5505:
5506: if (defined(&domain($dom,'primary'))) {
5507: my $cmd='dcmaildump:'.$dom.':'.&escape($startdate).':'.
5508: &escape($enddate).':';
5509: my @esc_senders=map { &escape($_)} @$senders;
5510: $cmd.=&escape(join('&',@esc_senders));
5511: foreach my $line (split(/\&/,&reply($cmd,&domain($dom,'primary')))) {
5512: my ($key,$value) = split(/\=/,$line,2);
5513: if (($key) && ($value)) {
5514: $returnhash{&unescape($key)} = &unescape($value);
5515: }
5516: }
5517: }
5518: return %returnhash;
5519: }
5520: # ---------------------------------------------------------- Domain roles
5521:
5522: sub get_domain_roles {
5523: my ($dom,$roles,$startdate,$enddate)=@_;
5524: if ((!defined($startdate)) || ($startdate eq '')) {
5525: $startdate = '.';
5526: }
5527: if ((!defined($enddate)) || ($enddate eq '')) {
5528: $enddate = '.';
5529: }
5530: my $rolelist;
5531: if (ref($roles) eq 'ARRAY') {
5532: $rolelist = join('&',@{$roles});
5533: }
5534: my %personnel = ();
5535:
5536: my %servers = &get_servers($dom,'library');
5537: foreach my $tryserver (keys(%servers)) {
5538: %{$personnel{$tryserver}}=();
5539: foreach my $line (split(/\&/,&reply('domrolesdump:'.$dom.':'.
5540: &escape($startdate).':'.
5541: &escape($enddate).':'.
5542: &escape($rolelist), $tryserver))) {
5543: my ($key,$value) = split(/\=/,$line,2);
5544: if (($key) && ($value)) {
5545: $personnel{$tryserver}{&unescape($key)} = &unescape($value);
5546: }
5547: }
5548: }
5549: return %personnel;
5550: }
5551:
5552: sub get_active_domroles {
5553: my ($dom,$roles) = @_;
5554: return () unless (ref($roles) eq 'ARRAY');
5555: my $now = time;
5556: my %dompersonnel = &get_domain_roles($dom,$roles,$now,$now);
5557: my %domroles;
5558: foreach my $server (keys(%dompersonnel)) {
5559: foreach my $user (sort(keys(%{$dompersonnel{$server}}))) {
5560: my ($trole,$uname,$udom,$runame,$rudom,$rsec) = split(/:/,$user);
5561: $domroles{$uname.':'.$udom} = $dompersonnel{$server}{$user};
5562: }
5563: }
5564: return %domroles;
5565: }
5566:
5567: # ----------------------------------------------------------- Interval timing
5568:
5569: {
5570: # Caches needed for speedup of navmaps
5571: # We don't want to cache this for very long at all (5 seconds at most)
5572: #
5573: # The user for whom we cache
5574: my $cachedkey='';
5575: # The cached times for this user
5576: my %cachedtimes=();
5577: # When this was last done
5578: my $cachedtime='';
5579:
5580: sub load_all_first_access {
5581: my ($uname,$udom,$ignorecache)=@_;
5582: if (($cachedkey eq $uname.':'.$udom) &&
5583: (abs($cachedtime-time)<5) && (!$env{'form.markaccess'}) &&
5584: (!$ignorecache)) {
5585: return;
5586: }
5587: $cachedtime=time;
5588: $cachedkey=$uname.':'.$udom;
5589: %cachedtimes=&dump('firstaccesstimes',$udom,$uname);
5590: }
5591:
5592: sub get_first_access {
5593: my ($type,$argsymb,$argmap,$ignorecache)=@_;
5594: my ($symb,$courseid,$udom,$uname)=&whichuser();
5595: if ($argsymb) { $symb=$argsymb; }
5596: my ($map,$id,$res)=&decode_symb($symb);
5597: if ($argmap) { $map = $argmap; }
5598: if ($type eq 'course') {
5599: $res='course';
5600: } elsif ($type eq 'map') {
5601: $res=&symbread($map);
5602: } else {
5603: $res=$symb;
5604: }
5605: &load_all_first_access($uname,$udom,$ignorecache);
5606: return $cachedtimes{"$courseid\0$res"};
5607: }
5608:
5609: sub set_first_access {
5610: my ($type,$interval)=@_;
5611: my ($symb,$courseid,$udom,$uname)=&whichuser();
5612: my ($map,$id,$res)=&decode_symb($symb);
5613: if ($type eq 'course') {
5614: $res='course';
5615: } elsif ($type eq 'map') {
5616: $res=&symbread($map);
5617: } else {
5618: $res=$symb;
5619: }
5620: $cachedkey='';
5621: my $firstaccess=&get_first_access($type,$symb,$map);
5622: if ($firstaccess) {
5623: &logthis("First access time already set ($firstaccess) when attempting ".
5624: "to set new value (type: $type, extent: $res) for $uname:$udom ".
5625: "in $courseid");
5626: return 'already_set';
5627: } else {
5628: my $start = time;
5629: my $putres = &put('firstaccesstimes',{"$courseid\0$res"=>$start},
5630: $udom,$uname);
5631: if ($putres eq 'ok') {
5632: &put('timerinterval',{"$courseid\0$res"=>$interval},
5633: $udom,$uname);
5634: &appenv(
5635: {
5636: 'course.'.$courseid.'.firstaccess.'.$res => $start,
5637: 'course.'.$courseid.'.timerinterval.'.$res => $interval,
5638: }
5639: );
5640: if (($cachedtime) && (abs($start-$cachedtime) < 5)) {
5641: $cachedtimes{"$courseid\0$res"} = $start;
5642: }
5643: } elsif ($putres ne 'refused') {
5644: &logthis("Result: $putres when attempting to set first access time ".
5645: "(type: $type, extent: $res) for $uname:$udom in $courseid");
5646: }
5647: return $putres;
5648: }
5649: return 'already_set';
5650: }
5651: }
5652:
5653: # --------------------------------------------- Set Expire Date for Spreadsheet
5654:
5655: sub expirespread {
5656: my ($uname,$udom,$stype,$usymb)=@_;
5657: my $cid=$env{'request.course.id'};
5658: if ($cid) {
5659: my $now=time;
5660: my $key=$uname.':'.$udom.':'.$stype.':'.$usymb;
5661: return &reply('put:'.$env{'course.'.$cid.'.domain'}.':'.
5662: $env{'course.'.$cid.'.num'}.
5663: ':nohist_expirationdates:'.
5664: &escape($key).'='.$now,
5665: $env{'course.'.$cid.'.home'})
5666: }
5667: return 'ok';
5668: }
5669:
5670: # ----------------------------------------------------- Devalidate Spreadsheets
5671:
5672: sub devalidate {
5673: my ($symb,$uname,$udom)=@_;
5674: my $cid=$env{'request.course.id'};
5675: if ($cid) {
5676: # delete the stored spreadsheets for
5677: # - the student level sheet of this user in course's homespace
5678: # - the assessment level sheet for this resource
5679: # for this user in user's homespace
5680: # - current conditional state info
5681: my $key=$uname.':'.$udom.':';
5682: my $status=
5683: &del('nohist_calculatedsheets',
5684: [$key.'studentcalc:'],
5685: $env{'course.'.$cid.'.domain'},
5686: $env{'course.'.$cid.'.num'})
5687: .' '.
5688: &del('nohist_calculatedsheets_'.$cid,
5689: [$key.'assesscalc:'.$symb],$udom,$uname);
5690: unless ($status eq 'ok ok') {
5691: &logthis('Could not devalidate spreadsheet '.
5692: $uname.' at '.$udom.' for '.
5693: $symb.': '.$status);
5694: }
5695: &delenv('user.state.'.$cid);
5696: }
5697: }
5698:
5699: sub get_scalar {
5700: my ($string,$end) = @_;
5701: my $value;
5702: if ($$string =~ s/^([^&]*?)($end)/$2/) {
5703: $value = $1;
5704: } elsif ($$string =~ s/^([^&]*?)&//) {
5705: $value = $1;
5706: }
5707: return &unescape($value);
5708: }
5709:
5710: sub array2str {
5711: my (@array) = @_;
5712: my $result=&arrayref2str(\@array);
5713: $result=~s/^__ARRAY_REF__//;
5714: $result=~s/__END_ARRAY_REF__$//;
5715: return $result;
5716: }
5717:
5718: sub arrayref2str {
5719: my ($arrayref) = @_;
5720: my $result='__ARRAY_REF__';
5721: foreach my $elem (@$arrayref) {
5722: if(ref($elem) eq 'ARRAY') {
5723: $result.=&arrayref2str($elem).'&';
5724: } elsif(ref($elem) eq 'HASH') {
5725: $result.=&hashref2str($elem).'&';
5726: } elsif(ref($elem)) {
5727: #print("Got a ref of ".(ref($elem))." skipping.");
5728: } else {
5729: $result.=&escape($elem).'&';
5730: }
5731: }
5732: $result=~s/\&$//;
5733: $result .= '__END_ARRAY_REF__';
5734: return $result;
5735: }
5736:
5737: sub hash2str {
5738: my (%hash) = @_;
5739: my $result=&hashref2str(\%hash);
5740: $result=~s/^__HASH_REF__//;
5741: $result=~s/__END_HASH_REF__$//;
5742: return $result;
5743: }
5744:
5745: sub hashref2str {
5746: my ($hashref)=@_;
5747: my $result='__HASH_REF__';
5748: foreach my $key (sort(keys(%$hashref))) {
5749: if (ref($key) eq 'ARRAY') {
5750: $result.=&arrayref2str($key).'=';
5751: } elsif (ref($key) eq 'HASH') {
5752: $result.=&hashref2str($key).'=';
5753: } elsif (ref($key)) {
5754: $result.='=';
5755: #print("Got a ref of ".(ref($key))." skipping.");
5756: } else {
5757: if (defined($key)) {$result.=&escape($key).'=';} else { last; }
5758: }
5759:
5760: if(ref($hashref->{$key}) eq 'ARRAY') {
5761: $result.=&arrayref2str($hashref->{$key}).'&';
5762: } elsif(ref($hashref->{$key}) eq 'HASH') {
5763: $result.=&hashref2str($hashref->{$key}).'&';
5764: } elsif(ref($hashref->{$key})) {
5765: $result.='&';
5766: #print("Got a ref of ".(ref($hashref->{$key}))." skipping.");
5767: } else {
5768: $result.=&escape($hashref->{$key}).'&';
5769: }
5770: }
5771: $result=~s/\&$//;
5772: $result .= '__END_HASH_REF__';
5773: return $result;
5774: }
5775:
5776: sub str2hash {
5777: my ($string)=@_;
5778: my ($hash)=&str2hashref('__HASH_REF__'.$string.'__END_HASH_REF__');
5779: return %$hash;
5780: }
5781:
5782: sub str2hashref {
5783: my ($string) = @_;
5784:
5785: my %hash;
5786:
5787: if($string !~ /^__HASH_REF__/) {
5788: if (! ($string eq '' || !defined($string))) {
5789: $hash{'error'}='Not hash reference';
5790: }
5791: return (\%hash, $string);
5792: }
5793:
5794: $string =~ s/^__HASH_REF__//;
5795:
5796: while($string !~ /^__END_HASH_REF__/) {
5797: #key
5798: my $key='';
5799: if($string =~ /^__HASH_REF__/) {
5800: ($key, $string)=&str2hashref($string);
5801: if(defined($key->{'error'})) {
5802: $hash{'error'}='Bad data';
5803: return (\%hash, $string);
5804: }
5805: } elsif($string =~ /^__ARRAY_REF__/) {
5806: ($key, $string)=&str2arrayref($string);
5807: if($key->[0] eq 'Array reference error') {
5808: $hash{'error'}='Bad data';
5809: return (\%hash, $string);
5810: }
5811: } else {
5812: $string =~ s/^(.*?)=//;
5813: $key=&unescape($1);
5814: }
5815: $string =~ s/^=//;
5816:
5817: #value
5818: my $value='';
5819: if($string =~ /^__HASH_REF__/) {
5820: ($value, $string)=&str2hashref($string);
5821: if(defined($value->{'error'})) {
5822: $hash{'error'}='Bad data';
5823: return (\%hash, $string);
5824: }
5825: } elsif($string =~ /^__ARRAY_REF__/) {
5826: ($value, $string)=&str2arrayref($string);
5827: if($value->[0] eq 'Array reference error') {
5828: $hash{'error'}='Bad data';
5829: return (\%hash, $string);
5830: }
5831: } else {
5832: $value=&get_scalar(\$string,'__END_HASH_REF__');
5833: }
5834: $string =~ s/^&//;
5835:
5836: $hash{$key}=$value;
5837: }
5838:
5839: $string =~ s/^__END_HASH_REF__//;
5840:
5841: return (\%hash, $string);
5842: }
5843:
5844: sub str2array {
5845: my ($string)=@_;
5846: my ($array)=&str2arrayref('__ARRAY_REF__'.$string.'__END_ARRAY_REF__');
5847: return @$array;
5848: }
5849:
5850: sub str2arrayref {
5851: my ($string) = @_;
5852: my @array;
5853:
5854: if($string !~ /^__ARRAY_REF__/) {
5855: if (! ($string eq '' || !defined($string))) {
5856: $array[0]='Array reference error';
5857: }
5858: return (\@array, $string);
5859: }
5860:
5861: $string =~ s/^__ARRAY_REF__//;
5862:
5863: while($string !~ /^__END_ARRAY_REF__/) {
5864: my $value='';
5865: if($string =~ /^__HASH_REF__/) {
5866: ($value, $string)=&str2hashref($string);
5867: if(defined($value->{'error'})) {
5868: $array[0] ='Array reference error';
5869: return (\@array, $string);
5870: }
5871: } elsif($string =~ /^__ARRAY_REF__/) {
5872: ($value, $string)=&str2arrayref($string);
5873: if($value->[0] eq 'Array reference error') {
5874: $array[0] ='Array reference error';
5875: return (\@array, $string);
5876: }
5877: } else {
5878: $value=&get_scalar(\$string,'__END_ARRAY_REF__');
5879: }
5880: $string =~ s/^&//;
5881:
5882: push(@array, $value);
5883: }
5884:
5885: $string =~ s/^__END_ARRAY_REF__//;
5886:
5887: return (\@array, $string);
5888: }
5889:
5890: # -------------------------------------------------------------------Temp Store
5891:
5892: sub tmpreset {
5893: my ($symb,$namespace,$domain,$stuname) = @_;
5894: if (!$symb) {
5895: $symb=&symbread();
5896: if (!$symb) { $symb= $env{'request.url'}; }
5897: }
5898: $symb=escape($symb);
5899:
5900: if (!$namespace) { $namespace=$env{'request.state'}; }
5901: $namespace=~s/\//\_/g;
5902: $namespace=~s/\W//g;
5903:
5904: if (!$domain) { $domain=$env{'user.domain'}; }
5905: if (!$stuname) { $stuname=$env{'user.name'}; }
5906: if ($domain eq 'public' && $stuname eq 'public') {
5907: $stuname=$ENV{'REMOTE_ADDR'};
5908: }
5909: my $path=LONCAPA::tempdir();
5910: my %hash;
5911: if (tie(%hash,'GDBM_File',
5912: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
5913: &GDBM_WRCREAT(),0640)) {
5914: foreach my $key (keys(%hash)) {
5915: if ($key=~ /:$symb/) {
5916: delete($hash{$key});
5917: }
5918: }
5919: }
5920: }
5921:
5922: sub tmpstore {
5923: my ($storehash,$symb,$namespace,$domain,$stuname) = @_;
5924:
5925: if (!$symb) {
5926: $symb=&symbread();
5927: if (!$symb) { $symb= $env{'request.url'}; }
5928: }
5929: $symb=escape($symb);
5930:
5931: if (!$namespace) {
5932: # I don't think we would ever want to store this for a course.
5933: # it seems this will only be used if we don't have a course.
5934: #$namespace=$env{'request.course.id'};
5935: #if (!$namespace) {
5936: $namespace=$env{'request.state'};
5937: #}
5938: }
5939: $namespace=~s/\//\_/g;
5940: $namespace=~s/\W//g;
5941: if (!$domain) { $domain=$env{'user.domain'}; }
5942: if (!$stuname) { $stuname=$env{'user.name'}; }
5943: if ($domain eq 'public' && $stuname eq 'public') {
5944: $stuname=$ENV{'REMOTE_ADDR'};
5945: }
5946: my $now=time;
5947: my %hash;
5948: my $path=LONCAPA::tempdir();
5949: if (tie(%hash,'GDBM_File',
5950: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
5951: &GDBM_WRCREAT(),0640)) {
5952: $hash{"version:$symb"}++;
5953: my $version=$hash{"version:$symb"};
5954: my $allkeys='';
5955: foreach my $key (keys(%$storehash)) {
5956: $allkeys.=$key.':';
5957: $hash{"$version:$symb:$key"}=&freeze_escape($$storehash{$key});
5958: }
5959: $hash{"$version:$symb:timestamp"}=$now;
5960: $allkeys.='timestamp';
5961: $hash{"$version:keys:$symb"}=$allkeys;
5962: if (untie(%hash)) {
5963: return 'ok';
5964: } else {
5965: return "error:$!";
5966: }
5967: } else {
5968: return "error:$!";
5969: }
5970: }
5971:
5972: # -----------------------------------------------------------------Temp Restore
5973:
5974: sub tmprestore {
5975: my ($symb,$namespace,$domain,$stuname) = @_;
5976:
5977: if (!$symb) {
5978: $symb=&symbread();
5979: if (!$symb) { $symb= $env{'request.url'}; }
5980: }
5981: $symb=escape($symb);
5982:
5983: if (!$namespace) { $namespace=$env{'request.state'}; }
5984:
5985: if (!$domain) { $domain=$env{'user.domain'}; }
5986: if (!$stuname) { $stuname=$env{'user.name'}; }
5987: if ($domain eq 'public' && $stuname eq 'public') {
5988: $stuname=$ENV{'REMOTE_ADDR'};
5989: }
5990: my %returnhash;
5991: $namespace=~s/\//\_/g;
5992: $namespace=~s/\W//g;
5993: my %hash;
5994: my $path=LONCAPA::tempdir();
5995: if (tie(%hash,'GDBM_File',
5996: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
5997: &GDBM_READER(),0640)) {
5998: my $version=$hash{"version:$symb"};
5999: $returnhash{'version'}=$version;
6000: my $scope;
6001: for ($scope=1;$scope<=$version;$scope++) {
6002: my $vkeys=$hash{"$scope:keys:$symb"};
6003: my @keys=split(/:/,$vkeys);
6004: my $key;
6005: $returnhash{"$scope:keys"}=$vkeys;
6006: foreach $key (@keys) {
6007: $returnhash{"$scope:$key"}=&thaw_unescape($hash{"$scope:$symb:$key"});
6008: $returnhash{"$key"}=&thaw_unescape($hash{"$scope:$symb:$key"});
6009: }
6010: }
6011: if (!(untie(%hash))) {
6012: return "error:$!";
6013: }
6014: } else {
6015: return "error:$!";
6016: }
6017: return %returnhash;
6018: }
6019:
6020: # ----------------------------------------------------------------------- Store
6021:
6022: sub store {
6023: my ($storehash,$symb,$namespace,$domain,$stuname,$laststore) = @_;
6024: my $home='';
6025:
6026: if ($stuname) { $home=&homeserver($stuname,$domain); }
6027:
6028: $symb=&symbclean($symb);
6029: if (!$symb) { unless ($symb=&symbread()) { return ''; } }
6030:
6031: if (!$domain) { $domain=$env{'user.domain'}; }
6032: if (!$stuname) { $stuname=$env{'user.name'}; }
6033:
6034: &devalidate($symb,$stuname,$domain);
6035:
6036: $symb=escape($symb);
6037: if (!$namespace) {
6038: unless ($namespace=$env{'request.course.id'}) {
6039: return '';
6040: }
6041: }
6042: if (!$home) { $home=$env{'user.home'}; }
6043:
6044: $$storehash{'ip'}=$ENV{'REMOTE_ADDR'};
6045: $$storehash{'host'}=$perlvar{'lonHostID'};
6046:
6047: my $namevalue='';
6048: foreach my $key (keys(%$storehash)) {
6049: $namevalue.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
6050: }
6051: $namevalue=~s/\&$//;
6052: &courselog($symb.':'.$stuname.':'.$domain.':STORE:'.$namevalue);
6053: return reply("store:$domain:$stuname:$namespace:$symb:$namevalue:$laststore","$home");
6054: }
6055:
6056: # -------------------------------------------------------------- Critical Store
6057:
6058: sub cstore {
6059: my ($storehash,$symb,$namespace,$domain,$stuname,$laststore) = @_;
6060: my $home='';
6061:
6062: if ($stuname) { $home=&homeserver($stuname,$domain); }
6063:
6064: $symb=&symbclean($symb);
6065: if (!$symb) { unless ($symb=&symbread()) { return ''; } }
6066:
6067: if (!$domain) { $domain=$env{'user.domain'}; }
6068: if (!$stuname) { $stuname=$env{'user.name'}; }
6069:
6070: &devalidate($symb,$stuname,$domain);
6071:
6072: $symb=escape($symb);
6073: if (!$namespace) {
6074: unless ($namespace=$env{'request.course.id'}) {
6075: return '';
6076: }
6077: }
6078: if (!$home) { $home=$env{'user.home'}; }
6079:
6080: $$storehash{'ip'}=$ENV{'REMOTE_ADDR'};
6081: $$storehash{'host'}=$perlvar{'lonHostID'};
6082:
6083: my $namevalue='';
6084: foreach my $key (keys(%$storehash)) {
6085: $namevalue.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
6086: }
6087: $namevalue=~s/\&$//;
6088: &courselog($symb.':'.$stuname.':'.$domain.':CSTORE:'.$namevalue);
6089: return critical
6090: ("store:$domain:$stuname:$namespace:$symb:$namevalue:$laststore","$home");
6091: }
6092:
6093: # --------------------------------------------------------------------- Restore
6094:
6095: sub restore {
6096: my ($symb,$namespace,$domain,$stuname) = @_;
6097: my $home='';
6098:
6099: if ($stuname) { $home=&homeserver($stuname,$domain); }
6100:
6101: if (!$symb) {
6102: return if ($namespace eq 'courserequests');
6103: unless ($symb=escape(&symbread())) { return ''; }
6104: } else {
6105: unless ($namespace eq 'courserequests') {
6106: $symb=&escape(&symbclean($symb));
6107: }
6108: }
6109: if (!$namespace) {
6110: unless ($namespace=$env{'request.course.id'}) {
6111: return '';
6112: }
6113: }
6114: if (!$domain) { $domain=$env{'user.domain'}; }
6115: if (!$stuname) { $stuname=$env{'user.name'}; }
6116: if (!$home) { $home=$env{'user.home'}; }
6117: my $answer=&reply("restore:$domain:$stuname:$namespace:$symb","$home");
6118:
6119: my %returnhash=();
6120: foreach my $line (split(/\&/,$answer)) {
6121: my ($name,$value)=split(/\=/,$line);
6122: $returnhash{&unescape($name)}=&thaw_unescape($value);
6123: }
6124: my $version;
6125: for ($version=1;$version<=$returnhash{'version'};$version++) {
6126: foreach my $item (split(/\:/,$returnhash{$version.':keys'})) {
6127: $returnhash{$item}=$returnhash{$version.':'.$item};
6128: }
6129: }
6130: return %returnhash;
6131: }
6132:
6133: # ---------------------------------------------------------- Course Description
6134: #
6135: #
6136:
6137: sub coursedescription {
6138: my ($courseid,$args)=@_;
6139: $courseid=~s/^\///;
6140: $courseid=~s/\_/\//g;
6141: my ($cdomain,$cnum)=split(/\//,$courseid);
6142: my $chome=&homeserver($cnum,$cdomain);
6143: my $normalid=$cdomain.'_'.$cnum;
6144: # need to always cache even if we get errors otherwise we keep
6145: # trying and trying and trying to get the course description.
6146: my %envhash=();
6147: my %returnhash=();
6148:
6149: my $expiretime=600;
6150: if ($env{'request.course.id'} eq $normalid) {
6151: $expiretime=120;
6152: }
6153:
6154: my $prefix='course.'.$cdomain.'_'.$cnum.'.';
6155: if (!$args->{'freshen_cache'}
6156: && ((time-$env{$prefix.'last_cache'}) < $expiretime) ) {
6157: foreach my $key (keys(%env)) {
6158: next if ($key !~ /^\Q$prefix\E(.*)/);
6159: my ($setting) = $1;
6160: $returnhash{$setting} = $env{$key};
6161: }
6162: return %returnhash;
6163: }
6164:
6165: # get the data again
6166:
6167: if (!$args->{'one_time'}) {
6168: $envhash{'course.'.$normalid.'.last_cache'}=time;
6169: }
6170:
6171: if ($chome ne 'no_host') {
6172: %returnhash=&dump('environment',$cdomain,$cnum);
6173: if (!exists($returnhash{'con_lost'})) {
6174: my $username = $env{'user.name'}; # Defult username
6175: if(defined $args->{'user'}) {
6176: $username = $args->{'user'};
6177: }
6178: $returnhash{'home'}= $chome;
6179: $returnhash{'domain'} = $cdomain;
6180: $returnhash{'num'} = $cnum;
6181: if (!defined($returnhash{'type'})) {
6182: $returnhash{'type'} = 'Course';
6183: }
6184: while (my ($name,$value) = each %returnhash) {
6185: $envhash{'course.'.$normalid.'.'.$name}=$value;
6186: }
6187: $returnhash{'url'}=&clutter($returnhash{'url'});
6188: $returnhash{'fn'}=LONCAPA::tempdir() .
6189: $username.'_'.$cdomain.'_'.$cnum;
6190: $envhash{'course.'.$normalid.'.home'}=$chome;
6191: $envhash{'course.'.$normalid.'.domain'}=$cdomain;
6192: $envhash{'course.'.$normalid.'.num'}=$cnum;
6193: }
6194: }
6195: if (!$args->{'one_time'}) {
6196: &appenv(\%envhash);
6197: }
6198: return %returnhash;
6199: }
6200:
6201: sub update_released_required {
6202: my ($needsrelease,$cdom,$cnum,$chome,$cid) = @_;
6203: if ($cdom eq '' || $cnum eq '' || $chome eq '' || $cid eq '') {
6204: $cid = $env{'request.course.id'};
6205: $cdom = $env{'course.'.$cid.'.domain'};
6206: $cnum = $env{'course.'.$cid.'.num'};
6207: $chome = $env{'course.'.$cid.'.home'};
6208: }
6209: if ($needsrelease) {
6210: my %curr_reqd_hash = &userenvironment($cdom,$cnum,'internal.releaserequired');
6211: my $needsupdate;
6212: if ($curr_reqd_hash{'internal.releaserequired'} eq '') {
6213: $needsupdate = 1;
6214: } else {
6215: my ($currmajor,$currminor) = split(/\./,$curr_reqd_hash{'internal.releaserequired'});
6216: my ($needsmajor,$needsminor) = split(/\./,$needsrelease);
6217: if (($currmajor < $needsmajor) || ($currmajor == $needsmajor && $currminor < $needsminor)) {
6218: $needsupdate = 1;
6219: }
6220: }
6221: if ($needsupdate) {
6222: my %needshash = (
6223: 'internal.releaserequired' => $needsrelease,
6224: );
6225: my $putresult = &put('environment',\%needshash,$cdom,$cnum);
6226: if ($putresult eq 'ok') {
6227: &appenv({'course.'.$cid.'.internal.releaserequired' => $needsrelease});
6228: my %crsinfo = &courseiddump($cdom,'.',1,'.','.',$cnum,undef,undef,'.');
6229: if (ref($crsinfo{$cid}) eq 'HASH') {
6230: $crsinfo{$cid}{'releaserequired'} = $needsrelease;
6231: &courseidput($cdom,\%crsinfo,$chome,'notime');
6232: }
6233: }
6234: }
6235: }
6236: return;
6237: }
6238:
6239: # -------------------------------------------------See if a user is privileged
6240:
6241: sub privileged {
6242: my ($username,$domain,$possdomains,$possroles)=@_;
6243: my $now = time;
6244: my $roles;
6245: if (ref($possroles) eq 'ARRAY') {
6246: $roles = $possroles;
6247: } else {
6248: $roles = ['dc','su'];
6249: }
6250: if (ref($possdomains) eq 'ARRAY') {
6251: my %privileged = &privileged_by_domain($possdomains,$roles);
6252: foreach my $dom (@{$possdomains}) {
6253: if (($username =~ /^$match_username$/) && ($domain =~ /^$match_domain$/) &&
6254: (ref($privileged{$dom}) eq 'HASH')) {
6255: foreach my $role (@{$roles}) {
6256: if (ref($privileged{$dom}{$role}) eq 'HASH') {
6257: if (exists($privileged{$dom}{$role}{$username.':'.$domain})) {
6258: my ($end,$start) = split(/:/,$privileged{$dom}{$role}{$username.':'.$domain});
6259: return 1 unless (($end && $end < $now) ||
6260: ($start && $start > $now));
6261: }
6262: }
6263: }
6264: }
6265: }
6266: } else {
6267: my %rolesdump = &dump("roles", $domain, $username) or return 0;
6268: my $now = time;
6269:
6270: for my $role (@rolesdump{grep { ! /^rolesdef_/ } keys(%rolesdump)}) {
6271: my ($trole, $tend, $tstart) = split(/_/, $role);
6272: if (grep(/^\Q$trole\E$/,@{$roles})) {
6273: return 1 unless ($tend && $tend < $now)
6274: or ($tstart && $tstart > $now);
6275: }
6276: }
6277: }
6278: return 0;
6279: }
6280:
6281: sub privileged_by_domain {
6282: my ($domains,$roles) = @_;
6283: my %privileged = ();
6284: my $cachetime = 60*60*24;
6285: my $now = time;
6286: unless ((ref($domains) eq 'ARRAY') && (ref($roles) eq 'ARRAY')) {
6287: return %privileged;
6288: }
6289: foreach my $dom (@{$domains}) {
6290: next if (ref($privileged{$dom}) eq 'HASH');
6291: my $needroles;
6292: foreach my $role (@{$roles}) {
6293: my ($result,$cached)=&is_cached_new('priv_'.$role,$dom);
6294: if (defined($cached)) {
6295: if (ref($result) eq 'HASH') {
6296: $privileged{$dom}{$role} = $result;
6297: }
6298: } else {
6299: $needroles = 1;
6300: }
6301: }
6302: if ($needroles) {
6303: my %dompersonnel = &get_domain_roles($dom,$roles);
6304: $privileged{$dom} = {};
6305: foreach my $server (keys(%dompersonnel)) {
6306: if (ref($dompersonnel{$server}) eq 'HASH') {
6307: foreach my $item (keys(%{$dompersonnel{$server}})) {
6308: my ($trole,$uname,$udom,$rest) = split(/:/,$item,4);
6309: my ($end,$start) = split(/:/,$dompersonnel{$server}{$item});
6310: next if ($end && $end < $now);
6311: $privileged{$dom}{$trole}{$uname.':'.$udom} =
6312: $dompersonnel{$server}{$item};
6313: }
6314: }
6315: }
6316: if (ref($privileged{$dom}) eq 'HASH') {
6317: foreach my $role (@{$roles}) {
6318: if (ref($privileged{$dom}{$role}) eq 'HASH') {
6319: &do_cache_new('priv_'.$role,$dom,$privileged{$dom}{$role},$cachetime);
6320: } else {
6321: my %hash = ();
6322: &do_cache_new('priv_'.$role,$dom,\%hash,$cachetime);
6323: }
6324: }
6325: }
6326: }
6327: }
6328: return %privileged;
6329: }
6330:
6331: # -------------------------------------------------------- Get user privileges
6332:
6333: sub rolesinit {
6334: my ($domain, $username) = @_;
6335: my %userroles = ('user.login.time' => time);
6336: my %rolesdump = &dump("roles", $domain, $username) or return \%userroles;
6337:
6338: # firstaccess and timerinterval are related to timed maps/resources.
6339: # also, blocking can be triggered by an activating timer
6340: # it's saved in the user's %env.
6341: my %firstaccess = &dump('firstaccesstimes', $domain, $username);
6342: my %timerinterval = &dump('timerinterval', $domain, $username);
6343: my (%coursetimerstarts, %firstaccchk, %firstaccenv, %coursetimerintervals,
6344: %timerintchk, %timerintenv);
6345:
6346: foreach my $key (keys(%firstaccess)) {
6347: my ($cid, $rest) = split(/\0/, $key);
6348: $coursetimerstarts{$cid}{$rest} = $firstaccess{$key};
6349: }
6350:
6351: foreach my $key (keys(%timerinterval)) {
6352: my ($cid,$rest) = split(/\0/,$key);
6353: $coursetimerintervals{$cid}{$rest} = $timerinterval{$key};
6354: }
6355:
6356: my %allroles=();
6357: my %allgroups=();
6358:
6359: for my $area (grep { ! /^rolesdef_/ } keys(%rolesdump)) {
6360: my $role = $rolesdump{$area};
6361: $area =~ s/\_\w\w$//;
6362:
6363: my ($trole, $tend, $tstart, $group_privs);
6364:
6365: if ($role =~ /^cr/) {
6366: # Custom role, defined by a user
6367: # e.g., user.role.cr/msu/smith/mynewrole
6368: if ($role =~ m|^(cr/$match_domain/$match_username/[a-zA-Z0-9]+)_(.*)$|) {
6369: $trole = $1;
6370: ($tend, $tstart) = split('_', $2);
6371: } else {
6372: $trole = $role;
6373: }
6374: } elsif ($role =~ m|^gr/|) {
6375: # Role of member in a group, defined within a course/community
6376: # e.g., user.role.gr/msu/04935610a19ee4a5fmsul1/leopards
6377: ($trole, $tend, $tstart) = split(/_/, $role);
6378: next if $tstart eq '-1';
6379: ($trole, $group_privs) = split(/\//, $trole);
6380: $group_privs = &unescape($group_privs);
6381: } else {
6382: # Just a normal role, defined in roles.tab
6383: ($trole, $tend, $tstart) = split(/_/,$role);
6384: }
6385:
6386: my %new_role = &set_arearole($trole,$area,$tstart,$tend,$domain,
6387: $username);
6388: @userroles{keys(%new_role)} = @new_role{keys(%new_role)};
6389:
6390: # role expired or not available yet?
6391: $trole = '' if ($tend != 0 && $tend < $userroles{'user.login.time'}) or
6392: ($tstart != 0 && $tstart > $userroles{'user.login.time'});
6393:
6394: next if $area eq '' or $trole eq '';
6395:
6396: my $spec = "$trole.$area";
6397: my ($tdummy, $tdomain, $trest) = split(/\//, $area);
6398:
6399: if ($trole =~ /^cr\//) {
6400: # Custom role, defined by a user
6401: &custom_roleprivs(\%allroles,$trole,$tdomain,$trest,$spec,$area);
6402: } elsif ($trole eq 'gr') {
6403: # Role of a member in a group, defined within a course/community
6404: &group_roleprivs(\%allgroups,$area,$group_privs,$tend,$tstart);
6405: next;
6406: } else {
6407: # Normal role, defined in roles.tab
6408: &standard_roleprivs(\%allroles,$trole,$tdomain,$spec,$trest,$area);
6409: }
6410:
6411: my $cid = $tdomain.'_'.$trest;
6412: unless ($firstaccchk{$cid}) {
6413: if (ref($coursetimerstarts{$cid}) eq 'HASH') {
6414: foreach my $item (keys(%{$coursetimerstarts{$cid}})) {
6415: $firstaccenv{'course.'.$cid.'.firstaccess.'.$item} =
6416: $coursetimerstarts{$cid}{$item};
6417: }
6418: }
6419: $firstaccchk{$cid} = 1;
6420: }
6421: unless ($timerintchk{$cid}) {
6422: if (ref($coursetimerintervals{$cid}) eq 'HASH') {
6423: foreach my $item (keys(%{$coursetimerintervals{$cid}})) {
6424: $timerintenv{'course.'.$cid.'.timerinterval.'.$item} =
6425: $coursetimerintervals{$cid}{$item};
6426: }
6427: }
6428: $timerintchk{$cid} = 1;
6429: }
6430: }
6431:
6432: @userroles{'user.author','user.adv','user.rar'} = &set_userprivs(\%userroles,
6433: \%allroles, \%allgroups);
6434: $env{'user.adv'} = $userroles{'user.adv'};
6435: $env{'user.rar'} = $userroles{'user.rar'};
6436:
6437: return (\%userroles,\%firstaccenv,\%timerintenv);
6438: }
6439:
6440: sub set_arearole {
6441: my ($trole,$area,$tstart,$tend,$domain,$username,$nolog) = @_;
6442: unless ($nolog) {
6443: # log the associated role with the area
6444: &userrolelog($trole,$username,$domain,$area,$tstart,$tend);
6445: }
6446: return ('user.role.'.$trole.'.'.$area => $tstart.'.'.$tend);
6447: }
6448:
6449: sub custom_roleprivs {
6450: my ($allroles,$trole,$tdomain,$trest,$spec,$area) = @_;
6451: my ($rdummy,$rdomain,$rauthor,$rrole)=split(/\//,$trole);
6452: my $homsvr = &homeserver($rauthor,$rdomain);
6453: if (&hostname($homsvr) ne '') {
6454: my ($rdummy,$roledef)=
6455: &get('roles',["rolesdef_$rrole"],$rdomain,$rauthor);
6456: if (($rdummy ne 'con_lost') && ($roledef ne '')) {
6457: my ($syspriv,$dompriv,$coursepriv)=split(/\_/,$roledef);
6458: if (defined($syspriv)) {
6459: if ($trest =~ /^$match_community$/) {
6460: $syspriv =~ s/bre\&S//;
6461: }
6462: $$allroles{'cm./'}.=':'.$syspriv;
6463: $$allroles{$spec.'./'}.=':'.$syspriv;
6464: }
6465: if ($tdomain ne '') {
6466: if (defined($dompriv)) {
6467: $$allroles{'cm./'.$tdomain.'/'}.=':'.$dompriv;
6468: $$allroles{$spec.'./'.$tdomain.'/'}.=':'.$dompriv;
6469: }
6470: if (($trest ne '') && (defined($coursepriv))) {
6471: if ($trole =~ m{^cr/$tdomain/$tdomain\Q-domainconfig\E/([^/]+)$}) {
6472: my $rolename = $1;
6473: $coursepriv = &course_adhocrole_privs($rolename,$tdomain,$trest,$coursepriv);
6474: }
6475: $$allroles{'cm.'.$area}.=':'.$coursepriv;
6476: $$allroles{$spec.'.'.$area}.=':'.$coursepriv;
6477: }
6478: }
6479: }
6480: }
6481: }
6482:
6483: sub course_adhocrole_privs {
6484: my ($rolename,$cdom,$cnum,$coursepriv) = @_;
6485: my %overrides = &get('environment',["internal.adhocpriv.$rolename"],$cdom,$cnum);
6486: if ($overrides{"internal.adhocpriv.$rolename"}) {
6487: my (%currprivs,%storeprivs);
6488: foreach my $item (split(/:/,$coursepriv)) {
6489: my ($priv,$restrict) = split(/\&/,$item);
6490: $currprivs{$priv} = $restrict;
6491: }
6492: my (%possadd,%possremove,%full);
6493: foreach my $item (split(/\:/,$Apache::lonnet::pr{'cr:c'})) {
6494: my ($priv,$restrict)=split(/\&/,$item);
6495: $full{$priv} = $restrict;
6496: }
6497: foreach my $item (split(/,/,$overrides{"internal.adhocpriv.$rolename"})) {
6498: next if ($item eq '');
6499: my ($rule,$rest) = split(/=/,$item);
6500: next unless (($rule eq 'off') || ($rule eq 'on'));
6501: foreach my $priv (split(/:/,$rest)) {
6502: if ($priv ne '') {
6503: if ($rule eq 'off') {
6504: $possremove{$priv} = 1;
6505: } else {
6506: $possadd{$priv} = 1;
6507: }
6508: }
6509: }
6510: }
6511: foreach my $priv (sort(keys(%full))) {
6512: if (exists($currprivs{$priv})) {
6513: unless (exists($possremove{$priv})) {
6514: $storeprivs{$priv} = $currprivs{$priv};
6515: }
6516: } elsif (exists($possadd{$priv})) {
6517: $storeprivs{$priv} = $full{$priv};
6518: }
6519: }
6520: $coursepriv = ':'.join(':',map { $_.'&'.$storeprivs{$_}; } sort(keys(%storeprivs)));
6521: }
6522: return $coursepriv;
6523: }
6524:
6525: sub group_roleprivs {
6526: my ($allgroups,$area,$group_privs,$tend,$tstart) = @_;
6527: my $access = 1;
6528: my $now = time;
6529: if (($tend!=0) && ($tend<$now)) { $access = 0; }
6530: if (($tstart!=0) && ($tstart>$now)) { $access=0; }
6531: if ($access) {
6532: my ($course,$group) = ($area =~ m|(/$match_domain/$match_courseid)/([^/]+)$|);
6533: $$allgroups{$course}{$group} .=':'.$group_privs;
6534: }
6535: }
6536:
6537: sub standard_roleprivs {
6538: my ($allroles,$trole,$tdomain,$spec,$trest,$area) = @_;
6539: if (defined($pr{$trole.':s'})) {
6540: $$allroles{'cm./'}.=':'.$pr{$trole.':s'};
6541: $$allroles{$spec.'./'}.=':'.$pr{$trole.':s'};
6542: }
6543: if ($tdomain ne '') {
6544: if (defined($pr{$trole.':d'})) {
6545: $$allroles{'cm./'.$tdomain.'/'}.=':'.$pr{$trole.':d'};
6546: $$allroles{$spec.'./'.$tdomain.'/'}.=':'.$pr{$trole.':d'};
6547: }
6548: if (($trest ne '') && (defined($pr{$trole.':c'}))) {
6549: $$allroles{'cm.'.$area}.=':'.$pr{$trole.':c'};
6550: $$allroles{$spec.'.'.$area}.=':'.$pr{$trole.':c'};
6551: }
6552: }
6553: }
6554:
6555: sub set_userprivs {
6556: my ($userroles,$allroles,$allgroups,$groups_roles) = @_;
6557: my $author=0;
6558: my $adv=0;
6559: my $rar=0;
6560: my %grouproles = ();
6561: if (keys(%{$allgroups}) > 0) {
6562: my @groupkeys;
6563: foreach my $role (keys(%{$allroles})) {
6564: push(@groupkeys,$role);
6565: }
6566: if (ref($groups_roles) eq 'HASH') {
6567: foreach my $key (keys(%{$groups_roles})) {
6568: unless (grep(/^\Q$key\E$/,@groupkeys)) {
6569: push(@groupkeys,$key);
6570: }
6571: }
6572: }
6573: if (@groupkeys > 0) {
6574: foreach my $role (@groupkeys) {
6575: my ($trole,$area,$sec,$extendedarea);
6576: if ($role =~ m-^(\w+|cr/$match_domain/$match_username/\w+)\.(/$match_domain/$match_courseid)(/?\w*)\.-) {
6577: $trole = $1;
6578: $area = $2;
6579: $sec = $3;
6580: $extendedarea = $area.$sec;
6581: if (exists($$allgroups{$area})) {
6582: foreach my $group (keys(%{$$allgroups{$area}})) {
6583: my $spec = $trole.'.'.$extendedarea;
6584: $grouproles{$spec.'.'.$area.'/'.$group} =
6585: $$allgroups{$area}{$group};
6586: }
6587: }
6588: }
6589: }
6590: }
6591: }
6592: foreach my $group (keys(%grouproles)) {
6593: $$allroles{$group} = $grouproles{$group};
6594: }
6595: foreach my $role (keys(%{$allroles})) {
6596: my %thesepriv;
6597: if (($role=~/^au/) || ($role=~/^ca/) || ($role=~/^aa/)) { $author=1; }
6598: foreach my $item (split(/:/,$$allroles{$role})) {
6599: if ($item ne '') {
6600: my ($privilege,$restrictions)=split(/&/,$item);
6601: if ($restrictions eq '') {
6602: $thesepriv{$privilege}='F';
6603: } elsif ($thesepriv{$privilege} ne 'F') {
6604: $thesepriv{$privilege}.=$restrictions;
6605: }
6606: if ($thesepriv{'adv'} eq 'F') { $adv=1; }
6607: if ($thesepriv{'rar'} eq 'F') { $rar=1; }
6608: }
6609: }
6610: my $thesestr='';
6611: foreach my $priv (sort(keys(%thesepriv))) {
6612: $thesestr.=':'.$priv.'&'.$thesepriv{$priv};
6613: }
6614: $userroles->{'user.priv.'.$role} = $thesestr;
6615: }
6616: return ($author,$adv,$rar);
6617: }
6618:
6619: sub role_status {
6620: my ($rolekey,$update,$refresh,$now,$role,$where,$trolecode,$tstatus,$tstart,$tend) = @_;
6621: if (exists($env{$rolekey}) && $env{$rolekey} ne '') {
6622: my ($one,$two) = split(m{\./},$rolekey,2);
6623: (undef,undef,$$role) = split(/\./,$one,3);
6624: unless (!defined($$role) || $$role eq '') {
6625: $$where = '/'.$two;
6626: $$trolecode=$$role.'.'.$$where;
6627: ($$tstart,$$tend)=split(/\./,$env{$rolekey});
6628: $$tstatus='is';
6629: if ($$tstart && $$tstart>$update) {
6630: $$tstatus='future';
6631: if ($$tstart<$now) {
6632: if ($$tstart && $$tstart>$refresh) {
6633: if (($$where ne '') && ($$role ne '')) {
6634: my (%allroles,%allgroups,$group_privs,
6635: %groups_roles,@rolecodes);
6636: my %userroles = (
6637: 'user.role.'.$$role.'.'.$$where => $$tstart.'.'.$$tend
6638: );
6639: @rolecodes = ('cm');
6640: my $spec=$$role.'.'.$$where;
6641: my ($tdummy,$tdomain,$trest)=split(/\//,$$where);
6642: if ($$role =~ /^cr\//) {
6643: &custom_roleprivs(\%allroles,$$role,$tdomain,$trest,$spec,$$where);
6644: push(@rolecodes,'cr');
6645: } elsif ($$role eq 'gr') {
6646: push(@rolecodes,$$role);
6647: my %rolehash = &get('roles',[$$where.'_'.$$role],$env{'user.domain'},
6648: $env{'user.name'});
6649: my ($trole) = split('_',$rolehash{$$where.'_'.$$role},2);
6650: (undef,my $group_privs) = split(/\//,$trole);
6651: $group_privs = &unescape($group_privs);
6652: &group_roleprivs(\%allgroups,$$where,$group_privs,$$tend,$$tstart);
6653: my %course_roles = &get_my_roles($env{'user.name'},$env{'user.domain'},'userroles',['active'],['cc','co','in','ta','ep','ad','st','cr'],[$tdomain],1);
6654: &get_groups_roles($tdomain,$trest,
6655: \%course_roles,\@rolecodes,
6656: \%groups_roles);
6657: } else {
6658: push(@rolecodes,$$role);
6659: &standard_roleprivs(\%allroles,$$role,$tdomain,$spec,$trest,$$where);
6660: }
6661: my ($author,$adv,$rar)= &set_userprivs(\%userroles,\%allroles,\%allgroups,
6662: \%groups_roles);
6663: &appenv(\%userroles,\@rolecodes);
6664: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},"Role ".$spec);
6665: }
6666: }
6667: $$tstatus = 'is';
6668: }
6669: }
6670: if ($$tend) {
6671: if ($$tend<$update) {
6672: $$tstatus='expired';
6673: } elsif ($$tend<$now) {
6674: $$tstatus='will_not';
6675: }
6676: }
6677: }
6678: }
6679: }
6680:
6681: sub get_groups_roles {
6682: my ($cdom,$rest,$cdom_courseroles,$rolecodes,$groups_roles) = @_;
6683: return unless((ref($cdom_courseroles) eq 'HASH') &&
6684: (ref($rolecodes) eq 'ARRAY') &&
6685: (ref($groups_roles) eq 'HASH'));
6686: if (keys(%{$cdom_courseroles}) > 0) {
6687: my ($cnum) = ($rest =~ /^($match_courseid)/);
6688: if ($cdom ne '' && $cnum ne '') {
6689: foreach my $key (keys(%{$cdom_courseroles})) {
6690: if ($key =~ /^\Q$cnum\E:\Q$cdom\E:([^:]+):?([^:]*)/) {
6691: my $crsrole = $1;
6692: my $crssec = $2;
6693: if ($crsrole =~ /^cr/) {
6694: unless (grep(/^cr$/,@{$rolecodes})) {
6695: push(@{$rolecodes},'cr');
6696: }
6697: } else {
6698: unless(grep(/^\Q$crsrole\E$/,@{$rolecodes})) {
6699: push(@{$rolecodes},$crsrole);
6700: }
6701: }
6702: my $rolekey = "$crsrole./$cdom/$cnum";
6703: if ($crssec ne '') {
6704: $rolekey .= "/$crssec";
6705: }
6706: $rolekey .= './';
6707: $groups_roles->{$rolekey} = $rolecodes;
6708: }
6709: }
6710: }
6711: }
6712: return;
6713: }
6714:
6715: sub delete_env_groupprivs {
6716: my ($where,$courseroles,$possroles) = @_;
6717: return unless((ref($courseroles) eq 'HASH') && (ref($possroles) eq 'ARRAY'));
6718: my ($dummy,$udom,$uname,$group) = split(/\//,$where);
6719: unless (ref($courseroles->{$udom}) eq 'HASH') {
6720: %{$courseroles->{$udom}} =
6721: &get_my_roles('','','userroles',['active'],
6722: $possroles,[$udom],1);
6723: }
6724: if (ref($courseroles->{$udom}) eq 'HASH') {
6725: foreach my $item (keys(%{$courseroles->{$udom}})) {
6726: my ($cnum,$cdom,$crsrole,$crssec) = split(/:/,$item);
6727: my $area = '/'.$cdom.'/'.$cnum;
6728: my $privkey = "user.priv.$crsrole.$area";
6729: if ($crssec ne '') {
6730: $privkey .= '/'.$crssec;
6731: }
6732: $privkey .= ".$area/$group";
6733: &Apache::lonnet::delenv($privkey,undef,[$crsrole]);
6734: }
6735: }
6736: return;
6737: }
6738:
6739: sub check_adhoc_privs {
6740: my ($cdom,$cnum,$update,$refresh,$now,$checkrole,$caller,$sec) = @_;
6741: my $cckey = 'user.role.'.$checkrole.'./'.$cdom.'/'.$cnum;
6742: if ($sec) {
6743: $cckey .= '/'.$sec;
6744: }
6745: my $setprivs;
6746: if ($env{$cckey}) {
6747: my ($role,$where,$trolecode,$tstart,$tend,$tremark,$tstatus,$tpstart,$tpend);
6748: &role_status($cckey,$update,$refresh,$now,\$role,\$where,\$trolecode,\$tstatus,\$tstart,\$tend);
6749: unless (($tstatus eq 'is') || ($tstatus eq 'will_not')) {
6750: &set_adhoc_privileges($cdom,$cnum,$checkrole,$caller,$sec);
6751: $setprivs = 1;
6752: }
6753: } else {
6754: &set_adhoc_privileges($cdom,$cnum,$checkrole,$caller,$sec);
6755: $setprivs = 1;
6756: }
6757: return $setprivs;
6758: }
6759:
6760: sub set_adhoc_privileges {
6761: # role can be cc, ca, or cr/<dom>/<dom>-domainconfig/role
6762: my ($dcdom,$pickedcourse,$role,$caller,$sec) = @_;
6763: my $area = '/'.$dcdom.'/'.$pickedcourse;
6764: if ($sec ne '') {
6765: $area .= '/'.$sec;
6766: }
6767: my $spec = $role.'.'.$area;
6768: my %userroles = &set_arearole($role,$area,'','',$env{'user.domain'},
6769: $env{'user.name'},1);
6770: my %rolehash = ();
6771: if ($role =~ m{^\Qcr/$dcdom/$dcdom\E\-domainconfig/(\w+)$}) {
6772: my $rolename = $1;
6773: &custom_roleprivs(\%rolehash,$role,$dcdom,$pickedcourse,$spec,$area);
6774: my %domdef = &get_domain_defaults($dcdom);
6775: if (ref($domdef{'adhocroles'}) eq 'HASH') {
6776: if (ref($domdef{'adhocroles'}{$rolename}) eq 'HASH') {
6777: &appenv({'request.role.desc' => $domdef{'adhocroles'}{$rolename}{'desc'},});
6778: }
6779: }
6780: } else {
6781: &standard_roleprivs(\%rolehash,$role,$dcdom,$spec,$pickedcourse,$area);
6782: }
6783: my ($author,$adv,$rar)= &set_userprivs(\%userroles,\%rolehash);
6784: &appenv(\%userroles,[$role,'cm']);
6785: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},"Role ".$spec);
6786: unless (($caller eq 'constructaccess' && $env{'request.course.id'}) ||
6787: ($caller eq 'tiny')) {
6788: &appenv( {'request.role' => $spec,
6789: 'request.role.domain' => $dcdom,
6790: 'request.course.sec' => $sec,
6791: }
6792: );
6793: my $tadv=0;
6794: if (&allowed('adv') eq 'F') { $tadv=1; }
6795: &appenv({'request.role.adv' => $tadv});
6796: }
6797: }
6798:
6799: # --------------------------------------------------------------- get interface
6800:
6801: sub get {
6802: my ($namespace,$storearr,$udomain,$uname)=@_;
6803: my $items='';
6804: foreach my $item (@$storearr) {
6805: $items.=&escape($item).'&';
6806: }
6807: $items=~s/\&$//;
6808: if (!$udomain) { $udomain=$env{'user.domain'}; }
6809: if (!$uname) { $uname=$env{'user.name'}; }
6810: my $uhome=&homeserver($uname,$udomain);
6811:
6812: my $rep=&reply("get:$udomain:$uname:$namespace:$items",$uhome);
6813: my @pairs=split(/\&/,$rep);
6814: if ( $#pairs==0 && $pairs[0] =~ /^(con_lost|error|no_such_host)/i) {
6815: return @pairs;
6816: }
6817: my %returnhash=();
6818: my $i=0;
6819: foreach my $item (@$storearr) {
6820: $returnhash{$item}=&thaw_unescape($pairs[$i]);
6821: $i++;
6822: }
6823: return %returnhash;
6824: }
6825:
6826: # --------------------------------------------------------------- del interface
6827:
6828: sub del {
6829: my ($namespace,$storearr,$udomain,$uname)=@_;
6830: my $items='';
6831: foreach my $item (@$storearr) {
6832: $items.=&escape($item).'&';
6833: }
6834:
6835: $items=~s/\&$//;
6836: if (!$udomain) { $udomain=$env{'user.domain'}; }
6837: if (!$uname) { $uname=$env{'user.name'}; }
6838: my $uhome=&homeserver($uname,$udomain);
6839: return &reply("del:$udomain:$uname:$namespace:$items",$uhome);
6840: }
6841:
6842: # -------------------------------------------------------------- dump interface
6843:
6844: sub unserialize {
6845: my ($rep, $escapedkeys) = @_;
6846:
6847: return {} if $rep =~ /^error/;
6848:
6849: my %returnhash=();
6850: foreach my $item (split(/\&/,$rep)) {
6851: my ($key, $value) = split(/=/, $item, 2);
6852: $key = unescape($key) unless $escapedkeys;
6853: next if $key =~ /^error: 2 /;
6854: $returnhash{$key} = &thaw_unescape($value);
6855: }
6856: #return %returnhash;
6857: return \%returnhash;
6858: }
6859:
6860: # see Lond::dump_with_regexp
6861: # if $escapedkeys hash keys won't get unescaped.
6862: sub dump {
6863: my ($namespace,$udomain,$uname,$regexp,$range,$escapedkeys)=@_;
6864: if (!$udomain) { $udomain=$env{'user.domain'}; }
6865: if (!$uname) { $uname=$env{'user.name'}; }
6866: my $uhome=&homeserver($uname,$udomain);
6867:
6868: if ($regexp) {
6869: $regexp=&escape($regexp);
6870: } else {
6871: $regexp='.';
6872: }
6873: if (grep { $_ eq $uhome } current_machine_ids()) {
6874: # user is hosted on this machine
6875: my $reply = LONCAPA::Lond::dump_with_regexp(join(":", ($udomain,
6876: $uname, $namespace, $regexp, $range)), $perlvar{'lonVersion'});
6877: return %{unserialize($reply, $escapedkeys)};
6878: }
6879: my $rep=&reply("dump:$udomain:$uname:$namespace:$regexp:$range",$uhome);
6880: my @pairs=split(/\&/,$rep);
6881: my %returnhash=();
6882: if (!($rep =~ /^error/ )) {
6883: foreach my $item (@pairs) {
6884: my ($key,$value)=split(/=/,$item,2);
6885: $key = unescape($key) unless $escapedkeys;
6886: #$key = &unescape($key);
6887: next if ($key =~ /^error: 2 /);
6888: $returnhash{$key}=&thaw_unescape($value);
6889: }
6890: }
6891: return %returnhash;
6892: }
6893:
6894:
6895: # --------------------------------------------------------- dumpstore interface
6896:
6897: sub dumpstore {
6898: my ($namespace,$udomain,$uname,$regexp,$range)=@_;
6899: # same as dump but keys must be escaped. They may contain colon separated
6900: # lists of values that may themself contain colons (e.g. symbs).
6901: return &dump($namespace, $udomain, $uname, $regexp, $range, 1);
6902: }
6903:
6904: # -------------------------------------------------------------- keys interface
6905:
6906: sub getkeys {
6907: my ($namespace,$udomain,$uname)=@_;
6908: if (!$udomain) { $udomain=$env{'user.domain'}; }
6909: if (!$uname) { $uname=$env{'user.name'}; }
6910: my $uhome=&homeserver($uname,$udomain);
6911: my $rep=reply("keys:$udomain:$uname:$namespace",$uhome);
6912: my @keyarray=();
6913: foreach my $key (split(/\&/,$rep)) {
6914: next if ($key =~ /^error: 2 /);
6915: push(@keyarray,&unescape($key));
6916: }
6917: return @keyarray;
6918: }
6919:
6920: # --------------------------------------------------------------- currentdump
6921: sub currentdump {
6922: my ($courseid,$sdom,$sname)=@_;
6923: $courseid = $env{'request.course.id'} if (! defined($courseid));
6924: $sdom = $env{'user.domain'} if (! defined($sdom));
6925: $sname = $env{'user.name'} if (! defined($sname));
6926: my $uhome = &homeserver($sname,$sdom);
6927: my $rep;
6928:
6929: if (grep { $_ eq $uhome } current_machine_ids()) {
6930: $rep = LONCAPA::Lond::dump_profile_database(join(":", ($sdom, $sname,
6931: $courseid)));
6932: } else {
6933: $rep = reply('currentdump:'.$sdom.':'.$sname.':'.$courseid,$uhome);
6934: }
6935:
6936: return if ($rep =~ /^(error:|no_such_host)/);
6937: #
6938: my %returnhash=();
6939: #
6940: if ($rep eq 'unknown_cmd') {
6941: # an old lond will not know currentdump
6942: # Do a dump and make it look like a currentdump
6943: my @tmp = &dumpstore($courseid,$sdom,$sname,'.');
6944: return if ($tmp[0] =~ /^(error:|no_such_host)/);
6945: my %hash = @tmp;
6946: @tmp=();
6947: %returnhash = %{&convert_dump_to_currentdump(\%hash)};
6948: } else {
6949: my @pairs=split(/\&/,$rep);
6950: foreach my $pair (@pairs) {
6951: my ($key,$value)=split(/=/,$pair,2);
6952: my ($symb,$param) = split(/:/,$key);
6953: $returnhash{&unescape($symb)}->{&unescape($param)} =
6954: &thaw_unescape($value);
6955: }
6956: }
6957: return %returnhash;
6958: }
6959:
6960: sub convert_dump_to_currentdump{
6961: my %hash = %{shift()};
6962: my %returnhash;
6963: # Code ripped from lond, essentially. The only difference
6964: # here is the unescaping done by lonnet::dump(). Conceivably
6965: # we might run in to problems with parameter names =~ /^v\./
6966: while (my ($key,$value) = each(%hash)) {
6967: my ($v,$symb,$param) = split(/:/,$key);
6968: $symb = &unescape($symb);
6969: $param = &unescape($param);
6970: next if ($v eq 'version' || $symb eq 'keys');
6971: next if (exists($returnhash{$symb}) &&
6972: exists($returnhash{$symb}->{$param}) &&
6973: $returnhash{$symb}->{'v.'.$param} > $v);
6974: $returnhash{$symb}->{$param}=$value;
6975: $returnhash{$symb}->{'v.'.$param}=$v;
6976: }
6977: #
6978: # Remove all of the keys in the hashes which keep track of
6979: # the version of the parameter.
6980: while (my ($symb,$param_hash) = each(%returnhash)) {
6981: # use a foreach because we are going to delete from the hash.
6982: foreach my $key (keys(%$param_hash)) {
6983: delete($param_hash->{$key}) if ($key =~ /^v\./);
6984: }
6985: }
6986: return \%returnhash;
6987: }
6988:
6989: # ------------------------------------------------------ critical inc interface
6990:
6991: sub cinc {
6992: return &inc(@_,'critical');
6993: }
6994:
6995: # --------------------------------------------------------------- inc interface
6996:
6997: sub inc {
6998: my ($namespace,$store,$udomain,$uname,$critical) = @_;
6999: if (!$udomain) { $udomain=$env{'user.domain'}; }
7000: if (!$uname) { $uname=$env{'user.name'}; }
7001: my $uhome=&homeserver($uname,$udomain);
7002: my $items='';
7003: if (! ref($store)) {
7004: # got a single value, so use that instead
7005: $items = &escape($store).'=&';
7006: } elsif (ref($store) eq 'SCALAR') {
7007: $items = &escape($$store).'=&';
7008: } elsif (ref($store) eq 'ARRAY') {
7009: $items = join('=&',map {&escape($_);} @{$store});
7010: } elsif (ref($store) eq 'HASH') {
7011: while (my($key,$value) = each(%{$store})) {
7012: $items.= &escape($key).'='.&escape($value).'&';
7013: }
7014: }
7015: $items=~s/\&$//;
7016: if ($critical) {
7017: return &critical("inc:$udomain:$uname:$namespace:$items",$uhome);
7018: } else {
7019: return &reply("inc:$udomain:$uname:$namespace:$items",$uhome);
7020: }
7021: }
7022:
7023: # --------------------------------------------------------------- put interface
7024:
7025: sub put {
7026: my ($namespace,$storehash,$udomain,$uname)=@_;
7027: if (!$udomain) { $udomain=$env{'user.domain'}; }
7028: if (!$uname) { $uname=$env{'user.name'}; }
7029: my $uhome=&homeserver($uname,$udomain);
7030: my $items='';
7031: foreach my $item (keys(%$storehash)) {
7032: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
7033: }
7034: $items=~s/\&$//;
7035: return &reply("put:$udomain:$uname:$namespace:$items",$uhome);
7036: }
7037:
7038: # ------------------------------------------------------------ newput interface
7039:
7040: sub newput {
7041: my ($namespace,$storehash,$udomain,$uname)=@_;
7042: if (!$udomain) { $udomain=$env{'user.domain'}; }
7043: if (!$uname) { $uname=$env{'user.name'}; }
7044: my $uhome=&homeserver($uname,$udomain);
7045: my $items='';
7046: foreach my $key (keys(%$storehash)) {
7047: $items.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
7048: }
7049: $items=~s/\&$//;
7050: return &reply("newput:$udomain:$uname:$namespace:$items",$uhome);
7051: }
7052:
7053: # --------------------------------------------------------- putstore interface
7054:
7055: sub putstore {
7056: my ($namespace,$symb,$version,$storehash,$udomain,$uname,$tolog)=@_;
7057: if (!$udomain) { $udomain=$env{'user.domain'}; }
7058: if (!$uname) { $uname=$env{'user.name'}; }
7059: my $uhome=&homeserver($uname,$udomain);
7060: my $items='';
7061: foreach my $key (keys(%$storehash)) {
7062: $items.= &escape($key).'='.&freeze_escape($storehash->{$key}).'&';
7063: }
7064: $items=~s/\&$//;
7065: my $esc_symb=&escape($symb);
7066: my $esc_v=&escape($version);
7067: my $reply =
7068: &reply("putstore:$udomain:$uname:$namespace:$esc_symb:$esc_v:$items",
7069: $uhome);
7070: if (($tolog) && ($reply eq 'ok')) {
7071: my $namevalue='';
7072: foreach my $key (keys(%{$storehash})) {
7073: $namevalue.=&escape($key).'='.&freeze_escape($storehash->{$key}).'&';
7074: }
7075: $namevalue .= 'ip='.&escape($ENV{'REMOTE_ADDR'}).
7076: '&host='.&escape($perlvar{'lonHostID'}).
7077: '&version='.$esc_v.
7078: '&by='.&escape($env{'user.name'}.':'.$env{'user.domain'});
7079: &Apache::lonnet::courselog($symb.':'.$uname.':'.$udomain.':PUTSTORE:'.$namevalue);
7080: }
7081: if ($reply eq 'unknown_cmd') {
7082: # gfall back to way things use to be done
7083: return &old_putstore($namespace,$symb,$version,$storehash,$udomain,
7084: $uname);
7085: }
7086: return $reply;
7087: }
7088:
7089: sub old_putstore {
7090: my ($namespace,$symb,$version,$storehash,$udomain,$uname)=@_;
7091: if (!$udomain) { $udomain=$env{'user.domain'}; }
7092: if (!$uname) { $uname=$env{'user.name'}; }
7093: my $uhome=&homeserver($uname,$udomain);
7094: my %newstorehash;
7095: foreach my $item (keys(%$storehash)) {
7096: my $key = $version.':'.&escape($symb).':'.$item;
7097: $newstorehash{$key} = $storehash->{$item};
7098: }
7099: my $items='';
7100: my %allitems = ();
7101: foreach my $item (keys(%newstorehash)) {
7102: if ($item =~ m/^([^\:]+):([^\:]+):([^\:]+)$/) {
7103: my $key = $1.':keys:'.$2;
7104: $allitems{$key} .= $3.':';
7105: }
7106: $items.=$item.'='.&freeze_escape($newstorehash{$item}).'&';
7107: }
7108: foreach my $item (keys(%allitems)) {
7109: $allitems{$item} =~ s/\:$//;
7110: $items.= $item.'='.$allitems{$item}.'&';
7111: }
7112: $items=~s/\&$//;
7113: return &reply("put:$udomain:$uname:$namespace:$items",$uhome);
7114: }
7115:
7116: # ------------------------------------------------------ critical put interface
7117:
7118: sub cput {
7119: my ($namespace,$storehash,$udomain,$uname)=@_;
7120: if (!$udomain) { $udomain=$env{'user.domain'}; }
7121: if (!$uname) { $uname=$env{'user.name'}; }
7122: my $uhome=&homeserver($uname,$udomain);
7123: my $items='';
7124: foreach my $item (keys(%$storehash)) {
7125: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
7126: }
7127: $items=~s/\&$//;
7128: return &critical("put:$udomain:$uname:$namespace:$items",$uhome);
7129: }
7130:
7131: # -------------------------------------------------------------- eget interface
7132:
7133: sub eget {
7134: my ($namespace,$storearr,$udomain,$uname)=@_;
7135: my $items='';
7136: foreach my $item (@$storearr) {
7137: $items.=&escape($item).'&';
7138: }
7139: $items=~s/\&$//;
7140: if (!$udomain) { $udomain=$env{'user.domain'}; }
7141: if (!$uname) { $uname=$env{'user.name'}; }
7142: my $uhome=&homeserver($uname,$udomain);
7143: my $rep=&reply("eget:$udomain:$uname:$namespace:$items",$uhome);
7144: my @pairs=split(/\&/,$rep);
7145: my %returnhash=();
7146: my $i=0;
7147: foreach my $item (@$storearr) {
7148: $returnhash{$item}=&thaw_unescape($pairs[$i]);
7149: $i++;
7150: }
7151: return %returnhash;
7152: }
7153:
7154: # ------------------------------------------------------------ tmpput interface
7155: sub tmpput {
7156: my ($storehash,$server,$context)=@_;
7157: my $items='';
7158: foreach my $item (keys(%$storehash)) {
7159: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
7160: }
7161: $items=~s/\&$//;
7162: if (defined($context)) {
7163: $items .= ':'.&escape($context);
7164: }
7165: return &reply("tmpput:$items",$server);
7166: }
7167:
7168: # ------------------------------------------------------------ tmpget interface
7169: sub tmpget {
7170: my ($token,$server)=@_;
7171: if (!defined($server)) { $server = $perlvar{'lonHostID'}; }
7172: my $rep=&reply("tmpget:$token",$server);
7173: my %returnhash;
7174: if ($rep =~ /^(con_lost|error|no_such_host)/i) {
7175: return %returnhash;
7176: }
7177: foreach my $item (split(/\&/,$rep)) {
7178: my ($key,$value)=split(/=/,$item);
7179: $returnhash{&unescape($key)}=&thaw_unescape($value);
7180: }
7181: return %returnhash;
7182: }
7183:
7184: # ------------------------------------------------------------ tmpdel interface
7185: sub tmpdel {
7186: my ($token,$server)=@_;
7187: if (!defined($server)) { $server = $perlvar{'lonHostID'}; }
7188: return &reply("tmpdel:$token",$server);
7189: }
7190:
7191: # ------------------------------------------------------------ get_timebased_id
7192:
7193: sub get_timebased_id {
7194: my ($prefix,$keyid,$namespace,$cdom,$cnum,$idtype,$who,$locktries,
7195: $maxtries) = @_;
7196: my ($newid,$error,$dellock);
7197: unless (($prefix =~ /^\w+$/) && ($keyid =~ /^\w+$/) && ($namespace ne '')) {
7198: return ('','ok','invalid call to get suffix');
7199: }
7200:
7201: # set defaults for any optional args for which values were not supplied
7202: if ($who eq '') {
7203: $who = $env{'user.name'}.':'.$env{'user.domain'};
7204: }
7205: if (!$locktries) {
7206: $locktries = 3;
7207: }
7208: if (!$maxtries) {
7209: $maxtries = 10;
7210: }
7211:
7212: if (($cdom eq '') || ($cnum eq '')) {
7213: if ($env{'request.course.id'}) {
7214: $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
7215: $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
7216: }
7217: if (($cdom eq '') || ($cnum eq '')) {
7218: return ('','ok','call to get suffix not in course context');
7219: }
7220: }
7221:
7222: # construct locking item
7223: my $lockhash = {
7224: $prefix."\0".'locked_'.$keyid => $who,
7225: };
7226: my $tries = 0;
7227:
7228: # attempt to get lock on nohist_$namespace file
7229: my $gotlock = &Apache::lonnet::newput('nohist_'.$namespace,$lockhash,$cdom,$cnum);
7230: while (($gotlock ne 'ok') && $tries <$locktries) {
7231: $tries ++;
7232: sleep 1;
7233: $gotlock = &Apache::lonnet::newput('nohist_'.$namespace,$lockhash,$cdom,$cnum);
7234: }
7235:
7236: # attempt to get unique identifier, based on current timestamp
7237: if ($gotlock eq 'ok') {
7238: my %inuse = &Apache::lonnet::dump('nohist_'.$namespace,$cdom,$cnum,$prefix);
7239: my $id = time;
7240: $newid = $id;
7241: if ($idtype eq 'addcode') {
7242: $newid .= &sixnum_code();
7243: }
7244: my $idtries = 0;
7245: while (exists($inuse{$prefix."\0".$newid}) && $idtries < $maxtries) {
7246: if ($idtype eq 'concat') {
7247: $newid = $id.$idtries;
7248: } elsif ($idtype eq 'addcode') {
7249: $newid = $newid.&sixnum_code();
7250: } else {
7251: $newid ++;
7252: }
7253: $idtries ++;
7254: }
7255: if (!exists($inuse{$prefix."\0".$newid})) {
7256: my %new_item = (
7257: $prefix."\0".$newid => $who,
7258: );
7259: my $putresult = &Apache::lonnet::put('nohist_'.$namespace,\%new_item,
7260: $cdom,$cnum);
7261: if ($putresult ne 'ok') {
7262: undef($newid);
7263: $error = 'error saving new item: '.$putresult;
7264: }
7265: } else {
7266: undef($newid);
7267: $error = ('error: no unique suffix available for the new item ');
7268: }
7269: # remove lock
7270: my @del_lock = ($prefix."\0".'locked_'.$keyid);
7271: $dellock = &Apache::lonnet::del('nohist_'.$namespace,\@del_lock,$cdom,$cnum);
7272: } else {
7273: $error = "error: could not obtain lockfile\n";
7274: $dellock = 'ok';
7275: if (($prefix eq 'paste') && ($namespace eq 'courseeditor') && ($keyid eq 'num')) {
7276: $dellock = 'nolock';
7277: }
7278: }
7279: return ($newid,$dellock,$error);
7280: }
7281:
7282: sub sixnum_code {
7283: my $code;
7284: for (0..6) {
7285: $code .= int( rand(9) );
7286: }
7287: return $code;
7288: }
7289:
7290: # -------------------------------------------------- portfolio access checking
7291:
7292: sub portfolio_access {
7293: my ($requrl,$clientip) = @_;
7294: my (undef,$udom,$unum,$file_name,$group) = &parse_portfolio_url($requrl);
7295: my $result = &get_portfolio_access($udom,$unum,$file_name,$group,$clientip);
7296: if ($result) {
7297: my %setters;
7298: if ($env{'user.name'} eq 'public' && $env{'user.domain'} eq 'public') {
7299: my ($startblock,$endblock) =
7300: &Apache::loncommon::blockcheck(\%setters,'port',$unum,$udom);
7301: if ($startblock && $endblock) {
7302: return 'B';
7303: }
7304: } else {
7305: my ($startblock,$endblock) =
7306: &Apache::loncommon::blockcheck(\%setters,'port');
7307: if ($startblock && $endblock) {
7308: return 'B';
7309: }
7310: }
7311: }
7312: if ($result eq 'ok') {
7313: return 'F';
7314: } elsif ($result =~ /^[^:]+:guest_/) {
7315: return 'A';
7316: }
7317: return '';
7318: }
7319:
7320: sub get_portfolio_access {
7321: my ($udom,$unum,$file_name,$group,$clientip,$access_hash) = @_;
7322:
7323: if (!ref($access_hash)) {
7324: my $current_perms = &get_portfile_permissions($udom,$unum);
7325: my %access_controls = &get_access_controls($current_perms,$group,
7326: $file_name);
7327: $access_hash = $access_controls{$file_name};
7328: }
7329:
7330: my ($public,$guest,@domains,@users,@courses,@groups,@ips);
7331: my $now = time;
7332: if (ref($access_hash) eq 'HASH') {
7333: foreach my $key (keys(%{$access_hash})) {
7334: my ($num,$scope,$end,$start) = ($key =~ /^([^:]+):([a-z]+)_(\d*)_?(\d*)$/);
7335: if ($start > $now) {
7336: next;
7337: }
7338: if ($end && $end<$now) {
7339: next;
7340: }
7341: if ($scope eq 'public') {
7342: $public = $key;
7343: last;
7344: } elsif ($scope eq 'guest') {
7345: $guest = $key;
7346: } elsif ($scope eq 'domains') {
7347: push(@domains,$key);
7348: } elsif ($scope eq 'users') {
7349: push(@users,$key);
7350: } elsif ($scope eq 'course') {
7351: push(@courses,$key);
7352: } elsif ($scope eq 'group') {
7353: push(@groups,$key);
7354: } elsif ($scope eq 'ip') {
7355: push(@ips,$key);
7356: }
7357: }
7358: if ($public) {
7359: return 'ok';
7360: } elsif (@ips > 0) {
7361: my $allowed;
7362: foreach my $ipkey (@ips) {
7363: if (ref($access_hash->{$ipkey}{'ip'}) eq 'ARRAY') {
7364: if (&Apache::loncommon::check_ip_acc(join(',',@{$access_hash->{$ipkey}{'ip'}}),$clientip)) {
7365: $allowed = 1;
7366: last;
7367: }
7368: }
7369: }
7370: if ($allowed) {
7371: return 'ok';
7372: }
7373: }
7374: if ($env{'user.name'} eq 'public' && $env{'user.domain'} eq 'public') {
7375: if ($guest) {
7376: return $guest;
7377: }
7378: } else {
7379: if (@domains > 0) {
7380: foreach my $domkey (@domains) {
7381: if (ref($access_hash->{$domkey}{'dom'}) eq 'ARRAY') {
7382: if (grep(/^\Q$env{'user.domain'}\E$/,@{$access_hash->{$domkey}{'dom'}})) {
7383: return 'ok';
7384: }
7385: }
7386: }
7387: }
7388: if (@users > 0) {
7389: foreach my $userkey (@users) {
7390: if (ref($access_hash->{$userkey}{'users'}) eq 'ARRAY') {
7391: foreach my $item (@{$access_hash->{$userkey}{'users'}}) {
7392: if (ref($item) eq 'HASH') {
7393: if (($item->{'uname'} eq $env{'user.name'}) &&
7394: ($item->{'udom'} eq $env{'user.domain'})) {
7395: return 'ok';
7396: }
7397: }
7398: }
7399: }
7400: }
7401: }
7402: my %roleshash;
7403: my @courses_and_groups = @courses;
7404: push(@courses_and_groups,@groups);
7405: if (@courses_and_groups > 0) {
7406: my (%allgroups,%allroles);
7407: my ($start,$end,$role,$sec,$group);
7408: foreach my $envkey (%env) {
7409: if ($envkey =~ m-^user\.role\.(gr|cc|co|in|ta|ep|ad|st)\./($match_domain)/($match_courseid)/?([^/]*)$-) {
7410: my $cid = $2.'_'.$3;
7411: if ($1 eq 'gr') {
7412: $group = $4;
7413: $allgroups{$cid}{$group} = $env{$envkey};
7414: } else {
7415: if ($4 eq '') {
7416: $sec = 'none';
7417: } else {
7418: $sec = $4;
7419: }
7420: $allroles{$cid}{$1}{$sec} = $env{$envkey};
7421: }
7422: } elsif ($envkey =~ m-^user\.role\./cr/($match_domain/$match_username/\w*)./($match_domain)/($match_courseid)/?([^/]*)$-) {
7423: my $cid = $2.'_'.$3;
7424: if ($4 eq '') {
7425: $sec = 'none';
7426: } else {
7427: $sec = $4;
7428: }
7429: $allroles{$cid}{$1}{$sec} = $env{$envkey};
7430: }
7431: }
7432: if (keys(%allroles) == 0) {
7433: return;
7434: }
7435: foreach my $key (@courses_and_groups) {
7436: my %content = %{$$access_hash{$key}};
7437: my $cnum = $content{'number'};
7438: my $cdom = $content{'domain'};
7439: my $cid = $cdom.'_'.$cnum;
7440: if (!exists($allroles{$cid})) {
7441: next;
7442: }
7443: foreach my $role_id (keys(%{$content{'roles'}})) {
7444: my @sections = @{$content{'roles'}{$role_id}{'section'}};
7445: my @groups = @{$content{'roles'}{$role_id}{'group'}};
7446: my @status = @{$content{'roles'}{$role_id}{'access'}};
7447: my @roles = @{$content{'roles'}{$role_id}{'role'}};
7448: foreach my $role (keys(%{$allroles{$cid}})) {
7449: if ((grep/^all$/,@roles) || (grep/^\Q$role\E$/,@roles)) {
7450: foreach my $sec (keys(%{$allroles{$cid}{$role}})) {
7451: if (&course_group_datechecker($allroles{$cid}{$role}{$sec},$now,\@status) eq 'ok') {
7452: if (grep/^all$/,@sections) {
7453: return 'ok';
7454: } else {
7455: if (grep/^$sec$/,@sections) {
7456: return 'ok';
7457: }
7458: }
7459: }
7460: }
7461: if (keys(%{$allgroups{$cid}}) == 0) {
7462: if (grep/^none$/,@groups) {
7463: return 'ok';
7464: }
7465: } else {
7466: if (grep/^all$/,@groups) {
7467: return 'ok';
7468: }
7469: foreach my $group (keys(%{$allgroups{$cid}})) {
7470: if (grep/^$group$/,@groups) {
7471: return 'ok';
7472: }
7473: }
7474: }
7475: }
7476: }
7477: }
7478: }
7479: }
7480: if ($guest) {
7481: return $guest;
7482: }
7483: }
7484: }
7485: return;
7486: }
7487:
7488: sub course_group_datechecker {
7489: my ($dates,$now,$status) = @_;
7490: my ($start,$end) = split(/\./,$dates);
7491: if (!$start && !$end) {
7492: return 'ok';
7493: }
7494: if (grep/^active$/,@{$status}) {
7495: if (((!$start) || ($start && $start <= $now)) && ((!$end) || ($end && $end >= $now))) {
7496: return 'ok';
7497: }
7498: }
7499: if (grep/^previous$/,@{$status}) {
7500: if ($end > $now ) {
7501: return 'ok';
7502: }
7503: }
7504: if (grep/^future$/,@{$status}) {
7505: if ($start > $now) {
7506: return 'ok';
7507: }
7508: }
7509: return;
7510: }
7511:
7512: sub parse_portfolio_url {
7513: my ($url) = @_;
7514:
7515: my ($type,$udom,$unum,$group,$file_name);
7516:
7517: if ($url =~ m-^/*(?:uploaded|editupload)/($match_domain)/($match_username)/portfolio(/.+)$-) {
7518: $type = 1;
7519: $udom = $1;
7520: $unum = $2;
7521: $file_name = $3;
7522: } elsif ($url =~ m-^/*(?:uploaded|editupload)/($match_domain)/($match_courseid)/groups/([^/]+)/portfolio/(.+)$-) {
7523: $type = 2;
7524: $udom = $1;
7525: $unum = $2;
7526: $group = $3;
7527: $file_name = $3.'/'.$4;
7528: }
7529: if (wantarray) {
7530: return ($type,$udom,$unum,$file_name,$group);
7531: }
7532: return $type;
7533: }
7534:
7535: sub is_portfolio_url {
7536: my ($url) = @_;
7537: return scalar(&parse_portfolio_url($url));
7538: }
7539:
7540: sub is_portfolio_file {
7541: my ($file) = @_;
7542: if (($file =~ /^portfolio/) || ($file =~ /^groups\/\w+\/portfolio/)) {
7543: return 1;
7544: }
7545: return;
7546: }
7547:
7548: sub usertools_access {
7549: my ($uname,$udom,$tool,$action,$context,$userenvref,$domdefref,$is_advref)=@_;
7550: my ($access,%tools);
7551: if ($context eq '') {
7552: $context = 'tools';
7553: }
7554: if ($context eq 'requestcourses') {
7555: %tools = (
7556: official => 1,
7557: unofficial => 1,
7558: community => 1,
7559: textbook => 1,
7560: placement => 1,
7561: lti => 1,
7562: );
7563: } elsif ($context eq 'requestauthor') {
7564: %tools = (
7565: requestauthor => 1,
7566: );
7567: } else {
7568: %tools = (
7569: aboutme => 1,
7570: blog => 1,
7571: webdav => 1,
7572: portfolio => 1,
7573: );
7574: }
7575: return if (!defined($tools{$tool}));
7576:
7577: if (($udom eq '') || ($uname eq '')) {
7578: $udom = $env{'user.domain'};
7579: $uname = $env{'user.name'};
7580: }
7581:
7582: if (($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'})) {
7583: if ($action ne 'reload') {
7584: if ($context eq 'requestcourses') {
7585: return $env{'environment.canrequest.'.$tool};
7586: } elsif ($context eq 'requestauthor') {
7587: return $env{'environment.canrequest.author'};
7588: } else {
7589: return $env{'environment.availabletools.'.$tool};
7590: }
7591: }
7592: }
7593:
7594: my ($toolstatus,$inststatus,$envkey);
7595: if ($context eq 'requestauthor') {
7596: $envkey = $context;
7597: } else {
7598: $envkey = $context.'.'.$tool;
7599: }
7600:
7601: if (($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'}) &&
7602: ($action ne 'reload')) {
7603: $toolstatus = $env{'environment.'.$envkey};
7604: $inststatus = $env{'environment.inststatus'};
7605: } else {
7606: if (ref($userenvref) eq 'HASH') {
7607: $toolstatus = $userenvref->{$envkey};
7608: $inststatus = $userenvref->{'inststatus'};
7609: } else {
7610: my %userenv = &userenvironment($udom,$uname,$envkey,'inststatus');
7611: $toolstatus = $userenv{$envkey};
7612: $inststatus = $userenv{'inststatus'};
7613: }
7614: }
7615:
7616: if ($toolstatus ne '') {
7617: if ($toolstatus) {
7618: $access = 1;
7619: } else {
7620: $access = 0;
7621: }
7622: return $access;
7623: }
7624:
7625: my ($is_adv,%domdef);
7626: if (ref($is_advref) eq 'HASH') {
7627: $is_adv = $is_advref->{'is_adv'};
7628: } else {
7629: $is_adv = &is_advanced_user($udom,$uname);
7630: }
7631: if (ref($domdefref) eq 'HASH') {
7632: %domdef = %{$domdefref};
7633: } else {
7634: %domdef = &get_domain_defaults($udom);
7635: }
7636: if (ref($domdef{$tool}) eq 'HASH') {
7637: if ($is_adv) {
7638: if ($domdef{$tool}{'_LC_adv'} ne '') {
7639: if ($domdef{$tool}{'_LC_adv'}) {
7640: $access = 1;
7641: } else {
7642: $access = 0;
7643: }
7644: return $access;
7645: }
7646: }
7647: if ($inststatus ne '') {
7648: my ($hasaccess,$hasnoaccess);
7649: foreach my $affiliation (split(/:/,$inststatus)) {
7650: if ($domdef{$tool}{$affiliation} ne '') {
7651: if ($domdef{$tool}{$affiliation}) {
7652: $hasaccess = 1;
7653: } else {
7654: $hasnoaccess = 1;
7655: }
7656: }
7657: }
7658: if ($hasaccess || $hasnoaccess) {
7659: if ($hasaccess) {
7660: $access = 1;
7661: } elsif ($hasnoaccess) {
7662: $access = 0;
7663: }
7664: return $access;
7665: }
7666: } else {
7667: if ($domdef{$tool}{'default'} ne '') {
7668: if ($domdef{$tool}{'default'}) {
7669: $access = 1;
7670: } elsif ($domdef{$tool}{'default'} == 0) {
7671: $access = 0;
7672: }
7673: return $access;
7674: }
7675: }
7676: } else {
7677: if (($context eq 'tools') && ($tool ne 'webdav')) {
7678: $access = 1;
7679: } else {
7680: $access = 0;
7681: }
7682: return $access;
7683: }
7684: }
7685:
7686: sub is_course_owner {
7687: my ($cdom,$cnum,$udom,$uname) = @_;
7688: if (($udom eq '') || ($uname eq '')) {
7689: $udom = $env{'user.domain'};
7690: $uname = $env{'user.name'};
7691: }
7692: unless (($udom eq '') || ($uname eq '')) {
7693: if (exists($env{'course.'.$cdom.'_'.$cnum.'.internal.courseowner'})) {
7694: if ($env{'course.'.$cdom.'_'.$cnum.'.internal.courseowner'} eq $uname.':'.$udom) {
7695: return 1;
7696: } else {
7697: my %courseinfo = &Apache::lonnet::coursedescription($cdom.'/'.$cnum);
7698: if ($courseinfo{'internal.courseowner'} eq $uname.':'.$udom) {
7699: return 1;
7700: }
7701: }
7702: }
7703: }
7704: return;
7705: }
7706:
7707: sub is_advanced_user {
7708: my ($udom,$uname) = @_;
7709: if ($udom ne '' && $uname ne '') {
7710: if (($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'})) {
7711: if (wantarray) {
7712: return ($env{'user.adv'},$env{'user.author'});
7713: } else {
7714: return $env{'user.adv'};
7715: }
7716: }
7717: }
7718: my %roleshash = &get_my_roles($uname,$udom,'userroles',undef,undef,undef,1);
7719: my %allroles;
7720: my ($is_adv,$is_author);
7721: foreach my $role (keys(%roleshash)) {
7722: my ($trest,$tdomain,$trole,$sec) = split(/:/,$role);
7723: my $area = '/'.$tdomain.'/'.$trest;
7724: if ($sec ne '') {
7725: $area .= '/'.$sec;
7726: }
7727: if (($area ne '') && ($trole ne '')) {
7728: my $spec=$trole.'.'.$area;
7729: if ($trole =~ /^cr\//) {
7730: &custom_roleprivs(\%allroles,$trole,$tdomain,$trest,$spec,$area);
7731: } elsif ($trole ne 'gr') {
7732: &standard_roleprivs(\%allroles,$trole,$tdomain,$spec,$trest,$area);
7733: }
7734: if ($trole eq 'au') {
7735: $is_author = 1;
7736: }
7737: }
7738: }
7739: foreach my $role (keys(%allroles)) {
7740: last if ($is_adv);
7741: foreach my $item (split(/:/,$allroles{$role})) {
7742: if ($item ne '') {
7743: my ($privilege,$restrictions)=split(/&/,$item);
7744: if ($privilege eq 'adv') {
7745: $is_adv = 1;
7746: last;
7747: }
7748: }
7749: }
7750: }
7751: if (wantarray) {
7752: return ($is_adv,$is_author);
7753: }
7754: return $is_adv;
7755: }
7756:
7757: sub check_can_request {
7758: my ($dom,$can_request,$request_domains,$uname,$udom) = @_;
7759: my $canreq = 0;
7760: if (($env{'user.name'} ne '') && ($env{'user.domain'} ne '')) {
7761: $uname = $env{'user.name'};
7762: $udom = $env{'user.domain'};
7763: }
7764: my ($types,$typename) = &Apache::loncommon::course_types();
7765: my @options = ('approval','validate','autolimit');
7766: my $optregex = join('|',@options);
7767: if ((ref($can_request) eq 'HASH') && (ref($types) eq 'ARRAY')) {
7768: foreach my $type (@{$types}) {
7769: if (&usertools_access($uname,$udom,$type,undef,
7770: 'requestcourses')) {
7771: $canreq ++;
7772: if (ref($request_domains) eq 'HASH') {
7773: push(@{$request_domains->{$type}},$udom);
7774: }
7775: if ($dom eq $udom) {
7776: $can_request->{$type} = 1;
7777: }
7778: }
7779: if (($env{'user.name'} ne '') && ($env{'user.domain'} ne '') &&
7780: ($env{'environment.reqcrsotherdom.'.$type} ne '')) {
7781: my @curr = split(',',$env{'environment.reqcrsotherdom.'.$type});
7782: if (@curr > 0) {
7783: foreach my $item (@curr) {
7784: if (ref($request_domains) eq 'HASH') {
7785: my ($otherdom) = ($item =~ /^($match_domain):($optregex)(=?\d*)$/);
7786: if ($otherdom ne '') {
7787: if (ref($request_domains->{$type}) eq 'ARRAY') {
7788: unless (grep(/^\Q$otherdom\E$/,@{$request_domains->{$type}})) {
7789: push(@{$request_domains->{$type}},$otherdom);
7790: }
7791: } else {
7792: push(@{$request_domains->{$type}},$otherdom);
7793: }
7794: }
7795: }
7796: }
7797: unless ($dom eq $env{'user.domain'}) {
7798: $canreq ++;
7799: if (grep(/^\Q$dom\E:($optregex)(=?\d*)$/,@curr)) {
7800: $can_request->{$type} = 1;
7801: }
7802: }
7803: }
7804: }
7805: }
7806: }
7807: return $canreq;
7808: }
7809:
7810: # ---------------------------------------------- Custom access rule evaluation
7811:
7812: sub customaccess {
7813: my ($priv,$uri)=@_;
7814: my ($urole,$urealm)=split(/\./,$env{'request.role'},2);
7815: my (undef,$udom,$ucrs,$usec)=split(/\//,$urealm);
7816: $udom = &LONCAPA::clean_domain($udom);
7817: $ucrs = &LONCAPA::clean_username($ucrs);
7818: my $access=0;
7819: foreach my $right (split(/\s*\,\s*/,&metadata($uri,'rule_rights'))) {
7820: my ($effect,$realm,$role,$type)=split(/\:/,$right);
7821: if ($type eq 'user') {
7822: foreach my $scope (split(/\s*\,\s*/,$realm)) {
7823: my ($tdom,$tuname)=split(m{/},$scope);
7824: if ($tdom) {
7825: if ($tdom ne $env{'user.domain'}) { next; }
7826: }
7827: if ($tuname) {
7828: if ($tuname ne $env{'user.name'}) { next; }
7829: }
7830: $access=($effect eq 'allow');
7831: last;
7832: }
7833: } else {
7834: if ($role) {
7835: if ($role ne $urole) { next; }
7836: }
7837: foreach my $scope (split(/\s*\,\s*/,$realm)) {
7838: my ($tdom,$tcrs,$tsec)=split(/\_/,$scope);
7839: if ($tdom) {
7840: if ($tdom ne $udom) { next; }
7841: }
7842: if ($tcrs) {
7843: if ($tcrs ne $ucrs) { next; }
7844: }
7845: if ($tsec) {
7846: if ($tsec ne $usec) { next; }
7847: }
7848: $access=($effect eq 'allow');
7849: last;
7850: }
7851: if ($realm eq '' && $role eq '') {
7852: $access=($effect eq 'allow');
7853: }
7854: }
7855: }
7856: return $access;
7857: }
7858:
7859: # ------------------------------------------------- Check for a user privilege
7860:
7861: sub allowed {
7862: my ($priv,$uri,$symb,$role,$clientip,$noblockcheck)=@_;
7863: my $ver_orguri=$uri;
7864: $uri=&deversion($uri);
7865: my $orguri=$uri;
7866: $uri=&declutter($uri);
7867:
7868: if ($priv eq 'evb') {
7869: # Evade communication block restrictions for specified role in a course
7870: if ($env{'user.priv.'.$role} =~/evb\&([^\:]*)/) {
7871: return $1;
7872: } else {
7873: return;
7874: }
7875: }
7876:
7877: if (defined($env{'allowed.'.$priv})) { return $env{'allowed.'.$priv}; }
7878: # Free bre access to adm and meta resources
7879: if (((($uri=~/^adm\//) && ($uri !~ m{/(?:smppg|bulletinboard|ext\.tool)$}))
7880: || (($uri=~/\.meta$/) && ($uri!~m|^uploaded/|) ))
7881: && ($priv eq 'bre')) {
7882: return 'F';
7883: }
7884:
7885: # Free bre access to user's own portfolio contents
7886: my ($space,$domain,$name,@dir)=split('/',$uri);
7887: if (($space=~/^(uploaded|editupload)$/) && ($env{'user.name'} eq $name) &&
7888: ($env{'user.domain'} eq $domain) && ('portfolio' eq $dir[0])) {
7889: my %setters;
7890: my ($startblock,$endblock) =
7891: &Apache::loncommon::blockcheck(\%setters,'port');
7892: if ($startblock && $endblock) {
7893: return 'B';
7894: } else {
7895: return 'F';
7896: }
7897: }
7898:
7899: # bre access to group portfolio for rgf priv in group, or mdg or vcg in course.
7900: if (($space=~/^(uploaded|editupload)$/) && ($dir[0] eq 'groups')
7901: && ($dir[2] eq 'portfolio') && ($priv eq 'bre')) {
7902: if (exists($env{'request.course.id'})) {
7903: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
7904: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
7905: if (($domain eq $cdom) && ($name eq $cnum)) {
7906: my $courseprivid=$env{'request.course.id'};
7907: $courseprivid=~s/\_/\//;
7908: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid
7909: .'/'.$dir[1]} =~/rgf\&([^\:]*)/) {
7910: return $1;
7911: } else {
7912: if ($env{'request.course.sec'}) {
7913: $courseprivid.='/'.$env{'request.course.sec'};
7914: }
7915: if ($env{'user.priv.'.$env{'request.role'}.'./'.
7916: $courseprivid} =~/(mdg|vcg)\&([^\:]*)/) {
7917: return $2;
7918: }
7919: }
7920: }
7921: }
7922: }
7923:
7924: # Free bre to public access
7925:
7926: if ($priv eq 'bre') {
7927: my $copyright;
7928: unless ($uri =~ /ext\.tool/) {
7929: $copyright=&metadata($uri,'copyright');
7930: }
7931: if (($copyright eq 'public') && (!$env{'request.course.id'})) {
7932: return 'F';
7933: }
7934: if ($copyright eq 'priv') {
7935: $uri=~/([^\/]+)\/([^\/]+)\//;
7936: unless (($env{'user.name'} eq $2) && ($env{'user.domain'} eq $1)) {
7937: return '';
7938: }
7939: }
7940: if ($copyright eq 'domain') {
7941: $uri=~/([^\/]+)\/([^\/]+)\//;
7942: unless (($env{'user.domain'} eq $1) ||
7943: ($env{'course.'.$env{'request.course.id'}.'.domain'} eq $1)) {
7944: return '';
7945: }
7946: }
7947: if ($env{'request.role'}=~ /li\.\//) {
7948: # Library role, so allow browsing of resources in this domain.
7949: return 'F';
7950: }
7951: if ($copyright eq 'custom') {
7952: unless (&customaccess($priv,$uri)) { return ''; }
7953: }
7954: }
7955: # Domain coordinator is trying to create a course
7956: if (($priv eq 'ccc') && ($env{'request.role'} =~ /^dc\./)) {
7957: # uri is the requested domain in this case.
7958: # comparison to 'request.role.domain' shows if the user has selected
7959: # a role of dc for the domain in question.
7960: return 'F' if ($uri eq $env{'request.role.domain'});
7961: }
7962:
7963: my $thisallowed='';
7964: my $statecond=0;
7965: my $courseprivid='';
7966:
7967: my $ownaccess;
7968: # Community Coordinator or Assistant Co-author browsing resource space.
7969: if (($priv eq 'bro') && ($env{'user.author'})) {
7970: if ($uri eq '') {
7971: $ownaccess = 1;
7972: } else {
7973: if (($env{'user.domain'} ne '') && ($env{'user.name'} ne '')) {
7974: my $udom = $env{'user.domain'};
7975: my $uname = $env{'user.name'};
7976: if ($uri =~ m{^\Q$udom\E/?$}) {
7977: $ownaccess = 1;
7978: } elsif ($uri =~ m{^\Q$udom\E/\Q$uname\E/?}) {
7979: unless ($uri =~ m{\.\./}) {
7980: $ownaccess = 1;
7981: }
7982: } elsif (($udom ne 'public') && ($uname ne 'public')) {
7983: my $now = time;
7984: if ($uri =~ m{^([^/]+)/?$}) {
7985: my $adom = $1;
7986: foreach my $key (keys(%env)) {
7987: if ($key =~ m{^user\.role\.(ca|aa)/\Q$adom\E}) {
7988: my ($start,$end) = split('.',$env{$key});
7989: if (($now >= $start) && (!$end || $end < $now)) {
7990: $ownaccess = 1;
7991: last;
7992: }
7993: }
7994: }
7995: } elsif ($uri =~ m{^([^/]+)/([^/]+)/?}) {
7996: my $adom = $1;
7997: my $aname = $2;
7998: foreach my $role ('ca','aa') {
7999: if ($env{"user.role.$role./$adom/$aname"}) {
8000: my ($start,$end) =
8001: split('.',$env{"user.role.$role./$adom/$aname"});
8002: if (($now >= $start) && (!$end || $end < $now)) {
8003: $ownaccess = 1;
8004: last;
8005: }
8006: }
8007: }
8008: }
8009: }
8010: }
8011: }
8012: }
8013:
8014: # Course
8015:
8016: if ($env{'user.priv.'.$env{'request.role'}.'./'}=~/\Q$priv\E\&([^\:]*)/) {
8017: unless (($priv eq 'bro') && (!$ownaccess)) {
8018: $thisallowed.=$1;
8019: }
8020: }
8021:
8022: # Domain
8023:
8024: if ($env{'user.priv.'.$env{'request.role'}.'./'.(split(/\//,$uri))[0].'/'}
8025: =~/\Q$priv\E\&([^\:]*)/) {
8026: unless (($priv eq 'bro') && (!$ownaccess)) {
8027: $thisallowed.=$1;
8028: }
8029: }
8030:
8031: # User who is not author or co-author might still be able to edit
8032: # resource of an author in the domain (e.g., if Domain Coordinator).
8033: if (($priv eq 'eco') && ($thisallowed eq '') && ($env{'request.course.id'}) &&
8034: (&allowed('mdc',$env{'request.course.id'}))) {
8035: if ($env{"user.priv.cm./$uri/"}=~/\Q$priv\E\&([^\:]*)/) {
8036: $thisallowed.=$1;
8037: }
8038: }
8039:
8040: # Course: uri itself is a course
8041: my $courseuri=$uri;
8042: $courseuri=~s/\_(\d)/\/$1/;
8043: $courseuri=~s/^([^\/])/\/$1/;
8044:
8045: if ($env{'user.priv.'.$env{'request.role'}.'.'.$courseuri}
8046: =~/\Q$priv\E\&([^\:]*)/) {
8047: unless (($priv eq 'bro') && (!$ownaccess)) {
8048: $thisallowed.=$1;
8049: }
8050: }
8051:
8052: # URI is an uploaded document for this course, default permissions don't matter
8053: # not allowing 'edit' access (editupload) to uploaded course docs
8054: if (($priv eq 'bre') && ($uri=~m|^uploaded/|)) {
8055: $thisallowed='';
8056: my ($match)=&is_on_map($uri);
8057: if ($match) {
8058: if ($env{'user.priv.'.$env{'request.role'}.'./'}
8059: =~/\Q$priv\E\&([^\:]*)/) {
8060: my $value = $1;
8061: my $deeplinkblock = &deeplink_check($priv,$symb,$uri);
8062: if ($deeplinkblock) {
8063: $thisallowed='D';
8064: } elsif ($noblockcheck) {
8065: $thisallowed.=$value;
8066: } else {
8067: my @blockers = &has_comm_blocking($priv,$symb,$uri);
8068: if (@blockers > 0) {
8069: $thisallowed = 'B';
8070: } else {
8071: $thisallowed.=$value;
8072: }
8073: }
8074: }
8075: } else {
8076: my $refuri = $env{'httpref.'.$orguri} || $env{'httpref.'.$ver_orguri};
8077: if ($refuri) {
8078: if ($refuri =~ m|^/adm/|) {
8079: $thisallowed='F';
8080: } else {
8081: $refuri=&declutter($refuri);
8082: my ($match) = &is_on_map($refuri);
8083: if ($match) {
8084: my $deeplinkblock = &deeplink_check($priv,$symb,$refuri);
8085: if ($deeplinkblock) {
8086: $thisallowed='D';
8087: } elsif ($noblockcheck) {
8088: $thisallowed='F';
8089: } else {
8090: my @blockers = &has_comm_blocking($priv,$symb,$refuri);
8091: if (@blockers > 0) {
8092: $thisallowed = 'B';
8093: } else {
8094: $thisallowed='F';
8095: }
8096: }
8097: }
8098: }
8099: }
8100: }
8101: }
8102:
8103: if ($priv eq 'bre'
8104: && $thisallowed ne 'F'
8105: && $thisallowed ne '2'
8106: && &is_portfolio_url($uri)) {
8107: $thisallowed = &portfolio_access($uri,$clientip);
8108: }
8109:
8110: # Full access at system, domain or course-wide level? Exit.
8111: if ($thisallowed=~/F/) {
8112: return 'F';
8113: }
8114:
8115: # If this is generating or modifying users, exit with special codes
8116:
8117: if (':csu:cdc:ccc:cin:cta:cep:ccr:cst:cad:cli:cau:cdg:cca:caa:'=~/\:\Q$priv\E\:/) {
8118: if (($priv eq 'cca') || ($priv eq 'caa')) {
8119: my ($audom,$auname)=split('/',$uri);
8120: # no author name given, so this just checks on the general right to make a co-author in this domain
8121: unless ($auname) { return $thisallowed; }
8122: # an author name is given, so we are about to actually make a co-author for a certain account
8123: if (($auname ne $env{'user.name'} && $env{'request.role'} !~ /^dc\./) ||
8124: (($audom ne $env{'user.domain'} && $env{'request.role'} !~ /^dc\./) &&
8125: ($audom ne $env{'request.role.domain'}))) { return ''; }
8126: }
8127: return $thisallowed;
8128: }
8129: #
8130: # Gathered so far: system, domain and course wide privileges
8131: #
8132: # Course: See if uri or referer is an individual resource that is part of
8133: # the course
8134:
8135: if ($env{'request.course.id'}) {
8136:
8137: $courseprivid=$env{'request.course.id'};
8138: if ($env{'request.course.sec'}) {
8139: $courseprivid.='/'.$env{'request.course.sec'};
8140: }
8141: $courseprivid=~s/\_/\//;
8142: my $checkreferer=1;
8143: my ($match,$cond)=&is_on_map($uri);
8144: if ($match) {
8145: $statecond=$cond;
8146: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid}
8147: =~/\Q$priv\E\&([^\:]*)/) {
8148: my $value = $1;
8149: if ($priv eq 'bre') {
8150: if ($noblockcheck) {
8151: $thisallowed.=$value;
8152: } else {
8153: my @blockers = &has_comm_blocking($priv,$symb,$uri);
8154: if (@blockers > 0) {
8155: $thisallowed = 'B';
8156: } else {
8157: $thisallowed.=$value;
8158: }
8159: }
8160: } else {
8161: $thisallowed.=$value;
8162: }
8163: $checkreferer=0;
8164: }
8165: }
8166:
8167: if ($checkreferer) {
8168: my $refuri=$env{'httpref.'.$orguri};
8169: unless ($refuri) {
8170: foreach my $key (keys(%env)) {
8171: if ($key=~/^httpref\..*\*/) {
8172: my $pattern=$key;
8173: $pattern=~s/^httpref\.\/res\///;
8174: $pattern=~s/\*/\[\^\/\]\+/g;
8175: $pattern=~s/\//\\\//g;
8176: if ($orguri=~/$pattern/) {
8177: $refuri=$env{$key};
8178: }
8179: }
8180: }
8181: }
8182:
8183: if ($refuri) {
8184: $refuri=&declutter($refuri);
8185: my ($match,$cond)=&is_on_map($refuri);
8186: if ($match) {
8187: my $refstatecond=$cond;
8188: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid}
8189: =~/\Q$priv\E\&([^\:]*)/) {
8190: my $value = $1;
8191: if ($priv eq 'bre') {
8192: my $deeplinkblock = &deeplink_check($priv,$symb,$refuri);
8193: if ($deeplinkblock) {
8194: $thisallowed = 'D';
8195: } elsif ($noblockcheck) {
8196: $thisallowed.=$value;
8197: } else {
8198: my @blockers = &has_comm_blocking($priv,$symb,$refuri);
8199: if (@blockers > 0) {
8200: $thisallowed = 'B';
8201: } else {
8202: $thisallowed.=$value;
8203: }
8204: }
8205: } else {
8206: $thisallowed.=$value;
8207: }
8208: $uri=$refuri;
8209: $statecond=$refstatecond;
8210: }
8211: }
8212: }
8213: }
8214: }
8215:
8216: #
8217: # Gathered now: all privileges that could apply, and condition number
8218: #
8219: #
8220: # Full or no access?
8221: #
8222:
8223: if ($thisallowed=~/F/) {
8224: return 'F';
8225: }
8226:
8227: unless ($thisallowed) {
8228: return '';
8229: }
8230:
8231: # Restrictions exist, deal with them
8232: #
8233: # C:according to course preferences
8234: # R:according to resource settings
8235: # L:unless locked
8236: # X:according to user session state
8237: #
8238:
8239: # Possibly locked functionality, check all courses
8240: # Locks might take effect only after 10 minutes cache expiration for other
8241: # courses, and 2 minutes for current course
8242:
8243: my $envkey;
8244: if ($thisallowed=~/L/) {
8245: foreach $envkey (keys(%env)) {
8246: if ($envkey=~/^user\.role\.(st|ta)\.([^\.]*)/) {
8247: my $courseid=$2;
8248: my $roleid=$1.'.'.$2;
8249: $courseid=~s/^\///;
8250: my $expiretime=600;
8251: if ($env{'request.role'} eq $roleid) {
8252: $expiretime=120;
8253: }
8254: my ($cdom,$cnum,$csec)=split(/\//,$courseid);
8255: my $prefix='course.'.$cdom.'_'.$cnum.'.';
8256: if ((time-$env{$prefix.'last_cache'})>$expiretime) {
8257: &coursedescription($courseid,{'freshen_cache' => 1});
8258: }
8259: if (($env{$prefix.'res.'.$uri.'.lock.sections'}=~/\,\Q$csec\E\,/)
8260: || ($env{$prefix.'res.'.$uri.'.lock.sections'} eq 'all')) {
8261: if ($env{$prefix.'res.'.$uri.'.lock.expire'}>time) {
8262: &log($env{'user.domain'},$env{'user.name'},
8263: $env{'user.home'},
8264: 'Locked by res: '.$priv.' for '.$uri.' due to '.
8265: $cdom.'/'.$cnum.'/'.$csec.' expire '.
8266: $env{$prefix.'priv.'.$priv.'.lock.expire'});
8267: return '';
8268: }
8269: }
8270: if (($env{$prefix.'priv.'.$priv.'.lock.sections'}=~/\,\Q$csec\E\,/)
8271: || ($env{$prefix.'priv.'.$priv.'.lock.sections'} eq 'all')) {
8272: if ($env{'priv.'.$priv.'.lock.expire'}>time) {
8273: &log($env{'user.domain'},$env{'user.name'},
8274: $env{'user.home'},
8275: 'Locked by priv: '.$priv.' for '.$uri.' due to '.
8276: $cdom.'/'.$cnum.'/'.$csec.' expire '.
8277: $env{$prefix.'priv.'.$priv.'.lock.expire'});
8278: return '';
8279: }
8280: }
8281: }
8282: }
8283: }
8284:
8285: #
8286: # Rest of the restrictions depend on selected course
8287: #
8288:
8289: unless ($env{'request.course.id'}) {
8290: if ($thisallowed eq 'A') {
8291: return 'A';
8292: } elsif ($thisallowed eq 'B') {
8293: return 'B';
8294: } else {
8295: return '1';
8296: }
8297: }
8298:
8299: #
8300: # Now user is definitely in a course
8301: #
8302:
8303:
8304: # Course preferences
8305:
8306: if ($thisallowed=~/C/) {
8307: my $rolecode=(split(/\./,$env{'request.role'}))[0];
8308: my $unamedom=$env{'user.name'}.':'.$env{'user.domain'};
8309: if ($env{'course.'.$env{'request.course.id'}.'.'.$priv.'.roles.denied'}
8310: =~/\Q$rolecode\E/) {
8311: if (($priv ne 'pch') && ($priv ne 'plc') && ($priv ne 'pac')) {
8312: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.':'.
8313: 'Denied by role: '.$priv.' for '.$uri.' as '.$rolecode.' in '.
8314: $env{'request.course.id'});
8315: }
8316: return '';
8317: }
8318:
8319: if ($env{'course.'.$env{'request.course.id'}.'.'.$priv.'.users.denied'}
8320: =~/\Q$unamedom\E/) {
8321: if (($priv ne 'pch') && ($priv ne 'plc') && ($priv ne 'pac')) {
8322: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.
8323: 'Denied by user: '.$priv.' for '.$uri.' as '.$unamedom.' in '.
8324: $env{'request.course.id'});
8325: }
8326: return '';
8327: }
8328: }
8329:
8330: # Resource preferences
8331:
8332: if ($thisallowed=~/R/) {
8333: my $rolecode=(split(/\./,$env{'request.role'}))[0];
8334: if (&metadata($uri,'roledeny')=~/\Q$rolecode\E/) {
8335: if (($priv ne 'pch') && ($priv ne 'plc')) {
8336: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.':'.
8337: 'Denied by role: '.$priv.' for '.$uri.' as '.$rolecode);
8338: }
8339: return '';
8340: }
8341: }
8342:
8343: # Restricted by state or randomout?
8344:
8345: if ($thisallowed=~/X/) {
8346: if ($env{'acc.randomout'}) {
8347: if (!$symb) { $symb=&symbread($uri,1); }
8348: if (($symb) && ($env{'acc.randomout'}=~/\&\Q$symb\E\&/)) {
8349: return '';
8350: }
8351: }
8352: if (&condval($statecond)) {
8353: return '2';
8354: } else {
8355: return '';
8356: }
8357: }
8358:
8359: if ($thisallowed eq 'A') {
8360: return 'A';
8361: } elsif ($thisallowed eq 'B') {
8362: return 'B';
8363: } elsif ($thisallowed eq 'D') {
8364: return 'D';
8365: }
8366: return 'F';
8367: }
8368:
8369: # ------------------------------------------- Check construction space access
8370:
8371: sub constructaccess {
8372: my ($url,$setpriv)=@_;
8373:
8374: # We do not allow editing of previous versions of files
8375: if ($url=~/\.(\d+)\.(\w+)$/) { return ''; }
8376:
8377: # Get username and domain from URL
8378: my ($ownername,$ownerdomain,$ownerhome);
8379:
8380: ($ownerdomain,$ownername) =
8381: ($url=~ m{^(?:\Q$perlvar{'lonDocRoot'}\E|)(?:/daxepage|/daxeopen)?/priv/($match_domain)/($match_username)(?:/|$)});
8382:
8383: # The URL does not really point to any authorspace, forget it
8384: unless (($ownername) && ($ownerdomain)) { return ''; }
8385:
8386: # Now we need to see if the user has access to the authorspace of
8387: # $ownername at $ownerdomain
8388:
8389: if (($ownername eq $env{'user.name'}) && ($ownerdomain eq $env{'user.domain'})) {
8390: # Real author for this?
8391: $ownerhome = $env{'user.home'};
8392: if (exists($env{'user.priv.au./'.$ownerdomain.'/./'})) {
8393: return ($ownername,$ownerdomain,$ownerhome);
8394: }
8395: } else {
8396: # Co-author for this?
8397: if (exists($env{'user.priv.ca./'.$ownerdomain.'/'.$ownername.'./'}) ||
8398: exists($env{'user.priv.aa./'.$ownerdomain.'/'.$ownername.'./'}) ) {
8399: $ownerhome = &homeserver($ownername,$ownerdomain);
8400: return ($ownername,$ownerdomain,$ownerhome);
8401: }
8402: if ($env{'request.course.id'}) {
8403: if (($ownername eq $env{'course.'.$env{'request.course.id'}.'.num'}) &&
8404: ($ownerdomain eq $env{'course.'.$env{'request.course.id'}.'.domain'})) {
8405: if (&allowed('mdc',$env{'request.course.id'})) {
8406: $ownerhome = $env{'course.'.$env{'request.course.id'}.'.home'};
8407: return ($ownername,$ownerdomain,$ownerhome);
8408: }
8409: }
8410: }
8411: }
8412:
8413: # We don't have any access right now. If we are not possibly going to do anything about this,
8414: # we might as well leave
8415: unless ($setpriv) { return ''; }
8416:
8417: # Backdoor access?
8418: my $allowed=&allowed('eco',$ownerdomain);
8419: # Nope
8420: unless ($allowed) { return ''; }
8421: # Looks like we may have access, but could be locked by the owner of the construction space
8422: if ($allowed eq 'U') {
8423: my %blocked=&get('environment',['domcoord.author'],
8424: $ownerdomain,$ownername);
8425: # Is blocked by owner
8426: if ($blocked{'domcoord.author'} eq 'blocked') { return ''; }
8427: }
8428: if (($allowed eq 'F') || ($allowed eq 'U')) {
8429: # Grant temporary access
8430: my $then=$env{'user.login.time'};
8431: my $update=$env{'user.update.time'};
8432: if (!$update) { $update = $then; }
8433: my $refresh=$env{'user.refresh.time'};
8434: if (!$refresh) { $refresh = $update; }
8435: my $now = time;
8436: &check_adhoc_privs($ownerdomain,$ownername,$update,$refresh,
8437: $now,'ca','constructaccess');
8438: $ownerhome = &homeserver($ownername,$ownerdomain);
8439: return($ownername,$ownerdomain,$ownerhome);
8440: }
8441: # No business here
8442: return '';
8443: }
8444:
8445: # ----------------------------------------------------------- Content Blocking
8446:
8447: {
8448: # Caches for faster Course Contents display where content blocking
8449: # is in operation (i.e., interval param set) for timed quiz.
8450: #
8451: # User for whom data are being temporarily cached.
8452: my $cacheduser='';
8453: # Cached blockers for this user (a hash of blocking items).
8454: my %cachedblockers=();
8455: # When the data were last cached.
8456: my $cachedlast='';
8457:
8458: sub load_all_blockers {
8459: my ($uname,$udom,$blocks)=@_;
8460: if (($uname ne '') && ($udom ne '')) {
8461: if (($cacheduser eq $uname.':'.$udom) &&
8462: (abs($cachedlast-time)<5)) {
8463: return;
8464: }
8465: }
8466: $cachedlast=time;
8467: $cacheduser=$uname.':'.$udom;
8468: %cachedblockers = &get_commblock_resources($blocks);
8469: }
8470:
8471: sub get_comm_blocks {
8472: my ($cdom,$cnum) = @_;
8473: if ($cdom eq '' || $cnum eq '') {
8474: return unless ($env{'request.course.id'});
8475: $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
8476: $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
8477: }
8478: my %commblocks;
8479: my $hashid=$cdom.'_'.$cnum;
8480: my ($blocksref,$cached)=&is_cached_new('comm_block',$hashid);
8481: if ((defined($cached)) && (ref($blocksref) eq 'HASH')) {
8482: %commblocks = %{$blocksref};
8483: } else {
8484: %commblocks = &Apache::lonnet::dump('comm_block',$cdom,$cnum);
8485: my $cachetime = 600;
8486: &do_cache_new('comm_block',$hashid,\%commblocks,$cachetime);
8487: }
8488: return %commblocks;
8489: }
8490:
8491: sub get_commblock_resources {
8492: my ($blocks) = @_;
8493: my %blockers = ();
8494: return %blockers unless ($env{'request.course.id'});
8495: return %blockers if ($env{'user.priv.'.$env{'request.role'}} =~/evb\&([^\:]*)/);
8496: my %commblocks;
8497: if (ref($blocks) eq 'HASH') {
8498: %commblocks = %{$blocks};
8499: } else {
8500: %commblocks = &get_comm_blocks();
8501: }
8502: return %blockers unless (keys(%commblocks) > 0);
8503: my $navmap = Apache::lonnavmaps::navmap->new();
8504: return %blockers unless (ref($navmap));
8505: my $now = time;
8506: foreach my $block (keys(%commblocks)) {
8507: if ($block =~ /^(\d+)____(\d+)$/) {
8508: my ($start,$end) = ($1,$2);
8509: if ($start <= $now && $end >= $now) {
8510: if (ref($commblocks{$block}{'blocks'}) eq 'HASH') {
8511: if (ref($commblocks{$block}{'blocks'}{'docs'}) eq 'HASH') {
8512: if (ref($commblocks{$block}{'blocks'}{'docs'}{'maps'}) eq 'HASH') {
8513: if (keys(%{$commblocks{$block}{'blocks'}{'docs'}{'maps'}})) {
8514: $blockers{$block}{maps} = $commblocks{$block}{'blocks'}{'docs'}{'maps'};
8515: }
8516: }
8517: if (ref($commblocks{$block}{'blocks'}{'docs'}{'resources'}) eq 'HASH') {
8518: if (keys(%{$commblocks{$block}{'blocks'}{'docs'}{'resources'}})) {
8519: $blockers{$block}{'resources'} = $commblocks{$block}{'blocks'}{'docs'}{'resources'};
8520: }
8521: }
8522: }
8523: }
8524: }
8525: } elsif ($block =~ /^firstaccess____(.+)$/) {
8526: my $item = $1;
8527: my @to_test;
8528: if (ref($commblocks{$block}{'blocks'}) eq 'HASH') {
8529: if (ref($commblocks{$block}{'blocks'}{'docs'}) eq 'HASH') {
8530: my @interval;
8531: my $type = 'map';
8532: if ($item eq 'course') {
8533: $type = 'course';
8534: @interval=&EXT("resource.0.interval");
8535: } else {
8536: if ($item =~ /___\d+___/) {
8537: $type = 'resource';
8538: @interval=&EXT("resource.0.interval",$item);
8539: if (ref($navmap)) {
8540: my $res = $navmap->getBySymb($item);
8541: push(@to_test,$res);
8542: }
8543: } else {
8544: my $mapsymb = &symbread($item,1);
8545: if ($mapsymb) {
8546: if (ref($navmap)) {
8547: my $mapres = $navmap->getBySymb($mapsymb);
8548: @to_test = $mapres->retrieveResources($mapres,undef,0,0,0,1);
8549: foreach my $res (@to_test) {
8550: my $symb = $res->symb();
8551: next if ($symb eq $mapsymb);
8552: if ($symb ne '') {
8553: @interval=&EXT("resource.0.interval",$symb);
8554: if ($interval[1] eq 'map') {
8555: last;
8556: }
8557: }
8558: }
8559: }
8560: }
8561: }
8562: }
8563: if ($interval[0] =~ /^(\d+)/) {
8564: my $timelimit = $1;
8565: my $first_access;
8566: if ($type eq 'resource') {
8567: $first_access=&get_first_access($interval[1],$item);
8568: } elsif ($type eq 'map') {
8569: $first_access=&get_first_access($interval[1],undef,$item);
8570: } else {
8571: $first_access=&get_first_access($interval[1]);
8572: }
8573: if ($first_access) {
8574: my $timesup = $first_access+$timelimit;
8575: if ($timesup > $now) {
8576: my $activeblock;
8577: foreach my $res (@to_test) {
8578: if ($res->answerable()) {
8579: $activeblock = 1;
8580: last;
8581: }
8582: }
8583: if ($activeblock) {
8584: if (ref($commblocks{$block}{'blocks'}{'docs'}{'maps'}) eq 'HASH') {
8585: if (keys(%{$commblocks{$block}{'blocks'}{'docs'}{'maps'}})) {
8586: $blockers{$block}{'maps'} = $commblocks{$block}{'blocks'}{'docs'}{'maps'};
8587: }
8588: }
8589: if (ref($commblocks{$block}{'blocks'}{'docs'}{'resources'}) eq 'HASH') {
8590: if (keys(%{$commblocks{$block}{'blocks'}{'docs'}{'resources'}})) {
8591: $blockers{$block}{'resources'} = $commblocks{$block}{'blocks'}{'docs'}{'resources'};
8592: }
8593: }
8594: }
8595: }
8596: }
8597: }
8598: }
8599: }
8600: }
8601: }
8602: return %blockers;
8603: }
8604:
8605: sub has_comm_blocking {
8606: my ($priv,$symb,$uri,$blocks) = @_;
8607: my @blockers;
8608: return unless ($env{'request.course.id'});
8609: return unless ($priv eq 'bre');
8610: return if ($env{'user.priv.'.$env{'request.role'}} =~/evb\&([^\:]*)/);
8611: return if ($env{'request.state'} eq 'construct');
8612: &load_all_blockers($env{'user.name'},$env{'user.domain'},$blocks);
8613: return unless (keys(%cachedblockers) > 0);
8614: my (%possibles,@symbs);
8615: if (!$symb) {
8616: $symb = &symbread($uri,1,1,1,\%possibles);
8617: }
8618: if ($symb) {
8619: @symbs = ($symb);
8620: } elsif (keys(%possibles)) {
8621: @symbs = keys(%possibles);
8622: }
8623: my $noblock;
8624: foreach my $symb (@symbs) {
8625: last if ($noblock);
8626: my ($map,$resid,$resurl)=&decode_symb($symb);
8627: foreach my $block (keys(%cachedblockers)) {
8628: if ($block =~ /^firstaccess____(.+)$/) {
8629: my $item = $1;
8630: if (($item eq $map) || ($item eq $symb)) {
8631: $noblock = 1;
8632: last;
8633: }
8634: }
8635: if (ref($cachedblockers{$block}) eq 'HASH') {
8636: if (ref($cachedblockers{$block}{'resources'}) eq 'HASH') {
8637: if ($cachedblockers{$block}{'resources'}{$symb}) {
8638: unless (grep(/^\Q$block\E$/,@blockers)) {
8639: push(@blockers,$block);
8640: }
8641: }
8642: }
8643: }
8644: if (ref($cachedblockers{$block}{'maps'}) eq 'HASH') {
8645: if ($cachedblockers{$block}{'maps'}{$map}) {
8646: unless (grep(/^\Q$block\E$/,@blockers)) {
8647: push(@blockers,$block);
8648: }
8649: }
8650: }
8651: }
8652: }
8653: return if ($noblock);
8654: return @blockers;
8655: }
8656: }
8657:
8658: sub deeplink_check {
8659: my ($priv,$symb,$uri) = @_;
8660: return unless ($env{'request.course.id'});
8661: return unless ($priv eq 'bre');
8662: return if ($env{'request.state'} eq 'construct');
8663: return if ($env{'request.role.adv'});
8664: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
8665: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
8666: my (%possibles,@symbs);
8667: if (!$symb) {
8668: $symb = &symbread($uri,1,1,1,\%possibles);
8669: }
8670: if ($symb) {
8671: @symbs = ($symb);
8672: } elsif (keys(%possibles)) {
8673: @symbs = keys(%possibles);
8674: }
8675:
8676: my ($login,$switchrole,$allow);
8677: if ($env{'request.deeplink.login'} =~ m{^\Q/tiny/$cdom/\E(\w+)$}) {
8678: my $key = $1;
8679: my $tinyurl;
8680: my ($result,$cached)=&Apache::lonnet::is_cached_new('tiny',$cdom."\0".$key);
8681: if (defined($cached)) {
8682: $tinyurl = $result;
8683: } else {
8684: my $configuname = &Apache::lonnet::get_domainconfiguser($cdom);
8685: my %currtiny = &Apache::lonnet::get('tiny',[$key],$cdom,$configuname);
8686: if ($currtiny{$key} ne '') {
8687: $tinyurl = $currtiny{$key};
8688: &Apache::lonnet::do_cache_new('tiny',$cdom."\0".$key,$currtiny{$key},600);
8689: }
8690: }
8691: if ($tinyurl ne '') {
8692: my ($cnumreq,$posslogin) = split(/\&/,$tinyurl);
8693: if ($cnumreq eq $cnum) {
8694: $login = $posslogin;
8695: } else {
8696: $switchrole = 1;
8697: }
8698: }
8699: }
8700: foreach my $symb (@symbs) {
8701: last if ($allow);
8702: my $deeplink = &EXT("resource.0.deeplink",$symb);
8703: if ($deeplink eq '') {
8704: $allow = 1;
8705: } else {
8706: my ($listed,$scope,$access) = split(/,/,$deeplink);
8707: if ($access eq 'any') {
8708: $allow = 1;
8709: } elsif ($login) {
8710: if ($access eq 'only') {
8711: if ($scope eq 'res') {
8712: if ($symb eq $login) {
8713: $allow = 1;
8714: }
8715: } elsif ($scope eq 'map') {
8716: #FIXME Compare map for $env{'request.deeplink.login'} with map for $symb
8717: } elsif ($scope eq 'rec') {
8718: #FIXME Recurse up for $env{'request.deeplink.login'} with map for $symb
8719: }
8720: } else {
8721: my ($acctype,$item) = split(/:/,$access);
8722: if (($acctype eq 'lti') && ($env{'user.linkprotector'})) {
8723: if (grep(/^\Q$item\E$/,split(/,/,$env{'user.linkprotector'}))) {
8724: my %tinyurls = &get('tiny',[$symb],$cdom,$cnum);
8725: if (grep(/\Q$tinyurls{$symb}\E$/,split(/,/,$env{'user.linkproturis'}))) {
8726: $allow = 1;
8727: }
8728: }
8729: } elsif (($acctype eq 'key') && ($env{'user.deeplinkkey'})) {
8730: if (grep(/^\Q$item\E$/,split(/,/,$env{'user.deeplinkkey'}))) {
8731: my %tinyurls = &get('tiny',[$symb],$cdom,$cnum);
8732: if (grep(/\Q$tinyurls{$symb}\E$/,split(/,/,$env{'user.keyedlinkuri'}))) {
8733: $allow = 1;
8734: }
8735: }
8736: }
8737: }
8738: }
8739: }
8740: }
8741: return if ($allow);
8742: return 1;
8743: }
8744:
8745: # -------------------------------- Deversion and split uri into path an filename
8746:
8747: #
8748: # Removes the version from a URI and
8749: # splits it in to its filename and path to the filename.
8750: # Seems like File::Basename could have done this more clearly.
8751: # Parameters:
8752: # $uri - input URI
8753: # Returns:
8754: # Two element list consisting of
8755: # $pathname - the URI up to and excluding the trailing /
8756: # $filename - The part of the URI following the last /
8757: # NOTE:
8758: # Another realization of this is simply:
8759: # use File::Basename;
8760: # ...
8761: # $uri = shift;
8762: # $filename = basename($uri);
8763: # $path = dirname($uri);
8764: # return ($filename, $path);
8765: #
8766: # The implementation below is probably faster however.
8767: #
8768: sub split_uri_for_cond {
8769: my $uri=&deversion(&declutter(shift));
8770: my @uriparts=split(/\//,$uri);
8771: my $filename=pop(@uriparts);
8772: my $pathname=join('/',@uriparts);
8773: return ($pathname,$filename);
8774: }
8775: # --------------------------------------------------- Is a resource on the map?
8776:
8777: sub is_on_map {
8778: my ($pathname,$filename) = &split_uri_for_cond(shift);
8779: #Trying to find the conditional for the file
8780: my $match=($env{'acc.res.'.$env{'request.course.id'}.'.'.$pathname}=~
8781: /\&\Q$filename\E\:([\d\|]+)\&/);
8782: if ($match) {
8783: return (1,$1);
8784: } else {
8785: return (0,0);
8786: }
8787: }
8788:
8789: # --------------------------------------------------------- Get symb from alias
8790:
8791: sub get_symb_from_alias {
8792: my $symb=shift;
8793: my ($map,$resid,$url)=&decode_symb($symb);
8794: # Already is a symb
8795: if ($url) { return $symb; }
8796: # Must be an alias
8797: my $aliassymb='';
8798: my %bighash;
8799: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
8800: &GDBM_READER(),0640)) {
8801: my $rid=$bighash{'mapalias_'.$symb};
8802: if ($rid) {
8803: my ($mapid,$resid)=split(/\./,$rid);
8804: $aliassymb=&encode_symb($bighash{'map_id_'.$mapid},
8805: $resid,$bighash{'src_'.$rid});
8806: }
8807: untie %bighash;
8808: }
8809: return $aliassymb;
8810: }
8811:
8812: # ----------------------------------------------------------------- Define Role
8813:
8814: sub definerole {
8815: if (allowed('mcr','/')) {
8816: my ($rolename,$sysrole,$domrole,$courole,$uname,$udom)=@_;
8817: foreach my $role (split(':',$sysrole)) {
8818: my ($crole,$cqual)=split(/\&/,$role);
8819: if ($pr{'cr:s'}!~/\Q$crole\E/) { return "refused:s:$crole"; }
8820: if ($pr{'cr:s'}=~/\Q$crole\E\&/) {
8821: if ($pr{'cr:s'}!~/\Q$crole\E\&\w*\Q$cqual\E/) {
8822: return "refused:s:$crole&$cqual";
8823: }
8824: }
8825: }
8826: foreach my $role (split(':',$domrole)) {
8827: my ($crole,$cqual)=split(/\&/,$role);
8828: if ($pr{'cr:d'}!~/\Q$crole\E/) { return "refused:d:$crole"; }
8829: if ($pr{'cr:d'}=~/\Q$crole\E\&/) {
8830: if ($pr{'cr:d'}!~/\Q$crole\W\&\w*\Q$cqual\E/) {
8831: return "refused:d:$crole&$cqual";
8832: }
8833: }
8834: }
8835: foreach my $role (split(':',$courole)) {
8836: my ($crole,$cqual)=split(/\&/,$role);
8837: if ($pr{'cr:c'}!~/\Q$crole\E/) { return "refused:c:$crole"; }
8838: if ($pr{'cr:c'}=~/\Q$crole\E\&/) {
8839: if ($pr{'cr:c'}!~/\Q$crole\E\&\w*\Q$cqual\E/) {
8840: return "refused:c:$crole&$cqual";
8841: }
8842: }
8843: }
8844: my $uhome;
8845: if (($uname ne '') && ($udom ne '')) {
8846: $uhome = &homeserver($uname,$udom);
8847: return $uhome if ($uhome eq 'no_host');
8848: } else {
8849: $uname = $env{'user.name'};
8850: $udom = $env{'user.domain'};
8851: $uhome = $env{'user.home'};
8852: }
8853: my $command="encrypt:rolesput:$env{'user.domain'}:$env{'user.name'}:".
8854: "$udom:$uname:rolesdef_$rolename=".
8855: escape($sysrole.'_'.$domrole.'_'.$courole);
8856: return reply($command,$uhome);
8857: } else {
8858: return 'refused';
8859: }
8860: }
8861:
8862: # ---------------- Make a metadata query against the network of library servers
8863:
8864: sub metadata_query {
8865: my ($query,$custom,$customshow,$server_array,$domains_hash)=@_;
8866: my %rhash;
8867: my %libserv = &all_library();
8868: my @server_list = (defined($server_array) ? @$server_array
8869: : keys(%libserv) );
8870: for my $server (@server_list) {
8871: my $domains = '';
8872: if (ref($domains_hash) eq 'HASH') {
8873: $domains = $domains_hash->{$server};
8874: }
8875: unless ($custom or $customshow) {
8876: my $reply=&reply("querysend:".&escape($query).':::'.&escape($domains),$server);
8877: $rhash{$server}=$reply;
8878: }
8879: else {
8880: my $reply=&reply("querysend:".&escape($query).':'.
8881: &escape($custom).':'.&escape($customshow).':'.&escape($domains),
8882: $server);
8883: $rhash{$server}=$reply;
8884: }
8885: }
8886: return \%rhash;
8887: }
8888:
8889: # ----------------------------------------- Send log queries and wait for reply
8890:
8891: sub log_query {
8892: my ($uname,$udom,$query,%filters)=@_;
8893: my $uhome=&homeserver($uname,$udom);
8894: if ($uhome eq 'no_host') { return 'error: no_host'; }
8895: my $uhost=&hostname($uhome);
8896: my $command=&escape(join(':',map{$_.'='.$filters{$_}} keys(%filters)));
8897: my $queryid=&reply("querysend:".$query.':'.$udom.':'.$uname.':'.$command,
8898: $uhome);
8899: unless ($queryid=~/^\Q$uhost\E\_/) { return 'error: '.$queryid; }
8900: return get_query_reply($queryid);
8901: }
8902:
8903: # -------------------------- Update MySQL table for portfolio file
8904:
8905: sub update_portfolio_table {
8906: my ($uname,$udom,$file_name,$query,$group,$action) = @_;
8907: if ($group ne '') {
8908: $file_name =~s /^\Q$group\E//;
8909: }
8910: my $homeserver = &homeserver($uname,$udom);
8911: my $queryid=
8912: &reply("querysend:".$query.':'.&escape($uname.':'.$udom.':'.$group).
8913: ':'.&escape($file_name).':'.$action,$homeserver);
8914: my $reply = &get_query_reply($queryid);
8915: return $reply;
8916: }
8917:
8918: # -------------------------- Update MySQL allusers table
8919:
8920: sub update_allusers_table {
8921: my ($uname,$udom,$names) = @_;
8922: my $homeserver = &homeserver($uname,$udom);
8923: my $queryid=
8924: &reply('querysend:allusers:'.&escape($uname).':'.&escape($udom).':'.
8925: 'lastname='.&escape($names->{'lastname'}).'%%'.
8926: 'firstname='.&escape($names->{'firstname'}).'%%'.
8927: 'middlename='.&escape($names->{'middlename'}).'%%'.
8928: 'generation='.&escape($names->{'generation'}).'%%'.
8929: 'permanentemail='.&escape($names->{'permanentemail'}).'%%'.
8930: 'id='.&escape($names->{'id'}),$homeserver);
8931: return;
8932: }
8933:
8934: # ------- Request retrieval of institutional classlists for course(s)
8935:
8936: sub fetch_enrollment_query {
8937: my ($context,$affiliatesref,$replyref,$dom,$cnum) = @_;
8938: my ($homeserver,$sleep,$loopmax);
8939: my $maxtries = 1;
8940: if ($context eq 'automated') {
8941: $homeserver = $perlvar{'lonHostID'};
8942: $sleep = 2;
8943: $loopmax = 100;
8944: $maxtries = 10; # will wait for up to 2000s for retrieval of classlist data before timeout
8945: } else {
8946: $homeserver = &homeserver($cnum,$dom);
8947: }
8948: my $host=&hostname($homeserver);
8949: my $cmd = '';
8950: foreach my $affiliate (keys(%{$affiliatesref})) {
8951: $cmd .= $affiliate.'='.join(",",@{$$affiliatesref{$affiliate}}).'%%';
8952: }
8953: $cmd =~ s/%%$//;
8954: $cmd = &escape($cmd);
8955: my $query = 'fetchenrollment';
8956: my $queryid=&reply("querysend:".$query.':'.$dom.':'.$env{'user.name'}.':'.$cmd,$homeserver);
8957: unless ($queryid=~/^\Q$host\E\_/) {
8958: &logthis('fetch_enrollment_query: invalid queryid: '.$queryid.' for host: '.$host.' and homeserver: '.$homeserver.' context: '.$context.' '.$cnum);
8959: return 'error: '.$queryid;
8960: }
8961: my $reply = &get_query_reply($queryid,$sleep,$loopmax);
8962: my $tries = 1;
8963: while (($reply=~/^timeout/) && ($tries < $maxtries)) {
8964: $reply = &get_query_reply($queryid,$sleep,$loopmax);
8965: $tries ++;
8966: }
8967: if ( ($reply =~/^timeout/) || ($reply =~/^error/) ) {
8968: &logthis('fetch_enrollment_query error: '.$reply.' for '.$dom.' '.$env{'user.name'}.' for '.$queryid.' context: '.$context.' '.$cnum.' maxtries: '.$maxtries.' tries: '.$tries);
8969: } else {
8970: my @responses = split(/:/,$reply);
8971: if (grep { $_ eq $homeserver } ¤t_machine_ids()) {
8972: foreach my $line (@responses) {
8973: my ($key,$value) = split(/=/,$line,2);
8974: $$replyref{$key} = $value;
8975: }
8976: } else {
8977: my $pathname = LONCAPA::tempdir();
8978: foreach my $line (@responses) {
8979: my ($key,$value) = split(/=/,$line);
8980: $$replyref{$key} = $value;
8981: if ($value > 0) {
8982: foreach my $item (@{$$affiliatesref{$key}}) {
8983: my $filename = $dom.'_'.$key.'_'.$item.'_classlist.xml';
8984: my $destname = $pathname.'/'.$filename;
8985: my $xml_classlist = &reply("autoretrieve:".$filename,$homeserver);
8986: if ($xml_classlist =~ /^error/) {
8987: &logthis('fetch_enrollment_query - autoretrieve error: '.$xml_classlist.' for '.$filename.' from server: '.$homeserver.' '.$context.' '.$cnum);
8988: } else {
8989: if ( open(FILE,">",$destname) ) {
8990: print FILE &unescape($xml_classlist);
8991: close(FILE);
8992: } else {
8993: &logthis('fetch_enrollment_query - error opening classlist file '.$destname.' '.$context.' '.$cnum);
8994: }
8995: }
8996: }
8997: }
8998: }
8999: }
9000: return 'ok';
9001: }
9002: return 'error';
9003: }
9004:
9005: sub get_query_reply {
9006: my ($queryid,$sleep,$loopmax) = @_;;
9007: if (($sleep eq '') || ($sleep !~ /^\d+\.?\d*$/)) {
9008: $sleep = 0.2;
9009: }
9010: if (($loopmax eq '') || ($loopmax =~ /\D/)) {
9011: $loopmax = 100;
9012: }
9013: my $replyfile=LONCAPA::tempdir().$queryid;
9014: my $reply='';
9015: for (1..$loopmax) {
9016: sleep($sleep);
9017: if (-e $replyfile.'.end') {
9018: if (open(my $fh,"<",$replyfile)) {
9019: $reply = join('',<$fh>);
9020: close($fh);
9021: } else { return 'error: reply_file_error'; }
9022: return &unescape($reply);
9023: }
9024: }
9025: return 'timeout:'.$queryid;
9026: }
9027:
9028: sub courselog_query {
9029: #
9030: # possible filters:
9031: # url: url or symb
9032: # username
9033: # domain
9034: # action: view, submit, grade
9035: # start: timestamp
9036: # end: timestamp
9037: #
9038: my (%filters)=@_;
9039: unless ($env{'request.course.id'}) { return 'no_course'; }
9040: if ($filters{'url'}) {
9041: $filters{'url'}=&symbclean(&declutter($filters{'url'}));
9042: $filters{'url'}=~s/\.(\w+)$/(\\.\\d+)*\\.$1/;
9043: $filters{'url'}=~s/\.(\w+)\_\_\_/(\\.\\d+)*\\.$1/;
9044: }
9045: my $cname=$env{'course.'.$env{'request.course.id'}.'.num'};
9046: my $cdom=$env{'course.'.$env{'request.course.id'}.'.domain'};
9047: return &log_query($cname,$cdom,'courselog',%filters);
9048: }
9049:
9050: sub userlog_query {
9051: #
9052: # possible filters:
9053: # action: log check role
9054: # start: timestamp
9055: # end: timestamp
9056: #
9057: my ($uname,$udom,%filters)=@_;
9058: return &log_query($uname,$udom,'userlog',%filters);
9059: }
9060:
9061: #--------- Call auto-enrollment subs in localenroll.pm for homeserver for course
9062:
9063: sub auto_run {
9064: my ($cnum,$cdom) = @_;
9065: my $response = 0;
9066: my $settings;
9067: my %domconfig = &get_dom('configuration',['autoenroll'],$cdom);
9068: if (ref($domconfig{'autoenroll'}) eq 'HASH') {
9069: $settings = $domconfig{'autoenroll'};
9070: if ($settings->{'run'} eq '1') {
9071: $response = 1;
9072: }
9073: } else {
9074: my $homeserver;
9075: if (&is_course($cdom,$cnum)) {
9076: $homeserver = &homeserver($cnum,$cdom);
9077: } else {
9078: $homeserver = &domain($cdom,'primary');
9079: }
9080: if ($homeserver ne 'no_host') {
9081: $response = &reply('autorun:'.$cdom,$homeserver);
9082: }
9083: }
9084: return $response;
9085: }
9086:
9087: sub auto_get_sections {
9088: my ($cnum,$cdom,$inst_coursecode) = @_;
9089: my $homeserver;
9090: if (($cdom =~ /^$match_domain$/) && ($cnum =~ /^$match_courseid$/)) {
9091: $homeserver = &homeserver($cnum,$cdom);
9092: }
9093: if (!defined($homeserver)) {
9094: if ($cdom =~ /^$match_domain$/) {
9095: $homeserver = &domain($cdom,'primary');
9096: }
9097: }
9098: my @secs;
9099: if (defined($homeserver)) {
9100: my $response=&unescape(&reply('autogetsections:'.$inst_coursecode.':'.$cdom,$homeserver));
9101: unless ($response eq 'refused') {
9102: @secs = split(/:/,$response);
9103: }
9104: }
9105: return @secs;
9106: }
9107:
9108: sub auto_new_course {
9109: my ($cnum,$cdom,$inst_course_id,$owner,$coowners) = @_;
9110: my $homeserver = &homeserver($cnum,$cdom);
9111: my $response=&unescape(&reply('autonewcourse:'.$inst_course_id.':'.&escape($owner).':'.$cdom.':'.&escape($coowners),$homeserver));
9112: return $response;
9113: }
9114:
9115: sub auto_validate_courseID {
9116: my ($cnum,$cdom,$inst_course_id) = @_;
9117: my $homeserver = &homeserver($cnum,$cdom);
9118: my $response=&unescape(&reply('autovalidatecourse:'.$inst_course_id.':'.$cdom,$homeserver));
9119: return $response;
9120: }
9121:
9122: sub auto_validate_instcode {
9123: my ($cnum,$cdom,$instcode,$owner) = @_;
9124: my ($homeserver,$response);
9125: if (($cdom =~ /^$match_domain$/) && ($cnum =~ /^$match_courseid$/)) {
9126: $homeserver = &homeserver($cnum,$cdom);
9127: }
9128: if (!defined($homeserver)) {
9129: if ($cdom =~ /^$match_domain$/) {
9130: $homeserver = &domain($cdom,'primary');
9131: }
9132: }
9133: $response=&unescape(&reply('autovalidateinstcode:'.$cdom.':'.
9134: &escape($instcode).':'.&escape($owner),$homeserver));
9135: my ($outcome,$description,$defaultcredits) = map { &unescape($_); } split('&',$response,3);
9136: return ($outcome,$description,$defaultcredits);
9137: }
9138:
9139: sub auto_create_password {
9140: my ($cnum,$cdom,$authparam,$udom) = @_;
9141: my ($homeserver,$response);
9142: my $create_passwd = 0;
9143: my $authchk = '';
9144: if ($udom =~ /^$match_domain$/) {
9145: $homeserver = &domain($udom,'primary');
9146: }
9147: if ($homeserver eq '') {
9148: if (($cdom =~ /^$match_domain$/) && ($cnum =~ /^$match_courseid$/)) {
9149: $homeserver = &homeserver($cnum,$cdom);
9150: }
9151: }
9152: if ($homeserver eq '') {
9153: $authchk = 'nodomain';
9154: } else {
9155: $response=&unescape(&reply('autocreatepassword:'.$authparam.':'.$cdom,$homeserver));
9156: if ($response eq 'refused') {
9157: $authchk = 'refused';
9158: } else {
9159: ($authparam,$create_passwd,$authchk) = split(/:/,$response);
9160: }
9161: }
9162: return ($authparam,$create_passwd,$authchk);
9163: }
9164:
9165: sub auto_photo_permission {
9166: my ($cnum,$cdom,$students) = @_;
9167: my $homeserver = &homeserver($cnum,$cdom);
9168: my ($outcome,$perm_reqd,$conditions) =
9169: split(/:/,&unescape(&reply('autophotopermission:'.$cdom,$homeserver)),3);
9170: if ($outcome =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
9171: return (undef,undef);
9172: }
9173: return ($outcome,$perm_reqd,$conditions);
9174: }
9175:
9176: sub auto_checkphotos {
9177: my ($uname,$udom,$pid) = @_;
9178: my $homeserver = &homeserver($uname,$udom);
9179: my ($result,$resulttype);
9180: my $outcome = &unescape(&reply('autophotocheck:'.&escape($udom).':'.
9181: &escape($uname).':'.&escape($pid),
9182: $homeserver));
9183: if ($outcome =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
9184: return (undef,undef);
9185: }
9186: if ($outcome) {
9187: ($result,$resulttype) = split(/:/,$outcome);
9188: }
9189: return ($result,$resulttype);
9190: }
9191:
9192: sub auto_photochoice {
9193: my ($cnum,$cdom) = @_;
9194: my $homeserver = &homeserver($cnum,$cdom);
9195: my ($update,$comment) = split(/:/,&unescape(&reply('autophotochoice:'.
9196: &escape($cdom),
9197: $homeserver)));
9198: if ($update =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
9199: return (undef,undef);
9200: }
9201: return ($update,$comment);
9202: }
9203:
9204: sub auto_photoupdate {
9205: my ($affiliatesref,$dom,$cnum,$photo) = @_;
9206: my $homeserver = &homeserver($cnum,$dom);
9207: my $host=&hostname($homeserver);
9208: my $cmd = '';
9209: my $maxtries = 1;
9210: foreach my $affiliate (keys(%{$affiliatesref})) {
9211: $cmd .= $affiliate.'='.join(",",@{$$affiliatesref{$affiliate}}).'%%';
9212: }
9213: $cmd =~ s/%%$//;
9214: $cmd = &escape($cmd);
9215: my $query = 'institutionalphotos';
9216: my $queryid=&reply("querysend:".$query.':'.$dom.':'.$cnum.':'.$cmd,$homeserver);
9217: unless ($queryid=~/^\Q$host\E\_/) {
9218: &logthis('institutionalphotos: invalid queryid: '.$queryid.' for host: '.$host.' and homeserver: '.$homeserver.' and course: '.$cnum);
9219: return 'error: '.$queryid;
9220: }
9221: my $reply = &get_query_reply($queryid);
9222: my $tries = 1;
9223: while (($reply=~/^timeout/) && ($tries < $maxtries)) {
9224: $reply = &get_query_reply($queryid);
9225: $tries ++;
9226: }
9227: if ( ($reply =~/^timeout/) || ($reply =~/^error/) ) {
9228: &logthis('institutionalphotos error: '.$reply.' for '.$dom.' '.$env{'user.name'}.' for '.$queryid.' course: '.$cnum.' maxtries: '.$maxtries.' tries: '.$tries);
9229: } else {
9230: my @responses = split(/:/,$reply);
9231: my $outcome = shift(@responses);
9232: foreach my $item (@responses) {
9233: my ($key,$value) = split(/=/,$item);
9234: $$photo{$key} = $value;
9235: }
9236: return $outcome;
9237: }
9238: return 'error';
9239: }
9240:
9241: sub auto_instcode_format {
9242: my ($caller,$codedom,$instcodes,$codes,$codetitles,$cat_titles,
9243: $cat_order) = @_;
9244: my $courses = '';
9245: my @homeservers;
9246: if ($caller eq 'global') {
9247: my %servers = &get_servers($codedom,'library');
9248: foreach my $tryserver (keys(%servers)) {
9249: if (!grep(/^\Q$tryserver\E$/,@homeservers)) {
9250: push(@homeservers,$tryserver);
9251: }
9252: }
9253: } elsif ($caller eq 'requests') {
9254: if ($codedom =~ /^$match_domain$/) {
9255: my $chome = &domain($codedom,'primary');
9256: unless ($chome eq 'no_host') {
9257: push(@homeservers,$chome);
9258: }
9259: }
9260: } else {
9261: push(@homeservers,&homeserver($caller,$codedom));
9262: }
9263: foreach my $code (keys(%{$instcodes})) {
9264: $courses .= &escape($code).'='.&escape($$instcodes{$code}).'&';
9265: }
9266: chop($courses);
9267: my $ok_response = 0;
9268: my $response;
9269: while (@homeservers > 0 && $ok_response == 0) {
9270: my $server = shift(@homeservers);
9271: $response=&reply('autoinstcodeformat:'.$codedom.':'.$courses,$server);
9272: if ($response !~ /(con_lost|error|no_such_host|refused)/) {
9273: my ($codes_str,$codetitles_str,$cat_titles_str,$cat_order_str) =
9274: split(/:/,$response);
9275: %{$codes} = (%{$codes},&str2hash($codes_str));
9276: push(@{$codetitles},&str2array($codetitles_str));
9277: %{$cat_titles} = (%{$cat_titles},&str2hash($cat_titles_str));
9278: %{$cat_order} = (%{$cat_order},&str2hash($cat_order_str));
9279: $ok_response = 1;
9280: }
9281: }
9282: if ($ok_response) {
9283: return 'ok';
9284: } else {
9285: return $response;
9286: }
9287: }
9288:
9289: sub auto_instcode_defaults {
9290: my ($domain,$returnhash,$code_order) = @_;
9291: my @homeservers;
9292:
9293: my %servers = &get_servers($domain,'library');
9294: foreach my $tryserver (keys(%servers)) {
9295: if (!grep(/^\Q$tryserver\E$/,@homeservers)) {
9296: push(@homeservers,$tryserver);
9297: }
9298: }
9299:
9300: my $response;
9301: foreach my $server (@homeservers) {
9302: $response=&reply('autoinstcodedefaults:'.$domain,$server);
9303: next if ($response =~ /(con_lost|error|no_such_host|refused)/);
9304:
9305: foreach my $pair (split(/\&/,$response)) {
9306: my ($name,$value)=split(/\=/,$pair);
9307: if ($name eq 'code_order') {
9308: @{$code_order} = split(/\&/,&unescape($value));
9309: } else {
9310: $returnhash->{&unescape($name)}=&unescape($value);
9311: }
9312: }
9313: return 'ok';
9314: }
9315:
9316: return $response;
9317: }
9318:
9319: sub auto_possible_instcodes {
9320: my ($domain,$codetitles,$cat_titles,$cat_orders,$code_order) = @_;
9321: unless ((ref($codetitles) eq 'ARRAY') && (ref($cat_titles) eq 'HASH') &&
9322: (ref($cat_orders) eq 'HASH') && (ref($code_order) eq 'ARRAY')) {
9323: return;
9324: }
9325: my (@homeservers,$uhome);
9326: if (defined(&domain($domain,'primary'))) {
9327: $uhome=&domain($domain,'primary');
9328: push(@homeservers,&domain($domain,'primary'));
9329: } else {
9330: my %servers = &get_servers($domain,'library');
9331: foreach my $tryserver (keys(%servers)) {
9332: if (!grep(/^\Q$tryserver\E$/,@homeservers)) {
9333: push(@homeservers,$tryserver);
9334: }
9335: }
9336: }
9337: my $response;
9338: foreach my $server (@homeservers) {
9339: $response=&reply('autopossibleinstcodes:'.$domain,$server);
9340: next if ($response =~ /(con_lost|error|no_such_host|refused)/);
9341: my ($codetitlestr,$codeorderstr,$cat_title,$cat_order) =
9342: split(':',$response);
9343: @{$codetitles} = map { &unescape($_); } (split('&',$codetitlestr));
9344: @{$code_order} = map { &unescape($_); } (split('&',$codeorderstr));
9345: foreach my $item (split('&',$cat_title)) {
9346: my ($name,$value)=split('=',$item);
9347: $cat_titles->{&unescape($name)}=&thaw_unescape($value);
9348: }
9349: foreach my $item (split('&',$cat_order)) {
9350: my ($name,$value)=split('=',$item);
9351: $cat_orders->{&unescape($name)}=&thaw_unescape($value);
9352: }
9353: return 'ok';
9354: }
9355: return $response;
9356: }
9357:
9358: sub auto_courserequest_checks {
9359: my ($dom) = @_;
9360: my ($homeserver,%validations);
9361: if ($dom =~ /^$match_domain$/) {
9362: $homeserver = &domain($dom,'primary');
9363: }
9364: unless ($homeserver eq 'no_host') {
9365: my $response=&reply('autocrsreqchecks:'.$dom,$homeserver);
9366: unless ($response =~ /(con_lost|error|no_such_host|refused)/) {
9367: my @items = split(/&/,$response);
9368: foreach my $item (@items) {
9369: my ($key,$value) = split('=',$item);
9370: $validations{&unescape($key)} = &thaw_unescape($value);
9371: }
9372: }
9373: }
9374: return %validations;
9375: }
9376:
9377: sub auto_courserequest_validation {
9378: my ($dom,$owner,$crstype,$inststatuslist,$instcode,$instseclist,$custominfo) = @_;
9379: my ($homeserver,$response);
9380: if ($dom =~ /^$match_domain$/) {
9381: $homeserver = &domain($dom,'primary');
9382: }
9383: unless ($homeserver eq 'no_host') {
9384: my $customdata;
9385: if (ref($custominfo) eq 'HASH') {
9386: $customdata = &freeze_escape($custominfo);
9387: }
9388: $response=&unescape(&reply('autocrsreqvalidation:'.$dom.':'.&escape($owner).
9389: ':'.&escape($crstype).':'.&escape($inststatuslist).
9390: ':'.&escape($instcode).':'.&escape($instseclist).':'.
9391: $customdata,$homeserver));
9392: }
9393: return $response;
9394: }
9395:
9396: sub auto_validate_class_sec {
9397: my ($cdom,$cnum,$owners,$inst_class) = @_;
9398: my $homeserver = &homeserver($cnum,$cdom);
9399: my $ownerlist;
9400: if (ref($owners) eq 'ARRAY') {
9401: $ownerlist = join(',',@{$owners});
9402: } else {
9403: $ownerlist = $owners;
9404: }
9405: my $response=&reply('autovalidateclass_sec:'.$inst_class.':'.
9406: &escape($ownerlist).':'.$cdom,$homeserver);
9407: return $response;
9408: }
9409:
9410: sub auto_validate_instclasses {
9411: my ($cdom,$cnum,$owners,$classesref) = @_;
9412: my ($homeserver,%validations);
9413: $homeserver = &homeserver($cnum,$cdom);
9414: unless ($homeserver eq 'no_host') {
9415: my $ownerlist;
9416: if (ref($owners) eq 'ARRAY') {
9417: $ownerlist = join(',',@{$owners});
9418: } else {
9419: $ownerlist = $owners;
9420: }
9421: if (ref($classesref) eq 'HASH') {
9422: my $classes = &freeze_escape($classesref);
9423: my $response=&reply('autovalidateinstclasses:'.&escape($ownerlist).
9424: ':'.$cdom.':'.$classes,$homeserver);
9425: unless ($response =~ /(con_lost|error|no_such_host|refused)/) {
9426: my @items = split(/&/,$response);
9427: foreach my $item (@items) {
9428: my ($key,$value) = split('=',$item);
9429: $validations{&unescape($key)} = &thaw_unescape($value);
9430: }
9431: }
9432: }
9433: }
9434: return %validations;
9435: }
9436:
9437: sub auto_crsreq_update {
9438: my ($cdom,$cnum,$crstype,$action,$ownername,$ownerdomain,$fullname,$title,
9439: $code,$accessstart,$accessend,$inbound) = @_;
9440: my ($homeserver,%crsreqresponse);
9441: if ($cdom =~ /^$match_domain$/) {
9442: $homeserver = &domain($cdom,'primary');
9443: }
9444: unless (($homeserver eq 'no_host') || ($homeserver eq '')) {
9445: my $info;
9446: if (ref($inbound) eq 'HASH') {
9447: $info = &freeze_escape($inbound);
9448: }
9449: my $response=&reply('autocrsrequpdate:'.$cdom.':'.$cnum.':'.&escape($crstype).
9450: ':'.&escape($action).':'.&escape($ownername).':'.
9451: &escape($ownerdomain).':'.&escape($fullname).':'.
9452: &escape($title).':'.&escape($code).':'.
9453: &escape($accessstart).':'.&escape($accessend).':'.$info,
9454: $homeserver);
9455: unless ($response =~ /(con_lost|error|no_such_host|refused)/) {
9456: my @items = split(/&/,$response);
9457: foreach my $item (@items) {
9458: my ($key,$value) = split('=',$item);
9459: $crsreqresponse{&unescape($key)} = &thaw_unescape($value);
9460: }
9461: }
9462: }
9463: return \%crsreqresponse;
9464: }
9465:
9466: sub auto_export_grades {
9467: my ($cdom,$cnum,$inforef,$gradesref) = @_;
9468: my ($homeserver,%exportresponse);
9469: if ($cdom =~ /^$match_domain$/) {
9470: $homeserver = &domain($cdom,'primary');
9471: }
9472: unless (($homeserver eq 'no_host') || ($homeserver eq '')) {
9473: my $info;
9474: if (ref($inforef) eq 'HASH') {
9475: $info = &freeze_escape($inforef);
9476: }
9477: if (ref($gradesref) eq 'HASH') {
9478: my $grades = &freeze_escape($gradesref);
9479: my $response=&reply('encrypt:autoexportgrades:'.$cdom.':'.$cnum.':'.
9480: $info.':'.$grades,$homeserver);
9481: unless ($response =~ /(con_lost|error|no_such_host|refused|unknown_command)/) {
9482: my @items = split(/&/,$response);
9483: foreach my $item (@items) {
9484: my ($key,$value) = split('=',$item);
9485: $exportresponse{&unescape($key)} = &thaw_unescape($value);
9486: }
9487: }
9488: }
9489: }
9490: return \%exportresponse;
9491: }
9492:
9493: sub check_instcode_cloning {
9494: my ($codedefaults,$code_order,$cloner,$clonefromcode,$clonetocode) = @_;
9495: unless ((ref($codedefaults) eq 'HASH') && (ref($code_order) eq 'ARRAY')) {
9496: return;
9497: }
9498: my $canclone;
9499: if (@{$code_order} > 0) {
9500: my $instcoderegexp ='^';
9501: my @clonecodes = split(/\&/,$cloner);
9502: foreach my $item (@{$code_order}) {
9503: if (grep(/^\Q$item\E=/,@clonecodes)) {
9504: foreach my $pair (@clonecodes) {
9505: my ($key,$val) = split(/\=/,$pair,2);
9506: $val = &unescape($val);
9507: if ($key eq $item) {
9508: $instcoderegexp .= '('.$val.')';
9509: last;
9510: }
9511: }
9512: } else {
9513: $instcoderegexp .= $codedefaults->{$item};
9514: }
9515: }
9516: $instcoderegexp .= '$';
9517: my (@from,@to);
9518: eval {
9519: (@from) = ($clonefromcode =~ /$instcoderegexp/);
9520: (@to) = ($clonetocode =~ /$instcoderegexp/);
9521: };
9522: if ((@from > 0) && (@to > 0)) {
9523: my @diffs = &Apache::loncommon::compare_arrays(\@from,\@to);
9524: if (!@diffs) {
9525: $canclone = 1;
9526: }
9527: }
9528: }
9529: return $canclone;
9530: }
9531:
9532: sub default_instcode_cloning {
9533: my ($clonedom,$domdefclone,$clonefromcode,$clonetocode,$codedefaultsref,$codeorderref) = @_;
9534: my (%codedefaults,@code_order,$canclone);
9535: if ((ref($codedefaultsref) eq 'HASH') && (ref($codeorderref) eq 'ARRAY')) {
9536: %codedefaults = %{$codedefaultsref};
9537: @code_order = @{$codeorderref};
9538: } elsif ($clonedom) {
9539: &auto_instcode_defaults($clonedom,\%codedefaults,\@code_order);
9540: }
9541: if (($domdefclone) && (@code_order)) {
9542: my @clonecodes = split(/\+/,$domdefclone);
9543: my $instcoderegexp ='^';
9544: foreach my $item (@code_order) {
9545: if (grep(/^\Q$item\E$/,@clonecodes)) {
9546: $instcoderegexp .= '('.$codedefaults{$item}.')';
9547: } else {
9548: $instcoderegexp .= $codedefaults{$item};
9549: }
9550: }
9551: $instcoderegexp .= '$';
9552: my (@from,@to);
9553: eval {
9554: (@from) = ($clonefromcode =~ /$instcoderegexp/);
9555: (@to) = ($clonetocode =~ /$instcoderegexp/);
9556: };
9557: if ((@from > 0) && (@to > 0)) {
9558: my @diffs = &Apache::loncommon::compare_arrays(\@from,\@to);
9559: if (!@diffs) {
9560: $canclone = 1;
9561: }
9562: }
9563: }
9564: return $canclone;
9565: }
9566:
9567: # ------------------------------------------------------- Course Group routines
9568:
9569: sub get_coursegroups {
9570: my ($cdom,$cnum,$group,$namespace) = @_;
9571: return(&dump($namespace,$cdom,$cnum,$group));
9572: }
9573:
9574: sub modify_coursegroup {
9575: my ($cdom,$cnum,$groupsettings) = @_;
9576: return(&put('coursegroups',$groupsettings,$cdom,$cnum));
9577: }
9578:
9579: sub toggle_coursegroup_status {
9580: my ($cdom,$cnum,$group,$action) = @_;
9581: my ($from_namespace,$to_namespace);
9582: if ($action eq 'delete') {
9583: $from_namespace = 'coursegroups';
9584: $to_namespace = 'deleted_groups';
9585: } else {
9586: $from_namespace = 'deleted_groups';
9587: $to_namespace = 'coursegroups';
9588: }
9589: my %curr_group = &get_coursegroups($cdom,$cnum,$group,$from_namespace);
9590: if (my $tmp = &error(%curr_group)) {
9591: &Apache::lonnet::logthis('Error retrieving group: '.$tmp.' in '.$cnum.':'.$cdom);
9592: return ('read error',$tmp);
9593: } else {
9594: my %savedsettings = %curr_group;
9595: my $result = &put($to_namespace,\%savedsettings,$cdom,$cnum);
9596: my $deloutcome;
9597: if ($result eq 'ok') {
9598: $deloutcome = &del($from_namespace,[$group],$cdom,$cnum);
9599: } else {
9600: return ('write error',$result);
9601: }
9602: if ($deloutcome eq 'ok') {
9603: return 'ok';
9604: } else {
9605: return ('delete error',$deloutcome);
9606: }
9607: }
9608: }
9609:
9610: sub modify_group_roles {
9611: my ($cdom,$cnum,$group_id,$user,$end,$start,$userprivs,$selfenroll,$context) = @_;
9612: my $url = '/'.$cdom.'/'.$cnum.'/'.$group_id;
9613: my $role = 'gr/'.&escape($userprivs);
9614: my ($uname,$udom) = split(/:/,$user);
9615: my $result = &assignrole($udom,$uname,$url,$role,$end,$start,'',$selfenroll,$context);
9616: if ($result eq 'ok') {
9617: &devalidate_getgroups_cache($udom,$uname,$cdom,$cnum);
9618: }
9619: return $result;
9620: }
9621:
9622: sub modify_coursegroup_membership {
9623: my ($cdom,$cnum,$membership) = @_;
9624: my $result = &put('groupmembership',$membership,$cdom,$cnum);
9625: return $result;
9626: }
9627:
9628: sub get_active_groups {
9629: my ($udom,$uname,$cdom,$cnum) = @_;
9630: my $now = time;
9631: my %groups = ();
9632: foreach my $key (keys(%env)) {
9633: if ($key =~ m-user\.role\.gr\./($match_domain)/($match_courseid)/(\w+)$-) {
9634: my ($start,$end) = split(/\./,$env{$key});
9635: if (($end!=0) && ($end<$now)) { next; }
9636: if (($start!=0) && ($start>$now)) { next; }
9637: if ($1 eq $cdom && $2 eq $cnum) {
9638: $groups{$3} = $env{$key} ;
9639: }
9640: }
9641: }
9642: return %groups;
9643: }
9644:
9645: sub get_group_membership {
9646: my ($cdom,$cnum,$group) = @_;
9647: return(&dump('groupmembership',$cdom,$cnum,$group));
9648: }
9649:
9650: sub get_users_groups {
9651: my ($udom,$uname,$courseid) = @_;
9652: my @usersgroups;
9653: my $cachetime=1800;
9654:
9655: my $hashid="$udom:$uname:$courseid";
9656: my ($grouplist,$cached)=&is_cached_new('getgroups',$hashid);
9657: if (defined($cached)) {
9658: @usersgroups = split(/:/,$grouplist);
9659: } else {
9660: $grouplist = '';
9661: my $courseurl = &courseid_to_courseurl($courseid);
9662: my %roleshash = &dump('roles',$udom,$uname,$courseurl);
9663: my $access_end = $env{'course.'.$courseid.
9664: '.default_enrollment_end_date'};
9665: my $now = time;
9666: foreach my $key (keys(%roleshash)) {
9667: if ($key =~ /^\Q$courseurl\E\/(\w+)\_gr$/) {
9668: my $group = $1;
9669: if ($roleshash{$key} =~ /_(\d+)_(\d+)$/) {
9670: my $start = $2;
9671: my $end = $1;
9672: if ($start == -1) { next; } # deleted from group
9673: if (($start!=0) && ($start>$now)) { next; }
9674: if (($end!=0) && ($end<$now)) {
9675: if ($access_end && $access_end < $now) {
9676: if ($access_end - $end < 86400) {
9677: push(@usersgroups,$group);
9678: }
9679: }
9680: next;
9681: }
9682: push(@usersgroups,$group);
9683: }
9684: }
9685: }
9686: @usersgroups = &sort_course_groups($courseid,@usersgroups);
9687: $grouplist = join(':',@usersgroups);
9688: &do_cache_new('getgroups',$hashid,$grouplist,$cachetime);
9689: }
9690: return @usersgroups;
9691: }
9692:
9693: sub devalidate_getgroups_cache {
9694: my ($udom,$uname,$cdom,$cnum)=@_;
9695: my $courseid = $cdom.'_'.$cnum;
9696:
9697: my $hashid="$udom:$uname:$courseid";
9698: &devalidate_cache_new('getgroups',$hashid);
9699: }
9700:
9701: # ------------------------------------------------------------------ Plain Text
9702:
9703: sub plaintext {
9704: my ($short,$type,$cid,$forcedefault) = @_;
9705: if ($short =~ m{^cr/}) {
9706: return (split('/',$short))[-1];
9707: }
9708: if (!defined($cid)) {
9709: $cid = $env{'request.course.id'};
9710: }
9711: my %rolenames = (
9712: Course => 'std',
9713: Community => 'alt1',
9714: Placement => 'std',
9715: );
9716: if ($cid ne '') {
9717: if ($env{'course.'.$cid.'.'.$short.'.plaintext'} ne '') {
9718: unless ($forcedefault) {
9719: my $roletext = $env{'course.'.$cid.'.'.$short.'.plaintext'};
9720: &Apache::lonlocal::mt_escape(\$roletext);
9721: return &Apache::lonlocal::mt($roletext);
9722: }
9723: }
9724: }
9725: if ((defined($type)) && (defined($rolenames{$type})) &&
9726: (defined($rolenames{$type})) &&
9727: (defined($prp{$short}{$rolenames{$type}}))) {
9728: return &Apache::lonlocal::mt($prp{$short}{$rolenames{$type}});
9729: } elsif ($cid ne '') {
9730: my $crstype = $env{'course.'.$cid.'.type'};
9731: if (($crstype ne '') && (defined($rolenames{$crstype})) &&
9732: (defined($prp{$short}{$rolenames{$crstype}}))) {
9733: return &Apache::lonlocal::mt($prp{$short}{$rolenames{$crstype}});
9734: }
9735: }
9736: return &Apache::lonlocal::mt($prp{$short}{'std'});
9737: }
9738:
9739: # ----------------------------------------------------------------- Assign Role
9740:
9741: sub assignrole {
9742: my ($udom,$uname,$url,$role,$end,$start,$deleteflag,$selfenroll,
9743: $context)=@_;
9744: my $mrole;
9745: if ($role =~ /^cr\//) {
9746: my $cwosec=$url;
9747: $cwosec=~s/^\/($match_domain)\/($match_courseid)\/.*/$1\/$2/;
9748: unless (&allowed('ccr',$cwosec)) {
9749: my $refused = 1;
9750: if ($context eq 'requestcourses') {
9751: if (($env{'user.name'} ne '') && ($env{'user.domain'} ne '')) {
9752: if ($role =~ m{^cr/($match_domain)/($match_username)/([^/]+)$}) {
9753: if (($1 eq $env{'user.domain'}) && ($2 eq $env{'user.name'})) {
9754: my ($cdom,$cnum) = ($cwosec =~ m{^/?($match_domain)/($match_courseid)$});
9755: my %crsenv = &userenvironment($cdom,$cnum,('internal.courseowner'));
9756: if ($crsenv{'internal.courseowner'} eq
9757: $env{'user.name'}.':'.$env{'user.domain'}) {
9758: $refused = '';
9759: }
9760: }
9761: }
9762: }
9763: }
9764: if ($refused) {
9765: &logthis('Refused custom assignrole: '.
9766: $udom.' '.$uname.' '.$url.' '.$role.' '.$end.' '.$start.
9767: ' by '.$env{'user.name'}.' at '.$env{'user.domain'});
9768: return 'refused';
9769: }
9770: }
9771: $mrole='cr';
9772: } elsif ($role =~ /^gr\//) {
9773: my $cwogrp=$url;
9774: $cwogrp=~s{^/($match_domain)/($match_courseid)/.*}{$1/$2};
9775: unless (&allowed('mdg',$cwogrp)) {
9776: &logthis('Refused group assignrole: '.
9777: $udom.' '.$uname.' '.$url.' '.$role.' '.$end.' '.$start.' by '.
9778: $env{'user.name'}.' at '.$env{'user.domain'});
9779: return 'refused';
9780: }
9781: $mrole='gr';
9782: } else {
9783: my $cwosec=$url;
9784: $cwosec=~s/^\/($match_domain)\/($match_courseid)\/.*/$1\/$2/;
9785: if (!(&allowed('c'.$role,$cwosec)) && !(&allowed('c'.$role,$udom))) {
9786: my $refused;
9787: if (($env{'request.course.sec'} ne '') && ($role eq 'st')) {
9788: if (!(&allowed('c'.$role,$url))) {
9789: $refused = 1;
9790: }
9791: } else {
9792: $refused = 1;
9793: }
9794: if ($refused) {
9795: my ($cdom,$cnum) = ($cwosec =~ m{^/?($match_domain)/($match_courseid)$});
9796: if (!$selfenroll && (($context eq 'course') || ($context eq 'ltienroll' && $env{'request.lti.login'}))) {
9797: my %crsenv;
9798: if ($role eq 'cc' || $role eq 'co') {
9799: %crsenv = &userenvironment($cdom,$cnum,('internal.courseowner'));
9800: if (($role eq 'cc') && ($cnum !~ /^$match_community$/)) {
9801: if ($env{'request.role'} eq 'cc./'.$cdom.'/'.$cnum) {
9802: if ($crsenv{'internal.courseowner'} eq
9803: $env{'user.name'}.':'.$env{'user.domain'}) {
9804: $refused = '';
9805: }
9806: }
9807: } elsif (($role eq 'co') && ($cnum =~ /^$match_community$/)) {
9808: if ($env{'request.role'} eq 'co./'.$cdom.'/'.$cnum) {
9809: if ($crsenv{'internal.courseowner'} eq
9810: $env{'user.name'}.':'.$env{'user.domain'}) {
9811: $refused = '';
9812: }
9813: }
9814: }
9815: }
9816: } elsif (($selfenroll == 1) && ($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'})) {
9817: if ($role eq 'st') {
9818: $refused = '';
9819: } elsif (($context eq 'ltienroll') && ($env{'request.lti.login'})) {
9820: $refused = '';
9821: }
9822: } elsif ($context eq 'requestcourses') {
9823: my @possroles = ('st','ta','ep','in','cc','co');
9824: if ((grep(/^\Q$role\E$/,@possroles)) && ($env{'user.name'} ne '' && $env{'user.domain'} ne '')) {
9825: my $wrongcc;
9826: if ($cnum =~ /^$match_community$/) {
9827: $wrongcc = 1 if ($role eq 'cc');
9828: } else {
9829: $wrongcc = 1 if ($role eq 'co');
9830: }
9831: unless ($wrongcc) {
9832: my %crsenv = &userenvironment($cdom,$cnum,('internal.courseowner'));
9833: if ($crsenv{'internal.courseowner'} eq
9834: $env{'user.name'}.':'.$env{'user.domain'}) {
9835: $refused = '';
9836: }
9837: }
9838: }
9839: } elsif ($context eq 'requestauthor') {
9840: if (($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'}) &&
9841: ($url eq '/'.$udom.'/') && ($role eq 'au')) {
9842: if ($env{'environment.requestauthor'} eq 'automatic') {
9843: $refused = '';
9844: } else {
9845: my %domdefaults = &get_domain_defaults($udom);
9846: if (ref($domdefaults{'requestauthor'}) eq 'HASH') {
9847: my $checkbystatus;
9848: if ($env{'user.adv'}) {
9849: my $disposition = $domdefaults{'requestauthor'}{'_LC_adv'};
9850: if ($disposition eq 'automatic') {
9851: $refused = '';
9852: } elsif ($disposition eq '') {
9853: $checkbystatus = 1;
9854: }
9855: } else {
9856: $checkbystatus = 1;
9857: }
9858: if ($checkbystatus) {
9859: if ($env{'environment.inststatus'}) {
9860: my @inststatuses = split(/,/,$env{'environment.inststatus'});
9861: foreach my $type (@inststatuses) {
9862: if (($type ne '') &&
9863: ($domdefaults{'requestauthor'}{$type} eq 'automatic')) {
9864: $refused = '';
9865: }
9866: }
9867: } elsif ($domdefaults{'requestauthor'}{'default'} eq 'automatic') {
9868: $refused = '';
9869: }
9870: }
9871: }
9872: }
9873: }
9874: }
9875: if ($refused) {
9876: &logthis('Refused assignrole: '.$udom.' '.$uname.' '.$url.
9877: ' '.$role.' '.$end.' '.$start.' by '.
9878: $env{'user.name'}.' at '.$env{'user.domain'});
9879: return 'refused';
9880: }
9881: }
9882: } elsif ($role eq 'au') {
9883: if ($url ne '/'.$udom.'/') {
9884: &logthis('Attempt by '.$env{'user.name'}.':'.$env{'user.domain'}.
9885: ' to assign author role for '.$uname.':'.$udom.
9886: ' in domain: '.$url.' refused (wrong domain).');
9887: return 'refused';
9888: }
9889: }
9890: $mrole=$role;
9891: }
9892: my $command="encrypt:rolesput:$env{'user.domain'}:$env{'user.name'}:".
9893: "$udom:$uname:$url".'_'."$mrole=$role";
9894: if ($end) { $command.='_'.$end; }
9895: if ($start) {
9896: if ($end) {
9897: $command.='_'.$start;
9898: } else {
9899: $command.='_0_'.$start;
9900: }
9901: }
9902: my $origstart = $start;
9903: my $origend = $end;
9904: my $delflag;
9905: # actually delete
9906: if ($deleteflag) {
9907: if ((&allowed('dro',$udom)) || (&allowed('dro',$url))) {
9908: # modify command to delete the role
9909: $command="encrypt:rolesdel:$env{'user.domain'}:$env{'user.name'}:".
9910: "$udom:$uname:$url".'_'."$mrole";
9911: &logthis("$env{'user.name'} at $env{'user.domain'} deletes $mrole in $url for $uname at $udom");
9912: # set start and finish to negative values for userrolelog
9913: $start=-1;
9914: $end=-1;
9915: $delflag = 1;
9916: }
9917: }
9918: # send command
9919: my $answer=&reply($command,&homeserver($uname,$udom));
9920: # log new user role if status is ok
9921: if ($answer eq 'ok') {
9922: &userrolelog($role,$uname,$udom,$url,$start,$end);
9923: if (($role eq 'cc') || ($role eq 'in') ||
9924: ($role eq 'ep') || ($role eq 'ad') ||
9925: ($role eq 'ta') || ($role eq 'st') ||
9926: ($role=~/^cr/) || ($role eq 'gr') ||
9927: ($role eq 'co')) {
9928: # for course roles, perform group memberships changes triggered by role change.
9929: unless ($role =~ /^gr/) {
9930: &Apache::longroup::group_changes($udom,$uname,$url,$role,$origend,
9931: $origstart,$selfenroll,$context);
9932: }
9933: &courserolelog($role,$uname,$udom,$url,$origstart,$origend,$delflag,
9934: $selfenroll,$context);
9935: } elsif (($role eq 'li') || ($role eq 'dg') || ($role eq 'sc') ||
9936: ($role eq 'au') || ($role eq 'dc') || ($role eq 'dh') ||
9937: ($role eq 'da')) {
9938: &domainrolelog($role,$uname,$udom,$url,$origstart,$origend,$delflag,
9939: $context);
9940: } elsif (($role eq 'ca') || ($role eq 'aa')) {
9941: &coauthorrolelog($role,$uname,$udom,$url,$origstart,$origend,$delflag,
9942: $context);
9943: }
9944: if ($role eq 'cc') {
9945: &autoupdate_coowners($url,$end,$start,$uname,$udom);
9946: }
9947: }
9948: return $answer;
9949: }
9950:
9951: sub autoupdate_coowners {
9952: my ($url,$end,$start,$uname,$udom) = @_;
9953: my ($cdom,$cnum) = ($url =~ m{^/($match_domain)/($match_courseid)});
9954: if (($cdom ne '') && ($cnum ne '')) {
9955: my $now = time;
9956: my %domdesign = &Apache::loncommon::get_domainconf($cdom);
9957: if ($domdesign{$cdom.'.autoassign.co-owners'}) {
9958: my %coursehash = &coursedescription($cdom.'_'.$cnum);
9959: my $instcode = $coursehash{'internal.coursecode'};
9960: if ($instcode ne '') {
9961: if (($start && $start <= $now) && ($end == 0) || ($end > $now)) {
9962: unless ($coursehash{'internal.courseowner'} eq $uname.':'.$udom) {
9963: my ($delcoowners,@newcoowners,$putresult,$delresult,$coowners);
9964: my ($result,$desc) = &auto_validate_instcode($cnum,$cdom,$instcode,$uname.':'.$udom);
9965: if ($result eq 'valid') {
9966: if ($coursehash{'internal.co-owners'}) {
9967: foreach my $coowner (split(',',$coursehash{'internal.co-owners'})) {
9968: push(@newcoowners,$coowner);
9969: }
9970: unless (grep(/^\Q$uname\E:\Q$udom\E$/,@newcoowners)) {
9971: push(@newcoowners,$uname.':'.$udom);
9972: }
9973: @newcoowners = sort(@newcoowners);
9974: } else {
9975: push(@newcoowners,$uname.':'.$udom);
9976: }
9977: } else {
9978: if ($coursehash{'internal.co-owners'}) {
9979: foreach my $coowner (split(',',$coursehash{'internal.co-owners'})) {
9980: unless ($coowner eq $uname.':'.$udom) {
9981: push(@newcoowners,$coowner);
9982: }
9983: }
9984: unless (@newcoowners > 0) {
9985: $delcoowners = 1;
9986: $coowners = '';
9987: }
9988: }
9989: }
9990: if (@newcoowners || $delcoowners) {
9991: &store_coowners($cdom,$cnum,$coursehash{'home'},
9992: $delcoowners,@newcoowners);
9993: }
9994: }
9995: }
9996: }
9997: }
9998: }
9999: }
10000:
10001: sub store_coowners {
10002: my ($cdom,$cnum,$chome,$delcoowners,@newcoowners) = @_;
10003: my $cid = $cdom.'_'.$cnum;
10004: my ($coowners,$delresult,$putresult);
10005: if (@newcoowners) {
10006: $coowners = join(',',@newcoowners);
10007: my %coownershash = (
10008: 'internal.co-owners' => $coowners,
10009: );
10010: $putresult = &put('environment',\%coownershash,$cdom,$cnum);
10011: if ($putresult eq 'ok') {
10012: if ($env{'course.'.$cid.'.num'} eq $cnum) {
10013: &appenv({'course.'.$cid.'.internal.co-owners' => $coowners});
10014: }
10015: }
10016: }
10017: if ($delcoowners) {
10018: $delresult = &Apache::lonnet::del('environment',['internal.co-owners'],$cdom,$cnum);
10019: if ($delresult eq 'ok') {
10020: if ($env{'course.'.$cid.'.internal.co-owners'}) {
10021: &Apache::lonnet::delenv('course.'.$cid.'.internal.co-owners');
10022: }
10023: }
10024: }
10025: if (($putresult eq 'ok') || ($delresult eq 'ok')) {
10026: my %crsinfo =
10027: &Apache::lonnet::courseiddump($cdom,'.',1,'.','.',$cnum,undef,undef,'.');
10028: if (ref($crsinfo{$cid}) eq 'HASH') {
10029: $crsinfo{$cid}{'co-owners'} = \@newcoowners;
10030: my $cidput = &Apache::lonnet::courseidput($cdom,\%crsinfo,$chome,'notime');
10031: }
10032: }
10033: }
10034:
10035: # -------------------------------------------------- Modify user authentication
10036: # Overrides without validation
10037:
10038: sub modifyuserauth {
10039: my ($udom,$uname,$umode,$upass)=@_;
10040: my $uhome=&homeserver($uname,$udom);
10041: unless (&allowed('mau',$udom)) { return 'refused'; }
10042: &logthis('Call to modify user authentication '.$udom.', '.$uname.', '.
10043: $umode.' by '.$env{'user.name'}.' at '.$env{'user.domain'}.
10044: ' in domain '.$env{'request.role.domain'});
10045: my $reply=&reply('encrypt:changeuserauth:'.$udom.':'.$uname.':'.$umode.':'.
10046: &escape($upass),$uhome);
10047: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},
10048: 'Authentication changed for '.$udom.', '.$uname.', '.$umode.
10049: '(Remote '.$ENV{'REMOTE_ADDR'}.'): '.$reply);
10050: &log($udom,,$uname,$uhome,
10051: 'Authentication changed by '.$env{'user.domain'}.', '.
10052: $env{'user.name'}.', '.$umode.
10053: '(Remote '.$ENV{'REMOTE_ADDR'}.'): '.$reply);
10054: unless ($reply eq 'ok') {
10055: &logthis('Authentication mode error: '.$reply);
10056: return 'error: '.$reply;
10057: }
10058: return 'ok';
10059: }
10060:
10061: # --------------------------------------------------------------- Modify a user
10062:
10063: sub modifyuser {
10064: my ($udom, $uname, $uid,
10065: $umode, $upass, $first,
10066: $middle, $last, $gene,
10067: $forceid, $desiredhome, $email, $inststatus, $candelete)=@_;
10068: $udom= &LONCAPA::clean_domain($udom);
10069: $uname=&LONCAPA::clean_username($uname);
10070: my $showcandelete = 'none';
10071: if (ref($candelete) eq 'ARRAY') {
10072: if (@{$candelete} > 0) {
10073: $showcandelete = join(', ',@{$candelete});
10074: }
10075: }
10076: &logthis('Call to modify user '.$udom.', '.$uname.', '.$uid.', '.
10077: $umode.', '.$first.', '.$middle.', '.
10078: $last.', '.$gene.'(forceid: '.$forceid.'; candelete: '.$showcandelete.')'.
10079: (defined($desiredhome) ? ' desiredhome = '.$desiredhome :
10080: ' desiredhome not specified').
10081: ' by '.$env{'user.name'}.' at '.$env{'user.domain'}.
10082: ' in domain '.$env{'request.role.domain'});
10083: my $uhome=&homeserver($uname,$udom,'true');
10084: my $newuser;
10085: if ($uhome eq 'no_host') {
10086: $newuser = 1;
10087: unless (($umode && ($upass ne '')) || ($umode eq 'localauth') ||
10088: ($umode eq 'lti')) {
10089: return 'error: more information needed to create new user';
10090: }
10091: }
10092: # ----------------------------------------------------------------- Create User
10093: if (($uhome eq 'no_host') &&
10094: (($umode && $upass) || ($umode eq 'localauth') || ($umode eq 'lti'))) {
10095: my $unhome='';
10096: if (defined($desiredhome) && &host_domain($desiredhome) eq $udom) {
10097: $unhome = $desiredhome;
10098: } elsif($env{'course.'.$env{'request.course.id'}.'.domain'} eq $udom) {
10099: $unhome=$env{'course.'.$env{'request.course.id'}.'.home'};
10100: } else { # load balancing routine for determining $unhome
10101: my $loadm=10000000;
10102: my %servers = &get_servers($udom,'library');
10103: foreach my $tryserver (keys(%servers)) {
10104: my $answer=reply('load',$tryserver);
10105: if (($answer=~/\d+/) && ($answer<$loadm)) {
10106: $loadm=$answer;
10107: $unhome=$tryserver;
10108: }
10109: }
10110: }
10111: if (($unhome eq '') || ($unhome eq 'no_host')) {
10112: return 'error: unable to find a home server for '.$uname.
10113: ' in domain '.$udom;
10114: }
10115: my $reply=&reply('encrypt:makeuser:'.$udom.':'.$uname.':'.$umode.':'.
10116: &escape($upass),$unhome);
10117: unless ($reply eq 'ok') {
10118: return 'error: '.$reply;
10119: }
10120: $uhome=&homeserver($uname,$udom,'true');
10121: if (($uhome eq '') || ($uhome eq 'no_host') || ($uhome ne $unhome)) {
10122: return 'error: unable verify users home machine.';
10123: }
10124: } # End of creation of new user
10125: # ---------------------------------------------------------------------- Add ID
10126: if ($uid) {
10127: $uid=~tr/A-Z/a-z/;
10128: my %uidhash=&idrget($udom,$uname);
10129: if (($uidhash{$uname}) && ($uidhash{$uname}!~/error\:/)
10130: && (!$forceid)) {
10131: unless ($uid eq $uidhash{$uname}) {
10132: return 'error: user id "'.$uid.'" does not match '.
10133: 'current user id "'.$uidhash{$uname}.'".';
10134: }
10135: } else {
10136: &idput($udom,{$uname => $uid},$uhome,'ids');
10137: }
10138: }
10139: # -------------------------------------------------------------- Add names, etc
10140: my @tmp=&get('environment',
10141: ['firstname','middlename','lastname','generation','id',
10142: 'permanentemail','inststatus'],
10143: $udom,$uname);
10144: my (%names,%oldnames);
10145: if ($tmp[0] =~ m/^error:.*/) {
10146: %names=();
10147: } else {
10148: %names = @tmp;
10149: %oldnames = %names;
10150: }
10151: #
10152: # If name, email and/or uid are blank (e.g., because an uploaded file
10153: # of users did not contain them), do not overwrite existing values
10154: # unless field is in $candelete array ref.
10155: #
10156:
10157: my @fields = ('firstname','middlename','lastname','generation',
10158: 'permanentemail','id');
10159: my %newvalues;
10160: if (ref($candelete) eq 'ARRAY') {
10161: foreach my $field (@fields) {
10162: if (grep(/^\Q$field\E$/,@{$candelete})) {
10163: if ($field eq 'firstname') {
10164: $names{$field} = $first;
10165: } elsif ($field eq 'middlename') {
10166: $names{$field} = $middle;
10167: } elsif ($field eq 'lastname') {
10168: $names{$field} = $last;
10169: } elsif ($field eq 'generation') {
10170: $names{$field} = $gene;
10171: } elsif ($field eq 'permanentemail') {
10172: $names{$field} = $email;
10173: } elsif ($field eq 'id') {
10174: $names{$field} = $uid;
10175: }
10176: }
10177: }
10178: }
10179: if ($first) { $names{'firstname'} = $first; }
10180: if (defined($middle)) { $names{'middlename'} = $middle; }
10181: if ($last) { $names{'lastname'} = $last; }
10182: if (defined($gene)) { $names{'generation'} = $gene; }
10183: if ($email) {
10184: $email=~s/[^\w\@\.\-\,]//gs;
10185: if ($email=~/\@/) { $names{'permanentemail'} = $email; }
10186: }
10187: if ($uid) { $names{'id'} = $uid; }
10188: if (defined($inststatus)) {
10189: $names{'inststatus'} = '';
10190: my ($usertypes,$typesorder) = &retrieve_inst_usertypes($udom);
10191: if (ref($usertypes) eq 'HASH') {
10192: my @okstatuses;
10193: foreach my $item (split(/:/,$inststatus)) {
10194: if (defined($usertypes->{$item})) {
10195: push(@okstatuses,$item);
10196: }
10197: }
10198: if (@okstatuses) {
10199: $names{'inststatus'} = join(':', map { &escape($_); } @okstatuses);
10200: }
10201: }
10202: }
10203: my $logmsg = $udom.', '.$uname.', '.$uid.', '.
10204: $umode.', '.$first.', '.$middle.', '.
10205: $last.', '.$gene.', '.$email.', '.$inststatus;
10206: if ($env{'user.name'} ne '' && $env{'user.domain'}) {
10207: $logmsg .= ' by '.$env{'user.name'}.' at '.$env{'user.domain'};
10208: } else {
10209: $logmsg .= ' during self creation';
10210: }
10211: my $changed;
10212: if ($newuser) {
10213: $changed = 1;
10214: } else {
10215: foreach my $field (@fields) {
10216: if ($names{$field} ne $oldnames{$field}) {
10217: $changed = 1;
10218: last;
10219: }
10220: }
10221: }
10222: unless ($changed) {
10223: $logmsg = 'No changes in user information needed for: '.$logmsg;
10224: &logthis($logmsg);
10225: return 'ok';
10226: }
10227: my $reply = &put('environment', \%names, $udom,$uname);
10228: if ($reply ne 'ok') {
10229: return 'error: '.$reply;
10230: }
10231: if ($names{'permanentemail'} ne $oldnames{'permanentemail'}) {
10232: &Apache::lonnet::devalidate_cache_new('emailscache',$uname.':'.$udom);
10233: }
10234: my $sqlresult = &update_allusers_table($uname,$udom,\%names);
10235: &devalidate_cache_new('namescache',$uname.':'.$udom);
10236: $logmsg = 'Success modifying user '.$logmsg;
10237: &logthis($logmsg);
10238: return 'ok';
10239: }
10240:
10241: # -------------------------------------------------------------- Modify student
10242:
10243: sub modifystudent {
10244: my ($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene,$usec,
10245: $end,$start,$forceid,$desiredhome,$email,$type,$locktype,$cid,
10246: $selfenroll,$context,$inststatus,$credits,$instsec)=@_;
10247: if (!$cid) {
10248: unless ($cid=$env{'request.course.id'}) {
10249: return 'not_in_class';
10250: }
10251: }
10252: # --------------------------------------------------------------- Make the user
10253: my $reply=&modifyuser
10254: ($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene,$forceid,
10255: $desiredhome,$email,$inststatus);
10256: unless ($reply eq 'ok') { return $reply; }
10257: # This will cause &modify_student_enrollment to get the uid from the
10258: # student's environment
10259: $uid = undef if (!$forceid);
10260: $reply = &modify_student_enrollment($udom,$uname,$uid,$first,$middle,$last,
10261: $gene,$usec,$end,$start,$type,$locktype,
10262: $cid,$selfenroll,$context,$credits,$instsec);
10263: return $reply;
10264: }
10265:
10266: sub modify_student_enrollment {
10267: my ($udom,$uname,$uid,$first,$middle,$last,$gene,$usec,$end,$start,$type,
10268: $locktype,$cid,$selfenroll,$context,$credits,$instsec) = @_;
10269: my ($cdom,$cnum,$chome);
10270: if (!$cid) {
10271: unless ($cid=$env{'request.course.id'}) {
10272: return 'not_in_class';
10273: }
10274: $cdom=$env{'course.'.$cid.'.domain'};
10275: $cnum=$env{'course.'.$cid.'.num'};
10276: } else {
10277: ($cdom,$cnum)=split(/_/,$cid);
10278: }
10279: $chome=$env{'course.'.$cid.'.home'};
10280: if (!$chome) {
10281: $chome=&homeserver($cnum,$cdom);
10282: }
10283: if (!$chome) { return 'unknown_course'; }
10284: # Make sure the user exists
10285: my $uhome=&homeserver($uname,$udom);
10286: if (($uhome eq '') || ($uhome eq 'no_host')) {
10287: return 'error: no such user';
10288: }
10289: # Get student data if we were not given enough information
10290: if (!defined($first) || $first eq '' ||
10291: !defined($last) || $last eq '' ||
10292: !defined($uid) || $uid eq '' ||
10293: !defined($middle) || $middle eq '' ||
10294: !defined($gene) || $gene eq '') {
10295: # They did not supply us with enough data to enroll the student, so
10296: # we need to pick up more information.
10297: my %tmp = &get('environment',
10298: ['firstname','middlename','lastname', 'generation','id']
10299: ,$udom,$uname);
10300:
10301: #foreach my $key (keys(%tmp)) {
10302: # &logthis("key $key = ".$tmp{$key});
10303: #}
10304: $first = $tmp{'firstname'} if (!defined($first) || $first eq '');
10305: $middle = $tmp{'middlename'} if (!defined($middle) || $middle eq '');
10306: $last = $tmp{'lastname'} if (!defined($last) || $last eq '');
10307: $gene = $tmp{'generation'} if (!defined($gene) || $gene eq '');
10308: $uid = $tmp{'id'} if (!defined($uid) || $uid eq '');
10309: }
10310: my $fullname = &format_name($first,$middle,$last,$gene,'lastname');
10311: my $user = "$uname:$udom";
10312: my %old_entry = &Apache::lonnet::get('classlist',[$user],$cdom,$cnum);
10313: my $reply=cput('classlist',
10314: {$user =>
10315: join(':',$end,$start,$uid,$usec,$fullname,$type,$locktype,$credits,$instsec) },
10316: $cdom,$cnum);
10317: if (($reply eq 'ok') || ($reply eq 'delayed')) {
10318: &devalidate_getsection_cache($udom,$uname,$cid);
10319: } else {
10320: return 'error: '.$reply;
10321: }
10322: # Add student role to user
10323: my $uurl='/'.$cid;
10324: $uurl=~s/\_/\//g;
10325: if ($usec) {
10326: $uurl.='/'.$usec;
10327: }
10328: my $result = &assignrole($udom,$uname,$uurl,'st',$end,$start,undef,
10329: $selfenroll,$context);
10330: if ($result ne 'ok') {
10331: if ($old_entry{$user} ne '') {
10332: $reply = &cput('classlist',\%old_entry,$cdom,$cnum);
10333: } else {
10334: $reply = &del('classlist',[$user],$cdom,$cnum);
10335: }
10336: }
10337: return $result;
10338: }
10339:
10340: sub format_name {
10341: my ($firstname,$middlename,$lastname,$generation,$first)=@_;
10342: my $name;
10343: if ($first ne 'lastname') {
10344: $name=$firstname.' '.$middlename.' '.$lastname.' '.$generation;
10345: } else {
10346: if ($lastname=~/\S/) {
10347: $name.= $lastname.' '.$generation.', '.$firstname.' '.$middlename;
10348: $name=~s/\s+,/,/;
10349: } else {
10350: $name.= $firstname.' '.$middlename.' '.$generation;
10351: }
10352: }
10353: $name=~s/^\s+//;
10354: $name=~s/\s+$//;
10355: $name=~s/\s+/ /g;
10356: return $name;
10357: }
10358:
10359: # ------------------------------------------------- Write to course preferences
10360:
10361: sub writecoursepref {
10362: my ($courseid,%prefs)=@_;
10363: $courseid=~s/^\///;
10364: $courseid=~s/\_/\//g;
10365: my ($cdomain,$cnum)=split(/\//,$courseid);
10366: my $chome=homeserver($cnum,$cdomain);
10367: if (($chome eq '') || ($chome eq 'no_host')) {
10368: return 'error: no such course';
10369: }
10370: my $cstring='';
10371: foreach my $pref (keys(%prefs)) {
10372: $cstring.=&escape($pref).'='.&escape($prefs{$pref}).'&';
10373: }
10374: $cstring=~s/\&$//;
10375: return reply('put:'.$cdomain.':'.$cnum.':environment:'.$cstring,$chome);
10376: }
10377:
10378: # ---------------------------------------------------------- Make/modify course
10379:
10380: sub createcourse {
10381: my ($udom,$description,$url,$course_server,$nonstandard,$inst_code,
10382: $course_owner,$crstype,$cnum,$context,$category)=@_;
10383: $url=&declutter($url);
10384: my $cid='';
10385: if ($context eq 'requestcourses') {
10386: my $can_create = 0;
10387: my ($ownername,$ownerdom) = split(':',$course_owner);
10388: if ($udom eq $ownerdom) {
10389: if (&usertools_access($ownername,$ownerdom,$category,undef,
10390: $context)) {
10391: $can_create = 1;
10392: }
10393: } else {
10394: my %userenv = &userenvironment($ownerdom,$ownername,'reqcrsotherdom.'.
10395: $category);
10396: if ($userenv{'reqcrsotherdom.'.$category} ne '') {
10397: my @curr = split(',',$userenv{'reqcrsotherdom.'.$category});
10398: if (@curr > 0) {
10399: my @options = qw(approval validate autolimit);
10400: my $optregex = join('|',@options);
10401: if (grep(/^\Q$udom\E:($optregex)(=?\d*)$/,@curr)) {
10402: $can_create = 1;
10403: }
10404: }
10405: }
10406: }
10407: if ($can_create) {
10408: unless ($ownername eq $env{'user.name'} && $ownerdom eq $env{'user.domain'}) {
10409: unless (&allowed('ccc',$udom)) {
10410: return 'refused';
10411: }
10412: }
10413: } else {
10414: return 'refused';
10415: }
10416: } elsif (!&allowed('ccc',$udom)) {
10417: return 'refused';
10418: }
10419: # --------------------------------------------------------------- Get Unique ID
10420: my $uname;
10421: if ($cnum =~ /^$match_courseid$/) {
10422: my $chome=&homeserver($cnum,$udom,'true');
10423: if (($chome eq '') || ($chome eq 'no_host')) {
10424: $uname = $cnum;
10425: } else {
10426: $uname = &generate_coursenum($udom,$crstype);
10427: }
10428: } else {
10429: $uname = &generate_coursenum($udom,$crstype);
10430: }
10431: return $uname if ($uname =~ /^error/);
10432: # -------------------------------------------------- Check supplied server name
10433: if (!defined($course_server)) {
10434: if (defined(&domain($udom,'primary'))) {
10435: $course_server = &domain($udom,'primary');
10436: } else {
10437: $course_server = $env{'user.home'};
10438: }
10439: }
10440: my %host_servers =
10441: &Apache::lonnet::get_servers($udom,'library');
10442: unless ($host_servers{$course_server}) {
10443: return 'error: invalid home server for course: '.$course_server;
10444: }
10445: # ------------------------------------------------------------- Make the course
10446: my $reply=&reply('encrypt:makeuser:'.$udom.':'.$uname.':none::',
10447: $course_server);
10448: unless ($reply eq 'ok') { return 'error: '.$reply; }
10449: my $uhome=&homeserver($uname,$udom,'true');
10450: if (($uhome eq '') || ($uhome eq 'no_host')) {
10451: return 'error: no such course';
10452: }
10453: # ----------------------------------------------------------------- Course made
10454: # log existence
10455: my $now = time;
10456: my $newcourse = {
10457: $udom.'_'.$uname => {
10458: description => $description,
10459: inst_code => $inst_code,
10460: owner => $course_owner,
10461: type => $crstype,
10462: creator => $env{'user.name'}.':'.
10463: $env{'user.domain'},
10464: created => $now,
10465: context => $context,
10466: },
10467: };
10468: &courseidput($udom,$newcourse,$uhome,'notime');
10469: # set toplevel url
10470: my $topurl=$url;
10471: unless ($nonstandard) {
10472: # ------------------------------------------ For standard courses, make top url
10473: my $mapurl=&clutter($url);
10474: if ($mapurl eq '/res/') { $mapurl=''; }
10475: $env{'form.initmap'}=(<<ENDINITMAP);
10476: <map>
10477: <resource id="1" type="start"></resource>
10478: <resource id="2" src="$mapurl"></resource>
10479: <resource id="3" type="finish"></resource>
10480: <link index="1" from="1" to="2"></link>
10481: <link index="2" from="2" to="3"></link>
10482: </map>
10483: ENDINITMAP
10484: $topurl=&declutter(
10485: &finishuserfileupload($uname,$udom,'initmap','default.sequence')
10486: );
10487: }
10488: # ----------------------------------------------------------- Write preferences
10489: &writecoursepref($udom.'_'.$uname,
10490: ('description' => $description,
10491: 'url' => $topurl,
10492: 'internal.creator' => $env{'user.name'}.':'.
10493: $env{'user.domain'},
10494: 'internal.created' => $now,
10495: 'internal.creationcontext' => $context)
10496: );
10497: return '/'.$udom.'/'.$uname;
10498: }
10499:
10500: # ------------------------------------------------------------------- Create ID
10501: sub generate_coursenum {
10502: my ($udom,$crstype) = @_;
10503: my $domdesc = &domain($udom);
10504: return 'error: invalid domain' if ($domdesc eq '');
10505: my $first;
10506: if ($crstype eq 'Community') {
10507: $first = '0';
10508: } else {
10509: $first = int(1+rand(9));
10510: }
10511: my $uname=$first.
10512: ('a'..'z','A'..'Z','0'..'9')[int(rand(62))].
10513: substr($$.time,0,5).unpack("H8",pack("I32",time)).
10514: unpack("H2",pack("I32",int(rand(255)))).$perlvar{'lonHostID'};
10515: # ----------------------------------------------- Make sure that does not exist
10516: my $uhome=&homeserver($uname,$udom,'true');
10517: unless (($uhome eq '') || ($uhome eq 'no_host')) {
10518: if ($crstype eq 'Community') {
10519: $first = '0';
10520: } else {
10521: $first = int(1+rand(9));
10522: }
10523: $uname=$first.
10524: ('a'..'z','A'..'Z','0'..'9')[int(rand(62))].
10525: substr($$.time,0,5).unpack("H8",pack("I32",time)).
10526: unpack("H2",pack("I32",int(rand(255)))).$perlvar{'lonHostID'};
10527: $uhome=&homeserver($uname,$udom,'true');
10528: unless (($uhome eq '') || ($uhome eq 'no_host')) {
10529: return 'error: unable to generate unique course-ID';
10530: }
10531: }
10532: return $uname;
10533: }
10534:
10535: sub is_course {
10536: my ($cdom, $cnum) = scalar(@_) == 1 ?
10537: ($_[0] =~ /^($match_domain)_($match_courseid)$/) : @_;
10538:
10539: return unless (($cdom =~ /^$match_domain$/) && ($cnum =~ /^$match_courseid$/));
10540: my $uhome=&homeserver($cnum,$cdom);
10541: my $iscourse;
10542: if (grep { $_ eq $uhome } current_machine_ids()) {
10543: $iscourse = &LONCAPA::Lond::is_course($cdom,$cnum);
10544: } else {
10545: my $hashid = $cdom.':'.$cnum;
10546: ($iscourse,my $cached) = &is_cached_new('iscourse',$hashid);
10547: unless (defined($cached)) {
10548: my %courses = &courseiddump($cdom, '.', 1, '.', '.',
10549: $cnum,undef,undef,'.');
10550: $iscourse = 0;
10551: if (exists($courses{$cdom.'_'.$cnum})) {
10552: $iscourse = 1;
10553: }
10554: &do_cache_new('iscourse',$hashid,$iscourse,3600);
10555: }
10556: }
10557: return unless ($iscourse);
10558: return wantarray ? ($cdom, $cnum) : $cdom.'_'.$cnum;
10559: }
10560:
10561: sub store_userdata {
10562: my ($storehash,$datakey,$namespace,$udom,$uname) = @_;
10563: my $result;
10564: if ($datakey ne '') {
10565: if (ref($storehash) eq 'HASH') {
10566: if ($udom eq '' || $uname eq '') {
10567: $udom = $env{'user.domain'};
10568: $uname = $env{'user.name'};
10569: }
10570: my $uhome=&homeserver($uname,$udom);
10571: if (($uhome eq '') || ($uhome eq 'no_host')) {
10572: $result = 'error: no_host';
10573: } else {
10574: $storehash->{'ip'} = $ENV{'REMOTE_ADDR'};
10575: $storehash->{'host'} = $perlvar{'lonHostID'};
10576:
10577: my $namevalue='';
10578: foreach my $key (keys(%{$storehash})) {
10579: $namevalue.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
10580: }
10581: $namevalue=~s/\&$//;
10582: unless ($namespace eq 'courserequests') {
10583: $datakey = &escape($datakey);
10584: }
10585: $result = &reply("store:$udom:$uname:$namespace:$datakey:".
10586: $namevalue,$uhome);
10587: }
10588: } else {
10589: $result = 'error: data to store was not a hash reference';
10590: }
10591: } else {
10592: $result= 'error: invalid requestkey';
10593: }
10594: return $result;
10595: }
10596:
10597: # ---------------------------------------------------------- Assign Custom Role
10598:
10599: sub assigncustomrole {
10600: my ($udom,$uname,$url,$rdom,$rnam,$rolename,$end,$start,$deleteflag,$selfenroll,$context)=@_;
10601: return &assignrole($udom,$uname,$url,'cr/'.$rdom.'/'.$rnam.'/'.$rolename,
10602: $end,$start,$deleteflag,$selfenroll,$context);
10603: }
10604:
10605: # ----------------------------------------------------------------- Revoke Role
10606:
10607: sub revokerole {
10608: my ($udom,$uname,$url,$role,$deleteflag,$selfenroll,$context)=@_;
10609: my $now=time;
10610: return &assignrole($udom,$uname,$url,$role,$now,undef,$deleteflag,$selfenroll,$context);
10611: }
10612:
10613: # ---------------------------------------------------------- Revoke Custom Role
10614:
10615: sub revokecustomrole {
10616: my ($udom,$uname,$url,$rdom,$rnam,$rolename,$deleteflag,$selfenroll,$context)=@_;
10617: my $now=time;
10618: return &assigncustomrole($udom,$uname,$url,$rdom,$rnam,$rolename,$now,
10619: $deleteflag,$selfenroll,$context);
10620: }
10621:
10622: # ------------------------------------------------------------ Disk usage
10623: sub diskusage {
10624: my ($udom,$uname,$directorypath,$getpropath)=@_;
10625: $directorypath =~ s/\/$//;
10626: my $listing=&reply('du2:'.&escape($directorypath).':'
10627: .&escape($getpropath).':'.&escape($uname).':'
10628: .&escape($udom),homeserver($uname,$udom));
10629: if ($listing eq 'unknown_cmd') {
10630: if ($getpropath) {
10631: $directorypath = &propath($udom,$uname).'/'.$directorypath;
10632: }
10633: $listing = &reply('du:'.$directorypath,homeserver($uname,$udom));
10634: }
10635: return $listing;
10636: }
10637:
10638: sub is_locked {
10639: my ($file_name, $domain, $user, $which) = @_;
10640: my @check;
10641: my $is_locked;
10642: push (@check,$file_name);
10643: my %locked = &get('file_permissions',\@check,
10644: $env{'user.domain'},$env{'user.name'});
10645: my ($tmp)=keys(%locked);
10646: if ($tmp=~/^error:/) { undef(%locked); }
10647:
10648: if (ref($locked{$file_name}) eq 'ARRAY') {
10649: $is_locked = 'false';
10650: foreach my $entry (@{$locked{$file_name}}) {
10651: if (ref($entry) eq 'ARRAY') {
10652: $is_locked = 'true';
10653: if (ref($which) eq 'ARRAY') {
10654: push(@{$which},$entry);
10655: } else {
10656: last;
10657: }
10658: }
10659: }
10660: } else {
10661: $is_locked = 'false';
10662: }
10663: return $is_locked;
10664: }
10665:
10666: sub declutter_portfile {
10667: my ($file) = @_;
10668: $file =~ s{^(/portfolio/|portfolio/)}{/};
10669: return $file;
10670: }
10671:
10672: # ------------------------------------------------------------- Mark as Read Only
10673:
10674: sub mark_as_readonly {
10675: my ($domain,$user,$files,$what) = @_;
10676: my %current_permissions = &dump('file_permissions',$domain,$user);
10677: my ($tmp)=keys(%current_permissions);
10678: if ($tmp=~/^error:/) { undef(%current_permissions); }
10679: foreach my $file (@{$files}) {
10680: $file = &declutter_portfile($file);
10681: push(@{$current_permissions{$file}},$what);
10682: }
10683: &put('file_permissions',\%current_permissions,$domain,$user);
10684: return;
10685: }
10686:
10687: # ------------------------------------------------------------Save Selected Files
10688:
10689: sub save_selected_files {
10690: my ($user, $path, @files) = @_;
10691: my $filename = $user."savedfiles";
10692: my @other_files = &files_not_in_path($user, $path);
10693: open (OUT,'>',LONCAPA::tempdir().$filename);
10694: foreach my $file (@files) {
10695: print (OUT $env{'form.currentpath'}.$file."\n");
10696: }
10697: foreach my $file (@other_files) {
10698: print (OUT $file."\n");
10699: }
10700: close (OUT);
10701: return 'ok';
10702: }
10703:
10704: sub clear_selected_files {
10705: my ($user) = @_;
10706: my $filename = $user."savedfiles";
10707: open (OUT,'>',LONCAPA::tempdir().$filename);
10708: print (OUT undef);
10709: close (OUT);
10710: return ("ok");
10711: }
10712:
10713: sub files_in_path {
10714: my ($user, $path) = @_;
10715: my $filename = $user."savedfiles";
10716: my %return_files;
10717: open (IN,'<',LONCAPA::tempdir().$filename);
10718: while (my $line_in = <IN>) {
10719: chomp ($line_in);
10720: my @paths_and_file = split (m!/!, $line_in);
10721: my $file_part = pop (@paths_and_file);
10722: my $path_part = join ('/', @paths_and_file);
10723: $path_part.='/';
10724: my $path_and_file = $path_part.$file_part;
10725: if ($path_part eq $path) {
10726: $return_files{$file_part}= 'selected';
10727: }
10728: }
10729: close (IN);
10730: return (\%return_files);
10731: }
10732:
10733: # called in portfolio select mode, to show files selected NOT in current directory
10734: sub files_not_in_path {
10735: my ($user, $path) = @_;
10736: my $filename = $user."savedfiles";
10737: my @return_files;
10738: my $path_part;
10739: open(IN, '<',LONCAPA::tempdir().$filename);
10740: while (my $line = <IN>) {
10741: #ok, I know it's clunky, but I want it to work
10742: my @paths_and_file = split(m|/|, $line);
10743: my $file_part = pop(@paths_and_file);
10744: chomp($file_part);
10745: my $path_part = join('/', @paths_and_file);
10746: $path_part .= '/';
10747: my $path_and_file = $path_part.$file_part;
10748: if ($path_part ne $path) {
10749: push(@return_files, ($path_and_file));
10750: }
10751: }
10752: close(OUT);
10753: return (@return_files);
10754: }
10755:
10756: #------------------------------Submitted/Handedback Portfolio Files Versioning
10757:
10758: sub portfiles_versioning {
10759: my ($symb,$domain,$stu_name,$portfiles,$versioned_portfiles) = @_;
10760: my $portfolio_root = '/userfiles/portfolio';
10761: return unless ((ref($portfiles) eq 'ARRAY') && (ref($versioned_portfiles) eq 'ARRAY'));
10762: foreach my $file (@{$portfiles}) {
10763: &unmark_as_readonly($domain,$stu_name,[$symb,$env{'request.course.id'}],$file);
10764: my ($directory,$answer_file) =($file =~ /^(.*?)([^\/]*)$/);
10765: my ($answer_name,$answer_ver,$answer_ext) = &file_name_version_ext($answer_file);
10766: my $getpropath = 1;
10767: my ($dir_list,$listerror) = &dirlist($portfolio_root.$directory,$domain,
10768: $stu_name,$getpropath);
10769: my $version = &get_next_version($answer_name,$answer_ext,$dir_list);
10770: my $new_answer =
10771: &version_selected_portfile($domain,$stu_name,$directory,$answer_file,$version);
10772: if ($new_answer ne 'problem getting file') {
10773: push(@{$versioned_portfiles}, $directory.$new_answer);
10774: &mark_as_readonly($domain,$stu_name,[$directory.$new_answer],
10775: [$symb,$env{'request.course.id'},'graded']);
10776: }
10777: }
10778: }
10779:
10780: sub get_next_version {
10781: my ($answer_name, $answer_ext, $dir_list) = @_;
10782: my $version;
10783: if (ref($dir_list) eq 'ARRAY') {
10784: foreach my $row (@{$dir_list}) {
10785: my ($file) = split(/\&/,$row,2);
10786: my ($file_name,$file_version,$file_ext) =
10787: &file_name_version_ext($file);
10788: if (($file_name eq $answer_name) &&
10789: ($file_ext eq $answer_ext)) {
10790: # gets here if filename and extension match,
10791: # regardless of version
10792: if ($file_version ne '') {
10793: # a versioned file is found so save it for later
10794: if ($file_version > $version) {
10795: $version = $file_version;
10796: }
10797: }
10798: }
10799: }
10800: }
10801: $version ++;
10802: return($version);
10803: }
10804:
10805: sub version_selected_portfile {
10806: my ($domain,$stu_name,$directory,$file_name,$version) = @_;
10807: my ($answer_name,$answer_ver,$answer_ext) =
10808: &file_name_version_ext($file_name);
10809: my $new_answer;
10810: $env{'form.copy'} =
10811: &getfile("/uploaded/$domain/$stu_name/portfolio$directory$file_name");
10812: if($env{'form.copy'} eq '-1') {
10813: $new_answer = 'problem getting file';
10814: } else {
10815: $new_answer = $answer_name.'.'.$version.'.'.$answer_ext;
10816: my $copy_result =
10817: &finishuserfileupload($stu_name,$domain,'copy',
10818: '/portfolio'.$directory.$new_answer);
10819: }
10820: undef($env{'form.copy'});
10821: return ($new_answer);
10822: }
10823:
10824: sub file_name_version_ext {
10825: my ($file)=@_;
10826: my @file_parts = split(/\./, $file);
10827: my ($name,$version,$ext);
10828: if (@file_parts > 1) {
10829: $ext=pop(@file_parts);
10830: if (@file_parts > 1 && $file_parts[-1] =~ /^\d+$/) {
10831: $version=pop(@file_parts);
10832: }
10833: $name=join('.',@file_parts);
10834: } else {
10835: $name=join('.',@file_parts);
10836: }
10837: return($name,$version,$ext);
10838: }
10839:
10840: #----------------------------------------------Get portfolio file permissions
10841:
10842: sub get_portfile_permissions {
10843: my ($domain,$user) = @_;
10844: my %current_permissions = &dump('file_permissions',$domain,$user);
10845: my ($tmp)=keys(%current_permissions);
10846: if ($tmp=~/^error:/) { undef(%current_permissions); }
10847: return \%current_permissions;
10848: }
10849:
10850: #---------------------------------------------Get portfolio file access controls
10851:
10852: sub get_access_controls {
10853: my ($current_permissions,$group,$file) = @_;
10854: my %access;
10855: my $real_file = $file;
10856: $file =~ s/\.meta$//;
10857: if (defined($file)) {
10858: if (ref($$current_permissions{$file."\0".'accesscontrol'}) eq 'HASH') {
10859: foreach my $control (keys(%{$$current_permissions{$file."\0".'accesscontrol'}})) {
10860: $access{$real_file}{$control} = $$current_permissions{$file."\0".$control};
10861: }
10862: }
10863: } else {
10864: foreach my $key (keys(%{$current_permissions})) {
10865: if ($key =~ /\0accesscontrol$/) {
10866: if (defined($group)) {
10867: if ($key !~ m-^\Q$group\E/-) {
10868: next;
10869: }
10870: }
10871: my ($fullpath) = split(/\0/,$key);
10872: if (ref($$current_permissions{$key}) eq 'HASH') {
10873: foreach my $control (keys(%{$$current_permissions{$key}})) {
10874: $access{$fullpath}{$control}=$$current_permissions{$fullpath."\0".$control};
10875: }
10876: }
10877: }
10878: }
10879: }
10880: return %access;
10881: }
10882:
10883: sub modify_access_controls {
10884: my ($file_name,$changes,$domain,$user)=@_;
10885: my ($outcome,$deloutcome);
10886: my %store_permissions;
10887: my %new_values;
10888: my %new_control;
10889: my %translation;
10890: my @deletions = ();
10891: my $now = time;
10892: if (exists($$changes{'activate'})) {
10893: if (ref($$changes{'activate'}) eq 'HASH') {
10894: my @newitems = sort(keys(%{$$changes{'activate'}}));
10895: my $numnew = scalar(@newitems);
10896: for (my $i=0; $i<$numnew; $i++) {
10897: my $newkey = $newitems[$i];
10898: my $newid = &Apache::loncommon::get_cgi_id();
10899: if ($newkey =~ /^\d+:/) {
10900: $newkey =~ s/^(\d+)/$newid/;
10901: $translation{$1} = $newid;
10902: } elsif ($newkey =~ /^\d+_\d+_\d+:/) {
10903: $newkey =~ s/^(\d+_\d+_\d+)/$newid/;
10904: $translation{$1} = $newid;
10905: }
10906: $new_values{$file_name."\0".$newkey} =
10907: $$changes{'activate'}{$newitems[$i]};
10908: $new_control{$newkey} = $now;
10909: }
10910: }
10911: }
10912: my %todelete;
10913: my %changed_items;
10914: foreach my $action ('delete','update') {
10915: if (exists($$changes{$action})) {
10916: if (ref($$changes{$action}) eq 'HASH') {
10917: foreach my $key (keys(%{$$changes{$action}})) {
10918: my ($itemnum) = ($key =~ /^([^:]+):/);
10919: if ($action eq 'delete') {
10920: $todelete{$itemnum} = 1;
10921: } else {
10922: $changed_items{$itemnum} = $key;
10923: }
10924: }
10925: }
10926: }
10927: }
10928: # get lock on access controls for file.
10929: my $lockhash = {
10930: $file_name."\0".'locked_access_records' => $env{'user.name'}.
10931: ':'.$env{'user.domain'},
10932: };
10933: my $tries = 0;
10934: my $gotlock = &newput('file_permissions',$lockhash,$domain,$user);
10935:
10936: while (($gotlock ne 'ok') && $tries < 10) {
10937: $tries ++;
10938: sleep(0.1);
10939: $gotlock = &newput('file_permissions',$lockhash,$domain,$user);
10940: }
10941: if ($gotlock eq 'ok') {
10942: my %curr_permissions = &dump('file_permissions',$domain,$user,$file_name);
10943: my ($tmp)=keys(%curr_permissions);
10944: if ($tmp=~/^error:/) { undef(%curr_permissions); }
10945: if (exists($curr_permissions{$file_name."\0".'accesscontrol'})) {
10946: my $curr_controls = $curr_permissions{$file_name."\0".'accesscontrol'};
10947: if (ref($curr_controls) eq 'HASH') {
10948: foreach my $control_item (keys(%{$curr_controls})) {
10949: my ($itemnum) = ($control_item =~ /^([^:]+):/);
10950: if (defined($todelete{$itemnum})) {
10951: push(@deletions,$file_name."\0".$control_item);
10952: } else {
10953: if (defined($changed_items{$itemnum})) {
10954: $new_control{$changed_items{$itemnum}} = $now;
10955: push(@deletions,$file_name."\0".$control_item);
10956: $new_values{$file_name."\0".$changed_items{$itemnum}} = $$changes{'update'}{$changed_items{$itemnum}};
10957: } else {
10958: $new_control{$control_item} = $$curr_controls{$control_item};
10959: }
10960: }
10961: }
10962: }
10963: }
10964: my ($group);
10965: if (&is_course($domain,$user)) {
10966: ($group,my $file) = split(/\//,$file_name,2);
10967: }
10968: $deloutcome = &del('file_permissions',\@deletions,$domain,$user);
10969: $new_values{$file_name."\0".'accesscontrol'} = \%new_control;
10970: $outcome = &put('file_permissions',\%new_values,$domain,$user);
10971: # remove lock
10972: my @del_lock = ($file_name."\0".'locked_access_records');
10973: my $dellockoutcome = &del('file_permissions',\@del_lock,$domain,$user);
10974: my $sqlresult =
10975: &update_portfolio_table($user,$domain,$file_name,'portfolio_access',
10976: $group);
10977: } else {
10978: $outcome = "error: could not obtain lockfile\n";
10979: }
10980: return ($outcome,$deloutcome,\%new_values,\%translation);
10981: }
10982:
10983: sub make_public_indefinitely {
10984: my (@requrl) = @_;
10985: return &automated_portfile_access('public',\@requrl);
10986: }
10987:
10988: sub automated_portfile_access {
10989: my ($accesstype,$addsref,$delsref,$info) = @_;
10990: unless (($accesstype eq 'public') || ($accesstype eq 'ip')) {
10991: return 'invalid';
10992: }
10993: my %urls;
10994: if (ref($addsref) eq 'ARRAY') {
10995: foreach my $requrl (@{$addsref}) {
10996: if (&is_portfolio_url($requrl)) {
10997: unless (exists($urls{$requrl})) {
10998: $urls{$requrl} = 'add';
10999: }
11000: }
11001: }
11002: }
11003: if (ref($delsref) eq 'ARRAY') {
11004: foreach my $requrl (@{$delsref}) {
11005: if (&is_portfolio_url($requrl)) {
11006: unless (exists($urls{$requrl})) {
11007: $urls{$requrl} = 'delete';
11008: }
11009: }
11010: }
11011: }
11012: unless (keys(%urls)) {
11013: return 'invalid';
11014: }
11015: my $ip;
11016: if ($accesstype eq 'ip') {
11017: if (ref($info) eq 'HASH') {
11018: if ($info->{'ip'} ne '') {
11019: $ip = $info->{'ip'};
11020: }
11021: }
11022: if ($ip eq '') {
11023: return 'invalid';
11024: }
11025: }
11026: my $errors;
11027: my $now = time;
11028: my %current_perms;
11029: foreach my $requrl (sort(keys(%urls))) {
11030: my $action;
11031: if ($urls{$requrl} eq 'add') {
11032: $action = 'activate';
11033: } else {
11034: $action = 'none';
11035: }
11036: my $aclnum = 0;
11037: my (undef,$udom,$unum,$file_name,$group) =
11038: &parse_portfolio_url($requrl);
11039: unless (exists($current_perms{$unum.':'.$udom})) {
11040: $current_perms{$unum.':'.$udom} = &get_portfile_permissions($udom,$unum);
11041: }
11042: my %access_controls = &get_access_controls($current_perms{$unum.':'.$udom},
11043: $group,$file_name);
11044: foreach my $key (keys(%{$access_controls{$file_name}})) {
11045: my ($num,$scope,$end,$start) =
11046: ($key =~ /^([^:]+):([a-z]+)_(\d*)_?(\d*)$/);
11047: if ($scope eq $accesstype) {
11048: if (($start <= $now) && ($end == 0)) {
11049: if ($accesstype eq 'ip') {
11050: if (ref($access_controls{$file_name}{$key}) eq 'HASH') {
11051: if (ref($access_controls{$file_name}{$key}{'ip'}) eq 'ARRAY') {
11052: if (grep(/^\Q$ip\E$/,@{$access_controls{$file_name}{$key}{'ip'}})) {
11053: if ($urls{$requrl} eq 'add') {
11054: $action = 'none';
11055: last;
11056: } else {
11057: $action = 'delete';
11058: $aclnum = $num;
11059: last;
11060: }
11061: }
11062: }
11063: }
11064: } elsif ($accesstype eq 'public') {
11065: if ($urls{$requrl} eq 'add') {
11066: $action = 'none';
11067: last;
11068: } else {
11069: $action = 'delete';
11070: $aclnum = $num;
11071: last;
11072: }
11073: }
11074: } elsif ($accesstype eq 'public') {
11075: $action = 'update';
11076: $aclnum = $num;
11077: last;
11078: }
11079: }
11080: }
11081: if ($action eq 'none') {
11082: next;
11083: } else {
11084: my %changes;
11085: my $newend = 0;
11086: my $newstart = $now;
11087: my $newkey = $aclnum.':'.$accesstype.'_'.$newend.'_'.$newstart;
11088: $changes{$action}{$newkey} = {
11089: type => $accesstype,
11090: time => {
11091: start => $newstart,
11092: end => $newend,
11093: },
11094: };
11095: if ($accesstype eq 'ip') {
11096: $changes{$action}{$newkey}{'ip'} = [$ip];
11097: }
11098: my ($outcome,$deloutcome,$new_values,$translation) =
11099: &modify_access_controls($file_name,\%changes,$udom,$unum);
11100: unless ($outcome eq 'ok') {
11101: $errors .= $outcome.' ';
11102: }
11103: }
11104: }
11105: if ($errors) {
11106: $errors =~ s/\s$//;
11107: return $errors;
11108: } else {
11109: return 'ok';
11110: }
11111: }
11112:
11113: #------------------------------------------------------Get Marked as Read Only
11114:
11115: sub get_marked_as_readonly {
11116: my ($domain,$user,$what,$group) = @_;
11117: my $current_permissions = &get_portfile_permissions($domain,$user);
11118: my @readonly_files;
11119: my $cmp1=$what;
11120: if (ref($what)) { $cmp1=join('',@{$what}) };
11121: while (my ($file_name,$value) = each(%{$current_permissions})) {
11122: if (defined($group)) {
11123: if ($file_name !~ m-^\Q$group\E/-) {
11124: next;
11125: }
11126: }
11127: if (ref($value) eq "ARRAY"){
11128: foreach my $stored_what (@{$value}) {
11129: my $cmp2=$stored_what;
11130: if (ref($stored_what) eq 'ARRAY') {
11131: $cmp2=join('',@{$stored_what});
11132: }
11133: if ($cmp1 eq $cmp2) {
11134: push(@readonly_files, $file_name);
11135: last;
11136: } elsif (!defined($what)) {
11137: push(@readonly_files, $file_name);
11138: last;
11139: }
11140: }
11141: }
11142: }
11143: return @readonly_files;
11144: }
11145: #-----------------------------------------------------------Get Marked as Read Only Hash
11146:
11147: sub get_marked_as_readonly_hash {
11148: my ($current_permissions,$group,$what) = @_;
11149: my %readonly_files;
11150: while (my ($file_name,$value) = each(%{$current_permissions})) {
11151: if (defined($group)) {
11152: if ($file_name !~ m-^\Q$group\E/-) {
11153: next;
11154: }
11155: }
11156: if (ref($value) eq "ARRAY"){
11157: foreach my $stored_what (@{$value}) {
11158: if (ref($stored_what) eq 'ARRAY') {
11159: foreach my $lock_descriptor(@{$stored_what}) {
11160: if ($lock_descriptor eq 'graded') {
11161: $readonly_files{$file_name} = 'graded';
11162: } elsif ($lock_descriptor eq 'handback') {
11163: $readonly_files{$file_name} = 'handback';
11164: } else {
11165: if (!exists($readonly_files{$file_name})) {
11166: $readonly_files{$file_name} = 'locked';
11167: }
11168: }
11169: }
11170: }
11171: }
11172: }
11173: }
11174: return %readonly_files;
11175: }
11176: # ------------------------------------------------------------ Unmark as Read Only
11177:
11178: sub unmark_as_readonly {
11179: # unmarks $file_name (if $file_name is defined), or all files locked by $what
11180: # for portfolio submissions, $what contains [$symb,$crsid]
11181: my ($domain,$user,$what,$file_name,$group) = @_;
11182: $file_name = &declutter_portfile($file_name);
11183: my $symb_crs = $what;
11184: if (ref($what)) { $symb_crs=join('',@$what); }
11185: my %current_permissions = &dump('file_permissions',$domain,$user,$group);
11186: my ($tmp)=keys(%current_permissions);
11187: if ($tmp=~/^error:/) { undef(%current_permissions); }
11188: my @readonly_files = &get_marked_as_readonly($domain,$user,$what,$group);
11189: foreach my $file (@readonly_files) {
11190: my $clean_file = &declutter_portfile($file);
11191: if (defined($file_name) && ($file_name ne $clean_file)) { next; }
11192: my $current_locks = $current_permissions{$file};
11193: my @new_locks;
11194: my @del_keys;
11195: if (ref($current_locks) eq "ARRAY"){
11196: foreach my $locker (@{$current_locks}) {
11197: my $compare=$locker;
11198: if (ref($locker) eq 'ARRAY') {
11199: $compare=join('',@{$locker});
11200: if ($compare ne $symb_crs) {
11201: push(@new_locks, $locker);
11202: }
11203: }
11204: }
11205: if (scalar(@new_locks) > 0) {
11206: $current_permissions{$file} = \@new_locks;
11207: } else {
11208: push(@del_keys, $file);
11209: &del('file_permissions',\@del_keys, $domain, $user);
11210: delete($current_permissions{$file});
11211: }
11212: }
11213: }
11214: &put('file_permissions',\%current_permissions,$domain,$user);
11215: return;
11216: }
11217:
11218: # ------------------------------------------------------------ Directory lister
11219:
11220: sub dirlist {
11221: my ($uri,$userdomain,$username,$getpropath,$getuserdir,$alternateRoot)=@_;
11222: $uri=~s/^\///;
11223: $uri=~s/\/$//;
11224: my ($udom, $uname);
11225: if ($getuserdir) {
11226: $udom = $userdomain;
11227: $uname = $username;
11228: } else {
11229: (undef,$udom,$uname)=split(/\//,$uri);
11230: if(defined($userdomain)) {
11231: $udom = $userdomain;
11232: }
11233: if(defined($username)) {
11234: $uname = $username;
11235: }
11236: }
11237: my ($dirRoot,$listing,@listing_results);
11238:
11239: $dirRoot = $perlvar{'lonDocRoot'};
11240: if (defined($getpropath)) {
11241: $dirRoot = &propath($udom,$uname);
11242: $dirRoot =~ s/\/$//;
11243: } elsif (defined($getuserdir)) {
11244: my $subdir=$uname.'__';
11245: $subdir =~ s/(.)(.)(.).*/$1\/$2\/$3/;
11246: $dirRoot = $Apache::lonnet::perlvar{'lonUsersDir'}
11247: ."/$udom/$subdir/$uname";
11248: } elsif (defined($alternateRoot)) {
11249: $dirRoot = $alternateRoot;
11250: }
11251:
11252: if($udom) {
11253: if($uname) {
11254: my $uhome = &homeserver($uname,$udom);
11255: if ($uhome eq 'no_host') {
11256: return ([],'no_host');
11257: }
11258: $listing = &reply('ls3:'.&escape('/'.$uri).':'.$getpropath.':'
11259: .$getuserdir.':'.&escape($dirRoot)
11260: .':'.&escape($uname).':'.&escape($udom),$uhome);
11261: if ($listing eq 'unknown_cmd') {
11262: $listing = &reply('ls2:'.$dirRoot.'/'.$uri,$uhome);
11263: } else {
11264: @listing_results = map { &unescape($_); } split(/:/,$listing);
11265: }
11266: if ($listing eq 'unknown_cmd') {
11267: $listing = &reply('ls:'.$dirRoot.'/'.$uri,$uhome);
11268: @listing_results = split(/:/,$listing);
11269: } else {
11270: @listing_results = map { &unescape($_); } split(/:/,$listing);
11271: }
11272: if (($listing eq 'no_such_host') || ($listing eq 'con_lost') ||
11273: ($listing eq 'rejected') || ($listing eq 'refused') ||
11274: ($listing eq 'no_such_dir') || ($listing eq 'empty')) {
11275: return ([],$listing);
11276: } else {
11277: return (\@listing_results);
11278: }
11279: } elsif(!$alternateRoot) {
11280: my (%allusers,%listerror);
11281: my %servers = &get_servers($udom,'library');
11282: foreach my $tryserver (keys(%servers)) {
11283: $listing = &reply('ls3:'.&escape("/res/$udom").':::::'.
11284: &escape($udom),$tryserver);
11285: if ($listing eq 'unknown_cmd') {
11286: $listing = &reply('ls2:'.$perlvar{'lonDocRoot'}.'/res/'.
11287: $udom, $tryserver);
11288: } else {
11289: @listing_results = map { &unescape($_); } split(/:/,$listing);
11290: }
11291: if ($listing eq 'unknown_cmd') {
11292: $listing = &reply('ls:'.$perlvar{'lonDocRoot'}.'/res/'.
11293: $udom, $tryserver);
11294: @listing_results = split(/:/,$listing);
11295: } else {
11296: @listing_results =
11297: map { &unescape($_); } split(/:/,$listing);
11298: }
11299: if (($listing eq 'no_such_host') || ($listing eq 'con_lost') ||
11300: ($listing eq 'rejected') || ($listing eq 'refused') ||
11301: ($listing eq 'no_such_dir') || ($listing eq 'empty')) {
11302: $listerror{$tryserver} = $listing;
11303: } else {
11304: foreach my $line (@listing_results) {
11305: my ($entry) = split(/&/,$line,2);
11306: $allusers{$entry} = 1;
11307: }
11308: }
11309: }
11310: my @alluserslist=();
11311: foreach my $user (sort(keys(%allusers))) {
11312: push(@alluserslist,$user.'&user');
11313: }
11314:
11315: if (!%listerror) {
11316: # no errors
11317: return (\@alluserslist);
11318: } elsif (scalar(keys(%servers)) == 1) {
11319: # one library server, one error
11320: my ($key) = keys(%listerror);
11321: return (\@alluserslist, $listerror{$key});
11322: } elsif ( grep { $_ eq 'con_lost' } values(%listerror) ) {
11323: # con_lost indicates that we might miss data from at least one
11324: # library server
11325: return (\@alluserslist, 'con_lost');
11326: } else {
11327: # multiple library servers and no con_lost -> data should be
11328: # complete.
11329: return (\@alluserslist);
11330: }
11331:
11332: } else {
11333: return ([],'missing username');
11334: }
11335: } elsif(!defined($getpropath)) {
11336: my $path = $perlvar{'lonDocRoot'}.'/res/';
11337: my @all_domains = map { $path.$_.'/&domain'; } (sort(&all_domains()));
11338: return (\@all_domains);
11339: } else {
11340: return ([],'missing domain');
11341: }
11342: }
11343:
11344: # --------------------------------------------- GetFileTimestamp
11345: # This function utilizes dirlist and returns the date stamp for
11346: # when it was last modified. It will also return an error of -1
11347: # if an error occurs
11348:
11349: sub GetFileTimestamp {
11350: my ($studentDomain,$studentName,$filename,$getuserdir)=@_;
11351: $studentDomain = &LONCAPA::clean_domain($studentDomain);
11352: $studentName = &LONCAPA::clean_username($studentName);
11353: my ($fileref,$error) = &dirlist($filename,$studentDomain,$studentName,
11354: undef,$getuserdir);
11355: if (($error eq 'empty') || ($error eq 'no_such_dir')) {
11356: return -1;
11357: }
11358: if (ref($fileref) eq 'ARRAY') {
11359: my @stats = split('&',$fileref->[0]);
11360: # @stats contains first the filename, then the stat output
11361: return $stats[10]; # so this is 10 instead of 9.
11362: } else {
11363: return -1;
11364: }
11365: }
11366:
11367: sub stat_file {
11368: my ($uri) = @_;
11369: $uri = &clutter_with_no_wrapper($uri);
11370:
11371: my ($udom,$uname,$file);
11372: if ($uri =~ m-^/(uploaded|editupload)/-) {
11373: ($udom,$uname,$file) =
11374: ($uri =~ m-/(?:uploaded|editupload)/?($match_domain)/?($match_name)/?(.*)-);
11375: $file = 'userfiles/'.$file;
11376: }
11377: if ($uri =~ m-^/res/-) {
11378: ($udom,$uname) =
11379: ($uri =~ m-/(?:res)/?($match_domain)/?($match_username)/-);
11380: $file = $uri;
11381: }
11382:
11383: if (!$udom || !$uname || !$file) {
11384: # unable to handle the uri
11385: return ();
11386: }
11387: my $getpropath;
11388: if ($file =~ /^userfiles\//) {
11389: $getpropath = 1;
11390: }
11391: my ($listref,$error) = &dirlist($file,$udom,$uname,$getpropath);
11392: if (($error eq 'empty') || ($error eq 'no_such_dir')) {
11393: return ();
11394: } else {
11395: if (ref($listref) eq 'ARRAY') {
11396: my @stats = split('&',$listref->[0]);
11397: shift(@stats); #filename is first
11398: return @stats;
11399: }
11400: }
11401: return ();
11402: }
11403:
11404: # --------------------------------------------------------- recursedirs
11405: # Recursive function to traverse either a specific user's Authoring Space
11406: # or corresponding Published Resource Space, and populate the hash ref:
11407: # $dirhashref with URLs of all directories, and if $filehashref hash
11408: # ref arg is provided, the URLs of any files, excluding versioned, .meta,
11409: # or .rights files in resource space, and .meta, .save, .log, and .bak
11410: # files in Authoring Space.
11411: #
11412: # Inputs:
11413: #
11414: # $is_home - true if current server is home server for user's space
11415: # $context - either: priv, or res respectively for Authoring or Resource Space.
11416: # $docroot - Document root (i.e., /home/httpd/html
11417: # $toppath - Top level directory (i.e., /res/$dom/$uname or /priv/$dom/$uname
11418: # $relpath - Current path (relative to top level).
11419: # $dirhashref - reference to hash to populate with URLs of directories (Required)
11420: # $filehashref - reference to hash to populate with URLs of files (Optional)
11421: #
11422: # Returns: nothing
11423: #
11424: # Side Effects: populates $dirhashref, and $filehashref (if provided).
11425: #
11426: # Currently used by interface/londocs.pm to create linked select boxes for
11427: # directory and filename to import a Course "Author" resource into a course, and
11428: # also to create linked select boxes for Authoring Space and Directory to choose
11429: # save location for creation of a new "standard" problem from the Course Editor.
11430: #
11431:
11432: sub recursedirs {
11433: my ($is_home,$context,$docroot,$toppath,$relpath,$dirhashref,$filehashref) = @_;
11434: return unless (ref($dirhashref) eq 'HASH');
11435: my $currpath = $docroot.$toppath;
11436: if ($relpath) {
11437: $currpath .= "/$relpath";
11438: }
11439: my $savefile;
11440: if (ref($filehashref)) {
11441: $savefile = 1;
11442: }
11443: if ($is_home) {
11444: if (opendir(my $dirh,$currpath)) {
11445: foreach my $item (sort { lc($a) cmp lc($b) } grep(!/^\.+$/,readdir($dirh))) {
11446: next if ($item eq '');
11447: if (-d "$currpath/$item") {
11448: my $newpath;
11449: if ($relpath) {
11450: $newpath = "$relpath/$item";
11451: } else {
11452: $newpath = $item;
11453: }
11454: $dirhashref->{&Apache::lonlocal::js_escape($newpath)} = 1;
11455: &recursedirs($is_home,$context,$docroot,$toppath,$newpath,$dirhashref,$filehashref);
11456: } elsif ($savefile) {
11457: if ($context eq 'priv') {
11458: unless ($item =~ /\.(meta|save|log|bak|DS_Store)$/) {
11459: $filehashref->{&Apache::lonlocal::js_escape($relpath)}{$item} = 1;
11460: }
11461: } else {
11462: unless (($item =~ /\.meta$/) || ($item =~ /\.\d+\.\w+$/) || ($item =~ /\.rights$/)) {
11463: $filehashref->{&Apache::lonlocal::js_escape($relpath)}{$item} = 1;
11464: }
11465: }
11466: }
11467: }
11468: closedir($dirh);
11469: }
11470: } else {
11471: my ($dirlistref,$listerror) =
11472: &dirlist($toppath.$relpath);
11473: my @dir_lines;
11474: my $dirptr=16384;
11475: if (ref($dirlistref) eq 'ARRAY') {
11476: foreach my $dir_line (sort
11477: {
11478: my ($afile)=split('&',$a,2);
11479: my ($bfile)=split('&',$b,2);
11480: return (lc($afile) cmp lc($bfile));
11481: } (@{$dirlistref})) {
11482: my ($item,$dom,undef,$testdir,undef,undef,undef,undef,$size,undef,$mtime,undef,undef,undef,$obs,undef) =
11483: split(/\&/,$dir_line,16);
11484: $item =~ s/\s+$//;
11485: next if (($item =~ /^\.\.?$/) || ($obs));
11486: if ($dirptr&$testdir) {
11487: my $newpath;
11488: if ($relpath) {
11489: $newpath = "$relpath/$item";
11490: } else {
11491: $relpath = '/';
11492: $newpath = $item;
11493: }
11494: $dirhashref->{&Apache::lonlocal::js_escape($newpath)} = 1;
11495: &recursedirs($is_home,$context,$docroot,$toppath,$newpath,$dirhashref,$filehashref);
11496: } elsif ($savefile) {
11497: if ($context eq 'priv') {
11498: unless ($item =~ /\.(meta|save|log|bak|DS_Store)$/) {
11499: $filehashref->{$relpath}{$item} = 1;
11500: }
11501: } else {
11502: unless (($item =~ /\.meta$/) || ($item =~ /\.\d+\.\w+$/)) {
11503: $filehashref->{$relpath}{$item} = 1;
11504: }
11505: }
11506: }
11507: }
11508: }
11509: }
11510: return;
11511: }
11512:
11513: # -------------------------------------------------------- Value of a Condition
11514:
11515: # gets the value of a specific preevaluated condition
11516: # stored in the string $env{user.state.<cid>}
11517: # or looks up a condition reference in the bighash and if if hasn't
11518: # already been evaluated recurses into docondval to get the value of
11519: # the condition, then memoizing it to
11520: # $env{user.state.<cid>.<condition>}
11521: sub directcondval {
11522: my $number=shift;
11523: if (!defined($env{'user.state.'.$env{'request.course.id'}})) {
11524: &Apache::lonuserstate::evalstate();
11525: }
11526: if (exists($env{'user.state.'.$env{'request.course.id'}.".$number"})) {
11527: return $env{'user.state.'.$env{'request.course.id'}.".$number"};
11528: } elsif ($number =~ /^_/) {
11529: my $sub_condition;
11530: if (tie(my %bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
11531: &GDBM_READER(),0640)) {
11532: $sub_condition=$bighash{'conditions'.$number};
11533: untie(%bighash);
11534: }
11535: my $value = &docondval($sub_condition);
11536: &appenv({'user.state.'.$env{'request.course.id'}.".$number" => $value});
11537: return $value;
11538: }
11539: if ($env{'user.state.'.$env{'request.course.id'}}) {
11540: return substr($env{'user.state.'.$env{'request.course.id'}},$number,1);
11541: } else {
11542: return 2;
11543: }
11544: }
11545:
11546: # get the collection of conditions for this resource
11547: sub condval {
11548: my $condidx=shift;
11549: my $allpathcond='';
11550: foreach my $cond (split(/\|/,$condidx)) {
11551: if (defined($env{'acc.cond.'.$env{'request.course.id'}.'.'.$cond})) {
11552: $allpathcond.=
11553: '('.$env{'acc.cond.'.$env{'request.course.id'}.'.'.$cond}.')|';
11554: }
11555: }
11556: $allpathcond=~s/\|$//;
11557: return &docondval($allpathcond);
11558: }
11559:
11560: #evaluates an expression of conditions
11561: sub docondval {
11562: my ($allpathcond) = @_;
11563: my $result=0;
11564: if ($env{'request.course.id'}
11565: && defined($allpathcond)) {
11566: my $operand='|';
11567: my @stack;
11568: foreach my $chunk ($allpathcond=~/(\d+|_\d+\.\d+|\(|\)|\&|\|)/g) {
11569: if ($chunk eq '(') {
11570: push @stack,($operand,$result);
11571: } elsif ($chunk eq ')') {
11572: my $before=pop @stack;
11573: if (pop @stack eq '&') {
11574: $result=$result>$before?$before:$result;
11575: } else {
11576: $result=$result>$before?$result:$before;
11577: }
11578: } elsif (($chunk eq '&') || ($chunk eq '|')) {
11579: $operand=$chunk;
11580: } else {
11581: my $new=directcondval($chunk);
11582: if ($operand eq '&') {
11583: $result=$result>$new?$new:$result;
11584: } else {
11585: $result=$result>$new?$result:$new;
11586: }
11587: }
11588: }
11589: }
11590: return $result;
11591: }
11592:
11593: # ---------------------------------------------------- Devalidate courseresdata
11594:
11595: sub devalidatecourseresdata {
11596: my ($coursenum,$coursedomain)=@_;
11597: my $hashid=$coursenum.':'.$coursedomain;
11598: &devalidate_cache_new('courseres',$hashid);
11599: }
11600:
11601:
11602: # --------------------------------------------------- Course Resourcedata Query
11603: #
11604: # Parameters:
11605: # $coursenum - Number of the course.
11606: # $coursedomain - Domain at which the course was created.
11607: # Returns:
11608: # A hash of the course parameters along (I think) with timestamps
11609: # and version info.
11610:
11611: sub get_courseresdata {
11612: my ($coursenum,$coursedomain)=@_;
11613: my $coursehom=&homeserver($coursenum,$coursedomain);
11614: my $hashid=$coursenum.':'.$coursedomain;
11615: my ($result,$cached)=&is_cached_new('courseres',$hashid);
11616: my %dumpreply;
11617: unless (defined($cached)) {
11618: %dumpreply=&dump('resourcedata',$coursedomain,$coursenum);
11619: $result=\%dumpreply;
11620: my ($tmp) = keys(%dumpreply);
11621: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
11622: &do_cache_new('courseres',$hashid,$result,600);
11623: } elsif ($tmp =~ /^(con_lost|no_such_host)/) {
11624: return $tmp;
11625: } elsif ($tmp =~ /^(error)/) {
11626: $result=undef;
11627: &do_cache_new('courseres',$hashid,$result,600);
11628: }
11629: }
11630: return $result;
11631: }
11632:
11633: sub devalidateuserresdata {
11634: my ($uname,$udom)=@_;
11635: my $hashid="$udom:$uname";
11636: &devalidate_cache_new('userres',$hashid);
11637: }
11638:
11639: sub get_userresdata {
11640: my ($uname,$udom)=@_;
11641: #most student don\'t have any data set, check if there is some data
11642: if (&EXT_cache_status($udom,$uname)) { return undef; }
11643:
11644: my $hashid="$udom:$uname";
11645: my ($result,$cached)=&is_cached_new('userres',$hashid);
11646: if (!defined($cached)) {
11647: my %resourcedata=&dump('resourcedata',$udom,$uname);
11648: $result=\%resourcedata;
11649: &do_cache_new('userres',$hashid,$result,600);
11650: }
11651: my ($tmp)=keys(%$result);
11652: if (($tmp!~/^error\:/) && ($tmp!~/^con_lost/)) {
11653: return $result;
11654: }
11655: #error 2 occurs when the .db doesn't exist
11656: if ($tmp!~/error: 2 /) {
11657: if ((!defined($cached)) || ($tmp ne 'con_lost')) {
11658: &logthis("<font color=\"blue\">WARNING:".
11659: " Trying to get resource data for ".
11660: $uname." at ".$udom.": ".
11661: $tmp."</font>");
11662: }
11663: } elsif ($tmp=~/error: 2 /) {
11664: #&EXT_cache_set($udom,$uname);
11665: &do_cache_new('userres',$hashid,undef,600);
11666: undef($tmp); # not really an error so don't send it back
11667: }
11668: return $tmp;
11669: }
11670: #----------------------------------------------- resdata - return resource data
11671: # Purpose:
11672: # Return resource data for either users or for a course.
11673: # Parameters:
11674: # $name - Course/user name.
11675: # $domain - Name of the domain the user/course is registered on.
11676: # $type - Type of thing $name is (must be 'course' or 'user')
11677: # $mapp - decluttered URL of enclosing map
11678: # $recursed - Ref to scalar -- set to 1, if nested maps have been recursed.
11679: # $recurseup - Ref to array of map URLs, starting with map containing
11680: # $mapp up through hierarchy of nested maps to top level map.
11681: # $courseid - CourseID (first part of param identifier).
11682: # $modifier - Middle part of param identifier.
11683: # $what - Last part of param identifier.
11684: # @which - Array of names of resources desired.
11685: # Returns:
11686: # The value of the first reasource in @which that is found in the
11687: # resource hash.
11688: # Exceptional Conditions:
11689: # If the $type passed in is not valid (not the string 'course' or
11690: # 'user', an undefined reference is returned.
11691: # If none of the resources are found, an undef is returned
11692: sub resdata {
11693: my ($name,$domain,$type,$mapp,$recursed,$recurseup,$courseid,
11694: $modifier,$what,@which)=@_;
11695: my $result;
11696: if ($type eq 'course') {
11697: $result=&get_courseresdata($name,$domain);
11698: } elsif ($type eq 'user') {
11699: $result=&get_userresdata($name,$domain);
11700: }
11701: if (!ref($result)) { return $result; }
11702: foreach my $item (@which) {
11703: if ($item->[1] eq 'course') {
11704: if ((ref($recurseup) eq 'ARRAY') && (ref($recursed) eq 'SCALAR')) {
11705: unless ($$recursed) {
11706: @{$recurseup} = &get_map_hierarchy($mapp,$courseid);
11707: $$recursed = 1;
11708: }
11709: foreach my $item (@${recurseup}) {
11710: my $norecursechk=$courseid.$modifier.$item.'___(all).'.$what;
11711: last if (defined($result->{$norecursechk}));
11712: my $recursechk=$courseid.$modifier.$item.'___(rec).'.$what;
11713: if (defined($result->{$recursechk})) { return [$result->{$recursechk},'map']; }
11714: }
11715: }
11716: }
11717: if (defined($result->{$item->[0]})) {
11718: return [$result->{$item->[0]},$item->[1]];
11719: }
11720: }
11721: return undef;
11722: }
11723:
11724: sub get_domain_lti {
11725: my ($cdom,$context) = @_;
11726: my ($name,%lti);
11727: if ($context eq 'consumer') {
11728: $name = 'ltitools';
11729: } elsif ($context eq 'provider') {
11730: $name = 'lti';
11731: } else {
11732: return %lti;
11733: }
11734: my ($result,$cached)=&is_cached_new($name,$cdom);
11735: if (defined($cached)) {
11736: if (ref($result) eq 'HASH') {
11737: %lti = %{$result};
11738: }
11739: } else {
11740: my %domconfig = &get_dom('configuration',[$name],$cdom);
11741: if (ref($domconfig{$name}) eq 'HASH') {
11742: %lti = %{$domconfig{$name}};
11743: my %encdomconfig = &get_dom('encconfig',[$name],$cdom);
11744: if (ref($encdomconfig{$name}) eq 'HASH') {
11745: foreach my $id (keys(%lti)) {
11746: if (ref($encdomconfig{$name}{$id}) eq 'HASH') {
11747: foreach my $item ('key','secret') {
11748: $lti{$id}{$item} = $encdomconfig{$name}{$id}{$item};
11749: }
11750: }
11751: }
11752: }
11753: }
11754: my $cachetime = 24*60*60;
11755: &do_cache_new($name,$cdom,\%lti,$cachetime);
11756: }
11757: return %lti;
11758: }
11759:
11760: sub get_numsuppfiles {
11761: my ($cnum,$cdom,$ignorecache)=@_;
11762: my $hashid=$cnum.':'.$cdom;
11763: my ($suppcount,$cached);
11764: unless ($ignorecache) {
11765: ($suppcount,$cached) = &is_cached_new('suppcount',$hashid);
11766: }
11767: unless (defined($cached)) {
11768: my $chome=&homeserver($cnum,$cdom);
11769: unless ($chome eq 'no_host') {
11770: ($suppcount,my $supptools,my $errors) = (0,0,0);
11771: my $suppmap = 'supplemental.sequence';
11772: ($suppcount,$supptools,$errors) =
11773: &Apache::loncommon::recurse_supplemental($cnum,$cdom,$suppmap,$suppcount,
11774: $supptools,$errors);
11775: }
11776: &do_cache_new('suppcount',$hashid,$suppcount,600);
11777: }
11778: return $suppcount;
11779: }
11780:
11781: #
11782: # EXT resource caching routines
11783: #
11784:
11785: {
11786: # Cache (5 seconds) of map hierarchy for speedup of navmaps display
11787: #
11788: # The course for which we cache
11789: my $cachedmapkey='';
11790: # The cached recursive maps for this course
11791: my %cachedmaps=();
11792: # When this was last done
11793: my $cachedmaptime='';
11794:
11795: sub clear_EXT_cache_status {
11796: &delenv('cache.EXT.');
11797: }
11798:
11799: sub EXT_cache_status {
11800: my ($target_domain,$target_user) = @_;
11801: my $cachename = 'cache.EXT.'.$target_user.'.'.$target_domain;
11802: if (exists($env{$cachename}) && ($env{$cachename}+600) > time) {
11803: # We know already the user has no data
11804: return 1;
11805: } else {
11806: return 0;
11807: }
11808: }
11809:
11810: sub EXT_cache_set {
11811: my ($target_domain,$target_user) = @_;
11812: my $cachename = 'cache.EXT.'.$target_user.'.'.$target_domain;
11813: #&appenv({$cachename => time});
11814: }
11815:
11816: # --------------------------------------------------------- Value of a Variable
11817: sub EXT {
11818:
11819: my ($varname,$symbparm,$udom,$uname,$usection,$recurse,$cid)=@_;
11820: unless ($varname) { return ''; }
11821: #get real user name/domain, courseid and symb
11822: my $courseid;
11823: my $publicuser;
11824: if ($symbparm) {
11825: $symbparm=&get_symb_from_alias($symbparm);
11826: }
11827: if (!($uname && $udom)) {
11828: (my $cursymb,$courseid,$udom,$uname,$publicuser)= &whichuser($symbparm);
11829: if (!$symbparm) { $symbparm=$cursymb; }
11830: } else {
11831: $courseid=$env{'request.course.id'};
11832: }
11833: my ($realm,$space,$qualifier,@therest)=split(/\./,$varname);
11834: my $rest;
11835: if (defined($therest[0])) {
11836: $rest=join('.',@therest);
11837: } else {
11838: $rest='';
11839: }
11840:
11841: my $qualifierrest=$qualifier;
11842: if ($rest) { $qualifierrest.='.'.$rest; }
11843: my $spacequalifierrest=$space;
11844: if ($qualifierrest) { $spacequalifierrest.='.'.$qualifierrest; }
11845: if ($realm eq 'user') {
11846: # --------------------------------------------------------------- user.resource
11847: if ($space eq 'resource') {
11848: if ( (defined($Apache::lonhomework::parsing_a_problem)
11849: || defined($Apache::lonhomework::parsing_a_task))
11850: &&
11851: ($symbparm eq &symbread()) ) {
11852: # if we are in the middle of processing the resource the
11853: # get the value we are planning on committing
11854: if (defined($Apache::lonhomework::results{$qualifierrest})) {
11855: return $Apache::lonhomework::results{$qualifierrest};
11856: } else {
11857: return $Apache::lonhomework::history{$qualifierrest};
11858: }
11859: } else {
11860: my %restored;
11861: if ($publicuser || $env{'request.state'} eq 'construct') {
11862: %restored=&tmprestore($symbparm,$courseid,$udom,$uname);
11863: } else {
11864: %restored=&restore($symbparm,$courseid,$udom,$uname);
11865: }
11866: return $restored{$qualifierrest};
11867: }
11868: # ----------------------------------------------------------------- user.access
11869: } elsif ($space eq 'access') {
11870: # FIXME - not supporting calls for a specific user
11871: return &allowed($qualifier,$rest);
11872: # ------------------------------------------ user.preferences, user.environment
11873: } elsif (($space eq 'preferences') || ($space eq 'environment')) {
11874: if (($uname eq $env{'user.name'}) &&
11875: ($udom eq $env{'user.domain'})) {
11876: return $env{join('.',('environment',$qualifierrest))};
11877: } else {
11878: my %returnhash;
11879: if (!$publicuser) {
11880: %returnhash=&userenvironment($udom,$uname,
11881: $qualifierrest);
11882: }
11883: return $returnhash{$qualifierrest};
11884: }
11885: # ----------------------------------------------------------------- user.course
11886: } elsif ($space eq 'course') {
11887: # FIXME - not supporting calls for a specific user
11888: return $env{join('.',('request.course',$qualifier))};
11889: # ------------------------------------------------------------------- user.role
11890: } elsif ($space eq 'role') {
11891: # FIXME - not supporting calls for a specific user
11892: my ($role,$where)=split(/\./,$env{'request.role'});
11893: if ($qualifier eq 'value') {
11894: return $role;
11895: } elsif ($qualifier eq 'extent') {
11896: return $where;
11897: }
11898: # ----------------------------------------------------------------- user.domain
11899: } elsif ($space eq 'domain') {
11900: return $udom;
11901: # ------------------------------------------------------------------- user.name
11902: } elsif ($space eq 'name') {
11903: return $uname;
11904: # ---------------------------------------------------- Any other user namespace
11905: } else {
11906: my %reply;
11907: if (!$publicuser) {
11908: %reply=&get($space,[$qualifierrest],$udom,$uname);
11909: }
11910: return $reply{$qualifierrest};
11911: }
11912: } elsif ($realm eq 'query') {
11913: # ---------------------------------------------- pull stuff out of query string
11914: &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},
11915: [$spacequalifierrest]);
11916: return $env{'form.'.$spacequalifierrest};
11917: } elsif ($realm eq 'request') {
11918: # ------------------------------------------------------------- request.browser
11919: if ($space eq 'browser') {
11920: return $env{'browser.'.$qualifier};
11921: # ------------------------------------------------------------ request.filename
11922: } else {
11923: return $env{'request.'.$spacequalifierrest};
11924: }
11925: } elsif ($realm eq 'course') {
11926: # ---------------------------------------------------------- course.description
11927: return $env{'course.'.$courseid.'.'.$spacequalifierrest};
11928: } elsif ($realm eq 'resource') {
11929:
11930: if (defined($courseid) && $courseid eq $env{'request.course.id'}) {
11931: if (!$symbparm) { $symbparm=&symbread(); }
11932: }
11933:
11934: if ($qualifier eq '') {
11935: if ($space eq 'title') {
11936: if (!$symbparm) { $symbparm = $env{'request.filename'}; }
11937: return &gettitle($symbparm);
11938: }
11939:
11940: if ($space eq 'map') {
11941: my ($map) = &decode_symb($symbparm);
11942: return &symbread($map);
11943: }
11944: if ($space eq 'maptitle') {
11945: my ($map) = &decode_symb($symbparm);
11946: return &gettitle($map);
11947: }
11948: if ($space eq 'filename') {
11949: if ($symbparm) {
11950: return &clutter((&decode_symb($symbparm))[2]);
11951: }
11952: return &hreflocation('',$env{'request.filename'});
11953: }
11954:
11955: if ((defined($courseid)) && ($courseid eq $env{'request.course.id'}) && $symbparm) {
11956: if ($space eq 'visibleparts') {
11957: my $navmap = Apache::lonnavmaps::navmap->new();
11958: my $item;
11959: if (ref($navmap)) {
11960: my $res = $navmap->getBySymb($symbparm);
11961: my $parts = $res->parts();
11962: if (ref($parts) eq 'ARRAY') {
11963: $item = join(',',@{$parts});
11964: }
11965: undef($navmap);
11966: }
11967: return $item;
11968: }
11969: }
11970: }
11971:
11972: my ($section, $group, @groups, @recurseup, $recursed);
11973: my ($courselevelm,$courseleveli,$courselevel,$mapp);
11974: if (($courseid eq '') && ($cid)) {
11975: $courseid = $cid;
11976: }
11977: if (($symbparm && $courseid) &&
11978: (($courseid eq $env{'request.course.id'}) || ($courseid eq $cid))) {
11979:
11980: #print '<br>'.$space.' - '.$qualifier.' - '.$spacequalifierrest;
11981:
11982: # ----------------------------------------------------- Cascading lookup scheme
11983: my $symbp=$symbparm;
11984: $mapp=&deversion((&decode_symb($symbp))[0]);
11985: my $symbparm=$symbp.'.'.$spacequalifierrest;
11986: my $recurseparm=$mapp.'___(rec).'.$spacequalifierrest;
11987: my $mapparm=$mapp.'___(all).'.$spacequalifierrest;
11988: if (($env{'user.name'} eq $uname) &&
11989: ($env{'user.domain'} eq $udom)) {
11990: $section=$env{'request.course.sec'};
11991: @groups = split(/:/,$env{'request.course.groups'});
11992: @groups=&sort_course_groups($courseid,@groups);
11993: } else {
11994: if (! defined($usection)) {
11995: $section=&getsection($udom,$uname,$courseid);
11996: } else {
11997: $section = $usection;
11998: }
11999: @groups = &get_users_groups($udom,$uname,$courseid);
12000: }
12001:
12002: my $seclevel=$courseid.'.['.$section.'].'.$spacequalifierrest;
12003: my $seclevelr=$courseid.'.['.$section.'].'.$symbparm;
12004: my $secleveli=$courseid.'.['.$section.'].'.$recurseparm;
12005: my $seclevelm=$courseid.'.['.$section.'].'.$mapparm;
12006:
12007: $courselevel=$courseid.'.'.$spacequalifierrest;
12008: my $courselevelr=$courseid.'.'.$symbparm;
12009: $courseleveli=$courseid.'.'.$recurseparm;
12010: $courselevelm=$courseid.'.'.$mapparm;
12011:
12012: # ----------------------------------------------------------- first, check user
12013:
12014: my $userreply=&resdata($uname,$udom,'user',$mapp,\$recursed,
12015: \@recurseup,$courseid,'.',$spacequalifierrest,
12016: ([$courselevelr,'resource'],
12017: [$courselevelm,'map' ],
12018: [$courseleveli,'map' ],
12019: [$courselevel, 'course' ]));
12020: if (defined($userreply)) { return &get_reply($userreply); }
12021:
12022: # ------------------------------------------------ second, check some of course
12023: my $coursereply;
12024: if (@groups > 0) {
12025: $coursereply = &check_group_parms($courseid,\@groups,$symbparm,
12026: $recurseparm,$mapparm,$spacequalifierrest,
12027: $mapp,\$recursed,\@recurseup);
12028: if (defined($coursereply)) { return &get_reply($coursereply); }
12029: }
12030:
12031: $coursereply=&resdata($env{'course.'.$courseid.'.num'},
12032: $env{'course.'.$courseid.'.domain'},
12033: 'course',$mapp,\$recursed,\@recurseup,
12034: $courseid,'.['.$section.'].',$spacequalifierrest,
12035: ([$seclevelr, 'resource'],
12036: [$seclevelm, 'map' ],
12037: [$secleveli, 'map' ],
12038: [$seclevel, 'course' ],
12039: [$courselevelr,'resource']));
12040: if (defined($coursereply)) { return &get_reply($coursereply); }
12041:
12042: # ------------------------------------------------------ third, check map parms
12043: my %parmhash=();
12044: my $thisparm='';
12045: if (tie(%parmhash,'GDBM_File',
12046: $env{'request.course.fn'}.'_parms.db',
12047: &GDBM_READER(),0640)) {
12048: $thisparm=$parmhash{$symbparm};
12049: untie(%parmhash);
12050: }
12051: if ($thisparm) { return &get_reply([$thisparm,'resource']); }
12052: }
12053: # ------------------------------------------ fourth, look in resource metadata
12054:
12055: my $what = $spacequalifierrest;
12056: $what=~s/\./\_/;
12057: my $filename;
12058: if (!$symbparm) { $symbparm=&symbread(); }
12059: if ($symbparm) {
12060: $filename=(&decode_symb($symbparm))[2];
12061: } else {
12062: $filename=$env{'request.filename'};
12063: }
12064: my $toolsymb;
12065: if (($filename =~ /ext\.tool$/) && ($what ne '0_gradable')) {
12066: $toolsymb = $symbparm;
12067: }
12068: my $metadata=&metadata($filename,$what,$toolsymb);
12069: if (defined($metadata)) { return &get_reply([$metadata,'resource']); }
12070: $metadata=&metadata($filename,'parameter_'.$what,$toolsymb);
12071: if (defined($metadata)) { return &get_reply([$metadata,'resource']); }
12072:
12073: # ----------------------------------------------- fifth, look in rest of course
12074: if ($symbparm && defined($courseid) &&
12075: $courseid eq $env{'request.course.id'}) {
12076: my $coursereply=&resdata($env{'course.'.$courseid.'.num'},
12077: $env{'course.'.$courseid.'.domain'},
12078: 'course',$mapp,\$recursed,\@recurseup,
12079: $courseid,'.',$spacequalifierrest,
12080: ([$courselevelm,'map' ],
12081: [$courseleveli,'map' ],
12082: [$courselevel, 'course']));
12083: if (defined($coursereply)) { return &get_reply($coursereply); }
12084: }
12085: # ------------------------------------------------------------------ Cascade up
12086: unless ($space eq '0') {
12087: my @parts=split(/_/,$space);
12088: my $id=pop(@parts);
12089: my $part=join('_',@parts);
12090: if ($part eq '') { $part='0'; }
12091: my @partgeneral=&EXT('resource.'.$part.'.'.$qualifierrest,
12092: $symbparm,$udom,$uname,$section,1);
12093: if (defined($partgeneral[0])) { return &get_reply(\@partgeneral); }
12094: }
12095: if ($recurse) { return undef; }
12096: my $pack_def=&packages_tab_default($filename,$varname,$toolsymb);
12097: if (defined($pack_def)) { return &get_reply([$pack_def,'resource']); }
12098: # ---------------------------------------------------- Any other user namespace
12099: } elsif ($realm eq 'environment') {
12100: # ----------------------------------------------------------------- environment
12101: if (($uname eq $env{'user.name'})&&($udom eq $env{'user.domain'})) {
12102: return $env{'environment.'.$spacequalifierrest};
12103: } else {
12104: if ($uname eq 'anonymous' && $udom eq '') {
12105: return '';
12106: }
12107: my %returnhash=&userenvironment($udom,$uname,
12108: $spacequalifierrest);
12109: return $returnhash{$spacequalifierrest};
12110: }
12111: } elsif ($realm eq 'system') {
12112: # ----------------------------------------------------------------- system.time
12113: if ($space eq 'time') {
12114: return time;
12115: }
12116: } elsif ($realm eq 'server') {
12117: # ----------------------------------------------------------------- system.time
12118: if ($space eq 'name') {
12119: return $ENV{'SERVER_NAME'};
12120: }
12121: }
12122: return '';
12123: }
12124:
12125: sub get_reply {
12126: my ($reply_value) = @_;
12127: if (ref($reply_value) eq 'ARRAY') {
12128: if (wantarray) {
12129: return @$reply_value;
12130: }
12131: return $reply_value->[0];
12132: } else {
12133: return $reply_value;
12134: }
12135: }
12136:
12137: sub check_group_parms {
12138: my ($courseid,$groups,$symbparm,$recurseparm,$mapparm,$what,$mapp,
12139: $recursed,$recurseupref) = @_;
12140: my @levels = ([$symbparm,'resource'],[$mapparm,'map'],[$recurseparm,'map'],
12141: [$what,'course']);
12142: my $coursereply;
12143: foreach my $group (@{$groups}) {
12144: my @groupitems = ();
12145: foreach my $level (@levels) {
12146: my $item = $courseid.'.['.$group.'].'.$level->[0];
12147: push(@groupitems,[$item,$level->[1]]);
12148: }
12149: my $coursereply = &resdata($env{'course.'.$courseid.'.num'},
12150: $env{'course.'.$courseid.'.domain'},
12151: 'course',$mapp,$recursed,$recurseupref,
12152: $courseid,'.['.$group.'].',$what,
12153: @groupitems);
12154: last if (defined($coursereply));
12155: }
12156: return $coursereply;
12157: }
12158:
12159: sub get_map_hierarchy {
12160: my ($mapname,$courseid) = @_;
12161: my @recurseup = ();
12162: if ($mapname) {
12163: if (($cachedmapkey eq $courseid) &&
12164: (abs($cachedmaptime-time)<5)) {
12165: if (ref($cachedmaps{$mapname}) eq 'ARRAY') {
12166: return @{$cachedmaps{$mapname}};
12167: }
12168: }
12169: my $navmap = Apache::lonnavmaps::navmap->new();
12170: if (ref($navmap)) {
12171: @recurseup = $navmap->recurseup_maps($mapname);
12172: undef($navmap);
12173: $cachedmaps{$mapname} = \@recurseup;
12174: $cachedmaptime=time;
12175: $cachedmapkey=$courseid;
12176: }
12177: }
12178: return @recurseup;
12179: }
12180:
12181: }
12182:
12183: sub sort_course_groups { # Sort groups based on defined rankings. Default is sort().
12184: my ($courseid,@groups) = @_;
12185: @groups = sort(@groups);
12186: return @groups;
12187: }
12188:
12189: sub packages_tab_default {
12190: my ($uri,$varname,$toolsymb)=@_;
12191: my (undef,$part,$name)=split(/\./,$varname);
12192:
12193: my (@extension,@specifics,$do_default);
12194: foreach my $package (split(/,/,&metadata($uri,'packages',$toolsymb))) {
12195: my ($pack_type,$pack_part)=split(/_/,$package,2);
12196: if ($pack_type eq 'default') {
12197: $do_default=1;
12198: } elsif ($pack_type eq 'extension') {
12199: push(@extension,[$package,$pack_type,$pack_part]);
12200: } elsif ($pack_part eq $part || $pack_type eq 'part') {
12201: # only look at packages defaults for packages that this id is
12202: push(@specifics,[$package,$pack_type,$pack_part]);
12203: }
12204: }
12205: # first look for a package that matches the requested part id
12206: foreach my $package (@specifics) {
12207: my (undef,$pack_type,$pack_part)=@{$package};
12208: next if ($pack_part ne $part);
12209: if (defined($packagetab{"$pack_type&$name&default"})) {
12210: return $packagetab{"$pack_type&$name&default"};
12211: }
12212: }
12213: # look for any possible matching non extension_ package
12214: foreach my $package (@specifics) {
12215: my (undef,$pack_type,$pack_part)=@{$package};
12216: if (defined($packagetab{"$pack_type&$name&default"})) {
12217: return $packagetab{"$pack_type&$name&default"};
12218: }
12219: if ($pack_type eq 'part') { $pack_part='0'; }
12220: if (defined($packagetab{$pack_type."_".$pack_part."&$name&default"})) {
12221: return $packagetab{$pack_type."_".$pack_part."&$name&default"};
12222: }
12223: }
12224: # look for any posible extension_ match
12225: foreach my $package (@extension) {
12226: my ($package,$pack_type)=@{$package};
12227: if (defined($packagetab{"$pack_type&$name&default"})) {
12228: return $packagetab{"$pack_type&$name&default"};
12229: }
12230: if (defined($packagetab{$package."&$name&default"})) {
12231: return $packagetab{$package."&$name&default"};
12232: }
12233: }
12234: # look for a global default setting
12235: if ($do_default && defined($packagetab{"default&$name&default"})) {
12236: return $packagetab{"default&$name&default"};
12237: }
12238: return undef;
12239: }
12240:
12241: sub add_prefix_and_part {
12242: my ($prefix,$part)=@_;
12243: my $keyroot;
12244: if (defined($prefix) && $prefix !~ /^__/) {
12245: # prefix that has a part already
12246: $keyroot=$prefix;
12247: } elsif (defined($prefix)) {
12248: # prefix that is missing a part
12249: if (defined($part)) { $keyroot='_'.$part.substr($prefix,1); }
12250: } else {
12251: # no prefix at all
12252: if (defined($part)) { $keyroot='_'.$part; }
12253: }
12254: return $keyroot;
12255: }
12256:
12257: # ---------------------------------------------------------------- Get metadata
12258:
12259: my %metaentry;
12260: my %importedpartids;
12261: my %importedrespids;
12262: sub metadata {
12263: my ($uri,$what,$toolsymb,$liburi,$prefix,$depthcount)=@_;
12264: $uri=&declutter($uri);
12265: # if it is a non metadata possible uri return quickly
12266: if (($uri eq '') ||
12267: (($uri =~ m|^/*adm/|) &&
12268: ($uri !~ m|^adm/includes|) && ($uri !~ m{/(smppg|bulletinboard|ext\.tool)$})) ||
12269: ($uri =~ m|/$|) || ($uri =~ m|/.meta$|) || ($uri =~ m{^/*uploaded/.+\.sequence$})) {
12270: return undef;
12271: }
12272: if (($uri =~ /^priv/ || $uri=~m{^home/httpd/html/priv})
12273: && &Apache::lonxml::get_state('target') =~ /^(|meta)$/) {
12274: return undef;
12275: }
12276: my $filename=$uri;
12277: $uri=~s/\.meta$//;
12278: #
12279: # Is the metadata already cached?
12280: # Look at timestamp of caching
12281: # Everything is cached by the main uri, libraries are never directly cached
12282: #
12283: if (!defined($liburi)) {
12284: my ($result,$cached)=&is_cached_new('meta',$uri);
12285: if (defined($cached)) { return $result->{':'.$what}; }
12286: }
12287:
12288: #
12289: # If the uri is for an external tool the file from
12290: # which metadata should be retrieved depends on whether
12291: # the tool had been configured to be gradable (set in the Course
12292: # Editor or Resource Editor).
12293: #
12294: # If a valid symb has been included as the third arg in the call
12295: # to &metadata() that can be used to retrieve the value of
12296: # parameter_0_gradable set for the resource, and included in the
12297: # uploaded map containing the tool. The value is retrieved via
12298: # &EXT(), if a valid symb is available. Otherwise the value of
12299: # gradable in the exttool_$marker.db file for the tool instance
12300: # is retrieved via &get().
12301: #
12302: # When lonuserstate::traceroute() calls lonnet::EXT() for
12303: # hiddenresource and encrypturl (during course initialization)
12304: # the map-level parameter for resource.0.gradable included in the
12305: # uploaded map containing the tool will not yet have been stored
12306: # in the user_course_parms.db file for the user's session, so in
12307: # this case fall back to retrieving gradable status from the
12308: # exttool_$marker.db file.
12309: #
12310: # In order to avoid an infinite loop, &metadata() will return
12311: # before a call to &EXT(), if the uri is for an external tool
12312: # and the $what for which metadata is being requested is
12313: # parameter_0_gradable or 0_gradable.
12314: #
12315:
12316: if ($uri =~ /ext\.tool$/) {
12317: if (($what eq 'parameter_0_gradable') || ($what eq '0_gradable')) {
12318: return;
12319: } else {
12320: my ($checked,$use_passback);
12321: if ($toolsymb ne '') {
12322: (undef,undef,my $tooluri) = &decode_symb($toolsymb);
12323: if (($tooluri eq $uri) && (&EXT('resource.0.gradable',$toolsymb))) {
12324: $checked = 1;
12325: if (&EXT('resource.0.gradable',$toolsymb) =~ /^yes$/i) {
12326: $use_passback = 1;
12327: }
12328: }
12329: }
12330: unless ($checked) {
12331: my ($ignore,$cdom,$cnum,$marker) = split(m{/},$uri);
12332: $marker=~s/\D//g;
12333: if ($marker) {
12334: my %toolsettings=&get('exttool_'.$marker,['gradable'],$cdom,$cnum);
12335: $use_passback = $toolsettings{'gradable'};
12336: }
12337: }
12338: if ($use_passback) {
12339: $filename = '/home/httpd/html/res/lib/templates/LTIpassback.tool';
12340: } else {
12341: $filename = '/home/httpd/html/res/lib/templates/LTIstandard.tool';
12342: }
12343: }
12344: }
12345:
12346: {
12347: # Imported parts would go here
12348: my @origfiletagids=();
12349: my $importedparts=0;
12350:
12351: # Imported responseids would go here
12352: my $importedresponses=0;
12353: #
12354: # Is this a recursive call for a library?
12355: #
12356: # if (! exists($metacache{$uri})) {
12357: # $metacache{$uri}={};
12358: # }
12359: my $cachetime = 60*60;
12360: if ($liburi) {
12361: $liburi=&declutter($liburi);
12362: $filename=$liburi;
12363: } else {
12364: &devalidate_cache_new('meta',$uri);
12365: undef(%metaentry);
12366: }
12367: my %metathesekeys=();
12368: unless ($filename=~/\.meta$/) { $filename.='.meta'; }
12369: my $metastring;
12370: if ($uri =~ /^priv/ || $uri=~/home\/httpd\/html\/priv/) {
12371: my $which = &hreflocation('','/'.($liburi || $uri));
12372: $metastring =
12373: &Apache::lonnet::ssi_body($which,
12374: ('grade_target' => 'meta'));
12375: $cachetime = 1; # only want this cached in the child not long term
12376: } elsif (($uri !~ m -^(editupload)/-) &&
12377: ($uri !~ m{^/*uploaded/$match_domain/$match_courseid/docs/})) {
12378: my $file=&filelocation('',&clutter($filename));
12379: #push(@{$metaentry{$uri.'.file'}},$file);
12380: $metastring=&getfile($file);
12381: }
12382: my $parser=HTML::LCParser->new(\$metastring);
12383: my $token;
12384: undef %metathesekeys;
12385: while ($token=$parser->get_token) {
12386: if ($token->[0] eq 'S') {
12387: if (defined($token->[2]->{'package'})) {
12388: #
12389: # This is a package - get package info
12390: #
12391: my $package=$token->[2]->{'package'};
12392: my $keyroot=&add_prefix_and_part($prefix,$token->[2]->{'part'});
12393: if (defined($token->[2]->{'id'})) {
12394: $keyroot.='_'.$token->[2]->{'id'};
12395: }
12396: if ($metaentry{':packages'}) {
12397: $metaentry{':packages'}.=','.$package.$keyroot;
12398: } else {
12399: $metaentry{':packages'}=$package.$keyroot;
12400: }
12401: foreach my $pack_entry (keys(%packagetab)) {
12402: my $part=$keyroot;
12403: $part=~s/^\_//;
12404: if ($pack_entry=~/^\Q$package\E\&/ ||
12405: $pack_entry=~/^\Q$package\E_0\&/) {
12406: my ($pack,$name,$subp)=split(/\&/,$pack_entry);
12407: # ignore package.tab specified default values
12408: # here &package_tab_default() will fetch those
12409: if ($subp eq 'default') { next; }
12410: my $value=$packagetab{$pack_entry};
12411: my $unikey;
12412: if ($pack =~ /_0$/) {
12413: $unikey='parameter_0_'.$name;
12414: $part=0;
12415: } else {
12416: $unikey='parameter'.$keyroot.'_'.$name;
12417: }
12418: if ($subp eq 'display') {
12419: $value.=' [Part: '.$part.']';
12420: }
12421: $metaentry{':'.$unikey.'.part'}=$part;
12422: $metathesekeys{$unikey}=1;
12423: unless (defined($metaentry{':'.$unikey.'.'.$subp})) {
12424: $metaentry{':'.$unikey.'.'.$subp}=$value;
12425: }
12426: if (defined($metaentry{':'.$unikey.'.default'})) {
12427: $metaentry{':'.$unikey}=
12428: $metaentry{':'.$unikey.'.default'};
12429: }
12430: }
12431: }
12432: } else {
12433: #
12434: # This is not a package - some other kind of start tag
12435: #
12436: my $entry=$token->[1];
12437: my $unikey='';
12438:
12439: if ($entry eq 'import') {
12440: #
12441: # Importing a library here
12442: #
12443: my $location=$parser->get_text('/import');
12444: my $dir=$filename;
12445: $dir=~s|[^/]*$||;
12446: $location=&filelocation($dir,$location);
12447:
12448: my $importid=$token->[2]->{'id'};
12449: my $importmode=$token->[2]->{'importmode'};
12450: #
12451: # Check metadata for imported file to
12452: # see if it contained response items
12453: #
12454: my ($origfile,@libfilekeys);
12455: my %currmetaentry = %metaentry;
12456: @libfilekeys = split(/,/,&metadata($location,'keys',undef,undef,undef,
12457: $depthcount+1));
12458: if (grep(/^responseorder$/,@libfilekeys)) {
12459: my $libresponseorder = &metadata($location,'responseorder',undef,undef,
12460: undef,$depthcount+1);
12461: if ($libresponseorder ne '') {
12462: if ($#origfiletagids<0) {
12463: undef(%importedrespids);
12464: undef(%importedpartids);
12465: }
12466: my @respids = split(/\s*,\s*/,$libresponseorder);
12467: if (@respids) {
12468: $importedrespids{$importid} = join(',',map { $importid.'_'.$_ } @respids);
12469: }
12470: if ($importedrespids{$importid} ne '') {
12471: $importedresponses = 1;
12472: # We need to get the original file and the imported file to get the response order correct
12473: # Load and inspect original file
12474: if ($#origfiletagids<0) {
12475: my $origfilelocation=$perlvar{'lonDocRoot'}.&clutter($uri);
12476: $origfile=&getfile($origfilelocation);
12477: @origfiletagids=($origfile=~/<((?:\w+)response|import|part)[^>]*id\s*=\s*[\"\']([^\"\']+)[\"\'][^>]*>/gs);
12478: }
12479: }
12480: }
12481: }
12482: # Do not overwrite contents of %metaentry hash for resource itself with
12483: # hash populated for imported library file
12484: %metaentry = %currmetaentry;
12485: undef(%currmetaentry);
12486: if ($importmode eq 'part') {
12487: # Import as part(s)
12488: $importedparts=1;
12489: # We need to get the original file and the imported file to get the part order correct
12490: # Good news: we do not need to worry about nested libraries, since parts cannot be nested
12491: # Load and inspect original file if we didn't do that already
12492: if ($#origfiletagids<0) {
12493: undef(%importedrespids);
12494: undef(%importedpartids);
12495: if ($origfile eq '') {
12496: my $origfilelocation=$perlvar{'lonDocRoot'}.&clutter($uri);
12497: $origfile=&getfile($origfilelocation);
12498: @origfiletagids=($origfile=~/<(part|import)[^>]*id\s*=\s*[\"\']([^\"\']+)[\"\'][^>]*>/gs);
12499: }
12500: }
12501: my @impfilepartids;
12502: # If <partorder> tag is included in metadata for the imported file
12503: # get the parts in the imported file from that.
12504: if (grep(/^partorder$/,@libfilekeys)) {
12505: %currmetaentry = %metaentry;
12506: my $libpartorder = &metadata($location,'partorder',undef,undef,undef,
12507: $depthcount+1);
12508: %metaentry = %currmetaentry;
12509: undef(%currmetaentry);
12510: if ($libpartorder ne '') {
12511: @impfilepartids=split(/\s*,\s*/,$libpartorder);
12512: }
12513: } else {
12514: # If no <partorder> tag available, load and inspect imported file
12515: my $impfile=&getfile($location);
12516: @impfilepartids=($impfile=~/<part[^>]*id\s*=\s*[\"\']([^\"\']+)[\"\'][^>]*>/gs);
12517: }
12518: if ($#impfilepartids>=0) {
12519: # This problem had parts
12520: $importedpartids{$token->[2]->{'id'}}=join(',',@impfilepartids);
12521: } else {
12522: # Importing by turning a single problem into a problem part
12523: # It gets the import-tags ID as part-ID
12524: $unikey=&add_prefix_and_part($prefix,$token->[2]->{'id'});
12525: $importedpartids{$token->[2]->{'id'}}=$token->[2]->{'id'};
12526: }
12527: } else {
12528: # Import as problem or as normal import
12529: $unikey=&add_prefix_and_part($prefix,$token->[2]->{'part'});
12530: unless ($importmode eq 'problem') {
12531: # Normal import
12532: if (defined($token->[2]->{'id'})) {
12533: $unikey.='_'.$token->[2]->{'id'};
12534: }
12535: }
12536: # Check metadata for imported file to
12537: # see if it contained parts
12538: if (grep(/^partorder$/,@libfilekeys)) {
12539: %currmetaentry = %metaentry;
12540: my $libpartorder = &metadata($location,'partorder',undef,undef,undef,
12541: $depthcount+1);
12542: %metaentry = %currmetaentry;
12543: undef(%currmetaentry);
12544: if ($libpartorder ne '') {
12545: $importedparts = 1;
12546: $importedpartids{$token->[2]->{'id'}}=$libpartorder;
12547: }
12548: }
12549: }
12550: if ($depthcount<20) {
12551: my $metadata =
12552: &metadata($uri,'keys',$toolsymb,$location,$unikey,
12553: $depthcount+1);
12554: foreach my $meta (split(',',$metadata)) {
12555: $metaentry{':'.$meta}=$metaentry{':'.$meta};
12556: $metathesekeys{$meta}=1;
12557: }
12558: }
12559: } else {
12560: #
12561: # Not importing, some other kind of non-package, non-library start tag
12562: #
12563: $unikey=$entry.&add_prefix_and_part($prefix,$token->[2]->{'part'});
12564: if (defined($token->[2]->{'id'})) {
12565: $unikey.='_'.$token->[2]->{'id'};
12566: }
12567: if (defined($token->[2]->{'name'})) {
12568: $unikey.='_'.$token->[2]->{'name'};
12569: }
12570: $metathesekeys{$unikey}=1;
12571: foreach my $param (@{$token->[3]}) {
12572: $metaentry{':'.$unikey.'.'.$param} =
12573: $token->[2]->{$param};
12574: }
12575: my $internaltext=&HTML::Entities::decode($parser->get_text('/'.$entry));
12576: my $default=$metaentry{':'.$unikey.'.default'};
12577: if ( $internaltext =~ /^\s*$/ && $default !~ /^\s*$/) {
12578: # only ws inside the tag, and not in default, so use default
12579: # as value
12580: $metaentry{':'.$unikey}=$default;
12581: } elsif ( $internaltext =~ /\S/ ) {
12582: # something interesting inside the tag
12583: $metaentry{':'.$unikey}=$internaltext;
12584: } else {
12585: # no interesting values, don't set a default
12586: }
12587: # end of not-a-package not-a-library import
12588: }
12589: # end of not-a-package start tag
12590: }
12591: # the next is the end of "start tag"
12592: }
12593: }
12594: my ($extension) = ($uri =~ /\.(\w+)$/);
12595: $extension = lc($extension);
12596: if ($extension eq 'htm') { $extension='html'; }
12597:
12598: foreach my $key (keys(%packagetab)) {
12599: #no specific packages #how's our extension
12600: if ($key!~/^extension_\Q$extension\E&/) { next; }
12601: &metadata_create_package_def($uri,$key,'extension_'.$extension,
12602: \%metathesekeys);
12603: }
12604:
12605: if (!exists($metaentry{':packages'})
12606: || $packagetab{"import_defaults&extension_$extension"}) {
12607: foreach my $key (keys(%packagetab)) {
12608: #no specific packages well let's get default then
12609: if ($key!~/^default&/) { next; }
12610: &metadata_create_package_def($uri,$key,'default',
12611: \%metathesekeys);
12612: }
12613: }
12614: # are there custom rights to evaluate
12615: if ($metaentry{':copyright'} eq 'custom') {
12616:
12617: #
12618: # Importing a rights file here
12619: #
12620: unless ($depthcount) {
12621: my $location=$metaentry{':customdistributionfile'};
12622: my $dir=$filename;
12623: $dir=~s|[^/]*$||;
12624: $location=&filelocation($dir,$location);
12625: my $rights_metadata =
12626: &metadata($uri,'keys',$toolsymb,$location,'_rights',
12627: $depthcount+1);
12628: foreach my $rights (split(',',$rights_metadata)) {
12629: #$metaentry{':'.$rights}=$metacache{$uri}->{':'.$rights};
12630: $metathesekeys{$rights}=1;
12631: }
12632: }
12633: }
12634: # uniqifiy package listing
12635: my %seen;
12636: my @uniq_packages =
12637: grep { ! $seen{$_} ++ } (split(',',$metaentry{':packages'}));
12638: $metaentry{':packages'} = join(',',@uniq_packages);
12639:
12640: if (($importedresponses) || ($importedparts)) {
12641: if ($importedparts) {
12642: # We had imported parts and need to rebuild partorder
12643: $metaentry{':partorder'}='';
12644: $metathesekeys{'partorder'}=1;
12645: }
12646: if ($importedresponses) {
12647: # We had imported responses and need to rebuil responseorder
12648: $metaentry{':responseorder'}='';
12649: $metathesekeys{'responseorder'}=1;
12650: }
12651: for (my $index=0;$index<$#origfiletagids;$index+=2) {
12652: my $origid = $origfiletagids[$index+1];
12653: if ($origfiletagids[$index] eq 'part') {
12654: # Original part, part of the problem
12655: if ($importedparts) {
12656: $metaentry{':partorder'}.=','.$origid;
12657: }
12658: } elsif ($origfiletagids[$index] eq 'import') {
12659: if ($importedparts) {
12660: # We have imported parts at this position
12661: if ($importedpartids{$origid} ne '') {
12662: $metaentry{':partorder'}.=','.$importedpartids{$origid};
12663: }
12664: }
12665: if ($importedresponses) {
12666: # We have imported responses at this position
12667: if ($importedrespids{$origid} ne '') {
12668: $metaentry{':responseorder'}.=','.$importedrespids{$origid};
12669: }
12670: }
12671: } else {
12672: # Original response item, part of the problem
12673: if ($importedresponses) {
12674: $metaentry{':responseorder'}.=','.$origid;
12675: }
12676: }
12677: }
12678: if ($importedparts) {
12679: $metaentry{':partorder'}=~s/^\,//;
12680: }
12681: if ($importedresponses) {
12682: $metaentry{':responseorder'}=~s/^\,//;
12683: }
12684: }
12685: $metaentry{':keys'} = join(',',keys(%metathesekeys));
12686: &metadata_generate_part0(\%metathesekeys,\%metaentry,$uri);
12687: $metaentry{':allpossiblekeys'}=join(',',keys(%metathesekeys));
12688: unless ($liburi) {
12689: &do_cache_new('meta',$uri,\%metaentry,$cachetime);
12690: }
12691: # this is the end of "was not already recently cached
12692: }
12693: return $metaentry{':'.$what};
12694: }
12695:
12696: sub metadata_create_package_def {
12697: my ($uri,$key,$package,$metathesekeys)=@_;
12698: my ($pack,$name,$subp)=split(/\&/,$key);
12699: if ($subp eq 'default') { next; }
12700:
12701: if (defined($metaentry{':packages'})) {
12702: $metaentry{':packages'}.=','.$package;
12703: } else {
12704: $metaentry{':packages'}=$package;
12705: }
12706: my $value=$packagetab{$key};
12707: my $unikey;
12708: $unikey='parameter_0_'.$name;
12709: $metaentry{':'.$unikey.'.part'}=0;
12710: $$metathesekeys{$unikey}=1;
12711: unless (defined($metaentry{':'.$unikey.'.'.$subp})) {
12712: $metaentry{':'.$unikey.'.'.$subp}=$value;
12713: }
12714: if (defined($metaentry{':'.$unikey.'.default'})) {
12715: $metaentry{':'.$unikey}=
12716: $metaentry{':'.$unikey.'.default'};
12717: }
12718: }
12719:
12720: sub metadata_generate_part0 {
12721: my ($metadata,$metacache,$uri) = @_;
12722: my %allnames;
12723: foreach my $metakey (keys(%$metadata)) {
12724: if ($metakey=~/^parameter\_(.*)/) {
12725: my $part=$$metacache{':'.$metakey.'.part'};
12726: my $name=$$metacache{':'.$metakey.'.name'};
12727: if (! exists($$metadata{'parameter_0_'.$name.'.name'})) {
12728: $allnames{$name}=$part;
12729: }
12730: }
12731: }
12732: foreach my $name (keys(%allnames)) {
12733: $$metadata{"parameter_0_$name"}=1;
12734: my $key=":parameter_0_$name";
12735: $$metacache{"$key.part"}='0';
12736: $$metacache{"$key.name"}=$name;
12737: $$metacache{"$key.type"}=$$metacache{':parameter_'.
12738: $allnames{$name}.'_'.$name.
12739: '.type'};
12740: my $olddis=$$metacache{':parameter_'.$allnames{$name}.'_'.$name.
12741: '.display'};
12742: my $expr='[Part: '.$allnames{$name}.']';
12743: $olddis=~s/\Q$expr\E/\[Part: 0\]/;
12744: $$metacache{"$key.display"}=$olddis;
12745: }
12746: }
12747:
12748: # ------------------------------------------------------ Devalidate title cache
12749:
12750: sub devalidate_title_cache {
12751: my ($url)=@_;
12752: if (!$env{'request.course.id'}) { return; }
12753: my $symb=&symbread($url);
12754: if (!$symb) { return; }
12755: my $key=$env{'request.course.id'}."\0".$symb;
12756: &devalidate_cache_new('title',$key);
12757: }
12758:
12759: # ------------------------------------------------- Get the title of a course
12760:
12761: sub current_course_title {
12762: return $env{ 'course.' . $env{'request.course.id'} . '.description' };
12763: }
12764: # ------------------------------------------------- Get the title of a resource
12765:
12766: sub gettitle {
12767: my $urlsymb=shift;
12768: my $symb=&symbread($urlsymb);
12769: if ($symb) {
12770: my $key=$env{'request.course.id'}."\0".$symb;
12771: my ($result,$cached)=&is_cached_new('title',$key);
12772: if (defined($cached)) {
12773: return $result;
12774: }
12775: my ($map,$resid,$url)=&decode_symb($symb);
12776: my $title='';
12777: if (!$map && $resid == 0 && $url =~/default\.sequence$/) {
12778: $title = $env{'course.'.$env{'request.course.id'}.'.description'};
12779: } else {
12780: if (tie(my %bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
12781: &GDBM_READER(),0640)) {
12782: my $mapid=$bighash{'map_pc_'.&clutter($map)};
12783: $title=$bighash{'title_'.$mapid.'.'.$resid};
12784: untie(%bighash);
12785: }
12786: }
12787: $title=~s/\&colon\;/\:/gs;
12788: if ($title) {
12789: # Remember both $symb and $title for dynamic metadata
12790: $accesshash{$symb.'___crstitle'}=$title;
12791: $accesshash{&declutter($map).'___'.&declutter($url).'___usage'}=time;
12792: # Cache this title and then return it
12793: return &do_cache_new('title',$key,$title,600);
12794: }
12795: $urlsymb=$url;
12796: }
12797: my $title=&metadata($urlsymb,'title');
12798: if (!$title) { $title=(split('/',$urlsymb))[-1]; }
12799: return $title;
12800: }
12801:
12802: sub get_slot {
12803: my ($which,$cnum,$cdom)=@_;
12804: if (!$cnum || !$cdom) {
12805: (undef,my $courseid)=&whichuser();
12806: $cdom=$env{'course.'.$courseid.'.domain'};
12807: $cnum=$env{'course.'.$courseid.'.num'};
12808: }
12809: my $key=join("\0",'slots',$cdom,$cnum,$which);
12810: my %slotinfo;
12811: if (exists($remembered{$key})) {
12812: $slotinfo{$which} = $remembered{$key};
12813: } else {
12814: %slotinfo=&get('slots',[$which],$cdom,$cnum);
12815: &Apache::lonhomework::showhash(%slotinfo);
12816: my ($tmp)=keys(%slotinfo);
12817: if ($tmp=~/^error:/) { return (); }
12818: $remembered{$key} = $slotinfo{$which};
12819: }
12820: if (ref($slotinfo{$which}) eq 'HASH') {
12821: return %{$slotinfo{$which}};
12822: }
12823: return $slotinfo{$which};
12824: }
12825:
12826: sub get_reservable_slots {
12827: my ($cnum,$cdom,$uname,$udom) = @_;
12828: my $now = time;
12829: my $reservable_info;
12830: my $key=join("\0",'reservableslots',$cdom,$cnum,$uname,$udom);
12831: if (exists($remembered{$key})) {
12832: $reservable_info = $remembered{$key};
12833: } else {
12834: my %resv;
12835: ($resv{'now_order'},$resv{'now'},$resv{'future_order'},$resv{'future'}) =
12836: &Apache::loncommon::get_future_slots($cnum,$cdom,$now);
12837: $reservable_info = \%resv;
12838: $remembered{$key} = $reservable_info;
12839: }
12840: return $reservable_info;
12841: }
12842:
12843: sub get_course_slots {
12844: my ($cnum,$cdom) = @_;
12845: my $hashid=$cnum.':'.$cdom;
12846: my ($result,$cached) = &Apache::lonnet::is_cached_new('allslots',$hashid);
12847: if (defined($cached)) {
12848: if (ref($result) eq 'HASH') {
12849: return %{$result};
12850: }
12851: } else {
12852: my %slots=&Apache::lonnet::dump('slots',$cdom,$cnum);
12853: my ($tmp) = keys(%slots);
12854: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
12855: &do_cache_new('allslots',$hashid,\%slots,600);
12856: return %slots;
12857: }
12858: }
12859: return;
12860: }
12861:
12862: sub devalidate_slots_cache {
12863: my ($cnum,$cdom)=@_;
12864: my $hashid=$cnum.':'.$cdom;
12865: &devalidate_cache_new('allslots',$hashid);
12866: }
12867:
12868: sub get_coursechange {
12869: my ($cdom,$cnum) = @_;
12870: if ($cdom eq '' || $cnum eq '') {
12871: return unless ($env{'request.course.id'});
12872: $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
12873: $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
12874: }
12875: my $hashid=$cdom.'_'.$cnum;
12876: my ($change,$cached)=&is_cached_new('crschange',$hashid);
12877: if ((defined($cached)) && ($change ne '')) {
12878: return $change;
12879: } else {
12880: my %crshash;
12881: %crshash = &get('environment',['internal.contentchange'],$cdom,$cnum);
12882: if ($crshash{'internal.contentchange'} eq '') {
12883: $change = $env{'course.'.$cdom.'_'.$cnum.'.internal.created'};
12884: if ($change eq '') {
12885: %crshash = &get('environment',['internal.created'],$cdom,$cnum);
12886: $change = $crshash{'internal.created'};
12887: }
12888: } else {
12889: $change = $crshash{'internal.contentchange'};
12890: }
12891: my $cachetime = 600;
12892: &do_cache_new('crschange',$hashid,$change,$cachetime);
12893: }
12894: return $change;
12895: }
12896:
12897: sub devalidate_coursechange_cache {
12898: my ($cnum,$cdom)=@_;
12899: my $hashid=$cnum.':'.$cdom;
12900: &devalidate_cache_new('crschange',$hashid);
12901: }
12902:
12903: # ------------------------------------------------- Update symbolic store links
12904:
12905: sub symblist {
12906: my ($mapname,%newhash)=@_;
12907: $mapname=&deversion(&declutter($mapname));
12908: my %hash;
12909: if (($env{'request.course.fn'}) && (%newhash)) {
12910: if (tie(%hash,'GDBM_File',$env{'request.course.fn'}.'_symb.db',
12911: &GDBM_WRCREAT(),0640)) {
12912: foreach my $url (keys(%newhash)) {
12913: next if ($url eq 'last_known'
12914: && $env{'form.no_update_last_known'});
12915: $hash{declutter($url)}=&encode_symb($mapname,
12916: $newhash{$url}->[1],
12917: $newhash{$url}->[0]);
12918: }
12919: if (untie(%hash)) {
12920: return 'ok';
12921: }
12922: }
12923: }
12924: return 'error';
12925: }
12926:
12927: # --------------------------------------------------------------- Verify a symb
12928:
12929: sub symbverify {
12930: my ($symb,$thisurl,$encstate)=@_;
12931: my $thisfn=$thisurl;
12932: $thisfn=&declutter($thisfn);
12933: # direct jump to resource in page or to a sequence - will construct own symbs
12934: if ($thisfn=~/\.(page|sequence)$/) { return 1; }
12935: # check URL part
12936: my ($map,$resid,$url)=&decode_symb($symb);
12937:
12938: unless ($url eq $thisfn) { return 0; }
12939:
12940: $symb=&symbclean($symb);
12941: $thisurl=&deversion($thisurl);
12942: $thisfn=&deversion($thisfn);
12943:
12944: my %bighash;
12945: my $okay=0;
12946:
12947: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
12948: &GDBM_READER(),0640)) {
12949: my $noclutter;
12950: if (($thisurl =~ m{^/adm/wrapper/ext/}) || ($thisurl =~ m{^ext/})) {
12951: $thisurl =~ s/\?.+$//;
12952: if ($map =~ m{^uploaded/.+\.page$}) {
12953: $thisurl =~ s{^(/adm/wrapper|)/ext/}{http://};
12954: $thisurl =~ s{^\Qhttp://https://\E}{https://};
12955: $noclutter = 1;
12956: }
12957: }
12958: my $ids;
12959: if ($noclutter) {
12960: $ids=$bighash{'ids_'.$thisurl};
12961: } else {
12962: $ids=$bighash{'ids_'.&clutter($thisurl)};
12963: }
12964: unless ($ids) {
12965: my $idkey = 'ids_'.($thisurl =~ m{^/}? '' : '/').$thisurl;
12966: $ids=$bighash{$idkey};
12967: }
12968: if ($ids) {
12969: # ------------------------------------------------------------------- Has ID(s)
12970: if ($thisfn =~ m{^/adm/wrapper/ext/}) {
12971: $symb =~ s/\?.+$//;
12972: }
12973: foreach my $id (split(/\,/,$ids)) {
12974: my ($mapid,$resid)=split(/\./,$id);
12975: if (
12976: &symbclean(&declutter($bighash{'map_id_'.$mapid}).'___'.$resid.'___'.$thisfn)
12977: eq $symb) {
12978: if (ref($encstate)) {
12979: $$encstate = $bighash{'encrypted_'.$id};
12980: }
12981: if (($env{'request.role.adv'}) ||
12982: ($bighash{'encrypted_'.$id} eq $env{'request.enc'}) ||
12983: ($thisurl eq '/adm/navmaps')) {
12984: $okay=1;
12985: last;
12986: }
12987: }
12988: }
12989: }
12990: untie(%bighash);
12991: }
12992: return $okay;
12993: }
12994:
12995: # --------------------------------------------------------------- Clean-up symb
12996:
12997: sub symbclean {
12998: my $symb=shift;
12999: if ($symb=~m|^/enc/|) { $symb=&Apache::lonenc::unencrypted($symb); }
13000: # remove version from map
13001: $symb=~s/\.(\d+)\.(\w+)\_\_\_/\.$2\_\_\_/;
13002:
13003: # remove version from URL
13004: $symb=~s/\.(\d+)\.(\w+)$/\.$2/;
13005:
13006: # remove wrapper
13007:
13008: $symb=~s/(\_\_\_\d+\_\_\_)adm\/wrapper\/(res\/)*/$1/;
13009: $symb=~s/(\_\_\_\d+\_\_\_)adm\/coursedocs\/showdoc\/(res\/)*/$1/;
13010: return $symb;
13011: }
13012:
13013: # ---------------------------------------------- Split symb to find map and url
13014:
13015: sub encode_symb {
13016: my ($map,$resid,$url)=@_;
13017: return &symbclean(&declutter($map).'___'.$resid.'___'.&declutter($url));
13018: }
13019:
13020: sub decode_symb {
13021: my $symb=shift;
13022: if ($symb=~m|^/enc/|) { $symb=&Apache::lonenc::unencrypted($symb); }
13023: my ($map,$resid,$url)=split(/___/,$symb);
13024: return (&fixversion($map),$resid,&fixversion($url));
13025: }
13026:
13027: sub fixversion {
13028: my $fn=shift;
13029: if ($fn=~/^(adm|uploaded|editupload|public)/) { return $fn; }
13030: my %bighash;
13031: my $uri=&clutter($fn);
13032: my $key=$env{'request.course.id'}.'_'.$uri;
13033: # is this cached?
13034: my ($result,$cached)=&is_cached_new('courseresversion',$key);
13035: if (defined($cached)) { return $result; }
13036: # unfortunately not cached, or expired
13037: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
13038: &GDBM_READER(),0640)) {
13039: if ($bighash{'version_'.$uri}) {
13040: my $version=$bighash{'version_'.$uri};
13041: unless (($version eq 'mostrecent') ||
13042: ($version==&getversion($uri))) {
13043: $uri=~s/\.(\w+)$/\.$version\.$1/;
13044: }
13045: }
13046: untie %bighash;
13047: }
13048: return &do_cache_new('courseresversion',$key,&declutter($uri),600);
13049: }
13050:
13051: sub deversion {
13052: my $url=shift;
13053: $url=~s/\.\d+\.(\w+)$/\.$1/;
13054: return $url;
13055: }
13056:
13057: # ------------------------------------------------------ Return symb list entry
13058:
13059: sub symbread {
13060: my ($thisfn,$donotrecurse,$ignorecachednull,$checkforblock,$possibles)=@_;
13061: my $cache_str='request.symbread.cached.'.$thisfn;
13062: if (defined($env{$cache_str})) {
13063: if ($ignorecachednull) {
13064: return $env{$cache_str} unless ($env{$cache_str} eq '');
13065: } else {
13066: return $env{$cache_str};
13067: }
13068: }
13069: # no filename provided? try from environment
13070: unless ($thisfn) {
13071: if ($env{'request.symb'}) {
13072: return $env{$cache_str}=&symbclean($env{'request.symb'});
13073: }
13074: $thisfn=$env{'request.filename'};
13075: }
13076: if ($thisfn=~m|^/enc/|) { $thisfn=&Apache::lonenc::unencrypted($thisfn); }
13077: # is that filename actually a symb? Verify, clean, and return
13078: if ($thisfn=~/\_\_\_\d+\_\_\_(.*)$/) {
13079: if (&symbverify($thisfn,$1)) {
13080: return $env{$cache_str}=&symbclean($thisfn);
13081: }
13082: }
13083: $thisfn=declutter($thisfn);
13084: my %hash;
13085: my %bighash;
13086: my $syval='';
13087: if (($env{'request.course.fn'}) && ($thisfn)) {
13088: my $targetfn = $thisfn;
13089: if ( ($thisfn =~ m/^(uploaded|editupload)\//) && ($thisfn !~ m/\.(page|sequence)$/) ) {
13090: $targetfn = 'adm/wrapper/'.$thisfn;
13091: }
13092: if ($targetfn =~ m|^adm/wrapper/(ext/.*)|) {
13093: $targetfn=$1;
13094: }
13095: if (tie(%hash,'GDBM_File',$env{'request.course.fn'}.'_symb.db',
13096: &GDBM_READER(),0640)) {
13097: $syval=$hash{$targetfn};
13098: untie(%hash);
13099: }
13100: # ---------------------------------------------------------- There was an entry
13101: if ($syval) {
13102: #unless ($syval=~/\_\d+$/) {
13103: #unless ($env{'form.request.prefix'}=~/\.(\d+)\_$/) {
13104: #&appenv({'request.ambiguous' => $thisfn});
13105: #return $env{$cache_str}='';
13106: #}
13107: #$syval.=$1;
13108: #}
13109: } else {
13110: # ------------------------------------------------------- Was not in symb table
13111: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
13112: &GDBM_READER(),0640)) {
13113: # ---------------------------------------------- Get ID(s) for current resource
13114: my $ids=$bighash{'ids_'.&clutter($thisfn)};
13115: unless ($ids) {
13116: $ids=$bighash{'ids_/'.$thisfn};
13117: }
13118: unless ($ids) {
13119: # alias?
13120: $ids=$bighash{'mapalias_'.$thisfn};
13121: }
13122: if ($ids) {
13123: # ------------------------------------------------------------------- Has ID(s)
13124: my @possibilities=split(/\,/,$ids);
13125: if ($#possibilities==0) {
13126: # ----------------------------------------------- There is only one possibility
13127: my ($mapid,$resid)=split(/\./,$ids);
13128: $syval=&encode_symb($bighash{'map_id_'.$mapid},
13129: $resid,$thisfn);
13130: if (ref($possibles) eq 'HASH') {
13131: $possibles->{$syval} = 1;
13132: }
13133: if ($checkforblock) {
13134: my @blockers = &has_comm_blocking('bre',$syval,$bighash{'src_'.$ids});
13135: if (@blockers) {
13136: $syval = '';
13137: return;
13138: }
13139: }
13140: } elsif ((!$donotrecurse) || ($checkforblock) || (ref($possibles) eq 'HASH')) {
13141: # ------------------------------------------ There is more than one possibility
13142: my $realpossible=0;
13143: foreach my $id (@possibilities) {
13144: my $file=$bighash{'src_'.$id};
13145: my $canaccess;
13146: if (($donotrecurse) || ($checkforblock) || (ref($possibles) eq 'HASH')) {
13147: $canaccess = 1;
13148: } else {
13149: $canaccess = &allowed('bre',$file);
13150: }
13151: if ($canaccess) {
13152: my ($mapid,$resid)=split(/\./,$id);
13153: if ($bighash{'map_type_'.$mapid} ne 'page') {
13154: my $poss_syval=&encode_symb($bighash{'map_id_'.$mapid},
13155: $resid,$thisfn);
13156: if (ref($possibles) eq 'HASH') {
13157: $possibles->{$syval} = 1;
13158: }
13159: if ($checkforblock) {
13160: my @blockers = &has_comm_blocking('bre',$poss_syval,$file);
13161: unless (@blockers > 0) {
13162: $syval = $poss_syval;
13163: $realpossible++;
13164: }
13165: } else {
13166: $syval = $poss_syval;
13167: $realpossible++;
13168: }
13169: }
13170: }
13171: }
13172: if ($realpossible!=1) { $syval=''; }
13173: } else {
13174: $syval='';
13175: }
13176: }
13177: untie(%bighash);
13178: }
13179: }
13180: if ($syval) {
13181: return $env{$cache_str}=$syval;
13182: }
13183: }
13184: &appenv({'request.ambiguous' => $thisfn});
13185: return $env{$cache_str}='';
13186: }
13187:
13188: # ---------------------------------------------------------- Return random seed
13189:
13190: sub numval {
13191: my $txt=shift;
13192: $txt=~tr/A-J/0-9/;
13193: $txt=~tr/a-j/0-9/;
13194: $txt=~tr/K-T/0-9/;
13195: $txt=~tr/k-t/0-9/;
13196: $txt=~tr/U-Z/0-5/;
13197: $txt=~tr/u-z/0-5/;
13198: $txt=~s/\D//g;
13199: if ($_64bit) { if ($txt > 2**32) { return -1; } }
13200: return int($txt);
13201: }
13202:
13203: sub numval2 {
13204: my $txt=shift;
13205: $txt=~tr/A-J/0-9/;
13206: $txt=~tr/a-j/0-9/;
13207: $txt=~tr/K-T/0-9/;
13208: $txt=~tr/k-t/0-9/;
13209: $txt=~tr/U-Z/0-5/;
13210: $txt=~tr/u-z/0-5/;
13211: $txt=~s/\D//g;
13212: my @txts=split(/(\d\d\d\d\d\d\d\d\d)/,$txt);
13213: my $total;
13214: foreach my $val (@txts) { $total+=$val; }
13215: if ($_64bit) { if ($total > 2**32) { return -1; } }
13216: return int($total);
13217: }
13218:
13219: sub numval3 {
13220: use integer;
13221: my $txt=shift;
13222: $txt=~tr/A-J/0-9/;
13223: $txt=~tr/a-j/0-9/;
13224: $txt=~tr/K-T/0-9/;
13225: $txt=~tr/k-t/0-9/;
13226: $txt=~tr/U-Z/0-5/;
13227: $txt=~tr/u-z/0-5/;
13228: $txt=~s/\D//g;
13229: my @txts=split(/(\d\d\d\d\d\d\d\d\d)/,$txt);
13230: my $total;
13231: foreach my $val (@txts) { $total+=$val; }
13232: if ($_64bit) { $total=(($total<<32)>>32); }
13233: return $total;
13234: }
13235:
13236: sub digest {
13237: my ($data)=@_;
13238: my $digest=&Digest::MD5::md5($data);
13239: my ($a,$b,$c,$d)=unpack("iiii",$digest);
13240: my ($e,$f);
13241: {
13242: use integer;
13243: $e=($a+$b);
13244: $f=($c+$d);
13245: if ($_64bit) {
13246: $e=(($e<<32)>>32);
13247: $f=(($f<<32)>>32);
13248: }
13249: }
13250: if (wantarray) {
13251: return ($e,$f);
13252: } else {
13253: my $g;
13254: {
13255: use integer;
13256: $g=($e+$f);
13257: if ($_64bit) {
13258: $g=(($g<<32)>>32);
13259: }
13260: }
13261: return $g;
13262: }
13263: }
13264:
13265: sub latest_rnd_algorithm_id {
13266: return '64bit5';
13267: }
13268:
13269: sub get_rand_alg {
13270: my ($courseid)=@_;
13271: if (!$courseid) { $courseid=(&whichuser())[1]; }
13272: if ($courseid) {
13273: return $env{"course.$courseid.rndseed"};
13274: }
13275: return &latest_rnd_algorithm_id();
13276: }
13277:
13278: sub validCODE {
13279: my ($CODE)=@_;
13280: if (defined($CODE) && $CODE ne '' && $CODE =~ /^\w+$/) { return 1; }
13281: return 0;
13282: }
13283:
13284: sub getCODE {
13285: if (&validCODE($env{'form.CODE'})) { return $env{'form.CODE'}; }
13286: if ( (defined($Apache::lonhomework::parsing_a_problem) ||
13287: defined($Apache::lonhomework::parsing_a_task) ) &&
13288: &validCODE($Apache::lonhomework::history{'resource.CODE'})) {
13289: return $Apache::lonhomework::history{'resource.CODE'};
13290: }
13291: return undef;
13292: }
13293: #
13294: # Determines the random seed for a specific context:
13295: #
13296: # parameters:
13297: # symb - in course context the symb for the seed.
13298: # course_id - The course id of the form domain_coursenum.
13299: # domain - Domain for the user.
13300: # course - Course for the user.
13301: # cenv - environment of the course.
13302: #
13303: # NOTE:
13304: # All parameters are picked out of the environment if missing
13305: # or not defined.
13306: # If a symb cannot be determined the current time is used instead.
13307: #
13308: # For a given well defined symb, courside, domain, username,
13309: # and course environment, the seed is reproducible.
13310: #
13311: sub rndseed {
13312: my ($symb,$courseid,$domain,$username, $cenv)=@_;
13313: my ($wsymb,$wcourseid,$wdomain,$wusername)=&whichuser();
13314: if (!defined($symb)) {
13315: unless ($symb=$wsymb) { return time; }
13316: }
13317: if (!defined $courseid) {
13318: $courseid=$wcourseid;
13319: }
13320: if (!defined $domain) { $domain=$wdomain; }
13321: if (!defined $username) { $username=$wusername }
13322:
13323: my $which;
13324: if (defined($cenv->{'rndseed'})) {
13325: $which = $cenv->{'rndseed'};
13326: } else {
13327: $which =&get_rand_alg($courseid);
13328: }
13329: if (defined(&getCODE())) {
13330:
13331: if ($which eq '64bit5') {
13332: return &rndseed_CODE_64bit5($symb,$courseid,$domain,$username);
13333: } elsif ($which eq '64bit4') {
13334: return &rndseed_CODE_64bit4($symb,$courseid,$domain,$username);
13335: } else {
13336: return &rndseed_CODE_64bit($symb,$courseid,$domain,$username);
13337: }
13338: } elsif ($which eq '64bit5') {
13339: return &rndseed_64bit5($symb,$courseid,$domain,$username);
13340: } elsif ($which eq '64bit4') {
13341: return &rndseed_64bit4($symb,$courseid,$domain,$username);
13342: } elsif ($which eq '64bit3') {
13343: return &rndseed_64bit3($symb,$courseid,$domain,$username);
13344: } elsif ($which eq '64bit2') {
13345: return &rndseed_64bit2($symb,$courseid,$domain,$username);
13346: } elsif ($which eq '64bit') {
13347: return &rndseed_64bit($symb,$courseid,$domain,$username);
13348: }
13349: return &rndseed_32bit($symb,$courseid,$domain,$username);
13350: }
13351:
13352: sub rndseed_32bit {
13353: my ($symb,$courseid,$domain,$username)=@_;
13354: {
13355: use integer;
13356: my $symbchck=unpack("%32C*",$symb) << 27;
13357: my $symbseed=numval($symb) << 22;
13358: my $namechck=unpack("%32C*",$username) << 17;
13359: my $nameseed=numval($username) << 12;
13360: my $domainseed=unpack("%32C*",$domain) << 7;
13361: my $courseseed=unpack("%32C*",$courseid);
13362: my $num=$symbseed+$nameseed+$domainseed+$courseseed+$namechck+$symbchck;
13363: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
13364: #&logthis("rndseed :$num:$symb");
13365: if ($_64bit) { $num=(($num<<32)>>32); }
13366: return $num;
13367: }
13368: }
13369:
13370: sub rndseed_64bit {
13371: my ($symb,$courseid,$domain,$username)=@_;
13372: {
13373: use integer;
13374: my $symbchck=unpack("%32S*",$symb) << 21;
13375: my $symbseed=numval($symb) << 10;
13376: my $namechck=unpack("%32S*",$username);
13377:
13378: my $nameseed=numval($username) << 21;
13379: my $domainseed=unpack("%32S*",$domain) << 10;
13380: my $courseseed=unpack("%32S*",$courseid);
13381:
13382: my $num1=$symbchck+$symbseed+$namechck;
13383: my $num2=$nameseed+$domainseed+$courseseed;
13384: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
13385: #&logthis("rndseed :$num:$symb");
13386: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
13387: return "$num1,$num2";
13388: }
13389: }
13390:
13391: sub rndseed_64bit2 {
13392: my ($symb,$courseid,$domain,$username)=@_;
13393: {
13394: use integer;
13395: # strings need to be an even # of cahracters long, it it is odd the
13396: # last characters gets thrown away
13397: my $symbchck=unpack("%32S*",$symb.' ') << 21;
13398: my $symbseed=numval($symb) << 10;
13399: my $namechck=unpack("%32S*",$username.' ');
13400:
13401: my $nameseed=numval($username) << 21;
13402: my $domainseed=unpack("%32S*",$domain.' ') << 10;
13403: my $courseseed=unpack("%32S*",$courseid.' ');
13404:
13405: my $num1=$symbchck+$symbseed+$namechck;
13406: my $num2=$nameseed+$domainseed+$courseseed;
13407: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
13408: #&logthis("rndseed :$num:$symb");
13409: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
13410: return "$num1,$num2";
13411: }
13412: }
13413:
13414: sub rndseed_64bit3 {
13415: my ($symb,$courseid,$domain,$username)=@_;
13416: {
13417: use integer;
13418: # strings need to be an even # of cahracters long, it it is odd the
13419: # last characters gets thrown away
13420: my $symbchck=unpack("%32S*",$symb.' ') << 21;
13421: my $symbseed=numval2($symb) << 10;
13422: my $namechck=unpack("%32S*",$username.' ');
13423:
13424: my $nameseed=numval2($username) << 21;
13425: my $domainseed=unpack("%32S*",$domain.' ') << 10;
13426: my $courseseed=unpack("%32S*",$courseid.' ');
13427:
13428: my $num1=$symbchck+$symbseed+$namechck;
13429: my $num2=$nameseed+$domainseed+$courseseed;
13430: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
13431: #&logthis("rndseed :$num1:$num2:$_64bit");
13432: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
13433:
13434: return "$num1:$num2";
13435: }
13436: }
13437:
13438: sub rndseed_64bit4 {
13439: my ($symb,$courseid,$domain,$username)=@_;
13440: {
13441: use integer;
13442: # strings need to be an even # of cahracters long, it it is odd the
13443: # last characters gets thrown away
13444: my $symbchck=unpack("%32S*",$symb.' ') << 21;
13445: my $symbseed=numval3($symb) << 10;
13446: my $namechck=unpack("%32S*",$username.' ');
13447:
13448: my $nameseed=numval3($username) << 21;
13449: my $domainseed=unpack("%32S*",$domain.' ') << 10;
13450: my $courseseed=unpack("%32S*",$courseid.' ');
13451:
13452: my $num1=$symbchck+$symbseed+$namechck;
13453: my $num2=$nameseed+$domainseed+$courseseed;
13454: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
13455: #&logthis("rndseed :$num1:$num2:$_64bit");
13456: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
13457:
13458: return "$num1:$num2";
13459: }
13460: }
13461:
13462: sub rndseed_64bit5 {
13463: my ($symb,$courseid,$domain,$username)=@_;
13464: my ($num1,$num2)=&digest("$symb,$courseid,$domain,$username");
13465: return "$num1:$num2";
13466: }
13467:
13468: sub rndseed_CODE_64bit {
13469: my ($symb,$courseid,$domain,$username)=@_;
13470: {
13471: use integer;
13472: my $symbchck=unpack("%32S*",$symb.' ') << 16;
13473: my $symbseed=numval2($symb);
13474: my $CODEchck=unpack("%32S*",&getCODE().' ') << 16;
13475: my $CODEseed=numval(&getCODE());
13476: my $courseseed=unpack("%32S*",$courseid.' ');
13477: my $num1=$symbseed+$CODEchck;
13478: my $num2=$CODEseed+$courseseed+$symbchck;
13479: #&logthis("$symbseed:$CODEchck|$CODEseed:$courseseed:$symbchck");
13480: #&logthis("rndseed :$num1:$num2:$symb");
13481: if ($_64bit) { $num1=(($num1<<32)>>32); }
13482: if ($_64bit) { $num2=(($num2<<32)>>32); }
13483: return "$num1:$num2";
13484: }
13485: }
13486:
13487: sub rndseed_CODE_64bit4 {
13488: my ($symb,$courseid,$domain,$username)=@_;
13489: {
13490: use integer;
13491: my $symbchck=unpack("%32S*",$symb.' ') << 16;
13492: my $symbseed=numval3($symb);
13493: my $CODEchck=unpack("%32S*",&getCODE().' ') << 16;
13494: my $CODEseed=numval3(&getCODE());
13495: my $courseseed=unpack("%32S*",$courseid.' ');
13496: my $num1=$symbseed+$CODEchck;
13497: my $num2=$CODEseed+$courseseed+$symbchck;
13498: #&logthis("$symbseed:$CODEchck|$CODEseed:$courseseed:$symbchck");
13499: #&logthis("rndseed :$num1:$num2:$symb");
13500: if ($_64bit) { $num1=(($num1<<32)>>32); }
13501: if ($_64bit) { $num2=(($num2<<32)>>32); }
13502: return "$num1:$num2";
13503: }
13504: }
13505:
13506: sub rndseed_CODE_64bit5 {
13507: my ($symb,$courseid,$domain,$username)=@_;
13508: my $code = &getCODE();
13509: my ($num1,$num2)=&digest("$symb,$courseid,$code");
13510: return "$num1:$num2";
13511: }
13512:
13513: sub setup_random_from_rndseed {
13514: my ($rndseed)=@_;
13515: if ($rndseed =~/([,:])/) {
13516: my ($num1,$num2) = map { abs($_); } (split(/[,:]/,$rndseed));
13517: if ((!$num1) || (!$num2) || ($num1 > 2147483562) || ($num2 > 2147483398)) {
13518: &Math::Random::random_set_seed_from_phrase($rndseed);
13519: } else {
13520: &Math::Random::random_set_seed($num1,$num2);
13521: }
13522: } else {
13523: &Math::Random::random_set_seed_from_phrase($rndseed);
13524: }
13525: }
13526:
13527: sub latest_receipt_algorithm_id {
13528: return 'receipt3';
13529: }
13530:
13531: sub recunique {
13532: my $fucourseid=shift;
13533: my $unique;
13534: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2' ||
13535: $env{"course.$fucourseid.receiptalg"} eq 'receipt3' ) {
13536: $unique=$env{"course.$fucourseid.internal.encseed"};
13537: } else {
13538: $unique=$perlvar{'lonReceipt'};
13539: }
13540: return unpack("%32C*",$unique);
13541: }
13542:
13543: sub recprefix {
13544: my $fucourseid=shift;
13545: my $prefix;
13546: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2'||
13547: $env{"course.$fucourseid.receiptalg"} eq 'receipt3' ) {
13548: $prefix=$env{"course.$fucourseid.internal.encpref"};
13549: } else {
13550: $prefix=$perlvar{'lonHostID'};
13551: }
13552: return unpack("%32C*",$prefix);
13553: }
13554:
13555: sub ireceipt {
13556: my ($funame,$fudom,$fucourseid,$fusymb,$part)=@_;
13557:
13558: my $return =&recprefix($fucourseid).'-';
13559:
13560: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt3' ||
13561: $env{'request.state'} eq 'construct') {
13562: $return .= (&digest("$funame,$fudom,$fucourseid,$fusymb,$part")%10000);
13563: return $return;
13564: }
13565:
13566: my $cuname=unpack("%32C*",$funame);
13567: my $cudom=unpack("%32C*",$fudom);
13568: my $cucourseid=unpack("%32C*",$fucourseid);
13569: my $cusymb=unpack("%32C*",$fusymb);
13570: my $cunique=&recunique($fucourseid);
13571: my $cpart=unpack("%32S*",$part);
13572: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2') {
13573:
13574: #&logthis("doing receipt2 using parts $cpart, uname $cuname and udom $cudom gets ".($cpart%$cuname)." and ".($cpart%$cudom));
13575:
13576: $return.= ($cunique%$cuname+
13577: $cunique%$cudom+
13578: $cusymb%$cuname+
13579: $cusymb%$cudom+
13580: $cucourseid%$cuname+
13581: $cucourseid%$cudom+
13582: $cpart%$cuname+
13583: $cpart%$cudom);
13584: } else {
13585: $return.= ($cunique%$cuname+
13586: $cunique%$cudom+
13587: $cusymb%$cuname+
13588: $cusymb%$cudom+
13589: $cucourseid%$cuname+
13590: $cucourseid%$cudom);
13591: }
13592: return $return;
13593: }
13594:
13595: sub receipt {
13596: my ($part)=@_;
13597: my ($symb,$courseid,$domain,$name) = &whichuser();
13598: return &ireceipt($name,$domain,$courseid,$symb,$part);
13599: }
13600:
13601: sub whichuser {
13602: my ($passedsymb)=@_;
13603: my ($symb,$courseid,$domain,$name,$publicuser);
13604: if (defined($env{'form.grade_symb'})) {
13605: my ($tmp_courseid)=&get_env_multiple('form.grade_courseid');
13606: my $allowed=&allowed('vgr',$tmp_courseid);
13607: if (!$allowed &&
13608: exists($env{'request.course.sec'}) &&
13609: $env{'request.course.sec'} !~ /^\s*$/) {
13610: $allowed=&allowed('vgr',$tmp_courseid.
13611: '/'.$env{'request.course.sec'});
13612: }
13613: if ($allowed) {
13614: ($symb)=&get_env_multiple('form.grade_symb');
13615: $courseid=$tmp_courseid;
13616: ($domain)=&get_env_multiple('form.grade_domain');
13617: ($name)=&get_env_multiple('form.grade_username');
13618: return ($symb,$courseid,$domain,$name,$publicuser);
13619: }
13620: }
13621: if (!$passedsymb) {
13622: $symb=&symbread();
13623: } else {
13624: $symb=$passedsymb;
13625: }
13626: $courseid=$env{'request.course.id'};
13627: $domain=$env{'user.domain'};
13628: $name=$env{'user.name'};
13629: if ($name eq 'public' && $domain eq 'public') {
13630: if (!defined($env{'form.username'})) {
13631: $env{'form.username'}.=time.rand(10000000);
13632: }
13633: $name.=$env{'form.username'};
13634: }
13635: return ($symb,$courseid,$domain,$name,$publicuser);
13636:
13637: }
13638:
13639: # ------------------------------------------------------------ Serves up a file
13640: # returns either the contents of the file or
13641: # -1 if the file doesn't exist
13642: #
13643: # if the target is a file that was uploaded via DOCS,
13644: # a check will be made to see if a current copy exists on the local server,
13645: # if it does this will be served, otherwise a copy will be retrieved from
13646: # the home server for the course and stored in /home/httpd/html/userfiles on
13647: # the local server.
13648:
13649: sub getfile {
13650: my ($file) = @_;
13651: if ($file =~ m -^/*(uploaded|editupload)/-) { $file=&filelocation("",$file); }
13652: &repcopy($file);
13653: return &readfile($file);
13654: }
13655:
13656: sub repcopy_userfile {
13657: my ($file)=@_;
13658: my $londocroot = $perlvar{'lonDocRoot'};
13659: if ($file =~ m{^/*(uploaded|editupload)/}) { $file=&filelocation("",$file); }
13660: if ($file =~ m{^\Q/home/httpd/lonUsers/\E}) { return 'ok'; }
13661: my ($cdom,$cnum,$filename) =
13662: ($file=~m|^\Q$perlvar{'lonDocRoot'}\E/+userfiles/+($match_domain)/+($match_name)/+(.*)|);
13663: my $uri="/uploaded/$cdom/$cnum/$filename";
13664: if (-e "$file") {
13665: # we already have a local copy, check it out
13666: my @fileinfo = stat($file);
13667: my $rtncode;
13668: my $info;
13669: my $lwpresp = &getuploaded('HEAD',$uri,$cdom,$cnum,\$info,\$rtncode);
13670: if ($lwpresp ne 'ok') {
13671: # there is no such file anymore, even though we had a local copy
13672: if ($rtncode eq '404') {
13673: unlink($file);
13674: }
13675: return -1;
13676: }
13677: if ($info < $fileinfo[9]) {
13678: # nice, the file we have is up-to-date, just say okay
13679: return 'ok';
13680: } else {
13681: # the file is outdated, get rid of it
13682: unlink($file);
13683: }
13684: }
13685: # one way or the other, at this point, we don't have the file
13686: # construct the correct path for the file
13687: my @parts = ($cdom,$cnum);
13688: if ($filename =~ m|^(.+)/[^/]+$|) {
13689: push @parts, split(/\//,$1);
13690: }
13691: my $path = $perlvar{'lonDocRoot'}.'/userfiles';
13692: foreach my $part (@parts) {
13693: $path .= '/'.$part;
13694: if (!-e $path) {
13695: mkdir($path,0770);
13696: }
13697: }
13698: # now the path exists for sure
13699: # get a user agent
13700: my $transferfile=$file.'.in.transfer';
13701: # FIXME: this should flock
13702: if (-e $transferfile) { return 'ok'; }
13703: my $request;
13704: $uri=~s/^\///;
13705: my $homeserver = &homeserver($cnum,$cdom);
13706: my $hostname = &hostname($homeserver);
13707: my $protocol = $protocol{$homeserver};
13708: $protocol = 'http' if ($protocol ne 'https');
13709: $request=new HTTP::Request('GET',$protocol.'://'.$hostname.'/raw/'.$uri);
13710: my $response = &LONCAPA::LWPReq::makerequest($homeserver,$request,$transferfile,\%perlvar,'',0,1);
13711: # did it work?
13712: if ($response->is_error()) {
13713: unlink($transferfile);
13714: &logthis("Userfile repcopy failed for $uri");
13715: return -1;
13716: }
13717: # worked, rename the transfer file
13718: rename($transferfile,$file);
13719: return 'ok';
13720: }
13721:
13722: sub tokenwrapper {
13723: my $uri=shift;
13724: $uri=~s|^https?\://([^/]+)||;
13725: $uri=~s|^/||;
13726: $env{'user.environment'}=~/\/([^\/]+)\.id/;
13727: my $token=$1;
13728: my (undef,$udom,$uname,$file)=split('/',$uri,4);
13729: if ($udom && $uname && $file) {
13730: $file=~s|(\?\.*)*$||;
13731: &appenv({"userfile.$udom/$uname/$file" => $env{'request.course.id'}});
13732: my $homeserver = &homeserver($uname,$udom);
13733: my $hostname = &hostname($homeserver);
13734: my $protocol = $protocol{$homeserver};
13735: $protocol = 'http' if ($protocol ne 'https');
13736: return $protocol.'://'.$hostname.'/'.$uri.
13737: (($uri=~/\?/)?'&':'?').'token='.$token.
13738: '&tokenissued='.$perlvar{'lonHostID'};
13739: } else {
13740: return '/adm/notfound.html';
13741: }
13742: }
13743:
13744: # call with reqtype HEAD: get last modification time
13745: # call with reqtype GET: get the file contents
13746: # Do not call this with reqtype GET for large files! It loads everything into memory
13747: #
13748: sub getuploaded {
13749: my ($reqtype,$uri,$cdom,$cnum,$info,$rtncode) = @_;
13750: $uri=~s/^\///;
13751: my $homeserver = &homeserver($cnum,$cdom);
13752: my $hostname = &hostname($homeserver);
13753: my $protocol = $protocol{$homeserver};
13754: $protocol = 'http' if ($protocol ne 'https');
13755: $uri = $protocol.'://'.$hostname.'/raw/'.$uri;
13756: my $request=new HTTP::Request($reqtype,$uri);
13757: my $response=&LONCAPA::LWPReq::makerequest($homeserver,$request,'',\%perlvar,'',0,1);
13758: $$rtncode = $response->code;
13759: if (! $response->is_success()) {
13760: return 'failed';
13761: }
13762: if ($reqtype eq 'HEAD') {
13763: $$info = &HTTP::Date::str2time( $response->header('Last-modified') );
13764: } elsif ($reqtype eq 'GET') {
13765: $$info = $response->content;
13766: }
13767: return 'ok';
13768: }
13769:
13770: sub readfile {
13771: my $file = shift;
13772: if ( (! -e $file ) || ($file eq '') ) { return -1; };
13773: my $fh;
13774: open($fh,"<",$file);
13775: my $a='';
13776: while (my $line = <$fh>) { $a .= $line; }
13777: return $a;
13778: }
13779:
13780: sub filelocation {
13781: my ($dir,$file) = @_;
13782: my $location;
13783: $file=~ s/^\s*(\S+)\s*$/$1/; ## strip off leading and trailing spaces
13784:
13785: if ($file =~ m-^/adm/-) {
13786: $file=~s-^/adm/wrapper/-/-;
13787: $file=~s-^/adm/coursedocs/showdoc/-/-;
13788: }
13789:
13790: if ($file =~ m-^\Q$Apache::lonnet::perlvar{'lonTabDir'}\E/-) {
13791: $location = $file;
13792: } elsif ($file=~/^\/*(uploaded|editupload)/) { # is an uploaded file
13793: my ($udom,$uname,$filename)=
13794: ($file=~m -^/+(?:uploaded|editupload)/+($match_domain)/+($match_name)/+(.*)$-);
13795: my $home=&homeserver($uname,$udom);
13796: my $is_me=0;
13797: my @ids=¤t_machine_ids();
13798: foreach my $id (@ids) { if ($id eq $home) { $is_me=1; } }
13799: if ($is_me) {
13800: $location=propath($udom,$uname).'/userfiles/'.$filename;
13801: } else {
13802: $location=$Apache::lonnet::perlvar{'lonDocRoot'}.'/userfiles/'.
13803: $udom.'/'.$uname.'/'.$filename;
13804: }
13805: } elsif ($file =~ m-^/adm/-) {
13806: $location = $perlvar{'lonDocRoot'}.'/'.$file;
13807: } else {
13808: $file=~s/^\Q$perlvar{'lonDocRoot'}\E//;
13809: $file=~s:^/(res|priv)/:/:;
13810: my $space=$1;
13811: if ( !( $file =~ m:^/:) ) {
13812: $location = $dir. '/'.$file;
13813: } else {
13814: $location = $perlvar{'lonDocRoot'}.'/'.$space.$file;
13815: }
13816: }
13817: $location=~s://+:/:g; # remove duplicate /
13818: while ($location=~m{/\.\./}) {
13819: if ($location =~ m{/[^/]+/\.\./}) {
13820: $location=~ s{/[^/]+/\.\./}{/}g;
13821: } else {
13822: $location=~ s{/\.\./}{/}g;
13823: }
13824: } #remove dir/..
13825: while ($location=~m:/\./:) {$location=~ s:/\./:/:g;} #remove /./
13826: return $location;
13827: }
13828:
13829: sub hreflocation {
13830: my ($dir,$file)=@_;
13831: unless (($file=~m-^https?\://-i) || ($file=~m-^/-)) {
13832: $file=filelocation($dir,$file);
13833: } elsif ($file=~m-^/adm/-) {
13834: $file=~s-^/adm/wrapper/-/-;
13835: $file=~s-^/adm/coursedocs/showdoc/-/-;
13836: }
13837: if ($file=~m-^\Q$perlvar{'lonDocRoot'}\E-) {
13838: $file=~s-^\Q$perlvar{'lonDocRoot'}\E--;
13839: } elsif ($file=~m-^\Q$perlvar{'lonUsersDir'}\E-) {
13840: $file=~s{^/home/httpd/lonUsers/($match_domain)/./././($match_name)/userfiles/}
13841: {/uploaded/$1/$2/}x;
13842: }
13843: if ($file=~ m{^/userfiles/}) {
13844: $file =~ s{^/userfiles/}{/uploaded/};
13845: }
13846: return $file;
13847: }
13848:
13849:
13850:
13851:
13852:
13853: sub current_machine_domains {
13854: return &machine_domains(&hostname($perlvar{'lonHostID'}));
13855: }
13856:
13857: sub machine_domains {
13858: my ($hostname) = @_;
13859: my @domains;
13860: my %hostname = &all_hostnames();
13861: while( my($id, $name) = each(%hostname)) {
13862: # &logthis("-$id-$name-$hostname-");
13863: if ($hostname eq $name) {
13864: push(@domains,&host_domain($id));
13865: }
13866: }
13867: return @domains;
13868: }
13869:
13870: sub current_machine_ids {
13871: return &machine_ids(&hostname($perlvar{'lonHostID'}));
13872: }
13873:
13874: sub machine_ids {
13875: my ($hostname) = @_;
13876: $hostname ||= &hostname($perlvar{'lonHostID'});
13877: my @ids;
13878: my %name_to_host = &all_names();
13879: if (ref($name_to_host{$hostname}) eq 'ARRAY') {
13880: return @{ $name_to_host{$hostname} };
13881: }
13882: return;
13883: }
13884:
13885: sub additional_machine_domains {
13886: my @domains;
13887: open(my $fh,"<","$perlvar{'lonTabDir'}/expected_domains.tab");
13888: while( my $line = <$fh>) {
13889: $line =~ s/\s//g;
13890: push(@domains,$line);
13891: }
13892: return @domains;
13893: }
13894:
13895: sub default_login_domain {
13896: my $domain = $perlvar{'lonDefDomain'};
13897: my $testdomain=(split(/\./,$ENV{'HTTP_HOST'}))[0];
13898: foreach my $posdom (¤t_machine_domains(),
13899: &additional_machine_domains()) {
13900: if (lc($posdom) eq lc($testdomain)) {
13901: $domain=$posdom;
13902: last;
13903: }
13904: }
13905: return $domain;
13906: }
13907:
13908: sub uses_sts {
13909: my ($ignore_cache) = @_;
13910: my $lonhost = $perlvar{'lonHostID'};
13911: my $hostname = &hostname($lonhost);
13912: my $sts_on;
13913: if ($protocol{$lonhost} eq 'https') {
13914: my $cachetime = 12*3600;
13915: if (!$ignore_cache) {
13916: ($sts_on,my $cached)=&is_cached_new('stspolicy',$lonhost);
13917: if (defined($cached)) {
13918: return $sts_on;
13919: }
13920: }
13921: my $url = $protocol{$lonhost}.'://'.$hostname.'/index.html';
13922: my $request=new HTTP::Request('HEAD',$url);
13923: my $response=&LONCAPA::LWPReq::makerequest($lonhost,$request,'',\%perlvar,'','','',1);
13924: if ($response->is_success) {
13925: my $has_sts = $response->header('Strict-Transport-Security');
13926: if ($has_sts eq '') {
13927: $sts_on = 0;
13928: } else {
13929: if ($has_sts =~ /\Qmax-age=\E(\d+)/) {
13930: my $maxage = $1;
13931: if ($maxage) {
13932: $sts_on = 1;
13933: } else {
13934: $sts_on = 0;
13935: }
13936: } else {
13937: $sts_on = 0;
13938: }
13939: }
13940: return &do_cache_new('stspolicy',$lonhost,$sts_on,$cachetime);
13941: }
13942: }
13943: return;
13944: }
13945:
13946: # ------------------------------------------------------------- Declutters URLs
13947:
13948: sub declutter {
13949: my $thisfn=shift;
13950: if ($thisfn=~m|^/enc/|) { $thisfn=&Apache::lonenc::unencrypted($thisfn); }
13951: unless ($thisfn=~m{^/home/httpd/html/priv/}) {
13952: $thisfn=~s{^/home/httpd/html}{};
13953: }
13954: $thisfn=~s/^\///;
13955: $thisfn=~s|^adm/wrapper/||;
13956: $thisfn=~s|^adm/coursedocs/showdoc/||;
13957: $thisfn=~s/^res\///;
13958: $thisfn=~s/^priv\///;
13959: unless (($thisfn =~ /^ext/) || ($thisfn =~ /\.(page|sequence)___\d+___ext/)) {
13960: $thisfn=~s/\?.+$//;
13961: }
13962: return $thisfn;
13963: }
13964:
13965: # ------------------------------------------------------------- Clutter up URLs
13966:
13967: sub clutter {
13968: my $thisfn='/'.&declutter(shift);
13969: if ($thisfn !~ m{^/(uploaded|editupload|adm|userfiles|ext|raw|priv|public)/}
13970: || $thisfn =~ m{^/adm/(includes|pages)} ) {
13971: $thisfn='/res'.$thisfn;
13972: }
13973: if ($thisfn !~m|^/adm|) {
13974: if ($thisfn =~ m|^/ext/|) {
13975: $thisfn='/adm/wrapper'.$thisfn;
13976: } else {
13977: my ($ext) = ($thisfn =~ /\.(\w+)$/);
13978: my $embstyle=&Apache::loncommon::fileembstyle($ext);
13979: if ($embstyle eq 'ssi'
13980: || ($embstyle eq 'hdn')
13981: || ($embstyle eq 'rat')
13982: || ($embstyle eq 'prv')
13983: || ($embstyle eq 'ign')) {
13984: #do nothing with these
13985: } elsif (($embstyle eq 'img')
13986: || ($embstyle eq 'emb')
13987: || ($embstyle eq 'wrp')) {
13988: $thisfn='/adm/wrapper'.$thisfn;
13989: } elsif ($embstyle eq 'unk'
13990: && $thisfn!~/\.(sequence|page)$/) {
13991: $thisfn='/adm/coursedocs/showdoc'.$thisfn;
13992: } else {
13993: # &logthis("Got a blank emb style");
13994: }
13995: }
13996: } elsif ($thisfn =~ m{^/adm/$match_domain/$match_courseid/\d+/ext\.tool$}) {
13997: $thisfn='/adm/wrapper'.$thisfn;
13998: }
13999: return $thisfn;
14000: }
14001:
14002: sub clutter_with_no_wrapper {
14003: my $uri = &clutter(shift);
14004: if ($uri =~ m-^/adm/-) {
14005: $uri =~ s-^/adm/wrapper/-/-;
14006: $uri =~ s-^/adm/coursedocs/showdoc/-/-;
14007: }
14008: return $uri;
14009: }
14010:
14011: sub freeze_escape {
14012: my ($value)=@_;
14013: if (ref($value)) {
14014: $value=&nfreeze($value);
14015: return '__FROZEN__'.&escape($value);
14016: }
14017: return &escape($value);
14018: }
14019:
14020:
14021: sub thaw_unescape {
14022: my ($value)=@_;
14023: if ($value =~ /^__FROZEN__/) {
14024: substr($value,0,10,undef);
14025: $value=&unescape($value);
14026: return &thaw($value);
14027: }
14028: return &unescape($value);
14029: }
14030:
14031: sub correct_line_ends {
14032: my ($result)=@_;
14033: $$result =~s/\r\n/\n/mg;
14034: $$result =~s/\r/\n/mg;
14035: }
14036: # ================================================================ Main Program
14037:
14038: sub goodbye {
14039: &logthis("Starting Shut down");
14040: #not converted to using infrastruture and probably shouldn't be
14041: &logthis(sprintf("%-20s is %s",'%badServerCache',length(&nfreeze(\%badServerCache))));
14042: #converted
14043: # &logthis(sprintf("%-20s is %s",'%metacache',scalar(%metacache)));
14044: &logthis(sprintf("%-20s is %s",'%homecache',length(&nfreeze(\%homecache))));
14045: # &logthis(sprintf("%-20s is %s",'%titlecache',length(&nfreeze(\%titlecache))));
14046: # &logthis(sprintf("%-20s is %s",'%courseresdatacache',length(&nfreeze(\%courseresdatacache))));
14047: #1.1 only
14048: # &logthis(sprintf("%-20s is %s",'%userresdatacache',length(&nfreeze(\%userresdatacache))));
14049: # &logthis(sprintf("%-20s is %s",'%getsectioncache',length(&nfreeze(\%getsectioncache))));
14050: # &logthis(sprintf("%-20s is %s",'%courseresversioncache',length(&nfreeze(\%courseresversioncache))));
14051: # &logthis(sprintf("%-20s is %s",'%resversioncache',length(&nfreeze(\%resversioncache))));
14052: &logthis(sprintf("%-20s is %s",'%remembered',length(&nfreeze(\%remembered))));
14053: &logthis(sprintf("%-20s is %s",'kicks',$kicks));
14054: &logthis(sprintf("%-20s is %s",'hits',$hits));
14055: &flushcourselogs();
14056: &logthis("Shutting down");
14057: }
14058:
14059: sub get_dns {
14060: my ($url,$func,$ignore_cache,$nocache,$hashref) = @_;
14061: if (!$ignore_cache) {
14062: my ($content,$cached)=
14063: &Apache::lonnet::is_cached_new('dns',$url);
14064: if ($cached) {
14065: &$func($content,$hashref);
14066: return;
14067: }
14068: }
14069:
14070: my %alldns;
14071: if (open(my $config,"<","$perlvar{'lonTabDir'}/hosts.tab")) {
14072: foreach my $dns (<$config>) {
14073: next if ($dns !~ /^\^(\S*)/x);
14074: my $line = $1;
14075: my ($host,$protocol) = split(/:/,$line);
14076: if ($protocol ne 'https') {
14077: $protocol = 'http';
14078: }
14079: $alldns{$host} = $protocol;
14080: }
14081: close($config);
14082: }
14083: while (%alldns) {
14084: my ($dns) = sort { $b cmp $a } keys(%alldns);
14085: my $request=new HTTP::Request('GET',"$alldns{$dns}://$dns$url");
14086: my $response = &LONCAPA::LWPReq::makerequest('',$request,'',\%perlvar,30,0);
14087: delete($alldns{$dns});
14088: next if ($response->is_error());
14089: if ($url eq '/adm/dns/loncapaCRL') {
14090: return &$func($response);
14091: } else {
14092: my @content = split("\n",$response->content);
14093: unless ($nocache) {
14094: &do_cache_new('dns',$url,\@content,30*24*60*60);
14095: }
14096: &$func(\@content,$hashref);
14097: return;
14098: }
14099: }
14100: my $which = (split('/',$url,4))[3];
14101: if ($which eq 'loncapaCRL') {
14102: my $diskfile = "$perlvar{'lonCertificateDirectory'}/$perlvar{'lonnetCertRevocationList'}";
14103: if (-e $diskfile) {
14104: &logthis("unable to contact DNS, on disk file $diskfile not updated");
14105: } else {
14106: &logthis("unable to contact DNS, no on disk file $diskfile available");
14107: }
14108: } else {
14109: &logthis("unable to contact DNS defaulting to on disk file dns_$which.tab\n");
14110: if (open(my $config,"<","$perlvar{'lonTabDir'}/dns_$which.tab")) {
14111: my @content = <$config>;
14112: close($config);
14113: &$func(\@content,$hashref);
14114: }
14115: }
14116: return;
14117: }
14118:
14119: # ------------------------------------------------------Get DNS checksums file
14120: sub parse_dns_checksums_tab {
14121: my ($lines,$hashref) = @_;
14122: my $lonhost = $perlvar{'lonHostID'};
14123: my $machine_dom = &Apache::lonnet::host_domain($lonhost);
14124: my $loncaparev = &get_server_loncaparev($machine_dom);
14125: my $distro = (split(/\:/,&get_server_distarch($lonhost)))[0];
14126: my $webconfdir = '/etc/httpd/conf';
14127: if ($distro =~ /^(ubuntu|debian)(\d+)$/) {
14128: $webconfdir = '/etc/apache2';
14129: } elsif ($distro =~ /^sles(\d+)$/) {
14130: if ($1 >= 10) {
14131: $webconfdir = '/etc/apache2';
14132: }
14133: } elsif ($distro =~ /^suse(\d+\.\d+)$/) {
14134: if ($1 >= 10.0) {
14135: $webconfdir = '/etc/apache2';
14136: }
14137: }
14138: my ($release,$timestamp) = split(/\-/,$loncaparev);
14139: my (%chksum,%revnum);
14140: if (ref($lines) eq 'ARRAY') {
14141: chomp(@{$lines});
14142: my $version = shift(@{$lines});
14143: if ($version eq $release) {
14144: foreach my $line (@{$lines}) {
14145: my ($file,$version,$shasum) = split(/,/,$line);
14146: if ($file =~ m{^/etc/httpd/conf}) {
14147: if ($webconfdir eq '/etc/apache2') {
14148: $file =~ s{^\Q/etc/httpd/conf/\E}{$webconfdir/};
14149: }
14150: }
14151: $chksum{$file} = $shasum;
14152: $revnum{$file} = $version;
14153: }
14154: if (ref($hashref) eq 'HASH') {
14155: %{$hashref} = (
14156: sums => \%chksum,
14157: versions => \%revnum,
14158: );
14159: }
14160: }
14161: }
14162: return;
14163: }
14164:
14165: sub fetch_dns_checksums {
14166: my %checksums;
14167: my $machine_dom = &Apache::lonnet::host_domain($perlvar{'lonHostID'});
14168: my $loncaparev = &get_server_loncaparev($machine_dom,$perlvar{'lonHostID'});
14169: my ($release,$timestamp) = split(/\-/,$loncaparev);
14170: &get_dns("/adm/dns/checksums/$release",\&parse_dns_checksums_tab,1,1,
14171: \%checksums);
14172: return \%checksums;
14173: }
14174:
14175: sub fetch_crl_pemfile {
14176: return &get_dns("/adm/dns/loncapaCRL",\&save_crl_pem,1,1);
14177: }
14178:
14179: sub save_crl_pem {
14180: my ($response) = @_;
14181: my ($msg,$hadchanges);
14182: if (ref($response)) {
14183: my $now = time;
14184: my $lonca = $perlvar{'lonCertificateDirectory'}.'/'.$perlvar{'lonnetCertificateAuthority'};
14185: my $tmpcrl = $tmpdir.'/'.$perlvar{'lonnetCertRevocationList'}.'_'.$now.'.'.$$.'.tmp';
14186: if (open(my $fh,'>',"$tmpcrl")) {
14187: print $fh $response->content;
14188: close($fh);
14189: if (-e $lonca) {
14190: if (open(PIPE,"openssl crl -in $tmpcrl -inform pem -CAfile $lonca -noout 2>&1 |")) {
14191: my $check = <PIPE>;
14192: close(PIPE);
14193: chomp($check);
14194: if ($check eq 'verify OK') {
14195: my $dest = "$perlvar{'lonCertificateDirectory'}/$perlvar{'lonnetCertRevocationList'}";
14196: my $backup;
14197: if (-e $dest) {
14198: if (&File::Copy::move($dest,"$dest.bak")) {
14199: $backup = 'ok';
14200: }
14201: }
14202: if (&File::Copy::move($tmpcrl,$dest)) {
14203: $msg = 'ok';
14204: if ($backup) {
14205: my (%oldnums,%newnums);
14206: if (open(PIPE, "openssl crl -inform PEM -text -noout -in $dest.bak |grep 'Serial Number' |")) {
14207: while (<PIPE>) {
14208: $oldnums{(split(/:/))[1]} = 1;
14209: }
14210: close(PIPE);
14211: }
14212: if (open(PIPE, "openssl crl -inform PEM -text -noout -in $dest |grep 'Serial Number' |")) {
14213: while(<PIPE>) {
14214: $newnums{(split(/:/))[1]} = 1;
14215: }
14216: close(PIPE);
14217: }
14218: foreach my $key (sort {$b <=> $a } (keys(%newnums))) {
14219: unless (exists($oldnums{$key})) {
14220: $hadchanges = 1;
14221: last;
14222: }
14223: }
14224: unless ($hadchanges) {
14225: foreach my $key (sort {$b <=> $a } (keys(%oldnums))) {
14226: unless (exists($newnums{$key})) {
14227: $hadchanges = 1;
14228: last;
14229: }
14230: }
14231: }
14232: }
14233: }
14234: } else {
14235: unlink($tmpcrl);
14236: }
14237: } else {
14238: unlink($tmpcrl);
14239: }
14240: } else {
14241: unlink($tmpcrl);
14242: }
14243: }
14244: }
14245: return ($msg,$hadchanges);
14246: }
14247:
14248: # ------------------------------------------------------------ Read domain file
14249: {
14250: my $loaded;
14251: my %domain;
14252:
14253: sub parse_domain_tab {
14254: my ($lines) = @_;
14255: foreach my $line (@$lines) {
14256: next if ($line =~ /^(\#|\s*$ )/x);
14257:
14258: chomp($line);
14259: my ($name,@elements) = split(/:/,$line,9);
14260: my %this_domain;
14261: foreach my $field ('description', 'auth_def', 'auth_arg_def',
14262: 'lang_def', 'city', 'longi', 'lati',
14263: 'primary') {
14264: $this_domain{$field} = shift(@elements);
14265: }
14266: $domain{$name} = \%this_domain;
14267: }
14268: }
14269:
14270: sub reset_domain_info {
14271: undef($loaded);
14272: undef(%domain);
14273: }
14274:
14275: sub load_domain_tab {
14276: my ($ignore_cache,$nocache) = @_;
14277: &get_dns('/adm/dns/domain',\&parse_domain_tab,$ignore_cache,$nocache);
14278: my $fh;
14279: if (open($fh,"<",$perlvar{'lonTabDir'}.'/domain.tab')) {
14280: my @lines = <$fh>;
14281: &parse_domain_tab(\@lines);
14282: }
14283: close($fh);
14284: $loaded = 1;
14285: }
14286:
14287: sub domain {
14288: &load_domain_tab() if (!$loaded);
14289:
14290: my ($name,$what) = @_;
14291: return if ( !exists($domain{$name}) );
14292:
14293: if (!$what) {
14294: return $domain{$name}{'description'};
14295: }
14296: return $domain{$name}{$what};
14297: }
14298:
14299: sub domain_info {
14300: &load_domain_tab() if (!$loaded);
14301: return %domain;
14302: }
14303:
14304: }
14305:
14306:
14307: # ------------------------------------------------------------- Read hosts file
14308: {
14309: my %hostname;
14310: my %hostdom;
14311: my %libserv;
14312: my $loaded;
14313: my %name_to_host;
14314: my %internetdom;
14315: my %LC_dns_serv;
14316:
14317: sub parse_hosts_tab {
14318: my ($file) = @_;
14319: foreach my $configline (@$file) {
14320: next if ($configline =~ /^(\#|\s*$ )/x);
14321: chomp($configline);
14322: if ($configline =~ /^\^/) {
14323: if ($configline =~ /^\^([\w.\-]+)/) {
14324: $LC_dns_serv{$1} = 1;
14325: }
14326: next;
14327: }
14328: my ($id,$domain,$role,$name,$protocol,$intdom)=split(/:/,$configline);
14329: $name=~s/\s//g;
14330: if ($id && $domain && $role && $name) {
14331: if ((exists($hostname{$id})) && ($hostname{$id} ne '')) {
14332: my $curr = $hostname{$id};
14333: my $skip;
14334: if (ref($name_to_host{$curr}) eq 'ARRAY') {
14335: if (($curr eq $name) && (@{$name_to_host{$curr}} == 1)) {
14336: $skip = 1;
14337: } else {
14338: @{$name_to_host{$curr}} = grep { $_ ne $id } @{$name_to_host{$curr}};
14339: }
14340: }
14341: unless ($skip) {
14342: push(@{$name_to_host{$name}},$id);
14343: }
14344: } else {
14345: push(@{$name_to_host{$name}},$id);
14346: }
14347: $hostname{$id}=$name;
14348: $hostdom{$id}=$domain;
14349: if ($role eq 'library') { $libserv{$id}=$name; }
14350: if (defined($protocol)) {
14351: if ($protocol eq 'https') {
14352: $protocol{$id} = $protocol;
14353: } else {
14354: $protocol{$id} = 'http';
14355: }
14356: } else {
14357: $protocol{$id} = 'http';
14358: }
14359: if (defined($intdom)) {
14360: $internetdom{$id} = $intdom;
14361: }
14362: }
14363: }
14364: }
14365:
14366: sub reset_hosts_info {
14367: &purge_remembered();
14368: &reset_domain_info();
14369: &reset_hosts_ip_info();
14370: undef(%internetdom);
14371: undef(%name_to_host);
14372: undef(%hostname);
14373: undef(%hostdom);
14374: undef(%libserv);
14375: undef($loaded);
14376: }
14377:
14378: sub load_hosts_tab {
14379: my ($ignore_cache,$nocache) = @_;
14380: &get_dns('/adm/dns/hosts',\&parse_hosts_tab,$ignore_cache,$nocache);
14381: open(my $config,"<","$perlvar{'lonTabDir'}/hosts.tab");
14382: my @config = <$config>;
14383: &parse_hosts_tab(\@config);
14384: close($config);
14385: $loaded=1;
14386: }
14387:
14388: sub hostname {
14389: &load_hosts_tab() if (!$loaded);
14390:
14391: my ($lonid) = @_;
14392: return $hostname{$lonid};
14393: }
14394:
14395: sub all_hostnames {
14396: &load_hosts_tab() if (!$loaded);
14397:
14398: return %hostname;
14399: }
14400:
14401: sub all_names {
14402: my ($ignore_cache,$nocache) = @_;
14403: &load_hosts_tab($ignore_cache,$nocache) if (!$loaded);
14404:
14405: return %name_to_host;
14406: }
14407:
14408: sub all_host_domain {
14409: &load_hosts_tab() if (!$loaded);
14410: return %hostdom;
14411: }
14412:
14413: sub all_host_intdom {
14414: &load_hosts_tab() if (!$loaded);
14415: return %internetdom;
14416: }
14417:
14418: sub is_library {
14419: &load_hosts_tab() if (!$loaded);
14420:
14421: return exists($libserv{$_[0]});
14422: }
14423:
14424: sub all_library {
14425: &load_hosts_tab() if (!$loaded);
14426:
14427: return %libserv;
14428: }
14429:
14430: sub unique_library {
14431: #2x reverse removes all hostnames that appear more than once
14432: my %unique = reverse &all_library();
14433: return reverse %unique;
14434: }
14435:
14436: sub get_servers {
14437: &load_hosts_tab() if (!$loaded);
14438:
14439: my ($domain,$type) = @_;
14440: my %possible_hosts = ($type eq 'library') ? %libserv
14441: : %hostname;
14442: my %result;
14443: if (ref($domain) eq 'ARRAY') {
14444: while ( my ($host,$hostname) = each(%possible_hosts)) {
14445: if (grep(/^\Q$hostdom{$host}\E$/,@$domain)) {
14446: $result{$host} = $hostname;
14447: }
14448: }
14449: } else {
14450: while ( my ($host,$hostname) = each(%possible_hosts)) {
14451: if ($hostdom{$host} eq $domain) {
14452: $result{$host} = $hostname;
14453: }
14454: }
14455: }
14456: return %result;
14457: }
14458:
14459: sub get_unique_servers {
14460: my %unique = reverse &get_servers(@_);
14461: return reverse %unique;
14462: }
14463:
14464: sub host_domain {
14465: &load_hosts_tab() if (!$loaded);
14466:
14467: my ($lonid) = @_;
14468: return $hostdom{$lonid};
14469: }
14470:
14471: sub all_domains {
14472: &load_hosts_tab() if (!$loaded);
14473:
14474: my %seen;
14475: my @uniq = grep(!$seen{$_}++, values(%hostdom));
14476: return @uniq;
14477: }
14478:
14479: sub internet_dom {
14480: &load_hosts_tab() if (!$loaded);
14481:
14482: my ($lonid) = @_;
14483: return $internetdom{$lonid};
14484: }
14485:
14486: sub is_LC_dns {
14487: &load_hosts_tab() if (!$loaded);
14488:
14489: my ($hostname) = @_;
14490: return exists($LC_dns_serv{$hostname});
14491: }
14492:
14493: }
14494:
14495: {
14496: my %iphost;
14497: my %name_to_ip;
14498: my %lonid_to_ip;
14499:
14500: sub get_hosts_from_ip {
14501: my ($ip) = @_;
14502: my %iphosts = &get_iphost();
14503: if (ref($iphosts{$ip})) {
14504: return @{$iphosts{$ip}};
14505: }
14506: return;
14507: }
14508:
14509: sub reset_hosts_ip_info {
14510: undef(%iphost);
14511: undef(%name_to_ip);
14512: undef(%lonid_to_ip);
14513: }
14514:
14515: sub get_host_ip {
14516: my ($lonid) = @_;
14517: if (exists($lonid_to_ip{$lonid})) {
14518: return $lonid_to_ip{$lonid};
14519: }
14520: my $name=&hostname($lonid);
14521: my $ip = gethostbyname($name);
14522: return if (!$ip || length($ip) ne 4);
14523: $ip=inet_ntoa($ip);
14524: $name_to_ip{$name} = $ip;
14525: $lonid_to_ip{$lonid} = $ip;
14526: return $ip;
14527: }
14528:
14529: sub get_iphost {
14530: my ($ignore_cache,$nocache) = @_;
14531:
14532: if (!$ignore_cache) {
14533: if (%iphost) {
14534: return %iphost;
14535: }
14536: my ($ip_info,$cached)=
14537: &Apache::lonnet::is_cached_new('iphost','iphost');
14538: if ($cached) {
14539: %iphost = %{$ip_info->[0]};
14540: %name_to_ip = %{$ip_info->[1]};
14541: %lonid_to_ip = %{$ip_info->[2]};
14542: return %iphost;
14543: }
14544: }
14545:
14546: # get yesterday's info for fallback
14547: my %old_name_to_ip;
14548: my ($ip_info,$cached)=
14549: &Apache::lonnet::is_cached_new('iphost','iphost');
14550: if ($cached) {
14551: %old_name_to_ip = %{$ip_info->[1]};
14552: }
14553:
14554: my %name_to_host = &all_names($ignore_cache,$nocache);
14555: foreach my $name (keys(%name_to_host)) {
14556: my $ip;
14557: if (!exists($name_to_ip{$name})) {
14558: $ip = gethostbyname($name);
14559: if (!$ip || length($ip) ne 4) {
14560: if (defined($old_name_to_ip{$name})) {
14561: $ip = $old_name_to_ip{$name};
14562: &logthis("Can't find $name defaulting to old $ip");
14563: } else {
14564: &logthis("Name $name no IP found");
14565: next;
14566: }
14567: } else {
14568: $ip=inet_ntoa($ip);
14569: }
14570: $name_to_ip{$name} = $ip;
14571: } else {
14572: $ip = $name_to_ip{$name};
14573: }
14574: foreach my $id (@{ $name_to_host{$name} }) {
14575: $lonid_to_ip{$id} = $ip;
14576: }
14577: push(@{$iphost{$ip}},@{$name_to_host{$name}});
14578: }
14579: unless ($nocache) {
14580: &do_cache_new('iphost','iphost',
14581: [\%iphost,\%name_to_ip,\%lonid_to_ip],
14582: 48*60*60);
14583: }
14584:
14585: return %iphost;
14586: }
14587:
14588: #
14589: # Given a DNS returns the loncapa host name for that DNS
14590: #
14591: sub host_from_dns {
14592: my ($dns) = @_;
14593: my @hosts;
14594: my $ip;
14595:
14596: if (exists($name_to_ip{$dns})) {
14597: $ip = $name_to_ip{$dns};
14598: }
14599: if (!$ip) {
14600: $ip = gethostbyname($dns); # Initial translation to IP is in net order.
14601: if (length($ip) == 4) {
14602: $ip = &IO::Socket::inet_ntoa($ip);
14603: }
14604: }
14605: if ($ip) {
14606: @hosts = get_hosts_from_ip($ip);
14607: return $hosts[0];
14608: }
14609: return undef;
14610: }
14611:
14612: sub get_internet_names {
14613: my ($lonid) = @_;
14614: return if ($lonid eq '');
14615: my ($idnref,$cached)=
14616: &Apache::lonnet::is_cached_new('internetnames',$lonid);
14617: if ($cached) {
14618: return $idnref;
14619: }
14620: my $ip = &get_host_ip($lonid);
14621: my @hosts = &get_hosts_from_ip($ip);
14622: my %iphost = &get_iphost();
14623: my (@idns,%seen);
14624: foreach my $id (@hosts) {
14625: my $dom = &host_domain($id);
14626: my $prim_id = &domain($dom,'primary');
14627: my $prim_ip = &get_host_ip($prim_id);
14628: next if ($seen{$prim_ip});
14629: if (ref($iphost{$prim_ip}) eq 'ARRAY') {
14630: foreach my $id (@{$iphost{$prim_ip}}) {
14631: my $intdom = &internet_dom($id);
14632: unless (grep(/^\Q$intdom\E$/,@idns)) {
14633: push(@idns,$intdom);
14634: }
14635: }
14636: }
14637: $seen{$prim_ip} = 1;
14638: }
14639: return &do_cache_new('internetnames',$lonid,\@idns,12*60*60);
14640: }
14641:
14642: }
14643:
14644: sub all_loncaparevs {
14645: 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);
14646: }
14647:
14648: # ---------------------------------------------------------- Read loncaparev table
14649: {
14650: sub load_loncaparevs {
14651: if (-e "$perlvar{'lonTabDir'}/loncaparevs.tab") {
14652: if (open(my $config,"<","$perlvar{'lonTabDir'}/loncaparevs.tab")) {
14653: while (my $configline=<$config>) {
14654: chomp($configline);
14655: my ($hostid,$loncaparev)=split(/:/,$configline);
14656: $loncaparevs{$hostid}=$loncaparev;
14657: }
14658: close($config);
14659: }
14660: }
14661: }
14662: }
14663:
14664: # ---------------------------------------------------------- Read serverhostID table
14665: {
14666: sub load_serverhomeIDs {
14667: if (-e "$perlvar{'lonTabDir'}/serverhomeIDs.tab") {
14668: if (open(my $config,"<","$perlvar{'lonTabDir'}/serverhomeIDs.tab")) {
14669: while (my $configline=<$config>) {
14670: chomp($configline);
14671: my ($name,$id)=split(/:/,$configline);
14672: $serverhomeIDs{$name}=$id;
14673: }
14674: close($config);
14675: }
14676: }
14677: }
14678: }
14679:
14680:
14681: BEGIN {
14682:
14683: # ----------------------------------- Read loncapa.conf and loncapa_apache.conf
14684: unless ($readit) {
14685: {
14686: my $configvars = LONCAPA::Configuration::read_conf('loncapa.conf');
14687: %perlvar = (%perlvar,%{$configvars});
14688: }
14689:
14690:
14691: # ------------------------------------------------------ Read spare server file
14692: {
14693: open(my $config,"<","$perlvar{'lonTabDir'}/spare.tab");
14694:
14695: while (my $configline=<$config>) {
14696: chomp($configline);
14697: if ($configline) {
14698: my ($host,$type) = split(':',$configline,2);
14699: if (!defined($type) || $type eq '') { $type = 'default' };
14700: push(@{ $spareid{$type} }, $host);
14701: }
14702: }
14703: close($config);
14704: }
14705: # ------------------------------------------------------------ Read permissions
14706: {
14707: open(my $config,"<","$perlvar{'lonTabDir'}/roles.tab");
14708:
14709: while (my $configline=<$config>) {
14710: chomp($configline);
14711: if ($configline) {
14712: my ($role,$perm)=split(/ /,$configline);
14713: if ($perm ne '') { $pr{$role}=$perm; }
14714: }
14715: }
14716: close($config);
14717: }
14718:
14719: # -------------------------------------------- Read plain texts for permissions
14720: {
14721: open(my $config,"<","$perlvar{'lonTabDir'}/rolesplain.tab");
14722:
14723: while (my $configline=<$config>) {
14724: chomp($configline);
14725: if ($configline) {
14726: my ($short,@plain)=split(/:/,$configline);
14727: %{$prp{$short}} = ();
14728: if (@plain > 0) {
14729: $prp{$short}{'std'} = $plain[0];
14730: for (my $i=1; $i<@plain; $i++) {
14731: $prp{$short}{'alt'.$i} = $plain[$i];
14732: }
14733: }
14734: }
14735: }
14736: close($config);
14737: }
14738:
14739: # ---------------------------------------------------------- Read package table
14740: {
14741: open(my $config,"<","$perlvar{'lonTabDir'}/packages.tab");
14742:
14743: while (my $configline=<$config>) {
14744: if ($configline !~ /\S/ || $configline=~/^#/) { next; }
14745: chomp($configline);
14746: my ($short,$plain)=split(/:/,$configline);
14747: my ($pack,$name)=split(/\&/,$short);
14748: if ($plain ne '') {
14749: $packagetab{$pack.'&'.$name.'&name'}=$name;
14750: $packagetab{$short}=$plain;
14751: }
14752: }
14753: close($config);
14754: }
14755:
14756: # ---------------------------------------------------------- Read loncaparev table
14757:
14758: &load_loncaparevs();
14759:
14760: # ---------------------------------------------------------- Read serverhostID table
14761:
14762: &load_serverhomeIDs();
14763:
14764: # ---------------------------------------------------------- Read releaseslist XML
14765: {
14766: my $file = $Apache::lonnet::perlvar{'lonTabDir'}.'/releaseslist.xml';
14767: if (-e $file) {
14768: my $parser = HTML::LCParser->new($file);
14769: while (my $token = $parser->get_token()) {
14770: if ($token->[0] eq 'S') {
14771: my $item = $token->[1];
14772: my $name = $token->[2]{'name'};
14773: my $value = $token->[2]{'value'};
14774: my $valuematch = $token->[2]{'valuematch'};
14775: my $namematch = $token->[2]{'namematch'};
14776: if ($item eq 'parameter') {
14777: if (($namematch ne '') || (($name ne '') && ($value ne '' || $valuematch ne ''))) {
14778: my $release = $parser->get_text();
14779: $release =~ s/(^\s*|\s*$ )//gx;
14780: $needsrelease{$item.':'.$name.':'.$value.':'.$valuematch.':'.$namematch} = $release;
14781: }
14782: } elsif ($item ne '' && $name ne '') {
14783: my $release = $parser->get_text();
14784: $release =~ s/(^\s*|\s*$ )//gx;
14785: $needsrelease{$item.':'.$name.':'.$value} = $release;
14786: }
14787: }
14788: }
14789: }
14790: }
14791:
14792: # ---------------------------------------------------------- Read managers table
14793: {
14794: if (-e "$perlvar{'lonTabDir'}/managers.tab") {
14795: if (open(my $config,"<","$perlvar{'lonTabDir'}/managers.tab")) {
14796: while (my $configline=<$config>) {
14797: chomp($configline);
14798: next if ($configline =~ /^\#/);
14799: if (($configline =~ /^[\w\-]+$/) || ($configline =~ /^[\w\-]+\:[\w\-]+$/)) {
14800: $managerstab{$configline} = 1;
14801: }
14802: }
14803: close($config);
14804: }
14805: }
14806: }
14807:
14808: # ------------- set up temporary directory
14809: {
14810: $tmpdir = LONCAPA::tempdir();
14811:
14812: }
14813:
14814: # ------------- set default texengine (domain default overrides this)
14815: {
14816: $deftex = LONCAPA::texengine();
14817: }
14818:
14819: $memcache=new Cache::Memcached({'servers' => ['127.0.0.1:11211'],
14820: 'compress_threshold'=> 20_000,
14821: });
14822:
14823: $processmarker='_'.time.'_'.$perlvar{'lonHostID'};
14824: $dumpcount=0;
14825: $locknum=0;
14826:
14827: &logtouch();
14828: &logthis('<font color="yellow">INFO: Read configuration</font>');
14829: $readit=1;
14830: {
14831: use integer;
14832: my $test=(2**32)+1;
14833: if ($test != 0) { $_64bit=1; } else { $_64bit=0; }
14834: &logthis(" Detected 64bit platform ($_64bit)");
14835: }
14836: }
14837: }
14838:
14839: 1;
14840: __END__
14841:
14842: =pod
14843:
14844: =head1 NAME
14845:
14846: Apache::lonnet - Subroutines to ask questions about things in the network.
14847:
14848: =head1 SYNOPSIS
14849:
14850: Invoked by other LON-CAPA modules, when they need to talk to or about objects in the network.
14851:
14852: &Apache::lonnet::SUBROUTINENAME(ARGUMENTS);
14853:
14854: Common parameters:
14855:
14856: =over 4
14857:
14858: =item *
14859:
14860: $uname : an internal username (if $cname expecting a course Id specifically)
14861:
14862: =item *
14863:
14864: $udom : a domain (if $cdom expecting a course's domain specifically)
14865:
14866: =item *
14867:
14868: $symb : a resource instance identifier
14869:
14870: =item *
14871:
14872: $namespace : the name of a .db file that contains the data needed or
14873: being set.
14874:
14875: =back
14876:
14877: =head1 OVERVIEW
14878:
14879: lonnet provides subroutines which interact with the
14880: lonc/lond (TCP) network layer of LON-CAPA. They can be used to ask
14881: about classes, users, and resources.
14882:
14883: For many of these objects you can also use this to store data about
14884: them or modify them in various ways.
14885:
14886: =head2 Symbs
14887:
14888: To identify a specific instance of a resource, LON-CAPA uses symbols
14889: or "symbs"X<symb>. These identifiers are built from the URL of the
14890: map, the resource number of the resource in the map, and the URL of
14891: the resource itself. The latter is somewhat redundant, but might help
14892: if maps change.
14893:
14894: An example is
14895:
14896: msu/korte/parts/part1.sequence___19___msu/korte/tests/part12.problem
14897:
14898: The respective map entry is
14899:
14900: <resource id="19" src="/res/msu/korte/tests/part12.problem"
14901: title="Problem 2">
14902: </resource>
14903:
14904: Symbs are used by the random number generator, as well as to store and
14905: restore data specific to a certain instance of for example a problem.
14906:
14907: =head2 Storing And Retrieving Data
14908:
14909: X<store()>X<cstore()>X<restore()>Three of the most important functions
14910: in C<lonnet.pm> are C<&Apache::lonnet::cstore()>,
14911: C<&Apache::lonnet:restore()>, and C<&Apache::lonnet::store()>, which
14912: is is the non-critical message twin of cstore. These functions are for
14913: handlers to store a perl hash to a user's permanent data space in an
14914: easy manner, and to retrieve it again on another call. It is expected
14915: that a handler would use this once at the beginning to retrieve data,
14916: and then again once at the end to send only the new data back.
14917:
14918: The data is stored in the user's data directory on the user's
14919: homeserver under the ID of the course.
14920:
14921: The hash that is returned by restore will have all of the previous
14922: value for all of the elements of the hash.
14923:
14924: Example:
14925:
14926: #creating a hash
14927: my %hash;
14928: $hash{'foo'}='bar';
14929:
14930: #storing it
14931: &Apache::lonnet::cstore(\%hash);
14932:
14933: #changing a value
14934: $hash{'foo'}='notbar';
14935:
14936: #adding a new value
14937: $hash{'bar'}='foo';
14938: &Apache::lonnet::cstore(\%hash);
14939:
14940: #retrieving the hash
14941: my %history=&Apache::lonnet::restore();
14942:
14943: #print the hash
14944: foreach my $key (sort(keys(%history))) {
14945: print("\%history{$key} = $history{$key}");
14946: }
14947:
14948: Will print out:
14949:
14950: %history{1:foo} = bar
14951: %history{1:keys} = foo:timestamp
14952: %history{1:timestamp} = 990455579
14953: %history{2:bar} = foo
14954: %history{2:foo} = notbar
14955: %history{2:keys} = foo:bar:timestamp
14956: %history{2:timestamp} = 990455580
14957: %history{bar} = foo
14958: %history{foo} = notbar
14959: %history{timestamp} = 990455580
14960: %history{version} = 2
14961:
14962: Note that the special hash entries C<keys>, C<version> and
14963: C<timestamp> were added to the hash. C<version> will be equal to the
14964: total number of versions of the data that have been stored. The
14965: C<timestamp> attribute will be the UNIX time the hash was
14966: stored. C<keys> is available in every historical section to list which
14967: keys were added or changed at a specific historical revision of a
14968: hash.
14969:
14970: B<Warning>: do not store the hash that restore returns directly. This
14971: will cause a mess since it will restore the historical keys as if the
14972: were new keys. I.E. 1:foo will become 1:1:foo etc.
14973:
14974: Calling convention:
14975:
14976: my %record=&Apache::lonnet::restore($symb,$courseid,$domain,$uname);
14977: &Apache::lonnet::cstore(\%newrecord,$symb,$courseid,$domain,$uname,$laststore);
14978:
14979: For more detailed information, see lonnet specific documentation.
14980:
14981: =head1 RETURN MESSAGES
14982:
14983: =over 4
14984:
14985: =item * B<con_lost>: unable to contact remote host
14986:
14987: =item * B<con_delayed>: unable to contact remote host, message will be delivered
14988: when the connection is brought back up
14989:
14990: =item * B<con_failed>: unable to contact remote host and unable to save message
14991: for later delivery
14992:
14993: =item * B<error:>: an error a occurred, a description of the error follows the :
14994:
14995: =item * B<no_such_host>: unable to fund a host associated with the user/domain
14996: that was requested
14997:
14998: =back
14999:
15000: =head1 PUBLIC SUBROUTINES
15001:
15002: =head2 Session Environment Functions
15003:
15004: =over 4
15005:
15006: =item *
15007: X<appenv()>
15008: B<appenv($hashref,$rolesarrayref)>: the value of %{$hashref} is written to
15009: the user envirnoment file, and will be restored for each access this
15010: user makes during this session, also modifies the %env for the current
15011: process. Optional rolesarrayref - if defined contains a reference to an array
15012: of roles which are exempt from the restriction on modifying user.role entries
15013: in the user's environment.db and in %env.
15014:
15015: =item *
15016: X<delenv()>
15017: B<delenv($delthis,$regexp)>: removes all items from the session
15018: environment file that begin with $delthis. If the
15019: optional second arg - $regexp - is true, $delthis is treated as a
15020: regular expression, otherwise \Q$delthis\E is used.
15021: The values are also deleted from the current processes %env.
15022:
15023: =item * get_env_multiple($name)
15024:
15025: gets $name from the %env hash, it seemlessly handles the cases where multiple
15026: values may be defined and end up as an array ref.
15027:
15028: returns an array of values
15029:
15030: =back
15031:
15032: =head2 User Information
15033:
15034: =over 4
15035:
15036: =item *
15037: X<queryauthenticate()>
15038: B<queryauthenticate($uname,$udom)>: try to determine user's current
15039: authentication scheme
15040:
15041: =item *
15042: X<authenticate()>
15043: B<authenticate($uname,$upass,$udom,$checkdefauth,$clientcancheckhost)>: try to
15044: authenticate user from domain's lib servers (first use the current
15045: one). C<$upass> should be the users password.
15046: $checkdefauth is optional (value is 1 if a check should be made to
15047: authenticate user using default authentication method, and allow
15048: account creation if username does not have account in the domain).
15049: $clientcancheckhost is optional (value is 1 if checking whether the
15050: server can host will occur on the client side in lonauth.pm).
15051:
15052: =item *
15053: X<homeserver()>
15054: B<homeserver($uname,$udom)>: find the server which has
15055: the user's directory and files (there must be only one), this caches
15056: the answer, and also caches if there is a borken connection.
15057:
15058: =item *
15059: X<idget()>
15060: B<idget($udom,$idsref,$namespace)>: find the usernames behind either
15061: a list of student/employee IDs or clicker IDs
15062: (student/employee IDs are a unique resource in a domain, there must be
15063: only 1 ID per username, and only 1 username per ID in a specific domain).
15064: clickerIDs are not necessarily unique, as students might share clickers.
15065: (returns hash: id=>name,id=>name)
15066:
15067: =item *
15068: X<idrget()>
15069: B<idrget($udom,@unames)>: find the IDs behind a list of
15070: usernames (returns hash: name=>id,name=>id)
15071:
15072: =item *
15073: X<idput()>
15074: B<idput($udom,$idsref,$uhome,$namespace)>: store away a list of
15075: names and associated student/employee IDs or clicker IDs.
15076:
15077: =item *
15078: X<iddel()>
15079: B<iddel($udom,$idshashref,$uhome,$namespace)>: delete unwanted
15080: student/employee ID or clicker ID username look-ups from domain.
15081: The homeserver ($uhome) and namespace ($namespace) are optional.
15082: If no $uhome is provided, it will be determined usig &homeserver()
15083: for each user. If no $namespace is provided, the default is ids.
15084:
15085: =item *
15086: X<updateclickers()>
15087: B<updateclickers($udom,$action,$idshashref,$uhome,$critical)>: update
15088: clicker ID-to-username look-ups in clickers.db on library server.
15089: Permitted actions are add or del (i.e., add or delete). The
15090: clickers.db contains clickerID as keys (escaped), and each corresponding
15091: value is an escaped comma-separated list of usernames (for whom the
15092: library server is the homeserver), who registered that particular ID.
15093: If $critical is true, the update will be sent via &critical, otherwise
15094: &reply() will be used.
15095:
15096: =item *
15097: X<rolesinit()>
15098: B<rolesinit($udom,$username)>: get user privileges.
15099: returns user role, first access and timer interval hashes
15100:
15101: =item *
15102: X<privileged()>
15103: B<privileged($username,$domain)>: returns a true if user has a
15104: privileged and active role (i.e. su or dc), false otherwise.
15105:
15106: =item *
15107: X<getsection()>
15108: B<getsection($udom,$uname,$cname)>: finds the section of student in the
15109: course $cname, return section name/number or '' for "not in course"
15110: and '-1' for "no section"
15111:
15112: =item *
15113: X<userenvironment()>
15114: B<userenvironment($udom,$uname,@what)>: gets the values of the keys
15115: passed in @what from the requested user's environment, returns a hash
15116:
15117: =item *
15118: X<userlog_query()>
15119: B<userlog_query($uname,$udom,%filters)>: retrieves data from a user's
15120: activity.log file. %filters defines filters applied when parsing the
15121: log file. These can be start or end timestamps, or the type of action
15122: - log to look for Login or Logout events, check for Checkin or
15123: Checkout, role for role selection. The response is in the form
15124: timestamp1:hostid1:event1×tamp2:hostid2:event2 where events are
15125: escaped strings of the action recorded in the activity.log file.
15126:
15127: =back
15128:
15129: =head2 User Roles
15130:
15131: =over 4
15132:
15133: =item *
15134:
15135: allowed($priv,$uri,$symb,$role,$clientip,$noblockcheck) : check for a user privilege;
15136: returns codes for allowed actions.
15137:
15138: The first argument is required, all others are optional.
15139:
15140: $priv is the privilege being checked.
15141: $uri contains additional information about what is being checked for access (e.g.,
15142: URL, course ID etc.).
15143: $symb is the unique resource instance identifier in a course; if needed,
15144: but not provided, it will be retrieved via a call to &symbread().
15145: $role is the role for which a priv is being checked (only used if priv is evb).
15146: $clientip is the user's IP address (only used when checking for access to portfolio
15147: files).
15148: $noblockcheck, if true, skips calls to &has_comm_blocking() for the bre priv. This
15149: prevents recursive calls to &allowed.
15150:
15151: F: full access
15152: U,I,K: authentication modes (cxx only)
15153: '': forbidden
15154: 1: user needs to choose course
15155: 2: browse allowed
15156: A: passphrase authentication needed
15157: B: access temporarily blocked because of a blocking event in a course.
15158: D: access blocked because access is required via session initiated via deep-link
15159:
15160: =item *
15161:
15162: constructaccess($url,$setpriv) : check for access to construction space URL
15163:
15164: See if the owner domain and name in the URL match those in the
15165: expected environment. If so, return three element list
15166: ($ownername,$ownerdomain,$ownerhome).
15167:
15168: Otherwise return the null string.
15169:
15170: If second argument 'setpriv' is true, it assigns the privileges,
15171: and returns the same three element list, unless the owner has
15172: blocked "ad hoc" Domain Coordinator access to the Author Space,
15173: in which case the null string is returned.
15174:
15175: =item *
15176:
15177: definerole($rolename,$sysrole,$domrole,$courole,$uname,$udom) : define role;
15178: define a custom role rolename set privileges in format of lonTabs/roles.tab
15179: for system, domain, and course level. $uname and $udom are optional (current
15180: user's username and domain will be used when either of $uname or $udom are absent.
15181:
15182: =item *
15183:
15184: plaintext($short,$type,$cid,$forcedefault) : return value in %prp hash
15185: (rolesplain.tab); plain text explanation of a user role term.
15186: $type is Course (default) or Community.
15187: If $forcedefault evaluates to true, text returned will be default
15188: text for $type. Otherwise, if this is a course, the text returned
15189: will be a custom name for the role (if defined in the course's
15190: environment). If no custom name is defined the default is returned.
15191:
15192: =item *
15193:
15194: get_my_roles($uname,$udom,$context,$types,$roles,$roledoms,$withsec,$hidepriv) :
15195: All arguments are optional. Returns a hash of a roles, either for
15196: co-author/assistant author roles for a user's Construction Space
15197: (default), or if $context is 'userroles', roles for the user himself,
15198: In the hash, keys are set to colon-separated $uname,$udom,$role, and
15199: (optionally) if $withsec is true, a fourth colon-separated item - $section.
15200: For each key, value is set to colon-separated start and end times for
15201: the role. If no username and domain are specified, will default to
15202: current user/domain. Types, roles, and roledoms are references to arrays
15203: of role statuses (active, future or previous), roles
15204: (e.g., cc,in, st etc.) and domains of the roles which can be used
15205: to restrict the list of roles reported. If no array ref is
15206: provided for types, will default to return only active roles.
15207:
15208: =item *
15209:
15210: in_course($udom,$uname,$cdom,$cnum,$type,$hideprivileged) : determine if
15211: user: $uname:$udom has a role in the course: $cdom_$cnum.
15212:
15213: Additional optional arguments are: $type (if role checking is to be restricted
15214: to certain user status types -- previous (expired roles), active (currently
15215: available roles) or future (roles available in the future), and
15216: $hideprivileged -- if true will not report course roles for users who
15217: have active Domain Coordinator role in course's domain or in additional
15218: domains (specified in 'Domains to check for privileged users' in course
15219: environment -- set via: Course Settings -> Classlists and staff listing).
15220:
15221: =item *
15222:
15223: privileged($username,$domain,$possdomains,$possroles) : returns 1 if user
15224: $username:$domain is a privileged user (e.g., Domain Coordinator or Super User)
15225: $possdomains and $possroles are optional array refs -- to domains to check and
15226: roles to check. If $possdomains is not specified, a dump will be done of the
15227: users' roles.db to check for a dc or su role in any domain. This can be
15228: time consuming if &privileged is called repeatedly (e.g., when displaying a
15229: classlist), so in such cases, supplying a $possdomains array is preferred, as
15230: this then allows &privileged_by_domain() to be used, which caches the identity
15231: of privileged users, eliminating the need for repeated calls to &dump().
15232:
15233: =item *
15234:
15235: privileged_by_domain($possdomains,$roles) : returns a hash of a hash of a hash,
15236: where the outer hash keys are domains specified in the $possdomains array ref,
15237: next inner hash keys are privileged roles specified in the $roles array ref,
15238: and the innermost hash contains key = value pairs for username:domain = end:start
15239: for active or future "privileged" users with that role in that domain. To avoid
15240: repeated dumps of domain roles -- via &get_domain_roles() -- contents of the
15241: innerhash are cached using priv_$role and $dom as the identifiers.
15242:
15243: =back
15244:
15245: =head2 User Modification
15246:
15247: =over 4
15248:
15249: =item *
15250:
15251: assignrole($udom,$uname,$url,$role,$end,$start,$deleteflag,$selfenroll,$context) : assign role; give a role to a
15252: user for the level given by URL. Optional start and end dates (leave empty
15253: string or zero for "no date")
15254:
15255: =item *
15256:
15257: changepass($uname,$udom,$currentpass,$newpass,$server) : attempts to
15258: change a users, password, possible return values are: ok,
15259: pwchange_failure, non_authorized, auth_mode_error, unknown_user,
15260: refused
15261:
15262: =item *
15263:
15264: modifyuserauth($udom,$uname,$umode,$upass) : modify user authentication
15265:
15266: =item *
15267:
15268: modifyuser($udom,$uname,$uid,$umode,$upass,$first,$middle,$last, $gene,
15269: $forceid,$desiredhome,$email,$inststatus,$candelete) :
15270:
15271: will update user information (firstname,middlename,lastname,generation,
15272: permanentemail), and if forceid is true, student/employee ID also.
15273: A user's institutional affiliation(s) can also be updated.
15274: User information fields will not be overwritten with empty entries
15275: unless the field is included in the $candelete array reference.
15276: This array is included when a single user is modified via "Manage Users",
15277: or when Autoupdate.pl is run by cron in a domain.
15278:
15279: =item *
15280:
15281: modifystudent
15282:
15283: modify a student's enrollment and identification information.
15284: The course id is resolved based on the current user's environment.
15285: This means the invoking user must be a course coordinator or otherwise
15286: associated with a course.
15287:
15288: This call is essentially a wrapper for lonnet::modifyuser and
15289: lonnet::modify_student_enrollment
15290:
15291: Inputs:
15292:
15293: =over 4
15294:
15295: =item B<$udom> Student's loncapa domain
15296:
15297: =item B<$uname> Student's loncapa login name
15298:
15299: =item B<$uid> Student/Employee ID
15300:
15301: =item B<$umode> Student's authentication mode
15302:
15303: =item B<$upass> Student's password
15304:
15305: =item B<$first> Student's first name
15306:
15307: =item B<$middle> Student's middle name
15308:
15309: =item B<$last> Student's last name
15310:
15311: =item B<$gene> Student's generation
15312:
15313: =item B<$usec> Student's section in course
15314:
15315: =item B<$end> Unix time of the roles expiration
15316:
15317: =item B<$start> Unix time of the roles start date
15318:
15319: =item B<$forceid> If defined, allow $uid to be changed
15320:
15321: =item B<$desiredhome> server to use as home server for student
15322:
15323: =item B<$email> Student's permanent e-mail address
15324:
15325: =item B<$type> Type of enrollment (auto or manual)
15326:
15327: =item B<$locktype> boolean - enrollment type locked to prevent Autoenroll.pl changing manual to auto
15328:
15329: =item B<$cid> courseID - needed if a course role is assigned by a user whose current role is DC
15330:
15331: =item B<$selfenroll> boolean - 1 if user role change occurred via self-enrollment
15332:
15333: =item B<$context> role change context (shown in User Management Logs display in a course)
15334:
15335: =item B<$inststatus> institutional status of user - : separated string of escaped status types
15336:
15337: =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.
15338:
15339: =back
15340:
15341: =item *
15342:
15343: modify_student_enrollment
15344:
15345: Change a student's enrollment status in a class. The environment variable
15346: 'role.request.course' must be defined for this function to proceed.
15347:
15348: Inputs:
15349:
15350: =over 4
15351:
15352: =item $udom, student's domain
15353:
15354: =item $uname, student's name
15355:
15356: =item $uid, student's user id
15357:
15358: =item $first, student's first name
15359:
15360: =item $middle
15361:
15362: =item $last
15363:
15364: =item $gene
15365:
15366: =item $usec
15367:
15368: =item $end
15369:
15370: =item $start
15371:
15372: =item $type
15373:
15374: =item $locktype
15375:
15376: =item $cid
15377:
15378: =item $selfenroll
15379:
15380: =item $context
15381:
15382: =item $credits, number of credits student will earn from this class
15383:
15384: =item $instsec, institutional course section code for student
15385:
15386: =back
15387:
15388:
15389: =item *
15390:
15391: assigncustomrole($udom,$uname,$url,$rdom,$rnam,$rolename,$end,$start) : assign
15392: custom role; give a custom role to a user for the level given by URL. Specify
15393: name and domain of role author, and role name
15394:
15395: =item *
15396:
15397: revokerole($udom,$uname,$url,$role) : revoke a role for url
15398:
15399: =item *
15400:
15401: revokecustomrole($udom,$uname,$url,$role) : revoke a custom role
15402:
15403: =back
15404:
15405: =head2 Course Infomation
15406:
15407: =over 4
15408:
15409: =item *
15410:
15411: coursedescription($courseid,$options) : returns a hash of information about the
15412: specified course id, including all environment settings for the
15413: course, the description of the course will be in the hash under the
15414: key 'description'
15415:
15416: $options is an optional parameter that if supplied is a hash reference that controls
15417: what how this function works. It has the following key/values:
15418:
15419: =over 4
15420:
15421: =item freshen_cache
15422:
15423: If defined, and the environment cache for the course is valid, it is
15424: returned in the returned hash.
15425:
15426: =item one_time
15427:
15428: If defined, the last cache time is set to _now_
15429:
15430: =item user
15431:
15432: If defined, the supplied username is used instead of the current user.
15433:
15434:
15435: =back
15436:
15437: =item *
15438:
15439: resdata($name,$domain,$type,@which) : request for current parameter
15440: setting for a specific $type, where $type is either 'course' or 'user',
15441: @what should be a list of parameters to ask about. This routine caches
15442: answers for 10 minutes.
15443:
15444: =item *
15445:
15446: get_courseresdata($courseid, $domain) : dump the entire course resource
15447: data base, returning a hash that is keyed by the resource name and has
15448: values that are the resource value. I believe that the timestamps and
15449: versions are also returned.
15450:
15451: get_numsuppfiles($cnum,$cdom) : retrieve number of files in a course's
15452: supplemental content area. This routine caches the number of files for
15453: 10 minutes.
15454:
15455: =back
15456:
15457: =head2 Course Modification
15458:
15459: =over 4
15460:
15461: =item *
15462:
15463: writecoursepref($courseid,%prefs) : write preferences (environment
15464: database) for a course
15465:
15466: =item *
15467:
15468: createcourse($udom,$description,$url,$course_server,$nonstandard,$inst_code,$course_owner,$crstype,$cnum) : make course
15469:
15470: =item *
15471:
15472: generate_coursenum($udom,$crstype) : get a unique (unused) course number in domain $udom for course type $crstype (Course or Community).
15473:
15474: =item *
15475:
15476: is_course($courseid), is_course($cdom, $cnum)
15477:
15478: Accepts either a combined $courseid (in the form of domain_courseid) or the
15479: two component version $cdom, $cnum. It checks if the specified course exists.
15480:
15481: Returns:
15482: undef if the course doesn't exist, otherwise
15483: in scalar context the combined courseid.
15484: in list context the two components of the course identifier, domain and
15485: courseid.
15486:
15487: =back
15488:
15489: =head2 Bubblesheet Configuration
15490:
15491: =over 4
15492:
15493: =item *
15494:
15495: get_scantron_config($which)
15496:
15497: $which - the name of the configuration to parse from the file.
15498:
15499: Parses and returns the bubblesheet configuration line selected as a
15500: hash of configuration file fields.
15501:
15502:
15503: Returns:
15504: If the named configuration is not in the file, an empty
15505: hash is returned.
15506:
15507: a hash with the fields
15508: name - internal name for the this configuration setup
15509: description - text to display to operator that describes this config
15510: CODElocation - if 0 or the string 'none'
15511: - no CODE exists for this config
15512: if -1 || the string 'letter'
15513: - a CODE exists for this config and is
15514: a string of letters
15515: Unsupported value (but planned for future support)
15516: if a positive integer
15517: - The CODE exists as the first n items from
15518: the question section of the form
15519: if the string 'number'
15520: - The CODE exists for this config and is
15521: a string of numbers
15522: CODEstart - (only matter if a CODE exists) column in the line where
15523: the CODE starts
15524: CODElength - length of the CODE
15525: IDstart - column where the student/employee ID starts
15526: IDlength - length of the student/employee ID info
15527: Qstart - column where the information from the bubbled
15528: 'questions' start
15529: Qlength - number of columns comprising a single bubble line from
15530: the sheet. (usually either 1 or 10)
15531: Qon - either a single character representing the character used
15532: to signal a bubble was chosen in the positional setup, or
15533: the string 'letter' if the letter of the chosen bubble is
15534: in the final, or 'number' if a number representing the
15535: chosen bubble is in the file (1->A 0->J)
15536: Qoff - the character used to represent that a bubble was
15537: left blank
15538: PaperID - if the scanning process generates a unique number for each
15539: sheet scanned the column that this ID number starts in
15540: PaperIDlength - number of columns that comprise the unique ID number
15541: for the sheet of paper
15542: FirstName - column that the first name starts in
15543: FirstNameLength - number of columns that the first name spans
15544: LastName - column that the last name starts in
15545: LastNameLength - number of columns that the last name spans
15546: BubblesPerRow - number of bubbles available in each row used to
15547: bubble an answer. (If not specified, 10 assumed).
15548:
15549:
15550: =item *
15551:
15552: get_scantronformat_file($cdom)
15553:
15554: $cdom - the course's domain (optional); if not supplied, uses
15555: domain for current $env{'request.course.id'}.
15556:
15557: Returns an array containing lines from the scantron format file for
15558: the domain of the course.
15559:
15560: If a url for a custom.tab file is listed in domain's configuration.db,
15561: lines are from this file.
15562:
15563: Otherwise, if a default.tab has been published in RES space by the
15564: domainconfig user, lines are from this file.
15565:
15566: Otherwise, fall back to getting lines from the legacy file on the
15567: local server: /home/httpd/lonTabs/default_scantronformat.tab
15568:
15569: =back
15570:
15571: =head2 Resource Subroutines
15572:
15573: =over 4
15574:
15575: =item *
15576:
15577: subscribe($fname) : subscribe to a resource, returns URL if possible (probably should use repcopy instead)
15578:
15579: =item *
15580:
15581: repcopy($filename) : subscribes to the requested file, and attempts to
15582: replicate from the owning library server, Might return
15583: 'unavailable', 'not_found', 'forbidden', 'ok', or
15584: 'bad_request', also attempts to grab the metadata for the
15585: resource. Expects the local filesystem pathname
15586: (/home/httpd/html/res/....)
15587:
15588: =back
15589:
15590: =head2 Resource Information
15591:
15592: =over 4
15593:
15594: =item *
15595:
15596: EXT($varname,$symb,$udom,$uname,$usection,$recurse,$cid) : evaluates
15597: and returns the value of a variety of different possible values,
15598: $varname should be a request string, and the other parameters can be
15599: used to specify who and what one is asking about. Ordinarily, $cid
15600: does not need to be specified, as it is retrived from
15601: $env{'request.course.id'}, but &Apache::lonnet::EXT() is called
15602: within lonuserstate::loadmap() when initializing a course, before
15603: $env{'request.course.id'} has been set, so it needs to be provided
15604: in that one case.
15605:
15606: Possible values for $varname are environment.lastname (or other item
15607: from the envirnment hash), user.name (or someother aspect about the
15608: user), resource.0.maxtries (or some other part and parameter of a
15609: resource)
15610:
15611: =item *
15612:
15613: directcondval($number) : get current value of a condition; reads from a state
15614: string
15615:
15616: =item *
15617:
15618: condval($condidx) : value of condition index based on state
15619:
15620: =item *
15621:
15622: metadata($uri,$what,$toolsymb,$liburi,$prefix,$depthcount) : request a
15623: resource's metadata, $what should be either a specific key, or either
15624: 'keys' (to get a list of possible keys) or 'packages' to get a list of
15625: packages that this resource currently uses, the last 3 arguments are
15626: only used internally for recursive metadata.
15627:
15628: the toolsymb is only used where the uri is for an external tool (for which
15629: the uri as well as the symb are guaranteed to be unique).
15630:
15631: this function automatically caches all requests except any made recursively
15632: to retrieve a list of metadata keys for an imported library file ($liburi is
15633: defined).
15634:
15635: =item *
15636:
15637: metadata_query($query,$custom,$customshow) : make a metadata query against the
15638: network of library servers; returns file handle of where SQL and regex results
15639: will be stored for query
15640:
15641: =item *
15642:
15643: symbread($filename,$donotrecurse,$ignorecachednull,$checkforblock,$possibles) :
15644: return symbolic list entry (all arguments optional).
15645:
15646: Args: filename is the filename (including path) for the file for which a symb
15647: is required; donotrecurse, if true will prevent calls to allowed() being made
15648: to check access status if more than one resource was found in the bighash
15649: (see rev. 1.249) to avoid an infinite loop if an ambiguous resource is part of
15650: a randompick); ignorecachednull, if true will prevent a symb of '' being
15651: returned if $env{$cache_str} is defined as ''; checkforblock if true will
15652: cause possible symbs to be checked to determine if they are subject to content
15653: blocking, if so they will not be included as possible symbs; possibles is a
15654: ref to a hash, which, as a side effect, will be populated with all possible
15655: symbs (content blocking not tested).
15656:
15657: returns the data handle
15658:
15659: =item *
15660:
15661: symbverify($symb,$thisfn,$encstate) : verifies that $symb actually exists
15662: and is a possible symb for the URL in $thisfn, and if is an encrypted
15663: resource that the user accessed using /enc/ returns a 1 on success, 0
15664: on failure, user must be in a course, as it assumes the existence of
15665: the course initial hash, and uses $env('request.course.id'}. The third
15666: arg is an optional reference to a scalar. If this arg is passed in the
15667: call to symbverify, it will be set to 1 if the symb has been set to be
15668: encrypted; otherwise it will be null.
15669:
15670: =item *
15671:
15672: symbclean($symb) : removes versions numbers from a symb, returns the
15673: cleaned symb
15674:
15675: =item *
15676:
15677: is_on_map($uri) : checks if the $uri is somewhere on the current
15678: course map, user must be in a course for it to work.
15679:
15680: =item *
15681:
15682: numval($salt) : return random seed value (addend for rndseed)
15683:
15684: =item *
15685:
15686: rndseed($symb,$courseid,$udom,$uname) : create a random sum; returns
15687: a random seed, all arguments are optional, if they aren't sent it uses the
15688: environment to derive them. Note: if symb isn't sent and it can't get one
15689: from &symbread it will use the current time as its return value
15690:
15691: =item *
15692:
15693: ireceipt($funame,$fudom,$fucourseid,$fusymb) : return unique,
15694: unfakeable, receipt
15695:
15696: =item *
15697:
15698: receipt() : API to ireceipt working off of env values; given out to users
15699:
15700: =item *
15701:
15702: countacc($url) : count the number of accesses to a given URL
15703:
15704: =item *
15705:
15706: 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
15707:
15708: =item *
15709:
15710: 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)
15711:
15712: =item *
15713:
15714: expirespread($uname,$udom,$stype,$usymb) : set expire date for spreadsheet
15715:
15716: =item *
15717:
15718: devalidate($symb) : devalidate temporary spreadsheet calculations,
15719: forcing spreadsheet to reevaluate the resource scores next time.
15720:
15721: =item *
15722:
15723: can_edit_resource($file,$cnum,$cdom,$resurl,$symb,$group) : determine if current user can edit a particular resource,
15724: when viewing in course context.
15725:
15726: input: six args -- filename (decluttered), course number, course domain,
15727: url, symb (if registered) and group (if this is a
15728: group item -- e.g., bulletin board, group page etc.).
15729:
15730: output: array of five scalars --
15731: $cfile -- url for file editing if editable on current server
15732: $home -- homeserver of resource (i.e., for author if published,
15733: or course if uploaded.).
15734: $switchserver -- 1 if server switch will be needed.
15735: $forceedit -- 1 if icon/link should be to go to edit mode
15736: $forceview -- 1 if icon/link should be to go to view mode
15737:
15738: =item *
15739:
15740: is_course_upload($file,$cnum,$cdom)
15741:
15742: Used in course context to determine if current file was uploaded to
15743: the course (i.e., would be found in /userfiles/docs on the course's
15744: homeserver.
15745:
15746: input: 3 args -- filename (decluttered), course number and course domain.
15747: output: boolean -- 1 if file was uploaded.
15748:
15749: =back
15750:
15751: =head2 Storing/Retreiving Data
15752:
15753: =over 4
15754:
15755: =item *
15756:
15757: store($storehash,$symb,$namespace,$udom,$uname,$laststore) : stores hash
15758: permanently for this url; hashref needs to be given and should be a \%hashname;
15759: the remaining args aren't required and if they aren't passed or are '' they will
15760: be derived from the env (with the exception of $laststore, which is an
15761: optional arg used when a user's submission is stored in grading).
15762: $laststore is $version=$timestamp, where $version is the most recent version
15763: number retrieved for the corresponding $symb in the $namespace db file, and
15764: $timestamp is the timestamp for that transaction (UNIX time).
15765: $laststore is currently only passed when cstore() is called by
15766: structuretags::finalize_storage().
15767:
15768: =item *
15769:
15770: cstore($storehash,$symb,$namespace,$udom,$uname,$laststore) : same as store
15771: but uses critical subroutine
15772:
15773: =item *
15774:
15775: restore($symb,$namespace,$udom,$uname) : returns hash for this symb;
15776: all args are optional
15777:
15778: =item *
15779:
15780: dumpstore($namespace,$udom,$uname,$regexp,$range) :
15781: dumps the complete (or key matching regexp) namespace into a hash
15782: ($udom, $uname, $regexp, $range are optional) for a namespace that is
15783: normally &store()ed into
15784:
15785: $range should be either an integer '100' (give me the first 100
15786: matching records)
15787: or be two integers sperated by a - with no spaces
15788: '30-50' (give me the 30th through the 50th matching
15789: records)
15790:
15791:
15792: =item *
15793:
15794: putstore($namespace,$symb,$version,$storehash,$udomain,$uname,$tolog) :
15795: replaces a &store() version of data with a replacement set of data
15796: for a particular resource in a namespace passed in the $storehash hash
15797: reference. If $tolog is true, the transaction is logged in the courselog
15798: with an action=PUTSTORE.
15799:
15800: =item *
15801:
15802: tmpstore($storehash,$symb,$namespace,$udom,$uname) : storage that
15803: works very similar to store/cstore, but all data is stored in a
15804: temporary location and can be reset using tmpreset, $storehash should
15805: be a hash reference, returns nothing on success
15806:
15807: =item *
15808:
15809: tmprestore($symb,$namespace,$udom,$uname) : storage that works very
15810: similar to restore, but all data is stored in a temporary location and
15811: can be reset using tmpreset. Returns a hash of values on success,
15812: error string otherwise.
15813:
15814: =item *
15815:
15816: tmpreset($symb,$namespace,$udom,$uname) : temporary storage reset,
15817: deltes all keys for $symb form the temporary storage hash.
15818:
15819: =item *
15820:
15821: get($namespace,$storearr,$udom,$uname) : returns hash with keys from array
15822: reference filled in from namesp ($udom and $uname are optional)
15823:
15824: =item *
15825:
15826: del($namespace,$storearr,$udom,$uname) : deletes keys out of array from
15827: namesp ($udom and $uname are optional)
15828:
15829: =item *
15830:
15831: dump($namespace,$udom,$uname,$regexp,$range) :
15832: dumps the complete (or key matching regexp) namespace into a hash
15833: ($udom, $uname, $regexp, $range are optional)
15834:
15835: $range should be either an integer '100' (give me the first 100
15836: matching records)
15837: or be two integers sperated by a - with no spaces
15838: '30-50' (give me the 30th through the 50th matching
15839: records)
15840: =item *
15841:
15842: inc($namespace,$store,$udom,$uname) : increments $store in $namespace.
15843: $store can be a scalar, an array reference, or if the amount to be
15844: incremented is > 1, a hash reference.
15845:
15846: ($udom and $uname are optional)
15847:
15848: =item *
15849:
15850: put($namespace,$storehash,$udom,$uname) : stores hash in namesp
15851: ($udom and $uname are optional)
15852:
15853: =item *
15854:
15855: cput($namespace,$storehash,$udom,$uname) : critical put
15856: ($udom and $uname are optional)
15857:
15858: =item *
15859:
15860: newput($namespace,$storehash,$udom,$uname) :
15861:
15862: Attempts to store the items in the $storehash, but only if they don't
15863: currently exist, if this succeeds you can be certain that you have
15864: successfully created a new key value pair in the $namespace db.
15865:
15866:
15867: Args:
15868: $namespace: name of database to store values to
15869: $storehash: hashref to store to the db
15870: $udom: (optional) domain of user containing the db
15871: $uname: (optional) name of user caontaining the db
15872:
15873: Returns:
15874: 'ok' -> succeeded in storing all keys of $storehash
15875: 'key_exists: <key>' -> failed to anything out of $storehash, as at
15876: least <key> already existed in the db (other
15877: requested keys may also already exist)
15878: 'error: <msg>' -> unable to tie the DB or other error occurred
15879: 'con_lost' -> unable to contact request server
15880: 'refused' -> action was not allowed by remote machine
15881:
15882:
15883: =item *
15884:
15885: eget($namespace,$storearr,$udom,$uname) : returns hash with keys from array
15886: reference filled in from namesp (encrypts the return communication)
15887: ($udom and $uname are optional)
15888:
15889: =item *
15890:
15891: log($udom,$name,$home,$message) : write to permanent log for user; use
15892: critical subroutine
15893:
15894: =item *
15895:
15896: get_dom($namespace,$storearr,$udom,$uhome) : returns hash with keys from
15897: array reference filled in from namespace found in domain level on either
15898: specified domain server ($uhome) or primary domain server ($udom and $uhome are optional).
15899:
15900: =item *
15901:
15902: put_dom($namespace,$storehash,$udom,$uhome) : stores hash in namespace at
15903: domain level either on specified domain server ($uhome) or primary domain
15904: server ($udom and $uhome are optional)
15905:
15906: =item *
15907:
15908: get_domain_defaults($target_domain,$ignore_cache) : returns hash with defaults
15909: for: authentication, language, quotas, timezone, date locale, and portal URL in
15910: the target domain.
15911:
15912: May also include additional key => value pairs for the following groups:
15913:
15914: =over
15915:
15916: =item
15917: disk quotas (MB allocated by default to portfolios and authoring spaces).
15918:
15919: =over
15920:
15921: =item defaultquota, authorquota
15922:
15923: =back
15924:
15925: =item
15926: tools (availability of aboutme page, blog, webDAV access for authoring spaces,
15927: portfolio for users).
15928:
15929: =over
15930:
15931: =item
15932: aboutme, blog, webdav, portfolio
15933:
15934: =back
15935:
15936: =item
15937: requestcourses: ability to request courses, and how requests are processed.
15938:
15939: =over
15940:
15941: =item
15942: official, unofficial, community, textbook, placement
15943:
15944: =back
15945:
15946: =item
15947: inststatus: types of institutional affiliation, and order in which they are displayed.
15948:
15949: =over
15950:
15951: =item
15952: inststatustypes, inststatusorder, inststatusguest
15953:
15954: =back
15955:
15956: =item
15957: coursedefaults: can PDF forms can be created, default credits for courses, default quotas (MB)
15958: for course's uploaded content.
15959:
15960: =over
15961:
15962: =item
15963: canuse_pdfforms, officialcredits, unofficialcredits, textbookcredits, officialquota, unofficialquota,
15964: communityquota, textbookquota, placementquota
15965:
15966: =back
15967:
15968: =item
15969: usersessions: set options for hosting of your users in other domains, and hosting of users from other domains
15970: on your servers.
15971:
15972: =over
15973:
15974: =item
15975: remotesessions, hostedsessions
15976:
15977: =back
15978:
15979: =back
15980:
15981: In cases where a domain coordinator has never used the "Set Domain Configuration"
15982: utility to create a configuration.db file on a domain's primary library server
15983: only the following domain defaults: auth_def, auth_arg_def, lang_def
15984: -- corresponding values are authentication type (internal, krb4, krb5,
15985: or localauth), initial password or a kerberos realm, language (e.g., en-us) --
15986: will be available. Values are retrieved from cache (if current), unless the
15987: optional $ignore_cache arg is true, or from domain's configuration.db (if available),
15988: or lastly from values in lonTabs/dns_domain,tab, or lonTabs/domain.tab.
15989:
15990: Typical usage:
15991:
15992: %domdefaults = &get_domain_defaults($target_domain);
15993:
15994: =back
15995:
15996: =head2 Network Status Functions
15997:
15998: =over 4
15999:
16000: =item *
16001:
16002: dirlist() : return directory list based on URI (first arg).
16003:
16004: Inputs: 1 required, 5 optional.
16005:
16006: =over
16007:
16008: =item
16009: $uri - path to file in filesystem (starts: /res or /userfiles/). Required.
16010:
16011: =item
16012: $userdomain - domain of user/course to be listed. Extracted from $uri if absent.
16013:
16014: =item
16015: $username - username of user/course to be listed. Extracted from $uri if absent.
16016:
16017: =item
16018: $getpropath - boolean: 1 if prepend path using &propath().
16019:
16020: =item
16021: $getuserdir - boolean: 1 if prepend path for "userfiles".
16022:
16023: =item
16024: $alternateRoot - path to prepend in place of path from $uri.
16025:
16026: =back
16027:
16028: Returns: Array of up to two items.
16029:
16030: =over
16031:
16032: a reference to an array of files/subdirectories
16033:
16034: =over
16035:
16036: Each element in the array of files/subdirectories is a & separated list of
16037: item name and the result of running stat on the item. If dirlist was requested
16038: for a file instead of a directory, the item name will be ''. For a directory
16039: listing, if the item is a metadata file, the element will end &N&M
16040: (where N amd M are either 0 or 1, corresponding to obsolete set (1), or
16041: default copyright set (1).
16042:
16043: =back
16044:
16045: a scalar containing error condition (if encountered).
16046:
16047: =over
16048:
16049: =item
16050: no_host (no homeserver identified for $username:$domain).
16051:
16052: =item
16053: no_such_host (server contacted for listing not identified as valid host).
16054:
16055: =item
16056: con_lost (connection to remote server failed).
16057:
16058: =item
16059: refused (invalid $username:$domain received on lond side).
16060:
16061: =item
16062: no_such_dir (directory at specified path on lond side does not exist).
16063:
16064: =item
16065: empty (directory at specified path on lond side is empty).
16066:
16067: =over
16068:
16069: This is currently not encountered because the &ls3, &ls2,
16070: &ls (_handler) routines on the lond side do not filter out
16071: . and .. from a directory listing.
16072:
16073: =back
16074:
16075: =back
16076:
16077: =back
16078:
16079: =item *
16080:
16081: spareserver() : find server with least workload from spare.tab
16082:
16083:
16084: =item *
16085:
16086: host_from_dns($dns) : Returns the loncapa hostname corresponding to a DNS name or undef
16087: if there is no corresponding loncapa host.
16088:
16089: =back
16090:
16091:
16092: =head2 Apache Request
16093:
16094: =over 4
16095:
16096: =item *
16097:
16098: ssi($url,%hash) : server side include, does a complete request cycle on url to
16099: localhost, posts hash
16100:
16101: =back
16102:
16103: =head2 Data to String to Data
16104:
16105: =over 4
16106:
16107: =item *
16108:
16109: hash2str(%hash) : convert a hash into a string complete with escaping and '='
16110: and '&' separators, supports elements that are arrayrefs and hashrefs
16111:
16112: =item *
16113:
16114: hashref2str($hashref) : convert a hashref into a string complete with
16115: escaping and '=' and '&' separators, supports elements that are
16116: arrayrefs and hashrefs
16117:
16118: =item *
16119:
16120: arrayref2str($arrayref) : convert an arrayref into a string complete
16121: with escaping and '&' separators, supports elements that are arrayrefs
16122: and hashrefs
16123:
16124: =item *
16125:
16126: str2hash($string) : convert string to hash using unescaping and
16127: splitting on '=' and '&', supports elements that are arrayrefs and
16128: hashrefs
16129:
16130: =item *
16131:
16132: str2array($string) : convert string to hash using unescaping and
16133: splitting on '&', supports elements that are arrayrefs and hashrefs
16134:
16135: =back
16136:
16137: =head2 Logging Routines
16138:
16139:
16140: These routines allow one to make log messages in the lonnet.log and
16141: lonnet.perm logfiles.
16142:
16143: =over 4
16144:
16145: =item *
16146:
16147: logtouch() : make sure the logfile, lonnet.log, exists
16148:
16149: =item *
16150:
16151: logthis() : append message to the normal lonnet.log file, it gets
16152: preiodically rolled over and deleted.
16153:
16154: =item *
16155:
16156: logperm() : append a permanent message to lonnet.perm.log, this log
16157: file never gets deleted by any automated portion of the system, only
16158: messages of critical importance should go in here.
16159:
16160:
16161: =back
16162:
16163: =head2 General File Helper Routines
16164:
16165: =over 4
16166:
16167: =item *
16168:
16169: getfile($file,$caller) : two cases - requests for files in /res or in /uploaded.
16170: (a) files in /uploaded
16171: (i) If a local copy of the file exists -
16172: compares modification date of local copy with last-modified date for
16173: definitive version stored on home server for course. If local copy is
16174: stale, requests a new version from the home server and stores it.
16175: If the original has been removed from the home server, then local copy
16176: is unlinked.
16177: (ii) If local copy does not exist -
16178: requests the file from the home server and stores it.
16179:
16180: If $caller is 'uploadrep':
16181: This indicates a call from lonuploadrep.pm (PerlHeaderParserHandler phase)
16182: for request for files originally uploaded via DOCS.
16183: - returns 'ok' if fresh local copy now available, -1 otherwise.
16184:
16185: Otherwise:
16186: This indicates a call from the content generation phase of the request.
16187: - returns the entire contents of the file or -1.
16188:
16189: (b) files in /res
16190: - returns the entire contents of a file or -1;
16191: it properly subscribes to and replicates the file if neccessary.
16192:
16193:
16194: =item *
16195:
16196: stat_file($url) : $url is expected to be a /res/ or /uploaded/ style file
16197: reference
16198:
16199: returns either a stat() list of data about the file or an empty list
16200: if the file doesn't exist or couldn't find out about it (connection
16201: problems or user unknown)
16202:
16203: =item *
16204:
16205: filelocation($dir,$file) : returns file system location of a file
16206: based on URI; meant to be "fairly clean" absolute reference, $dir is a
16207: directory that relative $file lookups are to looked in ($dir of /a/dir
16208: and a file of ../bob will become /a/bob)
16209:
16210: =item *
16211:
16212: hreflocation($dir,$file) : returns file system location or a URL; same as
16213: filelocation except for hrefs
16214:
16215: =item *
16216:
16217: declutter() : declutters URLs -- remove beginning slashes, 'res' etc.
16218: also removes beginning /home/httpd/html unless /priv/ follows it.
16219:
16220: =back
16221:
16222: =head2 Usererfile file routines (/uploaded*)
16223:
16224: =over 4
16225:
16226: =item *
16227:
16228: userfileupload(): main rotine for putting a file in a user or course's
16229: filespace, arguments are,
16230:
16231: formname - required - this is the name of the element in $env where the
16232: filename, and the contents of the file to create/modifed exist
16233: the filename is in $env{'form.'.$formname.'.filename'} and the
16234: contents of the file is located in $env{'form.'.$formname}
16235: context - if coursedoc, store the file in the course of the active role
16236: of the current user;
16237: if 'existingfile': store in 'overwrites' in /home/httpd/perl/tmp
16238: if 'canceloverwrite': delete file in tmp/overwrites directory
16239: subdir - required - subdirectory to put the file in under ../userfiles/
16240: if undefined, it will be placed in "unknown"
16241:
16242: (This routine calls clean_filename() to remove any dangerous
16243: characters from the filename, and then calls finuserfileupload() to
16244: complete the transaction)
16245:
16246: returns either the url of the uploaded file (/uploaded/....) if successful
16247: and /adm/notfound.html if unsuccessful
16248:
16249: =item *
16250:
16251: clean_filename(): routine for cleaing a filename up for storage in
16252: userfile space, argument is:
16253:
16254: filename - proposed filename
16255:
16256: returns: the new clean filename
16257:
16258: =item *
16259:
16260: finishuserfileupload(): routine that creates and sends the file to
16261: userspace, probably shouldn't be called directly
16262:
16263: docuname: username or courseid of destination for the file
16264: docudom: domain of user/course of destination for the file
16265: formname: same as for userfileupload()
16266: fname: filename (including subdirectories) for the file
16267: parser: if 'parse', will parse (html) file to extract references to objects, links etc.
16268: if hashref, and context is scantron, will convert csv format to standard format
16269: allfiles: reference to hash used to store objects found by parser
16270: codebase: reference to hash used for codebases of java objects found by parser
16271: thumbwidth: width (pixels) of thumbnail to be created for uploaded image
16272: thumbheight: height (pixels) of thumbnail to be created for uploaded image
16273: resizewidth: width to be used to resize image using resizeImage from ImageMagick
16274: resizeheight: height to be used to resize image using resizeImage from ImageMagick
16275: context: if 'overwrite', will move the uploaded file from its temporary location to
16276: userfiles to facilitate overwriting a previously uploaded file with same name.
16277: mimetype: reference to scalar to accommodate mime type determined
16278: from File::MMagic if $parser = parse.
16279:
16280: returns either the url of the uploaded file (/uploaded/....) if successful
16281: and /adm/notfound.html if unsuccessful (or an error message if context
16282: was 'overwrite').
16283:
16284:
16285: =item *
16286:
16287: renameuserfile(): renames an existing userfile to a new name
16288:
16289: Args:
16290: docuname: username or courseid of destination for the file
16291: docudom: domain of user/course of destination for the file
16292: old: current file name (including any subdirs under userfiles)
16293: new: desired file name (including any subdirs under userfiles)
16294:
16295: =item *
16296:
16297: mkdiruserfile(): creates a directory is a userfiles dir
16298:
16299: Args:
16300: docuname: username or courseid of destination for the file
16301: docudom: domain of user/course of destination for the file
16302: dir: dir to create (including any subdirs under userfiles)
16303:
16304: =item *
16305:
16306: removeuserfile(): removes a file that exists in userfiles
16307:
16308: Args:
16309: docuname: username or courseid of destination for the file
16310: docudom: domain of user/course of destination for the file
16311: fname: filname to delete (including any subdirs under userfiles)
16312:
16313: =item *
16314:
16315: removeuploadedurl(): convience function for removeuserfile()
16316:
16317: Args:
16318: url: a full /uploaded/... url to delete
16319:
16320: =item *
16321:
16322: get_portfile_permissions():
16323: Args:
16324: domain: domain of user or course contain the portfolio files
16325: user: name of user or num of course contain the portfolio files
16326: Returns:
16327: hashref of a dump of the proper file_permissions.db
16328:
16329:
16330: =item *
16331:
16332: get_access_controls():
16333:
16334: Args:
16335: current_permissions: the hash ref returned from get_portfile_permissions()
16336: group: (optional) the group you want the files associated with
16337: file: (optional) the file you want access info on
16338:
16339: Returns:
16340: a hash (keys are file names) of hashes containing
16341: keys are: path to file/file_name\0uniqueID:scope_end_start (see below)
16342: values are XML containing access control settings (see below)
16343:
16344: Internal notes:
16345:
16346: access controls are stored in file_permissions.db as key=value pairs.
16347: key -> path to file/file_name\0uniqueID:scope_end_start
16348: where scope -> public,guest,course,group,domains or users.
16349: end -> UNIX time for end of access (0 -> no end date)
16350: start -> UNIX time for start of access
16351:
16352: value -> XML description of access control
16353: <scope type=""> (type =1 of: public,guest,course,group,domains,users">
16354: <start></start>
16355: <end></end>
16356:
16357: <password></password> for scope type = guest
16358:
16359: <domain></domain> for scope type = course or group
16360: <number></number>
16361: <roles id="">
16362: <role></role>
16363: <access></access>
16364: <section></section>
16365: <group></group>
16366: </roles>
16367:
16368: <dom></dom> for scope type = domains
16369:
16370: <users> for scope type = users
16371: <user>
16372: <uname></uname>
16373: <udom></udom>
16374: </user>
16375: </users>
16376: </scope>
16377:
16378: Access data is also aggregated for each file in an additional key=value pair:
16379: key -> path to file/file_name\0accesscontrol
16380: value -> reference to hash
16381: hash contains key = value pairs
16382: where key = uniqueID:scope_end_start
16383: value = UNIX time record was last updated
16384:
16385: Used to improve speed of look-ups of access controls for each file.
16386:
16387: Locks on files (resulting from submission of portfolio file to a homework problem stored in array of arrays.
16388:
16389: =item *
16390:
16391: modify_access_controls():
16392:
16393: Modifies access controls for a portfolio file
16394: Args
16395: 1. file name
16396: 2. reference to hash of required changes,
16397: 3. domain
16398: 4. username
16399: where domain,username are the domain of the portfolio owner
16400: (either a user or a course)
16401:
16402: Returns:
16403: 1. result of additions or updates ('ok' or 'error', with error message).
16404: 2. result of deletions ('ok' or 'error', with error message).
16405: 3. reference to hash of any new or updated access controls.
16406: 4. reference to hash used to map incoming IDs to uniqueIDs assigned to control.
16407: key = integer (inbound ID)
16408: value = uniqueID
16409:
16410: =item *
16411:
16412: get_timebased_id():
16413:
16414: Attempts to get a unique timestamp-based suffix for use with items added to a
16415: course via the Course Editor (e.g., folders, composite pages,
16416: group bulletin boards).
16417:
16418: Args: (first three required; six others optional)
16419:
16420: 1. prefix (alphanumeric): of keys in hash, e.g., suppsequence, docspage,
16421: docssequence, or name of group
16422:
16423: 2. keyid (alphanumeric): name of temporary locking key in hash,
16424: e.g., num, boardids
16425:
16426: 3. namespace: name of gdbm file used to store suffixes already assigned;
16427: file will be named nohist_namespace.db
16428:
16429: 4. cdom: domain of course; default is current course domain from %env
16430:
16431: 5. cnum: course number; default is current course number from %env
16432:
16433: 6. idtype: set to concat if an additional digit is to be appended to the
16434: unix timestamp to form the suffix, if the plain timestamp is already
16435: in use. Default is to not do this, but simply increment the unix
16436: timestamp by 1 until a unique key is obtained.
16437:
16438: 7. who: holder of locking key; defaults to user:domain for user.
16439:
16440: 8. locktries: number of attempts to obtain a lock (sleep of 1s before
16441: retrying); default is 3.
16442:
16443: 9. maxtries: number of attempts to obtain a unique suffix; default is 20.
16444:
16445: Returns:
16446:
16447: 1. suffix obtained (numeric)
16448:
16449: 2. result of deleting locking key (ok if deleted, or lock never obtained)
16450:
16451: 3. error: contains (localized) error message if an error occurred.
16452:
16453:
16454: =back
16455:
16456: =head2 HTTP Helper Routines
16457:
16458: =over 4
16459:
16460: =item *
16461:
16462: escape() : unpack non-word characters into CGI-compatible hex codes
16463:
16464: =item *
16465:
16466: unescape() : pack CGI-compatible hex codes into actual non-word ASCII character
16467:
16468: =back
16469:
16470: =head1 PRIVATE SUBROUTINES
16471:
16472: =head2 Underlying communication routines (Shouldn't call)
16473:
16474: =over 4
16475:
16476: =item *
16477:
16478: subreply() : tries to pass a message to lonc, returns con_lost if incapable
16479:
16480: =item *
16481:
16482: reply() : uses subreply to send a message to remote machine, logs all failures
16483:
16484: =item *
16485:
16486: critical() : passes a critical message to another server; if cannot
16487: get through then place message in connection buffer directory and
16488: returns con_delayed, if incapable of saving message, returns
16489: con_failed
16490:
16491: =item *
16492:
16493: reconlonc() : tries to reconnect lonc client processes.
16494:
16495: =back
16496:
16497: =head2 Resource Access Logging
16498:
16499: =over 4
16500:
16501: =item *
16502:
16503: flushcourselogs() : flush (save) buffer logs and access logs
16504:
16505: =item *
16506:
16507: courselog($what) : save message for course in hash
16508:
16509: =item *
16510:
16511: courseacclog($what) : save message for course using &courselog(). Perform
16512: special processing for specific resource types (problems, exams, quizzes, etc).
16513:
16514: =item *
16515:
16516: goodbye() : flush course logs and log shutting down; it is called in srm.conf
16517: as a PerlChildExitHandler
16518:
16519: =back
16520:
16521: =head2 Other
16522:
16523: =over 4
16524:
16525: =item *
16526:
16527: symblist($mapname,%newhash) : update symbolic storage links
16528:
16529: =back
16530:
16531: =cut
16532:
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