1: # The LearningOnline Network
2: # TCP networking package
3: #
4: # $Id: lonnet.pm,v 1.1493 2022/10/07 12:53:32 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 $passwdmin);
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 Net::CIDR;
100: use Sys::Hostname::FQDN();
101: use LONCAPA qw(:DEFAULT :match);
102: use LONCAPA::Configuration;
103: use LONCAPA::lonmetadata;
104: use LONCAPA::Lond;
105: use LONCAPA::LWPReq;
106: use LONCAPA::transliterate;
107:
108: use File::Copy;
109:
110: my $readit;
111: my $max_connection_retries = 20; # Or some such value.
112:
113: require Exporter;
114:
115: our @ISA = qw (Exporter);
116: our @EXPORT = qw(%env);
117:
118:
119: # ------------------------------------ Logging (parameters, docs, slots, roles)
120: {
121: my $logid;
122: sub write_log {
123: my ($context,$hash_name,$storehash,$delflag,$uname,$udom,$cnum,$cdom)=@_;
124: if ($context eq 'course') {
125: if (($cnum eq '') || ($cdom eq '')) {
126: $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
127: $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
128: }
129: }
130: $logid ++;
131: my $now = time();
132: my $id=$now.'00000'.$$.'00000'.$logid;
133: my $ip = &get_requestor_ip();
134: my $logentry = {
135: $id => {
136: 'exe_uname' => $env{'user.name'},
137: 'exe_udom' => $env{'user.domain'},
138: 'exe_time' => $now,
139: 'exe_ip' => $ip,
140: 'delflag' => $delflag,
141: 'logentry' => $storehash,
142: 'uname' => $uname,
143: 'udom' => $udom,
144: }
145: };
146: return &put('nohist_'.$hash_name,$logentry,$cdom,$cnum);
147: }
148: }
149:
150: sub logtouch {
151: my $execdir=$perlvar{'lonDaemons'};
152: unless (-e "$execdir/logs/lonnet.log") {
153: open(my $fh,">>","$execdir/logs/lonnet.log");
154: close $fh;
155: }
156: my ($wwwuid,$wwwgid)=(getpwnam('www'))[2,3];
157: chown($wwwuid,$wwwgid,$execdir.'/logs/lonnet.log');
158: }
159:
160: sub logthis {
161: my $message=shift;
162: my $execdir=$perlvar{'lonDaemons'};
163: my $now=time;
164: my $local=localtime($now);
165: if (open(my $fh,">>","$execdir/logs/lonnet.log")) {
166: my $logstring = $local. " ($$): ".$message."\n"; # Keep any \'s in string.
167: print $fh $logstring;
168: close($fh);
169: }
170: return 1;
171: }
172:
173: sub logperm {
174: my $message=shift;
175: my $execdir=$perlvar{'lonDaemons'};
176: my $now=time;
177: my $local=localtime($now);
178: if (open(my $fh,">>","$execdir/logs/lonnet.perm.log")) {
179: print $fh "$now:$message:$local\n";
180: close($fh);
181: }
182: return 1;
183: }
184:
185: sub create_connection {
186: my ($hostname,$lonid) = @_;
187: my $client=IO::Socket::UNIX->new(Peer => $perlvar{'lonSockCreate'},
188: Type => SOCK_STREAM,
189: Timeout => 10);
190: return 0 if (!$client);
191: print $client (join(':',$hostname,$lonid,&machine_ids($hostname),$loncaparevs{$lonid})."\n");
192: my $result = <$client>;
193: chomp($result);
194: return 1 if ($result eq 'done');
195: return 0;
196: }
197:
198: sub get_server_timezone {
199: my ($cnum,$cdom) = @_;
200: my $home=&homeserver($cnum,$cdom);
201: if ($home ne 'no_host') {
202: my $cachetime = 24*3600;
203: my ($timezone,$cached)=&is_cached_new('servertimezone',$home);
204: if (defined($cached)) {
205: return $timezone;
206: } else {
207: my $timezone = &reply('servertimezone',$home);
208: return &do_cache_new('servertimezone',$home,$timezone,$cachetime);
209: }
210: }
211: }
212:
213: sub get_server_distarch {
214: my ($lonhost,$ignore_cache) = @_;
215: if (defined($lonhost)) {
216: if (!defined(&hostname($lonhost))) {
217: return;
218: }
219: my $cachetime = 12*3600;
220: if (!$ignore_cache) {
221: my ($distarch,$cached)=&is_cached_new('serverdistarch',$lonhost);
222: if (defined($cached)) {
223: return $distarch;
224: }
225: }
226: my $rep = &reply('serverdistarch',$lonhost);
227: unless ($rep eq 'unknown_command' || $rep eq 'no_such_host' ||
228: $rep eq 'con_lost' || $rep eq 'rejected' || $rep eq 'refused' ||
229: $rep eq '') {
230: return &do_cache_new('serverdistarch',$lonhost,$rep,$cachetime);
231: }
232: }
233: return;
234: }
235:
236: sub get_servercerts_info {
237: my ($lonhost,$hostname,$context) = @_;
238: return if ($lonhost eq '');
239: if ($hostname eq '') {
240: $hostname = &hostname($lonhost);
241: }
242: return if ($hostname eq '');
243: my ($rep,$uselocal);
244: if ($context eq 'install') {
245: $uselocal = 1;
246: } elsif (grep { $_ eq $lonhost } ¤t_machine_ids()) {
247: $uselocal = 1;
248: }
249: if (($context ne 'cgi') && ($context ne 'install') && ($uselocal)) {
250: my $distro = (split(/\:/,&get_server_distarch($lonhost)))[0];
251: if ($distro eq '') {
252: $uselocal = 0;
253: } elsif ($distro =~ /^(?:centos|redhat|scientific)(\d+)$/) {
254: if ($1 < 6) {
255: $uselocal = 0;
256: }
257: } elsif ($distro =~ /^(?:sles)(\d+)$/) {
258: if ($1 < 12) {
259: $uselocal = 0;
260: }
261: }
262: }
263: if ($uselocal) {
264: $rep = LONCAPA::Lond::server_certs(\%perlvar,$lonhost,$hostname);
265: } else {
266: $rep=&reply('servercerts',$lonhost);
267: }
268: my ($result,%returnhash);
269: if (($rep=~/^(refused|rejected|error)/) || ($rep eq 'con_lost') ||
270: ($rep eq 'unknown_cmd')) {
271: $result = $rep;
272: } else {
273: $result = 'ok';
274: my @pairs=split(/\&/,$rep);
275: foreach my $item (@pairs) {
276: my ($key,$value)=split(/=/,$item,2);
277: my $what = &unescape($key);
278: $returnhash{$what}=&thaw_unescape($value);
279: }
280: }
281: return ($result,\%returnhash);
282: }
283:
284: sub get_server_loncaparev {
285: my ($dom,$lonhost,$ignore_cache,$caller) = @_;
286: if (defined($lonhost)) {
287: if (!defined(&hostname($lonhost))) {
288: undef($lonhost);
289: }
290: }
291: if (!defined($lonhost)) {
292: if (defined(&domain($dom,'primary'))) {
293: $lonhost=&domain($dom,'primary');
294: if ($lonhost eq 'no_host') {
295: undef($lonhost);
296: }
297: }
298: }
299: if (defined($lonhost)) {
300: my $cachetime = 12*3600;
301: if (!$ignore_cache) {
302: my ($loncaparev,$cached)=&is_cached_new('serverloncaparev',$lonhost);
303: if (defined($cached)) {
304: return $loncaparev;
305: }
306: }
307: my ($answer,$loncaparev);
308: my @ids=¤t_machine_ids();
309: if (grep(/^\Q$lonhost\E$/,@ids)) {
310: $answer = $perlvar{'lonVersion'};
311: if ($answer =~ /^[\'\"]?([\w.\-]+)[\'\"]?$/) {
312: $loncaparev = $1;
313: }
314: } else {
315: $answer = &reply('serverloncaparev',$lonhost);
316: if (($answer eq 'unknown_cmd') || ($answer eq 'con_lost')) {
317: if ($caller eq 'loncron') {
318: my $hostname = &hostname($lonhost);
319: my $protocol = $protocol{$lonhost};
320: $protocol = 'http' if ($protocol ne 'https');
321: my $url = $protocol.'://'.$hostname.'/adm/about.html';
322: my $request=new HTTP::Request('GET',$url);
323: my $response=&LONCAPA::LWPReq::makerequest($lonhost,$request,'',\%perlvar,4,1);
324: unless ($response->is_error()) {
325: my $content = $response->content;
326: if ($content =~ /<p>VERSION\:\s*([\w.\-]+)<\/p>/) {
327: $loncaparev = $1;
328: }
329: }
330: } else {
331: $loncaparev = $loncaparevs{$lonhost};
332: }
333: } elsif ($answer =~ /^[\'\"]?([\w.\-]+)[\'\"]?$/) {
334: $loncaparev = $1;
335: }
336: }
337: return &do_cache_new('serverloncaparev',$lonhost,$loncaparev,$cachetime);
338: }
339: }
340:
341: sub get_server_homeID {
342: my ($hostname,$ignore_cache,$caller) = @_;
343: unless ($ignore_cache) {
344: my ($serverhomeID,$cached)=&is_cached_new('serverhomeID',$hostname);
345: if (defined($cached)) {
346: return $serverhomeID;
347: }
348: }
349: my $cachetime = 12*3600;
350: my $serverhomeID;
351: if ($caller eq 'loncron') {
352: my @machine_ids = &machine_ids($hostname);
353: foreach my $id (@machine_ids) {
354: my $response = &reply('serverhomeID',$id);
355: unless (($response eq 'unknown_cmd') || ($response eq 'con_lost')) {
356: $serverhomeID = $response;
357: last;
358: }
359: }
360: if ($serverhomeID eq '') {
361: $serverhomeID = $machine_ids[-1];
362: }
363: } else {
364: $serverhomeID = $serverhomeIDs{$hostname};
365: }
366: return &do_cache_new('serverhomeID',$hostname,$serverhomeID,$cachetime);
367: }
368:
369: sub get_remote_globals {
370: my ($lonhost,$whathash,$ignore_cache) = @_;
371: my ($result,%returnhash,%whatneeded);
372: if (ref($whathash) eq 'HASH') {
373: foreach my $what (sort(keys(%{$whathash}))) {
374: my $hashid = $lonhost.'-'.$what;
375: my ($response,$cached);
376: unless ($ignore_cache) {
377: ($response,$cached)=&is_cached_new('lonnetglobal',$hashid);
378: }
379: if (defined($cached)) {
380: $returnhash{$what} = $response;
381: } else {
382: $whatneeded{$what} = 1;
383: }
384: }
385: if (keys(%whatneeded) == 0) {
386: $result = 'ok';
387: } else {
388: my $requested = &freeze_escape(\%whatneeded);
389: my $rep=&reply('readlonnetglobal:'.$requested,$lonhost);
390: if (($rep=~/^(refused|rejected|error)/) || ($rep eq 'con_lost') ||
391: ($rep eq 'unknown_cmd')) {
392: $result = $rep;
393: } else {
394: $result = 'ok';
395: my @pairs=split(/\&/,$rep);
396: foreach my $item (@pairs) {
397: my ($key,$value)=split(/=/,$item,2);
398: my $what = &unescape($key);
399: my $hashid = $lonhost.'-'.$what;
400: $returnhash{$what}=&thaw_unescape($value);
401: &do_cache_new('lonnetglobal',$hashid,$returnhash{$what},600);
402: }
403: }
404: }
405: }
406: return ($result,\%returnhash);
407: }
408:
409: sub remote_devalidate_cache {
410: my ($lonhost,$cachekeys) = @_;
411: my $items;
412: return unless (ref($cachekeys) eq 'ARRAY');
413: my $cachestr = join('&',@{$cachekeys});
414: my $response = &reply('devalidatecache:'.&escape($cachestr),$lonhost);
415: return $response;
416: }
417:
418: # -------------------------------------------------- Non-critical communication
419: sub subreply {
420: my ($cmd,$server)=@_;
421: my $peerfile="$perlvar{'lonSockDir'}/".&hostname($server);
422: #
423: # With loncnew process trimming, there's a timing hole between lonc server
424: # process exit and the master server picking up the listen on the AF_UNIX
425: # socket. In that time interval, a lock file will exist:
426:
427: my $lockfile=$peerfile.".lock";
428: while (-e $lockfile) { # Need to wait for the lockfile to disappear.
429: sleep(0.1);
430: }
431: # At this point, either a loncnew parent is listening or an old lonc
432: # or loncnew child is listening so we can connect or everything's dead.
433: #
434: # We'll give the connection a few tries before abandoning it. If
435: # connection is not possible, we'll con_lost back to the client.
436: #
437: my $client;
438: for (my $retries = 0; $retries < $max_connection_retries; $retries++) {
439: $client=IO::Socket::UNIX->new(Peer =>"$peerfile",
440: Type => SOCK_STREAM,
441: Timeout => 10);
442: if ($client) {
443: last; # Connected!
444: } else {
445: &create_connection(&hostname($server),$server);
446: }
447: sleep(0.1); # Try again later if failed connection.
448: }
449: my $answer;
450: if ($client) {
451: print $client "sethost:$server:$cmd\n";
452: $answer=<$client>;
453: if (!$answer) { $answer="con_lost"; }
454: chomp($answer);
455: } else {
456: $answer = 'con_lost'; # Failed connection.
457: }
458: return $answer;
459: }
460:
461: sub reply {
462: my ($cmd,$server)=@_;
463: unless (defined(&hostname($server))) { return 'no_such_host'; }
464: my $answer=subreply($cmd,$server);
465: if (($answer=~/^refused/) || ($answer=~/^rejected/)) {
466: my $logged = $cmd;
467: if ($cmd =~ /^encrypt:([^:]+):/) {
468: my $subcmd = $1;
469: if (($subcmd eq 'auth') || ($subcmd eq 'passwd') ||
470: ($subcmd eq 'changeuserauth') || ($subcmd eq 'makeuser') ||
471: ($subcmd eq 'putdom') || ($subcmd eq 'autoexportgrades') ||
472: ($subcmd eq 'put')) {
473: (undef,undef,my @rest) = split(/:/,$cmd);
474: if (($subcmd eq 'auth') || ($subcmd eq 'putdom')) {
475: splice(@rest,2,1,'Hidden');
476: } elsif ($subcmd eq 'passwd') {
477: splice(@rest,2,2,('Hidden','Hidden'));
478: } elsif (($subcmd eq 'changeuserauth') || ($subcmd eq 'makeuser') ||
479: ($subcmd eq 'autoexportgrades') || ($subcmd eq 'put')) {
480: splice(@rest,3,1,'Hidden');
481: }
482: $logged = join(':',('encrypt:'.$subcmd,@rest));
483: }
484: }
485: &logthis("<font color=\"blue\">WARNING:".
486: " $logged to $server returned $answer</font>");
487: }
488: return $answer;
489: }
490:
491: # ----------------------------------------------------------- Send USR1 to lonc
492:
493: sub reconlonc {
494: my ($lonid) = @_;
495: if ($lonid) {
496: my $hostname = &hostname($lonid);
497: my $peerfile="$perlvar{'lonSockDir'}/$hostname";
498: if ($hostname && -e $peerfile) {
499: &logthis("Trying to reconnect lonc for $lonid ($hostname)");
500: my $client=IO::Socket::UNIX->new(Peer => $peerfile,
501: Type => SOCK_STREAM,
502: Timeout => 10);
503: if ($client) {
504: print $client ("reset_retries\n");
505: my $answer=<$client>;
506: #reset just this one.
507: }
508: }
509: return;
510: }
511:
512: &logthis("Trying to reconnect lonc");
513: my $loncfile="$perlvar{'lonDaemons'}/logs/lonc.pid";
514: if (open(my $fh,"<",$loncfile)) {
515: my $loncpid=<$fh>;
516: chomp($loncpid);
517: if (kill 0 => $loncpid) {
518: &logthis("lonc at pid $loncpid responding, sending USR1");
519: kill USR1 => $loncpid;
520: sleep 1;
521: } else {
522: &logthis(
523: "<font color=\"blue\">WARNING:".
524: " lonc at pid $loncpid not responding, giving up</font>");
525: }
526: } else {
527: &logthis('<font color="blue">WARNING: lonc not running, giving up</font>');
528: }
529: }
530:
531: # ------------------------------------------------------ Critical communication
532:
533: sub critical {
534: my ($cmd,$server)=@_;
535: unless (&hostname($server)) {
536: &logthis("<font color=\"blue\">WARNING:".
537: " Critical message to unknown server ($server)</font>");
538: return 'no_such_host';
539: }
540: my $answer=reply($cmd,$server);
541: if ($answer eq 'con_lost') {
542: &reconlonc($server);
543: my $answer=reply($cmd,$server);
544: if ($answer eq 'con_lost') {
545: my $now=time;
546: my $middlename=$cmd;
547: $middlename=substr($middlename,0,16);
548: $middlename=~s/\W//g;
549: my $dfilename=
550: "$perlvar{'lonSockDir'}/delayed/$now.$dumpcount.$$.$middlename.$server";
551: $dumpcount++;
552: {
553: my $dfh;
554: if (open($dfh,">",$dfilename)) {
555: print $dfh "$cmd\n";
556: close($dfh);
557: }
558: }
559: sleep 1;
560: my $wcmd='';
561: {
562: my $dfh;
563: if (open($dfh,"<",$dfilename)) {
564: $wcmd=<$dfh>;
565: close($dfh);
566: }
567: }
568: chomp($wcmd);
569: if ($wcmd eq $cmd) {
570: &logthis("<font color=\"blue\">WARNING: ".
571: "Connection buffer $dfilename: $cmd</font>");
572: &logperm("D:$server:$cmd");
573: return 'con_delayed';
574: } else {
575: &logthis("<font color=\"red\">CRITICAL:"
576: ." Critical connection failed: $server $cmd</font>");
577: &logperm("F:$server:$cmd");
578: return 'con_failed';
579: }
580: }
581: }
582: return $answer;
583: }
584:
585: # ------------------------------------------- check if return value is an error
586:
587: sub error {
588: my ($result) = @_;
589: if ($result =~ /^(con_lost|no_such_host|error: (\d+) (.*))/) {
590: if ($2 == 2) { return undef; }
591: return $1;
592: }
593: return undef;
594: }
595:
596: sub convert_and_load_session_env {
597: my ($lonidsdir,$handle)=@_;
598: my @profile;
599: {
600: my $opened = open(my $idf,'+<',"$lonidsdir/$handle.id");
601: if (!$opened) {
602: return 0;
603: }
604: flock($idf,LOCK_SH);
605: @profile=<$idf>;
606: close($idf);
607: }
608: my %temp_env;
609: foreach my $line (@profile) {
610: if ($line !~ m/=/) {
611: return 0;
612: }
613: chomp($line);
614: my ($envname,$envvalue)=split(/=/,$line,2);
615: $temp_env{&unescape($envname)} = &unescape($envvalue);
616: }
617: unlink("$lonidsdir/$handle.id");
618: if (tie(my %disk_env,'GDBM_File',"$lonidsdir/$handle.id",&GDBM_WRCREAT(),
619: 0640)) {
620: %disk_env = %temp_env;
621: @env{keys(%temp_env)} = @disk_env{keys(%temp_env)};
622: untie(%disk_env);
623: }
624: return 1;
625: }
626:
627: # ------------------------------------------- Transfer profile into environment
628: my $env_loaded;
629: sub transfer_profile_to_env {
630: my ($lonidsdir,$handle,$force_transfer) = @_;
631: if (!$force_transfer && $env_loaded) { return; }
632:
633: if (!defined($lonidsdir)) {
634: $lonidsdir = $perlvar{'lonIDsDir'};
635: }
636: if (!defined($handle)) {
637: ($handle) = ($env{'user.environment'} =~m|/([^/]+)\.id$| );
638: }
639:
640: my $convert;
641: {
642: my $opened = open(my $idf,'+<',"$lonidsdir/$handle.id");
643: if (!$opened) {
644: return;
645: }
646: flock($idf,LOCK_SH);
647: if (tie(my %disk_env,'GDBM_File',"$lonidsdir/$handle.id",
648: &GDBM_READER(),0640)) {
649: @env{keys(%disk_env)} = @disk_env{keys(%disk_env)};
650: untie(%disk_env);
651: } else {
652: $convert = 1;
653: }
654: }
655: if ($convert) {
656: if (!&convert_and_load_session_env($lonidsdir,$handle)) {
657: &logthis("Failed to load session, or convert session.");
658: }
659: }
660:
661: my %remove;
662: while ( my $envname = each(%env) ) {
663: if (my ($key,$time) = ($envname =~ /^(cgi\.(\d+)_\d+\.)/)) {
664: if ($time < time-300) {
665: $remove{$key}++;
666: }
667: }
668: }
669:
670: $env{'user.environment'} = "$lonidsdir/$handle.id";
671: $env_loaded=1;
672: foreach my $expired_key (keys(%remove)) {
673: &delenv($expired_key);
674: }
675: }
676:
677: # ---------------------------------------------------- Check for valid session
678: sub check_for_valid_session {
679: my ($r,$name,$userhashref,$domref) = @_;
680: my %cookies=CGI::Cookie->parse($r->header_in('Cookie'));
681: my ($lonidsdir,$linkname,$pubname,$secure,$lonid);
682: if ($name eq 'lonDAV') {
683: $lonidsdir=$r->dir_config('lonDAVsessDir');
684: } else {
685: $lonidsdir=$r->dir_config('lonIDsDir');
686: if ($name eq '') {
687: $name = 'lonID';
688: }
689: }
690: if ($name eq 'lonID') {
691: $secure = 'lonSID';
692: $linkname = 'lonLinkID';
693: $pubname = 'lonPubID';
694: if (exists($cookies{$secure})) {
695: $lonid=$cookies{$secure};
696: } elsif (exists($cookies{$name})) {
697: $lonid=$cookies{$name};
698: } elsif ((exists($cookies{$linkname})) && ($ENV{'SERVER_PORT'} != 443)) {
699: $lonid=$cookies{$linkname};
700: } elsif (exists($cookies{$pubname})) {
701: $lonid=$cookies{$pubname};
702: }
703: } else {
704: $lonid=$cookies{$name};
705: }
706: return undef if (!$lonid);
707:
708: my $handle=&LONCAPA::clean_handle($lonid->value);
709: if (-l "$lonidsdir/$handle.id") {
710: my $link = readlink("$lonidsdir/$handle.id");
711: if ((-e $link) && ($link =~ m{^\Q$lonidsdir\E/(.+)\.id$})) {
712: $handle = $1;
713: }
714: }
715: if (!-e "$lonidsdir/$handle.id") {
716: if ((ref($domref)) && ($name eq 'lonID') &&
717: ($handle =~ /^($match_username)\_\d+\_($match_domain)\_(.+)$/)) {
718: my ($possuname,$possudom,$possuhome) = ($1,$2,$3);
719: if ((&domain($possudom) ne '') && (&homeserver($possuname,$possudom) eq $possuhome)) {
720: $$domref = $possudom;
721: }
722: }
723: return undef;
724: }
725:
726: my $opened = open(my $idf,'+<',"$lonidsdir/$handle.id");
727: return undef if (!$opened);
728:
729: flock($idf,LOCK_SH);
730: my %disk_env;
731: if (!tie(%disk_env,'GDBM_File',"$lonidsdir/$handle.id",
732: &GDBM_READER(),0640)) {
733: return undef;
734: }
735:
736: if (!defined($disk_env{'user.name'})
737: || !defined($disk_env{'user.domain'})) {
738: untie(%disk_env);
739: return undef;
740: }
741:
742: if (ref($userhashref) eq 'HASH') {
743: $userhashref->{'name'} = $disk_env{'user.name'};
744: $userhashref->{'domain'} = $disk_env{'user.domain'};
745: if ($disk_env{'request.role'}) {
746: $userhashref->{'role'} = $disk_env{'request.role'};
747: }
748: $userhashref->{'lti'} = $disk_env{'request.lti.login'};
749: if ($userhashref->{'lti'}) {
750: $userhashref->{'ltitarget'} = $disk_env{'request.lti.target'};
751: $userhashref->{'ltiuri'} = $disk_env{'request.lti.uri'};
752: }
753: }
754: untie(%disk_env);
755:
756: return $handle;
757: }
758:
759: sub timed_flock {
760: my ($file,$lock_type) = @_;
761: my $failed=0;
762: eval {
763: local $SIG{__DIE__}='DEFAULT';
764: local $SIG{ALRM}=sub {
765: $failed=1;
766: die("failed lock");
767: };
768: alarm(13);
769: flock($file,$lock_type);
770: alarm(0);
771: };
772: if ($failed) {
773: return undef;
774: } else {
775: return 1;
776: }
777: }
778:
779: sub get_sessionfile_vars {
780: my ($handle,$lonidsdir,$storearr) = @_;
781: my %returnhash;
782: unless (ref($storearr) eq 'ARRAY') {
783: return %returnhash;
784: }
785: if (-l "$lonidsdir/$handle.id") {
786: my $link = readlink("$lonidsdir/$handle.id");
787: if ((-e $link) && ($link =~ m{^\Q$lonidsdir\E/(.+)\.id$})) {
788: $handle = $1;
789: }
790: }
791: if ((-e "$lonidsdir/$handle.id") &&
792: ($handle =~ /^($match_username)\_\d+\_($match_domain)\_(.+)$/)) {
793: my ($possuname,$possudom,$possuhome) = ($1,$2,$3);
794: if ((&domain($possudom) ne '') && (&homeserver($possuname,$possudom) eq $possuhome)) {
795: if (open(my $idf,'+<',"$lonidsdir/$handle.id")) {
796: flock($idf,LOCK_SH);
797: if (tie(my %disk_env,'GDBM_File',"$lonidsdir/$handle.id",
798: &GDBM_READER(),0640)) {
799: foreach my $item (@{$storearr}) {
800: $returnhash{$item} = $disk_env{$item};
801: }
802: untie(%disk_env);
803: }
804: }
805: }
806: }
807: return %returnhash;
808: }
809:
810: # ---------------------------------------------------------- Append Environment
811:
812: sub appenv {
813: my ($newenv,$roles) = @_;
814: if (ref($newenv) eq 'HASH') {
815: foreach my $key (keys(%{$newenv})) {
816: my $refused = 0;
817: if (($key =~ /^user\.role/) || ($key =~ /^user\.priv/)) {
818: $refused = 1;
819: if (ref($roles) eq 'ARRAY') {
820: my ($type,$role) = ($key =~ m{^user\.(role|priv)\.(.+?)\./});
821: if (grep(/^\Q$role\E$/,@{$roles})) {
822: $refused = 0;
823: }
824: }
825: }
826: if ($refused) {
827: &logthis("<font color=\"blue\">WARNING: ".
828: "Attempt to modify environment ".$key." to ".$newenv->{$key}
829: .'</font>');
830: delete($newenv->{$key});
831: } else {
832: $env{$key}=$newenv->{$key};
833: }
834: }
835: my $lonids = $perlvar{'lonIDsDir'};
836: if ($env{'user.environment'} =~ m{^\Q$lonids/\E$match_username\_\d+\_$match_domain\_[\w\-.]+\.id$}) {
837: my $opened = open(my $env_file,'+<',$env{'user.environment'});
838: if ($opened
839: && &timed_flock($env_file,LOCK_EX)
840: &&
841: tie(my %disk_env,'GDBM_File',$env{'user.environment'},
842: (&GDBM_WRITER()|&GDBM_NOLOCK()),0640)) {
843: while (my ($key,$value) = each(%{$newenv})) {
844: $disk_env{$key} = $value;
845: }
846: untie(%disk_env);
847: }
848: }
849: }
850: return 'ok';
851: }
852: # ----------------------------------------------------- Delete from Environment
853:
854: sub delenv {
855: my ($delthis,$regexp,$roles) = @_;
856: if (($delthis=~/^user\.role/) || ($delthis=~/^user\.priv/)) {
857: my $refused = 1;
858: if (ref($roles) eq 'ARRAY') {
859: my ($type,$role) = ($delthis =~ /^user\.(role|priv)\.([^.]+)\./);
860: if (grep(/^\Q$role\E$/,@{$roles})) {
861: $refused = 0;
862: }
863: }
864: if ($refused) {
865: &logthis("<font color=\"blue\">WARNING: ".
866: "Attempt to delete from environment ".$delthis);
867: return 'error';
868: }
869: }
870: my $opened = open(my $env_file,'+<',$env{'user.environment'});
871: if ($opened
872: && &timed_flock($env_file,LOCK_EX)
873: &&
874: tie(my %disk_env,'GDBM_File',$env{'user.environment'},
875: (&GDBM_WRITER()|&GDBM_NOLOCK()),0640)) {
876: foreach my $key (keys(%disk_env)) {
877: if ($regexp) {
878: if ($key=~/^$delthis/) {
879: delete($env{$key});
880: delete($disk_env{$key});
881: }
882: } else {
883: if ($key=~/^\Q$delthis\E/) {
884: delete($env{$key});
885: delete($disk_env{$key});
886: }
887: }
888: }
889: untie(%disk_env);
890: }
891: return 'ok';
892: }
893:
894: sub get_env_multiple {
895: my ($name) = @_;
896: my @values;
897: if (defined($env{$name})) {
898: # exists is it an array
899: if (ref($env{$name})) {
900: @values=@{ $env{$name} };
901: } else {
902: $values[0]=$env{$name};
903: }
904: }
905: return(@values);
906: }
907:
908: # ------------------------------------------------------------------- Locking
909:
910: sub set_lock {
911: my ($text)=@_;
912: $locknum++;
913: my $id=$$.'-'.$locknum;
914: &appenv({'session.locks' => $env{'session.locks'}.','.$id,
915: 'session.lock.'.$id => $text});
916: return $id;
917: }
918:
919: sub get_locks {
920: my $num=0;
921: my %texts=();
922: foreach my $lock (split(/\,/,$env{'session.locks'})) {
923: if ($lock=~/\w/) {
924: $num++;
925: $texts{$lock}=$env{'session.lock.'.$lock};
926: }
927: }
928: return ($num,%texts);
929: }
930:
931: sub remove_lock {
932: my ($id)=@_;
933: my $newlocks='';
934: foreach my $lock (split(/\,/,$env{'session.locks'})) {
935: if (($lock=~/\w/) && ($lock ne $id)) {
936: $newlocks.=','.$lock;
937: }
938: }
939: &appenv({'session.locks' => $newlocks});
940: &delenv('session.lock.'.$id);
941: }
942:
943: sub remove_all_locks {
944: my $activelocks=$env{'session.locks'};
945: foreach my $lock (split(/\,/,$env{'session.locks'})) {
946: if ($lock=~/\w/) {
947: &remove_lock($lock);
948: }
949: }
950: }
951:
952:
953: # ------------------------------------------ Find out current server userload
954: sub userload {
955: my $numusers=0;
956: {
957: opendir(LONIDS,$perlvar{'lonIDsDir'});
958: my $filename;
959: my $curtime=time;
960: while ($filename=readdir(LONIDS)) {
961: next if ($filename eq '.' || $filename eq '..');
962: next if ($filename =~ /publicuser_\d+\.id/);
963: next if ($filename =~ /^[a-f0-9]+_linked\.id$/);
964: my ($mtime)=(stat($perlvar{'lonIDsDir'}.'/'.$filename))[9];
965: if ($curtime-$mtime < 1800) { $numusers++; }
966: }
967: closedir(LONIDS);
968: }
969: my $userloadpercent=0;
970: my $maxuserload=$perlvar{'lonUserLoadLim'};
971: if ($maxuserload) {
972: $userloadpercent=100*$numusers/$maxuserload;
973: }
974: $userloadpercent=sprintf("%.2f",$userloadpercent);
975: return $userloadpercent;
976: }
977:
978: # ------------------------------ Find server with least workload from spare.tab
979:
980: sub spareserver {
981: my ($r,$loadpercent,$userloadpercent,$want_server_name,$udom) = @_;
982: my $spare_server;
983: if ($userloadpercent !~ /\d/) { $userloadpercent=0; }
984: my $lowest_load=($loadpercent > $userloadpercent) ? $loadpercent
985: : $userloadpercent;
986: my ($uint_dom,$remotesessions);
987: if (($udom ne '') && (&domain($udom) ne '')) {
988: my $uprimary_id = &Apache::lonnet::domain($udom,'primary');
989: $uint_dom = &Apache::lonnet::internet_dom($uprimary_id);
990: my %udomdefaults = &Apache::lonnet::get_domain_defaults($udom);
991: $remotesessions = $udomdefaults{'remotesessions'};
992: }
993: my $spareshash = &this_host_spares($udom);
994: if (ref($spareshash) eq 'HASH') {
995: if (ref($spareshash->{'primary'}) eq 'ARRAY') {
996: foreach my $try_server (@{ $spareshash->{'primary'} }) {
997: next unless (&spare_can_host($udom,$uint_dom,$remotesessions,
998: $try_server));
999: ($spare_server, $lowest_load) =
1000: &compare_server_load($try_server, $spare_server, $lowest_load);
1001: }
1002: }
1003:
1004: my $found_server = ($spare_server ne '' && $lowest_load < 100);
1005:
1006: if (!$found_server) {
1007: if (ref($spareshash->{'default'}) eq 'ARRAY') {
1008: foreach my $try_server (@{ $spareshash->{'default'} }) {
1009: next unless (&spare_can_host($udom,$uint_dom,
1010: $remotesessions,$try_server));
1011: ($spare_server, $lowest_load) =
1012: &compare_server_load($try_server, $spare_server, $lowest_load);
1013: }
1014: }
1015: }
1016: }
1017:
1018: if (!$want_server_name) {
1019: if (defined($spare_server)) {
1020: my $hostname = &hostname($spare_server);
1021: if (defined($hostname)) {
1022: my $protocol = 'http';
1023: if ($protocol{$spare_server} eq 'https') {
1024: $protocol = $protocol{$spare_server};
1025: }
1026: my $alias = &Apache::lonnet::use_proxy_alias($r,$spare_server);
1027: $hostname = $alias if ($alias ne '');
1028: $spare_server = $protocol.'://'.$hostname;
1029: }
1030: }
1031: }
1032: return $spare_server;
1033: }
1034:
1035: sub compare_server_load {
1036: my ($try_server, $spare_server, $lowest_load, $required) = @_;
1037:
1038: if ($required) {
1039: my ($reqdmajor,$reqdminor) = ($required =~ /^(\d+)\.(\d+)$/);
1040: my $remoterev = &get_server_loncaparev(undef,$try_server);
1041: my ($major,$minor) = ($remoterev =~ /^\'?(\d+)\.(\d+)\.[\w.\-]+\'?$/);
1042: if (($major eq '' && $minor eq '') ||
1043: (($reqdmajor > $major) || (($reqdmajor == $major) && ($reqdminor > $minor)))) {
1044: return ($spare_server,$lowest_load);
1045: }
1046: }
1047:
1048: my $loadans = &reply('load', $try_server);
1049: my $userloadans = &reply('userload',$try_server);
1050:
1051: if ($loadans !~ /\d/ && $userloadans !~ /\d/) {
1052: return ($spare_server, $lowest_load); #didn't get a number from the server
1053: }
1054:
1055: my $load;
1056: if ($loadans =~ /\d/) {
1057: if ($userloadans =~ /\d/) {
1058: #both are numbers, pick the bigger one
1059: $load = ($loadans > $userloadans) ? $loadans
1060: : $userloadans;
1061: } else {
1062: $load = $loadans;
1063: }
1064: } else {
1065: $load = $userloadans;
1066: }
1067:
1068: if (($load =~ /\d/) && ($load < $lowest_load)) {
1069: $spare_server = $try_server;
1070: $lowest_load = $load;
1071: }
1072: return ($spare_server,$lowest_load);
1073: }
1074:
1075: # --------------------------- ask offload servers if user already has a session
1076: sub find_existing_session {
1077: my ($udom,$uname) = @_;
1078: my $spareshash = &this_host_spares($udom);
1079: if (ref($spareshash) eq 'HASH') {
1080: if (ref($spareshash->{'primary'}) eq 'ARRAY') {
1081: foreach my $try_server (@{ $spareshash->{'primary'} }) {
1082: return $try_server if (&has_user_session($try_server, $udom, $uname));
1083: }
1084: }
1085: if (ref($spareshash->{'default'}) eq 'ARRAY') {
1086: foreach my $try_server (@{ $spareshash->{'default'} }) {
1087: return $try_server if (&has_user_session($try_server, $udom, $uname));
1088: }
1089: }
1090: }
1091: return;
1092: }
1093:
1094: sub delusersession {
1095: my ($lonid,$udom,$uname) = @_;
1096: my $uprimary_id = &domain($udom,'primary');
1097: my $uintdom = &internet_dom($uprimary_id);
1098: my $intdom = &internet_dom($lonid);
1099: my $serverhomedom = &host_domain($lonid);
1100: if (($uintdom ne '') && ($uintdom eq $intdom)) {
1101: return &reply(join(':','delusersession',
1102: map {&escape($_)} ($udom,$uname)),$lonid);
1103: }
1104: return;
1105: }
1106:
1107: # check if user's browser sent load balancer cookie and server still has session
1108: # and is not overloaded.
1109: sub check_for_balancer_cookie {
1110: my ($r,$update_mtime) = @_;
1111: my ($otherserver,$cookie);
1112: my %cookies=CGI::Cookie->parse($r->header_in('Cookie'));
1113: if (exists($cookies{'balanceID'})) {
1114: my $balid = $cookies{'balanceID'};
1115: $cookie=&LONCAPA::clean_handle($balid->value);
1116: my $balancedir=$r->dir_config('lonBalanceDir');
1117: if ((-d $balancedir) && (-e "$balancedir/$cookie.id")) {
1118: if ($cookie =~ /^($match_domain)_($match_username)_[a-f0-9]+$/) {
1119: my ($possudom,$possuname) = ($1,$2);
1120: my $has_session = 0;
1121: if ((&domain($possudom) ne '') &&
1122: (&homeserver($possuname,$possudom) ne 'no_host')) {
1123: my $try_server;
1124: my $opened = open(my $idf,'+<',"$balancedir/$cookie.id");
1125: if ($opened) {
1126: flock($idf,LOCK_SH);
1127: while (my $line = <$idf>) {
1128: chomp($line);
1129: if (&hostname($line) ne '') {
1130: $try_server = $line;
1131: last;
1132: }
1133: }
1134: close($idf);
1135: if (($try_server) &&
1136: (&has_user_session($try_server,$possudom,$possuname))) {
1137: my $lowest_load = 30000;
1138: ($otherserver,$lowest_load) =
1139: &compare_server_load($try_server,undef,$lowest_load);
1140: if ($otherserver ne '' && $lowest_load < 100) {
1141: $has_session = 1;
1142: } else {
1143: undef($otherserver);
1144: }
1145: }
1146: }
1147: }
1148: if ($has_session) {
1149: if ($update_mtime) {
1150: my $atime = my $mtime = time;
1151: utime($atime,$mtime,"$balancedir/$cookie.id");
1152: }
1153: } else {
1154: unlink("$balancedir/$cookie.id");
1155: }
1156: }
1157: }
1158: }
1159: return ($otherserver,$cookie);
1160: }
1161:
1162: sub updatebalcookie {
1163: my ($cookie,$balancer,$lastentry)=@_;
1164: if ($cookie =~ /^($match_domain)\_($match_username)\_[a-f0-9]{32}$/) {
1165: my ($udom,$uname) = ($1,$2);
1166: my $uprimary_id = &domain($udom,'primary');
1167: my $uintdom = &internet_dom($uprimary_id);
1168: my $intdom = &internet_dom($balancer);
1169: my $serverhomedom = &host_domain($balancer);
1170: if (($uintdom ne '') && ($uintdom eq $intdom)) {
1171: return &reply('updatebalcookie:'.&escape($cookie).':'.&escape($lastentry),$balancer);
1172: }
1173: }
1174: return;
1175: }
1176:
1177: sub delbalcookie {
1178: my ($cookie,$balancer) =@_;
1179: if ($cookie =~ /^($match_domain)\_($match_username)\_[a-f0-9]{32}$/) {
1180: my ($udom,$uname) = ($1,$2);
1181: my $uprimary_id = &domain($udom,'primary');
1182: my $uintdom = &internet_dom($uprimary_id);
1183: my $intdom = &internet_dom($balancer);
1184: my $serverhomedom = &host_domain($balancer);
1185: if (($uintdom ne '') && ($uintdom eq $intdom)) {
1186: return &reply('delbalcookie:'.&escape($cookie),$balancer);
1187: }
1188: }
1189: }
1190:
1191: # -------------------------------- ask if server already has a session for user
1192: sub has_user_session {
1193: my ($lonid,$udom,$uname) = @_;
1194: my $result = &reply(join(':','userhassession',
1195: map {&escape($_)} ($udom,$uname)),$lonid);
1196: return 1 if ($result eq 'ok');
1197:
1198: return 0;
1199: }
1200:
1201: # --------- determine least loaded server in a user's domain which allows login
1202:
1203: sub choose_server {
1204: my ($udom,$checkloginvia,$required,$skiploadbal) = @_;
1205: my %domconfhash = &Apache::loncommon::get_domainconf($udom);
1206: my %servers = &get_servers($udom);
1207: my $lowest_load = 30000;
1208: my ($login_host,$hostname,$portal_path,$isredirect,$balancers);
1209: if ($skiploadbal) {
1210: ($balancers,my $cached)=&is_cached_new('loadbalancing',$udom);
1211: unless (defined($cached)) {
1212: my $cachetime = 60*60*24;
1213: my %domconfig =
1214: &Apache::lonnet::get_dom('configuration',['loadbalancing'],$udom);
1215: if (ref($domconfig{'loadbalancing'}) eq 'HASH') {
1216: $balancers = &do_cache_new('loadbalancing',$udom,$domconfig{'loadbalancing'},
1217: $cachetime);
1218: }
1219: }
1220: }
1221: foreach my $lonhost (keys(%servers)) {
1222: if ($skiploadbal) {
1223: if (ref($balancers) eq 'HASH') {
1224: next if (exists($balancers->{$lonhost}));
1225: }
1226: }
1227: my $loginvia;
1228: if ($checkloginvia) {
1229: $loginvia = $domconfhash{$udom.'.login.loginvia_'.$lonhost};
1230: if ($loginvia) {
1231: my ($server,$path) = split(/:/,$loginvia);
1232: ($login_host, $lowest_load) =
1233: &compare_server_load($server, $login_host, $lowest_load, $required);
1234: if ($login_host eq $server) {
1235: $portal_path = $path;
1236: $isredirect = 1;
1237: }
1238: } else {
1239: ($login_host, $lowest_load) =
1240: &compare_server_load($lonhost, $login_host, $lowest_load, $required);
1241: if ($login_host eq $lonhost) {
1242: $portal_path = '';
1243: $isredirect = '';
1244: }
1245: }
1246: } else {
1247: ($login_host, $lowest_load) =
1248: &compare_server_load($lonhost, $login_host, $lowest_load, $required);
1249: }
1250: }
1251: if ($login_host ne '') {
1252: $hostname = &hostname($login_host);
1253: }
1254: return ($login_host,$hostname,$portal_path,$isredirect,$lowest_load);
1255: }
1256:
1257: sub get_course_sessions {
1258: my ($cnum,$cdom,$lastactivity) = @_;
1259: my %servers = &internet_dom_servers($cdom);
1260: my %returnhash;
1261: foreach my $server (sort(keys(%servers))) {
1262: my $rep = &reply("coursesessions:$cdom:$cnum:$lastactivity",$server);
1263: my @pairs=split(/\&/,$rep);
1264: unless (($rep eq 'unknown_cmd') || ($rep =~ /^error/)) {
1265: foreach my $item (@pairs) {
1266: my ($key,$value)=split(/=/,$item,2);
1267: $key = &unescape($key);
1268: next if ($key =~ /^error: 2 /);
1269: if (exists($returnhash{$key})) {
1270: next if ($value < $returnhash{$key});
1271: }
1272: $returnhash{$key}=$value;
1273: }
1274: }
1275: }
1276: return %returnhash;
1277: }
1278:
1279: # --------------------------------------------- Try to change a user's password
1280:
1281: sub changepass {
1282: my ($uname,$udom,$currentpass,$newpass,$server,$context)=@_;
1283: $currentpass = &escape($currentpass);
1284: $newpass = &escape($newpass);
1285: my $lonhost = $perlvar{'lonHostID'};
1286: my $answer = reply("encrypt:passwd:$udom:$uname:$currentpass:$newpass:$context:$lonhost",
1287: $server);
1288: if (! $answer) {
1289: &logthis("No reply on password change request to $server ".
1290: "by $uname in domain $udom.");
1291: } elsif ($answer =~ "^ok") {
1292: &logthis("$uname in $udom successfully changed their password ".
1293: "on $server.");
1294: } elsif ($answer =~ "^pwchange_failure") {
1295: &logthis("$uname in $udom was unable to change their password ".
1296: "on $server. The action was blocked by either lcpasswd ".
1297: "or pwchange");
1298: } elsif ($answer =~ "^non_authorized") {
1299: &logthis("$uname in $udom did not get their password correct when ".
1300: "attempting to change it on $server.");
1301: } elsif ($answer =~ "^auth_mode_error") {
1302: &logthis("$uname in $udom attempted to change their password despite ".
1303: "not being locally or internally authenticated on $server.");
1304: } elsif ($answer =~ "^unknown_user") {
1305: &logthis("$uname in $udom attempted to change their password ".
1306: "on $server but were unable to because $server is not ".
1307: "their home server.");
1308: } elsif ($answer =~ "^refused") {
1309: &logthis("$server refused to change $uname in $udom password because ".
1310: "it was sent an unencrypted request to change the password.");
1311: } elsif ($answer =~ "invalid_client") {
1312: &logthis("$server refused to change $uname in $udom password because ".
1313: "it was a reset by e-mail originating from an invalid server.");
1314: } elsif ($answer =~ "^prioruse") {
1315: &logthis("$server refused to change $uname in $udom password because ".
1316: "the password had been used before");
1317: }
1318: return $answer;
1319: }
1320:
1321: # ----------------------- Try to determine user's current authentication scheme
1322:
1323: sub queryauthenticate {
1324: my ($uname,$udom)=@_;
1325: my $uhome=&homeserver($uname,$udom);
1326: if ((!$uhome) || ($uhome eq 'no_host')) {
1327: &logthis("User $uname at $udom is unknown when looking for authentication mechanism");
1328: return 'no_host';
1329: }
1330: my $answer=reply("encrypt:currentauth:$udom:$uname",$uhome);
1331: if ($answer =~ /^(unknown_user|refused|con_lost)/) {
1332: &logthis("User $uname at $udom threw error $answer when checking authentication mechanism");
1333: }
1334: return $answer;
1335: }
1336:
1337: # --------- Try to authenticate user from domain's lib servers (first this one)
1338:
1339: sub authenticate {
1340: my ($uname,$upass,$udom,$checkdefauth,$clientcancheckhost)=@_;
1341: $upass=&escape($upass);
1342: $uname= &LONCAPA::clean_username($uname);
1343: my $uhome=&homeserver($uname,$udom,1);
1344: my $newhome;
1345: if ((!$uhome) || ($uhome eq 'no_host')) {
1346: # Maybe the machine was offline and only re-appeared again recently?
1347: &reconlonc();
1348: # One more
1349: $uhome=&homeserver($uname,$udom,1);
1350: if (($uhome eq 'no_host') && $checkdefauth) {
1351: if (defined(&domain($udom,'primary'))) {
1352: $newhome=&domain($udom,'primary');
1353: }
1354: if ($newhome ne '') {
1355: $uhome = $newhome;
1356: }
1357: }
1358: if ((!$uhome) || ($uhome eq 'no_host')) {
1359: &logthis("User $uname at $udom is unknown in authenticate");
1360: return 'no_host';
1361: }
1362: }
1363: my $answer=reply("encrypt:auth:$udom:$uname:$upass:$checkdefauth:$clientcancheckhost",$uhome);
1364: if ($answer eq 'authorized') {
1365: if ($newhome) {
1366: &logthis("User $uname at $udom authorized by $uhome, but needs account");
1367: return 'no_account_on_host';
1368: } else {
1369: &logthis("User $uname at $udom authorized by $uhome");
1370: return $uhome;
1371: }
1372: }
1373: if ($answer eq 'non_authorized') {
1374: &logthis("User $uname at $udom rejected by $uhome");
1375: return 'no_host';
1376: }
1377: &logthis("User $uname at $udom threw error $answer when checking authentication mechanism");
1378: return 'no_host';
1379: }
1380:
1381: sub can_switchserver {
1382: my ($udom,$home) = @_;
1383: my ($canswitch,@intdoms);
1384: my $internet_names = &get_internet_names($home);
1385: if (ref($internet_names) eq 'ARRAY') {
1386: @intdoms = @{$internet_names};
1387: }
1388: my $uint_dom = &internet_dom(&domain($udom,'primary'));
1389: if ($uint_dom ne '' && grep(/^\Q$uint_dom\E$/,@intdoms)) {
1390: $canswitch = 1;
1391: } else {
1392: my $serverhomeID = &get_server_homeID(&hostname($home));
1393: my $serverhomedom = &host_domain($serverhomeID);
1394: my %defdomdefaults = &get_domain_defaults($serverhomedom);
1395: my %udomdefaults = &get_domain_defaults($udom);
1396: my $remoterev = &get_server_loncaparev('',$home);
1397: $canswitch = &can_host_session($udom,$home,$remoterev,
1398: $udomdefaults{'remotesessions'},
1399: $defdomdefaults{'hostedsessions'});
1400: }
1401: return $canswitch;
1402: }
1403:
1404: sub can_host_session {
1405: my ($udom,$lonhost,$remoterev,$remotesessions,$hostedsessions) = @_;
1406: my $canhost = 1;
1407: my $host_idn = &Apache::lonnet::internet_dom($lonhost);
1408: if (ref($remotesessions) eq 'HASH') {
1409: if (ref($remotesessions->{'excludedomain'}) eq 'ARRAY') {
1410: if (grep(/^\Q$host_idn\E$/,@{$remotesessions->{'excludedomain'}})) {
1411: $canhost = 0;
1412: } else {
1413: $canhost = 1;
1414: }
1415: }
1416: if (ref($remotesessions->{'includedomain'}) eq 'ARRAY') {
1417: if (grep(/^\Q$host_idn\E$/,@{$remotesessions->{'includedomain'}})) {
1418: $canhost = 1;
1419: } else {
1420: $canhost = 0;
1421: }
1422: }
1423: if ($canhost) {
1424: if ($remotesessions->{'version'} ne '') {
1425: my ($reqmajor,$reqminor) = ($remotesessions->{'version'} =~ /^(\d+)\.(\d+)$/);
1426: if ($reqmajor ne '' && $reqminor ne '') {
1427: if ($remoterev =~ /^\'?(\d+)\.(\d+)/) {
1428: my $major = $1;
1429: my $minor = $2;
1430: if (($major < $reqmajor ) ||
1431: (($major == $reqmajor) && ($minor < $reqminor))) {
1432: $canhost = 0;
1433: }
1434: } else {
1435: $canhost = 0;
1436: }
1437: }
1438: }
1439: }
1440: }
1441: if ($canhost) {
1442: if (ref($hostedsessions) eq 'HASH') {
1443: my $uprimary_id = &Apache::lonnet::domain($udom,'primary');
1444: my $uint_dom = &Apache::lonnet::internet_dom($uprimary_id);
1445: if (ref($hostedsessions->{'excludedomain'}) eq 'ARRAY') {
1446: if (($uint_dom ne '') &&
1447: (grep(/^\Q$uint_dom\E$/,@{$hostedsessions->{'excludedomain'}}))) {
1448: $canhost = 0;
1449: } else {
1450: $canhost = 1;
1451: }
1452: }
1453: if (ref($hostedsessions->{'includedomain'}) eq 'ARRAY') {
1454: if (($uint_dom ne '') &&
1455: (grep(/^\Q$uint_dom\E$/,@{$hostedsessions->{'includedomain'}}))) {
1456: $canhost = 1;
1457: } else {
1458: $canhost = 0;
1459: }
1460: }
1461: }
1462: }
1463: return $canhost;
1464: }
1465:
1466: sub spare_can_host {
1467: my ($udom,$uint_dom,$remotesessions,$try_server)=@_;
1468: my $canhost=1;
1469: my $try_server_hostname = &hostname($try_server);
1470: my $serverhomeID = &get_server_homeID($try_server_hostname);
1471: my $serverhomedom = &host_domain($serverhomeID);
1472: my %defdomdefaults = &get_domain_defaults($serverhomedom);
1473: if (ref($defdomdefaults{'offloadnow'}) eq 'HASH') {
1474: if ($defdomdefaults{'offloadnow'}{$try_server}) {
1475: $canhost = 0;
1476: }
1477: }
1478: if ($canhost) {
1479: if (ref($defdomdefaults{'offloadoth'}) eq 'HASH') {
1480: if ($defdomdefaults{'offloadoth'}{$try_server}) {
1481: unless (&shared_institution($udom,$try_server)) {
1482: $canhost = 0;
1483: }
1484: }
1485: }
1486: }
1487: if (($canhost) && ($uint_dom)) {
1488: my @intdoms;
1489: my $internet_names = &get_internet_names($try_server);
1490: if (ref($internet_names) eq 'ARRAY') {
1491: @intdoms = @{$internet_names};
1492: }
1493: unless (grep(/^\Q$uint_dom\E$/,@intdoms)) {
1494: my $remoterev = &get_server_loncaparev(undef,$try_server);
1495: $canhost = &can_host_session($udom,$try_server,$remoterev,
1496: $remotesessions,
1497: $defdomdefaults{'hostedsessions'});
1498: }
1499: }
1500: return $canhost;
1501: }
1502:
1503: sub this_host_spares {
1504: my ($dom) = @_;
1505: my ($dom_in_use,$lonhost_in_use,$result);
1506: my @hosts = ¤t_machine_ids();
1507: foreach my $lonhost (@hosts) {
1508: if (&host_domain($lonhost) eq $dom) {
1509: $dom_in_use = $dom;
1510: $lonhost_in_use = $lonhost;
1511: last;
1512: }
1513: }
1514: if ($dom_in_use ne '') {
1515: $result = &spares_for_offload($dom_in_use,$lonhost_in_use);
1516: }
1517: if (ref($result) ne 'HASH') {
1518: $lonhost_in_use = $perlvar{'lonHostID'};
1519: $dom_in_use = &host_domain($lonhost_in_use);
1520: $result = &spares_for_offload($dom_in_use,$lonhost_in_use);
1521: if (ref($result) ne 'HASH') {
1522: $result = \%spareid;
1523: }
1524: }
1525: return $result;
1526: }
1527:
1528: sub spares_for_offload {
1529: my ($dom_in_use,$lonhost_in_use) = @_;
1530: my ($result,$cached)=&is_cached_new('spares',$dom_in_use);
1531: if (defined($cached)) {
1532: return $result;
1533: } else {
1534: my $cachetime = 60*60*24;
1535: my %domconfig =
1536: &Apache::lonnet::get_dom('configuration',['usersessions'],$dom_in_use);
1537: if (ref($domconfig{'usersessions'}) eq 'HASH') {
1538: if (ref($domconfig{'usersessions'}{'spares'}) eq 'HASH') {
1539: if (ref($domconfig{'usersessions'}{'spares'}{$lonhost_in_use}) eq 'HASH') {
1540: return &do_cache_new('spares',$dom_in_use,$domconfig{'usersessions'}{'spares'}{$lonhost_in_use},$cachetime);
1541: }
1542: }
1543: }
1544: }
1545: return;
1546: }
1547:
1548: sub get_lonbalancer_config {
1549: my ($servers) = @_;
1550: my ($currbalancer,$currtargets);
1551: if (ref($servers) eq 'HASH') {
1552: foreach my $server (keys(%{$servers})) {
1553: my %what = (
1554: spareid => 1,
1555: perlvar => 1,
1556: );
1557: my ($result,$returnhash) = &get_remote_globals($server,\%what);
1558: if ($result eq 'ok') {
1559: if (ref($returnhash) eq 'HASH') {
1560: if (ref($returnhash->{'perlvar'}) eq 'HASH') {
1561: if ($returnhash->{'perlvar'}->{'lonBalancer'} eq 'yes') {
1562: $currbalancer = $server;
1563: $currtargets = {};
1564: if (ref($returnhash->{'spareid'}) eq 'HASH') {
1565: if (ref($returnhash->{'spareid'}->{'primary'}) eq 'ARRAY') {
1566: $currtargets->{'primary'} = $returnhash->{'spareid'}->{'primary'};
1567: }
1568: if (ref($returnhash->{'spareid'}->{'default'}) eq 'ARRAY') {
1569: $currtargets->{'default'} = $returnhash->{'spareid'}->{'default'};
1570: }
1571: }
1572: last;
1573: }
1574: }
1575: }
1576: }
1577: }
1578: }
1579: return ($currbalancer,$currtargets);
1580: }
1581:
1582: sub check_loadbalancing {
1583: my ($uname,$udom,$caller) = @_;
1584: my ($is_balancer,$currtargets,$currrules,$dom_in_use,$homeintdom,
1585: $rule_in_effect,$offloadto,$otherserver,$setcookie,$dom_balancers);
1586: my $lonhost = $perlvar{'lonHostID'};
1587: my @hosts = ¤t_machine_ids();
1588: my $uprimary_id = &Apache::lonnet::domain($udom,'primary');
1589: my $uintdom = &Apache::lonnet::internet_dom($uprimary_id);
1590: my $intdom = &Apache::lonnet::internet_dom($lonhost);
1591: my $serverhomedom = &host_domain($lonhost);
1592: my $domneedscache;
1593: my $cachetime = 60*60*24;
1594:
1595: if (($uintdom ne '') && ($uintdom eq $intdom)) {
1596: $dom_in_use = $udom;
1597: $homeintdom = 1;
1598: } else {
1599: $dom_in_use = $serverhomedom;
1600: }
1601: my ($result,$cached)=&is_cached_new('loadbalancing',$dom_in_use);
1602: unless (defined($cached)) {
1603: my %domconfig =
1604: &Apache::lonnet::get_dom('configuration',['loadbalancing'],$dom_in_use);
1605: if (ref($domconfig{'loadbalancing'}) eq 'HASH') {
1606: $result = &do_cache_new('loadbalancing',$dom_in_use,$domconfig{'loadbalancing'},$cachetime);
1607: } else {
1608: $domneedscache = $dom_in_use;
1609: }
1610: }
1611: if (ref($result) eq 'HASH') {
1612: ($is_balancer,$currtargets,$currrules,$setcookie,$dom_balancers) =
1613: &check_balancer_result($result,@hosts);
1614: if ($is_balancer) {
1615: if (ref($currrules) eq 'HASH') {
1616: if ($homeintdom) {
1617: if ($uname ne '') {
1618: if (($currrules->{'_LC_adv'} ne '') || ($currrules->{'_LC_author'} ne '')) {
1619: my ($is_adv,$is_author) = &is_advanced_user($udom,$uname);
1620: if (($currrules->{'_LC_author'} ne '') && ($is_author)) {
1621: $rule_in_effect = $currrules->{'_LC_author'};
1622: } elsif (($currrules->{'_LC_adv'} ne '') && ($is_adv)) {
1623: $rule_in_effect = $currrules->{'_LC_adv'}
1624: }
1625: }
1626: if ($rule_in_effect eq '') {
1627: my %userenv = &userenvironment($udom,$uname,'inststatus');
1628: if ($userenv{'inststatus'} ne '') {
1629: my @statuses = map { &unescape($_); } split(/:/,$userenv{'inststatus'});
1630: my ($othertitle,$usertypes,$types) =
1631: &Apache::loncommon::sorted_inst_types($udom);
1632: if (ref($types) eq 'ARRAY') {
1633: foreach my $type (@{$types}) {
1634: if (grep(/^\Q$type\E$/,@statuses)) {
1635: if (exists($currrules->{$type})) {
1636: $rule_in_effect = $currrules->{$type};
1637: }
1638: }
1639: }
1640: }
1641: } else {
1642: if (exists($currrules->{'default'})) {
1643: $rule_in_effect = $currrules->{'default'};
1644: }
1645: }
1646: }
1647: } else {
1648: if (exists($currrules->{'default'})) {
1649: $rule_in_effect = $currrules->{'default'};
1650: }
1651: }
1652: } else {
1653: if ($currrules->{'_LC_external'} ne '') {
1654: $rule_in_effect = $currrules->{'_LC_external'};
1655: }
1656: }
1657: $offloadto = &get_loadbalancer_targets($rule_in_effect,$currtargets,
1658: $uname,$udom);
1659: }
1660: }
1661: } elsif (($homeintdom) && ($udom ne $serverhomedom)) {
1662: ($result,$cached)=&is_cached_new('loadbalancing',$serverhomedom);
1663: unless (defined($cached)) {
1664: my %domconfig =
1665: &Apache::lonnet::get_dom('configuration',['loadbalancing'],$serverhomedom);
1666: if (ref($domconfig{'loadbalancing'}) eq 'HASH') {
1667: $result = &do_cache_new('loadbalancing',$serverhomedom,$domconfig{'loadbalancing'},$cachetime);
1668: } else {
1669: $domneedscache = $serverhomedom;
1670: }
1671: }
1672: if (ref($result) eq 'HASH') {
1673: ($is_balancer,$currtargets,$currrules,$setcookie,$dom_balancers) =
1674: &check_balancer_result($result,@hosts);
1675: if ($is_balancer) {
1676: if (ref($currrules) eq 'HASH') {
1677: if ($currrules->{'_LC_internetdom'} ne '') {
1678: $rule_in_effect = $currrules->{'_LC_internetdom'};
1679: }
1680: }
1681: $offloadto = &get_loadbalancer_targets($rule_in_effect,$currtargets,
1682: $uname,$udom);
1683: }
1684: } else {
1685: if ($perlvar{'lonBalancer'} eq 'yes') {
1686: $is_balancer = 1;
1687: $offloadto = &this_host_spares($dom_in_use);
1688: }
1689: unless (defined($cached)) {
1690: $domneedscache = $serverhomedom;
1691: }
1692: }
1693: } else {
1694: if ($perlvar{'lonBalancer'} eq 'yes') {
1695: $is_balancer = 1;
1696: $offloadto = &this_host_spares($dom_in_use);
1697: }
1698: unless (defined($cached)) {
1699: $domneedscache = $serverhomedom;
1700: }
1701: }
1702: if ($domneedscache) {
1703: &do_cache_new('loadbalancing',$domneedscache,$is_balancer,$cachetime);
1704: }
1705: if (($is_balancer) && ($caller ne 'switchserver')) {
1706: my $lowest_load = 30000;
1707: if (ref($offloadto) eq 'HASH') {
1708: if (ref($offloadto->{'primary'}) eq 'ARRAY') {
1709: foreach my $try_server (@{$offloadto->{'primary'}}) {
1710: ($otherserver,$lowest_load) =
1711: &compare_server_load($try_server,$otherserver,$lowest_load);
1712: }
1713: }
1714: my $found_server = ($otherserver ne '' && $lowest_load < 100);
1715:
1716: if (!$found_server) {
1717: if (ref($offloadto->{'default'}) eq 'ARRAY') {
1718: foreach my $try_server (@{$offloadto->{'default'}}) {
1719: ($otherserver,$lowest_load) =
1720: &compare_server_load($try_server,$otherserver,$lowest_load);
1721: }
1722: }
1723: }
1724: } elsif (ref($offloadto) eq 'ARRAY') {
1725: if (@{$offloadto} == 1) {
1726: $otherserver = $offloadto->[0];
1727: } elsif (@{$offloadto} > 1) {
1728: foreach my $try_server (@{$offloadto}) {
1729: ($otherserver,$lowest_load) =
1730: &compare_server_load($try_server,$otherserver,$lowest_load);
1731: }
1732: }
1733: }
1734: unless ($caller eq 'login') {
1735: if (($otherserver ne '') && (grep(/^\Q$otherserver\E$/,@hosts))) {
1736: $is_balancer = 0;
1737: if ($uname ne '' && $udom ne '') {
1738: if (($env{'user.name'} eq $uname) && ($env{'user.domain'} eq $udom)) {
1739: &appenv({'user.loadbalexempt' => $lonhost,
1740: 'user.loadbalcheck.time' => time});
1741: }
1742: }
1743: }
1744: }
1745: }
1746: if (($is_balancer) && (!$homeintdom)) {
1747: undef($setcookie);
1748: }
1749: return ($is_balancer,$otherserver,$setcookie,$offloadto,$dom_balancers);
1750: }
1751:
1752: sub check_balancer_result {
1753: my ($result,@hosts) = @_;
1754: my ($is_balancer,$currtargets,$currrules,$setcookie,$dom_balancers);
1755: if (ref($result) eq 'HASH') {
1756: if ($result->{'lonhost'} ne '') {
1757: my $currbalancer = $result->{'lonhost'};
1758: if (grep(/^\Q$currbalancer\E$/,@hosts)) {
1759: $is_balancer = 1;
1760: $currtargets = $result->{'targets'};
1761: $currrules = $result->{'rules'};
1762: }
1763: $dom_balancers = $currbalancer;
1764: } else {
1765: if (keys(%{$result})) {
1766: foreach my $key (keys(%{$result})) {
1767: if (($key ne '') && (grep(/^\Q$key\E$/,@hosts)) &&
1768: (ref($result->{$key}) eq 'HASH')) {
1769: $is_balancer = 1;
1770: $currrules = $result->{$key}{'rules'};
1771: $currtargets = $result->{$key}{'targets'};
1772: $setcookie = $result->{$key}{'cookie'};
1773: last;
1774: }
1775: }
1776: $dom_balancers = join(',',sort(keys(%{$result})));
1777: }
1778: }
1779: }
1780: return ($is_balancer,$currtargets,$currrules,$setcookie,$dom_balancers);
1781: }
1782:
1783: sub get_loadbalancer_targets {
1784: my ($rule_in_effect,$currtargets,$uname,$udom) = @_;
1785: my $offloadto;
1786: if ($rule_in_effect eq 'none') {
1787: return [$perlvar{'lonHostID'}];
1788: } elsif ($rule_in_effect eq '') {
1789: $offloadto = $currtargets;
1790: } else {
1791: if ($rule_in_effect eq 'homeserver') {
1792: my $homeserver = &homeserver($uname,$udom);
1793: if ($homeserver ne 'no_host') {
1794: $offloadto = [$homeserver];
1795: }
1796: } elsif ($rule_in_effect eq 'externalbalancer') {
1797: my %domconfig =
1798: &Apache::lonnet::get_dom('configuration',['loadbalancing'],$udom);
1799: if (ref($domconfig{'loadbalancing'}) eq 'HASH') {
1800: if ($domconfig{'loadbalancing'}{'lonhost'} ne '') {
1801: if (&hostname($domconfig{'loadbalancing'}{'lonhost'}) ne '') {
1802: $offloadto = [$domconfig{'loadbalancing'}{'lonhost'}];
1803: }
1804: }
1805: } else {
1806: my %servers = &internet_dom_servers($udom);
1807: my ($remotebalancer,$remotetargets) = &get_lonbalancer_config(\%servers);
1808: if (&hostname($remotebalancer) ne '') {
1809: $offloadto = [$remotebalancer];
1810: }
1811: }
1812: } elsif (&hostname($rule_in_effect) ne '') {
1813: $offloadto = [$rule_in_effect];
1814: }
1815: }
1816: return $offloadto;
1817: }
1818:
1819: sub internet_dom_servers {
1820: my ($dom) = @_;
1821: my (%uniqservers,%servers);
1822: my $primaryserver = &hostname(&domain($dom,'primary'));
1823: my @machinedoms = &machine_domains($primaryserver);
1824: foreach my $mdom (@machinedoms) {
1825: my %currservers = %servers;
1826: my %server = &get_servers($mdom);
1827: %servers = (%currservers,%server);
1828: }
1829: my %by_hostname;
1830: foreach my $id (keys(%servers)) {
1831: push(@{$by_hostname{$servers{$id}}},$id);
1832: }
1833: foreach my $hostname (sort(keys(%by_hostname))) {
1834: if (@{$by_hostname{$hostname}} > 1) {
1835: my $match = 0;
1836: foreach my $id (@{$by_hostname{$hostname}}) {
1837: if (&host_domain($id) eq $dom) {
1838: $uniqservers{$id} = $hostname;
1839: $match = 1;
1840: }
1841: }
1842: unless ($match) {
1843: $uniqservers{$by_hostname{$hostname}[0]} = $hostname;
1844: }
1845: } else {
1846: $uniqservers{$by_hostname{$hostname}[0]} = $hostname;
1847: }
1848: }
1849: return %uniqservers;
1850: }
1851:
1852: sub trusted_domains {
1853: my ($cmdtype,$calldom) = @_;
1854: my ($trusted,$untrusted);
1855: if (&domain($calldom) eq '') {
1856: return ($trusted,$untrusted);
1857: }
1858: unless ($cmdtype =~ /^(content|shared|enroll|coaurem|othcoau|domroles|catalog|reqcrs|msg)$/) {
1859: return ($trusted,$untrusted);
1860: }
1861: my $callprimary = &domain($calldom,'primary');
1862: my $intcalldom = &Apache::lonnet::internet_dom($callprimary);
1863: if ($intcalldom eq '') {
1864: return ($trusted,$untrusted);
1865: }
1866:
1867: my ($trustconfig,$cached)=&Apache::lonnet::is_cached_new('trust',$calldom);
1868: unless (defined($cached)) {
1869: my %domconfig = &Apache::lonnet::get_dom('configuration',['trust'],$calldom);
1870: &Apache::lonnet::do_cache_new('trust',$calldom,$domconfig{'trust'},3600);
1871: $trustconfig = $domconfig{'trust'};
1872: }
1873: if (ref($trustconfig)) {
1874: my (%possexc,%possinc,@allexc,@allinc);
1875: if (ref($trustconfig->{$cmdtype}) eq 'HASH') {
1876: if (ref($trustconfig->{$cmdtype}->{'exc'}) eq 'ARRAY') {
1877: map { $possexc{$_} = 1; } @{$trustconfig->{$cmdtype}->{'exc'}};
1878: }
1879: if (ref($trustconfig->{$cmdtype}->{'inc'}) eq 'ARRAY') {
1880: $possinc{$intcalldom} = 1;
1881: map { $possinc{$_} = 1; } @{$trustconfig->{$cmdtype}->{'inc'}};
1882: }
1883: }
1884: if (keys(%possexc)) {
1885: if (keys(%possinc)) {
1886: foreach my $key (sort(keys(%possexc))) {
1887: next if ($key eq $intcalldom);
1888: unless ($possinc{$key}) {
1889: push(@allexc,$key);
1890: }
1891: }
1892: } else {
1893: @allexc = sort(keys(%possexc));
1894: }
1895: }
1896: if (keys(%possinc)) {
1897: $possinc{$intcalldom} = 1;
1898: @allinc = sort(keys(%possinc));
1899: }
1900: if ((@allexc > 0) || (@allinc > 0)) {
1901: my %doms_by_intdom;
1902: my %allintdoms = &all_host_intdom();
1903: my %alldoms = &all_host_domain();
1904: foreach my $key (%allintdoms) {
1905: if (ref($doms_by_intdom{$allintdoms{$key}}) eq 'ARRAY') {
1906: unless (grep(/^\Q$alldoms{$key}\E$/,@{$doms_by_intdom{$allintdoms{$key}}})) {
1907: push(@{$doms_by_intdom{$allintdoms{$key}}},$alldoms{$key});
1908: }
1909: } else {
1910: $doms_by_intdom{$allintdoms{$key}} = [$alldoms{$key}];
1911: }
1912: }
1913: foreach my $exc (@allexc) {
1914: if (ref($doms_by_intdom{$exc}) eq 'ARRAY') {
1915: push(@{$untrusted},@{$doms_by_intdom{$exc}});
1916: }
1917: }
1918: foreach my $inc (@allinc) {
1919: if (ref($doms_by_intdom{$inc}) eq 'ARRAY') {
1920: push(@{$trusted},@{$doms_by_intdom{$inc}});
1921: }
1922: }
1923: }
1924: }
1925: return ($trusted,$untrusted);
1926: }
1927:
1928: sub will_trust {
1929: my ($cmdtype,$domain,$possdom) = @_;
1930: return 1 if ($domain eq $possdom);
1931: my ($trustedref,$untrustedref) = &trusted_domains($cmdtype,$possdom);
1932: my $willtrust;
1933: if ((ref($trustedref) eq 'ARRAY') && (@{$trustedref} > 0)) {
1934: if (grep(/^\Q$domain\E$/,@{$trustedref})) {
1935: $willtrust = 1;
1936: }
1937: } elsif ((ref($untrustedref) eq 'ARRAY') && (@{$untrustedref} > 0)) {
1938: unless (grep(/^\Q$domain\E$/,@{$untrustedref})) {
1939: $willtrust = 1;
1940: }
1941: } else {
1942: $willtrust = 1;
1943: }
1944: return $willtrust;
1945: }
1946:
1947: # ---------------------- Find the homebase for a user from domain's lib servers
1948:
1949: my %homecache;
1950: sub homeserver {
1951: my ($uname,$udom,$ignoreBadCache)=@_;
1952: my $index="$uname:$udom";
1953:
1954: if (exists($homecache{$index})) { return $homecache{$index}; }
1955:
1956: my %servers = &get_servers($udom,'library');
1957: foreach my $tryserver (keys(%servers)) {
1958: next if ($ignoreBadCache ne 'true' &&
1959: exists($badServerCache{$tryserver}));
1960:
1961: my $answer=reply("home:$udom:$uname",$tryserver);
1962: if ($answer eq 'found') {
1963: delete($badServerCache{$tryserver});
1964: return $homecache{$index}=$tryserver;
1965: } elsif ($answer eq 'no_host') {
1966: $badServerCache{$tryserver}=1;
1967: }
1968: }
1969: return 'no_host';
1970: }
1971:
1972: # ----- Find the usernames behind a list of student/employee IDs or clicker IDs
1973:
1974: sub idget {
1975: my ($udom,$idsref,$namespace)=@_;
1976: my %returnhash=();
1977: my @ids=();
1978: if (ref($idsref) eq 'ARRAY') {
1979: @ids = @{$idsref};
1980: } else {
1981: return %returnhash;
1982: }
1983: if ($namespace eq '') {
1984: $namespace = 'ids';
1985: }
1986:
1987: my %servers = &get_servers($udom,'library');
1988: foreach my $tryserver (keys(%servers)) {
1989: my $idlist=join('&', map { &escape($_); } @ids);
1990: if ($namespace eq 'ids') {
1991: $idlist=~tr/A-Z/a-z/;
1992: }
1993: my $reply;
1994: if ($namespace eq 'ids') {
1995: $reply=&reply("idget:$udom:".$idlist,$tryserver);
1996: } else {
1997: $reply=&reply("getdom:$udom:$namespace:$idlist",$tryserver);
1998: }
1999: my @answer=();
2000: if (($reply ne 'con_lost') && ($reply!~/^error\:/)) {
2001: @answer=split(/\&/,$reply);
2002: } ;
2003: my $i;
2004: for ($i=0;$i<=$#ids;$i++) {
2005: if ($answer[$i]) {
2006: $returnhash{$ids[$i]}=&unescape($answer[$i]);
2007: }
2008: }
2009: }
2010: return %returnhash;
2011: }
2012:
2013: # ------------------------------------- Find the IDs behind a list of usernames
2014:
2015: sub idrget {
2016: my ($udom,@unames)=@_;
2017: my %returnhash=();
2018: foreach my $uname (@unames) {
2019: $returnhash{$uname}=(&userenvironment($udom,$uname,'id'))[1];
2020: }
2021: return %returnhash;
2022: }
2023:
2024: # Store away a list of names and associated student/employee IDs or clicker IDs
2025:
2026: sub idput {
2027: my ($udom,$idsref,$uhom,$namespace)=@_;
2028: my %servers=();
2029: my %ids=();
2030: my %byid = ();
2031: if (ref($idsref) eq 'HASH') {
2032: %ids=%{$idsref};
2033: }
2034: if ($namespace eq '') {
2035: $namespace = 'ids';
2036: }
2037: foreach my $uname (keys(%ids)) {
2038: &cput('environment',{'id'=>$ids{$uname}},$udom,$uname);
2039: if ($uhom eq '') {
2040: $uhom=&homeserver($uname,$udom);
2041: }
2042: if ($uhom ne 'no_host') {
2043: my $esc_unam=&escape($uname);
2044: if ($namespace eq 'ids') {
2045: my $id=&escape($ids{$uname});
2046: $id=~tr/A-Z/a-z/;
2047: my $esc_unam=&escape($uname);
2048: $servers{$uhom}.=$id.'='.$esc_unam.'&';
2049: } else {
2050: my @currids = split(/,/,$ids{$uname});
2051: foreach my $id (@currids) {
2052: $byid{$uhom}{$id} .= $uname.',';
2053: }
2054: }
2055: }
2056: }
2057: if ($namespace eq 'clickers') {
2058: foreach my $server (keys(%byid)) {
2059: if (ref($byid{$server}) eq 'HASH') {
2060: foreach my $id (keys(%{$byid{$server}})) {
2061: $byid{$server} =~ s/,$//;
2062: $servers{$uhom}.=&escape($id).'='.&escape($byid{$server}).'&';
2063: }
2064: }
2065: }
2066: }
2067: foreach my $server (keys(%servers)) {
2068: $servers{$server} =~ s/\&$//;
2069: if ($namespace eq 'ids') {
2070: &critical('idput:'.$udom.':'.$servers{$server},$server);
2071: } else {
2072: &critical('updateclickers:'.$udom.':add:'.$servers{$server},$server);
2073: }
2074: }
2075: }
2076:
2077: # ------------- Delete unwanted student/employee IDs or clicker IDs from domain
2078:
2079: sub iddel {
2080: my ($udom,$idshashref,$uhome,$namespace)=@_;
2081: my %result=();
2082: my %ids=();
2083: my %byid = ();
2084: if (ref($idshashref) eq 'HASH') {
2085: %ids=%{$idshashref};
2086: } else {
2087: return %result;
2088: }
2089: if ($namespace eq '') {
2090: $namespace = 'ids';
2091: }
2092: my %servers=();
2093: while (my ($id,$unamestr) = each(%ids)) {
2094: if ($namespace eq 'ids') {
2095: my $uhom = $uhome;
2096: if ($uhom eq '') {
2097: $uhom=&homeserver($unamestr,$udom);
2098: }
2099: if ($uhom ne 'no_host') {
2100: $servers{$uhom}.='&'.&escape($id);
2101: }
2102: } else {
2103: my @curritems = split(/,/,$ids{$id});
2104: foreach my $uname (@curritems) {
2105: my $uhom = $uhome;
2106: if ($uhom eq '') {
2107: $uhom=&homeserver($uname,$udom);
2108: }
2109: if ($uhom ne 'no_host') {
2110: $byid{$uhom}{$id} .= $uname.',';
2111: }
2112: }
2113: }
2114: }
2115: if ($namespace eq 'clickers') {
2116: foreach my $server (keys(%byid)) {
2117: if (ref($byid{$server}) eq 'HASH') {
2118: foreach my $id (keys(%{$byid{$server}})) {
2119: $byid{$server}{$id} =~ s/,$//;
2120: $servers{$server}.=&escape($id).'='.&escape($byid{$server}{$id}).'&';
2121: }
2122: }
2123: }
2124: }
2125: foreach my $server (keys(%servers)) {
2126: $servers{$server} =~ s/\&$//;
2127: if ($namespace eq 'ids') {
2128: $result{$server} = &critical('iddel:'.$udom.':'.$servers{$server},$uhome);
2129: } elsif ($namespace eq 'clickers') {
2130: $result{$server} = &critical('updateclickers:'.$udom.':del:'.$servers{$server},$server);
2131: }
2132: }
2133: return %result;
2134: }
2135:
2136: # ----- Update clicker ID-to-username look-ups in clickers.db on library server
2137:
2138: sub updateclickers {
2139: my ($udom,$action,$idshashref,$uhome,$critical) = @_;
2140: my %clickers;
2141: if (ref($idshashref) eq 'HASH') {
2142: %clickers=%{$idshashref};
2143: } else {
2144: return;
2145: }
2146: my $items='';
2147: foreach my $item (keys(%clickers)) {
2148: $items.=&escape($item).'='.&escape($clickers{$item}).'&';
2149: }
2150: $items=~s/\&$//;
2151: my $request = "updateclickers:$udom:$action:$items";
2152: if ($critical) {
2153: return &critical($request,$uhome);
2154: } else {
2155: return &reply($request,$uhome);
2156: }
2157: }
2158:
2159: # ------------------------------dump from db file owned by domainconfig user
2160: sub dump_dom {
2161: my ($namespace, $udom, $regexp) = @_;
2162:
2163: $udom ||= $env{'user.domain'};
2164:
2165: return () unless $udom;
2166:
2167: return &dump($namespace, $udom, &get_domainconfiguser($udom), $regexp);
2168: }
2169:
2170: # ------------------------------------------ get items from domain db files
2171:
2172: sub get_dom {
2173: my ($namespace,$storearr,$udom,$uhome,$encrypt)=@_;
2174: return if ($udom eq 'public');
2175: my $items='';
2176: foreach my $item (@$storearr) {
2177: $items.=&escape($item).'&';
2178: }
2179: $items=~s/\&$//;
2180: if (!$udom) {
2181: $udom=$env{'user.domain'};
2182: return if ($udom eq 'public');
2183: if (defined(&domain($udom,'primary'))) {
2184: $uhome=&domain($udom,'primary');
2185: } else {
2186: undef($uhome);
2187: }
2188: } else {
2189: if (!$uhome) {
2190: if (defined(&domain($udom,'primary'))) {
2191: $uhome=&domain($udom,'primary');
2192: }
2193: }
2194: }
2195: if ($udom && $uhome && ($uhome ne 'no_host')) {
2196: my $rep;
2197: if (grep { $_ eq $uhome } ¤t_machine_ids()) {
2198: # domain information is hosted on this machine
2199: $rep = &LONCAPA::Lond::get_dom("getdom:$udom:$namespace:$items");
2200: } else {
2201: if ($encrypt) {
2202: $rep=&reply("encrypt:egetdom:$udom:$namespace:$items",$uhome);
2203: } else {
2204: $rep=&reply("getdom:$udom:$namespace:$items",$uhome);
2205: }
2206: }
2207: my %returnhash;
2208: if ($rep eq '' || $rep =~ /^error: 2 /) {
2209: return %returnhash;
2210: }
2211: my @pairs=split(/\&/,$rep);
2212: if ( $#pairs==0 && $pairs[0] =~ /^(con_lost|error|no_such_host)/i) {
2213: return @pairs;
2214: }
2215: my $i=0;
2216: foreach my $item (@$storearr) {
2217: $returnhash{$item}=&thaw_unescape($pairs[$i]);
2218: $i++;
2219: }
2220: return %returnhash;
2221: } else {
2222: &logthis("get_dom failed - no homeserver and/or domain ($udom) ($uhome)");
2223: }
2224: }
2225:
2226: # -------------------------------------------- put items in domain db files
2227:
2228: sub put_dom {
2229: my ($namespace,$storehash,$udom,$uhome,$encrypt)=@_;
2230: if (!$udom) {
2231: $udom=$env{'user.domain'};
2232: if (defined(&domain($udom,'primary'))) {
2233: $uhome=&domain($udom,'primary');
2234: } else {
2235: undef($uhome);
2236: }
2237: } else {
2238: if (!$uhome) {
2239: if (defined(&domain($udom,'primary'))) {
2240: $uhome=&domain($udom,'primary');
2241: }
2242: }
2243: }
2244: if ($udom && $uhome && ($uhome ne 'no_host')) {
2245: my $items='';
2246: foreach my $item (keys(%$storehash)) {
2247: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
2248: }
2249: $items=~s/\&$//;
2250: if ($encrypt) {
2251: return &reply("encrypt:putdom:$udom:$namespace:$items",$uhome);
2252: } else {
2253: return &reply("putdom:$udom:$namespace:$items",$uhome);
2254: }
2255: } else {
2256: &logthis("put_dom failed - no homeserver and/or domain");
2257: }
2258: }
2259:
2260: # --------------------- newput for items in db file owned by domainconfig user
2261: sub newput_dom {
2262: my ($namespace,$storehash,$udom) = @_;
2263: my $result;
2264: if (!$udom) {
2265: $udom=$env{'user.domain'};
2266: }
2267: if ($udom) {
2268: my $uname = &get_domainconfiguser($udom);
2269: $result = &newput($namespace,$storehash,$udom,$uname);
2270: }
2271: return $result;
2272: }
2273:
2274: # --------------------- delete for items in db file owned by domainconfig user
2275: sub del_dom {
2276: my ($namespace,$storearr,$udom)=@_;
2277: if (ref($storearr) eq 'ARRAY') {
2278: if (!$udom) {
2279: $udom=$env{'user.domain'};
2280: }
2281: if ($udom) {
2282: my $uname = &get_domainconfiguser($udom);
2283: return &del($namespace,$storearr,$udom,$uname);
2284: }
2285: }
2286: }
2287:
2288: sub store_dom {
2289: my ($storehash,$id,$namespace,$dom,$home,$encrypt) = @_;
2290: $$storehash{'ip'}=&get_requestor_ip();
2291: $$storehash{'host'}=$perlvar{'lonHostID'};
2292: my $namevalue='';
2293: foreach my $key (keys(%{$storehash})) {
2294: $namevalue.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
2295: }
2296: $namevalue=~s/\&$//;
2297: if (grep { $_ eq $home } current_machine_ids()) {
2298: return LONCAPA::Lond::store_dom("storedom:$dom:$namespace:$id:$namevalue");
2299: } else {
2300: if ($namespace eq 'private') {
2301: return 'refused';
2302: } elsif ($encrypt) {
2303: return reply("encrypt:storedom:$dom:$namespace:$id:$namevalue",$home);
2304: } else {
2305: return reply("storedom:$dom:$namespace:$id:$namevalue",$home);
2306: }
2307: }
2308: }
2309:
2310: sub restore_dom {
2311: my ($id,$namespace,$dom,$home,$encrypt) = @_;
2312: my $answer;
2313: if (grep { $_ eq $home } current_machine_ids()) {
2314: $answer = LONCAPA::Lond::restore_dom("restoredom:$dom:$namespace:$id");
2315: } elsif ($namespace ne 'private') {
2316: if ($encrypt) {
2317: $answer=&reply("encrypt:restoredom:$dom:$namespace:$id",$home);
2318: } else {
2319: $answer=&reply("restoredom:$dom:$namespace:$id",$home);
2320: }
2321: }
2322: my %returnhash=();
2323: unless (($answer eq '') || ($answer eq 'con_lost') || ($answer eq 'refused') ||
2324: ($answer eq 'unknown_cmd') || ($answer eq 'rejected')) {
2325: foreach my $line (split(/\&/,$answer)) {
2326: my ($name,$value)=split(/\=/,$line);
2327: $returnhash{&unescape($name)}=&thaw_unescape($value);
2328: }
2329: my $version;
2330: for ($version=1;$version<=$returnhash{'version'};$version++) {
2331: foreach my $item (split(/\:/,$returnhash{$version.':keys'})) {
2332: $returnhash{$item}=$returnhash{$version.':'.$item};
2333: }
2334: }
2335: }
2336: return %returnhash;
2337: }
2338:
2339: # ----------------------------------construct domainconfig user for a domain
2340: sub get_domainconfiguser {
2341: my ($udom) = @_;
2342: return $udom.'-domainconfig';
2343: }
2344:
2345: sub retrieve_inst_usertypes {
2346: my ($udom) = @_;
2347: my (%returnhash,@order);
2348: my %domdefs = &Apache::lonnet::get_domain_defaults($udom);
2349: if ((ref($domdefs{'inststatustypes'}) eq 'HASH') &&
2350: (ref($domdefs{'inststatusorder'}) eq 'ARRAY')) {
2351: return ($domdefs{'inststatustypes'},$domdefs{'inststatusorder'});
2352: } else {
2353: if (defined(&domain($udom,'primary'))) {
2354: my $uhome=&domain($udom,'primary');
2355: my $rep=&reply("inst_usertypes:$udom",$uhome);
2356: if ($rep =~ /^(con_lost|error|no_such_host|refused)/) {
2357: &logthis("retrieve_inst_usertypes failed - $rep returned from $uhome in domain: $udom");
2358: return (\%returnhash,\@order);
2359: }
2360: my ($hashitems,$orderitems) = split(/:/,$rep);
2361: my @pairs=split(/\&/,$hashitems);
2362: foreach my $item (@pairs) {
2363: my ($key,$value)=split(/=/,$item,2);
2364: $key = &unescape($key);
2365: next if ($key =~ /^error: 2 /);
2366: $returnhash{$key}=&thaw_unescape($value);
2367: }
2368: my @esc_order = split(/\&/,$orderitems);
2369: foreach my $item (@esc_order) {
2370: push(@order,&unescape($item));
2371: }
2372: } else {
2373: &logthis("retrieve_inst_usertypes failed - no primary domain server for $udom");
2374: }
2375: return (\%returnhash,\@order);
2376: }
2377: }
2378:
2379: sub is_domainimage {
2380: my ($url) = @_;
2381: if ($url=~m-^/+res/+($match_domain)/+\1\-domainconfig/+(img|logo|domlogo|login)/+[^/]-) {
2382: if (&domain($1) ne '') {
2383: return '1';
2384: }
2385: }
2386: return;
2387: }
2388:
2389: sub inst_directory_query {
2390: my ($srch) = @_;
2391: my $udom = $srch->{'srchdomain'};
2392: my %results;
2393: my $homeserver = &domain($udom,'primary');
2394: my $outcome;
2395: if ($homeserver ne '') {
2396: unless ($homeserver eq $perlvar{'lonHostID'}) {
2397: if ($srch->{'srchby'} eq 'email') {
2398: my $lcrev = &get_server_loncaparev($udom,$homeserver);
2399: my ($major,$minor) = ($lcrev =~ /^\'?(\d+)\.(\d+)\.[\w.\-]+\'?$/);
2400: if (($major eq '' && $minor eq '') || ($major < 2) ||
2401: (($major == 2) && ($minor < 12))) {
2402: return;
2403: }
2404: }
2405: }
2406: my $queryid=&reply("querysend:instdirsearch:".
2407: &escape($srch->{'srchby'}).':'.
2408: &escape($srch->{'srchterm'}).':'.
2409: &escape($srch->{'srchtype'}),$homeserver);
2410: my $host=&hostname($homeserver);
2411: if ($queryid !~/^\Q$host\E\_/) {
2412: &logthis('institutional directory search invalid queryid: '.$queryid.' for host: '.$homeserver.' in domain '.$udom);
2413: return;
2414: }
2415: my $response = &get_query_reply($queryid);
2416: my $maxtries = 5;
2417: my $tries = 1;
2418: while (($response=~/^timeout/) && ($tries < $maxtries)) {
2419: $response = &get_query_reply($queryid);
2420: $tries ++;
2421: }
2422:
2423: if (!&error($response) && $response ne 'refused') {
2424: if ($response eq 'unavailable') {
2425: $outcome = $response;
2426: } else {
2427: $outcome = 'ok';
2428: my @matches = split(/\n/,$response);
2429: foreach my $match (@matches) {
2430: my ($key,$value) = split(/=/,$match);
2431: $results{&unescape($key).':'.$udom} = &thaw_unescape($value);
2432: }
2433: }
2434: }
2435: }
2436: return ($outcome,%results);
2437: }
2438:
2439: sub usersearch {
2440: my ($srch) = @_;
2441: my $dom = $srch->{'srchdomain'};
2442: my %results;
2443: my %libserv = &all_library();
2444: my $query = 'usersearch';
2445: foreach my $tryserver (keys(%libserv)) {
2446: if (&host_domain($tryserver) eq $dom) {
2447: unless ($tryserver eq $perlvar{'lonHostID'}) {
2448: if ($srch->{'srchby'} eq 'email') {
2449: my $lcrev = &get_server_loncaparev($dom,$tryserver);
2450: my ($major,$minor) = ($lcrev =~ /^\'?(\d+)\.(\d+)\.[\w.\-]+\'?$/);
2451: next if (($major eq '' && $minor eq '') || ($major < 2) ||
2452: (($major == 2) && ($minor < 12)));
2453: }
2454: }
2455: my $host=&hostname($tryserver);
2456: my $queryid=
2457: &reply("querysend:".&escape($query).':'.
2458: &escape($srch->{'srchby'}).':'.
2459: &escape($srch->{'srchtype'}).':'.
2460: &escape($srch->{'srchterm'}),$tryserver);
2461: if ($queryid !~/^\Q$host\E\_/) {
2462: &logthis('usersearch: invalid queryid: '.$queryid.' for host: '.$host.'in domain '.$dom.' and server: '.$tryserver);
2463: next;
2464: }
2465: my $reply = &get_query_reply($queryid);
2466: my $maxtries = 1;
2467: my $tries = 1;
2468: while (($reply=~/^timeout/) && ($tries < $maxtries)) {
2469: $reply = &get_query_reply($queryid);
2470: $tries ++;
2471: }
2472: if ( ($reply =~/^timeout/) || ($reply =~/^error/) ) {
2473: &logthis('usersrch error: '.$reply.' for '.$dom.' - searching for : '.$srch->{'srchterm'}.' by '.$srch->{'srchby'}.' ('.$srch->{'srchtype'}.') - maxtries: '.$maxtries.' tries: '.$tries);
2474: } else {
2475: my @matches;
2476: if ($reply =~ /\n/) {
2477: @matches = split(/\n/,$reply);
2478: } else {
2479: @matches = split(/\&/,$reply);
2480: }
2481: foreach my $match (@matches) {
2482: my ($uname,$udom,%userhash);
2483: foreach my $entry (split(/:/,$match)) {
2484: my ($key,$value) =
2485: map {&unescape($_);} split(/=/,$entry);
2486: $userhash{$key} = $value;
2487: if ($key eq 'username') {
2488: $uname = $value;
2489: } elsif ($key eq 'domain') {
2490: $udom = $value;
2491: }
2492: }
2493: $results{$uname.':'.$udom} = \%userhash;
2494: }
2495: }
2496: }
2497: }
2498: return %results;
2499: }
2500:
2501: sub get_instuser {
2502: my ($udom,$uname,$id) = @_;
2503: my $homeserver = &domain($udom,'primary');
2504: my ($outcome,%results);
2505: if ($homeserver ne '') {
2506: my $queryid=&reply("querysend:getinstuser:".&escape($uname).':'.
2507: &escape($id).':'.&escape($udom),$homeserver);
2508: my $host=&hostname($homeserver);
2509: if ($queryid !~/^\Q$host\E\_/) {
2510: &logthis('get_instuser invalid queryid: '.$queryid.' for host: '.$homeserver.'in domain '.$udom);
2511: return;
2512: }
2513: my $response = &get_query_reply($queryid);
2514: my $maxtries = 5;
2515: my $tries = 1;
2516: while (($response=~/^timeout/) && ($tries < $maxtries)) {
2517: $response = &get_query_reply($queryid);
2518: $tries ++;
2519: }
2520: if (!&error($response) && $response ne 'refused') {
2521: if ($response eq 'unavailable') {
2522: $outcome = $response;
2523: } else {
2524: $outcome = 'ok';
2525: my @matches = split(/\n/,$response);
2526: foreach my $match (@matches) {
2527: my ($key,$value) = split(/=/,$match);
2528: $results{&unescape($key)} = &thaw_unescape($value);
2529: }
2530: }
2531: }
2532: }
2533: my %userinfo;
2534: if (ref($results{$uname}) eq 'HASH') {
2535: %userinfo = %{$results{$uname}};
2536: }
2537: return ($outcome,%userinfo);
2538: }
2539:
2540: sub get_multiple_instusers {
2541: my ($udom,$users,$caller) = @_;
2542: my ($outcome,$results);
2543: if (ref($users) eq 'HASH') {
2544: my $count = keys(%{$users});
2545: my $requested = &freeze_escape($users);
2546: my $homeserver = &domain($udom,'primary');
2547: if ($homeserver ne '') {
2548: my $queryid=&reply('querysend:getmultinstusers:::'.$caller.'='.$requested,$homeserver);
2549: my $host=&hostname($homeserver);
2550: if ($queryid !~/^\Q$host\E\_/) {
2551: &logthis('get_multiple_instusers invalid queryid: '.$queryid.
2552: ' for host: '.$homeserver.'in domain '.$udom);
2553: return ($outcome,$results);
2554: }
2555: my $response = &get_query_reply($queryid);
2556: my $maxtries = 5;
2557: if ($count > 100) {
2558: $maxtries = 1+int($count/20);
2559: }
2560: my $tries = 1;
2561: while (($response=~/^timeout/) && ($tries <= $maxtries)) {
2562: $response = &get_query_reply($queryid);
2563: $tries ++;
2564: }
2565: if ($response eq '') {
2566: $results = {};
2567: foreach my $key (keys(%{$users})) {
2568: my ($uname,$id);
2569: if ($caller eq 'id') {
2570: $id = $key;
2571: } else {
2572: $uname = $key;
2573: }
2574: my ($resp,%info) = &get_instuser($udom,$uname,$id);
2575: $outcome = $resp;
2576: if ($resp eq 'ok') {
2577: %{$results} = (%{$results}, %info);
2578: } else {
2579: last;
2580: }
2581: }
2582: } elsif(!&error($response) && ($response ne 'refused')) {
2583: if (($response eq 'unavailable') || ($response eq 'invalid') || ($response eq 'timeout')) {
2584: $outcome = $response;
2585: } else {
2586: ($outcome,my $userdata) = split(/=/,$response,2);
2587: if ($outcome eq 'ok') {
2588: $results = &thaw_unescape($userdata);
2589: }
2590: }
2591: }
2592: }
2593: }
2594: return ($outcome,$results);
2595: }
2596:
2597: sub inst_rulecheck {
2598: my ($udom,$uname,$id,$item,$rules) = @_;
2599: my %returnhash;
2600: if ($udom ne '') {
2601: if (ref($rules) eq 'ARRAY') {
2602: @{$rules} = map {&escape($_);} (@{$rules});
2603: my $rulestr = join(':',@{$rules});
2604: my $homeserver=&domain($udom,'primary');
2605: if (($homeserver ne '') && ($homeserver ne 'no_host')) {
2606: my $response;
2607: if ($item eq 'username') {
2608: $response=&unescape(&reply('instrulecheck:'.&escape($udom).
2609: ':'.&escape($uname).':'.$rulestr,
2610: $homeserver));
2611: } elsif ($item eq 'id') {
2612: $response=&unescape(&reply('instidrulecheck:'.&escape($udom).
2613: ':'.&escape($id).':'.$rulestr,
2614: $homeserver));
2615: } elsif ($item eq 'selfcreate') {
2616: $response=&unescape(&reply('instselfcreatecheck:'.
2617: &escape($udom).':'.&escape($uname).
2618: ':'.$rulestr,$homeserver));
2619: } elsif ($item eq 'unamemap') {
2620: $response=&unescape(&reply('instunamemapcheck:'.
2621: &escape($udom).':'.&escape($uname).
2622: ':'.$rulestr,$homeserver));
2623: }
2624: if ($response ne 'refused') {
2625: my @pairs=split(/\&/,$response);
2626: foreach my $item (@pairs) {
2627: my ($key,$value)=split(/=/,$item,2);
2628: $key = &unescape($key);
2629: next if ($key =~ /^error: 2 /);
2630: $returnhash{$key}=&thaw_unescape($value);
2631: }
2632: }
2633: }
2634: }
2635: }
2636: return %returnhash;
2637: }
2638:
2639: sub inst_userrules {
2640: my ($udom,$check) = @_;
2641: my (%ruleshash,@ruleorder);
2642: if ($udom ne '') {
2643: my $homeserver=&domain($udom,'primary');
2644: if (($homeserver ne '') && ($homeserver ne 'no_host')) {
2645: my $response;
2646: if ($check eq 'id') {
2647: $response=&reply('instidrules:'.&escape($udom),
2648: $homeserver);
2649: } elsif ($check eq 'email') {
2650: $response=&reply('instemailrules:'.&escape($udom),
2651: $homeserver);
2652: } elsif ($check eq 'unamemap') {
2653: $response=&reply('unamemaprules:'.&escape($udom),
2654: $homeserver);
2655: } else {
2656: $response=&reply('instuserrules:'.&escape($udom),
2657: $homeserver);
2658: }
2659: if (($response ne 'refused') && ($response ne 'error') &&
2660: ($response ne 'unknown_cmd') &&
2661: ($response ne 'no_such_host')) {
2662: my ($hashitems,$orderitems) = split(/:/,$response);
2663: my @pairs=split(/\&/,$hashitems);
2664: foreach my $item (@pairs) {
2665: my ($key,$value)=split(/=/,$item,2);
2666: $key = &unescape($key);
2667: next if ($key =~ /^error: 2 /);
2668: $ruleshash{$key}=&thaw_unescape($value);
2669: }
2670: my @esc_order = split(/\&/,$orderitems);
2671: foreach my $item (@esc_order) {
2672: push(@ruleorder,&unescape($item));
2673: }
2674: }
2675: }
2676: }
2677: return (\%ruleshash,\@ruleorder);
2678: }
2679:
2680: # ------------- Get Authentication, Language and User Tools Defaults for Domain
2681:
2682: sub get_domain_defaults {
2683: my ($domain,$ignore_cache) = @_;
2684: return if (($domain eq '') || ($domain eq 'public'));
2685: my $cachetime = 60*60*24;
2686: unless ($ignore_cache) {
2687: my ($result,$cached)=&is_cached_new('domdefaults',$domain);
2688: if (defined($cached)) {
2689: if (ref($result) eq 'HASH') {
2690: return %{$result};
2691: }
2692: }
2693: }
2694: my %domdefaults;
2695: my %domconfig =
2696: &Apache::lonnet::get_dom('configuration',['defaults','quotas',
2697: 'requestcourses','inststatus',
2698: 'coursedefaults','usersessions',
2699: 'requestauthor','selfenrollment',
2700: 'coursecategories','ssl','autoenroll',
2701: 'trust','helpsettings','wafproxy','ltisec'],$domain);
2702: my @coursetypes = ('official','unofficial','community','textbook','placement');
2703: if (ref($domconfig{'defaults'}) eq 'HASH') {
2704: $domdefaults{'lang_def'} = $domconfig{'defaults'}{'lang_def'};
2705: $domdefaults{'auth_def'} = $domconfig{'defaults'}{'auth_def'};
2706: $domdefaults{'auth_arg_def'} = $domconfig{'defaults'}{'auth_arg_def'};
2707: $domdefaults{'timezone_def'} = $domconfig{'defaults'}{'timezone_def'};
2708: $domdefaults{'datelocale_def'} = $domconfig{'defaults'}{'datelocale_def'};
2709: $domdefaults{'portal_def'} = $domconfig{'defaults'}{'portal_def'};
2710: $domdefaults{'portal_def_email'} = $domconfig{'defaults'}{'portal_def_email'};
2711: $domdefaults{'portal_def_web'} = $domconfig{'defaults'}{'portal_def_web'};
2712: $domdefaults{'intauth_cost'} = $domconfig{'defaults'}{'intauth_cost'};
2713: $domdefaults{'intauth_switch'} = $domconfig{'defaults'}{'intauth_switch'};
2714: $domdefaults{'intauth_check'} = $domconfig{'defaults'}{'intauth_check'};
2715: $domdefaults{'unamemap_rule'} = $domconfig{'defaults'}{'unamemap_rule'};
2716: } else {
2717: $domdefaults{'lang_def'} = &domain($domain,'lang_def');
2718: $domdefaults{'auth_def'} = &domain($domain,'auth_def');
2719: $domdefaults{'auth_arg_def'} = &domain($domain,'auth_arg_def');
2720: }
2721: if (ref($domconfig{'quotas'}) eq 'HASH') {
2722: if (ref($domconfig{'quotas'}{'defaultquota'}) eq 'HASH') {
2723: $domdefaults{'defaultquota'} = $domconfig{'quotas'}{'defaultquota'};
2724: } else {
2725: $domdefaults{'defaultquota'} = $domconfig{'quotas'};
2726: }
2727: my @usertools = ('aboutme','blog','webdav','portfolio');
2728: foreach my $item (@usertools) {
2729: if (ref($domconfig{'quotas'}{$item}) eq 'HASH') {
2730: $domdefaults{$item} = $domconfig{'quotas'}{$item};
2731: }
2732: }
2733: if (ref($domconfig{'quotas'}{'authorquota'}) eq 'HASH') {
2734: $domdefaults{'authorquota'} = $domconfig{'quotas'}{'authorquota'};
2735: }
2736: }
2737: if (ref($domconfig{'requestcourses'}) eq 'HASH') {
2738: foreach my $item ('official','unofficial','community','textbook','placement') {
2739: $domdefaults{$item} = $domconfig{'requestcourses'}{$item};
2740: }
2741: }
2742: if (ref($domconfig{'requestauthor'}) eq 'HASH') {
2743: $domdefaults{'requestauthor'} = $domconfig{'requestauthor'};
2744: }
2745: if (ref($domconfig{'inststatus'}) eq 'HASH') {
2746: foreach my $item ('inststatustypes','inststatusorder','inststatusguest') {
2747: $domdefaults{$item} = $domconfig{'inststatus'}{$item};
2748: }
2749: }
2750: if (ref($domconfig{'coursedefaults'}) eq 'HASH') {
2751: $domdefaults{'canuse_pdfforms'} = $domconfig{'coursedefaults'}{'canuse_pdfforms'};
2752: $domdefaults{'usejsme'} = $domconfig{'coursedefaults'}{'usejsme'};
2753: $domdefaults{'inline_chem'} = $domconfig{'coursedefaults'}{'inline_chem'};
2754: $domdefaults{'uselcmath'} = $domconfig{'coursedefaults'}{'uselcmath'};
2755: if (ref($domconfig{'coursedefaults'}{'postsubmit'}) eq 'HASH') {
2756: $domdefaults{'postsubmit'} = $domconfig{'coursedefaults'}{'postsubmit'}{'client'};
2757: }
2758: foreach my $type (@coursetypes) {
2759: if (ref($domconfig{'coursedefaults'}{'coursecredits'}) eq 'HASH') {
2760: unless ($type eq 'community') {
2761: $domdefaults{$type.'credits'} = $domconfig{'coursedefaults'}{'coursecredits'}{$type};
2762: }
2763: }
2764: if (ref($domconfig{'coursedefaults'}{'uploadquota'}) eq 'HASH') {
2765: $domdefaults{$type.'quota'} = $domconfig{'coursedefaults'}{'uploadquota'}{$type};
2766: }
2767: if ($domdefaults{'postsubmit'} eq 'on') {
2768: if (ref($domconfig{'coursedefaults'}{'postsubmit'}{'timeout'}) eq 'HASH') {
2769: $domdefaults{$type.'postsubtimeout'} =
2770: $domconfig{'coursedefaults'}{'postsubmit'}{'timeout'}{$type};
2771: }
2772: }
2773: }
2774: if (ref($domconfig{'coursedefaults'}{'canclone'}) eq 'HASH') {
2775: if (ref($domconfig{'coursedefaults'}{'canclone'}{'instcode'}) eq 'ARRAY') {
2776: my @clonecodes = @{$domconfig{'coursedefaults'}{'canclone'}{'instcode'}};
2777: if (@clonecodes) {
2778: $domdefaults{'canclone'} = join('+',@clonecodes);
2779: }
2780: }
2781: } elsif ($domconfig{'coursedefaults'}{'canclone'}) {
2782: $domdefaults{'canclone'}=$domconfig{'coursedefaults'}{'canclone'};
2783: }
2784: if ($domconfig{'coursedefaults'}{'texengine'}) {
2785: $domdefaults{'texengine'} = $domconfig{'coursedefaults'}{'texengine'};
2786: }
2787: if (exists($domconfig{'coursedefaults'}{'ltiauth'})) {
2788: $domdefaults{'crsltiauth'} = $domconfig{'coursedefaults'}{'ltiauth'};
2789: }
2790: }
2791: if (ref($domconfig{'usersessions'}) eq 'HASH') {
2792: if (ref($domconfig{'usersessions'}{'remote'}) eq 'HASH') {
2793: $domdefaults{'remotesessions'} = $domconfig{'usersessions'}{'remote'};
2794: }
2795: if (ref($domconfig{'usersessions'}{'hosted'}) eq 'HASH') {
2796: $domdefaults{'hostedsessions'} = $domconfig{'usersessions'}{'hosted'};
2797: }
2798: if (ref($domconfig{'usersessions'}{'offloadnow'}) eq 'HASH') {
2799: $domdefaults{'offloadnow'} = $domconfig{'usersessions'}{'offloadnow'};
2800: }
2801: if (ref($domconfig{'usersessions'}{'offloadoth'}) eq 'HASH') {
2802: $domdefaults{'offloadoth'} = $domconfig{'usersessions'}{'offloadoth'};
2803: }
2804: }
2805: if (ref($domconfig{'selfenrollment'}) eq 'HASH') {
2806: if (ref($domconfig{'selfenrollment'}{'admin'}) eq 'HASH') {
2807: my @settings = ('types','registered','enroll_dates','access_dates','section',
2808: 'approval','limit');
2809: foreach my $type (@coursetypes) {
2810: if (ref($domconfig{'selfenrollment'}{'admin'}{$type}) eq 'HASH') {
2811: my @mgrdc = ();
2812: foreach my $item (@settings) {
2813: if ($domconfig{'selfenrollment'}{'admin'}{$type}{$item} eq '0') {
2814: push(@mgrdc,$item);
2815: }
2816: }
2817: if (@mgrdc) {
2818: $domdefaults{$type.'selfenrolladmdc'} = join(',',@mgrdc);
2819: }
2820: }
2821: }
2822: }
2823: if (ref($domconfig{'selfenrollment'}{'default'}) eq 'HASH') {
2824: foreach my $type (@coursetypes) {
2825: if (ref($domconfig{'selfenrollment'}{'default'}{$type}) eq 'HASH') {
2826: foreach my $item (keys(%{$domconfig{'selfenrollment'}{'default'}{$type}})) {
2827: $domdefaults{$type.'selfenroll'.$item} = $domconfig{'selfenrollment'}{'default'}{$type}{$item};
2828: }
2829: }
2830: }
2831: }
2832: }
2833: if (ref($domconfig{'coursecategories'}) eq 'HASH') {
2834: $domdefaults{'catauth'} = 'std';
2835: $domdefaults{'catunauth'} = 'std';
2836: if ($domconfig{'coursecategories'}{'auth'}) {
2837: $domdefaults{'catauth'} = $domconfig{'coursecategories'}{'auth'};
2838: }
2839: if ($domconfig{'coursecategories'}{'unauth'}) {
2840: $domdefaults{'catunauth'} = $domconfig{'coursecategories'}{'unauth'};
2841: }
2842: }
2843: if (ref($domconfig{'ssl'}) eq 'HASH') {
2844: if (ref($domconfig{'ssl'}{'replication'}) eq 'HASH') {
2845: $domdefaults{'replication'} = $domconfig{'ssl'}{'replication'};
2846: }
2847: if (ref($domconfig{'ssl'}{'connto'}) eq 'HASH') {
2848: $domdefaults{'connect'} = $domconfig{'ssl'}{'connto'};
2849: }
2850: if (ref($domconfig{'ssl'}{'connfrom'}) eq 'HASH') {
2851: $domdefaults{'connect'} = $domconfig{'ssl'}{'connfrom'};
2852: }
2853: }
2854: if (ref($domconfig{'trust'}) eq 'HASH') {
2855: my @prefixes = qw(content shared enroll othcoau coaurem domroles catalog reqcrs msg);
2856: foreach my $prefix (@prefixes) {
2857: if (ref($domconfig{'trust'}{$prefix}) eq 'HASH') {
2858: $domdefaults{'trust'.$prefix} = $domconfig{'trust'}{$prefix};
2859: }
2860: }
2861: }
2862: if (ref($domconfig{'autoenroll'}) eq 'HASH') {
2863: $domdefaults{'autofailsafe'} = $domconfig{'autoenroll'}{'autofailsafe'};
2864: $domdefaults{'failsafe'} = $domconfig{'autoenroll'}{'failsafe'};
2865: }
2866: if (ref($domconfig{'helpsettings'}) eq 'HASH') {
2867: $domdefaults{'submitbugs'} = $domconfig{'helpsettings'}{'submitbugs'};
2868: if (ref($domconfig{'helpsettings'}{'adhoc'}) eq 'HASH') {
2869: $domdefaults{'adhocroles'} = $domconfig{'helpsettings'}{'adhoc'};
2870: }
2871: }
2872: if (ref($domconfig{'wafproxy'}) eq 'HASH') {
2873: foreach my $item ('ipheader','trusted','vpnint','vpnext','sslopt') {
2874: if ($domconfig{'wafproxy'}{$item}) {
2875: $domdefaults{'waf_'.$item} = $domconfig{'wafproxy'}{$item};
2876: }
2877: }
2878: }
2879: if (ref($domconfig{'ltisec'}) eq 'HASH') {
2880: if (ref($domconfig{'ltisec'}{'encrypt'}) eq 'HASH') {
2881: $domdefaults{'linkprotenc_crs'} = $domconfig{'ltisec'}{'encrypt'}{'crs'};
2882: $domdefaults{'linkprotenc_dom'} = $domconfig{'ltisec'}{'encrypt'}{'dom'};
2883: $domdefaults{'ltienc_consumers'} = $domconfig{'ltisec'}{'encrypt'}{'consumers'};
2884: }
2885: if (ref($domconfig{'ltisec'}{'private'}) eq 'HASH') {
2886: if (ref($domconfig{'ltisec'}{'private'}{'keys'}) eq 'ARRAY') {
2887: $domdefaults{'privhosts'} = $domconfig{'ltisec'}{'private'}{'keys'};
2888: }
2889: }
2890: }
2891: &do_cache_new('domdefaults',$domain,\%domdefaults,$cachetime);
2892: return %domdefaults;
2893: }
2894:
2895: sub get_dom_cats {
2896: my ($dom) = @_;
2897: return unless (&domain($dom));
2898: my ($cats,$cached)=&is_cached_new('cats',$dom);
2899: unless (defined($cached)) {
2900: my %domconfig = &get_dom('configuration',['coursecategories'],$dom);
2901: if (ref($domconfig{'coursecategories'}) eq 'HASH') {
2902: if (ref($domconfig{'coursecategories'}{'cats'}) eq 'HASH') {
2903: %{$cats} = %{$domconfig{'coursecategories'}{'cats'}};
2904: } else {
2905: $cats = {};
2906: }
2907: } else {
2908: $cats = {};
2909: }
2910: &Apache::lonnet::do_cache_new('cats',$dom,$cats,3600);
2911: }
2912: return $cats;
2913: }
2914:
2915: sub get_dom_instcats {
2916: my ($dom) = @_;
2917: return unless (&domain($dom));
2918: my ($instcats,$cached)=&is_cached_new('instcats',$dom);
2919: unless (defined($cached)) {
2920: my (%coursecodes,%codes,@codetitles,%cat_titles,%cat_order);
2921: my $totcodes = &retrieve_instcodes(\%coursecodes,$dom);
2922: if ($totcodes > 0) {
2923: my $caller = 'global';
2924: if (&auto_instcode_format($caller,$dom,\%coursecodes,\%codes,
2925: \@codetitles,\%cat_titles,\%cat_order) eq 'ok') {
2926: $instcats = {
2927: codes => \%codes,
2928: codetitles => \@codetitles,
2929: cat_titles => \%cat_titles,
2930: cat_order => \%cat_order,
2931: };
2932: &do_cache_new('instcats',$dom,$instcats,3600);
2933: }
2934: }
2935: }
2936: return $instcats;
2937: }
2938:
2939: sub retrieve_instcodes {
2940: my ($coursecodes,$dom) = @_;
2941: my $totcodes;
2942: my %courses = &courseiddump($dom,'.',1,'.','.','.',undef,undef,'Course');
2943: foreach my $course (keys(%courses)) {
2944: if (ref($courses{$course}) eq 'HASH') {
2945: if ($courses{$course}{'inst_code'} ne '') {
2946: $$coursecodes{$course} = $courses{$course}{'inst_code'};
2947: $totcodes ++;
2948: }
2949: }
2950: }
2951: return $totcodes;
2952: }
2953:
2954: sub course_portal_url {
2955: my ($cnum,$cdom,$r) = @_;
2956: my $chome = &homeserver($cnum,$cdom);
2957: my $hostname = &hostname($chome);
2958: my $protocol = $protocol{$chome};
2959: $protocol = 'http' if ($protocol ne 'https');
2960: my %domdefaults = &get_domain_defaults($cdom);
2961: my $firsturl;
2962: if ($domdefaults{'portal_def'}) {
2963: $firsturl = $domdefaults{'portal_def'};
2964: } else {
2965: my $alias = &Apache::lonnet::use_proxy_alias($r,$chome);
2966: $hostname = $alias if ($alias ne '');
2967: $firsturl = $protocol.'://'.$hostname;
2968: }
2969: return $firsturl;
2970: }
2971:
2972: sub url_prefix {
2973: my ($r,$dom,$home,$context) = @_;
2974: my $prefix;
2975: my %domdefs = &get_domain_defaults($dom);
2976: if ($domdefs{'portal_def'} && $domdefs{'portal_def_'.$context}) {
2977: if ($domdefs{'portal_def'} =~ m{^(https?://[^/]+)}) {
2978: $prefix = $1;
2979: }
2980: }
2981: if ($prefix eq '') {
2982: my $hostname = &hostname($home);
2983: my $protocol = $protocol{$home};
2984: $protocol = 'http' if ($protocol{$home} ne 'https');
2985: my $alias = &use_proxy_alias($r,$home);
2986: $hostname = $alias if ($alias ne '');
2987: $prefix = $protocol.'://'.$hostname;
2988: }
2989: return $prefix;
2990: }
2991:
2992: # --------------------------------------------- Get domain config for passwords
2993:
2994: sub get_passwdconf {
2995: my ($dom) = @_;
2996: my (%passwdconf,$gotconf,$lookup);
2997: my ($result,$cached)=&is_cached_new('passwdconf',$dom);
2998: if (defined($cached)) {
2999: if (ref($result) eq 'HASH') {
3000: %passwdconf = %{$result};
3001: $gotconf = 1;
3002: }
3003: }
3004: unless ($gotconf) {
3005: my %domconfig = &get_dom('configuration',['passwords'],$dom);
3006: if (ref($domconfig{'passwords'}) eq 'HASH') {
3007: %passwdconf = %{$domconfig{'passwords'}};
3008: }
3009: my $cachetime = 24*60*60;
3010: &do_cache_new('passwdconf',$dom,\%passwdconf,$cachetime);
3011: }
3012: return %passwdconf;
3013: }
3014:
3015: # --------------------------------------------------- Assign a key to a student
3016:
3017: sub assign_access_key {
3018: #
3019: # a valid key looks like uname:udom#comments
3020: # comments are being appended
3021: #
3022: my ($ckey,$kdom,$knum,$cdom,$cnum,$udom,$uname,$logentry)=@_;
3023: $kdom=
3024: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($kdom));
3025: $knum=
3026: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($knum));
3027: $cdom=
3028: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
3029: $cnum=
3030: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
3031: $udom=$env{'user.name'} unless (defined($udom));
3032: $uname=$env{'user.domain'} unless (defined($uname));
3033: my %existing=&get('accesskeys',[$ckey],$kdom,$knum);
3034: if (($existing{$ckey}=~/^\#(.*)$/) || # - new key
3035: ($existing{$ckey}=~/^\Q$uname\E\:\Q$udom\E\#(.*)$/)) {
3036: # assigned to this person
3037: # - this should not happen,
3038: # unless something went wrong
3039: # the first time around
3040: # ready to assign
3041: $logentry=$1.'; '.$logentry;
3042: if (&put('accesskeys',{$ckey=>$uname.':'.$udom.'#'.$logentry},
3043: $kdom,$knum) eq 'ok') {
3044: # key now belongs to user
3045: my $envkey='key.'.$cdom.'_'.$cnum;
3046: if (&put('environment',{$envkey => $ckey}) eq 'ok') {
3047: &appenv({'environment.'.$envkey => $ckey});
3048: return 'ok';
3049: } else {
3050: return
3051: 'error: Count not permanently assign key, will need to be re-entered later.';
3052: }
3053: } else {
3054: return 'error: Could not assign key, try again later.';
3055: }
3056: } elsif (!$existing{$ckey}) {
3057: # the key does not exist
3058: return 'error: The key does not exist';
3059: } else {
3060: # the key is somebody else's
3061: return 'error: The key is already in use';
3062: }
3063: }
3064:
3065: # ------------------------------------------ put an additional comment on a key
3066:
3067: sub comment_access_key {
3068: #
3069: # a valid key looks like uname:udom#comments
3070: # comments are being appended
3071: #
3072: my ($ckey,$cdom,$cnum,$logentry)=@_;
3073: $cdom=
3074: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
3075: $cnum=
3076: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
3077: my %existing=&get('accesskeys',[$ckey],$cdom,$cnum);
3078: if ($existing{$ckey}) {
3079: $existing{$ckey}.='; '.$logentry;
3080: # ready to assign
3081: if (&put('accesskeys',{$ckey=>$existing{$ckey}},
3082: $cdom,$cnum) eq 'ok') {
3083: return 'ok';
3084: } else {
3085: return 'error: Count not store comment.';
3086: }
3087: } else {
3088: # the key does not exist
3089: return 'error: The key does not exist';
3090: }
3091: }
3092:
3093: # ------------------------------------------------------ Generate a set of keys
3094:
3095: sub generate_access_keys {
3096: my ($number,$cdom,$cnum,$logentry)=@_;
3097: $cdom=
3098: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
3099: $cnum=
3100: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
3101: unless (&allowed('mky',$cdom)) { return 0; }
3102: unless (($cdom) && ($cnum)) { return 0; }
3103: if ($number>10000) { return 0; }
3104: sleep(2); # make sure don't get same seed twice
3105: srand(time()^($$+($$<<15))); # from "Programming Perl"
3106: my $total=0;
3107: for (my $i=1;$i<=$number;$i++) {
3108: my $newkey=sprintf("%lx",int(100000*rand)).'-'.
3109: sprintf("%lx",int(100000*rand)).'-'.
3110: sprintf("%lx",int(100000*rand));
3111: $newkey=~s/1/g/g; # folks mix up 1 and l
3112: $newkey=~s/0/h/g; # and also 0 and O
3113: my %existing=&get('accesskeys',[$newkey],$cdom,$cnum);
3114: if ($existing{$newkey}) {
3115: $i--;
3116: } else {
3117: if (&put('accesskeys',
3118: { $newkey => '# generated '.localtime().
3119: ' by '.$env{'user.name'}.'@'.$env{'user.domain'}.
3120: '; '.$logentry },
3121: $cdom,$cnum) eq 'ok') {
3122: $total++;
3123: }
3124: }
3125: }
3126: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},
3127: 'Generated '.$total.' keys for '.$cnum.' at '.$cdom);
3128: return $total;
3129: }
3130:
3131: # ------------------------------------------------------- Validate an accesskey
3132:
3133: sub validate_access_key {
3134: my ($ckey,$cdom,$cnum,$udom,$uname)=@_;
3135: $cdom=
3136: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
3137: $cnum=
3138: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
3139: $udom=$env{'user.domain'} unless (defined($udom));
3140: $uname=$env{'user.name'} unless (defined($uname));
3141: my %existing=&get('accesskeys',[$ckey],$cdom,$cnum);
3142: return ($existing{$ckey}=~/^\Q$uname\E\:\Q$udom\E\#/);
3143: }
3144:
3145: # ------------------------------------- Find the section of student in a course
3146: sub devalidate_getsection_cache {
3147: my ($udom,$unam,$courseid)=@_;
3148: my $hashid="$udom:$unam:$courseid";
3149: &devalidate_cache_new('getsection',$hashid);
3150: }
3151:
3152: sub courseid_to_courseurl {
3153: my ($courseid) = @_;
3154: #already url style courseid
3155: return $courseid if ($courseid =~ m{^/});
3156:
3157: if (exists($env{'course.'.$courseid.'.num'})) {
3158: my $cnum = $env{'course.'.$courseid.'.num'};
3159: my $cdom = $env{'course.'.$courseid.'.domain'};
3160: return "/$cdom/$cnum";
3161: }
3162:
3163: my %courseinfo=&Apache::lonnet::coursedescription($courseid);
3164: if (exists($courseinfo{'num'})) {
3165: return "/$courseinfo{'domain'}/$courseinfo{'num'}";
3166: }
3167:
3168: return undef;
3169: }
3170:
3171: sub getsection {
3172: my ($udom,$unam,$courseid)=@_;
3173: my $cachetime=1800;
3174:
3175: my $hashid="$udom:$unam:$courseid";
3176: my ($result,$cached)=&is_cached_new('getsection',$hashid);
3177: if (defined($cached)) { return $result; }
3178:
3179: my %Pending;
3180: my %Expired;
3181: #
3182: # Each role can either have not started yet (pending), be active,
3183: # or have expired.
3184: #
3185: # If there is an active role, we are done.
3186: #
3187: # If there is more than one role which has not started yet,
3188: # choose the one which will start sooner
3189: # If there is one role which has not started yet, return it.
3190: #
3191: # If there is more than one expired role, choose the one which ended last.
3192: # If there is a role which has expired, return it.
3193: #
3194: $courseid = &courseid_to_courseurl($courseid);
3195: my %roleshash = &dump('roles',$udom,$unam,$courseid);
3196: foreach my $key (keys(%roleshash)) {
3197: next if ($key !~/^\Q$courseid\E(?:\/)*(\w+)*\_st$/);
3198: my $section=$1;
3199: if ($key eq $courseid.'_st') { $section=''; }
3200: my ($dummy,$end,$start)=split(/\_/,&unescape($roleshash{$key}));
3201: my $now=time;
3202: if (defined($end) && $end && ($now > $end)) {
3203: $Expired{$end}=$section;
3204: next;
3205: }
3206: if (defined($start) && $start && ($now < $start)) {
3207: $Pending{$start}=$section;
3208: next;
3209: }
3210: return &do_cache_new('getsection',$hashid,$section,$cachetime);
3211: }
3212: #
3213: # Presumedly there will be few matching roles from the above
3214: # loop and the sorting time will be negligible.
3215: if (scalar(keys(%Pending))) {
3216: my ($time) = sort {$a <=> $b} keys(%Pending);
3217: return &do_cache_new('getsection',$hashid,$Pending{$time},$cachetime);
3218: }
3219: if (scalar(keys(%Expired))) {
3220: my @sorted = sort {$a <=> $b} keys(%Expired);
3221: my $time = pop(@sorted);
3222: return &do_cache_new('getsection',$hashid,$Expired{$time},$cachetime);
3223: }
3224: return &do_cache_new('getsection',$hashid,'-1',$cachetime);
3225: }
3226:
3227: sub save_cache {
3228: &purge_remembered();
3229: #&Apache::loncommon::validate_page();
3230: undef(%env);
3231: undef($env_loaded);
3232: }
3233:
3234: my $to_remember=-1;
3235: my %remembered;
3236: my %accessed;
3237: my $kicks=0;
3238: my $hits=0;
3239: sub make_key {
3240: my ($name,$id) = @_;
3241: if (length($id) > 65
3242: && length(&escape($id)) > 200) {
3243: $id=length($id).':'.&Digest::MD5::md5_hex($id);
3244: }
3245: return &escape($name.':'.$id);
3246: }
3247:
3248: sub devalidate_cache_new {
3249: my ($name,$id,$debug) = @_;
3250: if ($debug) { &Apache::lonnet::logthis("deleting $name:$id"); }
3251: my $remembered_id=$name.':'.$id;
3252: $id=&make_key($name,$id);
3253: $memcache->delete($id);
3254: delete($remembered{$remembered_id});
3255: delete($accessed{$remembered_id});
3256: }
3257:
3258: sub is_cached_new {
3259: my ($name,$id,$debug) = @_;
3260: my $remembered_id=$name.':'.$id; # this is to avoid make_key (which is slow) whenever possible
3261: if (exists($remembered{$remembered_id})) {
3262: if ($debug) { &Apache::lonnet::logthis("Early return $remembered_id of $remembered{$remembered_id} "); }
3263: $accessed{$remembered_id}=[&gettimeofday()];
3264: $hits++;
3265: return ($remembered{$remembered_id},1);
3266: }
3267: $id=&make_key($name,$id);
3268: my $value = $memcache->get($id);
3269: if (!(defined($value))) {
3270: if ($debug) { &Apache::lonnet::logthis("getting $id is not defined"); }
3271: return (undef,undef);
3272: }
3273: if ($value eq '__undef__') {
3274: if ($debug) { &Apache::lonnet::logthis("getting $id is __undef__"); }
3275: $value=undef;
3276: }
3277: &make_room($remembered_id,$value,$debug);
3278: if ($debug) { &Apache::lonnet::logthis("getting $id is $value"); }
3279: return ($value,1);
3280: }
3281:
3282: sub do_cache_new {
3283: my ($name,$id,$value,$time,$debug) = @_;
3284: my $remembered_id=$name.':'.$id;
3285: $id=&make_key($name,$id);
3286: my $setvalue=$value;
3287: if (!defined($setvalue)) {
3288: $setvalue='__undef__';
3289: }
3290: if (!defined($time) ) {
3291: $time=600;
3292: }
3293: if ($debug) { &Apache::lonnet::logthis("Setting $id to $value"); }
3294: my $result = $memcache->set($id,$setvalue,$time);
3295: if (! $result) {
3296: &logthis("caching of id -> $id failed");
3297: $memcache->disconnect_all();
3298: }
3299: # need to make a copy of $value
3300: &make_room($remembered_id,$value,$debug);
3301: return $value;
3302: }
3303:
3304: sub make_room {
3305: my ($remembered_id,$value,$debug)=@_;
3306:
3307: $remembered{$remembered_id}= (ref($value)) ? &Storable::dclone($value)
3308: : $value;
3309: if ($to_remember<0) { return; }
3310: $accessed{$remembered_id}=[&gettimeofday()];
3311: if (scalar(keys(%remembered)) <= $to_remember) { return; }
3312: my $to_kick;
3313: my $max_time=0;
3314: foreach my $other (keys(%accessed)) {
3315: if (&tv_interval($accessed{$other}) > $max_time) {
3316: $to_kick=$other;
3317: $max_time=&tv_interval($accessed{$other});
3318: }
3319: }
3320: delete($remembered{$to_kick});
3321: delete($accessed{$to_kick});
3322: $kicks++;
3323: if ($debug) { &logthis("kicking $to_kick $max_time $kicks\n"); }
3324: return;
3325: }
3326:
3327: sub purge_remembered {
3328: #&logthis("Tossing ".scalar(keys(%remembered)));
3329: #&logthis(sprintf("%-20s is %s",'%remembered',length(&freeze(\%remembered))));
3330: undef(%remembered);
3331: undef(%accessed);
3332: }
3333: # ------------------------------------- Read an entry from a user's environment
3334:
3335: sub userenvironment {
3336: my ($udom,$unam,@what)=@_;
3337: my $items;
3338: foreach my $item (@what) {
3339: $items.=&escape($item).'&';
3340: }
3341: $items=~s/\&$//;
3342: my %returnhash=();
3343: my $uhome = &homeserver($unam,$udom);
3344: unless ($uhome eq 'no_host') {
3345: my @answer=split(/\&/,
3346: &reply('get:'.$udom.':'.$unam.':environment:'.$items,$uhome));
3347: if ($#answer==0 && $answer[0] =~ /^(con_lost|error:|no_such_host)/i) {
3348: return %returnhash;
3349: }
3350: my $i;
3351: for ($i=0;$i<=$#what;$i++) {
3352: $returnhash{$what[$i]}=&unescape($answer[$i]);
3353: }
3354: }
3355: return %returnhash;
3356: }
3357:
3358: # ---------------------------------------------------------- Get a studentphoto
3359: sub studentphoto {
3360: my ($udom,$unam,$ext) = @_;
3361: my $home=&Apache::lonnet::homeserver($unam,$udom);
3362: if (defined($env{'request.course.id'})) {
3363: if ($env{'course.'.$env{'request.course.id'}.'.internal.showphoto'}) {
3364: if ($udom eq $env{'course.'.$env{'request.course.id'}.'.domain'}) {
3365: return(&retrievestudentphoto($udom,$unam,$ext));
3366: } else {
3367: my ($result,$perm_reqd)=
3368: &Apache::lonnet::auto_photo_permission($unam,$udom);
3369: if ($result eq 'ok') {
3370: if (!($perm_reqd eq 'yes')) {
3371: return(&retrievestudentphoto($udom,$unam,$ext));
3372: }
3373: }
3374: }
3375: }
3376: } else {
3377: my ($result,$perm_reqd) =
3378: &Apache::lonnet::auto_photo_permission($unam,$udom);
3379: if ($result eq 'ok') {
3380: if (!($perm_reqd eq 'yes')) {
3381: return(&retrievestudentphoto($udom,$unam,$ext));
3382: }
3383: }
3384: }
3385: return '/adm/lonKaputt/lonlogo_broken.gif';
3386: }
3387:
3388: sub retrievestudentphoto {
3389: my ($udom,$unam,$ext,$type) = @_;
3390: my $home=&Apache::lonnet::homeserver($unam,$udom);
3391: my $ret=&Apache::lonnet::reply("studentphoto:$udom:$unam:$ext:$type",$home);
3392: if ($ret eq 'ok') {
3393: my $url="/uploaded/$udom/$unam/internal/studentphoto.$ext";
3394: if ($type eq 'thumbnail') {
3395: $url="/uploaded/$udom/$unam/internal/studentphoto_tn.$ext";
3396: }
3397: my $tokenurl=&Apache::lonnet::tokenwrapper($url);
3398: return $tokenurl;
3399: } else {
3400: if ($type eq 'thumbnail') {
3401: return '/adm/lonKaputt/genericstudent_tn.gif';
3402: } else {
3403: return '/adm/lonKaputt/lonlogo_broken.gif';
3404: }
3405: }
3406: }
3407:
3408: # -------------------------------------------------------------------- New chat
3409:
3410: sub chatsend {
3411: my ($newentry,$anon,$group)=@_;
3412: my $cnum=$env{'course.'.$env{'request.course.id'}.'.num'};
3413: my $cdom=$env{'course.'.$env{'request.course.id'}.'.domain'};
3414: my $chome=$env{'course.'.$env{'request.course.id'}.'.home'};
3415: &reply('chatsend:'.$cdom.':'.$cnum.':'.
3416: &escape($env{'user.domain'}.':'.$env{'user.name'}.':'.$anon.':'.
3417: &escape($newentry)).':'.$group,$chome);
3418: }
3419:
3420: # ------------------------------------------ Find current version of a resource
3421:
3422: sub getversion {
3423: my $fname=&clutter(shift);
3424: unless ($fname=~m{^(/adm/wrapper|)/res/}) { return -1; }
3425: return ¤tversion(&filelocation('',$fname));
3426: }
3427:
3428: sub currentversion {
3429: my $fname=shift;
3430: my $author=$fname;
3431: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
3432: my ($udom,$uname)=split(/\//,$author);
3433: my $home=&homeserver($uname,$udom);
3434: if ($home eq 'no_host') {
3435: return -1;
3436: }
3437: my $answer=&reply("currentversion:$fname",$home);
3438: if (($answer eq 'con_lost') || ($answer eq 'rejected')) {
3439: return -1;
3440: }
3441: return $answer;
3442: }
3443:
3444: #
3445: # Return special version number of resource if set by override, empty otherwise
3446: #
3447: sub usedversion {
3448: my $fname=shift;
3449: unless ($fname) { $fname=$env{'request.uri'}; }
3450: my ($urlversion)=($fname=~/\.(\d+)\.\w+$/);
3451: if ($urlversion) { return $urlversion; }
3452: return '';
3453: }
3454:
3455: # ----------------------------- Subscribe to a resource, return URL if possible
3456:
3457: sub subscribe {
3458: my $fname=shift;
3459: if ($fname=~/\/(aboutme|syllabus|bulletinboard|smppg)$/) { return ''; }
3460: $fname=~s/[\n\r]//g;
3461: my $author=$fname;
3462: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
3463: my ($udom,$uname)=split(/\//,$author);
3464: my $home=homeserver($uname,$udom);
3465: if ($home eq 'no_host') {
3466: return 'not_found';
3467: }
3468: my $answer=reply("sub:$fname",$home);
3469: if (($answer eq 'con_lost') || ($answer eq 'rejected')) {
3470: $answer.=' by '.$home;
3471: }
3472: return $answer;
3473: }
3474:
3475: # -------------------------------------------------------------- Replicate file
3476:
3477: sub repcopy {
3478: my $filename=shift;
3479: $filename=~s/\/+/\//g;
3480: my $londocroot = $perlvar{'lonDocRoot'};
3481: if ($filename=~m{^\Q$londocroot/adm/\E}) { return 'ok'; }
3482: if ($filename=~m{^\Q/home/httpd/lonUsers/\E}) { return 'ok'; }
3483: if ($filename=~m{^\Q$londocroot/userfiles/\E} or
3484: $filename=~m{^/*(uploaded|editupload)/}) {
3485: return &repcopy_userfile($filename);
3486: }
3487: $filename=~s/[\n\r]//g;
3488: my $transname="$filename.in.transfer";
3489: # FIXME: this should flock
3490: if ((-e $filename) || (-e $transname)) { return 'ok'; }
3491: my $remoteurl=subscribe($filename);
3492: if ($remoteurl =~ /^con_lost by/) {
3493: &logthis("Subscribe returned $remoteurl: $filename");
3494: return 'unavailable';
3495: } elsif ($remoteurl eq 'not_found') {
3496: #&logthis("Subscribe returned not_found: $filename");
3497: return 'not_found';
3498: } elsif ($remoteurl =~ /^rejected by/) {
3499: &logthis("Subscribe returned $remoteurl: $filename");
3500: return 'forbidden';
3501: } elsif ($remoteurl eq 'directory') {
3502: return 'ok';
3503: } else {
3504: my $author=$filename;
3505: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
3506: my ($udom,$uname)=split(/\//,$author);
3507: my $home=homeserver($uname,$udom);
3508: unless ($home eq $perlvar{'lonHostID'}) {
3509: my @parts=split(/\//,$filename);
3510: my $path="/$parts[1]/$parts[2]/$parts[3]/$parts[4]";
3511: if ($path ne "$londocroot/res") {
3512: &logthis("Malconfiguration for replication: $filename");
3513: return 'bad_request';
3514: }
3515: my $count;
3516: for ($count=5;$count<$#parts;$count++) {
3517: $path.="/$parts[$count]";
3518: if ((-e $path)!=1) {
3519: mkdir($path,0777);
3520: }
3521: }
3522: my $request=new HTTP::Request('GET',"$remoteurl");
3523: my $response;
3524: if ($remoteurl =~ m{/raw/}) {
3525: $response=&LONCAPA::LWPReq::makerequest($home,$request,$transname,\%perlvar,'',0,1);
3526: } else {
3527: $response=&LONCAPA::LWPReq::makerequest($home,$request,$transname,\%perlvar,'',1);
3528: }
3529: if ($response->is_error()) {
3530: unlink($transname);
3531: my $message=$response->status_line;
3532: &logthis("<font color=\"blue\">WARNING:"
3533: ." LWP get: $message: $filename</font>");
3534: return 'unavailable';
3535: } else {
3536: if ($remoteurl!~/\.meta$/) {
3537: my $mrequest=new HTTP::Request('GET',$remoteurl.'.meta');
3538: my $mresponse;
3539: if ($remoteurl =~ m{/raw/}) {
3540: $mresponse = &LONCAPA::LWPReq::makerequest($home,$mrequest,$filename.'.meta',\%perlvar,'',0,1);
3541: } else {
3542: $mresponse = &LONCAPA::LWPReq::makerequest($home,$mrequest,$filename.'.meta',\%perlvar,'',1);
3543: }
3544: if ($mresponse->is_error()) {
3545: unlink($filename.'.meta');
3546: &logthis(
3547: "<font color=\"yellow\">INFO: No metadata: $filename</font>");
3548: }
3549: }
3550: rename($transname,$filename);
3551: return 'ok';
3552: }
3553: }
3554: }
3555: }
3556:
3557: # ------------------------------------------------- Unsubscribe from a resource
3558:
3559: sub unsubscribe {
3560: my ($fname) = @_;
3561: my $answer;
3562: if ($fname=~/\/(aboutme|syllabus|bulletinboard|smppg)$/) { return $answer; }
3563: $fname=~s/[\n\r]//g;
3564: my $author=$fname;
3565: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
3566: my ($udom,$uname)=split(/\//,$author);
3567: my $home=homeserver($uname,$udom);
3568: if ($home eq 'no_host') {
3569: $answer = 'no_host';
3570: } elsif (grep { $_ eq $home } ¤t_machine_ids()) {
3571: $answer = 'home';
3572: } else {
3573: my $defdom = $perlvar{'lonDefDomain'};
3574: if (&will_trust('content',$defdom,$udom)) {
3575: $answer = reply("unsub:$fname",$home);
3576: } else {
3577: $answer = 'untrusted';
3578: }
3579: }
3580: return $answer;
3581: }
3582:
3583: # ------------------------------------------------ Get server side include body
3584: sub ssi_body {
3585: my ($filelink,%form)=@_;
3586: if (! exists($form{'LONCAPA_INTERNAL_no_discussion'})) {
3587: $form{'LONCAPA_INTERNAL_no_discussion'}='true';
3588: }
3589: my $output='';
3590: my $response;
3591: if ($filelink=~/^https?\:/) {
3592: ($output,$response)=&externalssi($filelink);
3593: } else {
3594: $filelink .= $filelink=~/\?/ ? '&' : '?';
3595: $filelink .= 'inhibitmenu=yes';
3596: ($output,$response)=&ssi($filelink,%form);
3597: }
3598: $output=~s|//(\s*<!--)? BEGIN LON-CAPA Internal.+?// END LON-CAPA Internal\s*(-->)?\s||gs;
3599: $output=~s/^.*?\<body[^\>]*\>//si;
3600: $output=~s/\<\/body\s*\>.*?$//si;
3601: if (wantarray) {
3602: return ($output, $response);
3603: } else {
3604: return $output;
3605: }
3606: }
3607:
3608: # --------------------------------------------------------- Server Side Include
3609:
3610: sub absolute_url {
3611: my ($host_name,$unalias,$keep_proto) = @_;
3612: my $protocol = ($ENV{'SERVER_PORT'} == 443?'https://':'http://');
3613: if ($host_name eq '') {
3614: $host_name = $ENV{'SERVER_NAME'};
3615: }
3616: if ($unalias) {
3617: my $alias = &get_proxy_alias();
3618: if ($alias eq $host_name) {
3619: my $lonhost = $perlvar{'lonHostID'};
3620: my $hostname = &hostname($lonhost);
3621: my $lcproto;
3622: if (($keep_proto) || ($hostname eq '')) {
3623: $lcproto = $protocol;
3624: } else {
3625: $lcproto = $protocol{$lonhost};
3626: $lcproto = 'http' if ($lcproto ne 'https');
3627: $lcproto .= '://';
3628: }
3629: unless ($hostname eq '') {
3630: return $lcproto.$hostname;
3631: }
3632: }
3633: }
3634: return $protocol.$host_name;
3635: }
3636:
3637: #
3638: # Server side include.
3639: # Parameters:
3640: # fn Possibly encrypted resource name/id.
3641: # form Hash that describes how the rendering should be done
3642: # and other things.
3643: # Returns:
3644: # Scalar context: The content of the response.
3645: # Array context: 2 element list of the content and the full response object.
3646: #
3647: sub ssi {
3648:
3649: my ($fn,%form)=@_;
3650: my ($host,$request,$response);
3651: $host = &absolute_url('',1);
3652:
3653: $form{'no_update_last_known'}=1;
3654: &Apache::lonenc::check_encrypt(\$fn);
3655: if (%form) {
3656: $request=new HTTP::Request('POST',$host.$fn);
3657: $request->content(join('&',map {
3658: my $name = escape($_);
3659: "$name=" . ( ref($form{$_}) eq 'ARRAY'
3660: ? join("&$name=", map {escape($_) } @{$form{$_}})
3661: : &escape($form{$_}) );
3662: } keys(%form)));
3663: } else {
3664: $request=new HTTP::Request('GET',$host.$fn);
3665: }
3666:
3667: $request->header(Cookie => $ENV{'HTTP_COOKIE'});
3668: my $lonhost = $perlvar{'lonHostID'};
3669: my $islocal;
3670: if (($env{'request.course.id'}) &&
3671: ($form{'grade_courseid'} eq $env{'request.course.id'}) &&
3672: ($form{'grade_username'} ne '') && ($form{'grade_domain'} ne '') &&
3673: ($form{'grade_symb'} ne '') &&
3674: (&Apache::lonnet::allowed('mgr',$env{'request.course.id'}.
3675: ($env{'request.course.sec'}?'/'.$env{'request.course.sec'}:'')))) {
3676: $islocal = 1;
3677: }
3678: $response= &LONCAPA::LWPReq::makerequest($lonhost,$request,'',\%perlvar,
3679: '','','',$islocal);
3680:
3681: if (wantarray) {
3682: return ($response->content, $response);
3683: } else {
3684: return $response->content;
3685: }
3686: }
3687:
3688: sub externalssi {
3689: my ($url)=@_;
3690: my $request=new HTTP::Request('GET',$url);
3691: my $response = &LONCAPA::LWPReq::makerequest('',$request,'',\%perlvar);
3692: if (wantarray) {
3693: return ($response->content, $response);
3694: } else {
3695: return $response->content;
3696: }
3697: }
3698:
3699:
3700: # If the local copy of a replicated resource is outdated, trigger a
3701: # connection from the homeserver to flush the delayed queue. If no update
3702: # happens, remove local copies of outdated resource (and corresponding
3703: # metadata file).
3704:
3705: sub remove_stale_resfile {
3706: my ($url) = @_;
3707: my $removed;
3708: if ($url=~m{^/res/($match_domain)/($match_username)/}) {
3709: my $audom = $1;
3710: my $auname = $2;
3711: unless (($url =~ /\.\d+\.\w+$/) || ($url =~ m{^/res/lib/templates/})) {
3712: my $homeserver = &homeserver($auname,$audom);
3713: unless (($homeserver eq 'no_host') ||
3714: (grep { $_ eq $homeserver } ¤t_machine_ids())) {
3715: my $fname = &filelocation('',$url);
3716: if (-e $fname) {
3717: my $hostname = &hostname($homeserver);
3718: if ($hostname) {
3719: my $protocol = $protocol{$homeserver};
3720: $protocol = 'http' if ($protocol ne 'https');
3721: my $uri = &declutter($url);
3722: my $request=new HTTP::Request('HEAD',$protocol.'://'.$hostname.'/raw/'.$uri);
3723: my $response = &LONCAPA::LWPReq::makerequest($homeserver,$request,'',\%perlvar,5,0,1);
3724: if ($response->is_success()) {
3725: my $remmodtime = &HTTP::Date::str2time( $response->header('Last-modified') );
3726: my $locmodtime = (stat($fname))[9];
3727: if ($locmodtime < $remmodtime) {
3728: my $stale;
3729: my $answer = &reply('pong',$homeserver);
3730: if ($answer eq $homeserver.':'.$perlvar{'lonHostID'}) {
3731: sleep(0.2);
3732: $locmodtime = (stat($fname))[9];
3733: if ($locmodtime < $remmodtime) {
3734: my $posstransfer = $fname.'.in.transfer';
3735: if ((-e $posstransfer) && ($remmodtime < (stat($posstransfer))[9])) {
3736: $removed = 1;
3737: } else {
3738: $stale = 1;
3739: }
3740: } else {
3741: $removed = 1;
3742: }
3743: } else {
3744: $stale = 1;
3745: }
3746: if ($stale) {
3747: if (unlink($fname)) {
3748: if ($uri!~/\.meta$/) {
3749: if (-e $fname.'.meta') {
3750: unlink($fname.'.meta');
3751: }
3752: }
3753: my $unsubresult = &unsubscribe($fname);
3754: unless ($unsubresult eq 'ok') {
3755: &logthis("no unsub of $fname from $homeserver, reason: $unsubresult");
3756: }
3757: $removed = 1;
3758: }
3759: }
3760: }
3761: }
3762: }
3763: }
3764: }
3765: }
3766: }
3767: return $removed;
3768: }
3769:
3770: # -------------------------------- Allow a /uploaded/ URI to be vouched for
3771:
3772: sub allowuploaded {
3773: my ($srcurl,$url)=@_;
3774: $url=&clutter(&declutter($url));
3775: my $dir=$url;
3776: $dir=~s/\/[^\/]+$//;
3777: my %httpref=();
3778: my $httpurl=&hreflocation('',$url);
3779: $httpref{'httpref.'.$httpurl}=$srcurl;
3780: &Apache::lonnet::appenv(\%httpref);
3781: }
3782:
3783: #
3784: # Determine if the current user should be able to edit a particular resource,
3785: # when viewing in course context.
3786: # (a) When viewing resource used to determine if "Edit" item is included in
3787: # Functions.
3788: # (b) When displaying folder contents in course editor, used to determine if
3789: # "Edit" link will be displayed alongside resource.
3790: #
3791: # input: six args -- filename (decluttered), course number, course domain,
3792: # url, symb (if registered) and group (if this is a group
3793: # item -- e.g., bulletin board, group page etc.).
3794: # output: array of five scalars --
3795: # $cfile -- url for file editing if editable on current server
3796: # $home -- homeserver of resource (i.e., for author if published,
3797: # or course if uploaded.).
3798: # $switchserver -- 1 if server switch will be needed.
3799: # $forceedit -- 1 if icon/link should be to go to edit mode
3800: # $forceview -- 1 if icon/link should be to go to view mode
3801: #
3802:
3803: sub can_edit_resource {
3804: my ($file,$cnum,$cdom,$resurl,$symb,$group) = @_;
3805: my ($cfile,$home,$switchserver,$forceedit,$forceview,$uploaded,$incourse);
3806: #
3807: # For aboutme pages user can only edit his/her own.
3808: #
3809: if ($resurl =~ m{^/?adm/($match_domain)/($match_username)/aboutme$}) {
3810: my ($sdom,$sname) = ($1,$2);
3811: if (($sdom eq $env{'user.domain'}) && ($sname eq $env{'user.name'})) {
3812: $home = $env{'user.home'};
3813: $cfile = $resurl;
3814: if ($env{'form.forceedit'}) {
3815: $forceview = 1;
3816: } else {
3817: $forceedit = 1;
3818: }
3819: return ($cfile,$home,$switchserver,$forceedit,$forceview);
3820: } else {
3821: return;
3822: }
3823: }
3824:
3825: if ($env{'request.course.id'}) {
3826: my $crsedit = &Apache::lonnet::allowed('mdc',$env{'request.course.id'});
3827: if ($group ne '') {
3828: # if this is a group homepage or group bulletin board, check group privs
3829: my $allowed = 0;
3830: if ($resurl =~ m{^/?adm/$cdom/$cnum/$group/smppg$}) {
3831: if ((&allowed('mdg',$env{'request.course.id'}.
3832: ($env{'request.course.sec'}?'/'.$env{'request.course.sec'}:''))) ||
3833: (&allowed('mgh',$env{'request.course.id'}.'/'.$group)) || $crsedit) {
3834: $allowed = 1;
3835: }
3836: } elsif ($resurl =~ m{^/?adm/$cdom/$cnum/\d+/bulletinboard$}) {
3837: if ((&allowed('mdg',$env{'request.course.id'}.($env{'request.course.sec'}?'/'.$env{'request.course.sec'}:''))) ||
3838: (&allowed('cgb',$env{'request.course.id'}.'/'.$group)) || $crsedit) {
3839: $allowed = 1;
3840: }
3841: }
3842: if ($allowed) {
3843: $home=&homeserver($cnum,$cdom);
3844: if ($env{'form.forceedit'}) {
3845: $forceview = 1;
3846: } else {
3847: $forceedit = 1;
3848: }
3849: $cfile = $resurl;
3850: } else {
3851: return;
3852: }
3853: } else {
3854: if ($resurl =~ m{^/?adm/viewclasslist$}) {
3855: unless (&Apache::lonnet::allowed('opa',$env{'request.course.id'})) {
3856: return;
3857: }
3858: } elsif (!$crsedit) {
3859: #
3860: # No edit allowed where CC has switched to student role.
3861: #
3862: return;
3863: }
3864: }
3865: }
3866:
3867: if ($file ne '') {
3868: if (($cnum =~ /$match_courseid/) && ($cdom =~ /$match_domain/)) {
3869: if (&is_course_upload($file,$cnum,$cdom)) {
3870: $uploaded = 1;
3871: $incourse = 1;
3872: if ($file =~/\.(htm|html|css|js|txt)$/) {
3873: $cfile = &hreflocation('',$file);
3874: if ($env{'form.forceedit'}) {
3875: $forceview = 1;
3876: } else {
3877: $forceedit = 1;
3878: }
3879: }
3880: } elsif ($resurl =~ m{^/public/$cdom/$cnum/syllabus}) {
3881: $incourse = 1;
3882: if ($env{'form.forceedit'}) {
3883: $forceview = 1;
3884: } else {
3885: $forceedit = 1;
3886: }
3887: $cfile = $resurl;
3888: } elsif (($resurl ne '') && (&is_on_map($resurl))) {
3889: if ($resurl =~ m{^/adm/$match_domain/$match_username/\d+/smppg|bulletinboard$}) {
3890: $incourse = 1;
3891: if ($env{'form.forceedit'}) {
3892: $forceview = 1;
3893: } else {
3894: $forceedit = 1;
3895: }
3896: $cfile = $resurl;
3897: } elsif ($resurl eq '/res/lib/templates/simpleproblem.problem') {
3898: $incourse = 1;
3899: $cfile = $resurl.'/smpedit';
3900: } elsif ($resurl =~ m{^/adm/wrapper/ext/}) {
3901: $incourse = 1;
3902: if ($env{'form.forceedit'}) {
3903: $forceview = 1;
3904: } else {
3905: $forceedit = 1;
3906: }
3907: $cfile = $resurl;
3908: } elsif (($resurl =~ m{^/ext/}) && ($symb ne '')) {
3909: my ($map,$id,$res) = &decode_symb($symb);
3910: if ($map =~ /\.page$/) {
3911: $incourse = 1;
3912: if ($env{'form.forceedit'}) {
3913: $forceview = 1;
3914: $cfile = $map;
3915: } else {
3916: $forceedit = 1;
3917: $cfile = '/adm/wrapper'.$resurl;
3918: }
3919: }
3920: } elsif ($resurl =~ m{^/adm/wrapper/adm/$cdom/$cnum/\d+/ext\.tool$}) {
3921: $incourse = 1;
3922: if ($env{'form.forceedit'}) {
3923: $forceview = 1;
3924: } else {
3925: $forceedit = 1;
3926: }
3927: $cfile = $resurl;
3928: } elsif ($resurl =~ m{^/?adm/viewclasslist$}) {
3929: $incourse = 1;
3930: if ($env{'form.forceedit'}) {
3931: $forceview = 1;
3932: } else {
3933: $forceedit = 1;
3934: }
3935: $cfile = ($resurl =~ m{^/} ? $resurl : "/$resurl");
3936: }
3937: } elsif ($resurl eq '/res/lib/templates/simpleproblem.problem/smpedit') {
3938: my $template = '/res/lib/templates/simpleproblem.problem';
3939: if (&is_on_map($template)) {
3940: $incourse = 1;
3941: $forceview = 1;
3942: $cfile = $template;
3943: }
3944: } elsif (($resurl =~ m{^/adm/wrapper/ext/}) && ($env{'form.folderpath'} =~ /^supplemental/)) {
3945: $incourse = 1;
3946: if ($env{'form.forceedit'}) {
3947: $forceview = 1;
3948: } else {
3949: $forceedit = 1;
3950: }
3951: $cfile = $resurl;
3952: } elsif (($resurl =~ m{^/adm/wrapper/adm/$cdom/$cnum/\d+/ext\.tool$}) && ($env{'form.folderpath'} =~ /^supplemental/)) {
3953: $incourse = 1;
3954: if ($env{'form.forceedit'}) {
3955: $forceview = 1;
3956: } else {
3957: $forceedit = 1;
3958: }
3959: $cfile = $resurl;
3960: } elsif (($resurl eq '/adm/extresedit') && ($symb || $env{'form.folderpath'})) {
3961: $incourse = 1;
3962: $forceview = 1;
3963: if ($symb) {
3964: my ($map,$id,$res)=&decode_symb($symb);
3965: $env{'request.symb'} = $symb;
3966: $cfile = &clutter($res);
3967: } else {
3968: $cfile = $env{'form.suppurl'};
3969: my $escfile = &unescape($cfile);
3970: if ($escfile =~ m{^/adm/$cdom/$cnum/\d+/ext\.tool$}) {
3971: $cfile = '/adm/wrapper'.$escfile;
3972: } else {
3973: $escfile =~ s{^http://}{};
3974: $cfile = &escape("/adm/wrapper/ext/$escfile");
3975: }
3976: }
3977: } elsif ($resurl =~ m{^/?adm/viewclasslist$}) {
3978: if ($env{'form.forceedit'}) {
3979: $forceview = 1;
3980: } else {
3981: $forceedit = 1;
3982: }
3983: $cfile = ($resurl =~ m{^/} ? $resurl : "/$resurl");
3984: }
3985: }
3986: if ($uploaded || $incourse) {
3987: $home=&homeserver($cnum,$cdom);
3988: } elsif ($file !~ m{/$}) {
3989: $file=~s{^(priv/$match_domain/$match_username)}{/$1};
3990: $file=~s{^($match_domain/$match_username)}{/priv/$1};
3991: # Check that the user has permission to edit this resource
3992: my $setpriv = 1;
3993: my ($cfuname,$cfudom)=&constructaccess($file,$setpriv);
3994: if (defined($cfudom)) {
3995: $home=&homeserver($cfuname,$cfudom);
3996: $cfile=$file;
3997: }
3998: }
3999: if (($cfile ne '') && (!$incourse || $uploaded) &&
4000: (($home ne '') && ($home ne 'no_host'))) {
4001: my @ids=¤t_machine_ids();
4002: unless (grep(/^\Q$home\E$/,@ids)) {
4003: $switchserver=1;
4004: }
4005: }
4006: }
4007: return ($cfile,$home,$switchserver,$forceedit,$forceview);
4008: }
4009:
4010: sub is_course_upload {
4011: my ($file,$cnum,$cdom) = @_;
4012: my $uploadpath = &LONCAPA::propath($cdom,$cnum);
4013: $uploadpath =~ s{^\/}{};
4014: if (($file =~ m{^\Q$uploadpath\E/userfiles/(docs|supplemental)/}) ||
4015: ($file =~ m{^userfiles/\Q$cdom\E/\Q$cnum\E/(docs|supplemental)/})) {
4016: return 1;
4017: }
4018: return;
4019: }
4020:
4021: sub in_course {
4022: my ($udom,$uname,$cdom,$cnum,$type,$hideprivileged) = @_;
4023: if ($hideprivileged) {
4024: my $skipuser;
4025: my %coursehash = &coursedescription($cdom.'_'.$cnum);
4026: my @possdoms = ($cdom);
4027: if ($coursehash{'checkforpriv'}) {
4028: push(@possdoms,split(/,/,$coursehash{'checkforpriv'}));
4029: }
4030: if (&privileged($uname,$udom,\@possdoms)) {
4031: $skipuser = 1;
4032: if ($coursehash{'nothideprivileged'}) {
4033: foreach my $item (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
4034: my $user;
4035: if ($item =~ /:/) {
4036: $user = $item;
4037: } else {
4038: $user = join(':',split(/[\@]/,$item));
4039: }
4040: if ($user eq $uname.':'.$udom) {
4041: undef($skipuser);
4042: last;
4043: }
4044: }
4045: }
4046: if ($skipuser) {
4047: return 0;
4048: }
4049: }
4050: }
4051: $type ||= 'any';
4052: if (!defined($cdom) || !defined($cnum)) {
4053: my $cid = $env{'request.course.id'};
4054: $cdom = $env{'course.'.$cid.'.domain'};
4055: $cnum = $env{'course.'.$cid.'.num'};
4056: }
4057: my $typesref;
4058: if (($type eq 'any') || ($type eq 'all')) {
4059: $typesref = ['active','previous','future'];
4060: } elsif ($type eq 'previous' || $type eq 'future') {
4061: $typesref = [$type];
4062: }
4063: my %roles = &get_my_roles($uname,$udom,'userroles',
4064: $typesref,undef,[$cdom]);
4065: my ($tmp) = keys(%roles);
4066: return 0 if ($tmp =~ /^(con_lost|error|no_such_host)/i);
4067: my @course_roles = grep(/^\Q$cnum\E:\Q$cdom\E:/, keys(%roles));
4068: if (@course_roles > 0) {
4069: return 1;
4070: }
4071: return 0;
4072: }
4073:
4074: # --------- File operations in /home/httpd/html/userfiles/$domain/1/2/3/$course
4075: # input: action, courseID, current domain, intended
4076: # path to file, source of file, instruction to parse file for objects,
4077: # ref to hash for embedded objects,
4078: # ref to hash for codebase of java objects.
4079: # reference to scalar to accommodate mime type determined
4080: # from File::MMagic if $parser = parse.
4081: #
4082: # output: url to file (if action was uploaddoc),
4083: # ok if successful, or diagnostic message otherwise (if action was propagate or copy)
4084: #
4085: # Allows directory structure to be used within lonUsers/../userfiles/ for a
4086: # course.
4087: #
4088: # action = propagate - /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
4089: # will be copied to /home/httpd/lonUsers/1/2/3/$course/userfiles in
4090: # course's home server.
4091: #
4092: # action = copy - /home/httpd/html/userfiles/$domain/1/2/3/$course/$file will
4093: # be copied from $source (current location) to
4094: # /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
4095: # and will then be copied to
4096: # /home/httpd/lonUsers/$domain/1/2/3/$course/userfiles/$file in
4097: # course's home server.
4098: #
4099: # action = uploaddoc - /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
4100: # will be retrived from $env{form.uploaddoc} (from DOCS interface) to
4101: # /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
4102: # and will then be copied to /home/httpd/lonUsers/1/2/3/$course/userfiles/$file
4103: # in course's home server.
4104: #
4105:
4106: sub process_coursefile {
4107: my ($action,$docuname,$docudom,$file,$source,$parser,$allfiles,$codebase,
4108: $mimetype)=@_;
4109: my $fetchresult;
4110: my $home=&homeserver($docuname,$docudom);
4111: if ($action eq 'propagate') {
4112: $fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
4113: $home);
4114: } else {
4115: my $fpath = '';
4116: my $fname = $file;
4117: ($fpath,$fname) = ($file =~ m|^(.*)/([^/]+)$|);
4118: $fpath=$docudom.'/'.$docuname.'/'.$fpath;
4119: my $filepath = &build_filepath($fpath);
4120: if ($action eq 'copy') {
4121: if ($source eq '') {
4122: $fetchresult = 'no source file';
4123: return $fetchresult;
4124: } else {
4125: my $destination = $filepath.'/'.$fname;
4126: rename($source,$destination);
4127: $fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
4128: $home);
4129: }
4130: } elsif ($action eq 'uploaddoc') {
4131: open(my $fh,'>',$filepath.'/'.$fname);
4132: print $fh $env{'form.'.$source};
4133: close($fh);
4134: if ($parser eq 'parse') {
4135: my $mm = new File::MMagic;
4136: my $type = $mm->checktype_filename($filepath.'/'.$fname);
4137: if ($type eq 'text/html') {
4138: my $parse_result = &extract_embedded_items($filepath.'/'.$fname,$allfiles,$codebase);
4139: unless ($parse_result eq 'ok') {
4140: &logthis('Failed to parse '.$filepath.'/'.$fname.' for embedded media: '.$parse_result);
4141: }
4142: }
4143: if (ref($mimetype)) {
4144: $$mimetype = $type;
4145: }
4146: }
4147: $fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
4148: $home);
4149: if ($fetchresult eq 'ok') {
4150: return '/uploaded/'.$fpath.'/'.$fname;
4151: } else {
4152: &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$file.
4153: ' to host '.$home.': '.$fetchresult);
4154: return '/adm/notfound.html';
4155: }
4156: }
4157: }
4158: unless ( $fetchresult eq 'ok') {
4159: &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$file.
4160: ' to host '.$home.': '.$fetchresult);
4161: }
4162: return $fetchresult;
4163: }
4164:
4165: sub build_filepath {
4166: my ($fpath) = @_;
4167: my $filepath=$perlvar{'lonDocRoot'}.'/userfiles';
4168: unless ($fpath eq '') {
4169: my @parts=split('/',$fpath);
4170: foreach my $part (@parts) {
4171: $filepath.= '/'.$part;
4172: if ((-e $filepath)!=1) {
4173: mkdir($filepath,0777);
4174: }
4175: }
4176: }
4177: return $filepath;
4178: }
4179:
4180: sub store_edited_file {
4181: my ($primary_url,$content,$docudom,$docuname,$fetchresult) = @_;
4182: my $file = $primary_url;
4183: $file =~ s#^/uploaded/$docudom/$docuname/##;
4184: my $fpath = '';
4185: my $fname = $file;
4186: ($fpath,$fname) = ($file =~ m|^(.*)/([^/]+)$|);
4187: $fpath=$docudom.'/'.$docuname.'/'.$fpath;
4188: my $filepath = &build_filepath($fpath);
4189: open(my $fh,'>',$filepath.'/'.$fname);
4190: print $fh $content;
4191: close($fh);
4192: my $home=&homeserver($docuname,$docudom);
4193: $$fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
4194: $home);
4195: if ($$fetchresult eq 'ok') {
4196: return '/uploaded/'.$fpath.'/'.$fname;
4197: } else {
4198: &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$file.
4199: ' to host '.$home.': '.$$fetchresult);
4200: return '/adm/notfound.html';
4201: }
4202: }
4203:
4204: sub clean_filename {
4205: my ($fname,$args)=@_;
4206: # Replace Windows backslashes by forward slashes
4207: $fname=~s/\\/\//g;
4208: if (!$args->{'keep_path'}) {
4209: # Get rid of everything but the actual filename
4210: $fname=~s/^.*\/([^\/]+)$/$1/;
4211: }
4212: # Replace spaces by underscores
4213: $fname=~s/\s+/\_/g;
4214: # Transliterate non-ascii text to ascii
4215: my $lang = &Apache::lonlocal::current_language();
4216: $fname = &LONCAPA::transliterate::fname_to_ascii($fname,$lang);
4217: # Replace all other weird characters by nothing
4218: $fname=~s{[^/\w\.\-]}{}g;
4219: # Replace all .\d. sequences with _\d. so they no longer look like version
4220: # numbers
4221: $fname=~s/\.(\d+)(?=\.)/_$1/g;
4222: # Replace three or more adjacent underscores with one for consistency
4223: # with loncfile::filename_check() so complete url can be extracted by
4224: # lonnet::decode_symb()
4225: $fname=~s/_{3,}/_/g;
4226: return $fname;
4227: }
4228:
4229: # This Function checks if an Image's dimensions exceed either $resizewidth (width)
4230: # or $resizeheight (height) - both pixels. If so, the image is scaled to produce an
4231: # image with the same aspect ratio as the original, but with dimensions which do
4232: # not exceed $resizewidth and $resizeheight.
4233:
4234: sub resizeImage {
4235: my ($img_path,$resizewidth,$resizeheight) = @_;
4236: my $ima = Image::Magick->new;
4237: my $resized;
4238: if (-e $img_path) {
4239: $ima->Read($img_path);
4240: if (($resizewidth =~ /^\d+$/) && ($resizeheight > 0)) {
4241: my $width = $ima->Get('width');
4242: my $height = $ima->Get('height');
4243: if ($width > $resizewidth) {
4244: my $factor = $width/$resizewidth;
4245: my $newheight = $height/$factor;
4246: $ima->Scale(width=>$resizewidth,height=>$newheight);
4247: $resized = 1;
4248: }
4249: }
4250: if (($resizeheight =~ /^\d+$/) && ($resizeheight > 0)) {
4251: my $width = $ima->Get('width');
4252: my $height = $ima->Get('height');
4253: if ($height > $resizeheight) {
4254: my $factor = $height/$resizeheight;
4255: my $newwidth = $width/$factor;
4256: $ima->Scale(width=>$newwidth,height=>$resizeheight);
4257: $resized = 1;
4258: }
4259: }
4260: if ($resized) {
4261: $ima->Write($img_path);
4262: }
4263: }
4264: return;
4265: }
4266:
4267: # --------------- Take an uploaded file and put it into the userfiles directory
4268: # input: $formname - the contents of the file are in $env{"form.$formname"}
4269: # the desired filename is in $env{"form.$formname.filename"}
4270: # $context - possible values: coursedoc, existingfile, overwrite,
4271: # canceloverwrite, scantron or ''.
4272: # if 'coursedoc': upload to the current course
4273: # if 'existingfile': write file to tmp/overwrites directory
4274: # if 'canceloverwrite': delete file written to tmp/overwrites directory
4275: # $context is passed as argument to &finishuserfileupload
4276: # $subdir - directory in userfile to store the file into
4277: # $parser - instruction to parse file for objects ($parser = parse) or
4278: # if context is 'scantron', $parser is hashref of csv column mapping
4279: # (e.g.,{ PaperID => 0, LastName => 1, FirstName => 2, ID => 3,
4280: # Section => 4, CODE => 5, FirstQuestion => 9 }).
4281: # $allfiles - reference to hash for embedded objects
4282: # $codebase - reference to hash for codebase of java objects
4283: # $desuname - username for permanent storage of uploaded file
4284: # $dsetudom - domain for permanaent storage of uploaded file
4285: # $thumbwidth - width (pixels) of thumbnail to make for uploaded image
4286: # $thumbheight - height (pixels) of thumbnail to make for uploaded image
4287: # $resizewidth - width (pixels) to which to resize uploaded image
4288: # $resizeheight - height (pixels) to which to resize uploaded image
4289: # $mimetype - reference to scalar to accommodate mime type determined
4290: # from File::MMagic.
4291: #
4292: # output: url of file in userspace, or error: <message>
4293: # or /adm/notfound.html if failure to upload occurse
4294:
4295: sub userfileupload {
4296: my ($formname,$context,$subdir,$parser,$allfiles,$codebase,$destuname,
4297: $destudom,$thumbwidth,$thumbheight,$resizewidth,$resizeheight,$mimetype)=@_;
4298: if (!defined($subdir)) { $subdir='unknown'; }
4299: my $fname=$env{'form.'.$formname.'.filename'};
4300: $fname=&clean_filename($fname);
4301: # See if there is anything left
4302: unless ($fname) { return 'error: no uploaded file'; }
4303: # If filename now begins with a . prepend unix timestamp _ milliseconds
4304: if ($fname =~ /^\./) {
4305: my ($s,$usec) = &gettimeofday();
4306: while (length($usec) < 6) {
4307: $usec = '0'.$usec;
4308: }
4309: $fname = $s.'_'.substr($usec,0,3).$fname;
4310: }
4311: # Files uploaded to help request form, or uploaded to "create course" page are handled differently
4312: if ((($formname eq 'screenshot') && ($subdir eq 'helprequests')) ||
4313: (($formname eq 'coursecreatorxml') && ($subdir eq 'batchupload')) ||
4314: ($context eq 'existingfile') || ($context eq 'canceloverwrite')) {
4315: my $now = time;
4316: my $filepath;
4317: if (($formname eq 'screenshot') && ($subdir eq 'helprequests')) {
4318: $filepath = 'tmp/helprequests/'.$now;
4319: } elsif (($formname eq 'coursecreatorxml') && ($subdir eq 'batchupload')) {
4320: $filepath = 'tmp/addcourse/'.$destudom.'/web/'.$env{'user.name'}.
4321: '_'.$env{'user.domain'}.'/pending';
4322: } elsif (($context eq 'existingfile') || ($context eq 'canceloverwrite')) {
4323: my ($docuname,$docudom);
4324: if ($destudom =~ /^$match_domain$/) {
4325: $docudom = $destudom;
4326: } else {
4327: $docudom = $env{'user.domain'};
4328: }
4329: if ($destuname =~ /^$match_username$/) {
4330: $docuname = $destuname;
4331: } else {
4332: $docuname = $env{'user.name'};
4333: }
4334: if (exists($env{'form.group'})) {
4335: $docuname=$env{'course.'.$env{'request.course.id'}.'.num'};
4336: $docudom=$env{'course.'.$env{'request.course.id'}.'.domain'};
4337: }
4338: $filepath = 'tmp/overwrites/'.$docudom.'/'.$docuname.'/'.$subdir;
4339: if ($context eq 'canceloverwrite') {
4340: my $tempfile = $perlvar{'lonDaemons'}.'/'.$filepath.'/'.$fname;
4341: if (-e $tempfile) {
4342: my @info = stat($tempfile);
4343: if ($info[9] eq $env{'form.timestamp'}) {
4344: unlink($tempfile);
4345: }
4346: }
4347: return;
4348: }
4349: }
4350: # Create the directory if not present
4351: my @parts=split(/\//,$filepath);
4352: my $fullpath = $perlvar{'lonDaemons'};
4353: for (my $i=0;$i<@parts;$i++) {
4354: $fullpath .= '/'.$parts[$i];
4355: if ((-e $fullpath)!=1) {
4356: mkdir($fullpath,0777);
4357: }
4358: }
4359: open(my $fh,'>',$fullpath.'/'.$fname);
4360: print $fh $env{'form.'.$formname};
4361: close($fh);
4362: if ($context eq 'existingfile') {
4363: my @info = stat($fullpath.'/'.$fname);
4364: return ($fullpath.'/'.$fname,$info[9]);
4365: } else {
4366: return $fullpath.'/'.$fname;
4367: }
4368: }
4369: if ($subdir eq 'scantron') {
4370: $fname = 'scantron_orig_'.$fname;
4371: } else {
4372: $fname="$subdir/$fname";
4373: }
4374: if ($context eq 'coursedoc') {
4375: my $docuname=$env{'course.'.$env{'request.course.id'}.'.num'};
4376: my $docudom=$env{'course.'.$env{'request.course.id'}.'.domain'};
4377: if ($env{'form.folder'} =~ m/^(default|supplemental)/) {
4378: return &finishuserfileupload($docuname,$docudom,
4379: $formname,$fname,$parser,$allfiles,
4380: $codebase,$thumbwidth,$thumbheight,
4381: $resizewidth,$resizeheight,$context,$mimetype);
4382: } else {
4383: if ($env{'form.folder'}) {
4384: $fname=$env{'form.folder'}.'/'.$fname;
4385: }
4386: return &process_coursefile('uploaddoc',$docuname,$docudom,
4387: $fname,$formname,$parser,
4388: $allfiles,$codebase,$mimetype);
4389: }
4390: } elsif (defined($destuname)) {
4391: my $docuname=$destuname;
4392: my $docudom=$destudom;
4393: return &finishuserfileupload($docuname,$docudom,$formname,$fname,
4394: $parser,$allfiles,$codebase,
4395: $thumbwidth,$thumbheight,
4396: $resizewidth,$resizeheight,$context,$mimetype);
4397: } else {
4398: my $docuname=$env{'user.name'};
4399: my $docudom=$env{'user.domain'};
4400: if ((exists($env{'form.group'})) || ($context eq 'syllabus')) {
4401: $docuname=$env{'course.'.$env{'request.course.id'}.'.num'};
4402: $docudom=$env{'course.'.$env{'request.course.id'}.'.domain'};
4403: }
4404: return &finishuserfileupload($docuname,$docudom,$formname,$fname,
4405: $parser,$allfiles,$codebase,
4406: $thumbwidth,$thumbheight,
4407: $resizewidth,$resizeheight,$context,$mimetype);
4408: }
4409: }
4410:
4411: sub finishuserfileupload {
4412: my ($docuname,$docudom,$formname,$fname,$parser,$allfiles,$codebase,
4413: $thumbwidth,$thumbheight,$resizewidth,$resizeheight,$context,$mimetype) = @_;
4414: my $path=$docudom.'/'.$docuname.'/';
4415: my $filepath=$perlvar{'lonDocRoot'};
4416:
4417: my ($fnamepath,$file,$fetchthumb);
4418: $file=$fname;
4419: if ($fname=~m|/|) {
4420: ($fnamepath,$file) = ($fname =~ m|^(.*)/([^/]+)$|);
4421: $path.=$fnamepath.'/';
4422: }
4423: my @parts=split(/\//,$filepath.'/userfiles/'.$path);
4424: my $count;
4425: for ($count=4;$count<=$#parts;$count++) {
4426: $filepath.="/$parts[$count]";
4427: if ((-e $filepath)!=1) {
4428: mkdir($filepath,0777);
4429: }
4430: }
4431:
4432: # Save the file
4433: {
4434: if (!open(FH,'>',$filepath.'/'.$file)) {
4435: &logthis('Failed to create '.$filepath.'/'.$file);
4436: print STDERR ('Failed to create '.$filepath.'/'.$file."\n");
4437: return '/adm/notfound.html';
4438: }
4439: if ($context eq 'overwrite') {
4440: my $source = LONCAPA::tempdir().'/overwrites/'.$docudom.'/'.$docuname.'/'.$fname;
4441: my $target = $filepath.'/'.$file;
4442: if (-e $source) {
4443: my @info = stat($source);
4444: if ($info[9] eq $env{'form.timestamp'}) {
4445: unless (&File::Copy::move($source,$target)) {
4446: &logthis('Failed to overwrite '.$filepath.'/'.$file);
4447: return "Moving from $source failed";
4448: }
4449: } else {
4450: return "Temporary file: $source had unexpected date/time for last modification";
4451: }
4452: } else {
4453: return "Temporary file: $source missing";
4454: }
4455: } elsif (!print FH ($env{'form.'.$formname})) {
4456: &logthis('Failed to write to '.$filepath.'/'.$file);
4457: print STDERR ('Failed to write to '.$filepath.'/'.$file."\n");
4458: return '/adm/notfound.html';
4459: }
4460: close(FH);
4461: if ($resizewidth && $resizeheight) {
4462: my $mm = new File::MMagic;
4463: my $mime_type = $mm->checktype_filename($filepath.'/'.$file);
4464: if ($mime_type =~ m{^image/}) {
4465: &resizeImage($filepath.'/'.$file,$resizewidth,$resizeheight);
4466: }
4467: }
4468: }
4469: if (($context eq 'coursedoc') || ($parser eq 'parse')) {
4470: if (ref($mimetype)) {
4471: if ($$mimetype eq '') {
4472: my $mm = new File::MMagic;
4473: my $type = $mm->checktype_filename($filepath.'/'.$file);
4474: $$mimetype = $type;
4475: }
4476: }
4477: }
4478: if (($context ne 'scantron') && ($parser eq 'parse')) {
4479: if ((ref($mimetype)) && ($$mimetype eq 'text/html')) {
4480: my $parse_result = &extract_embedded_items($filepath.'/'.$file,
4481: $allfiles,$codebase);
4482: unless ($parse_result eq 'ok') {
4483: &logthis('Failed to parse '.$filepath.$file.
4484: ' for embedded media: '.$parse_result);
4485: }
4486: }
4487: } elsif (($context eq 'scantron') && (ref($parser) eq 'HASH')) {
4488: my $format = $env{'form.scantron_format'};
4489: &bubblesheet_converter($docudom,$filepath.'/'.$file,$parser,$format);
4490: }
4491: if (($thumbwidth =~ /^\d+$/) && ($thumbheight =~ /^\d+$/)) {
4492: my $input = $filepath.'/'.$file;
4493: my $output = $filepath.'/'.'tn-'.$file;
4494: my $thumbsize = $thumbwidth.'x'.$thumbheight;
4495: my @args = ('convert','-sample',$thumbsize,$input,$output);
4496: system({$args[0]} @args);
4497: if (-e $filepath.'/'.'tn-'.$file) {
4498: $fetchthumb = 1;
4499: }
4500: }
4501:
4502: # Notify homeserver to grep it
4503: #
4504: my $docuhome=&homeserver($docuname,$docudom);
4505: my $fetchresult= &reply('fetchuserfile:'.$path.$file,$docuhome);
4506: if ($fetchresult eq 'ok') {
4507: if ($fetchthumb) {
4508: my $thumbresult= &reply('fetchuserfile:'.$path.'tn-'.$file,$docuhome);
4509: if ($thumbresult ne 'ok') {
4510: &logthis('Failed to transfer '.$path.'tn-'.$file.' to host '.
4511: $docuhome.': '.$thumbresult);
4512: }
4513: }
4514: #
4515: # Return the URL to it
4516: return '/uploaded/'.$path.$file;
4517: } else {
4518: &logthis('Failed to transfer '.$path.$file.' to host '.$docuhome.
4519: ': '.$fetchresult);
4520: return '/adm/notfound.html';
4521: }
4522: }
4523:
4524: sub extract_embedded_items {
4525: my ($fullpath,$allfiles,$codebase,$content) = @_;
4526: my @state = ();
4527: my (%lastids,%related,%shockwave,%flashvars);
4528: my %javafiles = (
4529: codebase => '',
4530: code => '',
4531: archive => ''
4532: );
4533: my %mediafiles = (
4534: src => '',
4535: movie => '',
4536: );
4537: my $p;
4538: if ($content) {
4539: $p = HTML::LCParser->new($content);
4540: } else {
4541: $p = HTML::LCParser->new($fullpath);
4542: }
4543: while (my $t=$p->get_token()) {
4544: if ($t->[0] eq 'S') {
4545: my ($tagname, $attr) = ($t->[1],$t->[2]);
4546: push(@state, $tagname);
4547: if (lc($tagname) eq 'allow') {
4548: &add_filetype($allfiles,$attr->{'src'},'src');
4549: }
4550: if (lc($tagname) eq 'img') {
4551: &add_filetype($allfiles,$attr->{'src'},'src');
4552: }
4553: if (lc($tagname) eq 'a') {
4554: unless (($attr->{'href'} =~ /^#/) || ($attr->{'href'} eq '')) {
4555: &add_filetype($allfiles,$attr->{'href'},'href');
4556: }
4557: }
4558: if (lc($tagname) eq 'script') {
4559: my $src;
4560: if ($attr->{'archive'} =~ /\.jar$/i) {
4561: &add_filetype($allfiles,$attr->{'archive'},'archive');
4562: } else {
4563: if ($attr->{'src'} ne '') {
4564: $src = $attr->{'src'};
4565: &add_filetype($allfiles,$src,'src');
4566: }
4567: }
4568: my $text = $p->get_trimmed_text();
4569: if ($text =~ /\Qswfobject.registerObject(\E([^\)]+)\)/) {
4570: my @swfargs = split(/,/,$1);
4571: foreach my $item (@swfargs) {
4572: $item =~ s/["']//g;
4573: $item =~ s/^\s+//;
4574: $item =~ s/\s+$//;
4575: }
4576: if (($swfargs[0] ne'') && ($swfargs[2] ne '')) {
4577: if (ref($related{$swfargs[0]}) eq 'ARRAY') {
4578: push(@{$related{$swfargs[0]}},$swfargs[2]);
4579: } else {
4580: $related{$swfargs[0]} = [$swfargs[2]];
4581: }
4582: }
4583: }
4584: }
4585: if (lc($tagname) eq 'link') {
4586: if (lc($attr->{'rel'}) eq 'stylesheet') {
4587: &add_filetype($allfiles,$attr->{'href'},'href');
4588: }
4589: }
4590: if (lc($tagname) eq 'object' ||
4591: (lc($tagname) eq 'embed' && lc($state[-2]) ne 'object')) {
4592: foreach my $item (keys(%javafiles)) {
4593: $javafiles{$item} = '';
4594: }
4595: if ((lc($tagname) eq 'object') && (lc($state[-2]) ne 'object')) {
4596: $lastids{lc($tagname)} = $attr->{'id'};
4597: }
4598: }
4599: if (lc($state[-2]) eq 'object' && lc($tagname) eq 'param') {
4600: my $name = lc($attr->{'name'});
4601: foreach my $item (keys(%javafiles)) {
4602: if ($name eq $item) {
4603: $javafiles{$item} = $attr->{'value'};
4604: last;
4605: }
4606: }
4607: my $pathfrom;
4608: foreach my $item (keys(%mediafiles)) {
4609: if ($name eq $item) {
4610: $pathfrom = $attr->{'value'};
4611: $shockwave{$lastids{lc($state[-2])}} = $pathfrom;
4612: &add_filetype($allfiles,$pathfrom,$name);
4613: last;
4614: }
4615: }
4616: if ($name eq 'flashvars') {
4617: $flashvars{$lastids{lc($state[-2])}} = $attr->{'value'};
4618: }
4619: if ($pathfrom ne '') {
4620: &embedded_dependency($allfiles,\%related,$lastids{lc($state[-2])},
4621: $pathfrom);
4622: }
4623: }
4624: if (lc($tagname) eq 'embed' || lc($tagname) eq 'applet') {
4625: foreach my $item (keys(%javafiles)) {
4626: if ($attr->{$item}) {
4627: $javafiles{$item} = $attr->{$item};
4628: last;
4629: }
4630: }
4631: foreach my $item (keys(%mediafiles)) {
4632: if ($attr->{$item}) {
4633: &add_filetype($allfiles,$attr->{$item},$item);
4634: last;
4635: }
4636: }
4637: if (lc($tagname) eq 'embed') {
4638: if (($attr->{'name'} ne '') && ($attr->{'src'} ne '')) {
4639: &embedded_dependency($allfiles,\%related,$attr->{'name'},
4640: $attr->{'src'});
4641: }
4642: }
4643: }
4644: if (lc($tagname) eq 'iframe') {
4645: my $src = $attr->{'src'} ;
4646: if (($src ne '') && ($src !~ m{^(/|https?://)})) {
4647: &add_filetype($allfiles,$src,'src');
4648: } elsif ($src =~ m{^/}) {
4649: if ($env{'request.course.id'}) {
4650: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
4651: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
4652: my $url = &hreflocation('',$fullpath);
4653: if ($url =~ m{^/uploaded/$cdom/$cnum/docs/(\w+/\d+)/}) {
4654: my $relpath = $1;
4655: if ($src =~ m{^/uploaded/$cdom/$cnum/docs/\Q$relpath\E/(.+)$}) {
4656: &add_filetype($allfiles,$1,'src');
4657: }
4658: }
4659: }
4660: }
4661: }
4662: if ($t->[4] =~ m{/>$}) {
4663: pop(@state);
4664: }
4665: } elsif ($t->[0] eq 'E') {
4666: my ($tagname) = ($t->[1]);
4667: if ($javafiles{'codebase'} ne '') {
4668: $javafiles{'codebase'} .= '/';
4669: }
4670: if (lc($tagname) eq 'applet' ||
4671: lc($tagname) eq 'object' ||
4672: (lc($tagname) eq 'embed' && lc($state[-2]) ne 'object')
4673: ) {
4674: foreach my $item (keys(%javafiles)) {
4675: if ($item ne 'codebase' && $javafiles{$item} ne '') {
4676: my $file=$javafiles{'codebase'}.$javafiles{$item};
4677: &add_filetype($allfiles,$file,$item);
4678: }
4679: }
4680: }
4681: pop @state;
4682: }
4683: }
4684: foreach my $id (sort(keys(%flashvars))) {
4685: if ($shockwave{$id} ne '') {
4686: my @pairs = split(/\&/,$flashvars{$id});
4687: foreach my $pair (@pairs) {
4688: my ($key,$value) = split(/\=/,$pair);
4689: if ($key eq 'thumb') {
4690: &add_filetype($allfiles,$value,$key);
4691: } elsif ($key eq 'content') {
4692: my ($path) = ($shockwave{$id} =~ m{^(.+/)[^/]+$});
4693: my ($ext) = ($value =~ /\.([^.]+)$/);
4694: if ($ext ne '') {
4695: &add_filetype($allfiles,$path.$value,$ext);
4696: }
4697: }
4698: }
4699: }
4700: }
4701: return 'ok';
4702: }
4703:
4704: sub add_filetype {
4705: my ($allfiles,$file,$type)=@_;
4706: if (exists($allfiles->{$file})) {
4707: unless (grep/^\Q$type\E$/, @{$allfiles->{$file}}) {
4708: push(@{$allfiles->{$file}}, &escape($type));
4709: }
4710: } else {
4711: @{$allfiles->{$file}} = (&escape($type));
4712: }
4713: }
4714:
4715: sub embedded_dependency {
4716: my ($allfiles,$related,$identifier,$pathfrom) = @_;
4717: if ((ref($allfiles) eq 'HASH') && (ref($related) eq 'HASH')) {
4718: if (($identifier ne '') &&
4719: (ref($related->{$identifier}) eq 'ARRAY') &&
4720: ($pathfrom ne '')) {
4721: my ($path) = ($pathfrom =~ m{^(.+/)[^/]+$});
4722: foreach my $dep (@{$related->{$identifier}}) {
4723: &add_filetype($allfiles,$path.$dep,'object');
4724: }
4725: }
4726: }
4727: return;
4728: }
4729:
4730: sub bubblesheet_converter {
4731: my ($cdom,$fullpath,$config,$format) = @_;
4732: if ((&domain($cdom) ne '') &&
4733: ($fullpath =~ m{^\Q$perlvar{'lonDocRoot'}/userfiles/$cdom/\E$match_courseid/scantron_orig}) &&
4734: (-e $fullpath) && (ref($config) eq 'HASH') && ($format ne '')) {
4735: my (%csvcols,%csvoptions);
4736: if (ref($config->{'fields'}) eq 'HASH') {
4737: %csvcols = %{$config->{'fields'}};
4738: }
4739: if (ref($config->{'options'}) eq 'HASH') {
4740: %csvoptions = %{$config->{'options'}};
4741: }
4742: my %csvbynum = reverse(%csvcols);
4743: my %scantronconf = &get_scantron_config($format,$cdom);
4744: if (keys(%scantronconf)) {
4745: my %bynum = (
4746: $scantronconf{CODEstart} => 'CODEstart',
4747: $scantronconf{IDstart} => 'IDstart',
4748: $scantronconf{PaperID} => 'PaperID',
4749: $scantronconf{FirstName} => 'FirstName',
4750: $scantronconf{LastName} => 'LastName',
4751: $scantronconf{Qstart} => 'Qstart',
4752: );
4753: my @ordered;
4754: foreach my $item (sort { $a <=> $b } keys(%bynum)) {
4755: push(@ordered,$bynum{$item});
4756: }
4757: my %mapstart = (
4758: CODEstart => 'CODE',
4759: IDstart => 'ID',
4760: PaperID => 'PaperID',
4761: FirstName => 'FirstName',
4762: LastName => 'LastName',
4763: Qstart => 'FirstQuestion',
4764: );
4765: my %maplength = (
4766: CODEstart => 'CODElength',
4767: IDstart => 'IDlength',
4768: PaperID => 'PaperIDlength',
4769: FirstName => 'FirstNamelength',
4770: LastName => 'LastNamelength',
4771: );
4772: if (open(my $fh,'<',$fullpath)) {
4773: my $output;
4774: my %lettdig = &letter_to_digits();
4775: my %diglett = reverse(%lettdig);
4776: my $numletts = scalar(keys(%lettdig));
4777: my $num = 0;
4778: while (my $line=<$fh>) {
4779: $num ++;
4780: next if (($num == 1) && ($csvoptions{'hdr'} == 1));
4781: $line =~ s{[\r\n]+$}{};
4782: my %found;
4783: my @values = split(/,/,$line,-1);
4784: my ($qstart,$record);
4785: for (my $i=0; $i<@values; $i++) {
4786: if ((($qstart ne '') && ($i > $qstart)) ||
4787: ($csvbynum{$i} eq 'FirstQuestion')) {
4788: if ($values[$i] eq '') {
4789: $values[$i] = $scantronconf{'Qoff'};
4790: } elsif ($scantronconf{'Qon'} eq 'number') {
4791: if ($values[$i] =~ /^[A-Ja-j]$/) {
4792: $values[$i] = $lettdig{uc($values[$i])};
4793: }
4794: } elsif ($scantronconf{'Qon'} eq 'letter') {
4795: if ($values[$i] =~ /^[0-9]$/) {
4796: $values[$i] = $diglett{$values[$i]};
4797: }
4798: } else {
4799: if ($values[$i] =~ /^[0-9A-Ja-j]$/) {
4800: my $digit;
4801: if ($values[$i] =~ /^[A-Ja-j]$/) {
4802: $digit = $lettdig{uc($values[$i])}-1;
4803: if ($values[$i] eq 'J') {
4804: $digit += $numletts;
4805: }
4806: } elsif ($values[$i] =~ /^[0-9]$/) {
4807: $digit = $values[$i]-1;
4808: if ($values[$i] eq '0') {
4809: $digit += $numletts;
4810: }
4811: }
4812: my $qval='';
4813: for (my $j=0; $j<$scantronconf{'Qlength'}; $j++) {
4814: if ($j == $digit) {
4815: $qval .= $scantronconf{'Qon'};
4816: } else {
4817: $qval .= $scantronconf{'Qoff'};
4818: }
4819: }
4820: $values[$i] = $qval;
4821: }
4822: }
4823: if (length($values[$i]) > $scantronconf{'Qlength'}) {
4824: $values[$i] = substr($values[$i],0,$scantronconf{'Qlength'});
4825: }
4826: my $numblank = $scantronconf{'Qlength'} - length($values[$i]);
4827: if ($numblank > 0) {
4828: $values[$i] .= ($scantronconf{'Qoff'} x $numblank);
4829: }
4830: if ($csvbynum{$i} eq 'FirstQuestion') {
4831: $qstart = $i;
4832: $found{$csvbynum{$i}} = $values[$i];
4833: } else {
4834: $found{'FirstQuestion'} .= $values[$i];
4835: }
4836: } elsif (exists($csvbynum{$i})) {
4837: if ($csvoptions{'rem'}) {
4838: $values[$i] =~ s/^\s+//;
4839: }
4840: if (($csvbynum{$i} eq 'PaperID') && ($csvoptions{'pad'})) {
4841: while (length($values[$i]) < $scantronconf{$maplength{$csvbynum{$i}}}) {
4842: $values[$i] = '0'.$values[$i];
4843: }
4844: }
4845: $found{$csvbynum{$i}} = $values[$i];
4846: }
4847: }
4848: foreach my $item (@ordered) {
4849: my $currlength = 1+length($record);
4850: my $numspaces = $scantronconf{$item} - $currlength;
4851: if ($numspaces > 0) {
4852: $record .= (' ' x $numspaces);
4853: }
4854: if (($mapstart{$item} ne '') && (exists($found{$mapstart{$item}}))) {
4855: unless ($item eq 'Qstart') {
4856: if (length($found{$mapstart{$item}}) > $scantronconf{$maplength{$item}}) {
4857: $found{$mapstart{$item}} = substr($found{$mapstart{$item}},0,$scantronconf{$maplength{$item}});
4858: }
4859: }
4860: $record .= $found{$mapstart{$item}};
4861: }
4862: }
4863: $output .= "$record\n";
4864: }
4865: close($fh);
4866: if ($output) {
4867: if (open(my $fh,'>',$fullpath)) {
4868: print $fh $output;
4869: close($fh);
4870: }
4871: }
4872: }
4873: }
4874: return;
4875: }
4876: }
4877:
4878: sub letter_to_digits {
4879: my %lettdig = (
4880: A => 1,
4881: B => 2,
4882: C => 3,
4883: D => 4,
4884: E => 5,
4885: F => 6,
4886: G => 7,
4887: H => 8,
4888: I => 9,
4889: J => 0,
4890: );
4891: return %lettdig;
4892: }
4893:
4894: sub get_scantron_config {
4895: my ($which,$cdom) = @_;
4896: my @lines = &get_scantronformat_file($cdom);
4897: my %config;
4898: #FIXME probably should move to XML it has already gotten a bit much now
4899: foreach my $line (@lines) {
4900: my ($name,$descrip)=split(/:/,$line);
4901: if ($name ne $which ) { next; }
4902: chomp($line);
4903: my @config=split(/:/,$line);
4904: $config{'name'}=$config[0];
4905: $config{'description'}=$config[1];
4906: $config{'CODElocation'}=$config[2];
4907: $config{'CODEstart'}=$config[3];
4908: $config{'CODElength'}=$config[4];
4909: $config{'IDstart'}=$config[5];
4910: $config{'IDlength'}=$config[6];
4911: $config{'Qstart'}=$config[7];
4912: $config{'Qlength'}=$config[8];
4913: $config{'Qoff'}=$config[9];
4914: $config{'Qon'}=$config[10];
4915: $config{'PaperID'}=$config[11];
4916: $config{'PaperIDlength'}=$config[12];
4917: $config{'FirstName'}=$config[13];
4918: $config{'FirstNamelength'}=$config[14];
4919: $config{'LastName'}=$config[15];
4920: $config{'LastNamelength'}=$config[16];
4921: $config{'BubblesPerRow'}=$config[17];
4922: last;
4923: }
4924: return %config;
4925: }
4926:
4927: sub get_scantronformat_file {
4928: my ($cdom) = @_;
4929: if ($cdom eq '') {
4930: $cdom= $env{'course.'.$env{'request.course.id'}.'.domain'};
4931: }
4932: my %domconfig = &get_dom('configuration',['scantron'],$cdom);
4933: my $gottab = 0;
4934: my @lines;
4935: if (ref($domconfig{'scantron'}) eq 'HASH') {
4936: if ($domconfig{'scantron'}{'scantronformat'} ne '') {
4937: my $formatfile = &getfile($perlvar{'lonDocRoot'}.$domconfig{'scantron'}{'scantronformat'});
4938: if ($formatfile ne '-1') {
4939: @lines = split("\n",$formatfile,-1);
4940: $gottab = 1;
4941: }
4942: }
4943: }
4944: if (!$gottab) {
4945: my $confname = $cdom.'-domainconfig';
4946: my $default = $perlvar{'lonDocRoot'}.'/res/'.$cdom.'/'.$confname.'/default.tab';
4947: my $formatfile = &getfile($default);
4948: if ($formatfile ne '-1') {
4949: @lines = split("\n",$formatfile,-1);
4950: $gottab = 1;
4951: }
4952: }
4953: if (!$gottab) {
4954: my @domains = ¤t_machine_domains();
4955: if (grep(/^\Q$cdom\E$/,@domains)) {
4956: if (open(my $fh,'<',$perlvar{'lonTabDir'}.'/scantronformat.tab')) {
4957: @lines = <$fh>;
4958: close($fh);
4959: }
4960: } else {
4961: if (open(my $fh,'<',$perlvar{'lonTabDir'}.'/default_scantronformat.tab')) {
4962: @lines = <$fh>;
4963: close($fh);
4964: }
4965: }
4966: chomp(@lines);
4967: }
4968: return @lines;
4969: }
4970:
4971: sub removeuploadedurl {
4972: my ($url)=@_;
4973: my (undef,undef,$udom,$uname,$fname)=split('/',$url,5);
4974: return &removeuserfile($uname,$udom,$fname);
4975: }
4976:
4977: sub removeuserfile {
4978: my ($docuname,$docudom,$fname)=@_;
4979: my $home=&homeserver($docuname,$docudom);
4980: my $result = &reply("removeuserfile:$docudom/$docuname/$fname",$home);
4981: if ($result eq 'ok') {
4982: if (($fname !~ /\.meta$/) && (&is_portfolio_file($fname))) {
4983: my $metafile = $fname.'.meta';
4984: my $metaresult = &removeuserfile($docuname,$docudom,$metafile);
4985: my $url = "/uploaded/$docudom/$docuname/$fname";
4986: my ($file,$group) = (&parse_portfolio_url($url))[3,4];
4987: my $sqlresult =
4988: &update_portfolio_table($docuname,$docudom,$file,
4989: 'portfolio_metadata',$group,
4990: 'delete');
4991: }
4992: }
4993: return $result;
4994: }
4995:
4996: sub mkdiruserfile {
4997: my ($docuname,$docudom,$dir)=@_;
4998: my $home=&homeserver($docuname,$docudom);
4999: return &reply("mkdiruserfile:".&escape("$docudom/$docuname/$dir"),$home);
5000: }
5001:
5002: sub renameuserfile {
5003: my ($docuname,$docudom,$old,$new)=@_;
5004: my $home=&homeserver($docuname,$docudom);
5005: my $result = &reply("renameuserfile:$docudom:$docuname:".
5006: &escape("$old").':'.&escape("$new"),$home);
5007: if ($result eq 'ok') {
5008: if (($old !~ /\.meta$/) && (&is_portfolio_file($old))) {
5009: my $oldmeta = $old.'.meta';
5010: my $newmeta = $new.'.meta';
5011: my $metaresult =
5012: &renameuserfile($docuname,$docudom,$oldmeta,$newmeta);
5013: my $url = "/uploaded/$docudom/$docuname/$old";
5014: my ($file,$group) = (&parse_portfolio_url($url))[3,4];
5015: my $sqlresult =
5016: &update_portfolio_table($docuname,$docudom,$file,
5017: 'portfolio_metadata',$group,
5018: 'delete');
5019: }
5020: }
5021: return $result;
5022: }
5023:
5024: # ------------------------------------------------------------------------- Log
5025:
5026: sub log {
5027: my ($dom,$nam,$hom,$what)=@_;
5028: return critical("log:$dom:$nam:$what",$hom);
5029: }
5030:
5031: # ------------------------------------------------------------------ Course Log
5032: #
5033: # This routine flushes several buffers of non-mission-critical nature
5034: #
5035:
5036: sub flushcourselogs {
5037: &logthis('Flushing log buffers');
5038: #
5039: # course logs
5040: # This is a log of all transactions in a course, which can be used
5041: # for data mining purposes
5042: #
5043: # It also collects the courseid database, which lists last transaction
5044: # times and course titles for all courseids
5045: #
5046: my %courseidbuffer=();
5047: foreach my $crsid (keys(%courselogs)) {
5048: if (&reply('log:'.$coursedombuf{$crsid}.':'.$coursenumbuf{$crsid}.':'.
5049: &escape($courselogs{$crsid}),
5050: $coursehombuf{$crsid}) eq 'ok') {
5051: delete $courselogs{$crsid};
5052: } else {
5053: &logthis('Failed to flush log buffer for '.$crsid);
5054: if (length($courselogs{$crsid})>40000) {
5055: &logthis("<font color=\"blue\">WARNING: Buffer for ".$crsid.
5056: " exceeded maximum size, deleting.</font>");
5057: delete $courselogs{$crsid};
5058: }
5059: }
5060: $courseidbuffer{$coursehombuf{$crsid}}{$crsid} = {
5061: 'description' => $coursedescrbuf{$crsid},
5062: 'inst_code' => $courseinstcodebuf{$crsid},
5063: 'type' => $coursetypebuf{$crsid},
5064: 'owner' => $courseownerbuf{$crsid},
5065: };
5066: }
5067: #
5068: # Write course id database (reverse lookup) to homeserver of courses
5069: # Is used in pickcourse
5070: #
5071: foreach my $crs_home (keys(%courseidbuffer)) {
5072: my $response = &courseidput(&host_domain($crs_home),
5073: $courseidbuffer{$crs_home},
5074: $crs_home,'timeonly');
5075: }
5076: #
5077: # File accesses
5078: # Writes to the dynamic metadata of resources to get hit counts, etc.
5079: #
5080: foreach my $entry (keys(%accesshash)) {
5081: if ($entry =~ /___count$/) {
5082: my ($dom,$name);
5083: ($dom,$name,undef)=
5084: ($entry=~m{___($match_domain)/($match_name)/(.*)___count$});
5085: if (! defined($dom) || $dom eq '' ||
5086: ! defined($name) || $name eq '') {
5087: my $cid = $env{'request.course.id'};
5088: #
5089: # FIXME 11/29/2021
5090: # Typo in rev. 1.458 (2003/12/09)??
5091: # These should likely by $env{'course.'.$cid.'.domain'} and $env{'course.'.$cid.'.num'}
5092: #
5093: # While these ramain as $env{'request.'.$cid.'.domain'} and $env{'request.'.$cid.'.num'}
5094: # $dom and $name will always be null, so the &inc() call will default to storing this data
5095: # in a nohist_accesscount.db file for the user rather than the course.
5096: #
5097: # That said there is a lot of noise in the data being stored.
5098: # So counts for prtspool/ and adm/ etc. are recorded.
5099: #
5100: # A review of which items ending '___count' are written to %accesshash should likely be
5101: # made before deciding whether to set these to 'course.' instead of 'request.'
5102: #
5103: # Under the current scheme each user receives a nohist_accesscount.db file listing
5104: # accesses for things which are not published resources, regardless of course, and
5105: # there is not a nohist_accesscount.db file in a course, which might log accesses from
5106: # anyone in the course for things which are not published resources.
5107: #
5108: # For an author, nohist_accesscount.db ends up having records for other items
5109: # mixed up with the legitimate access counts for the author's published resources.
5110: #
5111: $dom = $env{'request.'.$cid.'.domain'};
5112: $name = $env{'request.'.$cid.'.num'};
5113: }
5114: my $value = $accesshash{$entry};
5115: my (undef,$url,undef) = ($entry =~ /^(.*)___(.*)___count$/);
5116: my %temphash=($url => $value);
5117: my $result = &inc('nohist_accesscount',\%temphash,$dom,$name);
5118: if ($result eq 'ok') {
5119: delete $accesshash{$entry};
5120: }
5121: } else {
5122: my ($dom,$name) = ($entry=~m{___($match_domain)/($match_name)/(.*)___(\w+)$});
5123: if (($dom eq 'uploaded') || ($dom eq 'adm')) { next; }
5124: my %temphash=($entry => $accesshash{$entry});
5125: if (&put('nohist_resevaldata',\%temphash,$dom,$name) eq 'ok') {
5126: delete $accesshash{$entry};
5127: }
5128: }
5129: }
5130: #
5131: # Roles
5132: # Reverse lookup of user roles for course faculty/staff and co-authorship
5133: #
5134: foreach my $entry (keys(%userrolehash)) {
5135: my ($role,$uname,$udom,$runame,$rudom,$rsec)=
5136: split(/\:/,$entry);
5137: if (&Apache::lonnet::put('nohist_userroles',
5138: { $role.':'.$uname.':'.$udom.':'.$rsec => $userrolehash{$entry} },
5139: $rudom,$runame) eq 'ok') {
5140: delete $userrolehash{$entry};
5141: }
5142: }
5143: #
5144: # Reverse lookup of domain roles (dc, ad, li, sc, dh, da, au)
5145: #
5146: my %domrolebuffer = ();
5147: foreach my $entry (keys(%domainrolehash)) {
5148: my ($role,$uname,$udom,$runame,$rudom,$rsec)=split(/:/,$entry);
5149: if ($domrolebuffer{$rudom}) {
5150: $domrolebuffer{$rudom}.='&'.&escape($entry).
5151: '='.&escape($domainrolehash{$entry});
5152: } else {
5153: $domrolebuffer{$rudom}.=&escape($entry).
5154: '='.&escape($domainrolehash{$entry});
5155: }
5156: delete $domainrolehash{$entry};
5157: }
5158: foreach my $dom (keys(%domrolebuffer)) {
5159: my %servers;
5160: if (defined(&domain($dom,'primary'))) {
5161: my $primary=&domain($dom,'primary');
5162: my $hostname=&hostname($primary);
5163: $servers{$primary} = $hostname;
5164: } else {
5165: %servers = &get_servers($dom,'library');
5166: }
5167: foreach my $tryserver (keys(%servers)) {
5168: if (&reply('domroleput:'.$dom.':'.
5169: $domrolebuffer{$dom},$tryserver) eq 'ok') {
5170: last;
5171: } else {
5172: &logthis('Put of domain roles failed for '.$dom.' and '.$tryserver);
5173: }
5174: }
5175: }
5176: $dumpcount++;
5177: }
5178:
5179: sub courselog {
5180: my $what=shift;
5181: $what=time.':'.$what;
5182: unless ($env{'request.course.id'}) { return ''; }
5183: $coursedombuf{$env{'request.course.id'}}=
5184: $env{'course.'.$env{'request.course.id'}.'.domain'};
5185: $coursenumbuf{$env{'request.course.id'}}=
5186: $env{'course.'.$env{'request.course.id'}.'.num'};
5187: $coursehombuf{$env{'request.course.id'}}=
5188: $env{'course.'.$env{'request.course.id'}.'.home'};
5189: $coursedescrbuf{$env{'request.course.id'}}=
5190: $env{'course.'.$env{'request.course.id'}.'.description'};
5191: $courseinstcodebuf{$env{'request.course.id'}}=
5192: $env{'course.'.$env{'request.course.id'}.'.internal.coursecode'};
5193: $courseownerbuf{$env{'request.course.id'}}=
5194: $env{'course.'.$env{'request.course.id'}.'.internal.courseowner'};
5195: $coursetypebuf{$env{'request.course.id'}}=
5196: $env{'course.'.$env{'request.course.id'}.'.type'};
5197: if (defined $courselogs{$env{'request.course.id'}}) {
5198: $courselogs{$env{'request.course.id'}}.='&'.$what;
5199: } else {
5200: $courselogs{$env{'request.course.id'}}.=$what;
5201: }
5202: if (length($courselogs{$env{'request.course.id'}})>4048) {
5203: &flushcourselogs();
5204: }
5205: }
5206:
5207: sub courseacclog {
5208: my $fnsymb=shift;
5209: unless ($env{'request.course.id'}) { return ''; }
5210: my $what=$fnsymb.':'.$env{'user.name'}.':'.$env{'user.domain'};
5211: if ($fnsymb=~/$LONCAPA::assess_re/) {
5212: $what.=':POST';
5213: # FIXME: Probably ought to escape things....
5214: foreach my $key (keys(%env)) {
5215: if ($key=~/^form\.(.*)/) {
5216: my $formitem = $1;
5217: if ($formitem =~ /^HWFILE(?:SIZE|TOOBIG)/) {
5218: $what.=':'.$formitem.'='.$env{$key};
5219: } elsif ($formitem !~ /^HWFILE(?:[^.]+)$/) {
5220: if ($formitem eq 'proctorpassword') {
5221: $what.=':'.$formitem.'=' . '*' x length($env{$key});
5222: } else {
5223: $what.=':'.$formitem.'='.$env{$key};
5224: }
5225: }
5226: }
5227: }
5228: } elsif ($fnsymb =~ m:^/adm/searchcat:) {
5229: # FIXME: We should not be depending on a form parameter that someone
5230: # editing lonsearchcat.pm might change in the future.
5231: if ($env{'form.phase'} eq 'course_search') {
5232: $what.= ':POST';
5233: # FIXME: Probably ought to escape things....
5234: foreach my $element ('courseexp','crsfulltext','crsrelated',
5235: 'crsdiscuss') {
5236: $what.=':'.$element.'='.$env{'form.'.$element};
5237: }
5238: }
5239: }
5240: &courselog($what);
5241: }
5242:
5243: sub countacc {
5244: my $url=&declutter(shift);
5245: return if (! defined($url) || $url eq '');
5246: unless ($env{'request.course.id'}) { return ''; }
5247: #
5248: # Mark that this url was used in this course
5249: #
5250: $accesshash{$env{'request.course.id'}.'___'.$url.'___course'}=1;
5251: #
5252: # Increase the access count for this resource in this child process
5253: #
5254: my $key=$$.$processmarker.'_'.$dumpcount.'___'.$url.'___count';
5255: $accesshash{$key}++;
5256: }
5257:
5258: sub linklog {
5259: my ($from,$to)=@_;
5260: $from=&declutter($from);
5261: $to=&declutter($to);
5262: $accesshash{$from.'___'.$to.'___comefrom'}=1;
5263: $accesshash{$to.'___'.$from.'___goto'}=1;
5264: }
5265:
5266: sub statslog {
5267: my ($symb,$part,$users,$av_attempts,$degdiff)=@_;
5268: if ($users<2) { return; }
5269: my %dynstore=&LONCAPA::lonmetadata::dynamic_metadata_storage({
5270: 'course' => $env{'request.course.id'},
5271: 'sections' => '"all"',
5272: 'num_students' => $users,
5273: 'part' => $part,
5274: 'symb' => $symb,
5275: 'mean_tries' => $av_attempts,
5276: 'deg_of_diff' => $degdiff});
5277: foreach my $key (keys(%dynstore)) {
5278: $accesshash{$key}=$dynstore{$key};
5279: }
5280: }
5281:
5282: sub userrolelog {
5283: my ($trole,$username,$domain,$area,$tstart,$tend)=@_;
5284: if ( $trole =~ /^(ca|aa|in|cc|ep|cr|ta|co)/ ) {
5285: my (undef,$rudom,$runame,$rsec)=split(/\//,$area);
5286: $userrolehash
5287: {$trole.':'.$username.':'.$domain.':'.$runame.':'.$rudom.':'.$rsec}
5288: =$tend.':'.$tstart;
5289: }
5290: if ($env{'request.role'} =~ /dc\./ && $trole =~ /^(au|in|cc|ep|cr|ta|co)/) {
5291: $userrolehash
5292: {$trole.':'.$username.':'.$domain.':'.$env{'user.name'}.':'.$env{'user.domain'}.':'}
5293: =$tend.':'.$tstart;
5294: }
5295: if ($trole =~ /^(dc|ad|li|au|dg|sc|dh|da)/ ) {
5296: my (undef,$rudom,$runame,$rsec)=split(/\//,$area);
5297: $domainrolehash
5298: {$trole.':'.$username.':'.$domain.':'.$runame.':'.$rudom.':'.$rsec}
5299: = $tend.':'.$tstart;
5300: }
5301: }
5302:
5303: sub courserolelog {
5304: my ($trole,$username,$domain,$area,$tstart,$tend,$delflag,$selfenroll,$context)=@_;
5305: if ($area =~ m-^/($match_domain)/($match_courseid)/?([^/]*)-) {
5306: my $cdom = $1;
5307: my $cnum = $2;
5308: my $sec = $3;
5309: my $namespace = 'rolelog';
5310: my %storehash = (
5311: role => $trole,
5312: start => $tstart,
5313: end => $tend,
5314: selfenroll => $selfenroll,
5315: context => $context,
5316: );
5317: if ($trole eq 'gr') {
5318: $namespace = 'groupslog';
5319: $storehash{'group'} = $sec;
5320: } else {
5321: $storehash{'section'} = $sec;
5322: }
5323: &write_log('course',$namespace,\%storehash,$delflag,$username,
5324: $domain,$cnum,$cdom);
5325: if (($trole ne 'st') || ($sec ne '')) {
5326: &devalidate_cache_new('getcourseroles',$cdom.'_'.$cnum);
5327: }
5328: }
5329: return;
5330: }
5331:
5332: sub domainrolelog {
5333: my ($trole,$username,$domain,$area,$tstart,$tend,$delflag,$context)=@_;
5334: if ($area =~ m{^/($match_domain)/$}) {
5335: my $cdom = $1;
5336: my $domconfiguser = &Apache::lonnet::get_domainconfiguser($cdom);
5337: my $namespace = 'rolelog';
5338: my %storehash = (
5339: role => $trole,
5340: start => $tstart,
5341: end => $tend,
5342: context => $context,
5343: );
5344: &write_log('domain',$namespace,\%storehash,$delflag,$username,
5345: $domain,$domconfiguser,$cdom);
5346: }
5347: return;
5348:
5349: }
5350:
5351: sub coauthorrolelog {
5352: my ($trole,$username,$domain,$area,$tstart,$tend,$delflag,$context)=@_;
5353: if ($area =~ m{^/($match_domain)/($match_username)$}) {
5354: my $audom = $1;
5355: my $auname = $2;
5356: my $namespace = 'rolelog';
5357: my %storehash = (
5358: role => $trole,
5359: start => $tstart,
5360: end => $tend,
5361: context => $context,
5362: );
5363: &write_log('author',$namespace,\%storehash,$delflag,$username,
5364: $domain,$auname,$audom);
5365: }
5366: return;
5367: }
5368:
5369: sub get_course_adv_roles {
5370: my ($cid,$codes) = @_;
5371: $cid=$env{'request.course.id'} unless (defined($cid));
5372: my %coursehash=&coursedescription($cid);
5373: my $crstype = &Apache::loncommon::course_type($cid);
5374: my %nothide=();
5375: foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
5376: if ($user !~ /:/) {
5377: $nothide{join(':',split(/[\@]/,$user))}=1;
5378: } else {
5379: $nothide{$user}=1;
5380: }
5381: }
5382: my @possdoms = ($coursehash{'domain'});
5383: if ($coursehash{'checkforpriv'}) {
5384: push(@possdoms,split(/,/,$coursehash{'checkforpriv'}));
5385: }
5386: my %returnhash=();
5387: my %dumphash=
5388: &dump('nohist_userroles',$coursehash{'domain'},$coursehash{'num'});
5389: my $now=time;
5390: my %privileged;
5391: foreach my $entry (keys(%dumphash)) {
5392: my ($tend,$tstart)=split(/\:/,$dumphash{$entry});
5393: if (($tstart) && ($tstart<0)) { next; }
5394: if (($tend) && ($tend<$now)) { next; }
5395: if (($tstart) && ($now<$tstart)) { next; }
5396: my ($role,$username,$domain,$section)=split(/\:/,$entry);
5397: if ($username eq '' || $domain eq '') { next; }
5398: if ((&privileged($username,$domain,\@possdoms)) &&
5399: (!$nothide{$username.':'.$domain})) { next; }
5400: if ($role eq 'cr') { next; }
5401: if ($codes) {
5402: if ($section) { $role .= ':'.$section; }
5403: if ($returnhash{$role}) {
5404: $returnhash{$role}.=','.$username.':'.$domain;
5405: } else {
5406: $returnhash{$role}=$username.':'.$domain;
5407: }
5408: } else {
5409: my $key=&plaintext($role,$crstype);
5410: if ($section) { $key.=' ('.&Apache::lonlocal::mt('Section [_1]',$section).')'; }
5411: if ($returnhash{$key}) {
5412: $returnhash{$key}.=','.$username.':'.$domain;
5413: } else {
5414: $returnhash{$key}=$username.':'.$domain;
5415: }
5416: }
5417: }
5418: return %returnhash;
5419: }
5420:
5421: sub get_my_roles {
5422: my ($uname,$udom,$context,$types,$roles,$roledoms,$withsec,$hidepriv)=@_;
5423: unless (defined($uname)) { $uname=$env{'user.name'}; }
5424: unless (defined($udom)) { $udom=$env{'user.domain'}; }
5425: my (%dumphash,%nothide);
5426: if ($context eq 'userroles') {
5427: %dumphash = &dump('roles',$udom,$uname);
5428: } else {
5429: %dumphash = &dump('nohist_userroles',$udom,$uname);
5430: if ($hidepriv) {
5431: my %coursehash=&coursedescription($udom.'_'.$uname);
5432: foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
5433: if ($user !~ /:/) {
5434: $nothide{join(':',split(/[\@]/,$user))} = 1;
5435: } else {
5436: $nothide{$user} = 1;
5437: }
5438: }
5439: }
5440: }
5441: my %returnhash=();
5442: my $now=time;
5443: my %privileged;
5444: foreach my $entry (keys(%dumphash)) {
5445: my ($role,$tend,$tstart);
5446: if ($context eq 'userroles') {
5447: next if ($entry =~ /^rolesdef/);
5448: ($role,$tend,$tstart)=split(/_/,$dumphash{$entry});
5449: } else {
5450: ($tend,$tstart)=split(/\:/,$dumphash{$entry});
5451: }
5452: if (($tstart) && ($tstart<0)) { next; }
5453: my $status = 'active';
5454: if (($tend) && ($tend<=$now)) {
5455: $status = 'previous';
5456: }
5457: if (($tstart) && ($now<$tstart)) {
5458: $status = 'future';
5459: }
5460: if (ref($types) eq 'ARRAY') {
5461: if (!grep(/^\Q$status\E$/,@{$types})) {
5462: next;
5463: }
5464: } else {
5465: if ($status ne 'active') {
5466: next;
5467: }
5468: }
5469: my ($rolecode,$username,$domain,$section,$area);
5470: if ($context eq 'userroles') {
5471: ($area,$rolecode) = ($entry =~ /^(.+)_([^_]+)$/);
5472: (undef,$domain,$username,$section) = split(/\//,$area);
5473: } else {
5474: ($role,$username,$domain,$section) = split(/\:/,$entry);
5475: }
5476: if (ref($roledoms) eq 'ARRAY') {
5477: if (!grep(/^\Q$domain\E$/,@{$roledoms})) {
5478: next;
5479: }
5480: }
5481: if (ref($roles) eq 'ARRAY') {
5482: if (!grep(/^\Q$role\E$/,@{$roles})) {
5483: if ($role =~ /^cr\//) {
5484: if (!grep(/^cr$/,@{$roles})) {
5485: next;
5486: }
5487: } elsif ($role =~ /^gr\//) {
5488: if (!grep(/^gr$/,@{$roles})) {
5489: next;
5490: }
5491: } else {
5492: next;
5493: }
5494: }
5495: }
5496: if ($hidepriv) {
5497: my @privroles = ('dc','su');
5498: if ($context eq 'userroles') {
5499: next if (grep(/^\Q$role\E$/,@privroles));
5500: } else {
5501: my $possdoms = [$domain];
5502: if (ref($roledoms) eq 'ARRAY') {
5503: push(@{$possdoms},@{$roledoms});
5504: }
5505: if (&privileged($username,$domain,$possdoms,\@privroles)) {
5506: if (!$nothide{$username.':'.$domain}) {
5507: next;
5508: }
5509: }
5510: }
5511: }
5512: if ($withsec) {
5513: $returnhash{$username.':'.$domain.':'.$role.':'.$section} =
5514: $tstart.':'.$tend;
5515: } else {
5516: $returnhash{$username.':'.$domain.':'.$role}=$tstart.':'.$tend;
5517: }
5518: }
5519: return %returnhash;
5520: }
5521:
5522: sub get_all_adhocroles {
5523: my ($dom) = @_;
5524: my @roles_by_num = ();
5525: my %domdefaults = &get_domain_defaults($dom);
5526: my (%description,%access_in_dom,%access_info);
5527: if (ref($domdefaults{'adhocroles'}) eq 'HASH') {
5528: my $count = 0;
5529: my %domcurrent = %{$domdefaults{'adhocroles'}};
5530: my %ordered;
5531: foreach my $role (sort(keys(%domcurrent))) {
5532: my ($order,$desc,$access_in_dom);
5533: if (ref($domcurrent{$role}) eq 'HASH') {
5534: $order = $domcurrent{$role}{'order'};
5535: $desc = $domcurrent{$role}{'desc'};
5536: $access_in_dom{$role} = $domcurrent{$role}{'access'};
5537: $access_info{$role} = $domcurrent{$role}{$access_in_dom{$role}};
5538: }
5539: if ($order eq '') {
5540: $order = $count;
5541: }
5542: $ordered{$order} = $role;
5543: if ($desc ne '') {
5544: $description{$role} = $desc;
5545: } else {
5546: $description{$role}= $role;
5547: }
5548: $count++;
5549: }
5550: foreach my $item (sort {$a <=> $b } (keys(%ordered))) {
5551: push(@roles_by_num,$ordered{$item});
5552: }
5553: }
5554: return (\@roles_by_num,\%description,\%access_in_dom,\%access_info);
5555: }
5556:
5557: sub get_my_adhocroles {
5558: my ($cid,$checkreg) = @_;
5559: my ($cdom,$cnum,%info,@possroles,$description,$roles_by_num);
5560: if ($env{'request.course.id'} eq $cid) {
5561: $cdom = $env{'course.'.$cid.'.domain'};
5562: $cnum = $env{'course.'.$cid.'.num'};
5563: $info{'internal.coursecode'} = $env{'course.'.$cid.'.internal.coursecode'};
5564: } elsif ($cid =~ /^($match_domain)_($match_courseid)$/) {
5565: $cdom = $1;
5566: $cnum = $2;
5567: %info = &Apache::lonnet::get('environment',['internal.coursecode'],
5568: $cdom,$cnum);
5569: }
5570: if (($info{'internal.coursecode'} ne '') && ($checkreg)) {
5571: my $user = $env{'user.name'}.':'.$env{'user.domain'};
5572: my %rosterhash = &get('classlist',[$user],$cdom,$cnum);
5573: if ($rosterhash{$user} ne '') {
5574: my $type = (split(/:/,$rosterhash{$user}))[5];
5575: return ([],{}) if ($type eq 'auto');
5576: }
5577: }
5578: if (($cdom ne '') && ($cnum ne '')) {
5579: if (($env{"user.role.dh./$cdom/"}) || ($env{"user.role.da./$cdom/"})) {
5580: my $then=$env{'user.login.time'};
5581: my $update=$env{'user.update.time'};
5582: if (!$update) {
5583: $update = $then;
5584: }
5585: my @liveroles;
5586: foreach my $role ('dh','da') {
5587: if ($env{"user.role.$role./$cdom/"}) {
5588: my ($tstart,$tend)=split(/\./,$env{"user.role.$role./$cdom/"});
5589: my $limit = $update;
5590: if ($env{'request.role'} eq "$role./$cdom/") {
5591: $limit = $then;
5592: }
5593: my $activerole = 1;
5594: if ($tstart && $tstart>$limit) { $activerole = 0; }
5595: if ($tend && $tend <$limit) { $activerole = 0; }
5596: if ($activerole) {
5597: push(@liveroles,$role);
5598: }
5599: }
5600: }
5601: if (@liveroles) {
5602: if (&homeserver($cnum,$cdom) ne 'no_host') {
5603: my ($accessref,$accessinfo,%access_in_dom);
5604: ($roles_by_num,$description,$accessref,$accessinfo) = &get_all_adhocroles($cdom);
5605: if (ref($roles_by_num) eq 'ARRAY') {
5606: if (@{$roles_by_num}) {
5607: my %settings;
5608: if ($env{'request.course.id'} eq $cid) {
5609: foreach my $envkey (keys(%env)) {
5610: if ($envkey =~ /^\Qcourse.$cid.\E(internal\.adhoc.+)$/) {
5611: $settings{$1} = $env{$envkey};
5612: }
5613: }
5614: } else {
5615: %settings = &dump('environment',$cdom,$cnum,'internal\.adhoc');
5616: }
5617: my %setincrs;
5618: if ($settings{'internal.adhocaccess'}) {
5619: map { $setincrs{$_} = 1; } split(/,/,$settings{'internal.adhocaccess'});
5620: }
5621: my @statuses;
5622: if ($env{'environment.inststatus'}) {
5623: @statuses = split(/,/,$env{'environment.inststatus'});
5624: }
5625: my $user = $env{'user.name'}.':'.$env{'user.domain'};
5626: if (ref($accessref) eq 'HASH') {
5627: %access_in_dom = %{$accessref};
5628: }
5629: foreach my $role (@{$roles_by_num}) {
5630: my ($curraccess,@okstatus,@personnel);
5631: if ($setincrs{$role}) {
5632: ($curraccess,my $rest) = split(/=/,$settings{'internal.adhoc.'.$role});
5633: if ($curraccess eq 'status') {
5634: @okstatus = split(/\&/,$rest);
5635: } elsif (($curraccess eq 'exc') || ($curraccess eq 'inc')) {
5636: @personnel = split(/\&/,$rest);
5637: }
5638: } else {
5639: $curraccess = $access_in_dom{$role};
5640: if (ref($accessinfo) eq 'HASH') {
5641: if ($curraccess eq 'status') {
5642: if (ref($accessinfo->{$role}) eq 'ARRAY') {
5643: @okstatus = @{$accessinfo->{$role}};
5644: }
5645: } elsif (($curraccess eq 'exc') || ($curraccess eq 'inc')) {
5646: if (ref($accessinfo->{$role}) eq 'ARRAY') {
5647: @personnel = @{$accessinfo->{$role}};
5648: }
5649: }
5650: }
5651: }
5652: if ($curraccess eq 'none') {
5653: next;
5654: } elsif ($curraccess eq 'all') {
5655: push(@possroles,$role);
5656: } elsif ($curraccess eq 'dh') {
5657: if (grep(/^dh$/,@liveroles)) {
5658: push(@possroles,$role);
5659: } else {
5660: next;
5661: }
5662: } elsif ($curraccess eq 'da') {
5663: if (grep(/^da$/,@liveroles)) {
5664: push(@possroles,$role);
5665: } else {
5666: next;
5667: }
5668: } elsif ($curraccess eq 'status') {
5669: if (@okstatus) {
5670: if (!@statuses) {
5671: if (grep(/^default$/,@okstatus)) {
5672: push(@possroles,$role);
5673: }
5674: } else {
5675: foreach my $status (@okstatus) {
5676: if (grep(/^\Q$status\E$/,@statuses)) {
5677: push(@possroles,$role);
5678: last;
5679: }
5680: }
5681: }
5682: }
5683: } elsif (($curraccess eq 'exc') || ($curraccess eq 'inc')) {
5684: if (grep(/^\Q$user\E$/,@personnel)) {
5685: if ($curraccess eq 'exc') {
5686: push(@possroles,$role);
5687: }
5688: } elsif ($curraccess eq 'inc') {
5689: push(@possroles,$role);
5690: }
5691: }
5692: }
5693: }
5694: }
5695: }
5696: }
5697: }
5698: }
5699: unless (ref($description) eq 'HASH') {
5700: if (ref($roles_by_num) eq 'ARRAY') {
5701: my %desc;
5702: map { $desc{$_} = $_; } (@{$roles_by_num});
5703: $description = \%desc;
5704: } else {
5705: $description = {};
5706: }
5707: }
5708: return (\@possroles,$description);
5709: }
5710:
5711: # ----------------------------------------------------- Frontpage Announcements
5712: #
5713: #
5714:
5715: sub postannounce {
5716: my ($server,$text)=@_;
5717: unless (&allowed('psa',&host_domain($server))) { return 'refused'; }
5718: unless ($text=~/\w/) { $text=''; }
5719: return &reply('setannounce:'.&escape($text),$server);
5720: }
5721:
5722: sub getannounce {
5723:
5724: if (open(my $fh,"<",$perlvar{'lonDocRoot'}.'/announcement.txt')) {
5725: my $announcement='';
5726: while (my $line = <$fh>) { $announcement .= $line; }
5727: close($fh);
5728: if ($announcement=~/\w/) {
5729: return
5730: '<table bgcolor="#FF5555" cellpadding="5" cellspacing="3">'.
5731: '<tr><td bgcolor="#FFFFFF"><tt>'.$announcement.'</tt></td></tr></table>';
5732: } else {
5733: return '';
5734: }
5735: } else {
5736: return '';
5737: }
5738: }
5739:
5740: # ---------------------------------------------------------- Course ID routines
5741: # Deal with domain's nohist_courseid.db files
5742: #
5743:
5744: sub courseidput {
5745: my ($domain,$storehash,$coursehome,$caller) = @_;
5746: return unless (ref($storehash) eq 'HASH');
5747: my $outcome;
5748: if ($caller eq 'timeonly') {
5749: my $cids = '';
5750: foreach my $item (keys(%$storehash)) {
5751: $cids.=&escape($item).'&';
5752: }
5753: $cids=~s/\&$//;
5754: $outcome = &reply('courseidputhash:'.$domain.':'.$caller.':'.$cids,
5755: $coursehome);
5756: } else {
5757: my $items = '';
5758: foreach my $item (keys(%$storehash)) {
5759: $items.= &escape($item).'='.
5760: &freeze_escape($$storehash{$item}).'&';
5761: }
5762: $items=~s/\&$//;
5763: $outcome = &reply('courseidputhash:'.$domain.':'.$caller.':'.$items,
5764: $coursehome);
5765: }
5766: if ($outcome eq 'unknown_cmd') {
5767: my $what;
5768: foreach my $cid (keys(%$storehash)) {
5769: $what .= &escape($cid).'=';
5770: foreach my $item ('description','inst_code','owner','type') {
5771: $what .= &escape($storehash->{$cid}{$item}).':';
5772: }
5773: $what =~ s/\:$/&/;
5774: }
5775: $what =~ s/\&$//;
5776: return &reply('courseidput:'.$domain.':'.$what,$coursehome);
5777: } else {
5778: return $outcome;
5779: }
5780: }
5781:
5782: sub courseiddump {
5783: my ($domfilter,$descfilter,$sincefilter,$instcodefilter,$ownerfilter,
5784: $coursefilter,$hostidflag,$hostidref,$typefilter,$regexp_ok,
5785: $selfenrollonly,$catfilter,$showhidden,$caller,$cloner,$cc_clone,
5786: $cloneonly,$createdbefore,$createdafter,$creationcontext,$domcloner,
5787: $hasuniquecode,$reqcrsdom,$reqinstcode)=@_;
5788: my $as_hash = 1;
5789: my %returnhash;
5790: if (!$domfilter) { $domfilter=''; }
5791: my %libserv = &all_library();
5792: foreach my $tryserver (keys(%libserv)) {
5793: if ( ( $hostidflag == 1
5794: && grep(/^\Q$tryserver\E$/,@{$hostidref}) )
5795: || (!defined($hostidflag)) ) {
5796:
5797: if (($domfilter eq '') ||
5798: (&host_domain($tryserver) eq $domfilter)) {
5799: my $rep;
5800: if (grep { $_ eq $tryserver } current_machine_ids()) {
5801: $rep = LONCAPA::Lond::dump_course_id_handler(
5802: join(":", (&host_domain($tryserver), $sincefilter,
5803: &escape($descfilter), &escape($instcodefilter),
5804: &escape($ownerfilter), &escape($coursefilter),
5805: &escape($typefilter), &escape($regexp_ok),
5806: $as_hash, &escape($selfenrollonly),
5807: &escape($catfilter), $showhidden, $caller,
5808: &escape($cloner), &escape($cc_clone), $cloneonly,
5809: &escape($createdbefore), &escape($createdafter),
5810: &escape($creationcontext),$domcloner,$hasuniquecode,
5811: $reqcrsdom,&escape($reqinstcode))));
5812: } else {
5813: $rep = &reply('courseiddump:'.&host_domain($tryserver).':'.
5814: $sincefilter.':'.&escape($descfilter).':'.
5815: &escape($instcodefilter).':'.&escape($ownerfilter).
5816: ':'.&escape($coursefilter).':'.&escape($typefilter).
5817: ':'.&escape($regexp_ok).':'.$as_hash.':'.
5818: &escape($selfenrollonly).':'.&escape($catfilter).':'.
5819: $showhidden.':'.$caller.':'.&escape($cloner).':'.
5820: &escape($cc_clone).':'.$cloneonly.':'.
5821: &escape($createdbefore).':'.&escape($createdafter).':'.
5822: &escape($creationcontext).':'.$domcloner.':'.$hasuniquecode.
5823: ':'.$reqcrsdom.':'.&escape($reqinstcode),$tryserver);
5824: }
5825:
5826: my @pairs=split(/\&/,$rep);
5827: foreach my $item (@pairs) {
5828: my ($key,$value)=split(/\=/,$item,2);
5829: $key = &unescape($key);
5830: next if ($key =~ /^error: 2 /);
5831: my $result = &thaw_unescape($value);
5832: if (ref($result) eq 'HASH') {
5833: $returnhash{$key}=$result;
5834: } else {
5835: my @responses = split(/:/,$value);
5836: my @items = ('description','inst_code','owner','type');
5837: for (my $i=0; $i<@responses; $i++) {
5838: $returnhash{$key}{$items[$i]} = &unescape($responses[$i]);
5839: }
5840: }
5841: }
5842: }
5843: }
5844: }
5845: return %returnhash;
5846: }
5847:
5848: sub courselastaccess {
5849: my ($cdom,$cnum,$hostidref) = @_;
5850: my %returnhash;
5851: if ($cdom && $cnum) {
5852: my $chome = &homeserver($cnum,$cdom);
5853: if ($chome ne 'no_host') {
5854: my $rep = &reply('courselastaccess:'.$cdom.':'.$cnum,$chome);
5855: &extract_lastaccess(\%returnhash,$rep);
5856: }
5857: } else {
5858: if (!$cdom) { $cdom=''; }
5859: my %libserv = &all_library();
5860: foreach my $tryserver (keys(%libserv)) {
5861: if (ref($hostidref) eq 'ARRAY') {
5862: next unless (grep(/^\Q$tryserver\E$/,@{$hostidref}));
5863: }
5864: if (($cdom eq '') || (&host_domain($tryserver) eq $cdom)) {
5865: my $rep = &reply('courselastaccess:'.&host_domain($tryserver).':',$tryserver);
5866: &extract_lastaccess(\%returnhash,$rep);
5867: }
5868: }
5869: }
5870: return %returnhash;
5871: }
5872:
5873: sub extract_lastaccess {
5874: my ($returnhash,$rep) = @_;
5875: if (ref($returnhash) eq 'HASH') {
5876: unless ($rep eq 'unknown_command' || $rep eq 'no_such_host' ||
5877: $rep eq 'con_lost' || $rep eq 'rejected' || $rep eq 'refused' ||
5878: $rep eq '') {
5879: my @pairs=split(/\&/,$rep);
5880: foreach my $item (@pairs) {
5881: my ($key,$value)=split(/\=/,$item,2);
5882: $key = &unescape($key);
5883: next if ($key =~ /^error: 2 /);
5884: $returnhash->{$key} = &thaw_unescape($value);
5885: }
5886: }
5887: }
5888: return;
5889: }
5890:
5891: # ---------------------------------------------------------- DC e-mail
5892:
5893: sub dcmailput {
5894: my ($domain,$msgid,$message,$server)=@_;
5895: my $status = &Apache::lonnet::critical(
5896: 'dcmailput:'.$domain.':'.&escape($msgid).'='.
5897: &escape($message),$server);
5898: return $status;
5899: }
5900:
5901: sub dcmaildump {
5902: my ($dom,$startdate,$enddate,$senders) = @_;
5903: my %returnhash=();
5904:
5905: if (defined(&domain($dom,'primary'))) {
5906: my $cmd='dcmaildump:'.$dom.':'.&escape($startdate).':'.
5907: &escape($enddate).':';
5908: my @esc_senders=map { &escape($_)} @$senders;
5909: $cmd.=&escape(join('&',@esc_senders));
5910: foreach my $line (split(/\&/,&reply($cmd,&domain($dom,'primary')))) {
5911: my ($key,$value) = split(/\=/,$line,2);
5912: if (($key) && ($value)) {
5913: $returnhash{&unescape($key)} = &unescape($value);
5914: }
5915: }
5916: }
5917: return %returnhash;
5918: }
5919: # ---------------------------------------------------------- Domain roles
5920:
5921: sub get_domain_roles {
5922: my ($dom,$roles,$startdate,$enddate)=@_;
5923: if ((!defined($startdate)) || ($startdate eq '')) {
5924: $startdate = '.';
5925: }
5926: if ((!defined($enddate)) || ($enddate eq '')) {
5927: $enddate = '.';
5928: }
5929: my $rolelist;
5930: if (ref($roles) eq 'ARRAY') {
5931: $rolelist = join('&',@{$roles});
5932: }
5933: my %personnel = ();
5934:
5935: my %servers = &get_servers($dom,'library');
5936: foreach my $tryserver (keys(%servers)) {
5937: %{$personnel{$tryserver}}=();
5938: foreach my $line (split(/\&/,&reply('domrolesdump:'.$dom.':'.
5939: &escape($startdate).':'.
5940: &escape($enddate).':'.
5941: &escape($rolelist), $tryserver))) {
5942: my ($key,$value) = split(/\=/,$line,2);
5943: if (($key) && ($value)) {
5944: $personnel{$tryserver}{&unescape($key)} = &unescape($value);
5945: }
5946: }
5947: }
5948: return %personnel;
5949: }
5950:
5951: sub get_active_domroles {
5952: my ($dom,$roles) = @_;
5953: return () unless (ref($roles) eq 'ARRAY');
5954: my $now = time;
5955: my %dompersonnel = &get_domain_roles($dom,$roles,$now,$now);
5956: my %domroles;
5957: foreach my $server (keys(%dompersonnel)) {
5958: foreach my $user (sort(keys(%{$dompersonnel{$server}}))) {
5959: my ($trole,$uname,$udom,$runame,$rudom,$rsec) = split(/:/,$user);
5960: $domroles{$uname.':'.$udom} = $dompersonnel{$server}{$user};
5961: }
5962: }
5963: return %domroles;
5964: }
5965:
5966: # ----------------------------------------------------------- Interval timing
5967:
5968: {
5969: # Caches needed for speedup of navmaps
5970: # We don't want to cache this for very long at all (5 seconds at most)
5971: #
5972: # The user for whom we cache
5973: my $cachedkey='';
5974: # The cached times for this user
5975: my %cachedtimes=();
5976: # When this was last done
5977: my $cachedtime='';
5978:
5979: sub load_all_first_access {
5980: my ($uname,$udom,$ignorecache)=@_;
5981: if (($cachedkey eq $uname.':'.$udom) &&
5982: (abs($cachedtime-time)<5) && (!$env{'form.markaccess'}) &&
5983: (!$ignorecache)) {
5984: return;
5985: }
5986: $cachedtime=time;
5987: $cachedkey=$uname.':'.$udom;
5988: %cachedtimes=&dump('firstaccesstimes',$udom,$uname);
5989: }
5990:
5991: sub get_first_access {
5992: my ($type,$argsymb,$argmap,$ignorecache)=@_;
5993: my ($symb,$courseid,$udom,$uname)=&whichuser();
5994: if ($argsymb) { $symb=$argsymb; }
5995: my ($map,$id,$res)=&decode_symb($symb);
5996: if ($argmap) { $map = $argmap; }
5997: if ($type eq 'course') {
5998: $res='course';
5999: } elsif ($type eq 'map') {
6000: $res=&symbread($map);
6001: } else {
6002: $res=$symb;
6003: }
6004: &load_all_first_access($uname,$udom,$ignorecache);
6005: return $cachedtimes{"$courseid\0$res"};
6006: }
6007:
6008: sub set_first_access {
6009: my ($type,$interval)=@_;
6010: my ($symb,$courseid,$udom,$uname)=&whichuser();
6011: my ($map,$id,$res)=&decode_symb($symb);
6012: if ($type eq 'course') {
6013: $res='course';
6014: } elsif ($type eq 'map') {
6015: $res=&symbread($map);
6016: } else {
6017: $res=$symb;
6018: }
6019: $cachedkey='';
6020: my $firstaccess=&get_first_access($type,$symb,$map);
6021: if ($firstaccess) {
6022: &logthis("First access time already set ($firstaccess) when attempting ".
6023: "to set new value (type: $type, extent: $res) for $uname:$udom ".
6024: "in $courseid");
6025: return 'already_set';
6026: } else {
6027: my $start = time;
6028: my $putres = &put('firstaccesstimes',{"$courseid\0$res"=>$start},
6029: $udom,$uname);
6030: if ($putres eq 'ok') {
6031: &put('timerinterval',{"$courseid\0$res"=>$interval},
6032: $udom,$uname);
6033: &appenv(
6034: {
6035: 'course.'.$courseid.'.firstaccess.'.$res => $start,
6036: 'course.'.$courseid.'.timerinterval.'.$res => $interval,
6037: }
6038: );
6039: if (($cachedtime) && (abs($start-$cachedtime) < 5)) {
6040: $cachedtimes{"$courseid\0$res"} = $start;
6041: }
6042: } elsif ($putres ne 'refused') {
6043: &logthis("Result: $putres when attempting to set first access time ".
6044: "(type: $type, extent: $res) for $uname:$udom in $courseid");
6045: }
6046: return $putres;
6047: }
6048: return 'already_set';
6049: }
6050: }
6051:
6052: # --------------------------------------------- Set Expire Date for Spreadsheet
6053:
6054: sub expirespread {
6055: my ($uname,$udom,$stype,$usymb)=@_;
6056: my $cid=$env{'request.course.id'};
6057: if ($cid) {
6058: my $now=time;
6059: my $key=$uname.':'.$udom.':'.$stype.':'.$usymb;
6060: return &reply('put:'.$env{'course.'.$cid.'.domain'}.':'.
6061: $env{'course.'.$cid.'.num'}.
6062: ':nohist_expirationdates:'.
6063: &escape($key).'='.$now,
6064: $env{'course.'.$cid.'.home'})
6065: }
6066: return 'ok';
6067: }
6068:
6069: # ----------------------------------------------------- Devalidate Spreadsheets
6070:
6071: sub devalidate {
6072: my ($symb,$uname,$udom)=@_;
6073: my $cid=$env{'request.course.id'};
6074: if ($cid) {
6075: # delete the stored spreadsheets for
6076: # - the student level sheet of this user in course's homespace
6077: # - the assessment level sheet for this resource
6078: # for this user in user's homespace
6079: # - current conditional state info
6080: my $key=$uname.':'.$udom.':';
6081: my $status=
6082: &del('nohist_calculatedsheets',
6083: [$key.'studentcalc:'],
6084: $env{'course.'.$cid.'.domain'},
6085: $env{'course.'.$cid.'.num'})
6086: .' '.
6087: &del('nohist_calculatedsheets_'.$cid,
6088: [$key.'assesscalc:'.$symb],$udom,$uname);
6089: unless ($status eq 'ok ok') {
6090: &logthis('Could not devalidate spreadsheet '.
6091: $uname.' at '.$udom.' for '.
6092: $symb.': '.$status);
6093: }
6094: &delenv('user.state.'.$cid);
6095: }
6096: }
6097:
6098: sub get_scalar {
6099: my ($string,$end) = @_;
6100: my $value;
6101: if ($$string =~ s/^([^&]*?)($end)/$2/) {
6102: $value = $1;
6103: } elsif ($$string =~ s/^([^&]*?)&//) {
6104: $value = $1;
6105: }
6106: return &unescape($value);
6107: }
6108:
6109: sub array2str {
6110: my (@array) = @_;
6111: my $result=&arrayref2str(\@array);
6112: $result=~s/^__ARRAY_REF__//;
6113: $result=~s/__END_ARRAY_REF__$//;
6114: return $result;
6115: }
6116:
6117: sub arrayref2str {
6118: my ($arrayref) = @_;
6119: my $result='__ARRAY_REF__';
6120: foreach my $elem (@$arrayref) {
6121: if(ref($elem) eq 'ARRAY') {
6122: $result.=&arrayref2str($elem).'&';
6123: } elsif(ref($elem) eq 'HASH') {
6124: $result.=&hashref2str($elem).'&';
6125: } elsif(ref($elem)) {
6126: #print("Got a ref of ".(ref($elem))." skipping.");
6127: } else {
6128: $result.=&escape($elem).'&';
6129: }
6130: }
6131: $result=~s/\&$//;
6132: $result .= '__END_ARRAY_REF__';
6133: return $result;
6134: }
6135:
6136: sub hash2str {
6137: my (%hash) = @_;
6138: my $result=&hashref2str(\%hash);
6139: $result=~s/^__HASH_REF__//;
6140: $result=~s/__END_HASH_REF__$//;
6141: return $result;
6142: }
6143:
6144: sub hashref2str {
6145: my ($hashref)=@_;
6146: my $result='__HASH_REF__';
6147: foreach my $key (sort(keys(%$hashref))) {
6148: if (ref($key) eq 'ARRAY') {
6149: $result.=&arrayref2str($key).'=';
6150: } elsif (ref($key) eq 'HASH') {
6151: $result.=&hashref2str($key).'=';
6152: } elsif (ref($key)) {
6153: $result.='=';
6154: #print("Got a ref of ".(ref($key))." skipping.");
6155: } else {
6156: if (defined($key)) {$result.=&escape($key).'=';} else { last; }
6157: }
6158:
6159: if(ref($hashref->{$key}) eq 'ARRAY') {
6160: $result.=&arrayref2str($hashref->{$key}).'&';
6161: } elsif(ref($hashref->{$key}) eq 'HASH') {
6162: $result.=&hashref2str($hashref->{$key}).'&';
6163: } elsif(ref($hashref->{$key})) {
6164: $result.='&';
6165: #print("Got a ref of ".(ref($hashref->{$key}))." skipping.");
6166: } else {
6167: $result.=&escape($hashref->{$key}).'&';
6168: }
6169: }
6170: $result=~s/\&$//;
6171: $result .= '__END_HASH_REF__';
6172: return $result;
6173: }
6174:
6175: sub str2hash {
6176: my ($string)=@_;
6177: my ($hash)=&str2hashref('__HASH_REF__'.$string.'__END_HASH_REF__');
6178: return %$hash;
6179: }
6180:
6181: sub str2hashref {
6182: my ($string) = @_;
6183:
6184: my %hash;
6185:
6186: if($string !~ /^__HASH_REF__/) {
6187: if (! ($string eq '' || !defined($string))) {
6188: $hash{'error'}='Not hash reference';
6189: }
6190: return (\%hash, $string);
6191: }
6192:
6193: $string =~ s/^__HASH_REF__//;
6194:
6195: while($string !~ /^__END_HASH_REF__/) {
6196: #key
6197: my $key='';
6198: if($string =~ /^__HASH_REF__/) {
6199: ($key, $string)=&str2hashref($string);
6200: if(defined($key->{'error'})) {
6201: $hash{'error'}='Bad data';
6202: return (\%hash, $string);
6203: }
6204: } elsif($string =~ /^__ARRAY_REF__/) {
6205: ($key, $string)=&str2arrayref($string);
6206: if($key->[0] eq 'Array reference error') {
6207: $hash{'error'}='Bad data';
6208: return (\%hash, $string);
6209: }
6210: } else {
6211: $string =~ s/^(.*?)=//;
6212: $key=&unescape($1);
6213: }
6214: $string =~ s/^=//;
6215:
6216: #value
6217: my $value='';
6218: if($string =~ /^__HASH_REF__/) {
6219: ($value, $string)=&str2hashref($string);
6220: if(defined($value->{'error'})) {
6221: $hash{'error'}='Bad data';
6222: return (\%hash, $string);
6223: }
6224: } elsif($string =~ /^__ARRAY_REF__/) {
6225: ($value, $string)=&str2arrayref($string);
6226: if($value->[0] eq 'Array reference error') {
6227: $hash{'error'}='Bad data';
6228: return (\%hash, $string);
6229: }
6230: } else {
6231: $value=&get_scalar(\$string,'__END_HASH_REF__');
6232: }
6233: $string =~ s/^&//;
6234:
6235: $hash{$key}=$value;
6236: }
6237:
6238: $string =~ s/^__END_HASH_REF__//;
6239:
6240: return (\%hash, $string);
6241: }
6242:
6243: sub str2array {
6244: my ($string)=@_;
6245: my ($array)=&str2arrayref('__ARRAY_REF__'.$string.'__END_ARRAY_REF__');
6246: return @$array;
6247: }
6248:
6249: sub str2arrayref {
6250: my ($string) = @_;
6251: my @array;
6252:
6253: if($string !~ /^__ARRAY_REF__/) {
6254: if (! ($string eq '' || !defined($string))) {
6255: $array[0]='Array reference error';
6256: }
6257: return (\@array, $string);
6258: }
6259:
6260: $string =~ s/^__ARRAY_REF__//;
6261:
6262: while($string !~ /^__END_ARRAY_REF__/) {
6263: my $value='';
6264: if($string =~ /^__HASH_REF__/) {
6265: ($value, $string)=&str2hashref($string);
6266: if(defined($value->{'error'})) {
6267: $array[0] ='Array reference error';
6268: return (\@array, $string);
6269: }
6270: } elsif($string =~ /^__ARRAY_REF__/) {
6271: ($value, $string)=&str2arrayref($string);
6272: if($value->[0] eq 'Array reference error') {
6273: $array[0] ='Array reference error';
6274: return (\@array, $string);
6275: }
6276: } else {
6277: $value=&get_scalar(\$string,'__END_ARRAY_REF__');
6278: }
6279: $string =~ s/^&//;
6280:
6281: push(@array, $value);
6282: }
6283:
6284: $string =~ s/^__END_ARRAY_REF__//;
6285:
6286: return (\@array, $string);
6287: }
6288:
6289: # -------------------------------------------------------------------Temp Store
6290:
6291: sub tmpreset {
6292: my ($symb,$namespace,$domain,$stuname) = @_;
6293: if (!$symb) {
6294: $symb=&symbread();
6295: if (!$symb) { $symb= $env{'request.url'}; }
6296: }
6297: $symb=escape($symb);
6298:
6299: if (!$namespace) { $namespace=$env{'request.state'}; }
6300: $namespace=~s/\//\_/g;
6301: $namespace=~s/\W//g;
6302:
6303: if (!$domain) { $domain=$env{'user.domain'}; }
6304: if (!$stuname) { $stuname=$env{'user.name'}; }
6305: if ($domain eq 'public' && $stuname eq 'public') {
6306: $stuname=&get_requestor_ip();
6307: }
6308: my $path=LONCAPA::tempdir();
6309: my %hash;
6310: if (tie(%hash,'GDBM_File',
6311: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
6312: &GDBM_WRCREAT(),0640)) {
6313: foreach my $key (keys(%hash)) {
6314: if ($key=~ /:$symb/) {
6315: delete($hash{$key});
6316: }
6317: }
6318: }
6319: }
6320:
6321: sub tmpstore {
6322: my ($storehash,$symb,$namespace,$domain,$stuname) = @_;
6323:
6324: if (!$symb) {
6325: $symb=&symbread();
6326: if (!$symb) { $symb= $env{'request.url'}; }
6327: }
6328: $symb=escape($symb);
6329:
6330: if (!$namespace) {
6331: # I don't think we would ever want to store this for a course.
6332: # it seems this will only be used if we don't have a course.
6333: #$namespace=$env{'request.course.id'};
6334: #if (!$namespace) {
6335: $namespace=$env{'request.state'};
6336: #}
6337: }
6338: $namespace=~s/\//\_/g;
6339: $namespace=~s/\W//g;
6340: if (!$domain) { $domain=$env{'user.domain'}; }
6341: if (!$stuname) { $stuname=$env{'user.name'}; }
6342: if ($domain eq 'public' && $stuname eq 'public') {
6343: $stuname=&get_requestor_ip();
6344: }
6345: my $now=time;
6346: my %hash;
6347: my $path=LONCAPA::tempdir();
6348: if (tie(%hash,'GDBM_File',
6349: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
6350: &GDBM_WRCREAT(),0640)) {
6351: $hash{"version:$symb"}++;
6352: my $version=$hash{"version:$symb"};
6353: my $allkeys='';
6354: foreach my $key (keys(%$storehash)) {
6355: $allkeys.=$key.':';
6356: $hash{"$version:$symb:$key"}=&freeze_escape($$storehash{$key});
6357: }
6358: $hash{"$version:$symb:timestamp"}=$now;
6359: $allkeys.='timestamp';
6360: $hash{"$version:keys:$symb"}=$allkeys;
6361: if (untie(%hash)) {
6362: return 'ok';
6363: } else {
6364: return "error:$!";
6365: }
6366: } else {
6367: return "error:$!";
6368: }
6369: }
6370:
6371: # -----------------------------------------------------------------Temp Restore
6372:
6373: sub tmprestore {
6374: my ($symb,$namespace,$domain,$stuname) = @_;
6375:
6376: if (!$symb) {
6377: $symb=&symbread();
6378: if (!$symb) { $symb= $env{'request.url'}; }
6379: }
6380: $symb=escape($symb);
6381:
6382: if (!$namespace) { $namespace=$env{'request.state'}; }
6383:
6384: if (!$domain) { $domain=$env{'user.domain'}; }
6385: if (!$stuname) { $stuname=$env{'user.name'}; }
6386: if ($domain eq 'public' && $stuname eq 'public') {
6387: $stuname=&get_requestor_ip();
6388: }
6389: my %returnhash;
6390: $namespace=~s/\//\_/g;
6391: $namespace=~s/\W//g;
6392: my %hash;
6393: my $path=LONCAPA::tempdir();
6394: if (tie(%hash,'GDBM_File',
6395: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
6396: &GDBM_READER(),0640)) {
6397: my $version=$hash{"version:$symb"};
6398: $returnhash{'version'}=$version;
6399: my $scope;
6400: for ($scope=1;$scope<=$version;$scope++) {
6401: my $vkeys=$hash{"$scope:keys:$symb"};
6402: my @keys=split(/:/,$vkeys);
6403: my $key;
6404: $returnhash{"$scope:keys"}=$vkeys;
6405: foreach $key (@keys) {
6406: $returnhash{"$scope:$key"}=&thaw_unescape($hash{"$scope:$symb:$key"});
6407: $returnhash{"$key"}=&thaw_unescape($hash{"$scope:$symb:$key"});
6408: }
6409: }
6410: if (!(untie(%hash))) {
6411: return "error:$!";
6412: }
6413: } else {
6414: return "error:$!";
6415: }
6416: return %returnhash;
6417: }
6418:
6419: # ----------------------------------------------------------------------- Store
6420:
6421: sub store {
6422: my ($storehash,$symb,$namespace,$domain,$stuname,$laststore) = @_;
6423: my $home='';
6424:
6425: if ($stuname) { $home=&homeserver($stuname,$domain); }
6426:
6427: $symb=&symbclean($symb);
6428: if (!$symb) { unless ($symb=&symbread()) { return ''; } }
6429:
6430: if (!$domain) { $domain=$env{'user.domain'}; }
6431: if (!$stuname) { $stuname=$env{'user.name'}; }
6432:
6433: &devalidate($symb,$stuname,$domain);
6434:
6435: $symb=escape($symb);
6436: if (!$namespace) {
6437: unless ($namespace=$env{'request.course.id'}) {
6438: return '';
6439: }
6440: }
6441: if (!$home) { $home=$env{'user.home'}; }
6442:
6443: $$storehash{'ip'}=&get_requestor_ip();
6444: $$storehash{'host'}=$perlvar{'lonHostID'};
6445:
6446: my $namevalue='';
6447: foreach my $key (keys(%$storehash)) {
6448: $namevalue.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
6449: }
6450: $namevalue=~s/\&$//;
6451: &courselog($symb.':'.$stuname.':'.$domain.':STORE:'.$namevalue);
6452: return reply("store:$domain:$stuname:$namespace:$symb:$namevalue:$laststore","$home");
6453: }
6454:
6455: # -------------------------------------------------------------- Critical Store
6456:
6457: sub cstore {
6458: my ($storehash,$symb,$namespace,$domain,$stuname,$laststore) = @_;
6459: my $home='';
6460:
6461: if ($stuname) { $home=&homeserver($stuname,$domain); }
6462:
6463: $symb=&symbclean($symb);
6464: if (!$symb) { unless ($symb=&symbread()) { return ''; } }
6465:
6466: if (!$domain) { $domain=$env{'user.domain'}; }
6467: if (!$stuname) { $stuname=$env{'user.name'}; }
6468:
6469: &devalidate($symb,$stuname,$domain);
6470:
6471: $symb=escape($symb);
6472: if (!$namespace) {
6473: unless ($namespace=$env{'request.course.id'}) {
6474: return '';
6475: }
6476: }
6477: if (!$home) { $home=$env{'user.home'}; }
6478:
6479: $$storehash{'ip'}=&get_requestor_ip();
6480: $$storehash{'host'}=$perlvar{'lonHostID'};
6481:
6482: my $namevalue='';
6483: foreach my $key (keys(%$storehash)) {
6484: $namevalue.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
6485: }
6486: $namevalue=~s/\&$//;
6487: &courselog($symb.':'.$stuname.':'.$domain.':CSTORE:'.$namevalue);
6488: return critical
6489: ("store:$domain:$stuname:$namespace:$symb:$namevalue:$laststore","$home");
6490: }
6491:
6492: # --------------------------------------------------------------------- Restore
6493:
6494: sub restore {
6495: my ($symb,$namespace,$domain,$stuname) = @_;
6496: my $home='';
6497:
6498: if ($stuname) { $home=&homeserver($stuname,$domain); }
6499:
6500: if (!$symb) {
6501: return if ($namespace eq 'courserequests');
6502: unless ($symb=escape(&symbread())) { return ''; }
6503: } else {
6504: unless ($namespace eq 'courserequests') {
6505: $symb=&escape(&symbclean($symb));
6506: }
6507: }
6508: if (!$namespace) {
6509: unless ($namespace=$env{'request.course.id'}) {
6510: return '';
6511: }
6512: }
6513: if (!$domain) { $domain=$env{'user.domain'}; }
6514: if (!$stuname) { $stuname=$env{'user.name'}; }
6515: if (!$home) { $home=$env{'user.home'}; }
6516: my $answer=&reply("restore:$domain:$stuname:$namespace:$symb","$home");
6517:
6518: my %returnhash=();
6519: foreach my $line (split(/\&/,$answer)) {
6520: my ($name,$value)=split(/\=/,$line);
6521: $returnhash{&unescape($name)}=&thaw_unescape($value);
6522: }
6523: my $version;
6524: for ($version=1;$version<=$returnhash{'version'};$version++) {
6525: foreach my $item (split(/\:/,$returnhash{$version.':keys'})) {
6526: $returnhash{$item}=$returnhash{$version.':'.$item};
6527: }
6528: }
6529: return %returnhash;
6530: }
6531:
6532: # ---------------------------------------------------------- Course Description
6533: #
6534: #
6535:
6536: sub coursedescription {
6537: my ($courseid,$args)=@_;
6538: $courseid=~s/^\///;
6539: $courseid=~s/\_/\//g;
6540: my ($cdomain,$cnum)=split(/\//,$courseid);
6541: my $chome=&homeserver($cnum,$cdomain);
6542: my $normalid=$cdomain.'_'.$cnum;
6543: # need to always cache even if we get errors otherwise we keep
6544: # trying and trying and trying to get the course description.
6545: my %envhash=();
6546: my %returnhash=();
6547:
6548: my $expiretime=600;
6549: if ($env{'request.course.id'} eq $normalid) {
6550: $expiretime=120;
6551: }
6552:
6553: my $prefix='course.'.$cdomain.'_'.$cnum.'.';
6554: if (!$args->{'freshen_cache'}
6555: && ((time-$env{$prefix.'last_cache'}) < $expiretime) ) {
6556: foreach my $key (keys(%env)) {
6557: next if ($key !~ /^\Q$prefix\E(.*)/);
6558: my ($setting) = $1;
6559: $returnhash{$setting} = $env{$key};
6560: }
6561: return %returnhash;
6562: }
6563:
6564: # get the data again
6565:
6566: if (!$args->{'one_time'}) {
6567: $envhash{'course.'.$normalid.'.last_cache'}=time;
6568: }
6569:
6570: if ($chome ne 'no_host') {
6571: %returnhash=&dump('environment',$cdomain,$cnum);
6572: if (!exists($returnhash{'con_lost'})) {
6573: my $username = $env{'user.name'}; # Defult username
6574: if(defined $args->{'user'}) {
6575: $username = $args->{'user'};
6576: }
6577: $returnhash{'home'}= $chome;
6578: $returnhash{'domain'} = $cdomain;
6579: $returnhash{'num'} = $cnum;
6580: if (!defined($returnhash{'type'})) {
6581: $returnhash{'type'} = 'Course';
6582: }
6583: while (my ($name,$value) = each %returnhash) {
6584: $envhash{'course.'.$normalid.'.'.$name}=$value;
6585: }
6586: $returnhash{'url'}=&clutter($returnhash{'url'});
6587: $returnhash{'fn'}=LONCAPA::tempdir() .
6588: $username.'_'.$cdomain.'_'.$cnum;
6589: $envhash{'course.'.$normalid.'.home'}=$chome;
6590: $envhash{'course.'.$normalid.'.domain'}=$cdomain;
6591: $envhash{'course.'.$normalid.'.num'}=$cnum;
6592: }
6593: }
6594: if (!$args->{'one_time'}) {
6595: &appenv(\%envhash);
6596: }
6597: return %returnhash;
6598: }
6599:
6600: sub update_released_required {
6601: my ($needsrelease,$cdom,$cnum,$chome,$cid) = @_;
6602: if ($cdom eq '' || $cnum eq '' || $chome eq '' || $cid eq '') {
6603: $cid = $env{'request.course.id'};
6604: $cdom = $env{'course.'.$cid.'.domain'};
6605: $cnum = $env{'course.'.$cid.'.num'};
6606: $chome = $env{'course.'.$cid.'.home'};
6607: }
6608: if ($needsrelease) {
6609: my %curr_reqd_hash = &userenvironment($cdom,$cnum,'internal.releaserequired');
6610: my $needsupdate;
6611: if ($curr_reqd_hash{'internal.releaserequired'} eq '') {
6612: $needsupdate = 1;
6613: } else {
6614: my ($currmajor,$currminor) = split(/\./,$curr_reqd_hash{'internal.releaserequired'});
6615: my ($needsmajor,$needsminor) = split(/\./,$needsrelease);
6616: if (($currmajor < $needsmajor) || ($currmajor == $needsmajor && $currminor < $needsminor)) {
6617: $needsupdate = 1;
6618: }
6619: }
6620: if ($needsupdate) {
6621: my %needshash = (
6622: 'internal.releaserequired' => $needsrelease,
6623: );
6624: my $putresult = &put('environment',\%needshash,$cdom,$cnum);
6625: if ($putresult eq 'ok') {
6626: &appenv({'course.'.$cid.'.internal.releaserequired' => $needsrelease});
6627: my %crsinfo = &courseiddump($cdom,'.',1,'.','.',$cnum,undef,undef,'.');
6628: if (ref($crsinfo{$cid}) eq 'HASH') {
6629: $crsinfo{$cid}{'releaserequired'} = $needsrelease;
6630: &courseidput($cdom,\%crsinfo,$chome,'notime');
6631: }
6632: }
6633: }
6634: }
6635: return;
6636: }
6637:
6638: # -------------------------------------------------See if a user is privileged
6639:
6640: sub privileged {
6641: my ($username,$domain,$possdomains,$possroles)=@_;
6642: my $now = time;
6643: my $roles;
6644: if (ref($possroles) eq 'ARRAY') {
6645: $roles = $possroles;
6646: } else {
6647: $roles = ['dc','su'];
6648: }
6649: if (ref($possdomains) eq 'ARRAY') {
6650: my %privileged = &privileged_by_domain($possdomains,$roles);
6651: foreach my $dom (@{$possdomains}) {
6652: if (($username =~ /^$match_username$/) && ($domain =~ /^$match_domain$/) &&
6653: (ref($privileged{$dom}) eq 'HASH')) {
6654: foreach my $role (@{$roles}) {
6655: if (ref($privileged{$dom}{$role}) eq 'HASH') {
6656: if (exists($privileged{$dom}{$role}{$username.':'.$domain})) {
6657: my ($end,$start) = split(/:/,$privileged{$dom}{$role}{$username.':'.$domain});
6658: return 1 unless (($end && $end < $now) ||
6659: ($start && $start > $now));
6660: }
6661: }
6662: }
6663: }
6664: }
6665: } else {
6666: my %rolesdump = &dump("roles", $domain, $username) or return 0;
6667: my $now = time;
6668:
6669: for my $role (@rolesdump{grep { ! /^rolesdef_/ } keys(%rolesdump)}) {
6670: my ($trole, $tend, $tstart) = split(/_/, $role);
6671: if (grep(/^\Q$trole\E$/,@{$roles})) {
6672: return 1 unless ($tend && $tend < $now)
6673: or ($tstart && $tstart > $now);
6674: }
6675: }
6676: }
6677: return 0;
6678: }
6679:
6680: sub privileged_by_domain {
6681: my ($domains,$roles) = @_;
6682: my %privileged = ();
6683: my $cachetime = 60*60*24;
6684: my $now = time;
6685: unless ((ref($domains) eq 'ARRAY') && (ref($roles) eq 'ARRAY')) {
6686: return %privileged;
6687: }
6688: foreach my $dom (@{$domains}) {
6689: next if (ref($privileged{$dom}) eq 'HASH');
6690: my $needroles;
6691: foreach my $role (@{$roles}) {
6692: my ($result,$cached)=&is_cached_new('priv_'.$role,$dom);
6693: if (defined($cached)) {
6694: if (ref($result) eq 'HASH') {
6695: $privileged{$dom}{$role} = $result;
6696: }
6697: } else {
6698: $needroles = 1;
6699: }
6700: }
6701: if ($needroles) {
6702: my %dompersonnel = &get_domain_roles($dom,$roles);
6703: $privileged{$dom} = {};
6704: foreach my $server (keys(%dompersonnel)) {
6705: if (ref($dompersonnel{$server}) eq 'HASH') {
6706: foreach my $item (keys(%{$dompersonnel{$server}})) {
6707: my ($trole,$uname,$udom,$rest) = split(/:/,$item,4);
6708: my ($end,$start) = split(/:/,$dompersonnel{$server}{$item});
6709: next if ($end && $end < $now);
6710: $privileged{$dom}{$trole}{$uname.':'.$udom} =
6711: $dompersonnel{$server}{$item};
6712: }
6713: }
6714: }
6715: if (ref($privileged{$dom}) eq 'HASH') {
6716: foreach my $role (@{$roles}) {
6717: if (ref($privileged{$dom}{$role}) eq 'HASH') {
6718: &do_cache_new('priv_'.$role,$dom,$privileged{$dom}{$role},$cachetime);
6719: } else {
6720: my %hash = ();
6721: &do_cache_new('priv_'.$role,$dom,\%hash,$cachetime);
6722: }
6723: }
6724: }
6725: }
6726: }
6727: return %privileged;
6728: }
6729:
6730: # -------------------------------------------------------- Get user privileges
6731:
6732: sub rolesinit {
6733: my ($domain, $username) = @_;
6734: my %userroles = ('user.login.time' => time);
6735: my %rolesdump = &dump("roles", $domain, $username) or return \%userroles;
6736:
6737: # firstaccess and timerinterval are related to timed maps/resources.
6738: # also, blocking can be triggered by an activating timer
6739: # it's saved in the user's %env.
6740: my %firstaccess = &dump('firstaccesstimes', $domain, $username);
6741: my %timerinterval = &dump('timerinterval', $domain, $username);
6742: my (%coursetimerstarts, %firstaccchk, %firstaccenv, %coursetimerintervals,
6743: %timerintchk, %timerintenv);
6744:
6745: foreach my $key (keys(%firstaccess)) {
6746: my ($cid, $rest) = split(/\0/, $key);
6747: $coursetimerstarts{$cid}{$rest} = $firstaccess{$key};
6748: }
6749:
6750: foreach my $key (keys(%timerinterval)) {
6751: my ($cid,$rest) = split(/\0/,$key);
6752: $coursetimerintervals{$cid}{$rest} = $timerinterval{$key};
6753: }
6754:
6755: my %allroles=();
6756: my %allgroups=();
6757:
6758: for my $area (grep { ! /^rolesdef_/ } keys(%rolesdump)) {
6759: my $role = $rolesdump{$area};
6760: $area =~ s/\_\w\w$//;
6761:
6762: my ($trole, $tend, $tstart, $group_privs);
6763:
6764: if ($role =~ /^cr/) {
6765: # Custom role, defined by a user
6766: # e.g., user.role.cr/msu/smith/mynewrole
6767: if ($role =~ m|^(cr/$match_domain/$match_username/[a-zA-Z0-9]+)_(.*)$|) {
6768: $trole = $1;
6769: ($tend, $tstart) = split('_', $2);
6770: } else {
6771: $trole = $role;
6772: }
6773: } elsif ($role =~ m|^gr/|) {
6774: # Role of member in a group, defined within a course/community
6775: # e.g., user.role.gr/msu/04935610a19ee4a5fmsul1/leopards
6776: ($trole, $tend, $tstart) = split(/_/, $role);
6777: next if $tstart eq '-1';
6778: ($trole, $group_privs) = split(/\//, $trole);
6779: $group_privs = &unescape($group_privs);
6780: } else {
6781: # Just a normal role, defined in roles.tab
6782: ($trole, $tend, $tstart) = split(/_/,$role);
6783: }
6784:
6785: my %new_role = &set_arearole($trole,$area,$tstart,$tend,$domain,
6786: $username);
6787: @userroles{keys(%new_role)} = @new_role{keys(%new_role)};
6788:
6789: # role expired or not available yet?
6790: $trole = '' if ($tend != 0 && $tend < $userroles{'user.login.time'}) or
6791: ($tstart != 0 && $tstart > $userroles{'user.login.time'});
6792:
6793: next if $area eq '' or $trole eq '';
6794:
6795: my $spec = "$trole.$area";
6796: my ($tdummy, $tdomain, $trest) = split(/\//, $area);
6797:
6798: if ($trole =~ /^cr\//) {
6799: # Custom role, defined by a user
6800: &custom_roleprivs(\%allroles,$trole,$tdomain,$trest,$spec,$area);
6801: } elsif ($trole eq 'gr') {
6802: # Role of a member in a group, defined within a course/community
6803: &group_roleprivs(\%allgroups,$area,$group_privs,$tend,$tstart);
6804: next;
6805: } else {
6806: # Normal role, defined in roles.tab
6807: &standard_roleprivs(\%allroles,$trole,$tdomain,$spec,$trest,$area);
6808: }
6809:
6810: my $cid = $tdomain.'_'.$trest;
6811: unless ($firstaccchk{$cid}) {
6812: if (ref($coursetimerstarts{$cid}) eq 'HASH') {
6813: foreach my $item (keys(%{$coursetimerstarts{$cid}})) {
6814: $firstaccenv{'course.'.$cid.'.firstaccess.'.$item} =
6815: $coursetimerstarts{$cid}{$item};
6816: }
6817: }
6818: $firstaccchk{$cid} = 1;
6819: }
6820: unless ($timerintchk{$cid}) {
6821: if (ref($coursetimerintervals{$cid}) eq 'HASH') {
6822: foreach my $item (keys(%{$coursetimerintervals{$cid}})) {
6823: $timerintenv{'course.'.$cid.'.timerinterval.'.$item} =
6824: $coursetimerintervals{$cid}{$item};
6825: }
6826: }
6827: $timerintchk{$cid} = 1;
6828: }
6829: }
6830:
6831: @userroles{'user.author','user.adv','user.rar'} = &set_userprivs(\%userroles,
6832: \%allroles, \%allgroups);
6833: $env{'user.adv'} = $userroles{'user.adv'};
6834: $env{'user.rar'} = $userroles{'user.rar'};
6835:
6836: return (\%userroles,\%firstaccenv,\%timerintenv);
6837: }
6838:
6839: sub set_arearole {
6840: my ($trole,$area,$tstart,$tend,$domain,$username,$nolog) = @_;
6841: unless ($nolog) {
6842: # log the associated role with the area
6843: &userrolelog($trole,$username,$domain,$area,$tstart,$tend);
6844: }
6845: return ('user.role.'.$trole.'.'.$area => $tstart.'.'.$tend);
6846: }
6847:
6848: sub custom_roleprivs {
6849: my ($allroles,$trole,$tdomain,$trest,$spec,$area) = @_;
6850: my ($rdummy,$rdomain,$rauthor,$rrole)=split(/\//,$trole);
6851: my $homsvr = &homeserver($rauthor,$rdomain);
6852: if (&hostname($homsvr) ne '') {
6853: my ($rdummy,$roledef)=
6854: &get('roles',["rolesdef_$rrole"],$rdomain,$rauthor);
6855: if (($rdummy ne 'con_lost') && ($roledef ne '')) {
6856: my ($syspriv,$dompriv,$coursepriv)=split(/\_/,$roledef);
6857: if (defined($syspriv)) {
6858: if ($trest =~ /^$match_community$/) {
6859: $syspriv =~ s/bre\&S//;
6860: }
6861: $$allroles{'cm./'}.=':'.$syspriv;
6862: $$allroles{$spec.'./'}.=':'.$syspriv;
6863: }
6864: if ($tdomain ne '') {
6865: if (defined($dompriv)) {
6866: $$allroles{'cm./'.$tdomain.'/'}.=':'.$dompriv;
6867: $$allroles{$spec.'./'.$tdomain.'/'}.=':'.$dompriv;
6868: }
6869: if (($trest ne '') && (defined($coursepriv))) {
6870: if ($trole =~ m{^cr/$tdomain/$tdomain\Q-domainconfig\E/([^/]+)$}) {
6871: my $rolename = $1;
6872: $coursepriv = &course_adhocrole_privs($rolename,$tdomain,$trest,$coursepriv);
6873: }
6874: $$allroles{'cm.'.$area}.=':'.$coursepriv;
6875: $$allroles{$spec.'.'.$area}.=':'.$coursepriv;
6876: }
6877: }
6878: }
6879: }
6880: }
6881:
6882: sub course_adhocrole_privs {
6883: my ($rolename,$cdom,$cnum,$coursepriv) = @_;
6884: my %overrides = &get('environment',["internal.adhocpriv.$rolename"],$cdom,$cnum);
6885: if ($overrides{"internal.adhocpriv.$rolename"}) {
6886: my (%currprivs,%storeprivs);
6887: foreach my $item (split(/:/,$coursepriv)) {
6888: my ($priv,$restrict) = split(/\&/,$item);
6889: $currprivs{$priv} = $restrict;
6890: }
6891: my (%possadd,%possremove,%full);
6892: foreach my $item (split(/\:/,$Apache::lonnet::pr{'cr:c'})) {
6893: my ($priv,$restrict)=split(/\&/,$item);
6894: $full{$priv} = $restrict;
6895: }
6896: foreach my $item (split(/,/,$overrides{"internal.adhocpriv.$rolename"})) {
6897: next if ($item eq '');
6898: my ($rule,$rest) = split(/=/,$item);
6899: next unless (($rule eq 'off') || ($rule eq 'on'));
6900: foreach my $priv (split(/:/,$rest)) {
6901: if ($priv ne '') {
6902: if ($rule eq 'off') {
6903: $possremove{$priv} = 1;
6904: } else {
6905: $possadd{$priv} = 1;
6906: }
6907: }
6908: }
6909: }
6910: foreach my $priv (sort(keys(%full))) {
6911: if (exists($currprivs{$priv})) {
6912: unless (exists($possremove{$priv})) {
6913: $storeprivs{$priv} = $currprivs{$priv};
6914: }
6915: } elsif (exists($possadd{$priv})) {
6916: $storeprivs{$priv} = $full{$priv};
6917: }
6918: }
6919: $coursepriv = ':'.join(':',map { $_.'&'.$storeprivs{$_}; } sort(keys(%storeprivs)));
6920: }
6921: return $coursepriv;
6922: }
6923:
6924: sub group_roleprivs {
6925: my ($allgroups,$area,$group_privs,$tend,$tstart) = @_;
6926: my $access = 1;
6927: my $now = time;
6928: if (($tend!=0) && ($tend<$now)) { $access = 0; }
6929: if (($tstart!=0) && ($tstart>$now)) { $access=0; }
6930: if ($access) {
6931: my ($course,$group) = ($area =~ m|(/$match_domain/$match_courseid)/([^/]+)$|);
6932: $$allgroups{$course}{$group} .=':'.$group_privs;
6933: }
6934: }
6935:
6936: sub standard_roleprivs {
6937: my ($allroles,$trole,$tdomain,$spec,$trest,$area) = @_;
6938: if (defined($pr{$trole.':s'})) {
6939: $$allroles{'cm./'}.=':'.$pr{$trole.':s'};
6940: $$allroles{$spec.'./'}.=':'.$pr{$trole.':s'};
6941: }
6942: if ($tdomain ne '') {
6943: if (defined($pr{$trole.':d'})) {
6944: $$allroles{'cm./'.$tdomain.'/'}.=':'.$pr{$trole.':d'};
6945: $$allroles{$spec.'./'.$tdomain.'/'}.=':'.$pr{$trole.':d'};
6946: }
6947: if (($trest ne '') && (defined($pr{$trole.':c'}))) {
6948: $$allroles{'cm.'.$area}.=':'.$pr{$trole.':c'};
6949: $$allroles{$spec.'.'.$area}.=':'.$pr{$trole.':c'};
6950: }
6951: }
6952: }
6953:
6954: sub set_userprivs {
6955: my ($userroles,$allroles,$allgroups,$groups_roles) = @_;
6956: my $author=0;
6957: my $adv=0;
6958: my $rar=0;
6959: my %grouproles = ();
6960: if (keys(%{$allgroups}) > 0) {
6961: my @groupkeys;
6962: foreach my $role (keys(%{$allroles})) {
6963: push(@groupkeys,$role);
6964: }
6965: if (ref($groups_roles) eq 'HASH') {
6966: foreach my $key (keys(%{$groups_roles})) {
6967: unless (grep(/^\Q$key\E$/,@groupkeys)) {
6968: push(@groupkeys,$key);
6969: }
6970: }
6971: }
6972: if (@groupkeys > 0) {
6973: foreach my $role (@groupkeys) {
6974: my ($trole,$area,$sec,$extendedarea);
6975: if ($role =~ m-^(\w+|cr/$match_domain/$match_username/\w+)\.(/$match_domain/$match_courseid)(/?\w*)\.-) {
6976: $trole = $1;
6977: $area = $2;
6978: $sec = $3;
6979: $extendedarea = $area.$sec;
6980: if (exists($$allgroups{$area})) {
6981: foreach my $group (keys(%{$$allgroups{$area}})) {
6982: my $spec = $trole.'.'.$extendedarea;
6983: $grouproles{$spec.'.'.$area.'/'.$group} =
6984: $$allgroups{$area}{$group};
6985: }
6986: }
6987: }
6988: }
6989: }
6990: }
6991: foreach my $group (keys(%grouproles)) {
6992: $$allroles{$group} = $grouproles{$group};
6993: }
6994: foreach my $role (keys(%{$allroles})) {
6995: my %thesepriv;
6996: if (($role=~/^au/) || ($role=~/^ca/) || ($role=~/^aa/)) { $author=1; }
6997: foreach my $item (split(/:/,$$allroles{$role})) {
6998: if ($item ne '') {
6999: my ($privilege,$restrictions)=split(/&/,$item);
7000: if ($restrictions eq '') {
7001: $thesepriv{$privilege}='F';
7002: } elsif ($thesepriv{$privilege} ne 'F') {
7003: $thesepriv{$privilege}.=$restrictions;
7004: }
7005: if ($thesepriv{'adv'} eq 'F') { $adv=1; }
7006: if ($thesepriv{'rar'} eq 'F') { $rar=1; }
7007: }
7008: }
7009: my $thesestr='';
7010: foreach my $priv (sort(keys(%thesepriv))) {
7011: $thesestr.=':'.$priv.'&'.$thesepriv{$priv};
7012: }
7013: $userroles->{'user.priv.'.$role} = $thesestr;
7014: }
7015: return ($author,$adv,$rar);
7016: }
7017:
7018: sub role_status {
7019: my ($rolekey,$update,$refresh,$now,$role,$where,$trolecode,$tstatus,$tstart,$tend) = @_;
7020: if (exists($env{$rolekey}) && $env{$rolekey} ne '') {
7021: my ($one,$two) = split(m{\./},$rolekey,2);
7022: (undef,undef,$$role) = split(/\./,$one,3);
7023: unless (!defined($$role) || $$role eq '') {
7024: $$where = '/'.$two;
7025: $$trolecode=$$role.'.'.$$where;
7026: ($$tstart,$$tend)=split(/\./,$env{$rolekey});
7027: $$tstatus='is';
7028: if ($$tstart && $$tstart>$update) {
7029: $$tstatus='future';
7030: if ($$tstart<$now) {
7031: if ($$tstart && $$tstart>$refresh) {
7032: if (($$where ne '') && ($$role ne '')) {
7033: my (%allroles,%allgroups,$group_privs,
7034: %groups_roles,@rolecodes);
7035: my %userroles = (
7036: 'user.role.'.$$role.'.'.$$where => $$tstart.'.'.$$tend
7037: );
7038: @rolecodes = ('cm');
7039: my $spec=$$role.'.'.$$where;
7040: my ($tdummy,$tdomain,$trest)=split(/\//,$$where);
7041: if ($$role =~ /^cr\//) {
7042: &custom_roleprivs(\%allroles,$$role,$tdomain,$trest,$spec,$$where);
7043: push(@rolecodes,'cr');
7044: } elsif ($$role eq 'gr') {
7045: push(@rolecodes,$$role);
7046: my %rolehash = &get('roles',[$$where.'_'.$$role],$env{'user.domain'},
7047: $env{'user.name'});
7048: my ($trole) = split('_',$rolehash{$$where.'_'.$$role},2);
7049: (undef,my $group_privs) = split(/\//,$trole);
7050: $group_privs = &unescape($group_privs);
7051: &group_roleprivs(\%allgroups,$$where,$group_privs,$$tend,$$tstart);
7052: my %course_roles = &get_my_roles($env{'user.name'},$env{'user.domain'},'userroles',['active'],['cc','co','in','ta','ep','ad','st','cr'],[$tdomain],1);
7053: &get_groups_roles($tdomain,$trest,
7054: \%course_roles,\@rolecodes,
7055: \%groups_roles);
7056: } else {
7057: push(@rolecodes,$$role);
7058: &standard_roleprivs(\%allroles,$$role,$tdomain,$spec,$trest,$$where);
7059: }
7060: my ($author,$adv,$rar)= &set_userprivs(\%userroles,\%allroles,\%allgroups,
7061: \%groups_roles);
7062: &appenv(\%userroles,\@rolecodes);
7063: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},"Role ".$spec);
7064: }
7065: }
7066: $$tstatus = 'is';
7067: }
7068: }
7069: if ($$tend) {
7070: if ($$tend<$update) {
7071: $$tstatus='expired';
7072: } elsif ($$tend<$now) {
7073: $$tstatus='will_not';
7074: }
7075: }
7076: }
7077: }
7078: }
7079:
7080: sub get_groups_roles {
7081: my ($cdom,$rest,$cdom_courseroles,$rolecodes,$groups_roles) = @_;
7082: return unless((ref($cdom_courseroles) eq 'HASH') &&
7083: (ref($rolecodes) eq 'ARRAY') &&
7084: (ref($groups_roles) eq 'HASH'));
7085: if (keys(%{$cdom_courseroles}) > 0) {
7086: my ($cnum) = ($rest =~ /^($match_courseid)/);
7087: if ($cdom ne '' && $cnum ne '') {
7088: foreach my $key (keys(%{$cdom_courseroles})) {
7089: if ($key =~ /^\Q$cnum\E:\Q$cdom\E:([^:]+):?([^:]*)/) {
7090: my $crsrole = $1;
7091: my $crssec = $2;
7092: if ($crsrole =~ /^cr/) {
7093: unless (grep(/^cr$/,@{$rolecodes})) {
7094: push(@{$rolecodes},'cr');
7095: }
7096: } else {
7097: unless(grep(/^\Q$crsrole\E$/,@{$rolecodes})) {
7098: push(@{$rolecodes},$crsrole);
7099: }
7100: }
7101: my $rolekey = "$crsrole./$cdom/$cnum";
7102: if ($crssec ne '') {
7103: $rolekey .= "/$crssec";
7104: }
7105: $rolekey .= './';
7106: $groups_roles->{$rolekey} = $rolecodes;
7107: }
7108: }
7109: }
7110: }
7111: return;
7112: }
7113:
7114: sub delete_env_groupprivs {
7115: my ($where,$courseroles,$possroles) = @_;
7116: return unless((ref($courseroles) eq 'HASH') && (ref($possroles) eq 'ARRAY'));
7117: my ($dummy,$udom,$uname,$group) = split(/\//,$where);
7118: unless (ref($courseroles->{$udom}) eq 'HASH') {
7119: %{$courseroles->{$udom}} =
7120: &get_my_roles('','','userroles',['active'],
7121: $possroles,[$udom],1);
7122: }
7123: if (ref($courseroles->{$udom}) eq 'HASH') {
7124: foreach my $item (keys(%{$courseroles->{$udom}})) {
7125: my ($cnum,$cdom,$crsrole,$crssec) = split(/:/,$item);
7126: my $area = '/'.$cdom.'/'.$cnum;
7127: my $privkey = "user.priv.$crsrole.$area";
7128: if ($crssec ne '') {
7129: $privkey .= '/'.$crssec;
7130: }
7131: $privkey .= ".$area/$group";
7132: &Apache::lonnet::delenv($privkey,undef,[$crsrole]);
7133: }
7134: }
7135: return;
7136: }
7137:
7138: sub check_adhoc_privs {
7139: my ($cdom,$cnum,$update,$refresh,$now,$checkrole,$caller,$sec) = @_;
7140: my $cckey = 'user.role.'.$checkrole.'./'.$cdom.'/'.$cnum;
7141: if ($sec) {
7142: $cckey .= '/'.$sec;
7143: }
7144: my $setprivs;
7145: if ($env{$cckey}) {
7146: my ($role,$where,$trolecode,$tstart,$tend,$tremark,$tstatus,$tpstart,$tpend);
7147: &role_status($cckey,$update,$refresh,$now,\$role,\$where,\$trolecode,\$tstatus,\$tstart,\$tend);
7148: unless (($tstatus eq 'is') || ($tstatus eq 'will_not')) {
7149: &set_adhoc_privileges($cdom,$cnum,$checkrole,$caller,$sec);
7150: $setprivs = 1;
7151: }
7152: } else {
7153: &set_adhoc_privileges($cdom,$cnum,$checkrole,$caller,$sec);
7154: $setprivs = 1;
7155: }
7156: return $setprivs;
7157: }
7158:
7159: sub set_adhoc_privileges {
7160: # role can be cc, ca, or cr/<dom>/<dom>-domainconfig/role
7161: my ($dcdom,$pickedcourse,$role,$caller,$sec) = @_;
7162: my $area = '/'.$dcdom.'/'.$pickedcourse;
7163: if ($sec ne '') {
7164: $area .= '/'.$sec;
7165: }
7166: my $spec = $role.'.'.$area;
7167: my %userroles = &set_arearole($role,$area,'','',$env{'user.domain'},
7168: $env{'user.name'},1);
7169: my %rolehash = ();
7170: if ($role =~ m{^\Qcr/$dcdom/$dcdom\E\-domainconfig/(\w+)$}) {
7171: my $rolename = $1;
7172: &custom_roleprivs(\%rolehash,$role,$dcdom,$pickedcourse,$spec,$area);
7173: my %domdef = &get_domain_defaults($dcdom);
7174: if (ref($domdef{'adhocroles'}) eq 'HASH') {
7175: if (ref($domdef{'adhocroles'}{$rolename}) eq 'HASH') {
7176: &appenv({'request.role.desc' => $domdef{'adhocroles'}{$rolename}{'desc'},});
7177: }
7178: }
7179: } else {
7180: &standard_roleprivs(\%rolehash,$role,$dcdom,$spec,$pickedcourse,$area);
7181: }
7182: my ($author,$adv,$rar)= &set_userprivs(\%userroles,\%rolehash);
7183: &appenv(\%userroles,[$role,'cm']);
7184: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},"Role ".$spec);
7185: unless (($caller eq 'constructaccess' && $env{'request.course.id'}) ||
7186: ($caller eq 'tiny')) {
7187: &appenv( {'request.role' => $spec,
7188: 'request.role.domain' => $dcdom,
7189: 'request.course.sec' => $sec,
7190: }
7191: );
7192: my $tadv=0;
7193: if (&allowed('adv') eq 'F') { $tadv=1; }
7194: &appenv({'request.role.adv' => $tadv});
7195: }
7196: }
7197:
7198: # --------------------------------------------------------------- get interface
7199:
7200: sub get {
7201: my ($namespace,$storearr,$udomain,$uname)=@_;
7202: my $items='';
7203: foreach my $item (@$storearr) {
7204: $items.=&escape($item).'&';
7205: }
7206: $items=~s/\&$//;
7207: if (!$udomain) { $udomain=$env{'user.domain'}; }
7208: if (!$uname) { $uname=$env{'user.name'}; }
7209: my $uhome=&homeserver($uname,$udomain);
7210:
7211: my $rep=&reply("get:$udomain:$uname:$namespace:$items",$uhome);
7212: my @pairs=split(/\&/,$rep);
7213: if ( $#pairs==0 && $pairs[0] =~ /^(con_lost|error|no_such_host)/i) {
7214: return @pairs;
7215: }
7216: my %returnhash=();
7217: my $i=0;
7218: foreach my $item (@$storearr) {
7219: $returnhash{$item}=&thaw_unescape($pairs[$i]);
7220: $i++;
7221: }
7222: return %returnhash;
7223: }
7224:
7225: # --------------------------------------------------------------- del interface
7226:
7227: sub del {
7228: my ($namespace,$storearr,$udomain,$uname)=@_;
7229: my $items='';
7230: foreach my $item (@$storearr) {
7231: $items.=&escape($item).'&';
7232: }
7233:
7234: $items=~s/\&$//;
7235: if (!$udomain) { $udomain=$env{'user.domain'}; }
7236: if (!$uname) { $uname=$env{'user.name'}; }
7237: my $uhome=&homeserver($uname,$udomain);
7238: return &reply("del:$udomain:$uname:$namespace:$items",$uhome);
7239: }
7240:
7241: # -------------------------------------------------------------- dump interface
7242:
7243: sub unserialize {
7244: my ($rep, $escapedkeys) = @_;
7245:
7246: return {} if $rep =~ /^error/;
7247:
7248: my %returnhash=();
7249: foreach my $item (split(/\&/,$rep)) {
7250: my ($key, $value) = split(/=/, $item, 2);
7251: $key = unescape($key) unless $escapedkeys;
7252: next if $key =~ /^error: 2 /;
7253: $returnhash{$key} = &thaw_unescape($value);
7254: }
7255: #return %returnhash;
7256: return \%returnhash;
7257: }
7258:
7259: # see Lond::dump_with_regexp
7260: # if $escapedkeys hash keys won't get unescaped.
7261: sub dump {
7262: my ($namespace,$udomain,$uname,$regexp,$range,$escapedkeys,$encrypt)=@_;
7263: if (!$udomain) { $udomain=$env{'user.domain'}; }
7264: if (!$uname) { $uname=$env{'user.name'}; }
7265: my $uhome=&homeserver($uname,$udomain);
7266:
7267: if ($regexp) {
7268: $regexp=&escape($regexp);
7269: } else {
7270: $regexp='.';
7271: }
7272: if (grep { $_ eq $uhome } current_machine_ids()) {
7273: # user is hosted on this machine
7274: my $reply = LONCAPA::Lond::dump_with_regexp(join(":", ($udomain,
7275: $uname, $namespace, $regexp, $range)), $perlvar{'lonVersion'});
7276: return %{unserialize($reply, $escapedkeys)};
7277: }
7278: my $rep;
7279: if ($encrypt) {
7280: $rep=&reply("encrypt:edump:$udomain:$uname:$namespace:$regexp:$range",$uhome);
7281: } else {
7282: $rep=&reply("dump:$udomain:$uname:$namespace:$regexp:$range",$uhome);
7283: }
7284: my @pairs=split(/\&/,$rep);
7285: my %returnhash=();
7286: if (!($rep =~ /^error/ )) {
7287: foreach my $item (@pairs) {
7288: my ($key,$value)=split(/=/,$item,2);
7289: $key = unescape($key) unless $escapedkeys;
7290: #$key = &unescape($key);
7291: next if ($key =~ /^error: 2 /);
7292: $returnhash{$key}=&thaw_unescape($value);
7293: }
7294: }
7295: return %returnhash;
7296: }
7297:
7298:
7299: # --------------------------------------------------------- dumpstore interface
7300:
7301: sub dumpstore {
7302: my ($namespace,$udomain,$uname,$regexp,$range)=@_;
7303: # same as dump but keys must be escaped. They may contain colon separated
7304: # lists of values that may themself contain colons (e.g. symbs).
7305: return &dump($namespace, $udomain, $uname, $regexp, $range, 1);
7306: }
7307:
7308: # -------------------------------------------------------------- keys interface
7309:
7310: sub getkeys {
7311: my ($namespace,$udomain,$uname)=@_;
7312: if (!$udomain) { $udomain=$env{'user.domain'}; }
7313: if (!$uname) { $uname=$env{'user.name'}; }
7314: my $uhome=&homeserver($uname,$udomain);
7315: my $rep=reply("keys:$udomain:$uname:$namespace",$uhome);
7316: my @keyarray=();
7317: foreach my $key (split(/\&/,$rep)) {
7318: next if ($key =~ /^error: 2 /);
7319: push(@keyarray,&unescape($key));
7320: }
7321: return @keyarray;
7322: }
7323:
7324: # --------------------------------------------------------------- currentdump
7325: sub currentdump {
7326: my ($courseid,$sdom,$sname)=@_;
7327: $courseid = $env{'request.course.id'} if (! defined($courseid));
7328: $sdom = $env{'user.domain'} if (! defined($sdom));
7329: $sname = $env{'user.name'} if (! defined($sname));
7330: my $uhome = &homeserver($sname,$sdom);
7331: my $rep;
7332:
7333: if (grep { $_ eq $uhome } current_machine_ids()) {
7334: $rep = LONCAPA::Lond::dump_profile_database(join(":", ($sdom, $sname,
7335: $courseid)));
7336: } else {
7337: $rep = reply('currentdump:'.$sdom.':'.$sname.':'.$courseid,$uhome);
7338: }
7339:
7340: return if ($rep =~ /^(error:|no_such_host)/);
7341: #
7342: my %returnhash=();
7343: #
7344: if ($rep eq 'unknown_cmd') {
7345: # an old lond will not know currentdump
7346: # Do a dump and make it look like a currentdump
7347: my @tmp = &dumpstore($courseid,$sdom,$sname,'.');
7348: return if ($tmp[0] =~ /^(error:|no_such_host)/);
7349: my %hash = @tmp;
7350: @tmp=();
7351: %returnhash = %{&convert_dump_to_currentdump(\%hash)};
7352: } else {
7353: my @pairs=split(/\&/,$rep);
7354: foreach my $pair (@pairs) {
7355: my ($key,$value)=split(/=/,$pair,2);
7356: my ($symb,$param) = split(/:/,$key);
7357: $returnhash{&unescape($symb)}->{&unescape($param)} =
7358: &thaw_unescape($value);
7359: }
7360: }
7361: return %returnhash;
7362: }
7363:
7364: sub convert_dump_to_currentdump{
7365: my %hash = %{shift()};
7366: my %returnhash;
7367: # Code ripped from lond, essentially. The only difference
7368: # here is the unescaping done by lonnet::dump(). Conceivably
7369: # we might run in to problems with parameter names =~ /^v\./
7370: while (my ($key,$value) = each(%hash)) {
7371: my ($v,$symb,$param) = split(/:/,$key);
7372: $symb = &unescape($symb);
7373: $param = &unescape($param);
7374: next if ($v eq 'version' || $symb eq 'keys');
7375: next if (exists($returnhash{$symb}) &&
7376: exists($returnhash{$symb}->{$param}) &&
7377: $returnhash{$symb}->{'v.'.$param} > $v);
7378: $returnhash{$symb}->{$param}=$value;
7379: $returnhash{$symb}->{'v.'.$param}=$v;
7380: }
7381: #
7382: # Remove all of the keys in the hashes which keep track of
7383: # the version of the parameter.
7384: while (my ($symb,$param_hash) = each(%returnhash)) {
7385: # use a foreach because we are going to delete from the hash.
7386: foreach my $key (keys(%$param_hash)) {
7387: delete($param_hash->{$key}) if ($key =~ /^v\./);
7388: }
7389: }
7390: return \%returnhash;
7391: }
7392:
7393: # ------------------------------------------------------ critical inc interface
7394:
7395: sub cinc {
7396: return &inc(@_,'critical');
7397: }
7398:
7399: # --------------------------------------------------------------- inc interface
7400:
7401: sub inc {
7402: my ($namespace,$store,$udomain,$uname,$critical) = @_;
7403: if (!$udomain) { $udomain=$env{'user.domain'}; }
7404: if (!$uname) { $uname=$env{'user.name'}; }
7405: my $uhome=&homeserver($uname,$udomain);
7406: my $items='';
7407: if (! ref($store)) {
7408: # got a single value, so use that instead
7409: $items = &escape($store).'=&';
7410: } elsif (ref($store) eq 'SCALAR') {
7411: $items = &escape($$store).'=&';
7412: } elsif (ref($store) eq 'ARRAY') {
7413: $items = join('=&',map {&escape($_);} @{$store});
7414: } elsif (ref($store) eq 'HASH') {
7415: while (my($key,$value) = each(%{$store})) {
7416: $items.= &escape($key).'='.&escape($value).'&';
7417: }
7418: }
7419: $items=~s/\&$//;
7420: if ($critical) {
7421: return &critical("inc:$udomain:$uname:$namespace:$items",$uhome);
7422: } else {
7423: return &reply("inc:$udomain:$uname:$namespace:$items",$uhome);
7424: }
7425: }
7426:
7427: # --------------------------------------------------------------- put interface
7428:
7429: sub put {
7430: my ($namespace,$storehash,$udomain,$uname,$encrypt)=@_;
7431: if (!$udomain) { $udomain=$env{'user.domain'}; }
7432: if (!$uname) { $uname=$env{'user.name'}; }
7433: my $uhome=&homeserver($uname,$udomain);
7434: my $items='';
7435: foreach my $item (keys(%$storehash)) {
7436: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
7437: }
7438: $items=~s/\&$//;
7439: if ($encrypt) {
7440: return &reply("encrypt:put:$udomain:$uname:$namespace:$items",$uhome);
7441: } else {
7442: return &reply("put:$udomain:$uname:$namespace:$items",$uhome);
7443: }
7444: }
7445:
7446: # ------------------------------------------------------------ newput interface
7447:
7448: sub newput {
7449: my ($namespace,$storehash,$udomain,$uname)=@_;
7450: if (!$udomain) { $udomain=$env{'user.domain'}; }
7451: if (!$uname) { $uname=$env{'user.name'}; }
7452: my $uhome=&homeserver($uname,$udomain);
7453: my $items='';
7454: foreach my $key (keys(%$storehash)) {
7455: $items.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
7456: }
7457: $items=~s/\&$//;
7458: return &reply("newput:$udomain:$uname:$namespace:$items",$uhome);
7459: }
7460:
7461: # --------------------------------------------------------- putstore interface
7462:
7463: sub putstore {
7464: my ($namespace,$symb,$version,$storehash,$udomain,$uname,$tolog)=@_;
7465: if (!$udomain) { $udomain=$env{'user.domain'}; }
7466: if (!$uname) { $uname=$env{'user.name'}; }
7467: my $uhome=&homeserver($uname,$udomain);
7468: my $items='';
7469: foreach my $key (keys(%$storehash)) {
7470: $items.= &escape($key).'='.&freeze_escape($storehash->{$key}).'&';
7471: }
7472: $items=~s/\&$//;
7473: my $esc_symb=&escape($symb);
7474: my $esc_v=&escape($version);
7475: my $reply =
7476: &reply("putstore:$udomain:$uname:$namespace:$esc_symb:$esc_v:$items",
7477: $uhome);
7478: if (($tolog) && ($reply eq 'ok')) {
7479: my $namevalue='';
7480: foreach my $key (keys(%{$storehash})) {
7481: $namevalue.=&escape($key).'='.&freeze_escape($storehash->{$key}).'&';
7482: }
7483: my $ip = &get_requestor_ip();
7484: $namevalue .= 'ip='.&escape($ip).
7485: '&host='.&escape($perlvar{'lonHostID'}).
7486: '&version='.$esc_v.
7487: '&by='.&escape($env{'user.name'}.':'.$env{'user.domain'});
7488: &Apache::lonnet::courselog($symb.':'.$uname.':'.$udomain.':PUTSTORE:'.$namevalue);
7489: }
7490: if ($reply eq 'unknown_cmd') {
7491: # gfall back to way things use to be done
7492: return &old_putstore($namespace,$symb,$version,$storehash,$udomain,
7493: $uname);
7494: }
7495: return $reply;
7496: }
7497:
7498: sub old_putstore {
7499: my ($namespace,$symb,$version,$storehash,$udomain,$uname)=@_;
7500: if (!$udomain) { $udomain=$env{'user.domain'}; }
7501: if (!$uname) { $uname=$env{'user.name'}; }
7502: my $uhome=&homeserver($uname,$udomain);
7503: my %newstorehash;
7504: foreach my $item (keys(%$storehash)) {
7505: my $key = $version.':'.&escape($symb).':'.$item;
7506: $newstorehash{$key} = $storehash->{$item};
7507: }
7508: my $items='';
7509: my %allitems = ();
7510: foreach my $item (keys(%newstorehash)) {
7511: if ($item =~ m/^([^\:]+):([^\:]+):([^\:]+)$/) {
7512: my $key = $1.':keys:'.$2;
7513: $allitems{$key} .= $3.':';
7514: }
7515: $items.=$item.'='.&freeze_escape($newstorehash{$item}).'&';
7516: }
7517: foreach my $item (keys(%allitems)) {
7518: $allitems{$item} =~ s/\:$//;
7519: $items.= $item.'='.$allitems{$item}.'&';
7520: }
7521: $items=~s/\&$//;
7522: return &reply("put:$udomain:$uname:$namespace:$items",$uhome);
7523: }
7524:
7525: # ------------------------------------------------------ critical put interface
7526:
7527: sub cput {
7528: my ($namespace,$storehash,$udomain,$uname)=@_;
7529: if (!$udomain) { $udomain=$env{'user.domain'}; }
7530: if (!$uname) { $uname=$env{'user.name'}; }
7531: my $uhome=&homeserver($uname,$udomain);
7532: my $items='';
7533: foreach my $item (keys(%$storehash)) {
7534: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
7535: }
7536: $items=~s/\&$//;
7537: return &critical("put:$udomain:$uname:$namespace:$items",$uhome);
7538: }
7539:
7540: # -------------------------------------------------------------- eget interface
7541:
7542: sub eget {
7543: my ($namespace,$storearr,$udomain,$uname)=@_;
7544: my $items='';
7545: foreach my $item (@$storearr) {
7546: $items.=&escape($item).'&';
7547: }
7548: $items=~s/\&$//;
7549: if (!$udomain) { $udomain=$env{'user.domain'}; }
7550: if (!$uname) { $uname=$env{'user.name'}; }
7551: my $uhome=&homeserver($uname,$udomain);
7552: my $rep=&reply("eget:$udomain:$uname:$namespace:$items",$uhome);
7553: my @pairs=split(/\&/,$rep);
7554: my %returnhash=();
7555: my $i=0;
7556: foreach my $item (@$storearr) {
7557: $returnhash{$item}=&thaw_unescape($pairs[$i]);
7558: $i++;
7559: }
7560: return %returnhash;
7561: }
7562:
7563: # ------------------------------------------------------------ tmpput interface
7564: sub tmpput {
7565: my ($storehash,$server,$context)=@_;
7566: my $items='';
7567: foreach my $item (keys(%$storehash)) {
7568: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
7569: }
7570: $items=~s/\&$//;
7571: if (defined($context)) {
7572: $items .= ':'.&escape($context);
7573: }
7574: return &reply("tmpput:$items",$server);
7575: }
7576:
7577: # ------------------------------------------------------------ tmpget interface
7578: sub tmpget {
7579: my ($token,$server)=@_;
7580: if (!defined($server)) { $server = $perlvar{'lonHostID'}; }
7581: my $rep=&reply("tmpget:$token",$server);
7582: my %returnhash;
7583: if ($rep =~ /^(con_lost|error|no_such_host)/i) {
7584: return %returnhash;
7585: }
7586: foreach my $item (split(/\&/,$rep)) {
7587: my ($key,$value)=split(/=/,$item);
7588: $returnhash{&unescape($key)}=&thaw_unescape($value);
7589: }
7590: return %returnhash;
7591: }
7592:
7593: # ------------------------------------------------------------ tmpdel interface
7594: sub tmpdel {
7595: my ($token,$server)=@_;
7596: if (!defined($server)) { $server = $perlvar{'lonHostID'}; }
7597: return &reply("tmpdel:$token",$server);
7598: }
7599:
7600: # ------------------------------------------------------------ get_timebased_id
7601:
7602: sub get_timebased_id {
7603: my ($prefix,$keyid,$namespace,$cdom,$cnum,$idtype,$who,$locktries,
7604: $maxtries) = @_;
7605: my ($newid,$error,$dellock);
7606: unless (($prefix =~ /^\w+$/) && ($keyid =~ /^\w+$/) && ($namespace ne '')) {
7607: return ('','ok','invalid call to get suffix');
7608: }
7609:
7610: # set defaults for any optional args for which values were not supplied
7611: if ($who eq '') {
7612: $who = $env{'user.name'}.':'.$env{'user.domain'};
7613: }
7614: if (!$locktries) {
7615: $locktries = 3;
7616: }
7617: if (!$maxtries) {
7618: $maxtries = 10;
7619: }
7620:
7621: if (($cdom eq '') || ($cnum eq '')) {
7622: if ($env{'request.course.id'}) {
7623: $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
7624: $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
7625: }
7626: if (($cdom eq '') || ($cnum eq '')) {
7627: return ('','ok','call to get suffix not in course context');
7628: }
7629: }
7630:
7631: # construct locking item
7632: my $lockhash = {
7633: $prefix."\0".'locked_'.$keyid => $who,
7634: };
7635: my $tries = 0;
7636:
7637: # attempt to get lock on nohist_$namespace file
7638: my $gotlock = &Apache::lonnet::newput('nohist_'.$namespace,$lockhash,$cdom,$cnum);
7639: while (($gotlock ne 'ok') && $tries <$locktries) {
7640: $tries ++;
7641: sleep 1;
7642: $gotlock = &Apache::lonnet::newput('nohist_'.$namespace,$lockhash,$cdom,$cnum);
7643: }
7644:
7645: # attempt to get unique identifier, based on current timestamp
7646: if ($gotlock eq 'ok') {
7647: my %inuse = &Apache::lonnet::dump('nohist_'.$namespace,$cdom,$cnum,$prefix);
7648: my $id = time;
7649: $newid = $id;
7650: if ($idtype eq 'addcode') {
7651: $newid .= &sixnum_code();
7652: }
7653: my $idtries = 0;
7654: while (exists($inuse{$prefix."\0".$newid}) && $idtries < $maxtries) {
7655: if ($idtype eq 'concat') {
7656: $newid = $id.$idtries;
7657: } elsif ($idtype eq 'addcode') {
7658: $newid = $newid.&sixnum_code();
7659: } else {
7660: $newid ++;
7661: }
7662: $idtries ++;
7663: }
7664: if (!exists($inuse{$prefix."\0".$newid})) {
7665: my %new_item = (
7666: $prefix."\0".$newid => $who,
7667: );
7668: my $putresult = &Apache::lonnet::put('nohist_'.$namespace,\%new_item,
7669: $cdom,$cnum);
7670: if ($putresult ne 'ok') {
7671: undef($newid);
7672: $error = 'error saving new item: '.$putresult;
7673: }
7674: } else {
7675: undef($newid);
7676: $error = ('error: no unique suffix available for the new item ');
7677: }
7678: # remove lock
7679: my @del_lock = ($prefix."\0".'locked_'.$keyid);
7680: $dellock = &Apache::lonnet::del('nohist_'.$namespace,\@del_lock,$cdom,$cnum);
7681: } else {
7682: $error = "error: could not obtain lockfile\n";
7683: $dellock = 'ok';
7684: if (($prefix eq 'paste') && ($namespace eq 'courseeditor') && ($keyid eq 'num')) {
7685: $dellock = 'nolock';
7686: }
7687: }
7688: return ($newid,$dellock,$error);
7689: }
7690:
7691: sub sixnum_code {
7692: my $code;
7693: for (0..6) {
7694: $code .= int( rand(9) );
7695: }
7696: return $code;
7697: }
7698:
7699: # -------------------------------------------------- portfolio access checking
7700:
7701: sub portfolio_access {
7702: my ($requrl,$clientip) = @_;
7703: my (undef,$udom,$unum,$file_name,$group) = &parse_portfolio_url($requrl);
7704: my $result = &get_portfolio_access($udom,$unum,$file_name,$group,$clientip);
7705: if ($result) {
7706: my %setters;
7707: if ($env{'user.name'} eq 'public' && $env{'user.domain'} eq 'public') {
7708: my ($startblock,$endblock,$triggerblock,$by_ip,$blockdom) =
7709: &Apache::loncommon::blockcheck(\%setters,'port',$clientip,$unum,$udom);
7710: if (($startblock && $endblock) || ($by_ip)) {
7711: return 'B';
7712: }
7713: } else {
7714: my ($startblock,$endblock,$triggerblock,$by_ip,$blockdom) =
7715: &Apache::loncommon::blockcheck(\%setters,'port',$clientip);
7716: if (($startblock && $endblock) || ($by_ip)) {
7717: return 'B';
7718: }
7719: }
7720: }
7721: if ($result eq 'ok') {
7722: return 'F';
7723: } elsif ($result =~ /^[^:]+:guest_/) {
7724: return 'A';
7725: }
7726: return '';
7727: }
7728:
7729: sub get_portfolio_access {
7730: my ($udom,$unum,$file_name,$group,$clientip,$access_hash) = @_;
7731:
7732: if (!ref($access_hash)) {
7733: my $current_perms = &get_portfile_permissions($udom,$unum);
7734: my %access_controls = &get_access_controls($current_perms,$group,
7735: $file_name);
7736: $access_hash = $access_controls{$file_name};
7737: }
7738:
7739: my ($public,$guest,@domains,@users,@courses,@groups,@ips);
7740: my $now = time;
7741: if (ref($access_hash) eq 'HASH') {
7742: foreach my $key (keys(%{$access_hash})) {
7743: my ($num,$scope,$end,$start) = ($key =~ /^([^:]+):([a-z]+)_(\d*)_?(\d*)$/);
7744: if ($start > $now) {
7745: next;
7746: }
7747: if ($end && $end<$now) {
7748: next;
7749: }
7750: if ($scope eq 'public') {
7751: $public = $key;
7752: last;
7753: } elsif ($scope eq 'guest') {
7754: $guest = $key;
7755: } elsif ($scope eq 'domains') {
7756: push(@domains,$key);
7757: } elsif ($scope eq 'users') {
7758: push(@users,$key);
7759: } elsif ($scope eq 'course') {
7760: push(@courses,$key);
7761: } elsif ($scope eq 'group') {
7762: push(@groups,$key);
7763: } elsif ($scope eq 'ip') {
7764: push(@ips,$key);
7765: }
7766: }
7767: if ($public) {
7768: return 'ok';
7769: } elsif (@ips > 0) {
7770: my $allowed;
7771: foreach my $ipkey (@ips) {
7772: if (ref($access_hash->{$ipkey}{'ip'}) eq 'ARRAY') {
7773: if (&Apache::loncommon::check_ip_acc(join(',',@{$access_hash->{$ipkey}{'ip'}}),$clientip)) {
7774: $allowed = 1;
7775: last;
7776: }
7777: }
7778: }
7779: if ($allowed) {
7780: return 'ok';
7781: }
7782: }
7783: if ($env{'user.name'} eq 'public' && $env{'user.domain'} eq 'public') {
7784: if ($guest) {
7785: return $guest;
7786: }
7787: } else {
7788: if (@domains > 0) {
7789: foreach my $domkey (@domains) {
7790: if (ref($access_hash->{$domkey}{'dom'}) eq 'ARRAY') {
7791: if (grep(/^\Q$env{'user.domain'}\E$/,@{$access_hash->{$domkey}{'dom'}})) {
7792: return 'ok';
7793: }
7794: }
7795: }
7796: }
7797: if (@users > 0) {
7798: foreach my $userkey (@users) {
7799: if (ref($access_hash->{$userkey}{'users'}) eq 'ARRAY') {
7800: foreach my $item (@{$access_hash->{$userkey}{'users'}}) {
7801: if (ref($item) eq 'HASH') {
7802: if (($item->{'uname'} eq $env{'user.name'}) &&
7803: ($item->{'udom'} eq $env{'user.domain'})) {
7804: return 'ok';
7805: }
7806: }
7807: }
7808: }
7809: }
7810: }
7811: my %roleshash;
7812: my @courses_and_groups = @courses;
7813: push(@courses_and_groups,@groups);
7814: if (@courses_and_groups > 0) {
7815: my (%allgroups,%allroles);
7816: my ($start,$end,$role,$sec,$group);
7817: foreach my $envkey (%env) {
7818: if ($envkey =~ m-^user\.role\.(gr|cc|co|in|ta|ep|ad|st)\./($match_domain)/($match_courseid)/?([^/]*)$-) {
7819: my $cid = $2.'_'.$3;
7820: if ($1 eq 'gr') {
7821: $group = $4;
7822: $allgroups{$cid}{$group} = $env{$envkey};
7823: } else {
7824: if ($4 eq '') {
7825: $sec = 'none';
7826: } else {
7827: $sec = $4;
7828: }
7829: $allroles{$cid}{$1}{$sec} = $env{$envkey};
7830: }
7831: } elsif ($envkey =~ m-^user\.role\./cr/($match_domain/$match_username/\w*)./($match_domain)/($match_courseid)/?([^/]*)$-) {
7832: my $cid = $2.'_'.$3;
7833: if ($4 eq '') {
7834: $sec = 'none';
7835: } else {
7836: $sec = $4;
7837: }
7838: $allroles{$cid}{$1}{$sec} = $env{$envkey};
7839: }
7840: }
7841: if (keys(%allroles) == 0) {
7842: return;
7843: }
7844: foreach my $key (@courses_and_groups) {
7845: my %content = %{$$access_hash{$key}};
7846: my $cnum = $content{'number'};
7847: my $cdom = $content{'domain'};
7848: my $cid = $cdom.'_'.$cnum;
7849: if (!exists($allroles{$cid})) {
7850: next;
7851: }
7852: foreach my $role_id (keys(%{$content{'roles'}})) {
7853: my @sections = @{$content{'roles'}{$role_id}{'section'}};
7854: my @groups = @{$content{'roles'}{$role_id}{'group'}};
7855: my @status = @{$content{'roles'}{$role_id}{'access'}};
7856: my @roles = @{$content{'roles'}{$role_id}{'role'}};
7857: foreach my $role (keys(%{$allroles{$cid}})) {
7858: if ((grep/^all$/,@roles) || (grep/^\Q$role\E$/,@roles)) {
7859: foreach my $sec (keys(%{$allroles{$cid}{$role}})) {
7860: if (&course_group_datechecker($allroles{$cid}{$role}{$sec},$now,\@status) eq 'ok') {
7861: if (grep/^all$/,@sections) {
7862: return 'ok';
7863: } else {
7864: if (grep/^$sec$/,@sections) {
7865: return 'ok';
7866: }
7867: }
7868: }
7869: }
7870: if (keys(%{$allgroups{$cid}}) == 0) {
7871: if (grep/^none$/,@groups) {
7872: return 'ok';
7873: }
7874: } else {
7875: if (grep/^all$/,@groups) {
7876: return 'ok';
7877: }
7878: foreach my $group (keys(%{$allgroups{$cid}})) {
7879: if (grep/^$group$/,@groups) {
7880: return 'ok';
7881: }
7882: }
7883: }
7884: }
7885: }
7886: }
7887: }
7888: }
7889: if ($guest) {
7890: return $guest;
7891: }
7892: }
7893: }
7894: return;
7895: }
7896:
7897: sub course_group_datechecker {
7898: my ($dates,$now,$status) = @_;
7899: my ($start,$end) = split(/\./,$dates);
7900: if (!$start && !$end) {
7901: return 'ok';
7902: }
7903: if (grep/^active$/,@{$status}) {
7904: if (((!$start) || ($start && $start <= $now)) && ((!$end) || ($end && $end >= $now))) {
7905: return 'ok';
7906: }
7907: }
7908: if (grep/^previous$/,@{$status}) {
7909: if ($end > $now ) {
7910: return 'ok';
7911: }
7912: }
7913: if (grep/^future$/,@{$status}) {
7914: if ($start > $now) {
7915: return 'ok';
7916: }
7917: }
7918: return;
7919: }
7920:
7921: sub parse_portfolio_url {
7922: my ($url) = @_;
7923:
7924: my ($type,$udom,$unum,$group,$file_name);
7925:
7926: if ($url =~ m-^/*(?:uploaded|editupload)/($match_domain)/($match_username)/portfolio(/.+)$-) {
7927: $type = 1;
7928: $udom = $1;
7929: $unum = $2;
7930: $file_name = $3;
7931: } elsif ($url =~ m-^/*(?:uploaded|editupload)/($match_domain)/($match_courseid)/groups/([^/]+)/portfolio/(.+)$-) {
7932: $type = 2;
7933: $udom = $1;
7934: $unum = $2;
7935: $group = $3;
7936: $file_name = $3.'/'.$4;
7937: }
7938: if (wantarray) {
7939: return ($type,$udom,$unum,$file_name,$group);
7940: }
7941: return $type;
7942: }
7943:
7944: sub is_portfolio_url {
7945: my ($url) = @_;
7946: return scalar(&parse_portfolio_url($url));
7947: }
7948:
7949: sub is_portfolio_file {
7950: my ($file) = @_;
7951: if (($file =~ /^portfolio/) || ($file =~ /^groups\/\w+\/portfolio/)) {
7952: return 1;
7953: }
7954: return;
7955: }
7956:
7957: sub usertools_access {
7958: my ($uname,$udom,$tool,$action,$context,$userenvref,$domdefref,$is_advref)=@_;
7959: my ($access,%tools);
7960: if ($context eq '') {
7961: $context = 'tools';
7962: }
7963: if ($context eq 'requestcourses') {
7964: %tools = (
7965: official => 1,
7966: unofficial => 1,
7967: community => 1,
7968: textbook => 1,
7969: placement => 1,
7970: lti => 1,
7971: );
7972: } elsif ($context eq 'requestauthor') {
7973: %tools = (
7974: requestauthor => 1,
7975: );
7976: } else {
7977: %tools = (
7978: aboutme => 1,
7979: blog => 1,
7980: webdav => 1,
7981: portfolio => 1,
7982: timezone => 1,
7983: );
7984: }
7985: return if (!defined($tools{$tool}));
7986:
7987: if (($udom eq '') || ($uname eq '')) {
7988: $udom = $env{'user.domain'};
7989: $uname = $env{'user.name'};
7990: }
7991:
7992: if (($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'})) {
7993: if ($action ne 'reload') {
7994: if ($context eq 'requestcourses') {
7995: return $env{'environment.canrequest.'.$tool};
7996: } elsif ($context eq 'requestauthor') {
7997: return $env{'environment.canrequest.author'};
7998: } else {
7999: return $env{'environment.availabletools.'.$tool};
8000: }
8001: }
8002: }
8003:
8004: my ($toolstatus,$inststatus,$envkey);
8005: if ($context eq 'requestauthor') {
8006: $envkey = $context;
8007: } else {
8008: $envkey = $context.'.'.$tool;
8009: }
8010:
8011: if (($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'}) &&
8012: ($action ne 'reload')) {
8013: $toolstatus = $env{'environment.'.$envkey};
8014: $inststatus = $env{'environment.inststatus'};
8015: } else {
8016: if (ref($userenvref) eq 'HASH') {
8017: $toolstatus = $userenvref->{$envkey};
8018: $inststatus = $userenvref->{'inststatus'};
8019: } else {
8020: my %userenv = &userenvironment($udom,$uname,$envkey,'inststatus');
8021: $toolstatus = $userenv{$envkey};
8022: $inststatus = $userenv{'inststatus'};
8023: }
8024: }
8025:
8026: if ($toolstatus ne '') {
8027: if ($toolstatus) {
8028: $access = 1;
8029: } else {
8030: $access = 0;
8031: }
8032: return $access;
8033: }
8034:
8035: my ($is_adv,%domdef);
8036: if (ref($is_advref) eq 'HASH') {
8037: $is_adv = $is_advref->{'is_adv'};
8038: } else {
8039: $is_adv = &is_advanced_user($udom,$uname);
8040: }
8041: if (ref($domdefref) eq 'HASH') {
8042: %domdef = %{$domdefref};
8043: } else {
8044: %domdef = &get_domain_defaults($udom);
8045: }
8046: if (ref($domdef{$tool}) eq 'HASH') {
8047: if ($is_adv) {
8048: if ($domdef{$tool}{'_LC_adv'} ne '') {
8049: if ($domdef{$tool}{'_LC_adv'}) {
8050: $access = 1;
8051: } else {
8052: $access = 0;
8053: }
8054: return $access;
8055: }
8056: }
8057: if ($inststatus ne '') {
8058: my ($hasaccess,$hasnoaccess);
8059: foreach my $affiliation (split(/:/,$inststatus)) {
8060: if ($domdef{$tool}{$affiliation} ne '') {
8061: if ($domdef{$tool}{$affiliation}) {
8062: $hasaccess = 1;
8063: } else {
8064: $hasnoaccess = 1;
8065: }
8066: }
8067: }
8068: if ($hasaccess || $hasnoaccess) {
8069: if ($hasaccess) {
8070: $access = 1;
8071: } elsif ($hasnoaccess) {
8072: $access = 0;
8073: }
8074: return $access;
8075: }
8076: } else {
8077: if ($domdef{$tool}{'default'} ne '') {
8078: if ($domdef{$tool}{'default'}) {
8079: $access = 1;
8080: } elsif ($domdef{$tool}{'default'} == 0) {
8081: $access = 0;
8082: }
8083: return $access;
8084: }
8085: }
8086: } else {
8087: if (($context eq 'tools') && ($tool ne 'webdav')) {
8088: $access = 1;
8089: } else {
8090: $access = 0;
8091: }
8092: return $access;
8093: }
8094: }
8095:
8096: sub is_course_owner {
8097: my ($cdom,$cnum,$udom,$uname) = @_;
8098: if (($udom eq '') || ($uname eq '')) {
8099: $udom = $env{'user.domain'};
8100: $uname = $env{'user.name'};
8101: }
8102: unless (($udom eq '') || ($uname eq '')) {
8103: if (exists($env{'course.'.$cdom.'_'.$cnum.'.internal.courseowner'})) {
8104: if ($env{'course.'.$cdom.'_'.$cnum.'.internal.courseowner'} eq $uname.':'.$udom) {
8105: return 1;
8106: } else {
8107: my %courseinfo = &Apache::lonnet::coursedescription($cdom.'/'.$cnum);
8108: if ($courseinfo{'internal.courseowner'} eq $uname.':'.$udom) {
8109: return 1;
8110: }
8111: }
8112: }
8113: }
8114: return;
8115: }
8116:
8117: sub is_advanced_user {
8118: my ($udom,$uname) = @_;
8119: if ($udom ne '' && $uname ne '') {
8120: if (($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'})) {
8121: if (wantarray) {
8122: return ($env{'user.adv'},$env{'user.author'});
8123: } else {
8124: return $env{'user.adv'};
8125: }
8126: }
8127: }
8128: my %roleshash = &get_my_roles($uname,$udom,'userroles',undef,undef,undef,1);
8129: my %allroles;
8130: my ($is_adv,$is_author);
8131: foreach my $role (keys(%roleshash)) {
8132: my ($trest,$tdomain,$trole,$sec) = split(/:/,$role);
8133: my $area = '/'.$tdomain.'/'.$trest;
8134: if ($sec ne '') {
8135: $area .= '/'.$sec;
8136: }
8137: if (($area ne '') && ($trole ne '')) {
8138: my $spec=$trole.'.'.$area;
8139: if ($trole =~ /^cr\//) {
8140: &custom_roleprivs(\%allroles,$trole,$tdomain,$trest,$spec,$area);
8141: } elsif ($trole ne 'gr') {
8142: &standard_roleprivs(\%allroles,$trole,$tdomain,$spec,$trest,$area);
8143: }
8144: if ($trole eq 'au') {
8145: $is_author = 1;
8146: }
8147: }
8148: }
8149: foreach my $role (keys(%allroles)) {
8150: last if ($is_adv);
8151: foreach my $item (split(/:/,$allroles{$role})) {
8152: if ($item ne '') {
8153: my ($privilege,$restrictions)=split(/&/,$item);
8154: if ($privilege eq 'adv') {
8155: $is_adv = 1;
8156: last;
8157: }
8158: }
8159: }
8160: }
8161: if (wantarray) {
8162: return ($is_adv,$is_author);
8163: }
8164: return $is_adv;
8165: }
8166:
8167: sub check_can_request {
8168: my ($dom,$can_request,$request_domains,$uname,$udom) = @_;
8169: my $canreq = 0;
8170: if (($env{'user.name'} ne '') && ($env{'user.domain'} ne '')) {
8171: $uname = $env{'user.name'};
8172: $udom = $env{'user.domain'};
8173: }
8174: my ($types,$typename) = &Apache::loncommon::course_types();
8175: my @options = ('approval','validate','autolimit');
8176: my $optregex = join('|',@options);
8177: if ((ref($can_request) eq 'HASH') && (ref($types) eq 'ARRAY')) {
8178: my %willtrust;
8179: foreach my $type (@{$types}) {
8180: if (&usertools_access($uname,$udom,$type,undef,
8181: 'requestcourses')) {
8182: $canreq ++;
8183: if (ref($request_domains) eq 'HASH') {
8184: push(@{$request_domains->{$type}},$udom);
8185: }
8186: if ($dom eq $udom) {
8187: $can_request->{$type} = 1;
8188: }
8189: }
8190: if (($env{'user.name'} ne '') && ($env{'user.domain'} ne '') &&
8191: ($env{'environment.reqcrsotherdom.'.$type} ne '')) {
8192: my @curr = split(',',$env{'environment.reqcrsotherdom.'.$type});
8193: if (@curr > 0) {
8194: foreach my $item (@curr) {
8195: if (ref($request_domains) eq 'HASH') {
8196: my ($otherdom) = ($item =~ /^($match_domain):($optregex)(=?\d*)$/);
8197: if ($otherdom ne '') {
8198: unless (exists($willtrust{$otherdom})) {
8199: $willtrust{$otherdom} = &will_trust('reqcrs',$env{'user.domain'},$otherdom);
8200: }
8201: if ($willtrust{$otherdom}) {
8202: if (ref($request_domains->{$type}) eq 'ARRAY') {
8203: unless (grep(/^\Q$otherdom\E$/,@{$request_domains->{$type}})) {
8204: push(@{$request_domains->{$type}},$otherdom);
8205: }
8206: } else {
8207: push(@{$request_domains->{$type}},$otherdom);
8208: }
8209: }
8210: }
8211: }
8212: }
8213: unless ($dom eq $env{'user.domain'}) {
8214: $canreq ++;
8215: if (grep(/^\Q$dom\E:($optregex)(=?\d*)$/,@curr)) {
8216: $can_request->{$type} = 1;
8217: }
8218: }
8219: }
8220: }
8221: }
8222: }
8223: return $canreq;
8224: }
8225:
8226: # ---------------------------------------------- Custom access rule evaluation
8227:
8228: sub customaccess {
8229: my ($priv,$uri)=@_;
8230: my ($urole,$urealm)=split(/\./,$env{'request.role'},2);
8231: my (undef,$udom,$ucrs,$usec)=split(/\//,$urealm);
8232: $udom = &LONCAPA::clean_domain($udom);
8233: $ucrs = &LONCAPA::clean_username($ucrs);
8234: my $access=0;
8235: foreach my $right (split(/\s*\,\s*/,&metadata($uri,'rule_rights'))) {
8236: my ($effect,$realm,$role,$type)=split(/\:/,$right);
8237: if ($type eq 'user') {
8238: foreach my $scope (split(/\s*\,\s*/,$realm)) {
8239: my ($tdom,$tuname)=split(m{/},$scope);
8240: if ($tdom) {
8241: if ($tdom ne $env{'user.domain'}) { next; }
8242: }
8243: if ($tuname) {
8244: if ($tuname ne $env{'user.name'}) { next; }
8245: }
8246: $access=($effect eq 'allow');
8247: last;
8248: }
8249: } else {
8250: if ($role) {
8251: if ($role ne $urole) { next; }
8252: }
8253: foreach my $scope (split(/\s*\,\s*/,$realm)) {
8254: my ($tdom,$tcrs,$tsec)=split(/\_/,$scope);
8255: if ($tdom) {
8256: if ($tdom ne $udom) { next; }
8257: }
8258: if ($tcrs) {
8259: if ($tcrs ne $ucrs) { next; }
8260: }
8261: if ($tsec) {
8262: if ($tsec ne $usec) { next; }
8263: }
8264: $access=($effect eq 'allow');
8265: last;
8266: }
8267: if ($realm eq '' && $role eq '') {
8268: $access=($effect eq 'allow');
8269: }
8270: }
8271: }
8272: return $access;
8273: }
8274:
8275: # ------------------------------------------------- Check for a user privilege
8276:
8277: sub allowed {
8278: my ($priv,$uri,$symb,$role,$clientip,$noblockcheck,$ignorecache,$nodeeplinkcheck,$nodeeplinkout)=@_;
8279: my $ver_orguri=$uri;
8280: $uri=&deversion($uri);
8281: my $orguri=$uri;
8282: $uri=&declutter($uri);
8283:
8284: if ($priv eq 'evb') {
8285: # Evade communication block restrictions for specified role in a course or domain
8286: if ($env{'user.priv.'.$role} =~/evb\&([^\:]*)/) {
8287: return $1;
8288: } else {
8289: return;
8290: }
8291: }
8292:
8293: if (defined($env{'allowed.'.$priv})) { return $env{'allowed.'.$priv}; }
8294: # Free bre access to adm and meta resources
8295: if (((($uri=~/^adm\//) && ($uri !~ m{/(?:smppg|bulletinboard|viewclasslist|aboutme|ext\.tool)$}))
8296: || (($uri=~/\.meta$/) && ($uri!~m|^uploaded/|) ))
8297: && ($priv eq 'bre')) {
8298: return 'F';
8299: }
8300:
8301: # Free bre access to user's own portfolio contents
8302: my ($space,$domain,$name,@dir)=split('/',$uri);
8303: if (($space=~/^(uploaded|editupload)$/) && ($env{'user.name'} eq $name) &&
8304: ($env{'user.domain'} eq $domain) && ('portfolio' eq $dir[0])) {
8305: my %setters;
8306: my ($startblock,$endblock,$triggerblock,$by_ip,$blockdom) =
8307: &Apache::loncommon::blockcheck(\%setters,'port',$clientip);
8308: if (($startblock && $endblock) || ($by_ip)) {
8309: return 'B';
8310: } else {
8311: return 'F';
8312: }
8313: }
8314:
8315: # bre access to group portfolio for rgf priv in group, or mdg or vcg in course.
8316: if (($space=~/^(uploaded|editupload)$/) && ($dir[0] eq 'groups')
8317: && ($dir[2] eq 'portfolio') && ($priv eq 'bre')) {
8318: if (exists($env{'request.course.id'})) {
8319: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
8320: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
8321: if (($domain eq $cdom) && ($name eq $cnum)) {
8322: my $courseprivid=$env{'request.course.id'};
8323: $courseprivid=~s/\_/\//;
8324: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid
8325: .'/'.$dir[1]} =~/rgf\&([^\:]*)/) {
8326: return $1;
8327: } else {
8328: if ($env{'request.course.sec'}) {
8329: $courseprivid.='/'.$env{'request.course.sec'};
8330: }
8331: if ($env{'user.priv.'.$env{'request.role'}.'./'.
8332: $courseprivid} =~/(mdg|vcg)\&([^\:]*)/) {
8333: return $2;
8334: }
8335: }
8336: }
8337: }
8338: }
8339:
8340: # Free bre to public access
8341:
8342: if ($priv eq 'bre') {
8343: my $copyright;
8344: unless ($uri =~ /ext\.tool/) {
8345: $copyright=&metadata($uri,'copyright');
8346: }
8347: if (($copyright eq 'public') && (!$env{'request.course.id'})) {
8348: return 'F';
8349: }
8350: if ($copyright eq 'priv') {
8351: $uri=~/([^\/]+)\/([^\/]+)\//;
8352: unless (($env{'user.name'} eq $2) && ($env{'user.domain'} eq $1)) {
8353: return '';
8354: }
8355: }
8356: if ($copyright eq 'domain') {
8357: $uri=~/([^\/]+)\/([^\/]+)\//;
8358: unless (($env{'user.domain'} eq $1) ||
8359: ($env{'course.'.$env{'request.course.id'}.'.domain'} eq $1)) {
8360: return '';
8361: }
8362: }
8363: if ($env{'request.role'}=~ /li\.\//) {
8364: # Library role, so allow browsing of resources in this domain.
8365: return 'F';
8366: }
8367: if ($copyright eq 'custom') {
8368: unless (&customaccess($priv,$uri)) { return ''; }
8369: }
8370: }
8371: # Domain coordinator is trying to create a course
8372: if (($priv eq 'ccc') && ($env{'request.role'} =~ /^dc\./)) {
8373: # uri is the requested domain in this case.
8374: # comparison to 'request.role.domain' shows if the user has selected
8375: # a role of dc for the domain in question.
8376: return 'F' if ($uri eq $env{'request.role.domain'});
8377: }
8378:
8379: my $thisallowed='';
8380: my $statecond=0;
8381: my $courseprivid='';
8382:
8383: my $ownaccess;
8384: # Community Coordinator or Assistant Co-author browsing resource space.
8385: if (($priv eq 'bro') && ($env{'user.author'})) {
8386: if ($uri eq '') {
8387: $ownaccess = 1;
8388: } else {
8389: if (($env{'user.domain'} ne '') && ($env{'user.name'} ne '')) {
8390: my $udom = $env{'user.domain'};
8391: my $uname = $env{'user.name'};
8392: if ($uri =~ m{^\Q$udom\E/?$}) {
8393: $ownaccess = 1;
8394: } elsif ($uri =~ m{^\Q$udom\E/\Q$uname\E/?}) {
8395: unless ($uri =~ m{\.\./}) {
8396: $ownaccess = 1;
8397: }
8398: } elsif (($udom ne 'public') && ($uname ne 'public')) {
8399: my $now = time;
8400: if ($uri =~ m{^([^/]+)/?$}) {
8401: my $adom = $1;
8402: foreach my $key (keys(%env)) {
8403: if ($key =~ m{^user\.role\.(ca|aa)/\Q$adom\E}) {
8404: my ($start,$end) = split(/\./,$env{$key});
8405: if (($now >= $start) && (!$end || $end > $now)) {
8406: $ownaccess = 1;
8407: last;
8408: }
8409: }
8410: }
8411: } elsif ($uri =~ m{^([^/]+)/([^/]+)/?}) {
8412: my $adom = $1;
8413: my $aname = $2;
8414: foreach my $role ('ca','aa') {
8415: if ($env{"user.role.$role./$adom/$aname"}) {
8416: my ($start,$end) =
8417: split(/\./,$env{"user.role.$role./$adom/$aname"});
8418: if (($now >= $start) && (!$end || $end > $now)) {
8419: $ownaccess = 1;
8420: last;
8421: }
8422: }
8423: }
8424: }
8425: }
8426: }
8427: }
8428: }
8429:
8430: # Course
8431:
8432: if ($env{'user.priv.'.$env{'request.role'}.'./'}=~/\Q$priv\E\&([^\:]*)/) {
8433: unless (($priv eq 'bro') && (!$ownaccess)) {
8434: $thisallowed.=$1;
8435: }
8436: }
8437:
8438: # Domain
8439:
8440: if ($env{'user.priv.'.$env{'request.role'}.'./'.(split(/\//,$uri))[0].'/'}
8441: =~/\Q$priv\E\&([^\:]*)/) {
8442: unless (($priv eq 'bro') && (!$ownaccess)) {
8443: $thisallowed.=$1;
8444: }
8445: }
8446:
8447: # User who is not author or co-author might still be able to edit
8448: # resource of an author in the domain (e.g., if Domain Coordinator).
8449: if (($priv eq 'eco') && ($thisallowed eq '') && ($env{'request.course.id'}) &&
8450: (&allowed('mdc',$env{'request.course.id'}))) {
8451: if ($env{"user.priv.cm./$uri/"}=~/\Q$priv\E\&([^\:]*)/) {
8452: $thisallowed.=$1;
8453: }
8454: }
8455:
8456: # Course: uri itself is a course
8457: my $courseuri=$uri;
8458: $courseuri=~s/\_(\d)/\/$1/;
8459: $courseuri=~s/^([^\/])/\/$1/;
8460:
8461: if ($env{'user.priv.'.$env{'request.role'}.'.'.$courseuri}
8462: =~/\Q$priv\E\&([^\:]*)/) {
8463: if ($priv eq 'mip') {
8464: my $rem = $1;
8465: if (($uri ne '') && ($env{'request.course.id'} eq $uri) &&
8466: ($env{'course.'.$env{'request.course.id'}.'.internal.courseowner'} eq $env{'user.name'}.':'.$env{'user.domain'})) {
8467: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
8468: if ($cdom ne '') {
8469: my %passwdconf = &get_passwdconf($cdom);
8470: if (ref($passwdconf{'crsownerchg'}) eq 'HASH') {
8471: if (ref($passwdconf{'crsownerchg'}{'by'}) eq 'ARRAY') {
8472: if (@{$passwdconf{'crsownerchg'}{'by'}}) {
8473: my @inststatuses = split(':',$env{'environment.inststatus'});
8474: unless (@inststatuses) {
8475: @inststatuses = ('default');
8476: }
8477: foreach my $status (@inststatuses) {
8478: if (grep(/^\Q$status\E$/,@{$passwdconf{'crsownerchg'}{'by'}})) {
8479: $thisallowed.=$rem;
8480: }
8481: }
8482: }
8483: }
8484: }
8485: }
8486: }
8487: } else {
8488: unless (($priv eq 'bro') && (!$ownaccess)) {
8489: $thisallowed.=$1;
8490: }
8491: }
8492: }
8493:
8494: # URI is an uploaded document for this course, default permissions don't matter
8495: # not allowing 'edit' access (editupload) to uploaded course docs
8496: if (($priv eq 'bre') && ($uri=~m|^uploaded/|)) {
8497: $thisallowed='';
8498: my ($match)=&is_on_map($uri);
8499: if ($match) {
8500: if ($env{'user.priv.'.$env{'request.role'}.'./'}
8501: =~/\Q$priv\E\&([^\:]*)/) {
8502: my $value = $1;
8503: my $deeplinkblock;
8504: unless ($nodeeplinkcheck) {
8505: $deeplinkblock = &deeplink_check($priv,$symb,$uri);
8506: }
8507: if ($deeplinkblock) {
8508: $thisallowed='D';
8509: } elsif ($noblockcheck) {
8510: $thisallowed.=$value;
8511: } else {
8512: my @blockers = &has_comm_blocking($priv,$symb,$uri,$ignorecache);
8513: if (@blockers > 0) {
8514: $thisallowed = 'B';
8515: } else {
8516: $thisallowed.=$value;
8517: }
8518: }
8519: }
8520: } else {
8521: my $refuri = $env{'httpref.'.$orguri} || $env{'httpref.'.$ver_orguri};
8522: if ($refuri) {
8523: if ($refuri =~ m|^/adm/|) {
8524: $thisallowed='F';
8525: } else {
8526: $refuri=&declutter($refuri);
8527: my ($match) = &is_on_map($refuri);
8528: if ($match) {
8529: my $deeplinkblock;
8530: unless ($nodeeplinkcheck) {
8531: $deeplinkblock = &deeplink_check($priv,$symb,$refuri);
8532: }
8533: if ($deeplinkblock) {
8534: $thisallowed='D';
8535: } elsif ($noblockcheck) {
8536: $thisallowed='F';
8537: } else {
8538: my @blockers = &has_comm_blocking($priv,'',$refuri,'',1);
8539: if (@blockers > 0) {
8540: $thisallowed = 'B';
8541: } else {
8542: $thisallowed='F';
8543: }
8544: }
8545: }
8546: }
8547: }
8548: }
8549: }
8550:
8551: if ($priv eq 'bre'
8552: && $thisallowed ne 'F'
8553: && $thisallowed ne '2'
8554: && &is_portfolio_url($uri)) {
8555: $thisallowed = &portfolio_access($uri,$clientip);
8556: }
8557:
8558: # Full access at system, domain or course-wide level? Exit.
8559: if ($thisallowed=~/F/) {
8560: return 'F';
8561: }
8562:
8563: # If this is generating or modifying users, exit with special codes
8564:
8565: if (':csu:cdc:ccc:cin:cta:cep:ccr:cst:cad:cli:cau:cdg:cca:caa:'=~/\:\Q$priv\E\:/) {
8566: if (($priv eq 'cca') || ($priv eq 'caa')) {
8567: my ($audom,$auname)=split('/',$uri);
8568: # no author name given, so this just checks on the general right to make a co-author in this domain
8569: unless ($auname) { return $thisallowed; }
8570: # an author name is given, so we are about to actually make a co-author for a certain account
8571: if (($auname ne $env{'user.name'} && $env{'request.role'} !~ /^dc\./) ||
8572: (($audom ne $env{'user.domain'} && $env{'request.role'} !~ /^dc\./) &&
8573: ($audom ne $env{'request.role.domain'}))) { return ''; }
8574: }
8575: return $thisallowed;
8576: }
8577: #
8578: # Gathered so far: system, domain and course wide privileges
8579: #
8580: # Course: See if uri or referer is an individual resource that is part of
8581: # the course
8582:
8583: if ($env{'request.course.id'}) {
8584:
8585: # If this is modifying password (internal auth) domains must match for user and user's role.
8586:
8587: if ($priv eq 'mip') {
8588: if ($env{'user.domain'} eq $env{'request.role.domain'}) {
8589: return $thisallowed;
8590: } else {
8591: return '';
8592: }
8593: }
8594:
8595: $courseprivid=$env{'request.course.id'};
8596: if ($env{'request.course.sec'}) {
8597: $courseprivid.='/'.$env{'request.course.sec'};
8598: }
8599: $courseprivid=~s/\_/\//;
8600: my $checkreferer=1;
8601: my ($match,$cond)=&is_on_map($uri);
8602: if ($match) {
8603: $statecond=$cond;
8604: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid}
8605: =~/\Q$priv\E\&([^\:]*)/) {
8606: my $value = $1;
8607: if ($priv eq 'bre') {
8608: my $deeplinkblock;
8609: unless ($nodeeplinkcheck) {
8610: $deeplinkblock = &deeplink_check($priv,$symb,$uri);
8611: }
8612: if ($deeplinkblock) {
8613: $thisallowed = 'D';
8614: } elsif ($noblockcheck) {
8615: $thisallowed.=$value;
8616: } else {
8617: my @blockers = &has_comm_blocking($priv,$symb,$uri,$ignorecache);
8618: if (@blockers > 0) {
8619: $thisallowed = 'B';
8620: } else {
8621: $thisallowed.=$value;
8622: }
8623: }
8624: } else {
8625: $thisallowed.=$value;
8626: }
8627: $checkreferer=0;
8628: }
8629: }
8630:
8631: if ($checkreferer) {
8632: my $refuri=$env{'httpref.'.$orguri};
8633: unless ($refuri) {
8634: foreach my $key (keys(%env)) {
8635: if ($key=~/^httpref\..*\*/) {
8636: my $pattern=$key;
8637: $pattern=~s/^httpref\.\/res\///;
8638: $pattern=~s/\*/\[\^\/\]\+/g;
8639: $pattern=~s/\//\\\//g;
8640: if ($orguri=~/$pattern/) {
8641: $refuri=$env{$key};
8642: }
8643: }
8644: }
8645: }
8646:
8647: if ($refuri) {
8648: $refuri=&declutter($refuri);
8649: my ($match,$cond)=&is_on_map($refuri);
8650: if ($match) {
8651: my $refstatecond=$cond;
8652: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid}
8653: =~/\Q$priv\E\&([^\:]*)/) {
8654: my $value = $1;
8655: if ($priv eq 'bre') {
8656: my $deeplinkblock;
8657: unless ($nodeeplinkcheck) {
8658: $deeplinkblock = &deeplink_check($priv,$symb,$refuri);
8659: }
8660: if ($deeplinkblock) {
8661: $thisallowed = 'D';
8662: } elsif ($noblockcheck) {
8663: $thisallowed.=$value;
8664: } else {
8665: my @blockers = &has_comm_blocking($priv,'',$refuri,'',1);
8666: if (@blockers > 0) {
8667: $thisallowed = 'B';
8668: } else {
8669: $thisallowed.=$value;
8670: }
8671: }
8672: } else {
8673: $thisallowed.=$value;
8674: }
8675: $uri=$refuri;
8676: $statecond=$refstatecond;
8677: }
8678: }
8679: }
8680: }
8681: }
8682:
8683: #
8684: # Gathered now: all privileges that could apply, and condition number
8685: #
8686: #
8687: # Full or no access?
8688: #
8689:
8690: if ($thisallowed=~/F/) {
8691: return 'F';
8692: }
8693:
8694: unless ($thisallowed) {
8695: return '';
8696: }
8697:
8698: # Restrictions exist, deal with them
8699: #
8700: # C:according to course preferences
8701: # R:according to resource settings
8702: # L:unless locked
8703: # X:according to user session state
8704: #
8705:
8706: # Possibly locked functionality, check all courses
8707: # In roles.tab, L (unless locked) available for bre, pch, plc, pac and sma.
8708: # Locks might take effect only after 10 minutes cache expiration for other
8709: # courses, and 2 minutes for current course, in which user has st or ta role
8710: # which is neither expired nor a future role (unless current course).
8711:
8712: my ($needlockcheck,$now,$crsonly);
8713: if ($thisallowed=~/L/) {
8714: $now = time;
8715: if ($priv eq 'bre') {
8716: if ($uri ne '') {
8717: if ($orguri =~ m{^/+res/}) {
8718: if ($uri =~ m{^lib/templates/}) {
8719: if ($env{'request.course.id'}) {
8720: $crsonly = 1;
8721: $needlockcheck = 1;
8722: }
8723: } else {
8724: $needlockcheck = 1;
8725: }
8726: } elsif ($env{'request.course.id'}) {
8727: my ($crsdom,$crsnum) = split('_',$env{'request.course.id'});
8728: if (($uri =~ m{^(adm|uploaded|public)/$crsdom/$crsnum/}) ||
8729: ($uri =~ m{^adm/$match_domain/$match_username/\d+/(smppg|bulletinboard)$})) {
8730: $crsonly = 1;
8731: }
8732: $needlockcheck = 1;
8733: }
8734: }
8735: } elsif (($priv eq 'pch') || ($priv eq 'plc') || ($priv eq 'pac') || ($priv eq 'sma')) {
8736: $needlockcheck = 1;
8737: }
8738: }
8739: if ($needlockcheck) {
8740: foreach my $envkey (keys(%env)) {
8741: if ($envkey=~/^user\.role\.(st|ta)\.([^\.]*)/) {
8742: my $courseid=$2;
8743: my $roleid=$1.'.'.$2;
8744: $courseid=~s/^\///;
8745: unless ($env{'request.role'} eq $roleid) {
8746: my ($start,$end) = split(/\./,$env{$envkey});
8747: next unless (($now >= $start) && (!$end || $end > $now));
8748: }
8749: my $expiretime=600;
8750: if ($env{'request.role'} eq $roleid) {
8751: $expiretime=120;
8752: }
8753: my ($cdom,$cnum,$csec)=split(/\//,$courseid);
8754: my $prefix='course.'.$cdom.'_'.$cnum.'.';
8755: if ((time-$env{$prefix.'last_cache'})>$expiretime) {
8756: &coursedescription($courseid,{'freshen_cache' => 1});
8757: }
8758: if (($env{$prefix.'res.'.$uri.'.lock.sections'}=~/\,\Q$csec\E\,/)
8759: || ($env{$prefix.'res.'.$uri.'.lock.sections'} eq 'all')) {
8760: if ($env{$prefix.'res.'.$uri.'.lock.expire'}>time) {
8761: &log($env{'user.domain'},$env{'user.name'},
8762: $env{'user.home'},
8763: 'Locked by res: '.$priv.' for '.$uri.' due to '.
8764: $cdom.'/'.$cnum.'/'.$csec.' expire '.
8765: $env{$prefix.'priv.'.$priv.'.lock.expire'});
8766: return '';
8767: }
8768: }
8769: if (($env{$prefix.'priv.'.$priv.'.lock.sections'}=~/\,\Q$csec\E\,/)
8770: || ($env{$prefix.'priv.'.$priv.'.lock.sections'} eq 'all')) {
8771: if ($env{$prefix.'priv.'.$priv.'.lock.expire'}>time) {
8772: &log($env{'user.domain'},$env{'user.name'},
8773: $env{'user.home'},
8774: 'Locked by priv: '.$priv.' for '.$uri.' due to '.
8775: $cdom.'/'.$cnum.'/'.$csec.' expire '.
8776: $env{$prefix.'priv.'.$priv.'.lock.expire'});
8777: return '';
8778: }
8779: }
8780: }
8781: }
8782: }
8783:
8784: #
8785: # Rest of the restrictions depend on selected course
8786: #
8787:
8788: unless ($env{'request.course.id'}) {
8789: if ($thisallowed eq 'A') {
8790: return 'A';
8791: } elsif ($thisallowed eq 'B') {
8792: return 'B';
8793: } else {
8794: return '1';
8795: }
8796: }
8797:
8798: #
8799: # Now user is definitely in a course
8800: #
8801:
8802:
8803: # Course preferences
8804:
8805: if ($thisallowed=~/C/) {
8806: my $rolecode=(split(/\./,$env{'request.role'}))[0];
8807: my $unamedom=$env{'user.name'}.':'.$env{'user.domain'};
8808: if ($env{'course.'.$env{'request.course.id'}.'.'.$priv.'.roles.denied'}
8809: =~/\Q$rolecode\E/) {
8810: if (($priv ne 'pch') && ($priv ne 'plc') && ($priv ne 'pac')) {
8811: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.':'.
8812: 'Denied by role: '.$priv.' for '.$uri.' as '.$rolecode.' in '.
8813: $env{'request.course.id'});
8814: }
8815: return '';
8816: }
8817:
8818: if ($env{'course.'.$env{'request.course.id'}.'.'.$priv.'.users.denied'}
8819: =~/\Q$unamedom\E/) {
8820: if (($priv ne 'pch') && ($priv ne 'plc') && ($priv ne 'pac')) {
8821: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.
8822: 'Denied by user: '.$priv.' for '.$uri.' as '.$unamedom.' in '.
8823: $env{'request.course.id'});
8824: }
8825: return '';
8826: }
8827: }
8828:
8829: # Resource preferences
8830:
8831: if ($thisallowed=~/R/) {
8832: my $rolecode=(split(/\./,$env{'request.role'}))[0];
8833: if (&metadata($uri,'roledeny')=~/\Q$rolecode\E/) {
8834: if (($priv ne 'pch') && ($priv ne 'plc')) {
8835: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.':'.
8836: 'Denied by role: '.$priv.' for '.$uri.' as '.$rolecode);
8837: }
8838: return '';
8839: }
8840: }
8841:
8842: # Restricted for deeplinked session?
8843:
8844: if ($env{'request.deeplink.login'}) {
8845: if ($env{'acc.deeplinkout'} && !$nodeeplinkout) {
8846: if (!$symb) { $symb=&symbread($uri,1); }
8847: if (($symb) && ($env{'acc.deeplinkout'}=~/\&\Q$symb\E\&/)) {
8848: return '';
8849: }
8850: }
8851: }
8852:
8853: # Restricted by state or randomout?
8854:
8855: if ($thisallowed=~/X/) {
8856: if ($env{'acc.randomout'}) {
8857: if (!$symb) { $symb=&symbread($uri,1); }
8858: if (($symb) && ($env{'acc.randomout'}=~/\&\Q$symb\E\&/)) {
8859: return '';
8860: }
8861: }
8862: if (&condval($statecond)) {
8863: return '2';
8864: } else {
8865: return '';
8866: }
8867: }
8868:
8869: if ($thisallowed eq 'A') {
8870: return 'A';
8871: } elsif ($thisallowed eq 'B') {
8872: return 'B';
8873: } elsif ($thisallowed eq 'D') {
8874: return 'D';
8875: }
8876: return 'F';
8877: }
8878:
8879: # ------------------------------------------- Check construction space access
8880:
8881: sub constructaccess {
8882: my ($url,$setpriv)=@_;
8883:
8884: # We do not allow editing of previous versions of files
8885: if ($url=~/\.(\d+)\.(\w+)$/) { return ''; }
8886:
8887: # Get username and domain from URL
8888: my ($ownername,$ownerdomain,$ownerhome);
8889:
8890: ($ownerdomain,$ownername) =
8891: ($url=~ m{^(?:\Q$perlvar{'lonDocRoot'}\E|)(?:/daxepage|/daxeopen)?/priv/($match_domain)/($match_username)(?:/|$)});
8892:
8893: # The URL does not really point to any authorspace, forget it
8894: unless (($ownername) && ($ownerdomain)) { return ''; }
8895:
8896: # Now we need to see if the user has access to the authorspace of
8897: # $ownername at $ownerdomain
8898:
8899: if (($ownername eq $env{'user.name'}) && ($ownerdomain eq $env{'user.domain'})) {
8900: # Real author for this?
8901: $ownerhome = $env{'user.home'};
8902: if (exists($env{'user.priv.au./'.$ownerdomain.'/./'})) {
8903: return ($ownername,$ownerdomain,$ownerhome);
8904: }
8905: } else {
8906: # Co-author for this?
8907: if (exists($env{'user.priv.ca./'.$ownerdomain.'/'.$ownername.'./'}) ||
8908: exists($env{'user.priv.aa./'.$ownerdomain.'/'.$ownername.'./'}) ) {
8909: $ownerhome = &homeserver($ownername,$ownerdomain);
8910: return ($ownername,$ownerdomain,$ownerhome);
8911: }
8912: if ($env{'request.course.id'}) {
8913: if (($ownername eq $env{'course.'.$env{'request.course.id'}.'.num'}) &&
8914: ($ownerdomain eq $env{'course.'.$env{'request.course.id'}.'.domain'})) {
8915: if (&allowed('mdc',$env{'request.course.id'})) {
8916: $ownerhome = $env{'course.'.$env{'request.course.id'}.'.home'};
8917: return ($ownername,$ownerdomain,$ownerhome);
8918: }
8919: }
8920: }
8921: }
8922:
8923: # We don't have any access right now. If we are not possibly going to do anything about this,
8924: # we might as well leave
8925: unless ($setpriv) { return ''; }
8926:
8927: # Backdoor access?
8928: my $allowed=&allowed('eco',$ownerdomain);
8929: # Nope
8930: unless ($allowed) { return ''; }
8931: # Looks like we may have access, but could be locked by the owner of the construction space
8932: if ($allowed eq 'U') {
8933: my %blocked=&get('environment',['domcoord.author'],
8934: $ownerdomain,$ownername);
8935: # Is blocked by owner
8936: if ($blocked{'domcoord.author'} eq 'blocked') { return ''; }
8937: }
8938: if (($allowed eq 'F') || ($allowed eq 'U')) {
8939: # Grant temporary access
8940: my $then=$env{'user.login.time'};
8941: my $update=$env{'user.update.time'};
8942: if (!$update) { $update = $then; }
8943: my $refresh=$env{'user.refresh.time'};
8944: if (!$refresh) { $refresh = $update; }
8945: my $now = time;
8946: &check_adhoc_privs($ownerdomain,$ownername,$update,$refresh,
8947: $now,'ca','constructaccess');
8948: $ownerhome = &homeserver($ownername,$ownerdomain);
8949: return($ownername,$ownerdomain,$ownerhome);
8950: }
8951: # No business here
8952: return '';
8953: }
8954:
8955: # ----------------------------------------------------------- Content Blocking
8956:
8957: {
8958: # Caches for faster Course Contents display where content blocking
8959: # is in operation (i.e., interval param set) for timed quiz.
8960: #
8961: # User for whom data are being temporarily cached.
8962: my $cacheduser='';
8963: # Course for which data are being temporarily cached.
8964: my $cachedcid='';
8965: # Cached blockers for this user (a hash of blocking items).
8966: my %cachedblockers=();
8967: # When the data were last cached.
8968: my $cachedlast='';
8969:
8970: sub load_all_blockers {
8971: my ($uname,$udom)=@_;
8972: if (($uname ne '') && ($udom ne '')) {
8973: if (($cacheduser eq $uname.':'.$udom) &&
8974: ($cachedcid eq $env{'request.course.id'}) &&
8975: (abs($cachedlast-time)<5)) {
8976: return;
8977: }
8978: }
8979: $cachedlast=time;
8980: $cacheduser=$uname.':'.$udom;
8981: $cachedcid=$env{'request.course.id'};
8982: %cachedblockers = &get_commblock_resources();
8983: return;
8984: }
8985:
8986: sub get_comm_blocks {
8987: my ($cdom,$cnum) = @_;
8988: if ($cdom eq '' || $cnum eq '') {
8989: return unless ($env{'request.course.id'});
8990: $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
8991: $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
8992: }
8993: my %commblocks;
8994: my $hashid=$cdom.'_'.$cnum;
8995: my ($blocksref,$cached)=&is_cached_new('comm_block',$hashid);
8996: if ((defined($cached)) && (ref($blocksref) eq 'HASH')) {
8997: %commblocks = %{$blocksref};
8998: } else {
8999: %commblocks = &Apache::lonnet::dump('comm_block',$cdom,$cnum);
9000: my $cachetime = 600;
9001: &do_cache_new('comm_block',$hashid,\%commblocks,$cachetime);
9002: }
9003: return %commblocks;
9004: }
9005:
9006: sub get_commblock_resources {
9007: my ($blocks) = @_;
9008: my %blockers = ();
9009: return %blockers unless ($env{'request.course.id'});
9010: my $courseurl = &courseid_to_courseurl($env{'request.course.id'});
9011: if ($env{'request.course.sec'}) {
9012: $courseurl .= '/'.$env{'request.course.sec'};
9013: }
9014: return %blockers if ($env{'user.priv.'.$env{'request.role'}.'.'.$courseurl} =~/evb\&([^\:]*)/);
9015: my %commblocks;
9016: if (ref($blocks) eq 'HASH') {
9017: %commblocks = %{$blocks};
9018: } else {
9019: %commblocks = &get_comm_blocks();
9020: }
9021: return %blockers unless (keys(%commblocks) > 0);
9022: my $navmap = Apache::lonnavmaps::navmap->new();
9023: return %blockers unless (ref($navmap));
9024: my $now = time;
9025: foreach my $block (keys(%commblocks)) {
9026: if ($block =~ /^(\d+)____(\d+)$/) {
9027: my ($start,$end) = ($1,$2);
9028: if ($start <= $now && $end >= $now) {
9029: if (ref($commblocks{$block}{'blocks'}) eq 'HASH') {
9030: if (ref($commblocks{$block}{'blocks'}{'docs'}) eq 'HASH') {
9031: if (ref($commblocks{$block}{'blocks'}{'docs'}{'maps'}) eq 'HASH') {
9032: if (keys(%{$commblocks{$block}{'blocks'}{'docs'}{'maps'}})) {
9033: $blockers{$block}{maps} = $commblocks{$block}{'blocks'}{'docs'}{'maps'};
9034: }
9035: }
9036: if (ref($commblocks{$block}{'blocks'}{'docs'}{'resources'}) eq 'HASH') {
9037: if (keys(%{$commblocks{$block}{'blocks'}{'docs'}{'resources'}})) {
9038: $blockers{$block}{'resources'} = $commblocks{$block}{'blocks'}{'docs'}{'resources'};
9039: }
9040: }
9041: }
9042: }
9043: }
9044: } elsif ($block =~ /^firstaccess____(.+)$/) {
9045: my $item = $1;
9046: if (ref($commblocks{$block}{'blocks'}) eq 'HASH') {
9047: if (ref($commblocks{$block}{'blocks'}{'docs'}) eq 'HASH') {
9048: my (@interval,$mapname);
9049: my $type = 'map';
9050: if ($item eq 'course') {
9051: $type = 'course';
9052: @interval=&EXT("resource.0.interval");
9053: } else {
9054: if ($item =~ /___\d+___/) {
9055: $type = 'resource';
9056: @interval=&EXT("resource.0.interval",$item);
9057: } else {
9058: $mapname = &deversion($item);
9059: if (ref($navmap)) {
9060: my $timelimit = $navmap->get_mapparam(undef,$mapname,'0.interval');
9061: @interval = ($timelimit,'map');
9062: }
9063: }
9064: }
9065: if ($interval[0] =~ /^(\d+)/) {
9066: my $timelimit = $1;
9067: my $first_access;
9068: if ($type eq 'resource') {
9069: $first_access=&get_first_access($interval[1],$item);
9070: } elsif ($type eq 'map') {
9071: $first_access=&get_first_access($interval[1],undef,$item);
9072: } else {
9073: $first_access=&get_first_access($interval[1]);
9074: }
9075: if ($first_access) {
9076: my $timesup = $first_access+$timelimit;
9077: if ($timesup > $now) {
9078: my $activeblock;
9079: if ($type eq 'resource') {
9080: if (ref($navmap)) {
9081: my $res = $navmap->getBySymb($item);
9082: if ($res->answerable()) {
9083: $activeblock = 1;
9084: }
9085: }
9086: } elsif ($type eq 'map') {
9087: my $mapsymb = &symbread($mapname,1);
9088: if (($mapsymb) && (ref($navmap))) {
9089: my $mapres = $navmap->getBySymb($mapsymb);
9090: if (ref($mapres)) {
9091: my $first = $mapres->map_start();
9092: my $finish = $mapres->map_finish();
9093: my $it = $navmap->getIterator($first,$finish,undef,0,0);
9094: if (ref($it)) {
9095: my $res;
9096: while ($res = $it->next(undef,1)) {
9097: next unless (ref($res));
9098: my $symb = $res->symb();
9099: next if (($symb eq $mapsymb) || ($symb eq ''));
9100: @interval=&EXT("resource.0.interval",$symb);
9101: if ($interval[1] eq 'map') {
9102: if ($res->answerable()) {
9103: $activeblock = 1;
9104: last;
9105: }
9106: }
9107: }
9108: }
9109: }
9110: }
9111: }
9112: if ($activeblock) {
9113: if (ref($commblocks{$block}{'blocks'}{'docs'}{'maps'}) eq 'HASH') {
9114: if (keys(%{$commblocks{$block}{'blocks'}{'docs'}{'maps'}})) {
9115: $blockers{$block}{'maps'} = $commblocks{$block}{'blocks'}{'docs'}{'maps'};
9116: }
9117: }
9118: if (ref($commblocks{$block}{'blocks'}{'docs'}{'resources'}) eq 'HASH') {
9119: if (keys(%{$commblocks{$block}{'blocks'}{'docs'}{'resources'}})) {
9120: $blockers{$block}{'resources'} = $commblocks{$block}{'blocks'}{'docs'}{'resources'};
9121: }
9122: }
9123: }
9124: }
9125: }
9126: }
9127: }
9128: }
9129: }
9130: }
9131: return %blockers;
9132: }
9133:
9134: sub has_comm_blocking {
9135: my ($priv,$symb,$uri,$ignoresymbdb,$noenccheck,$blocked,$blocks) = @_;
9136: my @blockers;
9137: return unless ($env{'request.course.id'});
9138: return unless ($priv eq 'bre');
9139: return if ($env{'request.state'} eq 'construct');
9140: my $courseurl = &courseid_to_courseurl($env{'request.course.id'});
9141: if ($env{'request.course.sec'}) {
9142: $courseurl .= '/'.$env{'request.course.sec'};
9143: }
9144: return if ($env{'user.priv.'.$env{'request.role'}.'.'.$courseurl} =~/evb\&([^\:]*)/);
9145: my %blockinfo;
9146: if (ref($blocks) eq 'HASH') {
9147: %blockinfo = &get_commblock_resources($blocks);
9148: } else {
9149: &load_all_blockers($env{'user.name'},$env{'user.domain'});
9150: %blockinfo = %cachedblockers;
9151: }
9152: return unless (keys(%blockinfo) > 0);
9153: my (%possibles,@symbs);
9154: if (!$symb) {
9155: $symb = &symbread($uri,1,1,1,\%possibles,$ignoresymbdb,$noenccheck);
9156: }
9157: if ($symb) {
9158: @symbs = ($symb);
9159: } elsif (keys(%possibles)) {
9160: @symbs = keys(%possibles);
9161: }
9162: my $noblock;
9163: foreach my $symb (@symbs) {
9164: last if ($noblock);
9165: my ($map,$resid,$resurl)=&decode_symb($symb);
9166: foreach my $block (keys(%blockinfo)) {
9167: if ($block =~ /^firstaccess____(.+)$/) {
9168: my $item = $1;
9169: unless ($blocked) {
9170: if (($item eq $map) || ($item eq $symb)) {
9171: $noblock = 1;
9172: last;
9173: }
9174: }
9175: }
9176: if (ref($blockinfo{$block}) eq 'HASH') {
9177: if (ref($blockinfo{$block}{'resources'}) eq 'HASH') {
9178: if ($blockinfo{$block}{'resources'}{$symb}) {
9179: unless (grep(/^\Q$block\E$/,@blockers)) {
9180: push(@blockers,$block);
9181: }
9182: }
9183: }
9184: if (ref($blockinfo{$block}{'maps'}) eq 'HASH') {
9185: if ($blockinfo{$block}{'maps'}{$map}) {
9186: unless (grep(/^\Q$block\E$/,@blockers)) {
9187: push(@blockers,$block);
9188: }
9189: }
9190: }
9191: }
9192: }
9193: }
9194: unless ($noblock) {
9195: return @blockers;
9196: }
9197: return;
9198: }
9199: }
9200:
9201: sub deeplink_check {
9202: my ($priv,$symb,$uri) = @_;
9203: return unless ($env{'request.course.id'});
9204: return unless ($priv eq 'bre');
9205: return if ($env{'request.state'} eq 'construct');
9206: return if ($env{'request.role.adv'});
9207: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
9208: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
9209: my (%possibles,@symbs);
9210: if (!$symb) {
9211: $symb = &symbread($uri,1,1,1,\%possibles);
9212: }
9213: if ($symb) {
9214: @symbs = ($symb);
9215: } elsif (keys(%possibles)) {
9216: @symbs = keys(%possibles);
9217: }
9218:
9219: my ($deeplink_symb,$allow);
9220: if ($env{'request.deeplink.login'}) {
9221: $deeplink_symb = &Apache::loncommon::deeplink_login_symb($cnum,$cdom);
9222: }
9223: foreach my $symb (@symbs) {
9224: last if ($allow);
9225: my $deeplink = &EXT("resource.0.deeplink",$symb);
9226: if ($deeplink eq '') {
9227: $allow = 1;
9228: } else {
9229: my ($state,$others,$listed,$scope,$protect) = split(/,/,$deeplink);
9230: if ($state ne 'only') {
9231: $allow = 1;
9232: } else {
9233: my $check_deeplink_entry;
9234: if ($protect ne 'none') {
9235: my ($acctype,$item) = split(/:/,$protect);
9236: if (($acctype eq 'ltic') && ($env{'user.linkprotector'})) {
9237: if (grep(/^\Q$item\Ec$/,split(/,/,$env{'user.linkprotector'}))) {
9238: $check_deeplink_entry = 1
9239: }
9240: } elsif (($acctype eq 'ltid') && ($env{'user.linkprotector'})) {
9241: if (grep(/^\Q$item\Ed$/,split(/,/,$env{'user.linkprotector'}))) {
9242: $check_deeplink_entry = 1;
9243: }
9244: } elsif (($acctype eq 'key') && ($env{'user.deeplinkkey'})) {
9245: if (grep(/^\Q$item\E$/,split(/,/,$env{'user.deeplinkkey'}))) {
9246: $check_deeplink_entry = 1;
9247: }
9248: }
9249: }
9250: if (($protect eq 'none') || ($check_deeplink_entry)) {
9251: if ($scope eq 'res') {
9252: if ($symb eq $deeplink_symb) {
9253: $allow = 1;
9254: }
9255: } elsif (($scope eq 'map') || ($scope eq 'rec')) {
9256: my ($map_from_symb,$map_from_login);
9257: $map_from_symb = &deversion((&decode_symb($symb))[0]);
9258: if ($deeplink_symb =~ /\.(page|sequence)$/) {
9259: $map_from_login = &deversion((&decode_symb($deeplink_symb))[2]);
9260: } else {
9261: $map_from_login = &deversion((&decode_symb($deeplink_symb))[0]);
9262: }
9263: if (($map_from_symb) && ($map_from_login)) {
9264: if ($map_from_symb eq $map_from_login) {
9265: $allow = 1;
9266: } elsif ($scope eq 'rec') {
9267: my @recurseup = &get_map_hierarchy($map_from_symb,$env{'request.course.id'});
9268: if (grep(/^\Q$map_from_login\E$/,@recurseup)) {
9269: $allow = 1;
9270: }
9271: }
9272: }
9273: }
9274: }
9275: }
9276: }
9277: }
9278: return if ($allow);
9279: return 1;
9280: }
9281:
9282: # -------------------------------- Deversion and split uri into path an filename
9283:
9284: #
9285: # Removes the version from a URI and
9286: # splits it in to its filename and path to the filename.
9287: # Seems like File::Basename could have done this more clearly.
9288: # Parameters:
9289: # $uri - input URI
9290: # Returns:
9291: # Two element list consisting of
9292: # $pathname - the URI up to and excluding the trailing /
9293: # $filename - The part of the URI following the last /
9294: # NOTE:
9295: # Another realization of this is simply:
9296: # use File::Basename;
9297: # ...
9298: # $uri = shift;
9299: # $filename = basename($uri);
9300: # $path = dirname($uri);
9301: # return ($filename, $path);
9302: #
9303: # The implementation below is probably faster however.
9304: #
9305: sub split_uri_for_cond {
9306: my $uri=&deversion(&declutter(shift));
9307: my @uriparts=split(/\//,$uri);
9308: my $filename=pop(@uriparts);
9309: my $pathname=join('/',@uriparts);
9310: return ($pathname,$filename);
9311: }
9312: # --------------------------------------------------- Is a resource on the map?
9313:
9314: sub is_on_map {
9315: my ($pathname,$filename) = &split_uri_for_cond(shift);
9316: #Trying to find the conditional for the file
9317: my $match=($env{'acc.res.'.$env{'request.course.id'}.'.'.$pathname}=~
9318: /\&\Q$filename\E\:([\d\|]+)\&/);
9319: if ($match) {
9320: return (1,$1);
9321: } else {
9322: return (0,0);
9323: }
9324: }
9325:
9326: # --------------------------------------------------------- Get symb from alias
9327:
9328: sub get_symb_from_alias {
9329: my $symb=shift;
9330: my ($map,$resid,$url)=&decode_symb($symb);
9331: # Already is a symb
9332: if ($url) { return $symb; }
9333: # Must be an alias
9334: my $aliassymb='';
9335: my %bighash;
9336: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
9337: &GDBM_READER(),0640)) {
9338: my $rid=$bighash{'mapalias_'.$symb};
9339: if ($rid) {
9340: my ($mapid,$resid)=split(/\./,$rid);
9341: $aliassymb=&encode_symb($bighash{'map_id_'.$mapid},
9342: $resid,$bighash{'src_'.$rid});
9343: }
9344: untie %bighash;
9345: }
9346: return $aliassymb;
9347: }
9348:
9349: # ----------------------------------------------------------------- Define Role
9350:
9351: sub definerole {
9352: if (allowed('mcr','/')) {
9353: my ($rolename,$sysrole,$domrole,$courole,$uname,$udom)=@_;
9354: foreach my $role (split(':',$sysrole)) {
9355: my ($crole,$cqual)=split(/\&/,$role);
9356: if ($pr{'cr:s'}!~/\Q$crole\E/) { return "refused:s:$crole"; }
9357: if ($pr{'cr:s'}=~/\Q$crole\E\&/) {
9358: if ($pr{'cr:s'}!~/\Q$crole\E\&\w*\Q$cqual\E/) {
9359: return "refused:s:$crole&$cqual";
9360: }
9361: }
9362: }
9363: foreach my $role (split(':',$domrole)) {
9364: my ($crole,$cqual)=split(/\&/,$role);
9365: if ($pr{'cr:d'}!~/\Q$crole\E/) { return "refused:d:$crole"; }
9366: if ($pr{'cr:d'}=~/\Q$crole\E\&/) {
9367: if ($pr{'cr:d'}!~/\Q$crole\W\&\w*\Q$cqual\E/) {
9368: return "refused:d:$crole&$cqual";
9369: }
9370: }
9371: }
9372: foreach my $role (split(':',$courole)) {
9373: my ($crole,$cqual)=split(/\&/,$role);
9374: if ($pr{'cr:c'}!~/\Q$crole\E/) { return "refused:c:$crole"; }
9375: if ($pr{'cr:c'}=~/\Q$crole\E\&/) {
9376: if ($pr{'cr:c'}!~/\Q$crole\E\&\w*\Q$cqual\E/) {
9377: return "refused:c:$crole&$cqual";
9378: }
9379: }
9380: }
9381: my $uhome;
9382: if (($uname ne '') && ($udom ne '')) {
9383: $uhome = &homeserver($uname,$udom);
9384: return $uhome if ($uhome eq 'no_host');
9385: } else {
9386: $uname = $env{'user.name'};
9387: $udom = $env{'user.domain'};
9388: $uhome = $env{'user.home'};
9389: }
9390: my $command="encrypt:rolesput:$env{'user.domain'}:$env{'user.name'}:".
9391: "$udom:$uname:rolesdef_$rolename=".
9392: escape($sysrole.'_'.$domrole.'_'.$courole);
9393: return reply($command,$uhome);
9394: } else {
9395: return 'refused';
9396: }
9397: }
9398:
9399: # ---------------- Make a metadata query against the network of library servers
9400:
9401: sub metadata_query {
9402: my ($query,$custom,$customshow,$server_array,$domains_hash)=@_;
9403: my %rhash;
9404: my %libserv = &all_library();
9405: my @server_list = (defined($server_array) ? @$server_array
9406: : keys(%libserv) );
9407: for my $server (@server_list) {
9408: my $domains = '';
9409: if (ref($domains_hash) eq 'HASH') {
9410: $domains = $domains_hash->{$server};
9411: }
9412: unless ($custom or $customshow) {
9413: my $reply=&reply("querysend:".&escape($query).':::'.&escape($domains),$server);
9414: $rhash{$server}=$reply;
9415: }
9416: else {
9417: my $reply=&reply("querysend:".&escape($query).':'.
9418: &escape($custom).':'.&escape($customshow).':'.&escape($domains),
9419: $server);
9420: $rhash{$server}=$reply;
9421: }
9422: }
9423: return \%rhash;
9424: }
9425:
9426: # ----------------------------------------- Send log queries and wait for reply
9427:
9428: sub log_query {
9429: my ($uname,$udom,$query,%filters)=@_;
9430: my $uhome=&homeserver($uname,$udom);
9431: if ($uhome eq 'no_host') { return 'error: no_host'; }
9432: my $uhost=&hostname($uhome);
9433: my $command=&escape(join(':',map{$_.'='.$filters{$_}} keys(%filters)));
9434: my $queryid=&reply("querysend:".$query.':'.$udom.':'.$uname.':'.$command,
9435: $uhome);
9436: unless ($queryid=~/^\Q$uhost\E\_/) { return 'error: '.$queryid; }
9437: return get_query_reply($queryid);
9438: }
9439:
9440: # -------------------------- Update MySQL table for portfolio file
9441:
9442: sub update_portfolio_table {
9443: my ($uname,$udom,$file_name,$query,$group,$action) = @_;
9444: if ($group ne '') {
9445: $file_name =~s /^\Q$group\E//;
9446: }
9447: my $homeserver = &homeserver($uname,$udom);
9448: my $queryid=
9449: &reply("querysend:".$query.':'.&escape($uname.':'.$udom.':'.$group).
9450: ':'.&escape($file_name).':'.$action,$homeserver);
9451: my $reply = &get_query_reply($queryid);
9452: return $reply;
9453: }
9454:
9455: # -------------------------- Update MySQL allusers table
9456:
9457: sub update_allusers_table {
9458: my ($uname,$udom,$names) = @_;
9459: my $homeserver = &homeserver($uname,$udom);
9460: my $queryid=
9461: &reply('querysend:allusers:'.&escape($uname).':'.&escape($udom).':'.
9462: 'lastname='.&escape($names->{'lastname'}).'%%'.
9463: 'firstname='.&escape($names->{'firstname'}).'%%'.
9464: 'middlename='.&escape($names->{'middlename'}).'%%'.
9465: 'generation='.&escape($names->{'generation'}).'%%'.
9466: 'permanentemail='.&escape($names->{'permanentemail'}).'%%'.
9467: 'id='.&escape($names->{'id'}),$homeserver);
9468: return;
9469: }
9470:
9471: # ------- Request retrieval of institutional classlists for course(s)
9472:
9473: sub fetch_enrollment_query {
9474: my ($context,$affiliatesref,$replyref,$dom,$cnum) = @_;
9475: my ($homeserver,$sleep,$loopmax);
9476: my $maxtries = 1;
9477: if ($context eq 'automated') {
9478: $homeserver = $perlvar{'lonHostID'};
9479: $sleep = 2;
9480: $loopmax = 100;
9481: $maxtries = 10; # will wait for up to 2000s for retrieval of classlist data before timeout
9482: } else {
9483: $homeserver = &homeserver($cnum,$dom);
9484: }
9485: my $host=&hostname($homeserver);
9486: my $cmd = '';
9487: foreach my $affiliate (keys(%{$affiliatesref})) {
9488: $cmd .= $affiliate.'='.join(",",@{$$affiliatesref{$affiliate}}).'%%';
9489: }
9490: $cmd =~ s/%%$//;
9491: $cmd = &escape($cmd);
9492: my $query = 'fetchenrollment';
9493: my $queryid=&reply("querysend:".$query.':'.$dom.':'.$env{'user.name'}.':'.$cmd,$homeserver);
9494: unless ($queryid=~/^\Q$host\E\_/) {
9495: &logthis('fetch_enrollment_query: invalid queryid: '.$queryid.' for host: '.$host.' and homeserver: '.$homeserver.' context: '.$context.' '.$cnum);
9496: return 'error: '.$queryid;
9497: }
9498: my $reply = &get_query_reply($queryid,$sleep,$loopmax);
9499: my $tries = 1;
9500: while (($reply=~/^timeout/) && ($tries < $maxtries)) {
9501: $reply = &get_query_reply($queryid,$sleep,$loopmax);
9502: $tries ++;
9503: }
9504: if ( ($reply =~/^timeout/) || ($reply =~/^error/) ) {
9505: &logthis('fetch_enrollment_query error: '.$reply.' for '.$dom.' '.$env{'user.name'}.' for '.$queryid.' context: '.$context.' '.$cnum.' maxtries: '.$maxtries.' tries: '.$tries);
9506: } else {
9507: my @responses = split(/:/,$reply);
9508: if (grep { $_ eq $homeserver } ¤t_machine_ids()) {
9509: foreach my $line (@responses) {
9510: my ($key,$value) = split(/=/,$line,2);
9511: $$replyref{$key} = $value;
9512: }
9513: } else {
9514: my $pathname = LONCAPA::tempdir();
9515: foreach my $line (@responses) {
9516: my ($key,$value) = split(/=/,$line);
9517: $$replyref{$key} = $value;
9518: if ($value > 0) {
9519: foreach my $item (@{$$affiliatesref{$key}}) {
9520: my $filename = $dom.'_'.$key.'_'.$item.'_classlist.xml';
9521: my $destname = $pathname.'/'.$filename;
9522: my $xml_classlist = &reply("autoretrieve:".$filename,$homeserver);
9523: if ($xml_classlist =~ /^error/) {
9524: &logthis('fetch_enrollment_query - autoretrieve error: '.$xml_classlist.' for '.$filename.' from server: '.$homeserver.' '.$context.' '.$cnum);
9525: } else {
9526: if ( open(FILE,">",$destname) ) {
9527: print FILE &unescape($xml_classlist);
9528: close(FILE);
9529: } else {
9530: &logthis('fetch_enrollment_query - error opening classlist file '.$destname.' '.$context.' '.$cnum);
9531: }
9532: }
9533: }
9534: }
9535: }
9536: }
9537: return 'ok';
9538: }
9539: return 'error';
9540: }
9541:
9542: sub get_query_reply {
9543: my ($queryid,$sleep,$loopmax) = @_;
9544: if (($sleep eq '') || ($sleep !~ /^\d+\.?\d*$/)) {
9545: $sleep = 0.2;
9546: }
9547: if (($loopmax eq '') || ($loopmax =~ /\D/)) {
9548: $loopmax = 100;
9549: }
9550: my $replyfile=LONCAPA::tempdir().$queryid;
9551: my $reply='';
9552: for (1..$loopmax) {
9553: sleep($sleep);
9554: if (-e $replyfile.'.end') {
9555: if (open(my $fh,"<",$replyfile)) {
9556: $reply = join('',<$fh>);
9557: close($fh);
9558: } else { return 'error: reply_file_error'; }
9559: return &unescape($reply);
9560: }
9561: }
9562: return 'timeout:'.$queryid;
9563: }
9564:
9565: sub courselog_query {
9566: #
9567: # possible filters:
9568: # url: url or symb
9569: # username
9570: # domain
9571: # action: view, submit, grade
9572: # start: timestamp
9573: # end: timestamp
9574: #
9575: my (%filters)=@_;
9576: unless ($env{'request.course.id'}) { return 'no_course'; }
9577: if ($filters{'url'}) {
9578: $filters{'url'}=&symbclean(&declutter($filters{'url'}));
9579: $filters{'url'}=~s/\.(\w+)$/(\\.\\d+)*\\.$1/;
9580: $filters{'url'}=~s/\.(\w+)\_\_\_/(\\.\\d+)*\\.$1/;
9581: }
9582: my $cname=$env{'course.'.$env{'request.course.id'}.'.num'};
9583: my $cdom=$env{'course.'.$env{'request.course.id'}.'.domain'};
9584: return &log_query($cname,$cdom,'courselog',%filters);
9585: }
9586:
9587: sub userlog_query {
9588: #
9589: # possible filters:
9590: # action: log check role
9591: # start: timestamp
9592: # end: timestamp
9593: #
9594: my ($uname,$udom,%filters)=@_;
9595: return &log_query($uname,$udom,'userlog',%filters);
9596: }
9597:
9598: #--------- Call auto-enrollment subs in localenroll.pm for homeserver for course
9599:
9600: sub auto_run {
9601: my ($cnum,$cdom) = @_;
9602: my $response = 0;
9603: my $settings;
9604: my %domconfig = &get_dom('configuration',['autoenroll'],$cdom);
9605: if (ref($domconfig{'autoenroll'}) eq 'HASH') {
9606: $settings = $domconfig{'autoenroll'};
9607: if ($settings->{'run'} eq '1') {
9608: $response = 1;
9609: }
9610: } else {
9611: my $homeserver;
9612: if (&is_course($cdom,$cnum)) {
9613: $homeserver = &homeserver($cnum,$cdom);
9614: } else {
9615: $homeserver = &domain($cdom,'primary');
9616: }
9617: if ($homeserver ne 'no_host') {
9618: $response = &reply('autorun:'.$cdom,$homeserver);
9619: }
9620: }
9621: return $response;
9622: }
9623:
9624: sub auto_get_sections {
9625: my ($cnum,$cdom,$inst_coursecode) = @_;
9626: my $homeserver;
9627: if (($cdom =~ /^$match_domain$/) && ($cnum =~ /^$match_courseid$/)) {
9628: $homeserver = &homeserver($cnum,$cdom);
9629: }
9630: if (!defined($homeserver)) {
9631: if ($cdom =~ /^$match_domain$/) {
9632: $homeserver = &domain($cdom,'primary');
9633: }
9634: }
9635: my @secs;
9636: if (defined($homeserver)) {
9637: my $response=&unescape(&reply('autogetsections:'.$inst_coursecode.':'.$cdom,$homeserver));
9638: unless ($response eq 'refused') {
9639: @secs = split(/:/,$response);
9640: }
9641: }
9642: return @secs;
9643: }
9644:
9645: sub auto_new_course {
9646: my ($cnum,$cdom,$inst_course_id,$owner,$coowners) = @_;
9647: my $homeserver = &homeserver($cnum,$cdom);
9648: my $response=&unescape(&reply('autonewcourse:'.$inst_course_id.':'.&escape($owner).':'.$cdom.':'.&escape($coowners),$homeserver));
9649: return $response;
9650: }
9651:
9652: sub auto_validate_courseID {
9653: my ($cnum,$cdom,$inst_course_id) = @_;
9654: my $homeserver = &homeserver($cnum,$cdom);
9655: my $response=&unescape(&reply('autovalidatecourse:'.$inst_course_id.':'.$cdom,$homeserver));
9656: return $response;
9657: }
9658:
9659: sub auto_validate_instcode {
9660: my ($cnum,$cdom,$instcode,$owner) = @_;
9661: my ($homeserver,$response);
9662: if (($cdom =~ /^$match_domain$/) && ($cnum =~ /^$match_courseid$/)) {
9663: $homeserver = &homeserver($cnum,$cdom);
9664: }
9665: if (!defined($homeserver)) {
9666: if ($cdom =~ /^$match_domain$/) {
9667: $homeserver = &domain($cdom,'primary');
9668: }
9669: }
9670: $response=&unescape(&reply('autovalidateinstcode:'.$cdom.':'.
9671: &escape($instcode).':'.&escape($owner),$homeserver));
9672: my ($outcome,$description,$defaultcredits) = map { &unescape($_); } split('&',$response,3);
9673: return ($outcome,$description,$defaultcredits);
9674: }
9675:
9676: sub auto_validate_inst_crosslist {
9677: my ($cnum,$cdom,$instcode,$inst_xlist,$coowner) = @_;
9678: my ($homeserver,$response);
9679: if (($cdom =~ /^$match_domain$/) && ($cnum =~ /^$match_courseid$/)) {
9680: $homeserver = &homeserver($cnum,$cdom);
9681: }
9682: if (!defined($homeserver)) {
9683: if ($cdom =~ /^$match_domain$/) {
9684: $homeserver = &domain($cdom,'primary');
9685: }
9686: }
9687: unless (($homeserver eq '') || ($homeserver eq 'no_host')) {
9688: $response=&reply('autovalidateinstcrosslist:'.$cdom.':'.
9689: &escape($instcode).':'.&escape($inst_xlist).':'.
9690: &escape($coowner),$homeserver);
9691: }
9692: return $response;
9693: }
9694:
9695: sub auto_create_password {
9696: my ($cnum,$cdom,$authparam,$udom) = @_;
9697: my ($homeserver,$response);
9698: my $create_passwd = 0;
9699: my $authchk = '';
9700: if ($udom =~ /^$match_domain$/) {
9701: $homeserver = &domain($udom,'primary');
9702: }
9703: if ($homeserver eq '') {
9704: if (($cdom =~ /^$match_domain$/) && ($cnum =~ /^$match_courseid$/)) {
9705: $homeserver = &homeserver($cnum,$cdom);
9706: }
9707: }
9708: if ($homeserver eq '') {
9709: $authchk = 'nodomain';
9710: } else {
9711: $response=&unescape(&reply('autocreatepassword:'.$authparam.':'.$cdom,$homeserver));
9712: if ($response eq 'refused') {
9713: $authchk = 'refused';
9714: } else {
9715: ($authparam,$create_passwd,$authchk) = split(/:/,$response);
9716: }
9717: }
9718: return ($authparam,$create_passwd,$authchk);
9719: }
9720:
9721: sub auto_photo_permission {
9722: my ($cnum,$cdom,$students) = @_;
9723: my $homeserver = &homeserver($cnum,$cdom);
9724: my ($outcome,$perm_reqd,$conditions) =
9725: split(/:/,&unescape(&reply('autophotopermission:'.$cdom,$homeserver)),3);
9726: if ($outcome =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
9727: return (undef,undef);
9728: }
9729: return ($outcome,$perm_reqd,$conditions);
9730: }
9731:
9732: sub auto_checkphotos {
9733: my ($uname,$udom,$pid) = @_;
9734: my $homeserver = &homeserver($uname,$udom);
9735: my ($result,$resulttype);
9736: my $outcome = &unescape(&reply('autophotocheck:'.&escape($udom).':'.
9737: &escape($uname).':'.&escape($pid),
9738: $homeserver));
9739: if ($outcome =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
9740: return (undef,undef);
9741: }
9742: if ($outcome) {
9743: ($result,$resulttype) = split(/:/,$outcome);
9744: }
9745: return ($result,$resulttype);
9746: }
9747:
9748: sub auto_photochoice {
9749: my ($cnum,$cdom) = @_;
9750: my $homeserver = &homeserver($cnum,$cdom);
9751: my ($update,$comment) = split(/:/,&unescape(&reply('autophotochoice:'.
9752: &escape($cdom),
9753: $homeserver)));
9754: if ($update =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
9755: return (undef,undef);
9756: }
9757: return ($update,$comment);
9758: }
9759:
9760: sub auto_photoupdate {
9761: my ($affiliatesref,$dom,$cnum,$photo) = @_;
9762: my $homeserver = &homeserver($cnum,$dom);
9763: my $host=&hostname($homeserver);
9764: my $cmd = '';
9765: my $maxtries = 1;
9766: foreach my $affiliate (keys(%{$affiliatesref})) {
9767: $cmd .= $affiliate.'='.join(",",@{$$affiliatesref{$affiliate}}).'%%';
9768: }
9769: $cmd =~ s/%%$//;
9770: $cmd = &escape($cmd);
9771: my $query = 'institutionalphotos';
9772: my $queryid=&reply("querysend:".$query.':'.$dom.':'.$cnum.':'.$cmd,$homeserver);
9773: unless ($queryid=~/^\Q$host\E\_/) {
9774: &logthis('institutionalphotos: invalid queryid: '.$queryid.' for host: '.$host.' and homeserver: '.$homeserver.' and course: '.$cnum);
9775: return 'error: '.$queryid;
9776: }
9777: my $reply = &get_query_reply($queryid);
9778: my $tries = 1;
9779: while (($reply=~/^timeout/) && ($tries < $maxtries)) {
9780: $reply = &get_query_reply($queryid);
9781: $tries ++;
9782: }
9783: if ( ($reply =~/^timeout/) || ($reply =~/^error/) ) {
9784: &logthis('institutionalphotos error: '.$reply.' for '.$dom.' '.$env{'user.name'}.' for '.$queryid.' course: '.$cnum.' maxtries: '.$maxtries.' tries: '.$tries);
9785: } else {
9786: my @responses = split(/:/,$reply);
9787: my $outcome = shift(@responses);
9788: foreach my $item (@responses) {
9789: my ($key,$value) = split(/=/,$item);
9790: $$photo{$key} = $value;
9791: }
9792: return $outcome;
9793: }
9794: return 'error';
9795: }
9796:
9797: sub auto_instcode_format {
9798: my ($caller,$codedom,$instcodes,$codes,$codetitles,$cat_titles,
9799: $cat_order) = @_;
9800: my $courses = '';
9801: my @homeservers;
9802: if ($caller eq 'global') {
9803: my %servers = &get_servers($codedom,'library');
9804: foreach my $tryserver (keys(%servers)) {
9805: if (!grep(/^\Q$tryserver\E$/,@homeservers)) {
9806: push(@homeservers,$tryserver);
9807: }
9808: }
9809: } elsif ($caller eq 'requests') {
9810: if ($codedom =~ /^$match_domain$/) {
9811: my $chome = &domain($codedom,'primary');
9812: unless ($chome eq 'no_host') {
9813: push(@homeservers,$chome);
9814: }
9815: }
9816: } else {
9817: push(@homeservers,&homeserver($caller,$codedom));
9818: }
9819: foreach my $code (keys(%{$instcodes})) {
9820: $courses .= &escape($code).'='.&escape($$instcodes{$code}).'&';
9821: }
9822: chop($courses);
9823: my $ok_response = 0;
9824: my $response;
9825: while (@homeservers > 0 && $ok_response == 0) {
9826: my $server = shift(@homeservers);
9827: $response=&reply('autoinstcodeformat:'.$codedom.':'.$courses,$server);
9828: if ($response !~ /(con_lost|error|no_such_host|refused)/) {
9829: my ($codes_str,$codetitles_str,$cat_titles_str,$cat_order_str) =
9830: split(/:/,$response);
9831: %{$codes} = (%{$codes},&str2hash($codes_str));
9832: push(@{$codetitles},&str2array($codetitles_str));
9833: %{$cat_titles} = (%{$cat_titles},&str2hash($cat_titles_str));
9834: %{$cat_order} = (%{$cat_order},&str2hash($cat_order_str));
9835: $ok_response = 1;
9836: }
9837: }
9838: if ($ok_response) {
9839: return 'ok';
9840: } else {
9841: return $response;
9842: }
9843: }
9844:
9845: sub auto_instcode_defaults {
9846: my ($domain,$returnhash,$code_order) = @_;
9847: my @homeservers;
9848:
9849: my %servers = &get_servers($domain,'library');
9850: foreach my $tryserver (keys(%servers)) {
9851: if (!grep(/^\Q$tryserver\E$/,@homeservers)) {
9852: push(@homeservers,$tryserver);
9853: }
9854: }
9855:
9856: my $response;
9857: foreach my $server (@homeservers) {
9858: $response=&reply('autoinstcodedefaults:'.$domain,$server);
9859: next if ($response =~ /(con_lost|error|no_such_host|refused)/);
9860:
9861: foreach my $pair (split(/\&/,$response)) {
9862: my ($name,$value)=split(/\=/,$pair);
9863: if ($name eq 'code_order') {
9864: @{$code_order} = split(/\&/,&unescape($value));
9865: } else {
9866: $returnhash->{&unescape($name)}=&unescape($value);
9867: }
9868: }
9869: return 'ok';
9870: }
9871:
9872: return $response;
9873: }
9874:
9875: sub auto_possible_instcodes {
9876: my ($domain,$codetitles,$cat_titles,$cat_orders,$code_order) = @_;
9877: unless ((ref($codetitles) eq 'ARRAY') && (ref($cat_titles) eq 'HASH') &&
9878: (ref($cat_orders) eq 'HASH') && (ref($code_order) eq 'ARRAY')) {
9879: return;
9880: }
9881: my (@homeservers,$uhome);
9882: if (defined(&domain($domain,'primary'))) {
9883: $uhome=&domain($domain,'primary');
9884: push(@homeservers,&domain($domain,'primary'));
9885: } else {
9886: my %servers = &get_servers($domain,'library');
9887: foreach my $tryserver (keys(%servers)) {
9888: if (!grep(/^\Q$tryserver\E$/,@homeservers)) {
9889: push(@homeservers,$tryserver);
9890: }
9891: }
9892: }
9893: my $response;
9894: foreach my $server (@homeservers) {
9895: $response=&reply('autopossibleinstcodes:'.$domain,$server);
9896: next if ($response =~ /(con_lost|error|no_such_host|refused)/);
9897: my ($codetitlestr,$codeorderstr,$cat_title,$cat_order) =
9898: split(':',$response);
9899: @{$codetitles} = map { &unescape($_); } (split('&',$codetitlestr));
9900: @{$code_order} = map { &unescape($_); } (split('&',$codeorderstr));
9901: foreach my $item (split('&',$cat_title)) {
9902: my ($name,$value)=split('=',$item);
9903: $cat_titles->{&unescape($name)}=&thaw_unescape($value);
9904: }
9905: foreach my $item (split('&',$cat_order)) {
9906: my ($name,$value)=split('=',$item);
9907: $cat_orders->{&unescape($name)}=&thaw_unescape($value);
9908: }
9909: return 'ok';
9910: }
9911: return $response;
9912: }
9913:
9914: sub auto_courserequest_checks {
9915: my ($dom) = @_;
9916: my ($homeserver,%validations);
9917: if ($dom =~ /^$match_domain$/) {
9918: $homeserver = &domain($dom,'primary');
9919: }
9920: unless ($homeserver eq 'no_host') {
9921: my $response=&reply('autocrsreqchecks:'.$dom,$homeserver);
9922: unless ($response =~ /(con_lost|error|no_such_host|refused)/) {
9923: my @items = split(/&/,$response);
9924: foreach my $item (@items) {
9925: my ($key,$value) = split('=',$item);
9926: $validations{&unescape($key)} = &thaw_unescape($value);
9927: }
9928: }
9929: }
9930: return %validations;
9931: }
9932:
9933: sub auto_courserequest_validation {
9934: my ($dom,$owner,$crstype,$inststatuslist,$instcode,$instseclist,$custominfo) = @_;
9935: my ($homeserver,$response);
9936: if ($dom =~ /^$match_domain$/) {
9937: $homeserver = &domain($dom,'primary');
9938: }
9939: unless ($homeserver eq 'no_host') {
9940: my $customdata;
9941: if (ref($custominfo) eq 'HASH') {
9942: $customdata = &freeze_escape($custominfo);
9943: }
9944: $response=&unescape(&reply('autocrsreqvalidation:'.$dom.':'.&escape($owner).
9945: ':'.&escape($crstype).':'.&escape($inststatuslist).
9946: ':'.&escape($instcode).':'.&escape($instseclist).':'.
9947: $customdata,$homeserver));
9948: }
9949: return $response;
9950: }
9951:
9952: sub auto_validate_class_sec {
9953: my ($cdom,$cnum,$owners,$inst_class) = @_;
9954: my $homeserver = &homeserver($cnum,$cdom);
9955: my $ownerlist;
9956: if (ref($owners) eq 'ARRAY') {
9957: $ownerlist = join(',',@{$owners});
9958: } else {
9959: $ownerlist = $owners;
9960: }
9961: my $response=&reply('autovalidateclass_sec:'.$inst_class.':'.
9962: &escape($ownerlist).':'.$cdom,$homeserver);
9963: return $response;
9964: }
9965:
9966: sub auto_instsec_reformat {
9967: my ($cdom,$action,$instsecref) = @_;
9968: return unless(($action eq 'clutter') || ($action eq 'declutter'));
9969: my @homeservers;
9970: if (defined(&domain($cdom,'primary'))) {
9971: push(@homeservers,&domain($cdom,'primary'));
9972: } else {
9973: my %servers = &get_servers($cdom,'library');
9974: foreach my $tryserver (keys(%servers)) {
9975: if (!grep(/^\Q$tryserver\E$/,@homeservers)) {
9976: push(@homeservers,$tryserver);
9977: }
9978: }
9979: }
9980: my $response;
9981: my %reformatted = %{$instsecref};
9982: foreach my $server (@homeservers) {
9983: if (ref($instsecref) eq 'HASH') {
9984: my $info = &freeze_escape($instsecref);
9985: my $response=&reply('autoinstsecreformat:'.$cdom.':'.
9986: $action.':'.$info,$server);
9987: next if ($response =~ /(con_lost|error|no_such_host|refused|unknown_command)/);
9988: my @items = split(/&/,$response);
9989: foreach my $item (@items) {
9990: my ($key,$value) = split(/=/,$item);
9991: $reformatted{&unescape($key)} = &thaw_unescape($value);
9992: }
9993: }
9994: }
9995: return %reformatted;
9996: }
9997:
9998: sub auto_validate_instclasses {
9999: my ($cdom,$cnum,$owners,$classesref) = @_;
10000: my ($homeserver,%validations);
10001: $homeserver = &homeserver($cnum,$cdom);
10002: unless ($homeserver eq 'no_host') {
10003: my $ownerlist;
10004: if (ref($owners) eq 'ARRAY') {
10005: $ownerlist = join(',',@{$owners});
10006: } else {
10007: $ownerlist = $owners;
10008: }
10009: if (ref($classesref) eq 'HASH') {
10010: my $classes = &freeze_escape($classesref);
10011: my $response=&reply('autovalidateinstclasses:'.&escape($ownerlist).
10012: ':'.$cdom.':'.$classes,$homeserver);
10013: unless ($response =~ /(con_lost|error|no_such_host|refused)/) {
10014: my @items = split(/&/,$response);
10015: foreach my $item (@items) {
10016: my ($key,$value) = split('=',$item);
10017: $validations{&unescape($key)} = &thaw_unescape($value);
10018: }
10019: }
10020: }
10021: }
10022: return %validations;
10023: }
10024:
10025: sub auto_crsreq_update {
10026: my ($cdom,$cnum,$crstype,$action,$ownername,$ownerdomain,$fullname,$title,
10027: $code,$accessstart,$accessend,$inbound) = @_;
10028: my ($homeserver,%crsreqresponse);
10029: if ($cdom =~ /^$match_domain$/) {
10030: $homeserver = &domain($cdom,'primary');
10031: }
10032: unless (($homeserver eq 'no_host') || ($homeserver eq '')) {
10033: my $info;
10034: if (ref($inbound) eq 'HASH') {
10035: $info = &freeze_escape($inbound);
10036: }
10037: my $response=&reply('autocrsrequpdate:'.$cdom.':'.$cnum.':'.&escape($crstype).
10038: ':'.&escape($action).':'.&escape($ownername).':'.
10039: &escape($ownerdomain).':'.&escape($fullname).':'.
10040: &escape($title).':'.&escape($code).':'.
10041: &escape($accessstart).':'.&escape($accessend).':'.$info,
10042: $homeserver);
10043: unless ($response =~ /(con_lost|error|no_such_host|refused)/) {
10044: my @items = split(/&/,$response);
10045: foreach my $item (@items) {
10046: my ($key,$value) = split('=',$item);
10047: $crsreqresponse{&unescape($key)} = &thaw_unescape($value);
10048: }
10049: }
10050: }
10051: return \%crsreqresponse;
10052: }
10053:
10054: sub auto_export_grades {
10055: my ($cdom,$cnum,$inforef,$gradesref) = @_;
10056: my ($homeserver,%exportresponse);
10057: if ($cdom =~ /^$match_domain$/) {
10058: $homeserver = &domain($cdom,'primary');
10059: }
10060: unless (($homeserver eq 'no_host') || ($homeserver eq '')) {
10061: my $info;
10062: if (ref($inforef) eq 'HASH') {
10063: $info = &freeze_escape($inforef);
10064: }
10065: if (ref($gradesref) eq 'HASH') {
10066: my $grades = &freeze_escape($gradesref);
10067: my $response=&reply('encrypt:autoexportgrades:'.$cdom.':'.$cnum.':'.
10068: $info.':'.$grades,$homeserver);
10069: unless ($response =~ /(con_lost|error|no_such_host|refused|unknown_command)/) {
10070: my @items = split(/&/,$response);
10071: foreach my $item (@items) {
10072: my ($key,$value) = split('=',$item);
10073: $exportresponse{&unescape($key)} = &thaw_unescape($value);
10074: }
10075: }
10076: }
10077: }
10078: return \%exportresponse;
10079: }
10080:
10081: sub check_instcode_cloning {
10082: my ($codedefaults,$code_order,$cloner,$clonefromcode,$clonetocode) = @_;
10083: unless ((ref($codedefaults) eq 'HASH') && (ref($code_order) eq 'ARRAY')) {
10084: return;
10085: }
10086: my $canclone;
10087: if (@{$code_order} > 0) {
10088: my $instcoderegexp ='^';
10089: my @clonecodes = split(/\&/,$cloner);
10090: foreach my $item (@{$code_order}) {
10091: if (grep(/^\Q$item\E=/,@clonecodes)) {
10092: foreach my $pair (@clonecodes) {
10093: my ($key,$val) = split(/\=/,$pair,2);
10094: $val = &unescape($val);
10095: if ($key eq $item) {
10096: $instcoderegexp .= '('.$val.')';
10097: last;
10098: }
10099: }
10100: } else {
10101: $instcoderegexp .= $codedefaults->{$item};
10102: }
10103: }
10104: $instcoderegexp .= '$';
10105: my (@from,@to);
10106: eval {
10107: (@from) = ($clonefromcode =~ /$instcoderegexp/);
10108: (@to) = ($clonetocode =~ /$instcoderegexp/);
10109: };
10110: if ((@from > 0) && (@to > 0)) {
10111: my @diffs = &Apache::loncommon::compare_arrays(\@from,\@to);
10112: if (!@diffs) {
10113: $canclone = 1;
10114: }
10115: }
10116: }
10117: return $canclone;
10118: }
10119:
10120: sub default_instcode_cloning {
10121: my ($clonedom,$domdefclone,$clonefromcode,$clonetocode,$codedefaultsref,$codeorderref) = @_;
10122: my (%codedefaults,@code_order,$canclone);
10123: if ((ref($codedefaultsref) eq 'HASH') && (ref($codeorderref) eq 'ARRAY')) {
10124: %codedefaults = %{$codedefaultsref};
10125: @code_order = @{$codeorderref};
10126: } elsif ($clonedom) {
10127: &auto_instcode_defaults($clonedom,\%codedefaults,\@code_order);
10128: }
10129: if (($domdefclone) && (@code_order)) {
10130: my @clonecodes = split(/\+/,$domdefclone);
10131: my $instcoderegexp ='^';
10132: foreach my $item (@code_order) {
10133: if (grep(/^\Q$item\E$/,@clonecodes)) {
10134: $instcoderegexp .= '('.$codedefaults{$item}.')';
10135: } else {
10136: $instcoderegexp .= $codedefaults{$item};
10137: }
10138: }
10139: $instcoderegexp .= '$';
10140: my (@from,@to);
10141: eval {
10142: (@from) = ($clonefromcode =~ /$instcoderegexp/);
10143: (@to) = ($clonetocode =~ /$instcoderegexp/);
10144: };
10145: if ((@from > 0) && (@to > 0)) {
10146: my @diffs = &Apache::loncommon::compare_arrays(\@from,\@to);
10147: if (!@diffs) {
10148: $canclone = 1;
10149: }
10150: }
10151: }
10152: return $canclone;
10153: }
10154:
10155: # ------------------------------------------------------- Course Group routines
10156:
10157: sub get_coursegroups {
10158: my ($cdom,$cnum,$group,$namespace) = @_;
10159: return(&dump($namespace,$cdom,$cnum,$group));
10160: }
10161:
10162: sub modify_coursegroup {
10163: my ($cdom,$cnum,$groupsettings) = @_;
10164: return(&put('coursegroups',$groupsettings,$cdom,$cnum));
10165: }
10166:
10167: sub toggle_coursegroup_status {
10168: my ($cdom,$cnum,$group,$action) = @_;
10169: my ($from_namespace,$to_namespace);
10170: if ($action eq 'delete') {
10171: $from_namespace = 'coursegroups';
10172: $to_namespace = 'deleted_groups';
10173: } else {
10174: $from_namespace = 'deleted_groups';
10175: $to_namespace = 'coursegroups';
10176: }
10177: my %curr_group = &get_coursegroups($cdom,$cnum,$group,$from_namespace);
10178: if (my $tmp = &error(%curr_group)) {
10179: &Apache::lonnet::logthis('Error retrieving group: '.$tmp.' in '.$cnum.':'.$cdom);
10180: return ('read error',$tmp);
10181: } else {
10182: my %savedsettings = %curr_group;
10183: my $result = &put($to_namespace,\%savedsettings,$cdom,$cnum);
10184: my $deloutcome;
10185: if ($result eq 'ok') {
10186: $deloutcome = &del($from_namespace,[$group],$cdom,$cnum);
10187: } else {
10188: return ('write error',$result);
10189: }
10190: if ($deloutcome eq 'ok') {
10191: return 'ok';
10192: } else {
10193: return ('delete error',$deloutcome);
10194: }
10195: }
10196: }
10197:
10198: sub modify_group_roles {
10199: my ($cdom,$cnum,$group_id,$user,$end,$start,$userprivs,$selfenroll,$context) = @_;
10200: my $url = '/'.$cdom.'/'.$cnum.'/'.$group_id;
10201: my $role = 'gr/'.&escape($userprivs);
10202: my ($uname,$udom) = split(/:/,$user);
10203: my $result = &assignrole($udom,$uname,$url,$role,$end,$start,'',$selfenroll,$context);
10204: if ($result eq 'ok') {
10205: &devalidate_getgroups_cache($udom,$uname,$cdom,$cnum);
10206: }
10207: return $result;
10208: }
10209:
10210: sub modify_coursegroup_membership {
10211: my ($cdom,$cnum,$membership) = @_;
10212: my $result = &put('groupmembership',$membership,$cdom,$cnum);
10213: return $result;
10214: }
10215:
10216: sub get_active_groups {
10217: my ($udom,$uname,$cdom,$cnum) = @_;
10218: my $now = time;
10219: my %groups = ();
10220: foreach my $key (keys(%env)) {
10221: if ($key =~ m-user\.role\.gr\./($match_domain)/($match_courseid)/(\w+)$-) {
10222: my ($start,$end) = split(/\./,$env{$key});
10223: if (($end!=0) && ($end<$now)) { next; }
10224: if (($start!=0) && ($start>$now)) { next; }
10225: if ($1 eq $cdom && $2 eq $cnum) {
10226: $groups{$3} = $env{$key} ;
10227: }
10228: }
10229: }
10230: return %groups;
10231: }
10232:
10233: sub get_group_membership {
10234: my ($cdom,$cnum,$group) = @_;
10235: return(&dump('groupmembership',$cdom,$cnum,$group));
10236: }
10237:
10238: sub get_users_groups {
10239: my ($udom,$uname,$courseid) = @_;
10240: my @usersgroups;
10241: my $cachetime=1800;
10242:
10243: my $hashid="$udom:$uname:$courseid";
10244: my ($grouplist,$cached)=&is_cached_new('getgroups',$hashid);
10245: if (defined($cached)) {
10246: @usersgroups = split(/:/,$grouplist);
10247: } else {
10248: $grouplist = '';
10249: my $courseurl = &courseid_to_courseurl($courseid);
10250: my %roleshash = &dump('roles',$udom,$uname,$courseurl);
10251: my $access_end = $env{'course.'.$courseid.
10252: '.default_enrollment_end_date'};
10253: my $now = time;
10254: foreach my $key (keys(%roleshash)) {
10255: if ($key =~ /^\Q$courseurl\E\/(\w+)\_gr$/) {
10256: my $group = $1;
10257: if ($roleshash{$key} =~ /_(\d+)_(\d+)$/) {
10258: my $start = $2;
10259: my $end = $1;
10260: if ($start == -1) { next; } # deleted from group
10261: if (($start!=0) && ($start>$now)) { next; }
10262: if (($end!=0) && ($end<$now)) {
10263: if ($access_end && $access_end < $now) {
10264: if ($access_end - $end < 86400) {
10265: push(@usersgroups,$group);
10266: }
10267: }
10268: next;
10269: }
10270: push(@usersgroups,$group);
10271: }
10272: }
10273: }
10274: @usersgroups = &sort_course_groups($courseid,@usersgroups);
10275: $grouplist = join(':',@usersgroups);
10276: &do_cache_new('getgroups',$hashid,$grouplist,$cachetime);
10277: }
10278: return @usersgroups;
10279: }
10280:
10281: sub devalidate_getgroups_cache {
10282: my ($udom,$uname,$cdom,$cnum)=@_;
10283: my $courseid = $cdom.'_'.$cnum;
10284:
10285: my $hashid="$udom:$uname:$courseid";
10286: &devalidate_cache_new('getgroups',$hashid);
10287: }
10288:
10289: # ------------------------------------------------------------------ Plain Text
10290:
10291: sub plaintext {
10292: my ($short,$type,$cid,$forcedefault) = @_;
10293: if ($short =~ m{^cr/}) {
10294: return (split('/',$short))[-1];
10295: }
10296: if (!defined($cid)) {
10297: $cid = $env{'request.course.id'};
10298: }
10299: my %rolenames = (
10300: Course => 'std',
10301: Community => 'alt1',
10302: Placement => 'std',
10303: );
10304: if ($cid ne '') {
10305: if ($env{'course.'.$cid.'.'.$short.'.plaintext'} ne '') {
10306: unless ($forcedefault) {
10307: my $roletext = $env{'course.'.$cid.'.'.$short.'.plaintext'};
10308: &Apache::lonlocal::mt_escape(\$roletext);
10309: return &Apache::lonlocal::mt($roletext);
10310: }
10311: }
10312: }
10313: if ((defined($type)) && (defined($rolenames{$type})) &&
10314: (defined($rolenames{$type})) &&
10315: (defined($prp{$short}{$rolenames{$type}}))) {
10316: return &Apache::lonlocal::mt($prp{$short}{$rolenames{$type}});
10317: } elsif ($cid ne '') {
10318: my $crstype = $env{'course.'.$cid.'.type'};
10319: if (($crstype ne '') && (defined($rolenames{$crstype})) &&
10320: (defined($prp{$short}{$rolenames{$crstype}}))) {
10321: return &Apache::lonlocal::mt($prp{$short}{$rolenames{$crstype}});
10322: }
10323: }
10324: return &Apache::lonlocal::mt($prp{$short}{'std'});
10325: }
10326:
10327: # ----------------------------------------------------------------- Assign Role
10328:
10329: sub assignrole {
10330: my ($udom,$uname,$url,$role,$end,$start,$deleteflag,$selfenroll,
10331: $context)=@_;
10332: my $mrole;
10333: if ($role =~ /^cr\//) {
10334: my $cwosec=$url;
10335: $cwosec=~s/^\/($match_domain)\/($match_courseid)\/.*/$1\/$2/;
10336: unless (&allowed('ccr',$cwosec)) {
10337: my $refused = 1;
10338: if ($context eq 'requestcourses') {
10339: if (($env{'user.name'} ne '') && ($env{'user.domain'} ne '')) {
10340: if ($role =~ m{^cr/($match_domain)/($match_username)/([^/]+)$}) {
10341: if (($1 eq $env{'user.domain'}) && ($2 eq $env{'user.name'})) {
10342: my ($cdom,$cnum) = ($cwosec =~ m{^/?($match_domain)/($match_courseid)$});
10343: my %crsenv = &userenvironment($cdom,$cnum,('internal.courseowner'));
10344: if ($crsenv{'internal.courseowner'} eq
10345: $env{'user.name'}.':'.$env{'user.domain'}) {
10346: $refused = '';
10347: }
10348: }
10349: }
10350: }
10351: }
10352: if ($refused) {
10353: &logthis('Refused custom assignrole: '.
10354: $udom.' '.$uname.' '.$url.' '.$role.' '.$end.' '.$start.
10355: ' by '.$env{'user.name'}.' at '.$env{'user.domain'});
10356: return 'refused';
10357: }
10358: }
10359: $mrole='cr';
10360: } elsif ($role =~ /^gr\//) {
10361: my $cwogrp=$url;
10362: $cwogrp=~s{^/($match_domain)/($match_courseid)/.*}{$1/$2};
10363: unless (&allowed('mdg',$cwogrp)) {
10364: &logthis('Refused group assignrole: '.
10365: $udom.' '.$uname.' '.$url.' '.$role.' '.$end.' '.$start.' by '.
10366: $env{'user.name'}.' at '.$env{'user.domain'});
10367: return 'refused';
10368: }
10369: $mrole='gr';
10370: } else {
10371: my $cwosec=$url;
10372: $cwosec=~s/^\/($match_domain)\/($match_courseid)\/.*/$1\/$2/;
10373: if (!(&allowed('c'.$role,$cwosec)) && !(&allowed('c'.$role,$udom))) {
10374: my $refused;
10375: if (($env{'request.course.sec'} ne '') && ($role eq 'st')) {
10376: if (!(&allowed('c'.$role,$url))) {
10377: $refused = 1;
10378: }
10379: } else {
10380: $refused = 1;
10381: }
10382: if ($refused) {
10383: my ($cdom,$cnum) = ($cwosec =~ m{^/?($match_domain)/($match_courseid)$});
10384: if (!$selfenroll && (($context eq 'course') || ($context eq 'ltienroll' && $env{'request.lti.login'}))) {
10385: my %crsenv;
10386: if ($role eq 'cc' || $role eq 'co') {
10387: %crsenv = &userenvironment($cdom,$cnum,('internal.courseowner'));
10388: if (($role eq 'cc') && ($cnum !~ /^$match_community$/)) {
10389: if ($env{'request.role'} eq 'cc./'.$cdom.'/'.$cnum) {
10390: if ($crsenv{'internal.courseowner'} eq
10391: $env{'user.name'}.':'.$env{'user.domain'}) {
10392: $refused = '';
10393: }
10394: }
10395: } elsif (($role eq 'co') && ($cnum =~ /^$match_community$/)) {
10396: if ($env{'request.role'} eq 'co./'.$cdom.'/'.$cnum) {
10397: if ($crsenv{'internal.courseowner'} eq
10398: $env{'user.name'}.':'.$env{'user.domain'}) {
10399: $refused = '';
10400: }
10401: }
10402: }
10403: }
10404: } elsif (($selfenroll == 1) && ($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'})) {
10405: if ($role eq 'st') {
10406: $refused = '';
10407: } elsif (($context eq 'ltienroll') && ($env{'request.lti.login'})) {
10408: $refused = '';
10409: }
10410: } elsif ($context eq 'requestcourses') {
10411: my @possroles = ('st','ta','ep','in','cc','co');
10412: if ((grep(/^\Q$role\E$/,@possroles)) && ($env{'user.name'} ne '' && $env{'user.domain'} ne '')) {
10413: my $wrongcc;
10414: if ($cnum =~ /^$match_community$/) {
10415: $wrongcc = 1 if ($role eq 'cc');
10416: } else {
10417: $wrongcc = 1 if ($role eq 'co');
10418: }
10419: unless ($wrongcc) {
10420: my %crsenv = &userenvironment($cdom,$cnum,('internal.courseowner'));
10421: if ($crsenv{'internal.courseowner'} eq
10422: $env{'user.name'}.':'.$env{'user.domain'}) {
10423: $refused = '';
10424: }
10425: }
10426: }
10427: } elsif ($context eq 'requestauthor') {
10428: if (($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'}) &&
10429: ($url eq '/'.$udom.'/') && ($role eq 'au')) {
10430: if ($env{'environment.requestauthor'} eq 'automatic') {
10431: $refused = '';
10432: } else {
10433: my %domdefaults = &get_domain_defaults($udom);
10434: if (ref($domdefaults{'requestauthor'}) eq 'HASH') {
10435: my $checkbystatus;
10436: if ($env{'user.adv'}) {
10437: my $disposition = $domdefaults{'requestauthor'}{'_LC_adv'};
10438: if ($disposition eq 'automatic') {
10439: $refused = '';
10440: } elsif ($disposition eq '') {
10441: $checkbystatus = 1;
10442: }
10443: } else {
10444: $checkbystatus = 1;
10445: }
10446: if ($checkbystatus) {
10447: if ($env{'environment.inststatus'}) {
10448: my @inststatuses = split(/,/,$env{'environment.inststatus'});
10449: foreach my $type (@inststatuses) {
10450: if (($type ne '') &&
10451: ($domdefaults{'requestauthor'}{$type} eq 'automatic')) {
10452: $refused = '';
10453: }
10454: }
10455: } elsif ($domdefaults{'requestauthor'}{'default'} eq 'automatic') {
10456: $refused = '';
10457: }
10458: }
10459: }
10460: }
10461: }
10462: }
10463: if ($refused) {
10464: &logthis('Refused assignrole: '.$udom.' '.$uname.' '.$url.
10465: ' '.$role.' '.$end.' '.$start.' by '.
10466: $env{'user.name'}.' at '.$env{'user.domain'});
10467: return 'refused';
10468: }
10469: }
10470: } elsif ($role eq 'au') {
10471: if ($url ne '/'.$udom.'/') {
10472: &logthis('Attempt by '.$env{'user.name'}.':'.$env{'user.domain'}.
10473: ' to assign author role for '.$uname.':'.$udom.
10474: ' in domain: '.$url.' refused (wrong domain).');
10475: return 'refused';
10476: }
10477: }
10478: $mrole=$role;
10479: }
10480: my $command="encrypt:rolesput:$env{'user.domain'}:$env{'user.name'}:".
10481: "$udom:$uname:$url".'_'."$mrole=$role";
10482: if ($end) { $command.='_'.$end; }
10483: if ($start) {
10484: if ($end) {
10485: $command.='_'.$start;
10486: } else {
10487: $command.='_0_'.$start;
10488: }
10489: }
10490: my $origstart = $start;
10491: my $origend = $end;
10492: my $delflag;
10493: # actually delete
10494: if ($deleteflag) {
10495: if ((&allowed('dro',$udom)) || (&allowed('dro',$url))) {
10496: # modify command to delete the role
10497: $command="encrypt:rolesdel:$env{'user.domain'}:$env{'user.name'}:".
10498: "$udom:$uname:$url".'_'."$mrole";
10499: &logthis("$env{'user.name'} at $env{'user.domain'} deletes $mrole in $url for $uname at $udom");
10500: # set start and finish to negative values for userrolelog
10501: $start=-1;
10502: $end=-1;
10503: $delflag = 1;
10504: }
10505: }
10506: # send command
10507: my $answer=&reply($command,&homeserver($uname,$udom));
10508: # log new user role if status is ok
10509: if ($answer eq 'ok') {
10510: &userrolelog($role,$uname,$udom,$url,$start,$end);
10511: if (($role eq 'cc') || ($role eq 'in') ||
10512: ($role eq 'ep') || ($role eq 'ad') ||
10513: ($role eq 'ta') || ($role eq 'st') ||
10514: ($role=~/^cr/) || ($role eq 'gr') ||
10515: ($role eq 'co')) {
10516: # for course roles, perform group memberships changes triggered by role change.
10517: unless ($role =~ /^gr/) {
10518: &Apache::longroup::group_changes($udom,$uname,$url,$role,$origend,
10519: $origstart,$selfenroll,$context);
10520: }
10521: &courserolelog($role,$uname,$udom,$url,$origstart,$origend,$delflag,
10522: $selfenroll,$context);
10523: } elsif (($role eq 'li') || ($role eq 'dg') || ($role eq 'sc') ||
10524: ($role eq 'au') || ($role eq 'dc') || ($role eq 'dh') ||
10525: ($role eq 'da')) {
10526: &domainrolelog($role,$uname,$udom,$url,$origstart,$origend,$delflag,
10527: $context);
10528: } elsif (($role eq 'ca') || ($role eq 'aa')) {
10529: &coauthorrolelog($role,$uname,$udom,$url,$origstart,$origend,$delflag,
10530: $context);
10531: }
10532: if ($role eq 'cc') {
10533: &autoupdate_coowners($url,$end,$start,$uname,$udom);
10534: }
10535: }
10536: return $answer;
10537: }
10538:
10539: sub autoupdate_coowners {
10540: my ($url,$end,$start,$uname,$udom) = @_;
10541: my ($cdom,$cnum) = ($url =~ m{^/($match_domain)/($match_courseid)});
10542: if (($cdom ne '') && ($cnum ne '')) {
10543: my $now = time;
10544: my %domdesign = &Apache::loncommon::get_domainconf($cdom);
10545: if ($domdesign{$cdom.'.autoassign.co-owners'}) {
10546: my %coursehash = &coursedescription($cdom.'_'.$cnum);
10547: my $instcode = $coursehash{'internal.coursecode'};
10548: my $xlists = $coursehash{'internal.crosslistings'};
10549: if ($instcode ne '') {
10550: if (($start && $start <= $now) && ($end == 0) || ($end > $now)) {
10551: unless ($coursehash{'internal.courseowner'} eq $uname.':'.$udom) {
10552: my ($delcoowners,@newcoowners,$putresult,$delresult,$coowners);
10553: my ($result,$desc) = &auto_validate_instcode($cnum,$cdom,$instcode,$uname.':'.$udom);
10554: unless ($result eq 'valid') {
10555: if ($xlists ne '') {
10556: foreach my $xlist (split(',',$xlists)) {
10557: my ($inst_crosslist,$lcsec) = split(':',$xlist);
10558: $result =
10559: &auto_validate_inst_crosslist($cnum,$cdom,$instcode,
10560: $inst_crosslist,$uname.':'.$udom);
10561: last if ($result eq 'valid');
10562: }
10563: }
10564: }
10565: if ($result eq 'valid') {
10566: if ($coursehash{'internal.co-owners'}) {
10567: foreach my $coowner (split(',',$coursehash{'internal.co-owners'})) {
10568: push(@newcoowners,$coowner);
10569: }
10570: unless (grep(/^\Q$uname\E:\Q$udom\E$/,@newcoowners)) {
10571: push(@newcoowners,$uname.':'.$udom);
10572: }
10573: @newcoowners = sort(@newcoowners);
10574: } else {
10575: push(@newcoowners,$uname.':'.$udom);
10576: }
10577: } elsif ($coursehash{'internal.co-owners'}) {
10578: foreach my $coowner (split(',',$coursehash{'internal.co-owners'})) {
10579: unless ($coowner eq $uname.':'.$udom) {
10580: push(@newcoowners,$coowner);
10581: }
10582: }
10583: unless (@newcoowners > 0) {
10584: $delcoowners = 1;
10585: $coowners = '';
10586: }
10587: }
10588: if (@newcoowners || $delcoowners) {
10589: &store_coowners($cdom,$cnum,$coursehash{'home'},
10590: $delcoowners,@newcoowners);
10591: }
10592: }
10593: }
10594: }
10595: }
10596: }
10597: }
10598:
10599: sub store_coowners {
10600: my ($cdom,$cnum,$chome,$delcoowners,@newcoowners) = @_;
10601: my $cid = $cdom.'_'.$cnum;
10602: my ($coowners,$delresult,$putresult);
10603: if (@newcoowners) {
10604: $coowners = join(',',@newcoowners);
10605: my %coownershash = (
10606: 'internal.co-owners' => $coowners,
10607: );
10608: $putresult = &put('environment',\%coownershash,$cdom,$cnum);
10609: if ($putresult eq 'ok') {
10610: if ($env{'course.'.$cid.'.num'} eq $cnum) {
10611: &appenv({'course.'.$cid.'.internal.co-owners' => $coowners});
10612: }
10613: }
10614: }
10615: if ($delcoowners) {
10616: $delresult = &Apache::lonnet::del('environment',['internal.co-owners'],$cdom,$cnum);
10617: if ($delresult eq 'ok') {
10618: if ($env{'course.'.$cid.'.internal.co-owners'}) {
10619: &Apache::lonnet::delenv('course.'.$cid.'.internal.co-owners');
10620: }
10621: }
10622: }
10623: if (($putresult eq 'ok') || ($delresult eq 'ok')) {
10624: my %crsinfo =
10625: &Apache::lonnet::courseiddump($cdom,'.',1,'.','.',$cnum,undef,undef,'.');
10626: if (ref($crsinfo{$cid}) eq 'HASH') {
10627: $crsinfo{$cid}{'co-owners'} = \@newcoowners;
10628: my $cidput = &Apache::lonnet::courseidput($cdom,\%crsinfo,$chome,'notime');
10629: }
10630: }
10631: }
10632:
10633: # -------------------------------------------------- Modify user authentication
10634: # Overrides without validation
10635:
10636: sub modifyuserauth {
10637: my ($udom,$uname,$umode,$upass)=@_;
10638: my $uhome=&homeserver($uname,$udom);
10639: my $allowed;
10640: if (&allowed('mau',$udom)) {
10641: $allowed = 1;
10642: } elsif (($umode eq 'internal') && ($udom eq $env{'user.domain'}) &&
10643: ($env{'request.course.id'}) && (&allowed('mip',$env{'request.course.id'})) &&
10644: (!$env{'course.'.$env{'request.course.id'}.'.internal.nopasswdchg'})) {
10645: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
10646: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
10647: if (($cdom ne '') && ($cnum ne '')) {
10648: my $is_owner = &is_course_owner($cdom,$cnum);
10649: if ($is_owner) {
10650: $allowed = 1;
10651: }
10652: }
10653: }
10654: unless ($allowed) { return 'refused'; }
10655: &logthis('Call to modify user authentication '.$udom.', '.$uname.', '.
10656: $umode.' by '.$env{'user.name'}.' at '.$env{'user.domain'}.
10657: ' in domain '.$env{'request.role.domain'});
10658: my $reply=&reply('encrypt:changeuserauth:'.$udom.':'.$uname.':'.$umode.':'.
10659: &escape($upass),$uhome);
10660: my $ip = &get_requestor_ip();
10661: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},
10662: 'Authentication changed for '.$udom.', '.$uname.', '.$umode.
10663: '(Remote '.$ip.'): '.$reply);
10664: &log($udom,,$uname,$uhome,
10665: 'Authentication changed by '.$env{'user.domain'}.', '.
10666: $env{'user.name'}.', '.$umode.
10667: '(Remote '.$ip.'): '.$reply);
10668: unless ($reply eq 'ok') {
10669: &logthis('Authentication mode error: '.$reply);
10670: return 'error: '.$reply;
10671: }
10672: return 'ok';
10673: }
10674:
10675: # --------------------------------------------------------------- Modify a user
10676:
10677: sub modifyuser {
10678: my ($udom, $uname, $uid,
10679: $umode, $upass, $first,
10680: $middle, $last, $gene,
10681: $forceid, $desiredhome, $email, $inststatus, $candelete)=@_;
10682: $udom= &LONCAPA::clean_domain($udom);
10683: $uname=&LONCAPA::clean_username($uname);
10684: my $showcandelete = 'none';
10685: if (ref($candelete) eq 'ARRAY') {
10686: if (@{$candelete} > 0) {
10687: $showcandelete = join(', ',@{$candelete});
10688: }
10689: }
10690: &logthis('Call to modify user '.$udom.', '.$uname.', '.$uid.', '.
10691: $umode.', '.$first.', '.$middle.', '.
10692: $last.', '.$gene.'(forceid: '.$forceid.'; candelete: '.$showcandelete.')'.
10693: (defined($desiredhome) ? ' desiredhome = '.$desiredhome :
10694: ' desiredhome not specified').
10695: ' by '.$env{'user.name'}.' at '.$env{'user.domain'}.
10696: ' in domain '.$env{'request.role.domain'});
10697: my $uhome=&homeserver($uname,$udom,'true');
10698: my $newuser;
10699: if ($uhome eq 'no_host') {
10700: $newuser = 1;
10701: unless (($umode && ($upass ne '')) || ($umode eq 'localauth') ||
10702: ($umode eq 'lti')) {
10703: return 'error: more information needed to create new user';
10704: }
10705: }
10706: # ----------------------------------------------------------------- Create User
10707: if (($uhome eq 'no_host') &&
10708: (($umode && $upass) || ($umode eq 'localauth') || ($umode eq 'lti'))) {
10709: my $unhome='';
10710: if (defined($desiredhome) && &host_domain($desiredhome) eq $udom) {
10711: $unhome = $desiredhome;
10712: } elsif($env{'course.'.$env{'request.course.id'}.'.domain'} eq $udom) {
10713: $unhome=$env{'course.'.$env{'request.course.id'}.'.home'};
10714: } else { # load balancing routine for determining $unhome
10715: my $loadm=10000000;
10716: my %servers = &get_servers($udom,'library');
10717: foreach my $tryserver (keys(%servers)) {
10718: my $answer=reply('load',$tryserver);
10719: if (($answer=~/\d+/) && ($answer<$loadm)) {
10720: $loadm=$answer;
10721: $unhome=$tryserver;
10722: }
10723: }
10724: }
10725: if (($unhome eq '') || ($unhome eq 'no_host')) {
10726: return 'error: unable to find a home server for '.$uname.
10727: ' in domain '.$udom;
10728: }
10729: my $reply=&reply('encrypt:makeuser:'.$udom.':'.$uname.':'.$umode.':'.
10730: &escape($upass),$unhome);
10731: unless ($reply eq 'ok') {
10732: return 'error: '.$reply;
10733: }
10734: $uhome=&homeserver($uname,$udom,'true');
10735: if (($uhome eq '') || ($uhome eq 'no_host') || ($uhome ne $unhome)) {
10736: return 'error: unable verify users home machine.';
10737: }
10738: } # End of creation of new user
10739: # ---------------------------------------------------------------------- Add ID
10740: if ($uid) {
10741: $uid=~tr/A-Z/a-z/;
10742: my %uidhash=&idrget($udom,$uname);
10743: if (($uidhash{$uname}) && ($uidhash{$uname}!~/error\:/)
10744: && (!$forceid)) {
10745: unless ($uid eq $uidhash{$uname}) {
10746: return 'error: user id "'.$uid.'" does not match '.
10747: 'current user id "'.$uidhash{$uname}.'".';
10748: }
10749: } else {
10750: &idput($udom,{$uname => $uid},$uhome,'ids');
10751: }
10752: }
10753: # -------------------------------------------------------------- Add names, etc
10754: my @tmp=&get('environment',
10755: ['firstname','middlename','lastname','generation','id',
10756: 'permanentemail','inststatus'],
10757: $udom,$uname);
10758: my (%names,%oldnames);
10759: if ($tmp[0] =~ m/^error:.*/) {
10760: %names=();
10761: } else {
10762: %names = @tmp;
10763: %oldnames = %names;
10764: }
10765: #
10766: # If name, email and/or uid are blank (e.g., because an uploaded file
10767: # of users did not contain them), do not overwrite existing values
10768: # unless field is in $candelete array ref.
10769: #
10770:
10771: my @fields = ('firstname','middlename','lastname','generation',
10772: 'permanentemail','id');
10773: my %newvalues;
10774: if (ref($candelete) eq 'ARRAY') {
10775: foreach my $field (@fields) {
10776: if (grep(/^\Q$field\E$/,@{$candelete})) {
10777: if ($field eq 'firstname') {
10778: $names{$field} = $first;
10779: } elsif ($field eq 'middlename') {
10780: $names{$field} = $middle;
10781: } elsif ($field eq 'lastname') {
10782: $names{$field} = $last;
10783: } elsif ($field eq 'generation') {
10784: $names{$field} = $gene;
10785: } elsif ($field eq 'permanentemail') {
10786: $names{$field} = $email;
10787: } elsif ($field eq 'id') {
10788: $names{$field} = $uid;
10789: }
10790: }
10791: }
10792: }
10793: if ($first) { $names{'firstname'} = $first; }
10794: if (defined($middle)) { $names{'middlename'} = $middle; }
10795: if ($last) { $names{'lastname'} = $last; }
10796: if (defined($gene)) { $names{'generation'} = $gene; }
10797: if ($email) {
10798: $email=~s/[^\w\@\.\-\,]//gs;
10799: if ($email=~/\@/) { $names{'permanentemail'} = $email; }
10800: }
10801: if ($uid) { $names{'id'} = $uid; }
10802: if (defined($inststatus)) {
10803: $names{'inststatus'} = '';
10804: my ($usertypes,$typesorder) = &retrieve_inst_usertypes($udom);
10805: if (ref($usertypes) eq 'HASH') {
10806: my @okstatuses;
10807: foreach my $item (split(/:/,$inststatus)) {
10808: if (defined($usertypes->{$item})) {
10809: push(@okstatuses,$item);
10810: }
10811: }
10812: if (@okstatuses) {
10813: $names{'inststatus'} = join(':', map { &escape($_); } @okstatuses);
10814: }
10815: }
10816: }
10817: my $logmsg = $udom.', '.$uname.', '.$uid.', '.
10818: $umode.', '.$first.', '.$middle.', '.
10819: $last.', '.$gene.', '.$email.', '.$inststatus;
10820: if ($env{'user.name'} ne '' && $env{'user.domain'}) {
10821: $logmsg .= ' by '.$env{'user.name'}.' at '.$env{'user.domain'};
10822: } else {
10823: $logmsg .= ' during self creation';
10824: }
10825: my $changed;
10826: if ($newuser) {
10827: $changed = 1;
10828: } else {
10829: foreach my $field (@fields) {
10830: if ($names{$field} ne $oldnames{$field}) {
10831: $changed = 1;
10832: last;
10833: }
10834: }
10835: }
10836: unless ($changed) {
10837: $logmsg = 'No changes in user information needed for: '.$logmsg;
10838: &logthis($logmsg);
10839: return 'ok';
10840: }
10841: my $reply = &put('environment', \%names, $udom,$uname);
10842: if ($reply ne 'ok') {
10843: return 'error: '.$reply;
10844: }
10845: if ($names{'permanentemail'} ne $oldnames{'permanentemail'}) {
10846: &Apache::lonnet::devalidate_cache_new('emailscache',$uname.':'.$udom);
10847: }
10848: my $sqlresult = &update_allusers_table($uname,$udom,\%names);
10849: &devalidate_cache_new('namescache',$uname.':'.$udom);
10850: $logmsg = 'Success modifying user '.$logmsg;
10851: &logthis($logmsg);
10852: return 'ok';
10853: }
10854:
10855: # -------------------------------------------------------------- Modify student
10856:
10857: sub modifystudent {
10858: my ($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene,$usec,
10859: $end,$start,$forceid,$desiredhome,$email,$type,$locktype,$cid,
10860: $selfenroll,$context,$inststatus,$credits,$instsec)=@_;
10861: if (!$cid) {
10862: unless ($cid=$env{'request.course.id'}) {
10863: return 'not_in_class';
10864: }
10865: }
10866: # --------------------------------------------------------------- Make the user
10867: my $reply=&modifyuser
10868: ($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene,$forceid,
10869: $desiredhome,$email,$inststatus);
10870: unless ($reply eq 'ok') { return $reply; }
10871: # This will cause &modify_student_enrollment to get the uid from the
10872: # student's environment
10873: $uid = undef if (!$forceid);
10874: $reply = &modify_student_enrollment($udom,$uname,$uid,$first,$middle,$last,
10875: $gene,$usec,$end,$start,$type,$locktype,
10876: $cid,$selfenroll,$context,$credits,$instsec);
10877: return $reply;
10878: }
10879:
10880: sub modify_student_enrollment {
10881: my ($udom,$uname,$uid,$first,$middle,$last,$gene,$usec,$end,$start,$type,
10882: $locktype,$cid,$selfenroll,$context,$credits,$instsec) = @_;
10883: my ($cdom,$cnum,$chome);
10884: if (!$cid) {
10885: unless ($cid=$env{'request.course.id'}) {
10886: return 'not_in_class';
10887: }
10888: $cdom=$env{'course.'.$cid.'.domain'};
10889: $cnum=$env{'course.'.$cid.'.num'};
10890: } else {
10891: ($cdom,$cnum)=split(/_/,$cid);
10892: }
10893: $chome=$env{'course.'.$cid.'.home'};
10894: if (!$chome) {
10895: $chome=&homeserver($cnum,$cdom);
10896: }
10897: if (!$chome) { return 'unknown_course'; }
10898: # Make sure the user exists
10899: my $uhome=&homeserver($uname,$udom);
10900: if (($uhome eq '') || ($uhome eq 'no_host')) {
10901: return 'error: no such user';
10902: }
10903: # Get student data if we were not given enough information
10904: if (!defined($first) || $first eq '' ||
10905: !defined($last) || $last eq '' ||
10906: !defined($uid) || $uid eq '' ||
10907: !defined($middle) || $middle eq '' ||
10908: !defined($gene) || $gene eq '') {
10909: # They did not supply us with enough data to enroll the student, so
10910: # we need to pick up more information.
10911: my %tmp = &get('environment',
10912: ['firstname','middlename','lastname', 'generation','id']
10913: ,$udom,$uname);
10914:
10915: #foreach my $key (keys(%tmp)) {
10916: # &logthis("key $key = ".$tmp{$key});
10917: #}
10918: $first = $tmp{'firstname'} if (!defined($first) || $first eq '');
10919: $middle = $tmp{'middlename'} if (!defined($middle) || $middle eq '');
10920: $last = $tmp{'lastname'} if (!defined($last) || $last eq '');
10921: $gene = $tmp{'generation'} if (!defined($gene) || $gene eq '');
10922: $uid = $tmp{'id'} if (!defined($uid) || $uid eq '');
10923: }
10924: my $fullname = &format_name($first,$middle,$last,$gene,'lastname');
10925: my $user = "$uname:$udom";
10926: my %old_entry = &Apache::lonnet::get('classlist',[$user],$cdom,$cnum);
10927: my $reply=cput('classlist',
10928: {$user =>
10929: join(':',$end,$start,$uid,$usec,$fullname,$type,$locktype,$credits,$instsec) },
10930: $cdom,$cnum);
10931: if (($reply eq 'ok') || ($reply eq 'delayed')) {
10932: &devalidate_getsection_cache($udom,$uname,$cid);
10933: } else {
10934: return 'error: '.$reply;
10935: }
10936: # Add student role to user
10937: my $uurl='/'.$cid;
10938: $uurl=~s/\_/\//g;
10939: if ($usec) {
10940: $uurl.='/'.$usec;
10941: }
10942: my $result = &assignrole($udom,$uname,$uurl,'st',$end,$start,undef,
10943: $selfenroll,$context);
10944: if ($result ne 'ok') {
10945: if ($old_entry{$user} ne '') {
10946: $reply = &cput('classlist',\%old_entry,$cdom,$cnum);
10947: } else {
10948: $reply = &del('classlist',[$user],$cdom,$cnum);
10949: }
10950: }
10951: return $result;
10952: }
10953:
10954: sub format_name {
10955: my ($firstname,$middlename,$lastname,$generation,$first)=@_;
10956: my $name;
10957: if ($first ne 'lastname') {
10958: $name=$firstname.' '.$middlename.' '.$lastname.' '.$generation;
10959: } else {
10960: if ($lastname=~/\S/) {
10961: $name.= $lastname.' '.$generation.', '.$firstname.' '.$middlename;
10962: $name=~s/\s+,/,/;
10963: } else {
10964: $name.= $firstname.' '.$middlename.' '.$generation;
10965: }
10966: }
10967: $name=~s/^\s+//;
10968: $name=~s/\s+$//;
10969: $name=~s/\s+/ /g;
10970: return $name;
10971: }
10972:
10973: # ------------------------------------------------- Write to course preferences
10974:
10975: sub writecoursepref {
10976: my ($courseid,%prefs)=@_;
10977: $courseid=~s/^\///;
10978: $courseid=~s/\_/\//g;
10979: my ($cdomain,$cnum)=split(/\//,$courseid);
10980: my $chome=homeserver($cnum,$cdomain);
10981: if (($chome eq '') || ($chome eq 'no_host')) {
10982: return 'error: no such course';
10983: }
10984: my $cstring='';
10985: foreach my $pref (keys(%prefs)) {
10986: $cstring.=&escape($pref).'='.&escape($prefs{$pref}).'&';
10987: }
10988: $cstring=~s/\&$//;
10989: return reply('put:'.$cdomain.':'.$cnum.':environment:'.$cstring,$chome);
10990: }
10991:
10992: # ---------------------------------------------------------- Make/modify course
10993:
10994: sub createcourse {
10995: my ($udom,$description,$url,$course_server,$nonstandard,$inst_code,
10996: $course_owner,$crstype,$cnum,$context,$category,$callercontext)=@_;
10997: $url=&declutter($url);
10998: my $cid='';
10999: if ($context eq 'requestcourses') {
11000: my $can_create = 0;
11001: my ($ownername,$ownerdom) = split(':',$course_owner);
11002: if ($udom eq $ownerdom) {
11003: my $reload;
11004: if (($callercontext eq 'auto') &&
11005: ($ownerdom eq $env{'user.domain'}) && ($ownername eq $env{'user.name'})) {
11006: $reload = 'reload';
11007: }
11008: if (&usertools_access($ownername,$ownerdom,$category,$reload,
11009: $context)) {
11010: $can_create = 1;
11011: }
11012: } else {
11013: my %userenv = &userenvironment($ownerdom,$ownername,'reqcrsotherdom.'.
11014: $category);
11015: if ($userenv{'reqcrsotherdom.'.$category} ne '') {
11016: my @curr = split(',',$userenv{'reqcrsotherdom.'.$category});
11017: if (@curr > 0) {
11018: my @options = qw(approval validate autolimit);
11019: my $optregex = join('|',@options);
11020: if (grep(/^\Q$udom\E:($optregex)(=?\d*)$/,@curr)) {
11021: $can_create = 1;
11022: }
11023: }
11024: }
11025: }
11026: if ($can_create) {
11027: unless ($ownername eq $env{'user.name'} && $ownerdom eq $env{'user.domain'}) {
11028: unless (&allowed('ccc',$udom)) {
11029: return 'refused';
11030: }
11031: }
11032: } else {
11033: return 'refused';
11034: }
11035: } elsif (!&allowed('ccc',$udom)) {
11036: return 'refused';
11037: }
11038: # --------------------------------------------------------------- Get Unique ID
11039: my $uname;
11040: if ($cnum =~ /^$match_courseid$/) {
11041: my $chome=&homeserver($cnum,$udom,'true');
11042: if (($chome eq '') || ($chome eq 'no_host')) {
11043: $uname = $cnum;
11044: } else {
11045: $uname = &generate_coursenum($udom,$crstype);
11046: }
11047: } else {
11048: $uname = &generate_coursenum($udom,$crstype);
11049: }
11050: return $uname if ($uname =~ /^error/);
11051: # -------------------------------------------------- Check supplied server name
11052: if (!defined($course_server)) {
11053: if (defined(&domain($udom,'primary'))) {
11054: $course_server = &domain($udom,'primary');
11055: } else {
11056: $course_server = $env{'user.home'};
11057: }
11058: }
11059: my %host_servers =
11060: &Apache::lonnet::get_servers($udom,'library');
11061: unless ($host_servers{$course_server}) {
11062: return 'error: invalid home server for course: '.$course_server;
11063: }
11064: # ------------------------------------------------------------- Make the course
11065: my $reply=&reply('encrypt:makeuser:'.$udom.':'.$uname.':none::',
11066: $course_server);
11067: unless ($reply eq 'ok') { return 'error: '.$reply; }
11068: my $uhome=&homeserver($uname,$udom,'true');
11069: if (($uhome eq '') || ($uhome eq 'no_host')) {
11070: return 'error: no such course';
11071: }
11072: # ----------------------------------------------------------------- Course made
11073: # log existence
11074: my $now = time;
11075: my $newcourse = {
11076: $udom.'_'.$uname => {
11077: description => $description,
11078: inst_code => $inst_code,
11079: owner => $course_owner,
11080: type => $crstype,
11081: creator => $env{'user.name'}.':'.
11082: $env{'user.domain'},
11083: created => $now,
11084: context => $context,
11085: },
11086: };
11087: &courseidput($udom,$newcourse,$uhome,'notime');
11088: # set toplevel url
11089: my $topurl=$url;
11090: unless ($nonstandard) {
11091: # ------------------------------------------ For standard courses, make top url
11092: my $mapurl=&clutter($url);
11093: if ($mapurl eq '/res/') { $mapurl=''; }
11094: $env{'form.initmap'}=(<<ENDINITMAP);
11095: <map>
11096: <resource id="1" type="start"></resource>
11097: <resource id="2" src="$mapurl"></resource>
11098: <resource id="3" type="finish"></resource>
11099: <link index="1" from="1" to="2"></link>
11100: <link index="2" from="2" to="3"></link>
11101: </map>
11102: ENDINITMAP
11103: $topurl=&declutter(
11104: &finishuserfileupload($uname,$udom,'initmap','default.sequence')
11105: );
11106: }
11107: # ----------------------------------------------------------- Write preferences
11108: &writecoursepref($udom.'_'.$uname,
11109: ('description' => $description,
11110: 'url' => $topurl,
11111: 'internal.creator' => $env{'user.name'}.':'.
11112: $env{'user.domain'},
11113: 'internal.created' => $now,
11114: 'internal.creationcontext' => $context)
11115: );
11116: return '/'.$udom.'/'.$uname;
11117: }
11118:
11119: # ------------------------------------------------------------------- Create ID
11120: sub generate_coursenum {
11121: my ($udom,$crstype) = @_;
11122: my $domdesc = &domain($udom);
11123: return 'error: invalid domain' if ($domdesc eq '');
11124: my $first;
11125: if ($crstype eq 'Community') {
11126: $first = '0';
11127: } else {
11128: $first = int(1+rand(9));
11129: }
11130: my $uname=$first.
11131: ('a'..'z','A'..'Z','0'..'9')[int(rand(62))].
11132: substr($$.time,0,5).unpack("H8",pack("I32",time)).
11133: unpack("H2",pack("I32",int(rand(255)))).$perlvar{'lonHostID'};
11134: # ----------------------------------------------- Make sure that does not exist
11135: my $uhome=&homeserver($uname,$udom,'true');
11136: unless (($uhome eq '') || ($uhome eq 'no_host')) {
11137: if ($crstype eq 'Community') {
11138: $first = '0';
11139: } else {
11140: $first = int(1+rand(9));
11141: }
11142: $uname=$first.
11143: ('a'..'z','A'..'Z','0'..'9')[int(rand(62))].
11144: substr($$.time,0,5).unpack("H8",pack("I32",time)).
11145: unpack("H2",pack("I32",int(rand(255)))).$perlvar{'lonHostID'};
11146: $uhome=&homeserver($uname,$udom,'true');
11147: unless (($uhome eq '') || ($uhome eq 'no_host')) {
11148: return 'error: unable to generate unique course-ID';
11149: }
11150: }
11151: return $uname;
11152: }
11153:
11154: sub is_course {
11155: my ($cdom, $cnum) = scalar(@_) == 1 ?
11156: ($_[0] =~ /^($match_domain)_($match_courseid)$/) : @_;
11157:
11158: return unless (($cdom =~ /^$match_domain$/) && ($cnum =~ /^$match_courseid$/));
11159: my $uhome=&homeserver($cnum,$cdom);
11160: my $iscourse;
11161: if (grep { $_ eq $uhome } current_machine_ids()) {
11162: $iscourse = &LONCAPA::Lond::is_course($cdom,$cnum);
11163: } else {
11164: my $hashid = $cdom.':'.$cnum;
11165: ($iscourse,my $cached) = &is_cached_new('iscourse',$hashid);
11166: unless (defined($cached)) {
11167: my %courses = &courseiddump($cdom, '.', 1, '.', '.',
11168: $cnum,undef,undef,'.');
11169: $iscourse = 0;
11170: if (exists($courses{$cdom.'_'.$cnum})) {
11171: $iscourse = 1;
11172: }
11173: &do_cache_new('iscourse',$hashid,$iscourse,3600);
11174: }
11175: }
11176: return unless ($iscourse);
11177: return wantarray ? ($cdom, $cnum) : $cdom.'_'.$cnum;
11178: }
11179:
11180: sub store_userdata {
11181: my ($storehash,$datakey,$namespace,$udom,$uname) = @_;
11182: my $result;
11183: if ($datakey ne '') {
11184: if (ref($storehash) eq 'HASH') {
11185: if ($udom eq '' || $uname eq '') {
11186: $udom = $env{'user.domain'};
11187: $uname = $env{'user.name'};
11188: }
11189: my $uhome=&homeserver($uname,$udom);
11190: if (($uhome eq '') || ($uhome eq 'no_host')) {
11191: $result = 'error: no_host';
11192: } else {
11193: $storehash->{'ip'} = &get_requestor_ip();
11194: $storehash->{'host'} = $perlvar{'lonHostID'};
11195:
11196: my $namevalue='';
11197: foreach my $key (keys(%{$storehash})) {
11198: $namevalue.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
11199: }
11200: $namevalue=~s/\&$//;
11201: unless ($namespace eq 'courserequests') {
11202: $datakey = &escape($datakey);
11203: }
11204: $result = &reply("store:$udom:$uname:$namespace:$datakey:".
11205: $namevalue,$uhome);
11206: }
11207: } else {
11208: $result = 'error: data to store was not a hash reference';
11209: }
11210: } else {
11211: $result= 'error: invalid requestkey';
11212: }
11213: return $result;
11214: }
11215:
11216: # ---------------------------------------------------------- Assign Custom Role
11217:
11218: sub assigncustomrole {
11219: my ($udom,$uname,$url,$rdom,$rnam,$rolename,$end,$start,$deleteflag,$selfenroll,$context)=@_;
11220: return &assignrole($udom,$uname,$url,'cr/'.$rdom.'/'.$rnam.'/'.$rolename,
11221: $end,$start,$deleteflag,$selfenroll,$context);
11222: }
11223:
11224: # ----------------------------------------------------------------- Revoke Role
11225:
11226: sub revokerole {
11227: my ($udom,$uname,$url,$role,$deleteflag,$selfenroll,$context)=@_;
11228: my $now=time;
11229: return &assignrole($udom,$uname,$url,$role,$now,undef,$deleteflag,$selfenroll,$context);
11230: }
11231:
11232: # ---------------------------------------------------------- Revoke Custom Role
11233:
11234: sub revokecustomrole {
11235: my ($udom,$uname,$url,$rdom,$rnam,$rolename,$deleteflag,$selfenroll,$context)=@_;
11236: my $now=time;
11237: return &assigncustomrole($udom,$uname,$url,$rdom,$rnam,$rolename,$now,
11238: $deleteflag,$selfenroll,$context);
11239: }
11240:
11241: # ------------------------------------------------------------ Disk usage
11242: sub diskusage {
11243: my ($udom,$uname,$directorypath,$getpropath)=@_;
11244: $directorypath =~ s/\/$//;
11245: my $listing=&reply('du2:'.&escape($directorypath).':'
11246: .&escape($getpropath).':'.&escape($uname).':'
11247: .&escape($udom),homeserver($uname,$udom));
11248: if ($listing eq 'unknown_cmd') {
11249: if ($getpropath) {
11250: $directorypath = &propath($udom,$uname).'/'.$directorypath;
11251: }
11252: $listing = &reply('du:'.$directorypath,homeserver($uname,$udom));
11253: }
11254: return $listing;
11255: }
11256:
11257: sub is_locked {
11258: my ($file_name, $domain, $user, $which) = @_;
11259: my @check;
11260: my $is_locked;
11261: push (@check,$file_name);
11262: my %locked = &get('file_permissions',\@check,
11263: $env{'user.domain'},$env{'user.name'});
11264: my ($tmp)=keys(%locked);
11265: if ($tmp=~/^error:/) { undef(%locked); }
11266:
11267: if (ref($locked{$file_name}) eq 'ARRAY') {
11268: $is_locked = 'false';
11269: foreach my $entry (@{$locked{$file_name}}) {
11270: if (ref($entry) eq 'ARRAY') {
11271: $is_locked = 'true';
11272: if (ref($which) eq 'ARRAY') {
11273: push(@{$which},$entry);
11274: } else {
11275: last;
11276: }
11277: }
11278: }
11279: } else {
11280: $is_locked = 'false';
11281: }
11282: return $is_locked;
11283: }
11284:
11285: sub declutter_portfile {
11286: my ($file) = @_;
11287: $file =~ s{^(/portfolio/|portfolio/)}{/};
11288: return $file;
11289: }
11290:
11291: # ------------------------------------------------------------- Mark as Read Only
11292:
11293: sub mark_as_readonly {
11294: my ($domain,$user,$files,$what) = @_;
11295: my %current_permissions = &dump('file_permissions',$domain,$user);
11296: my ($tmp)=keys(%current_permissions);
11297: if ($tmp=~/^error:/) { undef(%current_permissions); }
11298: foreach my $file (@{$files}) {
11299: $file = &declutter_portfile($file);
11300: push(@{$current_permissions{$file}},$what);
11301: }
11302: &put('file_permissions',\%current_permissions,$domain,$user);
11303: return;
11304: }
11305:
11306: # ------------------------------------------------------------Save Selected Files
11307:
11308: sub save_selected_files {
11309: my ($user, $path, @files) = @_;
11310: my $filename = $user."savedfiles";
11311: my @other_files = &files_not_in_path($user, $path);
11312: open (OUT,'>',LONCAPA::tempdir().$filename);
11313: foreach my $file (@files) {
11314: print (OUT $env{'form.currentpath'}.$file."\n");
11315: }
11316: foreach my $file (@other_files) {
11317: print (OUT $file."\n");
11318: }
11319: close (OUT);
11320: return 'ok';
11321: }
11322:
11323: sub clear_selected_files {
11324: my ($user) = @_;
11325: my $filename = $user."savedfiles";
11326: open (OUT,'>',LONCAPA::tempdir().$filename);
11327: print (OUT undef);
11328: close (OUT);
11329: return ("ok");
11330: }
11331:
11332: sub files_in_path {
11333: my ($user, $path) = @_;
11334: my $filename = $user."savedfiles";
11335: my %return_files;
11336: open (IN,'<',LONCAPA::tempdir().$filename);
11337: while (my $line_in = <IN>) {
11338: chomp ($line_in);
11339: my @paths_and_file = split (m!/!, $line_in);
11340: my $file_part = pop (@paths_and_file);
11341: my $path_part = join ('/', @paths_and_file);
11342: $path_part.='/';
11343: my $path_and_file = $path_part.$file_part;
11344: if ($path_part eq $path) {
11345: $return_files{$file_part}= 'selected';
11346: }
11347: }
11348: close (IN);
11349: return (\%return_files);
11350: }
11351:
11352: # called in portfolio select mode, to show files selected NOT in current directory
11353: sub files_not_in_path {
11354: my ($user, $path) = @_;
11355: my $filename = $user."savedfiles";
11356: my @return_files;
11357: my $path_part;
11358: open(IN, '<',LONCAPA::tempdir().$filename);
11359: while (my $line = <IN>) {
11360: #ok, I know it's clunky, but I want it to work
11361: my @paths_and_file = split(m|/|, $line);
11362: my $file_part = pop(@paths_and_file);
11363: chomp($file_part);
11364: my $path_part = join('/', @paths_and_file);
11365: $path_part .= '/';
11366: my $path_and_file = $path_part.$file_part;
11367: if ($path_part ne $path) {
11368: push(@return_files, ($path_and_file));
11369: }
11370: }
11371: close(OUT);
11372: return (@return_files);
11373: }
11374:
11375: #------------------------------Submitted/Handedback Portfolio Files Versioning
11376:
11377: sub portfiles_versioning {
11378: my ($symb,$domain,$stu_name,$portfiles,$versioned_portfiles) = @_;
11379: my $portfolio_root = '/userfiles/portfolio';
11380: return unless ((ref($portfiles) eq 'ARRAY') && (ref($versioned_portfiles) eq 'ARRAY'));
11381: foreach my $file (@{$portfiles}) {
11382: &unmark_as_readonly($domain,$stu_name,[$symb,$env{'request.course.id'}],$file);
11383: my ($directory,$answer_file) =($file =~ /^(.*?)([^\/]*)$/);
11384: my ($answer_name,$answer_ver,$answer_ext) = &file_name_version_ext($answer_file);
11385: my $getpropath = 1;
11386: my ($dir_list,$listerror) = &dirlist($portfolio_root.$directory,$domain,
11387: $stu_name,$getpropath);
11388: my $version = &get_next_version($answer_name,$answer_ext,$dir_list);
11389: my $new_answer =
11390: &version_selected_portfile($domain,$stu_name,$directory,$answer_file,$version);
11391: if ($new_answer ne 'problem getting file') {
11392: push(@{$versioned_portfiles}, $directory.$new_answer);
11393: &mark_as_readonly($domain,$stu_name,[$directory.$new_answer],
11394: [$symb,$env{'request.course.id'},'graded']);
11395: }
11396: }
11397: }
11398:
11399: sub get_next_version {
11400: my ($answer_name, $answer_ext, $dir_list) = @_;
11401: my $version;
11402: if (ref($dir_list) eq 'ARRAY') {
11403: foreach my $row (@{$dir_list}) {
11404: my ($file) = split(/\&/,$row,2);
11405: my ($file_name,$file_version,$file_ext) =
11406: &file_name_version_ext($file);
11407: if (($file_name eq $answer_name) &&
11408: ($file_ext eq $answer_ext)) {
11409: # gets here if filename and extension match,
11410: # regardless of version
11411: if ($file_version ne '') {
11412: # a versioned file is found so save it for later
11413: if ($file_version > $version) {
11414: $version = $file_version;
11415: }
11416: }
11417: }
11418: }
11419: }
11420: $version ++;
11421: return($version);
11422: }
11423:
11424: sub version_selected_portfile {
11425: my ($domain,$stu_name,$directory,$file_name,$version) = @_;
11426: my ($answer_name,$answer_ver,$answer_ext) =
11427: &file_name_version_ext($file_name);
11428: my $new_answer;
11429: $env{'form.copy'} =
11430: &getfile("/uploaded/$domain/$stu_name/portfolio$directory$file_name");
11431: if($env{'form.copy'} eq '-1') {
11432: $new_answer = 'problem getting file';
11433: } else {
11434: $new_answer = $answer_name.'.'.$version.'.'.$answer_ext;
11435: my $copy_result =
11436: &finishuserfileupload($stu_name,$domain,'copy',
11437: '/portfolio'.$directory.$new_answer);
11438: }
11439: undef($env{'form.copy'});
11440: return ($new_answer);
11441: }
11442:
11443: sub file_name_version_ext {
11444: my ($file)=@_;
11445: my @file_parts = split(/\./, $file);
11446: my ($name,$version,$ext);
11447: if (@file_parts > 1) {
11448: $ext=pop(@file_parts);
11449: if (@file_parts > 1 && $file_parts[-1] =~ /^\d+$/) {
11450: $version=pop(@file_parts);
11451: }
11452: $name=join('.',@file_parts);
11453: } else {
11454: $name=join('.',@file_parts);
11455: }
11456: return($name,$version,$ext);
11457: }
11458:
11459: #----------------------------------------------Get portfolio file permissions
11460:
11461: sub get_portfile_permissions {
11462: my ($domain,$user) = @_;
11463: my %current_permissions = &dump('file_permissions',$domain,$user);
11464: my ($tmp)=keys(%current_permissions);
11465: if ($tmp=~/^error:/) { undef(%current_permissions); }
11466: return \%current_permissions;
11467: }
11468:
11469: #---------------------------------------------Get portfolio file access controls
11470:
11471: sub get_access_controls {
11472: my ($current_permissions,$group,$file) = @_;
11473: my %access;
11474: my $real_file = $file;
11475: $file =~ s/\.meta$//;
11476: if (defined($file)) {
11477: if (ref($$current_permissions{$file."\0".'accesscontrol'}) eq 'HASH') {
11478: foreach my $control (keys(%{$$current_permissions{$file."\0".'accesscontrol'}})) {
11479: $access{$real_file}{$control} = $$current_permissions{$file."\0".$control};
11480: }
11481: }
11482: } else {
11483: foreach my $key (keys(%{$current_permissions})) {
11484: if ($key =~ /\0accesscontrol$/) {
11485: if (defined($group)) {
11486: if ($key !~ m-^\Q$group\E/-) {
11487: next;
11488: }
11489: }
11490: my ($fullpath) = split(/\0/,$key);
11491: if (ref($$current_permissions{$key}) eq 'HASH') {
11492: foreach my $control (keys(%{$$current_permissions{$key}})) {
11493: $access{$fullpath}{$control}=$$current_permissions{$fullpath."\0".$control};
11494: }
11495: }
11496: }
11497: }
11498: }
11499: return %access;
11500: }
11501:
11502: sub modify_access_controls {
11503: my ($file_name,$changes,$domain,$user)=@_;
11504: my ($outcome,$deloutcome);
11505: my %store_permissions;
11506: my %new_values;
11507: my %new_control;
11508: my %translation;
11509: my @deletions = ();
11510: my $now = time;
11511: if (exists($$changes{'activate'})) {
11512: if (ref($$changes{'activate'}) eq 'HASH') {
11513: my @newitems = sort(keys(%{$$changes{'activate'}}));
11514: my $numnew = scalar(@newitems);
11515: for (my $i=0; $i<$numnew; $i++) {
11516: my $newkey = $newitems[$i];
11517: my $newid = &Apache::loncommon::get_cgi_id();
11518: if ($newkey =~ /^\d+:/) {
11519: $newkey =~ s/^(\d+)/$newid/;
11520: $translation{$1} = $newid;
11521: } elsif ($newkey =~ /^\d+_\d+_\d+:/) {
11522: $newkey =~ s/^(\d+_\d+_\d+)/$newid/;
11523: $translation{$1} = $newid;
11524: }
11525: $new_values{$file_name."\0".$newkey} =
11526: $$changes{'activate'}{$newitems[$i]};
11527: $new_control{$newkey} = $now;
11528: }
11529: }
11530: }
11531: my %todelete;
11532: my %changed_items;
11533: foreach my $action ('delete','update') {
11534: if (exists($$changes{$action})) {
11535: if (ref($$changes{$action}) eq 'HASH') {
11536: foreach my $key (keys(%{$$changes{$action}})) {
11537: my ($itemnum) = ($key =~ /^([^:]+):/);
11538: if ($action eq 'delete') {
11539: $todelete{$itemnum} = 1;
11540: } else {
11541: $changed_items{$itemnum} = $key;
11542: }
11543: }
11544: }
11545: }
11546: }
11547: # get lock on access controls for file.
11548: my $lockhash = {
11549: $file_name."\0".'locked_access_records' => $env{'user.name'}.
11550: ':'.$env{'user.domain'},
11551: };
11552: my $tries = 0;
11553: my $gotlock = &newput('file_permissions',$lockhash,$domain,$user);
11554:
11555: while (($gotlock ne 'ok') && $tries < 10) {
11556: $tries ++;
11557: sleep(0.1);
11558: $gotlock = &newput('file_permissions',$lockhash,$domain,$user);
11559: }
11560: if ($gotlock eq 'ok') {
11561: my %curr_permissions = &dump('file_permissions',$domain,$user,$file_name);
11562: my ($tmp)=keys(%curr_permissions);
11563: if ($tmp=~/^error:/) { undef(%curr_permissions); }
11564: if (exists($curr_permissions{$file_name."\0".'accesscontrol'})) {
11565: my $curr_controls = $curr_permissions{$file_name."\0".'accesscontrol'};
11566: if (ref($curr_controls) eq 'HASH') {
11567: foreach my $control_item (keys(%{$curr_controls})) {
11568: my ($itemnum) = ($control_item =~ /^([^:]+):/);
11569: if (defined($todelete{$itemnum})) {
11570: push(@deletions,$file_name."\0".$control_item);
11571: } else {
11572: if (defined($changed_items{$itemnum})) {
11573: $new_control{$changed_items{$itemnum}} = $now;
11574: push(@deletions,$file_name."\0".$control_item);
11575: $new_values{$file_name."\0".$changed_items{$itemnum}} = $$changes{'update'}{$changed_items{$itemnum}};
11576: } else {
11577: $new_control{$control_item} = $$curr_controls{$control_item};
11578: }
11579: }
11580: }
11581: }
11582: }
11583: my ($group);
11584: if (&is_course($domain,$user)) {
11585: ($group,my $file) = split(/\//,$file_name,2);
11586: }
11587: $deloutcome = &del('file_permissions',\@deletions,$domain,$user);
11588: $new_values{$file_name."\0".'accesscontrol'} = \%new_control;
11589: $outcome = &put('file_permissions',\%new_values,$domain,$user);
11590: # remove lock
11591: my @del_lock = ($file_name."\0".'locked_access_records');
11592: my $dellockoutcome = &del('file_permissions',\@del_lock,$domain,$user);
11593: my $sqlresult =
11594: &update_portfolio_table($user,$domain,$file_name,'portfolio_access',
11595: $group);
11596: } else {
11597: $outcome = "error: could not obtain lockfile\n";
11598: }
11599: return ($outcome,$deloutcome,\%new_values,\%translation);
11600: }
11601:
11602: sub make_public_indefinitely {
11603: my (@requrl) = @_;
11604: return &automated_portfile_access('public',\@requrl);
11605: }
11606:
11607: sub automated_portfile_access {
11608: my ($accesstype,$addsref,$delsref,$info) = @_;
11609: unless (($accesstype eq 'public') || ($accesstype eq 'ip')) {
11610: return 'invalid';
11611: }
11612: my %urls;
11613: if (ref($addsref) eq 'ARRAY') {
11614: foreach my $requrl (@{$addsref}) {
11615: if (&is_portfolio_url($requrl)) {
11616: unless (exists($urls{$requrl})) {
11617: $urls{$requrl} = 'add';
11618: }
11619: }
11620: }
11621: }
11622: if (ref($delsref) eq 'ARRAY') {
11623: foreach my $requrl (@{$delsref}) {
11624: if (&is_portfolio_url($requrl)) {
11625: unless (exists($urls{$requrl})) {
11626: $urls{$requrl} = 'delete';
11627: }
11628: }
11629: }
11630: }
11631: unless (keys(%urls)) {
11632: return 'invalid';
11633: }
11634: my $ip;
11635: if ($accesstype eq 'ip') {
11636: if (ref($info) eq 'HASH') {
11637: if ($info->{'ip'} ne '') {
11638: $ip = $info->{'ip'};
11639: }
11640: }
11641: if ($ip eq '') {
11642: return 'invalid';
11643: }
11644: }
11645: my $errors;
11646: my $now = time;
11647: my %current_perms;
11648: foreach my $requrl (sort(keys(%urls))) {
11649: my $action;
11650: if ($urls{$requrl} eq 'add') {
11651: $action = 'activate';
11652: } else {
11653: $action = 'none';
11654: }
11655: my $aclnum = 0;
11656: my (undef,$udom,$unum,$file_name,$group) =
11657: &parse_portfolio_url($requrl);
11658: unless (exists($current_perms{$unum.':'.$udom})) {
11659: $current_perms{$unum.':'.$udom} = &get_portfile_permissions($udom,$unum);
11660: }
11661: my %access_controls = &get_access_controls($current_perms{$unum.':'.$udom},
11662: $group,$file_name);
11663: foreach my $key (keys(%{$access_controls{$file_name}})) {
11664: my ($num,$scope,$end,$start) =
11665: ($key =~ /^([^:]+):([a-z]+)_(\d*)_?(\d*)$/);
11666: if ($scope eq $accesstype) {
11667: if (($start <= $now) && ($end == 0)) {
11668: if ($accesstype eq 'ip') {
11669: if (ref($access_controls{$file_name}{$key}) eq 'HASH') {
11670: if (ref($access_controls{$file_name}{$key}{'ip'}) eq 'ARRAY') {
11671: if (grep(/^\Q$ip\E$/,@{$access_controls{$file_name}{$key}{'ip'}})) {
11672: if ($urls{$requrl} eq 'add') {
11673: $action = 'none';
11674: last;
11675: } else {
11676: $action = 'delete';
11677: $aclnum = $num;
11678: last;
11679: }
11680: }
11681: }
11682: }
11683: } elsif ($accesstype eq 'public') {
11684: if ($urls{$requrl} eq 'add') {
11685: $action = 'none';
11686: last;
11687: } else {
11688: $action = 'delete';
11689: $aclnum = $num;
11690: last;
11691: }
11692: }
11693: } elsif ($accesstype eq 'public') {
11694: $action = 'update';
11695: $aclnum = $num;
11696: last;
11697: }
11698: }
11699: }
11700: if ($action eq 'none') {
11701: next;
11702: } else {
11703: my %changes;
11704: my $newend = 0;
11705: my $newstart = $now;
11706: my $newkey = $aclnum.':'.$accesstype.'_'.$newend.'_'.$newstart;
11707: $changes{$action}{$newkey} = {
11708: type => $accesstype,
11709: time => {
11710: start => $newstart,
11711: end => $newend,
11712: },
11713: };
11714: if ($accesstype eq 'ip') {
11715: $changes{$action}{$newkey}{'ip'} = [$ip];
11716: }
11717: my ($outcome,$deloutcome,$new_values,$translation) =
11718: &modify_access_controls($file_name,\%changes,$udom,$unum);
11719: unless ($outcome eq 'ok') {
11720: $errors .= $outcome.' ';
11721: }
11722: }
11723: }
11724: if ($errors) {
11725: $errors =~ s/\s$//;
11726: return $errors;
11727: } else {
11728: return 'ok';
11729: }
11730: }
11731:
11732: #------------------------------------------------------Get Marked as Read Only
11733:
11734: sub get_marked_as_readonly {
11735: my ($domain,$user,$what,$group) = @_;
11736: my $current_permissions = &get_portfile_permissions($domain,$user);
11737: my @readonly_files;
11738: my $cmp1=$what;
11739: if (ref($what)) { $cmp1=join('',@{$what}) };
11740: while (my ($file_name,$value) = each(%{$current_permissions})) {
11741: if (defined($group)) {
11742: if ($file_name !~ m-^\Q$group\E/-) {
11743: next;
11744: }
11745: }
11746: if (ref($value) eq "ARRAY"){
11747: foreach my $stored_what (@{$value}) {
11748: my $cmp2=$stored_what;
11749: if (ref($stored_what) eq 'ARRAY') {
11750: $cmp2=join('',@{$stored_what});
11751: }
11752: if ($cmp1 eq $cmp2) {
11753: push(@readonly_files, $file_name);
11754: last;
11755: } elsif (!defined($what)) {
11756: push(@readonly_files, $file_name);
11757: last;
11758: }
11759: }
11760: }
11761: }
11762: return @readonly_files;
11763: }
11764: #-----------------------------------------------------------Get Marked as Read Only Hash
11765:
11766: sub get_marked_as_readonly_hash {
11767: my ($current_permissions,$group,$what) = @_;
11768: my %readonly_files;
11769: while (my ($file_name,$value) = each(%{$current_permissions})) {
11770: if (defined($group)) {
11771: if ($file_name !~ m-^\Q$group\E/-) {
11772: next;
11773: }
11774: }
11775: if (ref($value) eq "ARRAY"){
11776: foreach my $stored_what (@{$value}) {
11777: if (ref($stored_what) eq 'ARRAY') {
11778: foreach my $lock_descriptor(@{$stored_what}) {
11779: if ($lock_descriptor eq 'graded') {
11780: $readonly_files{$file_name} = 'graded';
11781: } elsif ($lock_descriptor eq 'handback') {
11782: $readonly_files{$file_name} = 'handback';
11783: } else {
11784: if (!exists($readonly_files{$file_name})) {
11785: $readonly_files{$file_name} = 'locked';
11786: }
11787: }
11788: }
11789: }
11790: }
11791: }
11792: }
11793: return %readonly_files;
11794: }
11795: # ------------------------------------------------------------ Unmark as Read Only
11796:
11797: sub unmark_as_readonly {
11798: # unmarks $file_name (if $file_name is defined), or all files locked by $what
11799: # for portfolio submissions, $what contains [$symb,$crsid]
11800: my ($domain,$user,$what,$file_name,$group) = @_;
11801: $file_name = &declutter_portfile($file_name);
11802: my $symb_crs = $what;
11803: if (ref($what)) { $symb_crs=join('',@$what); }
11804: my %current_permissions = &dump('file_permissions',$domain,$user,$group);
11805: my ($tmp)=keys(%current_permissions);
11806: if ($tmp=~/^error:/) { undef(%current_permissions); }
11807: my @readonly_files = &get_marked_as_readonly($domain,$user,$what,$group);
11808: foreach my $file (@readonly_files) {
11809: my $clean_file = &declutter_portfile($file);
11810: if (defined($file_name) && ($file_name ne $clean_file)) { next; }
11811: my $current_locks = $current_permissions{$file};
11812: my @new_locks;
11813: my @del_keys;
11814: if (ref($current_locks) eq "ARRAY"){
11815: foreach my $locker (@{$current_locks}) {
11816: my $compare=$locker;
11817: if (ref($locker) eq 'ARRAY') {
11818: $compare=join('',@{$locker});
11819: if ($compare ne $symb_crs) {
11820: push(@new_locks, $locker);
11821: }
11822: }
11823: }
11824: if (scalar(@new_locks) > 0) {
11825: $current_permissions{$file} = \@new_locks;
11826: } else {
11827: push(@del_keys, $file);
11828: &del('file_permissions',\@del_keys, $domain, $user);
11829: delete($current_permissions{$file});
11830: }
11831: }
11832: }
11833: &put('file_permissions',\%current_permissions,$domain,$user);
11834: return;
11835: }
11836:
11837: # ------------------------------------------------------------ Directory lister
11838:
11839: sub dirlist {
11840: my ($uri,$userdomain,$username,$getpropath,$getuserdir,$alternateRoot)=@_;
11841: $uri=~s/^\///;
11842: $uri=~s/\/$//;
11843: my ($udom, $uname);
11844: if ($getuserdir) {
11845: $udom = $userdomain;
11846: $uname = $username;
11847: } else {
11848: (undef,$udom,$uname)=split(/\//,$uri);
11849: if(defined($userdomain)) {
11850: $udom = $userdomain;
11851: }
11852: if(defined($username)) {
11853: $uname = $username;
11854: }
11855: }
11856: my ($dirRoot,$listing,@listing_results);
11857:
11858: $dirRoot = $perlvar{'lonDocRoot'};
11859: if (defined($getpropath)) {
11860: $dirRoot = &propath($udom,$uname);
11861: $dirRoot =~ s/\/$//;
11862: } elsif (defined($getuserdir)) {
11863: my $subdir=$uname.'__';
11864: $subdir =~ s/(.)(.)(.).*/$1\/$2\/$3/;
11865: $dirRoot = $Apache::lonnet::perlvar{'lonUsersDir'}
11866: ."/$udom/$subdir/$uname";
11867: } elsif (defined($alternateRoot)) {
11868: $dirRoot = $alternateRoot;
11869: }
11870:
11871: if($udom) {
11872: if($uname) {
11873: my $uhome = &homeserver($uname,$udom);
11874: if ($uhome eq 'no_host') {
11875: return ([],'no_host');
11876: }
11877: $listing = &reply('ls3:'.&escape('/'.$uri).':'.$getpropath.':'
11878: .$getuserdir.':'.&escape($dirRoot)
11879: .':'.&escape($uname).':'.&escape($udom),$uhome);
11880: if ($listing eq 'unknown_cmd') {
11881: $listing = &reply('ls2:'.$dirRoot.'/'.$uri,$uhome);
11882: } else {
11883: @listing_results = map { &unescape($_); } split(/:/,$listing);
11884: }
11885: if ($listing eq 'unknown_cmd') {
11886: $listing = &reply('ls:'.$dirRoot.'/'.$uri,$uhome);
11887: @listing_results = split(/:/,$listing);
11888: } else {
11889: @listing_results = map { &unescape($_); } split(/:/,$listing);
11890: }
11891: if (($listing eq 'no_such_host') || ($listing eq 'con_lost') ||
11892: ($listing eq 'rejected') || ($listing eq 'refused') ||
11893: ($listing eq 'no_such_dir') || ($listing eq 'empty')) {
11894: return ([],$listing);
11895: } else {
11896: return (\@listing_results);
11897: }
11898: } elsif(!$alternateRoot) {
11899: my (%allusers,%listerror);
11900: my %servers = &get_servers($udom,'library');
11901: foreach my $tryserver (keys(%servers)) {
11902: $listing = &reply('ls3:'.&escape("/res/$udom").':::::'.
11903: &escape($udom),$tryserver);
11904: if ($listing eq 'unknown_cmd') {
11905: $listing = &reply('ls2:'.$perlvar{'lonDocRoot'}.'/res/'.
11906: $udom, $tryserver);
11907: } else {
11908: @listing_results = map { &unescape($_); } split(/:/,$listing);
11909: }
11910: if ($listing eq 'unknown_cmd') {
11911: $listing = &reply('ls:'.$perlvar{'lonDocRoot'}.'/res/'.
11912: $udom, $tryserver);
11913: @listing_results = split(/:/,$listing);
11914: } else {
11915: @listing_results =
11916: map { &unescape($_); } split(/:/,$listing);
11917: }
11918: if (($listing eq 'no_such_host') || ($listing eq 'con_lost') ||
11919: ($listing eq 'rejected') || ($listing eq 'refused') ||
11920: ($listing eq 'no_such_dir') || ($listing eq 'empty')) {
11921: $listerror{$tryserver} = $listing;
11922: } else {
11923: foreach my $line (@listing_results) {
11924: my ($entry) = split(/&/,$line,2);
11925: $allusers{$entry} = 1;
11926: }
11927: }
11928: }
11929: my @alluserslist=();
11930: foreach my $user (sort(keys(%allusers))) {
11931: push(@alluserslist,$user.'&user');
11932: }
11933:
11934: if (!%listerror) {
11935: # no errors
11936: return (\@alluserslist);
11937: } elsif (scalar(keys(%servers)) == 1) {
11938: # one library server, one error
11939: my ($key) = keys(%listerror);
11940: return (\@alluserslist, $listerror{$key});
11941: } elsif ( grep { $_ eq 'con_lost' } values(%listerror) ) {
11942: # con_lost indicates that we might miss data from at least one
11943: # library server
11944: return (\@alluserslist, 'con_lost');
11945: } else {
11946: # multiple library servers and no con_lost -> data should be
11947: # complete.
11948: return (\@alluserslist);
11949: }
11950:
11951: } else {
11952: return ([],'missing username');
11953: }
11954: } elsif(!defined($getpropath)) {
11955: my $path = $perlvar{'lonDocRoot'}.'/res/';
11956: my @all_domains = map { $path.$_.'/&domain'; } (sort(&all_domains()));
11957: return (\@all_domains);
11958: } else {
11959: return ([],'missing domain');
11960: }
11961: }
11962:
11963: # --------------------------------------------- GetFileTimestamp
11964: # This function utilizes dirlist and returns the date stamp for
11965: # when it was last modified. It will also return an error of -1
11966: # if an error occurs
11967:
11968: sub GetFileTimestamp {
11969: my ($studentDomain,$studentName,$filename,$getuserdir)=@_;
11970: $studentDomain = &LONCAPA::clean_domain($studentDomain);
11971: $studentName = &LONCAPA::clean_username($studentName);
11972: my ($fileref,$error) = &dirlist($filename,$studentDomain,$studentName,
11973: undef,$getuserdir);
11974: if (($error eq 'empty') || ($error eq 'no_such_dir')) {
11975: return -1;
11976: }
11977: if (ref($fileref) eq 'ARRAY') {
11978: my @stats = split('&',$fileref->[0]);
11979: # @stats contains first the filename, then the stat output
11980: return $stats[10]; # so this is 10 instead of 9.
11981: } else {
11982: return -1;
11983: }
11984: }
11985:
11986: sub stat_file {
11987: my ($uri) = @_;
11988: $uri = &clutter_with_no_wrapper($uri);
11989:
11990: my ($udom,$uname,$file);
11991: if ($uri =~ m-^/(uploaded|editupload)/-) {
11992: ($udom,$uname,$file) =
11993: ($uri =~ m-/(?:uploaded|editupload)/?($match_domain)/?($match_name)/?(.*)-);
11994: $file = 'userfiles/'.$file;
11995: }
11996: if ($uri =~ m-^/res/-) {
11997: ($udom,$uname) =
11998: ($uri =~ m-/(?:res)/?($match_domain)/?($match_username)/-);
11999: $file = $uri;
12000: }
12001:
12002: if (!$udom || !$uname || !$file) {
12003: # unable to handle the uri
12004: return ();
12005: }
12006: my $getpropath;
12007: if ($file =~ /^userfiles\//) {
12008: $getpropath = 1;
12009: }
12010: my ($listref,$error) = &dirlist($file,$udom,$uname,$getpropath);
12011: if (($error eq 'empty') || ($error eq 'no_such_dir')) {
12012: return ();
12013: } else {
12014: if (ref($listref) eq 'ARRAY') {
12015: my @stats = split('&',$listref->[0]);
12016: shift(@stats); #filename is first
12017: return @stats;
12018: }
12019: }
12020: return ();
12021: }
12022:
12023: # --------------------------------------------------------- recursedirs
12024: # Recursive function to traverse either a specific user's Authoring Space
12025: # or corresponding Published Resource Space, and populate the hash ref:
12026: # $dirhashref with URLs of all directories, and if $filehashref hash
12027: # ref arg is provided, the URLs of any files, excluding versioned, .meta,
12028: # or .rights files in resource space, and .meta, .save, .log, and .bak
12029: # files in Authoring Space.
12030: #
12031: # Inputs:
12032: #
12033: # $is_home - true if current server is home server for user's space
12034: # $context - either: priv, or res respectively for Authoring or Resource Space.
12035: # $docroot - Document root (i.e., /home/httpd/html
12036: # $toppath - Top level directory (i.e., /res/$dom/$uname or /priv/$dom/$uname
12037: # $relpath - Current path (relative to top level).
12038: # $dirhashref - reference to hash to populate with URLs of directories (Required)
12039: # $filehashref - reference to hash to populate with URLs of files (Optional)
12040: #
12041: # Returns: nothing
12042: #
12043: # Side Effects: populates $dirhashref, and $filehashref (if provided).
12044: #
12045: # Currently used by interface/londocs.pm to create linked select boxes for
12046: # directory and filename to import a Course "Author" resource into a course, and
12047: # also to create linked select boxes for Authoring Space and Directory to choose
12048: # save location for creation of a new "standard" problem from the Course Editor.
12049: #
12050:
12051: sub recursedirs {
12052: my ($is_home,$context,$docroot,$toppath,$relpath,$dirhashref,$filehashref) = @_;
12053: return unless (ref($dirhashref) eq 'HASH');
12054: my $currpath = $docroot.$toppath;
12055: if ($relpath) {
12056: $currpath .= "/$relpath";
12057: }
12058: my $savefile;
12059: if (ref($filehashref)) {
12060: $savefile = 1;
12061: }
12062: if ($is_home) {
12063: if (opendir(my $dirh,$currpath)) {
12064: foreach my $item (sort { lc($a) cmp lc($b) } grep(!/^\.+$/,readdir($dirh))) {
12065: next if ($item eq '');
12066: if (-d "$currpath/$item") {
12067: my $newpath;
12068: if ($relpath) {
12069: $newpath = "$relpath/$item";
12070: } else {
12071: $newpath = $item;
12072: }
12073: $dirhashref->{&Apache::lonlocal::js_escape($newpath)} = 1;
12074: &recursedirs($is_home,$context,$docroot,$toppath,$newpath,$dirhashref,$filehashref);
12075: } elsif ($savefile) {
12076: if ($context eq 'priv') {
12077: unless ($item =~ /\.(meta|save|log|bak|DS_Store)$/) {
12078: $filehashref->{&Apache::lonlocal::js_escape($relpath)}{$item} = 1;
12079: }
12080: } else {
12081: unless (($item =~ /\.meta$/) || ($item =~ /\.\d+\.\w+$/) || ($item =~ /\.rights$/)) {
12082: $filehashref->{&Apache::lonlocal::js_escape($relpath)}{$item} = 1;
12083: }
12084: }
12085: }
12086: }
12087: closedir($dirh);
12088: }
12089: } else {
12090: my ($dirlistref,$listerror) =
12091: &dirlist($toppath.$relpath);
12092: my @dir_lines;
12093: my $dirptr=16384;
12094: if (ref($dirlistref) eq 'ARRAY') {
12095: foreach my $dir_line (sort
12096: {
12097: my ($afile)=split('&',$a,2);
12098: my ($bfile)=split('&',$b,2);
12099: return (lc($afile) cmp lc($bfile));
12100: } (@{$dirlistref})) {
12101: my ($item,$dom,undef,$testdir,undef,undef,undef,undef,$size,undef,$mtime,undef,undef,undef,$obs,undef) =
12102: split(/\&/,$dir_line,16);
12103: $item =~ s/\s+$//;
12104: next if (($item =~ /^\.\.?$/) || ($obs));
12105: if ($dirptr&$testdir) {
12106: my $newpath;
12107: if ($relpath) {
12108: $newpath = "$relpath/$item";
12109: } else {
12110: $relpath = '/';
12111: $newpath = $item;
12112: }
12113: $dirhashref->{&Apache::lonlocal::js_escape($newpath)} = 1;
12114: &recursedirs($is_home,$context,$docroot,$toppath,$newpath,$dirhashref,$filehashref);
12115: } elsif ($savefile) {
12116: if ($context eq 'priv') {
12117: unless ($item =~ /\.(meta|save|log|bak|DS_Store)$/) {
12118: $filehashref->{$relpath}{$item} = 1;
12119: }
12120: } else {
12121: unless (($item =~ /\.meta$/) || ($item =~ /\.\d+\.\w+$/)) {
12122: $filehashref->{$relpath}{$item} = 1;
12123: }
12124: }
12125: }
12126: }
12127: }
12128: }
12129: return;
12130: }
12131:
12132: # -------------------------------------------------------- Value of a Condition
12133:
12134: # gets the value of a specific preevaluated condition
12135: # stored in the string $env{user.state.<cid>}
12136: # or looks up a condition reference in the bighash and if if hasn't
12137: # already been evaluated recurses into docondval to get the value of
12138: # the condition, then memoizing it to
12139: # $env{user.state.<cid>.<condition>}
12140: sub directcondval {
12141: my $number=shift;
12142: if (!defined($env{'user.state.'.$env{'request.course.id'}})) {
12143: &Apache::lonuserstate::evalstate();
12144: }
12145: if (exists($env{'user.state.'.$env{'request.course.id'}.".$number"})) {
12146: return $env{'user.state.'.$env{'request.course.id'}.".$number"};
12147: } elsif ($number =~ /^_/) {
12148: my $sub_condition;
12149: if (tie(my %bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
12150: &GDBM_READER(),0640)) {
12151: $sub_condition=$bighash{'conditions'.$number};
12152: untie(%bighash);
12153: }
12154: my $value = &docondval($sub_condition);
12155: &appenv({'user.state.'.$env{'request.course.id'}.".$number" => $value});
12156: return $value;
12157: }
12158: if ($env{'user.state.'.$env{'request.course.id'}}) {
12159: return substr($env{'user.state.'.$env{'request.course.id'}},$number,1);
12160: } else {
12161: return 2;
12162: }
12163: }
12164:
12165: # get the collection of conditions for this resource
12166: sub condval {
12167: my $condidx=shift;
12168: my $allpathcond='';
12169: foreach my $cond (split(/\|/,$condidx)) {
12170: if (defined($env{'acc.cond.'.$env{'request.course.id'}.'.'.$cond})) {
12171: $allpathcond.=
12172: '('.$env{'acc.cond.'.$env{'request.course.id'}.'.'.$cond}.')|';
12173: }
12174: }
12175: $allpathcond=~s/\|$//;
12176: return &docondval($allpathcond);
12177: }
12178:
12179: #evaluates an expression of conditions
12180: sub docondval {
12181: my ($allpathcond) = @_;
12182: my $result=0;
12183: if ($env{'request.course.id'}
12184: && defined($allpathcond)) {
12185: my $operand='|';
12186: my @stack;
12187: foreach my $chunk ($allpathcond=~/(\d+|_\d+\.\d+|\(|\)|\&|\|)/g) {
12188: if ($chunk eq '(') {
12189: push @stack,($operand,$result);
12190: } elsif ($chunk eq ')') {
12191: my $before=pop @stack;
12192: if (pop @stack eq '&') {
12193: $result=$result>$before?$before:$result;
12194: } else {
12195: $result=$result>$before?$result:$before;
12196: }
12197: } elsif (($chunk eq '&') || ($chunk eq '|')) {
12198: $operand=$chunk;
12199: } else {
12200: my $new=directcondval($chunk);
12201: if ($operand eq '&') {
12202: $result=$result>$new?$new:$result;
12203: } else {
12204: $result=$result>$new?$result:$new;
12205: }
12206: }
12207: }
12208: }
12209: return $result;
12210: }
12211:
12212: # ---------------------------------------------------- Devalidate courseresdata
12213:
12214: sub devalidatecourseresdata {
12215: my ($coursenum,$coursedomain)=@_;
12216: my $hashid=$coursenum.':'.$coursedomain;
12217: &devalidate_cache_new('courseres',$hashid);
12218: }
12219:
12220:
12221: # --------------------------------------------------- Course Resourcedata Query
12222: #
12223: # Parameters:
12224: # $coursenum - Number of the course.
12225: # $coursedomain - Domain at which the course was created.
12226: # Returns:
12227: # A hash of the course parameters along (I think) with timestamps
12228: # and version info.
12229:
12230: sub get_courseresdata {
12231: my ($coursenum,$coursedomain)=@_;
12232: my $coursehom=&homeserver($coursenum,$coursedomain);
12233: my $hashid=$coursenum.':'.$coursedomain;
12234: my ($result,$cached)=&is_cached_new('courseres',$hashid);
12235: my %dumpreply;
12236: unless (defined($cached)) {
12237: %dumpreply=&dump('resourcedata',$coursedomain,$coursenum);
12238: $result=\%dumpreply;
12239: my ($tmp) = keys(%dumpreply);
12240: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
12241: &do_cache_new('courseres',$hashid,$result,600);
12242: } elsif ($tmp =~ /^(con_lost|no_such_host)/) {
12243: return $tmp;
12244: } elsif ($tmp =~ /^(error)/) {
12245: $result=undef;
12246: &do_cache_new('courseres',$hashid,$result,600);
12247: }
12248: }
12249: return $result;
12250: }
12251:
12252: sub devalidateuserresdata {
12253: my ($uname,$udom)=@_;
12254: my $hashid="$udom:$uname";
12255: &devalidate_cache_new('userres',$hashid);
12256: }
12257:
12258: sub get_userresdata {
12259: my ($uname,$udom)=@_;
12260: #most student don\'t have any data set, check if there is some data
12261: if (&EXT_cache_status($udom,$uname)) { return undef; }
12262:
12263: my $hashid="$udom:$uname";
12264: my ($result,$cached)=&is_cached_new('userres',$hashid);
12265: if (!defined($cached)) {
12266: my %resourcedata=&dump('resourcedata',$udom,$uname);
12267: $result=\%resourcedata;
12268: &do_cache_new('userres',$hashid,$result,600);
12269: }
12270: my ($tmp)=keys(%$result);
12271: if (($tmp!~/^error\:/) && ($tmp!~/^con_lost/)) {
12272: return $result;
12273: }
12274: #error 2 occurs when the .db doesn't exist
12275: if ($tmp!~/error: 2 /) {
12276: if ((!defined($cached)) || ($tmp ne 'con_lost')) {
12277: &logthis("<font color=\"blue\">WARNING:".
12278: " Trying to get resource data for ".
12279: $uname." at ".$udom.": ".
12280: $tmp."</font>");
12281: }
12282: } elsif ($tmp=~/error: 2 /) {
12283: #&EXT_cache_set($udom,$uname);
12284: &do_cache_new('userres',$hashid,undef,600);
12285: undef($tmp); # not really an error so don't send it back
12286: }
12287: return $tmp;
12288: }
12289: #----------------------------------------------- resdata - return resource data
12290: # Purpose:
12291: # Return resource data for either users or for a course.
12292: # Parameters:
12293: # $name - Course/user name.
12294: # $domain - Name of the domain the user/course is registered on.
12295: # $type - Type of thing $name is (must be 'course' or 'user')
12296: # $mapp - decluttered URL of enclosing map
12297: # $recursed - Ref to scalar -- set to 1, if nested maps have been recursed.
12298: # $recurseup - Ref to array of map URLs, starting with map containing
12299: # $mapp up through hierarchy of nested maps to top level map.
12300: # $courseid - CourseID (first part of param identifier).
12301: # $modifier - Middle part of param identifier.
12302: # $what - Last part of param identifier.
12303: # @which - Array of names of resources desired.
12304: # Returns:
12305: # The value of the first reasource in @which that is found in the
12306: # resource hash.
12307: # Exceptional Conditions:
12308: # If the $type passed in is not valid (not the string 'course' or
12309: # 'user', an undefined reference is returned.
12310: # If none of the resources are found, an undef is returned
12311: sub resdata {
12312: my ($name,$domain,$type,$mapp,$recursed,$recurseup,$courseid,
12313: $modifier,$what,@which)=@_;
12314: my $result;
12315: if ($type eq 'course') {
12316: $result=&get_courseresdata($name,$domain);
12317: } elsif ($type eq 'user') {
12318: $result=&get_userresdata($name,$domain);
12319: }
12320: if (!ref($result)) { return $result; }
12321: foreach my $item (@which) {
12322: if ($item->[1] eq 'course') {
12323: if ((ref($recurseup) eq 'ARRAY') && (ref($recursed) eq 'SCALAR')) {
12324: unless ($$recursed) {
12325: @{$recurseup} = &get_map_hierarchy($mapp,$courseid);
12326: $$recursed = 1;
12327: }
12328: foreach my $item (@${recurseup}) {
12329: my $norecursechk=$courseid.$modifier.$item.'___(all).'.$what;
12330: last if (defined($result->{$norecursechk}));
12331: my $recursechk=$courseid.$modifier.$item.'___(rec).'.$what;
12332: if (defined($result->{$recursechk})) { return [$result->{$recursechk},'map']; }
12333: }
12334: }
12335: }
12336: if (defined($result->{$item->[0]})) {
12337: return [$result->{$item->[0]},$item->[1]];
12338: }
12339: }
12340: return undef;
12341: }
12342:
12343: sub get_domain_lti {
12344: my ($cdom,$context) = @_;
12345: my ($name,$cachename,%lti);
12346: if ($context eq 'consumer') {
12347: $name = 'ltitools';
12348: } elsif ($context eq 'provider') {
12349: $name = 'lti';
12350: } elsif ($context eq 'linkprot') {
12351: $name = 'ltisec';
12352: } else {
12353: return %lti;
12354: }
12355:
12356: if ($context eq 'linkprot') {
12357: $cachename = $context;
12358: } else {
12359: $cachename = $name;
12360: }
12361:
12362: my ($result,$cached)=&is_cached_new($cachename,$cdom);
12363: if (defined($cached)) {
12364: if (ref($result) eq 'HASH') {
12365: %lti = %{$result};
12366: }
12367: } else {
12368: my %domconfig = &get_dom('configuration',[$name],$cdom);
12369: if (ref($domconfig{$name}) eq 'HASH') {
12370: if ($context eq 'linkprot') {
12371: if (ref($domconfig{$name}{'linkprot'}) eq 'HASH') {
12372: %lti = %{$domconfig{$name}{'linkprot'}};
12373: }
12374: } else {
12375: %lti = %{$domconfig{$name}};
12376: }
12377: if (($context eq 'consumer') && (keys(%lti))) {
12378: my %encdomconfig = &get_dom('encconfig',[$name],$cdom,undef,1);
12379: if (ref($encdomconfig{$name}) eq 'HASH') {
12380: foreach my $id (keys(%lti)) {
12381: if (ref($encdomconfig{$name}{$id}) eq 'HASH') {
12382: foreach my $item ('key','secret') {
12383: $lti{$id}{$item} = $encdomconfig{$name}{$id}{$item};
12384: }
12385: }
12386: }
12387: }
12388: }
12389: }
12390: my $cachetime = 24*60*60;
12391: &do_cache_new($cachename,$cdom,\%lti,$cachetime);
12392: }
12393: return %lti;
12394: }
12395:
12396: sub get_course_lti {
12397: my ($cnum,$cdom) = @_;
12398: my $hashid=$cdom.'_'.$cnum;
12399: my %courselti;
12400: my ($result,$cached)=&is_cached_new('courselti',$hashid);
12401: if (defined($cached)) {
12402: if (ref($result) eq 'HASH') {
12403: %courselti = %{$result};
12404: }
12405: } else {
12406: %courselti = &dump('lti',$cdom,$cnum,undef,undef,undef,1);
12407: my $cachetime = 24*60*60;
12408: &do_cache_new('courselti',$hashid,\%courselti,$cachetime);
12409: }
12410: return %courselti;
12411: }
12412:
12413: sub courselti_itemid {
12414: my ($cnum,$cdom,$url,$method,$params,$context) = @_;
12415: my ($chome,$itemid);
12416: $chome = &homeserver($cnum,$cdom);
12417: return if ($chome eq 'no_host');
12418: if (ref($params) eq 'HASH') {
12419: my $rep;
12420: if (grep { $_ eq $chome } current_machine_ids()) {
12421: $rep = LONCAPA::Lond::crslti_itemid($cdom,$cnum,$url,$method,$params,$perlvar{'lonVersion'});
12422: } else {
12423: my $escurl = &escape($url);
12424: my $escmethod = &escape($method);
12425: my $items = &freeze_escape($params);
12426: $rep = &reply("encrypt:lti:$cdom:$cnum:$context:$escurl:$escmethod:$items",$chome);
12427: }
12428: unless (($rep=~/^(refused|rejected|error)/) || ($rep eq 'con_lost') ||
12429: ($rep eq 'unknown_cmd')) {
12430: $itemid = $rep;
12431: }
12432: }
12433: return $itemid;
12434: }
12435:
12436: sub domainlti_itemid {
12437: my ($cdom,$url,$method,$params,$context) = @_;
12438: my ($primary_id,$itemid);
12439: $primary_id = &domain($cdom,'primary');
12440: return if ($primary_id eq '');
12441: if (ref($params) eq 'HASH') {
12442: my $rep;
12443: if (grep { $_ eq $primary_id } current_machine_ids()) {
12444: $rep = LONCAPA::Lond::domlti_itemid($cdom,$context,$url,$method,$params,$perlvar{'lonVersion'});
12445: } else {
12446: my $cnum = '';
12447: my $escurl = &escape($url);
12448: my $escmethod = &escape($method);
12449: my $items = &freeze_escape($params);
12450: $rep = &reply("encrypt:lti:$cdom:$cnum:$context:$escurl:$escmethod:$items",$primary_id);
12451: }
12452: unless (($rep=~/^(refused|rejected|error)/) || ($rep eq 'con_lost') ||
12453: ($rep eq 'unknown_cmd')) {
12454: $itemid = $rep;
12455: }
12456: }
12457: return $itemid;
12458: }
12459:
12460: sub get_numsuppfiles {
12461: my ($cnum,$cdom,$ignorecache)=@_;
12462: my $hashid=$cnum.':'.$cdom;
12463: my ($suppcount,$cached);
12464: unless ($ignorecache) {
12465: ($suppcount,$cached) = &is_cached_new('suppcount',$hashid);
12466: }
12467: unless (defined($cached)) {
12468: my $chome=&homeserver($cnum,$cdom);
12469: unless ($chome eq 'no_host') {
12470: ($suppcount,my $supptools,my $errors) = (0,0,0);
12471: my $suppmap = 'supplemental.sequence';
12472: ($suppcount,$supptools,$errors) =
12473: &Apache::loncommon::recurse_supplemental($cnum,$cdom,$suppmap,$suppcount,
12474: $supptools,$errors);
12475: }
12476: &do_cache_new('suppcount',$hashid,$suppcount,600);
12477: }
12478: return $suppcount;
12479: }
12480:
12481: #
12482: # EXT resource caching routines
12483: #
12484:
12485: {
12486: # Cache (5 seconds) of map hierarchy for speedup of navmaps display
12487: #
12488: # The course for which we cache
12489: my $cachedmapkey='';
12490: # The cached recursive maps for this course
12491: my %cachedmaps=();
12492: # When this was last done
12493: my $cachedmaptime='';
12494:
12495: sub clear_EXT_cache_status {
12496: &delenv('cache.EXT.');
12497: }
12498:
12499: sub EXT_cache_status {
12500: my ($target_domain,$target_user) = @_;
12501: my $cachename = 'cache.EXT.'.$target_user.'.'.$target_domain;
12502: if (exists($env{$cachename}) && ($env{$cachename}+600) > time) {
12503: # We know already the user has no data
12504: return 1;
12505: } else {
12506: return 0;
12507: }
12508: }
12509:
12510: sub EXT_cache_set {
12511: my ($target_domain,$target_user) = @_;
12512: my $cachename = 'cache.EXT.'.$target_user.'.'.$target_domain;
12513: #&appenv({$cachename => time});
12514: }
12515:
12516: # --------------------------------------------------------- Value of a Variable
12517: sub EXT {
12518:
12519: my ($varname,$symbparm,$udom,$uname,$usection,$recurse,$cid,$recurseupref)=@_;
12520: unless ($varname) { return ''; }
12521: #get real user name/domain, courseid and symb
12522: my $courseid;
12523: my $publicuser;
12524: if ($symbparm) {
12525: $symbparm=&get_symb_from_alias($symbparm);
12526: }
12527: if (!($uname && $udom)) {
12528: (my $cursymb,$courseid,$udom,$uname,$publicuser)= &whichuser($symbparm);
12529: if (!$symbparm) { $symbparm=$cursymb; }
12530: } else {
12531: $courseid=$env{'request.course.id'};
12532: }
12533: my ($realm,$space,$qualifier,@therest)=split(/\./,$varname);
12534: my $rest;
12535: if (defined($therest[0])) {
12536: $rest=join('.',@therest);
12537: } else {
12538: $rest='';
12539: }
12540:
12541: my $qualifierrest=$qualifier;
12542: if ($rest) { $qualifierrest.='.'.$rest; }
12543: my $spacequalifierrest=$space;
12544: if ($qualifierrest) { $spacequalifierrest.='.'.$qualifierrest; }
12545: if ($realm eq 'user') {
12546: # --------------------------------------------------------------- user.resource
12547: if ($space eq 'resource') {
12548: if ( (defined($Apache::lonhomework::parsing_a_problem)
12549: || defined($Apache::lonhomework::parsing_a_task))
12550: &&
12551: ($symbparm eq &symbread()) ) {
12552: # if we are in the middle of processing the resource the
12553: # get the value we are planning on committing
12554: if (defined($Apache::lonhomework::results{$qualifierrest})) {
12555: return $Apache::lonhomework::results{$qualifierrest};
12556: } else {
12557: return $Apache::lonhomework::history{$qualifierrest};
12558: }
12559: } else {
12560: my %restored;
12561: if ($publicuser || $env{'request.state'} eq 'construct') {
12562: %restored=&tmprestore($symbparm,$courseid,$udom,$uname);
12563: } else {
12564: %restored=&restore($symbparm,$courseid,$udom,$uname);
12565: }
12566: return $restored{$qualifierrest};
12567: }
12568: # ----------------------------------------------------------------- user.access
12569: } elsif ($space eq 'access') {
12570: # FIXME - not supporting calls for a specific user
12571: return &allowed($qualifier,$rest);
12572: # ------------------------------------------ user.preferences, user.environment
12573: } elsif (($space eq 'preferences') || ($space eq 'environment')) {
12574: if (($uname eq $env{'user.name'}) &&
12575: ($udom eq $env{'user.domain'})) {
12576: return $env{join('.',('environment',$qualifierrest))};
12577: } else {
12578: my %returnhash;
12579: if (!$publicuser) {
12580: %returnhash=&userenvironment($udom,$uname,
12581: $qualifierrest);
12582: }
12583: return $returnhash{$qualifierrest};
12584: }
12585: # ----------------------------------------------------------------- user.course
12586: } elsif ($space eq 'course') {
12587: # FIXME - not supporting calls for a specific user
12588: return $env{join('.',('request.course',$qualifier))};
12589: # ------------------------------------------------------------------- user.role
12590: } elsif ($space eq 'role') {
12591: # FIXME - not supporting calls for a specific user
12592: my ($role,$where)=split(/\./,$env{'request.role'});
12593: if ($qualifier eq 'value') {
12594: return $role;
12595: } elsif ($qualifier eq 'extent') {
12596: return $where;
12597: }
12598: # ----------------------------------------------------------------- user.domain
12599: } elsif ($space eq 'domain') {
12600: return $udom;
12601: # ------------------------------------------------------------------- user.name
12602: } elsif ($space eq 'name') {
12603: return $uname;
12604: # ---------------------------------------------------- Any other user namespace
12605: } else {
12606: my %reply;
12607: if (!$publicuser) {
12608: %reply=&get($space,[$qualifierrest],$udom,$uname);
12609: }
12610: return $reply{$qualifierrest};
12611: }
12612: } elsif ($realm eq 'query') {
12613: # ---------------------------------------------- pull stuff out of query string
12614: &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},
12615: [$spacequalifierrest]);
12616: return $env{'form.'.$spacequalifierrest};
12617: } elsif ($realm eq 'request') {
12618: # ------------------------------------------------------------- request.browser
12619: if ($space eq 'browser') {
12620: return $env{'browser.'.$qualifier};
12621: # ------------------------------------------------------------ request.filename
12622: } else {
12623: return $env{'request.'.$spacequalifierrest};
12624: }
12625: } elsif ($realm eq 'course') {
12626: # ---------------------------------------------------------- course.description
12627: return $env{'course.'.$courseid.'.'.$spacequalifierrest};
12628: } elsif ($realm eq 'resource') {
12629:
12630: if (defined($courseid) && $courseid eq $env{'request.course.id'}) {
12631: if (!$symbparm) { $symbparm=&symbread(); }
12632: }
12633:
12634: if ($qualifier eq '') {
12635: if ($space eq 'title') {
12636: if (!$symbparm) { $symbparm = $env{'request.filename'}; }
12637: return &gettitle($symbparm);
12638: }
12639:
12640: if ($space eq 'map') {
12641: my ($map) = &decode_symb($symbparm);
12642: return &symbread($map);
12643: }
12644: if ($space eq 'maptitle') {
12645: my ($map) = &decode_symb($symbparm);
12646: return &gettitle($map);
12647: }
12648: if ($space eq 'filename') {
12649: if ($symbparm) {
12650: return &clutter((&decode_symb($symbparm))[2]);
12651: }
12652: return &hreflocation('',$env{'request.filename'});
12653: }
12654:
12655: if ((defined($courseid)) && ($courseid eq $env{'request.course.id'}) && $symbparm) {
12656: if ($space eq 'visibleparts') {
12657: my $navmap = Apache::lonnavmaps::navmap->new();
12658: my $item;
12659: if (ref($navmap)) {
12660: my $res = $navmap->getBySymb($symbparm);
12661: my $parts = $res->parts();
12662: if (ref($parts) eq 'ARRAY') {
12663: $item = join(',',@{$parts});
12664: }
12665: undef($navmap);
12666: }
12667: return $item;
12668: }
12669: }
12670: }
12671:
12672: my ($section, $group, @groups, @recurseup, $recursed);
12673: if (ref($recurseupref) eq 'ARRAY') {
12674: @recurseup = @{$recurseupref};
12675: $recursed = 1;
12676: }
12677: my ($courselevelm,$courseleveli,$courselevel,$mapp);
12678: if (($courseid eq '') && ($cid)) {
12679: $courseid = $cid;
12680: }
12681: if (($symbparm && $courseid) &&
12682: (($courseid eq $env{'request.course.id'}) || ($courseid eq $cid))) {
12683:
12684: #print '<br>'.$space.' - '.$qualifier.' - '.$spacequalifierrest;
12685:
12686: # ----------------------------------------------------- Cascading lookup scheme
12687: my $symbp=$symbparm;
12688: $mapp=&deversion((&decode_symb($symbp))[0]);
12689: my $symbparm=$symbp.'.'.$spacequalifierrest;
12690: my $recurseparm=$mapp.'___(rec).'.$spacequalifierrest;
12691: my $mapparm=$mapp.'___(all).'.$spacequalifierrest;
12692: if (($env{'user.name'} eq $uname) &&
12693: ($env{'user.domain'} eq $udom)) {
12694: $section=$env{'request.course.sec'};
12695: @groups = split(/:/,$env{'request.course.groups'});
12696: @groups=&sort_course_groups($courseid,@groups);
12697: } else {
12698: if (! defined($usection)) {
12699: $section=&getsection($udom,$uname,$courseid);
12700: } else {
12701: $section = $usection;
12702: }
12703: @groups = &get_users_groups($udom,$uname,$courseid);
12704: }
12705:
12706: my $seclevel=$courseid.'.['.$section.'].'.$spacequalifierrest;
12707: my $seclevelr=$courseid.'.['.$section.'].'.$symbparm;
12708: my $secleveli=$courseid.'.['.$section.'].'.$recurseparm;
12709: my $seclevelm=$courseid.'.['.$section.'].'.$mapparm;
12710:
12711: $courselevel=$courseid.'.'.$spacequalifierrest;
12712: my $courselevelr=$courseid.'.'.$symbparm;
12713: $courseleveli=$courseid.'.'.$recurseparm;
12714: $courselevelm=$courseid.'.'.$mapparm;
12715:
12716: # ----------------------------------------------------------- first, check user
12717:
12718: my $userreply=&resdata($uname,$udom,'user',$mapp,\$recursed,
12719: \@recurseup,$courseid,'.',$spacequalifierrest,
12720: ([$courselevelr,'resource'],
12721: [$courselevelm,'map' ],
12722: [$courseleveli,'map' ],
12723: [$courselevel, 'course' ]));
12724: if (defined($userreply)) { return &get_reply($userreply); }
12725:
12726: # ------------------------------------------------ second, check some of course
12727: my $coursereply;
12728: if (@groups > 0) {
12729: $coursereply = &check_group_parms($courseid,\@groups,$symbparm,
12730: $recurseparm,$mapparm,$spacequalifierrest,
12731: $mapp,\$recursed,\@recurseup);
12732: if (defined($coursereply)) { return &get_reply($coursereply); }
12733: }
12734:
12735: $coursereply=&resdata($env{'course.'.$courseid.'.num'},
12736: $env{'course.'.$courseid.'.domain'},
12737: 'course',$mapp,\$recursed,\@recurseup,
12738: $courseid,'.['.$section.'].',$spacequalifierrest,
12739: ([$seclevelr, 'resource'],
12740: [$seclevelm, 'map' ],
12741: [$secleveli, 'map' ],
12742: [$seclevel, 'course' ],
12743: [$courselevelr,'resource']));
12744: if (defined($coursereply)) { return &get_reply($coursereply); }
12745:
12746: # ------------------------------------------------------ third, check map parms
12747: my %parmhash=();
12748: my $thisparm='';
12749: if (tie(%parmhash,'GDBM_File',
12750: $env{'request.course.fn'}.'_parms.db',
12751: &GDBM_READER(),0640)) {
12752: $thisparm=$parmhash{$symbparm};
12753: untie(%parmhash);
12754: }
12755: if ($thisparm) { return &get_reply([$thisparm,'resource']); }
12756: }
12757: # ------------------------------------------ fourth, look in resource metadata
12758:
12759: my $what = $spacequalifierrest;
12760: $what=~s/\./\_/;
12761: my $filename;
12762: if (!$symbparm) { $symbparm=&symbread(); }
12763: if ($symbparm) {
12764: $filename=(&decode_symb($symbparm))[2];
12765: } else {
12766: $filename=$env{'request.filename'};
12767: }
12768: my $toolsymb;
12769: if (($filename =~ /ext\.tool$/) && ($what ne '0_gradable')) {
12770: $toolsymb = $symbparm;
12771: }
12772: my $metadata=&metadata($filename,$what,$toolsymb);
12773: if (defined($metadata)) { return &get_reply([$metadata,'resource']); }
12774: $metadata=&metadata($filename,'parameter_'.$what,$toolsymb);
12775: if (defined($metadata)) { return &get_reply([$metadata,'resource']); }
12776:
12777: # ----------------------------------------------- fifth, look in rest of course
12778: if ($symbparm && defined($courseid) &&
12779: $courseid eq $env{'request.course.id'}) {
12780: my $coursereply=&resdata($env{'course.'.$courseid.'.num'},
12781: $env{'course.'.$courseid.'.domain'},
12782: 'course',$mapp,\$recursed,\@recurseup,
12783: $courseid,'.',$spacequalifierrest,
12784: ([$courselevelm,'map' ],
12785: [$courseleveli,'map' ],
12786: [$courselevel, 'course']));
12787: if (defined($coursereply)) { return &get_reply($coursereply); }
12788: }
12789: # ------------------------------------------------------------------ Cascade up
12790: unless ($space eq '0') {
12791: my @parts=split(/_/,$space);
12792: my $id=pop(@parts);
12793: my $part=join('_',@parts);
12794: if ($part eq '') { $part='0'; }
12795: my @partgeneral=&EXT('resource.'.$part.'.'.$qualifierrest,
12796: $symbparm,$udom,$uname,$section,1);
12797: if (defined($partgeneral[0])) { return &get_reply(\@partgeneral); }
12798: }
12799: if ($recurse) { return undef; }
12800: my $pack_def=&packages_tab_default($filename,$varname,$toolsymb);
12801: if (defined($pack_def)) { return &get_reply([$pack_def,'resource']); }
12802: # ---------------------------------------------------- Any other user namespace
12803: } elsif ($realm eq 'environment') {
12804: # ----------------------------------------------------------------- environment
12805: if (($uname eq $env{'user.name'})&&($udom eq $env{'user.domain'})) {
12806: return $env{'environment.'.$spacequalifierrest};
12807: } else {
12808: if ($uname eq 'anonymous' && $udom eq '') {
12809: return '';
12810: }
12811: my %returnhash=&userenvironment($udom,$uname,
12812: $spacequalifierrest);
12813: return $returnhash{$spacequalifierrest};
12814: }
12815: } elsif ($realm eq 'system') {
12816: # ----------------------------------------------------------------- system.time
12817: if ($space eq 'time') {
12818: return time;
12819: }
12820: } elsif ($realm eq 'server') {
12821: # ----------------------------------------------------------------- system.time
12822: if ($space eq 'name') {
12823: return $ENV{'SERVER_NAME'};
12824: }
12825: } elsif ($realm eq 'client') {
12826: if ($space eq 'remote_addr') {
12827: return &get_requestor_ip();
12828: }
12829: }
12830: return '';
12831: }
12832:
12833: sub get_reply {
12834: my ($reply_value) = @_;
12835: if (ref($reply_value) eq 'ARRAY') {
12836: if (wantarray) {
12837: return @$reply_value;
12838: }
12839: return $reply_value->[0];
12840: } else {
12841: return $reply_value;
12842: }
12843: }
12844:
12845: sub check_group_parms {
12846: my ($courseid,$groups,$symbparm,$recurseparm,$mapparm,$what,$mapp,
12847: $recursed,$recurseupref) = @_;
12848: my @levels = ([$symbparm,'resource'],[$mapparm,'map'],[$recurseparm,'map'],
12849: [$what,'course']);
12850: my $coursereply;
12851: foreach my $group (@{$groups}) {
12852: my @groupitems = ();
12853: foreach my $level (@levels) {
12854: my $item = $courseid.'.['.$group.'].'.$level->[0];
12855: push(@groupitems,[$item,$level->[1]]);
12856: }
12857: my $coursereply = &resdata($env{'course.'.$courseid.'.num'},
12858: $env{'course.'.$courseid.'.domain'},
12859: 'course',$mapp,$recursed,$recurseupref,
12860: $courseid,'.['.$group.'].',$what,
12861: @groupitems);
12862: last if (defined($coursereply));
12863: }
12864: return $coursereply;
12865: }
12866:
12867: sub get_map_hierarchy {
12868: my ($mapname,$courseid) = @_;
12869: my @recurseup = ();
12870: if ($mapname) {
12871: if (($cachedmapkey eq $courseid) &&
12872: (abs($cachedmaptime-time)<5)) {
12873: if (ref($cachedmaps{$mapname}) eq 'ARRAY') {
12874: return @{$cachedmaps{$mapname}};
12875: }
12876: }
12877: my $navmap = Apache::lonnavmaps::navmap->new();
12878: if (ref($navmap)) {
12879: @recurseup = $navmap->recurseup_maps($mapname);
12880: undef($navmap);
12881: $cachedmaps{$mapname} = \@recurseup;
12882: $cachedmaptime=time;
12883: $cachedmapkey=$courseid;
12884: }
12885: }
12886: return @recurseup;
12887: }
12888:
12889: }
12890:
12891: sub sort_course_groups { # Sort groups based on defined rankings. Default is sort().
12892: my ($courseid,@groups) = @_;
12893: @groups = sort(@groups);
12894: return @groups;
12895: }
12896:
12897: sub packages_tab_default {
12898: my ($uri,$varname,$toolsymb)=@_;
12899: my (undef,$part,$name)=split(/\./,$varname);
12900:
12901: my (@extension,@specifics,$do_default);
12902: foreach my $package (split(/,/,&metadata($uri,'packages',$toolsymb))) {
12903: my ($pack_type,$pack_part)=split(/_/,$package,2);
12904: if ($pack_type eq 'default') {
12905: $do_default=1;
12906: } elsif ($pack_type eq 'extension') {
12907: push(@extension,[$package,$pack_type,$pack_part]);
12908: } elsif ($pack_part eq $part || $pack_type eq 'part') {
12909: # only look at packages defaults for packages that this id is
12910: push(@specifics,[$package,$pack_type,$pack_part]);
12911: }
12912: }
12913: # first look for a package that matches the requested part id
12914: foreach my $package (@specifics) {
12915: my (undef,$pack_type,$pack_part)=@{$package};
12916: next if ($pack_part ne $part);
12917: if (defined($packagetab{"$pack_type&$name&default"})) {
12918: return $packagetab{"$pack_type&$name&default"};
12919: }
12920: }
12921: # look for any possible matching non extension_ package
12922: foreach my $package (@specifics) {
12923: my (undef,$pack_type,$pack_part)=@{$package};
12924: if (defined($packagetab{"$pack_type&$name&default"})) {
12925: return $packagetab{"$pack_type&$name&default"};
12926: }
12927: if ($pack_type eq 'part') { $pack_part='0'; }
12928: if (defined($packagetab{$pack_type."_".$pack_part."&$name&default"})) {
12929: return $packagetab{$pack_type."_".$pack_part."&$name&default"};
12930: }
12931: }
12932: # look for any posible extension_ match
12933: foreach my $package (@extension) {
12934: my ($package,$pack_type)=@{$package};
12935: if (defined($packagetab{"$pack_type&$name&default"})) {
12936: return $packagetab{"$pack_type&$name&default"};
12937: }
12938: if (defined($packagetab{$package."&$name&default"})) {
12939: return $packagetab{$package."&$name&default"};
12940: }
12941: }
12942: # look for a global default setting
12943: if ($do_default && defined($packagetab{"default&$name&default"})) {
12944: return $packagetab{"default&$name&default"};
12945: }
12946: return undef;
12947: }
12948:
12949: sub add_prefix_and_part {
12950: my ($prefix,$part)=@_;
12951: my $keyroot;
12952: if (defined($prefix) && $prefix !~ /^__/) {
12953: # prefix that has a part already
12954: $keyroot=$prefix;
12955: } elsif (defined($prefix)) {
12956: # prefix that is missing a part
12957: if (defined($part)) { $keyroot='_'.$part.substr($prefix,1); }
12958: } else {
12959: # no prefix at all
12960: if (defined($part)) { $keyroot='_'.$part; }
12961: }
12962: return $keyroot;
12963: }
12964:
12965: # ---------------------------------------------------------------- Get metadata
12966:
12967: my %metaentry;
12968: my %importedpartids;
12969: my %importedrespids;
12970: sub metadata {
12971: my ($uri,$what,$toolsymb,$liburi,$prefix,$depthcount)=@_;
12972: $uri=&declutter($uri);
12973: # if it is a non metadata possible uri return quickly
12974: if (($uri eq '') ||
12975: (($uri =~ m|^/*adm/|) &&
12976: ($uri !~ m|^adm/includes|) && ($uri !~ m{/(smppg|bulletinboard|ext\.tool)$})) ||
12977: ($uri =~ m|/$|) || ($uri =~ m|/.meta$|) || ($uri =~ m{^/*uploaded/.+\.sequence$})) {
12978: return undef;
12979: }
12980: if (($uri =~ /^priv/ || $uri=~m{^home/httpd/html/priv})
12981: && &Apache::lonxml::get_state('target') =~ /^(|meta)$/) {
12982: return undef;
12983: }
12984: my $filename=$uri;
12985: $uri=~s/\.meta$//;
12986: #
12987: # Is the metadata already cached?
12988: # Look at timestamp of caching
12989: # Everything is cached by the main uri, libraries are never directly cached
12990: #
12991: if (!defined($liburi)) {
12992: my ($result,$cached)=&is_cached_new('meta',$uri);
12993: if (defined($cached)) { return $result->{':'.$what}; }
12994: }
12995:
12996: #
12997: # If the uri is for an external tool the file from
12998: # which metadata should be retrieved depends on whether
12999: # the tool had been configured to be gradable (set in the Course
13000: # Editor or Resource Editor).
13001: #
13002: # If a valid symb has been included as the third arg in the call
13003: # to &metadata() that can be used to retrieve the value of
13004: # parameter_0_gradable set for the resource, and included in the
13005: # uploaded map containing the tool. The value is retrieved via
13006: # &EXT(), if a valid symb is available. Otherwise the value of
13007: # gradable in the exttool_$marker.db file for the tool instance
13008: # is retrieved via &get().
13009: #
13010: # When lonuserstate::traceroute() calls lonnet::EXT() for
13011: # hiddenresource and encrypturl (during course initialization)
13012: # the map-level parameter for resource.0.gradable included in the
13013: # uploaded map containing the tool will not yet have been stored
13014: # in the user_course_parms.db file for the user's session, so in
13015: # this case fall back to retrieving gradable status from the
13016: # exttool_$marker.db file.
13017: #
13018: # In order to avoid an infinite loop, &metadata() will return
13019: # before a call to &EXT(), if the uri is for an external tool
13020: # and the $what for which metadata is being requested is
13021: # parameter_0_gradable or 0_gradable.
13022: #
13023:
13024: if ($uri =~ /ext\.tool$/) {
13025: if (($what eq 'parameter_0_gradable') || ($what eq '0_gradable')) {
13026: return;
13027: } else {
13028: my ($checked,$use_passback);
13029: if ($toolsymb ne '') {
13030: (undef,undef,my $tooluri) = &decode_symb($toolsymb);
13031: if (($tooluri eq $uri) && (&EXT('resource.0.gradable',$toolsymb))) {
13032: $checked = 1;
13033: if (&EXT('resource.0.gradable',$toolsymb) =~ /^yes$/i) {
13034: $use_passback = 1;
13035: }
13036: }
13037: }
13038: unless ($checked) {
13039: my ($ignore,$cdom,$cnum,$marker) = split(m{/},$uri);
13040: $marker=~s/\D//g;
13041: if ($marker) {
13042: my %toolsettings=&get('exttool_'.$marker,['gradable'],$cdom,$cnum);
13043: $use_passback = $toolsettings{'gradable'};
13044: }
13045: }
13046: if ($use_passback) {
13047: $filename = '/home/httpd/html/res/lib/templates/LTIpassback.tool';
13048: } else {
13049: $filename = '/home/httpd/html/res/lib/templates/LTIstandard.tool';
13050: }
13051: }
13052: }
13053:
13054: {
13055: # Imported parts would go here
13056: my @origfiletagids=();
13057: my $importedparts=0;
13058:
13059: # Imported responseids would go here
13060: my $importedresponses=0;
13061: #
13062: # Is this a recursive call for a library?
13063: #
13064: # if (! exists($metacache{$uri})) {
13065: # $metacache{$uri}={};
13066: # }
13067: my $cachetime = 60*60;
13068: if ($liburi) {
13069: $liburi=&declutter($liburi);
13070: $filename=$liburi;
13071: } else {
13072: &devalidate_cache_new('meta',$uri);
13073: undef(%metaentry);
13074: }
13075: my %metathesekeys=();
13076: unless ($filename=~/\.meta$/) { $filename.='.meta'; }
13077: my $metastring;
13078: if ($uri =~ /^priv/ || $uri=~/home\/httpd\/html\/priv/) {
13079: my $which = &hreflocation('','/'.($liburi || $uri));
13080: $metastring =
13081: &Apache::lonnet::ssi_body($which,
13082: ('grade_target' => 'meta'));
13083: $cachetime = 1; # only want this cached in the child not long term
13084: } elsif (($uri !~ m -^(editupload)/-) &&
13085: ($uri !~ m{^/*uploaded/$match_domain/$match_courseid/docs/})) {
13086: my $file=&filelocation('',&clutter($filename));
13087: #push(@{$metaentry{$uri.'.file'}},$file);
13088: $metastring=&getfile($file);
13089: }
13090: my $parser=HTML::LCParser->new(\$metastring);
13091: my $token;
13092: undef %metathesekeys;
13093: while ($token=$parser->get_token) {
13094: if ($token->[0] eq 'S') {
13095: if (defined($token->[2]->{'package'})) {
13096: #
13097: # This is a package - get package info
13098: #
13099: my $package=$token->[2]->{'package'};
13100: my $keyroot=&add_prefix_and_part($prefix,$token->[2]->{'part'});
13101: if (defined($token->[2]->{'id'})) {
13102: $keyroot.='_'.$token->[2]->{'id'};
13103: }
13104: if ($metaentry{':packages'}) {
13105: $metaentry{':packages'}.=','.$package.$keyroot;
13106: } else {
13107: $metaentry{':packages'}=$package.$keyroot;
13108: }
13109: foreach my $pack_entry (keys(%packagetab)) {
13110: my $part=$keyroot;
13111: $part=~s/^\_//;
13112: if ($pack_entry=~/^\Q$package\E\&/ ||
13113: $pack_entry=~/^\Q$package\E_0\&/) {
13114: my ($pack,$name,$subp)=split(/\&/,$pack_entry);
13115: # ignore package.tab specified default values
13116: # here &package_tab_default() will fetch those
13117: if ($subp eq 'default') { next; }
13118: my $value=$packagetab{$pack_entry};
13119: my $unikey;
13120: if ($pack =~ /_0$/) {
13121: $unikey='parameter_0_'.$name;
13122: $part=0;
13123: } else {
13124: $unikey='parameter'.$keyroot.'_'.$name;
13125: }
13126: if ($subp eq 'display') {
13127: $value.=' [Part: '.$part.']';
13128: }
13129: $metaentry{':'.$unikey.'.part'}=$part;
13130: $metathesekeys{$unikey}=1;
13131: unless (defined($metaentry{':'.$unikey.'.'.$subp})) {
13132: $metaentry{':'.$unikey.'.'.$subp}=$value;
13133: }
13134: if (defined($metaentry{':'.$unikey.'.default'})) {
13135: $metaentry{':'.$unikey}=
13136: $metaentry{':'.$unikey.'.default'};
13137: }
13138: }
13139: }
13140: } else {
13141: #
13142: # This is not a package - some other kind of start tag
13143: #
13144: my $entry=$token->[1];
13145: my $unikey='';
13146:
13147: if ($entry eq 'import') {
13148: #
13149: # Importing a library here
13150: #
13151: my $location=$parser->get_text('/import');
13152: my $dir=$filename;
13153: $dir=~s|[^/]*$||;
13154: $location=&filelocation($dir,$location);
13155:
13156: my $importid=$token->[2]->{'id'};
13157: my $importmode=$token->[2]->{'importmode'};
13158: #
13159: # Check metadata for imported file to
13160: # see if it contained response items
13161: #
13162: my ($origfile,@libfilekeys);
13163: my %currmetaentry = %metaentry;
13164: @libfilekeys = split(/,/,&metadata($location,'keys',undef,undef,undef,
13165: $depthcount+1));
13166: if (grep(/^responseorder$/,@libfilekeys)) {
13167: my $libresponseorder = &metadata($location,'responseorder',undef,undef,
13168: undef,$depthcount+1);
13169: if ($libresponseorder ne '') {
13170: if ($#origfiletagids<0) {
13171: undef(%importedrespids);
13172: undef(%importedpartids);
13173: }
13174: my @respids = split(/\s*,\s*/,$libresponseorder);
13175: if (@respids) {
13176: $importedrespids{$importid} = join(',',map { $importid.'_'.$_ } @respids);
13177: }
13178: if ($importedrespids{$importid} ne '') {
13179: $importedresponses = 1;
13180: # We need to get the original file and the imported file to get the response order correct
13181: # Load and inspect original file
13182: if ($#origfiletagids<0) {
13183: my $origfilelocation=$perlvar{'lonDocRoot'}.&clutter($uri);
13184: $origfile=&getfile($origfilelocation);
13185: @origfiletagids=($origfile=~/<((?:\w+)response|import|part)[^>]*id\s*=\s*[\"\']([^\"\']+)[\"\'][^>]*>/gs);
13186: }
13187: }
13188: }
13189: }
13190: # Do not overwrite contents of %metaentry hash for resource itself with
13191: # hash populated for imported library file
13192: %metaentry = %currmetaentry;
13193: undef(%currmetaentry);
13194: if ($importmode eq 'part') {
13195: # Import as part(s)
13196: $importedparts=1;
13197: # We need to get the original file and the imported file to get the part order correct
13198: # Good news: we do not need to worry about nested libraries, since parts cannot be nested
13199: # Load and inspect original file if we didn't do that already
13200: if ($#origfiletagids<0) {
13201: undef(%importedrespids);
13202: undef(%importedpartids);
13203: if ($origfile eq '') {
13204: my $origfilelocation=$perlvar{'lonDocRoot'}.&clutter($uri);
13205: $origfile=&getfile($origfilelocation);
13206: @origfiletagids=($origfile=~/<(part|import)[^>]*id\s*=\s*[\"\']([^\"\']+)[\"\'][^>]*>/gs);
13207: }
13208: }
13209: my @impfilepartids;
13210: # If <partorder> tag is included in metadata for the imported file
13211: # get the parts in the imported file from that.
13212: if (grep(/^partorder$/,@libfilekeys)) {
13213: %currmetaentry = %metaentry;
13214: my $libpartorder = &metadata($location,'partorder',undef,undef,undef,
13215: $depthcount+1);
13216: %metaentry = %currmetaentry;
13217: undef(%currmetaentry);
13218: if ($libpartorder ne '') {
13219: @impfilepartids=split(/\s*,\s*/,$libpartorder);
13220: }
13221: } else {
13222: # If no <partorder> tag available, load and inspect imported file
13223: my $impfile=&getfile($location);
13224: @impfilepartids=($impfile=~/<part[^>]*id\s*=\s*[\"\']([^\"\']+)[\"\'][^>]*>/gs);
13225: }
13226: if ($#impfilepartids>=0) {
13227: # This problem had parts
13228: $importedpartids{$token->[2]->{'id'}}=join(',',@impfilepartids);
13229: } else {
13230: # Importing by turning a single problem into a problem part
13231: # It gets the import-tags ID as part-ID
13232: $unikey=&add_prefix_and_part($prefix,$token->[2]->{'id'});
13233: $importedpartids{$token->[2]->{'id'}}=$token->[2]->{'id'};
13234: }
13235: } else {
13236: # Import as problem or as normal import
13237: $unikey=&add_prefix_and_part($prefix,$token->[2]->{'part'});
13238: unless ($importmode eq 'problem') {
13239: # Normal import
13240: if (defined($token->[2]->{'id'})) {
13241: $unikey.='_'.$token->[2]->{'id'};
13242: }
13243: }
13244: # Check metadata for imported file to
13245: # see if it contained parts
13246: if (grep(/^partorder$/,@libfilekeys)) {
13247: %currmetaentry = %metaentry;
13248: my $libpartorder = &metadata($location,'partorder',undef,undef,undef,
13249: $depthcount+1);
13250: %metaentry = %currmetaentry;
13251: undef(%currmetaentry);
13252: if ($libpartorder ne '') {
13253: $importedparts = 1;
13254: $importedpartids{$token->[2]->{'id'}}=$libpartorder;
13255: }
13256: }
13257: }
13258: if ($depthcount<20) {
13259: my $metadata =
13260: &metadata($uri,'keys',$toolsymb,$location,$unikey,
13261: $depthcount+1);
13262: foreach my $meta (split(',',$metadata)) {
13263: $metaentry{':'.$meta}=$metaentry{':'.$meta};
13264: $metathesekeys{$meta}=1;
13265: }
13266: }
13267: } else {
13268: #
13269: # Not importing, some other kind of non-package, non-library start tag
13270: #
13271: $unikey=$entry.&add_prefix_and_part($prefix,$token->[2]->{'part'});
13272: if (defined($token->[2]->{'id'})) {
13273: $unikey.='_'.$token->[2]->{'id'};
13274: }
13275: if (defined($token->[2]->{'name'})) {
13276: $unikey.='_'.$token->[2]->{'name'};
13277: }
13278: $metathesekeys{$unikey}=1;
13279: foreach my $param (@{$token->[3]}) {
13280: $metaentry{':'.$unikey.'.'.$param} =
13281: $token->[2]->{$param};
13282: }
13283: my $internaltext=&HTML::Entities::decode($parser->get_text('/'.$entry));
13284: my $default=$metaentry{':'.$unikey.'.default'};
13285: if ( $internaltext =~ /^\s*$/ && $default !~ /^\s*$/) {
13286: # only ws inside the tag, and not in default, so use default
13287: # as value
13288: $metaentry{':'.$unikey}=$default;
13289: } elsif ( $internaltext =~ /\S/ ) {
13290: # something interesting inside the tag
13291: $metaentry{':'.$unikey}=$internaltext;
13292: } else {
13293: # no interesting values, don't set a default
13294: }
13295: # end of not-a-package not-a-library import
13296: }
13297: # end of not-a-package start tag
13298: }
13299: # the next is the end of "start tag"
13300: }
13301: }
13302: my ($extension) = ($uri =~ /\.(\w+)$/);
13303: $extension = lc($extension);
13304: if ($extension eq 'htm') { $extension='html'; }
13305:
13306: foreach my $key (keys(%packagetab)) {
13307: #no specific packages #how's our extension
13308: if ($key!~/^extension_\Q$extension\E&/) { next; }
13309: &metadata_create_package_def($uri,$key,'extension_'.$extension,
13310: \%metathesekeys);
13311: }
13312:
13313: if (!exists($metaentry{':packages'})
13314: || $packagetab{"import_defaults&extension_$extension"}) {
13315: foreach my $key (keys(%packagetab)) {
13316: #no specific packages well let's get default then
13317: if ($key!~/^default&/) { next; }
13318: &metadata_create_package_def($uri,$key,'default',
13319: \%metathesekeys);
13320: }
13321: }
13322: # are there custom rights to evaluate
13323: if ($metaentry{':copyright'} eq 'custom') {
13324:
13325: #
13326: # Importing a rights file here
13327: #
13328: unless ($depthcount) {
13329: my $location=$metaentry{':customdistributionfile'};
13330: my $dir=$filename;
13331: $dir=~s|[^/]*$||;
13332: $location=&filelocation($dir,$location);
13333: my $rights_metadata =
13334: &metadata($uri,'keys',$toolsymb,$location,'_rights',
13335: $depthcount+1);
13336: foreach my $rights (split(',',$rights_metadata)) {
13337: #$metaentry{':'.$rights}=$metacache{$uri}->{':'.$rights};
13338: $metathesekeys{$rights}=1;
13339: }
13340: }
13341: }
13342: # uniqifiy package listing
13343: my %seen;
13344: my @uniq_packages =
13345: grep { ! $seen{$_} ++ } (split(',',$metaentry{':packages'}));
13346: $metaentry{':packages'} = join(',',@uniq_packages);
13347:
13348: if (($importedresponses) || ($importedparts)) {
13349: if ($importedparts) {
13350: # We had imported parts and need to rebuild partorder
13351: $metaentry{':partorder'}='';
13352: $metathesekeys{'partorder'}=1;
13353: }
13354: if ($importedresponses) {
13355: # We had imported responses and need to rebuil responseorder
13356: $metaentry{':responseorder'}='';
13357: $metathesekeys{'responseorder'}=1;
13358: }
13359: for (my $index=0;$index<$#origfiletagids;$index+=2) {
13360: my $origid = $origfiletagids[$index+1];
13361: if ($origfiletagids[$index] eq 'part') {
13362: # Original part, part of the problem
13363: if ($importedparts) {
13364: $metaentry{':partorder'}.=','.$origid;
13365: }
13366: } elsif ($origfiletagids[$index] eq 'import') {
13367: if ($importedparts) {
13368: # We have imported parts at this position
13369: if ($importedpartids{$origid} ne '') {
13370: $metaentry{':partorder'}.=','.$importedpartids{$origid};
13371: }
13372: }
13373: if ($importedresponses) {
13374: # We have imported responses at this position
13375: if ($importedrespids{$origid} ne '') {
13376: $metaentry{':responseorder'}.=','.$importedrespids{$origid};
13377: }
13378: }
13379: } else {
13380: # Original response item, part of the problem
13381: if ($importedresponses) {
13382: $metaentry{':responseorder'}.=','.$origid;
13383: }
13384: }
13385: }
13386: if ($importedparts) {
13387: $metaentry{':partorder'}=~s/^\,//;
13388: }
13389: if ($importedresponses) {
13390: $metaentry{':responseorder'}=~s/^\,//;
13391: }
13392: }
13393: $metaentry{':keys'} = join(',',keys(%metathesekeys));
13394: &metadata_generate_part0(\%metathesekeys,\%metaentry,$uri);
13395: $metaentry{':allpossiblekeys'}=join(',',keys(%metathesekeys));
13396: unless ($liburi) {
13397: &do_cache_new('meta',$uri,\%metaentry,$cachetime);
13398: }
13399: # this is the end of "was not already recently cached
13400: }
13401: return $metaentry{':'.$what};
13402: }
13403:
13404: sub metadata_create_package_def {
13405: my ($uri,$key,$package,$metathesekeys)=@_;
13406: my ($pack,$name,$subp)=split(/\&/,$key);
13407: if ($subp eq 'default') { next; }
13408:
13409: if (defined($metaentry{':packages'})) {
13410: $metaentry{':packages'}.=','.$package;
13411: } else {
13412: $metaentry{':packages'}=$package;
13413: }
13414: my $value=$packagetab{$key};
13415: my $unikey;
13416: $unikey='parameter_0_'.$name;
13417: $metaentry{':'.$unikey.'.part'}=0;
13418: $$metathesekeys{$unikey}=1;
13419: unless (defined($metaentry{':'.$unikey.'.'.$subp})) {
13420: $metaentry{':'.$unikey.'.'.$subp}=$value;
13421: }
13422: if (defined($metaentry{':'.$unikey.'.default'})) {
13423: $metaentry{':'.$unikey}=
13424: $metaentry{':'.$unikey.'.default'};
13425: }
13426: }
13427:
13428: sub metadata_generate_part0 {
13429: my ($metadata,$metacache,$uri) = @_;
13430: my %allnames;
13431: foreach my $metakey (keys(%$metadata)) {
13432: if ($metakey=~/^parameter\_(.*)/) {
13433: my $part=$$metacache{':'.$metakey.'.part'};
13434: my $name=$$metacache{':'.$metakey.'.name'};
13435: if (! exists($$metadata{'parameter_0_'.$name.'.name'})) {
13436: $allnames{$name}=$part;
13437: }
13438: }
13439: }
13440: foreach my $name (keys(%allnames)) {
13441: $$metadata{"parameter_0_$name"}=1;
13442: my $key=":parameter_0_$name";
13443: $$metacache{"$key.part"}='0';
13444: $$metacache{"$key.name"}=$name;
13445: $$metacache{"$key.type"}=$$metacache{':parameter_'.
13446: $allnames{$name}.'_'.$name.
13447: '.type'};
13448: my $olddis=$$metacache{':parameter_'.$allnames{$name}.'_'.$name.
13449: '.display'};
13450: my $expr='[Part: '.$allnames{$name}.']';
13451: $olddis=~s/\Q$expr\E/\[Part: 0\]/;
13452: $$metacache{"$key.display"}=$olddis;
13453: }
13454: }
13455:
13456: # ------------------------------------------------------ Devalidate title cache
13457:
13458: sub devalidate_title_cache {
13459: my ($url)=@_;
13460: if (!$env{'request.course.id'}) { return; }
13461: my $symb=&symbread($url);
13462: if (!$symb) { return; }
13463: my $key=$env{'request.course.id'}."\0".$symb;
13464: &devalidate_cache_new('title',$key);
13465: }
13466:
13467: # ------------------------------------------------- Get the title of a course
13468:
13469: sub current_course_title {
13470: return $env{ 'course.' . $env{'request.course.id'} . '.description' };
13471: }
13472: # ------------------------------------------------- Get the title of a resource
13473:
13474: sub gettitle {
13475: my $urlsymb=shift;
13476: my $symb=&symbread($urlsymb);
13477: if ($symb) {
13478: my $key=$env{'request.course.id'}."\0".$symb;
13479: my ($result,$cached)=&is_cached_new('title',$key);
13480: if (defined($cached)) {
13481: return $result;
13482: }
13483: my ($map,$resid,$url)=&decode_symb($symb);
13484: my $title='';
13485: if (!$map && $resid == 0 && $url =~/default\.sequence$/) {
13486: $title = $env{'course.'.$env{'request.course.id'}.'.description'};
13487: } else {
13488: if (tie(my %bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
13489: &GDBM_READER(),0640)) {
13490: my $mapid=$bighash{'map_pc_'.&clutter($map)};
13491: $title=$bighash{'title_'.$mapid.'.'.$resid};
13492: untie(%bighash);
13493: }
13494: }
13495: $title=~s/\&colon\;/\:/gs;
13496: if ($title) {
13497: # Remember both $symb and $title for dynamic metadata
13498: $accesshash{$symb.'___crstitle'}=$title;
13499: $accesshash{&declutter($map).'___'.&declutter($url).'___usage'}=time;
13500: # Cache this title and then return it
13501: return &do_cache_new('title',$key,$title,600);
13502: }
13503: $urlsymb=$url;
13504: }
13505: my $title=&metadata($urlsymb,'title');
13506: if (!$title) { $title=(split('/',$urlsymb))[-1]; }
13507: return $title;
13508: }
13509:
13510: sub get_slot {
13511: my ($which,$cnum,$cdom)=@_;
13512: if (!$cnum || !$cdom) {
13513: (undef,my $courseid)=&whichuser();
13514: $cdom=$env{'course.'.$courseid.'.domain'};
13515: $cnum=$env{'course.'.$courseid.'.num'};
13516: }
13517: my $key=join("\0",'slots',$cdom,$cnum,$which);
13518: my %slotinfo;
13519: if (exists($remembered{$key})) {
13520: $slotinfo{$which} = $remembered{$key};
13521: } else {
13522: %slotinfo=&get('slots',[$which],$cdom,$cnum);
13523: &Apache::lonhomework::showhash(%slotinfo);
13524: my ($tmp)=keys(%slotinfo);
13525: if ($tmp=~/^error:/) { return (); }
13526: $remembered{$key} = $slotinfo{$which};
13527: }
13528: if (ref($slotinfo{$which}) eq 'HASH') {
13529: return %{$slotinfo{$which}};
13530: }
13531: return $slotinfo{$which};
13532: }
13533:
13534: sub get_reservable_slots {
13535: my ($cnum,$cdom,$uname,$udom) = @_;
13536: my $now = time;
13537: my $reservable_info;
13538: my $key=join("\0",'reservableslots',$cdom,$cnum,$uname,$udom);
13539: if (exists($remembered{$key})) {
13540: $reservable_info = $remembered{$key};
13541: } else {
13542: my %resv;
13543: ($resv{'now_order'},$resv{'now'},$resv{'future_order'},$resv{'future'}) =
13544: &Apache::loncommon::get_future_slots($cnum,$cdom,$now);
13545: $reservable_info = \%resv;
13546: $remembered{$key} = $reservable_info;
13547: }
13548: return $reservable_info;
13549: }
13550:
13551: sub get_course_slots {
13552: my ($cnum,$cdom) = @_;
13553: my $hashid=$cnum.':'.$cdom;
13554: my ($result,$cached) = &Apache::lonnet::is_cached_new('allslots',$hashid);
13555: if (defined($cached)) {
13556: if (ref($result) eq 'HASH') {
13557: return %{$result};
13558: }
13559: } else {
13560: my %slots=&Apache::lonnet::dump('slots',$cdom,$cnum);
13561: my ($tmp) = keys(%slots);
13562: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
13563: &do_cache_new('allslots',$hashid,\%slots,600);
13564: return %slots;
13565: }
13566: }
13567: return;
13568: }
13569:
13570: sub devalidate_slots_cache {
13571: my ($cnum,$cdom)=@_;
13572: my $hashid=$cnum.':'.$cdom;
13573: &devalidate_cache_new('allslots',$hashid);
13574: }
13575:
13576: sub get_coursechange {
13577: my ($cdom,$cnum) = @_;
13578: if ($cdom eq '' || $cnum eq '') {
13579: return unless ($env{'request.course.id'});
13580: $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
13581: $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
13582: }
13583: my $hashid=$cdom.'_'.$cnum;
13584: my ($change,$cached)=&is_cached_new('crschange',$hashid);
13585: if ((defined($cached)) && ($change ne '')) {
13586: return $change;
13587: } else {
13588: my %crshash;
13589: %crshash = &get('environment',['internal.contentchange'],$cdom,$cnum);
13590: if ($crshash{'internal.contentchange'} eq '') {
13591: $change = $env{'course.'.$cdom.'_'.$cnum.'.internal.created'};
13592: if ($change eq '') {
13593: %crshash = &get('environment',['internal.created'],$cdom,$cnum);
13594: $change = $crshash{'internal.created'};
13595: }
13596: } else {
13597: $change = $crshash{'internal.contentchange'};
13598: }
13599: my $cachetime = 600;
13600: &do_cache_new('crschange',$hashid,$change,$cachetime);
13601: }
13602: return $change;
13603: }
13604:
13605: sub devalidate_coursechange_cache {
13606: my ($cnum,$cdom)=@_;
13607: my $hashid=$cnum.':'.$cdom;
13608: &devalidate_cache_new('crschange',$hashid);
13609: }
13610:
13611: # ------------------------------------------------- Update symbolic store links
13612:
13613: sub symblist {
13614: my ($mapname,%newhash)=@_;
13615: $mapname=&deversion(&declutter($mapname));
13616: my %hash;
13617: if (($env{'request.course.fn'}) && (%newhash)) {
13618: if (tie(%hash,'GDBM_File',$env{'request.course.fn'}.'_symb.db',
13619: &GDBM_WRCREAT(),0640)) {
13620: foreach my $url (keys(%newhash)) {
13621: next if ($url eq 'last_known'
13622: && $env{'form.no_update_last_known'});
13623: $hash{declutter($url)}=&encode_symb($mapname,
13624: $newhash{$url}->[1],
13625: $newhash{$url}->[0]);
13626: }
13627: if (untie(%hash)) {
13628: return 'ok';
13629: }
13630: }
13631: }
13632: return 'error';
13633: }
13634:
13635: # --------------------------------------------------------------- Verify a symb
13636:
13637: sub symbverify {
13638: my ($symb,$thisurl,$encstate)=@_;
13639: my $thisfn=$thisurl;
13640: $thisfn=&declutter($thisfn);
13641: # direct jump to resource in page or to a sequence - will construct own symbs
13642: if ($thisfn=~/\.(page|sequence)$/) { return 1; }
13643: # check URL part
13644: my ($map,$resid,$url)=&decode_symb($symb);
13645:
13646: unless ($url eq $thisfn) { return 0; }
13647:
13648: $symb=&symbclean($symb);
13649: $thisurl=&deversion($thisurl);
13650: $thisfn=&deversion($thisfn);
13651:
13652: my %bighash;
13653: my $okay=0;
13654:
13655: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
13656: &GDBM_READER(),0640)) {
13657: if (($thisurl =~ m{^/adm/wrapper/ext/}) || ($thisurl =~ m{^ext/})) {
13658: $thisurl =~ s/\?.+$//;
13659: if ($map =~ m{^uploaded/.+\.page$}) {
13660: $thisurl =~ s{^(/adm/wrapper|)/ext/}{http://};
13661: $thisurl =~ s{^\Qhttp://https://\E}{https://};
13662: }
13663: }
13664: my $ids;
13665: if ($map =~ m{^uploaded/.+\.page$}) {
13666: $ids=$bighash{'ids_'.&clutter_with_no_wrapper($thisurl)};
13667: } else {
13668: $ids=$bighash{'ids_'.&clutter($thisurl)};
13669: }
13670: unless ($ids) {
13671: my $idkey = 'ids_'.($thisurl =~ m{^/}? '' : '/').$thisurl;
13672: $ids=$bighash{$idkey};
13673: }
13674: if ($ids) {
13675: # ------------------------------------------------------------------- Has ID(s)
13676: if ($thisfn =~ m{^/adm/wrapper/ext/}) {
13677: $symb =~ s/\?.+$//;
13678: }
13679: foreach my $id (split(/\,/,$ids)) {
13680: my ($mapid,$resid)=split(/\./,$id);
13681: if (
13682: &symbclean(&declutter($bighash{'map_id_'.$mapid}).'___'.$resid.'___'.$thisfn)
13683: eq $symb) {
13684: if (ref($encstate)) {
13685: $$encstate = $bighash{'encrypted_'.$id};
13686: }
13687: if (($env{'request.role.adv'}) ||
13688: ($bighash{'encrypted_'.$id} eq $env{'request.enc'}) ||
13689: ($thisurl eq '/adm/navmaps')) {
13690: $okay=1;
13691: last;
13692: }
13693: }
13694: }
13695: }
13696: untie(%bighash);
13697: }
13698: return $okay;
13699: }
13700:
13701: # --------------------------------------------------------------- Clean-up symb
13702:
13703: sub symbclean {
13704: my $symb=shift;
13705: if ($symb=~m|^/enc/|) { $symb=&Apache::lonenc::unencrypted($symb); }
13706: # remove version from map
13707: $symb=~s/\.(\d+)\.(\w+)\_\_\_/\.$2\_\_\_/;
13708:
13709: # remove version from URL
13710: $symb=~s/\.(\d+)\.(\w+)$/\.$2/;
13711:
13712: # remove wrapper
13713:
13714: $symb=~s/(\_\_\_\d+\_\_\_)adm\/wrapper\/(res\/)*/$1/;
13715: $symb=~s/(\_\_\_\d+\_\_\_)adm\/coursedocs\/showdoc\/(res\/)*/$1/;
13716: return $symb;
13717: }
13718:
13719: # ---------------------------------------------- Split symb to find map and url
13720:
13721: sub encode_symb {
13722: my ($map,$resid,$url)=@_;
13723: return &symbclean(&declutter($map).'___'.$resid.'___'.&declutter($url));
13724: }
13725:
13726: sub decode_symb {
13727: my $symb=shift;
13728: if ($symb=~m|^/enc/|) { $symb=&Apache::lonenc::unencrypted($symb); }
13729: my ($map,$resid,$url)=split(/___/,$symb);
13730: return (&fixversion($map),$resid,&fixversion($url));
13731: }
13732:
13733: sub fixversion {
13734: my $fn=shift;
13735: if ($fn=~/^(adm|uploaded|editupload|public)/) { return $fn; }
13736: my %bighash;
13737: my $uri=&clutter($fn);
13738: my $key=$env{'request.course.id'}.'_'.$uri;
13739: # is this cached?
13740: my ($result,$cached)=&is_cached_new('courseresversion',$key);
13741: if (defined($cached)) { return $result; }
13742: # unfortunately not cached, or expired
13743: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
13744: &GDBM_READER(),0640)) {
13745: if ($bighash{'version_'.$uri}) {
13746: my $version=$bighash{'version_'.$uri};
13747: unless (($version eq 'mostrecent') ||
13748: ($version==&getversion($uri))) {
13749: $uri=~s/\.(\w+)$/\.$version\.$1/;
13750: }
13751: }
13752: untie %bighash;
13753: }
13754: return &do_cache_new('courseresversion',$key,&declutter($uri),600);
13755: }
13756:
13757: sub deversion {
13758: my $url=shift;
13759: $url=~s/\.\d+\.(\w+)$/\.$1/;
13760: return $url;
13761: }
13762:
13763: # ------------------------------------------------------ Return symb list entry
13764:
13765: sub symbread {
13766: my ($thisfn,$donotrecurse,$ignorecachednull,$checkforblock,$possibles,
13767: $ignoresymbdb,$noenccheck)=@_;
13768: my $cache_str='request.symbread.cached.'.$thisfn;
13769: if (defined($env{$cache_str})) {
13770: unless (ref($possibles) eq 'HASH') {
13771: if ($ignorecachednull) {
13772: return $env{$cache_str} unless ($env{$cache_str} eq '');
13773: } else {
13774: return $env{$cache_str};
13775: }
13776: }
13777: }
13778: # no filename provided? try from environment
13779: unless ($thisfn) {
13780: if ($env{'request.symb'}) {
13781: return $env{$cache_str}=&symbclean($env{'request.symb'});
13782: }
13783: $thisfn=$env{'request.filename'};
13784: }
13785: if ($thisfn=~m|^/enc/|) { $thisfn=&Apache::lonenc::unencrypted($thisfn); }
13786: # is that filename actually a symb? Verify, clean, and return
13787: if ($thisfn=~/\_\_\_\d+\_\_\_(.*)$/) {
13788: if (&symbverify($thisfn,$1)) {
13789: return $env{$cache_str}=&symbclean($thisfn);
13790: }
13791: }
13792: $thisfn=declutter($thisfn);
13793: my %hash;
13794: my %bighash;
13795: my $syval='';
13796: if (($env{'request.course.fn'}) && ($thisfn)) {
13797: unless ($ignoresymbdb) {
13798: if (tie(%hash,'GDBM_File',$env{'request.course.fn'}.'_symb.db',
13799: &GDBM_READER(),0640)) {
13800: $syval=$hash{$thisfn};
13801: untie(%hash);
13802: }
13803: if ($syval && $checkforblock) {
13804: my @blockers = &has_comm_blocking('bre',$syval,$thisfn,$ignoresymbdb,$noenccheck);
13805: if (@blockers) {
13806: $syval='';
13807: }
13808: }
13809: }
13810: # ---------------------------------------------------------- There was an entry
13811: if ($syval) {
13812: #unless ($syval=~/\_\d+$/) {
13813: #unless ($env{'form.request.prefix'}=~/\.(\d+)\_$/) {
13814: #&appenv({'request.ambiguous' => $thisfn});
13815: #return $env{$cache_str}='';
13816: #}
13817: #$syval.=$1;
13818: #}
13819: } else {
13820: # ------------------------------------------------------- Was not in symb table
13821: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
13822: &GDBM_READER(),0640)) {
13823: # ---------------------------------------------- Get ID(s) for current resource
13824: my $ids=$bighash{'ids_'.&clutter($thisfn)};
13825: unless ($ids) {
13826: $ids=$bighash{'ids_/'.$thisfn};
13827: }
13828: unless ($ids) {
13829: # alias?
13830: $ids=$bighash{'mapalias_'.$thisfn};
13831: }
13832: if ($ids) {
13833: # ------------------------------------------------------------------- Has ID(s)
13834: my @possibilities=split(/\,/,$ids);
13835: if ($#possibilities==0) {
13836: # ----------------------------------------------- There is only one possibility
13837: my ($mapid,$resid)=split(/\./,$ids);
13838: $syval=&encode_symb($bighash{'map_id_'.$mapid},
13839: $resid,$thisfn);
13840: if (ref($possibles) eq 'HASH') {
13841: unless ($bighash{'randomout_'.$ids} || $env{'request.role.adv'}) {
13842: $possibles->{$syval} = 1;
13843: }
13844: }
13845: if ($checkforblock) {
13846: unless ($bighash{'randomout_'.$ids} || $env{'request.role.adv'}) {
13847: my @blockers = &has_comm_blocking('bre',$syval,$bighash{'src_'.$ids},'',$noenccheck);
13848: if (@blockers) {
13849: $syval = '';
13850: untie(%bighash);
13851: return $env{$cache_str}='';
13852: }
13853: }
13854: }
13855: } elsif ((!$donotrecurse) || ($checkforblock) || (ref($possibles) eq 'HASH')) {
13856: # ------------------------------------------ There is more than one possibility
13857: my $realpossible=0;
13858: foreach my $id (@possibilities) {
13859: my $file=$bighash{'src_'.$id};
13860: my $canaccess;
13861: if (($donotrecurse) || ($checkforblock) || (ref($possibles) eq 'HASH')) {
13862: $canaccess = 1;
13863: } else {
13864: $canaccess = &allowed('bre',$file);
13865: }
13866: if ($canaccess) {
13867: my ($mapid,$resid)=split(/\./,$id);
13868: if ($bighash{'map_type_'.$mapid} ne 'page') {
13869: my $poss_syval=&encode_symb($bighash{'map_id_'.$mapid},
13870: $resid,$thisfn);
13871: next if ($bighash{'randomout_'.$id} && !$env{'request.role.adv'});
13872: next unless (($noenccheck) || ($bighash{'encrypted_'.$id} eq $env{'request.enc'}));
13873: if ($checkforblock) {
13874: my @blockers = &has_comm_blocking('bre',$poss_syval,$file,'',$noenccheck);
13875: if (@blockers > 0) {
13876: $syval = '';
13877: } else {
13878: $syval = $poss_syval;
13879: $realpossible++;
13880: }
13881: } else {
13882: $syval = $poss_syval;
13883: $realpossible++;
13884: }
13885: if ($syval) {
13886: if (ref($possibles) eq 'HASH') {
13887: $possibles->{$syval} = 1;
13888: }
13889: }
13890: }
13891: }
13892: }
13893: if ($realpossible!=1) { $syval=''; }
13894: } else {
13895: $syval='';
13896: }
13897: }
13898: untie(%bighash);
13899: }
13900: }
13901: if ($syval) {
13902: return $env{$cache_str}=$syval;
13903: }
13904: }
13905: &appenv({'request.ambiguous' => $thisfn});
13906: return $env{$cache_str}='';
13907: }
13908:
13909: # ---------------------------------------------------------- Return random seed
13910:
13911: sub numval {
13912: my $txt=shift;
13913: $txt=~tr/A-J/0-9/;
13914: $txt=~tr/a-j/0-9/;
13915: $txt=~tr/K-T/0-9/;
13916: $txt=~tr/k-t/0-9/;
13917: $txt=~tr/U-Z/0-5/;
13918: $txt=~tr/u-z/0-5/;
13919: $txt=~s/\D//g;
13920: if ($_64bit) { if ($txt > 2**32) { return -1; } }
13921: return int($txt);
13922: }
13923:
13924: sub numval2 {
13925: my $txt=shift;
13926: $txt=~tr/A-J/0-9/;
13927: $txt=~tr/a-j/0-9/;
13928: $txt=~tr/K-T/0-9/;
13929: $txt=~tr/k-t/0-9/;
13930: $txt=~tr/U-Z/0-5/;
13931: $txt=~tr/u-z/0-5/;
13932: $txt=~s/\D//g;
13933: my @txts=split(/(\d\d\d\d\d\d\d\d\d)/,$txt);
13934: my $total;
13935: foreach my $val (@txts) { $total+=$val; }
13936: if ($_64bit) { if ($total > 2**32) { return -1; } }
13937: return int($total);
13938: }
13939:
13940: sub numval3 {
13941: use integer;
13942: my $txt=shift;
13943: $txt=~tr/A-J/0-9/;
13944: $txt=~tr/a-j/0-9/;
13945: $txt=~tr/K-T/0-9/;
13946: $txt=~tr/k-t/0-9/;
13947: $txt=~tr/U-Z/0-5/;
13948: $txt=~tr/u-z/0-5/;
13949: $txt=~s/\D//g;
13950: my @txts=split(/(\d\d\d\d\d\d\d\d\d)/,$txt);
13951: my $total;
13952: foreach my $val (@txts) { $total+=$val; }
13953: if ($_64bit) { $total=(($total<<32)>>32); }
13954: return $total;
13955: }
13956:
13957: sub digest {
13958: my ($data)=@_;
13959: my $digest=&Digest::MD5::md5($data);
13960: my ($a,$b,$c,$d)=unpack("iiii",$digest);
13961: my ($e,$f);
13962: {
13963: use integer;
13964: $e=($a+$b);
13965: $f=($c+$d);
13966: if ($_64bit) {
13967: $e=(($e<<32)>>32);
13968: $f=(($f<<32)>>32);
13969: }
13970: }
13971: if (wantarray) {
13972: return ($e,$f);
13973: } else {
13974: my $g;
13975: {
13976: use integer;
13977: $g=($e+$f);
13978: if ($_64bit) {
13979: $g=(($g<<32)>>32);
13980: }
13981: }
13982: return $g;
13983: }
13984: }
13985:
13986: sub latest_rnd_algorithm_id {
13987: return '64bit5';
13988: }
13989:
13990: sub get_rand_alg {
13991: my ($courseid)=@_;
13992: if (!$courseid) { $courseid=(&whichuser())[1]; }
13993: if ($courseid) {
13994: return $env{"course.$courseid.rndseed"};
13995: }
13996: return &latest_rnd_algorithm_id();
13997: }
13998:
13999: sub validCODE {
14000: my ($CODE)=@_;
14001: if (defined($CODE) && $CODE ne '' && $CODE =~ /^\w+$/) { return 1; }
14002: return 0;
14003: }
14004:
14005: sub getCODE {
14006: if (&validCODE($env{'form.CODE'})) { return $env{'form.CODE'}; }
14007: if ( (defined($Apache::lonhomework::parsing_a_problem) ||
14008: defined($Apache::lonhomework::parsing_a_task) ) &&
14009: &validCODE($Apache::lonhomework::history{'resource.CODE'})) {
14010: return $Apache::lonhomework::history{'resource.CODE'};
14011: }
14012: return undef;
14013: }
14014: #
14015: # Determines the random seed for a specific context:
14016: #
14017: # parameters:
14018: # symb - in course context the symb for the seed.
14019: # course_id - The course id of the form domain_coursenum.
14020: # domain - Domain for the user.
14021: # course - Course for the user.
14022: # cenv - environment of the course.
14023: #
14024: # NOTE:
14025: # All parameters are picked out of the environment if missing
14026: # or not defined.
14027: # If a symb cannot be determined the current time is used instead.
14028: #
14029: # For a given well defined symb, courside, domain, username,
14030: # and course environment, the seed is reproducible.
14031: #
14032: sub rndseed {
14033: my ($symb,$courseid,$domain,$username, $cenv)=@_;
14034: my ($wsymb,$wcourseid,$wdomain,$wusername)=&whichuser();
14035: if (!defined($symb)) {
14036: unless ($symb=$wsymb) { return time; }
14037: }
14038: if (!defined $courseid) {
14039: $courseid=$wcourseid;
14040: }
14041: if (!defined $domain) { $domain=$wdomain; }
14042: if (!defined $username) { $username=$wusername }
14043:
14044: my $which;
14045: if (defined($cenv->{'rndseed'})) {
14046: $which = $cenv->{'rndseed'};
14047: } else {
14048: $which =&get_rand_alg($courseid);
14049: }
14050: if (defined(&getCODE())) {
14051:
14052: if ($which eq '64bit5') {
14053: return &rndseed_CODE_64bit5($symb,$courseid,$domain,$username);
14054: } elsif ($which eq '64bit4') {
14055: return &rndseed_CODE_64bit4($symb,$courseid,$domain,$username);
14056: } else {
14057: return &rndseed_CODE_64bit($symb,$courseid,$domain,$username);
14058: }
14059: } elsif ($which eq '64bit5') {
14060: return &rndseed_64bit5($symb,$courseid,$domain,$username);
14061: } elsif ($which eq '64bit4') {
14062: return &rndseed_64bit4($symb,$courseid,$domain,$username);
14063: } elsif ($which eq '64bit3') {
14064: return &rndseed_64bit3($symb,$courseid,$domain,$username);
14065: } elsif ($which eq '64bit2') {
14066: return &rndseed_64bit2($symb,$courseid,$domain,$username);
14067: } elsif ($which eq '64bit') {
14068: return &rndseed_64bit($symb,$courseid,$domain,$username);
14069: }
14070: return &rndseed_32bit($symb,$courseid,$domain,$username);
14071: }
14072:
14073: sub rndseed_32bit {
14074: my ($symb,$courseid,$domain,$username)=@_;
14075: {
14076: use integer;
14077: my $symbchck=unpack("%32C*",$symb) << 27;
14078: my $symbseed=numval($symb) << 22;
14079: my $namechck=unpack("%32C*",$username) << 17;
14080: my $nameseed=numval($username) << 12;
14081: my $domainseed=unpack("%32C*",$domain) << 7;
14082: my $courseseed=unpack("%32C*",$courseid);
14083: my $num=$symbseed+$nameseed+$domainseed+$courseseed+$namechck+$symbchck;
14084: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
14085: #&logthis("rndseed :$num:$symb");
14086: if ($_64bit) { $num=(($num<<32)>>32); }
14087: return $num;
14088: }
14089: }
14090:
14091: sub rndseed_64bit {
14092: my ($symb,$courseid,$domain,$username)=@_;
14093: {
14094: use integer;
14095: my $symbchck=unpack("%32S*",$symb) << 21;
14096: my $symbseed=numval($symb) << 10;
14097: my $namechck=unpack("%32S*",$username);
14098:
14099: my $nameseed=numval($username) << 21;
14100: my $domainseed=unpack("%32S*",$domain) << 10;
14101: my $courseseed=unpack("%32S*",$courseid);
14102:
14103: my $num1=$symbchck+$symbseed+$namechck;
14104: my $num2=$nameseed+$domainseed+$courseseed;
14105: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
14106: #&logthis("rndseed :$num:$symb");
14107: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
14108: return "$num1,$num2";
14109: }
14110: }
14111:
14112: sub rndseed_64bit2 {
14113: my ($symb,$courseid,$domain,$username)=@_;
14114: {
14115: use integer;
14116: # strings need to be an even # of cahracters long, it it is odd the
14117: # last characters gets thrown away
14118: my $symbchck=unpack("%32S*",$symb.' ') << 21;
14119: my $symbseed=numval($symb) << 10;
14120: my $namechck=unpack("%32S*",$username.' ');
14121:
14122: my $nameseed=numval($username) << 21;
14123: my $domainseed=unpack("%32S*",$domain.' ') << 10;
14124: my $courseseed=unpack("%32S*",$courseid.' ');
14125:
14126: my $num1=$symbchck+$symbseed+$namechck;
14127: my $num2=$nameseed+$domainseed+$courseseed;
14128: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
14129: #&logthis("rndseed :$num:$symb");
14130: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
14131: return "$num1,$num2";
14132: }
14133: }
14134:
14135: sub rndseed_64bit3 {
14136: my ($symb,$courseid,$domain,$username)=@_;
14137: {
14138: use integer;
14139: # strings need to be an even # of cahracters long, it it is odd the
14140: # last characters gets thrown away
14141: my $symbchck=unpack("%32S*",$symb.' ') << 21;
14142: my $symbseed=numval2($symb) << 10;
14143: my $namechck=unpack("%32S*",$username.' ');
14144:
14145: my $nameseed=numval2($username) << 21;
14146: my $domainseed=unpack("%32S*",$domain.' ') << 10;
14147: my $courseseed=unpack("%32S*",$courseid.' ');
14148:
14149: my $num1=$symbchck+$symbseed+$namechck;
14150: my $num2=$nameseed+$domainseed+$courseseed;
14151: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
14152: #&logthis("rndseed :$num1:$num2:$_64bit");
14153: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
14154:
14155: return "$num1:$num2";
14156: }
14157: }
14158:
14159: sub rndseed_64bit4 {
14160: my ($symb,$courseid,$domain,$username)=@_;
14161: {
14162: use integer;
14163: # strings need to be an even # of cahracters long, it it is odd the
14164: # last characters gets thrown away
14165: my $symbchck=unpack("%32S*",$symb.' ') << 21;
14166: my $symbseed=numval3($symb) << 10;
14167: my $namechck=unpack("%32S*",$username.' ');
14168:
14169: my $nameseed=numval3($username) << 21;
14170: my $domainseed=unpack("%32S*",$domain.' ') << 10;
14171: my $courseseed=unpack("%32S*",$courseid.' ');
14172:
14173: my $num1=$symbchck+$symbseed+$namechck;
14174: my $num2=$nameseed+$domainseed+$courseseed;
14175: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
14176: #&logthis("rndseed :$num1:$num2:$_64bit");
14177: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
14178:
14179: return "$num1:$num2";
14180: }
14181: }
14182:
14183: sub rndseed_64bit5 {
14184: my ($symb,$courseid,$domain,$username)=@_;
14185: my ($num1,$num2)=&digest("$symb,$courseid,$domain,$username");
14186: return "$num1:$num2";
14187: }
14188:
14189: sub rndseed_CODE_64bit {
14190: my ($symb,$courseid,$domain,$username)=@_;
14191: {
14192: use integer;
14193: my $symbchck=unpack("%32S*",$symb.' ') << 16;
14194: my $symbseed=numval2($symb);
14195: my $CODEchck=unpack("%32S*",&getCODE().' ') << 16;
14196: my $CODEseed=numval(&getCODE());
14197: my $courseseed=unpack("%32S*",$courseid.' ');
14198: my $num1=$symbseed+$CODEchck;
14199: my $num2=$CODEseed+$courseseed+$symbchck;
14200: #&logthis("$symbseed:$CODEchck|$CODEseed:$courseseed:$symbchck");
14201: #&logthis("rndseed :$num1:$num2:$symb");
14202: if ($_64bit) { $num1=(($num1<<32)>>32); }
14203: if ($_64bit) { $num2=(($num2<<32)>>32); }
14204: return "$num1:$num2";
14205: }
14206: }
14207:
14208: sub rndseed_CODE_64bit4 {
14209: my ($symb,$courseid,$domain,$username)=@_;
14210: {
14211: use integer;
14212: my $symbchck=unpack("%32S*",$symb.' ') << 16;
14213: my $symbseed=numval3($symb);
14214: my $CODEchck=unpack("%32S*",&getCODE().' ') << 16;
14215: my $CODEseed=numval3(&getCODE());
14216: my $courseseed=unpack("%32S*",$courseid.' ');
14217: my $num1=$symbseed+$CODEchck;
14218: my $num2=$CODEseed+$courseseed+$symbchck;
14219: #&logthis("$symbseed:$CODEchck|$CODEseed:$courseseed:$symbchck");
14220: #&logthis("rndseed :$num1:$num2:$symb");
14221: if ($_64bit) { $num1=(($num1<<32)>>32); }
14222: if ($_64bit) { $num2=(($num2<<32)>>32); }
14223: return "$num1:$num2";
14224: }
14225: }
14226:
14227: sub rndseed_CODE_64bit5 {
14228: my ($symb,$courseid,$domain,$username)=@_;
14229: my $code = &getCODE();
14230: my ($num1,$num2)=&digest("$symb,$courseid,$code");
14231: return "$num1:$num2";
14232: }
14233:
14234: sub setup_random_from_rndseed {
14235: my ($rndseed)=@_;
14236: if ($rndseed =~/([,:])/) {
14237: my ($num1,$num2) = map { abs($_); } (split(/[,:]/,$rndseed));
14238: if ((!$num1) || (!$num2) || ($num1 > 2147483562) || ($num2 > 2147483398)) {
14239: &Math::Random::random_set_seed_from_phrase($rndseed);
14240: } else {
14241: &Math::Random::random_set_seed($num1,$num2);
14242: }
14243: } else {
14244: &Math::Random::random_set_seed_from_phrase($rndseed);
14245: }
14246: }
14247:
14248: sub latest_receipt_algorithm_id {
14249: return 'receipt3';
14250: }
14251:
14252: sub recunique {
14253: my $fucourseid=shift;
14254: my $unique;
14255: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2' ||
14256: $env{"course.$fucourseid.receiptalg"} eq 'receipt3' ) {
14257: $unique=$env{"course.$fucourseid.internal.encseed"};
14258: } else {
14259: $unique=$perlvar{'lonReceipt'};
14260: }
14261: return unpack("%32C*",$unique);
14262: }
14263:
14264: sub recprefix {
14265: my $fucourseid=shift;
14266: my $prefix;
14267: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2'||
14268: $env{"course.$fucourseid.receiptalg"} eq 'receipt3' ) {
14269: $prefix=$env{"course.$fucourseid.internal.encpref"};
14270: } else {
14271: $prefix=$perlvar{'lonHostID'};
14272: }
14273: return unpack("%32C*",$prefix);
14274: }
14275:
14276: sub ireceipt {
14277: my ($funame,$fudom,$fucourseid,$fusymb,$part)=@_;
14278:
14279: my $return =&recprefix($fucourseid).'-';
14280:
14281: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt3' ||
14282: $env{'request.state'} eq 'construct') {
14283: $return .= (&digest("$funame,$fudom,$fucourseid,$fusymb,$part")%10000);
14284: return $return;
14285: }
14286:
14287: my $cuname=unpack("%32C*",$funame);
14288: my $cudom=unpack("%32C*",$fudom);
14289: my $cucourseid=unpack("%32C*",$fucourseid);
14290: my $cusymb=unpack("%32C*",$fusymb);
14291: my $cunique=&recunique($fucourseid);
14292: my $cpart=unpack("%32S*",$part);
14293: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2') {
14294:
14295: #&logthis("doing receipt2 using parts $cpart, uname $cuname and udom $cudom gets ".($cpart%$cuname)." and ".($cpart%$cudom));
14296:
14297: $return.= ($cunique%$cuname+
14298: $cunique%$cudom+
14299: $cusymb%$cuname+
14300: $cusymb%$cudom+
14301: $cucourseid%$cuname+
14302: $cucourseid%$cudom+
14303: $cpart%$cuname+
14304: $cpart%$cudom);
14305: } else {
14306: $return.= ($cunique%$cuname+
14307: $cunique%$cudom+
14308: $cusymb%$cuname+
14309: $cusymb%$cudom+
14310: $cucourseid%$cuname+
14311: $cucourseid%$cudom);
14312: }
14313: return $return;
14314: }
14315:
14316: sub receipt {
14317: my ($part)=@_;
14318: my ($symb,$courseid,$domain,$name) = &whichuser();
14319: return &ireceipt($name,$domain,$courseid,$symb,$part);
14320: }
14321:
14322: sub whichuser {
14323: my ($passedsymb)=@_;
14324: my ($symb,$courseid,$domain,$name,$publicuser);
14325: if (defined($env{'form.grade_symb'})) {
14326: my ($tmp_courseid)=&get_env_multiple('form.grade_courseid');
14327: my $allowed=&allowed('vgr',$tmp_courseid);
14328: if (!$allowed &&
14329: exists($env{'request.course.sec'}) &&
14330: $env{'request.course.sec'} !~ /^\s*$/) {
14331: $allowed=&allowed('vgr',$tmp_courseid.
14332: '/'.$env{'request.course.sec'});
14333: }
14334: if ($allowed) {
14335: ($symb)=&get_env_multiple('form.grade_symb');
14336: $courseid=$tmp_courseid;
14337: ($domain)=&get_env_multiple('form.grade_domain');
14338: ($name)=&get_env_multiple('form.grade_username');
14339: return ($symb,$courseid,$domain,$name,$publicuser);
14340: }
14341: }
14342: if (!$passedsymb) {
14343: $symb=&symbread();
14344: } else {
14345: $symb=$passedsymb;
14346: }
14347: $courseid=$env{'request.course.id'};
14348: $domain=$env{'user.domain'};
14349: $name=$env{'user.name'};
14350: if ($name eq 'public' && $domain eq 'public') {
14351: if (!defined($env{'form.username'})) {
14352: $env{'form.username'}.=time.rand(10000000);
14353: }
14354: $name.=$env{'form.username'};
14355: }
14356: return ($symb,$courseid,$domain,$name,$publicuser);
14357:
14358: }
14359:
14360: # ------------------------------------------------------------ Serves up a file
14361: # returns either the contents of the file or
14362: # -1 if the file doesn't exist
14363: #
14364: # if the target is a file that was uploaded via DOCS,
14365: # a check will be made to see if a current copy exists on the local server,
14366: # if it does this will be served, otherwise a copy will be retrieved from
14367: # the home server for the course and stored in /home/httpd/html/userfiles on
14368: # the local server.
14369:
14370: sub getfile {
14371: my ($file) = @_;
14372: if ($file =~ m -^/*(uploaded|editupload)/-) { $file=&filelocation("",$file); }
14373: &repcopy($file);
14374: return &readfile($file);
14375: }
14376:
14377: sub repcopy_userfile {
14378: my ($file)=@_;
14379: my $londocroot = $perlvar{'lonDocRoot'};
14380: if ($file =~ m{^/*(uploaded|editupload)/}) { $file=&filelocation("",$file); }
14381: if ($file =~ m{^\Q/home/httpd/lonUsers/\E}) { return 'ok'; }
14382: my ($cdom,$cnum,$filename) =
14383: ($file=~m|^\Q$perlvar{'lonDocRoot'}\E/+userfiles/+($match_domain)/+($match_name)/+(.*)|);
14384: my $uri="/uploaded/$cdom/$cnum/$filename";
14385: if (-e "$file") {
14386: # we already have a local copy, check it out
14387: my @fileinfo = stat($file);
14388: my $rtncode;
14389: my $info;
14390: my $lwpresp = &getuploaded('HEAD',$uri,$cdom,$cnum,\$info,\$rtncode);
14391: if ($lwpresp ne 'ok') {
14392: # there is no such file anymore, even though we had a local copy
14393: if ($rtncode eq '404') {
14394: unlink($file);
14395: }
14396: return -1;
14397: }
14398: if ($info < $fileinfo[9]) {
14399: # nice, the file we have is up-to-date, just say okay
14400: return 'ok';
14401: } else {
14402: # the file is outdated, get rid of it
14403: unlink($file);
14404: }
14405: }
14406: # one way or the other, at this point, we don't have the file
14407: # construct the correct path for the file
14408: my @parts = ($cdom,$cnum);
14409: if ($filename =~ m|^(.+)/[^/]+$|) {
14410: push @parts, split(/\//,$1);
14411: }
14412: my $path = $perlvar{'lonDocRoot'}.'/userfiles';
14413: foreach my $part (@parts) {
14414: $path .= '/'.$part;
14415: if (!-e $path) {
14416: mkdir($path,0770);
14417: }
14418: }
14419: # now the path exists for sure
14420: # get a user agent
14421: my $transferfile=$file.'.in.transfer';
14422: # FIXME: this should flock
14423: if (-e $transferfile) { return 'ok'; }
14424: my $request;
14425: $uri=~s/^\///;
14426: my $homeserver = &homeserver($cnum,$cdom);
14427: my $hostname = &hostname($homeserver);
14428: my $protocol = $protocol{$homeserver};
14429: $protocol = 'http' if ($protocol ne 'https');
14430: $request=new HTTP::Request('GET',$protocol.'://'.$hostname.'/raw/'.$uri);
14431: my $response = &LONCAPA::LWPReq::makerequest($homeserver,$request,$transferfile,\%perlvar,'',0,1);
14432: # did it work?
14433: if ($response->is_error()) {
14434: unlink($transferfile);
14435: &logthis("Userfile repcopy failed for $uri");
14436: return -1;
14437: }
14438: # worked, rename the transfer file
14439: rename($transferfile,$file);
14440: return 'ok';
14441: }
14442:
14443: sub tokenwrapper {
14444: my $uri=shift;
14445: $uri=~s|^https?\://([^/]+)||;
14446: $uri=~s|^/||;
14447: $env{'user.environment'}=~/\/([^\/]+)\.id/;
14448: my $token=$1;
14449: my (undef,$udom,$uname,$file)=split('/',$uri,4);
14450: if ($udom && $uname && $file) {
14451: $file=~s|(\?\.*)*$||;
14452: &appenv({"userfile.$udom/$uname/$file" => $env{'request.course.id'}});
14453: my $homeserver = &homeserver($uname,$udom);
14454: my $hostname = &hostname($homeserver);
14455: my $protocol = $protocol{$homeserver};
14456: $protocol = 'http' if ($protocol ne 'https');
14457: return $protocol.'://'.$hostname.'/'.$uri.
14458: (($uri=~/\?/)?'&':'?').'token='.$token.
14459: '&tokenissued='.$perlvar{'lonHostID'};
14460: } else {
14461: return '/adm/notfound.html';
14462: }
14463: }
14464:
14465: # call with reqtype HEAD: get last modification time
14466: # call with reqtype GET: get the file contents
14467: # Do not call this with reqtype GET for large files! It loads everything into memory
14468: #
14469: sub getuploaded {
14470: my ($reqtype,$uri,$cdom,$cnum,$info,$rtncode) = @_;
14471: $uri=~s/^\///;
14472: my $homeserver = &homeserver($cnum,$cdom);
14473: my $hostname = &hostname($homeserver);
14474: my $protocol = $protocol{$homeserver};
14475: $protocol = 'http' if ($protocol ne 'https');
14476: $uri = $protocol.'://'.$hostname.'/raw/'.$uri;
14477: my $request=new HTTP::Request($reqtype,$uri);
14478: my $response=&LONCAPA::LWPReq::makerequest($homeserver,$request,'',\%perlvar,'',0,1);
14479: $$rtncode = $response->code;
14480: if (! $response->is_success()) {
14481: return 'failed';
14482: }
14483: if ($reqtype eq 'HEAD') {
14484: $$info = &HTTP::Date::str2time( $response->header('Last-modified') );
14485: } elsif ($reqtype eq 'GET') {
14486: $$info = $response->content;
14487: }
14488: return 'ok';
14489: }
14490:
14491: sub readfile {
14492: my $file = shift;
14493: if ( (! -e $file ) || ($file eq '') ) { return -1; };
14494: my $fh;
14495: open($fh,"<",$file);
14496: my $a='';
14497: while (my $line = <$fh>) { $a .= $line; }
14498: return $a;
14499: }
14500:
14501: sub filelocation {
14502: my ($dir,$file) = @_;
14503: my $location;
14504: $file=~ s/^\s*(\S+)\s*$/$1/; ## strip off leading and trailing spaces
14505:
14506: if ($file =~ m-^/adm/-) {
14507: $file=~s-^/adm/wrapper/-/-;
14508: $file=~s-^/adm/coursedocs/showdoc/-/-;
14509: }
14510:
14511: if ($file =~ m-^\Q$Apache::lonnet::perlvar{'lonTabDir'}\E/-) {
14512: $location = $file;
14513: } elsif ($file=~/^\/*(uploaded|editupload)/) { # is an uploaded file
14514: my ($udom,$uname,$filename)=
14515: ($file=~m -^/+(?:uploaded|editupload)/+($match_domain)/+($match_name)/+(.*)$-);
14516: my $home=&homeserver($uname,$udom);
14517: my $is_me=0;
14518: my @ids=¤t_machine_ids();
14519: foreach my $id (@ids) { if ($id eq $home) { $is_me=1; } }
14520: if ($is_me) {
14521: $location=propath($udom,$uname).'/userfiles/'.$filename;
14522: } else {
14523: $location=$Apache::lonnet::perlvar{'lonDocRoot'}.'/userfiles/'.
14524: $udom.'/'.$uname.'/'.$filename;
14525: }
14526: } elsif ($file =~ m-^/adm/-) {
14527: $location = $perlvar{'lonDocRoot'}.'/'.$file;
14528: } else {
14529: $file=~s/^\Q$perlvar{'lonDocRoot'}\E//;
14530: $file=~s:^/(res|priv)/:/:;
14531: my $space=$1;
14532: if ( !( $file =~ m:^/:) ) {
14533: $location = $dir. '/'.$file;
14534: } else {
14535: $location = $perlvar{'lonDocRoot'}.'/'.$space.$file;
14536: }
14537: }
14538: $location=~s://+:/:g; # remove duplicate /
14539: while ($location=~m{/\.\./}) {
14540: if ($location =~ m{/[^/]+/\.\./}) {
14541: $location=~ s{/[^/]+/\.\./}{/}g;
14542: } else {
14543: $location=~ s{/\.\./}{/}g;
14544: }
14545: } #remove dir/..
14546: while ($location=~m:/\./:) {$location=~ s:/\./:/:g;} #remove /./
14547: return $location;
14548: }
14549:
14550: sub hreflocation {
14551: my ($dir,$file)=@_;
14552: unless (($file=~m-^https?\://-i) || ($file=~m-^/-)) {
14553: $file=filelocation($dir,$file);
14554: } elsif ($file=~m-^/adm/-) {
14555: $file=~s-^/adm/wrapper/-/-;
14556: $file=~s-^/adm/coursedocs/showdoc/-/-;
14557: }
14558: if ($file=~m-^\Q$perlvar{'lonDocRoot'}\E-) {
14559: $file=~s-^\Q$perlvar{'lonDocRoot'}\E--;
14560: } elsif ($file=~m-^\Q$perlvar{'lonUsersDir'}\E-) {
14561: $file=~s{^/home/httpd/lonUsers/($match_domain)/./././($match_name)/userfiles/}
14562: {/uploaded/$1/$2/}x;
14563: }
14564: if ($file=~ m{^/userfiles/}) {
14565: $file =~ s{^/userfiles/}{/uploaded/};
14566: }
14567: return $file;
14568: }
14569:
14570:
14571:
14572:
14573:
14574: sub current_machine_domains {
14575: return &machine_domains(&hostname($perlvar{'lonHostID'}));
14576: }
14577:
14578: sub machine_domains {
14579: my ($hostname) = @_;
14580: my @domains;
14581: my %hostname = &all_hostnames();
14582: while( my($id, $name) = each(%hostname)) {
14583: # &logthis("-$id-$name-$hostname-");
14584: if ($hostname eq $name) {
14585: push(@domains,&host_domain($id));
14586: }
14587: }
14588: return @domains;
14589: }
14590:
14591: sub current_machine_ids {
14592: return &machine_ids(&hostname($perlvar{'lonHostID'}));
14593: }
14594:
14595: sub machine_ids {
14596: my ($hostname) = @_;
14597: $hostname ||= &hostname($perlvar{'lonHostID'});
14598: my @ids;
14599: my %name_to_host = &all_names();
14600: if (ref($name_to_host{$hostname}) eq 'ARRAY') {
14601: return @{ $name_to_host{$hostname} };
14602: }
14603: return;
14604: }
14605:
14606: sub additional_machine_domains {
14607: my @domains;
14608: if (-e "$perlvar{'lonTabDir'}/expected_domains.tab") {
14609: if (open(my $fh,"<","$perlvar{'lonTabDir'}/expected_domains.tab")) {
14610: while (my $line = <$fh>) {
14611: chomp($line);
14612: $line =~ s/\s//g;
14613: push(@domains,$line);
14614: }
14615: close($fh);
14616: }
14617: }
14618: return @domains;
14619: }
14620:
14621: sub default_login_domain {
14622: my $domain = $perlvar{'lonDefDomain'};
14623: my $testdomain=(split(/\./,$ENV{'HTTP_HOST'}))[0];
14624: foreach my $posdom (¤t_machine_domains(),
14625: &additional_machine_domains()) {
14626: if (lc($posdom) eq lc($testdomain)) {
14627: $domain=$posdom;
14628: last;
14629: }
14630: }
14631: return $domain;
14632: }
14633:
14634: sub shared_institution {
14635: my ($dom,$lonhost) = @_;
14636: if ($lonhost eq '') {
14637: $lonhost = $perlvar{'lonHostID'};
14638: }
14639: my $same_intdom;
14640: my $hostintdom = &internet_dom($lonhost);
14641: if ($hostintdom ne '') {
14642: my %iphost = &get_iphost();
14643: my $primary_id = &domain($dom,'primary');
14644: my $primary_ip = &get_host_ip($primary_id);
14645: if (ref($iphost{$primary_ip}) eq 'ARRAY') {
14646: foreach my $id (@{$iphost{$primary_ip}}) {
14647: my $intdom = &internet_dom($id);
14648: if ($intdom eq $hostintdom) {
14649: $same_intdom = 1;
14650: last;
14651: }
14652: }
14653: }
14654: }
14655: return $same_intdom;
14656: }
14657:
14658: sub uses_sts {
14659: my ($ignore_cache) = @_;
14660: my $lonhost = $perlvar{'lonHostID'};
14661: my $hostname = &hostname($lonhost);
14662: my $sts_on;
14663: if ($protocol{$lonhost} eq 'https') {
14664: my $cachetime = 12*3600;
14665: if (!$ignore_cache) {
14666: ($sts_on,my $cached)=&is_cached_new('stspolicy',$lonhost);
14667: if (defined($cached)) {
14668: return $sts_on;
14669: }
14670: }
14671: my $url = $protocol{$lonhost}.'://'.$hostname.'/index.html';
14672: my $request=new HTTP::Request('HEAD',$url);
14673: my $response=&LONCAPA::LWPReq::makerequest($lonhost,$request,'',\%perlvar,'','','',1);
14674: if ($response->is_success) {
14675: my $has_sts = $response->header('Strict-Transport-Security');
14676: if ($has_sts eq '') {
14677: $sts_on = 0;
14678: } else {
14679: if ($has_sts =~ /\Qmax-age=\E(\d+)/) {
14680: my $maxage = $1;
14681: if ($maxage) {
14682: $sts_on = 1;
14683: } else {
14684: $sts_on = 0;
14685: }
14686: } else {
14687: $sts_on = 0;
14688: }
14689: }
14690: return &do_cache_new('stspolicy',$lonhost,$sts_on,$cachetime);
14691: }
14692: }
14693: return;
14694: }
14695:
14696: sub waf_allssl {
14697: my ($host_name) = @_;
14698: my $alias = &get_proxy_alias();
14699: if ($host_name eq '') {
14700: $host_name = $ENV{'SERVER_NAME'};
14701: }
14702: if (($host_name ne '') && ($alias eq $host_name)) {
14703: my $serverhomedom = &host_domain($perlvar{'lonHostID'});
14704: my %defdomdefaults = &get_domain_defaults($serverhomedom);
14705: if ($defdomdefaults{'waf_sslopt'}) {
14706: return $defdomdefaults{'waf_sslopt'};
14707: }
14708: }
14709: return;
14710: }
14711:
14712: sub get_requestor_ip {
14713: my ($r,$nolookup,$noproxy) = @_;
14714: my $from_ip;
14715: if (ref($r)) {
14716: if ($r->can('useragent_ip')) {
14717: if ($noproxy && $r->can('client_ip')) {
14718: $from_ip = $r->client_ip();
14719: } else {
14720: $from_ip = $r->useragent_ip();
14721: }
14722: } elsif ($r->connection->can('remote_ip')) {
14723: $from_ip = $r->connection->remote_ip();
14724: } else {
14725: $from_ip = $r->get_remote_host($nolookup);
14726: }
14727: } else {
14728: $from_ip = $ENV{'REMOTE_ADDR'};
14729: }
14730: return $from_ip if ($noproxy);
14731: # Who controls proxy settings for server
14732: my $dom_in_use = $Apache::lonnet::perlvar{'lonDefDomain'};
14733: my $proxyinfo = &get_proxy_settings($dom_in_use);
14734: if ((ref($proxyinfo) eq 'HASH') && ($from_ip)) {
14735: if ($proxyinfo->{'vpnint'}) {
14736: if (&ip_match($from_ip,$proxyinfo->{'vpnint'})) {
14737: return $from_ip;
14738: }
14739: }
14740: if ($proxyinfo->{'trusted'}) {
14741: if (&ip_match($from_ip,$proxyinfo->{'trusted'})) {
14742: my $ipheader = $proxyinfo->{'ipheader'};
14743: my ($ip,$xfor);
14744: if (ref($r)) {
14745: if ($ipheader) {
14746: $ip = $r->headers_in->{$ipheader};
14747: }
14748: $xfor = $r->headers_in->{'X-Forwarded-For'};
14749: } else {
14750: if ($ipheader) {
14751: $ip = $ENV{'HTTP_'.uc($ipheader)};
14752: }
14753: $xfor = $ENV{'HTTP_X_FORWARDED_FOR'};
14754: }
14755: if (($ip eq '') && ($xfor ne '')) {
14756: foreach my $poss_ip (reverse(split(/\s*,\s*/,$xfor))) {
14757: unless (&ip_match($poss_ip,$proxyinfo->{'trusted'})) {
14758: $ip = $poss_ip;
14759: last;
14760: }
14761: }
14762: }
14763: if ($ip ne '') {
14764: return $ip;
14765: }
14766: }
14767: }
14768: }
14769: return $from_ip;
14770: }
14771:
14772: sub get_proxy_settings {
14773: my ($dom_in_use) = @_;
14774: my %domdefaults = &Apache::lonnet::get_domain_defaults($dom_in_use);
14775: my $proxyinfo = {
14776: ipheader => $domdefaults{'waf_ipheader'},
14777: trusted => $domdefaults{'waf_trusted'},
14778: vpnint => $domdefaults{'waf_vpnint'},
14779: vpnext => $domdefaults{'waf_vpnext'},
14780: sslopt => $domdefaults{'waf_sslopt'},
14781: };
14782: return $proxyinfo;
14783: }
14784:
14785: sub ip_match {
14786: my ($ip,$pattern_str) = @_;
14787: $ip=Net::CIDR::cidrvalidate($ip);
14788: if ($ip) {
14789: return Net::CIDR::cidrlookup($ip,split(/\s*,\s*/,$pattern_str));
14790: }
14791: return;
14792: }
14793:
14794: sub get_proxy_alias {
14795: my ($lonid) = @_;
14796: if ($lonid eq '') {
14797: $lonid = $perlvar{'lonHostID'};
14798: }
14799: if (!defined(&hostname($lonid))) {
14800: return;
14801: }
14802: if ($lonid ne '') {
14803: my ($alias,$cached) = &is_cached_new('proxyalias',$lonid);
14804: if ($cached) {
14805: return $alias;
14806: }
14807: my $dom = &Apache::lonnet::host_domain($lonid);
14808: if ($dom ne '') {
14809: my $cachetime = 60*60*24;
14810: my %domconfig =
14811: &Apache::lonnet::get_dom('configuration',['wafproxy'],$dom);
14812: if (ref($domconfig{'wafproxy'}) eq 'HASH') {
14813: if (ref($domconfig{'wafproxy'}{'alias'}) eq 'HASH') {
14814: $alias = $domconfig{'wafproxy'}{'alias'}{$lonid};
14815: }
14816: }
14817: return &do_cache_new('proxyalias',$lonid,$alias,$cachetime);
14818: }
14819: }
14820: return;
14821: }
14822:
14823: sub use_proxy_alias {
14824: my ($r,$lonid) = @_;
14825: my $alias = &get_proxy_alias($lonid);
14826: if ($alias) {
14827: my $dom = &host_domain($lonid);
14828: if ($dom ne '') {
14829: my $proxyinfo = &get_proxy_settings($dom);
14830: my ($vpnint,$remote_ip);
14831: if (ref($proxyinfo) eq 'HASH') {
14832: $vpnint = $proxyinfo->{'vpnint'};
14833: if ($vpnint) {
14834: $remote_ip = &get_requestor_ip($r,1,1);
14835: }
14836: }
14837: unless ($vpnint && &ip_match($remote_ip,$vpnint)) {
14838: return $alias;
14839: }
14840: }
14841: }
14842: return;
14843: }
14844:
14845: sub alias_sso {
14846: my ($lonid) = @_;
14847: if ($lonid eq '') {
14848: $lonid = $perlvar{'lonHostID'};
14849: }
14850: if (!defined(&hostname($lonid))) {
14851: return;
14852: }
14853: if ($lonid ne '') {
14854: my ($use_alias,$cached) = &is_cached_new('proxysaml',$lonid);
14855: if ($cached) {
14856: return $use_alias;
14857: }
14858: my $dom = &Apache::lonnet::host_domain($lonid);
14859: if ($dom ne '') {
14860: my $cachetime = 60*60*24;
14861: my %domconfig =
14862: &Apache::lonnet::get_dom('configuration',['wafproxy'],$dom);
14863: if (ref($domconfig{'wafproxy'}) eq 'HASH') {
14864: if (ref($domconfig{'wafproxy'}{'saml'}) eq 'HASH') {
14865: $use_alias = $domconfig{'wafproxy'}{'saml'}{$lonid};
14866: }
14867: }
14868: return &do_cache_new('proxysaml',$lonid,$use_alias,$cachetime);
14869: }
14870: }
14871: return;
14872: }
14873:
14874: sub get_saml_landing {
14875: my ($lonid) = @_;
14876: if ($lonid eq '') {
14877: my $defdom = &default_login_domain();
14878: my @hosts = ¤t_machine_ids();
14879: if (@hosts > 1) {
14880: foreach my $hostid (@hosts) {
14881: if (&host_domain($hostid) eq $defdom) {
14882: $lonid = $hostid;
14883: last;
14884: }
14885: }
14886: } else {
14887: $lonid = $perlvar{'lonHostID'};
14888: }
14889: if ($lonid) {
14890: unless (&Apache::lonnet::host_domain($lonid) eq $defdom) {
14891: return;
14892: }
14893: } else {
14894: return;
14895: }
14896: } elsif (!defined(&hostname($lonid))) {
14897: return;
14898: }
14899: my ($landing,$cached) = &is_cached_new('samllanding',$lonid);
14900: if ($cached) {
14901: return $landing;
14902: }
14903: my $dom = &Apache::lonnet::host_domain($lonid);
14904: if ($dom ne '') {
14905: my $cachetime = 60*60*24;
14906: my %domconfig =
14907: &Apache::lonnet::get_dom('configuration',['login'],$dom);
14908: if (ref($domconfig{'login'}) eq 'HASH') {
14909: if (ref($domconfig{'login'}{'saml'}) eq 'HASH') {
14910: if (ref($domconfig{'login'}{'saml'}{$lonid}) eq 'HASH') {
14911: $landing = 1;
14912: }
14913: }
14914: }
14915: return &do_cache_new('samllanding',$lonid,$landing,$cachetime);
14916: }
14917: return;
14918: }
14919:
14920: # ------------------------------------------------------------- Declutters URLs
14921:
14922: sub declutter {
14923: my $thisfn=shift;
14924: if ($thisfn=~m|^/enc/|) { $thisfn=&Apache::lonenc::unencrypted($thisfn); }
14925: unless ($thisfn=~m{^/home/httpd/html/priv/}) {
14926: $thisfn=~s{^/home/httpd/html}{};
14927: }
14928: $thisfn=~s/^\///;
14929: $thisfn=~s|^adm/wrapper/||;
14930: $thisfn=~s|^adm/coursedocs/showdoc/||;
14931: $thisfn=~s/^res\///;
14932: $thisfn=~s/^priv\///;
14933: unless (($thisfn =~ /^ext/) || ($thisfn =~ /\.(page|sequence)___\d+___ext/)) {
14934: $thisfn=~s/\?.+$//;
14935: }
14936: return $thisfn;
14937: }
14938:
14939: # ------------------------------------------------------------- Clutter up URLs
14940:
14941: sub clutter {
14942: my $thisfn='/'.&declutter(shift);
14943: if ($thisfn !~ m{^/(uploaded|editupload|adm|userfiles|ext|raw|priv|public)/}
14944: || $thisfn =~ m{^/adm/(includes|pages)} ) {
14945: $thisfn='/res'.$thisfn;
14946: }
14947: if ($thisfn !~m|^/adm|) {
14948: if ($thisfn =~ m|^/ext/|) {
14949: $thisfn='/adm/wrapper'.$thisfn;
14950: } else {
14951: my ($ext) = ($thisfn =~ /\.(\w+)$/);
14952: my $embstyle=&Apache::loncommon::fileembstyle($ext);
14953: if ($embstyle eq 'ssi'
14954: || ($embstyle eq 'hdn')
14955: || ($embstyle eq 'rat')
14956: || ($embstyle eq 'prv')
14957: || ($embstyle eq 'ign')) {
14958: #do nothing with these
14959: } elsif (($embstyle eq 'img')
14960: || ($embstyle eq 'emb')
14961: || ($embstyle eq 'wrp')) {
14962: $thisfn='/adm/wrapper'.$thisfn;
14963: } elsif ($embstyle eq 'unk'
14964: && $thisfn!~/\.(sequence|page)$/) {
14965: $thisfn='/adm/coursedocs/showdoc'.$thisfn;
14966: } else {
14967: # &logthis("Got a blank emb style");
14968: }
14969: }
14970: } elsif ($thisfn =~ m{^/adm/$match_domain/$match_courseid/\d+/ext\.tool$}) {
14971: $thisfn='/adm/wrapper'.$thisfn;
14972: }
14973: return $thisfn;
14974: }
14975:
14976: sub clutter_with_no_wrapper {
14977: my $uri = &clutter(shift);
14978: if ($uri =~ m-^/adm/-) {
14979: $uri =~ s-^/adm/wrapper/-/-;
14980: $uri =~ s-^/adm/coursedocs/showdoc/-/-;
14981: }
14982: return $uri;
14983: }
14984:
14985: sub freeze_escape {
14986: my ($value)=@_;
14987: if (ref($value)) {
14988: $value=&nfreeze($value);
14989: return '__FROZEN__'.&escape($value);
14990: }
14991: return &escape($value);
14992: }
14993:
14994:
14995: sub thaw_unescape {
14996: my ($value)=@_;
14997: if ($value =~ /^__FROZEN__/) {
14998: substr($value,0,10,undef);
14999: $value=&unescape($value);
15000: return &thaw($value);
15001: }
15002: return &unescape($value);
15003: }
15004:
15005: sub correct_line_ends {
15006: my ($result)=@_;
15007: $$result =~s/\r\n/\n/mg;
15008: $$result =~s/\r/\n/mg;
15009: }
15010: # ================================================================ Main Program
15011:
15012: sub goodbye {
15013: &logthis("Starting Shut down");
15014: #not converted to using infrastruture and probably shouldn't be
15015: &logthis(sprintf("%-20s is %s",'%badServerCache',length(&nfreeze(\%badServerCache))));
15016: #converted
15017: # &logthis(sprintf("%-20s is %s",'%metacache',scalar(%metacache)));
15018: &logthis(sprintf("%-20s is %s",'%homecache',length(&nfreeze(\%homecache))));
15019: # &logthis(sprintf("%-20s is %s",'%titlecache',length(&nfreeze(\%titlecache))));
15020: # &logthis(sprintf("%-20s is %s",'%courseresdatacache',length(&nfreeze(\%courseresdatacache))));
15021: #1.1 only
15022: # &logthis(sprintf("%-20s is %s",'%userresdatacache',length(&nfreeze(\%userresdatacache))));
15023: # &logthis(sprintf("%-20s is %s",'%getsectioncache',length(&nfreeze(\%getsectioncache))));
15024: # &logthis(sprintf("%-20s is %s",'%courseresversioncache',length(&nfreeze(\%courseresversioncache))));
15025: # &logthis(sprintf("%-20s is %s",'%resversioncache',length(&nfreeze(\%resversioncache))));
15026: &logthis(sprintf("%-20s is %s",'%remembered',length(&nfreeze(\%remembered))));
15027: &logthis(sprintf("%-20s is %s",'kicks',$kicks));
15028: &logthis(sprintf("%-20s is %s",'hits',$hits));
15029: &flushcourselogs();
15030: &logthis("Shutting down");
15031: }
15032:
15033: sub get_dns {
15034: my ($url,$func,$ignore_cache,$nocache,$hashref) = @_;
15035: if (!$ignore_cache) {
15036: my ($content,$cached)=
15037: &Apache::lonnet::is_cached_new('dns',$url);
15038: if ($cached) {
15039: &$func($content,$hashref);
15040: return;
15041: }
15042: }
15043:
15044: my %alldns;
15045: if (open(my $config,"<","$perlvar{'lonTabDir'}/hosts.tab")) {
15046: foreach my $dns (<$config>) {
15047: next if ($dns !~ /^\^(\S*)/x);
15048: my $line = $1;
15049: my ($host,$protocol) = split(/:/,$line);
15050: if ($protocol ne 'https') {
15051: $protocol = 'http';
15052: }
15053: $alldns{$host} = $protocol;
15054: }
15055: close($config);
15056: }
15057: while (%alldns) {
15058: my ($dns) = sort { $b cmp $a } keys(%alldns);
15059: my ($contents,@content);
15060: if ($dns eq Sys::Hostname::FQDN::fqdn()) {
15061: my $command = (split('/',$url))[3];
15062: my ($dir,$file) = &parse_getdns_url($command,$url);
15063: delete($alldns{$dns});
15064: next if (($dir eq '') || ($file eq ''));
15065: if (open(my $config,'<',"$dir/$file")) {
15066: @content = <$config>;
15067: close($config);
15068: }
15069: if ($url eq '/adm/dns/loncapaCRL') {
15070: $contents = join('',@content);
15071: }
15072: } else {
15073: my $request=new HTTP::Request('GET',"$alldns{$dns}://$dns$url");
15074: my $response = &LONCAPA::LWPReq::makerequest('',$request,'',\%perlvar,30,0);
15075: delete($alldns{$dns});
15076: next if ($response->is_error());
15077: if ($url eq '/adm/dns/loncapaCRL') {
15078: $contents = $response->content;
15079: } else {
15080: @content = split("\n",$response->content);
15081: }
15082: }
15083: if ($url eq '/adm/dns/loncapaCRL') {
15084: return &$func($contents);
15085: } else {
15086: unless ($nocache) {
15087: &do_cache_new('dns',$url,\@content,30*24*60*60);
15088: }
15089: &$func(\@content,$hashref);
15090: return;
15091: }
15092: }
15093: my $which = (split('/',$url,4))[3];
15094: if ($which eq 'loncapaCRL') {
15095: my $diskfile = "$perlvar{'lonCertificateDirectory'}/$perlvar{'lonnetCertRevocationList'}";
15096: if (-e $diskfile) {
15097: &logthis("unable to contact DNS, on disk file $diskfile not updated");
15098: } else {
15099: &logthis("unable to contact DNS, no on disk file $diskfile available");
15100: }
15101: } else {
15102: &logthis("unable to contact DNS defaulting to on disk file dns_$which.tab\n");
15103: if (open(my $config,"<","$perlvar{'lonTabDir'}/dns_$which.tab")) {
15104: my @content = <$config>;
15105: close($config);
15106: &$func(\@content,$hashref);
15107: }
15108: }
15109: return;
15110: }
15111:
15112: # ------------------------------------------------------Get DNS checksums file
15113: sub parse_dns_checksums_tab {
15114: my ($lines,$hashref) = @_;
15115: my $lonhost = $perlvar{'lonHostID'};
15116: my $machine_dom = &Apache::lonnet::host_domain($lonhost);
15117: my $loncaparev = &get_server_loncaparev($machine_dom);
15118: my $distro = (split(/\:/,&get_server_distarch($lonhost)))[0];
15119: my $webconfdir = '/etc/httpd/conf';
15120: if ($distro =~ /^(ubuntu|debian)(\d+)$/) {
15121: $webconfdir = '/etc/apache2';
15122: } elsif ($distro =~ /^sles(\d+)$/) {
15123: if ($1 >= 10) {
15124: $webconfdir = '/etc/apache2';
15125: }
15126: } elsif ($distro =~ /^suse(\d+\.\d+)$/) {
15127: if ($1 >= 10.0) {
15128: $webconfdir = '/etc/apache2';
15129: }
15130: }
15131: my ($release,$timestamp) = split(/\-/,$loncaparev);
15132: my (%chksum,%revnum);
15133: if (ref($lines) eq 'ARRAY') {
15134: chomp(@{$lines});
15135: my $version = shift(@{$lines});
15136: if ($version eq $release) {
15137: foreach my $line (@{$lines}) {
15138: my ($file,$version,$shasum) = split(/,/,$line);
15139: if ($file =~ m{^/etc/httpd/conf}) {
15140: if ($webconfdir eq '/etc/apache2') {
15141: $file =~ s{^\Q/etc/httpd/conf/\E}{$webconfdir/};
15142: }
15143: }
15144: $chksum{$file} = $shasum;
15145: $revnum{$file} = $version;
15146: }
15147: if (ref($hashref) eq 'HASH') {
15148: %{$hashref} = (
15149: sums => \%chksum,
15150: versions => \%revnum,
15151: );
15152: }
15153: }
15154: }
15155: return;
15156: }
15157:
15158: sub fetch_dns_checksums {
15159: my %checksums;
15160: my $machine_dom = &Apache::lonnet::host_domain($perlvar{'lonHostID'});
15161: my $loncaparev = &get_server_loncaparev($machine_dom,$perlvar{'lonHostID'});
15162: my ($release,$timestamp) = split(/\-/,$loncaparev);
15163: &get_dns("/adm/dns/checksums/$release",\&parse_dns_checksums_tab,1,1,
15164: \%checksums);
15165: return \%checksums;
15166: }
15167:
15168: sub fetch_crl_pemfile {
15169: return &get_dns("/adm/dns/loncapaCRL",\&save_crl_pem,1,1);
15170: }
15171:
15172: sub save_crl_pem {
15173: my ($content) = @_;
15174: my ($msg,$hadchanges);
15175: if ($content ne '') {
15176: my $now = time;
15177: my $lonca = $perlvar{'lonCertificateDirectory'}.'/'.$perlvar{'lonnetCertificateAuthority'};
15178: my $tmpcrl = $tmpdir.'/'.$perlvar{'lonnetCertRevocationList'}.'_'.$now.'.'.$$.'.tmp';
15179: if (open(my $fh,'>',"$tmpcrl")) {
15180: print $fh $content;
15181: close($fh);
15182: if (-e $lonca) {
15183: if (open(PIPE,"openssl crl -in $tmpcrl -inform pem -CAfile $lonca -noout 2>&1 |")) {
15184: my $check = <PIPE>;
15185: close(PIPE);
15186: chomp($check);
15187: if ($check eq 'verify OK') {
15188: my $dest = "$perlvar{'lonCertificateDirectory'}/$perlvar{'lonnetCertRevocationList'}";
15189: my $backup;
15190: if (-e $dest) {
15191: if (&File::Copy::move($dest,"$dest.bak")) {
15192: $backup = 'ok';
15193: }
15194: }
15195: if (&File::Copy::move($tmpcrl,$dest)) {
15196: $msg = 'ok';
15197: if ($backup) {
15198: my (%oldnums,%newnums);
15199: if (open(PIPE, "openssl crl -inform PEM -text -noout -in $dest.bak |grep 'Serial Number' |")) {
15200: while (<PIPE>) {
15201: $oldnums{(split(/:/))[1]} = 1;
15202: }
15203: close(PIPE);
15204: }
15205: if (open(PIPE, "openssl crl -inform PEM -text -noout -in $dest |grep 'Serial Number' |")) {
15206: while(<PIPE>) {
15207: $newnums{(split(/:/))[1]} = 1;
15208: }
15209: close(PIPE);
15210: }
15211: foreach my $key (sort {$b <=> $a } (keys(%newnums))) {
15212: unless (exists($oldnums{$key})) {
15213: $hadchanges = 1;
15214: last;
15215: }
15216: }
15217: unless ($hadchanges) {
15218: foreach my $key (sort {$b <=> $a } (keys(%oldnums))) {
15219: unless (exists($newnums{$key})) {
15220: $hadchanges = 1;
15221: last;
15222: }
15223: }
15224: }
15225: }
15226: }
15227: } else {
15228: unlink($tmpcrl);
15229: }
15230: } else {
15231: unlink($tmpcrl);
15232: }
15233: } else {
15234: unlink($tmpcrl);
15235: }
15236: }
15237: }
15238: return ($msg,$hadchanges);
15239: }
15240:
15241: sub parse_getdns_url {
15242: my ($command,$url) = @_;
15243: my $dir = $perlvar{'lonTabDir'};
15244: my $file;
15245: if ($command eq 'hosts') {
15246: $file = 'dns_hosts.tab';
15247: } elsif ($command eq 'domain') {
15248: $file = 'dns_domain.tab';
15249: } elsif ($command eq 'checksums') {
15250: my $version = (split('/',$url))[4];
15251: $file = "dns_checksums/$version.tab",
15252: } elsif ($command eq 'loncapaCRL') {
15253: $dir = $perlvar{'lonCertificateDirectory'};
15254: $file = $perlvar{'lonnetCertRevocationList'};
15255: }
15256: return ($dir,$file);
15257: }
15258:
15259: # ------------------------------------------------------------ Read domain file
15260: {
15261: my $loaded;
15262: my %domain;
15263:
15264: sub parse_domain_tab {
15265: my ($lines) = @_;
15266: foreach my $line (@$lines) {
15267: next if ($line =~ /^(\#|\s*$ )/x);
15268:
15269: chomp($line);
15270: my ($name,@elements) = split(/:/,$line,9);
15271: my %this_domain;
15272: foreach my $field ('description', 'auth_def', 'auth_arg_def',
15273: 'lang_def', 'city', 'longi', 'lati',
15274: 'primary') {
15275: $this_domain{$field} = shift(@elements);
15276: }
15277: $domain{$name} = \%this_domain;
15278: }
15279: }
15280:
15281: sub reset_domain_info {
15282: undef($loaded);
15283: undef(%domain);
15284: }
15285:
15286: sub load_domain_tab {
15287: my ($ignore_cache,$nocache) = @_;
15288: &get_dns('/adm/dns/domain',\&parse_domain_tab,$ignore_cache,$nocache);
15289: my $fh;
15290: if (open($fh,"<",$perlvar{'lonTabDir'}.'/domain.tab')) {
15291: my @lines = <$fh>;
15292: &parse_domain_tab(\@lines);
15293: }
15294: close($fh);
15295: $loaded = 1;
15296: }
15297:
15298: sub domain {
15299: &load_domain_tab() if (!$loaded);
15300:
15301: my ($name,$what) = @_;
15302: return if ( !exists($domain{$name}) );
15303:
15304: if (!$what) {
15305: return $domain{$name}{'description'};
15306: }
15307: return $domain{$name}{$what};
15308: }
15309:
15310: sub domain_info {
15311: &load_domain_tab() if (!$loaded);
15312: return %domain;
15313: }
15314:
15315: }
15316:
15317:
15318: # ------------------------------------------------------------- Read hosts file
15319: {
15320: my %hostname;
15321: my %hostdom;
15322: my %libserv;
15323: my $loaded;
15324: my %name_to_host;
15325: my %internetdom;
15326: my %LC_dns_serv;
15327:
15328: sub parse_hosts_tab {
15329: my ($file) = @_;
15330: foreach my $configline (@$file) {
15331: next if ($configline =~ /^(\#|\s*$ )/x);
15332: chomp($configline);
15333: if ($configline =~ /^\^/) {
15334: if ($configline =~ /^\^([\w.\-]+)/) {
15335: $LC_dns_serv{$1} = 1;
15336: }
15337: next;
15338: }
15339: my ($id,$domain,$role,$name,$protocol,$intdom)=split(/:/,$configline);
15340: $name=~s/\s//g;
15341: if ($id && $domain && $role && $name) {
15342: if ((exists($hostname{$id})) && ($hostname{$id} ne '')) {
15343: my $curr = $hostname{$id};
15344: my $skip;
15345: if (ref($name_to_host{$curr}) eq 'ARRAY') {
15346: if (($curr eq $name) && (@{$name_to_host{$curr}} == 1)) {
15347: $skip = 1;
15348: } else {
15349: @{$name_to_host{$curr}} = grep { $_ ne $id } @{$name_to_host{$curr}};
15350: }
15351: }
15352: unless ($skip) {
15353: push(@{$name_to_host{$name}},$id);
15354: }
15355: } else {
15356: push(@{$name_to_host{$name}},$id);
15357: }
15358: $hostname{$id}=$name;
15359: $hostdom{$id}=$domain;
15360: if ($role eq 'library') { $libserv{$id}=$name; }
15361: if (defined($protocol)) {
15362: if ($protocol eq 'https') {
15363: $protocol{$id} = $protocol;
15364: } else {
15365: $protocol{$id} = 'http';
15366: }
15367: } else {
15368: $protocol{$id} = 'http';
15369: }
15370: if (defined($intdom)) {
15371: $internetdom{$id} = $intdom;
15372: }
15373: }
15374: }
15375: }
15376:
15377: sub reset_hosts_info {
15378: &purge_remembered();
15379: &reset_domain_info();
15380: &reset_hosts_ip_info();
15381: undef(%internetdom);
15382: undef(%name_to_host);
15383: undef(%hostname);
15384: undef(%hostdom);
15385: undef(%libserv);
15386: undef($loaded);
15387: }
15388:
15389: sub load_hosts_tab {
15390: my ($ignore_cache,$nocache) = @_;
15391: &get_dns('/adm/dns/hosts',\&parse_hosts_tab,$ignore_cache,$nocache);
15392: open(my $config,"<","$perlvar{'lonTabDir'}/hosts.tab");
15393: my @config = <$config>;
15394: &parse_hosts_tab(\@config);
15395: close($config);
15396: $loaded=1;
15397: }
15398:
15399: sub hostname {
15400: &load_hosts_tab() if (!$loaded);
15401:
15402: my ($lonid) = @_;
15403: return $hostname{$lonid};
15404: }
15405:
15406: sub all_hostnames {
15407: &load_hosts_tab() if (!$loaded);
15408:
15409: return %hostname;
15410: }
15411:
15412: sub all_names {
15413: my ($ignore_cache,$nocache) = @_;
15414: &load_hosts_tab($ignore_cache,$nocache) if (!$loaded);
15415:
15416: return %name_to_host;
15417: }
15418:
15419: sub all_host_domain {
15420: &load_hosts_tab() if (!$loaded);
15421: return %hostdom;
15422: }
15423:
15424: sub all_host_intdom {
15425: &load_hosts_tab() if (!$loaded);
15426: return %internetdom;
15427: }
15428:
15429: sub is_library {
15430: &load_hosts_tab() if (!$loaded);
15431:
15432: return exists($libserv{$_[0]});
15433: }
15434:
15435: sub all_library {
15436: &load_hosts_tab() if (!$loaded);
15437:
15438: return %libserv;
15439: }
15440:
15441: sub unique_library {
15442: #2x reverse removes all hostnames that appear more than once
15443: my %unique = reverse &all_library();
15444: return reverse %unique;
15445: }
15446:
15447: sub get_servers {
15448: &load_hosts_tab() if (!$loaded);
15449:
15450: my ($domain,$type) = @_;
15451: my %possible_hosts = ($type eq 'library') ? %libserv
15452: : %hostname;
15453: my %result;
15454: if (ref($domain) eq 'ARRAY') {
15455: while ( my ($host,$hostname) = each(%possible_hosts)) {
15456: if (grep(/^\Q$hostdom{$host}\E$/,@$domain)) {
15457: $result{$host} = $hostname;
15458: }
15459: }
15460: } else {
15461: while ( my ($host,$hostname) = each(%possible_hosts)) {
15462: if ($hostdom{$host} eq $domain) {
15463: $result{$host} = $hostname;
15464: }
15465: }
15466: }
15467: return %result;
15468: }
15469:
15470: sub get_unique_servers {
15471: my %unique = reverse &get_servers(@_);
15472: return reverse %unique;
15473: }
15474:
15475: sub host_domain {
15476: &load_hosts_tab() if (!$loaded);
15477:
15478: my ($lonid) = @_;
15479: return $hostdom{$lonid};
15480: }
15481:
15482: sub all_domains {
15483: &load_hosts_tab() if (!$loaded);
15484:
15485: my %seen;
15486: my @uniq = grep(!$seen{$_}++, values(%hostdom));
15487: return @uniq;
15488: }
15489:
15490: sub internet_dom {
15491: &load_hosts_tab() if (!$loaded);
15492:
15493: my ($lonid) = @_;
15494: return $internetdom{$lonid};
15495: }
15496:
15497: sub is_LC_dns {
15498: &load_hosts_tab() if (!$loaded);
15499:
15500: my ($hostname) = @_;
15501: return exists($LC_dns_serv{$hostname});
15502: }
15503:
15504: }
15505:
15506: {
15507: my %iphost;
15508: my %name_to_ip;
15509: my %lonid_to_ip;
15510:
15511: sub get_hosts_from_ip {
15512: my ($ip) = @_;
15513: my %iphosts = &get_iphost();
15514: if (ref($iphosts{$ip})) {
15515: return @{$iphosts{$ip}};
15516: }
15517: return;
15518: }
15519:
15520: sub reset_hosts_ip_info {
15521: undef(%iphost);
15522: undef(%name_to_ip);
15523: undef(%lonid_to_ip);
15524: }
15525:
15526: sub get_host_ip {
15527: my ($lonid) = @_;
15528: if (exists($lonid_to_ip{$lonid})) {
15529: return $lonid_to_ip{$lonid};
15530: }
15531: my $name=&hostname($lonid);
15532: my $ip = gethostbyname($name);
15533: return if (!$ip || length($ip) ne 4);
15534: $ip=inet_ntoa($ip);
15535: $name_to_ip{$name} = $ip;
15536: $lonid_to_ip{$lonid} = $ip;
15537: return $ip;
15538: }
15539:
15540: sub get_iphost {
15541: my ($ignore_cache,$nocache) = @_;
15542:
15543: if (!$ignore_cache) {
15544: if (%iphost) {
15545: return %iphost;
15546: }
15547: my ($ip_info,$cached)=
15548: &Apache::lonnet::is_cached_new('iphost','iphost');
15549: if ($cached) {
15550: %iphost = %{$ip_info->[0]};
15551: %name_to_ip = %{$ip_info->[1]};
15552: %lonid_to_ip = %{$ip_info->[2]};
15553: return %iphost;
15554: }
15555: }
15556:
15557: # get yesterday's info for fallback
15558: my %old_name_to_ip;
15559: my ($ip_info,$cached)=
15560: &Apache::lonnet::is_cached_new('iphost','iphost');
15561: if ($cached) {
15562: %old_name_to_ip = %{$ip_info->[1]};
15563: }
15564:
15565: my %name_to_host = &all_names($ignore_cache,$nocache);
15566: foreach my $name (keys(%name_to_host)) {
15567: my $ip;
15568: if (!exists($name_to_ip{$name})) {
15569: $ip = gethostbyname($name);
15570: if (!$ip || length($ip) ne 4) {
15571: if (defined($old_name_to_ip{$name})) {
15572: $ip = $old_name_to_ip{$name};
15573: &logthis("Can't find $name defaulting to old $ip");
15574: } else {
15575: &logthis("Name $name no IP found");
15576: next;
15577: }
15578: } else {
15579: $ip=inet_ntoa($ip);
15580: }
15581: $name_to_ip{$name} = $ip;
15582: } else {
15583: $ip = $name_to_ip{$name};
15584: }
15585: foreach my $id (@{ $name_to_host{$name} }) {
15586: $lonid_to_ip{$id} = $ip;
15587: }
15588: push(@{$iphost{$ip}},@{$name_to_host{$name}});
15589: }
15590: unless ($nocache) {
15591: &do_cache_new('iphost','iphost',
15592: [\%iphost,\%name_to_ip,\%lonid_to_ip],
15593: 48*60*60);
15594: }
15595:
15596: return %iphost;
15597: }
15598:
15599: #
15600: # Given a DNS returns the loncapa host name for that DNS
15601: #
15602: sub host_from_dns {
15603: my ($dns) = @_;
15604: my @hosts;
15605: my $ip;
15606:
15607: if (exists($name_to_ip{$dns})) {
15608: $ip = $name_to_ip{$dns};
15609: }
15610: if (!$ip) {
15611: $ip = gethostbyname($dns); # Initial translation to IP is in net order.
15612: if (length($ip) == 4) {
15613: $ip = &IO::Socket::inet_ntoa($ip);
15614: }
15615: }
15616: if ($ip) {
15617: @hosts = get_hosts_from_ip($ip);
15618: return $hosts[0];
15619: }
15620: return undef;
15621: }
15622:
15623: sub get_internet_names {
15624: my ($lonid) = @_;
15625: return if ($lonid eq '');
15626: my ($idnref,$cached)=
15627: &Apache::lonnet::is_cached_new('internetnames',$lonid);
15628: if ($cached) {
15629: return $idnref;
15630: }
15631: my $ip = &get_host_ip($lonid);
15632: my @hosts = &get_hosts_from_ip($ip);
15633: my %iphost = &get_iphost();
15634: my (@idns,%seen);
15635: foreach my $id (@hosts) {
15636: my $dom = &host_domain($id);
15637: my $prim_id = &domain($dom,'primary');
15638: my $prim_ip = &get_host_ip($prim_id);
15639: next if ($seen{$prim_ip});
15640: if (ref($iphost{$prim_ip}) eq 'ARRAY') {
15641: foreach my $id (@{$iphost{$prim_ip}}) {
15642: my $intdom = &internet_dom($id);
15643: unless (grep(/^\Q$intdom\E$/,@idns)) {
15644: push(@idns,$intdom);
15645: }
15646: }
15647: }
15648: $seen{$prim_ip} = 1;
15649: }
15650: return &do_cache_new('internetnames',$lonid,\@idns,12*60*60);
15651: }
15652:
15653: }
15654:
15655: sub all_loncaparevs {
15656: 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);
15657: }
15658:
15659: # ---------------------------------------------------------- Read loncaparev table
15660: {
15661: sub load_loncaparevs {
15662: if (-e "$perlvar{'lonTabDir'}/loncaparevs.tab") {
15663: if (open(my $config,"<","$perlvar{'lonTabDir'}/loncaparevs.tab")) {
15664: while (my $configline=<$config>) {
15665: chomp($configline);
15666: my ($hostid,$loncaparev)=split(/:/,$configline);
15667: $loncaparevs{$hostid}=$loncaparev;
15668: }
15669: close($config);
15670: }
15671: }
15672: }
15673: }
15674:
15675: # ---------------------------------------------------------- Read serverhostID table
15676: {
15677: sub load_serverhomeIDs {
15678: if (-e "$perlvar{'lonTabDir'}/serverhomeIDs.tab") {
15679: if (open(my $config,"<","$perlvar{'lonTabDir'}/serverhomeIDs.tab")) {
15680: while (my $configline=<$config>) {
15681: chomp($configline);
15682: my ($name,$id)=split(/:/,$configline);
15683: $serverhomeIDs{$name}=$id;
15684: }
15685: close($config);
15686: }
15687: }
15688: }
15689: }
15690:
15691:
15692: BEGIN {
15693:
15694: # ----------------------------------- Read loncapa.conf and loncapa_apache.conf
15695: unless ($readit) {
15696: {
15697: my $configvars = LONCAPA::Configuration::read_conf('loncapa.conf');
15698: %perlvar = (%perlvar,%{$configvars});
15699: }
15700:
15701:
15702: # ------------------------------------------------------ Read spare server file
15703: {
15704: open(my $config,"<","$perlvar{'lonTabDir'}/spare.tab");
15705:
15706: while (my $configline=<$config>) {
15707: chomp($configline);
15708: if ($configline) {
15709: my ($host,$type) = split(':',$configline,2);
15710: if (!defined($type) || $type eq '') { $type = 'default' };
15711: push(@{ $spareid{$type} }, $host);
15712: }
15713: }
15714: close($config);
15715: }
15716: # ------------------------------------------------------------ Read permissions
15717: {
15718: open(my $config,"<","$perlvar{'lonTabDir'}/roles.tab");
15719:
15720: while (my $configline=<$config>) {
15721: chomp($configline);
15722: if ($configline) {
15723: my ($role,$perm)=split(/ /,$configline);
15724: if ($perm ne '') { $pr{$role}=$perm; }
15725: }
15726: }
15727: close($config);
15728: }
15729:
15730: # -------------------------------------------- Read plain texts for permissions
15731: {
15732: open(my $config,"<","$perlvar{'lonTabDir'}/rolesplain.tab");
15733:
15734: while (my $configline=<$config>) {
15735: chomp($configline);
15736: if ($configline) {
15737: my ($short,@plain)=split(/:/,$configline);
15738: %{$prp{$short}} = ();
15739: if (@plain > 0) {
15740: $prp{$short}{'std'} = $plain[0];
15741: for (my $i=1; $i<@plain; $i++) {
15742: $prp{$short}{'alt'.$i} = $plain[$i];
15743: }
15744: }
15745: }
15746: }
15747: close($config);
15748: }
15749:
15750: # ---------------------------------------------------------- Read package table
15751: {
15752: open(my $config,"<","$perlvar{'lonTabDir'}/packages.tab");
15753:
15754: while (my $configline=<$config>) {
15755: if ($configline !~ /\S/ || $configline=~/^#/) { next; }
15756: chomp($configline);
15757: my ($short,$plain)=split(/:/,$configline);
15758: my ($pack,$name)=split(/\&/,$short);
15759: if ($plain ne '') {
15760: $packagetab{$pack.'&'.$name.'&name'}=$name;
15761: $packagetab{$short}=$plain;
15762: }
15763: }
15764: close($config);
15765: }
15766:
15767: # ---------------------------------------------------------- Read loncaparev table
15768:
15769: &load_loncaparevs();
15770:
15771: # ---------------------------------------------------------- Read serverhostID table
15772:
15773: &load_serverhomeIDs();
15774:
15775: # ---------------------------------------------------------- Read releaseslist XML
15776: {
15777: my $file = $Apache::lonnet::perlvar{'lonTabDir'}.'/releaseslist.xml';
15778: if (-e $file) {
15779: my $parser = HTML::LCParser->new($file);
15780: while (my $token = $parser->get_token()) {
15781: if ($token->[0] eq 'S') {
15782: my $item = $token->[1];
15783: my $name = $token->[2]{'name'};
15784: my $value = $token->[2]{'value'};
15785: my $valuematch = $token->[2]{'valuematch'};
15786: my $namematch = $token->[2]{'namematch'};
15787: if ($item eq 'parameter') {
15788: if (($namematch ne '') || (($name ne '') && ($value ne '' || $valuematch ne ''))) {
15789: my $release = $parser->get_text();
15790: $release =~ s/(^\s*|\s*$ )//gx;
15791: $needsrelease{$item.':'.$name.':'.$value.':'.$valuematch.':'.$namematch} = $release;
15792: }
15793: } elsif ($item ne '' && $name ne '') {
15794: my $release = $parser->get_text();
15795: $release =~ s/(^\s*|\s*$ )//gx;
15796: $needsrelease{$item.':'.$name.':'.$value} = $release;
15797: }
15798: }
15799: }
15800: }
15801: }
15802:
15803: # ---------------------------------------------------------- Read managers table
15804: {
15805: if (-e "$perlvar{'lonTabDir'}/managers.tab") {
15806: if (open(my $config,"<","$perlvar{'lonTabDir'}/managers.tab")) {
15807: while (my $configline=<$config>) {
15808: chomp($configline);
15809: next if ($configline =~ /^\#/);
15810: if (($configline =~ /^[\w\-]+$/) || ($configline =~ /^[\w\-]+\:[\w\-]+$/)) {
15811: $managerstab{$configline} = 1;
15812: }
15813: }
15814: close($config);
15815: }
15816: }
15817: }
15818:
15819: # ------------- set up temporary directory
15820: {
15821: $tmpdir = LONCAPA::tempdir();
15822:
15823: }
15824:
15825: # ------------- set default texengine (domain default overrides this)
15826: {
15827: $deftex = LONCAPA::texengine();
15828: }
15829:
15830: # ------------- set default minimum length for passwords for internal auth users
15831: {
15832: $passwdmin = LONCAPA::passwd_min();
15833: }
15834:
15835: $memcache=new Cache::Memcached({'servers' => ['127.0.0.1:11211'],
15836: 'compress_threshold'=> 20_000,
15837: });
15838:
15839: $processmarker='_'.time.'_'.$perlvar{'lonHostID'};
15840: $dumpcount=0;
15841: $locknum=0;
15842:
15843: &logtouch();
15844: &logthis('<font color="yellow">INFO: Read configuration</font>');
15845: $readit=1;
15846: {
15847: use integer;
15848: my $test=(2**32)+1;
15849: if ($test != 0) { $_64bit=1; } else { $_64bit=0; }
15850: &logthis(" Detected 64bit platform ($_64bit)");
15851: }
15852: }
15853: }
15854:
15855: 1;
15856: __END__
15857:
15858: =pod
15859:
15860: =head1 NAME
15861:
15862: Apache::lonnet - Subroutines to ask questions about things in the network.
15863:
15864: =head1 SYNOPSIS
15865:
15866: Invoked by other LON-CAPA modules, when they need to talk to or about objects in the network.
15867:
15868: &Apache::lonnet::SUBROUTINENAME(ARGUMENTS);
15869:
15870: Common parameters:
15871:
15872: =over 4
15873:
15874: =item *
15875:
15876: $uname : an internal username (if $cname expecting a course Id specifically)
15877:
15878: =item *
15879:
15880: $udom : a domain (if $cdom expecting a course's domain specifically)
15881:
15882: =item *
15883:
15884: $symb : a resource instance identifier
15885:
15886: =item *
15887:
15888: $namespace : the name of a .db file that contains the data needed or
15889: being set.
15890:
15891: =back
15892:
15893: =head1 OVERVIEW
15894:
15895: lonnet provides subroutines which interact with the
15896: lonc/lond (TCP) network layer of LON-CAPA. They can be used to ask
15897: about classes, users, and resources.
15898:
15899: For many of these objects you can also use this to store data about
15900: them or modify them in various ways.
15901:
15902: =head2 Symbs
15903:
15904: To identify a specific instance of a resource, LON-CAPA uses symbols
15905: or "symbs"X<symb>. These identifiers are built from the URL of the
15906: map, the resource number of the resource in the map, and the URL of
15907: the resource itself. The latter is somewhat redundant, but might help
15908: if maps change.
15909:
15910: An example is
15911:
15912: msu/korte/parts/part1.sequence___19___msu/korte/tests/part12.problem
15913:
15914: The respective map entry is
15915:
15916: <resource id="19" src="/res/msu/korte/tests/part12.problem"
15917: title="Problem 2">
15918: </resource>
15919:
15920: Symbs are used by the random number generator, as well as to store and
15921: restore data specific to a certain instance of for example a problem.
15922:
15923: =head2 Storing And Retrieving Data
15924:
15925: X<store()>X<cstore()>X<restore()>Three of the most important functions
15926: in C<lonnet.pm> are C<&Apache::lonnet::cstore()>,
15927: C<&Apache::lonnet:restore()>, and C<&Apache::lonnet::store()>, which
15928: is is the non-critical message twin of cstore. These functions are for
15929: handlers to store a perl hash to a user's permanent data space in an
15930: easy manner, and to retrieve it again on another call. It is expected
15931: that a handler would use this once at the beginning to retrieve data,
15932: and then again once at the end to send only the new data back.
15933:
15934: The data is stored in the user's data directory on the user's
15935: homeserver under the ID of the course.
15936:
15937: The hash that is returned by restore will have all of the previous
15938: value for all of the elements of the hash.
15939:
15940: Example:
15941:
15942: #creating a hash
15943: my %hash;
15944: $hash{'foo'}='bar';
15945:
15946: #storing it
15947: &Apache::lonnet::cstore(\%hash);
15948:
15949: #changing a value
15950: $hash{'foo'}='notbar';
15951:
15952: #adding a new value
15953: $hash{'bar'}='foo';
15954: &Apache::lonnet::cstore(\%hash);
15955:
15956: #retrieving the hash
15957: my %history=&Apache::lonnet::restore();
15958:
15959: #print the hash
15960: foreach my $key (sort(keys(%history))) {
15961: print("\%history{$key} = $history{$key}");
15962: }
15963:
15964: Will print out:
15965:
15966: %history{1:foo} = bar
15967: %history{1:keys} = foo:timestamp
15968: %history{1:timestamp} = 990455579
15969: %history{2:bar} = foo
15970: %history{2:foo} = notbar
15971: %history{2:keys} = foo:bar:timestamp
15972: %history{2:timestamp} = 990455580
15973: %history{bar} = foo
15974: %history{foo} = notbar
15975: %history{timestamp} = 990455580
15976: %history{version} = 2
15977:
15978: Note that the special hash entries C<keys>, C<version> and
15979: C<timestamp> were added to the hash. C<version> will be equal to the
15980: total number of versions of the data that have been stored. The
15981: C<timestamp> attribute will be the UNIX time the hash was
15982: stored. C<keys> is available in every historical section to list which
15983: keys were added or changed at a specific historical revision of a
15984: hash.
15985:
15986: B<Warning>: do not store the hash that restore returns directly. This
15987: will cause a mess since it will restore the historical keys as if the
15988: were new keys. I.E. 1:foo will become 1:1:foo etc.
15989:
15990: Calling convention:
15991:
15992: my %record=&Apache::lonnet::restore($symb,$courseid,$domain,$uname);
15993: &Apache::lonnet::cstore(\%newrecord,$symb,$courseid,$domain,$uname,$laststore);
15994:
15995: For more detailed information, see lonnet specific documentation.
15996:
15997: =head1 RETURN MESSAGES
15998:
15999: =over 4
16000:
16001: =item * B<con_lost>: unable to contact remote host
16002:
16003: =item * B<con_delayed>: unable to contact remote host, message will be delivered
16004: when the connection is brought back up
16005:
16006: =item * B<con_failed>: unable to contact remote host and unable to save message
16007: for later delivery
16008:
16009: =item * B<error:>: an error a occurred, a description of the error follows the :
16010:
16011: =item * B<no_such_host>: unable to fund a host associated with the user/domain
16012: that was requested
16013:
16014: =back
16015:
16016: =head1 PUBLIC SUBROUTINES
16017:
16018: =head2 Session Environment Functions
16019:
16020: =over 4
16021:
16022: =item *
16023: X<appenv()>
16024: B<appenv($hashref,$rolesarrayref)>: the value of %{$hashref} is written to
16025: the user envirnoment file, and will be restored for each access this
16026: user makes during this session, also modifies the %env for the current
16027: process. Optional rolesarrayref - if defined contains a reference to an array
16028: of roles which are exempt from the restriction on modifying user.role entries
16029: in the user's environment.db and in %env.
16030:
16031: =item *
16032: X<delenv()>
16033: B<delenv($delthis,$regexp)>: removes all items from the session
16034: environment file that begin with $delthis. If the
16035: optional second arg - $regexp - is true, $delthis is treated as a
16036: regular expression, otherwise \Q$delthis\E is used.
16037: The values are also deleted from the current processes %env.
16038:
16039: =item * get_env_multiple($name)
16040:
16041: gets $name from the %env hash, it seemlessly handles the cases where multiple
16042: values may be defined and end up as an array ref.
16043:
16044: returns an array of values
16045:
16046: =back
16047:
16048: =head2 User Information
16049:
16050: =over 4
16051:
16052: =item *
16053: X<queryauthenticate()>
16054: B<queryauthenticate($uname,$udom)>: try to determine user's current
16055: authentication scheme
16056:
16057: =item *
16058: X<authenticate()>
16059: B<authenticate($uname,$upass,$udom,$checkdefauth,$clientcancheckhost)>: try to
16060: authenticate user from domain's lib servers (first use the current
16061: one). C<$upass> should be the users password.
16062: $checkdefauth is optional (value is 1 if a check should be made to
16063: authenticate user using default authentication method, and allow
16064: account creation if username does not have account in the domain).
16065: $clientcancheckhost is optional (value is 1 if checking whether the
16066: server can host will occur on the client side in lonauth.pm).
16067:
16068: =item *
16069: X<homeserver()>
16070: B<homeserver($uname,$udom)>: find the server which has
16071: the user's directory and files (there must be only one), this caches
16072: the answer, and also caches if there is a borken connection.
16073:
16074: =item *
16075: X<idget()>
16076: B<idget($udom,$idsref,$namespace)>: find the usernames behind either
16077: a list of student/employee IDs or clicker IDs
16078: (student/employee IDs are a unique resource in a domain, there must be
16079: only 1 ID per username, and only 1 username per ID in a specific domain).
16080: clickerIDs are not necessarily unique, as students might share clickers.
16081: (returns hash: id=>name,id=>name)
16082:
16083: =item *
16084: X<idrget()>
16085: B<idrget($udom,@unames)>: find the IDs behind a list of
16086: usernames (returns hash: name=>id,name=>id)
16087:
16088: =item *
16089: X<idput()>
16090: B<idput($udom,$idsref,$uhome,$namespace)>: store away a list of
16091: names and associated student/employee IDs or clicker IDs.
16092:
16093: =item *
16094: X<iddel()>
16095: B<iddel($udom,$idshashref,$uhome,$namespace)>: delete unwanted
16096: student/employee ID or clicker ID username look-ups from domain.
16097: The homeserver ($uhome) and namespace ($namespace) are optional.
16098: If no $uhome is provided, it will be determined usig &homeserver()
16099: for each user. If no $namespace is provided, the default is ids.
16100:
16101: =item *
16102: X<updateclickers()>
16103: B<updateclickers($udom,$action,$idshashref,$uhome,$critical)>: update
16104: clicker ID-to-username look-ups in clickers.db on library server.
16105: Permitted actions are add or del (i.e., add or delete). The
16106: clickers.db contains clickerID as keys (escaped), and each corresponding
16107: value is an escaped comma-separated list of usernames (for whom the
16108: library server is the homeserver), who registered that particular ID.
16109: If $critical is true, the update will be sent via &critical, otherwise
16110: &reply() will be used.
16111:
16112: =item *
16113: X<rolesinit()>
16114: B<rolesinit($udom,$username)>: get user privileges.
16115: returns user role, first access and timer interval hashes
16116:
16117: =item *
16118: X<privileged()>
16119: B<privileged($username,$domain)>: returns a true if user has a
16120: privileged and active role (i.e. su or dc), false otherwise.
16121:
16122: =item *
16123: X<getsection()>
16124: B<getsection($udom,$uname,$cname)>: finds the section of student in the
16125: course $cname, return section name/number or '' for "not in course"
16126: and '-1' for "no section"
16127:
16128: =item *
16129: X<userenvironment()>
16130: B<userenvironment($udom,$uname,@what)>: gets the values of the keys
16131: passed in @what from the requested user's environment, returns a hash
16132:
16133: =item *
16134: X<userlog_query()>
16135: B<userlog_query($uname,$udom,%filters)>: retrieves data from a user's
16136: activity.log file. %filters defines filters applied when parsing the
16137: log file. These can be start or end timestamps, or the type of action
16138: - log to look for Login or Logout events, check for Checkin or
16139: Checkout, role for role selection. The response is in the form
16140: timestamp1:hostid1:event1×tamp2:hostid2:event2 where events are
16141: escaped strings of the action recorded in the activity.log file.
16142:
16143: =back
16144:
16145: =head2 User Roles
16146:
16147: =over 4
16148:
16149: =item *
16150:
16151: allowed($priv,$uri,$symb,$role,$clientip,$noblockcheck) : check for a user privilege;
16152: returns codes for allowed actions.
16153:
16154: The first argument is required, all others are optional.
16155:
16156: $priv is the privilege being checked.
16157: $uri contains additional information about what is being checked for access (e.g.,
16158: URL, course ID etc.).
16159: $symb is the unique resource instance identifier in a course; if needed,
16160: but not provided, it will be retrieved via a call to &symbread().
16161: $role is the role for which a priv is being checked (only used if priv is evb).
16162: $clientip is the user's IP address (only used when checking for access to portfolio
16163: files).
16164: $noblockcheck, if true, skips calls to &has_comm_blocking() for the bre priv. This
16165: prevents recursive calls to &allowed.
16166:
16167: F: full access
16168: U,I,K: authentication modes (cxx only)
16169: '': forbidden
16170: 1: user needs to choose course
16171: 2: browse allowed
16172: A: passphrase authentication needed
16173: B: access temporarily blocked because of a blocking event in a course.
16174: D: access blocked because access is required via session initiated via deep-link
16175:
16176: =item *
16177:
16178: constructaccess($url,$setpriv) : check for access to construction space URL
16179:
16180: See if the owner domain and name in the URL match those in the
16181: expected environment. If so, return three element list
16182: ($ownername,$ownerdomain,$ownerhome).
16183:
16184: Otherwise return the null string.
16185:
16186: If second argument 'setpriv' is true, it assigns the privileges,
16187: and returns the same three element list, unless the owner has
16188: blocked "ad hoc" Domain Coordinator access to the Author Space,
16189: in which case the null string is returned.
16190:
16191: =item *
16192:
16193: definerole($rolename,$sysrole,$domrole,$courole,$uname,$udom) : define role;
16194: define a custom role rolename set privileges in format of lonTabs/roles.tab
16195: for system, domain, and course level. $uname and $udom are optional (current
16196: user's username and domain will be used when either of $uname or $udom are absent.
16197:
16198: =item *
16199:
16200: plaintext($short,$type,$cid,$forcedefault) : return value in %prp hash
16201: (rolesplain.tab); plain text explanation of a user role term.
16202: $type is Course (default) or Community.
16203: If $forcedefault evaluates to true, text returned will be default
16204: text for $type. Otherwise, if this is a course, the text returned
16205: will be a custom name for the role (if defined in the course's
16206: environment). If no custom name is defined the default is returned.
16207:
16208: =item *
16209:
16210: get_my_roles($uname,$udom,$context,$types,$roles,$roledoms,$withsec,$hidepriv) :
16211: All arguments are optional. Returns a hash of a roles, either for
16212: co-author/assistant author roles for a user's Construction Space
16213: (default), or if $context is 'userroles', roles for the user himself,
16214: In the hash, keys are set to colon-separated $uname,$udom,$role, and
16215: (optionally) if $withsec is true, a fourth colon-separated item - $section.
16216: For each key, value is set to colon-separated start and end times for
16217: the role. If no username and domain are specified, will default to
16218: current user/domain. Types, roles, and roledoms are references to arrays
16219: of role statuses (active, future or previous), roles
16220: (e.g., cc,in, st etc.) and domains of the roles which can be used
16221: to restrict the list of roles reported. If no array ref is
16222: provided for types, will default to return only active roles.
16223:
16224: =item *
16225:
16226: in_course($udom,$uname,$cdom,$cnum,$type,$hideprivileged) : determine if
16227: user: $uname:$udom has a role in the course: $cdom_$cnum.
16228:
16229: Additional optional arguments are: $type (if role checking is to be restricted
16230: to certain user status types -- previous (expired roles), active (currently
16231: available roles) or future (roles available in the future), and
16232: $hideprivileged -- if true will not report course roles for users who
16233: have active Domain Coordinator role in course's domain or in additional
16234: domains (specified in 'Domains to check for privileged users' in course
16235: environment -- set via: Course Settings -> Classlists and staff listing).
16236:
16237: =item *
16238:
16239: privileged($username,$domain,$possdomains,$possroles) : returns 1 if user
16240: $username:$domain is a privileged user (e.g., Domain Coordinator or Super User)
16241: $possdomains and $possroles are optional array refs -- to domains to check and
16242: roles to check. If $possdomains is not specified, a dump will be done of the
16243: users' roles.db to check for a dc or su role in any domain. This can be
16244: time consuming if &privileged is called repeatedly (e.g., when displaying a
16245: classlist), so in such cases, supplying a $possdomains array is preferred, as
16246: this then allows &privileged_by_domain() to be used, which caches the identity
16247: of privileged users, eliminating the need for repeated calls to &dump().
16248:
16249: =item *
16250:
16251: privileged_by_domain($possdomains,$roles) : returns a hash of a hash of a hash,
16252: where the outer hash keys are domains specified in the $possdomains array ref,
16253: next inner hash keys are privileged roles specified in the $roles array ref,
16254: and the innermost hash contains key = value pairs for username:domain = end:start
16255: for active or future "privileged" users with that role in that domain. To avoid
16256: repeated dumps of domain roles -- via &get_domain_roles() -- contents of the
16257: innerhash are cached using priv_$role and $dom as the identifiers.
16258:
16259: =back
16260:
16261: =head2 User Modification
16262:
16263: =over 4
16264:
16265: =item *
16266:
16267: assignrole($udom,$uname,$url,$role,$end,$start,$deleteflag,$selfenroll,$context) : assign role; give a role to a
16268: user for the level given by URL. Optional start and end dates (leave empty
16269: string or zero for "no date")
16270:
16271: =item *
16272:
16273: changepass($uname,$udom,$currentpass,$newpass,$server) : attempts to
16274: change a users, password, possible return values are: ok,
16275: pwchange_failure, non_authorized, auth_mode_error, unknown_user,
16276: refused
16277:
16278: =item *
16279:
16280: modifyuserauth($udom,$uname,$umode,$upass) : modify user authentication
16281:
16282: =item *
16283:
16284: modifyuser($udom,$uname,$uid,$umode,$upass,$first,$middle,$last, $gene,
16285: $forceid,$desiredhome,$email,$inststatus,$candelete) :
16286:
16287: will update user information (firstname,middlename,lastname,generation,
16288: permanentemail), and if forceid is true, student/employee ID also.
16289: A user's institutional affiliation(s) can also be updated.
16290: User information fields will not be overwritten with empty entries
16291: unless the field is included in the $candelete array reference.
16292: This array is included when a single user is modified via "Manage Users",
16293: or when Autoupdate.pl is run by cron in a domain.
16294:
16295: =item *
16296:
16297: modifystudent
16298:
16299: modify a student's enrollment and identification information.
16300: The course id is resolved based on the current user's environment.
16301: This means the invoking user must be a course coordinator or otherwise
16302: associated with a course.
16303:
16304: This call is essentially a wrapper for lonnet::modifyuser and
16305: lonnet::modify_student_enrollment
16306:
16307: Inputs:
16308:
16309: =over 4
16310:
16311: =item B<$udom> Student's loncapa domain
16312:
16313: =item B<$uname> Student's loncapa login name
16314:
16315: =item B<$uid> Student/Employee ID
16316:
16317: =item B<$umode> Student's authentication mode
16318:
16319: =item B<$upass> Student's password
16320:
16321: =item B<$first> Student's first name
16322:
16323: =item B<$middle> Student's middle name
16324:
16325: =item B<$last> Student's last name
16326:
16327: =item B<$gene> Student's generation
16328:
16329: =item B<$usec> Student's section in course
16330:
16331: =item B<$end> Unix time of the roles expiration
16332:
16333: =item B<$start> Unix time of the roles start date
16334:
16335: =item B<$forceid> If defined, allow $uid to be changed
16336:
16337: =item B<$desiredhome> server to use as home server for student
16338:
16339: =item B<$email> Student's permanent e-mail address
16340:
16341: =item B<$type> Type of enrollment (auto or manual)
16342:
16343: =item B<$locktype> boolean - enrollment type locked to prevent Autoenroll.pl changing manual to auto
16344:
16345: =item B<$cid> courseID - needed if a course role is assigned by a user whose current role is DC
16346:
16347: =item B<$selfenroll> boolean - 1 if user role change occurred via self-enrollment
16348:
16349: =item B<$context> role change context (shown in User Management Logs display in a course)
16350:
16351: =item B<$inststatus> institutional status of user - : separated string of escaped status types
16352:
16353: =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.
16354:
16355: =back
16356:
16357: =item *
16358:
16359: modify_student_enrollment
16360:
16361: Change a student's enrollment status in a class. The environment variable
16362: 'role.request.course' must be defined for this function to proceed.
16363:
16364: Inputs:
16365:
16366: =over 4
16367:
16368: =item $udom, student's domain
16369:
16370: =item $uname, student's name
16371:
16372: =item $uid, student's user id
16373:
16374: =item $first, student's first name
16375:
16376: =item $middle
16377:
16378: =item $last
16379:
16380: =item $gene
16381:
16382: =item $usec
16383:
16384: =item $end
16385:
16386: =item $start
16387:
16388: =item $type
16389:
16390: =item $locktype
16391:
16392: =item $cid
16393:
16394: =item $selfenroll
16395:
16396: =item $context
16397:
16398: =item $credits, number of credits student will earn from this class
16399:
16400: =item $instsec, institutional course section code for student
16401:
16402: =back
16403:
16404:
16405: =item *
16406:
16407: assigncustomrole($udom,$uname,$url,$rdom,$rnam,$rolename,$end,$start) : assign
16408: custom role; give a custom role to a user for the level given by URL. Specify
16409: name and domain of role author, and role name
16410:
16411: =item *
16412:
16413: revokerole($udom,$uname,$url,$role) : revoke a role for url
16414:
16415: =item *
16416:
16417: revokecustomrole($udom,$uname,$url,$role) : revoke a custom role
16418:
16419: =back
16420:
16421: =head2 Course Infomation
16422:
16423: =over 4
16424:
16425: =item *
16426:
16427: coursedescription($courseid,$options) : returns a hash of information about the
16428: specified course id, including all environment settings for the
16429: course, the description of the course will be in the hash under the
16430: key 'description'
16431:
16432: $options is an optional parameter that if supplied is a hash reference that controls
16433: what how this function works. It has the following key/values:
16434:
16435: =over 4
16436:
16437: =item freshen_cache
16438:
16439: If defined, and the environment cache for the course is valid, it is
16440: returned in the returned hash.
16441:
16442: =item one_time
16443:
16444: If defined, the last cache time is set to _now_
16445:
16446: =item user
16447:
16448: If defined, the supplied username is used instead of the current user.
16449:
16450:
16451: =back
16452:
16453: =item *
16454:
16455: resdata($name,$domain,$type,@which) : request for current parameter
16456: setting for a specific $type, where $type is either 'course' or 'user',
16457: @what should be a list of parameters to ask about. This routine caches
16458: answers for 10 minutes.
16459:
16460: =item *
16461:
16462: get_courseresdata($courseid, $domain) : dump the entire course resource
16463: data base, returning a hash that is keyed by the resource name and has
16464: values that are the resource value. I believe that the timestamps and
16465: versions are also returned.
16466:
16467: get_numsuppfiles($cnum,$cdom) : retrieve number of files in a course's
16468: supplemental content area. This routine caches the number of files for
16469: 10 minutes.
16470:
16471: =back
16472:
16473: =head2 Course Modification
16474:
16475: =over 4
16476:
16477: =item *
16478:
16479: writecoursepref($courseid,%prefs) : write preferences (environment
16480: database) for a course
16481:
16482: =item *
16483:
16484: createcourse($udom,$description,$url,$course_server,$nonstandard,$inst_code,$course_owner,$crstype,$cnum) : make course
16485:
16486: =item *
16487:
16488: generate_coursenum($udom,$crstype) : get a unique (unused) course number in domain $udom for course type $crstype (Course or Community).
16489:
16490: =item *
16491:
16492: is_course($courseid), is_course($cdom, $cnum)
16493:
16494: Accepts either a combined $courseid (in the form of domain_courseid) or the
16495: two component version $cdom, $cnum. It checks if the specified course exists.
16496:
16497: Returns:
16498: undef if the course doesn't exist, otherwise
16499: in scalar context the combined courseid.
16500: in list context the two components of the course identifier, domain and
16501: courseid.
16502:
16503: =back
16504:
16505: =head2 Bubblesheet Configuration
16506:
16507: =over 4
16508:
16509: =item *
16510:
16511: get_scantron_config($which)
16512:
16513: $which - the name of the configuration to parse from the file.
16514:
16515: Parses and returns the bubblesheet configuration line selected as a
16516: hash of configuration file fields.
16517:
16518:
16519: Returns:
16520: If the named configuration is not in the file, an empty
16521: hash is returned.
16522:
16523: a hash with the fields
16524: name - internal name for the this configuration setup
16525: description - text to display to operator that describes this config
16526: CODElocation - if 0 or the string 'none'
16527: - no CODE exists for this config
16528: if -1 || the string 'letter'
16529: - a CODE exists for this config and is
16530: a string of letters
16531: Unsupported value (but planned for future support)
16532: if a positive integer
16533: - The CODE exists as the first n items from
16534: the question section of the form
16535: if the string 'number'
16536: - The CODE exists for this config and is
16537: a string of numbers
16538: CODEstart - (only matter if a CODE exists) column in the line where
16539: the CODE starts
16540: CODElength - length of the CODE
16541: IDstart - column where the student/employee ID starts
16542: IDlength - length of the student/employee ID info
16543: Qstart - column where the information from the bubbled
16544: 'questions' start
16545: Qlength - number of columns comprising a single bubble line from
16546: the sheet. (usually either 1 or 10)
16547: Qon - either a single character representing the character used
16548: to signal a bubble was chosen in the positional setup, or
16549: the string 'letter' if the letter of the chosen bubble is
16550: in the final, or 'number' if a number representing the
16551: chosen bubble is in the file (1->A 0->J)
16552: Qoff - the character used to represent that a bubble was
16553: left blank
16554: PaperID - if the scanning process generates a unique number for each
16555: sheet scanned the column that this ID number starts in
16556: PaperIDlength - number of columns that comprise the unique ID number
16557: for the sheet of paper
16558: FirstName - column that the first name starts in
16559: FirstNameLength - number of columns that the first name spans
16560: LastName - column that the last name starts in
16561: LastNameLength - number of columns that the last name spans
16562: BubblesPerRow - number of bubbles available in each row used to
16563: bubble an answer. (If not specified, 10 assumed).
16564:
16565:
16566: =item *
16567:
16568: get_scantronformat_file($cdom)
16569:
16570: $cdom - the course's domain (optional); if not supplied, uses
16571: domain for current $env{'request.course.id'}.
16572:
16573: Returns an array containing lines from the scantron format file for
16574: the domain of the course.
16575:
16576: If a url for a custom.tab file is listed in domain's configuration.db,
16577: lines are from this file.
16578:
16579: Otherwise, if a default.tab has been published in RES space by the
16580: domainconfig user, lines are from this file.
16581:
16582: Otherwise, fall back to getting lines from the legacy file on the
16583: local server: /home/httpd/lonTabs/default_scantronformat.tab
16584:
16585: =back
16586:
16587: =head2 Resource Subroutines
16588:
16589: =over 4
16590:
16591: =item *
16592:
16593: subscribe($fname) : subscribe to a resource, returns URL if possible (probably should use repcopy instead)
16594:
16595: =item *
16596:
16597: repcopy($filename) : subscribes to the requested file, and attempts to
16598: replicate from the owning library server, Might return
16599: 'unavailable', 'not_found', 'forbidden', 'ok', or
16600: 'bad_request', also attempts to grab the metadata for the
16601: resource. Expects the local filesystem pathname
16602: (/home/httpd/html/res/....)
16603:
16604: =back
16605:
16606: =head2 Resource Information
16607:
16608: =over 4
16609:
16610: =item *
16611:
16612: EXT($varname,$symb,$udom,$uname,$usection,$recurse,$cid) : evaluates
16613: and returns the value of a variety of different possible values,
16614: $varname should be a request string, and the other parameters can be
16615: used to specify who and what one is asking about. Ordinarily, $cid
16616: does not need to be specified, as it is retrived from
16617: $env{'request.course.id'}, but &Apache::lonnet::EXT() is called
16618: within lonuserstate::loadmap() when initializing a course, before
16619: $env{'request.course.id'} has been set, so it needs to be provided
16620: in that one case.
16621:
16622: Possible values for $varname are environment.lastname (or other item
16623: from the envirnment hash), user.name (or someother aspect about the
16624: user), resource.0.maxtries (or some other part and parameter of a
16625: resource)
16626:
16627: =item *
16628:
16629: directcondval($number) : get current value of a condition; reads from a state
16630: string
16631:
16632: =item *
16633:
16634: condval($condidx) : value of condition index based on state
16635:
16636: =item *
16637:
16638: metadata($uri,$what,$toolsymb,$liburi,$prefix,$depthcount) : request a
16639: resource's metadata, $what should be either a specific key, or either
16640: 'keys' (to get a list of possible keys) or 'packages' to get a list of
16641: packages that this resource currently uses, the last 3 arguments are
16642: only used internally for recursive metadata.
16643:
16644: the toolsymb is only used where the uri is for an external tool (for which
16645: the uri as well as the symb are guaranteed to be unique).
16646:
16647: this function automatically caches all requests except any made recursively
16648: to retrieve a list of metadata keys for an imported library file ($liburi is
16649: defined).
16650:
16651: =item *
16652:
16653: metadata_query($query,$custom,$customshow) : make a metadata query against the
16654: network of library servers; returns file handle of where SQL and regex results
16655: will be stored for query
16656:
16657: =item *
16658:
16659: symbread($filename,$donotrecurse,$ignorecachednull,$checkforblock,$possibles) :
16660: return symbolic list entry (all arguments optional).
16661:
16662: Args: filename is the filename (including path) for the file for which a symb
16663: is required; donotrecurse, if true will prevent calls to allowed() being made
16664: to check access status if more than one resource was found in the bighash
16665: (see rev. 1.249) to avoid an infinite loop if an ambiguous resource is part of
16666: a randompick); ignorecachednull, if true will prevent a symb of '' being
16667: returned if $env{$cache_str} is defined as ''; checkforblock if true will
16668: cause possible symbs to be checked to determine if they are subject to content
16669: blocking, if so they will not be included as possible symbs; possibles is a
16670: ref to a hash, which, as a side effect, will be populated with all possible
16671: symbs (content blocking not tested).
16672:
16673: returns the data handle
16674:
16675: =item *
16676:
16677: symbverify($symb,$thisfn,$encstate) : verifies that $symb actually exists
16678: and is a possible symb for the URL in $thisfn, and if is an encrypted
16679: resource that the user accessed using /enc/ returns a 1 on success, 0
16680: on failure, user must be in a course, as it assumes the existence of
16681: the course initial hash, and uses $env('request.course.id'}. The third
16682: arg is an optional reference to a scalar. If this arg is passed in the
16683: call to symbverify, it will be set to 1 if the symb has been set to be
16684: encrypted; otherwise it will be null.
16685:
16686: =item *
16687:
16688: symbclean($symb) : removes versions numbers from a symb, returns the
16689: cleaned symb
16690:
16691: =item *
16692:
16693: is_on_map($uri) : checks if the $uri is somewhere on the current
16694: course map, user must be in a course for it to work.
16695:
16696: =item *
16697:
16698: numval($salt) : return random seed value (addend for rndseed)
16699:
16700: =item *
16701:
16702: rndseed($symb,$courseid,$udom,$uname) : create a random sum; returns
16703: a random seed, all arguments are optional, if they aren't sent it uses the
16704: environment to derive them. Note: if symb isn't sent and it can't get one
16705: from &symbread it will use the current time as its return value
16706:
16707: =item *
16708:
16709: ireceipt($funame,$fudom,$fucourseid,$fusymb) : return unique,
16710: unfakeable, receipt
16711:
16712: =item *
16713:
16714: receipt() : API to ireceipt working off of env values; given out to users
16715:
16716: =item *
16717:
16718: countacc($url) : count the number of accesses to a given URL
16719:
16720: =item *
16721:
16722: 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
16723:
16724: =item *
16725:
16726: 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)
16727:
16728: =item *
16729:
16730: expirespread($uname,$udom,$stype,$usymb) : set expire date for spreadsheet
16731:
16732: =item *
16733:
16734: devalidate($symb) : devalidate temporary spreadsheet calculations,
16735: forcing spreadsheet to reevaluate the resource scores next time.
16736:
16737: =item *
16738:
16739: can_edit_resource($file,$cnum,$cdom,$resurl,$symb,$group) : determine if current user can edit a particular resource,
16740: when viewing in course context.
16741:
16742: input: six args -- filename (decluttered), course number, course domain,
16743: url, symb (if registered) and group (if this is a
16744: group item -- e.g., bulletin board, group page etc.).
16745:
16746: output: array of five scalars --
16747: $cfile -- url for file editing if editable on current server
16748: $home -- homeserver of resource (i.e., for author if published,
16749: or course if uploaded.).
16750: $switchserver -- 1 if server switch will be needed.
16751: $forceedit -- 1 if icon/link should be to go to edit mode
16752: $forceview -- 1 if icon/link should be to go to view mode
16753:
16754: =item *
16755:
16756: is_course_upload($file,$cnum,$cdom)
16757:
16758: Used in course context to determine if current file was uploaded to
16759: the course (i.e., would be found in /userfiles/docs on the course's
16760: homeserver.
16761:
16762: input: 3 args -- filename (decluttered), course number and course domain.
16763: output: boolean -- 1 if file was uploaded.
16764:
16765: =back
16766:
16767: =head2 Storing/Retreiving Data
16768:
16769: =over 4
16770:
16771: =item *
16772:
16773: store($storehash,$symb,$namespace,$udom,$uname,$laststore) : stores hash
16774: permanently for this url; hashref needs to be given and should be a \%hashname;
16775: the remaining args aren't required and if they aren't passed or are '' they will
16776: be derived from the env (with the exception of $laststore, which is an
16777: optional arg used when a user's submission is stored in grading).
16778: $laststore is $version=$timestamp, where $version is the most recent version
16779: number retrieved for the corresponding $symb in the $namespace db file, and
16780: $timestamp is the timestamp for that transaction (UNIX time).
16781: $laststore is currently only passed when cstore() is called by
16782: structuretags::finalize_storage().
16783:
16784: =item *
16785:
16786: cstore($storehash,$symb,$namespace,$udom,$uname,$laststore) : same as store
16787: but uses critical subroutine
16788:
16789: =item *
16790:
16791: restore($symb,$namespace,$udom,$uname) : returns hash for this symb;
16792: all args are optional
16793:
16794: =item *
16795:
16796: dumpstore($namespace,$udom,$uname,$regexp,$range) :
16797: dumps the complete (or key matching regexp) namespace into a hash
16798: ($udom, $uname, $regexp, $range are optional) for a namespace that is
16799: normally &store()ed into
16800:
16801: $range should be either an integer '100' (give me the first 100
16802: matching records)
16803: or be two integers sperated by a - with no spaces
16804: '30-50' (give me the 30th through the 50th matching
16805: records)
16806:
16807:
16808: =item *
16809:
16810: putstore($namespace,$symb,$version,$storehash,$udomain,$uname,$tolog) :
16811: replaces a &store() version of data with a replacement set of data
16812: for a particular resource in a namespace passed in the $storehash hash
16813: reference. If $tolog is true, the transaction is logged in the courselog
16814: with an action=PUTSTORE.
16815:
16816: =item *
16817:
16818: tmpstore($storehash,$symb,$namespace,$udom,$uname) : storage that
16819: works very similar to store/cstore, but all data is stored in a
16820: temporary location and can be reset using tmpreset, $storehash should
16821: be a hash reference, returns nothing on success
16822:
16823: =item *
16824:
16825: tmprestore($symb,$namespace,$udom,$uname) : storage that works very
16826: similar to restore, but all data is stored in a temporary location and
16827: can be reset using tmpreset. Returns a hash of values on success,
16828: error string otherwise.
16829:
16830: =item *
16831:
16832: tmpreset($symb,$namespace,$udom,$uname) : temporary storage reset,
16833: deltes all keys for $symb form the temporary storage hash.
16834:
16835: =item *
16836:
16837: get($namespace,$storearr,$udom,$uname) : returns hash with keys from array
16838: reference filled in from namesp ($udom and $uname are optional)
16839:
16840: =item *
16841:
16842: del($namespace,$storearr,$udom,$uname) : deletes keys out of array from
16843: namesp ($udom and $uname are optional)
16844:
16845: =item *
16846:
16847: dump($namespace,$udom,$uname,$regexp,$range) :
16848: dumps the complete (or key matching regexp) namespace into a hash
16849: ($udom, $uname, $regexp, $range are optional)
16850:
16851: $range should be either an integer '100' (give me the first 100
16852: matching records)
16853: or be two integers sperated by a - with no spaces
16854: '30-50' (give me the 30th through the 50th matching
16855: records)
16856: =item *
16857:
16858: inc($namespace,$store,$udom,$uname) : increments $store in $namespace.
16859: $store can be a scalar, an array reference, or if the amount to be
16860: incremented is > 1, a hash reference.
16861:
16862: ($udom and $uname are optional)
16863:
16864: =item *
16865:
16866: put($namespace,$storehash,$udom,$uname) : stores hash in namesp
16867: ($udom and $uname are optional)
16868:
16869: =item *
16870:
16871: cput($namespace,$storehash,$udom,$uname) : critical put
16872: ($udom and $uname are optional)
16873:
16874: =item *
16875:
16876: newput($namespace,$storehash,$udom,$uname) :
16877:
16878: Attempts to store the items in the $storehash, but only if they don't
16879: currently exist, if this succeeds you can be certain that you have
16880: successfully created a new key value pair in the $namespace db.
16881:
16882:
16883: Args:
16884: $namespace: name of database to store values to
16885: $storehash: hashref to store to the db
16886: $udom: (optional) domain of user containing the db
16887: $uname: (optional) name of user caontaining the db
16888:
16889: Returns:
16890: 'ok' -> succeeded in storing all keys of $storehash
16891: 'key_exists: <key>' -> failed to anything out of $storehash, as at
16892: least <key> already existed in the db (other
16893: requested keys may also already exist)
16894: 'error: <msg>' -> unable to tie the DB or other error occurred
16895: 'con_lost' -> unable to contact request server
16896: 'refused' -> action was not allowed by remote machine
16897:
16898:
16899: =item *
16900:
16901: eget($namespace,$storearr,$udom,$uname) : returns hash with keys from array
16902: reference filled in from namesp (encrypts the return communication)
16903: ($udom and $uname are optional)
16904:
16905: =item *
16906:
16907: log($udom,$name,$home,$message) : write to permanent log for user; use
16908: critical subroutine
16909:
16910: =item *
16911:
16912: get_dom($namespace,$storearr,$udom,$uhome) : returns hash with keys from
16913: array reference filled in from namespace found in domain level on either
16914: specified domain server ($uhome) or primary domain server ($udom and $uhome are optional).
16915:
16916: =item *
16917:
16918: put_dom($namespace,$storehash,$udom,$uhome) : stores hash in namespace at
16919: domain level either on specified domain server ($uhome) or primary domain
16920: server ($udom and $uhome are optional)
16921:
16922: =item *
16923:
16924: get_domain_defaults($target_domain,$ignore_cache) : returns hash with defaults
16925: for: authentication, language, quotas, timezone, date locale, and portal URL in
16926: the target domain.
16927:
16928: May also include additional key => value pairs for the following groups:
16929:
16930: =over
16931:
16932: =item
16933: disk quotas (MB allocated by default to portfolios and authoring spaces).
16934:
16935: =over
16936:
16937: =item defaultquota, authorquota
16938:
16939: =back
16940:
16941: =item
16942: tools (availability of aboutme page, blog, webDAV access for authoring spaces,
16943: portfolio for users).
16944:
16945: =over
16946:
16947: =item
16948: aboutme, blog, webdav, portfolio
16949:
16950: =back
16951:
16952: =item
16953: requestcourses: ability to request courses, and how requests are processed.
16954:
16955: =over
16956:
16957: =item
16958: official, unofficial, community, textbook, placement
16959:
16960: =back
16961:
16962: =item
16963: inststatus: types of institutional affiliation, and order in which they are displayed.
16964:
16965: =over
16966:
16967: =item
16968: inststatustypes, inststatusorder, inststatusguest
16969:
16970: =back
16971:
16972: =item
16973: coursedefaults: can PDF forms can be created, default credits for courses, default quotas (MB)
16974: for course's uploaded content.
16975:
16976: =over
16977:
16978: =item
16979: canuse_pdfforms, officialcredits, unofficialcredits, textbookcredits, officialquota, unofficialquota,
16980: communityquota, textbookquota, placementquota
16981:
16982: =back
16983:
16984: =item
16985: usersessions: set options for hosting of your users in other domains, and hosting of users from other domains
16986: on your servers.
16987:
16988: =over
16989:
16990: =item
16991: remotesessions, hostedsessions
16992:
16993: =back
16994:
16995: =back
16996:
16997: In cases where a domain coordinator has never used the "Set Domain Configuration"
16998: utility to create a configuration.db file on a domain's primary library server
16999: only the following domain defaults: auth_def, auth_arg_def, lang_def
17000: -- corresponding values are authentication type (internal, krb4, krb5,
17001: or localauth), initial password or a kerberos realm, language (e.g., en-us) --
17002: will be available. Values are retrieved from cache (if current), unless the
17003: optional $ignore_cache arg is true, or from domain's configuration.db (if available),
17004: or lastly from values in lonTabs/dns_domain,tab, or lonTabs/domain.tab.
17005:
17006: Typical usage:
17007:
17008: %domdefaults = &get_domain_defaults($target_domain);
17009:
17010: =back
17011:
17012: =head2 Network Status Functions
17013:
17014: =over 4
17015:
17016: =item *
17017:
17018: dirlist() : return directory list based on URI (first arg).
17019:
17020: Inputs: 1 required, 5 optional.
17021:
17022: =over
17023:
17024: =item
17025: $uri - path to file in filesystem (starts: /res or /userfiles/). Required.
17026:
17027: =item
17028: $userdomain - domain of user/course to be listed. Extracted from $uri if absent.
17029:
17030: =item
17031: $username - username of user/course to be listed. Extracted from $uri if absent.
17032:
17033: =item
17034: $getpropath - boolean: 1 if prepend path using &propath().
17035:
17036: =item
17037: $getuserdir - boolean: 1 if prepend path for "userfiles".
17038:
17039: =item
17040: $alternateRoot - path to prepend in place of path from $uri.
17041:
17042: =back
17043:
17044: Returns: Array of up to two items.
17045:
17046: =over
17047:
17048: a reference to an array of files/subdirectories
17049:
17050: =over
17051:
17052: Each element in the array of files/subdirectories is a & separated list of
17053: item name and the result of running stat on the item. If dirlist was requested
17054: for a file instead of a directory, the item name will be ''. For a directory
17055: listing, if the item is a metadata file, the element will end &N&M
17056: (where N amd M are either 0 or 1, corresponding to obsolete set (1), or
17057: default copyright set (1).
17058:
17059: =back
17060:
17061: a scalar containing error condition (if encountered).
17062:
17063: =over
17064:
17065: =item
17066: no_host (no homeserver identified for $username:$domain).
17067:
17068: =item
17069: no_such_host (server contacted for listing not identified as valid host).
17070:
17071: =item
17072: con_lost (connection to remote server failed).
17073:
17074: =item
17075: refused (invalid $username:$domain received on lond side).
17076:
17077: =item
17078: no_such_dir (directory at specified path on lond side does not exist).
17079:
17080: =item
17081: empty (directory at specified path on lond side is empty).
17082:
17083: =over
17084:
17085: This is currently not encountered because the &ls3, &ls2,
17086: &ls (_handler) routines on the lond side do not filter out
17087: . and .. from a directory listing.
17088:
17089: =back
17090:
17091: =back
17092:
17093: =back
17094:
17095: =item *
17096:
17097: spareserver() : find server with least workload from spare.tab
17098:
17099:
17100: =item *
17101:
17102: host_from_dns($dns) : Returns the loncapa hostname corresponding to a DNS name or undef
17103: if there is no corresponding loncapa host.
17104:
17105: =back
17106:
17107:
17108: =head2 Apache Request
17109:
17110: =over 4
17111:
17112: =item *
17113:
17114: ssi($url,%hash) : server side include, does a complete request cycle on url to
17115: localhost, posts hash
17116:
17117: =back
17118:
17119: =head2 Data to String to Data
17120:
17121: =over 4
17122:
17123: =item *
17124:
17125: hash2str(%hash) : convert a hash into a string complete with escaping and '='
17126: and '&' separators, supports elements that are arrayrefs and hashrefs
17127:
17128: =item *
17129:
17130: hashref2str($hashref) : convert a hashref into a string complete with
17131: escaping and '=' and '&' separators, supports elements that are
17132: arrayrefs and hashrefs
17133:
17134: =item *
17135:
17136: arrayref2str($arrayref) : convert an arrayref into a string complete
17137: with escaping and '&' separators, supports elements that are arrayrefs
17138: and hashrefs
17139:
17140: =item *
17141:
17142: str2hash($string) : convert string to hash using unescaping and
17143: splitting on '=' and '&', supports elements that are arrayrefs and
17144: hashrefs
17145:
17146: =item *
17147:
17148: str2array($string) : convert string to hash using unescaping and
17149: splitting on '&', supports elements that are arrayrefs and hashrefs
17150:
17151: =back
17152:
17153: =head2 Logging Routines
17154:
17155:
17156: These routines allow one to make log messages in the lonnet.log and
17157: lonnet.perm logfiles.
17158:
17159: =over 4
17160:
17161: =item *
17162:
17163: logtouch() : make sure the logfile, lonnet.log, exists
17164:
17165: =item *
17166:
17167: logthis() : append message to the normal lonnet.log file, it gets
17168: preiodically rolled over and deleted.
17169:
17170: =item *
17171:
17172: logperm() : append a permanent message to lonnet.perm.log, this log
17173: file never gets deleted by any automated portion of the system, only
17174: messages of critical importance should go in here.
17175:
17176:
17177: =back
17178:
17179: =head2 General File Helper Routines
17180:
17181: =over 4
17182:
17183: =item *
17184:
17185: getfile($file,$caller) : two cases - requests for files in /res or in /uploaded.
17186: (a) files in /uploaded
17187: (i) If a local copy of the file exists -
17188: compares modification date of local copy with last-modified date for
17189: definitive version stored on home server for course. If local copy is
17190: stale, requests a new version from the home server and stores it.
17191: If the original has been removed from the home server, then local copy
17192: is unlinked.
17193: (ii) If local copy does not exist -
17194: requests the file from the home server and stores it.
17195:
17196: If $caller is 'uploadrep':
17197: This indicates a call from lonuploadrep.pm (PerlHeaderParserHandler phase)
17198: for request for files originally uploaded via DOCS.
17199: - returns 'ok' if fresh local copy now available, -1 otherwise.
17200:
17201: Otherwise:
17202: This indicates a call from the content generation phase of the request.
17203: - returns the entire contents of the file or -1.
17204:
17205: (b) files in /res
17206: - returns the entire contents of a file or -1;
17207: it properly subscribes to and replicates the file if neccessary.
17208:
17209:
17210: =item *
17211:
17212: stat_file($url) : $url is expected to be a /res/ or /uploaded/ style file
17213: reference
17214:
17215: returns either a stat() list of data about the file or an empty list
17216: if the file doesn't exist or couldn't find out about it (connection
17217: problems or user unknown)
17218:
17219: =item *
17220:
17221: filelocation($dir,$file) : returns file system location of a file
17222: based on URI; meant to be "fairly clean" absolute reference, $dir is a
17223: directory that relative $file lookups are to looked in ($dir of /a/dir
17224: and a file of ../bob will become /a/bob)
17225:
17226: =item *
17227:
17228: hreflocation($dir,$file) : returns file system location or a URL; same as
17229: filelocation except for hrefs
17230:
17231: =item *
17232:
17233: declutter() : declutters URLs -- remove beginning slashes, 'res' etc.
17234: also removes beginning /home/httpd/html unless /priv/ follows it.
17235:
17236: =back
17237:
17238: =head2 Usererfile file routines (/uploaded*)
17239:
17240: =over 4
17241:
17242: =item *
17243:
17244: userfileupload(): main rotine for putting a file in a user or course's
17245: filespace, arguments are,
17246:
17247: formname - required - this is the name of the element in $env where the
17248: filename, and the contents of the file to create/modifed exist
17249: the filename is in $env{'form.'.$formname.'.filename'} and the
17250: contents of the file is located in $env{'form.'.$formname}
17251: context - if coursedoc, store the file in the course of the active role
17252: of the current user;
17253: if 'existingfile': store in 'overwrites' in /home/httpd/perl/tmp
17254: if 'canceloverwrite': delete file in tmp/overwrites directory
17255: subdir - required - subdirectory to put the file in under ../userfiles/
17256: if undefined, it will be placed in "unknown"
17257:
17258: (This routine calls clean_filename() to remove any dangerous
17259: characters from the filename, and then calls finuserfileupload() to
17260: complete the transaction)
17261:
17262: returns either the url of the uploaded file (/uploaded/....) if successful
17263: and /adm/notfound.html if unsuccessful
17264:
17265: =item *
17266:
17267: clean_filename(): routine for cleaing a filename up for storage in
17268: userfile space, argument is:
17269:
17270: filename - proposed filename
17271:
17272: returns: the new clean filename
17273:
17274: =item *
17275:
17276: finishuserfileupload(): routine that creates and sends the file to
17277: userspace, probably shouldn't be called directly
17278:
17279: docuname: username or courseid of destination for the file
17280: docudom: domain of user/course of destination for the file
17281: formname: same as for userfileupload()
17282: fname: filename (including subdirectories) for the file
17283: parser: if 'parse', will parse (html) file to extract references to objects, links etc.
17284: if hashref, and context is scantron, will convert csv format to standard format
17285: allfiles: reference to hash used to store objects found by parser
17286: codebase: reference to hash used for codebases of java objects found by parser
17287: thumbwidth: width (pixels) of thumbnail to be created for uploaded image
17288: thumbheight: height (pixels) of thumbnail to be created for uploaded image
17289: resizewidth: width to be used to resize image using resizeImage from ImageMagick
17290: resizeheight: height to be used to resize image using resizeImage from ImageMagick
17291: context: if 'overwrite', will move the uploaded file from its temporary location to
17292: userfiles to facilitate overwriting a previously uploaded file with same name.
17293: mimetype: reference to scalar to accommodate mime type determined
17294: from File::MMagic if $parser = parse.
17295:
17296: returns either the url of the uploaded file (/uploaded/....) if successful
17297: and /adm/notfound.html if unsuccessful (or an error message if context
17298: was 'overwrite').
17299:
17300:
17301: =item *
17302:
17303: renameuserfile(): renames an existing userfile to a new name
17304:
17305: Args:
17306: docuname: username or courseid of destination for the file
17307: docudom: domain of user/course of destination for the file
17308: old: current file name (including any subdirs under userfiles)
17309: new: desired file name (including any subdirs under userfiles)
17310:
17311: =item *
17312:
17313: mkdiruserfile(): creates a directory is a userfiles dir
17314:
17315: Args:
17316: docuname: username or courseid of destination for the file
17317: docudom: domain of user/course of destination for the file
17318: dir: dir to create (including any subdirs under userfiles)
17319:
17320: =item *
17321:
17322: removeuserfile(): removes a file that exists in userfiles
17323:
17324: Args:
17325: docuname: username or courseid of destination for the file
17326: docudom: domain of user/course of destination for the file
17327: fname: filname to delete (including any subdirs under userfiles)
17328:
17329: =item *
17330:
17331: removeuploadedurl(): convience function for removeuserfile()
17332:
17333: Args:
17334: url: a full /uploaded/... url to delete
17335:
17336: =item *
17337:
17338: get_portfile_permissions():
17339: Args:
17340: domain: domain of user or course contain the portfolio files
17341: user: name of user or num of course contain the portfolio files
17342: Returns:
17343: hashref of a dump of the proper file_permissions.db
17344:
17345:
17346: =item *
17347:
17348: get_access_controls():
17349:
17350: Args:
17351: current_permissions: the hash ref returned from get_portfile_permissions()
17352: group: (optional) the group you want the files associated with
17353: file: (optional) the file you want access info on
17354:
17355: Returns:
17356: a hash (keys are file names) of hashes containing
17357: keys are: path to file/file_name\0uniqueID:scope_end_start (see below)
17358: values are XML containing access control settings (see below)
17359:
17360: Internal notes:
17361:
17362: access controls are stored in file_permissions.db as key=value pairs.
17363: key -> path to file/file_name\0uniqueID:scope_end_start
17364: where scope -> public,guest,course,group,domains or users.
17365: end -> UNIX time for end of access (0 -> no end date)
17366: start -> UNIX time for start of access
17367:
17368: value -> XML description of access control
17369: <scope type=""> (type =1 of: public,guest,course,group,domains,users">
17370: <start></start>
17371: <end></end>
17372:
17373: <password></password> for scope type = guest
17374:
17375: <domain></domain> for scope type = course or group
17376: <number></number>
17377: <roles id="">
17378: <role></role>
17379: <access></access>
17380: <section></section>
17381: <group></group>
17382: </roles>
17383:
17384: <dom></dom> for scope type = domains
17385:
17386: <users> for scope type = users
17387: <user>
17388: <uname></uname>
17389: <udom></udom>
17390: </user>
17391: </users>
17392: </scope>
17393:
17394: Access data is also aggregated for each file in an additional key=value pair:
17395: key -> path to file/file_name\0accesscontrol
17396: value -> reference to hash
17397: hash contains key = value pairs
17398: where key = uniqueID:scope_end_start
17399: value = UNIX time record was last updated
17400:
17401: Used to improve speed of look-ups of access controls for each file.
17402:
17403: Locks on files (resulting from submission of portfolio file to a homework problem stored in array of arrays.
17404:
17405: =item *
17406:
17407: modify_access_controls():
17408:
17409: Modifies access controls for a portfolio file
17410: Args
17411: 1. file name
17412: 2. reference to hash of required changes,
17413: 3. domain
17414: 4. username
17415: where domain,username are the domain of the portfolio owner
17416: (either a user or a course)
17417:
17418: Returns:
17419: 1. result of additions or updates ('ok' or 'error', with error message).
17420: 2. result of deletions ('ok' or 'error', with error message).
17421: 3. reference to hash of any new or updated access controls.
17422: 4. reference to hash used to map incoming IDs to uniqueIDs assigned to control.
17423: key = integer (inbound ID)
17424: value = uniqueID
17425:
17426: =item *
17427:
17428: get_timebased_id():
17429:
17430: Attempts to get a unique timestamp-based suffix for use with items added to a
17431: course via the Course Editor (e.g., folders, composite pages,
17432: group bulletin boards).
17433:
17434: Args: (first three required; six others optional)
17435:
17436: 1. prefix (alphanumeric): of keys in hash, e.g., suppsequence, docspage,
17437: docssequence, or name of group
17438:
17439: 2. keyid (alphanumeric): name of temporary locking key in hash,
17440: e.g., num, boardids
17441:
17442: 3. namespace: name of gdbm file used to store suffixes already assigned;
17443: file will be named nohist_namespace.db
17444:
17445: 4. cdom: domain of course; default is current course domain from %env
17446:
17447: 5. cnum: course number; default is current course number from %env
17448:
17449: 6. idtype: set to concat if an additional digit is to be appended to the
17450: unix timestamp to form the suffix, if the plain timestamp is already
17451: in use. Default is to not do this, but simply increment the unix
17452: timestamp by 1 until a unique key is obtained.
17453:
17454: 7. who: holder of locking key; defaults to user:domain for user.
17455:
17456: 8. locktries: number of attempts to obtain a lock (sleep of 1s before
17457: retrying); default is 3.
17458:
17459: 9. maxtries: number of attempts to obtain a unique suffix; default is 20.
17460:
17461: Returns:
17462:
17463: 1. suffix obtained (numeric)
17464:
17465: 2. result of deleting locking key (ok if deleted, or lock never obtained)
17466:
17467: 3. error: contains (localized) error message if an error occurred.
17468:
17469:
17470: =back
17471:
17472: =head2 HTTP Helper Routines
17473:
17474: =over 4
17475:
17476: =item *
17477:
17478: escape() : unpack non-word characters into CGI-compatible hex codes
17479:
17480: =item *
17481:
17482: unescape() : pack CGI-compatible hex codes into actual non-word ASCII character
17483:
17484: =back
17485:
17486: =head1 PRIVATE SUBROUTINES
17487:
17488: =head2 Underlying communication routines (Shouldn't call)
17489:
17490: =over 4
17491:
17492: =item *
17493:
17494: subreply() : tries to pass a message to lonc, returns con_lost if incapable
17495:
17496: =item *
17497:
17498: reply() : uses subreply to send a message to remote machine, logs all failures
17499:
17500: =item *
17501:
17502: critical() : passes a critical message to another server; if cannot
17503: get through then place message in connection buffer directory and
17504: returns con_delayed, if incapable of saving message, returns
17505: con_failed
17506:
17507: =item *
17508:
17509: reconlonc() : tries to reconnect lonc client processes.
17510:
17511: =back
17512:
17513: =head2 Resource Access Logging
17514:
17515: =over 4
17516:
17517: =item *
17518:
17519: flushcourselogs() : flush (save) buffer logs and access logs
17520:
17521: =item *
17522:
17523: courselog($what) : save message for course in hash
17524:
17525: =item *
17526:
17527: courseacclog($what) : save message for course using &courselog(). Perform
17528: special processing for specific resource types (problems, exams, quizzes, etc).
17529:
17530: =item *
17531:
17532: goodbye() : flush course logs and log shutting down; it is called in srm.conf
17533: as a PerlChildExitHandler
17534:
17535: =back
17536:
17537: =head2 Other
17538:
17539: =over 4
17540:
17541: =item *
17542:
17543: symblist($mapname,%newhash) : update symbolic storage links
17544:
17545: =back
17546:
17547: =cut
17548:
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