Annotation of loncom/lonnet/perl/lonnet.pm, revision 1.1504
1.1 albertel 1: # The LearningOnline Network
2: # TCP networking package
1.12 www 3: #
1.1504 ! raeburn 4: # $Id: lonnet.pm,v 1.1503 2022/12/31 14:09:00 raeburn Exp $
1.178 www 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: #
1.169 harris41 28: ###
29:
1.971 jms 30: =pod
31:
1.972 jms 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:
1.971 jms 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:
1.1 albertel 71: package Apache::lonnet;
72:
73: use strict;
1.486 www 74: use HTTP::Date;
1.977 amueller 75: use Image::Magick;
1.1389 raeburn 76: use CGI::Cookie;
1.1182 foxr 77:
1.1173 foxr 78: use Encode;
79:
1.1405 raeburn 80: use vars qw(%perlvar %spareid %pr %prp $memcache %packagetab $tmpdir $deftex
1.1138 raeburn 81: $_64bit %env %protocol %loncaparevs %serverhomeIDs %needsrelease
1.1416 raeburn 82: %managerstab $passwdmin);
1.871 albertel 83:
84: my (%badServerCache, $memcache, %courselogs, %accesshash, %domainrolehash,
85: %userrolehash, $processmarker, $dumpcount, %coursedombuf,
86: %coursenumbuf, %coursehombuf, %coursedescrbuf, %courseinstcodebuf,
1.958 www 87: %courseownerbuf, %coursetypebuf,$locknum);
1.403 www 88:
1.1 albertel 89: use IO::Socket;
1.31 www 90: use GDBM_File;
1.208 albertel 91: use HTML::LCParser;
1.88 www 92: use Fcntl qw(:flock);
1.870 albertel 93: use Storable qw(thaw nfreeze);
1.1289 damieng 94: use Time::HiRes qw( sleep gettimeofday tv_interval );
1.599 albertel 95: use Cache::Memcached;
1.676 albertel 96: use Digest::MD5;
1.790 albertel 97: use Math::Random;
1.1024 raeburn 98: use File::MMagic;
1.1434 raeburn 99: use Net::CIDR;
1.1456 raeburn 100: use Sys::Hostname::FQDN();
1.807 albertel 101: use LONCAPA qw(:DEFAULT :match);
1.740 www 102: use LONCAPA::Configuration;
1.1160 www 103: use LONCAPA::lonmetadata;
1.1167 droeschl 104: use LONCAPA::Lond;
1.1345 raeburn 105: use LONCAPA::LWPReq;
1.1406 raeburn 106: use LONCAPA::transliterate;
1.1117 foxr 107:
1.1090 raeburn 108: use File::Copy;
1.676 albertel 109:
1.195 www 110: my $readit;
1.1288 damieng 111: my $max_connection_retries = 20; # Or some such value.
1.1 albertel 112:
1.619 albertel 113: require Exporter;
114:
115: our @ISA = qw (Exporter);
116: our @EXPORT = qw(%env);
117:
1.449 matthew 118:
1.1187 raeburn 119: # ------------------------------------ Logging (parameters, docs, slots, roles)
1.729 www 120: {
121: my $logid;
1.1187 raeburn 122: sub write_log {
1.1188 raeburn 123: my ($context,$hash_name,$storehash,$delflag,$uname,$udom,$cnum,$cdom)=@_;
1.1184 raeburn 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: }
1.957 raeburn 129: }
1.1184 raeburn 130: $logid ++;
1.957 raeburn 131: my $now = time();
132: my $id=$now.'00000'.$$.'00000'.$logid;
1.1434 raeburn 133: my $ip = &get_requestor_ip();
1.1184 raeburn 134: my $logentry = {
135: $id => {
136: 'exe_uname' => $env{'user.name'},
137: 'exe_udom' => $env{'user.domain'},
138: 'exe_time' => $now,
1.1434 raeburn 139: 'exe_ip' => $ip,
1.1184 raeburn 140: 'delflag' => $delflag,
141: 'logentry' => $storehash,
142: 'uname' => $uname,
143: 'udom' => $udom,
144: }
145: };
146: return &put('nohist_'.$hash_name,$logentry,$cdom,$cnum);
1.729 www 147: }
148: }
1.1 albertel 149:
1.163 harris41 150: sub logtouch {
151: my $execdir=$perlvar{'lonDaemons'};
1.448 albertel 152: unless (-e "$execdir/logs/lonnet.log") {
1.1359 raeburn 153: open(my $fh,">>","$execdir/logs/lonnet.log");
1.163 harris41 154: close $fh;
155: }
156: my ($wwwuid,$wwwgid)=(getpwnam('www'))[2,3];
157: chown($wwwuid,$wwwgid,$execdir.'/logs/lonnet.log');
158: }
159:
1.1 albertel 160: sub logthis {
161: my $message=shift;
162: my $execdir=$perlvar{'lonDaemons'};
163: my $now=time;
164: my $local=localtime($now);
1.1359 raeburn 165: if (open(my $fh,">>","$execdir/logs/lonnet.log")) {
1.986 foxr 166: my $logstring = $local. " ($$): ".$message."\n"; # Keep any \'s in string.
167: print $fh $logstring;
1.448 albertel 168: close($fh);
169: }
1.1 albertel 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);
1.1359 raeburn 178: if (open(my $fh,">>","$execdir/logs/lonnet.perm.log")) {
1.448 albertel 179: print $fh "$now:$message:$local\n";
180: close($fh);
181: }
1.1 albertel 182: return 1;
183: }
184:
1.850 albertel 185: sub create_connection {
1.853 albertel 186: my ($hostname,$lonid) = @_;
1.851 albertel 187: my $client=IO::Socket::UNIX->new(Peer => $perlvar{'lonSockCreate'},
1.850 albertel 188: Type => SOCK_STREAM,
189: Timeout => 10);
190: return 0 if (!$client);
1.1399 raeburn 191: print $client (join(':',$hostname,$lonid,&machine_ids($hostname),$loncaparevs{$lonid})."\n");
1.850 albertel 192: my $result = <$client>;
193: chomp($result);
194: return 1 if ($result eq 'done');
195: return 0;
196: }
197:
1.983 raeburn 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: }
1.850 albertel 212:
1.1106 raeburn 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:
1.1315 raeburn 236: sub get_servercerts_info {
1.1383 raeburn 237: my ($lonhost,$hostname,$context) = @_;
238: return if ($lonhost eq '');
239: if ($hostname eq '') {
240: $hostname = &hostname($lonhost);
241: }
242: return if ($hostname eq '');
1.1315 raeburn 243: my ($rep,$uselocal);
1.1388 raeburn 244: if ($context eq 'install') {
1.1387 raeburn 245: $uselocal = 1;
246: } elsif (grep { $_ eq $lonhost } ¤t_machine_ids()) {
1.1315 raeburn 247: $uselocal = 1;
248: }
1.1387 raeburn 249: if (($context ne 'cgi') && ($context ne 'install') && ($uselocal)) {
1.1315 raeburn 250: my $distro = (split(/\:/,&get_server_distarch($lonhost)))[0];
1.1323 raeburn 251: if ($distro eq '') {
252: $uselocal = 0;
253: } elsif ($distro =~ /^(?:centos|redhat|scientific)(\d+)$/) {
1.1315 raeburn 254: if ($1 < 6) {
255: $uselocal = 0;
256: }
1.1346 raeburn 257: } elsif ($distro =~ /^(?:sles)(\d+)$/) {
258: if ($1 < 12) {
259: $uselocal = 0;
260: }
1.1315 raeburn 261: }
262: }
263: if ($uselocal) {
1.1383 raeburn 264: $rep = LONCAPA::Lond::server_certs(\%perlvar,$lonhost,$hostname);
1.1315 raeburn 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:
1.993 raeburn 284: sub get_server_loncaparev {
1.1073 raeburn 285: my ($dom,$lonhost,$ignore_cache,$caller) = @_;
1.993 raeburn 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)) {
1.1073 raeburn 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'};
1.1081 raeburn 311: if ($answer =~ /^[\'\"]?([\w.\-]+)[\'\"]?$/) {
1.1073 raeburn 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') {
1.1397 raeburn 318: my $hostname = &hostname($lonhost);
1.1073 raeburn 319: my $protocol = $protocol{$lonhost};
320: $protocol = 'http' if ($protocol ne 'https');
1.1397 raeburn 321: my $url = $protocol.'://'.$hostname.'/adm/about.html';
1.1073 raeburn 322: my $request=new HTTP::Request('GET',$url);
1.1345 raeburn 323: my $response=&LONCAPA::LWPReq::makerequest($lonhost,$request,'',\%perlvar,4,1);
1.1073 raeburn 324: unless ($response->is_error()) {
325: my $content = $response->content;
1.1081 raeburn 326: if ($content =~ /<p>VERSION\:\s*([\w.\-]+)<\/p>/) {
1.1073 raeburn 327: $loncaparev = $1;
328: }
329: }
330: } else {
331: $loncaparev = $loncaparevs{$lonhost};
332: }
1.1081 raeburn 333: } elsif ($answer =~ /^[\'\"]?([\w.\-]+)[\'\"]?$/) {
1.1073 raeburn 334: $loncaparev = $1;
335: }
1.993 raeburn 336: }
1.1073 raeburn 337: return &do_cache_new('serverloncaparev',$lonhost,$loncaparev,$cachetime);
1.993 raeburn 338: }
339: }
340:
1.1074 raeburn 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:
1.1121 raeburn 369: sub get_remote_globals {
370: my ($lonhost,$whathash,$ignore_cache) = @_;
1.1125 raeburn 371: my ($result,%returnhash,%whatneeded);
372: if (ref($whathash) eq 'HASH') {
1.1121 raeburn 373: foreach my $what (sort(keys(%{$whathash}))) {
374: my $hashid = $lonhost.'-'.$what;
1.1125 raeburn 375: my ($response,$cached);
1.1121 raeburn 376: unless ($ignore_cache) {
1.1125 raeburn 377: ($response,$cached)=&is_cached_new('lonnetglobal',$hashid);
1.1121 raeburn 378: }
379: if (defined($cached)) {
1.1125 raeburn 380: $returnhash{$what} = $response;
1.1121 raeburn 381: } else {
1.1125 raeburn 382: $whatneeded{$what} = 1;
1.1121 raeburn 383: }
384: }
1.1125 raeburn 385: if (keys(%whatneeded) == 0) {
386: $result = 'ok';
387: } else {
1.1121 raeburn 388: my $requested = &freeze_escape(\%whatneeded);
389: my $rep=&reply('readlonnetglobal:'.$requested,$lonhost);
1.1125 raeburn 390: if (($rep=~/^(refused|rejected|error)/) || ($rep eq 'con_lost') ||
391: ($rep eq 'unknown_cmd')) {
392: $result = $rep;
393: } else {
394: $result = 'ok';
1.1121 raeburn 395: my @pairs=split(/\&/,$rep);
1.1125 raeburn 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);
1.1121 raeburn 402: }
403: }
404: }
405: }
1.1125 raeburn 406: return ($result,\%returnhash);
1.1121 raeburn 407: }
408:
1.1124 raeburn 409: sub remote_devalidate_cache {
1.1241 raeburn 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);
1.1124 raeburn 415: return $response;
416: }
417:
1.1 albertel 418: # -------------------------------------------------- Non-critical communication
419: sub subreply {
420: my ($cmd,$server)=@_;
1.838 albertel 421: my $peerfile="$perlvar{'lonSockDir'}/".&hostname($server);
1.549 foxr 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.
1.1289 damieng 429: sleep(0.1);
1.549 foxr 430: }
431: # At this point, either a loncnew parent is listening or an old lonc
1.550 foxr 432: # or loncnew child is listening so we can connect or everything's dead.
1.549 foxr 433: #
1.550 foxr 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);
1.869 albertel 442: if ($client) {
1.550 foxr 443: last; # Connected!
1.850 albertel 444: } else {
1.853 albertel 445: &create_connection(&hostname($server),$server);
1.550 foxr 446: }
1.1289 damieng 447: sleep(0.1); # Try again later if failed connection.
1.550 foxr 448: }
449: my $answer;
450: if ($client) {
1.704 albertel 451: print $client "sethost:$server:$cmd\n";
1.550 foxr 452: $answer=<$client>;
453: if (!$answer) { $answer="con_lost"; }
454: chomp($answer);
455: } else {
456: $answer = 'con_lost'; # Failed connection.
457: }
1.1 albertel 458: return $answer;
459: }
460:
461: sub reply {
462: my ($cmd,$server)=@_;
1.838 albertel 463: unless (defined(&hostname($server))) { return 'no_such_host'; }
1.1 albertel 464: my $answer=subreply($cmd,$server);
1.65 www 465: if (($answer=~/^refused/) || ($answer=~/^rejected/)) {
1.1396 raeburn 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') ||
1.1462 raeburn 471: ($subcmd eq 'putdom') || ($subcmd eq 'autoexportgrades') ||
472: ($subcmd eq 'put')) {
1.1396 raeburn 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') ||
1.1462 raeburn 479: ($subcmd eq 'autoexportgrades') || ($subcmd eq 'put')) {
1.1396 raeburn 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>");
1.12 www 487: }
1.1 albertel 488: return $answer;
489: }
490:
491: # ----------------------------------------------------------- Send USR1 to lonc
492:
493: sub reconlonc {
1.891 albertel 494: my ($lonid) = @_;
495: if ($lonid) {
1.1295 raeburn 496: my $hostname = &hostname($lonid);
1.891 albertel 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:
1.836 www 512: &logthis("Trying to reconnect lonc");
1.1 albertel 513: my $loncfile="$perlvar{'lonDaemons'}/logs/lonc.pid";
1.1359 raeburn 514: if (open(my $fh,"<",$loncfile)) {
1.1 albertel 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;
1.1295 raeburn 521: } else {
1.12 www 522: &logthis(
1.672 albertel 523: "<font color=\"blue\">WARNING:".
1.12 www 524: " lonc at pid $loncpid not responding, giving up</font>");
1.1 albertel 525: }
526: } else {
1.836 www 527: &logthis('<font color="blue">WARNING: lonc not running, giving up</font>');
1.1 albertel 528: }
529: }
530:
531: # ------------------------------------------------------ Critical communication
1.12 www 532:
1.1 albertel 533: sub critical {
534: my ($cmd,$server)=@_;
1.838 albertel 535: unless (&hostname($server)) {
1.672 albertel 536: &logthis("<font color=\"blue\">WARNING:".
1.89 www 537: " Critical message to unknown server ($server)</font>");
538: return 'no_such_host';
539: }
1.1 albertel 540: my $answer=reply($cmd,$server);
541: if ($answer eq 'con_lost') {
1.1295 raeburn 542: &reconlonc($server);
1.589 albertel 543: my $answer=reply($cmd,$server);
1.1 albertel 544: if ($answer eq 'con_lost') {
545: my $now=time;
546: my $middlename=$cmd;
1.5 www 547: $middlename=substr($middlename,0,16);
1.1 albertel 548: $middlename=~s/\W//g;
549: my $dfilename=
1.305 www 550: "$perlvar{'lonSockDir'}/delayed/$now.$dumpcount.$$.$middlename.$server";
551: $dumpcount++;
1.1 albertel 552: {
1.448 albertel 553: my $dfh;
1.1359 raeburn 554: if (open($dfh,">",$dfilename)) {
1.448 albertel 555: print $dfh "$cmd\n";
556: close($dfh);
557: }
1.1 albertel 558: }
1.1288 damieng 559: sleep 1;
1.1 albertel 560: my $wcmd='';
561: {
1.448 albertel 562: my $dfh;
1.1359 raeburn 563: if (open($dfh,"<",$dfilename)) {
1.448 albertel 564: $wcmd=<$dfh>;
565: close($dfh);
566: }
1.1 albertel 567: }
568: chomp($wcmd);
1.7 www 569: if ($wcmd eq $cmd) {
1.672 albertel 570: &logthis("<font color=\"blue\">WARNING: ".
1.12 www 571: "Connection buffer $dfilename: $cmd</font>");
1.1 albertel 572: &logperm("D:$server:$cmd");
573: return 'con_delayed';
574: } else {
1.672 albertel 575: &logthis("<font color=\"red\">CRITICAL:"
1.12 www 576: ." Critical connection failed: $server $cmd</font>");
1.1 albertel 577: &logperm("F:$server:$cmd");
578: return 'con_failed';
579: }
580: }
581: }
582: return $answer;
1.405 albertel 583: }
584:
1.755 albertel 585: # ------------------------------------------- check if return value is an error
586:
587: sub error {
588: my ($result) = @_;
1.756 albertel 589: if ($result =~ /^(con_lost|no_such_host|error: (\d+) (.*))/) {
1.755 albertel 590: if ($2 == 2) { return undef; }
591: return $1;
592: }
593: return undef;
594: }
595:
1.783 albertel 596: sub convert_and_load_session_env {
597: my ($lonidsdir,$handle)=@_;
598: my @profile;
599: {
1.917 albertel 600: my $opened = open(my $idf,'+<',"$lonidsdir/$handle.id");
601: if (!$opened) {
1.915 albertel 602: return 0;
603: }
1.783 albertel 604: flock($idf,LOCK_SH);
605: @profile=<$idf>;
606: close($idf);
607: }
608: my %temp_env;
609: foreach my $line (@profile) {
1.786 albertel 610: if ($line !~ m/=/) {
611: return 0;
612: }
1.783 albertel 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: }
1.786 albertel 624: return 1;
1.783 albertel 625: }
626:
1.374 www 627: # ------------------------------------------- Transfer profile into environment
1.780 albertel 628: my $env_loaded;
629: sub transfer_profile_to_env {
1.788 albertel 630: my ($lonidsdir,$handle,$force_transfer) = @_;
631: if (!$force_transfer && $env_loaded) { return; }
1.374 www 632:
1.720 albertel 633: if (!defined($lonidsdir)) {
634: $lonidsdir = $perlvar{'lonIDsDir'};
635: }
636: if (!defined($handle)) {
637: ($handle) = ($env{'user.environment'} =~m|/([^/]+)\.id$| );
638: }
639:
1.786 albertel 640: my $convert;
641: {
1.917 albertel 642: my $opened = open(my $idf,'+<',"$lonidsdir/$handle.id");
643: if (!$opened) {
1.915 albertel 644: return;
645: }
1.786 albertel 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: }
1.374 www 659: }
1.783 albertel 660:
1.786 albertel 661: my %remove;
1.783 albertel 662: while ( my $envname = each(%env) ) {
1.433 matthew 663: if (my ($key,$time) = ($envname =~ /^(cgi\.(\d+)_\d+\.)/)) {
664: if ($time < time-300) {
1.783 albertel 665: $remove{$key}++;
1.433 matthew 666: }
667: }
668: }
1.783 albertel 669:
1.619 albertel 670: $env{'user.environment'} = "$lonidsdir/$handle.id";
1.780 albertel 671: $env_loaded=1;
1.783 albertel 672: foreach my $expired_key (keys(%remove)) {
1.433 matthew 673: &delenv($expired_key);
1.374 www 674: }
1.1 albertel 675: }
676:
1.916 albertel 677: # ---------------------------------------------------- Check for valid session
678: sub check_for_valid_session {
1.1355 raeburn 679: my ($r,$name,$userhashref,$domref) = @_;
1.916 albertel 680: my %cookies=CGI::Cookie->parse($r->header_in('Cookie'));
1.1378 raeburn 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';
1.1337 raeburn 692: $linkname = 'lonLinkID';
693: $pubname = 'lonPubID';
1.1378 raeburn 694: if (exists($cookies{$secure})) {
695: $lonid=$cookies{$secure};
696: } elsif (exists($cookies{$name})) {
697: $lonid=$cookies{$name};
1.1400 raeburn 698: } elsif ((exists($cookies{$linkname})) && ($ENV{'SERVER_PORT'} != 443)) {
1.1337 raeburn 699: $lonid=$cookies{$linkname};
1.1378 raeburn 700: } elsif (exists($cookies{$pubname})) {
701: $lonid=$cookies{$pubname};
1.1337 raeburn 702: }
1.1378 raeburn 703: } else {
704: $lonid=$cookies{$name};
1.1337 raeburn 705: }
1.916 albertel 706: return undef if (!$lonid);
707:
708: my $handle=&LONCAPA::clean_handle($lonid->value);
1.1378 raeburn 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: }
1.1155 raeburn 714: }
1.1355 raeburn 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: }
1.916 albertel 725:
1.917 albertel 726: my $opened = open(my $idf,'+<',"$lonidsdir/$handle.id");
727: return undef if (!$opened);
1.916 albertel 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'})) {
1.1394 raeburn 738: untie(%disk_env);
1.916 albertel 739: return undef;
740: }
1.1245 raeburn 741:
742: if (ref($userhashref) eq 'HASH') {
743: $userhashref->{'name'} = $disk_env{'user.name'};
744: $userhashref->{'domain'} = $disk_env{'user.domain'};
1.1448 raeburn 745: if ($disk_env{'request.role'}) {
746: $userhashref->{'role'} = $disk_env{'request.role'};
747: }
1.1361 raeburn 748: $userhashref->{'lti'} = $disk_env{'request.lti.login'};
1.1375 raeburn 749: if ($userhashref->{'lti'}) {
750: $userhashref->{'ltitarget'} = $disk_env{'request.lti.target'};
751: $userhashref->{'ltiuri'} = $disk_env{'request.lti.uri'};
752: }
1.1212 raeburn 753: }
1.1394 raeburn 754: untie(%disk_env);
1.1245 raeburn 755:
1.916 albertel 756: return $handle;
757: }
758:
1.830 albertel 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:
1.1392 raeburn 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:
1.5 www 810: # ---------------------------------------------------------- Append Environment
811:
812: sub appenv {
1.949 raeburn 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') {
1.1250 raeburn 820: my ($type,$role) = ($key =~ m{^user\.(role|priv)\.(.+?)\./});
1.949 raeburn 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: }
1.1376 raeburn 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: }
1.35 www 848: }
1.191 harris41 849: }
1.56 www 850: return 'ok';
851: }
852: # ----------------------------------------------------- Delete from Environment
853:
854: sub delenv {
1.1104 raeburn 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: }
1.56 www 869: }
1.917 albertel 870: my $opened = open(my $env_file,'+<',$env{'user.environment'});
871: if ($opened
1.915 albertel 872: && &timed_flock($env_file,LOCK_EX)
1.830 albertel 873: &&
874: tie(my %disk_env,'GDBM_File',$env{'user.environment'},
875: (&GDBM_WRITER()|&GDBM_NOLOCK()),0640)) {
1.783 albertel 876: foreach my $key (keys(%disk_env)) {
1.987 raeburn 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: }
1.448 albertel 888: }
1.783 albertel 889: untie(%disk_env);
1.5 www 890: }
891: return 'ok';
1.369 albertel 892: }
893:
1.790 albertel 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:
1.958 www 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:
1.369 albertel 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)) {
1.925 albertel 961: next if ($filename eq '.' || $filename eq '..');
962: next if ($filename =~ /publicuser_\d+\.id/);
1.1390 raeburn 963: next if ($filename =~ /^[a-f0-9]+_linked\.id$/);
1.404 albertel 964: my ($mtime)=(stat($perlvar{'lonIDsDir'}.'/'.$filename))[9];
1.437 albertel 965: if ($curtime-$mtime < 1800) { $numusers++; }
1.369 albertel 966: }
967: closedir(LONIDS);
968: }
969: my $userloadpercent=0;
970: my $maxuserload=$perlvar{'lonUserLoadLim'};
971: if ($maxuserload) {
1.371 albertel 972: $userloadpercent=100*$numusers/$maxuserload;
1.369 albertel 973: }
1.372 albertel 974: $userloadpercent=sprintf("%.2f",$userloadpercent);
1.369 albertel 975: return $userloadpercent;
1.283 www 976: }
977:
1.1 albertel 978: # ------------------------------ Find server with least workload from spare.tab
1.11 www 979:
1.1 albertel 980: sub spareserver {
1.1451 raeburn 981: my ($r,$loadpercent,$userloadpercent,$want_server_name,$udom) = @_;
1.784 albertel 982: my $spare_server;
1.370 albertel 983: if ($userloadpercent !~ /\d/) { $userloadpercent=0; }
1.784 albertel 984: my $lowest_load=($loadpercent > $userloadpercent) ? $loadpercent
985: : $userloadpercent;
1.1083 raeburn 986: my ($uint_dom,$remotesessions);
987: if (($udom ne '') && (&domain($udom) ne '')) {
1.1494 raeburn 988: my $uprimary_id = &domain($udom,'primary');
989: $uint_dom = &internet_dom($uprimary_id);
990: my %udomdefaults = &get_domain_defaults($udom);
1.1083 raeburn 991: $remotesessions = $udomdefaults{'remotesessions'};
992: }
1.1123 raeburn 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'} }) {
1.1279 raeburn 997: next unless (&spare_can_host($udom,$uint_dom,$remotesessions,
998: $try_server));
1.1123 raeburn 999: ($spare_server, $lowest_load) =
1000: &compare_server_load($try_server, $spare_server, $lowest_load);
1001: }
1.1083 raeburn 1002: }
1.784 albertel 1003:
1.1123 raeburn 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'} }) {
1.1279 raeburn 1009: next unless (&spare_can_host($udom,$uint_dom,
1010: $remotesessions,$try_server));
1.1123 raeburn 1011: ($spare_server, $lowest_load) =
1012: &compare_server_load($try_server, $spare_server, $lowest_load);
1013: }
1014: }
1015: }
1.784 albertel 1016: }
1017:
1018: if (!$want_server_name) {
1.1001 raeburn 1019: if (defined($spare_server)) {
1020: my $hostname = &hostname($spare_server);
1.1083 raeburn 1021: if (defined($hostname)) {
1.1397 raeburn 1022: my $protocol = 'http';
1023: if ($protocol{$spare_server} eq 'https') {
1024: $protocol = $protocol{$spare_server};
1025: }
1.1494 raeburn 1026: my $alias = &use_proxy_alias($r,$spare_server);
1.1451 raeburn 1027: $hostname = $alias if ($alias ne '');
1.1001 raeburn 1028: $spare_server = $protocol.'://'.$hostname;
1029: }
1030: }
1.784 albertel 1031: }
1032: return $spare_server;
1033: }
1034:
1035: sub compare_server_load {
1.1253 raeburn 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: }
1.784 albertel 1047:
1048: my $loadans = &reply('load', $try_server);
1049: my $userloadans = &reply('userload',$try_server);
1050:
1051: if ($loadans !~ /\d/ && $userloadans !~ /\d/) {
1.1114 raeburn 1052: return ($spare_server, $lowest_load); #didn't get a number from the server
1.784 albertel 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;
1.411 albertel 1061: } else {
1.784 albertel 1062: $load = $loadans;
1.411 albertel 1063: }
1.784 albertel 1064: } else {
1065: $load = $userloadans;
1066: }
1067:
1068: if (($load =~ /\d/) && ($load < $lowest_load)) {
1069: $spare_server = $try_server;
1070: $lowest_load = $load;
1.370 albertel 1071: }
1.784 albertel 1072: return ($spare_server,$lowest_load);
1.202 matthew 1073: }
1.914 albertel 1074:
1075: # --------------------------- ask offload servers if user already has a session
1076: sub find_existing_session {
1077: my ($udom,$uname) = @_;
1.1123 raeburn 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: }
1.914 albertel 1090: }
1091: return;
1092: }
1093:
1.1411 raeburn 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:
1.1389 raeburn 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:
1.1431 raeburn 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:
1.1389 raeburn 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)) {
1.1431 raeburn 1186: return &reply('delbalcookie:'.&escape($cookie),$balancer);
1.1389 raeburn 1187: }
1188: }
1189: }
1190:
1.914 albertel 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:
1.1076 raeburn 1201: # --------- determine least loaded server in a user's domain which allows login
1202:
1203: sub choose_server {
1.1259 raeburn 1204: my ($udom,$checkloginvia,$required,$skiploadbal) = @_;
1.1076 raeburn 1205: my %domconfhash = &Apache::loncommon::get_domainconf($udom);
1.1077 raeburn 1206: my %servers = &get_servers($udom);
1.1076 raeburn 1207: my $lowest_load = 30000;
1.1259 raeburn 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 =
1.1494 raeburn 1214: &get_dom('configuration',['loadbalancing'],$udom);
1.1259 raeburn 1215: if (ref($domconfig{'loadbalancing'}) eq 'HASH') {
1216: $balancers = &do_cache_new('loadbalancing',$udom,$domconfig{'loadbalancing'},
1217: $cachetime);
1218: }
1219: }
1220: }
1.1076 raeburn 1221: foreach my $lonhost (keys(%servers)) {
1.1259 raeburn 1222: if ($skiploadbal) {
1223: if (ref($balancers) eq 'HASH') {
1224: next if (exists($balancers->{$lonhost}));
1225: }
1.1389 raeburn 1226: }
1.1115 raeburn 1227: my $loginvia;
1228: if ($checkloginvia) {
1229: $loginvia = $domconfhash{$udom.'.login.loginvia_'.$lonhost};
1.1116 raeburn 1230: if ($loginvia) {
1231: my ($server,$path) = split(/:/,$loginvia);
1232: ($login_host, $lowest_load) =
1.1253 raeburn 1233: &compare_server_load($server, $login_host, $lowest_load, $required);
1.1116 raeburn 1234: if ($login_host eq $server) {
1235: $portal_path = $path;
1.1151 raeburn 1236: $isredirect = 1;
1.1116 raeburn 1237: }
1238: } else {
1239: ($login_host, $lowest_load) =
1.1253 raeburn 1240: &compare_server_load($lonhost, $login_host, $lowest_load, $required);
1.1116 raeburn 1241: if ($login_host eq $lonhost) {
1242: $portal_path = '';
1.1151 raeburn 1243: $isredirect = '';
1.1116 raeburn 1244: }
1245: }
1246: } else {
1.1076 raeburn 1247: ($login_host, $lowest_load) =
1.1253 raeburn 1248: &compare_server_load($lonhost, $login_host, $lowest_load, $required);
1.1076 raeburn 1249: }
1250: }
1251: if ($login_host ne '') {
1.1116 raeburn 1252: $hostname = &hostname($login_host);
1.1076 raeburn 1253: }
1.1331 raeburn 1254: return ($login_host,$hostname,$portal_path,$isredirect,$lowest_load);
1.1076 raeburn 1255: }
1256:
1.1420 raeburn 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:
1.202 matthew 1279: # --------------------------------------------- Try to change a user's password
1280:
1281: sub changepass {
1.799 raeburn 1282: my ($uname,$udom,$currentpass,$newpass,$server,$context)=@_;
1.202 matthew 1283: $currentpass = &escape($currentpass);
1284: $newpass = &escape($newpass);
1.1030 raeburn 1285: my $lonhost = $perlvar{'lonHostID'};
1286: my $answer = reply("encrypt:passwd:$udom:$uname:$currentpass:$newpass:$context:$lonhost",
1.202 matthew 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.");
1.1030 raeburn 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.");
1.1408 raeburn 1314: } elsif ($answer =~ "^prioruse") {
1315: &logthis("$server refused to change $uname in $udom password because ".
1316: "the password had been used before");
1.202 matthew 1317: }
1318: return $answer;
1.1 albertel 1319: }
1320:
1.169 harris41 1321: # ----------------------- Try to determine user's current authentication scheme
1322:
1323: sub queryauthenticate {
1324: my ($uname,$udom)=@_;
1.456 albertel 1325: my $uhome=&homeserver($uname,$udom);
1.1484 raeburn 1326: if ((!$uhome) || ($uhome eq 'no_host')) {
1.456 albertel 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");
1.169 harris41 1333: }
1.456 albertel 1334: return $answer;
1.169 harris41 1335: }
1336:
1.1 albertel 1337: # --------- Try to authenticate user from domain's lib servers (first this one)
1.11 www 1338:
1.1 albertel 1339: sub authenticate {
1.1073 raeburn 1340: my ($uname,$upass,$udom,$checkdefauth,$clientcancheckhost)=@_;
1.807 albertel 1341: $upass=&escape($upass);
1342: $uname= &LONCAPA::clean_username($uname);
1.836 www 1343: my $uhome=&homeserver($uname,$udom,1);
1.952 raeburn 1344: my $newhome;
1.836 www 1345: if ((!$uhome) || ($uhome eq 'no_host')) {
1346: # Maybe the machine was offline and only re-appeared again recently?
1347: &reconlonc();
1348: # One more
1.952 raeburn 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: }
1.836 www 1358: if ((!$uhome) || ($uhome eq 'no_host')) {
1359: &logthis("User $uname at $udom is unknown in authenticate");
1.952 raeburn 1360: return 'no_host';
1361: }
1.1 albertel 1362: }
1.1073 raeburn 1363: my $answer=reply("encrypt:auth:$udom:$uname:$upass:$checkdefauth:$clientcancheckhost",$uhome);
1.471 albertel 1364: if ($answer eq 'authorized') {
1.952 raeburn 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: }
1.471 albertel 1372: }
1373: if ($answer eq 'non_authorized') {
1374: &logthis("User $uname at $udom rejected by $uhome");
1.1484 raeburn 1375: return 'no_host';
1.9 www 1376: }
1.471 albertel 1377: &logthis("User $uname at $udom threw error $answer when checking authentication mechanism");
1.1 albertel 1378: return 'no_host';
1379: }
1380:
1.1491 raeburn 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:
1.1073 raeburn 1404: sub can_host_session {
1.1074 raeburn 1405: my ($udom,$lonhost,$remoterev,$remotesessions,$hostedsessions) = @_;
1.1073 raeburn 1406: my $canhost = 1;
1.1494 raeburn 1407: my $host_idn = &internet_dom($lonhost);
1.1073 raeburn 1408: if (ref($remotesessions) eq 'HASH') {
1409: if (ref($remotesessions->{'excludedomain'}) eq 'ARRAY') {
1.1074 raeburn 1410: if (grep(/^\Q$host_idn\E$/,@{$remotesessions->{'excludedomain'}})) {
1.1073 raeburn 1411: $canhost = 0;
1412: } else {
1413: $canhost = 1;
1414: }
1415: }
1416: if (ref($remotesessions->{'includedomain'}) eq 'ARRAY') {
1.1074 raeburn 1417: if (grep(/^\Q$host_idn\E$/,@{$remotesessions->{'includedomain'}})) {
1.1073 raeburn 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') {
1.1494 raeburn 1443: my $uprimary_id = &domain($udom,'primary');
1444: my $uint_dom = &internet_dom($uprimary_id);
1.1073 raeburn 1445: if (ref($hostedsessions->{'excludedomain'}) eq 'ARRAY') {
1.1120 raeburn 1446: if (($uint_dom ne '') &&
1447: (grep(/^\Q$uint_dom\E$/,@{$hostedsessions->{'excludedomain'}}))) {
1.1073 raeburn 1448: $canhost = 0;
1449: } else {
1450: $canhost = 1;
1451: }
1452: }
1453: if (ref($hostedsessions->{'includedomain'}) eq 'ARRAY') {
1.1120 raeburn 1454: if (($uint_dom ne '') &&
1455: (grep(/^\Q$uint_dom\E$/,@{$hostedsessions->{'includedomain'}}))) {
1.1073 raeburn 1456: $canhost = 1;
1457: } else {
1458: $canhost = 0;
1459: }
1460: }
1461: }
1462: }
1463: return $canhost;
1464: }
1465:
1.1083 raeburn 1466: sub spare_can_host {
1467: my ($udom,$uint_dom,$remotesessions,$try_server)=@_;
1468: my $canhost=1;
1.1279 raeburn 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: }
1.1439 raeburn 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: }
1.1279 raeburn 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: }
1.1083 raeburn 1499: }
1500: return $canhost;
1501: }
1502:
1.1123 raeburn 1503: sub this_host_spares {
1504: my ($dom) = @_;
1.1126 raeburn 1505: my ($dom_in_use,$lonhost_in_use,$result);
1.1123 raeburn 1506: my @hosts = ¤t_machine_ids();
1507: foreach my $lonhost (@hosts) {
1508: if (&host_domain($lonhost) eq $dom) {
1.1126 raeburn 1509: $dom_in_use = $dom;
1510: $lonhost_in_use = $lonhost;
1.1123 raeburn 1511: last;
1512: }
1513: }
1.1126 raeburn 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);
1.1123 raeburn 1531: if (defined($cached)) {
1532: return $result;
1533: } else {
1.1126 raeburn 1534: my $cachetime = 60*60*24;
1535: my %domconfig =
1.1494 raeburn 1536: &get_dom('configuration',['usersessions'],$dom_in_use);
1.1126 raeburn 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);
1.1123 raeburn 1541: }
1542: }
1543: }
1544: }
1.1126 raeburn 1545: return;
1.1123 raeburn 1546: }
1547:
1.1129 raeburn 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 {
1.1331 raeburn 1583: my ($uname,$udom,$caller) = @_;
1.1191 raeburn 1584: my ($is_balancer,$currtargets,$currrules,$dom_in_use,$homeintdom,
1.1391 raeburn 1585: $rule_in_effect,$offloadto,$otherserver,$setcookie,$dom_balancers);
1.1129 raeburn 1586: my $lonhost = $perlvar{'lonHostID'};
1.1175 raeburn 1587: my @hosts = ¤t_machine_ids();
1.1494 raeburn 1588: my $uprimary_id = &domain($udom,'primary');
1589: my $uintdom = &internet_dom($uprimary_id);
1590: my $intdom = &internet_dom($lonhost);
1.1129 raeburn 1591: my $serverhomedom = &host_domain($lonhost);
1.1307 raeburn 1592: my $domneedscache;
1.1129 raeburn 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 =
1.1494 raeburn 1604: &get_dom('configuration',['loadbalancing'],$dom_in_use);
1.1129 raeburn 1605: if (ref($domconfig{'loadbalancing'}) eq 'HASH') {
1.1130 raeburn 1606: $result = &do_cache_new('loadbalancing',$dom_in_use,$domconfig{'loadbalancing'},$cachetime);
1.1307 raeburn 1607: } else {
1608: $domneedscache = $dom_in_use;
1.1129 raeburn 1609: }
1610: }
1611: if (ref($result) eq 'HASH') {
1.1391 raeburn 1612: ($is_balancer,$currtargets,$currrules,$setcookie,$dom_balancers) =
1.1191 raeburn 1613: &check_balancer_result($result,@hosts);
1.1129 raeburn 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)) {
1.1239 raeburn 1662: ($result,$cached)=&is_cached_new('loadbalancing',$serverhomedom);
1.1129 raeburn 1663: unless (defined($cached)) {
1664: my %domconfig =
1.1494 raeburn 1665: &get_dom('configuration',['loadbalancing'],$serverhomedom);
1.1129 raeburn 1666: if (ref($domconfig{'loadbalancing'}) eq 'HASH') {
1.1307 raeburn 1667: $result = &do_cache_new('loadbalancing',$serverhomedom,$domconfig{'loadbalancing'},$cachetime);
1668: } else {
1669: $domneedscache = $serverhomedom;
1.1129 raeburn 1670: }
1671: }
1672: if (ref($result) eq 'HASH') {
1.1391 raeburn 1673: ($is_balancer,$currtargets,$currrules,$setcookie,$dom_balancers) =
1.1191 raeburn 1674: &check_balancer_result($result,@hosts);
1675: if ($is_balancer) {
1.1129 raeburn 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: }
1.1307 raeburn 1689: unless (defined($cached)) {
1690: $domneedscache = $serverhomedom;
1691: }
1.1129 raeburn 1692: }
1693: } else {
1694: if ($perlvar{'lonBalancer'} eq 'yes') {
1695: $is_balancer = 1;
1696: $offloadto = &this_host_spares($dom_in_use);
1697: }
1.1307 raeburn 1698: unless (defined($cached)) {
1699: $domneedscache = $serverhomedom;
1700: }
1701: }
1702: if ($domneedscache) {
1703: &do_cache_new('loadbalancing',$domneedscache,$is_balancer,$cachetime);
1.1129 raeburn 1704: }
1.1430 raeburn 1705: if (($is_balancer) && ($caller ne 'switchserver')) {
1.1176 raeburn 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: }
1.1129 raeburn 1713: }
1.1176 raeburn 1714: my $found_server = ($otherserver ne '' && $lowest_load < 100);
1.1129 raeburn 1715:
1.1176 raeburn 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}) {
1.1129 raeburn 1729: ($otherserver,$lowest_load) =
1730: &compare_server_load($try_server,$otherserver,$lowest_load);
1731: }
1732: }
1733: }
1.1331 raeburn 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)) {
1.1389 raeburn 1739: &appenv({'user.loadbalexempt' => $lonhost,
1.1331 raeburn 1740: 'user.loadbalcheck.time' => time});
1741: }
1.1176 raeburn 1742: }
1.1129 raeburn 1743: }
1744: }
1.1430 raeburn 1745: }
1746: if (($is_balancer) && (!$homeintdom)) {
1747: undef($setcookie);
1.1129 raeburn 1748: }
1.1391 raeburn 1749: return ($is_balancer,$otherserver,$setcookie,$offloadto,$dom_balancers);
1.1129 raeburn 1750: }
1751:
1.1191 raeburn 1752: sub check_balancer_result {
1753: my ($result,@hosts) = @_;
1.1391 raeburn 1754: my ($is_balancer,$currtargets,$currrules,$setcookie,$dom_balancers);
1.1191 raeburn 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: }
1.1391 raeburn 1763: $dom_balancers = $currbalancer;
1.1191 raeburn 1764: } else {
1.1391 raeburn 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: }
1.1191 raeburn 1775: }
1.1391 raeburn 1776: $dom_balancers = join(',',sort(keys(%{$result})));
1.1191 raeburn 1777: }
1778: }
1779: }
1.1391 raeburn 1780: return ($is_balancer,$currtargets,$currrules,$setcookie,$dom_balancers);
1.1191 raeburn 1781: }
1782:
1.1129 raeburn 1783: sub get_loadbalancer_targets {
1784: my ($rule_in_effect,$currtargets,$uname,$udom) = @_;
1785: my $offloadto;
1.1175 raeburn 1786: if ($rule_in_effect eq 'none') {
1787: return [$perlvar{'lonHostID'}];
1788: } elsif ($rule_in_effect eq '') {
1.1129 raeburn 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 =
1.1494 raeburn 1798: &get_dom('configuration',['loadbalancing'],$udom);
1.1129 raeburn 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 {
1.1178 raeburn 1806: my %servers = &internet_dom_servers($udom);
1.1129 raeburn 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:
1.1127 raeburn 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:
1.1347 raeburn 1852: sub trusted_domains {
1853: my ($cmdtype,$calldom) = @_;
1.1349 raeburn 1854: my ($trusted,$untrusted);
1.1347 raeburn 1855: if (&domain($calldom) eq '') {
1.1349 raeburn 1856: return ($trusted,$untrusted);
1.1347 raeburn 1857: }
1.1395 raeburn 1858: unless ($cmdtype =~ /^(content|shared|enroll|coaurem|othcoau|domroles|catalog|reqcrs|msg)$/) {
1.1349 raeburn 1859: return ($trusted,$untrusted);
1.1347 raeburn 1860: }
1861: my $callprimary = &domain($calldom,'primary');
1.1494 raeburn 1862: my $intcalldom = &internet_dom($callprimary);
1.1347 raeburn 1863: if ($intcalldom eq '') {
1.1349 raeburn 1864: return ($trusted,$untrusted);
1.1347 raeburn 1865: }
1866:
1.1494 raeburn 1867: my ($trustconfig,$cached)=&is_cached_new('trust',$calldom);
1.1347 raeburn 1868: unless (defined($cached)) {
1.1494 raeburn 1869: my %domconfig = &get_dom('configuration',['trust'],$calldom);
1870: &do_cache_new('trust',$calldom,$domconfig{'trust'},3600);
1.1347 raeburn 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') {
1.1395 raeburn 1880: $possinc{$intcalldom} = 1;
1.1347 raeburn 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') {
1.1395 raeburn 1915: push(@{$untrusted},@{$doms_by_intdom{$exc}});
1.1347 raeburn 1916: }
1917: }
1918: foreach my $inc (@allinc) {
1919: if (ref($doms_by_intdom{$inc}) eq 'ARRAY') {
1.1395 raeburn 1920: push(@{$trusted},@{$doms_by_intdom{$inc}});
1.1347 raeburn 1921: }
1922: }
1923: }
1924: }
1.1349 raeburn 1925: return ($trusted,$untrusted);
1.1347 raeburn 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:
1.1 albertel 1947: # ---------------------- Find the homebase for a user from domain's lib servers
1.11 www 1948:
1.599 albertel 1949: my %homecache;
1.1 albertel 1950: sub homeserver {
1.230 stredwic 1951: my ($uname,$udom,$ignoreBadCache)=@_;
1.1 albertel 1952: my $index="$uname:$udom";
1.426 albertel 1953:
1.599 albertel 1954: if (exists($homecache{$index})) { return $homecache{$index}; }
1.841 albertel 1955:
1956: my %servers = &get_servers($udom,'library');
1957: foreach my $tryserver (keys(%servers)) {
1.230 stredwic 1958: next if ($ignoreBadCache ne 'true' &&
1.231 stredwic 1959: exists($badServerCache{$tryserver}));
1.841 albertel 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: }
1.1 albertel 1968: }
1969: return 'no_host';
1.70 www 1970: }
1971:
1.1300 raeburn 1972: # ----- Find the usernames behind a list of student/employee IDs or clicker IDs
1.70 www 1973:
1974: sub idget {
1.1300 raeburn 1975: my ($udom,$idsref,$namespace)=@_;
1.70 www 1976: my %returnhash=();
1.1300 raeburn 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: }
1.70 www 1986:
1.841 albertel 1987: my %servers = &get_servers($udom,'library');
1988: foreach my $tryserver (keys(%servers)) {
1.1299 raeburn 1989: my $idlist=join('&', map { &escape($_); } @ids);
1.1300 raeburn 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: }
1.841 albertel 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]) {
1.1299 raeburn 2006: $returnhash{$ids[$i]}=&unescape($answer[$i]);
1.1300 raeburn 2007: }
1.841 albertel 2008: }
1.1300 raeburn 2009: }
1.70 www 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=();
1.800 albertel 2018: foreach my $uname (@unames) {
2019: $returnhash{$uname}=(&userenvironment($udom,$uname,'id'))[1];
1.191 harris41 2020: }
1.70 www 2021: return %returnhash;
2022: }
2023:
1.1300 raeburn 2024: # Store away a list of names and associated student/employee IDs or clicker IDs
1.70 www 2025:
2026: sub idput {
1.1300 raeburn 2027: my ($udom,$idsref,$uhom,$namespace)=@_;
1.70 www 2028: my %servers=();
1.1300 raeburn 2029: my %ids=();
2030: my %byid = ();
2031: if (ref($idsref) eq 'HASH') {
2032: %ids=%{$idsref};
2033: }
2034: if ($namespace eq '') {
2035: $namespace = 'ids';
2036: }
1.800 albertel 2037: foreach my $uname (keys(%ids)) {
2038: &cput('environment',{'id'=>$ids{$uname}},$udom,$uname);
1.1300 raeburn 2039: if ($uhom eq '') {
2040: $uhom=&homeserver($uname,$udom);
2041: }
1.70 www 2042: if ($uhom ne 'no_host') {
1.800 albertel 2043: my $esc_unam=&escape($uname);
1.1300 raeburn 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.'&';
1.70 www 2049: } else {
1.1300 raeburn 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: }
1.70 www 2064: }
2065: }
1.191 harris41 2066: }
1.800 albertel 2067: foreach my $server (keys(%servers)) {
1.1300 raeburn 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: }
1.191 harris41 2074: }
1.344 www 2075: }
2076:
1.1300 raeburn 2077: # ------------- Delete unwanted student/employee IDs or clicker IDs from domain
1.1231 raeburn 2078:
2079: sub iddel {
1.1300 raeburn 2080: my ($udom,$idshashref,$uhome,$namespace)=@_;
1.1231 raeburn 2081: my %result=();
1.1300 raeburn 2082: my %ids=();
2083: my %byid = ();
2084: if (ref($idshashref) eq 'HASH') {
2085: %ids=%{$idshashref};
2086: } else {
1.1231 raeburn 2087: return %result;
2088: }
1.1300 raeburn 2089: if ($namespace eq '') {
2090: $namespace = 'ids';
2091: }
1.1231 raeburn 2092: my %servers=();
1.1300 raeburn 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: }
1.1231 raeburn 2113: }
1.1300 raeburn 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: }
1.1231 raeburn 2122: }
2123: }
2124: }
2125: foreach my $server (keys(%servers)) {
1.1300 raeburn 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: }
1.1231 raeburn 2132: }
2133: return %result;
2134: }
2135:
1.1300 raeburn 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:
1.1023 raeburn 2159: # ------------------------------dump from db file owned by domainconfig user
1.1012 raeburn 2160: sub dump_dom {
1.1165 droeschl 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);
1.1012 raeburn 2168: }
2169:
1.1023 raeburn 2170: # ------------------------------------------ get items from domain db files
1.806 raeburn 2171:
2172: sub get_dom {
1.1462 raeburn 2173: my ($namespace,$storearr,$udom,$uhome,$encrypt)=@_;
1.1267 raeburn 2174: return if ($udom eq 'public');
1.806 raeburn 2175: my $items='';
2176: foreach my $item (@$storearr) {
2177: $items.=&escape($item).'&';
2178: }
2179: $items=~s/\&$//;
1.860 raeburn 2180: if (!$udom) {
2181: $udom=$env{'user.domain'};
1.1267 raeburn 2182: return if ($udom eq 'public');
1.860 raeburn 2183: if (defined(&domain($udom,'primary'))) {
2184: $uhome=&domain($udom,'primary');
2185: } else {
1.874 albertel 2186: undef($uhome);
1.860 raeburn 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')) {
1.1344 raeburn 2196: my $rep;
1.1442 raeburn 2197: if (grep { $_ eq $uhome } ¤t_machine_ids()) {
2198: # domain information is hosted on this machine
1.1462 raeburn 2199: $rep = &LONCAPA::Lond::get_dom("getdom:$udom:$namespace:$items");
1.1344 raeburn 2200: } else {
1.1462 raeburn 2201: if ($encrypt) {
1.1442 raeburn 2202: $rep=&reply("encrypt:egetdom:$udom:$namespace:$items",$uhome);
2203: } else {
2204: $rep=&reply("getdom:$udom:$namespace:$items",$uhome);
2205: }
1.1344 raeburn 2206: }
1.866 raeburn 2207: my %returnhash;
1.875 albertel 2208: if ($rep eq '' || $rep =~ /^error: 2 /) {
1.866 raeburn 2209: return %returnhash;
2210: }
1.806 raeburn 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 {
1.880 banghart 2222: &logthis("get_dom failed - no homeserver and/or domain ($udom) ($uhome)");
1.806 raeburn 2223: }
2224: }
2225:
2226: # -------------------------------------------- put items in domain db files
2227:
2228: sub put_dom {
1.1462 raeburn 2229: my ($namespace,$storehash,$udom,$uhome,$encrypt)=@_;
1.860 raeburn 2230: if (!$udom) {
2231: $udom=$env{'user.domain'};
2232: if (defined(&domain($udom,'primary'))) {
2233: $uhome=&domain($udom,'primary');
2234: } else {
1.874 albertel 2235: undef($uhome);
1.860 raeburn 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')) {
1.806 raeburn 2245: my $items='';
2246: foreach my $item (keys(%$storehash)) {
2247: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
2248: }
2249: $items=~s/\&$//;
1.1462 raeburn 2250: if ($encrypt) {
1.1344 raeburn 2251: return &reply("encrypt:putdom:$udom:$namespace:$items",$uhome);
2252: } else {
2253: return &reply("putdom:$udom:$namespace:$items",$uhome);
2254: }
1.806 raeburn 2255: } else {
1.860 raeburn 2256: &logthis("put_dom failed - no homeserver and/or domain");
1.806 raeburn 2257: }
2258: }
2259:
1.1023 raeburn 2260: # --------------------- newput for items in db file owned by domainconfig user
1.1012 raeburn 2261: sub newput_dom {
1.1023 raeburn 2262: my ($namespace,$storehash,$udom) = @_;
1.1012 raeburn 2263: my $result;
2264: if (!$udom) {
2265: $udom=$env{'user.domain'};
2266: }
1.1023 raeburn 2267: if ($udom) {
2268: my $uname = &get_domainconfiguser($udom);
2269: $result = &newput($namespace,$storehash,$udom,$uname);
1.1012 raeburn 2270: }
2271: return $result;
2272: }
2273:
1.1023 raeburn 2274: # --------------------- delete for items in db file owned by domainconfig user
1.1012 raeburn 2275: sub del_dom {
1.1023 raeburn 2276: my ($namespace,$storearr,$udom)=@_;
1.1012 raeburn 2277: if (ref($storearr) eq 'ARRAY') {
2278: if (!$udom) {
2279: $udom=$env{'user.domain'};
2280: }
1.1023 raeburn 2281: if ($udom) {
2282: my $uname = &get_domainconfiguser($udom);
2283: return &del($namespace,$storearr,$udom,$uname);
1.1012 raeburn 2284: }
2285: }
2286: }
2287:
1.1481 raeburn 2288: sub store_dom {
1.1482 raeburn 2289: my ($storehash,$id,$namespace,$dom,$home,$encrypt) = @_;
1.1481 raeburn 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';
1.1482 raeburn 2302: } elsif ($encrypt) {
2303: return reply("encrypt:storedom:$dom:$namespace:$id:$namevalue",$home);
1.1481 raeburn 2304: } else {
1.1482 raeburn 2305: return reply("storedom:$dom:$namespace:$id:$namevalue",$home);
1.1481 raeburn 2306: }
2307: }
2308: }
2309:
1.1482 raeburn 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:
1.1023 raeburn 2339: # ----------------------------------construct domainconfig user for a domain
2340: sub get_domainconfiguser {
2341: my ($udom) = @_;
2342: return $udom.'-domainconfig';
2343: }
2344:
1.837 raeburn 2345: sub retrieve_inst_usertypes {
2346: my ($udom) = @_;
2347: my (%returnhash,@order);
1.1494 raeburn 2348: my %domdefs = &get_domain_defaults($udom);
1.989 raeburn 2349: if ((ref($domdefs{'inststatustypes'}) eq 'HASH') &&
2350: (ref($domdefs{'inststatusorder'}) eq 'ARRAY')) {
1.1256 raeburn 2351: return ($domdefs{'inststatustypes'},$domdefs{'inststatusorder'});
1.989 raeburn 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)/) {
1.1256 raeburn 2357: &logthis("retrieve_inst_usertypes failed - $rep returned from $uhome in domain: $udom");
1.989 raeburn 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 {
1.1256 raeburn 2373: &logthis("retrieve_inst_usertypes failed - no primary domain server for $udom");
1.837 raeburn 2374: }
1.1256 raeburn 2375: return (\%returnhash,\@order);
1.837 raeburn 2376: }
2377: }
2378:
1.868 raeburn 2379: sub is_domainimage {
2380: my ($url) = @_;
1.1468 raeburn 2381: if ($url=~m-^/+res/+($match_domain)/+\1\-domainconfig/+(img|logo|domlogo|login)/+[^/]-) {
1.868 raeburn 2382: if (&domain($1) ne '') {
2383: return '1';
2384: }
2385: }
2386: return;
2387: }
2388:
1.899 raeburn 2389: sub inst_directory_query {
2390: my ($srch) = @_;
2391: my $udom = $srch->{'srchdomain'};
2392: my %results;
2393: my $homeserver = &domain($udom,'primary');
1.909 raeburn 2394: my $outcome;
1.899 raeburn 2395: if ($homeserver ne '') {
1.1357 raeburn 2396: unless ($homeserver eq $perlvar{'lonHostID'}) {
2397: if ($srch->{'srchby'} eq 'email') {
1.1417 raeburn 2398: my $lcrev = &get_server_loncaparev($udom,$homeserver);
1.1357 raeburn 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: }
1.904 albertel 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\_/) {
1.1343 raeburn 2412: &logthis('institutional directory search invalid queryid: '.$queryid.' for host: '.$homeserver.' in domain '.$udom);
1.904 albertel 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') {
1.909 raeburn 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: }
1.899 raeburn 2433: }
2434: }
2435: }
1.909 raeburn 2436: return ($outcome,%results);
1.899 raeburn 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) {
1.1357 raeburn 2447: unless ($tryserver eq $perlvar{'lonHostID'}) {
2448: if ($srch->{'srchby'} eq 'email') {
1.1417 raeburn 2449: my $lcrev = &get_server_loncaparev($dom,$tryserver);
1.1357 raeburn 2450: my ($major,$minor) = ($lcrev =~ /^\'?(\d+)\.(\d+)\.[\w.\-]+\'?$/);
2451: next if (($major eq '' && $minor eq '') || ($major < 2) ||
2452: (($major == 2) && ($minor < 12)));
2453: }
2454: }
1.899 raeburn 2455: my $host=&hostname($tryserver);
2456: my $queryid=
1.911 raeburn 2457: &reply("querysend:".&escape($query).':'.
2458: &escape($srch->{'srchby'}).':'.
1.899 raeburn 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);
1.902 raeburn 2463: next;
1.899 raeburn 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 {
1.911 raeburn 2475: my @matches;
2476: if ($reply =~ /\n/) {
2477: @matches = split(/\n/,$reply);
2478: } else {
2479: @matches = split(/\&/,$reply);
2480: }
1.899 raeburn 2481: foreach my $match (@matches) {
2482: my ($uname,$udom,%userhash);
1.911 raeburn 2483: foreach my $entry (split(/:/,$match)) {
2484: my ($key,$value) =
2485: map {&unescape($_);} split(/=/,$entry);
1.899 raeburn 2486: $userhash{$key} = $value;
2487: if ($key eq 'username') {
2488: $uname = $value;
2489: } elsif ($key eq 'domain') {
2490: $udom = $value;
1.911 raeburn 2491: }
1.899 raeburn 2492: }
2493: $results{$uname.':'.$udom} = \%userhash;
2494: }
2495: }
2496: }
2497: }
2498: return %results;
2499: }
2500:
1.912 raeburn 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:
1.1290 raeburn 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);
1.1291 raeburn 2575: $outcome = $resp;
1.1290 raeburn 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 {
1.1291 raeburn 2586: ($outcome,my $userdata) = split(/=/,$response,2);
1.1290 raeburn 2587: if ($outcome eq 'ok') {
2588: $results = &thaw_unescape($userdata);
2589: }
2590: }
2591: }
2592: }
2593: }
2594: return ($outcome,$results);
2595: }
2596:
1.912 raeburn 2597: sub inst_rulecheck {
1.923 raeburn 2598: my ($udom,$uname,$id,$item,$rules) = @_;
1.912 raeburn 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')) {
1.923 raeburn 2606: my $response;
2607: if ($item eq 'username') {
2608: $response=&unescape(&reply('instrulecheck:'.&escape($udom).
2609: ':'.&escape($uname).':'.$rulestr,
1.912 raeburn 2610: $homeserver));
1.923 raeburn 2611: } elsif ($item eq 'id') {
2612: $response=&unescape(&reply('instidrulecheck:'.&escape($udom).
2613: ':'.&escape($id).':'.$rulestr,
2614: $homeserver));
1.945 raeburn 2615: } elsif ($item eq 'selfcreate') {
2616: $response=&unescape(&reply('instselfcreatecheck:'.
1.943 raeburn 2617: &escape($udom).':'.&escape($uname).
2618: ':'.$rulestr,$homeserver));
1.1484 raeburn 2619: } elsif ($item eq 'unamemap') {
2620: $response=&unescape(&reply('instunamemapcheck:'.
2621: &escape($udom).':'.&escape($uname).
2622: ':'.$rulestr,$homeserver));
1.923 raeburn 2623: }
1.912 raeburn 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 {
1.923 raeburn 2640: my ($udom,$check) = @_;
1.912 raeburn 2641: my (%ruleshash,@ruleorder);
2642: if ($udom ne '') {
2643: my $homeserver=&domain($udom,'primary');
2644: if (($homeserver ne '') && ($homeserver ne 'no_host')) {
1.923 raeburn 2645: my $response;
2646: if ($check eq 'id') {
2647: $response=&reply('instidrules:'.&escape($udom),
1.912 raeburn 2648: $homeserver);
1.943 raeburn 2649: } elsif ($check eq 'email') {
2650: $response=&reply('instemailrules:'.&escape($udom),
2651: $homeserver);
1.1484 raeburn 2652: } elsif ($check eq 'unamemap') {
2653: $response=&reply('unamemaprules:'.&escape($udom),
2654: $homeserver);
1.923 raeburn 2655: } else {
2656: $response=&reply('instuserrules:'.&escape($udom),
2657: $homeserver);
2658: }
1.912 raeburn 2659: if (($response ne 'refused') && ($response ne 'error') &&
1.923 raeburn 2660: ($response ne 'unknown_cmd') &&
1.912 raeburn 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:
1.976 raeburn 2680: # ------------- Get Authentication, Language and User Tools Defaults for Domain
1.943 raeburn 2681:
2682: sub get_domain_defaults {
1.1240 raeburn 2683: my ($domain,$ignore_cache) = @_;
1.1242 raeburn 2684: return if (($domain eq '') || ($domain eq 'public'));
1.943 raeburn 2685: my $cachetime = 60*60*24;
1.1240 raeburn 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: }
1.943 raeburn 2692: }
2693: }
2694: my %domdefaults;
2695: my %domconfig =
1.1494 raeburn 2696: &get_dom('configuration',['defaults','quotas',
1.1047 raeburn 2697: 'requestcourses','inststatus',
1.1183 raeburn 2698: 'coursedefaults','usersessions',
1.1258 raeburn 2699: 'requestauthor','selfenrollment',
1.1320 raeburn 2700: 'coursecategories','ssl','autoenroll',
1.1504 ! raeburn 2701: 'trust','helpsettings','wafproxy',
! 2702: 'ltisec','toolsec'],$domain);
1.1305 raeburn 2703: my @coursetypes = ('official','unofficial','community','textbook','placement');
1.943 raeburn 2704: if (ref($domconfig{'defaults'}) eq 'HASH') {
2705: $domdefaults{'lang_def'} = $domconfig{'defaults'}{'lang_def'};
2706: $domdefaults{'auth_def'} = $domconfig{'defaults'}{'auth_def'};
2707: $domdefaults{'auth_arg_def'} = $domconfig{'defaults'}{'auth_arg_def'};
1.982 raeburn 2708: $domdefaults{'timezone_def'} = $domconfig{'defaults'}{'timezone_def'};
1.985 raeburn 2709: $domdefaults{'datelocale_def'} = $domconfig{'defaults'}{'datelocale_def'};
1.1147 raeburn 2710: $domdefaults{'portal_def'} = $domconfig{'defaults'}{'portal_def'};
1.1492 raeburn 2711: $domdefaults{'portal_def_email'} = $domconfig{'defaults'}{'portal_def_email'};
2712: $domdefaults{'portal_def_web'} = $domconfig{'defaults'}{'portal_def_web'};
1.1340 raeburn 2713: $domdefaults{'intauth_cost'} = $domconfig{'defaults'}{'intauth_cost'};
2714: $domdefaults{'intauth_switch'} = $domconfig{'defaults'}{'intauth_switch'};
2715: $domdefaults{'intauth_check'} = $domconfig{'defaults'}{'intauth_check'};
1.1484 raeburn 2716: $domdefaults{'unamemap_rule'} = $domconfig{'defaults'}{'unamemap_rule'};
1.943 raeburn 2717: } else {
2718: $domdefaults{'lang_def'} = &domain($domain,'lang_def');
2719: $domdefaults{'auth_def'} = &domain($domain,'auth_def');
2720: $domdefaults{'auth_arg_def'} = &domain($domain,'auth_arg_def');
2721: }
1.976 raeburn 2722: if (ref($domconfig{'quotas'}) eq 'HASH') {
2723: if (ref($domconfig{'quotas'}{'defaultquota'}) eq 'HASH') {
2724: $domdefaults{'defaultquota'} = $domconfig{'quotas'}{'defaultquota'};
2725: } else {
2726: $domdefaults{'defaultquota'} = $domconfig{'quotas'};
1.1229 raeburn 2727: }
1.1177 raeburn 2728: my @usertools = ('aboutme','blog','webdav','portfolio');
1.976 raeburn 2729: foreach my $item (@usertools) {
2730: if (ref($domconfig{'quotas'}{$item}) eq 'HASH') {
2731: $domdefaults{$item} = $domconfig{'quotas'}{$item};
2732: }
2733: }
1.1229 raeburn 2734: if (ref($domconfig{'quotas'}{'authorquota'}) eq 'HASH') {
2735: $domdefaults{'authorquota'} = $domconfig{'quotas'}{'authorquota'};
2736: }
1.976 raeburn 2737: }
1.985 raeburn 2738: if (ref($domconfig{'requestcourses'}) eq 'HASH') {
1.1305 raeburn 2739: foreach my $item ('official','unofficial','community','textbook','placement') {
1.985 raeburn 2740: $domdefaults{$item} = $domconfig{'requestcourses'}{$item};
2741: }
2742: }
1.1183 raeburn 2743: if (ref($domconfig{'requestauthor'}) eq 'HASH') {
2744: $domdefaults{'requestauthor'} = $domconfig{'requestauthor'};
2745: }
1.989 raeburn 2746: if (ref($domconfig{'inststatus'}) eq 'HASH') {
1.1256 raeburn 2747: foreach my $item ('inststatustypes','inststatusorder','inststatusguest') {
1.989 raeburn 2748: $domdefaults{$item} = $domconfig{'inststatus'}{$item};
2749: }
2750: }
1.1047 raeburn 2751: if (ref($domconfig{'coursedefaults'}) eq 'HASH') {
1.1230 raeburn 2752: $domdefaults{'canuse_pdfforms'} = $domconfig{'coursedefaults'}{'canuse_pdfforms'};
1.1277 raeburn 2753: $domdefaults{'usejsme'} = $domconfig{'coursedefaults'}{'usejsme'};
1.1476 raeburn 2754: $domdefaults{'inline_chem'} = $domconfig{'coursedefaults'}{'inline_chem'};
1.1277 raeburn 2755: $domdefaults{'uselcmath'} = $domconfig{'coursedefaults'}{'uselcmath'};
2756: if (ref($domconfig{'coursedefaults'}{'postsubmit'}) eq 'HASH') {
2757: $domdefaults{'postsubmit'} = $domconfig{'coursedefaults'}{'postsubmit'}{'client'};
2758: }
1.1254 raeburn 2759: foreach my $type (@coursetypes) {
2760: if (ref($domconfig{'coursedefaults'}{'coursecredits'}) eq 'HASH') {
2761: unless ($type eq 'community') {
2762: $domdefaults{$type.'credits'} = $domconfig{'coursedefaults'}{'coursecredits'}{$type};
2763: }
2764: }
2765: if (ref($domconfig{'coursedefaults'}{'uploadquota'}) eq 'HASH') {
2766: $domdefaults{$type.'quota'} = $domconfig{'coursedefaults'}{'uploadquota'}{$type};
2767: }
1.1277 raeburn 2768: if ($domdefaults{'postsubmit'} eq 'on') {
2769: if (ref($domconfig{'coursedefaults'}{'postsubmit'}{'timeout'}) eq 'HASH') {
2770: $domdefaults{$type.'postsubtimeout'} =
2771: $domconfig{'coursedefaults'}{'postsubmit'}{'timeout'}{$type};
2772: }
2773: }
1.1230 raeburn 2774: }
1.1286 raeburn 2775: if (ref($domconfig{'coursedefaults'}{'canclone'}) eq 'HASH') {
2776: if (ref($domconfig{'coursedefaults'}{'canclone'}{'instcode'}) eq 'ARRAY') {
2777: my @clonecodes = @{$domconfig{'coursedefaults'}{'canclone'}{'instcode'}};
2778: if (@clonecodes) {
2779: $domdefaults{'canclone'} = join('+',@clonecodes);
2780: }
2781: }
2782: } elsif ($domconfig{'coursedefaults'}{'canclone'}) {
2783: $domdefaults{'canclone'}=$domconfig{'coursedefaults'}{'canclone'};
2784: }
1.1356 raeburn 2785: if ($domconfig{'coursedefaults'}{'texengine'}) {
2786: $domdefaults{'texengine'} = $domconfig{'coursedefaults'}{'texengine'};
1.1480 raeburn 2787: }
2788: if (exists($domconfig{'coursedefaults'}{'ltiauth'})) {
2789: $domdefaults{'crsltiauth'} = $domconfig{'coursedefaults'}{'ltiauth'};
2790: }
1.1047 raeburn 2791: }
1.1073 raeburn 2792: if (ref($domconfig{'usersessions'}) eq 'HASH') {
2793: if (ref($domconfig{'usersessions'}{'remote'}) eq 'HASH') {
2794: $domdefaults{'remotesessions'} = $domconfig{'usersessions'}{'remote'};
2795: }
2796: if (ref($domconfig{'usersessions'}{'hosted'}) eq 'HASH') {
2797: $domdefaults{'hostedsessions'} = $domconfig{'usersessions'}{'hosted'};
2798: }
1.1279 raeburn 2799: if (ref($domconfig{'usersessions'}{'offloadnow'}) eq 'HASH') {
2800: $domdefaults{'offloadnow'} = $domconfig{'usersessions'}{'offloadnow'};
2801: }
1.1440 raeburn 2802: if (ref($domconfig{'usersessions'}{'offloadoth'}) eq 'HASH') {
1.1439 raeburn 2803: $domdefaults{'offloadoth'} = $domconfig{'usersessions'}{'offloadoth'};
2804: }
1.1073 raeburn 2805: }
1.1254 raeburn 2806: if (ref($domconfig{'selfenrollment'}) eq 'HASH') {
2807: if (ref($domconfig{'selfenrollment'}{'admin'}) eq 'HASH') {
2808: my @settings = ('types','registered','enroll_dates','access_dates','section',
2809: 'approval','limit');
2810: foreach my $type (@coursetypes) {
2811: if (ref($domconfig{'selfenrollment'}{'admin'}{$type}) eq 'HASH') {
2812: my @mgrdc = ();
2813: foreach my $item (@settings) {
2814: if ($domconfig{'selfenrollment'}{'admin'}{$type}{$item} eq '0') {
2815: push(@mgrdc,$item);
2816: }
2817: }
2818: if (@mgrdc) {
2819: $domdefaults{$type.'selfenrolladmdc'} = join(',',@mgrdc);
2820: }
2821: }
2822: }
2823: }
2824: if (ref($domconfig{'selfenrollment'}{'default'}) eq 'HASH') {
2825: foreach my $type (@coursetypes) {
2826: if (ref($domconfig{'selfenrollment'}{'default'}{$type}) eq 'HASH') {
2827: foreach my $item (keys(%{$domconfig{'selfenrollment'}{'default'}{$type}})) {
2828: $domdefaults{$type.'selfenroll'.$item} = $domconfig{'selfenrollment'}{'default'}{$type}{$item};
2829: }
2830: }
2831: }
2832: }
2833: }
1.1258 raeburn 2834: if (ref($domconfig{'coursecategories'}) eq 'HASH') {
2835: $domdefaults{'catauth'} = 'std';
2836: $domdefaults{'catunauth'} = 'std';
1.1413 raeburn 2837: if ($domconfig{'coursecategories'}{'auth'}) {
1.1258 raeburn 2838: $domdefaults{'catauth'} = $domconfig{'coursecategories'}{'auth'};
2839: }
2840: if ($domconfig{'coursecategories'}{'unauth'}) {
2841: $domdefaults{'catunauth'} = $domconfig{'coursecategories'}{'unauth'};
2842: }
2843: }
1.1315 raeburn 2844: if (ref($domconfig{'ssl'}) eq 'HASH') {
2845: if (ref($domconfig{'ssl'}{'replication'}) eq 'HASH') {
2846: $domdefaults{'replication'} = $domconfig{'ssl'}{'replication'};
2847: }
1.1338 raeburn 2848: if (ref($domconfig{'ssl'}{'connto'}) eq 'HASH') {
2849: $domdefaults{'connect'} = $domconfig{'ssl'}{'connto'};
2850: }
2851: if (ref($domconfig{'ssl'}{'connfrom'}) eq 'HASH') {
2852: $domdefaults{'connect'} = $domconfig{'ssl'}{'connfrom'};
1.1315 raeburn 2853: }
2854: }
1.1320 raeburn 2855: if (ref($domconfig{'trust'}) eq 'HASH') {
2856: my @prefixes = qw(content shared enroll othcoau coaurem domroles catalog reqcrs msg);
2857: foreach my $prefix (@prefixes) {
2858: if (ref($domconfig{'trust'}{$prefix}) eq 'HASH') {
2859: $domdefaults{'trust'.$prefix} = $domconfig{'trust'}{$prefix};
2860: }
2861: }
2862: }
1.1314 raeburn 2863: if (ref($domconfig{'autoenroll'}) eq 'HASH') {
2864: $domdefaults{'autofailsafe'} = $domconfig{'autoenroll'}{'autofailsafe'};
1.1477 raeburn 2865: $domdefaults{'failsafe'} = $domconfig{'autoenroll'}{'failsafe'};
1.1314 raeburn 2866: }
1.1332 raeburn 2867: if (ref($domconfig{'helpsettings'}) eq 'HASH') {
2868: $domdefaults{'submitbugs'} = $domconfig{'helpsettings'}{'submitbugs'};
2869: if (ref($domconfig{'helpsettings'}{'adhoc'}) eq 'HASH') {
2870: $domdefaults{'adhocroles'} = $domconfig{'helpsettings'}{'adhoc'};
2871: }
2872: }
1.1434 raeburn 2873: if (ref($domconfig{'wafproxy'}) eq 'HASH') {
1.1449 raeburn 2874: foreach my $item ('ipheader','trusted','vpnint','vpnext','sslopt') {
1.1434 raeburn 2875: if ($domconfig{'wafproxy'}{$item}) {
2876: $domdefaults{'waf_'.$item} = $domconfig{'wafproxy'}{$item};
2877: }
2878: }
1.1482 raeburn 2879: }
2880: if (ref($domconfig{'ltisec'}) eq 'HASH') {
2881: if (ref($domconfig{'ltisec'}{'encrypt'}) eq 'HASH') {
2882: $domdefaults{'linkprotenc_crs'} = $domconfig{'ltisec'}{'encrypt'}{'crs'};
2883: $domdefaults{'linkprotenc_dom'} = $domconfig{'ltisec'}{'encrypt'}{'dom'};
2884: $domdefaults{'ltienc_consumers'} = $domconfig{'ltisec'}{'encrypt'}{'consumers'};
2885: }
2886: if (ref($domconfig{'ltisec'}{'private'}) eq 'HASH') {
2887: if (ref($domconfig{'ltisec'}{'private'}{'keys'}) eq 'ARRAY') {
1.1504 ! raeburn 2888: $domdefaults{'ltiprivhosts'} = $domconfig{'ltisec'}{'private'}{'keys'};
! 2889: }
! 2890: }
! 2891: }
! 2892: if (ref($domconfig{'toolsec'}) eq 'HASH') {
! 2893: if (ref($domconfig{'toolsec'}{'encrypt'}) eq 'HASH') {
! 2894: $domdefaults{'toolenc_crs'} = $domconfig{'toolsec'}{'encrypt'}{'crs'};
! 2895: $domdefaults{'toolenc_dom'} = $domconfig{'toolsec'}{'encrypt'}{'dom'};
! 2896: }
! 2897: if (ref($domconfig{'toolsec'}{'private'}) eq 'HASH') {
! 2898: if (ref($domconfig{'toolsec'}{'private'}{'keys'}) eq 'ARRAY') {
! 2899: $domdefaults{'toolprivhosts'} = $domconfig{'toolsec'}{'private'}{'keys'};
1.1482 raeburn 2900: }
2901: }
2902: }
1.1219 raeburn 2903: &do_cache_new('domdefaults',$domain,\%domdefaults,$cachetime);
1.943 raeburn 2904: return %domdefaults;
2905: }
2906:
1.1412 raeburn 2907: sub get_dom_cats {
2908: my ($dom) = @_;
2909: return unless (&domain($dom));
2910: my ($cats,$cached)=&is_cached_new('cats',$dom);
2911: unless (defined($cached)) {
2912: my %domconfig = &get_dom('configuration',['coursecategories'],$dom);
2913: if (ref($domconfig{'coursecategories'}) eq 'HASH') {
2914: if (ref($domconfig{'coursecategories'}{'cats'}) eq 'HASH') {
2915: %{$cats} = %{$domconfig{'coursecategories'}{'cats'}};
2916: } else {
2917: $cats = {};
2918: }
2919: } else {
2920: $cats = {};
2921: }
1.1494 raeburn 2922: &do_cache_new('cats',$dom,$cats,3600);
1.1412 raeburn 2923: }
1.1413 raeburn 2924: return $cats;
2925: }
2926:
2927: sub get_dom_instcats {
2928: my ($dom) = @_;
2929: return unless (&domain($dom));
2930: my ($instcats,$cached)=&is_cached_new('instcats',$dom);
2931: unless (defined($cached)) {
2932: my (%coursecodes,%codes,@codetitles,%cat_titles,%cat_order);
2933: my $totcodes = &retrieve_instcodes(\%coursecodes,$dom);
2934: if ($totcodes > 0) {
2935: my $caller = 'global';
2936: if (&auto_instcode_format($caller,$dom,\%coursecodes,\%codes,
2937: \@codetitles,\%cat_titles,\%cat_order) eq 'ok') {
2938: $instcats = {
1.1503 raeburn 2939: totcodes => $totcodes,
1.1413 raeburn 2940: codes => \%codes,
2941: codetitles => \@codetitles,
2942: cat_titles => \%cat_titles,
2943: cat_order => \%cat_order,
2944: };
2945: &do_cache_new('instcats',$dom,$instcats,3600);
2946: }
2947: }
2948: }
2949: return $instcats;
2950: }
2951:
2952: sub retrieve_instcodes {
2953: my ($coursecodes,$dom) = @_;
2954: my $totcodes;
2955: my %courses = &courseiddump($dom,'.',1,'.','.','.',undef,undef,'Course');
2956: foreach my $course (keys(%courses)) {
2957: if (ref($courses{$course}) eq 'HASH') {
2958: if ($courses{$course}{'inst_code'} ne '') {
2959: $$coursecodes{$course} = $courses{$course}{'inst_code'};
2960: $totcodes ++;
2961: }
2962: }
2963: }
2964: return $totcodes;
1.1412 raeburn 2965: }
2966:
1.1311 raeburn 2967: sub course_portal_url {
1.1451 raeburn 2968: my ($cnum,$cdom,$r) = @_;
1.1311 raeburn 2969: my $chome = &homeserver($cnum,$cdom);
2970: my $hostname = &hostname($chome);
2971: my $protocol = $protocol{$chome};
2972: $protocol = 'http' if ($protocol ne 'https');
2973: my %domdefaults = &get_domain_defaults($cdom);
2974: my $firsturl;
2975: if ($domdefaults{'portal_def'}) {
2976: $firsturl = $domdefaults{'portal_def'};
2977: } else {
1.1494 raeburn 2978: my $alias = &use_proxy_alias($r,$chome);
1.1451 raeburn 2979: $hostname = $alias if ($alias ne '');
1.1311 raeburn 2980: $firsturl = $protocol.'://'.$hostname;
2981: }
2982: return $firsturl;
2983: }
2984:
1.1492 raeburn 2985: sub url_prefix {
2986: my ($r,$dom,$home,$context) = @_;
2987: my $prefix;
2988: my %domdefs = &get_domain_defaults($dom);
2989: if ($domdefs{'portal_def'} && $domdefs{'portal_def_'.$context}) {
2990: if ($domdefs{'portal_def'} =~ m{^(https?://[^/]+)}) {
2991: $prefix = $1;
2992: }
2993: }
2994: if ($prefix eq '') {
2995: my $hostname = &hostname($home);
2996: my $protocol = $protocol{$home};
2997: $protocol = 'http' if ($protocol{$home} ne 'https');
2998: my $alias = &use_proxy_alias($r,$home);
2999: $hostname = $alias if ($alias ne '');
3000: $prefix = $protocol.'://'.$hostname;
3001: }
3002: return $prefix;
3003: }
3004:
1.1407 raeburn 3005: # --------------------------------------------- Get domain config for passwords
3006:
3007: sub get_passwdconf {
3008: my ($dom) = @_;
3009: my (%passwdconf,$gotconf,$lookup);
3010: my ($result,$cached)=&is_cached_new('passwdconf',$dom);
3011: if (defined($cached)) {
3012: if (ref($result) eq 'HASH') {
3013: %passwdconf = %{$result};
3014: $gotconf = 1;
3015: }
3016: }
3017: unless ($gotconf) {
3018: my %domconfig = &get_dom('configuration',['passwords'],$dom);
3019: if (ref($domconfig{'passwords'}) eq 'HASH') {
3020: %passwdconf = %{$domconfig{'passwords'}};
3021: }
3022: my $cachetime = 24*60*60;
3023: &do_cache_new('passwdconf',$dom,\%passwdconf,$cachetime);
3024: }
3025: return %passwdconf;
3026: }
3027:
1.344 www 3028: # --------------------------------------------------- Assign a key to a student
3029:
3030: sub assign_access_key {
1.364 www 3031: #
3032: # a valid key looks like uname:udom#comments
3033: # comments are being appended
3034: #
1.498 www 3035: my ($ckey,$kdom,$knum,$cdom,$cnum,$udom,$uname,$logentry)=@_;
3036: $kdom=
1.620 albertel 3037: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($kdom));
1.498 www 3038: $knum=
1.620 albertel 3039: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($knum));
1.344 www 3040: $cdom=
1.620 albertel 3041: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
1.344 www 3042: $cnum=
1.620 albertel 3043: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
3044: $udom=$env{'user.name'} unless (defined($udom));
3045: $uname=$env{'user.domain'} unless (defined($uname));
1.498 www 3046: my %existing=&get('accesskeys',[$ckey],$kdom,$knum);
1.364 www 3047: if (($existing{$ckey}=~/^\#(.*)$/) || # - new key
1.479 albertel 3048: ($existing{$ckey}=~/^\Q$uname\E\:\Q$udom\E\#(.*)$/)) {
1.364 www 3049: # assigned to this person
3050: # - this should not happen,
1.345 www 3051: # unless something went wrong
3052: # the first time around
3053: # ready to assign
1.364 www 3054: $logentry=$1.'; '.$logentry;
1.496 www 3055: if (&put('accesskeys',{$ckey=>$uname.':'.$udom.'#'.$logentry},
1.498 www 3056: $kdom,$knum) eq 'ok') {
1.345 www 3057: # key now belongs to user
1.346 www 3058: my $envkey='key.'.$cdom.'_'.$cnum;
1.345 www 3059: if (&put('environment',{$envkey => $ckey}) eq 'ok') {
1.949 raeburn 3060: &appenv({'environment.'.$envkey => $ckey});
1.345 www 3061: return 'ok';
3062: } else {
3063: return
3064: 'error: Count not permanently assign key, will need to be re-entered later.';
3065: }
3066: } else {
3067: return 'error: Could not assign key, try again later.';
3068: }
1.364 www 3069: } elsif (!$existing{$ckey}) {
1.345 www 3070: # the key does not exist
3071: return 'error: The key does not exist';
3072: } else {
3073: # the key is somebody else's
3074: return 'error: The key is already in use';
3075: }
1.344 www 3076: }
3077:
1.364 www 3078: # ------------------------------------------ put an additional comment on a key
3079:
3080: sub comment_access_key {
3081: #
3082: # a valid key looks like uname:udom#comments
3083: # comments are being appended
3084: #
3085: my ($ckey,$cdom,$cnum,$logentry)=@_;
3086: $cdom=
1.620 albertel 3087: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
1.364 www 3088: $cnum=
1.620 albertel 3089: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
1.364 www 3090: my %existing=&get('accesskeys',[$ckey],$cdom,$cnum);
3091: if ($existing{$ckey}) {
3092: $existing{$ckey}.='; '.$logentry;
3093: # ready to assign
1.367 www 3094: if (&put('accesskeys',{$ckey=>$existing{$ckey}},
1.364 www 3095: $cdom,$cnum) eq 'ok') {
3096: return 'ok';
3097: } else {
3098: return 'error: Count not store comment.';
3099: }
3100: } else {
3101: # the key does not exist
3102: return 'error: The key does not exist';
3103: }
3104: }
3105:
1.344 www 3106: # ------------------------------------------------------ Generate a set of keys
3107:
3108: sub generate_access_keys {
1.364 www 3109: my ($number,$cdom,$cnum,$logentry)=@_;
1.344 www 3110: $cdom=
1.620 albertel 3111: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
1.344 www 3112: $cnum=
1.620 albertel 3113: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
1.361 www 3114: unless (&allowed('mky',$cdom)) { return 0; }
1.344 www 3115: unless (($cdom) && ($cnum)) { return 0; }
3116: if ($number>10000) { return 0; }
3117: sleep(2); # make sure don't get same seed twice
3118: srand(time()^($$+($$<<15))); # from "Programming Perl"
3119: my $total=0;
3120: for (my $i=1;$i<=$number;$i++) {
3121: my $newkey=sprintf("%lx",int(100000*rand)).'-'.
3122: sprintf("%lx",int(100000*rand)).'-'.
3123: sprintf("%lx",int(100000*rand));
3124: $newkey=~s/1/g/g; # folks mix up 1 and l
3125: $newkey=~s/0/h/g; # and also 0 and O
3126: my %existing=&get('accesskeys',[$newkey],$cdom,$cnum);
3127: if ($existing{$newkey}) {
3128: $i--;
3129: } else {
1.364 www 3130: if (&put('accesskeys',
3131: { $newkey => '# generated '.localtime().
1.620 albertel 3132: ' by '.$env{'user.name'}.'@'.$env{'user.domain'}.
1.364 www 3133: '; '.$logentry },
3134: $cdom,$cnum) eq 'ok') {
1.344 www 3135: $total++;
3136: }
3137: }
3138: }
1.620 albertel 3139: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},
1.344 www 3140: 'Generated '.$total.' keys for '.$cnum.' at '.$cdom);
3141: return $total;
3142: }
3143:
3144: # ------------------------------------------------------- Validate an accesskey
3145:
3146: sub validate_access_key {
3147: my ($ckey,$cdom,$cnum,$udom,$uname)=@_;
3148: $cdom=
1.620 albertel 3149: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
1.344 www 3150: $cnum=
1.620 albertel 3151: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
3152: $udom=$env{'user.domain'} unless (defined($udom));
3153: $uname=$env{'user.name'} unless (defined($uname));
1.345 www 3154: my %existing=&get('accesskeys',[$ckey],$cdom,$cnum);
1.479 albertel 3155: return ($existing{$ckey}=~/^\Q$uname\E\:\Q$udom\E\#/);
1.70 www 3156: }
3157:
3158: # ------------------------------------- Find the section of student in a course
1.652 albertel 3159: sub devalidate_getsection_cache {
3160: my ($udom,$unam,$courseid)=@_;
3161: my $hashid="$udom:$unam:$courseid";
3162: &devalidate_cache_new('getsection',$hashid);
3163: }
1.298 matthew 3164:
1.815 albertel 3165: sub courseid_to_courseurl {
3166: my ($courseid) = @_;
3167: #already url style courseid
3168: return $courseid if ($courseid =~ m{^/});
3169:
3170: if (exists($env{'course.'.$courseid.'.num'})) {
3171: my $cnum = $env{'course.'.$courseid.'.num'};
3172: my $cdom = $env{'course.'.$courseid.'.domain'};
3173: return "/$cdom/$cnum";
3174: }
3175:
1.1494 raeburn 3176: my %courseinfo=&coursedescription($courseid);
1.815 albertel 3177: if (exists($courseinfo{'num'})) {
3178: return "/$courseinfo{'domain'}/$courseinfo{'num'}";
3179: }
3180:
3181: return undef;
3182: }
3183:
1.298 matthew 3184: sub getsection {
3185: my ($udom,$unam,$courseid)=@_;
1.599 albertel 3186: my $cachetime=1800;
1.551 albertel 3187:
3188: my $hashid="$udom:$unam:$courseid";
1.599 albertel 3189: my ($result,$cached)=&is_cached_new('getsection',$hashid);
1.551 albertel 3190: if (defined($cached)) { return $result; }
3191:
1.298 matthew 3192: my %Pending;
3193: my %Expired;
3194: #
3195: # Each role can either have not started yet (pending), be active,
3196: # or have expired.
3197: #
3198: # If there is an active role, we are done.
3199: #
3200: # If there is more than one role which has not started yet,
3201: # choose the one which will start sooner
3202: # If there is one role which has not started yet, return it.
3203: #
3204: # If there is more than one expired role, choose the one which ended last.
3205: # If there is a role which has expired, return it.
3206: #
1.815 albertel 3207: $courseid = &courseid_to_courseurl($courseid);
1.1166 raeburn 3208: my %roleshash = &dump('roles',$udom,$unam,$courseid);
1.817 raeburn 3209: foreach my $key (keys(%roleshash)) {
1.479 albertel 3210: next if ($key !~/^\Q$courseid\E(?:\/)*(\w+)*\_st$/);
1.298 matthew 3211: my $section=$1;
3212: if ($key eq $courseid.'_st') { $section=''; }
1.817 raeburn 3213: my ($dummy,$end,$start)=split(/\_/,&unescape($roleshash{$key}));
1.298 matthew 3214: my $now=time;
1.548 albertel 3215: if (defined($end) && $end && ($now > $end)) {
1.298 matthew 3216: $Expired{$end}=$section;
3217: next;
3218: }
1.548 albertel 3219: if (defined($start) && $start && ($now < $start)) {
1.298 matthew 3220: $Pending{$start}=$section;
3221: next;
3222: }
1.599 albertel 3223: return &do_cache_new('getsection',$hashid,$section,$cachetime);
1.298 matthew 3224: }
3225: #
3226: # Presumedly there will be few matching roles from the above
3227: # loop and the sorting time will be negligible.
3228: if (scalar(keys(%Pending))) {
3229: my ($time) = sort {$a <=> $b} keys(%Pending);
1.599 albertel 3230: return &do_cache_new('getsection',$hashid,$Pending{$time},$cachetime);
1.298 matthew 3231: }
3232: if (scalar(keys(%Expired))) {
3233: my @sorted = sort {$a <=> $b} keys(%Expired);
3234: my $time = pop(@sorted);
1.599 albertel 3235: return &do_cache_new('getsection',$hashid,$Expired{$time},$cachetime);
1.298 matthew 3236: }
1.599 albertel 3237: return &do_cache_new('getsection',$hashid,'-1',$cachetime);
1.298 matthew 3238: }
1.70 www 3239:
1.599 albertel 3240: sub save_cache {
3241: &purge_remembered();
1.722 albertel 3242: #&Apache::loncommon::validate_page();
1.620 albertel 3243: undef(%env);
1.780 albertel 3244: undef($env_loaded);
1.599 albertel 3245: }
1.452 albertel 3246:
1.599 albertel 3247: my $to_remember=-1;
3248: my %remembered;
3249: my %accessed;
3250: my $kicks=0;
3251: my $hits=0;
1.849 albertel 3252: sub make_key {
3253: my ($name,$id) = @_;
1.872 albertel 3254: if (length($id) > 65
3255: && length(&escape($id)) > 200) {
3256: $id=length($id).':'.&Digest::MD5::md5_hex($id);
3257: }
1.849 albertel 3258: return &escape($name.':'.$id);
3259: }
3260:
1.599 albertel 3261: sub devalidate_cache_new {
3262: my ($name,$id,$debug) = @_;
3263: if ($debug) { &Apache::lonnet::logthis("deleting $name:$id"); }
1.1319 damieng 3264: my $remembered_id=$name.':'.$id;
1.849 albertel 3265: $id=&make_key($name,$id);
1.599 albertel 3266: $memcache->delete($id);
1.1319 damieng 3267: delete($remembered{$remembered_id});
3268: delete($accessed{$remembered_id});
1.599 albertel 3269: }
3270:
3271: sub is_cached_new {
3272: my ($name,$id,$debug) = @_;
1.1319 damieng 3273: my $remembered_id=$name.':'.$id; # this is to avoid make_key (which is slow) whenever possible
3274: if (exists($remembered{$remembered_id})) {
3275: if ($debug) { &Apache::lonnet::logthis("Early return $remembered_id of $remembered{$remembered_id} "); }
3276: $accessed{$remembered_id}=[&gettimeofday()];
1.599 albertel 3277: $hits++;
1.1319 damieng 3278: return ($remembered{$remembered_id},1);
1.599 albertel 3279: }
1.1319 damieng 3280: $id=&make_key($name,$id);
1.599 albertel 3281: my $value = $memcache->get($id);
3282: if (!(defined($value))) {
3283: if ($debug) { &Apache::lonnet::logthis("getting $id is not defined"); }
1.417 albertel 3284: return (undef,undef);
1.416 albertel 3285: }
1.599 albertel 3286: if ($value eq '__undef__') {
3287: if ($debug) { &Apache::lonnet::logthis("getting $id is __undef__"); }
3288: $value=undef;
3289: }
1.1319 damieng 3290: &make_room($remembered_id,$value,$debug);
1.599 albertel 3291: if ($debug) { &Apache::lonnet::logthis("getting $id is $value"); }
3292: return ($value,1);
3293: }
3294:
3295: sub do_cache_new {
3296: my ($name,$id,$value,$time,$debug) = @_;
1.1319 damieng 3297: my $remembered_id=$name.':'.$id;
1.849 albertel 3298: $id=&make_key($name,$id);
1.599 albertel 3299: my $setvalue=$value;
3300: if (!defined($setvalue)) {
3301: $setvalue='__undef__';
3302: }
1.623 albertel 3303: if (!defined($time) ) {
3304: $time=600;
3305: }
1.599 albertel 3306: if ($debug) { &Apache::lonnet::logthis("Setting $id to $value"); }
1.910 albertel 3307: my $result = $memcache->set($id,$setvalue,$time);
3308: if (! $result) {
1.872 albertel 3309: &logthis("caching of id -> $id failed");
1.910 albertel 3310: $memcache->disconnect_all();
1.872 albertel 3311: }
1.600 albertel 3312: # need to make a copy of $value
1.1319 damieng 3313: &make_room($remembered_id,$value,$debug);
1.599 albertel 3314: return $value;
3315: }
3316:
3317: sub make_room {
1.1319 damieng 3318: my ($remembered_id,$value,$debug)=@_;
1.919 albertel 3319:
1.1319 damieng 3320: $remembered{$remembered_id}= (ref($value)) ? &Storable::dclone($value)
1.919 albertel 3321: : $value;
1.599 albertel 3322: if ($to_remember<0) { return; }
1.1319 damieng 3323: $accessed{$remembered_id}=[&gettimeofday()];
1.599 albertel 3324: if (scalar(keys(%remembered)) <= $to_remember) { return; }
3325: my $to_kick;
3326: my $max_time=0;
3327: foreach my $other (keys(%accessed)) {
3328: if (&tv_interval($accessed{$other}) > $max_time) {
3329: $to_kick=$other;
3330: $max_time=&tv_interval($accessed{$other});
3331: }
3332: }
3333: delete($remembered{$to_kick});
3334: delete($accessed{$to_kick});
3335: $kicks++;
3336: if ($debug) { &logthis("kicking $to_kick $max_time $kicks\n"); }
1.541 albertel 3337: return;
3338: }
3339:
1.599 albertel 3340: sub purge_remembered {
1.604 albertel 3341: #&logthis("Tossing ".scalar(keys(%remembered)));
3342: #&logthis(sprintf("%-20s is %s",'%remembered',length(&freeze(\%remembered))));
1.599 albertel 3343: undef(%remembered);
3344: undef(%accessed);
1.428 albertel 3345: }
1.70 www 3346: # ------------------------------------- Read an entry from a user's environment
3347:
3348: sub userenvironment {
3349: my ($udom,$unam,@what)=@_;
1.976 raeburn 3350: my $items;
3351: foreach my $item (@what) {
3352: $items.=&escape($item).'&';
3353: }
3354: $items=~s/\&$//;
1.70 www 3355: my %returnhash=();
1.1009 raeburn 3356: my $uhome = &homeserver($unam,$udom);
3357: unless ($uhome eq 'no_host') {
3358: my @answer=split(/\&/,
3359: &reply('get:'.$udom.':'.$unam.':environment:'.$items,$uhome));
1.1048 raeburn 3360: if ($#answer==0 && $answer[0] =~ /^(con_lost|error:|no_such_host)/i) {
3361: return %returnhash;
3362: }
1.1009 raeburn 3363: my $i;
3364: for ($i=0;$i<=$#what;$i++) {
3365: $returnhash{$what[$i]}=&unescape($answer[$i]);
3366: }
1.70 www 3367: }
3368: return %returnhash;
1.1 albertel 3369: }
3370:
1.617 albertel 3371: # ---------------------------------------------------------- Get a studentphoto
3372: sub studentphoto {
3373: my ($udom,$unam,$ext) = @_;
1.1494 raeburn 3374: my $home=&homeserver($unam,$udom);
1.706 raeburn 3375: if (defined($env{'request.course.id'})) {
1.708 raeburn 3376: if ($env{'course.'.$env{'request.course.id'}.'.internal.showphoto'}) {
1.706 raeburn 3377: if ($udom eq $env{'course.'.$env{'request.course.id'}.'.domain'}) {
3378: return(&retrievestudentphoto($udom,$unam,$ext));
3379: } else {
3380: my ($result,$perm_reqd)=
1.1494 raeburn 3381: &auto_photo_permission($unam,$udom);
1.706 raeburn 3382: if ($result eq 'ok') {
3383: if (!($perm_reqd eq 'yes')) {
3384: return(&retrievestudentphoto($udom,$unam,$ext));
3385: }
3386: }
3387: }
3388: }
3389: } else {
3390: my ($result,$perm_reqd) =
1.1494 raeburn 3391: &auto_photo_permission($unam,$udom);
1.706 raeburn 3392: if ($result eq 'ok') {
3393: if (!($perm_reqd eq 'yes')) {
3394: return(&retrievestudentphoto($udom,$unam,$ext));
3395: }
3396: }
3397: }
3398: return '/adm/lonKaputt/lonlogo_broken.gif';
3399: }
3400:
3401: sub retrievestudentphoto {
3402: my ($udom,$unam,$ext,$type) = @_;
1.1494 raeburn 3403: my $home=&homeserver($unam,$udom);
3404: my $ret=&reply("studentphoto:$udom:$unam:$ext:$type",$home);
1.706 raeburn 3405: if ($ret eq 'ok') {
3406: my $url="/uploaded/$udom/$unam/internal/studentphoto.$ext";
3407: if ($type eq 'thumbnail') {
3408: $url="/uploaded/$udom/$unam/internal/studentphoto_tn.$ext";
3409: }
1.1494 raeburn 3410: my $tokenurl=&tokenwrapper($url);
1.706 raeburn 3411: return $tokenurl;
3412: } else {
3413: if ($type eq 'thumbnail') {
3414: return '/adm/lonKaputt/genericstudent_tn.gif';
3415: } else {
3416: return '/adm/lonKaputt/lonlogo_broken.gif';
3417: }
1.617 albertel 3418: }
3419: }
3420:
1.263 www 3421: # -------------------------------------------------------------------- New chat
3422:
3423: sub chatsend {
1.724 raeburn 3424: my ($newentry,$anon,$group)=@_;
1.620 albertel 3425: my $cnum=$env{'course.'.$env{'request.course.id'}.'.num'};
3426: my $cdom=$env{'course.'.$env{'request.course.id'}.'.domain'};
3427: my $chome=$env{'course.'.$env{'request.course.id'}.'.home'};
1.263 www 3428: &reply('chatsend:'.$cdom.':'.$cnum.':'.
1.620 albertel 3429: &escape($env{'user.domain'}.':'.$env{'user.name'}.':'.$anon.':'.
1.724 raeburn 3430: &escape($newentry)).':'.$group,$chome);
1.292 www 3431: }
3432:
3433: # ------------------------------------------ Find current version of a resource
3434:
3435: sub getversion {
3436: my $fname=&clutter(shift);
1.1189 raeburn 3437: unless ($fname=~m{^(/adm/wrapper|)/res/}) { return -1; }
1.292 www 3438: return ¤tversion(&filelocation('',$fname));
3439: }
3440:
3441: sub currentversion {
3442: my $fname=shift;
3443: my $author=$fname;
3444: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
3445: my ($udom,$uname)=split(/\//,$author);
1.1112 www 3446: my $home=&homeserver($uname,$udom);
1.292 www 3447: if ($home eq 'no_host') {
3448: return -1;
3449: }
1.1112 www 3450: my $answer=&reply("currentversion:$fname",$home);
1.292 www 3451: if (($answer eq 'con_lost') || ($answer eq 'rejected')) {
3452: return -1;
3453: }
1.1112 www 3454: return $answer;
1.263 www 3455: }
3456:
1.1111 www 3457: #
3458: # Return special version number of resource if set by override, empty otherwise
3459: #
3460: sub usedversion {
3461: my $fname=shift;
3462: unless ($fname) { $fname=$env{'request.uri'}; }
3463: my ($urlversion)=($fname=~/\.(\d+)\.\w+$/);
3464: if ($urlversion) { return $urlversion; }
3465: return '';
3466: }
3467:
1.1 albertel 3468: # ----------------------------- Subscribe to a resource, return URL if possible
1.11 www 3469:
1.1 albertel 3470: sub subscribe {
3471: my $fname=shift;
1.761 raeburn 3472: if ($fname=~/\/(aboutme|syllabus|bulletinboard|smppg)$/) { return ''; }
1.532 albertel 3473: $fname=~s/[\n\r]//g;
1.1 albertel 3474: my $author=$fname;
3475: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
3476: my ($udom,$uname)=split(/\//,$author);
3477: my $home=homeserver($uname,$udom);
1.335 albertel 3478: if ($home eq 'no_host') {
3479: return 'not_found';
1.1 albertel 3480: }
3481: my $answer=reply("sub:$fname",$home);
1.64 www 3482: if (($answer eq 'con_lost') || ($answer eq 'rejected')) {
3483: $answer.=' by '.$home;
3484: }
1.1 albertel 3485: return $answer;
3486: }
3487:
1.8 www 3488: # -------------------------------------------------------------- Replicate file
3489:
3490: sub repcopy {
3491: my $filename=shift;
1.23 www 3492: $filename=~s/\/+/\//g;
1.1142 raeburn 3493: my $londocroot = $perlvar{'lonDocRoot'};
3494: if ($filename=~m{^\Q$londocroot/adm/\E}) { return 'ok'; }
1.1164 raeburn 3495: if ($filename=~m{^\Q/home/httpd/lonUsers/\E}) { return 'ok'; }
1.1142 raeburn 3496: if ($filename=~m{^\Q$londocroot/userfiles/\E} or
3497: $filename=~m{^/*(uploaded|editupload)/}) {
1.538 albertel 3498: return &repcopy_userfile($filename);
3499: }
1.532 albertel 3500: $filename=~s/[\n\r]//g;
1.8 www 3501: my $transname="$filename.in.transfer";
1.828 www 3502: # FIXME: this should flock
1.607 raeburn 3503: if ((-e $filename) || (-e $transname)) { return 'ok'; }
1.8 www 3504: my $remoteurl=subscribe($filename);
1.64 www 3505: if ($remoteurl =~ /^con_lost by/) {
3506: &logthis("Subscribe returned $remoteurl: $filename");
1.607 raeburn 3507: return 'unavailable';
1.8 www 3508: } elsif ($remoteurl eq 'not_found') {
1.441 albertel 3509: #&logthis("Subscribe returned not_found: $filename");
1.607 raeburn 3510: return 'not_found';
1.64 www 3511: } elsif ($remoteurl =~ /^rejected by/) {
3512: &logthis("Subscribe returned $remoteurl: $filename");
1.607 raeburn 3513: return 'forbidden';
1.20 www 3514: } elsif ($remoteurl eq 'directory') {
1.607 raeburn 3515: return 'ok';
1.8 www 3516: } else {
1.290 www 3517: my $author=$filename;
3518: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
3519: my ($udom,$uname)=split(/\//,$author);
3520: my $home=homeserver($uname,$udom);
3521: unless ($home eq $perlvar{'lonHostID'}) {
1.8 www 3522: my @parts=split(/\//,$filename);
3523: my $path="/$parts[1]/$parts[2]/$parts[3]/$parts[4]";
1.1142 raeburn 3524: if ($path ne "$londocroot/res") {
1.8 www 3525: &logthis("Malconfiguration for replication: $filename");
1.607 raeburn 3526: return 'bad_request';
1.8 www 3527: }
3528: my $count;
3529: for ($count=5;$count<$#parts;$count++) {
3530: $path.="/$parts[$count]";
3531: if ((-e $path)!=1) {
3532: mkdir($path,0777);
3533: }
3534: }
3535: my $request=new HTTP::Request('GET',"$remoteurl");
1.1345 raeburn 3536: my $response;
3537: if ($remoteurl =~ m{/raw/}) {
3538: $response=&LONCAPA::LWPReq::makerequest($home,$request,$transname,\%perlvar,'',0,1);
3539: } else {
3540: $response=&LONCAPA::LWPReq::makerequest($home,$request,$transname,\%perlvar,'',1);
3541: }
1.8 www 3542: if ($response->is_error()) {
3543: unlink($transname);
3544: my $message=$response->status_line;
1.672 albertel 3545: &logthis("<font color=\"blue\">WARNING:"
1.12 www 3546: ." LWP get: $message: $filename</font>");
1.607 raeburn 3547: return 'unavailable';
1.8 www 3548: } else {
1.16 www 3549: if ($remoteurl!~/\.meta$/) {
3550: my $mrequest=new HTTP::Request('GET',$remoteurl.'.meta');
1.1345 raeburn 3551: my $mresponse;
3552: if ($remoteurl =~ m{/raw/}) {
3553: $mresponse = &LONCAPA::LWPReq::makerequest($home,$mrequest,$filename.'.meta',\%perlvar,'',0,1);
3554: } else {
3555: $mresponse = &LONCAPA::LWPReq::makerequest($home,$mrequest,$filename.'.meta',\%perlvar,'',1);
3556: }
1.16 www 3557: if ($mresponse->is_error()) {
3558: unlink($filename.'.meta');
3559: &logthis(
1.672 albertel 3560: "<font color=\"yellow\">INFO: No metadata: $filename</font>");
1.16 www 3561: }
3562: }
1.8 www 3563: rename($transname,$filename);
1.607 raeburn 3564: return 'ok';
1.8 www 3565: }
1.290 www 3566: }
1.8 www 3567: }
1.330 www 3568: }
3569:
1.1422 raeburn 3570: # ------------------------------------------------- Unsubscribe from a resource
3571:
3572: sub unsubscribe {
3573: my ($fname) = @_;
3574: my $answer;
3575: if ($fname=~/\/(aboutme|syllabus|bulletinboard|smppg)$/) { return $answer; }
3576: $fname=~s/[\n\r]//g;
3577: my $author=$fname;
3578: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
3579: my ($udom,$uname)=split(/\//,$author);
3580: my $home=homeserver($uname,$udom);
3581: if ($home eq 'no_host') {
3582: $answer = 'no_host';
3583: } elsif (grep { $_ eq $home } ¤t_machine_ids()) {
3584: $answer = 'home';
3585: } else {
3586: my $defdom = $perlvar{'lonDefDomain'};
3587: if (&will_trust('content',$defdom,$udom)) {
3588: $answer = reply("unsub:$fname",$home);
3589: } else {
3590: $answer = 'untrusted';
3591: }
3592: }
3593: return $answer;
3594: }
3595:
1.330 www 3596: # ------------------------------------------------ Get server side include body
3597: sub ssi_body {
1.381 albertel 3598: my ($filelink,%form)=@_;
1.606 matthew 3599: if (! exists($form{'LONCAPA_INTERNAL_no_discussion'})) {
3600: $form{'LONCAPA_INTERNAL_no_discussion'}='true';
3601: }
1.953 www 3602: my $output='';
3603: my $response;
1.980 raeburn 3604: if ($filelink=~/^https?\:/) {
1.954 raeburn 3605: ($output,$response)=&externalssi($filelink);
1.953 www 3606: } else {
1.1004 droeschl 3607: $filelink .= $filelink=~/\?/ ? '&' : '?';
3608: $filelink .= 'inhibitmenu=yes';
1.953 www 3609: ($output,$response)=&ssi($filelink,%form);
3610: }
1.778 albertel 3611: $output=~s|//(\s*<!--)? BEGIN LON-CAPA Internal.+?// END LON-CAPA Internal\s*(-->)?\s||gs;
1.451 albertel 3612: $output=~s/^.*?\<body[^\>]*\>//si;
1.930 albertel 3613: $output=~s/\<\/body\s*\>.*?$//si;
1.953 www 3614: if (wantarray) {
3615: return ($output, $response);
3616: } else {
3617: return $output;
3618: }
1.8 www 3619: }
3620:
1.15 www 3621: # --------------------------------------------------------- Server Side Include
3622:
1.782 albertel 3623: sub absolute_url {
1.1447 raeburn 3624: my ($host_name,$unalias,$keep_proto) = @_;
1.782 albertel 3625: my $protocol = ($ENV{'SERVER_PORT'} == 443?'https://':'http://');
3626: if ($host_name eq '') {
3627: $host_name = $ENV{'SERVER_NAME'};
3628: }
1.1447 raeburn 3629: if ($unalias) {
3630: my $alias = &get_proxy_alias();
3631: if ($alias eq $host_name) {
3632: my $lonhost = $perlvar{'lonHostID'};
3633: my $hostname = &hostname($lonhost);
3634: my $lcproto;
3635: if (($keep_proto) || ($hostname eq '')) {
3636: $lcproto = $protocol;
3637: } else {
3638: $lcproto = $protocol{$lonhost};
3639: $lcproto = 'http' if ($lcproto ne 'https');
3640: $lcproto .= '://';
3641: }
3642: unless ($hostname eq '') {
3643: return $lcproto.$hostname;
3644: }
3645: }
3646: }
1.782 albertel 3647: return $protocol.$host_name;
3648: }
3649:
1.942 foxr 3650: #
3651: # Server side include.
3652: # Parameters:
3653: # fn Possibly encrypted resource name/id.
3654: # form Hash that describes how the rendering should be done
3655: # and other things.
1.944 foxr 3656: # Returns:
1.950 raeburn 3657: # Scalar context: The content of the response.
3658: # Array context: 2 element list of the content and the full response object.
1.942 foxr 3659: #
1.15 www 3660: sub ssi {
3661:
1.944 foxr 3662: my ($fn,%form)=@_;
1.1447 raeburn 3663: my ($host,$request,$response);
3664: $host = &absolute_url('',1);
1.711 albertel 3665:
3666: $form{'no_update_last_known'}=1;
1.895 albertel 3667: &Apache::lonenc::check_encrypt(\$fn);
1.23 www 3668: if (%form) {
1.1447 raeburn 3669: $request=new HTTP::Request('POST',$host.$fn);
1.1272 droeschl 3670: $request->content(join('&',map {
3671: my $name = escape($_);
3672: "$name=" . ( ref($form{$_}) eq 'ARRAY'
3673: ? join("&$name=", map {escape($_) } @{$form{$_}})
3674: : &escape($form{$_}) );
3675: } keys(%form)));
1.23 www 3676: } else {
1.1447 raeburn 3677: $request=new HTTP::Request('GET',$host.$fn);
1.23 www 3678: }
3679:
1.15 www 3680: $request->header(Cookie => $ENV{'HTTP_COOKIE'});
1.1345 raeburn 3681: my $lonhost = $perlvar{'lonHostID'};
1.1385 raeburn 3682: my $islocal;
3683: if (($env{'request.course.id'}) &&
3684: ($form{'grade_courseid'} eq $env{'request.course.id'}) &&
3685: ($form{'grade_username'} ne '') && ($form{'grade_domain'} ne '') &&
3686: ($form{'grade_symb'} ne '') &&
1.1494 raeburn 3687: (&allowed('mgr',$env{'request.course.id'}.
3688: ($env{'request.course.sec'}?'/'.$env{'request.course.sec'}:'')))) {
1.1385 raeburn 3689: $islocal = 1;
3690: }
1.1447 raeburn 3691: $response= &LONCAPA::LWPReq::makerequest($lonhost,$request,'',\%perlvar,
3692: '','','',$islocal);
1.1182 foxr 3693:
1.944 foxr 3694: if (wantarray) {
1.1345 raeburn 3695: return ($response->content, $response);
1.944 foxr 3696: } else {
1.1345 raeburn 3697: return $response->content;
1.942 foxr 3698: }
1.324 www 3699: }
3700:
3701: sub externalssi {
3702: my ($url)=@_;
3703: my $request=new HTTP::Request('GET',$url);
1.1345 raeburn 3704: my $response = &LONCAPA::LWPReq::makerequest('',$request,'',\%perlvar);
1.954 raeburn 3705: if (wantarray) {
3706: return ($response->content, $response);
3707: } else {
3708: return $response->content;
3709: }
1.15 www 3710: }
1.254 www 3711:
1.1354 raeburn 3712:
3713: # If the local copy of a replicated resource is outdated, trigger a
3714: # connection from the homeserver to flush the delayed queue. If no update
3715: # happens, remove local copies of outdated resource (and corresponding
3716: # metadata file).
3717:
1.1352 raeburn 3718: sub remove_stale_resfile {
3719: my ($url) = @_;
1.1354 raeburn 3720: my $removed;
1.1352 raeburn 3721: if ($url=~m{^/res/($match_domain)/($match_username)/}) {
3722: my $audom = $1;
3723: my $auname = $2;
1.1353 raeburn 3724: unless (($url =~ /\.\d+\.\w+$/) || ($url =~ m{^/res/lib/templates/})) {
1.1352 raeburn 3725: my $homeserver = &homeserver($auname,$audom);
3726: unless (($homeserver eq 'no_host') ||
3727: (grep { $_ eq $homeserver } ¤t_machine_ids())) {
3728: my $fname = &filelocation('',$url);
3729: if (-e $fname) {
3730: my $hostname = &hostname($homeserver);
3731: if ($hostname) {
1.1397 raeburn 3732: my $protocol = $protocol{$homeserver};
3733: $protocol = 'http' if ($protocol ne 'https');
1.1352 raeburn 3734: my $uri = &declutter($url);
3735: my $request=new HTTP::Request('HEAD',$protocol.'://'.$hostname.'/raw/'.$uri);
3736: my $response = &LONCAPA::LWPReq::makerequest($homeserver,$request,'',\%perlvar,5,0,1);
3737: if ($response->is_success()) {
3738: my $remmodtime = &HTTP::Date::str2time( $response->header('Last-modified') );
3739: my $locmodtime = (stat($fname))[9];
3740: if ($locmodtime < $remmodtime) {
1.1354 raeburn 3741: my $stale;
3742: my $answer = &reply('pong',$homeserver);
3743: if ($answer eq $homeserver.':'.$perlvar{'lonHostID'}) {
3744: sleep(0.2);
3745: $locmodtime = (stat($fname))[9];
3746: if ($locmodtime < $remmodtime) {
3747: my $posstransfer = $fname.'.in.transfer';
3748: if ((-e $posstransfer) && ($remmodtime < (stat($posstransfer))[9])) {
3749: $removed = 1;
3750: } else {
3751: $stale = 1;
3752: }
3753: } else {
3754: $removed = 1;
3755: }
3756: } else {
3757: $stale = 1;
3758: }
3759: if ($stale) {
1.1421 raeburn 3760: if (unlink($fname)) {
3761: if ($uri!~/\.meta$/) {
3762: if (-e $fname.'.meta') {
3763: unlink($fname.'.meta');
3764: }
3765: }
1.1422 raeburn 3766: my $unsubresult = &unsubscribe($fname);
3767: unless ($unsubresult eq 'ok') {
3768: &logthis("no unsub of $fname from $homeserver, reason: $unsubresult");
3769: }
1.1421 raeburn 3770: $removed = 1;
1.1354 raeburn 3771: }
1.1352 raeburn 3772: }
3773: }
3774: }
3775: }
3776: }
3777: }
3778: }
3779: }
1.1354 raeburn 3780: return $removed;
1.1352 raeburn 3781: }
3782:
1.492 albertel 3783: # -------------------------------- Allow a /uploaded/ URI to be vouched for
3784:
3785: sub allowuploaded {
3786: my ($srcurl,$url)=@_;
3787: $url=&clutter(&declutter($url));
3788: my $dir=$url;
3789: $dir=~s/\/[^\/]+$//;
3790: my %httpref=();
3791: my $httpurl=&hreflocation('',$url);
3792: $httpref{'httpref.'.$httpurl}=$srcurl;
1.949 raeburn 3793: &Apache::lonnet::appenv(\%httpref);
1.254 www 3794: }
1.477 raeburn 3795:
1.1193 raeburn 3796: #
3797: # Determine if the current user should be able to edit a particular resource,
3798: # when viewing in course context.
3799: # (a) When viewing resource used to determine if "Edit" item is included in
3800: # Functions.
3801: # (b) When displaying folder contents in course editor, used to determine if
3802: # "Edit" link will be displayed alongside resource.
3803: #
1.1196 raeburn 3804: # input: six args -- filename (decluttered), course number, course domain,
3805: # url, symb (if registered) and group (if this is a group
3806: # item -- e.g., bulletin board, group page etc.).
3807: # output: array of five scalars --
1.1193 raeburn 3808: # $cfile -- url for file editing if editable on current server
3809: # $home -- homeserver of resource (i.e., for author if published,
3810: # or course if uploaded.).
3811: # $switchserver -- 1 if server switch will be needed.
1.1196 raeburn 3812: # $forceedit -- 1 if icon/link should be to go to edit mode
3813: # $forceview -- 1 if icon/link should be to go to view mode
1.1193 raeburn 3814: #
3815:
3816: sub can_edit_resource {
1.1194 raeburn 3817: my ($file,$cnum,$cdom,$resurl,$symb,$group) = @_;
3818: my ($cfile,$home,$switchserver,$forceedit,$forceview,$uploaded,$incourse);
3819: #
3820: # For aboutme pages user can only edit his/her own.
3821: #
1.1199 raeburn 3822: if ($resurl =~ m{^/?adm/($match_domain)/($match_username)/aboutme$}) {
1.1194 raeburn 3823: my ($sdom,$sname) = ($1,$2);
3824: if (($sdom eq $env{'user.domain'}) && ($sname eq $env{'user.name'})) {
3825: $home = $env{'user.home'};
3826: $cfile = $resurl;
3827: if ($env{'form.forceedit'}) {
3828: $forceview = 1;
3829: } else {
3830: $forceedit = 1;
3831: }
3832: return ($cfile,$home,$switchserver,$forceedit,$forceview);
3833: } else {
3834: return;
3835: }
3836: }
3837:
3838: if ($env{'request.course.id'}) {
1.1494 raeburn 3839: my $crsedit = &allowed('mdc',$env{'request.course.id'});
1.1194 raeburn 3840: if ($group ne '') {
3841: # if this is a group homepage or group bulletin board, check group privs
3842: my $allowed = 0;
1.1197 raeburn 3843: if ($resurl =~ m{^/?adm/$cdom/$cnum/$group/smppg$}) {
3844: if ((&allowed('mdg',$env{'request.course.id'}.
1.1198 raeburn 3845: ($env{'request.course.sec'}?'/'.$env{'request.course.sec'}:''))) ||
1.1194 raeburn 3846: (&allowed('mgh',$env{'request.course.id'}.'/'.$group)) || $crsedit) {
3847: $allowed = 1;
3848: }
1.1197 raeburn 3849: } elsif ($resurl =~ m{^/?adm/$cdom/$cnum/\d+/bulletinboard$}) {
3850: if ((&allowed('mdg',$env{'request.course.id'}.($env{'request.course.sec'}?'/'.$env{'request.course.sec'}:''))) ||
3851: (&allowed('cgb',$env{'request.course.id'}.'/'.$group)) || $crsedit) {
1.1194 raeburn 3852: $allowed = 1;
3853: }
3854: }
3855: if ($allowed) {
3856: $home=&homeserver($cnum,$cdom);
3857: if ($env{'form.forceedit'}) {
3858: $forceview = 1;
3859: } else {
3860: $forceedit = 1;
3861: }
3862: $cfile = $resurl;
3863: } else {
3864: return;
3865: }
3866: } else {
1.1208 raeburn 3867: if ($resurl =~ m{^/?adm/viewclasslist$}) {
1.1494 raeburn 3868: unless (&allowed('opa',$env{'request.course.id'})) {
1.1208 raeburn 3869: return;
3870: }
3871: } elsif (!$crsedit) {
1.1194 raeburn 3872: #
3873: # No edit allowed where CC has switched to student role.
3874: #
3875: return;
3876: }
3877: }
3878: }
3879:
1.1193 raeburn 3880: if ($file ne '') {
3881: if (($cnum =~ /$match_courseid/) && ($cdom =~ /$match_domain/)) {
1.1194 raeburn 3882: if (&is_course_upload($file,$cnum,$cdom)) {
3883: $uploaded = 1;
3884: $incourse = 1;
1.1193 raeburn 3885: if ($file =~/\.(htm|html|css|js|txt)$/) {
3886: $cfile = &hreflocation('',$file);
1.1201 raeburn 3887: if ($env{'form.forceedit'}) {
3888: $forceview = 1;
3889: } else {
3890: $forceedit = 1;
3891: }
1.1194 raeburn 3892: }
3893: } elsif ($resurl =~ m{^/public/$cdom/$cnum/syllabus}) {
3894: $incourse = 1;
3895: if ($env{'form.forceedit'}) {
3896: $forceview = 1;
3897: } else {
3898: $forceedit = 1;
3899: }
3900: $cfile = $resurl;
3901: } elsif (($resurl ne '') && (&is_on_map($resurl))) {
3902: if ($resurl =~ m{^/adm/$match_domain/$match_username/\d+/smppg|bulletinboard$}) {
3903: $incourse = 1;
3904: if ($env{'form.forceedit'}) {
3905: $forceview = 1;
3906: } else {
3907: $forceedit = 1;
3908: }
3909: $cfile = $resurl;
1.1199 raeburn 3910: } elsif ($resurl eq '/res/lib/templates/simpleproblem.problem') {
1.1194 raeburn 3911: $incourse = 1;
3912: $cfile = $resurl.'/smpedit';
1.1199 raeburn 3913: } elsif ($resurl =~ m{^/adm/wrapper/ext/}) {
1.1194 raeburn 3914: $incourse = 1;
1.1199 raeburn 3915: if ($env{'form.forceedit'}) {
3916: $forceview = 1;
3917: } else {
3918: $forceedit = 1;
3919: }
3920: $cfile = $resurl;
1.1419 raeburn 3921: } elsif (($resurl =~ m{^/ext/}) && ($symb ne '')) {
3922: my ($map,$id,$res) = &decode_symb($symb);
3923: if ($map =~ /\.page$/) {
3924: $incourse = 1;
3925: if ($env{'form.forceedit'}) {
3926: $forceview = 1;
3927: $cfile = $map;
3928: } else {
3929: $forceedit = 1;
3930: $cfile = '/adm/wrapper'.$resurl;
3931: }
3932: }
1.1343 raeburn 3933: } elsif ($resurl =~ m{^/adm/wrapper/adm/$cdom/$cnum/\d+/ext\.tool$}) {
1.1298 raeburn 3934: $incourse = 1;
3935: if ($env{'form.forceedit'}) {
3936: $forceview = 1;
3937: } else {
3938: $forceedit = 1;
3939: }
3940: $cfile = $resurl;
1.1208 raeburn 3941: } elsif ($resurl =~ m{^/?adm/viewclasslist$}) {
3942: $incourse = 1;
3943: if ($env{'form.forceedit'}) {
3944: $forceview = 1;
3945: } else {
3946: $forceedit = 1;
3947: }
3948: $cfile = ($resurl =~ m{^/} ? $resurl : "/$resurl");
1.1194 raeburn 3949: }
3950: } elsif ($resurl eq '/res/lib/templates/simpleproblem.problem/smpedit') {
3951: my $template = '/res/lib/templates/simpleproblem.problem';
3952: if (&is_on_map($template)) {
3953: $incourse = 1;
3954: $forceview = 1;
3955: $cfile = $template;
1.1193 raeburn 3956: }
1.1199 raeburn 3957: } elsif (($resurl =~ m{^/adm/wrapper/ext/}) && ($env{'form.folderpath'} =~ /^supplemental/)) {
1.1418 raeburn 3958: $incourse = 1;
3959: if ($env{'form.forceedit'}) {
3960: $forceview = 1;
3961: } else {
3962: $forceedit = 1;
3963: }
3964: $cfile = $resurl;
1.1343 raeburn 3965: } elsif (($resurl =~ m{^/adm/wrapper/adm/$cdom/$cnum/\d+/ext\.tool$}) && ($env{'form.folderpath'} =~ /^supplemental/)) {
1.1298 raeburn 3966: $incourse = 1;
3967: if ($env{'form.forceedit'}) {
3968: $forceview = 1;
3969: } else {
3970: $forceedit = 1;
3971: }
3972: $cfile = $resurl;
1.1199 raeburn 3973: } elsif (($resurl eq '/adm/extresedit') && ($symb || $env{'form.folderpath'})) {
3974: $incourse = 1;
3975: $forceview = 1;
3976: if ($symb) {
3977: my ($map,$id,$res)=&decode_symb($symb);
3978: $env{'request.symb'} = $symb;
3979: $cfile = &clutter($res);
3980: } else {
3981: $cfile = $env{'form.suppurl'};
1.1298 raeburn 3982: my $escfile = &unescape($cfile);
1.1343 raeburn 3983: if ($escfile =~ m{^/adm/$cdom/$cnum/\d+/ext\.tool$}) {
1.1298 raeburn 3984: $cfile = '/adm/wrapper'.$escfile;
3985: } else {
3986: $escfile =~ s{^http://}{};
3987: $cfile = &escape("/adm/wrapper/ext/$escfile");
3988: }
1.1199 raeburn 3989: }
1.1234 raeburn 3990: } elsif ($resurl =~ m{^/?adm/viewclasslist$}) {
3991: if ($env{'form.forceedit'}) {
3992: $forceview = 1;
3993: } else {
3994: $forceedit = 1;
3995: }
3996: $cfile = ($resurl =~ m{^/} ? $resurl : "/$resurl");
1.1193 raeburn 3997: }
3998: }
1.1194 raeburn 3999: if ($uploaded || $incourse) {
4000: $home=&homeserver($cnum,$cdom);
1.1207 raeburn 4001: } elsif ($file !~ m{/$}) {
1.1193 raeburn 4002: $file=~s{^(priv/$match_domain/$match_username)}{/$1};
4003: $file=~s{^($match_domain/$match_username)}{/priv/$1};
4004: # Check that the user has permission to edit this resource
4005: my $setpriv = 1;
4006: my ($cfuname,$cfudom)=&constructaccess($file,$setpriv);
4007: if (defined($cfudom)) {
4008: $home=&homeserver($cfuname,$cfudom);
4009: $cfile=$file;
4010: }
4011: }
1.1194 raeburn 4012: if (($cfile ne '') && (!$incourse || $uploaded) &&
4013: (($home ne '') && ($home ne 'no_host'))) {
1.1193 raeburn 4014: my @ids=¤t_machine_ids();
4015: unless (grep(/^\Q$home\E$/,@ids)) {
4016: $switchserver=1;
4017: }
4018: }
4019: }
1.1194 raeburn 4020: return ($cfile,$home,$switchserver,$forceedit,$forceview);
1.1193 raeburn 4021: }
4022:
4023: sub is_course_upload {
4024: my ($file,$cnum,$cdom) = @_;
4025: my $uploadpath = &LONCAPA::propath($cdom,$cnum);
4026: $uploadpath =~ s{^\/}{};
1.1201 raeburn 4027: if (($file =~ m{^\Q$uploadpath\E/userfiles/(docs|supplemental)/}) ||
4028: ($file =~ m{^userfiles/\Q$cdom\E/\Q$cnum\E/(docs|supplemental)/})) {
1.1193 raeburn 4029: return 1;
4030: }
4031: return;
4032: }
4033:
1.1194 raeburn 4034: sub in_course {
1.1195 raeburn 4035: my ($udom,$uname,$cdom,$cnum,$type,$hideprivileged) = @_;
4036: if ($hideprivileged) {
4037: my $skipuser;
1.1219 raeburn 4038: my %coursehash = &coursedescription($cdom.'_'.$cnum);
4039: my @possdoms = ($cdom);
4040: if ($coursehash{'checkforpriv'}) {
4041: push(@possdoms,split(/,/,$coursehash{'checkforpriv'}));
4042: }
4043: if (&privileged($uname,$udom,\@possdoms)) {
1.1195 raeburn 4044: $skipuser = 1;
4045: if ($coursehash{'nothideprivileged'}) {
4046: foreach my $item (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
4047: my $user;
4048: if ($item =~ /:/) {
4049: $user = $item;
4050: } else {
4051: $user = join(':',split(/[\@]/,$item));
4052: }
4053: if ($user eq $uname.':'.$udom) {
4054: undef($skipuser);
4055: last;
4056: }
4057: }
4058: }
4059: if ($skipuser) {
4060: return 0;
4061: }
4062: }
4063: }
1.1194 raeburn 4064: $type ||= 'any';
4065: if (!defined($cdom) || !defined($cnum)) {
4066: my $cid = $env{'request.course.id'};
4067: $cdom = $env{'course.'.$cid.'.domain'};
4068: $cnum = $env{'course.'.$cid.'.num'};
4069: }
4070: my $typesref;
1.1195 raeburn 4071: if (($type eq 'any') || ($type eq 'all')) {
1.1194 raeburn 4072: $typesref = ['active','previous','future'];
4073: } elsif ($type eq 'previous' || $type eq 'future') {
4074: $typesref = [$type];
4075: }
4076: my %roles = &get_my_roles($uname,$udom,'userroles',
4077: $typesref,undef,[$cdom]);
4078: my ($tmp) = keys(%roles);
4079: return 0 if ($tmp =~ /^(con_lost|error|no_such_host)/i);
4080: my @course_roles = grep(/^\Q$cnum\E:\Q$cdom\E:/, keys(%roles));
4081: if (@course_roles > 0) {
4082: return 1;
4083: }
4084: return 0;
4085: }
4086:
1.478 albertel 4087: # --------- File operations in /home/httpd/html/userfiles/$domain/1/2/3/$course
1.638 albertel 4088: # input: action, courseID, current domain, intended
1.637 raeburn 4089: # path to file, source of file, instruction to parse file for objects,
4090: # ref to hash for embedded objects,
4091: # ref to hash for codebase of java objects.
1.1095 raeburn 4092: # reference to scalar to accommodate mime type determined
4093: # from File::MMagic if $parser = parse.
1.637 raeburn 4094: #
1.485 raeburn 4095: # output: url to file (if action was uploaddoc),
4096: # ok if successful, or diagnostic message otherwise (if action was propagate or copy)
1.477 raeburn 4097: #
1.478 albertel 4098: # Allows directory structure to be used within lonUsers/../userfiles/ for a
4099: # course.
1.477 raeburn 4100: #
1.478 albertel 4101: # action = propagate - /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
4102: # will be copied to /home/httpd/lonUsers/1/2/3/$course/userfiles in
4103: # course's home server.
1.477 raeburn 4104: #
1.478 albertel 4105: # action = copy - /home/httpd/html/userfiles/$domain/1/2/3/$course/$file will
4106: # be copied from $source (current location) to
4107: # /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
4108: # and will then be copied to
4109: # /home/httpd/lonUsers/$domain/1/2/3/$course/userfiles/$file in
4110: # course's home server.
1.485 raeburn 4111: #
1.481 raeburn 4112: # action = uploaddoc - /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
1.620 albertel 4113: # will be retrived from $env{form.uploaddoc} (from DOCS interface) to
1.481 raeburn 4114: # /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
4115: # and will then be copied to /home/httpd/lonUsers/1/2/3/$course/userfiles/$file
4116: # in course's home server.
1.637 raeburn 4117: #
1.477 raeburn 4118:
4119: sub process_coursefile {
1.1095 raeburn 4120: my ($action,$docuname,$docudom,$file,$source,$parser,$allfiles,$codebase,
4121: $mimetype)=@_;
1.477 raeburn 4122: my $fetchresult;
1.638 albertel 4123: my $home=&homeserver($docuname,$docudom);
1.477 raeburn 4124: if ($action eq 'propagate') {
1.638 albertel 4125: $fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
4126: $home);
1.481 raeburn 4127: } else {
1.477 raeburn 4128: my $fpath = '';
4129: my $fname = $file;
1.478 albertel 4130: ($fpath,$fname) = ($file =~ m|^(.*)/([^/]+)$|);
1.477 raeburn 4131: $fpath=$docudom.'/'.$docuname.'/'.$fpath;
1.637 raeburn 4132: my $filepath = &build_filepath($fpath);
1.481 raeburn 4133: if ($action eq 'copy') {
4134: if ($source eq '') {
4135: $fetchresult = 'no source file';
4136: return $fetchresult;
4137: } else {
4138: my $destination = $filepath.'/'.$fname;
4139: rename($source,$destination);
4140: $fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
1.638 albertel 4141: $home);
1.481 raeburn 4142: }
4143: } elsif ($action eq 'uploaddoc') {
1.1359 raeburn 4144: open(my $fh,'>',$filepath.'/'.$fname);
1.620 albertel 4145: print $fh $env{'form.'.$source};
1.481 raeburn 4146: close($fh);
1.637 raeburn 4147: if ($parser eq 'parse') {
1.1024 raeburn 4148: my $mm = new File::MMagic;
1.1095 raeburn 4149: my $type = $mm->checktype_filename($filepath.'/'.$fname);
4150: if ($type eq 'text/html') {
1.1024 raeburn 4151: my $parse_result = &extract_embedded_items($filepath.'/'.$fname,$allfiles,$codebase);
4152: unless ($parse_result eq 'ok') {
4153: &logthis('Failed to parse '.$filepath.'/'.$fname.' for embedded media: '.$parse_result);
4154: }
1.637 raeburn 4155: }
1.1095 raeburn 4156: if (ref($mimetype)) {
4157: $$mimetype = $type;
4158: }
1.637 raeburn 4159: }
1.477 raeburn 4160: $fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
1.638 albertel 4161: $home);
1.481 raeburn 4162: if ($fetchresult eq 'ok') {
4163: return '/uploaded/'.$fpath.'/'.$fname;
4164: } else {
4165: &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$file.
1.638 albertel 4166: ' to host '.$home.': '.$fetchresult);
1.481 raeburn 4167: return '/adm/notfound.html';
4168: }
1.477 raeburn 4169: }
4170: }
1.485 raeburn 4171: unless ( $fetchresult eq 'ok') {
1.477 raeburn 4172: &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$file.
1.638 albertel 4173: ' to host '.$home.': '.$fetchresult);
1.477 raeburn 4174: }
4175: return $fetchresult;
4176: }
4177:
1.637 raeburn 4178: sub build_filepath {
4179: my ($fpath) = @_;
4180: my $filepath=$perlvar{'lonDocRoot'}.'/userfiles';
4181: unless ($fpath eq '') {
4182: my @parts=split('/',$fpath);
4183: foreach my $part (@parts) {
4184: $filepath.= '/'.$part;
4185: if ((-e $filepath)!=1) {
4186: mkdir($filepath,0777);
4187: }
4188: }
4189: }
4190: return $filepath;
4191: }
4192:
4193: sub store_edited_file {
1.638 albertel 4194: my ($primary_url,$content,$docudom,$docuname,$fetchresult) = @_;
1.637 raeburn 4195: my $file = $primary_url;
4196: $file =~ s#^/uploaded/$docudom/$docuname/##;
4197: my $fpath = '';
4198: my $fname = $file;
4199: ($fpath,$fname) = ($file =~ m|^(.*)/([^/]+)$|);
4200: $fpath=$docudom.'/'.$docuname.'/'.$fpath;
4201: my $filepath = &build_filepath($fpath);
1.1359 raeburn 4202: open(my $fh,'>',$filepath.'/'.$fname);
1.637 raeburn 4203: print $fh $content;
4204: close($fh);
1.638 albertel 4205: my $home=&homeserver($docuname,$docudom);
1.637 raeburn 4206: $$fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
1.638 albertel 4207: $home);
1.637 raeburn 4208: if ($$fetchresult eq 'ok') {
4209: return '/uploaded/'.$fpath.'/'.$fname;
4210: } else {
1.638 albertel 4211: &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$file.
4212: ' to host '.$home.': '.$$fetchresult);
1.637 raeburn 4213: return '/adm/notfound.html';
4214: }
4215: }
4216:
1.531 albertel 4217: sub clean_filename {
1.831 albertel 4218: my ($fname,$args)=@_;
1.315 www 4219: # Replace Windows backslashes by forward slashes
1.257 www 4220: $fname=~s/\\/\//g;
1.831 albertel 4221: if (!$args->{'keep_path'}) {
4222: # Get rid of everything but the actual filename
4223: $fname=~s/^.*\/([^\/]+)$/$1/;
4224: }
1.315 www 4225: # Replace spaces by underscores
4226: $fname=~s/\s+/\_/g;
1.1406 raeburn 4227: # Transliterate non-ascii text to ascii
4228: my $lang = &Apache::lonlocal::current_language();
4229: $fname = &LONCAPA::transliterate::fname_to_ascii($fname,$lang);
1.315 www 4230: # Replace all other weird characters by nothing
1.831 albertel 4231: $fname=~s{[^/\w\.\-]}{}g;
1.540 albertel 4232: # Replace all .\d. sequences with _\d. so they no longer look like version
4233: # numbers
4234: $fname=~s/\.(\d+)(?=\.)/_$1/g;
1.1443 raeburn 4235: # Replace three or more adjacent underscores with one for consistency
4236: # with loncfile::filename_check() so complete url can be extracted by
4237: # lonnet::decode_symb()
4238: $fname=~s/_{3,}/_/g;
1.531 albertel 4239: return $fname;
4240: }
1.1406 raeburn 4241:
1.1051 raeburn 4242: # This Function checks if an Image's dimensions exceed either $resizewidth (width)
4243: # or $resizeheight (height) - both pixels. If so, the image is scaled to produce an
4244: # image with the same aspect ratio as the original, but with dimensions which do
4245: # not exceed $resizewidth and $resizeheight.
4246:
1.984 neumanie 4247: sub resizeImage {
1.1051 raeburn 4248: my ($img_path,$resizewidth,$resizeheight) = @_;
4249: my $ima = Image::Magick->new;
4250: my $resized;
4251: if (-e $img_path) {
4252: $ima->Read($img_path);
4253: if (($resizewidth =~ /^\d+$/) && ($resizeheight > 0)) {
4254: my $width = $ima->Get('width');
4255: my $height = $ima->Get('height');
4256: if ($width > $resizewidth) {
4257: my $factor = $width/$resizewidth;
4258: my $newheight = $height/$factor;
4259: $ima->Scale(width=>$resizewidth,height=>$newheight);
4260: $resized = 1;
4261: }
4262: }
4263: if (($resizeheight =~ /^\d+$/) && ($resizeheight > 0)) {
4264: my $width = $ima->Get('width');
4265: my $height = $ima->Get('height');
4266: if ($height > $resizeheight) {
4267: my $factor = $height/$resizeheight;
4268: my $newwidth = $width/$factor;
4269: $ima->Scale(width=>$newwidth,height=>$resizeheight);
4270: $resized = 1;
4271: }
4272: }
4273: if ($resized) {
4274: $ima->Write($img_path);
4275: }
4276: }
4277: return;
1.977 amueller 4278: }
4279:
1.608 albertel 4280: # --------------- Take an uploaded file and put it into the userfiles directory
1.686 albertel 4281: # input: $formname - the contents of the file are in $env{"form.$formname"}
1.1093 raeburn 4282: # the desired filename is in $env{"form.$formname.filename"}
1.1090 raeburn 4283: # $context - possible values: coursedoc, existingfile, overwrite,
1.1504 ! raeburn 4284: # canceloverwrite, scantron, toollogo or ''.
1.1090 raeburn 4285: # if 'coursedoc': upload to the current course
4286: # if 'existingfile': write file to tmp/overwrites directory
4287: # if 'canceloverwrite': delete file written to tmp/overwrites directory
4288: # $context is passed as argument to &finishuserfileupload
1.686 albertel 4289: # $subdir - directory in userfile to store the file into
1.1401 raeburn 4290: # $parser - instruction to parse file for objects ($parser = parse) or
4291: # if context is 'scantron', $parser is hashref of csv column mapping
4292: # (e.g.,{ PaperID => 0, LastName => 1, FirstName => 2, ID => 3,
4293: # Section => 4, CODE => 5, FirstQuestion => 9 }).
1.858 raeburn 4294: # $allfiles - reference to hash for embedded objects
4295: # $codebase - reference to hash for codebase of java objects
1.1504 ! raeburn 4296: # $destuname - username for permanent storage of uploaded file
! 4297: # $destudom - domain for permanaent storage of uploaded file
1.860 raeburn 4298: # $thumbwidth - width (pixels) of thumbnail to make for uploaded image
4299: # $thumbheight - height (pixels) of thumbnail to make for uploaded image
1.1051 raeburn 4300: # $resizewidth - width (pixels) to which to resize uploaded image
4301: # $resizeheight - height (pixels) to which to resize uploaded image
1.1095 raeburn 4302: # $mimetype - reference to scalar to accommodate mime type determined
1.1152 raeburn 4303: # from File::MMagic.
1.858 raeburn 4304: #
1.686 albertel 4305: # output: url of file in userspace, or error: <message>
4306: # or /adm/notfound.html if failure to upload occurse
1.608 albertel 4307:
1.531 albertel 4308: sub userfileupload {
1.1090 raeburn 4309: my ($formname,$context,$subdir,$parser,$allfiles,$codebase,$destuname,
1.1095 raeburn 4310: $destudom,$thumbwidth,$thumbheight,$resizewidth,$resizeheight,$mimetype)=@_;
1.531 albertel 4311: if (!defined($subdir)) { $subdir='unknown'; }
1.620 albertel 4312: my $fname=$env{'form.'.$formname.'.filename'};
1.531 albertel 4313: $fname=&clean_filename($fname);
1.1090 raeburn 4314: # See if there is anything left
1.257 www 4315: unless ($fname) { return 'error: no uploaded file'; }
1.1406 raeburn 4316: # If filename now begins with a . prepend unix timestamp _ milliseconds
4317: if ($fname =~ /^\./) {
4318: my ($s,$usec) = &gettimeofday();
4319: while (length($usec) < 6) {
4320: $usec = '0'.$usec;
4321: }
4322: $fname = $s.'_'.substr($usec,0,3).$fname;
4323: }
1.1090 raeburn 4324: # Files uploaded to help request form, or uploaded to "create course" page are handled differently
4325: if ((($formname eq 'screenshot') && ($subdir eq 'helprequests')) ||
4326: (($formname eq 'coursecreatorxml') && ($subdir eq 'batchupload')) ||
4327: ($context eq 'existingfile') || ($context eq 'canceloverwrite')) {
1.523 raeburn 4328: my $now = time;
1.1090 raeburn 4329: my $filepath;
1.1095 raeburn 4330: if (($formname eq 'screenshot') && ($subdir eq 'helprequests')) {
1.1090 raeburn 4331: $filepath = 'tmp/helprequests/'.$now;
4332: } elsif (($formname eq 'coursecreatorxml') && ($subdir eq 'batchupload')) {
4333: $filepath = 'tmp/addcourse/'.$destudom.'/web/'.$env{'user.name'}.
4334: '_'.$env{'user.domain'}.'/pending';
4335: } elsif (($context eq 'existingfile') || ($context eq 'canceloverwrite')) {
4336: my ($docuname,$docudom);
1.1350 raeburn 4337: if ($destudom =~ /^$match_domain$/) {
1.1090 raeburn 4338: $docudom = $destudom;
4339: } else {
4340: $docudom = $env{'user.domain'};
4341: }
1.1350 raeburn 4342: if ($destuname =~ /^$match_username$/) {
1.1090 raeburn 4343: $docuname = $destuname;
4344: } else {
4345: $docuname = $env{'user.name'};
4346: }
4347: if (exists($env{'form.group'})) {
4348: $docuname=$env{'course.'.$env{'request.course.id'}.'.num'};
4349: $docudom=$env{'course.'.$env{'request.course.id'}.'.domain'};
4350: }
4351: $filepath = 'tmp/overwrites/'.$docudom.'/'.$docuname.'/'.$subdir;
4352: if ($context eq 'canceloverwrite') {
4353: my $tempfile = $perlvar{'lonDaemons'}.'/'.$filepath.'/'.$fname;
4354: if (-e $tempfile) {
4355: my @info = stat($tempfile);
4356: if ($info[9] eq $env{'form.timestamp'}) {
4357: unlink($tempfile);
4358: }
4359: }
4360: return;
1.523 raeburn 4361: }
4362: }
1.1090 raeburn 4363: # Create the directory if not present
1.741 raeburn 4364: my @parts=split(/\//,$filepath);
4365: my $fullpath = $perlvar{'lonDaemons'};
4366: for (my $i=0;$i<@parts;$i++) {
4367: $fullpath .= '/'.$parts[$i];
4368: if ((-e $fullpath)!=1) {
4369: mkdir($fullpath,0777);
4370: }
4371: }
1.1359 raeburn 4372: open(my $fh,'>',$fullpath.'/'.$fname);
1.741 raeburn 4373: print $fh $env{'form.'.$formname};
4374: close($fh);
1.1090 raeburn 4375: if ($context eq 'existingfile') {
4376: my @info = stat($fullpath.'/'.$fname);
4377: return ($fullpath.'/'.$fname,$info[9]);
4378: } else {
4379: return $fullpath.'/'.$fname;
4380: }
1.523 raeburn 4381: }
1.995 raeburn 4382: if ($subdir eq 'scantron') {
4383: $fname = 'scantron_orig_'.$fname;
1.1093 raeburn 4384: } else {
1.995 raeburn 4385: $fname="$subdir/$fname";
4386: }
1.1090 raeburn 4387: if ($context eq 'coursedoc') {
1.638 albertel 4388: my $docuname=$env{'course.'.$env{'request.course.id'}.'.num'};
4389: my $docudom=$env{'course.'.$env{'request.course.id'}.'.domain'};
1.646 raeburn 4390: if ($env{'form.folder'} =~ m/^(default|supplemental)/) {
1.638 albertel 4391: return &finishuserfileupload($docuname,$docudom,
4392: $formname,$fname,$parser,$allfiles,
1.1051 raeburn 4393: $codebase,$thumbwidth,$thumbheight,
1.1095 raeburn 4394: $resizewidth,$resizeheight,$context,$mimetype);
1.481 raeburn 4395: } else {
1.1218 raeburn 4396: if ($env{'form.folder'}) {
4397: $fname=$env{'form.folder'}.'/'.$fname;
4398: }
1.638 albertel 4399: return &process_coursefile('uploaddoc',$docuname,$docudom,
4400: $fname,$formname,$parser,
1.1095 raeburn 4401: $allfiles,$codebase,$mimetype);
1.481 raeburn 4402: }
1.719 banghart 4403: } elsif (defined($destuname)) {
4404: my $docuname=$destuname;
4405: my $docudom=$destudom;
1.860 raeburn 4406: return &finishuserfileupload($docuname,$docudom,$formname,$fname,
4407: $parser,$allfiles,$codebase,
1.1051 raeburn 4408: $thumbwidth,$thumbheight,
1.1095 raeburn 4409: $resizewidth,$resizeheight,$context,$mimetype);
1.259 www 4410: } else {
1.638 albertel 4411: my $docuname=$env{'user.name'};
4412: my $docudom=$env{'user.domain'};
1.1220 raeburn 4413: if ((exists($env{'form.group'})) || ($context eq 'syllabus')) {
1.714 raeburn 4414: $docuname=$env{'course.'.$env{'request.course.id'}.'.num'};
4415: $docudom=$env{'course.'.$env{'request.course.id'}.'.domain'};
4416: }
1.860 raeburn 4417: return &finishuserfileupload($docuname,$docudom,$formname,$fname,
4418: $parser,$allfiles,$codebase,
1.1051 raeburn 4419: $thumbwidth,$thumbheight,
1.1095 raeburn 4420: $resizewidth,$resizeheight,$context,$mimetype);
1.259 www 4421: }
1.271 www 4422: }
4423:
4424: sub finishuserfileupload {
1.860 raeburn 4425: my ($docuname,$docudom,$formname,$fname,$parser,$allfiles,$codebase,
1.1095 raeburn 4426: $thumbwidth,$thumbheight,$resizewidth,$resizeheight,$context,$mimetype) = @_;
1.477 raeburn 4427: my $path=$docudom.'/'.$docuname.'/';
1.258 www 4428: my $filepath=$perlvar{'lonDocRoot'};
1.984 neumanie 4429:
1.860 raeburn 4430: my ($fnamepath,$file,$fetchthumb);
1.494 albertel 4431: $file=$fname;
4432: if ($fname=~m|/|) {
4433: ($fnamepath,$file) = ($fname =~ m|^(.*)/([^/]+)$|);
4434: $path.=$fnamepath.'/';
4435: }
1.259 www 4436: my @parts=split(/\//,$filepath.'/userfiles/'.$path);
1.258 www 4437: my $count;
4438: for ($count=4;$count<=$#parts;$count++) {
4439: $filepath.="/$parts[$count]";
4440: if ((-e $filepath)!=1) {
4441: mkdir($filepath,0777);
4442: }
4443: }
1.984 neumanie 4444:
1.258 www 4445: # Save the file
4446: {
1.1359 raeburn 4447: if (!open(FH,'>',$filepath.'/'.$file)) {
1.701 albertel 4448: &logthis('Failed to create '.$filepath.'/'.$file);
4449: print STDERR ('Failed to create '.$filepath.'/'.$file."\n");
4450: return '/adm/notfound.html';
4451: }
1.1090 raeburn 4452: if ($context eq 'overwrite') {
1.1117 foxr 4453: my $source = LONCAPA::tempdir().'/overwrites/'.$docudom.'/'.$docuname.'/'.$fname;
1.1090 raeburn 4454: my $target = $filepath.'/'.$file;
4455: if (-e $source) {
4456: my @info = stat($source);
4457: if ($info[9] eq $env{'form.timestamp'}) {
4458: unless (&File::Copy::move($source,$target)) {
4459: &logthis('Failed to overwrite '.$filepath.'/'.$file);
4460: return "Moving from $source failed";
4461: }
4462: } else {
4463: return "Temporary file: $source had unexpected date/time for last modification";
4464: }
4465: } else {
4466: return "Temporary file: $source missing";
4467: }
4468: } elsif (!print FH ($env{'form.'.$formname})) {
1.701 albertel 4469: &logthis('Failed to write to '.$filepath.'/'.$file);
4470: print STDERR ('Failed to write to '.$filepath.'/'.$file."\n");
4471: return '/adm/notfound.html';
4472: }
1.570 albertel 4473: close(FH);
1.1051 raeburn 4474: if ($resizewidth && $resizeheight) {
4475: my $mm = new File::MMagic;
4476: my $mime_type = $mm->checktype_filename($filepath.'/'.$file);
4477: if ($mime_type =~ m{^image/}) {
4478: &resizeImage($filepath.'/'.$file,$resizewidth,$resizeheight);
4479: }
1.977 amueller 4480: }
1.258 www 4481: }
1.1152 raeburn 4482: if (($context eq 'coursedoc') || ($parser eq 'parse')) {
4483: if (ref($mimetype)) {
4484: if ($$mimetype eq '') {
4485: my $mm = new File::MMagic;
4486: my $type = $mm->checktype_filename($filepath.'/'.$file);
4487: $$mimetype = $type;
4488: }
4489: }
4490: }
1.1401 raeburn 4491: if (($context ne 'scantron') && ($parser eq 'parse')) {
1.1152 raeburn 4492: if ((ref($mimetype)) && ($$mimetype eq 'text/html')) {
1.1024 raeburn 4493: my $parse_result = &extract_embedded_items($filepath.'/'.$file,
4494: $allfiles,$codebase);
4495: unless ($parse_result eq 'ok') {
4496: &logthis('Failed to parse '.$filepath.$file.
4497: ' for embedded media: '.$parse_result);
4498: }
1.637 raeburn 4499: }
1.1401 raeburn 4500: } elsif (($context eq 'scantron') && (ref($parser) eq 'HASH')) {
4501: my $format = $env{'form.scantron_format'};
4502: &bubblesheet_converter($docudom,$filepath.'/'.$file,$parser,$format);
1.637 raeburn 4503: }
1.860 raeburn 4504: if (($thumbwidth =~ /^\d+$/) && ($thumbheight =~ /^\d+$/)) {
4505: my $input = $filepath.'/'.$file;
4506: my $output = $filepath.'/'.'tn-'.$file;
1.1504 ! raeburn 4507: my $makethumb;
1.860 raeburn 4508: my $thumbsize = $thumbwidth.'x'.$thumbheight;
1.1504 ! raeburn 4509: if ($context eq 'toollogo') {
! 4510: my ($fullwidth,$fullheight) = &check_dimensions($input);
! 4511: if ($fullwidth ne '' && $fullheight ne '') {
! 4512: if ($fullwidth > $thumbwidth && $fullheight > $thumbheight) {
! 4513: $makethumb = 1;
! 4514: }
! 4515: }
! 4516: } else {
! 4517: $makethumb = 1;
! 4518: }
! 4519: if ($makethumb) {
! 4520: my @args = ('convert','-sample',$thumbsize,$input,$output);
! 4521: system({$args[0]} @args);
! 4522: if (-e $filepath.'/'.'tn-'.$file) {
! 4523: $fetchthumb = 1;
! 4524: }
1.860 raeburn 4525: }
4526: }
1.858 raeburn 4527:
1.259 www 4528: # Notify homeserver to grep it
4529: #
1.984 neumanie 4530: my $docuhome=&homeserver($docuname,$docudom);
1.494 albertel 4531: my $fetchresult= &reply('fetchuserfile:'.$path.$file,$docuhome);
1.295 www 4532: if ($fetchresult eq 'ok') {
1.860 raeburn 4533: if ($fetchthumb) {
4534: my $thumbresult= &reply('fetchuserfile:'.$path.'tn-'.$file,$docuhome);
4535: if ($thumbresult ne 'ok') {
4536: &logthis('Failed to transfer '.$path.'tn-'.$file.' to host '.
4537: $docuhome.': '.$thumbresult);
4538: }
4539: }
1.259 www 4540: #
1.258 www 4541: # Return the URL to it
1.494 albertel 4542: return '/uploaded/'.$path.$file;
1.263 www 4543: } else {
1.494 albertel 4544: &logthis('Failed to transfer '.$path.$file.' to host '.$docuhome.
4545: ': '.$fetchresult);
1.263 www 4546: return '/adm/notfound.html';
1.858 raeburn 4547: }
1.493 albertel 4548: }
4549:
1.637 raeburn 4550: sub extract_embedded_items {
1.961 raeburn 4551: my ($fullpath,$allfiles,$codebase,$content) = @_;
1.637 raeburn 4552: my @state = ();
1.1164 raeburn 4553: my (%lastids,%related,%shockwave,%flashvars);
1.637 raeburn 4554: my %javafiles = (
4555: codebase => '',
4556: code => '',
4557: archive => ''
4558: );
4559: my %mediafiles = (
4560: src => '',
4561: movie => '',
4562: );
1.648 raeburn 4563: my $p;
4564: if ($content) {
4565: $p = HTML::LCParser->new($content);
4566: } else {
1.961 raeburn 4567: $p = HTML::LCParser->new($fullpath);
1.648 raeburn 4568: }
1.641 albertel 4569: while (my $t=$p->get_token()) {
1.640 albertel 4570: if ($t->[0] eq 'S') {
4571: my ($tagname, $attr) = ($t->[1],$t->[2]);
1.886 albertel 4572: push(@state, $tagname);
1.648 raeburn 4573: if (lc($tagname) eq 'allow') {
4574: &add_filetype($allfiles,$attr->{'src'},'src');
4575: }
1.640 albertel 4576: if (lc($tagname) eq 'img') {
4577: &add_filetype($allfiles,$attr->{'src'},'src');
4578: }
1.886 albertel 4579: if (lc($tagname) eq 'a') {
1.1222 raeburn 4580: unless (($attr->{'href'} =~ /^#/) || ($attr->{'href'} eq '')) {
1.1221 raeburn 4581: &add_filetype($allfiles,$attr->{'href'},'href');
4582: }
1.886 albertel 4583: }
1.645 raeburn 4584: if (lc($tagname) eq 'script') {
1.1164 raeburn 4585: my $src;
1.645 raeburn 4586: if ($attr->{'archive'} =~ /\.jar$/i) {
4587: &add_filetype($allfiles,$attr->{'archive'},'archive');
4588: } else {
1.1164 raeburn 4589: if ($attr->{'src'} ne '') {
4590: $src = $attr->{'src'};
4591: &add_filetype($allfiles,$src,'src');
4592: }
4593: }
4594: my $text = $p->get_trimmed_text();
4595: if ($text =~ /\Qswfobject.registerObject(\E([^\)]+)\)/) {
4596: my @swfargs = split(/,/,$1);
4597: foreach my $item (@swfargs) {
4598: $item =~ s/["']//g;
4599: $item =~ s/^\s+//;
4600: $item =~ s/\s+$//;
4601: }
4602: if (($swfargs[0] ne'') && ($swfargs[2] ne '')) {
4603: if (ref($related{$swfargs[0]}) eq 'ARRAY') {
4604: push(@{$related{$swfargs[0]}},$swfargs[2]);
4605: } else {
4606: $related{$swfargs[0]} = [$swfargs[2]];
4607: }
4608: }
1.645 raeburn 4609: }
4610: }
4611: if (lc($tagname) eq 'link') {
4612: if (lc($attr->{'rel'}) eq 'stylesheet') {
4613: &add_filetype($allfiles,$attr->{'href'},'href');
4614: }
4615: }
1.640 albertel 4616: if (lc($tagname) eq 'object' ||
4617: (lc($tagname) eq 'embed' && lc($state[-2]) ne 'object')) {
4618: foreach my $item (keys(%javafiles)) {
4619: $javafiles{$item} = '';
4620: }
1.1164 raeburn 4621: if ((lc($tagname) eq 'object') && (lc($state[-2]) ne 'object')) {
4622: $lastids{lc($tagname)} = $attr->{'id'};
4623: }
1.640 albertel 4624: }
4625: if (lc($state[-2]) eq 'object' && lc($tagname) eq 'param') {
4626: my $name = lc($attr->{'name'});
4627: foreach my $item (keys(%javafiles)) {
4628: if ($name eq $item) {
4629: $javafiles{$item} = $attr->{'value'};
4630: last;
4631: }
4632: }
1.1164 raeburn 4633: my $pathfrom;
1.640 albertel 4634: foreach my $item (keys(%mediafiles)) {
4635: if ($name eq $item) {
1.1164 raeburn 4636: $pathfrom = $attr->{'value'};
4637: $shockwave{$lastids{lc($state[-2])}} = $pathfrom;
4638: &add_filetype($allfiles,$pathfrom,$name);
1.640 albertel 4639: last;
4640: }
4641: }
1.1164 raeburn 4642: if ($name eq 'flashvars') {
4643: $flashvars{$lastids{lc($state[-2])}} = $attr->{'value'};
4644: }
4645: if ($pathfrom ne '') {
4646: &embedded_dependency($allfiles,\%related,$lastids{lc($state[-2])},
4647: $pathfrom);
4648: }
1.640 albertel 4649: }
4650: if (lc($tagname) eq 'embed' || lc($tagname) eq 'applet') {
4651: foreach my $item (keys(%javafiles)) {
4652: if ($attr->{$item}) {
4653: $javafiles{$item} = $attr->{$item};
4654: last;
4655: }
4656: }
4657: foreach my $item (keys(%mediafiles)) {
4658: if ($attr->{$item}) {
4659: &add_filetype($allfiles,$attr->{$item},$item);
4660: last;
4661: }
4662: }
1.1164 raeburn 4663: if (lc($tagname) eq 'embed') {
4664: if (($attr->{'name'} ne '') && ($attr->{'src'} ne '')) {
4665: &embedded_dependency($allfiles,\%related,$attr->{'name'},
4666: $attr->{'src'});
4667: }
4668: }
1.640 albertel 4669: }
1.1243 raeburn 4670: if (lc($tagname) eq 'iframe') {
4671: my $src = $attr->{'src'} ;
4672: if (($src ne '') && ($src !~ m{^(/|https?://)})) {
4673: &add_filetype($allfiles,$src,'src');
4674: } elsif ($src =~ m{^/}) {
4675: if ($env{'request.course.id'}) {
4676: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
4677: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
4678: my $url = &hreflocation('',$fullpath);
4679: if ($url =~ m{^/uploaded/$cdom/$cnum/docs/(\w+/\d+)/}) {
4680: my $relpath = $1;
4681: if ($src =~ m{^/uploaded/$cdom/$cnum/docs/\Q$relpath\E/(.+)$}) {
4682: &add_filetype($allfiles,$1,'src');
4683: }
4684: }
4685: }
4686: }
4687: }
1.1164 raeburn 4688: if ($t->[4] =~ m{/>$}) {
1.1243 raeburn 4689: pop(@state);
1.1164 raeburn 4690: }
1.640 albertel 4691: } elsif ($t->[0] eq 'E') {
4692: my ($tagname) = ($t->[1]);
4693: if ($javafiles{'codebase'} ne '') {
4694: $javafiles{'codebase'} .= '/';
4695: }
4696: if (lc($tagname) eq 'applet' ||
4697: lc($tagname) eq 'object' ||
4698: (lc($tagname) eq 'embed' && lc($state[-2]) ne 'object')
4699: ) {
4700: foreach my $item (keys(%javafiles)) {
4701: if ($item ne 'codebase' && $javafiles{$item} ne '') {
4702: my $file=$javafiles{'codebase'}.$javafiles{$item};
4703: &add_filetype($allfiles,$file,$item);
4704: }
4705: }
4706: }
4707: pop @state;
4708: }
4709: }
1.1164 raeburn 4710: foreach my $id (sort(keys(%flashvars))) {
4711: if ($shockwave{$id} ne '') {
4712: my @pairs = split(/\&/,$flashvars{$id});
4713: foreach my $pair (@pairs) {
4714: my ($key,$value) = split(/\=/,$pair);
4715: if ($key eq 'thumb') {
4716: &add_filetype($allfiles,$value,$key);
4717: } elsif ($key eq 'content') {
4718: my ($path) = ($shockwave{$id} =~ m{^(.+/)[^/]+$});
4719: my ($ext) = ($value =~ /\.([^.]+)$/);
4720: if ($ext ne '') {
4721: &add_filetype($allfiles,$path.$value,$ext);
4722: }
4723: }
4724: }
4725: }
4726: }
1.637 raeburn 4727: return 'ok';
4728: }
4729:
1.639 albertel 4730: sub add_filetype {
4731: my ($allfiles,$file,$type)=@_;
4732: if (exists($allfiles->{$file})) {
4733: unless (grep/^\Q$type\E$/, @{$allfiles->{$file}}) {
4734: push(@{$allfiles->{$file}}, &escape($type));
4735: }
4736: } else {
4737: @{$allfiles->{$file}} = (&escape($type));
1.637 raeburn 4738: }
4739: }
4740:
1.1164 raeburn 4741: sub embedded_dependency {
4742: my ($allfiles,$related,$identifier,$pathfrom) = @_;
4743: if ((ref($allfiles) eq 'HASH') && (ref($related) eq 'HASH')) {
4744: if (($identifier ne '') &&
4745: (ref($related->{$identifier}) eq 'ARRAY') &&
4746: ($pathfrom ne '')) {
4747: my ($path) = ($pathfrom =~ m{^(.+/)[^/]+$});
4748: foreach my $dep (@{$related->{$identifier}}) {
4749: &add_filetype($allfiles,$path.$dep,'object');
4750: }
4751: }
4752: }
4753: return;
4754: }
4755:
1.1504 ! raeburn 4756: sub check_dimensions {
! 4757: my ($inputfile) = @_;
! 4758: my ($fullwidth,$fullheight);
! 4759: if (($inputfile =~ m|^[/\w.\-]+$|) && (-e $inputfile)) {
! 4760: my $mm = new File::MMagic;
! 4761: my $mime_type = $mm->checktype_filename($inputfile);
! 4762: if ($mime_type =~ m{^image/}) {
! 4763: if (open(PIPE,"identify $inputfile 2>&1 |")) {
! 4764: my $imageinfo = <PIPE>;
! 4765: if (!close(PIPE)) {
! 4766: &Apache::lonnet::logthis("Failed to close PIPE opened to retrieve image information for $inputfile");
! 4767: }
! 4768: chomp($imageinfo);
! 4769: my ($fullsize) =
! 4770: ($imageinfo =~ /^\Q$inputfile\E\s+\w+\s+(\d+x\d+)/);
! 4771: if ($fullsize) {
! 4772: ($fullwidth,$fullheight) = split(/x/,$fullsize);
! 4773: }
! 4774: }
! 4775: }
! 4776: }
! 4777: return ($fullwidth,$fullheight);
! 4778: }
! 4779:
1.1401 raeburn 4780: sub bubblesheet_converter {
4781: my ($cdom,$fullpath,$config,$format) = @_;
4782: if ((&domain($cdom) ne '') &&
1.1403 raeburn 4783: ($fullpath =~ m{^\Q$perlvar{'lonDocRoot'}/userfiles/$cdom/\E$match_courseid/scantron_orig}) &&
1.1401 raeburn 4784: (-e $fullpath) && (ref($config) eq 'HASH') && ($format ne '')) {
1.1404 raeburn 4785: my (%csvcols,%csvoptions);
4786: if (ref($config->{'fields'}) eq 'HASH') {
4787: %csvcols = %{$config->{'fields'}};
4788: }
4789: if (ref($config->{'options'}) eq 'HASH') {
4790: %csvoptions = %{$config->{'options'}};
4791: }
1.1401 raeburn 4792: my %csvbynum = reverse(%csvcols);
4793: my %scantronconf = &get_scantron_config($format,$cdom);
4794: if (keys(%scantronconf)) {
4795: my %bynum = (
4796: $scantronconf{CODEstart} => 'CODEstart',
4797: $scantronconf{IDstart} => 'IDstart',
4798: $scantronconf{PaperID} => 'PaperID',
4799: $scantronconf{FirstName} => 'FirstName',
4800: $scantronconf{LastName} => 'LastName',
4801: $scantronconf{Qstart} => 'Qstart',
4802: );
4803: my @ordered;
4804: foreach my $item (sort { $a <=> $b } keys(%bynum)) {
1.1403 raeburn 4805: push(@ordered,$bynum{$item});
1.1401 raeburn 4806: }
4807: my %mapstart = (
4808: CODEstart => 'CODE',
4809: IDstart => 'ID',
4810: PaperID => 'PaperID',
4811: FirstName => 'FirstName',
4812: LastName => 'LastName',
4813: Qstart => 'FirstQuestion',
4814: );
4815: my %maplength = (
4816: CODEstart => 'CODElength',
4817: IDstart => 'IDlength',
4818: PaperID => 'PaperIDlength',
4819: FirstName => 'FirstNamelength',
4820: LastName => 'LastNamelength',
4821: );
4822: if (open(my $fh,'<',$fullpath)) {
4823: my $output;
1.1403 raeburn 4824: my %lettdig = &letter_to_digits();
4825: my %diglett = reverse(%lettdig);
4826: my $numletts = scalar(keys(%lettdig));
1.1404 raeburn 4827: my $num = 0;
1.1401 raeburn 4828: while (my $line=<$fh>) {
1.1404 raeburn 4829: $num ++;
4830: next if (($num == 1) && ($csvoptions{'hdr'} == 1));
1.1401 raeburn 4831: $line =~ s{[\r\n]+$}{};
4832: my %found;
1.1475 raeburn 4833: my @values = split(/,/,$line,-1);
1.1401 raeburn 4834: my ($qstart,$record);
4835: for (my $i=0; $i<@values; $i++) {
1.1403 raeburn 4836: if ((($qstart ne '') && ($i > $qstart)) ||
4837: ($csvbynum{$i} eq 'FirstQuestion')) {
4838: if ($values[$i] eq '') {
4839: $values[$i] = $scantronconf{'Qoff'};
4840: } elsif ($scantronconf{'Qon'} eq 'number') {
4841: if ($values[$i] =~ /^[A-Ja-j]$/) {
4842: $values[$i] = $lettdig{uc($values[$i])};
4843: }
4844: } elsif ($scantronconf{'Qon'} eq 'letter') {
4845: if ($values[$i] =~ /^[0-9]$/) {
4846: $values[$i] = $diglett{$values[$i]};
4847: }
4848: } else {
4849: if ($values[$i] =~ /^[0-9A-Ja-j]$/) {
4850: my $digit;
4851: if ($values[$i] =~ /^[A-Ja-j]$/) {
4852: $digit = $lettdig{uc($values[$i])}-1;
4853: if ($values[$i] eq 'J') {
4854: $digit += $numletts;
4855: }
4856: } elsif ($values[$i] =~ /^[0-9]$/) {
4857: $digit = $values[$i]-1;
4858: if ($values[$i] eq '0') {
4859: $digit += $numletts;
4860: }
4861: }
4862: my $qval='';
4863: for (my $j=0; $j<$scantronconf{'Qlength'}; $j++) {
4864: if ($j == $digit) {
4865: $qval .= $scantronconf{'Qon'};
4866: } else {
4867: $qval .= $scantronconf{'Qoff'};
4868: }
4869: }
4870: $values[$i] = $qval;
4871: }
4872: }
4873: if (length($values[$i]) > $scantronconf{'Qlength'}) {
4874: $values[$i] = substr($values[$i],0,$scantronconf{'Qlength'});
4875: }
4876: my $numblank = $scantronconf{'Qlength'} - length($values[$i]);
4877: if ($numblank > 0) {
4878: $values[$i] .= ($scantronconf{'Qoff'} x $numblank);
4879: }
1.1401 raeburn 4880: if ($csvbynum{$i} eq 'FirstQuestion') {
4881: $qstart = $i;
1.1403 raeburn 4882: $found{$csvbynum{$i}} = $values[$i];
1.1401 raeburn 4883: } else {
1.1403 raeburn 4884: $found{'FirstQuestion'} .= $values[$i];
4885: }
4886: } elsif (exists($csvbynum{$i})) {
1.1404 raeburn 4887: if ($csvoptions{'rem'}) {
4888: $values[$i] =~ s/^\s+//;
4889: }
4890: if (($csvbynum{$i} eq 'PaperID') && ($csvoptions{'pad'})) {
1.1403 raeburn 4891: while (length($values[$i]) < $scantronconf{$maplength{$csvbynum{$i}}}) {
4892: $values[$i] = '0'.$values[$i];
1.1401 raeburn 4893: }
4894: }
4895: $found{$csvbynum{$i}} = $values[$i];
4896: }
4897: }
4898: foreach my $item (@ordered) {
4899: my $currlength = 1+length($record);
4900: my $numspaces = $scantronconf{$item} - $currlength;
4901: if ($numspaces > 0) {
4902: $record .= (' ' x $numspaces);
4903: }
4904: if (($mapstart{$item} ne '') && (exists($found{$mapstart{$item}}))) {
4905: unless ($item eq 'Qstart') {
4906: if (length($found{$mapstart{$item}}) > $scantronconf{$maplength{$item}}) {
4907: $found{$mapstart{$item}} = substr($found{$mapstart{$item}},0,$scantronconf{$maplength{$item}});
4908: }
4909: }
4910: $record .= $found{$mapstart{$item}};
4911: }
4912: }
4913: $output .= "$record\n";
4914: }
4915: close($fh);
4916: if ($output) {
4917: if (open(my $fh,'>',$fullpath)) {
4918: print $fh $output;
4919: close($fh);
4920: }
4921: }
4922: }
4923: }
4924: return;
4925: }
4926: }
4927:
1.1403 raeburn 4928: sub letter_to_digits {
4929: my %lettdig = (
4930: A => 1,
4931: B => 2,
4932: C => 3,
4933: D => 4,
4934: E => 5,
4935: F => 6,
4936: G => 7,
4937: H => 8,
4938: I => 9,
4939: J => 0,
4940: );
4941: return %lettdig;
4942: }
4943:
1.1401 raeburn 4944: sub get_scantron_config {
4945: my ($which,$cdom) = @_;
4946: my @lines = &get_scantronformat_file($cdom);
4947: my %config;
4948: #FIXME probably should move to XML it has already gotten a bit much now
4949: foreach my $line (@lines) {
4950: my ($name,$descrip)=split(/:/,$line);
4951: if ($name ne $which ) { next; }
4952: chomp($line);
4953: my @config=split(/:/,$line);
4954: $config{'name'}=$config[0];
4955: $config{'description'}=$config[1];
4956: $config{'CODElocation'}=$config[2];
4957: $config{'CODEstart'}=$config[3];
4958: $config{'CODElength'}=$config[4];
4959: $config{'IDstart'}=$config[5];
4960: $config{'IDlength'}=$config[6];
4961: $config{'Qstart'}=$config[7];
4962: $config{'Qlength'}=$config[8];
4963: $config{'Qoff'}=$config[9];
4964: $config{'Qon'}=$config[10];
4965: $config{'PaperID'}=$config[11];
4966: $config{'PaperIDlength'}=$config[12];
4967: $config{'FirstName'}=$config[13];
4968: $config{'FirstNamelength'}=$config[14];
4969: $config{'LastName'}=$config[15];
4970: $config{'LastNamelength'}=$config[16];
4971: $config{'BubblesPerRow'}=$config[17];
4972: last;
4973: }
4974: return %config;
4975: }
4976:
4977: sub get_scantronformat_file {
4978: my ($cdom) = @_;
4979: if ($cdom eq '') {
4980: $cdom= $env{'course.'.$env{'request.course.id'}.'.domain'};
4981: }
4982: my %domconfig = &get_dom('configuration',['scantron'],$cdom);
4983: my $gottab = 0;
4984: my @lines;
4985: if (ref($domconfig{'scantron'}) eq 'HASH') {
4986: if ($domconfig{'scantron'}{'scantronformat'} ne '') {
4987: my $formatfile = &getfile($perlvar{'lonDocRoot'}.$domconfig{'scantron'}{'scantronformat'});
4988: if ($formatfile ne '-1') {
4989: @lines = split("\n",$formatfile,-1);
4990: $gottab = 1;
4991: }
4992: }
4993: }
4994: if (!$gottab) {
4995: my $confname = $cdom.'-domainconfig';
4996: my $default = $perlvar{'lonDocRoot'}.'/res/'.$cdom.'/'.$confname.'/default.tab';
4997: my $formatfile = &getfile($default);
4998: if ($formatfile ne '-1') {
4999: @lines = split("\n",$formatfile,-1);
5000: $gottab = 1;
5001: }
5002: }
5003: if (!$gottab) {
5004: my @domains = ¤t_machine_domains();
5005: if (grep(/^\Q$cdom\E$/,@domains)) {
5006: if (open(my $fh,'<',$perlvar{'lonTabDir'}.'/scantronformat.tab')) {
5007: @lines = <$fh>;
5008: close($fh);
1.1403 raeburn 5009: }
1.1401 raeburn 5010: } else {
5011: if (open(my $fh,'<',$perlvar{'lonTabDir'}.'/default_scantronformat.tab')) {
5012: @lines = <$fh>;
5013: close($fh);
5014: }
5015: }
1.1488 raeburn 5016: chomp(@lines);
1.1401 raeburn 5017: }
5018: return @lines;
5019: }
5020:
1.493 albertel 5021: sub removeuploadedurl {
1.984 neumanie 5022: my ($url)=@_;
5023: my (undef,undef,$udom,$uname,$fname)=split('/',$url,5);
1.613 albertel 5024: return &removeuserfile($uname,$udom,$fname);
1.490 albertel 5025: }
5026:
5027: sub removeuserfile {
5028: my ($docuname,$docudom,$fname)=@_;
1.984 neumanie 5029: my $home=&homeserver($docuname,$docudom);
1.798 raeburn 5030: my $result = &reply("removeuserfile:$docudom/$docuname/$fname",$home);
1.984 neumanie 5031: if ($result eq 'ok') {
1.798 raeburn 5032: if (($fname !~ /\.meta$/) && (&is_portfolio_file($fname))) {
5033: my $metafile = $fname.'.meta';
5034: my $metaresult = &removeuserfile($docuname,$docudom,$metafile);
1.823 albertel 5035: my $url = "/uploaded/$docudom/$docuname/$fname";
1.984 neumanie 5036: my ($file,$group) = (&parse_portfolio_url($url))[3,4];
1.821 raeburn 5037: my $sqlresult =
1.823 albertel 5038: &update_portfolio_table($docuname,$docudom,$file,
1.821 raeburn 5039: 'portfolio_metadata',$group,
5040: 'delete');
1.798 raeburn 5041: }
5042: }
5043: return $result;
1.257 www 5044: }
1.15 www 5045:
1.530 albertel 5046: sub mkdiruserfile {
5047: my ($docuname,$docudom,$dir)=@_;
5048: my $home=&homeserver($docuname,$docudom);
5049: return &reply("mkdiruserfile:".&escape("$docudom/$docuname/$dir"),$home);
5050: }
5051:
1.531 albertel 5052: sub renameuserfile {
5053: my ($docuname,$docudom,$old,$new)=@_;
5054: my $home=&homeserver($docuname,$docudom);
1.798 raeburn 5055: my $result = &reply("renameuserfile:$docudom:$docuname:".
5056: &escape("$old").':'.&escape("$new"),$home);
5057: if ($result eq 'ok') {
5058: if (($old !~ /\.meta$/) && (&is_portfolio_file($old))) {
5059: my $oldmeta = $old.'.meta';
5060: my $newmeta = $new.'.meta';
5061: my $metaresult =
5062: &renameuserfile($docuname,$docudom,$oldmeta,$newmeta);
1.823 albertel 5063: my $url = "/uploaded/$docudom/$docuname/$old";
5064: my ($file,$group) = (&parse_portfolio_url($url))[3,4];
1.821 raeburn 5065: my $sqlresult =
1.823 albertel 5066: &update_portfolio_table($docuname,$docudom,$file,
1.821 raeburn 5067: 'portfolio_metadata',$group,
5068: 'delete');
1.798 raeburn 5069: }
5070: }
5071: return $result;
1.531 albertel 5072: }
5073:
1.14 www 5074: # ------------------------------------------------------------------------- Log
5075:
5076: sub log {
5077: my ($dom,$nam,$hom,$what)=@_;
1.47 www 5078: return critical("log:$dom:$nam:$what",$hom);
1.157 www 5079: }
5080:
5081: # ------------------------------------------------------------------ Course Log
1.352 www 5082: #
5083: # This routine flushes several buffers of non-mission-critical nature
5084: #
1.157 www 5085:
5086: sub flushcourselogs {
1.352 www 5087: &logthis('Flushing log buffers');
5088: #
5089: # course logs
5090: # This is a log of all transactions in a course, which can be used
5091: # for data mining purposes
5092: #
5093: # It also collects the courseid database, which lists last transaction
5094: # times and course titles for all courseids
5095: #
5096: my %courseidbuffer=();
1.921 raeburn 5097: foreach my $crsid (keys(%courselogs)) {
1.352 www 5098: if (&reply('log:'.$coursedombuf{$crsid}.':'.$coursenumbuf{$crsid}.':'.
1.188 www 5099: &escape($courselogs{$crsid}),
5100: $coursehombuf{$crsid}) eq 'ok') {
1.157 www 5101: delete $courselogs{$crsid};
5102: } else {
5103: &logthis('Failed to flush log buffer for '.$crsid);
5104: if (length($courselogs{$crsid})>40000) {
1.672 albertel 5105: &logthis("<font color=\"blue\">WARNING: Buffer for ".$crsid.
1.157 www 5106: " exceeded maximum size, deleting.</font>");
5107: delete $courselogs{$crsid};
5108: }
1.352 www 5109: }
1.920 raeburn 5110: $courseidbuffer{$coursehombuf{$crsid}}{$crsid} = {
1.936 raeburn 5111: 'description' => $coursedescrbuf{$crsid},
5112: 'inst_code' => $courseinstcodebuf{$crsid},
5113: 'type' => $coursetypebuf{$crsid},
5114: 'owner' => $courseownerbuf{$crsid},
1.920 raeburn 5115: };
1.191 harris41 5116: }
1.352 www 5117: #
5118: # Write course id database (reverse lookup) to homeserver of courses
5119: # Is used in pickcourse
5120: #
1.840 albertel 5121: foreach my $crs_home (keys(%courseidbuffer)) {
1.918 raeburn 5122: my $response = &courseidput(&host_domain($crs_home),
1.921 raeburn 5123: $courseidbuffer{$crs_home},
5124: $crs_home,'timeonly');
1.352 www 5125: }
5126: #
5127: # File accesses
5128: # Writes to the dynamic metadata of resources to get hit counts, etc.
5129: #
1.449 matthew 5130: foreach my $entry (keys(%accesshash)) {
1.458 matthew 5131: if ($entry =~ /___count$/) {
5132: my ($dom,$name);
1.807 albertel 5133: ($dom,$name,undef)=
1.811 albertel 5134: ($entry=~m{___($match_domain)/($match_name)/(.*)___count$});
1.458 matthew 5135: if (! defined($dom) || $dom eq '' ||
5136: ! defined($name) || $name eq '') {
1.620 albertel 5137: my $cid = $env{'request.course.id'};
1.1472 raeburn 5138: #
5139: # FIXME 11/29/2021
5140: # Typo in rev. 1.458 (2003/12/09)??
5141: # These should likely by $env{'course.'.$cid.'.domain'} and $env{'course.'.$cid.'.num'}
5142: #
5143: # While these ramain as $env{'request.'.$cid.'.domain'} and $env{'request.'.$cid.'.num'}
5144: # $dom and $name will always be null, so the &inc() call will default to storing this data
5145: # in a nohist_accesscount.db file for the user rather than the course.
5146: #
5147: # That said there is a lot of noise in the data being stored.
5148: # So counts for prtspool/ and adm/ etc. are recorded.
5149: #
5150: # A review of which items ending '___count' are written to %accesshash should likely be
5151: # made before deciding whether to set these to 'course.' instead of 'request.'
5152: #
5153: # Under the current scheme each user receives a nohist_accesscount.db file listing
5154: # accesses for things which are not published resources, regardless of course, and
5155: # there is not a nohist_accesscount.db file in a course, which might log accesses from
5156: # anyone in the course for things which are not published resources.
5157: #
5158: # For an author, nohist_accesscount.db ends up having records for other items
5159: # mixed up with the legitimate access counts for the author's published resources.
5160: #
1.620 albertel 5161: $dom = $env{'request.'.$cid.'.domain'};
5162: $name = $env{'request.'.$cid.'.num'};
1.458 matthew 5163: }
1.450 matthew 5164: my $value = $accesshash{$entry};
5165: my (undef,$url,undef) = ($entry =~ /^(.*)___(.*)___count$/);
5166: my %temphash=($url => $value);
1.449 matthew 5167: my $result = &inc('nohist_accesscount',\%temphash,$dom,$name);
5168: if ($result eq 'ok') {
5169: delete $accesshash{$entry};
5170: }
5171: } else {
1.811 albertel 5172: my ($dom,$name) = ($entry=~m{___($match_domain)/($match_name)/(.*)___(\w+)$});
1.1159 www 5173: if (($dom eq 'uploaded') || ($dom eq 'adm')) { next; }
1.450 matthew 5174: my %temphash=($entry => $accesshash{$entry});
1.449 matthew 5175: if (&put('nohist_resevaldata',\%temphash,$dom,$name) eq 'ok') {
5176: delete $accesshash{$entry};
5177: }
1.185 www 5178: }
1.191 harris41 5179: }
1.352 www 5180: #
5181: # Roles
5182: # Reverse lookup of user roles for course faculty/staff and co-authorship
5183: #
1.800 albertel 5184: foreach my $entry (keys(%userrolehash)) {
1.351 www 5185: my ($role,$uname,$udom,$runame,$rudom,$rsec)=
1.349 www 5186: split(/\:/,$entry);
1.1494 raeburn 5187: if (&put('nohist_userroles',
1.351 www 5188: { $role.':'.$uname.':'.$udom.':'.$rsec => $userrolehash{$entry} },
1.349 www 5189: $rudom,$runame) eq 'ok') {
5190: delete $userrolehash{$entry};
5191: }
5192: }
1.662 raeburn 5193: #
1.1334 raeburn 5194: # Reverse lookup of domain roles (dc, ad, li, sc, dh, da, au)
1.662 raeburn 5195: #
5196: my %domrolebuffer = ();
1.1000 raeburn 5197: foreach my $entry (keys(%domainrolehash)) {
1.901 albertel 5198: my ($role,$uname,$udom,$runame,$rudom,$rsec)=split(/:/,$entry);
1.662 raeburn 5199: if ($domrolebuffer{$rudom}) {
5200: $domrolebuffer{$rudom}.='&'.&escape($entry).
5201: '='.&escape($domainrolehash{$entry});
5202: } else {
5203: $domrolebuffer{$rudom}.=&escape($entry).
5204: '='.&escape($domainrolehash{$entry});
5205: }
5206: delete $domainrolehash{$entry};
5207: }
5208: foreach my $dom (keys(%domrolebuffer)) {
1.1324 raeburn 5209: my %servers;
5210: if (defined(&domain($dom,'primary'))) {
5211: my $primary=&domain($dom,'primary');
5212: my $hostname=&hostname($primary);
5213: $servers{$primary} = $hostname;
5214: } else {
5215: %servers = &get_servers($dom,'library');
5216: }
1.841 albertel 5217: foreach my $tryserver (keys(%servers)) {
1.1324 raeburn 5218: if (&reply('domroleput:'.$dom.':'.
5219: $domrolebuffer{$dom},$tryserver) eq 'ok') {
5220: last;
5221: } else {
1.841 albertel 5222: &logthis('Put of domain roles failed for '.$dom.' and '.$tryserver);
5223: }
1.662 raeburn 5224: }
5225: }
1.186 www 5226: $dumpcount++;
1.157 www 5227: }
5228:
5229: sub courselog {
5230: my $what=shift;
1.158 www 5231: $what=time.':'.$what;
1.620 albertel 5232: unless ($env{'request.course.id'}) { return ''; }
5233: $coursedombuf{$env{'request.course.id'}}=
5234: $env{'course.'.$env{'request.course.id'}.'.domain'};
5235: $coursenumbuf{$env{'request.course.id'}}=
5236: $env{'course.'.$env{'request.course.id'}.'.num'};
5237: $coursehombuf{$env{'request.course.id'}}=
5238: $env{'course.'.$env{'request.course.id'}.'.home'};
5239: $coursedescrbuf{$env{'request.course.id'}}=
5240: $env{'course.'.$env{'request.course.id'}.'.description'};
5241: $courseinstcodebuf{$env{'request.course.id'}}=
5242: $env{'course.'.$env{'request.course.id'}.'.internal.coursecode'};
5243: $courseownerbuf{$env{'request.course.id'}}=
5244: $env{'course.'.$env{'request.course.id'}.'.internal.courseowner'};
1.741 raeburn 5245: $coursetypebuf{$env{'request.course.id'}}=
5246: $env{'course.'.$env{'request.course.id'}.'.type'};
1.620 albertel 5247: if (defined $courselogs{$env{'request.course.id'}}) {
5248: $courselogs{$env{'request.course.id'}}.='&'.$what;
1.157 www 5249: } else {
1.620 albertel 5250: $courselogs{$env{'request.course.id'}}.=$what;
1.157 www 5251: }
1.620 albertel 5252: if (length($courselogs{$env{'request.course.id'}})>4048) {
1.157 www 5253: &flushcourselogs();
5254: }
1.158 www 5255: }
5256:
5257: sub courseacclog {
5258: my $fnsymb=shift;
1.620 albertel 5259: unless ($env{'request.course.id'}) { return ''; }
5260: my $what=$fnsymb.':'.$env{'user.name'}.':'.$env{'user.domain'};
1.1144 www 5261: if ($fnsymb=~/$LONCAPA::assess_re/) {
1.187 www 5262: $what.=':POST';
1.583 matthew 5263: # FIXME: Probably ought to escape things....
1.800 albertel 5264: foreach my $key (keys(%env)) {
5265: if ($key=~/^form\.(.*)/) {
1.975 raeburn 5266: my $formitem = $1;
5267: if ($formitem =~ /^HWFILE(?:SIZE|TOOBIG)/) {
5268: $what.=':'.$formitem.'='.$env{$key};
5269: } elsif ($formitem !~ /^HWFILE(?:[^.]+)$/) {
1.1432 raeburn 5270: if ($formitem eq 'proctorpassword') {
1.1433 raeburn 5271: $what.=':'.$formitem.'=' . '*' x length($env{$key});
1.1432 raeburn 5272: } else {
5273: $what.=':'.$formitem.'='.$env{$key};
5274: }
1.975 raeburn 5275: }
1.158 www 5276: }
1.191 harris41 5277: }
1.583 matthew 5278: } elsif ($fnsymb =~ m:^/adm/searchcat:) {
5279: # FIXME: We should not be depending on a form parameter that someone
5280: # editing lonsearchcat.pm might change in the future.
1.620 albertel 5281: if ($env{'form.phase'} eq 'course_search') {
1.583 matthew 5282: $what.= ':POST';
5283: # FIXME: Probably ought to escape things....
5284: foreach my $element ('courseexp','crsfulltext','crsrelated',
5285: 'crsdiscuss') {
1.620 albertel 5286: $what.=':'.$element.'='.$env{'form.'.$element};
1.583 matthew 5287: }
5288: }
1.158 www 5289: }
5290: &courselog($what);
1.149 www 5291: }
5292:
1.185 www 5293: sub countacc {
5294: my $url=&declutter(shift);
1.458 matthew 5295: return if (! defined($url) || $url eq '');
1.620 albertel 5296: unless ($env{'request.course.id'}) { return ''; }
1.1158 www 5297: #
5298: # Mark that this url was used in this course
5299: #
1.620 albertel 5300: $accesshash{$env{'request.course.id'}.'___'.$url.'___course'}=1;
1.1158 www 5301: #
5302: # Increase the access count for this resource in this child process
5303: #
1.281 www 5304: my $key=$$.$processmarker.'_'.$dumpcount.'___'.$url.'___count';
1.450 matthew 5305: $accesshash{$key}++;
1.185 www 5306: }
1.349 www 5307:
1.361 www 5308: sub linklog {
5309: my ($from,$to)=@_;
5310: $from=&declutter($from);
5311: $to=&declutter($to);
5312: $accesshash{$from.'___'.$to.'___comefrom'}=1;
5313: $accesshash{$to.'___'.$from.'___goto'}=1;
5314: }
1.1160 www 5315:
5316: sub statslog {
5317: my ($symb,$part,$users,$av_attempts,$degdiff)=@_;
5318: if ($users<2) { return; }
5319: my %dynstore=&LONCAPA::lonmetadata::dynamic_metadata_storage({
5320: 'course' => $env{'request.course.id'},
5321: 'sections' => '"all"',
5322: 'num_students' => $users,
5323: 'part' => $part,
5324: 'symb' => $symb,
5325: 'mean_tries' => $av_attempts,
5326: 'deg_of_diff' => $degdiff});
5327: foreach my $key (keys(%dynstore)) {
5328: $accesshash{$key}=$dynstore{$key};
5329: }
5330: }
1.361 www 5331:
1.349 www 5332: sub userrolelog {
5333: my ($trole,$username,$domain,$area,$tstart,$tend)=@_;
1.1169 droeschl 5334: if ( $trole =~ /^(ca|aa|in|cc|ep|cr|ta|co)/ ) {
1.350 www 5335: my (undef,$rudom,$runame,$rsec)=split(/\//,$area);
5336: $userrolehash
5337: {$trole.':'.$username.':'.$domain.':'.$runame.':'.$rudom.':'.$rsec}
1.349 www 5338: =$tend.':'.$tstart;
1.662 raeburn 5339: }
1.1169 droeschl 5340: if ($env{'request.role'} =~ /dc\./ && $trole =~ /^(au|in|cc|ep|cr|ta|co)/) {
1.898 albertel 5341: $userrolehash
5342: {$trole.':'.$username.':'.$domain.':'.$env{'user.name'}.':'.$env{'user.domain'}.':'}
5343: =$tend.':'.$tstart;
5344: }
1.1334 raeburn 5345: if ($trole =~ /^(dc|ad|li|au|dg|sc|dh|da)/ ) {
1.662 raeburn 5346: my (undef,$rudom,$runame,$rsec)=split(/\//,$area);
5347: $domainrolehash
5348: {$trole.':'.$username.':'.$domain.':'.$runame.':'.$rudom.':'.$rsec}
5349: = $tend.':'.$tstart;
5350: }
1.351 www 5351: }
5352:
1.957 raeburn 5353: sub courserolelog {
5354: my ($trole,$username,$domain,$area,$tstart,$tend,$delflag,$selfenroll,$context)=@_;
1.1184 raeburn 5355: if ($area =~ m-^/($match_domain)/($match_courseid)/?([^/]*)-) {
5356: my $cdom = $1;
5357: my $cnum = $2;
5358: my $sec = $3;
5359: my $namespace = 'rolelog';
5360: my %storehash = (
5361: role => $trole,
5362: start => $tstart,
5363: end => $tend,
5364: selfenroll => $selfenroll,
5365: context => $context,
5366: );
5367: if ($trole eq 'gr') {
5368: $namespace = 'groupslog';
5369: $storehash{'group'} = $sec;
5370: } else {
5371: $storehash{'section'} = $sec;
5372: }
1.1188 raeburn 5373: &write_log('course',$namespace,\%storehash,$delflag,$username,
5374: $domain,$cnum,$cdom);
1.1184 raeburn 5375: if (($trole ne 'st') || ($sec ne '')) {
5376: &devalidate_cache_new('getcourseroles',$cdom.'_'.$cnum);
1.957 raeburn 5377: }
5378: }
5379: return;
5380: }
5381:
1.1184 raeburn 5382: sub domainrolelog {
5383: my ($trole,$username,$domain,$area,$tstart,$tend,$delflag,$context)=@_;
5384: if ($area =~ m{^/($match_domain)/$}) {
5385: my $cdom = $1;
1.1494 raeburn 5386: my $domconfiguser = &get_domainconfiguser($cdom);
1.1184 raeburn 5387: my $namespace = 'rolelog';
5388: my %storehash = (
5389: role => $trole,
5390: start => $tstart,
5391: end => $tend,
5392: context => $context,
5393: );
1.1188 raeburn 5394: &write_log('domain',$namespace,\%storehash,$delflag,$username,
5395: $domain,$domconfiguser,$cdom);
1.1184 raeburn 5396: }
5397: return;
5398:
5399: }
5400:
5401: sub coauthorrolelog {
5402: my ($trole,$username,$domain,$area,$tstart,$tend,$delflag,$context)=@_;
5403: if ($area =~ m{^/($match_domain)/($match_username)$}) {
5404: my $audom = $1;
5405: my $auname = $2;
5406: my $namespace = 'rolelog';
5407: my %storehash = (
5408: role => $trole,
5409: start => $tstart,
5410: end => $tend,
5411: context => $context,
5412: );
1.1188 raeburn 5413: &write_log('author',$namespace,\%storehash,$delflag,$username,
5414: $domain,$auname,$audom);
1.1184 raeburn 5415: }
5416: return;
5417: }
5418:
1.351 www 5419: sub get_course_adv_roles {
1.948 raeburn 5420: my ($cid,$codes) = @_;
1.620 albertel 5421: $cid=$env{'request.course.id'} unless (defined($cid));
1.351 www 5422: my %coursehash=&coursedescription($cid);
1.988 raeburn 5423: my $crstype = &Apache::loncommon::course_type($cid);
1.470 www 5424: my %nothide=();
1.800 albertel 5425: foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
1.937 raeburn 5426: if ($user !~ /:/) {
5427: $nothide{join(':',split(/[\@]/,$user))}=1;
5428: } else {
5429: $nothide{$user}=1;
5430: }
1.470 www 5431: }
1.1219 raeburn 5432: my @possdoms = ($coursehash{'domain'});
5433: if ($coursehash{'checkforpriv'}) {
5434: push(@possdoms,split(/,/,$coursehash{'checkforpriv'}));
5435: }
1.351 www 5436: my %returnhash=();
5437: my %dumphash=
5438: &dump('nohist_userroles',$coursehash{'domain'},$coursehash{'num'});
5439: my $now=time;
1.997 raeburn 5440: my %privileged;
1.1000 raeburn 5441: foreach my $entry (keys(%dumphash)) {
1.800 albertel 5442: my ($tend,$tstart)=split(/\:/,$dumphash{$entry});
1.351 www 5443: if (($tstart) && ($tstart<0)) { next; }
5444: if (($tend) && ($tend<$now)) { next; }
5445: if (($tstart) && ($now<$tstart)) { next; }
1.800 albertel 5446: my ($role,$username,$domain,$section)=split(/\:/,$entry);
1.576 albertel 5447: if ($username eq '' || $domain eq '') { next; }
1.1219 raeburn 5448: if ((&privileged($username,$domain,\@possdoms)) &&
1.997 raeburn 5449: (!$nothide{$username.':'.$domain})) { next; }
1.656 albertel 5450: if ($role eq 'cr') { next; }
1.948 raeburn 5451: if ($codes) {
5452: if ($section) { $role .= ':'.$section; }
5453: if ($returnhash{$role}) {
5454: $returnhash{$role}.=','.$username.':'.$domain;
5455: } else {
5456: $returnhash{$role}=$username.':'.$domain;
5457: }
1.351 www 5458: } else {
1.988 raeburn 5459: my $key=&plaintext($role,$crstype);
1.973 bisitz 5460: if ($section) { $key.=' ('.&Apache::lonlocal::mt('Section [_1]',$section).')'; }
1.948 raeburn 5461: if ($returnhash{$key}) {
5462: $returnhash{$key}.=','.$username.':'.$domain;
5463: } else {
5464: $returnhash{$key}=$username.':'.$domain;
5465: }
1.351 www 5466: }
1.948 raeburn 5467: }
1.400 www 5468: return %returnhash;
5469: }
5470:
5471: sub get_my_roles {
1.937 raeburn 5472: my ($uname,$udom,$context,$types,$roles,$roledoms,$withsec,$hidepriv)=@_;
1.620 albertel 5473: unless (defined($uname)) { $uname=$env{'user.name'}; }
5474: unless (defined($udom)) { $udom=$env{'user.domain'}; }
1.937 raeburn 5475: my (%dumphash,%nothide);
1.1086 raeburn 5476: if ($context eq 'userroles') {
1.1166 raeburn 5477: %dumphash = &dump('roles',$udom,$uname);
1.858 raeburn 5478: } else {
1.1219 raeburn 5479: %dumphash = &dump('nohist_userroles',$udom,$uname);
1.937 raeburn 5480: if ($hidepriv) {
5481: my %coursehash=&coursedescription($udom.'_'.$uname);
5482: foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
5483: if ($user !~ /:/) {
5484: $nothide{join(':',split(/[\@]/,$user))} = 1;
5485: } else {
5486: $nothide{$user} = 1;
5487: }
5488: }
5489: }
1.858 raeburn 5490: }
1.400 www 5491: my %returnhash=();
5492: my $now=time;
1.999 raeburn 5493: my %privileged;
1.800 albertel 5494: foreach my $entry (keys(%dumphash)) {
1.867 raeburn 5495: my ($role,$tend,$tstart);
5496: if ($context eq 'userroles') {
1.1149 raeburn 5497: next if ($entry =~ /^rolesdef/);
1.867 raeburn 5498: ($role,$tend,$tstart)=split(/_/,$dumphash{$entry});
5499: } else {
5500: ($tend,$tstart)=split(/\:/,$dumphash{$entry});
5501: }
1.400 www 5502: if (($tstart) && ($tstart<0)) { next; }
1.832 raeburn 5503: my $status = 'active';
1.939 raeburn 5504: if (($tend) && ($tend<=$now)) {
1.832 raeburn 5505: $status = 'previous';
5506: }
5507: if (($tstart) && ($now<$tstart)) {
5508: $status = 'future';
5509: }
5510: if (ref($types) eq 'ARRAY') {
5511: if (!grep(/^\Q$status\E$/,@{$types})) {
5512: next;
5513: }
5514: } else {
5515: if ($status ne 'active') {
5516: next;
5517: }
5518: }
1.867 raeburn 5519: my ($rolecode,$username,$domain,$section,$area);
5520: if ($context eq 'userroles') {
1.1186 raeburn 5521: ($area,$rolecode) = ($entry =~ /^(.+)_([^_]+)$/);
1.867 raeburn 5522: (undef,$domain,$username,$section) = split(/\//,$area);
5523: } else {
5524: ($role,$username,$domain,$section) = split(/\:/,$entry);
5525: }
1.832 raeburn 5526: if (ref($roledoms) eq 'ARRAY') {
5527: if (!grep(/^\Q$domain\E$/,@{$roledoms})) {
5528: next;
5529: }
5530: }
5531: if (ref($roles) eq 'ARRAY') {
5532: if (!grep(/^\Q$role\E$/,@{$roles})) {
1.922 raeburn 5533: if ($role =~ /^cr\//) {
5534: if (!grep(/^cr$/,@{$roles})) {
5535: next;
5536: }
1.1104 raeburn 5537: } elsif ($role =~ /^gr\//) {
5538: if (!grep(/^gr$/,@{$roles})) {
5539: next;
5540: }
1.922 raeburn 5541: } else {
5542: next;
5543: }
1.832 raeburn 5544: }
1.867 raeburn 5545: }
1.937 raeburn 5546: if ($hidepriv) {
1.1219 raeburn 5547: my @privroles = ('dc','su');
1.999 raeburn 5548: if ($context eq 'userroles') {
1.1219 raeburn 5549: next if (grep(/^\Q$role\E$/,@privroles));
1.999 raeburn 5550: } else {
1.1219 raeburn 5551: my $possdoms = [$domain];
5552: if (ref($roledoms) eq 'ARRAY') {
5553: push(@{$possdoms},@{$roledoms});
1.999 raeburn 5554: }
1.1219 raeburn 5555: if (&privileged($username,$domain,$possdoms,\@privroles)) {
1.999 raeburn 5556: if (!$nothide{$username.':'.$domain}) {
5557: next;
5558: }
5559: }
1.937 raeburn 5560: }
5561: }
1.933 raeburn 5562: if ($withsec) {
5563: $returnhash{$username.':'.$domain.':'.$role.':'.$section} =
5564: $tstart.':'.$tend;
5565: } else {
5566: $returnhash{$username.':'.$domain.':'.$role}=$tstart.':'.$tend;
5567: }
1.832 raeburn 5568: }
1.373 www 5569: return %returnhash;
1.399 www 5570: }
5571:
1.1333 raeburn 5572: sub get_all_adhocroles {
5573: my ($dom) = @_;
5574: my @roles_by_num = ();
5575: my %domdefaults = &get_domain_defaults($dom);
5576: my (%description,%access_in_dom,%access_info);
5577: if (ref($domdefaults{'adhocroles'}) eq 'HASH') {
5578: my $count = 0;
5579: my %domcurrent = %{$domdefaults{'adhocroles'}};
5580: my %ordered;
5581: foreach my $role (sort(keys(%domcurrent))) {
5582: my ($order,$desc,$access_in_dom);
5583: if (ref($domcurrent{$role}) eq 'HASH') {
5584: $order = $domcurrent{$role}{'order'};
5585: $desc = $domcurrent{$role}{'desc'};
5586: $access_in_dom{$role} = $domcurrent{$role}{'access'};
5587: $access_info{$role} = $domcurrent{$role}{$access_in_dom{$role}};
5588: }
5589: if ($order eq '') {
5590: $order = $count;
5591: }
5592: $ordered{$order} = $role;
5593: if ($desc ne '') {
5594: $description{$role} = $desc;
5595: } else {
5596: $description{$role}= $role;
5597: }
5598: $count++;
5599: }
5600: foreach my $item (sort {$a <=> $b } (keys(%ordered))) {
5601: push(@roles_by_num,$ordered{$item});
5602: }
5603: }
5604: return (\@roles_by_num,\%description,\%access_in_dom,\%access_info);
5605: }
5606:
1.1332 raeburn 5607: sub get_my_adhocroles {
1.1333 raeburn 5608: my ($cid,$checkreg) = @_;
5609: my ($cdom,$cnum,%info,@possroles,$description,$roles_by_num);
5610: if ($env{'request.course.id'} eq $cid) {
5611: $cdom = $env{'course.'.$cid.'.domain'};
5612: $cnum = $env{'course.'.$cid.'.num'};
5613: $info{'internal.coursecode'} = $env{'course.'.$cid.'.internal.coursecode'};
5614: } elsif ($cid =~ /^($match_domain)_($match_courseid)$/) {
5615: $cdom = $1;
5616: $cnum = $2;
1.1494 raeburn 5617: %info = &get('environment',['internal.coursecode'],
5618: $cdom,$cnum);
1.1333 raeburn 5619: }
5620: if (($info{'internal.coursecode'} ne '') && ($checkreg)) {
5621: my $user = $env{'user.name'}.':'.$env{'user.domain'};
5622: my %rosterhash = &get('classlist',[$user],$cdom,$cnum);
5623: if ($rosterhash{$user} ne '') {
5624: my $type = (split(/:/,$rosterhash{$user}))[5];
5625: return ([],{}) if ($type eq 'auto');
5626: }
5627: }
5628: if (($cdom ne '') && ($cnum ne '')) {
1.1334 raeburn 5629: if (($env{"user.role.dh./$cdom/"}) || ($env{"user.role.da./$cdom/"})) {
1.1332 raeburn 5630: my $then=$env{'user.login.time'};
5631: my $update=$env{'user.update.time'};
1.1335 raeburn 5632: if (!$update) {
5633: $update = $then;
5634: }
5635: my @liveroles;
1.1334 raeburn 5636: foreach my $role ('dh','da') {
5637: if ($env{"user.role.$role./$cdom/"}) {
1.1335 raeburn 5638: my ($tstart,$tend)=split(/\./,$env{"user.role.$role./$cdom/"});
1.1334 raeburn 5639: my $limit = $update;
5640: if ($env{'request.role'} eq "$role./$cdom/") {
5641: $limit = $then;
5642: }
1.1335 raeburn 5643: my $activerole = 1;
5644: if ($tstart && $tstart>$limit) { $activerole = 0; }
5645: if ($tend && $tend <$limit) { $activerole = 0; }
5646: if ($activerole) {
5647: push(@liveroles,$role);
5648: }
1.1334 raeburn 5649: }
1.1332 raeburn 5650: }
1.1335 raeburn 5651: if (@liveroles) {
1.1332 raeburn 5652: if (&homeserver($cnum,$cdom) ne 'no_host') {
1.1333 raeburn 5653: my ($accessref,$accessinfo,%access_in_dom);
5654: ($roles_by_num,$description,$accessref,$accessinfo) = &get_all_adhocroles($cdom);
5655: if (ref($roles_by_num) eq 'ARRAY') {
5656: if (@{$roles_by_num}) {
1.1332 raeburn 5657: my %settings;
5658: if ($env{'request.course.id'} eq $cid) {
5659: foreach my $envkey (keys(%env)) {
5660: if ($envkey =~ /^\Qcourse.$cid.\E(internal\.adhoc.+)$/) {
5661: $settings{$1} = $env{$envkey};
5662: }
5663: }
5664: } else {
5665: %settings = &dump('environment',$cdom,$cnum,'internal\.adhoc');
5666: }
5667: my %setincrs;
5668: if ($settings{'internal.adhocaccess'}) {
5669: map { $setincrs{$_} = 1; } split(/,/,$settings{'internal.adhocaccess'});
5670: }
5671: my @statuses;
5672: if ($env{'environment.inststatus'}) {
5673: @statuses = split(/,/,$env{'environment.inststatus'});
5674: }
5675: my $user = $env{'user.name'}.':'.$env{'user.domain'};
1.1333 raeburn 5676: if (ref($accessref) eq 'HASH') {
5677: %access_in_dom = %{$accessref};
5678: }
5679: foreach my $role (@{$roles_by_num}) {
1.1332 raeburn 5680: my ($curraccess,@okstatus,@personnel);
5681: if ($setincrs{$role}) {
5682: ($curraccess,my $rest) = split(/=/,$settings{'internal.adhoc.'.$role});
5683: if ($curraccess eq 'status') {
5684: @okstatus = split(/\&/,$rest);
5685: } elsif (($curraccess eq 'exc') || ($curraccess eq 'inc')) {
5686: @personnel = split(/\&/,$rest);
5687: }
5688: } else {
5689: $curraccess = $access_in_dom{$role};
1.1333 raeburn 5690: if (ref($accessinfo) eq 'HASH') {
5691: if ($curraccess eq 'status') {
5692: if (ref($accessinfo->{$role}) eq 'ARRAY') {
5693: @okstatus = @{$accessinfo->{$role}};
5694: }
5695: } elsif (($curraccess eq 'exc') || ($curraccess eq 'inc')) {
5696: if (ref($accessinfo->{$role}) eq 'ARRAY') {
5697: @personnel = @{$accessinfo->{$role}};
5698: }
1.1332 raeburn 5699: }
5700: }
5701: }
5702: if ($curraccess eq 'none') {
5703: next;
5704: } elsif ($curraccess eq 'all') {
5705: push(@possroles,$role);
1.1336 raeburn 5706: } elsif ($curraccess eq 'dh') {
1.1335 raeburn 5707: if (grep(/^dh$/,@liveroles)) {
5708: push(@possroles,$role);
5709: } else {
5710: next;
5711: }
1.1336 raeburn 5712: } elsif ($curraccess eq 'da') {
1.1335 raeburn 5713: if (grep(/^da$/,@liveroles)) {
5714: push(@possroles,$role);
5715: } else {
5716: next;
5717: }
1.1332 raeburn 5718: } elsif ($curraccess eq 'status') {
5719: if (@okstatus) {
5720: if (!@statuses) {
5721: if (grep(/^default$/,@okstatus)) {
5722: push(@possroles,$role);
5723: }
5724: } else {
5725: foreach my $status (@okstatus) {
5726: if (grep(/^\Q$status\E$/,@statuses)) {
5727: push(@possroles,$role);
5728: last;
5729: }
5730: }
5731: }
5732: }
5733: } elsif (($curraccess eq 'exc') || ($curraccess eq 'inc')) {
5734: if (grep(/^\Q$user\E$/,@personnel)) {
5735: if ($curraccess eq 'exc') {
5736: push(@possroles,$role);
5737: }
5738: } elsif ($curraccess eq 'inc') {
5739: push(@possroles,$role);
5740: }
5741: }
5742: }
5743: }
5744: }
5745: }
5746: }
5747: }
5748: }
1.1333 raeburn 5749: unless (ref($description) eq 'HASH') {
5750: if (ref($roles_by_num) eq 'ARRAY') {
5751: my %desc;
5752: map { $desc{$_} = $_; } (@{$roles_by_num});
5753: $description = \%desc;
5754: } else {
5755: $description = {};
5756: }
5757: }
5758: return (\@possroles,$description);
1.1332 raeburn 5759: }
5760:
1.399 www 5761: # ----------------------------------------------------- Frontpage Announcements
5762: #
5763: #
5764:
5765: sub postannounce {
5766: my ($server,$text)=@_;
1.844 albertel 5767: unless (&allowed('psa',&host_domain($server))) { return 'refused'; }
1.399 www 5768: unless ($text=~/\w/) { $text=''; }
5769: return &reply('setannounce:'.&escape($text),$server);
5770: }
5771:
5772: sub getannounce {
1.448 albertel 5773:
1.1359 raeburn 5774: if (open(my $fh,"<",$perlvar{'lonDocRoot'}.'/announcement.txt')) {
1.399 www 5775: my $announcement='';
1.800 albertel 5776: while (my $line = <$fh>) { $announcement .= $line; }
1.448 albertel 5777: close($fh);
1.399 www 5778: if ($announcement=~/\w/) {
5779: return
5780: '<table bgcolor="#FF5555" cellpadding="5" cellspacing="3">'.
1.518 albertel 5781: '<tr><td bgcolor="#FFFFFF"><tt>'.$announcement.'</tt></td></tr></table>';
1.399 www 5782: } else {
5783: return '';
5784: }
5785: } else {
5786: return '';
5787: }
1.351 www 5788: }
1.353 www 5789:
5790: # ---------------------------------------------------------- Course ID routines
5791: # Deal with domain's nohist_courseid.db files
5792: #
5793:
5794: sub courseidput {
1.921 raeburn 5795: my ($domain,$storehash,$coursehome,$caller) = @_;
1.1054 raeburn 5796: return unless (ref($storehash) eq 'HASH');
1.921 raeburn 5797: my $outcome;
5798: if ($caller eq 'timeonly') {
5799: my $cids = '';
5800: foreach my $item (keys(%$storehash)) {
5801: $cids.=&escape($item).'&';
5802: }
5803: $cids=~s/\&$//;
5804: $outcome = &reply('courseidputhash:'.$domain.':'.$caller.':'.$cids,
5805: $coursehome);
5806: } else {
5807: my $items = '';
5808: foreach my $item (keys(%$storehash)) {
5809: $items.= &escape($item).'='.
5810: &freeze_escape($$storehash{$item}).'&';
5811: }
5812: $items=~s/\&$//;
5813: $outcome = &reply('courseidputhash:'.$domain.':'.$caller.':'.$items,
5814: $coursehome);
1.918 raeburn 5815: }
5816: if ($outcome eq 'unknown_cmd') {
5817: my $what;
5818: foreach my $cid (keys(%$storehash)) {
5819: $what .= &escape($cid).'=';
1.921 raeburn 5820: foreach my $item ('description','inst_code','owner','type') {
1.936 raeburn 5821: $what .= &escape($storehash->{$cid}{$item}).':';
1.918 raeburn 5822: }
5823: $what =~ s/\:$/&/;
5824: }
5825: $what =~ s/\&$//;
5826: return &reply('courseidput:'.$domain.':'.$what,$coursehome);
5827: } else {
5828: return $outcome;
5829: }
1.353 www 5830: }
5831:
5832: sub courseiddump {
1.921 raeburn 5833: my ($domfilter,$descfilter,$sincefilter,$instcodefilter,$ownerfilter,
1.947 raeburn 5834: $coursefilter,$hostidflag,$hostidref,$typefilter,$regexp_ok,
1.1029 raeburn 5835: $selfenrollonly,$catfilter,$showhidden,$caller,$cloner,$cc_clone,
1.1247 raeburn 5836: $cloneonly,$createdbefore,$createdafter,$creationcontext,$domcloner,
1.1287 raeburn 5837: $hasuniquecode,$reqcrsdom,$reqinstcode)=@_;
1.918 raeburn 5838: my $as_hash = 1;
5839: my %returnhash;
5840: if (!$domfilter) { $domfilter=''; }
1.845 albertel 5841: my %libserv = &all_library();
5842: foreach my $tryserver (keys(%libserv)) {
5843: if ( ( $hostidflag == 1
5844: && grep(/^\Q$tryserver\E$/,@{$hostidref}) )
5845: || (!defined($hostidflag)) ) {
5846:
1.918 raeburn 5847: if (($domfilter eq '') ||
5848: (&host_domain($tryserver) eq $domfilter)) {
1.1180 droeschl 5849: my $rep;
5850: if (grep { $_ eq $tryserver } current_machine_ids()) {
5851: $rep = LONCAPA::Lond::dump_course_id_handler(
5852: join(":", (&host_domain($tryserver), $sincefilter,
5853: &escape($descfilter), &escape($instcodefilter),
5854: &escape($ownerfilter), &escape($coursefilter),
5855: &escape($typefilter), &escape($regexp_ok),
5856: $as_hash, &escape($selfenrollonly),
5857: &escape($catfilter), $showhidden, $caller,
5858: &escape($cloner), &escape($cc_clone), $cloneonly,
5859: &escape($createdbefore), &escape($createdafter),
1.1287 raeburn 5860: &escape($creationcontext),$domcloner,$hasuniquecode,
5861: $reqcrsdom,&escape($reqinstcode))));
1.1180 droeschl 5862: } else {
5863: $rep = &reply('courseiddump:'.&host_domain($tryserver).':'.
5864: $sincefilter.':'.&escape($descfilter).':'.
5865: &escape($instcodefilter).':'.&escape($ownerfilter).
5866: ':'.&escape($coursefilter).':'.&escape($typefilter).
5867: ':'.&escape($regexp_ok).':'.$as_hash.':'.
5868: &escape($selfenrollonly).':'.&escape($catfilter).':'.
5869: $showhidden.':'.$caller.':'.&escape($cloner).':'.
5870: &escape($cc_clone).':'.$cloneonly.':'.
5871: &escape($createdbefore).':'.&escape($createdafter).':'.
1.1287 raeburn 5872: &escape($creationcontext).':'.$domcloner.':'.$hasuniquecode.
5873: ':'.$reqcrsdom.':'.&escape($reqinstcode),$tryserver);
1.1180 droeschl 5874: }
5875:
1.918 raeburn 5876: my @pairs=split(/\&/,$rep);
5877: foreach my $item (@pairs) {
5878: my ($key,$value)=split(/\=/,$item,2);
5879: $key = &unescape($key);
5880: next if ($key =~ /^error: 2 /);
5881: my $result = &thaw_unescape($value);
5882: if (ref($result) eq 'HASH') {
5883: $returnhash{$key}=$result;
5884: } else {
1.921 raeburn 5885: my @responses = split(/:/,$value);
5886: my @items = ('description','inst_code','owner','type');
1.918 raeburn 5887: for (my $i=0; $i<@responses; $i++) {
1.921 raeburn 5888: $returnhash{$key}{$items[$i]} = &unescape($responses[$i]);
1.918 raeburn 5889: }
1.1008 raeburn 5890: }
1.353 www 5891: }
5892: }
5893: }
5894: }
5895: return %returnhash;
5896: }
5897:
1.1055 raeburn 5898: sub courselastaccess {
5899: my ($cdom,$cnum,$hostidref) = @_;
5900: my %returnhash;
5901: if ($cdom && $cnum) {
5902: my $chome = &homeserver($cnum,$cdom);
5903: if ($chome ne 'no_host') {
5904: my $rep = &reply('courselastaccess:'.$cdom.':'.$cnum,$chome);
5905: &extract_lastaccess(\%returnhash,$rep);
5906: }
5907: } else {
5908: if (!$cdom) { $cdom=''; }
5909: my %libserv = &all_library();
5910: foreach my $tryserver (keys(%libserv)) {
5911: if (ref($hostidref) eq 'ARRAY') {
5912: next unless (grep(/^\Q$tryserver\E$/,@{$hostidref}));
5913: }
5914: if (($cdom eq '') || (&host_domain($tryserver) eq $cdom)) {
5915: my $rep = &reply('courselastaccess:'.&host_domain($tryserver).':',$tryserver);
5916: &extract_lastaccess(\%returnhash,$rep);
5917: }
5918: }
5919: }
5920: return %returnhash;
5921: }
5922:
5923: sub extract_lastaccess {
5924: my ($returnhash,$rep) = @_;
5925: if (ref($returnhash) eq 'HASH') {
5926: unless ($rep eq 'unknown_command' || $rep eq 'no_such_host' ||
5927: $rep eq 'con_lost' || $rep eq 'rejected' || $rep eq 'refused' ||
5928: $rep eq '') {
5929: my @pairs=split(/\&/,$rep);
5930: foreach my $item (@pairs) {
5931: my ($key,$value)=split(/\=/,$item,2);
5932: $key = &unescape($key);
5933: next if ($key =~ /^error: 2 /);
5934: $returnhash->{$key} = &thaw_unescape($value);
5935: }
5936: }
5937: }
5938: return;
5939: }
5940:
1.658 raeburn 5941: # ---------------------------------------------------------- DC e-mail
1.662 raeburn 5942:
5943: sub dcmailput {
1.685 raeburn 5944: my ($domain,$msgid,$message,$server)=@_;
1.1494 raeburn 5945: my $status = &critical(
1.740 www 5946: 'dcmailput:'.$domain.':'.&escape($msgid).'='.
5947: &escape($message),$server);
1.662 raeburn 5948: return $status;
5949: }
5950:
1.658 raeburn 5951: sub dcmaildump {
5952: my ($dom,$startdate,$enddate,$senders) = @_;
1.685 raeburn 5953: my %returnhash=();
1.846 albertel 5954:
5955: if (defined(&domain($dom,'primary'))) {
1.685 raeburn 5956: my $cmd='dcmaildump:'.$dom.':'.&escape($startdate).':'.
5957: &escape($enddate).':';
5958: my @esc_senders=map { &escape($_)} @$senders;
5959: $cmd.=&escape(join('&',@esc_senders));
1.846 albertel 5960: foreach my $line (split(/\&/,&reply($cmd,&domain($dom,'primary')))) {
1.800 albertel 5961: my ($key,$value) = split(/\=/,$line,2);
1.685 raeburn 5962: if (($key) && ($value)) {
5963: $returnhash{&unescape($key)} = &unescape($value);
1.658 raeburn 5964: }
5965: }
5966: }
5967: return %returnhash;
5968: }
1.662 raeburn 5969: # ---------------------------------------------------------- Domain roles
5970:
5971: sub get_domain_roles {
5972: my ($dom,$roles,$startdate,$enddate)=@_;
1.1018 raeburn 5973: if ((!defined($startdate)) || ($startdate eq '')) {
1.662 raeburn 5974: $startdate = '.';
5975: }
1.1018 raeburn 5976: if ((!defined($enddate)) || ($enddate eq '')) {
1.662 raeburn 5977: $enddate = '.';
5978: }
1.922 raeburn 5979: my $rolelist;
5980: if (ref($roles) eq 'ARRAY') {
1.1219 raeburn 5981: $rolelist = join('&',@{$roles});
1.922 raeburn 5982: }
1.662 raeburn 5983: my %personnel = ();
1.841 albertel 5984:
5985: my %servers = &get_servers($dom,'library');
5986: foreach my $tryserver (keys(%servers)) {
5987: %{$personnel{$tryserver}}=();
5988: foreach my $line (split(/\&/,&reply('domrolesdump:'.$dom.':'.
5989: &escape($startdate).':'.
5990: &escape($enddate).':'.
5991: &escape($rolelist), $tryserver))) {
5992: my ($key,$value) = split(/\=/,$line,2);
5993: if (($key) && ($value)) {
5994: $personnel{$tryserver}{&unescape($key)} = &unescape($value);
5995: }
5996: }
1.662 raeburn 5997: }
5998: return %personnel;
5999: }
1.658 raeburn 6000:
1.1332 raeburn 6001: sub get_active_domroles {
6002: my ($dom,$roles) = @_;
6003: return () unless (ref($roles) eq 'ARRAY');
6004: my $now = time;
6005: my %dompersonnel = &get_domain_roles($dom,$roles,$now,$now);
6006: my %domroles;
6007: foreach my $server (keys(%dompersonnel)) {
6008: foreach my $user (sort(keys(%{$dompersonnel{$server}}))) {
6009: my ($trole,$uname,$udom,$runame,$rudom,$rsec) = split(/:/,$user);
6010: $domroles{$uname.':'.$udom} = $dompersonnel{$server}{$user};
6011: }
6012: }
6013: return %domroles;
6014: }
6015:
1.1057 www 6016: # ----------------------------------------------------------- Interval timing
1.149 www 6017:
1.1153 www 6018: {
6019: # Caches needed for speedup of navmaps
6020: # We don't want to cache this for very long at all (5 seconds at most)
6021: #
6022: # The user for whom we cache
6023: my $cachedkey='';
6024: # The cached times for this user
6025: my %cachedtimes=();
6026: # When this was last done
1.1282 raeburn 6027: my $cachedtime='';
1.1153 www 6028:
6029: sub load_all_first_access {
1.1308 raeburn 6030: my ($uname,$udom,$ignorecache)=@_;
1.1156 www 6031: if (($cachedkey eq $uname.':'.$udom) &&
1.1308 raeburn 6032: (abs($cachedtime-time)<5) && (!$env{'form.markaccess'}) &&
6033: (!$ignorecache)) {
1.1154 raeburn 6034: return;
6035: }
6036: $cachedtime=time;
6037: $cachedkey=$uname.':'.$udom;
6038: %cachedtimes=&dump('firstaccesstimes',$udom,$uname);
1.1153 www 6039: }
6040:
1.504 albertel 6041: sub get_first_access {
1.1308 raeburn 6042: my ($type,$argsymb,$argmap,$ignorecache)=@_;
1.790 albertel 6043: my ($symb,$courseid,$udom,$uname)=&whichuser();
1.504 albertel 6044: if ($argsymb) { $symb=$argsymb; }
6045: my ($map,$id,$res)=&decode_symb($symb);
1.1162 raeburn 6046: if ($argmap) { $map = $argmap; }
1.926 albertel 6047: if ($type eq 'course') {
6048: $res='course';
6049: } elsif ($type eq 'map') {
1.588 albertel 6050: $res=&symbread($map);
6051: } else {
6052: $res=$symb;
6053: }
1.1308 raeburn 6054: &load_all_first_access($uname,$udom,$ignorecache);
1.1153 www 6055: return $cachedtimes{"$courseid\0$res"};
1.504 albertel 6056: }
6057:
6058: sub set_first_access {
1.1162 raeburn 6059: my ($type,$interval)=@_;
1.790 albertel 6060: my ($symb,$courseid,$udom,$uname)=&whichuser();
1.504 albertel 6061: my ($map,$id,$res)=&decode_symb($symb);
1.928 albertel 6062: if ($type eq 'course') {
6063: $res='course';
6064: } elsif ($type eq 'map') {
1.588 albertel 6065: $res=&symbread($map);
6066: } else {
6067: $res=$symb;
6068: }
1.1153 www 6069: $cachedkey='';
1.1162 raeburn 6070: my $firstaccess=&get_first_access($type,$symb,$map);
1.1386 raeburn 6071: if ($firstaccess) {
6072: &logthis("First access time already set ($firstaccess) when attempting ".
1.1393 raeburn 6073: "to set new value (type: $type, extent: $res) for $uname:$udom ".
6074: "in $courseid");
1.1386 raeburn 6075: return 'already_set';
6076: } else {
1.1162 raeburn 6077: my $start = time;
6078: my $putres = &put('firstaccesstimes',{"$courseid\0$res"=>$start},
6079: $udom,$uname);
6080: if ($putres eq 'ok') {
6081: &put('timerinterval',{"$courseid\0$res"=>$interval},
6082: $udom,$uname);
6083: &appenv(
6084: {
6085: 'course.'.$courseid.'.firstaccess.'.$res => $start,
6086: 'course.'.$courseid.'.timerinterval.'.$res => $interval,
6087: }
6088: );
1.1365 raeburn 6089: if (($cachedtime) && (abs($start-$cachedtime) < 5)) {
6090: $cachedtimes{"$courseid\0$res"} = $start;
6091: }
1.1386 raeburn 6092: } elsif ($putres ne 'refused') {
6093: &logthis("Result: $putres when attempting to set first access time ".
6094: "(type: $type, extent: $res) for $uname:$udom in $courseid");
1.1162 raeburn 6095: }
6096: return $putres;
1.505 albertel 6097: }
6098: return 'already_set';
1.504 albertel 6099: }
1.1153 www 6100: }
1.1282 raeburn 6101:
1.110 www 6102: # --------------------------------------------- Set Expire Date for Spreadsheet
6103:
6104: sub expirespread {
6105: my ($uname,$udom,$stype,$usymb)=@_;
1.620 albertel 6106: my $cid=$env{'request.course.id'};
1.110 www 6107: if ($cid) {
6108: my $now=time;
6109: my $key=$uname.':'.$udom.':'.$stype.':'.$usymb;
1.620 albertel 6110: return &reply('put:'.$env{'course.'.$cid.'.domain'}.':'.
6111: $env{'course.'.$cid.'.num'}.
1.110 www 6112: ':nohist_expirationdates:'.
6113: &escape($key).'='.$now,
1.620 albertel 6114: $env{'course.'.$cid.'.home'})
1.110 www 6115: }
6116: return 'ok';
1.14 www 6117: }
6118:
1.109 www 6119: # ----------------------------------------------------- Devalidate Spreadsheets
6120:
6121: sub devalidate {
1.325 www 6122: my ($symb,$uname,$udom)=@_;
1.620 albertel 6123: my $cid=$env{'request.course.id'};
1.109 www 6124: if ($cid) {
1.391 matthew 6125: # delete the stored spreadsheets for
6126: # - the student level sheet of this user in course's homespace
6127: # - the assessment level sheet for this resource
6128: # for this user in user's homespace
1.553 albertel 6129: # - current conditional state info
1.325 www 6130: my $key=$uname.':'.$udom.':';
1.109 www 6131: my $status=
1.299 matthew 6132: &del('nohist_calculatedsheets',
1.391 matthew 6133: [$key.'studentcalc:'],
1.620 albertel 6134: $env{'course.'.$cid.'.domain'},
6135: $env{'course.'.$cid.'.num'})
1.133 albertel 6136: .' '.
6137: &del('nohist_calculatedsheets_'.$cid,
1.391 matthew 6138: [$key.'assesscalc:'.$symb],$udom,$uname);
1.109 www 6139: unless ($status eq 'ok ok') {
6140: &logthis('Could not devalidate spreadsheet '.
1.325 www 6141: $uname.' at '.$udom.' for '.
1.109 www 6142: $symb.': '.$status);
1.133 albertel 6143: }
1.553 albertel 6144: &delenv('user.state.'.$cid);
1.109 www 6145: }
6146: }
6147:
1.265 albertel 6148: sub get_scalar {
6149: my ($string,$end) = @_;
6150: my $value;
6151: if ($$string =~ s/^([^&]*?)($end)/$2/) {
6152: $value = $1;
6153: } elsif ($$string =~ s/^([^&]*?)&//) {
6154: $value = $1;
6155: }
6156: return &unescape($value);
6157: }
6158:
6159: sub array2str {
6160: my (@array) = @_;
6161: my $result=&arrayref2str(\@array);
6162: $result=~s/^__ARRAY_REF__//;
6163: $result=~s/__END_ARRAY_REF__$//;
6164: return $result;
6165: }
6166:
1.204 albertel 6167: sub arrayref2str {
6168: my ($arrayref) = @_;
1.265 albertel 6169: my $result='__ARRAY_REF__';
1.204 albertel 6170: foreach my $elem (@$arrayref) {
1.265 albertel 6171: if(ref($elem) eq 'ARRAY') {
6172: $result.=&arrayref2str($elem).'&';
6173: } elsif(ref($elem) eq 'HASH') {
6174: $result.=&hashref2str($elem).'&';
6175: } elsif(ref($elem)) {
6176: #print("Got a ref of ".(ref($elem))." skipping.");
1.204 albertel 6177: } else {
6178: $result.=&escape($elem).'&';
6179: }
6180: }
6181: $result=~s/\&$//;
1.265 albertel 6182: $result .= '__END_ARRAY_REF__';
1.204 albertel 6183: return $result;
6184: }
6185:
1.168 albertel 6186: sub hash2str {
1.204 albertel 6187: my (%hash) = @_;
6188: my $result=&hashref2str(\%hash);
1.265 albertel 6189: $result=~s/^__HASH_REF__//;
6190: $result=~s/__END_HASH_REF__$//;
1.204 albertel 6191: return $result;
6192: }
6193:
6194: sub hashref2str {
6195: my ($hashref)=@_;
1.265 albertel 6196: my $result='__HASH_REF__';
1.800 albertel 6197: foreach my $key (sort(keys(%$hashref))) {
6198: if (ref($key) eq 'ARRAY') {
6199: $result.=&arrayref2str($key).'=';
6200: } elsif (ref($key) eq 'HASH') {
6201: $result.=&hashref2str($key).'=';
6202: } elsif (ref($key)) {
1.265 albertel 6203: $result.='=';
1.800 albertel 6204: #print("Got a ref of ".(ref($key))." skipping.");
1.204 albertel 6205: } else {
1.1132 raeburn 6206: if (defined($key)) {$result.=&escape($key).'=';} else { last; }
1.204 albertel 6207: }
6208:
1.800 albertel 6209: if(ref($hashref->{$key}) eq 'ARRAY') {
6210: $result.=&arrayref2str($hashref->{$key}).'&';
6211: } elsif(ref($hashref->{$key}) eq 'HASH') {
6212: $result.=&hashref2str($hashref->{$key}).'&';
6213: } elsif(ref($hashref->{$key})) {
1.265 albertel 6214: $result.='&';
1.800 albertel 6215: #print("Got a ref of ".(ref($hashref->{$key}))." skipping.");
1.204 albertel 6216: } else {
1.800 albertel 6217: $result.=&escape($hashref->{$key}).'&';
1.204 albertel 6218: }
6219: }
1.168 albertel 6220: $result=~s/\&$//;
1.265 albertel 6221: $result .= '__END_HASH_REF__';
1.168 albertel 6222: return $result;
6223: }
6224:
6225: sub str2hash {
1.265 albertel 6226: my ($string)=@_;
6227: my ($hash)=&str2hashref('__HASH_REF__'.$string.'__END_HASH_REF__');
6228: return %$hash;
6229: }
6230:
6231: sub str2hashref {
1.168 albertel 6232: my ($string) = @_;
1.265 albertel 6233:
6234: my %hash;
6235:
6236: if($string !~ /^__HASH_REF__/) {
6237: if (! ($string eq '' || !defined($string))) {
6238: $hash{'error'}='Not hash reference';
6239: }
6240: return (\%hash, $string);
6241: }
6242:
6243: $string =~ s/^__HASH_REF__//;
6244:
6245: while($string !~ /^__END_HASH_REF__/) {
6246: #key
6247: my $key='';
6248: if($string =~ /^__HASH_REF__/) {
6249: ($key, $string)=&str2hashref($string);
6250: if(defined($key->{'error'})) {
6251: $hash{'error'}='Bad data';
6252: return (\%hash, $string);
6253: }
6254: } elsif($string =~ /^__ARRAY_REF__/) {
6255: ($key, $string)=&str2arrayref($string);
6256: if($key->[0] eq 'Array reference error') {
6257: $hash{'error'}='Bad data';
6258: return (\%hash, $string);
6259: }
6260: } else {
6261: $string =~ s/^(.*?)=//;
1.267 albertel 6262: $key=&unescape($1);
1.265 albertel 6263: }
6264: $string =~ s/^=//;
6265:
6266: #value
6267: my $value='';
6268: if($string =~ /^__HASH_REF__/) {
6269: ($value, $string)=&str2hashref($string);
6270: if(defined($value->{'error'})) {
6271: $hash{'error'}='Bad data';
6272: return (\%hash, $string);
6273: }
6274: } elsif($string =~ /^__ARRAY_REF__/) {
6275: ($value, $string)=&str2arrayref($string);
6276: if($value->[0] eq 'Array reference error') {
6277: $hash{'error'}='Bad data';
6278: return (\%hash, $string);
6279: }
6280: } else {
6281: $value=&get_scalar(\$string,'__END_HASH_REF__');
6282: }
6283: $string =~ s/^&//;
6284:
6285: $hash{$key}=$value;
1.204 albertel 6286: }
1.265 albertel 6287:
6288: $string =~ s/^__END_HASH_REF__//;
6289:
6290: return (\%hash, $string);
1.204 albertel 6291: }
6292:
6293: sub str2array {
1.265 albertel 6294: my ($string)=@_;
6295: my ($array)=&str2arrayref('__ARRAY_REF__'.$string.'__END_ARRAY_REF__');
6296: return @$array;
6297: }
6298:
6299: sub str2arrayref {
1.204 albertel 6300: my ($string) = @_;
1.265 albertel 6301: my @array;
6302:
6303: if($string !~ /^__ARRAY_REF__/) {
6304: if (! ($string eq '' || !defined($string))) {
6305: $array[0]='Array reference error';
6306: }
6307: return (\@array, $string);
6308: }
6309:
6310: $string =~ s/^__ARRAY_REF__//;
6311:
6312: while($string !~ /^__END_ARRAY_REF__/) {
6313: my $value='';
6314: if($string =~ /^__HASH_REF__/) {
6315: ($value, $string)=&str2hashref($string);
6316: if(defined($value->{'error'})) {
6317: $array[0] ='Array reference error';
6318: return (\@array, $string);
6319: }
6320: } elsif($string =~ /^__ARRAY_REF__/) {
6321: ($value, $string)=&str2arrayref($string);
6322: if($value->[0] eq 'Array reference error') {
6323: $array[0] ='Array reference error';
6324: return (\@array, $string);
6325: }
6326: } else {
6327: $value=&get_scalar(\$string,'__END_ARRAY_REF__');
6328: }
6329: $string =~ s/^&//;
6330:
6331: push(@array, $value);
1.191 harris41 6332: }
1.265 albertel 6333:
6334: $string =~ s/^__END_ARRAY_REF__//;
6335:
6336: return (\@array, $string);
1.168 albertel 6337: }
6338:
1.167 albertel 6339: # -------------------------------------------------------------------Temp Store
6340:
1.168 albertel 6341: sub tmpreset {
6342: my ($symb,$namespace,$domain,$stuname) = @_;
6343: if (!$symb) {
6344: $symb=&symbread();
1.620 albertel 6345: if (!$symb) { $symb= $env{'request.url'}; }
1.168 albertel 6346: }
6347: $symb=escape($symb);
6348:
1.620 albertel 6349: if (!$namespace) { $namespace=$env{'request.state'}; }
1.168 albertel 6350: $namespace=~s/\//\_/g;
6351: $namespace=~s/\W//g;
6352:
1.620 albertel 6353: if (!$domain) { $domain=$env{'user.domain'}; }
6354: if (!$stuname) { $stuname=$env{'user.name'}; }
1.591 albertel 6355: if ($domain eq 'public' && $stuname eq 'public') {
1.1434 raeburn 6356: $stuname=&get_requestor_ip();
1.591 albertel 6357: }
1.1117 foxr 6358: my $path=LONCAPA::tempdir();
1.168 albertel 6359: my %hash;
6360: if (tie(%hash,'GDBM_File',
6361: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
1.256 albertel 6362: &GDBM_WRCREAT(),0640)) {
1.1000 raeburn 6363: foreach my $key (keys(%hash)) {
1.180 albertel 6364: if ($key=~ /:$symb/) {
1.168 albertel 6365: delete($hash{$key});
6366: }
6367: }
6368: }
6369: }
6370:
1.167 albertel 6371: sub tmpstore {
1.168 albertel 6372: my ($storehash,$symb,$namespace,$domain,$stuname) = @_;
6373:
6374: if (!$symb) {
6375: $symb=&symbread();
1.620 albertel 6376: if (!$symb) { $symb= $env{'request.url'}; }
1.168 albertel 6377: }
6378: $symb=escape($symb);
6379:
6380: if (!$namespace) {
6381: # I don't think we would ever want to store this for a course.
6382: # it seems this will only be used if we don't have a course.
1.620 albertel 6383: #$namespace=$env{'request.course.id'};
1.168 albertel 6384: #if (!$namespace) {
1.620 albertel 6385: $namespace=$env{'request.state'};
1.168 albertel 6386: #}
6387: }
6388: $namespace=~s/\//\_/g;
6389: $namespace=~s/\W//g;
1.620 albertel 6390: if (!$domain) { $domain=$env{'user.domain'}; }
6391: if (!$stuname) { $stuname=$env{'user.name'}; }
1.591 albertel 6392: if ($domain eq 'public' && $stuname eq 'public') {
1.1434 raeburn 6393: $stuname=&get_requestor_ip();
1.591 albertel 6394: }
1.168 albertel 6395: my $now=time;
6396: my %hash;
1.1117 foxr 6397: my $path=LONCAPA::tempdir();
1.168 albertel 6398: if (tie(%hash,'GDBM_File',
6399: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
1.256 albertel 6400: &GDBM_WRCREAT(),0640)) {
1.168 albertel 6401: $hash{"version:$symb"}++;
6402: my $version=$hash{"version:$symb"};
6403: my $allkeys='';
6404: foreach my $key (keys(%$storehash)) {
6405: $allkeys.=$key.':';
1.591 albertel 6406: $hash{"$version:$symb:$key"}=&freeze_escape($$storehash{$key});
1.168 albertel 6407: }
6408: $hash{"$version:$symb:timestamp"}=$now;
6409: $allkeys.='timestamp';
6410: $hash{"$version:keys:$symb"}=$allkeys;
6411: if (untie(%hash)) {
6412: return 'ok';
6413: } else {
6414: return "error:$!";
6415: }
6416: } else {
6417: return "error:$!";
6418: }
6419: }
1.167 albertel 6420:
1.168 albertel 6421: # -----------------------------------------------------------------Temp Restore
1.167 albertel 6422:
1.168 albertel 6423: sub tmprestore {
6424: my ($symb,$namespace,$domain,$stuname) = @_;
1.167 albertel 6425:
1.168 albertel 6426: if (!$symb) {
6427: $symb=&symbread();
1.620 albertel 6428: if (!$symb) { $symb= $env{'request.url'}; }
1.168 albertel 6429: }
6430: $symb=escape($symb);
6431:
1.620 albertel 6432: if (!$namespace) { $namespace=$env{'request.state'}; }
1.591 albertel 6433:
1.620 albertel 6434: if (!$domain) { $domain=$env{'user.domain'}; }
6435: if (!$stuname) { $stuname=$env{'user.name'}; }
1.591 albertel 6436: if ($domain eq 'public' && $stuname eq 'public') {
1.1434 raeburn 6437: $stuname=&get_requestor_ip();
1.591 albertel 6438: }
1.168 albertel 6439: my %returnhash;
6440: $namespace=~s/\//\_/g;
6441: $namespace=~s/\W//g;
6442: my %hash;
1.1117 foxr 6443: my $path=LONCAPA::tempdir();
1.168 albertel 6444: if (tie(%hash,'GDBM_File',
6445: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
1.256 albertel 6446: &GDBM_READER(),0640)) {
1.168 albertel 6447: my $version=$hash{"version:$symb"};
6448: $returnhash{'version'}=$version;
6449: my $scope;
6450: for ($scope=1;$scope<=$version;$scope++) {
6451: my $vkeys=$hash{"$scope:keys:$symb"};
6452: my @keys=split(/:/,$vkeys);
6453: my $key;
6454: $returnhash{"$scope:keys"}=$vkeys;
6455: foreach $key (@keys) {
1.591 albertel 6456: $returnhash{"$scope:$key"}=&thaw_unescape($hash{"$scope:$symb:$key"});
6457: $returnhash{"$key"}=&thaw_unescape($hash{"$scope:$symb:$key"});
1.167 albertel 6458: }
6459: }
1.168 albertel 6460: if (!(untie(%hash))) {
6461: return "error:$!";
6462: }
6463: } else {
6464: return "error:$!";
6465: }
6466: return %returnhash;
1.167 albertel 6467: }
6468:
1.9 www 6469: # ----------------------------------------------------------------------- Store
6470:
6471: sub store {
1.1269 raeburn 6472: my ($storehash,$symb,$namespace,$domain,$stuname,$laststore) = @_;
1.124 www 6473: my $home='';
6474:
1.168 albertel 6475: if ($stuname) { $home=&homeserver($stuname,$domain); }
1.124 www 6476:
1.213 www 6477: $symb=&symbclean($symb);
1.122 albertel 6478: if (!$symb) { unless ($symb=&symbread()) { return ''; } }
1.109 www 6479:
1.620 albertel 6480: if (!$domain) { $domain=$env{'user.domain'}; }
6481: if (!$stuname) { $stuname=$env{'user.name'}; }
1.325 www 6482:
6483: &devalidate($symb,$stuname,$domain);
1.109 www 6484:
6485: $symb=escape($symb);
1.187 www 6486: if (!$namespace) {
1.620 albertel 6487: unless ($namespace=$env{'request.course.id'}) {
1.187 www 6488: return '';
6489: }
6490: }
1.620 albertel 6491: if (!$home) { $home=$env{'user.home'}; }
1.447 www 6492:
1.1434 raeburn 6493: $$storehash{'ip'}=&get_requestor_ip();
1.447 www 6494: $$storehash{'host'}=$perlvar{'lonHostID'};
6495:
1.12 www 6496: my $namevalue='';
1.800 albertel 6497: foreach my $key (keys(%$storehash)) {
6498: $namevalue.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
1.191 harris41 6499: }
1.12 www 6500: $namevalue=~s/\&$//;
1.187 www 6501: &courselog($symb.':'.$stuname.':'.$domain.':STORE:'.$namevalue);
1.1269 raeburn 6502: return reply("store:$domain:$stuname:$namespace:$symb:$namevalue:$laststore","$home");
1.9 www 6503: }
6504:
1.47 www 6505: # -------------------------------------------------------------- Critical Store
6506:
6507: sub cstore {
1.1269 raeburn 6508: my ($storehash,$symb,$namespace,$domain,$stuname,$laststore) = @_;
1.124 www 6509: my $home='';
6510:
1.168 albertel 6511: if ($stuname) { $home=&homeserver($stuname,$domain); }
1.124 www 6512:
1.213 www 6513: $symb=&symbclean($symb);
1.122 albertel 6514: if (!$symb) { unless ($symb=&symbread()) { return ''; } }
1.109 www 6515:
1.620 albertel 6516: if (!$domain) { $domain=$env{'user.domain'}; }
6517: if (!$stuname) { $stuname=$env{'user.name'}; }
1.325 www 6518:
6519: &devalidate($symb,$stuname,$domain);
1.109 www 6520:
6521: $symb=escape($symb);
1.187 www 6522: if (!$namespace) {
1.620 albertel 6523: unless ($namespace=$env{'request.course.id'}) {
1.187 www 6524: return '';
6525: }
6526: }
1.620 albertel 6527: if (!$home) { $home=$env{'user.home'}; }
1.447 www 6528:
1.1434 raeburn 6529: $$storehash{'ip'}=&get_requestor_ip();
1.447 www 6530: $$storehash{'host'}=$perlvar{'lonHostID'};
1.122 albertel 6531:
1.47 www 6532: my $namevalue='';
1.800 albertel 6533: foreach my $key (keys(%$storehash)) {
6534: $namevalue.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
1.191 harris41 6535: }
1.47 www 6536: $namevalue=~s/\&$//;
1.187 www 6537: &courselog($symb.':'.$stuname.':'.$domain.':CSTORE:'.$namevalue);
1.188 www 6538: return critical
1.1269 raeburn 6539: ("store:$domain:$stuname:$namespace:$symb:$namevalue:$laststore","$home");
1.47 www 6540: }
6541:
1.9 www 6542: # --------------------------------------------------------------------- Restore
6543:
6544: sub restore {
1.124 www 6545: my ($symb,$namespace,$domain,$stuname) = @_;
6546: my $home='';
6547:
1.168 albertel 6548: if ($stuname) { $home=&homeserver($stuname,$domain); }
1.124 www 6549:
1.122 albertel 6550: if (!$symb) {
1.1224 raeburn 6551: return if ($namespace eq 'courserequests');
6552: unless ($symb=escape(&symbread())) { return ''; }
1.122 albertel 6553: } else {
1.1224 raeburn 6554: unless ($namespace eq 'courserequests') {
6555: $symb=&escape(&symbclean($symb));
6556: }
1.122 albertel 6557: }
1.188 www 6558: if (!$namespace) {
1.620 albertel 6559: unless ($namespace=$env{'request.course.id'}) {
1.188 www 6560: return '';
6561: }
6562: }
1.620 albertel 6563: if (!$domain) { $domain=$env{'user.domain'}; }
6564: if (!$stuname) { $stuname=$env{'user.name'}; }
6565: if (!$home) { $home=$env{'user.home'}; }
1.122 albertel 6566: my $answer=&reply("restore:$domain:$stuname:$namespace:$symb","$home");
6567:
1.12 www 6568: my %returnhash=();
1.800 albertel 6569: foreach my $line (split(/\&/,$answer)) {
6570: my ($name,$value)=split(/\=/,$line);
1.591 albertel 6571: $returnhash{&unescape($name)}=&thaw_unescape($value);
1.191 harris41 6572: }
1.75 www 6573: my $version;
6574: for ($version=1;$version<=$returnhash{'version'};$version++) {
1.800 albertel 6575: foreach my $item (split(/\:/,$returnhash{$version.':keys'})) {
6576: $returnhash{$item}=$returnhash{$version.':'.$item};
1.191 harris41 6577: }
1.75 www 6578: }
1.13 www 6579: return %returnhash;
1.34 www 6580: }
6581:
6582: # ---------------------------------------------------------- Course Description
1.1118 foxr 6583: #
6584: #
1.34 www 6585:
6586: sub coursedescription {
1.731 albertel 6587: my ($courseid,$args)=@_;
1.34 www 6588: $courseid=~s/^\///;
1.49 www 6589: $courseid=~s/\_/\//g;
1.34 www 6590: my ($cdomain,$cnum)=split(/\//,$courseid);
1.129 albertel 6591: my $chome=&homeserver($cnum,$cdomain);
1.302 albertel 6592: my $normalid=$cdomain.'_'.$cnum;
6593: # need to always cache even if we get errors otherwise we keep
6594: # trying and trying and trying to get the course description.
6595: my %envhash=();
6596: my %returnhash=();
1.731 albertel 6597:
6598: my $expiretime=600;
6599: if ($env{'request.course.id'} eq $normalid) {
6600: $expiretime=120;
6601: }
6602:
6603: my $prefix='course.'.$cdomain.'_'.$cnum.'.';
6604: if (!$args->{'freshen_cache'}
6605: && ((time-$env{$prefix.'last_cache'}) < $expiretime) ) {
6606: foreach my $key (keys(%env)) {
6607: next if ($key !~ /^\Q$prefix\E(.*)/);
6608: my ($setting) = $1;
6609: $returnhash{$setting} = $env{$key};
6610: }
6611: return %returnhash;
6612: }
6613:
1.1118 foxr 6614: # get the data again
6615:
1.731 albertel 6616: if (!$args->{'one_time'}) {
6617: $envhash{'course.'.$normalid.'.last_cache'}=time;
6618: }
1.811 albertel 6619:
1.34 www 6620: if ($chome ne 'no_host') {
1.302 albertel 6621: %returnhash=&dump('environment',$cdomain,$cnum);
1.129 albertel 6622: if (!exists($returnhash{'con_lost'})) {
1.1118 foxr 6623: my $username = $env{'user.name'}; # Defult username
6624: if(defined $args->{'user'}) {
6625: $username = $args->{'user'};
6626: }
1.129 albertel 6627: $returnhash{'home'}= $chome;
6628: $returnhash{'domain'} = $cdomain;
6629: $returnhash{'num'} = $cnum;
1.741 raeburn 6630: if (!defined($returnhash{'type'})) {
6631: $returnhash{'type'} = 'Course';
6632: }
1.130 albertel 6633: while (my ($name,$value) = each %returnhash) {
1.53 www 6634: $envhash{'course.'.$normalid.'.'.$name}=$value;
1.129 albertel 6635: }
1.270 www 6636: $returnhash{'url'}=&clutter($returnhash{'url'});
1.1117 foxr 6637: $returnhash{'fn'}=LONCAPA::tempdir() .
1.1118 foxr 6638: $username.'_'.$cdomain.'_'.$cnum;
1.60 www 6639: $envhash{'course.'.$normalid.'.home'}=$chome;
6640: $envhash{'course.'.$normalid.'.domain'}=$cdomain;
6641: $envhash{'course.'.$normalid.'.num'}=$cnum;
1.34 www 6642: }
6643: }
1.731 albertel 6644: if (!$args->{'one_time'}) {
1.949 raeburn 6645: &appenv(\%envhash);
1.731 albertel 6646: }
1.302 albertel 6647: return %returnhash;
1.461 www 6648: }
6649:
1.1080 raeburn 6650: sub update_released_required {
6651: my ($needsrelease,$cdom,$cnum,$chome,$cid) = @_;
6652: if ($cdom eq '' || $cnum eq '' || $chome eq '' || $cid eq '') {
6653: $cid = $env{'request.course.id'};
6654: $cdom = $env{'course.'.$cid.'.domain'};
6655: $cnum = $env{'course.'.$cid.'.num'};
6656: $chome = $env{'course.'.$cid.'.home'};
6657: }
6658: if ($needsrelease) {
6659: my %curr_reqd_hash = &userenvironment($cdom,$cnum,'internal.releaserequired');
6660: my $needsupdate;
6661: if ($curr_reqd_hash{'internal.releaserequired'} eq '') {
6662: $needsupdate = 1;
6663: } else {
6664: my ($currmajor,$currminor) = split(/\./,$curr_reqd_hash{'internal.releaserequired'});
6665: my ($needsmajor,$needsminor) = split(/\./,$needsrelease);
6666: if (($currmajor < $needsmajor) || ($currmajor == $needsmajor && $currminor < $needsminor)) {
6667: $needsupdate = 1;
6668: }
6669: }
6670: if ($needsupdate) {
6671: my %needshash = (
6672: 'internal.releaserequired' => $needsrelease,
6673: );
6674: my $putresult = &put('environment',\%needshash,$cdom,$cnum);
6675: if ($putresult eq 'ok') {
6676: &appenv({'course.'.$cid.'.internal.releaserequired' => $needsrelease});
6677: my %crsinfo = &courseiddump($cdom,'.',1,'.','.',$cnum,undef,undef,'.');
6678: if (ref($crsinfo{$cid}) eq 'HASH') {
6679: $crsinfo{$cid}{'releaserequired'} = $needsrelease;
6680: &courseidput($cdom,\%crsinfo,$chome,'notime');
6681: }
6682: }
6683: }
6684: }
6685: return;
6686: }
6687:
1.461 www 6688: # -------------------------------------------------See if a user is privileged
6689:
6690: sub privileged {
1.1219 raeburn 6691: my ($username,$domain,$possdomains,$possroles)=@_;
1.1170 droeschl 6692: my $now = time;
1.1219 raeburn 6693: my $roles;
6694: if (ref($possroles) eq 'ARRAY') {
6695: $roles = $possroles;
6696: } else {
6697: $roles = ['dc','su'];
6698: }
6699: if (ref($possdomains) eq 'ARRAY') {
6700: my %privileged = &privileged_by_domain($possdomains,$roles);
6701: foreach my $dom (@{$possdomains}) {
6702: if (($username =~ /^$match_username$/) && ($domain =~ /^$match_domain$/) &&
6703: (ref($privileged{$dom}) eq 'HASH')) {
6704: foreach my $role (@{$roles}) {
6705: if (ref($privileged{$dom}{$role}) eq 'HASH') {
6706: if (exists($privileged{$dom}{$role}{$username.':'.$domain})) {
6707: my ($end,$start) = split(/:/,$privileged{$dom}{$role}{$username.':'.$domain});
6708: return 1 unless (($end && $end < $now) ||
6709: ($start && $start > $now));
6710: }
6711: }
6712: }
6713: }
6714: }
6715: } else {
6716: my %rolesdump = &dump("roles", $domain, $username) or return 0;
6717: my $now = time;
1.1170 droeschl 6718:
1.1275 musolffc 6719: for my $role (@rolesdump{grep { ! /^rolesdef_/ } keys(%rolesdump)}) {
1.1170 droeschl 6720: my ($trole, $tend, $tstart) = split(/_/, $role);
1.1219 raeburn 6721: if (grep(/^\Q$trole\E$/,@{$roles})) {
1.1170 droeschl 6722: return 1 unless ($tend && $tend < $now)
1.1219 raeburn 6723: or ($tstart && $tstart > $now);
1.1170 droeschl 6724: }
1.1219 raeburn 6725: }
6726: }
6727: return 0;
6728: }
1.1170 droeschl 6729:
1.1219 raeburn 6730: sub privileged_by_domain {
6731: my ($domains,$roles) = @_;
6732: my %privileged = ();
6733: my $cachetime = 60*60*24;
6734: my $now = time;
6735: unless ((ref($domains) eq 'ARRAY') && (ref($roles) eq 'ARRAY')) {
6736: return %privileged;
6737: }
6738: foreach my $dom (@{$domains}) {
6739: next if (ref($privileged{$dom}) eq 'HASH');
6740: my $needroles;
6741: foreach my $role (@{$roles}) {
6742: my ($result,$cached)=&is_cached_new('priv_'.$role,$dom);
6743: if (defined($cached)) {
6744: if (ref($result) eq 'HASH') {
6745: $privileged{$dom}{$role} = $result;
6746: }
6747: } else {
6748: $needroles = 1;
6749: }
6750: }
6751: if ($needroles) {
6752: my %dompersonnel = &get_domain_roles($dom,$roles);
6753: $privileged{$dom} = {};
6754: foreach my $server (keys(%dompersonnel)) {
6755: if (ref($dompersonnel{$server}) eq 'HASH') {
6756: foreach my $item (keys(%{$dompersonnel{$server}})) {
6757: my ($trole,$uname,$udom,$rest) = split(/:/,$item,4);
6758: my ($end,$start) = split(/:/,$dompersonnel{$server}{$item});
6759: next if ($end && $end < $now);
6760: $privileged{$dom}{$trole}{$uname.':'.$udom} =
6761: $dompersonnel{$server}{$item};
6762: }
6763: }
6764: }
6765: if (ref($privileged{$dom}) eq 'HASH') {
6766: foreach my $role (@{$roles}) {
6767: if (ref($privileged{$dom}{$role}) eq 'HASH') {
6768: &do_cache_new('priv_'.$role,$dom,$privileged{$dom}{$role},$cachetime);
6769: } else {
6770: my %hash = ();
6771: &do_cache_new('priv_'.$role,$dom,\%hash,$cachetime);
6772: }
6773: }
6774: }
6775: }
6776: }
6777: return %privileged;
1.9 www 6778: }
1.1 albertel 6779:
1.103 harris41 6780: # -------------------------------------------------------- Get user privileges
1.11 www 6781:
6782: sub rolesinit {
1.1169 droeschl 6783: my ($domain, $username) = @_;
6784: my %userroles = ('user.login.time' => time);
6785: my %rolesdump = &dump("roles", $domain, $username) or return \%userroles;
6786:
6787: # firstaccess and timerinterval are related to timed maps/resources.
6788: # also, blocking can be triggered by an activating timer
6789: # it's saved in the user's %env.
6790: my %firstaccess = &dump('firstaccesstimes', $domain, $username);
6791: my %timerinterval = &dump('timerinterval', $domain, $username);
6792: my (%coursetimerstarts, %firstaccchk, %firstaccenv, %coursetimerintervals,
6793: %timerintchk, %timerintenv);
6794:
1.1162 raeburn 6795: foreach my $key (keys(%firstaccess)) {
1.1169 droeschl 6796: my ($cid, $rest) = split(/\0/, $key);
1.1162 raeburn 6797: $coursetimerstarts{$cid}{$rest} = $firstaccess{$key};
6798: }
1.1169 droeschl 6799:
1.1162 raeburn 6800: foreach my $key (keys(%timerinterval)) {
6801: my ($cid,$rest) = split(/\0/,$key);
6802: $coursetimerintervals{$cid}{$rest} = $timerinterval{$key};
6803: }
1.1169 droeschl 6804:
1.11 www 6805: my %allroles=();
1.1162 raeburn 6806: my %allgroups=();
1.11 www 6807:
1.1274 raeburn 6808: for my $area (grep { ! /^rolesdef_/ } keys(%rolesdump)) {
1.1169 droeschl 6809: my $role = $rolesdump{$area};
6810: $area =~ s/\_\w\w$//;
6811:
6812: my ($trole, $tend, $tstart, $group_privs);
6813:
6814: if ($role =~ /^cr/) {
6815: # Custom role, defined by a user
6816: # e.g., user.role.cr/msu/smith/mynewrole
6817: if ($role =~ m|^(cr/$match_domain/$match_username/[a-zA-Z0-9]+)_(.*)$|) {
6818: $trole = $1;
6819: ($tend, $tstart) = split('_', $2);
6820: } else {
6821: $trole = $role;
6822: }
6823: } elsif ($role =~ m|^gr/|) {
6824: # Role of member in a group, defined within a course/community
6825: # e.g., user.role.gr/msu/04935610a19ee4a5fmsul1/leopards
6826: ($trole, $tend, $tstart) = split(/_/, $role);
6827: next if $tstart eq '-1';
6828: ($trole, $group_privs) = split(/\//, $trole);
6829: $group_privs = &unescape($group_privs);
6830: } else {
6831: # Just a normal role, defined in roles.tab
6832: ($trole, $tend, $tstart) = split(/_/,$role);
6833: }
6834:
6835: my %new_role = &set_arearole($trole,$area,$tstart,$tend,$domain,
6836: $username);
6837: @userroles{keys(%new_role)} = @new_role{keys(%new_role)};
6838:
6839: # role expired or not available yet?
6840: $trole = '' if ($tend != 0 && $tend < $userroles{'user.login.time'}) or
6841: ($tstart != 0 && $tstart > $userroles{'user.login.time'});
6842:
6843: next if $area eq '' or $trole eq '';
6844:
6845: my $spec = "$trole.$area";
6846: my ($tdummy, $tdomain, $trest) = split(/\//, $area);
6847:
6848: if ($trole =~ /^cr\//) {
6849: # Custom role, defined by a user
6850: &custom_roleprivs(\%allroles,$trole,$tdomain,$trest,$spec,$area);
6851: } elsif ($trole eq 'gr') {
6852: # Role of a member in a group, defined within a course/community
6853: &group_roleprivs(\%allgroups,$area,$group_privs,$tend,$tstart);
6854: next;
6855: } else {
6856: # Normal role, defined in roles.tab
6857: &standard_roleprivs(\%allroles,$trole,$tdomain,$spec,$trest,$area);
6858: }
6859:
6860: my $cid = $tdomain.'_'.$trest;
6861: unless ($firstaccchk{$cid}) {
6862: if (ref($coursetimerstarts{$cid}) eq 'HASH') {
6863: foreach my $item (keys(%{$coursetimerstarts{$cid}})) {
6864: $firstaccenv{'course.'.$cid.'.firstaccess.'.$item} =
6865: $coursetimerstarts{$cid}{$item};
6866: }
6867: }
6868: $firstaccchk{$cid} = 1;
6869: }
6870: unless ($timerintchk{$cid}) {
6871: if (ref($coursetimerintervals{$cid}) eq 'HASH') {
6872: foreach my $item (keys(%{$coursetimerintervals{$cid}})) {
6873: $timerintenv{'course.'.$cid.'.timerinterval.'.$item} =
6874: $coursetimerintervals{$cid}{$item};
1.1162 raeburn 6875: }
1.12 www 6876: }
1.1169 droeschl 6877: $timerintchk{$cid} = 1;
1.191 harris41 6878: }
1.11 www 6879: }
1.1169 droeschl 6880:
1.1341 raeburn 6881: @userroles{'user.author','user.adv','user.rar'} = &set_userprivs(\%userroles,
6882: \%allroles, \%allgroups);
1.1169 droeschl 6883: $env{'user.adv'} = $userroles{'user.adv'};
1.1341 raeburn 6884: $env{'user.rar'} = $userroles{'user.rar'};
1.1169 droeschl 6885:
1.1162 raeburn 6886: return (\%userroles,\%firstaccenv,\%timerintenv);
1.11 www 6887: }
6888:
1.567 raeburn 6889: sub set_arearole {
1.1215 raeburn 6890: my ($trole,$area,$tstart,$tend,$domain,$username,$nolog) = @_;
6891: unless ($nolog) {
1.567 raeburn 6892: # log the associated role with the area
1.1215 raeburn 6893: &userrolelog($trole,$username,$domain,$area,$tstart,$tend);
6894: }
1.743 albertel 6895: return ('user.role.'.$trole.'.'.$area => $tstart.'.'.$tend);
1.567 raeburn 6896: }
6897:
6898: sub custom_roleprivs {
6899: my ($allroles,$trole,$tdomain,$trest,$spec,$area) = @_;
6900: my ($rdummy,$rdomain,$rauthor,$rrole)=split(/\//,$trole);
1.1250 raeburn 6901: my $homsvr = &homeserver($rauthor,$rdomain);
1.838 albertel 6902: if (&hostname($homsvr) ne '') {
1.567 raeburn 6903: my ($rdummy,$roledef)=
6904: &get('roles',["rolesdef_$rrole"],$rdomain,$rauthor);
6905: if (($rdummy ne 'con_lost') && ($roledef ne '')) {
6906: my ($syspriv,$dompriv,$coursepriv)=split(/\_/,$roledef);
6907: if (defined($syspriv)) {
1.1043 raeburn 6908: if ($trest =~ /^$match_community$/) {
6909: $syspriv =~ s/bre\&S//;
6910: }
1.567 raeburn 6911: $$allroles{'cm./'}.=':'.$syspriv;
6912: $$allroles{$spec.'./'}.=':'.$syspriv;
6913: }
6914: if ($tdomain ne '') {
6915: if (defined($dompriv)) {
6916: $$allroles{'cm./'.$tdomain.'/'}.=':'.$dompriv;
6917: $$allroles{$spec.'./'.$tdomain.'/'}.=':'.$dompriv;
6918: }
6919: if (($trest ne '') && (defined($coursepriv))) {
1.1332 raeburn 6920: if ($trole =~ m{^cr/$tdomain/$tdomain\Q-domainconfig\E/([^/]+)$}) {
6921: my $rolename = $1;
6922: $coursepriv = &course_adhocrole_privs($rolename,$tdomain,$trest,$coursepriv);
6923: }
1.567 raeburn 6924: $$allroles{'cm.'.$area}.=':'.$coursepriv;
6925: $$allroles{$spec.'.'.$area}.=':'.$coursepriv;
6926: }
6927: }
6928: }
6929: }
6930: }
6931:
1.1332 raeburn 6932: sub course_adhocrole_privs {
6933: my ($rolename,$cdom,$cnum,$coursepriv) = @_;
6934: my %overrides = &get('environment',["internal.adhocpriv.$rolename"],$cdom,$cnum);
6935: if ($overrides{"internal.adhocpriv.$rolename"}) {
6936: my (%currprivs,%storeprivs);
6937: foreach my $item (split(/:/,$coursepriv)) {
6938: my ($priv,$restrict) = split(/\&/,$item);
6939: $currprivs{$priv} = $restrict;
6940: }
6941: my (%possadd,%possremove,%full);
6942: foreach my $item (split(/\:/,$Apache::lonnet::pr{'cr:c'})) {
6943: my ($priv,$restrict)=split(/\&/,$item);
6944: $full{$priv} = $restrict;
6945: }
6946: foreach my $item (split(/,/,$overrides{"internal.adhocpriv.$rolename"})) {
1.1490 raeburn 6947: next if ($item eq '');
6948: my ($rule,$rest) = split(/=/,$item);
6949: next unless (($rule eq 'off') || ($rule eq 'on'));
6950: foreach my $priv (split(/:/,$rest)) {
6951: if ($priv ne '') {
6952: if ($rule eq 'off') {
6953: $possremove{$priv} = 1;
6954: } else {
6955: $possadd{$priv} = 1;
6956: }
6957: }
6958: }
6959: }
6960: foreach my $priv (sort(keys(%full))) {
6961: if (exists($currprivs{$priv})) {
6962: unless (exists($possremove{$priv})) {
6963: $storeprivs{$priv} = $currprivs{$priv};
6964: }
6965: } elsif (exists($possadd{$priv})) {
6966: $storeprivs{$priv} = $full{$priv};
6967: }
6968: }
6969: $coursepriv = ':'.join(':',map { $_.'&'.$storeprivs{$_}; } sort(keys(%storeprivs)));
6970: }
6971: return $coursepriv;
1.1332 raeburn 6972: }
6973:
1.678 raeburn 6974: sub group_roleprivs {
6975: my ($allgroups,$area,$group_privs,$tend,$tstart) = @_;
6976: my $access = 1;
6977: my $now = time;
6978: if (($tend!=0) && ($tend<$now)) { $access = 0; }
6979: if (($tstart!=0) && ($tstart>$now)) { $access=0; }
6980: if ($access) {
1.811 albertel 6981: my ($course,$group) = ($area =~ m|(/$match_domain/$match_courseid)/([^/]+)$|);
1.678 raeburn 6982: $$allgroups{$course}{$group} .=':'.$group_privs;
6983: }
6984: }
1.567 raeburn 6985:
6986: sub standard_roleprivs {
6987: my ($allroles,$trole,$tdomain,$spec,$trest,$area) = @_;
6988: if (defined($pr{$trole.':s'})) {
6989: $$allroles{'cm./'}.=':'.$pr{$trole.':s'};
6990: $$allroles{$spec.'./'}.=':'.$pr{$trole.':s'};
6991: }
6992: if ($tdomain ne '') {
6993: if (defined($pr{$trole.':d'})) {
6994: $$allroles{'cm./'.$tdomain.'/'}.=':'.$pr{$trole.':d'};
6995: $$allroles{$spec.'./'.$tdomain.'/'}.=':'.$pr{$trole.':d'};
6996: }
6997: if (($trest ne '') && (defined($pr{$trole.':c'}))) {
6998: $$allroles{'cm.'.$area}.=':'.$pr{$trole.':c'};
6999: $$allroles{$spec.'.'.$area}.=':'.$pr{$trole.':c'};
7000: }
7001: }
7002: }
7003:
7004: sub set_userprivs {
1.1064 raeburn 7005: my ($userroles,$allroles,$allgroups,$groups_roles) = @_;
1.567 raeburn 7006: my $author=0;
7007: my $adv=0;
1.1341 raeburn 7008: my $rar=0;
1.678 raeburn 7009: my %grouproles = ();
7010: if (keys(%{$allgroups}) > 0) {
1.1064 raeburn 7011: my @groupkeys;
1.1000 raeburn 7012: foreach my $role (keys(%{$allroles})) {
1.1064 raeburn 7013: push(@groupkeys,$role);
7014: }
7015: if (ref($groups_roles) eq 'HASH') {
7016: foreach my $key (keys(%{$groups_roles})) {
7017: unless (grep(/^\Q$key\E$/,@groupkeys)) {
7018: push(@groupkeys,$key);
7019: }
7020: }
7021: }
7022: if (@groupkeys > 0) {
7023: foreach my $role (@groupkeys) {
7024: my ($trole,$area,$sec,$extendedarea);
7025: if ($role =~ m-^(\w+|cr/$match_domain/$match_username/\w+)\.(/$match_domain/$match_courseid)(/?\w*)\.-) {
7026: $trole = $1;
7027: $area = $2;
7028: $sec = $3;
7029: $extendedarea = $area.$sec;
7030: if (exists($$allgroups{$area})) {
7031: foreach my $group (keys(%{$$allgroups{$area}})) {
7032: my $spec = $trole.'.'.$extendedarea;
7033: $grouproles{$spec.'.'.$area.'/'.$group} =
1.681 raeburn 7034: $$allgroups{$area}{$group};
1.1064 raeburn 7035: }
1.678 raeburn 7036: }
7037: }
7038: }
7039: }
7040: }
1.800 albertel 7041: foreach my $group (keys(%grouproles)) {
7042: $$allroles{$group} = $grouproles{$group};
1.678 raeburn 7043: }
1.800 albertel 7044: foreach my $role (keys(%{$allroles})) {
7045: my %thesepriv;
1.941 raeburn 7046: if (($role=~/^au/) || ($role=~/^ca/) || ($role=~/^aa/)) { $author=1; }
1.800 albertel 7047: foreach my $item (split(/:/,$$allroles{$role})) {
7048: if ($item ne '') {
7049: my ($privilege,$restrictions)=split(/&/,$item);
1.567 raeburn 7050: if ($restrictions eq '') {
7051: $thesepriv{$privilege}='F';
7052: } elsif ($thesepriv{$privilege} ne 'F') {
7053: $thesepriv{$privilege}.=$restrictions;
7054: }
7055: if ($thesepriv{'adv'} eq 'F') { $adv=1; }
1.1341 raeburn 7056: if ($thesepriv{'rar'} eq 'F') { $rar=1; }
1.567 raeburn 7057: }
7058: }
7059: my $thesestr='';
1.1104 raeburn 7060: foreach my $priv (sort(keys(%thesepriv))) {
1.800 albertel 7061: $thesestr.=':'.$priv.'&'.$thesepriv{$priv};
7062: }
7063: $userroles->{'user.priv.'.$role} = $thesestr;
1.567 raeburn 7064: }
1.1341 raeburn 7065: return ($author,$adv,$rar);
1.567 raeburn 7066: }
7067:
1.994 raeburn 7068: sub role_status {
1.1104 raeburn 7069: my ($rolekey,$update,$refresh,$now,$role,$where,$trolecode,$tstatus,$tstart,$tend) = @_;
1.994 raeburn 7070: if (exists($env{$rolekey}) && $env{$rolekey} ne '') {
1.1250 raeburn 7071: my ($one,$two) = split(m{\./},$rolekey,2);
7072: (undef,undef,$$role) = split(/\./,$one,3);
1.994 raeburn 7073: unless (!defined($$role) || $$role eq '') {
1.1251 raeburn 7074: $$where = '/'.$two;
1.994 raeburn 7075: $$trolecode=$$role.'.'.$$where;
7076: ($$tstart,$$tend)=split(/\./,$env{$rolekey});
7077: $$tstatus='is';
1.1104 raeburn 7078: if ($$tstart && $$tstart>$update) {
1.994 raeburn 7079: $$tstatus='future';
1.1034 raeburn 7080: if ($$tstart<$now) {
7081: if ($$tstart && $$tstart>$refresh) {
1.1002 raeburn 7082: if (($$where ne '') && ($$role ne '')) {
1.1064 raeburn 7083: my (%allroles,%allgroups,$group_privs,
7084: %groups_roles,@rolecodes);
1.1002 raeburn 7085: my %userroles = (
7086: 'user.role.'.$$role.'.'.$$where => $$tstart.'.'.$$tend
7087: );
1.1064 raeburn 7088: @rolecodes = ('cm');
1.1002 raeburn 7089: my $spec=$$role.'.'.$$where;
7090: my ($tdummy,$tdomain,$trest)=split(/\//,$$where);
7091: if ($$role =~ /^cr\//) {
7092: &custom_roleprivs(\%allroles,$$role,$tdomain,$trest,$spec,$$where);
1.1064 raeburn 7093: push(@rolecodes,'cr');
1.1002 raeburn 7094: } elsif ($$role eq 'gr') {
1.1064 raeburn 7095: push(@rolecodes,$$role);
1.1002 raeburn 7096: my %rolehash = &get('roles',[$$where.'_'.$$role],$env{'user.domain'},
7097: $env{'user.name'});
1.1064 raeburn 7098: my ($trole) = split('_',$rolehash{$$where.'_'.$$role},2);
1.1002 raeburn 7099: (undef,my $group_privs) = split(/\//,$trole);
7100: $group_privs = &unescape($group_privs);
7101: &group_roleprivs(\%allgroups,$$where,$group_privs,$$tend,$$tstart);
1.1064 raeburn 7102: my %course_roles = &get_my_roles($env{'user.name'},$env{'user.domain'},'userroles',['active'],['cc','co','in','ta','ep','ad','st','cr'],[$tdomain],1);
1.1104 raeburn 7103: &get_groups_roles($tdomain,$trest,
7104: \%course_roles,\@rolecodes,
7105: \%groups_roles);
1.1002 raeburn 7106: } else {
1.1064 raeburn 7107: push(@rolecodes,$$role);
1.1002 raeburn 7108: &standard_roleprivs(\%allroles,$$role,$tdomain,$spec,$trest,$$where);
7109: }
1.1341 raeburn 7110: my ($author,$adv,$rar)= &set_userprivs(\%userroles,\%allroles,\%allgroups,
7111: \%groups_roles);
1.1064 raeburn 7112: &appenv(\%userroles,\@rolecodes);
1.1342 raeburn 7113: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},"Role ".$spec);
1.1002 raeburn 7114: }
7115: }
1.1034 raeburn 7116: $$tstatus = 'is';
1.1002 raeburn 7117: }
1.994 raeburn 7118: }
7119: if ($$tend) {
1.1104 raeburn 7120: if ($$tend<$update) {
1.994 raeburn 7121: $$tstatus='expired';
7122: } elsif ($$tend<$now) {
7123: $$tstatus='will_not';
7124: }
7125: }
7126: }
7127: }
7128: }
7129:
1.1104 raeburn 7130: sub get_groups_roles {
7131: my ($cdom,$rest,$cdom_courseroles,$rolecodes,$groups_roles) = @_;
7132: return unless((ref($cdom_courseroles) eq 'HASH') &&
7133: (ref($rolecodes) eq 'ARRAY') &&
7134: (ref($groups_roles) eq 'HASH'));
7135: if (keys(%{$cdom_courseroles}) > 0) {
7136: my ($cnum) = ($rest =~ /^($match_courseid)/);
7137: if ($cdom ne '' && $cnum ne '') {
7138: foreach my $key (keys(%{$cdom_courseroles})) {
7139: if ($key =~ /^\Q$cnum\E:\Q$cdom\E:([^:]+):?([^:]*)/) {
7140: my $crsrole = $1;
7141: my $crssec = $2;
7142: if ($crsrole =~ /^cr/) {
7143: unless (grep(/^cr$/,@{$rolecodes})) {
7144: push(@{$rolecodes},'cr');
7145: }
7146: } else {
7147: unless(grep(/^\Q$crsrole\E$/,@{$rolecodes})) {
7148: push(@{$rolecodes},$crsrole);
7149: }
7150: }
7151: my $rolekey = "$crsrole./$cdom/$cnum";
7152: if ($crssec ne '') {
7153: $rolekey .= "/$crssec";
7154: }
7155: $rolekey .= './';
7156: $groups_roles->{$rolekey} = $rolecodes;
7157: }
7158: }
7159: }
7160: }
7161: return;
7162: }
7163:
7164: sub delete_env_groupprivs {
7165: my ($where,$courseroles,$possroles) = @_;
7166: return unless((ref($courseroles) eq 'HASH') && (ref($possroles) eq 'ARRAY'));
7167: my ($dummy,$udom,$uname,$group) = split(/\//,$where);
7168: unless (ref($courseroles->{$udom}) eq 'HASH') {
7169: %{$courseroles->{$udom}} =
7170: &get_my_roles('','','userroles',['active'],
7171: $possroles,[$udom],1);
7172: }
7173: if (ref($courseroles->{$udom}) eq 'HASH') {
7174: foreach my $item (keys(%{$courseroles->{$udom}})) {
7175: my ($cnum,$cdom,$crsrole,$crssec) = split(/:/,$item);
7176: my $area = '/'.$cdom.'/'.$cnum;
7177: my $privkey = "user.priv.$crsrole.$area";
7178: if ($crssec ne '') {
7179: $privkey .= '/'.$crssec;
7180: }
7181: $privkey .= ".$area/$group";
7182: &Apache::lonnet::delenv($privkey,undef,[$crsrole]);
7183: }
7184: }
7185: return;
7186: }
7187:
1.994 raeburn 7188: sub check_adhoc_privs {
1.1329 raeburn 7189: my ($cdom,$cnum,$update,$refresh,$now,$checkrole,$caller,$sec) = @_;
1.994 raeburn 7190: my $cckey = 'user.role.'.$checkrole.'./'.$cdom.'/'.$cnum;
1.1329 raeburn 7191: if ($sec) {
7192: $cckey .= '/'.$sec;
7193: }
1.1185 raeburn 7194: my $setprivs;
1.994 raeburn 7195: if ($env{$cckey}) {
7196: my ($role,$where,$trolecode,$tstart,$tend,$tremark,$tstatus,$tpstart,$tpend);
1.1104 raeburn 7197: &role_status($cckey,$update,$refresh,$now,\$role,\$where,\$trolecode,\$tstatus,\$tstart,\$tend);
1.994 raeburn 7198: unless (($tstatus eq 'is') || ($tstatus eq 'will_not')) {
1.1329 raeburn 7199: &set_adhoc_privileges($cdom,$cnum,$checkrole,$caller,$sec);
1.1185 raeburn 7200: $setprivs = 1;
1.994 raeburn 7201: }
7202: } else {
1.1330 raeburn 7203: &set_adhoc_privileges($cdom,$cnum,$checkrole,$caller,$sec);
1.1185 raeburn 7204: $setprivs = 1;
1.994 raeburn 7205: }
1.1185 raeburn 7206: return $setprivs;
1.994 raeburn 7207: }
7208:
7209: sub set_adhoc_privileges {
1.1326 raeburn 7210: # role can be cc, ca, or cr/<dom>/<dom>-domainconfig/role
1.1329 raeburn 7211: my ($dcdom,$pickedcourse,$role,$caller,$sec) = @_;
1.994 raeburn 7212: my $area = '/'.$dcdom.'/'.$pickedcourse;
1.1329 raeburn 7213: if ($sec ne '') {
7214: $area .= '/'.$sec;
7215: }
1.994 raeburn 7216: my $spec = $role.'.'.$area;
7217: my %userroles = &set_arearole($role,$area,'','',$env{'user.domain'},
1.1215 raeburn 7218: $env{'user.name'},1);
1.1326 raeburn 7219: my %rolehash = ();
1.1332 raeburn 7220: if ($role =~ m{^\Qcr/$dcdom/$dcdom\E\-domainconfig/(\w+)$}) {
7221: my $rolename = $1;
1.1326 raeburn 7222: &custom_roleprivs(\%rolehash,$role,$dcdom,$pickedcourse,$spec,$area);
1.1332 raeburn 7223: my %domdef = &get_domain_defaults($dcdom);
7224: if (ref($domdef{'adhocroles'}) eq 'HASH') {
7225: if (ref($domdef{'adhocroles'}{$rolename}) eq 'HASH') {
7226: &appenv({'request.role.desc' => $domdef{'adhocroles'}{$rolename}{'desc'},});
7227: }
7228: }
1.1326 raeburn 7229: } else {
7230: &standard_roleprivs(\%rolehash,$role,$dcdom,$spec,$pickedcourse,$area);
7231: }
1.1341 raeburn 7232: my ($author,$adv,$rar)= &set_userprivs(\%userroles,\%rolehash);
1.994 raeburn 7233: &appenv(\%userroles,[$role,'cm']);
1.1342 raeburn 7234: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},"Role ".$spec);
1.1402 raeburn 7235: unless (($caller eq 'constructaccess' && $env{'request.course.id'}) ||
7236: ($caller eq 'tiny')) {
1.1088 raeburn 7237: &appenv( {'request.role' => $spec,
7238: 'request.role.domain' => $dcdom,
1.1332 raeburn 7239: 'request.course.sec' => $sec,
1.1088 raeburn 7240: }
7241: );
7242: my $tadv=0;
7243: if (&allowed('adv') eq 'F') { $tadv=1; }
7244: &appenv({'request.role.adv' => $tadv});
7245: }
1.994 raeburn 7246: }
7247:
1.12 www 7248: # --------------------------------------------------------------- get interface
7249:
7250: sub get {
1.131 albertel 7251: my ($namespace,$storearr,$udomain,$uname)=@_;
1.12 www 7252: my $items='';
1.800 albertel 7253: foreach my $item (@$storearr) {
7254: $items.=&escape($item).'&';
1.191 harris41 7255: }
1.12 www 7256: $items=~s/\&$//;
1.620 albertel 7257: if (!$udomain) { $udomain=$env{'user.domain'}; }
7258: if (!$uname) { $uname=$env{'user.name'}; }
1.131 albertel 7259: my $uhome=&homeserver($uname,$udomain);
7260:
1.133 albertel 7261: my $rep=&reply("get:$udomain:$uname:$namespace:$items",$uhome);
1.15 www 7262: my @pairs=split(/\&/,$rep);
1.273 albertel 7263: if ( $#pairs==0 && $pairs[0] =~ /^(con_lost|error|no_such_host)/i) {
7264: return @pairs;
7265: }
1.15 www 7266: my %returnhash=();
1.42 www 7267: my $i=0;
1.800 albertel 7268: foreach my $item (@$storearr) {
7269: $returnhash{$item}=&thaw_unescape($pairs[$i]);
1.42 www 7270: $i++;
1.191 harris41 7271: }
1.15 www 7272: return %returnhash;
1.27 www 7273: }
7274:
7275: # --------------------------------------------------------------- del interface
7276:
7277: sub del {
1.133 albertel 7278: my ($namespace,$storearr,$udomain,$uname)=@_;
1.27 www 7279: my $items='';
1.800 albertel 7280: foreach my $item (@$storearr) {
7281: $items.=&escape($item).'&';
1.191 harris41 7282: }
1.984 neumanie 7283:
1.27 www 7284: $items=~s/\&$//;
1.620 albertel 7285: if (!$udomain) { $udomain=$env{'user.domain'}; }
7286: if (!$uname) { $uname=$env{'user.name'}; }
1.133 albertel 7287: my $uhome=&homeserver($uname,$udomain);
7288: return &reply("del:$udomain:$uname:$namespace:$items",$uhome);
1.15 www 7289: }
7290:
7291: # -------------------------------------------------------------- dump interface
7292:
1.1180 droeschl 7293: sub unserialize {
7294: my ($rep, $escapedkeys) = @_;
7295:
7296: return {} if $rep =~ /^error/;
7297:
7298: my %returnhash=();
1.1252 raeburn 7299: foreach my $item (split(/\&/,$rep)) {
1.1180 droeschl 7300: my ($key, $value) = split(/=/, $item, 2);
7301: $key = unescape($key) unless $escapedkeys;
7302: next if $key =~ /^error: 2 /;
1.1252 raeburn 7303: $returnhash{$key} = &thaw_unescape($value);
1.1180 droeschl 7304: }
7305: #return %returnhash;
7306: return \%returnhash;
7307: }
7308:
7309: # see Lond::dump_with_regexp
7310: # if $escapedkeys hash keys won't get unescaped.
1.15 www 7311: sub dump {
1.1462 raeburn 7312: my ($namespace,$udomain,$uname,$regexp,$range,$escapedkeys,$encrypt)=@_;
1.755 albertel 7313: if (!$udomain) { $udomain=$env{'user.domain'}; }
7314: if (!$uname) { $uname=$env{'user.name'}; }
7315: my $uhome=&homeserver($uname,$udomain);
1.1167 droeschl 7316:
1.1266 raeburn 7317: if ($regexp) {
7318: $regexp=&escape($regexp);
7319: } else {
7320: $regexp='.';
7321: }
1.1180 droeschl 7322: if (grep { $_ eq $uhome } current_machine_ids()) {
7323: # user is hosted on this machine
1.1266 raeburn 7324: my $reply = LONCAPA::Lond::dump_with_regexp(join(":", ($udomain,
1.1226 raeburn 7325: $uname, $namespace, $regexp, $range)), $perlvar{'lonVersion'});
1.1180 droeschl 7326: return %{unserialize($reply, $escapedkeys)};
7327: }
1.1462 raeburn 7328: my $rep;
7329: if ($encrypt) {
7330: $rep=&reply("encrypt:edump:$udomain:$uname:$namespace:$regexp:$range",$uhome);
1.1463 raeburn 7331: } else {
1.1462 raeburn 7332: $rep=&reply("dump:$udomain:$uname:$namespace:$regexp:$range",$uhome);
7333: }
1.755 albertel 7334: my @pairs=split(/\&/,$rep);
7335: my %returnhash=();
1.1098 foxr 7336: if (!($rep =~ /^error/ )) {
7337: foreach my $item (@pairs) {
7338: my ($key,$value)=split(/=/,$item,2);
1.1180 droeschl 7339: $key = unescape($key) unless $escapedkeys;
7340: #$key = &unescape($key);
1.1098 foxr 7341: next if ($key =~ /^error: 2 /);
7342: $returnhash{$key}=&thaw_unescape($value);
7343: }
1.755 albertel 7344: }
7345: return %returnhash;
1.407 www 7346: }
7347:
1.1098 foxr 7348:
1.717 albertel 7349: # --------------------------------------------------------- dumpstore interface
7350:
7351: sub dumpstore {
7352: my ($namespace,$udomain,$uname,$regexp,$range)=@_;
1.1180 droeschl 7353: # same as dump but keys must be escaped. They may contain colon separated
7354: # lists of values that may themself contain colons (e.g. symbs).
7355: return &dump($namespace, $udomain, $uname, $regexp, $range, 1);
1.717 albertel 7356: }
7357:
1.407 www 7358: # -------------------------------------------------------------- keys interface
7359:
7360: sub getkeys {
7361: my ($namespace,$udomain,$uname)=@_;
1.620 albertel 7362: if (!$udomain) { $udomain=$env{'user.domain'}; }
7363: if (!$uname) { $uname=$env{'user.name'}; }
1.407 www 7364: my $uhome=&homeserver($uname,$udomain);
7365: my $rep=reply("keys:$udomain:$uname:$namespace",$uhome);
7366: my @keyarray=();
1.800 albertel 7367: foreach my $key (split(/\&/,$rep)) {
1.812 raeburn 7368: next if ($key =~ /^error: 2 /);
1.800 albertel 7369: push(@keyarray,&unescape($key));
1.407 www 7370: }
7371: return @keyarray;
1.318 matthew 7372: }
7373:
1.319 matthew 7374: # --------------------------------------------------------------- currentdump
7375: sub currentdump {
1.328 matthew 7376: my ($courseid,$sdom,$sname)=@_;
1.620 albertel 7377: $courseid = $env{'request.course.id'} if (! defined($courseid));
7378: $sdom = $env{'user.domain'} if (! defined($sdom));
7379: $sname = $env{'user.name'} if (! defined($sname));
1.326 matthew 7380: my $uhome = &homeserver($sname,$sdom);
1.1180 droeschl 7381: my $rep;
7382:
7383: if (grep { $_ eq $uhome } current_machine_ids()) {
7384: $rep = LONCAPA::Lond::dump_profile_database(join(":", ($sdom, $sname,
7385: $courseid)));
7386: } else {
7387: $rep = reply('currentdump:'.$sdom.':'.$sname.':'.$courseid,$uhome);
7388: }
7389:
1.318 matthew 7390: return if ($rep =~ /^(error:|no_such_host)/);
1.319 matthew 7391: #
1.318 matthew 7392: my %returnhash=();
1.319 matthew 7393: #
1.1343 raeburn 7394: if ($rep eq 'unknown_cmd') {
1.319 matthew 7395: # an old lond will not know currentdump
7396: # Do a dump and make it look like a currentdump
1.822 albertel 7397: my @tmp = &dumpstore($courseid,$sdom,$sname,'.');
1.319 matthew 7398: return if ($tmp[0] =~ /^(error:|no_such_host)/);
7399: my %hash = @tmp;
7400: @tmp=();
1.424 matthew 7401: %returnhash = %{&convert_dump_to_currentdump(\%hash)};
1.319 matthew 7402: } else {
7403: my @pairs=split(/\&/,$rep);
1.800 albertel 7404: foreach my $pair (@pairs) {
7405: my ($key,$value)=split(/=/,$pair,2);
1.319 matthew 7406: my ($symb,$param) = split(/:/,$key);
7407: $returnhash{&unescape($symb)}->{&unescape($param)} =
1.557 albertel 7408: &thaw_unescape($value);
1.319 matthew 7409: }
1.191 harris41 7410: }
1.12 www 7411: return %returnhash;
1.424 matthew 7412: }
7413:
7414: sub convert_dump_to_currentdump{
7415: my %hash = %{shift()};
7416: my %returnhash;
7417: # Code ripped from lond, essentially. The only difference
7418: # here is the unescaping done by lonnet::dump(). Conceivably
7419: # we might run in to problems with parameter names =~ /^v\./
7420: while (my ($key,$value) = each(%hash)) {
7421: my ($v,$symb,$param) = split(/:/,$key);
1.822 albertel 7422: $symb = &unescape($symb);
7423: $param = &unescape($param);
1.424 matthew 7424: next if ($v eq 'version' || $symb eq 'keys');
7425: next if (exists($returnhash{$symb}) &&
7426: exists($returnhash{$symb}->{$param}) &&
7427: $returnhash{$symb}->{'v.'.$param} > $v);
7428: $returnhash{$symb}->{$param}=$value;
7429: $returnhash{$symb}->{'v.'.$param}=$v;
7430: }
7431: #
7432: # Remove all of the keys in the hashes which keep track of
7433: # the version of the parameter.
7434: while (my ($symb,$param_hash) = each(%returnhash)) {
7435: # use a foreach because we are going to delete from the hash.
7436: foreach my $key (keys(%$param_hash)) {
7437: delete($param_hash->{$key}) if ($key =~ /^v\./);
7438: }
7439: }
7440: return \%returnhash;
1.12 www 7441: }
7442:
1.627 albertel 7443: # ------------------------------------------------------ critical inc interface
7444:
7445: sub cinc {
7446: return &inc(@_,'critical');
7447: }
7448:
1.449 matthew 7449: # --------------------------------------------------------------- inc interface
7450:
7451: sub inc {
1.627 albertel 7452: my ($namespace,$store,$udomain,$uname,$critical) = @_;
1.620 albertel 7453: if (!$udomain) { $udomain=$env{'user.domain'}; }
7454: if (!$uname) { $uname=$env{'user.name'}; }
1.449 matthew 7455: my $uhome=&homeserver($uname,$udomain);
7456: my $items='';
7457: if (! ref($store)) {
7458: # got a single value, so use that instead
7459: $items = &escape($store).'=&';
7460: } elsif (ref($store) eq 'SCALAR') {
7461: $items = &escape($$store).'=&';
7462: } elsif (ref($store) eq 'ARRAY') {
7463: $items = join('=&',map {&escape($_);} @{$store});
7464: } elsif (ref($store) eq 'HASH') {
7465: while (my($key,$value) = each(%{$store})) {
7466: $items.= &escape($key).'='.&escape($value).'&';
7467: }
7468: }
7469: $items=~s/\&$//;
1.627 albertel 7470: if ($critical) {
7471: return &critical("inc:$udomain:$uname:$namespace:$items",$uhome);
7472: } else {
7473: return &reply("inc:$udomain:$uname:$namespace:$items",$uhome);
7474: }
1.449 matthew 7475: }
7476:
1.12 www 7477: # --------------------------------------------------------------- put interface
7478:
7479: sub put {
1.1462 raeburn 7480: my ($namespace,$storehash,$udomain,$uname,$encrypt)=@_;
1.620 albertel 7481: if (!$udomain) { $udomain=$env{'user.domain'}; }
7482: if (!$uname) { $uname=$env{'user.name'}; }
1.134 albertel 7483: my $uhome=&homeserver($uname,$udomain);
1.12 www 7484: my $items='';
1.800 albertel 7485: foreach my $item (keys(%$storehash)) {
7486: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
1.191 harris41 7487: }
1.12 www 7488: $items=~s/\&$//;
1.1462 raeburn 7489: if ($encrypt) {
7490: return &reply("encrypt:put:$udomain:$uname:$namespace:$items",$uhome);
7491: } else {
7492: return &reply("put:$udomain:$uname:$namespace:$items",$uhome);
7493: }
1.47 www 7494: }
7495:
1.631 albertel 7496: # ------------------------------------------------------------ newput interface
7497:
7498: sub newput {
7499: my ($namespace,$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 $items='';
7504: foreach my $key (keys(%$storehash)) {
7505: $items.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
7506: }
7507: $items=~s/\&$//;
7508: return &reply("newput:$udomain:$uname:$namespace:$items",$uhome);
7509: }
7510:
7511: # --------------------------------------------------------- putstore interface
7512:
1.524 raeburn 7513: sub putstore {
1.1269 raeburn 7514: my ($namespace,$symb,$version,$storehash,$udomain,$uname,$tolog)=@_;
1.620 albertel 7515: if (!$udomain) { $udomain=$env{'user.domain'}; }
7516: if (!$uname) { $uname=$env{'user.name'}; }
1.524 raeburn 7517: my $uhome=&homeserver($uname,$udomain);
7518: my $items='';
1.715 albertel 7519: foreach my $key (keys(%$storehash)) {
7520: $items.= &escape($key).'='.&freeze_escape($storehash->{$key}).'&';
1.524 raeburn 7521: }
1.715 albertel 7522: $items=~s/\&$//;
1.716 albertel 7523: my $esc_symb=&escape($symb);
7524: my $esc_v=&escape($version);
1.715 albertel 7525: my $reply =
1.716 albertel 7526: &reply("putstore:$udomain:$uname:$namespace:$esc_symb:$esc_v:$items",
1.715 albertel 7527: $uhome);
1.1269 raeburn 7528: if (($tolog) && ($reply eq 'ok')) {
7529: my $namevalue='';
7530: foreach my $key (keys(%{$storehash})) {
7531: $namevalue.=&escape($key).'='.&freeze_escape($storehash->{$key}).'&';
7532: }
1.1434 raeburn 7533: my $ip = &get_requestor_ip();
7534: $namevalue .= 'ip='.&escape($ip).
1.1269 raeburn 7535: '&host='.&escape($perlvar{'lonHostID'}).
7536: '&version='.$esc_v.
7537: '&by='.&escape($env{'user.name'}.':'.$env{'user.domain'});
1.1494 raeburn 7538: &courselog($symb.':'.$uname.':'.$udomain.':PUTSTORE:'.$namevalue);
1.1269 raeburn 7539: }
1.715 albertel 7540: if ($reply eq 'unknown_cmd') {
1.716 albertel 7541: # gfall back to way things use to be done
1.715 albertel 7542: return &old_putstore($namespace,$symb,$version,$storehash,$udomain,
7543: $uname);
1.524 raeburn 7544: }
1.715 albertel 7545: return $reply;
7546: }
7547:
7548: sub old_putstore {
1.716 albertel 7549: my ($namespace,$symb,$version,$storehash,$udomain,$uname)=@_;
7550: if (!$udomain) { $udomain=$env{'user.domain'}; }
7551: if (!$uname) { $uname=$env{'user.name'}; }
7552: my $uhome=&homeserver($uname,$udomain);
7553: my %newstorehash;
1.800 albertel 7554: foreach my $item (keys(%$storehash)) {
7555: my $key = $version.':'.&escape($symb).':'.$item;
7556: $newstorehash{$key} = $storehash->{$item};
1.716 albertel 7557: }
7558: my $items='';
7559: my %allitems = ();
1.800 albertel 7560: foreach my $item (keys(%newstorehash)) {
7561: if ($item =~ m/^([^\:]+):([^\:]+):([^\:]+)$/) {
1.716 albertel 7562: my $key = $1.':keys:'.$2;
7563: $allitems{$key} .= $3.':';
7564: }
1.800 albertel 7565: $items.=$item.'='.&freeze_escape($newstorehash{$item}).'&';
1.716 albertel 7566: }
1.800 albertel 7567: foreach my $item (keys(%allitems)) {
7568: $allitems{$item} =~ s/\:$//;
7569: $items.= $item.'='.$allitems{$item}.'&';
1.716 albertel 7570: }
7571: $items=~s/\&$//;
7572: return &reply("put:$udomain:$uname:$namespace:$items",$uhome);
1.524 raeburn 7573: }
7574:
1.47 www 7575: # ------------------------------------------------------ critical put interface
7576:
7577: sub cput {
1.134 albertel 7578: my ($namespace,$storehash,$udomain,$uname)=@_;
1.620 albertel 7579: if (!$udomain) { $udomain=$env{'user.domain'}; }
7580: if (!$uname) { $uname=$env{'user.name'}; }
1.134 albertel 7581: my $uhome=&homeserver($uname,$udomain);
1.47 www 7582: my $items='';
1.800 albertel 7583: foreach my $item (keys(%$storehash)) {
7584: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
1.191 harris41 7585: }
1.47 www 7586: $items=~s/\&$//;
1.134 albertel 7587: return &critical("put:$udomain:$uname:$namespace:$items",$uhome);
1.12 www 7588: }
7589:
7590: # -------------------------------------------------------------- eget interface
7591:
7592: sub eget {
1.133 albertel 7593: my ($namespace,$storearr,$udomain,$uname)=@_;
1.12 www 7594: my $items='';
1.800 albertel 7595: foreach my $item (@$storearr) {
7596: $items.=&escape($item).'&';
1.191 harris41 7597: }
1.12 www 7598: $items=~s/\&$//;
1.620 albertel 7599: if (!$udomain) { $udomain=$env{'user.domain'}; }
7600: if (!$uname) { $uname=$env{'user.name'}; }
1.133 albertel 7601: my $uhome=&homeserver($uname,$udomain);
7602: my $rep=&reply("eget:$udomain:$uname:$namespace:$items",$uhome);
1.12 www 7603: my @pairs=split(/\&/,$rep);
7604: my %returnhash=();
1.42 www 7605: my $i=0;
1.800 albertel 7606: foreach my $item (@$storearr) {
7607: $returnhash{$item}=&thaw_unescape($pairs[$i]);
1.42 www 7608: $i++;
1.191 harris41 7609: }
1.12 www 7610: return %returnhash;
7611: }
7612:
1.667 albertel 7613: # ------------------------------------------------------------ tmpput interface
7614: sub tmpput {
1.802 raeburn 7615: my ($storehash,$server,$context)=@_;
1.667 albertel 7616: my $items='';
1.800 albertel 7617: foreach my $item (keys(%$storehash)) {
7618: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
1.667 albertel 7619: }
7620: $items=~s/\&$//;
1.802 raeburn 7621: if (defined($context)) {
7622: $items .= ':'.&escape($context);
7623: }
1.667 albertel 7624: return &reply("tmpput:$items",$server);
7625: }
7626:
7627: # ------------------------------------------------------------ tmpget interface
7628: sub tmpget {
1.688 albertel 7629: my ($token,$server)=@_;
7630: if (!defined($server)) { $server = $perlvar{'lonHostID'}; }
7631: my $rep=&reply("tmpget:$token",$server);
1.667 albertel 7632: my %returnhash;
1.1328 raeburn 7633: if ($rep =~ /^(con_lost|error|no_such_host)/i) {
7634: return %returnhash;
7635: }
1.667 albertel 7636: foreach my $item (split(/\&/,$rep)) {
7637: my ($key,$value)=split(/=/,$item);
7638: $returnhash{&unescape($key)}=&thaw_unescape($value);
7639: }
7640: return %returnhash;
7641: }
7642:
1.1113 raeburn 7643: # ------------------------------------------------------------ tmpdel interface
1.688 albertel 7644: sub tmpdel {
7645: my ($token,$server)=@_;
7646: if (!defined($server)) { $server = $perlvar{'lonHostID'}; }
7647: return &reply("tmpdel:$token",$server);
7648: }
7649:
1.1198 raeburn 7650: # ------------------------------------------------------------ get_timebased_id
7651:
7652: sub get_timebased_id {
7653: my ($prefix,$keyid,$namespace,$cdom,$cnum,$idtype,$who,$locktries,
7654: $maxtries) = @_;
7655: my ($newid,$error,$dellock);
7656: unless (($prefix =~ /^\w+$/) && ($keyid =~ /^\w+$/) && ($namespace ne '')) {
7657: return ('','ok','invalid call to get suffix');
7658: }
7659:
7660: # set defaults for any optional args for which values were not supplied
7661: if ($who eq '') {
7662: $who = $env{'user.name'}.':'.$env{'user.domain'};
7663: }
7664: if (!$locktries) {
7665: $locktries = 3;
7666: }
7667: if (!$maxtries) {
7668: $maxtries = 10;
7669: }
7670:
7671: if (($cdom eq '') || ($cnum eq '')) {
7672: if ($env{'request.course.id'}) {
7673: $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
7674: $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
7675: }
7676: if (($cdom eq '') || ($cnum eq '')) {
7677: return ('','ok','call to get suffix not in course context');
7678: }
7679: }
7680:
7681: # construct locking item
7682: my $lockhash = {
7683: $prefix."\0".'locked_'.$keyid => $who,
7684: };
7685: my $tries = 0;
7686:
7687: # attempt to get lock on nohist_$namespace file
1.1494 raeburn 7688: my $gotlock = &newput('nohist_'.$namespace,$lockhash,$cdom,$cnum);
1.1198 raeburn 7689: while (($gotlock ne 'ok') && $tries <$locktries) {
7690: $tries ++;
7691: sleep 1;
1.1494 raeburn 7692: $gotlock = &newput('nohist_'.$namespace,$lockhash,$cdom,$cnum);
1.1198 raeburn 7693: }
7694:
7695: # attempt to get unique identifier, based on current timestamp
7696: if ($gotlock eq 'ok') {
1.1494 raeburn 7697: my %inuse = &dump('nohist_'.$namespace,$cdom,$cnum,$prefix);
1.1198 raeburn 7698: my $id = time;
7699: $newid = $id;
1.1268 raeburn 7700: if ($idtype eq 'addcode') {
7701: $newid .= &sixnum_code();
7702: }
1.1198 raeburn 7703: my $idtries = 0;
7704: while (exists($inuse{$prefix."\0".$newid}) && $idtries < $maxtries) {
7705: if ($idtype eq 'concat') {
7706: $newid = $id.$idtries;
1.1268 raeburn 7707: } elsif ($idtype eq 'addcode') {
7708: $newid = $newid.&sixnum_code();
1.1198 raeburn 7709: } else {
7710: $newid ++;
7711: }
7712: $idtries ++;
7713: }
7714: if (!exists($inuse{$prefix."\0".$newid})) {
7715: my %new_item = (
7716: $prefix."\0".$newid => $who,
7717: );
1.1494 raeburn 7718: my $putresult = &put('nohist_'.$namespace,\%new_item,
1.1198 raeburn 7719: $cdom,$cnum);
7720: if ($putresult ne 'ok') {
7721: undef($newid);
7722: $error = 'error saving new item: '.$putresult;
7723: }
7724: } else {
1.1268 raeburn 7725: undef($newid);
1.1198 raeburn 7726: $error = ('error: no unique suffix available for the new item ');
7727: }
7728: # remove lock
7729: my @del_lock = ($prefix."\0".'locked_'.$keyid);
7730: $dellock = &Apache::lonnet::del('nohist_'.$namespace,\@del_lock,$cdom,$cnum);
7731: } else {
7732: $error = "error: could not obtain lockfile\n";
7733: $dellock = 'ok';
1.1276 raeburn 7734: if (($prefix eq 'paste') && ($namespace eq 'courseeditor') && ($keyid eq 'num')) {
7735: $dellock = 'nolock';
7736: }
1.1198 raeburn 7737: }
7738: return ($newid,$dellock,$error);
7739: }
7740:
1.1268 raeburn 7741: sub sixnum_code {
7742: my $code;
7743: for (0..6) {
7744: $code .= int( rand(9) );
7745: }
7746: return $code;
7747: }
7748:
1.765 albertel 7749: # -------------------------------------------------- portfolio access checking
7750:
7751: sub portfolio_access {
1.1270 raeburn 7752: my ($requrl,$clientip) = @_;
1.765 albertel 7753: my (undef,$udom,$unum,$file_name,$group) = &parse_portfolio_url($requrl);
1.1270 raeburn 7754: my $result = &get_portfolio_access($udom,$unum,$file_name,$group,$clientip);
1.814 raeburn 7755: if ($result) {
7756: my %setters;
7757: if ($env{'user.name'} eq 'public' && $env{'user.domain'} eq 'public') {
1.1473 raeburn 7758: my ($startblock,$endblock,$triggerblock,$by_ip,$blockdom) =
7759: &Apache::loncommon::blockcheck(\%setters,'port',$clientip,$unum,$udom);
7760: if (($startblock && $endblock) || ($by_ip)) {
1.814 raeburn 7761: return 'B';
7762: }
7763: } else {
1.1473 raeburn 7764: my ($startblock,$endblock,$triggerblock,$by_ip,$blockdom) =
7765: &Apache::loncommon::blockcheck(\%setters,'port',$clientip);
7766: if (($startblock && $endblock) || ($by_ip)) {
1.814 raeburn 7767: return 'B';
7768: }
7769: }
7770: }
1.765 albertel 7771: if ($result eq 'ok') {
1.766 albertel 7772: return 'F';
1.765 albertel 7773: } elsif ($result =~ /^[^:]+:guest_/) {
1.766 albertel 7774: return 'A';
1.765 albertel 7775: }
1.766 albertel 7776: return '';
1.765 albertel 7777: }
7778:
7779: sub get_portfolio_access {
1.1270 raeburn 7780: my ($udom,$unum,$file_name,$group,$clientip,$access_hash) = @_;
1.767 albertel 7781:
7782: if (!ref($access_hash)) {
7783: my $current_perms = &get_portfile_permissions($udom,$unum);
7784: my %access_controls = &get_access_controls($current_perms,$group,
7785: $file_name);
7786: $access_hash = $access_controls{$file_name};
7787: }
7788:
1.1270 raeburn 7789: my ($public,$guest,@domains,@users,@courses,@groups,@ips);
1.765 albertel 7790: my $now = time;
7791: if (ref($access_hash) eq 'HASH') {
7792: foreach my $key (keys(%{$access_hash})) {
7793: my ($num,$scope,$end,$start) = ($key =~ /^([^:]+):([a-z]+)_(\d*)_?(\d*)$/);
7794: if ($start > $now) {
7795: next;
7796: }
7797: if ($end && $end<$now) {
7798: next;
7799: }
7800: if ($scope eq 'public') {
7801: $public = $key;
7802: last;
7803: } elsif ($scope eq 'guest') {
7804: $guest = $key;
7805: } elsif ($scope eq 'domains') {
7806: push(@domains,$key);
7807: } elsif ($scope eq 'users') {
7808: push(@users,$key);
7809: } elsif ($scope eq 'course') {
7810: push(@courses,$key);
7811: } elsif ($scope eq 'group') {
7812: push(@groups,$key);
1.1270 raeburn 7813: } elsif ($scope eq 'ip') {
7814: push(@ips,$key);
1.765 albertel 7815: }
7816: }
7817: if ($public) {
7818: return 'ok';
1.1270 raeburn 7819: } elsif (@ips > 0) {
7820: my $allowed;
7821: foreach my $ipkey (@ips) {
7822: if (ref($access_hash->{$ipkey}{'ip'}) eq 'ARRAY') {
7823: if (&Apache::loncommon::check_ip_acc(join(',',@{$access_hash->{$ipkey}{'ip'}}),$clientip)) {
7824: $allowed = 1;
7825: last;
7826: }
7827: }
7828: }
7829: if ($allowed) {
7830: return 'ok';
7831: }
1.765 albertel 7832: }
7833: if ($env{'user.name'} eq 'public' && $env{'user.domain'} eq 'public') {
7834: if ($guest) {
7835: return $guest;
7836: }
7837: } else {
7838: if (@domains > 0) {
7839: foreach my $domkey (@domains) {
7840: if (ref($access_hash->{$domkey}{'dom'}) eq 'ARRAY') {
7841: if (grep(/^\Q$env{'user.domain'}\E$/,@{$access_hash->{$domkey}{'dom'}})) {
7842: return 'ok';
7843: }
7844: }
7845: }
7846: }
7847: if (@users > 0) {
7848: foreach my $userkey (@users) {
1.865 raeburn 7849: if (ref($access_hash->{$userkey}{'users'}) eq 'ARRAY') {
7850: foreach my $item (@{$access_hash->{$userkey}{'users'}}) {
7851: if (ref($item) eq 'HASH') {
7852: if (($item->{'uname'} eq $env{'user.name'}) &&
7853: ($item->{'udom'} eq $env{'user.domain'})) {
7854: return 'ok';
7855: }
7856: }
7857: }
7858: }
1.765 albertel 7859: }
7860: }
7861: my %roleshash;
7862: my @courses_and_groups = @courses;
7863: push(@courses_and_groups,@groups);
7864: if (@courses_and_groups > 0) {
7865: my (%allgroups,%allroles);
7866: my ($start,$end,$role,$sec,$group);
7867: foreach my $envkey (%env) {
1.1060 raeburn 7868: if ($envkey =~ m-^user\.role\.(gr|cc|co|in|ta|ep|ad|st)\./($match_domain)/($match_courseid)/?([^/]*)$-) {
1.765 albertel 7869: my $cid = $2.'_'.$3;
7870: if ($1 eq 'gr') {
7871: $group = $4;
7872: $allgroups{$cid}{$group} = $env{$envkey};
7873: } else {
7874: if ($4 eq '') {
7875: $sec = 'none';
7876: } else {
7877: $sec = $4;
7878: }
7879: $allroles{$cid}{$1}{$sec} = $env{$envkey};
7880: }
1.811 albertel 7881: } elsif ($envkey =~ m-^user\.role\./cr/($match_domain/$match_username/\w*)./($match_domain)/($match_courseid)/?([^/]*)$-) {
1.765 albertel 7882: my $cid = $2.'_'.$3;
7883: if ($4 eq '') {
7884: $sec = 'none';
7885: } else {
7886: $sec = $4;
7887: }
7888: $allroles{$cid}{$1}{$sec} = $env{$envkey};
7889: }
7890: }
7891: if (keys(%allroles) == 0) {
7892: return;
7893: }
7894: foreach my $key (@courses_and_groups) {
7895: my %content = %{$$access_hash{$key}};
7896: my $cnum = $content{'number'};
7897: my $cdom = $content{'domain'};
7898: my $cid = $cdom.'_'.$cnum;
7899: if (!exists($allroles{$cid})) {
7900: next;
7901: }
7902: foreach my $role_id (keys(%{$content{'roles'}})) {
7903: my @sections = @{$content{'roles'}{$role_id}{'section'}};
7904: my @groups = @{$content{'roles'}{$role_id}{'group'}};
7905: my @status = @{$content{'roles'}{$role_id}{'access'}};
7906: my @roles = @{$content{'roles'}{$role_id}{'role'}};
7907: foreach my $role (keys(%{$allroles{$cid}})) {
7908: if ((grep/^all$/,@roles) || (grep/^\Q$role\E$/,@roles)) {
7909: foreach my $sec (keys(%{$allroles{$cid}{$role}})) {
7910: if (&course_group_datechecker($allroles{$cid}{$role}{$sec},$now,\@status) eq 'ok') {
7911: if (grep/^all$/,@sections) {
7912: return 'ok';
7913: } else {
7914: if (grep/^$sec$/,@sections) {
7915: return 'ok';
7916: }
7917: }
7918: }
7919: }
7920: if (keys(%{$allgroups{$cid}}) == 0) {
7921: if (grep/^none$/,@groups) {
7922: return 'ok';
7923: }
7924: } else {
7925: if (grep/^all$/,@groups) {
7926: return 'ok';
7927: }
7928: foreach my $group (keys(%{$allgroups{$cid}})) {
7929: if (grep/^$group$/,@groups) {
7930: return 'ok';
7931: }
7932: }
7933: }
7934: }
7935: }
7936: }
7937: }
7938: }
7939: if ($guest) {
7940: return $guest;
7941: }
7942: }
7943: }
7944: return;
7945: }
7946:
7947: sub course_group_datechecker {
7948: my ($dates,$now,$status) = @_;
7949: my ($start,$end) = split(/\./,$dates);
7950: if (!$start && !$end) {
7951: return 'ok';
7952: }
7953: if (grep/^active$/,@{$status}) {
7954: if (((!$start) || ($start && $start <= $now)) && ((!$end) || ($end && $end >= $now))) {
7955: return 'ok';
7956: }
7957: }
7958: if (grep/^previous$/,@{$status}) {
7959: if ($end > $now ) {
7960: return 'ok';
7961: }
7962: }
7963: if (grep/^future$/,@{$status}) {
7964: if ($start > $now) {
7965: return 'ok';
7966: }
7967: }
7968: return;
7969: }
7970:
7971: sub parse_portfolio_url {
7972: my ($url) = @_;
7973:
7974: my ($type,$udom,$unum,$group,$file_name);
7975:
1.823 albertel 7976: if ($url =~ m-^/*(?:uploaded|editupload)/($match_domain)/($match_username)/portfolio(/.+)$-) {
1.765 albertel 7977: $type = 1;
7978: $udom = $1;
7979: $unum = $2;
7980: $file_name = $3;
1.823 albertel 7981: } elsif ($url =~ m-^/*(?:uploaded|editupload)/($match_domain)/($match_courseid)/groups/([^/]+)/portfolio/(.+)$-) {
1.765 albertel 7982: $type = 2;
7983: $udom = $1;
7984: $unum = $2;
7985: $group = $3;
7986: $file_name = $3.'/'.$4;
7987: }
7988: if (wantarray) {
7989: return ($type,$udom,$unum,$file_name,$group);
7990: }
7991: return $type;
7992: }
7993:
7994: sub is_portfolio_url {
7995: my ($url) = @_;
7996: return scalar(&parse_portfolio_url($url));
7997: }
7998:
1.798 raeburn 7999: sub is_portfolio_file {
8000: my ($file) = @_;
1.820 raeburn 8001: if (($file =~ /^portfolio/) || ($file =~ /^groups\/\w+\/portfolio/)) {
1.798 raeburn 8002: return 1;
8003: }
8004: return;
8005: }
8006:
1.1504 ! raeburn 8007: sub is_coursetool_logo {
! 8008: my ($uri) = @_;
! 8009: if ($env{'request.course.id'}) {
! 8010: my $courseurl = &courseid_to_courseurl($env{'request.course.id'});
! 8011: if ($uri =~ m{^/*uploaded\Q$courseurl\E/toollogo/\d+/[^/]+$}) {
! 8012: return 1;
! 8013: }
! 8014: }
! 8015: return;
! 8016: }
! 8017:
1.976 raeburn 8018: sub usertools_access {
1.1084 raeburn 8019: my ($uname,$udom,$tool,$action,$context,$userenvref,$domdefref,$is_advref)=@_;
1.985 raeburn 8020: my ($access,%tools);
8021: if ($context eq '') {
8022: $context = 'tools';
8023: }
8024: if ($context eq 'requestcourses') {
8025: %tools = (
8026: official => 1,
8027: unofficial => 1,
1.1006 raeburn 8028: community => 1,
1.1246 raeburn 8029: textbook => 1,
1.1305 raeburn 8030: placement => 1,
1.1368 raeburn 8031: lti => 1,
1.985 raeburn 8032: );
1.1183 raeburn 8033: } elsif ($context eq 'requestauthor') {
8034: %tools = (
8035: requestauthor => 1,
8036: );
1.985 raeburn 8037: } else {
8038: %tools = (
8039: aboutme => 1,
8040: blog => 1,
1.1177 raeburn 8041: webdav => 1,
1.985 raeburn 8042: portfolio => 1,
1.1489 raeburn 8043: timezone => 1,
1.985 raeburn 8044: );
8045: }
1.976 raeburn 8046: return if (!defined($tools{$tool}));
8047:
1.1242 raeburn 8048: if (($udom eq '') || ($uname eq '')) {
1.976 raeburn 8049: $udom = $env{'user.domain'};
8050: $uname = $env{'user.name'};
8051: }
8052:
1.978 raeburn 8053: if (($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'})) {
8054: if ($action ne 'reload') {
1.985 raeburn 8055: if ($context eq 'requestcourses') {
8056: return $env{'environment.canrequest.'.$tool};
1.1183 raeburn 8057: } elsif ($context eq 'requestauthor') {
8058: return $env{'environment.canrequest.author'};
1.985 raeburn 8059: } else {
8060: return $env{'environment.availabletools.'.$tool};
8061: }
8062: }
1.976 raeburn 8063: }
8064:
1.1183 raeburn 8065: my ($toolstatus,$inststatus,$envkey);
8066: if ($context eq 'requestauthor') {
8067: $envkey = $context;
8068: } else {
8069: $envkey = $context.'.'.$tool;
8070: }
1.976 raeburn 8071:
1.985 raeburn 8072: if (($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'}) &&
8073: ($action ne 'reload')) {
1.1183 raeburn 8074: $toolstatus = $env{'environment.'.$envkey};
1.976 raeburn 8075: $inststatus = $env{'environment.inststatus'};
8076: } else {
1.1084 raeburn 8077: if (ref($userenvref) eq 'HASH') {
1.1183 raeburn 8078: $toolstatus = $userenvref->{$envkey};
1.1084 raeburn 8079: $inststatus = $userenvref->{'inststatus'};
8080: } else {
1.1183 raeburn 8081: my %userenv = &userenvironment($udom,$uname,$envkey,'inststatus');
8082: $toolstatus = $userenv{$envkey};
1.1084 raeburn 8083: $inststatus = $userenv{'inststatus'};
8084: }
1.976 raeburn 8085: }
8086:
8087: if ($toolstatus ne '') {
8088: if ($toolstatus) {
8089: $access = 1;
8090: } else {
8091: $access = 0;
8092: }
8093: return $access;
8094: }
8095:
1.1084 raeburn 8096: my ($is_adv,%domdef);
8097: if (ref($is_advref) eq 'HASH') {
8098: $is_adv = $is_advref->{'is_adv'};
8099: } else {
8100: $is_adv = &is_advanced_user($udom,$uname);
8101: }
8102: if (ref($domdefref) eq 'HASH') {
8103: %domdef = %{$domdefref};
8104: } else {
8105: %domdef = &get_domain_defaults($udom);
8106: }
1.976 raeburn 8107: if (ref($domdef{$tool}) eq 'HASH') {
8108: if ($is_adv) {
8109: if ($domdef{$tool}{'_LC_adv'} ne '') {
8110: if ($domdef{$tool}{'_LC_adv'}) {
8111: $access = 1;
8112: } else {
8113: $access = 0;
8114: }
8115: return $access;
8116: }
8117: }
8118: if ($inststatus ne '') {
8119: my ($hasaccess,$hasnoaccess);
8120: foreach my $affiliation (split(/:/,$inststatus)) {
8121: if ($domdef{$tool}{$affiliation} ne '') {
8122: if ($domdef{$tool}{$affiliation}) {
8123: $hasaccess = 1;
8124: } else {
8125: $hasnoaccess = 1;
8126: }
8127: }
8128: }
8129: if ($hasaccess || $hasnoaccess) {
8130: if ($hasaccess) {
8131: $access = 1;
8132: } elsif ($hasnoaccess) {
8133: $access = 0;
8134: }
8135: return $access;
8136: }
8137: } else {
8138: if ($domdef{$tool}{'default'} ne '') {
8139: if ($domdef{$tool}{'default'}) {
8140: $access = 1;
8141: } elsif ($domdef{$tool}{'default'} == 0) {
8142: $access = 0;
8143: }
8144: return $access;
8145: }
8146: }
8147: } else {
1.1177 raeburn 8148: if (($context eq 'tools') && ($tool ne 'webdav')) {
1.985 raeburn 8149: $access = 1;
8150: } else {
8151: $access = 0;
8152: }
1.976 raeburn 8153: return $access;
8154: }
8155: }
8156:
1.1050 raeburn 8157: sub is_course_owner {
8158: my ($cdom,$cnum,$udom,$uname) = @_;
8159: if (($udom eq '') || ($uname eq '')) {
8160: $udom = $env{'user.domain'};
8161: $uname = $env{'user.name'};
8162: }
8163: unless (($udom eq '') || ($uname eq '')) {
8164: if (exists($env{'course.'.$cdom.'_'.$cnum.'.internal.courseowner'})) {
8165: if ($env{'course.'.$cdom.'_'.$cnum.'.internal.courseowner'} eq $uname.':'.$udom) {
8166: return 1;
8167: } else {
1.1494 raeburn 8168: my %courseinfo = &coursedescription($cdom.'/'.$cnum);
1.1050 raeburn 8169: if ($courseinfo{'internal.courseowner'} eq $uname.':'.$udom) {
8170: return 1;
8171: }
8172: }
8173: }
8174: }
8175: return;
8176: }
8177:
1.976 raeburn 8178: sub is_advanced_user {
8179: my ($udom,$uname) = @_;
1.1085 raeburn 8180: if ($udom ne '' && $uname ne '') {
8181: if (($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'})) {
1.1128 raeburn 8182: if (wantarray) {
8183: return ($env{'user.adv'},$env{'user.author'});
8184: } else {
8185: return $env{'user.adv'};
8186: }
1.1085 raeburn 8187: }
8188: }
1.976 raeburn 8189: my %roleshash = &get_my_roles($uname,$udom,'userroles',undef,undef,undef,1);
8190: my %allroles;
1.1128 raeburn 8191: my ($is_adv,$is_author);
1.976 raeburn 8192: foreach my $role (keys(%roleshash)) {
8193: my ($trest,$tdomain,$trole,$sec) = split(/:/,$role);
8194: my $area = '/'.$tdomain.'/'.$trest;
8195: if ($sec ne '') {
8196: $area .= '/'.$sec;
8197: }
8198: if (($area ne '') && ($trole ne '')) {
8199: my $spec=$trole.'.'.$area;
8200: if ($trole =~ /^cr\//) {
8201: &custom_roleprivs(\%allroles,$trole,$tdomain,$trest,$spec,$area);
8202: } elsif ($trole ne 'gr') {
8203: &standard_roleprivs(\%allroles,$trole,$tdomain,$spec,$trest,$area);
8204: }
1.1128 raeburn 8205: if ($trole eq 'au') {
8206: $is_author = 1;
8207: }
1.976 raeburn 8208: }
8209: }
8210: foreach my $role (keys(%allroles)) {
8211: last if ($is_adv);
8212: foreach my $item (split(/:/,$allroles{$role})) {
8213: if ($item ne '') {
8214: my ($privilege,$restrictions)=split(/&/,$item);
8215: if ($privilege eq 'adv') {
8216: $is_adv = 1;
8217: last;
8218: }
8219: }
8220: }
8221: }
1.1128 raeburn 8222: if (wantarray) {
8223: return ($is_adv,$is_author);
8224: }
1.976 raeburn 8225: return $is_adv;
8226: }
1.798 raeburn 8227:
1.1035 raeburn 8228: sub check_can_request {
1.1368 raeburn 8229: my ($dom,$can_request,$request_domains,$uname,$udom) = @_;
1.1035 raeburn 8230: my $canreq = 0;
1.1368 raeburn 8231: if (($env{'user.name'} ne '') && ($env{'user.domain'} ne '')) {
8232: $uname = $env{'user.name'};
8233: $udom = $env{'user.domain'};
8234: }
1.1035 raeburn 8235: my ($types,$typename) = &Apache::loncommon::course_types();
8236: my @options = ('approval','validate','autolimit');
8237: my $optregex = join('|',@options);
8238: if ((ref($can_request) eq 'HASH') && (ref($types) eq 'ARRAY')) {
1.1486 raeburn 8239: my %willtrust;
1.1035 raeburn 8240: foreach my $type (@{$types}) {
1.1368 raeburn 8241: if (&usertools_access($uname,$udom,$type,undef,
8242: 'requestcourses')) {
1.1035 raeburn 8243: $canreq ++;
1.1036 raeburn 8244: if (ref($request_domains) eq 'HASH') {
1.1368 raeburn 8245: push(@{$request_domains->{$type}},$udom);
1.1036 raeburn 8246: }
1.1368 raeburn 8247: if ($dom eq $udom) {
1.1035 raeburn 8248: $can_request->{$type} = 1;
8249: }
8250: }
1.1368 raeburn 8251: if (($env{'user.name'} ne '') && ($env{'user.domain'} ne '') &&
8252: ($env{'environment.reqcrsotherdom.'.$type} ne '')) {
1.1035 raeburn 8253: my @curr = split(',',$env{'environment.reqcrsotherdom.'.$type});
8254: if (@curr > 0) {
1.1036 raeburn 8255: foreach my $item (@curr) {
8256: if (ref($request_domains) eq 'HASH') {
8257: my ($otherdom) = ($item =~ /^($match_domain):($optregex)(=?\d*)$/);
8258: if ($otherdom ne '') {
1.1486 raeburn 8259: unless (exists($willtrust{$otherdom})) {
8260: $willtrust{$otherdom} = &will_trust('reqcrs',$env{'user.domain'},$otherdom);
8261: }
8262: if ($willtrust{$otherdom}) {
8263: if (ref($request_domains->{$type}) eq 'ARRAY') {
8264: unless (grep(/^\Q$otherdom\E$/,@{$request_domains->{$type}})) {
8265: push(@{$request_domains->{$type}},$otherdom);
8266: }
8267: } else {
1.1036 raeburn 8268: push(@{$request_domains->{$type}},$otherdom);
8269: }
8270: }
8271: }
8272: }
8273: }
1.1368 raeburn 8274: unless ($dom eq $env{'user.domain'}) {
1.1036 raeburn 8275: $canreq ++;
1.1035 raeburn 8276: if (grep(/^\Q$dom\E:($optregex)(=?\d*)$/,@curr)) {
8277: $can_request->{$type} = 1;
8278: }
8279: }
8280: }
8281: }
8282: }
8283: }
8284: return $canreq;
8285: }
8286:
1.341 www 8287: # ---------------------------------------------- Custom access rule evaluation
8288:
8289: sub customaccess {
8290: my ($priv,$uri)=@_;
1.807 albertel 8291: my ($urole,$urealm)=split(/\./,$env{'request.role'},2);
1.819 www 8292: my (undef,$udom,$ucrs,$usec)=split(/\//,$urealm);
1.807 albertel 8293: $udom = &LONCAPA::clean_domain($udom);
8294: $ucrs = &LONCAPA::clean_username($ucrs);
1.341 www 8295: my $access=0;
1.800 albertel 8296: foreach my $right (split(/\s*\,\s*/,&metadata($uri,'rule_rights'))) {
1.893 albertel 8297: my ($effect,$realm,$role,$type)=split(/\:/,$right);
8298: if ($type eq 'user') {
8299: foreach my $scope (split(/\s*\,\s*/,$realm)) {
1.896 albertel 8300: my ($tdom,$tuname)=split(m{/},$scope);
1.893 albertel 8301: if ($tdom) {
8302: if ($tdom ne $env{'user.domain'}) { next; }
8303: }
1.896 albertel 8304: if ($tuname) {
8305: if ($tuname ne $env{'user.name'}) { next; }
1.893 albertel 8306: }
8307: $access=($effect eq 'allow');
8308: last;
8309: }
8310: } else {
8311: if ($role) {
8312: if ($role ne $urole) { next; }
8313: }
8314: foreach my $scope (split(/\s*\,\s*/,$realm)) {
8315: my ($tdom,$tcrs,$tsec)=split(/\_/,$scope);
8316: if ($tdom) {
8317: if ($tdom ne $udom) { next; }
8318: }
8319: if ($tcrs) {
8320: if ($tcrs ne $ucrs) { next; }
8321: }
8322: if ($tsec) {
8323: if ($tsec ne $usec) { next; }
8324: }
8325: $access=($effect eq 'allow');
8326: last;
8327: }
8328: if ($realm eq '' && $role eq '') {
8329: $access=($effect eq 'allow');
8330: }
1.402 bowersj2 8331: }
1.341 www 8332: }
8333: return $access;
8334: }
8335:
1.103 harris41 8336: # ------------------------------------------------- Check for a user privilege
1.12 www 8337:
8338: sub allowed {
1.1461 raeburn 8339: my ($priv,$uri,$symb,$role,$clientip,$noblockcheck,$ignorecache,$nodeeplinkcheck,$nodeeplinkout)=@_;
1.705 albertel 8340: my $ver_orguri=$uri;
1.439 www 8341: $uri=&deversion($uri);
1.152 www 8342: my $orguri=$uri;
1.52 www 8343: $uri=&declutter($uri);
1.809 raeburn 8344:
1.810 raeburn 8345: if ($priv eq 'evb') {
1.1478 raeburn 8346: # Evade communication block restrictions for specified role in a course or domain
1.810 raeburn 8347: if ($env{'user.priv.'.$role} =~/evb\&([^\:]*)/) {
8348: return $1;
8349: } else {
8350: return;
8351: }
8352: }
8353:
1.620 albertel 8354: if (defined($env{'allowed.'.$priv})) { return $env{'allowed.'.$priv}; }
1.54 www 8355: # Free bre access to adm and meta resources
1.1436 raeburn 8356: if (((($uri=~/^adm\//) && ($uri !~ m{/(?:smppg|bulletinboard|viewclasslist|aboutme|ext\.tool)$}))
1.769 albertel 8357: || (($uri=~/\.meta$/) && ($uri!~m|^uploaded/|) ))
8358: && ($priv eq 'bre')) {
1.14 www 8359: return 'F';
1.159 www 8360: }
8361:
1.545 banghart 8362: # Free bre access to user's own portfolio contents
1.714 raeburn 8363: my ($space,$domain,$name,@dir)=split('/',$uri);
1.647 raeburn 8364: if (($space=~/^(uploaded|editupload)$/) && ($env{'user.name'} eq $name) &&
1.714 raeburn 8365: ($env{'user.domain'} eq $domain) && ('portfolio' eq $dir[0])) {
1.814 raeburn 8366: my %setters;
1.1473 raeburn 8367: my ($startblock,$endblock,$triggerblock,$by_ip,$blockdom) =
8368: &Apache::loncommon::blockcheck(\%setters,'port',$clientip);
8369: if (($startblock && $endblock) || ($by_ip)) {
1.814 raeburn 8370: return 'B';
8371: } else {
8372: return 'F';
8373: }
1.545 banghart 8374: }
8375:
1.762 raeburn 8376: # bre access to group portfolio for rgf priv in group, or mdg or vcg in course.
1.714 raeburn 8377: if (($space=~/^(uploaded|editupload)$/) && ($dir[0] eq 'groups')
8378: && ($dir[2] eq 'portfolio') && ($priv eq 'bre')) {
8379: if (exists($env{'request.course.id'})) {
8380: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
8381: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
8382: if (($domain eq $cdom) && ($name eq $cnum)) {
8383: my $courseprivid=$env{'request.course.id'};
8384: $courseprivid=~s/\_/\//;
8385: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid
8386: .'/'.$dir[1]} =~/rgf\&([^\:]*)/) {
8387: return $1;
1.762 raeburn 8388: } else {
8389: if ($env{'request.course.sec'}) {
8390: $courseprivid.='/'.$env{'request.course.sec'};
8391: }
8392: if ($env{'user.priv.'.$env{'request.role'}.'./'.
8393: $courseprivid} =~/(mdg|vcg)\&([^\:]*)/) {
8394: return $2;
8395: }
1.714 raeburn 8396: }
8397: }
8398: }
8399: }
8400:
1.159 www 8401: # Free bre to public access
8402:
8403: if ($priv eq 'bre') {
1.1362 raeburn 8404: my $copyright;
8405: unless ($uri =~ /ext\.tool/) {
8406: $copyright=&metadata($uri,'copyright');
8407: }
1.620 albertel 8408: if (($copyright eq 'public') && (!$env{'request.course.id'})) {
1.301 www 8409: return 'F';
8410: }
1.238 www 8411: if ($copyright eq 'priv') {
8412: $uri=~/([^\/]+)\/([^\/]+)\//;
1.620 albertel 8413: unless (($env{'user.name'} eq $2) && ($env{'user.domain'} eq $1)) {
1.238 www 8414: return '';
8415: }
8416: }
8417: if ($copyright eq 'domain') {
8418: $uri=~/([^\/]+)\/([^\/]+)\//;
1.620 albertel 8419: unless (($env{'user.domain'} eq $1) ||
8420: ($env{'course.'.$env{'request.course.id'}.'.domain'} eq $1)) {
1.238 www 8421: return '';
8422: }
1.262 matthew 8423: }
1.620 albertel 8424: if ($env{'request.role'}=~ /li\.\//) {
1.262 matthew 8425: # Library role, so allow browsing of resources in this domain.
8426: return 'F';
1.238 www 8427: }
1.341 www 8428: if ($copyright eq 'custom') {
8429: unless (&customaccess($priv,$uri)) { return ''; }
8430: }
1.14 www 8431: }
1.264 matthew 8432: # Domain coordinator is trying to create a course
1.620 albertel 8433: if (($priv eq 'ccc') && ($env{'request.role'} =~ /^dc\./)) {
1.264 matthew 8434: # uri is the requested domain in this case.
8435: # comparison to 'request.role.domain' shows if the user has selected
1.678 raeburn 8436: # a role of dc for the domain in question.
1.620 albertel 8437: return 'F' if ($uri eq $env{'request.role.domain'});
1.264 matthew 8438: }
1.29 www 8439:
1.52 www 8440: my $thisallowed='';
8441: my $statecond=0;
8442: my $courseprivid='';
8443:
1.1039 raeburn 8444: my $ownaccess;
1.1043 raeburn 8445: # Community Coordinator or Assistant Co-author browsing resource space.
1.1039 raeburn 8446: if (($priv eq 'bro') && ($env{'user.author'})) {
8447: if ($uri eq '') {
8448: $ownaccess = 1;
8449: } else {
8450: if (($env{'user.domain'} ne '') && ($env{'user.name'} ne '')) {
8451: my $udom = $env{'user.domain'};
8452: my $uname = $env{'user.name'};
8453: if ($uri =~ m{^\Q$udom\E/?$}) {
8454: $ownaccess = 1;
1.1040 raeburn 8455: } elsif ($uri =~ m{^\Q$udom\E/\Q$uname\E/?}) {
1.1039 raeburn 8456: unless ($uri =~ m{\.\./}) {
8457: $ownaccess = 1;
8458: }
8459: } elsif (($udom ne 'public') && ($uname ne 'public')) {
8460: my $now = time;
8461: if ($uri =~ m{^([^/]+)/?$}) {
8462: my $adom = $1;
8463: foreach my $key (keys(%env)) {
1.1042 raeburn 8464: if ($key =~ m{^user\.role\.(ca|aa)/\Q$adom\E}) {
1.1452 raeburn 8465: my ($start,$end) = split(/\./,$env{$key});
8466: if (($now >= $start) && (!$end || $end > $now)) {
1.1039 raeburn 8467: $ownaccess = 1;
8468: last;
8469: }
8470: }
8471: }
8472: } elsif ($uri =~ m{^([^/]+)/([^/]+)/?}) {
8473: my $adom = $1;
8474: my $aname = $2;
1.1042 raeburn 8475: foreach my $role ('ca','aa') {
8476: if ($env{"user.role.$role./$adom/$aname"}) {
8477: my ($start,$end) =
1.1452 raeburn 8478: split(/\./,$env{"user.role.$role./$adom/$aname"});
8479: if (($now >= $start) && (!$end || $end > $now)) {
1.1042 raeburn 8480: $ownaccess = 1;
8481: last;
8482: }
1.1039 raeburn 8483: }
8484: }
8485: }
8486: }
8487: }
8488: }
8489: }
8490:
1.52 www 8491: # Course
8492:
1.620 albertel 8493: if ($env{'user.priv.'.$env{'request.role'}.'./'}=~/\Q$priv\E\&([^\:]*)/) {
1.1043 raeburn 8494: unless (($priv eq 'bro') && (!$ownaccess)) {
1.1039 raeburn 8495: $thisallowed.=$1;
8496: }
1.52 www 8497: }
1.29 www 8498:
1.52 www 8499: # Domain
8500:
1.620 albertel 8501: if ($env{'user.priv.'.$env{'request.role'}.'./'.(split(/\//,$uri))[0].'/'}
1.479 albertel 8502: =~/\Q$priv\E\&([^\:]*)/) {
1.1043 raeburn 8503: unless (($priv eq 'bro') && (!$ownaccess)) {
1.1039 raeburn 8504: $thisallowed.=$1;
8505: }
1.12 www 8506: }
1.52 www 8507:
1.1141 raeburn 8508: # User who is not author or co-author might still be able to edit
8509: # resource of an author in the domain (e.g., if Domain Coordinator).
8510: if (($priv eq 'eco') && ($thisallowed eq '') && ($env{'request.course.id'}) &&
8511: (&allowed('mdc',$env{'request.course.id'}))) {
8512: if ($env{"user.priv.cm./$uri/"}=~/\Q$priv\E\&([^\:]*)/) {
8513: $thisallowed.=$1;
8514: }
8515: }
8516:
1.52 www 8517: # Course: uri itself is a course
1.66 www 8518: my $courseuri=$uri;
8519: $courseuri=~s/\_(\d)/\/$1/;
1.83 www 8520: $courseuri=~s/^([^\/])/\/$1/;
1.81 www 8521:
1.620 albertel 8522: if ($env{'user.priv.'.$env{'request.role'}.'.'.$courseuri}
1.479 albertel 8523: =~/\Q$priv\E\&([^\:]*)/) {
1.1409 raeburn 8524: if ($priv eq 'mip') {
8525: my $rem = $1;
8526: if (($uri ne '') && ($env{'request.course.id'} eq $uri) &&
8527: ($env{'course.'.$env{'request.course.id'}.'.internal.courseowner'} eq $env{'user.name'}.':'.$env{'user.domain'})) {
8528: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
8529: if ($cdom ne '') {
1.1410 raeburn 8530: my %passwdconf = &get_passwdconf($cdom);
8531: if (ref($passwdconf{'crsownerchg'}) eq 'HASH') {
8532: if (ref($passwdconf{'crsownerchg'}{'by'}) eq 'ARRAY') {
8533: if (@{$passwdconf{'crsownerchg'}{'by'}}) {
8534: my @inststatuses = split(':',$env{'environment.inststatus'});
8535: unless (@inststatuses) {
8536: @inststatuses = ('default');
8537: }
8538: foreach my $status (@inststatuses) {
8539: if (grep(/^\Q$status\E$/,@{$passwdconf{'crsownerchg'}{'by'}})) {
8540: $thisallowed.=$rem;
8541: }
8542: }
8543: }
8544: }
1.1409 raeburn 8545: }
8546: }
8547: }
8548: } else {
8549: unless (($priv eq 'bro') && (!$ownaccess)) {
8550: $thisallowed.=$1;
8551: }
1.1039 raeburn 8552: }
1.12 www 8553: }
1.29 www 8554:
1.665 albertel 8555: # URI is an uploaded document for this course, default permissions don't matter
1.611 albertel 8556: # not allowing 'edit' access (editupload) to uploaded course docs
1.492 albertel 8557: if (($priv eq 'bre') && ($uri=~m|^uploaded/|)) {
1.665 albertel 8558: $thisallowed='';
1.671 raeburn 8559: my ($match)=&is_on_map($uri);
8560: if ($match) {
8561: if ($env{'user.priv.'.$env{'request.role'}.'./'}
8562: =~/\Q$priv\E\&([^\:]*)/) {
1.1281 raeburn 8563: my $value = $1;
1.1461 raeburn 8564: my $deeplinkblock;
8565: unless ($nodeeplinkcheck) {
8566: $deeplinkblock = &deeplink_check($priv,$symb,$uri);
8567: }
1.1402 raeburn 8568: if ($deeplinkblock) {
8569: $thisallowed='D';
8570: } elsif ($noblockcheck) {
1.1281 raeburn 8571: $thisallowed.=$value;
1.1162 raeburn 8572: } else {
1.1424 raeburn 8573: my @blockers = &has_comm_blocking($priv,$symb,$uri,$ignorecache);
1.1281 raeburn 8574: if (@blockers > 0) {
8575: $thisallowed = 'B';
8576: } else {
8577: $thisallowed.=$value;
8578: }
1.1162 raeburn 8579: }
1.671 raeburn 8580: }
8581: } else {
1.705 albertel 8582: my $refuri = $env{'httpref.'.$orguri} || $env{'httpref.'.$ver_orguri};
1.671 raeburn 8583: if ($refuri) {
8584: if ($refuri =~ m|^/adm/|) {
1.669 raeburn 8585: $thisallowed='F';
1.671 raeburn 8586: } else {
8587: $refuri=&declutter($refuri);
8588: my ($match) = &is_on_map($refuri);
8589: if ($match) {
1.1461 raeburn 8590: my $deeplinkblock;
8591: unless ($nodeeplinkcheck) {
8592: $deeplinkblock = &deeplink_check($priv,$symb,$refuri);
8593: }
1.1402 raeburn 8594: if ($deeplinkblock) {
8595: $thisallowed='D';
8596: } elsif ($noblockcheck) {
1.1281 raeburn 8597: $thisallowed='F';
1.1162 raeburn 8598: } else {
1.1426 raeburn 8599: my @blockers = &has_comm_blocking($priv,'',$refuri,'',1);
1.1281 raeburn 8600: if (@blockers > 0) {
8601: $thisallowed = 'B';
8602: } else {
8603: $thisallowed='F';
8604: }
1.1162 raeburn 8605: }
1.671 raeburn 8606: }
1.669 raeburn 8607: }
1.671 raeburn 8608: }
8609: }
1.314 www 8610: }
1.492 albertel 8611:
1.766 albertel 8612: if ($priv eq 'bre'
8613: && $thisallowed ne 'F'
8614: && $thisallowed ne '2'
8615: && &is_portfolio_url($uri)) {
1.1270 raeburn 8616: $thisallowed = &portfolio_access($uri,$clientip);
1.766 albertel 8617: }
1.1250 raeburn 8618:
1.52 www 8619: # Full access at system, domain or course-wide level? Exit.
1.29 www 8620: if ($thisallowed=~/F/) {
8621: return 'F';
8622: }
8623:
1.52 www 8624: # If this is generating or modifying users, exit with special codes
1.29 www 8625:
1.643 www 8626: if (':csu:cdc:ccc:cin:cta:cep:ccr:cst:cad:cli:cau:cdg:cca:caa:'=~/\:\Q$priv\E\:/) {
8627: if (($priv eq 'cca') || ($priv eq 'caa')) {
1.642 albertel 8628: my ($audom,$auname)=split('/',$uri);
1.643 www 8629: # no author name given, so this just checks on the general right to make a co-author in this domain
8630: unless ($auname) { return $thisallowed; }
8631: # an author name is given, so we are about to actually make a co-author for a certain account
1.642 albertel 8632: if (($auname ne $env{'user.name'} && $env{'request.role'} !~ /^dc\./) ||
8633: (($audom ne $env{'user.domain'} && $env{'request.role'} !~ /^dc\./) &&
8634: ($audom ne $env{'request.role.domain'}))) { return ''; }
8635: }
1.52 www 8636: return $thisallowed;
8637: }
8638: #
1.103 harris41 8639: # Gathered so far: system, domain and course wide privileges
1.52 www 8640: #
8641: # Course: See if uri or referer is an individual resource that is part of
8642: # the course
8643:
1.620 albertel 8644: if ($env{'request.course.id'}) {
1.232 www 8645:
1.1504 ! raeburn 8646: if ($priv eq 'bre') {
! 8647: if (&is_coursetool_logo($uri)) {
! 8648: return 'F';
! 8649: }
! 8650: }
! 8651:
1.1409 raeburn 8652: # If this is modifying password (internal auth) domains must match for user and user's role.
8653:
8654: if ($priv eq 'mip') {
8655: if ($env{'user.domain'} eq $env{'request.role.domain'}) {
8656: return $thisallowed;
8657: } else {
8658: return '';
8659: }
8660: }
8661:
1.620 albertel 8662: $courseprivid=$env{'request.course.id'};
8663: if ($env{'request.course.sec'}) {
8664: $courseprivid.='/'.$env{'request.course.sec'};
1.52 www 8665: }
8666: $courseprivid=~s/\_/\//;
8667: my $checkreferer=1;
1.232 www 8668: my ($match,$cond)=&is_on_map($uri);
8669: if ($match) {
8670: $statecond=$cond;
1.620 albertel 8671: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid}
1.479 albertel 8672: =~/\Q$priv\E\&([^\:]*)/) {
1.1162 raeburn 8673: my $value = $1;
8674: if ($priv eq 'bre') {
1.1461 raeburn 8675: my $deeplinkblock;
8676: unless ($nodeeplinkcheck) {
8677: $deeplinkblock = &deeplink_check($priv,$symb,$uri);
8678: }
1.1458 raeburn 8679: if ($deeplinkblock) {
8680: $thisallowed = 'D';
8681: } elsif ($noblockcheck) {
1.1281 raeburn 8682: $thisallowed.=$value;
1.1162 raeburn 8683: } else {
1.1424 raeburn 8684: my @blockers = &has_comm_blocking($priv,$symb,$uri,$ignorecache);
1.1281 raeburn 8685: if (@blockers > 0) {
8686: $thisallowed = 'B';
8687: } else {
8688: $thisallowed.=$value;
8689: }
1.1162 raeburn 8690: }
8691: } else {
8692: $thisallowed.=$value;
8693: }
1.52 www 8694: $checkreferer=0;
8695: }
1.29 www 8696: }
1.1424 raeburn 8697:
1.148 www 8698: if ($checkreferer) {
1.620 albertel 8699: my $refuri=$env{'httpref.'.$orguri};
1.148 www 8700: unless ($refuri) {
1.800 albertel 8701: foreach my $key (keys(%env)) {
8702: if ($key=~/^httpref\..*\*/) {
8703: my $pattern=$key;
1.156 www 8704: $pattern=~s/^httpref\.\/res\///;
1.148 www 8705: $pattern=~s/\*/\[\^\/\]\+/g;
8706: $pattern=~s/\//\\\//g;
1.152 www 8707: if ($orguri=~/$pattern/) {
1.800 albertel 8708: $refuri=$env{$key};
1.148 www 8709: }
8710: }
1.191 harris41 8711: }
1.148 www 8712: }
1.232 www 8713:
1.148 www 8714: if ($refuri) {
1.152 www 8715: $refuri=&declutter($refuri);
1.232 www 8716: my ($match,$cond)=&is_on_map($refuri);
8717: if ($match) {
8718: my $refstatecond=$cond;
1.620 albertel 8719: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid}
1.479 albertel 8720: =~/\Q$priv\E\&([^\:]*)/) {
1.1162 raeburn 8721: my $value = $1;
8722: if ($priv eq 'bre') {
1.1461 raeburn 8723: my $deeplinkblock;
8724: unless ($nodeeplinkcheck) {
8725: $deeplinkblock = &deeplink_check($priv,$symb,$refuri);
8726: }
1.1402 raeburn 8727: if ($deeplinkblock) {
8728: $thisallowed = 'D';
8729: } elsif ($noblockcheck) {
1.1281 raeburn 8730: $thisallowed.=$value;
1.1162 raeburn 8731: } else {
1.1426 raeburn 8732: my @blockers = &has_comm_blocking($priv,'',$refuri,'',1);
1.1281 raeburn 8733: if (@blockers > 0) {
8734: $thisallowed = 'B';
8735: } else {
8736: $thisallowed.=$value;
8737: }
1.1162 raeburn 8738: }
8739: } else {
8740: $thisallowed.=$value;
8741: }
1.53 www 8742: $uri=$refuri;
8743: $statecond=$refstatecond;
1.52 www 8744: }
8745: }
1.148 www 8746: }
1.29 www 8747: }
1.52 www 8748: }
1.29 www 8749:
1.52 www 8750: #
1.103 harris41 8751: # Gathered now: all privileges that could apply, and condition number
1.52 www 8752: #
8753: #
8754: # Full or no access?
8755: #
1.29 www 8756:
1.52 www 8757: if ($thisallowed=~/F/) {
8758: return 'F';
8759: }
1.29 www 8760:
1.52 www 8761: unless ($thisallowed) {
8762: return '';
8763: }
1.29 www 8764:
1.52 www 8765: # Restrictions exist, deal with them
8766: #
8767: # C:according to course preferences
8768: # R:according to resource settings
8769: # L:unless locked
8770: # X:according to user session state
8771: #
8772:
8773: # Possibly locked functionality, check all courses
1.1454 raeburn 8774: # In roles.tab, L (unless locked) available for bre, pch, plc, pac and sma.
1.54 www 8775: # Locks might take effect only after 10 minutes cache expiration for other
1.1454 raeburn 8776: # courses, and 2 minutes for current course, in which user has st or ta role
8777: # which is neither expired nor a future role (unless current course).
1.52 www 8778:
1.1454 raeburn 8779: my ($needlockcheck,$now,$crsonly);
1.52 www 8780: if ($thisallowed=~/L/) {
1.1454 raeburn 8781: $now = time;
8782: if ($priv eq 'bre') {
8783: if ($uri ne '') {
8784: if ($orguri =~ m{^/+res/}) {
8785: if ($uri =~ m{^lib/templates/}) {
8786: if ($env{'request.course.id'}) {
8787: $crsonly = 1;
8788: $needlockcheck = 1;
8789: }
8790: } else {
8791: $needlockcheck = 1;
8792: }
8793: } elsif ($env{'request.course.id'}) {
8794: my ($crsdom,$crsnum) = split('_',$env{'request.course.id'});
8795: if (($uri =~ m{^(adm|uploaded|public)/$crsdom/$crsnum/}) ||
8796: ($uri =~ m{^adm/$match_domain/$match_username/\d+/(smppg|bulletinboard)$})) {
8797: $crsonly = 1;
8798: }
8799: $needlockcheck = 1;
8800: }
8801: }
8802: } elsif (($priv eq 'pch') || ($priv eq 'plc') || ($priv eq 'pac') || ($priv eq 'sma')) {
8803: $needlockcheck = 1;
8804: }
8805: }
8806: if ($needlockcheck) {
1.1453 raeburn 8807: foreach my $envkey (keys(%env)) {
1.54 www 8808: if ($envkey=~/^user\.role\.(st|ta)\.([^\.]*)/) {
8809: my $courseid=$2;
8810: my $roleid=$1.'.'.$2;
1.92 www 8811: $courseid=~s/^\///;
1.1453 raeburn 8812: unless ($env{'request.role'} eq $roleid) {
8813: my ($start,$end) = split(/\./,$env{$envkey});
8814: next unless (($now >= $start) && (!$end || $end > $now));
8815: }
1.54 www 8816: my $expiretime=600;
1.620 albertel 8817: if ($env{'request.role'} eq $roleid) {
1.54 www 8818: $expiretime=120;
8819: }
8820: my ($cdom,$cnum,$csec)=split(/\//,$courseid);
8821: my $prefix='course.'.$cdom.'_'.$cnum.'.';
1.620 albertel 8822: if ((time-$env{$prefix.'last_cache'})>$expiretime) {
1.731 albertel 8823: &coursedescription($courseid,{'freshen_cache' => 1});
1.54 www 8824: }
1.620 albertel 8825: if (($env{$prefix.'res.'.$uri.'.lock.sections'}=~/\,\Q$csec\E\,/)
8826: || ($env{$prefix.'res.'.$uri.'.lock.sections'} eq 'all')) {
8827: if ($env{$prefix.'res.'.$uri.'.lock.expire'}>time) {
8828: &log($env{'user.domain'},$env{'user.name'},
8829: $env{'user.home'},
1.57 www 8830: 'Locked by res: '.$priv.' for '.$uri.' due to '.
1.52 www 8831: $cdom.'/'.$cnum.'/'.$csec.' expire '.
1.620 albertel 8832: $env{$prefix.'priv.'.$priv.'.lock.expire'});
1.52 www 8833: return '';
8834: }
8835: }
1.620 albertel 8836: if (($env{$prefix.'priv.'.$priv.'.lock.sections'}=~/\,\Q$csec\E\,/)
8837: || ($env{$prefix.'priv.'.$priv.'.lock.sections'} eq 'all')) {
1.1455 raeburn 8838: if ($env{$prefix.'priv.'.$priv.'.lock.expire'}>time) {
1.620 albertel 8839: &log($env{'user.domain'},$env{'user.name'},
8840: $env{'user.home'},
1.57 www 8841: 'Locked by priv: '.$priv.' for '.$uri.' due to '.
1.52 www 8842: $cdom.'/'.$cnum.'/'.$csec.' expire '.
1.620 albertel 8843: $env{$prefix.'priv.'.$priv.'.lock.expire'});
1.52 www 8844: return '';
8845: }
8846: }
8847: }
1.29 www 8848: }
1.52 www 8849: }
1.1424 raeburn 8850:
1.52 www 8851: #
8852: # Rest of the restrictions depend on selected course
8853: #
8854:
1.620 albertel 8855: unless ($env{'request.course.id'}) {
1.766 albertel 8856: if ($thisallowed eq 'A') {
8857: return 'A';
1.814 raeburn 8858: } elsif ($thisallowed eq 'B') {
8859: return 'B';
1.766 albertel 8860: } else {
8861: return '1';
8862: }
1.52 www 8863: }
1.29 www 8864:
1.52 www 8865: #
8866: # Now user is definitely in a course
8867: #
1.53 www 8868:
8869:
8870: # Course preferences
8871:
8872: if ($thisallowed=~/C/) {
1.620 albertel 8873: my $rolecode=(split(/\./,$env{'request.role'}))[0];
8874: my $unamedom=$env{'user.name'}.':'.$env{'user.domain'};
8875: if ($env{'course.'.$env{'request.course.id'}.'.'.$priv.'.roles.denied'}
1.479 albertel 8876: =~/\Q$rolecode\E/) {
1.1304 raeburn 8877: if (($priv ne 'pch') && ($priv ne 'plc') && ($priv ne 'pac')) {
1.689 albertel 8878: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.':'.
8879: 'Denied by role: '.$priv.' for '.$uri.' as '.$rolecode.' in '.
8880: $env{'request.course.id'});
8881: }
1.237 www 8882: return '';
8883: }
8884:
1.620 albertel 8885: if ($env{'course.'.$env{'request.course.id'}.'.'.$priv.'.users.denied'}
1.479 albertel 8886: =~/\Q$unamedom\E/) {
1.1304 raeburn 8887: if (($priv ne 'pch') && ($priv ne 'plc') && ($priv ne 'pac')) {
1.689 albertel 8888: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.
8889: 'Denied by user: '.$priv.' for '.$uri.' as '.$unamedom.' in '.
8890: $env{'request.course.id'});
8891: }
1.54 www 8892: return '';
8893: }
1.53 www 8894: }
8895:
8896: # Resource preferences
8897:
8898: if ($thisallowed=~/R/) {
1.620 albertel 8899: my $rolecode=(split(/\./,$env{'request.role'}))[0];
1.479 albertel 8900: if (&metadata($uri,'roledeny')=~/\Q$rolecode\E/) {
1.1103 raeburn 8901: if (($priv ne 'pch') && ($priv ne 'plc')) {
1.689 albertel 8902: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.':'.
8903: 'Denied by role: '.$priv.' for '.$uri.' as '.$rolecode);
8904: }
8905: return '';
1.54 www 8906: }
1.53 www 8907: }
1.30 www 8908:
1.1461 raeburn 8909: # Restricted for deeplinked session?
8910:
8911: if ($env{'request.deeplink.login'}) {
8912: if ($env{'acc.deeplinkout'} && !$nodeeplinkout) {
8913: if (!$symb) { $symb=&symbread($uri,1); }
8914: if (($symb) && ($env{'acc.deeplinkout'}=~/\&\Q$symb\E\&/)) {
8915: return '';
8916: }
8917: }
8918: }
8919:
1.246 www 8920: # Restricted by state or randomout?
1.30 www 8921:
1.52 www 8922: if ($thisallowed=~/X/) {
1.620 albertel 8923: if ($env{'acc.randomout'}) {
1.579 albertel 8924: if (!$symb) { $symb=&symbread($uri,1); }
1.620 albertel 8925: if (($symb) && ($env{'acc.randomout'}=~/\&\Q$symb\E\&/)) {
1.248 www 8926: return '';
8927: }
1.247 www 8928: }
8929: if (&condval($statecond)) {
1.52 www 8930: return '2';
8931: } else {
8932: return '';
8933: }
8934: }
1.30 www 8935:
1.766 albertel 8936: if ($thisallowed eq 'A') {
8937: return 'A';
1.814 raeburn 8938: } elsif ($thisallowed eq 'B') {
8939: return 'B';
1.1402 raeburn 8940: } elsif ($thisallowed eq 'D') {
8941: return 'D';
1.766 albertel 8942: }
1.52 www 8943: return 'F';
1.232 www 8944: }
1.1162 raeburn 8945:
1.1192 raeburn 8946: # ------------------------------------------- Check construction space access
8947:
8948: sub constructaccess {
8949: my ($url,$setpriv)=@_;
8950:
8951: # We do not allow editing of previous versions of files
8952: if ($url=~/\.(\d+)\.(\w+)$/) { return ''; }
8953:
8954: # Get username and domain from URL
8955: my ($ownername,$ownerdomain,$ownerhome);
8956:
8957: ($ownerdomain,$ownername) =
1.1325 raeburn 8958: ($url=~ m{^(?:\Q$perlvar{'lonDocRoot'}\E|)(?:/daxepage|/daxeopen)?/priv/($match_domain)/($match_username)(?:/|$)});
1.1192 raeburn 8959:
8960: # The URL does not really point to any authorspace, forget it
8961: unless (($ownername) && ($ownerdomain)) { return ''; }
8962:
8963: # Now we need to see if the user has access to the authorspace of
8964: # $ownername at $ownerdomain
8965:
8966: if (($ownername eq $env{'user.name'}) && ($ownerdomain eq $env{'user.domain'})) {
8967: # Real author for this?
8968: $ownerhome = $env{'user.home'};
8969: if (exists($env{'user.priv.au./'.$ownerdomain.'/./'})) {
8970: return ($ownername,$ownerdomain,$ownerhome);
8971: }
8972: } else {
8973: # Co-author for this?
8974: if (exists($env{'user.priv.ca./'.$ownerdomain.'/'.$ownername.'./'}) ||
8975: exists($env{'user.priv.aa./'.$ownerdomain.'/'.$ownername.'./'}) ) {
8976: $ownerhome = &homeserver($ownername,$ownerdomain);
8977: return ($ownername,$ownerdomain,$ownerhome);
8978: }
1.1312 raeburn 8979: if ($env{'request.course.id'}) {
8980: if (($ownername eq $env{'course.'.$env{'request.course.id'}.'.num'}) &&
8981: ($ownerdomain eq $env{'course.'.$env{'request.course.id'}.'.domain'})) {
8982: if (&allowed('mdc',$env{'request.course.id'})) {
8983: $ownerhome = $env{'course.'.$env{'request.course.id'}.'.home'};
8984: return ($ownername,$ownerdomain,$ownerhome);
8985: }
8986: }
8987: }
1.1192 raeburn 8988: }
8989:
8990: # We don't have any access right now. If we are not possibly going to do anything about this,
8991: # we might as well leave
8992: unless ($setpriv) { return ''; }
8993:
8994: # Backdoor access?
8995: my $allowed=&allowed('eco',$ownerdomain);
8996: # Nope
8997: unless ($allowed) { return ''; }
8998: # Looks like we may have access, but could be locked by the owner of the construction space
8999: if ($allowed eq 'U') {
9000: my %blocked=&get('environment',['domcoord.author'],
9001: $ownerdomain,$ownername);
9002: # Is blocked by owner
9003: if ($blocked{'domcoord.author'} eq 'blocked') { return ''; }
9004: }
9005: if (($allowed eq 'F') || ($allowed eq 'U')) {
9006: # Grant temporary access
9007: my $then=$env{'user.login.time'};
1.1209 raeburn 9008: my $update=$env{'user.update.time'};
1.1192 raeburn 9009: if (!$update) { $update = $then; }
9010: my $refresh=$env{'user.refresh.time'};
9011: if (!$refresh) { $refresh = $update; }
9012: my $now = time;
9013: &check_adhoc_privs($ownerdomain,$ownername,$update,$refresh,
9014: $now,'ca','constructaccess');
9015: $ownerhome = &homeserver($ownername,$ownerdomain);
9016: return($ownername,$ownerdomain,$ownerhome);
9017: }
9018: # No business here
9019: return '';
9020: }
9021:
1.1282 raeburn 9022: # ----------------------------------------------------------- Content Blocking
9023:
9024: {
9025: # Caches for faster Course Contents display where content blocking
9026: # is in operation (i.e., interval param set) for timed quiz.
9027: #
9028: # User for whom data are being temporarily cached.
9029: my $cacheduser='';
1.1424 raeburn 9030: # Course for which data are being temporarily cached.
9031: my $cachedcid='';
1.1282 raeburn 9032: # Cached blockers for this user (a hash of blocking items).
9033: my %cachedblockers=();
9034: # When the data were last cached.
9035: my $cachedlast='';
9036:
9037: sub load_all_blockers {
1.1427 raeburn 9038: my ($uname,$udom)=@_;
1.1282 raeburn 9039: if (($uname ne '') && ($udom ne '')) {
9040: if (($cacheduser eq $uname.':'.$udom) &&
1.1424 raeburn 9041: ($cachedcid eq $env{'request.course.id'}) &&
1.1427 raeburn 9042: (abs($cachedlast-time)<5)) {
1.1282 raeburn 9043: return;
9044: }
9045: }
9046: $cachedlast=time;
9047: $cacheduser=$uname.':'.$udom;
1.1424 raeburn 9048: $cachedcid=$env{'request.course.id'};
1.1427 raeburn 9049: %cachedblockers = &get_commblock_resources();
1.1424 raeburn 9050: return;
1.1282 raeburn 9051: }
9052:
1.1162 raeburn 9053: sub get_comm_blocks {
9054: my ($cdom,$cnum) = @_;
9055: if ($cdom eq '' || $cnum eq '') {
9056: return unless ($env{'request.course.id'});
9057: $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
9058: $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
9059: }
9060: my %commblocks;
9061: my $hashid=$cdom.'_'.$cnum;
9062: my ($blocksref,$cached)=&is_cached_new('comm_block',$hashid);
9063: if ((defined($cached)) && (ref($blocksref) eq 'HASH')) {
9064: %commblocks = %{$blocksref};
9065: } else {
1.1494 raeburn 9066: %commblocks = &dump('comm_block',$cdom,$cnum);
1.1162 raeburn 9067: my $cachetime = 600;
9068: &do_cache_new('comm_block',$hashid,\%commblocks,$cachetime);
9069: }
9070: return %commblocks;
9071: }
9072:
1.1282 raeburn 9073: sub get_commblock_resources {
9074: my ($blocks) = @_;
9075: my %blockers = ();
9076: return %blockers unless ($env{'request.course.id'});
1.1470 raeburn 9077: my $courseurl = &courseid_to_courseurl($env{'request.course.id'});
9078: if ($env{'request.course.sec'}) {
9079: $courseurl .= '/'.$env{'request.course.sec'};
9080: }
9081: return %blockers if ($env{'user.priv.'.$env{'request.role'}.'.'.$courseurl} =~/evb\&([^\:]*)/);
1.1162 raeburn 9082: my %commblocks;
9083: if (ref($blocks) eq 'HASH') {
9084: %commblocks = %{$blocks};
9085: } else {
9086: %commblocks = &get_comm_blocks();
9087: }
1.1282 raeburn 9088: return %blockers unless (keys(%commblocks) > 0);
9089: my $navmap = Apache::lonnavmaps::navmap->new();
9090: return %blockers unless (ref($navmap));
1.1162 raeburn 9091: my $now = time;
9092: foreach my $block (keys(%commblocks)) {
9093: if ($block =~ /^(\d+)____(\d+)$/) {
9094: my ($start,$end) = ($1,$2);
9095: if ($start <= $now && $end >= $now) {
9096: if (ref($commblocks{$block}{'blocks'}) eq 'HASH') {
9097: if (ref($commblocks{$block}{'blocks'}{'docs'}) eq 'HASH') {
9098: if (ref($commblocks{$block}{'blocks'}{'docs'}{'maps'}) eq 'HASH') {
1.1282 raeburn 9099: if (keys(%{$commblocks{$block}{'blocks'}{'docs'}{'maps'}})) {
9100: $blockers{$block}{maps} = $commblocks{$block}{'blocks'}{'docs'}{'maps'};
1.1162 raeburn 9101: }
9102: }
9103: if (ref($commblocks{$block}{'blocks'}{'docs'}{'resources'}) eq 'HASH') {
1.1282 raeburn 9104: if (keys(%{$commblocks{$block}{'blocks'}{'docs'}{'resources'}})) {
9105: $blockers{$block}{'resources'} = $commblocks{$block}{'blocks'}{'docs'}{'resources'};
1.1162 raeburn 9106: }
9107: }
9108: }
9109: }
9110: }
9111: } elsif ($block =~ /^firstaccess____(.+)$/) {
9112: my $item = $1;
9113: if (ref($commblocks{$block}{'blocks'}) eq 'HASH') {
9114: if (ref($commblocks{$block}{'blocks'}{'docs'}) eq 'HASH') {
1.1471 raeburn 9115: my (@interval,$mapname);
1.1282 raeburn 9116: my $type = 'map';
9117: if ($item eq 'course') {
9118: $type = 'course';
9119: @interval=&EXT("resource.0.interval");
9120: } else {
9121: if ($item =~ /___\d+___/) {
9122: $type = 'resource';
9123: @interval=&EXT("resource.0.interval",$item);
1.1162 raeburn 9124: } else {
1.1471 raeburn 9125: $mapname = &deversion($item);
9126: if (ref($navmap)) {
9127: my $timelimit = $navmap->get_mapparam(undef,$mapname,'0.interval');
9128: @interval = ($timelimit,'map');
1.1162 raeburn 9129: }
9130: }
1.1282 raeburn 9131: }
1.1310 raeburn 9132: if ($interval[0] =~ /^(\d+)/) {
1.1308 raeburn 9133: my $timelimit = $1;
1.1282 raeburn 9134: my $first_access;
9135: if ($type eq 'resource') {
9136: $first_access=&get_first_access($interval[1],$item);
9137: } elsif ($type eq 'map') {
9138: $first_access=&get_first_access($interval[1],undef,$item);
9139: } else {
9140: $first_access=&get_first_access($interval[1]);
9141: }
9142: if ($first_access) {
1.1292 raeburn 9143: my $timesup = $first_access+$timelimit;
1.1282 raeburn 9144: if ($timesup > $now) {
9145: my $activeblock;
1.1471 raeburn 9146: if ($type eq 'resource') {
9147: if (ref($navmap)) {
9148: my $res = $navmap->getBySymb($item);
9149: if ($res->answerable()) {
9150: $activeblock = 1;
9151: }
9152: }
9153: } elsif ($type eq 'map') {
9154: my $mapsymb = &symbread($mapname,1);
9155: if (($mapsymb) && (ref($navmap))) {
9156: my $mapres = $navmap->getBySymb($mapsymb);
9157: if (ref($mapres)) {
9158: my $first = $mapres->map_start();
9159: my $finish = $mapres->map_finish();
9160: my $it = $navmap->getIterator($first,$finish,undef,0,0);
9161: if (ref($it)) {
9162: my $res;
9163: while ($res = $it->next(undef,1)) {
9164: next unless (ref($res));
9165: my $symb = $res->symb();
9166: next if (($symb eq $mapsymb) || ($symb eq ''));
9167: @interval=&EXT("resource.0.interval",$symb);
9168: if ($interval[1] eq 'map') {
9169: if ($res->answerable()) {
9170: $activeblock = 1;
9171: last;
9172: }
9173: }
9174: }
9175: }
9176: }
1.1282 raeburn 9177: }
9178: }
9179: if ($activeblock) {
9180: if (ref($commblocks{$block}{'blocks'}{'docs'}{'maps'}) eq 'HASH') {
9181: if (keys(%{$commblocks{$block}{'blocks'}{'docs'}{'maps'}})) {
9182: $blockers{$block}{'maps'} = $commblocks{$block}{'blocks'}{'docs'}{'maps'};
9183: }
9184: }
9185: if (ref($commblocks{$block}{'blocks'}{'docs'}{'resources'}) eq 'HASH') {
9186: if (keys(%{$commblocks{$block}{'blocks'}{'docs'}{'resources'}})) {
9187: $blockers{$block}{'resources'} = $commblocks{$block}{'blocks'}{'docs'}{'resources'};
1.1163 raeburn 9188: }
1.1162 raeburn 9189: }
9190: }
9191: }
9192: }
9193: }
9194: }
9195: }
9196: }
9197: }
1.1282 raeburn 9198: return %blockers;
1.1162 raeburn 9199: }
9200:
1.1282 raeburn 9201: sub has_comm_blocking {
1.1427 raeburn 9202: my ($priv,$symb,$uri,$ignoresymbdb,$noenccheck,$blocked,$blocks) = @_;
1.1282 raeburn 9203: my @blockers;
9204: return unless ($env{'request.course.id'});
9205: return unless ($priv eq 'bre');
9206: return if ($env{'request.state'} eq 'construct');
1.1470 raeburn 9207: my $courseurl = &courseid_to_courseurl($env{'request.course.id'});
9208: if ($env{'request.course.sec'}) {
9209: $courseurl .= '/'.$env{'request.course.sec'};
9210: }
9211: return if ($env{'user.priv.'.$env{'request.role'}.'.'.$courseurl} =~/evb\&([^\:]*)/);
1.1427 raeburn 9212: my %blockinfo;
9213: if (ref($blocks) eq 'HASH') {
9214: %blockinfo = &get_commblock_resources($blocks);
9215: } else {
9216: &load_all_blockers($env{'user.name'},$env{'user.domain'});
9217: %blockinfo = %cachedblockers;
9218: }
9219: return unless (keys(%blockinfo) > 0);
1.1282 raeburn 9220: my (%possibles,@symbs);
9221: if (!$symb) {
1.1427 raeburn 9222: $symb = &symbread($uri,1,1,1,\%possibles,$ignoresymbdb,$noenccheck);
1.1162 raeburn 9223: }
1.1282 raeburn 9224: if ($symb) {
9225: @symbs = ($symb);
9226: } elsif (keys(%possibles)) {
9227: @symbs = keys(%possibles);
9228: }
9229: my $noblock;
9230: foreach my $symb (@symbs) {
9231: last if ($noblock);
9232: my ($map,$resid,$resurl)=&decode_symb($symb);
1.1427 raeburn 9233: foreach my $block (keys(%blockinfo)) {
1.1282 raeburn 9234: if ($block =~ /^firstaccess____(.+)$/) {
9235: my $item = $1;
1.1424 raeburn 9236: unless ($blocked) {
9237: if (($item eq $map) || ($item eq $symb)) {
9238: $noblock = 1;
9239: last;
9240: }
1.1282 raeburn 9241: }
9242: }
1.1427 raeburn 9243: if (ref($blockinfo{$block}) eq 'HASH') {
9244: if (ref($blockinfo{$block}{'resources'}) eq 'HASH') {
9245: if ($blockinfo{$block}{'resources'}{$symb}) {
1.1282 raeburn 9246: unless (grep(/^\Q$block\E$/,@blockers)) {
9247: push(@blockers,$block);
9248: }
9249: }
9250: }
1.1427 raeburn 9251: if (ref($blockinfo{$block}{'maps'}) eq 'HASH') {
9252: if ($blockinfo{$block}{'maps'}{$map}) {
1.1424 raeburn 9253: unless (grep(/^\Q$block\E$/,@blockers)) {
9254: push(@blockers,$block);
9255: }
1.1282 raeburn 9256: }
9257: }
1.1162 raeburn 9258: }
9259: }
9260: }
1.1424 raeburn 9261: unless ($noblock) {
9262: return @blockers;
9263: }
9264: return;
1.1282 raeburn 9265: }
1.1162 raeburn 9266: }
9267:
1.1402 raeburn 9268: sub deeplink_check {
9269: my ($priv,$symb,$uri) = @_;
9270: return unless ($env{'request.course.id'});
9271: return unless ($priv eq 'bre');
9272: return if ($env{'request.state'} eq 'construct');
9273: return if ($env{'request.role.adv'});
9274: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
9275: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
9276: my (%possibles,@symbs);
9277: if (!$symb) {
9278: $symb = &symbread($uri,1,1,1,\%possibles);
9279: }
9280: if ($symb) {
9281: @symbs = ($symb);
9282: } elsif (keys(%possibles)) {
9283: @symbs = keys(%possibles);
9284: }
9285:
1.1461 raeburn 9286: my ($deeplink_symb,$allow);
9287: if ($env{'request.deeplink.login'}) {
9288: $deeplink_symb = &Apache::loncommon::deeplink_login_symb($cnum,$cdom);
1.1402 raeburn 9289: }
9290: foreach my $symb (@symbs) {
9291: last if ($allow);
9292: my $deeplink = &EXT("resource.0.deeplink",$symb);
9293: if ($deeplink eq '') {
9294: $allow = 1;
9295: } else {
1.1463 raeburn 9296: my ($state,$others,$listed,$scope,$protect) = split(/,/,$deeplink);
9297: if ($state ne 'only') {
1.1402 raeburn 9298: $allow = 1;
1.1463 raeburn 9299: } else {
9300: my $check_deeplink_entry;
9301: if ($protect ne 'none') {
9302: my ($acctype,$item) = split(/:/,$protect);
9303: if (($acctype eq 'ltic') && ($env{'user.linkprotector'})) {
9304: if (grep(/^\Q$item\Ec$/,split(/,/,$env{'user.linkprotector'}))) {
9305: $check_deeplink_entry = 1
9306: }
9307: } elsif (($acctype eq 'ltid') && ($env{'user.linkprotector'})) {
9308: if (grep(/^\Q$item\Ed$/,split(/,/,$env{'user.linkprotector'}))) {
9309: $check_deeplink_entry = 1;
9310: }
9311: } elsif (($acctype eq 'key') && ($env{'user.deeplinkkey'})) {
9312: if (grep(/^\Q$item\E$/,split(/,/,$env{'user.deeplinkkey'}))) {
9313: $check_deeplink_entry = 1;
9314: }
9315: }
9316: }
9317: if (($protect eq 'none') || ($check_deeplink_entry)) {
1.1402 raeburn 9318: if ($scope eq 'res') {
1.1461 raeburn 9319: if ($symb eq $deeplink_symb) {
1.1402 raeburn 9320: $allow = 1;
9321: }
1.1459 raeburn 9322: } elsif (($scope eq 'map') || ($scope eq 'rec')) {
1.1463 raeburn 9323: my ($map_from_symb,$map_from_login);
1.1461 raeburn 9324: $map_from_symb = &deversion((&decode_symb($symb))[0]);
9325: if ($deeplink_symb =~ /\.(page|sequence)$/) {
9326: $map_from_login = &deversion((&decode_symb($deeplink_symb))[2]);
9327: } else {
9328: $map_from_login = &deversion((&decode_symb($deeplink_symb))[0]);
9329: }
1.1459 raeburn 9330: if (($map_from_symb) && ($map_from_login)) {
9331: if ($map_from_symb eq $map_from_login) {
9332: $allow = 1;
9333: } elsif ($scope eq 'rec') {
9334: my @recurseup = &get_map_hierarchy($map_from_symb,$env{'request.course.id'});
9335: if (grep(/^\Q$map_from_login\E$/,@recurseup)) {
9336: $allow = 1;
9337: }
9338: }
9339: }
1.1402 raeburn 9340: }
9341: }
9342: }
9343: }
9344: }
9345: return if ($allow);
9346: return 1;
9347: }
9348:
1.1282 raeburn 9349: # -------------------------------- Deversion and split uri into path an filename
9350:
1.1133 foxr 9351: #
1.1282 raeburn 9352: # Removes the version from a URI and
1.1133 foxr 9353: # splits it in to its filename and path to the filename.
9354: # Seems like File::Basename could have done this more clearly.
9355: # Parameters:
9356: # $uri - input URI
9357: # Returns:
9358: # Two element list consisting of
9359: # $pathname - the URI up to and excluding the trailing /
9360: # $filename - The part of the URI following the last /
9361: # NOTE:
9362: # Another realization of this is simply:
9363: # use File::Basename;
9364: # ...
9365: # $uri = shift;
9366: # $filename = basename($uri);
9367: # $path = dirname($uri);
9368: # return ($filename, $path);
9369: #
9370: # The implementation below is probably faster however.
9371: #
1.710 albertel 9372: sub split_uri_for_cond {
9373: my $uri=&deversion(&declutter(shift));
9374: my @uriparts=split(/\//,$uri);
9375: my $filename=pop(@uriparts);
9376: my $pathname=join('/',@uriparts);
9377: return ($pathname,$filename);
9378: }
1.232 www 9379: # --------------------------------------------------- Is a resource on the map?
9380:
9381: sub is_on_map {
1.710 albertel 9382: my ($pathname,$filename) = &split_uri_for_cond(shift);
1.289 bowersj2 9383: #Trying to find the conditional for the file
1.620 albertel 9384: my $match=($env{'acc.res.'.$env{'request.course.id'}.'.'.$pathname}=~
1.289 bowersj2 9385: /\&\Q$filename\E\:([\d\|]+)\&/);
1.232 www 9386: if ($match) {
1.289 bowersj2 9387: return (1,$1);
9388: } else {
1.434 www 9389: return (0,0);
1.289 bowersj2 9390: }
1.12 www 9391: }
9392:
1.427 www 9393: # --------------------------------------------------------- Get symb from alias
9394:
9395: sub get_symb_from_alias {
9396: my $symb=shift;
9397: my ($map,$resid,$url)=&decode_symb($symb);
9398: # Already is a symb
9399: if ($url) { return $symb; }
9400: # Must be an alias
9401: my $aliassymb='';
9402: my %bighash;
1.620 albertel 9403: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
1.427 www 9404: &GDBM_READER(),0640)) {
9405: my $rid=$bighash{'mapalias_'.$symb};
9406: if ($rid) {
9407: my ($mapid,$resid)=split(/\./,$rid);
1.429 albertel 9408: $aliassymb=&encode_symb($bighash{'map_id_'.$mapid},
9409: $resid,$bighash{'src_'.$rid});
1.427 www 9410: }
9411: untie %bighash;
9412: }
9413: return $aliassymb;
9414: }
9415:
1.12 www 9416: # ----------------------------------------------------------------- Define Role
9417:
9418: sub definerole {
9419: if (allowed('mcr','/')) {
1.1326 raeburn 9420: my ($rolename,$sysrole,$domrole,$courole,$uname,$udom)=@_;
1.800 albertel 9421: foreach my $role (split(':',$sysrole)) {
9422: my ($crole,$cqual)=split(/\&/,$role);
1.479 albertel 9423: if ($pr{'cr:s'}!~/\Q$crole\E/) { return "refused:s:$crole"; }
9424: if ($pr{'cr:s'}=~/\Q$crole\E\&/) {
9425: if ($pr{'cr:s'}!~/\Q$crole\E\&\w*\Q$cqual\E/) {
1.21 www 9426: return "refused:s:$crole&$cqual";
9427: }
9428: }
1.191 harris41 9429: }
1.800 albertel 9430: foreach my $role (split(':',$domrole)) {
9431: my ($crole,$cqual)=split(/\&/,$role);
1.479 albertel 9432: if ($pr{'cr:d'}!~/\Q$crole\E/) { return "refused:d:$crole"; }
9433: if ($pr{'cr:d'}=~/\Q$crole\E\&/) {
9434: if ($pr{'cr:d'}!~/\Q$crole\W\&\w*\Q$cqual\E/) {
1.21 www 9435: return "refused:d:$crole&$cqual";
9436: }
9437: }
1.191 harris41 9438: }
1.800 albertel 9439: foreach my $role (split(':',$courole)) {
9440: my ($crole,$cqual)=split(/\&/,$role);
1.479 albertel 9441: if ($pr{'cr:c'}!~/\Q$crole\E/) { return "refused:c:$crole"; }
9442: if ($pr{'cr:c'}=~/\Q$crole\E\&/) {
9443: if ($pr{'cr:c'}!~/\Q$crole\E\&\w*\Q$cqual\E/) {
1.21 www 9444: return "refused:c:$crole&$cqual";
9445: }
9446: }
1.191 harris41 9447: }
1.1326 raeburn 9448: my $uhome;
9449: if (($uname ne '') && ($udom ne '')) {
9450: $uhome = &homeserver($uname,$udom);
9451: return $uhome if ($uhome eq 'no_host');
9452: } else {
9453: $uname = $env{'user.name'};
9454: $udom = $env{'user.domain'};
9455: $uhome = $env{'user.home'};
9456: }
1.620 albertel 9457: my $command="encrypt:rolesput:$env{'user.domain'}:$env{'user.name'}:".
1.1326 raeburn 9458: "$udom:$uname:rolesdef_$rolename=".
1.21 www 9459: escape($sysrole.'_'.$domrole.'_'.$courole);
1.1326 raeburn 9460: return reply($command,$uhome);
1.12 www 9461: } else {
9462: return 'refused';
9463: }
1.105 harris41 9464: }
9465:
9466: # ---------------- Make a metadata query against the network of library servers
9467:
9468: sub metadata_query {
1.1237 raeburn 9469: my ($query,$custom,$customshow,$server_array,$domains_hash)=@_;
1.120 harris41 9470: my %rhash;
1.845 albertel 9471: my %libserv = &all_library();
1.244 matthew 9472: my @server_list = (defined($server_array) ? @$server_array
9473: : keys(%libserv) );
9474: for my $server (@server_list) {
1.1237 raeburn 9475: my $domains = '';
9476: if (ref($domains_hash) eq 'HASH') {
9477: $domains = $domains_hash->{$server};
9478: }
1.118 harris41 9479: unless ($custom or $customshow) {
1.1237 raeburn 9480: my $reply=&reply("querysend:".&escape($query).':::'.&escape($domains),$server);
1.118 harris41 9481: $rhash{$server}=$reply;
9482: }
9483: else {
9484: my $reply=&reply("querysend:".&escape($query).':'.
1.1237 raeburn 9485: &escape($custom).':'.&escape($customshow).':'.&escape($domains),
1.118 harris41 9486: $server);
9487: $rhash{$server}=$reply;
9488: }
1.112 harris41 9489: }
1.118 harris41 9490: return \%rhash;
1.240 www 9491: }
9492:
9493: # ----------------------------------------- Send log queries and wait for reply
9494:
9495: sub log_query {
9496: my ($uname,$udom,$query,%filters)=@_;
9497: my $uhome=&homeserver($uname,$udom);
9498: if ($uhome eq 'no_host') { return 'error: no_host'; }
1.838 albertel 9499: my $uhost=&hostname($uhome);
1.800 albertel 9500: my $command=&escape(join(':',map{$_.'='.$filters{$_}} keys(%filters)));
1.240 www 9501: my $queryid=&reply("querysend:".$query.':'.$udom.':'.$uname.':'.$command,
9502: $uhome);
1.479 albertel 9503: unless ($queryid=~/^\Q$uhost\E\_/) { return 'error: '.$queryid; }
1.242 www 9504: return get_query_reply($queryid);
9505: }
9506:
1.818 raeburn 9507: # -------------------------- Update MySQL table for portfolio file
9508:
9509: sub update_portfolio_table {
1.821 raeburn 9510: my ($uname,$udom,$file_name,$query,$group,$action) = @_;
1.970 raeburn 9511: if ($group ne '') {
9512: $file_name =~s /^\Q$group\E//;
9513: }
1.818 raeburn 9514: my $homeserver = &homeserver($uname,$udom);
9515: my $queryid=
1.821 raeburn 9516: &reply("querysend:".$query.':'.&escape($uname.':'.$udom.':'.$group).
9517: ':'.&escape($file_name).':'.$action,$homeserver);
1.818 raeburn 9518: my $reply = &get_query_reply($queryid);
9519: return $reply;
9520: }
9521:
1.899 raeburn 9522: # -------------------------- Update MySQL allusers table
9523:
9524: sub update_allusers_table {
9525: my ($uname,$udom,$names) = @_;
9526: my $homeserver = &homeserver($uname,$udom);
9527: my $queryid=
9528: &reply('querysend:allusers:'.&escape($uname).':'.&escape($udom).':'.
9529: 'lastname='.&escape($names->{'lastname'}).'%%'.
9530: 'firstname='.&escape($names->{'firstname'}).'%%'.
9531: 'middlename='.&escape($names->{'middlename'}).'%%'.
9532: 'generation='.&escape($names->{'generation'}).'%%'.
9533: 'permanentemail='.&escape($names->{'permanentemail'}).'%%'.
9534: 'id='.&escape($names->{'id'}),$homeserver);
1.1075 raeburn 9535: return;
1.899 raeburn 9536: }
9537:
1.508 raeburn 9538: # ------- Request retrieval of institutional classlists for course(s)
1.506 raeburn 9539:
9540: sub fetch_enrollment_query {
1.511 raeburn 9541: my ($context,$affiliatesref,$replyref,$dom,$cnum) = @_;
1.1317 raeburn 9542: my ($homeserver,$sleep,$loopmax);
1.547 raeburn 9543: my $maxtries = 1;
1.508 raeburn 9544: if ($context eq 'automated') {
9545: $homeserver = $perlvar{'lonHostID'};
1.1317 raeburn 9546: $sleep = 2;
9547: $loopmax = 100;
1.547 raeburn 9548: $maxtries = 10; # will wait for up to 2000s for retrieval of classlist data before timeout
1.508 raeburn 9549: } else {
9550: $homeserver = &homeserver($cnum,$dom);
9551: }
1.838 albertel 9552: my $host=&hostname($homeserver);
1.506 raeburn 9553: my $cmd = '';
1.1000 raeburn 9554: foreach my $affiliate (keys(%{$affiliatesref})) {
1.800 albertel 9555: $cmd .= $affiliate.'='.join(",",@{$$affiliatesref{$affiliate}}).'%%';
1.506 raeburn 9556: }
9557: $cmd =~ s/%%$//;
9558: $cmd = &escape($cmd);
9559: my $query = 'fetchenrollment';
1.620 albertel 9560: my $queryid=&reply("querysend:".$query.':'.$dom.':'.$env{'user.name'}.':'.$cmd,$homeserver);
1.526 raeburn 9561: unless ($queryid=~/^\Q$host\E\_/) {
9562: &logthis('fetch_enrollment_query: invalid queryid: '.$queryid.' for host: '.$host.' and homeserver: '.$homeserver.' context: '.$context.' '.$cnum);
9563: return 'error: '.$queryid;
9564: }
1.1317 raeburn 9565: my $reply = &get_query_reply($queryid,$sleep,$loopmax);
1.547 raeburn 9566: my $tries = 1;
9567: while (($reply=~/^timeout/) && ($tries < $maxtries)) {
1.1317 raeburn 9568: $reply = &get_query_reply($queryid,$sleep,$loopmax);
1.547 raeburn 9569: $tries ++;
9570: }
1.526 raeburn 9571: if ( ($reply =~/^timeout/) || ($reply =~/^error/) ) {
1.620 albertel 9572: &logthis('fetch_enrollment_query error: '.$reply.' for '.$dom.' '.$env{'user.name'}.' for '.$queryid.' context: '.$context.' '.$cnum.' maxtries: '.$maxtries.' tries: '.$tries);
1.526 raeburn 9573: } else {
1.901 albertel 9574: my @responses = split(/:/,$reply);
1.1322 raeburn 9575: if (grep { $_ eq $homeserver } ¤t_machine_ids()) {
1.800 albertel 9576: foreach my $line (@responses) {
9577: my ($key,$value) = split(/=/,$line,2);
1.515 raeburn 9578: $$replyref{$key} = $value;
9579: }
9580: } else {
1.1117 foxr 9581: my $pathname = LONCAPA::tempdir();
1.800 albertel 9582: foreach my $line (@responses) {
9583: my ($key,$value) = split(/=/,$line);
1.506 raeburn 9584: $$replyref{$key} = $value;
9585: if ($value > 0) {
1.800 albertel 9586: foreach my $item (@{$$affiliatesref{$key}}) {
9587: my $filename = $dom.'_'.$key.'_'.$item.'_classlist.xml';
1.506 raeburn 9588: my $destname = $pathname.'/'.$filename;
9589: my $xml_classlist = &reply("autoretrieve:".$filename,$homeserver);
1.526 raeburn 9590: if ($xml_classlist =~ /^error/) {
9591: &logthis('fetch_enrollment_query - autoretrieve error: '.$xml_classlist.' for '.$filename.' from server: '.$homeserver.' '.$context.' '.$cnum);
9592: } else {
1.1359 raeburn 9593: if ( open(FILE,">",$destname) ) {
1.506 raeburn 9594: print FILE &unescape($xml_classlist);
9595: close(FILE);
1.526 raeburn 9596: } else {
9597: &logthis('fetch_enrollment_query - error opening classlist file '.$destname.' '.$context.' '.$cnum);
1.506 raeburn 9598: }
9599: }
9600: }
9601: }
9602: }
9603: }
9604: return 'ok';
9605: }
9606: return 'error';
9607: }
9608:
1.242 www 9609: sub get_query_reply {
1.1471 raeburn 9610: my ($queryid,$sleep,$loopmax) = @_;
1.1317 raeburn 9611: if (($sleep eq '') || ($sleep !~ /^\d+\.?\d*$/)) {
9612: $sleep = 0.2;
9613: }
9614: if (($loopmax eq '') || ($loopmax =~ /\D/)) {
9615: $loopmax = 100;
9616: }
1.1117 foxr 9617: my $replyfile=LONCAPA::tempdir().$queryid;
1.240 www 9618: my $reply='';
1.1317 raeburn 9619: for (1..$loopmax) {
9620: sleep($sleep);
1.240 www 9621: if (-e $replyfile.'.end') {
1.1359 raeburn 9622: if (open(my $fh,"<",$replyfile)) {
1.904 albertel 9623: $reply = join('',<$fh>);
9624: close($fh);
1.240 www 9625: } else { return 'error: reply_file_error'; }
1.242 www 9626: return &unescape($reply);
9627: }
1.240 www 9628: }
1.242 www 9629: return 'timeout:'.$queryid;
1.240 www 9630: }
9631:
9632: sub courselog_query {
1.241 www 9633: #
9634: # possible filters:
9635: # url: url or symb
9636: # username
9637: # domain
9638: # action: view, submit, grade
9639: # start: timestamp
9640: # end: timestamp
9641: #
1.240 www 9642: my (%filters)=@_;
1.620 albertel 9643: unless ($env{'request.course.id'}) { return 'no_course'; }
1.241 www 9644: if ($filters{'url'}) {
9645: $filters{'url'}=&symbclean(&declutter($filters{'url'}));
9646: $filters{'url'}=~s/\.(\w+)$/(\\.\\d+)*\\.$1/;
9647: $filters{'url'}=~s/\.(\w+)\_\_\_/(\\.\\d+)*\\.$1/;
9648: }
1.620 albertel 9649: my $cname=$env{'course.'.$env{'request.course.id'}.'.num'};
9650: my $cdom=$env{'course.'.$env{'request.course.id'}.'.domain'};
1.240 www 9651: return &log_query($cname,$cdom,'courselog',%filters);
9652: }
9653:
9654: sub userlog_query {
1.858 raeburn 9655: #
9656: # possible filters:
9657: # action: log check role
9658: # start: timestamp
9659: # end: timestamp
9660: #
1.240 www 9661: my ($uname,$udom,%filters)=@_;
9662: return &log_query($uname,$udom,'userlog',%filters);
1.12 www 9663: }
9664:
1.506 raeburn 9665: #--------- Call auto-enrollment subs in localenroll.pm for homeserver for course
9666:
9667: sub auto_run {
1.508 raeburn 9668: my ($cnum,$cdom) = @_;
1.876 raeburn 9669: my $response = 0;
9670: my $settings;
9671: my %domconfig = &get_dom('configuration',['autoenroll'],$cdom);
9672: if (ref($domconfig{'autoenroll'}) eq 'HASH') {
9673: $settings = $domconfig{'autoenroll'};
9674: if ($settings->{'run'} eq '1') {
9675: $response = 1;
9676: }
9677: } else {
1.934 raeburn 9678: my $homeserver;
9679: if (&is_course($cdom,$cnum)) {
9680: $homeserver = &homeserver($cnum,$cdom);
9681: } else {
9682: $homeserver = &domain($cdom,'primary');
9683: }
9684: if ($homeserver ne 'no_host') {
9685: $response = &reply('autorun:'.$cdom,$homeserver);
9686: }
1.876 raeburn 9687: }
1.506 raeburn 9688: return $response;
9689: }
1.776 albertel 9690:
1.506 raeburn 9691: sub auto_get_sections {
1.508 raeburn 9692: my ($cnum,$cdom,$inst_coursecode) = @_;
1.1007 raeburn 9693: my $homeserver;
9694: if (($cdom =~ /^$match_domain$/) && ($cnum =~ /^$match_courseid$/)) {
9695: $homeserver = &homeserver($cnum,$cdom);
9696: }
9697: if (!defined($homeserver)) {
9698: if ($cdom =~ /^$match_domain$/) {
9699: $homeserver = &domain($cdom,'primary');
9700: }
9701: }
9702: my @secs;
9703: if (defined($homeserver)) {
9704: my $response=&unescape(&reply('autogetsections:'.$inst_coursecode.':'.$cdom,$homeserver));
9705: unless ($response eq 'refused') {
9706: @secs = split(/:/,$response);
9707: }
1.506 raeburn 9708: }
9709: return @secs;
9710: }
1.776 albertel 9711:
1.506 raeburn 9712: sub auto_new_course {
1.1099 raeburn 9713: my ($cnum,$cdom,$inst_course_id,$owner,$coowners) = @_;
1.508 raeburn 9714: my $homeserver = &homeserver($cnum,$cdom);
1.1099 raeburn 9715: my $response=&unescape(&reply('autonewcourse:'.$inst_course_id.':'.&escape($owner).':'.$cdom.':'.&escape($coowners),$homeserver));
1.506 raeburn 9716: return $response;
9717: }
1.776 albertel 9718:
1.506 raeburn 9719: sub auto_validate_courseID {
1.508 raeburn 9720: my ($cnum,$cdom,$inst_course_id) = @_;
9721: my $homeserver = &homeserver($cnum,$cdom);
1.511 raeburn 9722: my $response=&unescape(&reply('autovalidatecourse:'.$inst_course_id.':'.$cdom,$homeserver));
1.506 raeburn 9723: return $response;
9724: }
1.776 albertel 9725:
1.1007 raeburn 9726: sub auto_validate_instcode {
1.1020 raeburn 9727: my ($cnum,$cdom,$instcode,$owner) = @_;
1.1007 raeburn 9728: my ($homeserver,$response);
9729: if (($cdom =~ /^$match_domain$/) && ($cnum =~ /^$match_courseid$/)) {
9730: $homeserver = &homeserver($cnum,$cdom);
9731: }
9732: if (!defined($homeserver)) {
9733: if ($cdom =~ /^$match_domain$/) {
9734: $homeserver = &domain($cdom,'primary');
9735: }
9736: }
1.1065 raeburn 9737: $response=&unescape(&reply('autovalidateinstcode:'.$cdom.':'.
9738: &escape($instcode).':'.&escape($owner),$homeserver));
1.1216 raeburn 9739: my ($outcome,$description,$defaultcredits) = map { &unescape($_); } split('&',$response,3);
9740: return ($outcome,$description,$defaultcredits);
1.1007 raeburn 9741: }
9742:
1.1444 raeburn 9743: sub auto_validate_inst_crosslist {
9744: my ($cnum,$cdom,$instcode,$inst_xlist,$coowner) = @_;
9745: my ($homeserver,$response);
9746: if (($cdom =~ /^$match_domain$/) && ($cnum =~ /^$match_courseid$/)) {
9747: $homeserver = &homeserver($cnum,$cdom);
9748: }
9749: if (!defined($homeserver)) {
9750: if ($cdom =~ /^$match_domain$/) {
9751: $homeserver = &domain($cdom,'primary');
9752: }
9753: }
9754: unless (($homeserver eq '') || ($homeserver eq 'no_host')) {
9755: $response=&reply('autovalidateinstcrosslist:'.$cdom.':'.
9756: &escape($instcode).':'.&escape($inst_xlist).':'.
1.1445 raeburn 9757: &escape($coowner),$homeserver);
1.1444 raeburn 9758: }
9759: return $response;
9760: }
9761:
1.506 raeburn 9762: sub auto_create_password {
1.873 raeburn 9763: my ($cnum,$cdom,$authparam,$udom) = @_;
9764: my ($homeserver,$response);
1.506 raeburn 9765: my $create_passwd = 0;
9766: my $authchk = '';
1.873 raeburn 9767: if ($udom =~ /^$match_domain$/) {
9768: $homeserver = &domain($udom,'primary');
9769: }
9770: if ($homeserver eq '') {
9771: if (($cdom =~ /^$match_domain$/) && ($cnum =~ /^$match_courseid$/)) {
9772: $homeserver = &homeserver($cnum,$cdom);
9773: }
9774: }
9775: if ($homeserver eq '') {
9776: $authchk = 'nodomain';
1.506 raeburn 9777: } else {
1.873 raeburn 9778: $response=&unescape(&reply('autocreatepassword:'.$authparam.':'.$cdom,$homeserver));
9779: if ($response eq 'refused') {
9780: $authchk = 'refused';
9781: } else {
1.901 albertel 9782: ($authparam,$create_passwd,$authchk) = split(/:/,$response);
1.873 raeburn 9783: }
1.506 raeburn 9784: }
9785: return ($authparam,$create_passwd,$authchk);
9786: }
9787:
1.706 raeburn 9788: sub auto_photo_permission {
9789: my ($cnum,$cdom,$students) = @_;
9790: my $homeserver = &homeserver($cnum,$cdom);
1.707 albertel 9791: my ($outcome,$perm_reqd,$conditions) =
9792: split(/:/,&unescape(&reply('autophotopermission:'.$cdom,$homeserver)),3);
1.709 albertel 9793: if ($outcome =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
9794: return (undef,undef);
9795: }
1.706 raeburn 9796: return ($outcome,$perm_reqd,$conditions);
9797: }
9798:
9799: sub auto_checkphotos {
9800: my ($uname,$udom,$pid) = @_;
9801: my $homeserver = &homeserver($uname,$udom);
9802: my ($result,$resulttype);
9803: my $outcome = &unescape(&reply('autophotocheck:'.&escape($udom).':'.
1.707 albertel 9804: &escape($uname).':'.&escape($pid),
9805: $homeserver));
1.709 albertel 9806: if ($outcome =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
9807: return (undef,undef);
9808: }
1.706 raeburn 9809: if ($outcome) {
9810: ($result,$resulttype) = split(/:/,$outcome);
9811: }
9812: return ($result,$resulttype);
9813: }
9814:
9815: sub auto_photochoice {
9816: my ($cnum,$cdom) = @_;
9817: my $homeserver = &homeserver($cnum,$cdom);
9818: my ($update,$comment) = split(/:/,&unescape(&reply('autophotochoice:'.
1.707 albertel 9819: &escape($cdom),
9820: $homeserver)));
1.709 albertel 9821: if ($update =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
9822: return (undef,undef);
9823: }
1.706 raeburn 9824: return ($update,$comment);
9825: }
9826:
9827: sub auto_photoupdate {
9828: my ($affiliatesref,$dom,$cnum,$photo) = @_;
9829: my $homeserver = &homeserver($cnum,$dom);
1.838 albertel 9830: my $host=&hostname($homeserver);
1.706 raeburn 9831: my $cmd = '';
9832: my $maxtries = 1;
1.800 albertel 9833: foreach my $affiliate (keys(%{$affiliatesref})) {
9834: $cmd .= $affiliate.'='.join(",",@{$$affiliatesref{$affiliate}}).'%%';
1.706 raeburn 9835: }
9836: $cmd =~ s/%%$//;
9837: $cmd = &escape($cmd);
9838: my $query = 'institutionalphotos';
9839: my $queryid=&reply("querysend:".$query.':'.$dom.':'.$cnum.':'.$cmd,$homeserver);
9840: unless ($queryid=~/^\Q$host\E\_/) {
9841: &logthis('institutionalphotos: invalid queryid: '.$queryid.' for host: '.$host.' and homeserver: '.$homeserver.' and course: '.$cnum);
9842: return 'error: '.$queryid;
9843: }
9844: my $reply = &get_query_reply($queryid);
9845: my $tries = 1;
9846: while (($reply=~/^timeout/) && ($tries < $maxtries)) {
9847: $reply = &get_query_reply($queryid);
9848: $tries ++;
9849: }
9850: if ( ($reply =~/^timeout/) || ($reply =~/^error/) ) {
9851: &logthis('institutionalphotos error: '.$reply.' for '.$dom.' '.$env{'user.name'}.' for '.$queryid.' course: '.$cnum.' maxtries: '.$maxtries.' tries: '.$tries);
9852: } else {
9853: my @responses = split(/:/,$reply);
9854: my $outcome = shift(@responses);
9855: foreach my $item (@responses) {
9856: my ($key,$value) = split(/=/,$item);
9857: $$photo{$key} = $value;
9858: }
9859: return $outcome;
9860: }
9861: return 'error';
9862: }
9863:
1.521 raeburn 9864: sub auto_instcode_format {
1.793 albertel 9865: my ($caller,$codedom,$instcodes,$codes,$codetitles,$cat_titles,
9866: $cat_order) = @_;
1.521 raeburn 9867: my $courses = '';
1.772 raeburn 9868: my @homeservers;
1.521 raeburn 9869: if ($caller eq 'global') {
1.841 albertel 9870: my %servers = &get_servers($codedom,'library');
9871: foreach my $tryserver (keys(%servers)) {
9872: if (!grep(/^\Q$tryserver\E$/,@homeservers)) {
9873: push(@homeservers,$tryserver);
9874: }
1.584 raeburn 9875: }
1.1022 raeburn 9876: } elsif ($caller eq 'requests') {
9877: if ($codedom =~ /^$match_domain$/) {
9878: my $chome = &domain($codedom,'primary');
9879: unless ($chome eq 'no_host') {
9880: push(@homeservers,$chome);
9881: }
9882: }
1.521 raeburn 9883: } else {
1.772 raeburn 9884: push(@homeservers,&homeserver($caller,$codedom));
1.521 raeburn 9885: }
1.793 albertel 9886: foreach my $code (keys(%{$instcodes})) {
9887: $courses .= &escape($code).'='.&escape($$instcodes{$code}).'&';
1.521 raeburn 9888: }
9889: chop($courses);
1.772 raeburn 9890: my $ok_response = 0;
9891: my $response;
9892: while (@homeservers > 0 && $ok_response == 0) {
9893: my $server = shift(@homeservers);
9894: $response=&reply('autoinstcodeformat:'.$codedom.':'.$courses,$server);
9895: if ($response !~ /(con_lost|error|no_such_host|refused)/) {
9896: my ($codes_str,$codetitles_str,$cat_titles_str,$cat_order_str) =
1.901 albertel 9897: split(/:/,$response);
1.772 raeburn 9898: %{$codes} = (%{$codes},&str2hash($codes_str));
9899: push(@{$codetitles},&str2array($codetitles_str));
9900: %{$cat_titles} = (%{$cat_titles},&str2hash($cat_titles_str));
9901: %{$cat_order} = (%{$cat_order},&str2hash($cat_order_str));
9902: $ok_response = 1;
9903: }
9904: }
9905: if ($ok_response) {
1.521 raeburn 9906: return 'ok';
1.772 raeburn 9907: } else {
9908: return $response;
1.521 raeburn 9909: }
9910: }
9911:
1.792 raeburn 9912: sub auto_instcode_defaults {
9913: my ($domain,$returnhash,$code_order) = @_;
9914: my @homeservers;
1.841 albertel 9915:
9916: my %servers = &get_servers($domain,'library');
9917: foreach my $tryserver (keys(%servers)) {
9918: if (!grep(/^\Q$tryserver\E$/,@homeservers)) {
9919: push(@homeservers,$tryserver);
9920: }
1.792 raeburn 9921: }
1.841 albertel 9922:
1.792 raeburn 9923: my $response;
1.841 albertel 9924: foreach my $server (@homeservers) {
1.792 raeburn 9925: $response=&reply('autoinstcodedefaults:'.$domain,$server);
1.841 albertel 9926: next if ($response =~ /(con_lost|error|no_such_host|refused)/);
9927:
9928: foreach my $pair (split(/\&/,$response)) {
9929: my ($name,$value)=split(/\=/,$pair);
9930: if ($name eq 'code_order') {
9931: @{$code_order} = split(/\&/,&unescape($value));
9932: } else {
9933: $returnhash->{&unescape($name)}=&unescape($value);
9934: }
9935: }
9936: return 'ok';
1.792 raeburn 9937: }
1.841 albertel 9938:
9939: return $response;
1.1003 raeburn 9940: }
9941:
9942: sub auto_possible_instcodes {
1.1007 raeburn 9943: my ($domain,$codetitles,$cat_titles,$cat_orders,$code_order) = @_;
9944: unless ((ref($codetitles) eq 'ARRAY') && (ref($cat_titles) eq 'HASH') &&
9945: (ref($cat_orders) eq 'HASH') && (ref($code_order) eq 'ARRAY')) {
9946: return;
9947: }
1.1003 raeburn 9948: my (@homeservers,$uhome);
9949: if (defined(&domain($domain,'primary'))) {
9950: $uhome=&domain($domain,'primary');
9951: push(@homeservers,&domain($domain,'primary'));
9952: } else {
9953: my %servers = &get_servers($domain,'library');
9954: foreach my $tryserver (keys(%servers)) {
9955: if (!grep(/^\Q$tryserver\E$/,@homeservers)) {
9956: push(@homeservers,$tryserver);
9957: }
9958: }
9959: }
9960: my $response;
9961: foreach my $server (@homeservers) {
9962: $response=&reply('autopossibleinstcodes:'.$domain,$server);
9963: next if ($response =~ /(con_lost|error|no_such_host|refused)/);
1.1007 raeburn 9964: my ($codetitlestr,$codeorderstr,$cat_title,$cat_order) =
9965: split(':',$response);
9966: @{$codetitles} = map { &unescape($_); } (split('&',$codetitlestr));
9967: @{$code_order} = map { &unescape($_); } (split('&',$codeorderstr));
1.1003 raeburn 9968: foreach my $item (split('&',$cat_title)) {
1.1005 raeburn 9969: my ($name,$value)=split('=',$item);
9970: $cat_titles->{&unescape($name)}=&thaw_unescape($value);
1.1003 raeburn 9971: }
9972: foreach my $item (split('&',$cat_order)) {
1.1005 raeburn 9973: my ($name,$value)=split('=',$item);
9974: $cat_orders->{&unescape($name)}=&thaw_unescape($value);
1.1003 raeburn 9975: }
9976: return 'ok';
9977: }
9978: return $response;
9979: }
1.792 raeburn 9980:
1.1010 raeburn 9981: sub auto_courserequest_checks {
9982: my ($dom) = @_;
1.1020 raeburn 9983: my ($homeserver,%validations);
9984: if ($dom =~ /^$match_domain$/) {
9985: $homeserver = &domain($dom,'primary');
9986: }
9987: unless ($homeserver eq 'no_host') {
9988: my $response=&reply('autocrsreqchecks:'.$dom,$homeserver);
9989: unless ($response =~ /(con_lost|error|no_such_host|refused)/) {
9990: my @items = split(/&/,$response);
9991: foreach my $item (@items) {
9992: my ($key,$value) = split('=',$item);
9993: $validations{&unescape($key)} = &thaw_unescape($value);
9994: }
9995: }
9996: }
1.1010 raeburn 9997: return %validations;
9998: }
9999:
1.1020 raeburn 10000: sub auto_courserequest_validation {
1.1255 raeburn 10001: my ($dom,$owner,$crstype,$inststatuslist,$instcode,$instseclist,$custominfo) = @_;
1.1020 raeburn 10002: my ($homeserver,$response);
10003: if ($dom =~ /^$match_domain$/) {
10004: $homeserver = &domain($dom,'primary');
10005: }
1.1255 raeburn 10006: unless ($homeserver eq 'no_host') {
10007: my $customdata;
10008: if (ref($custominfo) eq 'HASH') {
10009: $customdata = &freeze_escape($custominfo);
10010: }
1.1020 raeburn 10011: $response=&unescape(&reply('autocrsreqvalidation:'.$dom.':'.&escape($owner).
1.1021 raeburn 10012: ':'.&escape($crstype).':'.&escape($inststatuslist).
1.1255 raeburn 10013: ':'.&escape($instcode).':'.&escape($instseclist).':'.
10014: $customdata,$homeserver));
1.1020 raeburn 10015: }
10016: return $response;
10017: }
10018:
1.777 albertel 10019: sub auto_validate_class_sec {
1.918 raeburn 10020: my ($cdom,$cnum,$owners,$inst_class) = @_;
1.773 raeburn 10021: my $homeserver = &homeserver($cnum,$cdom);
1.918 raeburn 10022: my $ownerlist;
10023: if (ref($owners) eq 'ARRAY') {
10024: $ownerlist = join(',',@{$owners});
10025: } else {
10026: $ownerlist = $owners;
10027: }
1.773 raeburn 10028: my $response=&reply('autovalidateclass_sec:'.$inst_class.':'.
1.918 raeburn 10029: &escape($ownerlist).':'.$cdom,$homeserver);
1.773 raeburn 10030: return $response;
10031: }
10032:
1.1460 raeburn 10033: sub auto_instsec_reformat {
10034: my ($cdom,$action,$instsecref) = @_;
10035: return unless(($action eq 'clutter') || ($action eq 'declutter'));
10036: my @homeservers;
10037: if (defined(&domain($cdom,'primary'))) {
10038: push(@homeservers,&domain($cdom,'primary'));
10039: } else {
10040: my %servers = &get_servers($cdom,'library');
10041: foreach my $tryserver (keys(%servers)) {
10042: if (!grep(/^\Q$tryserver\E$/,@homeservers)) {
10043: push(@homeservers,$tryserver);
10044: }
10045: }
10046: }
10047: my $response;
10048: my %reformatted = %{$instsecref};
10049: foreach my $server (@homeservers) {
10050: if (ref($instsecref) eq 'HASH') {
10051: my $info = &freeze_escape($instsecref);
10052: my $response=&reply('autoinstsecreformat:'.$cdom.':'.
10053: $action.':'.$info,$server);
10054: next if ($response =~ /(con_lost|error|no_such_host|refused|unknown_command)/);
10055: my @items = split(/&/,$response);
10056: foreach my $item (@items) {
10057: my ($key,$value) = split(/=/,$item);
10058: $reformatted{&unescape($key)} = &thaw_unescape($value);
10059: }
10060: }
10061: }
10062: return %reformatted;
10063: }
10064:
1.1367 raeburn 10065: sub auto_validate_instclasses {
10066: my ($cdom,$cnum,$owners,$classesref) = @_;
10067: my ($homeserver,%validations);
10068: $homeserver = &homeserver($cnum,$cdom);
10069: unless ($homeserver eq 'no_host') {
10070: my $ownerlist;
10071: if (ref($owners) eq 'ARRAY') {
10072: $ownerlist = join(',',@{$owners});
10073: } else {
10074: $ownerlist = $owners;
10075: }
10076: if (ref($classesref) eq 'HASH') {
10077: my $classes = &freeze_escape($classesref);
10078: my $response=&reply('autovalidateinstclasses:'.&escape($ownerlist).
10079: ':'.$cdom.':'.$classes,$homeserver);
10080: unless ($response =~ /(con_lost|error|no_such_host|refused)/) {
10081: my @items = split(/&/,$response);
10082: foreach my $item (@items) {
10083: my ($key,$value) = split('=',$item);
10084: $validations{&unescape($key)} = &thaw_unescape($value);
10085: }
10086: }
10087: }
10088: }
10089: return %validations;
10090: }
10091:
1.1248 raeburn 10092: sub auto_crsreq_update {
10093: my ($cdom,$cnum,$crstype,$action,$ownername,$ownerdomain,$fullname,$title,
1.1257 raeburn 10094: $code,$accessstart,$accessend,$inbound) = @_;
1.1248 raeburn 10095: my ($homeserver,%crsreqresponse);
10096: if ($cdom =~ /^$match_domain$/) {
10097: $homeserver = &domain($cdom,'primary');
10098: }
10099: unless (($homeserver eq 'no_host') || ($homeserver eq '')) {
10100: my $info;
10101: if (ref($inbound) eq 'HASH') {
10102: $info = &freeze_escape($inbound);
10103: }
10104: my $response=&reply('autocrsrequpdate:'.$cdom.':'.$cnum.':'.&escape($crstype).
10105: ':'.&escape($action).':'.&escape($ownername).':'.
10106: &escape($ownerdomain).':'.&escape($fullname).':'.
1.1257 raeburn 10107: &escape($title).':'.&escape($code).':'.
10108: &escape($accessstart).':'.&escape($accessend).':'.$info,
10109: $homeserver);
1.1248 raeburn 10110: unless ($response =~ /(con_lost|error|no_such_host|refused)/) {
10111: my @items = split(/&/,$response);
10112: foreach my $item (@items) {
10113: my ($key,$value) = split('=',$item);
10114: $crsreqresponse{&unescape($key)} = &thaw_unescape($value);
10115: }
10116: }
10117: }
10118: return \%crsreqresponse;
10119: }
10120:
1.1305 raeburn 10121: sub auto_export_grades {
1.1309 raeburn 10122: my ($cdom,$cnum,$inforef,$gradesref) = @_;
10123: my ($homeserver,%exportresponse);
10124: if ($cdom =~ /^$match_domain$/) {
10125: $homeserver = &domain($cdom,'primary');
10126: }
10127: unless (($homeserver eq 'no_host') || ($homeserver eq '')) {
10128: my $info;
10129: if (ref($inforef) eq 'HASH') {
10130: $info = &freeze_escape($inforef);
10131: }
10132: if (ref($gradesref) eq 'HASH') {
10133: my $grades = &freeze_escape($gradesref);
10134: my $response=&reply('encrypt:autoexportgrades:'.$cdom.':'.$cnum.':'.
10135: $info.':'.$grades,$homeserver);
10136: unless ($response =~ /(con_lost|error|no_such_host|refused|unknown_command)/) {
10137: my @items = split(/&/,$response);
10138: foreach my $item (@items) {
10139: my ($key,$value) = split('=',$item);
10140: $exportresponse{&unescape($key)} = &thaw_unescape($value);
10141: }
10142: }
10143: }
10144: }
10145: return \%exportresponse;
1.1305 raeburn 10146: }
10147:
1.1287 raeburn 10148: sub check_instcode_cloning {
10149: my ($codedefaults,$code_order,$cloner,$clonefromcode,$clonetocode) = @_;
10150: unless ((ref($codedefaults) eq 'HASH') && (ref($code_order) eq 'ARRAY')) {
10151: return;
10152: }
10153: my $canclone;
10154: if (@{$code_order} > 0) {
10155: my $instcoderegexp ='^';
10156: my @clonecodes = split(/\&/,$cloner);
10157: foreach my $item (@{$code_order}) {
10158: if (grep(/^\Q$item\E=/,@clonecodes)) {
10159: foreach my $pair (@clonecodes) {
10160: my ($key,$val) = split(/\=/,$pair,2);
10161: $val = &unescape($val);
10162: if ($key eq $item) {
10163: $instcoderegexp .= '('.$val.')';
10164: last;
10165: }
10166: }
10167: } else {
10168: $instcoderegexp .= $codedefaults->{$item};
10169: }
10170: }
10171: $instcoderegexp .= '$';
10172: my (@from,@to);
10173: eval {
10174: (@from) = ($clonefromcode =~ /$instcoderegexp/);
10175: (@to) = ($clonetocode =~ /$instcoderegexp/);
10176: };
10177: if ((@from > 0) && (@to > 0)) {
10178: my @diffs = &Apache::loncommon::compare_arrays(\@from,\@to);
10179: if (!@diffs) {
10180: $canclone = 1;
10181: }
10182: }
10183: }
10184: return $canclone;
10185: }
10186:
10187: sub default_instcode_cloning {
10188: my ($clonedom,$domdefclone,$clonefromcode,$clonetocode,$codedefaultsref,$codeorderref) = @_;
10189: my (%codedefaults,@code_order,$canclone);
10190: if ((ref($codedefaultsref) eq 'HASH') && (ref($codeorderref) eq 'ARRAY')) {
10191: %codedefaults = %{$codedefaultsref};
10192: @code_order = @{$codeorderref};
10193: } elsif ($clonedom) {
10194: &auto_instcode_defaults($clonedom,\%codedefaults,\@code_order);
10195: }
10196: if (($domdefclone) && (@code_order)) {
10197: my @clonecodes = split(/\+/,$domdefclone);
10198: my $instcoderegexp ='^';
10199: foreach my $item (@code_order) {
10200: if (grep(/^\Q$item\E$/,@clonecodes)) {
10201: $instcoderegexp .= '('.$codedefaults{$item}.')';
10202: } else {
10203: $instcoderegexp .= $codedefaults{$item};
10204: }
10205: }
10206: $instcoderegexp .= '$';
10207: my (@from,@to);
10208: eval {
10209: (@from) = ($clonefromcode =~ /$instcoderegexp/);
10210: (@to) = ($clonetocode =~ /$instcoderegexp/);
10211: };
10212: if ((@from > 0) && (@to > 0)) {
10213: my @diffs = &Apache::loncommon::compare_arrays(\@from,\@to);
10214: if (!@diffs) {
10215: $canclone = 1;
10216: }
10217: }
10218: }
10219: return $canclone;
10220: }
10221:
1.679 raeburn 10222: # ------------------------------------------------------- Course Group routines
10223:
10224: sub get_coursegroups {
1.809 raeburn 10225: my ($cdom,$cnum,$group,$namespace) = @_;
10226: return(&dump($namespace,$cdom,$cnum,$group));
1.805 raeburn 10227: }
10228:
1.679 raeburn 10229: sub modify_coursegroup {
10230: my ($cdom,$cnum,$groupsettings) = @_;
10231: return(&put('coursegroups',$groupsettings,$cdom,$cnum));
10232: }
10233:
1.809 raeburn 10234: sub toggle_coursegroup_status {
10235: my ($cdom,$cnum,$group,$action) = @_;
10236: my ($from_namespace,$to_namespace);
10237: if ($action eq 'delete') {
10238: $from_namespace = 'coursegroups';
10239: $to_namespace = 'deleted_groups';
10240: } else {
10241: $from_namespace = 'deleted_groups';
10242: $to_namespace = 'coursegroups';
10243: }
10244: my %curr_group = &get_coursegroups($cdom,$cnum,$group,$from_namespace);
1.805 raeburn 10245: if (my $tmp = &error(%curr_group)) {
10246: &Apache::lonnet::logthis('Error retrieving group: '.$tmp.' in '.$cnum.':'.$cdom);
10247: return ('read error',$tmp);
10248: } else {
10249: my %savedsettings = %curr_group;
1.809 raeburn 10250: my $result = &put($to_namespace,\%savedsettings,$cdom,$cnum);
1.805 raeburn 10251: my $deloutcome;
10252: if ($result eq 'ok') {
1.809 raeburn 10253: $deloutcome = &del($from_namespace,[$group],$cdom,$cnum);
1.805 raeburn 10254: } else {
10255: return ('write error',$result);
10256: }
10257: if ($deloutcome eq 'ok') {
10258: return 'ok';
10259: } else {
10260: return ('delete error',$deloutcome);
10261: }
10262: }
10263: }
10264:
1.679 raeburn 10265: sub modify_group_roles {
1.957 raeburn 10266: my ($cdom,$cnum,$group_id,$user,$end,$start,$userprivs,$selfenroll,$context) = @_;
1.679 raeburn 10267: my $url = '/'.$cdom.'/'.$cnum.'/'.$group_id;
10268: my $role = 'gr/'.&escape($userprivs);
10269: my ($uname,$udom) = split(/:/,$user);
1.957 raeburn 10270: my $result = &assignrole($udom,$uname,$url,$role,$end,$start,'',$selfenroll,$context);
1.684 raeburn 10271: if ($result eq 'ok') {
10272: &devalidate_getgroups_cache($udom,$uname,$cdom,$cnum);
10273: }
1.679 raeburn 10274: return $result;
10275: }
10276:
10277: sub modify_coursegroup_membership {
10278: my ($cdom,$cnum,$membership) = @_;
10279: my $result = &put('groupmembership',$membership,$cdom,$cnum);
10280: return $result;
10281: }
10282:
1.682 raeburn 10283: sub get_active_groups {
10284: my ($udom,$uname,$cdom,$cnum) = @_;
10285: my $now = time;
10286: my %groups = ();
10287: foreach my $key (keys(%env)) {
1.811 albertel 10288: if ($key =~ m-user\.role\.gr\./($match_domain)/($match_courseid)/(\w+)$-) {
1.682 raeburn 10289: my ($start,$end) = split(/\./,$env{$key});
10290: if (($end!=0) && ($end<$now)) { next; }
10291: if (($start!=0) && ($start>$now)) { next; }
10292: if ($1 eq $cdom && $2 eq $cnum) {
10293: $groups{$3} = $env{$key} ;
10294: }
10295: }
10296: }
10297: return %groups;
10298: }
10299:
1.683 raeburn 10300: sub get_group_membership {
10301: my ($cdom,$cnum,$group) = @_;
10302: return(&dump('groupmembership',$cdom,$cnum,$group));
10303: }
10304:
10305: sub get_users_groups {
10306: my ($udom,$uname,$courseid) = @_;
1.733 raeburn 10307: my @usersgroups;
1.683 raeburn 10308: my $cachetime=1800;
10309:
10310: my $hashid="$udom:$uname:$courseid";
1.733 raeburn 10311: my ($grouplist,$cached)=&is_cached_new('getgroups',$hashid);
10312: if (defined($cached)) {
1.734 albertel 10313: @usersgroups = split(/:/,$grouplist);
1.733 raeburn 10314: } else {
10315: $grouplist = '';
1.816 raeburn 10316: my $courseurl = &courseid_to_courseurl($courseid);
1.1166 raeburn 10317: my %roleshash = &dump('roles',$udom,$uname,$courseurl);
1.817 raeburn 10318: my $access_end = $env{'course.'.$courseid.
10319: '.default_enrollment_end_date'};
10320: my $now = time;
10321: foreach my $key (keys(%roleshash)) {
10322: if ($key =~ /^\Q$courseurl\E\/(\w+)\_gr$/) {
10323: my $group = $1;
10324: if ($roleshash{$key} =~ /_(\d+)_(\d+)$/) {
10325: my $start = $2;
10326: my $end = $1;
10327: if ($start == -1) { next; } # deleted from group
10328: if (($start!=0) && ($start>$now)) { next; }
10329: if (($end!=0) && ($end<$now)) {
10330: if ($access_end && $access_end < $now) {
10331: if ($access_end - $end < 86400) {
10332: push(@usersgroups,$group);
1.733 raeburn 10333: }
10334: }
1.817 raeburn 10335: next;
1.733 raeburn 10336: }
1.817 raeburn 10337: push(@usersgroups,$group);
1.683 raeburn 10338: }
10339: }
10340: }
1.817 raeburn 10341: @usersgroups = &sort_course_groups($courseid,@usersgroups);
10342: $grouplist = join(':',@usersgroups);
10343: &do_cache_new('getgroups',$hashid,$grouplist,$cachetime);
1.683 raeburn 10344: }
1.733 raeburn 10345: return @usersgroups;
1.683 raeburn 10346: }
10347:
10348: sub devalidate_getgroups_cache {
10349: my ($udom,$uname,$cdom,$cnum)=@_;
10350: my $courseid = $cdom.'_'.$cnum;
1.807 albertel 10351:
1.683 raeburn 10352: my $hashid="$udom:$uname:$courseid";
10353: &devalidate_cache_new('getgroups',$hashid);
10354: }
10355:
1.12 www 10356: # ------------------------------------------------------------------ Plain Text
10357:
10358: sub plaintext {
1.988 raeburn 10359: my ($short,$type,$cid,$forcedefault) = @_;
1.1046 raeburn 10360: if ($short =~ m{^cr/}) {
1.758 albertel 10361: return (split('/',$short))[-1];
10362: }
1.742 raeburn 10363: if (!defined($cid)) {
10364: $cid = $env{'request.course.id'};
10365: }
10366: my %rolenames = (
1.1008 raeburn 10367: Course => 'std',
10368: Community => 'alt1',
1.1305 raeburn 10369: Placement => 'std',
1.742 raeburn 10370: );
1.1037 raeburn 10371: if ($cid ne '') {
10372: if ($env{'course.'.$cid.'.'.$short.'.plaintext'} ne '') {
10373: unless ($forcedefault) {
10374: my $roletext = $env{'course.'.$cid.'.'.$short.'.plaintext'};
10375: &Apache::lonlocal::mt_escape(\$roletext);
10376: return &Apache::lonlocal::mt($roletext);
10377: }
10378: }
10379: }
10380: if ((defined($type)) && (defined($rolenames{$type})) &&
10381: (defined($rolenames{$type})) &&
10382: (defined($prp{$short}{$rolenames{$type}}))) {
1.742 raeburn 10383: return &Apache::lonlocal::mt($prp{$short}{$rolenames{$type}});
1.1037 raeburn 10384: } elsif ($cid ne '') {
10385: my $crstype = $env{'course.'.$cid.'.type'};
10386: if (($crstype ne '') && (defined($rolenames{$crstype})) &&
10387: (defined($prp{$short}{$rolenames{$crstype}}))) {
10388: return &Apache::lonlocal::mt($prp{$short}{$rolenames{$crstype}});
10389: }
1.742 raeburn 10390: }
1.1037 raeburn 10391: return &Apache::lonlocal::mt($prp{$short}{'std'});
1.12 www 10392: }
10393:
10394: # ----------------------------------------------------------------- Assign Role
10395:
10396: sub assignrole {
1.957 raeburn 10397: my ($udom,$uname,$url,$role,$end,$start,$deleteflag,$selfenroll,
10398: $context)=@_;
1.21 www 10399: my $mrole;
10400: if ($role =~ /^cr\//) {
1.393 www 10401: my $cwosec=$url;
1.811 albertel 10402: $cwosec=~s/^\/($match_domain)\/($match_courseid)\/.*/$1\/$2/;
1.1502 raeburn 10403: if ((!&allowed('ccr',$cwosec)) && (!&allowed('ccr',$udom))) {
1.1026 raeburn 10404: my $refused = 1;
10405: if ($context eq 'requestcourses') {
10406: if (($env{'user.name'} ne '') && ($env{'user.domain'} ne '')) {
10407: if ($role =~ m{^cr/($match_domain)/($match_username)/([^/]+)$}) {
10408: if (($1 eq $env{'user.domain'}) && ($2 eq $env{'user.name'})) {
10409: my ($cdom,$cnum) = ($cwosec =~ m{^/?($match_domain)/($match_courseid)$});
10410: my %crsenv = &userenvironment($cdom,$cnum,('internal.courseowner'));
10411: if ($crsenv{'internal.courseowner'} eq
10412: $env{'user.name'}.':'.$env{'user.domain'}) {
10413: $refused = '';
10414: }
10415: }
10416: }
10417: }
10418: }
10419: if ($refused) {
10420: &logthis('Refused custom assignrole: '.
10421: $udom.' '.$uname.' '.$url.' '.$role.' '.$end.' '.$start.
10422: ' by '.$env{'user.name'}.' at '.$env{'user.domain'});
10423: return 'refused';
10424: }
1.104 www 10425: }
1.21 www 10426: $mrole='cr';
1.678 raeburn 10427: } elsif ($role =~ /^gr\//) {
10428: my $cwogrp=$url;
1.811 albertel 10429: $cwogrp=~s{^/($match_domain)/($match_courseid)/.*}{$1/$2};
1.678 raeburn 10430: unless (&allowed('mdg',$cwogrp)) {
10431: &logthis('Refused group assignrole: '.
10432: $udom.' '.$uname.' '.$url.' '.$role.' '.$end.' '.$start.' by '.
10433: $env{'user.name'}.' at '.$env{'user.domain'});
10434: return 'refused';
10435: }
10436: $mrole='gr';
1.21 www 10437: } else {
1.82 www 10438: my $cwosec=$url;
1.811 albertel 10439: $cwosec=~s/^\/($match_domain)\/($match_courseid)\/.*/$1\/$2/;
1.932 raeburn 10440: if (!(&allowed('c'.$role,$cwosec)) && !(&allowed('c'.$role,$udom))) {
10441: my $refused;
10442: if (($env{'request.course.sec'} ne '') && ($role eq 'st')) {
10443: if (!(&allowed('c'.$role,$url))) {
10444: $refused = 1;
10445: }
10446: } else {
10447: $refused = 1;
10448: }
1.947 raeburn 10449: if ($refused) {
1.1045 raeburn 10450: my ($cdom,$cnum) = ($cwosec =~ m{^/?($match_domain)/($match_courseid)$});
1.1377 raeburn 10451: if (!$selfenroll && (($context eq 'course') || ($context eq 'ltienroll' && $env{'request.lti.login'}))) {
1.1045 raeburn 10452: my %crsenv;
10453: if ($role eq 'cc' || $role eq 'co') {
10454: %crsenv = &userenvironment($cdom,$cnum,('internal.courseowner'));
10455: if (($role eq 'cc') && ($cnum !~ /^$match_community$/)) {
10456: if ($env{'request.role'} eq 'cc./'.$cdom.'/'.$cnum) {
10457: if ($crsenv{'internal.courseowner'} eq
10458: $env{'user.name'}.':'.$env{'user.domain'}) {
10459: $refused = '';
10460: }
10461: }
10462: } elsif (($role eq 'co') && ($cnum =~ /^$match_community$/)) {
10463: if ($env{'request.role'} eq 'co./'.$cdom.'/'.$cnum) {
10464: if ($crsenv{'internal.courseowner'} eq
10465: $env{'user.name'}.':'.$env{'user.domain'}) {
10466: $refused = '';
10467: }
10468: }
10469: }
10470: }
1.1368 raeburn 10471: } elsif (($selfenroll == 1) && ($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'})) {
10472: if ($role eq 'st') {
10473: $refused = '';
1.1377 raeburn 10474: } elsif (($context eq 'ltienroll') && ($env{'request.lti.login'})) {
1.1368 raeburn 10475: $refused = '';
10476: }
1.1017 raeburn 10477: } elsif ($context eq 'requestcourses') {
1.1041 raeburn 10478: my @possroles = ('st','ta','ep','in','cc','co');
1.1026 raeburn 10479: if ((grep(/^\Q$role\E$/,@possroles)) && ($env{'user.name'} ne '' && $env{'user.domain'} ne '')) {
1.1041 raeburn 10480: my $wrongcc;
10481: if ($cnum =~ /^$match_community$/) {
10482: $wrongcc = 1 if ($role eq 'cc');
10483: } else {
10484: $wrongcc = 1 if ($role eq 'co');
10485: }
10486: unless ($wrongcc) {
10487: my %crsenv = &userenvironment($cdom,$cnum,('internal.courseowner'));
10488: if ($crsenv{'internal.courseowner'} eq
10489: $env{'user.name'}.':'.$env{'user.domain'}) {
10490: $refused = '';
10491: }
1.1017 raeburn 10492: }
10493: }
1.1183 raeburn 10494: } elsif ($context eq 'requestauthor') {
10495: if (($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'}) &&
10496: ($url eq '/'.$udom.'/') && ($role eq 'au')) {
10497: if ($env{'environment.requestauthor'} eq 'automatic') {
10498: $refused = '';
10499: } else {
10500: my %domdefaults = &get_domain_defaults($udom);
10501: if (ref($domdefaults{'requestauthor'}) eq 'HASH') {
10502: my $checkbystatus;
10503: if ($env{'user.adv'}) {
10504: my $disposition = $domdefaults{'requestauthor'}{'_LC_adv'};
10505: if ($disposition eq 'automatic') {
10506: $refused = '';
10507: } elsif ($disposition eq '') {
10508: $checkbystatus = 1;
10509: }
10510: } else {
10511: $checkbystatus = 1;
10512: }
10513: if ($checkbystatus) {
10514: if ($env{'environment.inststatus'}) {
10515: my @inststatuses = split(/,/,$env{'environment.inststatus'});
10516: foreach my $type (@inststatuses) {
10517: if (($type ne '') &&
10518: ($domdefaults{'requestauthor'}{$type} eq 'automatic')) {
10519: $refused = '';
10520: }
10521: }
10522: } elsif ($domdefaults{'requestauthor'}{'default'} eq 'automatic') {
10523: $refused = '';
10524: }
10525: }
10526: }
10527: }
10528: }
1.1017 raeburn 10529: }
10530: if ($refused) {
1.947 raeburn 10531: &logthis('Refused assignrole: '.$udom.' '.$uname.' '.$url.
10532: ' '.$role.' '.$end.' '.$start.' by '.
10533: $env{'user.name'}.' at '.$env{'user.domain'});
10534: return 'refused';
10535: }
1.932 raeburn 10536: }
1.1131 raeburn 10537: } elsif ($role eq 'au') {
10538: if ($url ne '/'.$udom.'/') {
10539: &logthis('Attempt by '.$env{'user.name'}.':'.$env{'user.domain'}.
10540: ' to assign author role for '.$uname.':'.$udom.
10541: ' in domain: '.$url.' refused (wrong domain).');
10542: return 'refused';
10543: }
1.104 www 10544: }
1.21 www 10545: $mrole=$role;
10546: }
1.620 albertel 10547: my $command="encrypt:rolesput:$env{'user.domain'}:$env{'user.name'}:".
1.21 www 10548: "$udom:$uname:$url".'_'."$mrole=$role";
1.81 www 10549: if ($end) { $command.='_'.$end; }
1.21 www 10550: if ($start) {
10551: if ($end) {
1.81 www 10552: $command.='_'.$start;
1.21 www 10553: } else {
1.81 www 10554: $command.='_0_'.$start;
1.21 www 10555: }
10556: }
1.739 raeburn 10557: my $origstart = $start;
10558: my $origend = $end;
1.957 raeburn 10559: my $delflag;
1.357 www 10560: # actually delete
10561: if ($deleteflag) {
1.373 www 10562: if ((&allowed('dro',$udom)) || (&allowed('dro',$url))) {
1.357 www 10563: # modify command to delete the role
1.620 albertel 10564: $command="encrypt:rolesdel:$env{'user.domain'}:$env{'user.name'}:".
1.357 www 10565: "$udom:$uname:$url".'_'."$mrole";
1.620 albertel 10566: &logthis("$env{'user.name'} at $env{'user.domain'} deletes $mrole in $url for $uname at $udom");
1.357 www 10567: # set start and finish to negative values for userrolelog
10568: $start=-1;
10569: $end=-1;
1.957 raeburn 10570: $delflag = 1;
1.357 www 10571: }
10572: }
10573: # send command
1.349 www 10574: my $answer=&reply($command,&homeserver($uname,$udom));
1.357 www 10575: # log new user role if status is ok
1.349 www 10576: if ($answer eq 'ok') {
1.663 raeburn 10577: &userrolelog($role,$uname,$udom,$url,$start,$end);
1.1184 raeburn 10578: if (($role eq 'cc') || ($role eq 'in') ||
10579: ($role eq 'ep') || ($role eq 'ad') ||
10580: ($role eq 'ta') || ($role eq 'st') ||
10581: ($role=~/^cr/) || ($role eq 'gr') ||
10582: ($role eq 'co')) {
1.1200 raeburn 10583: # for course roles, perform group memberships changes triggered by role change.
10584: unless ($role =~ /^gr/) {
10585: &Apache::longroup::group_changes($udom,$uname,$url,$role,$origend,
10586: $origstart,$selfenroll,$context);
10587: }
1.1184 raeburn 10588: &courserolelog($role,$uname,$udom,$url,$origstart,$origend,$delflag,
10589: $selfenroll,$context);
10590: } elsif (($role eq 'li') || ($role eq 'dg') || ($role eq 'sc') ||
1.1334 raeburn 10591: ($role eq 'au') || ($role eq 'dc') || ($role eq 'dh') ||
10592: ($role eq 'da')) {
1.1184 raeburn 10593: &domainrolelog($role,$uname,$udom,$url,$origstart,$origend,$delflag,
10594: $context);
10595: } elsif (($role eq 'ca') || ($role eq 'aa')) {
10596: &coauthorrolelog($role,$uname,$udom,$url,$origstart,$origend,$delflag,
10597: $context);
10598: }
1.1053 raeburn 10599: if ($role eq 'cc') {
10600: &autoupdate_coowners($url,$end,$start,$uname,$udom);
10601: }
1.349 www 10602: }
10603: return $answer;
1.169 harris41 10604: }
10605:
1.1053 raeburn 10606: sub autoupdate_coowners {
10607: my ($url,$end,$start,$uname,$udom) = @_;
10608: my ($cdom,$cnum) = ($url =~ m{^/($match_domain)/($match_courseid)});
10609: if (($cdom ne '') && ($cnum ne '')) {
10610: my $now = time;
10611: my %domdesign = &Apache::loncommon::get_domainconf($cdom);
10612: if ($domdesign{$cdom.'.autoassign.co-owners'}) {
10613: my %coursehash = &coursedescription($cdom.'_'.$cnum);
10614: my $instcode = $coursehash{'internal.coursecode'};
1.1444 raeburn 10615: my $xlists = $coursehash{'internal.crosslistings'};
1.1053 raeburn 10616: if ($instcode ne '') {
1.1056 raeburn 10617: if (($start && $start <= $now) && ($end == 0) || ($end > $now)) {
10618: unless ($coursehash{'internal.courseowner'} eq $uname.':'.$udom) {
1.1053 raeburn 10619: my ($delcoowners,@newcoowners,$putresult,$delresult,$coowners);
1.1056 raeburn 10620: my ($result,$desc) = &auto_validate_instcode($cnum,$cdom,$instcode,$uname.':'.$udom);
1.1444 raeburn 10621: unless ($result eq 'valid') {
10622: if ($xlists ne '') {
10623: foreach my $xlist (split(',',$xlists)) {
10624: my ($inst_crosslist,$lcsec) = split(':',$xlist);
10625: $result =
1.1446 raeburn 10626: &auto_validate_inst_crosslist($cnum,$cdom,$instcode,
10627: $inst_crosslist,$uname.':'.$udom);
10628: last if ($result eq 'valid');
1.1444 raeburn 10629: }
10630: }
10631: }
1.1056 raeburn 10632: if ($result eq 'valid') {
10633: if ($coursehash{'internal.co-owners'}) {
1.1053 raeburn 10634: foreach my $coowner (split(',',$coursehash{'internal.co-owners'})) {
10635: push(@newcoowners,$coowner);
10636: }
10637: unless (grep(/^\Q$uname\E:\Q$udom\E$/,@newcoowners)) {
10638: push(@newcoowners,$uname.':'.$udom);
10639: }
10640: @newcoowners = sort(@newcoowners);
10641: } else {
10642: push(@newcoowners,$uname.':'.$udom);
10643: }
1.1444 raeburn 10644: } elsif ($coursehash{'internal.co-owners'}) {
10645: foreach my $coowner (split(',',$coursehash{'internal.co-owners'})) {
10646: unless ($coowner eq $uname.':'.$udom) {
10647: push(@newcoowners,$coowner);
1.1053 raeburn 10648: }
1.1444 raeburn 10649: }
10650: unless (@newcoowners > 0) {
10651: $delcoowners = 1;
10652: $coowners = '';
1.1053 raeburn 10653: }
10654: }
10655: if (@newcoowners || $delcoowners) {
10656: &store_coowners($cdom,$cnum,$coursehash{'home'},
10657: $delcoowners,@newcoowners);
10658: }
10659: }
10660: }
10661: }
10662: }
10663: }
10664: }
10665:
10666: sub store_coowners {
10667: my ($cdom,$cnum,$chome,$delcoowners,@newcoowners) = @_;
10668: my $cid = $cdom.'_'.$cnum;
10669: my ($coowners,$delresult,$putresult);
10670: if (@newcoowners) {
10671: $coowners = join(',',@newcoowners);
10672: my %coownershash = (
10673: 'internal.co-owners' => $coowners,
10674: );
10675: $putresult = &put('environment',\%coownershash,$cdom,$cnum);
10676: if ($putresult eq 'ok') {
10677: if ($env{'course.'.$cid.'.num'} eq $cnum) {
10678: &appenv({'course.'.$cid.'.internal.co-owners' => $coowners});
10679: }
10680: }
10681: }
10682: if ($delcoowners) {
10683: $delresult = &Apache::lonnet::del('environment',['internal.co-owners'],$cdom,$cnum);
10684: if ($delresult eq 'ok') {
10685: if ($env{'course.'.$cid.'.internal.co-owners'}) {
10686: &Apache::lonnet::delenv('course.'.$cid.'.internal.co-owners');
10687: }
10688: }
10689: }
10690: if (($putresult eq 'ok') || ($delresult eq 'ok')) {
10691: my %crsinfo =
1.1494 raeburn 10692: &courseiddump($cdom,'.',1,'.','.',$cnum,undef,undef,'.');
1.1053 raeburn 10693: if (ref($crsinfo{$cid}) eq 'HASH') {
10694: $crsinfo{$cid}{'co-owners'} = \@newcoowners;
1.1494 raeburn 10695: my $cidput = &courseidput($cdom,\%crsinfo,$chome,'notime');
1.1053 raeburn 10696: }
10697: }
10698: }
10699:
1.169 harris41 10700: # -------------------------------------------------- Modify user authentication
1.197 www 10701: # Overrides without validation
10702:
1.169 harris41 10703: sub modifyuserauth {
10704: my ($udom,$uname,$umode,$upass)=@_;
10705: my $uhome=&homeserver($uname,$udom);
1.1409 raeburn 10706: my $allowed;
10707: if (&allowed('mau',$udom)) {
10708: $allowed = 1;
10709: } elsif (($umode eq 'internal') && ($udom eq $env{'user.domain'}) &&
10710: ($env{'request.course.id'}) && (&allowed('mip',$env{'request.course.id'})) &&
10711: (!$env{'course.'.$env{'request.course.id'}.'.internal.nopasswdchg'})) {
10712: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
10713: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
10714: if (($cdom ne '') && ($cnum ne '')) {
10715: my $is_owner = &is_course_owner($cdom,$cnum);
10716: if ($is_owner) {
10717: $allowed = 1;
10718: }
10719: }
10720: }
10721: unless ($allowed) { return 'refused'; }
1.197 www 10722: &logthis('Call to modify user authentication '.$udom.', '.$uname.', '.
1.620 albertel 10723: $umode.' by '.$env{'user.name'}.' at '.$env{'user.domain'}.
10724: ' in domain '.$env{'request.role.domain'});
1.169 harris41 10725: my $reply=&reply('encrypt:changeuserauth:'.$udom.':'.$uname.':'.$umode.':'.
10726: &escape($upass),$uhome);
1.1434 raeburn 10727: my $ip = &get_requestor_ip();
1.620 albertel 10728: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},
1.197 www 10729: 'Authentication changed for '.$udom.', '.$uname.', '.$umode.
1.1434 raeburn 10730: '(Remote '.$ip.'): '.$reply);
1.197 www 10731: &log($udom,,$uname,$uhome,
1.620 albertel 10732: 'Authentication changed by '.$env{'user.domain'}.', '.
10733: $env{'user.name'}.', '.$umode.
1.1435 raeburn 10734: '(Remote '.$ip.'): '.$reply);
1.169 harris41 10735: unless ($reply eq 'ok') {
1.197 www 10736: &logthis('Authentication mode error: '.$reply);
1.169 harris41 10737: return 'error: '.$reply;
10738: }
1.170 harris41 10739: return 'ok';
1.80 www 10740: }
10741:
1.81 www 10742: # --------------------------------------------------------------- Modify a user
1.80 www 10743:
1.81 www 10744: sub modifyuser {
1.206 matthew 10745: my ($udom, $uname, $uid,
10746: $umode, $upass, $first,
10747: $middle, $last, $gene,
1.1058 raeburn 10748: $forceid, $desiredhome, $email, $inststatus, $candelete)=@_;
1.807 albertel 10749: $udom= &LONCAPA::clean_domain($udom);
10750: $uname=&LONCAPA::clean_username($uname);
1.1059 raeburn 10751: my $showcandelete = 'none';
10752: if (ref($candelete) eq 'ARRAY') {
10753: if (@{$candelete} > 0) {
10754: $showcandelete = join(', ',@{$candelete});
10755: }
10756: }
1.81 www 10757: &logthis('Call to modify user '.$udom.', '.$uname.', '.$uid.', '.
1.80 www 10758: $umode.', '.$first.', '.$middle.', '.
1.1059 raeburn 10759: $last.', '.$gene.'(forceid: '.$forceid.'; candelete: '.$showcandelete.')'.
1.206 matthew 10760: (defined($desiredhome) ? ' desiredhome = '.$desiredhome :
10761: ' desiredhome not specified').
1.620 albertel 10762: ' by '.$env{'user.name'}.' at '.$env{'user.domain'}.
10763: ' in domain '.$env{'request.role.domain'});
1.230 stredwic 10764: my $uhome=&homeserver($uname,$udom,'true');
1.1075 raeburn 10765: my $newuser;
10766: if ($uhome eq 'no_host') {
10767: $newuser = 1;
1.1368 raeburn 10768: unless (($umode && ($upass ne '')) || ($umode eq 'localauth') ||
10769: ($umode eq 'lti')) {
10770: return 'error: more information needed to create new user';
10771: }
1.1075 raeburn 10772: }
1.80 www 10773: # ----------------------------------------------------------------- Create User
1.406 albertel 10774: if (($uhome eq 'no_host') &&
1.1368 raeburn 10775: (($umode && $upass) || ($umode eq 'localauth') || ($umode eq 'lti'))) {
1.80 www 10776: my $unhome='';
1.844 albertel 10777: if (defined($desiredhome) && &host_domain($desiredhome) eq $udom) {
1.209 matthew 10778: $unhome = $desiredhome;
1.620 albertel 10779: } elsif($env{'course.'.$env{'request.course.id'}.'.domain'} eq $udom) {
10780: $unhome=$env{'course.'.$env{'request.course.id'}.'.home'};
1.209 matthew 10781: } else { # load balancing routine for determining $unhome
1.81 www 10782: my $loadm=10000000;
1.841 albertel 10783: my %servers = &get_servers($udom,'library');
10784: foreach my $tryserver (keys(%servers)) {
10785: my $answer=reply('load',$tryserver);
10786: if (($answer=~/\d+/) && ($answer<$loadm)) {
10787: $loadm=$answer;
10788: $unhome=$tryserver;
10789: }
1.80 www 10790: }
10791: }
10792: if (($unhome eq '') || ($unhome eq 'no_host')) {
1.206 matthew 10793: return 'error: unable to find a home server for '.$uname.
10794: ' in domain '.$udom;
1.80 www 10795: }
10796: my $reply=&reply('encrypt:makeuser:'.$udom.':'.$uname.':'.$umode.':'.
10797: &escape($upass),$unhome);
10798: unless ($reply eq 'ok') {
10799: return 'error: '.$reply;
10800: }
1.230 stredwic 10801: $uhome=&homeserver($uname,$udom,'true');
1.80 www 10802: if (($uhome eq '') || ($uhome eq 'no_host') || ($uhome ne $unhome)) {
1.386 matthew 10803: return 'error: unable verify users home machine.';
1.80 www 10804: }
1.209 matthew 10805: } # End of creation of new user
1.80 www 10806: # ---------------------------------------------------------------------- Add ID
10807: if ($uid) {
10808: $uid=~tr/A-Z/a-z/;
10809: my %uidhash=&idrget($udom,$uname);
1.196 www 10810: if (($uidhash{$uname}) && ($uidhash{$uname}!~/error\:/)
10811: && (!$forceid)) {
1.80 www 10812: unless ($uid eq $uidhash{$uname}) {
1.386 matthew 10813: return 'error: user id "'.$uid.'" does not match '.
10814: 'current user id "'.$uidhash{$uname}.'".';
1.80 www 10815: }
10816: } else {
1.1300 raeburn 10817: &idput($udom,{$uname => $uid},$uhome,'ids');
1.80 www 10818: }
10819: }
10820: # -------------------------------------------------------------- Add names, etc
1.313 matthew 10821: my @tmp=&get('environment',
1.899 raeburn 10822: ['firstname','middlename','lastname','generation','id',
1.963 raeburn 10823: 'permanentemail','inststatus'],
1.134 albertel 10824: $udom,$uname);
1.1075 raeburn 10825: my (%names,%oldnames);
1.313 matthew 10826: if ($tmp[0] =~ m/^error:.*/) {
10827: %names=();
10828: } else {
10829: %names = @tmp;
1.1075 raeburn 10830: %oldnames = %names;
1.313 matthew 10831: }
1.388 www 10832: #
1.1058 raeburn 10833: # If name, email and/or uid are blank (e.g., because an uploaded file
10834: # of users did not contain them), do not overwrite existing values
10835: # unless field is in $candelete array ref.
10836: #
10837:
10838: my @fields = ('firstname','middlename','lastname','generation',
10839: 'permanentemail','id');
10840: my %newvalues;
10841: if (ref($candelete) eq 'ARRAY') {
10842: foreach my $field (@fields) {
10843: if (grep(/^\Q$field\E$/,@{$candelete})) {
10844: if ($field eq 'firstname') {
10845: $names{$field} = $first;
10846: } elsif ($field eq 'middlename') {
10847: $names{$field} = $middle;
10848: } elsif ($field eq 'lastname') {
10849: $names{$field} = $last;
10850: } elsif ($field eq 'generation') {
10851: $names{$field} = $gene;
10852: } elsif ($field eq 'permanentemail') {
10853: $names{$field} = $email;
10854: } elsif ($field eq 'id') {
10855: $names{$field} = $uid;
10856: }
10857: }
10858: }
10859: }
1.388 www 10860: if ($first) { $names{'firstname'} = $first; }
1.385 matthew 10861: if (defined($middle)) { $names{'middlename'} = $middle; }
1.388 www 10862: if ($last) { $names{'lastname'} = $last; }
1.385 matthew 10863: if (defined($gene)) { $names{'generation'} = $gene; }
1.592 www 10864: if ($email) {
10865: $email=~s/[^\w\@\.\-\,]//gs;
1.963 raeburn 10866: if ($email=~/\@/) { $names{'permanentemail'} = $email; }
1.592 www 10867: }
1.899 raeburn 10868: if ($uid) { $names{'id'} = $uid; }
1.989 raeburn 10869: if (defined($inststatus)) {
10870: $names{'inststatus'} = '';
10871: my ($usertypes,$typesorder) = &retrieve_inst_usertypes($udom);
10872: if (ref($usertypes) eq 'HASH') {
10873: my @okstatuses;
10874: foreach my $item (split(/:/,$inststatus)) {
10875: if (defined($usertypes->{$item})) {
10876: push(@okstatuses,$item);
10877: }
10878: }
10879: if (@okstatuses) {
10880: $names{'inststatus'} = join(':', map { &escape($_); } @okstatuses);
10881: }
10882: }
10883: }
1.1075 raeburn 10884: my $logmsg = $udom.', '.$uname.', '.$uid.', '.
1.963 raeburn 10885: $umode.', '.$first.', '.$middle.', '.
1.1075 raeburn 10886: $last.', '.$gene.', '.$email.', '.$inststatus;
1.963 raeburn 10887: if ($env{'user.name'} ne '' && $env{'user.domain'}) {
10888: $logmsg .= ' by '.$env{'user.name'}.' at '.$env{'user.domain'};
10889: } else {
10890: $logmsg .= ' during self creation';
10891: }
1.1075 raeburn 10892: my $changed;
10893: if ($newuser) {
10894: $changed = 1;
10895: } else {
10896: foreach my $field (@fields) {
10897: if ($names{$field} ne $oldnames{$field}) {
10898: $changed = 1;
10899: last;
10900: }
10901: }
10902: }
10903: unless ($changed) {
10904: $logmsg = 'No changes in user information needed for: '.$logmsg;
10905: &logthis($logmsg);
10906: return 'ok';
10907: }
10908: my $reply = &put('environment', \%names, $udom,$uname);
10909: if ($reply ne 'ok') {
10910: return 'error: '.$reply;
10911: }
1.1087 raeburn 10912: if ($names{'permanentemail'} ne $oldnames{'permanentemail'}) {
1.1494 raeburn 10913: &devalidate_cache_new('emailscache',$uname.':'.$udom);
1.1087 raeburn 10914: }
1.1075 raeburn 10915: my $sqlresult = &update_allusers_table($uname,$udom,\%names);
10916: &devalidate_cache_new('namescache',$uname.':'.$udom);
10917: $logmsg = 'Success modifying user '.$logmsg;
1.963 raeburn 10918: &logthis($logmsg);
1.134 albertel 10919: return 'ok';
1.80 www 10920: }
10921:
1.81 www 10922: # -------------------------------------------------------------- Modify student
1.80 www 10923:
1.81 www 10924: sub modifystudent {
10925: my ($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene,$usec,
1.957 raeburn 10926: $end,$start,$forceid,$desiredhome,$email,$type,$locktype,$cid,
1.1314 raeburn 10927: $selfenroll,$context,$inststatus,$credits,$instsec)=@_;
1.455 albertel 10928: if (!$cid) {
1.620 albertel 10929: unless ($cid=$env{'request.course.id'}) {
1.455 albertel 10930: return 'not_in_class';
10931: }
1.80 www 10932: }
10933: # --------------------------------------------------------------- Make the user
1.81 www 10934: my $reply=&modifyuser
1.209 matthew 10935: ($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene,$forceid,
1.990 raeburn 10936: $desiredhome,$email,$inststatus);
1.80 www 10937: unless ($reply eq 'ok') { return $reply; }
1.297 matthew 10938: # This will cause &modify_student_enrollment to get the uid from the
1.1235 raeburn 10939: # student's environment
1.297 matthew 10940: $uid = undef if (!$forceid);
1.455 albertel 10941: $reply = &modify_student_enrollment($udom,$uname,$uid,$first,$middle,$last,
1.1216 raeburn 10942: $gene,$usec,$end,$start,$type,$locktype,
1.1314 raeburn 10943: $cid,$selfenroll,$context,$credits,$instsec);
1.297 matthew 10944: return $reply;
10945: }
10946:
10947: sub modify_student_enrollment {
1.1216 raeburn 10948: my ($udom,$uname,$uid,$first,$middle,$last,$gene,$usec,$end,$start,$type,
1.1314 raeburn 10949: $locktype,$cid,$selfenroll,$context,$credits,$instsec) = @_;
1.455 albertel 10950: my ($cdom,$cnum,$chome);
10951: if (!$cid) {
1.620 albertel 10952: unless ($cid=$env{'request.course.id'}) {
1.455 albertel 10953: return 'not_in_class';
10954: }
1.620 albertel 10955: $cdom=$env{'course.'.$cid.'.domain'};
10956: $cnum=$env{'course.'.$cid.'.num'};
1.455 albertel 10957: } else {
10958: ($cdom,$cnum)=split(/_/,$cid);
10959: }
1.620 albertel 10960: $chome=$env{'course.'.$cid.'.home'};
1.455 albertel 10961: if (!$chome) {
1.457 raeburn 10962: $chome=&homeserver($cnum,$cdom);
1.297 matthew 10963: }
1.455 albertel 10964: if (!$chome) { return 'unknown_course'; }
1.297 matthew 10965: # Make sure the user exists
1.81 www 10966: my $uhome=&homeserver($uname,$udom);
10967: if (($uhome eq '') || ($uhome eq 'no_host')) {
10968: return 'error: no such user';
10969: }
1.297 matthew 10970: # Get student data if we were not given enough information
10971: if (!defined($first) || $first eq '' ||
10972: !defined($last) || $last eq '' ||
10973: !defined($uid) || $uid eq '' ||
10974: !defined($middle) || $middle eq '' ||
10975: !defined($gene) || $gene eq '') {
1.294 matthew 10976: # They did not supply us with enough data to enroll the student, so
10977: # we need to pick up more information.
1.297 matthew 10978: my %tmp = &get('environment',
1.294 matthew 10979: ['firstname','middlename','lastname', 'generation','id']
1.297 matthew 10980: ,$udom,$uname);
10981:
1.800 albertel 10982: #foreach my $key (keys(%tmp)) {
10983: # &logthis("key $key = ".$tmp{$key});
1.455 albertel 10984: #}
1.294 matthew 10985: $first = $tmp{'firstname'} if (!defined($first) || $first eq '');
10986: $middle = $tmp{'middlename'} if (!defined($middle) || $middle eq '');
10987: $last = $tmp{'lastname'} if (!defined($last) || $last eq '');
1.297 matthew 10988: $gene = $tmp{'generation'} if (!defined($gene) || $gene eq '');
1.294 matthew 10989: $uid = $tmp{'id'} if (!defined($uid) || $uid eq '');
10990: }
1.556 albertel 10991: my $fullname = &format_name($first,$middle,$last,$gene,'lastname');
1.1148 raeburn 10992: my $user = "$uname:$udom";
1.1494 raeburn 10993: my %old_entry = &get('classlist',[$user],$cdom,$cnum);
1.487 albertel 10994: my $reply=cput('classlist',
1.1148 raeburn 10995: {$user =>
1.1314 raeburn 10996: join(':',$end,$start,$uid,$usec,$fullname,$type,$locktype,$credits,$instsec) },
1.487 albertel 10997: $cdom,$cnum);
1.1148 raeburn 10998: if (($reply eq 'ok') || ($reply eq 'delayed')) {
10999: &devalidate_getsection_cache($udom,$uname,$cid);
11000: } else {
1.81 www 11001: return 'error: '.$reply;
11002: }
1.297 matthew 11003: # Add student role to user
1.83 www 11004: my $uurl='/'.$cid;
1.81 www 11005: $uurl=~s/\_/\//g;
11006: if ($usec) {
11007: $uurl.='/'.$usec;
11008: }
1.1148 raeburn 11009: my $result = &assignrole($udom,$uname,$uurl,'st',$end,$start,undef,
11010: $selfenroll,$context);
11011: if ($result ne 'ok') {
11012: if ($old_entry{$user} ne '') {
11013: $reply = &cput('classlist',\%old_entry,$cdom,$cnum);
11014: } else {
11015: $reply = &del('classlist',[$user],$cdom,$cnum);
11016: }
11017: }
11018: return $result;
1.21 www 11019: }
11020:
1.556 albertel 11021: sub format_name {
11022: my ($firstname,$middlename,$lastname,$generation,$first)=@_;
11023: my $name;
11024: if ($first ne 'lastname') {
11025: $name=$firstname.' '.$middlename.' '.$lastname.' '.$generation;
11026: } else {
11027: if ($lastname=~/\S/) {
11028: $name.= $lastname.' '.$generation.', '.$firstname.' '.$middlename;
11029: $name=~s/\s+,/,/;
11030: } else {
11031: $name.= $firstname.' '.$middlename.' '.$generation;
11032: }
11033: }
11034: $name=~s/^\s+//;
11035: $name=~s/\s+$//;
11036: $name=~s/\s+/ /g;
11037: return $name;
11038: }
11039:
1.84 www 11040: # ------------------------------------------------- Write to course preferences
11041:
11042: sub writecoursepref {
11043: my ($courseid,%prefs)=@_;
11044: $courseid=~s/^\///;
11045: $courseid=~s/\_/\//g;
11046: my ($cdomain,$cnum)=split(/\//,$courseid);
11047: my $chome=homeserver($cnum,$cdomain);
11048: if (($chome eq '') || ($chome eq 'no_host')) {
11049: return 'error: no such course';
11050: }
11051: my $cstring='';
1.800 albertel 11052: foreach my $pref (keys(%prefs)) {
11053: $cstring.=&escape($pref).'='.&escape($prefs{$pref}).'&';
1.191 harris41 11054: }
1.84 www 11055: $cstring=~s/\&$//;
11056: return reply('put:'.$cdomain.':'.$cnum.':environment:'.$cstring,$chome);
11057: }
11058:
11059: # ---------------------------------------------------------- Make/modify course
11060:
11061: sub createcourse {
1.741 raeburn 11062: my ($udom,$description,$url,$course_server,$nonstandard,$inst_code,
1.1423 raeburn 11063: $course_owner,$crstype,$cnum,$context,$category,$callercontext)=@_;
1.84 www 11064: $url=&declutter($url);
11065: my $cid='';
1.1028 raeburn 11066: if ($context eq 'requestcourses') {
11067: my $can_create = 0;
11068: my ($ownername,$ownerdom) = split(':',$course_owner);
11069: if ($udom eq $ownerdom) {
1.1423 raeburn 11070: my $reload;
11071: if (($callercontext eq 'auto') &&
11072: ($ownerdom eq $env{'user.domain'}) && ($ownername eq $env{'user.name'})) {
11073: $reload = 'reload';
11074: }
11075: if (&usertools_access($ownername,$ownerdom,$category,$reload,
1.1028 raeburn 11076: $context)) {
11077: $can_create = 1;
11078: }
11079: } else {
11080: my %userenv = &userenvironment($ownerdom,$ownername,'reqcrsotherdom.'.
11081: $category);
11082: if ($userenv{'reqcrsotherdom.'.$category} ne '') {
11083: my @curr = split(',',$userenv{'reqcrsotherdom.'.$category});
11084: if (@curr > 0) {
11085: my @options = qw(approval validate autolimit);
11086: my $optregex = join('|',@options);
11087: if (grep(/^\Q$udom\E:($optregex)(=?\d*)$/,@curr)) {
11088: $can_create = 1;
11089: }
11090: }
11091: }
11092: }
11093: if ($can_create) {
11094: unless ($ownername eq $env{'user.name'} && $ownerdom eq $env{'user.domain'}) {
11095: unless (&allowed('ccc',$udom)) {
11096: return 'refused';
11097: }
1.1017 raeburn 11098: }
11099: } else {
11100: return 'refused';
11101: }
1.1028 raeburn 11102: } elsif (!&allowed('ccc',$udom)) {
11103: return 'refused';
1.84 www 11104: }
1.1011 raeburn 11105: # --------------------------------------------------------------- Get Unique ID
11106: my $uname;
11107: if ($cnum =~ /^$match_courseid$/) {
11108: my $chome=&homeserver($cnum,$udom,'true');
11109: if (($chome eq '') || ($chome eq 'no_host')) {
11110: $uname = $cnum;
11111: } else {
1.1038 raeburn 11112: $uname = &generate_coursenum($udom,$crstype);
1.1011 raeburn 11113: }
11114: } else {
1.1038 raeburn 11115: $uname = &generate_coursenum($udom,$crstype);
1.1011 raeburn 11116: }
11117: return $uname if ($uname =~ /^error/);
11118: # -------------------------------------------------- Check supplied server name
1.1052 raeburn 11119: if (!defined($course_server)) {
11120: if (defined(&domain($udom,'primary'))) {
11121: $course_server = &domain($udom,'primary');
11122: } else {
11123: $course_server = $env{'user.home'};
11124: }
11125: }
11126: my %host_servers =
1.1494 raeburn 11127: &get_servers($udom,'library');
1.1052 raeburn 11128: unless ($host_servers{$course_server}) {
11129: return 'error: invalid home server for course: '.$course_server;
1.264 matthew 11130: }
1.84 www 11131: # ------------------------------------------------------------- Make the course
11132: my $reply=&reply('encrypt:makeuser:'.$udom.':'.$uname.':none::',
1.264 matthew 11133: $course_server);
1.84 www 11134: unless ($reply eq 'ok') { return 'error: '.$reply; }
1.1011 raeburn 11135: my $uhome=&homeserver($uname,$udom,'true');
1.84 www 11136: if (($uhome eq '') || ($uhome eq 'no_host')) {
11137: return 'error: no such course';
11138: }
1.271 www 11139: # ----------------------------------------------------------------- Course made
1.516 raeburn 11140: # log existence
1.1029 raeburn 11141: my $now = time;
1.918 raeburn 11142: my $newcourse = {
11143: $udom.'_'.$uname => {
1.921 raeburn 11144: description => $description,
11145: inst_code => $inst_code,
11146: owner => $course_owner,
11147: type => $crstype,
1.1029 raeburn 11148: creator => $env{'user.name'}.':'.
11149: $env{'user.domain'},
11150: created => $now,
11151: context => $context,
1.918 raeburn 11152: },
11153: };
1.921 raeburn 11154: &courseidput($udom,$newcourse,$uhome,'notime');
1.358 www 11155: # set toplevel url
1.271 www 11156: my $topurl=$url;
11157: unless ($nonstandard) {
11158: # ------------------------------------------ For standard courses, make top url
11159: my $mapurl=&clutter($url);
1.278 www 11160: if ($mapurl eq '/res/') { $mapurl=''; }
1.620 albertel 11161: $env{'form.initmap'}=(<<ENDINITMAP);
1.271 www 11162: <map>
11163: <resource id="1" type="start"></resource>
11164: <resource id="2" src="$mapurl"></resource>
11165: <resource id="3" type="finish"></resource>
11166: <link index="1" from="1" to="2"></link>
11167: <link index="2" from="2" to="3"></link>
11168: </map>
11169: ENDINITMAP
11170: $topurl=&declutter(
1.638 albertel 11171: &finishuserfileupload($uname,$udom,'initmap','default.sequence')
1.271 www 11172: );
11173: }
11174: # ----------------------------------------------------------- Write preferences
1.84 www 11175: &writecoursepref($udom.'_'.$uname,
1.1056 raeburn 11176: ('description' => $description,
11177: 'url' => $topurl,
11178: 'internal.creator' => $env{'user.name'}.':'.
11179: $env{'user.domain'},
11180: 'internal.created' => $now,
11181: 'internal.creationcontext' => $context)
11182: );
1.84 www 11183: return '/'.$udom.'/'.$uname;
11184: }
11185:
1.1011 raeburn 11186: # ------------------------------------------------------------------- Create ID
11187: sub generate_coursenum {
1.1038 raeburn 11188: my ($udom,$crstype) = @_;
1.1011 raeburn 11189: my $domdesc = &domain($udom);
11190: return 'error: invalid domain' if ($domdesc eq '');
1.1038 raeburn 11191: my $first;
11192: if ($crstype eq 'Community') {
11193: $first = '0';
11194: } else {
11195: $first = int(1+rand(9));
11196: }
11197: my $uname=$first.
1.1011 raeburn 11198: ('a'..'z','A'..'Z','0'..'9')[int(rand(62))].
11199: substr($$.time,0,5).unpack("H8",pack("I32",time)).
11200: unpack("H2",pack("I32",int(rand(255)))).$perlvar{'lonHostID'};
11201: # ----------------------------------------------- Make sure that does not exist
11202: my $uhome=&homeserver($uname,$udom,'true');
11203: unless (($uhome eq '') || ($uhome eq 'no_host')) {
1.1038 raeburn 11204: if ($crstype eq 'Community') {
11205: $first = '0';
11206: } else {
11207: $first = int(1+rand(9));
11208: }
11209: $uname=$first.
1.1011 raeburn 11210: ('a'..'z','A'..'Z','0'..'9')[int(rand(62))].
11211: substr($$.time,0,5).unpack("H8",pack("I32",time)).
11212: unpack("H2",pack("I32",int(rand(255)))).$perlvar{'lonHostID'};
11213: $uhome=&homeserver($uname,$udom,'true');
11214: unless (($uhome eq '') || ($uhome eq 'no_host')) {
11215: return 'error: unable to generate unique course-ID';
11216: }
11217: }
11218: return $uname;
11219: }
11220:
1.813 albertel 11221: sub is_course {
1.1167 droeschl 11222: my ($cdom, $cnum) = scalar(@_) == 1 ?
11223: ($_[0] =~ /^($match_domain)_($match_courseid)$/) : @_;
11224:
1.1381 raeburn 11225: return unless (($cdom =~ /^$match_domain$/) && ($cnum =~ /^$match_courseid$/));
11226: my $uhome=&homeserver($cnum,$cdom);
11227: my $iscourse;
11228: if (grep { $_ eq $uhome } current_machine_ids()) {
1.1382 raeburn 11229: $iscourse = &LONCAPA::Lond::is_course($cdom,$cnum);
1.1381 raeburn 11230: } else {
11231: my $hashid = $cdom.':'.$cnum;
11232: ($iscourse,my $cached) = &is_cached_new('iscourse',$hashid);
11233: unless (defined($cached)) {
11234: my %courses = &courseiddump($cdom, '.', 1, '.', '.',
11235: $cnum,undef,undef,'.');
11236: $iscourse = 0;
11237: if (exists($courses{$cdom.'_'.$cnum})) {
11238: $iscourse = 1;
11239: }
11240: &do_cache_new('iscourse',$hashid,$iscourse,3600);
11241: }
11242: }
11243: return unless ($iscourse);
1.1167 droeschl 11244: return wantarray ? ($cdom, $cnum) : $cdom.'_'.$cnum;
1.813 albertel 11245: }
11246:
1.1015 raeburn 11247: sub store_userdata {
11248: my ($storehash,$datakey,$namespace,$udom,$uname) = @_;
1.1013 raeburn 11249: my $result;
1.1016 raeburn 11250: if ($datakey ne '') {
1.1013 raeburn 11251: if (ref($storehash) eq 'HASH') {
1.1017 raeburn 11252: if ($udom eq '' || $uname eq '') {
11253: $udom = $env{'user.domain'};
11254: $uname = $env{'user.name'};
11255: }
11256: my $uhome=&homeserver($uname,$udom);
1.1013 raeburn 11257: if (($uhome eq '') || ($uhome eq 'no_host')) {
11258: $result = 'error: no_host';
11259: } else {
1.1434 raeburn 11260: $storehash->{'ip'} = &get_requestor_ip();
1.1013 raeburn 11261: $storehash->{'host'} = $perlvar{'lonHostID'};
11262:
11263: my $namevalue='';
11264: foreach my $key (keys(%{$storehash})) {
11265: $namevalue.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
11266: }
11267: $namevalue=~s/\&$//;
1.1224 raeburn 11268: unless ($namespace eq 'courserequests') {
11269: $datakey = &escape($datakey);
11270: }
1.1105 raeburn 11271: $result = &reply("store:$udom:$uname:$namespace:$datakey:".
11272: $namevalue,$uhome);
1.1013 raeburn 11273: }
11274: } else {
11275: $result = 'error: data to store was not a hash reference';
11276: }
11277: } else {
11278: $result= 'error: invalid requestkey';
11279: }
11280: return $result;
11281: }
11282:
1.21 www 11283: # ---------------------------------------------------------- Assign Custom Role
11284:
11285: sub assigncustomrole {
1.957 raeburn 11286: my ($udom,$uname,$url,$rdom,$rnam,$rolename,$end,$start,$deleteflag,$selfenroll,$context)=@_;
1.21 www 11287: return &assignrole($udom,$uname,$url,'cr/'.$rdom.'/'.$rnam.'/'.$rolename,
1.957 raeburn 11288: $end,$start,$deleteflag,$selfenroll,$context);
1.21 www 11289: }
11290:
11291: # ----------------------------------------------------------------- Revoke Role
11292:
11293: sub revokerole {
1.957 raeburn 11294: my ($udom,$uname,$url,$role,$deleteflag,$selfenroll,$context)=@_;
1.21 www 11295: my $now=time;
1.965 raeburn 11296: return &assignrole($udom,$uname,$url,$role,$now,undef,$deleteflag,$selfenroll,$context);
1.21 www 11297: }
11298:
11299: # ---------------------------------------------------------- Revoke Custom Role
11300:
11301: sub revokecustomrole {
1.957 raeburn 11302: my ($udom,$uname,$url,$rdom,$rnam,$rolename,$deleteflag,$selfenroll,$context)=@_;
1.21 www 11303: my $now=time;
1.357 www 11304: return &assigncustomrole($udom,$uname,$url,$rdom,$rnam,$rolename,$now,
1.957 raeburn 11305: $deleteflag,$selfenroll,$context);
1.17 www 11306: }
11307:
1.533 banghart 11308: # ------------------------------------------------------------ Disk usage
1.535 albertel 11309: sub diskusage {
1.955 raeburn 11310: my ($udom,$uname,$directorypath,$getpropath)=@_;
11311: $directorypath =~ s/\/$//;
11312: my $listing=&reply('du2:'.&escape($directorypath).':'
11313: .&escape($getpropath).':'.&escape($uname).':'
11314: .&escape($udom),homeserver($uname,$udom));
11315: if ($listing eq 'unknown_cmd') {
11316: if ($getpropath) {
11317: $directorypath = &propath($udom,$uname).'/'.$directorypath;
11318: }
11319: $listing = &reply('du:'.$directorypath,homeserver($uname,$udom));
11320: }
1.514 albertel 11321: return $listing;
1.512 banghart 11322: }
11323:
1.566 banghart 11324: sub is_locked {
1.1096 raeburn 11325: my ($file_name, $domain, $user, $which) = @_;
1.566 banghart 11326: my @check;
11327: my $is_locked;
1.1093 raeburn 11328: push (@check,$file_name);
1.613 albertel 11329: my %locked = &get('file_permissions',\@check,
1.620 albertel 11330: $env{'user.domain'},$env{'user.name'});
1.615 albertel 11331: my ($tmp)=keys(%locked);
11332: if ($tmp=~/^error:/) { undef(%locked); }
1.745 raeburn 11333:
1.566 banghart 11334: if (ref($locked{$file_name}) eq 'ARRAY') {
1.745 raeburn 11335: $is_locked = 'false';
11336: foreach my $entry (@{$locked{$file_name}}) {
1.1096 raeburn 11337: if (ref($entry) eq 'ARRAY') {
1.746 raeburn 11338: $is_locked = 'true';
1.1096 raeburn 11339: if (ref($which) eq 'ARRAY') {
11340: push(@{$which},$entry);
11341: } else {
11342: last;
11343: }
1.745 raeburn 11344: }
11345: }
1.566 banghart 11346: } else {
11347: $is_locked = 'false';
11348: }
1.1093 raeburn 11349: return $is_locked;
1.566 banghart 11350: }
11351:
1.759 albertel 11352: sub declutter_portfile {
11353: my ($file) = @_;
1.833 albertel 11354: $file =~ s{^(/portfolio/|portfolio/)}{/};
1.759 albertel 11355: return $file;
11356: }
11357:
1.559 banghart 11358: # ------------------------------------------------------------- Mark as Read Only
11359:
11360: sub mark_as_readonly {
11361: my ($domain,$user,$files,$what) = @_;
1.613 albertel 11362: my %current_permissions = &dump('file_permissions',$domain,$user);
1.615 albertel 11363: my ($tmp)=keys(%current_permissions);
11364: if ($tmp=~/^error:/) { undef(%current_permissions); }
1.560 banghart 11365: foreach my $file (@{$files}) {
1.759 albertel 11366: $file = &declutter_portfile($file);
1.561 banghart 11367: push(@{$current_permissions{$file}},$what);
1.559 banghart 11368: }
1.613 albertel 11369: &put('file_permissions',\%current_permissions,$domain,$user);
1.559 banghart 11370: return;
11371: }
11372:
1.572 banghart 11373: # ------------------------------------------------------------Save Selected Files
11374:
11375: sub save_selected_files {
11376: my ($user, $path, @files) = @_;
11377: my $filename = $user."savedfiles";
1.573 banghart 11378: my @other_files = &files_not_in_path($user, $path);
1.1359 raeburn 11379: open (OUT,'>',LONCAPA::tempdir().$filename);
1.573 banghart 11380: foreach my $file (@files) {
1.620 albertel 11381: print (OUT $env{'form.currentpath'}.$file."\n");
1.573 banghart 11382: }
11383: foreach my $file (@other_files) {
1.574 banghart 11384: print (OUT $file."\n");
1.572 banghart 11385: }
1.574 banghart 11386: close (OUT);
1.572 banghart 11387: return 'ok';
11388: }
11389:
1.574 banghart 11390: sub clear_selected_files {
11391: my ($user) = @_;
11392: my $filename = $user."savedfiles";
1.1359 raeburn 11393: open (OUT,'>',LONCAPA::tempdir().$filename);
1.574 banghart 11394: print (OUT undef);
11395: close (OUT);
11396: return ("ok");
11397: }
11398:
1.572 banghart 11399: sub files_in_path {
11400: my ($user, $path) = @_;
11401: my $filename = $user."savedfiles";
11402: my %return_files;
1.1359 raeburn 11403: open (IN,'<',LONCAPA::tempdir().$filename);
1.573 banghart 11404: while (my $line_in = <IN>) {
1.574 banghart 11405: chomp ($line_in);
11406: my @paths_and_file = split (m!/!, $line_in);
11407: my $file_part = pop (@paths_and_file);
11408: my $path_part = join ('/', @paths_and_file);
1.573 banghart 11409: $path_part.='/';
11410: my $path_and_file = $path_part.$file_part;
11411: if ($path_part eq $path) {
11412: $return_files{$file_part}= 'selected';
11413: }
11414: }
1.574 banghart 11415: close (IN);
11416: return (\%return_files);
1.572 banghart 11417: }
11418:
11419: # called in portfolio select mode, to show files selected NOT in current directory
11420: sub files_not_in_path {
11421: my ($user, $path) = @_;
11422: my $filename = $user."savedfiles";
11423: my @return_files;
11424: my $path_part;
1.1359 raeburn 11425: open(IN, '<',LONCAPA::tempdir().$filename);
1.800 albertel 11426: while (my $line = <IN>) {
1.572 banghart 11427: #ok, I know it's clunky, but I want it to work
1.800 albertel 11428: my @paths_and_file = split(m|/|, $line);
11429: my $file_part = pop(@paths_and_file);
11430: chomp($file_part);
11431: my $path_part = join('/', @paths_and_file);
1.572 banghart 11432: $path_part .= '/';
11433: my $path_and_file = $path_part.$file_part;
11434: if ($path_part ne $path) {
1.800 albertel 11435: push(@return_files, ($path_and_file));
1.572 banghart 11436: }
11437: }
1.800 albertel 11438: close(OUT);
1.574 banghart 11439: return (@return_files);
1.572 banghart 11440: }
11441:
1.1273 raeburn 11442: #------------------------------Submitted/Handedback Portfolio Files Versioning
11443:
11444: sub portfiles_versioning {
11445: my ($symb,$domain,$stu_name,$portfiles,$versioned_portfiles) = @_;
11446: my $portfolio_root = '/userfiles/portfolio';
11447: return unless ((ref($portfiles) eq 'ARRAY') && (ref($versioned_portfiles) eq 'ARRAY'));
11448: foreach my $file (@{$portfiles}) {
11449: &unmark_as_readonly($domain,$stu_name,[$symb,$env{'request.course.id'}],$file);
11450: my ($directory,$answer_file) =($file =~ /^(.*?)([^\/]*)$/);
11451: my ($answer_name,$answer_ver,$answer_ext) = &file_name_version_ext($answer_file);
11452: my $getpropath = 1;
11453: my ($dir_list,$listerror) = &dirlist($portfolio_root.$directory,$domain,
11454: $stu_name,$getpropath);
11455: my $version = &get_next_version($answer_name,$answer_ext,$dir_list);
11456: my $new_answer =
11457: &version_selected_portfile($domain,$stu_name,$directory,$answer_file,$version);
11458: if ($new_answer ne 'problem getting file') {
11459: push(@{$versioned_portfiles}, $directory.$new_answer);
11460: &mark_as_readonly($domain,$stu_name,[$directory.$new_answer],
11461: [$symb,$env{'request.course.id'},'graded']);
11462: }
11463: }
11464: }
11465:
11466: sub get_next_version {
11467: my ($answer_name, $answer_ext, $dir_list) = @_;
11468: my $version;
11469: if (ref($dir_list) eq 'ARRAY') {
11470: foreach my $row (@{$dir_list}) {
11471: my ($file) = split(/\&/,$row,2);
11472: my ($file_name,$file_version,$file_ext) =
11473: &file_name_version_ext($file);
11474: if (($file_name eq $answer_name) &&
11475: ($file_ext eq $answer_ext)) {
11476: # gets here if filename and extension match,
11477: # regardless of version
11478: if ($file_version ne '') {
11479: # a versioned file is found so save it for later
11480: if ($file_version > $version) {
11481: $version = $file_version;
11482: }
11483: }
11484: }
11485: }
11486: }
11487: $version ++;
11488: return($version);
11489: }
11490:
11491: sub version_selected_portfile {
11492: my ($domain,$stu_name,$directory,$file_name,$version) = @_;
11493: my ($answer_name,$answer_ver,$answer_ext) =
11494: &file_name_version_ext($file_name);
11495: my $new_answer;
11496: $env{'form.copy'} =
11497: &getfile("/uploaded/$domain/$stu_name/portfolio$directory$file_name");
11498: if($env{'form.copy'} eq '-1') {
11499: $new_answer = 'problem getting file';
11500: } else {
11501: $new_answer = $answer_name.'.'.$version.'.'.$answer_ext;
11502: my $copy_result =
11503: &finishuserfileupload($stu_name,$domain,'copy',
11504: '/portfolio'.$directory.$new_answer);
11505: }
11506: undef($env{'form.copy'});
11507: return ($new_answer);
11508: }
11509:
11510: sub file_name_version_ext {
11511: my ($file)=@_;
11512: my @file_parts = split(/\./, $file);
11513: my ($name,$version,$ext);
11514: if (@file_parts > 1) {
11515: $ext=pop(@file_parts);
11516: if (@file_parts > 1 && $file_parts[-1] =~ /^\d+$/) {
11517: $version=pop(@file_parts);
11518: }
11519: $name=join('.',@file_parts);
11520: } else {
11521: $name=join('.',@file_parts);
11522: }
11523: return($name,$version,$ext);
11524: }
11525:
1.745 raeburn 11526: #----------------------------------------------Get portfolio file permissions
1.629 banghart 11527:
1.745 raeburn 11528: sub get_portfile_permissions {
11529: my ($domain,$user) = @_;
1.613 albertel 11530: my %current_permissions = &dump('file_permissions',$domain,$user);
1.615 albertel 11531: my ($tmp)=keys(%current_permissions);
11532: if ($tmp=~/^error:/) { undef(%current_permissions); }
1.745 raeburn 11533: return \%current_permissions;
11534: }
11535:
11536: #---------------------------------------------Get portfolio file access controls
11537:
1.749 raeburn 11538: sub get_access_controls {
1.745 raeburn 11539: my ($current_permissions,$group,$file) = @_;
1.769 albertel 11540: my %access;
11541: my $real_file = $file;
11542: $file =~ s/\.meta$//;
1.745 raeburn 11543: if (defined($file)) {
1.749 raeburn 11544: if (ref($$current_permissions{$file."\0".'accesscontrol'}) eq 'HASH') {
11545: foreach my $control (keys(%{$$current_permissions{$file."\0".'accesscontrol'}})) {
1.769 albertel 11546: $access{$real_file}{$control} = $$current_permissions{$file."\0".$control};
1.749 raeburn 11547: }
11548: }
1.745 raeburn 11549: } else {
1.749 raeburn 11550: foreach my $key (keys(%{$current_permissions})) {
11551: if ($key =~ /\0accesscontrol$/) {
11552: if (defined($group)) {
11553: if ($key !~ m-^\Q$group\E/-) {
11554: next;
11555: }
11556: }
11557: my ($fullpath) = split(/\0/,$key);
11558: if (ref($$current_permissions{$key}) eq 'HASH') {
11559: foreach my $control (keys(%{$$current_permissions{$key}})) {
11560: $access{$fullpath}{$control}=$$current_permissions{$fullpath."\0".$control};
11561: }
11562: }
11563: }
11564: }
11565: }
11566: return %access;
11567: }
11568:
11569: sub modify_access_controls {
11570: my ($file_name,$changes,$domain,$user)=@_;
11571: my ($outcome,$deloutcome);
11572: my %store_permissions;
11573: my %new_values;
11574: my %new_control;
11575: my %translation;
11576: my @deletions = ();
11577: my $now = time;
11578: if (exists($$changes{'activate'})) {
11579: if (ref($$changes{'activate'}) eq 'HASH') {
11580: my @newitems = sort(keys(%{$$changes{'activate'}}));
11581: my $numnew = scalar(@newitems);
11582: for (my $i=0; $i<$numnew; $i++) {
11583: my $newkey = $newitems[$i];
11584: my $newid = &Apache::loncommon::get_cgi_id();
1.797 raeburn 11585: if ($newkey =~ /^\d+:/) {
11586: $newkey =~ s/^(\d+)/$newid/;
11587: $translation{$1} = $newid;
11588: } elsif ($newkey =~ /^\d+_\d+_\d+:/) {
11589: $newkey =~ s/^(\d+_\d+_\d+)/$newid/;
11590: $translation{$1} = $newid;
11591: }
1.749 raeburn 11592: $new_values{$file_name."\0".$newkey} =
11593: $$changes{'activate'}{$newitems[$i]};
11594: $new_control{$newkey} = $now;
11595: }
11596: }
11597: }
11598: my %todelete;
11599: my %changed_items;
11600: foreach my $action ('delete','update') {
11601: if (exists($$changes{$action})) {
11602: if (ref($$changes{$action}) eq 'HASH') {
11603: foreach my $key (keys(%{$$changes{$action}})) {
11604: my ($itemnum) = ($key =~ /^([^:]+):/);
11605: if ($action eq 'delete') {
11606: $todelete{$itemnum} = 1;
11607: } else {
11608: $changed_items{$itemnum} = $key;
11609: }
11610: }
1.745 raeburn 11611: }
11612: }
1.749 raeburn 11613: }
11614: # get lock on access controls for file.
11615: my $lockhash = {
11616: $file_name."\0".'locked_access_records' => $env{'user.name'}.
11617: ':'.$env{'user.domain'},
11618: };
11619: my $tries = 0;
11620: my $gotlock = &newput('file_permissions',$lockhash,$domain,$user);
11621:
1.1288 damieng 11622: while (($gotlock ne 'ok') && $tries < 10) {
1.749 raeburn 11623: $tries ++;
1.1289 damieng 11624: sleep(0.1);
1.749 raeburn 11625: $gotlock = &newput('file_permissions',$lockhash,$domain,$user);
11626: }
11627: if ($gotlock eq 'ok') {
11628: my %curr_permissions = &dump('file_permissions',$domain,$user,$file_name);
11629: my ($tmp)=keys(%curr_permissions);
11630: if ($tmp=~/^error:/) { undef(%curr_permissions); }
11631: if (exists($curr_permissions{$file_name."\0".'accesscontrol'})) {
11632: my $curr_controls = $curr_permissions{$file_name."\0".'accesscontrol'};
11633: if (ref($curr_controls) eq 'HASH') {
11634: foreach my $control_item (keys(%{$curr_controls})) {
11635: my ($itemnum) = ($control_item =~ /^([^:]+):/);
11636: if (defined($todelete{$itemnum})) {
11637: push(@deletions,$file_name."\0".$control_item);
11638: } else {
11639: if (defined($changed_items{$itemnum})) {
11640: $new_control{$changed_items{$itemnum}} = $now;
11641: push(@deletions,$file_name."\0".$control_item);
11642: $new_values{$file_name."\0".$changed_items{$itemnum}} = $$changes{'update'}{$changed_items{$itemnum}};
11643: } else {
11644: $new_control{$control_item} = $$curr_controls{$control_item};
11645: }
11646: }
1.745 raeburn 11647: }
11648: }
11649: }
1.970 raeburn 11650: my ($group);
11651: if (&is_course($domain,$user)) {
11652: ($group,my $file) = split(/\//,$file_name,2);
11653: }
1.749 raeburn 11654: $deloutcome = &del('file_permissions',\@deletions,$domain,$user);
11655: $new_values{$file_name."\0".'accesscontrol'} = \%new_control;
11656: $outcome = &put('file_permissions',\%new_values,$domain,$user);
11657: # remove lock
11658: my @del_lock = ($file_name."\0".'locked_access_records');
11659: my $dellockoutcome = &del('file_permissions',\@del_lock,$domain,$user);
1.818 raeburn 11660: my $sqlresult =
1.970 raeburn 11661: &update_portfolio_table($user,$domain,$file_name,'portfolio_access',
1.818 raeburn 11662: $group);
1.749 raeburn 11663: } else {
11664: $outcome = "error: could not obtain lockfile\n";
1.745 raeburn 11665: }
1.749 raeburn 11666: return ($outcome,$deloutcome,\%new_values,\%translation);
1.745 raeburn 11667: }
11668:
1.827 raeburn 11669: sub make_public_indefinitely {
1.1271 raeburn 11670: my (@requrl) = @_;
11671: return &automated_portfile_access('public',\@requrl);
11672: }
11673:
11674: sub automated_portfile_access {
11675: my ($accesstype,$addsref,$delsref,$info) = @_;
1.1273 raeburn 11676: unless (($accesstype eq 'public') || ($accesstype eq 'ip')) {
11677: return 'invalid';
11678: }
1.1271 raeburn 11679: my %urls;
11680: if (ref($addsref) eq 'ARRAY') {
11681: foreach my $requrl (@{$addsref}) {
11682: if (&is_portfolio_url($requrl)) {
11683: unless (exists($urls{$requrl})) {
11684: $urls{$requrl} = 'add';
11685: }
11686: }
11687: }
11688: }
11689: if (ref($delsref) eq 'ARRAY') {
11690: foreach my $requrl (@{$delsref}) {
11691: if (&is_portfolio_url($requrl)) {
11692: unless (exists($urls{$requrl})) {
11693: $urls{$requrl} = 'delete';
11694: }
11695: }
11696: }
11697: }
11698: unless (keys(%urls)) {
11699: return 'invalid';
11700: }
11701: my $ip;
11702: if ($accesstype eq 'ip') {
11703: if (ref($info) eq 'HASH') {
11704: if ($info->{'ip'} ne '') {
11705: $ip = $info->{'ip'};
11706: }
11707: }
11708: if ($ip eq '') {
11709: return 'invalid';
11710: }
11711: }
11712: my $errors;
1.827 raeburn 11713: my $now = time;
1.1271 raeburn 11714: my %current_perms;
11715: foreach my $requrl (sort(keys(%urls))) {
11716: my $action;
11717: if ($urls{$requrl} eq 'add') {
11718: $action = 'activate';
11719: } else {
11720: $action = 'none';
11721: }
11722: my $aclnum = 0;
1.827 raeburn 11723: my (undef,$udom,$unum,$file_name,$group) =
11724: &parse_portfolio_url($requrl);
1.1271 raeburn 11725: unless (exists($current_perms{$unum.':'.$udom})) {
11726: $current_perms{$unum.':'.$udom} = &get_portfile_permissions($udom,$unum);
11727: }
11728: my %access_controls = &get_access_controls($current_perms{$unum.':'.$udom},
1.827 raeburn 11729: $group,$file_name);
11730: foreach my $key (keys(%{$access_controls{$file_name}})) {
11731: my ($num,$scope,$end,$start) =
11732: ($key =~ /^([^:]+):([a-z]+)_(\d*)_?(\d*)$/);
1.1271 raeburn 11733: if ($scope eq $accesstype) {
11734: if (($start <= $now) && ($end == 0)) {
11735: if ($accesstype eq 'ip') {
11736: if (ref($access_controls{$file_name}{$key}) eq 'HASH') {
11737: if (ref($access_controls{$file_name}{$key}{'ip'}) eq 'ARRAY') {
11738: if (grep(/^\Q$ip\E$/,@{$access_controls{$file_name}{$key}{'ip'}})) {
11739: if ($urls{$requrl} eq 'add') {
11740: $action = 'none';
11741: last;
11742: } else {
11743: $action = 'delete';
11744: $aclnum = $num;
11745: last;
11746: }
11747: }
11748: }
11749: }
11750: } elsif ($accesstype eq 'public') {
11751: if ($urls{$requrl} eq 'add') {
11752: $action = 'none';
11753: last;
11754: } else {
11755: $action = 'delete';
11756: $aclnum = $num;
11757: last;
11758: }
11759: }
11760: } elsif ($accesstype eq 'public') {
1.827 raeburn 11761: $action = 'update';
11762: $aclnum = $num;
1.1271 raeburn 11763: last;
1.827 raeburn 11764: }
11765: }
11766: }
11767: if ($action eq 'none') {
1.1271 raeburn 11768: next;
1.827 raeburn 11769: } else {
11770: my %changes;
11771: my $newend = 0;
11772: my $newstart = $now;
1.1271 raeburn 11773: my $newkey = $aclnum.':'.$accesstype.'_'.$newend.'_'.$newstart;
1.827 raeburn 11774: $changes{$action}{$newkey} = {
1.1271 raeburn 11775: type => $accesstype,
1.827 raeburn 11776: time => {
11777: start => $newstart,
11778: end => $newend,
11779: },
11780: };
1.1271 raeburn 11781: if ($accesstype eq 'ip') {
11782: $changes{$action}{$newkey}{'ip'} = [$ip];
11783: }
1.827 raeburn 11784: my ($outcome,$deloutcome,$new_values,$translation) =
11785: &modify_access_controls($file_name,\%changes,$udom,$unum);
1.1271 raeburn 11786: unless ($outcome eq 'ok') {
11787: $errors .= $outcome.' ';
11788: }
1.827 raeburn 11789: }
1.1271 raeburn 11790: }
11791: if ($errors) {
11792: $errors =~ s/\s$//;
11793: return $errors;
1.827 raeburn 11794: } else {
1.1271 raeburn 11795: return 'ok';
1.827 raeburn 11796: }
11797: }
11798:
1.745 raeburn 11799: #------------------------------------------------------Get Marked as Read Only
11800:
11801: sub get_marked_as_readonly {
11802: my ($domain,$user,$what,$group) = @_;
11803: my $current_permissions = &get_portfile_permissions($domain,$user);
1.563 banghart 11804: my @readonly_files;
1.629 banghart 11805: my $cmp1=$what;
11806: if (ref($what)) { $cmp1=join('',@{$what}) };
1.745 raeburn 11807: while (my ($file_name,$value) = each(%{$current_permissions})) {
11808: if (defined($group)) {
11809: if ($file_name !~ m-^\Q$group\E/-) {
11810: next;
11811: }
11812: }
1.561 banghart 11813: if (ref($value) eq "ARRAY"){
11814: foreach my $stored_what (@{$value}) {
1.629 banghart 11815: my $cmp2=$stored_what;
1.759 albertel 11816: if (ref($stored_what) eq 'ARRAY') {
1.746 raeburn 11817: $cmp2=join('',@{$stored_what});
1.745 raeburn 11818: }
1.629 banghart 11819: if ($cmp1 eq $cmp2) {
1.561 banghart 11820: push(@readonly_files, $file_name);
1.745 raeburn 11821: last;
1.563 banghart 11822: } elsif (!defined($what)) {
11823: push(@readonly_files, $file_name);
1.745 raeburn 11824: last;
1.561 banghart 11825: }
11826: }
1.745 raeburn 11827: }
1.561 banghart 11828: }
11829: return @readonly_files;
11830: }
1.577 banghart 11831: #-----------------------------------------------------------Get Marked as Read Only Hash
1.561 banghart 11832:
1.577 banghart 11833: sub get_marked_as_readonly_hash {
1.745 raeburn 11834: my ($current_permissions,$group,$what) = @_;
1.577 banghart 11835: my %readonly_files;
1.745 raeburn 11836: while (my ($file_name,$value) = each(%{$current_permissions})) {
11837: if (defined($group)) {
11838: if ($file_name !~ m-^\Q$group\E/-) {
11839: next;
11840: }
11841: }
1.577 banghart 11842: if (ref($value) eq "ARRAY"){
11843: foreach my $stored_what (@{$value}) {
1.745 raeburn 11844: if (ref($stored_what) eq 'ARRAY') {
1.750 banghart 11845: foreach my $lock_descriptor(@{$stored_what}) {
11846: if ($lock_descriptor eq 'graded') {
11847: $readonly_files{$file_name} = 'graded';
11848: } elsif ($lock_descriptor eq 'handback') {
11849: $readonly_files{$file_name} = 'handback';
11850: } else {
11851: if (!exists($readonly_files{$file_name})) {
11852: $readonly_files{$file_name} = 'locked';
11853: }
11854: }
1.745 raeburn 11855: }
1.750 banghart 11856: }
1.577 banghart 11857: }
11858: }
11859: }
11860: return %readonly_files;
11861: }
1.559 banghart 11862: # ------------------------------------------------------------ Unmark as Read Only
11863:
11864: sub unmark_as_readonly {
1.629 banghart 11865: # unmarks $file_name (if $file_name is defined), or all files locked by $what
11866: # for portfolio submissions, $what contains [$symb,$crsid]
1.745 raeburn 11867: my ($domain,$user,$what,$file_name,$group) = @_;
1.759 albertel 11868: $file_name = &declutter_portfile($file_name);
1.634 albertel 11869: my $symb_crs = $what;
11870: if (ref($what)) { $symb_crs=join('',@$what); }
1.745 raeburn 11871: my %current_permissions = &dump('file_permissions',$domain,$user,$group);
1.615 albertel 11872: my ($tmp)=keys(%current_permissions);
11873: if ($tmp=~/^error:/) { undef(%current_permissions); }
1.745 raeburn 11874: my @readonly_files = &get_marked_as_readonly($domain,$user,$what,$group);
1.650 albertel 11875: foreach my $file (@readonly_files) {
1.759 albertel 11876: my $clean_file = &declutter_portfile($file);
11877: if (defined($file_name) && ($file_name ne $clean_file)) { next; }
1.650 albertel 11878: my $current_locks = $current_permissions{$file};
1.563 banghart 11879: my @new_locks;
11880: my @del_keys;
11881: if (ref($current_locks) eq "ARRAY"){
11882: foreach my $locker (@{$current_locks}) {
1.632 albertel 11883: my $compare=$locker;
1.749 raeburn 11884: if (ref($locker) eq 'ARRAY') {
1.745 raeburn 11885: $compare=join('',@{$locker});
1.746 raeburn 11886: if ($compare ne $symb_crs) {
11887: push(@new_locks, $locker);
11888: }
1.563 banghart 11889: }
11890: }
1.650 albertel 11891: if (scalar(@new_locks) > 0) {
1.563 banghart 11892: $current_permissions{$file} = \@new_locks;
11893: } else {
11894: push(@del_keys, $file);
1.613 albertel 11895: &del('file_permissions',\@del_keys, $domain, $user);
1.650 albertel 11896: delete($current_permissions{$file});
1.563 banghart 11897: }
11898: }
1.561 banghart 11899: }
1.613 albertel 11900: &put('file_permissions',\%current_permissions,$domain,$user);
1.559 banghart 11901: return;
11902: }
1.512 banghart 11903:
1.17 www 11904: # ------------------------------------------------------------ Directory lister
11905:
11906: sub dirlist {
1.955 raeburn 11907: my ($uri,$userdomain,$username,$getpropath,$getuserdir,$alternateRoot)=@_;
1.18 www 11908: $uri=~s/^\///;
11909: $uri=~s/\/$//;
1.253 stredwic 11910: my ($udom, $uname);
1.955 raeburn 11911: if ($getuserdir) {
1.253 stredwic 11912: $udom = $userdomain;
11913: $uname = $username;
1.955 raeburn 11914: } else {
11915: (undef,$udom,$uname)=split(/\//,$uri);
11916: if(defined($userdomain)) {
11917: $udom = $userdomain;
11918: }
11919: if(defined($username)) {
11920: $uname = $username;
11921: }
1.253 stredwic 11922: }
1.955 raeburn 11923: my ($dirRoot,$listing,@listing_results);
1.253 stredwic 11924:
1.955 raeburn 11925: $dirRoot = $perlvar{'lonDocRoot'};
11926: if (defined($getpropath)) {
11927: $dirRoot = &propath($udom,$uname);
1.253 stredwic 11928: $dirRoot =~ s/\/$//;
1.955 raeburn 11929: } elsif (defined($getuserdir)) {
11930: my $subdir=$uname.'__';
11931: $subdir =~ s/(.)(.)(.).*/$1\/$2\/$3/;
11932: $dirRoot = $Apache::lonnet::perlvar{'lonUsersDir'}
11933: ."/$udom/$subdir/$uname";
11934: } elsif (defined($alternateRoot)) {
11935: $dirRoot = $alternateRoot;
1.751 banghart 11936: }
1.253 stredwic 11937:
11938: if($udom) {
11939: if($uname) {
1.1135 raeburn 11940: my $uhome = &homeserver($uname,$udom);
1.1136 raeburn 11941: if ($uhome eq 'no_host') {
11942: return ([],'no_host');
11943: }
1.955 raeburn 11944: $listing = &reply('ls3:'.&escape('/'.$uri).':'.$getpropath.':'
1.956 raeburn 11945: .$getuserdir.':'.&escape($dirRoot)
1.1135 raeburn 11946: .':'.&escape($uname).':'.&escape($udom),$uhome);
1.955 raeburn 11947: if ($listing eq 'unknown_cmd') {
1.1135 raeburn 11948: $listing = &reply('ls2:'.$dirRoot.'/'.$uri,$uhome);
1.955 raeburn 11949: } else {
11950: @listing_results = map { &unescape($_); } split(/:/,$listing);
11951: }
1.605 matthew 11952: if ($listing eq 'unknown_cmd') {
1.1135 raeburn 11953: $listing = &reply('ls:'.$dirRoot.'/'.$uri,$uhome);
1.605 matthew 11954: @listing_results = split(/:/,$listing);
11955: } else {
11956: @listing_results = map { &unescape($_); } split(/:/,$listing);
11957: }
1.1135 raeburn 11958: if (($listing eq 'no_such_host') || ($listing eq 'con_lost') ||
1.1136 raeburn 11959: ($listing eq 'rejected') || ($listing eq 'refused') ||
11960: ($listing eq 'no_such_dir') || ($listing eq 'empty')) {
11961: return ([],$listing);
11962: } else {
11963: return (\@listing_results);
1.1135 raeburn 11964: }
1.955 raeburn 11965: } elsif(!$alternateRoot) {
1.1136 raeburn 11966: my (%allusers,%listerror);
1.841 albertel 11967: my %servers = &get_servers($udom,'library');
1.955 raeburn 11968: foreach my $tryserver (keys(%servers)) {
11969: $listing = &reply('ls3:'.&escape("/res/$udom").':::::'.
11970: &escape($udom),$tryserver);
11971: if ($listing eq 'unknown_cmd') {
11972: $listing = &reply('ls2:'.$perlvar{'lonDocRoot'}.'/res/'.
11973: $udom, $tryserver);
11974: } else {
11975: @listing_results = map { &unescape($_); } split(/:/,$listing);
11976: }
1.841 albertel 11977: if ($listing eq 'unknown_cmd') {
11978: $listing = &reply('ls:'.$perlvar{'lonDocRoot'}.'/res/'.
11979: $udom, $tryserver);
11980: @listing_results = split(/:/,$listing);
11981: } else {
11982: @listing_results =
11983: map { &unescape($_); } split(/:/,$listing);
11984: }
1.1136 raeburn 11985: if (($listing eq 'no_such_host') || ($listing eq 'con_lost') ||
11986: ($listing eq 'rejected') || ($listing eq 'refused') ||
11987: ($listing eq 'no_such_dir') || ($listing eq 'empty')) {
11988: $listerror{$tryserver} = $listing;
11989: } else {
1.841 albertel 11990: foreach my $line (@listing_results) {
11991: my ($entry) = split(/&/,$line,2);
11992: $allusers{$entry} = 1;
11993: }
11994: }
1.253 stredwic 11995: }
1.1136 raeburn 11996: my @alluserslist=();
1.800 albertel 11997: foreach my $user (sort(keys(%allusers))) {
1.1136 raeburn 11998: push(@alluserslist,$user.'&user');
1.253 stredwic 11999: }
1.1318 droeschl 12000:
12001: if (!%listerror) {
12002: # no errors
12003: return (\@alluserslist);
12004: } elsif (scalar(keys(%servers)) == 1) {
12005: # one library server, one error
12006: my ($key) = keys(%listerror);
12007: return (\@alluserslist, $listerror{$key});
12008: } elsif ( grep { $_ eq 'con_lost' } values(%listerror) ) {
12009: # con_lost indicates that we might miss data from at least one
12010: # library server
12011: return (\@alluserslist, 'con_lost');
12012: } else {
12013: # multiple library servers and no con_lost -> data should be
12014: # complete.
12015: return (\@alluserslist);
12016: }
12017:
1.253 stredwic 12018: } else {
1.1136 raeburn 12019: return ([],'missing username');
1.253 stredwic 12020: }
1.955 raeburn 12021: } elsif(!defined($getpropath)) {
1.1136 raeburn 12022: my $path = $perlvar{'lonDocRoot'}.'/res/';
12023: my @all_domains = map { $path.$_.'/&domain'; } (sort(&all_domains()));
12024: return (\@all_domains);
1.955 raeburn 12025: } else {
1.1136 raeburn 12026: return ([],'missing domain');
1.275 stredwic 12027: }
12028: }
12029:
12030: # --------------------------------------------- GetFileTimestamp
12031: # This function utilizes dirlist and returns the date stamp for
12032: # when it was last modified. It will also return an error of -1
12033: # if an error occurs
12034:
12035: sub GetFileTimestamp {
1.955 raeburn 12036: my ($studentDomain,$studentName,$filename,$getuserdir)=@_;
1.807 albertel 12037: $studentDomain = &LONCAPA::clean_domain($studentDomain);
12038: $studentName = &LONCAPA::clean_username($studentName);
1.1136 raeburn 12039: my ($fileref,$error) = &dirlist($filename,$studentDomain,$studentName,
12040: undef,$getuserdir);
12041: if (($error eq 'empty') || ($error eq 'no_such_dir')) {
12042: return -1;
12043: }
12044: if (ref($fileref) eq 'ARRAY') {
12045: my @stats = split('&',$fileref->[0]);
1.375 matthew 12046: # @stats contains first the filename, then the stat output
12047: return $stats[10]; # so this is 10 instead of 9.
1.275 stredwic 12048: } else {
12049: return -1;
1.253 stredwic 12050: }
1.26 www 12051: }
12052:
1.712 albertel 12053: sub stat_file {
12054: my ($uri) = @_;
1.787 albertel 12055: $uri = &clutter_with_no_wrapper($uri);
1.722 albertel 12056:
1.955 raeburn 12057: my ($udom,$uname,$file);
1.712 albertel 12058: if ($uri =~ m-^/(uploaded|editupload)/-) {
12059: ($udom,$uname,$file) =
1.811 albertel 12060: ($uri =~ m-/(?:uploaded|editupload)/?($match_domain)/?($match_name)/?(.*)-);
1.712 albertel 12061: $file = 'userfiles/'.$file;
12062: }
12063: if ($uri =~ m-^/res/-) {
12064: ($udom,$uname) =
1.807 albertel 12065: ($uri =~ m-/(?:res)/?($match_domain)/?($match_username)/-);
1.712 albertel 12066: $file = $uri;
12067: }
12068:
12069: if (!$udom || !$uname || !$file) {
12070: # unable to handle the uri
12071: return ();
12072: }
1.956 raeburn 12073: my $getpropath;
12074: if ($file =~ /^userfiles\//) {
12075: $getpropath = 1;
12076: }
1.1136 raeburn 12077: my ($listref,$error) = &dirlist($file,$udom,$uname,$getpropath);
12078: if (($error eq 'empty') || ($error eq 'no_such_dir')) {
12079: return ();
12080: } else {
12081: if (ref($listref) eq 'ARRAY') {
12082: my @stats = split('&',$listref->[0]);
12083: shift(@stats); #filename is first
12084: return @stats;
12085: }
1.712 albertel 12086: }
12087: return ();
12088: }
12089:
1.1313 raeburn 12090: # --------------------------------------------------------- recursedirs
12091: # Recursive function to traverse either a specific user's Authoring Space
12092: # or corresponding Published Resource Space, and populate the hash ref:
12093: # $dirhashref with URLs of all directories, and if $filehashref hash
12094: # ref arg is provided, the URLs of any files, excluding versioned, .meta,
1.1503 raeburn 12095: # or .rights files in resource space, and .meta, .save, .log, .bak and
12096: # .rights files in Authoring Space.
1.1313 raeburn 12097: #
12098: # Inputs:
12099: #
12100: # $is_home - true if current server is home server for user's space
1.1503 raeburn 12101: # $recurse - if true will also traverse subdirectories recursively
12102: # $include - reference to hash containing allowed file extensions. If provided,
12103: # files which do not have a matching extension will be ignored.
12104: # $exclude - reference to hash containing excluded file extensions. If provided,
12105: # files which have a matching extension will be ignored.
12106: # $nonemptydir - if true, will only populate $fileshashref hash entry for a particular
12107: # directory with first file found (with acceptable extension).
1.1313 raeburn 12108: # $toppath - Top level directory (i.e., /res/$dom/$uname or /priv/$dom/$uname
12109: # $relpath - Current path (relative to top level).
12110: # $dirhashref - reference to hash to populate with URLs of directories (Required)
12111: # $filehashref - reference to hash to populate with URLs of files (Optional)
12112: #
12113: # Returns: nothing
12114: #
12115: # Side Effects: populates $dirhashref, and $filehashref (if provided).
12116: #
12117: # Currently used by interface/londocs.pm to create linked select boxes for
12118: # directory and filename to import a Course "Author" resource into a course, and
12119: # also to create linked select boxes for Authoring Space and Directory to choose
12120: # save location for creation of a new "standard" problem from the Course Editor.
12121: #
12122:
12123: sub recursedirs {
1.1503 raeburn 12124: my ($is_home,$recurse,$include,$exclude,$nonemptydir,$toppath,$relpath,$dirhashref,$filehashref) = @_;
1.1313 raeburn 12125: return unless (ref($dirhashref) eq 'HASH');
1.1503 raeburn 12126: my $docroot = $perlvar{'lonDocRoot'};
1.1313 raeburn 12127: my $currpath = $docroot.$toppath;
1.1503 raeburn 12128: if ($relpath ne '') {
1.1313 raeburn 12129: $currpath .= "/$relpath";
12130: }
1.1503 raeburn 12131: my ($savefile,$checkinc,$checkexc);
1.1313 raeburn 12132: if (ref($filehashref)) {
12133: $savefile = 1;
12134: }
1.1503 raeburn 12135: if (ref($include) eq 'HASH') {
12136: $checkinc = 1;
12137: }
12138: if (ref($exclude) eq 'HASH') {
12139: $checkexc = 1;
12140: }
1.1313 raeburn 12141: if ($is_home) {
12142: if (opendir(my $dirh,$currpath)) {
1.1503 raeburn 12143: my $filecount = 0;
1.1313 raeburn 12144: foreach my $item (sort { lc($a) cmp lc($b) } grep(!/^\.+$/,readdir($dirh))) {
12145: next if ($item eq '');
12146: if (-d "$currpath/$item") {
12147: my $newpath;
1.1503 raeburn 12148: if ($relpath ne '') {
1.1313 raeburn 12149: $newpath = "$relpath/$item";
12150: } else {
12151: $newpath = $item;
12152: }
12153: $dirhashref->{&Apache::lonlocal::js_escape($newpath)} = 1;
1.1503 raeburn 12154: if ($recurse) {
12155: &recursedirs($is_home,$recurse,$include,$exclude,$nonemptydir,$toppath,$newpath,$dirhashref,$filehashref);
12156: }
12157: } elsif (($savefile) || ($relpath eq '')) {
12158: next if ($nonemptydir && $filecount);
12159: if ($checkinc || $checkexc) {
12160: my ($extension) = ($item =~ /\.(\w+)$/);
12161: if ($checkinc) {
12162: next unless ($extension && $include->{$extension});
12163: }
12164: if ($checkexc) {
12165: next if ($extension && $exclude->{$extension});
12166: }
12167: }
12168: if (($relpath eq '') && (!exists($dirhashref->{'/'}))) {
12169: $dirhashref->{'/'} = 1;
12170: }
12171: if ($savefile) {
12172: if ($relpath eq '') {
12173: $filehashref->{'/'}{$item} = 1;
12174: } else {
1.1313 raeburn 12175: $filehashref->{&Apache::lonlocal::js_escape($relpath)}{$item} = 1;
12176: }
12177: }
1.1503 raeburn 12178: $filecount ++;
1.1313 raeburn 12179: }
12180: }
12181: closedir($dirh);
12182: }
12183: } else {
12184: my ($dirlistref,$listerror) =
12185: &dirlist($toppath.$relpath);
12186: my @dir_lines;
12187: my $dirptr=16384;
12188: if (ref($dirlistref) eq 'ARRAY') {
1.1503 raeburn 12189: my $filecount = 0;
1.1313 raeburn 12190: foreach my $dir_line (sort
12191: {
12192: my ($afile)=split('&',$a,2);
12193: my ($bfile)=split('&',$b,2);
12194: return (lc($afile) cmp lc($bfile));
12195: } (@{$dirlistref})) {
12196: my ($item,$dom,undef,$testdir,undef,undef,undef,undef,$size,undef,$mtime,undef,undef,undef,$obs,undef) =
12197: split(/\&/,$dir_line,16);
12198: $item =~ s/\s+$//;
12199: next if (($item =~ /^\.\.?$/) || ($obs));
12200: if ($dirptr&$testdir) {
12201: my $newpath;
12202: if ($relpath) {
12203: $newpath = "$relpath/$item";
12204: } else {
12205: $newpath = $item;
12206: }
12207: $dirhashref->{&Apache::lonlocal::js_escape($newpath)} = 1;
1.1503 raeburn 12208: if ($recurse) {
12209: &recursedirs($is_home,$recurse,$include,$exclude,$nonemptydir,$toppath,$newpath,$dirhashref,$filehashref);
12210: }
12211: } elsif (($savefile) || ($relpath eq '')) {
12212: next if ($nonemptydir && $filecount);
12213: if ($checkinc || $checkexc) {
12214: my $extension;
12215: if ($checkinc) {
12216: next unless ($extension && $include->{$extension});
12217: }
12218: if ($checkexc) {
12219: next if ($extension && $exclude->{$extension});
12220: }
12221: }
12222: if (($relpath eq '') && (!exists($dirhashref->{'/'}))) {
12223: $dirhashref->{'/'} = 1;
12224: }
12225: if ($savefile) {
12226: if ($relpath eq '') {
12227: $filehashref->{'/'}{$item} = 1;
12228: } else {
12229: $filehashref->{&Apache::lonlocal::js_escape($relpath)}{$item} = 1;
1.1313 raeburn 12230: }
12231: }
1.1503 raeburn 12232: $filecount ++;
1.1313 raeburn 12233: }
12234: }
12235: }
12236: }
12237: return;
12238: }
12239:
1.1503 raeburn 12240: sub priv_exclude {
12241: return {
12242: meta => 1,
12243: save => 1,
12244: log => 1,
12245: bak => 1,
12246: rights => 1,
12247: DS_Store => 1,
12248: };
12249: }
12250:
1.26 www 12251: # -------------------------------------------------------- Value of a Condition
12252:
1.713 albertel 12253: # gets the value of a specific preevaluated condition
12254: # stored in the string $env{user.state.<cid>}
12255: # or looks up a condition reference in the bighash and if if hasn't
12256: # already been evaluated recurses into docondval to get the value of
12257: # the condition, then memoizing it to
12258: # $env{user.state.<cid>.<condition>}
1.40 www 12259: sub directcondval {
12260: my $number=shift;
1.620 albertel 12261: if (!defined($env{'user.state.'.$env{'request.course.id'}})) {
1.555 albertel 12262: &Apache::lonuserstate::evalstate();
12263: }
1.713 albertel 12264: if (exists($env{'user.state.'.$env{'request.course.id'}.".$number"})) {
12265: return $env{'user.state.'.$env{'request.course.id'}.".$number"};
12266: } elsif ($number =~ /^_/) {
12267: my $sub_condition;
12268: if (tie(my %bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
12269: &GDBM_READER(),0640)) {
12270: $sub_condition=$bighash{'conditions'.$number};
12271: untie(%bighash);
12272: }
12273: my $value = &docondval($sub_condition);
1.949 raeburn 12274: &appenv({'user.state.'.$env{'request.course.id'}.".$number" => $value});
1.713 albertel 12275: return $value;
12276: }
1.620 albertel 12277: if ($env{'user.state.'.$env{'request.course.id'}}) {
12278: return substr($env{'user.state.'.$env{'request.course.id'}},$number,1);
1.40 www 12279: } else {
12280: return 2;
12281: }
12282: }
12283:
1.713 albertel 12284: # get the collection of conditions for this resource
1.26 www 12285: sub condval {
12286: my $condidx=shift;
1.54 www 12287: my $allpathcond='';
1.713 albertel 12288: foreach my $cond (split(/\|/,$condidx)) {
12289: if (defined($env{'acc.cond.'.$env{'request.course.id'}.'.'.$cond})) {
12290: $allpathcond.=
12291: '('.$env{'acc.cond.'.$env{'request.course.id'}.'.'.$cond}.')|';
12292: }
1.191 harris41 12293: }
1.54 www 12294: $allpathcond=~s/\|$//;
1.713 albertel 12295: return &docondval($allpathcond);
12296: }
12297:
12298: #evaluates an expression of conditions
12299: sub docondval {
12300: my ($allpathcond) = @_;
12301: my $result=0;
12302: if ($env{'request.course.id'}
12303: && defined($allpathcond)) {
12304: my $operand='|';
12305: my @stack;
12306: foreach my $chunk ($allpathcond=~/(\d+|_\d+\.\d+|\(|\)|\&|\|)/g) {
12307: if ($chunk eq '(') {
12308: push @stack,($operand,$result);
12309: } elsif ($chunk eq ')') {
12310: my $before=pop @stack;
12311: if (pop @stack eq '&') {
12312: $result=$result>$before?$before:$result;
12313: } else {
12314: $result=$result>$before?$result:$before;
12315: }
12316: } elsif (($chunk eq '&') || ($chunk eq '|')) {
12317: $operand=$chunk;
12318: } else {
12319: my $new=directcondval($chunk);
12320: if ($operand eq '&') {
12321: $result=$result>$new?$new:$result;
12322: } else {
12323: $result=$result>$new?$result:$new;
12324: }
12325: }
12326: }
1.26 www 12327: }
12328: return $result;
1.421 albertel 12329: }
12330:
12331: # ---------------------------------------------------- Devalidate courseresdata
12332:
12333: sub devalidatecourseresdata {
12334: my ($coursenum,$coursedomain)=@_;
12335: my $hashid=$coursenum.':'.$coursedomain;
1.599 albertel 12336: &devalidate_cache_new('courseres',$hashid);
1.28 www 12337: }
12338:
1.763 www 12339:
1.200 www 12340: # --------------------------------------------------- Course Resourcedata Query
1.878 foxr 12341: #
12342: # Parameters:
12343: # $coursenum - Number of the course.
12344: # $coursedomain - Domain at which the course was created.
12345: # Returns:
12346: # A hash of the course parameters along (I think) with timestamps
12347: # and version info.
1.877 foxr 12348:
1.624 albertel 12349: sub get_courseresdata {
12350: my ($coursenum,$coursedomain)=@_;
1.200 www 12351: my $coursehom=&homeserver($coursenum,$coursedomain);
12352: my $hashid=$coursenum.':'.$coursedomain;
1.599 albertel 12353: my ($result,$cached)=&is_cached_new('courseres',$hashid);
1.624 albertel 12354: my %dumpreply;
1.417 albertel 12355: unless (defined($cached)) {
1.624 albertel 12356: %dumpreply=&dump('resourcedata',$coursedomain,$coursenum);
1.417 albertel 12357: $result=\%dumpreply;
1.251 albertel 12358: my ($tmp) = keys(%dumpreply);
12359: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
1.599 albertel 12360: &do_cache_new('courseres',$hashid,$result,600);
1.306 albertel 12361: } elsif ($tmp =~ /^(con_lost|no_such_host)/) {
12362: return $tmp;
1.416 albertel 12363: } elsif ($tmp =~ /^(error)/) {
1.417 albertel 12364: $result=undef;
1.599 albertel 12365: &do_cache_new('courseres',$hashid,$result,600);
1.250 albertel 12366: }
12367: }
1.624 albertel 12368: return $result;
12369: }
12370:
1.633 albertel 12371: sub devalidateuserresdata {
12372: my ($uname,$udom)=@_;
12373: my $hashid="$udom:$uname";
12374: &devalidate_cache_new('userres',$hashid);
12375: }
12376:
1.624 albertel 12377: sub get_userresdata {
12378: my ($uname,$udom)=@_;
12379: #most student don\'t have any data set, check if there is some data
12380: if (&EXT_cache_status($udom,$uname)) { return undef; }
12381:
12382: my $hashid="$udom:$uname";
12383: my ($result,$cached)=&is_cached_new('userres',$hashid);
12384: if (!defined($cached)) {
12385: my %resourcedata=&dump('resourcedata',$udom,$uname);
12386: $result=\%resourcedata;
12387: &do_cache_new('userres',$hashid,$result,600);
12388: }
12389: my ($tmp)=keys(%$result);
12390: if (($tmp!~/^error\:/) && ($tmp!~/^con_lost/)) {
12391: return $result;
12392: }
12393: #error 2 occurs when the .db doesn't exist
12394: if ($tmp!~/error: 2 /) {
1.1294 raeburn 12395: if ((!defined($cached)) || ($tmp ne 'con_lost')) {
12396: &logthis("<font color=\"blue\">WARNING:".
12397: " Trying to get resource data for ".
12398: $uname." at ".$udom.": ".
12399: $tmp."</font>");
12400: }
1.624 albertel 12401: } elsif ($tmp=~/error: 2 /) {
1.633 albertel 12402: #&EXT_cache_set($udom,$uname);
12403: &do_cache_new('userres',$hashid,undef,600);
1.636 albertel 12404: undef($tmp); # not really an error so don't send it back
1.624 albertel 12405: }
12406: return $tmp;
12407: }
1.879 foxr 12408: #----------------------------------------------- resdata - return resource data
12409: # Purpose:
12410: # Return resource data for either users or for a course.
12411: # Parameters:
12412: # $name - Course/user name.
12413: # $domain - Name of the domain the user/course is registered on.
1.1311 raeburn 12414: # $type - Type of thing $name is (must be 'course' or 'user')
1.1301 raeburn 12415: # $mapp - decluttered URL of enclosing map
12416: # $recursed - Ref to scalar -- set to 1, if nested maps have been recursed.
12417: # $recurseup - Ref to array of map URLs, starting with map containing
12418: # $mapp up through hierarchy of nested maps to top level map.
12419: # $courseid - CourseID (first part of param identifier).
12420: # $modifier - Middle part of param identifier.
12421: # $what - Last part of param identifier.
1.879 foxr 12422: # @which - Array of names of resources desired.
12423: # Returns:
12424: # The value of the first reasource in @which that is found in the
12425: # resource hash.
12426: # Exceptional Conditions:
12427: # If the $type passed in is not valid (not the string 'course' or
12428: # 'user', an undefined reference is returned.
12429: # If none of the resources are found, an undef is returned
1.624 albertel 12430: sub resdata {
1.1301 raeburn 12431: my ($name,$domain,$type,$mapp,$recursed,$recurseup,$courseid,
12432: $modifier,$what,@which)=@_;
1.624 albertel 12433: my $result;
12434: if ($type eq 'course') {
12435: $result=&get_courseresdata($name,$domain);
12436: } elsif ($type eq 'user') {
12437: $result=&get_userresdata($name,$domain);
12438: }
12439: if (!ref($result)) { return $result; }
1.251 albertel 12440: foreach my $item (@which) {
1.1301 raeburn 12441: if ($item->[1] eq 'course') {
12442: if ((ref($recurseup) eq 'ARRAY') && (ref($recursed) eq 'SCALAR')) {
12443: unless ($$recursed) {
1.1302 raeburn 12444: @{$recurseup} = &get_map_hierarchy($mapp,$courseid);
1.1301 raeburn 12445: $$recursed = 1;
12446: }
12447: foreach my $item (@${recurseup}) {
12448: my $norecursechk=$courseid.$modifier.$item.'___(all).'.$what;
12449: last if (defined($result->{$norecursechk}));
12450: my $recursechk=$courseid.$modifier.$item.'___(rec).'.$what;
12451: if (defined($result->{$recursechk})) { return [$result->{$recursechk},'map']; }
12452: }
12453: }
12454: }
12455: if (defined($result->{$item->[0]})) {
1.927 albertel 12456: return [$result->{$item->[0]},$item->[1]];
1.251 albertel 12457: }
1.250 albertel 12458: }
1.291 albertel 12459: return undef;
1.200 www 12460: }
12461:
1.1360 raeburn 12462: sub get_domain_lti {
12463: my ($cdom,$context) = @_;
1.1483 raeburn 12464: my ($name,$cachename,%lti);
1.1360 raeburn 12465: if ($context eq 'consumer') {
12466: $name = 'ltitools';
12467: } elsif ($context eq 'provider') {
12468: $name = 'lti';
1.1483 raeburn 12469: } elsif ($context eq 'linkprot') {
12470: $name = 'ltisec';
1.1360 raeburn 12471: } else {
12472: return %lti;
12473: }
1.1483 raeburn 12474:
12475: if ($context eq 'linkprot') {
12476: $cachename = $context;
12477: } else {
12478: $cachename = $name;
12479: }
12480:
12481: my ($result,$cached)=&is_cached_new($cachename,$cdom);
1.1298 raeburn 12482: if (defined($cached)) {
12483: if (ref($result) eq 'HASH') {
1.1360 raeburn 12484: %lti = %{$result};
1.1298 raeburn 12485: }
12486: } else {
1.1360 raeburn 12487: my %domconfig = &get_dom('configuration',[$name],$cdom);
12488: if (ref($domconfig{$name}) eq 'HASH') {
1.1483 raeburn 12489: if ($context eq 'linkprot') {
12490: if (ref($domconfig{$name}{'linkprot'}) eq 'HASH') {
12491: %lti = %{$domconfig{$name}{'linkprot'}};
12492: }
12493: } else {
12494: %lti = %{$domconfig{$name}};
12495: }
12496: if (($context eq 'consumer') && (keys(%lti))) {
12497: my %encdomconfig = &get_dom('encconfig',[$name],$cdom,undef,1);
12498: if (ref($encdomconfig{$name}) eq 'HASH') {
12499: foreach my $id (keys(%lti)) {
12500: if (ref($encdomconfig{$name}{$id}) eq 'HASH') {
12501: foreach my $item ('key','secret') {
12502: $lti{$id}{$item} = $encdomconfig{$name}{$id}{$item};
12503: }
1.1344 raeburn 12504: }
12505: }
12506: }
12507: }
1.1298 raeburn 12508: }
12509: my $cachetime = 24*60*60;
1.1483 raeburn 12510: &do_cache_new($cachename,$cdom,\%lti,$cachetime);
1.1298 raeburn 12511: }
1.1360 raeburn 12512: return %lti;
1.1298 raeburn 12513: }
12514:
1.1463 raeburn 12515: sub get_course_lti {
12516: my ($cnum,$cdom) = @_;
12517: my $hashid=$cdom.'_'.$cnum;
12518: my %courselti;
12519: my ($result,$cached)=&is_cached_new('courselti',$hashid);
12520: if (defined($cached)) {
12521: if (ref($result) eq 'HASH') {
12522: %courselti = %{$result};
12523: }
12524: } else {
12525: %courselti = &dump('lti',$cdom,$cnum,undef,undef,undef,1);
12526: my $cachetime = 24*60*60;
12527: &do_cache_new('courselti',$hashid,\%courselti,$cachetime);
12528: }
12529: return %courselti;
12530: }
12531:
1.1479 raeburn 12532: sub courselti_itemid {
12533: my ($cnum,$cdom,$url,$method,$params,$context) = @_;
12534: my ($chome,$itemid);
12535: $chome = &homeserver($cnum,$cdom);
12536: return if ($chome eq 'no_host');
12537: if (ref($params) eq 'HASH') {
12538: my $rep;
12539: if (grep { $_ eq $chome } current_machine_ids()) {
12540: $rep = LONCAPA::Lond::crslti_itemid($cdom,$cnum,$url,$method,$params,$perlvar{'lonVersion'});
12541: } else {
12542: my $escurl = &escape($url);
12543: my $escmethod = &escape($method);
12544: my $items = &freeze_escape($params);
12545: $rep = &reply("encrypt:lti:$cdom:$cnum:$context:$escurl:$escmethod:$items",$chome);
12546: }
12547: unless (($rep=~/^(refused|rejected|error)/) || ($rep eq 'con_lost') ||
12548: ($rep eq 'unknown_cmd')) {
12549: $itemid = $rep;
12550: }
12551: }
12552: return $itemid;
12553: }
12554:
12555: sub domainlti_itemid {
12556: my ($cdom,$url,$method,$params,$context) = @_;
12557: my ($primary_id,$itemid);
12558: $primary_id = &domain($cdom,'primary');
12559: return if ($primary_id eq '');
12560: if (ref($params) eq 'HASH') {
12561: my $rep;
12562: if (grep { $_ eq $primary_id } current_machine_ids()) {
12563: $rep = LONCAPA::Lond::domlti_itemid($cdom,$context,$url,$method,$params,$perlvar{'lonVersion'});
12564: } else {
12565: my $cnum = '';
12566: my $escurl = &escape($url);
12567: my $escmethod = &escape($method);
12568: my $items = &freeze_escape($params);
12569: $rep = &reply("encrypt:lti:$cdom:$cnum:$context:$escurl:$escmethod:$items",$primary_id);
12570: }
12571: unless (($rep=~/^(refused|rejected|error)/) || ($rep eq 'con_lost') ||
12572: ($rep eq 'unknown_cmd')) {
12573: $itemid = $rep;
12574: }
12575: }
12576: return $itemid;
12577: }
12578:
1.1496 raeburn 12579: sub count_supptools {
12580: my ($cnum,$cdom,$ignorecache,$reload)=@_;
12581: my $hashid=$cnum.':'.$cdom;
12582: my ($numexttools,$cached);
12583: unless ($ignorecache) {
12584: ($numexttools,$cached) = &is_cached_new('supptools',$hashid);
12585: }
12586: unless (defined($cached)) {
12587: my $chome=&homeserver($cnum,$cdom);
12588: $numexttools = 0;
12589: unless ($chome eq 'no_host') {
1.1500 raeburn 12590: my ($supplemental) = &Apache::loncommon::get_supplemental($cnum,$cdom,$reload);
1.1496 raeburn 12591: if (ref($supplemental) eq 'HASH') {
12592: if ((ref($supplemental->{'ids'}) eq 'HASH') && (ref($supplemental->{'hidden'}) eq 'HASH')) {
12593: foreach my $key (keys(%{$supplemental->{'ids'}})) {
12594: if ($key =~ m{^/adm/$cdom/$cnum/\d+/ext\.tool$}) {
12595: $numexttools ++;
12596: }
12597: }
12598: }
12599: }
12600: }
12601: &do_cache_new('supptools',$hashid,$numexttools,600);
12602: }
12603: return $numexttools;
12604: }
12605:
12606: sub has_unhidden_suppfiles {
1.1498 raeburn 12607: my ($cnum,$cdom,$ignorecache,$possdel)=@_;
1.1236 raeburn 12608: my $hashid=$cnum.':'.$cdom;
1.1496 raeburn 12609: my ($showsupp,$cached);
1.1236 raeburn 12610: unless ($ignorecache) {
1.1496 raeburn 12611: ($showsupp,$cached) = &is_cached_new('showsupp',$hashid);
1.1236 raeburn 12612: }
12613: unless (defined($cached)) {
12614: my $chome=&homeserver($cnum,$cdom);
12615: unless ($chome eq 'no_host') {
1.1500 raeburn 12616: my ($supplemental) = &Apache::loncommon::get_supplemental($cnum,$cdom,$ignorecache,$possdel);
1.1496 raeburn 12617: if (ref($supplemental) eq 'HASH') {
12618: if ((ref($supplemental->{'ids'}) eq 'HASH') && (ref($supplemental->{'hidden'}) eq 'HASH')) {
12619: foreach my $key (keys(%{$supplemental->{'ids'}})) {
12620: next if ($key =~ /\.sequence$/);
12621: if (ref($supplemental->{'ids'}->{$key}) eq 'ARRAY') {
12622: foreach my $id (@{$supplemental->{'ids'}->{$key}}) {
12623: unless ($supplemental->{'hidden'}->{$id}) {
12624: $showsupp = 1;
12625: last;
12626: }
12627: }
12628: }
12629: last if ($showsupp);
12630: }
12631: }
12632: }
1.1236 raeburn 12633: }
1.1496 raeburn 12634: &do_cache_new('showsupp',$hashid,$showsupp,600);
1.1236 raeburn 12635: }
1.1496 raeburn 12636: return $showsupp;
12637: }
12638:
1.379 matthew 12639: #
12640: # EXT resource caching routines
12641: #
12642:
1.1302 raeburn 12643: {
12644: # Cache (5 seconds) of map hierarchy for speedup of navmaps display
12645: #
12646: # The course for which we cache
12647: my $cachedmapkey='';
12648: # The cached recursive maps for this course
12649: my %cachedmaps=();
12650: # When this was last done
12651: my $cachedmaptime='';
12652:
1.379 matthew 12653: sub clear_EXT_cache_status {
1.383 albertel 12654: &delenv('cache.EXT.');
1.379 matthew 12655: }
12656:
12657: sub EXT_cache_status {
12658: my ($target_domain,$target_user) = @_;
1.383 albertel 12659: my $cachename = 'cache.EXT.'.$target_user.'.'.$target_domain;
1.620 albertel 12660: if (exists($env{$cachename}) && ($env{$cachename}+600) > time) {
1.379 matthew 12661: # We know already the user has no data
12662: return 1;
12663: } else {
12664: return 0;
12665: }
12666: }
12667:
12668: sub EXT_cache_set {
12669: my ($target_domain,$target_user) = @_;
1.383 albertel 12670: my $cachename = 'cache.EXT.'.$target_user.'.'.$target_domain;
1.949 raeburn 12671: #&appenv({$cachename => time});
1.379 matthew 12672: }
12673:
1.28 www 12674: # --------------------------------------------------------- Value of a Variable
1.58 www 12675: sub EXT {
1.715 albertel 12676:
1.1461 raeburn 12677: my ($varname,$symbparm,$udom,$uname,$usection,$recurse,$cid,$recurseupref)=@_;
1.68 www 12678: unless ($varname) { return ''; }
1.218 albertel 12679: #get real user name/domain, courseid and symb
12680: my $courseid;
1.359 albertel 12681: my $publicuser;
1.427 www 12682: if ($symbparm) {
12683: $symbparm=&get_symb_from_alias($symbparm);
12684: }
1.218 albertel 12685: if (!($uname && $udom)) {
1.790 albertel 12686: (my $cursymb,$courseid,$udom,$uname,$publicuser)= &whichuser($symbparm);
1.218 albertel 12687: if (!$symbparm) { $symbparm=$cursymb; }
12688: } else {
1.620 albertel 12689: $courseid=$env{'request.course.id'};
1.218 albertel 12690: }
1.48 www 12691: my ($realm,$space,$qualifier,@therest)=split(/\./,$varname);
12692: my $rest;
1.320 albertel 12693: if (defined($therest[0])) {
1.48 www 12694: $rest=join('.',@therest);
12695: } else {
12696: $rest='';
12697: }
1.320 albertel 12698:
1.57 www 12699: my $qualifierrest=$qualifier;
12700: if ($rest) { $qualifierrest.='.'.$rest; }
12701: my $spacequalifierrest=$space;
12702: if ($qualifierrest) { $spacequalifierrest.='.'.$qualifierrest; }
1.28 www 12703: if ($realm eq 'user') {
1.48 www 12704: # --------------------------------------------------------------- user.resource
12705: if ($space eq 'resource') {
1.651 albertel 12706: if ( (defined($Apache::lonhomework::parsing_a_problem)
12707: || defined($Apache::lonhomework::parsing_a_task))
12708: &&
1.1469 raeburn 12709: ($symbparm eq &symbread()) ) {
1.744 albertel 12710: # if we are in the middle of processing the resource the
12711: # get the value we are planning on committing
12712: if (defined($Apache::lonhomework::results{$qualifierrest})) {
12713: return $Apache::lonhomework::results{$qualifierrest};
12714: } else {
12715: return $Apache::lonhomework::history{$qualifierrest};
12716: }
1.335 albertel 12717: } else {
1.359 albertel 12718: my %restored;
1.620 albertel 12719: if ($publicuser || $env{'request.state'} eq 'construct') {
1.359 albertel 12720: %restored=&tmprestore($symbparm,$courseid,$udom,$uname);
12721: } else {
12722: %restored=&restore($symbparm,$courseid,$udom,$uname);
12723: }
1.335 albertel 12724: return $restored{$qualifierrest};
12725: }
1.48 www 12726: # ----------------------------------------------------------------- user.access
12727: } elsif ($space eq 'access') {
1.218 albertel 12728: # FIXME - not supporting calls for a specific user
1.48 www 12729: return &allowed($qualifier,$rest);
12730: # ------------------------------------------ user.preferences, user.environment
12731: } elsif (($space eq 'preferences') || ($space eq 'environment')) {
1.620 albertel 12732: if (($uname eq $env{'user.name'}) &&
12733: ($udom eq $env{'user.domain'})) {
12734: return $env{join('.',('environment',$qualifierrest))};
1.218 albertel 12735: } else {
1.359 albertel 12736: my %returnhash;
12737: if (!$publicuser) {
12738: %returnhash=&userenvironment($udom,$uname,
12739: $qualifierrest);
12740: }
1.218 albertel 12741: return $returnhash{$qualifierrest};
12742: }
1.48 www 12743: # ----------------------------------------------------------------- user.course
12744: } elsif ($space eq 'course') {
1.218 albertel 12745: # FIXME - not supporting calls for a specific user
1.620 albertel 12746: return $env{join('.',('request.course',$qualifier))};
1.48 www 12747: # ------------------------------------------------------------------- user.role
12748: } elsif ($space eq 'role') {
1.218 albertel 12749: # FIXME - not supporting calls for a specific user
1.620 albertel 12750: my ($role,$where)=split(/\./,$env{'request.role'});
1.48 www 12751: if ($qualifier eq 'value') {
12752: return $role;
12753: } elsif ($qualifier eq 'extent') {
12754: return $where;
12755: }
12756: # ----------------------------------------------------------------- user.domain
12757: } elsif ($space eq 'domain') {
1.218 albertel 12758: return $udom;
1.48 www 12759: # ------------------------------------------------------------------- user.name
12760: } elsif ($space eq 'name') {
1.218 albertel 12761: return $uname;
1.48 www 12762: # ---------------------------------------------------- Any other user namespace
1.29 www 12763: } else {
1.359 albertel 12764: my %reply;
12765: if (!$publicuser) {
12766: %reply=&get($space,[$qualifierrest],$udom,$uname);
12767: }
12768: return $reply{$qualifierrest};
1.48 www 12769: }
1.236 www 12770: } elsif ($realm eq 'query') {
12771: # ---------------------------------------------- pull stuff out of query string
1.384 albertel 12772: &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},
12773: [$spacequalifierrest]);
1.620 albertel 12774: return $env{'form.'.$spacequalifierrest};
1.236 www 12775: } elsif ($realm eq 'request') {
1.48 www 12776: # ------------------------------------------------------------- request.browser
12777: if ($space eq 'browser') {
1.1145 bisitz 12778: return $env{'browser.'.$qualifier};
1.57 www 12779: # ------------------------------------------------------------ request.filename
12780: } else {
1.620 albertel 12781: return $env{'request.'.$spacequalifierrest};
1.29 www 12782: }
1.28 www 12783: } elsif ($realm eq 'course') {
1.48 www 12784: # ---------------------------------------------------------- course.description
1.620 albertel 12785: return $env{'course.'.$courseid.'.'.$spacequalifierrest};
1.57 www 12786: } elsif ($realm eq 'resource') {
1.165 www 12787:
1.620 albertel 12788: if (defined($courseid) && $courseid eq $env{'request.course.id'}) {
1.539 albertel 12789: if (!$symbparm) { $symbparm=&symbread(); }
12790: }
1.693 albertel 12791:
1.1232 raeburn 12792: if ($qualifier eq '') {
12793: if ($space eq 'title') {
12794: if (!$symbparm) { $symbparm = $env{'request.filename'}; }
12795: return &gettitle($symbparm);
12796: }
1.693 albertel 12797:
1.1232 raeburn 12798: if ($space eq 'map') {
12799: my ($map) = &decode_symb($symbparm);
12800: return &symbread($map);
12801: }
12802: if ($space eq 'maptitle') {
12803: my ($map) = &decode_symb($symbparm);
12804: return &gettitle($map);
12805: }
12806: if ($space eq 'filename') {
12807: if ($symbparm) {
12808: return &clutter((&decode_symb($symbparm))[2]);
12809: }
12810: return &hreflocation('',$env{'request.filename'});
1.905 albertel 12811: }
1.1232 raeburn 12812:
1.1233 raeburn 12813: if ((defined($courseid)) && ($courseid eq $env{'request.course.id'}) && $symbparm) {
12814: if ($space eq 'visibleparts') {
12815: my $navmap = Apache::lonnavmaps::navmap->new();
12816: my $item;
12817: if (ref($navmap)) {
12818: my $res = $navmap->getBySymb($symbparm);
12819: my $parts = $res->parts();
12820: if (ref($parts) eq 'ARRAY') {
12821: $item = join(',',@{$parts});
12822: }
12823: undef($navmap);
1.1232 raeburn 12824: }
1.1233 raeburn 12825: return $item;
1.1232 raeburn 12826: }
12827: }
12828: }
1.693 albertel 12829:
1.1301 raeburn 12830: my ($section, $group, @groups, @recurseup, $recursed);
1.1461 raeburn 12831: if (ref($recurseupref) eq 'ARRAY') {
12832: @recurseup = @{$recurseupref};
12833: $recursed = 1;
12834: }
1.1301 raeburn 12835: my ($courselevelm,$courseleveli,$courselevel,$mapp);
1.1228 raeburn 12836: if (($courseid eq '') && ($cid)) {
12837: $courseid = $cid;
12838: }
12839: if (($symbparm && $courseid) &&
12840: (($courseid eq $env{'request.course.id'}) || ($courseid eq $cid))) {
1.165 www 12841:
1.218 albertel 12842: #print '<br>'.$space.' - '.$qualifier.' - '.$spacequalifierrest;
1.165 www 12843:
1.60 www 12844: # ----------------------------------------------------- Cascading lookup scheme
1.218 albertel 12845: my $symbp=$symbparm;
1.1301 raeburn 12846: $mapp=&deversion((&decode_symb($symbp))[0]);
1.218 albertel 12847: my $symbparm=$symbp.'.'.$spacequalifierrest;
1.1301 raeburn 12848: my $recurseparm=$mapp.'___(rec).'.$spacequalifierrest;
1.218 albertel 12849: my $mapparm=$mapp.'___(all).'.$spacequalifierrest;
1.620 albertel 12850: if (($env{'user.name'} eq $uname) &&
12851: ($env{'user.domain'} eq $udom)) {
12852: $section=$env{'request.course.sec'};
1.733 raeburn 12853: @groups = split(/:/,$env{'request.course.groups'});
12854: @groups=&sort_course_groups($courseid,@groups);
1.218 albertel 12855: } else {
1.539 albertel 12856: if (! defined($usection)) {
1.551 albertel 12857: $section=&getsection($udom,$uname,$courseid);
1.539 albertel 12858: } else {
12859: $section = $usection;
12860: }
1.733 raeburn 12861: @groups = &get_users_groups($udom,$uname,$courseid);
1.218 albertel 12862: }
12863:
12864: my $seclevel=$courseid.'.['.$section.'].'.$spacequalifierrest;
12865: my $seclevelr=$courseid.'.['.$section.'].'.$symbparm;
1.1301 raeburn 12866: my $secleveli=$courseid.'.['.$section.'].'.$recurseparm;
1.218 albertel 12867: my $seclevelm=$courseid.'.['.$section.'].'.$mapparm;
12868:
1.593 albertel 12869: $courselevel=$courseid.'.'.$spacequalifierrest;
1.218 albertel 12870: my $courselevelr=$courseid.'.'.$symbparm;
1.1301 raeburn 12871: $courseleveli=$courseid.'.'.$recurseparm;
1.593 albertel 12872: $courselevelm=$courseid.'.'.$mapparm;
1.69 www 12873:
1.60 www 12874: # ----------------------------------------------------------- first, check user
1.624 albertel 12875:
1.1301 raeburn 12876: my $userreply=&resdata($uname,$udom,'user',$mapp,\$recursed,
12877: \@recurseup,$courseid,'.',$spacequalifierrest,
1.927 albertel 12878: ([$courselevelr,'resource'],
12879: [$courselevelm,'map' ],
1.1301 raeburn 12880: [$courseleveli,'map' ],
1.927 albertel 12881: [$courselevel, 'course' ]));
1.931 albertel 12882: if (defined($userreply)) { return &get_reply($userreply); }
1.95 www 12883:
1.594 albertel 12884: # ------------------------------------------------ second, check some of course
1.684 raeburn 12885: my $coursereply;
1.691 raeburn 12886: if (@groups > 0) {
12887: $coursereply = &check_group_parms($courseid,\@groups,$symbparm,
1.1301 raeburn 12888: $recurseparm,$mapparm,$spacequalifierrest,
12889: $mapp,\$recursed,\@recurseup);
12890: if (defined($coursereply)) { return &get_reply($coursereply); }
1.684 raeburn 12891: }
1.96 www 12892:
1.684 raeburn 12893: $coursereply=&resdata($env{'course.'.$courseid.'.num'},
1.927 albertel 12894: $env{'course.'.$courseid.'.domain'},
1.1301 raeburn 12895: 'course',$mapp,\$recursed,\@recurseup,
12896: $courseid,'.['.$section.'].',$spacequalifierrest,
1.927 albertel 12897: ([$seclevelr, 'resource'],
12898: [$seclevelm, 'map' ],
1.1301 raeburn 12899: [$secleveli, 'map' ],
1.927 albertel 12900: [$seclevel, 'course' ],
12901: [$courselevelr,'resource']));
12902: if (defined($coursereply)) { return &get_reply($coursereply); }
1.200 www 12903:
1.60 www 12904: # ------------------------------------------------------ third, check map parms
1.218 albertel 12905: my %parmhash=();
12906: my $thisparm='';
12907: if (tie(%parmhash,'GDBM_File',
1.620 albertel 12908: $env{'request.course.fn'}.'_parms.db',
1.256 albertel 12909: &GDBM_READER(),0640)) {
1.218 albertel 12910: $thisparm=$parmhash{$symbparm};
12911: untie(%parmhash);
12912: }
1.927 albertel 12913: if ($thisparm) { return &get_reply([$thisparm,'resource']); }
1.218 albertel 12914: }
1.594 albertel 12915: # ------------------------------------------ fourth, look in resource metadata
1.1301 raeburn 12916:
12917: my $what = $spacequalifierrest;
12918: $what=~s/\./\_/;
1.282 albertel 12919: my $filename;
12920: if (!$symbparm) { $symbparm=&symbread(); }
12921: if ($symbparm) {
1.409 www 12922: $filename=(&decode_symb($symbparm))[2];
1.282 albertel 12923: } else {
1.620 albertel 12924: $filename=$env{'request.filename'};
1.282 albertel 12925: }
1.1362 raeburn 12926: my $toolsymb;
12927: if (($filename =~ /ext\.tool$/) && ($what ne '0_gradable')) {
12928: $toolsymb = $symbparm;
12929: }
12930: my $metadata=&metadata($filename,$what,$toolsymb);
1.927 albertel 12931: if (defined($metadata)) { return &get_reply([$metadata,'resource']); }
1.1362 raeburn 12932: $metadata=&metadata($filename,'parameter_'.$what,$toolsymb);
1.927 albertel 12933: if (defined($metadata)) { return &get_reply([$metadata,'resource']); }
1.142 www 12934:
1.1301 raeburn 12935: # ----------------------------------------------- fifth, look in rest of course
1.593 albertel 12936: if ($symbparm && defined($courseid) &&
1.620 albertel 12937: $courseid eq $env{'request.course.id'}) {
1.624 albertel 12938: my $coursereply=&resdata($env{'course.'.$courseid.'.num'},
12939: $env{'course.'.$courseid.'.domain'},
1.1301 raeburn 12940: 'course',$mapp,\$recursed,\@recurseup,
12941: $courseid,'.',$spacequalifierrest,
1.927 albertel 12942: ([$courselevelm,'map' ],
1.1301 raeburn 12943: [$courseleveli,'map' ],
1.927 albertel 12944: [$courselevel, 'course']));
12945: if (defined($coursereply)) { return &get_reply($coursereply); }
1.593 albertel 12946: }
1.145 www 12947: # ------------------------------------------------------------------ Cascade up
1.218 albertel 12948: unless ($space eq '0') {
1.336 albertel 12949: my @parts=split(/_/,$space);
12950: my $id=pop(@parts);
12951: my $part=join('_',@parts);
12952: if ($part eq '') { $part='0'; }
1.927 albertel 12953: my @partgeneral=&EXT('resource.'.$part.'.'.$qualifierrest,
1.395 albertel 12954: $symbparm,$udom,$uname,$section,1);
1.938 raeburn 12955: if (defined($partgeneral[0])) { return &get_reply(\@partgeneral); }
1.218 albertel 12956: }
1.395 albertel 12957: if ($recurse) { return undef; }
1.1362 raeburn 12958: my $pack_def=&packages_tab_default($filename,$varname,$toolsymb);
1.927 albertel 12959: if (defined($pack_def)) { return &get_reply([$pack_def,'resource']); }
1.48 www 12960: # ---------------------------------------------------- Any other user namespace
12961: } elsif ($realm eq 'environment') {
12962: # ----------------------------------------------------------------- environment
1.620 albertel 12963: if (($uname eq $env{'user.name'})&&($udom eq $env{'user.domain'})) {
12964: return $env{'environment.'.$spacequalifierrest};
1.219 albertel 12965: } else {
1.770 albertel 12966: if ($uname eq 'anonymous' && $udom eq '') {
12967: return '';
12968: }
1.219 albertel 12969: my %returnhash=&userenvironment($udom,$uname,
12970: $spacequalifierrest);
12971: return $returnhash{$spacequalifierrest};
12972: }
1.28 www 12973: } elsif ($realm eq 'system') {
1.48 www 12974: # ----------------------------------------------------------------- system.time
12975: if ($space eq 'time') {
12976: return time;
12977: }
1.696 albertel 12978: } elsif ($realm eq 'server') {
12979: # ----------------------------------------------------------------- system.time
12980: if ($space eq 'name') {
12981: return $ENV{'SERVER_NAME'};
12982: }
1.1415 raeburn 12983: } elsif ($realm eq 'client') {
12984: if ($space eq 'remote_addr') {
1.1441 raeburn 12985: return &get_requestor_ip();
1.1415 raeburn 12986: }
1.28 www 12987: }
1.48 www 12988: return '';
1.61 www 12989: }
12990:
1.927 albertel 12991: sub get_reply {
12992: my ($reply_value) = @_;
1.940 raeburn 12993: if (ref($reply_value) eq 'ARRAY') {
12994: if (wantarray) {
12995: return @$reply_value;
12996: }
12997: return $reply_value->[0];
12998: } else {
12999: return $reply_value;
1.927 albertel 13000: }
13001: }
13002:
1.691 raeburn 13003: sub check_group_parms {
1.1301 raeburn 13004: my ($courseid,$groups,$symbparm,$recurseparm,$mapparm,$what,$mapp,
13005: $recursed,$recurseupref) = @_;
13006: my @levels = ([$symbparm,'resource'],[$mapparm,'map'],[$recurseparm,'map'],
13007: [$what,'course']);
13008: my $coursereply;
1.691 raeburn 13009: foreach my $group (@{$groups}) {
1.1301 raeburn 13010: my @groupitems = ();
1.691 raeburn 13011: foreach my $level (@levels) {
1.927 albertel 13012: my $item = $courseid.'.['.$group.'].'.$level->[0];
13013: push(@groupitems,[$item,$level->[1]]);
1.691 raeburn 13014: }
1.1301 raeburn 13015: my $coursereply = &resdata($env{'course.'.$courseid.'.num'},
13016: $env{'course.'.$courseid.'.domain'},
13017: 'course',$mapp,$recursed,$recurseupref,
13018: $courseid,'.['.$group.'].',$what,
13019: @groupitems);
13020: last if (defined($coursereply));
1.691 raeburn 13021: }
13022: return $coursereply;
13023: }
13024:
1.1301 raeburn 13025: sub get_map_hierarchy {
1.1302 raeburn 13026: my ($mapname,$courseid) = @_;
13027: my @recurseup = ();
1.1301 raeburn 13028: if ($mapname) {
1.1302 raeburn 13029: if (($cachedmapkey eq $courseid) &&
13030: (abs($cachedmaptime-time)<5)) {
13031: if (ref($cachedmaps{$mapname}) eq 'ARRAY') {
13032: return @{$cachedmaps{$mapname}};
13033: }
13034: }
1.1301 raeburn 13035: my $navmap = Apache::lonnavmaps::navmap->new();
13036: if (ref($navmap)) {
13037: @recurseup = $navmap->recurseup_maps($mapname);
13038: undef($navmap);
1.1302 raeburn 13039: $cachedmaps{$mapname} = \@recurseup;
13040: $cachedmaptime=time;
13041: $cachedmapkey=$courseid;
1.1301 raeburn 13042: }
13043: }
13044: return @recurseup;
13045: }
13046:
1.1302 raeburn 13047: }
13048:
1.691 raeburn 13049: sub sort_course_groups { # Sort groups based on defined rankings. Default is sort().
1.733 raeburn 13050: my ($courseid,@groups) = @_;
13051: @groups = sort(@groups);
1.691 raeburn 13052: return @groups;
13053: }
13054:
1.395 albertel 13055: sub packages_tab_default {
1.1362 raeburn 13056: my ($uri,$varname,$toolsymb)=@_;
1.395 albertel 13057: my (undef,$part,$name)=split(/\./,$varname);
1.738 albertel 13058:
13059: my (@extension,@specifics,$do_default);
1.1362 raeburn 13060: foreach my $package (split(/,/,&metadata($uri,'packages',$toolsymb))) {
1.395 albertel 13061: my ($pack_type,$pack_part)=split(/_/,$package,2);
1.738 albertel 13062: if ($pack_type eq 'default') {
13063: $do_default=1;
13064: } elsif ($pack_type eq 'extension') {
13065: push(@extension,[$package,$pack_type,$pack_part]);
1.885 albertel 13066: } elsif ($pack_part eq $part || $pack_type eq 'part') {
1.848 albertel 13067: # only look at packages defaults for packages that this id is
1.738 albertel 13068: push(@specifics,[$package,$pack_type,$pack_part]);
13069: }
13070: }
13071: # first look for a package that matches the requested part id
13072: foreach my $package (@specifics) {
13073: my (undef,$pack_type,$pack_part)=@{$package};
13074: next if ($pack_part ne $part);
13075: if (defined($packagetab{"$pack_type&$name&default"})) {
13076: return $packagetab{"$pack_type&$name&default"};
13077: }
13078: }
13079: # look for any possible matching non extension_ package
13080: foreach my $package (@specifics) {
13081: my (undef,$pack_type,$pack_part)=@{$package};
1.468 albertel 13082: if (defined($packagetab{"$pack_type&$name&default"})) {
13083: return $packagetab{"$pack_type&$name&default"};
13084: }
1.585 albertel 13085: if ($pack_type eq 'part') { $pack_part='0'; }
1.468 albertel 13086: if (defined($packagetab{$pack_type."_".$pack_part."&$name&default"})) {
13087: return $packagetab{$pack_type."_".$pack_part."&$name&default"};
1.395 albertel 13088: }
13089: }
1.738 albertel 13090: # look for any posible extension_ match
13091: foreach my $package (@extension) {
13092: my ($package,$pack_type)=@{$package};
13093: if (defined($packagetab{"$pack_type&$name&default"})) {
13094: return $packagetab{"$pack_type&$name&default"};
13095: }
13096: if (defined($packagetab{$package."&$name&default"})) {
13097: return $packagetab{$package."&$name&default"};
13098: }
13099: }
13100: # look for a global default setting
13101: if ($do_default && defined($packagetab{"default&$name&default"})) {
13102: return $packagetab{"default&$name&default"};
13103: }
1.395 albertel 13104: return undef;
13105: }
13106:
1.334 albertel 13107: sub add_prefix_and_part {
13108: my ($prefix,$part)=@_;
13109: my $keyroot;
13110: if (defined($prefix) && $prefix !~ /^__/) {
13111: # prefix that has a part already
13112: $keyroot=$prefix;
13113: } elsif (defined($prefix)) {
13114: # prefix that is missing a part
13115: if (defined($part)) { $keyroot='_'.$part.substr($prefix,1); }
13116: } else {
13117: # no prefix at all
13118: if (defined($part)) { $keyroot='_'.$part; }
13119: }
13120: return $keyroot;
13121: }
13122:
1.71 www 13123: # ---------------------------------------------------------------- Get metadata
13124:
1.599 albertel 13125: my %metaentry;
1.1070 www 13126: my %importedpartids;
1.1369 raeburn 13127: my %importedrespids;
1.71 www 13128: sub metadata {
1.1362 raeburn 13129: my ($uri,$what,$toolsymb,$liburi,$prefix,$depthcount)=@_;
1.71 www 13130: $uri=&declutter($uri);
1.288 albertel 13131: # if it is a non metadata possible uri return quickly
1.529 albertel 13132: if (($uri eq '') ||
13133: (($uri =~ m|^/*adm/|) &&
1.1343 raeburn 13134: ($uri !~ m|^adm/includes|) && ($uri !~ m{/(smppg|bulletinboard|ext\.tool)$})) ||
1.1108 raeburn 13135: ($uri =~ m|/$|) || ($uri =~ m|/.meta$|) || ($uri =~ m{^/*uploaded/.+\.sequence$})) {
1.924 albertel 13136: return undef;
13137: }
1.1261 raeburn 13138: if (($uri =~ /^priv/ || $uri=~m{^home/httpd/html/priv})
1.924 albertel 13139: && &Apache::lonxml::get_state('target') =~ /^(|meta)$/) {
1.468 albertel 13140: return undef;
1.288 albertel 13141: }
1.73 www 13142: my $filename=$uri;
13143: $uri=~s/\.meta$//;
1.172 www 13144: #
13145: # Is the metadata already cached?
1.177 www 13146: # Look at timestamp of caching
1.172 www 13147: # Everything is cached by the main uri, libraries are never directly cached
13148: #
1.428 albertel 13149: if (!defined($liburi)) {
1.599 albertel 13150: my ($result,$cached)=&is_cached_new('meta',$uri);
1.428 albertel 13151: if (defined($cached)) { return $result->{':'.$what}; }
13152: }
1.1362 raeburn 13153:
13154: #
13155: # If the uri is for an external tool the file from
13156: # which metadata should be retrieved depends on whether
13157: # the tool had been configured to be gradable (set in the Course
13158: # Editor or Resource Editor).
13159: #
13160: # If a valid symb has been included as the third arg in the call
13161: # to &metadata() that can be used to retrieve the value of
13162: # parameter_0_gradable set for the resource, and included in the
13163: # uploaded map containing the tool. The value is retrieved via
13164: # &EXT(), if a valid symb is available. Otherwise the value of
13165: # gradable in the exttool_$marker.db file for the tool instance
1.1364 raeburn 13166: # is retrieved via &get().
13167: #
13168: # When lonuserstate::traceroute() calls lonnet::EXT() for
13169: # hiddenresource and encrypturl (during course initialization)
13170: # the map-level parameter for resource.0.gradable included in the
13171: # uploaded map containing the tool will not yet have been stored
13172: # in the user_course_parms.db file for the user's session, so in
13173: # this case fall back to retrieving gradable status from the
13174: # exttool_$marker.db file.
1.1362 raeburn 13175: #
13176: # In order to avoid an infinite loop, &metadata() will return
13177: # before a call to &EXT(), if the uri is for an external tool
13178: # and the $what for which metadata is being requested is
13179: # parameter_0_gradable or 0_gradable.
13180: #
13181:
13182: if ($uri =~ /ext\.tool$/) {
13183: if (($what eq 'parameter_0_gradable') || ($what eq '0_gradable')) {
13184: return;
13185: } else {
13186: my ($checked,$use_passback);
13187: if ($toolsymb ne '') {
13188: (undef,undef,my $tooluri) = &decode_symb($toolsymb);
1.1364 raeburn 13189: if (($tooluri eq $uri) && (&EXT('resource.0.gradable',$toolsymb))) {
1.1362 raeburn 13190: $checked = 1;
13191: if (&EXT('resource.0.gradable',$toolsymb) =~ /^yes$/i) {
13192: $use_passback = 1;
13193: }
13194: }
13195: }
13196: unless ($checked) {
13197: my ($ignore,$cdom,$cnum,$marker) = split(m{/},$uri);
13198: $marker=~s/\D//g;
1.1363 raeburn 13199: if ($marker) {
1.1362 raeburn 13200: my %toolsettings=&get('exttool_'.$marker,['gradable'],$cdom,$cnum);
13201: $use_passback = $toolsettings{'gradable'};
13202: }
13203: }
13204: if ($use_passback) {
13205: $filename = '/home/httpd/html/res/lib/templates/LTIpassback.tool';
13206: } else {
13207: $filename = '/home/httpd/html/res/lib/templates/LTIstandard.tool';
13208: }
13209: }
13210: }
13211:
1.428 albertel 13212: {
1.1069 www 13213: # Imported parts would go here
1.1369 raeburn 13214: my @origfiletagids=();
1.1069 www 13215: my $importedparts=0;
1.1369 raeburn 13216:
13217: # Imported responseids would go here
13218: my $importedresponses=0;
1.172 www 13219: #
13220: # Is this a recursive call for a library?
13221: #
1.599 albertel 13222: # if (! exists($metacache{$uri})) {
13223: # $metacache{$uri}={};
13224: # }
1.924 albertel 13225: my $cachetime = 60*60;
1.171 www 13226: if ($liburi) {
13227: $liburi=&declutter($liburi);
13228: $filename=$liburi;
1.401 bowersj2 13229: } else {
1.599 albertel 13230: &devalidate_cache_new('meta',$uri);
13231: undef(%metaentry);
1.401 bowersj2 13232: }
1.140 www 13233: my %metathesekeys=();
1.73 www 13234: unless ($filename=~/\.meta$/) { $filename.='.meta'; }
1.489 albertel 13235: my $metastring;
1.1140 www 13236: if ($uri =~ /^priv/ || $uri=~/home\/httpd\/html\/priv/) {
1.929 albertel 13237: my $which = &hreflocation('','/'.($liburi || $uri));
1.924 albertel 13238: $metastring =
1.929 albertel 13239: &Apache::lonnet::ssi_body($which,
1.924 albertel 13240: ('grade_target' => 'meta'));
13241: $cachetime = 1; # only want this cached in the child not long term
1.1108 raeburn 13242: } elsif (($uri !~ m -^(editupload)/-) &&
13243: ($uri !~ m{^/*uploaded/$match_domain/$match_courseid/docs/})) {
1.543 albertel 13244: my $file=&filelocation('',&clutter($filename));
1.599 albertel 13245: #push(@{$metaentry{$uri.'.file'}},$file);
1.543 albertel 13246: $metastring=&getfile($file);
1.489 albertel 13247: }
1.208 albertel 13248: my $parser=HTML::LCParser->new(\$metastring);
1.71 www 13249: my $token;
1.140 www 13250: undef %metathesekeys;
1.71 www 13251: while ($token=$parser->get_token) {
1.339 albertel 13252: if ($token->[0] eq 'S') {
13253: if (defined($token->[2]->{'package'})) {
1.172 www 13254: #
13255: # This is a package - get package info
13256: #
1.339 albertel 13257: my $package=$token->[2]->{'package'};
13258: my $keyroot=&add_prefix_and_part($prefix,$token->[2]->{'part'});
13259: if (defined($token->[2]->{'id'})) {
13260: $keyroot.='_'.$token->[2]->{'id'};
13261: }
1.599 albertel 13262: if ($metaentry{':packages'}) {
13263: $metaentry{':packages'}.=','.$package.$keyroot;
1.339 albertel 13264: } else {
1.599 albertel 13265: $metaentry{':packages'}=$package.$keyroot;
1.339 albertel 13266: }
1.736 albertel 13267: foreach my $pack_entry (keys(%packagetab)) {
1.432 albertel 13268: my $part=$keyroot;
13269: $part=~s/^\_//;
1.736 albertel 13270: if ($pack_entry=~/^\Q$package\E\&/ ||
13271: $pack_entry=~/^\Q$package\E_0\&/) {
13272: my ($pack,$name,$subp)=split(/\&/,$pack_entry);
1.395 albertel 13273: # ignore package.tab specified default values
13274: # here &package_tab_default() will fetch those
13275: if ($subp eq 'default') { next; }
1.736 albertel 13276: my $value=$packagetab{$pack_entry};
1.432 albertel 13277: my $unikey;
13278: if ($pack =~ /_0$/) {
13279: $unikey='parameter_0_'.$name;
13280: $part=0;
13281: } else {
13282: $unikey='parameter'.$keyroot.'_'.$name;
13283: }
1.339 albertel 13284: if ($subp eq 'display') {
13285: $value.=' [Part: '.$part.']';
13286: }
1.599 albertel 13287: $metaentry{':'.$unikey.'.part'}=$part;
1.395 albertel 13288: $metathesekeys{$unikey}=1;
1.599 albertel 13289: unless (defined($metaentry{':'.$unikey.'.'.$subp})) {
13290: $metaentry{':'.$unikey.'.'.$subp}=$value;
1.339 albertel 13291: }
1.599 albertel 13292: if (defined($metaentry{':'.$unikey.'.default'})) {
13293: $metaentry{':'.$unikey}=
13294: $metaentry{':'.$unikey.'.default'};
1.356 albertel 13295: }
1.339 albertel 13296: }
13297: }
13298: } else {
1.172 www 13299: #
13300: # This is not a package - some other kind of start tag
1.339 albertel 13301: #
13302: my $entry=$token->[1];
1.1068 www 13303: my $unikey='';
1.175 www 13304:
1.339 albertel 13305: if ($entry eq 'import') {
1.175 www 13306: #
13307: # Importing a library here
1.339 albertel 13308: #
1.1067 www 13309: my $location=$parser->get_text('/import');
13310: my $dir=$filename;
13311: $dir=~s|[^/]*$||;
13312: $location=&filelocation($dir,$location);
1.1369 raeburn 13313:
13314: my $importid=$token->[2]->{'id'};
1.1068 www 13315: my $importmode=$token->[2]->{'importmode'};
1.1369 raeburn 13316: #
13317: # Check metadata for imported file to
13318: # see if it contained response items
13319: #
1.1372 raeburn 13320: my ($origfile,@libfilekeys);
1.1370 raeburn 13321: my %currmetaentry = %metaentry;
1.1372 raeburn 13322: @libfilekeys = split(/,/,&metadata($location,'keys',undef,undef,undef,
13323: $depthcount+1));
13324: if (grep(/^responseorder$/,@libfilekeys)) {
13325: my $libresponseorder = &metadata($location,'responseorder',undef,undef,
13326: undef,$depthcount+1);
13327: if ($libresponseorder ne '') {
13328: if ($#origfiletagids<0) {
13329: undef(%importedrespids);
13330: undef(%importedpartids);
13331: }
1.1373 raeburn 13332: my @respids = split(/\s*,\s*/,$libresponseorder);
13333: if (@respids) {
13334: $importedrespids{$importid} = join(',',map { $importid.'_'.$_ } @respids);
13335: }
13336: if ($importedrespids{$importid} ne '') {
1.1372 raeburn 13337: $importedresponses = 1;
1.1369 raeburn 13338: # We need to get the original file and the imported file to get the response order correct
13339: # Load and inspect original file
1.1372 raeburn 13340: if ($#origfiletagids<0) {
13341: my $origfilelocation=$perlvar{'lonDocRoot'}.&clutter($uri);
13342: $origfile=&getfile($origfilelocation);
13343: @origfiletagids=($origfile=~/<((?:\w+)response|import|part)[^>]*id\s*=\s*[\"\']([^\"\']+)[\"\'][^>]*>/gs);
13344: }
1.1369 raeburn 13345: }
13346: }
13347: }
1.1370 raeburn 13348: # Do not overwrite contents of %metaentry hash for resource itself with
13349: # hash populated for imported library file
13350: %metaentry = %currmetaentry;
13351: undef(%currmetaentry);
1.1374 raeburn 13352: if ($importmode eq 'part') {
1.1068 www 13353: # Import as part(s)
1.1069 www 13354: $importedparts=1;
13355: # We need to get the original file and the imported file to get the part order correct
13356: # Good news: we do not need to worry about nested libraries, since parts cannot be nested
1.1369 raeburn 13357: # Load and inspect original file if we didn't do that already
13358: if ($#origfiletagids<0) {
13359: undef(%importedrespids);
13360: undef(%importedpartids);
13361: if ($origfile eq '') {
13362: my $origfilelocation=$perlvar{'lonDocRoot'}.&clutter($uri);
13363: $origfile=&getfile($origfilelocation);
13364: @origfiletagids=($origfile=~/<(part|import)[^>]*id\s*=\s*[\"\']([^\"\']+)[\"\'][^>]*>/gs);
13365: }
1.1070 www 13366: }
1.1372 raeburn 13367: my @impfilepartids;
13368: # If <partorder> tag is included in metadata for the imported file
13369: # get the parts in the imported file from that.
13370: if (grep(/^partorder$/,@libfilekeys)) {
13371: %currmetaentry = %metaentry;
13372: my $libpartorder = &metadata($location,'partorder',undef,undef,undef,
13373: $depthcount+1);
13374: %metaentry = %currmetaentry;
13375: undef(%currmetaentry);
13376: if ($libpartorder ne '') {
13377: @impfilepartids=split(/\s*,\s*/,$libpartorder);
13378: }
13379: } else {
13380: # If no <partorder> tag available, load and inspect imported file
13381: my $impfile=&getfile($location);
13382: @impfilepartids=($impfile=~/<part[^>]*id\s*=\s*[\"\']([^\"\']+)[\"\'][^>]*>/gs);
13383: }
1.1069 www 13384: if ($#impfilepartids>=0) {
13385: # This problem had parts
1.1070 www 13386: $importedpartids{$token->[2]->{'id'}}=join(',',@impfilepartids);
1.1069 www 13387: } else {
13388: # Importing by turning a single problem into a problem part
13389: # It gets the import-tags ID as part-ID
13390: $unikey=&add_prefix_and_part($prefix,$token->[2]->{'id'});
1.1070 www 13391: $importedpartids{$token->[2]->{'id'}}=$token->[2]->{'id'};
1.1069 www 13392: }
1.1068 www 13393: } else {
1.1374 raeburn 13394: # Import as problem or as normal import
13395: $unikey=&add_prefix_and_part($prefix,$token->[2]->{'part'});
13396: unless ($importmode eq 'problem') {
1.1068 www 13397: # Normal import
1.1374 raeburn 13398: if (defined($token->[2]->{'id'})) {
13399: $unikey.='_'.$token->[2]->{'id'};
13400: }
13401: }
13402: # Check metadata for imported file to
13403: # see if it contained parts
13404: if (grep(/^partorder$/,@libfilekeys)) {
13405: %currmetaentry = %metaentry;
13406: my $libpartorder = &metadata($location,'partorder',undef,undef,undef,
13407: $depthcount+1);
13408: %metaentry = %currmetaentry;
13409: undef(%currmetaentry);
13410: if ($libpartorder ne '') {
13411: $importedparts = 1;
13412: $importedpartids{$token->[2]->{'id'}}=$libpartorder;
13413: }
13414: }
1.1067 www 13415: }
1.339 albertel 13416: if ($depthcount<20) {
1.736 albertel 13417: my $metadata =
1.1362 raeburn 13418: &metadata($uri,'keys',$toolsymb,$location,$unikey,
1.736 albertel 13419: $depthcount+1);
13420: foreach my $meta (split(',',$metadata)) {
13421: $metaentry{':'.$meta}=$metaentry{':'.$meta};
13422: $metathesekeys{$meta}=1;
1.339 albertel 13423: }
1.1068 www 13424: }
1.1067 www 13425: } else {
13426: #
13427: # Not importing, some other kind of non-package, non-library start tag
13428: #
13429: $unikey=$entry.&add_prefix_and_part($prefix,$token->[2]->{'part'});
13430: if (defined($token->[2]->{'id'})) {
13431: $unikey.='_'.$token->[2]->{'id'};
13432: }
1.339 albertel 13433: if (defined($token->[2]->{'name'})) {
13434: $unikey.='_'.$token->[2]->{'name'};
13435: }
13436: $metathesekeys{$unikey}=1;
1.736 albertel 13437: foreach my $param (@{$token->[3]}) {
13438: $metaentry{':'.$unikey.'.'.$param} =
13439: $token->[2]->{$param};
1.339 albertel 13440: }
13441: my $internaltext=&HTML::Entities::decode($parser->get_text('/'.$entry));
1.599 albertel 13442: my $default=$metaentry{':'.$unikey.'.default'};
1.339 albertel 13443: if ( $internaltext =~ /^\s*$/ && $default !~ /^\s*$/) {
13444: # only ws inside the tag, and not in default, so use default
13445: # as value
1.599 albertel 13446: $metaentry{':'.$unikey}=$default;
1.908 albertel 13447: } elsif ( $internaltext =~ /\S/ ) {
13448: # something interesting inside the tag
13449: $metaentry{':'.$unikey}=$internaltext;
1.339 albertel 13450: } else {
1.908 albertel 13451: # no interesting values, don't set a default
1.339 albertel 13452: }
1.172 www 13453: # end of not-a-package not-a-library import
1.339 albertel 13454: }
1.172 www 13455: # end of not-a-package start tag
1.339 albertel 13456: }
1.172 www 13457: # the next is the end of "start tag"
1.339 albertel 13458: }
13459: }
1.483 albertel 13460: my ($extension) = ($uri =~ /\.(\w+)$/);
1.883 albertel 13461: $extension = lc($extension);
13462: if ($extension eq 'htm') { $extension='html'; }
13463:
1.737 albertel 13464: foreach my $key (keys(%packagetab)) {
1.483 albertel 13465: #no specific packages #how's our extension
13466: if ($key!~/^extension_\Q$extension\E&/) { next; }
1.488 albertel 13467: &metadata_create_package_def($uri,$key,'extension_'.$extension,
1.483 albertel 13468: \%metathesekeys);
13469: }
1.883 albertel 13470:
13471: if (!exists($metaentry{':packages'})
13472: || $packagetab{"import_defaults&extension_$extension"}) {
1.737 albertel 13473: foreach my $key (keys(%packagetab)) {
1.483 albertel 13474: #no specific packages well let's get default then
13475: if ($key!~/^default&/) { next; }
1.488 albertel 13476: &metadata_create_package_def($uri,$key,'default',
1.483 albertel 13477: \%metathesekeys);
13478: }
13479: }
1.338 www 13480: # are there custom rights to evaluate
1.599 albertel 13481: if ($metaentry{':copyright'} eq 'custom') {
1.339 albertel 13482:
1.338 www 13483: #
13484: # Importing a rights file here
1.339 albertel 13485: #
13486: unless ($depthcount) {
1.599 albertel 13487: my $location=$metaentry{':customdistributionfile'};
1.339 albertel 13488: my $dir=$filename;
13489: $dir=~s|[^/]*$||;
13490: $location=&filelocation($dir,$location);
1.736 albertel 13491: my $rights_metadata =
1.1362 raeburn 13492: &metadata($uri,'keys',$toolsymb,$location,'_rights',
1.736 albertel 13493: $depthcount+1);
13494: foreach my $rights (split(',',$rights_metadata)) {
13495: #$metaentry{':'.$rights}=$metacache{$uri}->{':'.$rights};
13496: $metathesekeys{$rights}=1;
1.339 albertel 13497: }
13498: }
13499: }
1.737 albertel 13500: # uniqifiy package listing
13501: my %seen;
13502: my @uniq_packages =
13503: grep { ! $seen{$_} ++ } (split(',',$metaentry{':packages'}));
13504: $metaentry{':packages'} = join(',',@uniq_packages);
13505:
1.1369 raeburn 13506: if (($importedresponses) || ($importedparts)) {
13507: if ($importedparts) {
1.1070 www 13508: # We had imported parts and need to rebuild partorder
1.1369 raeburn 13509: $metaentry{':partorder'}='';
13510: $metathesekeys{'partorder'}=1;
13511: }
13512: if ($importedresponses) {
13513: # We had imported responses and need to rebuil responseorder
13514: $metaentry{':responseorder'}='';
13515: $metathesekeys{'responseorder'}=1;
13516: }
13517: for (my $index=0;$index<$#origfiletagids;$index+=2) {
13518: my $origid = $origfiletagids[$index+1];
13519: if ($origfiletagids[$index] eq 'part') {
13520: # Original part, part of the problem
13521: if ($importedparts) {
13522: $metaentry{':partorder'}.=','.$origid;
13523: }
13524: } elsif ($origfiletagids[$index] eq 'import') {
13525: if ($importedparts) {
13526: # We have imported parts at this position
1.1373 raeburn 13527: if ($importedpartids{$origid} ne '') {
13528: $metaentry{':partorder'}.=','.$importedpartids{$origid};
13529: }
1.1369 raeburn 13530: }
13531: if ($importedresponses) {
13532: # We have imported responses at this position
1.1373 raeburn 13533: if ($importedrespids{$origid} ne '') {
13534: $metaentry{':responseorder'}.=','.$importedrespids{$origid};
1.1369 raeburn 13535: }
13536: }
13537: } else {
13538: # Original response item, part of the problem
13539: if ($importedresponses) {
13540: $metaentry{':responseorder'}.=','.$origid;
13541: }
13542: }
13543: }
13544: if ($importedparts) {
13545: $metaentry{':partorder'}=~s/^\,//;
13546: }
13547: if ($importedresponses) {
13548: $metaentry{':responseorder'}=~s/^\,//;
13549: }
1.1070 www 13550: }
1.737 albertel 13551: $metaentry{':keys'} = join(',',keys(%metathesekeys));
1.599 albertel 13552: &metadata_generate_part0(\%metathesekeys,\%metaentry,$uri);
1.1274 raeburn 13553: $metaentry{':allpossiblekeys'}=join(',',keys(%metathesekeys));
1.1371 raeburn 13554: unless ($liburi) {
13555: &do_cache_new('meta',$uri,\%metaentry,$cachetime);
13556: }
1.177 www 13557: # this is the end of "was not already recently cached
1.71 www 13558: }
1.599 albertel 13559: return $metaentry{':'.$what};
1.261 albertel 13560: }
13561:
1.488 albertel 13562: sub metadata_create_package_def {
1.483 albertel 13563: my ($uri,$key,$package,$metathesekeys)=@_;
13564: my ($pack,$name,$subp)=split(/\&/,$key);
13565: if ($subp eq 'default') { next; }
13566:
1.599 albertel 13567: if (defined($metaentry{':packages'})) {
13568: $metaentry{':packages'}.=','.$package;
1.483 albertel 13569: } else {
1.599 albertel 13570: $metaentry{':packages'}=$package;
1.483 albertel 13571: }
13572: my $value=$packagetab{$key};
13573: my $unikey;
13574: $unikey='parameter_0_'.$name;
1.599 albertel 13575: $metaentry{':'.$unikey.'.part'}=0;
1.483 albertel 13576: $$metathesekeys{$unikey}=1;
1.599 albertel 13577: unless (defined($metaentry{':'.$unikey.'.'.$subp})) {
13578: $metaentry{':'.$unikey.'.'.$subp}=$value;
1.483 albertel 13579: }
1.599 albertel 13580: if (defined($metaentry{':'.$unikey.'.default'})) {
13581: $metaentry{':'.$unikey}=
13582: $metaentry{':'.$unikey.'.default'};
1.483 albertel 13583: }
13584: }
13585:
1.261 albertel 13586: sub metadata_generate_part0 {
13587: my ($metadata,$metacache,$uri) = @_;
13588: my %allnames;
1.737 albertel 13589: foreach my $metakey (keys(%$metadata)) {
1.261 albertel 13590: if ($metakey=~/^parameter\_(.*)/) {
1.428 albertel 13591: my $part=$$metacache{':'.$metakey.'.part'};
13592: my $name=$$metacache{':'.$metakey.'.name'};
1.356 albertel 13593: if (! exists($$metadata{'parameter_0_'.$name.'.name'})) {
1.261 albertel 13594: $allnames{$name}=$part;
13595: }
13596: }
13597: }
13598: foreach my $name (keys(%allnames)) {
13599: $$metadata{"parameter_0_$name"}=1;
1.428 albertel 13600: my $key=":parameter_0_$name";
1.261 albertel 13601: $$metacache{"$key.part"}='0';
13602: $$metacache{"$key.name"}=$name;
1.428 albertel 13603: $$metacache{"$key.type"}=$$metacache{':parameter_'.
1.261 albertel 13604: $allnames{$name}.'_'.$name.
13605: '.type'};
1.428 albertel 13606: my $olddis=$$metacache{':parameter_'.$allnames{$name}.'_'.$name.
1.261 albertel 13607: '.display'};
1.644 www 13608: my $expr='[Part: '.$allnames{$name}.']';
1.479 albertel 13609: $olddis=~s/\Q$expr\E/\[Part: 0\]/;
1.261 albertel 13610: $$metacache{"$key.display"}=$olddis;
13611: }
1.71 www 13612: }
13613:
1.764 albertel 13614: # ------------------------------------------------------ Devalidate title cache
13615:
13616: sub devalidate_title_cache {
13617: my ($url)=@_;
13618: if (!$env{'request.course.id'}) { return; }
13619: my $symb=&symbread($url);
13620: if (!$symb) { return; }
13621: my $key=$env{'request.course.id'}."\0".$symb;
13622: &devalidate_cache_new('title',$key);
13623: }
13624:
1.1014 droeschl 13625: # ------------------------------------------------- Get the title of a course
13626:
13627: sub current_course_title {
13628: return $env{ 'course.' . $env{'request.course.id'} . '.description' };
13629: }
1.301 www 13630: # ------------------------------------------------- Get the title of a resource
13631:
13632: sub gettitle {
13633: my $urlsymb=shift;
13634: my $symb=&symbread($urlsymb);
1.534 albertel 13635: if ($symb) {
1.620 albertel 13636: my $key=$env{'request.course.id'}."\0".$symb;
1.599 albertel 13637: my ($result,$cached)=&is_cached_new('title',$key);
1.575 albertel 13638: if (defined($cached)) {
13639: return $result;
13640: }
1.534 albertel 13641: my ($map,$resid,$url)=&decode_symb($symb);
13642: my $title='';
1.907 albertel 13643: if (!$map && $resid == 0 && $url =~/default\.sequence$/) {
13644: $title = $env{'course.'.$env{'request.course.id'}.'.description'};
13645: } else {
13646: if (tie(my %bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
13647: &GDBM_READER(),0640)) {
13648: my $mapid=$bighash{'map_pc_'.&clutter($map)};
13649: $title=$bighash{'title_'.$mapid.'.'.$resid};
13650: untie(%bighash);
13651: }
1.534 albertel 13652: }
13653: $title=~s/\&colon\;/\:/gs;
13654: if ($title) {
1.1159 www 13655: # Remember both $symb and $title for dynamic metadata
13656: $accesshash{$symb.'___crstitle'}=$title;
1.1161 www 13657: $accesshash{&declutter($map).'___'.&declutter($url).'___usage'}=time;
1.1159 www 13658: # Cache this title and then return it
1.599 albertel 13659: return &do_cache_new('title',$key,$title,600);
1.534 albertel 13660: }
13661: $urlsymb=$url;
13662: }
13663: my $title=&metadata($urlsymb,'title');
13664: if (!$title) { $title=(split('/',$urlsymb))[-1]; }
13665: return $title;
1.301 www 13666: }
1.613 albertel 13667:
1.614 albertel 13668: sub get_slot {
13669: my ($which,$cnum,$cdom)=@_;
13670: if (!$cnum || !$cdom) {
1.790 albertel 13671: (undef,my $courseid)=&whichuser();
1.620 albertel 13672: $cdom=$env{'course.'.$courseid.'.domain'};
13673: $cnum=$env{'course.'.$courseid.'.num'};
1.614 albertel 13674: }
1.703 albertel 13675: my $key=join("\0",'slots',$cdom,$cnum,$which);
13676: my %slotinfo;
13677: if (exists($remembered{$key})) {
13678: $slotinfo{$which} = $remembered{$key};
13679: } else {
13680: %slotinfo=&get('slots',[$which],$cdom,$cnum);
13681: &Apache::lonhomework::showhash(%slotinfo);
13682: my ($tmp)=keys(%slotinfo);
13683: if ($tmp=~/^error:/) { return (); }
13684: $remembered{$key} = $slotinfo{$which};
13685: }
1.616 albertel 13686: if (ref($slotinfo{$which}) eq 'HASH') {
13687: return %{$slotinfo{$which}};
13688: }
13689: return $slotinfo{$which};
1.614 albertel 13690: }
1.1150 raeburn 13691:
13692: sub get_reservable_slots {
13693: my ($cnum,$cdom,$uname,$udom) = @_;
13694: my $now = time;
13695: my $reservable_info;
13696: my $key=join("\0",'reservableslots',$cdom,$cnum,$uname,$udom);
13697: if (exists($remembered{$key})) {
13698: $reservable_info = $remembered{$key};
13699: } else {
13700: my %resv;
13701: ($resv{'now_order'},$resv{'now'},$resv{'future_order'},$resv{'future'}) =
13702: &Apache::loncommon::get_future_slots($cnum,$cdom,$now);
13703: $reservable_info = \%resv;
13704: $remembered{$key} = $reservable_info;
13705: }
13706: return $reservable_info;
13707: }
13708:
13709: sub get_course_slots {
13710: my ($cnum,$cdom) = @_;
13711: my $hashid=$cnum.':'.$cdom;
1.1494 raeburn 13712: my ($result,$cached) = &is_cached_new('allslots',$hashid);
1.1150 raeburn 13713: if (defined($cached)) {
13714: if (ref($result) eq 'HASH') {
13715: return %{$result};
13716: }
13717: } else {
1.1494 raeburn 13718: my %slots=&dump('slots',$cdom,$cnum);
1.1150 raeburn 13719: my ($tmp) = keys(%slots);
13720: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
1.1219 raeburn 13721: &do_cache_new('allslots',$hashid,\%slots,600);
1.1150 raeburn 13722: return %slots;
13723: }
13724: }
13725: return;
13726: }
13727:
13728: sub devalidate_slots_cache {
13729: my ($cnum,$cdom)=@_;
13730: my $hashid=$cnum.':'.$cdom;
13731: &devalidate_cache_new('allslots',$hashid);
13732: }
13733:
1.1181 raeburn 13734: sub get_coursechange {
13735: my ($cdom,$cnum) = @_;
13736: if ($cdom eq '' || $cnum eq '') {
13737: return unless ($env{'request.course.id'});
13738: $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
13739: $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
13740: }
13741: my $hashid=$cdom.'_'.$cnum;
13742: my ($change,$cached)=&is_cached_new('crschange',$hashid);
13743: if ((defined($cached)) && ($change ne '')) {
13744: return $change;
13745: } else {
13746: my %crshash;
13747: %crshash = &get('environment',['internal.contentchange'],$cdom,$cnum);
13748: if ($crshash{'internal.contentchange'} eq '') {
13749: $change = $env{'course.'.$cdom.'_'.$cnum.'.internal.created'};
13750: if ($change eq '') {
13751: %crshash = &get('environment',['internal.created'],$cdom,$cnum);
13752: $change = $crshash{'internal.created'};
13753: }
13754: } else {
13755: $change = $crshash{'internal.contentchange'};
13756: }
13757: my $cachetime = 600;
13758: &do_cache_new('crschange',$hashid,$change,$cachetime);
13759: }
13760: return $change;
13761: }
13762:
13763: sub devalidate_coursechange_cache {
1.1496 raeburn 13764: my ($cdom,$cnum)=@_;
13765: my $hashid=$cdom.'_'.$cnum;
1.1181 raeburn 13766: &devalidate_cache_new('crschange',$hashid);
13767: }
13768:
1.1496 raeburn 13769: sub get_suppchange {
13770: my ($cdom,$cnum) = @_;
13771: if ($cdom eq '' || $cnum eq '') {
13772: return unless ($env{'request.course.id'});
13773: $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
13774: $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
13775: }
13776: my $hashid=$cdom.'_'.$cnum;
13777: my ($change,$cached)=&is_cached_new('suppchange',$hashid);
13778: if ((defined($cached)) && ($change ne '')) {
13779: return $change;
13780: } else {
13781: my %crshash = &get('environment',['internal.supplementalchange'],$cdom,$cnum);
13782: if ($crshash{'internal.supplementalchange'} eq '') {
13783: $change = $env{'course.'.$cdom.'_'.$cnum.'.internal.created'};
13784: if ($change eq '') {
13785: %crshash = &get('environment',['internal.created'],$cdom,$cnum);
13786: $change = $crshash{'internal.created'};
13787: }
13788: } else {
13789: $change = $crshash{'internal.supplementalchange'};
13790: }
13791: my $cachetime = 600;
13792: &do_cache_new('suppchange',$hashid,$change,$cachetime);
13793: }
13794: return $change;
13795: }
13796:
13797: sub devalidate_suppchange_cache {
13798: my ($cdom,$cnum)=@_;
13799: my $hashid=$cdom.'_'.$cnum;
13800: &devalidate_cache_new('suppchange',$hashid);
13801: }
13802:
1.1497 raeburn 13803: sub update_supp_caches {
13804: my ($cdom,$cnum) = @_;
13805: my %servers = &internet_dom_servers($cdom);
13806: my @ids=¤t_machine_ids();
13807: foreach my $server (keys(%servers)) {
13808: next if (grep(/^\Q$server\E$/,@ids));
13809: my $hashid=$cnum.':'.$cdom;
13810: my $cachekey = &escape('showsupp').':'.&escape($hashid);
13811: &remote_devalidate_cache($server,[$cachekey]);
13812: }
13813: &has_unhidden_suppfiles($cnum,$cdom,1,1);
13814: &count_supptools($cnum,$cdom,1);
13815: my $now = time;
13816: if ($env{'request.course.id'} eq $cdom.'_'.$cnum) {
13817: &Apache::lonnet::appenv({'request.course.suppupdated' => $now});
13818: }
13819: &put('environment',{'internal.supplementalchange' => $now},
13820: $cdom,$cnum);
13821: &Apache::lonnet::appenv(
13822: {'course.'.$cdom.'_'.$cnum.'.internal.supplementalchange' => $now});
13823: &do_cache_new('suppchange',$cdom.'_'.$cnum,$now,600);
13824: }
13825:
1.31 www 13826: # ------------------------------------------------- Update symbolic store links
13827:
13828: sub symblist {
13829: my ($mapname,%newhash)=@_;
1.438 www 13830: $mapname=&deversion(&declutter($mapname));
1.31 www 13831: my %hash;
1.620 albertel 13832: if (($env{'request.course.fn'}) && (%newhash)) {
13833: if (tie(%hash,'GDBM_File',$env{'request.course.fn'}.'_symb.db',
1.256 albertel 13834: &GDBM_WRCREAT(),0640)) {
1.1000 raeburn 13835: foreach my $url (keys(%newhash)) {
1.711 albertel 13836: next if ($url eq 'last_known'
13837: && $env{'form.no_update_last_known'});
13838: $hash{declutter($url)}=&encode_symb($mapname,
13839: $newhash{$url}->[1],
13840: $newhash{$url}->[0]);
1.191 harris41 13841: }
1.31 www 13842: if (untie(%hash)) {
13843: return 'ok';
13844: }
13845: }
13846: }
13847: return 'error';
1.212 www 13848: }
13849:
13850: # --------------------------------------------------------------- Verify a symb
13851:
13852: sub symbverify {
1.1190 raeburn 13853: my ($symb,$thisurl,$encstate)=@_;
1.510 www 13854: my $thisfn=$thisurl;
1.439 www 13855: $thisfn=&declutter($thisfn);
1.215 www 13856: # direct jump to resource in page or to a sequence - will construct own symbs
13857: if ($thisfn=~/\.(page|sequence)$/) { return 1; }
13858: # check URL part
1.409 www 13859: my ($map,$resid,$url)=&decode_symb($symb);
1.439 www 13860:
1.431 www 13861: unless ($url eq $thisfn) { return 0; }
1.213 www 13862:
1.216 www 13863: $symb=&symbclean($symb);
1.510 www 13864: $thisurl=&deversion($thisurl);
1.439 www 13865: $thisfn=&deversion($thisfn);
1.213 www 13866:
13867: my %bighash;
13868: my $okay=0;
1.431 www 13869:
1.620 albertel 13870: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
1.256 albertel 13871: &GDBM_READER(),0640)) {
1.1032 raeburn 13872: if (($thisurl =~ m{^/adm/wrapper/ext/}) || ($thisurl =~ m{^ext/})) {
13873: $thisurl =~ s/\?.+$//;
1.1204 raeburn 13874: if ($map =~ m{^uploaded/.+\.page$}) {
13875: $thisurl =~ s{^(/adm/wrapper|)/ext/}{http://};
13876: $thisurl =~ s{^\Qhttp://https://\E}{https://};
13877: }
13878: }
13879: my $ids;
1.1419 raeburn 13880: if ($map =~ m{^uploaded/.+\.page$}) {
13881: $ids=$bighash{'ids_'.&clutter_with_no_wrapper($thisurl)};
1.1204 raeburn 13882: } else {
13883: $ids=$bighash{'ids_'.&clutter($thisurl)};
1.1032 raeburn 13884: }
1.1102 raeburn 13885: unless ($ids) {
13886: my $idkey = 'ids_'.($thisurl =~ m{^/}? '' : '/').$thisurl;
13887: $ids=$bighash{$idkey};
1.216 www 13888: }
13889: if ($ids) {
13890: # ------------------------------------------------------------------- Has ID(s)
1.1202 raeburn 13891: if ($thisfn =~ m{^/adm/wrapper/ext/}) {
1.1203 raeburn 13892: $symb =~ s/\?.+$//;
1.1202 raeburn 13893: }
1.800 albertel 13894: foreach my $id (split(/\,/,$ids)) {
13895: my ($mapid,$resid)=split(/\./,$id);
1.216 www 13896: if (
13897: &symbclean(&declutter($bighash{'map_id_'.$mapid}).'___'.$resid.'___'.$thisfn)
1.1190 raeburn 13898: eq $symb) {
13899: if (ref($encstate)) {
13900: $$encstate = $bighash{'encrypted_'.$id};
13901: }
1.620 albertel 13902: if (($env{'request.role.adv'}) ||
1.1101 raeburn 13903: ($bighash{'encrypted_'.$id} eq $env{'request.enc'}) ||
13904: ($thisurl eq '/adm/navmaps')) {
1.1190 raeburn 13905: $okay=1;
1.1202 raeburn 13906: last;
1.582 albertel 13907: }
13908: }
1.216 www 13909: }
13910: }
1.213 www 13911: untie(%bighash);
13912: }
13913: return $okay;
1.31 www 13914: }
13915:
1.210 www 13916: # --------------------------------------------------------------- Clean-up symb
13917:
13918: sub symbclean {
13919: my $symb=shift;
1.568 albertel 13920: if ($symb=~m|^/enc/|) { $symb=&Apache::lonenc::unencrypted($symb); }
1.210 www 13921: # remove version from map
13922: $symb=~s/\.(\d+)\.(\w+)\_\_\_/\.$2\_\_\_/;
1.215 www 13923:
1.210 www 13924: # remove version from URL
13925: $symb=~s/\.(\d+)\.(\w+)$/\.$2/;
1.213 www 13926:
1.507 www 13927: # remove wrapper
13928:
1.510 www 13929: $symb=~s/(\_\_\_\d+\_\_\_)adm\/wrapper\/(res\/)*/$1/;
1.694 albertel 13930: $symb=~s/(\_\_\_\d+\_\_\_)adm\/coursedocs\/showdoc\/(res\/)*/$1/;
1.210 www 13931: return $symb;
1.409 www 13932: }
13933:
13934: # ---------------------------------------------- Split symb to find map and url
1.429 albertel 13935:
13936: sub encode_symb {
13937: my ($map,$resid,$url)=@_;
13938: return &symbclean(&declutter($map).'___'.$resid.'___'.&declutter($url));
13939: }
1.409 www 13940:
13941: sub decode_symb {
1.568 albertel 13942: my $symb=shift;
13943: if ($symb=~m|^/enc/|) { $symb=&Apache::lonenc::unencrypted($symb); }
13944: my ($map,$resid,$url)=split(/___/,$symb);
1.413 www 13945: return (&fixversion($map),$resid,&fixversion($url));
13946: }
13947:
13948: sub fixversion {
13949: my $fn=shift;
1.609 banghart 13950: if ($fn=~/^(adm|uploaded|editupload|public)/) { return $fn; }
1.435 www 13951: my %bighash;
13952: my $uri=&clutter($fn);
1.620 albertel 13953: my $key=$env{'request.course.id'}.'_'.$uri;
1.440 www 13954: # is this cached?
1.599 albertel 13955: my ($result,$cached)=&is_cached_new('courseresversion',$key);
1.440 www 13956: if (defined($cached)) { return $result; }
13957: # unfortunately not cached, or expired
1.620 albertel 13958: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
1.440 www 13959: &GDBM_READER(),0640)) {
13960: if ($bighash{'version_'.$uri}) {
13961: my $version=$bighash{'version_'.$uri};
1.444 www 13962: unless (($version eq 'mostrecent') ||
13963: ($version==&getversion($uri))) {
1.440 www 13964: $uri=~s/\.(\w+)$/\.$version\.$1/;
13965: }
13966: }
13967: untie %bighash;
1.413 www 13968: }
1.599 albertel 13969: return &do_cache_new('courseresversion',$key,&declutter($uri),600);
1.438 www 13970: }
13971:
13972: sub deversion {
13973: my $url=shift;
13974: $url=~s/\.\d+\.(\w+)$/\.$1/;
13975: return $url;
1.210 www 13976: }
13977:
1.31 www 13978: # ------------------------------------------------------ Return symb list entry
13979:
13980: sub symbread {
1.1424 raeburn 13981: my ($thisfn,$donotrecurse,$ignorecachednull,$checkforblock,$possibles,
1.1427 raeburn 13982: $ignoresymbdb,$noenccheck)=@_;
1.1265 raeburn 13983: my $cache_str='request.symbread.cached.'.$thisfn;
1.1427 raeburn 13984: if (defined($env{$cache_str})) {
1.1424 raeburn 13985: unless (ref($possibles) eq 'HASH') {
13986: if ($ignorecachednull) {
13987: return $env{$cache_str} unless ($env{$cache_str} eq '');
13988: } else {
13989: return $env{$cache_str};
13990: }
1.1282 raeburn 13991: }
13992: }
1.242 www 13993: # no filename provided? try from environment
1.1265 raeburn 13994: unless ($thisfn) {
1.620 albertel 13995: if ($env{'request.symb'}) {
1.1427 raeburn 13996: return $env{$cache_str}=&symbclean($env{'request.symb'});
1.539 albertel 13997: }
1.620 albertel 13998: $thisfn=$env{'request.filename'};
1.44 www 13999: }
1.569 albertel 14000: if ($thisfn=~m|^/enc/|) { $thisfn=&Apache::lonenc::unencrypted($thisfn); }
1.242 www 14001: # is that filename actually a symb? Verify, clean, and return
14002: if ($thisfn=~/\_\_\_\d+\_\_\_(.*)$/) {
1.539 albertel 14003: if (&symbverify($thisfn,$1)) {
1.1427 raeburn 14004: return $env{$cache_str}=&symbclean($thisfn);
1.539 albertel 14005: }
1.242 www 14006: }
1.44 www 14007: $thisfn=declutter($thisfn);
1.31 www 14008: my %hash;
1.37 www 14009: my %bighash;
14010: my $syval='';
1.620 albertel 14011: if (($env{'request.course.fn'}) && ($thisfn)) {
1.1427 raeburn 14012: unless ($ignoresymbdb) {
1.1424 raeburn 14013: if (tie(%hash,'GDBM_File',$env{'request.course.fn'}.'_symb.db',
14014: &GDBM_READER(),0640)) {
1.1487 raeburn 14015: $syval=$hash{$thisfn};
1.1424 raeburn 14016: untie(%hash);
14017: }
1.1427 raeburn 14018: if ($syval && $checkforblock) {
14019: my @blockers = &has_comm_blocking('bre',$syval,$thisfn,$ignoresymbdb,$noenccheck);
1.1424 raeburn 14020: if (@blockers) {
14021: $syval='';
14022: }
14023: }
1.37 www 14024: }
14025: # ---------------------------------------------------------- There was an entry
14026: if ($syval) {
1.601 albertel 14027: #unless ($syval=~/\_\d+$/) {
1.620 albertel 14028: #unless ($env{'form.request.prefix'}=~/\.(\d+)\_$/) {
1.949 raeburn 14029: #&appenv({'request.ambiguous' => $thisfn});
1.620 albertel 14030: #return $env{$cache_str}='';
1.601 albertel 14031: #}
14032: #$syval.=$1;
14033: #}
1.37 www 14034: } else {
14035: # ------------------------------------------------------- Was not in symb table
1.620 albertel 14036: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
1.256 albertel 14037: &GDBM_READER(),0640)) {
1.37 www 14038: # ---------------------------------------------- Get ID(s) for current resource
1.280 www 14039: my $ids=$bighash{'ids_'.&clutter($thisfn)};
1.65 www 14040: unless ($ids) {
14041: $ids=$bighash{'ids_/'.$thisfn};
1.242 www 14042: }
14043: unless ($ids) {
14044: # alias?
14045: $ids=$bighash{'mapalias_'.$thisfn};
1.65 www 14046: }
1.37 www 14047: if ($ids) {
14048: # ------------------------------------------------------------------- Has ID(s)
14049: my @possibilities=split(/\,/,$ids);
1.39 www 14050: if ($#possibilities==0) {
14051: # ----------------------------------------------- There is only one possibility
1.37 www 14052: my ($mapid,$resid)=split(/\./,$ids);
1.626 albertel 14053: $syval=&encode_symb($bighash{'map_id_'.$mapid},
14054: $resid,$thisfn);
1.1282 raeburn 14055: if (ref($possibles) eq 'HASH') {
1.1424 raeburn 14056: unless ($bighash{'randomout_'.$ids} || $env{'request.role.adv'}) {
14057: $possibles->{$syval} = 1;
14058: }
1.1282 raeburn 14059: }
14060: if ($checkforblock) {
1.1424 raeburn 14061: unless ($bighash{'randomout_'.$ids} || $env{'request.role.adv'}) {
1.1426 raeburn 14062: my @blockers = &has_comm_blocking('bre',$syval,$bighash{'src_'.$ids},'',$noenccheck);
1.1424 raeburn 14063: if (@blockers) {
14064: $syval = '';
1.1425 raeburn 14065: untie(%bighash);
14066: return $env{$cache_str}='';
1.1424 raeburn 14067: }
1.1282 raeburn 14068: }
14069: }
14070: } elsif ((!$donotrecurse) || ($checkforblock) || (ref($possibles) eq 'HASH')) {
1.39 www 14071: # ------------------------------------------ There is more than one possibility
14072: my $realpossible=0;
1.800 albertel 14073: foreach my $id (@possibilities) {
14074: my $file=$bighash{'src_'.$id};
1.1282 raeburn 14075: my $canaccess;
14076: if (($donotrecurse) || ($checkforblock) || (ref($possibles) eq 'HASH')) {
14077: $canaccess = 1;
14078: } else {
14079: $canaccess = &allowed('bre',$file);
14080: }
14081: if ($canaccess) {
14082: my ($mapid,$resid)=split(/\./,$id);
14083: if ($bighash{'map_type_'.$mapid} ne 'page') {
14084: my $poss_syval=&encode_symb($bighash{'map_id_'.$mapid},
14085: $resid,$thisfn);
1.1424 raeburn 14086: next if ($bighash{'randomout_'.$id} && !$env{'request.role.adv'});
1.1426 raeburn 14087: next unless (($noenccheck) || ($bighash{'encrypted_'.$id} eq $env{'request.enc'}));
1.1282 raeburn 14088: if ($checkforblock) {
1.1426 raeburn 14089: my @blockers = &has_comm_blocking('bre',$poss_syval,$file,'',$noenccheck);
1.1424 raeburn 14090: if (@blockers > 0) {
14091: $syval = '';
14092: } else {
1.1282 raeburn 14093: $syval = $poss_syval;
14094: $realpossible++;
14095: }
14096: } else {
14097: $syval = $poss_syval;
14098: $realpossible++;
14099: }
1.1424 raeburn 14100: if ($syval) {
14101: if (ref($possibles) eq 'HASH') {
14102: $possibles->{$syval} = 1;
14103: }
14104: }
1.1282 raeburn 14105: }
1.39 www 14106: }
1.191 harris41 14107: }
1.39 www 14108: if ($realpossible!=1) { $syval=''; }
1.249 www 14109: } else {
14110: $syval='';
1.37 www 14111: }
14112: }
1.1282 raeburn 14113: untie(%bighash);
1.481 raeburn 14114: }
1.31 www 14115: }
1.62 www 14116: if ($syval) {
1.1427 raeburn 14117: return $env{$cache_str}=$syval;
1.62 www 14118: }
1.31 www 14119: }
1.949 raeburn 14120: &appenv({'request.ambiguous' => $thisfn});
1.620 albertel 14121: return $env{$cache_str}='';
1.31 www 14122: }
14123:
14124: # ---------------------------------------------------------- Return random seed
14125:
1.32 www 14126: sub numval {
14127: my $txt=shift;
14128: $txt=~tr/A-J/0-9/;
14129: $txt=~tr/a-j/0-9/;
14130: $txt=~tr/K-T/0-9/;
14131: $txt=~tr/k-t/0-9/;
14132: $txt=~tr/U-Z/0-5/;
14133: $txt=~tr/u-z/0-5/;
14134: $txt=~s/\D//g;
1.564 albertel 14135: if ($_64bit) { if ($txt > 2**32) { return -1; } }
1.32 www 14136: return int($txt);
1.368 albertel 14137: }
14138:
1.484 albertel 14139: sub numval2 {
14140: my $txt=shift;
14141: $txt=~tr/A-J/0-9/;
14142: $txt=~tr/a-j/0-9/;
14143: $txt=~tr/K-T/0-9/;
14144: $txt=~tr/k-t/0-9/;
14145: $txt=~tr/U-Z/0-5/;
14146: $txt=~tr/u-z/0-5/;
14147: $txt=~s/\D//g;
14148: my @txts=split(/(\d\d\d\d\d\d\d\d\d)/,$txt);
14149: my $total;
14150: foreach my $val (@txts) { $total+=$val; }
1.564 albertel 14151: if ($_64bit) { if ($total > 2**32) { return -1; } }
1.484 albertel 14152: return int($total);
14153: }
14154:
1.575 albertel 14155: sub numval3 {
14156: use integer;
14157: my $txt=shift;
14158: $txt=~tr/A-J/0-9/;
14159: $txt=~tr/a-j/0-9/;
14160: $txt=~tr/K-T/0-9/;
14161: $txt=~tr/k-t/0-9/;
14162: $txt=~tr/U-Z/0-5/;
14163: $txt=~tr/u-z/0-5/;
14164: $txt=~s/\D//g;
14165: my @txts=split(/(\d\d\d\d\d\d\d\d\d)/,$txt);
14166: my $total;
14167: foreach my $val (@txts) { $total+=$val; }
14168: if ($_64bit) { $total=(($total<<32)>>32); }
14169: return $total;
14170: }
14171:
1.675 albertel 14172: sub digest {
14173: my ($data)=@_;
14174: my $digest=&Digest::MD5::md5($data);
14175: my ($a,$b,$c,$d)=unpack("iiii",$digest);
14176: my ($e,$f);
14177: {
14178: use integer;
14179: $e=($a+$b);
14180: $f=($c+$d);
14181: if ($_64bit) {
14182: $e=(($e<<32)>>32);
14183: $f=(($f<<32)>>32);
14184: }
14185: }
14186: if (wantarray) {
14187: return ($e,$f);
14188: } else {
14189: my $g;
14190: {
14191: use integer;
14192: $g=($e+$f);
14193: if ($_64bit) {
14194: $g=(($g<<32)>>32);
14195: }
14196: }
14197: return $g;
14198: }
14199: }
14200:
1.368 albertel 14201: sub latest_rnd_algorithm_id {
1.675 albertel 14202: return '64bit5';
1.366 albertel 14203: }
1.32 www 14204:
1.503 albertel 14205: sub get_rand_alg {
14206: my ($courseid)=@_;
1.790 albertel 14207: if (!$courseid) { $courseid=(&whichuser())[1]; }
1.503 albertel 14208: if ($courseid) {
1.620 albertel 14209: return $env{"course.$courseid.rndseed"};
1.503 albertel 14210: }
14211: return &latest_rnd_algorithm_id();
14212: }
14213:
1.562 albertel 14214: sub validCODE {
14215: my ($CODE)=@_;
14216: if (defined($CODE) && $CODE ne '' && $CODE =~ /^\w+$/) { return 1; }
14217: return 0;
14218: }
14219:
1.491 albertel 14220: sub getCODE {
1.620 albertel 14221: if (&validCODE($env{'form.CODE'})) { return $env{'form.CODE'}; }
1.618 albertel 14222: if ( (defined($Apache::lonhomework::parsing_a_problem) ||
14223: defined($Apache::lonhomework::parsing_a_task) ) &&
14224: &validCODE($Apache::lonhomework::history{'resource.CODE'})) {
1.491 albertel 14225: return $Apache::lonhomework::history{'resource.CODE'};
14226: }
14227: return undef;
14228: }
1.1133 foxr 14229: #
14230: # Determines the random seed for a specific context:
14231: #
14232: # parameters:
14233: # symb - in course context the symb for the seed.
14234: # course_id - The course id of the form domain_coursenum.
14235: # domain - Domain for the user.
14236: # course - Course for the user.
14237: # cenv - environment of the course.
14238: #
14239: # NOTE:
14240: # All parameters are picked out of the environment if missing
14241: # or not defined.
14242: # If a symb cannot be determined the current time is used instead.
14243: #
14244: # For a given well defined symb, courside, domain, username,
14245: # and course environment, the seed is reproducible.
14246: #
1.31 www 14247: sub rndseed {
1.1133 foxr 14248: my ($symb,$courseid,$domain,$username, $cenv)=@_;
1.790 albertel 14249: my ($wsymb,$wcourseid,$wdomain,$wusername)=&whichuser();
1.896 albertel 14250: if (!defined($symb)) {
1.366 albertel 14251: unless ($symb=$wsymb) { return time; }
14252: }
1.1146 foxr 14253: if (!defined $courseid) {
14254: $courseid=$wcourseid;
14255: }
14256: if (!defined $domain) { $domain=$wdomain; }
14257: if (!defined $username) { $username=$wusername }
1.1133 foxr 14258:
14259: my $which;
14260: if (defined($cenv->{'rndseed'})) {
14261: $which = $cenv->{'rndseed'};
14262: } else {
14263: $which =&get_rand_alg($courseid);
14264: }
1.491 albertel 14265: if (defined(&getCODE())) {
1.1133 foxr 14266:
1.675 albertel 14267: if ($which eq '64bit5') {
14268: return &rndseed_CODE_64bit5($symb,$courseid,$domain,$username);
14269: } elsif ($which eq '64bit4') {
1.575 albertel 14270: return &rndseed_CODE_64bit4($symb,$courseid,$domain,$username);
14271: } else {
14272: return &rndseed_CODE_64bit($symb,$courseid,$domain,$username);
14273: }
1.675 albertel 14274: } elsif ($which eq '64bit5') {
14275: return &rndseed_64bit5($symb,$courseid,$domain,$username);
1.575 albertel 14276: } elsif ($which eq '64bit4') {
14277: return &rndseed_64bit4($symb,$courseid,$domain,$username);
1.501 albertel 14278: } elsif ($which eq '64bit3') {
14279: return &rndseed_64bit3($symb,$courseid,$domain,$username);
1.443 albertel 14280: } elsif ($which eq '64bit2') {
14281: return &rndseed_64bit2($symb,$courseid,$domain,$username);
1.366 albertel 14282: } elsif ($which eq '64bit') {
14283: return &rndseed_64bit($symb,$courseid,$domain,$username);
14284: }
14285: return &rndseed_32bit($symb,$courseid,$domain,$username);
14286: }
14287:
14288: sub rndseed_32bit {
14289: my ($symb,$courseid,$domain,$username)=@_;
14290: {
14291: use integer;
14292: my $symbchck=unpack("%32C*",$symb) << 27;
14293: my $symbseed=numval($symb) << 22;
14294: my $namechck=unpack("%32C*",$username) << 17;
14295: my $nameseed=numval($username) << 12;
14296: my $domainseed=unpack("%32C*",$domain) << 7;
14297: my $courseseed=unpack("%32C*",$courseid);
14298: my $num=$symbseed+$nameseed+$domainseed+$courseseed+$namechck+$symbchck;
1.790 albertel 14299: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
14300: #&logthis("rndseed :$num:$symb");
1.564 albertel 14301: if ($_64bit) { $num=(($num<<32)>>32); }
1.366 albertel 14302: return $num;
14303: }
14304: }
14305:
14306: sub rndseed_64bit {
14307: my ($symb,$courseid,$domain,$username)=@_;
14308: {
14309: use integer;
14310: my $symbchck=unpack("%32S*",$symb) << 21;
14311: my $symbseed=numval($symb) << 10;
14312: my $namechck=unpack("%32S*",$username);
14313:
14314: my $nameseed=numval($username) << 21;
14315: my $domainseed=unpack("%32S*",$domain) << 10;
14316: my $courseseed=unpack("%32S*",$courseid);
14317:
14318: my $num1=$symbchck+$symbseed+$namechck;
14319: my $num2=$nameseed+$domainseed+$courseseed;
1.790 albertel 14320: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
14321: #&logthis("rndseed :$num:$symb");
1.564 albertel 14322: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
1.366 albertel 14323: return "$num1,$num2";
1.155 albertel 14324: }
1.366 albertel 14325: }
14326:
1.443 albertel 14327: sub rndseed_64bit2 {
14328: my ($symb,$courseid,$domain,$username)=@_;
14329: {
14330: use integer;
14331: # strings need to be an even # of cahracters long, it it is odd the
14332: # last characters gets thrown away
14333: my $symbchck=unpack("%32S*",$symb.' ') << 21;
14334: my $symbseed=numval($symb) << 10;
14335: my $namechck=unpack("%32S*",$username.' ');
14336:
14337: my $nameseed=numval($username) << 21;
1.501 albertel 14338: my $domainseed=unpack("%32S*",$domain.' ') << 10;
14339: my $courseseed=unpack("%32S*",$courseid.' ');
14340:
14341: my $num1=$symbchck+$symbseed+$namechck;
14342: my $num2=$nameseed+$domainseed+$courseseed;
1.790 albertel 14343: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
14344: #&logthis("rndseed :$num:$symb");
1.803 albertel 14345: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
1.501 albertel 14346: return "$num1,$num2";
14347: }
14348: }
14349:
14350: sub rndseed_64bit3 {
14351: my ($symb,$courseid,$domain,$username)=@_;
14352: {
14353: use integer;
14354: # strings need to be an even # of cahracters long, it it is odd the
14355: # last characters gets thrown away
14356: my $symbchck=unpack("%32S*",$symb.' ') << 21;
14357: my $symbseed=numval2($symb) << 10;
14358: my $namechck=unpack("%32S*",$username.' ');
14359:
14360: my $nameseed=numval2($username) << 21;
1.443 albertel 14361: my $domainseed=unpack("%32S*",$domain.' ') << 10;
14362: my $courseseed=unpack("%32S*",$courseid.' ');
14363:
14364: my $num1=$symbchck+$symbseed+$namechck;
14365: my $num2=$nameseed+$domainseed+$courseseed;
1.790 albertel 14366: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
14367: #&logthis("rndseed :$num1:$num2:$_64bit");
1.564 albertel 14368: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
1.1110 www 14369:
1.503 albertel 14370: return "$num1:$num2";
1.443 albertel 14371: }
14372: }
14373:
1.575 albertel 14374: sub rndseed_64bit4 {
14375: my ($symb,$courseid,$domain,$username)=@_;
14376: {
14377: use integer;
14378: # strings need to be an even # of cahracters long, it it is odd the
14379: # last characters gets thrown away
14380: my $symbchck=unpack("%32S*",$symb.' ') << 21;
14381: my $symbseed=numval3($symb) << 10;
14382: my $namechck=unpack("%32S*",$username.' ');
14383:
14384: my $nameseed=numval3($username) << 21;
14385: my $domainseed=unpack("%32S*",$domain.' ') << 10;
14386: my $courseseed=unpack("%32S*",$courseid.' ');
14387:
14388: my $num1=$symbchck+$symbseed+$namechck;
14389: my $num2=$nameseed+$domainseed+$courseseed;
1.790 albertel 14390: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
14391: #&logthis("rndseed :$num1:$num2:$_64bit");
1.575 albertel 14392: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
1.1110 www 14393:
1.575 albertel 14394: return "$num1:$num2";
14395: }
14396: }
14397:
1.675 albertel 14398: sub rndseed_64bit5 {
14399: my ($symb,$courseid,$domain,$username)=@_;
14400: my ($num1,$num2)=&digest("$symb,$courseid,$domain,$username");
14401: return "$num1:$num2";
14402: }
14403:
1.366 albertel 14404: sub rndseed_CODE_64bit {
14405: my ($symb,$courseid,$domain,$username)=@_;
1.155 albertel 14406: {
1.366 albertel 14407: use integer;
1.443 albertel 14408: my $symbchck=unpack("%32S*",$symb.' ') << 16;
1.484 albertel 14409: my $symbseed=numval2($symb);
1.491 albertel 14410: my $CODEchck=unpack("%32S*",&getCODE().' ') << 16;
14411: my $CODEseed=numval(&getCODE());
1.443 albertel 14412: my $courseseed=unpack("%32S*",$courseid.' ');
1.484 albertel 14413: my $num1=$symbseed+$CODEchck;
14414: my $num2=$CODEseed+$courseseed+$symbchck;
1.790 albertel 14415: #&logthis("$symbseed:$CODEchck|$CODEseed:$courseseed:$symbchck");
14416: #&logthis("rndseed :$num1:$num2:$symb");
1.564 albertel 14417: if ($_64bit) { $num1=(($num1<<32)>>32); }
14418: if ($_64bit) { $num2=(($num2<<32)>>32); }
1.503 albertel 14419: return "$num1:$num2";
1.366 albertel 14420: }
14421: }
14422:
1.575 albertel 14423: sub rndseed_CODE_64bit4 {
14424: my ($symb,$courseid,$domain,$username)=@_;
14425: {
14426: use integer;
14427: my $symbchck=unpack("%32S*",$symb.' ') << 16;
14428: my $symbseed=numval3($symb);
14429: my $CODEchck=unpack("%32S*",&getCODE().' ') << 16;
14430: my $CODEseed=numval3(&getCODE());
14431: my $courseseed=unpack("%32S*",$courseid.' ');
14432: my $num1=$symbseed+$CODEchck;
14433: my $num2=$CODEseed+$courseseed+$symbchck;
1.790 albertel 14434: #&logthis("$symbseed:$CODEchck|$CODEseed:$courseseed:$symbchck");
14435: #&logthis("rndseed :$num1:$num2:$symb");
1.575 albertel 14436: if ($_64bit) { $num1=(($num1<<32)>>32); }
14437: if ($_64bit) { $num2=(($num2<<32)>>32); }
14438: return "$num1:$num2";
14439: }
14440: }
14441:
1.675 albertel 14442: sub rndseed_CODE_64bit5 {
14443: my ($symb,$courseid,$domain,$username)=@_;
14444: my $code = &getCODE();
14445: my ($num1,$num2)=&digest("$symb,$courseid,$code");
14446: return "$num1:$num2";
14447: }
14448:
1.366 albertel 14449: sub setup_random_from_rndseed {
14450: my ($rndseed)=@_;
1.503 albertel 14451: if ($rndseed =~/([,:])/) {
1.1262 raeburn 14452: my ($num1,$num2) = map { abs($_); } (split(/[,:]/,$rndseed));
14453: if ((!$num1) || (!$num2) || ($num1 > 2147483562) || ($num2 > 2147483398)) {
14454: &Math::Random::random_set_seed_from_phrase($rndseed);
14455: } else {
14456: &Math::Random::random_set_seed($num1,$num2);
14457: }
1.366 albertel 14458: } else {
14459: &Math::Random::random_set_seed_from_phrase($rndseed);
1.98 albertel 14460: }
1.36 albertel 14461: }
14462:
1.474 albertel 14463: sub latest_receipt_algorithm_id {
1.835 albertel 14464: return 'receipt3';
1.474 albertel 14465: }
14466:
1.480 www 14467: sub recunique {
14468: my $fucourseid=shift;
14469: my $unique;
1.835 albertel 14470: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2' ||
14471: $env{"course.$fucourseid.receiptalg"} eq 'receipt3' ) {
1.620 albertel 14472: $unique=$env{"course.$fucourseid.internal.encseed"};
1.480 www 14473: } else {
14474: $unique=$perlvar{'lonReceipt'};
14475: }
14476: return unpack("%32C*",$unique);
14477: }
14478:
14479: sub recprefix {
14480: my $fucourseid=shift;
14481: my $prefix;
1.835 albertel 14482: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2'||
14483: $env{"course.$fucourseid.receiptalg"} eq 'receipt3' ) {
1.620 albertel 14484: $prefix=$env{"course.$fucourseid.internal.encpref"};
1.480 www 14485: } else {
14486: $prefix=$perlvar{'lonHostID'};
14487: }
14488: return unpack("%32C*",$prefix);
14489: }
14490:
1.76 www 14491: sub ireceipt {
1.474 albertel 14492: my ($funame,$fudom,$fucourseid,$fusymb,$part)=@_;
1.835 albertel 14493:
14494: my $return =&recprefix($fucourseid).'-';
14495:
14496: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt3' ||
14497: $env{'request.state'} eq 'construct') {
14498: $return .= (&digest("$funame,$fudom,$fucourseid,$fusymb,$part")%10000);
14499: return $return;
14500: }
14501:
1.76 www 14502: my $cuname=unpack("%32C*",$funame);
14503: my $cudom=unpack("%32C*",$fudom);
14504: my $cucourseid=unpack("%32C*",$fucourseid);
14505: my $cusymb=unpack("%32C*",$fusymb);
1.480 www 14506: my $cunique=&recunique($fucourseid);
1.474 albertel 14507: my $cpart=unpack("%32S*",$part);
1.835 albertel 14508: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2') {
14509:
1.790 albertel 14510: #&logthis("doing receipt2 using parts $cpart, uname $cuname and udom $cudom gets ".($cpart%$cuname)." and ".($cpart%$cudom));
1.474 albertel 14511:
14512: $return.= ($cunique%$cuname+
14513: $cunique%$cudom+
14514: $cusymb%$cuname+
14515: $cusymb%$cudom+
14516: $cucourseid%$cuname+
14517: $cucourseid%$cudom+
14518: $cpart%$cuname+
14519: $cpart%$cudom);
14520: } else {
14521: $return.= ($cunique%$cuname+
14522: $cunique%$cudom+
14523: $cusymb%$cuname+
14524: $cusymb%$cudom+
14525: $cucourseid%$cuname+
14526: $cucourseid%$cudom);
14527: }
14528: return $return;
1.76 www 14529: }
14530:
14531: sub receipt {
1.474 albertel 14532: my ($part)=@_;
1.790 albertel 14533: my ($symb,$courseid,$domain,$name) = &whichuser();
1.474 albertel 14534: return &ireceipt($name,$domain,$courseid,$symb,$part);
1.76 www 14535: }
1.260 ng 14536:
1.790 albertel 14537: sub whichuser {
14538: my ($passedsymb)=@_;
14539: my ($symb,$courseid,$domain,$name,$publicuser);
14540: if (defined($env{'form.grade_symb'})) {
14541: my ($tmp_courseid)=&get_env_multiple('form.grade_courseid');
14542: my $allowed=&allowed('vgr',$tmp_courseid);
14543: if (!$allowed &&
14544: exists($env{'request.course.sec'}) &&
14545: $env{'request.course.sec'} !~ /^\s*$/) {
14546: $allowed=&allowed('vgr',$tmp_courseid.
14547: '/'.$env{'request.course.sec'});
14548: }
14549: if ($allowed) {
14550: ($symb)=&get_env_multiple('form.grade_symb');
14551: $courseid=$tmp_courseid;
14552: ($domain)=&get_env_multiple('form.grade_domain');
14553: ($name)=&get_env_multiple('form.grade_username');
14554: return ($symb,$courseid,$domain,$name,$publicuser);
14555: }
14556: }
14557: if (!$passedsymb) {
14558: $symb=&symbread();
14559: } else {
14560: $symb=$passedsymb;
14561: }
14562: $courseid=$env{'request.course.id'};
14563: $domain=$env{'user.domain'};
14564: $name=$env{'user.name'};
14565: if ($name eq 'public' && $domain eq 'public') {
14566: if (!defined($env{'form.username'})) {
14567: $env{'form.username'}.=time.rand(10000000);
14568: }
14569: $name.=$env{'form.username'};
14570: }
14571: return ($symb,$courseid,$domain,$name,$publicuser);
14572:
14573: }
14574:
1.36 albertel 14575: # ------------------------------------------------------------ Serves up a file
1.472 albertel 14576: # returns either the contents of the file or
14577: # -1 if the file doesn't exist
1.481 raeburn 14578: #
14579: # if the target is a file that was uploaded via DOCS,
14580: # a check will be made to see if a current copy exists on the local server,
14581: # if it does this will be served, otherwise a copy will be retrieved from
14582: # the home server for the course and stored in /home/httpd/html/userfiles on
14583: # the local server.
1.472 albertel 14584:
1.36 albertel 14585: sub getfile {
1.538 albertel 14586: my ($file) = @_;
1.609 banghart 14587: if ($file =~ m -^/*(uploaded|editupload)/-) { $file=&filelocation("",$file); }
1.538 albertel 14588: &repcopy($file);
14589: return &readfile($file);
14590: }
14591:
14592: sub repcopy_userfile {
14593: my ($file)=@_;
1.1142 raeburn 14594: my $londocroot = $perlvar{'lonDocRoot'};
14595: if ($file =~ m{^/*(uploaded|editupload)/}) { $file=&filelocation("",$file); }
1.1164 raeburn 14596: if ($file =~ m{^\Q/home/httpd/lonUsers/\E}) { return 'ok'; }
1.538 albertel 14597: my ($cdom,$cnum,$filename) =
1.811 albertel 14598: ($file=~m|^\Q$perlvar{'lonDocRoot'}\E/+userfiles/+($match_domain)/+($match_name)/+(.*)|);
1.538 albertel 14599: my $uri="/uploaded/$cdom/$cnum/$filename";
14600: if (-e "$file") {
1.828 www 14601: # we already have a local copy, check it out
1.538 albertel 14602: my @fileinfo = stat($file);
1.828 www 14603: my $rtncode;
14604: my $info;
1.538 albertel 14605: my $lwpresp = &getuploaded('HEAD',$uri,$cdom,$cnum,\$info,\$rtncode);
1.482 albertel 14606: if ($lwpresp ne 'ok') {
1.828 www 14607: # there is no such file anymore, even though we had a local copy
1.482 albertel 14608: if ($rtncode eq '404') {
1.538 albertel 14609: unlink($file);
1.482 albertel 14610: }
14611: return -1;
14612: }
14613: if ($info < $fileinfo[9]) {
1.828 www 14614: # nice, the file we have is up-to-date, just say okay
1.607 raeburn 14615: return 'ok';
1.828 www 14616: } else {
14617: # the file is outdated, get rid of it
14618: unlink($file);
1.482 albertel 14619: }
1.828 www 14620: }
14621: # one way or the other, at this point, we don't have the file
14622: # construct the correct path for the file
14623: my @parts = ($cdom,$cnum);
14624: if ($filename =~ m|^(.+)/[^/]+$|) {
14625: push @parts, split(/\//,$1);
14626: }
14627: my $path = $perlvar{'lonDocRoot'}.'/userfiles';
14628: foreach my $part (@parts) {
14629: $path .= '/'.$part;
14630: if (!-e $path) {
14631: mkdir($path,0770);
1.482 albertel 14632: }
14633: }
1.828 www 14634: # now the path exists for sure
14635: # get a user agent
14636: my $transferfile=$file.'.in.transfer';
14637: # FIXME: this should flock
14638: if (-e $transferfile) { return 'ok'; }
14639: my $request;
14640: $uri=~s/^\///;
1.980 raeburn 14641: my $homeserver = &homeserver($cnum,$cdom);
1.1398 raeburn 14642: my $hostname = &hostname($homeserver);
1.980 raeburn 14643: my $protocol = $protocol{$homeserver};
14644: $protocol = 'http' if ($protocol ne 'https');
1.1397 raeburn 14645: $request=new HTTP::Request('GET',$protocol.'://'.$hostname.'/raw/'.$uri);
1.1345 raeburn 14646: my $response = &LONCAPA::LWPReq::makerequest($homeserver,$request,$transferfile,\%perlvar,'',0,1);
1.828 www 14647: # did it work?
14648: if ($response->is_error()) {
14649: unlink($transferfile);
14650: &logthis("Userfile repcopy failed for $uri");
14651: return -1;
14652: }
14653: # worked, rename the transfer file
14654: rename($transferfile,$file);
1.607 raeburn 14655: return 'ok';
1.481 raeburn 14656: }
14657:
1.517 albertel 14658: sub tokenwrapper {
14659: my $uri=shift;
1.980 raeburn 14660: $uri=~s|^https?\://([^/]+)||;
1.552 albertel 14661: $uri=~s|^/||;
1.620 albertel 14662: $env{'user.environment'}=~/\/([^\/]+)\.id/;
1.517 albertel 14663: my $token=$1;
1.552 albertel 14664: my (undef,$udom,$uname,$file)=split('/',$uri,4);
14665: if ($udom && $uname && $file) {
14666: $file=~s|(\?\.*)*$||;
1.949 raeburn 14667: &appenv({"userfile.$udom/$uname/$file" => $env{'request.course.id'}});
1.980 raeburn 14668: my $homeserver = &homeserver($uname,$udom);
1.1397 raeburn 14669: my $hostname = &hostname($homeserver);
1.980 raeburn 14670: my $protocol = $protocol{$homeserver};
14671: $protocol = 'http' if ($protocol ne 'https');
1.1397 raeburn 14672: return $protocol.'://'.$hostname.'/'.$uri.
1.517 albertel 14673: (($uri=~/\?/)?'&':'?').'token='.$token.
14674: '&tokenissued='.$perlvar{'lonHostID'};
14675: } else {
14676: return '/adm/notfound.html';
14677: }
14678: }
14679:
1.828 www 14680: # call with reqtype HEAD: get last modification time
14681: # call with reqtype GET: get the file contents
14682: # Do not call this with reqtype GET for large files! It loads everything into memory
14683: #
1.481 raeburn 14684: sub getuploaded {
14685: my ($reqtype,$uri,$cdom,$cnum,$info,$rtncode) = @_;
14686: $uri=~s/^\///;
1.980 raeburn 14687: my $homeserver = &homeserver($cnum,$cdom);
1.1397 raeburn 14688: my $hostname = &hostname($homeserver);
1.980 raeburn 14689: my $protocol = $protocol{$homeserver};
14690: $protocol = 'http' if ($protocol ne 'https');
1.1397 raeburn 14691: $uri = $protocol.'://'.$hostname.'/raw/'.$uri;
1.481 raeburn 14692: my $request=new HTTP::Request($reqtype,$uri);
1.1345 raeburn 14693: my $response=&LONCAPA::LWPReq::makerequest($homeserver,$request,'',\%perlvar,'',0,1);
1.481 raeburn 14694: $$rtncode = $response->code;
1.482 albertel 14695: if (! $response->is_success()) {
14696: return 'failed';
14697: }
14698: if ($reqtype eq 'HEAD') {
1.486 www 14699: $$info = &HTTP::Date::str2time( $response->header('Last-modified') );
1.482 albertel 14700: } elsif ($reqtype eq 'GET') {
14701: $$info = $response->content;
1.472 albertel 14702: }
1.482 albertel 14703: return 'ok';
1.36 albertel 14704: }
14705:
1.481 raeburn 14706: sub readfile {
14707: my $file = shift;
14708: if ( (! -e $file ) || ($file eq '') ) { return -1; };
14709: my $fh;
1.1359 raeburn 14710: open($fh,"<",$file);
1.481 raeburn 14711: my $a='';
1.800 albertel 14712: while (my $line = <$fh>) { $a .= $line; }
1.481 raeburn 14713: return $a;
14714: }
14715:
1.36 albertel 14716: sub filelocation {
1.590 banghart 14717: my ($dir,$file) = @_;
14718: my $location;
14719: $file=~ s/^\s*(\S+)\s*$/$1/; ## strip off leading and trailing spaces
1.700 albertel 14720:
14721: if ($file =~ m-^/adm/-) {
14722: $file=~s-^/adm/wrapper/-/-;
14723: $file=~s-^/adm/coursedocs/showdoc/-/-;
14724: }
1.882 albertel 14725:
1.1139 www 14726: if ($file =~ m-^\Q$Apache::lonnet::perlvar{'lonTabDir'}\E/-) {
1.956 raeburn 14727: $location = $file;
1.609 banghart 14728: } elsif ($file=~/^\/*(uploaded|editupload)/) { # is an uploaded file
1.590 banghart 14729: my ($udom,$uname,$filename)=
1.811 albertel 14730: ($file=~m -^/+(?:uploaded|editupload)/+($match_domain)/+($match_name)/+(.*)$-);
1.590 banghart 14731: my $home=&homeserver($uname,$udom);
14732: my $is_me=0;
14733: my @ids=¤t_machine_ids();
14734: foreach my $id (@ids) { if ($id eq $home) { $is_me=1; } }
14735: if ($is_me) {
1.1117 foxr 14736: $location=propath($udom,$uname).'/userfiles/'.$filename;
1.590 banghart 14737: } else {
14738: $location=$Apache::lonnet::perlvar{'lonDocRoot'}.'/userfiles/'.
14739: $udom.'/'.$uname.'/'.$filename;
14740: }
1.882 albertel 14741: } elsif ($file =~ m-^/adm/-) {
14742: $location = $perlvar{'lonDocRoot'}.'/'.$file;
1.590 banghart 14743: } else {
14744: $file=~s/^\Q$perlvar{'lonDocRoot'}\E//;
1.1139 www 14745: $file=~s:^/(res|priv)/:/:;
14746: my $space=$1;
1.590 banghart 14747: if ( !( $file =~ m:^/:) ) {
14748: $location = $dir. '/'.$file;
14749: } else {
1.1142 raeburn 14750: $location = $perlvar{'lonDocRoot'}.'/'.$space.$file;
1.590 banghart 14751: }
1.59 albertel 14752: }
1.590 banghart 14753: $location=~s://+:/:g; # remove duplicate /
1.930 albertel 14754: while ($location=~m{/\.\./}) {
14755: if ($location =~ m{/[^/]+/\.\./}) {
14756: $location=~ s{/[^/]+/\.\./}{/}g;
14757: } else {
14758: $location=~ s{/\.\./}{/}g;
14759: }
14760: } #remove dir/..
1.590 banghart 14761: while ($location=~m:/\./:) {$location=~ s:/\./:/:g;} #remove /./
14762: return $location;
1.46 www 14763: }
1.36 albertel 14764:
1.46 www 14765: sub hreflocation {
14766: my ($dir,$file)=@_;
1.980 raeburn 14767: unless (($file=~m-^https?\://-i) || ($file=~m-^/-)) {
1.666 albertel 14768: $file=filelocation($dir,$file);
1.700 albertel 14769: } elsif ($file=~m-^/adm/-) {
14770: $file=~s-^/adm/wrapper/-/-;
14771: $file=~s-^/adm/coursedocs/showdoc/-/-;
1.666 albertel 14772: }
14773: if ($file=~m-^\Q$perlvar{'lonDocRoot'}\E-) {
14774: $file=~s-^\Q$perlvar{'lonDocRoot'}\E--;
14775: } elsif ($file=~m-^\Q$perlvar{'lonUsersDir'}\E-) {
1.1143 raeburn 14776: $file=~s{^/home/httpd/lonUsers/($match_domain)/./././($match_name)/userfiles/}
14777: {/uploaded/$1/$2/}x;
1.46 www 14778: }
1.913 albertel 14779: if ($file=~ m{^/userfiles/}) {
14780: $file =~ s{^/userfiles/}{/uploaded/};
14781: }
1.462 albertel 14782: return $file;
1.465 albertel 14783: }
14784:
1.1139 www 14785:
14786:
14787:
14788:
1.465 albertel 14789: sub current_machine_domains {
1.853 albertel 14790: return &machine_domains(&hostname($perlvar{'lonHostID'}));
14791: }
14792:
14793: sub machine_domains {
14794: my ($hostname) = @_;
1.465 albertel 14795: my @domains;
1.838 albertel 14796: my %hostname = &all_hostnames();
1.465 albertel 14797: while( my($id, $name) = each(%hostname)) {
1.467 matthew 14798: # &logthis("-$id-$name-$hostname-");
1.465 albertel 14799: if ($hostname eq $name) {
1.844 albertel 14800: push(@domains,&host_domain($id));
1.465 albertel 14801: }
14802: }
14803: return @domains;
14804: }
14805:
14806: sub current_machine_ids {
1.853 albertel 14807: return &machine_ids(&hostname($perlvar{'lonHostID'}));
14808: }
14809:
14810: sub machine_ids {
14811: my ($hostname) = @_;
14812: $hostname ||= &hostname($perlvar{'lonHostID'});
1.465 albertel 14813: my @ids;
1.888 albertel 14814: my %name_to_host = &all_names();
1.889 albertel 14815: if (ref($name_to_host{$hostname}) eq 'ARRAY') {
14816: return @{ $name_to_host{$hostname} };
14817: }
14818: return;
1.31 www 14819: }
14820:
1.824 raeburn 14821: sub additional_machine_domains {
14822: my @domains;
1.1466 raeburn 14823: if (-e "$perlvar{'lonTabDir'}/expected_domains.tab") {
14824: if (open(my $fh,"<","$perlvar{'lonTabDir'}/expected_domains.tab")) {
14825: while (my $line = <$fh>) {
14826: chomp($line);
14827: $line =~ s/\s//g;
14828: push(@domains,$line);
14829: }
14830: close($fh);
14831: }
1.824 raeburn 14832: }
14833: return @domains;
14834: }
14835:
14836: sub default_login_domain {
14837: my $domain = $perlvar{'lonDefDomain'};
14838: my $testdomain=(split(/\./,$ENV{'HTTP_HOST'}))[0];
14839: foreach my $posdom (¤t_machine_domains(),
14840: &additional_machine_domains()) {
14841: if (lc($posdom) eq lc($testdomain)) {
14842: $domain=$posdom;
14843: last;
14844: }
14845: }
14846: return $domain;
14847: }
14848:
1.1414 raeburn 14849: sub shared_institution {
1.1439 raeburn 14850: my ($dom,$lonhost) = @_;
14851: if ($lonhost eq '') {
14852: $lonhost = $perlvar{'lonHostID'};
14853: }
1.1414 raeburn 14854: my $same_intdom;
1.1439 raeburn 14855: my $hostintdom = &internet_dom($lonhost);
1.1414 raeburn 14856: if ($hostintdom ne '') {
14857: my %iphost = &get_iphost();
14858: my $primary_id = &domain($dom,'primary');
14859: my $primary_ip = &get_host_ip($primary_id);
14860: if (ref($iphost{$primary_ip}) eq 'ARRAY') {
14861: foreach my $id (@{$iphost{$primary_ip}}) {
14862: my $intdom = &internet_dom($id);
14863: if ($intdom eq $hostintdom) {
14864: $same_intdom = 1;
14865: last;
14866: }
14867: }
14868: }
14869: }
14870: return $same_intdom;
14871: }
14872:
1.1398 raeburn 14873: sub uses_sts {
14874: my ($ignore_cache) = @_;
14875: my $lonhost = $perlvar{'lonHostID'};
14876: my $hostname = &hostname($lonhost);
14877: my $sts_on;
14878: if ($protocol{$lonhost} eq 'https') {
14879: my $cachetime = 12*3600;
14880: if (!$ignore_cache) {
14881: ($sts_on,my $cached)=&is_cached_new('stspolicy',$lonhost);
14882: if (defined($cached)) {
14883: return $sts_on;
14884: }
14885: }
14886: my $url = $protocol{$lonhost}.'://'.$hostname.'/index.html';
14887: my $request=new HTTP::Request('HEAD',$url);
14888: my $response=&LONCAPA::LWPReq::makerequest($lonhost,$request,'',\%perlvar,'','','',1);
14889: if ($response->is_success) {
14890: my $has_sts = $response->header('Strict-Transport-Security');
14891: if ($has_sts eq '') {
14892: $sts_on = 0;
14893: } else {
14894: if ($has_sts =~ /\Qmax-age=\E(\d+)/) {
14895: my $maxage = $1;
14896: if ($maxage) {
14897: $sts_on = 1;
14898: } else {
14899: $sts_on = 0;
14900: }
14901: } else {
14902: $sts_on = 0;
14903: }
14904: }
14905: return &do_cache_new('stspolicy',$lonhost,$sts_on,$cachetime);
14906: }
14907: }
14908: return;
14909: }
14910:
1.1449 raeburn 14911: sub waf_allssl {
14912: my ($host_name) = @_;
14913: my $alias = &get_proxy_alias();
14914: if ($host_name eq '') {
14915: $host_name = $ENV{'SERVER_NAME'};
14916: }
14917: if (($host_name ne '') && ($alias eq $host_name)) {
14918: my $serverhomedom = &host_domain($perlvar{'lonHostID'});
14919: my %defdomdefaults = &get_domain_defaults($serverhomedom);
14920: if ($defdomdefaults{'waf_sslopt'}) {
14921: return $defdomdefaults{'waf_sslopt'};
14922: }
14923: }
14924: return;
14925: }
14926:
1.1434 raeburn 14927: sub get_requestor_ip {
14928: my ($r,$nolookup,$noproxy) = @_;
14929: my $from_ip;
14930: if (ref($r)) {
1.1447 raeburn 14931: if ($r->can('useragent_ip')) {
14932: if ($noproxy && $r->can('client_ip')) {
14933: $from_ip = $r->client_ip();
14934: } else {
14935: $from_ip = $r->useragent_ip();
14936: }
14937: } elsif ($r->connection->can('remote_ip')) {
14938: $from_ip = $r->connection->remote_ip();
14939: } else {
14940: $from_ip = $r->get_remote_host($nolookup);
14941: }
1.1434 raeburn 14942: } else {
14943: $from_ip = $ENV{'REMOTE_ADDR'};
14944: }
14945: return $from_ip if ($noproxy);
14946: # Who controls proxy settings for server
14947: my $dom_in_use = $Apache::lonnet::perlvar{'lonDefDomain'};
14948: my $proxyinfo = &get_proxy_settings($dom_in_use);
14949: if ((ref($proxyinfo) eq 'HASH') && ($from_ip)) {
1.1437 raeburn 14950: if ($proxyinfo->{'vpnint'}) {
14951: if (&ip_match($from_ip,$proxyinfo->{'vpnint'})) {
1.1434 raeburn 14952: return $from_ip;
14953: }
14954: }
14955: if ($proxyinfo->{'trusted'}) {
14956: if (&ip_match($from_ip,$proxyinfo->{'trusted'})) {
14957: my $ipheader = $proxyinfo->{'ipheader'};
14958: my ($ip,$xfor);
14959: if (ref($r)) {
14960: if ($ipheader) {
14961: $ip = $r->headers_in->{$ipheader};
14962: }
14963: $xfor = $r->headers_in->{'X-Forwarded-For'};
14964: } else {
14965: if ($ipheader) {
14966: $ip = $ENV{'HTTP_'.uc($ipheader)};
14967: }
14968: $xfor = $ENV{'HTTP_X_FORWARDED_FOR'};
14969: }
14970: if (($ip eq '') && ($xfor ne '')) {
14971: foreach my $poss_ip (reverse(split(/\s*,\s*/,$xfor))) {
14972: unless (&ip_match($poss_ip,$proxyinfo->{'trusted'})) {
14973: $ip = $poss_ip;
1.1435 raeburn 14974: last;
1.1434 raeburn 14975: }
14976: }
14977: }
14978: if ($ip ne '') {
14979: return $ip;
14980: }
14981: }
14982: }
14983: }
14984: return $from_ip;
14985: }
14986:
14987: sub get_proxy_settings {
14988: my ($dom_in_use) = @_;
1.1494 raeburn 14989: my %domdefaults = &get_domain_defaults($dom_in_use);
1.1434 raeburn 14990: my $proxyinfo = {
14991: ipheader => $domdefaults{'waf_ipheader'},
14992: trusted => $domdefaults{'waf_trusted'},
1.1437 raeburn 14993: vpnint => $domdefaults{'waf_vpnint'},
1.1438 raeburn 14994: vpnext => $domdefaults{'waf_vpnext'},
1.1449 raeburn 14995: sslopt => $domdefaults{'waf_sslopt'},
1.1434 raeburn 14996: };
14997: return $proxyinfo;
14998: }
14999:
15000: sub ip_match {
15001: my ($ip,$pattern_str) = @_;
15002: $ip=Net::CIDR::cidrvalidate($ip);
15003: if ($ip) {
15004: return Net::CIDR::cidrlookup($ip,split(/\s*,\s*/,$pattern_str));
15005: }
15006: return;
15007: }
15008:
15009: sub get_proxy_alias {
1.1450 raeburn 15010: my ($lonid) = @_;
15011: if ($lonid eq '') {
15012: $lonid = $perlvar{'lonHostID'};
15013: }
15014: if (!defined(&hostname($lonid))) {
15015: return;
15016: }
15017: if ($lonid ne '') {
15018: my ($alias,$cached) = &is_cached_new('proxyalias',$lonid);
1.1434 raeburn 15019: if ($cached) {
15020: return $alias;
15021: }
1.1494 raeburn 15022: my $dom = &host_domain($lonid);
1.1434 raeburn 15023: if ($dom ne '') {
15024: my $cachetime = 60*60*24;
15025: my %domconfig =
1.1494 raeburn 15026: &get_dom('configuration',['wafproxy'],$dom);
1.1437 raeburn 15027: if (ref($domconfig{'wafproxy'}) eq 'HASH') {
15028: if (ref($domconfig{'wafproxy'}{'alias'}) eq 'HASH') {
1.1450 raeburn 15029: $alias = $domconfig{'wafproxy'}{'alias'}{$lonid};
15030: }
15031: }
15032: return &do_cache_new('proxyalias',$lonid,$alias,$cachetime);
15033: }
15034: }
15035: return;
15036: }
15037:
15038: sub use_proxy_alias {
15039: my ($r,$lonid) = @_;
15040: my $alias = &get_proxy_alias($lonid);
15041: if ($alias) {
15042: my $dom = &host_domain($lonid);
15043: if ($dom ne '') {
1.1467 raeburn 15044: my $proxyinfo = &get_proxy_settings($dom);
1.1450 raeburn 15045: my ($vpnint,$remote_ip);
15046: if (ref($proxyinfo) eq 'HASH') {
15047: $vpnint = $proxyinfo->{'vpnint'};
15048: if ($vpnint) {
15049: $remote_ip = &get_requestor_ip($r,1,1);
1.1434 raeburn 15050: }
15051: }
1.1450 raeburn 15052: unless ($vpnint && &ip_match($remote_ip,$vpnint)) {
15053: return $alias;
15054: }
1.1434 raeburn 15055: }
15056: }
15057: return;
15058: }
15059:
1.1474 raeburn 15060: sub alias_sso {
1.1467 raeburn 15061: my ($lonid) = @_;
15062: if ($lonid eq '') {
15063: $lonid = $perlvar{'lonHostID'};
15064: }
15065: if (!defined(&hostname($lonid))) {
15066: return;
15067: }
15068: if ($lonid ne '') {
15069: my ($use_alias,$cached) = &is_cached_new('proxysaml',$lonid);
15070: if ($cached) {
15071: return $use_alias;
15072: }
1.1494 raeburn 15073: my $dom = &host_domain($lonid);
1.1467 raeburn 15074: if ($dom ne '') {
15075: my $cachetime = 60*60*24;
15076: my %domconfig =
1.1494 raeburn 15077: &get_dom('configuration',['wafproxy'],$dom);
1.1467 raeburn 15078: if (ref($domconfig{'wafproxy'}) eq 'HASH') {
15079: if (ref($domconfig{'wafproxy'}{'saml'}) eq 'HASH') {
15080: $use_alias = $domconfig{'wafproxy'}{'saml'}{$lonid};
15081: }
15082: }
15083: return &do_cache_new('proxysaml',$lonid,$use_alias,$cachetime);
15084: }
15085: }
15086: return;
15087: }
15088:
1.1465 raeburn 15089: sub get_saml_landing {
15090: my ($lonid) = @_;
15091: if ($lonid eq '') {
15092: my $defdom = &default_login_domain();
15093: my @hosts = ¤t_machine_ids();
15094: if (@hosts > 1) {
15095: foreach my $hostid (@hosts) {
15096: if (&host_domain($hostid) eq $defdom) {
15097: $lonid = $hostid;
15098: last;
15099: }
15100: }
15101: } else {
15102: $lonid = $perlvar{'lonHostID'};
15103: }
15104: if ($lonid) {
1.1494 raeburn 15105: unless (&host_domain($lonid) eq $defdom) {
1.1465 raeburn 15106: return;
15107: }
15108: } else {
15109: return;
15110: }
15111: } elsif (!defined(&hostname($lonid))) {
15112: return;
15113: }
15114: my ($landing,$cached) = &is_cached_new('samllanding',$lonid);
15115: if ($cached) {
15116: return $landing;
15117: }
1.1494 raeburn 15118: my $dom = &host_domain($lonid);
1.1465 raeburn 15119: if ($dom ne '') {
15120: my $cachetime = 60*60*24;
15121: my %domconfig =
1.1494 raeburn 15122: &get_dom('configuration',['login'],$dom);
1.1465 raeburn 15123: if (ref($domconfig{'login'}) eq 'HASH') {
15124: if (ref($domconfig{'login'}{'saml'}) eq 'HASH') {
15125: if (ref($domconfig{'login'}{'saml'}{$lonid}) eq 'HASH') {
15126: $landing = 1;
15127: }
15128: }
15129: }
15130: return &do_cache_new('samllanding',$lonid,$landing,$cachetime);
15131: }
15132: return;
15133: }
15134:
1.31 www 15135: # ------------------------------------------------------------- Declutters URLs
15136:
15137: sub declutter {
15138: my $thisfn=shift;
1.569 albertel 15139: if ($thisfn=~m|^/enc/|) { $thisfn=&Apache::lonenc::unencrypted($thisfn); }
1.1261 raeburn 15140: unless ($thisfn=~m{^/home/httpd/html/priv/}) {
15141: $thisfn=~s{^/home/httpd/html}{};
15142: }
1.31 www 15143: $thisfn=~s/^\///;
1.697 albertel 15144: $thisfn=~s|^adm/wrapper/||;
15145: $thisfn=~s|^adm/coursedocs/showdoc/||;
1.31 www 15146: $thisfn=~s/^res\///;
1.1172 bisitz 15147: $thisfn=~s/^priv\///;
1.1032 raeburn 15148: unless (($thisfn =~ /^ext/) || ($thisfn =~ /\.(page|sequence)___\d+___ext/)) {
15149: $thisfn=~s/\?.+$//;
15150: }
1.268 www 15151: return $thisfn;
15152: }
15153:
15154: # ------------------------------------------------------------- Clutter up URLs
15155:
15156: sub clutter {
15157: my $thisfn='/'.&declutter(shift);
1.887 albertel 15158: if ($thisfn !~ m{^/(uploaded|editupload|adm|userfiles|ext|raw|priv|public)/}
1.884 albertel 15159: || $thisfn =~ m{^/adm/(includes|pages)} ) {
1.270 www 15160: $thisfn='/res'.$thisfn;
15161: }
1.1031 raeburn 15162: if ($thisfn !~m|^/adm|) {
15163: if ($thisfn =~ m|^/ext/|) {
1.694 albertel 15164: $thisfn='/adm/wrapper'.$thisfn;
1.695 albertel 15165: } else {
15166: my ($ext) = ($thisfn =~ /\.(\w+)$/);
15167: my $embstyle=&Apache::loncommon::fileembstyle($ext);
1.698 albertel 15168: if ($embstyle eq 'ssi'
15169: || ($embstyle eq 'hdn')
15170: || ($embstyle eq 'rat')
15171: || ($embstyle eq 'prv')
15172: || ($embstyle eq 'ign')) {
15173: #do nothing with these
15174: } elsif (($embstyle eq 'img')
1.695 albertel 15175: || ($embstyle eq 'emb')
15176: || ($embstyle eq 'wrp')) {
15177: $thisfn='/adm/wrapper'.$thisfn;
1.698 albertel 15178: } elsif ($embstyle eq 'unk'
15179: && $thisfn!~/\.(sequence|page)$/) {
1.695 albertel 15180: $thisfn='/adm/coursedocs/showdoc'.$thisfn;
1.698 albertel 15181: } else {
1.718 www 15182: # &logthis("Got a blank emb style");
1.695 albertel 15183: }
1.694 albertel 15184: }
1.1343 raeburn 15185: } elsif ($thisfn =~ m{^/adm/$match_domain/$match_courseid/\d+/ext\.tool$}) {
1.1298 raeburn 15186: $thisfn='/adm/wrapper'.$thisfn;
1.694 albertel 15187: }
1.31 www 15188: return $thisfn;
1.12 www 15189: }
15190:
1.787 albertel 15191: sub clutter_with_no_wrapper {
15192: my $uri = &clutter(shift);
15193: if ($uri =~ m-^/adm/-) {
15194: $uri =~ s-^/adm/wrapper/-/-;
15195: $uri =~ s-^/adm/coursedocs/showdoc/-/-;
15196: }
15197: return $uri;
15198: }
15199:
1.557 albertel 15200: sub freeze_escape {
15201: my ($value)=@_;
15202: if (ref($value)) {
15203: $value=&nfreeze($value);
15204: return '__FROZEN__'.&escape($value);
15205: }
15206: return &escape($value);
15207: }
15208:
1.11 www 15209:
1.557 albertel 15210: sub thaw_unescape {
15211: my ($value)=@_;
15212: if ($value =~ /^__FROZEN__/) {
15213: substr($value,0,10,undef);
15214: $value=&unescape($value);
15215: return &thaw($value);
15216: }
15217: return &unescape($value);
15218: }
15219:
1.436 albertel 15220: sub correct_line_ends {
15221: my ($result)=@_;
15222: $$result =~s/\r\n/\n/mg;
15223: $$result =~s/\r/\n/mg;
1.415 albertel 15224: }
1.1 albertel 15225: # ================================================================ Main Program
15226:
1.184 www 15227: sub goodbye {
1.204 albertel 15228: &logthis("Starting Shut down");
1.443 albertel 15229: #not converted to using infrastruture and probably shouldn't be
1.870 albertel 15230: &logthis(sprintf("%-20s is %s",'%badServerCache',length(&nfreeze(\%badServerCache))));
1.443 albertel 15231: #converted
1.599 albertel 15232: # &logthis(sprintf("%-20s is %s",'%metacache',scalar(%metacache)));
1.870 albertel 15233: &logthis(sprintf("%-20s is %s",'%homecache',length(&nfreeze(\%homecache))));
15234: # &logthis(sprintf("%-20s is %s",'%titlecache',length(&nfreeze(\%titlecache))));
15235: # &logthis(sprintf("%-20s is %s",'%courseresdatacache',length(&nfreeze(\%courseresdatacache))));
1.425 albertel 15236: #1.1 only
1.870 albertel 15237: # &logthis(sprintf("%-20s is %s",'%userresdatacache',length(&nfreeze(\%userresdatacache))));
15238: # &logthis(sprintf("%-20s is %s",'%getsectioncache',length(&nfreeze(\%getsectioncache))));
15239: # &logthis(sprintf("%-20s is %s",'%courseresversioncache',length(&nfreeze(\%courseresversioncache))));
15240: # &logthis(sprintf("%-20s is %s",'%resversioncache',length(&nfreeze(\%resversioncache))));
15241: &logthis(sprintf("%-20s is %s",'%remembered',length(&nfreeze(\%remembered))));
1.599 albertel 15242: &logthis(sprintf("%-20s is %s",'kicks',$kicks));
15243: &logthis(sprintf("%-20s is %s",'hits',$hits));
1.184 www 15244: &flushcourselogs();
15245: &logthis("Shutting down");
15246: }
15247:
1.852 albertel 15248: sub get_dns {
1.1210 raeburn 15249: my ($url,$func,$ignore_cache,$nocache,$hashref) = @_;
1.869 albertel 15250: if (!$ignore_cache) {
15251: my ($content,$cached)=
1.1494 raeburn 15252: &is_cached_new('dns',$url);
1.869 albertel 15253: if ($cached) {
1.1210 raeburn 15254: &$func($content,$hashref);
1.869 albertel 15255: return;
15256: }
15257: }
15258:
15259: my %alldns;
1.1379 raeburn 15260: if (open(my $config,"<","$perlvar{'lonTabDir'}/hosts.tab")) {
15261: foreach my $dns (<$config>) {
15262: next if ($dns !~ /^\^(\S*)/x);
15263: my $line = $1;
15264: my ($host,$protocol) = split(/:/,$line);
15265: if ($protocol ne 'https') {
15266: $protocol = 'http';
15267: }
15268: $alldns{$host} = $protocol;
1.979 raeburn 15269: }
1.1379 raeburn 15270: close($config);
1.869 albertel 15271: }
15272: while (%alldns) {
1.1263 raeburn 15273: my ($dns) = sort { $b cmp $a } keys(%alldns);
1.1456 raeburn 15274: my ($contents,@content);
15275: if ($dns eq Sys::Hostname::FQDN::fqdn()) {
15276: my $command = (split('/',$url))[3];
15277: my ($dir,$file) = &parse_getdns_url($command,$url);
15278: delete($alldns{$dns});
15279: next if (($dir eq '') || ($file eq ''));
15280: if (open(my $config,'<',"$dir/$file")) {
1.1457 raeburn 15281: @content = <$config>;
1.1456 raeburn 15282: close($config);
15283: }
15284: if ($url eq '/adm/dns/loncapaCRL') {
15285: $contents = join('',@content);
15286: }
15287: } else {
15288: my $request=new HTTP::Request('GET',"$alldns{$dns}://$dns$url");
15289: my $response = &LONCAPA::LWPReq::makerequest('',$request,'',\%perlvar,30,0);
15290: delete($alldns{$dns});
15291: next if ($response->is_error());
15292: if ($url eq '/adm/dns/loncapaCRL') {
15293: $contents = $response->content;
15294: } else {
15295: @content = split("\n",$response->content);
15296: }
15297: }
1.1379 raeburn 15298: if ($url eq '/adm/dns/loncapaCRL') {
1.1456 raeburn 15299: return &$func($contents);
1.1379 raeburn 15300: } else {
15301: unless ($nocache) {
15302: &do_cache_new('dns',$url,\@content,30*24*60*60);
15303: }
15304: &$func(\@content,$hashref);
15305: return;
15306: }
15307: }
15308: my $which = (split('/',$url,4))[3];
15309: if ($which eq 'loncapaCRL') {
15310: my $diskfile = "$perlvar{'lonCertificateDirectory'}/$perlvar{'lonnetCertRevocationList'}";
15311: if (-e $diskfile) {
15312: &logthis("unable to contact DNS, on disk file $diskfile not updated");
15313: } else {
15314: &logthis("unable to contact DNS, no on disk file $diskfile available");
15315: }
15316: } else {
15317: &logthis("unable to contact DNS defaulting to on disk file dns_$which.tab\n");
15318: if (open(my $config,"<","$perlvar{'lonTabDir'}/dns_$which.tab")) {
15319: my @content = <$config>;
15320: close($config);
15321: &$func(\@content,$hashref);
15322: }
1.852 albertel 15323: }
1.1210 raeburn 15324: return;
15325: }
15326:
15327: # ------------------------------------------------------Get DNS checksums file
1.1211 raeburn 15328: sub parse_dns_checksums_tab {
1.1210 raeburn 15329: my ($lines,$hashref) = @_;
1.1264 raeburn 15330: my $lonhost = $perlvar{'lonHostID'};
1.1494 raeburn 15331: my $machine_dom = &host_domain($lonhost);
1.1210 raeburn 15332: my $loncaparev = &get_server_loncaparev($machine_dom);
1.1264 raeburn 15333: my $distro = (split(/\:/,&get_server_distarch($lonhost)))[0];
15334: my $webconfdir = '/etc/httpd/conf';
15335: if ($distro =~ /^(ubuntu|debian)(\d+)$/) {
15336: $webconfdir = '/etc/apache2';
15337: } elsif ($distro =~ /^sles(\d+)$/) {
15338: if ($1 >= 10) {
15339: $webconfdir = '/etc/apache2';
15340: }
15341: } elsif ($distro =~ /^suse(\d+\.\d+)$/) {
15342: if ($1 >= 10.0) {
15343: $webconfdir = '/etc/apache2';
15344: }
15345: }
1.1210 raeburn 15346: my ($release,$timestamp) = split(/\-/,$loncaparev);
15347: my (%chksum,%revnum);
15348: if (ref($lines) eq 'ARRAY') {
15349: chomp(@{$lines});
1.1238 raeburn 15350: my $version = shift(@{$lines});
15351: if ($version eq $release) {
1.1210 raeburn 15352: foreach my $line (@{$lines}) {
1.1238 raeburn 15353: my ($file,$version,$shasum) = split(/,/,$line);
1.1264 raeburn 15354: if ($file =~ m{^/etc/httpd/conf}) {
15355: if ($webconfdir eq '/etc/apache2') {
15356: $file =~ s{^\Q/etc/httpd/conf/\E}{$webconfdir/};
15357: }
15358: }
1.1238 raeburn 15359: $chksum{$file} = $shasum;
15360: $revnum{$file} = $version;
1.1210 raeburn 15361: }
15362: if (ref($hashref) eq 'HASH') {
15363: %{$hashref} = (
15364: sums => \%chksum,
15365: versions => \%revnum,
15366: );
15367: }
15368: }
15369: }
1.869 albertel 15370: return;
1.852 albertel 15371: }
1.1210 raeburn 15372:
15373: sub fetch_dns_checksums {
1.1238 raeburn 15374: my %checksums;
1.1494 raeburn 15375: my $machine_dom = &host_domain($perlvar{'lonHostID'});
1.1260 raeburn 15376: my $loncaparev = &get_server_loncaparev($machine_dom,$perlvar{'lonHostID'});
1.1238 raeburn 15377: my ($release,$timestamp) = split(/\-/,$loncaparev);
15378: &get_dns("/adm/dns/checksums/$release",\&parse_dns_checksums_tab,1,1,
1.1211 raeburn 15379: \%checksums);
1.1210 raeburn 15380: return \%checksums;
15381: }
15382:
1.1379 raeburn 15383: sub fetch_crl_pemfile {
15384: return &get_dns("/adm/dns/loncapaCRL",\&save_crl_pem,1,1);
15385: }
15386:
15387: sub save_crl_pem {
1.1456 raeburn 15388: my ($content) = @_;
1.1380 raeburn 15389: my ($msg,$hadchanges);
1.1456 raeburn 15390: if ($content ne '') {
1.1379 raeburn 15391: my $now = time;
15392: my $lonca = $perlvar{'lonCertificateDirectory'}.'/'.$perlvar{'lonnetCertificateAuthority'};
15393: my $tmpcrl = $tmpdir.'/'.$perlvar{'lonnetCertRevocationList'}.'_'.$now.'.'.$$.'.tmp';
15394: if (open(my $fh,'>',"$tmpcrl")) {
1.1456 raeburn 15395: print $fh $content;
1.1379 raeburn 15396: close($fh);
15397: if (-e $lonca) {
15398: if (open(PIPE,"openssl crl -in $tmpcrl -inform pem -CAfile $lonca -noout 2>&1 |")) {
15399: my $check = <PIPE>;
15400: close(PIPE);
15401: chomp($check);
15402: if ($check eq 'verify OK') {
15403: my $dest = "$perlvar{'lonCertificateDirectory'}/$perlvar{'lonnetCertRevocationList'}";
1.1380 raeburn 15404: my $backup;
1.1379 raeburn 15405: if (-e $dest) {
1.1380 raeburn 15406: if (&File::Copy::move($dest,"$dest.bak")) {
15407: $backup = 'ok';
15408: }
1.1379 raeburn 15409: }
15410: if (&File::Copy::move($tmpcrl,$dest)) {
15411: $msg = 'ok';
1.1380 raeburn 15412: if ($backup) {
15413: my (%oldnums,%newnums);
15414: if (open(PIPE, "openssl crl -inform PEM -text -noout -in $dest.bak |grep 'Serial Number' |")) {
15415: while (<PIPE>) {
15416: $oldnums{(split(/:/))[1]} = 1;
15417: }
15418: close(PIPE);
15419: }
15420: if (open(PIPE, "openssl crl -inform PEM -text -noout -in $dest |grep 'Serial Number' |")) {
15421: while(<PIPE>) {
15422: $newnums{(split(/:/))[1]} = 1;
15423: }
15424: close(PIPE);
15425: }
15426: foreach my $key (sort {$b <=> $a } (keys(%newnums))) {
15427: unless (exists($oldnums{$key})) {
15428: $hadchanges = 1;
15429: last;
15430: }
15431: }
15432: unless ($hadchanges) {
15433: foreach my $key (sort {$b <=> $a } (keys(%oldnums))) {
15434: unless (exists($newnums{$key})) {
15435: $hadchanges = 1;
15436: last;
15437: }
15438: }
15439: }
15440: }
1.1379 raeburn 15441: }
15442: } else {
15443: unlink($tmpcrl);
15444: }
15445: } else {
15446: unlink($tmpcrl);
15447: }
15448: } else {
15449: unlink($tmpcrl);
15450: }
15451: }
15452: }
1.1380 raeburn 15453: return ($msg,$hadchanges);
1.1379 raeburn 15454: }
15455:
1.1456 raeburn 15456: sub parse_getdns_url {
15457: my ($command,$url) = @_;
15458: my $dir = $perlvar{'lonTabDir'};
15459: my $file;
15460: if ($command eq 'hosts') {
15461: $file = 'dns_hosts.tab';
15462: } elsif ($command eq 'domain') {
15463: $file = 'dns_domain.tab';
15464: } elsif ($command eq 'checksums') {
15465: my $version = (split('/',$url))[4];
15466: $file = "dns_checksums/$version.tab",
15467: } elsif ($command eq 'loncapaCRL') {
15468: $dir = $perlvar{'lonCertificateDirectory'};
15469: $file = $perlvar{'lonnetCertRevocationList'};
15470: }
15471: return ($dir,$file);
15472: }
15473:
1.327 albertel 15474: # ------------------------------------------------------------ Read domain file
15475: {
1.852 albertel 15476: my $loaded;
1.846 albertel 15477: my %domain;
15478:
1.852 albertel 15479: sub parse_domain_tab {
15480: my ($lines) = @_;
15481: foreach my $line (@$lines) {
15482: next if ($line =~ /^(\#|\s*$ )/x);
1.403 www 15483:
1.846 albertel 15484: chomp($line);
1.852 albertel 15485: my ($name,@elements) = split(/:/,$line,9);
1.846 albertel 15486: my %this_domain;
15487: foreach my $field ('description', 'auth_def', 'auth_arg_def',
15488: 'lang_def', 'city', 'longi', 'lati',
15489: 'primary') {
15490: $this_domain{$field} = shift(@elements);
15491: }
15492: $domain{$name} = \%this_domain;
1.852 albertel 15493: }
15494: }
1.864 albertel 15495:
15496: sub reset_domain_info {
15497: undef($loaded);
15498: undef(%domain);
15499: }
15500:
1.852 albertel 15501: sub load_domain_tab {
1.1293 raeburn 15502: my ($ignore_cache,$nocache) = @_;
15503: &get_dns('/adm/dns/domain',\&parse_domain_tab,$ignore_cache,$nocache);
1.852 albertel 15504: my $fh;
1.1359 raeburn 15505: if (open($fh,"<",$perlvar{'lonTabDir'}.'/domain.tab')) {
1.852 albertel 15506: my @lines = <$fh>;
15507: &parse_domain_tab(\@lines);
1.448 albertel 15508: }
1.852 albertel 15509: close($fh);
15510: $loaded = 1;
1.327 albertel 15511: }
1.846 albertel 15512:
15513: sub domain {
1.852 albertel 15514: &load_domain_tab() if (!$loaded);
15515:
1.846 albertel 15516: my ($name,$what) = @_;
15517: return if ( !exists($domain{$name}) );
15518:
15519: if (!$what) {
15520: return $domain{$name}{'description'};
15521: }
15522: return $domain{$name}{$what};
15523: }
1.974 raeburn 15524:
15525: sub domain_info {
15526: &load_domain_tab() if (!$loaded);
15527: return %domain;
15528: }
15529:
1.327 albertel 15530: }
15531:
15532:
1.1 albertel 15533: # ------------------------------------------------------------- Read hosts file
15534: {
1.838 albertel 15535: my %hostname;
1.844 albertel 15536: my %hostdom;
1.845 albertel 15537: my %libserv;
1.852 albertel 15538: my $loaded;
1.888 albertel 15539: my %name_to_host;
1.1074 raeburn 15540: my %internetdom;
1.1107 raeburn 15541: my %LC_dns_serv;
1.852 albertel 15542:
15543: sub parse_hosts_tab {
15544: my ($file) = @_;
15545: foreach my $configline (@$file) {
15546: next if ($configline =~ /^(\#|\s*$ )/x);
1.1107 raeburn 15547: chomp($configline);
15548: if ($configline =~ /^\^/) {
15549: if ($configline =~ /^\^([\w.\-]+)/) {
15550: $LC_dns_serv{$1} = 1;
15551: }
15552: next;
15553: }
1.1074 raeburn 15554: my ($id,$domain,$role,$name,$protocol,$intdom)=split(/:/,$configline);
1.852 albertel 15555: $name=~s/\s//g;
15556: if ($id && $domain && $role && $name) {
1.1351 raeburn 15557: if ((exists($hostname{$id})) && ($hostname{$id} ne '')) {
15558: my $curr = $hostname{$id};
15559: my $skip;
15560: if (ref($name_to_host{$curr}) eq 'ARRAY') {
15561: if (($curr eq $name) && (@{$name_to_host{$curr}} == 1)) {
15562: $skip = 1;
15563: } else {
15564: @{$name_to_host{$curr}} = grep { $_ ne $id } @{$name_to_host{$curr}};
15565: }
15566: }
15567: unless ($skip) {
15568: push(@{$name_to_host{$name}},$id);
15569: }
15570: } else {
15571: push(@{$name_to_host{$name}},$id);
15572: }
1.852 albertel 15573: $hostname{$id}=$name;
15574: $hostdom{$id}=$domain;
15575: if ($role eq 'library') { $libserv{$id}=$name; }
1.969 raeburn 15576: if (defined($protocol)) {
15577: if ($protocol eq 'https') {
15578: $protocol{$id} = $protocol;
15579: } else {
15580: $protocol{$id} = 'http';
15581: }
1.968 raeburn 15582: } else {
1.969 raeburn 15583: $protocol{$id} = 'http';
1.968 raeburn 15584: }
1.1074 raeburn 15585: if (defined($intdom)) {
15586: $internetdom{$id} = $intdom;
15587: }
1.852 albertel 15588: }
15589: }
15590: }
1.864 albertel 15591:
15592: sub reset_hosts_info {
1.897 albertel 15593: &purge_remembered();
1.864 albertel 15594: &reset_domain_info();
15595: &reset_hosts_ip_info();
1.1339 raeburn 15596: undef(%internetdom);
1.892 albertel 15597: undef(%name_to_host);
1.864 albertel 15598: undef(%hostname);
15599: undef(%hostdom);
15600: undef(%libserv);
15601: undef($loaded);
15602: }
1.1 albertel 15603:
1.852 albertel 15604: sub load_hosts_tab {
1.1293 raeburn 15605: my ($ignore_cache,$nocache) = @_;
15606: &get_dns('/adm/dns/hosts',\&parse_hosts_tab,$ignore_cache,$nocache);
1.1359 raeburn 15607: open(my $config,"<","$perlvar{'lonTabDir'}/hosts.tab");
1.852 albertel 15608: my @config = <$config>;
15609: &parse_hosts_tab(\@config);
15610: close($config);
15611: $loaded=1;
1.1 albertel 15612: }
1.852 albertel 15613:
1.838 albertel 15614: sub hostname {
1.852 albertel 15615: &load_hosts_tab() if (!$loaded);
15616:
1.838 albertel 15617: my ($lonid) = @_;
15618: return $hostname{$lonid};
15619: }
1.845 albertel 15620:
1.838 albertel 15621: sub all_hostnames {
1.852 albertel 15622: &load_hosts_tab() if (!$loaded);
15623:
1.838 albertel 15624: return %hostname;
15625: }
1.845 albertel 15626:
1.888 albertel 15627: sub all_names {
1.1293 raeburn 15628: my ($ignore_cache,$nocache) = @_;
15629: &load_hosts_tab($ignore_cache,$nocache) if (!$loaded);
1.888 albertel 15630:
15631: return %name_to_host;
15632: }
15633:
1.974 raeburn 15634: sub all_host_domain {
15635: &load_hosts_tab() if (!$loaded);
15636: return %hostdom;
15637: }
15638:
1.1339 raeburn 15639: sub all_host_intdom {
15640: &load_hosts_tab() if (!$loaded);
15641: return %internetdom;
15642: }
15643:
1.845 albertel 15644: sub is_library {
1.852 albertel 15645: &load_hosts_tab() if (!$loaded);
15646:
1.845 albertel 15647: return exists($libserv{$_[0]});
15648: }
15649:
15650: sub all_library {
1.852 albertel 15651: &load_hosts_tab() if (!$loaded);
15652:
1.845 albertel 15653: return %libserv;
15654: }
15655:
1.1062 droeschl 15656: sub unique_library {
15657: #2x reverse removes all hostnames that appear more than once
15658: my %unique = reverse &all_library();
15659: return reverse %unique;
15660: }
15661:
1.841 albertel 15662: sub get_servers {
1.852 albertel 15663: &load_hosts_tab() if (!$loaded);
15664:
1.841 albertel 15665: my ($domain,$type) = @_;
15666: my %possible_hosts = ($type eq 'library') ? %libserv
15667: : %hostname;
15668: my %result;
1.842 albertel 15669: if (ref($domain) eq 'ARRAY') {
15670: while ( my ($host,$hostname) = each(%possible_hosts)) {
1.843 albertel 15671: if (grep(/^\Q$hostdom{$host}\E$/,@$domain)) {
1.842 albertel 15672: $result{$host} = $hostname;
15673: }
15674: }
15675: } else {
15676: while ( my ($host,$hostname) = each(%possible_hosts)) {
15677: if ($hostdom{$host} eq $domain) {
15678: $result{$host} = $hostname;
15679: }
1.841 albertel 15680: }
15681: }
15682: return %result;
15683: }
1.845 albertel 15684:
1.1062 droeschl 15685: sub get_unique_servers {
15686: my %unique = reverse &get_servers(@_);
15687: return reverse %unique;
15688: }
15689:
1.844 albertel 15690: sub host_domain {
1.852 albertel 15691: &load_hosts_tab() if (!$loaded);
15692:
1.844 albertel 15693: my ($lonid) = @_;
15694: return $hostdom{$lonid};
15695: }
15696:
1.841 albertel 15697: sub all_domains {
1.852 albertel 15698: &load_hosts_tab() if (!$loaded);
15699:
1.841 albertel 15700: my %seen;
15701: my @uniq = grep(!$seen{$_}++, values(%hostdom));
15702: return @uniq;
15703: }
1.1074 raeburn 15704:
15705: sub internet_dom {
15706: &load_hosts_tab() if (!$loaded);
15707:
15708: my ($lonid) = @_;
15709: return $internetdom{$lonid};
15710: }
1.1107 raeburn 15711:
15712: sub is_LC_dns {
15713: &load_hosts_tab() if (!$loaded);
15714:
15715: my ($hostname) = @_;
15716: return exists($LC_dns_serv{$hostname});
15717: }
15718:
1.1 albertel 15719: }
15720:
1.847 albertel 15721: {
15722: my %iphost;
1.856 albertel 15723: my %name_to_ip;
15724: my %lonid_to_ip;
1.869 albertel 15725:
1.847 albertel 15726: sub get_hosts_from_ip {
15727: my ($ip) = @_;
15728: my %iphosts = &get_iphost();
15729: if (ref($iphosts{$ip})) {
15730: return @{$iphosts{$ip}};
15731: }
15732: return;
1.839 albertel 15733: }
1.864 albertel 15734:
15735: sub reset_hosts_ip_info {
15736: undef(%iphost);
15737: undef(%name_to_ip);
15738: undef(%lonid_to_ip);
15739: }
1.856 albertel 15740:
15741: sub get_host_ip {
15742: my ($lonid) = @_;
15743: if (exists($lonid_to_ip{$lonid})) {
15744: return $lonid_to_ip{$lonid};
15745: }
15746: my $name=&hostname($lonid);
15747: my $ip = gethostbyname($name);
15748: return if (!$ip || length($ip) ne 4);
15749: $ip=inet_ntoa($ip);
15750: $name_to_ip{$name} = $ip;
15751: $lonid_to_ip{$lonid} = $ip;
15752: return $ip;
15753: }
1.847 albertel 15754:
15755: sub get_iphost {
1.1293 raeburn 15756: my ($ignore_cache,$nocache) = @_;
1.894 albertel 15757:
1.869 albertel 15758: if (!$ignore_cache) {
15759: if (%iphost) {
15760: return %iphost;
15761: }
15762: my ($ip_info,$cached)=
1.1494 raeburn 15763: &is_cached_new('iphost','iphost');
1.869 albertel 15764: if ($cached) {
15765: %iphost = %{$ip_info->[0]};
15766: %name_to_ip = %{$ip_info->[1]};
15767: %lonid_to_ip = %{$ip_info->[2]};
15768: return %iphost;
15769: }
15770: }
1.894 albertel 15771:
15772: # get yesterday's info for fallback
15773: my %old_name_to_ip;
15774: my ($ip_info,$cached)=
1.1495 raeburn 15775: &is_cached_new('iphost','iphost');
1.894 albertel 15776: if ($cached) {
15777: %old_name_to_ip = %{$ip_info->[1]};
15778: }
15779:
1.1293 raeburn 15780: my %name_to_host = &all_names($ignore_cache,$nocache);
1.888 albertel 15781: foreach my $name (keys(%name_to_host)) {
1.847 albertel 15782: my $ip;
15783: if (!exists($name_to_ip{$name})) {
15784: $ip = gethostbyname($name);
15785: if (!$ip || length($ip) ne 4) {
1.894 albertel 15786: if (defined($old_name_to_ip{$name})) {
15787: $ip = $old_name_to_ip{$name};
15788: &logthis("Can't find $name defaulting to old $ip");
15789: } else {
15790: &logthis("Name $name no IP found");
15791: next;
15792: }
15793: } else {
15794: $ip=inet_ntoa($ip);
1.847 albertel 15795: }
15796: $name_to_ip{$name} = $ip;
15797: } else {
15798: $ip = $name_to_ip{$name};
1.653 albertel 15799: }
1.888 albertel 15800: foreach my $id (@{ $name_to_host{$name} }) {
15801: $lonid_to_ip{$id} = $ip;
15802: }
15803: push(@{$iphost{$ip}},@{$name_to_host{$name}});
1.598 albertel 15804: }
1.1293 raeburn 15805: unless ($nocache) {
15806: &do_cache_new('iphost','iphost',
15807: [\%iphost,\%name_to_ip,\%lonid_to_ip],
15808: 48*60*60);
15809: }
1.869 albertel 15810:
1.847 albertel 15811: return %iphost;
1.598 albertel 15812: }
15813:
1.992 raeburn 15814: #
15815: # Given a DNS returns the loncapa host name for that DNS
15816: #
15817: sub host_from_dns {
15818: my ($dns) = @_;
15819: my @hosts;
15820: my $ip;
15821:
1.993 raeburn 15822: if (exists($name_to_ip{$dns})) {
1.992 raeburn 15823: $ip = $name_to_ip{$dns};
15824: }
15825: if (!$ip) {
15826: $ip = gethostbyname($dns); # Initial translation to IP is in net order.
15827: if (length($ip) == 4) {
15828: $ip = &IO::Socket::inet_ntoa($ip);
15829: }
15830: }
15831: if ($ip) {
15832: @hosts = get_hosts_from_ip($ip);
15833: return $hosts[0];
15834: }
15835: return undef;
1.986 foxr 15836: }
1.992 raeburn 15837:
1.1074 raeburn 15838: sub get_internet_names {
15839: my ($lonid) = @_;
15840: return if ($lonid eq '');
15841: my ($idnref,$cached)=
1.1494 raeburn 15842: &is_cached_new('internetnames',$lonid);
1.1074 raeburn 15843: if ($cached) {
15844: return $idnref;
15845: }
15846: my $ip = &get_host_ip($lonid);
15847: my @hosts = &get_hosts_from_ip($ip);
15848: my %iphost = &get_iphost();
15849: my (@idns,%seen);
15850: foreach my $id (@hosts) {
15851: my $dom = &host_domain($id);
15852: my $prim_id = &domain($dom,'primary');
15853: my $prim_ip = &get_host_ip($prim_id);
15854: next if ($seen{$prim_ip});
15855: if (ref($iphost{$prim_ip}) eq 'ARRAY') {
15856: foreach my $id (@{$iphost{$prim_ip}}) {
15857: my $intdom = &internet_dom($id);
15858: unless (grep(/^\Q$intdom\E$/,@idns)) {
15859: push(@idns,$intdom);
15860: }
15861: }
15862: }
15863: $seen{$prim_ip} = 1;
15864: }
1.1219 raeburn 15865: return &do_cache_new('internetnames',$lonid,\@idns,12*60*60);
1.1074 raeburn 15866: }
15867:
1.986 foxr 15868: }
15869:
1.1079 raeburn 15870: sub all_loncaparevs {
1.1249 raeburn 15871: 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);
1.1079 raeburn 15872: }
15873:
1.1227 raeburn 15874: # ---------------------------------------------------------- Read loncaparev table
15875: {
15876: sub load_loncaparevs {
15877: if (-e "$perlvar{'lonTabDir'}/loncaparevs.tab") {
1.1359 raeburn 15878: if (open(my $config,"<","$perlvar{'lonTabDir'}/loncaparevs.tab")) {
1.1227 raeburn 15879: while (my $configline=<$config>) {
15880: chomp($configline);
15881: my ($hostid,$loncaparev)=split(/:/,$configline);
15882: $loncaparevs{$hostid}=$loncaparev;
15883: }
15884: close($config);
15885: }
15886: }
15887: }
15888: }
15889:
15890: # ---------------------------------------------------------- Read serverhostID table
15891: {
15892: sub load_serverhomeIDs {
15893: if (-e "$perlvar{'lonTabDir'}/serverhomeIDs.tab") {
1.1359 raeburn 15894: if (open(my $config,"<","$perlvar{'lonTabDir'}/serverhomeIDs.tab")) {
1.1227 raeburn 15895: while (my $configline=<$config>) {
15896: chomp($configline);
15897: my ($name,$id)=split(/:/,$configline);
15898: $serverhomeIDs{$name}=$id;
15899: }
15900: close($config);
15901: }
15902: }
15903: }
15904: }
15905:
15906:
1.862 albertel 15907: BEGIN {
15908:
15909: # ----------------------------------- Read loncapa.conf and loncapa_apache.conf
15910: unless ($readit) {
15911: {
15912: my $configvars = LONCAPA::Configuration::read_conf('loncapa.conf');
15913: %perlvar = (%perlvar,%{$configvars});
15914: }
15915:
15916:
1.1 albertel 15917: # ------------------------------------------------------ Read spare server file
15918: {
1.1359 raeburn 15919: open(my $config,"<","$perlvar{'lonTabDir'}/spare.tab");
1.1 albertel 15920:
15921: while (my $configline=<$config>) {
15922: chomp($configline);
1.284 matthew 15923: if ($configline) {
1.784 albertel 15924: my ($host,$type) = split(':',$configline,2);
1.785 albertel 15925: if (!defined($type) || $type eq '') { $type = 'default' };
1.784 albertel 15926: push(@{ $spareid{$type} }, $host);
1.1 albertel 15927: }
15928: }
1.448 albertel 15929: close($config);
1.1 albertel 15930: }
1.11 www 15931: # ------------------------------------------------------------ Read permissions
15932: {
1.1359 raeburn 15933: open(my $config,"<","$perlvar{'lonTabDir'}/roles.tab");
1.11 www 15934:
15935: while (my $configline=<$config>) {
1.448 albertel 15936: chomp($configline);
15937: if ($configline) {
15938: my ($role,$perm)=split(/ /,$configline);
15939: if ($perm ne '') { $pr{$role}=$perm; }
15940: }
1.11 www 15941: }
1.448 albertel 15942: close($config);
1.11 www 15943: }
15944:
15945: # -------------------------------------------- Read plain texts for permissions
15946: {
1.1359 raeburn 15947: open(my $config,"<","$perlvar{'lonTabDir'}/rolesplain.tab");
1.11 www 15948:
15949: while (my $configline=<$config>) {
1.448 albertel 15950: chomp($configline);
15951: if ($configline) {
1.742 raeburn 15952: my ($short,@plain)=split(/:/,$configline);
15953: %{$prp{$short}} = ();
15954: if (@plain > 0) {
15955: $prp{$short}{'std'} = $plain[0];
15956: for (my $i=1; $i<@plain; $i++) {
15957: $prp{$short}{'alt'.$i} = $plain[$i];
15958: }
15959: }
1.448 albertel 15960: }
1.135 www 15961: }
1.448 albertel 15962: close($config);
1.135 www 15963: }
15964:
15965: # ---------------------------------------------------------- Read package table
15966: {
1.1359 raeburn 15967: open(my $config,"<","$perlvar{'lonTabDir'}/packages.tab");
1.135 www 15968:
15969: while (my $configline=<$config>) {
1.483 albertel 15970: if ($configline !~ /\S/ || $configline=~/^#/) { next; }
1.448 albertel 15971: chomp($configline);
15972: my ($short,$plain)=split(/:/,$configline);
15973: my ($pack,$name)=split(/\&/,$short);
15974: if ($plain ne '') {
15975: $packagetab{$pack.'&'.$name.'&name'}=$name;
15976: $packagetab{$short}=$plain;
15977: }
1.11 www 15978: }
1.448 albertel 15979: close($config);
1.329 matthew 15980: }
15981:
1.1073 raeburn 15982: # ---------------------------------------------------------- Read loncaparev table
1.1227 raeburn 15983:
15984: &load_loncaparevs();
1.1073 raeburn 15985:
1.1074 raeburn 15986: # ---------------------------------------------------------- Read serverhostID table
15987:
1.1227 raeburn 15988: &load_serverhomeIDs();
15989:
15990: # ---------------------------------------------------------- Read releaseslist XML
1.1079 raeburn 15991: {
15992: my $file = $Apache::lonnet::perlvar{'lonTabDir'}.'/releaseslist.xml';
15993: if (-e $file) {
15994: my $parser = HTML::LCParser->new($file);
15995: while (my $token = $parser->get_token()) {
15996: if ($token->[0] eq 'S') {
15997: my $item = $token->[1];
15998: my $name = $token->[2]{'name'};
15999: my $value = $token->[2]{'value'};
1.1285 raeburn 16000: my $valuematch = $token->[2]{'valuematch'};
1.1303 raeburn 16001: my $namematch = $token->[2]{'namematch'};
16002: if ($item eq 'parameter') {
16003: if (($namematch ne '') || (($name ne '') && ($value ne '' || $valuematch ne ''))) {
16004: my $release = $parser->get_text();
16005: $release =~ s/(^\s*|\s*$ )//gx;
16006: $needsrelease{$item.':'.$name.':'.$value.':'.$valuematch.':'.$namematch} = $release;
16007: }
16008: } elsif ($item ne '' && $name ne '') {
1.1079 raeburn 16009: my $release = $parser->get_text();
16010: $release =~ s/(^\s*|\s*$ )//gx;
1.1303 raeburn 16011: $needsrelease{$item.':'.$name.':'.$value} = $release;
1.1079 raeburn 16012: }
16013: }
16014: }
16015: }
1.1073 raeburn 16016: }
16017:
1.1138 raeburn 16018: # ---------------------------------------------------------- Read managers table
16019: {
16020: if (-e "$perlvar{'lonTabDir'}/managers.tab") {
1.1359 raeburn 16021: if (open(my $config,"<","$perlvar{'lonTabDir'}/managers.tab")) {
1.1138 raeburn 16022: while (my $configline=<$config>) {
16023: chomp($configline);
16024: next if ($configline =~ /^\#/);
16025: if (($configline =~ /^[\w\-]+$/) || ($configline =~ /^[\w\-]+\:[\w\-]+$/)) {
16026: $managerstab{$configline} = 1;
16027: }
16028: }
16029: close($config);
16030: }
16031: }
16032: }
16033:
1.329 matthew 16034: # ------------- set up temporary directory
16035: {
1.1117 foxr 16036: $tmpdir = LONCAPA::tempdir();
1.329 matthew 16037:
1.11 www 16038: }
16039:
1.1405 raeburn 16040: # ------------- set default texengine (domain default overrides this)
16041: {
16042: $deftex = LONCAPA::texengine();
16043: }
16044:
1.1416 raeburn 16045: # ------------- set default minimum length for passwords for internal auth users
16046: {
16047: $passwdmin = LONCAPA::passwd_min();
16048: }
16049:
1.794 albertel 16050: $memcache=new Cache::Memcached({'servers' => ['127.0.0.1:11211'],
16051: 'compress_threshold'=> 20_000,
16052: });
1.185 www 16053:
1.281 www 16054: $processmarker='_'.time.'_'.$perlvar{'lonHostID'};
1.186 www 16055: $dumpcount=0;
1.958 www 16056: $locknum=0;
1.22 www 16057:
1.163 harris41 16058: &logtouch();
1.672 albertel 16059: &logthis('<font color="yellow">INFO: Read configuration</font>');
1.195 www 16060: $readit=1;
1.564 albertel 16061: {
16062: use integer;
16063: my $test=(2**32)+1;
1.568 albertel 16064: if ($test != 0) { $_64bit=1; } else { $_64bit=0; }
1.564 albertel 16065: &logthis(" Detected 64bit platform ($_64bit)");
16066: }
1.195 www 16067: }
1.1 albertel 16068: }
1.179 www 16069:
1.1 albertel 16070: 1;
1.191 harris41 16071: __END__
16072:
1.243 albertel 16073: =pod
16074:
1.191 harris41 16075: =head1 NAME
16076:
1.243 albertel 16077: Apache::lonnet - Subroutines to ask questions about things in the network.
1.191 harris41 16078:
16079: =head1 SYNOPSIS
16080:
1.243 albertel 16081: Invoked by other LON-CAPA modules, when they need to talk to or about objects in the network.
1.191 harris41 16082:
16083: &Apache::lonnet::SUBROUTINENAME(ARGUMENTS);
16084:
1.243 albertel 16085: Common parameters:
16086:
16087: =over 4
16088:
16089: =item *
16090:
16091: $uname : an internal username (if $cname expecting a course Id specifically)
16092:
16093: =item *
16094:
16095: $udom : a domain (if $cdom expecting a course's domain specifically)
16096:
16097: =item *
16098:
16099: $symb : a resource instance identifier
16100:
16101: =item *
16102:
16103: $namespace : the name of a .db file that contains the data needed or
16104: being set.
16105:
16106: =back
16107:
1.394 bowersj2 16108: =head1 OVERVIEW
1.191 harris41 16109:
1.394 bowersj2 16110: lonnet provides subroutines which interact with the
16111: lonc/lond (TCP) network layer of LON-CAPA. They can be used to ask
16112: about classes, users, and resources.
1.243 albertel 16113:
16114: For many of these objects you can also use this to store data about
16115: them or modify them in various ways.
1.191 harris41 16116:
1.394 bowersj2 16117: =head2 Symbs
1.191 harris41 16118:
1.394 bowersj2 16119: To identify a specific instance of a resource, LON-CAPA uses symbols
16120: or "symbs"X<symb>. These identifiers are built from the URL of the
16121: map, the resource number of the resource in the map, and the URL of
16122: the resource itself. The latter is somewhat redundant, but might help
16123: if maps change.
16124:
16125: An example is
16126:
16127: msu/korte/parts/part1.sequence___19___msu/korte/tests/part12.problem
16128:
16129: The respective map entry is
16130:
16131: <resource id="19" src="/res/msu/korte/tests/part12.problem"
16132: title="Problem 2">
16133: </resource>
16134:
16135: Symbs are used by the random number generator, as well as to store and
16136: restore data specific to a certain instance of for example a problem.
16137:
16138: =head2 Storing And Retrieving Data
16139:
16140: X<store()>X<cstore()>X<restore()>Three of the most important functions
16141: in C<lonnet.pm> are C<&Apache::lonnet::cstore()>,
16142: C<&Apache::lonnet:restore()>, and C<&Apache::lonnet::store()>, which
16143: is is the non-critical message twin of cstore. These functions are for
16144: handlers to store a perl hash to a user's permanent data space in an
16145: easy manner, and to retrieve it again on another call. It is expected
16146: that a handler would use this once at the beginning to retrieve data,
16147: and then again once at the end to send only the new data back.
16148:
16149: The data is stored in the user's data directory on the user's
16150: homeserver under the ID of the course.
16151:
16152: The hash that is returned by restore will have all of the previous
16153: value for all of the elements of the hash.
16154:
16155: Example:
16156:
16157: #creating a hash
16158: my %hash;
16159: $hash{'foo'}='bar';
16160:
16161: #storing it
16162: &Apache::lonnet::cstore(\%hash);
16163:
16164: #changing a value
16165: $hash{'foo'}='notbar';
16166:
16167: #adding a new value
16168: $hash{'bar'}='foo';
16169: &Apache::lonnet::cstore(\%hash);
16170:
16171: #retrieving the hash
16172: my %history=&Apache::lonnet::restore();
16173:
16174: #print the hash
16175: foreach my $key (sort(keys(%history))) {
16176: print("\%history{$key} = $history{$key}");
16177: }
16178:
16179: Will print out:
1.191 harris41 16180:
1.394 bowersj2 16181: %history{1:foo} = bar
16182: %history{1:keys} = foo:timestamp
16183: %history{1:timestamp} = 990455579
16184: %history{2:bar} = foo
16185: %history{2:foo} = notbar
16186: %history{2:keys} = foo:bar:timestamp
16187: %history{2:timestamp} = 990455580
16188: %history{bar} = foo
16189: %history{foo} = notbar
16190: %history{timestamp} = 990455580
16191: %history{version} = 2
16192:
16193: Note that the special hash entries C<keys>, C<version> and
16194: C<timestamp> were added to the hash. C<version> will be equal to the
16195: total number of versions of the data that have been stored. The
16196: C<timestamp> attribute will be the UNIX time the hash was
16197: stored. C<keys> is available in every historical section to list which
16198: keys were added or changed at a specific historical revision of a
16199: hash.
16200:
16201: B<Warning>: do not store the hash that restore returns directly. This
16202: will cause a mess since it will restore the historical keys as if the
16203: were new keys. I.E. 1:foo will become 1:1:foo etc.
1.191 harris41 16204:
1.394 bowersj2 16205: Calling convention:
1.191 harris41 16206:
1.1225 raeburn 16207: my %record=&Apache::lonnet::restore($symb,$courseid,$domain,$uname);
1.1269 raeburn 16208: &Apache::lonnet::cstore(\%newrecord,$symb,$courseid,$domain,$uname,$laststore);
1.191 harris41 16209:
1.394 bowersj2 16210: For more detailed information, see lonnet specific documentation.
1.191 harris41 16211:
1.394 bowersj2 16212: =head1 RETURN MESSAGES
1.191 harris41 16213:
1.394 bowersj2 16214: =over 4
1.191 harris41 16215:
1.394 bowersj2 16216: =item * B<con_lost>: unable to contact remote host
1.191 harris41 16217:
1.394 bowersj2 16218: =item * B<con_delayed>: unable to contact remote host, message will be delivered
16219: when the connection is brought back up
1.191 harris41 16220:
1.394 bowersj2 16221: =item * B<con_failed>: unable to contact remote host and unable to save message
16222: for later delivery
1.191 harris41 16223:
1.967 bisitz 16224: =item * B<error:>: an error a occurred, a description of the error follows the :
1.191 harris41 16225:
1.394 bowersj2 16226: =item * B<no_such_host>: unable to fund a host associated with the user/domain
1.243 albertel 16227: that was requested
1.191 harris41 16228:
1.243 albertel 16229: =back
1.191 harris41 16230:
1.243 albertel 16231: =head1 PUBLIC SUBROUTINES
1.191 harris41 16232:
1.243 albertel 16233: =head2 Session Environment Functions
1.191 harris41 16234:
1.243 albertel 16235: =over 4
1.191 harris41 16236:
1.394 bowersj2 16237: =item *
16238: X<appenv()>
1.949 raeburn 16239: B<appenv($hashref,$rolesarrayref)>: the value of %{$hashref} is written to
1.394 bowersj2 16240: the user envirnoment file, and will be restored for each access this
1.620 albertel 16241: user makes during this session, also modifies the %env for the current
1.949 raeburn 16242: process. Optional rolesarrayref - if defined contains a reference to an array
16243: of roles which are exempt from the restriction on modifying user.role entries
16244: in the user's environment.db and in %env.
1.191 harris41 16245:
16246: =item *
1.394 bowersj2 16247: X<delenv()>
1.987 raeburn 16248: B<delenv($delthis,$regexp)>: removes all items from the session
16249: environment file that begin with $delthis. If the
16250: optional second arg - $regexp - is true, $delthis is treated as a
16251: regular expression, otherwise \Q$delthis\E is used.
16252: The values are also deleted from the current processes %env.
1.191 harris41 16253:
1.795 albertel 16254: =item * get_env_multiple($name)
16255:
16256: gets $name from the %env hash, it seemlessly handles the cases where multiple
16257: values may be defined and end up as an array ref.
16258:
16259: returns an array of values
16260:
1.243 albertel 16261: =back
16262:
16263: =head2 User Information
1.191 harris41 16264:
1.243 albertel 16265: =over 4
1.191 harris41 16266:
16267: =item *
1.394 bowersj2 16268: X<queryauthenticate()>
16269: B<queryauthenticate($uname,$udom)>: try to determine user's current
1.191 harris41 16270: authentication scheme
16271:
16272: =item *
1.394 bowersj2 16273: X<authenticate()>
1.1073 raeburn 16274: B<authenticate($uname,$upass,$udom,$checkdefauth,$clientcancheckhost)>: try to
1.394 bowersj2 16275: authenticate user from domain's lib servers (first use the current
16276: one). C<$upass> should be the users password.
1.1073 raeburn 16277: $checkdefauth is optional (value is 1 if a check should be made to
16278: authenticate user using default authentication method, and allow
16279: account creation if username does not have account in the domain).
16280: $clientcancheckhost is optional (value is 1 if checking whether the
16281: server can host will occur on the client side in lonauth.pm).
1.191 harris41 16282:
16283: =item *
1.394 bowersj2 16284: X<homeserver()>
16285: B<homeserver($uname,$udom)>: find the server which has
16286: the user's directory and files (there must be only one), this caches
16287: the answer, and also caches if there is a borken connection.
1.191 harris41 16288:
16289: =item *
1.394 bowersj2 16290: X<idget()>
1.1300 raeburn 16291: B<idget($udom,$idsref,$namespace)>: find the usernames behind either
16292: a list of student/employee IDs or clicker IDs
16293: (student/employee IDs are a unique resource in a domain, there must be
16294: only 1 ID per username, and only 1 username per ID in a specific domain).
16295: clickerIDs are not necessarily unique, as students might share clickers.
16296: (returns hash: id=>name,id=>name)
1.191 harris41 16297:
16298: =item *
1.394 bowersj2 16299: X<idrget()>
16300: B<idrget($udom,@unames)>: find the IDs behind a list of
16301: usernames (returns hash: name=>id,name=>id)
1.191 harris41 16302:
16303: =item *
1.394 bowersj2 16304: X<idput()>
1.1300 raeburn 16305: B<idput($udom,$idsref,$uhome,$namespace)>: store away a list of
16306: names and associated student/employee IDs or clicker IDs.
16307:
16308: =item *
16309: X<iddel()>
16310: B<iddel($udom,$idshashref,$uhome,$namespace)>: delete unwanted
16311: student/employee ID or clicker ID username look-ups from domain.
16312: The homeserver ($uhome) and namespace ($namespace) are optional.
16313: If no $uhome is provided, it will be determined usig &homeserver()
16314: for each user. If no $namespace is provided, the default is ids.
16315:
16316: =item *
16317: X<updateclickers()>
16318: B<updateclickers($udom,$action,$idshashref,$uhome,$critical)>: update
16319: clicker ID-to-username look-ups in clickers.db on library server.
16320: Permitted actions are add or del (i.e., add or delete). The
16321: clickers.db contains clickerID as keys (escaped), and each corresponding
16322: value is an escaped comma-separated list of usernames (for whom the
16323: library server is the homeserver), who registered that particular ID.
16324: If $critical is true, the update will be sent via &critical, otherwise
16325: &reply() will be used.
1.191 harris41 16326:
16327: =item *
1.394 bowersj2 16328: X<rolesinit()>
1.1169 droeschl 16329: B<rolesinit($udom,$username)>: get user privileges.
16330: returns user role, first access and timer interval hashes
1.243 albertel 16331:
16332: =item *
1.1171 droeschl 16333: X<privileged()>
16334: B<privileged($username,$domain)>: returns a true if user has a
16335: privileged and active role (i.e. su or dc), false otherwise.
16336:
16337: =item *
1.551 albertel 16338: X<getsection()>
16339: B<getsection($udom,$uname,$cname)>: finds the section of student in the
1.243 albertel 16340: course $cname, return section name/number or '' for "not in course"
16341: and '-1' for "no section"
16342:
16343: =item *
1.394 bowersj2 16344: X<userenvironment()>
16345: B<userenvironment($udom,$uname,@what)>: gets the values of the keys
1.243 albertel 16346: passed in @what from the requested user's environment, returns a hash
16347:
1.858 raeburn 16348: =item *
16349: X<userlog_query()>
1.859 albertel 16350: B<userlog_query($uname,$udom,%filters)>: retrieves data from a user's
16351: activity.log file. %filters defines filters applied when parsing the
16352: log file. These can be start or end timestamps, or the type of action
16353: - log to look for Login or Logout events, check for Checkin or
16354: Checkout, role for role selection. The response is in the form
16355: timestamp1:hostid1:event1×tamp2:hostid2:event2 where events are
16356: escaped strings of the action recorded in the activity.log file.
1.858 raeburn 16357:
1.243 albertel 16358: =back
16359:
16360: =head2 User Roles
16361:
16362: =over 4
16363:
16364: =item *
16365:
1.1284 raeburn 16366: allowed($priv,$uri,$symb,$role,$clientip,$noblockcheck) : check for a user privilege;
16367: returns codes for allowed actions.
16368:
16369: The first argument is required, all others are optional.
16370:
16371: $priv is the privilege being checked.
16372: $uri contains additional information about what is being checked for access (e.g.,
16373: URL, course ID etc.).
16374: $symb is the unique resource instance identifier in a course; if needed,
16375: but not provided, it will be retrieved via a call to &symbread().
16376: $role is the role for which a priv is being checked (only used if priv is evb).
16377: $clientip is the user's IP address (only used when checking for access to portfolio
16378: files).
16379: $noblockcheck, if true, skips calls to &has_comm_blocking() for the bre priv. This
16380: prevents recursive calls to &allowed.
16381:
1.243 albertel 16382: F: full access
16383: U,I,K: authentication modes (cxx only)
16384: '': forbidden
16385: 1: user needs to choose course
16386: 2: browse allowed
1.766 albertel 16387: A: passphrase authentication needed
1.1284 raeburn 16388: B: access temporarily blocked because of a blocking event in a course.
1.1402 raeburn 16389: D: access blocked because access is required via session initiated via deep-link
1.243 albertel 16390:
16391: =item *
16392:
1.1192 raeburn 16393: constructaccess($url,$setpriv) : check for access to construction space URL
16394:
16395: See if the owner domain and name in the URL match those in the
16396: expected environment. If so, return three element list
16397: ($ownername,$ownerdomain,$ownerhome).
16398:
16399: Otherwise return the null string.
16400:
16401: If second argument 'setpriv' is true, it assigns the privileges,
16402: and returns the same three element list, unless the owner has
16403: blocked "ad hoc" Domain Coordinator access to the Author Space,
16404: in which case the null string is returned.
16405:
16406: =item *
16407:
1.1326 raeburn 16408: definerole($rolename,$sysrole,$domrole,$courole,$uname,$udom) : define role;
16409: define a custom role rolename set privileges in format of lonTabs/roles.tab
16410: for system, domain, and course level. $uname and $udom are optional (current
16411: user's username and domain will be used when either of $uname or $udom are absent.
1.243 albertel 16412:
16413: =item *
16414:
1.988 raeburn 16415: plaintext($short,$type,$cid,$forcedefault) : return value in %prp hash
16416: (rolesplain.tab); plain text explanation of a user role term.
1.1008 raeburn 16417: $type is Course (default) or Community.
1.988 raeburn 16418: If $forcedefault evaluates to true, text returned will be default
16419: text for $type. Otherwise, if this is a course, the text returned
16420: will be a custom name for the role (if defined in the course's
16421: environment). If no custom name is defined the default is returned.
16422:
1.832 raeburn 16423: =item *
16424:
1.1219 raeburn 16425: get_my_roles($uname,$udom,$context,$types,$roles,$roledoms,$withsec,$hidepriv) :
1.858 raeburn 16426: All arguments are optional. Returns a hash of a roles, either for
16427: co-author/assistant author roles for a user's Construction Space
1.906 albertel 16428: (default), or if $context is 'userroles', roles for the user himself,
1.933 raeburn 16429: In the hash, keys are set to colon-separated $uname,$udom,$role, and
16430: (optionally) if $withsec is true, a fourth colon-separated item - $section.
16431: For each key, value is set to colon-separated start and end times for
16432: the role. If no username and domain are specified, will default to
1.934 raeburn 16433: current user/domain. Types, roles, and roledoms are references to arrays
1.858 raeburn 16434: of role statuses (active, future or previous), roles
16435: (e.g., cc,in, st etc.) and domains of the roles which can be used
16436: to restrict the list of roles reported. If no array ref is
16437: provided for types, will default to return only active roles.
1.834 albertel 16438:
1.1195 raeburn 16439: =item *
16440:
16441: in_course($udom,$uname,$cdom,$cnum,$type,$hideprivileged) : determine if
1.1196 raeburn 16442: user: $uname:$udom has a role in the course: $cdom_$cnum.
16443:
16444: Additional optional arguments are: $type (if role checking is to be restricted
16445: to certain user status types -- previous (expired roles), active (currently
1.1195 raeburn 16446: available roles) or future (roles available in the future), and
16447: $hideprivileged -- if true will not report course roles for users who
1.1219 raeburn 16448: have active Domain Coordinator role in course's domain or in additional
16449: domains (specified in 'Domains to check for privileged users' in course
16450: environment -- set via: Course Settings -> Classlists and staff listing).
16451:
16452: =item *
16453:
16454: privileged($username,$domain,$possdomains,$possroles) : returns 1 if user
16455: $username:$domain is a privileged user (e.g., Domain Coordinator or Super User)
16456: $possdomains and $possroles are optional array refs -- to domains to check and
16457: roles to check. If $possdomains is not specified, a dump will be done of the
16458: users' roles.db to check for a dc or su role in any domain. This can be
16459: time consuming if &privileged is called repeatedly (e.g., when displaying a
16460: classlist), so in such cases, supplying a $possdomains array is preferred, as
16461: this then allows &privileged_by_domain() to be used, which caches the identity
16462: of privileged users, eliminating the need for repeated calls to &dump().
16463:
16464: =item *
16465:
16466: privileged_by_domain($possdomains,$roles) : returns a hash of a hash of a hash,
16467: where the outer hash keys are domains specified in the $possdomains array ref,
16468: next inner hash keys are privileged roles specified in the $roles array ref,
16469: and the innermost hash contains key = value pairs for username:domain = end:start
16470: for active or future "privileged" users with that role in that domain. To avoid
16471: repeated dumps of domain roles -- via &get_domain_roles() -- contents of the
16472: innerhash are cached using priv_$role and $dom as the identifiers.
1.1195 raeburn 16473:
1.243 albertel 16474: =back
16475:
16476: =head2 User Modification
16477:
16478: =over 4
16479:
16480: =item *
16481:
1.957 raeburn 16482: assignrole($udom,$uname,$url,$role,$end,$start,$deleteflag,$selfenroll,$context) : assign role; give a role to a
1.243 albertel 16483: user for the level given by URL. Optional start and end dates (leave empty
16484: string or zero for "no date")
1.191 harris41 16485:
16486: =item *
16487:
1.243 albertel 16488: changepass($uname,$udom,$currentpass,$newpass,$server) : attempts to
16489: change a users, password, possible return values are: ok,
16490: pwchange_failure, non_authorized, auth_mode_error, unknown_user,
16491: refused
1.191 harris41 16492:
16493: =item *
16494:
1.243 albertel 16495: modifyuserauth($udom,$uname,$umode,$upass) : modify user authentication
1.191 harris41 16496:
16497: =item *
16498:
1.1058 raeburn 16499: modifyuser($udom,$uname,$uid,$umode,$upass,$first,$middle,$last, $gene,
16500: $forceid,$desiredhome,$email,$inststatus,$candelete) :
16501:
16502: will update user information (firstname,middlename,lastname,generation,
16503: permanentemail), and if forceid is true, student/employee ID also.
16504: A user's institutional affiliation(s) can also be updated.
16505: User information fields will not be overwritten with empty entries
16506: unless the field is included in the $candelete array reference.
16507: This array is included when a single user is modified via "Manage Users",
16508: or when Autoupdate.pl is run by cron in a domain.
1.191 harris41 16509:
16510: =item *
16511:
1.286 matthew 16512: modifystudent
16513:
1.957 raeburn 16514: modify a student's enrollment and identification information.
1.1235 raeburn 16515: The course id is resolved based on the current user's environment.
16516: This means the invoking user must be a course coordinator or otherwise
1.286 matthew 16517: associated with a course.
16518:
1.297 matthew 16519: This call is essentially a wrapper for lonnet::modifyuser and
16520: lonnet::modify_student_enrollment
1.286 matthew 16521:
16522: Inputs:
16523:
16524: =over 4
16525:
1.957 raeburn 16526: =item B<$udom> Student's loncapa domain
1.286 matthew 16527:
1.957 raeburn 16528: =item B<$uname> Student's loncapa login name
1.286 matthew 16529:
1.964 bisitz 16530: =item B<$uid> Student/Employee ID
1.286 matthew 16531:
1.957 raeburn 16532: =item B<$umode> Student's authentication mode
1.286 matthew 16533:
1.957 raeburn 16534: =item B<$upass> Student's password
1.286 matthew 16535:
1.957 raeburn 16536: =item B<$first> Student's first name
1.286 matthew 16537:
1.957 raeburn 16538: =item B<$middle> Student's middle name
1.286 matthew 16539:
1.957 raeburn 16540: =item B<$last> Student's last name
1.286 matthew 16541:
1.957 raeburn 16542: =item B<$gene> Student's generation
1.286 matthew 16543:
1.957 raeburn 16544: =item B<$usec> Student's section in course
1.286 matthew 16545:
16546: =item B<$end> Unix time of the roles expiration
16547:
16548: =item B<$start> Unix time of the roles start date
16549:
16550: =item B<$forceid> If defined, allow $uid to be changed
16551:
16552: =item B<$desiredhome> server to use as home server for student
16553:
1.957 raeburn 16554: =item B<$email> Student's permanent e-mail address
16555:
16556: =item B<$type> Type of enrollment (auto or manual)
16557:
1.963 raeburn 16558: =item B<$locktype> boolean - enrollment type locked to prevent Autoenroll.pl changing manual to auto
16559:
16560: =item B<$cid> courseID - needed if a course role is assigned by a user whose current role is DC
1.957 raeburn 16561:
1.963 raeburn 16562: =item B<$selfenroll> boolean - 1 if user role change occurred via self-enrollment
1.957 raeburn 16563:
1.963 raeburn 16564: =item B<$context> role change context (shown in User Management Logs display in a course)
1.957 raeburn 16565:
1.1216 raeburn 16566: =item B<$inststatus> institutional status of user - : separated string of escaped status types
16567:
16568: =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.
1.957 raeburn 16569:
1.286 matthew 16570: =back
1.297 matthew 16571:
16572: =item *
16573:
16574: modify_student_enrollment
16575:
1.1235 raeburn 16576: Change a student's enrollment status in a class. The environment variable
1.297 matthew 16577: 'role.request.course' must be defined for this function to proceed.
16578:
16579: Inputs:
16580:
16581: =over 4
16582:
1.1235 raeburn 16583: =item $udom, student's domain
1.297 matthew 16584:
1.1235 raeburn 16585: =item $uname, student's name
1.297 matthew 16586:
1.1235 raeburn 16587: =item $uid, student's user id
1.297 matthew 16588:
1.1235 raeburn 16589: =item $first, student's first name
1.297 matthew 16590:
16591: =item $middle
16592:
16593: =item $last
16594:
16595: =item $gene
16596:
16597: =item $usec
16598:
16599: =item $end
16600:
16601: =item $start
16602:
1.957 raeburn 16603: =item $type
16604:
16605: =item $locktype
16606:
16607: =item $cid
16608:
16609: =item $selfenroll
16610:
16611: =item $context
16612:
1.1216 raeburn 16613: =item $credits, number of credits student will earn from this class
16614:
1.1314 raeburn 16615: =item $instsec, institutional course section code for student
16616:
1.297 matthew 16617: =back
16618:
1.191 harris41 16619:
16620: =item *
16621:
1.243 albertel 16622: assigncustomrole($udom,$uname,$url,$rdom,$rnam,$rolename,$end,$start) : assign
16623: custom role; give a custom role to a user for the level given by URL. Specify
16624: name and domain of role author, and role name
1.191 harris41 16625:
16626: =item *
16627:
1.243 albertel 16628: revokerole($udom,$uname,$url,$role) : revoke a role for url
1.191 harris41 16629:
16630: =item *
16631:
1.243 albertel 16632: revokecustomrole($udom,$uname,$url,$role) : revoke a custom role
16633:
16634: =back
16635:
16636: =head2 Course Infomation
16637:
16638: =over 4
1.191 harris41 16639:
16640: =item *
16641:
1.1118 foxr 16642: coursedescription($courseid,$options) : returns a hash of information about the
1.631 albertel 16643: specified course id, including all environment settings for the
16644: course, the description of the course will be in the hash under the
16645: key 'description'
1.191 harris41 16646:
1.1118 foxr 16647: $options is an optional parameter that if supplied is a hash reference that controls
16648: what how this function works. It has the following key/values:
16649:
16650: =over 4
16651:
16652: =item freshen_cache
16653:
16654: If defined, and the environment cache for the course is valid, it is
16655: returned in the returned hash.
16656:
16657: =item one_time
16658:
16659: If defined, the last cache time is set to _now_
16660:
16661: =item user
16662:
16663: If defined, the supplied username is used instead of the current user.
16664:
16665:
16666: =back
16667:
1.191 harris41 16668: =item *
16669:
1.624 albertel 16670: resdata($name,$domain,$type,@which) : request for current parameter
16671: setting for a specific $type, where $type is either 'course' or 'user',
16672: @what should be a list of parameters to ask about. This routine caches
1.1235 raeburn 16673: answers for 10 minutes.
1.243 albertel 16674:
1.877 foxr 16675: =item *
16676:
16677: get_courseresdata($courseid, $domain) : dump the entire course resource
16678: data base, returning a hash that is keyed by the resource name and has
16679: values that are the resource value. I believe that the timestamps and
16680: versions are also returned.
16681:
1.243 albertel 16682: =back
16683:
16684: =head2 Course Modification
16685:
16686: =over 4
1.191 harris41 16687:
16688: =item *
16689:
1.243 albertel 16690: writecoursepref($courseid,%prefs) : write preferences (environment
16691: database) for a course
1.191 harris41 16692:
16693: =item *
16694:
1.1011 raeburn 16695: createcourse($udom,$description,$url,$course_server,$nonstandard,$inst_code,$course_owner,$crstype,$cnum) : make course
16696:
16697: =item *
16698:
1.1038 raeburn 16699: generate_coursenum($udom,$crstype) : get a unique (unused) course number in domain $udom for course type $crstype (Course or Community).
1.243 albertel 16700:
1.1167 droeschl 16701: =item *
16702:
16703: is_course($courseid), is_course($cdom, $cnum)
16704:
16705: Accepts either a combined $courseid (in the form of domain_courseid) or the
16706: two component version $cdom, $cnum. It checks if the specified course exists.
16707:
16708: Returns:
16709: undef if the course doesn't exist, otherwise
16710: in scalar context the combined courseid.
16711: in list context the two components of the course identifier, domain and
16712: courseid.
16713:
1.243 albertel 16714: =back
16715:
1.1401 raeburn 16716: =head2 Bubblesheet Configuration
16717:
16718: =over 4
16719:
16720: =item *
16721:
16722: get_scantron_config($which)
16723:
16724: $which - the name of the configuration to parse from the file.
16725:
16726: Parses and returns the bubblesheet configuration line selected as a
16727: hash of configuration file fields.
16728:
16729:
16730: Returns:
16731: If the named configuration is not in the file, an empty
16732: hash is returned.
16733:
16734: a hash with the fields
16735: name - internal name for the this configuration setup
16736: description - text to display to operator that describes this config
16737: CODElocation - if 0 or the string 'none'
16738: - no CODE exists for this config
16739: if -1 || the string 'letter'
16740: - a CODE exists for this config and is
16741: a string of letters
16742: Unsupported value (but planned for future support)
16743: if a positive integer
16744: - The CODE exists as the first n items from
16745: the question section of the form
16746: if the string 'number'
16747: - The CODE exists for this config and is
16748: a string of numbers
16749: CODEstart - (only matter if a CODE exists) column in the line where
16750: the CODE starts
16751: CODElength - length of the CODE
16752: IDstart - column where the student/employee ID starts
16753: IDlength - length of the student/employee ID info
16754: Qstart - column where the information from the bubbled
16755: 'questions' start
16756: Qlength - number of columns comprising a single bubble line from
16757: the sheet. (usually either 1 or 10)
16758: Qon - either a single character representing the character used
16759: to signal a bubble was chosen in the positional setup, or
16760: the string 'letter' if the letter of the chosen bubble is
16761: in the final, or 'number' if a number representing the
16762: chosen bubble is in the file (1->A 0->J)
16763: Qoff - the character used to represent that a bubble was
16764: left blank
16765: PaperID - if the scanning process generates a unique number for each
16766: sheet scanned the column that this ID number starts in
16767: PaperIDlength - number of columns that comprise the unique ID number
16768: for the sheet of paper
16769: FirstName - column that the first name starts in
16770: FirstNameLength - number of columns that the first name spans
16771: LastName - column that the last name starts in
16772: LastNameLength - number of columns that the last name spans
16773: BubblesPerRow - number of bubbles available in each row used to
16774: bubble an answer. (If not specified, 10 assumed).
16775:
16776:
16777: =item *
16778:
16779: get_scantronformat_file($cdom)
16780:
16781: $cdom - the course's domain (optional); if not supplied, uses
16782: domain for current $env{'request.course.id'}.
16783:
16784: Returns an array containing lines from the scantron format file for
16785: the domain of the course.
16786:
16787: If a url for a custom.tab file is listed in domain's configuration.db,
16788: lines are from this file.
16789:
16790: Otherwise, if a default.tab has been published in RES space by the
16791: domainconfig user, lines are from this file.
16792:
16793: Otherwise, fall back to getting lines from the legacy file on the
16794: local server: /home/httpd/lonTabs/default_scantronformat.tab
16795:
16796: =back
16797:
1.243 albertel 16798: =head2 Resource Subroutines
16799:
16800: =over 4
1.191 harris41 16801:
16802: =item *
16803:
1.243 albertel 16804: subscribe($fname) : subscribe to a resource, returns URL if possible (probably should use repcopy instead)
1.191 harris41 16805:
16806: =item *
16807:
1.243 albertel 16808: repcopy($filename) : subscribes to the requested file, and attempts to
16809: replicate from the owning library server, Might return
1.607 raeburn 16810: 'unavailable', 'not_found', 'forbidden', 'ok', or
16811: 'bad_request', also attempts to grab the metadata for the
1.243 albertel 16812: resource. Expects the local filesystem pathname
16813: (/home/httpd/html/res/....)
16814:
16815: =back
16816:
16817: =head2 Resource Information
16818:
16819: =over 4
1.191 harris41 16820:
16821: =item *
16822:
1.1228 raeburn 16823: EXT($varname,$symb,$udom,$uname,$usection,$recurse,$cid) : evaluates
16824: and returns the value of a variety of different possible values,
16825: $varname should be a request string, and the other parameters can be
16826: used to specify who and what one is asking about. Ordinarily, $cid
16827: does not need to be specified, as it is retrived from
16828: $env{'request.course.id'}, but &Apache::lonnet::EXT() is called
16829: within lonuserstate::loadmap() when initializing a course, before
16830: $env{'request.course.id'} has been set, so it needs to be provided
16831: in that one case.
1.243 albertel 16832:
16833: Possible values for $varname are environment.lastname (or other item
16834: from the envirnment hash), user.name (or someother aspect about the
16835: user), resource.0.maxtries (or some other part and parameter of a
16836: resource)
1.204 albertel 16837:
16838: =item *
16839:
1.243 albertel 16840: directcondval($number) : get current value of a condition; reads from a state
16841: string
1.204 albertel 16842:
16843: =item *
16844:
1.243 albertel 16845: condval($condidx) : value of condition index based on state
1.204 albertel 16846:
16847: =item *
16848:
1.1362 raeburn 16849: metadata($uri,$what,$toolsymb,$liburi,$prefix,$depthcount) : request a
1.243 albertel 16850: resource's metadata, $what should be either a specific key, or either
16851: 'keys' (to get a list of possible keys) or 'packages' to get a list of
1.1362 raeburn 16852: packages that this resource currently uses, the last 3 arguments are
16853: only used internally for recursive metadata.
16854:
16855: the toolsymb is only used where the uri is for an external tool (for which
16856: the uri as well as the symb are guaranteed to be unique).
1.243 albertel 16857:
1.1371 raeburn 16858: this function automatically caches all requests except any made recursively
16859: to retrieve a list of metadata keys for an imported library file ($liburi is
16860: defined).
1.191 harris41 16861:
16862: =item *
16863:
1.243 albertel 16864: metadata_query($query,$custom,$customshow) : make a metadata query against the
16865: network of library servers; returns file handle of where SQL and regex results
16866: will be stored for query
1.191 harris41 16867:
16868: =item *
16869:
1.1282 raeburn 16870: symbread($filename,$donotrecurse,$ignorecachednull,$checkforblock,$possibles) :
16871: return symbolic list entry (all arguments optional).
16872:
16873: Args: filename is the filename (including path) for the file for which a symb
16874: is required; donotrecurse, if true will prevent calls to allowed() being made
16875: to check access status if more than one resource was found in the bighash
16876: (see rev. 1.249) to avoid an infinite loop if an ambiguous resource is part of
16877: a randompick); ignorecachednull, if true will prevent a symb of '' being
16878: returned if $env{$cache_str} is defined as ''; checkforblock if true will
16879: cause possible symbs to be checked to determine if they are subject to content
16880: blocking, if so they will not be included as possible symbs; possibles is a
16881: ref to a hash, which, as a side effect, will be populated with all possible
16882: symbs (content blocking not tested).
16883:
1.243 albertel 16884: returns the data handle
1.191 harris41 16885:
16886: =item *
16887:
1.1190 raeburn 16888: symbverify($symb,$thisfn,$encstate) : verifies that $symb actually exists
16889: and is a possible symb for the URL in $thisfn, and if is an encrypted
1.582 albertel 16890: resource that the user accessed using /enc/ returns a 1 on success, 0
1.1190 raeburn 16891: on failure, user must be in a course, as it assumes the existence of
16892: the course initial hash, and uses $env('request.course.id'}. The third
16893: arg is an optional reference to a scalar. If this arg is passed in the
16894: call to symbverify, it will be set to 1 if the symb has been set to be
16895: encrypted; otherwise it will be null.
1.191 harris41 16896:
16897: =item *
16898:
1.243 albertel 16899: symbclean($symb) : removes versions numbers from a symb, returns the
16900: cleaned symb
1.191 harris41 16901:
16902: =item *
16903:
1.243 albertel 16904: is_on_map($uri) : checks if the $uri is somewhere on the current
16905: course map, user must be in a course for it to work.
1.191 harris41 16906:
16907: =item *
16908:
1.243 albertel 16909: numval($salt) : return random seed value (addend for rndseed)
1.191 harris41 16910:
16911: =item *
16912:
1.243 albertel 16913: rndseed($symb,$courseid,$udom,$uname) : create a random sum; returns
16914: a random seed, all arguments are optional, if they aren't sent it uses the
16915: environment to derive them. Note: if symb isn't sent and it can't get one
16916: from &symbread it will use the current time as its return value
1.191 harris41 16917:
16918: =item *
16919:
1.243 albertel 16920: ireceipt($funame,$fudom,$fucourseid,$fusymb) : return unique,
16921: unfakeable, receipt
1.191 harris41 16922:
16923: =item *
16924:
1.620 albertel 16925: receipt() : API to ireceipt working off of env values; given out to users
1.191 harris41 16926:
16927: =item *
16928:
1.243 albertel 16929: countacc($url) : count the number of accesses to a given URL
1.191 harris41 16930:
16931: =item *
16932:
1.243 albertel 16933: 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
1.191 harris41 16934:
16935: =item *
16936:
1.243 albertel 16937: 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)
1.191 harris41 16938:
16939: =item *
16940:
1.243 albertel 16941: expirespread($uname,$udom,$stype,$usymb) : set expire date for spreadsheet
1.191 harris41 16942:
16943: =item *
16944:
1.243 albertel 16945: devalidate($symb) : devalidate temporary spreadsheet calculations,
16946: forcing spreadsheet to reevaluate the resource scores next time.
16947:
1.1195 raeburn 16948: =item *
16949:
1.1196 raeburn 16950: can_edit_resource($file,$cnum,$cdom,$resurl,$symb,$group) : determine if current user can edit a particular resource,
16951: when viewing in course context.
1.1195 raeburn 16952:
1.1196 raeburn 16953: input: six args -- filename (decluttered), course number, course domain,
16954: url, symb (if registered) and group (if this is a
16955: group item -- e.g., bulletin board, group page etc.).
1.1195 raeburn 16956:
1.1196 raeburn 16957: output: array of five scalars --
1.1195 raeburn 16958: $cfile -- url for file editing if editable on current server
16959: $home -- homeserver of resource (i.e., for author if published,
16960: or course if uploaded.).
16961: $switchserver -- 1 if server switch will be needed.
1.1196 raeburn 16962: $forceedit -- 1 if icon/link should be to go to edit mode
16963: $forceview -- 1 if icon/link should be to go to view mode
1.1195 raeburn 16964:
16965: =item *
16966:
16967: is_course_upload($file,$cnum,$cdom)
16968:
16969: Used in course context to determine if current file was uploaded to
16970: the course (i.e., would be found in /userfiles/docs on the course's
16971: homeserver.
16972:
16973: input: 3 args -- filename (decluttered), course number and course domain.
16974: output: boolean -- 1 if file was uploaded.
16975:
1.243 albertel 16976: =back
16977:
16978: =head2 Storing/Retreiving Data
16979:
16980: =over 4
1.191 harris41 16981:
16982: =item *
16983:
1.1269 raeburn 16984: store($storehash,$symb,$namespace,$udom,$uname,$laststore) : stores hash
16985: permanently for this url; hashref needs to be given and should be a \%hashname;
16986: the remaining args aren't required and if they aren't passed or are '' they will
16987: be derived from the env (with the exception of $laststore, which is an
16988: optional arg used when a user's submission is stored in grading).
16989: $laststore is $version=$timestamp, where $version is the most recent version
16990: number retrieved for the corresponding $symb in the $namespace db file, and
16991: $timestamp is the timestamp for that transaction (UNIX time).
16992: $laststore is currently only passed when cstore() is called by
16993: structuretags::finalize_storage().
1.191 harris41 16994:
16995: =item *
16996:
1.1269 raeburn 16997: cstore($storehash,$symb,$namespace,$udom,$uname,$laststore) : same as store
16998: but uses critical subroutine
1.191 harris41 16999:
17000: =item *
17001:
1.243 albertel 17002: restore($symb,$namespace,$udom,$uname) : returns hash for this symb;
17003: all args are optional
1.191 harris41 17004:
17005: =item *
17006:
1.717 albertel 17007: dumpstore($namespace,$udom,$uname,$regexp,$range) :
17008: dumps the complete (or key matching regexp) namespace into a hash
17009: ($udom, $uname, $regexp, $range are optional) for a namespace that is
17010: normally &store()ed into
17011:
17012: $range should be either an integer '100' (give me the first 100
17013: matching records)
17014: or be two integers sperated by a - with no spaces
17015: '30-50' (give me the 30th through the 50th matching
17016: records)
17017:
17018:
17019: =item *
17020:
1.1269 raeburn 17021: putstore($namespace,$symb,$version,$storehash,$udomain,$uname,$tolog) :
1.717 albertel 17022: replaces a &store() version of data with a replacement set of data
17023: for a particular resource in a namespace passed in the $storehash hash
1.1269 raeburn 17024: reference. If $tolog is true, the transaction is logged in the courselog
17025: with an action=PUTSTORE.
1.717 albertel 17026:
17027: =item *
17028:
1.243 albertel 17029: tmpstore($storehash,$symb,$namespace,$udom,$uname) : storage that
17030: works very similar to store/cstore, but all data is stored in a
17031: temporary location and can be reset using tmpreset, $storehash should
17032: be a hash reference, returns nothing on success
1.191 harris41 17033:
17034: =item *
17035:
1.243 albertel 17036: tmprestore($symb,$namespace,$udom,$uname) : storage that works very
17037: similar to restore, but all data is stored in a temporary location and
17038: can be reset using tmpreset. Returns a hash of values on success,
17039: error string otherwise.
1.191 harris41 17040:
17041: =item *
17042:
1.243 albertel 17043: tmpreset($symb,$namespace,$udom,$uname) : temporary storage reset,
17044: deltes all keys for $symb form the temporary storage hash.
1.191 harris41 17045:
17046: =item *
17047:
1.243 albertel 17048: get($namespace,$storearr,$udom,$uname) : returns hash with keys from array
17049: reference filled in from namesp ($udom and $uname are optional)
1.191 harris41 17050:
17051: =item *
17052:
1.243 albertel 17053: del($namespace,$storearr,$udom,$uname) : deletes keys out of array from
17054: namesp ($udom and $uname are optional)
1.191 harris41 17055:
17056: =item *
17057:
1.702 albertel 17058: dump($namespace,$udom,$uname,$regexp,$range) :
1.243 albertel 17059: dumps the complete (or key matching regexp) namespace into a hash
1.702 albertel 17060: ($udom, $uname, $regexp, $range are optional)
1.449 matthew 17061:
1.702 albertel 17062: $range should be either an integer '100' (give me the first 100
17063: matching records)
17064: or be two integers sperated by a - with no spaces
17065: '30-50' (give me the 30th through the 50th matching
17066: records)
1.449 matthew 17067: =item *
17068:
17069: inc($namespace,$store,$udom,$uname) : increments $store in $namespace.
17070: $store can be a scalar, an array reference, or if the amount to be
17071: incremented is > 1, a hash reference.
17072:
17073: ($udom and $uname are optional)
1.191 harris41 17074:
17075: =item *
17076:
1.243 albertel 17077: put($namespace,$storehash,$udom,$uname) : stores hash in namesp
17078: ($udom and $uname are optional)
1.191 harris41 17079:
17080: =item *
17081:
1.243 albertel 17082: cput($namespace,$storehash,$udom,$uname) : critical put
17083: ($udom and $uname are optional)
1.191 harris41 17084:
17085: =item *
17086:
1.748 albertel 17087: newput($namespace,$storehash,$udom,$uname) :
17088:
17089: Attempts to store the items in the $storehash, but only if they don't
17090: currently exist, if this succeeds you can be certain that you have
17091: successfully created a new key value pair in the $namespace db.
17092:
17093:
17094: Args:
17095: $namespace: name of database to store values to
17096: $storehash: hashref to store to the db
17097: $udom: (optional) domain of user containing the db
17098: $uname: (optional) name of user caontaining the db
17099:
17100: Returns:
17101: 'ok' -> succeeded in storing all keys of $storehash
17102: 'key_exists: <key>' -> failed to anything out of $storehash, as at
17103: least <key> already existed in the db (other
17104: requested keys may also already exist)
1.967 bisitz 17105: 'error: <msg>' -> unable to tie the DB or other error occurred
1.748 albertel 17106: 'con_lost' -> unable to contact request server
17107: 'refused' -> action was not allowed by remote machine
17108:
17109:
17110: =item *
17111:
1.243 albertel 17112: eget($namespace,$storearr,$udom,$uname) : returns hash with keys from array
17113: reference filled in from namesp (encrypts the return communication)
17114: ($udom and $uname are optional)
1.191 harris41 17115:
17116: =item *
17117:
1.243 albertel 17118: log($udom,$name,$home,$message) : write to permanent log for user; use
17119: critical subroutine
17120:
1.806 raeburn 17121: =item *
17122:
1.860 raeburn 17123: get_dom($namespace,$storearr,$udom,$uhome) : returns hash with keys from
17124: array reference filled in from namespace found in domain level on either
17125: specified domain server ($uhome) or primary domain server ($udom and $uhome are optional).
1.806 raeburn 17126:
17127: =item *
17128:
1.860 raeburn 17129: put_dom($namespace,$storehash,$udom,$uhome) : stores hash in namespace at
17130: domain level either on specified domain server ($uhome) or primary domain
17131: server ($udom and $uhome are optional)
1.806 raeburn 17132:
1.943 raeburn 17133: =item *
17134:
1.1240 raeburn 17135: get_domain_defaults($target_domain,$ignore_cache) : returns hash with defaults
17136: for: authentication, language, quotas, timezone, date locale, and portal URL in
17137: the target domain.
17138:
17139: May also include additional key => value pairs for the following groups:
17140:
17141: =over
17142:
17143: =item
17144: disk quotas (MB allocated by default to portfolios and authoring spaces).
17145:
17146: =over
17147:
17148: =item defaultquota, authorquota
17149:
17150: =back
17151:
17152: =item
17153: tools (availability of aboutme page, blog, webDAV access for authoring spaces,
17154: portfolio for users).
17155:
17156: =over
17157:
17158: =item
17159: aboutme, blog, webdav, portfolio
17160:
17161: =back
17162:
17163: =item
17164: requestcourses: ability to request courses, and how requests are processed.
17165:
17166: =over
17167:
17168: =item
1.1305 raeburn 17169: official, unofficial, community, textbook, placement
1.1240 raeburn 17170:
17171: =back
17172:
17173: =item
17174: inststatus: types of institutional affiliation, and order in which they are displayed.
17175:
17176: =over
17177:
17178: =item
1.1256 raeburn 17179: inststatustypes, inststatusorder, inststatusguest
1.1240 raeburn 17180:
17181: =back
17182:
17183: =item
17184: coursedefaults: can PDF forms can be created, default credits for courses, default quotas (MB)
17185: for course's uploaded content.
17186:
17187: =over
17188:
17189: =item
1.1246 raeburn 17190: canuse_pdfforms, officialcredits, unofficialcredits, textbookcredits, officialquota, unofficialquota,
1.1305 raeburn 17191: communityquota, textbookquota, placementquota
1.1240 raeburn 17192:
17193: =back
17194:
17195: =item
17196: usersessions: set options for hosting of your users in other domains, and hosting of users from other domains
17197: on your servers.
17198:
17199: =over
17200:
17201: =item
17202: remotesessions, hostedsessions
17203:
17204: =back
17205:
17206: =back
17207:
17208: In cases where a domain coordinator has never used the "Set Domain Configuration"
17209: utility to create a configuration.db file on a domain's primary library server
17210: only the following domain defaults: auth_def, auth_arg_def, lang_def
17211: -- corresponding values are authentication type (internal, krb4, krb5,
17212: or localauth), initial password or a kerberos realm, language (e.g., en-us) --
17213: will be available. Values are retrieved from cache (if current), unless the
17214: optional $ignore_cache arg is true, or from domain's configuration.db (if available),
17215: or lastly from values in lonTabs/dns_domain,tab, or lonTabs/domain.tab.
17216:
17217: Typical usage:
1.943 raeburn 17218:
1.1240 raeburn 17219: %domdefaults = &get_domain_defaults($target_domain);
1.943 raeburn 17220:
1.243 albertel 17221: =back
17222:
17223: =head2 Network Status Functions
17224:
17225: =over 4
1.191 harris41 17226:
17227: =item *
17228:
1.1137 raeburn 17229: dirlist() : return directory list based on URI (first arg).
17230:
17231: Inputs: 1 required, 5 optional.
17232:
17233: =over
17234:
17235: =item
17236: $uri - path to file in filesystem (starts: /res or /userfiles/). Required.
17237:
17238: =item
17239: $userdomain - domain of user/course to be listed. Extracted from $uri if absent.
17240:
17241: =item
17242: $username - username of user/course to be listed. Extracted from $uri if absent.
17243:
17244: =item
17245: $getpropath - boolean: 1 if prepend path using &propath().
17246:
17247: =item
17248: $getuserdir - boolean: 1 if prepend path for "userfiles".
17249:
17250: =item
17251: $alternateRoot - path to prepend in place of path from $uri.
17252:
17253: =back
17254:
17255: Returns: Array of up to two items.
17256:
17257: =over
17258:
17259: a reference to an array of files/subdirectories
17260:
17261: =over
17262:
17263: Each element in the array of files/subdirectories is a & separated list of
17264: item name and the result of running stat on the item. If dirlist was requested
17265: for a file instead of a directory, the item name will be ''. For a directory
17266: listing, if the item is a metadata file, the element will end &N&M
17267: (where N amd M are either 0 or 1, corresponding to obsolete set (1), or
17268: default copyright set (1).
17269:
17270: =back
17271:
17272: a scalar containing error condition (if encountered).
17273:
17274: =over
17275:
17276: =item
17277: no_host (no homeserver identified for $username:$domain).
17278:
17279: =item
17280: no_such_host (server contacted for listing not identified as valid host).
17281:
17282: =item
17283: con_lost (connection to remote server failed).
17284:
17285: =item
17286: refused (invalid $username:$domain received on lond side).
17287:
17288: =item
17289: no_such_dir (directory at specified path on lond side does not exist).
17290:
17291: =item
17292: empty (directory at specified path on lond side is empty).
17293:
17294: =over
17295:
17296: This is currently not encountered because the &ls3, &ls2,
17297: &ls (_handler) routines on the lond side do not filter out
17298: . and .. from a directory listing.
17299:
17300: =back
17301:
17302: =back
17303:
17304: =back
1.191 harris41 17305:
17306: =item *
17307:
1.243 albertel 17308: spareserver() : find server with least workload from spare.tab
17309:
1.986 foxr 17310:
17311: =item *
17312:
17313: host_from_dns($dns) : Returns the loncapa hostname corresponding to a DNS name or undef
17314: if there is no corresponding loncapa host.
17315:
1.243 albertel 17316: =back
17317:
1.986 foxr 17318:
1.243 albertel 17319: =head2 Apache Request
17320:
17321: =over 4
1.191 harris41 17322:
17323: =item *
17324:
1.243 albertel 17325: ssi($url,%hash) : server side include, does a complete request cycle on url to
17326: localhost, posts hash
17327:
17328: =back
17329:
17330: =head2 Data to String to Data
17331:
17332: =over 4
1.191 harris41 17333:
17334: =item *
17335:
1.243 albertel 17336: hash2str(%hash) : convert a hash into a string complete with escaping and '='
17337: and '&' separators, supports elements that are arrayrefs and hashrefs
1.191 harris41 17338:
17339: =item *
17340:
1.243 albertel 17341: hashref2str($hashref) : convert a hashref into a string complete with
17342: escaping and '=' and '&' separators, supports elements that are
17343: arrayrefs and hashrefs
1.191 harris41 17344:
17345: =item *
17346:
1.243 albertel 17347: arrayref2str($arrayref) : convert an arrayref into a string complete
17348: with escaping and '&' separators, supports elements that are arrayrefs
17349: and hashrefs
1.191 harris41 17350:
17351: =item *
17352:
1.243 albertel 17353: str2hash($string) : convert string to hash using unescaping and
17354: splitting on '=' and '&', supports elements that are arrayrefs and
17355: hashrefs
1.191 harris41 17356:
17357: =item *
17358:
1.243 albertel 17359: str2array($string) : convert string to hash using unescaping and
17360: splitting on '&', supports elements that are arrayrefs and hashrefs
17361:
17362: =back
17363:
17364: =head2 Logging Routines
17365:
17366:
17367: These routines allow one to make log messages in the lonnet.log and
17368: lonnet.perm logfiles.
1.191 harris41 17369:
1.1119 foxr 17370: =over 4
17371:
1.191 harris41 17372: =item *
17373:
1.243 albertel 17374: logtouch() : make sure the logfile, lonnet.log, exists
1.191 harris41 17375:
17376: =item *
17377:
1.243 albertel 17378: logthis() : append message to the normal lonnet.log file, it gets
17379: preiodically rolled over and deleted.
1.191 harris41 17380:
17381: =item *
17382:
1.243 albertel 17383: logperm() : append a permanent message to lonnet.perm.log, this log
17384: file never gets deleted by any automated portion of the system, only
17385: messages of critical importance should go in here.
17386:
1.1119 foxr 17387:
1.243 albertel 17388: =back
17389:
17390: =head2 General File Helper Routines
17391:
17392: =over 4
1.191 harris41 17393:
17394: =item *
17395:
1.481 raeburn 17396: getfile($file,$caller) : two cases - requests for files in /res or in /uploaded.
17397: (a) files in /uploaded
17398: (i) If a local copy of the file exists -
17399: compares modification date of local copy with last-modified date for
17400: definitive version stored on home server for course. If local copy is
17401: stale, requests a new version from the home server and stores it.
17402: If the original has been removed from the home server, then local copy
17403: is unlinked.
17404: (ii) If local copy does not exist -
17405: requests the file from the home server and stores it.
17406:
17407: If $caller is 'uploadrep':
17408: This indicates a call from lonuploadrep.pm (PerlHeaderParserHandler phase)
17409: for request for files originally uploaded via DOCS.
17410: - returns 'ok' if fresh local copy now available, -1 otherwise.
17411:
17412: Otherwise:
17413: This indicates a call from the content generation phase of the request.
17414: - returns the entire contents of the file or -1.
17415:
17416: (b) files in /res
17417: - returns the entire contents of a file or -1;
17418: it properly subscribes to and replicates the file if neccessary.
1.191 harris41 17419:
1.712 albertel 17420:
17421: =item *
17422:
17423: stat_file($url) : $url is expected to be a /res/ or /uploaded/ style file
17424: reference
17425:
17426: returns either a stat() list of data about the file or an empty list
17427: if the file doesn't exist or couldn't find out about it (connection
17428: problems or user unknown)
17429:
1.191 harris41 17430: =item *
17431:
1.243 albertel 17432: filelocation($dir,$file) : returns file system location of a file
17433: based on URI; meant to be "fairly clean" absolute reference, $dir is a
17434: directory that relative $file lookups are to looked in ($dir of /a/dir
17435: and a file of ../bob will become /a/bob)
1.191 harris41 17436:
17437: =item *
17438:
17439: hreflocation($dir,$file) : returns file system location or a URL; same as
17440: filelocation except for hrefs
17441:
17442: =item *
17443:
1.1261 raeburn 17444: declutter() : declutters URLs -- remove beginning slashes, 'res' etc.
17445: also removes beginning /home/httpd/html unless /priv/ follows it.
1.191 harris41 17446:
1.243 albertel 17447: =back
17448:
1.608 albertel 17449: =head2 Usererfile file routines (/uploaded*)
17450:
17451: =over 4
17452:
17453: =item *
17454:
17455: userfileupload(): main rotine for putting a file in a user or course's
17456: filespace, arguments are,
17457:
1.620 albertel 17458: formname - required - this is the name of the element in $env where the
1.608 albertel 17459: filename, and the contents of the file to create/modifed exist
1.620 albertel 17460: the filename is in $env{'form.'.$formname.'.filename'} and the
17461: contents of the file is located in $env{'form.'.$formname}
1.1090 raeburn 17462: context - if coursedoc, store the file in the course of the active role
17463: of the current user;
17464: if 'existingfile': store in 'overwrites' in /home/httpd/perl/tmp
17465: if 'canceloverwrite': delete file in tmp/overwrites directory
1.608 albertel 17466: subdir - required - subdirectory to put the file in under ../userfiles/
17467: if undefined, it will be placed in "unknown"
17468:
17469: (This routine calls clean_filename() to remove any dangerous
17470: characters from the filename, and then calls finuserfileupload() to
17471: complete the transaction)
17472:
17473: returns either the url of the uploaded file (/uploaded/....) if successful
17474: and /adm/notfound.html if unsuccessful
17475:
17476: =item *
17477:
17478: clean_filename(): routine for cleaing a filename up for storage in
17479: userfile space, argument is:
17480:
17481: filename - proposed filename
17482:
17483: returns: the new clean filename
17484:
17485: =item *
17486:
1.1090 raeburn 17487: finishuserfileupload(): routine that creates and sends the file to
1.608 albertel 17488: userspace, probably shouldn't be called directly
17489:
17490: docuname: username or courseid of destination for the file
17491: docudom: domain of user/course of destination for the file
17492: formname: same as for userfileupload()
1.1090 raeburn 17493: fname: filename (including subdirectories) for the file
17494: parser: if 'parse', will parse (html) file to extract references to objects, links etc.
1.1401 raeburn 17495: if hashref, and context is scantron, will convert csv format to standard format
1.1090 raeburn 17496: allfiles: reference to hash used to store objects found by parser
17497: codebase: reference to hash used for codebases of java objects found by parser
17498: thumbwidth: width (pixels) of thumbnail to be created for uploaded image
17499: thumbheight: height (pixels) of thumbnail to be created for uploaded image
17500: resizewidth: width to be used to resize image using resizeImage from ImageMagick
17501: resizeheight: height to be used to resize image using resizeImage from ImageMagick
17502: context: if 'overwrite', will move the uploaded file from its temporary location to
17503: userfiles to facilitate overwriting a previously uploaded file with same name.
1.1095 raeburn 17504: mimetype: reference to scalar to accommodate mime type determined
17505: from File::MMagic if $parser = parse.
1.608 albertel 17506:
17507: returns either the url of the uploaded file (/uploaded/....) if successful
1.1090 raeburn 17508: and /adm/notfound.html if unsuccessful (or an error message if context
17509: was 'overwrite').
17510:
1.608 albertel 17511:
17512: =item *
17513:
17514: renameuserfile(): renames an existing userfile to a new name
17515:
17516: Args:
17517: docuname: username or courseid of destination for the file
17518: docudom: domain of user/course of destination for the file
17519: old: current file name (including any subdirs under userfiles)
17520: new: desired file name (including any subdirs under userfiles)
17521:
17522: =item *
17523:
17524: mkdiruserfile(): creates a directory is a userfiles dir
17525:
17526: Args:
17527: docuname: username or courseid of destination for the file
17528: docudom: domain of user/course of destination for the file
17529: dir: dir to create (including any subdirs under userfiles)
17530:
17531: =item *
17532:
17533: removeuserfile(): removes a file that exists in userfiles
17534:
17535: Args:
17536: docuname: username or courseid of destination for the file
17537: docudom: domain of user/course of destination for the file
17538: fname: filname to delete (including any subdirs under userfiles)
17539:
17540: =item *
17541:
17542: removeuploadedurl(): convience function for removeuserfile()
17543:
17544: Args:
17545: url: a full /uploaded/... url to delete
17546:
1.747 albertel 17547: =item *
17548:
17549: get_portfile_permissions():
17550: Args:
17551: domain: domain of user or course contain the portfolio files
17552: user: name of user or num of course contain the portfolio files
17553: Returns:
17554: hashref of a dump of the proper file_permissions.db
17555:
17556:
17557: =item *
17558:
17559: get_access_controls():
17560:
17561: Args:
17562: current_permissions: the hash ref returned from get_portfile_permissions()
17563: group: (optional) the group you want the files associated with
17564: file: (optional) the file you want access info on
17565:
17566: Returns:
1.749 raeburn 17567: a hash (keys are file names) of hashes containing
17568: keys are: path to file/file_name\0uniqueID:scope_end_start (see below)
17569: values are XML containing access control settings (see below)
1.747 albertel 17570:
17571: Internal notes:
17572:
1.749 raeburn 17573: access controls are stored in file_permissions.db as key=value pairs.
17574: key -> path to file/file_name\0uniqueID:scope_end_start
17575: where scope -> public,guest,course,group,domains or users.
17576: end -> UNIX time for end of access (0 -> no end date)
17577: start -> UNIX time for start of access
17578:
17579: value -> XML description of access control
17580: <scope type=""> (type =1 of: public,guest,course,group,domains,users">
17581: <start></start>
17582: <end></end>
17583:
17584: <password></password> for scope type = guest
17585:
17586: <domain></domain> for scope type = course or group
17587: <number></number>
17588: <roles id="">
17589: <role></role>
17590: <access></access>
17591: <section></section>
17592: <group></group>
17593: </roles>
17594:
17595: <dom></dom> for scope type = domains
17596:
17597: <users> for scope type = users
17598: <user>
17599: <uname></uname>
17600: <udom></udom>
17601: </user>
17602: </users>
17603: </scope>
17604:
17605: Access data is also aggregated for each file in an additional key=value pair:
17606: key -> path to file/file_name\0accesscontrol
17607: value -> reference to hash
17608: hash contains key = value pairs
17609: where key = uniqueID:scope_end_start
17610: value = UNIX time record was last updated
17611:
17612: Used to improve speed of look-ups of access controls for each file.
17613:
17614: Locks on files (resulting from submission of portfolio file to a homework problem stored in array of arrays.
17615:
1.1198 raeburn 17616: =item *
17617:
1.749 raeburn 17618: modify_access_controls():
17619:
17620: Modifies access controls for a portfolio file
17621: Args
17622: 1. file name
17623: 2. reference to hash of required changes,
17624: 3. domain
17625: 4. username
17626: where domain,username are the domain of the portfolio owner
17627: (either a user or a course)
17628:
17629: Returns:
17630: 1. result of additions or updates ('ok' or 'error', with error message).
17631: 2. result of deletions ('ok' or 'error', with error message).
17632: 3. reference to hash of any new or updated access controls.
17633: 4. reference to hash used to map incoming IDs to uniqueIDs assigned to control.
17634: key = integer (inbound ID)
1.1198 raeburn 17635: value = uniqueID
17636:
17637: =item *
17638:
17639: get_timebased_id():
17640:
17641: Attempts to get a unique timestamp-based suffix for use with items added to a
17642: course via the Course Editor (e.g., folders, composite pages,
17643: group bulletin boards).
17644:
17645: Args: (first three required; six others optional)
17646:
17647: 1. prefix (alphanumeric): of keys in hash, e.g., suppsequence, docspage,
17648: docssequence, or name of group
17649:
17650: 2. keyid (alphanumeric): name of temporary locking key in hash,
17651: e.g., num, boardids
17652:
17653: 3. namespace: name of gdbm file used to store suffixes already assigned;
17654: file will be named nohist_namespace.db
17655:
17656: 4. cdom: domain of course; default is current course domain from %env
17657:
17658: 5. cnum: course number; default is current course number from %env
17659:
17660: 6. idtype: set to concat if an additional digit is to be appended to the
17661: unix timestamp to form the suffix, if the plain timestamp is already
17662: in use. Default is to not do this, but simply increment the unix
17663: timestamp by 1 until a unique key is obtained.
17664:
17665: 7. who: holder of locking key; defaults to user:domain for user.
17666:
17667: 8. locktries: number of attempts to obtain a lock (sleep of 1s before
17668: retrying); default is 3.
17669:
17670: 9. maxtries: number of attempts to obtain a unique suffix; default is 20.
17671:
17672: Returns:
17673:
17674: 1. suffix obtained (numeric)
17675:
17676: 2. result of deleting locking key (ok if deleted, or lock never obtained)
17677:
17678: 3. error: contains (localized) error message if an error occurred.
17679:
1.747 albertel 17680:
1.608 albertel 17681: =back
17682:
1.243 albertel 17683: =head2 HTTP Helper Routines
17684:
17685: =over 4
17686:
1.191 harris41 17687: =item *
17688:
17689: escape() : unpack non-word characters into CGI-compatible hex codes
17690:
17691: =item *
17692:
17693: unescape() : pack CGI-compatible hex codes into actual non-word ASCII character
17694:
1.243 albertel 17695: =back
17696:
17697: =head1 PRIVATE SUBROUTINES
17698:
17699: =head2 Underlying communication routines (Shouldn't call)
17700:
17701: =over 4
17702:
17703: =item *
17704:
17705: subreply() : tries to pass a message to lonc, returns con_lost if incapable
17706:
17707: =item *
17708:
17709: reply() : uses subreply to send a message to remote machine, logs all failures
17710:
17711: =item *
17712:
17713: critical() : passes a critical message to another server; if cannot
17714: get through then place message in connection buffer directory and
17715: returns con_delayed, if incapable of saving message, returns
17716: con_failed
17717:
17718: =item *
17719:
17720: reconlonc() : tries to reconnect lonc client processes.
17721:
17722: =back
17723:
17724: =head2 Resource Access Logging
17725:
17726: =over 4
17727:
17728: =item *
17729:
17730: flushcourselogs() : flush (save) buffer logs and access logs
17731:
17732: =item *
17733:
17734: courselog($what) : save message for course in hash
17735:
17736: =item *
17737:
17738: courseacclog($what) : save message for course using &courselog(). Perform
17739: special processing for specific resource types (problems, exams, quizzes, etc).
17740:
1.191 harris41 17741: =item *
17742:
17743: goodbye() : flush course logs and log shutting down; it is called in srm.conf
17744: as a PerlChildExitHandler
1.243 albertel 17745:
17746: =back
17747:
17748: =head2 Other
17749:
17750: =over 4
17751:
17752: =item *
17753:
17754: symblist($mapname,%newhash) : update symbolic storage links
1.191 harris41 17755:
17756: =back
17757:
17758: =cut
1.877 foxr 17759:
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